@stll/stdnum 1.0.0 → 2.0.1

package/src/cn/ric.ts

@@ -11,6 +11,12 @@
  * @see https://en.wikipedia.org/wiki/Resident_Identity_Card
  */
 
+import type {
+  ParsedPersonId,
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import {
   mod112checkChar,
   mod112validate,
@@ -21,12 +27,6 @@ import { randomInt } from "#util/generate";
 import { err } from "#util/result";
 import { isdigits } from "#util/strings";
 
-import type {
-  ParsedPersonId,
-  ValidateResult,
-  Validator,
-} from "../types";
-
 const compact = (value: string): string =>
   clean(value, " -").toUpperCase();
 
@@ -155,12 +155,13 @@ const generate = (): string => {
 };
 
 /** Chinese Resident Identity Card number. */
-const ric: Validator<ParsedPersonId> = {
+const ric: CountryValidator<"CN", ParsedPersonId> = {
   name: "Chinese Resident Identity Card",
   localName: "居民身份证号码",
   abbreviation: "RIC",
   aliases: ["身份证", "居民身份证号码", "RIC"] as const,
   candidatePattern: "\\d{17}[\\dX]",
+  scope: "country",
   country: "CN",
   entityType: "person",
   description:

package/src/cn/uscc.ts

@@ -9,6 +9,11 @@
  * @see https://zh.wikipedia.org/wiki/统一社会信用代码
  */
 
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import { clean } from "#util/clean";
 import {
   randomChar,
@@ -18,8 +23,6 @@ import {
 import { err } from "#util/result";
 import { isdigits } from "#util/strings";
 
-import type { ValidateResult, Validator } from "../types";
-
 const ALPHABET = "0123456789ABCDEFGHJKLMNPQRTUWXY";
 
 const WEIGHTS = [
@@ -98,13 +101,14 @@ const generate = (): string => {
 };
 
 /** Chinese Unified Social Credit Code. */
-const uscc: Validator = {
+const uscc: CountryValidator<"CN"> = {
   name: "Unified Social Credit Code",
   localName: "统一社会信用代码",
   abbreviation: "USCC",
   aliases: ["统一社会信用代码", "USCC"] as const,
   candidatePattern:
     "[0-9A-HJ-NP-RTUW-Y]{2}\\d{6}[0-9A-HJ-NP-RTUW-Y]{10}",
+  scope: "country",
   country: "CN",
   entityType: "company",
   description:

package/src/co/nit.ts

@@ -10,13 +10,16 @@
  * @see https://es.wikipedia.org/wiki/Número_de_identificación_tributaria
  */
 
+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, 13, 17, 19, 23, 29, 37, 41, 43, 47, 53, 59, 67, 71,
 ] as const;
@@ -57,7 +60,7 @@ const validate = (value: string): ValidateResult => {
 
   const body = v.slice(0, -1);
   const check = calcCheckDigit(body);
-  if (check !== Number(v[v.length - 1])) {
+  if (check !== Number(v.at(-1))) {
     return err(
       "INVALID_CHECKSUM",
       "NIT check digit does not match",
@@ -86,7 +89,7 @@ const generate = (): string => {
 };
 
 /** Colombian tax identification number. */
-const nit: Validator = {
+const nit: CountryValidator<"CO"> = {
   name: "Número de Identificación Tributaria",
   localName: "Número de Identificación Tributaria",
   abbreviation: "NIT",
@@ -95,6 +98,7 @@ const nit: Validator = {
     "Número de Identificación Tributaria",
   ] as const,
   candidatePattern: "\\d{9,10}-?\\d",
+  scope: "country",
   country: "CO",
   entityType: "any",
   description: "Tax identifier issued by the DIAN",

package/src/cr/cpf.ts

@@ -23,12 +23,15 @@ const generate = (): string => {
  * @see https://www.tse.go.cr/
  */
 
+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";
-
 /**
  * Compact: strip spaces, pad hyphen-separated parts
  * (2-4-4), join, and prepend '0' if 9 digits.
@@ -91,12 +94,13 @@ const format = (value: string): string => {
  *
  * Examples sourced from python-stdnum test suite.
  */
-const cpf: Validator = {
+const cpf: CountryValidator<"CR"> = {
   name: "Costa Rican Physical Person ID",
   localName: "Cédula de Persona Física",
   abbreviation: "CPF",
   aliases: ["CPF", "cédula de persona física"] as const,
   candidatePattern: "\\d{9,12}",
+  scope: "country",
   country: "CR",
   entityType: "person",
   lengths: [10] as const,

package/src/creditcard.ts

@@ -9,6 +9,11 @@
  * @see https://www.iso.org/standard/70484.html
  */
 
+import type {
+  ValidateResult,
+  GlobalValidator,
+} from "./types";
+
 import {
   luhnChecksum,
   luhnValidate,
@@ -18,8 +23,6 @@ import { randomDigits, randomInt } from "#util/generate";
 import { err } from "#util/result";
 import { isdigits } from "#util/strings";
 
-import type { ValidateResult, Validator } from "./types";
-
 /**
  * Card network identifiers returned by
  * {@link detectNetwork}.
@@ -74,9 +77,9 @@ const format = (value: string): string => {
   return groups.join(" ");
 };
 
-const MAESTRO_PREFIXES: readonly number[] = [
+const MAESTRO_PREFIXES = new Set([
   5018, 5020, 5038, 5893, 6304, 6759, 6761, 6762, 6763,
-];
+]);
 
 /**
  * Detect the card network from the BIN/IIN prefix.
@@ -112,7 +115,7 @@ const detectNetwork = (
 
   // Maestro (check before Mastercard; some share
   // the 50xx prefix space)
-  if (MAESTRO_PREFIXES.includes(d4)) return "maestro";
+  if (MAESTRO_PREFIXES.has(d4)) return "maestro";
 
   // Mastercard: 51-55 or 2221-2720
   if (d2 >= 51 && d2 <= 55) return "mastercard";
@@ -162,7 +165,8 @@ const generate = (): string => {
 };
 
 /** Credit Card Number (Luhn). */
-const creditCard: Validator = {
+const creditCard: GlobalValidator = {
+  scope: "global",
   name: "Credit Card Number",
   localName: "Credit Card Number",
   abbreviation: "CC",

package/src/cu/ni.ts

@@ -15,17 +15,17 @@
  * @see https://www.ecured.cu/Carnet_de_Identidad
  */
 
-import { clean } from "#util/clean";
-import { isValidDate } from "#util/date";
-import { randomDigits, 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 { randomDigits, randomInt } from "#util/generate";
+import { err } from "#util/result";
+
 const compact = (value: string): string =>
   clean(value, " -").trim();
 
@@ -119,7 +119,7 @@ const generate = (): string => {
  *
  * Examples sourced from python-stdnum test suite.
  */
-const ni: Validator<ParsedPersonId> = {
+const ni: CountryValidator<"CU", ParsedPersonId> = {
   name: "Cuban Identity Card Number",
   localName: "Número de Identidad",
   abbreviation: "NI",
@@ -129,6 +129,7 @@ const ni: Validator<ParsedPersonId> = {
     "carnet de identidad",
   ] as const,
   candidatePattern: "\\d{11}",
+  scope: "country",
   country: "CU",
   entityType: "person",
   lengths: [11] as const,

package/src/cy/vat.ts

@@ -7,13 +7,16 @@
  * @see https://www.oecd.org/content/dam/oecd/en/topics/policy-issue-focus/aeoi/cyprus-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 ODD_MAP: Record<number, number> = {
   0: 1,
   1: 0,
@@ -110,12 +113,13 @@ const generate = (): string => {
 };
 
 /** Cypriot VAT Number. */
-const vat: Validator = {
+const vat: CountryValidator<"CY"> = {
   name: "Cypriot VAT Number",
   localName: "Αριθμός Εγγραφής Φ.Π.Α.",
   abbreviation: "ΦΠΑ",
   aliases: ["ΦΠΑ", "VAT CY"] as const,
   candidatePattern: "CY\\d{8}[A-Z]",
+  scope: "country",
   country: "CY",
   entityType: "company",
   sourceUrl: "https://www.mof.gov.cy/",

package/src/cz/dic.ts

@@ -11,15 +11,18 @@
  * @see https://adisspr.mfcr.cz/dpr/DphReg
  */
 
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+import { validate as validateRc } from "./rc";
+
 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";
-import { validate as validateRc } from "./rc";
-
 const ICO_WEIGHTS = [8, 7, 6, 5, 4, 3, 2] as const;
 
 const compact = (value: string): string => {
@@ -115,15 +118,17 @@ const generate = (): string => {
 };
 
 /** Czech VAT Number. */
-const dic: Validator = {
+const dic: CountryValidator<"CZ"> = {
   name: "Czech VAT Number",
   localName: "Daňové identifikační číslo",
   abbreviation: "DIČ",
   aliases: ["DIČ", "daňové identifikační číslo"] as const,
   candidatePattern: "CZ\\d{8,10}",
+  scope: "country",
   country: "CZ",
   entityType: "any",
   sourceUrl: "https://adisspr.mfcr.cz/dpr/DphReg",
+  lengths: [8, 9, 10] as const,
   examples: ["25123891", "7103192745"] as const,
   compact,
   format,

package/src/cz/ico.ts

@@ -8,14 +8,17 @@
  * @see https://www.czso.cz/
  */
 
+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 =>
@@ -59,12 +62,13 @@ const generate = (): string => {
 };
 
 /** Czech Company Identification Number. */
-const ico: Validator = {
+const ico: CountryValidator<"CZ"> = {
   name: "Czech Company ID",
   localName: "Identifikační číslo osoby",
   abbreviation: "IČO",
   aliases: ["IČO", "IČ", "identifikační číslo"] as const,
   candidatePattern: "\\d{8}",
+  scope: "country",
   country: "CZ",
   entityType: "company",
   description:

package/src/cz/rc.ts

@@ -24,18 +24,18 @@
  * @see Law 133/2000 Sb.
  */
 
+import type {
+  ParsedPersonId,
+  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 type {
-  ParsedPersonId,
-  ValidateResult,
-  Validator,
-} from "../types";
-
 const compact = (value: string): string =>
   clean(value, " /");
 
@@ -196,12 +196,13 @@ const generate = (): string => {
 };
 
 /** Czech/Slovak Birth Number. */
-const rc: Validator<ParsedPersonId> = {
+const rc: CountryValidator<"CZ", ParsedPersonId> = {
   name: "Czech Birth Number",
   localName: "Rodné číslo",
   abbreviation: "RČ",
   aliases: ["rodné číslo", "RČ", "birth number"] as const,
   candidatePattern: "\\d{6}/\\d{3,4}",
+  scope: "country",
   country: "CZ",
   entityType: "person",
   description:

package/src/de/handelsreg.ts

@@ -31,12 +31,15 @@ const generate = (): string => {
  * @see https://de.wikipedia.org/wiki/Handelsregister_(Deutschland)
  */
 
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import { clean } from "#util/clean";
 import { randomDigits, randomPick } from "#util/generate";
 import { err } from "#util/result";
 
-import type { ValidateResult, Validator } from "../types";
-
 const REGISTER_TYPES = new Set([
   "HRA",
   "HRB",
@@ -92,7 +95,7 @@ const validate = (value: string): ValidateResult => {
 const format = (value: string): string => compact(value);
 
 /** German Company Register Number. */
-const handelsreg: Validator = {
+const handelsreg: CountryValidator<"DE"> = {
   name: "German Company Register Number",
   localName: "Handelsregisternummer",
   abbreviation: "HReg",
@@ -103,6 +106,7 @@ const handelsreg: Validator = {
     "HRA",
   ] as const,
   candidatePattern: "(?:HRA|HRB|GnR|PR|VR)\\s*\\d{1,7}",
+  scope: "country",
   country: "DE",
   entityType: "company",
   sourceUrl:

package/src/de/idnr.ts

@@ -10,6 +10,11 @@
  * @see https://www.bzst.de/DE/Privatpersonen/SteuerlicheIdentifikationsnummer/steuerlicheidentifikationsnummer_node.html
  */
 
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import {
   mod1110validate,
   mod1110checkDigit,
@@ -19,8 +24,6 @@ import { 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, " -/");
 
@@ -118,7 +121,7 @@ const generate = (): string => {
 };
 
 /** German Personal Tax ID. */
-const idnr: Validator = {
+const idnr: CountryValidator<"DE"> = {
   name: "German Tax ID",
   localName: "Steuerliche Identifikationsnummer",
   abbreviation: "IdNr",
@@ -128,6 +131,7 @@ const idnr: Validator = {
     "Steuer-ID",
   ] as const,
   candidatePattern: "\\d{2}\\s?\\d{3}\\s?\\d{3}\\s?\\d{3}",
+  scope: "country",
   country: "DE",
   entityType: "person",
   sourceUrl:

package/src/de/stnr.ts

@@ -26,13 +26,16 @@ const generate = (): string => {
  * @see https://de.wikipedia.org/wiki/Steuernummer
  */
 
+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";
-
 /**
  * Format patterns per federal state.
  * [0] = regional format, [1] = unified (federal) format.
@@ -194,12 +197,13 @@ const charCat = (ch: string): string => {
 };
 
 /** German Tax Number (Steuernummer). */
-const stnr: Validator = {
+const stnr: CountryValidator<"DE"> = {
   name: "German Tax Number",
   localName: "Steuernummer",
   abbreviation: "StNr",
   aliases: ["Steuernummer", "St.Nr."] as const,
   candidatePattern: "\\d{2,4}/\\d{3,4}/\\d{4,5}",
+  scope: "country",
   country: "DE",
   entityType: "any",
   description:

package/src/de/svnr.ts

@@ -9,6 +9,11 @@
  * @see https://de.wikipedia.org/wiki/Sozialversicherungsnummer
  */
 
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import { clean } from "#util/clean";
 import {
   isValidDate,
@@ -17,8 +22,6 @@ import {
 import { randomInt } from "#util/generate";
 import { err } from "#util/result";
 
-import type { ValidateResult, Validator } from "../types";
-
 const letterValue = (ch: string): number => {
   const code = ch.charCodeAt(0);
   if (code >= 65 && code <= 90) return code - 64;
@@ -137,7 +140,7 @@ const generate = (): string => {
 };
 
 /** German Social Insurance Number. */
-const svnr: Validator = {
+const svnr: CountryValidator<"DE"> = {
   name: "German Social Insurance Number",
   localName: "Sozialversicherungsnummer",
   abbreviation: "SVNR",
@@ -147,6 +150,7 @@ const svnr: Validator = {
     "Versicherungsnummer",
   ] as const,
   candidatePattern: "\\d{2}\\s?\\d{6}\\s?[A-Z]\\s?\\d{3}",
+  scope: "country",
   country: "DE",
   entityType: "person",
   description:

package/src/de/vat.ts

@@ -9,6 +9,11 @@
  * @see https://www.bzst.de/SharedDocs/Downloads/DE/Merkblaetter/ust_idnr_aufbau.pdf
  */
 
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import {
   mod1110checkDigit,
   mod1110validate,
@@ -18,8 +23,6 @@ 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 => {
   const v = clean(value, " -/");
   if (v.startsWith("DE") || v.startsWith("de")) {
@@ -70,7 +73,7 @@ const generate = (): string => {
 };
 
 /** German VAT Identification Number. */
-const vat: Validator = {
+const vat: CountryValidator<"DE"> = {
   name: "German VAT Number",
   localName: "Umsatzsteuer-Identifikationsnummer",
   abbreviation: "USt-IdNr.",
@@ -80,6 +83,7 @@ const vat: Validator = {
     "VAT DE",
   ] as const,
   candidatePattern: "DE\\d{9}",
+  scope: "country",
   country: "DE",
   entityType: "company",
   description:

package/src/dk/cpr.ts

@@ -8,18 +8,18 @@
  * @see https://cpr.dk/
  */
 
+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";
-
 const compact = (value: string): string =>
   clean(value, " -");
 
@@ -114,12 +114,13 @@ const generate = (): string => {
 };
 
 /** Danish Personal Identification Number. */
-const cpr: Validator<ParsedPersonId> = {
+const cpr: CountryValidator<"DK", ParsedPersonId> = {
   name: "Danish Personal ID",
   localName: "Det Centrale Personregister",
   abbreviation: "CPR",
   aliases: ["CPR-nummer", "personnummer", "CPR"] as const,
   candidatePattern: "\\d{6}-?\\d{4}",
+  scope: "country",
   country: "DK",
   entityType: "person",
   sourceUrl: "https://cpr.dk/",

package/src/dk/cvr.ts

@@ -13,14 +13,17 @@
  * for CVR.
  */
 
+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 = [2, 7, 6, 5, 4, 3, 2, 1];
 
 const compact = (value: string): string =>
@@ -67,12 +70,13 @@ const generate = (): string => {
 };
 
 /** Danish Central Business Register Number. */
-const cvr: Validator = {
+const cvr: CountryValidator<"DK"> = {
   name: "Danish Business Register Number",
   localName: "CVR-nummer",
   abbreviation: "CVR",
   aliases: ["CVR-nummer", "CVR"] as const,
   candidatePattern: "\\d{8}",
+  scope: "country",
   country: "DK",
   entityType: "company",
   sourceUrl: "https://erhvervsstyrelsen.dk/",