@metamask-previews/eth-snap-keyring 20.0.0-d23a1b9 → 21.0.1-7275dbc

package/CHANGELOG.md

@@ -7,18 +7,47 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [21.0.1]
+
+### Changed
+
+- Bump `@metamask/keyring-internal-api` from `^10.1.0` to `^10.1.1` ([#518](https://github.com/MetaMask/accounts/pull/518))
+- Bump `@metamask/keyring-internal-snap-client` from `^10.0.0` to `^10.0.1` ([#518](https://github.com/MetaMask/accounts/pull/518))
+- Bump `@metamask/keyring-sdk` from `^2.0.0` to `^2.0.1` ([#518](https://github.com/MetaMask/accounts/pull/518))
+- Bump `@metamask/keyring-snap-sdk` from `^9.0.0` to `^9.0.1` ([#518](https://github.com/MetaMask/accounts/pull/518))
+
+### Fixed
+
+- Workaround Browserify subpath export for `/v2` ([#516](https://github.com/MetaMask/accounts/pull/516))
+
+## [21.0.0]
+
 ### Added
 
-- Add `SnapKeyringV2` class, a per-snap keyring wrapper that implements `KeyringV2` with `createAccount`, `createAccounts`, `deleteAccount`, `submitRequest`, `getAccount`, and `getAccounts` ([#501](https://github.com/MetaMask/accounts/pull/501))
+- Support Stellar (`xlm:account`) accounts in account assertions and v1 migrations ([#483](https://github.com/MetaMask/accounts/pull/483))
+- Add `SnapKeyringV1` class, a per-snap keyring wrapper that implements the old keyring interface and flows ([#507](https://github.com/MetaMask/accounts/pull/507))
+  - This will allow us to re-use the existing logic (that we still use today) as part of the new V2 implementation until we completely them.
+- Add `SnapKeyringV2` class, a per-snap keyring wrapper that implements `KeyringV2` with `createAccount`, `createAccounts`, `deleteAccount`, `submitRequest`, `getAccount`, and `getAccounts` ([#501](https://github.com/MetaMask/accounts/pull/501)), ([#507](https://github.com/MetaMask/accounts/pull/507))
+  - `SnapKeyringV2` inherits from `SnapKeyringV1` so it can replace the current `SnapKeyring` class entirely, but for a single Snap.
 - Add `@metamask/keyring-sdk` `^1.1.0` as a new dependency ([#501](https://github.com/MetaMask/accounts/pull/501))
+- Add `./v2` subpath export for keyring v2 implementation ([#513](https://github.com/MetaMask/accounts/pull/513))
+  - `SnapKeyring`, `SnapKeyringState`, and `SnapKeyringCallbacks` are now available from `@metamask/keyring-snap-bridge/v2`.
 
 ### Changed
 
+- **BREAKING:** Move and rename `SnapKeyringV2` to the new `./v2` subpath export ([#513](https://github.com/MetaMask/accounts/pull/513))
+  - `SnapKeyringV2` is now `SnapKeyring` from `@metamask/keyring-snap-bridge/v2`.
+- **BREAKING:** Bump `@metamask/keyring-api` from `^22.0.0` to `^23.0.0` ([#515](https://github.com/MetaMask/accounts/pull/515))
+- Use `DeferredPromise` from `@metamask/utils` ([#508](https://github.com/MetaMask/accounts/pull/508))
 - Refactor `SnapKeyring` to store accounts in per-snap `SnapKeyringV2` wrappers instead of a single flat map ([#501](https://github.com/MetaMask/accounts/pull/501))
 - Bump `@metamask/messenger` from `^0.3.0` to `^1.1.1` ([#489](https://github.com/MetaMask/accounts/pull/489), [#500](https://github.com/MetaMask/accounts/pull/500))
 - Bump `@metamask/snaps-controllers` from `^19.0.0` to `^19.0.1` ([#500](https://github.com/MetaMask/accounts/pull/500))
 - Bump `@metamask/snaps-utils` from `^12.1.2` to `^12.1.3` ([#500](https://github.com/MetaMask/accounts/pull/500))
-- Bump `@metamask/utils` from `^11.1.0` to `^11.10.0` ([#489](https://github.com/MetaMask/accounts/pull/489))
+- Bump `@metamask/utils` from `^11.10.0` to `^11.11.0` ([#483](https://github.com/MetaMask/accounts/pull/483))
+- Bump `@metamask/keyring-internal-api` from `^10.0.1` to `^10.1.0` ([#515](https://github.com/MetaMask/accounts/pull/515))
+- Bump `@metamask/keyring-internal-snap-client` from `^9.0.1` to `^10.0.0` ([#515](https://github.com/MetaMask/accounts/pull/515))
+- Bump `@metamask/keyring-sdk` from `^1.2.0` to `^2.0.0` ([#515](https://github.com/MetaMask/accounts/pull/515))
+- Bump `@metamask/keyring-snap-sdk` from `^8.0.0` to `^9.0.0` ([#515](https://github.com/MetaMask/accounts/pull/515))
 
 ## [20.0.0]
 
@@ -658,7 +687,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Initial release.
 
-[Unreleased]: https://github.com/MetaMask/accounts/compare/@metamask/eth-snap-keyring@20.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/accounts/compare/@metamask/eth-snap-keyring@21.0.1...HEAD
+[21.0.1]: https://github.com/MetaMask/accounts/compare/@metamask/eth-snap-keyring@21.0.0...@metamask/eth-snap-keyring@21.0.1
+[21.0.0]: https://github.com/MetaMask/accounts/compare/@metamask/eth-snap-keyring@20.0.0...@metamask/eth-snap-keyring@21.0.0
 [20.0.0]: https://github.com/MetaMask/accounts/compare/@metamask/eth-snap-keyring@19.0.0...@metamask/eth-snap-keyring@20.0.0
 [19.0.0]: https://github.com/MetaMask/accounts/compare/@metamask/eth-snap-keyring@18.0.2...@metamask/eth-snap-keyring@19.0.0
 [18.0.2]: https://github.com/MetaMask/accounts/compare/@metamask/eth-snap-keyring@18.0.1...@metamask/eth-snap-keyring@18.0.2

package/README.md

@@ -37,35 +37,28 @@ Run `yarn lint` to run the linter, or run `yarn lint:fix` to run the linter and
 The project follows the same release process as the other libraries in the MetaMask organization. The GitHub Actions [`action-create-release-pr`](https://github.com/MetaMask/action-create-release-pr) and [`action-publish-release`](https://github.com/MetaMask/action-publish-release) are used to automate the release process; see those repositories for more information about how they work.
 
 1. Choose a release version.
-
    - The release version should be chosen according to SemVer. Analyze the changes to see whether they include any breaking changes, new features, or deprecations, then choose the appropriate SemVer version. See [the SemVer specification](https://semver.org/) for more information.
 
 2. If this release is backporting changes onto a previous release, then ensure there is a major version branch for that version (e.g. `1.x` for a `v1` backport release).
-
    - The major version branch should be set to the most recent release with that major version. For example, when backporting a `v1.0.2` release, you'd want to ensure there was a `1.x` branch that was set to the `v1.0.1` tag.
 
 3. Trigger the [`workflow_dispatch`](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#workflow_dispatch) event [manually](https://docs.github.com/en/actions/managing-workflow-runs/manually-running-a-workflow) for the `Create Release Pull Request` action to create the release PR.
-
    - For a backport release, the base branch should be the major version branch that you ensured existed in step 2. For a normal release, the base branch should be the main branch for that repository (which should be the default value).
    - This should trigger the [`action-create-release-pr`](https://github.com/MetaMask/action-create-release-pr) workflow to create the release PR.
 
 4. Update the changelog to move each change entry into the appropriate change category ([See here](https://keepachangelog.com/en/1.0.0/#types) for the full list of change categories, and the correct ordering), and edit them to be more easily understood by users of the package.
-
    - Generally any changes that don't affect consumers of the package (e.g. lockfile changes or development environment changes) are omitted. Exceptions may be made for changes that might be of interest despite not having an effect upon the published package (e.g. major test improvements, security improvements, improved documentation, etc.).
    - Try to explain each change in terms that users of the package would understand (e.g. avoid referencing internal variables/concepts).
    - Consolidate related changes into one change entry if it makes it easier to explain.
    - Run `yarn auto-changelog validate --rc` to check that the changelog is correctly formatted.
 
 5. Review and QA the release.
-
    - If changes are made to the base branch, the release branch will need to be updated with these changes and review/QA will need to restart again. As such, it's probably best to avoid merging other PRs into the base branch while review is underway.
 
 6. Squash & Merge the release.
-
    - This should trigger the [`action-publish-release`](https://github.com/MetaMask/action-publish-release) workflow to tag the final release commit and publish the release on GitHub.
 
 7. Publish the release on npm.
-
    - Wait for the `publish-release` GitHub Action workflow to finish. This should trigger a second job (`publish-npm`), which will wait for a run approval by the [`npm publishers`](https://github.com/orgs/MetaMask/teams/npm-publishers) team.
    - Approve the `publish-npm` job (or ask somebody on the npm publishers team to approve it for you).
    - Once the `publish-npm` job has finished, check npm to verify that it has been published.

package/dist/SnapIdMap.cjs

@@ -220,7 +220,6 @@ class SnapIdMap {
     delete(snapId, key) {
         return this.has(snapId, key) && __classPrivateFieldGet(this, _SnapIdMap_map, "f").delete(key);
     }
-    /* eslint-disable jsdoc/check-indentation */
     /**
      * Adds or updates a key-value pair in the map.
      *
@@ -239,7 +238,6 @@ class SnapIdMap {
      * @param value - Value of the element to add or update.
      * @returns The map itself.
      */
-    /* eslint-enable jsdoc/check-indentation */
     set(key, value) {
         // If the key is present in the map but isn't associated with the given
         // Snap ID, it means that the item was added to the map by a different

package/dist/SnapIdMap.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"SnapIdMap.cjs","sourceRoot":"","sources":["../src/SnapIdMap.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAEA,iEAA0D;AAE1D;;GAEG;AACH,MAAa,kBAAmB,SAAQ,KAAK;IAW3C;;;;;OAKG;IACH,YAAY,MAAc,EAAE,GAAW;QACrC,KAAK,CAAC,SAAS,MAAM,4BAA4B,GAAG,GAAG,CAAC,CAAC;QACzD,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;QACjC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,CAAC;CACF;AAvBD,gDAuBC;AAED;;;;;;GAMG;AACH,MAAa,SAAS;IAGpB;;;;;;;;;;;;;;;OAeG;IACH,YAAY,QAA6C;QAlBhD,iCAAgC;QAmBvC,uBAAA,IAAI,kBAAQ,IAAI,uCAAkB,CAAC,QAAQ,CAAC,MAAA,CAAC;IAC/C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,QAAQ;QACN,OAAO,uBAAA,IAAI,sBAAK,CAAC,QAAQ,EAAE,CAAC;IAC9B,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,UAAU,CACf,GAA0B;QAE1B,OAAO,IAAI,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,GAAG,CAAC,MAAc,EAAE,GAAW;QAC7B,MAAM,KAAK,GAAG,uBAAA,IAAI,sBAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACjC,OAAO,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;IACtD,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,GAAW;QACnB,OAAO,uBAAA,IAAI,sBAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IACpC,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,GAAG,CAAC,MAAc,EAAE,GAAW;QAC7B,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACpC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACzB,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,GAAG,CAAC,MAAc,EAAE,GAAW;QAC7B,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,SAAS,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,MAAc;QACtB,6EAA6E;QAC7E,mCAAmC;QACnC,OAAO,CAAC,GAAG,uBAAA,IAAI,sBAAK,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,MAAc,EAAE,GAAW;QAChC,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,uBAAA,IAAI,sBAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IACxD,CAAC;IAED,4CAA4C;IAC5C;;;;;;;;;;;;;;;;;OAiBG;IACH,2CAA2C;IAC3C,GAAG,CAAC,GAAW,EAAE,KAAY;QAC3B,uEAAuE;QACvE,sEAAsE;QACtE,sCAAsC;QACtC,IAAI,uBAAA,IAAI,sBAAK,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC;YACvD,MAAM,IAAI,kBAAkB,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAClD,CAAC;QACD,uBAAA,IAAI,sBAAK,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM;QACJ,OAAO,uBAAA,IAAI,sBAAK,CAAC,MAAM,EAAE,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACH,IAAI,IAAI;QACN,OAAO,uBAAA,IAAI,sBAAK,CAAC,IAAI,CAAC;IACxB,CAAC;CACF;AAhQD,8BAgQC","sourcesContent":["import type { SnapId } from '@metamask/snaps-sdk';\n\nimport { CaseInsensitiveMap } from './CaseInsensitiveMap';\n\n/**\n * Error thrown when an invalid Snap ID is encountered.\n */\nexport class InvalidSnapIdError extends Error {\n  /**\n   * The ID of the Snap that caused the error.\n   */\n  snapId: SnapId;\n\n  /**\n   * The key of the element that caused the error.\n   */\n  key: string;\n\n  /**\n   * Creates an instance of `InvalidSnapIdError`.\n   *\n   * @param snapId - The invalid Snap ID.\n   * @param key - The key associated with the invalid Snap ID.\n   */\n  constructor(snapId: SnapId, key: string) {\n    super(`Snap \"${snapId}\" is not allowed to set \"${key}\"`);\n    this.name = 'InvalidSnapIdError';\n    this.snapId = snapId;\n    this.key = key;\n  }\n}\n\n/**\n * A map that associates a string key with a value that has a `snapId`\n * property. Note that the key is case-insensitive.\n *\n * The `snapId` property is used to ensure that only the Snap that added an\n * item to the map can modify or delete it.\n */\nexport class SnapIdMap<Value extends { snapId: SnapId }> {\n  readonly #map: CaseInsensitiveMap<Value>;\n\n  /**\n   * Creates a new `SnapIdMap` object.\n   *\n   * Example:\n   *\n   * ```ts\n   * const items = [\n   *   ['foo', { snapId: '1', name: 'foo' }],\n   *   ['bar', { snapId: '1', name: 'bar' }],\n   * ];\n   * const map = new SnapIdMap(items);\n   * ```\n   *\n   * @param iterable - An iterable object whose elements are key-value pairs.\n   * Each key-value pair will be added to the new map.\n   */\n  constructor(iterable?: Iterable<readonly [string, Value]>) {\n    this.#map = new CaseInsensitiveMap(iterable);\n  }\n\n  /**\n   * Returns a plain object with the same key-value pairs as this map.\n   *\n   * Example:\n   *\n   * ```ts\n   * const items = [\n   *   ['foo', { snapId: '1', name: 'foo' }],\n   *   ['bar', { snapId: '1', name: 'bar' }],\n   * ];\n   * const map = new SnapIdMap(items);\n   * map.toObject();\n   * // Returns\n   * // {\n   * //   foo: { snapId: '1', name: 'foo' },\n   * //   bar: { snapId: '1', name: 'bar' },\n   * // }\n   * ```\n   *\n   * @returns A plain object with the same key-value pairs as this map.\n   */\n  toObject(): Record<string, Value> {\n    return this.#map.toObject();\n  }\n\n  /**\n   * Returns a new `SnapIdMap` object from an plain object.\n   *\n   * Example:\n   *\n   * ```ts\n   * const obj = {\n   *   foo: { snapId: '1', name: 'foo' },\n   *   bar: { snapId: '1', name: 'bar' },\n   * };\n   * const map = SnapIdMap.fromObject(obj);\n   * ```\n   *\n   * @param obj - A plain object whose elements will be added to the new map.\n   * @returns A new `SnapIdMap` containing the elements of the given object.\n   */\n  static fromObject<Value extends { snapId: SnapId }>(\n    obj: Record<string, Value>,\n  ): SnapIdMap<Value> {\n    return new SnapIdMap(Object.entries(obj));\n  }\n\n  /**\n   * Gets a value from the map.\n   *\n   * If the given key is not present in the map or the Snap ID of the value is\n   * different from the given Snap ID, returns `undefined`.\n   *\n   * Example:\n   *\n   * ```ts\n   * const map = new SnapIdMap();\n   * map.set('foo', { snapId: '1', name: 'foo' });\n   * map.get('1', 'foo'); // Returns { snapId: '1', name: 'foo' }\n   * map.get('2', 'foo'); // Returns `undefined`\n   * map.get('1', 'bar'); // Returns `undefined`\n   * ```\n   *\n   * @param snapId - Snap ID present in the value to get.\n   * @param key - Key of the element to get.\n   * @returns The value associated with the given key and Snap ID.\n   */\n  get(snapId: SnapId, key: string): Value | undefined {\n    const value = this.#map.get(key);\n    return value?.snapId === snapId ? value : undefined;\n  }\n\n  /**\n   * Gets a Snap ID that's associated with the given key from the map.\n   *\n   * @param key - Key of the element to get.\n   * @returns The Snap ID associated with the given key.\n   */\n  getSnapId(key: string): SnapId | undefined {\n    return this.#map.get(key)?.snapId;\n  }\n\n  /**\n   * Gets and delete a value from the map.\n   *\n   * If the given key is not present in the map or the Snap ID of the value is\n   * different from the given Snap ID, returns `undefined`.\n   *\n   * Example:\n   *\n   * ```ts\n   * const map = new SnapIdMap();\n   * map.set('foo', { snapId: '1', name: 'foo' });\n   * map.pop('1', 'foo'); // Returns { snapId: '1', name: 'foo' }\n   * map.pop('1', 'foo'); // Returns `undefined` (already returned and deleted)\n   * map.pop('1', 'bar'); // Returns `undefined`\n   * ```\n   *\n   * @param snapId - Snap ID present in the value to get.\n   * @param key - Key of the element to get.\n   * @returns The value associated with the given key and Snap ID.\n   */\n  pop(snapId: SnapId, key: string): Value | undefined {\n    const value = this.get(snapId, key);\n    this.delete(snapId, key);\n    return value;\n  }\n\n  /**\n   * Checks if a key is present in the map.\n   *\n   * If the given key is not present in the map or the Snap ID of the value is\n   * different from the given Snap ID, returns `false`.\n   *\n   * Example:\n   *\n   * ```ts\n   * const map = new SnapIdMap();\n   * map.set('foo', { snapId: '1', name: 'foo' });\n   * map.has('1', 'foo'); // Returns `true`\n   * map.has('2', 'foo'); // Returns `false`\n   * map.has('1', 'bar'); // Returns `false`\n   * ```\n   *\n   * @param snapId - Snap ID present in the value to check.\n   * @param key - Key of the element to check.\n   * @returns `true` if the key is present in the map and the Snap ID of the\n   * value is equal to the given Snap ID, `false` otherwise.\n   */\n  has(snapId: SnapId, key: string): boolean {\n    return this.get(snapId, key) !== undefined;\n  }\n\n  /**\n   * Checks if a snap ID exists in the map.\n   *\n   * @param snapId - Snap ID present in the value to check.\n   * @returns `true` if the snap ID is present in the map, `false` otherwise.\n   */\n  hasSnapId(snapId: SnapId): boolean {\n    // We could use a reverse-mapping to map Snap ID to their actual key too, but\n    // for now, this will do the trick.\n    return [...this.#map.values()].some((value) => value.snapId === snapId);\n  }\n\n  /**\n   * Deletes a key from the map.\n   *\n   * If the given key is not present in the map or the Snap IDs don't match,\n   * returns `false` and does nothing.\n   *\n   * Example:\n   *\n   * ```ts\n   * const map = new SnapIdMap();\n   * map.set('foo', { snapId: '1', name: 'foo' });\n   * map.delete('2', 'foo'); // Returns `false`\n   * map.delete('1', 'bar'); // Returns `false`\n   * map.delete('1', 'foo'); // Returns `true`\n   * ```\n   *\n   * @param snapId - Snap ID present in the value to delete.\n   * @param key - Key of the element to delete.\n   * @returns `true` if the key was present in the map and the Snap ID of the\n   * value was equal to the given Snap ID, `false` otherwise.\n   */\n  delete(snapId: SnapId, key: string): boolean {\n    return this.has(snapId, key) && this.#map.delete(key);\n  }\n\n  /* eslint-disable jsdoc/check-indentation */\n  /**\n   * Adds or updates a key-value pair in the map.\n   *\n   * Note that this method has a different behavior from the `Map.set`.\n   *\n   * - If the given key is not already present in the map, this method adds the\n   *   key-value pair to the map.\n   *\n   * - If the given key is already present in the map and the Snap IDs match,\n   *   this method updates the value associated with the key.\n   *\n   * - However, if the given key is already present in the map but the Snap IDs\n   *   do not match, this method throws an error.\n   *\n   * @param key - Key of the element to add or update.\n   * @param value - Value of the element to add or update.\n   * @returns The map itself.\n   */\n  /* eslint-enable jsdoc/check-indentation */\n  set(key: string, value: Value): this {\n    // If the key is present in the map but isn't associated with the given\n    // Snap ID, it means that the item was added to the map by a different\n    // Snap. In this case, throw an error.\n    if (this.#map.has(key) && !this.has(value.snapId, key)) {\n      throw new InvalidSnapIdError(value.snapId, key);\n    }\n    this.#map.set(key, value);\n    return this;\n  }\n\n  /**\n   * Returns an iterable of the values in the map.\n   *\n   * Example:\n   *\n   * ```ts\n   * const map = new SnapIdMap([\n   *   ['foo', { snapId: '1', name: 'foo' }],\n   *   ['bar', { snapId: '1', name: 'bar' }],\n   * ]);\n   * const values = [...map.values()];\n   * // Returns\n   * // [\n   * //   { snapId: '1', name: 'foo' },\n   * //   { snapId: '1', name: 'bar' },\n   * // ]\n   * ```\n   *\n   * @returns An iterable of the values in the map.\n   */\n  values(): IterableIterator<Value> {\n    return this.#map.values();\n  }\n\n  /**\n   * Returns the number of key-value pairs in the map.\n   *\n   * @returns The number of key-value pairs in the map.\n   */\n  get size(): number {\n    return this.#map.size;\n  }\n}\n"]}
+{"version":3,"file":"SnapIdMap.cjs","sourceRoot":"","sources":["../src/SnapIdMap.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAEA,iEAA0D;AAE1D;;GAEG;AACH,MAAa,kBAAmB,SAAQ,KAAK;IAW3C;;;;;OAKG;IACH,YAAY,MAAc,EAAE,GAAW;QACrC,KAAK,CAAC,SAAS,MAAM,4BAA4B,GAAG,GAAG,CAAC,CAAC;QACzD,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;QACjC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,CAAC;CACF;AAvBD,gDAuBC;AAED;;;;;;GAMG;AACH,MAAa,SAAS;IAGpB;;;;;;;;;;;;;;;OAeG;IACH,YAAY,QAA6C;QAlBhD,iCAAgC;QAmBvC,uBAAA,IAAI,kBAAQ,IAAI,uCAAkB,CAAC,QAAQ,CAAC,MAAA,CAAC;IAC/C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,QAAQ;QACN,OAAO,uBAAA,IAAI,sBAAK,CAAC,QAAQ,EAAE,CAAC;IAC9B,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,UAAU,CACf,GAA0B;QAE1B,OAAO,IAAI,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,GAAG,CAAC,MAAc,EAAE,GAAW;QAC7B,MAAM,KAAK,GAAG,uBAAA,IAAI,sBAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACjC,OAAO,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;IACtD,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,GAAW;QACnB,OAAO,uBAAA,IAAI,sBAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IACpC,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,GAAG,CAAC,MAAc,EAAE,GAAW;QAC7B,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACpC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACzB,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,GAAG,CAAC,MAAc,EAAE,GAAW;QAC7B,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,SAAS,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,MAAc;QACtB,6EAA6E;QAC7E,mCAAmC;QACnC,OAAO,CAAC,GAAG,uBAAA,IAAI,sBAAK,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,MAAc,EAAE,GAAW;QAChC,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,uBAAA,IAAI,sBAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,GAAG,CAAC,GAAW,EAAE,KAAY;QAC3B,uEAAuE;QACvE,sEAAsE;QACtE,sCAAsC;QACtC,IAAI,uBAAA,IAAI,sBAAK,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC;YACvD,MAAM,IAAI,kBAAkB,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAClD,CAAC;QACD,uBAAA,IAAI,sBAAK,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM;QACJ,OAAO,uBAAA,IAAI,sBAAK,CAAC,MAAM,EAAE,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACH,IAAI,IAAI;QACN,OAAO,uBAAA,IAAI,sBAAK,CAAC,IAAI,CAAC;IACxB,CAAC;CACF;AA9PD,8BA8PC","sourcesContent":["import type { SnapId } from '@metamask/snaps-sdk';\n\nimport { CaseInsensitiveMap } from './CaseInsensitiveMap';\n\n/**\n * Error thrown when an invalid Snap ID is encountered.\n */\nexport class InvalidSnapIdError extends Error {\n  /**\n   * The ID of the Snap that caused the error.\n   */\n  snapId: SnapId;\n\n  /**\n   * The key of the element that caused the error.\n   */\n  key: string;\n\n  /**\n   * Creates an instance of `InvalidSnapIdError`.\n   *\n   * @param snapId - The invalid Snap ID.\n   * @param key - The key associated with the invalid Snap ID.\n   */\n  constructor(snapId: SnapId, key: string) {\n    super(`Snap \"${snapId}\" is not allowed to set \"${key}\"`);\n    this.name = 'InvalidSnapIdError';\n    this.snapId = snapId;\n    this.key = key;\n  }\n}\n\n/**\n * A map that associates a string key with a value that has a `snapId`\n * property. Note that the key is case-insensitive.\n *\n * The `snapId` property is used to ensure that only the Snap that added an\n * item to the map can modify or delete it.\n */\nexport class SnapIdMap<Value extends { snapId: SnapId }> {\n  readonly #map: CaseInsensitiveMap<Value>;\n\n  /**\n   * Creates a new `SnapIdMap` object.\n   *\n   * Example:\n   *\n   * ```ts\n   * const items = [\n   *   ['foo', { snapId: '1', name: 'foo' }],\n   *   ['bar', { snapId: '1', name: 'bar' }],\n   * ];\n   * const map = new SnapIdMap(items);\n   * ```\n   *\n   * @param iterable - An iterable object whose elements are key-value pairs.\n   * Each key-value pair will be added to the new map.\n   */\n  constructor(iterable?: Iterable<readonly [string, Value]>) {\n    this.#map = new CaseInsensitiveMap(iterable);\n  }\n\n  /**\n   * Returns a plain object with the same key-value pairs as this map.\n   *\n   * Example:\n   *\n   * ```ts\n   * const items = [\n   *   ['foo', { snapId: '1', name: 'foo' }],\n   *   ['bar', { snapId: '1', name: 'bar' }],\n   * ];\n   * const map = new SnapIdMap(items);\n   * map.toObject();\n   * // Returns\n   * // {\n   * //   foo: { snapId: '1', name: 'foo' },\n   * //   bar: { snapId: '1', name: 'bar' },\n   * // }\n   * ```\n   *\n   * @returns A plain object with the same key-value pairs as this map.\n   */\n  toObject(): Record<string, Value> {\n    return this.#map.toObject();\n  }\n\n  /**\n   * Returns a new `SnapIdMap` object from an plain object.\n   *\n   * Example:\n   *\n   * ```ts\n   * const obj = {\n   *   foo: { snapId: '1', name: 'foo' },\n   *   bar: { snapId: '1', name: 'bar' },\n   * };\n   * const map = SnapIdMap.fromObject(obj);\n   * ```\n   *\n   * @param obj - A plain object whose elements will be added to the new map.\n   * @returns A new `SnapIdMap` containing the elements of the given object.\n   */\n  static fromObject<Value extends { snapId: SnapId }>(\n    obj: Record<string, Value>,\n  ): SnapIdMap<Value> {\n    return new SnapIdMap(Object.entries(obj));\n  }\n\n  /**\n   * Gets a value from the map.\n   *\n   * If the given key is not present in the map or the Snap ID of the value is\n   * different from the given Snap ID, returns `undefined`.\n   *\n   * Example:\n   *\n   * ```ts\n   * const map = new SnapIdMap();\n   * map.set('foo', { snapId: '1', name: 'foo' });\n   * map.get('1', 'foo'); // Returns { snapId: '1', name: 'foo' }\n   * map.get('2', 'foo'); // Returns `undefined`\n   * map.get('1', 'bar'); // Returns `undefined`\n   * ```\n   *\n   * @param snapId - Snap ID present in the value to get.\n   * @param key - Key of the element to get.\n   * @returns The value associated with the given key and Snap ID.\n   */\n  get(snapId: SnapId, key: string): Value | undefined {\n    const value = this.#map.get(key);\n    return value?.snapId === snapId ? value : undefined;\n  }\n\n  /**\n   * Gets a Snap ID that's associated with the given key from the map.\n   *\n   * @param key - Key of the element to get.\n   * @returns The Snap ID associated with the given key.\n   */\n  getSnapId(key: string): SnapId | undefined {\n    return this.#map.get(key)?.snapId;\n  }\n\n  /**\n   * Gets and delete a value from the map.\n   *\n   * If the given key is not present in the map or the Snap ID of the value is\n   * different from the given Snap ID, returns `undefined`.\n   *\n   * Example:\n   *\n   * ```ts\n   * const map = new SnapIdMap();\n   * map.set('foo', { snapId: '1', name: 'foo' });\n   * map.pop('1', 'foo'); // Returns { snapId: '1', name: 'foo' }\n   * map.pop('1', 'foo'); // Returns `undefined` (already returned and deleted)\n   * map.pop('1', 'bar'); // Returns `undefined`\n   * ```\n   *\n   * @param snapId - Snap ID present in the value to get.\n   * @param key - Key of the element to get.\n   * @returns The value associated with the given key and Snap ID.\n   */\n  pop(snapId: SnapId, key: string): Value | undefined {\n    const value = this.get(snapId, key);\n    this.delete(snapId, key);\n    return value;\n  }\n\n  /**\n   * Checks if a key is present in the map.\n   *\n   * If the given key is not present in the map or the Snap ID of the value is\n   * different from the given Snap ID, returns `false`.\n   *\n   * Example:\n   *\n   * ```ts\n   * const map = new SnapIdMap();\n   * map.set('foo', { snapId: '1', name: 'foo' });\n   * map.has('1', 'foo'); // Returns `true`\n   * map.has('2', 'foo'); // Returns `false`\n   * map.has('1', 'bar'); // Returns `false`\n   * ```\n   *\n   * @param snapId - Snap ID present in the value to check.\n   * @param key - Key of the element to check.\n   * @returns `true` if the key is present in the map and the Snap ID of the\n   * value is equal to the given Snap ID, `false` otherwise.\n   */\n  has(snapId: SnapId, key: string): boolean {\n    return this.get(snapId, key) !== undefined;\n  }\n\n  /**\n   * Checks if a snap ID exists in the map.\n   *\n   * @param snapId - Snap ID present in the value to check.\n   * @returns `true` if the snap ID is present in the map, `false` otherwise.\n   */\n  hasSnapId(snapId: SnapId): boolean {\n    // We could use a reverse-mapping to map Snap ID to their actual key too, but\n    // for now, this will do the trick.\n    return [...this.#map.values()].some((value) => value.snapId === snapId);\n  }\n\n  /**\n   * Deletes a key from the map.\n   *\n   * If the given key is not present in the map or the Snap IDs don't match,\n   * returns `false` and does nothing.\n   *\n   * Example:\n   *\n   * ```ts\n   * const map = new SnapIdMap();\n   * map.set('foo', { snapId: '1', name: 'foo' });\n   * map.delete('2', 'foo'); // Returns `false`\n   * map.delete('1', 'bar'); // Returns `false`\n   * map.delete('1', 'foo'); // Returns `true`\n   * ```\n   *\n   * @param snapId - Snap ID present in the value to delete.\n   * @param key - Key of the element to delete.\n   * @returns `true` if the key was present in the map and the Snap ID of the\n   * value was equal to the given Snap ID, `false` otherwise.\n   */\n  delete(snapId: SnapId, key: string): boolean {\n    return this.has(snapId, key) && this.#map.delete(key);\n  }\n\n  /**\n   * Adds or updates a key-value pair in the map.\n   *\n   * Note that this method has a different behavior from the `Map.set`.\n   *\n   * - If the given key is not already present in the map, this method adds the\n   *   key-value pair to the map.\n   *\n   * - If the given key is already present in the map and the Snap IDs match,\n   *   this method updates the value associated with the key.\n   *\n   * - However, if the given key is already present in the map but the Snap IDs\n   *   do not match, this method throws an error.\n   *\n   * @param key - Key of the element to add or update.\n   * @param value - Value of the element to add or update.\n   * @returns The map itself.\n   */\n  set(key: string, value: Value): this {\n    // If the key is present in the map but isn't associated with the given\n    // Snap ID, it means that the item was added to the map by a different\n    // Snap. In this case, throw an error.\n    if (this.#map.has(key) && !this.has(value.snapId, key)) {\n      throw new InvalidSnapIdError(value.snapId, key);\n    }\n    this.#map.set(key, value);\n    return this;\n  }\n\n  /**\n   * Returns an iterable of the values in the map.\n   *\n   * Example:\n   *\n   * ```ts\n   * const map = new SnapIdMap([\n   *   ['foo', { snapId: '1', name: 'foo' }],\n   *   ['bar', { snapId: '1', name: 'bar' }],\n   * ]);\n   * const values = [...map.values()];\n   * // Returns\n   * // [\n   * //   { snapId: '1', name: 'foo' },\n   * //   { snapId: '1', name: 'bar' },\n   * // ]\n   * ```\n   *\n   * @returns An iterable of the values in the map.\n   */\n  values(): IterableIterator<Value> {\n    return this.#map.values();\n  }\n\n  /**\n   * Returns the number of key-value pairs in the map.\n   *\n   * @returns The number of key-value pairs in the map.\n   */\n  get size(): number {\n    return this.#map.size;\n  }\n}\n"]}

package/dist/SnapIdMap.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"SnapIdMap.d.cts","sourceRoot":"","sources":["../src/SnapIdMap.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,4BAA4B;AAIlD;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,KAAK;IAC3C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;;OAKG;gBACS,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;CAMxC;AAED;;;;;;GAMG;AACH,qBAAa,SAAS,CAAC,KAAK,SAAS;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE;;IAGrD;;;;;;;;;;;;;;;OAeG;gBACS,QAAQ,CAAC,EAAE,QAAQ,CAAC,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAIzD;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,QAAQ,IAAI,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC;IAIjC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,UAAU,CAAC,KAAK,SAAS;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,EAChD,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GACzB,SAAS,CAAC,KAAK,CAAC;IAInB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,KAAK,GAAG,SAAS;IAKnD;;;;;OAKG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAI1C;;;;;;;;;;;;;;;;;;;OAmBG;IACH,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,KAAK,GAAG,SAAS;IAMnD;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO;IAIzC;;;;;OAKG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAMlC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO;IAK5C;;;;;;;;;;;;;;;;;OAiBG;IAEH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI;IAWpC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,IAAI,gBAAgB,CAAC,KAAK,CAAC;IAIjC;;;;OAIG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;CACF"}
+{"version":3,"file":"SnapIdMap.d.cts","sourceRoot":"","sources":["../src/SnapIdMap.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,4BAA4B;AAIlD;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,KAAK;IAC3C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;;OAKG;gBACS,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;CAMxC;AAED;;;;;;GAMG;AACH,qBAAa,SAAS,CAAC,KAAK,SAAS;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE;;IAGrD;;;;;;;;;;;;;;;OAeG;gBACS,QAAQ,CAAC,EAAE,QAAQ,CAAC,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAIzD;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,QAAQ,IAAI,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC;IAIjC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,UAAU,CAAC,KAAK,SAAS;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,EAChD,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GACzB,SAAS,CAAC,KAAK,CAAC;IAInB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,KAAK,GAAG,SAAS;IAKnD;;;;;OAKG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAI1C;;;;;;;;;;;;;;;;;;;OAmBG;IACH,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,KAAK,GAAG,SAAS;IAMnD;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO;IAIzC;;;;;OAKG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAMlC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO;IAI5C;;;;;;;;;;;;;;;;;OAiBG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI;IAWpC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,IAAI,gBAAgB,CAAC,KAAK,CAAC;IAIjC;;;;OAIG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;CACF"}

package/dist/SnapIdMap.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"SnapIdMap.d.mts","sourceRoot":"","sources":["../src/SnapIdMap.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,4BAA4B;AAIlD;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,KAAK;IAC3C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;;OAKG;gBACS,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;CAMxC;AAED;;;;;;GAMG;AACH,qBAAa,SAAS,CAAC,KAAK,SAAS;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE;;IAGrD;;;;;;;;;;;;;;;OAeG;gBACS,QAAQ,CAAC,EAAE,QAAQ,CAAC,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAIzD;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,QAAQ,IAAI,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC;IAIjC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,UAAU,CAAC,KAAK,SAAS;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,EAChD,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GACzB,SAAS,CAAC,KAAK,CAAC;IAInB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,KAAK,GAAG,SAAS;IAKnD;;;;;OAKG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAI1C;;;;;;;;;;;;;;;;;;;OAmBG;IACH,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,KAAK,GAAG,SAAS;IAMnD;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO;IAIzC;;;;;OAKG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAMlC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO;IAK5C;;;;;;;;;;;;;;;;;OAiBG;IAEH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI;IAWpC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,IAAI,gBAAgB,CAAC,KAAK,CAAC;IAIjC;;;;OAIG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;CACF"}
+{"version":3,"file":"SnapIdMap.d.mts","sourceRoot":"","sources":["../src/SnapIdMap.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,4BAA4B;AAIlD;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,KAAK;IAC3C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;;OAKG;gBACS,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;CAMxC;AAED;;;;;;GAMG;AACH,qBAAa,SAAS,CAAC,KAAK,SAAS;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE;;IAGrD;;;;;;;;;;;;;;;OAeG;gBACS,QAAQ,CAAC,EAAE,QAAQ,CAAC,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAIzD;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,QAAQ,IAAI,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC;IAIjC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,UAAU,CAAC,KAAK,SAAS;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,EAChD,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GACzB,SAAS,CAAC,KAAK,CAAC;IAInB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,KAAK,GAAG,SAAS;IAKnD;;;;;OAKG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAI1C;;;;;;;;;;;;;;;;;;;OAmBG;IACH,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,KAAK,GAAG,SAAS;IAMnD;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO;IAIzC;;;;;OAKG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAMlC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO;IAI5C;;;;;;;;;;;;;;;;;OAiBG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI;IAWpC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,IAAI,gBAAgB,CAAC,KAAK,CAAC;IAIjC;;;;OAIG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;CACF"}

package/dist/SnapIdMap.mjs

@@ -216,7 +216,6 @@ export class SnapIdMap {
     delete(snapId, key) {
         return this.has(snapId, key) && __classPrivateFieldGet(this, _SnapIdMap_map, "f").delete(key);
     }
-    /* eslint-disable jsdoc/check-indentation */
     /**
      * Adds or updates a key-value pair in the map.
      *
@@ -235,7 +234,6 @@ export class SnapIdMap {
      * @param value - Value of the element to add or update.
      * @returns The map itself.
      */
-    /* eslint-enable jsdoc/check-indentation */
     set(key, value) {
         // If the key is present in the map but isn't associated with the given
         // Snap ID, it means that the item was added to the map by a different

package/dist/SnapIdMap.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"SnapIdMap.mjs","sourceRoot":"","sources":["../src/SnapIdMap.ts"],"names":[],"mappings":";;;;;;;;;;;;AAEA,OAAO,EAAE,kBAAkB,EAAE,iCAA6B;AAE1D;;GAEG;AACH,MAAM,OAAO,kBAAmB,SAAQ,KAAK;IAW3C;;;;;OAKG;IACH,YAAY,MAAc,EAAE,GAAW;QACrC,KAAK,CAAC,SAAS,MAAM,4BAA4B,GAAG,GAAG,CAAC,CAAC;QACzD,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;QACjC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAM,OAAO,SAAS;IAGpB;;;;;;;;;;;;;;;OAeG;IACH,YAAY,QAA6C;QAlBhD,iCAAgC;QAmBvC,uBAAA,IAAI,kBAAQ,IAAI,kBAAkB,CAAC,QAAQ,CAAC,MAAA,CAAC;IAC/C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,QAAQ;QACN,OAAO,uBAAA,IAAI,sBAAK,CAAC,QAAQ,EAAE,CAAC;IAC9B,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,UAAU,CACf,GAA0B;QAE1B,OAAO,IAAI,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,GAAG,CAAC,MAAc,EAAE,GAAW;QAC7B,MAAM,KAAK,GAAG,uBAAA,IAAI,sBAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACjC,OAAO,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;IACtD,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,GAAW;QACnB,OAAO,uBAAA,IAAI,sBAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IACpC,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,GAAG,CAAC,MAAc,EAAE,GAAW;QAC7B,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACpC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACzB,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,GAAG,CAAC,MAAc,EAAE,GAAW;QAC7B,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,SAAS,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,MAAc;QACtB,6EAA6E;QAC7E,mCAAmC;QACnC,OAAO,CAAC,GAAG,uBAAA,IAAI,sBAAK,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,MAAc,EAAE,GAAW;QAChC,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,uBAAA,IAAI,sBAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IACxD,CAAC;IAED,4CAA4C;IAC5C;;;;;;;;;;;;;;;;;OAiBG;IACH,2CAA2C;IAC3C,GAAG,CAAC,GAAW,EAAE,KAAY;QAC3B,uEAAuE;QACvE,sEAAsE;QACtE,sCAAsC;QACtC,IAAI,uBAAA,IAAI,sBAAK,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC;YACvD,MAAM,IAAI,kBAAkB,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAClD,CAAC;QACD,uBAAA,IAAI,sBAAK,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM;QACJ,OAAO,uBAAA,IAAI,sBAAK,CAAC,MAAM,EAAE,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACH,IAAI,IAAI;QACN,OAAO,uBAAA,IAAI,sBAAK,CAAC,IAAI,CAAC;IACxB,CAAC;CACF","sourcesContent":["import type { SnapId } from '@metamask/snaps-sdk';\n\nimport { CaseInsensitiveMap } from './CaseInsensitiveMap';\n\n/**\n * Error thrown when an invalid Snap ID is encountered.\n */\nexport class InvalidSnapIdError extends Error {\n  /**\n   * The ID of the Snap that caused the error.\n   */\n  snapId: SnapId;\n\n  /**\n   * The key of the element that caused the error.\n   */\n  key: string;\n\n  /**\n   * Creates an instance of `InvalidSnapIdError`.\n   *\n   * @param snapId - The invalid Snap ID.\n   * @param key - The key associated with the invalid Snap ID.\n   */\n  constructor(snapId: SnapId, key: string) {\n    super(`Snap \"${snapId}\" is not allowed to set \"${key}\"`);\n    this.name = 'InvalidSnapIdError';\n    this.snapId = snapId;\n    this.key = key;\n  }\n}\n\n/**\n * A map that associates a string key with a value that has a `snapId`\n * property. Note that the key is case-insensitive.\n *\n * The `snapId` property is used to ensure that only the Snap that added an\n * item to the map can modify or delete it.\n */\nexport class SnapIdMap<Value extends { snapId: SnapId }> {\n  readonly #map: CaseInsensitiveMap<Value>;\n\n  /**\n   * Creates a new `SnapIdMap` object.\n   *\n   * Example:\n   *\n   * ```ts\n   * const items = [\n   *   ['foo', { snapId: '1', name: 'foo' }],\n   *   ['bar', { snapId: '1', name: 'bar' }],\n   * ];\n   * const map = new SnapIdMap(items);\n   * ```\n   *\n   * @param iterable - An iterable object whose elements are key-value pairs.\n   * Each key-value pair will be added to the new map.\n   */\n  constructor(iterable?: Iterable<readonly [string, Value]>) {\n    this.#map = new CaseInsensitiveMap(iterable);\n  }\n\n  /**\n   * Returns a plain object with the same key-value pairs as this map.\n   *\n   * Example:\n   *\n   * ```ts\n   * const items = [\n   *   ['foo', { snapId: '1', name: 'foo' }],\n   *   ['bar', { snapId: '1', name: 'bar' }],\n   * ];\n   * const map = new SnapIdMap(items);\n   * map.toObject();\n   * // Returns\n   * // {\n   * //   foo: { snapId: '1', name: 'foo' },\n   * //   bar: { snapId: '1', name: 'bar' },\n   * // }\n   * ```\n   *\n   * @returns A plain object with the same key-value pairs as this map.\n   */\n  toObject(): Record<string, Value> {\n    return this.#map.toObject();\n  }\n\n  /**\n   * Returns a new `SnapIdMap` object from an plain object.\n   *\n   * Example:\n   *\n   * ```ts\n   * const obj = {\n   *   foo: { snapId: '1', name: 'foo' },\n   *   bar: { snapId: '1', name: 'bar' },\n   * };\n   * const map = SnapIdMap.fromObject(obj);\n   * ```\n   *\n   * @param obj - A plain object whose elements will be added to the new map.\n   * @returns A new `SnapIdMap` containing the elements of the given object.\n   */\n  static fromObject<Value extends { snapId: SnapId }>(\n    obj: Record<string, Value>,\n  ): SnapIdMap<Value> {\n    return new SnapIdMap(Object.entries(obj));\n  }\n\n  /**\n   * Gets a value from the map.\n   *\n   * If the given key is not present in the map or the Snap ID of the value is\n   * different from the given Snap ID, returns `undefined`.\n   *\n   * Example:\n   *\n   * ```ts\n   * const map = new SnapIdMap();\n   * map.set('foo', { snapId: '1', name: 'foo' });\n   * map.get('1', 'foo'); // Returns { snapId: '1', name: 'foo' }\n   * map.get('2', 'foo'); // Returns `undefined`\n   * map.get('1', 'bar'); // Returns `undefined`\n   * ```\n   *\n   * @param snapId - Snap ID present in the value to get.\n   * @param key - Key of the element to get.\n   * @returns The value associated with the given key and Snap ID.\n   */\n  get(snapId: SnapId, key: string): Value | undefined {\n    const value = this.#map.get(key);\n    return value?.snapId === snapId ? value : undefined;\n  }\n\n  /**\n   * Gets a Snap ID that's associated with the given key from the map.\n   *\n   * @param key - Key of the element to get.\n   * @returns The Snap ID associated with the given key.\n   */\n  getSnapId(key: string): SnapId | undefined {\n    return this.#map.get(key)?.snapId;\n  }\n\n  /**\n   * Gets and delete a value from the map.\n   *\n   * If the given key is not present in the map or the Snap ID of the value is\n   * different from the given Snap ID, returns `undefined`.\n   *\n   * Example:\n   *\n   * ```ts\n   * const map = new SnapIdMap();\n   * map.set('foo', { snapId: '1', name: 'foo' });\n   * map.pop('1', 'foo'); // Returns { snapId: '1', name: 'foo' }\n   * map.pop('1', 'foo'); // Returns `undefined` (already returned and deleted)\n   * map.pop('1', 'bar'); // Returns `undefined`\n   * ```\n   *\n   * @param snapId - Snap ID present in the value to get.\n   * @param key - Key of the element to get.\n   * @returns The value associated with the given key and Snap ID.\n   */\n  pop(snapId: SnapId, key: string): Value | undefined {\n    const value = this.get(snapId, key);\n    this.delete(snapId, key);\n    return value;\n  }\n\n  /**\n   * Checks if a key is present in the map.\n   *\n   * If the given key is not present in the map or the Snap ID of the value is\n   * different from the given Snap ID, returns `false`.\n   *\n   * Example:\n   *\n   * ```ts\n   * const map = new SnapIdMap();\n   * map.set('foo', { snapId: '1', name: 'foo' });\n   * map.has('1', 'foo'); // Returns `true`\n   * map.has('2', 'foo'); // Returns `false`\n   * map.has('1', 'bar'); // Returns `false`\n   * ```\n   *\n   * @param snapId - Snap ID present in the value to check.\n   * @param key - Key of the element to check.\n   * @returns `true` if the key is present in the map and the Snap ID of the\n   * value is equal to the given Snap ID, `false` otherwise.\n   */\n  has(snapId: SnapId, key: string): boolean {\n    return this.get(snapId, key) !== undefined;\n  }\n\n  /**\n   * Checks if a snap ID exists in the map.\n   *\n   * @param snapId - Snap ID present in the value to check.\n   * @returns `true` if the snap ID is present in the map, `false` otherwise.\n   */\n  hasSnapId(snapId: SnapId): boolean {\n    // We could use a reverse-mapping to map Snap ID to their actual key too, but\n    // for now, this will do the trick.\n    return [...this.#map.values()].some((value) => value.snapId === snapId);\n  }\n\n  /**\n   * Deletes a key from the map.\n   *\n   * If the given key is not present in the map or the Snap IDs don't match,\n   * returns `false` and does nothing.\n   *\n   * Example:\n   *\n   * ```ts\n   * const map = new SnapIdMap();\n   * map.set('foo', { snapId: '1', name: 'foo' });\n   * map.delete('2', 'foo'); // Returns `false`\n   * map.delete('1', 'bar'); // Returns `false`\n   * map.delete('1', 'foo'); // Returns `true`\n   * ```\n   *\n   * @param snapId - Snap ID present in the value to delete.\n   * @param key - Key of the element to delete.\n   * @returns `true` if the key was present in the map and the Snap ID of the\n   * value was equal to the given Snap ID, `false` otherwise.\n   */\n  delete(snapId: SnapId, key: string): boolean {\n    return this.has(snapId, key) && this.#map.delete(key);\n  }\n\n  /* eslint-disable jsdoc/check-indentation */\n  /**\n   * Adds or updates a key-value pair in the map.\n   *\n   * Note that this method has a different behavior from the `Map.set`.\n   *\n   * - If the given key is not already present in the map, this method adds the\n   *   key-value pair to the map.\n   *\n   * - If the given key is already present in the map and the Snap IDs match,\n   *   this method updates the value associated with the key.\n   *\n   * - However, if the given key is already present in the map but the Snap IDs\n   *   do not match, this method throws an error.\n   *\n   * @param key - Key of the element to add or update.\n   * @param value - Value of the element to add or update.\n   * @returns The map itself.\n   */\n  /* eslint-enable jsdoc/check-indentation */\n  set(key: string, value: Value): this {\n    // If the key is present in the map but isn't associated with the given\n    // Snap ID, it means that the item was added to the map by a different\n    // Snap. In this case, throw an error.\n    if (this.#map.has(key) && !this.has(value.snapId, key)) {\n      throw new InvalidSnapIdError(value.snapId, key);\n    }\n    this.#map.set(key, value);\n    return this;\n  }\n\n  /**\n   * Returns an iterable of the values in the map.\n   *\n   * Example:\n   *\n   * ```ts\n   * const map = new SnapIdMap([\n   *   ['foo', { snapId: '1', name: 'foo' }],\n   *   ['bar', { snapId: '1', name: 'bar' }],\n   * ]);\n   * const values = [...map.values()];\n   * // Returns\n   * // [\n   * //   { snapId: '1', name: 'foo' },\n   * //   { snapId: '1', name: 'bar' },\n   * // ]\n   * ```\n   *\n   * @returns An iterable of the values in the map.\n   */\n  values(): IterableIterator<Value> {\n    return this.#map.values();\n  }\n\n  /**\n   * Returns the number of key-value pairs in the map.\n   *\n   * @returns The number of key-value pairs in the map.\n   */\n  get size(): number {\n    return this.#map.size;\n  }\n}\n"]}
+{"version":3,"file":"SnapIdMap.mjs","sourceRoot":"","sources":["../src/SnapIdMap.ts"],"names":[],"mappings":";;;;;;;;;;;;AAEA,OAAO,EAAE,kBAAkB,EAAE,iCAA6B;AAE1D;;GAEG;AACH,MAAM,OAAO,kBAAmB,SAAQ,KAAK;IAW3C;;;;;OAKG;IACH,YAAY,MAAc,EAAE,GAAW;QACrC,KAAK,CAAC,SAAS,MAAM,4BAA4B,GAAG,GAAG,CAAC,CAAC;QACzD,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;QACjC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAM,OAAO,SAAS;IAGpB;;;;;;;;;;;;;;;OAeG;IACH,YAAY,QAA6C;QAlBhD,iCAAgC;QAmBvC,uBAAA,IAAI,kBAAQ,IAAI,kBAAkB,CAAC,QAAQ,CAAC,MAAA,CAAC;IAC/C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,QAAQ;QACN,OAAO,uBAAA,IAAI,sBAAK,CAAC,QAAQ,EAAE,CAAC;IAC9B,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,UAAU,CACf,GAA0B;QAE1B,OAAO,IAAI,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,GAAG,CAAC,MAAc,EAAE,GAAW;QAC7B,MAAM,KAAK,GAAG,uBAAA,IAAI,sBAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACjC,OAAO,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;IACtD,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,GAAW;QACnB,OAAO,uBAAA,IAAI,sBAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IACpC,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,GAAG,CAAC,MAAc,EAAE,GAAW;QAC7B,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACpC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACzB,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,GAAG,CAAC,MAAc,EAAE,GAAW;QAC7B,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,SAAS,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,MAAc;QACtB,6EAA6E;QAC7E,mCAAmC;QACnC,OAAO,CAAC,GAAG,uBAAA,IAAI,sBAAK,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,MAAc,EAAE,GAAW;QAChC,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,uBAAA,IAAI,sBAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,GAAG,CAAC,GAAW,EAAE,KAAY;QAC3B,uEAAuE;QACvE,sEAAsE;QACtE,sCAAsC;QACtC,IAAI,uBAAA,IAAI,sBAAK,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC;YACvD,MAAM,IAAI,kBAAkB,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAClD,CAAC;QACD,uBAAA,IAAI,sBAAK,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM;QACJ,OAAO,uBAAA,IAAI,sBAAK,CAAC,MAAM,EAAE,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACH,IAAI,IAAI;QACN,OAAO,uBAAA,IAAI,sBAAK,CAAC,IAAI,CAAC;IACxB,CAAC;CACF","sourcesContent":["import type { SnapId } from '@metamask/snaps-sdk';\n\nimport { CaseInsensitiveMap } from './CaseInsensitiveMap';\n\n/**\n * Error thrown when an invalid Snap ID is encountered.\n */\nexport class InvalidSnapIdError extends Error {\n  /**\n   * The ID of the Snap that caused the error.\n   */\n  snapId: SnapId;\n\n  /**\n   * The key of the element that caused the error.\n   */\n  key: string;\n\n  /**\n   * Creates an instance of `InvalidSnapIdError`.\n   *\n   * @param snapId - The invalid Snap ID.\n   * @param key - The key associated with the invalid Snap ID.\n   */\n  constructor(snapId: SnapId, key: string) {\n    super(`Snap \"${snapId}\" is not allowed to set \"${key}\"`);\n    this.name = 'InvalidSnapIdError';\n    this.snapId = snapId;\n    this.key = key;\n  }\n}\n\n/**\n * A map that associates a string key with a value that has a `snapId`\n * property. Note that the key is case-insensitive.\n *\n * The `snapId` property is used to ensure that only the Snap that added an\n * item to the map can modify or delete it.\n */\nexport class SnapIdMap<Value extends { snapId: SnapId }> {\n  readonly #map: CaseInsensitiveMap<Value>;\n\n  /**\n   * Creates a new `SnapIdMap` object.\n   *\n   * Example:\n   *\n   * ```ts\n   * const items = [\n   *   ['foo', { snapId: '1', name: 'foo' }],\n   *   ['bar', { snapId: '1', name: 'bar' }],\n   * ];\n   * const map = new SnapIdMap(items);\n   * ```\n   *\n   * @param iterable - An iterable object whose elements are key-value pairs.\n   * Each key-value pair will be added to the new map.\n   */\n  constructor(iterable?: Iterable<readonly [string, Value]>) {\n    this.#map = new CaseInsensitiveMap(iterable);\n  }\n\n  /**\n   * Returns a plain object with the same key-value pairs as this map.\n   *\n   * Example:\n   *\n   * ```ts\n   * const items = [\n   *   ['foo', { snapId: '1', name: 'foo' }],\n   *   ['bar', { snapId: '1', name: 'bar' }],\n   * ];\n   * const map = new SnapIdMap(items);\n   * map.toObject();\n   * // Returns\n   * // {\n   * //   foo: { snapId: '1', name: 'foo' },\n   * //   bar: { snapId: '1', name: 'bar' },\n   * // }\n   * ```\n   *\n   * @returns A plain object with the same key-value pairs as this map.\n   */\n  toObject(): Record<string, Value> {\n    return this.#map.toObject();\n  }\n\n  /**\n   * Returns a new `SnapIdMap` object from an plain object.\n   *\n   * Example:\n   *\n   * ```ts\n   * const obj = {\n   *   foo: { snapId: '1', name: 'foo' },\n   *   bar: { snapId: '1', name: 'bar' },\n   * };\n   * const map = SnapIdMap.fromObject(obj);\n   * ```\n   *\n   * @param obj - A plain object whose elements will be added to the new map.\n   * @returns A new `SnapIdMap` containing the elements of the given object.\n   */\n  static fromObject<Value extends { snapId: SnapId }>(\n    obj: Record<string, Value>,\n  ): SnapIdMap<Value> {\n    return new SnapIdMap(Object.entries(obj));\n  }\n\n  /**\n   * Gets a value from the map.\n   *\n   * If the given key is not present in the map or the Snap ID of the value is\n   * different from the given Snap ID, returns `undefined`.\n   *\n   * Example:\n   *\n   * ```ts\n   * const map = new SnapIdMap();\n   * map.set('foo', { snapId: '1', name: 'foo' });\n   * map.get('1', 'foo'); // Returns { snapId: '1', name: 'foo' }\n   * map.get('2', 'foo'); // Returns `undefined`\n   * map.get('1', 'bar'); // Returns `undefined`\n   * ```\n   *\n   * @param snapId - Snap ID present in the value to get.\n   * @param key - Key of the element to get.\n   * @returns The value associated with the given key and Snap ID.\n   */\n  get(snapId: SnapId, key: string): Value | undefined {\n    const value = this.#map.get(key);\n    return value?.snapId === snapId ? value : undefined;\n  }\n\n  /**\n   * Gets a Snap ID that's associated with the given key from the map.\n   *\n   * @param key - Key of the element to get.\n   * @returns The Snap ID associated with the given key.\n   */\n  getSnapId(key: string): SnapId | undefined {\n    return this.#map.get(key)?.snapId;\n  }\n\n  /**\n   * Gets and delete a value from the map.\n   *\n   * If the given key is not present in the map or the Snap ID of the value is\n   * different from the given Snap ID, returns `undefined`.\n   *\n   * Example:\n   *\n   * ```ts\n   * const map = new SnapIdMap();\n   * map.set('foo', { snapId: '1', name: 'foo' });\n   * map.pop('1', 'foo'); // Returns { snapId: '1', name: 'foo' }\n   * map.pop('1', 'foo'); // Returns `undefined` (already returned and deleted)\n   * map.pop('1', 'bar'); // Returns `undefined`\n   * ```\n   *\n   * @param snapId - Snap ID present in the value to get.\n   * @param key - Key of the element to get.\n   * @returns The value associated with the given key and Snap ID.\n   */\n  pop(snapId: SnapId, key: string): Value | undefined {\n    const value = this.get(snapId, key);\n    this.delete(snapId, key);\n    return value;\n  }\n\n  /**\n   * Checks if a key is present in the map.\n   *\n   * If the given key is not present in the map or the Snap ID of the value is\n   * different from the given Snap ID, returns `false`.\n   *\n   * Example:\n   *\n   * ```ts\n   * const map = new SnapIdMap();\n   * map.set('foo', { snapId: '1', name: 'foo' });\n   * map.has('1', 'foo'); // Returns `true`\n   * map.has('2', 'foo'); // Returns `false`\n   * map.has('1', 'bar'); // Returns `false`\n   * ```\n   *\n   * @param snapId - Snap ID present in the value to check.\n   * @param key - Key of the element to check.\n   * @returns `true` if the key is present in the map and the Snap ID of the\n   * value is equal to the given Snap ID, `false` otherwise.\n   */\n  has(snapId: SnapId, key: string): boolean {\n    return this.get(snapId, key) !== undefined;\n  }\n\n  /**\n   * Checks if a snap ID exists in the map.\n   *\n   * @param snapId - Snap ID present in the value to check.\n   * @returns `true` if the snap ID is present in the map, `false` otherwise.\n   */\n  hasSnapId(snapId: SnapId): boolean {\n    // We could use a reverse-mapping to map Snap ID to their actual key too, but\n    // for now, this will do the trick.\n    return [...this.#map.values()].some((value) => value.snapId === snapId);\n  }\n\n  /**\n   * Deletes a key from the map.\n   *\n   * If the given key is not present in the map or the Snap IDs don't match,\n   * returns `false` and does nothing.\n   *\n   * Example:\n   *\n   * ```ts\n   * const map = new SnapIdMap();\n   * map.set('foo', { snapId: '1', name: 'foo' });\n   * map.delete('2', 'foo'); // Returns `false`\n   * map.delete('1', 'bar'); // Returns `false`\n   * map.delete('1', 'foo'); // Returns `true`\n   * ```\n   *\n   * @param snapId - Snap ID present in the value to delete.\n   * @param key - Key of the element to delete.\n   * @returns `true` if the key was present in the map and the Snap ID of the\n   * value was equal to the given Snap ID, `false` otherwise.\n   */\n  delete(snapId: SnapId, key: string): boolean {\n    return this.has(snapId, key) && this.#map.delete(key);\n  }\n\n  /**\n   * Adds or updates a key-value pair in the map.\n   *\n   * Note that this method has a different behavior from the `Map.set`.\n   *\n   * - If the given key is not already present in the map, this method adds the\n   *   key-value pair to the map.\n   *\n   * - If the given key is already present in the map and the Snap IDs match,\n   *   this method updates the value associated with the key.\n   *\n   * - However, if the given key is already present in the map but the Snap IDs\n   *   do not match, this method throws an error.\n   *\n   * @param key - Key of the element to add or update.\n   * @param value - Value of the element to add or update.\n   * @returns The map itself.\n   */\n  set(key: string, value: Value): this {\n    // If the key is present in the map but isn't associated with the given\n    // Snap ID, it means that the item was added to the map by a different\n    // Snap. In this case, throw an error.\n    if (this.#map.has(key) && !this.has(value.snapId, key)) {\n      throw new InvalidSnapIdError(value.snapId, key);\n    }\n    this.#map.set(key, value);\n    return this;\n  }\n\n  /**\n   * Returns an iterable of the values in the map.\n   *\n   * Example:\n   *\n   * ```ts\n   * const map = new SnapIdMap([\n   *   ['foo', { snapId: '1', name: 'foo' }],\n   *   ['bar', { snapId: '1', name: 'bar' }],\n   * ]);\n   * const values = [...map.values()];\n   * // Returns\n   * // [\n   * //   { snapId: '1', name: 'foo' },\n   * //   { snapId: '1', name: 'bar' },\n   * // ]\n   * ```\n   *\n   * @returns An iterable of the values in the map.\n   */\n  values(): IterableIterator<Value> {\n    return this.#map.values();\n  }\n\n  /**\n   * Returns the number of key-value pairs in the map.\n   *\n   * @returns The number of key-value pairs in the map.\n   */\n  get size(): number {\n    return this.#map.size;\n  }\n}\n"]}