orgnote-api 0.2.2 → 0.4.0

package/api.ts

@@ -7,6 +7,7 @@ import {
   MultilineEmbeddedWidget,
   OrgLineClass,
   WidgetBuilder,
+  CommandPreview,
 } from './models';
 import type { NavigationFailure } from 'vue-router';
 import { WidgetType } from './models/widget-type';
@@ -68,10 +69,10 @@ export interface OrgNoteApi {
     remove(...commands: Command[]): void;
     get(name: string): Command;
     getAll(): Command[];
-    addCommandToSidebar(...commands: Command[]): void;
-    removeCommandFromSidebar(...commands: Command[]): void;
-    addCommandToEditorPanel(...commands: Command[]): void;
-    removeCommandFromEditorPanel(...commands: Command[]): void;
+    addCommandToSidebar(...commands: CommandPreview[]): void;
+    removeCommandFromSidebar(...commands: CommandPreview[]): void;
+    addCommandToEditorPanel(...commands: CommandPreview[]): void;
+    removeCommandFromEditorPanel(...commands: CommandPreview[]): void;
   };
   configuration: () => OrgNoteConfig;
 }

package/models/command.ts

@@ -1,3 +1,5 @@
+import { DefaultCommands } from './default-commands';
+
 export const DEFAULT_KEYBINDING_GROUP = 'default';
 
 export type CommandGroup =
@@ -8,26 +10,35 @@ export type CommandGroup =
   | 'completion'
   | string;
 
-export interface CommandHandlerParams {
+export interface CommandHandlerParams<T = any> {
   event?: KeyboardEvent;
-  data?: unknown;
+  data?: T;
   [key: string]: unknown;
 }
 
-export interface Command {
-  // TODO: add support for multiple key sequences
-  keySequence?: string | string[];
+export interface CommandPreview {
   description?: string;
-  command?: string;
+  command?: DefaultCommands | string;
   title?: string | (() => string);
   icon?: string | (() => string);
+}
+
+export interface CommandMeta<T = any> extends Partial<CommandPreview> {
+  // TODO: add support for multiple key sequences
+  keySequence?: string | string[];
   /* Where is this command available, default value is global */
   group?: CommandGroup;
   allowOnInput?: boolean;
   ignorePrompt?: boolean;
-
   /* When command is system command, it will not be shown for users */
   system?: boolean;
+  available?: () => boolean;
+  context?: {
+    [key: string]: T;
+  };
+}
+
+export interface Command<T = any> extends CommandMeta<T> {
   /* arguments depend on the current scope */
   handler: (params?: CommandHandlerParams) => unknown | Promise<unknown>;
 }

package/models/default-commands.ts

@@ -0,0 +1,30 @@
+/*
+ * This are default commands. It's not a complete list
+ * Some of the commands are dynamically generated or
+ * can be added by user extensions.
+ */
+export enum DefaultCommands {
+  // Global commands
+  REPORT_BUG = 'report bug',
+  OPEN_DEBUG_INFO = 'open debug info',
+  SHOW_LOGS = 'show logs',
+  TOGGLE_SIDEBAR = 'toggle sidebar',
+  TOGGLE_FILE_MANAGER = 'toggle file manager',
+  CREATE_NOTE = 'create note',
+  PROJECT_INFO = 'project info',
+
+  // Completion commands
+  SEARCH = 'search',
+  TOGGLE_COMMANDS = 'toggle commands',
+  RESTORE_COMPLETION = 'restore last completion',
+  EXIT_COMMAND_EXECUTOR = 'exit command executor',
+  NEXT_CANDIDATE = 'next candidate',
+  PREV_CANDIDATE = 'previous candidate',
+  EXECUTE_CANDIDATE = 'execute candidate',
+
+  // Settings
+  SETTINGS = 'settings',
+  RESET_THEME = 'reset theme',
+  TOGGLE_DARK_MODE = 'toggle dark mode',
+  TOGGLE_DEBUG_MODE = 'toggle debug mode',
+}

package/models/index.ts

@@ -7,3 +7,4 @@ export * from './widget';
 export * from './modal';
 export * from './widget-type';
 export * from './editor';
+export * from './default-commands';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "orgnote-api",
-  "version": "0.2.2",
+  "version": "0.4.0",
   "description": "Official API for creating extensions for OrgNote app",
   "type": "module",
   "main": "./index.ts",