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

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)",

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>;
 

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-10
  * 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

package/dist/applicationinsights-core-js.js

@@ -1,5 +1,5 @@
 /*!
- * Application Insights JavaScript SDK - Core, 3.0.0-beta.2303-09
+ * Application Insights JavaScript SDK - Core, 3.0.0-beta.2303-10
  * Copyright (c) Microsoft and contributors. All rights reserved.
  */
 (function (global, factory) {
@@ -1767,7 +1767,7 @@
         return result;
     }
 
-    var version = "3.0.0-beta.2303-09";
+    var version = "3.0.0-beta.2303-10";
     var instanceName = "." + newId(6);
     var _dataUid = 0;
     function _canAcceptData(target) {
@@ -1949,6 +1949,8 @@
     }
 
     var CFG_HANDLER_LINK = symbolFor("[[ai_dynCfg_1]]");
+    var BLOCK_DYNAMIC = symbolFor("[[ai_blkDynCfg_1]]");
+    var FORCE_DYNAMIC = symbolFor("[[ai_frcDynCfg_1]]");
     function _cfgDeepCopy(source) {
         if (source) {
             var target_1;
@@ -1977,6 +1979,26 @@
         }
         return null;
     }
+    function blockDynamicConversion(value) {
+        if (value && (isPlainObject(value) || isArray(value))) {
+            try {
+                value[BLOCK_DYNAMIC] = true;
+            }
+            catch (e) {
+            }
+        }
+        return value;
+    }
+    function _canMakeDynamic(value) {
+        var result = false;
+        if (value) {
+            result = value[FORCE_DYNAMIC];
+            if (!result && !value[BLOCK_DYNAMIC]) {
+                result = isPlainObject(value) || isArray(value);
+            }
+        }
+        return result;
+    }
     function throwInvalidAccess(message) {
         throwTypeError$1("InvalidAccess:" + message);
     }
@@ -2031,7 +2053,7 @@
         var isObjectOrArray = false;
         function _getProperty() {
             if (checkDynamic) {
-                isObjectOrArray = isObjectOrArray || (value && (isPlainObject(value) || isArray(value)));
+                isObjectOrArray = isObjectOrArray || _canMakeDynamic(value);
                 if (value && !value[CFG_HANDLER_LINK] && isObjectOrArray) {
                     value = _makeDynamicObject(state, value);
                 }
@@ -2054,7 +2076,7 @@
                     throwInvalidAccess("[" + name + "] is read-only:" + dumpObj(theConfig));
                 }
                 if (checkDynamic) {
-                    isObjectOrArray = isObjectOrArray || (value && (isPlainObject(value) || isArray(value)));
+                    isObjectOrArray = isObjectOrArray || _canMakeDynamic(value);
                     checkDynamic = false;
                 }
                 var isReferenced = isObjectOrArray && _getProperty[state.rf];
@@ -2079,7 +2101,7 @@
                     }
                 }
                 if (newValue !== value) {
-                    var newIsObjectOrArray = newValue && (isPlainObject(newValue) || isArray(newValue));
+                    var newIsObjectOrArray = newValue && _canMakeDynamic(newValue);
                     if (!isReferenced && newIsObjectOrArray) {
                         _makeDynamicObject(state, newValue);
                     }
@@ -2090,14 +2112,13 @@
             }
         }
         objDefine(theConfig, detail.n, { g: _getProperty, s: _setProperty });
-        return _getProperty();
     }
     function _setDynamicProperty(state, target, name, value, inPlace, rdOnly) {
         if (target) {
             var getter = _getOwnPropGetter(target, name);
             var isDynamic = getter && !!getter[state.prop];
             if (!isDynamic) {
-                value = _makeDynamicProperty(state, target, name, value);
+                _makeDynamicProperty(state, target, name, value);
                 if (inPlace || rdOnly) {
                     getter = _getOwnPropGetter(target, name);
                 }
@@ -2112,7 +2133,7 @@
                 getter[state.ro] = rdOnly;
             }
         }
-        return value;
+        return target;
     }
     function _makeDynamicObject(state, target) {
         objForEachKey(target, function (key, value) {
@@ -2273,7 +2294,7 @@
             theState[_DYN_NOTIFY ]();
         }
         function _setValue(target, name, value) {
-            return _setDynamicProperty(theState, target, name, value);
+            return _setDynamicProperty(theState, target, name, value)[name];
         }
         function _watch(configHandler) {
             return _createAndUseHandler(theState, configHandler);
@@ -2282,10 +2303,10 @@
             theState.use(null, configHandler);
         }
         function _ref(target, name) {
-            return _setDynamicProperty(theState, target, name, target[name], true);
+            return _setDynamicProperty(theState, target, name, target[name], true)[name];
         }
         function _rdOnly(target, name) {
-            return _setDynamicProperty(theState, target, name, target[name], false, true);
+            return _setDynamicProperty(theState, target, name, target[name], false, true)[name];
         }
         function _applyDefaults(theConfig, defaultValues) {
             if (defaultValues) {
@@ -2664,6 +2685,20 @@
         }
         return _isIgnoredCookie(cookieMgrCfg, name);
     }
+    function _isCfgEnabled(rootConfig, cookieMgrConfig) {
+        var isCfgEnabled = cookieMgrConfig.enabled;
+        if (isNullOrUndefined(isCfgEnabled)) {
+            var cookieEnabled = void 0;
+            if (!isUndefined(rootConfig[strIsCookieUseDisabled])) {
+                cookieEnabled = !rootConfig[strIsCookieUseDisabled];
+            }
+            if (!isUndefined(rootConfig[strDisableCookiesUsage])) {
+                cookieEnabled = !rootConfig[strDisableCookiesUsage];
+            }
+            isCfgEnabled = cookieEnabled;
+        }
+        return isCfgEnabled;
+    }
     function safeGetCookieMgr(core, config) {
         var cookieMgr;
         if (core) {
@@ -2695,27 +2730,16 @@
         onConfigChange(rootConfig, function (details) {
             details[_DYN_SET_DF ](details.cfg, rootDefaultConfig);
             cookieMgrConfig = details.ref(details.cfg, "cookieCfg");
-            var isEnabled = cookieMgrConfig.enabled;
-            if (isNullOrUndefined(isEnabled)) {
-                var cookieEnabled = void 0;
-                if (!isUndefined(rootConfig[strIsCookieUseDisabled])) {
-                    cookieEnabled = !rootConfig[strIsCookieUseDisabled];
-                }
-                if (!isUndefined(rootConfig[strDisableCookiesUsage])) {
-                    cookieEnabled = !rootConfig[strDisableCookiesUsage];
-                }
-                isEnabled = cookieEnabled;
-            }
             _path = cookieMgrConfig[STR_PATH ] || "/";
             _domain = cookieMgrConfig[STR_DOMAIN ];
-            _enabled = isEnabled !== false;
+            _enabled = _isCfgEnabled(rootConfig, cookieMgrConfig) !== false;
             _getCookieFn = cookieMgrConfig.getCookie || _getCookieValue;
             _setCookieFn = cookieMgrConfig.setCookie || _setCookieValue;
             _delCookieFn = cookieMgrConfig.delCookie || _setCookieValue;
         }, logger);
         var cookieMgr = {
             isEnabled: function () {
-                var enabled = _enabled && areCookiesSupported(logger);
+                var enabled = _isCfgEnabled(rootConfig, cookieMgrConfig) !== false && _enabled && areCookiesSupported(logger);
                 var gblManager = _globalCookieConfig[strConfigCookieMgr];
                 if (enabled && gblManager && cookieMgr !== gblManager) {
                     enabled = _isMgrEnabled(gblManager);
@@ -2724,6 +2748,7 @@
             },
             setEnabled: function (value) {
                 _enabled = value !== false;
+                cookieMgrConfig.enabled = value;
             },
             set: function (name, value, maxAgeSec, domain, path) {
                 var result = false;
@@ -5270,6 +5295,7 @@
     exports.arrReduce = arrReduce;
     exports.asString = asString;
     exports.attachEvent = attachEvent;
+    exports.blockDynamicConversion = blockDynamicConversion;
     exports.cfgDfBoolean = cfgDfBoolean;
     exports.cfgDfFunc = cfgDfFunc;
     exports.cfgDfMerge = cfgDfMerge;