Fixing url import

This version of the clipper will support both new and old Joplin
clients, so as to ease the transition.

.eslintignore

@@ -81,6 +81,7 @@ ElectronClient/app.js
 ElectronClient/bridge.js
 ElectronClient/commands/copyDevCommand.js
 ElectronClient/commands/focusElement.js
+ElectronClient/commands/openProfileDirectory.js
 ElectronClient/commands/startExternalEditing.js
 ElectronClient/commands/stopExternalEditing.js
 ElectronClient/commands/toggleExternalEditing.js
@@ -104,7 +105,11 @@ ElectronClient/gui/MainScreen/commands/hideModalMessage.js
 ElectronClient/gui/MainScreen/commands/moveToFolder.js
 ElectronClient/gui/MainScreen/commands/newFolder.js
 ElectronClient/gui/MainScreen/commands/newNote.js
+ElectronClient/gui/MainScreen/commands/newSubFolder.js
 ElectronClient/gui/MainScreen/commands/newTodo.js
+ElectronClient/gui/MainScreen/commands/openFolder.js
+ElectronClient/gui/MainScreen/commands/openNote.js
+ElectronClient/gui/MainScreen/commands/openTag.js
 ElectronClient/gui/MainScreen/commands/print.js
 ElectronClient/gui/MainScreen/commands/renameFolder.js
 ElectronClient/gui/MainScreen/commands/renameTag.js

.gitignore

@@ -75,6 +75,7 @@ ElectronClient/app.js
 ElectronClient/bridge.js
 ElectronClient/commands/copyDevCommand.js
 ElectronClient/commands/focusElement.js
+ElectronClient/commands/openProfileDirectory.js
 ElectronClient/commands/startExternalEditing.js
 ElectronClient/commands/stopExternalEditing.js
 ElectronClient/commands/toggleExternalEditing.js
@@ -98,7 +99,11 @@ ElectronClient/gui/MainScreen/commands/hideModalMessage.js
 ElectronClient/gui/MainScreen/commands/moveToFolder.js
 ElectronClient/gui/MainScreen/commands/newFolder.js
 ElectronClient/gui/MainScreen/commands/newNote.js
+ElectronClient/gui/MainScreen/commands/newSubFolder.js
 ElectronClient/gui/MainScreen/commands/newTodo.js
+ElectronClient/gui/MainScreen/commands/openFolder.js
+ElectronClient/gui/MainScreen/commands/openNote.js
+ElectronClient/gui/MainScreen/commands/openTag.js
 ElectronClient/gui/MainScreen/commands/print.js
 ElectronClient/gui/MainScreen/commands/renameFolder.js
 ElectronClient/gui/MainScreen/commands/renameTag.js

.ignore

@@ -24,6 +24,7 @@ ElectronClient/app.js
 ElectronClient/bridge.js
 ElectronClient/commands/copyDevCommand.js
 ElectronClient/commands/focusElement.js
+ElectronClient/commands/openProfileDirectory.js
 ElectronClient/commands/startExternalEditing.js
 ElectronClient/commands/stopExternalEditing.js
 ElectronClient/commands/toggleExternalEditing.js
@@ -47,7 +48,11 @@ ElectronClient/gui/MainScreen/commands/hideModalMessage.js
 ElectronClient/gui/MainScreen/commands/moveToFolder.js
 ElectronClient/gui/MainScreen/commands/newFolder.js
 ElectronClient/gui/MainScreen/commands/newNote.js
+ElectronClient/gui/MainScreen/commands/newSubFolder.js
 ElectronClient/gui/MainScreen/commands/newTodo.js
+ElectronClient/gui/MainScreen/commands/openFolder.js
+ElectronClient/gui/MainScreen/commands/openNote.js
+ElectronClient/gui/MainScreen/commands/openTag.js
 ElectronClient/gui/MainScreen/commands/print.js
 ElectronClient/gui/MainScreen/commands/renameFolder.js
 ElectronClient/gui/MainScreen/commands/renameTag.js

CliClient/.gitignore

@@ -22,4 +22,5 @@ yarn-error.log
 tests/support/dropbox-auth.txt
 tests/support/nextcloud-auth.json
 tests/support/onedrive-auth.txt
-build/
+build/
+patches/

CliClient/app/services/plugins/PluginRunner.ts

@@ -54,15 +54,25 @@ export default class PluginRunner extends BasePluginRunner {
 		};
 	}
 
-	async run(plugin:Plugin, sandbox:Global) {
-		const vmSandbox = vm.createContext(this.newSandboxProxy(plugin.id, sandbox));
+	async run(plugin:Plugin, sandbox:Global):Promise<void> {
+		return new Promise((resolve:Function, reject:Function) => {
+			const onStarted = () => {
+				plugin.off('started', onStarted);
+				resolve();
+			};
 
-		try {
-			vm.runInContext(plugin.scriptText, vmSandbox);
-		} catch (error) {
-			this.logger().error(`In plugin ${plugin.id}:`, error);
-			return;
-		}
+			plugin.on('started', onStarted);
+
+			const vmSandbox = vm.createContext(this.newSandboxProxy(plugin.id, sandbox));
+
+			try {
+				vm.runInContext(plugin.scriptText, vmSandbox);
+			} catch (error) {
+				reject(error);
+				// this.logger().error(`In plugin ${plugin.id}:`, error);
+				// return;
+			}
+		});
 	}
 
 }

CliClient/gulpfile.js

@@ -17,12 +17,23 @@ tasks.prepareBuild = {
 			excluded: ['node_modules'],
 		});
 		await utils.copyDir(`${__dirname}/locales-build`, `${buildDir}/locales`);
-		await utils.copyDir(`${__dirname}/../patches`, `${buildDir}/patches`);
 		await tasks.copyLib.fn();
 		await utils.copyFile(`${__dirname}/package.json`, `${buildDir}/package.json`);
 		await utils.copyFile(`${__dirname}/package-lock.json`, `${buildDir}/package-lock.json`);
 		await utils.copyFile(`${__dirname}/gulpfile.js`, `${buildDir}/gulpfile.js`);
 
+		// Import all the patches inside the CliClient directory
+		// and build file. Needs to be in CliClient dir for when running
+		// in dev mode, and in build dir for production.
+		const localPatchDir = `${buildDir}/patches`;
+		await fs.remove(localPatchDir);
+		await fs.mkdirp(localPatchDir);
+		await utils.copyDir(`${__dirname}/../patches/shared`, `${localPatchDir}`, { delete: false });
+		await utils.copyDir(`${__dirname}/../patches/node`, `${localPatchDir}`, { delete: false });
+
+		await fs.remove(`${__dirname}/patches`);
+		await utils.copyDir(`${localPatchDir}`, `${__dirname}/patches`);
+
 		const packageRaw = await fs.readFile(`${buildDir}/package.json`);
 		const package = JSON.parse(packageRaw.toString());
 		package.scripts.postinstall = 'patch-package';

CliClient/locales-build/index.js

@@ -38,42 +38,42 @@ locales['tr_TR'] = require('./tr_TR.json');
 locales['vi'] = require('./vi.json');
 locales['zh_CN'] = require('./zh_CN.json');
 locales['zh_TW'] = require('./zh_TW.json');
-stats['ar'] = {"percentDone":80};
-stats['eu'] = {"percentDone":34};
-stats['bs_BA'] = {"percentDone":83};
-stats['bg_BG'] = {"percentDone":66};
-stats['ca'] = {"percentDone":96};
+stats['ar'] = {"percentDone":79};
+stats['eu'] = {"percentDone":33};
+stats['bs_BA'] = {"percentDone":82};
+stats['bg_BG'] = {"percentDone":65};
+stats['ca'] = {"percentDone":95};
 stats['hr_HR'] = {"percentDone":27};
-stats['cs_CZ'] = {"percentDone":82};
-stats['da_DK'] = {"percentDone":74};
-stats['de_DE'] = {"percentDone":98};
-stats['et_EE'] = {"percentDone":66};
+stats['cs_CZ'] = {"percentDone":99};
+stats['da_DK'] = {"percentDone":73};
+stats['de_DE'] = {"percentDone":97};
+stats['et_EE'] = {"percentDone":65};
 stats['en_GB'] = {"percentDone":100};
 stats['en_US'] = {"percentDone":100};
-stats['es_ES'] = {"percentDone":95};
-stats['eo'] = {"percentDone":38};
-stats['fr_FR'] = {"percentDone":99};
-stats['gl_ES'] = {"percentDone":43};
-stats['id_ID'] = {"percentDone":93};
-stats['it_IT'] = {"percentDone":90};
-stats['nl_BE'] = {"percentDone":34};
-stats['nl_NL'] = {"percentDone":95};
-stats['nb_NO'] = {"percentDone":88};
-stats['fa'] = {"percentDone":83};
-stats['pl_PL'] = {"percentDone":98};
-stats['pt_PT'] = {"percentDone":88};
-stats['pt_BR'] = {"percentDone":96};
+stats['es_ES'] = {"percentDone":99};
+stats['eo'] = {"percentDone":37};
+stats['fr_FR'] = {"percentDone":98};
+stats['gl_ES'] = {"percentDone":42};
+stats['id_ID'] = {"percentDone":92};
+stats['it_IT'] = {"percentDone":98};
+stats['nl_BE'] = {"percentDone":33};
+stats['nl_NL'] = {"percentDone":94};
+stats['nb_NO'] = {"percentDone":87};
+stats['fa'] = {"percentDone":82};
+stats['pl_PL'] = {"percentDone":97};
+stats['pt_PT'] = {"percentDone":98};
+stats['pt_BR'] = {"percentDone":95};
 stats['ro'] = {"percentDone":77};
 stats['sl_SI'] = {"percentDone":42};
 stats['sv'] = {"percentDone":70};
 stats['th_TH'] = {"percentDone":52};
-stats['vi'] = {"percentDone":85};
-stats['tr_TR'] = {"percentDone":98};
-stats['el_GR'] = {"percentDone":96};
-stats['ru_RU'] = {"percentDone":95};
-stats['sr_RS'] = {"percentDone":71};
-stats['zh_CN'] = {"percentDone":96};
-stats['zh_TW'] = {"percentDone":95};
-stats['ja_JP'] = {"percentDone":98};
-stats['ko'] = {"percentDone":98};
+stats['vi'] = {"percentDone":84};
+stats['tr_TR'] = {"percentDone":97};
+stats['el_GR'] = {"percentDone":95};
+stats['ru_RU'] = {"percentDone":94};
+stats['sr_RS'] = {"percentDone":70};
+stats['zh_CN'] = {"percentDone":95};
+stats['zh_TW'] = {"percentDone":94};
+stats['ja_JP'] = {"percentDone":97};
+stats['ko'] = {"percentDone":99};
 module.exports = { locales: locales, stats: stats };

CliClient/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "joplin",
-  "version": "1.3.0",
+  "version": "1.3.3",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {
@@ -2964,9 +2964,9 @@
       "integrity": "sha1-k0EP0hsAlzUVH4howvJx80J+I/0="
     },
     "highlight.js": {
-      "version": "10.1.1",
-      "resolved": "https://registry.npmjs.org/highlight.js/-/highlight.js-10.1.1.tgz",
-      "integrity": "sha512-b4L09127uVa+9vkMgPpdUQP78ickGbHEQTWeBrQFTJZ4/n2aihWOGS0ZoUqAwjVmfjhq/C76HRzkqwZhK4sBbg=="
+      "version": "10.2.1",
+      "resolved": "https://registry.npmjs.org/highlight.js/-/highlight.js-10.2.1.tgz",
+      "integrity": "sha512-A+sckVPIb9zQTUydC9lpRX1qRFO/N0OKEh0NwIr65ckvWA/oMY8v9P3+kGRK3w2ULSh9E8v5MszXafodQ6039g=="
     },
     "homedir-polyfill": {
       "version": "1.0.3",
@@ -3227,6 +3227,11 @@
         "file-type": "^4.1.0"
       }
     },
+    "immer": {
+      "version": "7.0.14",
+      "resolved": "https://registry.npmjs.org/immer/-/immer-7.0.14.tgz",
+      "integrity": "sha512-BxCs6pJwhgSEUEOZjywW7OA8DXVzfHjkBelSEl0A+nEu0+zS4cFVdNOONvt55N4WOm8Pu4xqSPYxhm1Lv2iBBA=="
+    },
     "inflight": {
       "version": "1.0.6",
       "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz",

CliClient/package.json

@@ -6,7 +6,7 @@
   "scripts": {
     "test": "gulp buildTests -L && node node_modules/jasmine/bin/jasmine.js --fail-fast=true --config=tests/support/jasmine.json",
     "test-ci": "gulp buildTests -L && node node_modules/jasmine/bin/jasmine.js --config=tests/support/jasmine.json",
-    "postinstall": "npm run build && patch-package --patch-dir ../patches/shared && patch-package --patch-dir ../patches/node",
+    "postinstall": "npm run build && patch-package --patch-dir ./patches",
     "build": "gulp build",
     "start": "gulp build -L && node 'build/main.js' --stack-trace-enabled --log-level debug --env dev"
   },
@@ -28,7 +28,7 @@
     ],
     "owner": "Laurent Cozic"
   },
-  "version": "1.3.0",
+  "version": "1.3.3",
   "bin": {
     "joplin": "./main.js"
   },
@@ -52,12 +52,13 @@
     "font-awesome-filetypes": "^2.1.0",
     "form-data": "^2.1.4",
     "fs-extra": "^5.0.0",
-    "highlight.js": "10.1.1",
+    "highlight.js": "^10.2.1",
     "html-entities": "^1.2.1",
     "html-minifier": "^3.5.15",
     "htmlparser2": "^4.1.0",
     "image-data-uri": "^2.0.0",
     "image-type": "^3.0.0",
+    "immer": "^7.0.14",
     "joplin-turndown": "^4.0.29",
     "joplin-turndown-plugin-gfm": "^1.0.12",
     "json-stringify-safe": "^5.0.1",

CliClient/tests/EnexToHtml.js

@@ -3,6 +3,7 @@ require('app-module-path').addPath(__dirname);
 const { asyncTest, setupDatabaseAndSynchronizer, switchClient } = require('test-utils.js');
 const shim = require('lib/shim').default;
 const { enexXmlToHtml } = require('lib/import-enex-html-gen.js');
+const cleanHtml = require('clean-html');
 
 process.on('unhandledRejection', (reason, p) => {
 	console.warn('Unhandled Rejection at: Promise', p, 'reason:', reason);
@@ -19,6 +20,20 @@ const audioResource = {
 	title: 'audio test',
 };
 
+// All the test HTML files are beautified ones, so we need to run
+// this before the comparison. Before, beautifying was done by `enexXmlToHtml`
+// but that was removed due to problems with the clean-html package.
+const beautifyHtml = (html) => {
+	return new Promise((resolve) => {
+		try {
+			cleanHtml.clean(html, { wrap: 0 }, (...cleanedHtml) => resolve(cleanedHtml.join('')));
+		} catch (error) {
+			console.warn(`Could not clean HTML - the "unclean" version will be used: ${error.message}: ${html.trim().substr(0, 512).replace(/[\n\r]/g, ' ')}...`);
+			resolve([html].join(''));
+		}
+	});
+};
+
 /**
  * Tests the importer for a single note, checking that the result of
  * processing the given `.enex` input file matches the contents of the given
@@ -38,7 +53,7 @@ const compareOutputToExpected = (options) => {
 	it(testTitle, asyncTest(async () => {
 		const enexInput = await shim.fsDriver().readFile(inputFile);
 		const expectedOutput = await shim.fsDriver().readFile(outputFile);
-		const actualOutput = await enexXmlToHtml(enexInput, options.resources);
+		const actualOutput = await beautifyHtml(await enexXmlToHtml(enexInput, options.resources));
 
 		expect(actualOutput).toEqual(expectedOutput);
 	}));

CliClient/tests/enex_to_html/attachment.html

@@ -1,5 +1,5 @@
 <en-note>
-  <div><a href="joplin://21ca2b948f222a38802940ec7e2e5de3" hash="21ca2b948f222a38802940ec7e2e5de3" type="application/pdf" style="cursor:pointer;" alt="attachment-1">attachment-1</a></div>
+  <div><a href=":/21ca2b948f222a38802940ec7e2e5de3" hash="21ca2b948f222a38802940ec7e2e5de3" type="application/pdf" style="cursor:pointer;" alt="attachment-1">attachment-1</a></div>
   <div>
     <br>
   </div>

CliClient/tests/fsDriver.ts

@@ -1,14 +1,25 @@
 import FsDriverNode from 'lib/fs-driver-node';
+import shim from 'lib/shim';
 const { expectThrow } = require('test-utils.js');
 
+// On Windows, path.resolve is going to convert a path such as
+// /tmp/file.txt to c:\tmp\file.txt
+function platformPath(path:string) {
+	if (shim.isWindows()) {
+		return `C:${path.replace(/\//g, '\\')}`;
+	} else {
+		return path;
+	}
+}
+
 describe('fsDriver', function() {
 
 	it('should resolveRelativePathWithinDir', () => {
 		const fsDriver = new FsDriverNode();
-		expect(fsDriver.resolveRelativePathWithinDir('/test/temp', './my/file.txt')).toBe('/test/temp/my/file.txt');
-		expect(fsDriver.resolveRelativePathWithinDir('/', './test')).toBe('/test');
-		expect(fsDriver.resolveRelativePathWithinDir('/test', 'myfile.txt')).toBe('/test/myfile.txt');
-		expect(fsDriver.resolveRelativePathWithinDir('/test/temp', './mydir/../test.txt')).toBe('/test/temp/test.txt');
+		expect(fsDriver.resolveRelativePathWithinDir('/test/temp', './my/file.txt')).toBe(platformPath('/test/temp/my/file.txt'));
+		expect(fsDriver.resolveRelativePathWithinDir('/', './test')).toBe(platformPath('/test'));
+		expect(fsDriver.resolveRelativePathWithinDir('/test', 'myfile.txt')).toBe(platformPath('/test/myfile.txt'));
+		expect(fsDriver.resolveRelativePathWithinDir('/test/temp', './mydir/../test.txt')).toBe(platformPath('/test/temp/test.txt'));
 
 		expectThrow(() => fsDriver.resolveRelativePathWithinDir('/test/temp', '../myfile.txt'));
 		expectThrow(() => fsDriver.resolveRelativePathWithinDir('/test/temp', './mydir/../../test.txt'));

CliClient/tests/html_to_md/anchor_with_brackets.html

@@ -0,0 +1 @@
+<a href="https://images.macrumors.com/filters:quality(90)/article.html"/>testing</a>

CliClient/tests/html_to_md/anchor_with_brackets.md

@@ -0,0 +1 @@
+[testing](https://images.macrumors.com/filters:quality%2890%29/article.html)

CliClient/tests/models_BaseItem.js

@@ -104,4 +104,14 @@ describe('models_BaseItem', function() {
 
 		expect(noteAfter).toEqual(noteBefore);
 	}));
+
+	it('should serialize and unserialize properties that contain new lines', asyncTest(async () => {
+		const note = await Note.save({ title: 'note', source_url: '\nhttps://joplinapp.org/\n' });
+
+		const noteBefore = await Note.load(note.id);
+		const serialized = await Note.serialize(noteBefore);
+		const noteAfter = await Note.unserialize(serialized);
+
+		expect(noteAfter).toEqual(noteBefore);
+	}));
 });

CliClient/tests/services_PluginService.ts

@@ -2,12 +2,10 @@ import PluginRunner from '../app/services/plugins/PluginRunner';
 import PluginService from 'lib/services/plugins/PluginService';
 import { ContentScriptType } from 'lib/services/plugins/api/types';
 import MdToHtml from 'lib/joplin-renderer/MdToHtml';
-import Setting from 'lib/models/Setting';
 import shim from 'lib/shim';
-import uuid from 'lib/uuid';
 
 require('app-module-path').addPath(__dirname);
-const { asyncTest, setupDatabaseAndSynchronizer, switchClient, expectThrow } = require('test-utils.js');
+const { asyncTest, setupDatabaseAndSynchronizer, switchClient, expectThrow, createTempDir } = require('test-utils.js');
 const Note = require('lib/models/Note');
 const Folder = require('lib/models/Folder');
 
@@ -65,6 +63,9 @@ describe('services_PluginService', function() {
 
 		const allFolders = await Folder.all();
 		expect(allFolders.length).toBe(1);
+
+		// If you have an error here, it might mean you need to run `npm i` from
+		// the "withExternalModules" folder. Not clear exactly why.
 		expect(allFolders[0].title).toBe('  foo');
 	}));
 
@@ -154,12 +155,14 @@ describe('services_PluginService', function() {
 	}));
 
 	it('should register a Markdown-it plugin', asyncTest(async () => {
-		const contentScriptPath = `${Setting.value('tempDir')}/markdownItTestPlugin${uuid.createNano()}.js`;
+		const tempDir = await createTempDir();
+
+		const contentScriptPath = `${tempDir}/markdownItTestPlugin.js`;
 		await shim.fsDriver().copy(`${testPluginDir}/content_script/src/markdownItTestPlugin.js`, contentScriptPath);
 
 		const service = newPluginService();
 
-		const plugin = await service.loadPluginFromString('example', Setting.value('tempDir'), `
+		const plugin = await service.loadPluginFromString('example', tempDir, `
 			/* joplin-manifest:
 			{
 				"manifest_version": 1,
@@ -173,7 +176,7 @@ describe('services_PluginService', function() {
 			
 			joplin.plugins.register({
 				onStart: async function() {
-					await joplin.plugins.registerContentScript('markdownItPlugin', 'justtesting', '${contentScriptPath}');
+					await joplin.plugins.registerContentScript('markdownItPlugin', 'justtesting', './markdownItTestPlugin.js');
 				},
 			});
 		`);
@@ -198,7 +201,7 @@ describe('services_PluginService', function() {
 
 		expect(result.html.includes('JUST TESTING: something')).toBe(true);
 
-		await shim.fsDriver().remove(contentScriptPath);
+		await shim.fsDriver().remove(tempDir);
 	}));
 
 });

CliClient/tests/services_rest_Api.ts

@@ -183,6 +183,59 @@ describe('services_rest_Api', function() {
 
 		expect(response.user_updated_time).toBe(updatedTime);
 		expect(response.user_created_time).toBe(createdTime);
+
+		const timeBefore = Date.now();
+
+		response = await api.route('POST', 'notes', null, JSON.stringify({
+			parent_id: f.id,
+		}));
+
+		const newNote = await Note.load(response.id);
+		expect(newNote.user_updated_time).toBeGreaterThanOrEqual(timeBefore);
+		expect(newNote.user_created_time).toBeGreaterThanOrEqual(timeBefore);
+	}));
+
+	it('should preserve user timestamps when updating notes', asyncTest(async () => {
+		const folder = await Folder.save({ title: 'mon carnet' });
+
+		const updatedTime = Date.now() - 1000;
+		const createdTime = Date.now() - 10000;
+
+		const response = await api.route('POST', 'notes', null, JSON.stringify({
+			parent_id: folder.id,
+		}));
+
+		const noteId = response.id;
+
+		{
+			// Check that if user timestamps are supplied, they are preserved by the API
+
+			await api.route('PUT', `notes/${noteId}`, null, JSON.stringify({
+				user_updated_time: updatedTime,
+				user_created_time: createdTime,
+				title: 'mod',
+			}));
+
+			const modNote = await Note.load(noteId);
+			expect(modNote.title).toBe('mod');
+			expect(modNote.user_updated_time).toBe(updatedTime);
+			expect(modNote.user_created_time).toBe(createdTime);
+		}
+
+		{
+			// Check if no user timestamps are supplied they are automatically updated.
+
+			const beforeTime = Date.now();
+
+			await api.route('PUT', `notes/${noteId}`, null, JSON.stringify({
+				title: 'mod2',
+			}));
+
+			const modNote = await Note.load(noteId);
+			expect(modNote.title).toBe('mod2');
+			expect(modNote.user_updated_time).toBeGreaterThanOrEqual(beforeTime);
+			expect(modNote.user_created_time).toBeGreaterThanOrEqual(createdTime);
+		}
 	}));
 
 	it('should create notes with supplied ID', asyncTest(async () => {

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

@@ -27,10 +27,10 @@ export default class JoplinCommands {
      *
      * // Create a new sub-notebook under the provided notebook
      * // Note: internally, notebooks are called "folders".
-     * await joplin.commands.execute('newFolder', { parent_id: "SOME_FOLDER_ID" });
+     * await joplin.commands.execute('newFolder', "SOME_FOLDER_ID");
      * ```
      */
-    execute(commandName: string, props?: any): Promise<any>;
+    execute(commandName: string, ...args: any[]): Promise<any | void>;
     /**
      * <span class="platform-desktop">desktop</span> Registers a new command.
      *

CliClient/tests/support/plugins/content_script/api/JoplinPlugins.d.ts

@@ -1,6 +1,6 @@
 import Plugin from '../Plugin';
 import Logger from 'lib/Logger';
-import { Script } from './types';
+import { ContentScriptType, Script } from './types';
 /**
  * This class provides access to plugin-related features.
  */
@@ -21,4 +21,18 @@ export default class JoplinPlugins {
      * ```
      */
     register(script: Script): Promise<void>;
+    /**
+     * Registers a new content script. Unlike regular plugin code, which runs in a separate process, content scripts run within the main process code
+     * and thus allow improved performances and more customisations in specific cases. It can be used for example to load a Markdown or editor plugin.
+     *
+     * Note that registering a content script in itself will do nothing - it will only be loaded in specific cases by the relevant app modules
+     * (eg. the Markdown renderer or the code editor). So it is not a way to inject and run arbitrary code in the app, which for safety and performance reasons is not supported.
+     *
+     * [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/content_script)
+     *
+     * @param type Defines how the script will be used. See the type definition for more information about each supported type.
+     * @param id A unique ID for the content script.
+     * @param scriptPath Must be a path relative to the plugin main script. For example, if your file content_script.js is next to your index.ts file, you would set `scriptPath` to `"./content_script.js`.
+     */
+    registerContentScript(type: ContentScriptType, id: string, scriptPath: string): Promise<void>;
 }

CliClient/tests/support/plugins/content_script/api/types.ts

@@ -3,12 +3,50 @@
 // =================================================================
 
 export interface Command {
+	/**
+	 * Name of command - must be globally unique
+	 */
 	name: string
-	label: 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,
-	execute(props:any):Promise<any>
-	isEnabled?(props:any):boolean
-	mapStateToProps?(state:any):any
+
+	/**
+	 * 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"
+	 *
+	 * Currently the supported context variables aren't documented, but you can find the list there:
+	 *
+	 * https://github.com/laurent22/joplin/blob/dev/ReactNativeClient/lib/services/commands/stateToWhenClauseContext.ts
+	 *
+	 * Note: Commands are enabled by default unless you use this property.
+	 */
+	enabledCondition?: string
 }
 
 // =================================================================
@@ -277,3 +315,54 @@ export interface SettingSection {
  * [2]: (Optional) Resource link.
  */
 export type Path = string[];
+
+// =================================================================
+// Plugins type
+// =================================================================
+
+export enum ContentScriptType {
+	/**
+	 * Registers a new Markdown-It plugin, which should follow this template:
+	 *
+	 * ```javascript
+	 * // The module should export an object as below:
+	 *
+	 * module.exports = {
+	 *
+	 *     // The "context" variable 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.
+	 *     default: function(context) {
+	 *         return {
+	 *
+	 *             // This 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/ReactNativeClient/lib/joplin-renderer/MdToHtml.ts), which
+	 *             // contains a number of options, mostly useful for Joplin's internal code.
+	 *             plugin: function(markdownIt, options) {
+	 *                 // ...
+	 *             },
+	 *
+	 *             // You may also specify additional 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/ReactNativeClient/lib/joplin-renderer/MdToHtml/rules/mermaid.ts) to
+	 *             // see how the data should be structured.
+	 *             assets: {},
+	 *         }
+	 *     }
+	 * }
+	 * ```
+	 *
+	 * To include a regular Markdown-It plugin, that doesn't make use of any Joplin-specific feature, 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',
+	CodeMirrorPlugin = 'codeMirrorPlugin',
+}

CliClient/tests/support/plugins/content_script/src/index.ts

@@ -1,7 +1,12 @@
 import joplin from 'api';
+import { ContentScriptType } from 'api/types';
 
 joplin.plugins.register({
 	onStart: async function() {
-		await (joplin.plugins as any).registerContentScript('markdownItPlugin', 'justtesting', './markdownItTestPlugin.js');
+		await joplin.plugins.registerContentScript(
+			ContentScriptType.MarkdownItPlugin,
+			'justtesting',
+			'./markdownItTestPlugin.js'
+		);
 	},
 });

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

@@ -3,7 +3,7 @@ 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/CliClient/tests/support/plugins/register_command)
+ * [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/register_command)
  *
  * ## Executing Joplin's internal commands
  *
@@ -27,10 +27,10 @@ export default class JoplinCommands {
      *
      * // Create a new sub-notebook under the provided notebook
      * // Note: internally, notebooks are called "folders".
-     * await joplin.commands.execute('newFolder', { parent_id: "SOME_FOLDER_ID" });
+     * await joplin.commands.execute('newFolder', "SOME_FOLDER_ID");
      * ```
      */
-    execute(commandName: string, props?: any): Promise<any>;
+    execute(commandName: string, ...args: any[]): Promise<any | void>;
     /**
      * <span class="platform-desktop">desktop</span> Registers a new command.
      *

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

@@ -1,12 +1,12 @@
 import { Path } from './types';
 /**
- * This module provides access to the Joplin data API: https://joplinapp.org/api/
+ * 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/CliClient/tests/support/plugins/simple)
+ * [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/simple)
  *
  * In general you would use the methods in this class as if you were using a REST API. There are four methods that map to GET, POST, PUT and DELETE calls.
  * And each method takes these parameters:
@@ -16,7 +16,7 @@ import { Path } from './types';
  * * `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/) 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.
+ * 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:
  *

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

@@ -2,14 +2,14 @@ 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/CliClient/tests/support/plugins/json_export)
+ * [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/json_export)
  *
  * To implement an import or export module, you would simply define an object with various event handlers that are called
  * by the application during the import/export process.
  *
  * See the documentation of the [[ExportModule]] and [[ImportModule]] for more information.
  *
- * You may also want to refer to the Joplin API documentation to see the list of properties for each item (note, notebook, etc.) - https://joplinapp.org/api/
+ * 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>;

CliClient/tests/support/plugins/dialog/api/JoplinPlugins.d.ts

@@ -1,6 +1,6 @@
 import Plugin from '../Plugin';
 import Logger from 'lib/Logger';
-import { Script } from './types';
+import { ContentScriptType, Script } from './types';
 /**
  * This class provides access to plugin-related features.
  */
@@ -21,4 +21,18 @@ export default class JoplinPlugins {
      * ```
      */
     register(script: Script): Promise<void>;
+    /**
+     * Registers a new content script. Unlike regular plugin code, which runs in a separate process, content scripts run within the main process code
+     * and thus allow improved performances and more customisations in specific cases. It can be used for example to load a Markdown or editor plugin.
+     *
+     * Note that registering a content script in itself will do nothing - it will only be loaded in specific cases by the relevant app modules
+     * (eg. the Markdown renderer or the code editor). So it is not a way to inject and run arbitrary code in the app, which for safety and performance reasons is not supported.
+     *
+     * [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/CliClient/tests/support/plugins/content_script)
+     *
+     * @param type Defines how the script will be used. See the type definition for more information about each supported type.
+     * @param id A unique ID for the content script.
+     * @param scriptPath Must be a path relative to the plugin main script. For example, if your file content_script.js is next to your index.ts file, you would set `scriptPath` to `"./content_script.js`.
+     */
+    registerContentScript(type: ContentScriptType, id: string, scriptPath: string): Promise<void>;
 }