@wox-launcher/wox-plugin 0.0.65 → 0.0.67

package/package.json

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

package/types/index.d.ts

@@ -1,3 +1,8 @@
+import { llm } from "./llm.js"
+import { MetadataCommand, PluginSettingDefinitionItem } from "./setting.js"
+
+export type Platform = "windows" | "darwin" | "linux"
+
 export interface Plugin {
   init: (ctx: Context, initParams: PluginInitParams) => Promise<void>
   query: (ctx: Context, query: Query) => Promise<Result[]>
@@ -11,6 +16,13 @@ export interface Selection {
   FilePaths: string[]
 }
 
+export interface QueryEnv {
+  /**
+   * Active window title when user query
+   */
+  ActiveWindowTitle: string
+}
+
 export interface Query {
   /**
    *  By default, Wox will only pass input query to plugin.
@@ -50,12 +62,19 @@ export interface Query {
    */
   Selection: Selection
 
+  /**
+   * Additional query environment data
+   * expose more context env data to plugin, E.g. plugin A only show result when active window title is "Chrome"
+   */
+  Env: QueryEnv
+
   /**
    * Whether current query is global query
    */
   IsGlobalQuery(): boolean
 }
 
+
 export interface Result {
   Id?: string
   Title: string
@@ -165,6 +184,21 @@ export interface PublicAPI {
    * Register setting changed callback
    */
   OnSettingChanged: (ctx: Context, callback: (key: string, value: string) => void) => Promise<void>
+
+  /**
+   * Get dynamic setting definition
+   */
+  OnGetDynamicSetting: (ctx: Context, callback: (key: string) => PluginSettingDefinitionItem) => Promise<void>
+
+  /**
+   * Register query commands
+   */
+  RegisterQueryCommands: (ctx: Context, commands: MetadataCommand[]) => Promise<void>
+
+  /**
+   * Chat using LLM
+   */
+  LLMStream: (ctx: Context, conversations: llm.Conversation[], callback: llm.ChatStreamFunc) => Promise<void>
 }
 
 export type WoxImageType = "absolute" | "relative" | "base64" | "svg" | "url" | "emoji"

package/types/llm.d.ts

@@ -0,0 +1,12 @@
+export namespace llm {
+  export type ConversationRole = "user" | "system"
+  export type ChatStreamDataType = "streaming" | "finished" | "error"
+
+  export interface Conversation {
+    Role: ConversationRole
+    Text: string
+    Timestamp: number
+  }
+
+  export type ChatStreamFunc = (dataType: ChatStreamDataType, data: string) => void
+}

package/types/setting.d.ts

@@ -0,0 +1,97 @@
+import { Context, Platform } from "./index.js"
+
+export type PluginSettingDefinitionType = "head" | "textbox" | "checkbox" | "select" | "label" | "newline" | "table" | "dynamic"
+
+
+export interface PluginSettingValueStyle {
+  PaddingLeft: number
+  PaddingTop: number
+  PaddingRight: number
+  PaddingBottom: number
+
+  Width: number
+  LabelWidth: number // if has label, E.g. select, checkbox, textbox
+}
+
+export interface PluginSettingDefinitionValue {
+  GetKey: () => string
+  GetDefaultValue: () => string
+  Translate: (translator: (ctx: Context, key: string) => string) => void
+}
+
+export interface PluginSettingDefinitionItem {
+  Type: PluginSettingDefinitionType
+  Value: PluginSettingDefinitionValue
+  DisabledInPlatforms: Platform[]
+  IsPlatformSpecific: boolean // if true, this setting may be different in different platforms
+}
+
+export interface MetadataCommand {
+  Command: string
+  Description: string
+}
+
+export interface PluginSettingValueCheckBox extends PluginSettingDefinitionValue {
+  Key: string
+  Label: string
+  DefaultValue: string
+  Tooltip: string
+  Style: PluginSettingValueStyle
+}
+
+export interface PluginSettingValueDynamic extends PluginSettingDefinitionValue {
+  Key: string
+}
+
+export interface PluginSettingValueHead extends PluginSettingDefinitionValue {
+  Content: string
+  Tooltip: string
+  Style: PluginSettingValueStyle
+}
+
+export interface PluginSettingValueLabel extends PluginSettingDefinitionValue {
+  Content: string
+  Tooltip: string
+  Style: PluginSettingValueStyle
+}
+
+export interface PluginSettingValueNewline extends PluginSettingDefinitionValue {
+  Style: PluginSettingValueStyle
+}
+
+export interface PluginSettingValueSelect extends PluginSettingDefinitionValue {
+  Key: string
+  Label: string
+  Suffix: string
+  DefaultValue: string
+  Tooltip: string
+  Options: PluginSettingValueSelectOption[]
+  Validators: PluginSettingValidator[] // validators for this setting, every validator should be satisfied
+
+  Style: PluginSettingValueStyle
+}
+
+export interface PluginSettingValueSelectOption {
+  Label: string
+  Value: string
+}
+
+export type PluginSettingValidatorType = "is_number" | "not_empty"
+
+export interface PluginSettingValidator {
+  Type: PluginSettingValidatorType
+  Value: PluginSettingValidatorValue
+}
+
+export interface PluginSettingValidatorValue {
+  GetValidatorType(): PluginSettingValidatorType
+}
+
+export interface PluginSettingValidatorIsNumber extends PluginSettingValidatorValue {
+  IsInteger: boolean
+  IsFloat: boolean
+}
+
+export interface PluginSettingValidatorNotEmpty extends PluginSettingValidatorValue {
+
+}