@microsoft/1ds-post-js 4.4.0-nightlybeta3.2602-17 → 4.4.1

package/package.json

@@ -1,67 +1,64 @@
-{
-    "name": "@microsoft/1ds-post-js",
-    "version": "4.4.0-nightlybeta3.2602-17",
-    "description": "Microsoft Application Insights JavaScript SDK - 1ds-post-channel-js",
-    "author": "Microsoft Application Insights Team",
-    "homepage": "https://github.com/microsoft/ApplicationInsights-JS#readme",
-    "license": "MIT",
-    "sideEffects": false,
-    "scripts": {
-        "clean": "git clean -xdf",
-        "build": "npm run build:esm && npm run build:browser && npm run dtsgen && npm run sri",
-        "build:esm": "grunt 1dsPostBuild",
-        "build:browser": "npx rollup -c rollup.config.js --bundleConfigAsCjs",
-        "rebuild": "npm run build",
-        "ai-min": "grunt 1dsPost-min",
-        "ai-restore": "grunt 1dsPost-restore",
-        "dtsgen": "api-extractor run --local && node ../../scripts/dtsgen.js \"1DS JS SDK Post Channel\" -oneDs",
-        "test": "grunt 1dsPostTest",
-        "mintest": "grunt adsPostMinTest",
-        "perftest": "",
-        "makePublicPackage": "node ../../tools/makePublic/makePublicPackage.js ./package.json && npm pack",
-        "publishPackage": "npm publish",
-        "sri": "node ../../tools/subResourceIntegrity/generateIntegrityFile.js",
-        "npm-pack": "npm pack",
-        "api-docs": "typedoc"
-    },
-    "dependencies": {
-        "@microsoft/applicationinsights-shims": "3.0.1",
-        "@microsoft/dynamicproto-js": "^2.0.3",
-        "@microsoft/1ds-core-js": "4.4.0-nightlybeta3.2602-17",
-        "@nevware21/ts-utils": ">= 0.12.6 < 2.x",
-        "@nevware21/ts-async": ">= 0.5.5 < 2.x"
-    },
-    "devDependencies": {
-        "@microsoft/ai-test-framework": "0.0.1",
-        "@microsoft/applicationinsights-rollup-plugin-uglify3-js": "1.0.0",
-        "@microsoft/applicationinsights-rollup-es5": "1.0.2",
-        "@microsoft/api-extractor": "^7.40.0",
-        "globby": "^11.0.0",
-        "grunt": "^1.6.1",
-        "sinon": "^7.3.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",
-        "typedoc": "^0.26.6",
-        "typescript": "^4.9.3",
-        "pako": "^2.0.3"
-    },
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/microsoft/ApplicationInsights-JS/tree/main/channels/1ds-post-js"
-    },
-    "main": "dist/es5/ms.post.js",
-    "module": "dist-es5/Index.js",
-    "types": "types/1ds-post-js.d.ts",
-    "keywords": [
-        "1DS",
-        "Js",
-        "SDK"
-    ],
-    "publishConfig": {
-        "tag": "nightlybeta3"
-    }
-}
+{
+    "name": "@microsoft/1ds-post-js",
+    "version": "4.4.1",
+    "description": "Microsoft Application Insights JavaScript SDK - 1ds-post-channel-js",
+    "author": "Microsoft Application Insights Team",
+    "homepage": "https://github.com/microsoft/ApplicationInsights-JS#readme",
+    "license": "MIT",
+    "sideEffects": false,
+    "scripts": {
+        "clean": "git clean -xdf",
+        "build": "npm run build:esm && npm run build:browser && npm run dtsgen && npm run sri",
+        "build:esm": "grunt 1dsPostBuild",
+        "build:browser": "npx rollup -c rollup.config.js --bundleConfigAsCjs",
+        "rebuild": "npm run build",
+        "ai-min": "grunt 1dsPost-min",
+        "ai-restore": "grunt 1dsPost-restore",
+        "dtsgen": "api-extractor run --local && node ../../scripts/dtsgen.js \"1DS JS SDK Post Channel\" -oneDs",
+        "test": "grunt 1dsPostTest",
+        "mintest": "grunt adsPostMinTest",
+        "perftest": "",
+        "makePublicPackage": "node ../../tools/makePublic/makePublicPackage.js ./package.json && npm pack",
+        "publishPackage": "npm publish",
+        "sri": "node ../../tools/subResourceIntegrity/generateIntegrityFile.js",
+        "npm-pack": "npm pack",
+        "api-docs": "typedoc"
+    },
+    "dependencies": {
+        "@microsoft/applicationinsights-shims": "3.0.1",
+        "@microsoft/dynamicproto-js": "^2.0.3",
+        "@microsoft/applicationinsights-core-js": "3.4.1",
+        "@nevware21/ts-utils": ">= 0.12.6 < 2.x",
+        "@nevware21/ts-async": ">= 0.5.5 < 2.x"
+    },
+    "devDependencies": {
+        "@microsoft/ai-test-framework": "0.0.1",
+        "@microsoft/applicationinsights-rollup-plugin-uglify3-js": "1.0.0",
+        "@microsoft/applicationinsights-rollup-es5": "1.0.2",
+        "@microsoft/api-extractor": "^7.40.0",
+        "globby": "^11.0.0",
+        "grunt": "^1.6.1",
+        "sinon": "^7.3.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",
+        "typedoc": "^0.26.6",
+        "typescript": "^4.9.3",
+        "pako": "^2.0.3"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/microsoft/ApplicationInsights-JS/tree/main/channels/1ds-post-js"
+    },
+    "main": "dist/es5/ms.post.js",
+    "module": "dist-es5/Index.js",
+    "types": "types/1ds-post-js.d.ts",
+    "keywords": [
+        "1DS",
+        "Js",
+        "SDK"
+    ]
+}

package/types/1ds-post-js.d.ts

@@ -1,5 +1,5 @@
 /*
- * 1DS JS SDK Post Channel, 4.4.0-nightlybeta3.2602-17
+ * 1DS JS SDK Post Channel, 4.4.1
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -12,24 +12,24 @@
  * ---------------------------------------------------------------------------
  */
 
-import { BaseTelemetryPlugin } from '@microsoft/1ds-core-js';
-import { IAppInsightsCore } from '@microsoft/1ds-core-js';
-import { IChannelControls } from '@microsoft/1ds-core-js';
-import { IDiagnosticLogger } from '@microsoft/1ds-core-js';
-import { IExtendedConfiguration } from '@microsoft/1ds-core-js';
-import { IInternalOfflineSupport } from '@microsoft/1ds-core-js';
-import { IPayloadData } from '@microsoft/1ds-core-js';
-import { IPlugin } from '@microsoft/1ds-core-js';
-import { IProcessTelemetryContext } from '@microsoft/1ds-core-js';
+import { BaseTelemetryPlugin } from '@microsoft/applicationinsights-core-js';
+import { IAppInsightsCore } from '@microsoft/applicationinsights-core-js';
+import { IChannelControls } from '@microsoft/applicationinsights-core-js';
+import { IDiagnosticLogger } from '@microsoft/applicationinsights-core-js';
+import { IExtendedConfiguration } from '@microsoft/applicationinsights-core-js';
+import { IInternalOfflineSupport } from '@microsoft/applicationinsights-core-js';
+import { IPayloadData } from '@microsoft/applicationinsights-core-js';
+import { IPlugin } from '@microsoft/applicationinsights-core-js';
+import { IProcessTelemetryContext } from '@microsoft/applicationinsights-core-js';
 import { IPromise } from '@nevware21/ts-async';
-import { ITelemetryItem } from '@microsoft/1ds-core-js';
-import { ITelemetryPlugin } from '@microsoft/1ds-core-js';
-import { IUnloadHook } from '@microsoft/1ds-core-js';
-import { IValueSanitizer } from '@microsoft/1ds-core-js';
-import { IXHROverride } from '@microsoft/1ds-core-js';
-import { OnCompleteCallback } from '@microsoft/1ds-core-js';
-import { SendPOSTFunction } from '@microsoft/1ds-core-js';
-import { SendRequestReason } from '@microsoft/1ds-core-js';
+import { ITelemetryItem } from '@microsoft/applicationinsights-core-js';
+import { ITelemetryPlugin } from '@microsoft/applicationinsights-core-js';
+import { IUnloadHook } from '@microsoft/applicationinsights-core-js';
+import { IValueSanitizer } from '@microsoft/applicationinsights-core-js';
+import { IXHROverride } from '@microsoft/applicationinsights-core-js';
+import { OnCompleteCallback } from '@microsoft/applicationinsights-core-js';
+import { SendPOSTFunction } from '@microsoft/applicationinsights-core-js';
+import { SendRequestReason } from '@microsoft/applicationinsights-core-js';
 
 /**
  * Best Effort. RealTime Latency events are sent every 9 sec and

package/types/1ds-post-js.namespaced.d.ts

@@ -1,5 +1,5 @@
 /*
- * 1DS JS SDK Post Channel, 4.4.0-nightlybeta3.2602-17
+ * 1DS JS SDK Post Channel, 4.4.1
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -387,6 +387,38 @@ declare namespace oneDS {
         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
+    }
+
     const enum FeatureOptInMode {
         /**
          * not set, completely depends on cdn cfg
@@ -1331,10 +1363,10 @@ declare namespace oneDS {
          */
         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.
@@ -4817,6 +4849,10 @@ declare namespace oneDS {
 
     type UnloadHandler = (itemCtx: IProcessTelemetryUnloadContext, unloadState: ITelemetryUnloadState) => void;
 
+    const UrlRedactionOptions: EnumValue<typeof eUrlRedactionOptions>;
+
+    type UrlRedactionOptions = boolean | eUrlRedactionOptions;
+
     type WatcherFunction<T = IConfiguration> = (details: IWatchDetails<T>) => void;
 
 }