@microsoft/applicationinsights-common 3.0.0-beta.2208-14 → 3.0.0-beta.2208-16

package/dist/applicationinsights-common.api.md

@@ -60,8 +60,20 @@ export class ContextTagKeys extends ContextTagKeys_base {
     constructor();
 }
 
+// @public
+export function correlationIdCanIncludeCorrelationHeader(config: ICorrelationConfig, requestUrl: string, currentHost?: string): boolean;
+
+// @public
+export function correlationIdGetCorrelationContext(responseHeader: string): string;
+
+// @public
+export function correlationIdGetCorrelationContextValue(responseHeader: string, key: string): string;
+
+// @public (undocumented)
+export function correlationIdGetPrefix(): string;
+
 // @public (undocumented)
-export const CorrelationIdHelper: ICorrelationIdHelper;
+export function correlationIdSetPrefix(prefix: string): void;
 
 // @public
 export function createDistributedTraceContextFromTrace(telemetryTrace?: ITelemetryTrace, parentCtx?: IDistributedTraceContext): IDistributedTraceContext;
@@ -116,9 +128,6 @@ export function dataSanitizeMessage(logger: IDiagnosticLogger, message: any): an
 // @public (undocumented)
 export function dataSanitizeProperties(logger: IDiagnosticLogger, properties: any): any;
 
-// @public
-export const DataSanitizer: IDataSanitizer;
-
 // @public (undocumented)
 export const enum DataSanitizerValues {
     MAX_EXCEPTION_LENGTH = 32768,
@@ -136,9 +145,6 @@ export function dataSanitizeString(logger: IDiagnosticLogger, value: any, maxLen
 // @public (undocumented)
 export function dataSanitizeUrl(logger: IDiagnosticLogger, url: any): any;
 
-// @public
-export const DateTimeUtils: IDateTimeUtils;
-
 // @public (undocumented)
 export function dateTimeUtilsDuration(start: number, end: number): number;
 
@@ -577,63 +583,6 @@ export interface ICorrelationConfig {
     maxAjaxPerfLookupAttempts?: number;
 }
 
-// @public (undocumented)
-export interface ICorrelationIdHelper {
-    canIncludeCorrelationHeader(config: ICorrelationConfig, requestUrl: string, currentHost?: string): boolean;
-    // (undocumented)
-    correlationIdPrefix: string;
-    getCorrelationContext(responseHeader: string): string | undefined;
-    getCorrelationContextValue(responseHeader: string, key: string): string | undefined;
-}
-
-// @public (undocumented)
-export interface IDataSanitizer {
-    MAX_EXCEPTION_LENGTH: number;
-    MAX_ID_LENGTH: number;
-    MAX_MESSAGE_LENGTH: number;
-    MAX_NAME_LENGTH: number;
-    MAX_PROPERTY_LENGTH: number;
-    MAX_STRING_LENGTH: number;
-    MAX_URL_LENGTH: number;
-    // (undocumented)
-    padNumber: (num: number) => string;
-    // Warning: (ae-forgotten-export) The symbol "_DYN_SANITIZE_EXCEPTION" needs to be exported by the entry point applicationinsights-common.d.ts
-    //
-    // (undocumented)
-    [_DYN_SANITIZE_EXCEPTION]: (logger: IDiagnosticLogger, exception: any) => string;
-    // (undocumented)
-    sanitizeId: (logger: IDiagnosticLogger, id: string) => string;
-    // (undocumented)
-    sanitizeInput: (logger: IDiagnosticLogger, input: any, maxLength: number, _msgId: _eInternalMessageId) => any;
-    // (undocumented)
-    sanitizeKey: (logger: IDiagnosticLogger, name: any) => string;
-    // Warning: (ae-forgotten-export) The symbol "_DYN_SANITIZE_KEY_AND_ADD2" needs to be exported by the entry point applicationinsights-common.d.ts
-    //
-    // (undocumented)
-    [_DYN_SANITIZE_KEY_AND_ADD2]: (logger: IDiagnosticLogger, key: any, map: any) => string;
-    // Warning: (ae-forgotten-export) The symbol "_DYN_SANITIZE_MEASUREMENT3" needs to be exported by the entry point applicationinsights-common.d.ts
-    //
-    // (undocumented)
-    [_DYN_SANITIZE_MEASUREMENT3]: (logger: IDiagnosticLogger, measurements: any) => any;
-    // (undocumented)
-    sanitizeMessage: (logger: IDiagnosticLogger, message: any) => string;
-    // Warning: (ae-forgotten-export) The symbol "_DYN_SANITIZE_PROPERTIES" needs to be exported by the entry point applicationinsights-common.d.ts
-    //
-    // (undocumented)
-    [_DYN_SANITIZE_PROPERTIES]: (logger: IDiagnosticLogger, properties: any) => any;
-    // (undocumented)
-    sanitizeString: (logger: IDiagnosticLogger, value: any, maxLength?: number) => string;
-    // (undocumented)
-    sanitizeUrl: (logger: IDiagnosticLogger, url: any) => string;
-    trim: (str: any) => string;
-}
-
-// @public (undocumented)
-export interface IDateTimeUtils {
-    GetDuration: (start: number, end: number) => number;
-    Now: () => number;
-}
-
 // Warning: (ae-forgotten-export) The symbol "IPartC" needs to be exported by the entry point applicationinsights-common.d.ts
 //
 // @public
@@ -900,21 +849,6 @@ export interface ITraceTelemetry extends IPartC {
     severityLevel?: SeverityLevel;
 }
 
-// @public (undocumented)
-export interface IUrlHelper {
-    // (undocumented)
-    getAbsoluteUrl: (url: string) => string;
-    // (undocumented)
-    getCompleteUrl: (method: string, absoluteUrl: string) => string;
-    // (undocumented)
-    getPathName: (url: string) => string;
-    parseFullHost: (url: string, inclPort?: boolean) => string;
-    // (undocumented)
-    parseHost: (url: string, inclPort?: boolean) => string;
-    // (undocumented)
-    parseUrl: (url: string) => HTMLAnchorElement;
-}
-
 // @public (undocumented)
 export interface IUser {
     accountAcquisitionDate: string;
@@ -937,58 +871,6 @@ export interface IUserContext extends IUser {
     update(userId?: string): void;
 }
 
-// @public (undocumented)
-export interface IUtil {
-    addEventHandler: (obj: any, eventNameWithoutOn: string, handlerRef: any, useCapture: boolean) => boolean;
-    // @deprecated (undocumented)
-    canUseCookies: (logger: IDiagnosticLogger) => any;
-    canUseLocalStorage: () => boolean;
-    canUseSessionStorage: () => boolean;
-    // (undocumented)
-    createDomEvent: (eventName: string) => Event;
-    // @deprecated (undocumented)
-    deleteCookie: (logger: IDiagnosticLogger, name: string) => void;
-    // @deprecated (undocumented)
-    disableCookies: () => void;
-    // (undocumented)
-    disableStorage: () => void;
-    // (undocumented)
-    disallowsSameSiteNone: (userAgent: string) => boolean;
-    dump: (object: any) => string;
-    generateW3CId: () => string;
-    // @deprecated (undocumented)
-    getCookie: (logger: IDiagnosticLogger, name: string) => string;
-    getExceptionName: (object: any) => string;
-    // (undocumented)
-    getExtension: (extensions: IPlugin[], identifier: string) => IPlugin | null;
-    getIEVersion: (userAgentStr?: string) => number;
-    getSessionStorage: (logger: IDiagnosticLogger, name: string) => string;
-    getSessionStorageKeys: () => string[];
-    getStorage: (logger: IDiagnosticLogger, name: string) => string;
-    isArray: (obj: any) => boolean;
-    IsBeaconApiSupported: () => boolean;
-    isCrossOriginError: (message: string | Event, url: string, lineNumber: number, columnNumber: number, error: Error) => boolean;
-    isDate: (obj: any) => obj is Date;
-    isError: (obj: any) => obj is Error;
-    isInternalApplicationInsightsEndpoint: (endpointUrl: string) => boolean;
-    msToTimeSpan: (totalms: number) => string;
-    newId: () => string;
-    // (undocumented)
-    NotSpecified: string;
-    random32: () => number;
-    removeSessionStorage: (logger: IDiagnosticLogger, name: string) => boolean;
-    removeStorage: (logger: IDiagnosticLogger, name: string) => boolean;
-    // @deprecated (undocumented)
-    setCookie: (logger: IDiagnosticLogger, name: string, value: string, domain?: string) => void;
-    setSessionStorage: (logger: IDiagnosticLogger, name: string, data: string) => boolean;
-    setStorage: (logger: IDiagnosticLogger, name: string, data: string) => boolean;
-    // (undocumented)
-    stringToBoolOrDefault: (str: any, defaultValue?: boolean) => boolean;
-    // (undocumented)
-    toISOStringForIE8: (date: Date) => string;
-    trim: (str: any) => string;
-}
-
 // @public (undocumented)
 export interface IWeb {
     browser: string;
@@ -1233,9 +1115,6 @@ export function urlGetCompleteUrl(method: string, absoluteUrl: string): string;
 // @public (undocumented)
 export function urlGetPathName(url: string): string;
 
-// @public (undocumented)
-export const UrlHelper: IUrlHelper;
-
 // @public (undocumented)
 export function urlParseFullHost(url: string, inclPort?: boolean): string;
 
@@ -1245,9 +1124,6 @@ export function urlParseHost(url: string, inclPort?: boolean): string;
 // @public (undocumented)
 export function urlParseUrl(url: string): HTMLAnchorElement;
 
-// @public (undocumented)
-export const Util: IUtil;
-
 // @public
 export function utlCanUseLocalStorage(reset?: boolean): boolean;
 

package/dist/applicationinsights-common.d.ts

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights Common JavaScript Library, 3.0.0-beta.2208-14
+ * Microsoft Application Insights Common JavaScript Library, 3.0.0-beta.2208-16
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -76,7 +76,28 @@ declare namespace ApplicationInsights {
 
     const ContextTagKeys_base: new () => IContextTagKeys;
 
-    const CorrelationIdHelper: ICorrelationIdHelper;
+    /**
+     * Checks if a request url is not on a excluded domain list and if it is safe to add correlation headers.
+     * Headers are always included if the current domain matches the request domain. If they do not match (CORS),
+     * they are regex-ed across correlationHeaderDomains and correlationHeaderExcludedDomains to determine if headers are included.
+     * Some environments don't give information on currentHost via window.location.host (e.g. Cordova). In these cases, the user must
+     * manually supply domains to include correlation headers on. Else, no headers will be included at all.
+     */
+    function correlationIdCanIncludeCorrelationHeader(config: ICorrelationConfig, requestUrl: string, currentHost?: string): boolean;
+
+    /**
+     * Combines target appId and target role name from response header.
+     */
+    function correlationIdGetCorrelationContext(responseHeader: string): string;
+
+    /**
+     * Gets key from correlation response header
+     */
+    function correlationIdGetCorrelationContextValue(responseHeader: string, key: string): string;
+
+    function correlationIdGetPrefix(): string;
+
+    function correlationIdSetPrefix(prefix: string): void;
 
     /**
      * Creates a IDistributedTraceContext from an optional telemetryTrace
@@ -196,11 +217,6 @@ declare namespace ApplicationInsights {
 
     function dataSanitizeProperties(logger: IDiagnosticLogger, properties: any): any;
 
-    /**
-     * Provides the DataSanitizer functions within the previous namespace.
-     */
-    const DataSanitizer: IDataSanitizer;
-
     const enum DataSanitizerValues {
         /**
          * Max length allowed for custom names.
@@ -236,11 +252,6 @@ declare namespace ApplicationInsights {
 
     function dataSanitizeUrl(logger: IDiagnosticLogger, url: any): any;
 
-    /**
-     * A utility class that helps getting time related parameters
-     */
-    const DateTimeUtils: IDateTimeUtils;
-
     function dateTimeUtilsDuration(start: number, end: number): number;
 
     function dateTimeUtilsNow(): number;
@@ -264,14 +275,6 @@ declare namespace ApplicationInsights {
 
     function dsPadNumber(num: number): string;
 
-    const _DYN_SANITIZE_EXCEPTION = "sanitizeException";
-
-    const _DYN_SANITIZE_KEY_AND_ADD2 = "sanitizeKeyAndAddUniqueness";
-
-    const _DYN_SANITIZE_MEASUREMENT3 = "sanitizeMeasurements";
-
-    const _DYN_SANITIZE_PROPERTIES = "sanitizeProperties";
-
     const enum eDistributedTracingModes {
         /**
          * (Default) Send Application Insights correlation headers
@@ -1113,26 +1116,6 @@ declare namespace ApplicationInsights {
         addRequestContext?: (requestContext?: IRequestContext) => ICustomProperties;
     }
 
-    interface ICorrelationIdHelper {
-        correlationIdPrefix: string;
-        /**
-         * Checks if a request url is not on a excluded domain list and if it is safe to add correlation headers.
-         * Headers are always included if the current domain matches the request domain. If they do not match (CORS),
-         * they are regex-ed across correlationHeaderDomains and correlationHeaderExcludedDomains to determine if headers are included.
-         * Some environments don't give information on currentHost via window.location.host (e.g. Cordova). In these cases, the user must
-         * manually supply domains to include correlation headers on. Else, no headers will be included at all.
-         */
-        canIncludeCorrelationHeader(config: ICorrelationConfig, requestUrl: string, currentHost?: string): boolean;
-        /**
-         * Combines target appId and target role name from response header.
-         */
-        getCorrelationContext(responseHeader: string): string | undefined;
-        /**
-         * Gets key from correlation response header
-         */
-        getCorrelationContextValue(responseHeader: string, key: string): string | undefined;
-    }
-
     /**
      * Metric data single measurement.
      */
@@ -1167,63 +1150,6 @@ declare namespace ApplicationInsights {
         stdDev: number;
     }
 
-    interface IDataSanitizer {
-        /**
-         * Max length allowed for custom names.
-         */
-        MAX_NAME_LENGTH: number;
-        /**
-         * Max length allowed for Id field in page views.
-         */
-        MAX_ID_LENGTH: number;
-        /**
-         * Max length allowed for custom values.
-         */
-        MAX_PROPERTY_LENGTH: number;
-        /**
-         * Max length allowed for names
-         */
-        MAX_STRING_LENGTH: number;
-        /**
-         * Max length allowed for url.
-         */
-        MAX_URL_LENGTH: number;
-        /**
-         * Max length allowed for messages.
-         */
-        MAX_MESSAGE_LENGTH: number;
-        /**
-         * Max length allowed for exceptions.
-         */
-        MAX_EXCEPTION_LENGTH: number;
-        [_DYN_SANITIZE_KEY_AND_ADD2]: (logger: IDiagnosticLogger, key: any, map: any) => string;
-        sanitizeKey: (logger: IDiagnosticLogger, name: any) => string;
-        sanitizeString: (logger: IDiagnosticLogger, value: any, maxLength?: number) => string;
-        sanitizeUrl: (logger: IDiagnosticLogger, url: any) => string;
-        sanitizeMessage: (logger: IDiagnosticLogger, message: any) => string;
-        [_DYN_SANITIZE_EXCEPTION]: (logger: IDiagnosticLogger, exception: any) => string;
-        [_DYN_SANITIZE_PROPERTIES]: (logger: IDiagnosticLogger, properties: any) => any;
-        [_DYN_SANITIZE_MEASUREMENT3]: (logger: IDiagnosticLogger, measurements: any) => any;
-        sanitizeId: (logger: IDiagnosticLogger, id: string) => string;
-        sanitizeInput: (logger: IDiagnosticLogger, input: any, maxLength: number, _msgId: _eInternalMessageId) => any;
-        padNumber: (num: number) => string;
-        /**
-         * helper method to trim strings (IE8 does not implement String.prototype.trim)
-         */
-        trim: (str: any) => string;
-    }
-
-    interface IDateTimeUtils {
-        /**
-         * Get the number of milliseconds since 1970/01/01 in local timezone
-         */
-        Now: () => number;
-        /**
-         * Gets duration between two timestamps
-         */
-        GetDuration: (start: number, end: number) => number;
-    }
-
     /**
      * DependencyTelemetry telemetry interface
      */
@@ -2041,18 +1967,6 @@ declare namespace ApplicationInsights {
         iKey?: string;
     }
 
-    interface IUrlHelper {
-        parseUrl: (url: string) => HTMLAnchorElement;
-        getAbsoluteUrl: (url: string) => string;
-        getPathName: (url: string) => string;
-        getCompleteUrl: (method: string, absoluteUrl: string) => string;
-        parseHost: (url: string, inclPort?: boolean) => string;
-        /**
-         * Get the full host from the url, optionally including the port
-         */
-        parseFullHost: (url: string, inclPort?: boolean) => string;
-    }
-
     interface IUser {
         /**
          * The telemetry configuration.
@@ -2094,171 +2008,6 @@ declare namespace ApplicationInsights {
         update(userId?: string): void;
     }
 
-    interface IUtil {
-        NotSpecified: string;
-        createDomEvent: (eventName: string) => Event;
-        disableStorage: () => void;
-        /**
-         *  Checks if endpoint URL is application insights internal injestion service URL.
-         *
-         *  @param endpointUrl Endpoint URL to check.
-         *  @returns {boolean} True if if endpoint URL is application insights internal injestion service URL.
-         */
-        isInternalApplicationInsightsEndpoint: (endpointUrl: string) => boolean;
-        /**
-         *  Check if the browser supports local storage.
-         *
-         *  @returns {boolean} True if local storage is supported.
-         */
-        canUseLocalStorage: () => boolean;
-        /**
-         *  Get an object from the browser's local storage
-         *
-         *  @param {string} name - the name of the object to get from storage
-         *  @returns {string} The contents of the storage object with the given name. Null if storage is not supported.
-         */
-        getStorage: (logger: IDiagnosticLogger, name: string) => string;
-        /**
-         *  Set the contents of an object in the browser's local storage
-         *
-         *  @param {string} name - the name of the object to set in storage
-         *  @param {string} data - the contents of the object to set in storage
-         *  @returns {boolean} True if the storage object could be written.
-         */
-        setStorage: (logger: IDiagnosticLogger, name: string, data: string) => boolean;
-        /**
-         *  Remove an object from the browser's local storage
-         *
-         *  @param {string} name - the name of the object to remove from storage
-         *  @returns {boolean} True if the storage object could be removed.
-         */
-        removeStorage: (logger: IDiagnosticLogger, name: string) => boolean;
-        /**
-         *  Check if the browser supports session storage.
-         *
-         *  @returns {boolean} True if session storage is supported.
-         */
-        canUseSessionStorage: () => boolean;
-        /**
-         *  Gets the list of session storage keys
-         *
-         *  @returns {string[]} List of session storage keys
-         */
-        getSessionStorageKeys: () => string[];
-        /**
-         *  Get an object from the browser's session storage
-         *
-         *  @param {string} name - the name of the object to get from storage
-         *  @returns {string} The contents of the storage object with the given name. Null if storage is not supported.
-         */
-        getSessionStorage: (logger: IDiagnosticLogger, name: string) => string;
-        /**
-         *  Set the contents of an object in the browser's session storage
-         *
-         *  @param {string} name - the name of the object to set in storage
-         *  @param {string} data - the contents of the object to set in storage
-         *  @returns {boolean} True if the storage object could be written.
-         */
-        setSessionStorage: (logger: IDiagnosticLogger, name: string, data: string) => boolean;
-        /**
-         *  Remove an object from the browser's session storage
-         *
-         *  @param {string} name - the name of the object to remove from storage
-         *  @returns {boolean} True if the storage object could be removed.
-         */
-        removeSessionStorage: (logger: IDiagnosticLogger, name: string) => boolean;
-        /**
-         * @deprecated - Use the core.getCookieMgr().disable()
-         * Force the SDK not to store and read any data from cookies.
-         */
-        disableCookies: () => void;
-        /**
-         * @deprecated - Use the core.getCookieMgr().isEnabled()
-         * Helper method to tell if document.cookie object is available and whether it can be used.
-         */
-        canUseCookies: (logger: IDiagnosticLogger) => any;
-        disallowsSameSiteNone: (userAgent: string) => boolean;
-        /**
-         * @deprecated - Use the core.getCookieMgr().set()
-         * helper method to set userId and sessionId cookie
-         */
-        setCookie: (logger: IDiagnosticLogger, name: string, value: string, domain?: string) => void;
-        stringToBoolOrDefault: (str: any, defaultValue?: boolean) => boolean;
-        /**
-         * @deprecated - Use the core.getCookieMgr().get()
-         * helper method to access userId and sessionId cookie
-         */
-        getCookie: (logger: IDiagnosticLogger, name: string) => string;
-        /**
-         * @deprecated - Use the core.getCookieMgr().del()
-         * Deletes a cookie by setting it's expiration time in the past.
-         * @param name - The name of the cookie to delete.
-         */
-        deleteCookie: (logger: IDiagnosticLogger, name: string) => void;
-        /**
-         * helper method to trim strings (IE8 does not implement String.prototype.trim)
-         */
-        trim: (str: any) => string;
-        /**
-         * generate random id string
-         */
-        newId: () => string;
-        /**
-         * generate a random 32bit number (-0x80000000..0x7FFFFFFF).
-         */
-        random32: () => number;
-        /**
-         * generate W3C trace id
-         */
-        generateW3CId: () => string;
-        /**
-         * Check if an object is of type Array
-         */
-        isArray: (obj: any) => boolean;
-        /**
-         * Check if an object is of type Error
-         */
-        isError: (obj: any) => obj is Error;
-        /**
-         * Check if an object is of type Date
-         */
-        isDate: (obj: any) => obj is Date;
-        toISOStringForIE8: (date: Date) => string;
-        /**
-         * Gets IE version returning the document emulation mode if we are running on IE, or null otherwise
-         */
-        getIEVersion: (userAgentStr?: string) => number;
-        /**
-         * Convert ms to c# time span format
-         */
-        msToTimeSpan: (totalms: number) => string;
-        /**
-         * Checks if error has no meaningful data inside. Ususally such errors are received by window.onerror when error
-         * happens in a script from other domain (cross origin, CORS).
-         */
-        isCrossOriginError: (message: string | Event, url: string, lineNumber: number, columnNumber: number, error: Error) => boolean;
-        /**
-         * Returns string representation of an object suitable for diagnostics logging.
-         */
-        dump: (object: any) => string;
-        /**
-         * Returns the name of object if it's an Error. Otherwise, returns empty string.
-         */
-        getExceptionName: (object: any) => string;
-        /**
-         * Adds an event handler for the specified event to the window
-         * @param eventName {string} - The name of the event
-         * @param callback {any} - The callback function that needs to be executed for the given event
-         * @return {boolean} - true if the handler was successfully added
-         */
-        addEventHandler: (obj: any, eventNameWithoutOn: string, handlerRef: any, useCapture: boolean) => boolean;
-        /**
-         * Tells if a browser supports a Beacon API
-         */
-        IsBeaconApiSupported: () => boolean;
-        getExtension: (extensions: IPlugin[], identifier: string) => IPlugin | null;
-    }
-
     interface IWeb {
         /**
          * Browser name, set at ingestion
@@ -2625,16 +2374,12 @@ declare namespace ApplicationInsights {
 
     function urlGetPathName(url: string): string;
 
-    const UrlHelper: IUrlHelper;
-
     function urlParseFullHost(url: string, inclPort?: boolean): string;
 
     function urlParseHost(url: string, inclPort?: boolean): string;
 
     function urlParseUrl(url: string): HTMLAnchorElement;
 
-    const Util: IUtil;
-
     /**
      * Returns whether LocalStorage can be used, if the reset parameter is passed a true this will override
      * any previous disable calls.