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

package/src/Interfaces/Context/IApplication.ts

@@ -1,14 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-export interface IApplication {
-    /**
-     * The application version.
-     */
-    ver: string;
-
-    /**
-     * The application build version.
-     */
-    build: string;
-}

package/src/Interfaces/Context/IDevice.ts

@@ -1,28 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-export interface IDevice {
-    /**
-     * The type for the current device.
-     */
-    deviceClass: string;
-    /**
-     * A device unique ID.
-     */
-    id: string;
-    
-    /**
-     * The device model for the current device.
-     */
-    model: string;
-   
-    /**
-     * The application screen resolution.
-     */
-    resolution: string;
-
-    /**
-     * The IP address.
-     */
-    ip: string;
-}

package/src/Interfaces/Context/IInternal.ts

@@ -1,29 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-export interface IInternal {
-    /**
-     * The SDK version used to create this telemetry item.
-     */
-    sdkVersion: string;
-
-    /**
-     * The SDK agent version.
-     */
-    agentVersion: string;
-
-    /**
-     * The Snippet version used to initialize the sdk instance, this will contain either
-     * undefined/null - Snippet not used
-     * '-' - Version and legacy mode not determined
-     * # - Version # of the snippet
-     * #.l - Version # in legacy mode
-     * .l - No defined version, but used legacy mode initialization
-     */
-    snippetVer: string;
-
-    /**
-     * Identifies the source of the sdk script
-     */
-    sdkSrc: string;
-}

package/src/Interfaces/Context/ILocation.ts

@@ -1,9 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-export interface ILocation {
-    /**
-     * Client IP address for reverse lookup
-     */
-    ip: string;
-}

package/src/Interfaces/Context/IOperatingSystem.ts

@@ -1,7 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-
-export interface IOperatingSystem {
-    name: string;
-}

package/src/Interfaces/Context/ISample.ts

@@ -1,13 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-import { ITelemetryItem } from "@microsoft/applicationinsights-core-js";
-
-export interface ISample {
-    /**
-     * Sample rate
-     */
-    sampleRate: number;
-
-    isSampledIn(envelope: ITelemetryItem): boolean;
-}

package/src/Interfaces/Context/ISession.ts

@@ -1,22 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-export interface ISession {
-    /**
-     * The session ID.
-     */
-    id?: string;
-
-    /**
-     * The date at which this guid was genereated.
-     * Per the spec the ID will be regenerated if more than acquisitionSpan milliseconds ellapse from this time.
-     */
-    acquisitionDate?: number;
-
-    /**
-     * The date at which this session ID was last reported.
-     * This value should be updated whenever telemetry is sent using this ID.
-     * Per the spec the ID will be regenerated if more than renewalSpan milliseconds elapse from this time with no activity.
-     */
-    renewalDate?: number;
-}

package/src/Interfaces/Context/ITelemetryTrace.ts

@@ -1,33 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-export interface ITelemetryTrace {
-    /**
-     * Trace id
-     */
-    traceID?: string;
-
-    /**
-     * Parent id
-     */
-    parentID?: string;
-
-    /**
-     * @deprecated Never Used
-     * Trace state
-     */
-    traceState?: ITraceState;
-
-    /**
-     * An integer representation of the W3C TraceContext trace-flags. https://www.w3.org/TR/trace-context/#trace-flags
-     */
-    traceFlags?: number;
-
-    /**
-     * Name
-     */
-    name?: string;
-}
-
-export interface ITraceState {
-}

package/src/Interfaces/Context/IUser.ts

@@ -1,50 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-export interface IUser {
-    /**
-     * The telemetry configuration.
-     */
-    config: any;
-
-    /**
-     * The user ID.
-     */
-    id: string;
-
-    /**
-     * Authenticated user id
-     */
-    authenticatedId: string;
-
-    /**
-     * The account ID.
-     */
-    accountId: string;
-
-    /**
-     * The account acquisition date.
-     */
-    accountAcquisitionDate: string;
-
-    /**
-     * The localId
-     */
-    localId: string;
-
-    /**
-     * A flag indicating whether this represents a new user
-     */
-    isNewUser?: boolean;
-
-    /**
-     * A flag indicating whether the user cookie has been set
-     */
-    isUserCookieSet?: boolean;
-}
-
-export interface IUserContext extends IUser {
-    setAuthenticatedUserContext(authenticatedUserId: string, accountId?: string, storeInCookie?: boolean): void;
-    clearAuthenticatedUserContext(): void;
-    update (userId?: string): void;
-}

package/src/Interfaces/Context/IWeb.ts

@@ -1,39 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-export interface IWeb {
-    /**
-     * Browser name, set at ingestion
-     */
-    browser: string;
-    
-    /**
-     * Browser ver, set at ingestion.
-     */
-    browserVer: string;
-    
-    /**
-     * Language
-     */
-    browserLang: string;
-    
-    /**
-     * User consent, populated to properties bag
-     */
-    userConsent: boolean;
-    
-    /**
-     * Whether event was fired manually, populated to properties bag
-     */
-    isManual: boolean;
-    
-    /**
-     * Screen resolution, populated to properties bag
-     */
-    screenRes: string;
-
-    /**
-     * Current domain. Leverages Window.location.hostname. populated to properties bag
-     */
-    domain: string;
-}

package/src/Interfaces/Contracts/AvailabilityData.ts

@@ -1,57 +0,0 @@
-// // Copyright (c) Microsoft Corporation. All rights reserved.
-// // Licensed under the MIT License.
-
-// // THIS FILE WAS AUTOGENERATED
-// import { Domain } from "./Domain";
-// "use strict";
-
-// /**
-//  * Instances of AvailabilityData represent the result of executing an availability test.
-//  */
-// export class AvailabilityData implements Domain {
-
-//     /**
-//      * Schema version
-//      */
-//     public ver: number = 2;
-
-//     /**
-//      * Identifier of a test run. Use it to correlate steps of test run and telemetry generated by the service.
-//      */
-//     public id: string;
-
-//     /**
-//      * Name of the test that these availability results represent.
-//      */
-//     public name: string;
-
-//     /**
-//      * Duration in format: DD.HH:MM:SS.MMMMMM. Must be less than 1000 days.
-//      */
-//     public duration: string;
-
-//     /**
-//      * Success flag.
-//      */
-//     public success: boolean;
-
-//     /**
-//      * Name of the location where the test was run from.
-//      */
-//     public runLocation: string;
-
-//     /**
-//      * Diagnostic message for the result.
-//      */
-//     public message: string;
-
-//     /**
-//      * Collection of custom properties.
-//      */
-//     public properties: any = {};
-
-//     /**
-//      * Collection of custom measurements.
-//      */
-//     public measurements: any = {};
-// }

package/src/Interfaces/Contracts/ContextTagKeys.ts

@@ -1,299 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-import { createClassFromInterface } from "@microsoft/applicationinsights-core-js";
-
-function _aiNameFunc(baseName: string) {
-    let aiName = "ai." + baseName + ".";
-    return function(name: string) {
-        return aiName + name;
-    }
-}
-
-let _aiApplication = _aiNameFunc("application");
-let _aiDevice = _aiNameFunc("device");
-let _aiLocation = _aiNameFunc("location");
-let _aiOperation = _aiNameFunc("operation");
-let _aiSession = _aiNameFunc("session");
-let _aiUser = _aiNameFunc("user");
-let _aiCloud = _aiNameFunc("cloud");
-let _aiInternal = _aiNameFunc("internal");
-
-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;
-}
-
-export class ContextTagKeys extends createClassFromInterface<IContextTagKeys>({
-    applicationVersion: _aiApplication("ver"),
-    applicationBuild: _aiApplication("build"),
-    applicationTypeId: _aiApplication("typeId"),
-    applicationId: _aiApplication("applicationId"),
-    applicationLayer: _aiApplication("layer"),
-    
-    deviceId: _aiDevice("id"),
-    deviceIp: _aiDevice("ip"),
-    deviceLanguage: _aiDevice("language"),
-    deviceLocale: _aiDevice("locale"),
-    deviceModel: _aiDevice("model"),
-    deviceFriendlyName: _aiDevice("friendlyName"),
-    deviceNetwork: _aiDevice("network"),
-    deviceNetworkName: _aiDevice("networkName"),
-    deviceOEMName: _aiDevice("oemName"),
-    deviceOS: _aiDevice("os"),
-    deviceOSVersion: _aiDevice("osVersion"),
-    deviceRoleInstance: _aiDevice("roleInstance"),
-    deviceRoleName: _aiDevice("roleName"),
-    deviceScreenResolution: _aiDevice("screenResolution"),
-    deviceType: _aiDevice("type"),
-    deviceMachineName: _aiDevice("machineName"),
-    deviceVMName: _aiDevice("vmName"),
-    deviceBrowser: _aiDevice("browser"),
-    deviceBrowserVersion: _aiDevice("browserVersion"),
-    
-    locationIp: _aiLocation("ip"),
-    locationCountry: _aiLocation("country"),
-    locationProvince: _aiLocation("province"),
-    locationCity: _aiLocation("city"),
-    
-    operationId: _aiOperation("id"),
-    operationName: _aiOperation("name"),
-    operationParentId: _aiOperation("parentId"),
-    operationRootId: _aiOperation("rootId"),
-    operationSyntheticSource: _aiOperation("syntheticSource"),
-    operationCorrelationVector: _aiOperation("correlationVector"),
-    
-    sessionId: _aiSession("id"),
-    sessionIsFirst: _aiSession("isFirst"),
-    sessionIsNew: _aiSession("isNew"),
-
-    userAccountAcquisitionDate: _aiUser("accountAcquisitionDate"),
-    userAccountId: _aiUser("accountId"),
-    userAgent: _aiUser("userAgent"),
-    userId: _aiUser("id"),
-    userStoreRegion: _aiUser("storeRegion"),
-    userAuthUserId: _aiUser("authUserId"),
-    userAnonymousUserAcquisitionDate: _aiUser("anonUserAcquisitionDate"),
-    userAuthenticatedUserAcquisitionDate: _aiUser("authUserAcquisitionDate"),
-
-    cloudName: _aiCloud("name"),
-    cloudRole: _aiCloud("role"),
-    cloudRoleVer: _aiCloud("roleVer"),
-    cloudRoleInstance: _aiCloud("roleInstance"),
-    cloudEnvironment: _aiCloud("environment"),
-    cloudLocation: _aiCloud("location"),
-    cloudDeploymentUnit: _aiCloud("deploymentUnit"),
-
-    internalNodeName: _aiInternal("nodeName"),
-    internalSdkVersion: _aiInternal("sdkVersion"),
-    internalAgentVersion: _aiInternal("agentVersion"),
-    internalSnippet: _aiInternal("snippet"),
-    internalSdkSrc: _aiInternal("sdkSrc")
-}) {
-    constructor() {
-        super();
-    }
-}

package/src/Interfaces/Contracts/DataPointType.ts

@@ -1,10 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-/**
- * Type of the metric data measurement.
- */
-export const enum DataPointType {
-    Measurement = 0,
-    Aggregation = 1
-}

package/src/Interfaces/Contracts/DependencyKind.ts

@@ -1,11 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-/**
- * Identifies the type of dependency.
- */
-export const enum DependencyKind {
-    SQL = 0,
-    Http = 1,
-    Other = 2
-}

package/src/Interfaces/Contracts/DependencySourceType.ts

@@ -1,11 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-/**
- * Identifies the source of the dependency.
- */
-export const enum DependencySourceType {
-    Undefined = 0,
-    Aic = 1,
-    Apmc = 2
-}

package/src/Interfaces/Contracts/IBase.ts

@@ -1,13 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-/**
- * 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/src/Interfaces/Contracts/IData.ts

@@ -1,19 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-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;
-}