@metamask-previews/remote-feature-flag-controller 3.0.0-preview-d2037635 → 3.0.0-preview-a4b203f

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

@@ -10,7 +10,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     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 _ClientConfigApiService_fetch, _ClientConfigApiService_policy, _ClientConfigApiService_client, _ClientConfigApiService_distribution, _ClientConfigApiService_environment;
+var _ClientConfigApiService_instances, _ClientConfigApiService_fetch, _ClientConfigApiService_policy, _ClientConfigApiService_client, _ClientConfigApiService_distribution, _ClientConfigApiService_environment, _ClientConfigApiService_flattenFeatureFlags;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ClientConfigApiService = void 0;
 const controller_utils_1 = require("@metamask/controller-utils");
@@ -20,6 +20,7 @@ const constants_1 = require("../constants.cjs");
  */
 class ClientConfigApiService {
     constructor({ fetch: fetchFunction, retries = controller_utils_1.DEFAULT_MAX_RETRIES, maximumConsecutiveFailures = controller_utils_1.DEFAULT_MAX_CONSECUTIVE_FAILURES, circuitBreakDuration = controller_utils_1.DEFAULT_CIRCUIT_BREAK_DURATION, onBreak, onDegraded, config, }) {
+        _ClientConfigApiService_instances.add(this);
         _ClientConfigApiService_fetch.set(this, void 0);
         _ClientConfigApiService_policy.set(this, void 0);
         _ClientConfigApiService_client.set(this, void 0);
@@ -77,27 +78,17 @@ class ClientConfigApiService {
         if (!Array.isArray(data)) {
             throw new Error('Feature flags api did not return an array');
         }
-        const remoteFeatureFlags = this.flattenFeatureFlags(data);
+        const remoteFeatureFlags = __classPrivateFieldGet(this, _ClientConfigApiService_instances, "m", _ClientConfigApiService_flattenFeatureFlags).call(this, data);
         return {
             remoteFeatureFlags,
             cacheTimestamp: Date.now(),
         };
     }
-    /**
-     * Flattens an array of feature flag objects into a single feature flags object.
-     *
-     * @param responseData - Array of objects containing feature flag key-value pairs
-     * @returns A single object containing all feature flags merged together
-     * @example
-     * // Input: [{ flag1: true }, { flag2: [] }]
-     * // Output: { flag1: true, flag2: [] }
-     */
-    flattenFeatureFlags(responseData) {
-        return responseData.reduce((acc, curr) => {
-            return { ...acc, ...curr };
-        }, {});
-    }
 }
 exports.ClientConfigApiService = ClientConfigApiService;
-_ClientConfigApiService_fetch = new WeakMap(), _ClientConfigApiService_policy = new WeakMap(), _ClientConfigApiService_client = new WeakMap(), _ClientConfigApiService_distribution = new WeakMap(), _ClientConfigApiService_environment = new WeakMap();
+_ClientConfigApiService_fetch = new WeakMap(), _ClientConfigApiService_policy = new WeakMap(), _ClientConfigApiService_client = new WeakMap(), _ClientConfigApiService_distribution = new WeakMap(), _ClientConfigApiService_environment = new WeakMap(), _ClientConfigApiService_instances = new WeakSet(), _ClientConfigApiService_flattenFeatureFlags = function _ClientConfigApiService_flattenFeatureFlags(responseData) {
+    return responseData.reduce((acc, curr) => {
+        return { ...acc, ...curr };
+    }, {});
+};
 //# sourceMappingURL=client-config-api-service.cjs.map

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

@@ -1 +1 @@
-{"version":3,"file":"client-config-api-service.cjs","sourceRoot":"","sources":["../../src/client-config-api-service/client-config-api-service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,iEAKoC;AAIpC,gDAAwC;AAUxC;;GAEG;AACH,MAAa,sBAAsB;IAwFjC,YAAY,EACV,KAAK,EAAE,aAAa,EACpB,OAAO,GAAG,sCAAmB,EAC7B,0BAA0B,GAAG,mDAAgC,EAC7D,oBAAoB,GAAG,iDAA8B,EACrD,OAAO,EACP,UAAU,EACV,MAAM,GAaP;QA3GQ,gDAAqB;QAErB,iDAAuB;QAEvB,iDAAoB;QAEpB,uDAAgC;QAEhC,sDAA8B;QAoGrC,uBAAA,IAAI,iCAAU,aAAa,MAAA,CAAC;QAC5B,uBAAA,IAAI,kCAAW,MAAM,CAAC,MAAM,MAAA,CAAC;QAC7B,uBAAA,IAAI,wCAAiB,MAAM,CAAC,YAAY,MAAA,CAAC;QACzC,uBAAA,IAAI,uCAAgB,MAAM,CAAC,WAAW,MAAA,CAAC;QAEvC,uBAAA,IAAI,kCAAW,IAAA,sCAAmB,EAAC;YACjC,UAAU,EAAE,OAAO;YACnB,sBAAsB,EAAE,0BAA0B;YAClD,oBAAoB;SACrB,CAAC,MAAA,CAAC;QACH,IAAI,OAAO,EAAE,CAAC;YACZ,uBAAA,IAAI,sCAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAChC,CAAC;QACD,IAAI,UAAU,EAAE,CAAC;YACf,uBAAA,IAAI,sCAAQ,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QACtC,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,OAAO,CAAC,GAAG,IAA0C;QACnD,OAAO,uBAAA,IAAI,sCAAQ,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;IACvC,CAAC;IAED;;;;;;OAMG;IACH,UAAU,CAAC,GAAG,IAA6C;QACzD,OAAO,uBAAA,IAAI,sCAAQ,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,uBAAuB;QAClC,MAAM,GAAG,GAAG,GAAG,oBAAQ,iBAAiB,uBAAA,IAAI,sCAAQ,iBAClD,uBAAA,IAAI,4CACN,gBAAgB,uBAAA,IAAI,2CAAa,EAAE,CAAC;QAEpC,MAAM,QAAQ,GAAG,MAAM,uBAAA,IAAI,sCAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,CAC/C,uBAAA,IAAI,qCAAO,MAAX,IAAI,EAAQ,GAAG,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,CACxC,CAAC;QAEF,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC1D,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAEnC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;QAC/D,CAAC;QAED,MAAM,kBAAkB,GAAG,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;QAE1D,OAAO;YACL,kBAAkB;YAClB,cAAc,EAAE,IAAI,CAAC,GAAG,EAAE;SAC3B,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACK,mBAAmB,CAAC,YAA6B;QACvD,OAAO,YAAY,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;YACvC,OAAO,EAAE,GAAG,GAAG,EAAE,GAAG,IAAI,EAAE,CAAC;QAC7B,CAAC,EAAE,EAAE,CAAC,CAAC;IACT,CAAC;CACF;AApMD,wDAoMC","sourcesContent":["import {\n  createServicePolicy,\n  DEFAULT_CIRCUIT_BREAK_DURATION,\n  DEFAULT_MAX_CONSECUTIVE_FAILURES,\n  DEFAULT_MAX_RETRIES,\n} from '@metamask/controller-utils';\nimport type { ServicePolicy } from '@metamask/controller-utils';\n\nimport type { AbstractClientConfigApiService } from './abstract-client-config-api-service';\nimport { BASE_URL } from '../constants';\nimport type {\n  FeatureFlags,\n  ClientType,\n  DistributionType,\n  EnvironmentType,\n  ServiceResponse,\n  ApiDataResponse,\n} from '../remote-feature-flag-controller-types';\n\n/**\n * This service is responsible for fetching feature flags from the ClientConfig API.\n */\nexport class ClientConfigApiService implements AbstractClientConfigApiService {\n  readonly #fetch: typeof fetch;\n\n  readonly #policy: ServicePolicy;\n\n  readonly #client: ClientType;\n\n  readonly #distribution: DistributionType;\n\n  readonly #environment: EnvironmentType;\n\n  /**\n   * Constructs a new ClientConfigApiService object.\n   *\n   * @param args - The arguments.\n   * @param args.fetch - A function that can be used to make an HTTP request.\n   * If your JavaScript environment supports `fetch` natively, you'll probably\n   * want to pass that; otherwise you can pass an equivalent (such as `fetch`\n   * via `node-fetch`).\n   * @param args.retries - Number of retry attempts for each fetch request.\n   * @param args.maximumConsecutiveFailures - The maximum number of consecutive\n   * failures allowed before breaking the circuit and pausing further fetch\n   * attempts.\n   * @param args.circuitBreakDuration - The amount of time to wait when the\n   * circuit breaks from too many consecutive failures.\n   * @param args.config - The configuration object, includes client,\n   * distribution, and environment.\n   * @param args.config.client - The client type (e.g., 'extension', 'mobile').\n   * @param args.config.distribution - The distribution type (e.g., 'main',\n   * 'flask').\n   * @param args.config.environment - The environment type (e.g., 'prod', 'rc',\n   * 'dev').\n   */\n  constructor(args: {\n    fetch: typeof fetch;\n    retries?: number;\n    maximumConsecutiveFailures?: number;\n    circuitBreakDuration?: number;\n    config: {\n      client: ClientType;\n      distribution: DistributionType;\n      environment: EnvironmentType;\n    };\n  });\n\n  /**\n   * Constructs a new ClientConfigApiService object.\n   *\n   * @deprecated This signature is deprecated; please use the `onBreak` and\n   * `onDegraded` methods instead.\n   * @param args - The arguments.\n   * @param args.fetch - A function that can be used to make an HTTP request.\n   * If your JavaScript environment supports `fetch` natively, you'll probably\n   * want to pass that; otherwise you can pass an equivalent (such as `fetch`\n   * via `node-fetch`).\n   * @param args.retries - Number of retry attempts for each fetch request.\n   * @param args.maximumConsecutiveFailures - The maximum number of consecutive\n   * failures allowed before breaking the circuit and pausing further fetch\n   * attempts.\n   * @param args.circuitBreakDuration - The amount of time to wait when the\n   * circuit breaks from too many consecutive failures.\n   * @param args.onBreak - Callback for when the circuit breaks, useful\n   * for capturing metrics about network failures.\n   * @param args.onDegraded - Callback for when the API responds successfully\n   * but takes too long to respond (5 seconds or more).\n   * @param args.config - The configuration object, includes client,\n   * distribution, and environment.\n   * @param args.config.client - The client type (e.g., 'extension', 'mobile').\n   * @param args.config.distribution - The distribution type (e.g., 'main',\n   * 'flask').\n   * @param args.config.environment - The environment type (e.g., 'prod', 'rc',\n   * 'dev').\n   */\n  // eslint-disable-next-line @typescript-eslint/unified-signatures\n  constructor(args: {\n    fetch: typeof fetch;\n    retries?: number;\n    maximumConsecutiveFailures?: number;\n    circuitBreakDuration?: number;\n    onBreak?: () => void;\n    onDegraded?: () => void;\n    config: {\n      client: ClientType;\n      distribution: DistributionType;\n      environment: EnvironmentType;\n    };\n  });\n\n  constructor({\n    fetch: fetchFunction,\n    retries = DEFAULT_MAX_RETRIES,\n    maximumConsecutiveFailures = DEFAULT_MAX_CONSECUTIVE_FAILURES,\n    circuitBreakDuration = DEFAULT_CIRCUIT_BREAK_DURATION,\n    onBreak,\n    onDegraded,\n    config,\n  }: {\n    fetch: typeof fetch;\n    retries?: number;\n    maximumConsecutiveFailures?: number;\n    circuitBreakDuration?: number;\n    onBreak?: () => void;\n    onDegraded?: () => void;\n    config: {\n      client: ClientType;\n      distribution: DistributionType;\n      environment: EnvironmentType;\n    };\n  }) {\n    this.#fetch = fetchFunction;\n    this.#client = config.client;\n    this.#distribution = config.distribution;\n    this.#environment = config.environment;\n\n    this.#policy = createServicePolicy({\n      maxRetries: retries,\n      maxConsecutiveFailures: maximumConsecutiveFailures,\n      circuitBreakDuration,\n    });\n    if (onBreak) {\n      this.#policy.onBreak(onBreak);\n    }\n    if (onDegraded) {\n      this.#policy.onDegraded(onDegraded);\n    }\n  }\n\n  /**\n   * Listens for when the request to the API fails too many times in a row.\n   *\n   * @param args - The same arguments that {@link ServicePolicy.onBreak}\n   * takes.\n   * @returns What {@link ServicePolicy.onBreak} returns.\n   */\n  onBreak(...args: Parameters<ServicePolicy['onBreak']>) {\n    return this.#policy.onBreak(...args);\n  }\n\n  /**\n   * Listens for when the API is degraded.\n   *\n   * @param args - The same arguments that {@link ServicePolicy.onDegraded}\n   * takes.\n   * @returns What {@link ServicePolicy.onDegraded} returns.\n   */\n  onDegraded(...args: Parameters<ServicePolicy['onDegraded']>) {\n    return this.#policy.onDegraded(...args);\n  }\n\n  /**\n   * Fetches feature flags from the API with specific client, distribution, and environment parameters.\n   * Provides structured error handling, including fallback to cached data if available.\n   *\n   * @returns An object of feature flags and their boolean values or a structured error object.\n   */\n  public async fetchRemoteFeatureFlags(): Promise<ServiceResponse> {\n    const url = `${BASE_URL}/flags?client=${this.#client}&distribution=${\n      this.#distribution\n    }&environment=${this.#environment}`;\n\n    const response = await this.#policy.execute(() =>\n      this.#fetch(url, { cache: 'no-cache' }),\n    );\n\n    if (!response.ok) {\n      throw new Error('Failed to fetch remote feature flags');\n    }\n\n    const data = await response.json();\n\n    if (!Array.isArray(data)) {\n      throw new Error('Feature flags api did not return an array');\n    }\n\n    const remoteFeatureFlags = this.flattenFeatureFlags(data);\n\n    return {\n      remoteFeatureFlags,\n      cacheTimestamp: Date.now(),\n    };\n  }\n\n  /**\n   * Flattens an array of feature flag objects into a single feature flags object.\n   *\n   * @param responseData - Array of objects containing feature flag key-value pairs\n   * @returns A single object containing all feature flags merged together\n   * @example\n   * // Input: [{ flag1: true }, { flag2: [] }]\n   * // Output: { flag1: true, flag2: [] }\n   */\n  private flattenFeatureFlags(responseData: ApiDataResponse): FeatureFlags {\n    return responseData.reduce((acc, curr) => {\n      return { ...acc, ...curr };\n    }, {});\n  }\n}\n"]}
+{"version":3,"file":"client-config-api-service.cjs","sourceRoot":"","sources":["../../src/client-config-api-service/client-config-api-service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,iEAKoC;AAKpC,gDAAwC;AAUxC;;GAEG;AACH,MAAa,sBAAsB;IAwFjC,YAAY,EACV,KAAK,EAAE,aAAa,EACpB,OAAO,GAAG,sCAAmB,EAC7B,0BAA0B,GAAG,mDAAgC,EAC7D,oBAAoB,GAAG,iDAA8B,EACrD,OAAO,EACP,UAAU,EACV,MAAM,GAaP;;QA3GQ,gDAAqB;QAErB,iDAAuB;QAEvB,iDAAoB;QAEpB,uDAAgC;QAEhC,sDAA8B;QAoGrC,uBAAA,IAAI,iCAAU,aAAa,MAAA,CAAC;QAC5B,uBAAA,IAAI,kCAAW,MAAM,CAAC,MAAM,MAAA,CAAC;QAC7B,uBAAA,IAAI,wCAAiB,MAAM,CAAC,YAAY,MAAA,CAAC;QACzC,uBAAA,IAAI,uCAAgB,MAAM,CAAC,WAAW,MAAA,CAAC;QAEvC,uBAAA,IAAI,kCAAW,IAAA,sCAAmB,EAAC;YACjC,UAAU,EAAE,OAAO;YACnB,sBAAsB,EAAE,0BAA0B;YAClD,oBAAoB;SACrB,CAAC,MAAA,CAAC;QACH,IAAI,OAAO,EAAE,CAAC;YACZ,uBAAA,IAAI,sCAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAChC,CAAC;QACD,IAAI,UAAU,EAAE,CAAC;YACf,uBAAA,IAAI,sCAAQ,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QACtC,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,OAAO,CAAC,GAAG,IAA0C;QACnD,OAAO,uBAAA,IAAI,sCAAQ,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;IACvC,CAAC;IAED;;;;;;OAMG;IACH,UAAU,CAAC,GAAG,IAA6C;QACzD,OAAO,uBAAA,IAAI,sCAAQ,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,uBAAuB;QAClC,MAAM,GAAG,GAAG,GAAG,oBAAQ,iBAAiB,uBAAA,IAAI,sCAAQ,iBAClD,uBAAA,IAAI,4CACN,gBAAgB,uBAAA,IAAI,2CAAa,EAAE,CAAC;QAEpC,MAAM,QAAQ,GAAG,MAAM,uBAAA,IAAI,sCAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,CAC/C,uBAAA,IAAI,qCAAO,MAAX,IAAI,EAAQ,GAAG,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,CACxC,CAAC;QAEF,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC1D,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAEnC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;QAC/D,CAAC;QAED,MAAM,kBAAkB,GAAG,uBAAA,IAAI,sFAAqB,MAAzB,IAAI,EAAsB,IAAI,CAAC,CAAC;QAE3D,OAAO;YACL,kBAAkB;YAClB,cAAc,EAAE,IAAI,CAAC,GAAG,EAAE;SAC3B,CAAC;IACJ,CAAC;CAgBF;AApMD,wDAoMC;gZALsB,YAA6B;IAChD,OAAO,YAAY,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;QACvC,OAAO,EAAE,GAAG,GAAG,EAAE,GAAG,IAAI,EAAE,CAAC;IAC7B,CAAC,EAAE,EAAE,CAAC,CAAC;AACT,CAAC","sourcesContent":["import {\n  createServicePolicy,\n  DEFAULT_CIRCUIT_BREAK_DURATION,\n  DEFAULT_MAX_CONSECUTIVE_FAILURES,\n  DEFAULT_MAX_RETRIES,\n} from '@metamask/controller-utils';\nimport type { ServicePolicy } from '@metamask/controller-utils';\nimport type { IDisposable } from 'cockatiel';\n\nimport type { AbstractClientConfigApiService } from './abstract-client-config-api-service';\nimport { BASE_URL } from '../constants';\nimport type {\n  FeatureFlags,\n  ClientType,\n  DistributionType,\n  EnvironmentType,\n  ServiceResponse,\n  ApiDataResponse,\n} from '../remote-feature-flag-controller-types';\n\n/**\n * This service is responsible for fetching feature flags from the ClientConfig API.\n */\nexport class ClientConfigApiService implements AbstractClientConfigApiService {\n  readonly #fetch: typeof fetch;\n\n  readonly #policy: ServicePolicy;\n\n  readonly #client: ClientType;\n\n  readonly #distribution: DistributionType;\n\n  readonly #environment: EnvironmentType;\n\n  /**\n   * Constructs a new ClientConfigApiService object.\n   *\n   * @param args - The arguments.\n   * @param args.fetch - A function that can be used to make an HTTP request.\n   * If your JavaScript environment supports `fetch` natively, you'll probably\n   * want to pass that; otherwise you can pass an equivalent (such as `fetch`\n   * via `node-fetch`).\n   * @param args.retries - Number of retry attempts for each fetch request.\n   * @param args.maximumConsecutiveFailures - The maximum number of consecutive\n   * failures allowed before breaking the circuit and pausing further fetch\n   * attempts.\n   * @param args.circuitBreakDuration - The amount of time to wait when the\n   * circuit breaks from too many consecutive failures.\n   * @param args.config - The configuration object, includes client,\n   * distribution, and environment.\n   * @param args.config.client - The client type (e.g., 'extension', 'mobile').\n   * @param args.config.distribution - The distribution type (e.g., 'main',\n   * 'flask').\n   * @param args.config.environment - The environment type (e.g., 'prod', 'rc',\n   * 'dev').\n   */\n  constructor(args: {\n    fetch: typeof fetch;\n    retries?: number;\n    maximumConsecutiveFailures?: number;\n    circuitBreakDuration?: number;\n    config: {\n      client: ClientType;\n      distribution: DistributionType;\n      environment: EnvironmentType;\n    };\n  });\n\n  /**\n   * Constructs a new ClientConfigApiService object.\n   *\n   * @deprecated This signature is deprecated; please use the `onBreak` and\n   * `onDegraded` methods instead.\n   * @param args - The arguments.\n   * @param args.fetch - A function that can be used to make an HTTP request.\n   * If your JavaScript environment supports `fetch` natively, you'll probably\n   * want to pass that; otherwise you can pass an equivalent (such as `fetch`\n   * via `node-fetch`).\n   * @param args.retries - Number of retry attempts for each fetch request.\n   * @param args.maximumConsecutiveFailures - The maximum number of consecutive\n   * failures allowed before breaking the circuit and pausing further fetch\n   * attempts.\n   * @param args.circuitBreakDuration - The amount of time to wait when the\n   * circuit breaks from too many consecutive failures.\n   * @param args.onBreak - Callback for when the circuit breaks, useful\n   * for capturing metrics about network failures.\n   * @param args.onDegraded - Callback for when the API responds successfully\n   * but takes too long to respond (5 seconds or more).\n   * @param args.config - The configuration object, includes client,\n   * distribution, and environment.\n   * @param args.config.client - The client type (e.g., 'extension', 'mobile').\n   * @param args.config.distribution - The distribution type (e.g., 'main',\n   * 'flask').\n   * @param args.config.environment - The environment type (e.g., 'prod', 'rc',\n   * 'dev').\n   */\n  // eslint-disable-next-line @typescript-eslint/unified-signatures\n  constructor(args: {\n    fetch: typeof fetch;\n    retries?: number;\n    maximumConsecutiveFailures?: number;\n    circuitBreakDuration?: number;\n    onBreak?: () => void;\n    onDegraded?: () => void;\n    config: {\n      client: ClientType;\n      distribution: DistributionType;\n      environment: EnvironmentType;\n    };\n  });\n\n  constructor({\n    fetch: fetchFunction,\n    retries = DEFAULT_MAX_RETRIES,\n    maximumConsecutiveFailures = DEFAULT_MAX_CONSECUTIVE_FAILURES,\n    circuitBreakDuration = DEFAULT_CIRCUIT_BREAK_DURATION,\n    onBreak,\n    onDegraded,\n    config,\n  }: {\n    fetch: typeof fetch;\n    retries?: number;\n    maximumConsecutiveFailures?: number;\n    circuitBreakDuration?: number;\n    onBreak?: () => void;\n    onDegraded?: () => void;\n    config: {\n      client: ClientType;\n      distribution: DistributionType;\n      environment: EnvironmentType;\n    };\n  }) {\n    this.#fetch = fetchFunction;\n    this.#client = config.client;\n    this.#distribution = config.distribution;\n    this.#environment = config.environment;\n\n    this.#policy = createServicePolicy({\n      maxRetries: retries,\n      maxConsecutiveFailures: maximumConsecutiveFailures,\n      circuitBreakDuration,\n    });\n    if (onBreak) {\n      this.#policy.onBreak(onBreak);\n    }\n    if (onDegraded) {\n      this.#policy.onDegraded(onDegraded);\n    }\n  }\n\n  /**\n   * Listens for when the request to the API fails too many times in a row.\n   *\n   * @param args - The same arguments that {@link ServicePolicy.onBreak}\n   * takes.\n   * @returns What {@link ServicePolicy.onBreak} returns.\n   */\n  onBreak(...args: Parameters<ServicePolicy['onBreak']>): IDisposable {\n    return this.#policy.onBreak(...args);\n  }\n\n  /**\n   * Listens for when the API is degraded.\n   *\n   * @param args - The same arguments that {@link ServicePolicy.onDegraded}\n   * takes.\n   * @returns What {@link ServicePolicy.onDegraded} returns.\n   */\n  onDegraded(...args: Parameters<ServicePolicy['onDegraded']>): IDisposable {\n    return this.#policy.onDegraded(...args);\n  }\n\n  /**\n   * Fetches feature flags from the API with specific client, distribution, and environment parameters.\n   * Provides structured error handling, including fallback to cached data if available.\n   *\n   * @returns An object of feature flags and their boolean values or a structured error object.\n   */\n  public async fetchRemoteFeatureFlags(): Promise<ServiceResponse> {\n    const url = `${BASE_URL}/flags?client=${this.#client}&distribution=${\n      this.#distribution\n    }&environment=${this.#environment}`;\n\n    const response = await this.#policy.execute(() =>\n      this.#fetch(url, { cache: 'no-cache' }),\n    );\n\n    if (!response.ok) {\n      throw new Error('Failed to fetch remote feature flags');\n    }\n\n    const data = await response.json();\n\n    if (!Array.isArray(data)) {\n      throw new Error('Feature flags api did not return an array');\n    }\n\n    const remoteFeatureFlags = this.#flattenFeatureFlags(data);\n\n    return {\n      remoteFeatureFlags,\n      cacheTimestamp: Date.now(),\n    };\n  }\n\n  /**\n   * Flattens an array of feature flag objects into a single feature flags object.\n   *\n   * @param responseData - Array of objects containing feature flag key-value pairs\n   * @returns A single object containing all feature flags merged together\n   * @example\n   * // Input: [{ flag1: true }, { flag2: [] }]\n   * // Output: { flag1: true, flag2: [] }\n   */\n  #flattenFeatureFlags(responseData: ApiDataResponse): FeatureFlags {\n    return responseData.reduce((acc, curr) => {\n      return { ...acc, ...curr };\n    }, {});\n  }\n}\n"]}

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

@@ -1,4 +1,5 @@
 import type { ServicePolicy } from "@metamask/controller-utils";
+import type { IDisposable } from "cockatiel";
 import type { AbstractClientConfigApiService } from "./abstract-client-config-api-service.cjs";
 import type { ClientType, DistributionType, EnvironmentType, ServiceResponse } from "../remote-feature-flag-controller-types.cjs";
 /**
@@ -87,7 +88,7 @@ export declare class ClientConfigApiService implements AbstractClientConfigApiSe
      * takes.
      * @returns What {@link ServicePolicy.onBreak} returns.
      */
-    onBreak(...args: Parameters<ServicePolicy['onBreak']>): import("cockatiel").IDisposable;
+    onBreak(...args: Parameters<ServicePolicy['onBreak']>): IDisposable;
     /**
      * Listens for when the API is degraded.
      *
@@ -95,7 +96,7 @@ export declare class ClientConfigApiService implements AbstractClientConfigApiSe
      * takes.
      * @returns What {@link ServicePolicy.onDegraded} returns.
      */
-    onDegraded(...args: Parameters<ServicePolicy['onDegraded']>): import("cockatiel").IDisposable;
+    onDegraded(...args: Parameters<ServicePolicy['onDegraded']>): IDisposable;
     /**
      * Fetches feature flags from the API with specific client, distribution, and environment parameters.
      * Provides structured error handling, including fallback to cached data if available.
@@ -103,15 +104,5 @@ export declare class ClientConfigApiService implements AbstractClientConfigApiSe
      * @returns An object of feature flags and their boolean values or a structured error object.
      */
     fetchRemoteFeatureFlags(): Promise<ServiceResponse>;
-    /**
-     * Flattens an array of feature flag objects into a single feature flags object.
-     *
-     * @param responseData - Array of objects containing feature flag key-value pairs
-     * @returns A single object containing all feature flags merged together
-     * @example
-     * // Input: [{ flag1: true }, { flag2: [] }]
-     * // Output: { flag1: true, flag2: [] }
-     */
-    private flattenFeatureFlags;
 }
 //# sourceMappingURL=client-config-api-service.d.cts.map

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

@@ -1 +1 @@
-{"version":3,"file":"client-config-api-service.d.cts","sourceRoot":"","sources":["../../src/client-config-api-service/client-config-api-service.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,aAAa,EAAE,mCAAmC;AAEhE,OAAO,KAAK,EAAE,8BAA8B,EAAE,iDAA6C;AAE3F,OAAO,KAAK,EAEV,UAAU,EACV,gBAAgB,EAChB,eAAe,EACf,eAAe,EAEhB,oDAAgD;AAEjD;;GAEG;AACH,qBAAa,sBAAuB,YAAW,8BAA8B;;IAW3E;;;;;;;;;;;;;;;;;;;;;OAqBG;gBACS,IAAI,EAAE;QAChB,KAAK,EAAE,OAAO,KAAK,CAAC;QACpB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,0BAA0B,CAAC,EAAE,MAAM,CAAC;QACpC,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAC9B,MAAM,EAAE;YACN,MAAM,EAAE,UAAU,CAAC;YACnB,YAAY,EAAE,gBAAgB,CAAC;YAC/B,WAAW,EAAE,eAAe,CAAC;SAC9B,CAAC;KACH;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;gBAES,IAAI,EAAE;QAChB,KAAK,EAAE,OAAO,KAAK,CAAC;QACpB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,0BAA0B,CAAC,EAAE,MAAM,CAAC;QACpC,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAC9B,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,IAAI,CAAC;QACxB,MAAM,EAAE;YACN,MAAM,EAAE,UAAU,CAAC;YACnB,YAAY,EAAE,gBAAgB,CAAC;YAC/B,WAAW,EAAE,eAAe,CAAC;SAC9B,CAAC;KACH;IAyCD;;;;;;OAMG;IACH,OAAO,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IAIrD;;;;;;OAMG;IACH,UAAU,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;IAI3D;;;;;OAKG;IACU,uBAAuB,IAAI,OAAO,CAAC,eAAe,CAAC;IA2BhE;;;;;;;;OAQG;IACH,OAAO,CAAC,mBAAmB;CAK5B"}
+{"version":3,"file":"client-config-api-service.d.cts","sourceRoot":"","sources":["../../src/client-config-api-service/client-config-api-service.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,aAAa,EAAE,mCAAmC;AAChE,OAAO,KAAK,EAAE,WAAW,EAAE,kBAAkB;AAE7C,OAAO,KAAK,EAAE,8BAA8B,EAAE,iDAA6C;AAE3F,OAAO,KAAK,EAEV,UAAU,EACV,gBAAgB,EAChB,eAAe,EACf,eAAe,EAEhB,oDAAgD;AAEjD;;GAEG;AACH,qBAAa,sBAAuB,YAAW,8BAA8B;;IAW3E;;;;;;;;;;;;;;;;;;;;;OAqBG;gBACS,IAAI,EAAE;QAChB,KAAK,EAAE,OAAO,KAAK,CAAC;QACpB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,0BAA0B,CAAC,EAAE,MAAM,CAAC;QACpC,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAC9B,MAAM,EAAE;YACN,MAAM,EAAE,UAAU,CAAC;YACnB,YAAY,EAAE,gBAAgB,CAAC;YAC/B,WAAW,EAAE,eAAe,CAAC;SAC9B,CAAC;KACH;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;gBAES,IAAI,EAAE;QAChB,KAAK,EAAE,OAAO,KAAK,CAAC;QACpB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,0BAA0B,CAAC,EAAE,MAAM,CAAC;QACpC,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAC9B,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,IAAI,CAAC;QACxB,MAAM,EAAE;YACN,MAAM,EAAE,UAAU,CAAC;YACnB,YAAY,EAAE,gBAAgB,CAAC;YAC/B,WAAW,EAAE,eAAe,CAAC;SAC9B,CAAC;KACH;IAyCD;;;;;;OAMG;IACH,OAAO,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,GAAG,WAAW;IAInE;;;;;;OAMG;IACH,UAAU,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,GAAG,WAAW;IAIzE;;;;;OAKG;IACU,uBAAuB,IAAI,OAAO,CAAC,eAAe,CAAC;CAyCjE"}

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

@@ -1,4 +1,5 @@
 import type { ServicePolicy } from "@metamask/controller-utils";
+import type { IDisposable } from "cockatiel";
 import type { AbstractClientConfigApiService } from "./abstract-client-config-api-service.mjs";
 import type { ClientType, DistributionType, EnvironmentType, ServiceResponse } from "../remote-feature-flag-controller-types.mjs";
 /**
@@ -87,7 +88,7 @@ export declare class ClientConfigApiService implements AbstractClientConfigApiSe
      * takes.
      * @returns What {@link ServicePolicy.onBreak} returns.
      */
-    onBreak(...args: Parameters<ServicePolicy['onBreak']>): import("cockatiel").IDisposable;
+    onBreak(...args: Parameters<ServicePolicy['onBreak']>): IDisposable;
     /**
      * Listens for when the API is degraded.
      *
@@ -95,7 +96,7 @@ export declare class ClientConfigApiService implements AbstractClientConfigApiSe
      * takes.
      * @returns What {@link ServicePolicy.onDegraded} returns.
      */
-    onDegraded(...args: Parameters<ServicePolicy['onDegraded']>): import("cockatiel").IDisposable;
+    onDegraded(...args: Parameters<ServicePolicy['onDegraded']>): IDisposable;
     /**
      * Fetches feature flags from the API with specific client, distribution, and environment parameters.
      * Provides structured error handling, including fallback to cached data if available.
@@ -103,15 +104,5 @@ export declare class ClientConfigApiService implements AbstractClientConfigApiSe
      * @returns An object of feature flags and their boolean values or a structured error object.
      */
     fetchRemoteFeatureFlags(): Promise<ServiceResponse>;
-    /**
-     * Flattens an array of feature flag objects into a single feature flags object.
-     *
-     * @param responseData - Array of objects containing feature flag key-value pairs
-     * @returns A single object containing all feature flags merged together
-     * @example
-     * // Input: [{ flag1: true }, { flag2: [] }]
-     * // Output: { flag1: true, flag2: [] }
-     */
-    private flattenFeatureFlags;
 }
 //# sourceMappingURL=client-config-api-service.d.mts.map

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

@@ -1 +1 @@
-{"version":3,"file":"client-config-api-service.d.mts","sourceRoot":"","sources":["../../src/client-config-api-service/client-config-api-service.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,aAAa,EAAE,mCAAmC;AAEhE,OAAO,KAAK,EAAE,8BAA8B,EAAE,iDAA6C;AAE3F,OAAO,KAAK,EAEV,UAAU,EACV,gBAAgB,EAChB,eAAe,EACf,eAAe,EAEhB,oDAAgD;AAEjD;;GAEG;AACH,qBAAa,sBAAuB,YAAW,8BAA8B;;IAW3E;;;;;;;;;;;;;;;;;;;;;OAqBG;gBACS,IAAI,EAAE;QAChB,KAAK,EAAE,OAAO,KAAK,CAAC;QACpB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,0BAA0B,CAAC,EAAE,MAAM,CAAC;QACpC,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAC9B,MAAM,EAAE;YACN,MAAM,EAAE,UAAU,CAAC;YACnB,YAAY,EAAE,gBAAgB,CAAC;YAC/B,WAAW,EAAE,eAAe,CAAC;SAC9B,CAAC;KACH;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;gBAES,IAAI,EAAE;QAChB,KAAK,EAAE,OAAO,KAAK,CAAC;QACpB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,0BAA0B,CAAC,EAAE,MAAM,CAAC;QACpC,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAC9B,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,IAAI,CAAC;QACxB,MAAM,EAAE;YACN,MAAM,EAAE,UAAU,CAAC;YACnB,YAAY,EAAE,gBAAgB,CAAC;YAC/B,WAAW,EAAE,eAAe,CAAC;SAC9B,CAAC;KACH;IAyCD;;;;;;OAMG;IACH,OAAO,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IAIrD;;;;;;OAMG;IACH,UAAU,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;IAI3D;;;;;OAKG;IACU,uBAAuB,IAAI,OAAO,CAAC,eAAe,CAAC;IA2BhE;;;;;;;;OAQG;IACH,OAAO,CAAC,mBAAmB;CAK5B"}
+{"version":3,"file":"client-config-api-service.d.mts","sourceRoot":"","sources":["../../src/client-config-api-service/client-config-api-service.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,aAAa,EAAE,mCAAmC;AAChE,OAAO,KAAK,EAAE,WAAW,EAAE,kBAAkB;AAE7C,OAAO,KAAK,EAAE,8BAA8B,EAAE,iDAA6C;AAE3F,OAAO,KAAK,EAEV,UAAU,EACV,gBAAgB,EAChB,eAAe,EACf,eAAe,EAEhB,oDAAgD;AAEjD;;GAEG;AACH,qBAAa,sBAAuB,YAAW,8BAA8B;;IAW3E;;;;;;;;;;;;;;;;;;;;;OAqBG;gBACS,IAAI,EAAE;QAChB,KAAK,EAAE,OAAO,KAAK,CAAC;QACpB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,0BAA0B,CAAC,EAAE,MAAM,CAAC;QACpC,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAC9B,MAAM,EAAE;YACN,MAAM,EAAE,UAAU,CAAC;YACnB,YAAY,EAAE,gBAAgB,CAAC;YAC/B,WAAW,EAAE,eAAe,CAAC;SAC9B,CAAC;KACH;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;gBAES,IAAI,EAAE;QAChB,KAAK,EAAE,OAAO,KAAK,CAAC;QACpB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,0BAA0B,CAAC,EAAE,MAAM,CAAC;QACpC,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAC9B,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,IAAI,CAAC;QACxB,MAAM,EAAE;YACN,MAAM,EAAE,UAAU,CAAC;YACnB,YAAY,EAAE,gBAAgB,CAAC;YAC/B,WAAW,EAAE,eAAe,CAAC;SAC9B,CAAC;KACH;IAyCD;;;;;;OAMG;IACH,OAAO,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,GAAG,WAAW;IAInE;;;;;;OAMG;IACH,UAAU,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,GAAG,WAAW;IAIzE;;;;;OAKG;IACU,uBAAuB,IAAI,OAAO,CAAC,eAAe,CAAC;CAyCjE"}

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

@@ -9,7 +9,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     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 _ClientConfigApiService_fetch, _ClientConfigApiService_policy, _ClientConfigApiService_client, _ClientConfigApiService_distribution, _ClientConfigApiService_environment;
+var _ClientConfigApiService_instances, _ClientConfigApiService_fetch, _ClientConfigApiService_policy, _ClientConfigApiService_client, _ClientConfigApiService_distribution, _ClientConfigApiService_environment, _ClientConfigApiService_flattenFeatureFlags;
 import { createServicePolicy, DEFAULT_CIRCUIT_BREAK_DURATION, DEFAULT_MAX_CONSECUTIVE_FAILURES, DEFAULT_MAX_RETRIES } from "@metamask/controller-utils";
 import { BASE_URL } from "../constants.mjs";
 /**
@@ -17,6 +17,7 @@ import { BASE_URL } from "../constants.mjs";
  */
 export class ClientConfigApiService {
     constructor({ fetch: fetchFunction, retries = DEFAULT_MAX_RETRIES, maximumConsecutiveFailures = DEFAULT_MAX_CONSECUTIVE_FAILURES, circuitBreakDuration = DEFAULT_CIRCUIT_BREAK_DURATION, onBreak, onDegraded, config, }) {
+        _ClientConfigApiService_instances.add(this);
         _ClientConfigApiService_fetch.set(this, void 0);
         _ClientConfigApiService_policy.set(this, void 0);
         _ClientConfigApiService_client.set(this, void 0);
@@ -74,26 +75,16 @@ export class ClientConfigApiService {
         if (!Array.isArray(data)) {
             throw new Error('Feature flags api did not return an array');
         }
-        const remoteFeatureFlags = this.flattenFeatureFlags(data);
+        const remoteFeatureFlags = __classPrivateFieldGet(this, _ClientConfigApiService_instances, "m", _ClientConfigApiService_flattenFeatureFlags).call(this, data);
         return {
             remoteFeatureFlags,
             cacheTimestamp: Date.now(),
         };
     }
-    /**
-     * Flattens an array of feature flag objects into a single feature flags object.
-     *
-     * @param responseData - Array of objects containing feature flag key-value pairs
-     * @returns A single object containing all feature flags merged together
-     * @example
-     * // Input: [{ flag1: true }, { flag2: [] }]
-     * // Output: { flag1: true, flag2: [] }
-     */
-    flattenFeatureFlags(responseData) {
-        return responseData.reduce((acc, curr) => {
-            return { ...acc, ...curr };
-        }, {});
-    }
 }
-_ClientConfigApiService_fetch = new WeakMap(), _ClientConfigApiService_policy = new WeakMap(), _ClientConfigApiService_client = new WeakMap(), _ClientConfigApiService_distribution = new WeakMap(), _ClientConfigApiService_environment = new WeakMap();
+_ClientConfigApiService_fetch = new WeakMap(), _ClientConfigApiService_policy = new WeakMap(), _ClientConfigApiService_client = new WeakMap(), _ClientConfigApiService_distribution = new WeakMap(), _ClientConfigApiService_environment = new WeakMap(), _ClientConfigApiService_instances = new WeakSet(), _ClientConfigApiService_flattenFeatureFlags = function _ClientConfigApiService_flattenFeatureFlags(responseData) {
+    return responseData.reduce((acc, curr) => {
+        return { ...acc, ...curr };
+    }, {});
+};
 //# sourceMappingURL=client-config-api-service.mjs.map

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

@@ -1 +1 @@
-{"version":3,"file":"client-config-api-service.mjs","sourceRoot":"","sources":["../../src/client-config-api-service/client-config-api-service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EACL,mBAAmB,EACnB,8BAA8B,EAC9B,gCAAgC,EAChC,mBAAmB,EACpB,mCAAmC;AAIpC,OAAO,EAAE,QAAQ,EAAE,yBAAqB;AAUxC;;GAEG;AACH,MAAM,OAAO,sBAAsB;IAwFjC,YAAY,EACV,KAAK,EAAE,aAAa,EACpB,OAAO,GAAG,mBAAmB,EAC7B,0BAA0B,GAAG,gCAAgC,EAC7D,oBAAoB,GAAG,8BAA8B,EACrD,OAAO,EACP,UAAU,EACV,MAAM,GAaP;QA3GQ,gDAAqB;QAErB,iDAAuB;QAEvB,iDAAoB;QAEpB,uDAAgC;QAEhC,sDAA8B;QAoGrC,uBAAA,IAAI,iCAAU,aAAa,MAAA,CAAC;QAC5B,uBAAA,IAAI,kCAAW,MAAM,CAAC,MAAM,MAAA,CAAC;QAC7B,uBAAA,IAAI,wCAAiB,MAAM,CAAC,YAAY,MAAA,CAAC;QACzC,uBAAA,IAAI,uCAAgB,MAAM,CAAC,WAAW,MAAA,CAAC;QAEvC,uBAAA,IAAI,kCAAW,mBAAmB,CAAC;YACjC,UAAU,EAAE,OAAO;YACnB,sBAAsB,EAAE,0BAA0B;YAClD,oBAAoB;SACrB,CAAC,MAAA,CAAC;QACH,IAAI,OAAO,EAAE,CAAC;YACZ,uBAAA,IAAI,sCAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAChC,CAAC;QACD,IAAI,UAAU,EAAE,CAAC;YACf,uBAAA,IAAI,sCAAQ,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QACtC,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,OAAO,CAAC,GAAG,IAA0C;QACnD,OAAO,uBAAA,IAAI,sCAAQ,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;IACvC,CAAC;IAED;;;;;;OAMG;IACH,UAAU,CAAC,GAAG,IAA6C;QACzD,OAAO,uBAAA,IAAI,sCAAQ,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,uBAAuB;QAClC,MAAM,GAAG,GAAG,GAAG,QAAQ,iBAAiB,uBAAA,IAAI,sCAAQ,iBAClD,uBAAA,IAAI,4CACN,gBAAgB,uBAAA,IAAI,2CAAa,EAAE,CAAC;QAEpC,MAAM,QAAQ,GAAG,MAAM,uBAAA,IAAI,sCAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,CAC/C,uBAAA,IAAI,qCAAO,MAAX,IAAI,EAAQ,GAAG,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,CACxC,CAAC;QAEF,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC1D,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAEnC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;QAC/D,CAAC;QAED,MAAM,kBAAkB,GAAG,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;QAE1D,OAAO;YACL,kBAAkB;YAClB,cAAc,EAAE,IAAI,CAAC,GAAG,EAAE;SAC3B,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACK,mBAAmB,CAAC,YAA6B;QACvD,OAAO,YAAY,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;YACvC,OAAO,EAAE,GAAG,GAAG,EAAE,GAAG,IAAI,EAAE,CAAC;QAC7B,CAAC,EAAE,EAAE,CAAC,CAAC;IACT,CAAC;CACF","sourcesContent":["import {\n  createServicePolicy,\n  DEFAULT_CIRCUIT_BREAK_DURATION,\n  DEFAULT_MAX_CONSECUTIVE_FAILURES,\n  DEFAULT_MAX_RETRIES,\n} from '@metamask/controller-utils';\nimport type { ServicePolicy } from '@metamask/controller-utils';\n\nimport type { AbstractClientConfigApiService } from './abstract-client-config-api-service';\nimport { BASE_URL } from '../constants';\nimport type {\n  FeatureFlags,\n  ClientType,\n  DistributionType,\n  EnvironmentType,\n  ServiceResponse,\n  ApiDataResponse,\n} from '../remote-feature-flag-controller-types';\n\n/**\n * This service is responsible for fetching feature flags from the ClientConfig API.\n */\nexport class ClientConfigApiService implements AbstractClientConfigApiService {\n  readonly #fetch: typeof fetch;\n\n  readonly #policy: ServicePolicy;\n\n  readonly #client: ClientType;\n\n  readonly #distribution: DistributionType;\n\n  readonly #environment: EnvironmentType;\n\n  /**\n   * Constructs a new ClientConfigApiService object.\n   *\n   * @param args - The arguments.\n   * @param args.fetch - A function that can be used to make an HTTP request.\n   * If your JavaScript environment supports `fetch` natively, you'll probably\n   * want to pass that; otherwise you can pass an equivalent (such as `fetch`\n   * via `node-fetch`).\n   * @param args.retries - Number of retry attempts for each fetch request.\n   * @param args.maximumConsecutiveFailures - The maximum number of consecutive\n   * failures allowed before breaking the circuit and pausing further fetch\n   * attempts.\n   * @param args.circuitBreakDuration - The amount of time to wait when the\n   * circuit breaks from too many consecutive failures.\n   * @param args.config - The configuration object, includes client,\n   * distribution, and environment.\n   * @param args.config.client - The client type (e.g., 'extension', 'mobile').\n   * @param args.config.distribution - The distribution type (e.g., 'main',\n   * 'flask').\n   * @param args.config.environment - The environment type (e.g., 'prod', 'rc',\n   * 'dev').\n   */\n  constructor(args: {\n    fetch: typeof fetch;\n    retries?: number;\n    maximumConsecutiveFailures?: number;\n    circuitBreakDuration?: number;\n    config: {\n      client: ClientType;\n      distribution: DistributionType;\n      environment: EnvironmentType;\n    };\n  });\n\n  /**\n   * Constructs a new ClientConfigApiService object.\n   *\n   * @deprecated This signature is deprecated; please use the `onBreak` and\n   * `onDegraded` methods instead.\n   * @param args - The arguments.\n   * @param args.fetch - A function that can be used to make an HTTP request.\n   * If your JavaScript environment supports `fetch` natively, you'll probably\n   * want to pass that; otherwise you can pass an equivalent (such as `fetch`\n   * via `node-fetch`).\n   * @param args.retries - Number of retry attempts for each fetch request.\n   * @param args.maximumConsecutiveFailures - The maximum number of consecutive\n   * failures allowed before breaking the circuit and pausing further fetch\n   * attempts.\n   * @param args.circuitBreakDuration - The amount of time to wait when the\n   * circuit breaks from too many consecutive failures.\n   * @param args.onBreak - Callback for when the circuit breaks, useful\n   * for capturing metrics about network failures.\n   * @param args.onDegraded - Callback for when the API responds successfully\n   * but takes too long to respond (5 seconds or more).\n   * @param args.config - The configuration object, includes client,\n   * distribution, and environment.\n   * @param args.config.client - The client type (e.g., 'extension', 'mobile').\n   * @param args.config.distribution - The distribution type (e.g., 'main',\n   * 'flask').\n   * @param args.config.environment - The environment type (e.g., 'prod', 'rc',\n   * 'dev').\n   */\n  // eslint-disable-next-line @typescript-eslint/unified-signatures\n  constructor(args: {\n    fetch: typeof fetch;\n    retries?: number;\n    maximumConsecutiveFailures?: number;\n    circuitBreakDuration?: number;\n    onBreak?: () => void;\n    onDegraded?: () => void;\n    config: {\n      client: ClientType;\n      distribution: DistributionType;\n      environment: EnvironmentType;\n    };\n  });\n\n  constructor({\n    fetch: fetchFunction,\n    retries = DEFAULT_MAX_RETRIES,\n    maximumConsecutiveFailures = DEFAULT_MAX_CONSECUTIVE_FAILURES,\n    circuitBreakDuration = DEFAULT_CIRCUIT_BREAK_DURATION,\n    onBreak,\n    onDegraded,\n    config,\n  }: {\n    fetch: typeof fetch;\n    retries?: number;\n    maximumConsecutiveFailures?: number;\n    circuitBreakDuration?: number;\n    onBreak?: () => void;\n    onDegraded?: () => void;\n    config: {\n      client: ClientType;\n      distribution: DistributionType;\n      environment: EnvironmentType;\n    };\n  }) {\n    this.#fetch = fetchFunction;\n    this.#client = config.client;\n    this.#distribution = config.distribution;\n    this.#environment = config.environment;\n\n    this.#policy = createServicePolicy({\n      maxRetries: retries,\n      maxConsecutiveFailures: maximumConsecutiveFailures,\n      circuitBreakDuration,\n    });\n    if (onBreak) {\n      this.#policy.onBreak(onBreak);\n    }\n    if (onDegraded) {\n      this.#policy.onDegraded(onDegraded);\n    }\n  }\n\n  /**\n   * Listens for when the request to the API fails too many times in a row.\n   *\n   * @param args - The same arguments that {@link ServicePolicy.onBreak}\n   * takes.\n   * @returns What {@link ServicePolicy.onBreak} returns.\n   */\n  onBreak(...args: Parameters<ServicePolicy['onBreak']>) {\n    return this.#policy.onBreak(...args);\n  }\n\n  /**\n   * Listens for when the API is degraded.\n   *\n   * @param args - The same arguments that {@link ServicePolicy.onDegraded}\n   * takes.\n   * @returns What {@link ServicePolicy.onDegraded} returns.\n   */\n  onDegraded(...args: Parameters<ServicePolicy['onDegraded']>) {\n    return this.#policy.onDegraded(...args);\n  }\n\n  /**\n   * Fetches feature flags from the API with specific client, distribution, and environment parameters.\n   * Provides structured error handling, including fallback to cached data if available.\n   *\n   * @returns An object of feature flags and their boolean values or a structured error object.\n   */\n  public async fetchRemoteFeatureFlags(): Promise<ServiceResponse> {\n    const url = `${BASE_URL}/flags?client=${this.#client}&distribution=${\n      this.#distribution\n    }&environment=${this.#environment}`;\n\n    const response = await this.#policy.execute(() =>\n      this.#fetch(url, { cache: 'no-cache' }),\n    );\n\n    if (!response.ok) {\n      throw new Error('Failed to fetch remote feature flags');\n    }\n\n    const data = await response.json();\n\n    if (!Array.isArray(data)) {\n      throw new Error('Feature flags api did not return an array');\n    }\n\n    const remoteFeatureFlags = this.flattenFeatureFlags(data);\n\n    return {\n      remoteFeatureFlags,\n      cacheTimestamp: Date.now(),\n    };\n  }\n\n  /**\n   * Flattens an array of feature flag objects into a single feature flags object.\n   *\n   * @param responseData - Array of objects containing feature flag key-value pairs\n   * @returns A single object containing all feature flags merged together\n   * @example\n   * // Input: [{ flag1: true }, { flag2: [] }]\n   * // Output: { flag1: true, flag2: [] }\n   */\n  private flattenFeatureFlags(responseData: ApiDataResponse): FeatureFlags {\n    return responseData.reduce((acc, curr) => {\n      return { ...acc, ...curr };\n    }, {});\n  }\n}\n"]}
+{"version":3,"file":"client-config-api-service.mjs","sourceRoot":"","sources":["../../src/client-config-api-service/client-config-api-service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EACL,mBAAmB,EACnB,8BAA8B,EAC9B,gCAAgC,EAChC,mBAAmB,EACpB,mCAAmC;AAKpC,OAAO,EAAE,QAAQ,EAAE,yBAAqB;AAUxC;;GAEG;AACH,MAAM,OAAO,sBAAsB;IAwFjC,YAAY,EACV,KAAK,EAAE,aAAa,EACpB,OAAO,GAAG,mBAAmB,EAC7B,0BAA0B,GAAG,gCAAgC,EAC7D,oBAAoB,GAAG,8BAA8B,EACrD,OAAO,EACP,UAAU,EACV,MAAM,GAaP;;QA3GQ,gDAAqB;QAErB,iDAAuB;QAEvB,iDAAoB;QAEpB,uDAAgC;QAEhC,sDAA8B;QAoGrC,uBAAA,IAAI,iCAAU,aAAa,MAAA,CAAC;QAC5B,uBAAA,IAAI,kCAAW,MAAM,CAAC,MAAM,MAAA,CAAC;QAC7B,uBAAA,IAAI,wCAAiB,MAAM,CAAC,YAAY,MAAA,CAAC;QACzC,uBAAA,IAAI,uCAAgB,MAAM,CAAC,WAAW,MAAA,CAAC;QAEvC,uBAAA,IAAI,kCAAW,mBAAmB,CAAC;YACjC,UAAU,EAAE,OAAO;YACnB,sBAAsB,EAAE,0BAA0B;YAClD,oBAAoB;SACrB,CAAC,MAAA,CAAC;QACH,IAAI,OAAO,EAAE,CAAC;YACZ,uBAAA,IAAI,sCAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAChC,CAAC;QACD,IAAI,UAAU,EAAE,CAAC;YACf,uBAAA,IAAI,sCAAQ,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QACtC,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,OAAO,CAAC,GAAG,IAA0C;QACnD,OAAO,uBAAA,IAAI,sCAAQ,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;IACvC,CAAC;IAED;;;;;;OAMG;IACH,UAAU,CAAC,GAAG,IAA6C;QACzD,OAAO,uBAAA,IAAI,sCAAQ,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,uBAAuB;QAClC,MAAM,GAAG,GAAG,GAAG,QAAQ,iBAAiB,uBAAA,IAAI,sCAAQ,iBAClD,uBAAA,IAAI,4CACN,gBAAgB,uBAAA,IAAI,2CAAa,EAAE,CAAC;QAEpC,MAAM,QAAQ,GAAG,MAAM,uBAAA,IAAI,sCAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,CAC/C,uBAAA,IAAI,qCAAO,MAAX,IAAI,EAAQ,GAAG,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,CACxC,CAAC;QAEF,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC1D,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAEnC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;QAC/D,CAAC;QAED,MAAM,kBAAkB,GAAG,uBAAA,IAAI,sFAAqB,MAAzB,IAAI,EAAsB,IAAI,CAAC,CAAC;QAE3D,OAAO;YACL,kBAAkB;YAClB,cAAc,EAAE,IAAI,CAAC,GAAG,EAAE;SAC3B,CAAC;IACJ,CAAC;CAgBF;gZALsB,YAA6B;IAChD,OAAO,YAAY,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;QACvC,OAAO,EAAE,GAAG,GAAG,EAAE,GAAG,IAAI,EAAE,CAAC;IAC7B,CAAC,EAAE,EAAE,CAAC,CAAC;AACT,CAAC","sourcesContent":["import {\n  createServicePolicy,\n  DEFAULT_CIRCUIT_BREAK_DURATION,\n  DEFAULT_MAX_CONSECUTIVE_FAILURES,\n  DEFAULT_MAX_RETRIES,\n} from '@metamask/controller-utils';\nimport type { ServicePolicy } from '@metamask/controller-utils';\nimport type { IDisposable } from 'cockatiel';\n\nimport type { AbstractClientConfigApiService } from './abstract-client-config-api-service';\nimport { BASE_URL } from '../constants';\nimport type {\n  FeatureFlags,\n  ClientType,\n  DistributionType,\n  EnvironmentType,\n  ServiceResponse,\n  ApiDataResponse,\n} from '../remote-feature-flag-controller-types';\n\n/**\n * This service is responsible for fetching feature flags from the ClientConfig API.\n */\nexport class ClientConfigApiService implements AbstractClientConfigApiService {\n  readonly #fetch: typeof fetch;\n\n  readonly #policy: ServicePolicy;\n\n  readonly #client: ClientType;\n\n  readonly #distribution: DistributionType;\n\n  readonly #environment: EnvironmentType;\n\n  /**\n   * Constructs a new ClientConfigApiService object.\n   *\n   * @param args - The arguments.\n   * @param args.fetch - A function that can be used to make an HTTP request.\n   * If your JavaScript environment supports `fetch` natively, you'll probably\n   * want to pass that; otherwise you can pass an equivalent (such as `fetch`\n   * via `node-fetch`).\n   * @param args.retries - Number of retry attempts for each fetch request.\n   * @param args.maximumConsecutiveFailures - The maximum number of consecutive\n   * failures allowed before breaking the circuit and pausing further fetch\n   * attempts.\n   * @param args.circuitBreakDuration - The amount of time to wait when the\n   * circuit breaks from too many consecutive failures.\n   * @param args.config - The configuration object, includes client,\n   * distribution, and environment.\n   * @param args.config.client - The client type (e.g., 'extension', 'mobile').\n   * @param args.config.distribution - The distribution type (e.g., 'main',\n   * 'flask').\n   * @param args.config.environment - The environment type (e.g., 'prod', 'rc',\n   * 'dev').\n   */\n  constructor(args: {\n    fetch: typeof fetch;\n    retries?: number;\n    maximumConsecutiveFailures?: number;\n    circuitBreakDuration?: number;\n    config: {\n      client: ClientType;\n      distribution: DistributionType;\n      environment: EnvironmentType;\n    };\n  });\n\n  /**\n   * Constructs a new ClientConfigApiService object.\n   *\n   * @deprecated This signature is deprecated; please use the `onBreak` and\n   * `onDegraded` methods instead.\n   * @param args - The arguments.\n   * @param args.fetch - A function that can be used to make an HTTP request.\n   * If your JavaScript environment supports `fetch` natively, you'll probably\n   * want to pass that; otherwise you can pass an equivalent (such as `fetch`\n   * via `node-fetch`).\n   * @param args.retries - Number of retry attempts for each fetch request.\n   * @param args.maximumConsecutiveFailures - The maximum number of consecutive\n   * failures allowed before breaking the circuit and pausing further fetch\n   * attempts.\n   * @param args.circuitBreakDuration - The amount of time to wait when the\n   * circuit breaks from too many consecutive failures.\n   * @param args.onBreak - Callback for when the circuit breaks, useful\n   * for capturing metrics about network failures.\n   * @param args.onDegraded - Callback for when the API responds successfully\n   * but takes too long to respond (5 seconds or more).\n   * @param args.config - The configuration object, includes client,\n   * distribution, and environment.\n   * @param args.config.client - The client type (e.g., 'extension', 'mobile').\n   * @param args.config.distribution - The distribution type (e.g., 'main',\n   * 'flask').\n   * @param args.config.environment - The environment type (e.g., 'prod', 'rc',\n   * 'dev').\n   */\n  // eslint-disable-next-line @typescript-eslint/unified-signatures\n  constructor(args: {\n    fetch: typeof fetch;\n    retries?: number;\n    maximumConsecutiveFailures?: number;\n    circuitBreakDuration?: number;\n    onBreak?: () => void;\n    onDegraded?: () => void;\n    config: {\n      client: ClientType;\n      distribution: DistributionType;\n      environment: EnvironmentType;\n    };\n  });\n\n  constructor({\n    fetch: fetchFunction,\n    retries = DEFAULT_MAX_RETRIES,\n    maximumConsecutiveFailures = DEFAULT_MAX_CONSECUTIVE_FAILURES,\n    circuitBreakDuration = DEFAULT_CIRCUIT_BREAK_DURATION,\n    onBreak,\n    onDegraded,\n    config,\n  }: {\n    fetch: typeof fetch;\n    retries?: number;\n    maximumConsecutiveFailures?: number;\n    circuitBreakDuration?: number;\n    onBreak?: () => void;\n    onDegraded?: () => void;\n    config: {\n      client: ClientType;\n      distribution: DistributionType;\n      environment: EnvironmentType;\n    };\n  }) {\n    this.#fetch = fetchFunction;\n    this.#client = config.client;\n    this.#distribution = config.distribution;\n    this.#environment = config.environment;\n\n    this.#policy = createServicePolicy({\n      maxRetries: retries,\n      maxConsecutiveFailures: maximumConsecutiveFailures,\n      circuitBreakDuration,\n    });\n    if (onBreak) {\n      this.#policy.onBreak(onBreak);\n    }\n    if (onDegraded) {\n      this.#policy.onDegraded(onDegraded);\n    }\n  }\n\n  /**\n   * Listens for when the request to the API fails too many times in a row.\n   *\n   * @param args - The same arguments that {@link ServicePolicy.onBreak}\n   * takes.\n   * @returns What {@link ServicePolicy.onBreak} returns.\n   */\n  onBreak(...args: Parameters<ServicePolicy['onBreak']>): IDisposable {\n    return this.#policy.onBreak(...args);\n  }\n\n  /**\n   * Listens for when the API is degraded.\n   *\n   * @param args - The same arguments that {@link ServicePolicy.onDegraded}\n   * takes.\n   * @returns What {@link ServicePolicy.onDegraded} returns.\n   */\n  onDegraded(...args: Parameters<ServicePolicy['onDegraded']>): IDisposable {\n    return this.#policy.onDegraded(...args);\n  }\n\n  /**\n   * Fetches feature flags from the API with specific client, distribution, and environment parameters.\n   * Provides structured error handling, including fallback to cached data if available.\n   *\n   * @returns An object of feature flags and their boolean values or a structured error object.\n   */\n  public async fetchRemoteFeatureFlags(): Promise<ServiceResponse> {\n    const url = `${BASE_URL}/flags?client=${this.#client}&distribution=${\n      this.#distribution\n    }&environment=${this.#environment}`;\n\n    const response = await this.#policy.execute(() =>\n      this.#fetch(url, { cache: 'no-cache' }),\n    );\n\n    if (!response.ok) {\n      throw new Error('Failed to fetch remote feature flags');\n    }\n\n    const data = await response.json();\n\n    if (!Array.isArray(data)) {\n      throw new Error('Feature flags api did not return an array');\n    }\n\n    const remoteFeatureFlags = this.#flattenFeatureFlags(data);\n\n    return {\n      remoteFeatureFlags,\n      cacheTimestamp: Date.now(),\n    };\n  }\n\n  /**\n   * Flattens an array of feature flag objects into a single feature flags object.\n   *\n   * @param responseData - Array of objects containing feature flag key-value pairs\n   * @returns A single object containing all feature flags merged together\n   * @example\n   * // Input: [{ flag1: true }, { flag2: [] }]\n   * // Output: { flag1: true, flag2: [] }\n   */\n  #flattenFeatureFlags(responseData: ApiDataResponse): FeatureFlags {\n    return responseData.reduce((acc, curr) => {\n      return { ...acc, ...curr };\n    }, {});\n  }\n}\n"]}

package/dist/remote-feature-flag-controller.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"remote-feature-flag-controller.cjs","sourceRoot":"","sources":["../src/remote-feature-flag-controller.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,+DAA2D;AAM3D,2CAAuD;AASvD,iFAGyC;AACzC,iDAAuE;AAEvE,kBAAkB;AAElB,MAAM,cAAc,GAAG,6BAA6B,CAAC;AACxC,QAAA,sBAAsB,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,QAAQ;AASnE,MAAM,mCAAmC,GAAG;IAC1C,kBAAkB,EAAE;QAClB,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,IAAI;QAC5B,QAAQ,EAAE,IAAI;KACf;IACD,cAAc,EAAE;QACd,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,IAAI;QAC5B,QAAQ,EAAE,KAAK;KAChB;CACF,CAAC;AAqCF;;;;GAIG;AACH,SAAgB,0CAA0C;IACxD,OAAO;QACL,kBAAkB,EAAE,EAAE;QACtB,cAAc,EAAE,CAAC;KAClB,CAAC;AACJ,CAAC;AALD,gGAKC;AAED;;;;;GAKG;AACH,MAAa,2BAA4B,SAAQ,gCAIhD;IAaC;;;;;;;;;;;OAWG;IACH,YAAY,EACV,SAAS,EACT,KAAK,EACL,sBAAsB,EACtB,aAAa,GAAG,8BAAsB,EACtC,QAAQ,GAAG,KAAK,EAChB,gBAAgB,EAChB,aAAa,GASd;QACC,IAAI,CAAC,IAAA,4BAAoB,EAAC,aAAa,CAAC,EAAE,CAAC;YACzC,MAAM,IAAI,KAAK,CACb,2BAA2B,aAAa,iDAAiD,CAC1F,CAAC;QACJ,CAAC;QAED,KAAK,CAAC;YACJ,IAAI,EAAE,cAAc;YACpB,QAAQ,EAAE,mCAAmC;YAC7C,SAAS;YACT,KAAK,EAAE;gBACL,GAAG,0CAA0C,EAAE;gBAC/C,GAAG,KAAK;aACT;SACF,CAAC,CAAC;;QAvDI,6DAAuB;QAEhC,wDAAmB;QAEV,sEAAwD;QAEjE,oEAAiD;QAExC,gEAAgC;QAEhC,6DAA8B;QA+CrC,uBAAA,IAAI,8CAAkB,aAAa,MAAA,CAAC;QACpC,uBAAA,IAAI,yCAAa,QAAQ,MAAA,CAAC;QAC1B,uBAAA,IAAI,uDAA2B,sBAAsB,MAAA,CAAC;QACtD,uBAAA,IAAI,iDAAqB,gBAAgB,MAAA,CAAC;QAC1C,uBAAA,IAAI,8CAAkB,aAAa,MAAA,CAAC;IACtC,CAAC;IAWD;;;;;OAKG;IACH,KAAK,CAAC,wBAAwB;QAC5B,IAAI,uBAAA,IAAI,6CAAU,IAAI,CAAC,uBAAA,IAAI,2FAAgB,MAApB,IAAI,CAAkB,EAAE,CAAC;YAC9C,OAAO;QACT,CAAC;QAED,IAAI,UAAU,CAAC;QAEf,IAAI,uBAAA,IAAI,yDAAsB,EAAE,CAAC;YAC/B,MAAM,uBAAA,IAAI,yDAAsB,CAAC;YACjC,OAAO;QACT,CAAC;QAED,IAAI,CAAC;YACH,uBAAA,IAAI,qDACF,uBAAA,IAAI,2DAAwB,CAAC,uBAAuB,EAAE,MAAA,CAAC;YAEzD,UAAU,GAAG,MAAM,uBAAA,IAAI,yDAAsB,CAAC;QAChD,CAAC;gBAAS,CAAC;YACT,uBAAA,IAAI,qDAAyB,SAAS,MAAA,CAAC;QACzC,CAAC;QAED,MAAM,uBAAA,IAAI,wFAAa,MAAjB,IAAI,EAAc,UAAU,CAAC,kBAAkB,CAAC,CAAC;IACzD,CAAC;IAyED;;OAEG;IACH,MAAM;QACJ,uBAAA,IAAI,yCAAa,KAAK,MAAA,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,OAAO;QACL,uBAAA,IAAI,yCAAa,IAAI,MAAA,CAAC;IACxB,CAAC;CACF;AAhMD,kEAgMC;;IArHG,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,GAAG,uBAAA,IAAI,kDAAe,CAAC;AACtE,CAAC;AAgCD;;;;GAIG;AACH,KAAK,mDAAc,kBAAgC;IACjD,MAAM,2BAA2B,GAC/B,MAAM,uBAAA,IAAI,sGAA2B,MAA/B,IAAI,EAA4B,kBAAkB,CAAC,CAAC;IAC5D,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE;QACf,OAAO;YACL,kBAAkB,EAAE,2BAA2B;YAC/C,cAAc,EAAE,IAAI,CAAC,GAAG,EAAE;SAC3B,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,uHAQwB,SAAe;IACtC,IAAI,CAAC,IAAA,8BAAoB,EAAC,SAAS,CAAC,EAAE,CAAC;QACrC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,IAAA,wBAAc,EAAC,SAAS,EAAE,uBAAA,IAAI,kDAAe,CAAC,CAAC;AACxD,CAAC,2DAED,KAAK,iEACH,kBAAgC;IAEhC,MAAM,2BAA2B,GAAiB,EAAE,CAAC;IACrD,MAAM,aAAa,GAAG,uBAAA,IAAI,qDAAkB,MAAtB,IAAI,CAAoB,CAAC;IAC/C,MAAM,cAAc,GAAG,IAAA,2DAAiC,EAAC,aAAa,CAAC,CAAC;IAExE,KAAK,MAAM,CACT,qBAAqB,EACrB,sBAAsB,EACvB,IAAI,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE,CAAC;QACxC,IAAI,cAAc,GAAG,uBAAA,IAAI,oGAAyB,MAA7B,IAAI,EACvB,sBAAsB,CACvB,CAAC;QACF,IAAI,cAAc,KAAK,IAAI,EAAE,CAAC;YAC5B,SAAS;QACX,CAAC;QAED,IAAI,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,cAAc,EAAE,CAAC;YACpD,MAAM,aAAa,GAAG,cAAc,CAAC,IAAI,CACvC,CAAC,WAAW,EAAwC,EAAE;gBACpD,IAAI,CAAC,IAAA,qDAA2B,EAAC,WAAW,CAAC,EAAE,CAAC;oBAC9C,OAAO,KAAK,CAAC;gBACf,CAAC;gBAED,OAAO,cAAc,IAAI,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC;YACnD,CAAC,CACF,CAAC;YACF,IAAI,aAAa,EAAE,CAAC;gBAClB,cAAc,GAAG;oBACf,IAAI,EAAE,aAAa,CAAC,IAAI;oBACxB,KAAK,EAAE,aAAa,CAAC,KAAK;iBAC3B,CAAC;YACJ,CAAC;QACH,CAAC;QAED,2BAA2B,CAAC,qBAAqB,CAAC,GAAG,cAAc,CAAC;IACtE,CAAC;IACD,OAAO,2BAA2B,CAAC;AACrC,CAAC","sourcesContent":["import { BaseController } from '@metamask/base-controller';\nimport type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n} from '@metamask/base-controller';\nimport type { Messenger } from '@metamask/messenger';\nimport { isValidSemVerVersion } from '@metamask/utils';\nimport type { Json, SemVerVersion } from '@metamask/utils';\n\nimport type { AbstractClientConfigApiService } from './client-config-api-service/abstract-client-config-api-service';\nimport type {\n  FeatureFlags,\n  ServiceResponse,\n  FeatureFlagScopeValue,\n} from './remote-feature-flag-controller-types';\nimport {\n  generateDeterministicRandomNumber,\n  isFeatureFlagWithScopeValue,\n} from './utils/user-segmentation-utils';\nimport { isVersionFeatureFlag, getVersionData } from './utils/version';\n\n// === GENERAL ===\n\nconst controllerName = 'RemoteFeatureFlagController';\nexport const DEFAULT_CACHE_DURATION = 24 * 60 * 60 * 1000; // 1 day\n\n// === STATE ===\n\nexport type RemoteFeatureFlagControllerState = {\n  remoteFeatureFlags: FeatureFlags;\n  cacheTimestamp: number;\n};\n\nconst remoteFeatureFlagControllerMetadata = {\n  remoteFeatureFlags: {\n    includeInStateLogs: true,\n    persist: true,\n    includeInDebugSnapshot: true,\n    usedInUi: true,\n  },\n  cacheTimestamp: {\n    includeInStateLogs: true,\n    persist: true,\n    includeInDebugSnapshot: true,\n    usedInUi: false,\n  },\n};\n\n// === MESSENGER ===\n\n/**\n * The action to retrieve the state of the {@link RemoteFeatureFlagController}.\n */\nexport type RemoteFeatureFlagControllerGetStateAction =\n  ControllerGetStateAction<\n    typeof controllerName,\n    RemoteFeatureFlagControllerState\n  >;\n\nexport type RemoteFeatureFlagControllerUpdateRemoteFeatureFlagsAction = {\n  type: `${typeof controllerName}:updateRemoteFeatureFlags`;\n  handler: RemoteFeatureFlagController['updateRemoteFeatureFlags'];\n};\n\nexport type RemoteFeatureFlagControllerActions =\n  | RemoteFeatureFlagControllerGetStateAction\n  | RemoteFeatureFlagControllerUpdateRemoteFeatureFlagsAction;\n\nexport type RemoteFeatureFlagControllerStateChangeEvent =\n  ControllerStateChangeEvent<\n    typeof controllerName,\n    RemoteFeatureFlagControllerState\n  >;\n\nexport type RemoteFeatureFlagControllerEvents =\n  RemoteFeatureFlagControllerStateChangeEvent;\n\nexport type RemoteFeatureFlagControllerMessenger = Messenger<\n  typeof controllerName,\n  RemoteFeatureFlagControllerActions,\n  RemoteFeatureFlagControllerEvents\n>;\n\n/**\n * Returns the default state for the RemoteFeatureFlagController.\n *\n * @returns The default controller state.\n */\nexport function getDefaultRemoteFeatureFlagControllerState(): RemoteFeatureFlagControllerState {\n  return {\n    remoteFeatureFlags: {},\n    cacheTimestamp: 0,\n  };\n}\n\n/**\n * The RemoteFeatureFlagController manages the retrieval and caching of remote feature flags.\n * It fetches feature flags from a remote API, caches them, and provides methods to access\n * and manage these flags. The controller ensures that feature flags are refreshed based on\n * a specified interval and handles cases where the controller is disabled or the network is unavailable.\n */\nexport class RemoteFeatureFlagController extends BaseController<\n  typeof controllerName,\n  RemoteFeatureFlagControllerState,\n  RemoteFeatureFlagControllerMessenger\n> {\n  readonly #fetchInterval: number;\n\n  #disabled: boolean;\n\n  readonly #clientConfigApiService: AbstractClientConfigApiService;\n\n  #inProgressFlagUpdate?: Promise<ServiceResponse>;\n\n  readonly #getMetaMetricsId: () => string;\n\n  readonly #clientVersion: SemVerVersion;\n\n  /**\n   * Constructs a new RemoteFeatureFlagController instance.\n   *\n   * @param options - The controller options.\n   * @param options.messenger - The messenger used for communication.\n   * @param options.state - The initial state of the controller.\n   * @param options.clientConfigApiService - The service instance to fetch remote feature flags.\n   * @param options.fetchInterval - The interval in milliseconds before cached flags expire. Defaults to 1 day.\n   * @param options.disabled - Determines if the controller should be disabled initially. Defaults to false.\n   * @param options.getMetaMetricsId - Returns metaMetricsId.\n   * @param options.clientVersion - The current client version for version-based feature flag filtering. Must be a valid 3-part SemVer version string.\n   */\n  constructor({\n    messenger,\n    state,\n    clientConfigApiService,\n    fetchInterval = DEFAULT_CACHE_DURATION,\n    disabled = false,\n    getMetaMetricsId,\n    clientVersion,\n  }: {\n    messenger: RemoteFeatureFlagControllerMessenger;\n    state?: Partial<RemoteFeatureFlagControllerState>;\n    clientConfigApiService: AbstractClientConfigApiService;\n    getMetaMetricsId: () => string;\n    fetchInterval?: number;\n    disabled?: boolean;\n    clientVersion: string;\n  }) {\n    if (!isValidSemVerVersion(clientVersion)) {\n      throw new Error(\n        `Invalid clientVersion: \"${clientVersion}\". Must be a valid 3-part SemVer version string`,\n      );\n    }\n\n    super({\n      name: controllerName,\n      metadata: remoteFeatureFlagControllerMetadata,\n      messenger,\n      state: {\n        ...getDefaultRemoteFeatureFlagControllerState(),\n        ...state,\n      },\n    });\n\n    this.#fetchInterval = fetchInterval;\n    this.#disabled = disabled;\n    this.#clientConfigApiService = clientConfigApiService;\n    this.#getMetaMetricsId = getMetaMetricsId;\n    this.#clientVersion = clientVersion;\n  }\n\n  /**\n   * Checks if the cached feature flags are expired based on the fetch interval.\n   *\n   * @returns Whether the cache is expired (`true`) or still valid (`false`).\n   */\n  #isCacheExpired(): boolean {\n    return Date.now() - this.state.cacheTimestamp > this.#fetchInterval;\n  }\n\n  /**\n   * Retrieves the remote feature flags, fetching from the API if necessary.\n   * Uses caching to prevent redundant API calls and handles concurrent fetches.\n   *\n   * @returns A promise that resolves to the current set of feature flags.\n   */\n  async updateRemoteFeatureFlags(): Promise<void> {\n    if (this.#disabled || !this.#isCacheExpired()) {\n      return;\n    }\n\n    let serverData;\n\n    if (this.#inProgressFlagUpdate) {\n      await this.#inProgressFlagUpdate;\n      return;\n    }\n\n    try {\n      this.#inProgressFlagUpdate =\n        this.#clientConfigApiService.fetchRemoteFeatureFlags();\n\n      serverData = await this.#inProgressFlagUpdate;\n    } finally {\n      this.#inProgressFlagUpdate = undefined;\n    }\n\n    await this.#updateCache(serverData.remoteFeatureFlags);\n  }\n\n  /**\n   * Updates the controller's state with new feature flags and resets the cache timestamp.\n   *\n   * @param remoteFeatureFlags - The new feature flags to cache.\n   */\n  async #updateCache(remoteFeatureFlags: FeatureFlags) {\n    const processedRemoteFeatureFlags =\n      await this.#processRemoteFeatureFlags(remoteFeatureFlags);\n    this.update(() => {\n      return {\n        remoteFeatureFlags: processedRemoteFeatureFlags,\n        cacheTimestamp: Date.now(),\n      };\n    });\n  }\n\n  /**\n   * Processes a version-based feature flag to get the appropriate value for the current client version.\n   *\n   * @param flagValue - The feature flag value to process\n   * @returns The processed value, or null if no version qualifies (skip this flag)\n   */\n  #processVersionBasedFlag(flagValue: Json): Json | null {\n    if (!isVersionFeatureFlag(flagValue)) {\n      return flagValue;\n    }\n\n    return getVersionData(flagValue, this.#clientVersion);\n  }\n\n  async #processRemoteFeatureFlags(\n    remoteFeatureFlags: FeatureFlags,\n  ): Promise<FeatureFlags> {\n    const processedRemoteFeatureFlags: FeatureFlags = {};\n    const metaMetricsId = this.#getMetaMetricsId();\n    const thresholdValue = generateDeterministicRandomNumber(metaMetricsId);\n\n    for (const [\n      remoteFeatureFlagName,\n      remoteFeatureFlagValue,\n    ] of Object.entries(remoteFeatureFlags)) {\n      let processedValue = this.#processVersionBasedFlag(\n        remoteFeatureFlagValue,\n      );\n      if (processedValue === null) {\n        continue;\n      }\n\n      if (Array.isArray(processedValue) && thresholdValue) {\n        const selectedGroup = processedValue.find(\n          (featureFlag): featureFlag is FeatureFlagScopeValue => {\n            if (!isFeatureFlagWithScopeValue(featureFlag)) {\n              return false;\n            }\n\n            return thresholdValue <= featureFlag.scope.value;\n          },\n        );\n        if (selectedGroup) {\n          processedValue = {\n            name: selectedGroup.name,\n            value: selectedGroup.value,\n          };\n        }\n      }\n\n      processedRemoteFeatureFlags[remoteFeatureFlagName] = processedValue;\n    }\n    return processedRemoteFeatureFlags;\n  }\n\n  /**\n   * Enables the controller, allowing it to make network requests.\n   */\n  enable(): void {\n    this.#disabled = false;\n  }\n\n  /**\n   * Disables the controller, preventing it from making network requests.\n   */\n  disable(): void {\n    this.#disabled = true;\n  }\n}\n"]}
+{"version":3,"file":"remote-feature-flag-controller.cjs","sourceRoot":"","sources":["../src/remote-feature-flag-controller.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,+DAA2D;AAM3D,2CAAuD;AASvD,iFAGyC;AACzC,iDAAuE;AAEvE,kBAAkB;AAElB,MAAM,cAAc,GAAG,6BAA6B,CAAC;AACxC,QAAA,sBAAsB,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,QAAQ;AASnE,MAAM,mCAAmC,GAAG;IAC1C,kBAAkB,EAAE;QAClB,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,IAAI;QAC5B,QAAQ,EAAE,IAAI;KACf;IACD,cAAc,EAAE;QACd,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,IAAI;QAC5B,QAAQ,EAAE,KAAK;KAChB;CACF,CAAC;AAqCF;;;;GAIG;AACH,SAAgB,0CAA0C;IACxD,OAAO;QACL,kBAAkB,EAAE,EAAE;QACtB,cAAc,EAAE,CAAC;KAClB,CAAC;AACJ,CAAC;AALD,gGAKC;AAED;;;;;GAKG;AACH,MAAa,2BAA4B,SAAQ,gCAIhD;IAaC;;;;;;;;;;;OAWG;IACH,YAAY,EACV,SAAS,EACT,KAAK,EACL,sBAAsB,EACtB,aAAa,GAAG,8BAAsB,EACtC,QAAQ,GAAG,KAAK,EAChB,gBAAgB,EAChB,aAAa,GASd;QACC,IAAI,CAAC,IAAA,4BAAoB,EAAC,aAAa,CAAC,EAAE,CAAC;YACzC,MAAM,IAAI,KAAK,CACb,2BAA2B,aAAa,iDAAiD,CAC1F,CAAC;QACJ,CAAC;QAED,KAAK,CAAC;YACJ,IAAI,EAAE,cAAc;YACpB,QAAQ,EAAE,mCAAmC;YAC7C,SAAS;YACT,KAAK,EAAE;gBACL,GAAG,0CAA0C,EAAE;gBAC/C,GAAG,KAAK;aACT;SACF,CAAC,CAAC;;QAvDI,6DAAuB;QAEhC,wDAAmB;QAEV,sEAAwD;QAEjE,oEAAiD;QAExC,gEAAgC;QAEhC,6DAA8B;QA+CrC,uBAAA,IAAI,8CAAkB,aAAa,MAAA,CAAC;QACpC,uBAAA,IAAI,yCAAa,QAAQ,MAAA,CAAC;QAC1B,uBAAA,IAAI,uDAA2B,sBAAsB,MAAA,CAAC;QACtD,uBAAA,IAAI,iDAAqB,gBAAgB,MAAA,CAAC;QAC1C,uBAAA,IAAI,8CAAkB,aAAa,MAAA,CAAC;IACtC,CAAC;IAWD;;;;;OAKG;IACH,KAAK,CAAC,wBAAwB;QAC5B,IAAI,uBAAA,IAAI,6CAAU,IAAI,CAAC,uBAAA,IAAI,2FAAgB,MAApB,IAAI,CAAkB,EAAE,CAAC;YAC9C,OAAO;QACT,CAAC;QAED,IAAI,UAAU,CAAC;QAEf,IAAI,uBAAA,IAAI,yDAAsB,EAAE,CAAC;YAC/B,MAAM,uBAAA,IAAI,yDAAsB,CAAC;YACjC,OAAO;QACT,CAAC;QAED,IAAI,CAAC;YACH,uBAAA,IAAI,qDACF,uBAAA,IAAI,2DAAwB,CAAC,uBAAuB,EAAE,MAAA,CAAC;YAEzD,UAAU,GAAG,MAAM,uBAAA,IAAI,yDAAsB,CAAC;QAChD,CAAC;gBAAS,CAAC;YACT,uBAAA,IAAI,qDAAyB,SAAS,MAAA,CAAC;QACzC,CAAC;QAED,MAAM,uBAAA,IAAI,wFAAa,MAAjB,IAAI,EAAc,UAAU,CAAC,kBAAkB,CAAC,CAAC;IACzD,CAAC;IAyED;;OAEG;IACH,MAAM;QACJ,uBAAA,IAAI,yCAAa,KAAK,MAAA,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,OAAO;QACL,uBAAA,IAAI,yCAAa,IAAI,MAAA,CAAC;IACxB,CAAC;CACF;AAhMD,kEAgMC;;IArHG,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,GAAG,uBAAA,IAAI,kDAAe,CAAC;AACtE,CAAC;AAgCD;;;;GAIG;AACH,KAAK,mDAAc,kBAAgC;IACjD,MAAM,2BAA2B,GAC/B,MAAM,uBAAA,IAAI,sGAA2B,MAA/B,IAAI,EAA4B,kBAAkB,CAAC,CAAC;IAC5D,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE;QACf,OAAO;YACL,kBAAkB,EAAE,2BAA2B;YAC/C,cAAc,EAAE,IAAI,CAAC,GAAG,EAAE;SAC3B,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,uHAQwB,SAAe;IACtC,IAAI,CAAC,IAAA,8BAAoB,EAAC,SAAS,CAAC,EAAE,CAAC;QACrC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,IAAA,wBAAc,EAAC,SAAS,EAAE,uBAAA,IAAI,kDAAe,CAAC,CAAC;AACxD,CAAC,2DAED,KAAK,iEACH,kBAAgC;IAEhC,MAAM,2BAA2B,GAAiB,EAAE,CAAC;IACrD,MAAM,aAAa,GAAG,uBAAA,IAAI,qDAAkB,MAAtB,IAAI,CAAoB,CAAC;IAC/C,MAAM,cAAc,GAAG,IAAA,2DAAiC,EAAC,aAAa,CAAC,CAAC;IAExE,KAAK,MAAM,CACT,qBAAqB,EACrB,sBAAsB,EACvB,IAAI,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE,CAAC;QACxC,IAAI,cAAc,GAAG,uBAAA,IAAI,oGAAyB,MAA7B,IAAI,EACvB,sBAAsB,CACvB,CAAC;QACF,IAAI,cAAc,KAAK,IAAI,EAAE,CAAC;YAC5B,SAAS;QACX,CAAC;QAED,IAAI,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,cAAc,EAAE,CAAC;YACpD,MAAM,aAAa,GAAG,cAAc,CAAC,IAAI,CACvC,CAAC,WAAW,EAAwC,EAAE;gBACpD,IAAI,CAAC,IAAA,qDAA2B,EAAC,WAAW,CAAC,EAAE,CAAC;oBAC9C,OAAO,KAAK,CAAC;gBACf,CAAC;gBAED,OAAO,cAAc,IAAI,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC;YACnD,CAAC,CACF,CAAC;YACF,IAAI,aAAa,EAAE,CAAC;gBAClB,cAAc,GAAG;oBACf,IAAI,EAAE,aAAa,CAAC,IAAI;oBACxB,KAAK,EAAE,aAAa,CAAC,KAAK;iBAC3B,CAAC;YACJ,CAAC;QACH,CAAC;QAED,2BAA2B,CAAC,qBAAqB,CAAC,GAAG,cAAc,CAAC;IACtE,CAAC;IACD,OAAO,2BAA2B,CAAC;AACrC,CAAC","sourcesContent":["import { BaseController } from '@metamask/base-controller';\nimport type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n} from '@metamask/base-controller';\nimport type { Messenger } from '@metamask/messenger';\nimport { isValidSemVerVersion } from '@metamask/utils';\nimport type { Json, SemVerVersion } from '@metamask/utils';\n\nimport type { AbstractClientConfigApiService } from './client-config-api-service/abstract-client-config-api-service';\nimport type {\n  FeatureFlags,\n  ServiceResponse,\n  FeatureFlagScopeValue,\n} from './remote-feature-flag-controller-types';\nimport {\n  generateDeterministicRandomNumber,\n  isFeatureFlagWithScopeValue,\n} from './utils/user-segmentation-utils';\nimport { isVersionFeatureFlag, getVersionData } from './utils/version';\n\n// === GENERAL ===\n\nconst controllerName = 'RemoteFeatureFlagController';\nexport const DEFAULT_CACHE_DURATION = 24 * 60 * 60 * 1000; // 1 day\n\n// === STATE ===\n\nexport type RemoteFeatureFlagControllerState = {\n  remoteFeatureFlags: FeatureFlags;\n  cacheTimestamp: number;\n};\n\nconst remoteFeatureFlagControllerMetadata = {\n  remoteFeatureFlags: {\n    includeInStateLogs: true,\n    persist: true,\n    includeInDebugSnapshot: true,\n    usedInUi: true,\n  },\n  cacheTimestamp: {\n    includeInStateLogs: true,\n    persist: true,\n    includeInDebugSnapshot: true,\n    usedInUi: false,\n  },\n};\n\n// === MESSENGER ===\n\n/**\n * The action to retrieve the state of the {@link RemoteFeatureFlagController}.\n */\nexport type RemoteFeatureFlagControllerGetStateAction =\n  ControllerGetStateAction<\n    typeof controllerName,\n    RemoteFeatureFlagControllerState\n  >;\n\nexport type RemoteFeatureFlagControllerUpdateRemoteFeatureFlagsAction = {\n  type: `${typeof controllerName}:updateRemoteFeatureFlags`;\n  handler: RemoteFeatureFlagController['updateRemoteFeatureFlags'];\n};\n\nexport type RemoteFeatureFlagControllerActions =\n  | RemoteFeatureFlagControllerGetStateAction\n  | RemoteFeatureFlagControllerUpdateRemoteFeatureFlagsAction;\n\nexport type RemoteFeatureFlagControllerStateChangeEvent =\n  ControllerStateChangeEvent<\n    typeof controllerName,\n    RemoteFeatureFlagControllerState\n  >;\n\nexport type RemoteFeatureFlagControllerEvents =\n  RemoteFeatureFlagControllerStateChangeEvent;\n\nexport type RemoteFeatureFlagControllerMessenger = Messenger<\n  typeof controllerName,\n  RemoteFeatureFlagControllerActions,\n  RemoteFeatureFlagControllerEvents\n>;\n\n/**\n * Returns the default state for the RemoteFeatureFlagController.\n *\n * @returns The default controller state.\n */\nexport function getDefaultRemoteFeatureFlagControllerState(): RemoteFeatureFlagControllerState {\n  return {\n    remoteFeatureFlags: {},\n    cacheTimestamp: 0,\n  };\n}\n\n/**\n * The RemoteFeatureFlagController manages the retrieval and caching of remote feature flags.\n * It fetches feature flags from a remote API, caches them, and provides methods to access\n * and manage these flags. The controller ensures that feature flags are refreshed based on\n * a specified interval and handles cases where the controller is disabled or the network is unavailable.\n */\nexport class RemoteFeatureFlagController extends BaseController<\n  typeof controllerName,\n  RemoteFeatureFlagControllerState,\n  RemoteFeatureFlagControllerMessenger\n> {\n  readonly #fetchInterval: number;\n\n  #disabled: boolean;\n\n  readonly #clientConfigApiService: AbstractClientConfigApiService;\n\n  #inProgressFlagUpdate?: Promise<ServiceResponse>;\n\n  readonly #getMetaMetricsId: () => string;\n\n  readonly #clientVersion: SemVerVersion;\n\n  /**\n   * Constructs a new RemoteFeatureFlagController instance.\n   *\n   * @param options - The controller options.\n   * @param options.messenger - The messenger used for communication.\n   * @param options.state - The initial state of the controller.\n   * @param options.clientConfigApiService - The service instance to fetch remote feature flags.\n   * @param options.fetchInterval - The interval in milliseconds before cached flags expire. Defaults to 1 day.\n   * @param options.disabled - Determines if the controller should be disabled initially. Defaults to false.\n   * @param options.getMetaMetricsId - Returns metaMetricsId.\n   * @param options.clientVersion - The current client version for version-based feature flag filtering. Must be a valid 3-part SemVer version string.\n   */\n  constructor({\n    messenger,\n    state,\n    clientConfigApiService,\n    fetchInterval = DEFAULT_CACHE_DURATION,\n    disabled = false,\n    getMetaMetricsId,\n    clientVersion,\n  }: {\n    messenger: RemoteFeatureFlagControllerMessenger;\n    state?: Partial<RemoteFeatureFlagControllerState>;\n    clientConfigApiService: AbstractClientConfigApiService;\n    getMetaMetricsId: () => string;\n    fetchInterval?: number;\n    disabled?: boolean;\n    clientVersion: string;\n  }) {\n    if (!isValidSemVerVersion(clientVersion)) {\n      throw new Error(\n        `Invalid clientVersion: \"${clientVersion}\". Must be a valid 3-part SemVer version string`,\n      );\n    }\n\n    super({\n      name: controllerName,\n      metadata: remoteFeatureFlagControllerMetadata,\n      messenger,\n      state: {\n        ...getDefaultRemoteFeatureFlagControllerState(),\n        ...state,\n      },\n    });\n\n    this.#fetchInterval = fetchInterval;\n    this.#disabled = disabled;\n    this.#clientConfigApiService = clientConfigApiService;\n    this.#getMetaMetricsId = getMetaMetricsId;\n    this.#clientVersion = clientVersion;\n  }\n\n  /**\n   * Checks if the cached feature flags are expired based on the fetch interval.\n   *\n   * @returns Whether the cache is expired (`true`) or still valid (`false`).\n   */\n  #isCacheExpired(): boolean {\n    return Date.now() - this.state.cacheTimestamp > this.#fetchInterval;\n  }\n\n  /**\n   * Retrieves the remote feature flags, fetching from the API if necessary.\n   * Uses caching to prevent redundant API calls and handles concurrent fetches.\n   *\n   * @returns A promise that resolves to the current set of feature flags.\n   */\n  async updateRemoteFeatureFlags(): Promise<void> {\n    if (this.#disabled || !this.#isCacheExpired()) {\n      return;\n    }\n\n    let serverData;\n\n    if (this.#inProgressFlagUpdate) {\n      await this.#inProgressFlagUpdate;\n      return;\n    }\n\n    try {\n      this.#inProgressFlagUpdate =\n        this.#clientConfigApiService.fetchRemoteFeatureFlags();\n\n      serverData = await this.#inProgressFlagUpdate;\n    } finally {\n      this.#inProgressFlagUpdate = undefined;\n    }\n\n    await this.#updateCache(serverData.remoteFeatureFlags);\n  }\n\n  /**\n   * Updates the controller's state with new feature flags and resets the cache timestamp.\n   *\n   * @param remoteFeatureFlags - The new feature flags to cache.\n   */\n  async #updateCache(remoteFeatureFlags: FeatureFlags): Promise<void> {\n    const processedRemoteFeatureFlags =\n      await this.#processRemoteFeatureFlags(remoteFeatureFlags);\n    this.update(() => {\n      return {\n        remoteFeatureFlags: processedRemoteFeatureFlags,\n        cacheTimestamp: Date.now(),\n      };\n    });\n  }\n\n  /**\n   * Processes a version-based feature flag to get the appropriate value for the current client version.\n   *\n   * @param flagValue - The feature flag value to process\n   * @returns The processed value, or null if no version qualifies (skip this flag)\n   */\n  #processVersionBasedFlag(flagValue: Json): Json | null {\n    if (!isVersionFeatureFlag(flagValue)) {\n      return flagValue;\n    }\n\n    return getVersionData(flagValue, this.#clientVersion);\n  }\n\n  async #processRemoteFeatureFlags(\n    remoteFeatureFlags: FeatureFlags,\n  ): Promise<FeatureFlags> {\n    const processedRemoteFeatureFlags: FeatureFlags = {};\n    const metaMetricsId = this.#getMetaMetricsId();\n    const thresholdValue = generateDeterministicRandomNumber(metaMetricsId);\n\n    for (const [\n      remoteFeatureFlagName,\n      remoteFeatureFlagValue,\n    ] of Object.entries(remoteFeatureFlags)) {\n      let processedValue = this.#processVersionBasedFlag(\n        remoteFeatureFlagValue,\n      );\n      if (processedValue === null) {\n        continue;\n      }\n\n      if (Array.isArray(processedValue) && thresholdValue) {\n        const selectedGroup = processedValue.find(\n          (featureFlag): featureFlag is FeatureFlagScopeValue => {\n            if (!isFeatureFlagWithScopeValue(featureFlag)) {\n              return false;\n            }\n\n            return thresholdValue <= featureFlag.scope.value;\n          },\n        );\n        if (selectedGroup) {\n          processedValue = {\n            name: selectedGroup.name,\n            value: selectedGroup.value,\n          };\n        }\n      }\n\n      processedRemoteFeatureFlags[remoteFeatureFlagName] = processedValue;\n    }\n    return processedRemoteFeatureFlags;\n  }\n\n  /**\n   * Enables the controller, allowing it to make network requests.\n   */\n  enable(): void {\n    this.#disabled = false;\n  }\n\n  /**\n   * Disables the controller, preventing it from making network requests.\n   */\n  disable(): void {\n    this.#disabled = true;\n  }\n}\n"]}

package/dist/remote-feature-flag-controller.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"remote-feature-flag-controller.mjs","sourceRoot":"","sources":["../src/remote-feature-flag-controller.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAM3D,OAAO,EAAE,oBAAoB,EAAE,wBAAwB;AASvD,OAAO,EACL,iCAAiC,EACjC,2BAA2B,EAC5B,4CAAwC;AACzC,OAAO,EAAE,oBAAoB,EAAE,cAAc,EAAE,4BAAwB;AAEvE,kBAAkB;AAElB,MAAM,cAAc,GAAG,6BAA6B,CAAC;AACrD,MAAM,CAAC,MAAM,sBAAsB,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,QAAQ;AASnE,MAAM,mCAAmC,GAAG;IAC1C,kBAAkB,EAAE;QAClB,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,IAAI;QAC5B,QAAQ,EAAE,IAAI;KACf;IACD,cAAc,EAAE;QACd,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,IAAI;QAC5B,QAAQ,EAAE,KAAK;KAChB;CACF,CAAC;AAqCF;;;;GAIG;AACH,MAAM,UAAU,0CAA0C;IACxD,OAAO;QACL,kBAAkB,EAAE,EAAE;QACtB,cAAc,EAAE,CAAC;KAClB,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,OAAO,2BAA4B,SAAQ,cAIhD;IAaC;;;;;;;;;;;OAWG;IACH,YAAY,EACV,SAAS,EACT,KAAK,EACL,sBAAsB,EACtB,aAAa,GAAG,sBAAsB,EACtC,QAAQ,GAAG,KAAK,EAChB,gBAAgB,EAChB,aAAa,GASd;QACC,IAAI,CAAC,oBAAoB,CAAC,aAAa,CAAC,EAAE,CAAC;YACzC,MAAM,IAAI,KAAK,CACb,2BAA2B,aAAa,iDAAiD,CAC1F,CAAC;QACJ,CAAC;QAED,KAAK,CAAC;YACJ,IAAI,EAAE,cAAc;YACpB,QAAQ,EAAE,mCAAmC;YAC7C,SAAS;YACT,KAAK,EAAE;gBACL,GAAG,0CAA0C,EAAE;gBAC/C,GAAG,KAAK;aACT;SACF,CAAC,CAAC;;QAvDI,6DAAuB;QAEhC,wDAAmB;QAEV,sEAAwD;QAEjE,oEAAiD;QAExC,gEAAgC;QAEhC,6DAA8B;QA+CrC,uBAAA,IAAI,8CAAkB,aAAa,MAAA,CAAC;QACpC,uBAAA,IAAI,yCAAa,QAAQ,MAAA,CAAC;QAC1B,uBAAA,IAAI,uDAA2B,sBAAsB,MAAA,CAAC;QACtD,uBAAA,IAAI,iDAAqB,gBAAgB,MAAA,CAAC;QAC1C,uBAAA,IAAI,8CAAkB,aAAa,MAAA,CAAC;IACtC,CAAC;IAWD;;;;;OAKG;IACH,KAAK,CAAC,wBAAwB;QAC5B,IAAI,uBAAA,IAAI,6CAAU,IAAI,CAAC,uBAAA,IAAI,2FAAgB,MAApB,IAAI,CAAkB,EAAE,CAAC;YAC9C,OAAO;QACT,CAAC;QAED,IAAI,UAAU,CAAC;QAEf,IAAI,uBAAA,IAAI,yDAAsB,EAAE,CAAC;YAC/B,MAAM,uBAAA,IAAI,yDAAsB,CAAC;YACjC,OAAO;QACT,CAAC;QAED,IAAI,CAAC;YACH,uBAAA,IAAI,qDACF,uBAAA,IAAI,2DAAwB,CAAC,uBAAuB,EAAE,MAAA,CAAC;YAEzD,UAAU,GAAG,MAAM,uBAAA,IAAI,yDAAsB,CAAC;QAChD,CAAC;gBAAS,CAAC;YACT,uBAAA,IAAI,qDAAyB,SAAS,MAAA,CAAC;QACzC,CAAC;QAED,MAAM,uBAAA,IAAI,wFAAa,MAAjB,IAAI,EAAc,UAAU,CAAC,kBAAkB,CAAC,CAAC;IACzD,CAAC;IAyED;;OAEG;IACH,MAAM;QACJ,uBAAA,IAAI,yCAAa,KAAK,MAAA,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,OAAO;QACL,uBAAA,IAAI,yCAAa,IAAI,MAAA,CAAC;IACxB,CAAC;CACF;;IArHG,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,GAAG,uBAAA,IAAI,kDAAe,CAAC;AACtE,CAAC;AAgCD;;;;GAIG;AACH,KAAK,mDAAc,kBAAgC;IACjD,MAAM,2BAA2B,GAC/B,MAAM,uBAAA,IAAI,sGAA2B,MAA/B,IAAI,EAA4B,kBAAkB,CAAC,CAAC;IAC5D,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE;QACf,OAAO;YACL,kBAAkB,EAAE,2BAA2B;YAC/C,cAAc,EAAE,IAAI,CAAC,GAAG,EAAE;SAC3B,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,uHAQwB,SAAe;IACtC,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,EAAE,CAAC;QACrC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,cAAc,CAAC,SAAS,EAAE,uBAAA,IAAI,kDAAe,CAAC,CAAC;AACxD,CAAC,2DAED,KAAK,iEACH,kBAAgC;IAEhC,MAAM,2BAA2B,GAAiB,EAAE,CAAC;IACrD,MAAM,aAAa,GAAG,uBAAA,IAAI,qDAAkB,MAAtB,IAAI,CAAoB,CAAC;IAC/C,MAAM,cAAc,GAAG,iCAAiC,CAAC,aAAa,CAAC,CAAC;IAExE,KAAK,MAAM,CACT,qBAAqB,EACrB,sBAAsB,EACvB,IAAI,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE,CAAC;QACxC,IAAI,cAAc,GAAG,uBAAA,IAAI,oGAAyB,MAA7B,IAAI,EACvB,sBAAsB,CACvB,CAAC;QACF,IAAI,cAAc,KAAK,IAAI,EAAE,CAAC;YAC5B,SAAS;QACX,CAAC;QAED,IAAI,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,cAAc,EAAE,CAAC;YACpD,MAAM,aAAa,GAAG,cAAc,CAAC,IAAI,CACvC,CAAC,WAAW,EAAwC,EAAE;gBACpD,IAAI,CAAC,2BAA2B,CAAC,WAAW,CAAC,EAAE,CAAC;oBAC9C,OAAO,KAAK,CAAC;gBACf,CAAC;gBAED,OAAO,cAAc,IAAI,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC;YACnD,CAAC,CACF,CAAC;YACF,IAAI,aAAa,EAAE,CAAC;gBAClB,cAAc,GAAG;oBACf,IAAI,EAAE,aAAa,CAAC,IAAI;oBACxB,KAAK,EAAE,aAAa,CAAC,KAAK;iBAC3B,CAAC;YACJ,CAAC;QACH,CAAC;QAED,2BAA2B,CAAC,qBAAqB,CAAC,GAAG,cAAc,CAAC;IACtE,CAAC;IACD,OAAO,2BAA2B,CAAC;AACrC,CAAC","sourcesContent":["import { BaseController } from '@metamask/base-controller';\nimport type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n} from '@metamask/base-controller';\nimport type { Messenger } from '@metamask/messenger';\nimport { isValidSemVerVersion } from '@metamask/utils';\nimport type { Json, SemVerVersion } from '@metamask/utils';\n\nimport type { AbstractClientConfigApiService } from './client-config-api-service/abstract-client-config-api-service';\nimport type {\n  FeatureFlags,\n  ServiceResponse,\n  FeatureFlagScopeValue,\n} from './remote-feature-flag-controller-types';\nimport {\n  generateDeterministicRandomNumber,\n  isFeatureFlagWithScopeValue,\n} from './utils/user-segmentation-utils';\nimport { isVersionFeatureFlag, getVersionData } from './utils/version';\n\n// === GENERAL ===\n\nconst controllerName = 'RemoteFeatureFlagController';\nexport const DEFAULT_CACHE_DURATION = 24 * 60 * 60 * 1000; // 1 day\n\n// === STATE ===\n\nexport type RemoteFeatureFlagControllerState = {\n  remoteFeatureFlags: FeatureFlags;\n  cacheTimestamp: number;\n};\n\nconst remoteFeatureFlagControllerMetadata = {\n  remoteFeatureFlags: {\n    includeInStateLogs: true,\n    persist: true,\n    includeInDebugSnapshot: true,\n    usedInUi: true,\n  },\n  cacheTimestamp: {\n    includeInStateLogs: true,\n    persist: true,\n    includeInDebugSnapshot: true,\n    usedInUi: false,\n  },\n};\n\n// === MESSENGER ===\n\n/**\n * The action to retrieve the state of the {@link RemoteFeatureFlagController}.\n */\nexport type RemoteFeatureFlagControllerGetStateAction =\n  ControllerGetStateAction<\n    typeof controllerName,\n    RemoteFeatureFlagControllerState\n  >;\n\nexport type RemoteFeatureFlagControllerUpdateRemoteFeatureFlagsAction = {\n  type: `${typeof controllerName}:updateRemoteFeatureFlags`;\n  handler: RemoteFeatureFlagController['updateRemoteFeatureFlags'];\n};\n\nexport type RemoteFeatureFlagControllerActions =\n  | RemoteFeatureFlagControllerGetStateAction\n  | RemoteFeatureFlagControllerUpdateRemoteFeatureFlagsAction;\n\nexport type RemoteFeatureFlagControllerStateChangeEvent =\n  ControllerStateChangeEvent<\n    typeof controllerName,\n    RemoteFeatureFlagControllerState\n  >;\n\nexport type RemoteFeatureFlagControllerEvents =\n  RemoteFeatureFlagControllerStateChangeEvent;\n\nexport type RemoteFeatureFlagControllerMessenger = Messenger<\n  typeof controllerName,\n  RemoteFeatureFlagControllerActions,\n  RemoteFeatureFlagControllerEvents\n>;\n\n/**\n * Returns the default state for the RemoteFeatureFlagController.\n *\n * @returns The default controller state.\n */\nexport function getDefaultRemoteFeatureFlagControllerState(): RemoteFeatureFlagControllerState {\n  return {\n    remoteFeatureFlags: {},\n    cacheTimestamp: 0,\n  };\n}\n\n/**\n * The RemoteFeatureFlagController manages the retrieval and caching of remote feature flags.\n * It fetches feature flags from a remote API, caches them, and provides methods to access\n * and manage these flags. The controller ensures that feature flags are refreshed based on\n * a specified interval and handles cases where the controller is disabled or the network is unavailable.\n */\nexport class RemoteFeatureFlagController extends BaseController<\n  typeof controllerName,\n  RemoteFeatureFlagControllerState,\n  RemoteFeatureFlagControllerMessenger\n> {\n  readonly #fetchInterval: number;\n\n  #disabled: boolean;\n\n  readonly #clientConfigApiService: AbstractClientConfigApiService;\n\n  #inProgressFlagUpdate?: Promise<ServiceResponse>;\n\n  readonly #getMetaMetricsId: () => string;\n\n  readonly #clientVersion: SemVerVersion;\n\n  /**\n   * Constructs a new RemoteFeatureFlagController instance.\n   *\n   * @param options - The controller options.\n   * @param options.messenger - The messenger used for communication.\n   * @param options.state - The initial state of the controller.\n   * @param options.clientConfigApiService - The service instance to fetch remote feature flags.\n   * @param options.fetchInterval - The interval in milliseconds before cached flags expire. Defaults to 1 day.\n   * @param options.disabled - Determines if the controller should be disabled initially. Defaults to false.\n   * @param options.getMetaMetricsId - Returns metaMetricsId.\n   * @param options.clientVersion - The current client version for version-based feature flag filtering. Must be a valid 3-part SemVer version string.\n   */\n  constructor({\n    messenger,\n    state,\n    clientConfigApiService,\n    fetchInterval = DEFAULT_CACHE_DURATION,\n    disabled = false,\n    getMetaMetricsId,\n    clientVersion,\n  }: {\n    messenger: RemoteFeatureFlagControllerMessenger;\n    state?: Partial<RemoteFeatureFlagControllerState>;\n    clientConfigApiService: AbstractClientConfigApiService;\n    getMetaMetricsId: () => string;\n    fetchInterval?: number;\n    disabled?: boolean;\n    clientVersion: string;\n  }) {\n    if (!isValidSemVerVersion(clientVersion)) {\n      throw new Error(\n        `Invalid clientVersion: \"${clientVersion}\". Must be a valid 3-part SemVer version string`,\n      );\n    }\n\n    super({\n      name: controllerName,\n      metadata: remoteFeatureFlagControllerMetadata,\n      messenger,\n      state: {\n        ...getDefaultRemoteFeatureFlagControllerState(),\n        ...state,\n      },\n    });\n\n    this.#fetchInterval = fetchInterval;\n    this.#disabled = disabled;\n    this.#clientConfigApiService = clientConfigApiService;\n    this.#getMetaMetricsId = getMetaMetricsId;\n    this.#clientVersion = clientVersion;\n  }\n\n  /**\n   * Checks if the cached feature flags are expired based on the fetch interval.\n   *\n   * @returns Whether the cache is expired (`true`) or still valid (`false`).\n   */\n  #isCacheExpired(): boolean {\n    return Date.now() - this.state.cacheTimestamp > this.#fetchInterval;\n  }\n\n  /**\n   * Retrieves the remote feature flags, fetching from the API if necessary.\n   * Uses caching to prevent redundant API calls and handles concurrent fetches.\n   *\n   * @returns A promise that resolves to the current set of feature flags.\n   */\n  async updateRemoteFeatureFlags(): Promise<void> {\n    if (this.#disabled || !this.#isCacheExpired()) {\n      return;\n    }\n\n    let serverData;\n\n    if (this.#inProgressFlagUpdate) {\n      await this.#inProgressFlagUpdate;\n      return;\n    }\n\n    try {\n      this.#inProgressFlagUpdate =\n        this.#clientConfigApiService.fetchRemoteFeatureFlags();\n\n      serverData = await this.#inProgressFlagUpdate;\n    } finally {\n      this.#inProgressFlagUpdate = undefined;\n    }\n\n    await this.#updateCache(serverData.remoteFeatureFlags);\n  }\n\n  /**\n   * Updates the controller's state with new feature flags and resets the cache timestamp.\n   *\n   * @param remoteFeatureFlags - The new feature flags to cache.\n   */\n  async #updateCache(remoteFeatureFlags: FeatureFlags) {\n    const processedRemoteFeatureFlags =\n      await this.#processRemoteFeatureFlags(remoteFeatureFlags);\n    this.update(() => {\n      return {\n        remoteFeatureFlags: processedRemoteFeatureFlags,\n        cacheTimestamp: Date.now(),\n      };\n    });\n  }\n\n  /**\n   * Processes a version-based feature flag to get the appropriate value for the current client version.\n   *\n   * @param flagValue - The feature flag value to process\n   * @returns The processed value, or null if no version qualifies (skip this flag)\n   */\n  #processVersionBasedFlag(flagValue: Json): Json | null {\n    if (!isVersionFeatureFlag(flagValue)) {\n      return flagValue;\n    }\n\n    return getVersionData(flagValue, this.#clientVersion);\n  }\n\n  async #processRemoteFeatureFlags(\n    remoteFeatureFlags: FeatureFlags,\n  ): Promise<FeatureFlags> {\n    const processedRemoteFeatureFlags: FeatureFlags = {};\n    const metaMetricsId = this.#getMetaMetricsId();\n    const thresholdValue = generateDeterministicRandomNumber(metaMetricsId);\n\n    for (const [\n      remoteFeatureFlagName,\n      remoteFeatureFlagValue,\n    ] of Object.entries(remoteFeatureFlags)) {\n      let processedValue = this.#processVersionBasedFlag(\n        remoteFeatureFlagValue,\n      );\n      if (processedValue === null) {\n        continue;\n      }\n\n      if (Array.isArray(processedValue) && thresholdValue) {\n        const selectedGroup = processedValue.find(\n          (featureFlag): featureFlag is FeatureFlagScopeValue => {\n            if (!isFeatureFlagWithScopeValue(featureFlag)) {\n              return false;\n            }\n\n            return thresholdValue <= featureFlag.scope.value;\n          },\n        );\n        if (selectedGroup) {\n          processedValue = {\n            name: selectedGroup.name,\n            value: selectedGroup.value,\n          };\n        }\n      }\n\n      processedRemoteFeatureFlags[remoteFeatureFlagName] = processedValue;\n    }\n    return processedRemoteFeatureFlags;\n  }\n\n  /**\n   * Enables the controller, allowing it to make network requests.\n   */\n  enable(): void {\n    this.#disabled = false;\n  }\n\n  /**\n   * Disables the controller, preventing it from making network requests.\n   */\n  disable(): void {\n    this.#disabled = true;\n  }\n}\n"]}
+{"version":3,"file":"remote-feature-flag-controller.mjs","sourceRoot":"","sources":["../src/remote-feature-flag-controller.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAM3D,OAAO,EAAE,oBAAoB,EAAE,wBAAwB;AASvD,OAAO,EACL,iCAAiC,EACjC,2BAA2B,EAC5B,4CAAwC;AACzC,OAAO,EAAE,oBAAoB,EAAE,cAAc,EAAE,4BAAwB;AAEvE,kBAAkB;AAElB,MAAM,cAAc,GAAG,6BAA6B,CAAC;AACrD,MAAM,CAAC,MAAM,sBAAsB,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,QAAQ;AASnE,MAAM,mCAAmC,GAAG;IAC1C,kBAAkB,EAAE;QAClB,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,IAAI;QAC5B,QAAQ,EAAE,IAAI;KACf;IACD,cAAc,EAAE;QACd,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,IAAI;QAC5B,QAAQ,EAAE,KAAK;KAChB;CACF,CAAC;AAqCF;;;;GAIG;AACH,MAAM,UAAU,0CAA0C;IACxD,OAAO;QACL,kBAAkB,EAAE,EAAE;QACtB,cAAc,EAAE,CAAC;KAClB,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,OAAO,2BAA4B,SAAQ,cAIhD;IAaC;;;;;;;;;;;OAWG;IACH,YAAY,EACV,SAAS,EACT,KAAK,EACL,sBAAsB,EACtB,aAAa,GAAG,sBAAsB,EACtC,QAAQ,GAAG,KAAK,EAChB,gBAAgB,EAChB,aAAa,GASd;QACC,IAAI,CAAC,oBAAoB,CAAC,aAAa,CAAC,EAAE,CAAC;YACzC,MAAM,IAAI,KAAK,CACb,2BAA2B,aAAa,iDAAiD,CAC1F,CAAC;QACJ,CAAC;QAED,KAAK,CAAC;YACJ,IAAI,EAAE,cAAc;YACpB,QAAQ,EAAE,mCAAmC;YAC7C,SAAS;YACT,KAAK,EAAE;gBACL,GAAG,0CAA0C,EAAE;gBAC/C,GAAG,KAAK;aACT;SACF,CAAC,CAAC;;QAvDI,6DAAuB;QAEhC,wDAAmB;QAEV,sEAAwD;QAEjE,oEAAiD;QAExC,gEAAgC;QAEhC,6DAA8B;QA+CrC,uBAAA,IAAI,8CAAkB,aAAa,MAAA,CAAC;QACpC,uBAAA,IAAI,yCAAa,QAAQ,MAAA,CAAC;QAC1B,uBAAA,IAAI,uDAA2B,sBAAsB,MAAA,CAAC;QACtD,uBAAA,IAAI,iDAAqB,gBAAgB,MAAA,CAAC;QAC1C,uBAAA,IAAI,8CAAkB,aAAa,MAAA,CAAC;IACtC,CAAC;IAWD;;;;;OAKG;IACH,KAAK,CAAC,wBAAwB;QAC5B,IAAI,uBAAA,IAAI,6CAAU,IAAI,CAAC,uBAAA,IAAI,2FAAgB,MAApB,IAAI,CAAkB,EAAE,CAAC;YAC9C,OAAO;QACT,CAAC;QAED,IAAI,UAAU,CAAC;QAEf,IAAI,uBAAA,IAAI,yDAAsB,EAAE,CAAC;YAC/B,MAAM,uBAAA,IAAI,yDAAsB,CAAC;YACjC,OAAO;QACT,CAAC;QAED,IAAI,CAAC;YACH,uBAAA,IAAI,qDACF,uBAAA,IAAI,2DAAwB,CAAC,uBAAuB,EAAE,MAAA,CAAC;YAEzD,UAAU,GAAG,MAAM,uBAAA,IAAI,yDAAsB,CAAC;QAChD,CAAC;gBAAS,CAAC;YACT,uBAAA,IAAI,qDAAyB,SAAS,MAAA,CAAC;QACzC,CAAC;QAED,MAAM,uBAAA,IAAI,wFAAa,MAAjB,IAAI,EAAc,UAAU,CAAC,kBAAkB,CAAC,CAAC;IACzD,CAAC;IAyED;;OAEG;IACH,MAAM;QACJ,uBAAA,IAAI,yCAAa,KAAK,MAAA,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,OAAO;QACL,uBAAA,IAAI,yCAAa,IAAI,MAAA,CAAC;IACxB,CAAC;CACF;;IArHG,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,GAAG,uBAAA,IAAI,kDAAe,CAAC;AACtE,CAAC;AAgCD;;;;GAIG;AACH,KAAK,mDAAc,kBAAgC;IACjD,MAAM,2BAA2B,GAC/B,MAAM,uBAAA,IAAI,sGAA2B,MAA/B,IAAI,EAA4B,kBAAkB,CAAC,CAAC;IAC5D,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE;QACf,OAAO;YACL,kBAAkB,EAAE,2BAA2B;YAC/C,cAAc,EAAE,IAAI,CAAC,GAAG,EAAE;SAC3B,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,uHAQwB,SAAe;IACtC,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,EAAE,CAAC;QACrC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,cAAc,CAAC,SAAS,EAAE,uBAAA,IAAI,kDAAe,CAAC,CAAC;AACxD,CAAC,2DAED,KAAK,iEACH,kBAAgC;IAEhC,MAAM,2BAA2B,GAAiB,EAAE,CAAC;IACrD,MAAM,aAAa,GAAG,uBAAA,IAAI,qDAAkB,MAAtB,IAAI,CAAoB,CAAC;IAC/C,MAAM,cAAc,GAAG,iCAAiC,CAAC,aAAa,CAAC,CAAC;IAExE,KAAK,MAAM,CACT,qBAAqB,EACrB,sBAAsB,EACvB,IAAI,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE,CAAC;QACxC,IAAI,cAAc,GAAG,uBAAA,IAAI,oGAAyB,MAA7B,IAAI,EACvB,sBAAsB,CACvB,CAAC;QACF,IAAI,cAAc,KAAK,IAAI,EAAE,CAAC;YAC5B,SAAS;QACX,CAAC;QAED,IAAI,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,cAAc,EAAE,CAAC;YACpD,MAAM,aAAa,GAAG,cAAc,CAAC,IAAI,CACvC,CAAC,WAAW,EAAwC,EAAE;gBACpD,IAAI,CAAC,2BAA2B,CAAC,WAAW,CAAC,EAAE,CAAC;oBAC9C,OAAO,KAAK,CAAC;gBACf,CAAC;gBAED,OAAO,cAAc,IAAI,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC;YACnD,CAAC,CACF,CAAC;YACF,IAAI,aAAa,EAAE,CAAC;gBAClB,cAAc,GAAG;oBACf,IAAI,EAAE,aAAa,CAAC,IAAI;oBACxB,KAAK,EAAE,aAAa,CAAC,KAAK;iBAC3B,CAAC;YACJ,CAAC;QACH,CAAC;QAED,2BAA2B,CAAC,qBAAqB,CAAC,GAAG,cAAc,CAAC;IACtE,CAAC;IACD,OAAO,2BAA2B,CAAC;AACrC,CAAC","sourcesContent":["import { BaseController } from '@metamask/base-controller';\nimport type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n} from '@metamask/base-controller';\nimport type { Messenger } from '@metamask/messenger';\nimport { isValidSemVerVersion } from '@metamask/utils';\nimport type { Json, SemVerVersion } from '@metamask/utils';\n\nimport type { AbstractClientConfigApiService } from './client-config-api-service/abstract-client-config-api-service';\nimport type {\n  FeatureFlags,\n  ServiceResponse,\n  FeatureFlagScopeValue,\n} from './remote-feature-flag-controller-types';\nimport {\n  generateDeterministicRandomNumber,\n  isFeatureFlagWithScopeValue,\n} from './utils/user-segmentation-utils';\nimport { isVersionFeatureFlag, getVersionData } from './utils/version';\n\n// === GENERAL ===\n\nconst controllerName = 'RemoteFeatureFlagController';\nexport const DEFAULT_CACHE_DURATION = 24 * 60 * 60 * 1000; // 1 day\n\n// === STATE ===\n\nexport type RemoteFeatureFlagControllerState = {\n  remoteFeatureFlags: FeatureFlags;\n  cacheTimestamp: number;\n};\n\nconst remoteFeatureFlagControllerMetadata = {\n  remoteFeatureFlags: {\n    includeInStateLogs: true,\n    persist: true,\n    includeInDebugSnapshot: true,\n    usedInUi: true,\n  },\n  cacheTimestamp: {\n    includeInStateLogs: true,\n    persist: true,\n    includeInDebugSnapshot: true,\n    usedInUi: false,\n  },\n};\n\n// === MESSENGER ===\n\n/**\n * The action to retrieve the state of the {@link RemoteFeatureFlagController}.\n */\nexport type RemoteFeatureFlagControllerGetStateAction =\n  ControllerGetStateAction<\n    typeof controllerName,\n    RemoteFeatureFlagControllerState\n  >;\n\nexport type RemoteFeatureFlagControllerUpdateRemoteFeatureFlagsAction = {\n  type: `${typeof controllerName}:updateRemoteFeatureFlags`;\n  handler: RemoteFeatureFlagController['updateRemoteFeatureFlags'];\n};\n\nexport type RemoteFeatureFlagControllerActions =\n  | RemoteFeatureFlagControllerGetStateAction\n  | RemoteFeatureFlagControllerUpdateRemoteFeatureFlagsAction;\n\nexport type RemoteFeatureFlagControllerStateChangeEvent =\n  ControllerStateChangeEvent<\n    typeof controllerName,\n    RemoteFeatureFlagControllerState\n  >;\n\nexport type RemoteFeatureFlagControllerEvents =\n  RemoteFeatureFlagControllerStateChangeEvent;\n\nexport type RemoteFeatureFlagControllerMessenger = Messenger<\n  typeof controllerName,\n  RemoteFeatureFlagControllerActions,\n  RemoteFeatureFlagControllerEvents\n>;\n\n/**\n * Returns the default state for the RemoteFeatureFlagController.\n *\n * @returns The default controller state.\n */\nexport function getDefaultRemoteFeatureFlagControllerState(): RemoteFeatureFlagControllerState {\n  return {\n    remoteFeatureFlags: {},\n    cacheTimestamp: 0,\n  };\n}\n\n/**\n * The RemoteFeatureFlagController manages the retrieval and caching of remote feature flags.\n * It fetches feature flags from a remote API, caches them, and provides methods to access\n * and manage these flags. The controller ensures that feature flags are refreshed based on\n * a specified interval and handles cases where the controller is disabled or the network is unavailable.\n */\nexport class RemoteFeatureFlagController extends BaseController<\n  typeof controllerName,\n  RemoteFeatureFlagControllerState,\n  RemoteFeatureFlagControllerMessenger\n> {\n  readonly #fetchInterval: number;\n\n  #disabled: boolean;\n\n  readonly #clientConfigApiService: AbstractClientConfigApiService;\n\n  #inProgressFlagUpdate?: Promise<ServiceResponse>;\n\n  readonly #getMetaMetricsId: () => string;\n\n  readonly #clientVersion: SemVerVersion;\n\n  /**\n   * Constructs a new RemoteFeatureFlagController instance.\n   *\n   * @param options - The controller options.\n   * @param options.messenger - The messenger used for communication.\n   * @param options.state - The initial state of the controller.\n   * @param options.clientConfigApiService - The service instance to fetch remote feature flags.\n   * @param options.fetchInterval - The interval in milliseconds before cached flags expire. Defaults to 1 day.\n   * @param options.disabled - Determines if the controller should be disabled initially. Defaults to false.\n   * @param options.getMetaMetricsId - Returns metaMetricsId.\n   * @param options.clientVersion - The current client version for version-based feature flag filtering. Must be a valid 3-part SemVer version string.\n   */\n  constructor({\n    messenger,\n    state,\n    clientConfigApiService,\n    fetchInterval = DEFAULT_CACHE_DURATION,\n    disabled = false,\n    getMetaMetricsId,\n    clientVersion,\n  }: {\n    messenger: RemoteFeatureFlagControllerMessenger;\n    state?: Partial<RemoteFeatureFlagControllerState>;\n    clientConfigApiService: AbstractClientConfigApiService;\n    getMetaMetricsId: () => string;\n    fetchInterval?: number;\n    disabled?: boolean;\n    clientVersion: string;\n  }) {\n    if (!isValidSemVerVersion(clientVersion)) {\n      throw new Error(\n        `Invalid clientVersion: \"${clientVersion}\". Must be a valid 3-part SemVer version string`,\n      );\n    }\n\n    super({\n      name: controllerName,\n      metadata: remoteFeatureFlagControllerMetadata,\n      messenger,\n      state: {\n        ...getDefaultRemoteFeatureFlagControllerState(),\n        ...state,\n      },\n    });\n\n    this.#fetchInterval = fetchInterval;\n    this.#disabled = disabled;\n    this.#clientConfigApiService = clientConfigApiService;\n    this.#getMetaMetricsId = getMetaMetricsId;\n    this.#clientVersion = clientVersion;\n  }\n\n  /**\n   * Checks if the cached feature flags are expired based on the fetch interval.\n   *\n   * @returns Whether the cache is expired (`true`) or still valid (`false`).\n   */\n  #isCacheExpired(): boolean {\n    return Date.now() - this.state.cacheTimestamp > this.#fetchInterval;\n  }\n\n  /**\n   * Retrieves the remote feature flags, fetching from the API if necessary.\n   * Uses caching to prevent redundant API calls and handles concurrent fetches.\n   *\n   * @returns A promise that resolves to the current set of feature flags.\n   */\n  async updateRemoteFeatureFlags(): Promise<void> {\n    if (this.#disabled || !this.#isCacheExpired()) {\n      return;\n    }\n\n    let serverData;\n\n    if (this.#inProgressFlagUpdate) {\n      await this.#inProgressFlagUpdate;\n      return;\n    }\n\n    try {\n      this.#inProgressFlagUpdate =\n        this.#clientConfigApiService.fetchRemoteFeatureFlags();\n\n      serverData = await this.#inProgressFlagUpdate;\n    } finally {\n      this.#inProgressFlagUpdate = undefined;\n    }\n\n    await this.#updateCache(serverData.remoteFeatureFlags);\n  }\n\n  /**\n   * Updates the controller's state with new feature flags and resets the cache timestamp.\n   *\n   * @param remoteFeatureFlags - The new feature flags to cache.\n   */\n  async #updateCache(remoteFeatureFlags: FeatureFlags): Promise<void> {\n    const processedRemoteFeatureFlags =\n      await this.#processRemoteFeatureFlags(remoteFeatureFlags);\n    this.update(() => {\n      return {\n        remoteFeatureFlags: processedRemoteFeatureFlags,\n        cacheTimestamp: Date.now(),\n      };\n    });\n  }\n\n  /**\n   * Processes a version-based feature flag to get the appropriate value for the current client version.\n   *\n   * @param flagValue - The feature flag value to process\n   * @returns The processed value, or null if no version qualifies (skip this flag)\n   */\n  #processVersionBasedFlag(flagValue: Json): Json | null {\n    if (!isVersionFeatureFlag(flagValue)) {\n      return flagValue;\n    }\n\n    return getVersionData(flagValue, this.#clientVersion);\n  }\n\n  async #processRemoteFeatureFlags(\n    remoteFeatureFlags: FeatureFlags,\n  ): Promise<FeatureFlags> {\n    const processedRemoteFeatureFlags: FeatureFlags = {};\n    const metaMetricsId = this.#getMetaMetricsId();\n    const thresholdValue = generateDeterministicRandomNumber(metaMetricsId);\n\n    for (const [\n      remoteFeatureFlagName,\n      remoteFeatureFlagValue,\n    ] of Object.entries(remoteFeatureFlags)) {\n      let processedValue = this.#processVersionBasedFlag(\n        remoteFeatureFlagValue,\n      );\n      if (processedValue === null) {\n        continue;\n      }\n\n      if (Array.isArray(processedValue) && thresholdValue) {\n        const selectedGroup = processedValue.find(\n          (featureFlag): featureFlag is FeatureFlagScopeValue => {\n            if (!isFeatureFlagWithScopeValue(featureFlag)) {\n              return false;\n            }\n\n            return thresholdValue <= featureFlag.scope.value;\n          },\n        );\n        if (selectedGroup) {\n          processedValue = {\n            name: selectedGroup.name,\n            value: selectedGroup.value,\n          };\n        }\n      }\n\n      processedRemoteFeatureFlags[remoteFeatureFlagName] = processedValue;\n    }\n    return processedRemoteFeatureFlags;\n  }\n\n  /**\n   * Enables the controller, allowing it to make network requests.\n   */\n  enable(): void {\n    this.#disabled = false;\n  }\n\n  /**\n   * Disables the controller, preventing it from making network requests.\n   */\n  disable(): void {\n    this.#disabled = true;\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/remote-feature-flag-controller",
-  "version": "3.0.0-preview-d2037635",
+  "version": "3.0.0-preview-a4b203f",
   "description": "The RemoteFeatureFlagController manages the retrieval and caching of remote feature flags",
   "keywords": [
     "MetaMask",