Initial commit with first commands

Author: benji300

.gitignore

@@ -0,0 +1,4 @@
+dist/
+node_modules/
+*.tgz
+*.zip

CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+> Requires Joplin v1.3.9!
+
 * Initial Release
 
 ## [1.0.0] - yyyy-mm-dd

README.md

@@ -1,63 +1,108 @@
-# Note extensions
+# Joplin Note Extensions
 
-_note-extensions_ is a plugin to extend the UX and UI of [Joplin](https://joplinapp.org/)'s desktop application.
+_joplin-note-ext_ is a plugin to extend the UX [Joplin](https://joplinapp.org/)'s desktop application.
 
-It provides a collection of [commands](#commands) and [UI enhancements](#ui-enhancements) for working with notes and to-dos.
+It provides a collection of [new commands](#new-commands) and adapts some [existing commands](#mapped-commands) to enhance working with notes and to-dos.
 
 > **NOTE** - This plugin requires at least Joplin v1.3.9!
 
 ## Table of contents
 
-* [Features](#features)
-  * [Commands](#commands)
-  * [UI enhancements](#ui-enhancements)
-  * [User options](#user-options)
-* [Installation](#installation)
-* [UI tweaks](#ui-tweaks)
-* [Support](#support)
-* [License](#license)
+- [Features](#features)
+- [New commands](#commands)
+- [Mapped commands](#mapped-commands)
+- [User options](#user-options)
+- [Installation](#installation)
+- [Uninstallation](#uninstallation)
+- [UI tweaks](#ui-tweaks)
+- [Support](#support)
+- [Changes](#changes)
+- [License](#license)
 
 ## Features
 
-### Commands
+TODO
 
-> TODO - describe new commands (if available). For example:
+- new commands
+- mapped commands
+- new commands user options
 
-- Add new Note (`addNewNote`)
-  - Adds a new note to the list
+## New Commands
 
-### UI enhancements
+> **NOTE** - Default keyboard shortcuts can be changed in user options.
+> Navigate to `Tools > Options > Keyboard Shortcuts` and search for the command label to be changed.
 
-> TODO - describe additions to the UI (with images, if available)\
-> New panels, views, dialogs, ... in sub-chapters
+### Toggle to-do state
 
-- Adds context menu entry: `Add new Note`
+| Command           | Command ID        | Default Key             |
+| ----------------- | ----------------- | ----------------------- |
+| Touch to-do state | `toggleTodoState` | `CmdOrCtrl+Shift+Space` |
 
-To get the best result, check out the [UI tweaks](#ui-tweaks).
+TODO describe more detailed...
 
-### User options
+### Touch note
 
-> TODO - describe added User options (if available)
+| Command    | Command ID  | Default Key |
+| ---------- | ----------- | ----------- |
+| Touch note | `touchNote` | -           |
 
-## Installation
+TODO describe more detailed...
+
+### Set URL
+
+| Command | Command ID | Default Key |
+| ------- | ---------- | ----------- |
+| Set URL | `editURL`  | -           |
+
+TODO describe more detailed...
+
+### Move notes
+
+| Command             | Command ID         | Default Key            |
+| ------------------- | ------------------ | ---------------------- |
+| Move note to top    | `moveNoteToTop`    | `CmdOrCtrl+Alt+Up`     |
+| Move note up        | `moveNoteUp`       | `CmdOrCtrl+Shift+Up`   |
+| Move note down      | `moveNoteDown`     | `CmdOrCtrl+Shift+Down` |
+| Move note to bottom | `moveNoteToBottom` | `CmdOrCtrl+Alt+Down`   |
+
+TODO describe more detailed...
+
+> **NOTE** TODO works only in custom order mode
 
-> TODO - steps to install the plugin
+## Mapped commands
 
-## UI tweaks
+## User options
 
-> TODO - describe how to change `webview.css` or `userchrome.css` (if available)
+This plugin adds the following user options which can be accessed via `Tools > Options > Note Extensions`.
 
-### General styles
+> **NOTE** - TODO changing requires restart
 
-E.g. to not show something which is displayed elsewhere via the new plugin).
+- Show [Toggle to-do state](#toggle-to-do-state) button on note toolbar:\
+  _Select whether an button for the command shall be shown on the note toolbar (next to note title) or not_
+
+> TODO - Add user options here...
+
+### UI enhancements
+
+This plugin adds the following elements to the UI.
+
+To get the best result, check out the [UI tweaks](#ui-tweaks) also.
+
+> TODO - describe additions to the UI (with screenshots, if available)
+> New panels, views, dialogs, ... in sub-chapters
+> Otherwise remove chapters
+
+## Installation
 
-### Rendered Markdown
+> TODO - Add steps to install the plugin here...
 
+## Uninstallation
 
+> TODO - Add steps to uninstall the plugin here...
 
 ## Support
 
-If you need help or found a bug, open an issue on [GitHub](https://github.com/benji300-joplin-extensions/note-extensions/issues).
+If you need help or found a bug, open an issue on [GitHub](https://github.com/benji300/joplin-note-ext/issues).
 
 ## Changes
 

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

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

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', "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/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>;
+}

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

api/JoplinPlugins.d.ts

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