@microsoft/applicationinsights-core-js 3.0.3-nightly3.2305-14 → 3.0.3-nightly3.2307-24

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

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights Core Javascript SDK, 3.0.3-nightly3.2305-14
+ * Microsoft Application Insights Core Javascript SDK, 3.0.3-nightly3.2307-24
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -134,6 +134,10 @@ export declare function addPageShowEventListener(listener: any, excludeEvents?:
  */
 export declare function addPageUnloadEventListener(listener: any, excludeEvents?: string[], evtNamespace?: string | string[]): boolean;
 
+/**
+ * @group Classes
+ * @group Entrypoint
+ */
 export declare class AppInsightsCore<CfgType extends IConfiguration = IConfiguration> implements IAppInsightsCore<CfgType> {
     config: CfgType;
     logger: IDiagnosticLogger;
@@ -286,15 +290,10 @@ export declare class AppInsightsCore<CfgType extends IConfiguration = IConfigura
 export declare function areCookiesSupported(logger?: IDiagnosticLogger): any;
 
 export { arrForEach }
-
 export { arrIndexOf }
-
 export { arrMap }
-
 export { arrReduce }
-
 export { asString }
-
 /**
  * Binds the specified function to an event, so that the function gets called whenever the event fires on the object
  * @param obj - Object to add the event too.
@@ -514,6 +513,8 @@ export declare function createClassFromInterface<T>(defaults?: T): new () => T;
 
 export declare function createCookieMgr(rootConfig?: IConfiguration, logger?: IDiagnosticLogger): ICookieMgr;
 
+export declare function createCustomDomEvent(eventName: string, details?: any): CustomEvent;
+
 /**
  * Create or return a dynamic version of the passed config, if it is not already dynamic
  * @param config - The config to be converted into a dynamic config
@@ -576,9 +577,7 @@ export declare const createValueMap: <E, V = E>(values: {
 }) => V;
 
 export { dateNow }
-
 export { deepFreeze }
-
 /**
  * Removes an event handler for the specified event
  * @param Object - to remove the event from
@@ -646,6 +645,9 @@ export declare class DiagnosticLogger implements IDiagnosticLogger {
     unload(isAsync?: boolean): void | IPromise<void>;
 }
 
+declare function dispatchEvent_2(target: EventTarget, evnt: Event | CustomEvent): boolean;
+export { dispatchEvent_2 as dispatchEvent }
+
 /**
  * Helper function to wrap a function with a perf event
  * @param mgrSource - The Performance Manager or a Performance provider source (may be null)
@@ -670,7 +672,6 @@ export declare function doUnloadAll<T>(targets: Array<{
 }>, isAsync?: boolean, done?: () => void): void | IPromise<void>;
 
 export { dumpObj }
-
 /**
  * The eEventsDiscardedReason enumeration contains a set of values that specify the reason for discarding an event.
  */
@@ -912,7 +913,6 @@ export declare function getDebugExt(config: IConfiguration): IDbgExtension;
 export declare function getDebugListener(config: IConfiguration): INotificationListener;
 
 export { getDocument }
-
 /**
  * @internal
  * Get the dynamic config handler if the value is already dynamic
@@ -933,11 +933,8 @@ export declare function getExceptionName(object: any): string;
 export declare function getGblPerfMgr(): IPerfManager;
 
 export { getGlobal }
-
 export { getGlobalInst }
-
 export { getHistory }
-
 /**
  * Gets IE version returning the document emulation mode if we are running on IE, or null otherwise
  */
@@ -965,9 +962,7 @@ export declare function getLocation(checkForMock?: boolean): Location | null;
 export declare function getMsCrypto(): Crypto | null;
 
 export { getNavigator }
-
 export { getPerformance }
-
 /**
  * Returns the current value from the target object if not null or undefined otherwise sets the new value and returns it
  * @param target - The target object to return or set the default value
@@ -977,11 +972,8 @@ export { getPerformance }
 export declare function getSetValue<T, K extends keyof T>(target: T, field: K, defValue?: T[K]): T[K];
 
 export { getWindow }
-
 export { hasDocument }
-
 export { hasHistory }
-
 /**
  * Checks if JSON object is available, this is required as we support the API running without a
  * window /document (eg. Node server, electron webworkers) and if we attempt to assign a history
@@ -992,11 +984,8 @@ export { hasHistory }
 export declare function hasJSON(): boolean;
 
 export { hasNavigator }
-
 export { hasOwnProperty }
-
 export { hasWindow }
-
 export declare interface IAppInsightsCore<CfgType extends IConfiguration = IConfiguration> extends IPerfManagerProvider {
     readonly config: CfgType;
     /**
@@ -1468,6 +1457,11 @@ export declare interface IConfiguration {
      * Default is false
      */
     enableWParam?: boolean;
+    /**
+     * Custom optional value that will be added as a prefix for storage name.
+     * @defaultValue undefined
+     */
+    storagePrefix?: string;
 }
 
 export declare interface ICookieMgr {
@@ -2269,19 +2263,17 @@ export declare interface _IRegisteredEvents {
 }
 
 export { isArray }
-
 /**
  * Checks if HTML5 Beacons are supported in the current environment.
+ * @param useCached - [Optional] used for testing to bypass the cached lookup, when `true` this will
+ * cause the cached global to be reset.
  * @returns True if supported, false otherwise.
  */
-export declare function isBeaconsSupported(): boolean;
+export declare function isBeaconsSupported(useCached?: boolean): boolean;
 
 export { isBoolean }
-
 export { isDate }
-
 export { isError }
-
 /**
  * Checks if the Fetch API is supported in the current environment.
  * @param withKeepAlive - [Optional] If True, check if fetch is available and it supports the keepalive feature, otherwise only check if fetch is supported
@@ -2290,7 +2282,6 @@ export { isError }
 export declare function isFetchSupported(withKeepAlive?: boolean): boolean;
 
 export { isFunction }
-
 /**
  * Identifies whether the current environment appears to be IE
  */
@@ -2299,15 +2290,11 @@ export declare function isIE(): boolean;
 export declare function isNotNullOrUndefined<T>(value: T): value is T;
 
 export { isNotTruthy }
-
 export declare function isNotUndefined<T>(value: T): value is T;
 
 export { isNullOrUndefined }
-
 export { isNumber }
-
 export { isObject }
-
 /**
  * Returns whether the environment is reporting that we are running in a React Native Environment
  */
@@ -2323,15 +2310,10 @@ export declare function isSafari(userAgentStr?: string): boolean;
 export declare function isSampledFlag(value: ITraceParent): boolean;
 
 export { isString }
-
 export { isSymbol }
-
 export { isTruthy }
-
 export { isTypeof }
-
 export { isUndefined }
-
 /**
  * Is the provided W3c span id (aka. parent id) a valid string representation, it must be a 16-character
  * string of lowercase hexadecimal characters, for example, 00f067aa0ba902b7.
@@ -2724,7 +2706,6 @@ export declare class NotificationManager implements INotificationManager {
 }
 
 export { objDefineAccessors }
-
 /**
  * Pass in the objects to merge as arguments, this will only "merge" (extend) properties that are owned by the object.
  * It will NOT merge inherited or non-enumerable properties.
@@ -2740,15 +2721,10 @@ export declare function objExtend<T2, T3, T4, T5, T6>(deepExtend?: boolean, obj2
 export declare function objExtend<T1, T2, T3, T4, T5, T6>(obj1?: T1, obj2?: T2, obj3?: T3, obj4?: T4, obj5?: T5, obj6?: T6): T1 & T2 & T3 & T4 & T5 & T6;
 
 export { objForEachKey }
-
 export { objFreeze }
-
 export { objKeys }
-
 export { objSeal }
-
 export { objToString }
-
 /**
  * Watch and track changes for accesses to the current config, the provided config MUST already be
  * a dynamic config or a child accessed via the dynamic config
@@ -2822,7 +2798,7 @@ export declare class PerfManager implements IPerfManager {
      * General bucket used for execution context set and retrieved via setCtx() and getCtx.
      * Defined as private so it can be visualized via the DebugPlugin
      */
-    private ctx;
+    // private ctx;
     constructor(manager?: INotificationManager);
     /**
      * Create a new event and start timing, the manager may return null/undefined to indicate that it does not
@@ -2851,7 +2827,6 @@ export declare class PerfManager implements IPerfManager {
 }
 
 export { perfNow }
-
 /**
  * This class will be removed!
  * @deprecated use createProcessTelemetryContext() instead
@@ -3040,6 +3015,8 @@ export declare function safeGetCookieMgr(core: IAppInsightsCore, config?: IConfi
 
 export declare function safeGetLogger(core: IAppInsightsCore, config?: IConfiguration): IDiagnosticLogger;
 
+export declare function sendCustomEvent(evtName: string, cfg?: any, customDetails?: any): boolean;
+
 /**
  * The EventsDiscardedReason enumeration contains a set of values that specify the reason for discarding an event.
  */
@@ -3120,19 +3097,12 @@ export declare function sortPlugins<T = IPlugin>(plugins: T[]): T[];
 export declare function strContains(value: string, search: string): boolean;
 
 export { strEndsWith }
-
 export { strFunction }
-
 export { strObject }
-
 export { strPrototype }
-
 export { strStartsWith }
-
 export { strTrim }
-
 export { strUndefined }
-
 export declare interface Tags {
     [key: string]: any;
 }
@@ -3191,7 +3161,6 @@ export declare const enum TelemetryUpdateReason {
 export declare function throwAggregationError(message: string, sourceErrors: any[]): never;
 
 export { throwError }
-
 /**
  * This is a helper method which will call throwInternal on the passed logger, will throw exceptions in
  * debug mode or attempt to log the error as a console warning. This helper is provided mostly to better

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

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights Core Javascript SDK, 3.0.3-nightly3.2305-14
+ * Microsoft Application Insights Core Javascript SDK, 3.0.3-nightly3.2307-24
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -129,6 +129,10 @@ declare namespace ApplicationInsights {
      */
     function addPageUnloadEventListener(listener: any, excludeEvents?: string[], evtNamespace?: string | string[]): boolean;
 
+    /**
+     * @group Classes
+     * @group Entrypoint
+     */
     class AppInsightsCore<CfgType extends IConfiguration = IConfiguration> implements IAppInsightsCore<CfgType> {
         config: CfgType;
         logger: IDiagnosticLogger;
@@ -280,16 +284,11 @@ declare namespace ApplicationInsights {
 
     function areCookiesSupported(logger?: IDiagnosticLogger): any;
 
-    export { arrForEach }
-
-    export { arrIndexOf }
-
-    export { arrMap }
-
-    export { arrReduce }
-
-    export { asString }
-
+    
+    
+    
+    
+    
     /**
      * Binds the specified function to an event, so that the function gets called whenever the event fires on the object
      * @param obj - Object to add the event too.
@@ -509,6 +508,8 @@ declare namespace ApplicationInsights {
 
     function createCookieMgr(rootConfig?: IConfiguration, logger?: IDiagnosticLogger): ICookieMgr;
 
+    function createCustomDomEvent(eventName: string, details?: any): CustomEvent;
+
     /**
      * Create or return a dynamic version of the passed config, if it is not already dynamic
      * @param config - The config to be converted into a dynamic config
@@ -570,10 +571,8 @@ declare namespace ApplicationInsights {
         [key in keyof E]: [E[keyof E], V[keyof V]];
     }) => V;
 
-    export { dateNow }
-
-    export { deepFreeze }
-
+    
+    
     /**
      * Removes an event handler for the specified event
      * @param Object - to remove the event from
@@ -641,6 +640,9 @@ declare namespace ApplicationInsights {
         unload(isAsync?: boolean): void | IPromise<void>;
     }
 
+    function dispatchEvent_2(target: EventTarget, evnt: Event | CustomEvent): boolean;
+    const dispatchEvent: typeof dispatchEvent_2;
+
     /**
      * Helper function to wrap a function with a perf event
      * @param mgrSource - The Performance Manager or a Performance provider source (may be null)
@@ -664,8 +666,7 @@ declare namespace ApplicationInsights {
         unload?: (isAsync?: boolean) => T | IPromise<T>;
     }>, isAsync?: boolean, done?: () => void): void | IPromise<void>;
 
-    export { dumpObj }
-
+    
     /**
      * The eEventsDiscardedReason enumeration contains a set of values that specify the reason for discarding an event.
      */
@@ -906,8 +907,7 @@ declare namespace ApplicationInsights {
 
     function getDebugListener(config: IConfiguration): INotificationListener;
 
-    export { getDocument }
-
+    
     /**
      * @internal
      * Get the dynamic config handler if the value is already dynamic
@@ -927,12 +927,9 @@ declare namespace ApplicationInsights {
      */
     function getGblPerfMgr(): IPerfManager;
 
-    export { getGlobal }
-
-    export { getGlobalInst }
-
-    export { getHistory }
-
+    
+    
+    
     /**
      * Gets IE version returning the document emulation mode if we are running on IE, or null otherwise
      */
@@ -959,10 +956,8 @@ declare namespace ApplicationInsights {
      */
     function getMsCrypto(): Crypto | null;
 
-    export { getNavigator }
-
-    export { getPerformance }
-
+    
+    
     /**
      * Returns the current value from the target object if not null or undefined otherwise sets the new value and returns it
      * @param target - The target object to return or set the default value
@@ -971,12 +966,9 @@ declare namespace ApplicationInsights {
      */
     function getSetValue<T, K extends keyof T>(target: T, field: K, defValue?: T[K]): T[K];
 
-    export { getWindow }
-
-    export { hasDocument }
-
-    export { hasHistory }
-
+    
+    
+    
     /**
      * Checks if JSON object is available, this is required as we support the API running without a
      * window /document (eg. Node server, electron webworkers) and if we attempt to assign a history
@@ -986,12 +978,9 @@ declare namespace ApplicationInsights {
      */
     function hasJSON(): boolean;
 
-    export { hasNavigator }
-
-    export { hasOwnProperty }
-
-    export { hasWindow }
-
+    
+    
+    
     interface IAppInsightsCore<CfgType extends IConfiguration = IConfiguration> extends IPerfManagerProvider {
         readonly config: CfgType;
         /**
@@ -1463,6 +1452,11 @@ declare namespace ApplicationInsights {
          * Default is false
          */
         enableWParam?: boolean;
+        /**
+         * Custom optional value that will be added as a prefix for storage name.
+         * @defaultValue undefined
+         */
+        storagePrefix?: string;
     }
 
     interface ICookieMgr {
@@ -2263,20 +2257,18 @@ declare namespace ApplicationInsights {
         handler: any;
     }
 
-    export { isArray }
-
+    
     /**
      * Checks if HTML5 Beacons are supported in the current environment.
+     * @param useCached - [Optional] used for testing to bypass the cached lookup, when `true` this will
+     * cause the cached global to be reset.
      * @returns True if supported, false otherwise.
      */
-    function isBeaconsSupported(): boolean;
-
-    export { isBoolean }
-
-    export { isDate }
-
-    export { isError }
+    function isBeaconsSupported(useCached?: boolean): boolean;
 
+    
+    
+    
     /**
      * Checks if the Fetch API is supported in the current environment.
      * @param withKeepAlive - [Optional] If True, check if fetch is available and it supports the keepalive feature, otherwise only check if fetch is supported
@@ -2284,8 +2276,7 @@ declare namespace ApplicationInsights {
      */
     function isFetchSupported(withKeepAlive?: boolean): boolean;
 
-    export { isFunction }
-
+    
     /**
      * Identifies whether the current environment appears to be IE
      */
@@ -2293,16 +2284,12 @@ declare namespace ApplicationInsights {
 
     function isNotNullOrUndefined<T>(value: T): value is T;
 
-    export { isNotTruthy }
-
+    
     function isNotUndefined<T>(value: T): value is T;
 
-    export { isNullOrUndefined }
-
-    export { isNumber }
-
-    export { isObject }
-
+    
+    
+    
     /**
      * Returns whether the environment is reporting that we are running in a React Native Environment
      */
@@ -2317,16 +2304,11 @@ declare namespace ApplicationInsights {
      */
     function isSampledFlag(value: ITraceParent): boolean;
 
-    export { isString }
-
-    export { isSymbol }
-
-    export { isTruthy }
-
-    export { isTypeof }
-
-    export { isUndefined }
-
+    
+    
+    
+    
+    
     /**
      * Is the provided W3c span id (aka. parent id) a valid string representation, it must be a 16-character
      * string of lowercase hexadecimal characters, for example, 00f067aa0ba902b7.
@@ -2718,8 +2700,7 @@ declare namespace ApplicationInsights {
         unload?(isAsync?: boolean): void | IPromise<void>;
     }
 
-    export { objDefineAccessors }
-
+    
     /**
      * Pass in the objects to merge as arguments, this will only "merge" (extend) properties that are owned by the object.
      * It will NOT merge inherited or non-enumerable properties.
@@ -2734,16 +2715,11 @@ declare namespace ApplicationInsights {
 
     function objExtend<T1, T2, T3, T4, T5, T6>(obj1?: T1, obj2?: T2, obj3?: T3, obj4?: T4, obj5?: T5, obj6?: T6): T1 & T2 & T3 & T4 & T5 & T6;
 
-    export { objForEachKey }
-
-    export { objFreeze }
-
-    export { objKeys }
-
-    export { objSeal }
-
-    export { objToString }
-
+    
+    
+    
+    
+    
     /**
      * Watch and track changes for accesses to the current config, the provided config MUST already be
      * a dynamic config or a child accessed via the dynamic config
@@ -2817,7 +2793,7 @@ declare namespace ApplicationInsights {
          * General bucket used for execution context set and retrieved via setCtx() and getCtx.
          * Defined as private so it can be visualized via the DebugPlugin
          */
-        private ctx;
+        // private ctx;
         constructor(manager?: INotificationManager);
         /**
          * Create a new event and start timing, the manager may return null/undefined to indicate that it does not
@@ -2845,8 +2821,7 @@ declare namespace ApplicationInsights {
         getCtx(key: string): any;
     }
 
-    export { perfNow }
-
+    
     /**
      * This class will be removed!
      * @deprecated use createProcessTelemetryContext() instead
@@ -3035,6 +3010,8 @@ declare namespace ApplicationInsights {
 
     function safeGetLogger(core: IAppInsightsCore, config?: IConfiguration): IDiagnosticLogger;
 
+    function sendCustomEvent(evtName: string, cfg?: any, customDetails?: any): boolean;
+
     /**
      * The EventsDiscardedReason enumeration contains a set of values that specify the reason for discarding an event.
      */
@@ -3114,20 +3091,13 @@ declare namespace ApplicationInsights {
      */
     function strContains(value: string, search: string): boolean;
 
-    export { strEndsWith }
-
-    export { strFunction }
-
-    export { strObject }
-
-    export { strPrototype }
-
-    export { strStartsWith }
-
-    export { strTrim }
-
-    export { strUndefined }
-
+    
+    
+    
+    
+    
+    
+    
     interface Tags {
         [key: string]: any;
     }
@@ -3185,8 +3155,7 @@ declare namespace ApplicationInsights {
      */
     function throwAggregationError(message: string, sourceErrors: any[]): never;
 
-    export { throwError }
-
+    
     /**
      * This is a helper method which will call throwInternal on the passed logger, will throw exceptions in
      * debug mode or attempt to log the error as a console warning. This helper is provided mostly to better