@microsoft/applicationinsights-common 2.8.0-beta.2203-15 → 2.8.0-nightly.2204-04

package/src/Telemetry/PageViewPerformance.ts

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-import { PageViewPerfData } from "../Interfaces/Contracts/Generated/PageViewPerfData";
+import { IPageViewPerfData } from "../Interfaces/Contracts/IPageViewPerfData";
 import { FieldType } from "../Enums";
 import { ISerializable } from "../Interfaces/Telemetry/ISerializable";
 import { dataSanitizeMeasurements, dataSanitizeProperties, dataSanitizeString, dataSanitizeUrl } from "./Common/DataSanitizer";
@@ -10,7 +10,7 @@ import { IPageViewPerformanceTelemetry } from "../Interfaces/IPageViewPerformanc
 import { strNotSpecified } from "../Constants";
 
 
-export class PageViewPerformance extends PageViewPerfData implements ISerializable {
+export class PageViewPerformance implements IPageViewPerfData, ISerializable {
 
     public static envelopeType = "Microsoft.ApplicationInsights.{0}.PageviewPerformance";
     public static dataType = "PageviewPerformanceData";
@@ -29,24 +29,86 @@ export class PageViewPerformance extends PageViewPerfData implements ISerializab
         measurements: FieldType.Default
     };
 
+    /**
+     * Schema version
+     */
+    public ver: number; // = 2;
+
+    /**
+     * Event name. Keep it low cardinality to allow proper grouping and useful metrics.
+     */
+    public name: string;
+  
+    /**
+     * Collection of custom properties.
+     */
+    public properties: any; // = {};
+  
+    /**
+     * Collection of custom measurements.
+     */
+    public measurements: any; // = {};
+  
+    /**
+     * Request URL with all query string parameters
+     */
+    public url: string;
+ 
+    /**
+     * Request duration in format: DD.HH:MM:SS.MMMMMM. For a page view (PageViewData), this is the duration. For a page view with performance information (PageViewPerfData), this is the page load time. Must be less than 1000 days.
+     */
+    public duration: string;
+  
+    /**
+     * Identifier of a page view instance. Used for correlation between page view and other telemetry items.
+     */
+    public id: string;
+  
+    /**
+     * Performance total in TimeSpan 'G' (general long) format: d:hh:mm:ss.fffffff
+     */
+    public perfTotal: string;
+
+    /**
+     * Network connection time in TimeSpan 'G' (general long) format: d:hh:mm:ss.fffffff
+     */
+    public networkConnect: string;
+  
+    /**
+     * Sent request time in TimeSpan 'G' (general long) format: d:hh:mm:ss.fffffff
+     */
+    public sentRequest: string;
+  
+    /**
+     * Received response time in TimeSpan 'G' (general long) format: d:hh:mm:ss.fffffff
+     */
+    public receivedResponse: string;
+  
+    /**
+     * DOM processing time in TimeSpan 'G' (general long) format: d:hh:mm:ss.fffffff
+     */
+    public domProcessing: string;
+  
     /**
      * Constructs a new instance of the PageEventTelemetry object
      */
     constructor(logger: IDiagnosticLogger, name: string, url: string, unused: number, properties?: { [key: string]: string }, measurements?: { [key: string]: number }, cs4BaseData?: IPageViewPerformanceTelemetry) {
-        super();
-        this.url = dataSanitizeUrl(logger, url);
-        this.name = dataSanitizeString(logger, name) || strNotSpecified;
+        let _self = this;
+
+        _self.ver = 2;
+        _self.url = dataSanitizeUrl(logger, url);
+        _self.name = dataSanitizeString(logger, name) || strNotSpecified;
 
-        this.properties = dataSanitizeProperties(logger, properties);
-        this.measurements = dataSanitizeMeasurements(logger, measurements);
+        _self.properties = dataSanitizeProperties(logger, properties);
+        _self.measurements = dataSanitizeMeasurements(logger, measurements);
 
         if (cs4BaseData) {
-            this.domProcessing = cs4BaseData.domProcessing;
-            this.duration = cs4BaseData.duration;
-            this.networkConnect = cs4BaseData.networkConnect;
-            this.perfTotal = cs4BaseData.perfTotal;
-            this.receivedResponse = cs4BaseData.receivedResponse;
-            this.sentRequest = cs4BaseData.sentRequest;
+            _self.domProcessing = cs4BaseData.domProcessing;
+            _self.duration = cs4BaseData.duration;
+            _self.networkConnect = cs4BaseData.networkConnect;
+            _self.perfTotal = cs4BaseData.perfTotal;
+            _self.receivedResponse = cs4BaseData.receivedResponse;
+            _self.sentRequest = cs4BaseData.sentRequest;
         }
     }
 }

package/src/Telemetry/RemoteDependencyData.ts

@@ -5,11 +5,11 @@ import { dataSanitizeMeasurements, dataSanitizeProperties, dataSanitizeString, d
 import { FieldType } from "../Enums";
 import { ISerializable } from "../Interfaces/Telemetry/ISerializable";
 import { AjaxHelperParseDependencyPath} from "../Util";
-import { RemoteDependencyData as GeneratedRemoteDependencyData } from "../Interfaces/Contracts/Generated/RemoteDependencyData";
+import { IRemoteDependencyData } from "../Interfaces/Contracts/IRemoteDependencyData";
 import { IDiagnosticLogger } from "@microsoft/applicationinsights-core-js";
 import { msToTimeSpan } from "../HelperFuncs";
 
-export class RemoteDependencyData extends GeneratedRemoteDependencyData implements ISerializable {
+export class RemoteDependencyData implements IRemoteDependencyData, ISerializable {
 
     public static envelopeType = "Microsoft.ApplicationInsights.{0}.RemoteDependency";
     public static dataType = "RemoteDependencyData";
@@ -39,29 +39,84 @@ export class RemoteDependencyData extends GeneratedRemoteDependencyData implemen
         dependencyTypeName: FieldType.Default
     }
 
+    /**
+     * Schema version
+     */
+    public ver: number; // = 2;
+
+    /**
+     * Name of the command initiated with this dependency call. Low cardinality value. Examples are stored procedure name and URL path template.
+     */
+    public name: string;
+ 
+    /**
+     * Identifier of a dependency call instance. Used for correlation with the request telemetry item corresponding to this dependency call.
+     */
+    public id: string;
+ 
+    /**
+     * Result code of a dependency call. Examples are SQL error code and HTTP status code.
+     */
+    public resultCode: string;
+ 
+    /**
+     * Request duration in format: DD.HH:MM:SS.MMMMMM. Must be less than 1000 days.
+     */
+    public duration: string;
+ 
+    /**
+     * Indication of successful or unsuccessful call.
+     */
+    public success: boolean; /* true */
+ 
+    /**
+     * Command initiated by this dependency call. Examples are SQL statement and HTTP URL's with all query parameters.
+     */
+    public data: string;
+ 
+    /**
+     * Target site of a dependency call. Examples are server name, host address.
+     */
+    public 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.
+     */
+    public type: string;
+ 
+    /**
+     * Collection of custom properties.
+     */
+    public properties: any; // = {};
+ 
+    /**
+     * Collection of custom measurements.
+     */
+    public measurements: any; // = {};
+ 
     /**
      * Constructs a new instance of the RemoteDependencyData object
      */
     constructor(logger: IDiagnosticLogger, id: string, absoluteUrl: string, commandName: string, value: number, success: boolean, resultCode: number, method?: string, requestAPI: string = "Ajax", correlationContext?: string, properties?: Object, measurements?: Object) {
-        super();
-
-        this.id = id;
+        let _self = this;
 
-        this.duration = msToTimeSpan(value);
-        this.success = success;
-        this.resultCode = resultCode + "";
+        _self.ver = 2;
+        _self.id = id;
+        _self.duration = msToTimeSpan(value);
+        _self.success = success;
+        _self.resultCode = resultCode + "";
 
-        this.type = dataSanitizeString(logger, requestAPI);
+        _self.type = dataSanitizeString(logger, requestAPI);
 
         const dependencyFields = AjaxHelperParseDependencyPath(logger, absoluteUrl, method, commandName);
-        this.data = dataSanitizeUrl(logger, commandName) || dependencyFields.data; // get a value from hosturl if commandName not available
-        this.target = dataSanitizeString(logger, dependencyFields.target);
+        _self.data = dataSanitizeUrl(logger, commandName) || dependencyFields.data; // get a value from hosturl if commandName not available
+        _self.target = dataSanitizeString(logger, dependencyFields.target);
         if (correlationContext) {
-            this.target = `${this.target} | ${correlationContext}`;
+            _self.target = `${_self.target} | ${correlationContext}`;
         }
-        this.name = dataSanitizeString(logger, dependencyFields.name);
+        _self.name = dataSanitizeString(logger, dependencyFields.name);
 
-        this.properties = dataSanitizeProperties(logger, properties);
-        this.measurements = dataSanitizeMeasurements(logger, measurements);
+        _self.properties = dataSanitizeProperties(logger, properties);
+        _self.measurements = dataSanitizeMeasurements(logger, measurements);
     }
 }

package/src/Telemetry/Trace.ts

@@ -1,15 +1,15 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-import { MessageData } from "../Interfaces/Contracts/Generated/MessageData";
+import { IMessageData } from "../Interfaces/Contracts/IMessageData";
 import { ISerializable } from "../Interfaces/Telemetry/ISerializable";
 import { dataSanitizeMessage, dataSanitizeProperties, dataSanitizeMeasurements } from "./Common/DataSanitizer";
 import { FieldType } from "../Enums";
-import { SeverityLevel } from "../Interfaces/Contracts/Generated/SeverityLevel";
+import { SeverityLevel } from "../Interfaces/Contracts/SeverityLevel";
 import { IDiagnosticLogger } from "@microsoft/applicationinsights-core-js";
 import { strNotSpecified } from "../Constants";
 
-export class Trace extends MessageData implements ISerializable {
+export class Trace implements IMessageData, ISerializable {
 
     public static envelopeType = "Microsoft.ApplicationInsights.{0}.Message";
     public static dataType = "MessageData";
@@ -21,18 +21,44 @@ export class Trace extends MessageData implements ISerializable {
         properties: FieldType.Default
     };
 
+    /**
+     * Schema version
+     */
+    public ver: number; // = 2;
+
+    /**
+     * Trace message
+     */
+    public message: string;
+ 
+    /**
+     * Trace severity level.
+     */
+    public severityLevel: SeverityLevel;
+ 
+    /**
+     * Collection of custom properties.
+     */
+    public properties: any;
+ 
+    /**
+     * Collection of custom measurements.
+     */
+    public measurements: any;
+ 
     /**
      * Constructs a new instance of the TraceTelemetry object
      */
     constructor(logger: IDiagnosticLogger, message: string, severityLevel?: SeverityLevel, properties?: any, measurements?: { [key: string]: number }) {
-        super();
+        let _self = this;
+        _self.ver = 2;
         message = message || strNotSpecified;
-        this.message = dataSanitizeMessage(logger, message);
-        this.properties = dataSanitizeProperties(logger, properties);
-        this.measurements = dataSanitizeMeasurements(logger, measurements);
+        _self.message = dataSanitizeMessage(logger, message);
+        _self.properties = dataSanitizeProperties(logger, properties);
+        _self.measurements = dataSanitizeMeasurements(logger, measurements);
 
         if (severityLevel) {
-            this.severityLevel = severityLevel;
+            _self.severityLevel = severityLevel;
         }
     }
 }

package/src/applicationinsights-common.ts

@@ -9,8 +9,8 @@ export { parseConnectionString, ConnectionStringParser } from "./ConnectionStrin
 export { FieldType } from "./Enums";
 export { IRequestHeaders, RequestHeaders } from "./RequestResponseHeaders";
 export { DisabledPropertyName, ProcessLegacy, SampleRate, HttpMethod, DEFAULT_BREEZE_ENDPOINT, strNotSpecified } from "./Constants";
-export { Data as AIData } from "./Interfaces/Contracts/Generated/Data";
-export { Base as AIBase } from "./Interfaces/Contracts/Generated/Base";
+export { IData as AIData } from "./Interfaces/Contracts/IData";
+export { IBase as AIBase } from "./Interfaces/Contracts/IBase";
 export { ISerializable } from "./Interfaces/Telemetry/ISerializable";
 export { IEnvelope } from "./Interfaces/Telemetry/IEnvelope";
 export { Envelope } from "./Telemetry/Common/Envelope";
@@ -18,7 +18,7 @@ export { Event } from "./Telemetry/Event";
 export { Exception } from "./Telemetry/Exception";
 export { Metric } from "./Telemetry/Metric";
 export { PageView } from "./Telemetry/PageView";
-export { PageViewData } from "./Interfaces/Contracts/Generated/PageViewData";
+export { IPageViewData } from "./Interfaces/Contracts/IPageViewData";
 export { RemoteDependencyData } from "./Telemetry/RemoteDependencyData";
 export { IEventTelemetry } from "./Interfaces/IEventTelemetry";
 export { ITraceTelemetry } from "./Interfaces/ITraceTelemetry";
@@ -30,10 +30,10 @@ export { IPageViewPerformanceTelemetry, IPageViewPerformanceTelemetryInternal }
 export { Trace } from "./Telemetry/Trace";
 export { PageViewPerformance } from "./Telemetry/PageViewPerformance";
 export { Data } from "./Telemetry/Common/Data";
-export { SeverityLevel } from "./Interfaces/Contracts/Generated/SeverityLevel";
+export { SeverityLevel } from "./Interfaces/Contracts/SeverityLevel";
 export { IConfig, ConfigurationManager } from "./Interfaces/IConfig";
 export { IChannelControlsAI } from "./Interfaces/IChannelControlsAI";
-export { IContextTagKeys, ContextTagKeys } from "./Interfaces/Contracts/Generated/ContextTagKeys";
+export { IContextTagKeys, ContextTagKeys } from "./Interfaces/Contracts/ContextTagKeys";
 export {
     DataSanitizerValues, IDataSanitizer, DataSanitizer,
     dataSanitizeKeyAndAddUniqueness, dataSanitizeKey, dataSanitizeString, dataSanitizeUrl, dataSanitizeMessage,

package/types/Interfaces/IExceptionTelemetry.d.ts

@@ -1,4 +1,4 @@
-import { SeverityLevel } from "./Contracts/Generated/SeverityLevel";
+import { SeverityLevel } from "./Contracts/SeverityLevel";
 import { IPartC } from "./IPartC";
 /**
  * @export

package/types/Interfaces/ITraceTelemetry.d.ts

@@ -1,4 +1,4 @@
-import { SeverityLevel } from "./Contracts/Generated/SeverityLevel";
+import { SeverityLevel } from "./Contracts/SeverityLevel";
 import { IPartC } from "./IPartC";
 export interface ITraceTelemetry extends IPartC {
     /**

package/types/Interfaces/PartAExtensions.d.ts

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

package/types/Interfaces/Telemetry/IEnvelope.d.ts

@@ -1,13 +1,37 @@
 import { ISerializable } from "./ISerializable";
 export interface IEnvelope extends ISerializable {
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * Sampling rate used in application. This telemetry item represents 1 / sampleRate actual telemetry items.
+     */
     sampleRate: number;
+    /**
+     * 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;
+    /**
+     * Key/value collection of context properties. See ContextTagKeys for information on available properties.
+     */
     tags: {
         [name: string]: any;
     };
+    /**
+     * Telemetry data item.
+     */
     data: any;
 }

package/types/Telemetry/Common/Data.d.ts

@@ -1,7 +1,7 @@
-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 declare class Data<TDomain> extends AIData<TDomain> implements ISerializable {
+export declare class Data<TDomain> implements IData<TDomain>, ISerializable {
     /**
      * The data contract for serializing this object.
      */
@@ -9,6 +9,14 @@ export declare class Data<TDomain> extends AIData<TDomain> implements ISerializa
         baseType: FieldType;
         baseData: FieldType;
     };
+    /**
+     * Name of item (B section) if any. If telemetry data is derived straight from this, this should be null.
+     */
+    baseType: string;
+    /**
+     * Container for data item (B section).
+     */
+    baseData: TDomain;
     /**
      * Constructs a new instance of telemetry data.
      */

package/types/Telemetry/Common/DataPoint.d.ts

@@ -1,7 +1,8 @@
-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";
-export declare class DataPoint extends AIDataPoint implements ISerializable {
+import { DataPointType } from "../../Interfaces/Contracts/DataPointType";
+export declare class DataPoint implements IDataPoint, ISerializable {
     /**
      * The data contract for serializing this object.
      */
@@ -14,4 +15,32 @@ export declare class DataPoint extends AIDataPoint implements ISerializable {
         max: FieldType;
         stdDev: FieldType;
     };
+    /**
+     * Name of the metric.
+     */
+    name: string;
+    /**
+     * Metric type. Single measurement or the aggregated value.
+     */
+    kind: DataPointType;
+    /**
+     * Single value for measurement. Sum of individual measurements for the aggregation.
+     */
+    value: number;
+    /**
+     * Metric weight of the aggregated metric. Should not be set for a measurement.
+     */
+    count: number;
+    /**
+     * Minimum value of the aggregated metric. Should not be set for a measurement.
+     */
+    min: number;
+    /**
+     * Maximum value of the aggregated metric. Should not be set for a measurement.
+     */
+    max: number;
+    /**
+     * Standard deviation of the aggregated metric. Should not be set for a measurement.
+     */
+    stdDev: number;
 }

package/types/Telemetry/Common/Envelope.d.ts

@@ -1,14 +1,45 @@
-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 { IDiagnosticLogger } from "@microsoft/applicationinsights-core-js";
-export declare class Envelope extends AIEnvelope implements IEnvelope {
+export declare class Envelope implements IEnvelope {
     /**
      * The data contract for serializing this object.
      */
     aiDataContract: any;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * Sampling rate used in application. This telemetry item represents 1 / sampleRate actual telemetry items.
+     */
+    sampleRate: number;
+    /**
+     * 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;
+    /**
+     * Key/value collection of context properties. See ContextTagKeys for information on available properties.
+     */
+    tags: any;
+    /**
+     * Telemetry data item.
+     */
+    data: IBase;
     /**
      * Constructs a new instance of telemetry data.
      */
-    constructor(logger: IDiagnosticLogger, data: Base, name: string);
+    constructor(logger: IDiagnosticLogger, data: IBase, name: string);
 }

package/types/Telemetry/Event.d.ts

@@ -1,8 +1,8 @@
-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 { FieldType } from "../Enums";
-export declare class Event extends EventData implements ISerializable {
+import { IDiagnosticLogger } from "@microsoft/applicationinsights-core-js";
+export declare class Event implements IEventData, ISerializable {
     static envelopeType: string;
     static dataType: string;
     aiDataContract: {
@@ -11,6 +11,22 @@ export declare class Event extends EventData implements ISerializable {
         properties: FieldType;
         measurements: FieldType;
     };
+    /**
+     * Schema version
+     */
+    ver: number;
+    /**
+     * Event name. Keep it low cardinality to allow proper grouping and useful metrics.
+     */
+    name: string;
+    /**
+     * Collection of custom properties.
+     */
+    properties: any;
+    /**
+     * Collection of custom measurements.
+     */
+    measurements: any;
     /**
      * Constructs a new instance of the EventTelemetry object
      */