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

package/README.md

@@ -1,5 +1,7 @@
 # Microsoft Feature Management for JavaScript
 
+[![feature-management](https://img.shields.io/npm/v/@microsoft/feature-management?label=@microsoft/feature-management)](https://www.npmjs.com/package/@microsoft/feature-management)
+
 Feature Management is a library for enabling/disabling features at runtime.
 Developers can use feature flags in simple use cases like conditional statement to more advanced scenarios like conditionally adding routes.
 

package/dist/commonjs/common/targetingEvaluator.js

@@ -0,0 +1,119 @@
+'use strict';
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/**
+ * Determines if the user is part of the audience, based on the user id and the percentage range.
+ *
+ * @param userId user id from app context
+ * @param hint hint string to be included in the context id
+ * @param from percentage range start
+ * @param to percentage range end
+ * @returns true if the user is part of the audience, false otherwise
+ */
+async function isTargetedPercentile(userId, hint, from, to) {
+    if (from < 0 || from > 100) {
+        throw new Error("The 'from' value must be between 0 and 100.");
+    }
+    if (to < 0 || to > 100) {
+        throw new Error("The 'to' value must be between 0 and 100.");
+    }
+    if (from > to) {
+        throw new Error("The 'from' value cannot be larger than the 'to' value.");
+    }
+    const audienceContextId = constructAudienceContextId(userId, hint);
+    // Cryptographic hashing algorithms ensure adequate entropy across hash values.
+    const contextMarker = await stringToUint32(audienceContextId);
+    const contextPercentage = (contextMarker / 0xFFFFFFFF) * 100;
+    // Handle edge case of exact 100 bucket
+    if (to === 100) {
+        return contextPercentage >= from;
+    }
+    return contextPercentage >= from && contextPercentage < to;
+}
+/**
+ * Determines if the user is part of the audience, based on the groups they belong to.
+ *
+ * @param sourceGroups user groups from app context
+ * @param targetedGroups targeted groups from feature configuration
+ * @returns true if the user is part of the audience, false otherwise
+ */
+function isTargetedGroup(sourceGroups, targetedGroups) {
+    if (sourceGroups === undefined) {
+        return false;
+    }
+    return sourceGroups.some(group => targetedGroups.includes(group));
+}
+/**
+ * Determines if the user is part of the audience, based on the user id.
+ * @param userId user id from app context
+ * @param users targeted users from feature configuration
+ * @returns true if the user is part of the audience, false otherwise
+ */
+function isTargetedUser(userId, users) {
+    if (userId === undefined) {
+        return false;
+    }
+    return users.includes(userId);
+}
+/**
+ * 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.
+ *
+ * @param userId userId from app context
+ * @param hint hint string to be included in the context id
+ * @returns a string that represents the context id for the audience
+ */
+function constructAudienceContextId(userId, hint) {
+    return `${userId ?? ""}\n${hint}`;
+}
+/**
+ * Converts a string to a uint32 in little-endian encoding.
+ * @param str the string to convert.
+ * @returns a uint32 value.
+ */
+async function stringToUint32(str) {
+    let crypto;
+    // Check for browser environment
+    if (typeof window !== "undefined" && window.crypto && window.crypto.subtle) {
+        crypto = window.crypto;
+    }
+    // Check for Node.js environment
+    else if (typeof global !== "undefined" && global.crypto) {
+        crypto = global.crypto;
+    }
+    // Fallback to native Node.js crypto module
+    else {
+        try {
+            if (typeof module !== "undefined" && module.exports) {
+                crypto = require("crypto");
+            }
+            else {
+                crypto = await import('crypto');
+            }
+        }
+        catch (error) {
+            console.error("Failed to load the crypto module:", error.message);
+            throw error;
+        }
+    }
+    // In the browser, use crypto.subtle.digest
+    if (crypto.subtle) {
+        const data = new TextEncoder().encode(str);
+        const hashBuffer = await crypto.subtle.digest("SHA-256", data);
+        const dataView = new DataView(hashBuffer);
+        const uint32 = dataView.getUint32(0, true);
+        return uint32;
+    }
+    // In Node.js, use the crypto module's hash function
+    else {
+        const hash = crypto.createHash("sha256").update(str).digest();
+        const uint32 = hash.readUInt32LE(0);
+        return uint32;
+    }
+}
+
+exports.isTargetedGroup = isTargetedGroup;
+exports.isTargetedPercentile = isTargetedPercentile;
+exports.isTargetedUser = isTargetedUser;
+//# sourceMappingURL=targetingEvaluator.js.map

package/dist/commonjs/common/targetingEvaluator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"targetingEvaluator.js","sources":["../../../src/common/targetingEvaluator.ts"],"sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\n/**\n * Determines if the user is part of the audience, based on the user id and the percentage range.\n *\n * @param userId user id from app context\n * @param hint hint string to be included in the context id\n * @param from percentage range start\n * @param to percentage range end\n * @returns true if the user is part of the audience, false otherwise\n */\nexport async function isTargetedPercentile(userId: string | undefined, hint: string, from: number, to: number): Promise<boolean> {\n    if (from < 0 || from > 100) {\n        throw new Error(\"The 'from' value must be between 0 and 100.\");\n    }\n    if (to < 0 || to > 100) {\n        throw new Error(\"The 'to' value must be between 0 and 100.\");\n    }\n    if (from > to) {\n        throw new Error(\"The 'from' value cannot be larger than the 'to' value.\");\n    }\n\n    const audienceContextId = constructAudienceContextId(userId, hint);\n\n    // Cryptographic hashing algorithms ensure adequate entropy across hash values.\n    const contextMarker = await stringToUint32(audienceContextId);\n    const contextPercentage = (contextMarker / 0xFFFFFFFF) * 100;\n\n    // Handle edge case of exact 100 bucket\n    if (to === 100) {\n        return contextPercentage >= from;\n    }\n\n    return contextPercentage >= from && contextPercentage < to;\n}\n\n/**\n * Determines if the user is part of the audience, based on the groups they belong to.\n *\n * @param sourceGroups user groups from app context\n * @param targetedGroups targeted groups from feature configuration\n * @returns true if the user is part of the audience, false otherwise\n */\nexport function isTargetedGroup(sourceGroups: string[] | undefined, targetedGroups: string[]): boolean {\n    if (sourceGroups === undefined) {\n        return false;\n    }\n\n    return sourceGroups.some(group => targetedGroups.includes(group));\n}\n\n/**\n * Determines if the user is part of the audience, based on the user id.\n * @param userId user id from app context\n * @param users targeted users from feature configuration\n * @returns true if the user is part of the audience, false otherwise\n */\nexport function isTargetedUser(userId: string | undefined, users: string[]): boolean {\n    if (userId === undefined) {\n        return false;\n    }\n\n    return users.includes(userId);\n}\n\n/**\n * Constructs the context id for the audience.\n * The context id is used to determine if the user is part of the audience for a feature.\n *\n * @param userId userId from app context\n * @param hint hint string to be included in the context id\n * @returns a string that represents the context id for the audience\n */\nfunction constructAudienceContextId(userId: string | undefined, hint: string): string {\n    return `${userId ?? \"\"}\\n${hint}`;\n}\n\n/**\n * Converts a string to a uint32 in little-endian encoding.\n * @param str the string to convert.\n * @returns a uint32 value.\n */\nasync function stringToUint32(str: string): Promise<number> {\n    let crypto;\n\n    // Check for browser environment\n    if (typeof window !== \"undefined\" && window.crypto && window.crypto.subtle) {\n        crypto = window.crypto;\n    }\n    // Check for Node.js environment\n    else if (typeof global !== \"undefined\" && global.crypto) {\n        crypto = global.crypto;\n    }\n    // Fallback to native Node.js crypto module\n    else {\n        try {\n            if (typeof module !== \"undefined\" && module.exports) {\n                crypto = require(\"crypto\");\n            }\n            else {\n                crypto = await import(\"crypto\");\n            }\n        } catch (error) {\n            console.error(\"Failed to load the crypto module:\", error.message);\n            throw error;\n        }\n    }\n\n    // In the browser, use crypto.subtle.digest\n    if (crypto.subtle) {\n        const data = new TextEncoder().encode(str);\n        const hashBuffer = await crypto.subtle.digest(\"SHA-256\", data);\n        const dataView = new DataView(hashBuffer);\n        const uint32 = dataView.getUint32(0, true);\n        return uint32;\n    }\n    // In Node.js, use the crypto module's hash function\n    else {\n        const hash = crypto.createHash(\"sha256\").update(str).digest();\n        const uint32 = hash.readUInt32LE(0);\n        return uint32;\n    }\n}\n"],"names":[],"mappings":";;AAAA;AACA;AAEA;;;;;;;;AAQG;AACI,eAAe,oBAAoB,CAAC,MAA0B,EAAE,IAAY,EAAE,IAAY,EAAE,EAAU,EAAA;IACzG,IAAI,IAAI,GAAG,CAAC,IAAI,IAAI,GAAG,GAAG,EAAE;AACxB,QAAA,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;KAClE;IACD,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,GAAG,GAAG,EAAE;AACpB,QAAA,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;KAChE;AACD,IAAA,IAAI,IAAI,GAAG,EAAE,EAAE;AACX,QAAA,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;KAC7E;IAED,MAAM,iBAAiB,GAAG,0BAA0B,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;;AAGnE,IAAA,MAAM,aAAa,GAAG,MAAM,cAAc,CAAC,iBAAiB,CAAC,CAAC;IAC9D,MAAM,iBAAiB,GAAG,CAAC,aAAa,GAAG,UAAU,IAAI,GAAG,CAAC;;AAG7D,IAAA,IAAI,EAAE,KAAK,GAAG,EAAE;QACZ,OAAO,iBAAiB,IAAI,IAAI,CAAC;KACpC;AAED,IAAA,OAAO,iBAAiB,IAAI,IAAI,IAAI,iBAAiB,GAAG,EAAE,CAAC;AAC/D,CAAC;AAED;;;;;;AAMG;AACa,SAAA,eAAe,CAAC,YAAkC,EAAE,cAAwB,EAAA;AACxF,IAAA,IAAI,YAAY,KAAK,SAAS,EAAE;AAC5B,QAAA,OAAO,KAAK,CAAC;KAChB;AAED,IAAA,OAAO,YAAY,CAAC,IAAI,CAAC,KAAK,IAAI,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;AACtE,CAAC;AAED;;;;;AAKG;AACa,SAAA,cAAc,CAAC,MAA0B,EAAE,KAAe,EAAA;AACtE,IAAA,IAAI,MAAM,KAAK,SAAS,EAAE;AACtB,QAAA,OAAO,KAAK,CAAC;KAChB;AAED,IAAA,OAAO,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AAClC,CAAC;AAED;;;;;;;AAOG;AACH,SAAS,0BAA0B,CAAC,MAA0B,EAAE,IAAY,EAAA;AACxE,IAAA,OAAO,GAAG,MAAM,IAAI,EAAE,CAAK,EAAA,EAAA,IAAI,EAAE,CAAC;AACtC,CAAC;AAED;;;;AAIG;AACH,eAAe,cAAc,CAAC,GAAW,EAAA;AACrC,IAAA,IAAI,MAAM,CAAC;;AAGX,IAAA,IAAI,OAAO,MAAM,KAAK,WAAW,IAAI,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE;AACxE,QAAA,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;KAC1B;;SAEI,IAAI,OAAO,MAAM,KAAK,WAAW,IAAI,MAAM,CAAC,MAAM,EAAE;AACrD,QAAA,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;KAC1B;;SAEI;AACD,QAAA,IAAI;YACA,IAAI,OAAO,MAAM,KAAK,WAAW,IAAI,MAAM,CAAC,OAAO,EAAE;AACjD,gBAAA,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;aAC9B;iBACI;AACD,gBAAA,MAAM,GAAG,MAAM,OAAO,QAAQ,CAAC,CAAC;aACnC;SACJ;QAAC,OAAO,KAAK,EAAE;YACZ,OAAO,CAAC,KAAK,CAAC,mCAAmC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;AAClE,YAAA,MAAM,KAAK,CAAC;SACf;KACJ;;AAGD,IAAA,IAAI,MAAM,CAAC,MAAM,EAAE;QACf,MAAM,IAAI,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;AAC3C,QAAA,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;AAC/D,QAAA,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC1C,MAAM,MAAM,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;AAC3C,QAAA,OAAO,MAAM,CAAC;KACjB;;SAEI;AACD,QAAA,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC;QAC9D,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;AACpC,QAAA,OAAO,MAAM,CAAC;KACjB;AACL;;;;;;"}

package/dist/commonjs/featureManager.js

@@ -0,0 +1,247 @@
+'use strict';
+
+var TimeWindowFilter = require('./filter/TimeWindowFilter.js');
+var TargetingFilter = require('./filter/TargetingFilter.js');
+var Variant = require('./variant/Variant.js');
+var targetingEvaluator = require('./common/targetingEvaluator.js');
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+class FeatureManager {
+    #provider;
+    #featureFilters = new Map();
+    #onFeatureEvaluated;
+    constructor(provider, options) {
+        this.#provider = provider;
+        const builtinFilters = [new TimeWindowFilter.TimeWindowFilter(), new TargetingFilter.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);
+        }
+        this.#onFeatureEvaluated = options?.onFeatureEvaluated;
+    }
+    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 result = await this.#evaluateFeature(featureName, context);
+        return result.enabled;
+    }
+    async getVariant(featureName, context) {
+        const result = await this.#evaluateFeature(featureName, context);
+        return result.variant;
+    }
+    async #assignVariant(featureFlag, context) {
+        // user allocation
+        if (featureFlag.allocation?.user !== undefined) {
+            for (const userAllocation of featureFlag.allocation.user) {
+                if (targetingEvaluator.isTargetedUser(context.userId, userAllocation.users)) {
+                    return getVariantAssignment(featureFlag, userAllocation.variant, exports.VariantAssignmentReason.User);
+                }
+            }
+        }
+        // group allocation
+        if (featureFlag.allocation?.group !== undefined) {
+            for (const groupAllocation of featureFlag.allocation.group) {
+                if (targetingEvaluator.isTargetedGroup(context.groups, groupAllocation.groups)) {
+                    return getVariantAssignment(featureFlag, groupAllocation.variant, exports.VariantAssignmentReason.Group);
+                }
+            }
+        }
+        // percentile allocation
+        if (featureFlag.allocation?.percentile !== undefined) {
+            for (const percentileAllocation of featureFlag.allocation.percentile) {
+                const hint = featureFlag.allocation.seed ?? `allocation\n${featureFlag.id}`;
+                if (await targetingEvaluator.isTargetedPercentile(context.userId, hint, percentileAllocation.from, percentileAllocation.to)) {
+                    return getVariantAssignment(featureFlag, percentileAllocation.variant, exports.VariantAssignmentReason.Percentile);
+                }
+            }
+        }
+        return { variant: undefined, reason: exports.VariantAssignmentReason.None };
+    }
+    async #isEnabled(featureFlag, context) {
+        if (featureFlag.enabled !== true) {
+            // If the feature is not explicitly enabled, then it is disabled by default.
+            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 ?? "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 === "Any";
+        for (const clientFilter of clientFilters) {
+            const matchedFeatureFilter = this.#featureFilters.get(clientFilter.name);
+            const contextWithFeatureName = { featureName: featureFlag.id, 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;
+    }
+    async #evaluateFeature(featureName, context) {
+        const featureFlag = await this.#provider.getFeatureFlag(featureName);
+        const result = new EvaluationResult(featureFlag);
+        if (featureFlag === undefined) {
+            return result;
+        }
+        // Ensure that the feature flag is in the correct format. Feature providers should validate the feature flags, but we do it here as a safeguard.
+        // TODO: move to the feature flag provider implementation.
+        validateFeatureFlagFormat(featureFlag);
+        // Evaluate if the feature is enabled.
+        result.enabled = await this.#isEnabled(featureFlag, context);
+        const targetingContext = context;
+        result.targetingId = targetingContext?.userId;
+        // Determine Variant
+        let variantDef;
+        let reason = exports.VariantAssignmentReason.None;
+        // featureFlag.variant not empty
+        if (featureFlag.variants !== undefined && featureFlag.variants.length > 0) {
+            if (!result.enabled) {
+                // not enabled, assign default if specified
+                if (featureFlag.allocation?.default_when_disabled !== undefined) {
+                    variantDef = featureFlag.variants.find(v => v.name == featureFlag.allocation?.default_when_disabled);
+                    reason = exports.VariantAssignmentReason.DefaultWhenDisabled;
+                }
+                else {
+                    // no default specified
+                    variantDef = undefined;
+                    reason = exports.VariantAssignmentReason.DefaultWhenDisabled;
+                }
+            }
+            else {
+                // enabled, assign based on allocation
+                if (context !== undefined && featureFlag.allocation !== undefined) {
+                    const variantAndReason = await this.#assignVariant(featureFlag, targetingContext);
+                    variantDef = variantAndReason.variant;
+                    reason = variantAndReason.reason;
+                }
+                // allocation failed, assign default if specified
+                if (variantDef === undefined && reason === exports.VariantAssignmentReason.None) {
+                    if (featureFlag.allocation?.default_when_enabled !== undefined) {
+                        variantDef = featureFlag.variants.find(v => v.name == featureFlag.allocation?.default_when_enabled);
+                        reason = exports.VariantAssignmentReason.DefaultWhenEnabled;
+                    }
+                    else {
+                        variantDef = undefined;
+                        reason = exports.VariantAssignmentReason.DefaultWhenEnabled;
+                    }
+                }
+            }
+        }
+        result.variant = variantDef !== undefined ? new Variant.Variant(variantDef.name, variantDef.configuration_value) : undefined;
+        result.variantAssignmentReason = reason;
+        // Status override for isEnabled
+        if (variantDef !== undefined && featureFlag.enabled) {
+            if (variantDef.status_override === "Enabled") {
+                result.enabled = true;
+            }
+            else if (variantDef.status_override === "Disabled") {
+                result.enabled = false;
+            }
+        }
+        // The callback will only be executed if telemetry is enabled for the feature flag
+        if (featureFlag.telemetry?.enabled && this.#onFeatureEvaluated !== undefined) {
+            this.#onFeatureEvaluated(result);
+        }
+        return result;
+    }
+}
+class EvaluationResult {
+    feature;
+    enabled;
+    targetingId;
+    variant;
+    variantAssignmentReason;
+    constructor(
+    // feature flag definition
+    feature, 
+    // enabled state
+    enabled = false, 
+    // variant assignment
+    targetingId = undefined, variant = undefined, variantAssignmentReason = exports.VariantAssignmentReason.None) {
+        this.feature = feature;
+        this.enabled = enabled;
+        this.targetingId = targetingId;
+        this.variant = variant;
+        this.variantAssignmentReason = variantAssignmentReason;
+    }
+}
+exports.VariantAssignmentReason = void 0;
+(function (VariantAssignmentReason) {
+    /**
+     * Variant allocation did not happen. No variant is assigned.
+     */
+    VariantAssignmentReason["None"] = "None";
+    /**
+     * The default variant is assigned when a feature flag is disabled.
+     */
+    VariantAssignmentReason["DefaultWhenDisabled"] = "DefaultWhenDisabled";
+    /**
+     * The default variant is assigned because of no applicable user/group/percentile allocation when a feature flag is enabled.
+     */
+    VariantAssignmentReason["DefaultWhenEnabled"] = "DefaultWhenEnabled";
+    /**
+     * The variant is assigned because of the user allocation when a feature flag is enabled.
+     */
+    VariantAssignmentReason["User"] = "User";
+    /**
+     * The variant is assigned because of the group allocation when a feature flag is enabled.
+     */
+    VariantAssignmentReason["Group"] = "Group";
+    /**
+     * The variant is assigned because of the percentile allocation when a feature flag is enabled.
+     */
+    VariantAssignmentReason["Percentile"] = "Percentile";
+})(exports.VariantAssignmentReason || (exports.VariantAssignmentReason = {}));
+/**
+ * Validates the format of the feature flag definition.
+ *
+ * FeatureFlag data objects are from IFeatureFlagProvider, depending on the implementation.
+ * Thus the properties are not guaranteed to have the expected types.
+ *
+ * @param featureFlag The feature flag definition to validate.
+ */
+function validateFeatureFlagFormat(featureFlag) {
+    if (featureFlag.enabled !== undefined && typeof featureFlag.enabled !== "boolean") {
+        throw new Error(`Feature flag ${featureFlag.id} has an invalid 'enabled' value.`);
+    }
+    // TODO: add more validations.
+    // TODO: should be moved to the feature flag provider.
+}
+/**
+ * Try to get the variant assignment for the given variant name. If the variant is not found, override the reason with VariantAssignmentReason.None.
+ *
+ * @param featureFlag feature flag definition
+ * @param variantName variant name
+ * @param reason variant assignment reason
+ * @returns variant assignment containing the variant definition and the reason
+ */
+function getVariantAssignment(featureFlag, variantName, reason) {
+    const variant = featureFlag.variants?.find(v => v.name == variantName);
+    if (variant !== undefined) {
+        return { variant, reason };
+    }
+    else {
+        console.warn(`Variant ${variantName} not found for feature ${featureFlag.id}.`);
+        return { variant: undefined, reason: exports.VariantAssignmentReason.None };
+    }
+}
+
+exports.EvaluationResult = EvaluationResult;
+exports.FeatureManager = FeatureManager;
+//# sourceMappingURL=featureManager.js.map

package/dist/commonjs/featureManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"featureManager.js","sources":["../../src/featureManager.ts"],"sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { TimeWindowFilter } from \"./filter/TimeWindowFilter.js\";\nimport { IFeatureFilter } from \"./filter/FeatureFilter.js\";\nimport { FeatureFlag, RequirementType, VariantDefinition } from \"./model.js\";\nimport { IFeatureFlagProvider } from \"./featureProvider.js\";\nimport { TargetingFilter } from \"./filter/TargetingFilter.js\";\nimport { Variant } from \"./variant/Variant.js\";\nimport { IFeatureManager } from \"./IFeatureManager.js\";\nimport { ITargetingContext } from \"./common/ITargetingContext.js\";\nimport { isTargetedGroup, isTargetedPercentile, isTargetedUser } from \"./common/targetingEvaluator.js\";\n\nexport class FeatureManager implements IFeatureManager {\n    #provider: IFeatureFlagProvider;\n    #featureFilters: Map<string, IFeatureFilter> = new Map();\n    #onFeatureEvaluated?: (event: EvaluationResult) => void;\n\n    constructor(provider: IFeatureFlagProvider, options?: FeatureManagerOptions) {\n        this.#provider = provider;\n\n        const builtinFilters = [new TimeWindowFilter(), new TargetingFilter()];\n\n        // If a custom filter shares a name with an existing filter, the custom filter overrides the existing one.\n        for (const filter of [...builtinFilters, ...(options?.customFilters ?? [])]) {\n            this.#featureFilters.set(filter.name, filter);\n        }\n\n        this.#onFeatureEvaluated = options?.onFeatureEvaluated;\n    }\n\n    async listFeatureNames(): Promise<string[]> {\n        const features = await this.#provider.getFeatureFlags();\n        const featureNameSet = new Set(features.map((feature) => feature.id));\n        return Array.from(featureNameSet);\n    }\n\n    // If multiple feature flags are found, the first one takes precedence.\n    async isEnabled(featureName: string, context?: unknown): Promise<boolean> {\n        const result = await this.#evaluateFeature(featureName, context);\n        return result.enabled;\n    }\n\n    async getVariant(featureName: string, context?: ITargetingContext): Promise<Variant | undefined> {\n        const result = await this.#evaluateFeature(featureName, context);\n        return result.variant;\n    }\n\n    async #assignVariant(featureFlag: FeatureFlag, context: ITargetingContext): Promise<VariantAssignment> {\n        // user allocation\n        if (featureFlag.allocation?.user !== undefined) {\n            for (const userAllocation of featureFlag.allocation.user) {\n                if (isTargetedUser(context.userId, userAllocation.users)) {\n                    return getVariantAssignment(featureFlag, userAllocation.variant, VariantAssignmentReason.User);\n                }\n            }\n        }\n\n        // group allocation\n        if (featureFlag.allocation?.group !== undefined) {\n            for (const groupAllocation of featureFlag.allocation.group) {\n                if (isTargetedGroup(context.groups, groupAllocation.groups)) {\n                    return getVariantAssignment(featureFlag, groupAllocation.variant, VariantAssignmentReason.Group);\n                }\n            }\n        }\n\n        // percentile allocation\n        if (featureFlag.allocation?.percentile !== undefined) {\n            for (const percentileAllocation of featureFlag.allocation.percentile) {\n                const hint = featureFlag.allocation.seed ?? `allocation\\n${featureFlag.id}`;\n                if (await isTargetedPercentile(context.userId, hint, percentileAllocation.from, percentileAllocation.to)) {\n                    return getVariantAssignment(featureFlag, percentileAllocation.variant, VariantAssignmentReason.Percentile);\n                }\n            }\n        }\n\n        return { variant: undefined, reason: VariantAssignmentReason.None };\n    }\n\n    async #isEnabled(featureFlag: FeatureFlag, context?: unknown): Promise<boolean> {\n        if (featureFlag.enabled !== true) {\n            // If the feature is not explicitly enabled, then it is disabled by default.\n            return false;\n        }\n\n        const clientFilters = featureFlag.conditions?.client_filters;\n        if (clientFilters === undefined || clientFilters.length <= 0) {\n            // If there are no client filters, then the feature is enabled.\n            return true;\n        }\n\n        const requirementType: RequirementType = featureFlag.conditions?.requirement_type ?? \"Any\"; // default to any.\n\n        /**\n         * While iterating through the client filters, we short-circuit the evaluation based on the requirement type.\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.\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.\n         */\n        const shortCircuitEvaluationResult: boolean = requirementType === \"Any\";\n\n        for (const clientFilter of clientFilters) {\n            const matchedFeatureFilter = this.#featureFilters.get(clientFilter.name);\n            const contextWithFeatureName = { featureName: featureFlag.id, parameters: clientFilter.parameters };\n            if (matchedFeatureFilter === undefined) {\n                console.warn(`Feature filter ${clientFilter.name} is not found.`);\n                return false;\n            }\n            if (await matchedFeatureFilter.evaluate(contextWithFeatureName, context) === shortCircuitEvaluationResult) {\n                return shortCircuitEvaluationResult;\n            }\n        }\n\n        // If we get here, then we have not found a client filter that matches the requirement type.\n        return !shortCircuitEvaluationResult;\n    }\n\n    async #evaluateFeature(featureName: string, context: unknown): Promise<EvaluationResult> {\n        const featureFlag = await this.#provider.getFeatureFlag(featureName);\n        const result = new EvaluationResult(featureFlag);\n\n        if (featureFlag === undefined) {\n            return result;\n        }\n\n        // Ensure that the feature flag is in the correct format. Feature providers should validate the feature flags, but we do it here as a safeguard.\n        // TODO: move to the feature flag provider implementation.\n        validateFeatureFlagFormat(featureFlag);\n\n        // Evaluate if the feature is enabled.\n        result.enabled = await this.#isEnabled(featureFlag, context);\n\n        const targetingContext = context as ITargetingContext;\n        result.targetingId = targetingContext?.userId;\n\n        // Determine Variant\n        let variantDef: VariantDefinition | undefined;\n        let reason: VariantAssignmentReason = VariantAssignmentReason.None;\n\n        // featureFlag.variant not empty\n        if (featureFlag.variants !== undefined && featureFlag.variants.length > 0) {\n            if (!result.enabled) {\n                // not enabled, assign default if specified\n                if (featureFlag.allocation?.default_when_disabled !== undefined) {\n                    variantDef = featureFlag.variants.find(v => v.name == featureFlag.allocation?.default_when_disabled);\n                    reason = VariantAssignmentReason.DefaultWhenDisabled;\n                } else {\n                    // no default specified\n                    variantDef = undefined;\n                    reason = VariantAssignmentReason.DefaultWhenDisabled;\n                }\n            } else {\n                // enabled, assign based on allocation\n                if (context !== undefined && featureFlag.allocation !== undefined) {\n                    const variantAndReason = await this.#assignVariant(featureFlag, targetingContext);\n                    variantDef = variantAndReason.variant;\n                    reason = variantAndReason.reason;\n                }\n\n                // allocation failed, assign default if specified\n                if (variantDef === undefined && reason === VariantAssignmentReason.None) {\n                    if (featureFlag.allocation?.default_when_enabled !== undefined) {\n                        variantDef = featureFlag.variants.find(v => v.name == featureFlag.allocation?.default_when_enabled);\n                        reason = VariantAssignmentReason.DefaultWhenEnabled;\n                    } else {\n                        variantDef = undefined;\n                        reason = VariantAssignmentReason.DefaultWhenEnabled;\n                    }\n                }\n            }\n        }\n\n        result.variant = variantDef !== undefined ? new Variant(variantDef.name, variantDef.configuration_value) : undefined;\n        result.variantAssignmentReason = reason;\n\n        // Status override for isEnabled\n        if (variantDef !== undefined && featureFlag.enabled) {\n            if (variantDef.status_override === \"Enabled\") {\n                result.enabled = true;\n            } else if (variantDef.status_override === \"Disabled\") {\n                result.enabled = false;\n            }\n        }\n\n        // The callback will only be executed if telemetry is enabled for the feature flag\n        if (featureFlag.telemetry?.enabled && this.#onFeatureEvaluated !== undefined) {\n            this.#onFeatureEvaluated(result);\n        }\n\n        return result;\n    }\n}\n\nexport interface FeatureManagerOptions {\n    /**\n     * The custom filters to be used by the feature manager.\n     */\n    customFilters?: IFeatureFilter[];\n\n    /**\n     * The callback function that is called when a feature flag is evaluated.\n     * The callback function is called only when telemetry is enabled for the feature flag.\n     */\n    onFeatureEvaluated?: (event: EvaluationResult) => void;\n}\n\nexport class EvaluationResult {\n    constructor(\n        // feature flag definition\n        public readonly feature: FeatureFlag | undefined,\n\n        // enabled state\n        public enabled: boolean = false,\n\n        // variant assignment\n        public targetingId: string | undefined = undefined,\n        public variant: Variant | undefined = undefined,\n        public variantAssignmentReason: VariantAssignmentReason = VariantAssignmentReason.None\n    ) { }\n}\n\nexport enum VariantAssignmentReason {\n    /**\n     * Variant allocation did not happen. No variant is assigned.\n     */\n    None = \"None\",\n\n    /**\n     * The default variant is assigned when a feature flag is disabled.\n     */\n    DefaultWhenDisabled = \"DefaultWhenDisabled\",\n\n    /**\n     * The default variant is assigned because of no applicable user/group/percentile allocation when a feature flag is enabled.\n     */\n    DefaultWhenEnabled = \"DefaultWhenEnabled\",\n\n    /**\n     * The variant is assigned because of the user allocation when a feature flag is enabled.\n     */\n    User = \"User\",\n\n    /**\n     * The variant is assigned because of the group allocation when a feature flag is enabled.\n     */\n    Group = \"Group\",\n\n    /**\n     * The variant is assigned because of the percentile allocation when a feature flag is enabled.\n     */\n    Percentile = \"Percentile\"\n}\n\n/**\n * Validates the format of the feature flag definition.\n *\n * FeatureFlag data objects are from IFeatureFlagProvider, depending on the implementation.\n * Thus the properties are not guaranteed to have the expected types.\n *\n * @param featureFlag The feature flag definition to validate.\n */\nfunction validateFeatureFlagFormat(featureFlag: any): void {\n    if (featureFlag.enabled !== undefined && typeof featureFlag.enabled !== \"boolean\") {\n        throw new Error(`Feature flag ${featureFlag.id} has an invalid 'enabled' value.`);\n    }\n    // TODO: add more validations.\n    // TODO: should be moved to the feature flag provider.\n}\n\n/**\n * Try to get the variant assignment for the given variant name. If the variant is not found, override the reason with VariantAssignmentReason.None.\n *\n * @param featureFlag feature flag definition\n * @param variantName variant name\n * @param reason variant assignment reason\n * @returns variant assignment containing the variant definition and the reason\n */\nfunction getVariantAssignment(featureFlag: FeatureFlag, variantName: string, reason: VariantAssignmentReason): VariantAssignment {\n    const variant = featureFlag.variants?.find(v => v.name == variantName);\n    if (variant !== undefined) {\n        return { variant, reason };\n    } else {\n        console.warn(`Variant ${variantName} not found for feature ${featureFlag.id}.`);\n        return { variant: undefined, reason: VariantAssignmentReason.None };\n    }\n}\n\ntype VariantAssignment = {\n    variant: VariantDefinition | undefined;\n    reason: VariantAssignmentReason;\n};\n"],"names":["TimeWindowFilter","TargetingFilter","isTargetedUser","VariantAssignmentReason","isTargetedGroup","isTargetedPercentile","Variant"],"mappings":";;;;;;;AAAA;AACA;MAYa,cAAc,CAAA;AACvB,IAAA,SAAS,CAAuB;AAChC,IAAA,eAAe,GAAgC,IAAI,GAAG,EAAE,CAAC;AACzD,IAAA,mBAAmB,CAAqC;IAExD,WAAY,CAAA,QAA8B,EAAE,OAA+B,EAAA;AACvE,QAAA,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAE1B,MAAM,cAAc,GAAG,CAAC,IAAIA,iCAAgB,EAAE,EAAE,IAAIC,+BAAe,EAAE,CAAC,CAAC;;AAGvE,QAAA,KAAK,MAAM,MAAM,IAAI,CAAC,GAAG,cAAc,EAAE,IAAI,OAAO,EAAE,aAAa,IAAI,EAAE,CAAC,CAAC,EAAE;YACzE,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;SACjD;AAED,QAAA,IAAI,CAAC,mBAAmB,GAAG,OAAO,EAAE,kBAAkB,CAAC;KAC1D;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,MAAM,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QACjE,OAAO,MAAM,CAAC,OAAO,CAAC;KACzB;AAED,IAAA,MAAM,UAAU,CAAC,WAAmB,EAAE,OAA2B,EAAA;QAC7D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QACjE,OAAO,MAAM,CAAC,OAAO,CAAC;KACzB;AAED,IAAA,MAAM,cAAc,CAAC,WAAwB,EAAE,OAA0B,EAAA;;QAErE,IAAI,WAAW,CAAC,UAAU,EAAE,IAAI,KAAK,SAAS,EAAE;YAC5C,KAAK,MAAM,cAAc,IAAI,WAAW,CAAC,UAAU,CAAC,IAAI,EAAE;gBACtD,IAAIC,iCAAc,CAAC,OAAO,CAAC,MAAM,EAAE,cAAc,CAAC,KAAK,CAAC,EAAE;AACtD,oBAAA,OAAO,oBAAoB,CAAC,WAAW,EAAE,cAAc,CAAC,OAAO,EAAEC,+BAAuB,CAAC,IAAI,CAAC,CAAC;iBAClG;aACJ;SACJ;;QAGD,IAAI,WAAW,CAAC,UAAU,EAAE,KAAK,KAAK,SAAS,EAAE;YAC7C,KAAK,MAAM,eAAe,IAAI,WAAW,CAAC,UAAU,CAAC,KAAK,EAAE;gBACxD,IAAIC,kCAAe,CAAC,OAAO,CAAC,MAAM,EAAE,eAAe,CAAC,MAAM,CAAC,EAAE;AACzD,oBAAA,OAAO,oBAAoB,CAAC,WAAW,EAAE,eAAe,CAAC,OAAO,EAAED,+BAAuB,CAAC,KAAK,CAAC,CAAC;iBACpG;aACJ;SACJ;;QAGD,IAAI,WAAW,CAAC,UAAU,EAAE,UAAU,KAAK,SAAS,EAAE;YAClD,KAAK,MAAM,oBAAoB,IAAI,WAAW,CAAC,UAAU,CAAC,UAAU,EAAE;AAClE,gBAAA,MAAM,IAAI,GAAG,WAAW,CAAC,UAAU,CAAC,IAAI,IAAI,CAAe,YAAA,EAAA,WAAW,CAAC,EAAE,EAAE,CAAC;AAC5E,gBAAA,IAAI,MAAME,uCAAoB,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,EAAE,oBAAoB,CAAC,IAAI,EAAE,oBAAoB,CAAC,EAAE,CAAC,EAAE;AACtG,oBAAA,OAAO,oBAAoB,CAAC,WAAW,EAAE,oBAAoB,CAAC,OAAO,EAAEF,+BAAuB,CAAC,UAAU,CAAC,CAAC;iBAC9G;aACJ;SACJ;QAED,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAEA,+BAAuB,CAAC,IAAI,EAAE,CAAC;KACvE;AAED,IAAA,MAAM,UAAU,CAAC,WAAwB,EAAE,OAAiB,EAAA;AACxD,QAAA,IAAI,WAAW,CAAC,OAAO,KAAK,IAAI,EAAE;;AAE9B,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;QAED,MAAM,eAAe,GAAoB,WAAW,CAAC,UAAU,EAAE,gBAAgB,IAAI,KAAK,CAAC;AAE3F;;;;AAIG;AACH,QAAA,MAAM,4BAA4B,GAAY,eAAe,KAAK,KAAK,CAAC;AAExE,QAAA,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE;AACtC,YAAA,MAAM,oBAAoB,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;AACzE,YAAA,MAAM,sBAAsB,GAAG,EAAE,WAAW,EAAE,WAAW,CAAC,EAAE,EAAE,UAAU,EAAE,YAAY,CAAC,UAAU,EAAE,CAAC;AACpG,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;AAED,IAAA,MAAM,gBAAgB,CAAC,WAAmB,EAAE,OAAgB,EAAA;QACxD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;AACrE,QAAA,MAAM,MAAM,GAAG,IAAI,gBAAgB,CAAC,WAAW,CAAC,CAAC;AAEjD,QAAA,IAAI,WAAW,KAAK,SAAS,EAAE;AAC3B,YAAA,OAAO,MAAM,CAAC;SACjB;;;QAID,yBAAyB,CAAC,WAAW,CAAC,CAAC;;AAGvC,QAAA,MAAM,CAAC,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QAE7D,MAAM,gBAAgB,GAAG,OAA4B,CAAC;AACtD,QAAA,MAAM,CAAC,WAAW,GAAG,gBAAgB,EAAE,MAAM,CAAC;;AAG9C,QAAA,IAAI,UAAyC,CAAC;AAC9C,QAAA,IAAI,MAAM,GAA4BA,+BAAuB,CAAC,IAAI,CAAC;;AAGnE,QAAA,IAAI,WAAW,CAAC,QAAQ,KAAK,SAAS,IAAI,WAAW,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;AACvE,YAAA,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE;;gBAEjB,IAAI,WAAW,CAAC,UAAU,EAAE,qBAAqB,KAAK,SAAS,EAAE;oBAC7D,UAAU,GAAG,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,WAAW,CAAC,UAAU,EAAE,qBAAqB,CAAC,CAAC;AACrG,oBAAA,MAAM,GAAGA,+BAAuB,CAAC,mBAAmB,CAAC;iBACxD;qBAAM;;oBAEH,UAAU,GAAG,SAAS,CAAC;AACvB,oBAAA,MAAM,GAAGA,+BAAuB,CAAC,mBAAmB,CAAC;iBACxD;aACJ;iBAAM;;gBAEH,IAAI,OAAO,KAAK,SAAS,IAAI,WAAW,CAAC,UAAU,KAAK,SAAS,EAAE;oBAC/D,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,WAAW,EAAE,gBAAgB,CAAC,CAAC;AAClF,oBAAA,UAAU,GAAG,gBAAgB,CAAC,OAAO,CAAC;AACtC,oBAAA,MAAM,GAAG,gBAAgB,CAAC,MAAM,CAAC;iBACpC;;gBAGD,IAAI,UAAU,KAAK,SAAS,IAAI,MAAM,KAAKA,+BAAuB,CAAC,IAAI,EAAE;oBACrE,IAAI,WAAW,CAAC,UAAU,EAAE,oBAAoB,KAAK,SAAS,EAAE;wBAC5D,UAAU,GAAG,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,WAAW,CAAC,UAAU,EAAE,oBAAoB,CAAC,CAAC;AACpG,wBAAA,MAAM,GAAGA,+BAAuB,CAAC,kBAAkB,CAAC;qBACvD;yBAAM;wBACH,UAAU,GAAG,SAAS,CAAC;AACvB,wBAAA,MAAM,GAAGA,+BAAuB,CAAC,kBAAkB,CAAC;qBACvD;iBACJ;aACJ;SACJ;QAED,MAAM,CAAC,OAAO,GAAG,UAAU,KAAK,SAAS,GAAG,IAAIG,eAAO,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,mBAAmB,CAAC,GAAG,SAAS,CAAC;AACrH,QAAA,MAAM,CAAC,uBAAuB,GAAG,MAAM,CAAC;;QAGxC,IAAI,UAAU,KAAK,SAAS,IAAI,WAAW,CAAC,OAAO,EAAE;AACjD,YAAA,IAAI,UAAU,CAAC,eAAe,KAAK,SAAS,EAAE;AAC1C,gBAAA,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC;aACzB;AAAM,iBAAA,IAAI,UAAU,CAAC,eAAe,KAAK,UAAU,EAAE;AAClD,gBAAA,MAAM,CAAC,OAAO,GAAG,KAAK,CAAC;aAC1B;SACJ;;AAGD,QAAA,IAAI,WAAW,CAAC,SAAS,EAAE,OAAO,IAAI,IAAI,CAAC,mBAAmB,KAAK,SAAS,EAAE;AAC1E,YAAA,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;SACpC;AAED,QAAA,OAAO,MAAM,CAAC;KACjB;AACJ,CAAA;MAeY,gBAAgB,CAAA;AAGL,IAAA,OAAA,CAAA;AAGT,IAAA,OAAA,CAAA;AAGA,IAAA,WAAA,CAAA;AACA,IAAA,OAAA,CAAA;AACA,IAAA,uBAAA,CAAA;AAVX,IAAA,WAAA;;IAEoB,OAAgC;;AAGzC,IAAA,OAAA,GAAmB,KAAK;;IAGxB,WAAkC,GAAA,SAAS,EAC3C,OAA+B,GAAA,SAAS,EACxC,uBAAmD,GAAAH,+BAAuB,CAAC,IAAI,EAAA;QARtE,IAAO,CAAA,OAAA,GAAP,OAAO,CAAyB;QAGzC,IAAO,CAAA,OAAA,GAAP,OAAO,CAAiB;QAGxB,IAAW,CAAA,WAAA,GAAX,WAAW,CAAgC;QAC3C,IAAO,CAAA,OAAA,GAAP,OAAO,CAAiC;QACxC,IAAuB,CAAA,uBAAA,GAAvB,uBAAuB,CAAwD;KACrF;AACR,CAAA;AAEWA,yCA8BX;AA9BD,CAAA,UAAY,uBAAuB,EAAA;AAC/B;;AAEG;AACH,IAAA,uBAAA,CAAA,MAAA,CAAA,GAAA,MAAa,CAAA;AAEb;;AAEG;AACH,IAAA,uBAAA,CAAA,qBAAA,CAAA,GAAA,qBAA2C,CAAA;AAE3C;;AAEG;AACH,IAAA,uBAAA,CAAA,oBAAA,CAAA,GAAA,oBAAyC,CAAA;AAEzC;;AAEG;AACH,IAAA,uBAAA,CAAA,MAAA,CAAA,GAAA,MAAa,CAAA;AAEb;;AAEG;AACH,IAAA,uBAAA,CAAA,OAAA,CAAA,GAAA,OAAe,CAAA;AAEf;;AAEG;AACH,IAAA,uBAAA,CAAA,YAAA,CAAA,GAAA,YAAyB,CAAA;AAC7B,CAAC,EA9BWA,+BAAuB,KAAvBA,+BAAuB,GA8BlC,EAAA,CAAA,CAAA,CAAA;AAED;;;;;;;AAOG;AACH,SAAS,yBAAyB,CAAC,WAAgB,EAAA;AAC/C,IAAA,IAAI,WAAW,CAAC,OAAO,KAAK,SAAS,IAAI,OAAO,WAAW,CAAC,OAAO,KAAK,SAAS,EAAE;QAC/E,MAAM,IAAI,KAAK,CAAC,CAAA,aAAA,EAAgB,WAAW,CAAC,EAAE,CAAkC,gCAAA,CAAA,CAAC,CAAC;KACrF;;;AAGL,CAAC;AAED;;;;;;;AAOG;AACH,SAAS,oBAAoB,CAAC,WAAwB,EAAE,WAAmB,EAAE,MAA+B,EAAA;AACxG,IAAA,MAAM,OAAO,GAAG,WAAW,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,WAAW,CAAC,CAAC;AACvE,IAAA,IAAI,OAAO,KAAK,SAAS,EAAE;AACvB,QAAA,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;KAC9B;SAAM;QACH,OAAO,CAAC,IAAI,CAAC,CAAW,QAAA,EAAA,WAAW,CAA0B,uBAAA,EAAA,WAAW,CAAC,EAAE,CAAG,CAAA,CAAA,CAAC,CAAC;QAChF,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAEA,+BAAuB,CAAC,IAAI,EAAE,CAAC;KACvE;AACL;;;;;"}

package/dist/commonjs/featureProvider.js

@@ -0,0 +1,43 @@
+'use strict';
+
+var model = require('./model.js');
+
+// 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(model.FEATURE_MANAGEMENT_KEY);
+        return featureConfig?.[model.FEATURE_FLAGS_KEY]?.find((feature) => feature.id === featureName);
+    }
+    async getFeatureFlags() {
+        const featureConfig = this.#configuration.get(model.FEATURE_MANAGEMENT_KEY);
+        return featureConfig?.[model.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[model.FEATURE_MANAGEMENT_KEY]?.[model.FEATURE_FLAGS_KEY];
+        return featureFlags?.find((feature) => feature.id === featureName);
+    }
+    async getFeatureFlags() {
+        return this.#configuration[model.FEATURE_MANAGEMENT_KEY]?.[model.FEATURE_FLAGS_KEY] ?? [];
+    }
+}
+
+exports.ConfigurationMapFeatureFlagProvider = ConfigurationMapFeatureFlagProvider;
+exports.ConfigurationObjectFeatureFlagProvider = ConfigurationObjectFeatureFlagProvider;
+//# sourceMappingURL=featureProvider.js.map

package/dist/commonjs/featureProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"featureProvider.js","sources":["../../src/featureProvider.ts"],"sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { IGettable } from \"./gettable.js\";\nimport { FeatureFlag, FeatureManagementConfiguration, FEATURE_MANAGEMENT_KEY, FEATURE_FLAGS_KEY } from \"./model.js\";\n\nexport interface IFeatureFlagProvider {\n    /**\n     * Get all feature flags.\n     */\n    getFeatureFlags(): Promise<FeatureFlag[]>;\n\n    /**\n     * Get a feature flag by name.\n     * @param featureName The name of the feature flag.\n     */\n    getFeatureFlag(featureName: string): Promise<FeatureFlag | undefined>;\n}\n\n/**\n * A feature flag provider that uses a map-like configuration to provide feature flags.\n */\nexport class ConfigurationMapFeatureFlagProvider implements IFeatureFlagProvider {\n    #configuration: IGettable;\n\n    constructor(configuration: IGettable) {\n        this.#configuration = configuration;\n    }\n    async getFeatureFlag(featureName: string): Promise<FeatureFlag | undefined> {\n        const featureConfig = this.#configuration.get<FeatureManagementConfiguration>(FEATURE_MANAGEMENT_KEY);\n        return featureConfig?.[FEATURE_FLAGS_KEY]?.find((feature) => feature.id === featureName);\n    }\n\n    async getFeatureFlags(): Promise<FeatureFlag[]> {\n        const featureConfig = this.#configuration.get<FeatureManagementConfiguration>(FEATURE_MANAGEMENT_KEY);\n        return featureConfig?.[FEATURE_FLAGS_KEY] ?? [];\n    }\n}\n\n/**\n * A feature flag provider that uses an object-like configuration to provide feature flags.\n */\nexport class ConfigurationObjectFeatureFlagProvider implements IFeatureFlagProvider {\n    #configuration: Record<string, unknown>;\n\n    constructor(configuration: Record<string, unknown>) {\n        this.#configuration = configuration;\n    }\n\n    async getFeatureFlag(featureName: string): Promise<FeatureFlag | undefined> {\n        const featureFlags = this.#configuration[FEATURE_MANAGEMENT_KEY]?.[FEATURE_FLAGS_KEY];\n        return featureFlags?.find((feature: FeatureFlag) => feature.id === featureName);\n    }\n\n    async getFeatureFlags(): Promise<FeatureFlag[]> {\n        return this.#configuration[FEATURE_MANAGEMENT_KEY]?.[FEATURE_FLAGS_KEY] ?? [];\n    }\n}\n"],"names":["FEATURE_MANAGEMENT_KEY","FEATURE_FLAGS_KEY"],"mappings":";;;;AAAA;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,CAAiCA,4BAAsB,CAAC,CAAC;AACtG,QAAA,OAAO,aAAa,GAAGC,uBAAiB,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,CAAiCD,4BAAsB,CAAC,CAAC;AACtG,QAAA,OAAO,aAAa,GAAGC,uBAAiB,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,CAACD,4BAAsB,CAAC,GAAGC,uBAAiB,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,CAACD,4BAAsB,CAAC,GAAGC,uBAAiB,CAAC,IAAI,EAAE,CAAC;KACjF;AACJ;;;;;"}

package/{dist-esm → dist/commonjs}/filter/TargetingFilter.js

@@ -1,9 +1,12 @@
+'use strict';
+
+var targetingEvaluator = require('../common/targetingEvaluator.js');
+
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
-import { createHash } from "crypto";
-export class TargetingFilter {
+class TargetingFilter {
     name = "Microsoft.Targeting";
-    evaluate(context, appContext) {
+    async evaluate(context, appContext) {
         const { featureName, parameters } = context;
         TargetingFilter.#validateParameters(parameters);
         if (appContext === undefined) {
@@ -37,26 +40,16 @@ export class TargetingFilter {
             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)) {
+                    const hint = `${featureName}\n${group.Name}`;
+                    if (await targetingEvaluator.isTargetedPercentile(appContext.userId, hint, 0, group.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;
+        const hint = featureName;
+        return targetingEvaluator.isTargetedPercentile(appContext?.userId, hint, 0, parameters.Audience.DefaultRolloutPercentage);
     }
     static #validateParameters(parameters) {
         if (parameters.Audience.DefaultRolloutPercentage < 0 || parameters.Audience.DefaultRolloutPercentage > 100) {
@@ -72,33 +65,6 @@ export class TargetingFilter {
         }
     }
 }
-/**
- * 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 = 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;
-}
-//# sourceMappingURL=TargetingFilter.js.map
+
+exports.TargetingFilter = TargetingFilter;
+//# sourceMappingURL=TargetingFilter.js.map

package/dist/commonjs/filter/TargetingFilter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TargetingFilter.js","sources":["../../../src/filter/TargetingFilter.ts"],"sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { IFeatureFilter } from \"./FeatureFilter.js\";\nimport { isTargetedPercentile } from \"../common/targetingEvaluator.js\";\nimport { ITargetingContext } from \"../common/ITargetingContext.js\";\n\ntype TargetingFilterParameters = {\n    Audience: {\n        DefaultRolloutPercentage: number;\n        Users?: string[];\n        Groups?: {\n            Name: string;\n            RolloutPercentage: number;\n        }[];\n        Exclusion?: {\n            Users?: string[];\n            Groups?: string[];\n        };\n    }\n}\n\ntype TargetingFilterEvaluationContext = {\n    featureName: string;\n    parameters: TargetingFilterParameters;\n}\n\nexport class TargetingFilter implements IFeatureFilter {\n    name: string = \"Microsoft.Targeting\";\n\n    async evaluate(context: TargetingFilterEvaluationContext, appContext?: ITargetingContext): Promise<boolean> {\n        const { featureName, parameters } = context;\n        TargetingFilter.#validateParameters(parameters);\n\n        if (appContext === undefined) {\n            throw new Error(\"The app context is required for targeting filter.\");\n        }\n\n        if (parameters.Audience.Exclusion !== undefined) {\n            // check if the user is in the exclusion list\n            if (appContext?.userId !== undefined &&\n                parameters.Audience.Exclusion.Users !== undefined &&\n                parameters.Audience.Exclusion.Users.includes(appContext.userId)) {\n                return false;\n            }\n            // check if the user is in a group within exclusion list\n            if (appContext?.groups !== undefined &&\n                parameters.Audience.Exclusion.Groups !== undefined) {\n                for (const excludedGroup of parameters.Audience.Exclusion.Groups) {\n                    if (appContext.groups.includes(excludedGroup)) {\n                        return false;\n                    }\n                }\n            }\n        }\n\n        // check if the user is being targeted directly\n        if (appContext?.userId !== undefined &&\n            parameters.Audience.Users !== undefined &&\n            parameters.Audience.Users.includes(appContext.userId)) {\n            return true;\n        }\n\n        // check if the user is in a group that is being targeted\n        if (appContext?.groups !== undefined &&\n            parameters.Audience.Groups !== undefined) {\n            for (const group of parameters.Audience.Groups) {\n                if (appContext.groups.includes(group.Name)) {\n                    const hint = `${featureName}\\n${group.Name}`;\n                    if (await isTargetedPercentile(appContext.userId, hint, 0, group.RolloutPercentage)) {\n                        return true;\n                    }\n                }\n            }\n        }\n\n        // check if the user is being targeted by a default rollout percentage\n        const hint = featureName;\n        return isTargetedPercentile(appContext?.userId, hint, 0, parameters.Audience.DefaultRolloutPercentage);\n    }\n\n    static #validateParameters(parameters: TargetingFilterParameters): void {\n        if (parameters.Audience.DefaultRolloutPercentage < 0 || parameters.Audience.DefaultRolloutPercentage > 100) {\n            throw new Error(\"Audience.DefaultRolloutPercentage must be a number between 0 and 100.\");\n        }\n        // validate RolloutPercentage for each group\n        if (parameters.Audience.Groups !== undefined) {\n            for (const group of parameters.Audience.Groups) {\n                if (group.RolloutPercentage < 0 || group.RolloutPercentage > 100) {\n                    throw new Error(`RolloutPercentage of group ${group.Name} must be a number between 0 and 100.`);\n                }\n            }\n        }\n    }\n}\n"],"names":["isTargetedPercentile"],"mappings":";;;;AAAA;AACA;MA0Ba,eAAe,CAAA;IACxB,IAAI,GAAW,qBAAqB,CAAC;AAErC,IAAA,MAAM,QAAQ,CAAC,OAAyC,EAAE,UAA8B,EAAA;AACpF,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;oBACxC,MAAM,IAAI,GAAG,CAAG,EAAA,WAAW,KAAK,KAAK,CAAC,IAAI,CAAA,CAAE,CAAC;AAC7C,oBAAA,IAAI,MAAMA,uCAAoB,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,EAAE;AACjF,wBAAA,OAAO,IAAI,CAAC;qBACf;iBACJ;aACJ;SACJ;;QAGD,MAAM,IAAI,GAAG,WAAW,CAAC;AACzB,QAAA,OAAOA,uCAAoB,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC,wBAAwB,CAAC,CAAC;KAC1G;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;;;;"}

package/dist/commonjs/filter/TimeWindowFilter.js

@@ -0,0 +1,22 @@
+'use strict';
+
+// 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);
+    }
+}
+
+exports.TimeWindowFilter = TimeWindowFilter;
+//# sourceMappingURL=TimeWindowFilter.js.map

package/dist/commonjs/filter/TimeWindowFilter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TimeWindowFilter.js","sources":["../../../src/filter/TimeWindowFilter.ts"],"sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { IFeatureFilter } from \"./FeatureFilter.js\";\n\n// [Start, End)\ntype TimeWindowParameters = {\n    Start?: string;\n    End?: string;\n}\n\ntype TimeWindowFilterEvaluationContext = {\n    featureName: string;\n    parameters: TimeWindowParameters;\n}\n\nexport class TimeWindowFilter implements IFeatureFilter {\n    name: string = \"Microsoft.TimeWindow\";\n\n    evaluate(context: TimeWindowFilterEvaluationContext): boolean {\n        const {featureName, parameters} = context;\n        const startTime = parameters.Start !== undefined ? new Date(parameters.Start) : undefined;\n        const endTime = parameters.End !== undefined ? new Date(parameters.End) : undefined;\n\n        if (startTime === undefined && endTime === undefined) {\n            // If neither start nor end time is specified, then the filter is not applicable.\n            console.warn(`The ${this.name} feature filter is not valid for feature ${featureName}. It must specify either 'Start', 'End', or both.`);\n            return false;\n        }\n        const now = new Date();\n        return (startTime === undefined || startTime <= now) && (endTime === undefined || now < endTime);\n    }\n}\n"],"names":[],"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;;;;"}

package/dist/commonjs/index.js

@@ -0,0 +1,18 @@
+'use strict';
+
+var featureManager = require('./featureManager.js');
+var featureProvider = require('./featureProvider.js');
+var version = require('./version.js');
+
+
+
+exports.EvaluationResult = featureManager.EvaluationResult;
+exports.FeatureManager = featureManager.FeatureManager;
+Object.defineProperty(exports, "VariantAssignmentReason", {
+	enumerable: true,
+	get: function () { return featureManager.VariantAssignmentReason; }
+});
+exports.ConfigurationMapFeatureFlagProvider = featureProvider.ConfigurationMapFeatureFlagProvider;
+exports.ConfigurationObjectFeatureFlagProvider = featureProvider.ConfigurationObjectFeatureFlagProvider;
+exports.VERSION = version.VERSION;
+//# sourceMappingURL=index.js.map

package/dist/commonjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;"}