@microsoft/applicationinsights-web-basic 2.8.4-nightly.2205-08 → 2.8.4

package/dist/applicationinsights-web-basic.api.json

@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "7.24.0",
+    "toolVersion": "7.24.2",
     "schemaVersion": 1005,
     "oldestForwardsCompatibleVersion": 1001,
     "tsdocConfig": {
@@ -3716,6 +3716,56 @@
               "parameters": [],
               "name": "getProcessTelContext"
             },
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "@microsoft/applicationinsights-web-basic!IAppInsightsCore#getTraceCtx:member(1)",
+              "docComment": "/**\n * Gets the current distributed trace context for this instance if available\n *\n * @param createNew - Optional flag to create a new instance if one doesn't currently exist, defaults to true\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "getTraceCtx(createNew?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "IDistributedTraceContext",
+                  "canonicalReference": "@microsoft/applicationinsights-web-basic!IDistributedTraceContext:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | null"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 5
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "createNew",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": true
+                }
+              ],
+              "name": "getTraceCtx"
+            },
             {
               "kind": "MethodSignature",
               "canonicalReference": "@microsoft/applicationinsights-web-basic!IAppInsightsCore#getTransmissionControls:member(1)",
@@ -4040,6 +4090,56 @@
               ],
               "name": "setCookieMgr"
             },
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "@microsoft/applicationinsights-web-basic!IAppInsightsCore#setTraceCtx:member(1)",
+              "docComment": "/**\n * Sets the current distributed trace context for this instance if available\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "setTraceCtx(newTraceCtx: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "IDistributedTraceContext",
+                  "canonicalReference": "@microsoft/applicationinsights-web-basic!IDistributedTraceContext:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | null | undefined"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 4,
+                "endIndex": 5
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "newTraceCtx",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 3
+                  },
+                  "isOptional": false
+                }
+              ],
+              "name": "setTraceCtx"
+            },
             {
               "kind": "MethodSignature",
               "canonicalReference": "@microsoft/applicationinsights-web-basic!IAppInsightsCore#stopPollingInternalLogs:member(1)",

package/dist/applicationinsights-web-basic.api.md

@@ -255,6 +255,8 @@ export interface IAppInsightsCore extends IPerfManagerProvider {
     getPlugin<T extends IPlugin = IPlugin>(pluginIdentifier: string): ILoadedPlugin<T>;
     // Warning: (ae-forgotten-export) The symbol "IProcessTelemetryContext" needs to be exported by the entry point index.d.ts
     getProcessTelContext(): IProcessTelemetryContext;
+    // Warning: (ae-forgotten-export) The symbol "IDistributedTraceContext" needs to be exported by the entry point index.d.ts
+    getTraceCtx(createNew?: boolean): IDistributedTraceContext | null;
     // Warning: (ae-forgotten-export) The symbol "IChannelControls" needs to be exported by the entry point index.d.ts
     //
     // (undocumented)
@@ -268,6 +270,7 @@ export interface IAppInsightsCore extends IPerfManagerProvider {
     pollInternalLogs?(eventName?: string): number;
     removeNotificationListener?(listener: INotificationListener): void;
     setCookieMgr(cookieMgr: ICookieMgr): void;
+    setTraceCtx(newTraceCtx: IDistributedTraceContext | null | undefined): void;
     // (undocumented)
     stopPollingInternalLogs?(): void;
     // (undocumented)

package/dist/applicationinsights-web-basic.d.ts

@@ -1,5 +1,5 @@
 /*
- * Microsoft.ApplicationInsights, 2.8.4-nightly.2205-08
+ * Microsoft.ApplicationInsights, 2.8.4
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -178,6 +178,15 @@ declare namespace ApplicationInsights {
          * @returns - true if the callback will be return after the flush is complete otherwise the caller should assume that any provided callback will never be called
          */
         flush(isAsync?: boolean, callBack?: (flushComplete?: boolean) => void, sendReason?: SendRequestReason): void;
+        /**
+         * Gets the current distributed trace context for this instance if available
+         * @param createNew - Optional flag to create a new instance if one doesn't currently exist, defaults to true
+         */
+        getTraceCtx(createNew?: boolean): IDistributedTraceContext | null;
+        /**
+         * Sets the current distributed trace context for this instance if available
+         */
+        setTraceCtx(newTracectx: IDistributedTraceContext): void;
         protected releaseQueue(): void;
         /**
          * Hook for Core extensions to allow them to update their own configuration before updating all of the plugins.
@@ -517,6 +526,15 @@ declare namespace ApplicationInsights {
          * @returns - true if the callback will be return after the flush is complete otherwise the caller should assume that any provided callback will never be called
          */
         flush(isAsync?: boolean, callBack?: (flushComplete?: boolean) => void, sendReason?: SendRequestReason, cbTimeout?: number): boolean | void;
+        /**
+         * Gets the current distributed trace context for this instance if available
+         * @param createNew - Optional flag to create a new instance if one doesn't currently exist, defaults to true
+         */
+        getTraceCtx(createNew?: boolean): IDistributedTraceContext | null;
+        /**
+         * Sets the current distributed trace context for this instance if available
+         */
+        setTraceCtx(newTraceCtx: IDistributedTraceContext | null | undefined): void;
     }
 
     /**
@@ -1493,6 +1511,50 @@ declare namespace ApplicationInsights {
         logInternalMessage?(severity: LoggingSeverity, message: _InternalLogMessage): void;
     }
 
+    interface IDistributedTraceContext {
+        /**
+         * Returns the current name of the page
+         */
+        getName(): string;
+        /**
+         * Sets the current name of the page
+         * @param pageName
+         */
+        setName(pageName: string): void;
+        /**
+         * Returns the unique identifier for a trace. All requests / spans from the same trace share the same traceId.
+         * Must be read from incoming headers or generated according to the W3C TraceContext specification,
+         * in a hex representation of 16-byte array. A.k.a. trace-id, TraceID or Distributed TraceID
+         */
+        getTraceId(): string;
+        /**
+         * Set the unique identifier for a trace. All requests / spans from the same trace share the same traceId.
+         * Must be conform to the W3C TraceContext specification, in a hex representation of 16-byte array.
+         * A.k.a. trace-id, TraceID or Distributed TraceID https://www.w3.org/TR/trace-context/#trace-id
+         */
+        setTraceId(newValue: string): void;
+        /**
+         * Self-generated 8-bytes identifier of the incoming request. Must be a hex representation of 8-byte array.
+         * Also know as the parentId, used to link requests together
+         */
+        getSpanId(): string;
+        /**
+         * Self-generated 8-bytes identifier of the incoming request. Must be a hex representation of 8-byte array.
+         * Also know as the parentId, used to link requests together
+         * https://www.w3.org/TR/trace-context/#parent-id
+         */
+        setSpanId(newValue: string): void;
+        /**
+         * An integer representation of the W3C TraceContext trace-flags.
+         */
+        getTraceFlags(): number | undefined;
+        /**
+         * https://www.w3.org/TR/trace-context/#trace-flags
+         * @param newValue
+         */
+        setTraceFlags(newValue?: number): void;
+    }
+
     interface IEnvelope extends ISerializable {
         /**
          * Envelope version. For internal use only. By assigning this the default, it will not be serialized within the payload unless changed to a value other than #1.