code v1.2.4: Add invalid format error to secureview

* Added screenshot files.
* Added invalid format error to secureview.

Author: cipherswami

api/JoplinClipboard.d.ts

@@ -1,3 +1,4 @@
+import { ClipboardContent } from './types';
 export default class JoplinClipboard {
     private electronClipboard_;
     private electronNativeImage_;
@@ -26,4 +27,19 @@ export default class JoplinClipboard {
      * For example [ 'text/plain', 'text/html' ]
      */
     availableFormats(): Promise<string[]>;
+    /**
+     * Writes multiple formats to the clipboard simultaneously.
+     * This allows setting both text/plain and text/html at the same time.
+     *
+     * <span class="platform-desktop">desktop</span>
+     *
+     * @example
+     * ```typescript
+     * await joplin.clipboard.write({
+     *   text: 'Plain text version',
+     *   html: '<strong>HTML version</strong>'
+     * });
+     * ```
+     */
+    write(content: ClipboardContent): Promise<void>;
 }

api/JoplinCommands.d.ts

@@ -14,7 +14,7 @@ import Plugin from '../Plugin';
  * 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)
+ * * [Main screen commands](https://github.com/laurent22/joplin/tree/dev/packages/app-desktop/gui/WindowCommandsAndDialogs/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)
  *
@@ -25,8 +25,13 @@ import Plugin from '../Plugin';
  * commands can be found in these places:
  *
  * * [Global commands](https://github.com/laurent22/joplin/tree/dev/packages/app-mobile/commands)
+ * * [Note screen commands](https://github.com/laurent22/joplin/tree/dev/packages/app-mobile/components/screens/Note/commands)
  * * [Editor commands](https://github.com/laurent22/joplin/blob/dev/packages/app-mobile/components/NoteEditor/commandDeclarations.ts)
  *
+ * Additionally, certain global commands have the same implementation on both platforms:
+ *
+ * * [Shared global commands](https://github.com/laurent22/joplin/tree/dev/packages/lib/commands)
+ *
  * ## Executing editor commands
  *
  * There might be a situation where you want to invoke editor commands

api/JoplinSettings.d.ts

@@ -42,9 +42,11 @@ export default class JoplinSettings {
      */
     values(keys: string[] | string): Promise<Record<string, unknown>>;
     /**
-     * @deprecated Use joplin.settings.values()
+     * Gets a setting value (only applies to setting you registered from your plugin).
      *
-     * Gets a setting value (only applies to setting you registered from your plugin)
+     * Note: If you want to retrieve all your plugin settings, for example when the plugin starts,
+     * it is recommended to use the `values()` function instead - it will be much faster than
+     * calling `value()` multiple times.
      */
     value(key: string): Promise<any>;
     /**

api/JoplinViews.d.ts

@@ -9,8 +9,17 @@ import JoplinViewsEditors from './JoplinViewsEditor';
 /**
  * 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.
+ * ## Creating a view
+ *
+ * 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.
+ *
+ * ## The `webviewApi` object
+ *
+ * Within a view, you can use the global object `webviewApi` for various utility functions, such as
+ * sending messages or displaying context menu. Refer to [[WebviewApi]] for the full documentation.
  */
 export default class JoplinViews {
     private store;

api/JoplinViewsEditor.d.ts

@@ -1,5 +1,18 @@
 import Plugin from '../Plugin';
-import { ActivationCheckCallback, ViewHandle, UpdateCallback } from './types';
+import { ActivationCheckCallback, ViewHandle, UpdateCallback, EditorPluginCallbacks } from './types';
+interface SaveNoteOptions {
+    /**
+     * The ID of the note to save. This should match either:
+     * - The ID of the note currently being edited
+     * - The ID of a note that was very recently open in the editor.
+     *
+     * This property is present to ensure that the note editor doesn't write
+     * to the wrong note just after switching notes.
+     */
+    noteId: string;
+    /** The note's new content. */
+    body: string;
+}
 /**
  * Allows creating alternative note editors. You can create a view to handle loading and saving the
  * note, and do your own rendering.
@@ -41,10 +54,18 @@ export default class JoplinViewsEditors {
     private store;
     private plugin;
     private activationCheckHandlers_;
+    private unhandledActivationCheck_;
     constructor(plugin: Plugin, store: any);
     private controller;
+    /**
+     * Registers a new editor plugin. Joplin will call the provided callback to create new editor views
+     * associated with the plugin as necessary (e.g. when a new editor is created in a new window).
+     */
+    register(viewId: string, callbacks: EditorPluginCallbacks): Promise<void>;
     /**
      * Creates a new editor view
+     *
+     * @deprecated
      */
     create(id: string): Promise<ViewHandle>;
     /**
@@ -59,11 +80,18 @@ export default class JoplinViewsEditors {
      * See [[JoplinViewPanels]]
      */
     onMessage(handle: ViewHandle, callback: Function): Promise<void>;
+    /**
+     * Saves the content of the editor, without calling `onUpdate` for editors in the same window.
+     */
+    saveNote(handle: ViewHandle, props: SaveNoteOptions): Promise<void>;
     /**
      * Emitted when the editor can potentially be activated - this is for example when the current
      * note is changed, or when the application is opened. At that point you should check the
      * current note and decide whether your editor should be activated or not. If it should, return
      * `true`, otherwise return `false`.
+     *
+     * @deprecated - `onActivationCheck` should be provided when the editor is first created with
+     * 	`editor.register`.
      */
     onActivationCheck(handle: ViewHandle, callback: ActivationCheckCallback): Promise<void>;
     /**
@@ -86,3 +114,4 @@ export default class JoplinViewsEditors {
      */
     isVisible(handle: ViewHandle): Promise<boolean>;
 }
+export {};

api/JoplinViewsPanels.d.ts

@@ -80,5 +80,9 @@ export default class JoplinViewsPanels {
      * Tells whether the panel is visible or not
      */
     visible(handle: ViewHandle): Promise<boolean>;
+    /**
+     * Assuming that the current panel is an editor plugin view, returns
+     * whether the editor plugin view supports editing the current note.
+     */
     isActive(handle: ViewHandle): Promise<boolean>;
 }

api/JoplinWorkspace.d.ts

@@ -80,6 +80,8 @@ export default class JoplinWorkspace {
     filterEditorContextMenu(handler: FilterHandler<EditContextMenuFilterObject>): void;
     /**
      * Gets the currently selected note. Will be `null` if no note is selected.
+     *
+     * On desktop, this returns the selected note in the focused window.
      */
     selectedNote(): Promise<any>;
     /**
@@ -93,5 +95,12 @@ export default class JoplinWorkspace {
      * 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[]>;
+    /**
+     * Gets the last hash (note section ID) from cross-note link targeting specific section.
+     * New hash is available after `onNoteSelectionChange()` is triggered.
+     * Example of cross-note link where `hello-world` is a hash: [Other Note Title](:/9bc9a5cb83f04554bf3fd3e41b4bb415#hello-world).
+     * Method returns empty value when a note was navigated with method other than cross-note link containing valid hash.
+     */
+    selectedNoteHash(): Promise<string>;
 }
 export {};

api/types.ts

@@ -397,9 +397,40 @@ export interface Rectangle {
 	height?: number;
 }
 
-export type ActivationCheckCallback = ()=> Promise<boolean>;
+export interface EditorUpdateEvent {
+	newBody: string;
+	noteId: string;
+}
+export type UpdateCallback = (event: EditorUpdateEvent)=> Promise<void>;
+
 
-export type UpdateCallback = ()=> Promise<void>;
+export interface ActivationCheckEvent {
+	handle: ViewHandle;
+	noteId: string;
+}
+export type ActivationCheckCallback = (event: ActivationCheckEvent)=> Promise<boolean>;
+
+/**
+ * Required callbacks for creating an editor plugin.
+ */
+export interface EditorPluginCallbacks {
+	/**
+	 * Emitted when the editor can potentially be activated - this is for example when the current
+	 * note is changed, or when the application is opened. At that point you should check the
+	 * current note and decide whether your editor should be activated or not. If it should, return
+	 * `true`, otherwise return `false`.
+	 */
+	onActivationCheck: ActivationCheckCallback;
+
+	/**
+	 * Emitted when an editor view is created. This happens, for example, when a new window containing
+	 * a new editor is created.
+	 *
+	 * This callback should set the editor plugin's HTML using `editors.setHtml`, add scripts to the editor
+	 * with `editors.addScript`, and optionally listen for external changes using `editors.onUpdate`.
+	 */
+	onSetup: (handle: ViewHandle)=> Promise<void>;
+}
 
 export type VisibleHandler = ()=> Promise<void>;
 
@@ -408,6 +439,8 @@ export interface EditContextMenuFilterObject {
 }
 
 export interface EditorActivationCheckFilterObject {
+	effectiveNoteId: string;
+	windowId: string;
 	activatedEditors: {
 		pluginId: string;
 		viewId: string;
@@ -417,6 +450,20 @@ export interface EditorActivationCheckFilterObject {
 
 export type FilterHandler<T> = (object: T)=> Promise<T>;
 
+export type CommandArgument = string|number|object|boolean|null;
+
+export interface MenuTemplateItem {
+	label?: string;
+	command?: string;
+	commandArgs?: CommandArgument[];
+}
+
+export interface WebviewApi {
+	postMessage: (message: object)=> unknown;
+	onMessage: (message: object)=> void;
+	menuPopupFromTemplate: (template: MenuTemplateItem[])=> void;
+}
+
 // =================================================================
 // Settings types
 // =================================================================
@@ -541,6 +588,30 @@ export interface SettingSection {
  */
 export type Path = string[];
 
+// =================================================================
+// Clipboard API types
+// =================================================================
+
+/**
+ * Represents content that can be written to the clipboard in multiple formats.
+ */
+export interface ClipboardContent {
+	/**
+	 * Plain text representation of the content
+	 */
+	text?: string;
+
+	/**
+	 * HTML representation of the content
+	 */
+	html?: string;
+
+	/**
+	 * Image in [data URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs) format
+	 */
+	image?: string;
+}
+
 // =================================================================
 // Content Script types
 // =================================================================