@metamask-previews/storage-service 0.0.0-preview-d6fe4594

package/dist/StorageService.d.cts

@@ -0,0 +1,145 @@
+import type { Json } from "@metamask/utils";
+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 JSON 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 - JSON data to store (should be 100KB+ for optimal use).
+     */
+    setItem(namespace: string, key: string, value: Json): Promise<void>;
+    /**
+     * Retrieve JSON data from storage.
+     *
+     * @param namespace - Controller namespace (e.g., 'SnapController').
+     * @param key - Storage key (e.g., 'npm:@metamask/example-snap:sourceCode').
+     * @returns Parsed JSON data or null if not found.
+     */
+    getItem(namespace: string, key: string): Promise<Json | null>;
+    /**
+     * 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":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAG5C,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,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAczE;;;;;;OAMG;IACG,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;IAKnE;;;;;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,145 @@
+import type { Json } from "@metamask/utils";
+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 JSON 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 - JSON data to store (should be 100KB+ for optimal use).
+     */
+    setItem(namespace: string, key: string, value: Json): Promise<void>;
+    /**
+     * Retrieve JSON data from storage.
+     *
+     * @param namespace - Controller namespace (e.g., 'SnapController').
+     * @param key - Storage key (e.g., 'npm:@metamask/example-snap:sourceCode').
+     * @returns Parsed JSON data or null if not found.
+     */
+    getItem(namespace: string, key: string): Promise<Json | null>;
+    /**
+     * 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":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAG5C,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,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAczE;;;;;;OAMG;IACG,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;IAKnE;;;;;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.mjs

@@ -0,0 +1,196 @@
+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;
+import { InMemoryStorageAdapter } from "./InMemoryStorageAdapter.mjs";
+import { SERVICE_NAME } from "./types.mjs";
+// === 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
+ * });
+ * ```
+ */
+export 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 = SERVICE_NAME;
+        __classPrivateFieldSet(this, _StorageService_messenger, messenger, "f");
+        __classPrivateFieldSet(this, _StorageService_storage, storage ?? new InMemoryStorageAdapter(), "f");
+        // Warn if using in-memory storage (data won't persist)
+        if (!storage) {
+            console.warn(`${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 JSON 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 - JSON 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: [key, value]
+        __classPrivateFieldGet(this, _StorageService_messenger, "f").publish(`${SERVICE_NAME}:itemSet:${namespace}`, key, value);
+    }
+    /**
+     * Retrieve JSON data from storage.
+     *
+     * @param namespace - Controller namespace (e.g., 'SnapController').
+     * @param key - Storage key (e.g., 'npm:@metamask/example-snap:sourceCode').
+     * @returns Parsed JSON data or null if not found.
+     */
+    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);
+    }
+}
+_StorageService_messenger = new WeakMap(), _StorageService_storage = new WeakMap();
+//# sourceMappingURL=StorageService.mjs.map

package/dist/StorageService.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"StorageService.mjs","sourceRoot":"","sources":["../src/StorageService.ts"],"names":[],"mappings":";;;;;;;;;;;;AAEA,OAAO,EAAE,sBAAsB,EAAE,qCAAiC;AAMlE,OAAO,EAAE,YAAY,EAAE,oBAAgB;AAEvC,oBAAoB;AAEpB,MAAM,yBAAyB,GAAG;IAChC,SAAS;IACT,SAAS;IACT,YAAY;IACZ,YAAY;IACZ,OAAO;CACC,CAAC;AAEX;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuEG;AACH,MAAM,OAAO,cAAc;IAgBzB;;;;;;;OAOG;IACH,YAAY,EAAE,SAAS,EAAE,OAAO,EAAyB;QAlBzD;;WAEG;QACM,4CAAoC;QAE7C;;WAEG;QACM,0CAAyB;QAWhC,IAAI,CAAC,IAAI,GAAG,YAAY,CAAC;QACzB,uBAAA,IAAI,6BAAc,SAAS,MAAA,CAAC;QAC5B,uBAAA,IAAI,2BAAY,OAAO,IAAI,IAAI,sBAAsB,EAAE,MAAA,CAAC;QAExD,uDAAuD;QACvD,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,CAAC,IAAI,CACV,GAAG,YAAY,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,KAAW;QACvD,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,YAAY,YAAY,SAAS,EAAW,EAC/C,GAAG,EACH,KAAK,CACN,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;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","sourcesContent":["import type { Json } from '@metamask/utils';\n\nimport { 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 JSON 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 - JSON data to store (should be 100KB+ for optimal use).\n   */\n  async setItem(namespace: string, key: string, value: Json): 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: [key, value]\n    this.#messenger.publish(\n      `${SERVICE_NAME}:itemSet:${namespace}` as const,\n      key,\n      value,\n    );\n  }\n\n  /**\n   * Retrieve JSON 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   * @returns Parsed JSON data or null if not found.\n   */\n  async getItem(namespace: string, key: string): Promise<Json | null> {\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/index.cjs

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.STORAGE_KEY_PREFIX = exports.SERVICE_NAME = exports.InMemoryStorageAdapter = exports.StorageService = void 0;
+// Export service class
+var StorageService_1 = require("./StorageService.cjs");
+Object.defineProperty(exports, "StorageService", { enumerable: true, get: function () { return StorageService_1.StorageService; } });
+// Export adapters
+var InMemoryStorageAdapter_1 = require("./InMemoryStorageAdapter.cjs");
+Object.defineProperty(exports, "InMemoryStorageAdapter", { enumerable: true, get: function () { return InMemoryStorageAdapter_1.InMemoryStorageAdapter; } });
+// Export service name and storage key prefix constants
+var types_1 = require("./types.cjs");
+Object.defineProperty(exports, "SERVICE_NAME", { enumerable: true, get: function () { return types_1.SERVICE_NAME; } });
+Object.defineProperty(exports, "STORAGE_KEY_PREFIX", { enumerable: true, get: function () { return types_1.STORAGE_KEY_PREFIX; } });
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,uBAAuB;AACvB,uDAAkD;AAAzC,gHAAA,cAAc,OAAA;AAEvB,kBAAkB;AAClB,uEAAkE;AAAzD,gIAAA,sBAAsB,OAAA;AAqB/B,uDAAuD;AACvD,qCAA2D;AAAlD,qGAAA,YAAY,OAAA;AAAE,2GAAA,kBAAkB,OAAA","sourcesContent":["// Export service class\nexport { StorageService } from './StorageService';\n\n// Export adapters\nexport { InMemoryStorageAdapter } from './InMemoryStorageAdapter';\n\n// Export types from types.ts\nexport type {\n  StorageAdapter,\n  StorageServiceOptions,\n  StorageServiceActions,\n  StorageServiceEvents,\n  StorageServiceMessenger,\n  StorageServiceItemSetEvent,\n} from './types';\n\n// Export individual action types from generated file\nexport type {\n  StorageServiceSetItemAction,\n  StorageServiceGetItemAction,\n  StorageServiceRemoveItemAction,\n  StorageServiceGetAllKeysAction,\n  StorageServiceClearAction,\n} from './StorageService-method-action-types';\n\n// Export service name and storage key prefix constants\nexport { SERVICE_NAME, STORAGE_KEY_PREFIX } from './types';\n"]}

package/dist/index.d.cts

@@ -0,0 +1,6 @@
+export { StorageService } from "./StorageService.cjs";
+export { InMemoryStorageAdapter } from "./InMemoryStorageAdapter.cjs";
+export type { StorageAdapter, StorageServiceOptions, StorageServiceActions, StorageServiceEvents, StorageServiceMessenger, StorageServiceItemSetEvent, } from "./types.cjs";
+export type { StorageServiceSetItemAction, StorageServiceGetItemAction, StorageServiceRemoveItemAction, StorageServiceGetAllKeysAction, StorageServiceClearAction, } from "./StorageService-method-action-types.cjs";
+export { SERVICE_NAME, STORAGE_KEY_PREFIX } from "./types.cjs";
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,6BAAyB;AAGlD,OAAO,EAAE,sBAAsB,EAAE,qCAAiC;AAGlE,YAAY,EACV,cAAc,EACd,qBAAqB,EACrB,qBAAqB,EACrB,oBAAoB,EACpB,uBAAuB,EACvB,0BAA0B,GAC3B,oBAAgB;AAGjB,YAAY,EACV,2BAA2B,EAC3B,2BAA2B,EAC3B,8BAA8B,EAC9B,8BAA8B,EAC9B,yBAAyB,GAC1B,iDAA6C;AAG9C,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,oBAAgB"}

package/dist/index.d.mts

@@ -0,0 +1,6 @@
+export { StorageService } from "./StorageService.mjs";
+export { InMemoryStorageAdapter } from "./InMemoryStorageAdapter.mjs";
+export type { StorageAdapter, StorageServiceOptions, StorageServiceActions, StorageServiceEvents, StorageServiceMessenger, StorageServiceItemSetEvent, } from "./types.mjs";
+export type { StorageServiceSetItemAction, StorageServiceGetItemAction, StorageServiceRemoveItemAction, StorageServiceGetAllKeysAction, StorageServiceClearAction, } from "./StorageService-method-action-types.mjs";
+export { SERVICE_NAME, STORAGE_KEY_PREFIX } from "./types.mjs";
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,6BAAyB;AAGlD,OAAO,EAAE,sBAAsB,EAAE,qCAAiC;AAGlE,YAAY,EACV,cAAc,EACd,qBAAqB,EACrB,qBAAqB,EACrB,oBAAoB,EACpB,uBAAuB,EACvB,0BAA0B,GAC3B,oBAAgB;AAGjB,YAAY,EACV,2BAA2B,EAC3B,2BAA2B,EAC3B,8BAA8B,EAC9B,8BAA8B,EAC9B,yBAAyB,GAC1B,iDAA6C;AAG9C,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,oBAAgB"}

package/dist/index.mjs

@@ -0,0 +1,7 @@
+// Export service class
+export { StorageService } from "./StorageService.mjs";
+// Export adapters
+export { InMemoryStorageAdapter } from "./InMemoryStorageAdapter.mjs";
+// Export service name and storage key prefix constants
+export { SERVICE_NAME, STORAGE_KEY_PREFIX } from "./types.mjs";
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,uBAAuB;AACvB,OAAO,EAAE,cAAc,EAAE,6BAAyB;AAElD,kBAAkB;AAClB,OAAO,EAAE,sBAAsB,EAAE,qCAAiC;AAqBlE,uDAAuD;AACvD,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,oBAAgB","sourcesContent":["// Export service class\nexport { StorageService } from './StorageService';\n\n// Export adapters\nexport { InMemoryStorageAdapter } from './InMemoryStorageAdapter';\n\n// Export types from types.ts\nexport type {\n  StorageAdapter,\n  StorageServiceOptions,\n  StorageServiceActions,\n  StorageServiceEvents,\n  StorageServiceMessenger,\n  StorageServiceItemSetEvent,\n} from './types';\n\n// Export individual action types from generated file\nexport type {\n  StorageServiceSetItemAction,\n  StorageServiceGetItemAction,\n  StorageServiceRemoveItemAction,\n  StorageServiceGetAllKeysAction,\n  StorageServiceClearAction,\n} from './StorageService-method-action-types';\n\n// Export service name and storage key prefix constants\nexport { SERVICE_NAME, STORAGE_KEY_PREFIX } from './types';\n"]}

package/dist/types.cjs

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.STORAGE_KEY_PREFIX = exports.SERVICE_NAME = void 0;
+// Service name constant
+exports.SERVICE_NAME = 'StorageService';
+/**
+ * Storage key prefix for all keys managed by StorageService.
+ * Keys are formatted as: {STORAGE_KEY_PREFIX}{namespace}:{key}
+ * Example: 'storageService:SnapController:snap-id:sourceCode'
+ */
+exports.STORAGE_KEY_PREFIX = 'storageService:';
+//# sourceMappingURL=types.cjs.map

package/dist/types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.cjs","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AA2GA,wBAAwB;AACX,QAAA,YAAY,GAAG,gBAAgB,CAAC;AAE7C;;;;GAIG;AACU,QAAA,kBAAkB,GAAG,iBAAiB,CAAC","sourcesContent":["import type { Messenger } from '@metamask/messenger';\nimport type { Json } from '@metamask/utils';\n\nimport type { StorageServiceMethodActions } from './StorageService-method-action-types';\n\n/**\n * Platform-agnostic storage adapter interface.\n * Each client (mobile, extension) implements this interface\n * with their preferred storage mechanism.\n *\n * ⚠️ **Designed for large, infrequently accessed data (100KB+)**\n *\n * ✅ **Use for:**\n * - Snap source code (~6 MB per snap)\n * - Token metadata caches (~4 MB)\n * - Large API response caches\n *\n * ❌ **Avoid for:**\n * - Small values (< 10 KB) - use controller state instead\n * - Frequently accessed data - use controller state instead\n * - Many small key-value pairs - use a single large object instead\n *\n * @example Mobile implementation using FilesystemStorage\n * @example Extension implementation using IndexedDB\n * @example Tests using InMemoryStorageAdapter\n */\nexport type StorageAdapter = {\n  /**\n   * Retrieve an item from storage.\n   * Adapter is responsible for building the full storage key.\n   *\n   * @param namespace - The controller namespace (e.g., 'SnapController').\n   * @param key - The data key (e.g., 'snap-id:sourceCode').\n   * @returns The JSON value, or null if not found.\n   */\n  getItem(namespace: string, key: string): Promise<Json | null>;\n\n  /**\n   * Store a large JSON value in storage.\n   *\n   * ⚠️ **Store large values, 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   * - Minimum recommended size: 100 KB per value\n   *\n   * Adapter is responsible for:\n   * - Building the full storage key\n   * - Serializing to string (JSON.stringify)\n   *\n   * @param namespace - The controller namespace (e.g., 'SnapController').\n   * @param key - The data key (e.g., 'snap-id:sourceCode').\n   * @param value - The JSON value to store.\n   */\n  setItem(namespace: string, key: string, value: Json): Promise<void>;\n\n  /**\n   * Remove an item from storage.\n   * Adapter is responsible for building the full storage key.\n   *\n   * @param namespace - The controller namespace (e.g., 'SnapController').\n   * @param key - The data key (e.g., 'snap-id:sourceCode').\n   */\n  removeItem(namespace: string, key: string): Promise<void>;\n\n  /**\n   * Get all keys for a specific namespace.\n   * Should return keys without the 'storage:namespace:' prefix.\n   *\n   * Adapter is responsible for:\n   * - Filtering keys by prefix: 'storage:{namespace}:'\n   * - Stripping the prefix from returned keys\n   * - Returning only the key portion after the prefix\n   *\n   * @param namespace - The namespace to get keys for (e.g., 'SnapController').\n   * @returns Array of keys without prefix (e.g., ['snap1:sourceCode', 'snap2:sourceCode']).\n   */\n  getAllKeys(namespace: string): Promise<string[]>;\n\n  /**\n   * Clear all items for a specific namespace.\n   *\n   * Adapter is responsible for:\n   * - Finding all keys with prefix: 'storageService:{namespace}:'\n   * - Removing all matching keys\n   *\n   * @param namespace - The namespace to clear (e.g., 'SnapController').\n   */\n  clear(namespace: string): Promise<void>;\n};\n\n/**\n * Options for constructing a {@link StorageService}.\n */\nexport type StorageServiceOptions = {\n  /**\n   * The messenger suited for this service.\n   */\n  messenger: StorageServiceMessenger;\n\n  /**\n   * Storage adapter for persisting data.\n   * If not provided, uses in-memory storage (data lost on restart).\n   * Production clients MUST provide a persistent storage adapter.\n   */\n  storage?: StorageAdapter;\n};\n\n// Service name constant\nexport const SERVICE_NAME = 'StorageService';\n\n/**\n * Storage key prefix for all keys managed by StorageService.\n * Keys are formatted as: {STORAGE_KEY_PREFIX}{namespace}:{key}\n * Example: 'storageService:SnapController:snap-id:sourceCode'\n */\nexport const STORAGE_KEY_PREFIX = 'storageService:';\n\n/**\n * All actions that {@link StorageService} exposes to other consumers.\n * Action types are auto-generated from the service methods.\n */\nexport type StorageServiceActions = StorageServiceMethodActions;\n\n/**\n * Event published when a storage item is set.\n * Event type includes namespace only, key passed in payload.\n *\n * @example\n * Subscribe to all changes in TokenListController:\n * messenger.subscribe('StorageService:itemSet:TokenListController', (key, value) => {\n *   // key = 'cache:0x1', 'cache:0x38', etc.\n *   // value = the data that was set\n *   if (key.startsWith('cache:')) {\n *     const chainId = key.replace('cache:', '');\n *     // React to cache change for specific chain\n *   }\n * });\n */\nexport type StorageServiceItemSetEvent = {\n  type: `${typeof SERVICE_NAME}:itemSet:${string}`;\n  payload: [key: string, value: Json];\n};\n\n/**\n * All events that {@link StorageService} publishes.\n */\nexport type StorageServiceEvents = StorageServiceItemSetEvent;\n\n/**\n * Actions from other messengers that {@link StorageService} calls.\n */\ntype AllowedActions = never;\n\n/**\n * Events from other messengers that {@link StorageService} subscribes to.\n */\ntype AllowedEvents = never;\n\n/**\n * The messenger restricted to actions and events that\n * {@link StorageService} needs to access.\n */\nexport type StorageServiceMessenger = Messenger<\n  typeof SERVICE_NAME,\n  StorageServiceActions | AllowedActions,\n  StorageServiceEvents | AllowedEvents\n>;\n"]}