@talex-touch/utils 1.0.28 → 1.0.29

package/package.json

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

package/plugin/sdk/storage.ts

@@ -1,6 +1,6 @@
 /**
  * Get the storage for the current plugin.
- * It provides file-based storage that is persisted across application launches.
+ * It provides simple 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.
@@ -21,7 +21,7 @@ export function usePluginStorage() {
      * @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 (fileName: string): Promise<any> => {
+    getFile: async (fileName: string): Promise<any> => {
       return channel.send('plugin:storage:get-file', { pluginName, fileName })
     },
 
@@ -31,47 +31,25 @@ export function usePluginStorage() {
      * @param content The content to store in the file.
      * @returns A promise that resolves when the file has been stored.
      */
-    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)) })
+    setFile: async (fileName: string, content: any): Promise<{ success: boolean, error?: string }> => {
+      return channel.send('plugin:storage:set-file', { pluginName, fileName, content: JSON.parse(JSON.stringify(content)) })
     },
 
     /**
-     * Removes a storage file.
-     * @param fileName The name of the file to remove.
-     * @returns A promise that resolves when the file has been removed.
+     * Deletes a storage file.
+     * @param fileName The name of the file to delete.
+     * @returns A promise that resolves when the file has been deleted.
      */
-    removeItem: async (fileName: string): Promise<{ success: boolean, error?: string }> => {
-      return channel.send('plugin:storage:remove-file', { pluginName, fileName })
+    deleteFile: async (fileName: string): Promise<{ success: boolean, error?: string }> => {
+      return channel.send('plugin:storage:delete-file', { pluginName, fileName })
     },
 
     /**
      * Lists all storage files for the current plugin.
      * @returns A promise that resolves with an array of file names.
      */
-    getAllItems: async (): Promise<string[]> => {
+    listFiles: 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: (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.regChannel('plugin:storage:update', listener)
-
-      return () => {
-        channel.unRegChannel('plugin:storage:update', listener)
-      }
     }
   }
 }