@metamask-previews/config-registry-controller 2.0.1-preview-3c77cf4 → 2.0.1-preview-6b4bcdab3

package/CHANGELOG.md

@@ -7,14 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-### Added
-
-- Add `ConfigRegistryApiEnv` enum to select the API environment for the service ([#9918](https://github.com/MetaMask/core/pull/9918))
-
 ### Changed
 
-- **BREAKING:** The `env` optional constructor option type is now `ConfigRegistryApiEnv` ([#9918](https://github.com/MetaMask/core/pull/9918))
-  - Previously, constructor options were reusing the `SDK.Env` enum from `@metamask/profile-sync-controller`.
 - Bump `@metamask/superstruct` from `^3.1.0` to `^3.4.1` ([#9754](https://github.com/MetaMask/core/pull/9754))
 - Bump `@metamask/keyring-controller` from `^27.1.0` to `^27.1.1` ([#9791](https://github.com/MetaMask/core/pull/9791))
 

package/dist/ConfigRegistryController.d.cts

@@ -84,8 +84,8 @@ export type ConfigRegistryControllerOptions = {
     fallbackConfig?: Record<string, RegistryNetworkConfig>;
 };
 declare const ConfigRegistryController_base: (abstract new (...args: any[]) => {
-    readonly "__#6@#intervalIds": Record<string, NodeJS.Timeout>;
-    "__#6@#intervalLength": number | undefined;
+    readonly "__#20@#intervalIds": Record<string, NodeJS.Timeout>;
+    "__#20@#intervalLength": number | undefined;
     setIntervalLength(intervalLength: number): void;
     getIntervalLength(): number | undefined;
     _startPolling(input: null): void;

package/dist/ConfigRegistryController.d.mts

@@ -84,8 +84,8 @@ export type ConfigRegistryControllerOptions = {
     fallbackConfig?: Record<string, RegistryNetworkConfig>;
 };
 declare const ConfigRegistryController_base: (abstract new (...args: any[]) => {
-    readonly "__#6@#intervalIds": Record<string, NodeJS.Timeout>;
-    "__#6@#intervalLength": number | undefined;
+    readonly "__#20@#intervalIds": Record<string, NodeJS.Timeout>;
+    "__#20@#intervalLength": number | undefined;
     setIntervalLength(intervalLength: number): void;
     getIntervalLength(): number | undefined;
     _startPolling(input: null): void;

package/dist/config-registry-api-service/config-registry-api-service.cjs

@@ -12,16 +12,11 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 };
 var _ConfigRegistryApiService_messenger, _ConfigRegistryApiService_policy, _ConfigRegistryApiService_url, _ConfigRegistryApiService_fetch, _ConfigRegistryApiService_cachedResponse;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConfigRegistryApiService = exports.serviceName = exports.ConfigRegistryApiEnv = void 0;
+exports.ConfigRegistryApiService = exports.serviceName = void 0;
 const controller_utils_1 = require("@metamask/controller-utils");
+const profile_sync_controller_1 = require("@metamask/profile-sync-controller");
 const types_js_1 = require("./types.cjs");
 const ENDPOINT_PATH = '/config/networks';
-var ConfigRegistryApiEnv;
-(function (ConfigRegistryApiEnv) {
-    ConfigRegistryApiEnv["DEV"] = "dev";
-    ConfigRegistryApiEnv["UAT"] = "uat";
-    ConfigRegistryApiEnv["PRD"] = "prod";
-})(ConfigRegistryApiEnv || (exports.ConfigRegistryApiEnv = ConfigRegistryApiEnv = {}));
 /**
  * The name of the {@link ConfigRegistryApiService}, used to namespace the
  * service's actions and events.
@@ -37,7 +32,7 @@ const MESSENGER_EXPOSED_METHODS = ['fetchConfig'];
  * @returns The base URL for the environment.
  */
 function getConfigRegistryUrl(env) {
-    const envPrefix = env === ConfigRegistryApiEnv.PRD ? '' : `${env}-`;
+    const envPrefix = env === profile_sync_controller_1.SDK.Env.PRD ? '' : `${env}-`;
     return `https://client-config.${envPrefix}api.cx.metamask.io/v1${ENDPOINT_PATH}`;
 }
 class ConfigRegistryApiService {
@@ -50,7 +45,7 @@ class ConfigRegistryApiService {
      * @param options.fetch - Custom fetch function for testing or custom implementations. Defaults to the global fetch.
      * @param options.policyOptions - Options to pass to `createServicePolicy`, which wraps each request. See {@link CreateServicePolicyOptions}.
      */
-    constructor({ messenger, env = ConfigRegistryApiEnv.UAT, fetch: customFetch = globalThis.fetch, policyOptions = {}, }) {
+    constructor({ messenger, env = profile_sync_controller_1.SDK.Env.UAT, fetch: customFetch = globalThis.fetch, policyOptions = {}, }) {
         _ConfigRegistryApiService_messenger.set(this, void 0);
         _ConfigRegistryApiService_policy.set(this, void 0);
         _ConfigRegistryApiService_url.set(this, void 0);

package/dist/config-registry-api-service/config-registry-api-service.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"config-registry-api-service.cjs","sourceRoot":"","sources":["../../src/config-registry-api-service/config-registry-api-service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,iEAA4E;AAc5E,0CAA+D;AAE/D,MAAM,aAAa,GAAG,kBAAkB,CAAC;AAEzC,IAAY,oBAIX;AAJD,WAAY,oBAAoB;IAC9B,mCAAW,CAAA;IACX,mCAAW,CAAA;IACX,oCAAY,CAAA;AACd,CAAC,EAJW,oBAAoB,oCAApB,oBAAoB,QAI/B;AAED;;;GAGG;AACU,QAAA,WAAW,GAAG,0BAA0B,CAAC;AAEtD,oBAAoB;AAEpB,MAAM,yBAAyB,GAAG,CAAC,aAAa,CAAU,CAAC;AAiC3D,6BAA6B;AAE7B;;;;;GAKG;AACH,SAAS,oBAAoB,CAAC,GAAyB;IACrD,MAAM,SAAS,GAAG,GAAG,KAAK,oBAAoB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,CAAC;IACpE,OAAO,yBAAyB,SAAS,wBAAwB,aAAa,EAAE,CAAC;AACnF,CAAC;AAiBD,MAAa,wBAAwB;IAcnC;;;;;;;;OAQG;IACH,YAAY,EACV,SAAS,EACT,GAAG,GAAG,oBAAoB,CAAC,GAAG,EAC9B,KAAK,EAAE,WAAW,GAAG,UAAU,CAAC,KAAK,EACrC,aAAa,GAAG,EAAE,GACc;QAzBzB,sDAA8C;QAE9C,mDAAuB;QAEvB,gDAAa;QAEb,kDAAqB;QAE9B,oFAAoF;QACpF,mDAAoD,IAAI,EAAC;QAiBvD,IAAI,CAAC,IAAI,GAAG,mBAAW,CAAC;QACxB,uBAAA,IAAI,uCAAc,SAAS,MAAA,CAAC;QAC5B,uBAAA,IAAI,iCAAQ,oBAAoB,CAAC,GAAG,CAAC,MAAA,CAAC;QACtC,uBAAA,IAAI,mCAAU,WAAW,MAAA,CAAC;QAE1B,uBAAA,IAAI,oCAAW,IAAA,sCAAmB,EAAC,aAAa,CAAC,MAAA,CAAC;QAElD,uBAAA,IAAI,2CAAW,CAAC,4BAA4B,CAC1C,IAAI,EACJ,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,OAAO,CAAC,QAAiD;QACvD,OAAO,uBAAA,IAAI,wCAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;;OASG;IACH,OAAO,CACL,GAAG,IAA0C;QAE7C,OAAO,uBAAA,IAAI,wCAAQ,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;IACvC,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,UAAU,CACR,GAAG,IAA6C;QAEhD,OAAO,uBAAA,IAAI,wCAAQ,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC;IAC1C,CAAC;IAED,KAAK,CAAC,WAAW,CACf,UAA8B,EAAE;QAEhC,MAAM,OAAO,GAAgB;YAC3B,eAAe,EAAE,UAAU;SAC5B,CAAC;QAEF,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;YACjB,OAAO,CAAC,eAAe,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;QAC1C,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,uBAAA,IAAI,wCAAQ,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE;YACrD,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,uCAAO,MAAX,IAAI,EAAQ,uBAAA,IAAI,qCAAK,EAAE;gBACvC,OAAO;aACR,CAAC,CAAC;YAEH,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBACvB,OAAO,GAAG,CAAC;YACb,CAAC;YAED,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;gBACZ,MAAM,IAAI,4BAAS,CACjB,GAAG,CAAC,MAAM,EACV,2BAA2B,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,UAAU,EAAE,CAC1D,CAAC;YACJ,CAAC;YAED,OAAO,GAAG,CAAC;QACb,CAAC,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC5B,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,SAAS,CAAC;YACvD,OAAO;gBACL,QAAQ,EAAE,KAAK;gBACf,IAAI;gBACJ,GAAG,CAAC,uBAAA,IAAI,gDAAgB,KAAK,IAAI,IAAI,EAAE,IAAI,EAAE,uBAAA,IAAI,gDAAgB,EAAE,CAAC;aACrE,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,SAAS,CAAC;QACvD,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAEvC,IAAA,4CAAiC,EAAC,QAAQ,CAAC,CAAC;QAE5C,uBAAA,IAAI,4CAAmB,QAAQ,MAAA,CAAC;QAEhC,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,IAAI;YACJ,QAAQ,EAAE,IAAI;SACf,CAAC;IACJ,CAAC;CACF;AApJD,4DAoJC","sourcesContent":["import { createServicePolicy, HttpError } from '@metamask/controller-utils';\nimport type {\n  CreateServicePolicyOptions,\n  ServicePolicy,\n} from '@metamask/controller-utils';\nimport type { Messenger } from '@metamask/messenger';\nimport type { IDisposable } from 'cockatiel';\n\nimport type { ConfigRegistryApiServiceMethodActions } from './config-registry-api-service-method-action-types.js';\nimport type {\n  FetchConfigOptions,\n  FetchConfigResult,\n  RegistryConfigApiResponse,\n} from './types.js';\nimport { validateRegistryConfigApiResponse } from './types.js';\n\nconst ENDPOINT_PATH = '/config/networks';\n\nexport enum ConfigRegistryApiEnv {\n  DEV = 'dev',\n  UAT = 'uat',\n  PRD = 'prod',\n}\n\n/**\n * The name of the {@link ConfigRegistryApiService}, used to namespace the\n * service's actions and events.\n */\nexport const serviceName = 'ConfigRegistryApiService';\n\n// === MESSENGER ===\n\nconst MESSENGER_EXPOSED_METHODS = ['fetchConfig'] as const;\n\n/**\n * Actions that {@link ConfigRegistryApiService} exposes to other consumers.\n */\nexport type ConfigRegistryApiServiceActions =\n  ConfigRegistryApiServiceMethodActions;\n\n/**\n * Actions from other messengers that {@link ConfigRegistryApiServiceMessenger} calls.\n */\ntype AllowedActions = never;\n\n/**\n * Events that {@link ConfigRegistryApiService} exposes to other consumers.\n */\nexport type ConfigRegistryApiServiceEvents = never;\n\n/**\n * Events from other messengers that {@link ConfigRegistryApiService} subscribes to.\n */\ntype AllowedEvents = never;\n\n/**\n * The messenger which is restricted to actions and events accessed by\n * {@link ConfigRegistryApiService}.\n */\nexport type ConfigRegistryApiServiceMessenger = Messenger<\n  typeof serviceName,\n  ConfigRegistryApiServiceActions | AllowedActions,\n  ConfigRegistryApiServiceEvents | AllowedEvents\n>;\n\n// === SERVICE DEFINITION ===\n\n/**\n * Returns the base URL for the config registry API for the given environment.\n *\n * @param env - The environment to get the URL for.\n * @returns The base URL for the environment.\n */\nfunction getConfigRegistryUrl(env: ConfigRegistryApiEnv): string {\n  const envPrefix = env === ConfigRegistryApiEnv.PRD ? '' : `${env}-`;\n  return `https://client-config.${envPrefix}api.cx.metamask.io/v1${ENDPOINT_PATH}`;\n}\n\nexport type ConfigRegistryApiServiceOptions = {\n  /**\n   * The messenger suited for this service. Required so the service can be used\n   * independently and register its actions.\n   */\n  messenger: ConfigRegistryApiServiceMessenger;\n  env?: ConfigRegistryApiEnv;\n  fetch?: typeof fetch;\n  /**\n   * Options to pass to `createServicePolicy`, which wraps each request.\n   * See {@link CreateServicePolicyOptions}.\n   */\n  policyOptions?: CreateServicePolicyOptions;\n};\n\nexport class ConfigRegistryApiService {\n  readonly name: typeof serviceName;\n\n  readonly #messenger: ConfigRegistryApiServiceMessenger;\n\n  readonly #policy: ServicePolicy;\n\n  readonly #url: string;\n\n  readonly #fetch: typeof fetch;\n\n  /** Cached response from the last successful fetch. Used when server returns 304. */\n  #cachedResponse: RegistryConfigApiResponse | null = null;\n\n  /**\n   * Construct a Config Registry API Service.\n   *\n   * @param options - The options for constructing the service.\n   * @param options.messenger - The messenger suited for this service.\n   * @param options.env - The environment to determine the correct API endpoints. Defaults to UAT.\n   * @param options.fetch - Custom fetch function for testing or custom implementations. Defaults to the global fetch.\n   * @param options.policyOptions - Options to pass to `createServicePolicy`, which wraps each request. See {@link CreateServicePolicyOptions}.\n   */\n  constructor({\n    messenger,\n    env = ConfigRegistryApiEnv.UAT,\n    fetch: customFetch = globalThis.fetch,\n    policyOptions = {},\n  }: ConfigRegistryApiServiceOptions) {\n    this.name = serviceName;\n    this.#messenger = messenger;\n    this.#url = getConfigRegistryUrl(env);\n    this.#fetch = customFetch;\n\n    this.#policy = createServicePolicy(policyOptions);\n\n    this.#messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n  }\n\n  /**\n   * Registers a handler that will be called after a request returns a non-500\n   * response, causing a retry. Primarily useful in tests where timers are being\n   * mocked.\n   *\n   * @param listener - The handler to be called.\n   * @returns An object that can be used to unregister the handler. See\n   * {@link CockatielEvent}.\n   * @see {@link createServicePolicy}\n   */\n  onRetry(listener: Parameters<ServicePolicy['onRetry']>[0]): IDisposable {\n    return this.#policy.onRetry(listener);\n  }\n\n  /**\n   * Registers a handler that will be called after a set number of retry rounds\n   * prove that requests to the API endpoint consistently return a 5xx response.\n   *\n   * @param args - The arguments passed to the underlying policy's onBreak method\n   * (e.g. the listener to be called).\n   * @returns An object that can be used to unregister the handler. See\n   * {@link CockatielEvent}.\n   * @see {@link createServicePolicy}\n   */\n  onBreak(\n    ...args: Parameters<ServicePolicy['onBreak']>\n  ): ReturnType<ServicePolicy['onBreak']> {\n    return this.#policy.onBreak(...args);\n  }\n\n  /**\n   * Registers a handler that will be called under one of two circumstances:\n   *\n   * 1. After a set number of retries prove that requests to the API\n   * consistently result in one of the following failures:\n   *    1. A connection initiation error\n   *    2. A connection reset error\n   *    3. A timeout error\n   *    4. A non-JSON response\n   *    5. A 502, 503, or 504 response\n   * 2. After a successful request is made to the API, but the response takes\n   * longer than a set duration to return.\n   *\n   * @param args - The arguments passed to the underlying policy's onDegraded\n   * method (e.g. the listener to be called).\n   * @returns An object that can be used to unregister the handler. See\n   * {@link CockatielEvent}.\n   */\n  onDegraded(\n    ...args: Parameters<ServicePolicy['onDegraded']>\n  ): ReturnType<ServicePolicy['onDegraded']> {\n    return this.#policy.onDegraded(...args);\n  }\n\n  async fetchConfig(\n    options: FetchConfigOptions = {},\n  ): Promise<FetchConfigResult> {\n    const headers: HeadersInit = {\n      'Cache-Control': 'no-cache',\n    };\n\n    if (options.etag) {\n      headers['If-None-Match'] = options.etag;\n    }\n\n    const response = await this.#policy.execute(async () => {\n      const res = await this.#fetch(this.#url, {\n        headers,\n      });\n\n      if (res.status === 304) {\n        return res;\n      }\n\n      if (!res.ok) {\n        throw new HttpError(\n          res.status,\n          `Failed to fetch config: ${res.status} ${res.statusText}`,\n        );\n      }\n\n      return res;\n    });\n\n    if (response.status === 304) {\n      const etag = response.headers.get('ETag') ?? undefined;\n      return {\n        modified: false,\n        etag,\n        ...(this.#cachedResponse !== null && { data: this.#cachedResponse }),\n      };\n    }\n\n    const etag = response.headers.get('ETag') ?? undefined;\n    const jsonData = await response.json();\n\n    validateRegistryConfigApiResponse(jsonData);\n\n    this.#cachedResponse = jsonData;\n\n    return {\n      data: jsonData,\n      etag,\n      modified: true,\n    };\n  }\n}\n"]}
+{"version":3,"file":"config-registry-api-service.cjs","sourceRoot":"","sources":["../../src/config-registry-api-service/config-registry-api-service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,iEAA4E;AAM5E,+EAAwD;AASxD,0CAA+D;AAE/D,MAAM,aAAa,GAAG,kBAAkB,CAAC;AAEzC;;;GAGG;AACU,QAAA,WAAW,GAAG,0BAA0B,CAAC;AAEtD,oBAAoB;AAEpB,MAAM,yBAAyB,GAAG,CAAC,aAAa,CAAU,CAAC;AAiC3D,6BAA6B;AAE7B;;;;;GAKG;AACH,SAAS,oBAAoB,CAAC,GAAY;IACxC,MAAM,SAAS,GAAG,GAAG,KAAK,6BAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,CAAC;IACvD,OAAO,yBAAyB,SAAS,wBAAwB,aAAa,EAAE,CAAC;AACnF,CAAC;AAiBD,MAAa,wBAAwB;IAcnC;;;;;;;;OAQG;IACH,YAAY,EACV,SAAS,EACT,GAAG,GAAG,6BAAG,CAAC,GAAG,CAAC,GAAG,EACjB,KAAK,EAAE,WAAW,GAAG,UAAU,CAAC,KAAK,EACrC,aAAa,GAAG,EAAE,GACc;QAzBzB,sDAA8C;QAE9C,mDAAuB;QAEvB,gDAAa;QAEb,kDAAqB;QAE9B,oFAAoF;QACpF,mDAAoD,IAAI,EAAC;QAiBvD,IAAI,CAAC,IAAI,GAAG,mBAAW,CAAC;QACxB,uBAAA,IAAI,uCAAc,SAAS,MAAA,CAAC;QAC5B,uBAAA,IAAI,iCAAQ,oBAAoB,CAAC,GAAG,CAAC,MAAA,CAAC;QACtC,uBAAA,IAAI,mCAAU,WAAW,MAAA,CAAC;QAE1B,uBAAA,IAAI,oCAAW,IAAA,sCAAmB,EAAC,aAAa,CAAC,MAAA,CAAC;QAElD,uBAAA,IAAI,2CAAW,CAAC,4BAA4B,CAC1C,IAAI,EACJ,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,OAAO,CAAC,QAAiD;QACvD,OAAO,uBAAA,IAAI,wCAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;;OASG;IACH,OAAO,CACL,GAAG,IAA0C;QAE7C,OAAO,uBAAA,IAAI,wCAAQ,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;IACvC,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,UAAU,CACR,GAAG,IAA6C;QAEhD,OAAO,uBAAA,IAAI,wCAAQ,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC;IAC1C,CAAC;IAED,KAAK,CAAC,WAAW,CACf,UAA8B,EAAE;QAEhC,MAAM,OAAO,GAAgB;YAC3B,eAAe,EAAE,UAAU;SAC5B,CAAC;QAEF,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;YACjB,OAAO,CAAC,eAAe,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;QAC1C,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,uBAAA,IAAI,wCAAQ,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE;YACrD,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,uCAAO,MAAX,IAAI,EAAQ,uBAAA,IAAI,qCAAK,EAAE;gBACvC,OAAO;aACR,CAAC,CAAC;YAEH,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBACvB,OAAO,GAAG,CAAC;YACb,CAAC;YAED,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;gBACZ,MAAM,IAAI,4BAAS,CACjB,GAAG,CAAC,MAAM,EACV,2BAA2B,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,UAAU,EAAE,CAC1D,CAAC;YACJ,CAAC;YAED,OAAO,GAAG,CAAC;QACb,CAAC,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC5B,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,SAAS,CAAC;YACvD,OAAO;gBACL,QAAQ,EAAE,KAAK;gBACf,IAAI;gBACJ,GAAG,CAAC,uBAAA,IAAI,gDAAgB,KAAK,IAAI,IAAI,EAAE,IAAI,EAAE,uBAAA,IAAI,gDAAgB,EAAE,CAAC;aACrE,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,SAAS,CAAC;QACvD,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAEvC,IAAA,4CAAiC,EAAC,QAAQ,CAAC,CAAC;QAE5C,uBAAA,IAAI,4CAAmB,QAAQ,MAAA,CAAC;QAEhC,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,IAAI;YACJ,QAAQ,EAAE,IAAI;SACf,CAAC;IACJ,CAAC;CACF;AApJD,4DAoJC","sourcesContent":["import { createServicePolicy, HttpError } from '@metamask/controller-utils';\nimport type {\n  CreateServicePolicyOptions,\n  ServicePolicy,\n} from '@metamask/controller-utils';\nimport type { Messenger } from '@metamask/messenger';\nimport { SDK } from '@metamask/profile-sync-controller';\nimport type { IDisposable } from 'cockatiel';\n\nimport type { ConfigRegistryApiServiceMethodActions } from './config-registry-api-service-method-action-types.js';\nimport type {\n  FetchConfigOptions,\n  FetchConfigResult,\n  RegistryConfigApiResponse,\n} from './types.js';\nimport { validateRegistryConfigApiResponse } from './types.js';\n\nconst ENDPOINT_PATH = '/config/networks';\n\n/**\n * The name of the {@link ConfigRegistryApiService}, used to namespace the\n * service's actions and events.\n */\nexport const serviceName = 'ConfigRegistryApiService';\n\n// === MESSENGER ===\n\nconst MESSENGER_EXPOSED_METHODS = ['fetchConfig'] as const;\n\n/**\n * Actions that {@link ConfigRegistryApiService} exposes to other consumers.\n */\nexport type ConfigRegistryApiServiceActions =\n  ConfigRegistryApiServiceMethodActions;\n\n/**\n * Actions from other messengers that {@link ConfigRegistryApiServiceMessenger} calls.\n */\ntype AllowedActions = never;\n\n/**\n * Events that {@link ConfigRegistryApiService} exposes to other consumers.\n */\nexport type ConfigRegistryApiServiceEvents = never;\n\n/**\n * Events from other messengers that {@link ConfigRegistryApiService} subscribes to.\n */\ntype AllowedEvents = never;\n\n/**\n * The messenger which is restricted to actions and events accessed by\n * {@link ConfigRegistryApiService}.\n */\nexport type ConfigRegistryApiServiceMessenger = Messenger<\n  typeof serviceName,\n  ConfigRegistryApiServiceActions | AllowedActions,\n  ConfigRegistryApiServiceEvents | AllowedEvents\n>;\n\n// === SERVICE DEFINITION ===\n\n/**\n * Returns the base URL for the config registry API for the given environment.\n *\n * @param env - The environment to get the URL for.\n * @returns The base URL for the environment.\n */\nfunction getConfigRegistryUrl(env: SDK.Env): string {\n  const envPrefix = env === SDK.Env.PRD ? '' : `${env}-`;\n  return `https://client-config.${envPrefix}api.cx.metamask.io/v1${ENDPOINT_PATH}`;\n}\n\nexport type ConfigRegistryApiServiceOptions = {\n  /**\n   * The messenger suited for this service. Required so the service can be used\n   * independently and register its actions.\n   */\n  messenger: ConfigRegistryApiServiceMessenger;\n  env?: SDK.Env;\n  fetch?: typeof fetch;\n  /**\n   * Options to pass to `createServicePolicy`, which wraps each request.\n   * See {@link CreateServicePolicyOptions}.\n   */\n  policyOptions?: CreateServicePolicyOptions;\n};\n\nexport class ConfigRegistryApiService {\n  readonly name: typeof serviceName;\n\n  readonly #messenger: ConfigRegistryApiServiceMessenger;\n\n  readonly #policy: ServicePolicy;\n\n  readonly #url: string;\n\n  readonly #fetch: typeof fetch;\n\n  /** Cached response from the last successful fetch. Used when server returns 304. */\n  #cachedResponse: RegistryConfigApiResponse | null = null;\n\n  /**\n   * Construct a Config Registry API Service.\n   *\n   * @param options - The options for constructing the service.\n   * @param options.messenger - The messenger suited for this service.\n   * @param options.env - The environment to determine the correct API endpoints. Defaults to UAT.\n   * @param options.fetch - Custom fetch function for testing or custom implementations. Defaults to the global fetch.\n   * @param options.policyOptions - Options to pass to `createServicePolicy`, which wraps each request. See {@link CreateServicePolicyOptions}.\n   */\n  constructor({\n    messenger,\n    env = SDK.Env.UAT,\n    fetch: customFetch = globalThis.fetch,\n    policyOptions = {},\n  }: ConfigRegistryApiServiceOptions) {\n    this.name = serviceName;\n    this.#messenger = messenger;\n    this.#url = getConfigRegistryUrl(env);\n    this.#fetch = customFetch;\n\n    this.#policy = createServicePolicy(policyOptions);\n\n    this.#messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n  }\n\n  /**\n   * Registers a handler that will be called after a request returns a non-500\n   * response, causing a retry. Primarily useful in tests where timers are being\n   * mocked.\n   *\n   * @param listener - The handler to be called.\n   * @returns An object that can be used to unregister the handler. See\n   * {@link CockatielEvent}.\n   * @see {@link createServicePolicy}\n   */\n  onRetry(listener: Parameters<ServicePolicy['onRetry']>[0]): IDisposable {\n    return this.#policy.onRetry(listener);\n  }\n\n  /**\n   * Registers a handler that will be called after a set number of retry rounds\n   * prove that requests to the API endpoint consistently return a 5xx response.\n   *\n   * @param args - The arguments passed to the underlying policy's onBreak method\n   * (e.g. the listener to be called).\n   * @returns An object that can be used to unregister the handler. See\n   * {@link CockatielEvent}.\n   * @see {@link createServicePolicy}\n   */\n  onBreak(\n    ...args: Parameters<ServicePolicy['onBreak']>\n  ): ReturnType<ServicePolicy['onBreak']> {\n    return this.#policy.onBreak(...args);\n  }\n\n  /**\n   * Registers a handler that will be called under one of two circumstances:\n   *\n   * 1. After a set number of retries prove that requests to the API\n   * consistently result in one of the following failures:\n   *    1. A connection initiation error\n   *    2. A connection reset error\n   *    3. A timeout error\n   *    4. A non-JSON response\n   *    5. A 502, 503, or 504 response\n   * 2. After a successful request is made to the API, but the response takes\n   * longer than a set duration to return.\n   *\n   * @param args - The arguments passed to the underlying policy's onDegraded\n   * method (e.g. the listener to be called).\n   * @returns An object that can be used to unregister the handler. See\n   * {@link CockatielEvent}.\n   */\n  onDegraded(\n    ...args: Parameters<ServicePolicy['onDegraded']>\n  ): ReturnType<ServicePolicy['onDegraded']> {\n    return this.#policy.onDegraded(...args);\n  }\n\n  async fetchConfig(\n    options: FetchConfigOptions = {},\n  ): Promise<FetchConfigResult> {\n    const headers: HeadersInit = {\n      'Cache-Control': 'no-cache',\n    };\n\n    if (options.etag) {\n      headers['If-None-Match'] = options.etag;\n    }\n\n    const response = await this.#policy.execute(async () => {\n      const res = await this.#fetch(this.#url, {\n        headers,\n      });\n\n      if (res.status === 304) {\n        return res;\n      }\n\n      if (!res.ok) {\n        throw new HttpError(\n          res.status,\n          `Failed to fetch config: ${res.status} ${res.statusText}`,\n        );\n      }\n\n      return res;\n    });\n\n    if (response.status === 304) {\n      const etag = response.headers.get('ETag') ?? undefined;\n      return {\n        modified: false,\n        etag,\n        ...(this.#cachedResponse !== null && { data: this.#cachedResponse }),\n      };\n    }\n\n    const etag = response.headers.get('ETag') ?? undefined;\n    const jsonData = await response.json();\n\n    validateRegistryConfigApiResponse(jsonData);\n\n    this.#cachedResponse = jsonData;\n\n    return {\n      data: jsonData,\n      etag,\n      modified: true,\n    };\n  }\n}\n"]}

package/dist/config-registry-api-service/config-registry-api-service.d.cts

@@ -1,13 +1,9 @@
 import type { CreateServicePolicyOptions, ServicePolicy } from "@metamask/controller-utils";
 import type { Messenger } from "@metamask/messenger";
+import { SDK } from "@metamask/profile-sync-controller";
 import type { IDisposable } from "cockatiel";
 import type { ConfigRegistryApiServiceMethodActions } from "./config-registry-api-service-method-action-types.cjs";
 import type { FetchConfigOptions, FetchConfigResult } from "./types.cjs";
-export declare enum ConfigRegistryApiEnv {
-    DEV = "dev",
-    UAT = "uat",
-    PRD = "prod"
-}
 /**
  * The name of the {@link ConfigRegistryApiService}, used to namespace the
  * service's actions and events.
@@ -40,7 +36,7 @@ export type ConfigRegistryApiServiceOptions = {
      * independently and register its actions.
      */
     messenger: ConfigRegistryApiServiceMessenger;
-    env?: ConfigRegistryApiEnv;
+    env?: SDK.Env;
     fetch?: typeof fetch;
     /**
      * Options to pass to `createServicePolicy`, which wraps each request.

package/dist/config-registry-api-service/config-registry-api-service.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"config-registry-api-service.d.cts","sourceRoot":"","sources":["../../src/config-registry-api-service/config-registry-api-service.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,0BAA0B,EAC1B,aAAa,EACd,mCAAmC;AACpC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AACrD,OAAO,KAAK,EAAE,WAAW,EAAE,kBAAkB;AAE7C,OAAO,KAAK,EAAE,qCAAqC,EAAE,8DAA6D;AAClH,OAAO,KAAK,EACV,kBAAkB,EAClB,iBAAiB,EAElB,oBAAmB;AAKpB,oBAAY,oBAAoB;IAC9B,GAAG,QAAQ;IACX,GAAG,QAAQ;IACX,GAAG,SAAS;CACb;AAED;;;GAGG;AACH,eAAO,MAAM,WAAW,6BAA6B,CAAC;AAMtD;;GAEG;AACH,MAAM,MAAM,+BAA+B,GACzC,qCAAqC,CAAC;AAExC;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG,KAAK,CAAC;AAEnD;;GAEG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,iCAAiC,GAAG,SAAS,CACvD,OAAO,WAAW,EAClB,+BAA+B,GAAG,cAAc,EAChD,8BAA8B,GAAG,aAAa,CAC/C,CAAC;AAeF,MAAM,MAAM,+BAA+B,GAAG;IAC5C;;;OAGG;IACH,SAAS,EAAE,iCAAiC,CAAC;IAC7C,GAAG,CAAC,EAAE,oBAAoB,CAAC;IAC3B,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;IACrB;;;OAGG;IACH,aAAa,CAAC,EAAE,0BAA0B,CAAC;CAC5C,CAAC;AAEF,qBAAa,wBAAwB;;IACnC,QAAQ,CAAC,IAAI,EAAE,OAAO,WAAW,CAAC;IAalC;;;;;;;;OAQG;gBACS,EACV,SAAS,EACT,GAA8B,EAC9B,KAAK,EAAE,WAA8B,EACrC,aAAkB,GACnB,EAAE,+BAA+B;IAclC;;;;;;;;;OASG;IACH,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW;IAIvE;;;;;;;;;OASG;IACH,OAAO,CACL,GAAG,IAAI,EAAE,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,GAC5C,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IAIvC;;;;;;;;;;;;;;;;;OAiBG;IACH,UAAU,CACR,GAAG,IAAI,EAAE,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,GAC/C,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;IAIpC,WAAW,CACf,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,iBAAiB,CAAC;CAkD9B"}
+{"version":3,"file":"config-registry-api-service.d.cts","sourceRoot":"","sources":["../../src/config-registry-api-service/config-registry-api-service.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,0BAA0B,EAC1B,aAAa,EACd,mCAAmC;AACpC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AACrD,OAAO,EAAE,GAAG,EAAE,0CAA0C;AACxD,OAAO,KAAK,EAAE,WAAW,EAAE,kBAAkB;AAE7C,OAAO,KAAK,EAAE,qCAAqC,EAAE,8DAA6D;AAClH,OAAO,KAAK,EACV,kBAAkB,EAClB,iBAAiB,EAElB,oBAAmB;AAKpB;;;GAGG;AACH,eAAO,MAAM,WAAW,6BAA6B,CAAC;AAMtD;;GAEG;AACH,MAAM,MAAM,+BAA+B,GACzC,qCAAqC,CAAC;AAExC;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG,KAAK,CAAC;AAEnD;;GAEG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,iCAAiC,GAAG,SAAS,CACvD,OAAO,WAAW,EAClB,+BAA+B,GAAG,cAAc,EAChD,8BAA8B,GAAG,aAAa,CAC/C,CAAC;AAeF,MAAM,MAAM,+BAA+B,GAAG;IAC5C;;;OAGG;IACH,SAAS,EAAE,iCAAiC,CAAC;IAC7C,GAAG,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC;IACd,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;IACrB;;;OAGG;IACH,aAAa,CAAC,EAAE,0BAA0B,CAAC;CAC5C,CAAC;AAEF,qBAAa,wBAAwB;;IACnC,QAAQ,CAAC,IAAI,EAAE,OAAO,WAAW,CAAC;IAalC;;;;;;;;OAQG;gBACS,EACV,SAAS,EACT,GAAiB,EACjB,KAAK,EAAE,WAA8B,EACrC,aAAkB,GACnB,EAAE,+BAA+B;IAclC;;;;;;;;;OASG;IACH,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW;IAIvE;;;;;;;;;OASG;IACH,OAAO,CACL,GAAG,IAAI,EAAE,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,GAC5C,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IAIvC;;;;;;;;;;;;;;;;;OAiBG;IACH,UAAU,CACR,GAAG,IAAI,EAAE,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,GAC/C,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;IAIpC,WAAW,CACf,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,iBAAiB,CAAC;CAkD9B"}

package/dist/config-registry-api-service/config-registry-api-service.d.mts

@@ -1,13 +1,9 @@
 import type { CreateServicePolicyOptions, ServicePolicy } from "@metamask/controller-utils";
 import type { Messenger } from "@metamask/messenger";
+import { SDK } from "@metamask/profile-sync-controller";
 import type { IDisposable } from "cockatiel";
 import type { ConfigRegistryApiServiceMethodActions } from "./config-registry-api-service-method-action-types.mjs";
 import type { FetchConfigOptions, FetchConfigResult } from "./types.mjs";
-export declare enum ConfigRegistryApiEnv {
-    DEV = "dev",
-    UAT = "uat",
-    PRD = "prod"
-}
 /**
  * The name of the {@link ConfigRegistryApiService}, used to namespace the
  * service's actions and events.
@@ -40,7 +36,7 @@ export type ConfigRegistryApiServiceOptions = {
      * independently and register its actions.
      */
     messenger: ConfigRegistryApiServiceMessenger;
-    env?: ConfigRegistryApiEnv;
+    env?: SDK.Env;
     fetch?: typeof fetch;
     /**
      * Options to pass to `createServicePolicy`, which wraps each request.

package/dist/config-registry-api-service/config-registry-api-service.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"config-registry-api-service.d.mts","sourceRoot":"","sources":["../../src/config-registry-api-service/config-registry-api-service.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,0BAA0B,EAC1B,aAAa,EACd,mCAAmC;AACpC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AACrD,OAAO,KAAK,EAAE,WAAW,EAAE,kBAAkB;AAE7C,OAAO,KAAK,EAAE,qCAAqC,EAAE,8DAA6D;AAClH,OAAO,KAAK,EACV,kBAAkB,EAClB,iBAAiB,EAElB,oBAAmB;AAKpB,oBAAY,oBAAoB;IAC9B,GAAG,QAAQ;IACX,GAAG,QAAQ;IACX,GAAG,SAAS;CACb;AAED;;;GAGG;AACH,eAAO,MAAM,WAAW,6BAA6B,CAAC;AAMtD;;GAEG;AACH,MAAM,MAAM,+BAA+B,GACzC,qCAAqC,CAAC;AAExC;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG,KAAK,CAAC;AAEnD;;GAEG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,iCAAiC,GAAG,SAAS,CACvD,OAAO,WAAW,EAClB,+BAA+B,GAAG,cAAc,EAChD,8BAA8B,GAAG,aAAa,CAC/C,CAAC;AAeF,MAAM,MAAM,+BAA+B,GAAG;IAC5C;;;OAGG;IACH,SAAS,EAAE,iCAAiC,CAAC;IAC7C,GAAG,CAAC,EAAE,oBAAoB,CAAC;IAC3B,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;IACrB;;;OAGG;IACH,aAAa,CAAC,EAAE,0BAA0B,CAAC;CAC5C,CAAC;AAEF,qBAAa,wBAAwB;;IACnC,QAAQ,CAAC,IAAI,EAAE,OAAO,WAAW,CAAC;IAalC;;;;;;;;OAQG;gBACS,EACV,SAAS,EACT,GAA8B,EAC9B,KAAK,EAAE,WAA8B,EACrC,aAAkB,GACnB,EAAE,+BAA+B;IAclC;;;;;;;;;OASG;IACH,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW;IAIvE;;;;;;;;;OASG;IACH,OAAO,CACL,GAAG,IAAI,EAAE,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,GAC5C,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IAIvC;;;;;;;;;;;;;;;;;OAiBG;IACH,UAAU,CACR,GAAG,IAAI,EAAE,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,GAC/C,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;IAIpC,WAAW,CACf,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,iBAAiB,CAAC;CAkD9B"}
+{"version":3,"file":"config-registry-api-service.d.mts","sourceRoot":"","sources":["../../src/config-registry-api-service/config-registry-api-service.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,0BAA0B,EAC1B,aAAa,EACd,mCAAmC;AACpC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AACrD,OAAO,EAAE,GAAG,EAAE,0CAA0C;AACxD,OAAO,KAAK,EAAE,WAAW,EAAE,kBAAkB;AAE7C,OAAO,KAAK,EAAE,qCAAqC,EAAE,8DAA6D;AAClH,OAAO,KAAK,EACV,kBAAkB,EAClB,iBAAiB,EAElB,oBAAmB;AAKpB;;;GAGG;AACH,eAAO,MAAM,WAAW,6BAA6B,CAAC;AAMtD;;GAEG;AACH,MAAM,MAAM,+BAA+B,GACzC,qCAAqC,CAAC;AAExC;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG,KAAK,CAAC;AAEnD;;GAEG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,iCAAiC,GAAG,SAAS,CACvD,OAAO,WAAW,EAClB,+BAA+B,GAAG,cAAc,EAChD,8BAA8B,GAAG,aAAa,CAC/C,CAAC;AAeF,MAAM,MAAM,+BAA+B,GAAG;IAC5C;;;OAGG;IACH,SAAS,EAAE,iCAAiC,CAAC;IAC7C,GAAG,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC;IACd,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;IACrB;;;OAGG;IACH,aAAa,CAAC,EAAE,0BAA0B,CAAC;CAC5C,CAAC;AAEF,qBAAa,wBAAwB;;IACnC,QAAQ,CAAC,IAAI,EAAE,OAAO,WAAW,CAAC;IAalC;;;;;;;;OAQG;gBACS,EACV,SAAS,EACT,GAAiB,EACjB,KAAK,EAAE,WAA8B,EACrC,aAAkB,GACnB,EAAE,+BAA+B;IAclC;;;;;;;;;OASG;IACH,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW;IAIvE;;;;;;;;;OASG;IACH,OAAO,CACL,GAAG,IAAI,EAAE,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,GAC5C,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IAIvC;;;;;;;;;;;;;;;;;OAiBG;IACH,UAAU,CACR,GAAG,IAAI,EAAE,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,GAC/C,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;IAIpC,WAAW,CACf,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,iBAAiB,CAAC;CAkD9B"}

package/dist/config-registry-api-service/config-registry-api-service.mjs

@@ -11,14 +11,9 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 };
 var _ConfigRegistryApiService_messenger, _ConfigRegistryApiService_policy, _ConfigRegistryApiService_url, _ConfigRegistryApiService_fetch, _ConfigRegistryApiService_cachedResponse;
 import { createServicePolicy, HttpError } from "@metamask/controller-utils";
+import { SDK } from "@metamask/profile-sync-controller";
 import { validateRegistryConfigApiResponse } from "./types.mjs";
 const ENDPOINT_PATH = '/config/networks';
-export var ConfigRegistryApiEnv;
-(function (ConfigRegistryApiEnv) {
-    ConfigRegistryApiEnv["DEV"] = "dev";
-    ConfigRegistryApiEnv["UAT"] = "uat";
-    ConfigRegistryApiEnv["PRD"] = "prod";
-})(ConfigRegistryApiEnv || (ConfigRegistryApiEnv = {}));
 /**
  * The name of the {@link ConfigRegistryApiService}, used to namespace the
  * service's actions and events.
@@ -34,7 +29,7 @@ const MESSENGER_EXPOSED_METHODS = ['fetchConfig'];
  * @returns The base URL for the environment.
  */
 function getConfigRegistryUrl(env) {
-    const envPrefix = env === ConfigRegistryApiEnv.PRD ? '' : `${env}-`;
+    const envPrefix = env === SDK.Env.PRD ? '' : `${env}-`;
     return `https://client-config.${envPrefix}api.cx.metamask.io/v1${ENDPOINT_PATH}`;
 }
 export class ConfigRegistryApiService {
@@ -47,7 +42,7 @@ export class ConfigRegistryApiService {
      * @param options.fetch - Custom fetch function for testing or custom implementations. Defaults to the global fetch.
      * @param options.policyOptions - Options to pass to `createServicePolicy`, which wraps each request. See {@link CreateServicePolicyOptions}.
      */
-    constructor({ messenger, env = ConfigRegistryApiEnv.UAT, fetch: customFetch = globalThis.fetch, policyOptions = {}, }) {
+    constructor({ messenger, env = SDK.Env.UAT, fetch: customFetch = globalThis.fetch, policyOptions = {}, }) {
         _ConfigRegistryApiService_messenger.set(this, void 0);
         _ConfigRegistryApiService_policy.set(this, void 0);
         _ConfigRegistryApiService_url.set(this, void 0);

package/dist/config-registry-api-service/config-registry-api-service.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"config-registry-api-service.mjs","sourceRoot":"","sources":["../../src/config-registry-api-service/config-registry-api-service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAE,mBAAmB,EAAE,SAAS,EAAE,mCAAmC;AAc5E,OAAO,EAAE,iCAAiC,EAAE,oBAAmB;AAE/D,MAAM,aAAa,GAAG,kBAAkB,CAAC;AAEzC,MAAM,CAAN,IAAY,oBAIX;AAJD,WAAY,oBAAoB;IAC9B,mCAAW,CAAA;IACX,mCAAW,CAAA;IACX,oCAAY,CAAA;AACd,CAAC,EAJW,oBAAoB,KAApB,oBAAoB,QAI/B;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,0BAA0B,CAAC;AAEtD,oBAAoB;AAEpB,MAAM,yBAAyB,GAAG,CAAC,aAAa,CAAU,CAAC;AAiC3D,6BAA6B;AAE7B;;;;;GAKG;AACH,SAAS,oBAAoB,CAAC,GAAyB;IACrD,MAAM,SAAS,GAAG,GAAG,KAAK,oBAAoB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,CAAC;IACpE,OAAO,yBAAyB,SAAS,wBAAwB,aAAa,EAAE,CAAC;AACnF,CAAC;AAiBD,MAAM,OAAO,wBAAwB;IAcnC;;;;;;;;OAQG;IACH,YAAY,EACV,SAAS,EACT,GAAG,GAAG,oBAAoB,CAAC,GAAG,EAC9B,KAAK,EAAE,WAAW,GAAG,UAAU,CAAC,KAAK,EACrC,aAAa,GAAG,EAAE,GACc;QAzBzB,sDAA8C;QAE9C,mDAAuB;QAEvB,gDAAa;QAEb,kDAAqB;QAE9B,oFAAoF;QACpF,mDAAoD,IAAI,EAAC;QAiBvD,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;QACxB,uBAAA,IAAI,uCAAc,SAAS,MAAA,CAAC;QAC5B,uBAAA,IAAI,iCAAQ,oBAAoB,CAAC,GAAG,CAAC,MAAA,CAAC;QACtC,uBAAA,IAAI,mCAAU,WAAW,MAAA,CAAC;QAE1B,uBAAA,IAAI,oCAAW,mBAAmB,CAAC,aAAa,CAAC,MAAA,CAAC;QAElD,uBAAA,IAAI,2CAAW,CAAC,4BAA4B,CAC1C,IAAI,EACJ,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,OAAO,CAAC,QAAiD;QACvD,OAAO,uBAAA,IAAI,wCAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;;OASG;IACH,OAAO,CACL,GAAG,IAA0C;QAE7C,OAAO,uBAAA,IAAI,wCAAQ,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;IACvC,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,UAAU,CACR,GAAG,IAA6C;QAEhD,OAAO,uBAAA,IAAI,wCAAQ,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC;IAC1C,CAAC;IAED,KAAK,CAAC,WAAW,CACf,UAA8B,EAAE;QAEhC,MAAM,OAAO,GAAgB;YAC3B,eAAe,EAAE,UAAU;SAC5B,CAAC;QAEF,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;YACjB,OAAO,CAAC,eAAe,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;QAC1C,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,uBAAA,IAAI,wCAAQ,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE;YACrD,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,uCAAO,MAAX,IAAI,EAAQ,uBAAA,IAAI,qCAAK,EAAE;gBACvC,OAAO;aACR,CAAC,CAAC;YAEH,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBACvB,OAAO,GAAG,CAAC;YACb,CAAC;YAED,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;gBACZ,MAAM,IAAI,SAAS,CACjB,GAAG,CAAC,MAAM,EACV,2BAA2B,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,UAAU,EAAE,CAC1D,CAAC;YACJ,CAAC;YAED,OAAO,GAAG,CAAC;QACb,CAAC,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC5B,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,SAAS,CAAC;YACvD,OAAO;gBACL,QAAQ,EAAE,KAAK;gBACf,IAAI;gBACJ,GAAG,CAAC,uBAAA,IAAI,gDAAgB,KAAK,IAAI,IAAI,EAAE,IAAI,EAAE,uBAAA,IAAI,gDAAgB,EAAE,CAAC;aACrE,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,SAAS,CAAC;QACvD,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAEvC,iCAAiC,CAAC,QAAQ,CAAC,CAAC;QAE5C,uBAAA,IAAI,4CAAmB,QAAQ,MAAA,CAAC;QAEhC,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,IAAI;YACJ,QAAQ,EAAE,IAAI;SACf,CAAC;IACJ,CAAC;CACF","sourcesContent":["import { createServicePolicy, HttpError } from '@metamask/controller-utils';\nimport type {\n  CreateServicePolicyOptions,\n  ServicePolicy,\n} from '@metamask/controller-utils';\nimport type { Messenger } from '@metamask/messenger';\nimport type { IDisposable } from 'cockatiel';\n\nimport type { ConfigRegistryApiServiceMethodActions } from './config-registry-api-service-method-action-types.js';\nimport type {\n  FetchConfigOptions,\n  FetchConfigResult,\n  RegistryConfigApiResponse,\n} from './types.js';\nimport { validateRegistryConfigApiResponse } from './types.js';\n\nconst ENDPOINT_PATH = '/config/networks';\n\nexport enum ConfigRegistryApiEnv {\n  DEV = 'dev',\n  UAT = 'uat',\n  PRD = 'prod',\n}\n\n/**\n * The name of the {@link ConfigRegistryApiService}, used to namespace the\n * service's actions and events.\n */\nexport const serviceName = 'ConfigRegistryApiService';\n\n// === MESSENGER ===\n\nconst MESSENGER_EXPOSED_METHODS = ['fetchConfig'] as const;\n\n/**\n * Actions that {@link ConfigRegistryApiService} exposes to other consumers.\n */\nexport type ConfigRegistryApiServiceActions =\n  ConfigRegistryApiServiceMethodActions;\n\n/**\n * Actions from other messengers that {@link ConfigRegistryApiServiceMessenger} calls.\n */\ntype AllowedActions = never;\n\n/**\n * Events that {@link ConfigRegistryApiService} exposes to other consumers.\n */\nexport type ConfigRegistryApiServiceEvents = never;\n\n/**\n * Events from other messengers that {@link ConfigRegistryApiService} subscribes to.\n */\ntype AllowedEvents = never;\n\n/**\n * The messenger which is restricted to actions and events accessed by\n * {@link ConfigRegistryApiService}.\n */\nexport type ConfigRegistryApiServiceMessenger = Messenger<\n  typeof serviceName,\n  ConfigRegistryApiServiceActions | AllowedActions,\n  ConfigRegistryApiServiceEvents | AllowedEvents\n>;\n\n// === SERVICE DEFINITION ===\n\n/**\n * Returns the base URL for the config registry API for the given environment.\n *\n * @param env - The environment to get the URL for.\n * @returns The base URL for the environment.\n */\nfunction getConfigRegistryUrl(env: ConfigRegistryApiEnv): string {\n  const envPrefix = env === ConfigRegistryApiEnv.PRD ? '' : `${env}-`;\n  return `https://client-config.${envPrefix}api.cx.metamask.io/v1${ENDPOINT_PATH}`;\n}\n\nexport type ConfigRegistryApiServiceOptions = {\n  /**\n   * The messenger suited for this service. Required so the service can be used\n   * independently and register its actions.\n   */\n  messenger: ConfigRegistryApiServiceMessenger;\n  env?: ConfigRegistryApiEnv;\n  fetch?: typeof fetch;\n  /**\n   * Options to pass to `createServicePolicy`, which wraps each request.\n   * See {@link CreateServicePolicyOptions}.\n   */\n  policyOptions?: CreateServicePolicyOptions;\n};\n\nexport class ConfigRegistryApiService {\n  readonly name: typeof serviceName;\n\n  readonly #messenger: ConfigRegistryApiServiceMessenger;\n\n  readonly #policy: ServicePolicy;\n\n  readonly #url: string;\n\n  readonly #fetch: typeof fetch;\n\n  /** Cached response from the last successful fetch. Used when server returns 304. */\n  #cachedResponse: RegistryConfigApiResponse | null = null;\n\n  /**\n   * Construct a Config Registry API Service.\n   *\n   * @param options - The options for constructing the service.\n   * @param options.messenger - The messenger suited for this service.\n   * @param options.env - The environment to determine the correct API endpoints. Defaults to UAT.\n   * @param options.fetch - Custom fetch function for testing or custom implementations. Defaults to the global fetch.\n   * @param options.policyOptions - Options to pass to `createServicePolicy`, which wraps each request. See {@link CreateServicePolicyOptions}.\n   */\n  constructor({\n    messenger,\n    env = ConfigRegistryApiEnv.UAT,\n    fetch: customFetch = globalThis.fetch,\n    policyOptions = {},\n  }: ConfigRegistryApiServiceOptions) {\n    this.name = serviceName;\n    this.#messenger = messenger;\n    this.#url = getConfigRegistryUrl(env);\n    this.#fetch = customFetch;\n\n    this.#policy = createServicePolicy(policyOptions);\n\n    this.#messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n  }\n\n  /**\n   * Registers a handler that will be called after a request returns a non-500\n   * response, causing a retry. Primarily useful in tests where timers are being\n   * mocked.\n   *\n   * @param listener - The handler to be called.\n   * @returns An object that can be used to unregister the handler. See\n   * {@link CockatielEvent}.\n   * @see {@link createServicePolicy}\n   */\n  onRetry(listener: Parameters<ServicePolicy['onRetry']>[0]): IDisposable {\n    return this.#policy.onRetry(listener);\n  }\n\n  /**\n   * Registers a handler that will be called after a set number of retry rounds\n   * prove that requests to the API endpoint consistently return a 5xx response.\n   *\n   * @param args - The arguments passed to the underlying policy's onBreak method\n   * (e.g. the listener to be called).\n   * @returns An object that can be used to unregister the handler. See\n   * {@link CockatielEvent}.\n   * @see {@link createServicePolicy}\n   */\n  onBreak(\n    ...args: Parameters<ServicePolicy['onBreak']>\n  ): ReturnType<ServicePolicy['onBreak']> {\n    return this.#policy.onBreak(...args);\n  }\n\n  /**\n   * Registers a handler that will be called under one of two circumstances:\n   *\n   * 1. After a set number of retries prove that requests to the API\n   * consistently result in one of the following failures:\n   *    1. A connection initiation error\n   *    2. A connection reset error\n   *    3. A timeout error\n   *    4. A non-JSON response\n   *    5. A 502, 503, or 504 response\n   * 2. After a successful request is made to the API, but the response takes\n   * longer than a set duration to return.\n   *\n   * @param args - The arguments passed to the underlying policy's onDegraded\n   * method (e.g. the listener to be called).\n   * @returns An object that can be used to unregister the handler. See\n   * {@link CockatielEvent}.\n   */\n  onDegraded(\n    ...args: Parameters<ServicePolicy['onDegraded']>\n  ): ReturnType<ServicePolicy['onDegraded']> {\n    return this.#policy.onDegraded(...args);\n  }\n\n  async fetchConfig(\n    options: FetchConfigOptions = {},\n  ): Promise<FetchConfigResult> {\n    const headers: HeadersInit = {\n      'Cache-Control': 'no-cache',\n    };\n\n    if (options.etag) {\n      headers['If-None-Match'] = options.etag;\n    }\n\n    const response = await this.#policy.execute(async () => {\n      const res = await this.#fetch(this.#url, {\n        headers,\n      });\n\n      if (res.status === 304) {\n        return res;\n      }\n\n      if (!res.ok) {\n        throw new HttpError(\n          res.status,\n          `Failed to fetch config: ${res.status} ${res.statusText}`,\n        );\n      }\n\n      return res;\n    });\n\n    if (response.status === 304) {\n      const etag = response.headers.get('ETag') ?? undefined;\n      return {\n        modified: false,\n        etag,\n        ...(this.#cachedResponse !== null && { data: this.#cachedResponse }),\n      };\n    }\n\n    const etag = response.headers.get('ETag') ?? undefined;\n    const jsonData = await response.json();\n\n    validateRegistryConfigApiResponse(jsonData);\n\n    this.#cachedResponse = jsonData;\n\n    return {\n      data: jsonData,\n      etag,\n      modified: true,\n    };\n  }\n}\n"]}
+{"version":3,"file":"config-registry-api-service.mjs","sourceRoot":"","sources":["../../src/config-registry-api-service/config-registry-api-service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAE,mBAAmB,EAAE,SAAS,EAAE,mCAAmC;AAM5E,OAAO,EAAE,GAAG,EAAE,0CAA0C;AASxD,OAAO,EAAE,iCAAiC,EAAE,oBAAmB;AAE/D,MAAM,aAAa,GAAG,kBAAkB,CAAC;AAEzC;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,0BAA0B,CAAC;AAEtD,oBAAoB;AAEpB,MAAM,yBAAyB,GAAG,CAAC,aAAa,CAAU,CAAC;AAiC3D,6BAA6B;AAE7B;;;;;GAKG;AACH,SAAS,oBAAoB,CAAC,GAAY;IACxC,MAAM,SAAS,GAAG,GAAG,KAAK,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,CAAC;IACvD,OAAO,yBAAyB,SAAS,wBAAwB,aAAa,EAAE,CAAC;AACnF,CAAC;AAiBD,MAAM,OAAO,wBAAwB;IAcnC;;;;;;;;OAQG;IACH,YAAY,EACV,SAAS,EACT,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,EACjB,KAAK,EAAE,WAAW,GAAG,UAAU,CAAC,KAAK,EACrC,aAAa,GAAG,EAAE,GACc;QAzBzB,sDAA8C;QAE9C,mDAAuB;QAEvB,gDAAa;QAEb,kDAAqB;QAE9B,oFAAoF;QACpF,mDAAoD,IAAI,EAAC;QAiBvD,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;QACxB,uBAAA,IAAI,uCAAc,SAAS,MAAA,CAAC;QAC5B,uBAAA,IAAI,iCAAQ,oBAAoB,CAAC,GAAG,CAAC,MAAA,CAAC;QACtC,uBAAA,IAAI,mCAAU,WAAW,MAAA,CAAC;QAE1B,uBAAA,IAAI,oCAAW,mBAAmB,CAAC,aAAa,CAAC,MAAA,CAAC;QAElD,uBAAA,IAAI,2CAAW,CAAC,4BAA4B,CAC1C,IAAI,EACJ,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,OAAO,CAAC,QAAiD;QACvD,OAAO,uBAAA,IAAI,wCAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;;OASG;IACH,OAAO,CACL,GAAG,IAA0C;QAE7C,OAAO,uBAAA,IAAI,wCAAQ,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;IACvC,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,UAAU,CACR,GAAG,IAA6C;QAEhD,OAAO,uBAAA,IAAI,wCAAQ,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC;IAC1C,CAAC;IAED,KAAK,CAAC,WAAW,CACf,UAA8B,EAAE;QAEhC,MAAM,OAAO,GAAgB;YAC3B,eAAe,EAAE,UAAU;SAC5B,CAAC;QAEF,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;YACjB,OAAO,CAAC,eAAe,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;QAC1C,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,uBAAA,IAAI,wCAAQ,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE;YACrD,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,uCAAO,MAAX,IAAI,EAAQ,uBAAA,IAAI,qCAAK,EAAE;gBACvC,OAAO;aACR,CAAC,CAAC;YAEH,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBACvB,OAAO,GAAG,CAAC;YACb,CAAC;YAED,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;gBACZ,MAAM,IAAI,SAAS,CACjB,GAAG,CAAC,MAAM,EACV,2BAA2B,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,UAAU,EAAE,CAC1D,CAAC;YACJ,CAAC;YAED,OAAO,GAAG,CAAC;QACb,CAAC,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC5B,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,SAAS,CAAC;YACvD,OAAO;gBACL,QAAQ,EAAE,KAAK;gBACf,IAAI;gBACJ,GAAG,CAAC,uBAAA,IAAI,gDAAgB,KAAK,IAAI,IAAI,EAAE,IAAI,EAAE,uBAAA,IAAI,gDAAgB,EAAE,CAAC;aACrE,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,SAAS,CAAC;QACvD,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAEvC,iCAAiC,CAAC,QAAQ,CAAC,CAAC;QAE5C,uBAAA,IAAI,4CAAmB,QAAQ,MAAA,CAAC;QAEhC,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,IAAI;YACJ,QAAQ,EAAE,IAAI;SACf,CAAC;IACJ,CAAC;CACF","sourcesContent":["import { createServicePolicy, HttpError } from '@metamask/controller-utils';\nimport type {\n  CreateServicePolicyOptions,\n  ServicePolicy,\n} from '@metamask/controller-utils';\nimport type { Messenger } from '@metamask/messenger';\nimport { SDK } from '@metamask/profile-sync-controller';\nimport type { IDisposable } from 'cockatiel';\n\nimport type { ConfigRegistryApiServiceMethodActions } from './config-registry-api-service-method-action-types.js';\nimport type {\n  FetchConfigOptions,\n  FetchConfigResult,\n  RegistryConfigApiResponse,\n} from './types.js';\nimport { validateRegistryConfigApiResponse } from './types.js';\n\nconst ENDPOINT_PATH = '/config/networks';\n\n/**\n * The name of the {@link ConfigRegistryApiService}, used to namespace the\n * service's actions and events.\n */\nexport const serviceName = 'ConfigRegistryApiService';\n\n// === MESSENGER ===\n\nconst MESSENGER_EXPOSED_METHODS = ['fetchConfig'] as const;\n\n/**\n * Actions that {@link ConfigRegistryApiService} exposes to other consumers.\n */\nexport type ConfigRegistryApiServiceActions =\n  ConfigRegistryApiServiceMethodActions;\n\n/**\n * Actions from other messengers that {@link ConfigRegistryApiServiceMessenger} calls.\n */\ntype AllowedActions = never;\n\n/**\n * Events that {@link ConfigRegistryApiService} exposes to other consumers.\n */\nexport type ConfigRegistryApiServiceEvents = never;\n\n/**\n * Events from other messengers that {@link ConfigRegistryApiService} subscribes to.\n */\ntype AllowedEvents = never;\n\n/**\n * The messenger which is restricted to actions and events accessed by\n * {@link ConfigRegistryApiService}.\n */\nexport type ConfigRegistryApiServiceMessenger = Messenger<\n  typeof serviceName,\n  ConfigRegistryApiServiceActions | AllowedActions,\n  ConfigRegistryApiServiceEvents | AllowedEvents\n>;\n\n// === SERVICE DEFINITION ===\n\n/**\n * Returns the base URL for the config registry API for the given environment.\n *\n * @param env - The environment to get the URL for.\n * @returns The base URL for the environment.\n */\nfunction getConfigRegistryUrl(env: SDK.Env): string {\n  const envPrefix = env === SDK.Env.PRD ? '' : `${env}-`;\n  return `https://client-config.${envPrefix}api.cx.metamask.io/v1${ENDPOINT_PATH}`;\n}\n\nexport type ConfigRegistryApiServiceOptions = {\n  /**\n   * The messenger suited for this service. Required so the service can be used\n   * independently and register its actions.\n   */\n  messenger: ConfigRegistryApiServiceMessenger;\n  env?: SDK.Env;\n  fetch?: typeof fetch;\n  /**\n   * Options to pass to `createServicePolicy`, which wraps each request.\n   * See {@link CreateServicePolicyOptions}.\n   */\n  policyOptions?: CreateServicePolicyOptions;\n};\n\nexport class ConfigRegistryApiService {\n  readonly name: typeof serviceName;\n\n  readonly #messenger: ConfigRegistryApiServiceMessenger;\n\n  readonly #policy: ServicePolicy;\n\n  readonly #url: string;\n\n  readonly #fetch: typeof fetch;\n\n  /** Cached response from the last successful fetch. Used when server returns 304. */\n  #cachedResponse: RegistryConfigApiResponse | null = null;\n\n  /**\n   * Construct a Config Registry API Service.\n   *\n   * @param options - The options for constructing the service.\n   * @param options.messenger - The messenger suited for this service.\n   * @param options.env - The environment to determine the correct API endpoints. Defaults to UAT.\n   * @param options.fetch - Custom fetch function for testing or custom implementations. Defaults to the global fetch.\n   * @param options.policyOptions - Options to pass to `createServicePolicy`, which wraps each request. See {@link CreateServicePolicyOptions}.\n   */\n  constructor({\n    messenger,\n    env = SDK.Env.UAT,\n    fetch: customFetch = globalThis.fetch,\n    policyOptions = {},\n  }: ConfigRegistryApiServiceOptions) {\n    this.name = serviceName;\n    this.#messenger = messenger;\n    this.#url = getConfigRegistryUrl(env);\n    this.#fetch = customFetch;\n\n    this.#policy = createServicePolicy(policyOptions);\n\n    this.#messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n  }\n\n  /**\n   * Registers a handler that will be called after a request returns a non-500\n   * response, causing a retry. Primarily useful in tests where timers are being\n   * mocked.\n   *\n   * @param listener - The handler to be called.\n   * @returns An object that can be used to unregister the handler. See\n   * {@link CockatielEvent}.\n   * @see {@link createServicePolicy}\n   */\n  onRetry(listener: Parameters<ServicePolicy['onRetry']>[0]): IDisposable {\n    return this.#policy.onRetry(listener);\n  }\n\n  /**\n   * Registers a handler that will be called after a set number of retry rounds\n   * prove that requests to the API endpoint consistently return a 5xx response.\n   *\n   * @param args - The arguments passed to the underlying policy's onBreak method\n   * (e.g. the listener to be called).\n   * @returns An object that can be used to unregister the handler. See\n   * {@link CockatielEvent}.\n   * @see {@link createServicePolicy}\n   */\n  onBreak(\n    ...args: Parameters<ServicePolicy['onBreak']>\n  ): ReturnType<ServicePolicy['onBreak']> {\n    return this.#policy.onBreak(...args);\n  }\n\n  /**\n   * Registers a handler that will be called under one of two circumstances:\n   *\n   * 1. After a set number of retries prove that requests to the API\n   * consistently result in one of the following failures:\n   *    1. A connection initiation error\n   *    2. A connection reset error\n   *    3. A timeout error\n   *    4. A non-JSON response\n   *    5. A 502, 503, or 504 response\n   * 2. After a successful request is made to the API, but the response takes\n   * longer than a set duration to return.\n   *\n   * @param args - The arguments passed to the underlying policy's onDegraded\n   * method (e.g. the listener to be called).\n   * @returns An object that can be used to unregister the handler. See\n   * {@link CockatielEvent}.\n   */\n  onDegraded(\n    ...args: Parameters<ServicePolicy['onDegraded']>\n  ): ReturnType<ServicePolicy['onDegraded']> {\n    return this.#policy.onDegraded(...args);\n  }\n\n  async fetchConfig(\n    options: FetchConfigOptions = {},\n  ): Promise<FetchConfigResult> {\n    const headers: HeadersInit = {\n      'Cache-Control': 'no-cache',\n    };\n\n    if (options.etag) {\n      headers['If-None-Match'] = options.etag;\n    }\n\n    const response = await this.#policy.execute(async () => {\n      const res = await this.#fetch(this.#url, {\n        headers,\n      });\n\n      if (res.status === 304) {\n        return res;\n      }\n\n      if (!res.ok) {\n        throw new HttpError(\n          res.status,\n          `Failed to fetch config: ${res.status} ${res.statusText}`,\n        );\n      }\n\n      return res;\n    });\n\n    if (response.status === 304) {\n      const etag = response.headers.get('ETag') ?? undefined;\n      return {\n        modified: false,\n        etag,\n        ...(this.#cachedResponse !== null && { data: this.#cachedResponse }),\n      };\n    }\n\n    const etag = response.headers.get('ETag') ?? undefined;\n    const jsonData = await response.json();\n\n    validateRegistryConfigApiResponse(jsonData);\n\n    this.#cachedResponse = jsonData;\n\n    return {\n      data: jsonData,\n      etag,\n      modified: true,\n    };\n  }\n}\n"]}

package/dist/config-registry-api-service/types.d.cts

@@ -4,33 +4,33 @@ import type { Infer } from "@metamask/superstruct";
  * chainId is in CAIP-2 format (e.g. "eip155:1", "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp").
  */
 export declare const RegistryNetworkConfigSchema: import("@metamask/superstruct").Struct<{
-    imageUrl: string;
     name: string;
+    imageUrl: string;
     chainId: `${string}:${string}`;
     coingeckoPlatformId: string;
     assets: {
         native: {
             symbol: string;
+            name: string;
             assetId: string;
             imageUrl: string;
-            name: string;
             decimals: number;
             coingeckoCoinId?: string | undefined;
         };
         listUrl?: string | undefined;
         governance?: {
             symbol: string;
+            name: string;
             assetId: string;
             imageUrl: string;
-            name: string;
             decimals: number;
             coingeckoCoinId?: string | undefined;
         } | undefined;
     };
     rpcProviders: {
         default: {
-            url: string;
             type: string;
+            url: string;
             networkClientId: string;
         };
         fallbacks: string[];
@@ -61,18 +61,18 @@ export declare const RegistryNetworkConfigSchema: import("@metamask/superstruct"
     assets: import("@metamask/superstruct").Struct<{
         native: {
             symbol: string;
+            name: string;
             assetId: string;
             imageUrl: string;
-            name: string;
             decimals: number;
             coingeckoCoinId?: string | undefined;
         };
         listUrl?: string | undefined;
         governance?: {
             symbol: string;
+            name: string;
             assetId: string;
             imageUrl: string;
-            name: string;
             decimals: number;
             coingeckoCoinId?: string | undefined;
         } | undefined;
@@ -80,9 +80,9 @@ export declare const RegistryNetworkConfigSchema: import("@metamask/superstruct"
         listUrl: import("@metamask/superstruct").Struct<string | undefined, null>;
         native: import("@metamask/superstruct").Struct<{
             symbol: string;
+            name: string;
             assetId: string;
             imageUrl: string;
-            name: string;
             decimals: number;
             coingeckoCoinId?: string | undefined;
         }, {
@@ -95,9 +95,9 @@ export declare const RegistryNetworkConfigSchema: import("@metamask/superstruct"
         }>;
         governance: import("@metamask/superstruct").Struct<{
             symbol: string;
+            name: string;
             assetId: string;
             imageUrl: string;
-            name: string;
             decimals: number;
             coingeckoCoinId?: string | undefined;
         } | undefined, {
@@ -111,15 +111,15 @@ export declare const RegistryNetworkConfigSchema: import("@metamask/superstruct"
     }>;
     rpcProviders: import("@metamask/superstruct").Struct<{
         default: {
-            url: string;
             type: string;
+            url: string;
             networkClientId: string;
         };
         fallbacks: string[];
     }, {
         default: import("@metamask/superstruct").Struct<{
-            url: string;
             type: string;
+            url: string;
             networkClientId: string;
         }, {
             url: import("@metamask/superstruct").Struct<string, null>;
@@ -166,33 +166,33 @@ export declare const RegistryConfigApiResponseSchema: import("@metamask/superstr
         version: string;
         timestamp: number;
         chains: {
-            imageUrl: string;
             name: string;
+            imageUrl: string;
             chainId: `${string}:${string}`;
             coingeckoPlatformId: string;
             assets: {
                 native: {
                     symbol: string;
+                    name: string;
                     assetId: string;
                     imageUrl: string;
-                    name: string;
                     decimals: number;
                     coingeckoCoinId?: string | undefined;
                 };
                 listUrl?: string | undefined;
                 governance?: {
                     symbol: string;
+                    name: string;
                     assetId: string;
                     imageUrl: string;
-                    name: string;
                     decimals: number;
                     coingeckoCoinId?: string | undefined;
                 } | undefined;
             };
             rpcProviders: {
                 default: {
-                    url: string;
                     type: string;
+                    url: string;
                     networkClientId: string;
                 };
                 fallbacks: string[];
@@ -221,33 +221,33 @@ export declare const RegistryConfigApiResponseSchema: import("@metamask/superstr
         version: string;
         timestamp: number;
         chains: {
-            imageUrl: string;
             name: string;
+            imageUrl: string;
             chainId: `${string}:${string}`;
             coingeckoPlatformId: string;
             assets: {
                 native: {
                     symbol: string;
+                    name: string;
                     assetId: string;
                     imageUrl: string;
-                    name: string;
                     decimals: number;
                     coingeckoCoinId?: string | undefined;
                 };
                 listUrl?: string | undefined;
                 governance?: {
                     symbol: string;
+                    name: string;
                     assetId: string;
                     imageUrl: string;
-                    name: string;
                     decimals: number;
                     coingeckoCoinId?: string | undefined;
                 } | undefined;
             };
             rpcProviders: {
                 default: {
-                    url: string;
                     type: string;
+                    url: string;
                     networkClientId: string;
                 };
                 fallbacks: string[];
@@ -274,33 +274,33 @@ export declare const RegistryConfigApiResponseSchema: import("@metamask/superstr
         version: import("@metamask/superstruct").Struct<string, null>;
         timestamp: import("@metamask/superstruct").Struct<number, null>;
         chains: import("@metamask/superstruct").Struct<{
-            imageUrl: string;
             name: string;
+            imageUrl: string;
             chainId: `${string}:${string}`;
             coingeckoPlatformId: string;
             assets: {
                 native: {
                     symbol: string;
+                    name: string;
                     assetId: string;
                     imageUrl: string;
-                    name: string;
                     decimals: number;
                     coingeckoCoinId?: string | undefined;
                 };
                 listUrl?: string | undefined;
                 governance?: {
                     symbol: string;
+                    name: string;
                     assetId: string;
                     imageUrl: string;
-                    name: string;
                     decimals: number;
                     coingeckoCoinId?: string | undefined;
                 } | undefined;
             };
             rpcProviders: {
                 default: {
-                    url: string;
                     type: string;
+                    url: string;
                     networkClientId: string;
                 };
                 fallbacks: string[];
@@ -323,33 +323,33 @@ export declare const RegistryConfigApiResponseSchema: import("@metamask/superstr
                 multicall3?: `0x${string}` | undefined;
             } | undefined;
         }[], import("@metamask/superstruct").Struct<{
-            imageUrl: string;
             name: string;
+            imageUrl: string;
             chainId: `${string}:${string}`;
             coingeckoPlatformId: string;
             assets: {
                 native: {
                     symbol: string;
+                    name: string;
                     assetId: string;
                     imageUrl: string;
-                    name: string;
                     decimals: number;
                     coingeckoCoinId?: string | undefined;
                 };
                 listUrl?: string | undefined;
                 governance?: {
                     symbol: string;
+                    name: string;
                     assetId: string;
                     imageUrl: string;
-                    name: string;
                     decimals: number;
                     coingeckoCoinId?: string | undefined;
                 } | undefined;
             };
             rpcProviders: {
                 default: {
-                    url: string;
                     type: string;
+                    url: string;
                     networkClientId: string;
                 };
                 fallbacks: string[];
@@ -380,18 +380,18 @@ export declare const RegistryConfigApiResponseSchema: import("@metamask/superstr
             assets: import("@metamask/superstruct").Struct<{
                 native: {
                     symbol: string;
+                    name: string;
                     assetId: string;
                     imageUrl: string;
-                    name: string;
                     decimals: number;
                     coingeckoCoinId?: string | undefined;
                 };
                 listUrl?: string | undefined;
                 governance?: {
                     symbol: string;
+                    name: string;
                     assetId: string;
                     imageUrl: string;
-                    name: string;
                     decimals: number;
                     coingeckoCoinId?: string | undefined;
                 } | undefined;
@@ -399,9 +399,9 @@ export declare const RegistryConfigApiResponseSchema: import("@metamask/superstr
                 listUrl: import("@metamask/superstruct").Struct<string | undefined, null>;
                 native: import("@metamask/superstruct").Struct<{
                     symbol: string;
+                    name: string;
                     assetId: string;
                     imageUrl: string;
-                    name: string;
                     decimals: number;
                     coingeckoCoinId?: string | undefined;
                 }, {
@@ -414,9 +414,9 @@ export declare const RegistryConfigApiResponseSchema: import("@metamask/superstr
                 }>;
                 governance: import("@metamask/superstruct").Struct<{
                     symbol: string;
+                    name: string;
                     assetId: string;
                     imageUrl: string;
-                    name: string;
                     decimals: number;
                     coingeckoCoinId?: string | undefined;
                 } | undefined, {
@@ -430,15 +430,15 @@ export declare const RegistryConfigApiResponseSchema: import("@metamask/superstr
             }>;
             rpcProviders: import("@metamask/superstruct").Struct<{
                 default: {
-                    url: string;
                     type: string;
+                    url: string;
                     networkClientId: string;
                 };
                 fallbacks: string[];
             }, {
                 default: import("@metamask/superstruct").Struct<{
-                    url: string;
                     type: string;
+                    url: string;
                     networkClientId: string;
                 }, {
                     url: import("@metamask/superstruct").Struct<string, null>;