@microsoft/feature-management-applicationinsights-browser 2.0.0-preview.1

package/LICENSE

@@ -0,0 +1,21 @@
+    MIT License
+
+    Copyright (c) Microsoft Corporation.
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE

package/README.md

@@ -0,0 +1,54 @@
+# Microsoft Feature Management Application Insights Plugin for Browser
+
+Feature Management Application Insights Plugin for Browser provides a solution for sending feature flag evaluation events produced by the Feature Management library.
+
+## Getting Started
+
+### Prerequisites
+
+- Node.js LTS version
+
+### Usage
+
+``` javascript
+import { ApplicationInsights } from "@microsoft/applicationinsights-web"
+import { FeatureManager, ConfigurationObjectFeatureFlagProvider } from "@microsoft/feature-management";
+import { trackEvent, createTelemetryPublisher } from "@microsoft/feature-management-applicationinsights-browser";
+
+const appInsights = new ApplicationInsights({ config: {
+    connectionString: CONNECTION_STRING
+}});
+appInsights.loadAppInsights();
+
+const publishTelemetry = createTelemetryPublisher(appInsights);
+const provider = new ConfigurationObjectFeatureFlagProvider(jsonObject);
+const featureManager = new FeatureManager(provider, {onFeatureEvaluated: publishTelemetry});
+
+// FeatureEvaluation event will be emitted when a feature flag is evaluated
+featureManager.getVariant("TestFeature", {userId : TARGETING_ID}).then((variant) => { /* do something*/ });
+
+// Emit a custom event with targeting id attached.
+trackEvent(appInsights, TARGETING_ID, {name: "TestEvent"}, {"Tag": "Some Value"});
+```
+
+## Contributing
+
+This project welcomes contributions and suggestions.  Most contributions require you to agree to a
+Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
+the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
+
+When you submit a pull request, a CLA bot will automatically determine whether you need to provide
+a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
+provided by the bot. You will only need to do this once across all repos using our CLA.
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
+contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
+
+## Trademarks
+
+This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft 
+trademarks or logos is subject to and must follow 
+[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
+Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
+Any use of third-party trademarks or logos are subject to those third-party's policies.

package/dist/esm/index.js

@@ -0,0 +1,3 @@
+export { createTelemetryPublisher, trackEvent } from './telemetry.js';
+export { VERSION } from './version.js';
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

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

package/dist/esm/telemetry.js

@@ -0,0 +1,47 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/**
+ * Creates a telemetry publisher that sends feature evaluation events to Application Insights.
+ * @param client The Application Insights telemetry client.
+ * @returns A callback function that takes an evaluation result and tracks an event with the evaluation details.
+ */
+function createTelemetryPublisher(client) {
+    return (event) => {
+        const eventProperties = {
+            "FeatureName": event.feature?.id,
+            "Enabled": event.enabled.toString(),
+            // Ensure targetingId is string so that it will be placed in customDimensions
+            "TargetingId": event.targetingId?.toString(),
+            "Variant": event.variant?.name,
+            "VariantAssignmentReason": event.variantAssignmentReason,
+        };
+        const metadata = event.feature?.telemetry?.metadata;
+        if (metadata) {
+            for (const key in metadata) {
+                if (!(key in eventProperties)) {
+                    eventProperties[key] = metadata[key];
+                }
+            }
+        }
+        client.trackEvent({ name: "FeatureEvaluation" }, eventProperties);
+    };
+}
+/**
+ * Tracks a custom event using Application Insights, ensuring that the "TargetingId"
+ * is included in the custom properties. If the "TargetingId" already exists in
+ * the provided custom properties, it will be overwritten.
+ *
+ * @param client The Application Insights client instance used to track the event.
+ * @param targetingId The unique targeting identifier that will be included in the custom properties.
+ * @param event The event telemetry object to be tracked, containing event details.
+ * @param customProperties (Optional) Additional properties to include in the event telemetry.
+ */
+function trackEvent(client, targetingId, event, customProperties) {
+    const properties = customProperties ? { ...customProperties } : {};
+    // Ensure targetingId is string so that it will be placed in customDimensions
+    properties["TargetingId"] = targetingId?.toString();
+    client.trackEvent(event, properties);
+}
+
+export { createTelemetryPublisher, trackEvent };
+//# sourceMappingURL=telemetry.js.map

package/dist/esm/telemetry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"telemetry.js","sources":["../../src/telemetry.ts"],"sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { EvaluationResult } from \"@microsoft/feature-management\";\nimport { ApplicationInsights } from \"@microsoft/applicationinsights-web\";\nimport { IEventTelemetry } from \"@microsoft/applicationinsights-web\";\n\n/**\n * Creates a telemetry publisher that sends feature evaluation events to Application Insights.\n * @param client The Application Insights telemetry client.\n * @returns A callback function that takes an evaluation result and tracks an event with the evaluation details.\n */\nexport function createTelemetryPublisher(client: ApplicationInsights): (event: EvaluationResult) => void {\n    return (event: EvaluationResult) => {\n        const eventProperties = {\n            \"FeatureName\": event.feature?.id,\n            \"Enabled\": event.enabled.toString(),\n            // Ensure targetingId is string so that it will be placed in customDimensions\n            \"TargetingId\": event.targetingId?.toString(),\n            \"Variant\": event.variant?.name,\n            \"VariantAssignmentReason\": event.variantAssignmentReason,\n        };\n\n        const metadata = event.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        client.trackEvent({ name: \"FeatureEvaluation\" }, eventProperties);\n    };\n}\n\n/**\n * Tracks a custom event using Application Insights, ensuring that the \"TargetingId\"\n * is included in the custom properties. If the \"TargetingId\" already exists in\n * the provided custom properties, it will be overwritten.\n *\n * @param client The Application Insights client instance used to track the event.\n * @param targetingId The unique targeting identifier that will be included in the custom properties.\n * @param event The event telemetry object to be tracked, containing event details.\n * @param customProperties (Optional) Additional properties to include in the event telemetry.\n */\nexport function trackEvent(client: ApplicationInsights, targetingId: string, event: IEventTelemetry, customProperties?: {[key: string]: any}): void {\n    const properties = customProperties ? { ...customProperties } : {};\n    // Ensure targetingId is string so that it will be placed in customDimensions\n    properties[\"TargetingId\"] = targetingId?.toString();\n    client.trackEvent(event, properties);\n}\n"],"names":[],"mappings":"AAAA;AACA;AAMA;;;;AAIG;AACG,SAAU,wBAAwB,CAAC,MAA2B,EAAA;IAChE,OAAO,CAAC,KAAuB,KAAI;AAC/B,QAAA,MAAM,eAAe,GAAG;AACpB,YAAA,aAAa,EAAE,KAAK,CAAC,OAAO,EAAE,EAAE;AAChC,YAAA,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE;;AAEnC,YAAA,aAAa,EAAE,KAAK,CAAC,WAAW,EAAE,QAAQ,EAAE;AAC5C,YAAA,SAAS,EAAE,KAAK,CAAC,OAAO,EAAE,IAAI;YAC9B,yBAAyB,EAAE,KAAK,CAAC,uBAAuB;SAC3D,CAAC;QAEF,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,EAAE,SAAS,EAAE,QAAQ,CAAC;QACpD,IAAI,QAAQ,EAAE;AACV,YAAA,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE;AACxB,gBAAA,IAAI,EAAE,GAAG,IAAI,eAAe,CAAC,EAAE;oBAC3B,eAAe,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;iBACxC;aACJ;SACJ;QAED,MAAM,CAAC,UAAU,CAAC,EAAE,IAAI,EAAE,mBAAmB,EAAE,EAAE,eAAe,CAAC,CAAC;AACtE,KAAC,CAAC;AACN,CAAC;AAED;;;;;;;;;AASG;AACG,SAAU,UAAU,CAAC,MAA2B,EAAE,WAAmB,EAAE,KAAsB,EAAE,gBAAuC,EAAA;AACxI,IAAA,MAAM,UAAU,GAAG,gBAAgB,GAAG,EAAE,GAAG,gBAAgB,EAAE,GAAG,EAAE,CAAC;;IAEnE,UAAU,CAAC,aAAa,CAAC,GAAG,WAAW,EAAE,QAAQ,EAAE,CAAC;AACpD,IAAA,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;AACzC;;;;"}

package/dist/esm/version.js

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

package/dist/esm/version.js.map

@@ -0,0 +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.1\";\n"],"names":[],"mappings":"AAAA;AACA;AAEO,MAAM,OAAO,GAAG;;;;"}

package/dist/umd/index.js

@@ -0,0 +1,61 @@
+(function (global, factory) {
+    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports) :
+    typeof define === 'function' && define.amd ? define(['exports'], factory) :
+    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.FeatureManagementApplicationInsights = {}));
+})(this, (function (exports) { 'use strict';
+
+    // Copyright (c) Microsoft Corporation.
+    // Licensed under the MIT license.
+    /**
+     * Creates a telemetry publisher that sends feature evaluation events to Application Insights.
+     * @param client The Application Insights telemetry client.
+     * @returns A callback function that takes an evaluation result and tracks an event with the evaluation details.
+     */
+    function createTelemetryPublisher(client) {
+        return (event) => {
+            const eventProperties = {
+                "FeatureName": event.feature?.id,
+                "Enabled": event.enabled.toString(),
+                // Ensure targetingId is string so that it will be placed in customDimensions
+                "TargetingId": event.targetingId?.toString(),
+                "Variant": event.variant?.name,
+                "VariantAssignmentReason": event.variantAssignmentReason,
+            };
+            const metadata = event.feature?.telemetry?.metadata;
+            if (metadata) {
+                for (const key in metadata) {
+                    if (!(key in eventProperties)) {
+                        eventProperties[key] = metadata[key];
+                    }
+                }
+            }
+            client.trackEvent({ name: "FeatureEvaluation" }, eventProperties);
+        };
+    }
+    /**
+     * Tracks a custom event using Application Insights, ensuring that the "TargetingId"
+     * is included in the custom properties. If the "TargetingId" already exists in
+     * the provided custom properties, it will be overwritten.
+     *
+     * @param client The Application Insights client instance used to track the event.
+     * @param targetingId The unique targeting identifier that will be included in the custom properties.
+     * @param event The event telemetry object to be tracked, containing event details.
+     * @param customProperties (Optional) Additional properties to include in the event telemetry.
+     */
+    function trackEvent(client, targetingId, event, customProperties) {
+        const properties = customProperties ? { ...customProperties } : {};
+        // Ensure targetingId is string so that it will be placed in customDimensions
+        properties["TargetingId"] = targetingId?.toString();
+        client.trackEvent(event, properties);
+    }
+
+    // Copyright (c) Microsoft Corporation.
+    // Licensed under the MIT license.
+    const VERSION = "2.0.0-preview.1";
+
+    exports.VERSION = VERSION;
+    exports.createTelemetryPublisher = createTelemetryPublisher;
+    exports.trackEvent = trackEvent;
+
+}));
+//# sourceMappingURL=index.js.map

package/dist/umd/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../src/telemetry.ts","../../src/version.ts"],"sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { EvaluationResult } from \"@microsoft/feature-management\";\nimport { ApplicationInsights } from \"@microsoft/applicationinsights-web\";\nimport { IEventTelemetry } from \"@microsoft/applicationinsights-web\";\n\n/**\n * Creates a telemetry publisher that sends feature evaluation events to Application Insights.\n * @param client The Application Insights telemetry client.\n * @returns A callback function that takes an evaluation result and tracks an event with the evaluation details.\n */\nexport function createTelemetryPublisher(client: ApplicationInsights): (event: EvaluationResult) => void {\n    return (event: EvaluationResult) => {\n        const eventProperties = {\n            \"FeatureName\": event.feature?.id,\n            \"Enabled\": event.enabled.toString(),\n            // Ensure targetingId is string so that it will be placed in customDimensions\n            \"TargetingId\": event.targetingId?.toString(),\n            \"Variant\": event.variant?.name,\n            \"VariantAssignmentReason\": event.variantAssignmentReason,\n        };\n\n        const metadata = event.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        client.trackEvent({ name: \"FeatureEvaluation\" }, eventProperties);\n    };\n}\n\n/**\n * Tracks a custom event using Application Insights, ensuring that the \"TargetingId\"\n * is included in the custom properties. If the \"TargetingId\" already exists in\n * the provided custom properties, it will be overwritten.\n *\n * @param client The Application Insights client instance used to track the event.\n * @param targetingId The unique targeting identifier that will be included in the custom properties.\n * @param event The event telemetry object to be tracked, containing event details.\n * @param customProperties (Optional) Additional properties to include in the event telemetry.\n */\nexport function trackEvent(client: ApplicationInsights, targetingId: string, event: IEventTelemetry, customProperties?: {[key: string]: any}): void {\n    const properties = customProperties ? { ...customProperties } : {};\n    // Ensure targetingId is string so that it will be placed in customDimensions\n    properties[\"TargetingId\"] = targetingId?.toString();\n    client.trackEvent(event, properties);\n}\n","// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nexport const VERSION = \"2.0.0-preview.1\";\n"],"names":[],"mappings":";;;;;;IAAA;IACA;IAMA;;;;IAIG;IACG,SAAU,wBAAwB,CAAC,MAA2B,EAAA;QAChE,OAAO,CAAC,KAAuB,KAAI;IAC/B,QAAA,MAAM,eAAe,GAAG;IACpB,YAAA,aAAa,EAAE,KAAK,CAAC,OAAO,EAAE,EAAE;IAChC,YAAA,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE;;IAEnC,YAAA,aAAa,EAAE,KAAK,CAAC,WAAW,EAAE,QAAQ,EAAE;IAC5C,YAAA,SAAS,EAAE,KAAK,CAAC,OAAO,EAAE,IAAI;gBAC9B,yBAAyB,EAAE,KAAK,CAAC,uBAAuB;aAC3D,CAAC;YAEF,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,EAAE,SAAS,EAAE,QAAQ,CAAC;YACpD,IAAI,QAAQ,EAAE;IACV,YAAA,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE;IACxB,gBAAA,IAAI,EAAE,GAAG,IAAI,eAAe,CAAC,EAAE;wBAC3B,eAAe,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;qBACxC;iBACJ;aACJ;YAED,MAAM,CAAC,UAAU,CAAC,EAAE,IAAI,EAAE,mBAAmB,EAAE,EAAE,eAAe,CAAC,CAAC;IACtE,KAAC,CAAC;IACN,CAAC;IAED;;;;;;;;;IASG;IACG,SAAU,UAAU,CAAC,MAA2B,EAAE,WAAmB,EAAE,KAAsB,EAAE,gBAAuC,EAAA;IACxI,IAAA,MAAM,UAAU,GAAG,gBAAgB,GAAG,EAAE,GAAG,gBAAgB,EAAE,GAAG,EAAE,CAAC;;QAEnE,UAAU,CAAC,aAAa,CAAC,GAAG,WAAW,EAAE,QAAQ,EAAE,CAAC;IACpD,IAAA,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;IACzC;;ICnDA;IACA;AAEO,UAAM,OAAO,GAAG;;;;;;;;;;"}

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@microsoft/feature-management-applicationinsights-browser",
+  "version": "2.0.0-preview.1",
+  "description": "Feature Management Application Insights Plugin for Browser provides a solution for sending feature flag evaluation events produced by the Feature Management library.",
+  "main": "./dist/umd/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "types/index.d.ts",
+  "files": [
+    "dist/",
+    "types/",
+    "LICENSE",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "npm run link && npm run clean && rollup --config",
+    "clean": "rimraf dist types",
+    "link": "npm link ../feature-management",
+    "dev": "rollup --config --watch",
+    "lint": "eslint src/",
+    "fix-lint": "eslint src/ --fix"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/microsoft/FeatureManagement-JavaScript.git"
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/microsoft/FeatureManagement-JavaScript/issues"
+  },
+  "homepage": "https://github.com/microsoft/FeatureManagement-JavaScript#readme",
+  "devDependencies": {
+    "@rollup/plugin-typescript": "^11.1.5",
+    "@types/node": "^20.10.7",
+    "@typescript-eslint/eslint-plugin": "^6.18.1",
+    "@typescript-eslint/parser": "^6.18.1",
+    "eslint": "^8.56.0",
+    "rimraf": "^5.0.5",
+    "rollup": "^4.9.4",
+    "rollup-plugin-dts": "^6.1.0",
+    "tslib": "^2.6.2",
+    "typescript": "^5.3.3"
+  },
+  "dependencies": {
+    "@microsoft/applicationinsights-web": "^3.3.2",
+    "@microsoft/feature-management": "1.0.0-preview.1"
+  }
+}
+  

package/types/index.d.ts

@@ -0,0 +1,26 @@
+import { EvaluationResult } from '@microsoft/feature-management';
+import { ApplicationInsights, IEventTelemetry } from '@microsoft/applicationinsights-web';
+
+/**
+ * Creates a telemetry publisher that sends feature evaluation events to Application Insights.
+ * @param client The Application Insights telemetry client.
+ * @returns A callback function that takes an evaluation result and tracks an event with the evaluation details.
+ */
+declare function createTelemetryPublisher(client: ApplicationInsights): (event: EvaluationResult) => void;
+/**
+ * Tracks a custom event using Application Insights, ensuring that the "TargetingId"
+ * is included in the custom properties. If the "TargetingId" already exists in
+ * the provided custom properties, it will be overwritten.
+ *
+ * @param client The Application Insights client instance used to track the event.
+ * @param targetingId The unique targeting identifier that will be included in the custom properties.
+ * @param event The event telemetry object to be tracked, containing event details.
+ * @param customProperties (Optional) Additional properties to include in the event telemetry.
+ */
+declare function trackEvent(client: ApplicationInsights, targetingId: string, event: IEventTelemetry, customProperties?: {
+    [key: string]: any;
+}): void;
+
+declare const VERSION = "2.0.0-preview.1";
+
+export { VERSION, createTelemetryPublisher, trackEvent };