@talex-touch/utils 1.0.24 → 1.0.26

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.24",
+  "version": "1.0.26",
   "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

@@ -59,7 +59,7 @@ export interface IPluginBaseInfo {
 export interface IPluginDev {
   enable: boolean
   address: string
-  source?: string // 修改此处，允许 source 为字符串或 undefined
+  source?: boolean
 }
 
 export interface ITouchPlugin extends IPluginBaseInfo {
@@ -81,6 +81,47 @@ export interface ITouchPlugin extends IPluginBaseInfo {
 
   enable(): Promise<boolean>
   disable(): Promise<boolean>
+
+  /**
+   * Get the plugin file.
+   * @param fileName The name of the file.
+   * @returns The content of the file.
+   */
+  getPluginFile(fileName: string): object
+
+  /**
+   * Save the plugin file.
+   * @param fileName The name of the file.
+   * @param content The content of the file.
+   * @returns The result of the save operation.
+   */
+  savePluginFile(fileName: string, content: object): { success: boolean; error?: string }
+
+  /**
+   * Delete the plugin file.
+   * @param fileName The name of the file.
+   * @returns The result of the delete operation.
+   */
+  deletePluginFile(fileName: string): { success: boolean; error?: string }
+
+  /**
+   * List all files in the plugin.
+   * @returns The list of files.
+   */
+  listPluginFiles(): string[]
+
+  /**
+   * Get the plugin configuration.
+   * @returns The configuration content.
+   */
+  getPluginConfig(): object
+
+  /**
+   * Save the plugin configuration.
+   * @param content The configuration content.
+   * @returns The result of the save operation.
+   */
+  savePluginConfig(content: object): { success: boolean; error?: string }
 }
 
 export interface IFeatureCommand {
@@ -124,6 +165,13 @@ export interface IFeatureLifeCycle {
    * Can be used to prepare data or UI specific to this session.
    */
   onInit?(): void
+
+  /**
+   * Called when a message is received from the main application.
+   * @param key - The key of the message
+   * @param info - The information of the message
+   */
+  onMessage?(key: string, info: any): void
   /**
    * Called when a feature is actively launched from the launcher.
    * Can be used to prepare data or UI specific to this session.

package/plugin/sdk/common.ts

@@ -1,28 +1,77 @@
-import { genChannel } from '../channel';
-import { IPluginFeature } from '../index'
+/**
+ * Plugin SDK Common Utilities
+ *
+ * @description
+ * 提供插件SDK的通用功能，包括通信、快捷键等
+ */
 
-export function regShortcut(key: string, func: Function) {
-    const channel = genChannel()
+import { genChannel } from '../channel'
 
-    const res = channel.sendSync('shortcon:reg', { key })
-    if ( res instanceof String ) throw new Error(String(res))
-    if ( res === false ) return false;
+/**
+ * Register a shortcut
+ * @param key - The shortcut combination
+ * @param func - The trigger function
+ * @returns Whether the shortcut is registered successfully
+ */
+export function regShortcut(key: string, func: Function): boolean {
+  const channel = genChannel()
+
+  const res = channel.sendSync('shortcon:reg', { key })
+  if (res instanceof String) throw new Error(String(res))
+  if (res === false) return false
 
-    channel.regChannel('shortcon:trigger', ({ data }) => key === data.key && func())
+  channel.regChannel('shortcon:trigger', ({ data }) => key === data.key && func())
 
-    return true;
+  return true
 }
 
-export function regFeature(feature: IPluginFeature): boolean {
+/**
+ * Communicate with other plugins via the index:communicate channel
+ * @param key - The message key
+ * @param info - The message data
+ * @returns Promise<any> The communication result
+ */
+export async function communicateWithPlugin(
+  key: string,
+  info: any = {}
+): Promise<any> {
   const channel = genChannel()
 
-  return channel.sendSync('feature:reg', { feature })
+  try {
+    return await channel.send('index:communicate', {
+      key,
+      info
+    })
+  } catch (error) {
+    console.error(`[Plugin SDK] Failed to communicate`, error)
+    throw error
+  }
 }
 
-export function unRegFeature(id: string): boolean {
+/**
+ * Send a message to the main application
+ * @param message - The message type
+ * @param data - The message data
+ * @returns Promise<any> The message result
+ */
+export async function sendMessage(message: string, data: any = {}): Promise<any> {
   const channel = genChannel()
 
-  return channel.sendSync('feature:unreg', { feature: id })
+  try {
+    return await channel.send(`plugin:${message}`, data)
+  } catch (error) {
+    console.error(`[Plugin SDK] Failed to send message: ${message}`, error)
+    throw error
+  }
+}
+
+/**
+ * Get the channel object for the plugin
+ * Attention: Using this function make sure you know what you are doing.
+ * @returns The channel object for the plugin
+ */
+export function getChannel() {
+  return genChannel()
 }
 
-export * from './window';
+export * from './window'

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

@@ -0,0 +1,217 @@
+/**
+ * Storage onDidChange 示例
+ * 展示如何使用 storage.onDidChange 监听存储文件变化
+ * 注意：这里只能获取新值，旧值无法获取
+ */
+
+// 获取SDK实例
+const sdk = window.$touchSDK
+
+// 示例1: 监听特定配置文件的变化
+function setupConfigListener() {
+  console.log('[Storage] Setting up listener for config.json changes')
+
+  const unsubscribe = sdk.storage.onDidChange('config.json', (newConfig) => {
+    console.log('[Storage] config.json 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 setupMultipleFileListeners() {
+  console.log('[Storage] Setting up multiple file listeners')
+
+  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)
+    }
+  })
+  unsubscribers.push(configUnsubscribe)
+
+  // 监听 settings.json
+  const settingsUnsubscribe = sdk.storage.onDidChange('settings.json', (newSettings) => {
+    console.log('[Storage] settings.json changed:', newSettings)
+    if (newSettings) {
+      handleSettingsChange(newSettings)
+    }
+  })
+  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 () => {
+    unsubscribers.forEach(unsubscribe => unsubscribe())
+  }
+}
+
+// 示例3: 动态监听
+function setupDynamicListener() {
+  let currentListener = null
+
+  // 开始监听
+  function startListening(fileName) {
+    console.log(`[Storage] Starting to listen for ${fileName} changes`)
+
+    // 如果已有监听器，先取消
+    if (currentListener) {
+      currentListener()
+    }
+
+    currentListener = sdk.storage.onDidChange(fileName, (newConfig) => {
+      console.log(`[Storage] Dynamic listener for ${fileName} 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 for user preferences')
+
+  const unsubscribe = sdk.storage.onDidChange('config.json', (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('batch_data.json', (newConfig) => {
+    console.log('[Storage] batch_data.json changed:')
+    console.log('  New config:', newConfig)
+
+    // 处理批量数据变化
+    if (newConfig) {
+      console.log('[Storage] Processing batch data changes')
+      console.log('  Batch data count:', Object.keys(newConfig).length)
+
+      // 应用变化
+      applyChanges(newConfig)
+    }
+  })
+
+  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,
+  setupMultipleFileListeners,
+  setupDynamicListener,
+  setupConditionalListener,
+  setupBatchOperationListener
+}
+
+// 自动运行示例（可选）
+if (typeof window !== 'undefined' && window.location.hostname === 'localhost') {
+  console.log('[Auto] Setting up storage listeners...')
+
+  // 设置配置监听
+  const unsubscribe1 = setupConfigListener()
+
+  // 设置多文件监听
+  const unsubscribeAll = setupMultipleFileListeners()
+
+  // 设置动态监听
+  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/storage.ts

@@ -74,10 +74,10 @@ export function usePluginStorage() {
         }
       }
 
-      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)
       }
     }
   }