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

package/types/applicationinsights-osplugin-js.namespaced.d.ts

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights osplugin plugin, 3.4.0-nightlybeta3.2602-27
+ * Microsoft Application Insights osplugin plugin, 3.4.1
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -461,6 +461,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
+    }
+
     const enum FeatureOptInMode {
         /**
          * not set, completely depends on cdn cfg
@@ -1502,10 +1534,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.
@@ -4719,6 +4751,10 @@ declare namespace ApplicationInsights {
 
     type UnloadHandler = (itemCtx: IProcessTelemetryUnloadContext, unloadState: ITelemetryUnloadState) => void;
 
+    const UrlRedactionOptions: EnumValue<typeof eUrlRedactionOptions>;
+
+    type UrlRedactionOptions = boolean | eUrlRedactionOptions;
+
     type WatcherFunction<T = IConfiguration> = (details: IWatchDetails<T>) => void;
 
 }