@microsoft/applicationinsights-common 2.7.5-nightly.2202-11 → 2.7.5-nightly.2203-03

package/src/Interfaces/Contracts/IPageViewPerfData.ts

@@ -0,0 +1,35 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+import { IPageViewData } from "./IPageViewData";
+
+/**
+ * An instance of PageViewPerf represents: a page view with no performance data, a page view with performance data, or just the performance data of an earlier page request.
+ */
+export interface IPageViewPerfData extends IPageViewData {
+
+    /**
+     * Performance total in TimeSpan 'G' (general long) format: d:hh:mm:ss.fffffff
+     */
+    perfTotal: string;
+
+    /**
+     * Network connection time in TimeSpan 'G' (general long) format: d:hh:mm:ss.fffffff
+     */
+    networkConnect: string;
+
+    /**
+     * Sent request time in TimeSpan 'G' (general long) format: d:hh:mm:ss.fffffff
+     */
+    sentRequest: string;
+
+    /**
+     * Received response time in TimeSpan 'G' (general long) format: d:hh:mm:ss.fffffff
+     */
+    receivedResponse: string;
+
+    /**
+     * DOM processing time in TimeSpan 'G' (general long) format: d:hh:mm:ss.fffffff
+     */
+    domProcessing: string;
+}

package/src/Interfaces/Contracts/IRemoteDependencyData.ts

@@ -0,0 +1,65 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+import { IDomain } from "./IDomain";
+
+/**
+ * An instance of Remote Dependency represents an interaction of the monitored component with a remote component/service like SQL or an HTTP endpoint.
+ */
+export interface IRemoteDependencyData extends IDomain {
+
+    /**
+     * Schema version
+     */
+    ver: number; /* 2 */
+
+    /**
+     * Name of the command initiated with this dependency call. Low cardinality value. Examples are stored procedure name and URL path template.
+     */
+    name: string;
+
+    /**
+     * Identifier of a dependency call instance. Used for correlation with the request telemetry item corresponding to this dependency call.
+     */
+    id: string;
+
+    /**
+     * Result code of a dependency call. Examples are SQL error code and HTTP status code.
+     */
+    resultCode: string;
+
+    /**
+     * Request duration in format: DD.HH:MM:SS.MMMMMM. Must be less than 1000 days.
+     */
+    duration: string;
+
+    /**
+     * Indication of successful or unsuccessful call.
+     */
+    success: boolean; /* true */
+
+    /**
+     * Command initiated by this dependency call. Examples are SQL statement and HTTP URL's with all query parameters.
+     */
+    data: string;
+
+    /**
+     * Target site of a dependency call. Examples are server name, host address.
+     */
+    target: string;
+
+    /**
+     * Dependency type name. Very low cardinality value for logical grouping of dependencies and interpretation of other fields like commandName and resultCode. Examples are SQL, Azure table, and HTTP.
+     */
+    type: string;
+
+    /**
+     * Collection of custom properties.
+     */
+    properties: any; /* {} */
+
+    /**
+     * Collection of custom measurements.
+     */
+    measurements: any; /* {} */
+}

package/src/Interfaces/Contracts/IStackFrame.ts

@@ -0,0 +1,33 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+/**
+ * Stack frame information.
+ */
+export interface IStackFrame {
+
+    /**
+     * Level in the call stack. For the long stacks SDK may not report every function in a call stack.
+     */
+    level: number;
+
+    /**
+     * Method name.
+     */
+    method: string;
+
+    /**
+     * Name of the assembly (dll, jar, etc.) containing this function.
+     */
+    assembly: string;
+
+    /**
+     * File name or URL of the method implementation.
+     */
+    fileName: string;
+
+    /**
+     * Line number of the code implementation.
+     */
+    line: number;
+}

package/src/Interfaces/Contracts/RequestData.ts

@@ -0,0 +1,50 @@
+// // Copyright (c) Microsoft Corporation. All rights reserved.
+// // Licensed under the MIT License.
+
+// import { IDomain } from "./IDomain";
+
+// /**
+//  * An instance of Request represents completion of an external request to the application to do work and contains a summary of that request execution and the results.
+//  */
+// export class RequestData implements IDomain {
+
+//     /**
+//      * Schema version
+//      */
+//     public ver: number = 2;
+
+//     /**
+//      * Identifier of a request call instance. Used for correlation between request and other telemetry items.
+//      */
+//     public id: string;
+
+//     /**
+//      * Source of the request. Examples are the instrumentation key of the caller or the ip address of the caller.
+//      */
+//     public source: string;
+
+//     /**
+//      * Name of the request. Represents code path taken to process request. Low cardinality value to allow better grouping of requests. For HTTP requests it represents the HTTP method and URL path template like 'GET /values/{id}'.
+//      */
+//     public name: string;
+
+//     /**
+//      * Indication of successful or unsuccessful call.
+//      */
+//     public success: boolean;
+
+//     /**
+//      * Request URL with all query string parameters.
+//      */
+//     public url: string;
+
+//     /**
+//      * Collection of custom properties.
+//      */
+//     public properties: any = {};
+
+//     /**
+//      * Collection of custom measurements.
+//      */
+//     public measurements: any = {};
+// }

package/src/Interfaces/Contracts/SeverityLevel.ts

@@ -0,0 +1,15 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+// THIS FILE WAS AUTOGENERATED
+
+/**
+ * Defines the level of severity for the event.
+ */
+export enum SeverityLevel {
+    Verbose = 0,
+    Information = 1,
+    Warning = 2,
+    Error = 3,
+    Critical = 4,
+}

package/src/StorageHelperFuncs.ts

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-import { dumpObj, getExceptionName, getGlobal, getGlobalInst, IDiagnosticLogger, isNullOrUndefined, LoggingSeverity, objForEachKey, _InternalMessageId } from "@microsoft/applicationinsights-core-js";
+import { dumpObj, getExceptionName, getGlobal, getGlobalInst, IDiagnosticLogger, isNullOrUndefined, eLoggingSeverity, objForEachKey, _InternalMessageId, _throwInternal } from "@microsoft/applicationinsights-core-js";
 import { StorageType } from "./Enums";
 
 let _canUseLocalStorage: boolean = undefined;
@@ -57,13 +57,29 @@ function _getSessionStorageObject(): Storage {
     return null;
 }
 
+/**
+ * Disables the global SDK usage of local or session storage if available
+ */
 export function utlDisableStorage() {
     _canUseLocalStorage = false;
     _canUseSessionStorage = false;
 }
 
-export function utlCanUseLocalStorage(): boolean {
-    if (_canUseLocalStorage === undefined) {
+/**
+ * Re-enables the global SDK usage of local or session storage if available
+ */
+export function utlEnableStorage() {
+    _canUseLocalStorage = utlCanUseLocalStorage(true);
+    _canUseSessionStorage = utlCanUseSessionStorage(true);
+}
+
+/**
+ * Returns whether LocalStorage can be used, if the reset parameter is passed a true this will override
+ * any previous disable calls.
+ * @param reset - Should the usage be reset and determined only based on whether LocalStorage is available
+ */
+export function utlCanUseLocalStorage(reset?: boolean): boolean {
+    if (reset || _canUseLocalStorage === undefined) {
         _canUseLocalStorage = !!_getVerifiedStorageObject(StorageType.LocalStorage);
     }
 
@@ -78,8 +94,8 @@ export function utlGetLocalStorage(logger: IDiagnosticLogger, name: string): str
         } catch (e) {
             _canUseLocalStorage = false;
 
-            logger.throwInternal(
-                LoggingSeverity.WARNING,
+            _throwInternal(logger,
+                eLoggingSeverity.WARNING,
                 _InternalMessageId.BrowserCannotReadLocalStorage,
                 "Browser failed read of local storage. " + getExceptionName(e),
                 { exception: dumpObj(e) });
@@ -97,8 +113,8 @@ export function utlSetLocalStorage(logger: IDiagnosticLogger, name: string, data
         } catch (e) {
             _canUseLocalStorage = false;
 
-            logger.throwInternal(
-                LoggingSeverity.WARNING,
+            _throwInternal(logger,
+                eLoggingSeverity.WARNING,
                 _InternalMessageId.BrowserCannotWriteLocalStorage,
                 "Browser failed write to local storage. " + getExceptionName(e),
                 { exception: dumpObj(e) });
@@ -116,8 +132,8 @@ export function utlRemoveStorage(logger: IDiagnosticLogger, name: string): boole
         } catch (e) {
             _canUseLocalStorage = false;
 
-            logger.throwInternal(
-                LoggingSeverity.WARNING,
+            _throwInternal(logger,
+                eLoggingSeverity.WARNING,
                 _InternalMessageId.BrowserFailedRemovalFromLocalStorage,
                 "Browser failed removal of local storage item. " + getExceptionName(e),
                 { exception: dumpObj(e) });
@@ -126,8 +142,8 @@ export function utlRemoveStorage(logger: IDiagnosticLogger, name: string): boole
     return false;
 }
 
-export function utlCanUseSessionStorage(): boolean {
-    if (_canUseSessionStorage === undefined) {
+export function utlCanUseSessionStorage(reset?: boolean): boolean {
+    if (reset || _canUseSessionStorage === undefined) {
         _canUseSessionStorage = !!_getVerifiedStorageObject(StorageType.SessionStorage);
     }
 
@@ -154,8 +170,8 @@ export function utlGetSessionStorage(logger: IDiagnosticLogger, name: string): s
         } catch (e) {
             _canUseSessionStorage = false;
 
-            logger.throwInternal(
-                LoggingSeverity.WARNING,
+            _throwInternal(logger,
+                eLoggingSeverity.WARNING,
                 _InternalMessageId.BrowserCannotReadSessionStorage,
                 "Browser failed read of session storage. " + getExceptionName(e),
                 { exception: dumpObj(e) });
@@ -173,8 +189,8 @@ export function utlSetSessionStorage(logger: IDiagnosticLogger, name: string, da
         } catch (e) {
             _canUseSessionStorage = false;
 
-            logger.throwInternal(
-                LoggingSeverity.WARNING,
+            _throwInternal(logger,
+                eLoggingSeverity.WARNING,
                 _InternalMessageId.BrowserCannotWriteSessionStorage,
                 "Browser failed write to session storage. " + getExceptionName(e),
                 { exception: dumpObj(e) });
@@ -192,12 +208,13 @@ export function utlRemoveSessionStorage(logger: IDiagnosticLogger, name: string)
         } catch (e) {
             _canUseSessionStorage = false;
 
-            logger.throwInternal(
-                LoggingSeverity.WARNING,
+            _throwInternal(logger,
+                eLoggingSeverity.WARNING,
                 _InternalMessageId.BrowserFailedRemovalFromSessionStorage,
                 "Browser failed removal of session storage item. " + getExceptionName(e),
                 { exception: dumpObj(e) });
         }
     }
+
     return false;
 }

package/src/Telemetry/Common/DataSanitizer.ts

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-import { IDiagnosticLogger, LoggingSeverity, _InternalMessageId, hasJSON, getJSON, objForEachKey, isObject, strTrim } from "@microsoft/applicationinsights-core-js";
+import { IDiagnosticLogger, eLoggingSeverity, _InternalMessageId, hasJSON, getJSON, objForEachKey, isObject, strTrim, _throwInternal } from "@microsoft/applicationinsights-core-js";
 
 export const enum DataSanitizerValues {
     /**
@@ -66,8 +66,8 @@ export function dataSanitizeKey(logger: IDiagnosticLogger, name: any) {
         // truncate the string to 150 chars
         if (name.length > DataSanitizerValues.MAX_NAME_LENGTH) {
             nameTrunc = name.substring(0, DataSanitizerValues.MAX_NAME_LENGTH);
-            logger && logger.throwInternal(
-                LoggingSeverity.WARNING,
+            _throwInternal(logger,
+                eLoggingSeverity.WARNING,
                 _InternalMessageId.NameTooLong,
                 "name is too long.  It has been truncated to " + DataSanitizerValues.MAX_NAME_LENGTH + " characters.",
                 { name }, true);
@@ -84,8 +84,8 @@ export function dataSanitizeString(logger: IDiagnosticLogger, value: any, maxLen
         value = strTrim(value);
         if (value.toString().length > maxLength) {
             valueTrunc = value.toString().substring(0, maxLength);
-            logger && logger.throwInternal(
-                LoggingSeverity.WARNING,
+            _throwInternal(logger,
+                eLoggingSeverity.WARNING,
                 _InternalMessageId.StringValueTooLong,
                 "string value is too long. It has been truncated to " + maxLength + " characters.",
                 { value }, true);
@@ -104,8 +104,8 @@ export function dataSanitizeMessage(logger: IDiagnosticLogger, message: any) {
     if (message) {
         if (message.length > DataSanitizerValues.MAX_MESSAGE_LENGTH) {
             messageTrunc = message.substring(0, DataSanitizerValues.MAX_MESSAGE_LENGTH);
-            logger && logger.throwInternal(
-                LoggingSeverity.WARNING, _InternalMessageId.MessageTruncated,
+            _throwInternal(logger,
+                eLoggingSeverity.WARNING, _InternalMessageId.MessageTruncated,
                 "message is too long, it has been truncated to " + DataSanitizerValues.MAX_MESSAGE_LENGTH + " characters.",
                 { message },
                 true);
@@ -122,8 +122,8 @@ export function dataSanitizeException(logger: IDiagnosticLogger, exception: any)
         let value:string = "" + exception;
         if (value.length > DataSanitizerValues.MAX_EXCEPTION_LENGTH) {
             exceptionTrunc = value.substring(0, DataSanitizerValues.MAX_EXCEPTION_LENGTH);
-            logger && logger.throwInternal(
-                LoggingSeverity.WARNING, _InternalMessageId.ExceptionTruncated, "exception is too long, it has been truncated to " + DataSanitizerValues.MAX_EXCEPTION_LENGTH + " characters.",
+            _throwInternal(logger,
+                eLoggingSeverity.WARNING, _InternalMessageId.ExceptionTruncated, "exception is too long, it has been truncated to " + DataSanitizerValues.MAX_EXCEPTION_LENGTH + " characters.",
                 { exception }, true);
         }
     }
@@ -140,7 +140,7 @@ export function dataSanitizeProperties(logger: IDiagnosticLogger, properties: an
                 try {
                     value = getJSON().stringify(value);
                 } catch (e) {
-                    logger && logger.throwInternal(LoggingSeverity.WARNING, _InternalMessageId.CannotSerializeObjectNonSerializable, "custom property is not valid", { exception: e}, true);
+                    _throwInternal(logger,eLoggingSeverity.WARNING, _InternalMessageId.CannotSerializeObjectNonSerializable, "custom property is not valid", { exception: e}, true);
                 }
             }
             value = dataSanitizeString(logger, value, DataSanitizerValues.MAX_PROPERTY_LENGTH);
@@ -177,8 +177,8 @@ export function dataSanitizeInput(logger: IDiagnosticLogger, input: any, maxLeng
         input = strTrim(input);
         if (input.length > maxLength) {
             inputTrunc = input.substring(0, maxLength);
-            logger && logger.throwInternal(
-                LoggingSeverity.WARNING,
+            _throwInternal(logger,
+                eLoggingSeverity.WARNING,
                 _msgId,
                 "input is too long, it has been truncated to " + maxLength + " characters.",
                 { data: input },
@@ -282,4 +282,4 @@ export const DataSanitizer: IDataSanitizer = {
     sanitizeInput: dataSanitizeInput,
     padNumber: dsPadNumber,
     trim: strTrim
-};
+};

package/src/Telemetry/Exception.ts

@@ -341,32 +341,44 @@ export class Exception extends ExceptionData implements ISerializable {
             this.exceptions = [new _ExceptionDetails(logger, exception, properties)];
             this.properties = dataSanitizeProperties(logger, properties);
             this.measurements = dataSanitizeMeasurements(logger, measurements);
-            if (severityLevel) { this.severityLevel = severityLevel; }
-            if (id) { this.id = id; }
+            if (severityLevel) {
+                this.severityLevel = severityLevel;
+            }
+            if (id) {
+                this.id = id;
+            }
         } else {
             this.exceptions = exception.exceptions;
             this.properties = exception.properties;
             this.measurements = exception.measurements;
-            if (exception.severityLevel) { this.severityLevel = exception.severityLevel; }
-            if (exception.id) { this.id = exception.id; }
-            if (exception.problemGroup) { this.problemGroup = exception.problemGroup; }
+            if (exception.severityLevel) {
+                this.severityLevel = exception.severityLevel;
+            }
+            if (exception.id) {
+                this.id = exception.id;
+            }
+            if (exception.problemGroup) {
+                this.problemGroup = exception.problemGroup;
+            }
 
             // bool/int types, use isNullOrUndefined
             this.ver = 2; // TODO: handle the CS"4.0" ==> breeze 2 conversion in a better way
-            if (!isNullOrUndefined(exception.isManual)) { this.isManual = exception.isManual; }
+            if (!isNullOrUndefined(exception.isManual)) {
+                this.isManual = exception.isManual;
+            }
         }
     }
 
     public static CreateAutoException(
-            message: string | Event,
-            url: string,
-            lineNumber: number,
-            columnNumber: number,
-            error: any,
-            evt?: Event|string,
-            stack?: string,
-            errorSrc?: string
-        ): IAutoExceptionTelemetry {
+        message: string | Event,
+        url: string,
+        lineNumber: number,
+        columnNumber: number,
+        error: any,
+        evt?: Event|string,
+        stack?: string,
+        errorSrc?: string
+    ): IAutoExceptionTelemetry {
 
         let errorType = _getErrorType(error || evt || message);
 

package/src/TelemetryItemCreator.ts

@@ -29,7 +29,7 @@ export class TelemetryItemCreator {
         if (isNullOrUndefined(item) ||
             isNullOrUndefined(baseType) ||
             isNullOrUndefined(envelopeName)) {
-                throw Error("Input doesn't contain all required fields");
+            throw Error("Input doesn't contain all required fields");
         }
         
         let iKey = "";

package/src/applicationinsights-common.ts

@@ -57,12 +57,12 @@ export { IPropertiesPlugin } from "./Interfaces/IPropertiesPlugin";
 export { IUser, IUserContext } from "./Interfaces/Context/IUser";
 export { ITelemetryTrace, ITraceState } from "./Interfaces/Context/ITelemetryTrace";
 export { IRequestContext } from "./Interfaces/IRequestContext";
-export { DistributedTracingModes } from "./Enums";
+export { eDistributedTracingModes, DistributedTracingModes } from "./Enums";
 export { stringToBoolOrDefault, msToTimeSpan, getExtensionByName, isCrossOriginError } from "./HelperFuncs";
 export { isBeaconsSupported as isBeaconApiSupported } from "@microsoft/applicationinsights-core-js"
 export { createDomEvent } from "./DomHelperFuncs";
 export {
-    utlDisableStorage, utlCanUseLocalStorage, utlGetLocalStorage, utlSetLocalStorage, utlRemoveStorage,
+    utlDisableStorage, utlEnableStorage, utlCanUseLocalStorage, utlGetLocalStorage, utlSetLocalStorage, utlRemoveStorage,
     utlCanUseSessionStorage, utlGetSessionStorageKeys, utlGetSessionStorage, utlSetSessionStorage, utlRemoveSessionStorage
 } from "./StorageHelperFuncs";
 export { urlParseUrl, urlGetAbsoluteUrl, urlGetPathName, urlGetCompleteUrl, urlParseHost, urlParseFullHost } from "./UrlHelperFuncs";

package/types/Enums.d.ts

@@ -1,10 +1,15 @@
 /**
  * Type of storage to differentiate between local storage and session storage
  */
-export declare enum StorageType {
+export declare const enum eStorageType {
     LocalStorage = 0,
     SessionStorage = 1
 }
+export declare const StorageType: {
+    LocalStorage: number;
+    SessionStorage: number;
+};
+export declare type StorageType = eStorageType | typeof StorageType;
 /**
  * Enum is used in aiDataContract to describe how fields are serialized.
  * For instance: (Fieldtype.Required | FieldType.Array) will mark the field as required and indicate it's an array
@@ -15,7 +20,7 @@ export declare const enum FieldType {
     Array = 2,
     Hidden = 4
 }
-export declare enum DistributedTracingModes {
+export declare const enum eDistributedTracingModes {
     /**
      * (Default) Send Application Insights correlation headers
      */
@@ -29,3 +34,9 @@ export declare enum DistributedTracingModes {
      */
     W3C = 2
 }
+export declare const DistributedTracingModes: {
+    AI: number;
+    AI_AND_W3C: number;
+    W3C: number;
+};
+export declare type DistributedTracingModes = number | eDistributedTracingModes;