@microsoft/applicationinsights-common 3.0.0-beta.2303-11 → 3.0.0-nightly3.2304-28

package/src/Interfaces/IMetricTelemetry.ts

@@ -1,56 +0,0 @@
-import { IPartC } from "./IPartC";
-
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-export interface IMetricTelemetry extends IPartC {
-    /**
-     * @description (required) - name of this metric
-     * @type {string}
-     * @memberof IMetricTelemetry
-     */
-    name: string;
-
-    /**
-     * @description (required) - Recorded value/average for this metric
-     * @type {number}
-     * @memberof IMetricTelemetry
-     */
-    average: number;
-
-    /**
-     * @description (optional) Number of samples represented by the average.
-     * @type {number=}
-     * @memberof IMetricTelemetry
-     * @default sampleCount=1
-     */
-    sampleCount?: number;
-
-    /**
-     * @description (optional) The smallest measurement in the sample. Defaults to the average
-     * @type {number}
-     * @memberof IMetricTelemetry
-     * @default min=average
-     */
-    min?: number;
-
-    /**
-     * @description (optional) The largest measurement in the sample. Defaults to the average.
-     * @type {number}
-     * @memberof IMetricTelemetry
-     * @default max=average
-     */
-    max?: number;
-
-    /**
-     * (optional) The standard deviation measurement in the sample, Defaults to undefined which results in zero.
-     */
-    stdDev?: number;
-
-     /**
-     * @description custom defined iKey
-     * @type {string}
-     * @memberof IMetricTelemetry
-     */
-    iKey?: string;
-}

package/src/Interfaces/IPageViewPerformanceTelemetry.ts

@@ -1,61 +0,0 @@
-import { IPartC } from "./IPartC";
-
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-export interface IPageViewPerformanceTelemetry extends IPartC {
-    /**
-     * name String - The name of the page. Defaults to the document title.
-     */
-    name?: string;
-
-    /**
-     * url String - a relative or absolute URL that identifies the page or other item. Defaults to the window location.
-     */
-    uri?: string;
-    /**
-     * Performance total in TimeSpan 'G' (general long) format: d:hh:mm:ss.fffffff". This is total duration in timespan format.
-     */
-    perfTotal?: string;
-    /**
-     * Performance total in TimeSpan 'G' (general long) format: d:hh:mm:ss.fffffff". This represents the total page load time.
-     */
-    duration?: string;
-    /**
-     * Sent request 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;
-}
-
-export interface IPageViewPerformanceTelemetryInternal extends IPageViewPerformanceTelemetry {
-    /**
-     * An identifier assigned to each distinct impression for the purposes of correlating with pageview.
-     * A new id is automatically generated on each pageview. You can manually specify this field if you
-     * want to use a specific value instead.
-     */
-    id?: string;
-    /**
-     * Version of the part B schema, todo: set this value in trackpageView
-     */
-    ver?: string;
-    /**
-     * Field indicating whether this instance of PageViewPerformance is valid and should be sent
-     */
-    isValid?: boolean;
-    /**
-     * Duration in miliseconds
-     */
-    durationMs?: number;
-}

package/src/Interfaces/IPageViewTelemetry.ts

@@ -1,65 +0,0 @@
-import { IPartC } from "./IPartC";
-
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-/**
- * Pageview telemetry interface
- */
-export interface IPageViewTelemetry extends IPartC {
-    /**
-     * name String - The string you used as the name in startTrackPage. Defaults to the document title.
-     */
-    name?: string;
-
-    /**
-     * uri  String - a relative or absolute URL that identifies the page or other item. Defaults to the window location.
-     */
-    uri?: string;
-
-    /**
-     * refUri  String - the URL of the source page where current page is loaded from
-     */
-    refUri?: string;
-
-    /**
-     * pageType  String - page type
-     */
-    pageType?: string;
-
-    /**
-     * isLoggedIn - boolean is user logged in
-     */
-    isLoggedIn?: boolean;
-
-    /**
-     * Property bag to contain additional custom properties (Part C)
-     */
-    properties?: {
-        /**
-         * The number of milliseconds it took to load the page. Defaults to undefined. If set to default value, page load time is calculated internally.
-         */
-        duration?: number;
-        [key: string]: any;
-    };
-
-     /**
-     * iKey String - custom defined iKey.
-     */
-      iKey?: string;
-}
-
-
-export interface IPageViewTelemetryInternal extends IPageViewTelemetry {
-    /**
-     * An identifier assigned to each distinct impression for the purposes of correlating with pageview.
-     * A new id is automatically generated on each pageview. You can manually specify this field if you
-     * want to use a specific value instead.
-     */
-    id?: string;
-
-    /**
-     * Version of the part B schema, todo: set this value in trackpageView
-     */
-    ver?: string;
-}

package/src/Interfaces/IPartC.ts

@@ -1,18 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-/**
- * PartC  telemetry interface
- */
-export interface IPartC {
-    /**
-     * Property bag to contain additional custom properties (Part C)
-     */
-    properties?: { [key: string]: any };
-
-    /**
-     * Property bag to contain additional custom measurements (Part C)
-     * @deprecated -- please use properties instead
-     */
-    measurements?: { [key: string]: number };
-}

package/src/Interfaces/IPropertiesPlugin.ts

@@ -1,8 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-import { ITelemetryContext } from "./ITelemetryContext";
-
-export interface IPropertiesPlugin {
-    readonly context: ITelemetryContext;
-}

package/src/Interfaces/IRequestContext.ts

@@ -1,6 +0,0 @@
-export interface IRequestContext {
-    status?: number;
-    xhr?: XMLHttpRequest;
-    request?: Request; // fetch request
-    response?: Response | string; // fetch response
-}

package/src/Interfaces/ITelemetryContext.ts

@@ -1,69 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-import { IApplication } from "./Context/IApplication";
-import { IDevice } from "./Context/IDevice";
-import { IInternal } from "./Context/IInternal";
-import { ILocation } from "./Context/ILocation";
-import { IUserContext } from "./Context/IUser";
-import { ISession } from "./Context/ISession";
-import { ITelemetryTrace } from "./Context/ITelemetryTrace";
-import { IOperatingSystem } from "./Context/IOperatingSystem";
-import { IWeb } from "./Context/IWeb";
-
-export interface ITelemetryContext {
-    /**
-     * The object describing a component tracked by this object.
-     */
-    readonly application: IApplication;
-
-    /**
-     * The object describing a device tracked by this object.
-     */
-    readonly device: IDevice;
-
-    /**
-     * The object describing internal settings.
-     */
-    readonly internal: IInternal;
-
-    /**
-     * The object describing a location tracked by this object.
-     */
-    readonly location: ILocation;
-
-    /**
-     * The object describing a operation tracked by this object.
-     */
-    readonly telemetryTrace: ITelemetryTrace;
-
-    /**
-     * The object describing a user tracked by this object.
-     */
-    readonly user: IUserContext;
-
-    /**
-     * The object describing a session tracked by this object.
-     */
-    readonly session: ISession;
-
-    /**
-     * The object describing os details tracked by this object.
-     */
-    readonly os?: IOperatingSystem;
-
-    /**
-     * The object describing we details tracked by this object.
-     */
-    readonly web?: IWeb;
-
-    /**
-     * application id obtained from breeze responses. Is used if appId is not specified by root config
-     */
-    appId: () => string;
-
-    /**
-     * session id obtained from session manager.
-     */
-    getSessionId: () => string;
-}

package/src/Interfaces/IThrottleMgr.ts

@@ -1,111 +0,0 @@
-import { IThrottleMsgKey } from "../Enums";
-
-/**
- * Identifies limit number/percentage of items sent per time
- * If both are provided, minimum number between the two will be used
- */
-export interface IThrottleLimit {
-    /**
-     * Identifies sampling percentage of items per time
-     * The percentage is set to 4 decimal places, for example: 1 means 0.0001%
-     * Default: 100 (0.01%)
-     */
-    samplingRate?: number;
-
-    /**
-     * Identifies limit number of items per time
-     * Default: 1
-     */
-    maxSendNumber?: number;
-}
-
-/**
- * Identifies frequency of items sent
- * Default: send data on 28th every 3 month each year
- */
-export interface IThrottleInterval {
-    /**
-     * Identifies month interval that items can be sent
-     * For example, if it is set to 2 and start date is in Jan, items will be sent out every two months (Jan, March, May etc.)
-     * If both monthInterval and dayInterval are undefined, it will be set to 3
-     */
-    monthInterval?: number;
-
-    /**
-     * Identifies days Interval from start date that items can be sent
-     * Default: undefined
-     */
-    dayInterval?: number;
-
-    /**
-     * Identifies days within each month that items can be sent
-     * If both monthInterval and dayInterval are undefined, it will be default to [28]
-     */
-    daysOfMonth?: number[];
-}
-
-/**
-* Identifies basic config
-*/
-export interface IThrottleMgrConfig {
-    /**
-    * Identifies message key to be used for local storage key
-    * Default: IThrottleMsgKey.default
-    */
-    msgKey?: IThrottleMsgKey;
-
-    /**
-    * Identifies if throttle is disabled
-    * Default: false
-    */
-    disabled?: boolean;
-
-    /**
-    * Identifies limit number/percentage of items sent per time
-    * Default: sampling percentage 0.01% with one item sent per time
-    */
-    limit?: IThrottleLimit;
-
-    /**
-    * Identifies frequency of items sent
-    * Default: send data on 28th every 3 month each year
-    */
-    interval?: IThrottleInterval;
-}
-
-/**
-* Identifies object for local storage
-*/
-export interface IThrottleLocalStorageObj {
-    /**
-    * Identifies start date
-    */
-    date: Date;
-
-    /**
-    * Identifies current count
-    */
-
-    count: number;
-
-    /**
-     * identifies previous triggered throttle date
-     */
-    preTriggerDate?: Date;
-}
-
-/**
-* Identifies throttle result
-*/
-export interface IThrottleResult {
-    /**
-    * Identifies if items are sent
-    */
-    isThrottled: boolean;
-
-    /**
-    * Identifies numbers of items are sent
-    * if isThrottled is false, it will be set to 0
-    */
-    throttleNum: number;
-}

package/src/Interfaces/ITraceTelemetry.ts

@@ -1,28 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-import { SeverityLevel } from "./Contracts/SeverityLevel"
-import { IPartC } from "./IPartC";
-
-export interface ITraceTelemetry extends IPartC {
-    /**
-     * @description A message string
-     * @type {string}
-     * @memberof ITraceTelemetry
-     */
-    message: string;
-
-    /**
-     * @description Severity level of the logging message used for filtering in the portal
-     * @type {SeverityLevel}
-     * @memberof ITraceTelemetry
-     */
-    severityLevel?: SeverityLevel;
-
-    /**
-     * @description custom defiend iKey
-     * @type {SeverityLevel}
-     * @memberof ITraceTelemetry
-     */
-    iKey?: string;
-}

package/src/Interfaces/PartAExtensions.ts

@@ -1,14 +0,0 @@
-import { ContextTagKeys } from "./Contracts/ContextTagKeys";
-
-export const Extensions = {
-    UserExt: "user",
-    DeviceExt: "device",
-    TraceExt: "trace",
-    WebExt: "web",
-    AppExt: "app",
-    OSExt: "os",
-    SessionExt: "ses",
-    SDKExt: "sdk"
-};
-
-export let CtxTagKeys = new ContextTagKeys();

package/src/Interfaces/Telemetry/IEnvelope.ts

@@ -1,47 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-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; /* 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;
- 
-    /**
-     * 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;
- 
-    /**
-     * Key/value collection of context properties. See ContextTagKeys for information on available properties.
-     */
-    tags: { [name: string]: any };  /* {} */
- 
-    /**
-     * Telemetry data item.
-     */
-    data: any;
-}

package/src/Interfaces/Telemetry/ISerializable.ts

@@ -1,11 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-export interface ISerializable {
-    /**
-     * The set of fields for a serializable object.
-     * This defines the serialization order and a value of true/false
-     * for each field defines whether the field is required or not.
-     */
-    aiDataContract: any;
-}

package/src/RequestResponseHeaders.ts

@@ -1,96 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-import { createValueMap } from "@microsoft/applicationinsights-core-js";
-
-export interface IRequestHeaders {
-    /**
-     * Request-Context header
-     */
-    requestContextHeader: string,
-
-    /**
-     * Target instrumentation header that is added to the response and retrieved by the
-     * calling application when processing incoming responses.
-     */
-    requestContextTargetKey: string,
-
-    /**
-     * Request-Context appId format
-     */
-    requestContextAppIdFormat: string,
-
-    /**
-     * Request-Id header
-     */
-    requestIdHeader: string,
-
-    /**
-     * W3C distributed tracing protocol header
-     */
-    traceParentHeader: string,
-
-    /**
-     * W3C distributed tracing protocol state header
-     */
-    traceStateHeader: string,     // currently not used
-
-    /**
-     * Sdk-Context header
-     * If this header passed with appId in content then appId will be returned back by the backend.
-     */
-    sdkContextHeader: string,
-
-    /**
-     * String to pass in header for requesting appId back from the backend.
-     */
-    sdkContextHeaderAppIdRequest: string,
-
-    requestContextHeaderLowerCase: string
-}
-
-export const enum eRequestHeaders {
-    requestContextHeader = 0,
-    requestContextTargetKey = 1,
-    requestContextAppIdFormat = 2,
-    requestIdHeader = 3,
-    traceParentHeader = 4,
-    traceStateHeader = 5,     // currently not used
-    sdkContextHeader = 6,
-    sdkContextHeaderAppIdRequest = 7,
-    requestContextHeaderLowerCase = 8
-}
-
-export const RequestHeaders = createValueMap<typeof eRequestHeaders, IRequestHeaders & {
-    // Defined the enum lookups
-    [eRequestHeaders.requestContextHeader]: "Request-Context",
-    [eRequestHeaders.requestContextTargetKey]: "appId",
-    [eRequestHeaders.requestContextAppIdFormat]: "appId=cid-v1:",
-    [eRequestHeaders.requestIdHeader]: "Request-Id",
-    [eRequestHeaders.traceParentHeader]: "traceparent",
-    [eRequestHeaders.traceStateHeader]: "tracestate",     // currently not used
-    [eRequestHeaders.sdkContextHeader]: "Sdk-Context",
-    [eRequestHeaders.sdkContextHeaderAppIdRequest]: "appId",
-    [eRequestHeaders.requestContextHeaderLowerCase]: "request-context",
-    // Defined Named reference
-    requestContextHeader: "Request-Context",
-    requestContextTargetKey: "appId",
-    requestContextAppIdFormat: "appId=cid-v1:",
-    requestIdHeader: "Request-Id",
-    traceParentHeader: "traceparent",
-    traceStateHeader: "tracestate",     // currently not used
-    sdkContextHeader: "Sdk-Context",
-    sdkContextHeaderAppIdRequest: "appId",
-    requestContextHeaderLowerCase: "request-context"
-}>({
-    requestContextHeader: [ eRequestHeaders.requestContextHeader, "Request-Context" ],
-    requestContextTargetKey: [ eRequestHeaders.requestContextTargetKey, "appId"],
-    requestContextAppIdFormat: [ eRequestHeaders.requestContextAppIdFormat, "appId=cid-v1:"],
-    requestIdHeader: [ eRequestHeaders.requestIdHeader, "Request-Id"],
-    traceParentHeader: [ eRequestHeaders.traceParentHeader, "traceparent"],
-    traceStateHeader: [ eRequestHeaders.traceStateHeader, "tracestate"],     // currently not used
-    sdkContextHeader: [ eRequestHeaders.sdkContextHeader, "Sdk-Context"],
-    sdkContextHeaderAppIdRequest: [ eRequestHeaders.sdkContextHeaderAppIdRequest, "appId"],
-    requestContextHeaderLowerCase: [ eRequestHeaders.requestContextHeaderLowerCase, "request-context"]
-});
-