@microsoft/applicationinsights-common 3.0.6-nightly3.2311-01 → 3.0.6-nightly3.2311-04

package/types/applicationinsights-common.d.ts

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights Common JavaScript Library, 3.0.6-nightly3.2311-01
+ * Microsoft Application Insights Common JavaScript Library, 3.0.6-nightly3.2311-04
  * 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,
@@ -884,6 +900,11 @@ export declare interface IConfig {
      * @defaultValue true
      */
     disableIkeyDeprecationMessage?: boolean;
+    /**
+     * [Optional] Sets to true if user wants to disable sending internal log message 'SendBrowserInfoOnUserInit'
+     * default to be false for versions 2.8.x and 3.0.x, true for versions 3.1.x and later
+     */
+    disableUserInitMessage?: boolean;
     /**
      * [Optional] Flag to indicate whether the internal looking endpoints should be automatically
      * added to the `excludeRequestFromAutoTrackingPatterns` collection. (defaults to true).
@@ -1526,6 +1547,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 +2263,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.6-nightly3.2311-01
+ * Microsoft Application Insights Common JavaScript Library, 3.0.6-nightly3.2311-04
  * 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,
@@ -879,6 +895,11 @@ declare namespace ApplicationInsights {
          * @defaultValue true
          */
         disableIkeyDeprecationMessage?: boolean;
+        /**
+         * [Optional] Sets to true if user wants to disable sending internal log message 'SendBrowserInfoOnUserInit'
+         * default to be false for versions 2.8.x and 3.0.x, true for versions 3.1.x and later
+         */
+        disableUserInitMessage?: boolean;
         /**
          * [Optional] Flag to indicate whether the internal looking endpoints should be automatically
          * added to the `excludeRequestFromAutoTrackingPatterns` collection. (defaults to true).
@@ -1521,6 +1542,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 +2258,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;