@microsoft/applicationinsights-cfgsync-js 0.0.2

package/dist-es5/__DynamicConstants.js

@@ -0,0 +1,18 @@
+/*
+ * Application Insights JavaScript SDK - Properties Plugin, 0.0.2
+ * Copyright (c) Microsoft and contributors. All rights reserved.
+ */
+
+
+// @skip-file-minify
+// ##############################################################
+// AUTO GENERATED FILE: This file is Auto Generated during build.
+// ##############################################################
+// !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+// Note: DON'T Export these const from the package as we are still targeting ES3 this will export a mutable variables that someone could change!!!
+// !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+export var _DYN_FEATURE_OPT_IN = "featureOptIn"; // Count: 4
+export var _DYN_ON_CFG_CHANGE_RECEIV0 = "onCfgChangeReceive"; // Count: 2
+export var _DYN_NON_OVERRIDE_CONFIGS = "nonOverrideConfigs"; // Count: 2
+export var _DYN_SCHEDULE_FETCH_TIMEO1 = "scheduleFetchTimeout"; // Count: 2
+//# sourceMappingURL=__DynamicConstants.js.map

package/dist-es5/__DynamicConstants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"__DynamicConstants.js.map","sources":["__DynamicConstants.js"],"sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved.\r\n// Licensed under the MIT License.\r\n// @skip-file-minify\r\n// ##############################################################\r\n// AUTO GENERATED FILE: This file is Auto Generated during build.\r\n// ##############################################################\r\n// !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\r\n// Note: DON'T Export these const from the package as we are still targeting ES3 this will export a mutable variables that someone could change!!!\r\n// !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\r\nexport var _DYN_FEATURE_OPT_IN = \"featureOptIn\"; // Count: 4\r\nexport var _DYN_ON_CFG_CHANGE_RECEIV0 = \"onCfgChangeReceive\"; // Count: 2\r\nexport var _DYN_NON_OVERRIDE_CONFIGS = \"nonOverrideConfigs\"; // Count: 2\r\nexport var _DYN_SCHEDULE_FETCH_TIMEO1 = \"scheduleFetchTimeout\"; // Count: 2\r\n//# sourceMappingURL=__DynamicConstants.js.map"],"names":[],"mappings":";;;;AAA4D;AAC1B;AAClC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA"}

package/dist-es5/applicationinsights-cfgsync-js.js

@@ -0,0 +1,7 @@
+/*
+ * Application Insights JavaScript SDK - Properties Plugin, 0.0.2
+ * Copyright (c) Microsoft and contributors. All rights reserved.
+ */
+import { CfgSyncPlugin } from "./CfgSyncPlugin";
+export { CfgSyncPlugin };
+//# sourceMappingURL=applicationinsights-cfgsync-js.js.map

package/dist-es5/applicationinsights-cfgsync-js.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"applicationinsights-cfgsync-js.js.map","sources":["applicationinsights-cfgsync-js.js"],"sourcesContent":["import { CfgSyncPlugin } from \"./CfgSyncPlugin\";\r\nexport { CfgSyncPlugin };\r\n//# sourceMappingURL=applicationinsights-cfgsync-js.js.map"],"names":[],"mappings":";;;;AAAA;AACA;AACA"}

package/package.json

@@ -0,0 +1,64 @@
+{
+    "name": "@microsoft/applicationinsights-cfgsync-js",
+    "version": "0.0.2",
+    "description": "Microsoft Application Insights CfgSync plugin",
+    "homepage": "https://github.com/microsoft/ApplicationInsights-JS#readme",
+    "author": "Microsoft Application Insights Team",
+    "main": "dist/es5/applicationinsights-cfgsync-js.js",
+    "module": "dist-es5/applicationinsights-cfgsync-js.js",
+    "types": "types/applicationinsights-cfgsync-js.d.ts",
+    "sideEffects": false,
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/microsoft/ApplicationInsights-JS/tree/main/extensions/applicationinsights-cfgsync-js"
+    },
+    "scripts": {
+        "build": "npm run build:esm && npm run build:browser && npm run sri && npm run dtsgen",
+        "build:esm": "grunt cfgsync",
+        "build:browser": "rollup -c rollup.config.js --bundleConfigAsCjs",
+        "rebuild": "npm run build",
+        "test": "grunt cfgsynctests",
+        "mintest": "grunt cfgsync-mintests",
+        "lint": "tslint -p tsconfig.json",
+        "dtsgen": "api-extractor run --local && node ../../scripts/dtsgen.js \"Microsoft Application Insights idsync plugin\"",
+        "sri": "node ../../tools/subResourceIntegrity/generateIntegrityFile.js",
+        "ai-min": "grunt cfgsync-min",
+        "ai-restore": "grunt cfgsync-restore",
+        "npm-pack": "npm pack"
+    },
+    "devDependencies": {
+        "@microsoft/ai-test-framework": "0.0.1",
+        "@microsoft/applicationinsights-rollup-plugin-uglify3-js": "1.0.0",
+        "@microsoft/applicationinsights-rollup-es5": "1.0.2",
+        "@microsoft/api-extractor": "^7.18.19",
+        "typescript": "^4.9.3",
+        "tslib": "^2.0.0",
+        "grunt": "^1.5.3",
+        "grunt-cli": "^1.4.3",
+        "grunt-contrib-qunit": "^6.2.1",
+        "@nevware21/grunt-ts-plugin": "^0.4.3",
+        "@nevware21/grunt-eslint-ts": "^0.2.2",
+        "globby": "^11.0.0",
+        "magic-string": "^0.25.7",
+        "pako": "^2.0.3",
+        "@rollup/plugin-commonjs": "^24.0.0",
+        "@rollup/plugin-node-resolve": "^15.0.1",
+        "@rollup/plugin-replace": "^5.0.2",
+        "rollup-plugin-cleanup": "^3.2.1",
+        "rollup": "^3.20.0",
+        "qunit": "^2.11.2",
+        "sinon": "^7.3.1"
+    },
+    "peerDependencies": {
+        "tslib": "*"
+    },
+    "dependencies": {
+        "@microsoft/dynamicproto-js": "^2.0.2",
+        "@microsoft/applicationinsights-shims": "3.0.1",
+        "@microsoft/applicationinsights-core-js": "3.0.3",
+        "@microsoft/applicationinsights-common": "3.0.3",
+        "@nevware21/ts-utils": ">= 0.10.1 < 2.x",
+        "@nevware21/ts-async": ">= 0.3.0 < 2.x"
+    },
+    "license": "MIT"
+}

package/tsconfig.json

@@ -0,0 +1,28 @@
+{
+  "compilerOptions": {
+    "sourceMap": true,
+    "inlineSources": true,
+    "noImplicitAny": true,
+    "module": "es6",
+    "moduleResolution": "Node",
+    "target": "es5",
+    "alwaysStrict": true,
+    "suppressImplicitAnyIndexErrors": true,
+    "allowSyntheticDefaultImports": true,
+    "importHelpers": true,
+    "noEmitHelpers": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "declaration": true,
+    "declarationDir": "build/types",
+    "outDir": "dist-es5",
+    "rootDir": "./src",
+    "removeComments": false
+  },
+  "include": [
+    "./src/**/*.ts"
+  ],
+  "exclude": [
+    "./node_modules/**"
+  ]
+}

package/types/applicationinsights-cfgsync-js.d.ts

@@ -0,0 +1,176 @@
+/*
+ * Microsoft Application Insights idsync plugin, 0.0.2
+ * Copyright (c) Microsoft and contributors. All rights reserved.
+ *
+ * Microsoft Application Insights Team
+ * https://github.com/microsoft/ApplicationInsights-JS#readme
+ *
+ * ---------------------------------------------------------------------------
+ * This is a single combined (rollup) declaration file for the package,
+ * if you require a namespace wrapped version it is also available.
+ * - Namespaced version: types/applicationinsights-cfgsync-js.namespaced.d.ts
+ * ---------------------------------------------------------------------------
+ */
+
+import { BaseTelemetryPlugin } from '@microsoft/applicationinsights-core-js';
+import { IAppInsightsCore } from '@microsoft/applicationinsights-core-js';
+import { IConfig } from '@microsoft/applicationinsights-common';
+import { IConfiguration } from '@microsoft/applicationinsights-core-js';
+import { IPlugin } from '@microsoft/applicationinsights-core-js';
+import { IProcessTelemetryContext } from '@microsoft/applicationinsights-core-js';
+import { ITelemetryItem } from '@microsoft/applicationinsights-core-js';
+import { ITelemetryPluginChain } from '@microsoft/applicationinsights-core-js';
+
+export declare class CfgSyncPlugin extends BaseTelemetryPlugin implements ICfgSyncPlugin {
+    priority: number;
+    identifier: string;
+    constructor();
+    initialize(config: IConfiguration & IConfig, core: IAppInsightsCore, extensions: IPlugin[], pluginChain?: ITelemetryPluginChain): void;
+    /**
+     * Get current configs of current instance.
+     * @param config current configs
+     */
+    getCfg(): IConfiguration & IConfig;
+    /**
+     * Manually set configs of current instance.
+     * @param config new configs
+     */
+    setCfg(config?: IConfiguration & IConfig): boolean;
+    /**
+     * Manually broadcast configs of current instance to all other instances.
+     * @param customDetails additional details should also be sent out to other instances
+     */
+    sync(customDetails?: any): boolean;
+    /**
+     * Manually update event name.
+     * If current instance is the main instance, then following config changes will be sent out under this new event name.
+     * If current instance is listener instances, it will listen to event details under this new name.
+     * @param eventName new event name
+     */
+    updateEventListenerName(eventName?: string): boolean;
+    /**
+     * Pause the sending/receiving of events
+     */
+    pause(): void;
+    /**
+     * Resume the sending/receiving of events
+     */
+    resume(): void;
+    processTelemetry(event: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
+}
+
+export declare interface ICfgSyncConfig {
+    /**
+     * Identifies whether instance should receive or broadcast config changes
+     * Default to broadcast
+     */
+    syncMode?: ICfgSyncMode;
+    /**
+     * Identifies event name that changes will be sent out with. And all listener instances will listen to event details under this name.
+     * Default to cfgsync.
+     */
+    customEvtName?: string;
+    /**
+     * Identifies endpoint to get config rather than core config.
+     * Default to null.
+     * If set, any core config changes will be ignored.
+     */
+    cfgUrl?: string;
+    /**
+     * Identifies if fetching cdn endpoint should be blocked
+     * Default to false.
+     */
+    blkCdnCfg?: boolean;
+    /**
+     * Overrides callback function to handle event details when changes are received via eventListener.
+     */
+    onCfgChangeReceive?: (event?: ICfgSyncEvent) => void;
+    /**
+     * Overrides sync() function to broadcast changes.
+     */
+    overrideSyncFn?: (config?: IConfiguration & IConfig, customDetails?: any) => boolean;
+    /**
+     * Overrides fetch function to get config from cfgUrl.
+     */
+    overrideFetchFn?: SendGetFunction;
+    /**
+     * Identifies configs that should NOT be changed by other instances.
+     * Default to {instrumentationKey: true, connectionString: true, endpointUrl: true }
+     */
+    nonOverrideConfigs?: NonOverrideCfg;
+    /**
+     * Identifies time interval (in ms) that should fetch from cfgUrl.
+     * Default to 30 mins, 30*60*1000ms.
+     * If set to 0, fetch will only be called once during initialization.
+     */
+    scheduleFetchTimeout?: number;
+}
+
+export declare interface ICfgSyncEvent {
+    /**
+     * Identifies config changes are expected to send out to other instances.
+     */
+    cfg?: IConfiguration & IConfig;
+    /**
+     * Identifies additional details that are expected to send out with config changes.
+     */
+    customDetails?: any;
+}
+
+export declare const enum ICfgSyncMode {
+    /**
+     * Instance will NOT receive config changes or broadcast changes
+     */
+    None = 0,
+    /**
+     * Instance will only broadcast config changes but NOT receive changes
+     */
+    Broadcast = 1,
+    /**
+     * Instance will only receive config changes but NOT broadcast changes
+     */
+    Receive = 2
+}
+
+export declare interface ICfgSyncPlugin {
+    /**
+     * Get current configs of current instance.
+     * @param config current configs
+     */
+    getCfg(): IConfiguration & IConfig;
+    /**
+     * Manually set configs of current instance.
+     * @param config new configs
+     */
+    setCfg(config?: IConfiguration & IConfig): boolean;
+    /**
+     * Manually broadcast configs of current instance to all other instances.
+     * @param customDetails additional details should also be sent out to other instances
+     */
+    sync(customDetails?: any): boolean;
+    /**
+     * Manually update event name.
+     * If current instance is the main instance, then following config changes will be sent out under this new event name.
+     * If current instance is listener instances, it will listen to event details under this new name.
+     * @param eventName new event name
+     */
+    updateEventListenerName(eventName?: string): boolean;
+    /**
+     * Pause the sending/receiving of events
+     */
+    pause(): void;
+    /**
+     * Resume the sending/receiving of events
+     */
+    resume(): void;
+}
+
+export declare type NonOverrideCfg<T = IConfiguration & IConfig> = {
+    [key in keyof T]?: boolean | NonOverrideCfg<T[key]> | undefined;
+};
+
+export declare type OnCompleteCallback = (status: number, response?: string, isAutoSync?: boolean) => void;
+
+export declare type SendGetFunction = (url: string, oncomplete: OnCompleteCallback, isAutoSync?: boolean) => void;
+
+export { }

package/types/applicationinsights-cfgsync-js.namespaced.d.ts

@@ -0,0 +1,172 @@
+/*
+ * Microsoft Application Insights idsync plugin, 0.0.2
+ * Copyright (c) Microsoft and contributors. All rights reserved.
+ *
+ * Microsoft Application Insights Team
+ * https://github.com/microsoft/ApplicationInsights-JS#readme
+ */
+
+declare namespace ApplicationInsights {
+    import { BaseTelemetryPlugin } from '@microsoft/applicationinsights-core-js';
+    import { IAppInsightsCore } from '@microsoft/applicationinsights-core-js';
+    import { IConfig } from '@microsoft/applicationinsights-common';
+    import { IConfiguration } from '@microsoft/applicationinsights-core-js';
+    import { IPlugin } from '@microsoft/applicationinsights-core-js';
+    import { IProcessTelemetryContext } from '@microsoft/applicationinsights-core-js';
+    import { ITelemetryItem } from '@microsoft/applicationinsights-core-js';
+    import { ITelemetryPluginChain } from '@microsoft/applicationinsights-core-js';
+
+    class CfgSyncPlugin extends BaseTelemetryPlugin implements ICfgSyncPlugin {
+        priority: number;
+        identifier: string;
+        constructor();
+        initialize(config: IConfiguration & IConfig, core: IAppInsightsCore, extensions: IPlugin[], pluginChain?: ITelemetryPluginChain): void;
+        /**
+         * Get current configs of current instance.
+         * @param config current configs
+         */
+        getCfg(): IConfiguration & IConfig;
+        /**
+         * Manually set configs of current instance.
+         * @param config new configs
+         */
+        setCfg(config?: IConfiguration & IConfig): boolean;
+        /**
+         * Manually broadcast configs of current instance to all other instances.
+         * @param customDetails additional details should also be sent out to other instances
+         */
+        sync(customDetails?: any): boolean;
+        /**
+         * Manually update event name.
+         * If current instance is the main instance, then following config changes will be sent out under this new event name.
+         * If current instance is listener instances, it will listen to event details under this new name.
+         * @param eventName new event name
+         */
+        updateEventListenerName(eventName?: string): boolean;
+        /**
+         * Pause the sending/receiving of events
+         */
+        pause(): void;
+        /**
+         * Resume the sending/receiving of events
+         */
+        resume(): void;
+        processTelemetry(event: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
+    }
+
+    interface ICfgSyncConfig {
+        /**
+         * Identifies whether instance should receive or broadcast config changes
+         * Default to broadcast
+         */
+        syncMode?: ICfgSyncMode;
+        /**
+         * Identifies event name that changes will be sent out with. And all listener instances will listen to event details under this name.
+         * Default to cfgsync.
+         */
+        customEvtName?: string;
+        /**
+         * Identifies endpoint to get config rather than core config.
+         * Default to null.
+         * If set, any core config changes will be ignored.
+         */
+        cfgUrl?: string;
+        /**
+         * Identifies if fetching cdn endpoint should be blocked
+         * Default to false.
+         */
+        blkCdnCfg?: boolean;
+        /**
+         * Overrides callback function to handle event details when changes are received via eventListener.
+         */
+        onCfgChangeReceive?: (event?: ICfgSyncEvent) => void;
+        /**
+         * Overrides sync() function to broadcast changes.
+         */
+        overrideSyncFn?: (config?: IConfiguration & IConfig, customDetails?: any) => boolean;
+        /**
+         * Overrides fetch function to get config from cfgUrl.
+         */
+        overrideFetchFn?: SendGetFunction;
+        /**
+         * Identifies configs that should NOT be changed by other instances.
+         * Default to {instrumentationKey: true, connectionString: true, endpointUrl: true }
+         */
+        nonOverrideConfigs?: NonOverrideCfg;
+        /**
+         * Identifies time interval (in ms) that should fetch from cfgUrl.
+         * Default to 30 mins, 30*60*1000ms.
+         * If set to 0, fetch will only be called once during initialization.
+         */
+        scheduleFetchTimeout?: number;
+    }
+
+    interface ICfgSyncEvent {
+        /**
+         * Identifies config changes are expected to send out to other instances.
+         */
+        cfg?: IConfiguration & IConfig;
+        /**
+         * Identifies additional details that are expected to send out with config changes.
+         */
+        customDetails?: any;
+    }
+
+    const enum ICfgSyncMode {
+        /**
+         * Instance will NOT receive config changes or broadcast changes
+         */
+        None = 0,
+        /**
+         * Instance will only broadcast config changes but NOT receive changes
+         */
+        Broadcast = 1,
+        /**
+         * Instance will only receive config changes but NOT broadcast changes
+         */
+        Receive = 2
+    }
+
+    interface ICfgSyncPlugin {
+        /**
+         * Get current configs of current instance.
+         * @param config current configs
+         */
+        getCfg(): IConfiguration & IConfig;
+        /**
+         * Manually set configs of current instance.
+         * @param config new configs
+         */
+        setCfg(config?: IConfiguration & IConfig): boolean;
+        /**
+         * Manually broadcast configs of current instance to all other instances.
+         * @param customDetails additional details should also be sent out to other instances
+         */
+        sync(customDetails?: any): boolean;
+        /**
+         * Manually update event name.
+         * If current instance is the main instance, then following config changes will be sent out under this new event name.
+         * If current instance is listener instances, it will listen to event details under this new name.
+         * @param eventName new event name
+         */
+        updateEventListenerName(eventName?: string): boolean;
+        /**
+         * Pause the sending/receiving of events
+         */
+        pause(): void;
+        /**
+         * Resume the sending/receiving of events
+         */
+        resume(): void;
+    }
+
+    type NonOverrideCfg<T = IConfiguration & IConfig> = {
+        [key in keyof T]?: boolean | NonOverrideCfg<T[key]> | undefined;
+    };
+
+    type OnCompleteCallback = (status: number, response?: string, isAutoSync?: boolean) => void;
+
+    type SendGetFunction = (url: string, oncomplete: OnCompleteCallback, isAutoSync?: boolean) => void;
+
+    
+}