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

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

@@ -1,5 +1,5 @@
 /*
- * 1DS JS SDK Core, 4.4.0-nightlybeta3.2602-17
+ * 1DS JS SDK Core, 4.4.1
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -1090,6 +1090,38 @@ declare namespace oneDS {
         INFORMATION = 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
+    }
+
     /**
      * The eValueKind contains a set of values that specify value kind of the property.
      * Either PII (Personal Identifiable Information) or customer content.
@@ -1231,7 +1263,7 @@ declare namespace oneDS {
     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 {
         /**
@@ -1379,6 +1411,10 @@ declare namespace oneDS {
      */
     function formatTraceParent(value: ITraceParent): string;
 
+    /**
+     * Identifies the full version for the extended SDK (legacy constant)
+     * @deprecated Use {@link ExtFullVersionString} instead
+     */
     const FullVersionString: string;
 
     /**
@@ -2358,10 +2394,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.
@@ -7243,6 +7279,11 @@ declare namespace oneDS {
 
     type TraceLevel = number | eTraceLevel;
 
+    /**
+     * An enumeration that identifies the transport type that are requested to be used, if the requested
+     * transport is not available ir supported the SDK may choose the first available transport or it
+     * will log a warning to the diagnostic logger.
+     */
     const enum TransportType {
         /**
          * Use the default available api
@@ -7264,6 +7305,10 @@ declare namespace oneDS {
 
     type UnloadHandler = (itemCtx: IProcessTelemetryUnloadContext, unloadState: ITelemetryUnloadState) => void;
 
+    const UrlRedactionOptions: EnumValue<typeof eUrlRedactionOptions>;
+
+    type UrlRedactionOptions = boolean | eUrlRedactionOptions;
+
     function useXDomainRequest(): boolean | undefined;
 
     /**
@@ -7330,7 +7375,11 @@ declare namespace oneDS {
         constructor(fieldSanitizerProvider?: IFieldValueSanitizerProvider);
     }
 
-    const Version = "4.4.0-nightlybeta3.2602-17";
+    /**
+     * Identifies the version for the extended SDK (legacy constant)
+     * @deprecated Use {@link ExtVersion} instead
+     */
+    const Version = "4.4.1";
 
     /**
      * This is a helper method which will call warnToConsole on the passed logger with the provided message.