mirror of
https://github.com/laurent22/joplin.git
synced 2024-12-21 09:38:01 +02:00
88 lines
3.7 KiB
TypeScript
88 lines
3.7 KiB
TypeScript
import Setting, { SettingItem as InternalSettingItem } from 'lib/models/Setting';
|
|
import Plugin from '../Plugin';
|
|
import { SettingItem, SettingSection } from './types';
|
|
|
|
/**
|
|
* This API allows registering new settings and setting sections, as well as getting and setting settings. Once a setting has been registered it will appear in the config screen and be editable by the user.
|
|
*
|
|
* Settings are essentially key/value pairs.
|
|
*
|
|
* Note: Currently this API does **not** provide access to Joplin's built-in settings. This is by design as plugins that modify user settings could give unexpected results
|
|
*
|
|
* [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/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.
|
|
*/
|
|
async registerSetting(key:string, settingItem:SettingItem) {
|
|
const internalSettingItem:InternalSettingItem = {
|
|
key: key,
|
|
value: settingItem.value,
|
|
type: settingItem.type,
|
|
public: settingItem.public,
|
|
label: () => settingItem.label,
|
|
description: (_appType:string) => settingItem.description,
|
|
};
|
|
|
|
if ('isEnum' in settingItem) internalSettingItem.isEnum = settingItem.isEnum;
|
|
if ('section' in settingItem) internalSettingItem.section = this.namespacedKey(settingItem.section);
|
|
if ('options' in settingItem) internalSettingItem.options = settingItem.options;
|
|
if ('appTypes' in settingItem) internalSettingItem.appTypes = settingItem.appTypes;
|
|
if ('secure' in settingItem) internalSettingItem.secure = settingItem.secure;
|
|
if ('advanced' in settingItem) internalSettingItem.advanced = settingItem.advanced;
|
|
if ('minimum' in settingItem) internalSettingItem.minimum = settingItem.minimum;
|
|
if ('maximum' in settingItem) internalSettingItem.maximum = settingItem.maximum;
|
|
if ('step' in settingItem) internalSettingItem.step = settingItem.step;
|
|
|
|
return Setting.registerSetting(this.namespacedKey(key), internalSettingItem);
|
|
}
|
|
|
|
/**
|
|
* Registers a new setting section. Like for registerSetting, it is dynamic and needs to be done every time the plugin starts.
|
|
*/
|
|
async registerSection(name:string, section:SettingSection) {
|
|
return Setting.registerSection(this.namespacedKey(name), section);
|
|
}
|
|
|
|
/**
|
|
* Gets a setting value (only applies to setting you registered from your plugin)
|
|
*/
|
|
async value(key:string):Promise<any> {
|
|
return Setting.value(this.namespacedKey(key));
|
|
}
|
|
|
|
/**
|
|
* Sets a setting value (only applies to setting you registered from your plugin)
|
|
*/
|
|
async setValue(key:string, value:any) {
|
|
return Setting.setValue(this.namespacedKey(key), value);
|
|
}
|
|
|
|
/**
|
|
* Gets a global setting value, including app-specific settings and those set by other plugins.
|
|
*
|
|
* The list of available settings is not documented yet, but can be found by looking at the source code:
|
|
*
|
|
* https://github.com/laurent22/joplin/blob/3539a452a359162c461d2849829d2d42973eab50/ReactNativeClient/lib/models/Setting.ts#L142
|
|
*/
|
|
async globalValue(key:string):Promise<any> {
|
|
return Setting.value(key);
|
|
}
|
|
}
|