@stll/stdnum 0.0.1 → 2.0.0

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,11 +59,15 @@ const generate = (length = 16): string => {
 };
 
 /** Generic Luhn Validator. */
-const luhn: Validator = {
+const luhn: GlobalValidator = {
+  scope: "global",
   name: "Luhn",
   localName: "Luhn",
   abbreviation: "Luhn",
+  aliases: ["Luhn", "Luhn algorithm", "mod 10"] as const,
+  candidatePattern: "\\d{2,}",
   entityType: "any",
+  sourceUrl: "https://en.wikipedia.org/wiki/Luhn_algorithm",
   examples: ["4111111111111111", "18"] as const,
   compact,
   format,

package/src/lv/vat.ts

@@ -1,22 +1,42 @@
 /**
  * PVN (Latvian VAT number).
  *
- * 11 digits. Legal entities (first digit > 3):
- * weights [9,1,4,8,3,10,2,5,7,6,1], sum % 11 === 3.
- * Personal (first digit <= 3): 11-digit format only.
+ * 11 digits.
  *
- * @see https://www.vatify.eu/latvia-vat-number.html
- * @see https://www.vid.gov.lv/en
+ * Individuals:
+ * - legacy personal codes: DDMMYY + century digit 0/1/2 + 4 digits
+ * - since 1 July 2017: codes start with 3, the second digit is 2-9,
+ *   and the remaining digits are random
+ *
+ * Entities:
+ * - tax administration issued: 9XXXXXXXXXX
+ * - enterprise register issued: 4XXXXXXXXXX / 5XXXXXXXXXX
+ *
+ * Canonical sources:
+ * - OECD Latvia TIN sheet for the tax-facing formats
+ * - PMLP page documenting the post-2017 personal code
+ *
+ * These are the reasons we accept the new personal
+ * code shape (`3` + second digit `2-9`) without the
+ * legacy birth-date checksum, and why we reject
+ * legacy personal codes with century digits outside
+ * 0/1/2.
+ *
+ * @see https://www.oecd.org/tax/automatic-exchange/crs-implementation-and-assistance/tax-identification-numbers/Latvia-TIN.pdf
+ * @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 => {
@@ -46,6 +66,9 @@ const validateBirthDate = (v: string): boolean => {
   const month = Number(v.slice(2, 4));
   const year2 = Number(v.slice(4, 6));
   const century = Number(v[6]);
+  if (century < 0 || century > 2) {
+    return false;
+  }
   const fullYear = 1800 + century * 100 + year2;
   const date = new Date(fullYear, month - 1, day);
   return (
@@ -69,9 +92,19 @@ const validate = (value: string): ValidateResult => {
       "Latvian VAT number must contain only digits",
     );
   }
-  const first = Number(v[0]);
-  // Legal entity: first digit > 3
-  if (first > 3) {
+  if (
+    v[0] === "3" &&
+    v[1] !== undefined &&
+    v[1] >= "2" &&
+    v[1] <= "9"
+  ) {
+    // Since 1 July 2017, new personal codes start with 3
+    // and are syntactic identifiers only.
+    return { valid: true, compact: v };
+  }
+
+  const first = v[0];
+  if (first === "4" || first === "5" || first === "9") {
     const sum = weightedSum(v, WEIGHTS, 11);
     if (sum !== 3) {
       return err(
@@ -79,15 +112,6 @@ const validate = (value: string): ValidateResult => {
         "Latvian VAT number check digit mismatch",
       );
     }
-  } else if (v.startsWith("32")) {
-    // New-format personal code (from July 2017),
-    // no birth date; checksum only
-    if (!checkPersonal(v)) {
-      return err(
-        "INVALID_CHECKSUM",
-        "Latvian personal code check digit mismatch",
-      );
-    }
   } else {
     // Old-format personal code: first 6 digits encode
     // birth date as DDMMYY, digit 7 encodes century
@@ -112,23 +136,29 @@ const format = (value: string): string =>
 
 /** Generate a random valid Latvian VAT number. */
 const generate = (): string => {
+  const entityPrefixes = ["4", "5", "9"] as const;
   for (;;) {
-    const c = String(randomInt(4, 9)) + randomDigits(10);
+    const c =
+      randomInt(0, 1) === 0
+        ? `3${randomInt(2, 9)}${randomDigits(9)}`
+        : `${entityPrefixes[randomInt(0, entityPrefixes.length - 1)] ?? "4"}${randomDigits(10)}`;
     if (validate(c).valid) return c;
   }
 };
 
 /** 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: "https://www.vid.gov.lv/en",
-  examples: ["40003521600"] as const,
+  sourceUrl:
+    "https://www.pmlp.gov.lv/en/change-personal-identity-number",
+  examples: ["40003521600", "32999999999"] as const,
   compact,
   format,
   validate,

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,