@microsoft/feature-management 2.0.0-preview.2 → 2.0.0-preview.3

package/dist/esm/featureProvider.js

@@ -1,4 +1,5 @@
-import { FEATURE_MANAGEMENT_KEY, FEATURE_FLAGS_KEY } from './model.js';
+import { FEATURE_MANAGEMENT_KEY, FEATURE_FLAGS_KEY } from './schema/model.js';
+import { validateFeatureFlag } from './schema/validator.js';
 
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
@@ -12,11 +13,15 @@ class ConfigurationMapFeatureFlagProvider {
     }
     async getFeatureFlag(featureName) {
         const featureConfig = this.#configuration.get(FEATURE_MANAGEMENT_KEY);
-        return featureConfig?.[FEATURE_FLAGS_KEY]?.find((feature) => feature.id === featureName);
+        const featureFlag = featureConfig?.[FEATURE_FLAGS_KEY]?.findLast((feature) => feature.id === featureName);
+        validateFeatureFlag(featureFlag);
+        return featureFlag;
     }
     async getFeatureFlags() {
         const featureConfig = this.#configuration.get(FEATURE_MANAGEMENT_KEY);
-        return featureConfig?.[FEATURE_FLAGS_KEY] ?? [];
+        const featureFlag = featureConfig?.[FEATURE_FLAGS_KEY] ?? [];
+        validateFeatureFlag(featureFlag);
+        return featureFlag;
     }
 }
 /**
@@ -29,10 +34,14 @@ class ConfigurationObjectFeatureFlagProvider {
     }
     async getFeatureFlag(featureName) {
         const featureFlags = this.#configuration[FEATURE_MANAGEMENT_KEY]?.[FEATURE_FLAGS_KEY];
-        return featureFlags?.find((feature) => feature.id === featureName);
+        const featureFlag = featureFlags?.findLast((feature) => feature.id === featureName);
+        validateFeatureFlag(featureFlag);
+        return featureFlag;
     }
     async getFeatureFlags() {
-        return this.#configuration[FEATURE_MANAGEMENT_KEY]?.[FEATURE_FLAGS_KEY] ?? [];
+        const featureFlag = this.#configuration[FEATURE_MANAGEMENT_KEY]?.[FEATURE_FLAGS_KEY] ?? [];
+        validateFeatureFlag(featureFlag);
+        return featureFlag;
     }
 }
 

package/dist/esm/featureProvider.js.map

@@ -1 +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":[],"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,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;;;;"}
+{"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 \"./schema/model.js\";\nimport { validateFeatureFlag } from \"./schema/validator.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        const featureFlag = featureConfig?.[FEATURE_FLAGS_KEY]?.findLast((feature) => feature.id === featureName);\n        validateFeatureFlag(featureFlag);\n        return featureFlag;\n    }\n\n    async getFeatureFlags(): Promise<FeatureFlag[]> {\n        const featureConfig = this.#configuration.get<FeatureManagementConfiguration>(FEATURE_MANAGEMENT_KEY);\n        const featureFlag = featureConfig?.[FEATURE_FLAGS_KEY] ?? [];\n        validateFeatureFlag(featureFlag);\n        return featureFlag;\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        const featureFlag = featureFlags?.findLast((feature: FeatureFlag) => feature.id === featureName);\n        validateFeatureFlag(featureFlag);\n        return featureFlag;\n    }\n\n    async getFeatureFlags(): Promise<FeatureFlag[]> {\n        const featureFlag = this.#configuration[FEATURE_MANAGEMENT_KEY]?.[FEATURE_FLAGS_KEY] ?? [];\n        validateFeatureFlag(featureFlag);\n        return featureFlag;\n    }\n}\n"],"names":[],"mappings":";;;AAAA;AACA;AAmBA;;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;QACtG,MAAM,WAAW,GAAG,aAAa,GAAG,iBAAiB,CAAC,EAAE,QAAQ,CAAC,CAAC,OAAO,KAAK,OAAO,CAAC,EAAE,KAAK,WAAW,CAAC,CAAC;QAC1G,mBAAmB,CAAC,WAAW,CAAC,CAAC;AACjC,QAAA,OAAO,WAAW,CAAC;KACtB;AAED,IAAA,MAAM,eAAe,GAAA;QACjB,MAAM,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAiC,sBAAsB,CAAC,CAAC;QACtG,MAAM,WAAW,GAAG,aAAa,GAAG,iBAAiB,CAAC,IAAI,EAAE,CAAC;QAC7D,mBAAmB,CAAC,WAAW,CAAC,CAAC;AACjC,QAAA,OAAO,WAAW,CAAC;KACtB;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,MAAM,WAAW,GAAG,YAAY,EAAE,QAAQ,CAAC,CAAC,OAAoB,KAAK,OAAO,CAAC,EAAE,KAAK,WAAW,CAAC,CAAC;QACjG,mBAAmB,CAAC,WAAW,CAAC,CAAC;AACjC,QAAA,OAAO,WAAW,CAAC;KACtB;AAED,IAAA,MAAM,eAAe,GAAA;AACjB,QAAA,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,sBAAsB,CAAC,GAAG,iBAAiB,CAAC,IAAI,EAAE,CAAC;QAC3F,mBAAmB,CAAC,WAAW,CAAC,CAAC;AACjC,QAAA,OAAO,WAAW,CAAC;KACtB;AACJ;;;;"}

package/dist/esm/index.js

@@ -1,4 +1,5 @@
 export { EvaluationResult, FeatureManager, VariantAssignmentReason } from './featureManager.js';
 export { ConfigurationMapFeatureFlagProvider, ConfigurationObjectFeatureFlagProvider } from './featureProvider.js';
+export { createFeatureEvaluationEventProperties } from './telemetry/featureEvaluationEvent.js';
 export { VERSION } from './version.js';
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

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

package/dist/esm/schema/model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"model.js","sources":["../../../src/schema/model.ts"],"sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\n// Converted from:\n// https://github.com/Azure/AppConfiguration/blob/6e544296a5607f922a423df165f60801717c7800/docs/FeatureManagement/FeatureFlag.v2.0.0.schema.json\n\n/**\n * A feature flag is a named property that can be toggled to enable or disable some feature of an application.\n */\nexport interface FeatureFlag {\n    /**\n     * An ID used to uniquely identify and reference the feature.\n     */\n    id: string;\n    /**\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.\n     */\n    enabled?: boolean;\n    /**\n     * The declaration of conditions used to dynamically enable the feature.\n     */\n    conditions?: FeatureEnablementConditions;\n    /**\n     * 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.\n     */\n    variants?: VariantDefinition[];\n    /**\n     * Determines how variants should be allocated for the feature to various users.\n     */\n    allocation?: VariantAllocation;\n    /**\n     * The declaration of options used to configure telemetry for this feature.\n     */\n    telemetry?: TelemetryOptions\n  }\n\n  /**\n  * The declaration of conditions used to dynamically enable the feature\n  */\n  interface FeatureEnablementConditions {\n    /**\n     * Determines whether any or all registered client filters must be evaluated as true for the feature to be considered enabled.\n     */\n    requirement_type?: RequirementType;\n    /**\n     * Filters that must run on the client and be evaluated as true for the feature to be considered enabled.\n     */\n    client_filters?: ClientFilter[];\n  }\n\n  export type RequirementType = \"Any\" | \"All\";\n\n  interface ClientFilter {\n    /**\n     * The name used to refer to a client filter.\n     */\n    name: string;\n    /**\n     * Parameters for a given client filter. A client filter can require any set of parameters of any type.\n     */\n    parameters?: Record<string, unknown>;\n  }\n\n  export interface VariantDefinition {\n    /**\n     * The name used to refer to a feature variant.\n     */\n    name: string;\n    /**\n     * The configuration value for this feature variant.\n     */\n    configuration_value?: unknown;\n    /**\n     * Overrides the enabled state of the feature if the given variant is assigned. Does not override the state if value is None.\n     */\n    status_override?: \"None\" | \"Enabled\" | \"Disabled\";\n  }\n\n  /**\n  * Determines how variants should be allocated for the feature to various users.\n  */\n  interface VariantAllocation {\n    /**\n     * Specifies which variant should be used when the feature is considered disabled.\n     */\n    default_when_disabled?: string;\n    /**\n     * Specifies which variant should be used when the feature is considered enabled and no other allocation rules are applicable.\n     */\n    default_when_enabled?: string;\n    /**\n     * A list of objects, each containing a variant name and list of users for whom that variant should be used.\n     */\n    user?: UserAllocation[];\n    /**\n     * A list of objects, each containing a variant name and list of groups for which that variant should be used.\n     */\n    group?: GroupAllocation[];\n    /**\n     * A list of objects, each containing a variant name and percentage range for which that variant should be used.\n     */\n    percentile?: PercentileAllocation[]\n    /**\n     * 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.\n     */\n    seed?: string;\n  }\n\n  interface UserAllocation {\n    /**\n     * The name of the variant to use if the user allocation matches the current user.\n     */\n    variant: string;\n    /**\n     * Collection of users where if any match the current user, the variant specified in the user allocation is used.\n     */\n    users: string[];\n  }\n\n  interface GroupAllocation {\n    /**\n     * The name of the variant to use if the group allocation matches a group the current user is in.\n     */\n    variant: string;\n    /**\n     * Collection of groups where if the current user is in any of these groups, the variant specified in the group allocation is used.\n     */\n    groups: string[];\n  }\n\n  interface PercentileAllocation {\n    /**\n     * The name of the variant to use if the calculated percentile for the current user falls in the provided range.\n     */\n    variant: string;\n    /**\n     * The lower end of the percentage range for which this variant will be used.\n     */\n    from: number;\n    /**\n     * The upper end of the percentage range for which this variant will be used.\n     */\n    to: number;\n  }\n\n  /**\n  * The declaration of options used to configure telemetry for this feature.\n  */\n  interface TelemetryOptions {\n    /**\n     * Indicates if telemetry is enabled.\n     */\n    enabled?: boolean;\n    /**\n     * A container for metadata that should be bundled with flag telemetry.\n     */\n    metadata?: Record<string, string>;\n  }\n\n  // Feature Management Section fed into feature manager.\n  // Converted from https://github.com/Azure/AppConfiguration/blob/main/docs/FeatureManagement/FeatureManagement.v1.0.0.schema.json\n\n  export const FEATURE_MANAGEMENT_KEY = \"feature_management\";\n  export const FEATURE_FLAGS_KEY = \"feature_flags\";\n\n  export interface FeatureManagementConfiguration {\n    feature_management: FeatureManagement\n  }\n\n  /**\n   * Declares feature management configuration.\n   */\n  export interface FeatureManagement {\n    feature_flags: FeatureFlag[];\n  }\n"],"names":[],"mappings":"AAAA;AACA;AA8JE;AACA;AAEO,MAAM,sBAAsB,GAAG,qBAAqB;AACpD,MAAM,iBAAiB,GAAG;;;;"}

package/dist/esm/schema/validator.js

@@ -0,0 +1,174 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/**
+ * Validates a feature flag object, checking if it conforms to the schema.
+ * @param featureFlag The feature flag object to validate.
+ */
+function validateFeatureFlag(featureFlag) {
+    if (featureFlag === undefined) {
+        return; // no-op if feature flag is undefined, indicating that the feature flag is not found
+    }
+    if (featureFlag === null || typeof featureFlag !== "object") { // Note: typeof null = "object"
+        throw new TypeError("Feature flag must be an object.");
+    }
+    if (typeof featureFlag.id !== "string") {
+        throw new TypeError("Feature flag 'id' must be a string.");
+    }
+    if (featureFlag.enabled !== undefined && typeof featureFlag.enabled !== "boolean") {
+        throw new TypeError("Feature flag 'enabled' must be a boolean.");
+    }
+    if (featureFlag.conditions !== undefined) {
+        validateFeatureEnablementConditions(featureFlag.conditions);
+    }
+    if (featureFlag.variants !== undefined) {
+        validateVariants(featureFlag.variants);
+    }
+    if (featureFlag.allocation !== undefined) {
+        validateVariantAllocation(featureFlag.allocation);
+    }
+    if (featureFlag.telemetry !== undefined) {
+        validateTelemetryOptions(featureFlag.telemetry);
+    }
+}
+function validateFeatureEnablementConditions(conditions) {
+    if (typeof conditions !== "object") {
+        throw new TypeError("Feature flag 'conditions' must be an object.");
+    }
+    if (conditions.requirement_type !== undefined && conditions.requirement_type !== "Any" && conditions.requirement_type !== "All") {
+        throw new TypeError("'requirement_type' must be 'Any' or 'All'.");
+    }
+    if (conditions.client_filters !== undefined) {
+        validateClientFilters(conditions.client_filters);
+    }
+}
+function validateClientFilters(client_filters) {
+    if (!Array.isArray(client_filters)) {
+        throw new TypeError("Feature flag conditions 'client_filters' must be an array.");
+    }
+    for (const filter of client_filters) {
+        if (typeof filter.name !== "string") {
+            throw new TypeError("Client filter 'name' must be a string.");
+        }
+        if (filter.parameters !== undefined && typeof filter.parameters !== "object") {
+            throw new TypeError("Client filter 'parameters' must be an object.");
+        }
+    }
+}
+function validateVariants(variants) {
+    if (!Array.isArray(variants)) {
+        throw new TypeError("Feature flag 'variants' must be an array.");
+    }
+    for (const variant of variants) {
+        if (typeof variant.name !== "string") {
+            throw new TypeError("Variant 'name' must be a string.");
+        }
+        // skip configuration_value validation as it accepts any type
+        if (variant.status_override !== undefined && typeof variant.status_override !== "string") {
+            throw new TypeError("Variant 'status_override' must be a string.");
+        }
+        if (variant.status_override !== undefined && variant.status_override !== "None" && variant.status_override !== "Enabled" && variant.status_override !== "Disabled") {
+            throw new TypeError("Variant 'status_override' must be 'None', 'Enabled', or 'Disabled'.");
+        }
+    }
+}
+function validateVariantAllocation(allocation) {
+    if (typeof allocation !== "object") {
+        throw new TypeError("Variant 'allocation' must be an object.");
+    }
+    if (allocation.default_when_disabled !== undefined && typeof allocation.default_when_disabled !== "string") {
+        throw new TypeError("Variant allocation 'default_when_disabled' must be a string.");
+    }
+    if (allocation.default_when_enabled !== undefined && typeof allocation.default_when_enabled !== "string") {
+        throw new TypeError("Variant allocation 'default_when_enabled' must be a string.");
+    }
+    if (allocation.user !== undefined) {
+        validateUserVariantAllocation(allocation.user);
+    }
+    if (allocation.group !== undefined) {
+        validateGroupVariantAllocation(allocation.group);
+    }
+    if (allocation.percentile !== undefined) {
+        validatePercentileVariantAllocation(allocation.percentile);
+    }
+    if (allocation.seed !== undefined && typeof allocation.seed !== "string") {
+        throw new TypeError("Variant allocation 'seed' must be a string.");
+    }
+}
+function validateUserVariantAllocation(UserAllocations) {
+    if (!Array.isArray(UserAllocations)) {
+        throw new TypeError("Variant 'user' allocation must be an array.");
+    }
+    for (const allocation of UserAllocations) {
+        if (typeof allocation !== "object") {
+            throw new TypeError("Elements in variant 'user' allocation must be an object.");
+        }
+        if (typeof allocation.variant !== "string") {
+            throw new TypeError("User allocation 'variant' must be a string.");
+        }
+        if (!Array.isArray(allocation.users)) {
+            throw new TypeError("User allocation 'users' must be an array.");
+        }
+        for (const user of allocation.users) {
+            if (typeof user !== "string") {
+                throw new TypeError("Elements in user allocation 'users' must be strings.");
+            }
+        }
+    }
+}
+function validateGroupVariantAllocation(groupAllocations) {
+    if (!Array.isArray(groupAllocations)) {
+        throw new TypeError("Variant 'group' allocation must be an array.");
+    }
+    for (const allocation of groupAllocations) {
+        if (typeof allocation !== "object") {
+            throw new TypeError("Elements in variant 'group' allocation must be an object.");
+        }
+        if (typeof allocation.variant !== "string") {
+            throw new TypeError("Group allocation 'variant' must be a string.");
+        }
+        if (!Array.isArray(allocation.groups)) {
+            throw new TypeError("Group allocation 'groups' must be an array.");
+        }
+        for (const group of allocation.groups) {
+            if (typeof group !== "string") {
+                throw new TypeError("Elements in group allocation 'groups' must be strings.");
+            }
+        }
+    }
+}
+function validatePercentileVariantAllocation(percentileAllocations) {
+    if (!Array.isArray(percentileAllocations)) {
+        throw new TypeError("Variant 'percentile' allocation must be an array.");
+    }
+    for (const allocation of percentileAllocations) {
+        if (typeof allocation !== "object") {
+            throw new TypeError("Elements in variant 'percentile' allocation must be an object.");
+        }
+        if (typeof allocation.variant !== "string") {
+            throw new TypeError("Percentile allocation 'variant' must be a string.");
+        }
+        if (typeof allocation.from !== "number" || allocation.from < 0 || allocation.from > 100) {
+            throw new TypeError("Percentile allocation 'from' must be a number between 0 and 100.");
+        }
+        if (typeof allocation.to !== "number" || allocation.to < 0 || allocation.to > 100) {
+            throw new TypeError("Percentile allocation 'to' must be a number between 0 and 100.");
+        }
+    }
+}
+// #endregion
+// #region Telemetry
+function validateTelemetryOptions(telemetry) {
+    if (typeof telemetry !== "object") {
+        throw new TypeError("Feature flag 'telemetry' must be an object.");
+    }
+    if (telemetry.enabled !== undefined && typeof telemetry.enabled !== "boolean") {
+        throw new TypeError("Telemetry 'enabled' must be a boolean.");
+    }
+    if (telemetry.metadata !== undefined && typeof telemetry.metadata !== "object") {
+        throw new TypeError("Telemetry 'metadata' must be an object.");
+    }
+}
+// #endregion
+
+export { validateFeatureFlag };
+//# sourceMappingURL=validator.js.map

package/dist/esm/schema/validator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validator.js","sources":["../../../src/schema/validator.ts"],"sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\n/**\n * Validates a feature flag object, checking if it conforms to the schema.\n * @param featureFlag The feature flag object to validate.\n */\nexport function validateFeatureFlag(featureFlag: any): void {\n    if (featureFlag === undefined) {\n        return; // no-op if feature flag is undefined, indicating that the feature flag is not found\n    }\n    if (featureFlag === null || typeof featureFlag !== \"object\") { // Note: typeof null = \"object\"\n        throw new TypeError(\"Feature flag must be an object.\");\n    }\n    if (typeof featureFlag.id !== \"string\") {\n        throw new TypeError(\"Feature flag 'id' must be a string.\");\n    }\n    if (featureFlag.enabled !== undefined && typeof featureFlag.enabled !== \"boolean\") {\n        throw new TypeError(\"Feature flag 'enabled' must be a boolean.\");\n    }\n    if (featureFlag.conditions !== undefined) {\n        validateFeatureEnablementConditions(featureFlag.conditions);\n    }\n    if (featureFlag.variants !== undefined) {\n        validateVariants(featureFlag.variants);\n    }\n    if (featureFlag.allocation !== undefined) {\n        validateVariantAllocation(featureFlag.allocation);\n    }\n    if (featureFlag.telemetry !== undefined) {\n        validateTelemetryOptions(featureFlag.telemetry);\n    }\n}\n\nfunction validateFeatureEnablementConditions(conditions: any) {\n    if (typeof conditions !== \"object\") {\n        throw new TypeError(\"Feature flag 'conditions' must be an object.\");\n    }\n    if (conditions.requirement_type !== undefined && conditions.requirement_type !== \"Any\" && conditions.requirement_type !== \"All\") {\n        throw new TypeError(\"'requirement_type' must be 'Any' or 'All'.\");\n    }\n    if (conditions.client_filters !== undefined) {\n        validateClientFilters(conditions.client_filters);\n    }\n}\n\nfunction validateClientFilters(client_filters: any) {\n    if (!Array.isArray(client_filters)) {\n        throw new TypeError(\"Feature flag conditions 'client_filters' must be an array.\");\n    }\n\n    for (const filter of client_filters) {\n        if (typeof filter.name !== \"string\") {\n            throw new TypeError(\"Client filter 'name' must be a string.\");\n        }\n        if (filter.parameters !== undefined && typeof filter.parameters !== \"object\") {\n            throw new TypeError(\"Client filter 'parameters' must be an object.\");\n        }\n    }\n}\n\nfunction validateVariants(variants: any) {\n    if (!Array.isArray(variants)) {\n        throw new TypeError(\"Feature flag 'variants' must be an array.\");\n    }\n\n    for (const variant of variants) {\n        if (typeof variant.name !== \"string\") {\n            throw new TypeError(\"Variant 'name' must be a string.\");\n        }\n        // skip configuration_value validation as it accepts any type\n        if (variant.status_override !== undefined && typeof variant.status_override !== \"string\") {\n            throw new TypeError(\"Variant 'status_override' must be a string.\");\n        }\n        if (variant.status_override !== undefined && variant.status_override !== \"None\" && variant.status_override !== \"Enabled\" && variant.status_override !== \"Disabled\") {\n            throw new TypeError(\"Variant 'status_override' must be 'None', 'Enabled', or 'Disabled'.\");\n        }\n    }\n}\n\nfunction validateVariantAllocation(allocation: any) {\n    if (typeof allocation !== \"object\") {\n        throw new TypeError(\"Variant 'allocation' must be an object.\");\n    }\n\n    if (allocation.default_when_disabled !== undefined && typeof allocation.default_when_disabled !== \"string\") {\n        throw new TypeError(\"Variant allocation 'default_when_disabled' must be a string.\");\n    }\n    if (allocation.default_when_enabled !== undefined && typeof allocation.default_when_enabled !== \"string\") {\n        throw new TypeError(\"Variant allocation 'default_when_enabled' must be a string.\");\n    }\n    if (allocation.user !== undefined) {\n        validateUserVariantAllocation(allocation.user);\n    }\n    if (allocation.group !== undefined) {\n        validateGroupVariantAllocation(allocation.group);\n    }\n    if (allocation.percentile !== undefined) {\n        validatePercentileVariantAllocation(allocation.percentile);\n    }\n    if (allocation.seed !== undefined && typeof allocation.seed !== \"string\") {\n        throw new TypeError(\"Variant allocation 'seed' must be a string.\");\n    }\n}\n\nfunction validateUserVariantAllocation(UserAllocations: any) {\n    if (!Array.isArray(UserAllocations)) {\n        throw new TypeError(\"Variant 'user' allocation must be an array.\");\n    }\n\n    for (const allocation of UserAllocations) {\n        if (typeof allocation !== \"object\") {\n            throw new TypeError(\"Elements in variant 'user' allocation must be an object.\");\n        }\n        if (typeof allocation.variant !== \"string\") {\n            throw new TypeError(\"User allocation 'variant' must be a string.\");\n        }\n        if (!Array.isArray(allocation.users)) {\n            throw new TypeError(\"User allocation 'users' must be an array.\");\n        }\n        for (const user of allocation.users) {\n            if (typeof user !== \"string\") {\n                throw new TypeError(\"Elements in user allocation 'users' must be strings.\");\n            }\n        }\n    }\n}\n\nfunction validateGroupVariantAllocation(groupAllocations: any) {\n    if (!Array.isArray(groupAllocations)) {\n        throw new TypeError(\"Variant 'group' allocation must be an array.\");\n    }\n\n    for (const allocation of groupAllocations) {\n        if (typeof allocation !== \"object\") {\n            throw new TypeError(\"Elements in variant 'group' allocation must be an object.\");\n        }\n        if (typeof allocation.variant !== \"string\") {\n            throw new TypeError(\"Group allocation 'variant' must be a string.\");\n        }\n        if (!Array.isArray(allocation.groups)) {\n            throw new TypeError(\"Group allocation 'groups' must be an array.\");\n        }\n        for (const group of allocation.groups) {\n            if (typeof group !== \"string\") {\n                throw new TypeError(\"Elements in group allocation 'groups' must be strings.\");\n            }\n        }\n    }\n}\n\nfunction validatePercentileVariantAllocation(percentileAllocations: any) {\n    if (!Array.isArray(percentileAllocations)) {\n        throw new TypeError(\"Variant 'percentile' allocation must be an array.\");\n    }\n\n    for (const allocation of percentileAllocations) {\n        if (typeof allocation !== \"object\") {\n            throw new TypeError(\"Elements in variant 'percentile' allocation must be an object.\");\n        }\n        if (typeof allocation.variant !== \"string\") {\n            throw new TypeError(\"Percentile allocation 'variant' must be a string.\");\n        }\n        if (typeof allocation.from !== \"number\" || allocation.from < 0 || allocation.from > 100) {\n            throw new TypeError(\"Percentile allocation 'from' must be a number between 0 and 100.\");\n        }\n        if (typeof allocation.to !== \"number\" || allocation.to < 0 || allocation.to > 100) {\n            throw new TypeError(\"Percentile allocation 'to' must be a number between 0 and 100.\");\n        }\n    }\n}\n// #endregion\n\n// #region Telemetry\nfunction validateTelemetryOptions(telemetry: any) {\n    if (typeof telemetry !== \"object\") {\n        throw new TypeError(\"Feature flag 'telemetry' must be an object.\");\n    }\n    if (telemetry.enabled !== undefined && typeof telemetry.enabled !== \"boolean\") {\n        throw new TypeError(\"Telemetry 'enabled' must be a boolean.\");\n    }\n    if (telemetry.metadata !== undefined && typeof telemetry.metadata !== \"object\") {\n        throw new TypeError(\"Telemetry 'metadata' must be an object.\");\n    }\n}\n// #endregion\n"],"names":[],"mappings":"AAAA;AACA;AAEA;;;AAGG;AACG,SAAU,mBAAmB,CAAC,WAAgB,EAAA;AAChD,IAAA,IAAI,WAAW,KAAK,SAAS,EAAE;AAC3B,QAAA,OAAO;KACV;IACD,IAAI,WAAW,KAAK,IAAI,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE;AACzD,QAAA,MAAM,IAAI,SAAS,CAAC,iCAAiC,CAAC,CAAC;KAC1D;AACD,IAAA,IAAI,OAAO,WAAW,CAAC,EAAE,KAAK,QAAQ,EAAE;AACpC,QAAA,MAAM,IAAI,SAAS,CAAC,qCAAqC,CAAC,CAAC;KAC9D;AACD,IAAA,IAAI,WAAW,CAAC,OAAO,KAAK,SAAS,IAAI,OAAO,WAAW,CAAC,OAAO,KAAK,SAAS,EAAE;AAC/E,QAAA,MAAM,IAAI,SAAS,CAAC,2CAA2C,CAAC,CAAC;KACpE;AACD,IAAA,IAAI,WAAW,CAAC,UAAU,KAAK,SAAS,EAAE;AACtC,QAAA,mCAAmC,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;KAC/D;AACD,IAAA,IAAI,WAAW,CAAC,QAAQ,KAAK,SAAS,EAAE;AACpC,QAAA,gBAAgB,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;KAC1C;AACD,IAAA,IAAI,WAAW,CAAC,UAAU,KAAK,SAAS,EAAE;AACtC,QAAA,yBAAyB,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;KACrD;AACD,IAAA,IAAI,WAAW,CAAC,SAAS,KAAK,SAAS,EAAE;AACrC,QAAA,wBAAwB,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;KACnD;AACL,CAAC;AAED,SAAS,mCAAmC,CAAC,UAAe,EAAA;AACxD,IAAA,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;AAChC,QAAA,MAAM,IAAI,SAAS,CAAC,8CAA8C,CAAC,CAAC;KACvE;AACD,IAAA,IAAI,UAAU,CAAC,gBAAgB,KAAK,SAAS,IAAI,UAAU,CAAC,gBAAgB,KAAK,KAAK,IAAI,UAAU,CAAC,gBAAgB,KAAK,KAAK,EAAE;AAC7H,QAAA,MAAM,IAAI,SAAS,CAAC,4CAA4C,CAAC,CAAC;KACrE;AACD,IAAA,IAAI,UAAU,CAAC,cAAc,KAAK,SAAS,EAAE;AACzC,QAAA,qBAAqB,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;KACpD;AACL,CAAC;AAED,SAAS,qBAAqB,CAAC,cAAmB,EAAA;IAC9C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE;AAChC,QAAA,MAAM,IAAI,SAAS,CAAC,4DAA4D,CAAC,CAAC;KACrF;AAED,IAAA,KAAK,MAAM,MAAM,IAAI,cAAc,EAAE;AACjC,QAAA,IAAI,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ,EAAE;AACjC,YAAA,MAAM,IAAI,SAAS,CAAC,wCAAwC,CAAC,CAAC;SACjE;AACD,QAAA,IAAI,MAAM,CAAC,UAAU,KAAK,SAAS,IAAI,OAAO,MAAM,CAAC,UAAU,KAAK,QAAQ,EAAE;AAC1E,YAAA,MAAM,IAAI,SAAS,CAAC,+CAA+C,CAAC,CAAC;SACxE;KACJ;AACL,CAAC;AAED,SAAS,gBAAgB,CAAC,QAAa,EAAA;IACnC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;AAC1B,QAAA,MAAM,IAAI,SAAS,CAAC,2CAA2C,CAAC,CAAC;KACpE;AAED,IAAA,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;AAC5B,QAAA,IAAI,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE;AAClC,YAAA,MAAM,IAAI,SAAS,CAAC,kCAAkC,CAAC,CAAC;SAC3D;;AAED,QAAA,IAAI,OAAO,CAAC,eAAe,KAAK,SAAS,IAAI,OAAO,OAAO,CAAC,eAAe,KAAK,QAAQ,EAAE;AACtF,YAAA,MAAM,IAAI,SAAS,CAAC,6CAA6C,CAAC,CAAC;SACtE;QACD,IAAI,OAAO,CAAC,eAAe,KAAK,SAAS,IAAI,OAAO,CAAC,eAAe,KAAK,MAAM,IAAI,OAAO,CAAC,eAAe,KAAK,SAAS,IAAI,OAAO,CAAC,eAAe,KAAK,UAAU,EAAE;AAChK,YAAA,MAAM,IAAI,SAAS,CAAC,qEAAqE,CAAC,CAAC;SAC9F;KACJ;AACL,CAAC;AAED,SAAS,yBAAyB,CAAC,UAAe,EAAA;AAC9C,IAAA,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;AAChC,QAAA,MAAM,IAAI,SAAS,CAAC,yCAAyC,CAAC,CAAC;KAClE;AAED,IAAA,IAAI,UAAU,CAAC,qBAAqB,KAAK,SAAS,IAAI,OAAO,UAAU,CAAC,qBAAqB,KAAK,QAAQ,EAAE;AACxG,QAAA,MAAM,IAAI,SAAS,CAAC,8DAA8D,CAAC,CAAC;KACvF;AACD,IAAA,IAAI,UAAU,CAAC,oBAAoB,KAAK,SAAS,IAAI,OAAO,UAAU,CAAC,oBAAoB,KAAK,QAAQ,EAAE;AACtG,QAAA,MAAM,IAAI,SAAS,CAAC,6DAA6D,CAAC,CAAC;KACtF;AACD,IAAA,IAAI,UAAU,CAAC,IAAI,KAAK,SAAS,EAAE;AAC/B,QAAA,6BAA6B,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;KAClD;AACD,IAAA,IAAI,UAAU,CAAC,KAAK,KAAK,SAAS,EAAE;AAChC,QAAA,8BAA8B,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;KACpD;AACD,IAAA,IAAI,UAAU,CAAC,UAAU,KAAK,SAAS,EAAE;AACrC,QAAA,mCAAmC,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;KAC9D;AACD,IAAA,IAAI,UAAU,CAAC,IAAI,KAAK,SAAS,IAAI,OAAO,UAAU,CAAC,IAAI,KAAK,QAAQ,EAAE;AACtE,QAAA,MAAM,IAAI,SAAS,CAAC,6CAA6C,CAAC,CAAC;KACtE;AACL,CAAC;AAED,SAAS,6BAA6B,CAAC,eAAoB,EAAA;IACvD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE;AACjC,QAAA,MAAM,IAAI,SAAS,CAAC,6CAA6C,CAAC,CAAC;KACtE;AAED,IAAA,KAAK,MAAM,UAAU,IAAI,eAAe,EAAE;AACtC,QAAA,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;AAChC,YAAA,MAAM,IAAI,SAAS,CAAC,0DAA0D,CAAC,CAAC;SACnF;AACD,QAAA,IAAI,OAAO,UAAU,CAAC,OAAO,KAAK,QAAQ,EAAE;AACxC,YAAA,MAAM,IAAI,SAAS,CAAC,6CAA6C,CAAC,CAAC;SACtE;QACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE;AAClC,YAAA,MAAM,IAAI,SAAS,CAAC,2CAA2C,CAAC,CAAC;SACpE;AACD,QAAA,KAAK,MAAM,IAAI,IAAI,UAAU,CAAC,KAAK,EAAE;AACjC,YAAA,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;AAC1B,gBAAA,MAAM,IAAI,SAAS,CAAC,sDAAsD,CAAC,CAAC;aAC/E;SACJ;KACJ;AACL,CAAC;AAED,SAAS,8BAA8B,CAAC,gBAAqB,EAAA;IACzD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE;AAClC,QAAA,MAAM,IAAI,SAAS,CAAC,8CAA8C,CAAC,CAAC;KACvE;AAED,IAAA,KAAK,MAAM,UAAU,IAAI,gBAAgB,EAAE;AACvC,QAAA,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;AAChC,YAAA,MAAM,IAAI,SAAS,CAAC,2DAA2D,CAAC,CAAC;SACpF;AACD,QAAA,IAAI,OAAO,UAAU,CAAC,OAAO,KAAK,QAAQ,EAAE;AACxC,YAAA,MAAM,IAAI,SAAS,CAAC,8CAA8C,CAAC,CAAC;SACvE;QACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE;AACnC,YAAA,MAAM,IAAI,SAAS,CAAC,6CAA6C,CAAC,CAAC;SACtE;AACD,QAAA,KAAK,MAAM,KAAK,IAAI,UAAU,CAAC,MAAM,EAAE;AACnC,YAAA,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;AAC3B,gBAAA,MAAM,IAAI,SAAS,CAAC,wDAAwD,CAAC,CAAC;aACjF;SACJ;KACJ;AACL,CAAC;AAED,SAAS,mCAAmC,CAAC,qBAA0B,EAAA;IACnE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,qBAAqB,CAAC,EAAE;AACvC,QAAA,MAAM,IAAI,SAAS,CAAC,mDAAmD,CAAC,CAAC;KAC5E;AAED,IAAA,KAAK,MAAM,UAAU,IAAI,qBAAqB,EAAE;AAC5C,QAAA,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;AAChC,YAAA,MAAM,IAAI,SAAS,CAAC,gEAAgE,CAAC,CAAC;SACzF;AACD,QAAA,IAAI,OAAO,UAAU,CAAC,OAAO,KAAK,QAAQ,EAAE;AACxC,YAAA,MAAM,IAAI,SAAS,CAAC,mDAAmD,CAAC,CAAC;SAC5E;AACD,QAAA,IAAI,OAAO,UAAU,CAAC,IAAI,KAAK,QAAQ,IAAI,UAAU,CAAC,IAAI,GAAG,CAAC,IAAI,UAAU,CAAC,IAAI,GAAG,GAAG,EAAE;AACrF,YAAA,MAAM,IAAI,SAAS,CAAC,kEAAkE,CAAC,CAAC;SAC3F;AACD,QAAA,IAAI,OAAO,UAAU,CAAC,EAAE,KAAK,QAAQ,IAAI,UAAU,CAAC,EAAE,GAAG,CAAC,IAAI,UAAU,CAAC,EAAE,GAAG,GAAG,EAAE;AAC/E,YAAA,MAAM,IAAI,SAAS,CAAC,gEAAgE,CAAC,CAAC;SACzF;KACJ;AACL,CAAC;AACD;AAEA;AACA,SAAS,wBAAwB,CAAC,SAAc,EAAA;AAC5C,IAAA,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;AAC/B,QAAA,MAAM,IAAI,SAAS,CAAC,6CAA6C,CAAC,CAAC;KACtE;AACD,IAAA,IAAI,SAAS,CAAC,OAAO,KAAK,SAAS,IAAI,OAAO,SAAS,CAAC,OAAO,KAAK,SAAS,EAAE;AAC3E,QAAA,MAAM,IAAI,SAAS,CAAC,wCAAwC,CAAC,CAAC;KACjE;AACD,IAAA,IAAI,SAAS,CAAC,QAAQ,KAAK,SAAS,IAAI,OAAO,SAAS,CAAC,QAAQ,KAAK,QAAQ,EAAE;AAC5E,QAAA,MAAM,IAAI,SAAS,CAAC,yCAAyC,CAAC,CAAC;KAClE;AACL,CAAC;AACD;;;;"}

package/dist/esm/telemetry/featureEvaluationEvent.js

@@ -0,0 +1,62 @@
+import { VariantAssignmentReason } from '../featureManager.js';
+import { EVALUATION_EVENT_VERSION } from '../version.js';
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+const VERSION = "Version";
+const FEATURE_NAME = "FeatureName";
+const ENABLED = "Enabled";
+const TARGETING_ID = "TargetingId";
+const VARIANT = "Variant";
+const VARIANT_ASSIGNMENT_REASON = "VariantAssignmentReason";
+const DEFAULT_WHEN_ENABLED = "DefaultWhenEnabled";
+const VARIANT_ASSIGNMENT_PERCENTAGE = "VariantAssignmentPercentage";
+function createFeatureEvaluationEventProperties(result) {
+    if (result.feature === undefined) {
+        return undefined;
+    }
+    const eventProperties = {
+        [VERSION]: EVALUATION_EVENT_VERSION,
+        [FEATURE_NAME]: result.feature ? result.feature.id : "",
+        [ENABLED]: result.enabled ? "True" : "False",
+        // Ensure targetingId is string so that it will be placed in customDimensions
+        [TARGETING_ID]: result.targetingId ? result.targetingId.toString() : "",
+        [VARIANT]: result.variant ? result.variant.name : "",
+        [VARIANT_ASSIGNMENT_REASON]: result.variantAssignmentReason,
+    };
+    if (result.feature.allocation?.default_when_enabled) {
+        eventProperties[DEFAULT_WHEN_ENABLED] = result.feature.allocation.default_when_enabled;
+    }
+    if (result.variantAssignmentReason === VariantAssignmentReason.DefaultWhenEnabled) {
+        let percentileAllocationPercentage = 0;
+        if (result.variant !== undefined && result.feature.allocation !== undefined && result.feature.allocation.percentile !== undefined) {
+            for (const percentile of result.feature.allocation.percentile) {
+                percentileAllocationPercentage += percentile.to - percentile.from;
+            }
+        }
+        eventProperties[VARIANT_ASSIGNMENT_PERCENTAGE] = (100 - percentileAllocationPercentage).toString();
+    }
+    else if (result.variantAssignmentReason === VariantAssignmentReason.Percentile) {
+        let percentileAllocationPercentage = 0;
+        if (result.variant !== undefined && result.feature.allocation !== undefined && result.feature.allocation.percentile !== undefined) {
+            for (const percentile of result.feature.allocation.percentile) {
+                if (percentile.variant === result.variant.name) {
+                    percentileAllocationPercentage += percentile.to - percentile.from;
+                }
+            }
+        }
+        eventProperties[VARIANT_ASSIGNMENT_PERCENTAGE] = percentileAllocationPercentage.toString();
+    }
+    const metadata = result.feature.telemetry?.metadata;
+    if (metadata) {
+        for (const key in metadata) {
+            if (!(key in eventProperties)) {
+                eventProperties[key] = metadata[key];
+            }
+        }
+    }
+    return eventProperties;
+}
+
+export { createFeatureEvaluationEventProperties };
+//# sourceMappingURL=featureEvaluationEvent.js.map

package/dist/esm/telemetry/featureEvaluationEvent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"featureEvaluationEvent.js","sources":["../../../src/telemetry/featureEvaluationEvent.ts"],"sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { EvaluationResult, VariantAssignmentReason } from \"../featureManager\";\nimport { EVALUATION_EVENT_VERSION } from \"../version.js\";\n\nconst VERSION = \"Version\";\nconst FEATURE_NAME = \"FeatureName\";\nconst ENABLED = \"Enabled\";\nconst TARGETING_ID = \"TargetingId\";\nconst VARIANT = \"Variant\";\nconst VARIANT_ASSIGNMENT_REASON = \"VariantAssignmentReason\";\nconst DEFAULT_WHEN_ENABLED = \"DefaultWhenEnabled\";\nconst VARIANT_ASSIGNMENT_PERCENTAGE = \"VariantAssignmentPercentage\";\n\nexport function createFeatureEvaluationEventProperties(result: EvaluationResult): any {\n    if (result.feature === undefined) {\n        return undefined;\n    }\n\n    const eventProperties = {\n        [VERSION]: EVALUATION_EVENT_VERSION,\n        [FEATURE_NAME]: result.feature ? result.feature.id : \"\",\n        [ENABLED]: result.enabled ? \"True\" : \"False\",\n        // Ensure targetingId is string so that it will be placed in customDimensions\n        [TARGETING_ID]: result.targetingId ? result.targetingId.toString() : \"\",\n        [VARIANT]: result.variant ? result.variant.name : \"\",\n        [VARIANT_ASSIGNMENT_REASON]: result.variantAssignmentReason,\n    };\n\n    if (result.feature.allocation?.default_when_enabled) {\n        eventProperties[DEFAULT_WHEN_ENABLED] = result.feature.allocation.default_when_enabled;\n    }\n\n    if (result.variantAssignmentReason === VariantAssignmentReason.DefaultWhenEnabled) {\n        let percentileAllocationPercentage = 0;\n        if (result.variant !== undefined && result.feature.allocation !== undefined && result.feature.allocation.percentile !== undefined) {\n            for (const percentile of result.feature.allocation.percentile) {\n                percentileAllocationPercentage += percentile.to - percentile.from;\n            }\n        }\n        eventProperties[VARIANT_ASSIGNMENT_PERCENTAGE] = (100 - percentileAllocationPercentage).toString();\n    }\n    else if (result.variantAssignmentReason === VariantAssignmentReason.Percentile) {\n        let percentileAllocationPercentage = 0;\n        if (result.variant !== undefined && result.feature.allocation !== undefined && result.feature.allocation.percentile !== undefined) {\n            for (const percentile of result.feature.allocation.percentile) {\n                if (percentile.variant === result.variant.name) {\n                    percentileAllocationPercentage += percentile.to - percentile.from;\n                }\n            }\n        }\n        eventProperties[VARIANT_ASSIGNMENT_PERCENTAGE] = percentileAllocationPercentage.toString();\n    }\n\n    const metadata = result.feature.telemetry?.metadata;\n    if (metadata) {\n        for (const key in metadata) {\n            if (!(key in eventProperties)) {\n                eventProperties[key] = metadata[key];\n            }\n        }\n    }\n\n    return eventProperties;\n}\n"],"names":[],"mappings":";;;AAAA;AACA;AAKA,MAAM,OAAO,GAAG,SAAS,CAAC;AAC1B,MAAM,YAAY,GAAG,aAAa,CAAC;AACnC,MAAM,OAAO,GAAG,SAAS,CAAC;AAC1B,MAAM,YAAY,GAAG,aAAa,CAAC;AACnC,MAAM,OAAO,GAAG,SAAS,CAAC;AAC1B,MAAM,yBAAyB,GAAG,yBAAyB,CAAC;AAC5D,MAAM,oBAAoB,GAAG,oBAAoB,CAAC;AAClD,MAAM,6BAA6B,GAAG,6BAA6B,CAAC;AAE9D,SAAU,sCAAsC,CAAC,MAAwB,EAAA;AAC3E,IAAA,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE;AAC9B,QAAA,OAAO,SAAS,CAAC;KACpB;AAED,IAAA,MAAM,eAAe,GAAG;QACpB,CAAC,OAAO,GAAG,wBAAwB;AACnC,QAAA,CAAC,YAAY,GAAG,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE;AACvD,QAAA,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,GAAG,MAAM,GAAG,OAAO;;AAE5C,QAAA,CAAC,YAAY,GAAG,MAAM,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC,QAAQ,EAAE,GAAG,EAAE;AACvE,QAAA,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,GAAG,EAAE;AACpD,QAAA,CAAC,yBAAyB,GAAG,MAAM,CAAC,uBAAuB;KAC9D,CAAC;IAEF,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,oBAAoB,EAAE;QACjD,eAAe,CAAC,oBAAoB,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,oBAAoB,CAAC;KAC1F;IAED,IAAI,MAAM,CAAC,uBAAuB,KAAK,uBAAuB,CAAC,kBAAkB,EAAE;QAC/E,IAAI,8BAA8B,GAAG,CAAC,CAAC;QACvC,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,KAAK,SAAS,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,KAAK,SAAS,EAAE;YAC/H,KAAK,MAAM,UAAU,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,EAAE;gBAC3D,8BAA8B,IAAI,UAAU,CAAC,EAAE,GAAG,UAAU,CAAC,IAAI,CAAC;aACrE;SACJ;AACD,QAAA,eAAe,CAAC,6BAA6B,CAAC,GAAG,CAAC,GAAG,GAAG,8BAA8B,EAAE,QAAQ,EAAE,CAAC;KACtG;SACI,IAAI,MAAM,CAAC,uBAAuB,KAAK,uBAAuB,CAAC,UAAU,EAAE;QAC5E,IAAI,8BAA8B,GAAG,CAAC,CAAC;QACvC,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,KAAK,SAAS,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,KAAK,SAAS,EAAE;YAC/H,KAAK,MAAM,UAAU,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,EAAE;gBAC3D,IAAI,UAAU,CAAC,OAAO,KAAK,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE;oBAC5C,8BAA8B,IAAI,UAAU,CAAC,EAAE,GAAG,UAAU,CAAC,IAAI,CAAC;iBACrE;aACJ;SACJ;QACD,eAAe,CAAC,6BAA6B,CAAC,GAAG,8BAA8B,CAAC,QAAQ,EAAE,CAAC;KAC9F;IAED,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,QAAQ,CAAC;IACpD,IAAI,QAAQ,EAAE;AACV,QAAA,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE;AACxB,YAAA,IAAI,EAAE,GAAG,IAAI,eAAe,CAAC,EAAE;gBAC3B,eAAe,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;aACxC;SACJ;KACJ;AAED,IAAA,OAAO,eAAe,CAAC;AAC3B;;;;"}

package/dist/esm/version.js

@@ -1,6 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
-const VERSION = "2.0.0-preview.2";
+const VERSION = "2.0.0-preview.3";
+const EVALUATION_EVENT_VERSION = "1.0.0";
 
-export { VERSION };
+export { EVALUATION_EVENT_VERSION, VERSION };
 //# sourceMappingURL=version.js.map

package/dist/esm/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sources":["../../src/version.ts"],"sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nexport const VERSION = \"2.0.0-preview.2\";\n"],"names":[],"mappings":"AAAA;AACA;AAEO,MAAM,OAAO,GAAG;;;;"}
+{"version":3,"file":"version.js","sources":["../../src/version.ts"],"sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nexport const VERSION = \"2.0.0-preview.3\";\nexport const EVALUATION_EVENT_VERSION = \"1.0.0\";\n"],"names":[],"mappings":"AAAA;AACA;AAEO,MAAM,OAAO,GAAG,kBAAkB;AAClC,MAAM,wBAAwB,GAAG;;;;"}