@metamask-previews/phishing-controller 12.0.2-preview-367cb1da → 12.0.2-preview-cf09c0a

package/dist/index.d.cts

@@ -0,0 +1,5 @@
+export * from "./PhishingController.cjs";
+export type { LegacyPhishingDetectorList, PhishingDetectorList, FuzzyTolerance, PhishingDetectorOptions, PhishingDetectorConfiguration, } from "./PhishingDetector.cjs";
+export { PhishingDetector } from "./PhishingDetector.cjs";
+export { PhishingDetectorResultType } from "./types.cjs";
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,yCAAqC;AACrC,YAAY,EACV,0BAA0B,EAC1B,oBAAoB,EACpB,cAAc,EACd,uBAAuB,EACvB,6BAA6B,GAC9B,+BAA2B;AAC5B,OAAO,EAAE,gBAAgB,EAAE,+BAA2B;AACtD,OAAO,EAAE,0BAA0B,EAAE,oBAAgB"}

package/dist/index.d.mts

@@ -0,0 +1,5 @@
+export * from "./PhishingController.mjs";
+export type { LegacyPhishingDetectorList, PhishingDetectorList, FuzzyTolerance, PhishingDetectorOptions, PhishingDetectorConfiguration, } from "./PhishingDetector.mjs";
+export { PhishingDetector } from "./PhishingDetector.mjs";
+export { PhishingDetectorResultType } from "./types.mjs";
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,yCAAqC;AACrC,YAAY,EACV,0BAA0B,EAC1B,oBAAoB,EACpB,cAAc,EACd,uBAAuB,EACvB,6BAA6B,GAC9B,+BAA2B;AAC5B,OAAO,EAAE,gBAAgB,EAAE,+BAA2B;AACtD,OAAO,EAAE,0BAA0B,EAAE,oBAAgB"}

package/dist/index.mjs

@@ -1,42 +1,4 @@
-import {
-  C2_DOMAIN_BLOCKLIST_ENDPOINT,
-  C2_DOMAIN_BLOCKLIST_REFRESH_INTERVAL,
-  C2_DOMAIN_BLOCKLIST_URL,
-  CLIENT_SIDE_DETECION_BASE_URL,
-  HOTLIST_REFRESH_INTERVAL,
-  ListKeys,
-  ListNames,
-  METAMASK_HOTLIST_DIFF_FILE,
-  METAMASK_HOTLIST_DIFF_URL,
-  METAMASK_STALELIST_FILE,
-  METAMASK_STALELIST_URL,
-  PHISHING_CONFIG_BASE_URL,
-  PhishingController,
-  PhishingDetector,
-  STALELIST_REFRESH_INTERVAL,
-  phishingListKeyNameMap
-} from "./chunk-I3U4U3MW.mjs";
-import {
-  PhishingDetectorResultType
-} from "./chunk-G2RL74NS.mjs";
-import "./chunk-XUI43LEZ.mjs";
-export {
-  C2_DOMAIN_BLOCKLIST_ENDPOINT,
-  C2_DOMAIN_BLOCKLIST_REFRESH_INTERVAL,
-  C2_DOMAIN_BLOCKLIST_URL,
-  CLIENT_SIDE_DETECION_BASE_URL,
-  HOTLIST_REFRESH_INTERVAL,
-  ListKeys,
-  ListNames,
-  METAMASK_HOTLIST_DIFF_FILE,
-  METAMASK_HOTLIST_DIFF_URL,
-  METAMASK_STALELIST_FILE,
-  METAMASK_STALELIST_URL,
-  PHISHING_CONFIG_BASE_URL,
-  PhishingController,
-  PhishingDetector,
-  PhishingDetectorResultType,
-  STALELIST_REFRESH_INTERVAL,
-  phishingListKeyNameMap
-};
+export * from "./PhishingController.mjs";
+export { PhishingDetector } from "./PhishingDetector.mjs";
+export { PhishingDetectorResultType } from "./types.mjs";
 //# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,yCAAqC;AAQrC,OAAO,EAAE,gBAAgB,EAAE,+BAA2B;AACtD,OAAO,EAAE,0BAA0B,EAAE,oBAAgB","sourcesContent":["export * from './PhishingController';\nexport type {\n  LegacyPhishingDetectorList,\n  PhishingDetectorList,\n  FuzzyTolerance,\n  PhishingDetectorOptions,\n  PhishingDetectorConfiguration,\n} from './PhishingDetector';\nexport { PhishingDetector } from './PhishingDetector';\nexport { PhishingDetectorResultType } from './types';\n"]}

package/dist/tests/utils.cjs

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatHostnameToUrl = void 0;
+/**
+ * Formats a hostname into a URL so we can parse it correctly
+ * and pass full URLs into the PhishingDetector class. Previously
+ * only hostnames were supported, but now only full URLs are
+ * supported since we want to block IPFS CIDs.
+ *
+ * @param hostname - the hostname of the URL.
+ * @returns the href property of a URL object.
+ */
+const formatHostnameToUrl = (hostname) => {
+    let url = '';
+    try {
+        url = new URL(hostname).href;
+    }
+    catch (e) {
+        url = new URL(['https://', hostname].join('')).href;
+    }
+    return url;
+};
+exports.formatHostnameToUrl = formatHostnameToUrl;
+//# sourceMappingURL=utils.cjs.map

package/dist/tests/utils.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.cjs","sourceRoot":"","sources":["../../src/tests/utils.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;GAQG;AACI,MAAM,mBAAmB,GAAG,CAAC,QAAgB,EAAU,EAAE;IAC9D,IAAI,GAAG,GAAG,EAAE,CAAC;IACb,IAAI;QACF,GAAG,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC;KAC9B;IAAC,OAAO,CAAC,EAAE;QACV,GAAG,GAAG,IAAI,GAAG,CAAC,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;KACrD;IACD,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AARW,QAAA,mBAAmB,uBAQ9B","sourcesContent":["/**\n * Formats a hostname into a URL so we can parse it correctly\n * and pass full URLs into the PhishingDetector class. Previously\n * only hostnames were supported, but now only full URLs are\n * supported since we want to block IPFS CIDs.\n *\n * @param hostname - the hostname of the URL.\n * @returns the href property of a URL object.\n */\nexport const formatHostnameToUrl = (hostname: string): string => {\n  let url = '';\n  try {\n    url = new URL(hostname).href;\n  } catch (e) {\n    url = new URL(['https://', hostname].join('')).href;\n  }\n  return url;\n};\n"]}

package/dist/{types/tests/utils.d.ts → tests/utils.d.cts}

@@ -8,4 +8,4 @@
  * @returns the href property of a URL object.
  */
 export declare const formatHostnameToUrl: (hostname: string) => string;
-//# sourceMappingURL=utils.d.ts.map
+//# sourceMappingURL=utils.d.cts.map

package/dist/tests/utils.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.cts","sourceRoot":"","sources":["../../src/tests/utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,eAAO,MAAM,mBAAmB,aAAc,MAAM,KAAG,MAQtD,CAAC"}

package/dist/tests/utils.d.mts

@@ -0,0 +1,11 @@
+/**
+ * Formats a hostname into a URL so we can parse it correctly
+ * and pass full URLs into the PhishingDetector class. Previously
+ * only hostnames were supported, but now only full URLs are
+ * supported since we want to block IPFS CIDs.
+ *
+ * @param hostname - the hostname of the URL.
+ * @returns the href property of a URL object.
+ */
+export declare const formatHostnameToUrl: (hostname: string) => string;
+//# sourceMappingURL=utils.d.mts.map

package/dist/tests/utils.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.mts","sourceRoot":"","sources":["../../src/tests/utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,eAAO,MAAM,mBAAmB,aAAc,MAAM,KAAG,MAQtD,CAAC"}

package/dist/tests/utils.mjs

@@ -1,16 +1,20 @@
-import "../chunk-XUI43LEZ.mjs";
-
-// src/tests/utils.ts
-var formatHostnameToUrl = (hostname) => {
-  let url = "";
-  try {
-    url = new URL(hostname).href;
-  } catch (e) {
-    url = new URL(["https://", hostname].join("")).href;
-  }
-  return url;
-};
-export {
-  formatHostnameToUrl
+/**
+ * Formats a hostname into a URL so we can parse it correctly
+ * and pass full URLs into the PhishingDetector class. Previously
+ * only hostnames were supported, but now only full URLs are
+ * supported since we want to block IPFS CIDs.
+ *
+ * @param hostname - the hostname of the URL.
+ * @returns the href property of a URL object.
+ */
+export const formatHostnameToUrl = (hostname) => {
+    let url = '';
+    try {
+        url = new URL(hostname).href;
+    }
+    catch (e) {
+        url = new URL(['https://', hostname].join('')).href;
+    }
+    return url;
 };
 //# sourceMappingURL=utils.mjs.map

package/dist/tests/utils.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/tests/utils.ts"],"sourcesContent":["/**\n * Formats a hostname into a URL so we can parse it correctly\n * and pass full URLs into the PhishingDetector class. Previously\n * only hostnames were supported, but now only full URLs are\n * supported since we want to block IPFS CIDs.\n *\n * @param hostname - the hostname of the URL.\n * @returns the href property of a URL object.\n */\nexport const formatHostnameToUrl = (hostname: string): string => {\n  let url = '';\n  try {\n    url = new URL(hostname).href;\n  } catch (e) {\n    url = new URL(['https://', hostname].join('')).href;\n  }\n  return url;\n};\n"],"mappings":";;;AASO,IAAM,sBAAsB,CAAC,aAA6B;AAC/D,MAAI,MAAM;AACV,MAAI;AACF,UAAM,IAAI,IAAI,QAAQ,EAAE;AAAA,EAC1B,SAAS,GAAG;AACV,UAAM,IAAI,IAAI,CAAC,YAAY,QAAQ,EAAE,KAAK,EAAE,CAAC,EAAE;AAAA,EACjD;AACA,SAAO;AACT;","names":[]}
+{"version":3,"file":"utils.mjs","sourceRoot":"","sources":["../../src/tests/utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,QAAgB,EAAU,EAAE;IAC9D,IAAI,GAAG,GAAG,EAAE,CAAC;IACb,IAAI;QACF,GAAG,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC;KAC9B;IAAC,OAAO,CAAC,EAAE;QACV,GAAG,GAAG,IAAI,GAAG,CAAC,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;KACrD;IACD,OAAO,GAAG,CAAC;AACb,CAAC,CAAC","sourcesContent":["/**\n * Formats a hostname into a URL so we can parse it correctly\n * and pass full URLs into the PhishingDetector class. Previously\n * only hostnames were supported, but now only full URLs are\n * supported since we want to block IPFS CIDs.\n *\n * @param hostname - the hostname of the URL.\n * @returns the href property of a URL object.\n */\nexport const formatHostnameToUrl = (hostname: string): string => {\n  let url = '';\n  try {\n    url = new URL(hostname).href;\n  } catch (e) {\n    url = new URL(['https://', hostname].join('')).href;\n  }\n  return url;\n};\n"]}

package/dist/types.cjs

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PhishingDetectorResultType = void 0;
+/**
+ * The type of list in which the domain was found.
+ */
+var PhishingDetectorResultType;
+(function (PhishingDetectorResultType) {
+    /*
+     * "all" means that the domain was not found in any list.
+     */
+    PhishingDetectorResultType["All"] = "all";
+    /*
+     * "fuzzy" means that the domain was found in the fuzzylist.
+     */
+    PhishingDetectorResultType["Fuzzy"] = "fuzzy";
+    /*
+     * "blocklist" means that the domain was found in the blocklist.
+     */
+    PhishingDetectorResultType["Blocklist"] = "blocklist";
+    /*
+     * "allowlist" means that the domain was found in the allowlist.
+     */
+    PhishingDetectorResultType["Allowlist"] = "allowlist";
+    /*
+     * "blacklist" means that the domain was found in a blacklist of a legacy
+     * configuration object.
+     */
+    PhishingDetectorResultType["Blacklist"] = "blacklist";
+    /*
+     * "whitelist" means that the domain was found in a whitelist of a legacy
+     * configuration object.
+     */
+    PhishingDetectorResultType["Whitelist"] = "whitelist";
+    /*
+     * "c2DomainBlocklist" means that the domain was found in the C2 domain blocklist.
+     */
+    PhishingDetectorResultType["C2DomainBlocklist"] = "c2DomainBlocklist";
+})(PhishingDetectorResultType || (exports.PhishingDetectorResultType = PhishingDetectorResultType = {}));
+//# sourceMappingURL=types.cjs.map

package/dist/types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.cjs","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAsCA;;GAEG;AACH,IAAY,0BA+BX;AA/BD,WAAY,0BAA0B;IACpC;;OAEG;IACH,yCAAW,CAAA;IACX;;OAEG;IACH,6CAAe,CAAA;IACf;;OAEG;IACH,qDAAuB,CAAA;IACvB;;OAEG;IACH,qDAAuB,CAAA;IACvB;;;OAGG;IACH,qDAAuB,CAAA;IACvB;;;OAGG;IACH,qDAAuB,CAAA;IACvB;;OAEG;IACH,qEAAuC,CAAA;AACzC,CAAC,EA/BW,0BAA0B,0CAA1B,0BAA0B,QA+BrC","sourcesContent":["/**\n * Represents the result of checking a domain.\n */\nexport type PhishingDetectorResult = {\n  /**\n   * The name of the configuration object in which the domain was found within\n   * an allowlist, blocklist, or fuzzylist.\n   */\n  name?: string;\n  /**\n   * The version associated with the configuration object in which the domain\n   * was found within an allowlist, blocklist, or fuzzylist.\n   */\n  version?: string;\n  /**\n   * Whether the domain is regarded as allowed (true) or not (false).\n   */\n  result: boolean;\n  /**\n   * A normalized version of the domain, which is only constructed if the domain\n   * is found within a list.\n   */\n  match?: string;\n  /**\n   * Which type of list in which the domain was found.\n   *\n   * - \"allowlist\" means that the domain was found in the allowlist.\n   * - \"blocklist\" means that the domain was found in the blocklist.\n   * - \"fuzzy\" means that the domain was found in the fuzzylist.\n   * - \"blacklist\" means that the domain was found in a blacklist of a legacy\n   * configuration object.\n   * - \"whitelist\" means that the domain was found in a whitelist of a legacy\n   * configuration object.\n   * - \"all\" means that the domain was not found in any list.\n   */\n  type: PhishingDetectorResultType;\n};\n\n/**\n * The type of list in which the domain was found.\n */\nexport enum PhishingDetectorResultType {\n  /*\n   * \"all\" means that the domain was not found in any list.\n   */\n  All = 'all',\n  /*\n   * \"fuzzy\" means that the domain was found in the fuzzylist.\n   */\n  Fuzzy = 'fuzzy',\n  /*\n   * \"blocklist\" means that the domain was found in the blocklist.\n   */\n  Blocklist = 'blocklist',\n  /*\n   * \"allowlist\" means that the domain was found in the allowlist.\n   */\n  Allowlist = 'allowlist',\n  /*\n   * \"blacklist\" means that the domain was found in a blacklist of a legacy\n   * configuration object.\n   */\n  Blacklist = 'blacklist',\n  /*\n   * \"whitelist\" means that the domain was found in a whitelist of a legacy\n   * configuration object.\n   */\n  Whitelist = 'whitelist',\n  /*\n   * \"c2DomainBlocklist\" means that the domain was found in the C2 domain blocklist.\n   */\n  C2DomainBlocklist = 'c2DomainBlocklist',\n}\n"]}

package/dist/{types/types.d.ts → types.d.cts}

@@ -47,4 +47,4 @@ export declare enum PhishingDetectorResultType {
     Whitelist = "whitelist",
     C2DomainBlocklist = "c2DomainBlocklist"
 }
-//# sourceMappingURL=types.d.ts.map
+//# sourceMappingURL=types.d.cts.map

package/dist/types.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.cts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAChB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;;;;;;;;OAWG;IACH,IAAI,EAAE,0BAA0B,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,oBAAY,0BAA0B;IAIpC,GAAG,QAAQ;IAIX,KAAK,UAAU;IAIf,SAAS,cAAc;IAIvB,SAAS,cAAc;IAKvB,SAAS,cAAc;IAKvB,SAAS,cAAc;IAIvB,iBAAiB,sBAAsB;CACxC"}

package/dist/types.d.mts

@@ -0,0 +1,50 @@
+/**
+ * Represents the result of checking a domain.
+ */
+export type PhishingDetectorResult = {
+    /**
+     * The name of the configuration object in which the domain was found within
+     * an allowlist, blocklist, or fuzzylist.
+     */
+    name?: string;
+    /**
+     * The version associated with the configuration object in which the domain
+     * was found within an allowlist, blocklist, or fuzzylist.
+     */
+    version?: string;
+    /**
+     * Whether the domain is regarded as allowed (true) or not (false).
+     */
+    result: boolean;
+    /**
+     * A normalized version of the domain, which is only constructed if the domain
+     * is found within a list.
+     */
+    match?: string;
+    /**
+     * Which type of list in which the domain was found.
+     *
+     * - "allowlist" means that the domain was found in the allowlist.
+     * - "blocklist" means that the domain was found in the blocklist.
+     * - "fuzzy" means that the domain was found in the fuzzylist.
+     * - "blacklist" means that the domain was found in a blacklist of a legacy
+     * configuration object.
+     * - "whitelist" means that the domain was found in a whitelist of a legacy
+     * configuration object.
+     * - "all" means that the domain was not found in any list.
+     */
+    type: PhishingDetectorResultType;
+};
+/**
+ * The type of list in which the domain was found.
+ */
+export declare enum PhishingDetectorResultType {
+    All = "all",
+    Fuzzy = "fuzzy",
+    Blocklist = "blocklist",
+    Allowlist = "allowlist",
+    Blacklist = "blacklist",
+    Whitelist = "whitelist",
+    C2DomainBlocklist = "c2DomainBlocklist"
+}
+//# sourceMappingURL=types.d.mts.map

package/dist/types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.mts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAChB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;;;;;;;;OAWG;IACH,IAAI,EAAE,0BAA0B,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,oBAAY,0BAA0B;IAIpC,GAAG,QAAQ;IAIX,KAAK,UAAU;IAIf,SAAS,cAAc;IAIvB,SAAS,cAAc;IAKvB,SAAS,cAAc;IAKvB,SAAS,cAAc;IAIvB,iBAAiB,sBAAsB;CACxC"}

package/dist/types.mjs

@@ -1,8 +1,37 @@
-import {
-  PhishingDetectorResultType
-} from "./chunk-G2RL74NS.mjs";
-import "./chunk-XUI43LEZ.mjs";
-export {
-  PhishingDetectorResultType
-};
+/**
+ * The type of list in which the domain was found.
+ */
+export var PhishingDetectorResultType;
+(function (PhishingDetectorResultType) {
+    /*
+     * "all" means that the domain was not found in any list.
+     */
+    PhishingDetectorResultType["All"] = "all";
+    /*
+     * "fuzzy" means that the domain was found in the fuzzylist.
+     */
+    PhishingDetectorResultType["Fuzzy"] = "fuzzy";
+    /*
+     * "blocklist" means that the domain was found in the blocklist.
+     */
+    PhishingDetectorResultType["Blocklist"] = "blocklist";
+    /*
+     * "allowlist" means that the domain was found in the allowlist.
+     */
+    PhishingDetectorResultType["Allowlist"] = "allowlist";
+    /*
+     * "blacklist" means that the domain was found in a blacklist of a legacy
+     * configuration object.
+     */
+    PhishingDetectorResultType["Blacklist"] = "blacklist";
+    /*
+     * "whitelist" means that the domain was found in a whitelist of a legacy
+     * configuration object.
+     */
+    PhishingDetectorResultType["Whitelist"] = "whitelist";
+    /*
+     * "c2DomainBlocklist" means that the domain was found in the C2 domain blocklist.
+     */
+    PhishingDetectorResultType["C2DomainBlocklist"] = "c2DomainBlocklist";
+})(PhishingDetectorResultType || (PhishingDetectorResultType = {}));
 //# sourceMappingURL=types.mjs.map

package/dist/types.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"types.mjs","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAsCA;;GAEG;AACH,MAAM,CAAN,IAAY,0BA+BX;AA/BD,WAAY,0BAA0B;IACpC;;OAEG;IACH,yCAAW,CAAA;IACX;;OAEG;IACH,6CAAe,CAAA;IACf;;OAEG;IACH,qDAAuB,CAAA;IACvB;;OAEG;IACH,qDAAuB,CAAA;IACvB;;;OAGG;IACH,qDAAuB,CAAA;IACvB;;;OAGG;IACH,qDAAuB,CAAA;IACvB;;OAEG;IACH,qEAAuC,CAAA;AACzC,CAAC,EA/BW,0BAA0B,KAA1B,0BAA0B,QA+BrC","sourcesContent":["/**\n * Represents the result of checking a domain.\n */\nexport type PhishingDetectorResult = {\n  /**\n   * The name of the configuration object in which the domain was found within\n   * an allowlist, blocklist, or fuzzylist.\n   */\n  name?: string;\n  /**\n   * The version associated with the configuration object in which the domain\n   * was found within an allowlist, blocklist, or fuzzylist.\n   */\n  version?: string;\n  /**\n   * Whether the domain is regarded as allowed (true) or not (false).\n   */\n  result: boolean;\n  /**\n   * A normalized version of the domain, which is only constructed if the domain\n   * is found within a list.\n   */\n  match?: string;\n  /**\n   * Which type of list in which the domain was found.\n   *\n   * - \"allowlist\" means that the domain was found in the allowlist.\n   * - \"blocklist\" means that the domain was found in the blocklist.\n   * - \"fuzzy\" means that the domain was found in the fuzzylist.\n   * - \"blacklist\" means that the domain was found in a blacklist of a legacy\n   * configuration object.\n   * - \"whitelist\" means that the domain was found in a whitelist of a legacy\n   * configuration object.\n   * - \"all\" means that the domain was not found in any list.\n   */\n  type: PhishingDetectorResultType;\n};\n\n/**\n * The type of list in which the domain was found.\n */\nexport enum PhishingDetectorResultType {\n  /*\n   * \"all\" means that the domain was not found in any list.\n   */\n  All = 'all',\n  /*\n   * \"fuzzy\" means that the domain was found in the fuzzylist.\n   */\n  Fuzzy = 'fuzzy',\n  /*\n   * \"blocklist\" means that the domain was found in the blocklist.\n   */\n  Blocklist = 'blocklist',\n  /*\n   * \"allowlist\" means that the domain was found in the allowlist.\n   */\n  Allowlist = 'allowlist',\n  /*\n   * \"blacklist\" means that the domain was found in a blacklist of a legacy\n   * configuration object.\n   */\n  Blacklist = 'blacklist',\n  /*\n   * \"whitelist\" means that the domain was found in a whitelist of a legacy\n   * configuration object.\n   */\n  Whitelist = 'whitelist',\n  /*\n   * \"c2DomainBlocklist\" means that the domain was found in the C2 domain blocklist.\n   */\n  C2DomainBlocklist = 'c2DomainBlocklist',\n}\n"]}

package/dist/utils.cjs

@@ -0,0 +1,242 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getHostnameFromUrl = exports.sha256Hash = exports.matchPartsAgainstList = exports.domainPartsToFuzzyForm = exports.domainPartsToDomain = exports.processConfigs = exports.getDefaultPhishingDetectorConfig = exports.processDomainList = exports.domainToParts = exports.validateConfig = exports.applyDiffs = exports.roundToNearestMinute = exports.fetchTimeNow = void 0;
+const utils_1 = require("@noble/hashes/utils");
+const sha256_1 = require("ethereum-cryptography/sha256");
+const PhishingController_1 = require("./PhishingController.cjs");
+const DEFAULT_TOLERANCE = 3;
+/**
+ * Fetches current epoch time in seconds.
+ *
+ * @returns the Date.now() time in seconds instead of miliseconds. backend files rely on timestamps in seconds since epoch.
+ */
+const fetchTimeNow = () => Math.round(Date.now() / 1000);
+exports.fetchTimeNow = fetchTimeNow;
+/**
+ * Rounds a Unix timestamp down to the nearest minute.
+ *
+ * @param unixTimestamp - The Unix timestamp to be rounded.
+ * @returns The rounded Unix timestamp.
+ */
+function roundToNearestMinute(unixTimestamp) {
+    return Math.floor(unixTimestamp / 60) * 60;
+}
+exports.roundToNearestMinute = roundToNearestMinute;
+/**
+ * Split a string into two pieces, using the first period as the delimiter.
+ *
+ * @param stringToSplit - The string to split.
+ * @returns An array of length two containing the beginning and end of the string.
+ */
+const splitStringByPeriod = (stringToSplit) => {
+    const periodIndex = stringToSplit.indexOf('.');
+    return [
+        stringToSplit.slice(0, periodIndex),
+        stringToSplit.slice(periodIndex + 1),
+    ];
+};
+/**
+ * Determines which diffs are applicable to the listState, then applies those diffs.
+ *
+ * @param listState - the stalelist or the existing liststate that diffs will be applied to.
+ * @param hotlistDiffs - the diffs to apply to the listState if valid.
+ * @param listKey - the key associated with the input/output phishing list state.
+ * @param recentlyAddedC2Domains - list of hashed C2 domains to add to the local c2 domain blocklist
+ * @param recentlyRemovedC2Domains - list of hashed C2 domains to remove from the local c2 domain blocklist
+ * @returns the new list state
+ */
+const applyDiffs = (listState, hotlistDiffs, listKey, recentlyAddedC2Domains = [], recentlyRemovedC2Domains = []) => {
+    // filter to remove diffs that were added before the lastUpdate time.
+    // filter to remove diffs that aren't applicable to the specified list (by listKey).
+    const diffsToApply = hotlistDiffs.filter(({ timestamp, targetList }) => timestamp > listState.lastUpdated &&
+        splitStringByPeriod(targetList)[0] === listKey);
+    // the reason behind using latestDiffTimestamp as the lastUpdated time
+    // is so that we can benefit server-side from memoization due to end client's
+    // `GET /v1/diffSince/:timestamp` requests lining up with
+    // our periodic updates (which create diffs at specific timestamps).
+    let latestDiffTimestamp = listState.lastUpdated;
+    const listSets = {
+        allowlist: new Set(listState.allowlist),
+        blocklist: new Set(listState.blocklist),
+        fuzzylist: new Set(listState.fuzzylist),
+        c2DomainBlocklist: new Set(listState.c2DomainBlocklist),
+    };
+    for (const { isRemoval, targetList, url, timestamp } of diffsToApply) {
+        const targetListType = splitStringByPeriod(targetList)[1];
+        if (timestamp > latestDiffTimestamp) {
+            latestDiffTimestamp = timestamp;
+        }
+        if (isRemoval) {
+            listSets[targetListType].delete(url);
+        }
+        else {
+            listSets[targetListType].add(url);
+        }
+    }
+    if (listKey === PhishingController_1.ListKeys.EthPhishingDetectConfig) {
+        for (const hash of recentlyAddedC2Domains) {
+            listSets.c2DomainBlocklist.add(hash);
+        }
+        for (const hash of recentlyRemovedC2Domains) {
+            listSets.c2DomainBlocklist.delete(hash);
+        }
+    }
+    return {
+        c2DomainBlocklist: Array.from(listSets.c2DomainBlocklist),
+        allowlist: Array.from(listSets.allowlist),
+        blocklist: Array.from(listSets.blocklist),
+        fuzzylist: Array.from(listSets.fuzzylist),
+        version: listState.version,
+        name: PhishingController_1.phishingListKeyNameMap[listKey],
+        tolerance: listState.tolerance,
+        lastUpdated: latestDiffTimestamp,
+    };
+};
+exports.applyDiffs = applyDiffs;
+/**
+ * Validates the configuration object for the phishing detector.
+ *
+ * @param config - the configuration object to validate.
+ * @throws an error if the configuration is invalid.
+ */
+function validateConfig(config) {
+    if (config === null || typeof config !== 'object') {
+        throw new Error('Invalid config');
+    }
+    if ('tolerance' in config && !('fuzzylist' in config)) {
+        throw new Error('Fuzzylist tolerance provided without fuzzylist');
+    }
+    if ('name' in config &&
+        (typeof config.name !== 'string' || config.name === '')) {
+        throw new Error("Invalid config parameter: 'name'");
+    }
+    if ('version' in config &&
+        (!['number', 'string'].includes(typeof config.version) ||
+            config.version === '')) {
+        throw new Error("Invalid config parameter: 'version'");
+    }
+}
+exports.validateConfig = validateConfig;
+/**
+ * Converts a domain string to a list of domain parts.
+ *
+ * @param domain - the domain string to convert.
+ * @returns the list of domain parts.
+ */
+const domainToParts = (domain) => {
+    try {
+        return domain.split('.').reverse();
+    }
+    catch (e) {
+        throw new Error(JSON.stringify(domain));
+    }
+};
+exports.domainToParts = domainToParts;
+/**
+ * Converts a list of domain strings to a list of domain parts.
+ *
+ * @param list - the list of domain strings to convert.
+ * @returns the list of domain parts.
+ */
+const processDomainList = (list) => {
+    return list.map(exports.domainToParts);
+};
+exports.processDomainList = processDomainList;
+/**
+ * Gets the default phishing detector configuration.
+ *
+ * @param override - the optional override for the configuration.
+ * @param override.allowlist - the optional allowlist to override.
+ * @param override.blocklist - the optional blocklist to override.
+ * @param override.c2DomainBlocklist - the optional c2DomainBlocklist to override.
+ * @param override.fuzzylist - the optional fuzzylist to override.
+ * @param override.tolerance - the optional tolerance to override.
+ * @returns the default phishing detector configuration.
+ */
+const getDefaultPhishingDetectorConfig = ({ allowlist = [], blocklist = [], fuzzylist = [], tolerance = DEFAULT_TOLERANCE, }) => ({
+    allowlist: (0, exports.processDomainList)(allowlist),
+    blocklist: (0, exports.processDomainList)(blocklist),
+    fuzzylist: (0, exports.processDomainList)(fuzzylist),
+    tolerance,
+});
+exports.getDefaultPhishingDetectorConfig = getDefaultPhishingDetectorConfig;
+/**
+ * Processes the configurations for the phishing detector.
+ *
+ * @param configs - the configurations to process.
+ * @returns the processed configurations.
+ */
+const processConfigs = (configs = []) => {
+    return configs.map((config) => {
+        validateConfig(config);
+        return { ...config, ...(0, exports.getDefaultPhishingDetectorConfig)(config) };
+    });
+};
+exports.processConfigs = processConfigs;
+/**
+ * Converts a list of domain parts to a domain string.
+ *
+ * @param domainParts - the list of domain parts.
+ * @returns the domain string.
+ */
+const domainPartsToDomain = (domainParts) => {
+    return domainParts.slice().reverse().join('.');
+};
+exports.domainPartsToDomain = domainPartsToDomain;
+/**
+ * Converts a list of domain parts to a fuzzy form.
+ *
+ * @param domainParts - the list of domain parts.
+ * @returns the fuzzy form of the domain.
+ */
+const domainPartsToFuzzyForm = (domainParts) => {
+    return domainParts.slice(1).reverse().join('.');
+};
+exports.domainPartsToFuzzyForm = domainPartsToFuzzyForm;
+/**
+ * Matches the target parts, ignoring extra subdomains on source.
+ *
+ * @param source - the source domain parts.
+ * @param list - the list of domain parts to match against.
+ * @returns the parts for the first found matching entry.
+ */
+const matchPartsAgainstList = (source, list) => {
+    return list.find((target) => {
+        // target domain has more parts than source, fail
+        if (target.length > source.length) {
+            return false;
+        }
+        // source matches target or (is deeper subdomain)
+        return target.every((part, index) => source[index] === part);
+    });
+};
+exports.matchPartsAgainstList = matchPartsAgainstList;
+/**
+ * Generate the SHA-256 hash of a hostname.
+ *
+ * @param hostname - The hostname to hash.
+ * @returns The SHA-256 hash of the hostname.
+ */
+const sha256Hash = (hostname) => {
+    const hashBuffer = (0, sha256_1.sha256)(new TextEncoder().encode(hostname.toLowerCase()));
+    return (0, utils_1.bytesToHex)(hashBuffer);
+};
+exports.sha256Hash = sha256Hash;
+/**
+ * Extracts the hostname from a URL.
+ *
+ * @param url - The URL to extract the hostname from.
+ * @returns The hostname extracted from the URL, or null if the URL is invalid.
+ */
+const getHostnameFromUrl = (url) => {
+    let hostname;
+    try {
+        hostname = new URL(url).hostname;
+    }
+    catch (error) {
+        return null;
+    }
+    return hostname;
+};
+exports.getHostnameFromUrl = getHostnameFromUrl;
+//# sourceMappingURL=utils.cjs.map

package/dist/utils.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.cjs","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;AAAA,+CAAiD;AACjD,yDAAsD;AAGtD,iEAAwE;AAMxE,MAAM,iBAAiB,GAAG,CAAC,CAAC;AAE5B;;;;GAIG;AACI,MAAM,YAAY,GAAG,GAAW,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;AAA3D,QAAA,YAAY,gBAA+C;AAExE;;;;;GAKG;AACH,SAAgB,oBAAoB,CAAC,aAAqB;IACxD,OAAO,IAAI,CAAC,KAAK,CAAC,aAAa,GAAG,EAAE,CAAC,GAAG,EAAE,CAAC;AAC7C,CAAC;AAFD,oDAEC;AAED;;;;;GAKG;AACH,MAAM,mBAAmB,GAAG,CAC1B,aAAgC,EAClB,EAAE;IAChB,MAAM,WAAW,GAAG,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC/C,OAAO;QACL,aAAa,CAAC,KAAK,CAAC,CAAC,EAAE,WAAW,CAAU;QAC5C,aAAa,CAAC,KAAK,CAAC,WAAW,GAAG,CAAC,CAAQ;KAC5C,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;;;;GASG;AACI,MAAM,UAAU,GAAG,CACxB,SAA4B,EAC5B,YAAqB,EACrB,OAAiB,EACjB,yBAAmC,EAAE,EACrC,2BAAqC,EAAE,EACpB,EAAE;IACrB,qEAAqE;IACrE,oFAAoF;IACpF,MAAM,YAAY,GAAG,YAAY,CAAC,MAAM,CACtC,CAAC,EAAE,SAAS,EAAE,UAAU,EAAE,EAAE,EAAE,CAC5B,SAAS,GAAG,SAAS,CAAC,WAAW;QACjC,mBAAmB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK,OAAO,CACjD,CAAC;IAEF,sEAAsE;IACtE,6EAA6E;IAC7E,yDAAyD;IACzD,oEAAoE;IACpE,IAAI,mBAAmB,GAAG,SAAS,CAAC,WAAW,CAAC;IAEhD,MAAM,QAAQ,GAAG;QACf,SAAS,EAAE,IAAI,GAAG,CAAC,SAAS,CAAC,SAAS,CAAC;QACvC,SAAS,EAAE,IAAI,GAAG,CAAC,SAAS,CAAC,SAAS,CAAC;QACvC,SAAS,EAAE,IAAI,GAAG,CAAC,SAAS,CAAC,SAAS,CAAC;QACvC,iBAAiB,EAAE,IAAI,GAAG,CAAC,SAAS,CAAC,iBAAiB,CAAC;KACxD,CAAC;IACF,KAAK,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,EAAE,SAAS,EAAE,IAAI,YAAY,EAAE;QACpE,MAAM,cAAc,GAAG,mBAAmB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1D,IAAI,SAAS,GAAG,mBAAmB,EAAE;YACnC,mBAAmB,GAAG,SAAS,CAAC;SACjC;QACD,IAAI,SAAS,EAAE;YACb,QAAQ,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;SACtC;aAAM;YACL,QAAQ,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;SACnC;KACF;IAED,IAAI,OAAO,KAAK,6BAAQ,CAAC,uBAAuB,EAAE;QAChD,KAAK,MAAM,IAAI,IAAI,sBAAsB,EAAE;YACzC,QAAQ,CAAC,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;SACtC;QACD,KAAK,MAAM,IAAI,IAAI,wBAAwB,EAAE;YAC3C,QAAQ,CAAC,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;SACzC;KACF;IAED,OAAO;QACL,iBAAiB,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC;QACzD,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;QACzC,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;QACzC,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;QACzC,OAAO,EAAE,SAAS,CAAC,OAAO;QAC1B,IAAI,EAAE,2CAAsB,CAAC,OAAO,CAAC;QACrC,SAAS,EAAE,SAAS,CAAC,SAAS;QAC9B,WAAW,EAAE,mBAAmB;KACjC,CAAC;AACJ,CAAC,CAAC;AA1DW,QAAA,UAAU,cA0DrB;AAEF;;;;;GAKG;AACH,SAAgB,cAAc,CAC5B,MAAe;IAEf,IAAI,MAAM,KAAK,IAAI,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;QACjD,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;KACnC;IAED,IAAI,WAAW,IAAI,MAAM,IAAI,CAAC,CAAC,WAAW,IAAI,MAAM,CAAC,EAAE;QACrD,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;KACnE;IAED,IACE,MAAM,IAAI,MAAM;QAChB,CAAC,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ,IAAI,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC,EACvD;QACA,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;KACrD;IAED,IACE,SAAS,IAAI,MAAM;QACnB,CAAC,CAAC,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,OAAO,MAAM,CAAC,OAAO,CAAC;YACpD,MAAM,CAAC,OAAO,KAAK,EAAE,CAAC,EACxB;QACA,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;KACxD;AACH,CAAC;AAzBD,wCAyBC;AAED;;;;;GAKG;AACI,MAAM,aAAa,GAAG,CAAC,MAAc,EAAE,EAAE;IAC9C,IAAI;QACF,OAAO,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,CAAC;KACpC;IAAC,OAAO,CAAC,EAAE;QACV,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;KACzC;AACH,CAAC,CAAC;AANW,QAAA,aAAa,iBAMxB;AAEF;;;;;GAKG;AACI,MAAM,iBAAiB,GAAG,CAAC,IAAc,EAAE,EAAE;IAClD,OAAO,IAAI,CAAC,GAAG,CAAC,qBAAa,CAAC,CAAC;AACjC,CAAC,CAAC;AAFW,QAAA,iBAAiB,qBAE5B;AAEF;;;;;;;;;;GAUG;AACI,MAAM,gCAAgC,GAAG,CAAC,EAC/C,SAAS,GAAG,EAAE,EACd,SAAS,GAAG,EAAE,EACd,SAAS,GAAG,EAAE,EACd,SAAS,GAAG,iBAAiB,GAO9B,EAAiC,EAAE,CAAC,CAAC;IACpC,SAAS,EAAE,IAAA,yBAAiB,EAAC,SAAS,CAAC;IACvC,SAAS,EAAE,IAAA,yBAAiB,EAAC,SAAS,CAAC;IACvC,SAAS,EAAE,IAAA,yBAAiB,EAAC,SAAS,CAAC;IACvC,SAAS;CACV,CAAC,CAAC;AAhBU,QAAA,gCAAgC,oCAgB1C;AAEH;;;;;GAKG;AACI,MAAM,cAAc,GAAG,CAAC,UAAkC,EAAE,EAAE,EAAE;IACrE,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,MAA4B,EAAE,EAAE;QAClD,cAAc,CAAC,MAAM,CAAC,CAAC;QACvB,OAAO,EAAE,GAAG,MAAM,EAAE,GAAG,IAAA,wCAAgC,EAAC,MAAM,CAAC,EAAE,CAAC;IACpE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AALW,QAAA,cAAc,kBAKzB;AAEF;;;;;GAKG;AACI,MAAM,mBAAmB,GAAG,CAAC,WAAqB,EAAE,EAAE;IAC3D,OAAO,WAAW,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACjD,CAAC,CAAC;AAFW,QAAA,mBAAmB,uBAE9B;AAEF;;;;;GAKG;AACI,MAAM,sBAAsB,GAAG,CAAC,WAAqB,EAAE,EAAE;IAC9D,OAAO,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAClD,CAAC,CAAC;AAFW,QAAA,sBAAsB,0BAEjC;AAEF;;;;;;GAMG;AACI,MAAM,qBAAqB,GAAG,CAAC,MAAgB,EAAE,IAAgB,EAAE,EAAE;IAC1E,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;QAC1B,iDAAiD;QACjD,IAAI,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE;YACjC,OAAO,KAAK,CAAC;SACd;QACD,iDAAiD;QACjD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AATW,QAAA,qBAAqB,yBAShC;AAEF;;;;;GAKG;AACI,MAAM,UAAU,GAAG,CAAC,QAAgB,EAAU,EAAE;IACrD,MAAM,UAAU,GAAG,IAAA,eAAM,EAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;IAC5E,OAAO,IAAA,kBAAU,EAAC,UAAU,CAAC,CAAC;AAChC,CAAC,CAAC;AAHW,QAAA,UAAU,cAGrB;AAEF;;;;;GAKG;AACI,MAAM,kBAAkB,GAAG,CAAC,GAAW,EAAiB,EAAE;IAC/D,IAAI,QAAQ,CAAC;IACb,IAAI;QACF,QAAQ,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC;KAClC;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,IAAI,CAAC;KACb;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AARW,QAAA,kBAAkB,sBAQ7B","sourcesContent":["import { bytesToHex } from '@noble/hashes/utils';\nimport { sha256 } from 'ethereum-cryptography/sha256';\n\nimport type { Hotlist, PhishingListState } from './PhishingController';\nimport { ListKeys, phishingListKeyNameMap } from './PhishingController';\nimport type {\n  PhishingDetectorList,\n  PhishingDetectorConfiguration,\n} from './PhishingDetector';\n\nconst DEFAULT_TOLERANCE = 3;\n\n/**\n * Fetches current epoch time in seconds.\n *\n * @returns the Date.now() time in seconds instead of miliseconds. backend files rely on timestamps in seconds since epoch.\n */\nexport const fetchTimeNow = (): number => Math.round(Date.now() / 1000);\n\n/**\n * Rounds a Unix timestamp down to the nearest minute.\n *\n * @param unixTimestamp - The Unix timestamp to be rounded.\n * @returns The rounded Unix timestamp.\n */\nexport function roundToNearestMinute(unixTimestamp: number): number {\n  return Math.floor(unixTimestamp / 60) * 60;\n}\n\n/**\n * Split a string into two pieces, using the first period as the delimiter.\n *\n * @param stringToSplit - The string to split.\n * @returns An array of length two containing the beginning and end of the string.\n */\nconst splitStringByPeriod = <Start extends string, End extends string>(\n  stringToSplit: `${Start}.${End}`,\n): [Start, End] => {\n  const periodIndex = stringToSplit.indexOf('.');\n  return [\n    stringToSplit.slice(0, periodIndex) as Start,\n    stringToSplit.slice(periodIndex + 1) as End,\n  ];\n};\n\n/**\n * Determines which diffs are applicable to the listState, then applies those diffs.\n *\n * @param listState - the stalelist or the existing liststate that diffs will be applied to.\n * @param hotlistDiffs - the diffs to apply to the listState if valid.\n * @param listKey - the key associated with the input/output phishing list state.\n * @param recentlyAddedC2Domains - list of hashed C2 domains to add to the local c2 domain blocklist\n * @param recentlyRemovedC2Domains - list of hashed C2 domains to remove from the local c2 domain blocklist\n * @returns the new list state\n */\nexport const applyDiffs = (\n  listState: PhishingListState,\n  hotlistDiffs: Hotlist,\n  listKey: ListKeys,\n  recentlyAddedC2Domains: string[] = [],\n  recentlyRemovedC2Domains: string[] = [],\n): PhishingListState => {\n  // filter to remove diffs that were added before the lastUpdate time.\n  // filter to remove diffs that aren't applicable to the specified list (by listKey).\n  const diffsToApply = hotlistDiffs.filter(\n    ({ timestamp, targetList }) =>\n      timestamp > listState.lastUpdated &&\n      splitStringByPeriod(targetList)[0] === listKey,\n  );\n\n  // the reason behind using latestDiffTimestamp as the lastUpdated time\n  // is so that we can benefit server-side from memoization due to end client's\n  // `GET /v1/diffSince/:timestamp` requests lining up with\n  // our periodic updates (which create diffs at specific timestamps).\n  let latestDiffTimestamp = listState.lastUpdated;\n\n  const listSets = {\n    allowlist: new Set(listState.allowlist),\n    blocklist: new Set(listState.blocklist),\n    fuzzylist: new Set(listState.fuzzylist),\n    c2DomainBlocklist: new Set(listState.c2DomainBlocklist),\n  };\n  for (const { isRemoval, targetList, url, timestamp } of diffsToApply) {\n    const targetListType = splitStringByPeriod(targetList)[1];\n    if (timestamp > latestDiffTimestamp) {\n      latestDiffTimestamp = timestamp;\n    }\n    if (isRemoval) {\n      listSets[targetListType].delete(url);\n    } else {\n      listSets[targetListType].add(url);\n    }\n  }\n\n  if (listKey === ListKeys.EthPhishingDetectConfig) {\n    for (const hash of recentlyAddedC2Domains) {\n      listSets.c2DomainBlocklist.add(hash);\n    }\n    for (const hash of recentlyRemovedC2Domains) {\n      listSets.c2DomainBlocklist.delete(hash);\n    }\n  }\n\n  return {\n    c2DomainBlocklist: Array.from(listSets.c2DomainBlocklist),\n    allowlist: Array.from(listSets.allowlist),\n    blocklist: Array.from(listSets.blocklist),\n    fuzzylist: Array.from(listSets.fuzzylist),\n    version: listState.version,\n    name: phishingListKeyNameMap[listKey],\n    tolerance: listState.tolerance,\n    lastUpdated: latestDiffTimestamp,\n  };\n};\n\n/**\n * Validates the configuration object for the phishing detector.\n *\n * @param config - the configuration object to validate.\n * @throws an error if the configuration is invalid.\n */\nexport function validateConfig(\n  config: unknown,\n): asserts config is PhishingListState {\n  if (config === null || typeof config !== 'object') {\n    throw new Error('Invalid config');\n  }\n\n  if ('tolerance' in config && !('fuzzylist' in config)) {\n    throw new Error('Fuzzylist tolerance provided without fuzzylist');\n  }\n\n  if (\n    'name' in config &&\n    (typeof config.name !== 'string' || config.name === '')\n  ) {\n    throw new Error(\"Invalid config parameter: 'name'\");\n  }\n\n  if (\n    'version' in config &&\n    (!['number', 'string'].includes(typeof config.version) ||\n      config.version === '')\n  ) {\n    throw new Error(\"Invalid config parameter: 'version'\");\n  }\n}\n\n/**\n * Converts a domain string to a list of domain parts.\n *\n * @param domain - the domain string to convert.\n * @returns the list of domain parts.\n */\nexport const domainToParts = (domain: string) => {\n  try {\n    return domain.split('.').reverse();\n  } catch (e) {\n    throw new Error(JSON.stringify(domain));\n  }\n};\n\n/**\n * Converts a list of domain strings to a list of domain parts.\n *\n * @param list - the list of domain strings to convert.\n * @returns the list of domain parts.\n */\nexport const processDomainList = (list: string[]) => {\n  return list.map(domainToParts);\n};\n\n/**\n * Gets the default phishing detector configuration.\n *\n * @param override - the optional override for the configuration.\n * @param override.allowlist - the optional allowlist to override.\n * @param override.blocklist - the optional blocklist to override.\n * @param override.c2DomainBlocklist - the optional c2DomainBlocklist to override.\n * @param override.fuzzylist - the optional fuzzylist to override.\n * @param override.tolerance - the optional tolerance to override.\n * @returns the default phishing detector configuration.\n */\nexport const getDefaultPhishingDetectorConfig = ({\n  allowlist = [],\n  blocklist = [],\n  fuzzylist = [],\n  tolerance = DEFAULT_TOLERANCE,\n}: {\n  allowlist?: string[];\n  blocklist?: string[];\n  c2DomainBlocklist?: string[];\n  fuzzylist?: string[];\n  tolerance?: number;\n}): PhishingDetectorConfiguration => ({\n  allowlist: processDomainList(allowlist),\n  blocklist: processDomainList(blocklist),\n  fuzzylist: processDomainList(fuzzylist),\n  tolerance,\n});\n\n/**\n * Processes the configurations for the phishing detector.\n *\n * @param configs - the configurations to process.\n * @returns the processed configurations.\n */\nexport const processConfigs = (configs: PhishingDetectorList[] = []) => {\n  return configs.map((config: PhishingDetectorList) => {\n    validateConfig(config);\n    return { ...config, ...getDefaultPhishingDetectorConfig(config) };\n  });\n};\n\n/**\n * Converts a list of domain parts to a domain string.\n *\n * @param domainParts - the list of domain parts.\n * @returns the domain string.\n */\nexport const domainPartsToDomain = (domainParts: string[]) => {\n  return domainParts.slice().reverse().join('.');\n};\n\n/**\n * Converts a list of domain parts to a fuzzy form.\n *\n * @param domainParts - the list of domain parts.\n * @returns the fuzzy form of the domain.\n */\nexport const domainPartsToFuzzyForm = (domainParts: string[]) => {\n  return domainParts.slice(1).reverse().join('.');\n};\n\n/**\n * Matches the target parts, ignoring extra subdomains on source.\n *\n * @param source - the source domain parts.\n * @param list - the list of domain parts to match against.\n * @returns the parts for the first found matching entry.\n */\nexport const matchPartsAgainstList = (source: string[], list: string[][]) => {\n  return list.find((target) => {\n    // target domain has more parts than source, fail\n    if (target.length > source.length) {\n      return false;\n    }\n    // source matches target or (is deeper subdomain)\n    return target.every((part, index) => source[index] === part);\n  });\n};\n\n/**\n * Generate the SHA-256 hash of a hostname.\n *\n * @param hostname - The hostname to hash.\n * @returns The SHA-256 hash of the hostname.\n */\nexport const sha256Hash = (hostname: string): string => {\n  const hashBuffer = sha256(new TextEncoder().encode(hostname.toLowerCase()));\n  return bytesToHex(hashBuffer);\n};\n\n/**\n * Extracts the hostname from a URL.\n *\n * @param url - The URL to extract the hostname from.\n * @returns The hostname extracted from the URL, or null if the URL is invalid.\n */\nexport const getHostnameFromUrl = (url: string): string | null => {\n  let hostname;\n  try {\n    hostname = new URL(url).hostname;\n  } catch (error) {\n    return null;\n  }\n  return hostname;\n};\n"]}

package/dist/{types/utils.d.ts → utils.d.cts}

@@ -1,6 +1,6 @@
-import type { Hotlist, PhishingListState } from './PhishingController';
-import { ListKeys } from './PhishingController';
-import type { PhishingDetectorList, PhishingDetectorConfiguration } from './PhishingDetector';
+import type { Hotlist, PhishingListState } from "./PhishingController.cjs";
+import { ListKeys } from "./PhishingController.cjs";
+import type { PhishingDetectorList, PhishingDetectorConfiguration } from "./PhishingDetector.cjs";
 /**
  * Fetches current epoch time in seconds.
  *
@@ -116,4 +116,4 @@ export declare const sha256Hash: (hostname: string) => string;
  * @returns The hostname extracted from the URL, or null if the URL is invalid.
  */
 export declare const getHostnameFromUrl: (url: string) => string | null;
-//# sourceMappingURL=utils.d.ts.map
+//# sourceMappingURL=utils.d.cts.map

package/dist/utils.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.cts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,OAAO,EAAE,iBAAiB,EAAE,iCAA6B;AACvE,OAAO,EAAE,QAAQ,EAA0B,iCAA6B;AACxE,OAAO,KAAK,EACV,oBAAoB,EACpB,6BAA6B,EAC9B,+BAA2B;AAI5B;;;;GAIG;AACH,eAAO,MAAM,YAAY,QAAO,MAAuC,CAAC;AAExE;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM,CAElE;AAkBD;;;;;;;;;GASG;AACH,eAAO,MAAM,UAAU,cACV,iBAAiB,kCAEnB,QAAQ,2BACO,MAAM,EAAE,6BACN,MAAM,EAAE,KACjC,iBAoDF,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,cAAc,CAC5B,MAAM,EAAE,OAAO,GACd,OAAO,CAAC,MAAM,IAAI,iBAAiB,CAuBrC;AAED;;;;;GAKG;AACH,eAAO,MAAM,aAAa,WAAY,MAAM,aAM3C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,SAAU,MAAM,EAAE,eAE/C,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,gCAAgC;;;;;;MAWzC,6BAKF,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,cAAc,aAAa,oBAAoB,EAAE;;;;;;;;;GAK7D,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,gBAAiB,MAAM,EAAE,WAExD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,gBAAiB,MAAM,EAAE,WAE3D,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB,WAAY,MAAM,EAAE,QAAQ,MAAM,EAAE,EAAE,yBASvE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,UAAU,aAAc,MAAM,KAAG,MAG7C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,QAAS,MAAM,KAAG,MAAM,GAAG,IAQzD,CAAC"}