@wox-launcher/wox-plugin 0.0.49 → 0.0.51

package/dist/index.d.ts

@@ -2,28 +2,48 @@ export interface Plugin {
     init: (context: PluginInitContext) => Promise<void>;
     query: (query: Query) => Promise<Result[]>;
 }
+export interface Selection {
+    Type: "text" | "file";
+    Text: string;
+    FilePaths: string[];
+}
 export interface Query {
     /**
-     * Type of a query.
+     *  By default, Wox will only pass input query to plugin.
+     *  plugin author need to enable MetadataFeatureQuerySelection feature to handle selection query
      */
-    Type: "text" | "file";
+    Type: "input" | "selection";
     /**
      * Raw query, this includes trigger keyword if it has
      * We didn't recommend use this property directly. You should always use Search property.
+     *
+     * NOTE: Only available when query type is input
      */
     RawQuery: string;
     /**
      * Trigger keyword of a query. It can be empty if user is using global trigger keyword.
+     *
+     * NOTE: Only available when query type is input
      */
     TriggerKeyword?: string;
     /**
      * Command part of a query.
+     *
+     * NOTE: Only available when query type is input
      */
     Command?: string;
     /**
      * Search part of a query.
+     *
+     * NOTE: Only available when query type is input
      */
     Search: string;
+    /**
+     * User selected or drag-drop data, can be text or file or image etc
+     *
+     * NOTE: Only available when query type is selection
+     */
+    Selection: Selection;
 }
 export interface Result {
     Id?: string;
@@ -70,11 +90,16 @@ export interface PluginInitContext {
     API: PublicAPI;
     PluginDirectory: string;
 }
+export interface ChangeQueryParam {
+    QueryType: "input" | "selection";
+    QueryText?: string;
+    QuerySelection?: Selection;
+}
 export interface PublicAPI {
     /**
      * Change Wox query
      */
-    ChangeQuery: (query: string) => Promise<void>;
+    ChangeQuery: (query: ChangeQueryParam) => Promise<void>;
     /**
      * Hide Wox
      */

package/package.json

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