@microsoft/applicationinsights-common 3.4.0-nightlybeta3.2602-27 → 3.4.1

package/dist-es5/applicationinsights-common.js

@@ -1,5 +1,5 @@
 /*
- * Application Insights JavaScript SDK - Common, 3.4.0-nightlybeta3.2602-27
+ * Application Insights JavaScript SDK - Common, 3.4.1
  * Copyright (c) Microsoft and contributors. All rights reserved.
  */
 

package/package.json

@@ -1,65 +1,62 @@
-{
-    "name": "@microsoft/applicationinsights-common",
-    "version": "3.4.0-nightlybeta3.2602-27",
-    "description": "Microsoft Application Insights Common JavaScript Library",
-    "homepage": "https://github.com/microsoft/ApplicationInsights-JS#readme",
-    "author": "Microsoft Application Insights Team",
-    "main": "dist/es5/applicationinsights-common.js",
-    "module": "dist-es5/applicationinsights-common.js",
-    "types": "types/applicationinsights-common.d.ts",
-    "sideEffects": false,
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/microsoft/ApplicationInsights-JS/tree/main/shared/AppInsightsCommon"
-    },
-    "scripts": {
-        "clean": "git clean -xdf",
-        "build": "npm run build:esm && npm run build:browser && npm run sri && npm run dtsgen",
-        "build:esm": "grunt common",
-        "build:browser": "rollup -c rollup.config.js --bundleConfigAsCjs",
-        "rebuild": "npm run build",
-        "test": "",
-        "mintest": "",
-        "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",
-        "ai-min": "grunt common-min",
-        "ai-restore": "grunt common-restore",
-        "npm-pack": "npm pack",
-        "api-docs": "typedoc"
-    },
-    "devDependencies": {
-        "@microsoft/applicationinsights-rollup-plugin-uglify3-js": "1.0.0",
-        "@microsoft/applicationinsights-rollup-es5": "1.0.2",
-        "@microsoft/api-extractor": "^7.40.0",
-        "grunt": "^1.6.1",
-        "grunt-cli": "^1.5.0",
-        "@nevware21/grunt-ts-plugin": "^0.5.1",
-        "@nevware21/grunt-eslint-ts": "^0.5.1",
-        "@rollup/plugin-commonjs": "^24.0.0",
-        "@rollup/plugin-node-resolve": "^15.0.1",
-        "@rollup/plugin-replace": "^5.0.2",
-        "rollup": "^3.20.0",
-        "rollup-plugin-cleanup": "^3.2.1",
-        "rollup-plugin-sourcemaps": "^0.6.3",
-        "typescript": "^4.9.3",
-        "tslib": "^2.0.0",
-        "typedoc": "^0.26.6",
-        "globby": "^11.0.0",
-        "magic-string": "^0.25.7",
-        "sinon": "^7.3.1"
-    },
-    "peerDependencies": {
-        "tslib": ">= 1.0.0"
-    },
-    "dependencies": {
-        "@microsoft/applicationinsights-shims": "3.0.1",
-        "@microsoft/applicationinsights-core-js": "3.4.0-nightlybeta3.2602-27",
-        "@microsoft/dynamicproto-js": "^2.0.3",
-        "@nevware21/ts-utils": ">= 0.12.6 < 2.x"
-    },
-    "license": "MIT",
-    "publishConfig": {
-        "tag": "nightlybeta3"
-    }
-}
+{
+    "name": "@microsoft/applicationinsights-common",
+    "version": "3.4.1",
+    "description": "Microsoft Application Insights Common JavaScript Library",
+    "homepage": "https://github.com/microsoft/ApplicationInsights-JS#readme",
+    "author": "Microsoft Application Insights Team",
+    "main": "dist/es5/applicationinsights-common.js",
+    "module": "dist-es5/applicationinsights-common.js",
+    "types": "types/applicationinsights-common.d.ts",
+    "sideEffects": false,
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/microsoft/ApplicationInsights-JS/tree/main/shared/AppInsightsCommon"
+    },
+    "scripts": {
+        "clean": "git clean -xdf",
+        "build": "npm run build:esm && npm run build:browser && npm run sri && npm run dtsgen",
+        "build:esm": "grunt common",
+        "build:browser": "rollup -c rollup.config.js --bundleConfigAsCjs",
+        "rebuild": "npm run build",
+        "test": "",
+        "mintest": "",
+        "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",
+        "ai-min": "grunt common-min",
+        "ai-restore": "grunt common-restore",
+        "npm-pack": "npm pack",
+        "api-docs": "typedoc"
+    },
+    "devDependencies": {
+        "@microsoft/applicationinsights-rollup-plugin-uglify3-js": "1.0.0",
+        "@microsoft/applicationinsights-rollup-es5": "1.0.2",
+        "@microsoft/api-extractor": "^7.40.0",
+        "grunt": "^1.6.1",
+        "grunt-cli": "^1.5.0",
+        "@nevware21/grunt-ts-plugin": "^0.5.1",
+        "@nevware21/grunt-eslint-ts": "^0.5.1",
+        "@rollup/plugin-commonjs": "^24.0.0",
+        "@rollup/plugin-node-resolve": "^15.0.1",
+        "@rollup/plugin-replace": "^5.0.2",
+        "rollup": "^3.20.0",
+        "rollup-plugin-cleanup": "^3.2.1",
+        "rollup-plugin-sourcemaps": "^0.6.3",
+        "typescript": "^4.9.3",
+        "tslib": "^2.0.0",
+        "typedoc": "^0.26.6",
+        "globby": "^11.0.0",
+        "magic-string": "^0.25.7",
+        "sinon": "^7.3.1"
+    },
+    "peerDependencies": {
+        "tslib": ">= 1.0.0"
+    },
+    "dependencies": {
+        "@microsoft/applicationinsights-shims": "3.0.1",
+        "@microsoft/applicationinsights-core-js": "3.4.1",
+        "@microsoft/dynamicproto-js": "^2.0.3",
+        "@nevware21/ts-utils": ">= 0.12.6 < 2.x"
+    },
+    "license": "MIT"
+}

package/types/applicationinsights-common.d.ts

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights Common JavaScript Library, 3.4.0-nightlybeta3.2602-27
+ * Microsoft Application Insights Common JavaScript Library, 3.4.1
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team

package/types/applicationinsights-common.namespaced.d.ts

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights Common JavaScript Library, 3.4.0-nightlybeta3.2602-27
+ * Microsoft Application Insights Common JavaScript Library, 3.4.1
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -697,6 +697,38 @@ declare namespace ApplicationInsights {
         All = 3
     }
 
+    /**
+     * Controls how the user can configure which parts of the URL should be redacted. Example, certain query parameters, username and password, etc.
+     */
+    const enum eUrlRedactionOptions {
+        /**
+         * The default value, will redact the username and password as well as the default set of query parameters
+         */
+        true = 1,
+        /**
+         * Does not redact username and password or any query parameters, the URL will be left as is. Note: this is not recommended as it may lead
+         * to sensitive data being sent in clear text.
+         */
+        false = 2,
+        /**
+         * This will append any additional queryParams that the user has provided through redactQueryParams config to the default set i.e to
+         * @defaultValue ["sig", "Signature", "AWSAccessKeyId", "X-Goog-Signature"].
+         */
+        appendToDefault = 3,
+        /**
+         * This will replace the default set of query parameters to redact with the query parameters defined in redactQueryParams config, if provided by the user.
+         */
+        replaceDefault = 4,
+        /**
+         * This will redact username and password in the URL but will not redact any query parameters, even those in the default set.
+         */
+        usernamePasswordOnly = 5,
+        /**
+         * This will only redact the query parameter in the default set of query parameters to redact. It will not redact username and password.
+         */
+        queryParamsOnly = 6
+    }
+
     class Event_2 implements IEventData, ISerializable {
         /**
          * @deprecated Use the constant EventEnvelopeType instead.
@@ -747,7 +779,7 @@ declare namespace ApplicationInsights {
     type EventPersistence = number | EventPersistenceValue;
 
     /**
-     * The EventPersistence contains a set of values that specify the event's persistence.
+     * The EventPersistenceValue contains a set of values that specify the event's persistence.
      */
     const enum EventPersistenceValue {
         /**
@@ -2014,10 +2046,10 @@ declare namespace ApplicationInsights {
          */
         expCfg?: IExceptionConfig;
         /**
-         * [Optional] A flag to enable or disable the use of the field redaction for urls.
+         * [Optional] A flag to enable or disable redaction for query parameters and username/password.
          * @defaultValue true
          */
-        redactUrls?: boolean;
+        redactUrls?: UrlRedactionOptions;
         /**
          * [Optional] Additional query parameters to redact beyond the default set.
          * Use this to specify custom parameters that contain sensitive information.
@@ -5710,24 +5742,92 @@ declare namespace ApplicationInsights {
 
     /**
      * Interface for telemetry trace context.
-     * @deprecated Use the core getTraceCtx method instead to get / set the current trace context, this is required to
-     * support distributed tracing and allows the core to manage the trace context.
+     * @deprecated Use {@link ITraceHost.getTraceCtx | appInsights.getTraceCtx()} or {@link ITraceHost.getTraceCtx | appInsights.core.getTraceCtx()} instead to get / set the
+     * current trace context. This returns an {@link IDistributedTraceContext} which supports distributed tracing and
+     * allows the core to manage the trace context.
+     *
+     * To replace the entire trace context, use {@link ITraceHost.setTraceCtx | appInsights.core.setTraceCtx()}.
+     *
+     * @see {@link https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-core-js/interfaces/IDistributedTraceContext.html | IDistributedTraceContext Typedoc}
+     * @see {@link https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-core-js/interfaces/ITraceHost.html#getTraceCtx | getTraceCtx Typedoc}
      */
     interface ITelemetryTrace {
         /**
-         * Trace id
+         * The trace ID for this telemetry context. A 32 lowercase hex character string.
+         * @deprecated Use {@link IDistributedTraceContext.traceId} instead via `appInsights.getTraceCtx().traceId`.
+         *
+         * @example
+         * ```typescript
+         * // Old (deprecated)
+         * let traceId = context.telemetryTrace.traceID;
+         *
+         * // New (recommended) - using the standard SKU (AISKU)
+         * let traceCtx = appInsights.getTraceCtx();
+         * let traceId = traceCtx.traceId;
+         * traceCtx.traceId = "00000000000000000000000000000001";
+         *
+         * // Or when using the core directly
+         * let traceCtx = appInsights.core.getTraceCtx();
+         * ```
          */
         traceID?: string;
         /**
-         * Parent id
+         * The parent span ID. A 16 lowercase hex character string.
+         * @deprecated Use {@link IDistributedTraceContext.spanId} instead via `appInsights.getTraceCtx().spanId`.
+         *
+         * @example
+         * ```typescript
+         * // Old (deprecated)
+         * let parentId = context.telemetryTrace.parentID;
+         *
+         * // New (recommended) - using the standard SKU (AISKU)
+         * let traceCtx = appInsights.getTraceCtx();
+         * let spanId = traceCtx.spanId;
+         * traceCtx.spanId = "0000000000000001";
+         *
+         * // Or when using the core directly
+         * let traceCtx = appInsights.core.getTraceCtx();
+         * ```
          */
         parentID?: string;
         /**
-         * An integer representation of the W3C TraceContext trace-flags. https://www.w3.org/TR/trace-context/#trace-flags
+         * An integer representation of the W3C TraceContext trace-flags.
+         * @deprecated Use {@link IDistributedTraceContext.traceFlags} instead via `appInsights.getTraceCtx().traceFlags`.
+         *
+         * @example
+         * ```typescript
+         * // Old (deprecated)
+         * let flags = context.telemetryTrace.traceFlags;
+         *
+         * // New (recommended) - using the standard SKU (AISKU)
+         * let traceCtx = appInsights.getTraceCtx();
+         * let flags = traceCtx.traceFlags;
+         * traceCtx.traceFlags = 1; // sampled
+         *
+         * // Or when using the core directly
+         * let traceCtx = appInsights.core.getTraceCtx();
+         * ```
+         *
+         * @see {@link https://www.w3.org/TR/trace-context/#trace-flags | W3C TraceContext trace-flags}
          */
         traceFlags?: number;
         /**
-         * Name
+         * The operation/page name for this trace context.
+         * @deprecated Use {@link IDistributedTraceContext.pageName} instead via `appInsights.getTraceCtx().pageName`.
+         *
+         * @example
+         * ```typescript
+         * // Old (deprecated)
+         * let name = context.telemetryTrace.name;
+         *
+         * // New (recommended) - using the standard SKU (AISKU)
+         * let traceCtx = appInsights.getTraceCtx();
+         * let pageName = traceCtx.pageName;
+         * traceCtx.pageName = "my-page";
+         *
+         * // Or when using the core directly
+         * let traceCtx = appInsights.core.getTraceCtx();
+         * ```
          */
         name?: string;
     }
@@ -7028,6 +7128,10 @@ declare namespace ApplicationInsights {
 
     function urlParseUrl(url: string): HTMLAnchorElement;
 
+    const UrlRedactionOptions: EnumValue<typeof eUrlRedactionOptions>;
+
+    type UrlRedactionOptions = boolean | eUrlRedactionOptions;
+
     /**
      * Returns whether LocalStorage can be used, if the reset parameter is passed a true this will override
      * any previous disable calls.