@metamask-previews/remote-feature-flag-controller 1.0.0-preview-a82fd89

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

@@ -0,0 +1,113 @@
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _ClientConfigApiService_fetch, _ClientConfigApiService_policy, _ClientConfigApiService_client, _ClientConfigApiService_distribution, _ClientConfigApiService_environment;
+import { circuitBreaker, ConsecutiveBreaker, ExponentialBackoff, handleAll, retry, wrap, CircuitState } from "cockatiel";
+import { BASE_URL } from "../constants.mjs";
+const DEFAULT_FETCH_RETRIES = 3;
+// Each update attempt will result (1 + retries) calls if the server is down
+const DEFAULT_MAX_CONSECUTIVE_FAILURES = (1 + DEFAULT_FETCH_RETRIES) * 3;
+export const DEFAULT_DEGRADED_THRESHOLD = 5000;
+/**
+ * This service is responsible for fetching feature flags from the ClientConfig API.
+ */
+export class ClientConfigApiService {
+    /**
+     * Constructs a new ClientConfigApiService object.
+     *
+     * @param args - The arguments.
+     * @param args.fetch - A function that can be used to make an HTTP request.
+     * @param args.retries - Number of retry attempts for each fetch request.
+     * @param args.maximumConsecutiveFailures - The maximum number of consecutive failures
+     * allowed before breaking the circuit and pausing further fetch attempts.
+     * @param args.circuitBreakDuration - The duration for which the circuit remains open after
+     * too many consecutive failures.
+     * @param args.onBreak - Callback invoked when the circuit breaks.
+     * @param args.onDegraded - Callback invoked when the service is degraded (requests resolving too slowly).
+     * @param args.config - The configuration object, includes client, distribution, and environment.
+     * @param args.config.client - The client type (e.g., 'extension', 'mobile').
+     * @param args.config.distribution - The distribution type (e.g., 'main', 'flask').
+     * @param args.config.environment - The environment type (e.g., 'prod', 'rc', 'dev').
+     */
+    constructor({ fetch: fetchFunction, retries = DEFAULT_FETCH_RETRIES, maximumConsecutiveFailures = DEFAULT_MAX_CONSECUTIVE_FAILURES, circuitBreakDuration = 30 * 60 * 1000, onBreak, onDegraded, config, }) {
+        _ClientConfigApiService_fetch.set(this, void 0);
+        _ClientConfigApiService_policy.set(this, void 0);
+        _ClientConfigApiService_client.set(this, void 0);
+        _ClientConfigApiService_distribution.set(this, void 0);
+        _ClientConfigApiService_environment.set(this, void 0);
+        __classPrivateFieldSet(this, _ClientConfigApiService_fetch, fetchFunction, "f");
+        __classPrivateFieldSet(this, _ClientConfigApiService_client, config.client, "f");
+        __classPrivateFieldSet(this, _ClientConfigApiService_distribution, config.distribution, "f");
+        __classPrivateFieldSet(this, _ClientConfigApiService_environment, config.environment, "f");
+        const retryPolicy = retry(handleAll, {
+            maxAttempts: retries,
+            backoff: new ExponentialBackoff(),
+        });
+        const circuitBreakerPolicy = circuitBreaker(handleAll, {
+            halfOpenAfter: circuitBreakDuration,
+            breaker: new ConsecutiveBreaker(maximumConsecutiveFailures),
+        });
+        if (onBreak) {
+            circuitBreakerPolicy.onBreak(onBreak);
+        }
+        if (onDegraded) {
+            retryPolicy.onGiveUp(() => {
+                if (circuitBreakerPolicy.state === CircuitState.Closed) {
+                    onDegraded();
+                }
+            });
+            retryPolicy.onSuccess(({ duration }) => {
+                if (circuitBreakerPolicy.state === CircuitState.Closed &&
+                    duration > DEFAULT_DEGRADED_THRESHOLD // Default degraded threshold
+                ) {
+                    onDegraded();
+                }
+            });
+        }
+        __classPrivateFieldSet(this, _ClientConfigApiService_policy, wrap(retryPolicy, circuitBreakerPolicy), "f");
+    }
+    /**
+     * Fetches feature flags from the API with specific client, distribution, and environment parameters.
+     * Provides structured error handling, including fallback to cached data if available.
+     * @returns An object of feature flags and their boolean values or a structured error object.
+     */
+    async fetchRemoteFeatureFlags() {
+        const url = `${BASE_URL}/flags?client=${__classPrivateFieldGet(this, _ClientConfigApiService_client, "f")}&distribution=${__classPrivateFieldGet(this, _ClientConfigApiService_distribution, "f")}&environment=${__classPrivateFieldGet(this, _ClientConfigApiService_environment, "f")}`;
+        const response = await __classPrivateFieldGet(this, _ClientConfigApiService_policy, "f").execute(() => __classPrivateFieldGet(this, _ClientConfigApiService_fetch, "f").call(this, url, { cache: 'no-cache' }));
+        if (!response.ok) {
+            throw new Error('Failed to fetch remote feature flags');
+        }
+        const data = await response.json();
+        if (!Array.isArray(data)) {
+            throw new Error('Feature flags api did not return an array');
+        }
+        const remoteFeatureFlags = this.flattenFeatureFlags(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();
+//# sourceMappingURL=client-config-api-service.mjs.map

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

@@ -0,0 +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,cAAc,EACd,kBAAkB,EAClB,kBAAkB,EAClB,SAAS,EAET,KAAK,EACL,IAAI,EACJ,YAAY,EACb,kBAAkB;AAEnB,OAAO,EAAE,QAAQ,EAAE,yBAAqB;AAUxC,MAAM,qBAAqB,GAAG,CAAC,CAAC;AAChC,4EAA4E;AAC5E,MAAM,gCAAgC,GAAG,CAAC,CAAC,GAAG,qBAAqB,CAAC,GAAG,CAAC,CAAC;AAEzE,MAAM,CAAC,MAAM,0BAA0B,GAAG,IAAI,CAAC;AAE/C;;GAEG;AACH,MAAM,OAAO,sBAAsB;IAWjC;;;;;;;;;;;;;;;;OAgBG;IACH,YAAY,EACV,KAAK,EAAE,aAAa,EACpB,OAAO,GAAG,qBAAqB,EAC/B,0BAA0B,GAAG,gCAAgC,EAC7D,oBAAoB,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,EACrC,OAAO,EACP,UAAU,EACV,MAAM,GAaP;QA/CD,gDAAqB;QAErB,iDAAiB;QAEjB,iDAAoB;QAEpB,uDAAgC;QAEhC,sDAA8B;QAwC5B,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,MAAM,WAAW,GAAG,KAAK,CAAC,SAAS,EAAE;YACnC,WAAW,EAAE,OAAO;YACpB,OAAO,EAAE,IAAI,kBAAkB,EAAE;SAClC,CAAC,CAAC;QAEH,MAAM,oBAAoB,GAAG,cAAc,CAAC,SAAS,EAAE;YACrD,aAAa,EAAE,oBAAoB;YACnC,OAAO,EAAE,IAAI,kBAAkB,CAAC,0BAA0B,CAAC;SAC5D,CAAC,CAAC;QAEH,IAAI,OAAO,EAAE;YACX,oBAAoB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;SACvC;QAED,IAAI,UAAU,EAAE;YACd,WAAW,CAAC,QAAQ,CAAC,GAAG,EAAE;gBACxB,IAAI,oBAAoB,CAAC,KAAK,KAAK,YAAY,CAAC,MAAM,EAAE;oBACtD,UAAU,EAAE,CAAC;iBACd;YACH,CAAC,CAAC,CAAC;YAEH,WAAW,CAAC,SAAS,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE;gBACrC,IACE,oBAAoB,CAAC,KAAK,KAAK,YAAY,CAAC,MAAM;oBAClD,QAAQ,GAAG,0BAA0B,CAAC,6BAA6B;kBACnE;oBACA,UAAU,EAAE,CAAC;iBACd;YACH,CAAC,CAAC,CAAC;SACJ;QAED,uBAAA,IAAI,kCAAW,IAAI,CAAC,WAAW,EAAE,oBAAoB,CAAC,MAAA,CAAC;IACzD,CAAC;IAED;;;;OAIG;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;YAChB,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;SACzD;QAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAEnC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACxB,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;SAC9D;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;;;;;;;OAOG;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  circuitBreaker,\n  ConsecutiveBreaker,\n  ExponentialBackoff,\n  handleAll,\n  type IPolicy,\n  retry,\n  wrap,\n  CircuitState,\n} from 'cockatiel';\n\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\nconst DEFAULT_FETCH_RETRIES = 3;\n// Each update attempt will result (1 + retries) calls if the server is down\nconst DEFAULT_MAX_CONSECUTIVE_FAILURES = (1 + DEFAULT_FETCH_RETRIES) * 3;\n\nexport const DEFAULT_DEGRADED_THRESHOLD = 5000;\n\n/**\n * This service is responsible for fetching feature flags from the ClientConfig API.\n */\nexport class ClientConfigApiService {\n  #fetch: typeof fetch;\n\n  #policy: IPolicy;\n\n  #client: ClientType;\n\n  #distribution: DistributionType;\n\n  #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   * @param args.retries - Number of retry attempts for each fetch request.\n   * @param args.maximumConsecutiveFailures - The maximum number of consecutive failures\n   * allowed before breaking the circuit and pausing further fetch attempts.\n   * @param args.circuitBreakDuration - The duration for which the circuit remains open after\n   * too many consecutive failures.\n   * @param args.onBreak - Callback invoked when the circuit breaks.\n   * @param args.onDegraded - Callback invoked when the service is degraded (requests resolving too slowly).\n   * @param args.config - The configuration object, includes client, 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', 'flask').\n   * @param args.config.environment - The environment type (e.g., 'prod', 'rc', 'dev').\n   */\n  constructor({\n    fetch: fetchFunction,\n    retries = DEFAULT_FETCH_RETRIES,\n    maximumConsecutiveFailures = DEFAULT_MAX_CONSECUTIVE_FAILURES,\n    circuitBreakDuration = 30 * 60 * 1000,\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    const retryPolicy = retry(handleAll, {\n      maxAttempts: retries,\n      backoff: new ExponentialBackoff(),\n    });\n\n    const circuitBreakerPolicy = circuitBreaker(handleAll, {\n      halfOpenAfter: circuitBreakDuration,\n      breaker: new ConsecutiveBreaker(maximumConsecutiveFailures),\n    });\n\n    if (onBreak) {\n      circuitBreakerPolicy.onBreak(onBreak);\n    }\n\n    if (onDegraded) {\n      retryPolicy.onGiveUp(() => {\n        if (circuitBreakerPolicy.state === CircuitState.Closed) {\n          onDegraded();\n        }\n      });\n\n      retryPolicy.onSuccess(({ duration }) => {\n        if (\n          circuitBreakerPolicy.state === CircuitState.Closed &&\n          duration > DEFAULT_DEGRADED_THRESHOLD // Default degraded threshold\n        ) {\n          onDegraded();\n        }\n      });\n    }\n\n    this.#policy = wrap(retryPolicy, circuitBreakerPolicy);\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   * @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   * @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"]}

package/dist/constants.cjs

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BASE_URL = void 0;
+/**
+ * ClientConfig API base URL.
+ */
+exports.BASE_URL = 'https://client-config.api.cx.metamask.io/v1';
+//# sourceMappingURL=constants.cjs.map

package/dist/constants.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.cjs","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACU,QAAA,QAAQ,GAAG,6CAA6C,CAAC","sourcesContent":["/**\n * ClientConfig API base URL.\n */\nexport const BASE_URL = 'https://client-config.api.cx.metamask.io/v1';\n"]}

package/dist/constants.d.cts

@@ -0,0 +1,5 @@
+/**
+ * ClientConfig API base URL.
+ */
+export declare const BASE_URL = "https://client-config.api.cx.metamask.io/v1";
+//# sourceMappingURL=constants.d.cts.map

package/dist/constants.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.cts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,QAAQ,gDAAgD,CAAC"}

package/dist/constants.d.mts

@@ -0,0 +1,5 @@
+/**
+ * ClientConfig API base URL.
+ */
+export declare const BASE_URL = "https://client-config.api.cx.metamask.io/v1";
+//# sourceMappingURL=constants.d.mts.map

package/dist/constants.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.mts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,QAAQ,gDAAgD,CAAC"}

package/dist/constants.mjs

@@ -0,0 +1,5 @@
+/**
+ * ClientConfig API base URL.
+ */
+export const BASE_URL = 'https://client-config.api.cx.metamask.io/v1';
+//# sourceMappingURL=constants.mjs.map

package/dist/constants.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.mjs","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,6CAA6C,CAAC","sourcesContent":["/**\n * ClientConfig API base URL.\n */\nexport const BASE_URL = 'https://client-config.api.cx.metamask.io/v1';\n"]}

package/dist/index.cjs

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClientConfigApiService = exports.EnvironmentType = exports.DistributionType = exports.ClientType = exports.RemoteFeatureFlagController = void 0;
+var remote_feature_flag_controller_1 = require("./remote-feature-flag-controller.cjs");
+Object.defineProperty(exports, "RemoteFeatureFlagController", { enumerable: true, get: function () { return remote_feature_flag_controller_1.RemoteFeatureFlagController; } });
+var remote_feature_flag_controller_types_1 = require("./remote-feature-flag-controller-types.cjs");
+Object.defineProperty(exports, "ClientType", { enumerable: true, get: function () { return remote_feature_flag_controller_types_1.ClientType; } });
+Object.defineProperty(exports, "DistributionType", { enumerable: true, get: function () { return remote_feature_flag_controller_types_1.DistributionType; } });
+Object.defineProperty(exports, "EnvironmentType", { enumerable: true, get: function () { return remote_feature_flag_controller_types_1.EnvironmentType; } });
+var client_config_api_service_1 = require("./client-config-api-service/client-config-api-service.cjs");
+Object.defineProperty(exports, "ClientConfigApiService", { enumerable: true, get: function () { return client_config_api_service_1.ClientConfigApiService; } });
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,uFAA+E;AAAtE,6IAAA,2BAA2B,OAAA;AAEpC,mGAIgD;AAH9C,kIAAA,UAAU,OAAA;AACV,wIAAA,gBAAgB,OAAA;AAChB,uIAAA,eAAe,OAAA;AAQjB,uGAA+F;AAAtF,mIAAA,sBAAsB,OAAA","sourcesContent":["export { RemoteFeatureFlagController } from './remote-feature-flag-controller';\nexport type { RemoteFeatureFlagControllerMessenger } from './remote-feature-flag-controller';\nexport {\n  ClientType,\n  DistributionType,\n  EnvironmentType,\n} from './remote-feature-flag-controller-types';\n\nexport type {\n  RemoteFeatureFlagControllerState,\n  RemoteFeatureFlagControllerGetStateAction,\n  FeatureFlags,\n} from './remote-feature-flag-controller-types';\nexport { ClientConfigApiService } from './client-config-api-service/client-config-api-service';\n"]}

package/dist/index.d.cts

@@ -0,0 +1,6 @@
+export { RemoteFeatureFlagController } from "./remote-feature-flag-controller.cjs";
+export type { RemoteFeatureFlagControllerMessenger } from "./remote-feature-flag-controller.cjs";
+export { ClientType, DistributionType, EnvironmentType, } from "./remote-feature-flag-controller-types.cjs";
+export type { RemoteFeatureFlagControllerState, RemoteFeatureFlagControllerGetStateAction, FeatureFlags, } from "./remote-feature-flag-controller-types.cjs";
+export { ClientConfigApiService } from "./client-config-api-service/client-config-api-service.cjs";
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,6CAAyC;AAC/E,YAAY,EAAE,oCAAoC,EAAE,6CAAyC;AAC7F,OAAO,EACL,UAAU,EACV,gBAAgB,EAChB,eAAe,GAChB,mDAA+C;AAEhD,YAAY,EACV,gCAAgC,EAChC,yCAAyC,EACzC,YAAY,GACb,mDAA+C;AAChD,OAAO,EAAE,sBAAsB,EAAE,kEAA8D"}

package/dist/index.d.mts

@@ -0,0 +1,6 @@
+export { RemoteFeatureFlagController } from "./remote-feature-flag-controller.mjs";
+export type { RemoteFeatureFlagControllerMessenger } from "./remote-feature-flag-controller.mjs";
+export { ClientType, DistributionType, EnvironmentType, } from "./remote-feature-flag-controller-types.mjs";
+export type { RemoteFeatureFlagControllerState, RemoteFeatureFlagControllerGetStateAction, FeatureFlags, } from "./remote-feature-flag-controller-types.mjs";
+export { ClientConfigApiService } from "./client-config-api-service/client-config-api-service.mjs";
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,6CAAyC;AAC/E,YAAY,EAAE,oCAAoC,EAAE,6CAAyC;AAC7F,OAAO,EACL,UAAU,EACV,gBAAgB,EAChB,eAAe,GAChB,mDAA+C;AAEhD,YAAY,EACV,gCAAgC,EAChC,yCAAyC,EACzC,YAAY,GACb,mDAA+C;AAChD,OAAO,EAAE,sBAAsB,EAAE,kEAA8D"}

package/dist/index.mjs

@@ -0,0 +1,4 @@
+export { RemoteFeatureFlagController } from "./remote-feature-flag-controller.mjs";
+export { ClientType, DistributionType, EnvironmentType } from "./remote-feature-flag-controller-types.mjs";
+export { ClientConfigApiService } from "./client-config-api-service/client-config-api-service.mjs";
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,6CAAyC;AAE/E,OAAO,EACL,UAAU,EACV,gBAAgB,EAChB,eAAe,EAChB,mDAA+C;AAOhD,OAAO,EAAE,sBAAsB,EAAE,kEAA8D","sourcesContent":["export { RemoteFeatureFlagController } from './remote-feature-flag-controller';\nexport type { RemoteFeatureFlagControllerMessenger } from './remote-feature-flag-controller';\nexport {\n  ClientType,\n  DistributionType,\n  EnvironmentType,\n} from './remote-feature-flag-controller-types';\n\nexport type {\n  RemoteFeatureFlagControllerState,\n  RemoteFeatureFlagControllerGetStateAction,\n  FeatureFlags,\n} from './remote-feature-flag-controller-types';\nexport { ClientConfigApiService } from './client-config-api-service/client-config-api-service';\n"]}

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

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EnvironmentType = exports.DistributionType = exports.ClientType = void 0;
+// Define accepted values for client, distribution, and environment
+var ClientType;
+(function (ClientType) {
+    ClientType["Extension"] = "extension";
+    ClientType["Mobile"] = "mobile";
+})(ClientType || (exports.ClientType = ClientType = {}));
+var DistributionType;
+(function (DistributionType) {
+    DistributionType["Main"] = "main";
+    DistributionType["Flask"] = "flask";
+})(DistributionType || (exports.DistributionType = DistributionType = {}));
+var EnvironmentType;
+(function (EnvironmentType) {
+    EnvironmentType["Production"] = "prod";
+    EnvironmentType["ReleaseCandidate"] = "rc";
+    EnvironmentType["Development"] = "dev";
+})(EnvironmentType || (exports.EnvironmentType = EnvironmentType = {}));
+//# sourceMappingURL=remote-feature-flag-controller-types.cjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"remote-feature-flag-controller-types.cjs","sourceRoot":"","sources":["../src/remote-feature-flag-controller-types.ts"],"names":[],"mappings":";;;AAGA,mEAAmE;AACnE,IAAY,UAGX;AAHD,WAAY,UAAU;IACpB,qCAAuB,CAAA;IACvB,+BAAiB,CAAA;AACnB,CAAC,EAHW,UAAU,0BAAV,UAAU,QAGrB;AAED,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,iCAAa,CAAA;IACb,mCAAe,CAAA;AACjB,CAAC,EAHW,gBAAgB,gCAAhB,gBAAgB,QAG3B;AAED,IAAY,eAIX;AAJD,WAAY,eAAe;IACzB,sCAAmB,CAAA;IACnB,0CAAuB,CAAA;IACvB,sCAAmB,CAAA;AACrB,CAAC,EAJW,eAAe,+BAAf,eAAe,QAI1B","sourcesContent":["import type { ControllerGetStateAction } from '@metamask/base-controller';\nimport type { Json } from '@metamask/utils';\n\n// Define accepted values for client, distribution, and environment\nexport enum ClientType {\n  Extension = 'extension',\n  Mobile = 'mobile',\n}\n\nexport enum DistributionType {\n  Main = 'main',\n  Flask = 'flask',\n}\n\nexport enum EnvironmentType {\n  Production = 'prod',\n  ReleaseCandidate = 'rc',\n  Development = 'dev',\n}\n\n/** Type representing the feature flags collection */\nexport type FeatureFlags = {\n  [key: string]: Json;\n};\n\nexport type ApiDataResponse = FeatureFlags[];\n\nexport type ServiceResponse = {\n  remoteFeatureFlags: FeatureFlags;\n  cacheTimestamp: number | null;\n};\n\n/**\n * Describes the shape of the state object for the {@link RemoteFeatureFlagController}.\n */\nexport type RemoteFeatureFlagControllerState = {\n  /**\n   * The collection of feature flags and their respective values, which can be objects.\n   */\n  remoteFeatureFlags: FeatureFlags;\n  /**\n   * The timestamp of the last successful feature flag cache.\n   */\n  cacheTimestamp: number;\n};\n\n/**\n * The action to retrieve the state of the {@link RemoteFeatureFlagController}.\n */\nexport type RemoteFeatureFlagControllerGetStateAction =\n  ControllerGetStateAction<\n    'RemoteFeatureFlagController',\n    RemoteFeatureFlagControllerState\n  >;\n"]}

package/dist/remote-feature-flag-controller-types.d.cts

@@ -0,0 +1,42 @@
+import type { ControllerGetStateAction } from "@metamask/base-controller";
+import type { Json } from "@metamask/utils";
+export declare enum ClientType {
+    Extension = "extension",
+    Mobile = "mobile"
+}
+export declare enum DistributionType {
+    Main = "main",
+    Flask = "flask"
+}
+export declare enum EnvironmentType {
+    Production = "prod",
+    ReleaseCandidate = "rc",
+    Development = "dev"
+}
+/** Type representing the feature flags collection */
+export type FeatureFlags = {
+    [key: string]: Json;
+};
+export type ApiDataResponse = FeatureFlags[];
+export type ServiceResponse = {
+    remoteFeatureFlags: FeatureFlags;
+    cacheTimestamp: number | null;
+};
+/**
+ * Describes the shape of the state object for the {@link RemoteFeatureFlagController}.
+ */
+export type RemoteFeatureFlagControllerState = {
+    /**
+     * The collection of feature flags and their respective values, which can be objects.
+     */
+    remoteFeatureFlags: FeatureFlags;
+    /**
+     * The timestamp of the last successful feature flag cache.
+     */
+    cacheTimestamp: number;
+};
+/**
+ * The action to retrieve the state of the {@link RemoteFeatureFlagController}.
+ */
+export type RemoteFeatureFlagControllerGetStateAction = ControllerGetStateAction<'RemoteFeatureFlagController', RemoteFeatureFlagControllerState>;
+//# sourceMappingURL=remote-feature-flag-controller-types.d.cts.map

package/dist/remote-feature-flag-controller-types.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"remote-feature-flag-controller-types.d.cts","sourceRoot":"","sources":["../src/remote-feature-flag-controller-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,kCAAkC;AAC1E,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAG5C,oBAAY,UAAU;IACpB,SAAS,cAAc;IACvB,MAAM,WAAW;CAClB;AAED,oBAAY,gBAAgB;IAC1B,IAAI,SAAS;IACb,KAAK,UAAU;CAChB;AAED,oBAAY,eAAe;IACzB,UAAU,SAAS;IACnB,gBAAgB,OAAO;IACvB,WAAW,QAAQ;CACpB;AAED,qDAAqD;AACrD,MAAM,MAAM,YAAY,GAAG;IACzB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,YAAY,EAAE,CAAC;AAE7C,MAAM,MAAM,eAAe,GAAG;IAC5B,kBAAkB,EAAE,YAAY,CAAC;IACjC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gCAAgC,GAAG;IAC7C;;OAEG;IACH,kBAAkB,EAAE,YAAY,CAAC;IACjC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,yCAAyC,GACnD,wBAAwB,CACtB,6BAA6B,EAC7B,gCAAgC,CACjC,CAAC"}

package/dist/remote-feature-flag-controller-types.d.mts

@@ -0,0 +1,42 @@
+import type { ControllerGetStateAction } from "@metamask/base-controller";
+import type { Json } from "@metamask/utils";
+export declare enum ClientType {
+    Extension = "extension",
+    Mobile = "mobile"
+}
+export declare enum DistributionType {
+    Main = "main",
+    Flask = "flask"
+}
+export declare enum EnvironmentType {
+    Production = "prod",
+    ReleaseCandidate = "rc",
+    Development = "dev"
+}
+/** Type representing the feature flags collection */
+export type FeatureFlags = {
+    [key: string]: Json;
+};
+export type ApiDataResponse = FeatureFlags[];
+export type ServiceResponse = {
+    remoteFeatureFlags: FeatureFlags;
+    cacheTimestamp: number | null;
+};
+/**
+ * Describes the shape of the state object for the {@link RemoteFeatureFlagController}.
+ */
+export type RemoteFeatureFlagControllerState = {
+    /**
+     * The collection of feature flags and their respective values, which can be objects.
+     */
+    remoteFeatureFlags: FeatureFlags;
+    /**
+     * The timestamp of the last successful feature flag cache.
+     */
+    cacheTimestamp: number;
+};
+/**
+ * The action to retrieve the state of the {@link RemoteFeatureFlagController}.
+ */
+export type RemoteFeatureFlagControllerGetStateAction = ControllerGetStateAction<'RemoteFeatureFlagController', RemoteFeatureFlagControllerState>;
+//# sourceMappingURL=remote-feature-flag-controller-types.d.mts.map

package/dist/remote-feature-flag-controller-types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"remote-feature-flag-controller-types.d.mts","sourceRoot":"","sources":["../src/remote-feature-flag-controller-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,kCAAkC;AAC1E,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAG5C,oBAAY,UAAU;IACpB,SAAS,cAAc;IACvB,MAAM,WAAW;CAClB;AAED,oBAAY,gBAAgB;IAC1B,IAAI,SAAS;IACb,KAAK,UAAU;CAChB;AAED,oBAAY,eAAe;IACzB,UAAU,SAAS;IACnB,gBAAgB,OAAO;IACvB,WAAW,QAAQ;CACpB;AAED,qDAAqD;AACrD,MAAM,MAAM,YAAY,GAAG;IACzB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,YAAY,EAAE,CAAC;AAE7C,MAAM,MAAM,eAAe,GAAG;IAC5B,kBAAkB,EAAE,YAAY,CAAC;IACjC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gCAAgC,GAAG;IAC7C;;OAEG;IACH,kBAAkB,EAAE,YAAY,CAAC;IACjC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,yCAAyC,GACnD,wBAAwB,CACtB,6BAA6B,EAC7B,gCAAgC,CACjC,CAAC"}

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

@@ -0,0 +1,18 @@
+// Define accepted values for client, distribution, and environment
+export var ClientType;
+(function (ClientType) {
+    ClientType["Extension"] = "extension";
+    ClientType["Mobile"] = "mobile";
+})(ClientType || (ClientType = {}));
+export var DistributionType;
+(function (DistributionType) {
+    DistributionType["Main"] = "main";
+    DistributionType["Flask"] = "flask";
+})(DistributionType || (DistributionType = {}));
+export var EnvironmentType;
+(function (EnvironmentType) {
+    EnvironmentType["Production"] = "prod";
+    EnvironmentType["ReleaseCandidate"] = "rc";
+    EnvironmentType["Development"] = "dev";
+})(EnvironmentType || (EnvironmentType = {}));
+//# sourceMappingURL=remote-feature-flag-controller-types.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"remote-feature-flag-controller-types.mjs","sourceRoot":"","sources":["../src/remote-feature-flag-controller-types.ts"],"names":[],"mappings":"AAGA,mEAAmE;AACnE,MAAM,CAAN,IAAY,UAGX;AAHD,WAAY,UAAU;IACpB,qCAAuB,CAAA;IACvB,+BAAiB,CAAA;AACnB,CAAC,EAHW,UAAU,KAAV,UAAU,QAGrB;AAED,MAAM,CAAN,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,iCAAa,CAAA;IACb,mCAAe,CAAA;AACjB,CAAC,EAHW,gBAAgB,KAAhB,gBAAgB,QAG3B;AAED,MAAM,CAAN,IAAY,eAIX;AAJD,WAAY,eAAe;IACzB,sCAAmB,CAAA;IACnB,0CAAuB,CAAA;IACvB,sCAAmB,CAAA;AACrB,CAAC,EAJW,eAAe,KAAf,eAAe,QAI1B","sourcesContent":["import type { ControllerGetStateAction } from '@metamask/base-controller';\nimport type { Json } from '@metamask/utils';\n\n// Define accepted values for client, distribution, and environment\nexport enum ClientType {\n  Extension = 'extension',\n  Mobile = 'mobile',\n}\n\nexport enum DistributionType {\n  Main = 'main',\n  Flask = 'flask',\n}\n\nexport enum EnvironmentType {\n  Production = 'prod',\n  ReleaseCandidate = 'rc',\n  Development = 'dev',\n}\n\n/** Type representing the feature flags collection */\nexport type FeatureFlags = {\n  [key: string]: Json;\n};\n\nexport type ApiDataResponse = FeatureFlags[];\n\nexport type ServiceResponse = {\n  remoteFeatureFlags: FeatureFlags;\n  cacheTimestamp: number | null;\n};\n\n/**\n * Describes the shape of the state object for the {@link RemoteFeatureFlagController}.\n */\nexport type RemoteFeatureFlagControllerState = {\n  /**\n   * The collection of feature flags and their respective values, which can be objects.\n   */\n  remoteFeatureFlags: FeatureFlags;\n  /**\n   * The timestamp of the last successful feature flag cache.\n   */\n  cacheTimestamp: number;\n};\n\n/**\n * The action to retrieve the state of the {@link RemoteFeatureFlagController}.\n */\nexport type RemoteFeatureFlagControllerGetStateAction =\n  ControllerGetStateAction<\n    'RemoteFeatureFlagController',\n    RemoteFeatureFlagControllerState\n  >;\n"]}

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

@@ -0,0 +1,120 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _RemoteFeatureFlagController_instances, _RemoteFeatureFlagController_fetchInterval, _RemoteFeatureFlagController_disabled, _RemoteFeatureFlagController_clientConfigApiService, _RemoteFeatureFlagController_inProgressFlagUpdate, _RemoteFeatureFlagController_isCacheExpired, _RemoteFeatureFlagController_updateCache;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RemoteFeatureFlagController = exports.getDefaultRemoteFeatureFlagControllerState = exports.DEFAULT_CACHE_DURATION = exports.controllerName = void 0;
+const base_controller_1 = require("@metamask/base-controller");
+// === GENERAL ===
+exports.controllerName = 'RemoteFeatureFlagController';
+exports.DEFAULT_CACHE_DURATION = 24 * 60 * 60 * 1000; // 1 day
+const remoteFeatureFlagControllerMetadata = {
+    remoteFeatureFlags: { persist: true, anonymous: true },
+    cacheTimestamp: { persist: true, anonymous: true },
+};
+/**
+ * Returns the default state for the RemoteFeatureFlagController.
+ *
+ * @returns The default controller state.
+ */
+function getDefaultRemoteFeatureFlagControllerState() {
+    return {
+        remoteFeatureFlags: {},
+        cacheTimestamp: 0,
+    };
+}
+exports.getDefaultRemoteFeatureFlagControllerState = getDefaultRemoteFeatureFlagControllerState;
+/**
+ * The RemoteFeatureFlagController manages the retrieval and caching of remote feature flags.
+ * It fetches feature flags from a remote API, caches them, and provides methods to access
+ * and manage these flags. The controller ensures that feature flags are refreshed based on
+ * a specified interval and handles cases where the controller is disabled or the network is unavailable.
+ */
+class RemoteFeatureFlagController extends base_controller_1.BaseController {
+    /**
+     * Constructs a new RemoteFeatureFlagController instance.
+     *
+     * @param options - The controller options.
+     * @param options.messenger - The controller messenger used for communication.
+     * @param options.state - The initial state of the controller.
+     * @param options.clientConfigApiService - The service instance to fetch remote feature flags.
+     * @param options.fetchInterval - The interval in milliseconds before cached flags expire. Defaults to 1 day.
+     * @param options.disabled - Determines if the controller should be disabled initially. Defaults to false.
+     */
+    constructor({ messenger, state, clientConfigApiService, fetchInterval = exports.DEFAULT_CACHE_DURATION, disabled = false, }) {
+        super({
+            name: exports.controllerName,
+            metadata: remoteFeatureFlagControllerMetadata,
+            messenger,
+            state: {
+                ...getDefaultRemoteFeatureFlagControllerState(),
+                ...state,
+            },
+        });
+        _RemoteFeatureFlagController_instances.add(this);
+        _RemoteFeatureFlagController_fetchInterval.set(this, void 0);
+        _RemoteFeatureFlagController_disabled.set(this, void 0);
+        _RemoteFeatureFlagController_clientConfigApiService.set(this, void 0);
+        _RemoteFeatureFlagController_inProgressFlagUpdate.set(this, void 0);
+        __classPrivateFieldSet(this, _RemoteFeatureFlagController_fetchInterval, fetchInterval, "f");
+        __classPrivateFieldSet(this, _RemoteFeatureFlagController_disabled, disabled, "f");
+        __classPrivateFieldSet(this, _RemoteFeatureFlagController_clientConfigApiService, clientConfigApiService, "f");
+    }
+    /**
+     * Retrieves the remote feature flags, fetching from the API if necessary.
+     * Uses caching to prevent redundant API calls and handles concurrent fetches.
+     *
+     * @returns A promise that resolves to the current set of feature flags.
+     */
+    async updateRemoteFeatureFlags() {
+        if (__classPrivateFieldGet(this, _RemoteFeatureFlagController_disabled, "f") || !__classPrivateFieldGet(this, _RemoteFeatureFlagController_instances, "m", _RemoteFeatureFlagController_isCacheExpired).call(this)) {
+            return;
+        }
+        let serverData;
+        if (__classPrivateFieldGet(this, _RemoteFeatureFlagController_inProgressFlagUpdate, "f")) {
+            await __classPrivateFieldGet(this, _RemoteFeatureFlagController_inProgressFlagUpdate, "f");
+            return;
+        }
+        try {
+            __classPrivateFieldSet(this, _RemoteFeatureFlagController_inProgressFlagUpdate, __classPrivateFieldGet(this, _RemoteFeatureFlagController_clientConfigApiService, "f").fetchRemoteFeatureFlags(), "f");
+            serverData = await __classPrivateFieldGet(this, _RemoteFeatureFlagController_inProgressFlagUpdate, "f");
+        }
+        finally {
+            __classPrivateFieldSet(this, _RemoteFeatureFlagController_inProgressFlagUpdate, undefined, "f");
+        }
+        __classPrivateFieldGet(this, _RemoteFeatureFlagController_instances, "m", _RemoteFeatureFlagController_updateCache).call(this, serverData.remoteFeatureFlags);
+    }
+    /**
+     * Enables the controller, allowing it to make network requests.
+     */
+    enable() {
+        __classPrivateFieldSet(this, _RemoteFeatureFlagController_disabled, false, "f");
+    }
+    /**
+     * Disables the controller, preventing it from making network requests.
+     */
+    disable() {
+        __classPrivateFieldSet(this, _RemoteFeatureFlagController_disabled, true, "f");
+    }
+}
+exports.RemoteFeatureFlagController = RemoteFeatureFlagController;
+_RemoteFeatureFlagController_fetchInterval = new WeakMap(), _RemoteFeatureFlagController_disabled = new WeakMap(), _RemoteFeatureFlagController_clientConfigApiService = new WeakMap(), _RemoteFeatureFlagController_inProgressFlagUpdate = new WeakMap(), _RemoteFeatureFlagController_instances = new WeakSet(), _RemoteFeatureFlagController_isCacheExpired = function _RemoteFeatureFlagController_isCacheExpired() {
+    return Date.now() - this.state.cacheTimestamp > __classPrivateFieldGet(this, _RemoteFeatureFlagController_fetchInterval, "f");
+}, _RemoteFeatureFlagController_updateCache = function _RemoteFeatureFlagController_updateCache(remoteFeatureFlags) {
+    this.update(() => {
+        return {
+            remoteFeatureFlags,
+            cacheTimestamp: Date.now(),
+        };
+    });
+};
+//# sourceMappingURL=remote-feature-flag-controller.cjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"remote-feature-flag-controller.cjs","sourceRoot":"","sources":["../src/remote-feature-flag-controller.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAKA,+DAA2D;AAQ3D,kBAAkB;AAEL,QAAA,cAAc,GAAG,6BAA6B,CAAC;AAC/C,QAAA,sBAAsB,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,QAAQ;AASnE,MAAM,mCAAmC,GAAG;IAC1C,kBAAkB,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;IACtD,cAAc,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;CACnD,CAAC;AAwCF;;;;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;IASC;;;;;;;;;OASG;IACH,YAAY,EACV,SAAS,EACT,KAAK,EACL,sBAAsB,EACtB,aAAa,GAAG,8BAAsB,EACtC,QAAQ,GAAG,KAAK,GAOjB;QACC,KAAK,CAAC;YACJ,IAAI,EAAE,sBAAc;YACpB,QAAQ,EAAE,mCAAmC;YAC7C,SAAS;YACT,KAAK,EAAE;gBACL,GAAG,0CAA0C,EAAE;gBAC/C,GAAG,KAAK;aACT;SACF,CAAC,CAAC;;QAvCI,6DAAuB;QAEhC,wDAAmB;QAEnB,sEAAwD;QAExD,oEAAiD;QAmC/C,uBAAA,IAAI,8CAAkB,aAAa,MAAA,CAAC;QACpC,uBAAA,IAAI,yCAAa,QAAQ,MAAA,CAAC;QAC1B,uBAAA,IAAI,uDAA2B,sBAAsB,MAAA,CAAC;IACxD,CAAC;IAYD;;;;;OAKG;IACH,KAAK,CAAC,wBAAwB;QAC5B,IAAI,uBAAA,IAAI,6CAAU,IAAI,CAAC,uBAAA,IAAI,2FAAgB,MAApB,IAAI,CAAkB,EAAE;YAC7C,OAAO;SACR;QAED,IAAI,UAAU,CAAC;QAEf,IAAI,uBAAA,IAAI,yDAAsB,EAAE;YAC9B,MAAM,uBAAA,IAAI,yDAAsB,CAAC;YACjC,OAAO;SACR;QAED,IAAI;YACF,uBAAA,IAAI,qDACF,uBAAA,IAAI,2DAAwB,CAAC,uBAAuB,EAAE,MAAA,CAAC;YAEzD,UAAU,GAAG,MAAM,uBAAA,IAAI,yDAAsB,CAAC;SAC/C;gBAAS;YACR,uBAAA,IAAI,qDAAyB,SAAS,MAAA,CAAC;SACxC;QAED,uBAAA,IAAI,wFAAa,MAAjB,IAAI,EAAc,UAAU,CAAC,kBAAkB,CAAC,CAAC;IACnD,CAAC;IAiBD;;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;AAvHD,kEAuHC;;IA7DG,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,GAAG,uBAAA,IAAI,kDAAe,CAAC;AACtE,CAAC,+FAsCY,kBAAgC;IAC3C,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE;QACf,OAAO;YACL,kBAAkB;YAClB,cAAc,EAAE,IAAI,CAAC,GAAG,EAAE;SAC3B,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  RestrictedControllerMessenger,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\n\nimport type { AbstractClientConfigApiService } from './client-config-api-service/abstract-client-config-api-service';\nimport type {\n  FeatureFlags,\n  ServiceResponse,\n} from './remote-feature-flag-controller-types';\n\n// === GENERAL ===\n\nexport const 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: { persist: true, anonymous: true },\n  cacheTimestamp: { persist: true, anonymous: true },\n};\n\n// === MESSENGER ===\n\nexport type RemoteFeatureFlagControllerGetStateAction =\n  ControllerGetStateAction<\n    typeof controllerName,\n    RemoteFeatureFlagControllerState\n  >;\n\nexport type RemoteFeatureFlagControllerGetRemoteFeatureFlagAction = {\n  type: `${typeof controllerName}:updateRemoteFeatureFlags`;\n  handler: RemoteFeatureFlagController['updateRemoteFeatureFlags'];\n};\n\nexport type RemoteFeatureFlagControllerActions =\n  RemoteFeatureFlagControllerGetStateAction;\n\nexport type AllowedActions = never;\n\nexport type RemoteFeatureFlagControllerStateChangeEvent =\n  ControllerStateChangeEvent<\n    typeof controllerName,\n    RemoteFeatureFlagControllerState\n  >;\n\nexport type RemoteFeatureFlagControllerEvents =\n  RemoteFeatureFlagControllerStateChangeEvent;\n\nexport type AllowedEvents = never;\n\nexport type RemoteFeatureFlagControllerMessenger =\n  RestrictedControllerMessenger<\n    typeof controllerName,\n    RemoteFeatureFlagControllerActions | AllowedActions,\n    RemoteFeatureFlagControllerEvents | AllowedEvents,\n    AllowedActions['type'],\n    AllowedEvents['type']\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  #clientConfigApiService: AbstractClientConfigApiService;\n\n  #inProgressFlagUpdate?: Promise<ServiceResponse>;\n\n  /**\n   * Constructs a new RemoteFeatureFlagController instance.\n   *\n   * @param options - The controller options.\n   * @param options.messenger - The controller 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   */\n  constructor({\n    messenger,\n    state,\n    clientConfigApiService,\n    fetchInterval = DEFAULT_CACHE_DURATION,\n    disabled = false,\n  }: {\n    messenger: RemoteFeatureFlagControllerMessenger;\n    state?: Partial<RemoteFeatureFlagControllerState>;\n    clientConfigApiService: AbstractClientConfigApiService;\n    fetchInterval?: number;\n    disabled?: boolean;\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  }\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   * @private\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    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   * @private\n   */\n  #updateCache(remoteFeatureFlags: FeatureFlags) {\n    this.update(() => {\n      return {\n        remoteFeatureFlags,\n        cacheTimestamp: Date.now(),\n      };\n    });\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.d.cts

@@ -0,0 +1,69 @@
+import type { ControllerGetStateAction, ControllerStateChangeEvent, RestrictedControllerMessenger } from "@metamask/base-controller";
+import { BaseController } from "@metamask/base-controller";
+import type { AbstractClientConfigApiService } from "./client-config-api-service/abstract-client-config-api-service.cjs";
+import type { FeatureFlags } from "./remote-feature-flag-controller-types.cjs";
+export declare const controllerName = "RemoteFeatureFlagController";
+export declare const DEFAULT_CACHE_DURATION: number;
+export type RemoteFeatureFlagControllerState = {
+    remoteFeatureFlags: FeatureFlags;
+    cacheTimestamp: number;
+};
+export type RemoteFeatureFlagControllerGetStateAction = ControllerGetStateAction<typeof controllerName, RemoteFeatureFlagControllerState>;
+export type RemoteFeatureFlagControllerGetRemoteFeatureFlagAction = {
+    type: `${typeof controllerName}:updateRemoteFeatureFlags`;
+    handler: RemoteFeatureFlagController['updateRemoteFeatureFlags'];
+};
+export type RemoteFeatureFlagControllerActions = RemoteFeatureFlagControllerGetStateAction;
+export type AllowedActions = never;
+export type RemoteFeatureFlagControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, RemoteFeatureFlagControllerState>;
+export type RemoteFeatureFlagControllerEvents = RemoteFeatureFlagControllerStateChangeEvent;
+export type AllowedEvents = never;
+export type RemoteFeatureFlagControllerMessenger = RestrictedControllerMessenger<typeof controllerName, RemoteFeatureFlagControllerActions | AllowedActions, RemoteFeatureFlagControllerEvents | AllowedEvents, AllowedActions['type'], AllowedEvents['type']>;
+/**
+ * Returns the default state for the RemoteFeatureFlagController.
+ *
+ * @returns The default controller state.
+ */
+export declare function getDefaultRemoteFeatureFlagControllerState(): RemoteFeatureFlagControllerState;
+/**
+ * The RemoteFeatureFlagController manages the retrieval and caching of remote feature flags.
+ * It fetches feature flags from a remote API, caches them, and provides methods to access
+ * and manage these flags. The controller ensures that feature flags are refreshed based on
+ * a specified interval and handles cases where the controller is disabled or the network is unavailable.
+ */
+export declare class RemoteFeatureFlagController extends BaseController<typeof controllerName, RemoteFeatureFlagControllerState, RemoteFeatureFlagControllerMessenger> {
+    #private;
+    /**
+     * Constructs a new RemoteFeatureFlagController instance.
+     *
+     * @param options - The controller options.
+     * @param options.messenger - The controller messenger used for communication.
+     * @param options.state - The initial state of the controller.
+     * @param options.clientConfigApiService - The service instance to fetch remote feature flags.
+     * @param options.fetchInterval - The interval in milliseconds before cached flags expire. Defaults to 1 day.
+     * @param options.disabled - Determines if the controller should be disabled initially. Defaults to false.
+     */
+    constructor({ messenger, state, clientConfigApiService, fetchInterval, disabled, }: {
+        messenger: RemoteFeatureFlagControllerMessenger;
+        state?: Partial<RemoteFeatureFlagControllerState>;
+        clientConfigApiService: AbstractClientConfigApiService;
+        fetchInterval?: number;
+        disabled?: boolean;
+    });
+    /**
+     * Retrieves the remote feature flags, fetching from the API if necessary.
+     * Uses caching to prevent redundant API calls and handles concurrent fetches.
+     *
+     * @returns A promise that resolves to the current set of feature flags.
+     */
+    updateRemoteFeatureFlags(): Promise<void>;
+    /**
+     * Enables the controller, allowing it to make network requests.
+     */
+    enable(): void;
+    /**
+     * Disables the controller, preventing it from making network requests.
+     */
+    disable(): void;
+}
+//# sourceMappingURL=remote-feature-flag-controller.d.cts.map

package/dist/remote-feature-flag-controller.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"remote-feature-flag-controller.d.cts","sourceRoot":"","sources":["../src/remote-feature-flag-controller.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAC1B,6BAA6B,EAC9B,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAE3D,OAAO,KAAK,EAAE,8BAA8B,EAAE,2EAAuE;AACrH,OAAO,KAAK,EACV,YAAY,EAEb,mDAA+C;AAIhD,eAAO,MAAM,cAAc,gCAAgC,CAAC;AAC5D,eAAO,MAAM,sBAAsB,QAAsB,CAAC;AAI1D,MAAM,MAAM,gCAAgC,GAAG;IAC7C,kBAAkB,EAAE,YAAY,CAAC;IACjC,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AASF,MAAM,MAAM,yCAAyC,GACnD,wBAAwB,CACtB,OAAO,cAAc,EACrB,gCAAgC,CACjC,CAAC;AAEJ,MAAM,MAAM,qDAAqD,GAAG;IAClE,IAAI,EAAE,GAAG,OAAO,cAAc,2BAA2B,CAAC;IAC1D,OAAO,EAAE,2BAA2B,CAAC,0BAA0B,CAAC,CAAC;CAClE,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAC5C,yCAAyC,CAAC;AAE5C,MAAM,MAAM,cAAc,GAAG,KAAK,CAAC;AAEnC,MAAM,MAAM,2CAA2C,GACrD,0BAA0B,CACxB,OAAO,cAAc,EACrB,gCAAgC,CACjC,CAAC;AAEJ,MAAM,MAAM,iCAAiC,GAC3C,2CAA2C,CAAC;AAE9C,MAAM,MAAM,aAAa,GAAG,KAAK,CAAC;AAElC,MAAM,MAAM,oCAAoC,GAC9C,6BAA6B,CAC3B,OAAO,cAAc,EACrB,kCAAkC,GAAG,cAAc,EACnD,iCAAiC,GAAG,aAAa,EACjD,cAAc,CAAC,MAAM,CAAC,EACtB,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAEJ;;;;GAIG;AACH,wBAAgB,0CAA0C,IAAI,gCAAgC,CAK7F;AAED;;;;;GAKG;AACH,qBAAa,2BAA4B,SAAQ,cAAc,CAC7D,OAAO,cAAc,EACrB,gCAAgC,EAChC,oCAAoC,CACrC;;IASC;;;;;;;;;OASG;gBACS,EACV,SAAS,EACT,KAAK,EACL,sBAAsB,EACtB,aAAsC,EACtC,QAAgB,GACjB,EAAE;QACD,SAAS,EAAE,oCAAoC,CAAC;QAChD,KAAK,CAAC,EAAE,OAAO,CAAC,gCAAgC,CAAC,CAAC;QAClD,sBAAsB,EAAE,8BAA8B,CAAC;QACvD,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB;IA0BD;;;;;OAKG;IACG,wBAAwB,IAAI,OAAO,CAAC,IAAI,CAAC;IAuC/C;;OAEG;IACH,MAAM,IAAI,IAAI;IAId;;OAEG;IACH,OAAO,IAAI,IAAI;CAGhB"}