@microsoft/applicationinsights-core-js 3.0.0-beta.2301-14 → 3.0.0-beta.2301-17

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

@@ -5105,6 +5105,24 @@
                   "kind": "Content",
                   "text": "[] | "
                 },
+                {
+                  "kind": "Reference",
+                  "text": "Iterator",
+                  "canonicalReference": "!Iterator:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<"
+                },
+                {
+                  "kind": "Reference",
+                  "text": "IUnloadHook",
+                  "canonicalReference": "@microsoft/applicationinsights-core-js!IUnloadHook:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "> | "
+                },
                 {
                   "kind": "Reference",
                   "text": "ILegacyUnloadHook",
@@ -5121,7 +5139,25 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "[]"
+                  "text": "[] | "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Iterator",
+                  "canonicalReference": "!Iterator:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<"
+                },
+                {
+                  "kind": "Reference",
+                  "text": "ILegacyUnloadHook",
+                  "canonicalReference": "@microsoft/applicationinsights-core-js!ILegacyUnloadHook:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ">"
                 },
                 {
                   "kind": "Content",
@@ -5138,8 +5174,8 @@
               ],
               "isStatic": false,
               "returnTypeTokenRange": {
-                "startIndex": 10,
-                "endIndex": 11
+                "startIndex": 18,
+                "endIndex": 19
               },
               "releaseTag": "Public",
               "isProtected": true,
@@ -5149,7 +5185,7 @@
                   "parameterName": "hooks",
                   "parameterTypeTokenRange": {
                     "startIndex": 1,
-                    "endIndex": 9
+                    "endIndex": 17
                   },
                   "isOptional": false
                 }
@@ -5347,6 +5383,37 @@
               "isProtected": true,
               "isAbstract": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@microsoft/applicationinsights-core-js!BaseTelemetryPlugin#_unloadHooks:member",
+              "docComment": "/**\n * Exposes the underlying unload hook container instance for this extension to allow it to be passed down to any sub components of the class. This should NEVER be exposed or called publically as it's scope is for internal use by BaseTelemetryPlugin and any derived class (which is why it's scoped as protected)\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "protected readonly _unloadHooks: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "IUnloadHookContainer",
+                  "canonicalReference": "@microsoft/applicationinsights-core-js!IUnloadHookContainer:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "_unloadHooks",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": true,
+              "isAbstract": false
+            },
             {
               "kind": "Constructor",
               "canonicalReference": "@microsoft/applicationinsights-core-js!BaseTelemetryPlugin:constructor(1)",
@@ -6539,51 +6606,54 @@
               "kind": "Content",
               "text": "export declare function createUnloadHandlerContainer(): "
             },
-            {
-              "kind": "Content",
-              "text": "{\n    add: (handler: "
-            },
             {
               "kind": "Reference",
-              "text": "UnloadHandler",
-              "canonicalReference": "@microsoft/applicationinsights-core-js!UnloadHandler:type"
+              "text": "IUnloadHandlerContainer",
+              "canonicalReference": "@microsoft/applicationinsights-core-js!IUnloadHandlerContainer:interface"
             },
             {
               "kind": "Content",
-              "text": ") => void;\n    run: (unloadCtx: "
-            },
-            {
-              "kind": "Reference",
-              "text": "IProcessTelemetryUnloadContext",
-              "canonicalReference": "@microsoft/applicationinsights-core-js!IProcessTelemetryUnloadContext:interface"
-            },
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "types/JavaScriptSDK/UnloadHandlerContainer.d.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [],
+          "name": "createUnloadHandlerContainer"
+        },
+        {
+          "kind": "Function",
+          "canonicalReference": "@microsoft/applicationinsights-core-js!createUnloadHookContainer:function(1)",
+          "docComment": "/**\n * Create a IUnloadHookContainer which can be used to remember unload hook functions to be executed during the component unloading process.\n *\n * @returns A new IUnloadHookContainer instance\n */\n",
+          "excerptTokens": [
             {
               "kind": "Content",
-              "text": ", unloadState: "
+              "text": "export declare function createUnloadHookContainer(): "
             },
             {
               "kind": "Reference",
-              "text": "ITelemetryUnloadState",
-              "canonicalReference": "@microsoft/applicationinsights-core-js!ITelemetryUnloadState:interface"
-            },
-            {
-              "kind": "Content",
-              "text": ") => void;\n}"
+              "text": "IUnloadHookContainer",
+              "canonicalReference": "@microsoft/applicationinsights-core-js!IUnloadHookContainer:interface"
             },
             {
               "kind": "Content",
               "text": ";"
             }
           ],
-          "fileUrlPath": "types/JavaScriptSDK/UnloadHandlerContainer.d.ts",
+          "fileUrlPath": "types/JavaScriptSDK/UnloadHookContainer.d.ts",
           "returnTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 8
+            "endIndex": 2
           },
           "releaseTag": "Public",
           "overloadIndex": 1,
           "parameters": [],
-          "name": "createUnloadHandlerContainer"
+          "name": "createUnloadHookContainer"
         },
         {
           "kind": "Variable",
@@ -13918,6 +13988,60 @@
                 "endIndex": 2
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/applicationinsights-core-js!IDynamicConfigHandler#rdOnly:member",
+              "docComment": "/**\n * Set this named property of the target as read-only, which will block this single named property from ever being changed for the target instance. This does NOT freeze or seal the instance, it just stops the direct re-assignment of the named property, if the value is a non-primitive (ie. an object or array) it's properties will still be mutable.\n *\n * @returns The referenced properties current value\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "rdOnly: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "<C, V = any>(target: C, name: string) => V"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "rdOnly",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/applicationinsights-core-js!IDynamicConfigHandler#ref:member",
+              "docComment": "/**\n * Set this named property of the target as referenced, which will cause any object or array instances to be updated in-place rather than being entirely replaced. All other values will continue to be replaced.\n *\n * @returns The referenced properties current value\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "ref: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "<C, V = any>(target: C, name: string) => V"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "ref",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@microsoft/applicationinsights-core-js!IDynamicConfigHandler#set:member",
@@ -19157,6 +19281,159 @@
           ],
           "extendsTokenRanges": []
         },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@microsoft/applicationinsights-core-js!IUnloadHookContainer:interface",
+          "docComment": "/**\n * Interface which identifiesAdd this hook so that it is automatically removed during unloading\n *\n * @param hooks - The single hook or an array of IInstrumentHook objects\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface IUnloadHookContainer "
+            }
+          ],
+          "fileUrlPath": "types/JavaScriptSDK/UnloadHookContainer.d.ts",
+          "releaseTag": "Public",
+          "name": "IUnloadHookContainer",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/applicationinsights-core-js!IUnloadHookContainer#add:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "add: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "(hooks: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "IUnloadHook",
+                  "canonicalReference": "@microsoft/applicationinsights-core-js!IUnloadHook:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "IUnloadHook",
+                  "canonicalReference": "@microsoft/applicationinsights-core-js!IUnloadHook:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[] | "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Iterator",
+                  "canonicalReference": "!Iterator:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<"
+                },
+                {
+                  "kind": "Reference",
+                  "text": "IUnloadHook",
+                  "canonicalReference": "@microsoft/applicationinsights-core-js!IUnloadHook:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "> | "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "ILegacyUnloadHook",
+                  "canonicalReference": "@microsoft/applicationinsights-core-js!ILegacyUnloadHook:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "ILegacyUnloadHook",
+                  "canonicalReference": "@microsoft/applicationinsights-core-js!ILegacyUnloadHook:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[] | "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Iterator",
+                  "canonicalReference": "!Iterator:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<"
+                },
+                {
+                  "kind": "Reference",
+                  "text": "ILegacyUnloadHook",
+                  "canonicalReference": "@microsoft/applicationinsights-core-js!ILegacyUnloadHook:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ">) => void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "add",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 18
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/applicationinsights-core-js!IUnloadHookContainer#run:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "run: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "(logger?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "IDiagnosticLogger",
+                  "canonicalReference": "@microsoft/applicationinsights-core-js!IDiagnosticLogger:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ") => void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "run",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 4
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
         {
           "kind": "Interface",
           "canonicalReference": "@microsoft/applicationinsights-core-js!IWatchDetails:interface",
@@ -19221,6 +19498,60 @@
                 "endIndex": 2
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/applicationinsights-core-js!IWatchDetails#rdOnly:member",
+              "docComment": "/**\n * Set this named property of the target as read-only, which will block this single named property from ever being changed for the target instance. This does NOT freeze or seal the instance, it just stops the direct re-assignment of the named property, if the value is a non-primitive (ie. an object or array) it's properties will still be mutable.\n *\n * @returns The referenced properties current value\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "rdOnly: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "<C, V = any>(target: C, name: string) => V"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "rdOnly",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/applicationinsights-core-js!IWatchDetails#ref:member",
+              "docComment": "/**\n * Set this named property of the target as referenced, which will cause any object or array instance to be updated in-place rather than being entirely replaced. All other values will continue to be replaced.\n *\n * @returns The referenced properties current value\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "ref: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "<C, V = any>(target: C, name: string) => V"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "ref",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@microsoft/applicationinsights-core-js!IWatchDetails#set:member",

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

@@ -147,7 +147,7 @@ export function attachEvent(obj: any, eventNameWithoutOn: string, handlerRef: an
 // @public
 export abstract class BaseTelemetryPlugin implements ITelemetryPlugin {
     constructor();
-    protected _addHook(hooks: IUnloadHook | IUnloadHook[] | ILegacyUnloadHook | ILegacyUnloadHook[]): void;
+    protected _addHook(hooks: IUnloadHook | IUnloadHook[] | Iterator<IUnloadHook> | ILegacyUnloadHook | ILegacyUnloadHook[] | Iterator<ILegacyUnloadHook>): void;
     protected _addUnloadCb(handler: UnloadHandler): void;
     core: IAppInsightsCore;
     diagLog: (itemCtx?: IProcessTelemetryContext) => IDiagnosticLogger;
@@ -167,6 +167,7 @@ export abstract class BaseTelemetryPlugin implements ITelemetryPlugin {
     protected setInitialized: (isInitialized: boolean) => void;
     setNextPlugin: (next: ITelemetryPlugin | ITelemetryPluginChain) => void;
     teardown(unloadCtx?: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState): void | boolean;
+    protected readonly _unloadHooks: IUnloadHookContainer;
     update(updateCtx: IProcessTelemetryUpdateContext, updateState: ITelemetryUpdateState): void | boolean;
     // (undocumented)
     version?: string;
@@ -196,10 +197,10 @@ export function createTraceParent(traceId?: string, spanId?: string, flags?: num
 export function createUniqueNamespace(name: string, includeVersion?: boolean): string;
 
 // @public (undocumented)
-export function createUnloadHandlerContainer(): {
-    add: (handler: UnloadHandler) => void;
-    run: (unloadCtx: IProcessTelemetryUnloadContext, unloadState: ITelemetryUnloadState) => void;
-};
+export function createUnloadHandlerContainer(): IUnloadHandlerContainer;
+
+// @public
+export function createUnloadHookContainer(): IUnloadHookContainer;
 
 // @public
 export const createValueMap: <E, V = E>(values: {
@@ -715,6 +716,8 @@ export interface IDynamicConfigHandler<T extends IConfiguration> {
     cfg: T;
     logger: IDiagnosticLogger;
     notify: () => void;
+    rdOnly: <C, V = any>(target: C, name: string) => V;
+    ref: <C, V = any>(target: C, name: string) => V;
     set: <C, V>(theConfig: C, name: string, value: V) => V;
     setDf: <C>(theConfig: C, defaultValues: IConfigDefaults<C, T>) => C;
     readonly uid: string;
@@ -1058,9 +1061,19 @@ export interface IUnloadHook {
     rm: () => void;
 }
 
+// @public
+export interface IUnloadHookContainer {
+    // (undocumented)
+    add: (hooks: IUnloadHook | IUnloadHook[] | Iterator<IUnloadHook> | ILegacyUnloadHook | ILegacyUnloadHook[] | Iterator<ILegacyUnloadHook>) => void;
+    // (undocumented)
+    run: (logger?: IDiagnosticLogger) => void;
+}
+
 // @public (undocumented)
 export interface IWatchDetails<T extends IConfiguration> {
     cfg: T;
+    rdOnly: <C, V = any>(target: C, name: string) => V;
+    ref: <C, V = any>(target: C, name: string) => V;
     set: <C, V>(theConfig: C, name: string, value: V) => V;
     setDf: <C>(theConfig: C, defaultValues: IConfigDefaults<C>) => C;
 }

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

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights Core Javascript SDK, 3.0.0-beta.2301-14
+ * Microsoft Application Insights Core Javascript SDK, 3.0.0-beta.2301-17
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -353,6 +353,12 @@ declare namespace ApplicationInsights {
          * @returns boolean - true if the plugin has or will call asyncCallback, this allows the plugin to perform any asynchronous operations.
          */
         protected _doUpdate?: (updateCtx?: IProcessTelemetryUpdateContext, updateState?: ITelemetryUpdateState, asyncCallback?: () => void) => void | boolean;
+        /**
+         * Exposes the underlying unload hook container instance for this extension to allow it to be passed down to any sub components of the class.
+         * This should NEVER be exposed or called publically as it's scope is for internal use by BaseTelemetryPlugin and any derived class (which is why
+         * it's scoped as protected)
+         */
+        protected readonly _unloadHooks: IUnloadHookContainer;
         constructor();
         initialize(config: IConfiguration, core: IAppInsightsCore, extensions: IPlugin[], pluginChain?: ITelemetryPluginChain): void;
         /**
@@ -381,7 +387,7 @@ declare namespace ApplicationInsights {
          * Add this hook so that it is automatically removed during unloading
          * @param hooks - The single hook or an array of IInstrumentHook objects
          */
-        protected _addHook(hooks: IUnloadHook | IUnloadHook[] | ILegacyUnloadHook | ILegacyUnloadHook[]): void;
+        protected _addHook(hooks: IUnloadHook | IUnloadHook[] | Iterator<IUnloadHook> | ILegacyUnloadHook | ILegacyUnloadHook[] | Iterator<ILegacyUnloadHook>): void;
     }
 
     /**
@@ -432,10 +438,14 @@ declare namespace ApplicationInsights {
 
     function createUniqueNamespace(name: string, includeVersion?: boolean): string;
 
-    function createUnloadHandlerContainer(): {
-        add: (handler: UnloadHandler) => void;
-        run: (unloadCtx: IProcessTelemetryUnloadContext, unloadState: ITelemetryUnloadState) => void;
-    };
+    function createUnloadHandlerContainer(): IUnloadHandlerContainer;
+
+    /**
+     * Create a IUnloadHookContainer which can be used to remember unload hook functions to be executed during the component unloading
+     * process.
+     * @returns A new IUnloadHookContainer instance
+     */
+    function createUnloadHookContainer(): IUnloadHookContainer;
 
     /**
      * 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.
@@ -1508,6 +1518,20 @@ declare namespace ApplicationInsights {
          * @param defaultValues - The default values to apply to the config
          */
         setDf: <C>(theConfig: C, defaultValues: IConfigDefaults<C, T>) => C;
+        /**
+         * Set this named property of the target as referenced, which will cause any object or array instances
+         * to be updated in-place rather than being entirely replaced. All other values will continue to be replaced.
+         * @returns The referenced properties current value
+         */
+        ref: <C, V = any>(target: C, name: string) => V;
+        /**
+         * Set this named property of the target as read-only, which will block this single named property from
+         * ever being changed for the target instance.
+         * This does NOT freeze or seal the instance, it just stops the direct re-assignment of the named property,
+         * if the value is a non-primitive (ie. an object or array) it's properties will still be mutable.
+         * @returns The referenced properties current value
+         */
+        rdOnly: <C, V = any>(target: C, name: string) => V;
     }
 
     interface IDynamicPropertyHandler<T> {
@@ -2287,6 +2311,15 @@ declare namespace ApplicationInsights {
         rm: () => void;
     }
 
+    /**
+     * Interface which identifiesAdd this hook so that it is automatically removed during unloading
+     * @param hooks - The single hook or an array of IInstrumentHook objects
+     */
+    interface IUnloadHookContainer {
+        add: (hooks: IUnloadHook | IUnloadHook[] | Iterator<IUnloadHook> | ILegacyUnloadHook | ILegacyUnloadHook[] | Iterator<ILegacyUnloadHook>) => void;
+        run: (logger?: IDiagnosticLogger) => void;
+    }
+
     interface IWatchDetails<T extends IConfiguration> {
         /**
          * The current config object
@@ -2305,6 +2338,20 @@ declare namespace ApplicationInsights {
          * @param defaultValues - The default values to apply to the config
          */
         setDf: <C>(theConfig: C, defaultValues: IConfigDefaults<C>) => C;
+        /**
+         * Set this named property of the target as referenced, which will cause any object or array instance
+         * to be updated in-place rather than being entirely replaced. All other values will continue to be replaced.
+         * @returns The referenced properties current value
+         */
+        ref: <C, V = any>(target: C, name: string) => V;
+        /**
+         * Set this named property of the target as read-only, which will block this single named property from
+         * ever being changed for the target instance.
+         * This does NOT freeze or seal the instance, it just stops the direct re-assignment of the named property,
+         * if the value is a non-primitive (ie. an object or array) it's properties will still be mutable.
+         * @returns The referenced properties current value
+         */
+        rdOnly: <C, V = any>(target: C, name: string) => V;
     }
 
     interface IWatcherHandler<T extends IConfiguration> extends IUnloadHook {