feat: Initial clean release of CHM

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

@@ -0,0 +1,92 @@
+/* eslint-disable multiline-comment-style */
+
+import Plugin from '../Plugin';
+import Logger from '@joplin/utils/Logger';
+import { ContentScriptType, Script } from './types';
+
+const logger = Logger.create('joplin.plugins');
+
+/**
+ * This class provides access to plugin-related features.
+ */
+export default class JoplinPlugins {
+
+	private plugin: Plugin;
+
+	public constructor(plugin: Plugin) {
+		this.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
+	 *     }
+	 * });
+	 * ```
+	 */
+	public async register(script: Script) {
+		if (script.onStart) {
+			const startTime = Date.now();
+
+			logger.info(`Starting plugin: ${this.plugin.id}`);
+
+			// We don't use `await` when calling onStart because the plugin might be awaiting
+			// in that call too (for example, when opening a dialog on startup) so we don't
+			// want to get stuck here.
+			// eslint-disable-next-line promise/prefer-await-to-then -- Old code before rule was applied
+			void script.onStart({}).catch((error: { message: string; stack?: string }) => {
+				// For some reason, error thrown from the executed script do not have the type "Error"
+				// but are instead plain object. So recreate the Error object here so that it can
+				// be handled correctly by loggers, etc.
+				const newError: Error = new Error(error.message);
+				newError.stack = error.stack;
+				logger.error(`Uncaught exception in plugin "${this.plugin.id}":`, newError);
+				// eslint-disable-next-line promise/prefer-await-to-then -- Old code before rule was applied
+			}).then(() => {
+				logger.info(`Finished running onStart handler: ${this.plugin.id} (Took ${Date.now() - startTime}ms)`);
+				this.plugin.emit('started');
+			});
+		}
+	}
+
+	/**
+	 * @deprecated Use joplin.contentScripts.register()
+	 */
+	public async registerContentScript(type: ContentScriptType, id: string, scriptPath: string) {
+		this.plugin.deprecationNotice('1.8', 'joplin.plugins.registerContentScript() is deprecated in favour of joplin.contentScripts.register()', true);
+		return this.plugin.registerContentScript(type, id, scriptPath);
+	}
+
+	/**
+	 * Gets the plugin own data directory path. Use this to store any
+	 * plugin-related data. Unlike [[installationDir]], any data stored here
+	 * will be persisted.
+	 */
+	public async dataDir(): Promise<string> {
+		return this.plugin.createAndGetDataDir();
+	}
+
+	/**
+	 * 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]].
+	 */
+	public async installationDir(): Promise<string> {
+		return this.plugin.baseDir;
+	}
+
+	/**
+	 * @deprecated Use joplin.require()
+	 */
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Plugin API: returns whatever native module the plugin requires; concretely replaced inside the sandbox
+	public require(_path: string): any {
+		// Just a stub. Implementation has to be done within plugin process, in plugin_index.js
+	}
+
+}