@microsoft/applicationinsights-common 2.8.0-nightly.2204-04 → 2.8.0-nightly.2204-07

package/types/TelemetryItemCreator.d.ts

@@ -1,4 +1,18 @@
 import { ITelemetryItem, IDiagnosticLogger } 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
@@ -9,9 +23,5 @@ export declare class TelemetryItemCreator {
      * @param systemProperties system properties that are added to the context; part A
      * @returns ITelemetryItem that is sent to channel
      */
-    static create<T>(item: T, baseType: string, envelopeName: string, logger: IDiagnosticLogger, customProperties?: {
-        [key: string]: any;
-    }, systemProperties?: {
-        [key: string]: any;
-    }): ITelemetryItem;
+    static create: typeof createTelemetryItem;
 }

package/types/W3cTraceParent.d.ts

@@ -0,0 +1,59 @@
+import { ITraceParent } from "./Interfaces/ITraceParent";
+/**
+ * Create a new ITraceParent instance using the provided values.
+ * @param traceId - The traceId to use, when invalid a new random W3C id will be generated.
+ * @param spanId - The parent/span id to use, a new random value will be generated if it is invalid.
+ * @param flags - The traceFlags to use, defaults to zero (0) if not supplied or invalid
+ * @param version - The version to used, defaults to version "01" if not supplied or invalid.
+ * @returns
+ */
+export declare function createTraceParent(traceId?: string, spanId?: string, flags?: number, version?: string): ITraceParent;
+/**
+ * Attempt to parse the provided string as a W3C TraceParent header value (https://www.w3.org/TR/trace-context/#traceparent-header)
+ *
+ * @param value
+ * @returns
+ */
+export declare function parseTraceParent(value: string): ITraceParent;
+/**
+ * Is the provided W3c Trace Id a valid string representation, it must be a 32-character string
+ * of lowercase hexadecimal characters for example, 4bf92f3577b34da6a3ce929d0e0e4736.
+ * If all characters as zero (00000000000000000000000000000000) it will be considered an invalid value.
+ * @param value - The W3c trace Id to be validated
+ * @returns true if valid otherwise false
+ */
+export declare function isValidTraceId(value: string): boolean;
+/**
+ * Is the provided W3c span id (aka. parent id) a valid string representation, it must be a 16-character
+ * string of lowercase hexadecimal characters, for example, 00f067aa0ba902b7.
+ * If all characters are zero (0000000000000000) this is considered an invalid value.
+ * @param value - The W3c span id to be validated
+ * @returns true if valid otherwise false
+ */
+export declare function isValidSpanId(value: string): boolean;
+/**
+ * Validates that the provided ITraceParent instance conforms to the currently supported specifications
+ * @param value
+ * @returns
+ */
+export declare function isValidTraceParent(value: ITraceParent): boolean;
+/**
+ * Is the parsed traceParent indicating that the trace is currently sampled.
+ * @param value - The parsed traceParent value
+ * @returns
+ */
+export declare function isSampledFlag(value: ITraceParent): boolean;
+/**
+ * Format the ITraceParent value as a string using the supported and know version formats.
+ * So even if the passed traceParent is a later version the string value returned from this
+ * function will convert it to only the known version formats.
+ * This currently only supports version "00" and invalid "ff"
+ * @param value - The parsed traceParent value
+ * @returns
+ */
+export declare function formatTraceParent(value: ITraceParent): string;
+/**
+ * Helper function to fetch the passed traceparent from the page, looking for it as a meta-tag or a Server-Timing header.
+ * @returns
+ */
+export declare function findW3cTraceParent(): ITraceParent;

package/types/applicationinsights-common.d.ts

@@ -1,7 +1,7 @@
 export { IUtil, Util, ICorrelationIdHelper, CorrelationIdHelper, IDateTimeUtils, DateTimeUtils, dateTimeUtilsNow, dateTimeUtilsDuration, IUrlHelper, UrlHelper, isInternalApplicationInsightsEndpoint } from "./Util";
 export { parseConnectionString, ConnectionStringParser } from "./ConnectionStringParser";
 export { FieldType } from "./Enums";
-export { IRequestHeaders, RequestHeaders } from "./RequestResponseHeaders";
+export { IRequestHeaders, RequestHeaders, eRequestHeaders } from "./RequestResponseHeaders";
 export { DisabledPropertyName, ProcessLegacy, SampleRate, HttpMethod, DEFAULT_BREEZE_ENDPOINT, strNotSpecified } from "./Constants";
 export { IData as AIData } from "./Interfaces/Contracts/IData";
 export { IBase as AIBase } from "./Interfaces/Contracts/IBase";
@@ -24,12 +24,12 @@ export { IPageViewPerformanceTelemetry, IPageViewPerformanceTelemetryInternal }
 export { Trace } from "./Telemetry/Trace";
 export { PageViewPerformance } from "./Telemetry/PageViewPerformance";
 export { Data } from "./Telemetry/Common/Data";
-export { SeverityLevel } from "./Interfaces/Contracts/SeverityLevel";
+export { eSeverityLevel, SeverityLevel } from "./Interfaces/Contracts/SeverityLevel";
 export { IConfig, ConfigurationManager } from "./Interfaces/IConfig";
 export { IChannelControlsAI } from "./Interfaces/IChannelControlsAI";
 export { IContextTagKeys, ContextTagKeys } from "./Interfaces/Contracts/ContextTagKeys";
 export { DataSanitizerValues, IDataSanitizer, DataSanitizer, dataSanitizeKeyAndAddUniqueness, dataSanitizeKey, dataSanitizeString, dataSanitizeUrl, dataSanitizeMessage, dataSanitizeException, dataSanitizeProperties, dataSanitizeMeasurements, dataSanitizeId, dataSanitizeInput, dsPadNumber } from "./Telemetry/Common/DataSanitizer";
-export { TelemetryItemCreator } from "./TelemetryItemCreator";
+export { TelemetryItemCreator, createTelemetryItem } from "./TelemetryItemCreator";
 export { ICorrelationConfig } from "./Interfaces/ICorrelationConfig";
 export { IAppInsights } from "./Interfaces/IAppInsights";
 export { IWeb } from "./Interfaces/Context/IWeb";
@@ -52,6 +52,8 @@ export { isBeaconsSupported as isBeaconApiSupported } from "@microsoft/applicati
 export { createDomEvent } from "./DomHelperFuncs";
 export { utlDisableStorage, utlEnableStorage, utlCanUseLocalStorage, utlGetLocalStorage, utlSetLocalStorage, utlRemoveStorage, utlCanUseSessionStorage, utlGetSessionStorageKeys, utlGetSessionStorage, utlSetSessionStorage, utlRemoveSessionStorage } from "./StorageHelperFuncs";
 export { urlParseUrl, urlGetAbsoluteUrl, urlGetPathName, urlGetCompleteUrl, urlParseHost, urlParseFullHost } from "./UrlHelperFuncs";
+export { ITraceParent } from "./Interfaces/ITraceParent";
+export { createTraceParent, parseTraceParent, isValidTraceId, isValidSpanId, isValidTraceParent, isSampledFlag, formatTraceParent, findW3cTraceParent } from "./W3cTraceParent";
 export declare const PropertiesPluginIdentifier = "AppInsightsPropertiesPlugin";
 export declare const BreezeChannelIdentifier = "AppInsightsChannelPlugin";
 export declare const AnalyticsPluginIdentifier = "ApplicationInsightsAnalytics";