@talex-touch/utils 1.0.23 → 1.0.25

package/plugin/sdk/examples/storage-onDidChange-example.js

@@ -0,0 +1,201 @@
+/**
+ * Storage onDidChange 示例
+ * 展示如何使用 storage.onDidChange 监听存储文件变化
+ * 注意：这里只能获取新值，旧值无法获取
+ */
+
+// 获取SDK实例
+const sdk = window.$touchSDK
+
+// 示例1: 监听整个配置文件的变化
+function setupConfigListener() {
+  console.log('[Storage] Setting up listener for entire config changes')
+
+  const unsubscribe = sdk.storage.onDidChange((newConfig) => {
+    console.log('[Storage] Config changed:')
+    console.log('  New config:', newConfig)
+
+    // 处理特定键的变化
+    if (newConfig && newConfig.user_preference && newConfig.user_preference.theme) {
+      console.log(`[Storage] Theme changed to: ${newConfig.user_preference.theme}`)
+    }
+  })
+
+  // 返回取消监听的函数
+  return unsubscribe
+}
+
+// 示例2: 监听配置变化并处理特定键
+function setupConfigChangeHandler() {
+  console.log('[Storage] Setting up config change handler')
+
+  const unsubscribe = sdk.storage.onDidChange((newConfig) => {
+    console.log('[Storage] Config changed:')
+    console.log('  New config:', newConfig)
+
+    // 处理特定键的变化
+    if (newConfig.user_preference) {
+      handleUserPreferenceChange(newConfig.user_preference)
+    }
+    if (newConfig.settings) {
+      handleSettingsChange(newConfig.settings)
+    }
+    if (newConfig.cache) {
+      handleCacheChange(newConfig.cache)
+    }
+  })
+
+  return unsubscribe
+}
+
+// 示例3: 动态监听
+function setupDynamicListener() {
+  let currentListener = null
+
+  // 开始监听
+  function startListening() {
+    console.log('[Storage] Starting to listen for config changes')
+
+    // 如果已有监听器，先取消
+    if (currentListener) {
+      currentListener()
+    }
+
+    currentListener = sdk.storage.onDidChange((newConfig) => {
+      console.log('[Storage] Dynamic listener for config changes:')
+      console.log('  New config:', newConfig)
+    })
+  }
+
+  // 停止监听
+  function stopListening() {
+    if (currentListener) {
+      console.log('[Storage] Stopping current listener')
+      currentListener()
+      currentListener = null
+    }
+  }
+
+  return { startListening, stopListening }
+}
+
+// 示例4: 条件监听
+function setupConditionalListener() {
+  console.log('[Storage] Setting up conditional listener')
+
+  const unsubscribe = sdk.storage.onDidChange((newConfig) => {
+    // 处理用户偏好变化
+    if (newConfig.user_preference) {
+      const pref = newConfig.user_preference
+
+      // 处理主题变化
+      if (pref.theme) {
+        console.log(`[Storage] Theme: ${pref.theme}`)
+        applyTheme(pref.theme)
+      }
+
+      // 处理语言变化
+      if (pref.language) {
+        console.log(`[Storage] Language: ${pref.language}`)
+        reloadInterface(pref.language)
+      }
+    }
+  })
+
+  return unsubscribe
+}
+
+// 示例5: 批量操作监听
+function setupBatchOperationListener() {
+  console.log('[Storage] Setting up batch operation listener')
+
+  const unsubscribe = sdk.storage.onDidChange((newConfig) => {
+    console.log('[Storage] Config changed:')
+    console.log('  New config keys:', Object.keys(newConfig))
+
+    // 处理批量数据变化
+    if (newConfig.batch_data) {
+      console.log('[Storage] Processing batch data changes')
+      console.log('  Batch data count:', Object.keys(newConfig.batch_data).length)
+
+      // 应用变化
+      applyChanges(newConfig.batch_data)
+    }
+  })
+
+  return unsubscribe
+}
+
+// 辅助函数
+function handleUserPreferenceChange(newValue) {
+  console.log('[Storage] Handling user preference change')
+  // 处理用户偏好变化
+}
+
+function handleSettingsChange(newValue) {
+  console.log('[Storage] Handling settings change')
+  // 处理设置变化
+}
+
+function handleCacheChange(newValue) {
+  console.log('[Storage] Handling cache change')
+  // 处理缓存变化
+}
+
+function applyTheme(theme) {
+  console.log(`[Storage] Applying theme: ${theme}`)
+  // 应用主题逻辑
+}
+
+function reloadInterface(language) {
+  console.log(`[Storage] Reloading interface for language: ${language}`)
+  // 重新加载界面逻辑
+}
+
+function findChanges(oldValue, newValue) {
+  const changes = []
+  // 比较两个对象并找出变化
+  return changes
+}
+
+function applyChanges(changes) {
+  console.log('[Storage] Applying changes:', changes)
+  // 应用变化逻辑
+}
+
+// 导出函数供外部调用
+window.storageOnDidChangeExample = {
+  setupConfigListener,
+  setupConfigChangeHandler,
+  setupDynamicListener,
+  setupConditionalListener,
+  setupBatchOperationListener
+}
+
+// 自动运行示例（可选）
+if (typeof window !== 'undefined' && window.location.hostname === 'localhost') {
+  console.log('[Auto] Setting up storage listeners...')
+
+  // 设置配置监听
+  const unsubscribe1 = setupConfigListener()
+
+  // 设置配置变化处理器
+  const unsubscribeAll = setupConfigChangeHandler()
+
+  // 设置动态监听
+  const { startListening, stopListening } = setupDynamicListener()
+
+  // 5秒后切换到监听其他键
+  setTimeout(() => {
+    stopListening()
+    startListening('settings')
+  }, 5000)
+
+  // 10秒后停止所有监听
+  setTimeout(() => {
+    console.log('[Auto] Stopping all listeners...')
+    unsubscribe1()
+    unsubscribeAll()
+    stopListening()
+  }, 10000)
+}

package/plugin/sdk/features.ts

@@ -0,0 +1,324 @@
+/**
+ * Plugin Features SDK
+ *
+ * @description
+ * 提供插件features管理的SDK功能，包括动态添加、删除、查询和优先级管理
+ *
+ * @version 1.0.0
+ * @module plugin/sdk/features
+ */
+
+import { IPluginFeature } from '../index'
+
+/**
+ * Features管理器接口
+ *
+ * @description
+ * 提供完整的features管理功能，包括CRUD操作和优先级管理
+ */
+export interface IFeaturesManager {
+  /**
+   * 动态添加功能到插件
+   * @param feature - 功能定义
+   * @returns 是否添加成功
+   */
+  addFeature(feature: IPluginFeature): boolean
+
+  /**
+   * 删除功能
+   * @param featureId - 功能ID
+   * @returns 是否删除成功
+   */
+  removeFeature(featureId: string): boolean
+
+  /**
+   * 获取所有功能
+   * @returns 所有功能列表
+   */
+  getFeatures(): IPluginFeature[]
+
+  /**
+   * 获取指定功能
+   * @param featureId - 功能ID
+   * @returns 功能对象，如果不存在返回null
+   */
+  getFeature(featureId: string): IPluginFeature | null
+
+  /**
+   * 设置功能优先级
+   * @param featureId - 功能ID
+   * @param priority - 优先级值（数字越大优先级越高）
+   * @returns 是否设置成功
+   */
+  setPriority(featureId: string, priority: number): boolean
+
+  /**
+   * 获取功能优先级
+   * @param featureId - 功能ID
+   * @returns 优先级值，如果功能不存在返回null
+   */
+  getPriority(featureId: string): number | null
+
+  /**
+   * 按优先级排序获取所有功能
+   * @returns 按优先级排序的功能列表（高优先级在前）
+   */
+  getFeaturesByPriority(): IPluginFeature[]
+
+  /**
+   * 批量设置功能优先级
+   * @param priorities - 优先级映射对象 {featureId: priority}
+   * @returns 设置成功的功能数量
+   */
+  setPriorities(priorities: Record<string, number>): number
+
+  /**
+   * 重置功能优先级为默认值（0）
+   * @param featureId - 功能ID
+   * @returns 是否重置成功
+   */
+  resetPriority(featureId: string): boolean
+
+  /**
+   * 获取功能统计信息
+   * @returns 功能统计对象
+   */
+  getStats(): {
+    total: number
+    byPriority: Record<number, number>
+    averagePriority: number
+  }
+}
+
+/**
+ * 创建Features管理器
+ *
+ * @description
+ * 为插件创建features管理器实例
+ *
+ * @param pluginName - 插件名称
+ * @param utils - 插件工具对象
+ * @returns Features管理器实例
+ *
+ * @example
+ * ```typescript
+ * const featuresManager = createFeaturesManager('my-plugin', utils)
+ *
+ * // 添加功能
+ * featuresManager.addFeature({
+ *   id: 'search',
+ *   name: '搜索功能',
+ *   desc: '提供搜索能力',
+ *   commands: [{ type: 'over', value: ['search'] }],
+ *   priority: 100
+ * })
+ *
+ * // 设置优先级
+ * featuresManager.setPriority('search', 200)
+ *
+ * // 获取按优先级排序的功能
+ * const sortedFeatures = featuresManager.getFeaturesByPriority()
+ * ```
+ */
+export function createFeaturesManager(
+  pluginName: string,
+  utils: any
+): IFeaturesManager {
+  return {
+    /**
+     * 动态添加功能到插件
+     */
+    addFeature(feature: IPluginFeature): boolean {
+      try {
+        return utils.features.addFeature(feature)
+      } catch (error) {
+        console.error(`[FeaturesManager] Failed to add feature ${feature.id}:`, error)
+        return false
+      }
+    },
+
+    /**
+     * 删除功能
+     */
+    removeFeature(featureId: string): boolean {
+      try {
+        return utils.features.removeFeature(featureId)
+      } catch (error) {
+        console.error(`[FeaturesManager] Failed to remove feature ${featureId}:`, error)
+        return false
+      }
+    },
+
+    /**
+     * 获取所有功能
+     */
+    getFeatures(): IPluginFeature[] {
+      try {
+        return utils.features.getFeatures()
+      } catch (error) {
+        console.error(`[FeaturesManager] Failed to get features:`, error)
+        return []
+      }
+    },
+
+    /**
+     * 获取指定功能
+     */
+    getFeature(featureId: string): IPluginFeature | null {
+      try {
+        return utils.features.getFeature(featureId)
+      } catch (error) {
+        console.error(`[FeaturesManager] Failed to get feature ${featureId}:`, error)
+        return null
+      }
+    },
+
+    /**
+     * 设置功能优先级
+     */
+    setPriority(featureId: string, priority: number): boolean {
+      try {
+        return utils.features.setPriority(featureId, priority)
+      } catch (error) {
+        console.error(`[FeaturesManager] Failed to set priority for ${featureId}:`, error)
+        return false
+      }
+    },
+
+    /**
+     * 获取功能优先级
+     */
+    getPriority(featureId: string): number | null {
+      try {
+        return utils.features.getPriority(featureId)
+      } catch (error) {
+        console.error(`[FeaturesManager] Failed to get priority for ${featureId}:`, error)
+        return null
+      }
+    },
+
+    /**
+     * 按优先级排序获取所有功能
+     */
+    getFeaturesByPriority(): IPluginFeature[] {
+      try {
+        return utils.features.getFeaturesByPriority()
+      } catch (error) {
+        console.error(`[FeaturesManager] Failed to get features by priority:`, error)
+        return []
+      }
+    },
+
+    /**
+     * 批量设置功能优先级
+     */
+    setPriorities(priorities: Record<string, number>): number {
+      let successCount = 0
+      for (const [featureId, priority] of Object.entries(priorities)) {
+        if (this.setPriority(featureId, priority)) {
+          successCount++
+        }
+      }
+      return successCount
+    },
+
+    /**
+     * 重置功能优先级为默认值
+     */
+    resetPriority(featureId: string): boolean {
+      return this.setPriority(featureId, 0)
+    },
+
+    /**
+     * 获取功能统计信息
+     */
+    getStats(): {
+      total: number
+      byPriority: Record<number, number>
+      averagePriority: number
+    } {
+      try {
+        const features = this.getFeatures()
+        const total = features.length
+
+        const byPriority: Record<number, number> = {}
+        let totalPriority = 0
+
+        features.forEach(feature => {
+          const priority = feature.priority ?? 0
+          byPriority[priority] = (byPriority[priority] || 0) + 1
+          totalPriority += priority
+        })
+
+        const averagePriority = total > 0 ? totalPriority / total : 0
+
+        return {
+          total,
+          byPriority,
+          averagePriority
+        }
+      } catch (error) {
+        console.error(`[FeaturesManager] Failed to get stats:`, error)
+        return {
+          total: 0,
+          byPriority: {},
+          averagePriority: 0
+        }
+      }
+    }
+  }
+}
+
+/**
+ * Features管理器工厂函数
+ *
+ * @description
+ * 为插件创建features管理器的便捷工厂函数
+ *
+ * @param utils - 插件工具对象
+ * @returns Features管理器实例
+ */
+export function useFeatures(utils: any): IFeaturesManager {
+  const pluginName = utils.plugin?.getInfo()?.name || 'unknown'
+  return createFeaturesManager(pluginName, utils)
+}
+
+/**
+ * 功能优先级常量
+ *
+ * @description
+ * 提供常用的优先级值，便于插件开发者使用
+ */
+export const FEATURE_PRIORITIES = {
+  /** 最高优先级 */
+  HIGHEST: 1000,
+  /** 高优先级 */
+  HIGH: 500,
+  /** 默认优先级 */
+  NORMAL: 0,
+  /** 低优先级 */
+  LOW: -500,
+  /** 最低优先级 */
+  LOWEST: -1000
+} as const
+
+/**
+ * 功能类型枚举
+ *
+ * @description
+ * 预定义的功能类型，便于分类管理
+ */
+export const FEATURE_TYPES = {
+  /** 搜索功能 */
+  SEARCH: 'search',
+  /** 工具功能 */
+  TOOL: 'tool',
+  /** 系统功能 */
+  SYSTEM: 'system',
+  /** 网络功能 */
+  NETWORK: 'network',
+  /** 文件功能 */
+  FILE: 'file',
+  /** 应用功能 */
+  APP: 'app'
+} as const

package/plugin/sdk/index.ts

@@ -19,5 +19,7 @@ export * from './service/index'
 
 export * from './channel'
 export * from './clipboard'
+export * from './core-box'
 export * from './storage'
 export * from './system'
+export * from './features'

package/plugin/sdk/types.ts

@@ -5,6 +5,7 @@
  */
 
 import type { ITouchChannel, ITouchClientChannel, StandardChannelData } from '@talex-touch/utils/channel';
+import type { IPluginFeature } from '../index';
 
 /**
  * Handler signature for plugin channel events.
@@ -198,6 +199,18 @@ export interface IPluginUtils {
    * @returns Array of current search result items
    */
   getItems: () => any[];
+
+  /**
+   * Features manager for dynamic feature management
+   * @see {@link IFeaturesManager}
+   */
+  features: IFeaturesManager;
+
+  /**
+   * Plugin information manager
+   * @see {@link IPluginInfoManager}
+   */
+  plugin: IPluginInfoManager;
 }
 
 /**
@@ -700,3 +713,132 @@ export function createSearchManager(): ISearchManager {
     }
   };
 }
+
+/**
+ * Features管理器接口
+ *
+ * @description
+ * 提供完整的features管理功能，包括CRUD操作和优先级管理
+ */
+export interface IFeaturesManager {
+  /**
+   * 动态添加功能到插件
+   * @param feature - 功能定义
+   * @returns 是否添加成功
+   */
+  addFeature(feature: IPluginFeature): boolean
+
+  /**
+   * 删除功能
+   * @param featureId - 功能ID
+   * @returns 是否删除成功
+   */
+  removeFeature(featureId: string): boolean
+
+  /**
+   * 获取所有功能
+   * @returns 所有功能列表
+   */
+  getFeatures(): IPluginFeature[]
+
+  /**
+   * 获取指定功能
+   * @param featureId - 功能ID
+   * @returns 功能对象，如果不存在返回null
+   */
+  getFeature(featureId: string): IPluginFeature | null
+
+  /**
+   * 设置功能优先级
+   * @param featureId - 功能ID
+   * @param priority - 优先级值（数字越大优先级越高）
+   * @returns 是否设置成功
+   */
+  setPriority(featureId: string, priority: number): boolean
+
+  /**
+   * 获取功能优先级
+   * @param featureId - 功能ID
+   * @returns 优先级值，如果功能不存在返回null
+   */
+  getPriority(featureId: string): number | null
+
+  /**
+   * 按优先级排序获取所有功能
+   * @returns 按优先级排序的功能列表（高优先级在前）
+   */
+  getFeaturesByPriority(): IPluginFeature[]
+
+  /**
+   * 批量设置功能优先级
+   * @param priorities - 优先级映射对象 {featureId: priority}
+   * @returns 设置成功的功能数量
+   */
+  setPriorities(priorities: Record<string, number>): number
+
+  /**
+   * 重置功能优先级为默认值（0）
+   * @param featureId - 功能ID
+   * @returns 是否重置成功
+   */
+  resetPriority(featureId: string): boolean
+
+  /**
+   * 获取功能统计信息
+   * @returns 功能统计对象
+   */
+  getStats(): {
+    total: number
+    byPriority: Record<number, number>
+    averagePriority: number
+  }
+}
+
+/**
+ * 插件信息管理器接口
+ *
+ * @description
+ * 提供插件信息查询功能
+ */
+export interface IPluginInfoManager {
+  /**
+   * 获取完整插件信息
+   * @returns 包含所有插件信息的对象
+   */
+  getInfo(): {
+    name: string
+    version: string
+    desc: string
+    readme: string
+    dev: any
+    status: number
+    platforms: any
+    pluginPath: string
+    features: any[]
+    issues: any[]
+  }
+
+  /**
+   * 获取插件路径
+   * @returns 插件文件系统路径
+   */
+  getPath(): string
+
+  /**
+   * 获取插件状态
+   * @returns 当前插件状态
+   */
+  getStatus(): number
+
+  /**
+   * 获取开发信息
+   * @returns 开发配置信息
+   */
+  getDevInfo(): any
+
+  /**
+   * 获取平台支持信息
+   * @returns 平台兼容性信息
+   */
+  getPlatforms(): any
+}

package/renderer/touch-sdk/index.ts

@@ -85,6 +85,15 @@ export class TouchSDK {
     return this.channel.send('plugin:explorer', pluginName)
   }
 
+  /**
+   * Reloads a plugin by its name
+   * @param pluginName - The name of the plugin to reload
+   * @returns Promise that resolves when the reload operation completes
+   */
+  async reloadPlugin(pluginName: string): Promise<void> {
+    return this.channel.send('reload-plugin', { name: pluginName })
+  }
+
   /**
    * Module Operations
    */