Desktop: Added support for Menu API for plugins

Author: laurent22

.eslintignore

@@ -264,11 +264,13 @@ ReactNativeClient/lib/services/plugins/api/JoplinSettings.js
 ReactNativeClient/lib/services/plugins/api/JoplinViews.js
 ReactNativeClient/lib/services/plugins/api/JoplinViewsDialogs.js
 ReactNativeClient/lib/services/plugins/api/JoplinViewsMenuItems.js
+ReactNativeClient/lib/services/plugins/api/JoplinViewsMenus.js
 ReactNativeClient/lib/services/plugins/api/JoplinViewsPanels.js
 ReactNativeClient/lib/services/plugins/api/JoplinViewsToolbarButtons.js
 ReactNativeClient/lib/services/plugins/api/JoplinWorkspace.js
 ReactNativeClient/lib/services/plugins/api/types.js
 ReactNativeClient/lib/services/plugins/BasePluginRunner.js
+ReactNativeClient/lib/services/plugins/MenuController.js
 ReactNativeClient/lib/services/plugins/MenuItemController.js
 ReactNativeClient/lib/services/plugins/Plugin.js
 ReactNativeClient/lib/services/plugins/PluginService.js

.gitignore

@@ -258,11 +258,13 @@ ReactNativeClient/lib/services/plugins/api/JoplinSettings.js
 ReactNativeClient/lib/services/plugins/api/JoplinViews.js
 ReactNativeClient/lib/services/plugins/api/JoplinViewsDialogs.js
 ReactNativeClient/lib/services/plugins/api/JoplinViewsMenuItems.js
+ReactNativeClient/lib/services/plugins/api/JoplinViewsMenus.js
 ReactNativeClient/lib/services/plugins/api/JoplinViewsPanels.js
 ReactNativeClient/lib/services/plugins/api/JoplinViewsToolbarButtons.js
 ReactNativeClient/lib/services/plugins/api/JoplinWorkspace.js
 ReactNativeClient/lib/services/plugins/api/types.js
 ReactNativeClient/lib/services/plugins/BasePluginRunner.js
+ReactNativeClient/lib/services/plugins/MenuController.js
 ReactNativeClient/lib/services/plugins/MenuItemController.js
 ReactNativeClient/lib/services/plugins/Plugin.js
 ReactNativeClient/lib/services/plugins/PluginService.js

CliClient/tests/support/plugins/menu/.gitignore

@@ -0,0 +1,2 @@
+dist/*
+node_modules/

CliClient/tests/support/plugins/menu/README.md

@@ -0,0 +1,14 @@
+# Joplin Plugin
+
+This is a template to create a new Joplin plugin.
+
+The main two files you will want to look at are:
+
+- `/src/index.ts`, which contains the entry point for the plugin source code.
+- `/src/manifest.json`, which is the plugin manifest. It contains information such as the plugin a name, version, etc.
+
+The plugin is built using webpack, which create the compiled code in `/dist`. The project is setup to use TypeScript, although you can change the configuration to use plain JavaScript.
+
+## Building the plugin
+
+To build the plugin, simply run `npm run dist`.

CliClient/tests/support/plugins/menu/api/Global.d.ts

@@ -0,0 +1,15 @@
+import Plugin from '../Plugin';
+import Joplin from './Joplin';
+import Logger from 'lib/Logger';
+/**
+ * @ignore
+ */
+export default class Global {
+    private joplin_;
+    private requireWhiteList_;
+    constructor(logger: Logger, implementation: any, plugin: Plugin, store: any);
+    get joplin(): Joplin;
+    private requireWhiteList;
+    require(filePath: string): any;
+    get process(): any;
+}

CliClient/tests/support/plugins/menu/api/Joplin.d.ts

@@ -0,0 +1,38 @@
+import Plugin from '../Plugin';
+import JoplinData from './JoplinData';
+import JoplinPlugins from './JoplinPlugins';
+import JoplinWorkspace from './JoplinWorkspace';
+import JoplinFilters from './JoplinFilters';
+import JoplinCommands from './JoplinCommands';
+import JoplinViews from './JoplinViews';
+import JoplinInterop from './JoplinInterop';
+import JoplinSettings from './JoplinSettings';
+import Logger from 'lib/Logger';
+/**
+ * This is the main entry point to the Joplin API. You can access various services using the provided accessors.
+ */
+export default class Joplin {
+    private data_;
+    private plugins_;
+    private workspace_;
+    private filters_;
+    private commands_;
+    private views_;
+    private interop_;
+    private settings_;
+    constructor(logger: Logger, implementation: any, plugin: Plugin, store: any);
+    get data(): JoplinData;
+    get plugins(): JoplinPlugins;
+    get workspace(): JoplinWorkspace;
+    /**
+     * @ignore
+     *
+     * Not sure if it's the best way to hook into the app
+     * so for now disable filters.
+     */
+    get filters(): JoplinFilters;
+    get commands(): JoplinCommands;
+    get views(): JoplinViews;
+    get interop(): JoplinInterop;
+    get settings(): JoplinSettings;
+}

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

@@ -0,0 +1,51 @@
+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/tree/dev/CliClient/tests/support/plugins/register_command)
+ *
+ * ## Executing Joplin's internal commands
+ *
+ * It is also possible to execute internal Joplin's commands which, as of now, are not well documented.
+ * You can find the list directly on GitHub though at the following locations:
+ *
+ * https://github.com/laurent22/joplin/tree/dev/ElectronClient/gui/MainScreen/commands
+ * https://github.com/laurent22/joplin/tree/dev/ElectronClient/commands
+ * https://github.com/laurent22/joplin/tree/dev/ElectronClient/gui/NoteEditor/commands/editorCommandDeclarations.ts
+ *
+ * To view what arguments are supported, you can open any of these files and look at the `execute()` command.
+ */
+export default class JoplinCommands {
+    /**
+     * <span class="platform-desktop">desktop</span> Executes the given command.
+     * The `props` are the arguments passed to the command, and they vary based on the command
+     *
+     * ```typescript
+     * // Create a new note in the current notebook:
+     * await joplin.commands.execute('newNote');
+     *
+     * // 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" });
+     * ```
+     */
+    execute(commandName: string, props?: any): Promise<any>;
+    /**
+     * <span class="platform-desktop">desktop</span> Registers a new command.
+     *
+     * ```typescript
+     * // Register a new commmand called "testCommand1"
+     *
+     * await joplin.commands.register({
+     *     name: 'testCommand1',
+     *     label: 'My Test Command 1',
+     *     iconName: 'fas fa-music',
+     *     execute: () => {
+     *         alert('Testing plugin command 1');
+     *     },
+     * });
+     * ```
+     */
+    register(command: Command): Promise<void>;
+}

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

@@ -0,0 +1,47 @@
+import { Path } from './types';
+/**
+ * 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/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:
+ *
+ * * `path`: This is an array that represents the path to the resource in the form `["resouceName", "resourceId", "resourceLink"]` (eg. ["tags", ":id", "notes"]). The "resources" segment is the name of the resources you want to access (eg. "notes", "folders", etc.). If not followed by anything, it will refer to all the resources in that collection. The optional "resourceId" points to a particular resources within the collection. Finally, an optional "link" can be present, which links the resource to a collection of resources. This can be used in the API for example to retrieve all the notes associated with a tag.
+ * * `query`: (Optional) The query parameters. In a URL, this is the part after the question mark "?". In this case, it should be an object with key/value pairs.
+ * * `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/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:
+ *
+ * ```typescript
+ * // Get a note ID, title and body
+ * const noteId = 'some_note_id';
+ * const note = await joplin.data.get(['notes', noteId], { fields: ['id', 'title', 'body'] });
+ *
+ * // Get all folders
+ * const folders = await joplin.data.get(['folders']);
+ *
+ * // Set the note body
+ * await joplin.data.put(['notes', noteId], null, { body: "New note body" });
+ *
+ * // Create a new note under one of the folders
+ * await joplin.data.post(['notes'], null, { body: "my new note", title: "some title", parent_id: folders[0].id });
+ * ```
+ */
+export default class JoplinData {
+    private api_;
+    private pathSegmentRegex_;
+    private serializeApiBody;
+    private pathToString;
+    get(path: Path, query?: any): Promise<any>;
+    post(path: Path, query?: any, body?: any, files?: any[]): Promise<any>;
+    put(path: Path, query?: any, body?: any, files?: any[]): Promise<any>;
+    delete(path: Path, query?: any): Promise<any>;
+}

CliClient/tests/support/plugins/menu/api/JoplinFilters.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @ignore
+ *
+ * Not sure if it's the best way to hook into the app
+ * so for now disable filters.
+ */
+export default class JoplinFilters {
+    on(name: string, callback: Function): Promise<void>;
+    off(name: string, callback: Function): Promise<void>;
+}

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

@@ -0,0 +1,17 @@
+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/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/references/rest_api/
+ */
+export default class JoplinInterop {
+    registerExportModule(module: ExportModule): Promise<void>;
+    registerImportModule(module: ImportModule): Promise<void>;
+}