@microsoft/applicationinsights-common 2.8.12-nightly.2304-31 → 2.8.12

package/dist-esm/ThrottleMgr.js

@@ -1,5 +1,5 @@
 /*
- * Application Insights JavaScript SDK - Common, 2.8.12-nightly.2304-31
+ * Application Insights JavaScript SDK - Common, 2.8.12
  * Copyright (c) Microsoft and contributors. All rights reserved.
  */
 import { _throwInternal, arrForEach, arrIndexOf, isNotNullOrUndefined, isNullOrUndefined, randomValue, safeGetLogger, strTrim } from "@microsoft/applicationinsights-core-js";

package/dist-esm/UrlHelperFuncs.js

@@ -1,5 +1,5 @@
 /*
- * Application Insights JavaScript SDK - Common, 2.8.12-nightly.2304-31
+ * Application Insights JavaScript SDK - Common, 2.8.12
  * Copyright (c) Microsoft and contributors. All rights reserved.
  */
 

package/dist-esm/Util.js

@@ -1,5 +1,5 @@
 /*
- * Application Insights JavaScript SDK - Common, 2.8.12-nightly.2304-31
+ * Application Insights JavaScript SDK - Common, 2.8.12
  * Copyright (c) Microsoft and contributors. All rights reserved.
  */
 

package/dist-esm/__DynamicConstants.js

@@ -1,5 +1,5 @@
 /*
- * Application Insights JavaScript SDK - Common, 2.8.12-nightly.2304-31
+ * Application Insights JavaScript SDK - Common, 2.8.12
  * Copyright (c) Microsoft and contributors. All rights reserved.
  */
 

package/dist-esm/applicationinsights-common.js

@@ -1,5 +1,5 @@
 /*
- * Application Insights JavaScript SDK - Common, 2.8.12-nightly.2304-31
+ * Application Insights JavaScript SDK - Common, 2.8.12
  * Copyright (c) Microsoft and contributors. All rights reserved.
  */
 

package/package.json

@@ -1,62 +1,59 @@
-{
-    "name": "@microsoft/applicationinsights-common",
-    "version": "2.8.12-nightly.2304-31",
-    "description": "Microsoft Application Insights Common JavaScript Library",
-    "homepage": "https://github.com/microsoft/ApplicationInsights-JS#readme",
-    "author": "Microsoft Application Insights Team",
-    "main": "./dist/applicationinsights-common.js",
-    "module": "./dist-esm/applicationinsights-common.js",
-    "types": "./types/applicationinsights-common.d.ts",
-    "sideEffects": false,
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/microsoft/ApplicationInsights-JS/tree/master/shared/AppInsightsCommon"
-    },
-    "scripts": {
-        "build": "npm run build:esm && npm run build:browser && npm run sri && npm run dtsgen",
-        "build:esm": "grunt common",
-        "build:browser": "rollup -c",
-        "rebuild": "npm run build",
-        "test": "grunt commontest",
-        "mintest": "grunt common-mintest",
-        "lint": "tslint -p tsconfig.json",
-        "dtsgen": "api-extractor run --local && node ../../scripts/dtsgen.js \"Microsoft Application Insights Common JavaScript Library\"",
-        "sri": "node ../../tools/subResourceIntegrity/generateIntegrityFile.js",
-        "ai-min": "grunt common-min",
-        "ai-restore": "grunt common-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-es3": "1.1.3",
-        "@microsoft/api-extractor": "^7.18.1",
-        "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",
-        "@rollup/plugin-commonjs": "^18.0.0",
-        "@rollup/plugin-node-resolve": "^11.2.1",
-        "@rollup/plugin-replace": "^2.3.3",
-        "rollup-plugin-cleanup": "^3.2.1",
-        "rollup": "^2.32.0",
-        "typescript": "^4.9.3",
-        "tslib": "^2.0.0",
-        "globby": "^11.0.0",
-        "magic-string": "^0.25.7",
-        "sinon": "^7.3.1"
-    },
-    "peerDependencies": {
-        "tslib": "*"
-    },
-    "dependencies": {
-        "@microsoft/applicationinsights-shims": "2.0.2",
-        "@microsoft/applicationinsights-core-js": "2.8.12-nightly.2304-31",
-        "@microsoft/dynamicproto-js": "^1.1.9"
-    },
-    "license": "MIT",
-    "publishConfig": {
-        "tag": "nightly"
-    }
-}
+{
+    "name": "@microsoft/applicationinsights-common",
+    "version": "2.8.12",
+    "description": "Microsoft Application Insights Common JavaScript Library",
+    "homepage": "https://github.com/microsoft/ApplicationInsights-JS#readme",
+    "author": "Microsoft Application Insights Team",
+    "main": "./dist/applicationinsights-common.js",
+    "module": "./dist-esm/applicationinsights-common.js",
+    "types": "./types/applicationinsights-common.d.ts",
+    "sideEffects": false,
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/microsoft/ApplicationInsights-JS/tree/master/shared/AppInsightsCommon"
+    },
+    "scripts": {
+        "build": "npm run build:esm && npm run build:browser && npm run sri && npm run dtsgen",
+        "build:esm": "grunt common",
+        "build:browser": "rollup -c",
+        "rebuild": "npm run build",
+        "test": "grunt commontest",
+        "mintest": "grunt common-mintest",
+        "lint": "tslint -p tsconfig.json",
+        "dtsgen": "api-extractor run --local && node ../../scripts/dtsgen.js \"Microsoft Application Insights Common JavaScript Library\"",
+        "sri": "node ../../tools/subResourceIntegrity/generateIntegrityFile.js",
+        "ai-min": "grunt common-min",
+        "ai-restore": "grunt common-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-es3": "1.1.3",
+        "@microsoft/api-extractor": "^7.18.1",
+        "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",
+        "@rollup/plugin-commonjs": "^18.0.0",
+        "@rollup/plugin-node-resolve": "^11.2.1",
+        "@rollup/plugin-replace": "^2.3.3",
+        "rollup-plugin-cleanup": "^3.2.1",
+        "rollup": "^2.32.0",
+        "typescript": "^4.9.3",
+        "tslib": "^2.0.0",
+        "globby": "^11.0.0",
+        "magic-string": "^0.25.7",
+        "sinon": "^7.3.1"
+    },
+    "peerDependencies": {
+        "tslib": "*"
+    },
+    "dependencies": {
+        "@microsoft/applicationinsights-shims": "2.0.2",
+        "@microsoft/applicationinsights-core-js": "2.8.12",
+        "@microsoft/dynamicproto-js": "^1.1.9"
+    },
+    "license": "MIT"
+}

package/src/Interfaces/IConfig.ts

@@ -3,6 +3,7 @@
 import { IConfiguration, ICustomProperties, isNullOrUndefined } from "@microsoft/applicationinsights-core-js";
 import { DistributedTracingModes } from "../Enums";
 import { IRequestContext } from "./IRequestContext";
+import { IStorageBuffer } from "./IStorageBuffer";
 
 /**
  * Configuration settings for how telemetry is sent
@@ -170,6 +171,11 @@ export interface IConfig {
      */
     enableSessionStorageBuffer?: boolean;
 
+    /**
+     * If specified, overrides the storage & retrieval mechanism that is used to manage unsent telemetry.
+     */
+    bufferOverride?: IStorageBuffer;
+
     /**
      * @deprecated Use either disableCookiesUsage or specify a cookieCfg with the enabled value set.
      * If true, the SDK will not store or read any data from cookies. Default is false. As this field is being deprecated, when both

package/src/Interfaces/IStorageBuffer.ts

@@ -0,0 +1,19 @@
+import { IDiagnosticLogger } from "@microsoft/applicationinsights-core-js";
+
+/**
+ * Identifies a simple interface to allow you to override the storage mechanism used
+ * to track unsent and unacknowledged events. When provided it must provide both
+ * the get and set item functions.
+ * @since 2.8.12
+ */
+export interface IStorageBuffer {
+    /**
+     * Retrieves the stored value for a given key
+     */
+    getItem(logger: IDiagnosticLogger, name: string): string;
+
+    /**
+     * Sets the stored value for a given key
+     */
+    setItem(logger: IDiagnosticLogger, name: string, data: string): boolean;
+}

package/src/applicationinsights-common.ts

@@ -34,6 +34,7 @@ export { PageViewPerformance } from "./Telemetry/PageViewPerformance";
 export { Data } from "./Telemetry/Common/Data";
 export { eSeverityLevel, SeverityLevel } from "./Interfaces/Contracts/SeverityLevel";
 export { IConfig, ConfigurationManager } from "./Interfaces/IConfig";
+export { IStorageBuffer } from "./Interfaces/IStorageBuffer";
 export { IChannelControlsAI } from "./Interfaces/IChannelControlsAI";
 export { IContextTagKeys, ContextTagKeys } from "./Interfaces/Contracts/ContextTagKeys";
 export {

package/types/Interfaces/IConfig.d.ts

@@ -1,6 +1,7 @@
 import { IConfiguration, ICustomProperties } from "@microsoft/applicationinsights-core-js";
 import { DistributedTracingModes } from "../Enums";
 import { IRequestContext } from "./IRequestContext";
+import { IStorageBuffer } from "./IStorageBuffer";
 /**
  * Configuration settings for how telemetry is sent
  * @export
@@ -139,6 +140,10 @@ export interface IConfig {
      * @defaultValue true
      */
     enableSessionStorageBuffer?: boolean;
+    /**
+     * If specified, overrides the storage & retrieval mechanism that is used to manage unsent telemetry.
+     */
+    bufferOverride?: IStorageBuffer;
     /**
      * @deprecated Use either disableCookiesUsage or specify a cookieCfg with the enabled value set.
      * If true, the SDK will not store or read any data from cookies. Default is false. As this field is being deprecated, when both

package/types/Interfaces/IStorageBuffer.d.ts

@@ -0,0 +1,17 @@
+import { IDiagnosticLogger } from "@microsoft/applicationinsights-core-js";
+/**
+ * Identifies a simple interface to allow you to override the storage mechanism used
+ * to track unsent and unacknowledged events. When provided it must provide both
+ * the get and set item functions.
+ * @since 2.8.12
+ */
+export interface IStorageBuffer {
+    /**
+     * Retrieves the stored value for a given key
+     */
+    getItem(logger: IDiagnosticLogger, name: string): string;
+    /**
+     * Sets the stored value for a given key
+     */
+    setItem(logger: IDiagnosticLogger, name: string, data: string): boolean;
+}

package/types/applicationinsights-common.d.ts

@@ -27,6 +27,7 @@ export { PageViewPerformance } from "./Telemetry/PageViewPerformance";
 export { Data } from "./Telemetry/Common/Data";
 export { eSeverityLevel, SeverityLevel } from "./Interfaces/Contracts/SeverityLevel";
 export { IConfig, ConfigurationManager } from "./Interfaces/IConfig";
+export { IStorageBuffer } from "./Interfaces/IStorageBuffer";
 export { IChannelControlsAI } from "./Interfaces/IChannelControlsAI";
 export { IContextTagKeys, ContextTagKeys } from "./Interfaces/Contracts/ContextTagKeys";
 export { DataSanitizerValues, IDataSanitizer, DataSanitizer, dataSanitizeKeyAndAddUniqueness, dataSanitizeKey, dataSanitizeString, dataSanitizeUrl, dataSanitizeMessage, dataSanitizeException, dataSanitizeProperties, dataSanitizeMeasurements, dataSanitizeId, dataSanitizeInput, dsPadNumber } from "./Telemetry/Common/DataSanitizer";