@wox-launcher/wox-plugin 0.0.88 → 0.0.89

package/package.json

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

package/types/index.d.ts

@@ -135,7 +135,7 @@ export interface ResultTail {
  * })
  * ```
  */
-export interface UpdateableResult {
+export interface UpdatableResult {
   /** Required - identifies which result to update */
   Id: string
   /** Optional - update the title */
@@ -177,7 +177,7 @@ export interface UpdateableResult {
  * })
  * ```
  */
-export interface UpdateableResultAction {
+export interface UpdatableResultAction {
   /** Required - identifies which result contains the action */
   ResultId: string
   /** Required - identifies which action to update */
@@ -214,6 +214,10 @@ export interface ResultAction {
    * If IsDefault is true, Hotkey will be set to enter key by default
    */
   Hotkey?: string
+  /**
+   * Additional data associate with this action, can be retrieved later
+   */
+  ContextData?: string
 }
 
 export interface ActionContext {
@@ -345,7 +349,7 @@ export interface PublicAPI {
   /**
    * Get the current state of a result that is displayed in the UI.
    *
-   * Returns UpdateableResult with current values if the result is still visible.
+   * Returns UpdatableResult with current values if the result is still visible.
    * Returns null if the result is no longer visible.
    *
    * Note: System actions and tails (like favorite icon) are automatically filtered out.
@@ -372,9 +376,9 @@ export interface PublicAPI {
    *
    * @param ctx Context
    * @param resultId ID of the result to get
-   * @returns Promise<UpdateableResult | null> Current result state, or null if not visible
+   * @returns Promise<UpdatableResult | null> Current result state, or null if not visible
    */
-  GetUpdatableResult: (ctx: Context, resultId: string) => Promise<UpdateableResult | null>
+  GetUpdatableResult: (ctx: Context, resultId: string) => Promise<UpdatableResult | null>
 
   /**
    * Update a query result that is currently displayed in the UI.
@@ -408,10 +412,10 @@ export interface PublicAPI {
    * ```
    *
    * @param ctx Context
-   * @param result UpdateableResult with Id (required) and optional fields to update
+   * @param result UpdatableResult with Id (required) and optional fields to update
    * @returns Promise<boolean> True if updated successfully, false if result no longer visible
    */
-  UpdateResult: (ctx: Context, result: UpdateableResult) => Promise<boolean>
+  UpdateResult: (ctx: Context, result: UpdatableResult) => Promise<boolean>
 
   /**
    * Update a single action within a query result that is currently displayed in the UI.
@@ -452,10 +456,10 @@ export interface PublicAPI {
    * ```
    *
    * @param ctx Context
-   * @param action UpdateableResultAction with ResultId, ActionId (required) and optional fields to update
+   * @param action UpdatableResultAction with ResultId, ActionId (required) and optional fields to update
    * @returns Promise<boolean> True if updated successfully, false if result no longer visible
    */
-  UpdateResultAction: (ctx: Context, action: UpdateableResultAction) => Promise<boolean>
+  UpdateResultAction: (ctx: Context, action: UpdatableResultAction) => Promise<boolean>
 }
 
 export type WoxImageType = "absolute" | "relative" | "base64" | "svg" | "url" | "emoji" | "lottie"