Initial commit

.gitignore

@@ -0,0 +1,3 @@
+dist/*
+node_modules/
+*.jpl

README.md

@@ -0,0 +1,3 @@
+# Joplin Line Numbers Plugin
+
+This plugin enables line numbers in Joplin when using Code Mirror editor.

api/Global.d.ts

@@ -0,0 +1,15 @@
+import Plugin from '../Plugin';
+import Joplin from './Joplin';
+import Logger from '../../../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;
+}

api/Joplin.d.ts

@@ -0,0 +1,50 @@
+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 '../../../Logger';
+/**
+ * This is the main entry point to the Joplin API. You can access various services using the provided accessors.
+ *
+ * **This is a beta API**
+ *
+ * Please note that the plugin API is relatively new and should be considered Beta state. Besides possible bugs, what it means is that there might be necessary breaking changes from one version to the next. Whenever such change is needed, best effort will be done to:
+ *
+ * - Maintain backward compatibility;
+ * - When possible, deprecate features instead of removing them;
+ * - Document breaking changes in the changelog;
+ *
+ * So if you are developing a plugin, please keep an eye on the changelog as everything will be in there with information about how to update your code. There won't be any major API rewrite or architecture changes, but possibly small tweaks like function signature change, type change, etc.
+ *
+ * Eventually, the plugin API will be versioned to make this process smoother.
+ */
+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;
+}

api/JoplinCommands.d.ts

@@ -0,0 +1,61 @@
+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/packages/app-cli/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:
+ *
+ * * [Main screen commands](https://github.com/laurent22/joplin/tree/dev/packages/app-desktop/gui/MainScreen/commands)
+ * * [Global commands](https://github.com/laurent22/joplin/tree/dev/packages/app-desktop/commands)
+ * * [Editor commands](https://github.com/laurent22/joplin/tree/dev/packages/app-desktop/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 command can take any number of arguments, and the supported
+     * arguments will vary based on the command. For custom commands, this
+     * is the `args` passed to the `execute()` function. For built-in
+     * commands, you can find the supported arguments by checking the links
+     * above.
+     *
+     * ```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', "SOME_FOLDER_ID");
+     * ```
+     */
+	execute(commandName: string, ...args: any[]): Promise<any | void>;
+	/**
+     * <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>;
+}

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/packages/app-cli/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>;
+}

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>;
+}

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/packages/app-cli/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>;
+}

api/JoplinPlugins.d.ts

@@ -0,0 +1,39 @@
+import Plugin from '../Plugin';
+import Logger from '../../../Logger';
+import { ContentScriptType, Script } from './types';
+/**
+ * This class provides access to plugin-related features.
+ */
+export default class JoplinPlugins {
+    private logger;
+    private plugin;
+    constructor(logger: Logger, plugin: Plugin);
+    /**
+     * Registers a new plugin. This is the entry point when creating a plugin. You should pass a simple object with an `onStart` method to it.
+     * That `onStart` method will be executed as soon as the plugin is loaded.
+     *
+     * ```typescript
+     * joplin.plugins.register({
+     *     onStart: async function() {
+     *         // Run your plugin code here
+     *     }
+     * });
+     * ```
+     */
+    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 renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script)
+     * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_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>;
+}

api/JoplinSettings.d.ts

@@ -0,0 +1,43 @@
+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/packages/app-cli/tests/support/plugins/settings)
+ */
+export default class JoplinSettings {
+    private plugin_;
+    constructor(plugin: Plugin);
+    private namespacedKey;
+    /**
+     * 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.
+     */
+    registerSetting(key: string, settingItem: SettingItem): Promise<void>;
+    /**
+     * Registers a new setting section. Like for registerSetting, it is dynamic and needs to be done every time the plugin starts.
+     */
+    registerSection(name: string, section: SettingSection): Promise<void>;
+    /**
+     * Gets a setting value (only applies to setting you registered from your plugin)
+     */
+    value(key: string): Promise<any>;
+    /**
+     * 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/packages/app-mobile/lib/models/Setting.ts#L142
+     */
+    globalValue(key: string): Promise<any>;
+}

api/JoplinViews.d.ts

@@ -0,0 +1,28 @@
+import Plugin from '../Plugin';
+import JoplinViewsDialogs from './JoplinViewsDialogs';
+import JoplinViewsMenuItems from './JoplinViewsMenuItems';
+import JoplinViewsMenus from './JoplinViewsMenus';
+import JoplinViewsToolbarButtons from './JoplinViewsToolbarButtons';
+import JoplinViewsPanels from './JoplinViewsPanels';
+/**
+ * This namespace provides access to view-related services.
+ *
+ * All view services provide a `create()` method which you would use to create the view object, whether it's a dialog, a toolbar button or a menu item.
+ * In some cases, the `create()` method will return a [[ViewHandle]], which you would use to act on the view, for example to set certain properties or call some methods.
+ */
+export default class JoplinViews {
+    private store;
+    private plugin;
+    private dialogs_;
+    private panels_;
+    private menuItems_;
+    private menus_;
+    private toolbarButtons_;
+    private implementation_;
+    constructor(implementation: any, plugin: Plugin, store: any);
+    get dialogs(): JoplinViewsDialogs;
+    get panels(): JoplinViewsPanels;
+    get menuItems(): JoplinViewsMenuItems;
+    get menus(): JoplinViewsMenus;
+    get toolbarButtons(): JoplinViewsToolbarButtons;
+}

api/JoplinViewsDialogs.d.ts

@@ -0,0 +1,58 @@
+import Plugin from '../Plugin';
+import { ButtonSpec, ViewHandle, DialogResult } from './types';
+/**
+ * Allows creating and managing dialogs. A dialog is modal window that
+ * contains a webview and a row of buttons. You can update the update the
+ * webview using the `setHtml` method. 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 an object indicating what button was
+ * clicked on.
+ *
+ * ## Retrieving form values
+ *
+ * If your HTML content included one or more forms, a `formData` object
+ * will also be included with the key/value for each form.
+ *
+ * ## Special button IDs
+ *
+ * The following buttons IDs have a special meaning:
+ *
+ * - `ok`, `yes`, `submit`, `confirm`: They are considered "submit" buttons
+ * - `cancel`, `no`, `reject`: They are considered "dismiss" buttons
+ *
+ * This information is used by the application to determine what action
+ * should be done when the user presses "Enter" or "Escape" within the
+ * dialog. If they press "Enter", the first "submit" button will be
+ * automatically clicked. If they press "Escape" the first "dismiss" button
+ * will be automatically clicked.
+ *
+ * [View the demo
+ * plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/dialog)
+ */
+export default class JoplinViewsDialogs {
+    private store;
+    private plugin;
+    private implementation_;
+    constructor(implementation: any, plugin: Plugin, store: any);
+    private controller;
+    /**
+     * Creates a new dialog
+     */
+    create(id: string): 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
+     */
+    setHtml(handle: ViewHandle, html: string): Promise<string>;
+    /**
+     * Sets the dialog buttons.
+     */
+    setButtons(handle: ViewHandle, buttons: ButtonSpec[]): Promise<ButtonSpec[]>;
+    /**
+     * Opens the dialog
+     */
+    open(handle: ViewHandle): Promise<DialogResult>;
+}