@microsoft/applicationinsights-core-js 3.4.0-nightlybeta3.2602-27 → 3.4.1

package/types/applicationinsights-core-js.d.ts

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights Core Javascript SDK, 3.4.0-nightlybeta3.2602-27
+ * Microsoft Application Insights Core Javascript SDK, 3.4.1
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -431,6 +431,25 @@ export declare class AppInsightsCore<CfgType extends IConfiguration = IConfigura
     protected _updateHook?(updateCtx: IProcessTelemetryUpdateContext, updateState: ITelemetryUpdateState): void | boolean;
 }
 
+/**
+ * @group Classes
+ * @group Entrypoint
+ */
+export declare class AppInsightsExtCore<C extends IExtendedConfiguration = IExtendedConfiguration> extends AppInsightsCore<C> {
+    constructor();
+    /**
+     * Initialize the sdk.
+     * @param config - The configuration to initialize the SDK.
+     * @param extensions - An array of extensions that are to be used by the core.
+     */
+    initialize(config: C, extensions: IPlugin[], logger?: IDiagnosticLogger, notificationManager?: INotificationManager): void;
+    track(item: IExtendedTelemetryItem | ITelemetryItem): void;
+    /**
+     * Periodically check logger.queue for
+     */
+    pollInternalLogs(eventName?: string): ITimerHandler;
+}
+
 export declare const ApplicationInsightsAvailabilityBaseType = "AvailabilityData";
 
 export declare const ApplicationInsightsAvailabilityName: string;
@@ -1008,6 +1027,24 @@ export declare const createEnumStyle: <E>(values: {
     [key in keyof E]: E[keyof E];
 }) => EnumValue<E>;
 
+/**
+ * Create an extended common schema telemetry item from the provided span
+ * @param core - The app insights core instance
+ * @param span - The span to create the telemetry item from
+ * @returns A new extended telemetry item or null if the span kind is not supported
+ */
+export declare function createExtendedTelemetryItemFromSpan(core: IAppInsightsCore, span: IReadableSpan): IExtendedTelemetryItem | null;
+
+/**
+ * Create a new guid.
+ * @param style - The style of guid to generated, defaults to Digits
+ * Digits (Default) : 32 digits separated by hyphens: 00000000-0000-0000-0000-000000000000
+ * Braces - 32 digits separated by hyphens, enclosed in braces: \{00000000-0000-0000-0000-000000000000\}
+ * Parentheses - 32 digits separated by hyphens, enclosed in parentheses: (00000000-0000-0000-0000-000000000000)
+ * Numeric - 32 digits: 00000000000000000000000000000000
+ */
+export declare function createGuid(style?: GuidStyle): string;
+
 /**
  * Return a non-recording span based on the provided spanContext using the otelApi instance as the
  * owning instance.
@@ -1580,6 +1617,22 @@ export declare const enum eDistributedTracingModes {
     W3C_TRACE = 18
 }
 
+/**
+ * Enum for property types.
+ */
+export declare const enum eEventPropertyType {
+    Unspecified = 0,
+    String = 1,
+    Int32 = 2,
+    UInt32 = 3,
+    Int64 = 4,
+    UInt64 = 5,
+    Double = 6,
+    Bool = 7,
+    Guid = 8,
+    DateTime = 9
+}
+
 /**
  * The eEventsDiscardedReason enumeration contains a set of values that specify the reason for discarding an event.
  */
@@ -1614,6 +1667,29 @@ export declare const enum eEventsDiscardedReason {
     BeaconSendFailure = 6
 }
 
+export declare const enum _eExtendedInternalMessageId {
+    AuthHandShakeError = 501,
+    AuthRedirectFail = 502,
+    BrowserCannotReadLocalStorage = 503,
+    BrowserCannotWriteLocalStorage = 504,
+    BrowserDoesNotSupportLocalStorage = 505,
+    CannotParseBiBlobValue = 506,
+    CannotParseDataAttribute = 507,
+    CVPluginNotAvailable = 508,
+    DroppedEvent = 509,
+    ErrorParsingAISessionCookie = 510,
+    ErrorProvidedChannels = 511,
+    FailedToGetCookies = 512,
+    FailedToInitializeCorrelationVector = 513,
+    FailedToInitializeSDK = 514,
+    InvalidContentBlob = 515,
+    InvalidCorrelationValue = 516,
+    SessionRenewalDateIsZero = 517,
+    SendPostOnCompleteFailure = 518,
+    PostResponseHandler = 519,
+    SDKNotInitialized = 520
+}
+
 export declare const enum _eInternalMessageId {
     BrowserDoesNotSupportLocalStorage = 0,
     BrowserCannotReadLocalStorage = 1,
@@ -1886,6 +1962,136 @@ export declare const enum eTraceHeadersMode {
     All = 3
 }
 
+/**
+ * The TraceLevel contains a set of values that specify the trace level for the trace messages.
+ */
+export declare const enum eTraceLevel {
+    /**
+     * None.
+     */
+    NONE = 0,
+    /**
+     * Error trace.
+     */
+    ERROR = 1,
+    /**
+     * Warning trace.
+     */
+    WARNING = 2,
+    /**
+     * Information trace.
+     */
+    INFORMATION = 3
+}
+
+/**
+ * Controls how the user can configure which parts of the URL should be redacted. Example, certain query parameters, username and password, etc.
+ */
+export declare const enum eUrlRedactionOptions {
+    /**
+     * The default value, will redact the username and password as well as the default set of query parameters
+     */
+    true = 1,
+    /**
+     * Does not redact username and password or any query parameters, the URL will be left as is. Note: this is not recommended as it may lead
+     * to sensitive data being sent in clear text.
+     */
+    false = 2,
+    /**
+     * This will append any additional queryParams that the user has provided through redactQueryParams config to the default set i.e to
+     * @defaultValue ["sig", "Signature", "AWSAccessKeyId", "X-Goog-Signature"].
+     */
+    appendToDefault = 3,
+    /**
+     * This will replace the default set of query parameters to redact with the query parameters defined in redactQueryParams config, if provided by the user.
+     */
+    replaceDefault = 4,
+    /**
+     * This will redact username and password in the URL but will not redact any query parameters, even those in the default set.
+     */
+    usernamePasswordOnly = 5,
+    /**
+     * This will only redact the query parameter in the default set of query parameters to redact. It will not redact username and password.
+     */
+    queryParamsOnly = 6
+}
+
+/**
+ * The eValueKind contains a set of values that specify value kind of the property.
+ * Either PII (Personal Identifiable Information) or customer content.
+ */
+export declare const enum eValueKind {
+    /**
+     * No kind.
+     */
+    NotSet = 0,
+    /**
+     * An LDAP distinguished name. For example, CN=Jeff Smith,OU=Sales,DC=Fabrikam,DC=COM.
+     */
+    Pii_DistinguishedName = 1,
+    /**
+     * Generic information.
+     */
+    Pii_GenericData = 2,
+    /**
+     * An IPV4 Internet address. For example, 192.0.2.1.
+     */
+    Pii_IPV4Address = 3,
+    /**
+     * An IPV6 Internet address. For example, 2001:0db8:85a3:0000:0000:8a2e:0370:7334.
+     */
+    Pii_IPv6Address = 4,
+    /**
+     * The Subject of an e-mail message.
+     */
+    Pii_MailSubject = 5,
+    /**
+     * A telephone number.
+     */
+    Pii_PhoneNumber = 6,
+    /**
+     * A query string.
+     */
+    Pii_QueryString = 7,
+    /**
+     * An SIP (Session Internet Protocol) address.
+     */
+    Pii_SipAddress = 8,
+    /**
+     * An e-mail address.
+     */
+    Pii_SmtpAddress = 9,
+    /**
+     * An user ID.
+     */
+    Pii_Identity = 10,
+    /**
+     * A URI (Uniform Resource Identifier).
+     */
+    Pii_Uri = 11,
+    /**
+     * The fully-qualified domain name.
+     */
+    Pii_Fqdn = 12,
+    /**
+     * Scrubs the last octet in a IPV4 Internet address.
+     * For example: 10.121.227.147 becomes 10.121.227.*
+     */
+    Pii_IPV4AddressLegacy = 13,
+    /**
+     * Scrubs the last 4 Hextets (last 64-bits) of an IPv6 address
+     */
+    Pii_IPv6ScrubLastHextets = 14,
+    /**
+     * Drops the value altogether, rather than hashing
+     */
+    Pii_DropValue = 15,
+    /**
+     * Generic content.
+     */
+    CustomerContent_GenericContent = 32
+}
+
 declare class Event_2 implements IEventData, ISerializable {
     /**
      * @deprecated Use the constant EventEnvelopeType instead.
@@ -1928,6 +2134,36 @@ export declare const EventDataType = "EventData";
 
 export declare const EventEnvelopeType: string;
 
+/**
+ * The EventLatency contains a set of values that specify the latency with which an event is sent.
+ */
+export declare const EventLatency: EnumValue<typeof EventLatencyValue>;
+
+export declare type EventLatency = number | EventLatencyValue;
+
+/**
+ * The EventLatency contains a set of values that specify the latency with which an event is sent.
+ */
+export declare const enum EventLatencyValue {
+    /**
+     * Normal latency.
+     */
+    Normal = 1,
+    /**
+     * Cost deferred latency. At the moment this latency is treated as Normal latency.
+     */
+    CostDeferred = 2,
+    /**
+     * Real time latency.
+     */
+    RealTime = 3,
+    /**
+     * Bypass normal batching/timing and send as soon as possible, this will still send asynchronously.
+     * Added in v3.1.1
+     */
+    Immediate = 4
+}
+
 /**
  * Removes an event handler for the specified event
  * @param Object - to remove the event from
@@ -1963,9 +2199,9 @@ export declare const EventPersistence: EnumValue<typeof EventPersistenceValue>;
 export declare type EventPersistence = number | EventPersistenceValue;
 
 /**
- * The EventPersistence contains a set of values that specify the event's persistence.
+ * The EventPersistenceValue contains a set of values that specify the event's persistence.
  */
-declare const enum EventPersistenceValue {
+export declare const enum EventPersistenceValue {
     /**
      * Normal persistence.
      */
@@ -1976,6 +2212,13 @@ declare const enum EventPersistenceValue {
     Critical = 2
 }
 
+/**
+ * Enum for property types.
+ */
+export declare const EventPropertyType: EnumValue<typeof eEventPropertyType>;
+
+export declare type EventPropertyType = number | eEventPropertyType;
+
 /**
  * The EventsDiscardedReason enumeration contains a set of values that specify the reason for discarding an event.
  */
@@ -1983,6 +2226,34 @@ export declare const EventsDiscardedReason: EnumValue<typeof eEventsDiscardedRea
 
 export declare type EventsDiscardedReason = number | eEventsDiscardedReason;
 
+/**
+ * Define a specific way to send an event synchronously
+ */
+export declare const enum EventSendType {
+    /**
+     * Batch and send the event asynchronously, this is the same as either setting the event `sync` flag to false or not setting at all.
+     */
+    Batched = 0,
+    /**
+     * Attempt to send the event synchronously, this is the same as setting the event `sync` flag to true
+     */
+    Synchronous = 1,
+    /**
+     * Attempt to send the event synchronously with a preference for the sendBeacon() API.
+     * As per the specification, the payload of the event (when converted to JSON) must not be larger than 64kb,
+     * the sendHook is also not supported or used when sendBeacon.
+     */
+    SendBeacon = 2,
+    /**
+     * Attempt to send the event synchronously with a preference for the fetch() API with the keepalive flag,
+     * the SDK checks to ensure that the fetch() implementation supports the 'keepalive' flag and if not it
+     * will fallback to either sendBeacon() or a synchronous XHR request.
+     * As per the specification, the payload of the event (when converted to JSON) must not be larger than 64kb.
+     * Note: Not all browsers support the keepalive flag so for those environments the events may still fail
+     */
+    SyncFetch = 3
+}
+
 /**
  * The TelemetryUpdateReason enumeration contains a set of bit-wise values that specify the reason for update request.
  */
@@ -2067,6 +2338,19 @@ export declare const EXP_ATTR_ENDUSER_PSEUDO_ID: string;
 
 export declare const EXP_ATTR_SYNTHETIC_TYPE = "synthetic.type";
 
+/**
+ * Pass in the objects to merge as arguments.
+ * @param obj1 - object to merge.  Set this argument to 'true' for a deep extend.
+ * @param obj2 - object to merge.
+ * @param obj3 - object to merge.
+ * @param obj4 - object to merge.
+ * @param obj5 - object to merge.
+ * @returns The extended object.
+ */
+export declare function extend(obj?: any, obj2?: any, obj3?: any, obj4?: any, obj5?: any): any;
+
+export declare type _ExtendedInternalMessageId = number | _eExtendedInternalMessageId | _eInternalMessageId;
+
 /**
  * Defines extended attribute values which may contain nested attributes.
  *
@@ -2085,6 +2369,16 @@ export declare const Extensions: {
     SDKExt: string;
 };
 
+/**
+ * Identifies the full version for the extended SDK
+ */
+export declare const ExtFullVersionString: string;
+
+/**
+ * Identifies the version for the extended SDK
+ */
+export declare const ExtVersion = "4.4.1";
+
 export declare const enum FeatureOptInMode {
     /**
      * not set, completely depends on cdn cfg
@@ -2119,6 +2413,20 @@ export declare const enum FieldType {
     Hidden = 4
 }
 
+export declare type FieldValueSanitizerFunc = (details: IFieldSanitizerDetails) => IEventProperty | null;
+
+export declare const enum FieldValueSanitizerType {
+    NotSet = 0,
+    String = 1,
+    Number = 2,
+    Boolean = 3,
+    Object = 4,
+    Array = 4096,
+    EventProperty = 8192
+}
+
+export declare type FieldValueSanitizerTypes = string | number | boolean | object | string[] | number[] | boolean[] | IEventProperty;
+
 /**
  * Find all script tags in the provided document and return the information about them.
  * @param doc - The document to search for script tags
@@ -2190,6 +2498,12 @@ export declare function formatErrorMessageXhr(xhr: XMLHttpRequest, message?: str
  */
 export declare function formatTraceParent(value: ITraceParent): string;
 
+/**
+ * Identifies the full version for the extended SDK (legacy constant)
+ * @deprecated Use {@link ExtFullVersionString} instead
+ */
+export declare const FullVersionString: string;
+
 /**
  * generate W3C trace id
  */
@@ -2201,11 +2515,23 @@ export declare function generateW3CId(): string;
  */
 export declare function _getAllResponseHeaders(xhr: XMLHttpRequest, isOneDs?: boolean): {};
 
+export declare function getCommonSchemaMetaData(value: string | boolean | number | string[] | number[] | boolean[] | undefined, kind: number | undefined, type?: number | undefined): number;
+
 /**
  * Returns the global console object
  */
 export declare function getConsole(): Console | null;
 
+/**
+ * Helper to get and decode the cookie value using decodeURIComponent, this is for historical
+ * backward compatibility where the document.cookie value was decoded before parsing.
+ * @param cookieMgr - The cookie manager to use
+ * @param name - The name of the cookie to get
+ * @param decode - A flag to indicate whether the cookie value should be decoded
+ * @returns The decoded cookie value (if available) otherwise an empty string.
+ */
+export declare function getCookieValue(cookieMgr: ICookieMgr, name: string, decode?: boolean): string;
+
 /**
  * Returns the crypto object if it is present otherwise null.
  * This helper is used to access the crypto object from the current
@@ -2236,6 +2562,12 @@ export declare function getExceptionName(object: any): string;
 
 export declare function getExtensionByName(extensions: IPlugin[], identifier: string): IPlugin | null;
 
+/**
+ * Returns a bitwise value for the FieldValueSanitizerType enum representing the decoded type of the passed value
+ * @param value - The value to determine the type
+ */
+export declare function getFieldValueType(value: any): FieldValueSanitizerType;
+
 /**
  * Get the current global performance manager that will be used with no performance manager is supplied.
  * @returns - The current default manager
@@ -2326,6 +2658,15 @@ export declare function getSetValue<T, K extends keyof T>(target: T, field: K, d
  */
 export declare function getSyntheticType(container: IAttributeContainer): OTelAttributeValue;
 
+/**
+ * Gets the tenant id from the tenant token.
+ * @param apiKey - The token from which the tenant id is to be extracted.
+ * @returns The tenant id.
+ */
+export declare function getTenantId(apiKey: string | undefined): string;
+
+export declare let getTime: typeof perfNow;
+
 /**
  * Get the URL from the attribute container
  * @param container - The attribute container to extract the URL from
@@ -2337,6 +2678,13 @@ export declare function getUserAgent(container: IAttributeContainer): OTelAttrib
 
 export { getWindow }
 
+export declare const enum GuidStyle {
+    Numeric = "N",
+    Digits = "D",
+    Braces = "B",
+    Parentheses = "P"
+}
+
 /**
  * Handle / report an error.
  * When not provided the default is to generally throw an {@link OTelInvalidAttributeError}
@@ -3560,10 +3908,10 @@ export declare interface IConfiguration extends IOTelConfig {
      */
     expCfg?: IExceptionConfig;
     /**
-     * [Optional] A flag to enable or disable the use of the field redaction for urls.
+     * [Optional] A flag to enable or disable redaction for query parameters and username/password.
      * @defaultValue true
      */
-    redactUrls?: boolean;
+    redactUrls?: UrlRedactionOptions;
     /**
      * [Optional] Additional query parameters to redact beyond the default set.
      * Use this to specify custom parameters that contain sensitive information.
@@ -4661,6 +5009,29 @@ export declare interface IEventData extends IDomain {
     measurements: any;
 }
 
+/**
+ * An interface used to create an event property value along with tagging it as PII, or customer content.
+ * <b>Caution:</b> Customer content and PII are mutually exclusive. You can use only one of them at a time.
+ * If you use both, then the property will be considered invalid, and therefore won't be sent.
+ */
+export declare interface IEventProperty {
+    /**
+     * The value for the property.
+     */
+    value: string | number | boolean | string[] | number[] | boolean[];
+    /**
+     * [Optional] The value kind associated with property value. The constant enum ValueKind should be used to specify the
+     * different kinds.
+     */
+    kind?: number;
+    /**
+     * [Optional] The data type for the property. Valid values accepted by onecollector are
+     * "string", "bool", "double", "int64", "datetime", "guid".
+     *  The EventPropertyType constant enum should be used to specify the different property type values.
+     */
+    propertyType?: number;
+}
+
 export declare interface IEventTelemetry extends IPartC {
     /**
      * @description An event name string
@@ -4672,6 +5043,46 @@ export declare interface IEventTelemetry extends IPartC {
     iKey?: string;
 }
 
+/**
+ * An interface used for telemetry event timings.
+ */
+export declare interface IEventTiming {
+    /**
+     * Time when 1DS Core calls track
+     */
+    trackStart?: number;
+    /**
+     * Array of times when each plugin configured in 1DS calls processTelemetry method
+     */
+    processTelemetryStart?: {
+        [key: string]: number;
+    };
+    /**
+     * Array of times when a specific channel tried to send the telemetry to configured endpoint
+     */
+    sendEventStart?: {
+        [key: string]: number;
+    };
+    /**
+     * Array of times when a specific channel received a response from endpoint or request timed out
+     */
+    sendEventCompleted?: {
+        [key: string]: number;
+    };
+    /**
+     * Array of times when a specific channel started serialization of the telemetry event
+     */
+    serializationStart?: {
+        [key: string]: number;
+    };
+    /**
+     * Array of times when a specific channel completed serialization of the telemetry event
+     */
+    serializationCompleted?: {
+        [key: string]: number;
+    };
+}
+
 /**
  * Configuration for extra exceptions information sent with the exception telemetry.
  * @example
@@ -4836,6 +5247,83 @@ export declare interface IExceptionTelemetry extends IPartC {
     severityLevel?: SeverityLevel | number;
 }
 
+/**
+ * The IExtendedConfiguration interface holds the configuration details passed to core during initialize.
+ */
+export declare interface IExtendedConfiguration extends IConfiguration {
+    /**
+     * [Optional] The property storage override that should be used to store
+     * internal SDK properties, otherwise stored as cookies. It is needed where cookies are not available.
+     */
+    propertyStorageOverride?: IPropertyStorageOverride;
+    /**
+     * [Optional] A boolean that indicated whether to disable the use of cookies by the 1DS Web SDK. The cookies added by the SDK are
+     * MicrosoftApplicationsTelemetryDeviceId. If cookies are disabled, then session events are not sent unless propertyStorageOverride
+     * is provided to store the values elsewhere.
+     */
+    disableCookiesUsage?: boolean;
+    /**
+     * [Optional] Name of the Anon cookie.  The value will be set in the qsp header to collector requests.  Collector will use this value to look for specific cookie to use for anid property.
+     */
+    anonCookieName?: string;
+    /**
+     * [Optional] Disables additional internal event timings that are added during processing of events, the timings are not sent as part telemetry items to the server
+     */
+    disableEventTimings?: boolean;
+    /**
+     * [Optional] Enables support for objects with compound keys which indirectly represent an object where the "key" of the object contains a "." as part of it's name.
+     * @example
+     * ```typescript
+     * event: { "somedata.embeddedvalue": 123 }
+     * ```
+     */
+    enableCompoundKey?: boolean;
+    /**
+     * Add "&w=0" parameter to support UA Parsing when web-workers don't have access to Document.
+     * Default is false
+     */
+    enableWParam?: boolean;
+}
+
+/**
+ * An interface used to create an event, along with its name, properties, type, timestamp, and priority.
+ */
+export declare interface IExtendedTelemetryItem extends ITelemetryItem {
+    /**
+     * Properties to be captured about the telemetry item.
+     * Custom properties (alternatively referred to as Part C properties for a Common Schema event) can be
+     * directly added under data.
+     */
+    data?: {
+        [key: string]: any;
+    };
+    /**
+     * Telemetry properties pertaining to domain about which data is being captured. Example, duration, referrerUri for browser page.
+     * These are alternatively referred to as Part B properties for a Common Schema event.
+     */
+    baseData?: {
+        [key: string]: any;
+    };
+    /**
+     * An EventLatency value, that specifies the latency for the event.The EventLatency constant should be
+     * used to specify the different latency values.
+     */
+    latency?: number | EventLatencyValue;
+    /**
+     * [Optional] An EventPersistence value, that specifies the persistence for the event. The EventPersistence constant
+     * should be used to specify the different persistence values.
+     */
+    persistence?: number | EventPersistenceValue;
+    /**
+     * [Optional] A boolean that specifies whether the event should be sent as a sync request.
+     */
+    sync?: boolean | EventSendType;
+    /**
+     * [Optional] A timings object.
+     */
+    timings?: IEventTiming;
+}
+
 export declare interface IFeatureOptIn {
     [feature: string]: IFeatureOptInDetails;
 }
@@ -4871,6 +5359,57 @@ export declare interface IFeatureOptInDetails {
     blockCdnCfg?: boolean;
 }
 
+/**
+ * This interface defines the object that is passed to any provided FieldValueSanitizerFunc, it provides not only the value to be sanitized but also
+ * some context about the value like it's location within the envelope (serialized object), the format is defined via the
+ * [Common Schema 4.0](https://aka.ms/CommonSchema) specification.
+ */
+export declare interface IFieldSanitizerDetails {
+    /**
+     * The path within the event where the value is stored
+     */
+    path: string;
+    /**
+     * The name of the field with the event path that will store the value
+     */
+    name: string;
+    /**
+     * Identifies the type of the property value
+     */
+    type: FieldValueSanitizerType;
+    /**
+     * The value for the property.
+     */
+    prop: IEventProperty;
+    /**
+     * A reference to the value sanitizer that created the details
+     */
+    sanitizer: IValueSanitizer;
+}
+
+/**
+ * This interface is used during the serialization of individual fields when converting the events into envelope (serialized object) which is sent to the services,
+ * the format is defined via the [Common Schema 4.0](https://aka.ms/CommonSchema) specification. The path and field names used are based
+ * on how the data is serialized to the service (CS 4.0 location) and not specifically the location on the event object you pass into the track methods (unless they are the same).
+ */
+export declare interface IFieldValueSanitizerProvider {
+    /**
+     * Does this field value sanitizer handle this path / field combination
+     * @param path - The field path
+     * @param name - The name of the field
+     */
+    handleField(path: string, name: string): boolean;
+    /**
+     * Get the field sanitizer for this type of field based on the field type, value kind and/or event property type
+     * @param path - The field path
+     * @param name - The name of the field
+     * @param theType - The type of field
+     * @param theKind - The value kind of the field
+     * @param propType - The property type of the field
+     */
+    getSanitizer(path: string, name: string, theType: FieldValueSanitizerType, theKind?: number, propType?: number): FieldValueSanitizerFunc | null | undefined;
+}
+
 export declare interface IInstrumentCallDetails {
     name: string;
     inst: any;
@@ -6880,6 +7419,26 @@ export declare interface IPropertiesPlugin {
     readonly context: ITelemetryContext;
 }
 
+/**
+ * The IPropertyStorageOverride interface provides a custom interface for storing internal SDK properties - otherwise they are
+ * stored as cookies.
+ * You need this interface when you intend to run auto collection for common properties, or when you log a session in
+ * a non browser environment.
+ */
+export declare interface IPropertyStorageOverride {
+    /**
+     * A function for passing key value pairs to be stored.
+     * @param key   - The key for the key value pair.
+     * @param value - The value for the key value pair.
+     */
+    setProperty: (key: string, value: string) => void;
+    /**
+     * A function that gets a value for a given key.
+     * @param key - The key for which the value must be fetched.
+     */
+    getProperty: (key: string) => string;
+}
+
 /**
  * Provides an OpenTelemetry compatible Interface for the Open Telemetry Sdk-Trace-Base (1.8.0 and 2.0.0) ReadableSpan type.
  *
@@ -7068,6 +7627,8 @@ export declare interface ISample {
 
 export { isArray }
 
+export declare function isArrayValid(value: any[]): boolean;
+
 /**
  * Helper function to identify if a passed argument is or implements the IAttributeContainer interface
  * @param value - The value to check
@@ -7118,12 +7679,22 @@ export declare function isBeaconsSupported(useCached?: boolean): boolean;
 
 export { isBoolean }
 
+/**
+ * Helper to identify whether we are running in a chromium based browser environment
+ */
+export declare function isChromium(): boolean;
+
 export declare function isCrossOriginError(message: string | Event, url: string, lineNumber: number, columnNumber: number, error: Error | Event): boolean;
 
 export { isDate }
 
 export declare function isDistributedTraceContext(obj: any): obj is IDistributedTraceContext;
 
+/**
+ * Checks if document object is available
+ */
+export declare const isDocumentObjectAvailable: boolean;
+
 /**
  * internal interface
  * Define functions when xhr/xdr/fetch requests are successfully returned. If they are not defined, oncomplete with be called instead
@@ -7320,6 +7891,13 @@ export declare function isFetchSupported(withKeepAlive?: boolean): boolean;
 
 export { isFunction }
 
+/**
+ * Check to see if the value is \> 0
+ * @param value - The value to check
+ * @returns true if \> 0 otherwise false
+ */
+export declare function isGreaterThanZero(value: number): boolean;
+
 /**
  * Identifies whether the current environment appears to be IE
  */
@@ -7327,6 +7905,13 @@ export declare function isIE(): boolean;
 
 export declare function isInternalApplicationInsightsEndpoint(endpointUrl: string): boolean;
 
+/**
+ * Checks if the value is a valid EventLatency.
+ * @param value - The value that needs to be checked.
+ * @returns True if the value is in AWTEventLatency, false otherwise.
+ */
+export declare function isLatency(value: EventLatency | undefined): boolean;
+
 export declare function isNotNullOrUndefined<T>(value: T): value is T;
 
 export { isNotTruthy }
@@ -7499,6 +8084,13 @@ export { isTruthy }
 
 export { isTypeof }
 
+/**
+ * Checks if Uint8Array are available in the current environment. Safari and Firefox along with
+ * ReactNative are known to not support Uint8Array properly.
+ * @returns True if available, false otherwise.
+ */
+export declare function isUint8ArrayAvailable(): boolean;
+
 export { isUndefined }
 
 /**
@@ -7526,6 +8118,15 @@ export declare function isValidTraceId(value: string): boolean;
  */
 export declare function isValidTraceParent(value: ITraceParent): boolean;
 
+/**
+ * Checks if value is assigned to the given param.
+ * @param value - The token from which the tenant id is to be extracted.
+ * @returns True/false denoting if value is assigned to the param.
+ */
+export declare function isValueAssigned(value: any): boolean;
+
+export declare function isValueKind(value: number | undefined): boolean;
+
 /**
  * Identifies if the provided value looks like a distributed trace state instance
  * @param value - The value to check
@@ -7533,6 +8134,11 @@ export declare function isValidTraceParent(value: ITraceParent): boolean;
  */
 export declare function isW3cTraceState(value: any): value is IW3cTraceState;
 
+/**
+ * Checks if window object is available
+ */
+export declare const isWindowObjectAvailable: boolean;
+
 /**
  * Checks if XMLHttpRequest is supported
  * @returns True if supported, otherwise false
@@ -7711,24 +8317,92 @@ declare interface ITelemetryProcessor {
 
 /**
  * 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.
+ * @deprecated Use {@link ITraceHost.getTraceCtx | appInsights.getTraceCtx()} or {@link ITraceHost.getTraceCtx | appInsights.core.getTraceCtx()} instead to get / set the
+ * current trace context. This returns an {@link IDistributedTraceContext} which supports distributed tracing and
+ * allows the core to manage the trace context.
+ *
+ * To replace the entire trace context, use {@link ITraceHost.setTraceCtx | appInsights.core.setTraceCtx()}.
+ *
+ * @see {@link https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-core-js/interfaces/IDistributedTraceContext.html | IDistributedTraceContext Typedoc}
+ * @see {@link https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-core-js/interfaces/ITraceHost.html#getTraceCtx | getTraceCtx Typedoc}
  */
 export declare interface ITelemetryTrace {
     /**
-     * Trace id
+     * The trace ID for this telemetry context. A 32 lowercase hex character string.
+     * @deprecated Use {@link IDistributedTraceContext.traceId} instead via `appInsights.getTraceCtx().traceId`.
+     *
+     * @example
+     * ```typescript
+     * // Old (deprecated)
+     * let traceId = context.telemetryTrace.traceID;
+     *
+     * // New (recommended) - using the standard SKU (AISKU)
+     * let traceCtx = appInsights.getTraceCtx();
+     * let traceId = traceCtx.traceId;
+     * traceCtx.traceId = "00000000000000000000000000000001";
+     *
+     * // Or when using the core directly
+     * let traceCtx = appInsights.core.getTraceCtx();
+     * ```
      */
     traceID?: string;
     /**
-     * Parent id
+     * The parent span ID. A 16 lowercase hex character string.
+     * @deprecated Use {@link IDistributedTraceContext.spanId} instead via `appInsights.getTraceCtx().spanId`.
+     *
+     * @example
+     * ```typescript
+     * // Old (deprecated)
+     * let parentId = context.telemetryTrace.parentID;
+     *
+     * // New (recommended) - using the standard SKU (AISKU)
+     * let traceCtx = appInsights.getTraceCtx();
+     * let spanId = traceCtx.spanId;
+     * traceCtx.spanId = "0000000000000001";
+     *
+     * // Or when using the core directly
+     * let traceCtx = appInsights.core.getTraceCtx();
+     * ```
      */
     parentID?: string;
     /**
-     * An integer representation of the W3C TraceContext trace-flags. https://www.w3.org/TR/trace-context/#trace-flags
+     * An integer representation of the W3C TraceContext trace-flags.
+     * @deprecated Use {@link IDistributedTraceContext.traceFlags} instead via `appInsights.getTraceCtx().traceFlags`.
+     *
+     * @example
+     * ```typescript
+     * // Old (deprecated)
+     * let flags = context.telemetryTrace.traceFlags;
+     *
+     * // New (recommended) - using the standard SKU (AISKU)
+     * let traceCtx = appInsights.getTraceCtx();
+     * let flags = traceCtx.traceFlags;
+     * traceCtx.traceFlags = 1; // sampled
+     *
+     * // Or when using the core directly
+     * let traceCtx = appInsights.core.getTraceCtx();
+     * ```
+     *
+     * @see {@link https://www.w3.org/TR/trace-context/#trace-flags | W3C TraceContext trace-flags}
      */
     traceFlags?: number;
     /**
-     * Name
+     * The operation/page name for this trace context.
+     * @deprecated Use {@link IDistributedTraceContext.pageName} instead via `appInsights.getTraceCtx().pageName`.
+     *
+     * @example
+     * ```typescript
+     * // Old (deprecated)
+     * let name = context.telemetryTrace.name;
+     *
+     * // New (recommended) - using the standard SKU (AISKU)
+     * let traceCtx = appInsights.getTraceCtx();
+     * let pageName = traceCtx.pageName;
+     * traceCtx.pageName = "my-page";
+     *
+     * // Or when using the core directly
+     * let traceCtx = appInsights.core.getTraceCtx();
+     * ```
      */
     name?: string;
 }
@@ -8199,6 +8873,56 @@ export declare interface IUserContext extends IUser {
     update(userId?: string): void;
 }
 
+/**
+ * This interface is used during the serialization of events into envelope (serialized object) which is sent to the services, the format is defined via the
+ * [Common Schema 4.0](https://aka.ms/CommonSchema) specification. The path and field names used are based on how the data is serialized
+ * to the service (CS 4.0 location) and not specifically the location on the event object you pass into the track methods (unless they are the same).
+ */
+export declare interface IValueSanitizer {
+    /**
+     * Add a value sanitizer as a fallback sanitizer if this sanitizer can't handle the path/name.
+     */
+    addSanitizer: (sanitizer: IValueSanitizer) => void;
+    /**
+     * Adds a field sanitizer to the evaluation list
+     */
+    addFieldSanitizer: (fieldSanitizer: IFieldValueSanitizerProvider) => void;
+    /**
+     * Removes the value sanitizer as a fallback sanitizer if this sanitizer can't handle the path/name if present.
+     */
+    rmSanitizer: (theSanitizer: IValueSanitizer) => void;
+    /**
+     * Removes the field sanitizer to the evaluation list if present
+     */
+    rmFieldSanitizer: (theFieldSanitizer: IFieldValueSanitizerProvider) => void;
+    /**
+     * Does this field value sanitizer handle this path / field combination
+     * @param path - The field path
+     * @param name - The name of the field
+     */
+    handleField: (path: string, name: string) => boolean;
+    /**
+     * Sanitizes the value. It checks the that the property name and value are valid. It also
+     * checks/populates the correct type and pii of the property value.
+     * @param path - The root path of the property
+     * @param name - The property name.
+     * @param value - The property value or an IEventProperty containing value, type ,pii and customer content.
+     * @param stringifyObjects - If supplied tells the sanitizer that it should JSON stringify() objects
+     * @returns IEventProperty containing valid name, value, pii and type or null if invalid.
+     */
+    value: (path: string, name: string, value: FieldValueSanitizerTypes, stringifyObjects?: boolean) => IEventProperty | null;
+    /**
+     * Sanitizes the Property. It checks the that the property name and value are valid. It also
+     * checks/populates the correct type and pii of the property value.
+     * @param path - The root path of the property
+     * @param name - The property name.
+     * @param property - The property value or an IEventProperty containing value, type ,pii and customer content.
+     * @param stringifyObjects - If supplied tells the sanitizer that it should JSON stringify() objects
+     * @returns IEventProperty containing valid name, value, pii and type or null if invalid.
+     */
+    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
@@ -9186,6 +9910,16 @@ export declare const SampleRate = "sampleRate";
  */
 export declare function sanitizeAttributes(otelApi: IOTelApi, attributes: unknown): IOTelAttributes;
 
+/**
+ * Sanitizes the Property. It checks the that the property name and value are valid. It also
+ * checks/populates the correct type and pii of the property value.
+ * @param name - property name                          - The property name.
+ * @param property - The property value or an IEventProperty containing value,
+ * type ,pii and customer content.
+ * @returns IEventProperty containing valid name, value, pii and type or null if invalid.
+ */
+export declare function sanitizeProperty(name: string, property: string | number | boolean | string[] | number[] | boolean[] | object | IEventProperty, stringifyObjects?: boolean): IEventProperty | null;
+
 export declare interface scriptsInfo {
     url: string;
     crossOrigin?: string;
@@ -9366,6 +10100,8 @@ export declare function setGblPerfMgr(perfManager: IPerfManager): void;
  */
 export declare function setObjStringTag<T>(target: T, nameOrFunc: string | (() => string)): T;
 
+export declare function setProcessTelemetryTimings(event: ITelemetryItem, identifier: string): void;
+
 /**
  * Introduce an intermediate prototype to the target object and that sets the toStringTag on that prototype,
  * this avoids directly modifying the target object and also allows multiple different "types" to be
@@ -9658,6 +10394,15 @@ export declare const TraceDataType = "MessageData";
 
 export declare const TraceEnvelopeType: string;
 
+export declare const TraceLevel: EnumValue<typeof eTraceLevel>;
+
+export declare type TraceLevel = number | eTraceLevel;
+
+/**
+ * An enumeration that identifies the transport type that are requested to be used, if the requested
+ * transport is not available ir supported the SDK may choose the first available transport or it
+ * will log a warning to the diagnostic logger.
+ */
 export declare const enum TransportType {
     /**
      * Use the default available api
@@ -9715,6 +10460,10 @@ export declare function urlParseHost(url: string, inclPort?: boolean): string;
 
 export declare function urlParseUrl(url: string): HTMLAnchorElement;
 
+export declare const UrlRedactionOptions: EnumValue<typeof eUrlRedactionOptions>;
+
+export declare type UrlRedactionOptions = boolean | eUrlRedactionOptions;
+
 /**
  * Execute the callback `fn` function with the passed span as the active span. The callback receives
  * an ISpanScope object as its first parameter and the `this` context (when no thisArg is provided).
@@ -9777,6 +10526,76 @@ export declare function utlSetSessionStorage(logger: IDiagnosticLogger, name: st
 
 export declare function utlSetStoragePrefix(storagePrefix: string): void;
 
+/**
+ * The ValueKind contains a set of values that specify value kind of the property.
+ * Either PII (Personal Identifiable Information) or customer content.
+ */
+export declare const ValueKind: EnumValue<typeof eValueKind>;
+
+export declare type ValueKind = number | eValueKind;
+
+export declare class ValueSanitizer implements IValueSanitizer {
+    static getFieldType: typeof getFieldValueType;
+    /**
+     * Clear the current value sanitizer cache.
+     */
+    clearCache: () => void;
+    /**
+     * Add a value sanitizer as a fallback sanitizer if this sanitizer can't handle the path/name.
+     */
+    addSanitizer: (sanitizer: IValueSanitizer) => void;
+    /**
+     * Adds a field sanitizer to the evaluation list
+     */
+    addFieldSanitizer: (fieldSanitizer: IFieldValueSanitizerProvider) => void;
+    /**
+     * Removes the value sanitizer as a fallback sanitizer if this sanitizer can't handle the path/name if present.
+     */
+    rmSanitizer: (theSanitizer: IValueSanitizer) => void;
+    /**
+     * Removes the field sanitizer to the evaluation list if present
+     */
+    rmFieldSanitizer: (theFieldSanitizer: IFieldValueSanitizerProvider) => void;
+    /**
+     * Does this field value sanitizer handle this path / field combination
+     * @param path - The field path
+     * @param name - The name of the field
+     */
+    handleField: (path: string, name: string) => boolean;
+    /**
+     * Sanitizes the value. It checks the that the property name and value are valid. It also
+     * checks/populates the correct type and pii of the property value.
+     * @param path - The root path of the property
+     * @param name - The property name.
+     * @param value - The property value or an IEventProperty containing value, type ,pii and customer content.
+     * @param stringifyObjects - If supplied tells the sanitizer that it should JSON stringify() objects
+     * @returns IEventProperty containing valid name, value, pii and type or null if invalid.
+     */
+    value: (path: string, name: string, value: FieldValueSanitizerTypes, stringifyObjects?: boolean) => IEventProperty | null;
+    /**
+     * Sanitizes the Property. It checks the that the property name and value are valid. It also
+     * checks/populates the correct type and pii of the property value.
+     * @param path - The root path of the property
+     * @param name - The property name.
+     * @param property - The property value or an IEventProperty containing value, type ,pii and customer content.
+     * @param stringifyObjects - If supplied tells the sanitizer that it should JSON stringify() objects
+     * @returns IEventProperty containing valid name, value, pii and type or null if invalid.
+     */
+    property: (path: string, name: string, property: IEventProperty, stringifyObjects?: boolean) => IEventProperty | null;
+    /**
+     * Returns whether this ValueSanitizer is empty
+     * @returns `true` if it contains no chained sanitizers or field sanitizers, otherwise `false`
+     */
+    isEmpty?: () => boolean;
+    constructor(fieldSanitizerProvider?: IFieldValueSanitizerProvider);
+}
+
+/**
+ * Identifies the version for the extended SDK (legacy constant)
+ * @deprecated Use {@link ExtVersion} instead
+ */
+export declare const Version = "4.4.1";
+
 /**
  * This is a helper method which will call warnToConsole on the passed logger with the provided message.
  * @param logger - The Diagnostic Logger instance to use.