@stll/stdnum 1.0.0 → 2.0.0

package/src/fr/nir.ts

@@ -12,17 +12,17 @@
  * @see https://en.wikipedia.org/wiki/INSEE_code
  */
 
-import { clean } from "#util/clean";
-import { resolveTwoDigitYear } 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 { resolveTwoDigitYear } from "#util/date";
+import { randomInt } from "#util/generate";
+import { err } from "#util/result";
+
 const compact = (value: string): string =>
   clean(value, " -.");
 
@@ -165,7 +165,7 @@ const generate = (): string => {
 };
 
 /** French Social Security Number. */
-const nir: Validator<ParsedPersonId> = {
+const nir: CountryValidator<"FR", ParsedPersonId> = {
   name: "French Social Security Number",
   localName: "Numero d'Inscription au Repertoire",
   abbreviation: "NIR",
@@ -177,6 +177,7 @@ const nir: Validator<ParsedPersonId> = {
   ] as const,
   candidatePattern:
     "[12]\\s?\\d{2}\\s?\\d{2}\\s?\\d{2}\\s?\\d{3}\\s?\\d{3}\\s?\\d{2}",
+  scope: "country",
   country: "FR",
   entityType: "person",
   description:

package/src/fr/siren.ts

@@ -8,6 +8,11 @@
  * @see https://www.insee.fr/fr/information/2549588
  */
 
+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 compact = (value: string): string =>
   clean(value, " -.");
 
@@ -58,13 +61,14 @@ const generate = (): string => {
 };
 
 /** French Company Identification Number. */
-const siren: Validator = {
+const siren: CountryValidator<"FR"> = {
   name: "French Company ID",
   localName:
     "Système d'Identification du Répertoire des Entreprises",
   abbreviation: "SIREN",
   aliases: ["SIREN", "numéro SIREN"] as const,
   candidatePattern: "\\d{3}\\s?\\d{3}\\s?\\d{3}",
+  scope: "country",
   country: "FR",
   entityType: "company",
   sourceUrl: "https://www.insee.fr/fr/information/2549588",

package/src/fr/siret.ts

@@ -9,6 +9,11 @@
  * @see https://www.insee.fr/fr/information/2549588
  */
 
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import {
   luhnValidate,
   luhnChecksum,
@@ -18,8 +23,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, " -.");
 
@@ -101,13 +104,14 @@ const generate = (): string => {
 };
 
 /** French Establishment Identification Number. */
-const siret: Validator = {
+const siret: CountryValidator<"FR"> = {
   name: "French Establishment ID",
   localName:
     "Système d'Identification du Répertoire des Établissements",
   abbreviation: "SIRET",
   aliases: ["SIRET", "numéro SIRET"] as const,
   candidatePattern: "\\d{3}\\s?\\d{3}\\s?\\d{3}\\s?\\d{5}",
+  scope: "country",
   country: "FR",
   entityType: "company",
   sourceUrl: "https://www.insee.fr/fr/information/2549588",

package/src/fr/tva.ts

@@ -10,6 +10,11 @@
  * @see https://www.economie.gouv.fr/
  */
 
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import {
   luhnValidate,
   luhnChecksum,
@@ -19,8 +24,6 @@ import { randomDigits } from "#util/generate";
 import { err } from "#util/result";
 import { isdigits } from "#util/strings";
 
-import type { ValidateResult, Validator } from "../types";
-
 const ALPHABET = "0123456789ABCDEFGHJKLMNPQRSTUVWXYZ";
 
 const compact = (value: string): string => {
@@ -122,7 +125,7 @@ const generate = (): string => {
 };
 
 /** French VAT Number. */
-const tva: Validator = {
+const tva: CountryValidator<"FR"> = {
   name: "French VAT Number",
   localName: "Numéro de TVA intracommunautaire",
   abbreviation: "TVA",
@@ -132,6 +135,7 @@ const tva: Validator = {
     "FR VAT",
   ] as const,
   candidatePattern: "FR[A-Z0-9]{2}\\d{9}",
+  scope: "country",
   country: "FR",
   entityType: "company",
   sourceUrl: "https://www.economie.gouv.fr/",

package/src/gb/nino.ts

@@ -28,12 +28,15 @@ const generate = (): string => {
  * @see https://www.gov.uk/hmrc-internal-manuals/national-insurance-manual/nim39110
  */
 
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import { clean } from "#util/clean";
 import { randomChar, randomDigits } from "#util/generate";
 import { err } from "#util/result";
 
-import type { ValidateResult, Validator } from "../types";
-
 const INVALID_FIRST = new Set([
   "D",
   "F",
@@ -124,7 +127,7 @@ const format = (value: string): string => {
 };
 
 /** UK National Insurance Number. */
-const nino: Validator = {
+const nino: CountryValidator<"GB"> = {
   name: "UK National Insurance Number",
   localName: "National Insurance Number",
   abbreviation: "NINO",
@@ -134,6 +137,7 @@ const nino: Validator = {
     "NI number",
   ] as const,
   candidatePattern: "[A-Z]{2}\\d{6}[A-Z]",
+  scope: "country",
   country: "GB",
   entityType: "person",
   description:

package/src/gb/sedol.ts

@@ -10,13 +10,16 @@
  * @see https://en.wikipedia.org/wiki/SEDOL
  */
 
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import { clean } from "#util/clean";
 import { randomChar } from "#util/generate";
 import { err } from "#util/result";
 import { isdigits } from "#util/strings";
 
-import type { ValidateResult, Validator } from "../types";
-
 /**
  * Allowed characters in a SEDOL: digits and
  * consonants only (vowels are never used).
@@ -109,7 +112,7 @@ const generate = (): string => {
 };
 
 /** Stock Exchange Daily Official List number. */
-const sedol: Validator = {
+const sedol: CountryValidator<"GB"> = {
   name: "Stock Exchange Daily Official List number",
   localName: "Stock Exchange Daily Official List number",
   abbreviation: "SEDOL",
@@ -118,6 +121,7 @@ const sedol: Validator = {
     "Stock Exchange Daily Official List",
   ] as const,
   candidatePattern: "[B-DF-HJ-NP-TV-Z0-9]{6}\\d",
+  scope: "country",
   country: "GB",
   entityType: "any",
   sourceUrl: "https://en.wikipedia.org/wiki/SEDOL",

package/src/gb/utr.ts

@@ -8,14 +8,17 @@
  * @see https://www.gov.uk/find-utr-number
  */
 
+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 = [6, 7, 8, 9, 10, 5, 4, 3, 2] as const;
 const CHECK_LOOKUP = "21987654321";
 
@@ -61,12 +64,13 @@ const generate = (): string => {
 };
 
 /** UK Unique Taxpayer Reference. */
-const utr: Validator = {
+const utr: CountryValidator<"GB"> = {
   name: "UK Unique Taxpayer Reference",
   localName: "Unique Taxpayer Reference",
   abbreviation: "UTR",
   aliases: ["Unique Taxpayer Reference", "UTR"] as const,
   candidatePattern: "\\d{10}",
+  scope: "country",
   country: "GB",
   entityType: "any",
   sourceUrl: "https://www.gov.uk/find-utr-number",

package/src/gb/vat.ts

@@ -9,14 +9,17 @@
  * @see https://www.gov.uk/vat-registration
  */
 
+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 => {
@@ -135,7 +138,7 @@ const generate = (): string => {
 };
 
 /** UK VAT Registration Number. */
-const vat: Validator = {
+const vat: CountryValidator<"GB"> = {
   name: "UK VAT Number",
   localName: "VAT Registration Number",
   abbreviation: "VAT",
@@ -144,6 +147,7 @@ const vat: Validator = {
     "VAT number",
   ] as const,
   candidatePattern: "GB\\d{9,12}",
+  scope: "country",
   country: "GB",
   entityType: "company",
   sourceUrl: "https://www.gov.uk/vat-registration",

package/src/ge/pin.ts

@@ -14,13 +14,16 @@ const generate = (): string => randomDigits(11);
  * @see https://www.oecd.org/tax/automatic-exchange/crs-implementation-and-assistance/tax-identification-numbers/Georgia-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 =>
   clean(value, " -").trim();
 
@@ -47,12 +50,13 @@ const validate = (value: string): ValidateResult => {
 const format = (value: string): string => compact(value);
 
 /** Georgian Personal Identification Number. */
-const pin: Validator = {
+const pin: CountryValidator<"GE"> = {
   name: "Georgian Personal ID",
   localName: "პირადი ნომერი",
   abbreviation: "PIN",
   aliases: ["პირადი ნომერი", "PIN"] as const,
   candidatePattern: "\\d{11}",
+  scope: "country",
   country: "GE",
   entityType: "any",
   lengths: [9, 11] as const,

package/src/gh/tin.ts

@@ -14,12 +14,15 @@
  * @see https://gra.gov.gh/
  */
 
+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 FORMAT_RE = /^[PCGQV]00[0-9]{7}[0-9X]$/;
 
 const compact = (value: string): string =>
@@ -79,12 +82,13 @@ const generate = (): string => {
 };
 
 /** Ghanaian Tax Identification Number. */
-const tin: Validator = {
+const tin: CountryValidator<"GH"> = {
   name: "Ghanaian Tax Identification Number",
   localName: "Tax Identification Number",
   abbreviation: "TIN",
   aliases: ["TIN", "Tax Identification Number"] as const,
   candidatePattern: "[A-Z]\\d{9,10}",
+  scope: "country",
   country: "GH",
   entityType: "any",
   compact,

package/src/gr/amka.ts

@@ -8,6 +8,11 @@
  * @see https://www.amka.gr/
  */
 
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import {
   luhnValidate,
   luhnChecksum,
@@ -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 =>
   clean(value, " -");
 
@@ -80,7 +83,7 @@ const generate = (): string => {
 };
 
 /** Greek Social Security Number. */
-const amka: Validator = {
+const amka: CountryValidator<"GR"> = {
   name: "Greek Social Security Number",
   localName: "Αριθμός Μητρώου Κοινωνικής Ασφάλισης",
   abbreviation: "ΑΜΚΑ",
@@ -90,6 +93,7 @@ const amka: Validator = {
     "AMKA",
   ] as const,
   candidatePattern: "\\d{11}",
+  scope: "country",
   country: "GR",
   entityType: "person",
   sourceUrl: "https://www.amka.gr/",

package/src/gr/vat.ts

@@ -9,13 +9,16 @@
  * @see https://www.aade.gr/
  */
 
+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("EL") || v.startsWith("el")) {
@@ -72,7 +75,7 @@ const generate = (): string => {
 };
 
 /** Greek VAT Number. */
-const vat: Validator = {
+const vat: CountryValidator<"GR"> = {
   name: "Greek VAT Number",
   localName: "Αριθμός Φορολογικού Μητρώου",
   abbreviation: "ΑΦΜ",
@@ -82,6 +85,7 @@ const vat: Validator = {
     "AFM",
   ] as const,
   candidatePattern: "EL\\d{9}",
+  scope: "country",
   country: "GR",
   entityType: "any",
   sourceUrl: "https://www.aade.gr/",

package/src/gt/nit.ts

@@ -11,13 +11,16 @@
  * @see https://portal.sat.gob.gt/portal/
  */
 
+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";
-
 /**
  * Compact: strip spaces, hyphens, leading zeros,
  * and uppercase.
@@ -97,12 +100,13 @@ const generate = (): string => {
 };
 
 /** Guatemala tax identification number. */
-const nit: Validator = {
+const nit: CountryValidator<"GT"> = {
   name: "Tax Identification Number",
   localName: "Número de Identificación Tributaria",
   abbreviation: "NIT",
   aliases: ["NIT"] as const,
   candidatePattern: "\\d{7,8}-?\\d",
+  scope: "country",
   country: "GT",
   entityType: "any",
   description: "Tax identifier issued by Guatemala's SAT",

package/src/hk/hkid.ts

@@ -9,12 +9,15 @@
  * @see https://en.wikipedia.org/wiki/Hong_Kong_identity_card
  */
 
+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";
-
 /** Strip spaces, parentheses, and dashes. */
 const compact = (value: string): string =>
   clean(value, " -()").toUpperCase();
@@ -106,12 +109,13 @@ const generate = (): string => {
 };
 
 /** Hong Kong Identity Card number. */
-const hkid: Validator = {
+const hkid: CountryValidator<"HK"> = {
   name: "Hong Kong Identity Card Number",
   localName: "Hong Kong Identity Card Number",
   abbreviation: "HKID",
   aliases: ["HKID", "香港身份證"] as const,
   candidatePattern: "[A-Z]{1,2}\\d{6}[\\dA]",
+  scope: "country",
   country: "HK",
   entityType: "person",
   lengths: [8, 9],

package/src/hr/vat.ts

@@ -7,6 +7,11 @@
  * @see https://www.porezna-uprava.hr/
  */
 
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import {
   mod1110validate,
   mod1110checkDigit,
@@ -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 => {
   let v = clean(value, " -/.");
   if (v.startsWith("HR") || v.startsWith("hr")) {
@@ -59,12 +62,13 @@ const generate = (): string => {
 };
 
 /** Croatian VAT Number. */
-const vat: Validator = {
+const vat: CountryValidator<"HR"> = {
   name: "Croatian VAT Number",
   localName: "Osobni identifikacijski broj",
   abbreviation: "OIB",
   aliases: ["OIB", "osobni identifikacijski broj"] as const,
   candidatePattern: "HR\\d{11}",
+  scope: "country",
   country: "HR",
   entityType: "any",
   sourceUrl: "https://www.porezna-uprava.hr/",

package/src/hu/vat.ts

@@ -8,14 +8,17 @@
  * @see https://www.oecd.org/content/dam/oecd/en/topics/policy-issue-focus/aeoi/hungary-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 WEIGHTS = [9, 7, 3, 1, 9, 7, 3, 1];
 
 const compact = (value: string): string => {
@@ -62,15 +65,17 @@ const generate = (): string => {
 };
 
 /** Hungarian VAT Number. */
-const vat: Validator = {
+const vat: CountryValidator<"HU"> = {
   name: "Hungarian VAT Number",
   localName: "Adószám",
   abbreviation: "ANUM",
   aliases: ["adószám", "adóazonosító jel"] as const,
   candidatePattern: "\\d{8}-\\d-\\d{2}",
+  scope: "country",
   country: "HU",
   entityType: "company",
   sourceUrl: "https://nav.gov.hu/",
+  lengths: [8] as const,
   examples: ["12892312"] as const,
   compact,
   format,

package/src/iban.ts

@@ -6,14 +6,17 @@
  * characters. Validated using ISO 7064 Mod 97-10.
  */
 
+import type {
+  ValidateResult,
+  GlobalValidator,
+} from "./types";
+
 import { mod97 } from "#checksums/mod97";
 import { clean } from "#util/clean";
 import { randomDigits, randomInt } from "#util/generate";
 import { err } from "#util/result";
 import { charValue, isalnum } from "#util/strings";
 
-import type { ValidateResult, Validator } from "./types";
-
 /**
  * BBAN format regex by country code.
  * Sourced from SWIFT IBAN Registry.
@@ -314,7 +317,8 @@ const generate = (): string => {
 };
 
 /** International Bank Account Number. */
-const iban: Validator = {
+const iban: GlobalValidator = {
+  scope: "global",
   name: "IBAN",
   localName: "IBAN",
   abbreviation: "IBAN",

package/src/id/npwp.ts

@@ -10,6 +10,11 @@
  * @see https://www.oecd.org/tax/automatic-exchange/crs-implementation-and-assistance/tax-identification-numbers/Indonesia-TIN.pdf
  */
 
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import {
   luhnValidate,
   luhnChecksum,
@@ -20,8 +25,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, " .-");
 
@@ -160,13 +163,14 @@ const generate = (): string => {
 };
 
 /** Indonesian Taxpayer Identification Number. */
-const npwp: Validator = {
+const npwp: CountryValidator<"ID"> = {
   name: "Indonesian Taxpayer Identification Number",
   localName: "Nomor Pokok Wajib Pajak",
   abbreviation: "NPWP",
   aliases: ["NPWP", "Nomor Pokok Wajib Pajak"] as const,
   candidatePattern:
     "\\d{2}\\.?\\d{3}\\.?\\d{3}\\.?\\d-?\\d{3}\\.?\\d{3}",
+  scope: "country",
   country: "ID",
   entityType: "any",
   lengths: [15, 16],

package/src/ie/pps.ts

@@ -9,13 +9,16 @@
  * @see https://www.gov.ie/en/service/12e6de-get-a-personal-public-service-pps-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 ALPHABET = "WABCDEFGHIJKLMNOPQRSTUV";
 
 const compact = (value: string): string =>
@@ -84,12 +87,13 @@ const generate = (): string => {
 };
 
 /** Irish Personal Public Service Number. */
-const pps: Validator = {
+const pps: CountryValidator<"IE"> = {
   name: "Irish Personal ID",
   localName: "Personal Public Service Number",
   abbreviation: "PPS",
   aliases: ["PPS number", "PPSN", "RSI number"] as const,
   candidatePattern: "\\d{7}[A-Z]{1,2}",
+  scope: "country",
   country: "IE",
   entityType: "person",
   sourceUrl: