@talex-touch/utils 1.0.26 → 1.0.27

package/package.json

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

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/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,58 +17,52 @@ 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)
         }
       }