orgnote-api 0.3.0 → 0.4.1

package/models/command.ts

@@ -1,3 +1,5 @@
+import { DefaultCommands } from './default-commands';
+
 export const DEFAULT_KEYBINDING_GROUP = 'default';
 
 export type CommandGroup =
@@ -16,7 +18,7 @@ export interface CommandHandlerParams<T = any> {
 
 export interface CommandPreview {
   description?: string;
-  command?: string;
+  command?: DefaultCommands | string;
   title?: string | (() => string);
   icon?: string | (() => string);
 }

package/models/default-commands.ts

@@ -0,0 +1,31 @@
+/*
+ * 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',
+  SELECT_THEME = 'select theme',
+}

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.3.0",
+  "version": "0.4.1",
   "description": "Official API for creating extensions for OrgNote app",
   "type": "module",
   "main": "./index.ts",