@microsoft/applicationinsights-common 2.8.0-beta.2203-16 → 2.8.0-nightly.2204-05

package/src/Interfaces/PartAExtensions.ts

@@ -1,4 +1,4 @@
-import { ContextTagKeys } from "./Contracts/Generated/ContextTagKeys";
+import { ContextTagKeys } from "./Contracts/ContextTagKeys";
 
 export const Extensions = {
     UserExt: "user",

package/src/Interfaces/Telemetry/IEnvelope.ts

@@ -4,12 +4,44 @@
 import { ISerializable } from "./ISerializable";
 
 export interface IEnvelope extends ISerializable {
-    ver: number;
+
+    /**
+     * Envelope version. For internal use only. By assigning this the default, it will not be serialized within the payload unless changed to a value other than #1.
+     */
+    ver: number; /* 1 */
+
+    /**
+     * Type name of telemetry data item.
+     */
     name: string;
+ 
+    /**
+     * Event date time when telemetry item was created. This is the wall clock time on the client when the event was generated. There is no guarantee that the client's time is accurate. This field must be formatted in UTC ISO 8601 format, with a trailing 'Z' character, as described publicly on https://en.wikipedia.org/wiki/ISO_8601#UTC. Note: the number of decimal seconds digits provided are variable (and unspecified). Consumers should handle this, i.e. managed code consumers should not use format 'O' for parsing as it specifies a fixed length. Example: 2009-06-15T13:45:30.0000000Z.
+     */
     time: string;
-    sampleRate: number;
+ 
+    /**
+     * Sampling rate used in application. This telemetry item represents 1 / sampleRate actual telemetry items.
+     */
+    sampleRate: number; /* 100.0 */
+ 
+    /**
+     * Sequence field used to track absolute order of uploaded events.
+     */
     seq: string;
+ 
+    /**
+     * The application's instrumentation key. The key is typically represented as a GUID, but there are cases when it is not a guid. No code should rely on iKey being a GUID. Instrumentation key is case insensitive.
+     */
     iKey: string;
-    tags: { [name: string]: any };
+ 
+    /**
+     * Key/value collection of context properties. See ContextTagKeys for information on available properties.
+     */
+    tags: { [name: string]: any };  /* {} */
+ 
+    /**
+     * Telemetry data item.
+     */
     data: any;
 }

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, eLoggingSeverity, objForEachKey, _InternalMessageId, _throwInternal } from "@microsoft/applicationinsights-core-js";
+import { dumpObj, getExceptionName, getGlobal, getGlobalInst, IDiagnosticLogger, isNullOrUndefined, eLoggingSeverity, objForEachKey, _eInternalMessageId, _throwInternal } from "@microsoft/applicationinsights-core-js";
 import { StorageType } from "./Enums";
 
 let _canUseLocalStorage: boolean = undefined;
@@ -96,7 +96,7 @@ export function utlGetLocalStorage(logger: IDiagnosticLogger, name: string): str
 
             _throwInternal(logger,
                 eLoggingSeverity.WARNING,
-                _InternalMessageId.BrowserCannotReadLocalStorage,
+                _eInternalMessageId.BrowserCannotReadLocalStorage,
                 "Browser failed read of local storage. " + getExceptionName(e),
                 { exception: dumpObj(e) });
         }
@@ -115,7 +115,7 @@ export function utlSetLocalStorage(logger: IDiagnosticLogger, name: string, data
 
             _throwInternal(logger,
                 eLoggingSeverity.WARNING,
-                _InternalMessageId.BrowserCannotWriteLocalStorage,
+                _eInternalMessageId.BrowserCannotWriteLocalStorage,
                 "Browser failed write to local storage. " + getExceptionName(e),
                 { exception: dumpObj(e) });
         }
@@ -134,7 +134,7 @@ export function utlRemoveStorage(logger: IDiagnosticLogger, name: string): boole
 
             _throwInternal(logger,
                 eLoggingSeverity.WARNING,
-                _InternalMessageId.BrowserFailedRemovalFromLocalStorage,
+                _eInternalMessageId.BrowserFailedRemovalFromLocalStorage,
                 "Browser failed removal of local storage item. " + getExceptionName(e),
                 { exception: dumpObj(e) });
         }
@@ -172,7 +172,7 @@ export function utlGetSessionStorage(logger: IDiagnosticLogger, name: string): s
 
             _throwInternal(logger,
                 eLoggingSeverity.WARNING,
-                _InternalMessageId.BrowserCannotReadSessionStorage,
+                _eInternalMessageId.BrowserCannotReadSessionStorage,
                 "Browser failed read of session storage. " + getExceptionName(e),
                 { exception: dumpObj(e) });
         }
@@ -191,7 +191,7 @@ export function utlSetSessionStorage(logger: IDiagnosticLogger, name: string, da
 
             _throwInternal(logger,
                 eLoggingSeverity.WARNING,
-                _InternalMessageId.BrowserCannotWriteSessionStorage,
+                _eInternalMessageId.BrowserCannotWriteSessionStorage,
                 "Browser failed write to session storage. " + getExceptionName(e),
                 { exception: dumpObj(e) });
         }
@@ -210,7 +210,7 @@ export function utlRemoveSessionStorage(logger: IDiagnosticLogger, name: string)
 
             _throwInternal(logger,
                 eLoggingSeverity.WARNING,
-                _InternalMessageId.BrowserFailedRemovalFromSessionStorage,
+                _eInternalMessageId.BrowserFailedRemovalFromSessionStorage,
                 "Browser failed removal of session storage item. " + getExceptionName(e),
                 { exception: dumpObj(e) });
         }

package/src/Telemetry/Common/Data.ts

@@ -1,11 +1,11 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-import { Data as AIData } from "../../Interfaces/Contracts/Generated/Data";
+import { IData } from "../../Interfaces/Contracts/IData";
 import { ISerializable } from "../../Interfaces/Telemetry/ISerializable";
 import { FieldType } from "../../Enums";
 
-export class Data<TDomain> extends AIData<TDomain> implements ISerializable {
+export class Data<TDomain> implements IData<TDomain>, ISerializable {
 
     /**
      * The data contract for serializing this object.
@@ -15,12 +15,20 @@ export class Data<TDomain> extends AIData<TDomain> implements ISerializable {
         baseData: FieldType.Required
     }
 
+    /**
+     * Name of item (B section) if any. If telemetry data is derived straight from this, this should be null.
+     */
+    public baseType: string;
+
+    /**
+     * Container for data item (B section).
+     */
+    public baseData: TDomain;
+
     /**
      * Constructs a new instance of telemetry data.
      */
     constructor(baseType: string, data: TDomain) {
-        super();
-
         this.baseType = baseType;
         this.baseData = data;
     }

package/src/Telemetry/Common/DataPoint.ts

@@ -1,11 +1,12 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-import { DataPoint as AIDataPoint } from "../../Interfaces/Contracts/Generated/DataPoint";
+import { IDataPoint } from "../../Interfaces/Contracts/IDataPoint";
 import { ISerializable } from "../../Interfaces/Telemetry/ISerializable";
 import { FieldType } from "../../Enums";
+import { DataPointType } from "../../Interfaces/Contracts/DataPointType";
 
-export class DataPoint extends AIDataPoint implements ISerializable {
+export class DataPoint implements IDataPoint, ISerializable {
 
     /**
      * The data contract for serializing this object.
@@ -19,4 +20,39 @@ export class DataPoint extends AIDataPoint implements ISerializable {
         max: FieldType.Default,
         stdDev: FieldType.Default
     }
+
+    /**
+     * Name of the metric.
+     */
+    public name: string;
+
+    /**
+     * Metric type. Single measurement or the aggregated value.
+     */
+    public kind: DataPointType = DataPointType.Measurement;
+ 
+    /**
+     * Single value for measurement. Sum of individual measurements for the aggregation.
+     */
+    public value: number;
+ 
+    /**
+     * Metric weight of the aggregated metric. Should not be set for a measurement.
+     */
+    public count: number;
+ 
+    /**
+     * Minimum value of the aggregated metric. Should not be set for a measurement.
+     */
+    public min: number;
+ 
+    /**
+     * Maximum value of the aggregated metric. Should not be set for a measurement.
+     */
+    public max: number;
+ 
+    /**
+     * Standard deviation of the aggregated metric. Should not be set for a measurement.
+     */
+    public stdDev: number;
 }

package/src/Telemetry/Common/DataSanitizer.ts

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-import { IDiagnosticLogger, eLoggingSeverity, _InternalMessageId, hasJSON, getJSON, objForEachKey, isObject, strTrim, _throwInternal } from "@microsoft/applicationinsights-core-js";
+import { IDiagnosticLogger, eLoggingSeverity, _eInternalMessageId, hasJSON, getJSON, objForEachKey, isObject, strTrim, _throwInternal } from "@microsoft/applicationinsights-core-js";
 
 export const enum DataSanitizerValues {
     /**
@@ -68,7 +68,7 @@ export function dataSanitizeKey(logger: IDiagnosticLogger, name: any) {
             nameTrunc = name.substring(0, DataSanitizerValues.MAX_NAME_LENGTH);
             _throwInternal(logger,
                 eLoggingSeverity.WARNING,
-                _InternalMessageId.NameTooLong,
+                _eInternalMessageId.NameTooLong,
                 "name is too long.  It has been truncated to " + DataSanitizerValues.MAX_NAME_LENGTH + " characters.",
                 { name }, true);
         }
@@ -86,7 +86,7 @@ export function dataSanitizeString(logger: IDiagnosticLogger, value: any, maxLen
             valueTrunc = value.toString().substring(0, maxLength);
             _throwInternal(logger,
                 eLoggingSeverity.WARNING,
-                _InternalMessageId.StringValueTooLong,
+                _eInternalMessageId.StringValueTooLong,
                 "string value is too long. It has been truncated to " + maxLength + " characters.",
                 { value }, true);
         }
@@ -96,7 +96,7 @@ export function dataSanitizeString(logger: IDiagnosticLogger, value: any, maxLen
 }
 
 export function dataSanitizeUrl(logger: IDiagnosticLogger, url: any) {
-    return dataSanitizeInput(logger, url, DataSanitizerValues.MAX_URL_LENGTH, _InternalMessageId.UrlTooLong);
+    return dataSanitizeInput(logger, url, DataSanitizerValues.MAX_URL_LENGTH, _eInternalMessageId.UrlTooLong);
 }
 
 export function dataSanitizeMessage(logger: IDiagnosticLogger, message: any) {
@@ -105,7 +105,7 @@ export function dataSanitizeMessage(logger: IDiagnosticLogger, message: any) {
         if (message.length > DataSanitizerValues.MAX_MESSAGE_LENGTH) {
             messageTrunc = message.substring(0, DataSanitizerValues.MAX_MESSAGE_LENGTH);
             _throwInternal(logger,
-                eLoggingSeverity.WARNING, _InternalMessageId.MessageTruncated,
+                eLoggingSeverity.WARNING, _eInternalMessageId.MessageTruncated,
                 "message is too long, it has been truncated to " + DataSanitizerValues.MAX_MESSAGE_LENGTH + " characters.",
                 { message },
                 true);
@@ -123,7 +123,7 @@ export function dataSanitizeException(logger: IDiagnosticLogger, exception: any)
         if (value.length > DataSanitizerValues.MAX_EXCEPTION_LENGTH) {
             exceptionTrunc = value.substring(0, DataSanitizerValues.MAX_EXCEPTION_LENGTH);
             _throwInternal(logger,
-                eLoggingSeverity.WARNING, _InternalMessageId.ExceptionTruncated, "exception is too long, it has been truncated to " + DataSanitizerValues.MAX_EXCEPTION_LENGTH + " characters.",
+                eLoggingSeverity.WARNING, _eInternalMessageId.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) {
-                    _throwInternal(logger,eLoggingSeverity.WARNING, _InternalMessageId.CannotSerializeObjectNonSerializable, "custom property is not valid", { exception: e}, true);
+                    _throwInternal(logger,eLoggingSeverity.WARNING, _eInternalMessageId.CannotSerializeObjectNonSerializable, "custom property is not valid", { exception: e}, true);
                 }
             }
             value = dataSanitizeString(logger, value, DataSanitizerValues.MAX_PROPERTY_LENGTH);
@@ -168,10 +168,10 @@ export function dataSanitizeMeasurements(logger: IDiagnosticLogger, measurements
 }
 
 export function dataSanitizeId(logger: IDiagnosticLogger, id: string): string {
-    return id ? dataSanitizeInput(logger, id, DataSanitizerValues.MAX_ID_LENGTH, _InternalMessageId.IdTooLong).toString() : id;
+    return id ? dataSanitizeInput(logger, id, DataSanitizerValues.MAX_ID_LENGTH, _eInternalMessageId.IdTooLong).toString() : id;
 }
 
-export function dataSanitizeInput(logger: IDiagnosticLogger, input: any, maxLength: number, _msgId: _InternalMessageId) {
+export function dataSanitizeInput(logger: IDiagnosticLogger, input: any, maxLength: number, _msgId: _eInternalMessageId) {
     let inputTrunc : String;
     if (input) {
         input = strTrim(input);
@@ -248,7 +248,7 @@ export interface IDataSanitizer {
  
     sanitizeId: (logger: IDiagnosticLogger, id: string) => string;
  
-    sanitizeInput: (logger: IDiagnosticLogger, input: any, maxLength: number, _msgId: _InternalMessageId) => any;
+    sanitizeInput: (logger: IDiagnosticLogger, input: any, maxLength: number, _msgId: _eInternalMessageId) => any;
 
     padNumber: (num: number) => string;
  

package/src/Telemetry/Common/Envelope.ts

@@ -1,15 +1,14 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-import { Envelope as AIEnvelope } from "../../Interfaces/Contracts/Generated/Envelope";
-import { Base } from "../../Interfaces/Contracts/Generated/Base";
+import { IBase } from "../../Interfaces/Contracts/IBase";
 import { IEnvelope } from "../../Interfaces/Telemetry/IEnvelope";
 import { dataSanitizeString } from "./DataSanitizer";
 import { FieldType } from "../../Enums";
 import { IDiagnosticLogger, toISOString } from "@microsoft/applicationinsights-core-js";
 import { strNotSpecified } from "../../Constants";
 
-export class Envelope extends AIEnvelope implements IEnvelope {
+export class Envelope implements IEnvelope {
 
     /**
      * The data contract for serializing this object.
@@ -17,16 +16,58 @@ export class Envelope extends AIEnvelope implements IEnvelope {
     public aiDataContract: any;
 
     /**
-     * Constructs a new instance of telemetry data.
+     * Envelope version. For internal use only. By assigning this the default, it will not be serialized within the payload unless changed to a value other than #1.
      */
-    constructor(logger: IDiagnosticLogger, data: Base, name: string) {
-        super();
+    public ver: number; /* 1 */
 
-        this.name = dataSanitizeString(logger, name) || strNotSpecified;
-        this.data = data;
-        this.time = toISOString(new Date());
+    /**
+     * Type name of telemetry data item.
+     */
+    public name: string;
+ 
+    /**
+     * Event date time when telemetry item was created. This is the wall clock time on the client when the event was generated. There is no guarantee that the client's time is accurate. This field must be formatted in UTC ISO 8601 format, with a trailing 'Z' character, as described publicly on https://en.wikipedia.org/wiki/ISO_8601#UTC. Note: the number of decimal seconds digits provided are variable (and unspecified). Consumers should handle this, i.e. managed code consumers should not use format 'O' for parsing as it specifies a fixed length. Example: 2009-06-15T13:45:30.0000000Z.
+     */
+    public time: string;
+ 
+    /**
+     * Sampling rate used in application. This telemetry item represents 1 / sampleRate actual telemetry items.
+     */
+    public sampleRate: number; /* 100.0 */
+ 
+    /**
+     * Sequence field used to track absolute order of uploaded events.
+     */
+    public seq: string;
+ 
+    /**
+     * The application's instrumentation key. The key is typically represented as a GUID, but there are cases when it is not a guid. No code should rely on iKey being a GUID. Instrumentation key is case insensitive.
+     */
+    public iKey: string;
+ 
+    /**
+     * Key/value collection of context properties. See ContextTagKeys for information on available properties.
+     */
+    public tags: any; /* {} */
+ 
+    /**
+     * Telemetry data item.
+     */
+    public data: IBase;
+ 
+    /**
+     * Constructs a new instance of telemetry data.
+     */
+    constructor(logger: IDiagnosticLogger, data: IBase, name: string) {
+        let _self = this;
+        _self.ver = 1;
+        _self.sampleRate = 100.0;
+        _self.tags = {};
+        _self.name = dataSanitizeString(logger, name) || strNotSpecified;
+        _self.data = data;
+        _self.time = toISOString(new Date());
 
-        this.aiDataContract = {
+        _self.aiDataContract = {
             time: FieldType.Required,
             iKey: FieldType.Required,
             name: FieldType.Required,

package/src/Telemetry/Event.ts

@@ -1,15 +1,14 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-import { IDiagnosticLogger } from "@microsoft/applicationinsights-core-js";
-import { EventData } from "../Interfaces/Contracts/Generated/EventData";
+import { IEventData } from "../Interfaces/Contracts/IEventData";
 import { ISerializable } from "../Interfaces/Telemetry/ISerializable";
 import { dataSanitizeString, dataSanitizeProperties, dataSanitizeMeasurements } from "./Common/DataSanitizer";
 import { FieldType } from "../Enums";
 import { strNotSpecified } from "../Constants";
+import { IDiagnosticLogger } from "@microsoft/applicationinsights-core-js";
 
-export class Event extends EventData implements ISerializable {
-
+export class Event implements IEventData, ISerializable {
     public static envelopeType = "Microsoft.ApplicationInsights.{0}.Event";
     public static dataType = "EventData";
 
@@ -18,17 +17,36 @@ export class Event extends EventData implements ISerializable {
         name: FieldType.Required,
         properties: FieldType.Default,
         measurements: FieldType.Default
-    }
+    };
 
     /**
-     * Constructs a new instance of the EventTelemetry object
+     * Schema version
      */
-    constructor(logger: IDiagnosticLogger, name: string, properties?: any, measurements?: any) {
+    public ver: number; /* 2 */
+
+    /**
+     * Event name. Keep it low cardinality to allow proper grouping and useful metrics.
+     */
+    public name: string;
 
-        super();
+    /**
+     * Collection of custom properties.
+     */
+    public properties: any; /* {} */
+
+    /**
+     * Collection of custom measurements.
+     */
+    public measurements: any; /* {} */
 
-        this.name = dataSanitizeString(logger, name) || strNotSpecified;
-        this.properties = dataSanitizeProperties(logger, properties);
-        this.measurements = dataSanitizeMeasurements(logger, measurements);
+    /**
+     * Constructs a new instance of the EventTelemetry object
+     */
+    constructor(logger: IDiagnosticLogger, name: string, properties?: any, measurements?: any) {
+        let _self = this;
+        _self.ver = 2;
+        _self.name = dataSanitizeString(logger, name) || strNotSpecified;
+        _self.properties = dataSanitizeProperties(logger, properties);
+        _self.measurements = dataSanitizeMeasurements(logger, measurements);
     }
-}
+}