self-hosted/joplin
1
0
Fork 0
mirror of https://github.com/laurent22/joplin.git synced 2025-01-11 18:24:43 +02:00
Code Issues Releases Activity

Chore: Updated plugin types

Browse Source
This commit is contained in:
Laurent Cozic 2022-04-20 16:30:28 +01:00
parent fc095986b0
commit 373cd805dc
4 changed files with 24 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
packages/generator-joplin/generators/app/templates/api/JoplinCommands.d.ts vendored
View File

@ -15,7 +15,7 @@ import { Command } from './types';
* *
* * [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/MainScreen/commands)
* * [Global commands](https://github.com/laurent22/joplin/tree/dev/packages/app-desktop/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/commands/editorCommandDeclarations.ts) * * [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 * To view what arguments are supported, you can open any of these files
* and look at the `execute()` command. * and look at the `execute()` command.

9
packages/generator-joplin/generators/app/templates/api/JoplinWorkspace.d.ts vendored
View File

@ -16,8 +16,12 @@ interface ItemChangeEvent {
interface SyncStartEvent { interface SyncStartEvent {
withErrors: boolean; withErrors: boolean;
} }
interface ResourceChangeEvent {
id: string;
}
declare type ItemChangeHandler = (event: ItemChangeEvent)=> void; declare type ItemChangeHandler = (event: ItemChangeEvent)=> void;
declare type SyncStartHandler = (event: SyncStartEvent)=> 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 * 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 * are being worked on - i.e. the currently selected notes or notebooks as
@ -42,6 +46,11 @@ export default class JoplinWorkspace {
* Called when the content of the current note changes. * Called when the content of the current note changes.
*/ */
onNoteChange(handler: ItemChangeHandler): Promise<Disposable>; 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. * Called when an alarm associated with a to-do is triggered.
*/ */

14
packages/generator-joplin/generators/app/templates/api/types.ts
View File

@ -297,7 +297,7 @@ export interface MenuItem {
/** /**
* Set to "separator" to create a divider line * Set to "separator" to create a divider line
*/ */
type?: string; type?: ('normal' | 'separator' | 'submenu' | 'checkbox' | 'radio');
/** /**
* Accelerator associated with the menu item * Accelerator associated with the menu item
@ -364,6 +364,12 @@ export enum SettingItemType {
Button = 6, 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 { export enum AppType {
Desktop = 'desktop', Desktop = 'desktop',
Mobile = 'mobile', Mobile = 'mobile',
@ -381,6 +387,12 @@ export interface SettingItem {
value: any; value: any;
type: SettingItemType; 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; label: string;
description?: string; description?: string;

2
packages/generator-joplin/updateTypes.sh
View File

@ -8,7 +8,7 @@ cd "$LIB_DIR"
yarn run generatePluginTypes yarn run generatePluginTypes
cd "$SCRIPT_DIR" cd "$SCRIPT_DIR"
rsync -a --delete "$LIB_DIR/plugin_types/services/plugins/api/" "$SCRIPT_DIR/generators/app/templates/api/" rsync -a --delete "$LIB_DIR/plugin_types/lib/services/plugins/api/" "$SCRIPT_DIR/generators/app/templates/api/"
cp "$LIB_DIR/services/plugins/api/types.ts" "$SCRIPT_DIR/generators/app/templates/api/" cp "$LIB_DIR/services/plugins/api/types.ts" "$SCRIPT_DIR/generators/app/templates/api/"
cp "$SCRIPT_DIR/generators/app/templates/api_index.ts" "$SCRIPT_DIR/generators/app/templates/api/index.ts" cp "$SCRIPT_DIR/generators/app/templates/api_index.ts" "$SCRIPT_DIR/generators/app/templates/api/index.ts"
rm -f "$SCRIPT_DIR/generators/app/templates/api/types.d.ts" rm -f "$SCRIPT_DIR/generators/app/templates/api/types.d.ts"