@stll/stdnum 1.0.0 → 2.0.0

package/src/lei.ts

@@ -9,14 +9,17 @@
  * @see https://www.gleif.org/
  */
 
+import type {
+  ValidateResult,
+  GlobalValidator,
+} from "./types";
+
 import { mod97 } from "#checksums/mod97";
 import { clean } from "#util/clean";
 import { randomInt } from "#util/generate";
 import { err } from "#util/result";
 import { charValue, isalnum } from "#util/strings";
 
-import type { ValidateResult, Validator } from "./types";
-
 const compact = (value: string): string =>
   clean(value, " -").toUpperCase();
 
@@ -79,7 +82,8 @@ const generate = (): string => {
 };
 
 /** Legal Entity Identifier. */
-const lei: Validator = {
+const lei: GlobalValidator = {
+  scope: "global",
   name: "Legal Entity Identifier",
   localName: "Legal Entity Identifier",
   abbreviation: "LEI",

package/src/li/peid.ts

@@ -15,13 +15,16 @@ const generate = (): string => {
  * @see https://www.oera.li/
  */
 
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import { clean } from "#util/clean";
 import { randomDigits, randomInt } from "#util/generate";
 import { err } from "#util/result";
 import { isdigits } from "#util/strings";
 
-import type { ValidateResult, Validator } from "../types";
-
 const compact = (value: string): string =>
   clean(value, " .").replace(/^0+/, "");
 
@@ -45,12 +48,13 @@ const validate = (value: string): ValidateResult => {
 const format = (value: string): string => compact(value);
 
 /** Liechtenstein Person Identification Number. */
-const peid: Validator = {
+const peid: CountryValidator<"LI"> = {
   name: "Liechtenstein Person Identification Number",
   localName: "Personenidentifikationsnummer",
   abbreviation: "PEID",
   aliases: ["PEID", "Personenidentifikation"] as const,
   candidatePattern: "\\d{6}",
+  scope: "country",
   country: "LI",
   entityType: "any",
   lengths: [4, 5, 6, 7, 8, 9, 10, 11, 12] as const,

package/src/lk/nic.ts

@@ -12,18 +12,18 @@
  * @see https://drp.gov.lk/Templates/Artical%20-%20English%20new%20number.html
  */
 
+import type {
+  ParsedPersonId,
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import { clean } from "#util/clean";
 import { isValidDate } from "#util/date";
 import { randomDigits, randomInt } from "#util/generate";
 import { err } from "#util/result";
 import { isdigits } from "#util/strings";
 
-import type {
-  ParsedPersonId,
-  ValidateResult,
-  Validator,
-} from "../types";
-
 /** Old format: 9 digits + V or X (case-insensitive). */
 const OLD_RE = /^\d{9}[VvXx]$/;
 
@@ -205,12 +205,13 @@ const generate = (): string => {
 };
 
 /** Sri Lankan National Identity Card. */
-const nic: Validator<ParsedPersonId> = {
+const nic: CountryValidator<"LK", ParsedPersonId> = {
   name: "National Identity Card",
   localName: "ජාතික හැඳුනුම්පත",
   abbreviation: "NIC",
   aliases: ["NIC", "ජාතික හැඳුනුම්පත"] as const,
   candidatePattern: "\\d{9}[VXvx]|\\d{12}",
+  scope: "country",
   country: "LK",
   entityType: "person",
   description:

package/src/lt/asmens.ts

@@ -10,15 +10,18 @@
  * @see https://www.registrucentras.lt/
  */
 
+import { twoPassCheck } from "../ee/ik";
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import { clean } from "#util/clean";
 import { isValidDate } from "#util/date";
 import { randomInt } from "#util/generate";
 import { err } from "#util/result";
 import { isdigits } from "#util/strings";
 
-import { twoPassCheck } from "../ee/ik";
-import type { ValidateResult, Validator } from "../types";
-
 const compact = (value: string): string =>
   clean(value, " -");
 
@@ -100,12 +103,13 @@ const generate = (): string => {
 };
 
 /** Lithuanian Personal Code. */
-const asmens: Validator = {
+const asmens: CountryValidator<"LT"> = {
   name: "Lithuanian Personal ID",
   localName: "Asmens kodas",
   abbreviation: "AK",
   aliases: ["asmens kodas", "AK"] as const,
   candidatePattern: "[3-6]\\d{10}",
+  scope: "country",
   country: "LT",
   entityType: "person",
   sourceUrl: "https://www.registrucentras.lt/",

package/src/lt/vat.ts

@@ -9,13 +9,16 @@
  * @see https://www.vmi.lt/
  */
 
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import { clean } from "#util/clean";
 import { randomDigits } from "#util/generate";
 import { err } from "#util/result";
 import { isdigits } from "#util/strings";
 
-import type { ValidateResult, Validator } from "../types";
-
 const compact = (value: string): string => {
   let v = clean(value, " -/.");
   if (v.startsWith("LT") || v.startsWith("lt")) {
@@ -89,15 +92,17 @@ const generate = (): string => {
 };
 
 /** Lithuanian VAT Number. */
-const vat: Validator = {
+const vat: CountryValidator<"LT"> = {
   name: "Lithuanian VAT Number",
   localName: "PVM mokėtojo kodas",
   abbreviation: "PVM kodas",
   aliases: ["PVM mokėtojo kodas", "PVM"] as const,
   candidatePattern: "LT\\d{9,12}",
+  scope: "country",
   country: "LT",
   entityType: "any",
   sourceUrl: "https://www.vmi.lt/",
+  lengths: [9, 12] as const,
   examples: ["119511515", "100001919017"] as const,
   compact,
   format,

package/src/lu/vat.ts

@@ -7,13 +7,16 @@
  * @see https://www.oecd.org/content/dam/oecd/en/topics/policy-issue-focus/aeoi/luxembourg-tin.pdf
  */
 
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import { clean } from "#util/clean";
 import { randomDigits } from "#util/generate";
 import { err } from "#util/result";
 import { isdigits } from "#util/strings";
 
-import type { ValidateResult, Validator } from "../types";
-
 const compact = (value: string): string => {
   let v = clean(value, " -/.");
   if (v.startsWith("LU") || v.startsWith("lu")) {
@@ -60,15 +63,17 @@ const generate = (): string => {
 };
 
 /** Luxembourg VAT Number. */
-const vat: Validator = {
+const vat: CountryValidator<"LU"> = {
   name: "Luxembourg VAT Number",
   localName: "Numéro de TVA",
   abbreviation: "TVA",
   aliases: ["TVA", "numéro d'identification TVA"] as const,
   candidatePattern: "LU\\d{8}",
+  scope: "country",
   country: "LU",
   entityType: "company",
   sourceUrl: "https://pfi.public.lu/",
+  lengths: [8] as const,
   examples: ["15027442"] as const,
   compact,
   format,

package/src/luhn.ts

@@ -7,6 +7,11 @@
  * (13-19 digits), use `creditcard` instead.
  */
 
+import type {
+  ValidateResult,
+  GlobalValidator,
+} from "./types";
+
 import {
   luhnChecksum,
   luhnValidate,
@@ -16,8 +21,6 @@ import { randomDigits } from "#util/generate";
 import { err } from "#util/result";
 import { isdigits } from "#util/strings";
 
-import type { ValidateResult, Validator } from "./types";
-
 const compact = (value: string): string =>
   clean(value, " -.");
 
@@ -56,7 +59,8 @@ const generate = (length = 16): string => {
 };
 
 /** Generic Luhn Validator. */
-const luhn: Validator = {
+const luhn: GlobalValidator = {
+  scope: "global",
   name: "Luhn",
   localName: "Luhn",
   abbreviation: "Luhn",

package/src/lv/vat.ts

@@ -26,14 +26,17 @@
  * @see https://www.pmlp.gov.lv/en/change-personal-identity-number
  */
 
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import { weightedSum } from "#checksums/weighted-sum";
 import { clean } from "#util/clean";
 import { randomDigits, randomInt } from "#util/generate";
 import { err } from "#util/result";
 import { isdigits } from "#util/strings";
 
-import type { ValidateResult, Validator } from "../types";
-
 const WEIGHTS = [9, 1, 4, 8, 3, 10, 2, 5, 7, 6, 1];
 
 const compact = (value: string): string => {
@@ -144,12 +147,13 @@ const generate = (): string => {
 };
 
 /** Latvian VAT Number. */
-const vat: Validator = {
+const vat: CountryValidator<"LV"> = {
   name: "Latvian VAT Number",
   localName: "PVN reģistrācijas numurs",
   abbreviation: "PVN",
   aliases: ["PVN reģistrācijas numurs", "PVN"] as const,
   candidatePattern: "LV\\d{11}",
+  scope: "country",
   country: "LV",
   entityType: "any",
   sourceUrl:

package/src/ma/ice.ts

@@ -9,14 +9,17 @@
  * @see https://www.ice.gov.ma/
  */
 
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import { mod97 } from "#checksums/mod97";
 import { clean } from "#util/clean";
 import { randomDigits } from "#util/generate";
 import { err } from "#util/result";
 import { isdigits } from "#util/strings";
 
-import type { ValidateResult, Validator } from "../types";
-
 const compact = (value: string): string =>
   clean(value, " ");
 
@@ -54,7 +57,7 @@ const generate = (): string => {
 };
 
 /** Moroccan Company Identification Number. */
-const ice: Validator = {
+const ice: CountryValidator<"MA"> = {
   name: "Moroccan Company Identification Number",
   localName: "Identifiant Commun de l'Entreprise",
   abbreviation: "ICE",
@@ -63,6 +66,7 @@ const ice: Validator = {
     "Identifiant Commun de l'Entreprise",
   ] as const,
   candidatePattern: "\\d{15}",
+  scope: "country",
   country: "MA",
   entityType: "company",
   compact,

package/src/mc/tva.ts

@@ -10,14 +10,17 @@
  * @see https://www.economie.gouv.fr/
  */
 
-import { randomDigits } from "#util/generate";
-import { err } from "#util/result";
-
 import {
   compact as frCompact,
   validate as frValidate,
 } from "../fr/tva";
-import type { ValidateResult, Validator } from "../types";
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
+import { randomDigits } from "#util/generate";
+import { err } from "#util/result";
 
 const compact = (value: string): string => {
   const v = frCompact(value);
@@ -54,12 +57,13 @@ const generate = (): string => {
 };
 
 /** Monacan VAT Number. */
-const tva: Validator = {
+const tva: CountryValidator<"MC"> = {
   name: "Monacan VAT Number",
   localName: "Numéro de TVA",
   abbreviation: "TVA",
   aliases: ["numéro de TVA", "TVA"] as const,
   candidatePattern: "FR\\d{11}",
+  scope: "country",
   country: "MC",
   entityType: "company",
   sourceUrl: "https://www.economie.gouv.fr/",

package/src/md/idno.ts

@@ -9,12 +9,15 @@
  * @see https://www.idno.md
  */
 
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import { clean } from "#util/clean";
 import { err } from "#util/result";
 import { isdigits } from "#util/strings";
 
-import type { ValidateResult, Validator } from "../types";
-
 const WEIGHTS = [
   7, 3, 1, 7, 3, 1, 7, 3, 1, 7, 3, 1,
 ] as const;
@@ -65,12 +68,13 @@ const generate = (): string => {
 };
 
 /** Moldavian Company Identification Number. */
-const idno: Validator = {
+const idno: CountryValidator<"MD"> = {
   name: "Moldavian Company Identification Number",
   localName: "IDNO",
   abbreviation: "IDNO",
   aliases: ["IDNO", "cod de identificare"] as const,
   candidatePattern: "\\d{13}",
+  scope: "country",
   country: "MD",
   entityType: "company",
   lengths: [13] as const,

package/src/me/pib.ts

@@ -8,14 +8,17 @@
  * @see https://www.tax.gov.me/
  */
 
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import { weightedSum } from "#checksums/weighted-sum";
 import { clean } from "#util/clean";
 import { randomDigits } from "#util/generate";
 import { err } from "#util/result";
 import { isdigits } from "#util/strings";
 
-import type { ValidateResult, Validator } from "../types";
-
 const WEIGHTS = [8, 7, 6, 5, 4, 3, 2] as const;
 
 const compact = (value: string): string =>
@@ -58,12 +61,13 @@ const generate = (): string => {
 };
 
 /** Montenegrin Tax Identification Number. */
-const pib: Validator = {
+const pib: CountryValidator<"ME"> = {
   name: "Montenegrin Tax ID",
   localName: "Poreski identifikacioni broj",
   abbreviation: "PIB",
   aliases: ["PIB"] as const,
   candidatePattern: "\\d{8}",
+  scope: "country",
   country: "ME",
   entityType: "any",
   lengths: [8] as const,

package/src/mk/edb.ts

@@ -9,14 +9,17 @@
  * @see https://www.ujp.gov.mk/
  */
 
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import { weightedSum } from "#checksums/weighted-sum";
 import { clean } from "#util/clean";
 import { randomDigits } from "#util/generate";
 import { err } from "#util/result";
 import { isdigits } from "#util/strings";
 
-import type { ValidateResult, Validator } from "../types";
-
 const WEIGHTS = [
   7, 6, 5, 4, 3, 2, 7, 6, 5, 4, 3, 2,
 ] as const;
@@ -66,7 +69,7 @@ const generate = (): string => {
 };
 
 /** North Macedonian Tax Identification Number. */
-const edb: Validator = {
+const edb: CountryValidator<"MK"> = {
   name: "North Macedonian Tax ID",
   localName: "Edinstven danocen broj",
   abbreviation: "EDB",
@@ -76,6 +79,7 @@ const edb: Validator = {
     "EDB",
   ] as const,
   candidatePattern: "MK\\d{13}",
+  scope: "country",
   country: "MK",
   entityType: "any",
   lengths: [13] as const,

package/src/mt/vat.ts

@@ -8,14 +8,17 @@
  * @see https://www.oecd.org/content/dam/oecd/en/topics/policy-issue-focus/aeoi/malta-tin.pdf
  */
 
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import { weightedSum } from "#checksums/weighted-sum";
 import { clean } from "#util/clean";
 import { randomDigits, randomInt } from "#util/generate";
 import { err } from "#util/result";
 import { isdigits } from "#util/strings";
 
-import type { ValidateResult, Validator } from "../types";
-
 const WEIGHTS = [3, 4, 6, 7, 8, 9, 10, 1];
 
 const compact = (value: string): string => {
@@ -68,15 +71,17 @@ const generate = (): string => {
 };
 
 /** Maltese VAT Number. */
-const vat: Validator = {
+const vat: CountryValidator<"MT"> = {
   name: "Maltese VAT Number",
   localName: "VAT Registration Number",
   abbreviation: "VAT",
   aliases: ["VAT number MT"] as const,
   candidatePattern: "MT\\d{8}",
+  scope: "country",
   country: "MT",
   entityType: "company",
   sourceUrl: "https://cfr.gov.mt/",
+  lengths: [8] as const,
   examples: ["11679112"] as const,
   compact,
   format,

package/src/mu/brn.ts

@@ -29,12 +29,15 @@ const generate = (): string => {
  * @see https://www.oecd.org/content/dam/oecd/en/topics/policy-issue-focus/aeoi/mauritius-tin.pdf
  */
 
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import { clean } from "#util/clean";
 import { randomDigits, randomInt } from "#util/generate";
 import { err } from "#util/result";
 
-import type { ValidateResult, Validator } from "../types";
-
 /** Entity BRN: letter + 8 digits. */
 const ENTITY_RE = /^[A-Z]\d{8}$/;
 
@@ -78,12 +81,13 @@ const validate = (value: string): ValidateResult => {
 const format = (value: string): string => compact(value);
 
 /** Mauritius Business Registration Number. */
-const brn: Validator = {
+const brn: CountryValidator<"MU"> = {
   name: "Mauritius Business Registration Number",
   localName: "Business Registration Number",
   abbreviation: "BRN",
   aliases: ["BRN", "Business Registration Number"] as const,
   candidatePattern: "[A-Z]\\d{8}",
+  scope: "country",
   country: "MU",
   entityType: "any",
   compact,

package/src/mx/clabe.ts

@@ -13,13 +13,16 @@
  * @see https://en.wikipedia.org/wiki/CLABE
  */
 
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import { clean } from "#util/clean";
 import { randomDigits } from "#util/generate";
 import { err } from "#util/result";
 import { isdigits } from "#util/strings";
 
-import type { ValidateResult, Validator } from "../types";
-
 const WEIGHTS = [3, 7, 1] as const;
 
 const compact = (value: string): string =>
@@ -87,7 +90,7 @@ const generate = (): string => {
  *
  * Example sourced from Wikipedia CLABE article.
  */
-const clabe: Validator = {
+const clabe: CountryValidator<"MX"> = {
   name: "Mexican Bank Account",
   localName: "Clave Bancaria Estandarizada",
   abbreviation: "CLABE",
@@ -96,6 +99,7 @@ const clabe: Validator = {
     "Clave Bancaria Estandarizada",
   ] as const,
   candidatePattern: "\\d{18}",
+  scope: "country",
   country: "MX",
   entityType: "any",
   lengths: [18] as const,

package/src/mx/curp.ts

@@ -14,17 +14,17 @@
  * @see https://en.wikipedia.org/wiki/CURP
  */
 
-import { clean } from "#util/clean";
-import { isValidDate } from "#util/date";
-import { randomInt } from "#util/generate";
-import { err } from "#util/result";
-
 import type {
   ParsedPersonId,
   ValidateResult,
-  Validator,
+  CountryValidator,
 } from "../types";
 
+import { clean } from "#util/clean";
+import { isValidDate } from "#util/date";
+import { randomInt } from "#util/generate";
+import { err } from "#util/result";
+
 /** Valid Mexican state codes (2-letter). */
 const STATE_CODES = new Set([
   "AS",
@@ -72,7 +72,7 @@ const LETTERS = "ABCDEFGHIJKLMNOPQRSTUVWXYZ";
 const ALPHABET = "0123456789ABCDEFGHIJKLMN&OPQRSTUVWXYZ";
 
 const CHAR_MAP = new Map<string, number>();
-for (const [i, ch] of [...ALPHABET].entries()) {
+for (const [i, ch] of ALPHABET.split("").entries()) {
   CHAR_MAP.set(ch, i);
 }
 
@@ -221,7 +221,7 @@ const generate = (): string => {
  *
  * Example sourced from python-stdnum test suite.
  */
-const curp: Validator<ParsedPersonId> = {
+const curp: CountryValidator<"MX", ParsedPersonId> = {
   name: "Mexican Personal ID",
   localName: "Clave Única de Registro de Población",
   abbreviation: "CURP",
@@ -230,6 +230,7 @@ const curp: Validator<ParsedPersonId> = {
     "Clave Única de Registro de Población",
   ] as const,
   candidatePattern: "[A-Z]{4}\\d{6}[HM][A-Z]{5}[A-Z\\d]\\d",
+  scope: "country",
   country: "MX",
   entityType: "person",
   lengths: [18] as const,

package/src/mx/rfc.ts

@@ -16,18 +16,21 @@
  * @see https://en.wikipedia.org/wiki/Tax_Identification_Number_(Mexico)
  */
 
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import { clean } from "#util/clean";
 import { isValidDate } from "#util/date";
 import { randomInt } from "#util/generate";
 import { err } from "#util/result";
 
-import type { ValidateResult, Validator } from "../types";
-
 /** Alphabet for RFC check digit computation. */
 const ALPHABET = "0123456789ABCDEFGHIJKLMN&OPQRSTUVWXYZ Ñ";
 
 const CHAR_MAP = new Map<string, number>();
-for (const [i, ch] of [...ALPHABET].entries()) {
+for (const [i, ch] of ALPHABET.split("").entries()) {
   CHAR_MAP.set(ch, i);
 }
 
@@ -150,7 +153,7 @@ const generate = (): string => {
  *
  * Examples sourced from python-stdnum test suite.
  */
-const rfc: Validator = {
+const rfc: CountryValidator<"MX"> = {
   name: "Mexican Tax ID",
   localName: "Registro Federal de Contribuyentes",
   abbreviation: "RFC",
@@ -159,6 +162,7 @@ const rfc: Validator = {
     "Registro Federal de Contribuyentes",
   ] as const,
   candidatePattern: "[A-ZÑ&]{3,4}\\d{6}[A-Z\\d]{3}",
+  scope: "country",
   country: "MX",
   entityType: "any",
   lengths: [12, 13] as const,