Plugins API - Saving settings

danpeig · 15 November 2020 18:40

Hello,

I was playing around the Plugins API and I was wondering if the interface provides any native means for storing persistent data like authentication tokens.

As far as I understood, the settings object only provides an interface to the settings menu.

If this storage function is not implemented, what would be the recommended way of storing persistent data by the plugins? Could I use something simple like the HTML5 storage API or it would be better to save in a flat file?

Regards,

laurent · 15 November 2020 18:55

For now you can either:

Create a new private setting (set public to false) and save the data to it, maybe by serializing to JSON first.
Or use the fs package (you can also use fs-extra) and save/load the settings to a file yourself.

There's a key/value store in Joplin which I'm planning to expose in the plugin API, as that would make it easier to quickly save/load cache and other settings.

tessus · 15 November 2020 19:38

We should require a pliugin namespace or add it automatically for new settings from plugins. Otherwise this could be a mess when 2 plugins try to use the same setting name.

laurent · 15 November 2020 19:50

It's all there

github.com

laurent22/joplin/blob/f45029b2e8cf41d8e4f8b0617bf8e3f175b93148/packages/lib/services/plugins/api/JoplinSettings.ts#L21


*
* [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/settings)
*/
export default class JoplinSettings {
	private plugin_: Plugin = null;

	constructor(plugin: Plugin) {
		this.plugin_ = plugin;
	}

	// Ensures that the plugin settings and sections are within their own namespace, to prevent them from
	// overwriting other plugin settings or the default settings.
	private namespacedKey(key: string): string {
		return `plugin-${this.plugin_.id}.${key}`;
	}

	/**
	 * Registers a new setting. Note that registering a setting item is dynamic and will be gone next time Joplin starts.
	 * What it means is that you need to register the setting every time the plugin starts (for example in the onStart event).
	 * The setting value however will be preserved from one launch to the next so there is no risk that it will be lost even if for some
	 * reason the plugin fails to start at some point.

danpeig · 16 November 2020 14:23

Thank you! Private setting means it will not be visible in the settings page?

laurent · 16 November 2020 14:30

Yes that's right.

Topic		Replies	Views
Best way to persist plugin-specific data Plugins	6	856	24 April 2023
[Beta] Easier workflow for making plugins Plugins	12	812	20 May 2021
Can plugins cause trouble at all? Support	4	444	12 December 2020
Tutorial for getting started on Joplin plugin ecosystem? Development	3	1078	3 November 2020
Plugins - multiple questions - sharing, publishing etc Plugins	4	588	25 April 2023

Plugins API - Saving settings

Related Topics