@metamask-previews/storage-service 1.0.0-preview-e493d3e8 → 1.0.0-preview-81c9cf83

package/dist/StorageService.cjs

@@ -0,0 +1,203 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _StorageService_messenger, _StorageService_storage;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StorageService = void 0;
+const InMemoryStorageAdapter_1 = require("./InMemoryStorageAdapter.cjs");
+const types_1 = require("./types.cjs");
+// === MESSENGER ===
+const MESSENGER_EXPOSED_METHODS = [
+    'setItem',
+    'getItem',
+    'removeItem',
+    'getAllKeys',
+    'clear',
+];
+/**
+ * StorageService provides a platform-agnostic way for controllers to store
+ * large, infrequently accessed data outside of memory/Redux state.
+ *
+ * **Use cases:**
+ * - Snap source code (6+ MB that's rarely accessed)
+ * - Token metadata caches (4+ MB of cached data)
+ * - Large cached responses from APIs
+ * - Any data > 100 KB that's not frequently accessed
+ *
+ * **Benefits:**
+ * - Reduces memory usage (data stays on disk)
+ * - Faster Redux persist (less data to serialize)
+ * - Faster app startup (less data to parse)
+ * - Lazy loading (data loaded only when needed)
+ *
+ * **Platform Support:**
+ * - Mobile: FilesystemStorage adapter
+ * - Extension: IndexedDB adapter
+ * - Tests/Dev: InMemoryStorageAdapter (default)
+ *
+ * @example Using the service via messenger
+ *
+ * ```typescript
+ * // In a controller
+ * type AllowedActions =
+ *   | StorageServiceSetItemAction
+ *   | StorageServiceGetItemAction;
+ *
+ * class SnapController extends BaseController {
+ *   async storeSnapSourceCode(snapId: string, sourceCode: string) {
+ *     await this.messenger.call(
+ *       'StorageService:setItem',
+ *       'SnapController',
+ *       `${snapId}:sourceCode`,
+ *       sourceCode,
+ *     );
+ *   }
+ *
+ *   async getSnapSourceCode(snapId: string): Promise<string | null> {
+ *     const result = await this.messenger.call(
+ *       'StorageService:getItem',
+ *       'SnapController',
+ *       `${snapId}:sourceCode`,
+ *     );
+ *     return result as string | null; // Caller must validate/cast
+ *   }
+ * }
+ * ```
+ *
+ * @example Initializing in a client
+ *
+ * ```typescript
+ * // Mobile
+ * const service = new StorageService({
+ *   messenger: storageServiceMessenger,
+ *   storage: filesystemStorageAdapter, // Platform-specific
+ * });
+ *
+ * // Extension
+ * const service = new StorageService({
+ *   messenger: storageServiceMessenger,
+ *   storage: indexedDBAdapter, // Platform-specific
+ * });
+ *
+ * // Tests (uses in-memory by default)
+ * const service = new StorageService({
+ *   messenger: storageServiceMessenger,
+ *   // No storage - uses InMemoryStorageAdapter
+ * });
+ * ```
+ */
+class StorageService {
+    /**
+     * Constructs a new StorageService.
+     *
+     * @param options - The options.
+     * @param options.messenger - The messenger suited for this service.
+     * @param options.storage - Storage adapter for persisting data.
+     * If not provided, uses InMemoryStorageAdapter (data lost on restart).
+     */
+    constructor({ messenger, storage }) {
+        /**
+         * The messenger suited for this service.
+         */
+        _StorageService_messenger.set(this, void 0);
+        /**
+         * The storage adapter for persisting data.
+         */
+        _StorageService_storage.set(this, void 0);
+        this.name = types_1.SERVICE_NAME;
+        __classPrivateFieldSet(this, _StorageService_messenger, messenger, "f");
+        __classPrivateFieldSet(this, _StorageService_storage, storage ?? new InMemoryStorageAdapter_1.InMemoryStorageAdapter(), "f");
+        // Warn if using in-memory storage (data won't persist)
+        if (!storage) {
+            console.warn(`${types_1.SERVICE_NAME}: No storage adapter provided. Using in-memory storage. ` +
+                'Data will be lost on restart. Provide a storage adapter for persistence.');
+        }
+        // Register messenger actions
+        __classPrivateFieldGet(this, _StorageService_messenger, "f").registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
+    }
+    /**
+     * Store large data in storage.
+     *
+     * ⚠️ **Designed for large values (100KB+), not many small ones.**
+     * Each storage operation has I/O overhead. For best performance,
+     * store one large object rather than many small key-value pairs.
+     *
+     * @example Good: Store entire cache as one value
+     * ```typescript
+     * await service.setItem('TokenList', 'cache', { '0x1': [...], '0x38': [...] });
+     * ```
+     *
+     * @example Avoid: Many small values
+     * ```typescript
+     * // ❌ Don't do this - too many small writes
+     * await service.setItem('TokenList', 'cache:0x1', [...]);
+     * await service.setItem('TokenList', 'cache:0x38', [...]);
+     * ```
+     *
+     * @param namespace - Controller namespace (e.g., 'SnapController').
+     * @param key - Storage key (e.g., 'npm:@metamask/example-snap:sourceCode').
+     * @param value - Data to store (should be 100KB+ for optimal use).
+     */
+    async setItem(namespace, key, value) {
+        // Adapter handles serialization and wrapping with metadata
+        await __classPrivateFieldGet(this, _StorageService_storage, "f").setItem(namespace, key, value);
+        // Publish event so other controllers can react to changes
+        // Event type: StorageService:itemSet:namespace
+        // Payload: [value, key]
+        __classPrivateFieldGet(this, _StorageService_messenger, "f").publish(`${types_1.SERVICE_NAME}:itemSet:${namespace}`, value, key);
+    }
+    /**
+     * Retrieve data from storage.
+     *
+     * Returns `unknown` since there's no schema validation.
+     * Callers should validate or cast the result to the expected type.
+     *
+     * @param namespace - Controller namespace (e.g., 'SnapController').
+     * @param key - Storage key (e.g., 'npm:@metamask/example-snap:sourceCode').
+     * @returns Parsed data or null if not found. Type is `unknown` - caller must validate.
+     */
+    async getItem(namespace, key) {
+        // Adapter handles deserialization and unwrapping
+        return await __classPrivateFieldGet(this, _StorageService_storage, "f").getItem(namespace, key);
+    }
+    /**
+     * Remove data from storage.
+     *
+     * @param namespace - Controller namespace (e.g., 'SnapController').
+     * @param key - Storage key (e.g., 'npm:@metamask/example-snap:sourceCode').
+     */
+    async removeItem(namespace, key) {
+        // Adapter builds full storage key (e.g., mobile: 'storageService:namespace:key')
+        await __classPrivateFieldGet(this, _StorageService_storage, "f").removeItem(namespace, key);
+    }
+    /**
+     * Get all keys for a namespace.
+     * Delegates to storage adapter which handles filtering.
+     *
+     * @param namespace - Controller namespace (e.g., 'SnapController').
+     * @returns Array of keys (without prefix) for this namespace.
+     */
+    async getAllKeys(namespace) {
+        return await __classPrivateFieldGet(this, _StorageService_storage, "f").getAllKeys(namespace);
+    }
+    /**
+     * Clear all data for a namespace.
+     *
+     * @param namespace - Controller namespace (e.g., 'SnapController').
+     */
+    async clear(namespace) {
+        await __classPrivateFieldGet(this, _StorageService_storage, "f").clear(namespace);
+    }
+}
+exports.StorageService = StorageService;
+_StorageService_messenger = new WeakMap(), _StorageService_storage = new WeakMap();
+//# sourceMappingURL=StorageService.cjs.map

package/dist/StorageService.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"StorageService.cjs","sourceRoot":"","sources":["../src/StorageService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,yEAAkE;AAMlE,uCAAuC;AAEvC,oBAAoB;AAEpB,MAAM,yBAAyB,GAAG;IAChC,SAAS;IACT,SAAS;IACT,YAAY;IACZ,YAAY;IACZ,OAAO;CACC,CAAC;AAEX;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuEG;AACH,MAAa,cAAc;IAgBzB;;;;;;;OAOG;IACH,YAAY,EAAE,SAAS,EAAE,OAAO,EAAyB;QAlBzD;;WAEG;QACM,4CAAoC;QAE7C;;WAEG;QACM,0CAAyB;QAWhC,IAAI,CAAC,IAAI,GAAG,oBAAY,CAAC;QACzB,uBAAA,IAAI,6BAAc,SAAS,MAAA,CAAC;QAC5B,uBAAA,IAAI,2BAAY,OAAO,IAAI,IAAI,+CAAsB,EAAE,MAAA,CAAC;QAExD,uDAAuD;QACvD,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,CAAC,IAAI,CACV,GAAG,oBAAY,0DAA0D;gBACvE,0EAA0E,CAC7E,CAAC;QACJ,CAAC;QAED,6BAA6B;QAC7B,uBAAA,IAAI,iCAAW,CAAC,4BAA4B,CAC1C,IAAI,EACJ,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,CAAC,OAAO,CAAC,SAAiB,EAAE,GAAW,EAAE,KAAc;QAC1D,2DAA2D;QAC3D,MAAM,uBAAA,IAAI,+BAAS,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;QAEnD,0DAA0D;QAC1D,+CAA+C;QAC/C,wBAAwB;QACxB,uBAAA,IAAI,iCAAW,CAAC,OAAO,CACrB,GAAG,oBAAY,YAAY,SAAS,EAAW,EAC/C,KAAK,EACL,GAAG,CACJ,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,OAAO,CAAC,SAAiB,EAAE,GAAW;QAC1C,iDAAiD;QACjD,OAAO,MAAM,uBAAA,IAAI,+BAAS,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;IACrD,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,UAAU,CAAC,SAAiB,EAAE,GAAW;QAC7C,iFAAiF;QACjF,MAAM,uBAAA,IAAI,+BAAS,CAAC,UAAU,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,UAAU,CAAC,SAAiB;QAChC,OAAO,MAAM,uBAAA,IAAI,+BAAS,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACnD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,KAAK,CAAC,SAAiB;QAC3B,MAAM,uBAAA,IAAI,+BAAS,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IACvC,CAAC;CACF;AA9HD,wCA8HC","sourcesContent":["import { InMemoryStorageAdapter } from './InMemoryStorageAdapter';\nimport type {\n  StorageAdapter,\n  StorageServiceMessenger,\n  StorageServiceOptions,\n} from './types';\nimport { SERVICE_NAME } from './types';\n\n// === MESSENGER ===\n\nconst MESSENGER_EXPOSED_METHODS = [\n  'setItem',\n  'getItem',\n  'removeItem',\n  'getAllKeys',\n  'clear',\n] as const;\n\n/**\n * StorageService provides a platform-agnostic way for controllers to store\n * large, infrequently accessed data outside of memory/Redux state.\n *\n * **Use cases:**\n * - Snap source code (6+ MB that's rarely accessed)\n * - Token metadata caches (4+ MB of cached data)\n * - Large cached responses from APIs\n * - Any data > 100 KB that's not frequently accessed\n *\n * **Benefits:**\n * - Reduces memory usage (data stays on disk)\n * - Faster Redux persist (less data to serialize)\n * - Faster app startup (less data to parse)\n * - Lazy loading (data loaded only when needed)\n *\n * **Platform Support:**\n * - Mobile: FilesystemStorage adapter\n * - Extension: IndexedDB adapter\n * - Tests/Dev: InMemoryStorageAdapter (default)\n *\n * @example Using the service via messenger\n *\n * ```typescript\n * // In a controller\n * type AllowedActions =\n *   | StorageServiceSetItemAction\n *   | StorageServiceGetItemAction;\n *\n * class SnapController extends BaseController {\n *   async storeSnapSourceCode(snapId: string, sourceCode: string) {\n *     await this.messenger.call(\n *       'StorageService:setItem',\n *       'SnapController',\n *       `${snapId}:sourceCode`,\n *       sourceCode,\n *     );\n *   }\n *\n *   async getSnapSourceCode(snapId: string): Promise<string | null> {\n *     const result = await this.messenger.call(\n *       'StorageService:getItem',\n *       'SnapController',\n *       `${snapId}:sourceCode`,\n *     );\n *     return result as string | null; // Caller must validate/cast\n *   }\n * }\n * ```\n *\n * @example Initializing in a client\n *\n * ```typescript\n * // Mobile\n * const service = new StorageService({\n *   messenger: storageServiceMessenger,\n *   storage: filesystemStorageAdapter, // Platform-specific\n * });\n *\n * // Extension\n * const service = new StorageService({\n *   messenger: storageServiceMessenger,\n *   storage: indexedDBAdapter, // Platform-specific\n * });\n *\n * // Tests (uses in-memory by default)\n * const service = new StorageService({\n *   messenger: storageServiceMessenger,\n *   // No storage - uses InMemoryStorageAdapter\n * });\n * ```\n */\nexport class StorageService {\n  /**\n   * The name of the service.\n   */\n  readonly name: typeof SERVICE_NAME;\n\n  /**\n   * The messenger suited for this service.\n   */\n  readonly #messenger: StorageServiceMessenger;\n\n  /**\n   * The storage adapter for persisting data.\n   */\n  readonly #storage: StorageAdapter;\n\n  /**\n   * Constructs a new StorageService.\n   *\n   * @param options - The options.\n   * @param options.messenger - The messenger suited for this service.\n   * @param options.storage - Storage adapter for persisting data.\n   * If not provided, uses InMemoryStorageAdapter (data lost on restart).\n   */\n  constructor({ messenger, storage }: StorageServiceOptions) {\n    this.name = SERVICE_NAME;\n    this.#messenger = messenger;\n    this.#storage = storage ?? new InMemoryStorageAdapter();\n\n    // Warn if using in-memory storage (data won't persist)\n    if (!storage) {\n      console.warn(\n        `${SERVICE_NAME}: No storage adapter provided. Using in-memory storage. ` +\n          'Data will be lost on restart. Provide a storage adapter for persistence.',\n      );\n    }\n\n    // Register messenger actions\n    this.#messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n  }\n\n  /**\n   * Store large data in storage.\n   *\n   * ⚠️ **Designed for large values (100KB+), not many small ones.**\n   * Each storage operation has I/O overhead. For best performance,\n   * store one large object rather than many small key-value pairs.\n   *\n   * @example Good: Store entire cache as one value\n   * ```typescript\n   * await service.setItem('TokenList', 'cache', { '0x1': [...], '0x38': [...] });\n   * ```\n   *\n   * @example Avoid: Many small values\n   * ```typescript\n   * // ❌ Don't do this - too many small writes\n   * await service.setItem('TokenList', 'cache:0x1', [...]);\n   * await service.setItem('TokenList', 'cache:0x38', [...]);\n   * ```\n   *\n   * @param namespace - Controller namespace (e.g., 'SnapController').\n   * @param key - Storage key (e.g., 'npm:@metamask/example-snap:sourceCode').\n   * @param value - Data to store (should be 100KB+ for optimal use).\n   */\n  async setItem(namespace: string, key: string, value: unknown): Promise<void> {\n    // Adapter handles serialization and wrapping with metadata\n    await this.#storage.setItem(namespace, key, value);\n\n    // Publish event so other controllers can react to changes\n    // Event type: StorageService:itemSet:namespace\n    // Payload: [value, key]\n    this.#messenger.publish(\n      `${SERVICE_NAME}:itemSet:${namespace}` as const,\n      value,\n      key,\n    );\n  }\n\n  /**\n   * Retrieve data from storage.\n   *\n   * Returns `unknown` since there's no schema validation.\n   * Callers should validate or cast the result to the expected type.\n   *\n   * @param namespace - Controller namespace (e.g., 'SnapController').\n   * @param key - Storage key (e.g., 'npm:@metamask/example-snap:sourceCode').\n   * @returns Parsed data or null if not found. Type is `unknown` - caller must validate.\n   */\n  async getItem(namespace: string, key: string): Promise<unknown> {\n    // Adapter handles deserialization and unwrapping\n    return await this.#storage.getItem(namespace, key);\n  }\n\n  /**\n   * Remove data from storage.\n   *\n   * @param namespace - Controller namespace (e.g., 'SnapController').\n   * @param key - Storage key (e.g., 'npm:@metamask/example-snap:sourceCode').\n   */\n  async removeItem(namespace: string, key: string): Promise<void> {\n    // Adapter builds full storage key (e.g., mobile: 'storageService:namespace:key')\n    await this.#storage.removeItem(namespace, key);\n  }\n\n  /**\n   * Get all keys for a namespace.\n   * Delegates to storage adapter which handles filtering.\n   *\n   * @param namespace - Controller namespace (e.g., 'SnapController').\n   * @returns Array of keys (without prefix) for this namespace.\n   */\n  async getAllKeys(namespace: string): Promise<string[]> {\n    return await this.#storage.getAllKeys(namespace);\n  }\n\n  /**\n   * Clear all data for a namespace.\n   *\n   * @param namespace - Controller namespace (e.g., 'SnapController').\n   */\n  async clear(namespace: string): Promise<void> {\n    await this.#storage.clear(namespace);\n  }\n}\n"]}

package/dist/StorageService.d.cts

@@ -0,0 +1,147 @@
+import type { StorageServiceOptions } from "./types.cjs";
+import { SERVICE_NAME } from "./types.cjs";
+/**
+ * StorageService provides a platform-agnostic way for controllers to store
+ * large, infrequently accessed data outside of memory/Redux state.
+ *
+ * **Use cases:**
+ * - Snap source code (6+ MB that's rarely accessed)
+ * - Token metadata caches (4+ MB of cached data)
+ * - Large cached responses from APIs
+ * - Any data > 100 KB that's not frequently accessed
+ *
+ * **Benefits:**
+ * - Reduces memory usage (data stays on disk)
+ * - Faster Redux persist (less data to serialize)
+ * - Faster app startup (less data to parse)
+ * - Lazy loading (data loaded only when needed)
+ *
+ * **Platform Support:**
+ * - Mobile: FilesystemStorage adapter
+ * - Extension: IndexedDB adapter
+ * - Tests/Dev: InMemoryStorageAdapter (default)
+ *
+ * @example Using the service via messenger
+ *
+ * ```typescript
+ * // In a controller
+ * type AllowedActions =
+ *   | StorageServiceSetItemAction
+ *   | StorageServiceGetItemAction;
+ *
+ * class SnapController extends BaseController {
+ *   async storeSnapSourceCode(snapId: string, sourceCode: string) {
+ *     await this.messenger.call(
+ *       'StorageService:setItem',
+ *       'SnapController',
+ *       `${snapId}:sourceCode`,
+ *       sourceCode,
+ *     );
+ *   }
+ *
+ *   async getSnapSourceCode(snapId: string): Promise<string | null> {
+ *     const result = await this.messenger.call(
+ *       'StorageService:getItem',
+ *       'SnapController',
+ *       `${snapId}:sourceCode`,
+ *     );
+ *     return result as string | null; // Caller must validate/cast
+ *   }
+ * }
+ * ```
+ *
+ * @example Initializing in a client
+ *
+ * ```typescript
+ * // Mobile
+ * const service = new StorageService({
+ *   messenger: storageServiceMessenger,
+ *   storage: filesystemStorageAdapter, // Platform-specific
+ * });
+ *
+ * // Extension
+ * const service = new StorageService({
+ *   messenger: storageServiceMessenger,
+ *   storage: indexedDBAdapter, // Platform-specific
+ * });
+ *
+ * // Tests (uses in-memory by default)
+ * const service = new StorageService({
+ *   messenger: storageServiceMessenger,
+ *   // No storage - uses InMemoryStorageAdapter
+ * });
+ * ```
+ */
+export declare class StorageService {
+    #private;
+    /**
+     * The name of the service.
+     */
+    readonly name: typeof SERVICE_NAME;
+    /**
+     * Constructs a new StorageService.
+     *
+     * @param options - The options.
+     * @param options.messenger - The messenger suited for this service.
+     * @param options.storage - Storage adapter for persisting data.
+     * If not provided, uses InMemoryStorageAdapter (data lost on restart).
+     */
+    constructor({ messenger, storage }: StorageServiceOptions);
+    /**
+     * Store large data in storage.
+     *
+     * ⚠️ **Designed for large values (100KB+), not many small ones.**
+     * Each storage operation has I/O overhead. For best performance,
+     * store one large object rather than many small key-value pairs.
+     *
+     * @example Good: Store entire cache as one value
+     * ```typescript
+     * await service.setItem('TokenList', 'cache', { '0x1': [...], '0x38': [...] });
+     * ```
+     *
+     * @example Avoid: Many small values
+     * ```typescript
+     * // ❌ Don't do this - too many small writes
+     * await service.setItem('TokenList', 'cache:0x1', [...]);
+     * await service.setItem('TokenList', 'cache:0x38', [...]);
+     * ```
+     *
+     * @param namespace - Controller namespace (e.g., 'SnapController').
+     * @param key - Storage key (e.g., 'npm:@metamask/example-snap:sourceCode').
+     * @param value - Data to store (should be 100KB+ for optimal use).
+     */
+    setItem(namespace: string, key: string, value: unknown): Promise<void>;
+    /**
+     * Retrieve data from storage.
+     *
+     * Returns `unknown` since there's no schema validation.
+     * Callers should validate or cast the result to the expected type.
+     *
+     * @param namespace - Controller namespace (e.g., 'SnapController').
+     * @param key - Storage key (e.g., 'npm:@metamask/example-snap:sourceCode').
+     * @returns Parsed data or null if not found. Type is `unknown` - caller must validate.
+     */
+    getItem(namespace: string, key: string): Promise<unknown>;
+    /**
+     * Remove data from storage.
+     *
+     * @param namespace - Controller namespace (e.g., 'SnapController').
+     * @param key - Storage key (e.g., 'npm:@metamask/example-snap:sourceCode').
+     */
+    removeItem(namespace: string, key: string): Promise<void>;
+    /**
+     * Get all keys for a namespace.
+     * Delegates to storage adapter which handles filtering.
+     *
+     * @param namespace - Controller namespace (e.g., 'SnapController').
+     * @returns Array of keys (without prefix) for this namespace.
+     */
+    getAllKeys(namespace: string): Promise<string[]>;
+    /**
+     * Clear all data for a namespace.
+     *
+     * @param namespace - Controller namespace (e.g., 'SnapController').
+     */
+    clear(namespace: string): Promise<void>;
+}
+//# sourceMappingURL=StorageService.d.cts.map

package/dist/StorageService.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StorageService.d.cts","sourceRoot":"","sources":["../src/StorageService.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAGV,qBAAqB,EACtB,oBAAgB;AACjB,OAAO,EAAE,YAAY,EAAE,oBAAgB;AAYvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuEG;AACH,qBAAa,cAAc;;IACzB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,YAAY,CAAC;IAYnC;;;;;;;OAOG;gBACS,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,qBAAqB;IAoBzD;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAc5E;;;;;;;;;OASG;IACG,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAK/D;;;;;OAKG;IACG,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAK/D;;;;;;OAMG;IACG,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAItD;;;;OAIG;IACG,KAAK,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAG9C"}

package/dist/StorageService.d.mts

@@ -0,0 +1,147 @@
+import type { StorageServiceOptions } from "./types.mjs";
+import { SERVICE_NAME } from "./types.mjs";
+/**
+ * StorageService provides a platform-agnostic way for controllers to store
+ * large, infrequently accessed data outside of memory/Redux state.
+ *
+ * **Use cases:**
+ * - Snap source code (6+ MB that's rarely accessed)
+ * - Token metadata caches (4+ MB of cached data)
+ * - Large cached responses from APIs
+ * - Any data > 100 KB that's not frequently accessed
+ *
+ * **Benefits:**
+ * - Reduces memory usage (data stays on disk)
+ * - Faster Redux persist (less data to serialize)
+ * - Faster app startup (less data to parse)
+ * - Lazy loading (data loaded only when needed)
+ *
+ * **Platform Support:**
+ * - Mobile: FilesystemStorage adapter
+ * - Extension: IndexedDB adapter
+ * - Tests/Dev: InMemoryStorageAdapter (default)
+ *
+ * @example Using the service via messenger
+ *
+ * ```typescript
+ * // In a controller
+ * type AllowedActions =
+ *   | StorageServiceSetItemAction
+ *   | StorageServiceGetItemAction;
+ *
+ * class SnapController extends BaseController {
+ *   async storeSnapSourceCode(snapId: string, sourceCode: string) {
+ *     await this.messenger.call(
+ *       'StorageService:setItem',
+ *       'SnapController',
+ *       `${snapId}:sourceCode`,
+ *       sourceCode,
+ *     );
+ *   }
+ *
+ *   async getSnapSourceCode(snapId: string): Promise<string | null> {
+ *     const result = await this.messenger.call(
+ *       'StorageService:getItem',
+ *       'SnapController',
+ *       `${snapId}:sourceCode`,
+ *     );
+ *     return result as string | null; // Caller must validate/cast
+ *   }
+ * }
+ * ```
+ *
+ * @example Initializing in a client
+ *
+ * ```typescript
+ * // Mobile
+ * const service = new StorageService({
+ *   messenger: storageServiceMessenger,
+ *   storage: filesystemStorageAdapter, // Platform-specific
+ * });
+ *
+ * // Extension
+ * const service = new StorageService({
+ *   messenger: storageServiceMessenger,
+ *   storage: indexedDBAdapter, // Platform-specific
+ * });
+ *
+ * // Tests (uses in-memory by default)
+ * const service = new StorageService({
+ *   messenger: storageServiceMessenger,
+ *   // No storage - uses InMemoryStorageAdapter
+ * });
+ * ```
+ */
+export declare class StorageService {
+    #private;
+    /**
+     * The name of the service.
+     */
+    readonly name: typeof SERVICE_NAME;
+    /**
+     * Constructs a new StorageService.
+     *
+     * @param options - The options.
+     * @param options.messenger - The messenger suited for this service.
+     * @param options.storage - Storage adapter for persisting data.
+     * If not provided, uses InMemoryStorageAdapter (data lost on restart).
+     */
+    constructor({ messenger, storage }: StorageServiceOptions);
+    /**
+     * Store large data in storage.
+     *
+     * ⚠️ **Designed for large values (100KB+), not many small ones.**
+     * Each storage operation has I/O overhead. For best performance,
+     * store one large object rather than many small key-value pairs.
+     *
+     * @example Good: Store entire cache as one value
+     * ```typescript
+     * await service.setItem('TokenList', 'cache', { '0x1': [...], '0x38': [...] });
+     * ```
+     *
+     * @example Avoid: Many small values
+     * ```typescript
+     * // ❌ Don't do this - too many small writes
+     * await service.setItem('TokenList', 'cache:0x1', [...]);
+     * await service.setItem('TokenList', 'cache:0x38', [...]);
+     * ```
+     *
+     * @param namespace - Controller namespace (e.g., 'SnapController').
+     * @param key - Storage key (e.g., 'npm:@metamask/example-snap:sourceCode').
+     * @param value - Data to store (should be 100KB+ for optimal use).
+     */
+    setItem(namespace: string, key: string, value: unknown): Promise<void>;
+    /**
+     * Retrieve data from storage.
+     *
+     * Returns `unknown` since there's no schema validation.
+     * Callers should validate or cast the result to the expected type.
+     *
+     * @param namespace - Controller namespace (e.g., 'SnapController').
+     * @param key - Storage key (e.g., 'npm:@metamask/example-snap:sourceCode').
+     * @returns Parsed data or null if not found. Type is `unknown` - caller must validate.
+     */
+    getItem(namespace: string, key: string): Promise<unknown>;
+    /**
+     * Remove data from storage.
+     *
+     * @param namespace - Controller namespace (e.g., 'SnapController').
+     * @param key - Storage key (e.g., 'npm:@metamask/example-snap:sourceCode').
+     */
+    removeItem(namespace: string, key: string): Promise<void>;
+    /**
+     * Get all keys for a namespace.
+     * Delegates to storage adapter which handles filtering.
+     *
+     * @param namespace - Controller namespace (e.g., 'SnapController').
+     * @returns Array of keys (without prefix) for this namespace.
+     */
+    getAllKeys(namespace: string): Promise<string[]>;
+    /**
+     * Clear all data for a namespace.
+     *
+     * @param namespace - Controller namespace (e.g., 'SnapController').
+     */
+    clear(namespace: string): Promise<void>;
+}
+//# sourceMappingURL=StorageService.d.mts.map

package/dist/StorageService.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StorageService.d.mts","sourceRoot":"","sources":["../src/StorageService.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAGV,qBAAqB,EACtB,oBAAgB;AACjB,OAAO,EAAE,YAAY,EAAE,oBAAgB;AAYvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuEG;AACH,qBAAa,cAAc;;IACzB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,YAAY,CAAC;IAYnC;;;;;;;OAOG;gBACS,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,qBAAqB;IAoBzD;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAc5E;;;;;;;;;OASG;IACG,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAK/D;;;;;OAKG;IACG,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAK/D;;;;;;OAMG;IACG,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAItD;;;;OAIG;IACG,KAAK,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAG9C"}