@sophonz/redaction 0.0.2 → 0.0.4

package/build/index.d.ts

@@ -1,4 +1,4 @@
 export { createAttributeScrubber } from './attributes';
-export { createSanitizeUrl, DEFAULT_QUERY_PARAMS_TO_SCRUB, defaultSanitizeUrl, REDACTED, } from './url';
+export { createSanitizeUrl, DEFAULT_QUERY_PARAMS_TO_DROP, DEFAULT_QUERY_PARAMS_TO_SCRUB, defaultSanitizeUrl, REDACTED, } from './url';
 export type { AttributeScrubber, AttributeScrubberOptions, SanitizeUrl, SanitizeUrlOptions, ScrubAttributes, ScrubbableValue, } from './types';
 //# sourceMappingURL=index.d.ts.map

package/build/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAEvD,OAAO,EACL,iBAAiB,EACjB,6BAA6B,EAC7B,kBAAkB,EAClB,QAAQ,GACT,MAAM,OAAO,CAAC;AAEf,YAAY,EACV,iBAAiB,EACjB,wBAAwB,EACxB,WAAW,EACX,kBAAkB,EAClB,eAAe,EACf,eAAe,GAChB,MAAM,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAEvD,OAAO,EACL,iBAAiB,EACjB,4BAA4B,EAC5B,6BAA6B,EAC7B,kBAAkB,EAClB,QAAQ,GACT,MAAM,OAAO,CAAC;AAEf,YAAY,EACV,iBAAiB,EACjB,wBAAwB,EACxB,WAAW,EACX,kBAAkB,EAClB,eAAe,EACf,eAAe,GAChB,MAAM,SAAS,CAAC"}

package/build/index.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.REDACTED = exports.defaultSanitizeUrl = exports.DEFAULT_QUERY_PARAMS_TO_SCRUB = exports.createSanitizeUrl = exports.createAttributeScrubber = void 0;
+exports.REDACTED = exports.defaultSanitizeUrl = exports.DEFAULT_QUERY_PARAMS_TO_SCRUB = exports.DEFAULT_QUERY_PARAMS_TO_DROP = exports.createSanitizeUrl = exports.createAttributeScrubber = void 0;
 var attributes_1 = require("./attributes");
 Object.defineProperty(exports, "createAttributeScrubber", { enumerable: true, get: function () { return attributes_1.createAttributeScrubber; } });
 var url_1 = require("./url");
 Object.defineProperty(exports, "createSanitizeUrl", { enumerable: true, get: function () { return url_1.createSanitizeUrl; } });
+Object.defineProperty(exports, "DEFAULT_QUERY_PARAMS_TO_DROP", { enumerable: true, get: function () { return url_1.DEFAULT_QUERY_PARAMS_TO_DROP; } });
 Object.defineProperty(exports, "DEFAULT_QUERY_PARAMS_TO_SCRUB", { enumerable: true, get: function () { return url_1.DEFAULT_QUERY_PARAMS_TO_SCRUB; } });
 Object.defineProperty(exports, "defaultSanitizeUrl", { enumerable: true, get: function () { return url_1.defaultSanitizeUrl; } });
 Object.defineProperty(exports, "REDACTED", { enumerable: true, get: function () { return url_1.REDACTED; } });

package/build/types.d.ts

@@ -2,6 +2,8 @@ export type SanitizeUrl = (url: string) => string;
 export interface SanitizeUrlOptions {
     additionalQueryParamsToScrub?: readonly string[];
     queryParamsToScrub?: readonly string[];
+    additionalQueryParamsToDrop?: readonly string[];
+    queryParamsToDrop?: readonly string[];
     redactCredentials?: boolean;
     scrubFragment?: boolean;
 }

package/build/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAQA,MAAM,MAAM,WAAW,GAAG,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC;AAKlD,MAAM,WAAW,kBAAkB;IAWjC,4BAA4B,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAUjD,kBAAkB,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAKvC,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAW5B,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAsBD,MAAM,MAAM,eAAe,GACvB,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,SAAS,GACT,UAAU,GACV,eAAe,EAAE,GACjB;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,CAAA;CAAE,CAAC;AAyBvC,MAAM,WAAW,iBAAiB;IAQhC,IAAI,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IASzB,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,MAAM,EAAE,CAAC;IAgBxC,WAAW,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC;IAWvC,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,eAAe,KAAK,eAAe,GAAG,SAAS,CAAC;CAC9E;AAKD,MAAM,WAAW,wBAAwB;IAQvC,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;CACtD;AAYD,MAAM,MAAM,eAAe,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,OAAO,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAQA,MAAM,MAAM,WAAW,GAAG,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC;AAKlD,MAAM,WAAW,kBAAkB;IAWjC,4BAA4B,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAUjD,kBAAkB,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAavC,2BAA2B,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAQhD,iBAAiB,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAKtC,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAW5B,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAsBD,MAAM,MAAM,eAAe,GACvB,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,SAAS,GACT,UAAU,GACV,eAAe,EAAE,GACjB;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,CAAA;CAAE,CAAC;AAyBvC,MAAM,WAAW,iBAAiB;IAQhC,IAAI,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IASzB,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,MAAM,EAAE,CAAC;IAgBxC,WAAW,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC;IAWvC,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,eAAe,KAAK,eAAe,GAAG,SAAS,CAAC;CAC9E;AAKD,MAAM,WAAW,wBAAwB;IAQvC,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;CACtD;AAYD,MAAM,MAAM,eAAe,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,OAAO,CAAC"}

package/build/url.d.ts

@@ -1,6 +1,7 @@
 import type { SanitizeUrl, SanitizeUrlOptions } from './types';
 export declare const REDACTED = "REDACTED";
 export declare const DEFAULT_QUERY_PARAMS_TO_SCRUB: readonly string[];
+export declare const DEFAULT_QUERY_PARAMS_TO_DROP: readonly string[];
 export declare function createSanitizeUrl(options?: SanitizeUrlOptions): SanitizeUrl;
 export declare function defaultSanitizeUrl(url: string): string;
 //# sourceMappingURL=url.d.ts.map

package/build/url.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"url.d.ts","sourceRoot":"","sources":["../src/url.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAY/D,eAAO,MAAM,QAAQ,aAAa,CAAC;AAMnC,eAAO,MAAM,6BAA6B,EAAE,SAAS,MAAM,EAoBzD,CAAC;AAgMH,wBAAgB,iBAAiB,CAC/B,OAAO,GAAE,kBAAuB,GAC/B,WAAW,CAsCb;AAgBD,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEtD"}
+{"version":3,"file":"url.d.ts","sourceRoot":"","sources":["../src/url.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAY/D,eAAO,MAAM,QAAQ,aAAa,CAAC;AAMnC,eAAO,MAAM,6BAA6B,EAAE,SAAS,MAAM,EAoBzD,CAAC;AAkBH,eAAO,MAAM,4BAA4B,EAAE,SAAS,MAAM,EAKxD,CAAC;AA6NH,wBAAgB,iBAAiB,CAC/B,OAAO,GAAE,kBAAuB,GAC/B,WAAW,CAmDb;AAgBD,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEtD"}

package/build/url.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_QUERY_PARAMS_TO_SCRUB = exports.REDACTED = void 0;
+exports.DEFAULT_QUERY_PARAMS_TO_DROP = exports.DEFAULT_QUERY_PARAMS_TO_SCRUB = exports.REDACTED = void 0;
 exports.createSanitizeUrl = createSanitizeUrl;
 exports.defaultSanitizeUrl = defaultSanitizeUrl;
 exports.REDACTED = 'REDACTED';
@@ -25,6 +25,10 @@ exports.DEFAULT_QUERY_PARAMS_TO_SCRUB = Object.freeze([
     'signature',
     'hash',
 ]);
+exports.DEFAULT_QUERY_PARAMS_TO_DROP = Object.freeze([
+    '_rsc',
+    '_',
+]);
 const SCHEME = /^[A-Za-z][A-Za-z0-9+.-]*:/;
 function isSlash(ch) {
     return ch === '/' || ch === '\\';
@@ -43,36 +47,44 @@ function normalizeParamName(raw) {
     }
     return name.trim().toLowerCase();
 }
-function scrubParams(params, scrub) {
+function scrubParams(params, scrub, drop) {
     if (params === '' || params.indexOf('=') === -1) {
         return params;
     }
     const pairs = params.split('&');
+    const kept = [];
     let changed = false;
     for (let i = 0; i < pairs.length; i++) {
         const pair = pairs[i];
         const eq = pair.indexOf('=');
         if (eq === -1) {
+            kept.push(pair);
+            continue;
+        }
+        const name = normalizeParamName(pair.slice(0, eq));
+        if (drop.has(name)) {
+            changed = true;
             continue;
         }
         const rawName = pair.slice(0, eq);
-        if (!scrub.has(normalizeParamName(rawName))) {
+        if (!scrub.has(name)) {
+            kept.push(pair);
             continue;
         }
         const redacted = rawName + '=' + exports.REDACTED;
         if (redacted !== pair) {
-            pairs[i] = redacted;
             changed = true;
         }
+        kept.push(redacted);
     }
-    return changed ? pairs.join('&') : params;
+    return changed ? kept.join('&') : params;
 }
-function scrubFragmentParams(fragment, scrub) {
+function scrubFragmentParams(fragment, scrub, drop) {
     const q = fragment.indexOf('?');
     if (q !== -1) {
-        return fragment.slice(0, q + 1) + scrubParams(fragment.slice(q + 1), scrub);
+        return (fragment.slice(0, q + 1) + scrubParams(fragment.slice(q + 1), scrub, drop));
     }
-    return scrubParams(fragment, scrub);
+    return scrubParams(fragment, scrub, drop);
 }
 function redactCredentials(head) {
     let start = -1;
@@ -112,7 +124,7 @@ function redactCredentials(head) {
     }
     return head.slice(0, start) + replacement + head.slice(start + at);
 }
-function sanitize(url, scrub, credentials, fragment) {
+function sanitize(url, scrub, drop, credentials, fragment) {
     const hash = url.indexOf('#');
     const beforeHash = hash === -1 ? url : url.slice(0, hash);
     const fragmentText = hash === -1 ? '' : url.slice(hash + 1);
@@ -121,17 +133,20 @@ function sanitize(url, scrub, credentials, fragment) {
     const query = question === -1 ? '' : beforeHash.slice(question + 1);
     let out = credentials ? redactCredentials(head) : head;
     if (question !== -1) {
-        out += '?' + scrubParams(query, scrub);
+        const scrubbed = scrubParams(query, scrub, drop);
+        if (scrubbed !== '' || query === '') {
+            out += '?' + scrubbed;
+        }
     }
     if (hash !== -1) {
         out +=
             '#' +
-                (fragment ? scrubFragmentParams(fragmentText, scrub) : fragmentText);
+                (fragment ? scrubFragmentParams(fragmentText, scrub, drop) : fragmentText);
     }
     return out;
 }
 function createSanitizeUrl(options = {}) {
-    var _a;
+    var _a, _b;
     const scrub = new Set();
     const base = (_a = options.queryParamsToScrub) !== null && _a !== void 0 ? _a : exports.DEFAULT_QUERY_PARAMS_TO_SCRUB;
     for (let i = 0; i < base.length; i++) {
@@ -144,6 +159,18 @@ function createSanitizeUrl(options = {}) {
         }
     }
     scrub.delete('');
+    const drop = new Set();
+    const dropBase = (_b = options.queryParamsToDrop) !== null && _b !== void 0 ? _b : exports.DEFAULT_QUERY_PARAMS_TO_DROP;
+    for (let i = 0; i < dropBase.length; i++) {
+        drop.add(normalizeParamName(dropBase[i]));
+    }
+    const dropExtra = options.additionalQueryParamsToDrop;
+    if (dropExtra) {
+        for (let i = 0; i < dropExtra.length; i++) {
+            drop.add(normalizeParamName(dropExtra[i]));
+        }
+    }
+    drop.delete('');
     const credentials = options.redactCredentials !== false;
     const fragment = options.scrubFragment !== false;
     return function sanitizeUrl(url) {
@@ -151,7 +178,7 @@ function createSanitizeUrl(options = {}) {
             return '';
         }
         try {
-            return sanitize(url, scrub, credentials, fragment);
+            return sanitize(url, scrub, drop, credentials, fragment);
         }
         catch {
             return exports.REDACTED;

package/build/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.0.1";
+export declare const VERSION = "0.0.3";
 //# sourceMappingURL=version.d.ts.map

package/build/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.0.1';
+exports.VERSION = '0.0.3';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sophonz/redaction",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "Sophonz Redaction",
   "homepage": "https://sophonz.com",
   "repository": {