@talex-touch/utils 1.0.25 → 1.0.27

package/channel/index.ts

@@ -9,6 +9,8 @@ export enum DataCode {
   ERROR = 100
 }
 
+export type ChannelCallback = (data: StandardChannelData) => any
+
 export interface ITouchChannel {
 
   /**
@@ -18,7 +20,17 @@ export interface ITouchChannel {
    * @param eventName {string} The name of event, must be unique in the channel {@link ChannelType}
    * @param callback {Function} The callback function
    */
-  regChannel(type: ChannelType, eventName: string, callback: (data: StandardChannelData) => any): () => void
+  regChannel(type: ChannelType, eventName: string, callback: ChannelCallback): () => void
+
+  /**
+   * Unregister a channel
+   * @description Unregister a channel by type, event name and callback
+   * @param type {@link ChannelType} The type of channel
+   * @param eventName {string} The name of event
+   * @param callback {Function} The callback function to unregister
+   * @returns {boolean} Returns true if the channel was successfully unregistered, false otherwise
+   */
+  unregChannel(type: ChannelType, eventName: string, callback: ChannelCallback): boolean
 
   /**
    * @deprecated Use sendMain instead
@@ -96,6 +108,15 @@ export interface ITouchClientChannel {
    */
   regChannel(eventName: string, callback: (data: StandardChannelData) => any): () => void
 
+  /**
+   * Unregister a channel
+   * @description Unregister a channel by event name and callback
+   * @param eventName {string} The name of event
+   * @param callback {Function} The callback function to unregister
+   * @returns {boolean} Returns true if the channel was successfully unregistered, false otherwise
+   */
+  unRegChannel(eventName: string, callback: (data: StandardChannelData) => any): boolean
+
   /**
    * Send a message to a channel
    * @param eventName {string} The name of event, must be unique in the channel {@link ChannelType}

package/package.json

@@ -5,7 +5,7 @@
   "module": "./index.ts",
   "license": "MPL-2.0",
   "private": false,
-  "version": "1.0.25",
+  "version": "1.0.27",
   "scripts": {
     "publish": "npm publish --access public"
   },

package/plugin/channel.ts

@@ -164,6 +164,29 @@ class TouchChannel implements ITouchClientChannel {
     };
   }
 
+  unRegChannel(eventName: string, callback: Function): boolean {
+    const listeners = this.channelMap.get(eventName);
+
+    if (!listeners) {
+      return false;
+    }
+
+    const index = listeners.indexOf(callback);
+
+    if (index === -1) {
+      return false;
+    }
+
+    listeners.splice(index, 1);
+
+    // If no listeners remain for this event, remove the event from the map
+    if (listeners.length === 0) {
+      this.channelMap.delete(eventName);
+    }
+
+    return true;
+  }
+
   send(eventName: string, arg: any): Promise<any> {
     const uniqueId = `${new Date().getTime()}#${eventName}@${Math.random().toString(
       12

package/plugin/index.ts

@@ -225,6 +225,13 @@ export interface IFeatureLifeCycle {
     /** Activation data if shouldActivate is true */
     activation?: any
   } | void>
+
+  /**
+   * Called when plugin storage changes.
+   * @param key - The storage key that changed
+   * @param value - The new value (undefined if key was removed)
+   */
+  onStorageChange?(key: string, value: any): void
 }
 
 /**

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

@@ -7,12 +7,12 @@
 // 获取SDK实例
 const sdk = window.$touchSDK
 
-// 示例1: 监听整个配置文件的变化
+// 示例1: 监听特定配置文件的变化
 function setupConfigListener() {
-  console.log('[Storage] Setting up listener for entire config changes')
+  console.log('[Storage] Setting up listener for config.json changes')
 
-  const unsubscribe = sdk.storage.onDidChange((newConfig) => {
-    console.log('[Storage] Config changed:')
+  const unsubscribe = sdk.storage.onDidChange('config.json', (newConfig) => {
+    console.log('[Storage] config.json changed:')
     console.log('  New config:', newConfig)
 
     // 处理特定键的变化
@@ -25,27 +25,43 @@ function setupConfigListener() {
   return unsubscribe
 }
 
-// 示例2: 监听配置变化并处理特定键
-function setupConfigChangeHandler() {
-  console.log('[Storage] Setting up config change handler')
+// 示例2: 监听多个配置文件的变化
+function setupMultipleFileListeners() {
+  console.log('[Storage] Setting up multiple file listeners')
 
-  const unsubscribe = sdk.storage.onDidChange((newConfig) => {
-    console.log('[Storage] Config changed:')
-    console.log('  New config:', newConfig)
+  const unsubscribers = []
 
-    // 处理特定键的变化
+  // 监听 config.json
+  const configUnsubscribe = sdk.storage.onDidChange('config.json', (newConfig) => {
+    console.log('[Storage] config.json changed:', newConfig)
     if (newConfig.user_preference) {
       handleUserPreferenceChange(newConfig.user_preference)
     }
-    if (newConfig.settings) {
-      handleSettingsChange(newConfig.settings)
+  })
+  unsubscribers.push(configUnsubscribe)
+
+  // 监听 settings.json
+  const settingsUnsubscribe = sdk.storage.onDidChange('settings.json', (newSettings) => {
+    console.log('[Storage] settings.json changed:', newSettings)
+    if (newSettings) {
+      handleSettingsChange(newSettings)
     }
-    if (newConfig.cache) {
-      handleCacheChange(newConfig.cache)
+  })
+  unsubscribers.push(settingsUnsubscribe)
+
+  // 监听 cache.json
+  const cacheUnsubscribe = sdk.storage.onDidChange('cache.json', (newCache) => {
+    console.log('[Storage] cache.json changed:', newCache)
+    if (newCache) {
+      handleCacheChange(newCache)
     }
   })
+  unsubscribers.push(cacheUnsubscribe)
 
-  return unsubscribe
+  // 返回取消所有监听的函数
+  return () => {
+    unsubscribers.forEach(unsubscribe => unsubscribe())
+  }
 }
 
 // 示例3: 动态监听
@@ -53,16 +69,16 @@ function setupDynamicListener() {
   let currentListener = null
 
   // 开始监听
-  function startListening() {
-    console.log('[Storage] Starting to listen for config changes')
+  function startListening(fileName) {
+    console.log(`[Storage] Starting to listen for ${fileName} changes`)
 
     // 如果已有监听器，先取消
     if (currentListener) {
       currentListener()
     }
 
-    currentListener = sdk.storage.onDidChange((newConfig) => {
-      console.log('[Storage] Dynamic listener for config changes:')
+    currentListener = sdk.storage.onDidChange(fileName, (newConfig) => {
+      console.log(`[Storage] Dynamic listener for ${fileName} changes:`)
       console.log('  New config:', newConfig)
     })
   }
@@ -81,9 +97,9 @@ function setupDynamicListener() {
 
 // 示例4: 条件监听
 function setupConditionalListener() {
-  console.log('[Storage] Setting up conditional listener')
+  console.log('[Storage] Setting up conditional listener for user preferences')
 
-  const unsubscribe = sdk.storage.onDidChange((newConfig) => {
+  const unsubscribe = sdk.storage.onDidChange('config.json', (newConfig) => {
     // 处理用户偏好变化
     if (newConfig.user_preference) {
       const pref = newConfig.user_preference
@@ -109,17 +125,17 @@ function setupConditionalListener() {
 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))
+  const unsubscribe = sdk.storage.onDidChange('batch_data.json', (newConfig) => {
+    console.log('[Storage] batch_data.json changed:')
+    console.log('  New config:', newConfig)
 
     // 处理批量数据变化
-    if (newConfig.batch_data) {
+    if (newConfig) {
       console.log('[Storage] Processing batch data changes')
-      console.log('  Batch data count:', Object.keys(newConfig.batch_data).length)
+      console.log('  Batch data count:', Object.keys(newConfig).length)
 
       // 应用变化
-      applyChanges(newConfig.batch_data)
+      applyChanges(newConfig)
     }
   })
 
@@ -166,7 +182,7 @@ function applyChanges(changes) {
 // 导出函数供外部调用
 window.storageOnDidChangeExample = {
   setupConfigListener,
-  setupConfigChangeHandler,
+  setupMultipleFileListeners,
   setupDynamicListener,
   setupConditionalListener,
   setupBatchOperationListener
@@ -179,8 +195,8 @@ if (typeof window !== 'undefined' && window.location.hostname === 'localhost') {
   // 设置配置监听
   const unsubscribe1 = setupConfigListener()
 
-  // 设置配置变化处理器
-  const unsubscribeAll = setupConfigChangeHandler()
+  // 设置多文件监听
+  const unsubscribeAll = setupMultipleFileListeners()
 
   // 设置动态监听
   const { startListening, stopListening } = setupDynamicListener()

package/plugin/sdk/storage.ts

@@ -1,8 +1,7 @@
 /**
  * Get the storage for the current plugin.
- * It provides a simple key-value store that is persisted across application launches.
- * The data is stored in a JSON file in the application's support directory.
- * Each plugin has its own separate storage file.
+ * It provides file-based storage that is persisted across application launches.
+ * Each plugin can have multiple storage files in its own directory.
  *
  * @returns An object with methods to interact with the storage.
  */
@@ -18,66 +17,60 @@ export function usePluginStorage() {
 
   return {
     /**
-     * Retrieves an item from the storage.
-     * @param key The key of the item to retrieve.
-     * @returns A promise that resolves with the value of the item, or null if the item does not exist.
+     * Retrieves the content of a storage file.
+     * @param fileName The name of the file to retrieve.
+     * @returns A promise that resolves with the file content, or null if the file does not exist.
      */
-    getItem: async (key: string): Promise<any> => {
-      return channel.send('plugin:storage:get-item', { pluginName, key })
+    getItem: async (fileName: string): Promise<any> => {
+      return channel.send('plugin:storage:get-file', { pluginName, fileName })
     },
 
     /**
-     * Stores an item in the storage.
-     * @param key The key of the item to store.
-     * @param value The value of the item to store.
-     * @returns A promise that resolves when the item has been stored.
+     * Stores content to a storage file.
+     * @param fileName The name of the file to store.
+     * @param content The content to store in the file.
+     * @returns A promise that resolves when the file has been stored.
      */
-    setItem: async (key: string, value: any): Promise<{ success: boolean, error?: string }> => {
-      return channel.send('plugin:storage:set-item', { pluginName, key, value: JSON.parse(JSON.stringify(value)) })
+    setItem: async (fileName: string, content: any): Promise<{ success: boolean, error?: string }> => {
+      return channel.send('plugin:storage:save-file', { pluginName, fileName, content: JSON.parse(JSON.stringify(content)) })
     },
 
     /**
-     * Removes an item from the storage.
-     * @param key The key of the item to remove.
-     * @returns A promise that resolves when the item has been removed.
+     * Removes a storage file.
+     * @param fileName The name of the file to remove.
+     * @returns A promise that resolves when the file has been removed.
      */
-    removeItem: async (key: string): Promise<{ success: boolean, error?: string }> => {
-      return channel.send('plugin:storage:remove-item', { pluginName, key })
+    removeItem: async (fileName: string): Promise<{ success: boolean, error?: string }> => {
+      return channel.send('plugin:storage:remove-file', { pluginName, fileName })
     },
 
     /**
-     * Clears all items from the storage for the current plugin.
-     * @returns A promise that resolves when the storage has been cleared.
+     * Lists all storage files for the current plugin.
+     * @returns A promise that resolves with an array of file names.
      */
-    clear: async (): Promise<{ success: boolean, error?: string }> => {
-      return channel.send('plugin:storage:clear', { pluginName })
-    },
-
-    /**
-     * Retrieves all items from the storage for the current plugin.
-     * @returns A promise that resolves with an object containing all items.
-     */
-    getAllItems: async (): Promise<Record<string, any>> => {
-      return channel.send('plugin:storage:get-all', { pluginName })
+    getAllItems: async (): Promise<string[]> => {
+      return channel.send('plugin:storage:list-files', { pluginName })
     },
 
     /**
      * Listens for changes to the storage.
      * When `clear()` is called, the key will be `__clear__`.
+     * @param fileName The file name to listen for changes
      * @param callback The function to call when the storage changes for the current plugin.
      * @returns A function to unsubscribe from the listener.
      */
-    onDidChange: (callback: (data: { name: string, key?: string }) => void) => {
-      const listener = (data: { name: string, key?: string }) => {
-        if (data.name === pluginName) {
+    onDidChange: (fileName: string, callback: (newConfig: any) => void) => {
+      const listener = (data: { name: string, fileName?: string, key?: string }) => {
+        if (data.name === pluginName &&
+            (data.fileName === fileName || data.fileName === undefined)) {
           callback(data)
         }
       }
 
-      channel.on('plugin:storage:update', listener)
+      channel.regChannel('plugin:storage:update', listener)
 
       return () => {
-        channel.off('plugin:storage:update', listener)
+        channel.unRegChannel('plugin:storage:update', listener)
       }
     }
   }