@microsoft/applicationinsights-web-basic 3.0.0-beta.2208-03 → 3.0.0-beta.2208-16

package/dist/applicationinsights-web-basic.d.ts

@@ -1,5 +1,5 @@
 /*
- * Microsoft.ApplicationInsights, 3.0.0-beta.2208-03
+ * Microsoft.ApplicationInsights, 3.0.0-beta.2208-16
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -7,6 +7,11 @@
  */
 
 declare namespace ApplicationInsights {
+    import { arrForEach } from '@nevware21/ts-utils';
+    import { EnumCls } from '@nevware21/ts-utils';
+    import { isNullOrUndefined } from '@nevware21/ts-utils';
+    import { throwError } from '@nevware21/ts-utils';
+
     class AppInsightsCore extends BaseCore implements IAppInsightsCore {
         constructor();
         initialize(config: IConfiguration, extensions: IPlugin[], logger?: IDiagnosticLogger, notificationManager?: INotificationManager): void;
@@ -79,15 +84,7 @@ declare namespace ApplicationInsights {
         addUnloadCb(handler: UnloadHandler): void;
     }
 
-    /**
-     * Performs the specified action for each element in an array. This helper exists to avoid adding a polyfil for older browsers
-     * that do not define Array.prototype.xxxx (eg. ES3 only, IE8) just in case any page checks for presence/absence of the prototype
-     * implementation. Note: For consistency this will not use the Array.prototype.xxxx implementation if it exists as this would
-     * cause a testing requirement to test with and without the implementations
-     * @param callbackfn  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. It can return -1 to break out of the loop
-     * @param thisArg  [Optional] An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
-     */
-    function arrForEach<T = any>(arr: T[], callbackfn: (value: T, index?: number, array?: T[]) => undefined | void | number, thisArg?: any): void;
+    export { arrForEach }
 
     class BaseCore implements IAppInsightsCore {
         static defaultConfig: IConfiguration;
@@ -290,14 +287,6 @@ declare namespace ApplicationInsights {
         protected _addHook(hooks: IInstrumentHook | IInstrumentHook[]): void;
     }
 
-    /**
-     * Provides a collection of utility functions, included for backward compatibility with previous releases.
-     * @deprecated Marking this instance as deprecated in favor of direct usage of the helper functions
-     * as direct usage provides better tree-shaking and minification by avoiding the inclusion of the unused items
-     * in your resulting code.
-     */
-    const CoreUtils: ICoreUtils;
-
     const DistributedTracingModes: EnumValue<typeof eDistributedTracingModes>;
 
     type DistributedTracingModes = number | eDistributedTracingModes;
@@ -414,9 +403,7 @@ declare namespace ApplicationInsights {
         WARNING = 2
     }
 
-    type EnumValue<E = any> = {
-        readonly [key in keyof E]: E[key];
-    };
+    type EnumValue<E = any> = EnumCls<E>;
 
     /**
      * Defines the level of severity for the event.
@@ -1246,195 +1233,6 @@ declare namespace ApplicationInsights {
         delCookie?: (name: string, cookieValue: string) => void;
     }
 
-    /**
-     * Provides a collection of utility functions, included for backward compatibility with previous releases.
-     * @deprecated Marking this interface and instance as deprecated in favor of direct usage of the helper functions
-     * as direct usage provides better tree-shaking and minification by avoiding the inclusion of the unused items
-     * in your resulting code.
-     */
-    interface ICoreUtils {
-        /**
-         * Internal - Do not use directly.
-         * @deprecated Direct usage of this property is not recommend
-         */
-        _canUseCookies: boolean;
-        isTypeof: (value: any, theType: string) => boolean;
-        isUndefined: (value: any) => boolean;
-        isNullOrUndefined: (value: any) => boolean;
-        hasOwnProperty: (obj: any, prop: string) => boolean;
-        /**
-         * Checks if the passed of value is a function.
-         * @param {any} value - Value to be checked.
-         * @return {boolean} True if the value is a boolean, false otherwise.
-         */
-        isFunction: (value: any) => value is Function;
-        /**
-         * Checks if the passed of value is a function.
-         * @param {any} value - Value to be checked.
-         * @return {boolean} True if the value is a boolean, false otherwise.
-         */
-        isObject: (value: any) => boolean;
-        /**
-         * Check if an object is of type Date
-         */
-        isDate: (obj: any) => obj is Date;
-        /**
-         * Check if an object is of type Array
-         */
-        isArray: (obj: any) => boolean;
-        /**
-         * Check if an object is of type Error
-         */
-        isError: (obj: any) => obj is Error;
-        /**
-         * Checks if the type of value is a string.
-         * @param {any} value - Value to be checked.
-         * @return {boolean} True if the value is a string, false otherwise.
-         */
-        isString: (value: any) => value is string;
-        /**
-         * Checks if the type of value is a number.
-         * @param {any} value - Value to be checked.
-         * @return {boolean} True if the value is a number, false otherwise.
-         */
-        isNumber: (value: any) => value is number;
-        /**
-         * Checks if the type of value is a boolean.
-         * @param {any} value - Value to be checked.
-         * @return {boolean} True if the value is a boolean, false otherwise.
-         */
-        isBoolean: (value: any) => value is boolean;
-        /**
-         * Convert a date to I.S.O. format in IE8
-         */
-        toISOString: (date: Date) => string;
-        /**
-         * Performs the specified action for each element in an array. This helper exists to avoid adding a polyfil for older browsers
-         * that do not define Array.prototype.xxxx (eg. ES3 only, IE8) just in case any page checks for presence/absence of the prototype
-         * implementation. Note: For consistency this will not use the Array.prototype.xxxx implementation if it exists as this would
-         * cause a testing requirement to test with and without the implementations
-         * @param callbackfn  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. It can return -1 to break out of the loop
-         * @param thisArg  [Optional] An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
-         */
-        arrForEach: <T>(arr: T[], callbackfn: (value: T, index?: number, array?: T[]) => void | number, thisArg?: any) => void;
-        /**
-         * Returns the index of the first occurrence of a value in an array. This helper exists to avoid adding a polyfil for older browsers
-         * that do not define Array.prototype.xxxx (eg. ES3 only, IE8) just in case any page checks for presence/absence of the prototype
-         * implementation. Note: For consistency this will not use the Array.prototype.xxxx implementation if it exists as this would
-         * cause a testing requirement to test with and without the implementations
-         * @param searchElement The value to locate in the array.
-         * @param fromIndex The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
-         */
-        arrIndexOf: <T>(arr: T[], searchElement: T, fromIndex?: number) => number;
-        /**
-         * Calls a defined callback function on each element of an array, and returns an array that contains the results. This helper exists
-         * to avoid adding a polyfil for older browsers that do not define Array.prototype.xxxx (eg. ES3 only, IE8) just in case any page
-         * checks for presence/absence of the prototype implementation. Note: For consistency this will not use the Array.prototype.xxxx
-         * implementation if it exists as this would cause a testing requirement to test with and without the implementations
-         * @param callbackfn A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
-         * @param thisArg An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
-         */
-        arrMap: <T, R>(arr: T[], callbackfn: (value: T, index?: number, array?: T[]) => R, thisArg?: any) => R[];
-        /**
-         * Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is
-         * provided as an argument in the next call to the callback function. This helper exists to avoid adding a polyfil for older browsers that do not define
-         * Array.prototype.xxxx (eg. ES3 only, IE8) just in case any page checks for presence/absence of the prototype implementation. Note: For consistency
-         * this will not use the Array.prototype.xxxx implementation if it exists as this would cause a testing requirement to test with and without the implementations
-         * @param callbackfn A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
-         * @param initialValue If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
-         */
-        arrReduce: <T, R>(arr: T[], callbackfn: (previousValue: T | R, currentValue?: T, currentIndex?: number, array?: T[]) => R, initialValue?: R) => R;
-        /**
-         * helper method to trim strings (IE8 does not implement String.prototype.trim)
-         */
-        strTrim: (str: any) => string;
-        /**
-         * Creates an object that has the specified prototype, and that optionally contains specified properties. This helper exists to avoid adding a polyfil
-         * for older browsers that do not define Object.create eg. ES3 only, IE8 just in case any page checks for presence/absence of the prototype implementation.
-         * Note: For consistency this will not use the Object.create implementation if it exists as this would cause a testing requirement to test with and without the implementations
-         * @param obj Object to use as a prototype. May be null
-         */
-        objCreate: (obj: object) => any;
-        /**
-         * Returns the names of the enumerable string properties and methods of an object. This helper exists to avoid adding a polyfil for older browsers
-         * that do not define Object.keys eg. ES3 only, IE8 just in case any page checks for presence/absence of the prototype implementation.
-         * Note: For consistency this will not use the Object.keys implementation if it exists as this would cause a testing requirement to test with and without the implementations
-         * @param obj Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
-         */
-        objKeys: (obj: {}) => string[];
-        /**
-         * Try to define get/set object property accessors for the target object/prototype, this will provide compatibility with
-         * existing API definition when run within an ES5+ container that supports accessors but still enable the code to be loaded
-         * and executed in an ES3 container, providing basic IE8 compatibility.
-         * @param target The object on which to define the property.
-         * @param prop The name of the property to be defined or modified.
-         * @param getProp The getter function to wire against the getter.
-         * @param setProp The setter function to wire against the setter.
-         * @returns True if it was able to create the accessors otherwise false
-         */
-        objDefineAccessors: <T>(target: any, prop: string, getProp?: () => T, setProp?: (v: T) => void) => boolean;
-        /**
-         * Trys to add an event handler for the specified event to the window, body and document
-         * @param eventName {string} - The name of the event
-         * @param callback {any} - The callback function that needs to be executed for the given event
-         * @return {boolean} - true if the handler was successfully added
-         */
-        addEventHandler: (eventName: string, callback: any, evtNamespace?: string | string[]) => boolean;
-        /**
-         * 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
-         */
-        dateNow: () => number;
-        /**
-         * Identifies whether the current environment appears to be IE
-         */
-        isIE: () => boolean;
-        /**
-         * @deprecated - Use the core.getCookieMgr().disable()
-         * Force the SDK not to store and read any data from cookies.
-         */
-        disableCookies: () => void;
-        newGuid: () => string;
-        /**
-         * Return the current value of the Performance Api now() function (if available) and fallback to dateNow() if it is unavailable (IE9 or less)
-         * https://caniuse.com/#search=performance.now
-         */
-        perfNow: () => number;
-        /**
-         * Generate random base64 id string.
-         * The default length is 22 which is 132-bits so almost the same as a GUID but as base64 (the previous default was 5)
-         * @param maxLength - Optional value to specify the length of the id to be generated, defaults to 22
-         */
-        newId: (maxLength?: number) => string;
-        /**
-         * Generate a random value between 0 and maxValue, max value should be limited to a 32-bit maximum.
-         * So maxValue(16) will produce a number from 0..16 (range of 17)
-         * @param maxValue
-         */
-        randomValue: (maxValue: number) => number;
-        /**
-         * generate a random 32-bit number (0x000000..0xFFFFFFFF) or (-0x80000000..0x7FFFFFFF), defaults un-unsigned.
-         * @param signed - True to return a signed 32-bit number (-0x80000000..0x7FFFFFFF) otherwise an unsigned one (0x000000..0xFFFFFFFF)
-         */
-        random32: (signed?: boolean) => number;
-        /**
-         * Seed the MWC random number generator with the specified seed or a random value
-         * @param value - optional the number to used as the seed, if undefined, null or zero a random value will be chosen
-         */
-        mwcRandomSeed: (value?: number) => void;
-        /**
-         * Generate a random 32-bit number between (0x000000..0xFFFFFFFF) or (-0x80000000..0x7FFFFFFF), using MWC (Multiply with carry)
-         * instead of Math.random() defaults to un-signed.
-         * Used as a replacement random generator for IE to avoid issues with older IE instances.
-         * @param signed - True to return a signed 32-bit number (-0x80000000..0x7FFFFFFF) otherwise an unsigned one (0x000000..0xFFFFFFFF)
-         */
-        mwcRandom32: (signed?: boolean) => number;
-        /**
-         * generate W3C trace id
-         */
-        generateW3CId: () => string;
-    }
-
     interface ICustomProperties {
         [key: string]: any;
     }
@@ -2064,6 +1862,12 @@ declare namespace ApplicationInsights {
          * Plugin version (available in data.properties.version in common schema)
          */
         readonly version?: string;
+        /**
+         * The App Insights core to use for backward compatibility.
+         * Therefore the interface will be able to access the core without needing to cast to "any".
+         * [optional] any 3rd party plugins which are already implementing this interface don't fail to compile.
+         */
+        core?: IAppInsightsCore;
     }
 
     /**
@@ -2263,7 +2067,7 @@ declare namespace ApplicationInsights {
         aiDataContract: any;
     }
 
-    function isNullOrUndefined(value: any): value is null | undefined;
+    export { isNullOrUndefined }
 
     interface IStackDetails {
         src: string;
@@ -2623,7 +2427,7 @@ declare namespace ApplicationInsights {
         PluginRemoved = 32
     }
 
-    function throwError(message: string): never;
+    export { throwError }
 
     type UnloadHandler = (itemCtx: IProcessTelemetryUnloadContext, unloadState: ITelemetryUnloadState) => void;