@microsoft/applicationinsights-core-js 2.8.0-nightly.2204-04 → 2.8.0-nightly.2204-07

package/dist/applicationinsights-core-js.api.md

@@ -145,7 +145,14 @@ export function createClassFromInterface<T>(defaults?: T): new () => T;
 export function createCookieMgr(rootConfig?: IConfiguration, logger?: IDiagnosticLogger): ICookieMgr;
 
 // @public
-export function createEnumStyle<T>(values: T): T;
+export function createEnumMap<E, I = keyof E>(values: {
+    [key in keyof E]: E[keyof E];
+}): EnumMap<E, I>;
+
+// @public
+export function createEnumStyle<E>(values: {
+    [key in keyof E]: E[keyof E];
+}): EnumValue<E>;
 
 // @public
 export function createProcessTelemetryContext(telemetryChain: ITelemetryPluginChain | null, config: IConfiguration, core: IAppInsightsCore, startAt?: IPlugin): IProcessTelemetryContext;
@@ -159,9 +166,17 @@ export function createUnloadHandlerContainer(): {
     run: (unloadCtx: IProcessTelemetryUnloadContext, unloadState: ITelemetryUnloadState) => void;
 };
 
+// @public
+export function createValueMap<E, V = E>(values: {
+    [key in keyof E]: [eValue: E[keyof E], mapValue: V[keyof V]];
+}): V;
+
 // @public
 export function dateNow(): number;
 
+// @public (undocumented)
+export function deepFreeze<T>(obj: T): T;
+
 // @public @deprecated (undocumented)
 export function deleteCookie(logger: IDiagnosticLogger, name: string): boolean;
 
@@ -194,6 +209,16 @@ export function doPerf<T>(mgrSource: IPerfManagerProvider | IPerfManager, getSou
 // @public
 export function dumpObj(object: any): string;
 
+// @public
+export const enum eEventsDiscardedReason {
+    InvalidEvent = 2,
+    KillSwitch = 4,
+    NonRetryableStatus = 1,
+    QueueFull = 5,
+    SizeLimitExceeded = 3,
+    Unknown = 0
+}
+
 // @public (undocumented)
 export const enum _eInternalMessageId {
     // (undocumented)
@@ -368,6 +393,16 @@ export const enum eLoggingSeverity {
     WARNING = 2
 }
 
+// @public (undocumented)
+export type EnumMap<E = any, I = E> = {
+    readonly [key in keyof E extends string ? keyof E : never]: key extends string ? key : keyof E;
+} & I;
+
+// @public (undocumented)
+export type EnumValue<E = any> = {
+    readonly [key in keyof E]: E[key];
+};
+
 // @public (undocumented)
 export const EventHelper: IEventHelper;
 
@@ -378,14 +413,10 @@ export function eventOff<T>(target: T, eventName: string, handlerRef: any, evtNa
 export function eventOn<T>(target: T, eventName: string, handlerRef: any, evtNamespace?: string | string[] | null, useCapture?: boolean): boolean;
 
 // @public
-export const EventsDiscardedReason: {
-    Unknown: number;
-    NonRetryableStatus: number;
-    InvalidEvent: number;
-    SizeLimitExceeded: number;
-    KillSwitch: number;
-    QueueFull: number;
-};
+export const EventsDiscardedReason: EnumValue<typeof eEventsDiscardedReason>;
+
+// @public (undocumented)
+export type EventsDiscardedReason = number | eEventsDiscardedReason;
 
 // @public
 export function generateW3CId(): string;
@@ -772,90 +803,7 @@ export class _InternalLogMessage {
 }
 
 // @public
-export const _InternalMessageId: {
-    BrowserDoesNotSupportLocalStorage: number;
-    BrowserCannotReadLocalStorage: number;
-    BrowserCannotReadSessionStorage: number;
-    BrowserCannotWriteLocalStorage: number;
-    BrowserCannotWriteSessionStorage: number;
-    BrowserFailedRemovalFromLocalStorage: number;
-    BrowserFailedRemovalFromSessionStorage: number;
-    CannotSendEmptyTelemetry: number;
-    ClientPerformanceMathError: number;
-    ErrorParsingAISessionCookie: number;
-    ErrorPVCalc: number;
-    ExceptionWhileLoggingError: number;
-    FailedAddingTelemetryToBuffer: number;
-    FailedMonitorAjaxAbort: number;
-    FailedMonitorAjaxDur: number;
-    FailedMonitorAjaxOpen: number;
-    FailedMonitorAjaxRSC: number;
-    FailedMonitorAjaxSend: number;
-    FailedMonitorAjaxGetCorrelationHeader: number;
-    FailedToAddHandlerForOnBeforeUnload: number;
-    FailedToSendQueuedTelemetry: number;
-    FailedToReportDataLoss: number;
-    FlushFailed: number;
-    MessageLimitPerPVExceeded: number;
-    MissingRequiredFieldSpecification: number;
-    NavigationTimingNotSupported: number;
-    OnError: number;
-    SessionRenewalDateIsZero: number;
-    SenderNotInitialized: number;
-    StartTrackEventFailed: number;
-    StopTrackEventFailed: number;
-    StartTrackFailed: number;
-    StopTrackFailed: number;
-    TelemetrySampledAndNotSent: number;
-    TrackEventFailed: number;
-    TrackExceptionFailed: number;
-    TrackMetricFailed: number;
-    TrackPVFailed: number;
-    TrackPVFailedCalc: number;
-    TrackTraceFailed: number;
-    TransmissionFailed: number;
-    FailedToSetStorageBuffer: number;
-    FailedToRestoreStorageBuffer: number;
-    InvalidBackendResponse: number;
-    FailedToFixDepricatedValues: number;
-    InvalidDurationValue: number;
-    TelemetryEnvelopeInvalid: number;
-    CreateEnvelopeError: number;
-    CannotSerializeObject: number;
-    CannotSerializeObjectNonSerializable: number;
-    CircularReferenceDetected: number;
-    ClearAuthContextFailed: number;
-    ExceptionTruncated: number;
-    IllegalCharsInName: number;
-    ItemNotInArray: number;
-    MaxAjaxPerPVExceeded: number;
-    MessageTruncated: number;
-    NameTooLong: number;
-    SampleRateOutOfRange: number;
-    SetAuthContextFailed: number;
-    SetAuthContextFailedAccountName: number;
-    StringValueTooLong: number;
-    StartCalledMoreThanOnce: number;
-    StopCalledWithoutStart: number;
-    TelemetryInitializerFailed: number;
-    TrackArgumentsNotSpecified: number;
-    UrlTooLong: number;
-    SessionStorageBufferFull: number;
-    CannotAccessCookie: number;
-    IdTooLong: number;
-    InvalidEvent: number;
-    FailedMonitorAjaxSetRequestHeader: number;
-    SendBrowserInfoOnUserInit: number;
-    PluginException: number;
-    NotificationException: number;
-    SnippetScriptLoadFailure: number;
-    InvalidInstrumentationKey: number;
-    CannotParseAiBlobValue: number;
-    InvalidContentBlob: number;
-    TrackPageActionEventFailed: number;
-    FailedAddingCustomDefinedRequestContext: number;
-    InMemoryStorageBufferFull: number;
-};
+export const _InternalMessageId: EnumValue<typeof _eInternalMessageId>;
 
 // @public (undocumented)
 export type _InternalMessageId = number | _eInternalMessageId;
@@ -1068,14 +1016,14 @@ export interface IUnloadHandlerContainer {
 export function _legacyCookieMgr(config?: IConfiguration, logger?: IDiagnosticLogger): ICookieMgr;
 
 // @public (undocumented)
-export const LoggingSeverity: {
-    CRITICAL: number;
-    WARNING: number;
-};
+export const LoggingSeverity: EnumValue<typeof eLoggingSeverity>;
 
 // @public (undocumented)
 export type LoggingSeverity = number | eLoggingSeverity;
 
+// @public
+export function _logInternalMessage(logger: IDiagnosticLogger, severity: LoggingSeverity, message: _InternalLogMessage): void;
+
 // @public (undocumented)
 export function mergeEvtNamespace(theNamespace: string, namespaces?: string | string[] | null): string | string[];
 
@@ -1195,7 +1143,7 @@ export class ProcessTelemetryContext implements IProcessTelemetryContext {
 // @public
 export function proxyAssign<T, S>(target: T, source: S, chkSet?: (name: string, isFunc?: boolean, source?: S, target?: T) => boolean): T;
 
-// @public (undocumented)
+// @public
 export function proxyFunctionAs<T, S>(target: T, name: string, source: S | (() => S), theFunc: (keyof S), overwriteTarget?: boolean): void;
 
 // @public
@@ -1331,6 +1279,9 @@ export type UnloadHandler = (itemCtx: IProcessTelemetryUnloadContext, unloadStat
 // @public (undocumented)
 export function useXDomainRequest(): boolean | undefined;
 
+// @public
+export function _warnToConsole(logger: IDiagnosticLogger, message: string): void;
+
 // (No @packageDocumentation comment for this package)
 
 ```

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

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights Core Javascript SDK, 2.8.0-nightly.2204-04
+ * Microsoft Application Insights Core Javascript SDK, 2.8.0-nightly.2204-07
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -356,12 +356,23 @@ declare namespace ApplicationInsights {
 
     function createCookieMgr(rootConfig?: IConfiguration, logger?: IDiagnosticLogger): ICookieMgr;
 
+    /**
+     * Create a 2 index map that maps an enum's key as both the key and value, X["key"] => "key" and X[0] => "keyof 0".
+     * @param values - The values to populate on the new object
+     * @returns
+     */
+    function createEnumMap<E, I = keyof E>(values: {
+        [key in keyof E]: E[keyof E];
+    }): EnumMap<E, I>;
+
     /**
      * Create an enum style object which has both the key => value and value => key mappings
      * @param values - The values to populate on the new object
      * @returns
      */
-    function createEnumStyle<T>(values: T): T;
+    function createEnumStyle<E>(values: {
+        [key in keyof E]: E[keyof E];
+    }): EnumValue<E>;
 
     /**
      * Creates a new Telemetry Item context with the current config, core and plugin execution chain
@@ -379,12 +390,27 @@ declare namespace ApplicationInsights {
         run: (unloadCtx: IProcessTelemetryUnloadContext, unloadState: ITelemetryUnloadState) => void;
     };
 
+    /**
+     * Create a 2 index map that maps an enum's key and value to the defined map value, X["key"] => mapValue and X[0] => mapValue.
+     * Generic values
+     * - E = the const enum type (typeof eRequestHeaders);
+     * - V = Identifies the valid values for the keys, this should include both the enum numeric and string key of the type. The
+     * resulting "Value" of each entry identifies the valid values withing the assignments.
+     * @param values - The values to populate on the new object
+     * @returns
+     */
+    function createValueMap<E, V = E>(values: {
+        [key in keyof E]: [eValue: E[keyof E], mapValue: V[keyof V]];
+    }): V;
+
     /**
      * Return the current time via the Date now() function (if available) and falls back to (new Date()).getTime() if now() is unavailable (IE8 or less)
      * https://caniuse.com/#search=Date.now
      */
     function dateNow(): number;
 
+    function deepFreeze<T>(obj: T): T;
+
     /**
      * @deprecated - Use the core.getCookieMgr().del()
      * Deletes a cookie by setting it's expiration time in the past.
@@ -480,6 +506,36 @@ declare namespace ApplicationInsights {
      */
     function dumpObj(object: any): string;
 
+    /**
+     * The eEventsDiscardedReason enumeration contains a set of values that specify the reason for discarding an event.
+     */
+    const enum eEventsDiscardedReason {
+        /**
+         * Unknown.
+         */
+        Unknown = 0,
+        /**
+         * Status set to non-retryable.
+         */
+        NonRetryableStatus = 1,
+        /**
+         * The event is invalid.
+         */
+        InvalidEvent = 2,
+        /**
+         * The size of the event is too large.
+         */
+        SizeLimitExceeded = 3,
+        /**
+         * The server is not accepting events from this instrumentation key.
+         */
+        KillSwitch = 4,
+        /**
+         * The event queue is full.
+         */
+        QueueFull = 5
+    }
+
     const enum _eInternalMessageId {
         BrowserDoesNotSupportLocalStorage = 0,
         BrowserCannotReadLocalStorage = 1,
@@ -576,6 +632,14 @@ declare namespace ApplicationInsights {
         WARNING = 2
     }
 
+    type EnumMap<E = any, I = E> = {
+        readonly [key in keyof E extends string ? keyof E : never]: key extends string ? key : keyof E;
+    } & I;
+
+    type EnumValue<E = any> = {
+        readonly [key in keyof E]: E[key];
+    };
+
     const EventHelper: IEventHelper;
 
     /**
@@ -608,32 +672,9 @@ declare namespace ApplicationInsights {
     /**
      * The EventsDiscardedReason enumeration contains a set of values that specify the reason for discarding an event.
      */
-    const EventsDiscardedReason: {
-        /**
-         * Unknown.
-         */
-        Unknown: number;
-        /**
-         * Status set to non-retryable.
-         */
-        NonRetryableStatus: number;
-        /**
-         * The event is invalid.
-         */
-        InvalidEvent: number;
-        /**
-         * The size of the event is too large.
-         */
-        SizeLimitExceeded: number;
-        /**
-         * The server is not accepting events from this instrumentation key.
-         */
-        KillSwitch: number;
-        /**
-         * The event queue is full.
-         */
-        QueueFull: number;
-    };
+    const EventsDiscardedReason: EnumValue<typeof eEventsDiscardedReason>;
+
+    type EventsDiscardedReason = number | eEventsDiscardedReason;
 
     /**
      * generate W3C trace id
@@ -1734,90 +1775,7 @@ declare namespace ApplicationInsights {
     /**
      * Internal message ID. Please create a new one for every conceptually different message. Please keep alphabetically ordered
      */
-    const _InternalMessageId: {
-        BrowserDoesNotSupportLocalStorage: number;
-        BrowserCannotReadLocalStorage: number;
-        BrowserCannotReadSessionStorage: number;
-        BrowserCannotWriteLocalStorage: number;
-        BrowserCannotWriteSessionStorage: number;
-        BrowserFailedRemovalFromLocalStorage: number;
-        BrowserFailedRemovalFromSessionStorage: number;
-        CannotSendEmptyTelemetry: number;
-        ClientPerformanceMathError: number;
-        ErrorParsingAISessionCookie: number;
-        ErrorPVCalc: number;
-        ExceptionWhileLoggingError: number;
-        FailedAddingTelemetryToBuffer: number;
-        FailedMonitorAjaxAbort: number;
-        FailedMonitorAjaxDur: number;
-        FailedMonitorAjaxOpen: number;
-        FailedMonitorAjaxRSC: number;
-        FailedMonitorAjaxSend: number;
-        FailedMonitorAjaxGetCorrelationHeader: number;
-        FailedToAddHandlerForOnBeforeUnload: number;
-        FailedToSendQueuedTelemetry: number;
-        FailedToReportDataLoss: number;
-        FlushFailed: number;
-        MessageLimitPerPVExceeded: number;
-        MissingRequiredFieldSpecification: number;
-        NavigationTimingNotSupported: number;
-        OnError: number;
-        SessionRenewalDateIsZero: number;
-        SenderNotInitialized: number;
-        StartTrackEventFailed: number;
-        StopTrackEventFailed: number;
-        StartTrackFailed: number;
-        StopTrackFailed: number;
-        TelemetrySampledAndNotSent: number;
-        TrackEventFailed: number;
-        TrackExceptionFailed: number;
-        TrackMetricFailed: number;
-        TrackPVFailed: number;
-        TrackPVFailedCalc: number;
-        TrackTraceFailed: number;
-        TransmissionFailed: number;
-        FailedToSetStorageBuffer: number;
-        FailedToRestoreStorageBuffer: number;
-        InvalidBackendResponse: number;
-        FailedToFixDepricatedValues: number;
-        InvalidDurationValue: number;
-        TelemetryEnvelopeInvalid: number;
-        CreateEnvelopeError: number;
-        CannotSerializeObject: number;
-        CannotSerializeObjectNonSerializable: number;
-        CircularReferenceDetected: number;
-        ClearAuthContextFailed: number;
-        ExceptionTruncated: number;
-        IllegalCharsInName: number;
-        ItemNotInArray: number;
-        MaxAjaxPerPVExceeded: number;
-        MessageTruncated: number;
-        NameTooLong: number;
-        SampleRateOutOfRange: number;
-        SetAuthContextFailed: number;
-        SetAuthContextFailedAccountName: number;
-        StringValueTooLong: number;
-        StartCalledMoreThanOnce: number;
-        StopCalledWithoutStart: number;
-        TelemetryInitializerFailed: number;
-        TrackArgumentsNotSpecified: number;
-        UrlTooLong: number;
-        SessionStorageBufferFull: number;
-        CannotAccessCookie: number;
-        IdTooLong: number;
-        InvalidEvent: number;
-        FailedMonitorAjaxSetRequestHeader: number;
-        SendBrowserInfoOnUserInit: number;
-        PluginException: number;
-        NotificationException: number;
-        SnippetScriptLoadFailure: number;
-        InvalidInstrumentationKey: number;
-        CannotParseAiBlobValue: number;
-        InvalidContentBlob: number;
-        TrackPageActionEventFailed: number;
-        FailedAddingCustomDefinedRequestContext: number;
-        InMemoryStorageBufferFull: number;
-    };
+    const _InternalMessageId: EnumValue<typeof _eInternalMessageId>;
 
     type _InternalMessageId = number | _eInternalMessageId;
 
@@ -2292,13 +2250,18 @@ declare namespace ApplicationInsights {
      */
     function _legacyCookieMgr(config?: IConfiguration, logger?: IDiagnosticLogger): ICookieMgr;
 
-    const LoggingSeverity: {
-        CRITICAL: number;
-        WARNING: number;
-    };
+    const LoggingSeverity: EnumValue<typeof eLoggingSeverity>;
 
     type LoggingSeverity = number | eLoggingSeverity;
 
+    /**
+     * Logs a message to the internal queue.
+     * @param logger - The Diagnostic Logger instance to use.
+     * @param severity {LoggingSeverity} - The severity of the log message
+     * @param message {_InternalLogMessage} - The message to log.
+     */
+    function _logInternalMessage(logger: IDiagnosticLogger, severity: LoggingSeverity, message: _InternalLogMessage): void;
+
     function mergeEvtNamespace(theNamespace: string, namespaces?: string | string[] | null): string | string[];
 
     const MinChannelPriorty: number;
@@ -2600,6 +2563,15 @@ declare namespace ApplicationInsights {
      */
     function proxyAssign<T, S>(target: T, source: S, chkSet?: (name: string, isFunc?: boolean, source?: S, target?: T) => boolean): T;
 
+    /**
+     * Creates a proxy function on the target which internally will call the source version with all arguments passed to the target method.
+     *
+     * @param target - The target object to be assigned with the source properties and functions
+     * @param name - The function name that will be added on the target
+     * @param source - The source object which will be assigned / called by setting / calling the targets proxies
+     * @param theFunc - The function name on the source that will be proxied on the target
+     * @param overwriteTarget - If `false` this will not replace any pre-existing name otherwise (the default) it will overwrite any existing name
+     */
     function proxyFunctionAs<T, S>(target: T, name: string, source: S | (() => S), theFunc: (keyof S), overwriteTarget?: boolean): void;
 
     /**
@@ -2608,6 +2580,7 @@ declare namespace ApplicationInsights {
      * @param target - The target object to be assigned with the source properties and functions
      * @param source - The source object which will be assigned / called by setting / calling the targets proxies
      * @param functionsToProxy - An array of function names that will be proxied on the target
+     * @param overwriteTarget - If false this will not replace any pre-existing name otherwise (the default) it will overwrite any existing name
      */
     function proxyFunctions<T, S>(target: T, source: S | (() => S), functionsToProxy: (keyof S)[], overwriteTarget?: boolean): T;
 
@@ -2885,5 +2858,12 @@ declare namespace ApplicationInsights {
 
     function useXDomainRequest(): boolean | undefined;
 
+    /**
+     * 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.
+     * @param message {_InternalLogMessage} - The log message.
+     */
+    function _warnToConsole(logger: IDiagnosticLogger, message: string): void;
+
     
 }