@microsoft/1ds-core-js 3.2.3 → 3.2.6

package/src/BaseCore.ts

@@ -1,15 +1,18 @@
 /**
- * BaseCore.ts
- * Base Core is a subset of 1DS Web SDK Core. The purpose of Base Core is to generate a smaller bundle size while providing essential features of Core. Features that are not included in Base Core are:
- * 1. Internal logging
- * 2. Sending notifications on telemetry sent/discarded
- * @author Abhilash Panwar (abpanwar) Hector Hernandez (hectorh)
- * @copyright Microsoft 2018
- */
+* BaseCore.ts
+* Base Core is a subset of 1DS Web SDK Core. The purpose of Base Core is to generate a smaller bundle size while providing essential features of Core. Features that are not included in Base Core are:
+* 1. Internal logging
+* 2. Sending notifications on telemetry sent/discarded
+* @author Abhilash Panwar (abpanwar) Hector Hernandez (hectorh)
+* @copyright Microsoft 2018
+*/
 import dynamicProto from "@microsoft/dynamicproto-js";
-import { BaseCore as InternalCore, IPlugin, eLoggingSeverity, ITelemetryItem, IDiagnosticLogger, INotificationManager, dumpObj, _throwInternal } from "@microsoft/applicationinsights-core-js";
-import { IExtendedConfiguration, IExtendedTelemetryItem, IExtendedAppInsightsCore } from "./DataModels";
+import {
+    BaseCore as InternalCore, IDiagnosticLogger, INotificationManager, IPlugin, ITelemetryItem, _throwInternal, dumpObj, eLoggingSeverity
+} from "@microsoft/applicationinsights-core-js";
+import { IExtendedAppInsightsCore, IExtendedConfiguration, IExtendedTelemetryItem } from "./DataModels";
 import { _eExtendedInternalMessageId } from "./Enums";
+import { STR_DEFAULT_ENDPOINT_URL } from "./InternalConstants";
 import { FullVersionString, isDocumentObjectAvailable } from "./Utils";
 
 export default class BaseCore extends InternalCore implements IExtendedAppInsightsCore {
@@ -24,11 +27,11 @@ export default class BaseCore extends InternalCore implements IExtendedAppInsigh
 
             _self.initialize = (config: IExtendedConfiguration, extensions: IPlugin[], logger?: IDiagnosticLogger, notificationManager?: INotificationManager) => {
                 if (config && !config.endpointUrl) {
-                    config.endpointUrl = "https://browser.events.data.microsoft.com/OneCollector/1.0/";
+                    config.endpointUrl = STR_DEFAULT_ENDPOINT_URL;
                 }
 
                 _self.getWParam = () => {
-                    return isDocumentObjectAvailable ? 0 : -1;
+                    return (isDocumentObjectAvailable || !!config.enableWParam) ? 0 : -1;
                 };
 
                 try {

package/src/DataModels.ts

@@ -122,6 +122,12 @@ export interface IExtendedConfiguration extends IConfiguration {
       * Page Show events include "pageshow" and "visibilitychange" (with 'visible' state)
       */
      disablePageShowEvents?: string[];
+
+    /**
+     * Add "&w=0" parameter to support UA Parsing when web-workers don't have access to Document.
+     * Default is false
+     */
+    enableWParam?: boolean;
  
      // End of Internal note: remove these after consuming the ApplicationInsights Core version that defines these on IConfiguration
  }

package/src/ESPromise.ts

@@ -1,12 +1,12 @@
 /**
- * ESPromise.ts
- * @author  Nev Wylie (newylie))
- * @copyright Microsoft 2019
- * Simplified wrapper to provide ES6 style Promise callback handling for older browsers
- */
+* ESPromise.ts
+* @author  Nev Wylie (newylie))
+* @copyright Microsoft 2019
+* Simplified wrapper to provide ES6 style Promise callback handling for older browsers
+*/
 
-import { isFunction } from "@microsoft/applicationinsights-core-js";
 import dynamicProto from "@microsoft/dynamicproto-js";
+import { isFunction } from "@microsoft/applicationinsights-core-js";
 
 /**
  * @ignore -- Don't include in the generated documentation

package/src/ESPromiseScheduler.ts

@@ -1,13 +1,13 @@
 /**
- * ESPromiseScheduler.ts
- * @author Nev Wylie (newylie)
- * @copyright Microsoft 2019
- */
+* ESPromiseScheduler.ts
+* @author Nev Wylie (newylie)
+* @copyright Microsoft 2019
+*/
 
-import ESPromise from "./ESPromise";
-import { ResolverResolveFunc, ResolverRejectFunc } from "./ESPromise";
-import { IDiagnosticLogger, getGlobal } from "@microsoft/applicationinsights-core-js";
 import dynamicProto from "@microsoft/dynamicproto-js";
+import ESPromise from "./ESPromise";
+import { IDiagnosticLogger, _warnToConsole, getGlobal } from "@microsoft/applicationinsights-core-js";
+import { ResolverRejectFunc, ResolverResolveFunc } from "./ESPromise";
 
 /** This is a default timeout that will cause outstanding running promises to be removed/rejected to avoid filling up memory with blocked events */
 const LazyRejectPeriod = 600000;            // 10 Minutes
@@ -309,7 +309,7 @@ export default class ESPromiseScheduler {
         }
 
         function _warnLog(message: string) {
-            diagLog && diagLog.warnToConsole("ESPromiseScheduler[" + _scheduledName + "] " + message);
+            _warnToConsole(diagLog, "ESPromiseScheduler[" + _scheduledName + "] " + message);
         }
     }
 

package/src/Enums.ts

@@ -1,9 +1,9 @@
 /**
- * Enums.ts
- * @author Abhilash Panwar (abpanwar)
- * @copyright Microsoft 2018
- * File containing the enums as constants.
- */
+* Enums.ts
+* @author Abhilash Panwar (abpanwar)
+* @copyright Microsoft 2018
+* File containing the enums as constants.
+*/
 
 import { _InternalMessageId, _eInternalMessageId, createEnumStyle, objFreeze } from "@microsoft/applicationinsights-core-js";
 

package/src/Index.ts

@@ -37,7 +37,7 @@ export {
     MinChannelPriorty, EventsDiscardedReason, ICoreUtils, IDiagnosticLogger, DiagnosticLogger, LoggingSeverity, SendRequestReason,
     IPerfEvent, IPerfManager, IPerfManagerProvider, PerfEvent, PerfManager, doPerf, ICustomProperties, Tags,
     EventHelper, AppInsightsCore as InternalAppInsightsCore, BaseCore as InternalBaseCore, _InternalLogMessage, _InternalMessageId,
-    createEnumStyle, eLoggingSeverity, _eInternalMessageId, _throwInternal,// _warnToConsole, _logInternalMessage
+    createEnumStyle, eLoggingSeverity, _eInternalMessageId, _throwInternal, _warnToConsole, _logInternalMessage,
     // The HelperFuncs functions
     isTypeof, isUndefined, isNullOrUndefined, hasOwnProperty, isObject, isFunction, attachEvent, detachEvent, normalizeJsName,
     objForEachKey, strStartsWith, strEndsWith, strContains, strTrim, isDate, isArray, isError, isString, isNumber, isBoolean,

package/src/InternalConstants.ts

@@ -0,0 +1,16 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+// !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+// Note: DON'T Export these const from the package as we are still targeting ES3 this will export a mutable variables that someone could change!!!
+// !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+// Generally you should only put values that are used more than 2 times and then only if not already exposed as a constant (such as SdkCoreNames)
+// as when using "short" named values from here they will be will be minified smaller than the SdkCoreNames[eSdkCoreNames.xxxx] value.
+
+export const STR_EMPTY = "";
+export const STR_DEFAULT_ENDPOINT_URL = "https://browser.events.data.microsoft.com/OneCollector/1.0/";
+export const STR_PLUGIN_VERSION_STRING = "pluginVersionString";
+export const STR_PLUGIN_VERSION_STRING_ARR = STR_PLUGIN_VERSION_STRING + "Arr" as "pluginVersionStringArr";
+export const STR_VERSION = "version";
+export const STR_PROPERTIES = "properties";

package/src/Utils.ts

@@ -1,20 +1,20 @@
 /**
- * Utils.ts
- * @author  Abhilash Panwar (abpanwar) Hector Hernandez (hectorh)
- * @copyright Microsoft 2018
- * File containing utility functions.
- */
-import { objCreateFn, strShimObject } from "@microsoft/applicationinsights-shims";
-import { IEventProperty, IExtendedTelemetryItem } from "./DataModels";
-import { eEventPropertyType, _ExtendedInternalMessageId, GuidStyle, eValueKind, FieldValueSanitizerType, EventLatency, EventLatencyValue } from "./Enums";
+* Utils.ts
+* @author  Abhilash Panwar (abpanwar) Hector Hernandez (hectorh)
+* @copyright Microsoft 2018
+* File containing utility functions.
+*/
 import {
-    ITelemetryItem, getDocument, getNavigator, getWindow, getGlobalInst,
-    objForEachKey, isUndefined, isNullOrUndefined, isNumber, isReactNative, isString, isBoolean, isArray,
-    newGuid, isObject, perfNow, hasOwnProperty, addEventHandler, uaDisallowsSameSiteNone, strPrototype, objDefineAccessors,
-    toISOString, strTrim, isFunction, objKeys, arrReduce, arrMap, arrIndexOf, arrForEach, strUndefined, strObject,
-    areCookiesSupported, ICookieMgr,  safeGetCookieMgr, generateW3CId,
-    mwcRandom32, mwcRandomSeed, random32, randomValue, newId, isIE, dateNow, isError, isDate, isTypeof, ICoreUtils, strEndsWith, useXDomainRequest, isBeaconsSupported, addPageUnloadEventListener,
+    ICookieMgr, ICoreUtils, ITelemetryItem, addEventHandler, addPageUnloadEventListener, areCookiesSupported, arrForEach, arrIndexOf, arrMap,
+    arrReduce, dateNow, generateW3CId, getDocument, getGlobalInst, getNavigator, getWindow, hasOwnProperty, isArray, isBeaconsSupported,
+    isBoolean, isDate, isError, isFunction, isIE, isNullOrUndefined, isNumber, isObject, isReactNative, isString, isTypeof, isUndefined,
+    mwcRandom32, mwcRandomSeed, newGuid, newId, objDefineAccessors, objForEachKey, objKeys, perfNow, random32, randomValue, safeGetCookieMgr,
+    strEndsWith, strObject, strTrim, strUndefined, toISOString, uaDisallowsSameSiteNone, useXDomainRequest
 } from "@microsoft/applicationinsights-core-js";
+import { ObjHasOwnProperty, objCreateFn, strShimObject, strShimPrototype } from "@microsoft/applicationinsights-shims";
+import { IEventProperty, IExtendedTelemetryItem } from "./DataModels";
+import { EventLatency, EventLatencyValue, FieldValueSanitizerType, GuidStyle, eEventPropertyType, eValueKind } from "./Enums";
+import { STR_EMPTY } from "./InternalConstants";
 
 export const Version = "#version#";
 export const FullVersionString = "1DS-Web-JS-" + Version;
@@ -62,7 +62,7 @@ export function isValueAssigned(value: any) {
     /// <summary> takes a value and checks for undefined, null and empty string </summary>
     /// <param type="any"> value to be tested </param>
     /// <returns> true if value is null undefined or emptyString </returns>
-    return !(value === "" || isNullOrUndefined(value));
+    return !(value === STR_EMPTY || isNullOrUndefined(value));
 }
 
 /**
@@ -77,7 +77,7 @@ export function getTenantId(apiKey: string | undefined): string {
             return apiKey.substring(0, indexTenantId);
         }
     }
-    return "";
+    return STR_EMPTY;
 }
 
 /**
@@ -126,10 +126,10 @@ export function sanitizeProperty(name: string,
     // If the property isn't IEventProperty (and is either string, number, boolean or array), convert it into one.
     if (propType === "string" || propType === "number" || propType === "boolean" || isArray(property)) {
         property = ({ value: property } as IEventProperty);
-    } else if (propType === "object" && !property.hasOwnProperty("value")) {
+    } else if (propType === "object" && !ObjHasOwnProperty.call(property, "value")) {
         property = ({ value: stringifyObjects ? JSON.stringify(property) : property } as IEventProperty);
     } else if (isNullOrUndefined((property as IEventProperty).value)
-        || (property as IEventProperty).value === "" || (!isString((property as IEventProperty).value)
+        || (property as IEventProperty).value === STR_EMPTY || (!isString((property as IEventProperty).value)
             && !isNumber((property as IEventProperty).value) && !isBoolean((property as IEventProperty).value)
             && !isArray((property as IEventProperty).value))) {
         // Since property is IEventProperty, we need to validate its value
@@ -238,7 +238,7 @@ export function getCookie(name: string): string {
         return getCookieValue(safeGetCookieMgr(null), name);
     }
 
-    return "";
+    return STR_EMPTY;
 }
 
 /**
@@ -258,7 +258,7 @@ export function getCookieValue(cookieMgr: ICookieMgr, name: string, decode: bool
         }
     }
 
-    return cookieValue || "";
+    return cookieValue || STR_EMPTY;
 }
 
 /**
@@ -277,7 +277,7 @@ export function createGuid(style: GuidStyle = GuidStyle.Digits): string {
     } else if (style === GuidStyle.Parentheses) {
         theGuid = "(" + theGuid + ")";
     } else if (style === GuidStyle.Numeric) {
-        theGuid = theGuid.replace(/-/g, "");
+        theGuid = theGuid.replace(/-/g, STR_EMPTY);
     }
 
     return theGuid;
@@ -298,7 +298,7 @@ export function extend(obj?: any, obj2?: any, obj3?: any, obj4?: any, obj5?: any
     var deep = false;
     var i = 0;
     var length = arguments.length;
-    var objProto = Object[strPrototype];
+    var objProto = Object[strShimPrototype];
     var theArgs = arguments;
 
     // Check if a deep merge
@@ -400,7 +400,7 @@ export function getFieldValueType(value: any): FieldValueSanitizerType {
                     // Empty arrays are not supported and are considered to be the same as null
                     theType |= getFieldValueType(value[0]);
                 }
-            } else if (hasOwnProperty(value, "value")) {
+            } else if (ObjHasOwnProperty.call(value, "value")) {
                 // Looks like an IEventProperty
                 theType = FieldValueSanitizerType.EventProperty | getFieldValueType(value.value);
             }
@@ -562,4 +562,4 @@ export function openXhr(method: string, urlString: string, withCredentials?: boo
     }
 
     return xhr;
-}
+}

package/src/ValueSanitizer.ts

@@ -1,9 +1,10 @@
-import { isNullOrUndefined, objForEachKey, isString } from "@microsoft/applicationinsights-core-js";
-import { isValueKind, isValueAssigned, getFieldValueType  } from "./Utils";
+import { isNullOrUndefined, isString, objForEachKey } from "@microsoft/applicationinsights-core-js";
 import {
-    IEventProperty, IValueSanitizer, FieldValueSanitizerFunc, FieldValueSanitizerTypes, IFieldSanitizerDetails, IFieldValueSanitizerProvider,
+    FieldValueSanitizerFunc, FieldValueSanitizerTypes, IEventProperty, IFieldSanitizerDetails, IFieldValueSanitizerProvider, IValueSanitizer
 } from "./DataModels";
 import { FieldValueSanitizerType } from "./Enums";
+import { STR_EMPTY } from "./InternalConstants";
+import { getFieldValueType, isValueAssigned, isValueKind } from "./Utils";
 
 interface ISanitizerMapValue {
     canHandle: boolean;
@@ -154,7 +155,7 @@ export class ValueSanitizer implements IValueSanitizer {
                 }
 
                 // Check that property is valid
-                if (!isString(name) || isNullOrUndefined(value) || (value as any) === "") {
+                if (!isString(name) || isNullOrUndefined(value) || (value as any) === STR_EMPTY) {
                     return null;
                 }