@microsoft/applicationinsights-core-js 3.0.0-beta.2303-09 → 3.0.0-beta.2303-11

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

@@ -6000,6 +6000,64 @@
             }
           ]
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@microsoft/applicationinsights-core-js!blockDynamicConversion:function(1)",
+          "docComment": "/**\n * Mark the provided value so that if it's included into the configuration it will NOT have its properties converted into a dynamic (reactive) object. If the object is not a plain object or an array (ie. a class) this function has not affect as only Objects and Arrays are converted into dynamic objects in the dynamic configuration.\n *\n * When you have tagged a value as both {@link forceDynamicConversion} and blocked force will take precedence.\n *\n * You should only need to use this function, if you are creating dynamic \"classes\" from objects which confirm to the require interface. A common case for this is during unit testing where it's easier to create mock extensions.\n *\n * If `value` is falsy (null / undefined / 0 / empty string etc) it will not be tagged and if there is an exception adding the property to the value (because its frozen etc) the exception will be swallowed\n *\n * @param value - The object that you want to block from being converted into a trackable dynamic object\n *\n * @returns The original value\n *\n * @example\n * ```ts\n * // This is a valid \"extension\", but it is technically an object\n * // So when included in the config.extensions it WILL be cloned and then\n * // converted into a dynamic object, where all of its properties will become\n * // get/set object properties and will be tracked. While this WILL still\n * // function, when attempt to use a mocking framework on top of this the\n * // functions are now technically get accessors which return a function\n * // and this can cause some mocking frameworks to fail.\n * let mockChannel = {\n *      pause: () => { },\n *      resume: () => { },\n *      teardown: () => { },\n *      flush: (async: any, callBack: any) => { },\n *      processTelemetry: (env: any) => { },\n *      setNextPlugin: (next: any) => { },\n *      initialize: (config: any, core: any, extensions: any) => { },\n *      identifier: \"testChannel\",\n *      priority: 1003\n * };\n * ```\n *\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function blockDynamicConversion<T>(value: "
+            },
+            {
+              "kind": "Content",
+              "text": "T"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Content",
+              "text": "T"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "types/Config/DynamicSupport.d.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 4
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "value",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            }
+          ],
+          "typeParameters": [
+            {
+              "typeParameterName": "T",
+              "constraintTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              },
+              "defaultTypeTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              }
+            }
+          ],
+          "name": "blockDynamicConversion"
+        },
         {
           "kind": "Function",
           "canonicalReference": "@microsoft/applicationinsights-core-js!cfgDfBoolean:function(1)",
@@ -7452,37 +7510,6 @@
               "isAbstract": false,
               "name": "consoleLoggingLevel"
             },
-            {
-              "kind": "Method",
-              "canonicalReference": "@microsoft/applicationinsights-core-js!DiagnosticLogger#enableDebugExceptions:member(1)",
-              "docComment": "/**\n * When this is true the SDK will throw exceptions to aid in debugging.\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "enableDebugExceptions(): "
-                },
-                {
-                  "kind": "Content",
-                  "text": "boolean"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isStatic": false,
-              "returnTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              },
-              "releaseTag": "Public",
-              "isProtected": false,
-              "overloadIndex": 1,
-              "parameters": [],
-              "isOptional": false,
-              "isAbstract": false,
-              "name": "enableDebugExceptions"
-            },
             {
               "kind": "Method",
               "canonicalReference": "@microsoft/applicationinsights-core-js!DiagnosticLogger#errorToConsole:member(1)",
@@ -7627,37 +7654,6 @@
               "isAbstract": false,
               "name": "logInternalMessage"
             },
-            {
-              "kind": "Method",
-              "canonicalReference": "@microsoft/applicationinsights-core-js!DiagnosticLogger#maxInternalMessageLimit:member(1)",
-              "docComment": "/**\n * The maximum number of internal messages allowed to be sent per page view\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "maxInternalMessageLimit(): "
-                },
-                {
-                  "kind": "Content",
-                  "text": "number"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isStatic": false,
-              "returnTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              },
-              "releaseTag": "Public",
-              "isProtected": false,
-              "overloadIndex": 1,
-              "parameters": [],
-              "isOptional": false,
-              "isAbstract": false,
-              "name": "maxInternalMessageLimit"
-            },
             {
               "kind": "Property",
               "canonicalReference": "@microsoft/applicationinsights-core-js!DiagnosticLogger#queue:member",
@@ -7724,37 +7720,6 @@
               "isAbstract": false,
               "name": "resetInternalMessageCount"
             },
-            {
-              "kind": "Method",
-              "canonicalReference": "@microsoft/applicationinsights-core-js!DiagnosticLogger#telemetryLoggingLevel:member(1)",
-              "docComment": "/**\n * 0: OFF 1: CRITICAL (default) 2: >= WARNING\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "telemetryLoggingLevel(): "
-                },
-                {
-                  "kind": "Content",
-                  "text": "number"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isStatic": false,
-              "returnTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              },
-              "releaseTag": "Public",
-              "isProtected": false,
-              "overloadIndex": 1,
-              "parameters": [],
-              "isOptional": false,
-              "isAbstract": false,
-              "name": "telemetryLoggingLevel"
-            },
             {
               "kind": "Method",
               "canonicalReference": "@microsoft/applicationinsights-core-js!DiagnosticLogger#throwInternal:member(1)",
@@ -8826,6 +8791,64 @@
           "parameters": [],
           "name": "findW3cTraceParent"
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@microsoft/applicationinsights-core-js!forceDynamicConversion:function(1)",
+          "docComment": "/**\n * This is the reverse case of {@link blockDynamicConversion} in that this will tag an object to indicate that it should always be converted into a dynamic trackable object even when not an object or array. So all properties of this object will become get / set accessor functions.\n *\n * When you have tagged a value as both {@link forceDynamicConversion} and blocked force will take precedence.\n *\n * If `value` is falsy (null / undefined / 0 / empty string etc) it will not be tagged and if there is an exception adding the property to the value (because its frozen etc) the exception will be swallowed.\n *\n * @param value - The object that should be tagged and converted if included into a dynamic configuration.\n *\n * @returns The original value\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function forceDynamicConversion<T>(value: "
+            },
+            {
+              "kind": "Content",
+              "text": "T"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Content",
+              "text": "T"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "types/Config/DynamicSupport.d.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 4
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "value",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            }
+          ],
+          "typeParameters": [
+            {
+              "typeParameterName": "T",
+              "constraintTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              },
+              "defaultTypeTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              }
+            }
+          ],
+          "name": "forceDynamicConversion"
+        },
         {
           "kind": "Function",
           "canonicalReference": "@microsoft/applicationinsights-core-js!formatTraceParent:function(1)",
@@ -12554,12 +12577,12 @@
             },
             {
               "kind": "PropertySignature",
-              "canonicalReference": "@microsoft/applicationinsights-core-js!IConfiguration#enableDebugExceptions:member",
+              "canonicalReference": "@microsoft/applicationinsights-core-js!IConfiguration#enableDebug:member",
               "docComment": "/**\n * If enabled, uncaught exceptions will be thrown to help with debugging\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "enableDebugExceptions?: "
+                  "text": "enableDebug?: "
                 },
                 {
                   "kind": "Content",
@@ -12573,7 +12596,7 @@
               "isReadonly": false,
               "isOptional": true,
               "releaseTag": "Public",
-              "name": "enableDebugExceptions",
+              "name": "enableDebug",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
                 "endIndex": 2
@@ -13843,33 +13866,6 @@
                 "endIndex": 2
               }
             },
-            {
-              "kind": "PropertySignature",
-              "canonicalReference": "@microsoft/applicationinsights-core-js!IDiagnosticLogger#enableDebugExceptions:member",
-              "docComment": "/**\n * When this is true the SDK will throw exceptions to aid in debugging.\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "enableDebugExceptions: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "() => boolean"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": false,
-              "isOptional": false,
-              "releaseTag": "Public",
-              "name": "enableDebugExceptions",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              }
-            },
             {
               "kind": "MethodSignature",
               "canonicalReference": "@microsoft/applicationinsights-core-js!IDiagnosticLogger#errorToConsole:member(1)",
@@ -13978,33 +13974,6 @@
               ],
               "name": "logInternalMessage"
             },
-            {
-              "kind": "PropertySignature",
-              "canonicalReference": "@microsoft/applicationinsights-core-js!IDiagnosticLogger#maxInternalMessageLimit:member",
-              "docComment": "/**\n * The maximum number of internal messages allowed to be sent per page view\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "maxInternalMessageLimit: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "() => number"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": false,
-              "isOptional": false,
-              "releaseTag": "Public",
-              "name": "maxInternalMessageLimit",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              }
-            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@microsoft/applicationinsights-core-js!IDiagnosticLogger#queue:member",
@@ -14065,33 +14034,6 @@
               "parameters": [],
               "name": "resetInternalMessageCount"
             },
-            {
-              "kind": "PropertySignature",
-              "canonicalReference": "@microsoft/applicationinsights-core-js!IDiagnosticLogger#telemetryLoggingLevel:member",
-              "docComment": "/**\n * 0: OFF (default) 1: CRITICAL 2: WARNING\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "telemetryLoggingLevel: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "() => number"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": false,
-              "isOptional": false,
-              "releaseTag": "Public",
-              "name": "telemetryLoggingLevel",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              }
-            },
             {
               "kind": "MethodSignature",
               "canonicalReference": "@microsoft/applicationinsights-core-js!IDiagnosticLogger#throwInternal:member(1)",

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

@@ -171,6 +171,9 @@ export abstract class BaseTelemetryPlugin implements ITelemetryPlugin {
     version?: string;
 }
 
+// @public
+export function blockDynamicConversion<T>(value: T): T;
+
 // @public
 export function cfgDfBoolean<T, C = IConfiguration>(defaultValue?: boolean, fallBackName?: keyof T | keyof C | Array<keyof T | keyof C>): IConfigDefaultCheck<T, boolean, C>;
 
@@ -234,15 +237,12 @@ export function detachEvent(obj: any, eventNameWithoutOn: string, handlerRef: an
 export class DiagnosticLogger implements IDiagnosticLogger {
     constructor(config?: IConfiguration);
     consoleLoggingLevel(): number;
-    enableDebugExceptions(): boolean;
     errorToConsole(message: string): void;
     // (undocumented)
     identifier: string;
     logInternalMessage(severity: LoggingSeverity, message: _InternalLogMessage): void;
-    maxInternalMessageLimit(): number;
     queue: _InternalLogMessage[];
     resetInternalMessageCount(): void;
-    telemetryLoggingLevel(): number;
     throwInternal(severity: LoggingSeverity, msgId: _InternalMessageId, msg: string, properties?: Object, isUserAct?: boolean): void;
     // (undocumented)
     update(updateState: ITelemetryUpdateState): void;
@@ -469,6 +469,9 @@ export function findNamedServerTiming(name: string): any;
 // @public
 export function findW3cTraceParent(): ITraceParent;
 
+// @public
+export function forceDynamicConversion<T>(value: T): T;
+
 // @public
 export function formatTraceParent(value: ITraceParent): string;
 
@@ -644,7 +647,7 @@ export interface IConfiguration {
     disableInstrumentationKeyValidation?: boolean;
     disablePageShowEvents?: string[];
     disablePageUnloadEvents?: string[];
-    enableDebugExceptions?: boolean;
+    enableDebug?: boolean;
     enablePerfMgr?: boolean;
     enableWParam?: boolean;
     endpointUrl?: string;
@@ -710,13 +713,10 @@ export interface IDbgExtension {
 // @public (undocumented)
 export interface IDiagnosticLogger {
     consoleLoggingLevel: () => number;
-    enableDebugExceptions: () => boolean;
     errorToConsole?(message: string): void;
     logInternalMessage?(severity: LoggingSeverity, message: _InternalLogMessage): void;
-    maxInternalMessageLimit: () => number;
     queue: _InternalLogMessage[];
     resetInternalMessageCount(): void;
-    telemetryLoggingLevel: () => number;
     throwInternal(severity: LoggingSeverity, msgId: _InternalMessageId, msg: string, properties?: Object, isUserAct?: boolean): void;
     update?(updateState: ITelemetryUpdateState): void;
     warnToConsole(message: string): void;

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

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights Core Javascript SDK, 3.0.0-beta.2303-09
+ * Microsoft Application Insights Core Javascript SDK, 3.0.0-beta.2303-11
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -389,6 +389,49 @@ declare namespace ApplicationInsights {
         protected _addHook(hooks: IUnloadHook | IUnloadHook[] | Iterator<IUnloadHook> | ILegacyUnloadHook | ILegacyUnloadHook[] | Iterator<ILegacyUnloadHook>): void;
     }
 
+    /**
+     * Mark the provided value so that if it's included into the configuration it will NOT have
+     * its properties converted into a dynamic (reactive) object. If the object is not a plain object
+     * or an array (ie. a class) this function has not affect as only Objects and Arrays are converted
+     * into dynamic objects in the dynamic configuration.
+     *
+     * When you have tagged a value as both {@link forceDynamicConversion} and blocked force will take precedence.
+     *
+     * You should only need to use this function, if you are creating dynamic "classes" from objects
+     * which confirm to the require interface. A common case for this is during unit testing where it's
+     * easier to create mock extensions.
+     *
+     * If `value` is falsy (null / undefined / 0 / empty string etc) it will not be tagged and
+     * if there is an exception adding the property to the value (because its frozen etc) the
+     * exception will be swallowed
+     *
+     * @example
+     * ```ts
+     * // This is a valid "extension", but it is technically an object
+     * // So when included in the config.extensions it WILL be cloned and then
+     * // converted into a dynamic object, where all of its properties will become
+     * // get/set object properties and will be tracked. While this WILL still
+     * // function, when attempt to use a mocking framework on top of this the
+     * // functions are now technically get accessors which return a function
+     * // and this can cause some mocking frameworks to fail.
+     * let mockChannel = {
+     *      pause: () => { },
+     *      resume: () => { },
+     *      teardown: () => { },
+     *      flush: (async: any, callBack: any) => { },
+     *      processTelemetry: (env: any) => { },
+     *      setNextPlugin: (next: any) => { },
+     *      initialize: (config: any, core: any, extensions: any) => { },
+     *      identifier: "testChannel",
+     *      priority: 1003
+     * };
+     * ```
+     * @param value - The object that you want to block from being converted into a
+     * trackable dynamic object
+     * @returns The original value
+     */
+    function blockDynamicConversion<T>(value: T): T;
+
     /**
      * Helper which returns an IConfigDefaultCheck instance that will validate and convert the user
      * provided value to a boolean from a string or boolean value
@@ -533,26 +576,12 @@ declare namespace ApplicationInsights {
          */
         queue: _InternalLogMessage[];
         constructor(config?: IConfiguration);
-        /**
-         * When this is true the SDK will throw exceptions to aid in debugging.
-         */
-        enableDebugExceptions(): boolean;
         /**
          * 0: OFF (default)
          * 1: CRITICAL
          * 2: >= WARNING
          */
         consoleLoggingLevel(): number;
-        /**
-         * 0: OFF
-         * 1: CRITICAL (default)
-         * 2: >= WARNING
-         */
-        telemetryLoggingLevel(): number;
-        /**
-         * The maximum number of internal messages allowed to be sent per page view
-         */
-        maxInternalMessageLimit(): number;
         /**
          * This method will throw exceptions in debug mode or attempt to log the error as a console warning.
          * @param severity - {LoggingSeverity} - The severity of the log message
@@ -781,6 +810,23 @@ declare namespace ApplicationInsights {
      */
     function findW3cTraceParent(): ITraceParent;
 
+    /**
+     * This is the reverse case of {@link blockDynamicConversion} in that this will tag an
+     * object to indicate that it should always be converted into a dynamic trackable object
+     * even when not an object or array. So all properties of this object will become
+     * get / set accessor functions.
+     *
+     * When you have tagged a value as both {@link forceDynamicConversion} and blocked force will take precedence.
+     *
+     * If `value` is falsy (null / undefined / 0 / empty string etc) it will not be tagged and
+     * if there is an exception adding the property to the value (because its frozen etc) the
+     * exception will be swallowed.
+     * @param value - The object that should be tagged and converted if included into a dynamic
+     * configuration.
+     * @returns The original value
+     */
+    function forceDynamicConversion<T>(value: T): T;
+
     /**
      * Format the ITraceParent value as a string using the supported and know version formats.
      * So even if the passed traceParent is a later version the string value returned from this
@@ -1249,7 +1295,7 @@ declare namespace ApplicationInsights {
         /**
          * If enabled, uncaught exceptions will be thrown to help with debugging
          */
-        enableDebugExceptions?: boolean;
+        enableDebug?: boolean;
         /**
          * Endpoint where telemetry data is sent
          */
@@ -1460,26 +1506,12 @@ declare namespace ApplicationInsights {
     }
 
     interface IDiagnosticLogger {
-        /**
-         * When this is true the SDK will throw exceptions to aid in debugging.
-         */
-        enableDebugExceptions: () => boolean;
         /**
          * 0: OFF
          * 1: only critical (default)
          * 2: critical + info
          */
         consoleLoggingLevel: () => number;
-        /**
-         * 0: OFF (default)
-         * 1: CRITICAL
-         * 2: WARNING
-         */
-        telemetryLoggingLevel: () => number;
-        /**
-         * The maximum number of internal messages allowed to be sent per page view
-         */
-        maxInternalMessageLimit: () => number;
         /**
          * The internal logging queue
          */