@microsoft/applicationinsights-common 2.7.5-nightly.2203-02 → 2.7.5-nightly.2203-03

package/types/Interfaces/Contracts/ContextTagKeys.d.ts

@@ -0,0 +1,175 @@
+export interface IContextTagKeys {
+    /**
+     * Application version. Information in the application context fields is always about the application that is sending the telemetry.
+     */
+    readonly applicationVersion: string;
+    /**
+     * Application build.
+     */
+    readonly applicationBuild: string;
+    /**
+     * Application type id.
+     */
+    readonly applicationTypeId: string;
+    /**
+     * Application id.
+     */
+    readonly applicationId: string;
+    /**
+     * Application layer.
+     */
+    readonly applicationLayer: string;
+    /**
+     * Unique client device id. Computer name in most cases.
+     */
+    readonly deviceId: string;
+    readonly deviceIp: string;
+    readonly deviceLanguage: string;
+    /**
+     * Device locale using <language>-<REGION> pattern, following RFC 5646. Example 'en-US'.
+     */
+    readonly deviceLocale: string;
+    /**
+     * Model of the device the end user of the application is using. Used for client scenarios. If this field is empty then it is derived from the user agent.
+     */
+    readonly deviceModel: string;
+    readonly deviceFriendlyName: string;
+    readonly deviceNetwork: string;
+    readonly deviceNetworkName: string;
+    /**
+     * Client device OEM name taken from the browser.
+     */
+    readonly deviceOEMName: string;
+    readonly deviceOS: string;
+    /**
+     * Operating system name and version of the device the end user of the application is using. If this field is empty then it is derived from the user agent. Example 'Windows 10 Pro 10.0.10586.0'
+     */
+    readonly deviceOSVersion: string;
+    /**
+     * Name of the instance where application is running. Computer name for on-premisis, instance name for Azure.
+     */
+    readonly deviceRoleInstance: string;
+    /**
+     * Name of the role application is part of. Maps directly to the role name in azure.
+     */
+    readonly deviceRoleName: string;
+    readonly deviceScreenResolution: string;
+    /**
+     * The type of the device the end user of the application is using. Used primarily to distinguish JavaScript telemetry from server side telemetry. Examples: 'PC', 'Phone', 'Browser'. 'PC' is the default value.
+     */
+    readonly deviceType: string;
+    readonly deviceMachineName: string;
+    readonly deviceVMName: string;
+    readonly deviceBrowser: string;
+    /**
+     * The browser name and version as reported by the browser.
+     */
+    readonly deviceBrowserVersion: string;
+    /**
+     * The IP address of the client device. IPv4 and IPv6 are supported. Information in the location context fields is always about the end user. When telemetry is sent from a service, the location context is about the user that initiated the operation in the service.
+     */
+    readonly locationIp: string;
+    /**
+     * The country of the client device. If any of Country, Province, or City is specified, those values will be preferred over geolocation of the IP address field. Information in the location context fields is always about the end user. When telemetry is sent from a service, the location context is about the user that initiated the operation in the service.
+     */
+    readonly locationCountry: string;
+    /**
+     * The province/state of the client device. If any of Country, Province, or City is specified, those values will be preferred over geolocation of the IP address field. Information in the location context fields is always about the end user. When telemetry is sent from a service, the location context is about the user that initiated the operation in the service.
+     */
+    readonly locationProvince: string;
+    /**
+     * The city of the client device. If any of Country, Province, or City is specified, those values will be preferred over geolocation of the IP address field. Information in the location context fields is always about the end user. When telemetry is sent from a service, the location context is about the user that initiated the operation in the service.
+     */
+    readonly locationCity: string;
+    /**
+     * A unique identifier for the operation instance. The operation.id is created by either a request or a page view. All other telemetry sets this to the value for the containing request or page view. Operation.id is used for finding all the telemetry items for a specific operation instance.
+     */
+    readonly operationId: string;
+    /**
+     * The name (group) of the operation. The operation.name is created by either a request or a page view. All other telemetry items set this to the value for the containing request or page view. Operation.name is used for finding all the telemetry items for a group of operations (i.e. 'GET Home/Index').
+     */
+    readonly operationName: string;
+    /**
+     * The unique identifier of the telemetry item's immediate parent.
+     */
+    readonly operationParentId: string;
+    readonly operationRootId: string;
+    /**
+     * Name of synthetic source. Some telemetry from the application may represent a synthetic traffic. It may be web crawler indexing the web site, site availability tests or traces from diagnostic libraries like Application Insights SDK itself.
+     */
+    readonly operationSyntheticSource: string;
+    /**
+     * The correlation vector is a light weight vector clock which can be used to identify and order related events across clients and services.
+     */
+    readonly operationCorrelationVector: string;
+    /**
+     * Session ID - the instance of the user's interaction with the app. Information in the session context fields is always about the end user. When telemetry is sent from a service, the session context is about the user that initiated the operation in the service.
+     */
+    readonly sessionId: string;
+    /**
+     * Boolean value indicating whether the session identified by ai.session.id is first for the user or not.
+     */
+    readonly sessionIsFirst: string;
+    readonly sessionIsNew: string;
+    readonly userAccountAcquisitionDate: string;
+    /**
+     * In multi-tenant applications this is the account ID or name which the user is acting with. Examples may be subscription ID for Azure portal or blog name blogging platform.
+     */
+    readonly userAccountId: string;
+    /**
+     * The browser's user agent string as reported by the browser. This property will be used to extract informaiton regarding the customer's browser but will not be stored. Use custom properties to store the original user agent.
+     */
+    readonly userAgent: string;
+    /**
+     * Anonymous user id. Represents the end user of the application. When telemetry is sent from a service, the user context is about the user that initiated the operation in the service.
+     */
+    readonly userId: string;
+    /**
+     * Store region for UWP applications.
+     */
+    readonly userStoreRegion: string;
+    /**
+     * Authenticated user id. The opposite of ai.user.id, this represents the user with a friendly name. Since it's PII information it is not collected by default by most SDKs.
+     */
+    readonly userAuthUserId: string;
+    readonly userAnonymousUserAcquisitionDate: string;
+    readonly userAuthenticatedUserAcquisitionDate: string;
+    readonly cloudName: string;
+    /**
+     * Name of the role the application is a part of. Maps directly to the role name in azure.
+     */
+    readonly cloudRole: string;
+    readonly cloudRoleVer: string;
+    /**
+     * Name of the instance where the application is running. Computer name for on-premisis, instance name for Azure.
+     */
+    readonly cloudRoleInstance: string;
+    readonly cloudEnvironment: string;
+    readonly cloudLocation: string;
+    readonly cloudDeploymentUnit: string;
+    /**
+     * SDK version. See https://github.com/microsoft/ApplicationInsights-Home/blob/master/SDK-AUTHORING.md#sdk-version-specification for information.
+     */
+    readonly internalSdkVersion: string;
+    /**
+     * Agent version. Used to indicate the version of StatusMonitor installed on the computer if it is used for data collection.
+     */
+    readonly internalAgentVersion: string;
+    /**
+     * This is the node name used for billing purposes. Use it to override the standard detection of nodes.
+     */
+    readonly internalNodeName: string;
+    /**
+     * This identifies the version of the snippet that was used to initialize the SDK
+     */
+    readonly internalSnippet: string;
+    /**
+     * This identifies the source of the Sdk script (used to identify whether the SDK was loaded via the CDN)
+     */
+    readonly internalSdkSrc: string;
+}
+declare const ContextTagKeys_base: new () => IContextTagKeys;
+export declare class ContextTagKeys extends ContextTagKeys_base {
+    constructor();
+}
+export {};

package/types/Interfaces/Contracts/DataPointType.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Type of the metric data measurement.
+ */
+export declare const enum DataPointType {
+    Measurement = 0,
+    Aggregation = 1
+}

package/types/Interfaces/Contracts/DependencyKind.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Identifies the type of dependency.
+ */
+export declare const enum DependencyKind {
+    SQL = 0,
+    Http = 1,
+    Other = 2
+}

package/types/Interfaces/Contracts/DependencySourceType.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Identifies the source of the dependency.
+ */
+export declare const enum DependencySourceType {
+    Undefined = 0,
+    Aic = 1,
+    Apmc = 2
+}

package/types/Interfaces/Contracts/IBase.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Data struct to contain only C section with custom fields.
+ */
+export interface IBase {
+    /**
+     * Name of item (B section) if any. If telemetry data is derived straight from this, this should be null.
+     */
+    baseType: string;
+}

package/types/Interfaces/Contracts/IData.d.ts

@@ -0,0 +1,14 @@
+import { IBase } from "./IBase";
+/**
+ * Data struct to contain both B and C sections.
+ */
+export interface IData<TDomain> extends IBase {
+    /**
+     * 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;
+}

package/types/Interfaces/Contracts/IDataPoint.d.ts

@@ -0,0 +1,34 @@
+import { DataPointType } from "./DataPointType";
+/**
+ * Metric data single measurement.
+ */
+export interface IDataPoint {
+    /**
+     * 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/Interfaces/Contracts/IDomain.d.ts

@@ -0,0 +1,5 @@
+/**
+ * The abstract common base of all domains.
+ */
+export interface IDomain {
+}

package/types/Interfaces/Contracts/IEventData.d.ts

@@ -0,0 +1,22 @@
+import { IDomain } from "./IDomain";
+/**
+ * Instances of Event represent structured event records that can be grouped and searched by their properties. Event data item also creates a metric of event count by name.
+ */
+export interface IEventData extends IDomain {
+    /**
+     * 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;
+}

package/types/Interfaces/Contracts/IExceptionData.d.ts

@@ -0,0 +1,28 @@
+import { IExceptionDetails } from "./IExceptionDetails";
+import { IDomain } from "./IDomain";
+import { SeverityLevel } from "./SeverityLevel";
+/**
+ * An instance of Exception represents a handled or unhandled exception that occurred during execution of the monitored application.
+ */
+export interface IExceptionData extends IDomain {
+    /**
+     * 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;
+}

package/types/Interfaces/Contracts/IExceptionDetails.d.ts

@@ -0,0 +1,34 @@
+import { IStackFrame } from "./IStackFrame";
+/**
+ * Exception details of the exception in a chain.
+ */
+export interface IExceptionDetails {
+    /**
+     * 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[];
+}

package/types/Interfaces/Contracts/IMessageData.d.ts

@@ -0,0 +1,27 @@
+import { IDomain } from "./IDomain";
+import { SeverityLevel } from "./SeverityLevel";
+/**
+ * Instances of Message represent printf-like trace statements that are text-searched. Log4Net, NLog and other text-based log file entries are translated into intances of this type. The message does not have measurements.
+ */
+export interface IMessageData extends IDomain {
+    /**
+     * 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;
+}

package/types/Interfaces/Contracts/IMetricData.d.ts

@@ -0,0 +1,23 @@
+import { IDomain } from "./IDomain";
+import { IDataPoint } from "./IDataPoint";
+/**
+ * An instance of the Metric item is a list of measurements (single data points) and/or aggregations.
+ */
+export interface IMetricData extends IDomain {
+    /**
+     * 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: IDataPoint[];
+    /**
+     * Collection of custom properties.
+     */
+    properties: any;
+    /**
+     * Collection of custom measurements.
+     */
+    measurements: any;
+}

package/types/Interfaces/Contracts/IPageViewData.d.ts

@@ -0,0 +1,18 @@
+import { IEventData } from "./IEventData";
+/**
+ * An instance of PageView represents a generic action on a page like a button click. It is also the base type for PageView.
+ */
+export interface IPageViewData extends IEventData {
+    /**
+     * 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;
+}

package/types/Interfaces/Contracts/IPageViewPerfData.d.ts

@@ -0,0 +1,26 @@
+import { IPageViewData } from "./IPageViewData";
+/**
+ * An instance of PageViewPerf represents: a page view with no performance data, a page view with performance data, or just the performance data of an earlier page request.
+ */
+export interface IPageViewPerfData extends IPageViewData {
+    /**
+     * 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;
+}

package/types/Interfaces/Contracts/IRemoteDependencyData.d.ts

@@ -0,0 +1,50 @@
+import { IDomain } from "./IDomain";
+/**
+ * An instance of Remote Dependency represents an interaction of the monitored component with a remote component/service like SQL or an HTTP endpoint.
+ */
+export interface IRemoteDependencyData extends IDomain {
+    /**
+     * 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;
+}

package/types/Interfaces/Contracts/IStackFrame.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Stack frame information.
+ */
+export interface IStackFrame {
+    /**
+     * 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;
+}

package/types/Interfaces/Contracts/SeverityLevel.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Defines the level of severity for the event.
+ */
+export declare enum SeverityLevel {
+    Verbose = 0,
+    Information = 1,
+    Warning = 2,
+    Error = 3,
+    Critical = 4
+}

package/types/StorageHelperFuncs.d.ts

@@ -1,10 +1,22 @@
 import { IDiagnosticLogger } from "@microsoft/applicationinsights-core-js";
+/**
+ * Disables the global SDK usage of local or session storage if available
+ */
 export declare function utlDisableStorage(): void;
-export declare function utlCanUseLocalStorage(): boolean;
+/**
+ * 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(): 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;

package/types/applicationinsights-common.d.ts

@@ -46,11 +46,11 @@ export { IPropertiesPlugin } from "./Interfaces/IPropertiesPlugin";
 export { IUser, IUserContext } from "./Interfaces/Context/IUser";
 export { ITelemetryTrace, ITraceState } from "./Interfaces/Context/ITelemetryTrace";
 export { IRequestContext } from "./Interfaces/IRequestContext";
-export { DistributedTracingModes } from "./Enums";
+export { eDistributedTracingModes, DistributedTracingModes } from "./Enums";
 export { stringToBoolOrDefault, msToTimeSpan, getExtensionByName, isCrossOriginError } from "./HelperFuncs";
 export { isBeaconsSupported as isBeaconApiSupported } from "@microsoft/applicationinsights-core-js";
 export { createDomEvent } from "./DomHelperFuncs";
-export { utlDisableStorage, utlCanUseLocalStorage, utlGetLocalStorage, utlSetLocalStorage, utlRemoveStorage, utlCanUseSessionStorage, utlGetSessionStorageKeys, utlGetSessionStorage, utlSetSessionStorage, utlRemoveSessionStorage } from "./StorageHelperFuncs";
+export { utlDisableStorage, utlEnableStorage, utlCanUseLocalStorage, utlGetLocalStorage, utlSetLocalStorage, utlRemoveStorage, utlCanUseSessionStorage, utlGetSessionStorageKeys, utlGetSessionStorage, utlSetSessionStorage, utlRemoveSessionStorage } from "./StorageHelperFuncs";
 export { urlParseUrl, urlGetAbsoluteUrl, urlGetPathName, urlGetCompleteUrl, urlParseHost, urlParseFullHost } from "./UrlHelperFuncs";
 export declare const PropertiesPluginIdentifier = "AppInsightsPropertiesPlugin";
 export declare const BreezeChannelIdentifier = "AppInsightsChannelPlugin";

package/types/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.19.4"
+      "packageVersion": "7.19.5"
     }
   ]
 }