@microsoft/applicationinsights-offlinechannel-js 0.4.0-nightlybeta3.2505-36 → 0.4.0-nightlybeta3.2507-22

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/README.md CHANGED
@@ -14,35 +14,35 @@ The Offline Channel supports the saving of events when your application is offli
14
14
 
15
15
  ## Configuration
16
16
 
17
- `IOfflineChannelConfiguration`
17
+ [`IOfflineChannelConfiguration`](https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-offlinechannel-js/interfaces/IOfflineChannelConfiguration.html)
18
18
 
19
19
  | Name | Type | Default | Description |
20
20
  |------|------|---------|-------------|
21
- | maxStorageSizeInBytes | [Optional]| 5000000 | The max size in bytes that should be used for storing events in local/session storage. |
22
- | storageKeyPrefix | [Optional] | AIOffline | The storage key prefix that should be used when storing events in persistent storage. |
23
- | minPersistenceLevel | [Optional] | `EventPersistence.Normal` or 1 | Identifies the minimum level that will be cached in the offline channel. Valid values of this setting are defined by the `EventPersistence` enum, currently Normal (1) and Critical (2) with the default value being Normal (1), which means all events without a persistence level set or with invalid persistence level will be marked as Normal(1) events.|
24
- | providers | [Optional] | [`eStorageProviders.LocalStorage, eStorageProviders.IndexedDB`]| Identifies the StorageProviders that should be used by the system if available, the first available provider will be used. Valid available values are defined by the `eStorageProviders` enum. </br> Note: LocalStorage will be used to save unload events even if it is not in the providers list. |
25
- | eventsLimitInMem | [Optional] | null | Identifies the maximum number of events to store in memory before sending to persistent storage. |
26
- | autoClean | [Optional] | false | Identifies if events that have existed in storage longer than the maximum allowed time (configured in inStorageMaxTime) should be cleaned after connection with storage. |
27
- | inMemoMaxTime | [Optional] | 15000 | Identifies the maximum time in ms that items should be in memory before being saved into storage. |
28
- | inStorageMaxTime | [Optional] | 10080000 (around 7days) | Identifies the maximum time in ms that items should be in the configured persistent storage. |
29
- | maxRetry | [Optional] | 1 | Identifies the maximum retry times for an event batch. |
30
- | primaryOnlineChannelId | [Optional] | `[AppInsightsChannelPlugin, PostChannel]` | Identifies online channel IDs in order. The first available one will be used. |
31
- | maxBatchsize | [Optional] | 63000 | Identifies the maximum size per batch in bytes that is saved in persistent storage. |
32
- | senderCfg | [Optional] | `IOfflineSenderConfig` | Identifies offline sender properties. |
33
- | maxSentBatchInterval | [Optional] | 15000 | Identifies the interval time in ms that previously stored offline event batches should be sent under online status. |
34
- | EventsToDropPerTime | [Optional] | 10 | Identifies the maximum event batch count when cleaning or releasing space for persistent storage per time. |
35
- | maxCriticalEvtsDropCnt | [Optional] | 2 | Identifies the maximum critical events count for an event batch to be able to drop when releasing space for persistent storage per time. |
36
- | overrideInstrumentationKey | [Optional] | null | Identifies overridden for the Instrumentation key when the offline channel calls `processTelemetry`. |
37
-
38
- `IOfflineSenderConfig`
21
+ | [maxStorageSizeInBytes](https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-offlinechannel-js/interfaces/IOfflineChannelConfiguration.html#maxStorageSizeInBytes) | [Optional]| 5000000 | The max size in bytes that should be used for storing events in local/session storage. |
22
+ | [storageKeyPrefix](https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-offlinechannel-js/interfaces/IOfflineChannelConfiguration.html#storageKeyPrefix) | [Optional] | AIOffline | The storage key prefix that should be used when storing events in persistent storage. |
23
+ | [minPersistenceLevel](https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-offlinechannel-js/interfaces/IOfflineChannelConfiguration.html#minPersistenceLevel) | [Optional] | `EventPersistence.Normal` or 1 | Identifies the minimum level that will be cached in the offline channel. Valid values of this setting are defined by the `EventPersistence` enum, currently Normal (1) and Critical (2) with the default value being Normal (1), which means all events without a persistence level set or with invalid persistence level will be marked as Normal(1) events.|
24
+ | [providers](https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-offlinechannel-js/interfaces/IOfflineChannelConfiguration.html#providers) | [Optional] | [`eStorageProviders.LocalStorage, eStorageProviders.IndexedDB`]| Identifies the StorageProviders that should be used by the system if available, the first available provider will be used. Valid available values are defined by the `eStorageProviders` enum. </br> Note: LocalStorage will be used to save unload events even if it is not in the providers list. |
25
+ | [eventsLimitInMem](https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-offlinechannel-js/interfaces/IOfflineChannelConfiguration.html#eventsLimitInMem) | [Optional] | null | Identifies the maximum number of events to store in memory before sending to persistent storage. |
26
+ | [autoClean](https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-offlinechannel-js/interfaces/IOfflineChannelConfiguration.html#autoClean) | [Optional] | false | Identifies if events that have existed in storage longer than the maximum allowed time (configured in inStorageMaxTime) should be cleaned after connection with storage. |
27
+ | [inMemoMaxTime](https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-offlinechannel-js/interfaces/IOfflineChannelConfiguration.html#inMemoMaxTime) | [Optional] | 15000 | Identifies the maximum time in ms that items should be in memory before being saved into storage. |
28
+ | [inStorageMaxTime](https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-offlinechannel-js/interfaces/IOfflineChannelConfiguration.html#inStorageMaxTime) | [Optional] | 10080000 (around 7days) | Identifies the maximum time in ms that items should be in the configured persistent storage. |
29
+ | [maxRetry](https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-offlinechannel-js/interfaces/IOfflineChannelConfiguration.html#maxRetry) | [Optional] | 1 | Identifies the maximum retry times for an event batch. |
30
+ | [primaryOnlineChannelId](https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-offlinechannel-js/interfaces/IOfflineChannelConfiguration.html#primaryOnlineChannelId) | [Optional] | `[AppInsightsChannelPlugin, PostChannel]` | Identifies online channel IDs in order. The first available one will be used. |
31
+ | [maxBatchsize](https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-offlinechannel-js/interfaces/IOfflineChannelConfiguration.html#maxBatchsize) | [Optional] | 63000 | Identifies the maximum size per batch in bytes that is saved in persistent storage. |
32
+ | [senderCfg](https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-offlinechannel-js/interfaces/IOfflineChannelConfiguration.html#senderCfg) | [Optional] | `IOfflineSenderConfig` | Identifies offline sender properties. |
33
+ | [maxSentBatchInterval](https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-offlinechannel-js/interfaces/IOfflineChannelConfiguration.html#maxSentBatchInterval) | [Optional] | 15000 | Identifies the interval time in ms that previously stored offline event batches should be sent under online status. |
34
+ | [EventsToDropPerTime](https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-offlinechannel-js/interfaces/IOfflineChannelConfiguration.html#EventsToDropPerTime) | [Optional] | 10 | Identifies the maximum event batch count when cleaning or releasing space for persistent storage per time. |
35
+ | [maxCriticalEvtsDropCnt](https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-offlinechannel-js/interfaces/IOfflineChannelConfiguration.html#maxCriticalEvtsDropCnt) | [Optional] | 2 | Identifies the maximum critical events count for an event batch to be able to drop when releasing space for persistent storage per time. |
36
+ | [overrideInstrumentationKey](https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-offlinechannel-js/interfaces/IOfflineChannelConfiguration.html#overrideInstrumentationKey) | [Optional] | null | Identifies overridden for the Instrumentation key when the offline channel calls `processTelemetry`. |
37
+
38
+ ### [IOfflineSenderConfig](https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-offlinechannel-js/interfaces/IOfflineSenderConfig.html)
39
39
 
40
40
  | Name | Type | Default | Description |
41
41
  |------|------|---------|-------------|
42
- | retryCodes | [Optional] | `[401, 403, 408, 429, 500, 502, 503, 504]` | Identifies status codes for re-sending event batches. |
43
- | transports | [Optional] | null | Either an array or single value identifying the requested TransportType type(s) that should be used for sending events. If not defined, the same transports will be used in the channel with the `primaryOnlineChannelI`. |
44
- | httpXHROverride | [Optional] | null | The HTTP override that should be used to send requests, as an `IXHROverride` object. |
45
- | alwaysUseXhrOverride | [Optional] | false | Identifies if provided httpXhrOverride will always be used. |
42
+ | [retryCodes](https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-offlinechannel-js/interfaces/IOfflineSenderConfig.html#retryCodes) | [Optional] | `[401, 403, 408, 429, 500, 502, 503, 504]` | Identifies status codes for re-sending event batches. |
43
+ | [transports](https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-offlinechannel-js/interfaces/IOfflineSenderConfig.html#transports) | [Optional] | null | Either an array or single value identifying the requested TransportType type(s) that should be used for sending events. If not defined, the same transports will be used in the channel with the `primaryOnlineChannelI`. |
44
+ | [httpXHROverride](https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-offlinechannel-js/interfaces/IOfflineSenderConfig.html#httpXHROverride) | [Optional] | null | The HTTP override that should be used to send requests, as an `IXHROverride` object. |
45
+ | [alwaysUseXhrOverride](https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-offlinechannel-js/interfaces/IOfflineSenderConfig.html#alwaysUseXhrOverride) | [Optional] | false | Identifies if provided httpXhrOverride will always be used. |
46
46
 
47
47
  ## Basic Usage
48
48
 
@@ -1,5 +1,5 @@
1
1
  /*!
2
- * Application Insights JavaScript SDK - Offline Channel, 0.4.0-nightlybeta3.2505-36
2
+ * Application Insights JavaScript SDK - Offline Channel, 0.4.0-nightlybeta3.2507-22
3
3
  * Copyright (c) Microsoft and contributors. All rights reserved.
4
4
  */
5
5
  (function (global, factory) {
@@ -841,14 +841,14 @@
841
841
 
842
842
  var createEnumStyle = createEnum;
843
843
 
844
- var EventsDiscardedReason = createEnumStyle({
844
+ var EventsDiscardedReason = ( /* @__PURE__ */createEnumStyle({
845
845
  Unknown: 0 ,
846
846
  NonRetryableStatus: 1 ,
847
847
  InvalidEvent: 2 ,
848
848
  SizeLimitExceeded: 3 ,
849
849
  KillSwitch: 4 ,
850
850
  QueueFull: 5
851
- });
851
+ }));
852
852
 
853
853
  var _DYN_TO_LOWER_CASE = "toLowerCase";
854
854
  var _DYN_LENGTH$1 = "length";
@@ -882,10 +882,11 @@
882
882
  var _DYN_USER_AGENT = "userAgent";
883
883
  var _DYN_SPLIT$1 = "split";
884
884
  var _DYN_REPLACE = "replace";
885
+ var _DYN_SUBSTRING = "substring";
886
+ var _DYN_INDEX_OF$1 = "indexOf";
885
887
  var _DYN_TYPE = "type";
886
888
  var _DYN_EVT_NAME = "evtName";
887
889
  var _DYN_STATUS = "status";
888
- var _DYN_INDEX_OF$1 = "indexOf";
889
890
  var _DYN_GET_ALL_RESPONSE_HEA5 = "getAllResponseHeaders";
890
891
  var _DYN_IS_CHILD_EVT = "isChildEvt";
891
892
  var _DYN_DATA$1 = "data";
@@ -1874,7 +1875,7 @@
1874
1875
  var idx = headerEntry[_DYN_INDEX_OF$1 ](": ");
1875
1876
  if (idx !== -1) {
1876
1877
  var header = strTrim(headerEntry.substring(0, idx))[_DYN_TO_LOWER_CASE ]();
1877
- var value = strTrim(headerEntry.substring(idx + 1));
1878
+ var value = strTrim(headerEntry[_DYN_SUBSTRING ](idx + 1));
1878
1879
  headers[header] = value;
1879
1880
  }
1880
1881
  else {
@@ -2101,7 +2102,7 @@
2101
2102
  return result;
2102
2103
  }
2103
2104
 
2104
- var version$1 = '3.4.0-nightlybeta3.2505-36';
2105
+ var version$1 = '3.4.0-nightlybeta3.2507-22';
2105
2106
  var instanceName = "." + newId(6);
2106
2107
  var _dataUid = 0;
2107
2108
  function _canAcceptData(target) {
@@ -2767,6 +2768,29 @@
2767
2768
  return createDynamicConfig(config, null, logger)[_DYN_WATCH ](configHandler);
2768
2769
  }
2769
2770
 
2771
+ function newGuid() {
2772
+ var uuid = generateW3CId();
2773
+ return strSubstring(uuid, 0, 8) + "-" + strSubstring(uuid, 8, 12) + "-" + strSubstring(uuid, 12, 16) + "-" + strSubstring(uuid, 16, 20) + "-" + strSubstring(uuid, 20);
2774
+ }
2775
+ function generateW3CId() {
2776
+ var hexValues = ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "a", "b", "c", "d", "e", "f"];
2777
+ var oct = STR_EMPTY$1, tmp;
2778
+ for (var a = 0; a < 4; a++) {
2779
+ tmp = random32();
2780
+ oct +=
2781
+ hexValues[tmp & 0xF] +
2782
+ hexValues[tmp >> 4 & 0xF] +
2783
+ hexValues[tmp >> 8 & 0xF] +
2784
+ hexValues[tmp >> 12 & 0xF] +
2785
+ hexValues[tmp >> 16 & 0xF] +
2786
+ hexValues[tmp >> 20 & 0xF] +
2787
+ hexValues[tmp >> 24 & 0xF] +
2788
+ hexValues[tmp >> 28 & 0xF];
2789
+ }
2790
+ var clockSequenceHi = hexValues[8 + (random32() & 0x03) | 0];
2791
+ return strSubstr(oct, 0, 8) + strSubstr(oct, 9, 4) + "4" + strSubstr(oct, 13, 3) + clockSequenceHi + strSubstr(oct, 16, 3) + strSubstr(oct, 19, 12);
2792
+ }
2793
+
2770
2794
  function runTargetUnload(target, isAsync) {
2771
2795
  if (target && target[_DYN_UNLOAD ]) {
2772
2796
  return target[_DYN_UNLOAD ](isAsync);
@@ -3088,29 +3112,6 @@
3088
3112
  return func();
3089
3113
  }
3090
3114
 
3091
- function newGuid() {
3092
- var uuid = generateW3CId();
3093
- return strSubstring(uuid, 0, 8) + "-" + strSubstring(uuid, 8, 12) + "-" + strSubstring(uuid, 12, 16) + "-" + strSubstring(uuid, 16, 20) + "-" + strSubstring(uuid, 20);
3094
- }
3095
- function generateW3CId() {
3096
- var hexValues = ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "a", "b", "c", "d", "e", "f"];
3097
- var oct = STR_EMPTY$1, tmp;
3098
- for (var a = 0; a < 4; a++) {
3099
- tmp = random32();
3100
- oct +=
3101
- hexValues[tmp & 0xF] +
3102
- hexValues[tmp >> 4 & 0xF] +
3103
- hexValues[tmp >> 8 & 0xF] +
3104
- hexValues[tmp >> 12 & 0xF] +
3105
- hexValues[tmp >> 16 & 0xF] +
3106
- hexValues[tmp >> 20 & 0xF] +
3107
- hexValues[tmp >> 24 & 0xF] +
3108
- hexValues[tmp >> 28 & 0xF];
3109
- }
3110
- var clockSequenceHi = hexValues[8 + (random32() & 0x03) | 0];
3111
- return strSubstr(oct, 0, 8) + strSubstr(oct, 9, 4) + "4" + strSubstr(oct, 13, 3) + clockSequenceHi + strSubstr(oct, 16, 3) + strSubstr(oct, 19, 12);
3112
- }
3113
-
3114
3115
  var pluginStateData = createElmNodeData("plugin");
3115
3116
  function _getPluginState(plugin) {
3116
3117
  return pluginStateData.get(plugin, "state", {}, true);
@@ -3199,27 +3200,26 @@
3199
3200
  }
3200
3201
  function _getExtCfg(identifier, createIfMissing) {
3201
3202
  var idCfg = null;
3202
- var cfg = dynamicHandler.cfg;
3203
+ var extCfg = _getCfg(dynamicHandler.cfg, "extensionConfig", createIfMissing);
3204
+ if (extCfg) {
3205
+ idCfg = _getCfg(extCfg, identifier, createIfMissing);
3206
+ }
3207
+ return idCfg;
3208
+ }
3209
+ function _getCfg(cfg, identifier, createIfMissing) {
3210
+ var idCfg = null;
3203
3211
  if (cfg && identifier) {
3204
- var extCfg = cfg[STR_EXTENSION_CONFIG ];
3205
- if (!extCfg && createIfMissing) {
3206
- extCfg = {};
3207
- }
3208
- cfg[STR_EXTENSION_CONFIG] = extCfg;
3209
- extCfg = dynamicHandler.ref(cfg, STR_EXTENSION_CONFIG);
3210
- if (extCfg) {
3211
- idCfg = extCfg[identifier];
3212
- if (!idCfg && createIfMissing) {
3213
- idCfg = {};
3214
- }
3215
- extCfg[identifier] = idCfg;
3216
- idCfg = dynamicHandler.ref(extCfg, identifier);
3212
+ idCfg = cfg[identifier];
3213
+ if (!idCfg && createIfMissing) {
3214
+ idCfg = {};
3217
3215
  }
3216
+ cfg[identifier] = idCfg;
3217
+ idCfg = dynamicHandler.ref(cfg, identifier);
3218
3218
  }
3219
3219
  return idCfg;
3220
3220
  }
3221
- function _resolveExtCfg(identifier, defaultValues) {
3222
- var newConfig = _getExtCfg(identifier, true);
3221
+ function _resolveExtCfg(identifier, defaultValues, rootOnly) {
3222
+ var newConfig = rootOnly ? _getCfg(dynamicHandler.cfg, identifier, true) : _getExtCfg(identifier, true);
3223
3223
  if (defaultValues) {
3224
3224
  objForEachKey(defaultValues, function (field, defaultValue) {
3225
3225
  if (isNullOrUndefined(newConfig[field])) {
@@ -4358,33 +4358,33 @@
4358
4358
  }
4359
4359
  }
4360
4360
 
4361
- var StorageType = createEnumStyle({
4361
+ var StorageType = ( /* @__PURE__ */createEnumStyle({
4362
4362
  Unknown: 0 ,
4363
4363
  LocalStorage: 1 ,
4364
4364
  SessionStorage: 2 ,
4365
4365
  IndexDb: 3
4366
- });
4367
- var BatchSendStatus = createEnumStyle({
4366
+ }));
4367
+ var BatchSendStatus = ( /* @__PURE__ */createEnumStyle({
4368
4368
  Complete: 1 ,
4369
4369
  Retry: 2 ,
4370
4370
  Drop: 3 ,
4371
4371
  Failure: 4
4372
- });
4373
- var BatchStoreStatus = createEnumStyle({
4372
+ }));
4373
+ var BatchStoreStatus = ( /* @__PURE__ */createEnumStyle({
4374
4374
  Success: 1 ,
4375
4375
  Failure: 2
4376
- });
4376
+ }));
4377
4377
 
4378
- var StorageProviders = createEnumStyle({
4378
+ var StorageProviders = ( /* @__PURE__ */createEnumStyle({
4379
4379
  LocalStorage: 1 ,
4380
4380
  SessionStorage: 2 ,
4381
4381
  IndexedDb: 3
4382
- });
4382
+ }));
4383
4383
 
4384
- var EventPersistence = createEnumStyle({
4384
+ var EventPersistence = ( /* @__PURE__ */createEnumStyle({
4385
4385
  Normal: 1 ,
4386
4386
  Critical: 2
4387
- });
4387
+ }));
4388
4388
 
4389
4389
  function _disableEvents(target, evtNamespace) {
4390
4390
  eventOff(target, null, null, evtNamespace);
@@ -6496,7 +6496,7 @@
6496
6496
  return Sender;
6497
6497
  }());
6498
6498
 
6499
- var version = '0.4.0-nightlybeta3.2505-36';
6499
+ var version = '0.4.0-nightlybeta3.2507-22';
6500
6500
  var DefaultOfflineIdentifier = "OfflineChannel";
6501
6501
  var DefaultBatchInterval = 15000;
6502
6502
  var DefaultInMemoMaxTime = 15000;