@microsoft/applicationinsights-common 2.7.5-nightly.2203-01 → 2.7.5-nightly.2204-03

package/dist/applicationinsights-common.api.json

@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "7.19.4",
+    "toolVersion": "7.19.5",
     "schemaVersion": 1004,
     "oldestForwardsCompatibleVersion": 1001,
     "tsdocConfig": {
@@ -1778,21 +1778,115 @@
           }
         },
         {
-          "kind": "Enum",
-          "canonicalReference": "@microsoft/applicationinsights-common!DistributedTracingModes:enum",
+          "kind": "TypeAlias",
+          "canonicalReference": "@microsoft/applicationinsights-common!DistributedTracingModes:type",
           "docComment": "",
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export declare enum DistributedTracingModes "
+              "text": "export declare type DistributedTracingModes = "
+            },
+            {
+              "kind": "Content",
+              "text": "number | "
+            },
+            {
+              "kind": "Reference",
+              "text": "eDistributedTracingModes",
+              "canonicalReference": "@microsoft/applicationinsights-common!eDistributedTracingModes:enum"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
             }
           ],
           "releaseTag": "Public",
           "name": "DistributedTracingModes",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 3
+          }
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@microsoft/applicationinsights-common!DistributedTracingModes:var",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "DistributedTracingModes: "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    AI: number;\n    AI_AND_W3C: number;\n    W3C: number;\n}"
+            }
+          ],
+          "releaseTag": "Public",
+          "name": "DistributedTracingModes",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
+        {
+          "kind": "Function",
+          "canonicalReference": "@microsoft/applicationinsights-common!dsPadNumber:function(1)",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function dsPadNumber(num: "
+            },
+            {
+              "kind": "Content",
+              "text": "number"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 4
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "num",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "name": "dsPadNumber"
+        },
+        {
+          "kind": "Enum",
+          "canonicalReference": "@microsoft/applicationinsights-common!eDistributedTracingModes:enum",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare const enum eDistributedTracingModes "
+            }
+          ],
+          "releaseTag": "Public",
+          "name": "eDistributedTracingModes",
           "members": [
             {
               "kind": "EnumMember",
-              "canonicalReference": "@microsoft/applicationinsights-common!DistributedTracingModes.AI:member",
+              "canonicalReference": "@microsoft/applicationinsights-common!eDistributedTracingModes.AI:member",
               "docComment": "/**\n * (Default) Send Application Insights correlation headers\n */\n",
               "excerptTokens": [
                 {
@@ -1813,7 +1907,7 @@
             },
             {
               "kind": "EnumMember",
-              "canonicalReference": "@microsoft/applicationinsights-common!DistributedTracingModes.AI_AND_W3C:member",
+              "canonicalReference": "@microsoft/applicationinsights-common!eDistributedTracingModes.AI_AND_W3C:member",
               "docComment": "/**\n * Send both W3C Trace Context headers and back-compatibility Application Insights headers\n */\n",
               "excerptTokens": [
                 {
@@ -1834,7 +1928,7 @@
             },
             {
               "kind": "EnumMember",
-              "canonicalReference": "@microsoft/applicationinsights-common!DistributedTracingModes.W3C:member",
+              "canonicalReference": "@microsoft/applicationinsights-common!eDistributedTracingModes.W3C:member",
               "docComment": "/**\n * Send W3C Trace Context headers\n */\n",
               "excerptTokens": [
                 {
@@ -1855,49 +1949,6 @@
             }
           ]
         },
-        {
-          "kind": "Function",
-          "canonicalReference": "@microsoft/applicationinsights-common!dsPadNumber:function(1)",
-          "docComment": "",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "export declare function dsPadNumber(num: "
-            },
-            {
-              "kind": "Content",
-              "text": "number"
-            },
-            {
-              "kind": "Content",
-              "text": "): "
-            },
-            {
-              "kind": "Content",
-              "text": "string"
-            },
-            {
-              "kind": "Content",
-              "text": ";"
-            }
-          ],
-          "returnTypeTokenRange": {
-            "startIndex": 3,
-            "endIndex": 4
-          },
-          "releaseTag": "Public",
-          "overloadIndex": 1,
-          "parameters": [
-            {
-              "parameterName": "num",
-              "parameterTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              }
-            }
-          ],
-          "name": "dsPadNumber"
-        },
         {
           "kind": "Class",
           "canonicalReference": "@microsoft/applicationinsights-common!Envelope:class",
@@ -5138,7 +5189,7 @@
                 {
                   "kind": "Reference",
                   "text": "DistributedTracingModes",
-                  "canonicalReference": "@microsoft/applicationinsights-common!DistributedTracingModes:enum"
+                  "canonicalReference": "@microsoft/applicationinsights-common!DistributedTracingModes:type"
                 },
                 {
                   "kind": "Content",
@@ -7773,7 +7824,7 @@
                 {
                   "kind": "Reference",
                   "text": "DistributedTracingModes",
-                  "canonicalReference": "@microsoft/applicationinsights-common!DistributedTracingModes:enum"
+                  "canonicalReference": "@microsoft/applicationinsights-common!DistributedTracingModes:type"
                 },
                 {
                   "kind": "Content",
@@ -17224,11 +17275,19 @@
         {
           "kind": "Function",
           "canonicalReference": "@microsoft/applicationinsights-common!utlCanUseLocalStorage:function(1)",
-          "docComment": "",
+          "docComment": "/**\n * Returns whether LocalStorage can be used, if the reset parameter is passed a true this will override any previous disable calls.\n *\n * @param reset - Should the usage be reset and determined only based on whether LocalStorage is available\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export declare function utlCanUseLocalStorage(): "
+              "text": "export declare function utlCanUseLocalStorage(reset?: "
+            },
+            {
+              "kind": "Content",
+              "text": "boolean"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
             },
             {
               "kind": "Content",
@@ -17240,12 +17299,20 @@
             }
           ],
           "returnTypeTokenRange": {
-            "startIndex": 1,
-            "endIndex": 2
+            "startIndex": 3,
+            "endIndex": 4
           },
           "releaseTag": "Public",
           "overloadIndex": 1,
-          "parameters": [],
+          "parameters": [
+            {
+              "parameterName": "reset",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
           "name": "utlCanUseLocalStorage"
         },
         {
@@ -17255,7 +17322,15 @@
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export declare function utlCanUseSessionStorage(): "
+              "text": "export declare function utlCanUseSessionStorage(reset?: "
+            },
+            {
+              "kind": "Content",
+              "text": "boolean"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
             },
             {
               "kind": "Content",
@@ -17267,18 +17342,26 @@
             }
           ],
           "returnTypeTokenRange": {
-            "startIndex": 1,
-            "endIndex": 2
+            "startIndex": 3,
+            "endIndex": 4
           },
           "releaseTag": "Public",
           "overloadIndex": 1,
-          "parameters": [],
+          "parameters": [
+            {
+              "parameterName": "reset",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
           "name": "utlCanUseSessionStorage"
         },
         {
           "kind": "Function",
           "canonicalReference": "@microsoft/applicationinsights-common!utlDisableStorage:function(1)",
-          "docComment": "",
+          "docComment": "/**\n * Disables the global SDK usage of local or session storage if available\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -17302,6 +17385,33 @@
           "parameters": [],
           "name": "utlDisableStorage"
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@microsoft/applicationinsights-common!utlEnableStorage:function(1)",
+          "docComment": "/**\n * Re-enables the global SDK usage of local or session storage if available\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function utlEnableStorage(): "
+            },
+            {
+              "kind": "Content",
+              "text": "void"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "returnTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [],
+          "name": "utlEnableStorage"
+        },
         {
           "kind": "Function",
           "canonicalReference": "@microsoft/applicationinsights-common!utlGetLocalStorage:function(1)",

package/dist/applicationinsights-common.api.md

@@ -130,15 +130,25 @@ export const DEFAULT_BREEZE_ENDPOINT = "https://dc.services.visualstudio.com";
 export const DisabledPropertyName: string;
 
 // @public (undocumented)
-export enum DistributedTracingModes {
+export const DistributedTracingModes: {
+    AI: number;
+    AI_AND_W3C: number;
+    W3C: number;
+};
+
+// @public (undocumented)
+export type DistributedTracingModes = number | eDistributedTracingModes;
+
+// @public (undocumented)
+export function dsPadNumber(num: number): string;
+
+// @public (undocumented)
+export const enum eDistributedTracingModes {
     AI = 0,
     AI_AND_W3C = 1,
     W3C = 2
 }
 
-// @public (undocumented)
-export function dsPadNumber(num: number): string;
-
 // Warning: (ae-forgotten-export) The symbol "Envelope" needs to be exported by the entry point applicationinsights-common.d.ts
 //
 // @public (undocumented)
@@ -1105,15 +1115,18 @@ export function urlParseUrl(url: string): HTMLAnchorElement;
 // @public (undocumented)
 export const Util: IUtil;
 
-// @public (undocumented)
-export function utlCanUseLocalStorage(): boolean;
+// @public
+export function utlCanUseLocalStorage(reset?: boolean): boolean;
 
 // @public (undocumented)
-export function utlCanUseSessionStorage(): boolean;
+export function utlCanUseSessionStorage(reset?: boolean): boolean;
 
-// @public (undocumented)
+// @public
 export function utlDisableStorage(): void;
 
+// @public
+export function utlEnableStorage(): void;
+
 // @public (undocumented)
 export function utlGetLocalStorage(logger: IDiagnosticLogger, name: string): string;
 

package/dist/applicationinsights-common.d.ts

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights Common JavaScript Library, 2.7.5-nightly.2203-01
+ * Microsoft Application Insights Common JavaScript Library, 2.7.5-nightly.2204-03
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -206,7 +206,23 @@ declare namespace ApplicationInsights {
      */
     const DisabledPropertyName: string;
 
-    enum DistributedTracingModes {
+    const DistributedTracingModes: {
+        AI: number;
+        AI_AND_W3C: number;
+        W3C: number;
+    };
+
+    type DistributedTracingModes = number | eDistributedTracingModes;
+
+    /**
+     * The abstract common base of all domains.
+     */
+    interface Domain {
+    }
+
+    function dsPadNumber(num: number): string;
+
+    const enum eDistributedTracingModes {
         /**
          * (Default) Send Application Insights correlation headers
          */
@@ -221,14 +237,6 @@ declare namespace ApplicationInsights {
         W3C = 2
     }
 
-    /**
-     * The abstract common base of all domains.
-     */
-    interface Domain {
-    }
-
-    function dsPadNumber(num: number): string;
-
     class Envelope extends Envelope_2 implements IEnvelope {
         /**
          * The data contract for serializing this object.
@@ -2320,12 +2328,25 @@ declare namespace ApplicationInsights {
 
     const Util: IUtil;
 
-    function utlCanUseLocalStorage(): boolean;
+    /**
+     * Returns whether LocalStorage can be used, if the reset parameter is passed a true this will override
+     * any previous disable calls.
+     * @param reset - Should the usage be reset and determined only based on whether LocalStorage is available
+     */
+    function utlCanUseLocalStorage(reset?: boolean): boolean;
 
-    function utlCanUseSessionStorage(): boolean;
+    function utlCanUseSessionStorage(reset?: boolean): boolean;
 
+    /**
+     * Disables the global SDK usage of local or session storage if available
+     */
     function utlDisableStorage(): void;
 
+    /**
+     * Re-enables the global SDK usage of local or session storage if available
+     */
+    function utlEnableStorage(): void;
+
     function utlGetLocalStorage(logger: IDiagnosticLogger, name: string): string;
 
     function utlGetSessionStorage(logger: IDiagnosticLogger, name: string): string;