orgnote-api 0.2.1 → 0.3.0

package/README.org

@@ -30,6 +30,8 @@ You can find all available methods here. They are currently undocumented.
 
 
 * Connected links
+- [[https://github.com/Artawower/orgnote-client/tree/master/src/components/extensions][Built-in extensions]]
+- [[https://github.com/Artawower/orgnote-api/blob/master/src/api.ts#L24][Type definition for existing extension API]]
 - [[https://github.com/artawower/orgnote][OrgNote entrypoint]]
 - [[https://org-note.com/][Official website]]
 - [[https://github.com/Artawower/orgnote-client][Org Note client]]
@@ -51,6 +53,8 @@ interface Extension {
 }
 #+END_SRC
 
+You can find available methods of =OrgNoteApi= [[https://github.com/Artawower/orgnote-api/blob/master/src/api.ts#L24][here]]
+
 ** Extension manifest
 Also, each extension should export manifest const:
 #+BEGIN_SRC typescript
@@ -65,7 +69,7 @@ interface ExtensionManifest {
   description?: string;
   keywords?: string[];
   // Repository url
-  sourceType: 'git' | 'file';
+  sourceType: 'git' | 'file' | 'builtin';
   /* Default value is README.org */
   readmeFilePath?: string;
   /* WIP */
@@ -77,6 +81,7 @@ interface ExtensionManifest {
   icon?: string;
 }
 #+END_SRC
+** Extension API
 * Publish to official repository
 OrgNote has an official [[https://github.com/Artawower/orgnote-extensions][repository]] for user-based extensions. You can easily add new =recipes/<package>.json=
 with =ExtensionManifest=

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';
@@ -67,10 +68,11 @@ export interface OrgNoteApi {
     add(...commands: Command[]): void;
     remove(...commands: Command[]): void;
     get(name: string): Command;
-    addCommandToSidebar(...commands: Command[]): void;
-    removeCommandFromSidebar(...commands: Command[]): void;
-    addCommandToEditorPanel(...commands: Command[]): void;
-    removeCommandFromEditorPanel(...commands: Command[]): void;
+    getAll(): Command[];
+    addCommandToSidebar(...commands: CommandPreview[]): void;
+    removeCommandFromSidebar(...commands: CommandPreview[]): void;
+    addCommandToEditorPanel(...commands: CommandPreview[]): void;
+    removeCommandFromEditorPanel(...commands: CommandPreview[]): void;
   };
   configuration: () => OrgNoteConfig;
 }

package/models/command.ts

@@ -8,26 +8,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;
   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/package.json

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