@microsoft/1ds-core-js 4.4.0-nightlybeta3.2505-36 → 4.4.0-nightlybeta3.2507-22

package/types/1ds-core-js.namespaced.d.ts

@@ -1,5 +1,5 @@
 /*
- * 1DS JS SDK Core, 4.4.0-nightlybeta3.2505-36
+ * 1DS JS SDK Core, 4.4.0-nightlybeta3.2507-22
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -385,9 +385,12 @@ declare namespace oneDS {
          */
         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.
@@ -935,6 +938,30 @@ declare namespace oneDS {
 
     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
+    }
+
     /**
      * The TraceLevel contains a set of values that specify the trace level for the trace messages.
      */
@@ -1181,6 +1208,14 @@ declare namespace oneDS {
         enable = 3
     }
 
+    /**
+     * Redacts sensitive information from a URL string, including credentials and specific query parameters.
+     * @param input - The URL string to be redacted.
+     * @param config - Configuration object that contain redactUrls setting.
+     * @returns The redacted URL string or the original string if no redaction was needed or possible.
+     */
+    function fieldRedaction(input: string, config: IConfiguration): string;
+
     type FieldValueSanitizerFunc = (details: IFieldSanitizerDetails) => IEventProperty | null;
 
     const enum FieldValueSanitizerType {
@@ -1623,7 +1658,7 @@ declare namespace oneDS {
          */
         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;
@@ -1691,9 +1726,12 @@ declare namespace oneDS {
          */
         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
@@ -1989,7 +2027,7 @@ declare namespace oneDS {
          * }
          * ```
          *
-         * 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[];
         /**
@@ -2004,7 +2042,7 @@ declare namespace oneDS {
          * }
          * ```
          *
-         * 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[];
         /**
@@ -2046,6 +2084,25 @@ declare namespace oneDS {
          * @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 {
@@ -2226,8 +2283,13 @@ declare namespace oneDS {
          */
         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;
         /**
@@ -2240,6 +2302,12 @@ declare namespace oneDS {
          * 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;
         /**
@@ -2251,6 +2319,12 @@ declare namespace oneDS {
          * 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;
         /**
@@ -2259,9 +2333,80 @@ declare namespace oneDS {
         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;
     }
 
     /**
@@ -2960,12 +3105,21 @@ declare namespace oneDS {
          * @param callBack - if specified, notify caller when send is complete, the channel should return true to indicate to the caller that it will be called.
          * If the caller doesn't return true the caller should assume that it may never be called.
          * @param sendReason - specify the reason that you are calling "flush" defaults to ManualFlush (1) if not specified
-         * @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
+         * @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
+         * Gets the current distributed trace context for this instance if available, you can optional
+         * create a new instance if one does not currently exist or return null if one does not currently exist.
+         * When a server context is available it will be used as the parent context for the any new instance created
+         * (when createNew is true or no instance currently exists), calling this function will not
+         * change the current distributed trace context, it will only return the current context
+         * or create a new instance if one does not currently exist.
+         * @param createNew - Optional flag to create a new instance if one doesn't currently exist, defaults to
+         * undefined which will only create a new instance if one does not currently exist.
+         * If set to `false` then it will return null if no distributed trace context is available.
+         * If set to `true` then a new instance will be created even if one already exists.
+         * @param createNew - Optional flag to create a new instance if one doesn't currently exist, defaults to
          */
         getTraceCtx(createNew?: boolean): IDistributedTraceContext | null;
         /**
@@ -3988,9 +4142,10 @@ declare namespace oneDS {
      */
     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;
         /**
@@ -4320,6 +4475,76 @@ declare namespace oneDS {
         property: (path: string, name: string, property: IEventProperty, stringifyObjects?: boolean) => IEventProperty | null;
     }
 
+    /**
+     * 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
@@ -5266,7 +5491,7 @@ declare namespace oneDS {
         constructor(fieldSanitizerProvider?: IFieldValueSanitizerProvider);
     }
 
-    const Version = "4.4.0-nightlybeta3.2505-36";
+    const Version = "4.4.0-nightlybeta3.2507-22";
 
     /**
      * This is a helper method which will call warnToConsole on the passed logger with the provided message.