@microsoft/applicationinsights-properties-js 3.4.0-nightlybeta3.2505-36 → 3.4.0-nightlybeta3.2507-23

package/types/applicationinsights-properties-js.namespaced.d.ts

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights properties plugin, 3.4.0-nightlybeta3.2505-36
+ * Microsoft Application Insights properties plugin, 3.4.0-nightlybeta3.2507-23
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -29,9 +29,12 @@ declare namespace ApplicationInsights {
          */
         processNext: (env: ITelemetryItem, itemCtx: IProcessTelemetryContext) => void;
         /**
-         * Set next extension for telemetry processing
+         * Set next extension for telemetry processing, this is now optional as plugins should use the
+         * processNext() function of the passed IProcessTelemetryContext instead. It is being kept for
+         * now for backward compatibility only.
+         * @deprecated - Use processNext() function of the passed IProcessTelemetryContext instead
          */
-        setNextPlugin: (next: ITelemetryPlugin | ITelemetryPluginChain) => void;
+        setNextPlugin?: (next: ITelemetryPlugin | ITelemetryPluginChain) => void;
         /**
          * Returns the current diagnostic logger that can be used to log issues, if no logger is currently
          * assigned a new default one will be created and returned.
@@ -129,17 +132,78 @@ declare namespace ApplicationInsights {
 
     const enum eDistributedTracingModes {
         /**
-         * (Default) Send Application Insights correlation headers
+         * Send only the legacy Application Insights correlation headers
+         *
+         * Headers Sent:
+         * - `Request-Id` (Legacy Application Insights header for older Server side SDKs)
+         *
+         * Config Decimal Value: `0` (Zero)
          */
         AI = 0,
         /**
-         * Send both W3C Trace Context headers and back-compatibility Application Insights headers
+         * (Default) Send both W3C Trace parent header and back-compatibility Application Insights headers
+         * - `Request-Id`
+         * - [`traceparent`](https://www.w3.org/TR/trace-context/#traceparent-header)
+         *
+         * Config Decimal Value: `1` (One)
          */
         AI_AND_W3C = 1,
         /**
-         * Send W3C Trace Context headers
+         * Send Only the W3C Trace parent header
+         *
+         * Headers Sent:
+         * - [`traceparent`](https://www.w3.org/TR/trace-context/#traceparent-header)
+         *
+         * Config Decimal Value: `2` (Two)
+         */
+        W3C = 2,
+        /**
+         * @internal
+         * Bitwise mask used to separate the base distributed tracing mode from the additional optional
+         * tracing modes.
+         * @since 3.4.0
+         */
+        _BaseMask = 15,
+        /**
+         * @internal
+         * Enabling this bit will send the W3C Trace State header, it is not intended to be used directly
+         * or on its own. The code may assume that if this bit is set, then the W3C Trace Context headers
+         * will also be included.
+         *
+         * Config Decimal Value: `16` (Sixteen in decimal)
+         * @since 3.4.0
+         */
+        _W3CTraceState = 16,
+        /**
+         * Send all of the W3C Trace Context headers and the W3C Trace State headers and back-compatibility
+         * Application Insights headers.
+         *
+         * Currently sent headers:
+         * - `Request-Id` (Legacy Application Insights header for older Server side SDKs)
+         * - [`traceparent`](https://www.w3.org/TR/trace-context/#traceparent-header)
+         * - [`tracestate`](https://www.w3.org/TR/trace-context/#tracestate-header)
+         *
+         * NOTE!: Additional headers may be added as part of a future update should the W3C Trace Context specification be updated
+         * to include additional headers.
+         *
+         * Config Decimal Value: `17` (Seventeen in decimal)
+         * @since 3.4.0
+         */
+        AI_AND_W3C_TRACE = 17,
+        /**
+         * Send all of the W3C Trace Context headers and the W3C Trace State headers.
+         *
+         * Currently sent headers:
+         * - [`traceparent`](https://www.w3.org/TR/trace-context/#traceparent-header)
+         * - [`tracestate`](https://www.w3.org/TR/trace-context/#tracestate-header)
+         *
+         * NOTE!: Additional headers may be added as part of a future update should the W3C Trace Context specification be updated
+         * to include additional headers.
+         *
+         * Config Decimal Value: `18` (Eighteen in decimal)
+         * @since 3.4.0
          */
-        W3C = 2
+        W3C_TRACE = 18
     }
 
     const enum _eInternalMessageId {
@@ -272,6 +336,30 @@ declare namespace ApplicationInsights {
 
     type EnumValue<E = any> = EnumCls<E>;
 
+    /**
+     * Controls how the SDK should look for trace headers (traceparent/tracestate) from the initial page load
+     * The values are bitwise OR'd together to allow for multiple values to be set at once.
+     * @since 3.4.0
+     */
+    const enum eTraceHeadersMode {
+        /**
+         * Don't look for any trace headers
+         */
+        None = 0,
+        /**
+         * Look for traceparent header/meta tag
+         */
+        TraceParent = 1,
+        /**
+         * Look for tracestate header/meta tag
+         */
+        TraceState = 2,
+        /**
+         * Look for both traceparent and tracestate headers/meta tags
+         */
+        All = 3
+    }
+
     const enum FeatureOptInMode {
         /**
          * not set, completely depends on cdn cfg
@@ -414,7 +502,7 @@ declare namespace ApplicationInsights {
          */
         flush(isAsync?: boolean, callBack?: (flushComplete?: boolean) => void, sendReason?: SendRequestReason, cbTimeout?: number): boolean | void;
         /**
-         * Gets the current distributed trace context for this instance if available
+         * Gets the current distributed trace active context for this instance
          * @param createNew - Optional flag to create a new instance if one doesn't currently exist, defaults to true
          */
         getTraceCtx(createNew?: boolean): IDistributedTraceContext | null;
@@ -474,9 +562,12 @@ declare namespace ApplicationInsights {
          */
         getCfg: () => IConfiguration;
         /**
-         * Gets the named extension config
+         * Gets the named extension configuration
+         * @param identifier - The named extension identifier
+         * @param defaultValue - The default value(s) to return if no defined config exists
+         * @param rootOnly - If true, only the look for the configuration in the top level and not in the "extensionConfig"
          */
-        getExtCfg: <T>(identifier: string, defaultValue?: IConfigDefaults<T>) => T;
+        getExtCfg: <T>(identifier: string, defaultValue?: IConfigDefaults<T>, rootOnly?: boolean) => T;
         /**
          * Gets the named config from either the named identifier extension or core config if neither exist then the
          * default value is returned
@@ -1097,7 +1188,7 @@ declare namespace ApplicationInsights {
          * }
          * ```
          *
-         * For more details, see the [Page Unload Events documentation](https://microsoft.github.io/ApplicationInsights-JS/docs/PageUnloadEvents.html).
+         * For more details, see the [Page Unload Events documentation](https://microsoft.github.io/ApplicationInsights-JS/PageUnloadEvents.html).
          */
         disablePageUnloadEvents?: string[];
         /**
@@ -1112,7 +1203,7 @@ declare namespace ApplicationInsights {
          * }
          * ```
          *
-         * For more details, see the [Page Unload Events documentation](https://microsoft.github.io/ApplicationInsights-JS/docs/PageUnloadEvents.html).
+         * For more details, see the [Page Unload Events documentation](https://microsoft.github.io/ApplicationInsights-JS/PageUnloadEvents.html).
          */
         disablePageShowEvents?: string[];
         /**
@@ -1154,6 +1245,25 @@ declare namespace ApplicationInsights {
          * @since 3.3.2
          */
         expCfg?: IExceptionConfig;
+        /**
+         * [Optional] A flag to enable or disable the use of the field redaction for urls.
+         * @defaultValue true
+         */
+        redactUrls?: boolean;
+        /**
+         * [Optional] Additional query parameters to redact beyond the default set.
+         * Use this to specify custom parameters that contain sensitive information.
+         * These will be combined with the default parameters that are redacted.
+         * @defaultValue ["sig", "Signature", "AWSAccessKeyId", "X-Goog-Signature"]
+         * @example ["sig", "Signature", "AWSAccessKeyId", "X-Goog-Signature","auth_token", "api_key", "private_data"]
+         */
+        redactQueryParams?: string[];
+        /**
+         * [Optional] Controls if the SDK should look for the `traceparent` and/or `tracestate` values from
+         * the service timing headers or meta tags from the initial page load.
+         * @defaultValue eTraceHeadersMode.All
+         */
+        traceHdrMode?: eTraceHeadersMode;
     }
 
     interface ICookieMgr {
@@ -1357,8 +1467,13 @@ declare namespace ApplicationInsights {
          */
         getName(): string;
         /**
-         * Sets the current name of the page
+         * Sets the current name of the page, also updates the name for any parent context.
+         * This is used to identify the page in the telemetry data.
+         * @remarks This function updates the current and ALL parent contexts with the new name,
+         * to just update the name of the current context, use the `pageName` property.
          * @param pageName - The name of the page
+         * @deprecated Use the `pageName` property to avoid the side effect of changing the page name of all
+         * parent contexts.
          */
         setName(pageName: string): void;
         /**
@@ -1371,6 +1486,12 @@ declare namespace ApplicationInsights {
          * 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
+         *
+         * @remarks Sets the traceId for the current context AND all parent contexts, if you want to set the traceId
+         * for the current context only, use the `traceId` property.
+         * @param newValue - The traceId to set
+         * @deprecated Use the `traceId` property to avoid the side effect of changing the traceId of all
+         * parent contexts.
          */
         setTraceId(newValue: string): void;
         /**
@@ -1382,6 +1503,12 @@ declare namespace ApplicationInsights {
          * 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
+         *
+         * @remarks Sets the spanId for the current context AND all parent contexts, if you want to set the spanId for
+         * the current context only, use the `spanId` property.
+         * @param newValue - The spanId to set
+         * @deprecated Use the `spanId` property to avoid the side effect of changing the spanId of all
+         * parent contexts.
          */
         setSpanId(newValue: string): void;
         /**
@@ -1390,9 +1517,80 @@ declare namespace ApplicationInsights {
         getTraceFlags(): number | undefined;
         /**
          * https://www.w3.org/TR/trace-context/#trace-flags
+         * @remarks Sets the trace flags for the current context and ALL  parent contexts, if you want to set the trace
+         * flags for the current context only, use the `traceFlags` property.
          * @param newValue - An integer representation of the W3C TraceContext trace-flags.
+         * @deprecated Use the `traceFlags` property to avoid the side effect of changing the traceFlags of all
+         * parent contexts.
          */
         setTraceFlags(newValue?: number): void;
+        /**
+         * Returns the current name of the page
+         * @remarks This function updates the current context only, to update the name of the current and ALL parent contexts,
+         * use the `setName` method.
+         * @default undefined
+         * @since 3.4.0
+         */
+        pageName: string;
+        /**
+         * The current ID of the trace that this span belongs to. It is worldwide unique
+         * with practically sufficient probability by being made as 16 randomly
+         * generated bytes, encoded as a 32 lowercase hex characters corresponding to
+         * 128 bits.
+         * @remarks If you update this value, it will only update for the current context, not the parent context,
+         * if you need to update the current and ALL parent contexts, use the `setTraceId` method.
+         * @since 3.4.0
+         */
+        traceId: string;
+        /**
+         * The ID of the Span. It is globally unique with practically sufficient
+         * probability by being made as 8 randomly generated bytes, encoded as a 16
+         * lowercase hex characters corresponding to 64 bits.
+         * If you update this value, it will only update for the current context, not the parent context.
+         * @remarks If you update this value, it will only update for the current context, not the parent context,
+         * if you need to update the current and ALL parent contexts, use the `setSpanId` method.
+         * @since 3.4.0
+         */
+        spanId: string;
+        /**
+         * Returns true if the current context was initialized (propagated) from a remote parent.
+         * @since 3.4.0
+         * @default false
+         * @returns True if the context was propagated from a remote parent
+         */
+        readonly isRemote: boolean;
+        /**
+         * Trace flags to propagate.
+         *
+         * It is represented as 1 byte (bitmap). Bit to represent whether trace is
+         * sampled or not. When set, the least significant bit documents that the
+         * caller may have recorded trace data. A caller who does not record trace
+         * data out-of-band leaves this flag unset.
+         *
+         * see {@link eW3CTraceFlags} for valid flag values.
+         *
+         * @remarks If you update this value, it will only update for the current context, not the parent context,
+         * if you need to update the current and ALL parent contexts, use the `setTraceFlags` method.
+         * @since 3.4.0
+         */
+        traceFlags?: number;
+        /**
+         * Returns the current trace state which will be used to propgate context across different services.
+         * Updating (adding / removing keys) of the trace state will modify the current context.
+         * @remarks Unlike the OpenTelemetry {@link TraceState}, this value is a mutable object, so you can
+         * modify it directly you do not need to reassign the new value to this property.
+         * @since 3.4.0
+         */
+        readonly traceState: IW3cTraceState;
+        /**
+         * Provides access to the parent context of the current context.
+         * @remarks This is a read-only property, you cannot modify the parent context directly, you can only
+         * modify the current context. If you need to modify the parent context, you need to do it through the
+         * current context using the `setTraceId`, `setSpanId`, `setTraceFlags` and `setName` methods.
+         * @default null
+         * @since 3.4.0
+         */
+        readonly parentCtx?: IDistributedTraceContext | null;
     }
 
     /**
@@ -2121,23 +2319,6 @@ declare namespace ApplicationInsights {
         finally(onfinally?: FinallyPromiseHandler): IPromise<T>;
     }
 
-    interface IPropertiesConfig {
-        readonly accountId: string;
-        readonly sessionRenewalMs: number;
-        readonly samplingPercentage: number;
-        readonly sessionExpirationMs: number;
-        readonly cookieDomain: string;
-        readonly sdkExtension: string;
-        readonly isBrowserLinkTrackingEnabled: boolean;
-        readonly appId: string;
-        readonly getSessionId: string;
-        readonly namePrefix: string;
-        readonly sessionCookiePostfix: string;
-        readonly userCookiePostfix: string;
-        readonly idLength: number;
-        readonly getNewId: (idLength?: number) => string;
-    }
-
     interface IPropertiesPlugin {
         readonly context: ITelemetryContext;
     }
@@ -2252,6 +2433,8 @@ declare namespace ApplicationInsights {
         readonly location: ILocation;
         /**
          * The object describing a operation tracked by this object.
+         * @deprecated Use the core getTraceCtx method instead to get / set the current trace context, this is required to
+         * support distributed tracing and allows the core to manage the trace context.
          */
         readonly telemetryTrace: ITelemetryTrace;
         /**
@@ -2339,9 +2522,10 @@ declare namespace ApplicationInsights {
      */
     interface ITelemetryPlugin extends ITelemetryProcessor, IPlugin {
         /**
-         * Set next extension for telemetry processing, this is not optional as plugins should use the
+         * Set next extension for telemetry processing, this is now optional as plugins should use the
          * processNext() function of the passed IProcessTelemetryContext instead. It is being kept for
          * now for backward compatibility only.
+         * @deprecated - Use processNext() function of the passed IProcessTelemetryContext instead
          */
         setNextPlugin?: (next: ITelemetryPlugin | ITelemetryPluginChain) => void;
         /**
@@ -2391,6 +2575,11 @@ declare namespace ApplicationInsights {
         update?: (updateCtx: IProcessTelemetryUpdateContext, updateState: ITelemetryUpdateState) => void | boolean;
     }
 
+    /**
+     * Interface for telemetry trace context.
+     * @deprecated Use the core getTraceCtx method instead to get / set the current trace context, this is required to
+     * support distributed tracing and allows the core to manage the trace context.
+     */
     interface ITelemetryTrace {
         /**
          * Trace id
@@ -2400,11 +2589,6 @@ declare namespace ApplicationInsights {
          * Parent id
          */
         parentID?: string;
-        /**
-         * @deprecated Never Used
-         * Trace state
-         */
-        traceState?: ITraceState;
         /**
          * An integer representation of the W3C TraceContext trace-flags. https://www.w3.org/TR/trace-context/#trace-flags
          */
@@ -2628,9 +2812,6 @@ declare namespace ApplicationInsights {
         enabled: boolean;
     }
 
-    interface ITraceState {
-    }
-
     /**
      * An interface which provides automatic removal during unloading of the component
      */
@@ -2691,6 +2872,76 @@ declare namespace ApplicationInsights {
         update(userId?: string): void;
     }
 
+    /**
+     * Represents a mutable [W3C trace state list](https://www.w3.org/TR/trace-context/#tracestate-header), this is a
+     * list of key/value pairs that are used to pass trace state information between different tracing systems. The
+     * list is ordered and the order is important as it determines the processing order.
+     *
+     * Importantly instances of this type are mutable, change made to an instance via {@link IW3cTraceState.set} or
+     * {@link IW3cTraceState.del} will be reflected on the instance and any child instances that use it as a parent.
+     * However, any parent instance associated with an instance will not be modified by operations on that particular
+     * instance.
+     *
+     * @since 3.4.0
+     */
+    interface IW3cTraceState {
+        /**
+         * Returns a readonly array of the current keys associated with the trace state, keys are returned in the
+         * required processing order and if this instance has a parent the keys from the parent will be included
+         * unless they have been removed (deleted) from the child instance.
+         * Once created any modifications to the parent will also be reflected in the child, this is different from
+         * the OpenTelemetry implementation which creates a new instance for each call.
+         * @returns A readonly array of the current keys associated with the trace state
+         */
+        readonly keys: string[];
+        /**
+         * Check if the trace state list is empty, meaning it has no keys or values.
+         * This exists to allow for quick checks without needing to create a new array of keys.
+         * @since 3.4.0
+         * @returns true if the trace state list is empty, false otherwise
+         */
+        readonly isEmpty: boolean;
+        /**
+         * Get the value for the specified key that is associated with this instance, either directly or from the parent.
+         * @param key - The key to lookup
+         * @returns The value for the key, or undefined if not found
+         */
+        get(key: string): string | undefined;
+        /**
+         * Set the value for the specified key for this instance, returning its new location within the list.
+         * - 0 is the front of the list
+         * - -1 not set because the key/value pair is invalid
+         * If the key already exists it will be removed from its current location and added to the front of the list. And
+         * if the key was in the parent this will override the value inherited from the parent, more importantly it will
+         * not modify the parent value.
+         * @param key - The key to set
+         * @param value - The value to set
+         * @returns 0 if successful, -1 if not
+         */
+        set(key: string, value: string): number;
+        /**
+         * Delete the specified key from this instance, if the key was in the parent it will be removed (hidden) from
+         * this instance but will still be available directly from the parent.
+         * @param key - The key to delete
+         */
+        del(key: string): void;
+        /**
+         * Format the trace state list into a strings where each string can be used as a header value.
+         * This will return an empty array if the trace state list is empty.
+         * @param maxHeaders - The maximum number of entries to include in the output, once the limit is reached no more entries will be included
+         * @param maxKeys - The maximum number of keys to include in the output, once the limit is reached no more keys will be included
+         * @param maxLen - The maximum length of each header value, once the limit is reached a new header value will be created
+         * @returns An array of strings that can be used for the header values, if the trace state list is empty an empty array will be returned
+         */
+        hdrs(maxHeaders?: number, maxKeys?: number, maxLen?: number): string[];
+        /**
+         * Create a new instance of IW3cTraceState which is a child of this instance, meaning it will inherit the keys
+         * and values from this instance but any changes made to the child will not affect this instance.
+         * @returns A new instance of IW3cTraceState which is a child of this instance
+         */
+        child(): IW3cTraceState;
+    }
+
     interface IWatchDetails<T = IConfiguration> {
         /**
          * The current config object
@@ -2867,43 +3118,8 @@ declare namespace ApplicationInsights {
         [key: string]: any;
     }
 
-    class TelemetryContext implements IPropTelemetryContext {
-        application: IApplication;
-        device: IDevice;
-        location: ILocation;
-        telemetryTrace: ITelemetryTrace;
-        user: IUserContext;
-        internal: IInternal;
-        session: ISession;
-        sessionManager: ISessionManager;
-        os: IOperatingSystem;
-        web: IWeb;
-        appId: () => string;
-        getSessionId: () => string;
-        constructor(core: IAppInsightsCore, defaultConfig: IPropertiesConfig, previousTraceCtx?: IDistributedTraceContext, unloadHookContainer?: IUnloadHookContainer);
-        applySessionContext(evt: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
-        applyOperatingSystemContxt(event: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
-        applyApplicationContext(event: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
-        applyDeviceContext(event: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
-        applyInternalContext(event: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
-        applyLocationContext(event: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
-        applyOperationContext(event: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
-        applyWebContext(event: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
-        applyUserContext(event: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
-        cleanUp(event: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
-    }
-
     type TelemetryInitializerFunction = <T extends ITelemetryItem>(item: T) => boolean | void;
 
-    class TelemetryTrace implements ITelemetryTrace {
-        traceID: string;
-        parentID: string;
-        traceState: ITraceState;
-        traceFlags: number;
-        name: string;
-        constructor(id?: string, parentId?: string, name?: string, logger?: IDiagnosticLogger);
-    }
-
     /**
      * The TelemetryUnloadReason enumeration contains the possible reasons for why a plugin is being unloaded / torndown().
      */