@metamask/name-controller 1.0.0 → 3.0.0

package/dist/providers/token.js

@@ -8,13 +8,31 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+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 _TokenNameProvider_isEnabled;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TokenNameProvider = void 0;
+const logger_1 = require("../logger");
 const types_1 = require("../types");
 const util_1 = require("../util");
 const ID = 'token';
 const LABEL = 'Blockchain (Token Name)';
+const log = (0, logger_1.createModuleLogger)(logger_1.projectLogger, 'token');
 class TokenNameProvider {
+    constructor({ isEnabled } = {}) {
+        _TokenNameProvider_isEnabled.set(this, void 0);
+        __classPrivateFieldSet(this, _TokenNameProvider_isEnabled, isEnabled || (() => true), "f");
+    }
     getMetadata() {
         return {
             sourceIds: { [types_1.NameType.ETHEREUM_ADDRESS]: [ID] },
@@ -23,19 +41,39 @@ class TokenNameProvider {
     }
     getProposedNames(request) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { value, chainId } = request;
+            if (!__classPrivateFieldGet(this, _TokenNameProvider_isEnabled, "f").call(this)) {
+                log('Skipping request as disabled');
+                return {
+                    results: {
+                        [ID]: {
+                            proposedNames: [],
+                        },
+                    },
+                };
+            }
+            const { value, variation: chainId } = request;
             const url = `https://token-api.metaswap.codefi.network/token/${chainId}?address=${value}`;
-            const responseData = yield (0, util_1.handleFetch)(url);
-            const proposedName = responseData.name;
-            return {
-                results: {
-                    [ID]: {
-                        proposedNames: [proposedName],
+            log('Sending request', url);
+            try {
+                const responseData = yield (0, util_1.handleFetch)(url);
+                const proposedName = responseData.name;
+                const proposedNames = proposedName ? [proposedName] : [];
+                log('New proposed names', proposedNames);
+                return {
+                    results: {
+                        [ID]: {
+                            proposedNames,
+                        },
                     },
-                },
-            };
+                };
+            }
+            catch (error) {
+                log('Request failed', error);
+                throw error;
+            }
         });
     }
 }
 exports.TokenNameProvider = TokenNameProvider;
+_TokenNameProvider_isEnabled = new WeakMap();
 //# sourceMappingURL=token.js.map

package/dist/providers/token.js.map

@@ -1 +1 @@
-{"version":3,"file":"token.js","sourceRoot":"","sources":["../../src/providers/token.ts"],"names":[],"mappings":";;;;;;;;;;;;AAMA,oCAAoC;AACpC,kCAAsC;AAEtC,MAAM,EAAE,GAAG,OAAO,CAAC;AACnB,MAAM,KAAK,GAAG,yBAAyB,CAAC;AAExC,MAAa,iBAAiB;IAC5B,WAAW;QACT,OAAO;YACL,SAAS,EAAE,EAAE,CAAC,gBAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE;YAChD,YAAY,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE;SAC9B,CAAC;IACJ,CAAC;IAEK,gBAAgB,CACpB,OAA4B;;YAE5B,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;YACnC,MAAM,GAAG,GAAG,mDAAmD,OAAO,YAAY,KAAK,EAAE,CAAC;YAC1F,MAAM,YAAY,GAAG,MAAM,IAAA,kBAAW,EAAC,GAAG,CAAC,CAAC;YAC5C,MAAM,YAAY,GAAG,YAAY,CAAC,IAAI,CAAC;YAEvC,OAAO;gBACL,OAAO,EAAE;oBACP,CAAC,EAAE,CAAC,EAAE;wBACJ,aAAa,EAAE,CAAC,YAAY,CAAC;qBAC9B;iBACF;aACF,CAAC;QACJ,CAAC;KAAA;CACF;AAxBD,8CAwBC","sourcesContent":["import type {\n  NameProvider,\n  NameProviderMetadata,\n  NameProviderRequest,\n  NameProviderResult,\n} from '../types';\nimport { NameType } from '../types';\nimport { handleFetch } from '../util';\n\nconst ID = 'token';\nconst LABEL = 'Blockchain (Token Name)';\n\nexport class TokenNameProvider implements NameProvider {\n  getMetadata(): NameProviderMetadata {\n    return {\n      sourceIds: { [NameType.ETHEREUM_ADDRESS]: [ID] },\n      sourceLabels: { [ID]: LABEL },\n    };\n  }\n\n  async getProposedNames(\n    request: NameProviderRequest,\n  ): Promise<NameProviderResult> {\n    const { value, chainId } = request;\n    const url = `https://token-api.metaswap.codefi.network/token/${chainId}?address=${value}`;\n    const responseData = await handleFetch(url);\n    const proposedName = responseData.name;\n\n    return {\n      results: {\n        [ID]: {\n          proposedNames: [proposedName],\n        },\n      },\n    };\n  }\n}\n"]}
+{"version":3,"file":"token.js","sourceRoot":"","sources":["../../src/providers/token.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAAA,sCAA8D;AAO9D,oCAAoC;AACpC,kCAAsC;AAEtC,MAAM,EAAE,GAAG,OAAO,CAAC;AACnB,MAAM,KAAK,GAAG,yBAAyB,CAAC;AAExC,MAAM,GAAG,GAAG,IAAA,2BAAkB,EAAC,sBAAa,EAAE,OAAO,CAAC,CAAC;AAEvD,MAAa,iBAAiB;IAG5B,YAAY,EAAE,SAAS,KAAoC,EAAE;QAF7D,+CAA0B;QAGxB,uBAAA,IAAI,gCAAc,SAAS,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAA,CAAC;IAC9C,CAAC;IAED,WAAW;QACT,OAAO;YACL,SAAS,EAAE,EAAE,CAAC,gBAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE;YAChD,YAAY,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE;SAC9B,CAAC;IACJ,CAAC;IAEK,gBAAgB,CACpB,OAA4B;;YAE5B,IAAI,CAAC,uBAAA,IAAI,oCAAW,MAAf,IAAI,CAAa,EAAE;gBACtB,GAAG,CAAC,8BAA8B,CAAC,CAAC;gBAEpC,OAAO;oBACL,OAAO,EAAE;wBACP,CAAC,EAAE,CAAC,EAAE;4BACJ,aAAa,EAAE,EAAE;yBAClB;qBACF;iBACF,CAAC;aACH;YAED,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;YAC9C,MAAM,GAAG,GAAG,mDAAmD,OAAO,YAAY,KAAK,EAAE,CAAC;YAE1F,GAAG,CAAC,iBAAiB,EAAE,GAAG,CAAC,CAAC;YAE5B,IAAI;gBACF,MAAM,YAAY,GAAG,MAAM,IAAA,kBAAW,EAAC,GAAG,CAAC,CAAC;gBAC5C,MAAM,YAAY,GAAG,YAAY,CAAC,IAAI,CAAC;gBACvC,MAAM,aAAa,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBAEzD,GAAG,CAAC,oBAAoB,EAAE,aAAa,CAAC,CAAC;gBAEzC,OAAO;oBACL,OAAO,EAAE;wBACP,CAAC,EAAE,CAAC,EAAE;4BACJ,aAAa;yBACd;qBACF;iBACF,CAAC;aACH;YAAC,OAAO,KAAK,EAAE;gBACd,GAAG,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAC;gBAC7B,MAAM,KAAK,CAAC;aACb;QACH,CAAC;KAAA;CACF;AArDD,8CAqDC","sourcesContent":["import { createModuleLogger, projectLogger } from '../logger';\nimport type {\n  NameProvider,\n  NameProviderMetadata,\n  NameProviderRequest,\n  NameProviderResult,\n} from '../types';\nimport { NameType } from '../types';\nimport { handleFetch } from '../util';\n\nconst ID = 'token';\nconst LABEL = 'Blockchain (Token Name)';\n\nconst log = createModuleLogger(projectLogger, 'token');\n\nexport class TokenNameProvider implements NameProvider {\n  #isEnabled: () => boolean;\n\n  constructor({ isEnabled }: { isEnabled?: () => boolean } = {}) {\n    this.#isEnabled = isEnabled || (() => true);\n  }\n\n  getMetadata(): NameProviderMetadata {\n    return {\n      sourceIds: { [NameType.ETHEREUM_ADDRESS]: [ID] },\n      sourceLabels: { [ID]: LABEL },\n    };\n  }\n\n  async getProposedNames(\n    request: NameProviderRequest,\n  ): Promise<NameProviderResult> {\n    if (!this.#isEnabled()) {\n      log('Skipping request as disabled');\n\n      return {\n        results: {\n          [ID]: {\n            proposedNames: [],\n          },\n        },\n      };\n    }\n\n    const { value, variation: chainId } = request;\n    const url = `https://token-api.metaswap.codefi.network/token/${chainId}?address=${value}`;\n\n    log('Sending request', url);\n\n    try {\n      const responseData = await handleFetch(url);\n      const proposedName = responseData.name;\n      const proposedNames = proposedName ? [proposedName] : [];\n\n      log('New proposed names', proposedNames);\n\n      return {\n        results: {\n          [ID]: {\n            proposedNames,\n          },\n        },\n      };\n    } catch (error) {\n      log('Request failed', error);\n      throw error;\n    }\n  }\n}\n"]}

package/dist/types.d.ts

@@ -18,14 +18,17 @@ export declare type NameProviderMetadata = {
 };
 /** The request data to get proposed names from a name provider. */
 export declare type NameProviderRequest = {
-    /** The current chain ID of the client. */
-    chainId: string;
     /** The optional list of source IDs to get proposed names from. */
     sourceIds?: string[];
     /** The type of name being requested. */
     type: NameType;
     /** The raw value to get proposed names for. */
     value: string;
+    /**
+     * The variation of the raw value to get proposed names for.
+     * For example, the chain ID if the raw value is an Ethereum address.
+     */
+    variation: string;
 };
 /** The resulting data after requesting proposed names from a name provider, for a single source. */
 export declare type NameProviderSourceResult = {
@@ -34,6 +37,11 @@ export declare type NameProviderSourceResult = {
      * Undefined if there is an error.
      */
     proposedNames?: string[];
+    /**
+     * The delay in seconds before the next request to the source should be made.
+     * Can be used to avoid rate limiting for example.
+     */
+    updateDelay?: number;
     /**
      * An error that occurred while fetching the proposed names from the source.
      * Undefined if there was no error.

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,oBAAY,QAAQ;IAClB,0CAA0C;IAC1C,gBAAgB,oBAAoB;CACrC;AAED,wCAAwC;AACxC,oBAAY,oBAAoB,GAAG;IACjC;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;IAEtC;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACtC,CAAC;AAEF,mEAAmE;AACnE,oBAAY,mBAAmB,GAAG;IAChC,0CAA0C;IAC1C,OAAO,EAAE,MAAM,CAAC;IAEhB,kEAAkE;IAClE,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IAErB,wCAAwC;IACxC,IAAI,EAAE,QAAQ,CAAC;IAEf,+CAA+C;IAC/C,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,oGAAoG;AACpG,oBAAY,wBAAwB,GAAG;IACrC;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzB;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,+EAA+E;AAC/E,oBAAY,kBAAkB,GAAG;IAC/B;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;IAElD;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,qFAAqF;AACrF,oBAAY,YAAY,GAAG;IACzB;;OAEG;IACH,WAAW,IAAI,oBAAoB,CAAC;IAEpC;;;;OAIG;IACH,gBAAgB,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;CAC7E,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,oBAAY,QAAQ;IAClB,0CAA0C;IAC1C,gBAAgB,oBAAoB;CACrC;AAED,wCAAwC;AACxC,oBAAY,oBAAoB,GAAG;IACjC;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;IAEtC;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACtC,CAAC;AAEF,mEAAmE;AACnE,oBAAY,mBAAmB,GAAG;IAChC,kEAAkE;IAClE,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IAErB,wCAAwC;IACxC,IAAI,EAAE,QAAQ,CAAC;IAEf,+CAA+C;IAC/C,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,oGAAoG;AACpG,oBAAY,wBAAwB,GAAG;IACrC;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,+EAA+E;AAC/E,oBAAY,kBAAkB,GAAG;IAC/B;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;IAElD;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,qFAAqF;AACrF,oBAAY,YAAY,GAAG;IACzB;;OAEG;IACH,WAAW,IAAI,oBAAoB,CAAC;IAEpC;;;;OAIG;IACH,gBAAgB,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;CAC7E,CAAC"}

package/dist/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAAA,sDAAsD;AACtD,IAAY,QAGX;AAHD,WAAY,QAAQ;IAClB,0CAA0C;IAC1C,gDAAoC,CAAA;AACtC,CAAC,EAHW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAGnB","sourcesContent":["/** The name types supported by the NameController. */\nexport enum NameType {\n  /** The address of an Ethereum account. */\n  ETHEREUM_ADDRESS = 'ethereumAddress',\n}\n\n/** The metadata for a name provider. */\nexport type NameProviderMetadata = {\n  /**\n   * IDs for each alternate source of proposed names.\n   * Keyed by the name type.\n   */\n  sourceIds: Record<NameType, string[]>;\n\n  /**\n   * Friendly labels to describe each source of proposed names.\n   * Keyed by the source ID.\n   */\n  sourceLabels: Record<string, string>;\n};\n\n/** The request data to get proposed names from a name provider. */\nexport type NameProviderRequest = {\n  /** The current chain ID of the client. */\n  chainId: string;\n\n  /** The optional list of source IDs to get proposed names from. */\n  sourceIds?: string[];\n\n  /** The type of name being requested. */\n  type: NameType;\n\n  /** The raw value to get proposed names for. */\n  value: string;\n};\n\n/** The resulting data after requesting proposed names from a name provider, for a single source. */\nexport type NameProviderSourceResult = {\n  /**\n   * The array of proposed names from the source.\n   * Undefined if there is an error.\n   */\n  proposedNames?: string[];\n\n  /**\n   * An error that occurred while fetching the proposed names from the source.\n   * Undefined if there was no error.\n   */\n  error?: unknown;\n};\n\n/** The resulting data after requesting proposed names from a name provider. */\nexport type NameProviderResult = {\n  /**\n   * The resulting data from each alternate source of proposed names supported by the name provider.\n   * Keyed by the source ID.\n   */\n  results: Record<string, NameProviderSourceResult>;\n\n  /**\n   * An error that occurred while fetching the proposed names that was not specific to a single source.\n   * Undefined if there was no error.\n   */\n  error?: unknown;\n};\n\n/** An object capable of proposing friendly names for a raw value of a given type. */\nexport type NameProvider = {\n  /**\n   * Returns metadata about the name provider.\n   */\n  getMetadata(): NameProviderMetadata;\n\n  /**\n   * Returns proposed names for the given value and request data.\n   *\n   * @param request - The request data including the value to propose names for.\n   */\n  getProposedNames(request: NameProviderRequest): Promise<NameProviderResult>;\n};\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAAA,sDAAsD;AACtD,IAAY,QAGX;AAHD,WAAY,QAAQ;IAClB,0CAA0C;IAC1C,gDAAoC,CAAA;AACtC,CAAC,EAHW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAGnB","sourcesContent":["/** The name types supported by the NameController. */\nexport enum NameType {\n  /** The address of an Ethereum account. */\n  ETHEREUM_ADDRESS = 'ethereumAddress',\n}\n\n/** The metadata for a name provider. */\nexport type NameProviderMetadata = {\n  /**\n   * IDs for each alternate source of proposed names.\n   * Keyed by the name type.\n   */\n  sourceIds: Record<NameType, string[]>;\n\n  /**\n   * Friendly labels to describe each source of proposed names.\n   * Keyed by the source ID.\n   */\n  sourceLabels: Record<string, string>;\n};\n\n/** The request data to get proposed names from a name provider. */\nexport type NameProviderRequest = {\n  /** The optional list of source IDs to get proposed names from. */\n  sourceIds?: string[];\n\n  /** The type of name being requested. */\n  type: NameType;\n\n  /** The raw value to get proposed names for. */\n  value: string;\n\n  /**\n   * The variation of the raw value to get proposed names for.\n   * For example, the chain ID if the raw value is an Ethereum address.\n   */\n  variation: string;\n};\n\n/** The resulting data after requesting proposed names from a name provider, for a single source. */\nexport type NameProviderSourceResult = {\n  /**\n   * The array of proposed names from the source.\n   * Undefined if there is an error.\n   */\n  proposedNames?: string[];\n\n  /**\n   * The delay in seconds before the next request to the source should be made.\n   * Can be used to avoid rate limiting for example.\n   */\n  updateDelay?: number;\n\n  /**\n   * An error that occurred while fetching the proposed names from the source.\n   * Undefined if there was no error.\n   */\n  error?: unknown;\n};\n\n/** The resulting data after requesting proposed names from a name provider. */\nexport type NameProviderResult = {\n  /**\n   * The resulting data from each alternate source of proposed names supported by the name provider.\n   * Keyed by the source ID.\n   */\n  results: Record<string, NameProviderSourceResult>;\n\n  /**\n   * An error that occurred while fetching the proposed names that was not specific to a single source.\n   * Undefined if there was no error.\n   */\n  error?: unknown;\n};\n\n/** An object capable of proposing friendly names for a raw value of a given type. */\nexport type NameProvider = {\n  /**\n   * Returns metadata about the name provider.\n   */\n  getMetadata(): NameProviderMetadata;\n\n  /**\n   * Returns proposed names for the given value and request data.\n   *\n   * @param request - The request data including the value to propose names for.\n   */\n  getProposedNames(request: NameProviderRequest): Promise<NameProviderResult>;\n};\n"]}

package/dist/util.d.ts

@@ -22,4 +22,14 @@ export declare function handleFetch(request: string, options?: RequestInit): Pro
  * @returns The fetch response.
  */
 export declare function successfulFetch(request: string, options?: RequestInit): Promise<Response>;
+/**
+ * Assert that a value is an error. If it's not an error, throw an
+ * error that wraps the given value.
+ *
+ * TODO: Migrate this to @metamask/utils
+ *
+ * @param error - The value that we expect to be an error.
+ * @throws Throws an error wrapping the given value if it's not an error.
+ */
+export declare function assertIsError(error: unknown): asserts error is Error;
 //# sourceMappingURL=util.d.ts.map

package/dist/util.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,wBAAsB,OAAO,CAAC,CAAC,EAC7B,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC7B,OAAO,CAAC,CAAC,CAAC,CAeZ;AAID;;;;;;GAMG;AACH,wBAAsB,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,gBAIvE;AAED;;;;;;GAMG;AACH,wBAAsB,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,qBAQ3E"}
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,wBAAsB,OAAO,CAAC,CAAC,EAC7B,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC7B,OAAO,CAAC,CAAC,CAAC,CAeZ;AAID;;;;;;GAMG;AACH,wBAAsB,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,gBAIvE;AAED;;;;;;GAMG;AACH,wBAAsB,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,qBAQ3E;AAED;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,KAAK,IAAI,KAAK,CAKpE"}

package/dist/util.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.successfulFetch = exports.handleFetch = exports.graphQL = void 0;
+exports.assertIsError = exports.successfulFetch = exports.handleFetch = exports.graphQL = void 0;
 /**
  * Execute a GraphQL query.
  *
@@ -67,4 +67,20 @@ function successfulFetch(request, options) {
     });
 }
 exports.successfulFetch = successfulFetch;
+/**
+ * Assert that a value is an error. If it's not an error, throw an
+ * error that wraps the given value.
+ *
+ * TODO: Migrate this to @metamask/utils
+ *
+ * @param error - The value that we expect to be an error.
+ * @throws Throws an error wrapping the given value if it's not an error.
+ */
+function assertIsError(error) {
+    if (error instanceof Error) {
+        return;
+    }
+    throw new Error(`Invalid error of type '${typeof error}'`);
+}
+exports.assertIsError = assertIsError;
 //# sourceMappingURL=util.js.map

package/dist/util.js.map

@@ -1 +1 @@
-{"version":3,"file":"util.js","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA;;;;;;GAMG;AACH,SAAsB,OAAO,CAC3B,GAAW,EACX,KAAa,EACb,SAA8B;;QAE9B,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC;YAC1B,KAAK;YACL,SAAS;SACV,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,GAAG,EAAE;YACtC,IAAI;YACJ,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;SACF,CAAC,CAAC;QAEH,OAAO,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,IAAI,CAAC;IACxB,CAAC;CAAA;AAnBD,0BAmBC;AAED,+FAA+F;AAE/F;;;;;;GAMG;AACH,SAAsB,WAAW,CAAC,OAAe,EAAE,OAAqB;;QACtE,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACzD,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACrC,OAAO,MAAM,CAAC;IAChB,CAAC;CAAA;AAJD,kCAIC;AAED;;;;;;GAMG;AACH,SAAsB,eAAe,CAAC,OAAe,EAAE,OAAqB;;QAC1E,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC/C,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE;YAChB,MAAM,IAAI,KAAK,CACb,6BAA6B,QAAQ,CAAC,MAAM,kBAAkB,OAAO,GAAG,CACzE,CAAC;SACH;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;CAAA;AARD,0CAQC","sourcesContent":["/**\n * Execute a GraphQL query.\n *\n * @param url - GraphQL endpoint URL.\n * @param query - GraphQL query.\n * @param variables - GraphQL variables.\n */\nexport async function graphQL<T>(\n  url: string,\n  query: string,\n  variables: Record<string, any>,\n): Promise<T> {\n  const body = JSON.stringify({\n    query,\n    variables,\n  });\n\n  const response = await handleFetch(url, {\n    body,\n    method: 'POST',\n    headers: {\n      'Content-Type': 'application/json',\n    },\n  });\n\n  return response?.data;\n}\n\n// Below functions are intentionally copied from controller-utils to avoid a package dependency\n\n/**\n * Execute fetch and return object response.\n *\n * @param request - The request information.\n * @param options - The fetch options.\n * @returns The fetch response JSON data.\n */\nexport async function handleFetch(request: string, options?: RequestInit) {\n  const response = await successfulFetch(request, options);\n  const object = await response.json();\n  return object;\n}\n\n/**\n * Execute fetch and verify that the response was successful.\n *\n * @param request - Request information.\n * @param options - Fetch options.\n * @returns The fetch response.\n */\nexport async function successfulFetch(request: string, options?: RequestInit) {\n  const response = await fetch(request, options);\n  if (!response.ok) {\n    throw new Error(\n      `Fetch failed with status '${response.status}' for request '${request}'`,\n    );\n  }\n  return response;\n}\n"]}
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA;;;;;;GAMG;AACH,SAAsB,OAAO,CAC3B,GAAW,EACX,KAAa,EACb,SAA8B;;QAE9B,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC;YAC1B,KAAK;YACL,SAAS;SACV,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,GAAG,EAAE;YACtC,IAAI;YACJ,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;SACF,CAAC,CAAC;QAEH,OAAO,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,IAAI,CAAC;IACxB,CAAC;CAAA;AAnBD,0BAmBC;AAED,+FAA+F;AAE/F;;;;;;GAMG;AACH,SAAsB,WAAW,CAAC,OAAe,EAAE,OAAqB;;QACtE,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACzD,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACrC,OAAO,MAAM,CAAC;IAChB,CAAC;CAAA;AAJD,kCAIC;AAED;;;;;;GAMG;AACH,SAAsB,eAAe,CAAC,OAAe,EAAE,OAAqB;;QAC1E,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC/C,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE;YAChB,MAAM,IAAI,KAAK,CACb,6BAA6B,QAAQ,CAAC,MAAM,kBAAkB,OAAO,GAAG,CACzE,CAAC;SACH;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;CAAA;AARD,0CAQC;AAED;;;;;;;;GAQG;AACH,SAAgB,aAAa,CAAC,KAAc;IAC1C,IAAI,KAAK,YAAY,KAAK,EAAE;QAC1B,OAAO;KACR;IACD,MAAM,IAAI,KAAK,CAAC,0BAA0B,OAAO,KAAK,GAAG,CAAC,CAAC;AAC7D,CAAC;AALD,sCAKC","sourcesContent":["/**\n * Execute a GraphQL query.\n *\n * @param url - GraphQL endpoint URL.\n * @param query - GraphQL query.\n * @param variables - GraphQL variables.\n */\nexport async function graphQL<T>(\n  url: string,\n  query: string,\n  variables: Record<string, any>,\n): Promise<T> {\n  const body = JSON.stringify({\n    query,\n    variables,\n  });\n\n  const response = await handleFetch(url, {\n    body,\n    method: 'POST',\n    headers: {\n      'Content-Type': 'application/json',\n    },\n  });\n\n  return response?.data;\n}\n\n// Below functions are intentionally copied from controller-utils to avoid a package dependency\n\n/**\n * Execute fetch and return object response.\n *\n * @param request - The request information.\n * @param options - The fetch options.\n * @returns The fetch response JSON data.\n */\nexport async function handleFetch(request: string, options?: RequestInit) {\n  const response = await successfulFetch(request, options);\n  const object = await response.json();\n  return object;\n}\n\n/**\n * Execute fetch and verify that the response was successful.\n *\n * @param request - Request information.\n * @param options - Fetch options.\n * @returns The fetch response.\n */\nexport async function successfulFetch(request: string, options?: RequestInit) {\n  const response = await fetch(request, options);\n  if (!response.ok) {\n    throw new Error(\n      `Fetch failed with status '${response.status}' for request '${request}'`,\n    );\n  }\n  return response;\n}\n\n/**\n * Assert that a value is an error. If it's not an error, throw an\n * error that wraps the given value.\n *\n * TODO: Migrate this to @metamask/utils\n *\n * @param error - The value that we expect to be an error.\n * @throws Throws an error wrapping the given value if it's not an error.\n */\nexport function assertIsError(error: unknown): asserts error is Error {\n  if (error instanceof Error) {\n    return;\n  }\n  throw new Error(`Invalid error of type '${typeof error}'`);\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/name-controller",
-  "version": "1.0.0",
+  "version": "3.0.0",
   "description": "Stores and suggests names for values such as Ethereum addresses",
   "keywords": [
     "MetaMask",
@@ -26,10 +26,13 @@
     "prepare-manifest:preview": "../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
     "test": "jest",
+    "test:clean": "jest --clearCache",
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@metamask/base-controller": "^3.2.1",
+    "@metamask/base-controller": "^3.2.2",
+    "@metamask/utils": "^6.2.0",
+    "async-mutex": "^0.2.6",
     "immer": "^9.0.6"
   },
   "devDependencies": {
@@ -38,9 +41,9 @@
     "deepmerge": "^4.2.2",
     "jest": "^27.5.1",
     "ts-jest": "^27.1.4",
-    "typedoc": "^0.22.15",
-    "typedoc-plugin-missing-exports": "^0.22.6",
-    "typescript": "~4.6.3"
+    "typedoc": "^0.23.15",
+    "typedoc-plugin-missing-exports": "^0.23.0",
+    "typescript": "~4.8.4"
   },
   "engines": {
     "node": ">=16.0.0"