@microsoft/applicationinsights-common 2.8.4-nightly.2205-08 → 2.8.4

package/package.json

@@ -1,57 +1,54 @@
-{
-    "name": "@microsoft/applicationinsights-common",
-    "version": "2.8.4-nightly.2205-08",
-    "description": "Microsoft Application Insights Common JavaScript Library",
-    "homepage": "https://github.com/microsoft/ApplicationInsights-JS#readme",
-    "author": "Microsoft Application Insights Team",
-    "main": "./dist/applicationinsights-common.js",
-    "module": "./dist-esm/applicationinsights-common.js",
-    "types": "./types/applicationinsights-common.d.ts",
-    "sideEffects": false,
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/microsoft/ApplicationInsights-JS/tree/master/shared/AppInsightsCommon"
-    },
-    "scripts": {
-        "build": "npm run build:esm && npm run build:browser && npm run sri && npm run dtsgen",
-        "build:esm": "grunt common",
-        "build:browser": "rollup -c",
-        "rebuild": "npm run build",
-        "test": "grunt commontest",
-        "lint": "tslint -p tsconfig.json",
-        "dtsgen": "api-extractor run --local && node ../../scripts/dtsgen.js \"Microsoft Application Insights Common JavaScript Library\"",
-        "sri": "node ../../tools/subResourceIntegrity/generateIntegrityFile.js"
-    },
-    "devDependencies": {
-        "@microsoft/ai-test-framework": "0.0.1",
-        "@microsoft/applicationinsights-rollup-plugin-uglify3-js": "1.0.0",
-        "@microsoft/applicationinsights-rollup-es3": "1.1.3",
-        "@microsoft/api-extractor": "^7.18.1",
-        "grunt": "^1.5.3",
-        "grunt-cli": "^1.4.3",
-        "grunt-contrib-qunit": "^5.0.1",
-        "@nevware21/grunt-ts-plugin": "^0.4.3",
-        "@nevware21/grunt-eslint-ts": "^0.2.2",
-        "@rollup/plugin-commonjs": "^18.0.0",
-        "@rollup/plugin-node-resolve": "^11.2.1",
-        "@rollup/plugin-replace": "^2.3.3",
-        "rollup-plugin-cleanup": "^3.2.1",
-        "rollup": "^2.32.0",
-        "typescript": "^4.3.4",
-        "tslib": "^2.0.0",
-        "globby": "^11.0.0",
-        "magic-string": "^0.25.7"
-    },
-    "peerDependencies": {
-        "tslib": "*"
-    },
-    "dependencies": {
-        "@microsoft/applicationinsights-shims": "2.0.1",
-        "@microsoft/applicationinsights-core-js": "2.8.4-nightly.2205-08",
-        "@microsoft/dynamicproto-js": "^1.1.6"
-    },
-    "license": "MIT",
-    "publishConfig": {
-        "tag": "nightly"
-    }
-}
+{
+    "name": "@microsoft/applicationinsights-common",
+    "version": "2.8.4",
+    "description": "Microsoft Application Insights Common JavaScript Library",
+    "homepage": "https://github.com/microsoft/ApplicationInsights-JS#readme",
+    "author": "Microsoft Application Insights Team",
+    "main": "./dist/applicationinsights-common.js",
+    "module": "./dist-esm/applicationinsights-common.js",
+    "types": "./types/applicationinsights-common.d.ts",
+    "sideEffects": false,
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/microsoft/ApplicationInsights-JS/tree/master/shared/AppInsightsCommon"
+    },
+    "scripts": {
+        "build": "npm run build:esm && npm run build:browser && npm run sri && npm run dtsgen",
+        "build:esm": "grunt common",
+        "build:browser": "rollup -c",
+        "rebuild": "npm run build",
+        "test": "grunt commontest",
+        "lint": "tslint -p tsconfig.json",
+        "dtsgen": "api-extractor run --local && node ../../scripts/dtsgen.js \"Microsoft Application Insights Common JavaScript Library\"",
+        "sri": "node ../../tools/subResourceIntegrity/generateIntegrityFile.js"
+    },
+    "devDependencies": {
+        "@microsoft/ai-test-framework": "0.0.1",
+        "@microsoft/applicationinsights-rollup-plugin-uglify3-js": "1.0.0",
+        "@microsoft/applicationinsights-rollup-es3": "1.1.3",
+        "@microsoft/api-extractor": "^7.18.1",
+        "grunt": "^1.5.3",
+        "grunt-cli": "^1.4.3",
+        "grunt-contrib-qunit": "^5.0.1",
+        "@nevware21/grunt-ts-plugin": "^0.4.3",
+        "@nevware21/grunt-eslint-ts": "^0.2.2",
+        "@rollup/plugin-commonjs": "^18.0.0",
+        "@rollup/plugin-node-resolve": "^11.2.1",
+        "@rollup/plugin-replace": "^2.3.3",
+        "rollup-plugin-cleanup": "^3.2.1",
+        "rollup": "^2.32.0",
+        "typescript": "^4.3.4",
+        "tslib": "^2.0.0",
+        "globby": "^11.0.0",
+        "magic-string": "^0.25.7"
+    },
+    "peerDependencies": {
+        "tslib": "*"
+    },
+    "dependencies": {
+        "@microsoft/applicationinsights-shims": "2.0.1",
+        "@microsoft/applicationinsights-core-js": "2.8.4",
+        "@microsoft/dynamicproto-js": "^1.1.6"
+    },
+    "license": "MIT"
+}

package/src/Interfaces/Context/ITelemetryTrace.ts

@@ -13,10 +13,16 @@ export interface ITelemetryTrace {
     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
      */

package/src/Util.ts

@@ -9,8 +9,8 @@ import {
     dateNow, uaDisallowsSameSiteNone, disableCookies as coreDisableCookies,
     canUseCookies as coreCanUseCookies, getCookie as coreGetCookie,
     setCookie as coreSetCookie, deleteCookie as coreDeleteCookie,
-    isBeaconsSupported,
-    arrIndexOf
+    isBeaconsSupported, arrIndexOf, IDistributedTraceContext,
+    isValidTraceId, isValidSpanId
 } from "@microsoft/applicationinsights-core-js";
 import { eRequestHeaders, RequestHeaders } from "./RequestResponseHeaders";
 import { dataSanitizeString } from "./Telemetry/Common/DataSanitizer";
@@ -20,6 +20,7 @@ import { stringToBoolOrDefault, msToTimeSpan, isCrossOriginError, getExtensionBy
 import { strNotSpecified } from "./Constants";
 import { utlCanUseLocalStorage, utlCanUseSessionStorage, utlDisableStorage, utlGetSessionStorage, utlGetSessionStorageKeys, utlGetLocalStorage, utlRemoveSessionStorage, utlRemoveStorage, utlSetSessionStorage, utlSetLocalStorage } from "./StorageHelperFuncs";
 import { urlGetAbsoluteUrl, urlGetCompleteUrl, urlGetPathName, urlParseFullHost, urlParseHost, urlParseUrl } from "./UrlHelperFuncs";
+import { ITelemetryTrace } from "./Interfaces/Context/ITelemetryTrace";
 
 // listing only non-geo specific locations
 const _internalEndpoints: string[] = [
@@ -489,3 +490,49 @@ export const DateTimeUtils: IDateTimeUtils = {
     Now: dateTimeUtilsNow,
     GetDuration: dateTimeUtilsDuration
 };
+
+
+/**
+ * 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 function createDistributedTraceContextFromTrace(telemetryTrace?: ITelemetryTrace, parentCtx?: IDistributedTraceContext): IDistributedTraceContext {
+    let trace: ITelemetryTrace = telemetryTrace || {};
+
+    return {
+        getName: (): string => {
+            return trace.name;
+        },
+        setName: (newValue: string): void => {
+            parentCtx && parentCtx.setName(newValue);
+            trace.name = newValue;
+        },
+        getTraceId: (): string => {
+            return trace.traceID;
+        },
+        setTraceId: (newValue: string): void => {
+            parentCtx && parentCtx.setTraceId(newValue);
+            if (isValidTraceId(newValue)) {
+                trace.traceID = newValue
+            }
+        },
+        getSpanId: (): string => {
+            return trace.parentID;
+        },
+        setSpanId: (newValue: string): void => {
+            parentCtx && parentCtx.setSpanId(newValue);
+            if (isValidSpanId(newValue)) {
+                trace.parentID = newValue
+            }
+        },
+        getTraceFlags: (): number => {
+            return trace.traceFlags;
+        },
+        setTraceFlags: (newTraceFlags?: number): void => {
+            parentCtx && parentCtx.setTraceFlags(newTraceFlags);
+            trace.traceFlags = newTraceFlags
+        }
+    };
+}

package/src/applicationinsights-common.ts

@@ -3,7 +3,8 @@
 export {
     IUtil, Util, ICorrelationIdHelper, CorrelationIdHelper,
     IDateTimeUtils, DateTimeUtils, dateTimeUtilsNow, dateTimeUtilsDuration,
-    IUrlHelper, UrlHelper, isInternalApplicationInsightsEndpoint
+    IUrlHelper, UrlHelper, isInternalApplicationInsightsEndpoint,
+    createDistributedTraceContextFromTrace
 } from "./Util";
 export { parseConnectionString, ConnectionStringParser } from "./ConnectionStringParser";
 export { FieldType } from "./Enums";
@@ -59,17 +60,16 @@ export { ITelemetryTrace, ITraceState } from "./Interfaces/Context/ITelemetryTra
 export { IRequestContext } from "./Interfaces/IRequestContext";
 export { eDistributedTracingModes, DistributedTracingModes } from "./Enums";
 export { stringToBoolOrDefault, msToTimeSpan, getExtensionByName, isCrossOriginError } from "./HelperFuncs";
-export { isBeaconsSupported as isBeaconApiSupported } from "@microsoft/applicationinsights-core-js"
+export {
+    isBeaconsSupported as isBeaconApiSupported,
+    ITraceParent, createTraceParent, parseTraceParent, isValidTraceId, isValidSpanId, isValidTraceParent, isSampledFlag, formatTraceParent, findW3cTraceParent
+} from "@microsoft/applicationinsights-core-js"
 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 const PropertiesPluginIdentifier = "AppInsightsPropertiesPlugin";
 export const BreezeChannelIdentifier = "AppInsightsChannelPlugin";

package/types/Interfaces/Context/ITelemetryTrace.d.ts

@@ -8,9 +8,14 @@ export interface ITelemetryTrace {
      */
     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
      */

package/types/Util.d.ts

@@ -1,5 +1,6 @@
-import { IDiagnosticLogger, IPlugin } from "@microsoft/applicationinsights-core-js";
+import { IDiagnosticLogger, IPlugin, IDistributedTraceContext } from "@microsoft/applicationinsights-core-js";
 import { ICorrelationConfig } from "./Interfaces/ICorrelationConfig";
+import { ITelemetryTrace } from "./Interfaces/Context/ITelemetryTrace";
 export declare function isInternalApplicationInsightsEndpoint(endpointUrl: string): boolean;
 export interface IUtil {
     NotSpecified: string;
@@ -219,3 +220,10 @@ export interface IDateTimeUtils {
  * A utility class that helps getting time related parameters
  */
 export declare const DateTimeUtils: IDateTimeUtils;
+/**
+ * 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/applicationinsights-common.d.ts

@@ -1,4 +1,4 @@
-export { IUtil, Util, ICorrelationIdHelper, CorrelationIdHelper, IDateTimeUtils, DateTimeUtils, dateTimeUtilsNow, dateTimeUtilsDuration, IUrlHelper, UrlHelper, isInternalApplicationInsightsEndpoint } from "./Util";
+export { IUtil, Util, ICorrelationIdHelper, CorrelationIdHelper, IDateTimeUtils, DateTimeUtils, dateTimeUtilsNow, dateTimeUtilsDuration, IUrlHelper, UrlHelper, isInternalApplicationInsightsEndpoint, createDistributedTraceContextFromTrace } from "./Util";
 export { parseConnectionString, ConnectionStringParser } from "./ConnectionStringParser";
 export { FieldType } from "./Enums";
 export { IRequestHeaders, RequestHeaders, eRequestHeaders } from "./RequestResponseHeaders";
@@ -48,12 +48,10 @@ export { ITelemetryTrace, ITraceState } from "./Interfaces/Context/ITelemetryTra
 export { IRequestContext } from "./Interfaces/IRequestContext";
 export { eDistributedTracingModes, DistributedTracingModes } from "./Enums";
 export { stringToBoolOrDefault, msToTimeSpan, getExtensionByName, isCrossOriginError } from "./HelperFuncs";
-export { isBeaconsSupported as isBeaconApiSupported } from "@microsoft/applicationinsights-core-js";
+export { isBeaconsSupported as isBeaconApiSupported, ITraceParent, createTraceParent, parseTraceParent, isValidTraceId, isValidSpanId, isValidTraceParent, isSampledFlag, formatTraceParent, findW3cTraceParent } from "@microsoft/applicationinsights-core-js";
 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";

package/types/tsdoc-metadata.json

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

package/dist-esm/Interfaces/ITraceParent.js

@@ -1,8 +0,0 @@
-/*
- * Application Insights JavaScript SDK - Common, 2.8.4-nightly.2205-08
- * Copyright (c) Microsoft and contributors. All rights reserved.
- */
-
-
-export {};
-//# sourceMappingURL=ITraceParent.js.map

package/dist-esm/Interfaces/ITraceParent.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ITraceParent.js.map","sources":["ITraceParent.js"],"sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved.\r\n// Licensed under the MIT License.\r\nexport {};\r\n//# sourceMappingURL=ITraceParent.js.map"],"names":[],"mappings":";;;;AAA4D;AAC1B;AAClC;AACA"}

package/dist-esm/W3cTraceParent.js

@@ -1,192 +0,0 @@
-/*
- * Application Insights JavaScript SDK - Common, 2.8.4-nightly.2205-08
- * Copyright (c) Microsoft and contributors. All rights reserved.
- */
-import { generateW3CId, getDocument, getPerformance, isArray, isString, strTrim } from "@microsoft/applicationinsights-core-js";
-// using {0,16} for leading and trailing whitespace just to constrain the possible runtime of a random string
-var TRACE_PARENT_REGEX = /^([\da-f]{2})-([\da-f]{32})-([\da-f]{16})-([\da-f]{2})(-[^\s]*)?$/;
-var DEFAULT_VERSION = "00";
-var INVALID_VERSION = "ff";
-var INVALID_TRACE_ID = "00000000000000000000000000000000";
-var INVALID_SPAN_ID = "0000000000000000";
-var SAMPLED_FLAG = 0x01;
-function _isValid(value, len, invalidValue) {
-    if (value && value.length === len && value !== invalidValue) {
-        return !!value.match(/^[\da-f]*$/);
-    }
-    return false;
-}
-function _formatValue(value, len, defValue) {
-    if (_isValid(value, len)) {
-        return value;
-    }
-    return defValue;
-}
-function _formatFlags(value) {
-    if (isNaN(value) || value < 0 || value > 255) {
-        value = 0x01;
-    }
-    var result = value.toString(16);
-    while (result.length < 2) {
-        result = "0" + result;
-    }
-    return result;
-}
-function _getTraceParentValue(values) {
-    if (values) {
-        for (var i = 0; i < values.length; i++) {
-            var value = values[i];
-            if (value.name) {
-                if (value.name === "traceparent") {
-                    return value;
-                }
-            }
-        }
-    }
-    return {};
-}
-/**
- * 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 function createTraceParent(traceId, spanId, flags, version) {
-    return {
-        version: _isValid(version, 2, INVALID_VERSION) ? version : DEFAULT_VERSION,
-        traceId: isValidTraceId(traceId) ? traceId : generateW3CId(),
-        spanId: isValidSpanId(spanId) ? spanId : generateW3CId().substr(0, 16),
-        traceFlags: flags >= 0 && flags <= 0xFF ? flags : 1
-    };
-}
-/**
- * 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 function parseTraceParent(value) {
-    if (!value) {
-        // Don't pass a null/undefined or empty string
-        return null;
-    }
-    if (isArray(value)) {
-        // The value may have been encoded on the page into an array so handle this automatically
-        value = value[0] || "";
-    }
-    if (!value || !isString(value) || value.length > 8192) {
-        // limit potential processing based on total length
-        return null;
-    }
-    // See https://www.w3.org/TR/trace-context/#versioning-of-traceparent
-    var match = TRACE_PARENT_REGEX.exec(strTrim(value));
-    if (!match || // No match
-        match[1] === INVALID_VERSION || // version ff is forbidden
-        match[2] === INVALID_TRACE_ID || // All zeros is considered to be invalid
-        match[3] === INVALID_SPAN_ID) { // All zeros is considered to be invalid
-        return null;
-    }
-    return {
-        version: match[1],
-        traceId: match[2],
-        spanId: match[3],
-        traceFlags: parseInt(match[4], 16)
-    };
-}
-/**
- * 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 function isValidTraceId(value) {
-    return _isValid(value, 32, INVALID_TRACE_ID);
-}
-/**
- * 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 function isValidSpanId(value) {
-    return _isValid(value, 16, INVALID_SPAN_ID);
-}
-/**
- * Validates that the provided ITraceParent instance conforms to the currently supported specifications
- * @param value
- * @returns
- */
-export function isValidTraceParent(value) {
-    if (!value ||
-        !_isValid(value.version, 2, INVALID_VERSION) ||
-        !_isValid(value.traceId, 32, INVALID_TRACE_ID) ||
-        !_isValid(value.spanId, 16, INVALID_SPAN_ID) ||
-        !_isValid(_formatFlags(value.traceFlags), 2)) {
-        // Each known field must contain a valid value
-        return false;
-    }
-    return true;
-}
-/**
- * Is the parsed traceParent indicating that the trace is currently sampled.
- * @param value - The parsed traceParent value
- * @returns
- */
-export function isSampledFlag(value) {
-    if (isValidTraceParent(value)) {
-        return (value.traceFlags & SAMPLED_FLAG) === SAMPLED_FLAG;
-    }
-    return false;
-}
-/**
- * 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 function formatTraceParent(value) {
-    if (value) {
-        // Special Note: This only supports formatting as version 00, future versions should encode any known supported version
-        // So parsing a future version will populate the correct version value but reformatting will reduce it to version 00.
-        var flags = _formatFlags(value.traceFlags);
-        if (!_isValid(flags, 2)) {
-            flags = "01";
-        }
-        var version = value.version || DEFAULT_VERSION;
-        if (version !== "00" && version !== "ff") {
-            // Reduce version to "00"
-            version = DEFAULT_VERSION;
-        }
-        // Format as version 00
-        return "".concat(version, "-").concat(_formatValue(value.traceId, 32, INVALID_TRACE_ID), "-").concat(_formatValue(value.spanId, 16, INVALID_SPAN_ID), "-").concat(flags);
-    }
-    return "";
-}
-/**
- * Helper function to fetch the passed traceparent from the page, looking for it as a meta-tag or a Server-Timing header.
- * @returns
- */
-export function findW3cTraceParent() {
-    var traceParent;
-    var doc = getDocument();
-    if (doc) {
-        // Look for a meta-tag called "traceparent"
-        traceParent = parseTraceParent(_getTraceParentValue(doc.querySelectorAll("meta")).content);
-    }
-    if (!traceParent) {
-        var perf = getPerformance();
-        if (perf) {
-            // Try looking for a server-timing header
-            var navPerf = perf.getEntriesByType("navigation") || [];
-            traceParent = parseTraceParent(_getTraceParentValue((navPerf.length > 0 ? navPerf[0] : {}).serverTiming).description);
-        }
-    }
-    return traceParent;
-}
-//# sourceMappingURL=W3cTraceParent.js.map

package/dist-esm/W3cTraceParent.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"W3cTraceParent.js.map","sources":["W3cTraceParent.js"],"sourcesContent":["import { generateW3CId, getDocument, getPerformance, isArray, isString, strTrim } from \"@microsoft/applicationinsights-core-js\";\r\n// using {0,16} for leading and trailing whitespace just to constrain the possible runtime of a random string\r\nvar TRACE_PARENT_REGEX = /^([\\da-f]{2})-([\\da-f]{32})-([\\da-f]{16})-([\\da-f]{2})(-[^\\s]*)?$/;\r\nvar DEFAULT_VERSION = \"00\";\r\nvar INVALID_VERSION = \"ff\";\r\nvar INVALID_TRACE_ID = \"00000000000000000000000000000000\";\r\nvar INVALID_SPAN_ID = \"0000000000000000\";\r\nvar SAMPLED_FLAG = 0x01;\r\nfunction _isValid(value, len, invalidValue) {\r\n    if (value && value.length === len && value !== invalidValue) {\r\n        return !!value.match(/^[\\da-f]*$/);\r\n    }\r\n    return false;\r\n}\r\nfunction _formatValue(value, len, defValue) {\r\n    if (_isValid(value, len)) {\r\n        return value;\r\n    }\r\n    return defValue;\r\n}\r\nfunction _formatFlags(value) {\r\n    if (isNaN(value) || value < 0 || value > 255) {\r\n        value = 0x01;\r\n    }\r\n    var result = value.toString(16);\r\n    while (result.length < 2) {\r\n        result = \"0\" + result;\r\n    }\r\n    return result;\r\n}\r\nfunction _getTraceParentValue(values) {\r\n    if (values) {\r\n        for (var i = 0; i < values.length; i++) {\r\n            var value = values[i];\r\n            if (value.name) {\r\n                if (value.name === \"traceparent\") {\r\n                    return value;\r\n                }\r\n            }\r\n        }\r\n    }\r\n    return {};\r\n}\r\n/**\r\n * Create a new ITraceParent instance using the provided values.\r\n * @param traceId - The traceId to use, when invalid a new random W3C id will be generated.\r\n * @param spanId - The parent/span id to use, a new random value will be generated if it is invalid.\r\n * @param flags - The traceFlags to use, defaults to zero (0) if not supplied or invalid\r\n * @param version - The version to used, defaults to version \"01\" if not supplied or invalid.\r\n * @returns\r\n */\r\nexport function createTraceParent(traceId, spanId, flags, version) {\r\n    return {\r\n        version: _isValid(version, 2, INVALID_VERSION) ? version : DEFAULT_VERSION,\r\n        traceId: isValidTraceId(traceId) ? traceId : generateW3CId(),\r\n        spanId: isValidSpanId(spanId) ? spanId : generateW3CId().substr(0, 16),\r\n        traceFlags: flags >= 0 && flags <= 0xFF ? flags : 1\r\n    };\r\n}\r\n/**\r\n * Attempt to parse the provided string as a W3C TraceParent header value (https://www.w3.org/TR/trace-context/#traceparent-header)\r\n *\r\n * @param value\r\n * @returns\r\n */\r\nexport function parseTraceParent(value) {\r\n    if (!value) {\r\n        // Don't pass a null/undefined or empty string\r\n        return null;\r\n    }\r\n    if (isArray(value)) {\r\n        // The value may have been encoded on the page into an array so handle this automatically\r\n        value = value[0] || \"\";\r\n    }\r\n    if (!value || !isString(value) || value.length > 8192) {\r\n        // limit potential processing based on total length\r\n        return null;\r\n    }\r\n    // See https://www.w3.org/TR/trace-context/#versioning-of-traceparent\r\n    var match = TRACE_PARENT_REGEX.exec(strTrim(value));\r\n    if (!match || // No match\r\n        match[1] === INVALID_VERSION || // version ff is forbidden\r\n        match[2] === INVALID_TRACE_ID || // All zeros is considered to be invalid\r\n        match[3] === INVALID_SPAN_ID) { // All zeros is considered to be invalid\r\n        return null;\r\n    }\r\n    return {\r\n        version: match[1],\r\n        traceId: match[2],\r\n        spanId: match[3],\r\n        traceFlags: parseInt(match[4], 16)\r\n    };\r\n}\r\n/**\r\n * Is the provided W3c Trace Id a valid string representation, it must be a 32-character string\r\n * of lowercase hexadecimal characters for example, 4bf92f3577b34da6a3ce929d0e0e4736.\r\n * If all characters as zero (00000000000000000000000000000000) it will be considered an invalid value.\r\n * @param value - The W3c trace Id to be validated\r\n * @returns true if valid otherwise false\r\n */\r\nexport function isValidTraceId(value) {\r\n    return _isValid(value, 32, INVALID_TRACE_ID);\r\n}\r\n/**\r\n * Is the provided W3c span id (aka. parent id) a valid string representation, it must be a 16-character\r\n * string of lowercase hexadecimal characters, for example, 00f067aa0ba902b7.\r\n * If all characters are zero (0000000000000000) this is considered an invalid value.\r\n * @param value - The W3c span id to be validated\r\n * @returns true if valid otherwise false\r\n */\r\nexport function isValidSpanId(value) {\r\n    return _isValid(value, 16, INVALID_SPAN_ID);\r\n}\r\n/**\r\n * Validates that the provided ITraceParent instance conforms to the currently supported specifications\r\n * @param value\r\n * @returns\r\n */\r\nexport function isValidTraceParent(value) {\r\n    if (!value ||\r\n        !_isValid(value.version, 2, INVALID_VERSION) ||\r\n        !_isValid(value.traceId, 32, INVALID_TRACE_ID) ||\r\n        !_isValid(value.spanId, 16, INVALID_SPAN_ID) ||\r\n        !_isValid(_formatFlags(value.traceFlags), 2)) {\r\n        // Each known field must contain a valid value\r\n        return false;\r\n    }\r\n    return true;\r\n}\r\n/**\r\n * Is the parsed traceParent indicating that the trace is currently sampled.\r\n * @param value - The parsed traceParent value\r\n * @returns\r\n */\r\nexport function isSampledFlag(value) {\r\n    if (isValidTraceParent(value)) {\r\n        return (value.traceFlags & SAMPLED_FLAG) === SAMPLED_FLAG;\r\n    }\r\n    return false;\r\n}\r\n/**\r\n * Format the ITraceParent value as a string using the supported and know version formats.\r\n * So even if the passed traceParent is a later version the string value returned from this\r\n * function will convert it to only the known version formats.\r\n * This currently only supports version \"00\" and invalid \"ff\"\r\n * @param value - The parsed traceParent value\r\n * @returns\r\n */\r\nexport function formatTraceParent(value) {\r\n    if (value) {\r\n        // Special Note: This only supports formatting as version 00, future versions should encode any known supported version\r\n        // So parsing a future version will populate the correct version value but reformatting will reduce it to version 00.\r\n        var flags = _formatFlags(value.traceFlags);\r\n        if (!_isValid(flags, 2)) {\r\n            flags = \"01\";\r\n        }\r\n        var version = value.version || DEFAULT_VERSION;\r\n        if (version !== \"00\" && version !== \"ff\") {\r\n            // Reduce version to \"00\"\r\n            version = DEFAULT_VERSION;\r\n        }\r\n        // Format as version 00\r\n        return \"\".concat(version, \"-\").concat(_formatValue(value.traceId, 32, INVALID_TRACE_ID), \"-\").concat(_formatValue(value.spanId, 16, INVALID_SPAN_ID), \"-\").concat(flags);\r\n    }\r\n    return \"\";\r\n}\r\n/**\r\n * Helper function to fetch the passed traceparent from the page, looking for it as a meta-tag or a Server-Timing header.\r\n * @returns\r\n */\r\nexport function findW3cTraceParent() {\r\n    var traceParent;\r\n    var doc = getDocument();\r\n    if (doc) {\r\n        // Look for a meta-tag called \"traceparent\"\r\n        traceParent = parseTraceParent(_getTraceParentValue(doc.querySelectorAll(\"meta\")).content);\r\n    }\r\n    if (!traceParent) {\r\n        var perf = getPerformance();\r\n        if (perf) {\r\n            // Try looking for a server-timing header\r\n            var navPerf = perf.getEntriesByType(\"navigation\") || [];\r\n            traceParent = parseTraceParent(_getTraceParentValue((navPerf.length > 0 ? navPerf[0] : {}).serverTiming).description);\r\n        }\r\n    }\r\n    return traceParent;\r\n}\r\n//# sourceMappingURL=W3cTraceParent.js.map"],"names":[],"mappings":";;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA"}

package/src/Interfaces/ITraceParent.ts

@@ -1,38 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-/**
- * This interface represents the components of a W3C traceparent header
- */
-export interface ITraceParent {
-    /**
-     * The version of the definition, this MUST be a string with a length of 2 and only contain lowercase
-     * hexadecimal characters. A value of 'ff' is considered to be an invalid version.
-     */
-    version: string;
-
-    /**
-     * This is the ID of the whole trace forest and is used to uniquely identify a distributed trace
-     * through a system. It is represented as a 32-character string of lowercase hexadecimal characters,
-     * for example, 4bf92f3577b34da6a3ce929d0e0e4736.
-     * All characters as zero (00000000000000000000000000000000) is considered an invalid value.
-     */
-    traceId: string;
-
-    /**
-     * This is the ID of the current request as known by the caller (in some tracing systems, this is also
-     * known as the parent-id, where a span is the execution of a client request). It is represented as an
-     * 16-character string of lowercase hexadecimal characters, for example, 00f067aa0ba902b7.
-     * All bytes as zero (0000000000000000) is considered an invalid value.
-     */
-    spanId: string;
-
-    /**
-     * An 8-bit value of flags that controls tracing such as sampling, trace level, etc. These flags are
-     * recommendations given by the caller rather than strict rules to follow.
-     * As this is a bit field, you cannot interpret flags by decoding the hex value and looking at the resulting
-     * number. For example, a flag 00000001 could be encoded as 01 in hex, or 09 in hex if present with the flag
-     * 00001000. A common mistake in bit fields is forgetting to mask when interpreting flags.
-     */
-    traceFlags: number;
-}