@microsoft/applicationinsights-offlinechannel-js 0.3.5-nightly3.2411-13 → 0.3.5-nightly3.2412-01

package/dist-es5/applicationinsights-offlinechannel-js.js

@@ -1,5 +1,5 @@
 /*
- * Application Insights JavaScript SDK - Offline Channel, 0.3.5-nightly3.2411-13
+ * Application Insights JavaScript SDK - Offline Channel, 0.3.5-nightly3.2412-01
  * Copyright (c) Microsoft and contributors. All rights reserved.
  */
 export { BatchSendStatus, BatchStoreStatus, StorageType } from "./Interfaces/IOfflineBatch";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@microsoft/applicationinsights-offlinechannel-js",
-    "version": "0.3.5-nightly3.2411-13",
+    "version": "0.3.5-nightly3.2412-01",
     "description": "Microsoft Application Insights JavaScript SDK Offline Channel",
     "homepage": "https://github.com/microsoft/ApplicationInsights-JS#readme",
     "author": "Microsoft Application Insights Team",
@@ -28,8 +28,8 @@
     "dependencies": {
         "@microsoft/dynamicproto-js": "^2.0.3",
         "@microsoft/applicationinsights-shims": "3.0.1",
-        "@microsoft/applicationinsights-core-js": "3.3.5-nightly3.2411-13",
-        "@microsoft/applicationinsights-common": "3.3.5-nightly3.2411-13",
+        "@microsoft/applicationinsights-core-js": "3.3.5-nightly3.2412-01",
+        "@microsoft/applicationinsights-common": "3.3.5-nightly3.2412-01",
         "@nevware21/ts-utils": ">= 0.11.3 < 2.x",
         "@nevware21/ts-async": ">= 0.5.2 < 2.x"
     },

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

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights JavaScript SDK Offline Channel, 0.3.5-nightly3.2411-13
+ * Microsoft Application Insights JavaScript SDK Offline Channel, 0.3.5-nightly3.2412-01
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -102,15 +102,16 @@ export declare interface IInMemoryBatch {
     /**
      * Split this batch into 2 with any events > fromEvent returned in the new batch and all other
      * events are kept in the current batch.
-     * @param fromEvt The first event to remove from the current batch.
-     * @param numEvts The number of events to be removed from the current batch and returned in the new one. Defaults to all trailing events
+     * @param fromEvt - The first event to remove from the current batch.
+
+     * @param numEvts - The number of events to be removed from the current batch and returned in the new one. Defaults to all trailing events
      */
     split: (fromEvt: number, numEvts?: number) => IInMemoryBatch;
     /**
      * create current buffer to a new endpoint with current logger
-     * @param endpoint new endpoint
-     * @param evts new events to be added
-     * @param evtsLimitInMem new evtsLimitInMem
+     * @param endpoint - new endpoint
+     * @param evts - new events to be added
+     * @param evtsLimitInMem - new evtsLimitInMem
      */
     createNew(endpoint: string, evts?: IPostTransmissionTelemetryItem[] | ITelemetryItem[], evtsLimitInMem?: number): IInMemoryBatch;
 }
@@ -154,7 +155,7 @@ export declare class IndexedDbProvider implements IOfflineProvider {
     constructor(id?: string, unloadHookContainer?: IUnloadHookContainer);
     /**
      * Initializes the provider using the config
-     * @param providerContext The provider context that should be used to initialize the provider
+     * @param providerContext - The provider context that should be used to initialize the provider
      * @returns True if the provider is initialized and available for use otherwise false
      */
     initialize(providerContext: ILocalStorageProviderContext): boolean;
@@ -208,15 +209,16 @@ export declare class InMemoryBatch implements IInMemoryBatch {
     /**
      * Split this batch into 2 with any events > fromEvent returned in the new batch and all other
      * events are kept in the current batch.
-     * @param fromEvt The first event to remove from the current batch.
-     * @param numEvts The number of events to be removed from the current batch and returned in the new one. Defaults to all trailing events
+     * @param fromEvt - The first event to remove from the current batch.
+
+     * @param numEvts - The number of events to be removed from the current batch and returned in the new one. Defaults to all trailing events
      */
     split(fromEvt: number, numEvts?: number): any;
     /**
      * create current buffer to a new endpoint
-     * @param endpoint if not defined, current endpoint will be used
-     * @param evts new events to be added
-     * @param addCurEvts if it is set to true, current itemss will be transferred to the new batch
+     * @param endpoint - if not defined, current endpoint will be used
+     * @param evts - new events to be added
+     * @param addCurEvts - if it is set to true, current itemss will be transferred to the new batch
      */
     createNew(endpoint: string, evts?: IPostTransmissionTelemetryItem[] | ITelemetryItem[], evtsLimitInMem?: number): any;
 }
@@ -372,7 +374,7 @@ export declare interface IOfflineDetectorCfg {
 export declare interface IOfflineProvider {
     /**
      * Initializes the provider using the config
-     * @param providerContext The provider context that should be used to initialize the provider
+     * @param providerContext - The provider context that should be used to initialize the provider
      * @returns True if the provider is initialized and available for use otherwise false
      */
     initialize(providerContext: ILocalStorageProviderContext): boolean;
@@ -396,7 +398,7 @@ export declare interface IOfflineProvider {
     getNextBatch(): IStorageTelemetryItem[] | IPromise<IStorageTelemetryItem[]> | null;
     /**
      * Get all stored batches from the storage.
-     * @param cnt batch numbers if it is defined, it will returns given number of batches.
+     * @param cnt - batch numbers if it is defined, it will returns given number of batches.
      * if cnt is not defined, it will return all available batches
      */
     getAllEvents(cnt?: number): IStorageTelemetryItem[] | IPromise<IStorageTelemetryItem[]> | null;
@@ -589,7 +591,7 @@ export declare class WebStorageProvider implements IOfflineProvider {
     id: string;
     /**
      * Creates a WebStorageProvider using the provider storageType
-     * @param storageType The type of Storage provider, normal values are "localStorage" or "sessionStorage"
+     * @param storageType - The type of Storage provider, normal values are "localStorage" or "sessionStorage"
      */
     constructor(storageType: string, id?: string, unloadHookContainer?: IUnloadHookContainer);
     /**

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

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights JavaScript SDK Offline Channel, 0.3.5-nightly3.2411-13
+ * Microsoft Application Insights JavaScript SDK Offline Channel, 0.3.5-nightly3.2412-01
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -448,7 +448,6 @@ declare namespace ApplicationInsights {
         unload(isAsync?: boolean, unloadComplete?: (unloadState: ITelemetryUnloadState) => void, cbTimeout?: number): void | IPromise<ITelemetryUnloadState>;
         /**
          * Find and return the (first) plugin with the specified identifier if present
-         * @param pluginIdentifier
          */
         getPlugin<T extends IPlugin = IPlugin>(pluginIdentifier: string): ILoadedPlugin<T>;
         /**
@@ -503,7 +502,6 @@ declare namespace ApplicationInsights {
         /**
          * Watches and tracks changes for accesses to the current config, and if the accessed config changes the
          * handler will be recalled.
-         * @param handler
          * @returns A watcher handler instance that can be used to remove itself when being unloaded
          */
         onCfgChange(handler: WatcherFunction<CfgType>): IUnloadHook;
@@ -750,7 +748,7 @@ declare namespace ApplicationInsights {
          */
         disableFlushOnBeforeUnload?: boolean;
         /**
-         * Default value of {@link #disableFlushOnBeforeUnload}. If true, flush method will not be called when onPageHide or onVisibilityChange (hidden state) event(s) trigger.
+         * Default value of `disableFlushOnBeforeUnload`. If true, flush method will not be called when onPageHide or onVisibilityChange (hidden state) event(s) trigger.
          */
         disableFlushOnUnload?: boolean;
         /**
@@ -802,12 +800,12 @@ declare namespace ApplicationInsights {
          */
         isStorageUseDisabled?: boolean;
         /**
-         * If false, the SDK will send all telemetry using the [Beacon API](https://www.w3.org/TR/beacon)
+         * If false, the SDK will send all telemetry using the <a href="https://www.w3.org/TR/beacon">Beacon API</a>.
          * @defaultValue true
          */
         isBeaconApiDisabled?: boolean;
         /**
-         * Don't use XMLHttpRequest or XDomainRequest (for IE < 9) by default instead attempt to use fetch() or sendBeacon.
+         * Don't use XMLHttpRequest or XDomainRequest (for IE \< 9) by default instead attempt to use fetch() or sendBeacon.
          * If no other transport is available it will still use XMLHttpRequest
          */
         disableXhr?: boolean;
@@ -1064,8 +1062,8 @@ declare namespace ApplicationInsights {
          * be logged to console if their severity meets the configured loggingConsoleLevel
          *
          * 0: ALL console logging off
-         * 1: logs to console: severity >= CRITICAL
-         * 2: logs to console: severity >= WARNING
+         * 1: logs to console: severity \>= CRITICAL
+         * 2: logs to console: severity \>= WARNING
          */
         loggingLevelConsole?: number;
         /**
@@ -1074,8 +1072,8 @@ declare namespace ApplicationInsights {
          * the configured instrumentation key.
          *
          * 0: ALL iKey logging off
-         * 1: logs to iKey: severity >= CRITICAL
-         * 2: logs to iKey: severity >= WARNING
+         * 1: logs to iKey: severity \>= CRITICAL
+         * 2: logs to iKey: severity \>= WARNING
          */
         loggingLevelTelemetry?: number;
         /**
@@ -1102,7 +1100,6 @@ declare namespace ApplicationInsights {
          */
         readonly channels?: IChannelControls[][];
         /**
-         * @type {boolean}
          * Flag that disables the Instrumentation Key validation.
          */
         disableInstrumentationKeyValidation?: boolean;
@@ -1133,14 +1130,12 @@ declare namespace ApplicationInsights {
         /**
          * @description Custom cookie domain. This is helpful if you want to share Application Insights cookies across subdomains. It
          * can be set here or as part of the cookieCfg.domain, the cookieCfg takes precedence if both are specified.
-         * @type {string}
          * @defaultValue ""
          */
         cookieDomain?: string;
         /**
          * @description Custom cookie path. This is helpful if you want to share Application Insights cookies behind an application
          * gateway. It can be set here or as part of the cookieCfg.domain, the cookieCfg takes precedence if both are specified.
-         * @type {string}
          * @defaultValue ""
          */
         cookiePath?: string;
@@ -1252,7 +1247,7 @@ declare namespace ApplicationInsights {
         /**
          * Optional Callback hook to allow the cookie manager to update it's configuration, not generally implemented now that
          * dynamic configuration is supported
-         * @param updateState
+         * @param updateState - The new configuration state to apply to the cookie manager
          */
         update?(updateState: ITelemetryUpdateState): void;
         /**
@@ -1366,7 +1361,7 @@ declare namespace ApplicationInsights {
         logInternalMessage?(severity: LoggingSeverity, message: _InternalLogMessage): void;
         /**
          * Optional Callback hook to allow the diagnostic logger to update it's configuration
-         * @param updateState
+         * @param updateState - The new configuration state to apply to the diagnostic logger
          */
         update?(updateState: ITelemetryUpdateState): void;
         /**
@@ -1387,7 +1382,7 @@ declare namespace ApplicationInsights {
         getName(): string;
         /**
          * Sets the current name of the page
-         * @param pageName
+         * @param pageName - The name of the page
          */
         setName(pageName: string): void;
         /**
@@ -1419,7 +1414,7 @@ declare namespace ApplicationInsights {
         getTraceFlags(): number | undefined;
         /**
          * https://www.w3.org/TR/trace-context/#trace-flags
-         * @param newValue
+         * @param newValue - An integer representation of the W3C TraceContext trace-flags.
          */
         setTraceFlags(newValue?: number): void;
     }
@@ -1458,10 +1453,10 @@ declare namespace ApplicationInsights {
          *
          * This callback is called before telemetry data is sent, allowing for dynamic customization of the logs.
          *
-         * @returns {Object} An object with the following property:
+         * @returns An object with the following property:
          * - logs: An array of strings, where each string represents a log entry to be included in the telemetry.
          *
-         * @property {number} maxLogs - Specifies the maximum number of logs that can be generated. If not explicitly set, it defaults to 50.
+         * @property maxLogs - Specifies the maximum number of logs that can be generated. If not explicitly set, it defaults to 50.
          */
         expLog?: () => {
             logs: string[];
@@ -1528,15 +1523,16 @@ declare namespace ApplicationInsights {
         /**
          * Split this batch into 2 with any events > fromEvent returned in the new batch and all other
          * events are kept in the current batch.
-         * @param fromEvt The first event to remove from the current batch.
-         * @param numEvts The number of events to be removed from the current batch and returned in the new one. Defaults to all trailing events
+         * @param fromEvt - The first event to remove from the current batch.
+
+         * @param numEvts - The number of events to be removed from the current batch and returned in the new one. Defaults to all trailing events
          */
         split: (fromEvt: number, numEvts?: number) => IInMemoryBatch;
         /**
          * create current buffer to a new endpoint with current logger
-         * @param endpoint new endpoint
-         * @param evts new events to be added
-         * @param evtsLimitInMem new evtsLimitInMem
+         * @param endpoint - new endpoint
+         * @param evts - new events to be added
+         * @param evtsLimitInMem - new evtsLimitInMem
          */
         createNew(endpoint: string, evts?: IPostTransmissionTelemetryItem[] | ITelemetryItem[], evtsLimitInMem?: number): IInMemoryBatch;
     }
@@ -1552,32 +1548,31 @@ declare namespace ApplicationInsights {
         getUrl: () => string;
         /**
          * Create payload data
-         * @param data data
          * @returns IPayloadData
          */
         createPayload: (data: string | Uint8Array) => IPayloadData;
         /**
          * Serialize an item into a string
-         * @param input telemetry item
-         * @param convertUndefined convert undefined to a custom-defined object
+         * @param input - telemetry item
+         * @param convertUndefined - convert undefined to a custom-defined object
          * @returns Serialized string
          */
         serialize?: (input: ITelemetryItem, convertUndefined?: any) => string;
         /**
          * Batch an array of strings into one string
-         * @param arr array of strings
+         * @param arr - array of strings
          * @returns a string represent all items in the given array
          */
         batch?: (arr: string[]) => string;
         /**
          * If the item should be processed by offline channel
-         * @param evt telemetry item
+         * @param evt - telemetry item
          * @returns should process or not
          */
         shouldProcess?: (evt: ITelemetryItem) => boolean;
         /**
          * Create 1ds payload data
-         * @param evts ITelemetryItems
+         * @param evts - ITelemetryItems
          * @returns IPayloadData
          */
         createOneDSPayload?: (evts: ITelemetryItem[]) => IPayloadData;
@@ -1650,7 +1645,7 @@ declare namespace ApplicationInsights {
         constructor(id?: string, unloadHookContainer?: IUnloadHookContainer);
         /**
          * Initializes the provider using the config
-         * @param providerContext The provider context that should be used to initialize the provider
+         * @param providerContext - The provider context that should be used to initialize the provider
          * @returns True if the provider is initialized and available for use otherwise false
          */
         initialize(providerContext: ILocalStorageProviderContext): boolean;
@@ -1704,15 +1699,16 @@ declare namespace ApplicationInsights {
         /**
          * Split this batch into 2 with any events > fromEvent returned in the new batch and all other
          * events are kept in the current batch.
-         * @param fromEvt The first event to remove from the current batch.
-         * @param numEvts The number of events to be removed from the current batch and returned in the new one. Defaults to all trailing events
+         * @param fromEvt - The first event to remove from the current batch.
+
+         * @param numEvts - The number of events to be removed from the current batch and returned in the new one. Defaults to all trailing events
          */
         split(fromEvt: number, numEvts?: number): any;
         /**
          * create current buffer to a new endpoint
-         * @param endpoint if not defined, current endpoint will be used
-         * @param evts new events to be added
-         * @param addCurEvts if it is set to true, current itemss will be transferred to the new batch
+         * @param endpoint - if not defined, current endpoint will be used
+         * @param evts - new events to be added
+         * @param addCurEvts - if it is set to true, current itemss will be transferred to the new batch
          */
         createNew(endpoint: string, evts?: IPostTransmissionTelemetryItem[] | ITelemetryItem[], evtsLimitInMem?: number): any;
     }
@@ -1743,7 +1739,7 @@ declare namespace ApplicationInsights {
         /**
          * [Optional] This event is sent if you have enabled perf events, they are primarily used to track internal performance testing and debugging
          * the event can be displayed via the debug plugin extension.
-         * @param perfEvent
+         * @param perfEvent - The performance event object
          */
         perfEvent?: (perfEvent: IPerfEvent) => void;
         /**
@@ -2013,7 +2009,7 @@ declare namespace ApplicationInsights {
     interface IOfflineProvider {
         /**
          * Initializes the provider using the config
-         * @param providerContext The provider context that should be used to initialize the provider
+         * @param providerContext - The provider context that should be used to initialize the provider
          * @returns True if the provider is initialized and available for use otherwise false
          */
         initialize(providerContext: ILocalStorageProviderContext): boolean;
@@ -2037,7 +2033,7 @@ declare namespace ApplicationInsights {
         getNextBatch(): IStorageTelemetryItem[] | IPromise<IStorageTelemetryItem[]> | null;
         /**
          * Get all stored batches from the storage.
-         * @param cnt batch numbers if it is defined, it will returns given number of batches.
+         * @param cnt - batch numbers if it is defined, it will returns given number of batches.
          * if cnt is not defined, it will return all available batches
          */
         getAllEvents(cnt?: number): IStorageTelemetryItem[] | IPromise<IStorageTelemetryItem[]> | null;
@@ -2944,7 +2940,7 @@ declare namespace ApplicationInsights {
 
     /**
      * this is the callback that will be called when the network status changes
-     * @param onlineState this is the current network running state
+     * @param onlineState - this is the current network running state
      */
     type OfflineCallback = (onlineState: IOfflineState) => void;
 
@@ -3181,7 +3177,7 @@ declare namespace ApplicationInsights {
         id: string;
         /**
          * Creates a WebStorageProvider using the provider storageType
-         * @param storageType The type of Storage provider, normal values are "localStorage" or "sessionStorage"
+         * @param storageType - The type of Storage provider, normal values are "localStorage" or "sessionStorage"
          */
         constructor(storageType: string, id?: string, unloadHookContainer?: IUnloadHookContainer);
         /**