parse-domain 4.1.0 → 7.0.0

package/README.md

@@ -15,7 +15,7 @@ Since domain name registrars organize their namespaces in different ways, it's n
 import { parseDomain, ParseResultType } from "parse-domain";
 
 const parseResult = parseDomain(
-  // This should be a string with basic latin characters only.
+  // This should be a string with basic latin letters only.
   // More information below.
   "www.some.example.co.uk"
 );
@@ -32,9 +32,9 @@ if (parseResult.type === ParseResultType.Listed) {
 }
 ```
 
-This package has been designed for modern Node and browser environments, supporting both CommonJS and ECMAScript modules. It assumes an ES2015 environment with [`Symbol()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol) and [`URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL) globally available. You need to transpile it down to ES5 (e.g. by using [Babel](https://babeljs.io/)) if you need to support older environments.
+This package has been designed for modern Node and browser environments with ECMAScript modules support. It assumes an ES2015 environment with [`Symbol()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol), [`URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL) and [`TextDecoder()`](https://developer.mozilla.org/en-US/docs/Web/API/TextEncoder) globally available. You need to transpile it down to ES5 (e.g. by using [Babel](https://babeljs.io/)) if you need to support older environments.
 
-The list of top-level domains is stored in a [trie](https://en.wikipedia.org/wiki/Trie) data structure and serialization format to ensure the fastest lookup and the smallest possible library size. The library is side-effect free (this is important for proper [tree-shaking](https://webpack.js.org/guides/tree-shaking/)).
+The list of top-level domains is stored in a [trie](https://en.wikipedia.org/wiki/Trie) data structure and serialization format to ensure the fastest lookup and the smallest possible library size.
 
 <br />
 
@@ -96,7 +96,7 @@ When parsing a hostname there are 5 possible results:
 
 ### 👉 Invalid domains
 
-The given input is first validated against [RFC 1034](https://tools.ietf.org/html/rfc1034). If the validation fails, `parseResult.type` will be `ParseResultType.Invalid`:
+The given input is first validated against [RFC 3696](https://datatracker.ietf.org/doc/html/rfc3696#section-2) (the domain labels are limited to basic latin letters, numbers and hyphens). If the validation fails, `parseResult.type` will be `ParseResultType.Invalid`:
 
 ```javascript
 import { parseDomain, ParseResultType } from "parse-domain";
@@ -108,6 +108,20 @@ console.log(parseResult.type === ParseResultType.Invalid); // true
 
 Check out the [API](#api-ts-ValidationError) if you need more information about the validation error.
 
+If you don't want the characters to be validated (e.g. because you need to allow underscores in hostnames), there's also a more relaxed validation mode (according to [RFC 2181](https://www.rfc-editor.org/rfc/rfc2181#section-11)).
+
+```javascript
+import { parseDomain, ParseResultType, Validation } from "parse-domain";
+
+const parseResult = parseDomain("_jabber._tcp.gmail.com", {
+  validation: Validation.Lax,
+});
+
+console.log(parseResult.type === ParseResultType.Listed); // true
+```
+
+See also [#134](https://github.com/peerigon/parse-domain/issues/134) for the discussion.
+
 ### 👉 IP addresses
 
 If the given input is an IP address, `parseResult.type` will be `ParseResultType.Ip`:
@@ -273,10 +287,10 @@ console.log(topLevelDomains); // []
 🧬 = TypeScript export
 
 <h3 id="api-js-parseDomain">
-🧩 <code>export parseDomain(hostname: string | typeof <a href="#api-js-NO_HOSTNAME">NO_HOSTNAME</a>): <a href="#api-ts-ParseResult">ParseResult</a></code>
+🧩 <code>export parseDomain(hostname: string | typeof <a href="#api-js-NO_HOSTNAME">NO_HOSTNAME</a>, options?: <a href="#api-ts-ParseDomainOptions">ParseDomainOptions</a>): <a href="#api-ts-ParseResult">ParseResult</a></code>
 </h3>
 
-Takes a hostname (e.g. `"www.example.com"`) and returns a [`ParseResult`](#api-ts-ParseResult). The hostname must only contain basic latin characters, digits, hyphens and dots. International hostnames must be puny-encoded. Does not throw an error, even with invalid input.
+Takes a hostname (e.g. `"www.example.com"`) and returns a [`ParseResult`](#api-ts-ParseResult). The hostname must only contain basic latin letters, digits, hyphens and dots. International hostnames must be puny-encoded. Does not throw an error, even with invalid input.
 
 ```javascript
 import { parseDomain } from "parse-domain";
@@ -284,6 +298,16 @@ import { parseDomain } from "parse-domain";
 const parseResult = parseDomain("www.example.com");
 ```
 
+Use `Validation.Lax` if you want to allow all characters:
+
+```javascript
+import { parseDomain, Validation } from "parse-domain";
+
+const parseResult = parseDomain("_jabber._tcp.gmail.com", {
+  validation: Validation.Lax,
+});
+```
+
 <h3 id="api-js-fromUrl">
 🧩 <code>export fromUrl(input: string): string | typeof <a href="#api-js-NO_HOSTNAME">NO_HOSTNAME</a></code>
 </h3>
@@ -296,6 +320,54 @@ Takes a URL-like string and tries to extract the hostname. Requires the global [
 
 `NO_HOSTNAME` is a symbol that is returned by [`fromUrl`](#api-js-fromUrl) when it was not able to extract a hostname from the given string. When passed to [`parseDomain`](#api-js-parseDomain), it will always yield a [`ParseResultInvalid`](#api-ts-ParseResultInvalid).
 
+<h3 id="api-ts-ParseDomainOptions">
+🧬 <code>export type ParseDomainOptions</code>
+</h3>
+
+```ts
+export type ParseDomainOptions = {
+  /**
+   * If no validation is specified, Validation.Strict will be used.
+   **/
+  validation?: Validation;
+};
+```
+
+<h3 id="api-js-Validation">
+🧩 <code>export Validation</code>
+</h3>
+
+An object that holds all possible [Validation](#api-ts-Validation) `validation` values:
+
+```javascript
+export const Validation = {
+  /**
+   * Allows any octets as labels
+   * but still restricts the length of labels and the overall domain.
+   *
+   * @see https://www.rfc-editor.org/rfc/rfc2181#section-11
+   **/
+  Lax: "LAX",
+
+  /**
+   * Only allows ASCII letters, digits and hyphens (aka LDH),
+   * forbids hyphens at the beginning or end of a label
+   * and requires top-level domain names not to be all-numeric.
+   *
+   * This is the default if no validation is configured.
+   *
+   * @see https://datatracker.ietf.org/doc/html/rfc3696#section-2
+   */
+  Strict: "STRICT",
+};
+```
+
+<h3 id="api-ts-Validation">
+🧬 <code>export Validation</code>
+</h3>
+
+This type represents all possible `validation` values.
+
 <h3 id="api-ts-ParseResult">
 🧬 <code>export ParseResult</code>
 </h3>
@@ -342,17 +414,17 @@ Describes the shape of the parse result that is returned when the given hostname
 
 ```ts
 type ParseResultInvalid = {
-	type: ParseResultType.INVALID;
-	hostname: string | typeof NO_HOSTNAME;
-	errors: Array<ValidationError>;
+  type: ParseResultType.INVALID;
+  hostname: string | typeof NO_HOSTNAME;
+  errors: Array<ValidationError>;
 };
 
 // Example
 
 {
-	type: "INVALID",
-	hostname: ".com",
-	errors: [...]
+  type: "INVALID",
+  hostname: ".com",
+  errors: [...]
 }
 ```
 
@@ -364,17 +436,17 @@ Describes the shape of a validation error as returned by [`parseDomain`](#api-js
 
 ```ts
 type ValidationError = {
-	type: ValidationErrorType;
-	message: string;
-	column: number;
+  type: ValidationErrorType;
+  message: string;
+  column: number;
 };
 
 // Example
 
 {
-	type: "LABEL_MIN_LENGTH",
-	message: `Label "" is too short. Label is 0 octets long but should be at least 1.`,
-	column: 1,
+  type: "LABEL_MIN_LENGTH",
+  message: `Label "" is too short. Label is 0 octets long but should be at least 1.`,
+  column: 1,
 }
 ```
 
@@ -391,6 +463,7 @@ const ValidationErrorType = {
   LabelMinLength: "LABEL_MIN_LENGTH",
   LabelMaxLength: "LABEL_MAX_LENGTH",
   LabelInvalidCharacter: "LABEL_INVALID_CHARACTER",
+  LastLabelInvalid: "LAST_LABEL_INVALID",
 };
 ```
 
@@ -408,17 +481,17 @@ This type describes the shape of the parse result that is returned when the give
 
 ```ts
 type ParseResultIp = {
-	type: ParseResultType.Ip;
-	hostname: string;
-	ipVersion: 4 | 6;
+  type: ParseResultType.Ip;
+  hostname: string;
+  ipVersion: 4 | 6;
 };
 
 // Example
 
 {
-	type: "IP",
-	hostname: "192.168.0.1",
-	ipVersion: 4
+  type: "IP",
+  hostname: "192.168.0.1",
+  ipVersion: 4
 }
 ```
 
@@ -443,17 +516,17 @@ This type describes the shape of the parse result that is returned when the give
 
 ```ts
 type ParseResultReserved = {
-	type: ParseResultType.Reserved;
-	hostname: string;
-	labels: Array<string>;
+  type: ParseResultType.Reserved;
+  hostname: string;
+  labels: Array<string>;
 };
 
 // Example
 
 {
-	type: "RESERVED",
-	hostname: "pecorino.local",
-	labels: ["pecorino", "local"]
+  type: "RESERVED",
+  hostname: "pecorino.local",
+  labels: ["pecorino", "local"]
 }
 ```
 
@@ -467,17 +540,17 @@ Describes the shape of the parse result that is returned when the given hostname
 
 ```ts
 type ParseResultNotListed = {
-	type: ParseResultType.NotListed;
-	hostname: string;
-	labels: Array<string>;
+  type: ParseResultType.NotListed;
+  hostname: string;
+  labels: Array<string>;
 };
 
 // Example
 
 {
-	type: "NOT_LISTED",
-	hostname: "this.is.not-listed",
-	labels: ["this", "is", "not-listed"]
+  type: "NOT_LISTED",
+  hostname: "this.is.not-listed",
+  labels: ["this", "is", "not-listed"]
 }
 ```
 
@@ -489,33 +562,33 @@ Describes the shape of the parse result that is returned when the given hostname
 
 ```ts
 type ParseResultListed = {
-	type: ParseResultType.Listed;
-	hostname: string;
-	labels: Array<string>;
-	subDomains: Array<string>;
-	domain: string | undefined;
-	topLevelDomains: Array<string>;
-	icann: {
-		subDomains: Array<string>;
-		domain: string | undefined;
-		topLevelDomains: Array<string>;
-	};
+  type: ParseResultType.Listed;
+  hostname: string;
+  labels: Array<string>;
+  subDomains: Array<string>;
+  domain: string | undefined;
+  topLevelDomains: Array<string>;
+  icann: {
+    subDomains: Array<string>;
+    domain: string | undefined;
+    topLevelDomains: Array<string>;
+  };
 };
 
 // Example
 
 {
-	type: "LISTED",
-	hostname: "parse-domain.github.io",
-	labels: ["parse-domain", "github", "io"]
-	subDomains: [],
-	domain: "parse-domain",
-	topLevelDomains: ["github", "io"],
-	icann: {
-		subDomains: ["parse-domain"],
-		domain: "github",
-		topLevelDomains: ["io"]
-	}
+  type: "LISTED",
+  hostname: "parse-domain.github.io",
+  labels: ["parse-domain", "github", "io"]
+  subDomains: [],
+  domain: "parse-domain",
+  topLevelDomains: ["github", "io"],
+  icann: {
+    subDomains: ["parse-domain"],
+    domain: "github",
+    topLevelDomains: ["io"]
+  }
 }
 ```
 

package/bin/update.js

@@ -1,25 +1,22 @@
 #!/usr/bin/env node
 
-"use strict";
-
-const { EOL } = require("os");
+import { EOL } from "os";
 
 (async () => {
-  process.argv.push(
-    "--",
-    "../../serialized-tries",
-    "../../../build-esm/serialized-tries"
-  );
+  process.argv.push("--", "../../serialized-tries");
+
+  const updateTries = await import("../build/scripts/update-tries.js");
 
-  await require("../build-cjs/src/scripts/update-tries.js").done;
+  await updateTries.done;
 
   process.stderr.write("Running smoke test... ");
 
-  require("../build-cjs/src/smoke-test.js").runSmokeTest();
+  const smokeTest = await import("../build/smoke-test.js");
+
+  smokeTest.runSmokeTest();
 
   process.stdout.write("ok" + EOL);
 })().catch((error) => {
   console.error(`parse-domain update failed: ${error}`);
-  // eslint-disable-next-line no-process-exit, node/no-process-exit
   process.exit(1);
 });

package/build/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,iBAAiB,GAC5B,sDAAsD,CAAC;AACzD,MAAM,CAAC,MAAM,gCAAgC,GAAG,8BAA8B,CAAC;AAC/E,MAAM,CAAC,MAAM,8BAA8B,GAAG,4BAA4B,CAAC;AAC3E,MAAM,CAAC,MAAM,kCAAkC,GAC7C,gCAAgC,CAAC;AACnC,MAAM,CAAC,MAAM,gCAAgC,GAAG,8BAA8B,CAAC;AAC/E,MAAM,CAAC,MAAM,6BAA6B,GAAG,MAAM,CAAC"}

package/{build-esm/src → build}/from-url.js

@@ -1,4 +1,5 @@
 const urlPattern = /^[a-z][*+.a-z-]+:\/\//i;
+const invalidIpv6Pattern = /^([a-z][*+.a-z-]+:\/\/)([^[].*:[^/?]*:[^/?]*)(.*)/i;
 export const NO_HOSTNAME = Symbol("NO_HOSTNAME");
 export const fromUrl = (urlLike) => {
     /* istanbul ignore next */
@@ -10,7 +11,7 @@ export const fromUrl = (urlLike) => {
         return NO_HOSTNAME;
     }
     // URLs that start with // are protocol relative
-    const url = urlLike.startsWith("//")
+    let url = urlLike.startsWith("//")
         ? `http:${urlLike}`
         : // URLs that start with / do not have a hostname section
             urlLike.startsWith("/")
@@ -18,6 +19,7 @@ export const fromUrl = (urlLike) => {
                 : urlPattern.test(urlLike)
                     ? urlLike
                     : `http://${urlLike}`;
+    url = url.replace(invalidIpv6Pattern, "$1[$2]$3");
     try {
         return new URL(url).hostname;
     }

package/build/from-url.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"from-url.js","sourceRoot":"","sources":["../src/from-url.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,GAAG,wBAAwB,CAAC;AAC5C,MAAM,kBAAkB,GAAG,oDAAoD,CAAC;AAEhF,MAAM,CAAC,MAAM,WAAW,GAAkB,MAAM,CAAC,aAAa,CAAC,CAAC;AAEhE,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,OAAe,EAAE,EAAE;IACzC,0BAA0B;IAC1B,IAAI,OAAO,GAAG,KAAK,UAAU,EAAE;QAC7B,MAAM,IAAI,KAAK,CACb,yHAAyH,CAC1H,CAAC;KACH;IAED,uCAAuC;IACvC,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;QAC/B,OAAO,WAAW,CAAC;KACpB;IAED,gDAAgD;IAChD,IAAI,GAAG,GAAG,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC;QAChC,CAAC,CAAC,QAAQ,OAAO,EAAE;QACnB,CAAC,CAAC,wDAAwD;YAC1D,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC;gBACvB,CAAC,CAAC,OAAO;gBACT,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC;oBAC1B,CAAC,CAAC,OAAO;oBACT,CAAC,CAAC,UAAU,OAAO,EAAE,CAAC;IAExB,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,kBAAkB,EAAE,UAAU,CAAC,CAAC;IAElD,IAAI;QACF,OAAO,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC;KAC9B;IAAC,WAAM;QACN,OAAO,WAAW,CAAC;KACpB;AACH,CAAC,CAAC"}

package/build/main.d.ts

@@ -0,0 +1,3 @@
+export { parseDomain, ParseResult, ParseResultType, ParseResultInvalid, ParseResultReserved, ParseResultNotListed, ParseResultListed, } from "./parse-domain.js";
+export { fromUrl, NO_HOSTNAME } from "./from-url.js";
+export { Validation, ValidationError, ValidationErrorType, } from "./sanitize.js";

package/build/main.js

@@ -0,0 +1,6 @@
+/* istanbul ignore file */
+// Jest will report function coverage errors here otherwise
+export { parseDomain, ParseResultType, } from "./parse-domain.js";
+export { fromUrl, NO_HOSTNAME } from "./from-url.js";
+export { Validation, ValidationErrorType, } from "./sanitize.js";
+//# sourceMappingURL=main.js.map

package/build/main.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.js","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AAAA,0BAA0B;AAC1B,2DAA2D;AAC3D,OAAO,EACL,WAAW,EAEX,eAAe,GAKhB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACrD,OAAO,EACL,UAAU,EAEV,mBAAmB,GACpB,MAAM,eAAe,CAAC"}

package/{build-cjs/src → build}/parse-domain.d.ts

@@ -1,5 +1,5 @@
-import { ValidationError, SanitizationResultValidIp } from "./sanitize";
-import { NO_HOSTNAME } from "./from-url";
+import { ValidationError, SanitizationResultValidIp, Validation } from "./sanitize.js";
+import { NO_HOSTNAME } from "./from-url.js";
 export declare const RESERVED_TOP_LEVEL_DOMAINS: string[];
 export declare type Label = string;
 export declare enum ParseResultType {
@@ -72,8 +72,14 @@ export declare type ParseResultListed = ParseResultCommon<ParseResultType.Listed
     icann: ParseResultListedDomains;
 };
 export declare type ParseResult = ParseResultInvalid | ParseResultIp | ParseResultReserved | ParseResultNotListed | ParseResultListed;
+export declare type ParseDomainOptions = {
+    /**
+     * If no validation is specified, Validation.Strict will be used.
+     **/
+    validation?: Validation;
+};
 /**
  * Splits the given hostname in topLevelDomains, a domain and subDomains.
  */
-export declare const parseDomain: (hostname: string | typeof NO_HOSTNAME) => ParseResult;
+export declare const parseDomain: (hostname: string | typeof NO_HOSTNAME, options?: ParseDomainOptions | undefined) => ParseResult;
 export {};

package/{build-esm/src → build}/parse-domain.js

@@ -1,7 +1,7 @@
-import { icannTrie, privateTrie } from "./serialized-tries";
-import { lookUpTldsInTrie } from "./trie/look-up";
-import { sanitize, SanitizationResultType, } from "./sanitize";
-import { parseTrie } from "./trie/parse-trie";
+import { icannTrie, privateTrie } from "./serialized-tries.js";
+import { lookUpTldsInTrie } from "./trie/look-up.js";
+import { sanitize, SanitizationResultType, } from "./sanitize.js";
+import { parseTrie } from "./trie/parse-trie.js";
 export const RESERVED_TOP_LEVEL_DOMAINS = [
     "localhost",
     "local",
@@ -49,8 +49,8 @@ let parsedPrivateTrie;
 /**
  * Splits the given hostname in topLevelDomains, a domain and subDomains.
  */
-export const parseDomain = (hostname) => {
-    const sanitizationResult = sanitize(hostname);
+export const parseDomain = (hostname, options) => {
+    const sanitizationResult = sanitize(hostname, options);
     if (sanitizationResult.type === SanitizationResultType.Error) {
         return {
             type: ParseResultType.Invalid,

package/build/parse-domain.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse-domain.js","sourceRoot":"","sources":["../src/parse-domain.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAC/D,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,EAEL,QAAQ,EACR,sBAAsB,GAGvB,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAGjD,MAAM,CAAC,MAAM,0BAA0B,GAAG;IACxC,WAAW;IACX,OAAO;IACP,SAAS;IACT,SAAS;IACT,MAAM;CACP,CAAC;AAIF,MAAM,CAAN,IAAY,eAuBX;AAvBD,WAAY,eAAe;IACzB;;OAEG;IACH,sCAAmB,CAAA;IACnB;;OAEG;IACH,4BAAS,CAAA;IACT;;;;OAIG;IACH,wCAAqB,CAAA;IACrB;;OAEG;IACH,2CAAwB,CAAA;IACxB;;OAEG;IACH,oCAAiB,CAAA;AACnB,CAAC,EAvBW,eAAe,KAAf,eAAe,QAuB1B;AAyED,MAAM,UAAU,GAAG,CACjB,KAAkB,EAClB,KAAa,EACK,EAAE;IACpB,OAAO,KAAK,IAAI,CAAC,IAAI,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACvE,CAAC,CAAC;AAEF,MAAM,sBAAsB,GAAG,CAC7B,MAAoB,EACpB,KAAa,EACa,EAAE;IAC5B,OAAO;QACL,UAAU,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;QAC/C,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,KAAK,CAAC;QACjC,eAAe,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC;KACzC,CAAC;AACJ,CAAC,CAAC;AAEF,IAAI,eAAyC,CAAC;AAC9C,IAAI,iBAA2C,CAAC;AAShD;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CACzB,QAAqC,EACrC,OAA4B,EACf,EAAE;IACf,MAAM,kBAAkB,GAAG,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAEvD,IAAI,kBAAkB,CAAC,IAAI,KAAK,sBAAsB,CAAC,KAAK,EAAE;QAC5D,OAAO;YACL,IAAI,EAAE,eAAe,CAAC,OAAO;YAC7B,QAAQ;YACR,MAAM,EAAE,kBAAkB,CAAC,MAAM;SAClC,CAAC;KACH;IAED,IAAI,kBAAkB,CAAC,IAAI,KAAK,sBAAsB,CAAC,OAAO,EAAE;QAC9D,OAAO;YACL,IAAI,EAAE,eAAe,CAAC,EAAE;YACxB,QAAQ,EAAE,kBAAkB,CAAC,EAAE;YAC/B,SAAS,EAAE,kBAAkB,CAAC,SAAS;SACxC,CAAC;KACH;IAED,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,kBAAkB,CAAC;IAE9C,IACE,QAAQ,KAAK,EAAE;QACf,0BAA0B,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,EAC9D;QACA,OAAO;YACL,IAAI,EAAE,eAAe,CAAC,QAAQ;YAC9B,QAAQ,EAAE,MAAM;YAChB,MAAM;SACP,CAAC;KACH;IAED,mCAAmC;IACnC,eAAe,GAAG,eAAe,aAAf,eAAe,cAAf,eAAe,GAAI,SAAS,CAAC,SAAS,CAAC,CAAC;IAC1D,iBAAiB,GAAG,iBAAiB,aAAjB,iBAAiB,cAAjB,iBAAiB,GAAI,SAAS,CAAC,WAAW,CAAC,CAAC;IAEhE,MAAM,SAAS,GAAG,gBAAgB,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAC5D,MAAM,WAAW,GAAG,gBAAgB,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAEhE,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE;QACtD,OAAO;YACL,IAAI,EAAE,eAAe,CAAC,SAAS;YAC/B,QAAQ,EAAE,MAAM;YAChB,MAAM;SACP,CAAC;KACH;IAED,MAAM,yBAAyB,GAC7B,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAErE,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,GAAG,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;IAEhE,uBACE,IAAI,EAAE,eAAe,CAAC,MAAM,EAC5B,QAAQ,EAAE,MAAM,EAChB,MAAM,EACN,KAAK,EAAE,sBAAsB,CAAC,MAAM,EAAE,kBAAkB,CAAC,IACtD,sBAAsB,CAAC,MAAM,EAAE,yBAAyB,CAAC,EAC5D;AACJ,CAAC,CAAC"}

package/build/psl/build-tries.d.ts

@@ -0,0 +1,4 @@
+export declare const buildTries: (psl: string) => {
+    icannTrie: import("../trie/nodes.js").TrieRootNode;
+    privateTrie: import("../trie/nodes.js").TrieRootNode;
+};

package/{build-esm/src → build}/psl/build-tries.js

@@ -1,6 +1,6 @@
-import { toASCII } from "punycode";
-import { PUBLIC_SUFFIX_MARKER_ICANN_START, PUBLIC_SUFFIX_MARKER_ICANN_END, PUBLIC_SUFFIX_MARKER_PRIVATE_START, PUBLIC_SUFFIX_MARKER_PRIVATE_END, } from "../config";
-import { createTrieFromList } from "../trie/create-trie";
+import { PUBLIC_SUFFIX_MARKER_ICANN_START, PUBLIC_SUFFIX_MARKER_ICANN_END, PUBLIC_SUFFIX_MARKER_PRIVATE_START, PUBLIC_SUFFIX_MARKER_PRIVATE_END, } from "../config.js";
+import { toASCII } from "../punycode.js";
+import { createTrieFromList } from "../trie/create-trie.js";
 const matchNewLine = /\r?\n/u;
 const matchComment = /^\s*\/\//u;
 const matchWhitespace = /^\s*$/u;
@@ -16,31 +16,16 @@ const extractByMarkers = (listContent, startMarker, endMarker) => {
     return listContent.slice(start, end);
 };
 const containsRule = (line) => matchComment.test(line) === false && matchWhitespace.test(line) === false;
-const normalizeRule = (rule) => 
-/*
-  Users of parse-domain should only pass parsed hostnames (e.g. via new URL("...").hostname)
-  to parseDomain(). This frees us from the burden of URL parsing.
-  See also https://github.com/peerigon/parse-domain/issues/14
-
-  The problem is that new URL("...").hostname will also translate all non-ASCII characters
-  into punycode (e.g. 大分.jp becomes xn--kbrq7o.jp). This means for us that our serialized
-  trie needs to use punyencoded hostnames.
-
-  The downside of this is that punycode hostnames are bigger in terms of file size.
-  However, that's still better than including a punycode library into the runtime code of parse-domain.
-  Gzip is also very effective in removing duplicate characters.
-  */
-toASCII(rule).toLowerCase();
 const parsePsl = (listContent) => {
     return {
         icann: extractByMarkers(listContent, PUBLIC_SUFFIX_MARKER_ICANN_START, PUBLIC_SUFFIX_MARKER_ICANN_END)
             .split(matchNewLine)
             .filter(containsRule)
-            .map(normalizeRule),
+            .map(toASCII),
         private: extractByMarkers(listContent, PUBLIC_SUFFIX_MARKER_PRIVATE_START, PUBLIC_SUFFIX_MARKER_PRIVATE_END)
             .split(matchNewLine)
             .filter(containsRule)
-            .map(normalizeRule),
+            .map(toASCII),
     };
 };
 export const buildTries = (psl) => {

package/build/psl/build-tries.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"build-tries.js","sourceRoot":"","sources":["../../src/psl/build-tries.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gCAAgC,EAChC,8BAA8B,EAC9B,kCAAkC,EAClC,gCAAgC,GACjC,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AACzC,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAE5D,MAAM,YAAY,GAAG,QAAQ,CAAC;AAC9B,MAAM,YAAY,GAAG,WAAW,CAAC;AACjC,MAAM,eAAe,GAAG,QAAQ,CAAC;AAEjC,MAAM,gBAAgB,GAAG,CACvB,WAAmB,EACnB,WAAmB,EACnB,SAAiB,EACjB,EAAE;IACF,MAAM,KAAK,GAAG,WAAW,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IAC/C,MAAM,GAAG,GAAG,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAE3C,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE;QAChB,MAAM,IAAI,KAAK,CACb,wBAAwB,WAAW,wBAAwB,CAC5D,CAAC;KACH;IACD,IAAI,GAAG,KAAK,CAAC,CAAC,EAAE;QACd,MAAM,IAAI,KAAK,CAAC,sBAAsB,SAAS,wBAAwB,CAAC,CAAC;KAC1E;IAED,OAAO,WAAW,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;AACvC,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,IAAY,EAAE,EAAE,CACpC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,IAAI,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,CAAC;AAE5E,MAAM,QAAQ,GAAG,CAAC,WAAmB,EAAE,EAAE;IACvC,OAAO;QACL,KAAK,EAAE,gBAAgB,CACrB,WAAW,EACX,gCAAgC,EAChC,8BAA8B,CAC/B;aACE,KAAK,CAAC,YAAY,CAAC;aACnB,MAAM,CAAC,YAAY,CAAC;aACpB,GAAG,CAAC,OAAO,CAAC;QACf,OAAO,EAAE,gBAAgB,CACvB,WAAW,EACX,kCAAkC,EAClC,gCAAgC,CACjC;aACE,KAAK,CAAC,YAAY,CAAC;aACnB,MAAM,CAAC,YAAY,CAAC;aACpB,GAAG,CAAC,OAAO,CAAC;KAChB,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,GAAW,EAAE,EAAE;IACxC,MAAM,SAAS,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;IAChC,MAAM,SAAS,GAAG,kBAAkB,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IACtD,MAAM,WAAW,GAAG,kBAAkB,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAE1D,OAAO;QACL,SAAS;QACT,WAAW;KACZ,CAAC;AACJ,CAAC,CAAC"}

package/{build-esm/src → build}/psl/fetch-psl.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { ok } from "assert";
 import fetch from "node-fetch";
-import { FETCH_PSL_EXPECTED_MIN_LENGTH, PUBLIC_SUFFIX_URL } from "../config";
+import { FETCH_PSL_EXPECTED_MIN_LENGTH, PUBLIC_SUFFIX_URL } from "../config.js";
 export const fetchPsl = () => __awaiter(void 0, void 0, void 0, function* () {
     const response = yield fetch(PUBLIC_SUFFIX_URL);
     const pslContent = yield response.text();

package/build/psl/fetch-psl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch-psl.js","sourceRoot":"","sources":["../../src/psl/fetch-psl.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC5B,OAAO,KAAK,MAAM,YAAY,CAAC;AAC/B,OAAO,EAAE,6BAA6B,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAEhF,MAAM,CAAC,MAAM,QAAQ,GAAG,GAAS,EAAE;IACjC,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAChD,MAAM,UAAU,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;IAEzC,eAAe;IACf,EAAE,CACA,UAAU,CAAC,MAAM,IAAI,6BAA6B,EAClD,6CAA6C,CAC9C,CAAC;IAEF,OAAO,UAAU,CAAC;AACpB,CAAC,CAAA,CAAC"}

package/build/punycode.d.ts

@@ -0,0 +1 @@
+export declare const toASCII: (hostname: string) => string;

package/build/punycode.js

@@ -0,0 +1,4 @@
+export const toASCII = (hostname) => {
+    return new URL(`http://${hostname}`).hostname;
+};
+//# sourceMappingURL=punycode.js.map

package/build/punycode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"punycode.js","sourceRoot":"","sources":["../src/punycode.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,QAAgB,EAAE,EAAE;IAC1C,OAAO,IAAI,GAAG,CAAC,UAAU,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC;AAChD,CAAC,CAAC"}

package/{build-cjs/src → build}/sanitize.d.ts

@@ -1,12 +1,32 @@
-import isIp from "is-ip";
-import { Label } from "./parse-domain";
-import { NO_HOSTNAME } from "./from-url";
+import { ipVersion } from "is-ip";
+import { Label } from "./parse-domain.js";
+import { NO_HOSTNAME } from "./from-url.js";
+export declare enum Validation {
+    /**
+     * Allows any octets as labels
+     * but still restricts the length of labels and the overall domain.
+     *
+     * @see https://www.rfc-editor.org/rfc/rfc2181#section-11
+     **/
+    Lax = "LAX",
+    /**
+     * Only allows ASCII letters, digits and hyphens (aka LDH),
+     * forbids hyphens at the beginning or end of a label
+     * and requires top-level domain names not to be all-numeric.
+     *
+     * This is the default if no validation is configured.
+     *
+     * @see https://datatracker.ietf.org/doc/html/rfc3696#section-2
+     */
+    Strict = "STRICT"
+}
 export declare enum ValidationErrorType {
     NoHostname = "NO_HOSTNAME",
     DomainMaxLength = "DOMAIN_MAX_LENGTH",
     LabelMinLength = "LABEL_MIN_LENGTH",
     LabelMaxLength = "LABEL_MAX_LENGTH",
-    LabelInvalidCharacter = "LABEL_INVALID_CHARACTER"
+    LabelInvalidCharacter = "LABEL_INVALID_CHARACTER",
+    LastLabelInvalid = "LAST_LABEL_INVALID"
 }
 export declare type ValidationError = {
     type: ValidationErrorType;
@@ -21,7 +41,7 @@ export declare enum SanitizationResultType {
 export declare type SanitizationResultValidIp = {
     type: SanitizationResultType.ValidIp;
     ip: string;
-    ipVersion: Exclude<ReturnType<typeof isIp.version>, undefined>;
+    ipVersion: Exclude<ReturnType<typeof ipVersion>, undefined>;
 };
 export declare type SanitizationResultValidDomain = {
     type: SanitizationResultType.ValidDomain;
@@ -33,4 +53,6 @@ export declare type SanitizationResultError = {
     errors: Array<ValidationError>;
 };
 export declare type SanitizationResult = SanitizationResultValidIp | SanitizationResultValidDomain | SanitizationResultError;
-export declare const sanitize: (input: string | typeof NO_HOSTNAME) => SanitizationResult;
+export declare const sanitize: (input: string | typeof NO_HOSTNAME, options?: {
+    validation?: Validation;
+}) => SanitizationResult;