@metamask-previews/remote-feature-flag-controller 6.1.1-preview-abca9bcea → 7.0.0-preview-0a30e47
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +19 -1
- package/dist/client-config-api-service/{abstract-client-config-api-service.d.mts → abstract-client-config-api-service.d.ts} +3 -3
- package/dist/client-config-api-service/abstract-client-config-api-service.d.ts.map +1 -0
- package/dist/client-config-api-service/abstract-client-config-api-service.js +2 -0
- package/dist/client-config-api-service/abstract-client-config-api-service.js.map +1 -0
- package/dist/client-config-api-service/{client-config-api-service.d.cts → client-config-api-service.d.ts} +5 -5
- package/dist/client-config-api-service/client-config-api-service.d.ts.map +1 -0
- package/dist/client-config-api-service/client-config-api-service.js +86 -0
- package/dist/client-config-api-service/client-config-api-service.js.map +1 -0
- package/dist/{constants.d.cts → constants.d.ts} +1 -1
- package/dist/constants.d.ts.map +1 -0
- package/dist/{constants.mjs → constants.js} +1 -1
- package/dist/constants.js.map +1 -0
- package/dist/index.d.ts +8 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +5 -0
- package/dist/index.js.map +1 -0
- package/dist/{remote-feature-flag-controller-method-action-types.d.cts → remote-feature-flag-controller-method-action-types.d.ts} +2 -2
- package/dist/remote-feature-flag-controller-method-action-types.d.ts.map +1 -0
- package/dist/{remote-feature-flag-controller-method-action-types.mjs → remote-feature-flag-controller-method-action-types.js} +1 -1
- package/dist/remote-feature-flag-controller-method-action-types.js.map +1 -0
- package/dist/{remote-feature-flag-controller-types.d.mts → remote-feature-flag-controller-types.d.ts} +2 -2
- package/dist/remote-feature-flag-controller-types.d.ts.map +1 -0
- package/dist/{remote-feature-flag-controller-types.mjs → remote-feature-flag-controller-types.js} +1 -1
- package/dist/remote-feature-flag-controller-types.js.map +1 -0
- package/dist/{remote-feature-flag-controller.d.cts → remote-feature-flag-controller.d.ts} +8 -8
- package/dist/remote-feature-flag-controller.d.ts.map +1 -0
- package/dist/remote-feature-flag-controller.js +470 -0
- package/dist/{remote-feature-flag-controller.cjs.map → remote-feature-flag-controller.js.map} +1 -1
- package/dist/utils/{user-segmentation-utils.d.cts → user-segmentation-utils.d.ts} +3 -3
- package/dist/utils/user-segmentation-utils.d.ts.map +1 -0
- package/dist/utils/{user-segmentation-utils.mjs → user-segmentation-utils.js} +5 -5
- package/dist/utils/user-segmentation-utils.js.map +1 -0
- package/dist/utils/{version.d.cts → version.d.ts} +4 -4
- package/dist/utils/version.d.ts.map +1 -0
- package/dist/utils/{version.mjs → version.js} +2 -2
- package/dist/utils/version.js.map +1 -0
- package/package.json +16 -20
- package/dist/client-config-api-service/abstract-client-config-api-service.cjs +0 -3
- package/dist/client-config-api-service/abstract-client-config-api-service.cjs.map +0 -1
- package/dist/client-config-api-service/abstract-client-config-api-service.d.cts +0 -17
- package/dist/client-config-api-service/abstract-client-config-api-service.d.cts.map +0 -1
- package/dist/client-config-api-service/abstract-client-config-api-service.d.mts.map +0 -1
- package/dist/client-config-api-service/abstract-client-config-api-service.mjs +0 -2
- package/dist/client-config-api-service/abstract-client-config-api-service.mjs.map +0 -1
- package/dist/client-config-api-service/client-config-api-service.cjs +0 -94
- package/dist/client-config-api-service/client-config-api-service.cjs.map +0 -1
- package/dist/client-config-api-service/client-config-api-service.d.cts.map +0 -1
- package/dist/client-config-api-service/client-config-api-service.d.mts +0 -108
- package/dist/client-config-api-service/client-config-api-service.d.mts.map +0 -1
- package/dist/client-config-api-service/client-config-api-service.mjs +0 -90
- package/dist/client-config-api-service/client-config-api-service.mjs.map +0 -1
- package/dist/constants.cjs +0 -8
- package/dist/constants.cjs.map +0 -1
- package/dist/constants.d.cts.map +0 -1
- package/dist/constants.d.mts +0 -5
- package/dist/constants.d.mts.map +0 -1
- package/dist/constants.mjs.map +0 -1
- package/dist/index.cjs +0 -15
- package/dist/index.cjs.map +0 -1
- package/dist/index.d.cts +0 -8
- package/dist/index.d.cts.map +0 -1
- package/dist/index.d.mts +0 -8
- package/dist/index.d.mts.map +0 -1
- package/dist/index.mjs +0 -5
- package/dist/index.mjs.map +0 -1
- package/dist/remote-feature-flag-controller-method-action-types.cjs +0 -7
- package/dist/remote-feature-flag-controller-method-action-types.cjs.map +0 -1
- package/dist/remote-feature-flag-controller-method-action-types.d.cts.map +0 -1
- package/dist/remote-feature-flag-controller-method-action-types.d.mts +0 -62
- package/dist/remote-feature-flag-controller-method-action-types.d.mts.map +0 -1
- package/dist/remote-feature-flag-controller-method-action-types.mjs.map +0 -1
- package/dist/remote-feature-flag-controller-types.cjs +0 -32
- package/dist/remote-feature-flag-controller-types.cjs.map +0 -1
- package/dist/remote-feature-flag-controller-types.d.cts +0 -64
- package/dist/remote-feature-flag-controller-types.d.cts.map +0 -1
- package/dist/remote-feature-flag-controller-types.d.mts.map +0 -1
- package/dist/remote-feature-flag-controller-types.mjs.map +0 -1
- package/dist/remote-feature-flag-controller.cjs +0 -453
- package/dist/remote-feature-flag-controller.d.cts.map +0 -1
- package/dist/remote-feature-flag-controller.d.mts +0 -113
- package/dist/remote-feature-flag-controller.d.mts.map +0 -1
- package/dist/remote-feature-flag-controller.mjs +0 -448
- package/dist/remote-feature-flag-controller.mjs.map +0 -1
- package/dist/utils/user-segmentation-utils.cjs +0 -107
- package/dist/utils/user-segmentation-utils.cjs.map +0 -1
- package/dist/utils/user-segmentation-utils.d.cts.map +0 -1
- package/dist/utils/user-segmentation-utils.d.mts +0 -34
- package/dist/utils/user-segmentation-utils.d.mts.map +0 -1
- package/dist/utils/user-segmentation-utils.mjs.map +0 -1
- package/dist/utils/version.cjs +0 -78
- package/dist/utils/version.cjs.map +0 -1
- package/dist/utils/version.d.cts.map +0 -1
- package/dist/utils/version.d.mts +0 -26
- package/dist/utils/version.d.mts.map +0 -1
- package/dist/utils/version.mjs.map +0 -1
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"user-segmentation-utils.d.cts","sourceRoot":"","sources":["../../src/utils/user-segmentation-utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAI5C,OAAO,KAAK,EAAE,qBAAqB,EAAE,oDAAmD;AAkBxF;;;;;;;;;GASG;AACH,wBAAsB,yBAAyB,CAC7C,cAAc,EAAE,MAAM,EACtB,eAAe,EAAE,MAAM,GACtB,OAAO,CAAC,MAAM,CAAC,CAsBjB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,iCAAiC,CAC/C,aAAa,EAAE,MAAM,GACpB,MAAM,CA0CR;AAED;;;;;;GAMG;AACH,eAAO,MAAM,2BAA2B,gBACzB,IAAI,yCAOlB,CAAC"}
|
|
@@ -1,34 +0,0 @@
|
|
|
1
|
-
import type { Json } from "@metamask/utils";
|
|
2
|
-
import type { FeatureFlagScopeValue } from "../remote-feature-flag-controller-types.mjs";
|
|
3
|
-
/**
|
|
4
|
-
* Calculates a deterministic threshold value between 0 and 1 for A/B testing.
|
|
5
|
-
* This function hashes the segmentation ID combined with the feature flag name
|
|
6
|
-
* to ensure consistent group assignment across sessions while varying across different flags.
|
|
7
|
-
*
|
|
8
|
-
* @param segmentationId - The identifier used for threshold segmentation (must be non-empty)
|
|
9
|
-
* @param featureFlagName - The feature flag name to create unique threshold per flag
|
|
10
|
-
* @returns A promise that resolves to a number between 0 and 1
|
|
11
|
-
* @throws Error if segmentationId is empty
|
|
12
|
-
*/
|
|
13
|
-
export declare function calculateThresholdForFlag(segmentationId: string, featureFlagName: string): Promise<number>;
|
|
14
|
-
/**
|
|
15
|
-
* Generates a deterministic random number between 0 and 1 based on a metaMetricsId.
|
|
16
|
-
* This is useful for A/B testing and feature flag rollouts where we want
|
|
17
|
-
* consistent group assignment for the same user.
|
|
18
|
-
*
|
|
19
|
-
* @param metaMetricsId - The unique identifier used to generate the deterministic random number. Must be either:
|
|
20
|
-
* - A UUIDv4 string (e.g., '123e4567-e89b-12d3-a456-426614174000'
|
|
21
|
-
* - A hex string with '0x' prefix (e.g., '0x86bacb9b2bf9a7e8d2b147eadb95ac9aaa26842327cd24afc8bd4b3c1d136420')
|
|
22
|
-
* @returns A number between 0 and 1, deterministically generated from the input ID.
|
|
23
|
-
* The same input will always produce the same output.
|
|
24
|
-
*/
|
|
25
|
-
export declare function generateDeterministicRandomNumber(metaMetricsId: string): number;
|
|
26
|
-
/**
|
|
27
|
-
* Type guard to check if a value is a feature flag with scope.
|
|
28
|
-
* Used to validate feature flag objects that contain scope-based configurations.
|
|
29
|
-
*
|
|
30
|
-
* @param featureFlag - The value to check if it's a feature flag with scope
|
|
31
|
-
* @returns True if the value is a feature flag with scope, false otherwise
|
|
32
|
-
*/
|
|
33
|
-
export declare const isFeatureFlagWithScopeValue: (featureFlag: Json) => featureFlag is FeatureFlagScopeValue;
|
|
34
|
-
//# sourceMappingURL=user-segmentation-utils.d.mts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"user-segmentation-utils.d.mts","sourceRoot":"","sources":["../../src/utils/user-segmentation-utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAI5C,OAAO,KAAK,EAAE,qBAAqB,EAAE,oDAAmD;AAkBxF;;;;;;;;;GASG;AACH,wBAAsB,yBAAyB,CAC7C,cAAc,EAAE,MAAM,EACtB,eAAe,EAAE,MAAM,GACtB,OAAO,CAAC,MAAM,CAAC,CAsBjB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,iCAAiC,CAC/C,aAAa,EAAE,MAAM,GACpB,MAAM,CA0CR;AAED;;;;;;GAMG;AACH,eAAO,MAAM,2BAA2B,gBACzB,IAAI,yCAOlB,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"user-segmentation-utils.mjs","sourceRoot":"","sources":["../../src/utils/user-segmentation-utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,wBAAwB;AACrD,OAAO,EAAE,QAAQ,IAAI,YAAY,EAAE,OAAO,IAAI,WAAW,EAAE,aAAa;AAIxE;;;;;GAKG;AACH,SAAS,kBAAkB,CAAC,IAAY;IACtC,OAAO,MAAM,CAAC,KAAK,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;AAChD,CAAC;AAED,MAAM,WAAW,GAAG,sCAAsC,CAAC;AAC3D,MAAM,WAAW,GAAG,sCAAsC,CAAC;AAC3D,MAAM,kBAAkB,GAAG,kBAAkB,CAAC,WAAW,CAAC,CAAC;AAC3D,MAAM,kBAAkB,GAAG,kBAAkB,CAAC,WAAW,CAAC,CAAC;AAC3D,MAAM,0BAA0B,GAAG,kBAAkB,GAAG,kBAAkB,CAAC;AAE3E;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAC7C,cAAsB,EACtB,eAAuB;IAEvB,IAAI,CAAC,cAAc,EAAE,CAAC;QACpB,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;IACrD,CAAC;IAED,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;IACvD,CAAC;IAED,MAAM,IAAI,GAAG,cAAc,GAAG,eAAe,CAAC;IAE9C,yBAAyB;IACzB,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;IAClC,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IAEtD,2CAA2C;IAC3C,MAAM,IAAI,GAAG,UAAU,CAAC,UAAU,CAAC,CAAC;IACpC,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;IAChC,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IAE/C,0EAA0E;IAC1E,OAAO,MAAM,CAAC,CAAC,UAAU,GAAG,MAAM,CAAC,OAAS,CAAC,CAAC,GAAG,QAAQ,CAAC,GAAG,OAAS,CAAC;AACzE,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,iCAAiC,CAC/C,aAAqB;IAErB,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;IACpD,CAAC;IAED,IAAI,OAAe,CAAC;IACpB,IAAI,QAAgB,CAAC;IAErB,gBAAgB;IAChB,IAAI,YAAY,CAAC,aAAa,CAAC,EAAE,CAAC;QAChC,IAAI,WAAW,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CACb,2CAA2C,WAAW,CAAC,aAAa,CAAC,EAAE,CACxE,CAAC;QACJ,CAAC;QACD,OAAO,GAAG,kBAAkB,CAAC,aAAa,CAAC,GAAG,kBAAkB,CAAC;QACjE,QAAQ,GAAG,0BAA0B,CAAC;IACxC,CAAC;SAAM,CAAC;QACN,4BAA4B;QAC5B,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YACpC,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;QACtD,CAAC;QAED,MAAM,OAAO,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACvC,MAAM,mBAAmB,GAAG,EAAE,CAAC,CAAC,+BAA+B;QAE/D,IAAI,OAAO,CAAC,MAAM,KAAK,mBAAmB,EAAE,CAAC;YAC3C,MAAM,IAAI,KAAK,CACb,mCAAmC,mBAAmB,oBAAoB,OAAO,CAAC,MAAM,EAAE,CAC3F,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YACnC,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;QACxD,CAAC;QAED,OAAO,GAAG,MAAM,CAAC,KAAK,OAAO,EAAE,CAAC,CAAC;QACjC,QAAQ,GAAG,MAAM,CAAC,KAAK,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACvD,CAAC;IAED,0EAA0E;IAC1E,OAAO,MAAM,CAAC,CAAC,OAAO,GAAG,MAAM,CAAC,OAAS,CAAC,CAAC,GAAG,QAAQ,CAAC,GAAG,OAAS,CAAC;AACtE,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CACzC,WAAiB,EACqB,EAAE;IACxC,OAAO,CACL,OAAO,WAAW,KAAK,QAAQ;QAC/B,WAAW,KAAK,IAAI;QACpB,OAAO,IAAI,WAAW,CACvB,CAAC;AACJ,CAAC,CAAC","sourcesContent":["import type { Json } from '@metamask/utils';\nimport { sha256, bytesToHex } from '@metamask/utils';\nimport { validate as uuidValidate, version as uuidVersion } from 'uuid';\n\nimport type { FeatureFlagScopeValue } from '../remote-feature-flag-controller-types.js';\n\n/**\n * Converts a UUID string to a BigInt by removing dashes and converting to hexadecimal.\n *\n * @param uuid - The UUID string to convert\n * @returns The UUID as a BigInt value\n */\nfunction uuidStringToBigInt(uuid: string): bigint {\n return BigInt(`0x${uuid.replace(/-/gu, '')}`);\n}\n\nconst MIN_UUID_V4 = '00000000-0000-4000-8000-000000000000';\nconst MAX_UUID_V4 = 'ffffffff-ffff-4fff-bfff-ffffffffffff';\nconst MIN_UUID_V4_BIGINT = uuidStringToBigInt(MIN_UUID_V4);\nconst MAX_UUID_V4_BIGINT = uuidStringToBigInt(MAX_UUID_V4);\nconst UUID_V4_VALUE_RANGE_BIGINT = MAX_UUID_V4_BIGINT - MIN_UUID_V4_BIGINT;\n\n/**\n * Calculates a deterministic threshold value between 0 and 1 for A/B testing.\n * This function hashes the segmentation ID combined with the feature flag name\n * to ensure consistent group assignment across sessions while varying across different flags.\n *\n * @param segmentationId - The identifier used for threshold segmentation (must be non-empty)\n * @param featureFlagName - The feature flag name to create unique threshold per flag\n * @returns A promise that resolves to a number between 0 and 1\n * @throws Error if segmentationId is empty\n */\nexport async function calculateThresholdForFlag(\n segmentationId: string,\n featureFlagName: string,\n): Promise<number> {\n if (!segmentationId) {\n throw new Error('Segmentation ID cannot be empty');\n }\n\n if (!featureFlagName) {\n throw new Error('Feature flag name cannot be empty');\n }\n\n const seed = segmentationId + featureFlagName;\n\n // Hash the combined seed\n const encoder = new TextEncoder();\n const hashBuffer = await sha256(encoder.encode(seed));\n\n // Convert hash bytes directly to 0-1 range\n const hash = bytesToHex(hashBuffer);\n const hashBigInt = BigInt(hash);\n const maxValue = BigInt(`0x${'f'.repeat(64)}`);\n\n // Use BigInt division first, then convert to number to maintain precision\n return Number((hashBigInt * BigInt(1_000_000)) / maxValue) / 1_000_000;\n}\n\n/**\n * Generates a deterministic random number between 0 and 1 based on a metaMetricsId.\n * This is useful for A/B testing and feature flag rollouts where we want\n * consistent group assignment for the same user.\n *\n * @param metaMetricsId - The unique identifier used to generate the deterministic random number. Must be either:\n * - A UUIDv4 string (e.g., '123e4567-e89b-12d3-a456-426614174000'\n * - A hex string with '0x' prefix (e.g., '0x86bacb9b2bf9a7e8d2b147eadb95ac9aaa26842327cd24afc8bd4b3c1d136420')\n * @returns A number between 0 and 1, deterministically generated from the input ID.\n * The same input will always produce the same output.\n */\nexport function generateDeterministicRandomNumber(\n metaMetricsId: string,\n): number {\n if (!metaMetricsId) {\n throw new Error('MetaMetrics ID cannot be empty');\n }\n\n let idValue: bigint;\n let maxValue: bigint;\n\n // uuidv4 format\n if (uuidValidate(metaMetricsId)) {\n if (uuidVersion(metaMetricsId) !== 4) {\n throw new Error(\n `Invalid UUID version. Expected v4, got v${uuidVersion(metaMetricsId)}`,\n );\n }\n idValue = uuidStringToBigInt(metaMetricsId) - MIN_UUID_V4_BIGINT;\n maxValue = UUID_V4_VALUE_RANGE_BIGINT;\n } else {\n // hex format with 0x prefix\n if (!metaMetricsId.startsWith('0x')) {\n throw new Error('Hex ID must start with 0x prefix');\n }\n\n const cleanId = metaMetricsId.slice(2);\n const EXPECTED_HEX_LENGTH = 64; // 32 bytes = 64 hex characters\n\n if (cleanId.length !== EXPECTED_HEX_LENGTH) {\n throw new Error(\n `Invalid hex ID length. Expected ${EXPECTED_HEX_LENGTH} characters, got ${cleanId.length}`,\n );\n }\n\n if (!/^[0-9a-f]+$/iu.test(cleanId)) {\n throw new Error('Hex ID contains invalid characters');\n }\n\n idValue = BigInt(`0x${cleanId}`);\n maxValue = BigInt(`0x${'f'.repeat(cleanId.length)}`);\n }\n\n // Use BigInt division first, then convert to number to maintain precision\n return Number((idValue * BigInt(1_000_000)) / maxValue) / 1_000_000;\n}\n\n/**\n * Type guard to check if a value is a feature flag with scope.\n * Used to validate feature flag objects that contain scope-based configurations.\n *\n * @param featureFlag - The value to check if it's a feature flag with scope\n * @returns True if the value is a feature flag with scope, false otherwise\n */\nexport const isFeatureFlagWithScopeValue = (\n featureFlag: Json,\n): featureFlag is FeatureFlagScopeValue => {\n return (\n typeof featureFlag === 'object' &&\n featureFlag !== null &&\n 'scope' in featureFlag\n );\n};\n"]}
|
package/dist/utils/version.cjs
DELETED
|
@@ -1,78 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.getVersionData = exports.isVersionFeatureFlag = exports.MULTI_VERSION_FLAG_KEYS = void 0;
|
|
4
|
-
const utils_1 = require("@metamask/utils");
|
|
5
|
-
/**
|
|
6
|
-
* Constants for MultiVersionFeatureFlagValue property names
|
|
7
|
-
* to ensure consistency across validation, type checking, and other usage.
|
|
8
|
-
*/
|
|
9
|
-
exports.MULTI_VERSION_FLAG_KEYS = {
|
|
10
|
-
VERSIONS: 'versions',
|
|
11
|
-
};
|
|
12
|
-
/**
|
|
13
|
-
* Checks if a feature flag value is a multi-version gated flag (contains versions object with valid SemVer keys).
|
|
14
|
-
*
|
|
15
|
-
* @param value - The feature flag value to check
|
|
16
|
-
* @returns true if the value is a multi-version feature flag with valid SemVer version keys, false otherwise
|
|
17
|
-
*/
|
|
18
|
-
function isVersionFeatureFlag(value) {
|
|
19
|
-
if (typeof value !== 'object' ||
|
|
20
|
-
value === null ||
|
|
21
|
-
Array.isArray(value) ||
|
|
22
|
-
!(exports.MULTI_VERSION_FLAG_KEYS.VERSIONS in value)) {
|
|
23
|
-
return false;
|
|
24
|
-
}
|
|
25
|
-
const versions = value[exports.MULTI_VERSION_FLAG_KEYS.VERSIONS];
|
|
26
|
-
if (typeof versions !== 'object' ||
|
|
27
|
-
versions === null ||
|
|
28
|
-
Array.isArray(versions)) {
|
|
29
|
-
return false;
|
|
30
|
-
}
|
|
31
|
-
// Validate that all version keys are valid SemVer versions
|
|
32
|
-
const versionKeys = Object.keys(versions);
|
|
33
|
-
return versionKeys.every((versionKey) => (0, utils_1.isValidSemVerVersion)(versionKey));
|
|
34
|
-
}
|
|
35
|
-
exports.isVersionFeatureFlag = isVersionFeatureFlag;
|
|
36
|
-
/**
|
|
37
|
-
* Selects the appropriate version value from a multi-version feature flag based on current app version.
|
|
38
|
-
* Returns the value from the highest version that the app version meets or exceeds.
|
|
39
|
-
*
|
|
40
|
-
* @param multiVersionFlag - The multi-version feature flag
|
|
41
|
-
* @param currentAppVersion - The current application version
|
|
42
|
-
* @returns The selected version value, or null if no version requirements are met
|
|
43
|
-
*/
|
|
44
|
-
function getVersionData(multiVersionFlag, currentAppVersion) {
|
|
45
|
-
const sortedVersions = getObjectEntries(multiVersionFlag.versions).sort(([versionA], [versionB]) => {
|
|
46
|
-
return isVersionAtLeast(versionA, versionB) ? -1 : 1;
|
|
47
|
-
});
|
|
48
|
-
for (const [version, data] of sortedVersions) {
|
|
49
|
-
if (isVersionAtLeast(currentAppVersion, version)) {
|
|
50
|
-
return data;
|
|
51
|
-
}
|
|
52
|
-
}
|
|
53
|
-
return null;
|
|
54
|
-
}
|
|
55
|
-
exports.getVersionData = getVersionData;
|
|
56
|
-
/**
|
|
57
|
-
* Compares two semantic version strings.
|
|
58
|
-
* Both versions are expected to be valid SemVer format (e.g., "13.9.5").
|
|
59
|
-
*
|
|
60
|
-
* @param currentVersion - The current version (e.g., "13.9.5")
|
|
61
|
-
* @param requiredVersion - The required minimum version (e.g., "13.10.0")
|
|
62
|
-
* @returns true if currentVersion >= requiredVersion, false otherwise
|
|
63
|
-
*/
|
|
64
|
-
function isVersionAtLeast(currentVersion, requiredVersion) {
|
|
65
|
-
return (currentVersion === requiredVersion ||
|
|
66
|
-
(0, utils_1.gtVersion)(currentVersion, requiredVersion));
|
|
67
|
-
}
|
|
68
|
-
/**
|
|
69
|
-
* A utility function that calls `Object.entries` while preserving the index type.
|
|
70
|
-
*
|
|
71
|
-
* @param input - The object to get the entries of.
|
|
72
|
-
* @returns - The object entries.
|
|
73
|
-
*/
|
|
74
|
-
function getObjectEntries(input) {
|
|
75
|
-
// Use cast to preserve index type. Object.entries always widens to string.
|
|
76
|
-
return Object.entries(input);
|
|
77
|
-
}
|
|
78
|
-
//# sourceMappingURL=version.cjs.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"version.cjs","sourceRoot":"","sources":["../../src/utils/version.ts"],"names":[],"mappings":";;;AAAA,2CAAkE;AAKlE;;;GAGG;AACU,QAAA,uBAAuB,GAAG;IACrC,QAAQ,EAAE,UAAU;CACZ,CAAC;AAEX;;;;;GAKG;AACH,SAAgB,oBAAoB,CAClC,KAAW;IAEX,IACE,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACd,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QACpB,CAAC,CAAC,+BAAuB,CAAC,QAAQ,IAAI,KAAK,CAAC,EAC5C,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,QAAQ,GAAG,KAAK,CAAC,+BAAuB,CAAC,QAAQ,CAAC,CAAC;IAEzD,IACE,OAAO,QAAQ,KAAK,QAAQ;QAC5B,QAAQ,KAAK,IAAI;QACjB,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EACvB,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,2DAA2D;IAC3D,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC1C,OAAO,WAAW,CAAC,KAAK,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,IAAA,4BAAoB,EAAC,UAAU,CAAC,CAAC,CAAC;AAC7E,CAAC;AAzBD,oDAyBC;AAED;;;;;;;GAOG;AACH,SAAgB,cAAc,CAC5B,gBAA8C,EAC9C,iBAAgC;IAEhC,MAAM,cAAc,GAAG,gBAAgB,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,IAAI,CACrE,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE;QACzB,OAAO,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACvD,CAAC,CACF,CAAC;IAEF,KAAK,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,cAAc,EAAE,CAAC;QAC7C,IAAI,gBAAgB,CAAC,iBAAiB,EAAE,OAAO,CAAC,EAAE,CAAC;YACjD,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAjBD,wCAiBC;AAED;;;;;;;GAOG;AACH,SAAS,gBAAgB,CACvB,cAA6B,EAC7B,eAA8B;IAE9B,OAAO,CACL,cAAc,KAAK,eAAe;QAClC,IAAA,iBAAS,EAAC,cAAc,EAAE,eAAe,CAAC,CAC3C,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAS,gBAAgB,CACvB,KAAY;IAEZ,2EAA2E;IAC3E,OAAO,MAAM,CAAC,OAAO,CAAC,KAAK,CAAwC,CAAC;AACtE,CAAC","sourcesContent":["import { gtVersion, isValidSemVerVersion } from '@metamask/utils';\nimport type { Json, SemVerVersion } from '@metamask/utils';\n\nimport type { MultiVersionFeatureFlagValue } from '../remote-feature-flag-controller-types.js';\n\n/**\n * Constants for MultiVersionFeatureFlagValue property names\n * to ensure consistency across validation, type checking, and other usage.\n */\nexport const MULTI_VERSION_FLAG_KEYS = {\n VERSIONS: 'versions',\n} as const;\n\n/**\n * Checks if a feature flag value is a multi-version gated flag (contains versions object with valid SemVer keys).\n *\n * @param value - The feature flag value to check\n * @returns true if the value is a multi-version feature flag with valid SemVer version keys, false otherwise\n */\nexport function isVersionFeatureFlag(\n value: Json,\n): value is MultiVersionFeatureFlagValue {\n if (\n typeof value !== 'object' ||\n value === null ||\n Array.isArray(value) ||\n !(MULTI_VERSION_FLAG_KEYS.VERSIONS in value)\n ) {\n return false;\n }\n\n const versions = value[MULTI_VERSION_FLAG_KEYS.VERSIONS];\n\n if (\n typeof versions !== 'object' ||\n versions === null ||\n Array.isArray(versions)\n ) {\n return false;\n }\n\n // Validate that all version keys are valid SemVer versions\n const versionKeys = Object.keys(versions);\n return versionKeys.every((versionKey) => isValidSemVerVersion(versionKey));\n}\n\n/**\n * Selects the appropriate version value from a multi-version feature flag based on current app version.\n * Returns the value from the highest version that the app version meets or exceeds.\n *\n * @param multiVersionFlag - The multi-version feature flag\n * @param currentAppVersion - The current application version\n * @returns The selected version value, or null if no version requirements are met\n */\nexport function getVersionData(\n multiVersionFlag: MultiVersionFeatureFlagValue,\n currentAppVersion: SemVerVersion,\n): Json | null {\n const sortedVersions = getObjectEntries(multiVersionFlag.versions).sort(\n ([versionA], [versionB]) => {\n return isVersionAtLeast(versionA, versionB) ? -1 : 1;\n },\n );\n\n for (const [version, data] of sortedVersions) {\n if (isVersionAtLeast(currentAppVersion, version)) {\n return data;\n }\n }\n\n return null;\n}\n\n/**\n * Compares two semantic version strings.\n * Both versions are expected to be valid SemVer format (e.g., \"13.9.5\").\n *\n * @param currentVersion - The current version (e.g., \"13.9.5\")\n * @param requiredVersion - The required minimum version (e.g., \"13.10.0\")\n * @returns true if currentVersion >= requiredVersion, false otherwise\n */\nfunction isVersionAtLeast(\n currentVersion: SemVerVersion,\n requiredVersion: SemVerVersion,\n): boolean {\n return (\n currentVersion === requiredVersion ||\n gtVersion(currentVersion, requiredVersion)\n );\n}\n\n/**\n * A utility function that calls `Object.entries` while preserving the index type.\n *\n * @param input - The object to get the entries of.\n * @returns - The object entries.\n */\nfunction getObjectEntries<Input extends Record<string, unknown>>(\n input: Input,\n): [keyof Input, Input[keyof Input]][] {\n // Use cast to preserve index type. Object.entries always widens to string.\n return Object.entries(input) as [keyof Input, Input[keyof Input]][];\n}\n"]}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"version.d.cts","sourceRoot":"","sources":["../../src/utils/version.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,aAAa,EAAE,wBAAwB;AAE3D,OAAO,KAAK,EAAE,4BAA4B,EAAE,oDAAmD;AAE/F;;;GAGG;AACH,eAAO,MAAM,uBAAuB;;CAE1B,CAAC;AAEX;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAClC,KAAK,EAAE,IAAI,GACV,KAAK,IAAI,4BAA4B,CAuBvC;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAC5B,gBAAgB,EAAE,4BAA4B,EAC9C,iBAAiB,EAAE,aAAa,GAC/B,IAAI,GAAG,IAAI,CAcb"}
|
package/dist/utils/version.d.mts
DELETED
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
import type { Json, SemVerVersion } from "@metamask/utils";
|
|
2
|
-
import type { MultiVersionFeatureFlagValue } from "../remote-feature-flag-controller-types.mjs";
|
|
3
|
-
/**
|
|
4
|
-
* Constants for MultiVersionFeatureFlagValue property names
|
|
5
|
-
* to ensure consistency across validation, type checking, and other usage.
|
|
6
|
-
*/
|
|
7
|
-
export declare const MULTI_VERSION_FLAG_KEYS: {
|
|
8
|
-
readonly VERSIONS: "versions";
|
|
9
|
-
};
|
|
10
|
-
/**
|
|
11
|
-
* Checks if a feature flag value is a multi-version gated flag (contains versions object with valid SemVer keys).
|
|
12
|
-
*
|
|
13
|
-
* @param value - The feature flag value to check
|
|
14
|
-
* @returns true if the value is a multi-version feature flag with valid SemVer version keys, false otherwise
|
|
15
|
-
*/
|
|
16
|
-
export declare function isVersionFeatureFlag(value: Json): value is MultiVersionFeatureFlagValue;
|
|
17
|
-
/**
|
|
18
|
-
* Selects the appropriate version value from a multi-version feature flag based on current app version.
|
|
19
|
-
* Returns the value from the highest version that the app version meets or exceeds.
|
|
20
|
-
*
|
|
21
|
-
* @param multiVersionFlag - The multi-version feature flag
|
|
22
|
-
* @param currentAppVersion - The current application version
|
|
23
|
-
* @returns The selected version value, or null if no version requirements are met
|
|
24
|
-
*/
|
|
25
|
-
export declare function getVersionData(multiVersionFlag: MultiVersionFeatureFlagValue, currentAppVersion: SemVerVersion): Json | null;
|
|
26
|
-
//# sourceMappingURL=version.d.mts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["../../src/utils/version.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,aAAa,EAAE,wBAAwB;AAE3D,OAAO,KAAK,EAAE,4BAA4B,EAAE,oDAAmD;AAE/F;;;GAGG;AACH,eAAO,MAAM,uBAAuB;;CAE1B,CAAC;AAEX;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAClC,KAAK,EAAE,IAAI,GACV,KAAK,IAAI,4BAA4B,CAuBvC;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAC5B,gBAAgB,EAAE,4BAA4B,EAC9C,iBAAiB,EAAE,aAAa,GAC/B,IAAI,GAAG,IAAI,CAcb"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"version.mjs","sourceRoot":"","sources":["../../src/utils/version.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,oBAAoB,EAAE,wBAAwB;AAKlE;;;GAGG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,QAAQ,EAAE,UAAU;CACZ,CAAC;AAEX;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAClC,KAAW;IAEX,IACE,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACd,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QACpB,CAAC,CAAC,uBAAuB,CAAC,QAAQ,IAAI,KAAK,CAAC,EAC5C,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,QAAQ,GAAG,KAAK,CAAC,uBAAuB,CAAC,QAAQ,CAAC,CAAC;IAEzD,IACE,OAAO,QAAQ,KAAK,QAAQ;QAC5B,QAAQ,KAAK,IAAI;QACjB,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EACvB,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,2DAA2D;IAC3D,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC1C,OAAO,WAAW,CAAC,KAAK,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC,CAAC;AAC7E,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,cAAc,CAC5B,gBAA8C,EAC9C,iBAAgC;IAEhC,MAAM,cAAc,GAAG,gBAAgB,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,IAAI,CACrE,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE;QACzB,OAAO,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACvD,CAAC,CACF,CAAC;IAEF,KAAK,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,cAAc,EAAE,CAAC;QAC7C,IAAI,gBAAgB,CAAC,iBAAiB,EAAE,OAAO,CAAC,EAAE,CAAC;YACjD,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,gBAAgB,CACvB,cAA6B,EAC7B,eAA8B;IAE9B,OAAO,CACL,cAAc,KAAK,eAAe;QAClC,SAAS,CAAC,cAAc,EAAE,eAAe,CAAC,CAC3C,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAS,gBAAgB,CACvB,KAAY;IAEZ,2EAA2E;IAC3E,OAAO,MAAM,CAAC,OAAO,CAAC,KAAK,CAAwC,CAAC;AACtE,CAAC","sourcesContent":["import { gtVersion, isValidSemVerVersion } from '@metamask/utils';\nimport type { Json, SemVerVersion } from '@metamask/utils';\n\nimport type { MultiVersionFeatureFlagValue } from '../remote-feature-flag-controller-types.js';\n\n/**\n * Constants for MultiVersionFeatureFlagValue property names\n * to ensure consistency across validation, type checking, and other usage.\n */\nexport const MULTI_VERSION_FLAG_KEYS = {\n VERSIONS: 'versions',\n} as const;\n\n/**\n * Checks if a feature flag value is a multi-version gated flag (contains versions object with valid SemVer keys).\n *\n * @param value - The feature flag value to check\n * @returns true if the value is a multi-version feature flag with valid SemVer version keys, false otherwise\n */\nexport function isVersionFeatureFlag(\n value: Json,\n): value is MultiVersionFeatureFlagValue {\n if (\n typeof value !== 'object' ||\n value === null ||\n Array.isArray(value) ||\n !(MULTI_VERSION_FLAG_KEYS.VERSIONS in value)\n ) {\n return false;\n }\n\n const versions = value[MULTI_VERSION_FLAG_KEYS.VERSIONS];\n\n if (\n typeof versions !== 'object' ||\n versions === null ||\n Array.isArray(versions)\n ) {\n return false;\n }\n\n // Validate that all version keys are valid SemVer versions\n const versionKeys = Object.keys(versions);\n return versionKeys.every((versionKey) => isValidSemVerVersion(versionKey));\n}\n\n/**\n * Selects the appropriate version value from a multi-version feature flag based on current app version.\n * Returns the value from the highest version that the app version meets or exceeds.\n *\n * @param multiVersionFlag - The multi-version feature flag\n * @param currentAppVersion - The current application version\n * @returns The selected version value, or null if no version requirements are met\n */\nexport function getVersionData(\n multiVersionFlag: MultiVersionFeatureFlagValue,\n currentAppVersion: SemVerVersion,\n): Json | null {\n const sortedVersions = getObjectEntries(multiVersionFlag.versions).sort(\n ([versionA], [versionB]) => {\n return isVersionAtLeast(versionA, versionB) ? -1 : 1;\n },\n );\n\n for (const [version, data] of sortedVersions) {\n if (isVersionAtLeast(currentAppVersion, version)) {\n return data;\n }\n }\n\n return null;\n}\n\n/**\n * Compares two semantic version strings.\n * Both versions are expected to be valid SemVer format (e.g., \"13.9.5\").\n *\n * @param currentVersion - The current version (e.g., \"13.9.5\")\n * @param requiredVersion - The required minimum version (e.g., \"13.10.0\")\n * @returns true if currentVersion >= requiredVersion, false otherwise\n */\nfunction isVersionAtLeast(\n currentVersion: SemVerVersion,\n requiredVersion: SemVerVersion,\n): boolean {\n return (\n currentVersion === requiredVersion ||\n gtVersion(currentVersion, requiredVersion)\n );\n}\n\n/**\n * A utility function that calls `Object.entries` while preserving the index type.\n *\n * @param input - The object to get the entries of.\n * @returns - The object entries.\n */\nfunction getObjectEntries<Input extends Record<string, unknown>>(\n input: Input,\n): [keyof Input, Input[keyof Input]][] {\n // Use cast to preserve index type. Object.entries always widens to string.\n return Object.entries(input) as [keyof Input, Input[keyof Input]][];\n}\n"]}
|