Server v2.11.2

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

.eslintignore

@@ -225,6 +225,7 @@ packages/app-desktop/gui/NoteEditor/NoteBody/CodeMirror/utils/useScrollHandler.j
 packages/app-desktop/gui/NoteEditor/NoteBody/CodeMirror/utils/useScrollUtils.js
 packages/app-desktop/gui/NoteEditor/NoteBody/TinyMCE/TinyMCE.js
 packages/app-desktop/gui/NoteEditor/NoteBody/TinyMCE/styles/index.js
+packages/app-desktop/gui/NoteEditor/NoteBody/TinyMCE/utils/joplinCommandToTinyMceCommands.js
 packages/app-desktop/gui/NoteEditor/NoteBody/TinyMCE/utils/openEditDialog.js
 packages/app-desktop/gui/NoteEditor/NoteBody/TinyMCE/utils/setupToolbarButtons.js
 packages/app-desktop/gui/NoteEditor/NoteBody/TinyMCE/utils/types.js
@@ -557,6 +558,8 @@ packages/lib/models/utils/itemCanBeEncrypted.js
 packages/lib/models/utils/paginatedFeed.js
 packages/lib/models/utils/paginationToSql.js
 packages/lib/models/utils/types.js
+packages/lib/models/utils/userData.js
+packages/lib/models/utils/userData.test.js
 packages/lib/net-utils.js
 packages/lib/ntp.js
 packages/lib/onedrive-api.js

.github/workflows/cla.yml

@@ -33,5 +33,5 @@ jobs:
           #custom-notsigned-prcomment: 'pull request comment with Introductory message to ask new contributors to sign'
           #custom-pr-sign-comment: 'The signature to be committed in order to sign the CLA'
           #custom-allsigned-prcomment: 'pull request comment when all contributors has signed, defaults to **CLA Assistant Lite bot** All Contributors have signed the CLA.'
-          #lock-pullrequest-aftermerge: false - if you don't want this bot to automatically lock the pull request after merging (default - true)
+          lock-pullrequest-aftermerge: false
           #use-dco-flag: true - If you are using DCO instead of CLA

.github/workflows/github-actions-main.yml

@@ -176,3 +176,35 @@ jobs:
           # Basic test to ensure that the created build is valid. It should exit with
           # code 0  if it works.
           docker run joplin/server:0.0.0-beta node dist/app.js migrate list
+ 
+      - name: Check HTTP request
+        run: |
+          # Need to pass environment variables:
+          docker run -p 22300:22300 joplin/server:0.0.0-beta node dist/app.js --env dev &
+
+          # Wait for server to start
+          sleep 10
+
+          # Check if status code is correct
+          # if the actual_status DOES NOT include the expected_status
+          # it exits the process with code 1
+          
+          expected_status="HTTP/1.1 200 OK"
+          actual_status=$(curl -I -X GET http://localhost:22300/api/ping | head -n 1)
+          if [[ ! "$actual_status" =~ "$expected_status" ]]; then 
+            echo 'Failed while checking the status code after request to /api/ping'
+            echo 'expected: ' $expected_status
+            echo 'actual:   ' $actual_status
+            exit 1; 
+          fi
+          
+          # Check if the body response is correct
+          # if the actual_body is different of expected_body exit with code 1
+          expected_body='{"status":"ok","message":"Joplin Server is running"}'
+          actual_body=$(curl http://localhost:22300/api/ping)
+          
+          if [[ "$actual_body" != "$expected_body" ]]; then
+            echo 'Failed while checking the body response after request to /api/ping'
+            exit 1;
+          fi
+

.gitignore

@@ -210,6 +210,7 @@ packages/app-desktop/gui/NoteEditor/NoteBody/CodeMirror/utils/useScrollHandler.j
 packages/app-desktop/gui/NoteEditor/NoteBody/CodeMirror/utils/useScrollUtils.js
 packages/app-desktop/gui/NoteEditor/NoteBody/TinyMCE/TinyMCE.js
 packages/app-desktop/gui/NoteEditor/NoteBody/TinyMCE/styles/index.js
+packages/app-desktop/gui/NoteEditor/NoteBody/TinyMCE/utils/joplinCommandToTinyMceCommands.js
 packages/app-desktop/gui/NoteEditor/NoteBody/TinyMCE/utils/openEditDialog.js
 packages/app-desktop/gui/NoteEditor/NoteBody/TinyMCE/utils/setupToolbarButtons.js
 packages/app-desktop/gui/NoteEditor/NoteBody/TinyMCE/utils/types.js
@@ -542,6 +543,8 @@ packages/lib/models/utils/itemCanBeEncrypted.js
 packages/lib/models/utils/paginatedFeed.js
 packages/lib/models/utils/paginationToSql.js
 packages/lib/models/utils/types.js
+packages/lib/models/utils/userData.js
+packages/lib/models/utils/userData.test.js
 packages/lib/net-utils.js
 packages/lib/ntp.js
 packages/lib/onedrive-api.js

.yarn/patches/react-native-vosk-npm-0.1.12-76b1caaae8.patch

@@ -36,7 +36,7 @@ index 6afcbbf0cc8ca2d69dd78077d61e59a90b2136bb..9f8d72b4ec5b2b3d290975d6a255917c
  def kotlin_version = getExtOrDefault('kotlinVersion')
  
 diff --git a/android/src/main/java/com/reactnativevosk/VoskModule.kt b/android/src/main/java/com/reactnativevosk/VoskModule.kt
-index 0e2b6595b1b2cf1ee01c6c64239c4b0ea37fce19..f3da440bc2863a59db6d2d1691c54d8d4870cb3f 100644
+index 0e2b6595b1b2cf1ee01c6c64239c4b0ea37fce19..5a8539b9cce8951967640dba755e29a4e3ff404a 100644
 --- a/android/src/main/java/com/reactnativevosk/VoskModule.kt
 +++ b/android/src/main/java/com/reactnativevosk/VoskModule.kt
 @@ -19,13 +19,25 @@ class VoskModule(reactContext: ReactApplicationContext) : ReactContextBaseJavaMo
@@ -66,7 +66,25 @@ index 0e2b6595b1b2cf1ee01c6c64239c4b0ea37fce19..f3da440bc2863a59db6d2d1691c54d8d
        sendEvent("onResult", text)
      }
    }
-@@ -153,6 +165,25 @@ class VoskModule(reactContext: ReactApplicationContext) : ReactContextBaseJavaMo
+@@ -93,12 +105,11 @@ class VoskModule(reactContext: ReactApplicationContext) : ReactContextBaseJavaMo
+   @ReactMethod
+   fun loadModel(path: String, promise: Promise) {
+     cleanModel();
+-    StorageService.unpack(context, path, "models",
+-      { model: Model? ->
+-        this.model = model
+-        promise.resolve("Model successfully loaded")
+-      }
+-    ) { e: IOException ->
++    
++    try {
++      this.model = Model(path);
++      promise.resolve("Model successfully loaded")
++    } catch (e: IOException) {
+       this.model = null
+       promise.reject(e)
+     }
+@@ -153,6 +164,25 @@ class VoskModule(reactContext: ReactApplicationContext) : ReactContextBaseJavaMo
      cleanRecognizer();
    }
  

packages/app-cli/tests/md_to_html/sanitize_18.html

@@ -0,0 +1 @@
+<a data-from-md title='&lt;style&gt;' href='&amp;#x22&amp;#x2c&amp;#x22&amp;#x61&amp;#x22&amp;#x29&amp;#x3b&amp;#x74&amp;#x6f&amp;#x70&amp;#x2e&amp;#x72&amp;#x65&amp;#x71&amp;#x75&amp;#x69&amp;#x72&amp;#x65&amp;#x28&amp;#x27&amp;#x63&amp;#x68&amp;#x69&amp;#x6c&amp;#x64&amp;#x5f&amp;#x70&amp;#x72&amp;#x6f&amp;#x63&amp;#x65&amp;#x73&amp;#x73&amp;#x27&amp;#x29&amp;#x2e&amp;#x65&amp;#x78&amp;#x65&amp;#x63&amp;#x28&amp;#x27&amp;#x6f&amp;#x70&amp;#x65&amp;#x6e&amp;#x20&amp;#x2f&amp;#x53&amp;#x79&amp;#x73&amp;#x74&amp;#x65&amp;#x6d&amp;#x2f&amp;#x41&amp;#x70&amp;#x70&amp;#x6c&amp;#x69&amp;#x63&amp;#x61&amp;#x74&amp;#x69&amp;#x6f&amp;#x6e&amp;#x73&amp;#x2f&amp;#x43&amp;#x61&amp;#x6c&amp;#x63&amp;#x75&amp;#x6c&amp;#x61&amp;#x74&amp;#x6f&amp;#x72&amp;#x2e&amp;#x61&amp;#x70&amp;#x70&amp;#x27&amp;#x29&amp;#x3b&amp;#x2f&amp;#x2f' onclick='postMessage(&quot;&amp;#x22&amp;#x2c&amp;#x22&amp;#x61&amp;#x22&amp;#x29&amp;#x3b&amp;#x74&amp;#x6f&amp;#x70&amp;#x2e&amp;#x72&amp;#x65&amp;#x71&amp;#x75&amp;#x69&amp;#x72&amp;#x65&amp;#x28&amp;#x27&amp;#x63&amp;#x68&amp;#x69&amp;#x6c&amp;#x64&amp;#x5f&amp;#x70&amp;#x72&amp;#x6f&amp;#x63&amp;#x65&amp;#x73&amp;#x73&amp;#x27&amp;#x29&amp;#x2e&amp;#x65&amp;#x78&amp;#x65&amp;#x63&amp;#x28&amp;#x27&amp;#x6f&amp;#x70&amp;#x65&amp;#x6e&amp;#x20&amp;#x2f&amp;#x53&amp;#x79&amp;#x73&amp;#x74&amp;#x65&amp;#x6d&amp;#x2f&amp;#x41&amp;#x70&amp;#x70&amp;#x6c&amp;#x69&amp;#x63&amp;#x61&amp;#x74&amp;#x69&amp;#x6f&amp;#x6e&amp;#x73&amp;#x2f&amp;#x43&amp;#x61&amp;#x6c&amp;#x63&amp;#x75&amp;#x6c&amp;#x61&amp;#x74&amp;#x6f&amp;#x72&amp;#x2e&amp;#x61&amp;#x70&amp;#x70&amp;#x27&amp;#x29&amp;#x3b&amp;#x2f&amp;#x2f&quot;, { resourceId: &quot;&quot; }); return false;'>xxxxx</a>

packages/app-cli/tests/md_to_html/sanitize_18.md

@@ -0,0 +1 @@
+[xxxxx](&#x22&#x2c&#x22&#x61&#x22&#x29&#x3b&#x74&#x6f&#x70&#x2e&#x72&#x65&#x71&#x75&#x69&#x72&#x65&#x28&#x27&#x63&#x68&#x69&#x6c&#x64&#x5f&#x70&#x72&#x6f&#x63&#x65&#x73&#x73&#x27&#x29&#x2e&#x65&#x78&#x65&#x63&#x28&#x27&#x6f&#x70&#x65&#x6e&#x20&#x2f&#x53&#x79&#x73&#x74&#x65&#x6d&#x2f&#x41&#x70&#x70&#x6c&#x69&#x63&#x61&#x74&#x69&#x6f&#x6e&#x73&#x2f&#x43&#x61&#x6c&#x63&#x75&#x6c&#x61&#x74&#x6f&#x72&#x2e&#x61&#x70&#x70&#x27&#x29&#x3b&#x2f&#x2f '<style>')

packages/app-cli/tests/support/plugins/clipboard/tsconfig.json

@@ -5,6 +5,9 @@
 		"target": "es2015",
 		"jsx": "react",
 		"allowJs": true,
-		"baseUrl": "."
+		"baseUrl": ".",
+		"typeRoots": [
+			"./node_modules/@types"
+		]
 	}
 }

packages/app-cli/tests/support/plugins/codemirror_content_script/tsconfig.json

@@ -5,6 +5,9 @@
 		"target": "es2015",
 		"jsx": "react",
 		"allowJs": true,
-		"baseUrl": "."
+		"baseUrl": ".",
+		"typeRoots": [
+			"./node_modules/@types"
+		]
 	}
 }

packages/app-cli/tests/support/plugins/content_script/tsconfig.json

@@ -5,6 +5,9 @@
 		"target": "es2015",
 		"jsx": "react",
 		"allowJs": true,
-		"baseUrl": "."
+		"baseUrl": ".",
+		"typeRoots": [
+			"./node_modules/@types"
+		]
 	}
 }

packages/app-cli/tests/support/plugins/dialog/tsconfig.json

@@ -5,6 +5,9 @@
 		"target": "es2015",
 		"jsx": "react",
 		"allowJs": true,
-		"baseUrl": "."
+		"baseUrl": ".",
+		"typeRoots": [
+			"./node_modules/@types"
+		]
 	}
 }

packages/app-cli/tests/support/plugins/editor_context_menu/tsconfig.json

@@ -5,6 +5,9 @@
 		"target": "es2015",
 		"jsx": "react",
 		"allowJs": true,
-		"baseUrl": "."
+		"baseUrl": ".",
+		"typeRoots": [
+			"./node_modules/@types"
+		]
 	}
 }

packages/app-cli/tests/support/plugins/events/tsconfig.json

@@ -5,6 +5,9 @@
 		"target": "es2015",
 		"jsx": "react",
 		"allowJs": true,
-		"baseUrl": "."
+		"baseUrl": ".",
+		"typeRoots": [
+			"./node_modules/@types"
+		]
 	}
 }

packages/app-cli/tests/support/plugins/external_assets/tsconfig.json

@@ -5,6 +5,9 @@
 		"target": "es2015",
 		"jsx": "react",
 		"allowJs": true,
-		"baseUrl": "."
+		"baseUrl": ".",
+		"typeRoots": [
+			"./node_modules/@types"
+		]
 	}
 }

packages/app-cli/tests/support/plugins/json_export/tsconfig.json

@@ -5,6 +5,9 @@
 		"target": "es2015",
 		"jsx": "react",
 		"allowJs": true,
-		"baseUrl": "."
+		"baseUrl": ".",
+		"typeRoots": [
+			"./node_modules/@types"
+		]
 	}
 }

packages/app-cli/tests/support/plugins/load_css/tsconfig.json

@@ -5,6 +5,9 @@
 		"target": "es2015",
 		"jsx": "react",
 		"allowJs": true,
-		"baseUrl": "."
+		"baseUrl": ".",
+		"typeRoots": [
+			"./node_modules/@types"
+		]
 	}
 }

packages/app-cli/tests/support/plugins/menu/tsconfig.json

@@ -5,6 +5,9 @@
 		"target": "es2015",
 		"jsx": "react",
 		"allowJs": true,
-		"baseUrl": "."
+		"baseUrl": ".",
+		"typeRoots": [
+			"./node_modules/@types"
+		]
 	}
 }

packages/app-cli/tests/support/plugins/multi_selection/tsconfig.json

@@ -5,6 +5,9 @@
 		"target": "es2015",
 		"jsx": "react",
 		"allowJs": true,
-		"baseUrl": "."
+		"baseUrl": ".",
+		"typeRoots": [
+			"./node_modules/@types"
+		]
 	}
 }

packages/app-cli/tests/support/plugins/nativeModule/tsconfig.json

@@ -5,6 +5,9 @@
 		"target": "es2015",
 		"jsx": "react",
 		"allowJs": true,
-		"baseUrl": "."
+		"baseUrl": ".",
+		"typeRoots": [
+			"./node_modules/@types"
+		]
 	}
 }

packages/app-cli/tests/support/plugins/post_messages/tsconfig.json

@@ -5,6 +5,9 @@
 		"target": "es2015",
 		"jsx": "react",
 		"allowJs": true,
-		"baseUrl": "."
+		"baseUrl": ".",
+		"typeRoots": [
+			"./node_modules/@types"
+		]
 	}
 }

packages/app-cli/tests/support/plugins/register_command/tsconfig.json

@@ -5,6 +5,9 @@
 		"target": "es2015",
 		"jsx": "react",
 		"allowJs": true,
-		"baseUrl": "."
+		"baseUrl": ".",
+		"typeRoots": [
+			"./node_modules/@types"
+		]
 	}
 }

packages/app-cli/tests/support/plugins/selected_text/tsconfig.json

@@ -5,6 +5,9 @@
 		"target": "es2015",
 		"jsx": "react",
 		"allowJs": true,
-		"baseUrl": "."
+		"baseUrl": ".",
+		"typeRoots": [
+			"./node_modules/@types"
+		]
 	}
 }

packages/app-cli/tests/support/plugins/settings/tsconfig.json

@@ -5,6 +5,9 @@
 		"target": "es2015",
 		"jsx": "react",
 		"allowJs": true,
-		"baseUrl": "."
+		"baseUrl": ".",
+		"typeRoots": [
+			"./node_modules/@types"
+		]
 	}
 }

packages/app-cli/tests/support/plugins/toc/tsconfig.json

@@ -5,6 +5,9 @@
 		"target": "es2015",
 		"jsx": "react",
 		"allowJs": true,
-		"baseUrl": "."
+		"baseUrl": ".",
+		"typeRoots": [
+			"./node_modules/@types"
+		]
 	}
 }

packages/app-cli/tests/support/plugins/updatePlugins.sh

@@ -20,3 +20,4 @@ cd "$SCRIPT_DIR/withExternalModules/" && yo joplin --update --skip-install --sil
 cd "$SCRIPT_DIR/post_messages/" && yo joplin --update --skip-install --silent
 cd "$SCRIPT_DIR/nativeModule/" && yo joplin --update --skip-install --silent
 cd "$SCRIPT_DIR/external_assets/" && yo joplin --update --skip-install --silent
+cd "$SCRIPT_DIR/user_data/" && yo joplin --update --skip-install --silent

packages/app-cli/tests/support/plugins/user_data/.gitignore

@@ -0,0 +1,3 @@
+dist/
+node_modules/
+publish/

packages/app-cli/tests/support/plugins/user_data/.npmignore

@@ -0,0 +1,8 @@
+*.md
+!README.md
+/*.jpl
+/api
+/src
+/dist
+tsconfig.json
+webpack.config.js

packages/app-cli/tests/support/plugins/user_data/GENERATOR_DOC.md

@@ -0,0 +1,72 @@
+# generator-joplin
+
+Scaffolds out a new Joplin plugin
+
+## Installation
+
+First, install [Yeoman](http://yeoman.io) and generator-joplin using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)).
+
+```bash
+npm install -g yo
+npm install -g generator-joplin
+```
+
+Then generate your new project:
+
+```bash
+yo joplin
+```
+
+## Development
+
+To test the generator for development purposes, follow the instructions there: https://yeoman.io/authoring/#running-the-generator
+This is a template to create a new Joplin plugin.
+
+## Structure
+
+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 file `/plugin.config.json` could also be useful if you intend to use [external scripts](#external-script-files), such as content scripts or webview scripts.
+
+## Building the plugin
+
+The plugin is built using Webpack, which creates the compiled code in `/dist`. A JPL archive will also be created at the root, which can use to distribute the plugin.
+
+To build the plugin, simply run `npm run dist`.
+
+The project is setup to use TypeScript, although you can change the configuration to use plain JavaScript.
+
+## Publishing the plugin
+
+To publish the plugin, add it to npmjs.com by running `npm publish`. Later on, a script will pick up your plugin and add it automatically to the Joplin plugin repository as long as the package satisfies these conditions:
+
+- In `package.json`, the name starts with "joplin-plugin-". For example, "joplin-plugin-toc".
+- In `package.json`, the keywords include "joplin-plugin".
+- In the `publish/` directory, there should be a .jpl and .json file (which are built by `npm run dist`)
+
+In general all this is done automatically by the plugin generator, which will set the name and keywords of package.json, and will put the right files in the "publish" directory. But if something doesn't work and your plugin doesn't appear in the repository, double-check the above conditions.
+
+## Updating the plugin framework
+
+To update the plugin framework, run `npm run update`.
+
+In general this command tries to do the right thing - in particular it's going to merge the changes in package.json and .gitignore instead of overwriting. It will also leave "/src" as well as README.md untouched.
+
+The file that may cause problem is "webpack.config.js" because it's going to be overwritten. For that reason, if you want to change it, consider creating a separate JavaScript file and include it in webpack.config.js. That way, when you update, you only have to restore the line that include your file.
+
+## External script files
+
+By default, the compiler (webpack) is going to compile `src/index.ts` only (as well as any file it imports), and any other file will simply be copied to the plugin package. In some cases this is sufficient, however if you have [content scripts](https://joplinapp.org/api/references/plugin_api/classes/joplincontentscripts.html) or [webview scripts](https://joplinapp.org/api/references/plugin_api/classes/joplinviewspanels.html#addscript) you might want to compile them too, in particular in these two cases:
+
+- The script is a TypeScript file - in which case it has to be compiled to JavaScript.
+
+- The script requires modules you've added to package.json. In that case, the script, whether JS or TS, must be compiled so that the dependencies are bundled with the JPL file.
+
+To get such an external script file to compile, you need to add it to the `extraScripts` array in `plugin.config.json`. The path you add should be relative to /src. For example, if you have a file in "/src/webviews/index.ts", the path should be set to "webviews/index.ts". Once compiled, the file will always be named with a .js extension. So you will get "webviews/index.js" in the plugin package, and that's the path you should use to reference the file.
+
+## License
+
+MIT © Laurent Cozic

packages/app-cli/tests/support/plugins/user_data/README.md

@@ -0,0 +1,24 @@
+# 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.
+
+## Building the plugin
+
+The plugin is built using Webpack, which creates the compiled code in `/dist`. A JPL archive will also be created at the root, which can use to distribute the plugin.
+
+To build the plugin, simply run `npm run dist`.
+
+The project is setup to use TypeScript, although you can change the configuration to use plain JavaScript.
+
+## Updating the plugin framework
+
+To update the plugin framework, run `npm run update`.
+
+In general this command tries to do the right thing - in particular it's going to merge the changes in package.json and .gitignore instead of overwriting. It will also leave "/src" as well as README.md untouched.
+
+The file that may cause problem is "webpack.config.js" because it's going to be overwritten. For that reason, if you want to change it, consider creating a separate JavaScript file and include it in webpack.config.js. That way, when you update, you only have to restore the line that include your file.

packages/app-cli/tests/support/plugins/user_data/api/Global.d.ts

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

packages/app-cli/tests/support/plugins/user_data/api/Joplin.d.ts

@@ -0,0 +1,68 @@
+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 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.
+ *
+ * The API is now relatively stable and in general maintaining backward compatibility is a top priority, so you shouldn't except much breakages.
+ *
+ * If a breaking change ever becomes needed, best effort will be done to:
+ *
+ * - Deprecate features instead of removing them, so as to give you time to fix the issue;
+ * - 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.
+ */
+export default class Joplin {
+    private data_;
+    private plugins_;
+    private workspace_;
+    private filters_;
+    private commands_;
+    private views_;
+    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;
+    /**
+     * @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;
+    /**
+     * 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;
+}

packages/app-cli/tests/support/plugins/user_data/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[]>;
+}

packages/app-cli/tests/support/plugins/user_data/api/JoplinCommands.d.ts

@@ -0,0 +1,89 @@
+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/editorCommandDeclarations.ts)
+ *
+ * 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 {
+    /**
+     * <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>;
+}

packages/app-cli/tests/support/plugins/user_data/api/JoplinContentScripts.d.ts

@@ -0,0 +1,40 @@
+import Plugin from '../Plugin';
+import { ContentScriptType } from './types';
+export default class JoplinContentScripts {
+    private plugin;
+    constructor(plugin: Plugin);
+    /**
+     * 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.
+     *
+     * The plugin generator provides a way to build any content script you might
+     * want to package as well as its dependencies. See the [Plugin Generator
+     * doc](https://github.com/laurent22/joplin/blob/dev/packages/generator-joplin/README.md)
+     * for more information.
+     *
+     * * [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)
+     *
+     * See also the [postMessage demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages)
+     *
+     * @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`.
+     */
+    register(type: ContentScriptType, id: string, scriptPath: string): Promise<void>;
+    /**
+     * Listens to a messages sent from the content script using postMessage().
+     * See {@link ContentScriptType} for more information as well as the
+     * [postMessage
+     * demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages)
+     */
+    onMessage(contentScriptId: string, callback: any): Promise<void>;
+}

packages/app-cli/tests/support/plugins/user_data/api/JoplinData.d.ts

@@ -0,0 +1,50 @@
+import { ModelType } from '../../../BaseModel';
+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>;
+    itemType(itemId: string): Promise<ModelType>;
+    resourcePath(resourceId: string): Promise<string>;
+}

packages/app-cli/tests/support/plugins/user_data/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>;
+}

packages/app-cli/tests/support/plugins/user_data/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>;
+}

packages/app-cli/tests/support/plugins/user_data/api/JoplinPlugins.d.ts

@@ -0,0 +1,43 @@
+import Plugin from '../Plugin';
+import { ContentScriptType, Script } from './types';
+/**
+ * This class provides access to plugin-related features.
+ */
+export default class JoplinPlugins {
+    private plugin;
+    constructor(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>;
+    /**
+     * @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;
+}

packages/app-cli/tests/support/plugins/user_data/api/JoplinSettings.d.ts

@@ -0,0 +1,64 @@
+import Plugin from '../Plugin';
+import { SettingItem, SettingSection } from './types';
+export interface ChangeEvent {
+    /**
+     * Setting keys that have been changed
+     */
+    keys: string[];
+}
+export declare type ChangeHandler = (event: ChangeEvent) => void;
+/**
+ * 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 get keyPrefix();
+    private namespacedKey;
+    /**
+     * 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.
+     */
+    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/dev/packages/lib/models/Setting.ts#L142
+     */
+    globalValue(key: string): Promise<any>;
+    /**
+     * Called when one or multiple settings of your plugin have been changed.
+     * - For performance reasons, this event is triggered with a delay.
+     * - You will only get events for your own plugin settings.
+     */
+    onChange(handler: ChangeHandler): Promise<void>;
+}

packages/app-cli/tests/support/plugins/user_data/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;
+}

packages/app-cli/tests/support/plugins/user_data/api/JoplinViewsDialogs.d.ts

@@ -0,0 +1,68 @@
+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
+ * 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>;
+    /**
+     * Adds and loads a new JS or CSS files into the dialog.
+     */
+    addScript(handle: ViewHandle, scriptPath: string): Promise<void>;
+    /**
+     * Sets the dialog buttons.
+     */
+    setButtons(handle: ViewHandle, buttons: ButtonSpec[]): Promise<ButtonSpec[]>;
+    /**
+     * 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 is set to 90vw and 80vh
+     * @default true
+     */
+    setFitToContent(handle: ViewHandle, status: boolean): Promise<boolean>;
+}

packages/app-cli/tests/support/plugins/user_data/api/JoplinViewsMenuItems.d.ts

@@ -0,0 +1,16 @@
+import { CreateMenuItemOptions, MenuItemLocation } from './types';
+import Plugin from '../Plugin';
+/**
+ * Allows creating and managing menu items.
+ *
+ * [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/register_command)
+ */
+export default class JoplinViewsMenuItems {
+    private store;
+    private plugin;
+    constructor(plugin: Plugin, store: any);
+    /**
+     * Creates a new menu item and associate it with the given command. You can specify under which menu the item should appear using the `location` parameter.
+     */
+    create(id: string, commandName: string, location?: MenuItemLocation, options?: CreateMenuItemOptions): Promise<void>;
+}

packages/app-cli/tests/support/plugins/user_data/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/packages/app-cli/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(id: string, label: string, menuItems: MenuItem[], location?: MenuItemLocation): Promise<void>;
+}

packages/app-cli/tests/support/plugins/user_data/api/JoplinViewsPanels.d.ts

@@ -0,0 +1,78 @@
+import Plugin from '../Plugin';
+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/tree/dev/packages/app-cli/tests/support/plugins/toc)
+ */
+export default class JoplinViewsPanels {
+    private store;
+    private plugin;
+    constructor(plugin: Plugin, store: any);
+    private controller;
+    /**
+     * Creates a new panel
+     */
+    create(id: string): Promise<ViewHandle>;
+    /**
+     * Sets the panel webview HTML
+     */
+    setHtml(handle: ViewHandle, html: string): Promise<string>;
+    /**
+     * Adds and loads a new JS or CSS files into the panel.
+     */
+    addScript(handle: ViewHandle, scriptPath: string): Promise<void>;
+    /**
+     * Called when a message is sent from the webview (using postMessage).
+     *
+     * To post a message from the webview to the plugin use:
+     *
+     * ```javascript
+     * const response = await webviewApi.postMessage(message);
+     * ```
+     *
+     * - `message` can be any JavaScript object, string or number
+     * - `response` is whatever was returned by the `onMessage` handler
+     *
+     * Using this mechanism, you can have two-way communication between the
+     * plugin and webview.
+     *
+     * See the [postMessage
+     * demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages) for more details.
+     *
+     */
+    onMessage(handle: ViewHandle, callback: Function): Promise<void>;
+    /**
+     * Sends a message to the webview.
+     *
+     * The webview must have registered a message handler prior, otherwise the message is ignored. Use;
+     *
+     * ```javascript
+     * webviewApi.onMessage((message) => { ... });
+     * ```
+     *
+     *  - `message` can be any JavaScript object, string or number
+     *
+     * The view API may have only one onMessage handler defined.
+     * This method is fire and forget so no response is returned.
+     *
+     * It is particularly useful when the webview needs to react to events emitted by the plugin or the joplin api.
+     */
+    postMessage(handle: ViewHandle, message: any): void;
+    /**
+     * Shows the panel
+     */
+    show(handle: ViewHandle, show?: boolean): Promise<void>;
+    /**
+     * Hides the panel
+     */
+    hide(handle: ViewHandle): Promise<void>;
+    /**
+     * Tells whether the panel is visible or not
+     */
+    visible(handle: ViewHandle): Promise<boolean>;
+}

packages/app-cli/tests/support/plugins/user_data/api/JoplinViewsToolbarButtons.d.ts

@@ -0,0 +1,16 @@
+import { ToolbarButtonLocation } from './types';
+import Plugin from '../Plugin';
+/**
+ * Allows creating and managing toolbar buttons.
+ *
+ * [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/register_command)
+ */
+export default class JoplinViewsToolbarButtons {
+    private store;
+    private plugin;
+    constructor(plugin: Plugin, store: any);
+    /**
+     * Creates a new toolbar button and associate it with the given command.
+     */
+    create(id: string, commandName: string, location: ToolbarButtonLocation): Promise<void>;
+}

packages/app-cli/tests/support/plugins/user_data/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>;
+}

packages/app-cli/tests/support/plugins/user_data/api/JoplinWorkspace.d.ts

@@ -0,0 +1,87 @@
+import { FolderEntity } from '../../database/types';
+import { Disposable, MenuItem } from './types';
+export interface EditContextMenuFilterObject {
+    items: MenuItem[];
+}
+declare type FilterHandler<T> = (object: T) => Promise<void>;
+declare enum ItemChangeEventType {
+    Create = 1,
+    Update = 2,
+    Delete = 3
+}
+interface ItemChangeEvent {
+    id: string;
+    event: ItemChangeEventType;
+}
+interface SyncStartEvent {
+    withErrors: boolean;
+}
+interface ResourceChangeEvent {
+    id: string;
+}
+declare type ItemChangeHandler = (event: ItemChangeEvent) => void;
+declare type SyncStartHandler = (event: SyncStartEvent) => void;
+declare type ResourceChangeHandler = (event: ResourceChangeEvent) => void;
+/**
+ * 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/tree/dev/packages/app-cli/tests/support/plugins)
+ */
+export default class JoplinWorkspace {
+    private store;
+    constructor(store: any);
+    /**
+     * Called when a new note or notes are selected.
+     */
+    onNoteSelectionChange(callback: Function): Promise<Disposable>;
+    /**
+     * Called when the content of a note changes.
+     * @deprecated Use `onNoteChange()` instead, which is reliably triggered whenever the note content, or any note property changes.
+     */
+    onNoteContentChange(callback: Function): Promise<void>;
+    /**
+     * Called when the content of the current note changes.
+     */
+    onNoteChange(handler: ItemChangeHandler): Promise<Disposable>;
+    /**
+     * Called when a resource is changed. Currently this handled will not be
+     * called when a resource is added or deleted.
+     */
+    onResourceChange(handler: ResourceChangeHandler): Promise<void>;
+    /**
+     * Called when an alarm associated with a to-do is triggered.
+     */
+    onNoteAlarmTrigger(handler: Function): Promise<Disposable>;
+    /**
+     * Called when the synchronisation process is starting.
+     */
+    onSyncStart(handler: SyncStartHandler): Promise<Disposable>;
+    /**
+     * Called when the synchronisation process has finished.
+     */
+    onSyncComplete(callback: Function): Promise<Disposable>;
+    /**
+     * Called just before the editor context menu is about to open. Allows
+     * adding items to it.
+     */
+    filterEditorContextMenu(handler: FilterHandler<EditContextMenuFilterObject>): void;
+    /**
+     * Gets the currently selected note
+     */
+    selectedNote(): Promise<any>;
+    /**
+     * Gets the currently selected folder. In some cases, for example during
+     * search or when viewing a tag, no folder is actually selected in the user
+     * interface. In that case, that function would return the last selected
+     * folder.
+     */
+    selectedFolder(): Promise<FolderEntity>;
+    /**
+     * Gets the IDs of the selected notes (can be zero, one, or many). Use the data API to retrieve information about these notes.
+     */
+    selectedNoteIds(): Promise<string[]>;
+}
+export {};

packages/app-cli/tests/support/plugins/user_data/api/index.ts

@@ -0,0 +1,5 @@
+import type Joplin from './Joplin';
+
+declare const joplin: Joplin;
+
+export default joplin;

packages/app-cli/tests/support/plugins/user_data/api/types.ts

@@ -0,0 +1,674 @@
+// =================================================================
+// Command API types
+// =================================================================
+
+export interface Command {
+	/**
+	 * Name of command - must be globally unique
+	 */
+	name: 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;
+
+	/**
+	 * 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"
+	 *
+	 * Joplin, unlike VSCode, also supports parenthesis, which allows creating
+	 * more complex expressions such as `cond1 || (cond2 && cond3)`. Only one
+	 * level of parenthesis is possible (nested ones aren't supported).
+	 *
+	 * Currently the supported context variables aren't documented, but you can
+	 * find the list below:
+	 *
+	 * - [Global When Clauses](https://github.com/laurent22/joplin/blob/dev/packages/lib/services/commands/stateToWhenClauseContext.ts)
+	 * - [Desktop app When Clauses](https://github.com/laurent22/joplin/blob/dev/packages/app-desktop/services/commands/stateToWhenClauseContext.ts)
+	 *
+	 * Note: Commands are enabled by default unless you use this property.
+	 */
+	enabledCondition?: string;
+}
+
+// =================================================================
+// Interop API types
+// =================================================================
+
+export enum FileSystemItem {
+	File = 'file',
+	Directory = 'directory',
+}
+
+export enum ImportModuleOutputFormat {
+	Markdown = 'md',
+	Html = 'html',
+}
+
+/**
+ * Used to implement a module to export data from Joplin. [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/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.
+ *
+ * To get a better sense of what it will contain it can be useful to print it using `console.info(context)`.
+ */
+export interface ExportModule {
+	/**
+	 * The format to be exported, eg "enex", "jex", "json", etc.
+	 */
+	format: string;
+
+	/**
+	 * The description that will appear in the UI, for example in the menu item.
+	 */
+	description: string;
+
+	/**
+	 * Whether the module will export a single file or multiple files in a directory. It affects the open dialog that will be presented to the user when using your exporter.
+	 */
+	target: FileSystemItem;
+
+	/**
+	 * Only applies to single file exporters or importers
+	 * It tells whether the format can package multiple notes into one file.
+	 * For example JEX or ENEX can, but HTML cannot.
+	 */
+	isNoteArchive: boolean;
+
+	/**
+	 * The extensions of the files exported by your module. For example, it is `["htm", "html"]` for the HTML module, and just `["jex"]` for the JEX module.
+	 */
+	fileExtensions?: string[];
+
+	/**
+	 * Called when the export process starts.
+	 */
+	onInit(context: ExportContext): Promise<void>;
+
+	/**
+	 * Called when an item needs to be processed. An "item" can be any Joplin object, such as a note, a folder, a notebook, etc.
+	 */
+	onProcessItem(context: ExportContext, itemType: number, item: any): Promise<void>;
+
+	/**
+	 * Called when a resource file needs to be exported.
+	 */
+	onProcessResource(context: ExportContext, resource: any, filePath: string): Promise<void>;
+
+	/**
+	 * Called when the export process is done.
+	 */
+	onClose(context: ExportContext): Promise<void>;
+}
+
+export interface ImportModule {
+	/**
+	 * The format to be exported, eg "enex", "jex", "json", etc.
+	 */
+	format: string;
+
+	/**
+	 * The description that will appear in the UI, for example in the menu item.
+	 */
+	description: string;
+
+	/**
+	 * Only applies to single file exporters or importers
+	 * It tells whether the format can package multiple notes into one file.
+	 * For example JEX or ENEX can, but HTML cannot.
+	 */
+	isNoteArchive: boolean;
+
+	/**
+	 * The type of sources that are supported by the module. Tells whether the module can import files or directories or both.
+	 */
+	sources: FileSystemItem[];
+
+	/**
+	 * Tells the file extensions of the exported files.
+	 */
+	fileExtensions?: string[];
+
+	/**
+	 * Tells the type of notes that will be generated, either HTML or Markdown (default).
+	 */
+	outputFormat?: ImportModuleOutputFormat;
+
+	/**
+	 * Called when the import process starts. There is only one event handler within which you should import the complete data.
+	 */
+	onExec(context: ImportContext): Promise<void>;
+}
+
+export interface ExportOptions {
+	format?: string;
+	path?: string;
+	sourceFolderIds?: string[];
+	sourceNoteIds?: string[];
+	// modulePath?: string;
+	target?: FileSystemItem;
+}
+
+export interface ExportContext {
+	destPath: string;
+	options: ExportOptions;
+
+	/**
+	 * You can attach your own custom data using this propery - it will then be passed to each event handler, allowing you to keep state from one event to the next.
+	 */
+	userData?: any;
+}
+
+export interface ImportContext {
+	sourcePath: string;
+	options: any;
+	warnings: string[];
+}
+
+// =================================================================
+// Misc types
+// =================================================================
+
+export interface Script {
+	onStart?(event: any): Promise<void>;
+}
+
+export interface Disposable {
+	// dispose():void;
+}
+
+export enum ModelType {
+	Note = 1,
+	Folder = 2,
+	Setting = 3,
+	Resource = 4,
+	Tag = 5,
+	NoteTag = 6,
+	Search = 7,
+	Alarm = 8,
+	MasterKey = 9,
+	ItemChange = 10,
+	NoteResource = 11,
+	ResourceLocalState = 12,
+	Revision = 13,
+	Migration = 14,
+	SmartFilter = 15,
+	Command = 16,
+}
+
+// =================================================================
+// Menu types
+// =================================================================
+
+export interface CreateMenuItemOptions {
+	accelerator: string;
+}
+
+export enum MenuItemLocation {
+	File = 'file',
+	Edit = 'edit',
+	View = 'view',
+	Note = 'note',
+	Tools = 'tools',
+	Help = 'help',
+
+	/**
+	 * @deprecated Do not use - same as NoteListContextMenu
+	 */
+	Context = 'context',
+
+	// If adding an item here, don't forget to update isContextMenuItemLocation()
+
+	/**
+	 * When a command is called from the note list context menu, the
+	 * command will receive the following arguments:
+	 *
+	 * - `noteIds:string[]`: IDs of the notes that were right-clicked on.
+	 */
+	NoteListContextMenu = 'noteListContextMenu',
+
+	EditorContextMenu = 'editorContextMenu',
+
+	/**
+	 * When a command is called from a folder context menu, the
+	 * command will receive the following arguments:
+	 *
+	 * - `folderId:string`: ID of the folder that was right-clicked on
+	 */
+	FolderContextMenu = 'folderContextMenu',
+
+	/**
+	 * When a command is called from a tag context menu, the
+	 * command will receive the following arguments:
+	 *
+	 * - `tagId:string`: ID of the tag that was right-clicked on
+	 */
+	TagContextMenu = 'tagContextMenu',
+}
+
+export function isContextMenuItemLocation(location: MenuItemLocation): boolean {
+	return [
+		MenuItemLocation.Context,
+		MenuItemLocation.NoteListContextMenu,
+		MenuItemLocation.EditorContextMenu,
+		MenuItemLocation.FolderContextMenu,
+		MenuItemLocation.TagContextMenu,
+	].includes(location);
+}
+
+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;
+
+	/**
+	 * Arguments that should be passed to the command. They will be as rest
+	 * parameters.
+	 */
+	commandArgs?: any[];
+
+	/**
+	 * Set to "separator" to create a divider line
+	 */
+	type?: ('normal' | 'separator' | 'submenu' | 'checkbox' | 'radio');
+
+	/**
+	 * 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.
+	 */
+	NoteToolbar = 'noteToolbar',
+
+	/**
+	 * This toolbar is right above the text editor. It applies to the note body only.
+	 */
+	EditorToolbar = 'editorToolbar',
+}
+
+export type ViewHandle = string;
+
+export interface EditorCommand {
+	name: string;
+	value?: any;
+}
+
+export interface DialogResult {
+	id: ButtonId;
+	formData?: any;
+}
+
+// =================================================================
+// Settings types
+// =================================================================
+
+export enum SettingItemType {
+	Int = 1,
+	String = 2,
+	Bool = 3,
+	Array = 4,
+	Object = 5,
+	Button = 6,
+}
+
+export enum SettingItemSubType {
+	FilePathAndArgs = 'file_path_and_args',
+	FilePath = 'file_path', // Not supported on mobile!
+	DirectoryPath = 'directory_path', // Not supported on mobile!
+}
+
+export enum AppType {
+	Desktop = 'desktop',
+	Mobile = 'mobile',
+	Cli = 'cli',
+}
+
+export enum SettingStorage {
+	Database = 1,
+	File = 2,
+}
+
+// Redefine a simplified interface to mask internal details
+// and to remove function calls as they would have to be async.
+export interface SettingItem {
+	value: any;
+	type: SettingItemType;
+
+	/**
+	 * Currently only used to display a file or directory selector. Always set
+	 * `type` to `SettingItemType.String` when using this property.
+	 */
+	subType?: SettingItemSubType;
+
+	label: string;
+	description?: string;
+
+	/**
+	 * A public setting will appear in the Configuration screen and will be
+	 * modifiable by the user. A private setting however will not appear there,
+	 * and can only be changed programmatically. You may use this to store some
+	 * values that you do not want to directly expose.
+	 */
+	public: boolean;
+
+	/**
+	 * You would usually set this to a section you would have created
+	 * specifically for the plugin.
+	 */
+	section?: string;
+
+	/**
+	 * To create a setting with multiple options, set this property to `true`.
+	 * That setting will render as a dropdown list in the configuration screen.
+	 */
+	isEnum?: boolean;
+
+	/**
+	 * This property is required when `isEnum` is `true`. In which case, it
+	 * should contain a map of value => label.
+	 */
+	options?: Record<any, any>;
+
+	/**
+	 * Reserved property. Not used at the moment.
+	 */
+	appTypes?: AppType[];
+
+	/**
+	 * Set this to `true` to store secure data, such as passwords. Any such
+	 * setting will be stored in the system keychain if one is available.
+	 */
+	secure?: boolean;
+
+	/**
+	 * An advanced setting will be moved under the "Advanced" button in the
+	 * config screen.
+	 */
+	advanced?: boolean;
+
+	/**
+	 * Set the min, max and step values if you want to restrict an int setting
+	 * to a particular range.
+	 */
+	minimum?: number;
+	maximum?: number;
+	step?: number;
+
+	/**
+	 * Either store the setting in the database or in settings.json. Defaults to database.
+	 */
+	storage?: SettingStorage;
+}
+
+export interface SettingSection {
+	label: string;
+	iconName?: string;
+	description?: string;
+	name?: string;
+}
+
+// =================================================================
+// Data API types
+// =================================================================
+
+/**
+ * An array of at least one element and at most three elements.
+ *
+ * - **[0]**: Resource name (eg. "notes", "folders", "tags", etc.)
+ * - **[1]**: (Optional) Resource ID.
+ * - **[2]**: (Optional) Resource link.
+ */
+export type Path = string[];
+
+// =================================================================
+// Content Script types
+// =================================================================
+
+export type PostMessageHandler = (message: any)=> Promise<any>;
+
+/**
+ * When a content script is initialised, it receives a `context` object.
+ */
+export interface ContentScriptContext {
+	/**
+	 * The plugin ID that registered this content script
+	 */
+	pluginId: string;
+
+	/**
+	 * The content script ID, which may be necessary to post messages
+	 */
+	contentScriptId: string;
+
+	/**
+	 * Can be used by CodeMirror content scripts to post a message to the plugin
+	 */
+	postMessage: PostMessageHandler;
+}
+
+export enum ContentScriptType {
+	/**
+	 * Registers a new Markdown-It plugin, which should follow the template
+	 * below.
+	 *
+	 * ```javascript
+	 * module.exports = {
+	 *     default: function(context) {
+	 *         return {
+	 *             plugin: function(markdownIt, options) {
+	 *                 // ...
+	 *             },
+	 *             assets: {
+	 *                 // ...
+	 *             },
+	 *         }
+	 *     }
+	 * }
+	 * ```
+	 * See [the
+	 * demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script)
+	 * for a simple Markdown-it plugin example.
+	 *
+	 * ## Exported members
+	 *
+	 * - The `context` argument 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.
+	 *
+	 * - The **required** `plugin` key 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/packages/renderer/MdToHtml.ts),
+	 *   which contains a number of options, mostly useful for Joplin's internal
+	 *   code.
+	 *
+	 * - Using the **optional** `assets` key you may specify 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/packages/renderer/MdToHtml/rules/mermaid.ts)
+	 *   to see how the data should be structured.
+	 *
+	 * ## Posting messages from the content script to your plugin
+	 *
+	 * The application provides the following function to allow executing
+	 * commands from the rendered HTML code:
+	 *
+	 * ```javascript
+	 * const response = await webviewApi.postMessage(contentScriptId, message);
+	 * ```
+	 *
+	 * - `contentScriptId` is the ID you've defined when you registered the
+	 *   content script. You can retrieve it from the
+	 *   {@link ContentScriptContext | context}.
+	 * - `message` can be any basic JavaScript type (number, string, plain
+	 *   object), but it cannot be a function or class instance.
+	 *
+	 * When you post a message, the plugin can send back a `response` thus
+	 * allowing two-way communication:
+	 *
+	 * ```javascript
+	 * await joplin.contentScripts.onMessage(contentScriptId, (message) => {
+	 *     // Process message
+	 *     return response; // Can be any object, string or number
+	 * });
+	 * ```
+	 *
+	 * See {@link JoplinContentScripts.onMessage} for more details, as well as
+	 * the [postMessage
+	 * demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages).
+	 *
+	 * ## Registering an existing Markdown-it plugin
+	 *
+	 * To include a regular Markdown-It plugin, that doesn't make use of any
+	 * Joplin-specific features, 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',
+
+	/**
+	 * Registers a new CodeMirror plugin, which should follow the template
+	 * below.
+	 *
+	 * ```javascript
+	 * module.exports = {
+	 *     default: function(context) {
+	 *         return {
+	 *             plugin: function(CodeMirror) {
+	 *                 // ...
+	 *             },
+	 *             codeMirrorResources: [],
+	 *             codeMirrorOptions: {
+	 *                                  // ...
+	 *                       },
+	 *             assets: {
+	 *                 // ...
+	 *             },
+	 *         }
+	 *     }
+	 * }
+	 * ```
+	 *
+	 * - The `context` argument 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.
+	 *
+	 * - The `plugin` key is your CodeMirror plugin. This is where you can
+	 *   register new commands with CodeMirror or interact with the CodeMirror
+	 *   instance as needed.
+	 *
+	 * - The `codeMirrorResources` key is an array of CodeMirror resources that
+	 *   will be loaded and attached to the CodeMirror module. These are made up
+	 *   of addons, keymaps, and modes. For example, for a plugin that want's to
+	 *   enable clojure highlighting in code blocks. `codeMirrorResources` would
+	 *   be set to `['mode/clojure/clojure']`.
+	 *
+	 * - The `codeMirrorOptions` key contains all the
+	 *   [CodeMirror](https://codemirror.net/doc/manual.html#config) options
+	 *   that will be set or changed by this plugin. New options can alse be
+	 *   declared via
+	 *   [`CodeMirror.defineOption`](https://codemirror.net/doc/manual.html#defineOption),
+	 *   and then have their value set here. For example, a plugin that enables
+	 *   line numbers would set `codeMirrorOptions` to `{'lineNumbers': true}`.
+	 *
+	 * - Using the **optional** `assets` key you may specify **only** CSS assets
+	 *   that should be loaded in the rendered HTML document. Check for example
+	 *   the Joplin [Mermaid
+	 *   plugin](https://github.com/laurent22/joplin/blob/dev/packages/renderer/MdToHtml/rules/mermaid.ts)
+	 *   to see how the data should be structured.
+	 *
+	 * One of the `plugin`, `codeMirrorResources`, or `codeMirrorOptions` keys
+	 * must be provided for the plugin to be valid. Having multiple or all
+	 * provided is also okay.
+	 *
+	 * See also the [demo
+	 * plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script)
+	 * for an example of all these keys being used in one plugin.
+	 *
+	 * ## Posting messages from the content script to your plugin
+	 *
+	 * In order to post messages to the plugin, you can use the postMessage
+	 * function passed to the {@link ContentScriptContext | context}.
+	 *
+	 * ```javascript
+	 * const response = await context.postMessage('messageFromCodeMirrorContentScript');
+	 * ```
+	 *
+	 * When you post a message, the plugin can send back a `response` thus
+	 * allowing two-way communication:
+	 *
+	 * ```javascript
+	 * await joplin.contentScripts.onMessage(contentScriptId, (message) => {
+	 *     // Process message
+	 *     return response; // Can be any object, string or number
+	 * });
+	 * ```
+	 *
+	 * See {@link JoplinContentScripts.onMessage} for more details, as well as
+	 * the [postMessage
+	 * demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages).
+	 *
+	 */
+	CodeMirrorPlugin = 'codeMirrorPlugin',
+}

packages/app-cli/tests/support/plugins/user_data/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "joplin-plugin-userdata-demo",
+  "version": "1.0.0",
+  "scripts": {
+    "dist": "webpack --joplin-plugin-config buildMain && webpack --joplin-plugin-config buildExtraScripts && webpack --joplin-plugin-config createArchive",
+    "prepare": "npm run dist",
+    "update": "npm install -g generator-joplin && yo joplin --update"
+  },
+  "license": "MIT",
+  "keywords": [
+    "joplin-plugin"
+  ],
+  "devDependencies": {
+    "@types/node": "^14.0.14",
+    "chalk": "^4.1.0",
+    "copy-webpack-plugin": "^6.1.0",
+    "fs-extra": "^9.0.1",
+    "glob": "^7.1.6",
+    "on-build-webpack": "^0.1.0",
+    "tar": "^6.0.5",
+    "ts-loader": "^7.0.5",
+    "typescript": "^3.9.3",
+    "webpack": "^4.43.0",
+    "webpack-cli": "^3.3.11",
+    "yargs": "^16.2.0"
+  },
+  "files": [
+    "publish"
+  ]
+}

packages/app-cli/tests/support/plugins/user_data/plugin.config.json

@@ -0,0 +1,3 @@
+{
+	"extraScripts": []
+}

packages/app-cli/tests/support/plugins/user_data/src/index.ts

@@ -0,0 +1,17 @@
+import joplin from 'api';
+import { ModelType } from 'api/types';
+
+joplin.plugins.register({
+	onStart: async function() {
+		const folder = await joplin.data.post(['folders'], null, { title: "test" });
+		const note = await joplin.data.post(['notes'], null, { title: "test", parent_id: folder.id });
+		
+		await joplin.data.userDataSet(ModelType.Note, note.id, 'mykey', 'abcd');
+
+		console.info('Got back user data:', await joplin.data.userDataGet(ModelType.Note, note.id, 'mykey'));
+
+		await joplin.data.userDataDelete(ModelType.Note, note.id, 'mykey');
+	
+		console.info('Got back user data:', await joplin.data.userDataGet(ModelType.Note, note.id, 'mykey'));
+	},
+});

packages/app-cli/tests/support/plugins/user_data/src/manifest.json

@@ -0,0 +1,12 @@
+{
+	"manifest_version": 1,
+	"id": "org.joplinapp.plugins.UserDataDemo",
+	"app_min_version": "2.0",
+	"version": "1.0.0",
+	"name": "User Data Demo",
+	"description": "",
+	"author": "",
+	"homepage_url": "",
+	"repository_url": "",
+	"keywords": []
+}

packages/app-cli/tests/support/plugins/user_data/tsconfig.json

@@ -0,0 +1,13 @@
+{
+	"compilerOptions": {
+		"outDir": "./dist/",
+		"module": "commonjs",
+		"target": "es2015",
+		"jsx": "react",
+		"allowJs": true,
+		"baseUrl": ".",
+		"typeRoots": [
+			"./node_modules/@types"
+		]
+	}
+}

packages/app-cli/tests/support/plugins/user_data/webpack.config.js

@@ -0,0 +1,291 @@
+// -----------------------------------------------------------------------------
+// This file is used to build the plugin file (.jpl) and plugin info (.json). It
+// is recommended not to edit this file as it would be overwritten when updating
+// the plugin framework. If you do make some changes, consider using an external
+// JS file and requiring it here to minimize the changes. That way when you
+// update, you can easily restore the functionality you've added.
+// -----------------------------------------------------------------------------
+
+const path = require('path');
+const crypto = require('crypto');
+const fs = require('fs-extra');
+const chalk = require('chalk');
+const CopyPlugin = require('copy-webpack-plugin');
+const WebpackOnBuildPlugin = require('on-build-webpack');
+const tar = require('tar');
+const glob = require('glob');
+const execSync = require('child_process').execSync;
+
+const rootDir = path.resolve(__dirname);
+const userConfigFilename = './plugin.config.json';
+const userConfigPath = path.resolve(rootDir, userConfigFilename);
+const distDir = path.resolve(rootDir, 'dist');
+const srcDir = path.resolve(rootDir, 'src');
+const publishDir = path.resolve(rootDir, 'publish');
+
+const userConfig = Object.assign({}, {
+	extraScripts: [],
+}, fs.pathExistsSync(userConfigPath) ? require(userConfigFilename) : {});
+
+const manifestPath = `${srcDir}/manifest.json`;
+const packageJsonPath = `${rootDir}/package.json`;
+const allPossibleCategories = ['appearance', 'developer tools', 'productivity', 'themes', 'integrations', 'viewer', 'search', 'tags', 'editor', 'files', 'personal knowledge management'];
+const manifest = readManifest(manifestPath);
+const pluginArchiveFilePath = path.resolve(publishDir, `${manifest.id}.jpl`);
+const pluginInfoFilePath = path.resolve(publishDir, `${manifest.id}.json`);
+
+function validatePackageJson() {
+	const content = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
+	if (!content.name || content.name.indexOf('joplin-plugin-') !== 0) {
+		console.warn(chalk.yellow(`WARNING: To publish the plugin, the package name should start with "joplin-plugin-" (found "${content.name}") in ${packageJsonPath}`));
+	}
+
+	if (!content.keywords || content.keywords.indexOf('joplin-plugin') < 0) {
+		console.warn(chalk.yellow(`WARNING: To publish the plugin, the package keywords should include "joplin-plugin" (found "${JSON.stringify(content.keywords)}") in ${packageJsonPath}`));
+	}
+
+	if (content.scripts && content.scripts.postinstall) {
+		console.warn(chalk.yellow(`WARNING: package.json contains a "postinstall" script. It is recommended to use a "prepare" script instead so that it is executed before publish. In ${packageJsonPath}`));
+	}
+}
+
+function fileSha256(filePath) {
+	const content = fs.readFileSync(filePath);
+	return crypto.createHash('sha256').update(content).digest('hex');
+}
+
+function currentGitInfo() {
+	try {
+		let branch = execSync('git rev-parse --abbrev-ref HEAD', { stdio: 'pipe' }).toString().trim();
+		const commit = execSync('git rev-parse HEAD', { stdio: 'pipe' }).toString().trim();
+		if (branch === 'HEAD') branch = 'master';
+		return `${branch}:${commit}`;
+	} catch (error) {
+		const messages = error.message ? error.message.split('\n') : [''];
+		console.info(chalk.cyan('Could not get git commit (not a git repo?):', messages[0].trim()));
+		console.info(chalk.cyan('Git information will not be stored in plugin info file'));
+		return '';
+	}
+}
+
+function validateCategories(categories) {
+	if (!categories) return null;
+	if ((categories.length !== new Set(categories).size)) throw new Error('Repeated categories are not allowed');
+	categories.forEach(category => {
+		if (!allPossibleCategories.includes(category)) throw new Error(`${category} is not a valid category. Please make sure that the category name is lowercase. Valid Categories are: \n${allPossibleCategories}\n`);
+	});
+}
+
+function readManifest(manifestPath) {
+	const content = fs.readFileSync(manifestPath, 'utf8');
+	const output = JSON.parse(content);
+	if (!output.id) throw new Error(`Manifest plugin ID is not set in ${manifestPath}`);
+	validateCategories(output.categories);
+	return output;
+}
+
+function createPluginArchive(sourceDir, destPath) {
+	const distFiles = glob.sync(`${sourceDir}/**/*`, { nodir: true })
+		.map(f => f.substr(sourceDir.length + 1));
+
+	if (!distFiles.length) throw new Error('Plugin archive was not created because the "dist" directory is empty');
+	fs.removeSync(destPath);
+
+	tar.create(
+		{
+			strict: true,
+			portable: true,
+			file: destPath,
+			cwd: sourceDir,
+			sync: true,
+		},
+		distFiles
+	);
+
+	console.info(chalk.cyan(`Plugin archive has been created in ${destPath}`));
+}
+
+function createPluginInfo(manifestPath, destPath, jplFilePath) {
+	const contentText = fs.readFileSync(manifestPath, 'utf8');
+	const content = JSON.parse(contentText);
+	content._publish_hash = `sha256:${fileSha256(jplFilePath)}`;
+	content._publish_commit = currentGitInfo();
+	fs.writeFileSync(destPath, JSON.stringify(content, null, '\t'), 'utf8');
+}
+
+function onBuildCompleted() {
+	try {
+		fs.removeSync(path.resolve(publishDir, 'index.js'));
+		createPluginArchive(distDir, pluginArchiveFilePath);
+		createPluginInfo(manifestPath, pluginInfoFilePath, pluginArchiveFilePath);
+		validatePackageJson();
+	} catch (error) {
+		console.error(chalk.red(error.message));
+	}
+}
+
+const baseConfig = {
+	mode: 'production',
+	target: 'node',
+	stats: 'errors-only',
+	module: {
+		rules: [
+			{
+				test: /\.tsx?$/,
+				use: 'ts-loader',
+				exclude: /node_modules/,
+			},
+		],
+	},
+};
+
+const pluginConfig = Object.assign({}, baseConfig, {
+	entry: './src/index.ts',
+	resolve: {
+		alias: {
+			api: path.resolve(__dirname, 'api'),
+		},
+		// JSON files can also be required from scripts so we include this.
+		// https://github.com/joplin/plugin-bibtex/pull/2
+		extensions: ['.js', '.tsx', '.ts', '.json'],
+	},
+	output: {
+		filename: 'index.js',
+		path: distDir,
+	},
+	plugins: [
+		new CopyPlugin({
+			patterns: [
+				{
+					from: '**/*',
+					context: path.resolve(__dirname, 'src'),
+					to: path.resolve(__dirname, 'dist'),
+					globOptions: {
+						ignore: [
+							// All TypeScript files are compiled to JS and
+							// already copied into /dist so we don't copy them.
+							'**/*.ts',
+							'**/*.tsx',
+						],
+					},
+				},
+			],
+		}),
+	],
+});
+
+const extraScriptConfig = Object.assign({}, baseConfig, {
+	resolve: {
+		alias: {
+			api: path.resolve(__dirname, 'api'),
+		},
+		extensions: ['.js', '.tsx', '.ts', '.json'],
+	},
+});
+
+const createArchiveConfig = {
+	stats: 'errors-only',
+	entry: './dist/index.js',
+	output: {
+		filename: 'index.js',
+		path: publishDir,
+	},
+	plugins: [new WebpackOnBuildPlugin(onBuildCompleted)],
+};
+
+function resolveExtraScriptPath(name) {
+	const relativePath = `./src/${name}`;
+
+	const fullPath = path.resolve(`${rootDir}/${relativePath}`);
+	if (!fs.pathExistsSync(fullPath)) throw new Error(`Could not find extra script: "${name}" at "${fullPath}"`);
+
+	const s = name.split('.');
+	s.pop();
+	const nameNoExt = s.join('.');
+
+	return {
+		entry: relativePath,
+		output: {
+			filename: `${nameNoExt}.js`,
+			path: distDir,
+			library: 'default',
+			libraryTarget: 'commonjs',
+			libraryExport: 'default',
+		},
+	};
+}
+
+function buildExtraScriptConfigs(userConfig) {
+	if (!userConfig.extraScripts.length) return [];
+
+	const output = [];
+
+	for (const scriptName of userConfig.extraScripts) {
+		const scriptPaths = resolveExtraScriptPath(scriptName);
+		output.push(Object.assign({}, extraScriptConfig, {
+			entry: scriptPaths.entry,
+			output: scriptPaths.output,
+		}));
+	}
+
+	return output;
+}
+
+function main(processArgv) {
+	const yargs = require('yargs/yargs');
+	const argv = yargs(processArgv).argv;
+
+	const configName = argv['joplin-plugin-config'];
+	if (!configName) throw new Error('A config file must be specified via the --joplin-plugin-config flag');
+
+	// Webpack configurations run in parallel, while we need them to run in
+	// sequence, and to do that it seems the only way is to run webpack multiple
+	// times, with different config each time.
+
+	const configs = {
+		// Builds the main src/index.ts and copy the extra content from /src to
+		// /dist including scripts, CSS and any other asset.
+		buildMain: [pluginConfig],
+
+		// Builds the extra scripts as defined in plugin.config.json. When doing
+		// so, some JavaScript files that were copied in the previous might be
+		// overwritten here by the compiled version. This is by design. The
+		// result is that JS files that don't need compilation, are simply
+		// copied to /dist, while those that do need it are correctly compiled.
+		buildExtraScripts: buildExtraScriptConfigs(userConfig),
+
+		// Ths config is for creating the .jpl, which is done via the plugin, so
+		// it doesn't actually need an entry and output, however webpack won't
+		// run without this. So we give it an entry that we know is going to
+		// exist and output in the publish dir. Then the plugin will delete this
+		// temporary file before packaging the plugin.
+		createArchive: [createArchiveConfig],
+	};
+
+	// If we are running the first config step, we clean up and create the build
+	// directories.
+	if (configName === 'buildMain') {
+		fs.removeSync(distDir);
+		fs.removeSync(publishDir);
+		fs.mkdirpSync(publishDir);
+	}
+
+	return configs[configName];
+}
+
+let exportedConfigs = [];
+
+try {
+	exportedConfigs = main(process.argv);
+} catch (error) {
+	console.error(chalk.red(error.message));
+	process.exit(1);
+}
+
+if (!exportedConfigs.length) {
+	// Nothing to do - for example where there are no external scripts to
+	// compile.
+	process.exit(0);
+}
+
+module.exports = exportedConfigs;

packages/app-cli/tests/support/plugins/withExternalModules/tsconfig.json

@@ -5,6 +5,9 @@
 		"target": "es2015",
 		"jsx": "react",
 		"allowJs": true,
-		"baseUrl": "."
+		"baseUrl": ".",
+		"typeRoots": [
+			"./node_modules/@types"
+		]
 	}
 }

packages/app-desktop/gui/MainScreen/MainScreen.tsx

@@ -34,7 +34,7 @@ import ShareFolderDialog from '../ShareFolderDialog/ShareFolderDialog';
 import { ShareInvitation } from '@joplin/lib/services/share/reducer';
 import removeKeylessItems from '../ResizableLayout/utils/removeKeylessItems';
 import { localSyncInfoFromState } from '@joplin/lib/services/synchronizer/syncInfoUtils';
-import { parseCallbackUrl } from '@joplin/lib/callbackUrlUtils';
+import { isCallbackUrl, parseCallbackUrl } from '@joplin/lib/callbackUrlUtils';
 import ElectronAppWrapper from '../../ElectronAppWrapper';
 import { showMissingMasterKeyMessage } from '@joplin/lib/services/e2ee/utils';
 import { MasterKeyEntity } from '@joplin/lib/services/e2ee/types';
@@ -173,6 +173,7 @@ class MainScreenComponent extends React.Component<Props, State> {
 	}
 
 	private openCallbackUrl(url: string) {
+		if (!isCallbackUrl(url)) throw new Error(`Invalid callback URL: ${url}`);
 		const { command, params } = parseCallbackUrl(url);
 		void CommandService.instance().execute(command.toString(), params.id);
 	}

packages/app-desktop/gui/NoteEditor/NoteBody/TinyMCE/TinyMCE.tsx

@@ -26,6 +26,7 @@ import { loadScript } from '../../../utils/loadScript';
 import bridge from '../../../../services/bridge';
 import { TinyMceEditorEvents } from './utils/types';
 import type { Editor } from 'tinymce';
+import { joplinCommandToTinyMceCommands, TinyMceCommand } from './utils/joplinCommandToTinyMceCommands';
 const { clipboard } = require('electron');
 const supportedLocales = require('./supportedLocales');
 
@@ -78,23 +79,6 @@ function stripMarkup(markupLanguage: number, markup: string, options: any = null
 	return	markupToHtml_.stripMarkup(markupLanguage, markup, options);
 }
 
-interface TinyMceCommand {
-	name: string;
-	value?: any;
-	ui?: boolean;
-}
-
-interface JoplinCommandToTinyMceCommands {
-	[key: string]: TinyMceCommand;
-}
-
-const joplinCommandToTinyMceCommands: JoplinCommandToTinyMceCommands = {
-	'textBold': { name: 'mceToggleFormat', value: 'bold' },
-	'textItalic': { name: 'mceToggleFormat', value: 'italic' },
-	'textLink': { name: 'mceLink' },
-	'search': { name: 'SearchReplace' },
-};
-
 interface LastOnChangeEventInfo {
 	content: string;
 	resourceInfos: ResourceInfos;
@@ -274,11 +258,17 @@ const TinyMCE = (props: NoteBodyEditorProps, ref: any) => {
 					return false;
 				}
 
-				const tinyMceCmd: TinyMceCommand = { ...joplinCommandToTinyMceCommands[cmd.name] };
-				if (!('ui' in tinyMceCmd)) tinyMceCmd.ui = false;
-				if (!('value' in tinyMceCmd)) tinyMceCmd.value = null;
+				if (joplinCommandToTinyMceCommands[cmd.name] === true) {
+					// Already handled in useWindowCommandHandlers.ts
+				} else if (joplinCommandToTinyMceCommands[cmd.name] === false) {
+					// Explicitely not supported
+				} else {
+					const tinyMceCmd: TinyMceCommand = { ...(joplinCommandToTinyMceCommands[cmd.name] as TinyMceCommand) };
+					if (!('ui' in tinyMceCmd)) tinyMceCmd.ui = false;
+					if (!('value' in tinyMceCmd)) tinyMceCmd.value = null;
 
-				editor.execCommand(tinyMceCmd.name, tinyMceCmd.ui, tinyMceCmd.value);
+					editor.execCommand(tinyMceCmd.name, tinyMceCmd.ui, tinyMceCmd.value);
+				}
 
 				return true;
 			},
@@ -603,11 +593,15 @@ const TinyMCE = (props: NoteBodyEditorProps, ref: any) => {
 					joplinSup: { inline: 'sup', remove: 'all' },
 				},
 				setup: (editor: Editor) => {
+					editor.addCommand('joplinAttach', () => {
+						insertResourcesIntoContentRef.current();
+					});
+
 					editor.ui.registry.addButton('joplinAttach', {
 						tooltip: _('Attach file'),
 						icon: 'paperclip',
 						onAction: async function() {
-							insertResourcesIntoContentRef.current();
+							editor.execCommand('joplinAttach');
 						},
 					});
 

packages/app-desktop/gui/NoteEditor/NoteBody/TinyMCE/utils/joplinCommandToTinyMceCommands.ts

@@ -0,0 +1,22 @@
+export interface TinyMceCommand {
+	name: string;
+	value?: any;
+	ui?: boolean;
+}
+
+interface JoplinCommandToTinyMceCommands {
+	[key: string]: TinyMceCommand | boolean;
+}
+
+// If the mapping is simply `true` it means that the command is supported via
+// useWindowCommandHandlers.ts. We still add it here to have the complete list
+// of supported commands.
+export const joplinCommandToTinyMceCommands: JoplinCommandToTinyMceCommands = {
+	'textBold': { name: 'mceToggleFormat', value: 'bold' },
+	'textItalic': { name: 'mceToggleFormat', value: 'italic' },
+	'textCode': { name: 'mceToggleFormat', value: 'code' },
+	'textLink': { name: 'mceLink' },
+	'search': { name: 'SearchReplace' },
+	'attachFile': { name: 'joplinAttach' },
+	'insertDateTime': true,
+};

packages/app-desktop/gui/NoteEditor/utils/useWindowCommandHandler.ts

@@ -4,6 +4,7 @@ import editorCommandDeclarations from '../editorCommandDeclarations';
 import CommandService, { CommandDeclaration, CommandRuntime, CommandContext } from '@joplin/lib/services/CommandService';
 import time from '@joplin/lib/time';
 import { reg } from '@joplin/lib/registry';
+import { joplinCommandToTinyMceCommands } from '../NoteBody/TinyMCE/utils/joplinCommandToTinyMceCommands';
 
 const commandsWithDependencies = [
 	require('../commands/showLocalSearch'),
@@ -24,6 +25,8 @@ interface HookDependencies {
 }
 
 function editorCommandRuntime(declaration: CommandDeclaration, editorRef: any, setFormNote: Function): CommandRuntime {
+	const markdownEditorOnly = !Object.keys(joplinCommandToTinyMceCommands).includes(declaration.name);
+
 	return {
 		execute: async (_context: CommandContext, ...args: any[]) => {
 			if (!editorRef.current) {
@@ -65,7 +68,7 @@ function editorCommandRuntime(declaration: CommandDeclaration, editorRef: any, s
 		// currently selected text.
 		//
 		// https://github.com/laurent22/joplin/issues/5707
-		enabledCondition: '(!modalDialogVisible || gotoAnythingVisible) && markdownEditorPaneVisible && oneNoteSelected && noteIsMarkdown',
+		enabledCondition: `(!modalDialogVisible || gotoAnythingVisible) ${markdownEditorOnly ? '&& markdownEditorPaneVisible' : ''} && oneNoteSelected && noteIsMarkdown`,
 	};
 }
 

packages/app-desktop/package.json

@@ -162,7 +162,7 @@
     "react": "18.2.0",
     "react-datetime": "3.2.0",
     "react-dom": "18.2.0",
-    "react-redux": "8.0.5",
+    "react-redux": "8.0.7",
     "react-select": "5.7.3",
     "react-toggle-button": "2.2.0",
     "react-tooltip": "4.5.1",
@@ -171,7 +171,7 @@
     "roboto-fontface": "0.10.0",
     "smalltalk": "2.5.1",
     "sqlite3": "5.1.6",
-    "styled-components": "5.3.10",
+    "styled-components": "5.3.11",
     "styled-system": "5.1.5",
     "taboverride": "4.0.3",
     "tinymce": "5.10.6"

packages/app-desktop/testPluginDemo.sh

@@ -4,5 +4,15 @@
 # It could be used to develop plugins too.
 
 SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
-PLUGIN_PATH=~/src/joplin-rich-markdown
-npm install --prefix="$PLUGIN_PATH" && yarn start --dev-plugins "$PLUGIN_PATH"
+TEMP_PATH=~/src/plugin-tests
+PLUGIN_PATH=~/src/joplin/packages/app-cli/tests/support/plugins/user_data
+
+mkdir -p "$TEMP_PATH"
+PLUGIN_NAME=$(echo "$PLUGIN_PATH" | awk -F/ '{print $NF}')
+TEMP_PLUGIN_PATH="$TEMP_PATH/$PLUGIN_NAME" 
+
+rsync -a --delete "$PLUGIN_PATH/" "$TEMP_PLUGIN_PATH/" 
+
+npm install --prefix="$TEMP_PLUGIN_PATH" && yarn start --dev-plugins "$TEMP_PLUGIN_PATH"
+
+# Add eg "--profile $HOME/.config/joplindev-desktop-1" to test with a different profile

packages/app-mobile/android/app/src/main/assets/model-fr-fr/README

@@ -1,7 +0,0 @@
-French small model for Vosk
-
-WER
-
-%WER 23.95 [ 37203 / 155330, 5373 ins, 4427 del, 27403 sub ] exp/chain_a/tdnn/decode_test_cv/wer_12_0.0
-%WER 19.30 [ 2975 / 15412, 683 ins, 672 del, 1620 sub ] exp/chain_a/tdnn/decode_test_mtedx/wer_10_0.0
-%WER 27.25 [ 20208 / 74145, 2647 ins, 5852 del, 11709 sub ] exp/chain_a/tdnn/decode_test_podcast_reseg/wer_10_0.0

packages/app-mobile/android/app/src/main/assets/model-fr-fr/conf/mfcc.conf

@@ -1,8 +0,0 @@
---use-energy=false
---sample-frequency=16000
---num-mel-bins=40
---num-ceps=40
---low-freq=40
---high-freq=-200
---allow-upsample=true
---allow-downsample=true

packages/app-mobile/android/app/src/main/assets/model-fr-fr/conf/model.conf

@@ -1,10 +0,0 @@
---min-active=200
---max-active=7000
---beam=13.0
---lattice-beam=4.0
---acoustic-scale=1.0
---frame-subsampling-factor=3
---endpoint.silence-phones=1:2:3:4:5:6:7:8:9:10
---endpoint.rule2.min-trailing-silence=0.5
---endpoint.rule3.min-trailing-silence=1.0
---endpoint.rule4.min-trailing-silence=2.0

packages/app-mobile/android/app/src/main/assets/model-fr-fr/graph/disambig_tid.int

@@ -1,76 +0,0 @@
-9365
-9366
-9367
-9368
-9369
-9370
-9371
-9372
-9373
-9374
-9375
-9376
-9377
-9378
-9379
-9380
-9381
-9382
-9383
-9384
-9385
-9386
-9387
-9388
-9389
-9390
-9391
-9392
-9393
-9394
-9395
-9396
-9397
-9398
-9399
-9400
-9401
-9402
-9403
-9404
-9405
-9406
-9407
-9408
-9409
-9410
-9411
-9412
-9413
-9414
-9415
-9416
-9417
-9418
-9419
-9420
-9421
-9422
-9423
-9424
-9425
-9426
-9427
-9428
-9429
-9430
-9431
-9432
-9433
-9434
-9435
-9436
-9437
-9438
-9439
-9440

packages/app-mobile/android/app/src/main/assets/model-fr-fr/graph/phones/word_boundary.int

@@ -1,154 +0,0 @@
-1 nonword
-2 begin
-3 end
-4 internal
-5 singleton
-6 nonword
-7 begin
-8 end
-9 internal
-10 singleton
-11 begin
-12 end
-13 internal
-14 singleton
-15 begin
-16 end
-17 internal
-18 singleton
-19 begin
-20 end
-21 internal
-22 singleton
-23 begin
-24 end
-25 internal
-26 singleton
-27 begin
-28 end
-29 internal
-30 singleton
-31 begin
-32 end
-33 internal
-34 singleton
-35 begin
-36 end
-37 internal
-38 singleton
-39 begin
-40 end
-41 internal
-42 singleton
-43 begin
-44 end
-45 internal
-46 singleton
-47 begin
-48 end
-49 internal
-50 singleton
-51 begin
-52 end
-53 internal
-54 singleton
-55 begin
-56 end
-57 internal
-58 singleton
-59 begin
-60 end
-61 internal
-62 singleton
-63 begin
-64 end
-65 internal
-66 singleton
-67 begin
-68 end
-69 internal
-70 singleton
-71 begin
-72 end
-73 internal
-74 singleton
-75 begin
-76 end
-77 internal
-78 singleton
-79 begin
-80 end
-81 internal
-82 singleton
-83 begin
-84 end
-85 internal
-86 singleton
-87 begin
-88 end
-89 internal
-90 singleton
-91 begin
-92 end
-93 internal
-94 singleton
-95 begin
-96 end
-97 internal
-98 singleton
-99 begin
-100 end
-101 internal
-102 singleton
-103 begin
-104 end
-105 internal
-106 singleton
-107 begin
-108 end
-109 internal
-110 singleton
-111 begin
-112 end
-113 internal
-114 singleton
-115 begin
-116 end
-117 internal
-118 singleton
-119 begin
-120 end
-121 internal
-122 singleton
-123 begin
-124 end
-125 internal
-126 singleton
-127 begin
-128 end
-129 internal
-130 singleton
-131 begin
-132 end
-133 internal
-134 singleton
-135 begin
-136 end
-137 internal
-138 singleton
-139 begin
-140 end
-141 internal
-142 singleton
-143 begin
-144 end
-145 internal
-146 singleton
-147 begin
-148 end
-149 internal
-150 singleton
-151 begin
-152 end
-153 internal
-154 singleton

packages/app-mobile/android/app/src/main/assets/model-fr-fr/ivector/global_cmvn.stats

@@ -1,3 +0,0 @@
- [
-  1.022245e+11 -6.33291e+09 -2.480997e+09 8.290258e+09 -9.084483e+09 -8.092173e+09 -1.4735e+10 -7.041795e+09 -1.171205e+10 -2.976464e+08 -1.009425e+10 -6765179 -7.821326e+09 1.449499e+09 -6.413975e+09 -5.303802e+08 -4.998635e+09 9.521598e+07 -3.073041e+09 1.56756e+08 -1.287956e+09 1.738752e+08 -2.382392e+08 -2.716675e+07 4.404485e+08 -1.913359e+08 7.780919e+08 -4.006922e+08 7.895809e+08 -5.401082e+08 5.17605e+08 -6.227134e+08 6.58271e+08 -6.204593e+07 5.187754e+08 -4.497048e+08 4.219366e+07 -2.78742e+08 -1.797385e+07 -3.604475e+07 1.053647e+09 
-  1.040194e+13 6.245521e+11 4.223293e+11 6.831219e+11 6.078478e+11 6.3425e+11 7.943839e+11 6.013323e+11 6.781652e+11 5.272091e+11 5.810814e+11 4.353831e+11 4.473305e+11 3.42063e+11 3.083377e+11 2.14257e+11 1.892057e+11 1.163827e+11 8.367058e+10 4.203224e+10 2.297476e+10 7.596307e+09 1.099877e+09 2.886651e+08 3.797438e+09 9.372847e+09 1.629059e+10 2.196351e+10 2.747149e+10 3.072878e+10 3.238528e+10 3.330232e+10 3.407238e+10 3.230687e+10 2.676914e+10 2.252055e+10 1.914305e+10 1.565974e+10 1.224627e+10 8.415393e+09 0 ]

packages/app-mobile/android/app/src/main/assets/model-fr-fr/ivector/splice.conf

@@ -1,2 +0,0 @@
---left-context=3
---right-context=3

packages/app-mobile/android/app/src/main/assets/model-fr-fr/uuid

@@ -1 +0,0 @@
-1b7180e6-e500-4818-adc8-a41fe97a84ce

packages/app-mobile/components/screens/Note.tsx

@@ -46,6 +46,7 @@ import { NoteEntity } from '@joplin/lib/services/database/types';
 import Logger from '@joplin/lib/Logger';
 import VoiceTypingDialog from '../voiceTyping/VoiceTypingDialog';
 import { voskEnabled } from '../../services/voiceTyping/vosk';
+import { isSupportedLanguage } from '../../services/voiceTyping/vosk.android';
 const urlUtils = require('@joplin/lib/urlUtils');
 
 // import Vosk from 'react-native-vosk';
@@ -1000,7 +1001,7 @@ class NoteScreenComponent extends BaseScreenComponent {
 		});
 
 		// Voice typing is enabled only for French language and on Android for now
-		if (voskEnabled && shim.mobilePlatform() === 'android' && currentLocale() === 'fr_FR') {
+		if (voskEnabled && shim.mobilePlatform() === 'android' && isSupportedLanguage(currentLocale())) {
 			output.push({
 				title: _('Voice typing...'),
 				onPress: () => {
@@ -1307,7 +1308,7 @@ class NoteScreenComponent extends BaseScreenComponent {
 
 		const renderVoiceTypingDialog = () => {
 			if (!this.state.voiceTypingDialogShown) return null;
-			return <VoiceTypingDialog onText={this.voiceTypingDialog_onText} onDismiss={this.voiceTypingDialog_onDismiss}/>;
+			return <VoiceTypingDialog locale={currentLocale()} onText={this.voiceTypingDialog_onText} onDismiss={this.voiceTypingDialog_onDismiss}/>;
 		};
 
 		return (

packages/app-mobile/components/voiceTyping/VoiceTypingDialog.tsx

@@ -1,12 +1,14 @@
 import * as React from 'react';
 import { useState, useEffect, useCallback } from 'react';
-import { Banner, ActivityIndicator } from 'react-native-paper';
-import { _ } from '@joplin/lib/locale';
+import { Banner, ActivityIndicator, Modal } from 'react-native-paper';
+import { _, languageName } from '@joplin/lib/locale';
 import useAsyncEffect, { AsyncEffectEvent } from '@joplin/lib/hooks/useAsyncEffect';
 import { getVosk, Recorder, startRecording, Vosk } from '../../services/voiceTyping/vosk';
 import { IconSource } from 'react-native-paper/lib/typescript/src/components/Icon';
+import { modelIsDownloaded } from '../../services/voiceTyping/vosk.android';
 
 interface Props {
+	locale: string;
 	onDismiss: ()=> void;
 	onText: (text: string)=> void;
 }
@@ -16,30 +18,39 @@ enum RecorderState {
 	Recording = 2,
 	Processing = 3,
 	Error = 4,
+	Downloading = 5,
 }
 
-const useVosk = (): [Error | null, Vosk|null] => {
+const useVosk = (locale: string): [Error | null, boolean, Vosk|null] => {
 	const [vosk, setVosk] = useState<Vosk>(null);
 	const [error, setError] = useState<Error>(null);
+	const [mustDownloadModel, setMustDownloadModel] = useState<boolean | null>(null);
 
 	useAsyncEffect(async (event: AsyncEffectEvent) => {
+		if (mustDownloadModel === null) return;
+
 		try {
-			const v = await getVosk();
+			const v = await getVosk(locale);
 			if (event.cancelled) return;
 			setVosk(v);
 		} catch (error) {
 			setError(error);
+		} finally {
+			setMustDownloadModel(false);
 		}
-	}, []);
+	}, [locale, mustDownloadModel]);
 
-	return [error, vosk];
+	useAsyncEffect(async (_event: AsyncEffectEvent) => {
+		setMustDownloadModel(!(await modelIsDownloaded(locale)));
+	}, [locale]);
+
+	return [error, mustDownloadModel, vosk];
 };
 
 export default (props: Props) => {
 	const [recorder, setRecorder] = useState<Recorder>(null);
 	const [recorderState, setRecorderState] = useState<RecorderState>(RecorderState.Loading);
-
-	const [voskError, vosk] = useVosk();
+	const [voskError, mustDownloadModel, vosk] = useVosk(props.locale);
 
 	useEffect(() => {
 		if (voskError) {
@@ -49,6 +60,12 @@ export default (props: Props) => {
 		}
 	}, [vosk, voskError]);
 
+	useEffect(() => {
+		if (mustDownloadModel) {
+			setRecorderState(RecorderState.Downloading);
+		}
+	}, [mustDownloadModel]);
+
 	useEffect(() => {
 		if (recorderState === RecorderState.Recording) {
 			setRecorder(startRecording(vosk, {
@@ -60,7 +77,7 @@ export default (props: Props) => {
 	}, [recorderState, vosk, props.onText]);
 
 	const onDismiss = useCallback(() => {
-		recorder.cleanup();
+		if (recorder) recorder.cleanup();
 		props.onDismiss();
 	}, [recorder, props.onDismiss]);
 
@@ -69,6 +86,7 @@ export default (props: Props) => {
 			[RecorderState.Loading]: () => _('Loading...'),
 			[RecorderState.Recording]: () => _('Please record your voice...'),
 			[RecorderState.Processing]: () => _('Converting speech to text...'),
+			[RecorderState.Downloading]: () => _('Downloading %s language files...', languageName(props.locale)),
 			[RecorderState.Error]: () => _('Error: %s', voskError.message),
 		};
 
@@ -80,6 +98,7 @@ export default (props: Props) => {
 			[RecorderState.Loading]: ({ size }: { size: number }) => <ActivityIndicator animating={true} style={{ width: size, height: size }} />,
 			[RecorderState.Recording]: 'microphone',
 			[RecorderState.Processing]: 'microphone',
+			[RecorderState.Downloading]: ({ size }: { size: number }) => <ActivityIndicator animating={true} style={{ width: size, height: size }} />,
 			[RecorderState.Error]: 'alert-circle-outline',
 		};
 
@@ -87,16 +106,18 @@ export default (props: Props) => {
 	};
 
 	return (
-		<Banner
-			visible={true}
-			icon={renderIcon()}
-			actions={[
-				{
-					label: _('Done'),
-					onPress: onDismiss,
-				},
-			]}>
-			{`${_('Voice typing...')}\n${renderContent()}`}
-		</Banner>
+		<Modal visible={true} style={{ display: 'flex', flexDirection: 'column', justifyContent: 'flex-end' }}>
+			<Banner
+				visible={true}
+				icon={renderIcon()}
+				actions={[
+					{
+						label: _('Done'),
+						onPress: onDismiss,
+					},
+				]}>
+				{`${_('Voice typing...')}\n${renderContent()}`}
+			</Banner>
+		</Modal>
 	);
 };

packages/app-mobile/ios/Podfile.lock

@@ -347,7 +347,7 @@ PODS:
     - React-Core
   - react-native-fingerprint-scanner (6.0.0):
     - React
-  - react-native-geolocation (2.1.0):
+  - react-native-geolocation (3.0.6):
     - React-Core
   - react-native-get-random-values (1.8.0):
     - React-Core
@@ -483,7 +483,15 @@ PODS:
     - React-Core
   - RNVectorIcons (9.2.0):
     - React-Core
+  - RNZipArchive (6.0.9):
+    - React-Core
+    - RNZipArchive/Core (= 6.0.9)
+    - SSZipArchive (~> 2.2)
+  - RNZipArchive/Core (6.0.9):
+    - React-Core
+    - SSZipArchive (~> 2.2)
   - SocketRocket (0.6.0)
+  - SSZipArchive (2.4.3)
   - Yoga (1.14.0)
   - YogaKit (1.18.1):
     - Yoga (~> 1.14)
@@ -577,6 +585,7 @@ DEPENDENCIES:
   - RNSecureRandom (from `../node_modules/react-native-securerandom`)
   - RNShare (from `../node_modules/react-native-share`)
   - RNVectorIcons (from `../node_modules/react-native-vector-icons`)
+  - RNZipArchive (from `../node_modules/react-native-zip-archive`)
   - Yoga (from `../node_modules/react-native/ReactCommon/yoga`)
 
 SPEC REPOS:
@@ -595,6 +604,7 @@ SPEC REPOS:
     - libevent
     - OpenSSL-Universal
     - SocketRocket
+    - SSZipArchive
     - YogaKit
 
 EXTERNAL SOURCES:
@@ -724,6 +734,8 @@ EXTERNAL SOURCES:
     :path: "../node_modules/react-native-share"
   RNVectorIcons:
     :path: "../node_modules/react-native-vector-icons"
+  RNZipArchive:
+    :path: "../node_modules/react-native-zip-archive"
   Yoga:
     :path: "../node_modules/react-native/ReactCommon/yoga"
 
@@ -767,7 +779,7 @@ SPEC CHECKSUMS:
   react-native-camera: 3eae183c1d111103963f3dd913b65d01aef8110f
   react-native-document-picker: 69ca2094d8780cfc1e7e613894d15290fdc54bba
   react-native-fingerprint-scanner: ac6656f18c8e45a7459302b84da41a44ad96dbbe
-  react-native-geolocation: 69f4fd37650b8e7fee91816d395e62dd16f5ab8d
+  react-native-geolocation: 0f7fe8a4c2de477e278b0365cce27d089a8c5903
   react-native-get-random-values: a6ea6a8a65dc93e96e24a11105b1a9c8cfe1d72a
   react-native-image-picker: ec9b713e248760bfa0f879f0715391de4651a7cb
   react-native-image-resizer: d9fb629a867335bdc13230ac2a58702bb8c8828f
@@ -804,7 +816,9 @@ SPEC CHECKSUMS:
   RNSecureRandom: 07efbdf2cd99efe13497433668e54acd7df49fef
   RNShare: d82e10f6b7677f4b0048c23709bd04098d5aee6c
   RNVectorIcons: fcc2f6cb32f5735b586e66d14103a74ce6ad61f8
+  RNZipArchive: 68a0c6db4b1c103f846f1559622050df254a3ade
   SocketRocket: fccef3f9c5cedea1353a9ef6ada904fde10d6608
+  SSZipArchive: fe6a26b2a54d5a0890f2567b5cc6de5caa600aef
   Yoga: e7ea9e590e27460d28911403b894722354d73479
   YogaKit: f782866e155069a2cca2517aafea43200b01fd5a
 

packages/app-mobile/package.json

@@ -24,7 +24,7 @@
     "@joplin/renderer": "~2.11",
     "@react-native-community/clipboard": "1.5.1",
     "@react-native-community/datetimepicker": "7.0.1",
-    "@react-native-community/geolocation": "2.1.0",
+    "@react-native-community/geolocation": "3.0.6",
     "@react-native-community/netinfo": "9.3.10",
     "@react-native-community/push-notification-ios": "1.11.0",
     "@react-native-community/slider": "4.4.2",
@@ -69,7 +69,8 @@
     "react-native-version-info": "1.1.1",
     "react-native-vosk": "0.1.12",
     "react-native-webview": "12.4.0",
-    "react-redux": "7.2.9",
+    "react-native-zip-archive": "6.0.9",
+    "react-redux": "8.0.7",
     "redux": "4.2.1",
     "rn-fetch-blob": "0.12.0",
     "stream": "0.0.2",
@@ -116,7 +117,7 @@
     "metro-react-native-babel-preset": "0.73.9",
     "nodemon": "2.0.22",
     "ts-jest": "29.1.0",
-    "ts-loader": "9.4.2",
+    "ts-loader": "9.4.3",
     "ts-node": "10.9.1",
     "typescript": "5.0.2",
     "uglify-js": "3.17.4",

packages/app-mobile/services/voiceTyping/vosk.android.ts

@@ -1,17 +1,25 @@
+import { languageCodeOnly } from '@joplin/lib/locale';
 import Logger from '@joplin/lib/Logger';
+import shim from '@joplin/lib/shim';
 import Vosk from 'react-native-vosk';
+import { unzip } from 'react-native-zip-archive';
+import RNFetchBlob from 'rn-fetch-blob';
+const md5 = require('md5');
+
 const logger = Logger.create('voiceTyping/vosk');
 
 enum State {
 	Idle = 0,
 	Recording,
+	Completing,
 }
 
 interface StartOptions {
 	onResult: (text: string)=> void;
 }
 
-let vosk_: Vosk|null = null;
+let vosk_: Record<string, Vosk> = {};
+
 let state_: State = State.Idle;
 
 export const voskEnabled = true;
@@ -23,12 +31,113 @@ export interface Recorder {
 	cleanup: ()=> void;
 }
 
-export const getVosk = async () => {
-	if (vosk_) return vosk_;
-	vosk_ = new Vosk();
-	const result = await vosk_.loadModel('model-fr-fr');
+const supportedLanguages = {
+	'en': 'https://alphacephei.com/vosk/models/vosk-model-small-en-us-0.15.zip',
+	'cn': 'https://alphacephei.com/vosk/models/vosk-model-small-cn-0.22.zip',
+	'ru': 'https://alphacephei.com/vosk/models/vosk-model-small-ru-0.22.zip',
+	'fr': 'https://alphacephei.com/vosk/models/vosk-model-small-fr-0.22.zip',
+	'de': 'https://alphacephei.com/vosk/models/vosk-model-small-de-0.15.zip',
+	'es': 'https://alphacephei.com/vosk/models/vosk-model-small-es-0.42.zip',
+	'pt': 'https://alphacephei.com/vosk/models/vosk-model-small-pt-0.3.zip',
+	'tr': 'https://alphacephei.com/vosk/models/vosk-model-small-tr-0.3.zip',
+	'vn': 'https://alphacephei.com/vosk/models/vosk-model-small-vn-0.4.zip',
+	'it': 'https://alphacephei.com/vosk/models/vosk-model-small-it-0.22.zip',
+	'nl': 'https://alphacephei.com/vosk/models/vosk-model-small-nl-0.22.zip',
+	'uk': 'https://alphacephei.com/vosk/models/vosk-model-small-uk-v3-small.zip',
+	'ja': 'https://alphacephei.com/vosk/models/vosk-model-small-ja-0.22.zip',
+	'hi': 'https://alphacephei.com/vosk/models/vosk-model-small-hi-0.22.zip',
+	'cs': 'https://alphacephei.com/vosk/models/vosk-model-small-cs-0.4-rhasspy.zip',
+	'pl': 'https://alphacephei.com/vosk/models/vosk-model-small-pl-0.22.zip',
+	'uz': 'https://alphacephei.com/vosk/models/vosk-model-small-uz-0.22.zip',
+	'ko': 'https://alphacephei.com/vosk/models/vosk-model-small-ko-0.22.zip',
+};
+
+export const isSupportedLanguage = (locale: string) => {
+	const l = languageCodeOnly(locale).toLowerCase();
+	return Object.keys(supportedLanguages).includes(l);
+};
+
+// Where all the models files for all the languages are
+const getModelRootDir = () => {
+	return `${RNFetchBlob.fs.dirs.DocumentDir}/vosk-models`;
+};
+
+// Where we unzip a model after downloading it
+const getUnzipDir = (locale: string) => {
+	return `${getModelRootDir()}/${locale}`;
+};
+
+// Where the model for a particular language is
+const getModelDir = (locale: string) => {
+	return `${getUnzipDir(locale)}/model`;
+};
+
+const languageModelUrl = (locale: string) => {
+	const l = languageCodeOnly(locale).toLowerCase();
+	if (!(l in supportedLanguages)) throw new Error(`No language file for: ${locale}`);
+	return (supportedLanguages as any)[l];
+};
+
+export const modelIsDownloaded = async (locale: string) => {
+	const uuidFile = `${getModelDir(locale)}/uuid`;
+	return shim.fsDriver().exists(uuidFile);
+};
+
+export const getVosk = async (locale: string) => {
+	if (vosk_[locale]) return vosk_[locale];
+
+	const vosk = new Vosk();
+	const modelDir = await downloadModel(locale);
+	logger.info(`Loading model from ${modelDir}`);
+	await shim.fsDriver().readDirStats(modelDir);
+	const result = await vosk.loadModel(modelDir);
 	logger.info('getVosk:', result);
-	return vosk_;
+
+	vosk_ = { [locale]: vosk };
+
+	return vosk;
+};
+
+const downloadModel = async (locale: string) => {
+	const modelUrl = languageModelUrl(locale);
+	const unzipDir = getUnzipDir(locale);
+	const zipFilePath = `${unzipDir}.zip`;
+	const modelDir = getModelDir(locale);
+	const uuidFile = `${modelDir}/uuid`;
+
+	if (await modelIsDownloaded(locale)) {
+		logger.info(`Model for ${locale} already exists at ${modelDir}`);
+		return modelDir;
+	}
+
+	await shim.fsDriver().remove(unzipDir);
+
+	logger.info(`Downloading model from: ${modelUrl}`);
+
+	await shim.fetchBlob(languageModelUrl(locale), {
+		path: zipFilePath,
+	});
+
+	logger.info(`Unzipping ${zipFilePath} => ${unzipDir}`);
+
+	await unzip(zipFilePath, unzipDir);
+
+	const dirs = await shim.fsDriver().readDirStats(unzipDir);
+	if (dirs.length !== 1) {
+		logger.error('Expected 1 directory but got', dirs);
+		throw new Error(`Expected 1 directory, but got ${dirs.length}`);
+	}
+
+	const fullUnzipPath = `${unzipDir}/${dirs[0].path}`;
+
+	logger.info(`Moving ${fullUnzipPath} =>  ${modelDir}`);
+	await shim.fsDriver().rename(fullUnzipPath, modelDir);
+
+	await shim.fsDriver().writeFile(uuidFile, md5(modelUrl));
+
+	await shim.fsDriver().remove(zipFilePath);
+
+	return modelDir;
 };
 
 export const startRecording = (vosk: Vosk, options: StartOptions): Recorder => {
@@ -110,8 +219,9 @@ export const startRecording = (vosk: Vosk, options: StartOptions): Recorder => {
 			});
 		},
 		cleanup: () => {
-			if (state_ !== State.Idle) {
+			if (state_ === State.Recording) {
 				logger.info('Cancelling...');
+				state_ = State.Completing;
 				vosk.stopOnly();
 				completeRecording('', null);
 			}

packages/app-mobile/services/voiceTyping/vosk.ios.ts

@@ -13,7 +13,15 @@ export interface Recorder {
 	cleanup: ()=> void;
 }
 
-export const getVosk = async () => {
+export const isSupportedLanguage = (_locale: string) => {
+	return false;
+};
+
+export const modelIsDownloaded = async (_locale: string) => {
+	return false;
+};
+
+export const getVosk = async (_locale: string) => {
 	return {} as any;
 };
 

packages/app-mobile/utils/fs-driver-rn.ts

@@ -116,6 +116,13 @@ export default class FsDriverRN extends FsDriverBase {
 		return RNFS.moveFile(source, dest);
 	}
 
+	public async rename(source: string, dest: string) {
+		if (isScopedUri(source) || isScopedUri(dest)) {
+			await RNSAF.rename(source, dest);
+		}
+		return RNFS.moveFile(source, dest);
+	}
+
 	public async exists(path: string) {
 		if (isScopedUri(path)) {
 			return RNSAF.exists(path);

packages/fork-htmlparser2/package.json

@@ -40,7 +40,7 @@
   },
   "dependencies": {
     "domelementtype": "2.3.0",
-    "domhandler": "3.3.0",
+    "domhandler": "5.0.3",
     "domutils": "3.1.0",
     "entities": "2.2.0"
   },

packages/generator-joplin/generators/app/templates/api/JoplinData.d.ts

@@ -1,4 +1,5 @@
 import { ModelType } from '../../../BaseModel';
+import Plugin from '../Plugin';
 import { Path } from './types';
 /**
  * This module provides access to the Joplin data API: https://joplinapp.org/api/references/rest_api/
@@ -39,6 +40,8 @@ import { Path } from './types';
 export default class JoplinData {
     private api_;
     private pathSegmentRegex_;
+    private plugin;
+    constructor(plugin: Plugin);
     private serializeApiBody;
     private pathToString;
     get(path: Path, query?: any): Promise<any>;
@@ -47,4 +50,24 @@ export default class JoplinData {
     delete(path: Path, query?: any): Promise<any>;
     itemType(itemId: string): Promise<ModelType>;
     resourcePath(resourceId: string): Promise<string>;
+    /**
+     * Gets an item user data. User data are key/value pairs. The `key` can be any
+     * arbitrary string, while the `value` can be of any type supported by
+     * [JSON.stringify](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#description)
+     *
+     * User data is synchronised across devices, and each value wil be merged based on their timestamp:
+     *
+     * - If value is modified by client 1, then modified by client 2, it will take the value from client 2
+     * - If value is modified by client 1, then deleted by client 2, the value will be deleted after merge
+     * - If value is deleted by client 1, then updated by client 2, the value will be restored and set to the value from client 2 after merge
+     */
+    userDataGet<T>(itemType: ModelType, itemId: string, key: string): Promise<T>;
+    /**
+     * Sets a note user data. See {@link JoplinData.userDataGet} for more details.
+     */
+    userDataSet<T>(itemType: ModelType, itemId: string, key: string, value: T): Promise<void>;
+    /**
+     * Deletes a note user data. See {@link JoplinData.userDataGet} for more details.
+     */
+    userDataDelete(itemType: ModelType, itemId: string, key: string): Promise<void>;
 }

packages/generator-joplin/updateTypesAndDemos.sh

@@ -1,11 +1,13 @@
 #!/bin/bash
 
-git pull
+set -e
 
-if [[ -n $(git status --porcelain) ]]; then
-	echo "There are changes in the repo"
-	exit 1
-fi
+# git pull
+
+# if [[ -n $(git status --porcelain) ]]; then
+# 	echo "There are changes in the repo"
+# 	exit 1
+# fi
 
 SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
 CLI_DIR="$SCRIPT_DIR/../app-cli"
@@ -13,7 +15,7 @@ LIB_DIR="$SCRIPT_DIR/../lib"
 
 ./updateTypes.sh
 
-yarn link
+npm link
 
 "$CLI_DIR/tests/support/plugins/updatePlugins.sh"
 

packages/lib/BaseModel.ts

@@ -4,6 +4,7 @@ import Database from './database';
 import uuid from './uuid';
 import time from './time';
 import JoplinDatabase, { TableField } from './JoplinDatabase';
+import { LoadOptions } from './models/utils/types';
 const Mutex = require('async-mutex').Mutex;
 
 // New code should make use of this enum
@@ -254,7 +255,7 @@ class BaseModel {
 			});
 	}
 
-	public static load(id: string, options: any = null) {
+	public static load(id: string, options: LoadOptions = null) {
 		return this.loadByField('id', id, options);
 	}
 
@@ -352,7 +353,7 @@ class BaseModel {
 			});
 	}
 
-	public static loadByField(fieldName: string, fieldValue: any, options: any = null) {
+	public static loadByField(fieldName: string, fieldValue: any, options: LoadOptions = null) {
 		if (!options) options = {};
 		if (!('caseInsensitive' in options)) options.caseInsensitive = false;
 		if (!options.fields) options.fields = '*';
@@ -361,7 +362,7 @@ class BaseModel {
 		return this.modelSelectOne(sql, [fieldValue]);
 	}
 
-	public static loadByFields(fields: any, options: any = null) {
+	public static loadByFields(fields: any, options: LoadOptions = null) {
 		if (!options) options = {};
 		if (!('caseInsensitive' in options)) options.caseInsensitive = false;
 		if (!options.fields) options.fields = '*';

packages/lib/JoplinDatabase.ts

@@ -354,7 +354,7 @@ export default class JoplinDatabase extends Database {
 		// must be set in the synchronizer too.
 
 		// Note: v16 and v17 don't do anything. They were used to debug an issue.
-		const existingDatabaseVersions = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42];
+		const existingDatabaseVersions = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43];
 
 		let currentVersionIndex = existingDatabaseVersions.indexOf(fromVersion);
 
@@ -917,6 +917,13 @@ export default class JoplinDatabase extends Database {
 				queries.push(this.addMigrationFile(42));
 			}
 
+			if (targetVersion === 43) {
+				queries.push('ALTER TABLE `notes` ADD COLUMN `user_data` TEXT NOT NULL DEFAULT ""');
+				queries.push('ALTER TABLE `tags` ADD COLUMN `user_data` TEXT NOT NULL DEFAULT ""');
+				queries.push('ALTER TABLE `folders` ADD COLUMN `user_data` TEXT NOT NULL DEFAULT ""');
+				queries.push('ALTER TABLE `resources` ADD COLUMN `user_data` TEXT NOT NULL DEFAULT ""');
+			}
+
 			const updateVersionQuery = { sql: 'UPDATE version SET version = ?', params: [targetVersion] };
 
 			queries.push(updateVersionQuery);

packages/lib/callbackUrlUtils.test.ts

@@ -3,13 +3,14 @@ import * as callbackUrlUtils from './callbackUrlUtils';
 describe('callbackUrlUtils', () => {
 
 	it('should identify valid callback urls', () => {
-		const url = 'joplin://x-callback-url/123?a=b';
+		const url = 'joplin://x-callback-url/openFolder?a=b';
 		expect(callbackUrlUtils.isCallbackUrl(url)).toBe(true);
 	});
 
 	it('should identify invalid callback urls', () => {
 		expect(callbackUrlUtils.isCallbackUrl('not-joplin://x-callback-url/123?a=b')).toBe(false);
 		expect(callbackUrlUtils.isCallbackUrl('joplin://xcallbackurl/123?a=b')).toBe(false);
+		expect(callbackUrlUtils.isCallbackUrl('joplin://x-callback-url/invalidCommand?a=b')).toBe(false);
 	});
 
 	it('should build valid note callback urls', () => {

packages/lib/callbackUrlUtils.ts

@@ -1,7 +1,9 @@
 const URL = require('url-parse');
 
 export function isCallbackUrl(s: string) {
-	return s.startsWith('joplin://x-callback-url/');
+	return s.startsWith('joplin://x-callback-url/openNote?') ||
+		s.startsWith('joplin://x-callback-url/openFolder?') ||
+		s.startsWith('joplin://x-callback-url/openTag?');
 }
 
 export function getNoteCallbackUrl(noteId: string) {

packages/lib/locale.ts

@@ -508,7 +508,8 @@ function languageNameInEnglish(languageCode: string) {
 	return codeToLanguageE_[languageCode] ? codeToLanguageE_[languageCode] : '';
 }
 
-function languageName(languageCode: string, defaultToEnglish: boolean = true) {
+function languageName(canonicalName: string, defaultToEnglish: boolean = true) {
+	const languageCode = languageCodeOnly(canonicalName);
 	if (codeToLanguage_[languageCode]) return codeToLanguage_[languageCode];
 	if (defaultToEnglish) return languageNameInEnglish(languageCode);
 	return '';
@@ -603,4 +604,4 @@ const stringByLocale = (locale: string, s: string, ...args: any[]): string => {
 	}
 };
 
-export { _, _n, supportedLocales, currentLocale, localesFromLanguageCode, languageCodeOnly, countryDisplayName, localeStrings, setLocale, supportedLocalesToLanguages, defaultLocale, closestSupportedLocale, languageCode, countryCodeOnly };
+export { _, _n, supportedLocales, languageName, currentLocale, localesFromLanguageCode, languageCodeOnly, countryDisplayName, localeStrings, setLocale, supportedLocalesToLanguages, defaultLocale, closestSupportedLocale, languageCode, countryCodeOnly };

packages/lib/models/BaseItem.ts

@@ -11,6 +11,7 @@ import ShareService from '../services/share/ShareService';
 import itemCanBeEncrypted from './utils/itemCanBeEncrypted';
 import { getEncryptionEnabled } from '../services/synchronizer/syncInfoUtils';
 import JoplinError from '../JoplinError';
+import { LoadOptions } from './utils/types';
 const { sprintf } = require('sprintf-js');
 const moment = require('moment');
 
@@ -227,9 +228,10 @@ export default class BaseItem extends BaseModel {
 		return ItemClass.loadByField(field, value);
 	}
 
-	public static loadItem(itemType: ModelType, id: string) {
+	public static loadItem(itemType: ModelType, id: string, options: LoadOptions = null) {
+		if (!options) options = {};
 		const ItemClass = this.itemClass(itemType);
-		return ItemClass.load(id);
+		return ItemClass.load(id, options);
 	}
 
 	public static deleteItem(itemType: ModelType, id: string) {

packages/lib/models/Note.ts

@@ -14,6 +14,7 @@ import { toFileProtocolPath, toForwardSlashes } from '../path-utils';
 const { pregQuote, substrWithEllipsis } = require('../string-utils.js');
 const { _ } = require('../locale');
 import { pull, unique } from '../ArrayUtils';
+import { LoadOptions } from './utils/types';
 const urlUtils = require('../urlUtils.js');
 const { isImageMimeType } = require('../resourceUtils');
 const { MarkupToHtml } = require('@joplin/renderer');
@@ -662,6 +663,10 @@ export default class Note extends BaseItem {
 		return n.updated_time < date;
 	}
 
+	public static load(id: string, options: LoadOptions = null): Promise<NoteEntity> {
+		return super.load(id, options);
+	}
+
 	public static async save(o: NoteEntity, options: any = null): Promise<NoteEntity> {
 		const isNew = this.isNew(o, options);
 
@@ -705,7 +710,7 @@ export default class Note extends BaseItem {
 		if (oldNote) {
 			for (const field in o) {
 				if (!o.hasOwnProperty(field)) continue;
-				if ((o as any)[field] !== oldNote[field]) {
+				if ((o as any)[field] !== (oldNote as any)[field]) {
 					changedFields.push(field);
 				}
 			}

packages/lib/models/utils/types.ts

@@ -15,3 +15,8 @@ export interface Pagination {
 	page: number;
 	caseInsensitive?: boolean;
 }
+
+export interface LoadOptions {
+	caseInsensitive?: boolean;
+	fields?: string | string[];
+}

packages/lib/models/utils/userData.test.ts

@@ -0,0 +1,210 @@
+import { ModelType } from '../../BaseModel';
+import { UserData } from '../../services/database/types';
+import { msleep, setupDatabaseAndSynchronizer, switchClient } from '../../testing/test-utils';
+import Folder from '../Folder';
+import Note from '../Note';
+import Resource from '../Resource';
+import Tag from '../Tag';
+import { LoadOptions } from './types';
+import { deleteItemUserData, deleteNoteUserData, getItemUserData, getNoteUserData, mergeUserData, setItemUserData, setNoteUserData } from './userData';
+
+const loadOptions: LoadOptions = { fields: ['id', 'parent_id', 'user_data', 'updated_time'] };
+
+describe('utils/userData', () => {
+
+	beforeEach(async () => {
+		await setupDatabaseAndSynchronizer(1);
+		await switchClient(1);
+	});
+
+	it('should set and get user data on a note', async () => {
+		const folder = await Folder.save({});
+		let note = await Note.save({ parent_id: folder.id });
+		note = await Note.load(note.id, loadOptions);
+		await msleep(5);
+		await setNoteUserData(note, 'org.joplin', 'my-key', 'something');
+
+		const noteReloaded = await Note.load(note.id);
+		expect(await getNoteUserData(noteReloaded, 'org.joplin', 'my-key')).toBe('something');
+
+		// Check that the updated_time has been updated (for sync purposes), but
+		// not the user_updated_time.
+		expect(noteReloaded.updated_time).toBeGreaterThan(note.updated_time);
+		expect(noteReloaded.user_updated_time).toBe(note.updated_time);
+
+		// Check for non-existing props
+		expect(await getNoteUserData(noteReloaded, 'org.doesntexist', 'my-key')).toBe(undefined);
+		expect(await getNoteUserData(noteReloaded, 'org.joplin', 'doesntexist')).toBe(undefined);
+	});
+
+	it('should set and get user data on any item', async () => {
+		const folder = await Folder.save({});
+		const tag = await Tag.save({});
+		const resource = await Resource.save({ mime: 'plain/text' });
+
+		await setItemUserData(ModelType.Folder, folder.id, 'foldertest', 'folderkey', 123);
+		expect(await getItemUserData(ModelType.Folder, folder.id, 'foldertest', 'folderkey')).toBe(123);
+		await deleteItemUserData(ModelType.Folder, folder.id, 'foldertest', 'folderkey');
+		expect(await getItemUserData(ModelType.Folder, folder.id, 'foldertest', 'folderkey')).toBe(undefined);
+
+		await setItemUserData(ModelType.Tag, tag.id, 'tagtest', 'tagkey', 123);
+		expect(await getItemUserData(ModelType.Tag, tag.id, 'tagtest', 'tagkey')).toBe(123);
+		await deleteItemUserData(ModelType.Tag, tag.id, 'tagtest', 'tagkey');
+		expect(await getItemUserData(ModelType.Tag, tag.id, 'tagtest', 'tagkey')).toBe(undefined);
+
+		await setItemUserData(ModelType.Resource, resource.id, 'resourcetest', 'resourcekey', 123);
+		expect(await getItemUserData(ModelType.Resource, resource.id, 'resourcetest', 'resourcekey')).toBe(123);
+		await deleteItemUserData(ModelType.Resource, resource.id, 'resourcetest', 'resourcekey');
+		expect(await getItemUserData(ModelType.Resource, resource.id, 'resourcetest', 'resourcekey')).toBe(undefined);
+	});
+
+	it('should delete user data', async () => {
+		const folder = await Folder.save({});
+		let note = await Note.save({ parent_id: folder.id });
+		note = await Note.load(note.id, loadOptions);
+		await setNoteUserData(note, 'org.joplin', 'my-key', 'something');
+
+		let noteReloaded = await Note.load(note.id);
+		expect(await getNoteUserData(noteReloaded, 'org.joplin', 'my-key')).toBe('something');
+
+		noteReloaded = await deleteNoteUserData(noteReloaded, 'org.joplin', 'my-key');
+		expect(await getNoteUserData(noteReloaded, 'org.joplin', 'my-key')).toBe(undefined);
+
+		// Check that it works if we set it again
+		await setNoteUserData(note, 'org.joplin', 'my-key', 'something else');
+		noteReloaded = await Note.load(noteReloaded.id, loadOptions);
+		expect(await getNoteUserData(noteReloaded, 'org.joplin', 'my-key')).toBe('something else');
+	});
+
+	it('should merge user data', async () => {
+		const testCases: [UserData, UserData, UserData][] = [
+			[
+				{
+					'org.joplin': {
+						'k1': {
+							v: 123,
+							t: 0,
+						},
+						'k3': {
+							v: 789,
+							t: 5,
+						},
+						'k4': {
+							v: 789,
+							t: 5,
+						},
+					},
+					'com.example': {},
+				},
+				{
+					'org.joplin': {
+						'k1': {
+							v: 456,
+							t: 1,
+						},
+						'k2': {
+							v: 'abc',
+							t: 5,
+						},
+						'k4': {
+							v: 111,
+							t: 0,
+						},
+					},
+				},
+				{
+					'org.joplin': {
+						'k1': {
+							v: 456,
+							t: 1,
+						},
+						'k2': {
+							v: 'abc',
+							t: 5,
+						},
+						'k3': {
+							v: 789,
+							t: 5,
+						},
+						'k4': {
+							v: 789,
+							t: 5,
+						},
+					},
+					'com.example': {},
+				},
+			],
+
+			[
+				// Client 2 delete a prop
+				// Later, client 1 update that prop
+				// Then data is merged
+				// => In that case, the data is restored using client 1 data
+				{
+					'org.joplin': {
+						'k1': {
+							v: 123,
+							t: 10,
+						},
+					},
+				},
+				{
+					'org.joplin': {
+						'k1': {
+							v: 0,
+							t: 0,
+							d: 1,
+						},
+					},
+				},
+				{
+					'org.joplin': {
+						'k1': {
+							v: 123,
+							t: 10,
+						},
+					},
+				},
+			],
+
+			[
+				// Client 1 update a prop
+				// Later, client 2 delete a prop
+				// Then data is merged
+				// => In that case, the data is deleted and the update from client 1 is lost
+				{
+					'org.joplin': {
+						'k1': {
+							v: 123,
+							t: 0,
+						},
+					},
+				},
+				{
+					'org.joplin': {
+						'k1': {
+							v: 0,
+							t: 10,
+							d: 1,
+						},
+					},
+				},
+				{
+					'org.joplin': {
+						'k1': {
+							v: 0,
+							t: 10,
+							d: 1,
+						},
+					},
+				},
+			],
+		];
+
+		for (const [target, source, expected] of testCases) {
+			const actual = mergeUserData(target, source);
+			expect(actual).toEqual(expected);
+		}
+	});
+
+});

packages/lib/models/utils/userData.ts

@@ -0,0 +1,155 @@
+import { ModelType } from '../../BaseModel';
+import { FolderEntity, NoteEntity, ResourceEntity, TagEntity, UserData, UserDataValue } from '../../services/database/types';
+import Note from '../Note';
+import Folder from '../Folder';
+import Resource from '../Resource';
+import Tag from '../Tag';
+import BaseItem from '../BaseItem';
+import { LoadOptions } from './types';
+
+const maxKeyLength = 255;
+
+type SupportedEntity = NoteEntity | ResourceEntity | FolderEntity | TagEntity;
+
+const unserializeUserData = (s: string): UserData => {
+	if (!s) return {};
+
+	try {
+		const r = JSON.parse(s);
+		return r as UserData;
+	} catch (error) {
+		error.message = `Could not unserialize user data: ${error.message}: ${s}`;
+		throw error;
+	}
+};
+
+const serializeUserData = (d: UserData): string => {
+	if (!d) return '';
+	return JSON.stringify(d);
+};
+
+export const setUserData = <T>(userData: UserData, namespace: string, key: string, value: T, deleted: boolean = false): UserData => {
+	if (key.length > maxKeyLength) new Error(`Key must no be longer than ${maxKeyLength} characters`);
+	if (!(namespace in userData)) userData[namespace] = {};
+	if (key in userData[namespace] && userData[namespace][key].v === value) return userData;
+
+	const newUserDataValue: UserDataValue = {
+		v: value,
+		t: Date.now(),
+	};
+
+	if (deleted) newUserDataValue.d = 1;
+
+	return {
+		...userData,
+		[namespace]: {
+			...userData[namespace],
+			[key]: newUserDataValue,
+		},
+	};
+};
+
+export const getUserData = <T>(userData: UserData, namespace: string, key: string): T|undefined => {
+	if (!hasUserData(userData, namespace, key)) return undefined;
+	return userData[namespace][key].v as T;
+};
+
+const checkIsSupportedItemType = (itemType: ModelType) => {
+	if (![ModelType.Note, ModelType.Folder, ModelType.Tag, ModelType.Resource].includes(itemType)) {
+		throw new Error(`Unsupported item type: ${itemType}`);
+	}
+};
+
+export const setItemUserData = async <T>(itemType: ModelType, itemId: string, namespace: string, key: string, value: T, deleted: boolean = false): Promise<SupportedEntity> => {
+	checkIsSupportedItemType(itemType);
+
+	interface ItemSlice {
+		user_data: string;
+		updated_time?: number;
+		id?: string;
+		parent_id?: string;
+	}
+
+	const options: LoadOptions = { fields: ['user_data'] };
+	if (itemType === ModelType.Note) (options.fields as string[]).push('parent_id');
+
+	const item = await BaseItem.loadItem(itemType, itemId, options) as ItemSlice;
+
+	const userData = unserializeUserData(item.user_data);
+	const newUserData = setUserData(userData, namespace, key, value, deleted);
+
+	const itemToSave: ItemSlice = {
+		id: itemId,
+		user_data: serializeUserData(newUserData),
+		updated_time: Date.now(),
+	};
+
+	if (itemType === ModelType.Note) itemToSave.parent_id = item.parent_id;
+
+	const saveOptions: any = { autoTimestamp: false };
+
+	if (itemType === ModelType.Note) return Note.save(itemToSave, saveOptions);
+	if (itemType === ModelType.Folder) return Folder.save(itemToSave, saveOptions);
+	if (itemType === ModelType.Resource) return Resource.save(itemToSave, saveOptions);
+	if (itemType === ModelType.Tag) return Tag.save(itemToSave, saveOptions);
+
+	throw new Error('Unreachable');
+};
+
+// Deprecated - don't use
+export const setNoteUserData = async <T>(note: NoteEntity, namespace: string, key: string, value: T, deleted: boolean = false): Promise<NoteEntity> => {
+	return setItemUserData(ModelType.Note, note.id, namespace, key, value, deleted);
+};
+
+const hasUserData = (userData: UserData, namespace: string, key: string) => {
+	if (!(namespace in userData)) return false;
+	if (!(key in userData[namespace])) return false;
+	if (userData[namespace][key].d) return false;
+	return true;
+};
+
+export const getItemUserData = async <T>(itemType: ModelType, itemId: string, namespace: string, key: string): Promise<T|undefined> => {
+	checkIsSupportedItemType(itemType);
+
+	interface ItemSlice {
+		user_data: string;
+	}
+
+	const item = await BaseItem.loadItem(itemType, itemId, { fields: ['user_data'] }) as ItemSlice;
+	const userData = unserializeUserData(item.user_data);
+	return getUserData(userData, namespace, key);
+};
+
+// Deprecated - don't use
+export const getNoteUserData = async <T>(note: NoteEntity, namespace: string, key: string): Promise<T|undefined> => {
+	return getItemUserData<T>(ModelType.Note, note.id, namespace, key);
+};
+
+export const deleteItemUserData = async (itemType: ModelType, itemId: string, namespace: string, key: string): Promise<SupportedEntity> => {
+	return setItemUserData(itemType, itemId, namespace, key, 0, true);
+};
+
+// Deprecated - don't use
+export const deleteNoteUserData = async (note: NoteEntity, namespace: string, key: string): Promise<NoteEntity> => {
+	return setNoteUserData(note, namespace, key, 0, true);
+};
+
+export const mergeUserData = (target: UserData, source: UserData): UserData => {
+	const output: UserData = { ...target };
+
+	for (const namespaceName of Object.keys(source)) {
+		if (!(namespaceName in output)) output[namespaceName] = source[namespaceName];
+		const namespace = source[namespaceName];
+		for (const [key, value] of Object.entries(namespace)) {
+			// Keep ours
+			if (output[namespaceName][key] && output[namespaceName][key].t >= value.t) continue;
+
+			// Use theirs
+			output[namespaceName][key] = {
+				...value,
+			};
+		}
+	}
+
+	return output;
+};

packages/lib/services/database/types.ts

@@ -38,6 +38,23 @@ export const defaultFolderIcon = () => {
   return icon;
 }
 
+export interface UserDataValue {
+  v: any; // value
+  t: Number; // timestamp
+  d?: Number; // deleted - 0 or 1 (default = 0)
+}
+
+export type UserData = Record<string, Record<string, UserDataValue>>;
+
+
+
+
+
+
+
+
+
+
 
 
 
@@ -60,225 +77,226 @@ export const defaultFolderIcon = () => {
 * Rerun sql-ts to regenerate this file.
 */
 export interface AlarmEntity {
-  "id"?: number | null 
-  "note_id"?: string 
-  "trigger_time"?: number 
-  "type_"?: number 
+  'id'?: number | null;
+  'note_id'?: string;
+  'trigger_time'?: number;
+  'type_'?: number;
 }
 export interface DeletedItemEntity {
-  "id"?: number | null 
-  "item_type"?: number 
-  "item_id"?: string 
-  "deleted_time"?: number 
-  "sync_target"?: number 
-  "type_"?: number 
+  'deleted_time'?: number;
+  'id'?: number | null;
+  'item_id'?: string;
+  'item_type'?: number;
+  'sync_target'?: number;
+  'type_'?: number;
 }
 export interface FolderEntity {
-  "id"?: string | null 
-  "title"?: string 
-  "created_time"?: number 
-  "updated_time"?: number 
-  "user_created_time"?: number 
-  "user_updated_time"?: number 
-  "encryption_cipher_text"?: string 
-  "encryption_applied"?: number 
-  "parent_id"?: string 
-  "is_shared"?: number 
-  "share_id"?: string 
-  "master_key_id"?: string 
-  "icon"?: string 
-  "type_"?: number 
+  'created_time'?: number;
+  'encryption_applied'?: number;
+  'encryption_cipher_text'?: string;
+  'icon'?: string;
+  'id'?: string | null;
+  'is_shared'?: number;
+  'master_key_id'?: string;
+  'parent_id'?: string;
+  'share_id'?: string;
+  'title'?: string;
+  'updated_time'?: number;
+  'user_created_time'?: number;
+  'user_updated_time'?: number;
+  'type_'?: number;
 }
 export interface ItemChangeEntity {
-  "id"?: number | null 
-  "item_type"?: number 
-  "item_id"?: string 
-  "type"?: number 
-  "created_time"?: number 
-  "source"?: number 
-  "before_change_item"?: string 
-  "type_"?: number 
+  'before_change_item'?: string;
+  'created_time'?: number;
+  'id'?: number | null;
+  'item_id'?: string;
+  'item_type'?: number;
+  'source'?: number;
+  'type'?: number;
+  'type_'?: number;
 }
 export interface KeyValueEntity {
-  "id"?: number | null 
-  "key"?: string 
-  "value"?: string 
-  "type"?: number 
-  "updated_time"?: number 
-  "type_"?: number 
+  'id'?: number | null;
+  'key'?: string;
+  'type'?: number;
+  'updated_time'?: number;
+  'value'?: string;
+  'type_'?: number;
 }
 export interface MigrationEntity {
-  "id"?: number | null 
-  "number"?: number 
-  "updated_time"?: number 
-  "created_time"?: number 
-  "type_"?: number 
+  'created_time'?: number;
+  'id'?: number | null;
+  'number'?: number;
+  'updated_time'?: number;
+  'type_'?: number;
 }
 export interface NoteResourceEntity {
-  "id"?: number | null 
-  "note_id"?: string 
-  "resource_id"?: string 
-  "is_associated"?: number 
-  "last_seen_time"?: number 
-  "type_"?: number 
+  'id'?: number | null;
+  'is_associated'?: number;
+  'last_seen_time'?: number;
+  'note_id'?: string;
+  'resource_id'?: string;
+  'type_'?: number;
 }
 export interface NoteTagEntity {
-  "id"?: string | null 
-  "note_id"?: string 
-  "tag_id"?: string 
-  "created_time"?: number 
-  "updated_time"?: number 
-  "user_created_time"?: number 
-  "user_updated_time"?: number 
-  "encryption_cipher_text"?: string 
-  "encryption_applied"?: number 
-  "is_shared"?: number 
-  "type_"?: number 
+  'created_time'?: number;
+  'encryption_applied'?: number;
+  'encryption_cipher_text'?: string;
+  'id'?: string | null;
+  'is_shared'?: number;
+  'note_id'?: string;
+  'tag_id'?: string;
+  'updated_time'?: number;
+  'user_created_time'?: number;
+  'user_updated_time'?: number;
+  'type_'?: number;
 }
 export interface NoteEntity {
-  "id"?: string | null 
-  "parent_id"?: string 
-  "title"?: string 
-  "body"?: string 
-  "created_time"?: number 
-  "updated_time"?: number 
-  "is_conflict"?: number 
-  "latitude"?: number 
-  "longitude"?: number 
-  "altitude"?: number 
-  "author"?: string 
-  "source_url"?: string 
-  "is_todo"?: number 
-  "todo_due"?: number 
-  "todo_completed"?: number 
-  "source"?: string 
-  "source_application"?: string 
-  "application_data"?: string 
-  "order"?: number 
-  "user_created_time"?: number 
-  "user_updated_time"?: number 
-  "encryption_cipher_text"?: string 
-  "encryption_applied"?: number 
-  "markup_language"?: number 
-  "is_shared"?: number 
-  "share_id"?: string 
-  "conflict_original_id"?: string 
-  "master_key_id"?: string 
-  "type_"?: number 
+  'altitude'?: number;
+  'application_data'?: string;
+  'author'?: string;
+  'body'?: string;
+  'conflict_original_id'?: string;
+  'created_time'?: number;
+  'encryption_applied'?: number;
+  'encryption_cipher_text'?: string;
+  'id'?: string | null;
+  'is_conflict'?: number;
+  'is_shared'?: number;
+  'is_todo'?: number;
+  'latitude'?: number;
+  'longitude'?: number;
+  'markup_language'?: number;
+  'master_key_id'?: string;
+  'order'?: number;
+  'parent_id'?: string;
+  'share_id'?: string;
+  'source'?: string;
+  'source_application'?: string;
+  'source_url'?: string;
+  'title'?: string;
+  'todo_completed'?: number;
+  'todo_due'?: number;
+  'updated_time'?: number;
+  'user_created_time'?: number;
+  'user_data'?: string;
+  'user_updated_time'?: number;
+  'type_'?: number;
 }
 export interface NotesNormalizedEntity {
-  "id"?: string 
-  "title"?: string 
-  "body"?: string 
-  "user_created_time"?: number 
-  "user_updated_time"?: number 
-  "is_todo"?: number 
-  "todo_completed"?: number 
-  "parent_id"?: string 
-  "latitude"?: number 
-  "longitude"?: number 
-  "altitude"?: number 
-  "source_url"?: string 
-  "todo_due"?: number 
-  "type_"?: number 
+  'altitude'?: number;
+  'body'?: string;
+  'id'?: string;
+  'is_todo'?: number;
+  'latitude'?: number;
+  'longitude'?: number;
+  'parent_id'?: string;
+  'source_url'?: string;
+  'title'?: string;
+  'todo_completed'?: number;
+  'todo_due'?: number;
+  'user_created_time'?: number;
+  'user_updated_time'?: number;
+  'type_'?: number;
 }
 export interface ResourceLocalStateEntity {
-  "id"?: number | null 
-  "resource_id"?: string 
-  "fetch_status"?: number 
-  "fetch_error"?: string 
-  "type_"?: number 
+  'fetch_error'?: string;
+  'fetch_status'?: number;
+  'id'?: number | null;
+  'resource_id'?: string;
+  'type_'?: number;
 }
 export interface ResourceEntity {
-  "id"?: string | null 
-  "title"?: string 
-  "mime"?: string 
-  "filename"?: string 
-  "created_time"?: number 
-  "updated_time"?: number 
-  "user_created_time"?: number 
-  "user_updated_time"?: number 
-  "file_extension"?: string 
-  "encryption_cipher_text"?: string 
-  "encryption_applied"?: number 
-  "encryption_blob_encrypted"?: number 
-  "size"?: number 
-  "is_shared"?: number 
-  "share_id"?: string 
-  "master_key_id"?: string 
-  "type_"?: number 
+  'created_time'?: number;
+  'encryption_applied'?: number;
+  'encryption_blob_encrypted'?: number;
+  'encryption_cipher_text'?: string;
+  'file_extension'?: string;
+  'filename'?: string;
+  'id'?: string | null;
+  'is_shared'?: number;
+  'master_key_id'?: string;
+  'mime'?: string;
+  'share_id'?: string;
+  'size'?: number;
+  'title'?: string;
+  'updated_time'?: number;
+  'user_created_time'?: number;
+  'user_updated_time'?: number;
+  'type_'?: number;
 }
 export interface ResourcesToDownloadEntity {
-  "id"?: number | null 
-  "resource_id"?: string 
-  "updated_time"?: number 
-  "created_time"?: number 
-  "type_"?: number 
+  'created_time'?: number;
+  'id'?: number | null;
+  'resource_id'?: string;
+  'updated_time'?: number;
+  'type_'?: number;
 }
 export interface RevisionEntity {
-  "id"?: string | null 
-  "parent_id"?: string 
-  "item_type"?: number 
-  "item_id"?: string 
-  "item_updated_time"?: number 
-  "title_diff"?: string 
-  "body_diff"?: string 
-  "metadata_diff"?: string 
-  "encryption_cipher_text"?: string 
-  "encryption_applied"?: number 
-  "updated_time"?: number 
-  "created_time"?: number 
-  "type_"?: number 
+  'body_diff'?: string;
+  'created_time'?: number;
+  'encryption_applied'?: number;
+  'encryption_cipher_text'?: string;
+  'id'?: string | null;
+  'item_id'?: string;
+  'item_type'?: number;
+  'item_updated_time'?: number;
+  'metadata_diff'?: string;
+  'parent_id'?: string;
+  'title_diff'?: string;
+  'updated_time'?: number;
+  'type_'?: number;
 }
 export interface SettingEntity {
-  "key"?: string | null 
-  "value"?: string | null 
-  "type_"?: number 
+  'key'?: string | null;
+  'value'?: string | null;
+  'type_'?: number;
 }
 export interface SyncItemEntity {
-  "id"?: number | null 
-  "sync_target"?: number 
-  "sync_time"?: number 
-  "item_type"?: number 
-  "item_id"?: string 
-  "sync_disabled"?: number 
-  "sync_disabled_reason"?: string 
-  "force_sync"?: number 
-  "item_location"?: number 
-  "type_"?: number 
+  'force_sync'?: number;
+  'id'?: number | null;
+  'item_id'?: string;
+  'item_location'?: number;
+  'item_type'?: number;
+  'sync_disabled'?: number;
+  'sync_disabled_reason'?: string;
+  'sync_target'?: number;
+  'sync_time'?: number;
+  'type_'?: number;
 }
 export interface TableFieldEntity {
-  "id"?: number | null 
-  "table_name"?: string 
-  "field_name"?: string 
-  "field_type"?: number 
-  "field_default"?: string | null 
-  "type_"?: number 
+  'field_default'?: string | null;
+  'field_name'?: string;
+  'field_type'?: number;
+  'id'?: number | null;
+  'table_name'?: string;
+  'type_'?: number;
 }
 export interface TagEntity {
-  "id"?: string | null 
-  "title"?: string 
-  "created_time"?: number 
-  "updated_time"?: number 
-  "user_created_time"?: number 
-  "user_updated_time"?: number 
-  "encryption_cipher_text"?: string 
-  "encryption_applied"?: number 
-  "is_shared"?: number 
-  "parent_id"?: string 
-  "type_"?: number 
+  'created_time'?: number;
+  'encryption_applied'?: number;
+  'encryption_cipher_text'?: string;
+  'id'?: string | null;
+  'is_shared'?: number;
+  'parent_id'?: string;
+  'title'?: string;
+  'updated_time'?: number;
+  'user_created_time'?: number;
+  'user_updated_time'?: number;
+  'type_'?: number;
 }
 export interface TagsWithNoteCountEntity {
-  "id"?: string | null 
-  "title"?: string | null 
-  "created_time"?: number | null 
-  "updated_time"?: number | null 
-  "note_count"?: any | null 
-  "todo_completed_count"?: any | null 
-  "type_"?: number 
+  'created_time'?: number | null;
+  'id'?: string | null;
+  'note_count'?: any | null;
+  'title'?: string | null;
+  'todo_completed_count'?: any | null;
+  'updated_time'?: number | null;
+  'type_'?: number;
 }
 export interface VersionEntity {
-  "version"?: number 
-  "table_fields_version"?: number 
-  "type_"?: number 
+  'table_fields_version'?: number;
+  'version'?: number;
+  'type_'?: number;
 }

packages/lib/services/plugins/api/Joplin.ts

@@ -41,7 +41,7 @@ export default class Joplin {
 
 	public constructor(implementation: BasePlatformImplementation, plugin: Plugin, store: any) {
 		this.implementation_ = implementation;
-		this.data_ = new JoplinData();
+		this.data_ = new JoplinData(plugin);
 		this.plugins_ = new JoplinPlugins(plugin);
 		this.workspace_ = new JoplinWorkspace(store);
 		this.filters_ = new JoplinFilters();