Merge pull request #50 from benji300/release-1.4

Release v1.4.0

CHANGELOG.md

@@ -9,6 +9,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - None
 
+## [1.4.0] - 2021-08-10
+
+### Added
+
+- User option `Show checklist completion status` to display the completion status of all checklists in the selected note
+- Ability to unpin note with middle button click on tab
+
+### Changed
+
+- Updated plugin API to version v1.8.2 (`registerSettings`) to support app version v2.2.4 or newer
+
+### Fixed
+
+- Escape html characters from note titles before using them as tab titles
+- Removing the tab of a completed but unpinned (temporary) to-do when editing the content of the note
+  - Occured only when 'Unpin active tab behavior' was set to a value other than 'Keep selected'
+
+### Removed
+
+- Bundled font packages (FontAwesome, Roboto). Use built-in versions now
+
 ## [1.3.0] - 2021-03-09
 
 ### Added

README.md

@@ -4,31 +4,15 @@ Note Tabs is a plugin to extend the UX and UI of [Joplin's](https://joplinapp.or
 
 It allows to open several notes at once in tabs and pin them to be kept open.
 
-> :warning: **CAUTION** - Requires Joplin **v1.6.7** or newer
-
-## Table of contents
-
-- [Features](#features)
-  - [Screenshots](#screenshots)
-- [Installation](#installation)
-- [Usage](#usage)
-  - [Place the panel](#place-the-panel)
-- [Commands](#commands)
-  - [Keyboard shortcuts](#keyboard-shortcuts)
-- [User options](#user-options)
-- [UI Tweaks](#ui-tweaks)
-- [Feedback](#feedback)
-- [Support](#support)
-- [Development](#development)
-- [Changes](#changes)
-- [License](#license)
+> :warning: **CAUTION** - Requires Joplin **v1.8.2** or newer
 
 ## Features
 
 - Display selected note as tab
 - Additional display options below the tabs
-  - Full breadcrumbs for selected note
   - Navigation buttons (`historyBackward/Forward`)
+  - Completion status of all checklists in selected note
+  - Full breadcrumbs for selected note
 - Pin note(s) to the tabs
   - Either via command or drag & drop from the note list
 - Save pinned tabs permanently
@@ -66,7 +50,7 @@ It allows to open several notes at once in tabs and pin them to be kept open.
 ### Automatic (Joplin v1.6.4 and newer)
 
 - Open Joplin and navigate to `Tools > Options > Plugins`
-- Search for `tabs` and press install
+- Search for the plugin name and press install
 - Restart Joplin to enable the plugin
 - By default the panel will appear on the right side of the screen, see how to [place the panel](#place-the-panel)
 
@@ -82,8 +66,7 @@ It allows to open several notes at once in tabs and pin them to be kept open.
 ### Uninstall
 
 - Open Joplin and navigate to `Tools > Options > Plugins`
-- Search for the `Note Tabs` plugin
-- Press `Delete` to remove the plugin completely
+- Search for the plugin name and press `Delete` to remove the plugin completely
   - Alternatively you can also disable the plugin by clicking on the toggle button
 - Restart Joplin
 
@@ -160,7 +143,7 @@ In the keyboard shortcut editor, search for the command label where shortcuts sh
 
 ## User options
 
-This plugin adds provides user options which can be changed via `Tools > Options > Note Tabs`.
+This plugin adds provides user options which can be changed via `Tools > Options > Note Tabs` (Windows App).
 
 > **NOTE** - If `default` is set for an advanced style setting, the corresponding default color, font family, etc. will be used to match the common App look.
 
@@ -203,7 +186,7 @@ Follow these steps to hide it via the `userchrome.css` stylesheet:
 
 You like this plugin as much as I do and it improves your daily work with Joplin?
 
-Then I would be very happy if you buy me a beer via [PayPal](https://www.paypal.com/donate?hosted_button_id=6FHDGK3PTNU22) :wink::beer:
+Then I would be very happy if you buy me a :beer: or :coffee: via [PayPal](https://www.paypal.com/donate?hosted_button_id=6FHDGK3PTNU22) :wink:
 
 ## Development
 

api/Global.d.ts

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

api/Joplin.d.ts

@@ -8,6 +8,8 @@ import JoplinViews from './JoplinViews';
 import JoplinInterop from './JoplinInterop';
 import JoplinSettings from './JoplinSettings';
 import JoplinContentScripts from './JoplinContentScripts';
+import JoplinClipboard from './JoplinClipboard';
+import JoplinWindow from './JoplinWindow';
 /**
  * This is the main entry point to the Joplin API. You can access various services using the provided accessors.
  *
@@ -33,8 +35,12 @@ export default class Joplin {
     private interop_;
     private settings_;
     private contentScripts_;
+    private clipboard_;
+    private window_;
     constructor(implementation: any, plugin: Plugin, store: any);
     get data(): JoplinData;
+    get clipboard(): JoplinClipboard;
+    get window(): JoplinWindow;
     get plugins(): JoplinPlugins;
     get workspace(): JoplinWorkspace;
     get contentScripts(): JoplinContentScripts;
@@ -49,4 +55,17 @@ export default class Joplin {
     get views(): JoplinViews;
     get interop(): JoplinInterop;
     get settings(): JoplinSettings;
+    /**
+     * It is not possible to bundle native packages with a plugin, because they
+     * need to work cross-platforms. Instead access to certain useful native
+     * packages is provided using this function.
+     *
+     * Currently these packages are available:
+     *
+     * - [sqlite3](https://www.npmjs.com/package/sqlite3)
+     * - [fs-extra](https://www.npmjs.com/package/fs-extra)
+     *
+     * [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/nativeModule)
+     */
+    require(_path: string): any;
 }

api/JoplinClipboard.d.ts

@@ -0,0 +1,23 @@
+export default class JoplinClipboard {
+    private electronClipboard_;
+    private electronNativeImage_;
+    constructor(electronClipboard: any, electronNativeImage: any);
+    readText(): Promise<string>;
+    writeText(text: string): Promise<void>;
+    readHtml(): Promise<string>;
+    writeHtml(html: string): Promise<void>;
+    /**
+     * Returns the image in [data URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs) format.
+     */
+    readImage(): Promise<string>;
+    /**
+     * Takes an image in [data URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs) format.
+     */
+    writeImage(dataUrl: string): Promise<void>;
+    /**
+     * Returns the list available formats (mime types).
+     *
+     * For example [ 'text/plain', 'text/html' ]
+     */
+    availableFormats(): Promise<string[]>;
+}

api/JoplinCommands.d.ts

@@ -19,6 +19,34 @@ import { Command } from './types';
  *
  * To view what arguments are supported, you can open any of these files
  * and look at the `execute()` command.
+ *
+ * ## Executing editor commands
+ *
+ * There might be a situation where you want to invoke editor commands
+ * without using a {@link JoplinContentScripts | contentScript}. For this
+ * reason Joplin provides the built in `editor.execCommand` command.
+ *
+ * `editor.execCommand`  should work with any core command in both the
+ * [CodeMirror](https://codemirror.net/doc/manual.html#execCommand) and
+ * [TinyMCE](https://www.tiny.cloud/docs/api/tinymce/tinymce.editorcommands/#execcommand) editors,
+ * as well as most functions calls directly on a CodeMirror editor object (extensions).
+ *
+ * * [CodeMirror commands](https://codemirror.net/doc/manual.html#commands)
+ * * [TinyMCE core editor commands](https://www.tiny.cloud/docs/advanced/editor-command-identifiers/#coreeditorcommands)
+ *
+ * `editor.execCommand` supports adding arguments for the commands.
+ *
+ * ```typescript
+ * await joplin.commands.execute('editor.execCommand', {
+ *     name: 'madeUpCommand', // CodeMirror and TinyMCE
+ *     args: [], // CodeMirror and TinyMCE
+ *     ui: false, // TinyMCE only
+ *     value: '', // TinyMCE only
+ * });
+ * ```
+ *
+ * [View the example using the CodeMirror editor](https://github.com/laurent22/joplin/blob/dev/packages/app-cli/tests/support/plugins/codemirror_content_script/src/index.ts)
+ *
  */
 export default class JoplinCommands {
 	/**

api/JoplinPlugins.d.ts

@@ -23,4 +23,21 @@ export default class JoplinPlugins {
      * @deprecated Use joplin.contentScripts.register()
      */
     registerContentScript(type: ContentScriptType, id: string, scriptPath: string): Promise<void>;
+    /**
+     * Gets the plugin own data directory path. Use this to store any
+     * plugin-related data. Unlike [[installationDir]], any data stored here
+     * will be persisted.
+     */
+    dataDir(): Promise<string>;
+    /**
+     * Gets the plugin installation directory. This can be used to access any
+     * asset that was packaged with the plugin. This directory should be
+     * considered read-only because any data you store here might be deleted or
+     * re-created at any time. To store new persistent data, use [[dataDir]].
+     */
+    installationDir(): Promise<string>;
+    /**
+     * @deprecated Use joplin.require()
+     */
+    require(_path: string): any;
 }

api/JoplinSettings.d.ts

@@ -22,11 +22,18 @@ export default class JoplinSettings {
     private get keyPrefix();
     private namespacedKey;
     /**
-     * Registers a new setting. Note that registering a setting item is dynamic and will be gone next time Joplin starts.
+     * Registers new settings.
+     * 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.
      */
+    registerSettings(settings: Record<string, SettingItem>): Promise<void>;
+    /**
+     * @deprecated Use joplin.settings.registerSettings()
+     *
+     * Registers a new setting.
+     */
     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.

api/JoplinViewsDialogs.d.ts

@@ -2,7 +2,7 @@ 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
+ * contains a webview and a row of buttons. You can 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
@@ -59,4 +59,11 @@ export default class JoplinViewsDialogs {
      * Opens the dialog
      */
     open(handle: ViewHandle): Promise<DialogResult>;
+    /**
+     * Toggle on whether to fit the dialog size to the content or not.
+     * When set to false, the dialog stretches to fill the application
+     * window.
+     * @default true
+     */
+    setFitToContent(handle: ViewHandle, status: boolean): Promise<boolean>;
 }

api/JoplinWindow.d.ts

@@ -0,0 +1,24 @@
+import Plugin from '../Plugin';
+export interface Implementation {
+    injectCustomStyles(elementId: string, cssFilePath: string): Promise<void>;
+}
+export default class JoplinWindow {
+    private plugin_;
+    private store_;
+    private implementation_;
+    constructor(implementation: Implementation, plugin: Plugin, store: any);
+    /**
+     * Loads a chrome CSS file. It will apply to the window UI elements, except
+     * for the note viewer. It is the same as the "Custom stylesheet for
+     * Joplin-wide app styles" setting. See the [Load CSS Demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/load_css)
+     * for an example.
+     */
+    loadChromeCssFile(filePath: string): Promise<void>;
+    /**
+     * Loads a note CSS file. It will apply to the note viewer, as well as any
+     * exported or printed note. It is the same as the "Custom stylesheet for
+     * rendered Markdown" setting. See the [Load CSS Demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/load_css)
+     * for an example.
+     */
+    loadNoteCssFile(filePath: string): Promise<void>;
+}

api/JoplinWorkspace.d.ts

@@ -35,7 +35,7 @@ export default class JoplinWorkspace {
      */
     onNoteContentChange(callback: Function): Promise<void>;
     /**
-     * Called when the content of a note changes.
+     * Called when the content of the current note changes.
      */
     onNoteChange(handler: ItemChangeHandler): Promise<Disposable>;
     /**