@wox-launcher/wox-plugin 0.0.26 → 0.0.28

package/package.json

@@ -1,16 +1,15 @@
 {
   "name": "@wox-launcher/wox-plugin",
-  "version": "0.0.26",
+  "version": "0.0.28",
   "description": "All nodejs plugin for Wox should use types in this package",
   "repository": {
     "type": "git",
     "url": "https://github.com/Wox-launcher/Wox.git"
   },
-  "type": "module",
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
+  "main": "./src/index.js",
+  "types": "./src/index.ts",
   "files": [
-    "dist"
+    "src"
   ],
   "devDependencies": {
     "@tsconfig/node-lts": "^18.12.5",

package/src/index.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WoxImageBuilder = void 0;
+exports.WoxImageBuilder = {
+    FromAbsolutePath: (path) => {
+        return {
+            ImageType: "AbsolutePath",
+            ImageData: path
+        };
+    },
+    FromRelativeToPluginPath: (path) => {
+        return {
+            ImageType: "RelativeToPluginPath",
+            ImageData: path
+        };
+    },
+    FromSvg: (svg) => {
+        return {
+            ImageType: "Svg",
+            ImageData: svg
+        };
+    },
+    FromBase64: (base64) => {
+        return {
+            ImageType: "Base64",
+            ImageData: base64
+        };
+    },
+    FromRemote: (url) => {
+        return {
+            ImageType: "Remote",
+            ImageData: url
+        };
+    }
+};

package/src/index.ts

@@ -0,0 +1,125 @@
+export interface Plugin {
+  init: (context: PluginInitContext) => Promise<void>;
+  query: (query: Query) => Promise<Result[]>;
+}
+
+export interface Query {
+  /**
+   * Raw query, this includes trigger keyword if it has
+   * We didn't recommend use this property directly. You should always use Search property.
+   */
+  RawQuery: string;
+  /**
+   * Trigger keyword of a query. It can be empty if user is using global trigger keyword.
+   */
+  TriggerKeyword?: string;
+  /**
+   * Command part of a query.
+   */
+  Command?: string;
+  /**
+   * Search part of a query.
+   */
+  Search: string;
+}
+
+export interface Result {
+  Id?: string;
+  Title: string;
+  SubTitle?: string;
+  Icon: WoxImage;
+  Score?: number;
+  Action: () => Promise<boolean>;
+}
+
+export interface PluginInitContext {
+  API: PublicAPI;
+}
+
+export interface PublicAPI {
+  /**
+   * Change Wox query
+   */
+  ChangeQuery: (query: string) => Promise<void>;
+
+  /**
+   * Hide Wox
+   */
+  HideApp: () => Promise<void>;
+
+  /**
+   * Show Wox
+   */
+  ShowApp: () => Promise<void>;
+
+  /**
+   * Show message box
+   */
+  ShowMsg: (title: string, description?: string, iconPath?: string) => Promise<void>;
+
+  /**
+   * Write log
+   */
+  Log: (msg: string) => Promise<void>;
+
+  /**
+   * Get translation of current language
+   */
+  GetTranslation: (key: string) => Promise<string>;
+}
+
+export type WoxImageType = "AbsolutePath" | "RelativeToPluginPath" | "Svg" | "Base64" | "Remote"
+
+export interface WoxImage {
+  ImageType: WoxImageType;
+  ImageData: string;
+}
+
+export interface WoxImageCreator {
+  FromAbsolutePath(path: string): WoxImage;
+
+  FromRelativeToPluginPath(path: string): WoxImage;
+
+  FromSvg(svg: string): WoxImage;
+
+  FromBase64(base64: string): WoxImage;
+
+  FromRemote(url: string): WoxImage;
+}
+
+export const WoxImageBuilder: WoxImageCreator = {
+  FromAbsolutePath: (path: string) => {
+    return {
+      ImageType: "AbsolutePath",
+      ImageData: path
+    };
+  },
+
+  FromRelativeToPluginPath: (path: string) => {
+    return {
+      ImageType: "RelativeToPluginPath",
+      ImageData: path
+    };
+  },
+
+  FromSvg: (svg: string) => {
+    return {
+      ImageType: "Svg",
+      ImageData: svg
+    };
+  },
+
+  FromBase64: (base64: string) => {
+    return {
+      ImageType: "Base64",
+      ImageData: base64
+    };
+  },
+
+  FromRemote: (url: string) => {
+    return {
+      ImageType: "Remote",
+      ImageData: url
+    };
+  }
+};