@wox-launcher/wox-plugin 0.0.100 → 0.0.103

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wox-launcher/wox-plugin",
-  "version": "0.0.100",
+  "version": "0.0.103",
   "description": "All nodejs plugin for Wox should use types in this package",
   "repository": {
     "type": "git",

package/types/index.d.ts

@@ -40,6 +40,10 @@ export interface QueryEnv {
 }
 
 export interface Query {
+  /**
+   * Query id passed from UI to correlate async updates.
+   */
+  Id: string
   /**
    *  By default, Wox will only pass input query to plugin.
    *  plugin author need to enable MetadataFeatureQuerySelection feature to handle selection query
@@ -171,7 +175,7 @@ export interface ExecuteResultAction {
    * If true, Wox will not hide after user select this result
    */
   PreventHideAfterAction?: boolean
-  Action: (actionContext: ActionContext) => Promise<void>
+  Action: (ctx: Context, actionContext: ActionContext) => Promise<void>
   /**
    * Hotkey to trigger this action. E.g. "ctrl+Shift+Space", "Ctrl+1", "Command+K"
    * Case insensitive, space insensitive
@@ -203,7 +207,7 @@ export interface FormResultAction {
    */
   PreventHideAfterAction?: boolean
   Form: PluginSettingDefinitionItem[]
-  OnSubmit: (actionContext: FormActionContext) => Promise<void>
+  OnSubmit: (ctx: Context, actionContext: FormActionContext) => Promise<void>
   /**
    * Hotkey to trigger this action. E.g. "ctrl+Shift+Space", "Ctrl+1", "Command+K"
    * Case insensitive, space insensitive
@@ -329,22 +333,22 @@ export interface PublicAPI {
   /**
    * Register setting changed callback
    */
-  OnSettingChanged: (ctx: Context, callback: (key: string, value: string) => void) => Promise<void>
+  OnSettingChanged: (ctx: Context, callback: (ctx: Context, key: string, value: string) => void) => Promise<void>
 
   /**
    * Get dynamic setting definition
    */
-  OnGetDynamicSetting: (ctx: Context, callback: (key: string) => PluginSettingDefinitionItem) => Promise<void>
+  OnGetDynamicSetting: (ctx: Context, callback: (ctx: Context, key: string) => PluginSettingDefinitionItem) => Promise<void>
 
   /**
    * Register deep link callback
    */
-  OnDeepLink: (ctx: Context, callback: (arguments: MapString) => void) => Promise<void>
+  OnDeepLink: (ctx: Context, callback: (ctx: Context, arguments: MapString) => void) => Promise<void>
 
   /**
    * Register on load event
    */
-  OnUnload: (ctx: Context, callback: () => Promise<void>) => Promise<void>
+  OnUnload: (ctx: Context, callback: (ctx: Context) => Promise<void>) => Promise<void>
 
   /**
    * Register query commands
@@ -362,7 +366,7 @@ export interface PublicAPI {
    * @param callback Callback function that takes MRUData and returns Result or null
    *                 Return null if the MRU data is no longer valid
    */
-  OnMRURestore: (ctx: Context, callback: (mruData: MRUData) => Promise<Result | null>) => Promise<void>
+  OnMRURestore: (ctx: Context, callback: (ctx: Context, mruData: MRUData) => Promise<Result | null>) => Promise<void>
 
   /**
    * Get the current state of a result that is displayed in the UI.
@@ -376,7 +380,7 @@ export interface PublicAPI {
    * Example:
    * ```typescript
    * // In an action handler
-   * Action: async (actionContext) => {
+   * Action: async (ctx, actionContext) => {
    *   // Get current result state
    *   const updatableResult = await api.GetUpdatableResult(ctx, actionContext.ResultId)
    *   if (updatableResult === null) {
@@ -413,7 +417,7 @@ export interface PublicAPI {
    * Example:
    * ```typescript
    * // In an action handler
-   * Action: async (actionContext) => {
+   * Action: async (ctx, actionContext) => {
    *   // Update only the title
    *   const success = await api.UpdateResult(ctx, {
    *     Id: actionContext.ResultId,
@@ -435,13 +439,25 @@ export interface PublicAPI {
    */
   UpdateResult: (ctx: Context, result: UpdatableResult) => Promise<boolean>
 
+  /**
+   * Push additional results for the current query.
+   *
+   * Returns true if UI accepted the results (query still active),
+   * false if query is no longer active.
+   *
+   * @param ctx Context
+   * @param query Current query
+   * @param results Results to append
+   */
+  PushResults: (ctx: Context, query: Query, results: Result[]) => Promise<boolean>
+
   /**
    * Re-execute the current query with the existing query text.
    * This is useful when plugin data changes and you want to update the displayed results.
    *
    * Example - Refresh after marking item as favorite:
    * ```typescript
-   * Action: async (actionContext) => {
+   * Action: async (ctx, actionContext) => {
    *   markAsFavorite(item)
    *   // Refresh query and preserve user's current selection
    *   await api.RefreshQuery(ctx, { PreserveSelectedIndex: true })
@@ -450,7 +466,7 @@ export interface PublicAPI {
    *
    * Example - Refresh after deleting item:
    * ```typescript
-   * Action: async (actionContext) => {
+   * Action: async (ctx, actionContext) => {
    *   deleteItem(item)
    *   // Refresh query and reset to first item
    *   await api.RefreshQuery(ctx, { PreserveSelectedIndex: false })