@metamask-previews/network-connection-banner-controller 0.1.0-preview-7507a11

package/dist/url-utils.d.mts

@@ -0,0 +1,24 @@
+/**
+ * Check if a hostname is localhost or an IP address (v4 or v6). Public RPC
+ * providers use domain names, not raw IP addresses, so a `true` result means
+ * the host should not be reduced to an eTLD+1.
+ *
+ * @param hostname - The hostname to check.
+ * @returns True if the hostname is localhost or an IP address.
+ */
+export declare function isLocalhostOrIPAddress(hostname: string): boolean;
+/**
+ * Registrable domain (eTLD+1) for a URL, computed via the Public Suffix List
+ * so multi-part suffixes like ".co.uk" resolve correctly. Used to group RPC
+ * endpoints by provider so a single provider's wide outage (e.g. *.infura.io)
+ * is treated as one failure rather than many.
+ *
+ * Localhost, IP literals, and single-label hosts are returned verbatim rather
+ * than reduced to a domain (psl returns null or garbage for those, and callers
+ * grouping by domain still need to distinguish them).
+ *
+ * @param urlString - The URL to extract a domain from.
+ * @returns The domain, or null if the URL is invalid.
+ */
+export declare function getDomain(urlString: string): string | null;
+//# sourceMappingURL=url-utils.d.mts.map

package/dist/url-utils.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"url-utils.d.mts","sourceRoot":"","sources":["../src/url-utils.ts"],"names":[],"mappings":"AAGA;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAWhE;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAe1D"}

package/dist/url-utils.mjs

@@ -0,0 +1,54 @@
+function $importDefault(module) {
+    if (module?.__esModule) {
+        return module.default;
+    }
+    return module;
+}
+import $ipRegex from "ip-regex/index.js";
+const ipRegex = $importDefault($ipRegex);
+import { get as pslGet } from "psl";
+/**
+ * Check if a hostname is localhost or an IP address (v4 or v6). Public RPC
+ * providers use domain names, not raw IP addresses, so a `true` result means
+ * the host should not be reduced to an eTLD+1.
+ *
+ * @param hostname - The hostname to check.
+ * @returns True if the hostname is localhost or an IP address.
+ */
+export function isLocalhostOrIPAddress(hostname) {
+    const lowerHostname = hostname.toLowerCase();
+    if (lowerHostname === 'localhost') {
+        return true;
+    }
+    // Remove brackets from IPv6 addresses for testing (e.g., [::1] -> ::1)
+    const hostnameWithoutBrackets = lowerHostname.replace(/^\[|\]$/gu, '');
+    return ipRegex({ exact: true }).test(hostnameWithoutBrackets);
+}
+/**
+ * Registrable domain (eTLD+1) for a URL, computed via the Public Suffix List
+ * so multi-part suffixes like ".co.uk" resolve correctly. Used to group RPC
+ * endpoints by provider so a single provider's wide outage (e.g. *.infura.io)
+ * is treated as one failure rather than many.
+ *
+ * Localhost, IP literals, and single-label hosts are returned verbatim rather
+ * than reduced to a domain (psl returns null or garbage for those, and callers
+ * grouping by domain still need to distinguish them).
+ *
+ * @param urlString - The URL to extract a domain from.
+ * @returns The domain, or null if the URL is invalid.
+ */
+export function getDomain(urlString) {
+    let url;
+    try {
+        url = new URL(urlString);
+    }
+    catch {
+        return null;
+    }
+    const { hostname } = url;
+    if (!hostname.includes('.') || isLocalhostOrIPAddress(hostname)) {
+        return hostname;
+    }
+    return pslGet(hostname) ?? hostname;
+}
+//# sourceMappingURL=url-utils.mjs.map

package/dist/url-utils.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"url-utils.mjs","sourceRoot":"","sources":["../src/url-utils.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,QAAO,0BAAiB;;AAC/B,OAAO,EAAE,GAAG,IAAI,MAAM,EAAE,YAAY;AAEpC;;;;;;;GAOG;AACH,MAAM,UAAU,sBAAsB,CAAC,QAAgB;IACrD,MAAM,aAAa,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC;IAE7C,IAAI,aAAa,KAAK,WAAW,EAAE,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,uEAAuE;IACvE,MAAM,uBAAuB,GAAG,aAAa,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;IAEvE,OAAO,OAAO,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;AAChE,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,SAAS,CAAC,SAAiB;IACzC,IAAI,GAAQ,CAAC;IACb,IAAI,CAAC;QACH,GAAG,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC;IAC3B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,EAAE,QAAQ,EAAE,GAAG,GAAG,CAAC;IAEzB,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,sBAAsB,CAAC,QAAQ,CAAC,EAAE,CAAC;QAChE,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,MAAM,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC;AACtC,CAAC","sourcesContent":["import ipRegex from 'ip-regex';\nimport { get as pslGet } from 'psl';\n\n/**\n * Check if a hostname is localhost or an IP address (v4 or v6). Public RPC\n * providers use domain names, not raw IP addresses, so a `true` result means\n * the host should not be reduced to an eTLD+1.\n *\n * @param hostname - The hostname to check.\n * @returns True if the hostname is localhost or an IP address.\n */\nexport function isLocalhostOrIPAddress(hostname: string): boolean {\n  const lowerHostname = hostname.toLowerCase();\n\n  if (lowerHostname === 'localhost') {\n    return true;\n  }\n\n  // Remove brackets from IPv6 addresses for testing (e.g., [::1] -> ::1)\n  const hostnameWithoutBrackets = lowerHostname.replace(/^\\[|\\]$/gu, '');\n\n  return ipRegex({ exact: true }).test(hostnameWithoutBrackets);\n}\n\n/**\n * Registrable domain (eTLD+1) for a URL, computed via the Public Suffix List\n * so multi-part suffixes like \".co.uk\" resolve correctly. Used to group RPC\n * endpoints by provider so a single provider's wide outage (e.g. *.infura.io)\n * is treated as one failure rather than many.\n *\n * Localhost, IP literals, and single-label hosts are returned verbatim rather\n * than reduced to a domain (psl returns null or garbage for those, and callers\n * grouping by domain still need to distinguish them).\n *\n * @param urlString - The URL to extract a domain from.\n * @returns The domain, or null if the URL is invalid.\n */\nexport function getDomain(urlString: string): string | null {\n  let url: URL;\n  try {\n    url = new URL(urlString);\n  } catch {\n    return null;\n  }\n\n  const { hostname } = url;\n\n  if (!hostname.includes('.') || isLocalhostOrIPAddress(hostname)) {\n    return hostname;\n  }\n\n  return pslGet(hostname) ?? hostname;\n}\n"]}

package/package.json

@@ -0,0 +1,80 @@
+{
+  "name": "@metamask-previews/network-connection-banner-controller",
+  "version": "0.1.0-preview-7507a11",
+  "description": "Decides when and how to surface the network connection banner based on RPC endpoint health",
+  "keywords": [
+    "Ethereum",
+    "MetaMask"
+  ],
+  "homepage": "https://github.com/MetaMask/core/tree/main/packages/network-connection-banner-controller#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/core/issues"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/core.git"
+  },
+  "files": [
+    "dist/"
+  ],
+  "sideEffects": false,
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.cts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "ts-bridge --project tsconfig.build.json --verbose --clean --no-references",
+    "build:all": "ts-bridge --project tsconfig.build.json --verbose --clean",
+    "build:docs": "typedoc",
+    "changelog:update": "../../scripts/update-changelog.sh @metamask/network-connection-banner-controller",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/network-connection-banner-controller",
+    "messenger-action-types:check": "tsx ../../packages/messenger-cli/src/cli.ts --formatter oxfmt --check",
+    "messenger-action-types:generate": "tsx ../../packages/messenger-cli/src/cli.ts --formatter oxfmt --generate",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter",
+    "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache",
+    "test:verbose": "NODE_OPTIONS=--experimental-vm-modules jest --verbose",
+    "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
+  },
+  "dependencies": {
+    "@metamask/base-controller": "^9.1.0",
+    "@metamask/connectivity-controller": "^0.2.0",
+    "@metamask/messenger": "^1.2.0",
+    "@metamask/network-controller": "^32.0.0",
+    "@metamask/network-enablement-controller": "^5.3.0",
+    "@metamask/utils": "^11.9.0",
+    "ip-regex": "^4.3.0",
+    "psl": "^1.15.0"
+  },
+  "devDependencies": {
+    "@metamask/auto-changelog": "^6.1.0",
+    "@ts-bridge/cli": "^0.6.4",
+    "@types/jest": "^29.5.14",
+    "deepmerge": "^4.2.2",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.2.5",
+    "tsx": "^4.20.5",
+    "typedoc": "^0.25.13",
+    "typedoc-plugin-missing-exports": "^2.0.0",
+    "typescript": "~5.3.3"
+  },
+  "engines": {
+    "node": "^18.18 || >=20"
+  }
+}