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

package/types/Telemetry/Exception.d.ts

@@ -1,150 +0,0 @@
-import { IDiagnosticLogger } from "@microsoft/applicationinsights-core-js";
-import { FieldType } from "../Enums";
-import { IExceptionData } from "../Interfaces/Contracts/IExceptionData";
-import { IExceptionDetails } from "../Interfaces/Contracts/IExceptionDetails";
-import { IStackFrame } from "../Interfaces/Contracts/IStackFrame";
-import { SeverityLevel } from "../Interfaces/Contracts/SeverityLevel";
-import { IAutoExceptionTelemetry, IExceptionDetailsInternal, IExceptionInternal, IExceptionStackFrameInternal } from "../Interfaces/IExceptionTelemetry";
-import { ISerializable } from "../Interfaces/Telemetry/ISerializable";
-/**
- * Formats the provided errorObj for display and reporting, it may be a String, Object, integer or undefined depending on the browser.
- * @param errorObj - The supplied errorObj
- */
-export declare function _formatErrorCode(errorObj: any): any;
-export declare class Exception implements IExceptionData, ISerializable {
-    static envelopeType: string;
-    static dataType: string;
-    id?: string;
-    problemGroup?: string;
-    isManual?: boolean;
-    aiDataContract: {
-        ver: FieldType;
-        exceptions: FieldType;
-        severityLevel: FieldType;
-        properties: FieldType;
-        measurements: FieldType;
-    };
-    /**
-     * Schema version
-     */
-    ver: number;
-    /**
-     * Exception chain - list of inner exceptions.
-     */
-    exceptions: IExceptionDetails[];
-    /**
-     * Severity level. Mostly used to indicate exception severity level when it is reported by logging library.
-     */
-    severityLevel: SeverityLevel;
-    /**
-     * Collection of custom properties.
-     */
-    properties: any;
-    /**
-     * Collection of custom measurements.
-     */
-    measurements: any;
-    /**
-     * Constructs a new instance of the ExceptionTelemetry object
-     */
-    constructor(logger: IDiagnosticLogger, exception: Error | IExceptionInternal | IAutoExceptionTelemetry, properties?: {
-        [key: string]: any;
-    }, measurements?: {
-        [key: string]: number;
-    }, severityLevel?: SeverityLevel, id?: string);
-    static CreateAutoException(message: string | Event, url: string, lineNumber: number, columnNumber: number, error: any, evt?: Event | string, stack?: string, errorSrc?: string): IAutoExceptionTelemetry;
-    static CreateFromInterface(logger: IDiagnosticLogger, exception: IExceptionInternal, properties?: any, measurements?: {
-        [key: string]: number;
-    }): Exception;
-    toInterface(): IExceptionInternal;
-    /**
-     * Creates a simple exception with 1 stack frame. Useful for manual constracting of exception.
-     */
-    static CreateSimpleException(message: string, typeName: string, assembly: string, fileName: string, details: string, line: number): Exception;
-    static formatError: typeof _formatErrorCode;
-}
-export declare class _ExceptionDetails implements IExceptionDetails, ISerializable {
-    aiDataContract: {
-        id: FieldType;
-        outerId: FieldType;
-        typeName: FieldType;
-        message: FieldType;
-        hasFullStack: FieldType;
-        stack: FieldType;
-        parsedStack: FieldType;
-    };
-    /**
-     * In case exception is nested (outer exception contains inner one), the id and outerId properties are used to represent the nesting.
-     */
-    id: number;
-    /**
-     * The value of outerId is a reference to an element in ExceptionDetails that represents the outer exception
-     */
-    outerId: number;
-    /**
-     * Exception type name.
-     */
-    typeName: string;
-    /**
-     * Exception message.
-     */
-    message: string;
-    /**
-     * Indicates if full exception stack is provided in the exception. The stack may be trimmed, such as in the case of a StackOverflow exception.
-     */
-    hasFullStack: boolean;
-    /**
-     * Text describing the stack. Either stack or parsedStack should have a value.
-     */
-    stack: string;
-    /**
-     * List of stack frames. Either stack or parsedStack should have a value.
-     */
-    parsedStack: IStackFrame[];
-    constructor(logger: IDiagnosticLogger, exception: Error | IExceptionDetailsInternal | IAutoExceptionTelemetry, properties?: {
-        [key: string]: any;
-    });
-    toInterface(): IExceptionDetailsInternal;
-    static CreateFromInterface(logger: IDiagnosticLogger, exception: IExceptionDetailsInternal): _ExceptionDetails;
-}
-export declare class _StackFrame implements IStackFrame, ISerializable {
-    static regex: RegExp;
-    static baseSize: number;
-    sizeInBytes: number;
-    aiDataContract: {
-        level: FieldType;
-        method: FieldType;
-        assembly: FieldType;
-        fileName: FieldType;
-        line: FieldType;
-    };
-    /**
-     * 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;
-    constructor(sourceFrame: string | IExceptionStackFrameInternal, level: number);
-    static CreateFromInterface(frame: IExceptionStackFrameInternal): _StackFrame;
-    toInterface(): {
-        level: number;
-        method: string;
-        assembly: string;
-        fileName: string;
-        line: number;
-    };
-}

package/types/Telemetry/Metric.d.ts

@@ -1,36 +0,0 @@
-import { IDiagnosticLogger } from "@microsoft/applicationinsights-core-js";
-import { FieldType } from "../Enums";
-import { IMetricData } from "../Interfaces/Contracts/IMetricData";
-import { ISerializable } from "../Interfaces/Telemetry/ISerializable";
-import { DataPoint } from "./Common/DataPoint";
-export declare class Metric implements IMetricData, ISerializable {
-    static envelopeType: string;
-    static dataType: string;
-    aiDataContract: {
-        ver: FieldType;
-        metrics: FieldType;
-        properties: FieldType;
-    };
-    /**
-     * Schema version
-     */
-    ver: number;
-    /**
-     * List of metrics. Only one metric in the list is currently supported by Application Insights storage. If multiple data points were sent only the first one will be used.
-     */
-    metrics: DataPoint[];
-    /**
-     * Collection of custom properties.
-     */
-    properties: any;
-    /**
-     * Collection of custom measurements.
-     */
-    measurements: any;
-    /**
-     * Constructs a new instance of the MetricTelemetry object
-     */
-    constructor(logger: IDiagnosticLogger, name: string, value: number, count?: number, min?: number, max?: number, stdDev?: number, properties?: any, measurements?: {
-        [key: string]: number;
-    });
-}

package/types/Telemetry/PageView.d.ts

@@ -1,53 +0,0 @@
-import { IDiagnosticLogger } from "@microsoft/applicationinsights-core-js";
-import { FieldType } from "../Enums";
-import { IPageViewData } from "../Interfaces/Contracts/IPageViewData";
-import { ISerializable } from "../Interfaces/Telemetry/ISerializable";
-export declare class PageView implements IPageViewData, ISerializable {
-    static envelopeType: string;
-    static dataType: string;
-    aiDataContract: {
-        ver: FieldType;
-        name: FieldType;
-        url: FieldType;
-        duration: FieldType;
-        properties: FieldType;
-        measurements: FieldType;
-        id: 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;
-    /**
-     * Request URL with all query string parameters
-     */
-    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.
-     */
-    duration: string;
-    /**
-     * Identifier of a page view instance. Used for correlation between page view and other telemetry items.
-     */
-    id: string;
-    /**
-     * Constructs a new instance of the PageEventTelemetry object
-     */
-    constructor(logger: IDiagnosticLogger, name?: string, url?: string, durationMs?: number, properties?: {
-        [key: string]: string;
-    }, measurements?: {
-        [key: string]: number;
-    }, id?: string);
-}

package/types/Telemetry/PageViewPerformance.d.ts

@@ -1,78 +0,0 @@
-import { IDiagnosticLogger } from "@microsoft/applicationinsights-core-js";
-import { FieldType } from "../Enums";
-import { IPageViewPerfData } from "../Interfaces/Contracts/IPageViewPerfData";
-import { IPageViewPerformanceTelemetry } from "../Interfaces/IPageViewPerformanceTelemetry";
-import { ISerializable } from "../Interfaces/Telemetry/ISerializable";
-export declare class PageViewPerformance implements IPageViewPerfData, ISerializable {
-    static envelopeType: string;
-    static dataType: string;
-    aiDataContract: {
-        ver: FieldType;
-        name: FieldType;
-        url: FieldType;
-        duration: FieldType;
-        perfTotal: FieldType;
-        networkConnect: FieldType;
-        sentRequest: FieldType;
-        receivedResponse: FieldType;
-        domProcessing: 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;
-    /**
-     * Request URL with all query string parameters
-     */
-    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.
-     */
-    duration: string;
-    /**
-     * Identifier of a page view instance. Used for correlation between page view and other telemetry items.
-     */
-    id: string;
-    /**
-     * 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;
-    /**
-     * 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);
-}

package/types/Telemetry/RemoteDependencyData.d.ts

@@ -1,79 +0,0 @@
-import { IDiagnosticLogger } from "@microsoft/applicationinsights-core-js";
-import { FieldType } from "../Enums";
-import { IRemoteDependencyData } from "../Interfaces/Contracts/IRemoteDependencyData";
-import { ISerializable } from "../Interfaces/Telemetry/ISerializable";
-export declare class RemoteDependencyData implements IRemoteDependencyData, ISerializable {
-    static envelopeType: string;
-    static dataType: string;
-    aiDataContract: {
-        id: FieldType;
-        ver: FieldType;
-        name: FieldType;
-        resultCode: FieldType;
-        duration: FieldType;
-        success: FieldType;
-        data: FieldType;
-        target: FieldType;
-        type: FieldType;
-        properties: FieldType;
-        measurements: FieldType;
-        kind: FieldType;
-        value: FieldType;
-        count: FieldType;
-        min: FieldType;
-        max: FieldType;
-        stdDev: FieldType;
-        dependencyKind: FieldType;
-        dependencySource: FieldType;
-        commandName: FieldType;
-        dependencyTypeName: FieldType;
-    };
-    /**
-     * Schema version
-     */
-    ver: number;
-    /**
-     * 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;
-    /**
-     * 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;
-    /**
-     * 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, correlationContext?: string, properties?: Object, measurements?: Object);
-}

package/types/Telemetry/Trace.d.ts

@@ -1,41 +0,0 @@
-import { IDiagnosticLogger } from "@microsoft/applicationinsights-core-js";
-import { FieldType } from "../Enums";
-import { IMessageData } from "../Interfaces/Contracts/IMessageData";
-import { SeverityLevel } from "../Interfaces/Contracts/SeverityLevel";
-import { ISerializable } from "../Interfaces/Telemetry/ISerializable";
-export declare class Trace implements IMessageData, ISerializable {
-    static envelopeType: string;
-    static dataType: string;
-    aiDataContract: {
-        ver: FieldType;
-        message: FieldType;
-        severityLevel: FieldType;
-        properties: FieldType;
-    };
-    /**
-     * Schema version
-     */
-    ver: number;
-    /**
-     * Trace message
-     */
-    message: string;
-    /**
-     * Trace severity level.
-     */
-    severityLevel: SeverityLevel;
-    /**
-     * Collection of custom properties.
-     */
-    properties: any;
-    /**
-     * Collection of custom measurements.
-     */
-    measurements: any;
-    /**
-     * Constructs a new instance of the TraceTelemetry object
-     */
-    constructor(logger: IDiagnosticLogger, message: string, severityLevel?: SeverityLevel, properties?: any, measurements?: {
-        [key: string]: number;
-    });
-}

package/types/TelemetryItemCreator.d.ts

@@ -1,27 +0,0 @@
-import { IDiagnosticLogger, ITelemetryItem } from "@microsoft/applicationinsights-core-js";
-/**
- * Create a telemetry item that the 1DS channel understands
- * @param item - domain specific properties; part B
- * @param baseType - telemetry item type. ie PageViewData
- * @param envelopeName - name of the envelope. ie Microsoft.ApplicationInsights.<instrumentation key>.PageView
- * @param customProperties - user defined custom properties; part C
- * @param systemProperties - system properties that are added to the context; part A
- * @returns ITelemetryItem that is sent to channel
- */
-export declare function createTelemetryItem<T>(item: T, baseType: string, envelopeName: string, logger: IDiagnosticLogger, customProperties?: {
-    [key: string]: any;
-}, systemProperties?: {
-    [key: string]: any;
-}): ITelemetryItem;
-export declare class TelemetryItemCreator {
-    /**
-     * Create a telemetry item that the 1DS channel understands
-     * @param item - domain specific properties; part B
-     * @param baseType - telemetry item type. ie PageViewData
-     * @param envelopeName - name of the envelope. ie Microsoft.ApplicationInsights.<instrumentation key>.PageView
-     * @param customProperties - user defined custom properties; part C
-     * @param systemProperties - system properties that are added to the context; part A
-     * @returns ITelemetryItem that is sent to channel
-     */
-    static create: typeof createTelemetryItem;
-}

package/types/ThrottleMgr.d.ts

@@ -1,13 +0,0 @@
-import { IAppInsightsCore, IUnloadHookContainer, _eInternalMessageId, eLoggingSeverity } from "@microsoft/applicationinsights-core-js";
-import { IThrottleMgrConfig, IThrottleResult } from "./Interfaces/IThrottleMgr";
-export declare class ThrottleMgr {
-    canThrottle: () => boolean;
-    sendMessage: (msgID: _eInternalMessageId, message: string, severity?: eLoggingSeverity) => IThrottleResult | null;
-    getConfig: () => IThrottleMgrConfig;
-    isTriggered: () => boolean;
-    isReady: () => boolean;
-    onReadyState: (isReady?: boolean) => boolean;
-    flush: () => boolean;
-    config: IThrottleMgrConfig;
-    constructor(config?: IThrottleMgrConfig, core?: IAppInsightsCore, namePrefix?: string, unloadHookContainer?: IUnloadHookContainer);
-}

package/types/UrlHelperFuncs.d.ts

@@ -1,6 +0,0 @@
-export declare function urlParseUrl(url: string): HTMLAnchorElement;
-export declare function urlGetAbsoluteUrl(url: string): string;
-export declare function urlGetPathName(url: string): string;
-export declare function urlGetCompleteUrl(method: string, absoluteUrl: string): string;
-export declare function urlParseHost(url: string, inclPort?: boolean): string;
-export declare function urlParseFullHost(url: string, inclPort?: boolean): string;

package/types/Util.d.ts

@@ -1,36 +0,0 @@
-import { IDiagnosticLogger, IDistributedTraceContext } from "@microsoft/applicationinsights-core-js";
-import { ITelemetryTrace } from "./Interfaces/Context/ITelemetryTrace";
-import { ICorrelationConfig } from "./Interfaces/ICorrelationConfig";
-export declare function isInternalApplicationInsightsEndpoint(endpointUrl: string): boolean;
-export declare function correlationIdSetPrefix(prefix: string): void;
-export declare function correlationIdGetPrefix(): string;
-/**
- * Checks if a request url is not on a excluded domain list and if it is safe to add correlation headers.
- * Headers are always included if the current domain matches the request domain. If they do not match (CORS),
- * they are regex-ed across correlationHeaderDomains and correlationHeaderExcludedDomains to determine if headers are included.
- * Some environments don't give information on currentHost via window.location.host (e.g. Cordova). In these cases, the user must
- * manually supply domains to include correlation headers on. Else, no headers will be included at all.
- */
-export declare function correlationIdCanIncludeCorrelationHeader(config: ICorrelationConfig, requestUrl: string, currentHost?: string): boolean;
-/**
- * Combines target appId and target role name from response header.
- */
-export declare function correlationIdGetCorrelationContext(responseHeader: string): string;
-/**
- * Gets key from correlation response header
- */
-export declare function correlationIdGetCorrelationContextValue(responseHeader: string, key: string): string;
-export declare function AjaxHelperParseDependencyPath(logger: IDiagnosticLogger, absoluteUrl: string, method: string, commandName: string): {
-    target: string;
-    name: string;
-    data: string;
-};
-export declare function dateTimeUtilsNow(): number;
-export declare function dateTimeUtilsDuration(start: number, end: number): number;
-/**
- * Creates a IDistributedTraceContext from an optional telemetryTrace
- * @param telemetryTrace - The telemetryTrace instance that is being wrapped
- * @param parentCtx - An optional parent distributed trace instance, almost always undefined as this scenario is only used in the case of multiple property handlers.
- * @returns A new IDistributedTraceContext instance that is backed by the telemetryTrace or temporary object
- */
-export declare function createDistributedTraceContextFromTrace(telemetryTrace?: ITelemetryTrace, parentCtx?: IDistributedTraceContext): IDistributedTraceContext;

package/types/__DynamicConstants.d.ts

@@ -1,38 +0,0 @@
-export declare const _DYN_SPLIT = "split";
-export declare const _DYN_LENGTH = "length";
-export declare const _DYN_TO_LOWER_CASE = "toLowerCase";
-export declare const _DYN_INGESTIONENDPOINT = "ingestionendpoint";
-export declare const _DYN_TO_STRING = "toString";
-export declare const _DYN_REMOVE_ITEM = "removeItem";
-export declare const _DYN_NAME = "name";
-export declare const _DYN_MESSAGE = "message";
-export declare const _DYN_COUNT = "count";
-export declare const _DYN_PRE_TRIGGER_DATE = "preTriggerDate";
-export declare const _DYN_DISABLED = "disabled";
-export declare const _DYN_INTERVAL = "interval";
-export declare const _DYN_DAYS_OF_MONTH = "daysOfMonth";
-export declare const _DYN_DATE = "date";
-export declare const _DYN_GET_UTCDATE = "getUTCDate";
-export declare const _DYN_STRINGIFY = "stringify";
-export declare const _DYN_PATHNAME = "pathname";
-export declare const _DYN_CORRELATION_HEADER_E0 = "correlationHeaderExcludePatterns";
-export declare const _DYN_EXTENSION_CONFIG = "extensionConfig";
-export declare const _DYN_EXCEPTIONS = "exceptions";
-export declare const _DYN_PARSED_STACK = "parsedStack";
-export declare const _DYN_PROPERTIES = "properties";
-export declare const _DYN_MEASUREMENTS = "measurements";
-export declare const _DYN_SIZE_IN_BYTES = "sizeInBytes";
-export declare const _DYN_TYPE_NAME = "typeName";
-export declare const _DYN_SEVERITY_LEVEL = "severityLevel";
-export declare const _DYN_PROBLEM_GROUP = "problemGroup";
-export declare const _DYN_IS_MANUAL = "isManual";
-export declare const _DYN__CREATE_FROM_INTERFA1 = "CreateFromInterface";
-export declare const _DYN_ASSEMBLY = "assembly";
-export declare const _DYN_HAS_FULL_STACK = "hasFullStack";
-export declare const _DYN_LEVEL = "level";
-export declare const _DYN_METHOD = "method";
-export declare const _DYN_FILE_NAME = "fileName";
-export declare const _DYN_LINE = "line";
-export declare const _DYN_DURATION = "duration";
-export declare const _DYN_RECEIVED_RESPONSE = "receivedResponse";
-export declare const _DYN_SUBSTRING = "substring";

package/types/tsdoc-metadata.json

@@ -1,11 +0,0 @@
-// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
-// It should be published with your NPM package.  It should not be tracked by Git.
-{
-  "tsdocVersion": "0.12",
-  "toolPackages": [
-    {
-      "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.34.4"
-    }
-  ]
-}