@microsoft/applicationinsights-core-js 3.0.0-beta.2211-01 → 3.0.0-beta.2211-04

package/dist/applicationinsights-core-js.api.json

@@ -2251,7 +2251,7 @@
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export declare type _InternalMessageId = "
+              "text": "export type _InternalMessageId = "
             },
             {
               "kind": "Content",
@@ -3709,6 +3709,41 @@
               "isOptional": false,
               "name": "flush"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@microsoft/applicationinsights-core-js!AppInsightsCore#getChannels:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "getChannels(): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "IChannelControls",
+                  "canonicalReference": "@microsoft/applicationinsights-core-js!IChannelControls:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [],
+              "isOptional": false,
+              "name": "getChannels"
+            },
             {
               "kind": "Method",
               "canonicalReference": "@microsoft/applicationinsights-core-js!AppInsightsCore#getCookieMgr:member(1)",
@@ -3968,41 +4003,6 @@
               "isOptional": false,
               "name": "getTraceCtx"
             },
-            {
-              "kind": "Method",
-              "canonicalReference": "@microsoft/applicationinsights-core-js!AppInsightsCore#getTransmissionControls:member(1)",
-              "docComment": "",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "getTransmissionControls(): "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "IChannelControls",
-                  "canonicalReference": "@microsoft/applicationinsights-core-js!IChannelControls:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": "[][]"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isStatic": false,
-              "returnTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 3
-              },
-              "releaseTag": "Public",
-              "isProtected": false,
-              "overloadIndex": 1,
-              "parameters": [],
-              "isOptional": false,
-              "name": "getTransmissionControls"
-            },
             {
               "kind": "Property",
               "canonicalReference": "@microsoft/applicationinsights-core-js!AppInsightsCore#getWParam:member",
@@ -4354,8 +4354,9 @@
                   "text": "): "
                 },
                 {
-                  "kind": "Content",
-                  "text": "number"
+                  "kind": "Reference",
+                  "text": "ITimerHandler",
+                  "canonicalReference": "@nevware21/ts-utils!ITimerHandler:interface"
                 },
                 {
                   "kind": "Content",
@@ -7907,7 +7908,7 @@
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export declare type EventsDiscardedReason = "
+              "text": "export type EventsDiscardedReason = "
             },
             {
               "kind": "Content",
@@ -9247,6 +9248,39 @@
               ],
               "name": "flush"
             },
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "@microsoft/applicationinsights-core-js!IAppInsightsCore#getChannels:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "getChannels(): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "IChannelControls",
+                  "canonicalReference": "@microsoft/applicationinsights-core-js!IChannelControls:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [],
+              "name": "getChannels"
+            },
             {
               "kind": "MethodSignature",
               "canonicalReference": "@microsoft/applicationinsights-core-js!IAppInsightsCore#getCookieMgr:member(1)",
@@ -9465,39 +9499,6 @@
               ],
               "name": "getTraceCtx"
             },
-            {
-              "kind": "MethodSignature",
-              "canonicalReference": "@microsoft/applicationinsights-core-js!IAppInsightsCore#getTransmissionControls:member(1)",
-              "docComment": "",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "getTransmissionControls(): "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "IChannelControls",
-                  "canonicalReference": "@microsoft/applicationinsights-core-js!IChannelControls:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": "[][]"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isOptional": false,
-              "returnTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 3
-              },
-              "releaseTag": "Public",
-              "overloadIndex": 1,
-              "parameters": [],
-              "name": "getTransmissionControls"
-            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@microsoft/applicationinsights-core-js!IAppInsightsCore#getWParam:member",
@@ -9835,8 +9836,9 @@
                   "text": "): "
                 },
                 {
-                  "kind": "Content",
-                  "text": "number"
+                  "kind": "Reference",
+                  "text": "ITimerHandler",
+                  "canonicalReference": "@nevware21/ts-utils!ITimerHandler:interface"
                 },
                 {
                   "kind": "Content",
@@ -10730,7 +10732,7 @@
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "flush(async: "
+                  "text": "flush?(async: "
                 },
                 {
                   "kind": "Content",
@@ -10766,7 +10768,7 @@
                   "text": ";"
                 }
               ],
-              "isOptional": false,
+              "isOptional": true,
               "returnTypeTokenRange": {
                 "startIndex": 7,
                 "endIndex": 8
@@ -10808,7 +10810,7 @@
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "pause(): "
+                  "text": "pause?(): "
                 },
                 {
                   "kind": "Content",
@@ -10819,7 +10821,7 @@
                   "text": ";"
                 }
               ],
-              "isOptional": false,
+              "isOptional": true,
               "returnTypeTokenRange": {
                 "startIndex": 1,
                 "endIndex": 2
@@ -10836,7 +10838,7 @@
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "resume(): "
+                  "text": "resume?(): "
                 },
                 {
                   "kind": "Content",
@@ -10847,7 +10849,7 @@
                   "text": ";"
                 }
               ],
-              "isOptional": false,
+              "isOptional": true,
               "returnTypeTokenRange": {
                 "startIndex": 1,
                 "endIndex": 2
@@ -10864,7 +10866,7 @@
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "teardown: "
+                  "text": "teardown?: "
                 },
                 {
                   "kind": "Content",
@@ -10894,7 +10896,7 @@
                 }
               ],
               "isReadonly": false,
-              "isOptional": false,
+              "isOptional": true,
               "releaseTag": "Public",
               "name": "teardown",
               "propertyTypeTokenRange": {
@@ -10917,7 +10919,7 @@
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export declare type IConfigCheckFn<V> = "
+              "text": "export type IConfigCheckFn<V> = "
             },
             {
               "kind": "Content",
@@ -11181,7 +11183,7 @@
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export declare type IConfigDefaults<T, C extends "
+              "text": "export type IConfigDefaults<T, C extends "
             },
             {
               "kind": "Reference",
@@ -11258,7 +11260,7 @@
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export declare type IConfigSetFn<T, V> = "
+              "text": "export type IConfigSetFn<T, V> = "
             },
             {
               "kind": "Content",
@@ -15757,7 +15759,7 @@
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export declare type InstrumentorHooksCallback = "
+              "text": "export type InstrumentorHooksCallback = "
             },
             {
               "kind": "Content",
@@ -19333,7 +19335,7 @@
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export declare type LoggingSeverity = "
+              "text": "export type LoggingSeverity = "
             },
             {
               "kind": "Content",
@@ -24122,7 +24124,7 @@
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export declare type UnloadHandler = "
+              "text": "export type UnloadHandler = "
             },
             {
               "kind": "Content",
@@ -24194,7 +24196,7 @@
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export declare type WatcherFunction<T extends "
+              "text": "export type WatcherFunction<T extends "
             },
             {
               "kind": "Reference",

package/dist/applicationinsights-core-js.api.md

@@ -39,6 +39,7 @@ import { isSymbol } from '@nevware21/ts-utils';
 import { isTruthy } from '@nevware21/ts-utils';
 import { isTypeof } from '@nevware21/ts-utils';
 import { isUndefined } from '@nevware21/ts-utils';
+import { ITimerHandler } from '@nevware21/ts-utils';
 import { objCreateFn as objCreate } from '@microsoft/applicationinsights-shims';
 import { objDefineAccessors } from '@nevware21/ts-utils';
 import { objForEachKey } from '@nevware21/ts-utils';
@@ -90,6 +91,8 @@ export class AppInsightsCore implements IAppInsightsCore {
     eventCnt(): number;
     evtNamespace(): string;
     flush(isAsync?: boolean, callBack?: (flushComplete?: boolean) => void, sendReason?: SendRequestReason): void;
+    // (undocumented)
+    getChannels(): IChannelControls[];
     getCookieMgr(): ICookieMgr;
     // (undocumented)
     getNotifyMgr(): INotificationManager;
@@ -100,8 +103,6 @@ export class AppInsightsCore implements IAppInsightsCore {
     // (undocumented)
     getProcessTelContext(): IProcessTelemetryContext;
     getTraceCtx(createNew?: boolean): IDistributedTraceContext | null;
-    // (undocumented)
-    getTransmissionControls(): IChannelControls[][];
     getWParam: () => number;
     // (undocumented)
     initialize(config: IConfiguration, extensions: IPlugin[], logger?: IDiagnosticLogger, notificationManager?: INotificationManager): void;
@@ -111,7 +112,7 @@ export class AppInsightsCore implements IAppInsightsCore {
     onCfgChange<T extends IConfiguration = IConfiguration>(handler: WatcherFunction<T>): IUnloadHook;
     readonly pluginVersionString: string;
     readonly pluginVersionStringArr: string[];
-    pollInternalLogs(eventName?: string): number;
+    pollInternalLogs(eventName?: string): ITimerHandler;
     // (undocumented)
     protected releaseQueue(): void;
     removeNotificationListener(listener: INotificationListener): void;
@@ -533,13 +534,13 @@ export interface IAppInsightsCore extends IPerfManagerProvider {
     config: IConfiguration;
     evtNamespace(): string;
     flush(isAsync?: boolean, callBack?: (flushComplete?: boolean) => void, sendReason?: SendRequestReason, cbTimeout?: number): boolean | void;
+    // (undocumented)
+    getChannels(): IChannelControls[];
     getCookieMgr(): ICookieMgr;
     getNotifyMgr(): INotificationManager;
     getPlugin<T extends IPlugin = IPlugin>(pluginIdentifier: string): ILoadedPlugin<T>;
     getProcessTelContext(): IProcessTelemetryContext;
     getTraceCtx(createNew?: boolean): IDistributedTraceContext | null;
-    // (undocumented)
-    getTransmissionControls(): IChannelControls[][];
     getWParam: () => number;
     // (undocumented)
     initialize(config: IConfiguration, extensions: IPlugin[], logger?: IDiagnosticLogger, notificationManager?: INotificationManager): void;
@@ -550,7 +551,7 @@ export interface IAppInsightsCore extends IPerfManagerProvider {
     readonly pluginVersionString: string;
     readonly pluginVersionStringArr: string[];
     // (undocumented)
-    pollInternalLogs?(eventName?: string): number;
+    pollInternalLogs?(eventName?: string): ITimerHandler;
     removeNotificationListener?(listener: INotificationListener): void;
     setCookieMgr(cookieMgr: ICookieMgr): void;
     setTraceCtx(newTraceCtx: IDistributedTraceContext | null | undefined): void;
@@ -579,10 +580,10 @@ export interface IBaseProcessingContext {
 
 // @public
 export interface IChannelControls extends ITelemetryPlugin {
-    flush(async: boolean, callBack?: (flushComplete?: boolean) => void, sendReason?: SendRequestReason): boolean | void;
-    pause(): void;
-    resume(): void;
-    teardown: (unloadCtx?: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState) => void | boolean;
+    flush?(async: boolean, callBack?: (flushComplete?: boolean) => void, sendReason?: SendRequestReason): boolean | void;
+    pause?(): void;
+    resume?(): void;
+    teardown?: (unloadCtx?: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState) => void | boolean;
 }
 
 // @public

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

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights Core Javascript SDK, 3.0.0-beta.2211-01
+ * Microsoft Application Insights Core Javascript SDK, 3.0.0-beta.2211-04
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -42,6 +42,7 @@ declare namespace ApplicationInsights {
     import { isTruthy } from '@nevware21/ts-utils';
     import { isTypeof } from '@nevware21/ts-utils';
     import { isUndefined } from '@nevware21/ts-utils';
+    import { ITimerHandler } from '@nevware21/ts-utils';
     import { objCreateFn as objCreate } from '@microsoft/applicationinsights-shims';
     import { objDefineAccessors } from '@nevware21/ts-utils';
     import { objForEachKey } from '@nevware21/ts-utils';
@@ -150,7 +151,7 @@ declare namespace ApplicationInsights {
         getWParam: () => number;
         constructor();
         initialize(config: IConfiguration, extensions: IPlugin[], logger?: IDiagnosticLogger, notificationManager?: INotificationManager): void;
-        getTransmissionControls(): IChannelControls[][];
+        getChannels(): IChannelControls[];
         track(telemetryItem: ITelemetryItem): void;
         getProcessTelContext(): IProcessTelemetryContext;
         getNotifyMgr(): INotificationManager;
@@ -181,7 +182,7 @@ declare namespace ApplicationInsights {
         /**
          * Periodically check logger.queue for
          */
-        pollInternalLogs(eventName?: string): number;
+        pollInternalLogs(eventName?: string): ITimerHandler;
         /**
          * Periodically check logger.queue for
          */
@@ -853,7 +854,7 @@ declare namespace ApplicationInsights {
          */
         isInitialized?: () => boolean;
         initialize(config: IConfiguration, extensions: IPlugin[], logger?: IDiagnosticLogger, notificationManager?: INotificationManager): void;
-        getTransmissionControls(): IChannelControls[][];
+        getChannels(): IChannelControls[];
         track(telemetryItem: ITelemetryItem): void;
         /**
          * Get the current notification manager
@@ -886,7 +887,7 @@ declare namespace ApplicationInsights {
          * @returns - A ITelemetryInitializerHandler to enable the initializer to be removed
          */
         addTelemetryInitializer(telemetryInitializer: TelemetryInitializerFunction): ITelemetryInitializerHandler;
-        pollInternalLogs?(eventName?: string): number;
+        pollInternalLogs?(eventName?: string): ITimerHandler;
         stopPollingInternalLogs?(): void;
         /**
          * Return a new instance of the IProcessTelemetryContext for processing events
@@ -1039,11 +1040,11 @@ declare namespace ApplicationInsights {
         /**
          * Pause sending data
          */
-        pause(): void;
+        pause?(): void;
         /**
          * Resume sending data
          */
-        resume(): void;
+        resume?(): void;
         /**
          * Tear down the plugin and remove any hooked value, the plugin should be removed so that it is no longer initialized and
          * therefore could be re-initialized after being torn down. The plugin should ensure that once this has been called any further
@@ -1052,7 +1053,7 @@ declare namespace ApplicationInsights {
          * @param unloadState - The details / state of the unload process, it holds details like whether it should be unloaded synchronously or asynchronously and the reason for the unload.
          * @returns boolean - true if the plugin has or will call processNext(), this for backward compatibility as previously teardown was synchronous and returned nothing.
          */
-        teardown: (unloadCtx?: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState) => void | boolean;
+        teardown?: (unloadCtx?: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState) => void | boolean;
         /**
          * Flush to send data immediately; channel should default to sending data asynchronously
          * @param async - send data asynchronously when true
@@ -1061,7 +1062,7 @@ declare namespace ApplicationInsights {
          * @param sendReason - specify the reason that you are calling "flush" defaults to ManualFlush (1) if not specified
          * @returns - true if the callback will be return after the flush is complete otherwise the caller should assume that any provided callback will never be called
          */
-        flush(async: boolean, callBack?: (flushComplete?: boolean) => void, sendReason?: SendRequestReason): boolean | void;
+        flush?(async: boolean, callBack?: (flushComplete?: boolean) => void, sendReason?: SendRequestReason): boolean | void;
     }
 
     /**