@microsoft/applicationinsights-core-js 3.3.5-nightly3.2411-14 → 3.3.5-nightly3.2412-01
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/browser/es5/applicationinsights-core-js.cjs.js +2 -2
- package/browser/es5/applicationinsights-core-js.cjs.js.map +1 -1
- package/browser/es5/applicationinsights-core-js.cjs.min.js +2 -2
- package/browser/es5/applicationinsights-core-js.cjs.min.js.map +1 -1
- package/browser/es5/applicationinsights-core-js.gbl.js +4 -4
- package/browser/es5/applicationinsights-core-js.gbl.js.map +1 -1
- package/browser/es5/applicationinsights-core-js.gbl.min.js +2 -2
- package/browser/es5/applicationinsights-core-js.gbl.min.js.map +1 -1
- package/browser/es5/applicationinsights-core-js.integrity.json +25 -25
- package/browser/es5/applicationinsights-core-js.js +4 -4
- package/browser/es5/applicationinsights-core-js.js.map +1 -1
- package/browser/es5/applicationinsights-core-js.min.js +2 -2
- package/browser/es5/applicationinsights-core-js.min.js.map +1 -1
- package/dist/es5/applicationinsights-core-js.js +2 -2
- package/dist/es5/applicationinsights-core-js.js.map +1 -1
- package/dist/es5/applicationinsights-core-js.min.js +2 -2
- package/dist/es5/applicationinsights-core-js.min.js.map +1 -1
- package/dist-es5/Config/ConfigDefaultHelpers.js +1 -1
- package/dist-es5/Config/ConfigDefaults.js +1 -1
- package/dist-es5/Config/DynamicConfig.js +1 -4
- package/dist-es5/Config/DynamicConfig.js.map +1 -1
- package/dist-es5/Config/DynamicProperty.js +1 -1
- package/dist-es5/Config/DynamicState.js +1 -1
- package/dist-es5/Config/DynamicSupport.js +1 -2
- package/dist-es5/Config/DynamicSupport.js.map +1 -1
- package/dist-es5/Config/IConfigDefaults.js +1 -1
- package/dist-es5/Config/IDynamicConfigHandler.js +1 -1
- package/dist-es5/Config/IDynamicPropertyHandler.js +1 -1
- package/dist-es5/Config/IDynamicWatcher.js +1 -1
- package/dist-es5/Config/_IDynamicConfigHandlerState.js +1 -1
- package/dist-es5/JavaScriptSDK/AggregationError.js +1 -1
- package/dist-es5/JavaScriptSDK/AppInsightsCore.js +1 -1
- package/dist-es5/JavaScriptSDK/AsyncUtils.js +1 -1
- package/dist-es5/JavaScriptSDK/BaseTelemetryPlugin.js +1 -1
- package/dist-es5/JavaScriptSDK/Constants.js +1 -1
- package/dist-es5/JavaScriptSDK/CookieMgr.js +3 -3
- package/dist-es5/JavaScriptSDK/CookieMgr.js.map +1 -1
- package/dist-es5/JavaScriptSDK/CoreUtils.js +1 -1
- package/dist-es5/JavaScriptSDK/DataCacheHelper.js +2 -2
- package/dist-es5/JavaScriptSDK/DataCacheHelper.js.map +1 -1
- package/dist-es5/JavaScriptSDK/DbgExtensionUtils.js +1 -1
- package/dist-es5/JavaScriptSDK/DiagnosticLogger.js +1 -1
- package/dist-es5/JavaScriptSDK/EnvUtils.js +4 -4
- package/dist-es5/JavaScriptSDK/EnvUtils.js.map +1 -1
- package/dist-es5/JavaScriptSDK/EventHelpers.js +1 -1
- package/dist-es5/JavaScriptSDK/HelperFuncs.js +1 -1
- package/dist-es5/JavaScriptSDK/InstrumentHooks.js +1 -1
- package/dist-es5/JavaScriptSDK/InternalConstants.js +1 -1
- package/dist-es5/JavaScriptSDK/NotificationManager.js +1 -1
- package/dist-es5/JavaScriptSDK/PerfManager.js +1 -1
- package/dist-es5/JavaScriptSDK/ProcessTelemetryContext.js +1 -1
- package/dist-es5/JavaScriptSDK/RandomHelper.js +2 -2
- package/dist-es5/JavaScriptSDK/RandomHelper.js.map +1 -1
- package/dist-es5/JavaScriptSDK/ResponseHelpers.js +1 -1
- package/dist-es5/JavaScriptSDK/SenderPostManager.js +1 -1
- package/dist-es5/JavaScriptSDK/TelemetryHelpers.js +1 -1
- package/dist-es5/JavaScriptSDK/TelemetryInitializerPlugin.js +1 -1
- package/dist-es5/JavaScriptSDK/UnloadHandlerContainer.js +1 -1
- package/dist-es5/JavaScriptSDK/UnloadHookContainer.js +1 -1
- package/dist-es5/JavaScriptSDK/W3cTraceParent.js +3 -3
- package/dist-es5/JavaScriptSDK/W3cTraceParent.js.map +1 -1
- package/dist-es5/JavaScriptSDK.Enums/EnumHelperFuncs.js +3 -3
- package/dist-es5/JavaScriptSDK.Enums/EnumHelperFuncs.js.map +1 -1
- package/dist-es5/JavaScriptSDK.Enums/EventsDiscardedReason.js +1 -1
- package/dist-es5/JavaScriptSDK.Enums/FeatureOptInEnums.js +1 -1
- package/dist-es5/JavaScriptSDK.Enums/InitActiveStatusEnum.js +1 -1
- package/dist-es5/JavaScriptSDK.Enums/LoggingEnums.js +1 -1
- package/dist-es5/JavaScriptSDK.Enums/SendRequestReason.js +1 -1
- package/dist-es5/JavaScriptSDK.Enums/TelemetryUnloadReason.js +1 -1
- package/dist-es5/JavaScriptSDK.Enums/TelemetryUpdateReason.js +1 -1
- package/dist-es5/JavaScriptSDK.Interfaces/IAppInsightsCore.js +1 -1
- package/dist-es5/JavaScriptSDK.Interfaces/IChannelControls.js +1 -1
- package/dist-es5/JavaScriptSDK.Interfaces/IChannelControlsHost.js +1 -1
- package/dist-es5/JavaScriptSDK.Interfaces/IConfiguration.js +1 -1
- package/dist-es5/JavaScriptSDK.Interfaces/ICookieMgr.js +1 -1
- package/dist-es5/JavaScriptSDK.Interfaces/IDbgExtension.js +1 -1
- package/dist-es5/JavaScriptSDK.Interfaces/IDiagnosticLogger.js +1 -1
- package/dist-es5/JavaScriptSDK.Interfaces/IDistributedTraceContext.js +1 -1
- package/dist-es5/JavaScriptSDK.Interfaces/IExceptionConfig.js +1 -1
- package/dist-es5/JavaScriptSDK.Interfaces/IFeatureOptIn.js +1 -1
- package/dist-es5/JavaScriptSDK.Interfaces/IInstrumentHooks.js +1 -1
- package/dist-es5/JavaScriptSDK.Interfaces/INotificationListener.js +1 -1
- package/dist-es5/JavaScriptSDK.Interfaces/INotificationManager.js +1 -1
- package/dist-es5/JavaScriptSDK.Interfaces/IPerfEvent.js +1 -1
- package/dist-es5/JavaScriptSDK.Interfaces/IPerfManager.js +1 -1
- package/dist-es5/JavaScriptSDK.Interfaces/IProcessTelemetryContext.js +1 -1
- package/dist-es5/JavaScriptSDK.Interfaces/ISenderPostManager.js +1 -1
- package/dist-es5/JavaScriptSDK.Interfaces/ITelemetryInitializers.js +1 -1
- package/dist-es5/JavaScriptSDK.Interfaces/ITelemetryItem.js +1 -1
- package/dist-es5/JavaScriptSDK.Interfaces/ITelemetryPlugin.js +1 -1
- package/dist-es5/JavaScriptSDK.Interfaces/ITelemetryPluginChain.js +1 -1
- package/dist-es5/JavaScriptSDK.Interfaces/ITelemetryUnloadState.js +1 -1
- package/dist-es5/JavaScriptSDK.Interfaces/ITelemetryUpdateState.js +1 -1
- package/dist-es5/JavaScriptSDK.Interfaces/ITraceParent.js +1 -1
- package/dist-es5/JavaScriptSDK.Interfaces/IUnloadHook.js +1 -1
- package/dist-es5/JavaScriptSDK.Interfaces/IUnloadableComponent.js +1 -1
- package/dist-es5/JavaScriptSDK.Interfaces/IXDomainRequest.js +1 -1
- package/dist-es5/JavaScriptSDK.Interfaces/IXHROverride.js +1 -1
- package/dist-es5/__DynamicConstants.js +1 -1
- package/dist-es5/applicationinsights-core-js.js +1 -1
- package/package.json +1 -1
- package/types/applicationinsights-core-js.d.ts +37 -46
- package/types/applicationinsights-core-js.namespaced.d.ts +37 -46
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/*
|
|
2
|
-
* Microsoft Application Insights Core Javascript SDK, 3.3.5-nightly3.
|
|
2
|
+
* Microsoft Application Insights Core Javascript SDK, 3.3.5-nightly3.2412-01
|
|
3
3
|
* Copyright (c) Microsoft and contributors. All rights reserved.
|
|
4
4
|
*
|
|
5
5
|
* Microsoft Application Insights Team
|
|
@@ -593,7 +593,7 @@ export declare function createCustomDomEvent(eventName: string, details?: any):
|
|
|
593
593
|
export declare function createDynamicConfig<T = IConfiguration>(config: T, defaultConfig?: IConfigDefaults<T>, logger?: IDiagnosticLogger, inPlace?: boolean): IDynamicConfigHandler<T>;
|
|
594
594
|
|
|
595
595
|
/**
|
|
596
|
-
* Create an enum style object which has both the key
|
|
596
|
+
* Create an enum style object which has both the key \=> value and value \=> key mappings
|
|
597
597
|
* @param values - The values to populate on the new object
|
|
598
598
|
* @returns
|
|
599
599
|
*/
|
|
@@ -632,7 +632,7 @@ export declare function createUnloadHandlerContainer(): IUnloadHandlerContainer;
|
|
|
632
632
|
export declare function createUnloadHookContainer(): IUnloadHookContainer;
|
|
633
633
|
|
|
634
634
|
/**
|
|
635
|
-
* Create a 2 index map that maps an enum's key and value to the defined map value, X["key"]
|
|
635
|
+
* 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.
|
|
636
636
|
* Generic values
|
|
637
637
|
* - E = the const enum type (typeof eRequestHeaders);
|
|
638
638
|
* - V = Identifies the valid values for the keys, this should include both the enum numeric and string key of the type. The
|
|
@@ -978,20 +978,20 @@ export declare const enum FeatureOptInMode {
|
|
|
978
978
|
|
|
979
979
|
/**
|
|
980
980
|
* Find all script tags in the provided document and return the information about them.
|
|
981
|
-
* @param doc
|
|
981
|
+
* @param doc - The document to search for script tags
|
|
982
982
|
* @returns
|
|
983
983
|
*/
|
|
984
984
|
export declare function findAllScripts(doc: any): scriptsInfo[];
|
|
985
985
|
|
|
986
986
|
/**
|
|
987
987
|
* Helper function to fetch the named meta-tag from the page.
|
|
988
|
-
* @param name
|
|
988
|
+
* @param name - The name of the meta-tag to find.
|
|
989
989
|
*/
|
|
990
990
|
export declare function findMetaTag(name: string): any;
|
|
991
991
|
|
|
992
992
|
/**
|
|
993
993
|
* Helper function to fetch the named server timing value from the page response (first navigation event).
|
|
994
|
-
* @param name
|
|
994
|
+
* @param name - The name of the server timing value to find.
|
|
995
995
|
*/
|
|
996
996
|
export declare function findNamedServerTiming(name: string): any;
|
|
997
997
|
|
|
@@ -1065,7 +1065,6 @@ export { getDocument }
|
|
|
1065
1065
|
/**
|
|
1066
1066
|
* @internal
|
|
1067
1067
|
* Get the dynamic config handler if the value is already dynamic
|
|
1068
|
-
* @param value
|
|
1069
1068
|
* @returns
|
|
1070
1069
|
*/
|
|
1071
1070
|
export declare function getDynamicConfigHandler<T = IConfiguration, V = IConfiguration>(value: V | IDynamicConfigHandler<T>): IDynamicConfigHandler<T> | null;
|
|
@@ -1227,7 +1226,6 @@ export declare interface IAppInsightsCore<CfgType extends IConfiguration = IConf
|
|
|
1227
1226
|
unload(isAsync?: boolean, unloadComplete?: (unloadState: ITelemetryUnloadState) => void, cbTimeout?: number): void | IPromise<ITelemetryUnloadState>;
|
|
1228
1227
|
/**
|
|
1229
1228
|
* Find and return the (first) plugin with the specified identifier if present
|
|
1230
|
-
* @param pluginIdentifier
|
|
1231
1229
|
*/
|
|
1232
1230
|
getPlugin<T extends IPlugin = IPlugin>(pluginIdentifier: string): ILoadedPlugin<T>;
|
|
1233
1231
|
/**
|
|
@@ -1282,7 +1280,6 @@ export declare interface IAppInsightsCore<CfgType extends IConfiguration = IConf
|
|
|
1282
1280
|
/**
|
|
1283
1281
|
* Watches and tracks changes for accesses to the current config, and if the accessed config changes the
|
|
1284
1282
|
* handler will be recalled.
|
|
1285
|
-
* @param handler
|
|
1286
1283
|
* @returns A watcher handler instance that can be used to remove itself when being unloaded
|
|
1287
1284
|
*/
|
|
1288
1285
|
onCfgChange(handler: WatcherFunction<CfgType>): IUnloadHook;
|
|
@@ -1545,8 +1542,8 @@ export declare interface IConfiguration {
|
|
|
1545
1542
|
* be logged to console if their severity meets the configured loggingConsoleLevel
|
|
1546
1543
|
*
|
|
1547
1544
|
* 0: ALL console logging off
|
|
1548
|
-
* 1: logs to console: severity
|
|
1549
|
-
* 2: logs to console: severity
|
|
1545
|
+
* 1: logs to console: severity \>= CRITICAL
|
|
1546
|
+
* 2: logs to console: severity \>= WARNING
|
|
1550
1547
|
*/
|
|
1551
1548
|
loggingLevelConsole?: number;
|
|
1552
1549
|
/**
|
|
@@ -1555,8 +1552,8 @@ export declare interface IConfiguration {
|
|
|
1555
1552
|
* the configured instrumentation key.
|
|
1556
1553
|
*
|
|
1557
1554
|
* 0: ALL iKey logging off
|
|
1558
|
-
* 1: logs to iKey: severity
|
|
1559
|
-
* 2: logs to iKey: severity
|
|
1555
|
+
* 1: logs to iKey: severity \>= CRITICAL
|
|
1556
|
+
* 2: logs to iKey: severity \>= WARNING
|
|
1560
1557
|
*/
|
|
1561
1558
|
loggingLevelTelemetry?: number;
|
|
1562
1559
|
/**
|
|
@@ -1583,7 +1580,6 @@ export declare interface IConfiguration {
|
|
|
1583
1580
|
*/
|
|
1584
1581
|
readonly channels?: IChannelControls[][];
|
|
1585
1582
|
/**
|
|
1586
|
-
* @type {boolean}
|
|
1587
1583
|
* Flag that disables the Instrumentation Key validation.
|
|
1588
1584
|
*/
|
|
1589
1585
|
disableInstrumentationKeyValidation?: boolean;
|
|
@@ -1614,14 +1610,12 @@ export declare interface IConfiguration {
|
|
|
1614
1610
|
/**
|
|
1615
1611
|
* @description Custom cookie domain. This is helpful if you want to share Application Insights cookies across subdomains. It
|
|
1616
1612
|
* can be set here or as part of the cookieCfg.domain, the cookieCfg takes precedence if both are specified.
|
|
1617
|
-
* @type {string}
|
|
1618
1613
|
* @defaultValue ""
|
|
1619
1614
|
*/
|
|
1620
1615
|
cookieDomain?: string;
|
|
1621
1616
|
/**
|
|
1622
1617
|
* @description Custom cookie path. This is helpful if you want to share Application Insights cookies behind an application
|
|
1623
1618
|
* gateway. It can be set here or as part of the cookieCfg.domain, the cookieCfg takes precedence if both are specified.
|
|
1624
|
-
* @type {string}
|
|
1625
1619
|
* @defaultValue ""
|
|
1626
1620
|
*/
|
|
1627
1621
|
cookiePath?: string;
|
|
@@ -1733,7 +1727,7 @@ export declare interface ICookieMgr {
|
|
|
1733
1727
|
/**
|
|
1734
1728
|
* Optional Callback hook to allow the cookie manager to update it's configuration, not generally implemented now that
|
|
1735
1729
|
* dynamic configuration is supported
|
|
1736
|
-
* @param updateState
|
|
1730
|
+
* @param updateState - The new configuration state to apply to the cookie manager
|
|
1737
1731
|
*/
|
|
1738
1732
|
update?(updateState: ITelemetryUpdateState): void;
|
|
1739
1733
|
/**
|
|
@@ -1857,7 +1851,7 @@ export declare interface IDiagnosticLogger {
|
|
|
1857
1851
|
logInternalMessage?(severity: LoggingSeverity, message: _InternalLogMessage): void;
|
|
1858
1852
|
/**
|
|
1859
1853
|
* Optional Callback hook to allow the diagnostic logger to update it's configuration
|
|
1860
|
-
* @param updateState
|
|
1854
|
+
* @param updateState - The new configuration state to apply to the diagnostic logger
|
|
1861
1855
|
*/
|
|
1862
1856
|
update?(updateState: ITelemetryUpdateState): void;
|
|
1863
1857
|
/**
|
|
@@ -1878,7 +1872,7 @@ export declare interface IDistributedTraceContext {
|
|
|
1878
1872
|
getName(): string;
|
|
1879
1873
|
/**
|
|
1880
1874
|
* Sets the current name of the page
|
|
1881
|
-
* @param pageName
|
|
1875
|
+
* @param pageName - The name of the page
|
|
1882
1876
|
*/
|
|
1883
1877
|
setName(pageName: string): void;
|
|
1884
1878
|
/**
|
|
@@ -1910,7 +1904,7 @@ export declare interface IDistributedTraceContext {
|
|
|
1910
1904
|
getTraceFlags(): number | undefined;
|
|
1911
1905
|
/**
|
|
1912
1906
|
* https://www.w3.org/TR/trace-context/#trace-flags
|
|
1913
|
-
* @param newValue
|
|
1907
|
+
* @param newValue - An integer representation of the W3C TraceContext trace-flags.
|
|
1914
1908
|
*/
|
|
1915
1909
|
setTraceFlags(newValue?: number): void;
|
|
1916
1910
|
}
|
|
@@ -2042,10 +2036,10 @@ export declare interface IExceptionConfig {
|
|
|
2042
2036
|
*
|
|
2043
2037
|
* This callback is called before telemetry data is sent, allowing for dynamic customization of the logs.
|
|
2044
2038
|
*
|
|
2045
|
-
* @returns
|
|
2039
|
+
* @returns An object with the following property:
|
|
2046
2040
|
* - logs: An array of strings, where each string represents a log entry to be included in the telemetry.
|
|
2047
2041
|
*
|
|
2048
|
-
* @property
|
|
2042
|
+
* @property maxLogs - Specifies the maximum number of logs that can be generated. If not explicitly set, it defaults to 50.
|
|
2049
2043
|
*/
|
|
2050
2044
|
expLog?: () => {
|
|
2051
2045
|
logs: string[];
|
|
@@ -2183,32 +2177,31 @@ export declare interface IInternalOfflineSupport {
|
|
|
2183
2177
|
getUrl: () => string;
|
|
2184
2178
|
/**
|
|
2185
2179
|
* Create payload data
|
|
2186
|
-
* @param data data
|
|
2187
2180
|
* @returns IPayloadData
|
|
2188
2181
|
*/
|
|
2189
2182
|
createPayload: (data: string | Uint8Array) => IPayloadData;
|
|
2190
2183
|
/**
|
|
2191
2184
|
* Serialize an item into a string
|
|
2192
|
-
* @param input telemetry item
|
|
2193
|
-
* @param convertUndefined convert undefined to a custom-defined object
|
|
2185
|
+
* @param input - telemetry item
|
|
2186
|
+
* @param convertUndefined - convert undefined to a custom-defined object
|
|
2194
2187
|
* @returns Serialized string
|
|
2195
2188
|
*/
|
|
2196
2189
|
serialize?: (input: ITelemetryItem, convertUndefined?: any) => string;
|
|
2197
2190
|
/**
|
|
2198
2191
|
* Batch an array of strings into one string
|
|
2199
|
-
* @param arr array of strings
|
|
2192
|
+
* @param arr - array of strings
|
|
2200
2193
|
* @returns a string represent all items in the given array
|
|
2201
2194
|
*/
|
|
2202
2195
|
batch?: (arr: string[]) => string;
|
|
2203
2196
|
/**
|
|
2204
2197
|
* If the item should be processed by offline channel
|
|
2205
|
-
* @param evt telemetry item
|
|
2198
|
+
* @param evt - telemetry item
|
|
2206
2199
|
* @returns should process or not
|
|
2207
2200
|
*/
|
|
2208
2201
|
shouldProcess?: (evt: ITelemetryItem) => boolean;
|
|
2209
2202
|
/**
|
|
2210
2203
|
* Create 1ds payload data
|
|
2211
|
-
* @param evts ITelemetryItems
|
|
2204
|
+
* @param evts - ITelemetryItems
|
|
2212
2205
|
* @returns IPayloadData
|
|
2213
2206
|
*/
|
|
2214
2207
|
createOneDSPayload?: (evts: ITelemetryItem[]) => IPayloadData;
|
|
@@ -2288,7 +2281,7 @@ export declare interface INotificationListener {
|
|
|
2288
2281
|
/**
|
|
2289
2282
|
* [Optional] This event is sent if you have enabled perf events, they are primarily used to track internal performance testing and debugging
|
|
2290
2283
|
* the event can be displayed via the debug plugin extension.
|
|
2291
|
-
* @param perfEvent
|
|
2284
|
+
* @param perfEvent - The performance event object
|
|
2292
2285
|
*/
|
|
2293
2286
|
perfEvent?: (perfEvent: IPerfEvent) => void;
|
|
2294
2287
|
/**
|
|
@@ -2704,31 +2697,31 @@ export { isDate }
|
|
|
2704
2697
|
export declare interface _ISenderOnComplete {
|
|
2705
2698
|
/**
|
|
2706
2699
|
* defined xdr onload function to handle response
|
|
2707
|
-
* @param dxr xdr request object
|
|
2708
|
-
* @param oncomplete oncomplete function
|
|
2700
|
+
* @param dxr - xdr request object
|
|
2701
|
+
* @param oncomplete - oncomplete function
|
|
2709
2702
|
* @since version after 3.1.0
|
|
2710
2703
|
*/
|
|
2711
2704
|
xdrOnComplete?(xdr: IXDomainRequest, onComplete: OnCompleteCallback, payload?: IPayloadData): void;
|
|
2712
2705
|
/**
|
|
2713
2706
|
* defined fetch on complete function to handle response
|
|
2714
|
-
* @param response response object
|
|
2715
|
-
* @param onComplete oncomplete function
|
|
2716
|
-
* @param resValue response.text().value
|
|
2707
|
+
* @param response - response object
|
|
2708
|
+
* @param onComplete - oncomplete function
|
|
2709
|
+
* @param resValue - response.text().value
|
|
2717
2710
|
* @since version after 3.1.0
|
|
2718
2711
|
*/
|
|
2719
2712
|
fetchOnComplete?(response: Response, onComplete: OnCompleteCallback, resValue?: string, payload?: IPayloadData): void;
|
|
2720
2713
|
/**
|
|
2721
2714
|
* defined xhr onreadystatechange function to handle response
|
|
2722
|
-
* @param request request object
|
|
2723
|
-
* @param oncomplete oncomplete function
|
|
2715
|
+
* @param request - request object
|
|
2716
|
+
* @param oncomplete - oncomplete function
|
|
2724
2717
|
* @since version after 3.1.0
|
|
2725
2718
|
*/
|
|
2726
2719
|
xhrOnComplete?(request: XMLHttpRequest, onComplete: OnCompleteCallback, payload?: IPayloadData): void;
|
|
2727
2720
|
/**
|
|
2728
2721
|
* Define functions during beacon can not send payload after first attempt. If not defined, will be apyload will be retried with fallback sender.
|
|
2729
|
-
* @param data payload data
|
|
2730
|
-
* @param onComplete oncomplete function
|
|
2731
|
-
* @param canSend can the current data sent by beacon sender
|
|
2722
|
+
* @param data - payload data
|
|
2723
|
+
* @param onComplete - oncomplete function
|
|
2724
|
+
* @param canSend - can the current data sent by beacon sender
|
|
2732
2725
|
* @since version after 3.1.0
|
|
2733
2726
|
*/
|
|
2734
2727
|
beaconOnRetry?(data: IPayloadData, onComplete: OnCompleteCallback, canSend: (payload: IPayloadData, oncomplete: OnCompleteCallback, sync?: boolean) => boolean): void;
|
|
@@ -2894,7 +2887,7 @@ export declare function isValidTraceId(value: string): boolean;
|
|
|
2894
2887
|
|
|
2895
2888
|
/**
|
|
2896
2889
|
* Validates that the provided ITraceParent instance conforms to the currently supported specifications
|
|
2897
|
-
* @param value
|
|
2890
|
+
* @param value - The parsed traceParent value
|
|
2898
2891
|
* @returns
|
|
2899
2892
|
*/
|
|
2900
2893
|
export declare function isValidTraceParent(value: ITraceParent): boolean;
|
|
@@ -3343,8 +3336,6 @@ export declare type OnCompleteCallback = (status: number, headers: {
|
|
|
3343
3336
|
/**
|
|
3344
3337
|
* Watch and track changes for accesses to the current config, the provided config MUST already be
|
|
3345
3338
|
* a dynamic config or a child accessed via the dynamic config
|
|
3346
|
-
* @param config
|
|
3347
|
-
* @param configHandler
|
|
3348
3339
|
* @param logger - The logger instance to use if there is no existing handler
|
|
3349
3340
|
* @returns A watcher handler instance that can be used to remove itself when being unloaded
|
|
3350
3341
|
* @throws TypeError if the provided config is not a dynamic config instance
|
|
@@ -3579,7 +3570,7 @@ export declare function random32(signed?: boolean): number;
|
|
|
3579
3570
|
/**
|
|
3580
3571
|
* Generate a random value between 0 and maxValue, max value should be limited to a 32-bit maximum.
|
|
3581
3572
|
* So maxValue(16) will produce a number from 0..16 (range of 17)
|
|
3582
|
-
* @param maxValue
|
|
3573
|
+
* @param maxValue - The max value for the range
|
|
3583
3574
|
*/
|
|
3584
3575
|
export declare function randomValue(maxValue: number): number;
|
|
3585
3576
|
|
|
@@ -3644,8 +3635,8 @@ export declare function runTargetUnload<T>(target: {
|
|
|
3644
3635
|
/**
|
|
3645
3636
|
* Helper to return the ICookieMgr from the core (if not null/undefined) or a default implementation
|
|
3646
3637
|
* associated with the configuration or a legacy default.
|
|
3647
|
-
* @param core
|
|
3648
|
-
* @param config
|
|
3638
|
+
* @param core - The AppInsightsCore instance to get the cookie manager from
|
|
3639
|
+
* @param config - The config to use if the core is not available
|
|
3649
3640
|
* @returns
|
|
3650
3641
|
*/
|
|
3651
3642
|
export declare function safeGetCookieMgr(core: IAppInsightsCore, config?: IConfiguration): ICookieMgr;
|
|
@@ -3747,7 +3738,7 @@ export declare const enum SendRequestReason {
|
|
|
3747
3738
|
|
|
3748
3739
|
/**
|
|
3749
3740
|
* Enable the lookup of test mock objects if requested
|
|
3750
|
-
* @param enabled
|
|
3741
|
+
* @param enabled - A flag to enable or disable the mock
|
|
3751
3742
|
*/
|
|
3752
3743
|
export declare function setEnableEnvMocks(enabled: boolean): void;
|
|
3753
3744
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/*
|
|
2
|
-
* Microsoft Application Insights Core Javascript SDK, 3.3.5-nightly3.
|
|
2
|
+
* Microsoft Application Insights Core Javascript SDK, 3.3.5-nightly3.2412-01
|
|
3
3
|
* Copyright (c) Microsoft and contributors. All rights reserved.
|
|
4
4
|
*
|
|
5
5
|
* Microsoft Application Insights Team
|
|
@@ -788,7 +788,7 @@ declare namespace ApplicationInsights {
|
|
|
788
788
|
function createDynamicConfig<T = IConfiguration>(config: T, defaultConfig?: IConfigDefaults<T>, logger?: IDiagnosticLogger, inPlace?: boolean): IDynamicConfigHandler<T>;
|
|
789
789
|
|
|
790
790
|
/**
|
|
791
|
-
* Create an enum style object which has both the key
|
|
791
|
+
* Create an enum style object which has both the key \=> value and value \=> key mappings
|
|
792
792
|
* @param values - The values to populate on the new object
|
|
793
793
|
* @returns
|
|
794
794
|
*/
|
|
@@ -827,7 +827,7 @@ declare namespace ApplicationInsights {
|
|
|
827
827
|
function createUnloadHookContainer(): IUnloadHookContainer;
|
|
828
828
|
|
|
829
829
|
/**
|
|
830
|
-
* Create a 2 index map that maps an enum's key and value to the defined map value, X["key"]
|
|
830
|
+
* 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.
|
|
831
831
|
* Generic values
|
|
832
832
|
* - E = the const enum type (typeof eRequestHeaders);
|
|
833
833
|
* - V = Identifies the valid values for the keys, this should include both the enum numeric and string key of the type. The
|
|
@@ -1268,20 +1268,20 @@ declare namespace ApplicationInsights {
|
|
|
1268
1268
|
|
|
1269
1269
|
/**
|
|
1270
1270
|
* Find all script tags in the provided document and return the information about them.
|
|
1271
|
-
* @param doc
|
|
1271
|
+
* @param doc - The document to search for script tags
|
|
1272
1272
|
* @returns
|
|
1273
1273
|
*/
|
|
1274
1274
|
function findAllScripts(doc: any): scriptsInfo[];
|
|
1275
1275
|
|
|
1276
1276
|
/**
|
|
1277
1277
|
* Helper function to fetch the named meta-tag from the page.
|
|
1278
|
-
* @param name
|
|
1278
|
+
* @param name - The name of the meta-tag to find.
|
|
1279
1279
|
*/
|
|
1280
1280
|
function findMetaTag(name: string): any;
|
|
1281
1281
|
|
|
1282
1282
|
/**
|
|
1283
1283
|
* Helper function to fetch the named server timing value from the page response (first navigation event).
|
|
1284
|
-
* @param name
|
|
1284
|
+
* @param name - The name of the server timing value to find.
|
|
1285
1285
|
*/
|
|
1286
1286
|
function findNamedServerTiming(name: string): any;
|
|
1287
1287
|
|
|
@@ -1360,7 +1360,6 @@ declare namespace ApplicationInsights {
|
|
|
1360
1360
|
/**
|
|
1361
1361
|
* @internal
|
|
1362
1362
|
* Get the dynamic config handler if the value is already dynamic
|
|
1363
|
-
* @param value
|
|
1364
1363
|
* @returns
|
|
1365
1364
|
*/
|
|
1366
1365
|
function getDynamicConfigHandler<T = IConfiguration, V = IConfiguration>(value: V | IDynamicConfigHandler<T>): IDynamicConfigHandler<T> | null;
|
|
@@ -1636,7 +1635,6 @@ declare namespace ApplicationInsights {
|
|
|
1636
1635
|
unload(isAsync?: boolean, unloadComplete?: (unloadState: ITelemetryUnloadState) => void, cbTimeout?: number): void | IPromise<ITelemetryUnloadState>;
|
|
1637
1636
|
/**
|
|
1638
1637
|
* Find and return the (first) plugin with the specified identifier if present
|
|
1639
|
-
* @param pluginIdentifier
|
|
1640
1638
|
*/
|
|
1641
1639
|
getPlugin<T extends IPlugin = IPlugin>(pluginIdentifier: string): ILoadedPlugin<T>;
|
|
1642
1640
|
/**
|
|
@@ -1691,7 +1689,6 @@ declare namespace ApplicationInsights {
|
|
|
1691
1689
|
/**
|
|
1692
1690
|
* Watches and tracks changes for accesses to the current config, and if the accessed config changes the
|
|
1693
1691
|
* handler will be recalled.
|
|
1694
|
-
* @param handler
|
|
1695
1692
|
* @returns A watcher handler instance that can be used to remove itself when being unloaded
|
|
1696
1693
|
*/
|
|
1697
1694
|
onCfgChange(handler: WatcherFunction<CfgType>): IUnloadHook;
|
|
@@ -1954,8 +1951,8 @@ declare namespace ApplicationInsights {
|
|
|
1954
1951
|
* be logged to console if their severity meets the configured loggingConsoleLevel
|
|
1955
1952
|
*
|
|
1956
1953
|
* 0: ALL console logging off
|
|
1957
|
-
* 1: logs to console: severity
|
|
1958
|
-
* 2: logs to console: severity
|
|
1954
|
+
* 1: logs to console: severity \>= CRITICAL
|
|
1955
|
+
* 2: logs to console: severity \>= WARNING
|
|
1959
1956
|
*/
|
|
1960
1957
|
loggingLevelConsole?: number;
|
|
1961
1958
|
/**
|
|
@@ -1964,8 +1961,8 @@ declare namespace ApplicationInsights {
|
|
|
1964
1961
|
* the configured instrumentation key.
|
|
1965
1962
|
*
|
|
1966
1963
|
* 0: ALL iKey logging off
|
|
1967
|
-
* 1: logs to iKey: severity
|
|
1968
|
-
* 2: logs to iKey: severity
|
|
1964
|
+
* 1: logs to iKey: severity \>= CRITICAL
|
|
1965
|
+
* 2: logs to iKey: severity \>= WARNING
|
|
1969
1966
|
*/
|
|
1970
1967
|
loggingLevelTelemetry?: number;
|
|
1971
1968
|
/**
|
|
@@ -1992,7 +1989,6 @@ declare namespace ApplicationInsights {
|
|
|
1992
1989
|
*/
|
|
1993
1990
|
readonly channels?: IChannelControls[][];
|
|
1994
1991
|
/**
|
|
1995
|
-
* @type {boolean}
|
|
1996
1992
|
* Flag that disables the Instrumentation Key validation.
|
|
1997
1993
|
*/
|
|
1998
1994
|
disableInstrumentationKeyValidation?: boolean;
|
|
@@ -2023,14 +2019,12 @@ declare namespace ApplicationInsights {
|
|
|
2023
2019
|
/**
|
|
2024
2020
|
* @description Custom cookie domain. This is helpful if you want to share Application Insights cookies across subdomains. It
|
|
2025
2021
|
* can be set here or as part of the cookieCfg.domain, the cookieCfg takes precedence if both are specified.
|
|
2026
|
-
* @type {string}
|
|
2027
2022
|
* @defaultValue ""
|
|
2028
2023
|
*/
|
|
2029
2024
|
cookieDomain?: string;
|
|
2030
2025
|
/**
|
|
2031
2026
|
* @description Custom cookie path. This is helpful if you want to share Application Insights cookies behind an application
|
|
2032
2027
|
* gateway. It can be set here or as part of the cookieCfg.domain, the cookieCfg takes precedence if both are specified.
|
|
2033
|
-
* @type {string}
|
|
2034
2028
|
* @defaultValue ""
|
|
2035
2029
|
*/
|
|
2036
2030
|
cookiePath?: string;
|
|
@@ -2142,7 +2136,7 @@ declare namespace ApplicationInsights {
|
|
|
2142
2136
|
/**
|
|
2143
2137
|
* Optional Callback hook to allow the cookie manager to update it's configuration, not generally implemented now that
|
|
2144
2138
|
* dynamic configuration is supported
|
|
2145
|
-
* @param updateState
|
|
2139
|
+
* @param updateState - The new configuration state to apply to the cookie manager
|
|
2146
2140
|
*/
|
|
2147
2141
|
update?(updateState: ITelemetryUpdateState): void;
|
|
2148
2142
|
/**
|
|
@@ -2266,7 +2260,7 @@ declare namespace ApplicationInsights {
|
|
|
2266
2260
|
logInternalMessage?(severity: LoggingSeverity, message: _InternalLogMessage): void;
|
|
2267
2261
|
/**
|
|
2268
2262
|
* Optional Callback hook to allow the diagnostic logger to update it's configuration
|
|
2269
|
-
* @param updateState
|
|
2263
|
+
* @param updateState - The new configuration state to apply to the diagnostic logger
|
|
2270
2264
|
*/
|
|
2271
2265
|
update?(updateState: ITelemetryUpdateState): void;
|
|
2272
2266
|
/**
|
|
@@ -2287,7 +2281,7 @@ declare namespace ApplicationInsights {
|
|
|
2287
2281
|
getName(): string;
|
|
2288
2282
|
/**
|
|
2289
2283
|
* Sets the current name of the page
|
|
2290
|
-
* @param pageName
|
|
2284
|
+
* @param pageName - The name of the page
|
|
2291
2285
|
*/
|
|
2292
2286
|
setName(pageName: string): void;
|
|
2293
2287
|
/**
|
|
@@ -2319,7 +2313,7 @@ declare namespace ApplicationInsights {
|
|
|
2319
2313
|
getTraceFlags(): number | undefined;
|
|
2320
2314
|
/**
|
|
2321
2315
|
* https://www.w3.org/TR/trace-context/#trace-flags
|
|
2322
|
-
* @param newValue
|
|
2316
|
+
* @param newValue - An integer representation of the W3C TraceContext trace-flags.
|
|
2323
2317
|
*/
|
|
2324
2318
|
setTraceFlags(newValue?: number): void;
|
|
2325
2319
|
}
|
|
@@ -2451,10 +2445,10 @@ declare namespace ApplicationInsights {
|
|
|
2451
2445
|
*
|
|
2452
2446
|
* This callback is called before telemetry data is sent, allowing for dynamic customization of the logs.
|
|
2453
2447
|
*
|
|
2454
|
-
* @returns
|
|
2448
|
+
* @returns An object with the following property:
|
|
2455
2449
|
* - logs: An array of strings, where each string represents a log entry to be included in the telemetry.
|
|
2456
2450
|
*
|
|
2457
|
-
* @property
|
|
2451
|
+
* @property maxLogs - Specifies the maximum number of logs that can be generated. If not explicitly set, it defaults to 50.
|
|
2458
2452
|
*/
|
|
2459
2453
|
expLog?: () => {
|
|
2460
2454
|
logs: string[];
|
|
@@ -2592,32 +2586,31 @@ declare namespace ApplicationInsights {
|
|
|
2592
2586
|
getUrl: () => string;
|
|
2593
2587
|
/**
|
|
2594
2588
|
* Create payload data
|
|
2595
|
-
* @param data data
|
|
2596
2589
|
* @returns IPayloadData
|
|
2597
2590
|
*/
|
|
2598
2591
|
createPayload: (data: string | Uint8Array) => IPayloadData;
|
|
2599
2592
|
/**
|
|
2600
2593
|
* Serialize an item into a string
|
|
2601
|
-
* @param input telemetry item
|
|
2602
|
-
* @param convertUndefined convert undefined to a custom-defined object
|
|
2594
|
+
* @param input - telemetry item
|
|
2595
|
+
* @param convertUndefined - convert undefined to a custom-defined object
|
|
2603
2596
|
* @returns Serialized string
|
|
2604
2597
|
*/
|
|
2605
2598
|
serialize?: (input: ITelemetryItem, convertUndefined?: any) => string;
|
|
2606
2599
|
/**
|
|
2607
2600
|
* Batch an array of strings into one string
|
|
2608
|
-
* @param arr array of strings
|
|
2601
|
+
* @param arr - array of strings
|
|
2609
2602
|
* @returns a string represent all items in the given array
|
|
2610
2603
|
*/
|
|
2611
2604
|
batch?: (arr: string[]) => string;
|
|
2612
2605
|
/**
|
|
2613
2606
|
* If the item should be processed by offline channel
|
|
2614
|
-
* @param evt telemetry item
|
|
2607
|
+
* @param evt - telemetry item
|
|
2615
2608
|
* @returns should process or not
|
|
2616
2609
|
*/
|
|
2617
2610
|
shouldProcess?: (evt: ITelemetryItem) => boolean;
|
|
2618
2611
|
/**
|
|
2619
2612
|
* Create 1ds payload data
|
|
2620
|
-
* @param evts ITelemetryItems
|
|
2613
|
+
* @param evts - ITelemetryItems
|
|
2621
2614
|
* @returns IPayloadData
|
|
2622
2615
|
*/
|
|
2623
2616
|
createOneDSPayload?: (evts: ITelemetryItem[]) => IPayloadData;
|
|
@@ -2697,7 +2690,7 @@ declare namespace ApplicationInsights {
|
|
|
2697
2690
|
/**
|
|
2698
2691
|
* [Optional] This event is sent if you have enabled perf events, they are primarily used to track internal performance testing and debugging
|
|
2699
2692
|
* the event can be displayed via the debug plugin extension.
|
|
2700
|
-
* @param perfEvent
|
|
2693
|
+
* @param perfEvent - The performance event object
|
|
2701
2694
|
*/
|
|
2702
2695
|
perfEvent?: (perfEvent: IPerfEvent) => void;
|
|
2703
2696
|
/**
|
|
@@ -3336,31 +3329,31 @@ declare namespace ApplicationInsights {
|
|
|
3336
3329
|
interface _ISenderOnComplete {
|
|
3337
3330
|
/**
|
|
3338
3331
|
* defined xdr onload function to handle response
|
|
3339
|
-
* @param dxr xdr request object
|
|
3340
|
-
* @param oncomplete oncomplete function
|
|
3332
|
+
* @param dxr - xdr request object
|
|
3333
|
+
* @param oncomplete - oncomplete function
|
|
3341
3334
|
* @since version after 3.1.0
|
|
3342
3335
|
*/
|
|
3343
3336
|
xdrOnComplete?(xdr: IXDomainRequest, onComplete: OnCompleteCallback, payload?: IPayloadData): void;
|
|
3344
3337
|
/**
|
|
3345
3338
|
* defined fetch on complete function to handle response
|
|
3346
|
-
* @param response response object
|
|
3347
|
-
* @param onComplete oncomplete function
|
|
3348
|
-
* @param resValue response.text().value
|
|
3339
|
+
* @param response - response object
|
|
3340
|
+
* @param onComplete - oncomplete function
|
|
3341
|
+
* @param resValue - response.text().value
|
|
3349
3342
|
* @since version after 3.1.0
|
|
3350
3343
|
*/
|
|
3351
3344
|
fetchOnComplete?(response: Response, onComplete: OnCompleteCallback, resValue?: string, payload?: IPayloadData): void;
|
|
3352
3345
|
/**
|
|
3353
3346
|
* defined xhr onreadystatechange function to handle response
|
|
3354
|
-
* @param request request object
|
|
3355
|
-
* @param oncomplete oncomplete function
|
|
3347
|
+
* @param request - request object
|
|
3348
|
+
* @param oncomplete - oncomplete function
|
|
3356
3349
|
* @since version after 3.1.0
|
|
3357
3350
|
*/
|
|
3358
3351
|
xhrOnComplete?(request: XMLHttpRequest, onComplete: OnCompleteCallback, payload?: IPayloadData): void;
|
|
3359
3352
|
/**
|
|
3360
3353
|
* Define functions during beacon can not send payload after first attempt. If not defined, will be apyload will be retried with fallback sender.
|
|
3361
|
-
* @param data payload data
|
|
3362
|
-
* @param onComplete oncomplete function
|
|
3363
|
-
* @param canSend can the current data sent by beacon sender
|
|
3354
|
+
* @param data - payload data
|
|
3355
|
+
* @param onComplete - oncomplete function
|
|
3356
|
+
* @param canSend - can the current data sent by beacon sender
|
|
3364
3357
|
* @since version after 3.1.0
|
|
3365
3358
|
*/
|
|
3366
3359
|
beaconOnRetry?(data: IPayloadData, onComplete: OnCompleteCallback, canSend: (payload: IPayloadData, oncomplete: OnCompleteCallback, sync?: boolean) => boolean): void;
|
|
@@ -3687,7 +3680,7 @@ declare namespace ApplicationInsights {
|
|
|
3687
3680
|
|
|
3688
3681
|
/**
|
|
3689
3682
|
* Validates that the provided ITraceParent instance conforms to the currently supported specifications
|
|
3690
|
-
* @param value
|
|
3683
|
+
* @param value - The parsed traceParent value
|
|
3691
3684
|
* @returns
|
|
3692
3685
|
*/
|
|
3693
3686
|
function isValidTraceParent(value: ITraceParent): boolean;
|
|
@@ -4375,8 +4368,6 @@ declare namespace ApplicationInsights {
|
|
|
4375
4368
|
/**
|
|
4376
4369
|
* Watch and track changes for accesses to the current config, the provided config MUST already be
|
|
4377
4370
|
* a dynamic config or a child accessed via the dynamic config
|
|
4378
|
-
* @param config
|
|
4379
|
-
* @param configHandler
|
|
4380
4371
|
* @param logger - The logger instance to use if there is no existing handler
|
|
4381
4372
|
* @returns A watcher handler instance that can be used to remove itself when being unloaded
|
|
4382
4373
|
* @throws TypeError if the provided config is not a dynamic config instance
|
|
@@ -4626,7 +4617,7 @@ declare namespace ApplicationInsights {
|
|
|
4626
4617
|
/**
|
|
4627
4618
|
* Generate a random value between 0 and maxValue, max value should be limited to a 32-bit maximum.
|
|
4628
4619
|
* So maxValue(16) will produce a number from 0..16 (range of 17)
|
|
4629
|
-
* @param maxValue
|
|
4620
|
+
* @param maxValue - The max value for the range
|
|
4630
4621
|
*/
|
|
4631
4622
|
function randomValue(maxValue: number): number;
|
|
4632
4623
|
|
|
@@ -4705,8 +4696,8 @@ declare namespace ApplicationInsights {
|
|
|
4705
4696
|
/**
|
|
4706
4697
|
* Helper to return the ICookieMgr from the core (if not null/undefined) or a default implementation
|
|
4707
4698
|
* associated with the configuration or a legacy default.
|
|
4708
|
-
* @param core
|
|
4709
|
-
* @param config
|
|
4699
|
+
* @param core - The AppInsightsCore instance to get the cookie manager from
|
|
4700
|
+
* @param config - The config to use if the core is not available
|
|
4710
4701
|
* @returns
|
|
4711
4702
|
*/
|
|
4712
4703
|
function safeGetCookieMgr(core: IAppInsightsCore, config?: IConfiguration): ICookieMgr;
|
|
@@ -4808,7 +4799,7 @@ declare namespace ApplicationInsights {
|
|
|
4808
4799
|
|
|
4809
4800
|
/**
|
|
4810
4801
|
* Enable the lookup of test mock objects if requested
|
|
4811
|
-
* @param enabled
|
|
4802
|
+
* @param enabled - A flag to enable or disable the mock
|
|
4812
4803
|
*/
|
|
4813
4804
|
function setEnableEnvMocks(enabled: boolean): void;
|
|
4814
4805
|
|