@metamask-previews/phishing-controller 14.0.0-preview-bc6087f6 → 14.1.0-preview-622f3f09

package/CHANGELOG.md

@@ -7,6 +7,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [14.1.0]
+
+### Added
+
+- Add path-based blocking [#6416](https://github.com/MetaMask/core/pull/6416)
+  - Add `blocklistPaths` to `PhishingDetectorList`
+  - Add `blocklistPaths` to `PhishingDetectorConfiguration`
+  - Add `whitelistPaths` to `PhishingControllerState`
+  - Adds a type called PathTrie
+
+### Fixed
+
+- Fixed phishing detector initialization failure when domain lists contain invalid values (numbers, null, undefined) by filtering them out ([#6767](https://github.com/MetaMask/core/pull/6767))
+
 ## [14.0.0]
 
 ### Added
@@ -416,7 +430,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
     All changes listed after this point were applied to this package following the monorepo conversion.
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/phishing-controller@14.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/phishing-controller@14.1.0...HEAD
+[14.1.0]: https://github.com/MetaMask/core/compare/@metamask/phishing-controller@14.0.0...@metamask/phishing-controller@14.1.0
 [14.0.0]: https://github.com/MetaMask/core/compare/@metamask/phishing-controller@13.1.0...@metamask/phishing-controller@14.0.0
 [13.1.0]: https://github.com/MetaMask/core/compare/@metamask/phishing-controller@13.0.0...@metamask/phishing-controller@13.1.0
 [13.0.0]: https://github.com/MetaMask/core/compare/@metamask/phishing-controller@12.6.0...@metamask/phishing-controller@13.0.0

package/dist/PathTrie.cjs

@@ -0,0 +1,169 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deepCopyPathTrie = exports.convertListToTrie = exports.matchedPathPrefix = exports.deleteFromTrie = exports.insertToTrie = exports.isTerminal = void 0;
+const utils_1 = require("./utils.cjs");
+const isTerminal = (node) => {
+    if (!node || typeof node !== 'object') {
+        return false;
+    }
+    return Object.keys(node).length === 0;
+};
+exports.isTerminal = isTerminal;
+/**
+ * Insert a URL into the trie.
+ *
+ * @param url - The URL to insert into the trie.
+ * @param pathTrie - The trie to insert the URL into.
+ */
+const insertToTrie = (url, pathTrie) => {
+    const { hostname, pathComponents } = (0, utils_1.getHostnameAndPathComponents)(url);
+    if (pathComponents.length === 0 || !hostname) {
+        return;
+    }
+    const lowerHostname = hostname.toLowerCase();
+    if (!pathTrie[lowerHostname]) {
+        pathTrie[lowerHostname] = {};
+    }
+    let curr = pathTrie[lowerHostname];
+    for (let i = 0; i < pathComponents.length; i++) {
+        const pathComponent = pathComponents[i];
+        const isLast = i === pathComponents.length - 1;
+        const exists = curr[pathComponent] !== undefined;
+        if (exists) {
+            if (!isLast && (0, exports.isTerminal)(curr[pathComponent])) {
+                return;
+            }
+            if (isLast) {
+                // Prune descendants if the current path component is not terminal
+                if (!(0, exports.isTerminal)(curr[pathComponent])) {
+                    curr[pathComponent] = {};
+                }
+                return;
+            }
+            curr = curr[pathComponent];
+            continue;
+        }
+        if (isLast) {
+            curr[pathComponent] = {};
+            return;
+        }
+        const next = {};
+        curr[pathComponent] = next;
+        curr = next;
+    }
+};
+exports.insertToTrie = insertToTrie;
+/**
+ * Delete a URL from the trie.
+ *
+ * @param url - The URL to delete from the trie.
+ * @param pathTrie - The trie to delete the URL from.
+ */
+const deleteFromTrie = (url, pathTrie) => {
+    const { hostname, pathComponents } = (0, utils_1.getHostnameAndPathComponents)(url);
+    const lowerHostname = hostname.toLowerCase();
+    if (pathComponents.length === 0 || !pathTrie[lowerHostname]) {
+        return;
+    }
+    const pathToNode = [
+        { node: pathTrie, key: lowerHostname },
+    ];
+    let curr = pathTrie[lowerHostname];
+    for (const pathComponent of pathComponents) {
+        if (!curr[pathComponent]) {
+            return;
+        }
+        pathToNode.push({ node: curr, key: pathComponent });
+        curr = curr[pathComponent];
+    }
+    const lastEntry = pathToNode[pathToNode.length - 1];
+    delete lastEntry.node[lastEntry.key];
+    for (let i = pathToNode.length - 2; i >= 0; i--) {
+        const { node, key } = pathToNode[i];
+        if ((0, exports.isTerminal)(node[key])) {
+            delete node[key];
+        }
+        else {
+            break;
+        }
+    }
+};
+exports.deleteFromTrie = deleteFromTrie;
+/**
+ * Get the concatenated hostname and path components all the way down to the
+ * terminal node in the trie that is prefixed in the passed URL. It will only
+ * return a string if the terminal node in the trie is contained in the passed
+ * URL.
+ *
+ * @param url - The URL to check.
+ * @param pathTrie - The trie to check the URL in.
+ * @returns The matched path prefix, or null if no match is found.
+ */
+const matchedPathPrefix = (url, pathTrie) => {
+    const { hostname, pathComponents } = (0, utils_1.getHostnameAndPathComponents)(url);
+    const lowerHostname = hostname.toLowerCase();
+    if (pathComponents.length === 0 || !hostname || !pathTrie[lowerHostname]) {
+        return null;
+    }
+    let matchedPath = `${hostname}/`;
+    let curr = pathTrie[lowerHostname];
+    for (const pathComponent of pathComponents) {
+        if (!curr[pathComponent]) {
+            return null;
+        }
+        curr = curr[pathComponent];
+        // If we've reached a terminal node, then we can return the matched path.
+        if ((0, exports.isTerminal)(curr)) {
+            matchedPath += pathComponent;
+            return matchedPath;
+        }
+        matchedPath += `${pathComponent}/`;
+    }
+    return null;
+};
+exports.matchedPathPrefix = matchedPathPrefix;
+/**
+ * Converts a list ofpaths into a PathTrie structure. This assumes that the
+ * entries are only hostname+pathname format.
+ *
+ * @param paths - Array of hostname+pathname
+ * @returns PathTrie structure for efficient path checking
+ */
+const convertListToTrie = (paths = []) => {
+    const pathTrie = {};
+    if (!paths || !Array.isArray(paths)) {
+        return pathTrie;
+    }
+    for (const path of paths) {
+        (0, exports.insertToTrie)(path, pathTrie);
+    }
+    return pathTrie;
+};
+exports.convertListToTrie = convertListToTrie;
+/**
+ * Creates a deep copy of a PathNode structure.
+ *
+ * @param original - The original PathNode to copy.
+ * @returns A deep copy of the PathNode.
+ */
+const deepCopyPathNode = (original) => {
+    const copy = {};
+    for (const [key, childNode] of Object.entries(original)) {
+        copy[key] = deepCopyPathNode(childNode);
+    }
+    return copy;
+};
+/**
+ * Creates a deep copy of a PathTrie structure.
+ *
+ * @param original - The original PathTrie to copy.
+ * @returns A deep copy of the PathTrie.
+ */
+const deepCopyPathTrie = (original) => {
+    if (!original) {
+        return {};
+    }
+    return deepCopyPathNode(original);
+};
+exports.deepCopyPathTrie = deepCopyPathTrie;
+//# sourceMappingURL=PathTrie.cjs.map

package/dist/PathTrie.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"PathTrie.cjs","sourceRoot":"","sources":["../src/PathTrie.ts"],"names":[],"mappings":";;;AAAA,uCAAuD;AAQhD,MAAM,UAAU,GAAG,CAAC,IAA0B,EAAW,EAAE;IAChE,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;QACrC,OAAO,KAAK,CAAC;KACd;IACD,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC;AACxC,CAAC,CAAC;AALW,QAAA,UAAU,cAKrB;AAEF;;;;;GAKG;AACI,MAAM,YAAY,GAAG,CAAC,GAAW,EAAE,QAAkB,EAAE,EAAE;IAC9D,MAAM,EAAE,QAAQ,EAAE,cAAc,EAAE,GAAG,IAAA,oCAA4B,EAAC,GAAG,CAAC,CAAC;IAEvE,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE;QAC5C,OAAO;KACR;IAED,MAAM,aAAa,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC;IAC7C,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE;QAC5B,QAAQ,CAAC,aAAa,CAAC,GAAG,EAAc,CAAC;KAC1C;IAED,IAAI,IAAI,GAAa,QAAQ,CAAC,aAAa,CAAC,CAAC;IAC7C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,cAAc,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QAC9C,MAAM,aAAa,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;QACxC,MAAM,MAAM,GAAG,CAAC,KAAK,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC;QAC/C,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,KAAK,SAAS,CAAC;QAEjD,IAAI,MAAM,EAAE;YACV,IAAI,CAAC,MAAM,IAAI,IAAA,kBAAU,EAAC,IAAI,CAAC,aAAa,CAAC,CAAC,EAAE;gBAC9C,OAAO;aACR;YAED,IAAI,MAAM,EAAE;gBACV,kEAAkE;gBAClE,IAAI,CAAC,IAAA,kBAAU,EAAC,IAAI,CAAC,aAAa,CAAC,CAAC,EAAE;oBACpC,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC;iBAC1B;gBACD,OAAO;aACR;YACD,IAAI,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC;YAC3B,SAAS;SACV;QAED,IAAI,MAAM,EAAE;YACV,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC;YACzB,OAAO;SACR;QACD,MAAM,IAAI,GAAa,EAAE,CAAC;QAC1B,IAAI,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC;QAC3B,IAAI,GAAG,IAAI,CAAC;KACb;AACH,CAAC,CAAC;AA1CW,QAAA,YAAY,gBA0CvB;AAEF;;;;;GAKG;AACI,MAAM,cAAc,GAAG,CAAC,GAAW,EAAE,QAAkB,EAAE,EAAE;IAChE,MAAM,EAAE,QAAQ,EAAE,cAAc,EAAE,GAAG,IAAA,oCAA4B,EAAC,GAAG,CAAC,CAAC;IAEvE,MAAM,aAAa,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC;IAC7C,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE;QAC3D,OAAO;KACR;IAED,MAAM,UAAU,GAAsC;QACpD,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,aAAa,EAAE;KACvC,CAAC;IACF,IAAI,IAAI,GAAa,QAAQ,CAAC,aAAa,CAAC,CAAC;IAC7C,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE;QAC1C,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE;YACxB,OAAO;SACR;QAED,UAAU,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,aAAa,EAAE,CAAC,CAAC;QACpD,IAAI,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC;KAC5B;IAED,MAAM,SAAS,GAAG,UAAU,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACpD,OAAO,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IACrC,KAAK,IAAI,CAAC,GAAG,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE;QAC/C,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;QACpC,IAAI,IAAA,kBAAU,EAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE;YACzB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;SAClB;aAAM;YACL,MAAM;SACP;KACF;AACH,CAAC,CAAC;AA/BW,QAAA,cAAc,kBA+BzB;AAEF;;;;;;;;;GASG;AACI,MAAM,iBAAiB,GAAG,CAC/B,GAAW,EACX,QAAkB,EACH,EAAE;IACjB,MAAM,EAAE,QAAQ,EAAE,cAAc,EAAE,GAAG,IAAA,oCAA4B,EAAC,GAAG,CAAC,CAAC;IAEvE,MAAM,aAAa,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC;IAC7C,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE;QACxE,OAAO,IAAI,CAAC;KACb;IAED,IAAI,WAAW,GAAG,GAAG,QAAQ,GAAG,CAAC;IACjC,IAAI,IAAI,GAAa,QAAQ,CAAC,aAAa,CAAC,CAAC;IAC7C,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE;QAC1C,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE;YACxB,OAAO,IAAI,CAAC;SACb;QACD,IAAI,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC;QAC3B,yEAAyE;QACzE,IAAI,IAAA,kBAAU,EAAC,IAAI,CAAC,EAAE;YACpB,WAAW,IAAI,aAAa,CAAC;YAC7B,OAAO,WAAW,CAAC;SACpB;QACD,WAAW,IAAI,GAAG,aAAa,GAAG,CAAC;KACpC;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AA1BW,QAAA,iBAAiB,qBA0B5B;AAEF;;;;;;GAMG;AACI,MAAM,iBAAiB,GAAG,CAAC,QAAkB,EAAE,EAAY,EAAE;IAClE,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QACnC,OAAO,QAAQ,CAAC;KACjB;IACD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;QACxB,IAAA,oBAAY,EAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;KAC9B;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AATW,QAAA,iBAAiB,qBAS5B;AAEF;;;;;GAKG;AACH,MAAM,gBAAgB,GAAG,CAAC,QAAkB,EAAY,EAAE;IACxD,MAAM,IAAI,GAAa,EAAE,CAAC;IAE1B,KAAK,MAAM,CAAC,GAAG,EAAE,SAAS,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;QACvD,IAAI,CAAC,GAAG,CAAC,GAAG,gBAAgB,CAAC,SAAS,CAAC,CAAC;KACzC;IAED,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF;;;;;GAKG;AACI,MAAM,gBAAgB,GAAG,CAC9B,QAAqC,EAC3B,EAAE;IACZ,IAAI,CAAC,QAAQ,EAAE;QACb,OAAO,EAAE,CAAC;KACX;IACD,OAAO,gBAAgB,CAAC,QAAQ,CAAa,CAAC;AAChD,CAAC,CAAC;AAPW,QAAA,gBAAgB,oBAO3B","sourcesContent":["import { getHostnameAndPathComponents } from './utils';\n\nexport type PathNode = {\n  [key: string]: PathNode;\n};\n\nexport type PathTrie = Record<string, PathNode>;\n\nexport const isTerminal = (node: PathNode | undefined): boolean => {\n  if (!node || typeof node !== 'object') {\n    return false;\n  }\n  return Object.keys(node).length === 0;\n};\n\n/**\n * Insert a URL into the trie.\n *\n * @param url - The URL to insert into the trie.\n * @param pathTrie - The trie to insert the URL into.\n */\nexport const insertToTrie = (url: string, pathTrie: PathTrie) => {\n  const { hostname, pathComponents } = getHostnameAndPathComponents(url);\n\n  if (pathComponents.length === 0 || !hostname) {\n    return;\n  }\n\n  const lowerHostname = hostname.toLowerCase();\n  if (!pathTrie[lowerHostname]) {\n    pathTrie[lowerHostname] = {} as PathNode;\n  }\n\n  let curr: PathNode = pathTrie[lowerHostname];\n  for (let i = 0; i < pathComponents.length; i++) {\n    const pathComponent = pathComponents[i];\n    const isLast = i === pathComponents.length - 1;\n    const exists = curr[pathComponent] !== undefined;\n\n    if (exists) {\n      if (!isLast && isTerminal(curr[pathComponent])) {\n        return;\n      }\n\n      if (isLast) {\n        // Prune descendants if the current path component is not terminal\n        if (!isTerminal(curr[pathComponent])) {\n          curr[pathComponent] = {};\n        }\n        return;\n      }\n      curr = curr[pathComponent];\n      continue;\n    }\n\n    if (isLast) {\n      curr[pathComponent] = {};\n      return;\n    }\n    const next: PathNode = {};\n    curr[pathComponent] = next;\n    curr = next;\n  }\n};\n\n/**\n * Delete a URL from the trie.\n *\n * @param url - The URL to delete from the trie.\n * @param pathTrie - The trie to delete the URL from.\n */\nexport const deleteFromTrie = (url: string, pathTrie: PathTrie) => {\n  const { hostname, pathComponents } = getHostnameAndPathComponents(url);\n\n  const lowerHostname = hostname.toLowerCase();\n  if (pathComponents.length === 0 || !pathTrie[lowerHostname]) {\n    return;\n  }\n\n  const pathToNode: { node: PathNode; key: string }[] = [\n    { node: pathTrie, key: lowerHostname },\n  ];\n  let curr: PathNode = pathTrie[lowerHostname];\n  for (const pathComponent of pathComponents) {\n    if (!curr[pathComponent]) {\n      return;\n    }\n\n    pathToNode.push({ node: curr, key: pathComponent });\n    curr = curr[pathComponent];\n  }\n\n  const lastEntry = pathToNode[pathToNode.length - 1];\n  delete lastEntry.node[lastEntry.key];\n  for (let i = pathToNode.length - 2; i >= 0; i--) {\n    const { node, key } = pathToNode[i];\n    if (isTerminal(node[key])) {\n      delete node[key];\n    } else {\n      break;\n    }\n  }\n};\n\n/**\n * Get the concatenated hostname and path components all the way down to the\n * terminal node in the trie that is prefixed in the passed URL. It will only\n * return a string if the terminal node in the trie is contained in the passed\n * URL.\n *\n * @param url - The URL to check.\n * @param pathTrie - The trie to check the URL in.\n * @returns The matched path prefix, or null if no match is found.\n */\nexport const matchedPathPrefix = (\n  url: string,\n  pathTrie: PathTrie,\n): string | null => {\n  const { hostname, pathComponents } = getHostnameAndPathComponents(url);\n\n  const lowerHostname = hostname.toLowerCase();\n  if (pathComponents.length === 0 || !hostname || !pathTrie[lowerHostname]) {\n    return null;\n  }\n\n  let matchedPath = `${hostname}/`;\n  let curr: PathNode = pathTrie[lowerHostname];\n  for (const pathComponent of pathComponents) {\n    if (!curr[pathComponent]) {\n      return null;\n    }\n    curr = curr[pathComponent];\n    // If we've reached a terminal node, then we can return the matched path.\n    if (isTerminal(curr)) {\n      matchedPath += pathComponent;\n      return matchedPath;\n    }\n    matchedPath += `${pathComponent}/`;\n  }\n  return null;\n};\n\n/**\n * Converts a list ofpaths into a PathTrie structure. This assumes that the\n * entries are only hostname+pathname format.\n *\n * @param paths - Array of hostname+pathname\n * @returns PathTrie structure for efficient path checking\n */\nexport const convertListToTrie = (paths: string[] = []): PathTrie => {\n  const pathTrie: PathTrie = {};\n  if (!paths || !Array.isArray(paths)) {\n    return pathTrie;\n  }\n  for (const path of paths) {\n    insertToTrie(path, pathTrie);\n  }\n  return pathTrie;\n};\n\n/**\n * Creates a deep copy of a PathNode structure.\n *\n * @param original - The original PathNode to copy.\n * @returns A deep copy of the PathNode.\n */\nconst deepCopyPathNode = (original: PathNode): PathNode => {\n  const copy: PathNode = {};\n\n  for (const [key, childNode] of Object.entries(original)) {\n    copy[key] = deepCopyPathNode(childNode);\n  }\n\n  return copy;\n};\n\n/**\n * Creates a deep copy of a PathTrie structure.\n *\n * @param original - The original PathTrie to copy.\n * @returns A deep copy of the PathTrie.\n */\nexport const deepCopyPathTrie = (\n  original: PathTrie | undefined | null,\n): PathTrie => {\n  if (!original) {\n    return {};\n  }\n  return deepCopyPathNode(original) as PathTrie;\n};\n"]}

package/dist/PathTrie.d.cts

@@ -0,0 +1,46 @@
+export type PathNode = {
+    [key: string]: PathNode;
+};
+export type PathTrie = Record<string, PathNode>;
+export declare const isTerminal: (node: PathNode | undefined) => boolean;
+/**
+ * Insert a URL into the trie.
+ *
+ * @param url - The URL to insert into the trie.
+ * @param pathTrie - The trie to insert the URL into.
+ */
+export declare const insertToTrie: (url: string, pathTrie: PathTrie) => void;
+/**
+ * Delete a URL from the trie.
+ *
+ * @param url - The URL to delete from the trie.
+ * @param pathTrie - The trie to delete the URL from.
+ */
+export declare const deleteFromTrie: (url: string, pathTrie: PathTrie) => void;
+/**
+ * Get the concatenated hostname and path components all the way down to the
+ * terminal node in the trie that is prefixed in the passed URL. It will only
+ * return a string if the terminal node in the trie is contained in the passed
+ * URL.
+ *
+ * @param url - The URL to check.
+ * @param pathTrie - The trie to check the URL in.
+ * @returns The matched path prefix, or null if no match is found.
+ */
+export declare const matchedPathPrefix: (url: string, pathTrie: PathTrie) => string | null;
+/**
+ * Converts a list ofpaths into a PathTrie structure. This assumes that the
+ * entries are only hostname+pathname format.
+ *
+ * @param paths - Array of hostname+pathname
+ * @returns PathTrie structure for efficient path checking
+ */
+export declare const convertListToTrie: (paths?: string[]) => PathTrie;
+/**
+ * Creates a deep copy of a PathTrie structure.
+ *
+ * @param original - The original PathTrie to copy.
+ * @returns A deep copy of the PathTrie.
+ */
+export declare const deepCopyPathTrie: (original: PathTrie | undefined | null) => PathTrie;
+//# sourceMappingURL=PathTrie.d.cts.map

package/dist/PathTrie.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PathTrie.d.cts","sourceRoot":"","sources":["../src/PathTrie.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,QAAQ,GAAG;IACrB,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AAEhD,eAAO,MAAM,UAAU,SAAU,QAAQ,GAAG,SAAS,KAAG,OAKvD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,YAAY,QAAS,MAAM,YAAY,QAAQ,SA0C3D,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,QAAS,MAAM,YAAY,QAAQ,SA+B7D,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,iBAAiB,QACvB,MAAM,YACD,QAAQ,KACjB,MAAM,GAAG,IAuBX,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,WAAW,MAAM,EAAE,KAAQ,QASxD,CAAC;AAkBF;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,aACjB,QAAQ,GAAG,SAAS,GAAG,IAAI,KACpC,QAKF,CAAC"}

package/dist/PathTrie.d.mts

@@ -0,0 +1,46 @@
+export type PathNode = {
+    [key: string]: PathNode;
+};
+export type PathTrie = Record<string, PathNode>;
+export declare const isTerminal: (node: PathNode | undefined) => boolean;
+/**
+ * Insert a URL into the trie.
+ *
+ * @param url - The URL to insert into the trie.
+ * @param pathTrie - The trie to insert the URL into.
+ */
+export declare const insertToTrie: (url: string, pathTrie: PathTrie) => void;
+/**
+ * Delete a URL from the trie.
+ *
+ * @param url - The URL to delete from the trie.
+ * @param pathTrie - The trie to delete the URL from.
+ */
+export declare const deleteFromTrie: (url: string, pathTrie: PathTrie) => void;
+/**
+ * Get the concatenated hostname and path components all the way down to the
+ * terminal node in the trie that is prefixed in the passed URL. It will only
+ * return a string if the terminal node in the trie is contained in the passed
+ * URL.
+ *
+ * @param url - The URL to check.
+ * @param pathTrie - The trie to check the URL in.
+ * @returns The matched path prefix, or null if no match is found.
+ */
+export declare const matchedPathPrefix: (url: string, pathTrie: PathTrie) => string | null;
+/**
+ * Converts a list ofpaths into a PathTrie structure. This assumes that the
+ * entries are only hostname+pathname format.
+ *
+ * @param paths - Array of hostname+pathname
+ * @returns PathTrie structure for efficient path checking
+ */
+export declare const convertListToTrie: (paths?: string[]) => PathTrie;
+/**
+ * Creates a deep copy of a PathTrie structure.
+ *
+ * @param original - The original PathTrie to copy.
+ * @returns A deep copy of the PathTrie.
+ */
+export declare const deepCopyPathTrie: (original: PathTrie | undefined | null) => PathTrie;
+//# sourceMappingURL=PathTrie.d.mts.map

package/dist/PathTrie.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PathTrie.d.mts","sourceRoot":"","sources":["../src/PathTrie.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,QAAQ,GAAG;IACrB,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AAEhD,eAAO,MAAM,UAAU,SAAU,QAAQ,GAAG,SAAS,KAAG,OAKvD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,YAAY,QAAS,MAAM,YAAY,QAAQ,SA0C3D,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,QAAS,MAAM,YAAY,QAAQ,SA+B7D,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,iBAAiB,QACvB,MAAM,YACD,QAAQ,KACjB,MAAM,GAAG,IAuBX,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,WAAW,MAAM,EAAE,KAAQ,QASxD,CAAC;AAkBF;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,aACjB,QAAQ,GAAG,SAAS,GAAG,IAAI,KACpC,QAKF,CAAC"}

package/dist/PathTrie.mjs

@@ -0,0 +1,160 @@
+import { getHostnameAndPathComponents } from "./utils.mjs";
+export const isTerminal = (node) => {
+    if (!node || typeof node !== 'object') {
+        return false;
+    }
+    return Object.keys(node).length === 0;
+};
+/**
+ * Insert a URL into the trie.
+ *
+ * @param url - The URL to insert into the trie.
+ * @param pathTrie - The trie to insert the URL into.
+ */
+export const insertToTrie = (url, pathTrie) => {
+    const { hostname, pathComponents } = getHostnameAndPathComponents(url);
+    if (pathComponents.length === 0 || !hostname) {
+        return;
+    }
+    const lowerHostname = hostname.toLowerCase();
+    if (!pathTrie[lowerHostname]) {
+        pathTrie[lowerHostname] = {};
+    }
+    let curr = pathTrie[lowerHostname];
+    for (let i = 0; i < pathComponents.length; i++) {
+        const pathComponent = pathComponents[i];
+        const isLast = i === pathComponents.length - 1;
+        const exists = curr[pathComponent] !== undefined;
+        if (exists) {
+            if (!isLast && isTerminal(curr[pathComponent])) {
+                return;
+            }
+            if (isLast) {
+                // Prune descendants if the current path component is not terminal
+                if (!isTerminal(curr[pathComponent])) {
+                    curr[pathComponent] = {};
+                }
+                return;
+            }
+            curr = curr[pathComponent];
+            continue;
+        }
+        if (isLast) {
+            curr[pathComponent] = {};
+            return;
+        }
+        const next = {};
+        curr[pathComponent] = next;
+        curr = next;
+    }
+};
+/**
+ * Delete a URL from the trie.
+ *
+ * @param url - The URL to delete from the trie.
+ * @param pathTrie - The trie to delete the URL from.
+ */
+export const deleteFromTrie = (url, pathTrie) => {
+    const { hostname, pathComponents } = getHostnameAndPathComponents(url);
+    const lowerHostname = hostname.toLowerCase();
+    if (pathComponents.length === 0 || !pathTrie[lowerHostname]) {
+        return;
+    }
+    const pathToNode = [
+        { node: pathTrie, key: lowerHostname },
+    ];
+    let curr = pathTrie[lowerHostname];
+    for (const pathComponent of pathComponents) {
+        if (!curr[pathComponent]) {
+            return;
+        }
+        pathToNode.push({ node: curr, key: pathComponent });
+        curr = curr[pathComponent];
+    }
+    const lastEntry = pathToNode[pathToNode.length - 1];
+    delete lastEntry.node[lastEntry.key];
+    for (let i = pathToNode.length - 2; i >= 0; i--) {
+        const { node, key } = pathToNode[i];
+        if (isTerminal(node[key])) {
+            delete node[key];
+        }
+        else {
+            break;
+        }
+    }
+};
+/**
+ * Get the concatenated hostname and path components all the way down to the
+ * terminal node in the trie that is prefixed in the passed URL. It will only
+ * return a string if the terminal node in the trie is contained in the passed
+ * URL.
+ *
+ * @param url - The URL to check.
+ * @param pathTrie - The trie to check the URL in.
+ * @returns The matched path prefix, or null if no match is found.
+ */
+export const matchedPathPrefix = (url, pathTrie) => {
+    const { hostname, pathComponents } = getHostnameAndPathComponents(url);
+    const lowerHostname = hostname.toLowerCase();
+    if (pathComponents.length === 0 || !hostname || !pathTrie[lowerHostname]) {
+        return null;
+    }
+    let matchedPath = `${hostname}/`;
+    let curr = pathTrie[lowerHostname];
+    for (const pathComponent of pathComponents) {
+        if (!curr[pathComponent]) {
+            return null;
+        }
+        curr = curr[pathComponent];
+        // If we've reached a terminal node, then we can return the matched path.
+        if (isTerminal(curr)) {
+            matchedPath += pathComponent;
+            return matchedPath;
+        }
+        matchedPath += `${pathComponent}/`;
+    }
+    return null;
+};
+/**
+ * Converts a list ofpaths into a PathTrie structure. This assumes that the
+ * entries are only hostname+pathname format.
+ *
+ * @param paths - Array of hostname+pathname
+ * @returns PathTrie structure for efficient path checking
+ */
+export const convertListToTrie = (paths = []) => {
+    const pathTrie = {};
+    if (!paths || !Array.isArray(paths)) {
+        return pathTrie;
+    }
+    for (const path of paths) {
+        insertToTrie(path, pathTrie);
+    }
+    return pathTrie;
+};
+/**
+ * Creates a deep copy of a PathNode structure.
+ *
+ * @param original - The original PathNode to copy.
+ * @returns A deep copy of the PathNode.
+ */
+const deepCopyPathNode = (original) => {
+    const copy = {};
+    for (const [key, childNode] of Object.entries(original)) {
+        copy[key] = deepCopyPathNode(childNode);
+    }
+    return copy;
+};
+/**
+ * Creates a deep copy of a PathTrie structure.
+ *
+ * @param original - The original PathTrie to copy.
+ * @returns A deep copy of the PathTrie.
+ */
+export const deepCopyPathTrie = (original) => {
+    if (!original) {
+        return {};
+    }
+    return deepCopyPathNode(original);
+};
+//# sourceMappingURL=PathTrie.mjs.map

package/dist/PathTrie.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"PathTrie.mjs","sourceRoot":"","sources":["../src/PathTrie.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,4BAA4B,EAAE,oBAAgB;AAQvD,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,IAA0B,EAAW,EAAE;IAChE,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;QACrC,OAAO,KAAK,CAAC;KACd;IACD,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC;AACxC,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,GAAW,EAAE,QAAkB,EAAE,EAAE;IAC9D,MAAM,EAAE,QAAQ,EAAE,cAAc,EAAE,GAAG,4BAA4B,CAAC,GAAG,CAAC,CAAC;IAEvE,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE;QAC5C,OAAO;KACR;IAED,MAAM,aAAa,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC;IAC7C,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE;QAC5B,QAAQ,CAAC,aAAa,CAAC,GAAG,EAAc,CAAC;KAC1C;IAED,IAAI,IAAI,GAAa,QAAQ,CAAC,aAAa,CAAC,CAAC;IAC7C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,cAAc,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QAC9C,MAAM,aAAa,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;QACxC,MAAM,MAAM,GAAG,CAAC,KAAK,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC;QAC/C,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,KAAK,SAAS,CAAC;QAEjD,IAAI,MAAM,EAAE;YACV,IAAI,CAAC,MAAM,IAAI,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,EAAE;gBAC9C,OAAO;aACR;YAED,IAAI,MAAM,EAAE;gBACV,kEAAkE;gBAClE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,EAAE;oBACpC,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC;iBAC1B;gBACD,OAAO;aACR;YACD,IAAI,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC;YAC3B,SAAS;SACV;QAED,IAAI,MAAM,EAAE;YACV,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC;YACzB,OAAO;SACR;QACD,MAAM,IAAI,GAAa,EAAE,CAAC;QAC1B,IAAI,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC;QAC3B,IAAI,GAAG,IAAI,CAAC;KACb;AACH,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,GAAW,EAAE,QAAkB,EAAE,EAAE;IAChE,MAAM,EAAE,QAAQ,EAAE,cAAc,EAAE,GAAG,4BAA4B,CAAC,GAAG,CAAC,CAAC;IAEvE,MAAM,aAAa,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC;IAC7C,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE;QAC3D,OAAO;KACR;IAED,MAAM,UAAU,GAAsC;QACpD,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,aAAa,EAAE;KACvC,CAAC;IACF,IAAI,IAAI,GAAa,QAAQ,CAAC,aAAa,CAAC,CAAC;IAC7C,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE;QAC1C,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE;YACxB,OAAO;SACR;QAED,UAAU,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,aAAa,EAAE,CAAC,CAAC;QACpD,IAAI,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC;KAC5B;IAED,MAAM,SAAS,GAAG,UAAU,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACpD,OAAO,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IACrC,KAAK,IAAI,CAAC,GAAG,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE;QAC/C,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;QACpC,IAAI,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE;YACzB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;SAClB;aAAM;YACL,MAAM;SACP;KACF;AACH,CAAC,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAC/B,GAAW,EACX,QAAkB,EACH,EAAE;IACjB,MAAM,EAAE,QAAQ,EAAE,cAAc,EAAE,GAAG,4BAA4B,CAAC,GAAG,CAAC,CAAC;IAEvE,MAAM,aAAa,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC;IAC7C,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE;QACxE,OAAO,IAAI,CAAC;KACb;IAED,IAAI,WAAW,GAAG,GAAG,QAAQ,GAAG,CAAC;IACjC,IAAI,IAAI,GAAa,QAAQ,CAAC,aAAa,CAAC,CAAC;IAC7C,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE;QAC1C,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE;YACxB,OAAO,IAAI,CAAC;SACb;QACD,IAAI,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC;QAC3B,yEAAyE;QACzE,IAAI,UAAU,CAAC,IAAI,CAAC,EAAE;YACpB,WAAW,IAAI,aAAa,CAAC;YAC7B,OAAO,WAAW,CAAC;SACpB;QACD,WAAW,IAAI,GAAG,aAAa,GAAG,CAAC;KACpC;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,QAAkB,EAAE,EAAY,EAAE;IAClE,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QACnC,OAAO,QAAQ,CAAC;KACjB;IACD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;QACxB,YAAY,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;KAC9B;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,gBAAgB,GAAG,CAAC,QAAkB,EAAY,EAAE;IACxD,MAAM,IAAI,GAAa,EAAE,CAAC;IAE1B,KAAK,MAAM,CAAC,GAAG,EAAE,SAAS,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;QACvD,IAAI,CAAC,GAAG,CAAC,GAAG,gBAAgB,CAAC,SAAS,CAAC,CAAC;KACzC;IAED,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC9B,QAAqC,EAC3B,EAAE;IACZ,IAAI,CAAC,QAAQ,EAAE;QACb,OAAO,EAAE,CAAC;KACX;IACD,OAAO,gBAAgB,CAAC,QAAQ,CAAa,CAAC;AAChD,CAAC,CAAC","sourcesContent":["import { getHostnameAndPathComponents } from './utils';\n\nexport type PathNode = {\n  [key: string]: PathNode;\n};\n\nexport type PathTrie = Record<string, PathNode>;\n\nexport const isTerminal = (node: PathNode | undefined): boolean => {\n  if (!node || typeof node !== 'object') {\n    return false;\n  }\n  return Object.keys(node).length === 0;\n};\n\n/**\n * Insert a URL into the trie.\n *\n * @param url - The URL to insert into the trie.\n * @param pathTrie - The trie to insert the URL into.\n */\nexport const insertToTrie = (url: string, pathTrie: PathTrie) => {\n  const { hostname, pathComponents } = getHostnameAndPathComponents(url);\n\n  if (pathComponents.length === 0 || !hostname) {\n    return;\n  }\n\n  const lowerHostname = hostname.toLowerCase();\n  if (!pathTrie[lowerHostname]) {\n    pathTrie[lowerHostname] = {} as PathNode;\n  }\n\n  let curr: PathNode = pathTrie[lowerHostname];\n  for (let i = 0; i < pathComponents.length; i++) {\n    const pathComponent = pathComponents[i];\n    const isLast = i === pathComponents.length - 1;\n    const exists = curr[pathComponent] !== undefined;\n\n    if (exists) {\n      if (!isLast && isTerminal(curr[pathComponent])) {\n        return;\n      }\n\n      if (isLast) {\n        // Prune descendants if the current path component is not terminal\n        if (!isTerminal(curr[pathComponent])) {\n          curr[pathComponent] = {};\n        }\n        return;\n      }\n      curr = curr[pathComponent];\n      continue;\n    }\n\n    if (isLast) {\n      curr[pathComponent] = {};\n      return;\n    }\n    const next: PathNode = {};\n    curr[pathComponent] = next;\n    curr = next;\n  }\n};\n\n/**\n * Delete a URL from the trie.\n *\n * @param url - The URL to delete from the trie.\n * @param pathTrie - The trie to delete the URL from.\n */\nexport const deleteFromTrie = (url: string, pathTrie: PathTrie) => {\n  const { hostname, pathComponents } = getHostnameAndPathComponents(url);\n\n  const lowerHostname = hostname.toLowerCase();\n  if (pathComponents.length === 0 || !pathTrie[lowerHostname]) {\n    return;\n  }\n\n  const pathToNode: { node: PathNode; key: string }[] = [\n    { node: pathTrie, key: lowerHostname },\n  ];\n  let curr: PathNode = pathTrie[lowerHostname];\n  for (const pathComponent of pathComponents) {\n    if (!curr[pathComponent]) {\n      return;\n    }\n\n    pathToNode.push({ node: curr, key: pathComponent });\n    curr = curr[pathComponent];\n  }\n\n  const lastEntry = pathToNode[pathToNode.length - 1];\n  delete lastEntry.node[lastEntry.key];\n  for (let i = pathToNode.length - 2; i >= 0; i--) {\n    const { node, key } = pathToNode[i];\n    if (isTerminal(node[key])) {\n      delete node[key];\n    } else {\n      break;\n    }\n  }\n};\n\n/**\n * Get the concatenated hostname and path components all the way down to the\n * terminal node in the trie that is prefixed in the passed URL. It will only\n * return a string if the terminal node in the trie is contained in the passed\n * URL.\n *\n * @param url - The URL to check.\n * @param pathTrie - The trie to check the URL in.\n * @returns The matched path prefix, or null if no match is found.\n */\nexport const matchedPathPrefix = (\n  url: string,\n  pathTrie: PathTrie,\n): string | null => {\n  const { hostname, pathComponents } = getHostnameAndPathComponents(url);\n\n  const lowerHostname = hostname.toLowerCase();\n  if (pathComponents.length === 0 || !hostname || !pathTrie[lowerHostname]) {\n    return null;\n  }\n\n  let matchedPath = `${hostname}/`;\n  let curr: PathNode = pathTrie[lowerHostname];\n  for (const pathComponent of pathComponents) {\n    if (!curr[pathComponent]) {\n      return null;\n    }\n    curr = curr[pathComponent];\n    // If we've reached a terminal node, then we can return the matched path.\n    if (isTerminal(curr)) {\n      matchedPath += pathComponent;\n      return matchedPath;\n    }\n    matchedPath += `${pathComponent}/`;\n  }\n  return null;\n};\n\n/**\n * Converts a list ofpaths into a PathTrie structure. This assumes that the\n * entries are only hostname+pathname format.\n *\n * @param paths - Array of hostname+pathname\n * @returns PathTrie structure for efficient path checking\n */\nexport const convertListToTrie = (paths: string[] = []): PathTrie => {\n  const pathTrie: PathTrie = {};\n  if (!paths || !Array.isArray(paths)) {\n    return pathTrie;\n  }\n  for (const path of paths) {\n    insertToTrie(path, pathTrie);\n  }\n  return pathTrie;\n};\n\n/**\n * Creates a deep copy of a PathNode structure.\n *\n * @param original - The original PathNode to copy.\n * @returns A deep copy of the PathNode.\n */\nconst deepCopyPathNode = (original: PathNode): PathNode => {\n  const copy: PathNode = {};\n\n  for (const [key, childNode] of Object.entries(original)) {\n    copy[key] = deepCopyPathNode(childNode);\n  }\n\n  return copy;\n};\n\n/**\n * Creates a deep copy of a PathTrie structure.\n *\n * @param original - The original PathTrie to copy.\n * @returns A deep copy of the PathTrie.\n */\nexport const deepCopyPathTrie = (\n  original: PathTrie | undefined | null,\n): PathTrie => {\n  if (!original) {\n    return {};\n  }\n  return deepCopyPathNode(original) as PathTrie;\n};\n"]}

package/dist/PhishingController.cjs

@@ -17,6 +17,7 @@ const base_controller_1 = require("@metamask/base-controller");
 const controller_utils_1 = require("@metamask/controller-utils");
 const punycode_js_1 = require("punycode/punycode.js");
 const CacheManager_1 = require("./CacheManager.cjs");
+const PathTrie_1 = require("./PathTrie.cjs");
 const PhishingDetector_1 = require("./PhishingDetector.cjs");
 const types_1 = require("./types.cjs");
 const utils_1 = require("./utils.cjs");
@@ -84,6 +85,12 @@ const metadata = {
         anonymous: false,
         usedInUi: false,
     },
+    whitelistPaths: {
+        includeInStateLogs: false,
+        persist: true,
+        anonymous: false,
+        usedInUi: false,
+    },
     hotlistLastFetched: {
         includeInStateLogs: true,
         persist: true,
@@ -117,12 +124,14 @@ const metadata = {
 };
 /**
  * Get a default empty state for the controller.
+ *
  * @returns The default empty state.
  */
 const getDefaultState = () => {
     return {
         phishingLists: [],
         whitelist: [],
+        whitelistPaths: {},
         hotlistLastFetched: 0,
         stalelistLastFetched: 0,
         c2DomainBlocklistLastFetched: 0,
@@ -610,6 +619,10 @@ class PhishingController extends base_controller_1.BaseController {
     test(origin) {
         const punycodeOrigin = (0, punycode_js_1.toASCII)(origin);
         const hostname = (0, utils_1.getHostnameFromUrl)(punycodeOrigin);
+        const hostnameWithPaths = hostname + (0, utils_1.getPathnameFromUrl)(origin);
+        if ((0, PathTrie_1.matchedPathPrefix)(hostnameWithPaths, this.state.whitelistPaths)) {
+            return { result: false, type: types_1.PhishingDetectorResultType.All };
+        }
         if (this.state.whitelist.includes(hostname || punycodeOrigin)) {
             return { result: false, type: types_1.PhishingDetectorResultType.All }; // Same as whitelisted match returned by detector.check(...).
         }
@@ -641,8 +654,19 @@ class PhishingController extends base_controller_1.BaseController {
     bypass(origin) {
         const punycodeOrigin = (0, punycode_js_1.toASCII)(origin);
         const hostname = (0, utils_1.getHostnameFromUrl)(punycodeOrigin);
-        const { whitelist } = this.state;
-        if (whitelist.includes(hostname || punycodeOrigin)) {
+        const hostnameWithPaths = hostname + (0, utils_1.getPathnameFromUrl)(origin);
+        const { whitelist, whitelistPaths } = this.state;
+        const whitelistPath = (0, PathTrie_1.matchedPathPrefix)(hostnameWithPaths, whitelistPaths);
+        if (whitelist.includes(hostname || punycodeOrigin) || whitelistPath) {
+            return;
+        }
+        // If the origin was blocked by a path, then we only want to add it to the whitelistPaths since
+        // other paths with the same hostname may not be blocked.
+        const blockingPath = __classPrivateFieldGet(this, _PhishingController_detector, "f").blockingPath(origin);
+        if (blockingPath) {
+            this.update((draftState) => {
+                (0, PathTrie_1.insertToTrie)(blockingPath, draftState.whitelistPaths);
+            });
             return;
         }
         this.update((draftState) => {
@@ -801,11 +825,14 @@ async function _PhishingController_updateStalelist() {
     if (!stalelistResponse || !hotlistDiffsResponse) {
         return;
     }
-    // TODO: Either fix this lint violation or explain why it's necessary to ignore.
-    const { eth_phishing_detect_config, ...partialState } = stalelistResponse.data;
     const metamaskListState = {
-        ...eth_phishing_detect_config,
-        ...partialState,
+        allowlist: stalelistResponse.data.allowlist,
+        fuzzylist: stalelistResponse.data.fuzzylist,
+        tolerance: stalelistResponse.data.tolerance,
+        version: stalelistResponse.data.version,
+        lastUpdated: stalelistResponse.data.lastUpdated,
+        blocklist: stalelistResponse.data.blocklist,
+        blocklistPaths: (0, PathTrie_1.convertListToTrie)(stalelistResponse.data.blocklistPaths),
         c2DomainBlocklist: c2DomainBlocklistResponse
             ? c2DomainBlocklistResponse.recentlyAdded
             : [],