@metamask-previews/storage-service 1.0.2-preview-8bfa290fb → 2.0.0-preview-0a30e47

package/CHANGELOG.md

@@ -7,10 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.0.0]
+
 ### Changed
 
+- **BREAKING:** Drop CommonJS support ([#9536](https://github.com/MetaMask/core/pull/9536))
+  - This package is now ESM-only, but can still be used in CommonJS projects via `require(esm)` in modern Node.js versions (22+), or dynamic imports in older Node.js versions.
+- **BREAKING:** Bump minimum Node.js version to 22 ([#9976](https://github.com/MetaMask/core/pull/9976))
+- **BREAKING:** Bump TypeScript target to ES2022 ([#10019](https://github.com/MetaMask/core/pull/10019))
+  - This package now ships ES2022 code, requiring a compatible modern environment or bundler configuration to consume.
 - Bump `@metamask/utils` from `^11.9.0` to `^11.12.0` ([#9074](https://github.com/MetaMask/core/pull/9074), [#10076](https://github.com/MetaMask/core/pull/10076))
-- Bump `@metamask/messenger` from `^1.2.0` to `^2.0.0` ([#9392](https://github.com/MetaMask/core/pull/9392))
+- Bump `@metamask/messenger` from `^1.2.0` to `^3.0.0` ([#9392](https://github.com/MetaMask/core/pull/9392), [#10160](https://github.com/MetaMask/core/pull/10160))
 
 ## [1.0.2]
 
@@ -40,7 +47,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Initial release of `@metamask/storage-service` ([#7192](https://github.com/MetaMask/core/pull/7192))
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/storage-service@1.0.2...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/storage-service@2.0.0...HEAD
+[2.0.0]: https://github.com/MetaMask/core/compare/@metamask/storage-service@1.0.2...@metamask/storage-service@2.0.0
 [1.0.2]: https://github.com/MetaMask/core/compare/@metamask/storage-service@1.0.1...@metamask/storage-service@1.0.2
 [1.0.1]: https://github.com/MetaMask/core/compare/@metamask/storage-service@1.0.0...@metamask/storage-service@1.0.1
 [1.0.0]: https://github.com/MetaMask/core/compare/@metamask/storage-service@0.0.1...@metamask/storage-service@1.0.0

package/dist/{InMemoryStorageAdapter.d.mts → InMemoryStorageAdapter.d.ts}

@@ -1,5 +1,5 @@
-import type { Json } from "@metamask/utils";
-import type { InitialStorageData, StorageAdapter, StorageGetResult } from "./types.mjs";
+import type { Json } from '@metamask/utils';
+import type { InitialStorageData, StorageAdapter, StorageGetResult } from './types.js';
 /**
  * In-memory storage adapter (default fallback).
  * Implements the {@link StorageAdapter} interface using a Map.
@@ -85,4 +85,4 @@ export declare class InMemoryStorageAdapter implements StorageAdapter {
      */
     clear(namespace: string): Promise<void>;
 }
-//# sourceMappingURL=InMemoryStorageAdapter.d.mts.map
+//# sourceMappingURL=InMemoryStorageAdapter.d.ts.map

package/dist/InMemoryStorageAdapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"InMemoryStorageAdapter.d.ts","sourceRoot":"","sources":["../src/InMemoryStorageAdapter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAE5C,OAAO,KAAK,EACV,kBAAkB,EAClB,cAAc,EACd,gBAAgB,EACjB,MAAM,YAAY,CAAC;AAGpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,qBAAa,sBAAuB,YAAW,cAAc;;IAO3D;;;;;OAKG;IACH,YAAY,WAAW,CAAC,EAAE,kBAAkB,EAW3C;IAED;;;;;;;OAOG;IACG,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAgBvE;IAED;;;;;;;OAOG;IACG,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAGxE;IAED;;;;;OAKG;IACG,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAG9D;IAED;;;;;;OAMG;IACG,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAKrD;IAED;;;;OAIG;IACG,KAAK,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAM5C;CACF"}

package/dist/{InMemoryStorageAdapter.mjs → InMemoryStorageAdapter.js}

@@ -1,16 +1,4 @@
-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 _InMemoryStorageAdapter_storage;
-import { STORAGE_KEY_PREFIX } from "./types.mjs";
+import { STORAGE_KEY_PREFIX } from './types.js';
 /**
  * In-memory storage adapter (default fallback).
  * Implements the {@link StorageAdapter} interface using a Map.
@@ -48,6 +36,11 @@ import { STORAGE_KEY_PREFIX } from "./types.mjs";
  * ```
  */
 export class InMemoryStorageAdapter {
+    // Explicitly implement StorageAdapter interface
+    /**
+     * Internal storage map.
+     */
+    #storage;
     /**
      * Constructs a new InMemoryStorageAdapter.
      *
@@ -55,17 +48,12 @@ export class InMemoryStorageAdapter {
      * Useful for setting up test fixtures without calling setItem multiple times.
      */
     constructor(initialData) {
-        // Explicitly implement StorageAdapter interface
-        /**
-         * Internal storage map.
-         */
-        _InMemoryStorageAdapter_storage.set(this, void 0);
-        __classPrivateFieldSet(this, _InMemoryStorageAdapter_storage, new Map(), "f");
+        this.#storage = new Map();
         if (initialData) {
             for (const [namespace, items] of Object.entries(initialData)) {
                 for (const [key, value] of Object.entries(items)) {
                     const fullKey = `${STORAGE_KEY_PREFIX}${namespace}:${key}`;
-                    __classPrivateFieldGet(this, _InMemoryStorageAdapter_storage, "f").set(fullKey, JSON.stringify(value));
+                    this.#storage.set(fullKey, JSON.stringify(value));
                 }
             }
         }
@@ -80,7 +68,7 @@ export class InMemoryStorageAdapter {
      */
     async getItem(namespace, key) {
         const fullKey = `${STORAGE_KEY_PREFIX}${namespace}:${key}`;
-        const serialized = __classPrivateFieldGet(this, _InMemoryStorageAdapter_storage, "f").get(fullKey);
+        const serialized = this.#storage.get(fullKey);
         // Key not found - return empty object
         if (serialized === undefined) {
             return {};
@@ -104,7 +92,7 @@ export class InMemoryStorageAdapter {
      */
     async setItem(namespace, key, value) {
         const fullKey = `${STORAGE_KEY_PREFIX}${namespace}:${key}`;
-        __classPrivateFieldGet(this, _InMemoryStorageAdapter_storage, "f").set(fullKey, JSON.stringify(value));
+        this.#storage.set(fullKey, JSON.stringify(value));
     }
     /**
      * Remove an item from in-memory storage.
@@ -114,7 +102,7 @@ export class InMemoryStorageAdapter {
      */
     async removeItem(namespace, key) {
         const fullKey = `${STORAGE_KEY_PREFIX}${namespace}:${key}`;
-        __classPrivateFieldGet(this, _InMemoryStorageAdapter_storage, "f").delete(fullKey);
+        this.#storage.delete(fullKey);
     }
     /**
      * Get all keys for a namespace.
@@ -125,7 +113,7 @@ export class InMemoryStorageAdapter {
      */
     async getAllKeys(namespace) {
         const prefix = `${STORAGE_KEY_PREFIX}${namespace}:`;
-        return Array.from(__classPrivateFieldGet(this, _InMemoryStorageAdapter_storage, "f").keys())
+        return Array.from(this.#storage.keys())
             .filter((key) => key.startsWith(prefix))
             .map((key) => key.slice(prefix.length));
     }
@@ -136,9 +124,8 @@ export class InMemoryStorageAdapter {
      */
     async clear(namespace) {
         const prefix = `${STORAGE_KEY_PREFIX}${namespace}:`;
-        const keysToDelete = Array.from(__classPrivateFieldGet(this, _InMemoryStorageAdapter_storage, "f").keys()).filter((key) => key.startsWith(prefix));
-        keysToDelete.forEach((key) => __classPrivateFieldGet(this, _InMemoryStorageAdapter_storage, "f").delete(key));
+        const keysToDelete = Array.from(this.#storage.keys()).filter((key) => key.startsWith(prefix));
+        keysToDelete.forEach((key) => this.#storage.delete(key));
     }
 }
-_InMemoryStorageAdapter_storage = new WeakMap();
-//# sourceMappingURL=InMemoryStorageAdapter.mjs.map
+//# sourceMappingURL=InMemoryStorageAdapter.js.map

package/dist/InMemoryStorageAdapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"InMemoryStorageAdapter.js","sourceRoot":"","sources":["../src/InMemoryStorageAdapter.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAEhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,MAAM,OAAO,sBAAsB;IACjC,gDAAgD;IAChD;;OAEG;IACM,QAAQ,CAAsB;IAEvC;;;;;OAKG;IACH,YAAY,WAAgC;QAC1C,IAAI,CAAC,QAAQ,GAAG,IAAI,GAAG,EAAE,CAAC;QAE1B,IAAI,WAAW,EAAE,CAAC;YAChB,KAAK,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;gBAC7D,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;oBACjD,MAAM,OAAO,GAAG,GAAG,kBAAkB,GAAG,SAAS,IAAI,GAAG,EAAE,CAAC;oBAC3D,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;gBACpD,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,OAAO,CAAC,SAAiB,EAAE,GAAW;QAC1C,MAAM,OAAO,GAAG,GAAG,kBAAkB,GAAG,SAAS,IAAI,GAAG,EAAE,CAAC;QAC3D,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAE9C,sCAAsC;QACtC,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;YACtC,OAAO,EAAE,MAAM,EAAE,CAAC;QACpB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,mCAAmC,OAAO,GAAG,EAAE,KAAK,CAAC,CAAC;YACpE,OAAO,EAAE,KAAK,EAAE,KAAc,EAAE,CAAC;QACnC,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,OAAO,CAAC,SAAiB,EAAE,GAAW,EAAE,KAAW;QACvD,MAAM,OAAO,GAAG,GAAG,kBAAkB,GAAG,SAAS,IAAI,GAAG,EAAE,CAAC;QAC3D,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;IACpD,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,UAAU,CAAC,SAAiB,EAAE,GAAW;QAC7C,MAAM,OAAO,GAAG,GAAG,kBAAkB,GAAG,SAAS,IAAI,GAAG,EAAE,CAAC;QAC3D,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAChC,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,UAAU,CAAC,SAAiB;QAChC,MAAM,MAAM,GAAG,GAAG,kBAAkB,GAAG,SAAS,GAAG,CAAC;QACpD,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;aACpC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;aACvC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;IAC5C,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,KAAK,CAAC,SAAiB;QAC3B,MAAM,MAAM,GAAG,GAAG,kBAAkB,GAAG,SAAS,GAAG,CAAC;QACpD,MAAM,YAAY,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CACnE,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,CACvB,CAAC;QACF,YAAY,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;IAC3D,CAAC;CACF","sourcesContent":["import type { Json } from '@metamask/utils';\n\nimport type {\n  InitialStorageData,\n  StorageAdapter,\n  StorageGetResult,\n} from './types.js';\nimport { STORAGE_KEY_PREFIX } from './types.js';\n\n/**\n * In-memory storage adapter (default fallback).\n * Implements the {@link StorageAdapter} interface using a Map.\n *\n * ⚠️ **Warning**: Data is NOT persisted - lost on restart.\n *\n * **Suitable for:**\n * - Testing (isolated, no mocking needed)\n * - Development (quick start, zero config)\n * - Temporary/ephemeral data\n *\n * **Not suitable for:**\n * - Production (unless data is truly ephemeral)\n * - Data that needs to persist across restarts\n *\n * @example Basic usage\n * ```typescript\n * const adapter = new InMemoryStorageAdapter();\n * await adapter.setItem('SnapController', 'snap-id:sourceCode', 'const x = 1;');\n * const value = await adapter.getItem('SnapController', 'snap-id:sourceCode'); // 'const x = 1;'\n * // After restart: data is lost\n * ```\n *\n * @example Initialize with data (useful for testing)\n * ```typescript\n * const adapter = new InMemoryStorageAdapter({\n *   SnapController: {\n *     'snap-id:sourceCode': 'const x = 1;',\n *     'snap-id:manifest': { name: 'My Snap' },\n *   },\n *   TokenListController: {\n *     cache: { '0x1': ['token1', 'token2'] },\n *   },\n * });\n * ```\n */\nexport class InMemoryStorageAdapter implements StorageAdapter {\n  // Explicitly implement StorageAdapter interface\n  /**\n   * Internal storage map.\n   */\n  readonly #storage: Map<string, string>;\n\n  /**\n   * Constructs a new InMemoryStorageAdapter.\n   *\n   * @param initialData - Optional initial data to populate the storage.\n   * Useful for setting up test fixtures without calling setItem multiple times.\n   */\n  constructor(initialData?: InitialStorageData) {\n    this.#storage = new Map();\n\n    if (initialData) {\n      for (const [namespace, items] of Object.entries(initialData)) {\n        for (const [key, value] of Object.entries(items)) {\n          const fullKey = `${STORAGE_KEY_PREFIX}${namespace}:${key}`;\n          this.#storage.set(fullKey, JSON.stringify(value));\n        }\n      }\n    }\n  }\n\n  /**\n   * Retrieve an item from in-memory storage.\n   * Deserializes JSON data from storage.\n   *\n   * @param namespace - The controller namespace.\n   * @param key - The data key.\n   * @returns StorageGetResult: { result } if found, {} if not found, { error } on failure.\n   */\n  async getItem(namespace: string, key: string): Promise<StorageGetResult> {\n    const fullKey = `${STORAGE_KEY_PREFIX}${namespace}:${key}`;\n    const serialized = this.#storage.get(fullKey);\n\n    // Key not found - return empty object\n    if (serialized === undefined) {\n      return {};\n    }\n\n    try {\n      const result = JSON.parse(serialized);\n      return { result };\n    } catch (error) {\n      console.error(`Failed to parse stored data for ${fullKey}:`, error);\n      return { error: error as Error };\n    }\n  }\n\n  /**\n   * Store an item in in-memory storage.\n   * Serializes JSON data to string.\n   *\n   * @param namespace - The controller namespace.\n   * @param key - The data key.\n   * @param value - The JSON value to store.\n   */\n  async setItem(namespace: string, key: string, value: Json): Promise<void> {\n    const fullKey = `${STORAGE_KEY_PREFIX}${namespace}:${key}`;\n    this.#storage.set(fullKey, JSON.stringify(value));\n  }\n\n  /**\n   * Remove an item from in-memory storage.\n   *\n   * @param namespace - The controller namespace.\n   * @param key - The data key.\n   */\n  async removeItem(namespace: string, key: string): Promise<void> {\n    const fullKey = `${STORAGE_KEY_PREFIX}${namespace}:${key}`;\n    this.#storage.delete(fullKey);\n  }\n\n  /**\n   * Get all keys for a namespace.\n   * Returns keys without the 'storage:namespace:' prefix.\n   *\n   * @param namespace - The namespace to get keys for.\n   * @returns Array of keys (without prefix) for this namespace.\n   */\n  async getAllKeys(namespace: string): Promise<string[]> {\n    const prefix = `${STORAGE_KEY_PREFIX}${namespace}:`;\n    return Array.from(this.#storage.keys())\n      .filter((key) => key.startsWith(prefix))\n      .map((key) => key.slice(prefix.length));\n  }\n\n  /**\n   * Clear all items for a namespace.\n   *\n   * @param namespace - The namespace to clear.\n   */\n  async clear(namespace: string): Promise<void> {\n    const prefix = `${STORAGE_KEY_PREFIX}${namespace}:`;\n    const keysToDelete = Array.from(this.#storage.keys()).filter((key) =>\n      key.startsWith(prefix),\n    );\n    keysToDelete.forEach((key) => this.#storage.delete(key));\n  }\n}\n"]}

package/dist/{StorageService-method-action-types.d.cts → StorageService-method-action-types.d.ts}

@@ -2,7 +2,7 @@
  * This file is auto generated.
  * Do not edit manually.
  */
-import type { StorageService } from "./StorageService.cjs";
+import type { StorageService } from './StorageService.js';
 /**
  * Store large JSON data in storage.
  *
@@ -75,4 +75,4 @@ export type StorageServiceClearAction = {
  * Union of all StorageService action types.
  */
 export type StorageServiceMethodActions = StorageServiceSetItemAction | StorageServiceGetItemAction | StorageServiceRemoveItemAction | StorageServiceGetAllKeysAction | StorageServiceClearAction;
-//# sourceMappingURL=StorageService-method-action-types.d.cts.map
+//# sourceMappingURL=StorageService-method-action-types.d.ts.map

package/dist/StorageService-method-action-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StorageService-method-action-types.d.ts","sourceRoot":"","sources":["../src/StorageService-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAE1D;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,IAAI,EAAE,wBAAwB,CAAC;IAC/B,OAAO,EAAE,cAAc,CAAC,SAAS,CAAC,CAAC;CACpC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,IAAI,EAAE,wBAAwB,CAAC;IAC/B,OAAO,EAAE,cAAc,CAAC,SAAS,CAAC,CAAC;CACpC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C,IAAI,EAAE,2BAA2B,CAAC;IAClC,OAAO,EAAE,cAAc,CAAC,YAAY,CAAC,CAAC;CACvC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C,IAAI,EAAE,2BAA2B,CAAC;IAClC,OAAO,EAAE,cAAc,CAAC,YAAY,CAAC,CAAC;CACvC,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,IAAI,EAAE,sBAAsB,CAAC;IAC7B,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GACnC,2BAA2B,GAC3B,2BAA2B,GAC3B,8BAA8B,GAC9B,8BAA8B,GAC9B,yBAAyB,CAAC"}

package/dist/{StorageService-method-action-types.mjs → StorageService-method-action-types.js}

@@ -3,4 +3,4 @@
  * Do not edit manually.
  */
 export {};
-//# sourceMappingURL=StorageService-method-action-types.mjs.map
+//# sourceMappingURL=StorageService-method-action-types.js.map

package/dist/StorageService-method-action-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StorageService-method-action-types.js","sourceRoot":"","sources":["../src/StorageService-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { StorageService } from './StorageService.js';\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 */\nexport type StorageServiceSetItemAction = {\n  type: `StorageService:setItem`;\n  handler: StorageService['setItem'];\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 StorageGetResult: { result } if found, {} if not found, { error } on failure.\n */\nexport type StorageServiceGetItemAction = {\n  type: `StorageService:getItem`;\n  handler: StorageService['getItem'];\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 */\nexport type StorageServiceRemoveItemAction = {\n  type: `StorageService:removeItem`;\n  handler: StorageService['removeItem'];\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 */\nexport type StorageServiceGetAllKeysAction = {\n  type: `StorageService:getAllKeys`;\n  handler: StorageService['getAllKeys'];\n};\n\n/**\n * Clear all data for a namespace.\n *\n * @param namespace - Controller namespace (e.g., 'SnapController').\n */\nexport type StorageServiceClearAction = {\n  type: `StorageService:clear`;\n  handler: StorageService['clear'];\n};\n\n/**\n * Union of all StorageService action types.\n */\nexport type StorageServiceMethodActions =\n  | StorageServiceSetItemAction\n  | StorageServiceGetItemAction\n  | StorageServiceRemoveItemAction\n  | StorageServiceGetAllKeysAction\n  | StorageServiceClearAction;\n"]}

package/dist/{StorageService.d.mts → StorageService.d.ts}

@@ -1,6 +1,6 @@
-import type { Json } from "@metamask/utils";
-import type { StorageGetResult, StorageServiceOptions } from "./types.mjs";
-import { SERVICE_NAME } from "./types.mjs";
+import type { Json } from '@metamask/utils';
+import type { StorageGetResult, StorageServiceOptions } from './types.js';
+import { SERVICE_NAME } from './types.js';
 /**
  * StorageService provides a platform-agnostic way for controllers to store
  * large, infrequently accessed data outside of memory/Redux state.
@@ -145,4 +145,4 @@ export declare class StorageService {
      */
     clear(namespace: string): Promise<void>;
 }
-//# sourceMappingURL=StorageService.d.mts.map
+//# sourceMappingURL=StorageService.d.ts.map

package/dist/StorageService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StorageService.d.ts","sourceRoot":"","sources":["../src/StorageService.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAG5C,OAAO,KAAK,EAEV,gBAAgB,EAEhB,qBAAqB,EACtB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAY1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0EG;AACH,qBAAa,cAAc;;IACzB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,YAAY,CAAC;IAYnC;;;;;;;OAOG;IACH,YAAY,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,qBAAqB,EAkBxD;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAYxE;IAED;;;;;;OAMG;IACG,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAGvE;IAED;;;;;OAKG;IACG,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAG9D;IAED;;;;;;OAMG;IACG,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAErD;IAED;;;;OAIG;IACG,KAAK,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAE5C;CACF"}

package/dist/{StorageService.d.cts → StorageService.js}

@@ -1,6 +1,13 @@
-import type { Json } from "@metamask/utils";
-import type { StorageGetResult, StorageServiceOptions } from "./types.cjs";
-import { SERVICE_NAME } from "./types.cjs";
+import { InMemoryStorageAdapter } from './InMemoryStorageAdapter.js';
+import { SERVICE_NAME } from './types.js';
+// === 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.
@@ -76,12 +83,19 @@ import { SERVICE_NAME } from "./types.cjs";
  * });
  * ```
  */
-export declare class StorageService {
-    #private;
+export class StorageService {
     /**
      * The name of the service.
      */
-    readonly name: typeof SERVICE_NAME;
+    name;
+    /**
+     * The messenger suited for this service.
+     */
+    #messenger;
+    /**
+     * The storage adapter for persisting data.
+     */
+    #storage;
     /**
      * Constructs a new StorageService.
      *
@@ -90,7 +104,18 @@ export declare class StorageService {
      * @param options.storage - Storage adapter for persisting data.
      * If not provided, uses InMemoryStorageAdapter (data lost on restart).
      */
-    constructor({ messenger, storage }: StorageServiceOptions);
+    constructor({ messenger, storage }) {
+        this.name = SERVICE_NAME;
+        this.#messenger = messenger;
+        this.#storage = storage ?? new InMemoryStorageAdapter();
+        // 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
+        this.#messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
+    }
     /**
      * Store large JSON data in storage.
      *
@@ -114,7 +139,14 @@ export declare class StorageService {
      * @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>;
+    async setItem(namespace, key, value) {
+        // Adapter handles serialization and wrapping with metadata
+        await this.#storage.setItem(namespace, key, value);
+        // Publish event so other controllers can react to changes
+        // Event type: StorageService:itemSet:namespace
+        // Payload: [key, value]
+        this.#messenger.publish(`${SERVICE_NAME}:itemSet:${namespace}`, key, value);
+    }
     /**
      * Retrieve JSON data from storage.
      *
@@ -122,14 +154,20 @@ export declare class StorageService {
      * @param key - Storage key (e.g., 'npm:@metamask/example-snap:sourceCode').
      * @returns StorageGetResult: { result } if found, {} if not found, { error } on failure.
      */
-    getItem(namespace: string, key: string): Promise<StorageGetResult>;
+    async getItem(namespace, key) {
+        // Adapter handles deserialization and unwrapping
+        return await this.#storage.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').
      */
-    removeItem(namespace: string, key: string): Promise<void>;
+    async removeItem(namespace, key) {
+        // Adapter builds full storage key (e.g., mobile: 'storageService:namespace:key')
+        await this.#storage.removeItem(namespace, key);
+    }
     /**
      * Get all keys for a namespace.
      * Delegates to storage adapter which handles filtering.
@@ -137,12 +175,16 @@ export declare class StorageService {
      * @param namespace - Controller namespace (e.g., 'SnapController').
      * @returns Array of keys (without prefix) for this namespace.
      */
-    getAllKeys(namespace: string): Promise<string[]>;
+    async getAllKeys(namespace) {
+        return await this.#storage.getAllKeys(namespace);
+    }
     /**
      * Clear all data for a namespace.
      *
      * @param namespace - Controller namespace (e.g., 'SnapController').
      */
-    clear(namespace: string): Promise<void>;
+    async clear(namespace) {
+        await this.#storage.clear(namespace);
+    }
 }
-//# sourceMappingURL=StorageService.d.cts.map
+//# sourceMappingURL=StorageService.js.map

package/dist/StorageService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StorageService.js","sourceRoot":"","sources":["../src/StorageService.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAOrE,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1C,oBAAoB;AAEpB,MAAM,yBAAyB,GAAG;IAChC,SAAS;IACT,SAAS;IACT,YAAY;IACZ,YAAY;IACZ,OAAO;CACC,CAAC;AAEX;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0EG;AACH,MAAM,OAAO,cAAc;IACzB;;OAEG;IACM,IAAI,CAAsB;IAEnC;;OAEG;IACM,UAAU,CAA0B;IAE7C;;OAEG;IACM,QAAQ,CAAiB;IAElC;;;;;;;OAOG;IACH,YAAY,EAAE,SAAS,EAAE,OAAO,EAAyB;QACvD,IAAI,CAAC,IAAI,GAAG,YAAY,CAAC;QACzB,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,QAAQ,GAAG,OAAO,IAAI,IAAI,sBAAsB,EAAE,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,IAAI,CAAC,UAAU,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,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;QAEnD,0DAA0D;QAC1D,+CAA+C;QAC/C,wBAAwB;QACxB,IAAI,CAAC,UAAU,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,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;IACrD,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,UAAU,CAAC,SAAiB,EAAE,GAAW;QAC7C,iFAAiF;QACjF,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,UAAU,CAAC,SAAiB;QAChC,OAAO,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACnD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,KAAK,CAAC,SAAiB;QAC3B,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IACvC,CAAC;CACF","sourcesContent":["import type { Json } from '@metamask/utils';\n\nimport { InMemoryStorageAdapter } from './InMemoryStorageAdapter.js';\nimport type {\n  StorageAdapter,\n  StorageGetResult,\n  StorageServiceMessenger,\n  StorageServiceOptions,\n} from './types.js';\nimport { SERVICE_NAME } from './types.js';\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 | undefined> {\n *     const { result, error } = await this.messenger.call(\n *       'StorageService:getItem',\n *       'SnapController',\n *       `${snapId}:sourceCode`,\n *     );\n *     if (error) {\n *       throw error; // Handle error\n *     }\n *     return result as string | undefined; // undefined if not found\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 StorageGetResult: { result } if found, {} if not found, { error } on failure.\n   */\n  async getItem(namespace: string, key: string): Promise<StorageGetResult> {\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.d.ts

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

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAGrD,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAGrE,YAAY,EACV,kBAAkB,EAClB,cAAc,EACd,gBAAgB,EAChB,qBAAqB,EACrB,qBAAqB,EACrB,oBAAoB,EACpB,uBAAuB,EACvB,0BAA0B,GAC3B,MAAM,YAAY,CAAC;AAGpB,YAAY,EACV,2BAA2B,EAC3B,2BAA2B,EAC3B,8BAA8B,EAC9B,8BAA8B,EAC9B,yBAAyB,GAC1B,MAAM,yCAAyC,CAAC;AAGjD,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC"}

package/dist/index.js

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

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,uBAAuB;AACvB,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAErD,kBAAkB;AAClB,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAuBrE,uDAAuD;AACvD,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC","sourcesContent":["// Export service class\nexport { StorageService } from './StorageService.js';\n\n// Export adapters\nexport { InMemoryStorageAdapter } from './InMemoryStorageAdapter.js';\n\n// Export types from types.ts\nexport type {\n  InitialStorageData,\n  StorageAdapter,\n  StorageGetResult,\n  StorageServiceOptions,\n  StorageServiceActions,\n  StorageServiceEvents,\n  StorageServiceMessenger,\n  StorageServiceItemSetEvent,\n} from './types.js';\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.js';\n\n// Export service name and storage key prefix constants\nexport { SERVICE_NAME, STORAGE_KEY_PREFIX } from './types.js';\n"]}

package/dist/{types.d.cts → types.d.ts}

@@ -1,6 +1,6 @@
-import type { Messenger } from "@metamask/messenger";
-import type { Json } from "@metamask/utils";
-import type { StorageServiceMethodActions } from "./StorageService-method-action-types.cjs";
+import type { Messenger } from '@metamask/messenger';
+import type { Json } from '@metamask/utils';
+import type { StorageServiceMethodActions } from './StorageService-method-action-types.js';
 /**
  * Initial data structure for populating InMemoryStorageAdapter.
  * Useful for setting up test fixtures.
@@ -183,4 +183,4 @@ type AllowedEvents = never;
  */
 export type StorageServiceMessenger = Messenger<typeof SERVICE_NAME, StorageServiceActions | AllowedActions, StorageServiceEvents | AllowedEvents>;
 export {};
-//# sourceMappingURL=types.d.cts.map
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAE5C,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,yCAAyC,CAAC;AAE3F;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,CAAC,SAAS,EAAE,MAAM,GAAG;QACnB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;KACrB,CAAC;CACH,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,gBAAgB,GACxB;IAAE,MAAM,EAAE,IAAI,CAAC;IAAC,KAAK,CAAC,EAAE,KAAK,CAAA;CAAE,GAC/B;IAAE,MAAM,CAAC,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,KAAK,CAAA;CAAE,GAChC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AAE1B;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;;;;;;OAOG;IACH,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAEnE;;;;;;;;;;;;;;;OAeG;IACH,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpE;;;;;;OAMG;IACH,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1D;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAEjD;;;;;;;;OAQG;IACH,KAAK,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACzC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,SAAS,EAAE,uBAAuB,CAAC;IAEnC;;;;OAIG;IACH,OAAO,CAAC,EAAE,cAAc,CAAC;CAC1B,CAAC;AAGF,eAAO,MAAM,YAAY,mBAAmB,CAAC;AAE7C;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,oBAAoB,CAAC;AAEpD;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG,2BAA2B,CAAC;AAEhE;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC,IAAI,EAAE,GAAG,OAAO,YAAY,YAAY,MAAM,EAAE,CAAC;IACjD,OAAO,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;CACrC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,0BAA0B,CAAC;AAE9D;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAG,SAAS,CAC7C,OAAO,YAAY,EACnB,qBAAqB,GAAG,cAAc,EACtC,oBAAoB,GAAG,aAAa,CACrC,CAAC"}

package/dist/{types.mjs → types.js}

@@ -6,4 +6,4 @@ export const SERVICE_NAME = 'StorageService';
  * Example: 'storageService:SnapController:snap-id:sourceCode'
  */
 export const STORAGE_KEY_PREFIX = 'storageService:';
-//# sourceMappingURL=types.mjs.map
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAgJA,wBAAwB;AACxB,MAAM,CAAC,MAAM,YAAY,GAAG,gBAAgB,CAAC;AAE7C;;;;GAIG;AACH,MAAM,CAAC,MAAM,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.js';\n\n/**\n * Initial data structure for populating InMemoryStorageAdapter.\n * Useful for setting up test fixtures.\n *\n * @example\n * ```typescript\n * const initialData: InitialStorageData = {\n *   SnapController: {\n *     'snap-id:sourceCode': 'const x = 1;',\n *     'snap-id:manifest': { name: 'My Snap' },\n *   },\n *   TokenListController: {\n *     cache: { '0x1': ['token1', 'token2'] },\n *   },\n * };\n * const adapter = new InMemoryStorageAdapter(initialData);\n * ```\n */\nexport type InitialStorageData = {\n  [namespace: string]: {\n    [key: string]: Json;\n  };\n};\n\n/**\n * Result type for getItem operations.\n * Distinguishes between: found data, not found, and error conditions.\n *\n * - `{ result: Json }` - Data was found and successfully retrieved\n * - `{}` (empty object) - No data stored with that key\n * - `{ error: Error }` - Error occurred during retrieval\n */\nexport type StorageGetResult =\n  | { result: Json; error?: never }\n  | { result?: never; error: Error }\n  | Record<string, never>;\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 StorageGetResult: { result } if found, {} if not found, { error } on failure.\n   */\n  getItem(namespace: string, key: string): Promise<StorageGetResult>;\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"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/storage-service",
-  "version": "1.0.2-preview-8bfa290fb",
+  "version": "2.0.0-preview-0a30e47",
   "description": "Platform-agnostic service for storing large, infrequently accessed controller data",
   "keywords": [
     "Ethereum",
@@ -18,19 +18,12 @@
   "files": [
     "dist/"
   ],
+  "type": "module",
   "sideEffects": false,
-  "main": "./dist/index.cjs",
-  "types": "./dist/index.d.cts",
   "exports": {
     ".": {
-      "import": {
-        "types": "./dist/index.d.mts",
-        "default": "./dist/index.mjs"
-      },
-      "require": {
-        "types": "./dist/index.d.cts",
-        "default": "./dist/index.cjs"
-      }
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
     },
     "./package.json": "./package.json"
   },
@@ -39,9 +32,11 @@
     "registry": "https://registry.npmjs.org/"
   },
   "scripts": {
-    "build": "ts-bridge --project tsconfig.build.json --verbose --clean --no-references",
-    "build:all": "ts-bridge --project tsconfig.build.json --verbose --clean",
+    "build": "tsc --project tsconfig.build.json",
+    "build:all": "tsc --build tsconfig.build.json --verbose",
+    "build:clean": "yarn build:only-clean && yarn build",
     "build:docs": "typedoc",
+    "build:only-clean": "rimraf './dist' './tsconfig.build.tsbuildinfo'",
     "changelog:update": "../../scripts/update-changelog.sh @metamask/storage-service",
     "changelog:validate": "../../scripts/validate-changelog.sh @metamask/storage-service",
     "lint:tsconfigs": "tsx ../../scripts/lint-tsconfigs/lint-tsconfigs.mts",
@@ -55,22 +50,23 @@
     "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
   },
   "dependencies": {
-    "@metamask/messenger": "^2.0.0",
+    "@metamask/messenger": "^3.0.0",
     "@metamask/utils": "^11.12.0"
   },
   "devDependencies": {
     "@metamask/auto-changelog": "^6.1.0",
-    "@ts-bridge/cli": "^0.6.4",
     "@types/jest": "^30.0.0",
+    "@typescript/native": "npm:typescript@^7.0.2",
     "deepmerge": "^4.2.2",
     "jest": "^30.4.2",
+    "rimraf": "^5.0.5",
     "ts-jest": "^29.4.11",
     "tsx": "^4.20.5",
     "typedoc": "^0.25.13",
     "typedoc-plugin-missing-exports": "^2.0.0",
-    "typescript": "~5.3.3"
+    "typescript": "npm:@typescript/typescript6@^6.0.2"
   },
   "engines": {
-    "node": "^18.18 || >=20"
+    "node": "^22.14.0 || ^24"
   }
 }