@stll/stdnum 2.1.0 → 2.1.2

package/src/bh/cpr.ts

@@ -1,94 +0,0 @@
-/**
- * CPR (Central Population Registration number, Bahrain).
- *
- * 9-digit personal identification number:
- *   YYMM  = year and month of birth
- *   NNNN  = serial number
- *   C     = check digit
- *
- * The check digit algorithm is not publicly
- * documented; validation is structural only
- * (length, digits, and valid birth month).
- *
- * Note: a minority of older CPR numbers do not
- * follow the YYMMNNNNC format.
- *
- * @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";
-
-const compact = (value: string): string =>
-  clean(value, " -");
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-
-  if (v.length !== 9) {
-    return err(
-      "INVALID_LENGTH",
-      "Bahrain CPR must be 9 digits",
-    );
-  }
-
-  if (!isdigits(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "Bahrain CPR must contain only digits",
-    );
-  }
-
-  // Validate birth month (digits 3-4) is 01-12
-  const mm = Number(v.slice(2, 4));
-  if (mm < 1 || mm > 12) {
-    return err(
-      "INVALID_COMPONENT",
-      "CPR birth month must be 01-12",
-    );
-  }
-
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => {
-  const v = compact(value);
-  return `${v.slice(0, 2)}-${v.slice(2, 4)}-${v.slice(4)}`;
-};
-
-/** Generate a random structurally valid Bahrain CPR. */
-const generate = (): string => {
-  const yy = String(randomInt(0, 99)).padStart(2, "0");
-  const mm = String(randomInt(1, 12)).padStart(2, "0");
-  return `${yy}${mm}${randomDigits(5)}`;
-};
-
-/** Bahrain Central Population Registration number. */
-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,
-  examples: ["890112345", "000612345"] as const,
-  description: "9-digit personal identification number",
-  sourceUrl: "https://www.bahrain.bh/wps/portal/IDInfo_en",
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default cpr;
-export { compact, format, generate, validate };

package/src/bh/mod.ts

@@ -1 +0,0 @@
-export { default as cpr } from "./cpr";

package/src/bic.ts

@@ -1,105 +0,0 @@
-const BIC_ALPHANUM = "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";
-const BIC_COUNTRIES = [
-  "DE",
-  "GB",
-  "US",
-  "FR",
-  "CH",
-  "NL",
-  "AT",
-] as const;
-
-/** Generate a random valid BIC (8-character). */
-const generate = (): string => {
-  const randomLetter = (): string =>
-    String.fromCodePoint(65 + randomInt(0, 25));
-  const country = randomPick(BIC_COUNTRIES);
-  const bank =
-    randomLetter() +
-    randomLetter() +
-    randomLetter() +
-    randomLetter();
-  const location =
-    randomChar(BIC_ALPHANUM) + randomChar(BIC_ALPHANUM);
-  return `${bank}${country}${location}`;
-};
-
-/**
- * BIC (Business Identifier Code).
- *
- * ISO 9362. 8 or 11 character code identifying
- * financial institutions. Format:
- * [A-Z]{4} (institution) + [A-Z]{2} (country) +
- * [0-9A-Z]{2} (location) + [0-9A-Z]{3} (branch,
- * optional).
- *
- * @see https://www.swift.com/
- */
-
-import type {
-  ValidateResult,
-  GlobalValidator,
-} from "./types";
-
-import { clean } from "#util/clean";
-import {
-  randomChar,
-  randomInt,
-  randomPick,
-} from "#util/generate";
-import { err } from "#util/result";
-
-const BIC_RE =
-  /^[A-Z]{4}[A-Z]{2}[0-9A-Z]{2}([0-9A-Z]{3})?$/;
-
-const compact = (value: string): string =>
-  clean(value, " -").toUpperCase();
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length !== 8 && v.length !== 11) {
-    return err(
-      "INVALID_LENGTH",
-      "BIC must be 8 or 11 characters",
-    );
-  }
-  if (!BIC_RE.test(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "BIC must be 8 or 11 alphanumeric characters",
-    );
-  }
-  // Country code at positions 4-5 is already
-  // validated as [A-Z]{2} by the regex above.
-  // SWIFT accepts all ISO 3166-1 alpha-2 codes
-  // plus XK (Kosovo); we don't restrict further.
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => {
-  const v = compact(value);
-  if (v.length === 11) {
-    return `${v.slice(0, 4)} ${v.slice(4, 6)} ${v.slice(6, 8)} ${v.slice(8)}`;
-  }
-  return `${v.slice(0, 4)} ${v.slice(4, 6)} ${v.slice(6)}`;
-};
-
-/** Business Identifier Code (SWIFT/BIC). */
-const bic: GlobalValidator = {
-  scope: "global",
-  name: "Business Identifier Code",
-  localName: "Business Identifier Code",
-  abbreviation: "BIC",
-  aliases: ["BIC", "SWIFT", "BIC/SWIFT"] as const,
-  candidatePattern: "[A-Z]{6}[A-Z0-9]{2}(?:[A-Z0-9]{3})?",
-  entityType: "company",
-  sourceUrl: "https://www.swift.com/",
-  examples: ["DEUTDEFF", "DEUTDEFF500"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default bic;
-export { compact, format, validate, generate };

package/src/br/cnpj.ts

@@ -1,156 +0,0 @@
-/**
- * CNPJ (Cadastro Nacional da Pessoa Jurídica).
- *
- * Brazilian company tax identification number assigned by
- * the Receita Federal (Federal Revenue Service). The
- * number consists of 14 characters: 8 identifying the
- * company, 4 identifying the establishment (0001 for
- * headquarters), and 2 check digits computed using a
- * weighted modulo 11 algorithm.
- *
- * As of July 2026 the Receita Federal will begin issuing
- * alphanumeric CNPJs (letters A-Z in place of some
- * digits). The check digit algorithm uses ordinal values
- * (0-9 = 0-9, A-Z = 17-42) to support this.
- *
- * Format: NN.NNN.NNN/NNNN-DD (14 characters).
- *
- * @see https://www.gov.br/en/categories/finance-taxes-and-public-management/cpf-cnpj-and-other-records
- * @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";
-
-const CNPJ_RE = /^[\dA-Z]+$/;
-
-const compact = (value: string): string =>
-  clean(value, " -./").trim().toUpperCase();
-
-/**
- * Convert a CNPJ character to its numeric value.
- * Digits 0-9 map to 0-9; letters A-Z map to their
- * char code minus 48 (matching python-stdnum's
- * `ord(n) - 48` convention: A=17, B=18, ..., Z=42).
- */
-const charToValue = (ch: string): number =>
-  ch.charCodeAt(0) - 48;
-
-/**
- * Calculate the two CNPJ check digits using the
- * Receita Federal modulo 11 algorithm.
- *
- * First check digit: weights [5,4,3,2,9,8,7,6,5,4,3,2]
- * applied to the first 12 characters.
- *
- * Second check digit: weights [6,5,4,3,2,9,8,7,6,5,4,3,2]
- * applied to the first 12 characters plus the first
- * check digit.
- */
-const calcCheckDigits = (number: string): string => {
-  const w1 = [5, 4, 3, 2, 9, 8, 7, 6, 5, 4, 3, 2];
-  let sum = 0;
-  for (let i = 0; i < 12; i++) {
-    sum += (w1[i] ?? 0) * charToValue(number.charAt(i));
-  }
-  const d1 = ((11 - (sum % 11)) % 11) % 10;
-
-  const w2 = [6, 5, 4, 3, 2, 9, 8, 7, 6, 5, 4, 3, 2];
-  sum = 0;
-  for (let i = 0; i < 12; i++) {
-    sum += (w2[i] ?? 0) * charToValue(number.charAt(i));
-  }
-  // Use the computed d1 (not the stored digit at
-  // number[12]) so both check digits are derived
-  // from the base alone.
-  sum += (w2[12] ?? 0) * d1;
-  const d2 = ((11 - (sum % 11)) % 11) % 10;
-
-  return `${d1}${d2}`;
-};
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length !== 14) {
-    return err(
-      "INVALID_LENGTH",
-      "CNPJ must be 14 characters",
-    );
-  }
-  if (!CNPJ_RE.test(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "CNPJ must contain only digits and uppercase letters",
-    );
-  }
-  // Reject all-zero base (first 12 chars).
-  // Unlike CPF, we do not reject all-same-digit CNPJs;
-  // python-stdnum only blocks the all-zero base, and
-  // there is no official Receita Federal list of
-  // blocked same-digit CNPJ sequences.
-  if (v.startsWith("000000000000")) {
-    return err(
-      "INVALID_FORMAT",
-      "CNPJ base must not be all zeros",
-    );
-  }
-  if (calcCheckDigits(v) !== v.slice(12)) {
-    return err(
-      "INVALID_CHECKSUM",
-      "CNPJ check digit mismatch",
-    );
-  }
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => {
-  const v = compact(value);
-  return `${v.slice(0, 2)}.${v.slice(2, 5)}.${v.slice(5, 8)}/${v.slice(8, 12)}-${v.slice(12)}`;
-};
-
-/** Generate a random valid CNPJ. */
-const generate = (): string => {
-  for (;;) {
-    const base = randomDigits(12);
-    if (base === "000000000000") continue;
-    return base + calcCheckDigits(base);
-  }
-};
-
-/**
- * Brazilian CNPJ (company tax ID).
- *
- * Examples sourced from publicly available Brazilian
- * corporate registries:
- * - Petrobras: 33.000.167/0001-01
- * - Banco do Brasil: 00.000.000/0001-91
- */
-const cnpj: CountryValidator<"BR"> = {
-  name: "Brazilian CNPJ",
-  localName: "Cadastro Nacional da Pessoa Jurídica",
-  abbreviation: "CNPJ",
-  aliases: [
-    "CNPJ",
-    "Cadastro Nacional da Pessoa Jurídica",
-  ] 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/",
-  examples: ["33000167000101", "00000000000191"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default cnpj;
-export { compact, format, validate, generate };

package/src/br/cpf.ts

@@ -1,118 +0,0 @@
-/**
- * CPF (Cadastro de Pessoas Físicas).
- *
- * Brazilian personal tax identification number assigned
- * by the Receita Federal (Federal Revenue Service) to
- * individuals. The number consists of 11 digits: 9 base
- * digits followed by 2 check digits computed using a
- * weighted modulo 11 algorithm.
- *
- * Format: NNN.NNN.NNN-DD (11 digits, purely numeric).
- *
- * @see https://www.gov.br/en/categories/finance-taxes-and-public-management/cpf-cnpj-and-other-records
- * @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";
-
-const compact = (value: string): string =>
-  clean(value, " -.").trim();
-
-/**
- * Calculate the two CPF check digits using the
- * Receita Federal modulo 11 algorithm.
- *
- * First check digit: multiply digits 0..8 by weights
- * 10..2, sum, then (11 - sum % 11) % 11 % 10.
- *
- * Second check digit: multiply digits 0..8 by weights
- * 11..3, add 2 * first check digit, then
- * (11 - sum % 11) % 11 % 10.
- */
-const calcCheckDigits = (number: string): string => {
-  let sum = 0;
-  for (let i = 0; i < 9; i++) {
-    sum += (10 - i) * Number(number[i]);
-  }
-  const d1 = ((11 - (sum % 11)) % 11) % 10;
-
-  sum = 0;
-  for (let i = 0; i < 9; i++) {
-    sum += (11 - i) * Number(number[i]);
-  }
-  sum += 2 * d1;
-  const d2 = ((11 - (sum % 11)) % 11) % 10;
-
-  return `${d1}${d2}`;
-};
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length !== 11) {
-    return err("INVALID_LENGTH", "CPF must be 11 digits");
-  }
-  if (!isdigits(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "CPF must contain only digits",
-    );
-  }
-  // All-same-digit CPFs (e.g. 000.000.000-00) pass the
-  // checksum but are not valid registrations.
-  if (/^(\d)\1{10}$/.test(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "CPF must not be a repeated digit sequence",
-    );
-  }
-  if (calcCheckDigits(v) !== v.slice(9)) {
-    return err(
-      "INVALID_CHECKSUM",
-      "CPF check digit mismatch",
-    );
-  }
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => {
-  const v = compact(value);
-  return `${v.slice(0, 3)}.${v.slice(3, 6)}.${v.slice(6, 9)}-${v.slice(9)}`;
-};
-
-/** Generate a random valid CPF. */
-const generate = (): string => {
-  for (;;) {
-    const base = randomDigits(9);
-    if (/^(\d)\1{8}$/.test(base)) continue;
-    return base + calcCheckDigits(base);
-  }
-};
-
-/** Brazilian CPF (personal tax ID). */
-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/",
-  examples: ["39053344705"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default cpf;
-export { compact, format, validate, generate };

package/src/br/mod.ts

@@ -1,2 +0,0 @@
-export { default as cnpj } from "./cnpj";
-export { default as cpf } from "./cpf";

package/src/by/mod.ts

@@ -1 +0,0 @@
-export { default as unp } from "./unp";

package/src/by/unp.ts

@@ -1,163 +0,0 @@
-/**
- * UNP (Учётный номер плательщика, Belarus tax number).
- *
- * 9 characters: the first two identify the region (numeric
- * for organisations, letters from ABCEHKMOPT for
- * individuals), followed by 7 digits. The last digit is a
- * weighted check digit (mod 11; if remainder > 9 the
- * number is invalid).
- *
- * @see https://be.wikipedia.org/wiki/Уліковы_нумар_плацельшчыка
- * @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";
-
-/** Cyrillic to Latin mapping for the letter positions. */
-const CYRILLIC_TO_LATIN: Record<string, string> = {
-  А: "A",
-  В: "B",
-  Е: "E",
-  К: "K",
-  М: "M",
-  Н: "H",
-  О: "O",
-  Р: "P",
-  С: "C",
-  Т: "T",
-};
-
-const WEIGHTS = [29, 23, 19, 17, 13, 7, 5, 3] as const;
-const ALPHA_SET = "ABCEHKMOPT";
-const VALID_FIRST = "1234567ABCEHKM";
-const ALPHABET = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ";
-
-const compact = (value: string): string => {
-  let v = clean(value, " ").toUpperCase().trim();
-  if (v.startsWith("УНП")) {
-    v = v.slice(3);
-  } else if (v.startsWith("UNP")) {
-    v = v.slice(3);
-  }
-  return v
-    .split("")
-    .map((ch) => CYRILLIC_TO_LATIN[ch] ?? ch)
-    .join("");
-};
-
-const calcCheckDigit = (number: string): number | null => {
-  let work = number;
-  if (!isdigits(number)) {
-    const second = number[1];
-    if (second === undefined) return null;
-    const idx = ALPHA_SET.indexOf(second);
-    if (idx === -1) return null;
-    work = number[0] + String(idx) + number.slice(2);
-  }
-  let sum = 0;
-  for (const [i, weight] of WEIGHTS.entries()) {
-    const ch = work[i];
-    if (ch === undefined) return null;
-    const val = ALPHABET.indexOf(ch);
-    if (val === -1) return null;
-    sum += weight * val;
-  }
-  const remainder = sum % 11;
-  if (remainder > 9) return null;
-  return remainder;
-};
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length !== 9) {
-    return err(
-      "INVALID_LENGTH",
-      "Belarus UNP must be 9 characters",
-    );
-  }
-  if (!isdigits(v.slice(2))) {
-    return err(
-      "INVALID_FORMAT",
-      "Belarus UNP positions 3-9 must be digits",
-    );
-  }
-  const first2 = v.slice(0, 2);
-  if (
-    !isdigits(first2) &&
-    !first2.split("").every((ch) => ALPHA_SET.includes(ch))
-  ) {
-    return err(
-      "INVALID_FORMAT",
-      "Belarus UNP first two characters must be" +
-        " digits or letters from ABCEHKMOPT",
-    );
-  }
-  // SAFETY: v.length === 9 guarantees v[0] exists.
-  // eslint-disable-next-line no-non-null-assertion
-  if (!VALID_FIRST.includes(v[0]!)) {
-    return err(
-      "INVALID_COMPONENT",
-      "Belarus UNP has an invalid region prefix",
-    );
-  }
-  const expected = calcCheckDigit(v);
-  if (expected === null) {
-    return err(
-      "INVALID_CHECKSUM",
-      "Belarus UNP check digit is invalid" +
-        " (mod 11 remainder > 9)",
-    );
-  }
-  if (v[8] !== String(expected)) {
-    return err(
-      "INVALID_CHECKSUM",
-      "Belarus UNP check digit mismatch",
-    );
-  }
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => compact(value);
-
-/** Generate a random valid Belarus UNP. */
-const generate = (): string => {
-  for (let i = 0; i < 100; i++) {
-    const prefix = String(randomInt(1, 7));
-    const rest = randomDigits(7);
-    const payload = prefix + rest;
-    const check = calcCheckDigit(payload);
-    if (check === null) continue;
-    const c = payload.slice(0, 8) + String(check);
-    if (validate(c).valid) return c;
-  }
-  throw new Error("Failed to generate valid UNP");
-};
-
-/** Belarus UNP (Учётный номер плательщика). */
-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/",
-  examples: ["200988541", "MA1953684"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default unp;
-export { compact, format, validate, generate };

package/src/bz/mod.ts

@@ -1 +0,0 @@
-export { default as tin } from "./tin";