@microsoft/applicationinsights-core-js 3.4.0-nightlybeta3.2504-05 → 3.4.0-nightlybeta3.2504-17

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

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights Core Javascript SDK, 3.4.0-nightlybeta3.2504-05
+ * Microsoft Application Insights Core Javascript SDK, 3.4.0-nightlybeta3.2504-17
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -195,6 +195,7 @@ export declare class AppInsightsCore<CfgType extends IConfiguration = IConfigura
      */
     setCookieMgr(cookieMgr: ICookieMgr): void;
     getPerfMgr(): IPerfManager;
+    getStatsBeat(statsBeatConfig?: IStatsBeatConfig): IStatsBeat;
     setPerfMgr(perfMgr: IPerfManager): void;
     eventCnt(): number;
     /**
@@ -1200,6 +1201,7 @@ export declare interface IAppInsightsCore<CfgType extends IConfiguration = IConf
      */
     addTelemetryInitializer(telemetryInitializer: TelemetryInitializerFunction): ITelemetryInitializerHandler;
     pollInternalLogs?(eventName?: string): ITimerHandler;
+    getStatsBeat?(statsBeatConfig?: IStatsBeatConfig): IStatsBeat;
     stopPollingInternalLogs?(): void;
     /**
      * Return a new instance of the IProcessTelemetryContext for processing events
@@ -1681,6 +1683,11 @@ export declare interface IConfiguration {
      * @since 3.3.2
      */
     expCfg?: IExceptionConfig;
+    /**
+     * [Optional] Internal SDK configuration for developers
+     * @internal
+     */
+    _sdk?: IInternalSdkConfiguration;
 }
 
 export declare interface ICookieMgr {
@@ -2207,6 +2214,18 @@ export declare interface IInternalOfflineSupport {
     createOneDSPayload?: (evts: ITelemetryItem[]) => IPayloadData;
 }
 
+/**
+ * Internal SDK configuration options
+ * @internal
+ */
+declare interface IInternalSdkConfiguration {
+    /**
+     * [Optional] Enable Internal StatsBeat
+     * @internal
+     */
+    stats?: boolean;
+}
+
 /**
  * Internal interface
  * internal sendpost interface
@@ -2861,6 +2880,28 @@ export { isString }
 
 export { isSymbol }
 
+export declare interface IStatsBeat {
+    initialize(core: IAppInsightsCore, statsBeatConfig: IStatsBeatConfig): void;
+    isInitialized(): boolean;
+    count(status: number, payloadData: IPayloadData, endpoint: string): void;
+    countException(endpoint: string, exceptionType: string): void;
+    getEndpoint(): string;
+}
+
+export declare interface IStatsBeatConfig {
+    ikey: string;
+    endpoint: string;
+    version?: string;
+}
+
+/**
+ * This interface identifies the details of stats beat event
+ */
+export declare interface IStatsBeatEvent {
+    startTime: number;
+    duration?: number;
+}
+
 export { isTruthy }
 
 export { isTypeof }

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

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights Core Javascript SDK, 3.4.0-nightlybeta3.2504-05
+ * Microsoft Application Insights Core Javascript SDK, 3.4.0-nightlybeta3.2504-17
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -137,6 +137,7 @@ declare namespace ApplicationInsights {
          */
         setCookieMgr(cookieMgr: ICookieMgr): void;
         getPerfMgr(): IPerfManager;
+        getStatsBeat(statsBeatConfig?: IStatsBeatConfig): IStatsBeat;
         setPerfMgr(perfMgr: IPerfManager): void;
         eventCnt(): number;
         /**
@@ -305,6 +306,7 @@ declare namespace ApplicationInsights {
      * or -1 if it is not present.
      * `arrIndexOf()` compares searchElement to elements of the Array using strict equality (the same
      * method used by the === or triple-equals operator).
+     * @function
      * @group Array
      * @group ArrayLike
      * @typeParam T - Identifies the type of array elements
@@ -381,6 +383,7 @@ declare namespace ApplicationInsights {
      * - indexes that have never been set;
      * - indexes which have been deleted.
      *
+     * @function
      * @since 0.3.3
      * @group Array
      * @group ArrayLike
@@ -444,6 +447,7 @@ declare namespace ApplicationInsights {
      * The first time that the callback is run there is no "return value of the previous calculation". If supplied,
      * an initial value may be used in its place. Otherwise the array element at index 0 is used as the initial
      * value and iteration starts from the next element (index 1 instead of index 0).
+     * @function
      * @group Array
      * @group ArrayLike
      * @typeParam T - Identifies the type of array elements
@@ -502,6 +506,7 @@ declare namespace ApplicationInsights {
      * The asString() method returns a string representing the value by
      * explicitly using `String(`value`)`.
      *
+     * @function
      * @since 0.4.3
      * @group String
      * @group Conversion
@@ -860,6 +865,7 @@ declare namespace ApplicationInsights {
     /**
      * Perform a deep freeze on the object and all of it's contained values / properties by recursively calling
      * `objFreeze()` on all enumerable properties of the object and on each property returned.
+     * This implementation handles recursive objects (objects that reference themselves) by tracking visited objects.
      * @group Object
      * @param value - the object to be completly frozen.
      * @returns The originally passed in object.
@@ -1352,6 +1358,7 @@ declare namespace ApplicationInsights {
 
     /**
      * Return the global `document` instance.
+     * @function
      * @group Environment
      * @returns
      */
@@ -1418,6 +1425,7 @@ declare namespace ApplicationInsights {
 
     /**
      * Returns the global `history` instance
+     * @function
      * @group Environment
      * @returns
      */
@@ -1451,6 +1459,7 @@ declare namespace ApplicationInsights {
 
     /**
      * Returns the global `navigator` instance
+     * @function
      * @group Environment
      * @returns
      */
@@ -1480,6 +1489,7 @@ declare namespace ApplicationInsights {
 
     /**
      * Return the global `window` instance.
+     * @function
      * @group Environment
      * @returns
      */
@@ -1609,6 +1619,7 @@ declare namespace ApplicationInsights {
          */
         addTelemetryInitializer(telemetryInitializer: TelemetryInitializerFunction): ITelemetryInitializerHandler;
         pollInternalLogs?(eventName?: string): ITimerHandler;
+        getStatsBeat?(statsBeatConfig?: IStatsBeatConfig): IStatsBeat;
         stopPollingInternalLogs?(): void;
         /**
          * Return a new instance of the IProcessTelemetryContext for processing events
@@ -2090,6 +2101,11 @@ declare namespace ApplicationInsights {
          * @since 3.3.2
          */
         expCfg?: IExceptionConfig;
+        /**
+         * [Optional] Internal SDK configuration for developers
+         * @internal
+         */
+        _sdk?: IInternalSdkConfiguration;
     }
 
     interface ICookieMgr {
@@ -2616,6 +2632,18 @@ declare namespace ApplicationInsights {
         createOneDSPayload?: (evts: ITelemetryItem[]) => IPayloadData;
     }
 
+    /**
+     * Internal SDK configuration options
+     * @internal
+     */
+    interface IInternalSdkConfiguration {
+        /**
+         * [Optional] Enable Internal StatsBeat
+         * @internal
+         */
+        stats?: boolean;
+    }
+
     /**
      * Internal interface
      * internal sendpost interface
@@ -3268,6 +3296,7 @@ declare namespace ApplicationInsights {
     /**
      * Checks if the type of value is an Array.
      *
+     * @function
      * @group Type Identity
      * @group Array
      * @param arg - Value to be checked.
@@ -3297,6 +3326,7 @@ declare namespace ApplicationInsights {
 
     /**
      * Checks if the type of value is a boolean.
+     * @function
      * @group Type Identity
      * @param value - Value to be checked.
      * @return True if the value is a boolean, false otherwise.
@@ -3305,6 +3335,7 @@ declare namespace ApplicationInsights {
 
     /**
      * Check if an object is of type Date
+     * @function
      * @group Type Identity
      * @example
      * ```ts
@@ -3447,6 +3478,7 @@ declare namespace ApplicationInsights {
 
     /**
      * Checks if the type of value is a Error object.
+     * @function
      * @group Type Identity
      * @group Error
      * @param value - Value to be checked.
@@ -3465,6 +3497,7 @@ declare namespace ApplicationInsights {
 
     /**
      * Checks to see if the past value is a function value
+     * @function
      * @group Type Identity
      * @param value - The value to check
      * @returns
@@ -3533,6 +3566,7 @@ declare namespace ApplicationInsights {
 
     /**
      * Checks if the type of value is a number.
+     * @function
      * @group Type Identity
      * @param value - Value to be checked.
      * @return True if the value is a number, false otherwise.
@@ -3541,6 +3575,7 @@ declare namespace ApplicationInsights {
 
     /**
      * Checks to see if the past value is an object value
+     * @function
      * @group Type Identity
      * @group Object
      * @typeParam T - The object type, defaults to any
@@ -3565,6 +3600,7 @@ declare namespace ApplicationInsights {
 
     /**
      * Checks to see if the past value is a string value
+     * @function
      * @group Type Identity
      * @group String
      * @param value - The value to check
@@ -3585,12 +3621,36 @@ declare namespace ApplicationInsights {
 
     /**
      * Checks if the type of value is a symbol.
+     *
+     * @function
      * @group Symbol
      * @param value - Value to be checked.
      * @return True if the value is a symbol, false otherwise.
      */
     const isSymbol: (value: any) => value is symbol;
 
+    interface IStatsBeat {
+        initialize(core: IAppInsightsCore, statsBeatConfig: IStatsBeatConfig): void;
+        isInitialized(): boolean;
+        count(status: number, payloadData: IPayloadData, endpoint: string): void;
+        countException(endpoint: string, exceptionType: string): void;
+        getEndpoint(): string;
+    }
+
+    interface IStatsBeatConfig {
+        ikey: string;
+        endpoint: string;
+        version?: string;
+    }
+
+    /**
+     * This interface identifies the details of stats beat event
+     */
+    interface IStatsBeatEvent {
+        startTime: number;
+        duration?: number;
+    }
+
     /**
      * Checks if the type of value evaluates to true value, handling some special
      * case usages of Boolean(true/false) and new Boolean(true/false).
@@ -4284,6 +4344,7 @@ declare namespace ApplicationInsights {
      * to or removed from the array.
      *
      * `objFreeze()` returns the same object that was passed into the function. It does not create a frozen copy.
+     * @function
      * @group Object
      * @param value - The object to freeze.
      * @returns The object that was passed to the function.
@@ -4297,6 +4358,7 @@ declare namespace ApplicationInsights {
      * objKeys() returns an array whose elements are strings corresponding to the enumerable properties found
      * directly upon object. The ordering of the properties is the same as that given by looping over the
      * properties of the object manually.
+     * @function
      * @group Object
      * @param value - The object to obtain a copy of the keys from
      * @returns An array of the properties names for the value object.
@@ -4330,6 +4392,7 @@ declare namespace ApplicationInsights {
      * The `objSeal()` method seals an object, preventing new properties from being added to it and marking all
      * existing properties as non-configurable. Values of present properties can still be changed as long as they
      * are writable.
+     * @function
      * @group Object
      * @param value - The object which should be sealed.
      * @returns The object being sealed.
@@ -4832,6 +4895,7 @@ declare namespace ApplicationInsights {
 
     /**
      * This method lets you determine whether or not a string ends with another string. This method is case-sensitive.
+     * @function
      * @group String
      * @param value - The value to be checked
      * @param searchString - The characters to be searched for at the end of `value` string.
@@ -4847,6 +4911,7 @@ declare namespace ApplicationInsights {
 
     /**
      * This method lets you determine whether or not a string begins with another string. This method is case-sensitive.
+     * @function
      * @group String
      * @param value - The value to be checked
      * @param searchString - The characters to be searched for at the start of the string
@@ -4861,6 +4926,8 @@ declare namespace ApplicationInsights {
      * without modifying the original string. Whitespace in this context is all the whitespace
      * characters (space, tab, no-break space, etc.) and all the line terminator characters
      * (LF, CR, etc.).
+     *
+     * @function
      * @group String
      * @param value - The string value to be trimmed.
      * @returns A new string representing str stripped of whitespace from both its beginning and end.