@microsoft/applicationinsights-common 3.0.5 → 3.0.6-nightly3.2311-02

package/package.json

@@ -1,63 +1,66 @@
-{
-    "name": "@microsoft/applicationinsights-common",
-    "version": "3.0.5",
-    "description": "Microsoft Application Insights Common JavaScript Library",
-    "homepage": "https://github.com/microsoft/ApplicationInsights-JS#readme",
-    "author": "Microsoft Application Insights Team",
-    "main": "dist/es5/applicationinsights-common.js",
-    "module": "dist-es5/applicationinsights-common.js",
-    "types": "types/applicationinsights-common.d.ts",
-    "sideEffects": false,
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/microsoft/ApplicationInsights-JS/tree/main/shared/AppInsightsCommon"
-    },
-    "scripts": {
-        "clean": "git clean -xdf",
-        "build": "npm run build:esm && npm run build:browser && npm run sri && npm run dtsgen",
-        "build:esm": "grunt common",
-        "build:browser": "rollup -c rollup.config.js --bundleConfigAsCjs",
-        "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",
-        "api-docs": "typedoc"
-    },
-    "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",
-        "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": "^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",
-        "typescript": "^4.9.3",
-        "tslib": "^2.0.0",
-        "typedoc": "^0.24.8",
-        "globby": "^11.0.0",
-        "magic-string": "^0.25.7",
-        "sinon": "^7.3.1"
-    },
-    "peerDependencies": {
-        "tslib": "*"
-    },
-    "dependencies": {
-        "@microsoft/applicationinsights-shims": "3.0.1",
-        "@microsoft/applicationinsights-core-js": "3.0.5",
-        "@microsoft/dynamicproto-js": "^2.0.2",
-        "@nevware21/ts-utils": ">= 0.10.1 < 2.x"
-    },
-    "license": "MIT"
-}
+{
+    "name": "@microsoft/applicationinsights-common",
+    "version": "3.0.6-nightly3.2311-02",
+    "description": "Microsoft Application Insights Common JavaScript Library",
+    "homepage": "https://github.com/microsoft/ApplicationInsights-JS#readme",
+    "author": "Microsoft Application Insights Team",
+    "main": "dist/es5/applicationinsights-common.js",
+    "module": "dist-es5/applicationinsights-common.js",
+    "types": "types/applicationinsights-common.d.ts",
+    "sideEffects": false,
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/microsoft/ApplicationInsights-JS/tree/main/shared/AppInsightsCommon"
+    },
+    "scripts": {
+        "clean": "git clean -xdf",
+        "build": "npm run build:esm && npm run build:browser && npm run sri && npm run dtsgen",
+        "build:esm": "grunt common",
+        "build:browser": "rollup -c rollup.config.js --bundleConfigAsCjs",
+        "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",
+        "api-docs": "typedoc"
+    },
+    "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",
+        "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": "^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",
+        "typescript": "^4.9.3",
+        "tslib": "^2.0.0",
+        "typedoc": "^0.24.8",
+        "globby": "^11.0.0",
+        "magic-string": "^0.25.7",
+        "sinon": "^7.3.1"
+    },
+    "peerDependencies": {
+        "tslib": "*"
+    },
+    "dependencies": {
+        "@microsoft/applicationinsights-shims": "3.0.1",
+        "@microsoft/applicationinsights-core-js": "3.0.6-nightly3.2311-02",
+        "@microsoft/dynamicproto-js": "^2.0.2",
+        "@nevware21/ts-utils": ">= 0.10.1 < 2.x"
+    },
+    "license": "MIT",
+    "publishConfig": {
+        "tag": "nightly3"
+    }
+}

package/types/applicationinsights-common.d.ts

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights Common JavaScript Library, 3.0.5
+ * Microsoft Application Insights Common JavaScript Library, 3.0.6-nightly3.2311-02
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -32,6 +32,7 @@ import { isValidTraceId } from '@microsoft/applicationinsights-core-js';
 import { isValidTraceParent } from '@microsoft/applicationinsights-core-js';
 import { ITelemetryItem } from '@microsoft/applicationinsights-core-js';
 import { ITraceParent } from '@microsoft/applicationinsights-core-js';
+import { IUnloadHook } from '@microsoft/applicationinsights-core-js';
 import { parseTraceParent } from '@microsoft/applicationinsights-core-js';
 
 /**
@@ -115,6 +116,12 @@ export declare function createDistributedTraceContextFromTrace(telemetryTrace?:
 
 export declare function createDomEvent(eventName: string): Event;
 
+/**
+ * Create a new OfflineListener instance to monitor browser online / offline events
+ * @param parentEvtNamespace - The parent event namespace to append to any specific events for this instance
+ */
+export declare function createOfflineListener(parentEvtNamespace?: string | string[]): IOfflineListener;
+
 /**
  * Create a telemetry item that the 1DS channel understands
  * @param item - domain specific properties; part B
@@ -338,6 +345,15 @@ export declare class Envelope implements IEnvelope {
     constructor(logger: IDiagnosticLogger, data: AIBase, name: string);
 }
 
+/**
+ * This is the enum for the different network states current ai is experiencing
+ */
+export declare const enum eOfflineValue {
+    Unknown = 0,
+    Online = 1,
+    Offline = 2
+}
+
 export declare const enum eRequestHeaders {
     requestContextHeader = 0,
     requestContextTargetKey = 1,
@@ -1526,6 +1542,25 @@ export declare interface IMetricTelemetry extends IPartC {
     iKey?: string;
 }
 
+export declare interface IOfflineListener {
+    isOnline: () => boolean;
+    isListening: () => boolean;
+    unload: () => void;
+    addListener: (callback: OfflineCallback) => IUnloadHook;
+    setOnlineState: (uState: eOfflineValue) => void;
+}
+
+/**
+ * This is the interface for the Offline state
+ * runtime state is retrieved from the browser state
+ * user state is set by the user
+ */
+export declare interface IOfflineState {
+    readonly isOnline: boolean;
+    readonly rState: eOfflineValue;
+    readonly uState: eOfflineValue;
+}
+
 export declare interface IOperatingSystem {
     name: string;
 }
@@ -2223,6 +2258,12 @@ export declare class Metric implements IMetricData, ISerializable {
  */
 export declare function msToTimeSpan(totalms: number): string;
 
+/**
+ * this is the callback that will be called when the network status changes
+ * @param onlineState this is the current network running state
+ */
+export declare type OfflineCallback = (onlineState: IOfflineState) => void;
+
 export declare class PageView implements IPageViewData, ISerializable {
     static envelopeType: string;
     static dataType: string;

package/types/applicationinsights-common.namespaced.d.ts

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights Common JavaScript Library, 3.0.5
+ * Microsoft Application Insights Common JavaScript Library, 3.0.6-nightly3.2311-02
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -27,6 +27,7 @@ declare namespace ApplicationInsights {
     import { isValidTraceParent } from '@microsoft/applicationinsights-core-js';
     import { ITelemetryItem } from '@microsoft/applicationinsights-core-js';
     import { ITraceParent } from '@microsoft/applicationinsights-core-js';
+    import { IUnloadHook } from '@microsoft/applicationinsights-core-js';
     import { parseTraceParent } from '@microsoft/applicationinsights-core-js';
 
     /**
@@ -110,6 +111,12 @@ declare namespace ApplicationInsights {
 
     function createDomEvent(eventName: string): Event;
 
+    /**
+     * Create a new OfflineListener instance to monitor browser online / offline events
+     * @param parentEvtNamespace - The parent event namespace to append to any specific events for this instance
+     */
+    function createOfflineListener(parentEvtNamespace?: string | string[]): IOfflineListener;
+
     /**
      * Create a telemetry item that the 1DS channel understands
      * @param item - domain specific properties; part B
@@ -333,6 +340,15 @@ declare namespace ApplicationInsights {
         constructor(logger: IDiagnosticLogger, data: AIBase, name: string);
     }
 
+    /**
+     * This is the enum for the different network states current ai is experiencing
+     */
+    const enum eOfflineValue {
+        Unknown = 0,
+        Online = 1,
+        Offline = 2
+    }
+
     const enum eRequestHeaders {
         requestContextHeader = 0,
         requestContextTargetKey = 1,
@@ -1521,6 +1537,25 @@ declare namespace ApplicationInsights {
         iKey?: string;
     }
 
+    interface IOfflineListener {
+        isOnline: () => boolean;
+        isListening: () => boolean;
+        unload: () => void;
+        addListener: (callback: OfflineCallback) => IUnloadHook;
+        setOnlineState: (uState: eOfflineValue) => void;
+    }
+
+    /**
+     * This is the interface for the Offline state
+     * runtime state is retrieved from the browser state
+     * user state is set by the user
+     */
+    interface IOfflineState {
+        readonly isOnline: boolean;
+        readonly rState: eOfflineValue;
+        readonly uState: eOfflineValue;
+    }
+
     interface IOperatingSystem {
         name: string;
     }
@@ -2218,6 +2253,12 @@ declare namespace ApplicationInsights {
      */
     function msToTimeSpan(totalms: number): string;
 
+    /**
+     * this is the callback that will be called when the network status changes
+     * @param onlineState this is the current network running state
+     */
+    type OfflineCallback = (onlineState: IOfflineState) => void;
+
     class PageView implements IPageViewData, ISerializable {
         static envelopeType: string;
         static dataType: string;