@microsoft/feature-management 1.0.0-preview.1 → 1.0.0

package/types/index.d.ts

@@ -11,6 +11,9 @@ interface IGettable {
     get<T>(key: string): T | undefined;
 }
 
+/**
+ * A feature flag is a named property that can be toggled to enable or disable some feature of an application.
+ */
 interface FeatureFlag {
     /**
      * An ID used to uniquely identify and reference the feature.
@@ -27,16 +30,27 @@ interface FeatureFlag {
     /**
      * A feature is OFF if enabled is false. If enabled is true, then the feature is ON if there are no conditions (null or empty) or if the conditions are satisfied.
      */
-    enabled: boolean;
+    enabled?: boolean;
     /**
-     * The declaration of conditions used to dynamically enable features.
+     * The declaration of conditions used to dynamically enable the feature.
      */
     conditions?: FeatureEnablementConditions;
+    /**
+     * The list of variants defined for this feature. A variant represents a configuration value of a feature flag that can be a string, a number, a boolean, or a JSON object.
+     */
+    variants?: Variant[];
+    /**
+     * Determines how variants should be allocated for the feature to various users.
+     */
+    allocation?: VariantAllocation;
+    /**
+     * The declaration of options used to configure telemetry for this feature.
+     */
+    telemetry?: TelemetryOptions;
 }
-declare enum RequirementType {
-    Any = "Any",
-    All = "All"
-}
+/**
+* The declaration of conditions used to dynamically enable the feature
+*/
 interface FeatureEnablementConditions {
     /**
      * Determines whether any or all registered client filters must be evaluated as true for the feature to be considered enabled.
@@ -47,15 +61,110 @@ interface FeatureEnablementConditions {
      */
     client_filters?: ClientFilter[];
 }
+type RequirementType = "Any" | "All";
 interface ClientFilter {
     /**
-     * The name used to refer to and require a client filter.
+     * The name used to refer to a client filter.
      */
     name: string;
     /**
-     * Custom parameters for a given client filter. A client filter can require any set of parameters of any type.
+     * Parameters for a given client filter. A client filter can require any set of parameters of any type.
      */
-    parameters?: unknown;
+    parameters?: Record<string, unknown>;
+}
+interface Variant {
+    /**
+     * The name used to refer to a feature variant.
+     */
+    name: string;
+    /**
+     * The configuration value for this feature variant.
+     */
+    configuration_value?: unknown;
+    /**
+     * The path to a configuration section used as the configuration value for this feature variant.
+     */
+    configuration_reference?: string;
+    /**
+     * Overrides the enabled state of the feature if the given variant is assigned. Does not override the state if value is None.
+     */
+    status_override?: "None" | "Enabled" | "Disabled";
+}
+/**
+* Determines how variants should be allocated for the feature to various users.
+*/
+interface VariantAllocation {
+    /**
+     * Specifies which variant should be used when the feature is considered disabled.
+     */
+    default_when_disabled?: string;
+    /**
+     * Specifies which variant should be used when the feature is considered enabled and no other allocation rules are applicable.
+     */
+    default_when_enabled?: string;
+    /**
+     * A list of objects, each containing a variant name and list of users for whom that variant should be used.
+     */
+    user?: UserAllocation[];
+    /**
+     * A list of objects, each containing a variant name and list of groups for which that variant should be used.
+     */
+    group?: GroupAllocation[];
+    /**
+     * A list of objects, each containing a variant name and percentage range for which that variant should be used.
+     */
+    percentile?: PercentileAllocation[];
+    /**
+     * The value percentile calculations are based on. The calculated percentile is consistent across features for a given user if the same nonempty seed is used.
+     */
+    seed?: string;
+}
+interface UserAllocation {
+    /**
+     * The name of the variant to use if the user allocation matches the current user.
+     */
+    variant: string;
+    /**
+     * Collection of users where if any match the current user, the variant specified in the user allocation is used.
+     */
+    users: string[];
+}
+interface GroupAllocation {
+    /**
+     * The name of the variant to use if the group allocation matches a group the current user is in.
+     */
+    variant: string;
+    /**
+     * Collection of groups where if the current user is in any of these groups, the variant specified in the group allocation is used.
+     */
+    groups: string[];
+}
+interface PercentileAllocation {
+    /**
+     * The name of the variant to use if the calculated percentile for the current user falls in the provided range.
+     */
+    variant: string;
+    /**
+     * The lower end of the percentage range for which this variant will be used.
+     */
+    from: number;
+    /**
+     * The upper end of the percentage range for which this variant will be used.
+     */
+    to: number;
+}
+/**
+* The declaration of options used to configure telemetry for this feature.
+*/
+interface TelemetryOptions {
+    /**
+     * Indicates if telemetry is enabled.
+     */
+    enabled?: boolean;
+    /**
+     * A container for metadata that should be bundled with flag telemetry.
+     */
+    metadata?: Record<string, string>;
 }
 
 interface IFeatureFlagProvider {
@@ -98,4 +207,6 @@ interface FeatureManagerOptions {
     customFilters?: IFeatureFilter[];
 }
 
-export { ConfigurationMapFeatureFlagProvider, ConfigurationObjectFeatureFlagProvider, FeatureManager, type IFeatureFlagProvider };
+declare const VERSION = "1.0.0";
+
+export { ConfigurationMapFeatureFlagProvider, ConfigurationObjectFeatureFlagProvider, FeatureManager, type IFeatureFilter, type IFeatureFlagProvider, VERSION };

package/dist/index.js

@@ -1,234 +0,0 @@
-'use strict';
-
-var crypto = require('crypto');
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-class TimeWindowFilter {
-    name = "Microsoft.TimeWindow";
-    evaluate(context) {
-        const { featureName, parameters } = context;
-        const startTime = parameters.Start !== undefined ? new Date(parameters.Start) : undefined;
-        const endTime = parameters.End !== undefined ? new Date(parameters.End) : undefined;
-        if (startTime === undefined && endTime === undefined) {
-            // If neither start nor end time is specified, then the filter is not applicable.
-            console.warn(`The ${this.name} feature filter is not valid for feature ${featureName}. It must specify either 'Start', 'End', or both.`);
-            return false;
-        }
-        const now = new Date();
-        return (startTime === undefined || startTime <= now) && (endTime === undefined || now < endTime);
-    }
-}
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-var RequirementType;
-(function (RequirementType) {
-    RequirementType["Any"] = "Any";
-    RequirementType["All"] = "All";
-})(RequirementType || (RequirementType = {}));
-// Feature Management Section fed into feature manager.
-// Converted from https://github.com/Azure/AppConfiguration/blob/main/docs/FeatureManagement/FeatureManagement.v1.0.0.schema.json
-const FEATURE_MANAGEMENT_KEY = "feature_management";
-const FEATURE_FLAGS_KEY = "feature_flags";
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-class TargetingFilter {
-    name = "Microsoft.Targeting";
-    evaluate(context, appContext) {
-        const { featureName, parameters } = context;
-        TargetingFilter.#validateParameters(parameters);
-        if (appContext === undefined) {
-            throw new Error("The app context is required for targeting filter.");
-        }
-        if (parameters.Audience.Exclusion !== undefined) {
-            // check if the user is in the exclusion list
-            if (appContext?.userId !== undefined &&
-                parameters.Audience.Exclusion.Users !== undefined &&
-                parameters.Audience.Exclusion.Users.includes(appContext.userId)) {
-                return false;
-            }
-            // check if the user is in a group within exclusion list
-            if (appContext?.groups !== undefined &&
-                parameters.Audience.Exclusion.Groups !== undefined) {
-                for (const excludedGroup of parameters.Audience.Exclusion.Groups) {
-                    if (appContext.groups.includes(excludedGroup)) {
-                        return false;
-                    }
-                }
-            }
-        }
-        // check if the user is being targeted directly
-        if (appContext?.userId !== undefined &&
-            parameters.Audience.Users !== undefined &&
-            parameters.Audience.Users.includes(appContext.userId)) {
-            return true;
-        }
-        // check if the user is in a group that is being targeted
-        if (appContext?.groups !== undefined &&
-            parameters.Audience.Groups !== undefined) {
-            for (const group of parameters.Audience.Groups) {
-                if (appContext.groups.includes(group.Name)) {
-                    const audienceContextId = constructAudienceContextId(featureName, appContext.userId, group.Name);
-                    const rolloutPercentage = group.RolloutPercentage;
-                    if (TargetingFilter.#isTargeted(audienceContextId, rolloutPercentage)) {
-                        return true;
-                    }
-                }
-            }
-        }
-        // check if the user is being targeted by a default rollout percentage
-        const defaultContextId = constructAudienceContextId(featureName, appContext?.userId);
-        return TargetingFilter.#isTargeted(defaultContextId, parameters.Audience.DefaultRolloutPercentage);
-    }
-    static #isTargeted(audienceContextId, rolloutPercentage) {
-        if (rolloutPercentage === 100) {
-            return true;
-        }
-        // Cryptographic hashing algorithms ensure adequate entropy across hash values.
-        const contextMarker = stringToUint32(audienceContextId);
-        const contextPercentage = (contextMarker / 0xFFFFFFFF) * 100;
-        return contextPercentage < rolloutPercentage;
-    }
-    static #validateParameters(parameters) {
-        if (parameters.Audience.DefaultRolloutPercentage < 0 || parameters.Audience.DefaultRolloutPercentage > 100) {
-            throw new Error("Audience.DefaultRolloutPercentage must be a number between 0 and 100.");
-        }
-        // validate RolloutPercentage for each group
-        if (parameters.Audience.Groups !== undefined) {
-            for (const group of parameters.Audience.Groups) {
-                if (group.RolloutPercentage < 0 || group.RolloutPercentage > 100) {
-                    throw new Error(`RolloutPercentage of group ${group.Name} must be a number between 0 and 100.`);
-                }
-            }
-        }
-    }
-}
-/**
- * Constructs the context id for the audience.
- * The context id is used to determine if the user is part of the audience for a feature.
- * If groupName is provided, the context id is constructed as follows:
- *  userId + "\n" + featureName + "\n" + groupName
- * Otherwise, the context id is constructed as follows:
- *  userId + "\n" + featureName
- *
- * @param featureName name of the feature
- * @param userId userId from app context
- * @param groupName group name from app context
- * @returns a string that represents the context id for the audience
- */
-function constructAudienceContextId(featureName, userId, groupName) {
-    let contextId = `${userId ?? ""}\n${featureName}`;
-    if (groupName !== undefined) {
-        contextId += `\n${groupName}`;
-    }
-    return contextId;
-}
-function stringToUint32(str) {
-    // Create a SHA-256 hash of the string
-    const hash = crypto.createHash("sha256").update(str).digest();
-    // Get the first 4 bytes of the hash
-    const first4Bytes = hash.subarray(0, 4);
-    // Convert the 4 bytes to a uint32 with little-endian encoding
-    const uint32 = first4Bytes.readUInt32LE(0);
-    return uint32;
-}
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-class FeatureManager {
-    #provider;
-    #featureFilters = new Map();
-    constructor(provider, options) {
-        this.#provider = provider;
-        const builtinFilters = [new TimeWindowFilter(), new TargetingFilter()];
-        // If a custom filter shares a name with an existing filter, the custom filter overrides the existing one.
-        for (const filter of [...builtinFilters, ...(options?.customFilters ?? [])]) {
-            this.#featureFilters.set(filter.name, filter);
-        }
-    }
-    async listFeatureNames() {
-        const features = await this.#provider.getFeatureFlags();
-        const featureNameSet = new Set(features.map((feature) => feature.id));
-        return Array.from(featureNameSet);
-    }
-    // If multiple feature flags are found, the first one takes precedence.
-    async isEnabled(featureName, context) {
-        const featureFlag = await this.#provider.getFeatureFlag(featureName);
-        if (featureFlag === undefined) {
-            // If the feature is not found, then it is disabled.
-            return false;
-        }
-        if (featureFlag.enabled === false) {
-            // If the feature is explicitly disabled, then it is disabled.
-            return false;
-        }
-        const clientFilters = featureFlag.conditions?.client_filters;
-        if (clientFilters === undefined || clientFilters.length <= 0) {
-            // If there are no client filters, then the feature is enabled.
-            return true;
-        }
-        const requirementType = featureFlag.conditions?.requirement_type ?? RequirementType.Any; // default to any.
-        /**
-         * While iterating through the client filters, we short-circuit the evaluation based on the requirement type.
-         * - When requirement type is "All", the feature is enabled if all client filters are matched. If any client filter is not matched, the feature is disabled, otherwise it is enabled. `shortCircuitEvaluationResult` is false.
-         * - When requirement type is "Any", the feature is enabled if any client filter is matched. If any client filter is matched, the feature is enabled, otherwise it is disabled. `shortCircuitEvaluationResult` is true.
-         */
-        const shortCircuitEvaluationResult = requirementType === RequirementType.Any;
-        for (const clientFilter of clientFilters) {
-            const matchedFeatureFilter = this.#featureFilters.get(clientFilter.name);
-            const contextWithFeatureName = { featureName, parameters: clientFilter.parameters };
-            if (matchedFeatureFilter === undefined) {
-                console.warn(`Feature filter ${clientFilter.name} is not found.`);
-                return false;
-            }
-            if (await matchedFeatureFilter.evaluate(contextWithFeatureName, context) === shortCircuitEvaluationResult) {
-                return shortCircuitEvaluationResult;
-            }
-        }
-        // If we get here, then we have not found a client filter that matches the requirement type.
-        return !shortCircuitEvaluationResult;
-    }
-}
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-/**
- * A feature flag provider that uses a map-like configuration to provide feature flags.
- */
-class ConfigurationMapFeatureFlagProvider {
-    #configuration;
-    constructor(configuration) {
-        this.#configuration = configuration;
-    }
-    async getFeatureFlag(featureName) {
-        const featureConfig = this.#configuration.get(FEATURE_MANAGEMENT_KEY);
-        return featureConfig?.[FEATURE_FLAGS_KEY]?.find((feature) => feature.id === featureName);
-    }
-    async getFeatureFlags() {
-        const featureConfig = this.#configuration.get(FEATURE_MANAGEMENT_KEY);
-        return featureConfig?.[FEATURE_FLAGS_KEY] ?? [];
-    }
-}
-/**
- * A feature flag provider that uses an object-like configuration to provide feature flags.
- */
-class ConfigurationObjectFeatureFlagProvider {
-    #configuration;
-    constructor(configuration) {
-        this.#configuration = configuration;
-    }
-    async getFeatureFlag(featureName) {
-        const featureFlags = this.#configuration[FEATURE_MANAGEMENT_KEY]?.[FEATURE_FLAGS_KEY];
-        return featureFlags?.find((feature) => feature.id === featureName);
-    }
-    async getFeatureFlags() {
-        return this.#configuration[FEATURE_MANAGEMENT_KEY]?.[FEATURE_FLAGS_KEY] ?? [];
-    }
-}
-
-exports.ConfigurationMapFeatureFlagProvider = ConfigurationMapFeatureFlagProvider;
-exports.ConfigurationObjectFeatureFlagProvider = ConfigurationObjectFeatureFlagProvider;
-exports.FeatureManager = FeatureManager;
-//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sources":["../src/filter/TimeWindowFilter.ts","../src/model.ts","../src/filter/TargetingFilter.ts","../src/featureManager.ts","../src/featureProvider.ts"],"sourcesContent":["// Copyright (c) Microsoft Corporation.\r\n// Licensed under the MIT license.\r\n\r\nimport { IFeatureFilter } from \"./FeatureFilter\";\r\n\r\n// [Start, End)\r\ntype TimeWindowParameters = {\r\n    Start?: string;\r\n    End?: string;\r\n}\r\n\r\ntype TimeWindowFilterEvaluationContext = {\r\n    featureName: string;\r\n    parameters: TimeWindowParameters;\r\n}\r\n\r\nexport class TimeWindowFilter implements IFeatureFilter {\r\n    name: string = \"Microsoft.TimeWindow\";\r\n\r\n    evaluate(context: TimeWindowFilterEvaluationContext): boolean {\r\n        const {featureName, parameters} = context;\r\n        const startTime = parameters.Start !== undefined ? new Date(parameters.Start) : undefined;\r\n        const endTime = parameters.End !== undefined ? new Date(parameters.End) : undefined;\r\n\r\n        if (startTime === undefined && endTime === undefined) {\r\n            // If neither start nor end time is specified, then the filter is not applicable.\r\n            console.warn(`The ${this.name} feature filter is not valid for feature ${featureName}. It must specify either 'Start', 'End', or both.`);\r\n            return false;\r\n        }\r\n        const now = new Date();\r\n        return (startTime === undefined || startTime <= now) && (endTime === undefined || now < endTime);\r\n    }\r\n}\r\n","// Copyright (c) Microsoft Corporation.\r\n// Licensed under the MIT license.\r\n\r\n// Converted from https://github.com/Azure/AppConfiguration/blob/main/docs/FeatureManagement/FeatureFlag.v1.1.0.schema.json\r\n\r\nexport interface FeatureFlag {\r\n  /**\r\n   * An ID used to uniquely identify and reference the feature.\r\n   */\r\n  id: string\r\n\r\n  /**\r\n   * A description of the feature.\r\n   */\r\n  description?: string\r\n\r\n  /**\r\n   * A display name for the feature to use for display rather than the ID.\r\n   */\r\n  display_name?: string\r\n\r\n  /**\r\n   * A feature is OFF if enabled is false. If enabled is true, then the feature is ON if there are no conditions (null or empty) or if the conditions are satisfied.\r\n   */\r\n  enabled: boolean\r\n\r\n  /**\r\n   * The declaration of conditions used to dynamically enable features.\r\n   */\r\n  conditions?: FeatureEnablementConditions\r\n}\r\n\r\nexport enum RequirementType {\r\n  Any = \"Any\",\r\n  All = \"All\"\r\n}\r\n\r\nexport interface FeatureEnablementConditions {\r\n  /**\r\n   * Determines whether any or all registered client filters must be evaluated as true for the feature to be considered enabled.\r\n   */\r\n  requirement_type?: RequirementType\r\n\r\n  /**\r\n   * Filters that must run on the client and be evaluated as true for the feature to be considered enabled.\r\n   */\r\n  client_filters?: ClientFilter[]\r\n}\r\n\r\nexport interface ClientFilter {\r\n  /**\r\n   * The name used to refer to and require a client filter.\r\n   */\r\n  name: string\r\n  /**\r\n   * Custom parameters for a given client filter. A client filter can require any set of parameters of any type.\r\n   */\r\n  parameters?: unknown\r\n}\r\n\r\n// Feature Management Section fed into feature manager.\r\n// Converted from https://github.com/Azure/AppConfiguration/blob/main/docs/FeatureManagement/FeatureManagement.v1.0.0.schema.json\r\n\r\nexport const FEATURE_MANAGEMENT_KEY = \"feature_management\"\r\nexport const FEATURE_FLAGS_KEY = \"feature_flags\"\r\n\r\nexport interface FeatureManagementConfiguration {\r\n  feature_management: FeatureManagement\r\n}\r\n\r\n/**\r\n * Declares feature management configuration.\r\n */\r\nexport interface FeatureManagement {\r\n  feature_flags: FeatureFlag[];\r\n}\r\n","// Copyright (c) Microsoft Corporation.\r\n// Licensed under the MIT license.\r\n\r\nimport { IFeatureFilter } from \"./FeatureFilter\";\r\nimport { createHash } from \"crypto\";\r\n\r\ntype TargetingFilterParameters = {\r\n    Audience: {\r\n        DefaultRolloutPercentage: number;\r\n        Users?: string[];\r\n        Groups?: {\r\n            Name: string;\r\n            RolloutPercentage: number;\r\n        }[];\r\n        Exclusion?: {\r\n            Users?: string[];\r\n            Groups?: string[];\r\n        };\r\n    }\r\n}\r\n\r\ntype TargetingFilterEvaluationContext = {\r\n    featureName: string;\r\n    parameters: TargetingFilterParameters;\r\n}\r\n\r\ntype TargetingFilterAppContext = {\r\n    userId?: string;\r\n    groups?: string[];\r\n}\r\n\r\nexport class TargetingFilter implements IFeatureFilter {\r\n    name: string = \"Microsoft.Targeting\";\r\n\r\n    evaluate(context: TargetingFilterEvaluationContext, appContext?: TargetingFilterAppContext): boolean {\r\n        const { featureName, parameters } = context;\r\n        TargetingFilter.#validateParameters(parameters);\r\n\r\n        if (appContext === undefined) {\r\n            throw new Error(\"The app context is required for targeting filter.\");\r\n        }\r\n\r\n        if (parameters.Audience.Exclusion !== undefined) {\r\n            // check if the user is in the exclusion list\r\n            if (appContext?.userId !== undefined &&\r\n                parameters.Audience.Exclusion.Users !== undefined &&\r\n                parameters.Audience.Exclusion.Users.includes(appContext.userId)) {\r\n                return false;\r\n            }\r\n            // check if the user is in a group within exclusion list\r\n            if (appContext?.groups !== undefined &&\r\n                parameters.Audience.Exclusion.Groups !== undefined) {\r\n                for (const excludedGroup of parameters.Audience.Exclusion.Groups) {\r\n                    if (appContext.groups.includes(excludedGroup)) {\r\n                        return false;\r\n                    }\r\n                }\r\n            }\r\n        }\r\n\r\n        // check if the user is being targeted directly\r\n        if (appContext?.userId !== undefined &&\r\n            parameters.Audience.Users !== undefined &&\r\n            parameters.Audience.Users.includes(appContext.userId)) {\r\n            return true;\r\n        }\r\n\r\n        // check if the user is in a group that is being targeted\r\n        if (appContext?.groups !== undefined &&\r\n            parameters.Audience.Groups !== undefined) {\r\n            for (const group of parameters.Audience.Groups) {\r\n                if (appContext.groups.includes(group.Name)) {\r\n                    const audienceContextId = constructAudienceContextId(featureName, appContext.userId, group.Name);\r\n                    const rolloutPercentage = group.RolloutPercentage;\r\n                    if (TargetingFilter.#isTargeted(audienceContextId, rolloutPercentage)) {\r\n                        return true;\r\n                    }\r\n                }\r\n            }\r\n        }\r\n\r\n        // check if the user is being targeted by a default rollout percentage\r\n        const defaultContextId = constructAudienceContextId(featureName, appContext?.userId);\r\n        return TargetingFilter.#isTargeted(defaultContextId, parameters.Audience.DefaultRolloutPercentage);\r\n    }\r\n\r\n    static #isTargeted(audienceContextId: string, rolloutPercentage: number): boolean {\r\n        if (rolloutPercentage === 100) {\r\n            return true;\r\n        }\r\n        // Cryptographic hashing algorithms ensure adequate entropy across hash values.\r\n        const contextMarker = stringToUint32(audienceContextId);\r\n        const contextPercentage = (contextMarker / 0xFFFFFFFF) * 100;\r\n        return contextPercentage < rolloutPercentage;\r\n    }\r\n\r\n    static #validateParameters(parameters: TargetingFilterParameters): void {\r\n        if (parameters.Audience.DefaultRolloutPercentage < 0 || parameters.Audience.DefaultRolloutPercentage > 100) {\r\n            throw new Error(\"Audience.DefaultRolloutPercentage must be a number between 0 and 100.\");\r\n        }\r\n        // validate RolloutPercentage for each group\r\n        if (parameters.Audience.Groups !== undefined) {\r\n            for (const group of parameters.Audience.Groups) {\r\n                if (group.RolloutPercentage < 0 || group.RolloutPercentage > 100) {\r\n                    throw new Error(`RolloutPercentage of group ${group.Name} must be a number between 0 and 100.`);\r\n                }\r\n            }\r\n        }\r\n    }\r\n}\r\n\r\n/**\r\n * Constructs the context id for the audience.\r\n * The context id is used to determine if the user is part of the audience for a feature.\r\n * If groupName is provided, the context id is constructed as follows:\r\n *  userId + \"\\n\" + featureName + \"\\n\" + groupName\r\n * Otherwise, the context id is constructed as follows:\r\n *  userId + \"\\n\" + featureName\r\n *\r\n * @param featureName name of the feature\r\n * @param userId userId from app context\r\n * @param groupName group name from app context\r\n * @returns a string that represents the context id for the audience\r\n */\r\nfunction constructAudienceContextId(featureName: string, userId: string | undefined, groupName?: string) {\r\n    let contextId = `${userId ?? \"\"}\\n${featureName}`;\r\n    if (groupName !== undefined) {\r\n        contextId += `\\n${groupName}`;\r\n    }\r\n    return contextId\r\n}\r\n\r\nfunction stringToUint32(str: string): number {\r\n    // Create a SHA-256 hash of the string\r\n    const hash = createHash(\"sha256\").update(str).digest();\r\n\r\n    // Get the first 4 bytes of the hash\r\n    const first4Bytes = hash.subarray(0, 4);\r\n\r\n    // Convert the 4 bytes to a uint32 with little-endian encoding\r\n    const uint32 = first4Bytes.readUInt32LE(0);\r\n    return uint32;\r\n}\r\n","// Copyright (c) Microsoft Corporation.\r\n// Licensed under the MIT license.\r\n\r\nimport { TimeWindowFilter } from \"./filter/TimeWindowFilter\";\r\nimport { IFeatureFilter } from \"./filter/FeatureFilter\";\r\nimport { RequirementType } from \"./model\";\r\nimport { IFeatureFlagProvider } from \"./featureProvider\";\r\nimport { TargetingFilter } from \"./filter/TargetingFilter\";\r\n\r\nexport class FeatureManager {\r\n    #provider: IFeatureFlagProvider;\r\n    #featureFilters: Map<string, IFeatureFilter> = new Map();\r\n\r\n    constructor(provider: IFeatureFlagProvider, options?: FeatureManagerOptions) {\r\n        this.#provider = provider;\r\n\r\n        const builtinFilters = [new TimeWindowFilter(), new TargetingFilter()];\r\n\r\n        // If a custom filter shares a name with an existing filter, the custom filter overrides the existing one.\r\n        for (const filter of [...builtinFilters, ...(options?.customFilters ?? [])]) {\r\n            this.#featureFilters.set(filter.name, filter);\r\n        }\r\n    }\r\n\r\n    async listFeatureNames(): Promise<string[]> {\r\n        const features = await this.#provider.getFeatureFlags();\r\n        const featureNameSet = new Set(features.map((feature) => feature.id));\r\n        return Array.from(featureNameSet);\r\n    }\r\n\r\n    // If multiple feature flags are found, the first one takes precedence.\r\n    async isEnabled(featureName: string, context?: unknown): Promise<boolean> {\r\n        const featureFlag = await this.#provider.getFeatureFlag(featureName);\r\n        if (featureFlag === undefined) {\r\n            // If the feature is not found, then it is disabled.\r\n            return false;\r\n        }\r\n\r\n        if (featureFlag.enabled === false) {\r\n            // If the feature is explicitly disabled, then it is disabled.\r\n            return false;\r\n        }\r\n\r\n        const clientFilters = featureFlag.conditions?.client_filters;\r\n        if (clientFilters === undefined || clientFilters.length <= 0) {\r\n            // If there are no client filters, then the feature is enabled.\r\n            return true;\r\n        }\r\n\r\n        const requirementType = featureFlag.conditions?.requirement_type ?? RequirementType.Any; // default to any.\r\n\r\n        /**\r\n         * While iterating through the client filters, we short-circuit the evaluation based on the requirement type.\r\n         * - When requirement type is \"All\", the feature is enabled if all client filters are matched. If any client filter is not matched, the feature is disabled, otherwise it is enabled. `shortCircuitEvaluationResult` is false.\r\n         * - When requirement type is \"Any\", the feature is enabled if any client filter is matched. If any client filter is matched, the feature is enabled, otherwise it is disabled. `shortCircuitEvaluationResult` is true.\r\n         */\r\n        const shortCircuitEvaluationResult: boolean = requirementType === RequirementType.Any;\r\n\r\n        for (const clientFilter of clientFilters) {\r\n            const matchedFeatureFilter = this.#featureFilters.get(clientFilter.name);\r\n            const contextWithFeatureName = { featureName, parameters: clientFilter.parameters };\r\n            if (matchedFeatureFilter === undefined) {\r\n                console.warn(`Feature filter ${clientFilter.name} is not found.`);\r\n                return false;\r\n            }\r\n            if (await matchedFeatureFilter.evaluate(contextWithFeatureName, context) === shortCircuitEvaluationResult) {\r\n                return shortCircuitEvaluationResult;\r\n            }\r\n        }\r\n\r\n        // If we get here, then we have not found a client filter that matches the requirement type.\r\n        return !shortCircuitEvaluationResult;\r\n    }\r\n\r\n}\r\n\r\ninterface FeatureManagerOptions {\r\n    customFilters?: IFeatureFilter[];\r\n}\r\n","// Copyright (c) Microsoft Corporation.\r\n// Licensed under the MIT license.\r\n\r\nimport { IGettable } from \"./gettable\";\r\nimport { FeatureFlag, FeatureManagementConfiguration, FEATURE_MANAGEMENT_KEY, FEATURE_FLAGS_KEY } from \"./model\";\r\n\r\nexport interface IFeatureFlagProvider {\r\n    /**\r\n     * Get all feature flags.\r\n     */\r\n    getFeatureFlags(): Promise<FeatureFlag[]>;\r\n\r\n    /**\r\n     * Get a feature flag by name.\r\n     * @param featureName The name of the feature flag.\r\n     */\r\n    getFeatureFlag(featureName: string): Promise<FeatureFlag | undefined>;\r\n}\r\n\r\n/**\r\n * A feature flag provider that uses a map-like configuration to provide feature flags.\r\n */\r\nexport class ConfigurationMapFeatureFlagProvider implements IFeatureFlagProvider {\r\n    #configuration: IGettable;\r\n\r\n    constructor(configuration: IGettable) {\r\n        this.#configuration = configuration;\r\n    }\r\n    async getFeatureFlag(featureName: string): Promise<FeatureFlag | undefined> {\r\n        const featureConfig = this.#configuration.get<FeatureManagementConfiguration>(FEATURE_MANAGEMENT_KEY);\r\n        return featureConfig?.[FEATURE_FLAGS_KEY]?.find((feature) => feature.id === featureName);\r\n    }\r\n\r\n    async getFeatureFlags(): Promise<FeatureFlag[]> {\r\n        const featureConfig = this.#configuration.get<FeatureManagementConfiguration>(FEATURE_MANAGEMENT_KEY);\r\n        return featureConfig?.[FEATURE_FLAGS_KEY] ?? [];\r\n    }\r\n}\r\n\r\n/**\r\n * A feature flag provider that uses an object-like configuration to provide feature flags.\r\n */\r\nexport class ConfigurationObjectFeatureFlagProvider implements IFeatureFlagProvider {\r\n    #configuration: Record<string, unknown>;\r\n\r\n    constructor(configuration: Record<string, unknown>) {\r\n        this.#configuration = configuration;\r\n    }\r\n\r\n    async getFeatureFlag(featureName: string): Promise<FeatureFlag | undefined> {\r\n        const featureFlags = this.#configuration[FEATURE_MANAGEMENT_KEY]?.[FEATURE_FLAGS_KEY];\r\n        return featureFlags?.find((feature: FeatureFlag) => feature.id === featureName);\r\n    }\r\n\r\n    async getFeatureFlags(): Promise<FeatureFlag[]> {\r\n        return this.#configuration[FEATURE_MANAGEMENT_KEY]?.[FEATURE_FLAGS_KEY] ?? [];\r\n    }\r\n}\r\n"],"names":["createHash"],"mappings":";;;;AAAA;AACA;MAea,gBAAgB,CAAA;IACzB,IAAI,GAAW,sBAAsB,CAAC;AAEtC,IAAA,QAAQ,CAAC,OAA0C,EAAA;AAC/C,QAAA,MAAM,EAAC,WAAW,EAAE,UAAU,EAAC,GAAG,OAAO,CAAC;QAC1C,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,KAAK,SAAS,GAAG,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;QAC1F,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,KAAK,SAAS,GAAG,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC;QAEpF,IAAI,SAAS,KAAK,SAAS,IAAI,OAAO,KAAK,SAAS,EAAE;;YAElD,OAAO,CAAC,IAAI,CAAC,CAAO,IAAA,EAAA,IAAI,CAAC,IAAI,CAA4C,yCAAA,EAAA,WAAW,CAAmD,iDAAA,CAAA,CAAC,CAAC;AACzI,YAAA,OAAO,KAAK,CAAC;SAChB;AACD,QAAA,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;AACvB,QAAA,OAAO,CAAC,SAAS,KAAK,SAAS,IAAI,SAAS,IAAI,GAAG,MAAM,OAAO,KAAK,SAAS,IAAI,GAAG,GAAG,OAAO,CAAC,CAAC;KACpG;AACJ;;AChCD;AACA;AA+BA,IAAY,eAGX,CAAA;AAHD,CAAA,UAAY,eAAe,EAAA;AACzB,IAAA,eAAA,CAAA,KAAA,CAAA,GAAA,KAAW,CAAA;AACX,IAAA,eAAA,CAAA,KAAA,CAAA,GAAA,KAAW,CAAA;AACb,CAAC,EAHW,eAAe,KAAf,eAAe,GAG1B,EAAA,CAAA,CAAA,CAAA;AAyBD;AACA;AAEO,MAAM,sBAAsB,GAAG,oBAAoB,CAAA;AACnD,MAAM,iBAAiB,GAAG,eAAe;;AChEhD;AACA;MA8Ba,eAAe,CAAA;IACxB,IAAI,GAAW,qBAAqB,CAAC;IAErC,QAAQ,CAAC,OAAyC,EAAE,UAAsC,EAAA;AACtF,QAAA,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;AAC5C,QAAA,eAAe,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;AAEhD,QAAA,IAAI,UAAU,KAAK,SAAS,EAAE;AAC1B,YAAA,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;SACxE;QAED,IAAI,UAAU,CAAC,QAAQ,CAAC,SAAS,KAAK,SAAS,EAAE;;AAE7C,YAAA,IAAI,UAAU,EAAE,MAAM,KAAK,SAAS;AAChC,gBAAA,UAAU,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,KAAK,SAAS;AACjD,gBAAA,UAAU,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE;AACjE,gBAAA,OAAO,KAAK,CAAC;aAChB;;AAED,YAAA,IAAI,UAAU,EAAE,MAAM,KAAK,SAAS;gBAChC,UAAU,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,KAAK,SAAS,EAAE;gBACpD,KAAK,MAAM,aAAa,IAAI,UAAU,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,EAAE;oBAC9D,IAAI,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE;AAC3C,wBAAA,OAAO,KAAK,CAAC;qBAChB;iBACJ;aACJ;SACJ;;AAGD,QAAA,IAAI,UAAU,EAAE,MAAM,KAAK,SAAS;AAChC,YAAA,UAAU,CAAC,QAAQ,CAAC,KAAK,KAAK,SAAS;AACvC,YAAA,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE;AACvD,YAAA,OAAO,IAAI,CAAC;SACf;;AAGD,QAAA,IAAI,UAAU,EAAE,MAAM,KAAK,SAAS;AAChC,YAAA,UAAU,CAAC,QAAQ,CAAC,MAAM,KAAK,SAAS,EAAE;YAC1C,KAAK,MAAM,KAAK,IAAI,UAAU,CAAC,QAAQ,CAAC,MAAM,EAAE;gBAC5C,IAAI,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;AACxC,oBAAA,MAAM,iBAAiB,GAAG,0BAA0B,CAAC,WAAW,EAAE,UAAU,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;AACjG,oBAAA,MAAM,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,CAAC;oBAClD,IAAI,eAAe,CAAC,WAAW,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,EAAE;AACnE,wBAAA,OAAO,IAAI,CAAC;qBACf;iBACJ;aACJ;SACJ;;QAGD,MAAM,gBAAgB,GAAG,0BAA0B,CAAC,WAAW,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;AACrF,QAAA,OAAO,eAAe,CAAC,WAAW,CAAC,gBAAgB,EAAE,UAAU,CAAC,QAAQ,CAAC,wBAAwB,CAAC,CAAC;KACtG;AAED,IAAA,OAAO,WAAW,CAAC,iBAAyB,EAAE,iBAAyB,EAAA;AACnE,QAAA,IAAI,iBAAiB,KAAK,GAAG,EAAE;AAC3B,YAAA,OAAO,IAAI,CAAC;SACf;;AAED,QAAA,MAAM,aAAa,GAAG,cAAc,CAAC,iBAAiB,CAAC,CAAC;QACxD,MAAM,iBAAiB,GAAG,CAAC,aAAa,GAAG,UAAU,IAAI,GAAG,CAAC;QAC7D,OAAO,iBAAiB,GAAG,iBAAiB,CAAC;KAChD;IAED,OAAO,mBAAmB,CAAC,UAAqC,EAAA;AAC5D,QAAA,IAAI,UAAU,CAAC,QAAQ,CAAC,wBAAwB,GAAG,CAAC,IAAI,UAAU,CAAC,QAAQ,CAAC,wBAAwB,GAAG,GAAG,EAAE;AACxG,YAAA,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC;SAC5F;;QAED,IAAI,UAAU,CAAC,QAAQ,CAAC,MAAM,KAAK,SAAS,EAAE;YAC1C,KAAK,MAAM,KAAK,IAAI,UAAU,CAAC,QAAQ,CAAC,MAAM,EAAE;AAC5C,gBAAA,IAAI,KAAK,CAAC,iBAAiB,GAAG,CAAC,IAAI,KAAK,CAAC,iBAAiB,GAAG,GAAG,EAAE;oBAC9D,MAAM,IAAI,KAAK,CAAC,CAAA,2BAAA,EAA8B,KAAK,CAAC,IAAI,CAAsC,oCAAA,CAAA,CAAC,CAAC;iBACnG;aACJ;SACJ;KACJ;AACJ,CAAA;AAED;;;;;;;;;;;;AAYG;AACH,SAAS,0BAA0B,CAAC,WAAmB,EAAE,MAA0B,EAAE,SAAkB,EAAA;IACnG,IAAI,SAAS,GAAG,CAAG,EAAA,MAAM,IAAI,EAAE,CAAA,EAAA,EAAK,WAAW,CAAA,CAAE,CAAC;AAClD,IAAA,IAAI,SAAS,KAAK,SAAS,EAAE;AACzB,QAAA,SAAS,IAAI,CAAA,EAAA,EAAK,SAAS,CAAA,CAAE,CAAC;KACjC;AACD,IAAA,OAAO,SAAS,CAAA;AACpB,CAAC;AAED,SAAS,cAAc,CAAC,GAAW,EAAA;;AAE/B,IAAA,MAAM,IAAI,GAAGA,iBAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC;;IAGvD,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;;IAGxC,MAAM,MAAM,GAAG,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;AAC3C,IAAA,OAAO,MAAM,CAAC;AAClB;;AC9IA;AACA;MAQa,cAAc,CAAA;AACvB,IAAA,SAAS,CAAuB;AAChC,IAAA,eAAe,GAAgC,IAAI,GAAG,EAAE,CAAC;IAEzD,WAAY,CAAA,QAA8B,EAAE,OAA+B,EAAA;AACvE,QAAA,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAE1B,MAAM,cAAc,GAAG,CAAC,IAAI,gBAAgB,EAAE,EAAE,IAAI,eAAe,EAAE,CAAC,CAAC;;AAGvE,QAAA,KAAK,MAAM,MAAM,IAAI,CAAC,GAAG,cAAc,EAAE,IAAI,OAAO,EAAE,aAAa,IAAI,EAAE,EAAE,EAAE;YACzE,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;SACjD;KACJ;AAED,IAAA,MAAM,gBAAgB,GAAA;QAClB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,eAAe,EAAE,CAAC;AACxD,QAAA,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,KAAK,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;AACtE,QAAA,OAAO,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;KACrC;;AAGD,IAAA,MAAM,SAAS,CAAC,WAAmB,EAAE,OAAiB,EAAA;QAClD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;AACrE,QAAA,IAAI,WAAW,KAAK,SAAS,EAAE;;AAE3B,YAAA,OAAO,KAAK,CAAC;SAChB;AAED,QAAA,IAAI,WAAW,CAAC,OAAO,KAAK,KAAK,EAAE;;AAE/B,YAAA,OAAO,KAAK,CAAC;SAChB;AAED,QAAA,MAAM,aAAa,GAAG,WAAW,CAAC,UAAU,EAAE,cAAc,CAAC;QAC7D,IAAI,aAAa,KAAK,SAAS,IAAI,aAAa,CAAC,MAAM,IAAI,CAAC,EAAE;;AAE1D,YAAA,OAAO,IAAI,CAAC;SACf;AAED,QAAA,MAAM,eAAe,GAAG,WAAW,CAAC,UAAU,EAAE,gBAAgB,IAAI,eAAe,CAAC,GAAG,CAAC;AAExF;;;;AAIG;AACH,QAAA,MAAM,4BAA4B,GAAY,eAAe,KAAK,eAAe,CAAC,GAAG,CAAC;AAEtF,QAAA,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE;AACtC,YAAA,MAAM,oBAAoB,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;YACzE,MAAM,sBAAsB,GAAG,EAAE,WAAW,EAAE,UAAU,EAAE,YAAY,CAAC,UAAU,EAAE,CAAC;AACpF,YAAA,IAAI,oBAAoB,KAAK,SAAS,EAAE;gBACpC,OAAO,CAAC,IAAI,CAAC,CAAA,eAAA,EAAkB,YAAY,CAAC,IAAI,CAAgB,cAAA,CAAA,CAAC,CAAC;AAClE,gBAAA,OAAO,KAAK,CAAC;aAChB;AACD,YAAA,IAAI,MAAM,oBAAoB,CAAC,QAAQ,CAAC,sBAAsB,EAAE,OAAO,CAAC,KAAK,4BAA4B,EAAE;AACvG,gBAAA,OAAO,4BAA4B,CAAC;aACvC;SACJ;;QAGD,OAAO,CAAC,4BAA4B,CAAC;KACxC;AAEJ;;AC1ED;AACA;AAkBA;;AAEG;MACU,mCAAmC,CAAA;AAC5C,IAAA,cAAc,CAAY;AAE1B,IAAA,WAAA,CAAY,aAAwB,EAAA;AAChC,QAAA,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;KACvC;IACD,MAAM,cAAc,CAAC,WAAmB,EAAA;QACpC,MAAM,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAiC,sBAAsB,CAAC,CAAC;AACtG,QAAA,OAAO,aAAa,GAAG,iBAAiB,CAAC,EAAE,IAAI,CAAC,CAAC,OAAO,KAAK,OAAO,CAAC,EAAE,KAAK,WAAW,CAAC,CAAC;KAC5F;AAED,IAAA,MAAM,eAAe,GAAA;QACjB,MAAM,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAiC,sBAAsB,CAAC,CAAC;AACtG,QAAA,OAAO,aAAa,GAAG,iBAAiB,CAAC,IAAI,EAAE,CAAC;KACnD;AACJ,CAAA;AAED;;AAEG;MACU,sCAAsC,CAAA;AAC/C,IAAA,cAAc,CAA0B;AAExC,IAAA,WAAA,CAAY,aAAsC,EAAA;AAC9C,QAAA,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;KACvC;IAED,MAAM,cAAc,CAAC,WAAmB,EAAA;AACpC,QAAA,MAAM,YAAY,GAAG,IAAI,CAAC,cAAc,CAAC,sBAAsB,CAAC,GAAG,iBAAiB,CAAC,CAAC;AACtF,QAAA,OAAO,YAAY,EAAE,IAAI,CAAC,CAAC,OAAoB,KAAK,OAAO,CAAC,EAAE,KAAK,WAAW,CAAC,CAAC;KACnF;AAED,IAAA,MAAM,eAAe,GAAA;AACjB,QAAA,OAAO,IAAI,CAAC,cAAc,CAAC,sBAAsB,CAAC,GAAG,iBAAiB,CAAC,IAAI,EAAE,CAAC;KACjF;AACJ;;;;;;"}

package/dist-esm/featureManager.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"featureManager.js","sourceRoot":"","sources":["../src/featureManager.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAE7D,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE1C,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAE3D,MAAM,OAAO,cAAc;IACvB,SAAS,CAAuB;IAChC,eAAe,GAAgC,IAAI,GAAG,EAAE,CAAC;IAEzD,YAAY,QAA8B,EAAE,OAA+B;QACvE,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAE1B,MAAM,cAAc,GAAG,CAAC,IAAI,gBAAgB,EAAE,EAAE,IAAI,eAAe,EAAE,CAAC,CAAC;QAEvE,0GAA0G;QAC1G,KAAK,MAAM,MAAM,IAAI,CAAC,GAAG,cAAc,EAAE,GAAG,CAAC,OAAO,EAAE,aAAa,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC;YAC1E,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAClD,CAAC;IACL,CAAC;IAED,KAAK,CAAC,gBAAgB;QAClB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,eAAe,EAAE,CAAC;QACxD,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;QACtE,OAAO,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACtC,CAAC;IAED,uEAAuE;IACvE,KAAK,CAAC,SAAS,CAAC,WAAmB,EAAE,OAAiB;QAClD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;QACrE,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC5B,oDAAoD;YACpD,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,IAAI,WAAW,CAAC,OAAO,KAAK,KAAK,EAAE,CAAC;YAChC,8DAA8D;YAC9D,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,MAAM,aAAa,GAAG,WAAW,CAAC,UAAU,EAAE,cAAc,CAAC;QAC7D,IAAI,aAAa,KAAK,SAAS,IAAI,aAAa,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;YAC3D,+DAA+D;YAC/D,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,MAAM,eAAe,GAAG,WAAW,CAAC,UAAU,EAAE,gBAAgB,IAAI,eAAe,CAAC,GAAG,CAAC,CAAC,kBAAkB;QAE3G;;;;WAIG;QACH,MAAM,4BAA4B,GAAY,eAAe,KAAK,eAAe,CAAC,GAAG,CAAC;QAEtF,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;YACvC,MAAM,oBAAoB,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;YACzE,MAAM,sBAAsB,GAAG,EAAE,WAAW,EAAE,UAAU,EAAE,YAAY,CAAC,UAAU,EAAE,CAAC;YACpF,IAAI,oBAAoB,KAAK,SAAS,EAAE,CAAC;gBACrC,OAAO,CAAC,IAAI,CAAC,kBAAkB,YAAY,CAAC,IAAI,gBAAgB,CAAC,CAAC;gBAClE,OAAO,KAAK,CAAC;YACjB,CAAC;YACD,IAAI,MAAM,oBAAoB,CAAC,QAAQ,CAAC,sBAAsB,EAAE,OAAO,CAAC,KAAK,4BAA4B,EAAE,CAAC;gBACxG,OAAO,4BAA4B,CAAC;YACxC,CAAC;QACL,CAAC;QAED,4FAA4F;QAC5F,OAAO,CAAC,4BAA4B,CAAC;IACzC,CAAC;CAEJ","sourcesContent":["// Copyright (c) Microsoft Corporation.\r\n// Licensed under the MIT license.\r\n\r\nimport { TimeWindowFilter } from \"./filter/TimeWindowFilter\";\r\nimport { IFeatureFilter } from \"./filter/FeatureFilter\";\r\nimport { RequirementType } from \"./model\";\r\nimport { IFeatureFlagProvider } from \"./featureProvider\";\r\nimport { TargetingFilter } from \"./filter/TargetingFilter\";\r\n\r\nexport class FeatureManager {\r\n    #provider: IFeatureFlagProvider;\r\n    #featureFilters: Map<string, IFeatureFilter> = new Map();\r\n\r\n    constructor(provider: IFeatureFlagProvider, options?: FeatureManagerOptions) {\r\n        this.#provider = provider;\r\n\r\n        const builtinFilters = [new TimeWindowFilter(), new TargetingFilter()];\r\n\r\n        // If a custom filter shares a name with an existing filter, the custom filter overrides the existing one.\r\n        for (const filter of [...builtinFilters, ...(options?.customFilters ?? [])]) {\r\n            this.#featureFilters.set(filter.name, filter);\r\n        }\r\n    }\r\n\r\n    async listFeatureNames(): Promise<string[]> {\r\n        const features = await this.#provider.getFeatureFlags();\r\n        const featureNameSet = new Set(features.map((feature) => feature.id));\r\n        return Array.from(featureNameSet);\r\n    }\r\n\r\n    // If multiple feature flags are found, the first one takes precedence.\r\n    async isEnabled(featureName: string, context?: unknown): Promise<boolean> {\r\n        const featureFlag = await this.#provider.getFeatureFlag(featureName);\r\n        if (featureFlag === undefined) {\r\n            // If the feature is not found, then it is disabled.\r\n            return false;\r\n        }\r\n\r\n        if (featureFlag.enabled === false) {\r\n            // If the feature is explicitly disabled, then it is disabled.\r\n            return false;\r\n        }\r\n\r\n        const clientFilters = featureFlag.conditions?.client_filters;\r\n        if (clientFilters === undefined || clientFilters.length <= 0) {\r\n            // If there are no client filters, then the feature is enabled.\r\n            return true;\r\n        }\r\n\r\n        const requirementType = featureFlag.conditions?.requirement_type ?? RequirementType.Any; // default to any.\r\n\r\n        /**\r\n         * While iterating through the client filters, we short-circuit the evaluation based on the requirement type.\r\n         * - When requirement type is \"All\", the feature is enabled if all client filters are matched. If any client filter is not matched, the feature is disabled, otherwise it is enabled. `shortCircuitEvaluationResult` is false.\r\n         * - When requirement type is \"Any\", the feature is enabled if any client filter is matched. If any client filter is matched, the feature is enabled, otherwise it is disabled. `shortCircuitEvaluationResult` is true.\r\n         */\r\n        const shortCircuitEvaluationResult: boolean = requirementType === RequirementType.Any;\r\n\r\n        for (const clientFilter of clientFilters) {\r\n            const matchedFeatureFilter = this.#featureFilters.get(clientFilter.name);\r\n            const contextWithFeatureName = { featureName, parameters: clientFilter.parameters };\r\n            if (matchedFeatureFilter === undefined) {\r\n                console.warn(`Feature filter ${clientFilter.name} is not found.`);\r\n                return false;\r\n            }\r\n            if (await matchedFeatureFilter.evaluate(contextWithFeatureName, context) === shortCircuitEvaluationResult) {\r\n                return shortCircuitEvaluationResult;\r\n            }\r\n        }\r\n\r\n        // If we get here, then we have not found a client filter that matches the requirement type.\r\n        return !shortCircuitEvaluationResult;\r\n    }\r\n\r\n}\r\n\r\ninterface FeatureManagerOptions {\r\n    customFilters?: IFeatureFilter[];\r\n}\r\n"]}

package/dist-esm/featureProvider.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"featureProvider.js","sourceRoot":"","sources":["../src/featureProvider.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EAA+C,sBAAsB,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAejH;;GAEG;AACH,MAAM,OAAO,mCAAmC;IAC5C,cAAc,CAAY;IAE1B,YAAY,aAAwB;QAChC,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;IACxC,CAAC;IACD,KAAK,CAAC,cAAc,CAAC,WAAmB;QACpC,MAAM,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAiC,sBAAsB,CAAC,CAAC;QACtG,OAAO,aAAa,EAAE,CAAC,iBAAiB,CAAC,EAAE,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,KAAK,WAAW,CAAC,CAAC;IAC7F,CAAC;IAED,KAAK,CAAC,eAAe;QACjB,MAAM,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAiC,sBAAsB,CAAC,CAAC;QACtG,OAAO,aAAa,EAAE,CAAC,iBAAiB,CAAC,IAAI,EAAE,CAAC;IACpD,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,OAAO,sCAAsC;IAC/C,cAAc,CAA0B;IAExC,YAAY,aAAsC;QAC9C,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;IACxC,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,WAAmB;QACpC,MAAM,YAAY,GAAG,IAAI,CAAC,cAAc,CAAC,sBAAsB,CAAC,EAAE,CAAC,iBAAiB,CAAC,CAAC;QACtF,OAAO,YAAY,EAAE,IAAI,CAAC,CAAC,OAAoB,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,KAAK,WAAW,CAAC,CAAC;IACpF,CAAC;IAED,KAAK,CAAC,eAAe;QACjB,OAAO,IAAI,CAAC,cAAc,CAAC,sBAAsB,CAAC,EAAE,CAAC,iBAAiB,CAAC,IAAI,EAAE,CAAC;IAClF,CAAC;CACJ","sourcesContent":["// Copyright (c) Microsoft Corporation.\r\n// Licensed under the MIT license.\r\n\r\nimport { IGettable } from \"./gettable\";\r\nimport { FeatureFlag, FeatureManagementConfiguration, FEATURE_MANAGEMENT_KEY, FEATURE_FLAGS_KEY } from \"./model\";\r\n\r\nexport interface IFeatureFlagProvider {\r\n    /**\r\n     * Get all feature flags.\r\n     */\r\n    getFeatureFlags(): Promise<FeatureFlag[]>;\r\n\r\n    /**\r\n     * Get a feature flag by name.\r\n     * @param featureName The name of the feature flag.\r\n     */\r\n    getFeatureFlag(featureName: string): Promise<FeatureFlag | undefined>;\r\n}\r\n\r\n/**\r\n * A feature flag provider that uses a map-like configuration to provide feature flags.\r\n */\r\nexport class ConfigurationMapFeatureFlagProvider implements IFeatureFlagProvider {\r\n    #configuration: IGettable;\r\n\r\n    constructor(configuration: IGettable) {\r\n        this.#configuration = configuration;\r\n    }\r\n    async getFeatureFlag(featureName: string): Promise<FeatureFlag | undefined> {\r\n        const featureConfig = this.#configuration.get<FeatureManagementConfiguration>(FEATURE_MANAGEMENT_KEY);\r\n        return featureConfig?.[FEATURE_FLAGS_KEY]?.find((feature) => feature.id === featureName);\r\n    }\r\n\r\n    async getFeatureFlags(): Promise<FeatureFlag[]> {\r\n        const featureConfig = this.#configuration.get<FeatureManagementConfiguration>(FEATURE_MANAGEMENT_KEY);\r\n        return featureConfig?.[FEATURE_FLAGS_KEY] ?? [];\r\n    }\r\n}\r\n\r\n/**\r\n * A feature flag provider that uses an object-like configuration to provide feature flags.\r\n */\r\nexport class ConfigurationObjectFeatureFlagProvider implements IFeatureFlagProvider {\r\n    #configuration: Record<string, unknown>;\r\n\r\n    constructor(configuration: Record<string, unknown>) {\r\n        this.#configuration = configuration;\r\n    }\r\n\r\n    async getFeatureFlag(featureName: string): Promise<FeatureFlag | undefined> {\r\n        const featureFlags = this.#configuration[FEATURE_MANAGEMENT_KEY]?.[FEATURE_FLAGS_KEY];\r\n        return featureFlags?.find((feature: FeatureFlag) => feature.id === featureName);\r\n    }\r\n\r\n    async getFeatureFlags(): Promise<FeatureFlag[]> {\r\n        return this.#configuration[FEATURE_MANAGEMENT_KEY]?.[FEATURE_FLAGS_KEY] ?? [];\r\n    }\r\n}\r\n"]}

package/dist-esm/filter/FeatureFilter.js

@@ -1,4 +0,0 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-export {};
-//# sourceMappingURL=FeatureFilter.js.map

package/dist-esm/filter/FeatureFilter.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"FeatureFilter.js","sourceRoot":"","sources":["../../src/filter/FeatureFilter.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\r\n// Licensed under the MIT license.\r\n\r\nexport interface IFeatureFilter {\r\n    name: string; // e.g. Microsoft.TimeWindow\r\n    evaluate(context: IFeatureFilterEvaluationContext, appContext?: unknown): boolean | Promise<boolean>;\r\n}\r\n\r\nexport interface IFeatureFilterEvaluationContext {\r\n    featureName: string;\r\n    parameters?: unknown;\r\n}\r\n"]}

package/dist-esm/filter/TargetingFilter.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"TargetingFilter.js","sourceRoot":"","sources":["../../src/filter/TargetingFilter.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AA2BpC,MAAM,OAAO,eAAe;IACxB,IAAI,GAAW,qBAAqB,CAAC;IAErC,QAAQ,CAAC,OAAyC,EAAE,UAAsC;QACtF,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;QAC5C,eAAe,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;QAEhD,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;QACzE,CAAC;QAED,IAAI,UAAU,CAAC,QAAQ,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YAC9C,6CAA6C;YAC7C,IAAI,UAAU,EAAE,MAAM,KAAK,SAAS;gBAChC,UAAU,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,KAAK,SAAS;gBACjD,UAAU,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;gBAClE,OAAO,KAAK,CAAC;YACjB,CAAC;YACD,wDAAwD;YACxD,IAAI,UAAU,EAAE,MAAM,KAAK,SAAS;gBAChC,UAAU,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;gBACrD,KAAK,MAAM,aAAa,IAAI,UAAU,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;oBAC/D,IAAI,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC;wBAC5C,OAAO,KAAK,CAAC;oBACjB,CAAC;gBACL,CAAC;YACL,CAAC;QACL,CAAC;QAED,+CAA+C;QAC/C,IAAI,UAAU,EAAE,MAAM,KAAK,SAAS;YAChC,UAAU,CAAC,QAAQ,CAAC,KAAK,KAAK,SAAS;YACvC,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;YACxD,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,yDAAyD;QACzD,IAAI,UAAU,EAAE,MAAM,KAAK,SAAS;YAChC,UAAU,CAAC,QAAQ,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC3C,KAAK,MAAM,KAAK,IAAI,UAAU,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;gBAC7C,IAAI,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;oBACzC,MAAM,iBAAiB,GAAG,0BAA0B,CAAC,WAAW,EAAE,UAAU,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;oBACjG,MAAM,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,CAAC;oBAClD,IAAI,eAAe,CAAC,WAAW,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,EAAE,CAAC;wBACpE,OAAO,IAAI,CAAC;oBAChB,CAAC;gBACL,CAAC;YACL,CAAC;QACL,CAAC;QAED,sEAAsE;QACtE,MAAM,gBAAgB,GAAG,0BAA0B,CAAC,WAAW,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;QACrF,OAAO,eAAe,CAAC,WAAW,CAAC,gBAAgB,EAAE,UAAU,CAAC,QAAQ,CAAC,wBAAwB,CAAC,CAAC;IACvG,CAAC;IAED,MAAM,CAAC,WAAW,CAAC,iBAAyB,EAAE,iBAAyB;QACnE,IAAI,iBAAiB,KAAK,GAAG,EAAE,CAAC;YAC5B,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,+EAA+E;QAC/E,MAAM,aAAa,GAAG,cAAc,CAAC,iBAAiB,CAAC,CAAC;QACxD,MAAM,iBAAiB,GAAG,CAAC,aAAa,GAAG,UAAU,CAAC,GAAG,GAAG,CAAC;QAC7D,OAAO,iBAAiB,GAAG,iBAAiB,CAAC;IACjD,CAAC;IAED,MAAM,CAAC,mBAAmB,CAAC,UAAqC;QAC5D,IAAI,UAAU,CAAC,QAAQ,CAAC,wBAAwB,GAAG,CAAC,IAAI,UAAU,CAAC,QAAQ,CAAC,wBAAwB,GAAG,GAAG,EAAE,CAAC;YACzG,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC;QAC7F,CAAC;QACD,4CAA4C;QAC5C,IAAI,UAAU,CAAC,QAAQ,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC3C,KAAK,MAAM,KAAK,IAAI,UAAU,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;gBAC7C,IAAI,KAAK,CAAC,iBAAiB,GAAG,CAAC,IAAI,KAAK,CAAC,iBAAiB,GAAG,GAAG,EAAE,CAAC;oBAC/D,MAAM,IAAI,KAAK,CAAC,8BAA8B,KAAK,CAAC,IAAI,sCAAsC,CAAC,CAAC;gBACpG,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC;CACJ;AAED;;;;;;;;;;;;GAYG;AACH,SAAS,0BAA0B,CAAC,WAAmB,EAAE,MAA0B,EAAE,SAAkB;IACnG,IAAI,SAAS,GAAG,GAAG,MAAM,IAAI,EAAE,KAAK,WAAW,EAAE,CAAC;IAClD,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QAC1B,SAAS,IAAI,KAAK,SAAS,EAAE,CAAC;IAClC,CAAC;IACD,OAAO,SAAS,CAAA;AACpB,CAAC;AAED,SAAS,cAAc,CAAC,GAAW;IAC/B,sCAAsC;IACtC,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC;IAEvD,oCAAoC;IACpC,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAExC,8DAA8D;IAC9D,MAAM,MAAM,GAAG,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAC3C,OAAO,MAAM,CAAC;AAClB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\r\n// Licensed under the MIT license.\r\n\r\nimport { IFeatureFilter } from \"./FeatureFilter\";\r\nimport { createHash } from \"crypto\";\r\n\r\ntype TargetingFilterParameters = {\r\n    Audience: {\r\n        DefaultRolloutPercentage: number;\r\n        Users?: string[];\r\n        Groups?: {\r\n            Name: string;\r\n            RolloutPercentage: number;\r\n        }[];\r\n        Exclusion?: {\r\n            Users?: string[];\r\n            Groups?: string[];\r\n        };\r\n    }\r\n}\r\n\r\ntype TargetingFilterEvaluationContext = {\r\n    featureName: string;\r\n    parameters: TargetingFilterParameters;\r\n}\r\n\r\ntype TargetingFilterAppContext = {\r\n    userId?: string;\r\n    groups?: string[];\r\n}\r\n\r\nexport class TargetingFilter implements IFeatureFilter {\r\n    name: string = \"Microsoft.Targeting\";\r\n\r\n    evaluate(context: TargetingFilterEvaluationContext, appContext?: TargetingFilterAppContext): boolean {\r\n        const { featureName, parameters } = context;\r\n        TargetingFilter.#validateParameters(parameters);\r\n\r\n        if (appContext === undefined) {\r\n            throw new Error(\"The app context is required for targeting filter.\");\r\n        }\r\n\r\n        if (parameters.Audience.Exclusion !== undefined) {\r\n            // check if the user is in the exclusion list\r\n            if (appContext?.userId !== undefined &&\r\n                parameters.Audience.Exclusion.Users !== undefined &&\r\n                parameters.Audience.Exclusion.Users.includes(appContext.userId)) {\r\n                return false;\r\n            }\r\n            // check if the user is in a group within exclusion list\r\n            if (appContext?.groups !== undefined &&\r\n                parameters.Audience.Exclusion.Groups !== undefined) {\r\n                for (const excludedGroup of parameters.Audience.Exclusion.Groups) {\r\n                    if (appContext.groups.includes(excludedGroup)) {\r\n                        return false;\r\n                    }\r\n                }\r\n            }\r\n        }\r\n\r\n        // check if the user is being targeted directly\r\n        if (appContext?.userId !== undefined &&\r\n            parameters.Audience.Users !== undefined &&\r\n            parameters.Audience.Users.includes(appContext.userId)) {\r\n            return true;\r\n        }\r\n\r\n        // check if the user is in a group that is being targeted\r\n        if (appContext?.groups !== undefined &&\r\n            parameters.Audience.Groups !== undefined) {\r\n            for (const group of parameters.Audience.Groups) {\r\n                if (appContext.groups.includes(group.Name)) {\r\n                    const audienceContextId = constructAudienceContextId(featureName, appContext.userId, group.Name);\r\n                    const rolloutPercentage = group.RolloutPercentage;\r\n                    if (TargetingFilter.#isTargeted(audienceContextId, rolloutPercentage)) {\r\n                        return true;\r\n                    }\r\n                }\r\n            }\r\n        }\r\n\r\n        // check if the user is being targeted by a default rollout percentage\r\n        const defaultContextId = constructAudienceContextId(featureName, appContext?.userId);\r\n        return TargetingFilter.#isTargeted(defaultContextId, parameters.Audience.DefaultRolloutPercentage);\r\n    }\r\n\r\n    static #isTargeted(audienceContextId: string, rolloutPercentage: number): boolean {\r\n        if (rolloutPercentage === 100) {\r\n            return true;\r\n        }\r\n        // Cryptographic hashing algorithms ensure adequate entropy across hash values.\r\n        const contextMarker = stringToUint32(audienceContextId);\r\n        const contextPercentage = (contextMarker / 0xFFFFFFFF) * 100;\r\n        return contextPercentage < rolloutPercentage;\r\n    }\r\n\r\n    static #validateParameters(parameters: TargetingFilterParameters): void {\r\n        if (parameters.Audience.DefaultRolloutPercentage < 0 || parameters.Audience.DefaultRolloutPercentage > 100) {\r\n            throw new Error(\"Audience.DefaultRolloutPercentage must be a number between 0 and 100.\");\r\n        }\r\n        // validate RolloutPercentage for each group\r\n        if (parameters.Audience.Groups !== undefined) {\r\n            for (const group of parameters.Audience.Groups) {\r\n                if (group.RolloutPercentage < 0 || group.RolloutPercentage > 100) {\r\n                    throw new Error(`RolloutPercentage of group ${group.Name} must be a number between 0 and 100.`);\r\n                }\r\n            }\r\n        }\r\n    }\r\n}\r\n\r\n/**\r\n * Constructs the context id for the audience.\r\n * The context id is used to determine if the user is part of the audience for a feature.\r\n * If groupName is provided, the context id is constructed as follows:\r\n *  userId + \"\\n\" + featureName + \"\\n\" + groupName\r\n * Otherwise, the context id is constructed as follows:\r\n *  userId + \"\\n\" + featureName\r\n *\r\n * @param featureName name of the feature\r\n * @param userId userId from app context\r\n * @param groupName group name from app context\r\n * @returns a string that represents the context id for the audience\r\n */\r\nfunction constructAudienceContextId(featureName: string, userId: string | undefined, groupName?: string) {\r\n    let contextId = `${userId ?? \"\"}\\n${featureName}`;\r\n    if (groupName !== undefined) {\r\n        contextId += `\\n${groupName}`;\r\n    }\r\n    return contextId\r\n}\r\n\r\nfunction stringToUint32(str: string): number {\r\n    // Create a SHA-256 hash of the string\r\n    const hash = createHash(\"sha256\").update(str).digest();\r\n\r\n    // Get the first 4 bytes of the hash\r\n    const first4Bytes = hash.subarray(0, 4);\r\n\r\n    // Convert the 4 bytes to a uint32 with little-endian encoding\r\n    const uint32 = first4Bytes.readUInt32LE(0);\r\n    return uint32;\r\n}\r\n"]}

package/dist-esm/gettable.js

@@ -1,6 +0,0 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-export function isGettable(object) {
-    return typeof object === "object" && object !== null && typeof object.get === "function";
-}
-//# sourceMappingURL=gettable.js.map

package/dist-esm/gettable.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"gettable.js","sourceRoot":"","sources":["../src/gettable.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAMlC,MAAM,UAAU,UAAU,CAAC,MAAe;IACtC,OAAO,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,IAAI,OAAQ,MAAoB,CAAC,GAAG,KAAK,UAAU,CAAC;AAC5G,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\r\n// Licensed under the MIT license.\r\n\r\nexport interface IGettable {\r\n    get<T>(key: string): T | undefined;\r\n}\r\n\r\nexport function isGettable(object: unknown): object is IGettable {\r\n    return typeof object === \"object\" && object !== null && typeof (object as IGettable).get === \"function\";\r\n}\n"]}

package/dist-esm/index.js

@@ -1,5 +0,0 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-export { FeatureManager } from "./featureManager";
-export { ConfigurationMapFeatureFlagProvider, ConfigurationObjectFeatureFlagProvider } from "./featureProvider";
-//# sourceMappingURL=index.js.map

package/dist-esm/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,mCAAmC,EAAE,sCAAsC,EAAwB,MAAM,mBAAmB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\r\n// Licensed under the MIT license.\r\n\r\nexport { FeatureManager } from \"./featureManager\";\r\nexport { ConfigurationMapFeatureFlagProvider, ConfigurationObjectFeatureFlagProvider, IFeatureFlagProvider } from \"./featureProvider\";\n"]}

package/dist-esm/model.js

@@ -1,12 +0,0 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-export var RequirementType;
-(function (RequirementType) {
-    RequirementType["Any"] = "Any";
-    RequirementType["All"] = "All";
-})(RequirementType || (RequirementType = {}));
-// Feature Management Section fed into feature manager.
-// Converted from https://github.com/Azure/AppConfiguration/blob/main/docs/FeatureManagement/FeatureManagement.v1.0.0.schema.json
-export const FEATURE_MANAGEMENT_KEY = "feature_management";
-export const FEATURE_FLAGS_KEY = "feature_flags";
-//# sourceMappingURL=model.js.map

package/dist-esm/model.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"model.js","sourceRoot":"","sources":["../src/model.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AA+BlC,MAAM,CAAN,IAAY,eAGX;AAHD,WAAY,eAAe;IACzB,8BAAW,CAAA;IACX,8BAAW,CAAA;AACb,CAAC,EAHW,eAAe,KAAf,eAAe,QAG1B;AAyBD,uDAAuD;AACvD,iIAAiI;AAEjI,MAAM,CAAC,MAAM,sBAAsB,GAAG,oBAAoB,CAAA;AAC1D,MAAM,CAAC,MAAM,iBAAiB,GAAG,eAAe,CAAA","sourcesContent":["// Copyright (c) Microsoft Corporation.\r\n// Licensed under the MIT license.\r\n\r\n// Converted from https://github.com/Azure/AppConfiguration/blob/main/docs/FeatureManagement/FeatureFlag.v1.1.0.schema.json\r\n\r\nexport interface FeatureFlag {\r\n  /**\r\n   * An ID used to uniquely identify and reference the feature.\r\n   */\r\n  id: string\r\n\r\n  /**\r\n   * A description of the feature.\r\n   */\r\n  description?: string\r\n\r\n  /**\r\n   * A display name for the feature to use for display rather than the ID.\r\n   */\r\n  display_name?: string\r\n\r\n  /**\r\n   * A feature is OFF if enabled is false. If enabled is true, then the feature is ON if there are no conditions (null or empty) or if the conditions are satisfied.\r\n   */\r\n  enabled: boolean\r\n\r\n  /**\r\n   * The declaration of conditions used to dynamically enable features.\r\n   */\r\n  conditions?: FeatureEnablementConditions\r\n}\r\n\r\nexport enum RequirementType {\r\n  Any = \"Any\",\r\n  All = \"All\"\r\n}\r\n\r\nexport interface FeatureEnablementConditions {\r\n  /**\r\n   * Determines whether any or all registered client filters must be evaluated as true for the feature to be considered enabled.\r\n   */\r\n  requirement_type?: RequirementType\r\n\r\n  /**\r\n   * Filters that must run on the client and be evaluated as true for the feature to be considered enabled.\r\n   */\r\n  client_filters?: ClientFilter[]\r\n}\r\n\r\nexport interface ClientFilter {\r\n  /**\r\n   * The name used to refer to and require a client filter.\r\n   */\r\n  name: string\r\n  /**\r\n   * Custom parameters for a given client filter. A client filter can require any set of parameters of any type.\r\n   */\r\n  parameters?: unknown\r\n}\r\n\r\n// Feature Management Section fed into feature manager.\r\n// Converted from https://github.com/Azure/AppConfiguration/blob/main/docs/FeatureManagement/FeatureManagement.v1.0.0.schema.json\r\n\r\nexport const FEATURE_MANAGEMENT_KEY = \"feature_management\"\r\nexport const FEATURE_FLAGS_KEY = \"feature_flags\"\r\n\r\nexport interface FeatureManagementConfiguration {\r\n  feature_management: FeatureManagement\r\n}\r\n\r\n/**\r\n * Declares feature management configuration.\r\n */\r\nexport interface FeatureManagement {\r\n  feature_flags: FeatureFlag[];\r\n}\r\n"]}