@stll/stdnum 0.0.1 → 2.0.0

package/src/pl/nip.ts

@@ -8,14 +8,17 @@
  * @see https://www.oecd.org/content/dam/oecd/en/topics/policy-issue-focus/aeoi/poland-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 = [6, 5, 7, 2, 3, 4, 5, 6, 7] as const;
 
 const compact = (value: string): string => {
@@ -73,7 +76,7 @@ const generate = (): string => {
 };
 
 /** Polish VAT Number. */
-const nip: Validator = {
+const nip: CountryValidator<"PL"> = {
   name: "Polish VAT Number",
   localName: "Numer Identyfikacji Podatkowej",
   abbreviation: "NIP",
@@ -82,6 +85,7 @@ const nip: Validator = {
     "numer identyfikacji podatkowej",
   ] as const,
   candidatePattern: "\\d{3}-?\\d{3}-?\\d{2}-?\\d{2}",
+  scope: "country",
   country: "PL",
   entityType: "company",
   sourceUrl: "https://www.biznes.gov.pl/en/portal/004124",

package/src/pl/pesel.ts

@@ -10,6 +10,12 @@
  * @see https://www.gov.pl/web/cyfryzacja/numer-pesel
  */
 
+import type {
+  ParsedPersonId,
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import { weightedSum } from "#checksums/weighted-sum";
 import { clean } from "#util/clean";
 import { isValidDate } from "#util/date";
@@ -17,12 +23,6 @@ import { randomDigits, randomInt } from "#util/generate";
 import { err } from "#util/result";
 import { isdigits } from "#util/strings";
 
-import type {
-  ParsedPersonId,
-  ValidateResult,
-  Validator,
-} from "../types";
-
 const WEIGHTS = [1, 3, 7, 9, 1, 3, 7, 9, 1, 3] as const;
 
 const compact = (value: string): string =>
@@ -131,13 +131,14 @@ const generate = (): string => {
 };
 
 /** Polish National Identification Number. */
-const pesel: Validator = {
+const pesel: CountryValidator<"PL", ParsedPersonId> = {
   name: "Polish National ID",
   localName:
     "Powszechny Elektroniczny System Ewidencji Ludności",
   abbreviation: "PESEL",
   aliases: ["PESEL"] as const,
   candidatePattern: "\\d{11}",
+  scope: "country",
   country: "PL",
   entityType: "person",
   sourceUrl:
@@ -145,6 +146,7 @@ const pesel: Validator = {
   examples: ["02070803628"] as const,
   compact,
   format,
+  parse,
   validate,
   generate,
 };

package/src/pl/regon.ts

@@ -9,14 +9,17 @@
  * @see https://bip.stat.gov.pl/en/regon/
  */
 
+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 = [8, 9, 2, 3, 4, 5, 6, 7] as const;
 const WEIGHTS_14 = [
   2, 4, 8, 5, 0, 9, 7, 3, 6, 1, 2, 4, 8,
@@ -78,12 +81,13 @@ const generate = (): string => {
 };
 
 /** Polish Statistical Identification Number. */
-const regon: Validator = {
+const regon: CountryValidator<"PL"> = {
   name: "Polish Business Register Number",
   localName: "Rejestr Gospodarki Narodowej",
   abbreviation: "REGON",
   aliases: ["REGON", "numer statystyczny"] as const,
   candidatePattern: "\\d{9,14}",
+  scope: "country",
   country: "PL",
   entityType: "company",
   sourceUrl: "https://bip.stat.gov.pl/en/regon/",

package/src/pt/cc.ts

@@ -8,12 +8,15 @@
  * @see https://pt.wikipedia.org/wiki/Cartão_de_cidadão
  */
 
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import { clean } from "#util/clean";
-import { randomDigits, randomInt } from "#util/generate";
+import { randomChar, randomDigits } from "#util/generate";
 import { err } from "#util/result";
 
-import type { ValidateResult, Validator } from "../types";
-
 const CC_RE = /^\d{9}[A-Z0-9]{2}\d$/;
 
 const ALPHABET = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ";
@@ -24,8 +27,10 @@ const compact = (value: string): string =>
 const calcCheckDigit = (value: string): string => {
   let sum = 0;
   for (let i = value.length - 1; i >= 0; i--) {
+    const ch = value[i];
+    if (ch === undefined) continue;
     const pos = value.length - 1 - i;
-    let n = ALPHABET.indexOf(value[i]!);
+    let n = ALPHABET.indexOf(ch);
     if (pos % 2 === 0) {
       n *= 2;
       if (n > 9) n = Math.floor(n / 10) + (n % 10);
@@ -70,15 +75,15 @@ const format = (value: string): string => {
 /** Generate a random valid Portuguese CC number. */
 const generate = (): string => {
   const digits = randomDigits(9);
-  const v0 = ALPHABET[randomInt(0, 35)]!;
-  const v1 = ALPHABET[randomInt(0, 35)]!;
+  const v0 = randomChar(ALPHABET);
+  const v1 = randomChar(ALPHABET);
   const body = digits + v0 + v1;
   const check = calcCheckDigit(body);
   return body + check;
 };
 
 /** Portuguese Identity Card number. */
-const cc: Validator = {
+const cc: CountryValidator<"PT"> = {
   name: "Portuguese Identity Card",
   localName: "Cartão de Cidadão",
   abbreviation: "CC",
@@ -88,6 +93,7 @@ const cc: Validator = {
     "número de identificação civil",
   ] as const,
   candidatePattern: "\\d{8}\\s?\\d\\s?[A-Z]{2}\\d",
+  scope: "country",
   country: "PT",
   entityType: "person",
   description:

package/src/pt/vat.ts

@@ -9,14 +9,17 @@
  * @see https://www.portaldasfinancas.gov.pt/
  */
 
+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, 8, 7, 6, 5, 4, 3, 2];
 
 const compact = (value: string): string => {
@@ -69,7 +72,7 @@ const generate = (): string => {
 };
 
 /** Portuguese VAT Number. */
-const vat: Validator = {
+const vat: CountryValidator<"PT"> = {
   name: "Portuguese VAT Number",
   localName: "Número de Identificação Fiscal",
   abbreviation: "NIF",
@@ -79,9 +82,11 @@ const vat: Validator = {
     "contribuinte",
   ] as const,
   candidatePattern: "PT\\d{9}",
+  scope: "country",
   country: "PT",
   entityType: "any",
   sourceUrl: "https://www.portaldasfinancas.gov.pt/",
+  lengths: [9] as const,
   examples: ["501964843"] as const,
   compact,
   format,

package/src/ro/cnp.ts

@@ -9,6 +9,12 @@
  * @see https://www.cnp.ro/
  */
 
+import type {
+  ParsedPersonId,
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import { weightedSum } from "#checksums/weighted-sum";
 import { clean } from "#util/clean";
 import { isValidDate } from "#util/date";
@@ -16,21 +22,20 @@ 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, 7, 9, 1, 4, 6, 3, 5, 8, 2, 7, 9,
 ] as const;
 
+// Counties 01-39 are the 39 modern judete; 40-46 are
+// Bucuresti sectors 1-6; 47-48 are the abolished
+// sectors 7-8; 51-52 are Calarasi/Giurgiu; 70 is "Any";
+// 80-83 are reserved. 49 and 50 are not allocated.
+// See https://github.com/vimishor/cnp-spec.
 const VALID_COUNTIES = new Set([
   1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17,
   18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31,
   32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45,
-  46, 47, 48, 49, 50, 51, 52, 70, 80, 81, 82, 83,
+  46, 47, 48, 51, 52, 70, 80, 81, 82, 83,
 ]);
 
 const centuryMap: Record<number, number> = {
@@ -150,19 +155,22 @@ const generate = (): string => {
 };
 
 /** Romanian Personal Identification Number. */
-const cnp: Validator = {
+const cnp: CountryValidator<"RO", ParsedPersonId> = {
   name: "Romanian Personal ID",
   localName: "Cod Numeric Personal",
   abbreviation: "CNP",
   aliases: ["CNP", "cod numeric personal"] as const,
   candidatePattern:
     "[1-8]\\d{2}(?:0[1-9]|1[0-2])(?:0[1-9]|[12]\\d|3[01])\\d{6}",
+  scope: "country",
   country: "RO",
   entityType: "person",
   sourceUrl: "https://www.cnp.ro/",
+  lengths: [13] as const,
   examples: ["1630615123457"] as const,
   compact,
   format,
+  parse,
   validate,
   generate,
 };

package/src/ro/vat.ts

@@ -9,14 +9,17 @@
  * @see https://www.anaf.ro/
  */
 
+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 = [7, 5, 3, 2, 1, 7, 5, 3, 2];
 
 const compact = (value: string): string => {
@@ -69,7 +72,7 @@ const generate = (): string => {
 };
 
 /** Romanian VAT Number. */
-const vat: Validator = {
+const vat: CountryValidator<"RO"> = {
   name: "Romanian VAT Number",
   localName: "Cod de Identificare Fiscală",
   abbreviation: "CIF",
@@ -80,9 +83,11 @@ const vat: Validator = {
     "cod fiscal",
   ] as const,
   candidatePattern: "RO\\d{2,10}",
+  scope: "country",
   country: "RO",
   entityType: "any",
   sourceUrl: "https://www.anaf.ro/",
+  lengths: [2, 3, 4, 5, 6, 7, 8, 9, 10] as const,
   examples: ["18547290"] as const,
   compact,
   format,

package/src/rs/pib.ts

@@ -8,13 +8,16 @@
  * @see https://www.purs.gov.rs/
  */
 
+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, " -");
 
@@ -62,12 +65,13 @@ const generate = (): string => {
 };
 
 /** Serbian Tax Identification Number. */
-const pib: Validator = {
+const pib: CountryValidator<"RS"> = {
   name: "Serbian Tax ID",
   localName: "Poreski identifikacioni broj",
   abbreviation: "PIB",
   aliases: ["PIB", "poreski identifikacioni broj"] as const,
   candidatePattern: "\\d{9}",
+  scope: "country",
   country: "RS",
   entityType: "any",
   lengths: [9] as const,

package/src/ru/inn.ts

@@ -10,13 +10,16 @@
  * @see https://www.nalog.gov.ru/
  */
 
+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_10 = [2, 4, 10, 3, 5, 9, 4, 6, 8] as const;
 const WEIGHTS_11 = [7, 2, 4, 10, 3, 5, 9, 4, 6, 8] as const;
 const WEIGHTS_12 = [
@@ -28,8 +31,8 @@ const checkDigit = (
   weights: readonly number[],
 ): number => {
   let sum = 0;
-  for (let i = 0; i < weights.length; i++) {
-    sum += Number(value[i]) * weights[i]!;
+  for (const [i, weight] of weights.entries()) {
+    sum += Number(value[i]) * weight;
   }
   return (sum % 11) % 10;
 };
@@ -88,12 +91,13 @@ const generate = (): string => {
 };
 
 /** Russian Taxpayer Identification Number. */
-const inn: Validator = {
+const inn: CountryValidator<"RU"> = {
   name: "Russian Tax ID",
   localName: "Идентификационный номер налогоплательщика",
   abbreviation: "ИНН",
   aliases: ["ИНН", "INN"] as const,
   candidatePattern: "\\d{10,12}",
+  scope: "country",
   country: "RU",
   entityType: "any",
   lengths: [10, 12] as const,

package/src/se/orgnr.ts

@@ -7,6 +7,11 @@
  * @see https://www.skatteverket.se/
  */
 
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import {
   luhnValidate,
   luhnChecksum,
@@ -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, " -");
 
@@ -57,7 +60,7 @@ const generate = (): string => {
 };
 
 /** Swedish Organization Number. */
-const orgnr: Validator = {
+const orgnr: CountryValidator<"SE"> = {
   name: "Swedish Organization Number",
   localName: "Organisationsnummer",
   abbreviation: "Orgnr",
@@ -67,6 +70,7 @@ const orgnr: Validator = {
     "org nr",
   ] as const,
   candidatePattern: "\\d{6}-\\d{4}",
+  scope: "country",
   country: "SE",
   entityType: "company",
   sourceUrl: "https://www.skatteverket.se/",

package/src/se/personnummer.ts

@@ -8,6 +8,12 @@
  * @see https://www.skatteverket.se/privat/folkbokforing/personnummer.4.3810a01c150939e893f18c29.html
  */
 
+import type {
+  ParsedPersonId,
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import {
   luhnValidate,
   luhnChecksum,
@@ -18,12 +24,6 @@ import { randomInt } from "#util/generate";
 import { err } from "#util/result";
 import { isdigits } from "#util/strings";
 
-import type {
-  ParsedPersonId,
-  ValidateResult,
-  Validator,
-} from "../types";
-
 /**
  * Match python-stdnum's compact: preserve the '-' or '+'
  * separator at position -5, and strip any others.
@@ -32,8 +32,8 @@ const compact = (value: string): string => {
   let v = clean(value, " :");
   if (
     (v.length === 10 || v.length === 12) &&
-    v[v.length - 5] !== "-" &&
-    v[v.length - 5] !== "+"
+    v.at(-5) !== "-" &&
+    v.at(-5) !== "+"
   ) {
     v = `${v.slice(0, -4)}-${v.slice(-4)}`;
   }
@@ -64,7 +64,7 @@ const getBirthDate = (
     let century = Math.floor(currentYear / 100);
     const yy = Number(v.slice(0, 2));
     if (yy > currentYear % 100) century -= 1;
-    if (v[v.length - 5] === "+") century -= 1;
+    if (v.at(-5) === "+") century -= 1;
     year = century * 100 + yy;
     month = Number(v.slice(2, 4));
     day = Number(v.slice(4, 6));
@@ -84,7 +84,7 @@ const validate = (value: string): ValidateResult => {
   }
 
   const digits = v.slice(0, -5) + v.slice(-4);
-  const sep = v[v.length - 5];
+  const sep = v.at(-5);
   if ((sep !== "-" && sep !== "+") || !isdigits(digits)) {
     return err(
       "INVALID_FORMAT",
@@ -123,7 +123,7 @@ const parse = (value: string): ParsedPersonId | null => {
   const birthDate = getBirthDate(v);
   if (birthDate === null) return null;
 
-  const genderDigit = Number(v[v.length - 2]);
+  const genderDigit = Number(v.at(-2));
 
   return {
     birthDate: new Date(
@@ -154,27 +154,30 @@ const generate = (): string => {
 };
 
 /** Swedish Personal Identity Number. */
-const personnummer: Validator = {
-  name: "Swedish Personal ID",
-  localName: "Personnummer",
-  abbreviation: "PN",
-  aliases: [
-    "personnummer",
-    "personnr",
-    "pers.nr",
-    "personal identity number",
-  ] as const,
-  candidatePattern: "\\d{6,8}-\\d{4}",
-  country: "SE",
-  entityType: "person",
-  sourceUrl:
-    "https://www.skatteverket.se/privat/folkbokforing/personnummer.4.3810a01c150939e893f18c29.html",
-  examples: ["880320-0016"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
+const personnummer: CountryValidator<"SE", ParsedPersonId> =
+  {
+    name: "Swedish Personal ID",
+    localName: "Personnummer",
+    abbreviation: "PN",
+    aliases: [
+      "personnummer",
+      "personnr",
+      "pers.nr",
+      "personal identity number",
+    ] as const,
+    candidatePattern: "\\d{6,8}-\\d{4}",
+    scope: "country",
+    country: "SE",
+    entityType: "person",
+    sourceUrl:
+      "https://www.skatteverket.se/privat/folkbokforing/personnummer.4.3810a01c150939e893f18c29.html",
+    examples: ["880320-0016"] as const,
+    compact,
+    format,
+    parse,
+    validate,
+    generate,
+  };
 
 export default personnummer;
 export { compact, format, parse, validate, generate };

package/src/se/vat.ts

@@ -8,6 +8,11 @@
  * @see https://www.skatteverket.se/
  */
 
+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 => {
   let v = clean(value, " -/.");
   if (v.startsWith("SE") || v.startsWith("se")) {
@@ -67,7 +70,7 @@ const generate = (): string => {
 };
 
 /** Swedish VAT Number. */
-const vat: Validator = {
+const vat: CountryValidator<"SE"> = {
   name: "Swedish VAT Number",
   localName: "Momsregistreringsnummer",
   abbreviation: "Momsnr.",
@@ -78,9 +81,11 @@ const vat: Validator = {
     "SE VAT",
   ] as const,
   candidatePattern: "SE\\s?\\d{10}01",
+  scope: "country",
   country: "SE",
   entityType: "company",
   sourceUrl: "https://www.skatteverket.se/",
+  lengths: [12] as const,
   examples: ["556188840401"] as const,
   compact,
   format,