@microsoft/applicationinsights-core-js 3.0.0-beta.2302-04 → 3.0.0-beta.2302-06

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

@@ -173,6 +173,24 @@ export abstract class BaseTelemetryPlugin implements ITelemetryPlugin {
     version?: string;
 }
 
+// @public
+export function cfgDfBoolean<T, C = IConfiguration>(defaultValue?: boolean, fallBackName?: keyof T | keyof C | Array<keyof T | keyof C>): IConfigDefaultCheck<T, boolean, C>;
+
+// @public
+export function cfgDfFunc<V, T, C = IConfiguration>(defaultValue?: V): IConfigDefaultCheck<T, V, C>;
+
+// @public
+export function cfgDfMerge<V, T = IConfiguration, C = IConfiguration>(defaultValue: V | IConfigDefaults<V, T>): IConfigDefaultCheck<T, V, C>;
+
+// @public
+export function cfgDfSet<V, T, C = IConfiguration>(setter: IConfigSetFn<T, V>, defaultValue: V): IConfigDefaultCheck<T, V, C>;
+
+// @public
+export function cfgDfString<T, C = IConfiguration>(defaultValue?: string): IConfigDefaultCheck<T, string, C>;
+
+// @public
+export function cfgDfValidate<V, T, C = IConfiguration>(validator: IConfigCheckFn<V>, defaultValue: V, fallBackName?: keyof T | keyof C | Array<keyof T | keyof C>): IConfigDefaultCheck<T, V, C>;
+
 // @public
 export function createClassFromInterface<T>(defaults?: T): new () => T;
 
@@ -591,16 +609,19 @@ export interface IChannelControls extends ITelemetryPlugin {
 export type IConfigCheckFn<V> = (value: V) => boolean;
 
 // @public
-export interface IConfigDefaultCheck<T, V, C extends IConfiguration = IConfiguration> {
+export interface IConfigDefaultCheck<T, V, C = IConfiguration> {
     dfVal?: (value: any) => boolean;
     fb?: keyof T | keyof C | Array<keyof T | keyof C>;
     isVal?: IConfigCheckFn<V>;
+    mrg?: boolean;
+    rdOnly?: boolean;
+    ref?: boolean;
     set?: IConfigSetFn<T, V>;
-    v?: V;
+    v?: V | IConfigDefaults<V, T>;
 }
 
 // @public
-export type IConfigDefaults<T, C extends IConfiguration = IConfiguration> = {
+export type IConfigDefaults<T, C = IConfiguration> = {
     [key in keyof T]: T[key] | IConfigDefaultCheck<T, T[key], C>;
 };
 
@@ -810,13 +831,13 @@ export interface INotificationManager {
 }
 
 // @public
-export function InstrumentEvent(target: any, evtName: string, callbacks: IInstrumentHooksCallbacks, checkPrototype?: boolean): IInstrumentHook;
+export function InstrumentEvent(target: any, evtName: string, callbacks: IInstrumentHooksCallbacks, checkPrototype?: boolean, checkParentProto?: boolean): IInstrumentHook;
 
 // @public
-export function InstrumentFunc(target: any, funcName: string, callbacks: IInstrumentHooksCallbacks, checkPrototype?: boolean): IInstrumentHook;
+export function InstrumentFunc(target: any, funcName: string, callbacks: IInstrumentHooksCallbacks, checkPrototype?: boolean, checkParentProto?: boolean): IInstrumentHook;
 
 // @public
-export function InstrumentFuncs(target: any, funcNames: string[], callbacks: IInstrumentHooksCallbacks, checkPrototype?: boolean): IInstrumentHook[];
+export function InstrumentFuncs(target: any, funcNames: string[], callbacks: IInstrumentHooksCallbacks, checkPrototype?: boolean, checkParentProto?: boolean): IInstrumentHook[];
 
 // @public
 export type InstrumentorHooksCallback = (funcArgs: IInstrumentCallDetails, ...orgArgs: any[]) => void;

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

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights Core Javascript SDK, 3.0.0-beta.2302-04
+ * Microsoft Application Insights Core Javascript SDK, 3.0.0-beta.2302-06
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -390,6 +390,57 @@ declare namespace ApplicationInsights {
         protected _addHook(hooks: IUnloadHook | IUnloadHook[] | Iterator<IUnloadHook> | ILegacyUnloadHook | ILegacyUnloadHook[] | Iterator<ILegacyUnloadHook>): void;
     }
 
+    /**
+     * Helper which returns an IConfigDefaultCheck instance that will validate and convert the user
+     * provided value to a boolean from a string or boolean value
+     * @param validator - The IConfigCheckFn function to validate the user provided value
+     * @param defaultValue - The default value to apply it not provided or it's not valid
+     * @param fallBackName - The fallback configuration name if the current value is not available
+     * @returns a new IConfigDefaultCheck structure
+     */
+    function cfgDfBoolean<T, C = IConfiguration>(defaultValue?: boolean, fallBackName?: keyof T | keyof C | Array<keyof T | keyof C>): IConfigDefaultCheck<T, boolean, C>;
+
+    /**
+     * Helper which returns an IConfigDefaultCheck instance that will validate that the user
+     * provided value is a function.
+     * @param defaultValue - The default value to apply it not provided or it's not valid
+     * @returns a new IConfigDefaultCheck structure
+     */
+    function cfgDfFunc<V, T, C = IConfiguration>(defaultValue?: V): IConfigDefaultCheck<T, V, C>;
+
+    /**
+     * Helper which returns an IConfigDefaultCheck instance with the provided field validator
+     * @param validator - The IConfigCheckFn function to validate the user provided value
+     * @param defaultValue - The default value to apply it not provided or it's not valid
+     * @returns a new IConfigDefaultCheck structure
+     */
+    function cfgDfMerge<V, T = IConfiguration, C = IConfiguration>(defaultValue: V | IConfigDefaults<V, T>): IConfigDefaultCheck<T, V, C>;
+
+    /**
+     * Helper which returns an IConfigDefaultCheck instance with the provided field set function
+     * @param setter - The IConfigCheckFn function to validate the user provided value
+     * @param defaultValue - The default value to apply it not provided or it's not valid
+     * @returns a new IConfigDefaultCheck structure
+     */
+    function cfgDfSet<V, T, C = IConfiguration>(setter: IConfigSetFn<T, V>, defaultValue: V): IConfigDefaultCheck<T, V, C>;
+
+    /**
+     * Helper which returns an IConfigDefaultCheck instance that will validate that the user
+     * provided value is a function.
+     * @param defaultValue - The default string value to apply it not provided or it's not valid, defaults to an empty string
+     * @returns a new IConfigDefaultCheck structure
+     */
+    function cfgDfString<T, C = IConfiguration>(defaultValue?: string): IConfigDefaultCheck<T, string, C>;
+
+    /**
+     * Helper which returns an IConfigDefaultCheck instance with the provided field validator
+     * @param validator - The IConfigCheckFn function to validate the user provided value
+     * @param defaultValue - The default value to apply it not provided or it's not valid
+     * @param fallBackName - The fallback configuration name if the current value is not available
+     * @returns a new IConfigDefaultCheck structure
+     */
+    function cfgDfValidate<V, T, C = IConfiguration>(validator: IConfigCheckFn<V>, defaultValue: V, fallBackName?: keyof T | keyof C | Array<keyof T | keyof C>): IConfigDefaultCheck<T, V, C>;
+
     /**
      * Simpler helper to create a dynamic class that implements the interface and populates the values with the defaults.
      * Only instance properties (hasOwnProperty) values are copied from the defaults to the new instance
@@ -1083,7 +1134,7 @@ declare namespace ApplicationInsights {
     /**
      * The default values with a check function
      */
-    interface IConfigDefaultCheck<T, V, C extends IConfiguration = IConfiguration> {
+    interface IConfigDefaultCheck<T, V, C = IConfiguration> {
         /**
          * Callback function to check if the user-supplied value is valid, if not the default will be applied
          */
@@ -1095,7 +1146,7 @@ declare namespace ApplicationInsights {
         /**
          * The default value to apply if the user-supplied value is not valid
          */
-        v?: V;
+        v?: V | IConfigDefaults<V, T>;
         /**
          *  The default fallback key if the main key is not present, this is the key value from the config
          */
@@ -1105,13 +1156,34 @@ declare namespace ApplicationInsights {
          * therefore `null`; `""` are considered to be valid values.
          */
         dfVal?: (value: any) => boolean;
+        /**
+         * Specify that any provided value should have the default value(s) merged into the value rather than
+         * just using either the default of user provided values. Mergeed objects will automatically be marked
+         * as referenced.
+         */
+        mrg?: boolean;
+        /**
+         * Set this field 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.
+         * This is required for nested default objects to avoid multiple repetitive updates to listeners
+         * @returns The referenced properties current value
+         */
+        ref?: boolean;
+        /**
+         * Set this field 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?: boolean;
     }
 
     /**
      * The Type definition to define default values to be applied to the config
      * The value may be either the direct value or a ConfigDefaultCheck definition
      */
-    type IConfigDefaults<T, C extends IConfiguration = IConfiguration> = {
+    type IConfigDefaults<T, C = IConfiguration> = {
         [key in keyof T]: T[key] | IConfigDefaultCheck<T, T[key], C>;
     };
 
@@ -1740,8 +1812,9 @@ declare namespace ApplicationInsights {
      * @param evtName - The name of the event
      * @param callbacks - The callbacks to configure and call whenever the function is called
      * @param checkPrototype - If the function doesn't exist on the target should it attempt to hook the prototype function
+     * @param checkParentProto - If the function doesn't exist on the target or it's prototype should it attempt to hook the parent's prototype
      */
-    function InstrumentEvent(target: any, evtName: string, callbacks: IInstrumentHooksCallbacks, checkPrototype?: boolean): IInstrumentHook;
+    function InstrumentEvent(target: any, evtName: string, callbacks: IInstrumentHooksCallbacks, checkPrototype?: boolean, checkParentProto?: boolean): IInstrumentHook;
 
     /**
      * Intercept the named prototype functions for the target class / object
@@ -1749,8 +1822,9 @@ declare namespace ApplicationInsights {
      * @param funcName - The function name
      * @param callbacks - The callbacks to configure and call whenever the function is called
      * @param checkPrototype - If the function doesn't exist on the target should it attempt to hook the prototype function
+     * @param checkParentProto - If the function doesn't exist on the target or it's prototype should it attempt to hook the parent's prototype
      */
-    function InstrumentFunc(target: any, funcName: string, callbacks: IInstrumentHooksCallbacks, checkPrototype?: boolean): IInstrumentHook;
+    function InstrumentFunc(target: any, funcName: string, callbacks: IInstrumentHooksCallbacks, checkPrototype?: boolean, checkParentProto?: boolean): IInstrumentHook;
 
     /**
      * Intercept the named functions for the target class / object
@@ -1758,8 +1832,9 @@ declare namespace ApplicationInsights {
      * @param funcNames - The function names to intercept and call
      * @param callbacks - The callbacks to configure and call whenever the function is called
      * @param checkPrototype - If the function doesn't exist on the target should it attempt to hook the prototype function
+     * @param checkParentProto - If the function doesn't exist on the target or it's prototype should it attempt to hook the parent's prototype
      */
-    function InstrumentFuncs(target: any, funcNames: string[], callbacks: IInstrumentHooksCallbacks, checkPrototype?: boolean): IInstrumentHook[];
+    function InstrumentFuncs(target: any, funcNames: string[], callbacks: IInstrumentHooksCallbacks, checkPrototype?: boolean, checkParentProto?: boolean): IInstrumentHook[];
 
     /**
      * A callback function that will be called for the wrapped instrumentation function