orgnote-api 0.41.6 → 0.41.7

package/models/command.d.ts

@@ -3,6 +3,7 @@ import { COMMAND_GROUPS } from "../constants/index.js";
 import { DefaultCommands } from './default-commands.js';
 import { OrgNoteApi } from "../api.js";
 import { VueComponent } from './vue-component.js';
+import type { ExecuteCommandOptions } from './commands-store.js';
 export type CommandGroup = (typeof COMMAND_GROUPS)[number] | (string & Record<never, never>);
 export type CommandName = DefaultCommands | (string & {});
 export type CommandIcon = string | VueComponent;
@@ -33,4 +34,4 @@ export interface CommandMeta<T = any> extends Partial<CommandPreview> {
 export interface Command<T = any, R = unknown> extends CommandMeta<T> {
     handler: (api: OrgNoteApi, params: CommandHandlerParams<T>) => R | Promise<R>;
 }
-export type CommandCallback = <T = any>(meta: Command, data: T) => void;
+export type CommandCallback = <T = any>(meta: Command, data: T, options?: ExecuteCommandOptions) => void;

package/models/commands-store.d.ts

@@ -2,12 +2,15 @@ import { Ref } from 'vue';
 import { Command, CommandCallback } from './command.js';
 import { StoreDefinition } from './store.js';
 export type CommandUnsubscribFn = () => void;
+export interface ExecuteCommandOptions {
+    interactive?: boolean;
+}
 export interface CommandsStore {
     add: (...newCommands: Command[]) => void;
     remove: (...commandsToUnregister: Command[]) => void;
     get: (name: string) => Command | undefined;
     commands: Ref<Command[]>;
-    execute: (name: string, data?: unknown) => Promise<void>;
+    execute: (name: string, data?: unknown, options?: ExecuteCommandOptions) => Promise<void>;
     afterExecute: (commandNames: string | string[], callback: CommandCallback) => CommandUnsubscribFn;
 }
 export type CommandsStoreDefinition = StoreDefinition<CommandsStore>;

package/models/completion-store.d.ts

@@ -1,5 +1,5 @@
 import { ComputedRef } from 'vue';
-import { Completion, CompletionConfig } from './completion.js';
+import { Completion, CompletionConfig, CompletionInterceptor } from './completion.js';
 import { StoreDefinition } from './store.js';
 export interface CompletionStore {
     restore: () => void;
@@ -10,5 +10,6 @@ export interface CompletionStore {
     nextCandidate: () => void;
     previousCandidate: () => void;
     search: (limit?: number, offset?: number) => void;
+    registerInterceptor: <T = unknown>(interceptor: CompletionInterceptor<T>) => () => void;
 }
 export type CompletionStoreDefinition = StoreDefinition<CompletionStore>;

package/models/completion.d.ts

@@ -14,6 +14,7 @@ export interface CompletionSearchResult<T = unknown> {
 }
 export type CandidateGetterFn<T = unknown> = (filter: string, limit?: number, offset?: number) => CompletionSearchResult<T> | Promise<CompletionSearchResult<T>>;
 export interface CompletionConfig<T = unknown> {
+    name?: string;
     searchAutocompletions?: string[];
     itemsGetter: CandidateGetterFn<T>;
     type?: 'input' | 'choice' | 'input-choice';
@@ -30,3 +31,14 @@ export interface Completion<T = any, TResult = any> extends CompletionConfig<T>
     searchQuery: string;
     result: Promise<TResult>;
 }
+export interface CompletionInterceptorContext {
+    completionName: string;
+    searchQuery: string;
+}
+export type CompletionInterceptorTarget = string | string[] | '*';
+export interface CompletionInterceptor<T = unknown> {
+    name: string;
+    target: CompletionInterceptorTarget;
+    priority?: number;
+    handler: (candidates: CompletionCandidate<T>[], context: CompletionInterceptorContext) => CompletionCandidate<T>[] | Promise<CompletionCandidate<T>[]>;
+}

package/package.json

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