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

package/types/Interfaces/IPartC.d.ts

@@ -1,18 +0,0 @@
-/**
- * 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/types/Interfaces/IPropertiesPlugin.d.ts

@@ -1,4 +0,0 @@
-import { ITelemetryContext } from "./ITelemetryContext";
-export interface IPropertiesPlugin {
-    readonly context: ITelemetryContext;
-}

package/types/Interfaces/IRequestContext.d.ts

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

package/types/Interfaces/ITelemetryContext.d.ts

@@ -1,55 +0,0 @@
-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/types/Interfaces/IThrottleMgr.d.ts

@@ -1,96 +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/types/Interfaces/ITraceTelemetry.d.ts

@@ -1,22 +0,0 @@
-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/types/Interfaces/PartAExtensions.d.ts

@@ -1,12 +0,0 @@
-import { ContextTagKeys } from "./Contracts/ContextTagKeys";
-export declare const Extensions: {
-    UserExt: string;
-    DeviceExt: string;
-    TraceExt: string;
-    WebExt: string;
-    AppExt: string;
-    OSExt: string;
-    SessionExt: string;
-    SDKExt: string;
-};
-export declare let CtxTagKeys: ContextTagKeys;

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

@@ -1,37 +0,0 @@
-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/Interfaces/Telemetry/ISerializable.d.ts

@@ -1,8 +0,0 @@
-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/types/RequestResponseHeaders.d.ts

@@ -1,68 +0,0 @@
-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;
-    /**
-     * 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 declare const enum eRequestHeaders {
-    requestContextHeader = 0,
-    requestContextTargetKey = 1,
-    requestContextAppIdFormat = 2,
-    requestIdHeader = 3,
-    traceParentHeader = 4,
-    traceStateHeader = 5,
-    sdkContextHeader = 6,
-    sdkContextHeaderAppIdRequest = 7,
-    requestContextHeaderLowerCase = 8
-}
-export declare const RequestHeaders: IRequestHeaders & {
-    requestContextHeader: "Request-Context";
-    requestContextTargetKey: "appId";
-    requestContextAppIdFormat: "appId=cid-v1:";
-    requestIdHeader: "Request-Id";
-    traceParentHeader: "traceparent";
-    traceStateHeader: "tracestate";
-    sdkContextHeader: "Sdk-Context";
-    sdkContextHeaderAppIdRequest: "appId";
-    requestContextHeaderLowerCase: "request-context";
-    0: "Request-Context";
-    1: "appId";
-    2: "appId=cid-v1:";
-    3: "Request-Id";
-    4: "traceparent";
-    5: "tracestate";
-    6: "Sdk-Context";
-    7: "appId";
-    8: "request-context";
-};

package/types/StorageHelperFuncs.d.ts

@@ -1,23 +0,0 @@
-import { IDiagnosticLogger } from "@microsoft/applicationinsights-core-js";
-/**
- * Disables the global SDK usage of local or session storage if available
- */
-export declare function utlDisableStorage(): void;
-/**
- * Re-enables the global SDK usage of local or session storage if available
- */
-export declare function utlEnableStorage(): void;
-/**
- * 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 declare function utlCanUseLocalStorage(reset?: boolean): boolean;
-export declare function utlGetLocalStorage(logger: IDiagnosticLogger, name: string): string;
-export declare function utlSetLocalStorage(logger: IDiagnosticLogger, name: string, data: string): boolean;
-export declare function utlRemoveStorage(logger: IDiagnosticLogger, name: string): boolean;
-export declare function utlCanUseSessionStorage(reset?: boolean): boolean;
-export declare function utlGetSessionStorageKeys(): string[];
-export declare function utlGetSessionStorage(logger: IDiagnosticLogger, name: string): string;
-export declare function utlSetSessionStorage(logger: IDiagnosticLogger, name: string, data: string): boolean;
-export declare function utlRemoveSessionStorage(logger: IDiagnosticLogger, name: string): boolean;

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

@@ -1,24 +0,0 @@
-import { IData } from "../../Interfaces/Contracts/IData";
-import { ISerializable } from "../../Interfaces/Telemetry/ISerializable";
-import { FieldType } from "../../Enums";
-export declare class Data<TDomain> implements IData<TDomain>, ISerializable {
-    /**
-     * The data contract for serializing this object.
-     */
-    aiDataContract: {
-        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.
-     */
-    constructor(baseType: string, data: TDomain);
-}

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

@@ -1,46 +0,0 @@
-import { FieldType } from "../../Enums";
-import { DataPointType } from "../../Interfaces/Contracts/DataPointType";
-import { IDataPoint } from "../../Interfaces/Contracts/IDataPoint";
-import { ISerializable } from "../../Interfaces/Telemetry/ISerializable";
-export declare class DataPoint implements IDataPoint, ISerializable {
-    /**
-     * The data contract for serializing this object.
-     */
-    aiDataContract: {
-        name: FieldType;
-        kind: FieldType;
-        value: FieldType;
-        count: FieldType;
-        min: FieldType;
-        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/DataSanitizer.d.ts

@@ -1,42 +0,0 @@
-import { IDiagnosticLogger, _eInternalMessageId } from "@microsoft/applicationinsights-core-js";
-export declare const enum DataSanitizerValues {
-    /**
-     * Max length allowed for custom names.
-     */
-    MAX_NAME_LENGTH = 150,
-    /**
-     * Max length allowed for Id field in page views.
-     */
-    MAX_ID_LENGTH = 128,
-    /**
-     * Max length allowed for custom values.
-     */
-    MAX_PROPERTY_LENGTH = 8192,
-    /**
-     * Max length allowed for names
-     */
-    MAX_STRING_LENGTH = 1024,
-    /**
-     * Max length allowed for url.
-     */
-    MAX_URL_LENGTH = 2048,
-    /**
-     * Max length allowed for messages.
-     */
-    MAX_MESSAGE_LENGTH = 32768,
-    /**
-     * Max length allowed for exceptions.
-     */
-    MAX_EXCEPTION_LENGTH = 32768
-}
-export declare function dataSanitizeKeyAndAddUniqueness(logger: IDiagnosticLogger, key: any, map: any): any;
-export declare function dataSanitizeKey(logger: IDiagnosticLogger, name: any): any;
-export declare function dataSanitizeString(logger: IDiagnosticLogger, value: any, maxLength?: number): any;
-export declare function dataSanitizeUrl(logger: IDiagnosticLogger, url: any): any;
-export declare function dataSanitizeMessage(logger: IDiagnosticLogger, message: any): any;
-export declare function dataSanitizeException(logger: IDiagnosticLogger, exception: any): any;
-export declare function dataSanitizeProperties(logger: IDiagnosticLogger, properties: any): any;
-export declare function dataSanitizeMeasurements(logger: IDiagnosticLogger, measurements: any): any;
-export declare function dataSanitizeId(logger: IDiagnosticLogger, id: string): string;
-export declare function dataSanitizeInput(logger: IDiagnosticLogger, input: any, maxLength: number, _msgId: _eInternalMessageId): any;
-export declare function dsPadNumber(num: number): string;

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

@@ -1,45 +0,0 @@
-import { IDiagnosticLogger } from "@microsoft/applicationinsights-core-js";
-import { IBase } from "../../Interfaces/Contracts/IBase";
-import { IEnvelope } from "../../Interfaces/Telemetry/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: IBase, name: string);
-}

package/types/Telemetry/Event.d.ts

@@ -1,34 +0,0 @@
-import { IDiagnosticLogger } from "@microsoft/applicationinsights-core-js";
-import { FieldType } from "../Enums";
-import { IEventData } from "../Interfaces/Contracts/IEventData";
-import { ISerializable } from "../Interfaces/Telemetry/ISerializable";
-export declare class Event implements IEventData, ISerializable {
-    static envelopeType: string;
-    static dataType: string;
-    aiDataContract: {
-        ver: FieldType;
-        name: FieldType;
-        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
-     */
-    constructor(logger: IDiagnosticLogger, name: string, properties?: any, measurements?: any);
-}