@stll/stdnum 1.0.0 → 2.0.0

package/src/be/bis.ts

@@ -10,14 +10,17 @@
  * @see https://nl.wikipedia.org/wiki/Rijksregisternummer
  */
 
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+import { checksum, format as nnFormat } from "./nn";
+
 import { clean } from "#util/clean";
 import { randomInt } from "#util/generate";
 import { err } from "#util/result";
 import { isdigits } from "#util/strings";
 
-import type { ValidateResult, Validator } from "../types";
-import { checksum, format as nnFormat } from "./nn";
-
 const compact = (value: string): string =>
   clean(value, " .-");
 
@@ -83,13 +86,14 @@ const generate = (): string => {
 };
 
 /** Belgian BIS Number. */
-const bis: Validator = {
+const bis: CountryValidator<"BE"> = {
   name: "Belgian BIS Number",
   localName: "BIS-nummer",
   abbreviation: "BIS",
   aliases: ["BIS-nummer", "numéro BIS"] as const,
   candidatePattern:
     "\\d{2}\\.?\\d{2}\\.?\\d{2}-?\\d{3}\\.?\\d{2}",
+  scope: "country",
   country: "BE",
   entityType: "person",
   sourceUrl:

package/src/be/nn.ts

@@ -10,13 +10,16 @@
  * @see https://www.ibz.rrn.fgov.be/
  */
 
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import { clean } from "#util/clean";
 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, " .-");
 
@@ -100,7 +103,7 @@ const generate = (): string => {
 };
 
 /** Belgian National Number. */
-const nn: Validator = {
+const nn: CountryValidator<"BE"> = {
   name: "Belgian National Number",
   localName: "Numéro national",
   abbreviation: "NN",
@@ -111,6 +114,7 @@ const nn: Validator = {
   ] as const,
   candidatePattern:
     "\\d{2}\\.?\\d{2}\\.?\\d{2}-?\\d{3}\\.?\\d{2}",
+  scope: "country",
   country: "BE",
   entityType: "person",
   sourceUrl: "https://www.ibz.rrn.fgov.be/",

package/src/be/vat.ts

@@ -8,13 +8,16 @@
  * @see https://www.oecd.org/content/dam/oecd/en/topics/policy-issue-focus/aeoi/belgium-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("BE") || v.startsWith("be")) {
@@ -82,7 +85,7 @@ const generate = (): string => {
 };
 
 /** Belgian VAT Number. */
-const vat: Validator = {
+const vat: CountryValidator<"BE"> = {
   name: "Belgian VAT Number",
   localName: "BTW-identificatienummer",
   abbreviation: "BTW",
@@ -93,6 +96,7 @@ const vat: Validator = {
     "ondernemingsnummer",
   ] as const,
   candidatePattern: "BE0?\\d{9,10}",
+  scope: "country",
   country: "BE",
   entityType: "company",
   sourceUrl: "https://finances.belgium.be/",

package/src/bg/egn.ts

@@ -15,6 +15,12 @@
  * @see https://www.grao.bg/normact/NaredbaFunkcESGR.pdf
  */
 
+import type {
+  ParsedPersonId,
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import { weightedSum } from "#checksums/weighted-sum";
 import { clean } from "#util/clean";
 import { isValidDate } from "#util/date";
@@ -22,12 +28,6 @@ import { randomInt } from "#util/generate";
 import { err } from "#util/result";
 import { isdigits } from "#util/strings";
 
-import type {
-  ParsedPersonId,
-  ValidateResult,
-  Validator,
-} from "../types";
-
 const WEIGHTS = [2, 4, 8, 5, 10, 9, 7, 3, 6] as const;
 
 const compact = (value: string): string =>
@@ -137,7 +137,7 @@ const generate = (): string => {
 };
 
 /** Bulgarian Personal Identification Number. */
-const egn: Validator<ParsedPersonId> = {
+const egn: CountryValidator<"BG", ParsedPersonId> = {
   name: "Bulgarian Personal ID",
   localName: "Единен граждански номер",
   abbreviation: "ЕГН",
@@ -147,6 +147,7 @@ const egn: Validator<ParsedPersonId> = {
     "EGN",
   ] as const,
   candidatePattern: "\\d{10}",
+  scope: "country",
   country: "BG",
   entityType: "person",
   sourceUrl:

package/src/bg/pnf.ts

@@ -7,13 +7,16 @@
  * @see https://en.wikipedia.org/wiki/Unique_citizenship_number
  */
 
+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 = [21, 19, 17, 13, 11, 9, 7, 3, 1] as const;
 
 const compact = (value: string): string =>
@@ -61,7 +64,7 @@ const generate = (): string => {
 };
 
 /** Bulgarian Personal Number of a Foreigner. */
-const pnf: Validator = {
+const pnf: CountryValidator<"BG"> = {
   name: "Bulgarian Foreigner Number",
   localName: "Личен номер на чужденец",
   abbreviation: "ЛНЧ",
@@ -71,6 +74,7 @@ const pnf: Validator = {
     "PNF",
   ] as const,
   candidatePattern: "\\d{10}",
+  scope: "country",
   country: "BG",
   entityType: "person",
   sourceUrl:

package/src/bg/vat.ts

@@ -7,14 +7,17 @@
  * @see https://www.oecd.org/content/dam/oecd/en/topics/policy-issue-focus/aeoi/bulgaria-tin.pdf
  */
 
+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 compact = (value: string): string => {
   let v = clean(value, " -/.");
   if (v.startsWith("BG") || v.startsWith("bg")) {
@@ -132,7 +135,7 @@ const generate = (): string => {
 };
 
 /** Bulgarian VAT Number. */
-const vat: Validator = {
+const vat: CountryValidator<"BG"> = {
   name: "Bulgarian VAT Number",
   localName: "ИН по ДДС",
   abbreviation: "ИН по ДДС",
@@ -141,9 +144,11 @@ const vat: Validator = {
     "идентификационен номер по ДДС",
   ] as const,
   candidatePattern: "BG\\d{9,10}",
+  scope: "country",
   country: "BG",
   entityType: "any",
   sourceUrl: "https://www.nra.bg/",
+  lengths: [9, 10] as const,
   examples: ["175074752"] as const,
   compact,
   format,

package/src/bh/cpr.ts

@@ -16,13 +16,16 @@
  * @see https://www.bahrain.bh/wps/portal/IDInfo_en
  */
 
+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, " -");
 
@@ -68,12 +71,13 @@ const generate = (): string => {
 };
 
 /** Bahrain Central Population Registration number. */
-const cpr: Validator = {
+const cpr: CountryValidator<"BH"> = {
   name: "Central Population Registration Number",
   localName: "الرقم السكاني",
   abbreviation: "CPR",
   aliases: ["CPR", "الرقم السكاني"] as const,
   candidatePattern: "\\d{9}",
+  scope: "country",
   country: "BH",
   entityType: "person",
   lengths: [9] as const,

package/src/bic.ts

@@ -36,6 +36,11 @@ const generate = (): string => {
  * @see https://www.swift.com/
  */
 
+import type {
+  ValidateResult,
+  GlobalValidator,
+} from "./types";
+
 import { clean } from "#util/clean";
 import {
   randomChar,
@@ -44,8 +49,6 @@ import {
 } from "#util/generate";
 import { err } from "#util/result";
 
-import type { ValidateResult, Validator } from "./types";
-
 const BIC_RE =
   /^[A-Z]{4}[A-Z]{2}[0-9A-Z]{2}([0-9A-Z]{3})?$/;
 
@@ -82,7 +85,8 @@ const format = (value: string): string => {
 };
 
 /** Business Identifier Code (SWIFT/BIC). */
-const bic: Validator = {
+const bic: GlobalValidator = {
+  scope: "global",
   name: "Business Identifier Code",
   localName: "Business Identifier Code",
   abbreviation: "BIC",

package/src/br/cnpj.ts

@@ -19,12 +19,15 @@
  * @see https://en.wikipedia.org/wiki/CNPJ
  */
 
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import { clean } from "#util/clean";
 import { randomDigits } from "#util/generate";
 import { err } from "#util/result";
 
-import type { ValidateResult, Validator } from "../types";
-
 const CNPJ_RE = /^[\dA-Z]+$/;
 
 const compact = (value: string): string =>
@@ -128,7 +131,7 @@ const generate = (): string => {
  * - Petrobras: 33.000.167/0001-01
  * - Banco do Brasil: 00.000.000/0001-91
  */
-const cnpj: Validator = {
+const cnpj: CountryValidator<"BR"> = {
   name: "Brazilian CNPJ",
   localName: "Cadastro Nacional da Pessoa Jurídica",
   abbreviation: "CNPJ",
@@ -138,6 +141,7 @@ const cnpj: Validator = {
   ] as const,
   candidatePattern:
     "\\d{2}\\.?\\d{3}\\.?\\d{3}/?\\d{4}-?\\d{2}",
+  scope: "country",
   country: "BR",
   entityType: "company",
   sourceUrl: "https://www.gov.br/receitafederal/",

package/src/br/cpf.ts

@@ -13,13 +13,16 @@
  * @see https://en.wikipedia.org/wiki/CPF_number
  */
 
+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 =>
   clean(value, " -.").trim();
 
@@ -94,12 +97,13 @@ const generate = (): string => {
 };
 
 /** Brazilian CPF (personal tax ID). */
-const cpf: Validator = {
+const cpf: CountryValidator<"BR"> = {
   name: "Brazilian CPF",
   localName: "Cadastro de Pessoas Físicas",
   abbreviation: "CPF",
   aliases: ["CPF", "Cadastro de Pessoas Físicas"] as const,
   candidatePattern: "\\d{3}\\.?\\d{3}\\.?\\d{3}-?\\d{2}",
+  scope: "country",
   country: "BR",
   entityType: "person",
   sourceUrl: "https://www.gov.br/receitafederal/",

package/src/by/unp.ts

@@ -11,13 +11,16 @@
  * @see https://www.nalog.gov.by/
  */
 
+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";
-
 /** Cyrillic to Latin mapping for the letter positions. */
 const CYRILLIC_TO_LATIN: Record<string, string> = {
   А: "A",
@@ -44,7 +47,8 @@ const compact = (value: string): string => {
   } else if (v.startsWith("UNP")) {
     v = v.slice(3);
   }
-  return [...v]
+  return v
+    .split("")
     .map((ch) => CYRILLIC_TO_LATIN[ch] ?? ch)
     .join("");
 };
@@ -88,7 +92,7 @@ const validate = (value: string): ValidateResult => {
   const first2 = v.slice(0, 2);
   if (
     !isdigits(first2) &&
-    ![...first2].every((ch) => ALPHA_SET.includes(ch))
+    !first2.split("").every((ch) => ALPHA_SET.includes(ch))
   ) {
     return err(
       "INVALID_FORMAT",
@@ -138,12 +142,13 @@ const generate = (): string => {
 };
 
 /** Belarus UNP (Учётный номер плательщика). */
-const unp: Validator = {
+const unp: CountryValidator<"BY"> = {
   name: "Belarus Tax Number",
   localName: "Учётный номер плательщика",
   abbreviation: "УНП",
   aliases: ["УНП", "UNP"] as const,
   candidatePattern: "\\d{9}",
+  scope: "country",
   country: "BY",
   entityType: "any",
   sourceUrl: "https://www.nalog.gov.by/",

package/src/bz/tin.ts

@@ -25,12 +25,15 @@
  * @see https://www.oecd.org/tax/automatic-exchange/crs-implementation-and-assistance/tax-identification-numbers/Belize-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";
-
 /** Valid 2-digit suffix codes. */
 const SUFFIX_CODES = ["10", "13", "66"] as const;
 
@@ -94,12 +97,13 @@ const generate = (): string => {
  *
  * Examples derived from stdnum-js test suite.
  */
-const tin: Validator = {
+const tin: CountryValidator<"BZ"> = {
   name: "Belize Tax Identification Number",
   localName: "Tax Identification Number",
   abbreviation: "TIN",
   aliases: ["TIN"] as const,
   candidatePattern: "\\d{6}",
+  scope: "country",
   country: "BZ",
   entityType: "any",
   lengths: [6, 8] as const,

package/src/ca/bn.ts

@@ -8,6 +8,11 @@
  * @see https://www.canada.ca/en/services/taxes/business-number.html
  */
 
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import {
   luhnValidate,
   luhnChecksum,
@@ -17,8 +22,6 @@ import { randomDigits } from "#util/generate";
 import { err } from "#util/result";
 import { isdigits } from "#util/strings";
 
-import type { ValidateResult, Validator } from "../types";
-
 const VALID_PROGRAMS = new Set(["RC", "RM", "RP", "RT"]);
 
 const compact = (value: string): string =>
@@ -82,7 +85,7 @@ const generate = (): string => {
 };
 
 /** Canadian Business Number. */
-const bn: Validator = {
+const bn: CountryValidator<"CA"> = {
   name: "Business Number",
   localName: "Business Number",
   abbreviation: "BN",
@@ -92,6 +95,7 @@ const bn: Validator = {
     "numéro d'entreprise",
   ] as const,
   candidatePattern: "\\d{9}\\s?[A-Z]{2}\\s?\\d{4}",
+  scope: "country",
   country: "CA",
   entityType: "company",
   sourceUrl:

package/src/ca/sin.ts

@@ -8,6 +8,11 @@
  * @see https://en.wikipedia.org/wiki/Social_Insurance_Number
  */
 
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import {
   luhnValidate,
   luhnChecksum,
@@ -17,8 +22,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 =>
   clean(value, " -");
 
@@ -66,7 +69,7 @@ const generate = (): string => {
 };
 
 /** Canadian Social Insurance Number. */
-const sin: Validator = {
+const sin: CountryValidator<"CA"> = {
   name: "Social Insurance Number",
   localName: "Social Insurance Number",
   abbreviation: "SIN",
@@ -76,6 +79,7 @@ const sin: Validator = {
     "NAS",
   ] as const,
   candidatePattern: "\\d{3}-?\\d{3}-?\\d{3}",
+  scope: "country",
   country: "CA",
   entityType: "person",
   sourceUrl:

package/src/ch/ssn.ts

@@ -8,13 +8,16 @@
  * @see https://www.bsv.admin.ch/
  */
 
+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 =>
   clean(value, " -.");
 
@@ -70,7 +73,7 @@ const generate = (): string => {
 };
 
 /** Swiss Social Security Number. */
-const ssn: Validator = {
+const ssn: CountryValidator<"CH"> = {
   name: "Swiss Social Security Number",
   localName: "AHV-Versichertennummer",
   abbreviation: "AHV",
@@ -81,6 +84,7 @@ const ssn: Validator = {
     "AHV",
   ] as const,
   candidatePattern: "756\\.?\\d{4}\\.?\\d{4}\\.?\\d{2}",
+  scope: "country",
   country: "CH",
   entityType: "person",
   sourceUrl: "https://www.bsv.admin.ch/",

package/src/ch/uid.ts

@@ -8,13 +8,16 @@
  * @see https://www.uid.admin.ch/
  */
 
+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 = [5, 4, 3, 2, 7, 6, 5, 4] as const;
 
 const compact = (value: string): string =>
@@ -84,7 +87,7 @@ const generate = (): string => {
 };
 
 /** Swiss Business Identification Number. */
-const uid: Validator = {
+const uid: CountryValidator<"CH"> = {
   name: "Swiss Business ID",
   localName: "Unternehmens-Identifikationsnummer",
   abbreviation: "UID",
@@ -94,6 +97,7 @@ const uid: Validator = {
     "IDE",
   ] as const,
   candidatePattern: "CHE-?\\d{3}\\.?\\d{3}\\.?\\d{3}",
+  scope: "country",
   country: "CH",
   entityType: "company",
   sourceUrl: "https://www.uid.admin.ch/",

package/src/ch/vat.ts

@@ -8,15 +8,18 @@
  * @see https://www.estv.admin.ch/
  */
 
-import { clean } from "#util/clean";
-import { err } from "#util/result";
-
-import type { ValidateResult, Validator } from "../types";
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
 import {
   validate as validateUid,
   generate as generateUid,
 } from "./uid";
 
+import { clean } from "#util/clean";
+import { err } from "#util/result";
+
 const SUFFIXES = ["MWST", "TVA", "IVA", "TPV"] as const;
 
 const compact = (value: string): string =>
@@ -64,13 +67,14 @@ const format = (value: string): string => {
 const generate = (): string => generateUid() + "MWST";
 
 /** Swiss VAT Number. */
-const vat: Validator = {
+const vat: CountryValidator<"CH"> = {
   name: "Swiss VAT Number",
   localName: "Mehrwertsteuernummer",
   abbreviation: "MWST",
   aliases: ["MWST", "TVA", "IVA"] as const,
   candidatePattern:
     "CHE-?\\d{3}\\.?\\d{3}\\.?\\d{3}\\s?(?:MWST|TVA|IVA)",
+  scope: "country",
   country: "CH",
   entityType: "company",
   sourceUrl: "https://www.estv.admin.ch/",

package/src/cl/rut.ts

@@ -13,12 +13,15 @@
  * @see https://en.wikipedia.org/wiki/Rol_%C3%9Anico_Tributario
  */
 
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import { clean } from "#util/clean";
 import { randomDigits } from "#util/generate";
 import { err } from "#util/result";
 
-import type { ValidateResult, Validator } from "../types";
-
 const RUT_RE = /^\d{7,8}[\dK]$/;
 
 const compact = (value: string): string => {
@@ -99,12 +102,13 @@ const generate = (): string => {
  * Examples sourced from python-stdnum test suite
  * (cl.rut module).
  */
-const rut: Validator = {
+const rut: CountryValidator<"CL"> = {
   name: "Chilean Tax ID",
   localName: "Rol Único Tributario",
   abbreviation: "RUT",
   aliases: ["RUT", "Rol Único Tributario"] as const,
   candidatePattern: "\\d{1,2}\\.?\\d{3}\\.?\\d{3}-?[\\dkK]",
+  scope: "country",
   country: "CL",
   entityType: "any",
   compact,