@microsoft/applicationinsights-common 2.8.4-nightly.2205-08 → 2.8.4

package/dist/applicationinsights-common.api.json

@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "7.24.0",
+    "toolVersion": "7.24.2",
     "schemaVersion": 1005,
     "oldestForwardsCompatibleVersion": 1001,
     "tsdocConfig": {
@@ -556,6 +556,69 @@
             "endIndex": 2
           }
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@microsoft/applicationinsights-common!createDistributedTraceContextFromTrace:function(1)",
+          "docComment": "/**\n * Creates a IDistributedTraceContext from an optional telemetryTrace\n *\n * @param telemetryTrace - The telemetryTrace instance that is being wrapped\n *\n * @param parentCtx - An optional parent distributed trace instance, almost always undefined as this scenario is only used in the case of multiple property handlers.\n *\n * @returns A new IDistributedTraceContext instance that is backed by the telemetryTrace or temporary object\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function createDistributedTraceContextFromTrace(telemetryTrace?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "ITelemetryTrace",
+              "canonicalReference": "@microsoft/applicationinsights-common!ITelemetryTrace:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", parentCtx?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "IDistributedTraceContext",
+              "canonicalReference": "@microsoft/applicationinsights-core-js!IDistributedTraceContext:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Reference",
+              "text": "IDistributedTraceContext",
+              "canonicalReference": "@microsoft/applicationinsights-core-js!IDistributedTraceContext:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "returnTypeTokenRange": {
+            "startIndex": 5,
+            "endIndex": 6
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "telemetryTrace",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": true
+            },
+            {
+              "parameterName": "parentCtx",
+              "parameterTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "isOptional": true
+            }
+          ],
+          "name": "createDistributedTraceContextFromTrace"
+        },
         {
           "kind": "Function",
           "canonicalReference": "@microsoft/applicationinsights-common!createDomEvent:function(1)",
@@ -740,99 +803,6 @@
           ],
           "name": "createTelemetryItem"
         },
-        {
-          "kind": "Function",
-          "canonicalReference": "@microsoft/applicationinsights-common!createTraceParent:function(1)",
-          "docComment": "/**\n * Create a new ITraceParent instance using the provided values.\n *\n * @param traceId - The traceId to use, when invalid a new random W3C id will be generated.\n *\n * @param spanId - The parent/span id to use, a new random value will be generated if it is invalid.\n *\n * @param flags - The traceFlags to use, defaults to zero (0) if not supplied or invalid\n *\n * @param version - The version to used, defaults to version \"01\" if not supplied or invalid.\n *\n * @returns \n */\n",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "export declare function createTraceParent(traceId?: "
-            },
-            {
-              "kind": "Content",
-              "text": "string"
-            },
-            {
-              "kind": "Content",
-              "text": ", spanId?: "
-            },
-            {
-              "kind": "Content",
-              "text": "string"
-            },
-            {
-              "kind": "Content",
-              "text": ", flags?: "
-            },
-            {
-              "kind": "Content",
-              "text": "number"
-            },
-            {
-              "kind": "Content",
-              "text": ", version?: "
-            },
-            {
-              "kind": "Content",
-              "text": "string"
-            },
-            {
-              "kind": "Content",
-              "text": "): "
-            },
-            {
-              "kind": "Reference",
-              "text": "ITraceParent",
-              "canonicalReference": "@microsoft/applicationinsights-common!ITraceParent:interface"
-            },
-            {
-              "kind": "Content",
-              "text": ";"
-            }
-          ],
-          "returnTypeTokenRange": {
-            "startIndex": 9,
-            "endIndex": 10
-          },
-          "releaseTag": "Public",
-          "overloadIndex": 1,
-          "parameters": [
-            {
-              "parameterName": "traceId",
-              "parameterTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              },
-              "isOptional": true
-            },
-            {
-              "parameterName": "spanId",
-              "parameterTypeTokenRange": {
-                "startIndex": 3,
-                "endIndex": 4
-              },
-              "isOptional": true
-            },
-            {
-              "parameterName": "flags",
-              "parameterTypeTokenRange": {
-                "startIndex": 5,
-                "endIndex": 6
-              },
-              "isOptional": true
-            },
-            {
-              "parameterName": "version",
-              "parameterTypeTokenRange": {
-                "startIndex": 7,
-                "endIndex": 8
-              },
-              "isOptional": true
-            }
-          ],
-          "name": "createTraceParent"
-        },
         {
           "kind": "Variable",
           "canonicalReference": "@microsoft/applicationinsights-common!CtxTagKeys:var",
@@ -4367,79 +4337,6 @@
             }
           ]
         },
-        {
-          "kind": "Function",
-          "canonicalReference": "@microsoft/applicationinsights-common!findW3cTraceParent:function(1)",
-          "docComment": "/**\n * Helper function to fetch the passed traceparent from the page, looking for it as a meta-tag or a Server-Timing header.\n *\n * @returns \n */\n",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "export declare function findW3cTraceParent(): "
-            },
-            {
-              "kind": "Reference",
-              "text": "ITraceParent",
-              "canonicalReference": "@microsoft/applicationinsights-common!ITraceParent:interface"
-            },
-            {
-              "kind": "Content",
-              "text": ";"
-            }
-          ],
-          "returnTypeTokenRange": {
-            "startIndex": 1,
-            "endIndex": 2
-          },
-          "releaseTag": "Public",
-          "overloadIndex": 1,
-          "parameters": [],
-          "name": "findW3cTraceParent"
-        },
-        {
-          "kind": "Function",
-          "canonicalReference": "@microsoft/applicationinsights-common!formatTraceParent:function(1)",
-          "docComment": "/**\n * Format the ITraceParent value as a string using the supported and know version formats. So even if the passed traceParent is a later version the string value returned from this function will convert it to only the known version formats. This currently only supports version \"00\" and invalid \"ff\"\n *\n * @param value - The parsed traceParent value\n *\n * @returns \n */\n",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "export declare function formatTraceParent(value: "
-            },
-            {
-              "kind": "Reference",
-              "text": "ITraceParent",
-              "canonicalReference": "@microsoft/applicationinsights-common!ITraceParent:interface"
-            },
-            {
-              "kind": "Content",
-              "text": "): "
-            },
-            {
-              "kind": "Content",
-              "text": "string"
-            },
-            {
-              "kind": "Content",
-              "text": ";"
-            }
-          ],
-          "returnTypeTokenRange": {
-            "startIndex": 3,
-            "endIndex": 4
-          },
-          "releaseTag": "Public",
-          "overloadIndex": 1,
-          "parameters": [
-            {
-              "parameterName": "value",
-              "parameterTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              },
-              "isOptional": false
-            }
-          ],
-          "name": "formatTraceParent"
-        },
         {
           "kind": "Function",
           "canonicalReference": "@microsoft/applicationinsights-common!getExtensionByName:function(1)",
@@ -13319,184 +13216,6 @@
           ],
           "name": "isInternalApplicationInsightsEndpoint"
         },
-        {
-          "kind": "Function",
-          "canonicalReference": "@microsoft/applicationinsights-common!isSampledFlag:function(1)",
-          "docComment": "/**\n * Is the parsed traceParent indicating that the trace is currently sampled.\n *\n * @param value - The parsed traceParent value\n *\n * @returns \n */\n",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "export declare function isSampledFlag(value: "
-            },
-            {
-              "kind": "Reference",
-              "text": "ITraceParent",
-              "canonicalReference": "@microsoft/applicationinsights-common!ITraceParent:interface"
-            },
-            {
-              "kind": "Content",
-              "text": "): "
-            },
-            {
-              "kind": "Content",
-              "text": "boolean"
-            },
-            {
-              "kind": "Content",
-              "text": ";"
-            }
-          ],
-          "returnTypeTokenRange": {
-            "startIndex": 3,
-            "endIndex": 4
-          },
-          "releaseTag": "Public",
-          "overloadIndex": 1,
-          "parameters": [
-            {
-              "parameterName": "value",
-              "parameterTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              },
-              "isOptional": false
-            }
-          ],
-          "name": "isSampledFlag"
-        },
-        {
-          "kind": "Function",
-          "canonicalReference": "@microsoft/applicationinsights-common!isValidSpanId:function(1)",
-          "docComment": "/**\n * Is the provided W3c span id (aka. parent id) a valid string representation, it must be a 16-character string of lowercase hexadecimal characters, for example, 00f067aa0ba902b7. If all characters are zero (0000000000000000) this is considered an invalid value.\n *\n * @param value - The W3c span id to be validated\n *\n * @returns true if valid otherwise false\n */\n",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "export declare function isValidSpanId(value: "
-            },
-            {
-              "kind": "Content",
-              "text": "string"
-            },
-            {
-              "kind": "Content",
-              "text": "): "
-            },
-            {
-              "kind": "Content",
-              "text": "boolean"
-            },
-            {
-              "kind": "Content",
-              "text": ";"
-            }
-          ],
-          "returnTypeTokenRange": {
-            "startIndex": 3,
-            "endIndex": 4
-          },
-          "releaseTag": "Public",
-          "overloadIndex": 1,
-          "parameters": [
-            {
-              "parameterName": "value",
-              "parameterTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              },
-              "isOptional": false
-            }
-          ],
-          "name": "isValidSpanId"
-        },
-        {
-          "kind": "Function",
-          "canonicalReference": "@microsoft/applicationinsights-common!isValidTraceId:function(1)",
-          "docComment": "/**\n * Is the provided W3c Trace Id a valid string representation, it must be a 32-character string of lowercase hexadecimal characters for example, 4bf92f3577b34da6a3ce929d0e0e4736. If all characters as zero (00000000000000000000000000000000) it will be considered an invalid value.\n *\n * @param value - The W3c trace Id to be validated\n *\n * @returns true if valid otherwise false\n */\n",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "export declare function isValidTraceId(value: "
-            },
-            {
-              "kind": "Content",
-              "text": "string"
-            },
-            {
-              "kind": "Content",
-              "text": "): "
-            },
-            {
-              "kind": "Content",
-              "text": "boolean"
-            },
-            {
-              "kind": "Content",
-              "text": ";"
-            }
-          ],
-          "returnTypeTokenRange": {
-            "startIndex": 3,
-            "endIndex": 4
-          },
-          "releaseTag": "Public",
-          "overloadIndex": 1,
-          "parameters": [
-            {
-              "parameterName": "value",
-              "parameterTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              },
-              "isOptional": false
-            }
-          ],
-          "name": "isValidTraceId"
-        },
-        {
-          "kind": "Function",
-          "canonicalReference": "@microsoft/applicationinsights-common!isValidTraceParent:function(1)",
-          "docComment": "/**\n * Validates that the provided ITraceParent instance conforms to the currently supported specifications\n *\n * @param value - \n *\n * @returns \n */\n",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "export declare function isValidTraceParent(value: "
-            },
-            {
-              "kind": "Reference",
-              "text": "ITraceParent",
-              "canonicalReference": "@microsoft/applicationinsights-common!ITraceParent:interface"
-            },
-            {
-              "kind": "Content",
-              "text": "): "
-            },
-            {
-              "kind": "Content",
-              "text": "boolean"
-            },
-            {
-              "kind": "Content",
-              "text": ";"
-            }
-          ],
-          "returnTypeTokenRange": {
-            "startIndex": 3,
-            "endIndex": 4
-          },
-          "releaseTag": "Public",
-          "overloadIndex": 1,
-          "parameters": [
-            {
-              "parameterName": "value",
-              "parameterTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              },
-              "isOptional": false
-            }
-          ],
-          "name": "isValidTraceParent"
-        },
         {
           "kind": "Interface",
           "canonicalReference": "@microsoft/applicationinsights-common!ITelemetryContext:interface",
@@ -13875,107 +13594,12 @@
             },
             {
               "kind": "PropertySignature",
-              "canonicalReference": "@microsoft/applicationinsights-common!ITelemetryTrace#traceID:member",
-              "docComment": "/**\n * Trace id\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "traceID?: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "string"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isOptional": true,
-              "releaseTag": "Public",
-              "name": "traceID",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              }
-            },
-            {
-              "kind": "PropertySignature",
-              "canonicalReference": "@microsoft/applicationinsights-common!ITelemetryTrace#traceState:member",
-              "docComment": "/**\n * Trace state\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "traceState?: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "ITraceState",
-                  "canonicalReference": "@microsoft/applicationinsights-common!ITraceState:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isOptional": true,
-              "releaseTag": "Public",
-              "name": "traceState",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              }
-            }
-          ],
-          "extendsTokenRanges": []
-        },
-        {
-          "kind": "Interface",
-          "canonicalReference": "@microsoft/applicationinsights-common!ITraceParent:interface",
-          "docComment": "/**\n * This interface represents the components of a W3C traceparent header\n */\n",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "export interface ITraceParent "
-            }
-          ],
-          "releaseTag": "Public",
-          "name": "ITraceParent",
-          "members": [
-            {
-              "kind": "PropertySignature",
-              "canonicalReference": "@microsoft/applicationinsights-common!ITraceParent#spanId:member",
-              "docComment": "/**\n * This is the ID of the current request as known by the caller (in some tracing systems, this is also known as the parent-id, where a span is the execution of a client request). It is represented as an 16-character string of lowercase hexadecimal characters, for example, 00f067aa0ba902b7. All bytes as zero (0000000000000000) is considered an invalid value.\n */\n",
+              "canonicalReference": "@microsoft/applicationinsights-common!ITelemetryTrace#traceFlags:member",
+              "docComment": "/**\n * An integer representation of the W3C TraceContext trace-flags. https://www.w3.org/TR/trace-context/#trace-flags\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "spanId: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "string"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isOptional": false,
-              "releaseTag": "Public",
-              "name": "spanId",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              }
-            },
-            {
-              "kind": "PropertySignature",
-              "canonicalReference": "@microsoft/applicationinsights-common!ITraceParent#traceFlags:member",
-              "docComment": "/**\n * An 8-bit value of flags that controls tracing such as sampling, trace level, etc. These flags are recommendations given by the caller rather than strict rules to follow. As this is a bit field, you cannot interpret flags by decoding the hex value and looking at the resulting number. For example, a flag 00000001 could be encoded as 01 in hex, or 09 in hex if present with the flag 00001000. A common mistake in bit fields is forgetting to mask when interpreting flags.\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "traceFlags: "
+                  "text": "traceFlags?: "
                 },
                 {
                   "kind": "Content",
@@ -13986,7 +13610,7 @@
                   "text": ";"
                 }
               ],
-              "isOptional": false,
+              "isOptional": true,
               "releaseTag": "Public",
               "name": "traceFlags",
               "propertyTypeTokenRange": {
@@ -13996,12 +13620,12 @@
             },
             {
               "kind": "PropertySignature",
-              "canonicalReference": "@microsoft/applicationinsights-common!ITraceParent#traceId:member",
-              "docComment": "/**\n * This is the ID of the whole trace forest and is used to uniquely identify a distributed trace through a system. It is represented as a 32-character string of lowercase hexadecimal characters, for example, 4bf92f3577b34da6a3ce929d0e0e4736. All characters as zero (00000000000000000000000000000000) is considered an invalid value.\n */\n",
+              "canonicalReference": "@microsoft/applicationinsights-common!ITelemetryTrace#traceID:member",
+              "docComment": "/**\n * Trace id\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "traceId: "
+                  "text": "traceID?: "
                 },
                 {
                   "kind": "Content",
@@ -14012,9 +13636,9 @@
                   "text": ";"
                 }
               ],
-              "isOptional": false,
+              "isOptional": true,
               "releaseTag": "Public",
-              "name": "traceId",
+              "name": "traceID",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
                 "endIndex": 2
@@ -14022,25 +13646,26 @@
             },
             {
               "kind": "PropertySignature",
-              "canonicalReference": "@microsoft/applicationinsights-common!ITraceParent#version:member",
-              "docComment": "/**\n * The version of the definition, this MUST be a string with a length of 2 and only contain lowercase hexadecimal characters. A value of 'ff' is considered to be an invalid version.\n */\n",
+              "canonicalReference": "@microsoft/applicationinsights-common!ITelemetryTrace#traceState:member",
+              "docComment": "/**\n * @deprecated\n *\n * Never Used Trace state\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "version: "
+                  "text": "traceState?: "
                 },
                 {
-                  "kind": "Content",
-                  "text": "string"
+                  "kind": "Reference",
+                  "text": "ITraceState",
+                  "canonicalReference": "@microsoft/applicationinsights-common!ITraceState:interface"
                 },
                 {
                   "kind": "Content",
                   "text": ";"
                 }
               ],
-              "isOptional": false,
+              "isOptional": true,
               "releaseTag": "Public",
-              "name": "version",
+              "name": "traceState",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
                 "endIndex": 2
@@ -17765,51 +17390,6 @@
           ],
           "name": "parseConnectionString"
         },
-        {
-          "kind": "Function",
-          "canonicalReference": "@microsoft/applicationinsights-common!parseTraceParent:function(1)",
-          "docComment": "/**\n * Attempt to parse the provided string as a W3C TraceParent header value (https://www.w3.org/TR/trace-context/#traceparent-header)\n *\n * @param value - \n *\n * @returns \n */\n",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "export declare function parseTraceParent(value: "
-            },
-            {
-              "kind": "Content",
-              "text": "string"
-            },
-            {
-              "kind": "Content",
-              "text": "): "
-            },
-            {
-              "kind": "Reference",
-              "text": "ITraceParent",
-              "canonicalReference": "@microsoft/applicationinsights-common!ITraceParent:interface"
-            },
-            {
-              "kind": "Content",
-              "text": ";"
-            }
-          ],
-          "returnTypeTokenRange": {
-            "startIndex": 3,
-            "endIndex": 4
-          },
-          "releaseTag": "Public",
-          "overloadIndex": 1,
-          "parameters": [
-            {
-              "parameterName": "value",
-              "parameterTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              },
-              "isOptional": false
-            }
-          ],
-          "name": "parseTraceParent"
-        },
         {
           "kind": "Variable",
           "canonicalReference": "@microsoft/applicationinsights-common!ProcessLegacy:var",