@microsoft/applicationinsights-core-js 3.0.0-beta.2210-04 → 3.0.0-beta.2210-07

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

@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "7.32.0",
+    "toolVersion": "7.32.1",
     "schemaVersion": 1009,
     "oldestForwardsCompatibleVersion": 1001,
     "tsdocConfig": {
@@ -4806,84 +4806,6 @@
             }
           ]
         },
-        {
-          "kind": "Function",
-          "canonicalReference": "@microsoft/applicationinsights-core-js!applyDefaults:function(1)",
-          "docComment": "",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "export declare function applyDefaults<C>(theConfig: "
-            },
-            {
-              "kind": "Content",
-              "text": "C"
-            },
-            {
-              "kind": "Content",
-              "text": ", defaultValues: "
-            },
-            {
-              "kind": "Reference",
-              "text": "IConfigDefaults",
-              "canonicalReference": "@microsoft/applicationinsights-core-js!IConfigDefaults:type"
-            },
-            {
-              "kind": "Content",
-              "text": "<C>"
-            },
-            {
-              "kind": "Content",
-              "text": "): "
-            },
-            {
-              "kind": "Content",
-              "text": "C"
-            },
-            {
-              "kind": "Content",
-              "text": ";"
-            }
-          ],
-          "returnTypeTokenRange": {
-            "startIndex": 6,
-            "endIndex": 7
-          },
-          "releaseTag": "Public",
-          "overloadIndex": 1,
-          "parameters": [
-            {
-              "parameterName": "theConfig",
-              "parameterTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              },
-              "isOptional": false
-            },
-            {
-              "parameterName": "defaultValues",
-              "parameterTypeTokenRange": {
-                "startIndex": 3,
-                "endIndex": 5
-              },
-              "isOptional": false
-            }
-          ],
-          "typeParameters": [
-            {
-              "typeParameterName": "C",
-              "constraintTokenRange": {
-                "startIndex": 0,
-                "endIndex": 0
-              },
-              "defaultTypeTokenRange": {
-                "startIndex": 0,
-                "endIndex": 0
-              }
-            }
-          ],
-          "name": "applyDefaults"
-        },
         {
           "kind": "Function",
           "canonicalReference": "@microsoft/applicationinsights-core-js!areCookiesSupported:function(1)",
@@ -12900,7 +12822,7 @@
             {
               "kind": "MethodSignature",
               "canonicalReference": "@microsoft/applicationinsights-core-js!IDiagnosticLogger#errorToConsole:member(1)",
-              "docComment": "/**\n * This will write an error to the console if possible. Provided by the default DiagnosticLogger instance, and internally the SDK will fall back to warnToConsole, however, direct callers MUST check for its existence on the logger as you can provide your own IDiagnosticLogger instance.\n *\n * @param message - - The error message\n */\n",
+              "docComment": "/**\n * This will write an error to the console if possible. Provided by the default DiagnosticLogger instance, and internally the SDK will fall back to warnToConsole, however, direct callers MUST check for its existence on the logger as you can provide your own IDiagnosticLogger instance.\n *\n * @param message - The error message\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -12945,7 +12867,7 @@
             {
               "kind": "MethodSignature",
               "canonicalReference": "@microsoft/applicationinsights-core-js!IDiagnosticLogger#logInternalMessage:member(1)",
-              "docComment": "/**\n * Logs a message to the internal queue.\n *\n * @param severity - - The severity of the log message\n *\n * @param message - - The message to log.\n */\n",
+              "docComment": "/**\n * Logs a message to the internal queue.\n *\n * @param severity - The severity of the log message\n *\n * @param message - The message to log.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -13122,7 +13044,7 @@
             {
               "kind": "MethodSignature",
               "canonicalReference": "@microsoft/applicationinsights-core-js!IDiagnosticLogger#throwInternal:member(1)",
-              "docComment": "/**\n * This method will throw exceptions in debug mode or attempt to log the error as a console warning.\n *\n * @param severity - - The severity of the log message\n *\n * @param message - - The log message.\n */\n",
+              "docComment": "/**\n * This method will throw exceptions in debug mode or attempt to log the error as a console warning.\n *\n * @param severity - The severity of the log message\n *\n * @param message - The log message.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -13280,7 +13202,7 @@
             {
               "kind": "MethodSignature",
               "canonicalReference": "@microsoft/applicationinsights-core-js!IDiagnosticLogger#warnToConsole:member(1)",
-              "docComment": "/**\n * This will write a warning to the console if possible\n *\n * @param message - - The warning message\n */\n",
+              "docComment": "/**\n * This will write a warning to the console if possible\n *\n * @param message - The warning message\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -13779,6 +13701,42 @@
                 "endIndex": 2
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/applicationinsights-core-js!IDynamicConfigHandler#setDf:member",
+              "docComment": "/**\n * Set default values for the config if not present.\n *\n * @param theConfig - The configuration object to set default on (if missing)\n *\n * @param defaultValues - The default values to apply to the config\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "setDf: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "<C>(theConfig: C, defaultValues: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "IConfigDefaults",
+                  "canonicalReference": "@microsoft/applicationinsights-core-js!IConfigDefaults:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<C, T>) => C"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "setDf",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 4
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@microsoft/applicationinsights-core-js!IDynamicConfigHandler#uid:member",
@@ -18948,7 +18906,7 @@
             {
               "kind": "PropertySignature",
               "canonicalReference": "@microsoft/applicationinsights-core-js!IWatchDetails#cfg:member",
-              "docComment": "",
+              "docComment": "/**\n * The current config object\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -18974,21 +18932,52 @@
             },
             {
               "kind": "PropertySignature",
-              "canonicalReference": "@microsoft/applicationinsights-core-js!IWatchDetails#hdlr:member",
-              "docComment": "",
+              "canonicalReference": "@microsoft/applicationinsights-core-js!IWatchDetails#set:member",
+              "docComment": "/**\n * Set the value against the provided config/name with the value, the property will be converted to be dynamic (if not already) as long as the provided config is already a tracked dynamic object.\n *\n * @throws\n *\n * TypeError if the provided config is not a monitored dynamic config\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "set: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "<C, V>(theConfig: C, name: string, value: V) => V"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "set",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@microsoft/applicationinsights-core-js!IWatchDetails#setDf:member",
+              "docComment": "/**\n * Set default values for the config if not present.\n *\n * @param theConfig - The configuration object to set default on (if missing)\n *\n * @param defaultValues - The default values to apply to the config\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "hdlr: "
+                  "text": "setDf: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "<C>(theConfig: C, defaultValues: "
                 },
                 {
                   "kind": "Reference",
-                  "text": "IDynamicConfigHandler",
-                  "canonicalReference": "@microsoft/applicationinsights-core-js!IDynamicConfigHandler:interface"
+                  "text": "IConfigDefaults",
+                  "canonicalReference": "@microsoft/applicationinsights-core-js!IConfigDefaults:type"
                 },
                 {
                   "kind": "Content",
-                  "text": "<T>"
+                  "text": "<C>) => C"
                 },
                 {
                   "kind": "Content",
@@ -18998,10 +18987,10 @@
               "isReadonly": false,
               "isOptional": false,
               "releaseTag": "Public",
-              "name": "hdlr",
+              "name": "setDf",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
-                "endIndex": 3
+                "endIndex": 4
               }
             }
           ],

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

@@ -124,9 +124,6 @@ export class AppInsightsCore implements IAppInsightsCore {
     protected _updateHook?(updateCtx: IProcessTelemetryUpdateContext, updateState: ITelemetryUpdateState): void | boolean;
 }
 
-// @public (undocumented)
-export function applyDefaults<C>(theConfig: C, defaultValues: IConfigDefaults<C>): C;
-
 // @public (undocumented)
 export function areCookiesSupported(logger?: IDiagnosticLogger): any;
 
@@ -713,6 +710,7 @@ export interface IDynamicConfigHandler<T extends IConfiguration> {
     logger: IDiagnosticLogger;
     notify: () => void;
     set: <C, V>(theConfig: C, name: string, value: V) => V;
+    setDf: <C>(theConfig: C, defaultValues: IConfigDefaults<C, T>) => C;
     readonly uid: string;
     watch: (configHandler: WatcherFunction<T>) => IWatcherHandler<T>;
 }
@@ -1056,10 +1054,9 @@ export interface IUnloadHook {
 
 // @public (undocumented)
 export interface IWatchDetails<T extends IConfiguration> {
-    // (undocumented)
     cfg: T;
-    // (undocumented)
-    hdlr: IDynamicConfigHandler<T>;
+    set: <C, V>(theConfig: C, name: string, value: V) => V;
+    setDf: <C>(theConfig: C, defaultValues: IConfigDefaults<C>) => C;
 }
 
 // @public (undocumented)

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

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights Core Javascript SDK, 3.0.0-beta.2210-04
+ * Microsoft Application Insights Core Javascript SDK, 3.0.0-beta.2210-07
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -251,8 +251,6 @@ declare namespace ApplicationInsights {
         protected _updateHook?(updateCtx: IProcessTelemetryUpdateContext, updateState: ITelemetryUpdateState): void | boolean;
     }
 
-    function applyDefaults<C>(theConfig: C, defaultValues: IConfigDefaults<C>): C;
-
     function areCookiesSupported(logger?: IDiagnosticLogger): any;
 
     export { arrForEach }
@@ -1370,20 +1368,20 @@ declare namespace ApplicationInsights {
         queue: _InternalLogMessage[];
         /**
          * 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
-         * @param message - {_InternalLogMessage} - The log message.
+         * @param severity - The severity of the log message
+         * @param message - The log message.
          */
         throwInternal(severity: LoggingSeverity, msgId: _InternalMessageId, msg: string, properties?: Object, isUserAct?: boolean): void;
         /**
          * This will write a warning to the console if possible
-         * @param message - {string} - The warning message
+         * @param message - The warning message
          */
         warnToConsole(message: string): void;
         /**
          * This will write an error to the console if possible.
          * Provided by the default DiagnosticLogger instance, and internally the SDK will fall back to warnToConsole, however,
          * direct callers MUST check for its existence on the logger as you can provide your own IDiagnosticLogger instance.
-         * @param message - {string} - The error message
+         * @param message - The error message
          */
         errorToConsole?(message: string): void;
         /**
@@ -1392,8 +1390,8 @@ declare namespace ApplicationInsights {
         resetInternalMessageCount(): void;
         /**
          * Logs a message to the internal queue.
-         * @param severity - {LoggingSeverity} - The severity of the log message
-         * @param message - {_InternalLogMessage} - The message to log.
+         * @param severity - The severity of the log message
+         * @param message - The message to log.
          */
         logInternalMessage?(severity: LoggingSeverity, message: _InternalLogMessage): void;
         /**
@@ -1478,6 +1476,12 @@ declare namespace ApplicationInsights {
          * @throws TypeError if the provided config is not a monitored dynamic config
          */
         set: <C, V>(theConfig: C, name: string, value: V) => V;
+        /**
+         * Set default values for the config if not present.
+         * @param theConfig - The configuration object to set default on (if missing)
+         * @param defaultValues - The default values to apply to the config
+         */
+        setDf: <C>(theConfig: C, defaultValues: IConfigDefaults<C, T>) => C;
     }
 
     interface IDynamicPropertyHandler<T> {
@@ -2258,8 +2262,23 @@ declare namespace ApplicationInsights {
     }
 
     interface IWatchDetails<T extends IConfiguration> {
+        /**
+         * The current config object
+         */
         cfg: T;
-        hdlr: IDynamicConfigHandler<T>;
+        /**
+         * Set the value against the provided config/name with the value, the property
+         * will be converted to be dynamic (if not already) as long as the provided config
+         * is already a tracked dynamic object.
+         * @throws TypeError if the provided config is not a monitored dynamic config
+         */
+        set: <C, V>(theConfig: C, name: string, value: V) => V;
+        /**
+         * Set default values for the config if not present.
+         * @param theConfig - The configuration object to set default on (if missing)
+         * @param defaultValues - The default values to apply to the config
+         */
+        setDf: <C>(theConfig: C, defaultValues: IConfigDefaults<C>) => C;
     }
 
     interface IWatcherHandler<T extends IConfiguration> extends IUnloadHook {