@stll/stdnum 2.1.0 → 2.1.2

package/src/cl/rut.ts

@@ -1,124 +0,0 @@
-/**
- * RUT (Rol Único Tributario).
- *
- * Chilean tax identification number assigned by the SII
- * (Servicio de Impuestos Internos). The number consists
- * of 7 or 8 digits followed by a check digit (0-9 or K),
- * computed using a modulo 11 algorithm with weights
- * [2, 3, 4, 5, 6, 7] cycling right-to-left.
- *
- * Format: XX.XXX.XXX-C (7-8 digits + check digit).
- *
- * @see https://www.sii.cl/
- * @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";
-
-const RUT_RE = /^\d{7,8}[\dK]$/;
-
-const compact = (value: string): string => {
-  let v = clean(value, " -.").trim().toUpperCase();
-  if (v.startsWith("CL")) v = v.slice(2);
-  return v;
-};
-
-/**
- * Compute the RUT check digit using mod 11 with
- * weights [2, 3, 4, 5, 6, 7] cycling right-to-left.
- *
- * remainder = 11 - (weighted sum % 11)
- * 11 -> "0", 10 -> "K", else the digit as string.
- */
-const calcCheckDigit = (body: string): string => {
-  const weights = [2, 3, 4, 5, 6, 7] as const;
-  let sum = 0;
-  for (let i = body.length - 1, w = 0; i >= 0; i--, w++) {
-    // SAFETY: w % weights.length is a valid index.
-    // eslint-disable-next-line no-non-null-assertion
-    sum += Number(body[i]) * weights[w % weights.length]!;
-  }
-  const remainder = 11 - (sum % 11);
-  if (remainder === 11) return "0";
-  if (remainder === 10) return "K";
-  return String(remainder);
-};
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-
-  if (v.length !== 8 && v.length !== 9) {
-    return err(
-      "INVALID_LENGTH",
-      "RUT must be 8 or 9 characters",
-    );
-  }
-
-  if (!RUT_RE.test(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "RUT must contain only digits and optionally K",
-    );
-  }
-
-  const body = v.slice(0, -1);
-  const expected = calcCheckDigit(body);
-  if (v.at(-1) !== expected) {
-    return err(
-      "INVALID_CHECKSUM",
-      "RUT check digit does not match",
-    );
-  }
-
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => {
-  const v = compact(value);
-  const check = v.at(-1);
-  const body = v.slice(0, -1);
-  return (
-    `${body.slice(0, -6)}.${body.slice(-6, -3)}` +
-    `.${body.slice(-3)}-${check}`
-  );
-};
-
-/** Generate a random valid Chilean RUT. */
-const generate = (): string => {
-  const body = randomDigits(8);
-  return body + calcCheckDigit(body);
-};
-
-/**
- * Chilean RUT (tax identification number).
- *
- * Examples sourced from python-stdnum test suite
- * (cl.rut module).
- */
-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,
-  format,
-  validate,
-  sourceUrl: "https://www.sii.cl/",
-  lengths: [8, 9] as const,
-  examples: ["760864285", "125319092"] as const,
-  generate,
-};
-
-export default rut;
-export { compact, format, validate, generate };

package/src/cn/mod.ts

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

package/src/cn/ric.ts

@@ -1,184 +0,0 @@
-/**
- * RIC (Resident Identity Card number, 居民身份证号码).
- *
- * Chinese national identifier. 18 characters:
- * 6 (area code) + 8 (YYYYMMDD birth) + 3 (sequence,
- * odd = male) + 1 (check, 0-9 or X).
- *
- * Also accepts the legacy 15-digit format (no check
- * digit, 2-digit year).
- *
- * @see https://en.wikipedia.org/wiki/Resident_Identity_Card
- */
-
-import type {
-  ParsedPersonId,
-  ValidateResult,
-  CountryValidator,
-} from "../types";
-
-import {
-  mod112checkChar,
-  mod112validate,
-} from "#checksums/mod112";
-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";
-
-const compact = (value: string): string =>
-  clean(value, " -").toUpperCase();
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-
-  if (v.length !== 15 && v.length !== 18) {
-    return err(
-      "INVALID_LENGTH",
-      "RIC must be 15 or 18 characters",
-    );
-  }
-
-  if (v.length === 15) {
-    if (!isdigits(v)) {
-      return err(
-        "INVALID_FORMAT",
-        "15-digit RIC must contain only digits",
-      );
-    }
-    // Validate date: digits 6-11 are YYMMDD
-    const year = 1900 + Number(v.slice(6, 8));
-    const month = Number(v.slice(8, 10));
-    const day = Number(v.slice(10, 12));
-    if (!isValidDate(year, month, day)) {
-      return err(
-        "INVALID_COMPONENT",
-        "RIC contains an invalid birth date",
-      );
-    }
-    return { valid: true, compact: v };
-  }
-
-  // 18-character format
-  if (!isdigits(v.slice(0, 17))) {
-    return err(
-      "INVALID_FORMAT",
-      "RIC must contain only digits (plus check char)",
-    );
-  }
-  // SAFETY: 18-character branch guarantees v[17] exists.
-  // eslint-disable-next-line no-non-null-assertion
-  const lastChar = v[17]!;
-  if (!isdigits(lastChar) && lastChar !== "X") {
-    return err(
-      "INVALID_FORMAT",
-      "RIC check character must be 0-9 or X",
-    );
-  }
-
-  // Validate date: digits 6-13 are YYYYMMDD
-  const year = Number(v.slice(6, 10));
-  const month = Number(v.slice(10, 12));
-  const day = Number(v.slice(12, 14));
-  if (!isValidDate(year, month, day)) {
-    return err(
-      "INVALID_COMPONENT",
-      "RIC contains an invalid birth date",
-    );
-  }
-
-  if (!mod112validate(v)) {
-    return err(
-      "INVALID_CHECKSUM",
-      "RIC check character does not match",
-    );
-  }
-
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => compact(value);
-
-/**
- * Extract birth date and gender from an RIC number.
- * Returns null if the value is not valid.
- */
-const parse = (value: string): ParsedPersonId | null => {
-  const result = validate(value);
-  if (!result.valid) return null;
-
-  const v = result.compact;
-
-  let year: number;
-  let month: number;
-  let day: number;
-  let seq: number;
-
-  if (v.length === 15) {
-    year = 1900 + Number(v.slice(6, 8));
-    month = Number(v.slice(8, 10));
-    day = Number(v.slice(10, 12));
-    seq = Number(v.slice(12, 15));
-  } else {
-    year = Number(v.slice(6, 10));
-    month = Number(v.slice(10, 12));
-    day = Number(v.slice(12, 14));
-    seq = Number(v.slice(14, 17));
-  }
-
-  const gender = seq % 2 === 1 ? "male" : "female";
-
-  return {
-    birthDate: new Date(year, month - 1, day),
-    gender,
-  };
-};
-
-/** Generate a random valid 18-digit RIC. */
-const generate = (): string => {
-  // Use a simple area code prefix
-  const area = String(randomInt(110000, 659999));
-  const year = randomInt(1950, 2005);
-  const month = randomInt(1, 12);
-  const day = randomInt(1, 28);
-  const seqNum = randomInt(1, 999);
-  const seq = String(seqNum).padStart(3, "0");
-
-  const yStr = String(year);
-  const mStr = String(month).padStart(2, "0");
-  const dStr = String(day).padStart(2, "0");
-
-  const payload = `${area}${yStr}${mStr}${dStr}${seq}`;
-  const check = mod112checkChar(payload);
-  return `${payload}${check}`;
-};
-
-/** Chinese Resident Identity Card number. */
-const ric: CountryValidator<"CN", ParsedPersonId> = {
-  name: "Chinese Resident Identity Card",
-  localName: "居民身份证号码",
-  abbreviation: "RIC",
-  aliases: ["身份证", "居民身份证号码", "RIC"] as const,
-  candidatePattern: "\\d{17}[\\dX]",
-  scope: "country",
-  country: "CN",
-  entityType: "person",
-  description:
-    "18-character national ID encoding area, birth date, gender, and check digit",
-  sourceUrl:
-    "https://en.wikipedia.org/wiki/Resident_Identity_Card",
-  lengths: [15, 18] as const,
-  examples: [
-    "11010519491231002X",
-    "440524188001010014",
-  ] as const,
-  compact,
-  format,
-  parse,
-  validate,
-  generate,
-};
-
-export default ric;
-export { compact, format, generate, parse, validate };

package/src/cn/uscc.ts

@@ -1,127 +0,0 @@
-/**
- * USCC (Unified Social Credit Code, 统一社会信用代码).
- *
- * 18 alphanumeric characters (excluding I, O, Z, S, V):
- * 1 (registering authority) + 1 (entity type) +
- * 6 (region code, digits only) + 9 (organisation code) +
- * 1 (mod 31 check character).
- *
- * @see https://zh.wikipedia.org/wiki/统一社会信用代码
- */
-
-import type {
-  ValidateResult,
-  CountryValidator,
-} from "../types";
-
-import { clean } from "#util/clean";
-import {
-  randomChar,
-  randomDigits,
-  randomInt,
-} from "#util/generate";
-import { err } from "#util/result";
-import { isdigits } from "#util/strings";
-
-const ALPHABET = "0123456789ABCDEFGHJKLMNPQRTUWXY";
-
-const WEIGHTS = [
-  1, 3, 9, 27, 19, 26, 16, 17, 20, 29, 25, 13, 8, 24, 10,
-  30, 28,
-] as const;
-
-const compact = (value: string): string =>
-  clean(value, " -").toUpperCase();
-
-const calcCheckChar = (value: string): string => {
-  let total = 0;
-  for (const [i, weight] of WEIGHTS.entries()) {
-    const ch = value[i];
-    if (ch === undefined) continue;
-    total += ALPHABET.indexOf(ch) * weight;
-  }
-  // SAFETY: (31 - total % 31) % 31 is in 0..30 and
-  // ALPHABET has 31 characters.
-  // eslint-disable-next-line no-non-null-assertion
-  return ALPHABET[(31 - (total % 31)) % 31]!;
-};
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-
-  if (v.length !== 18) {
-    return err(
-      "INVALID_LENGTH",
-      "USCC must be 18 characters",
-    );
-  }
-
-  for (const ch of v) {
-    if (!ALPHABET.includes(ch)) {
-      return err(
-        "INVALID_FORMAT",
-        "USCC contains invalid character",
-      );
-    }
-  }
-
-  if (!isdigits(v.slice(2, 8))) {
-    return err(
-      "INVALID_FORMAT",
-      "USCC region code (positions 3-8) must be digits",
-    );
-  }
-
-  if (v[17] !== calcCheckChar(v)) {
-    return err(
-      "INVALID_CHECKSUM",
-      "USCC check character does not match",
-    );
-  }
-
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => compact(value);
-
-/** Generate a random valid USCC. */
-const generate = (): string => {
-  // SAFETY: indices 1..9 are within ALPHABET (31 chars).
-  // eslint-disable-next-line no-non-null-assertion
-  const reg = ALPHABET[randomInt(1, 9)]!;
-  // eslint-disable-next-line no-non-null-assertion
-  const etype = ALPHABET[randomInt(1, 9)]!;
-  const region = randomDigits(6);
-  let org = "";
-  for (let i = 0; i < 9; i++) {
-    org += randomChar(ALPHABET);
-  }
-  const payload = reg + etype + region + org;
-  return payload + calcCheckChar(payload);
-};
-
-/** Chinese Unified Social Credit Code. */
-const uscc: CountryValidator<"CN"> = {
-  name: "Unified Social Credit Code",
-  localName: "统一社会信用代码",
-  abbreviation: "USCC",
-  aliases: ["统一社会信用代码", "USCC"] as const,
-  candidatePattern:
-    "[0-9A-HJ-NP-RTUW-Y]{2}\\d{6}[0-9A-HJ-NP-RTUW-Y]{10}",
-  scope: "country",
-  country: "CN",
-  entityType: "company",
-  description:
-    "18-character tax/registration code for Chinese entities",
-  sourceUrl:
-    "https://zh.wikipedia.org/wiki/统一社会信用代码",
-  lengths: [18] as const,
-  examples: ["91110000600037341L"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default uscc;
-export { compact, format, validate, generate };

package/src/co/mod.ts

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

package/src/co/nit.ts

@@ -1,116 +0,0 @@
-/**
- * NIT (Número de Identificación Tributaria).
- *
- * Colombian tax identification number, also known as
- * RUT (Registro Unico Tributario). The last digit is
- * a check digit computed via a weighted sum mod 11
- * with weights [3,7,13,17,19,23,29,37,41,43,47,53,
- * 59,67,71] applied right-to-left.
- *
- * @see https://es.wikipedia.org/wiki/Número_de_identificación_tributaria
- */
-
-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 WEIGHTS = [
-  3, 7, 13, 17, 19, 23, 29, 37, 41, 43, 47, 53, 59, 67, 71,
-] as const;
-
-/** Lookup table: remainder -> check digit. */
-const CHECK_DIGITS = [0, 1, 9, 8, 7, 6, 5, 4, 3, 2, 1];
-
-const compact = (value: string): string =>
-  clean(value, " -.,");
-
-const calcCheckDigit = (body: string): number => {
-  let sum = 0;
-  const len = body.length;
-  for (const [i, weight] of WEIGHTS.entries()) {
-    if (i >= len) break;
-    sum += Number(body[len - 1 - i]) * weight;
-  }
-  // SAFETY: sum % 11 is in 0..10 and CHECK_DIGITS has
-  // 11 entries.
-  // eslint-disable-next-line no-non-null-assertion
-  return CHECK_DIGITS[sum % 11]!;
-};
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length < 8 || v.length > 16) {
-    return err(
-      "INVALID_LENGTH",
-      "NIT must be between 8 and 16 digits",
-    );
-  }
-  if (!isdigits(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "NIT must contain only digits",
-    );
-  }
-
-  const body = v.slice(0, -1);
-  const check = calcCheckDigit(body);
-  if (check !== Number(v.at(-1))) {
-    return err(
-      "INVALID_CHECKSUM",
-      "NIT check digit does not match",
-    );
-  }
-
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => {
-  const v = compact(value);
-  const body = v.slice(0, -1);
-  const checkChar = v.slice(-1);
-  const groups: string[] = [];
-  for (let i = body.length; i > 0; i -= 3) {
-    groups.unshift(body.slice(Math.max(0, i - 3), i));
-  }
-  return `${groups.join(".")}-${checkChar}`;
-};
-
-/** Generate a random valid NIT (10 digits). */
-const generate = (): string => {
-  const body = randomDigits(9);
-  const check = calcCheckDigit(body);
-  return `${body}${check}`;
-};
-
-/** Colombian tax identification number. */
-const nit: CountryValidator<"CO"> = {
-  name: "Número de Identificación Tributaria",
-  localName: "Número de Identificación Tributaria",
-  abbreviation: "NIT",
-  aliases: [
-    "NIT",
-    "Número de Identificación Tributaria",
-  ] as const,
-  candidatePattern: "\\d{9,10}-?\\d",
-  scope: "country",
-  country: "CO",
-  entityType: "any",
-  description: "Tax identifier issued by the DIAN",
-  sourceUrl:
-    "https://es.wikipedia.org/wiki/N%C3%BAmero_de_identificaci%C3%B3n_tributaria",
-  lengths: [8, 9, 10, 11, 12, 13, 14, 15, 16] as const,
-  examples: ["2131234321", "8001234565"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default nit;
-export { compact, format, generate, validate };

package/src/cr/cpf.ts

@@ -1,116 +0,0 @@
-/** Generate a random valid Costa Rican CPF. */
-const generate = (): string => {
-  const province = String(randomInt(1, 9));
-  const volume = randomDigits(4);
-  const entry = randomDigits(4);
-  return `0${province}${volume}${entry}`;
-};
-
-/**
- * CPF (Cédula de Persona Física, Costa Rican
- * physical person ID number).
- *
- * 10 digits: 0P-TTTT-AAAA where:
- *   - 0 = fixed leading zero
- *   - P = province digit
- *   - TTTT = volume (tomo), zero-padded
- *   - AAAA = entry (asiento), zero-padded
- *
- * No check digit; validation is by format only.
- *
- * Ported from python-stdnum cr.cpf module.
- *
- * @see https://www.tse.go.cr/
- */
-
-import type {
-  ValidateResult,
-  CountryValidator,
-} from "../types";
-
-import { clean } from "#util/clean";
-import { randomDigits, randomInt } from "#util/generate";
-import { err } from "#util/result";
-
-/**
- * Compact: strip spaces, pad hyphen-separated parts
- * (2-4-4), join, and prepend '0' if 9 digits.
- */
-const compact = (value: string): string => {
-  let number = clean(value, " ").trim().toUpperCase();
-
-  const parts = number.split("-");
-  if (parts.length === 3) {
-    const [raw0, raw1, raw2] = parts;
-    const p0 = (raw0 ?? "").padStart(2, "0");
-    const p1 = (raw1 ?? "").padStart(4, "0");
-    const p2 = (raw2 ?? "").padStart(4, "0");
-    number = p0 + p1 + p2;
-  } else {
-    number = number.replaceAll("-", "");
-  }
-
-  if (number.length === 9) {
-    number = "0" + number;
-  }
-
-  return number;
-};
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-
-  if (v.length !== 10) {
-    return err(
-      "INVALID_LENGTH",
-      "Costa Rican CPF must be 10 digits",
-    );
-  }
-
-  if (!/^\d{10}$/.test(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "Costa Rican CPF must contain only digits",
-    );
-  }
-
-  if (v[0] !== "0") {
-    return err(
-      "INVALID_COMPONENT",
-      "Costa Rican CPF must start with 0",
-    );
-  }
-
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => {
-  const v = compact(value);
-  return `${v.slice(0, 2)}-${v.slice(2, 6)}-${v.slice(6, 10)}`;
-};
-
-/**
- * Costa Rican physical person ID number (CPF).
- *
- * Examples sourced from python-stdnum test suite.
- */
-const cpf: CountryValidator<"CR"> = {
-  name: "Costa Rican Physical Person ID",
-  localName: "Cédula de Persona Física",
-  abbreviation: "CPF",
-  aliases: ["CPF", "cédula de persona física"] as const,
-  candidatePattern: "\\d{9,12}",
-  scope: "country",
-  country: "CR",
-  entityType: "person",
-  lengths: [10] as const,
-  examples: ["0304550175", "0109130259"] as const,
-  compact,
-  format,
-  validate,
-  sourceUrl: "https://www.tse.go.cr/",
-  generate,
-};
-
-export default cpf;
-export { compact, format, validate, generate };

package/src/cr/mod.ts

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