Added openProfileDirectory directory command and menu item

* Updated italian translation

* Updated translator name and email

.eslintignore

@@ -81,6 +81,7 @@ ElectronClient/app.js
 ElectronClient/bridge.js
 ElectronClient/commands/copyDevCommand.js
 ElectronClient/commands/focusElement.js
+ElectronClient/commands/openProfileDirectory.js
 ElectronClient/commands/startExternalEditing.js
 ElectronClient/commands/stopExternalEditing.js
 ElectronClient/commands/toggleExternalEditing.js

.gitignore

@@ -75,6 +75,7 @@ ElectronClient/app.js
 ElectronClient/bridge.js
 ElectronClient/commands/copyDevCommand.js
 ElectronClient/commands/focusElement.js
+ElectronClient/commands/openProfileDirectory.js
 ElectronClient/commands/startExternalEditing.js
 ElectronClient/commands/stopExternalEditing.js
 ElectronClient/commands/toggleExternalEditing.js

.ignore

@@ -24,6 +24,7 @@ ElectronClient/app.js
 ElectronClient/bridge.js
 ElectronClient/commands/copyDevCommand.js
 ElectronClient/commands/focusElement.js
+ElectronClient/commands/openProfileDirectory.js
 ElectronClient/commands/startExternalEditing.js
 ElectronClient/commands/stopExternalEditing.js
 ElectronClient/commands/toggleExternalEditing.js

CliClient/locales-build/index.js

@@ -38,42 +38,42 @@ locales['tr_TR'] = require('./tr_TR.json');
 locales['vi'] = require('./vi.json');
 locales['zh_CN'] = require('./zh_CN.json');
 locales['zh_TW'] = require('./zh_TW.json');
-stats['ar'] = {"percentDone":80};
-stats['eu'] = {"percentDone":34};
-stats['bs_BA'] = {"percentDone":83};
-stats['bg_BG'] = {"percentDone":66};
-stats['ca'] = {"percentDone":96};
+stats['ar'] = {"percentDone":79};
+stats['eu'] = {"percentDone":33};
+stats['bs_BA'] = {"percentDone":82};
+stats['bg_BG'] = {"percentDone":65};
+stats['ca'] = {"percentDone":95};
 stats['hr_HR'] = {"percentDone":27};
-stats['cs_CZ'] = {"percentDone":82};
-stats['da_DK'] = {"percentDone":74};
-stats['de_DE'] = {"percentDone":98};
-stats['et_EE'] = {"percentDone":66};
+stats['cs_CZ'] = {"percentDone":99};
+stats['da_DK'] = {"percentDone":73};
+stats['de_DE'] = {"percentDone":97};
+stats['et_EE'] = {"percentDone":65};
 stats['en_GB'] = {"percentDone":100};
 stats['en_US'] = {"percentDone":100};
-stats['es_ES'] = {"percentDone":95};
-stats['eo'] = {"percentDone":38};
-stats['fr_FR'] = {"percentDone":99};
-stats['gl_ES'] = {"percentDone":43};
-stats['id_ID'] = {"percentDone":93};
-stats['it_IT'] = {"percentDone":90};
-stats['nl_BE'] = {"percentDone":34};
-stats['nl_NL'] = {"percentDone":95};
-stats['nb_NO'] = {"percentDone":88};
-stats['fa'] = {"percentDone":83};
-stats['pl_PL'] = {"percentDone":98};
-stats['pt_PT'] = {"percentDone":88};
-stats['pt_BR'] = {"percentDone":96};
+stats['es_ES'] = {"percentDone":99};
+stats['eo'] = {"percentDone":37};
+stats['fr_FR'] = {"percentDone":98};
+stats['gl_ES'] = {"percentDone":42};
+stats['id_ID'] = {"percentDone":92};
+stats['it_IT'] = {"percentDone":98};
+stats['nl_BE'] = {"percentDone":33};
+stats['nl_NL'] = {"percentDone":94};
+stats['nb_NO'] = {"percentDone":87};
+stats['fa'] = {"percentDone":82};
+stats['pl_PL'] = {"percentDone":97};
+stats['pt_PT'] = {"percentDone":98};
+stats['pt_BR'] = {"percentDone":95};
 stats['ro'] = {"percentDone":77};
 stats['sl_SI'] = {"percentDone":42};
 stats['sv'] = {"percentDone":70};
 stats['th_TH'] = {"percentDone":52};
-stats['vi'] = {"percentDone":85};
-stats['tr_TR'] = {"percentDone":98};
-stats['el_GR'] = {"percentDone":96};
-stats['ru_RU'] = {"percentDone":95};
-stats['sr_RS'] = {"percentDone":71};
-stats['zh_CN'] = {"percentDone":96};
-stats['zh_TW'] = {"percentDone":95};
-stats['ja_JP'] = {"percentDone":98};
-stats['ko'] = {"percentDone":98};
+stats['vi'] = {"percentDone":84};
+stats['tr_TR'] = {"percentDone":97};
+stats['el_GR'] = {"percentDone":95};
+stats['ru_RU'] = {"percentDone":94};
+stats['sr_RS'] = {"percentDone":70};
+stats['zh_CN'] = {"percentDone":95};
+stats['zh_TW'] = {"percentDone":94};
+stats['ja_JP'] = {"percentDone":97};
+stats['ko'] = {"percentDone":99};
 module.exports = { locales: locales, stats: stats };

CliClient/tests/services_rest_Api.ts

@@ -183,6 +183,59 @@ describe('services_rest_Api', function() {
 
 		expect(response.user_updated_time).toBe(updatedTime);
 		expect(response.user_created_time).toBe(createdTime);
+
+		const timeBefore = Date.now();
+
+		response = await api.route('POST', 'notes', null, JSON.stringify({
+			parent_id: f.id,
+		}));
+
+		const newNote = await Note.load(response.id);
+		expect(newNote.user_updated_time).toBeGreaterThanOrEqual(timeBefore);
+		expect(newNote.user_created_time).toBeGreaterThanOrEqual(timeBefore);
+	}));
+
+	it('should preserve user timestamps when updating notes', asyncTest(async () => {
+		const folder = await Folder.save({ title: 'mon carnet' });
+
+		const updatedTime = Date.now() - 1000;
+		const createdTime = Date.now() - 10000;
+
+		const response = await api.route('POST', 'notes', null, JSON.stringify({
+			parent_id: folder.id,
+		}));
+
+		const noteId = response.id;
+
+		{
+			// Check that if user timestamps are supplied, they are preserved by the API
+
+			await api.route('PUT', `notes/${noteId}`, null, JSON.stringify({
+				user_updated_time: updatedTime,
+				user_created_time: createdTime,
+				title: 'mod',
+			}));
+
+			const modNote = await Note.load(noteId);
+			expect(modNote.title).toBe('mod');
+			expect(modNote.user_updated_time).toBe(updatedTime);
+			expect(modNote.user_created_time).toBe(createdTime);
+		}
+
+		{
+			// Check if no user timestamps are supplied they are automatically updated.
+
+			const beforeTime = Date.now();
+
+			await api.route('PUT', `notes/${noteId}`, null, JSON.stringify({
+				title: 'mod2',
+			}));
+
+			const modNote = await Note.load(noteId);
+			expect(modNote.title).toBe('mod2');
+			expect(modNote.user_updated_time).toBeGreaterThanOrEqual(beforeTime);
+			expect(modNote.user_created_time).toBeGreaterThanOrEqual(createdTime);
+		}
 	}));
 
 	it('should create notes with supplied ID', asyncTest(async () => {

CliClient/tests/support/plugins/content_script/api/JoplinCommands.d.ts

@@ -27,10 +27,10 @@ export default class JoplinCommands {
      *
      * // Create a new sub-notebook under the provided notebook
      * // Note: internally, notebooks are called "folders".
-     * await joplin.commands.execute('newFolder', { parent_id: "SOME_FOLDER_ID" });
+     * await joplin.commands.execute('newFolder', "SOME_FOLDER_ID");
      * ```
      */
-    execute(commandName: string, props?: any): Promise<any>;
+    execute(commandName: string, ...args: any[]): Promise<any | void>;
     /**
      * <span class="platform-desktop">desktop</span> Registers a new command.
      *

CliClient/tests/support/plugins/content_script/api/JoplinPlugins.d.ts

@@ -1,6 +1,6 @@
 import Plugin from '../Plugin';
 import Logger from 'lib/Logger';
-import { Script } from './types';
+import { ContentScriptType, Script } from './types';
 /**
  * This class provides access to plugin-related features.
  */
@@ -21,4 +21,18 @@ export default class JoplinPlugins {
      * ```
      */
     register(script: Script): Promise<void>;
+    /**
+     * Registers a new content script. Unlike regular plugin code, which runs in a separate process, content scripts run within the main process code
+     * and thus allow improved performances and more customisations in specific cases. It can be used for example to load a Markdown or editor plugin.
+     *
+     * Note that registering a content script in itself will do nothing - it will only be loaded in specific cases by the relevant app modules
+     * (eg. the Markdown renderer or the code editor). So it is not a way to inject and run arbitrary code in the app, which for safety and performance reasons is not supported.
+     *
+     * [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/content_script)
+     *
+     * @param type Defines how the script will be used. See the type definition for more information about each supported type.
+     * @param id A unique ID for the content script.
+     * @param scriptPath Must be a path relative to the plugin main script. For example, if your file content_script.js is next to your index.ts file, you would set `scriptPath` to `"./content_script.js`.
+     */
+    registerContentScript(type: ContentScriptType, id: string, scriptPath: string): Promise<void>;
 }

CliClient/tests/support/plugins/content_script/api/types.ts

@@ -3,12 +3,50 @@
 // =================================================================
 
 export interface Command {
+	/**
+	 * Name of command - must be globally unique
+	 */
 	name: string
-	label: string
+
+	/**
+	 * Label to be displayed on menu items or keyboard shortcut editor for example.
+	 * If it is missing, it's assumed it's a private command, to be called programmatically only.
+	 * In that case the command will not appear in the shortcut editor or command panel, and logically
+	 * should not be used as a menu item.
+	 */
+	label?: string
+
+	/**
+	 * Icon to be used on toolbar buttons for example
+	 */
 	iconName?: string,
-	execute(props:any):Promise<any>
-	isEnabled?(props:any):boolean
-	mapStateToProps?(state:any):any
+
+	/**
+	 * Code to be ran when the command is executed. It may return a result.
+	 */
+	execute(...args:any[]):Promise<any | void>
+
+	/**
+	 * Defines whether the command should be enabled or disabled, which in turns affects
+	 * the enabled state of any associated button or menu item.
+	 *
+	 * The condition should be expressed as a "when-clause" (as in Visual Studio Code). It's a simple boolean expression that evaluates to
+	 * `true` or `false`. It supports the following operators:
+	 *
+	 * Operator | Symbol | Example
+	 * -- | -- | --
+	 * Equality | == | "editorType == markdown"
+	 * Inequality | != | "currentScreen != config"
+	 * Or | \|\| | "noteIsTodo \|\| noteTodoCompleted"
+	 * And | && | "oneNoteSelected && !inConflictFolder"
+	 *
+	 * Currently the supported context variables aren't documented, but you can find the list there:
+	 *
+	 * https://github.com/laurent22/joplin/blob/dev/ReactNativeClient/lib/services/commands/stateToWhenClauseContext.ts
+	 *
+	 * Note: Commands are enabled by default unless you use this property.
+	 */
+	enabledCondition?: string
 }
 
 // =================================================================
@@ -277,3 +315,54 @@ export interface SettingSection {
  * [2]: (Optional) Resource link.
  */
 export type Path = string[];
+
+// =================================================================
+// Plugins type
+// =================================================================
+
+export enum ContentScriptType {
+	/**
+	 * Registers a new Markdown-It plugin, which should follow this template:
+	 *
+	 * ```javascript
+	 * // The module should export an object as below:
+	 *
+	 * module.exports = {
+	 *
+	 *     // The "context" variable is currently unused but could be used later on to provide
+	 *     // access to your own plugin so that the content script and plugin can communicate.
+	 *     default: function(context) {
+	 *         return {
+	 *
+	 *             // This is the actual Markdown-It plugin - check the [official doc](https://github.com/markdown-it/markdown-it) for more information
+	 *             // The `options` parameter is of type [RuleOptions](https://github.com/laurent22/joplin/blob/dev/ReactNativeClient/lib/joplin-renderer/MdToHtml.ts), which
+	 *             // contains a number of options, mostly useful for Joplin's internal code.
+	 *             plugin: function(markdownIt, options) {
+	 *                 // ...
+	 *             },
+	 *
+	 *             // You may also specify additional assets such as JS or CSS that should be loaded in the rendered HTML document.
+	 *             // Check for example the Joplin [Mermaid plugin](https://github.com/laurent22/joplin/blob/dev/ReactNativeClient/lib/joplin-renderer/MdToHtml/rules/mermaid.ts) to
+	 *             // see how the data should be structured.
+	 *             assets: {},
+	 *         }
+	 *     }
+	 * }
+	 * ```
+	 *
+	 * To include a regular Markdown-It plugin, that doesn't make use of any Joplin-specific feature, you
+	 * would simply create a file such as this:
+	 *
+	 * ```javascript
+	 * module.exports = {
+	 *     default: function(context) {
+	 *         return {
+	 *             plugin: require('markdown-it-toc-done-right');
+	 *         }
+	 *     }
+	 * }
+	 * ```
+	 */
+	MarkdownItPlugin = 'markdownItPlugin',
+	CodeMirrorPlugin = 'codeMirrorPlugin',
+}

CliClient/tests/support/plugins/content_script/src/index.ts

@@ -2,6 +2,6 @@ import joplin from 'api';
 
 joplin.plugins.register({
 	onStart: async function() {
-		await (joplin.plugins as any).registerContentScript('markdownItPlugin', 'justtesting', './markdownItTestPlugin.js');
+		await joplin.plugins.registerContentScript('markdownItPlugin', 'justtesting', './markdownItTestPlugin.js');
 	},
 });

CliClient/tests/support/plugins/dialog/api/JoplinCommands.d.ts

@@ -3,7 +3,7 @@ import { Command } from './types';
  * This class allows executing or registering new Joplin commands. Commands can be executed or associated with
  * {@link JoplinViewsToolbarButtons | toolbar buttons} or {@link JoplinViewsMenuItems | menu items}.
  *
- * [View the demo plugin](https://github.com/laurent22/joplin/CliClient/tests/support/plugins/register_command)
+ * [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/register_command)
  *
  * ## Executing Joplin's internal commands
  *
@@ -27,10 +27,10 @@ export default class JoplinCommands {
      *
      * // Create a new sub-notebook under the provided notebook
      * // Note: internally, notebooks are called "folders".
-     * await joplin.commands.execute('newFolder', { parent_id: "SOME_FOLDER_ID" });
+     * await joplin.commands.execute('newFolder', "SOME_FOLDER_ID");
      * ```
      */
-    execute(commandName: string, props?: any): Promise<any>;
+    execute(commandName: string, ...args: any[]): Promise<any | void>;
     /**
      * <span class="platform-desktop">desktop</span> Registers a new command.
      *

CliClient/tests/support/plugins/dialog/api/JoplinData.d.ts

@@ -1,12 +1,12 @@
 import { Path } from './types';
 /**
- * This module provides access to the Joplin data API: https://joplinapp.org/api/
+ * This module provides access to the Joplin data API: https://joplinapp.org/api/references/rest_api/
  * This is the main way to retrieve data, such as notes, notebooks, tags, etc.
  * or to update them or delete them.
  *
  * This is also what you would use to search notes, via the `search` endpoint.
  *
- * [View the demo plugin](https://github.com/laurent22/joplin/CliClient/tests/support/plugins/simple)
+ * [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/simple)
  *
  * In general you would use the methods in this class as if you were using a REST API. There are four methods that map to GET, POST, PUT and DELETE calls.
  * And each method takes these parameters:
@@ -16,7 +16,7 @@ import { Path } from './types';
  * * `data`: (Optional) Applies to PUT and POST calls only. The request body contains the data you want to create or modify, for example the content of a note or folder.
  * * `files`: (Optional) Used to create new resources and associate them with files.
  *
- * Please refer to the [Joplin API documentation](https://joplinapp.org/api/) for complete details about each call. As the plugin runs within the Joplin application **you do not need an authorisation token** to use this API.
+ * Please refer to the [Joplin API documentation](https://joplinapp.org/api/references/rest_api/) for complete details about each call. As the plugin runs within the Joplin application **you do not need an authorisation token** to use this API.
  *
  * For example:
  *

CliClient/tests/support/plugins/dialog/api/JoplinInterop.d.ts

@@ -2,14 +2,14 @@ import { ExportModule, ImportModule } from './types';
 /**
  * Provides a way to create modules to import external data into Joplin or to export notes into any arbitrary format.
  *
- * [View the demo plugin](https://github.com/laurent22/joplin/CliClient/tests/support/plugins/json_export)
+ * [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/json_export)
  *
  * To implement an import or export module, you would simply define an object with various event handlers that are called
  * by the application during the import/export process.
  *
  * See the documentation of the [[ExportModule]] and [[ImportModule]] for more information.
  *
- * You may also want to refer to the Joplin API documentation to see the list of properties for each item (note, notebook, etc.) - https://joplinapp.org/api/
+ * You may also want to refer to the Joplin API documentation to see the list of properties for each item (note, notebook, etc.) - https://joplinapp.org/api/references/rest_api/
  */
 export default class JoplinInterop {
     registerExportModule(module: ExportModule): Promise<void>;

CliClient/tests/support/plugins/dialog/api/JoplinPlugins.d.ts

@@ -1,6 +1,6 @@
 import Plugin from '../Plugin';
 import Logger from 'lib/Logger';
-import { Script } from './types';
+import { ContentScriptType, Script } from './types';
 /**
  * This class provides access to plugin-related features.
  */
@@ -21,4 +21,18 @@ export default class JoplinPlugins {
      * ```
      */
     register(script: Script): Promise<void>;
+    /**
+     * Registers a new content script. Unlike regular plugin code, which runs in a separate process, content scripts run within the main process code
+     * and thus allow improved performances and more customisations in specific cases. It can be used for example to load a Markdown or editor plugin.
+     *
+     * Note that registering a content script in itself will do nothing - it will only be loaded in specific cases by the relevant app modules
+     * (eg. the Markdown renderer or the code editor). So it is not a way to inject and run arbitrary code in the app, which for safety and performance reasons is not supported.
+     *
+     * [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/content_script)
+     *
+     * @param type Defines how the script will be used. See the type definition for more information about each supported type.
+     * @param id A unique ID for the content script.
+     * @param scriptPath Must be a path relative to the plugin main script. For example, if your file content_script.js is next to your index.ts file, you would set `scriptPath` to `"./content_script.js`.
+     */
+    registerContentScript(type: ContentScriptType, id: string, scriptPath: string): Promise<void>;
 }

CliClient/tests/support/plugins/dialog/api/JoplinSettings.d.ts

@@ -7,7 +7,7 @@ import { SettingItem, SettingSection } from './types';
  *
  * 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/CliClient/tests/support/plugins/settings)
+ * [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/settings)
  */
 export default class JoplinSettings {
     private plugin_;
@@ -32,4 +32,12 @@ export default class JoplinSettings {
      * Sets a setting value (only applies to setting you registered from your plugin)
      */
     setValue(key: string, value: any): Promise<void>;
+    /**
+     * 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
+     */
+    globalValue(key: string): Promise<any>;
 }

CliClient/tests/support/plugins/dialog/api/JoplinViews.d.ts

@@ -1,6 +1,7 @@
 import Plugin from '../Plugin';
 import JoplinViewsDialogs from './JoplinViewsDialogs';
 import JoplinViewsMenuItems from './JoplinViewsMenuItems';
+import JoplinViewsMenus from './JoplinViewsMenus';
 import JoplinViewsToolbarButtons from './JoplinViewsToolbarButtons';
 import JoplinViewsPanels from './JoplinViewsPanels';
 /**
@@ -15,10 +16,13 @@ export default class JoplinViews {
     private dialogs_;
     private panels_;
     private menuItems_;
+    private menus_;
     private toolbarButtons_;
-    constructor(plugin: Plugin, store: any);
+    private implementation_;
+    constructor(implementation: any, plugin: Plugin, store: any);
     get dialogs(): JoplinViewsDialogs;
     get panels(): JoplinViewsPanels;
     get menuItems(): JoplinViewsMenuItems;
+    get menus(): JoplinViewsMenus;
     get toolbarButtons(): JoplinViewsToolbarButtons;
 }

CliClient/tests/support/plugins/dialog/api/JoplinViewsDialogs.d.ts

@@ -5,17 +5,22 @@ import { ButtonSpec, ViewHandle, ButtonId } from './types';
  * Dialogs are hidden by default and you need to call `open()` to open them. Once the user clicks on a button, the `open` call will return and provide the button ID that was
  * clicked on. There is currently no "close" method since the dialog should be thought as a modal one and thus can only be closed by clicking on one of the buttons.
  *
- * [View the demo plugin](https://github.com/laurent22/joplin/CliClient/tests/support/plugins/dialog)
+ * [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/dialog)
  */
 export default class JoplinViewsDialogs {
     private store;
     private plugin;
-    constructor(plugin: Plugin, store: any);
+    private implementation_;
+    constructor(implementation: any, plugin: Plugin, store: any);
     private controller;
     /**
      * Creates a new dialog
      */
     create(): Promise<ViewHandle>;
+    /**
+     * Displays a message box with OK/Cancel buttons. Returns the button index that was clicked - "0" for OK and "1" for "Cancel"
+     */
+    showMessageBox(message: string): Promise<number>;
     /**
      * Sets the dialog HTML content
      */

CliClient/tests/support/plugins/dialog/api/JoplinViewsMenuItems.d.ts

@@ -3,7 +3,7 @@ import Plugin from '../Plugin';
 /**
  * Allows creating and managing menu items.
  *
- * [View the demo plugin](https://github.com/laurent22/joplin/CliClient/tests/support/plugins/register_command)
+ * [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/register_command)
  */
 export default class JoplinViewsMenuItems {
     private store;

CliClient/tests/support/plugins/dialog/api/JoplinViewsMenus.d.ts

@@ -0,0 +1,18 @@
+import { MenuItem, MenuItemLocation } from './types';
+import Plugin from '../Plugin';
+/**
+ * Allows creating menus.
+ *
+ * [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/menu)
+ */
+export default class JoplinViewsMenus {
+    private store;
+    private plugin;
+    constructor(plugin: Plugin, store: any);
+    private registerCommandAccelerators;
+    /**
+     * Creates a new menu from the provided menu items and place it at the given location. As of now, it is only possible to place the
+     * menu as a sub-menu of the application build-in menus.
+     */
+    create(label: string, menuItems: MenuItem[], location?: MenuItemLocation): Promise<void>;
+}

CliClient/tests/support/plugins/dialog/api/JoplinViewsPanels.d.ts

@@ -4,7 +4,7 @@ import { ViewHandle } from './types';
  * Allows creating and managing view panels. View panels currently are displayed at the right of the sidebar and allows displaying any HTML content (within a webview) and update it in real-time. For example
  * it could be used to display a table of content for the active note, or display various metadata or graph.
  *
- * [View the demo plugin](https://github.com/laurent22/joplin/CliClient/tests/support/plugins/toc)
+ * [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/toc)
  */
 export default class JoplinViewsPanels {
     private store;

CliClient/tests/support/plugins/dialog/api/JoplinViewsToolbarButtons.d.ts

@@ -3,7 +3,7 @@ import Plugin from '../Plugin';
 /**
  * Allows creating and managing toolbar buttons.
  *
- * [View the demo plugin](https://github.com/laurent22/joplin/CliClient/tests/support/plugins/register_command)
+ * [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/register_command)
  */
 export default class JoplinViewsToolbarButtons {
     private store;

CliClient/tests/support/plugins/dialog/api/JoplinWorkspace.d.ts

@@ -2,7 +2,7 @@
  * The workspace service provides access to all the parts of Joplin that are being worked on - i.e. the currently selected notes or notebooks as well
  * as various related events, such as when a new note is selected, or when the note content changes.
  *
- * [View the demo plugin](https://github.com/laurent22/joplin/CliClient/tests/support/plugins)
+ * [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins)
  */
 export default class JoplinWorkspace {
     private store;

CliClient/tests/support/plugins/dialog/api/types.ts

@@ -3,12 +3,50 @@
 // =================================================================
 
 export interface Command {
+	/**
+	 * Name of command - must be globally unique
+	 */
 	name: string
-	label: string
+
+	/**
+	 * Label to be displayed on menu items or keyboard shortcut editor for example.
+	 * If it is missing, it's assumed it's a private command, to be called programmatically only.
+	 * In that case the command will not appear in the shortcut editor or command panel, and logically
+	 * should not be used as a menu item.
+	 */
+	label?: string
+
+	/**
+	 * Icon to be used on toolbar buttons for example
+	 */
 	iconName?: string,
-	execute(props:any):Promise<any>
-	isEnabled?(props:any):boolean
-	mapStateToProps?(state:any):any
+
+	/**
+	 * Code to be ran when the command is executed. It may return a result.
+	 */
+	execute(...args:any[]):Promise<any | void>
+
+	/**
+	 * Defines whether the command should be enabled or disabled, which in turns affects
+	 * the enabled state of any associated button or menu item.
+	 *
+	 * The condition should be expressed as a "when-clause" (as in Visual Studio Code). It's a simple boolean expression that evaluates to
+	 * `true` or `false`. It supports the following operators:
+	 *
+	 * Operator | Symbol | Example
+	 * -- | -- | --
+	 * Equality | == | "editorType == markdown"
+	 * Inequality | != | "currentScreen != config"
+	 * Or | \|\| | "noteIsTodo \|\| noteTodoCompleted"
+	 * And | && | "oneNoteSelected && !inConflictFolder"
+	 *
+	 * Currently the supported context variables aren't documented, but you can find the list there:
+	 *
+	 * https://github.com/laurent22/joplin/blob/dev/ReactNativeClient/lib/services/commands/stateToWhenClauseContext.ts
+	 *
+	 * Note: Commands are enabled by default unless you use this property.
+	 */
+	enabledCondition?: string
 }
 
 // =================================================================
@@ -26,7 +64,7 @@ export enum ImportModuleOutputFormat {
 }
 
 /**
- * Used to implement a module to export data from Joplin. [View the demo plugin](https://github.com/laurent22/joplin/CliClient/tests/support/plugins/json_export) for an example.
+ * Used to implement a module to export data from Joplin. [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/json_export) for an example.
  *
  * In general, all the event handlers you'll need to implement take a `context` object as a first argument. This object will contain the export or import path as well as various optional properties, such as which notes or notebooks need to be exported.
  *
@@ -154,17 +192,9 @@ export interface Script {
 }
 
 // =================================================================
-// View API types
+// Menu types
 // =================================================================
 
-export type ButtonId = string;
-
-export interface ButtonSpec {
-	id: ButtonId,
-	title?: string,
-	onClick?():void,
-}
-
 export interface CreateMenuItemOptions {
 	accelerator: string,
 }
@@ -179,6 +209,41 @@ export enum MenuItemLocation {
 	Context = 'context',
 }
 
+export interface MenuItem {
+	/**
+	 * Command that should be associated with the menu item. All menu item should
+	 * have a command associated with them unless they are a sub-menu.
+	 */
+	commandName?: string,
+
+	/**
+	 * Accelerator associated with the menu item
+	 */
+	accelerator?: string,
+
+	/**
+	 * Menu items that should appear below this menu item. Allows creating a menu tree.
+	 */
+	submenu?: MenuItem[],
+
+	/**
+	 * Menu item label. If not specified, the command label will be used instead.
+	 */
+	label?: string,
+}
+
+// =================================================================
+// View API types
+// =================================================================
+
+export interface ButtonSpec {
+	id: ButtonId,
+	title?: string,
+	onClick?():void,
+}
+
+export type ButtonId = string;
+
 export enum ToolbarButtonLocation {
 	/**
 	 * This toolbar in the top right corner of the application. It applies to the note as a whole, including its metadata.
@@ -250,3 +315,54 @@ export interface SettingSection {
  * [2]: (Optional) Resource link.
  */
 export type Path = string[];
+
+// =================================================================
+// Plugins type
+// =================================================================
+
+export enum ContentScriptType {
+	/**
+	 * Registers a new Markdown-It plugin, which should follow this template:
+	 *
+	 * ```javascript
+	 * // The module should export an object as below:
+	 *
+	 * module.exports = {
+	 *
+	 *     // The "context" variable is currently unused but could be used later on to provide
+	 *     // access to your own plugin so that the content script and plugin can communicate.
+	 *     default: function(context) {
+	 *         return {
+	 *
+	 *             // This is the actual Markdown-It plugin - check the [official doc](https://github.com/markdown-it/markdown-it) for more information
+	 *             // The `options` parameter is of type [RuleOptions](https://github.com/laurent22/joplin/blob/dev/ReactNativeClient/lib/joplin-renderer/MdToHtml.ts), which
+	 *             // contains a number of options, mostly useful for Joplin's internal code.
+	 *             plugin: function(markdownIt, options) {
+	 *                 // ...
+	 *             },
+	 *
+	 *             // You may also specify additional assets such as JS or CSS that should be loaded in the rendered HTML document.
+	 *             // Check for example the Joplin [Mermaid plugin](https://github.com/laurent22/joplin/blob/dev/ReactNativeClient/lib/joplin-renderer/MdToHtml/rules/mermaid.ts) to
+	 *             // see how the data should be structured.
+	 *             assets: {},
+	 *         }
+	 *     }
+	 * }
+	 * ```
+	 *
+	 * To include a regular Markdown-It plugin, that doesn't make use of any Joplin-specific feature, you
+	 * would simply create a file such as this:
+	 *
+	 * ```javascript
+	 * module.exports = {
+	 *     default: function(context) {
+	 *         return {
+	 *             plugin: require('markdown-it-toc-done-right');
+	 *         }
+	 *     }
+	 * }
+	 * ```
+	 */
+	MarkdownItPlugin = 'markdownItPlugin',
+	CodeMirrorPlugin = 'codeMirrorPlugin',
+}

CliClient/tests/support/plugins/events/api/JoplinCommands.d.ts

@@ -3,7 +3,7 @@ import { Command } from './types';
  * This class allows executing or registering new Joplin commands. Commands can be executed or associated with
  * {@link JoplinViewsToolbarButtons | toolbar buttons} or {@link JoplinViewsMenuItems | menu items}.
  *
- * [View the demo plugin](https://github.com/laurent22/joplin/CliClient/tests/support/plugins/register_command)
+ * [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/register_command)
  *
  * ## Executing Joplin's internal commands
  *
@@ -27,10 +27,10 @@ export default class JoplinCommands {
      *
      * // Create a new sub-notebook under the provided notebook
      * // Note: internally, notebooks are called "folders".
-     * await joplin.commands.execute('newFolder', { parent_id: "SOME_FOLDER_ID" });
+     * await joplin.commands.execute('newFolder', "SOME_FOLDER_ID");
      * ```
      */
-    execute(commandName: string, props?: any): Promise<any>;
+    execute(commandName: string, ...args: any[]): Promise<any | void>;
     /**
      * <span class="platform-desktop">desktop</span> Registers a new command.
      *

CliClient/tests/support/plugins/events/api/JoplinData.d.ts

@@ -1,12 +1,12 @@
 import { Path } from './types';
 /**
- * This module provides access to the Joplin data API: https://joplinapp.org/api/
+ * This module provides access to the Joplin data API: https://joplinapp.org/api/references/rest_api/
  * This is the main way to retrieve data, such as notes, notebooks, tags, etc.
  * or to update them or delete them.
  *
  * This is also what you would use to search notes, via the `search` endpoint.
  *
- * [View the demo plugin](https://github.com/laurent22/joplin/CliClient/tests/support/plugins/simple)
+ * [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/simple)
  *
  * In general you would use the methods in this class as if you were using a REST API. There are four methods that map to GET, POST, PUT and DELETE calls.
  * And each method takes these parameters:
@@ -16,7 +16,7 @@ import { Path } from './types';
  * * `data`: (Optional) Applies to PUT and POST calls only. The request body contains the data you want to create or modify, for example the content of a note or folder.
  * * `files`: (Optional) Used to create new resources and associate them with files.
  *
- * Please refer to the [Joplin API documentation](https://joplinapp.org/api/) for complete details about each call. As the plugin runs within the Joplin application **you do not need an authorisation token** to use this API.
+ * Please refer to the [Joplin API documentation](https://joplinapp.org/api/references/rest_api/) for complete details about each call. As the plugin runs within the Joplin application **you do not need an authorisation token** to use this API.
  *
  * For example:
  *

CliClient/tests/support/plugins/events/api/JoplinInterop.d.ts

@@ -2,14 +2,14 @@ import { ExportModule, ImportModule } from './types';
 /**
  * Provides a way to create modules to import external data into Joplin or to export notes into any arbitrary format.
  *
- * [View the demo plugin](https://github.com/laurent22/joplin/CliClient/tests/support/plugins/json_export)
+ * [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/json_export)
  *
  * To implement an import or export module, you would simply define an object with various event handlers that are called
  * by the application during the import/export process.
  *
  * See the documentation of the [[ExportModule]] and [[ImportModule]] for more information.
  *
- * You may also want to refer to the Joplin API documentation to see the list of properties for each item (note, notebook, etc.) - https://joplinapp.org/api/
+ * You may also want to refer to the Joplin API documentation to see the list of properties for each item (note, notebook, etc.) - https://joplinapp.org/api/references/rest_api/
  */
 export default class JoplinInterop {
     registerExportModule(module: ExportModule): Promise<void>;