@stll/stdnum 2.1.1 → 2.1.2

package/src/do/rnc.ts

@@ -1,130 +0,0 @@
-/**
- * RNC (Registro Nacional del Contribuyente) /
- * Cédula de Identidad.
- *
- * Dominican Republic tax identification number.
- * Companies use a 9-digit RNC with a check digit
- * computed via weighted sum mod 11. Individuals
- * use an 11-digit Cédula validated with the Luhn
- * algorithm.
- *
- * Format: #########   (9 digits, company RNC)
- *         ###########  (11 digits, individual Cédula)
- *
- * @see https://dgii.gov.do/
- */
-
-import type {
-  ValidateResult,
-  CountryValidator,
-} from "../types";
-
-import { luhnValidate } from "#checksums/luhn";
-import { clean } from "#util/clean";
-import { randomDigits } from "#util/generate";
-import { err } from "#util/result";
-import { isdigits } from "#util/strings";
-
-/**
- * Weights for the 9-digit RNC check digit.
- * Applied to positions 0-7; check digit is at
- * position 8.
- */
-const RNC_WEIGHTS = [7, 9, 8, 6, 5, 4, 3, 2] as const;
-
-const compact = (value: string): string =>
-  clean(value, " -.").trim();
-
-/**
- * RNC check digit: weighted sum mod 11, then
- * ((10 - remainder) % 9) + 1.
- */
-const calcRncCheckDigit = (value: string): string => {
-  let sum = 0;
-  for (const [i, weight] of RNC_WEIGHTS.entries()) {
-    sum += Number(value[i]) * weight;
-  }
-  const remainder = sum % 11;
-  return String(((10 - remainder) % 9) + 1);
-};
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-
-  if (v.length !== 9 && v.length !== 11) {
-    return err(
-      "INVALID_LENGTH",
-      "Must be 9 digits (RNC) or 11 digits (Cédula)",
-    );
-  }
-
-  if (!isdigits(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "Must contain only digits",
-    );
-  }
-
-  if (v.length === 9) {
-    const expected = calcRncCheckDigit(v);
-    if (v.at(-1) !== expected) {
-      return err(
-        "INVALID_CHECKSUM",
-        "RNC check digit does not match",
-      );
-    }
-  } else {
-    // 11-digit Cédula uses Luhn checksum
-    if (!luhnValidate(v)) {
-      return err(
-        "INVALID_CHECKSUM",
-        "Cédula Luhn checksum does not match",
-      );
-    }
-  }
-
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => {
-  const v = compact(value);
-  if (v.length === 9) {
-    return `${v[0]}-${v.slice(1, 3)}-${v.slice(3, 8)}-${v.slice(8)}`;
-  }
-  return `${v.slice(0, 3)}-${v.slice(3, 10)}-${v.slice(10)}`;
-};
-
-/** Generate a random valid 9-digit RNC. */
-const generate = (): string => {
-  const payload = randomDigits(8);
-  return payload + calcRncCheckDigit(payload);
-};
-
-/**
- * Dominican Republic RNC / Cédula.
- *
- * Examples sourced from python-stdnum test suite.
- */
-const rnc: CountryValidator<"DO"> = {
-  name: "Dominican Republic Tax ID",
-  localName: "Registro Nacional del Contribuyente",
-  abbreviation: "RNC",
-  aliases: [
-    "RNC",
-    "Registro Nacional del Contribuyente",
-  ] as const,
-  candidatePattern: "\\d{9}",
-  scope: "country",
-  country: "DO",
-  entityType: "any",
-  lengths: [9, 11] as const,
-  examples: ["131098193", "00113918205"] as const,
-  compact,
-  format,
-  validate,
-  sourceUrl: "https://dgii.gov.do/",
-  generate,
-};
-
-export default rnc;
-export { compact, format, validate, generate };

package/src/ec/mod.ts

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

package/src/ec/ruc.ts

@@ -1,199 +0,0 @@
-/**
- * RUC (Registro Único de Contribuyentes).
- *
- * Ecuadorian tax identification number. 13 digits:
- * - Digits 1-2: province code (01-24, 30, or 50)
- * - Digit 3: type indicator
- *   - 0-5: natural person (CI + establishment)
- *   - 6: public entity (or natural person fallback)
- *   - 9: juridical entity (public checksum first,
- *         then juridical fallback)
- *
- * Natural persons use a Luhn-like mod-10 checksum on
- * the first 10 digits. Public entities use a mod-11
- * checksum on the first 9 digits. Private companies
- * use a mod-11 checksum on the first 10 digits.
- *
- * @see https://www.sri.gob.ec/
- */
-
-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, " -");
-
-/** CI mod-10 checksum: weights [2,1,2,1,...], fold
- *  products > 9 by subtracting 9, sum mod 10 == 0. */
-const ciChecksum = (digits: string): number => {
-  let sum = 0;
-  for (let i = 0; i < digits.length; i++) {
-    const weight = i % 2 === 0 ? 2 : 1;
-    let product = Number(digits[i]) * weight;
-    if (product > 9) product -= 9;
-    sum += product;
-  }
-  return sum % 10;
-};
-
-/** Weighted mod-11 checksum. */
-const mod11Checksum = (
-  digits: string,
-  weights: readonly number[],
-): number => {
-  let sum = 0;
-  for (const [i, weight] of weights.entries()) {
-    sum += Number(digits[i]) * weight;
-  }
-  return sum % 11;
-};
-
-const PUBLIC_WEIGHTS = [3, 2, 7, 6, 5, 4, 3, 2, 1];
-const JURIDICAL_WEIGHTS = [4, 3, 2, 7, 6, 5, 4, 3, 2, 1];
-
-const isValidProvince = (v: string): boolean => {
-  const province = v.slice(0, 2);
-  return (
-    (province >= "01" && province <= "24") ||
-    province === "30" ||
-    province === "50"
-  );
-};
-
-const validateNatural = (
-  v: string,
-): ValidateResult | null => {
-  if (v.slice(-3) === "000") return null;
-  if (ciChecksum(v.slice(0, 10)) !== 0) return null;
-  return { valid: true, compact: v };
-};
-
-const validatePublic = (
-  v: string,
-): ValidateResult | null => {
-  if (v.slice(-4) === "0000") return null;
-  if (mod11Checksum(v, PUBLIC_WEIGHTS) !== 0) return null;
-  return { valid: true, compact: v };
-};
-
-const validateJuridical = (
-  v: string,
-): ValidateResult | null => {
-  if (v.slice(-3) === "000") return null;
-  if (mod11Checksum(v, JURIDICAL_WEIGHTS) !== 0) {
-    return null;
-  }
-  return { valid: true, compact: v };
-};
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length !== 13) {
-    return err(
-      "INVALID_LENGTH",
-      "RUC must be exactly 13 digits",
-    );
-  }
-  if (!isdigits(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "RUC must contain only digits",
-    );
-  }
-  if (!isValidProvince(v)) {
-    return err(
-      "INVALID_COMPONENT",
-      "RUC province code is invalid",
-    );
-  }
-
-  const typeDigit = Number(v[2]);
-
-  if (typeDigit <= 5) {
-    // Natural person
-    const result = validateNatural(v);
-    if (result) return result;
-    return err(
-      "INVALID_CHECKSUM",
-      "RUC check digit does not match",
-    );
-  }
-
-  if (typeDigit === 6) {
-    // Public entity; fall back to natural person
-    const pub = validatePublic(v);
-    if (pub) return pub;
-    const nat = validateNatural(v);
-    if (nat) return nat;
-    return err(
-      "INVALID_CHECKSUM",
-      "RUC check digit does not match",
-    );
-  }
-
-  if (typeDigit === 9) {
-    // Juridical RUC; try public checksum first, fall
-    // back to juridical (matches python-stdnum).
-    const pub = validatePublic(v);
-    if (pub) return pub;
-    const jur = validateJuridical(v);
-    if (jur) return jur;
-    return err(
-      "INVALID_CHECKSUM",
-      "RUC check digit does not match",
-    );
-  }
-
-  return err(
-    "INVALID_COMPONENT",
-    "RUC type digit is invalid",
-  );
-};
-
-const format = (value: string): string => compact(value);
-
-/** Generate a random valid Ecuadorian RUC. */
-const generate = (): string => {
-  for (;;) {
-    const province = String(randomInt(1, 24)).padStart(
-      2,
-      "0",
-    );
-    const c = province + randomDigits(11);
-    if (validate(c).valid) return c;
-  }
-};
-
-/** Ecuadorian tax identification number. */
-const ruc: CountryValidator<"EC"> = {
-  name: "Registro Único de Contribuyentes",
-  localName: "Registro Único de Contribuyentes",
-  abbreviation: "RUC",
-  aliases: [
-    "RUC",
-    "Registro Único de Contribuyentes",
-  ] as const,
-  candidatePattern: "\\d{13}",
-  scope: "country",
-  country: "EC",
-  entityType: "any",
-  description:
-    "13-digit tax identification number issued by the SRI",
-  sourceUrl: "https://www.sri.gob.ec/",
-  lengths: [13] as const,
-  examples: ["1792060346001", "1790011674001"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default ruc;
-export { compact, format, validate, generate };

package/src/ee/ik.ts

@@ -1,167 +0,0 @@
-/**
- * Isikukood (IK).
- *
- * Estonian personal identification code. 11 digits:
- * gender/century digit, YYMMDD, 3-digit serial, and
- * a check digit computed with two-pass weighted sums.
- *
- * Canonical sources:
- * - Estonian legislation for the personal code format
- * - OECD Estonia TIN sheet summarising the same
- *   first-digit ranges for cross-border tax use
- *
- * These sources are why we restrict the first digit
- * to 1-6 rather than accepting speculative 7/8 forms.
- *
- * @see https://www.riigiteataja.ee/en/eli/512012015003/consolide
- * @see https://www.oecd.org/tax/automatic-exchange/crs-implementation-and-assistance/tax-identification-numbers/Estonia-TIN.pdf
- */
-
-import type {
-  ParsedPersonId,
-  ValidateResult,
-  CountryValidator,
-} from "../types";
-
-import { weightedSum } from "#checksums/weighted-sum";
-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 WEIGHTS_1 = [1, 2, 3, 4, 5, 6, 7, 8, 9, 1] as const;
-const WEIGHTS_2 = [3, 4, 5, 6, 7, 8, 9, 1, 2, 3] as const;
-
-const centuryMap: Record<number, number> = {
-  1: 1800,
-  2: 1800,
-  3: 1900,
-  4: 1900,
-  5: 2000,
-  6: 2000,
-};
-
-const compact = (value: string): string =>
-  clean(value, " -");
-
-/**
- * Compute the two-pass check digit used by both
- * Estonian IK and Lithuanian Asmens kodas.
- */
-export const twoPassCheck = (digits: string): number => {
-  let remainder = weightedSum(digits, WEIGHTS_1, 11);
-  if (remainder !== 10) return remainder;
-  remainder = weightedSum(digits, WEIGHTS_2, 11);
-  return remainder === 10 ? 0 : remainder;
-};
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length !== 11) {
-    return err(
-      "INVALID_LENGTH",
-      "Isikukood must be exactly 11 digits",
-    );
-  }
-  if (!isdigits(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "Isikukood must contain only digits",
-    );
-  }
-
-  const g = Number(v[0]);
-  // Official Estonian structure uses 1-6:
-  // 1-2 = 1800s, 3-4 = 1900s, 5-6 = 2000s.
-  if (g < 1 || g > 6) {
-    return err(
-      "INVALID_COMPONENT",
-      "Isikukood gender/century digit is invalid",
-    );
-  }
-
-  const century = centuryMap[g] ?? 1900;
-  const yy = Number(v.slice(1, 3));
-  const mm = Number(v.slice(3, 5));
-  const dd = Number(v.slice(5, 7));
-  const year = century + yy;
-
-  if (!isValidDate(year, mm, dd)) {
-    return err(
-      "INVALID_COMPONENT",
-      "Isikukood contains an invalid date",
-    );
-  }
-
-  const check = twoPassCheck(v.slice(0, 10));
-  if (check !== Number(v[10])) {
-    return err(
-      "INVALID_CHECKSUM",
-      "Isikukood check digit does not match",
-    );
-  }
-
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => compact(value);
-
-/**
- * Extract birth date and gender from an Isikukood.
- * 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;
-  const g = Number(v[0]);
-  const century = centuryMap[g] ?? 1900;
-  const yy = Number(v.slice(1, 3));
-  const mm = Number(v.slice(3, 5));
-  const dd = Number(v.slice(5, 7));
-  const year = century + yy;
-
-  return {
-    birthDate: new Date(year, mm - 1, dd),
-    gender: g % 2 === 1 ? "male" : "female",
-  };
-};
-
-/** Generate a random valid Estonian IK. */
-const generate = (): string => {
-  for (;;) {
-    const g = String(randomInt(3, 6));
-    const yy = String(randomInt(0, 99)).padStart(2, "0");
-    const mm = String(randomInt(1, 12)).padStart(2, "0");
-    const dd = String(randomInt(1, 28)).padStart(2, "0");
-    const s = String(randomInt(0, 999)).padStart(3, "0");
-    const payload = g + yy + mm + dd + s;
-    const c = payload + String(twoPassCheck(payload));
-    if (validate(c).valid) return c;
-  }
-};
-
-/** Estonian Personal Identification Code. */
-const ik: CountryValidator<"EE", ParsedPersonId> = {
-  name: "Estonian Personal ID",
-  localName: "Isikukood",
-  abbreviation: "IK",
-  aliases: ["isikukood", "IK"] as const,
-  candidatePattern: "[1-6]\\d{10}",
-  scope: "country",
-  country: "EE",
-  entityType: "person",
-  sourceUrl:
-    "https://www.riigiteataja.ee/en/eli/512012015003/consolide",
-  examples: ["36805280109"] as const,
-  compact,
-  format,
-  parse,
-  validate,
-  generate,
-};
-
-export default ik;
-export { compact, format, parse, validate, generate };

package/src/ee/mod.ts

@@ -1,3 +0,0 @@
-export { default as ik } from "./ik";
-export { default as registrikood } from "./registrikood";
-export { default as vat } from "./vat";

package/src/ee/registrikood.ts

@@ -1,86 +0,0 @@
-/**
- * Registrikood (Estonian company registration code).
- *
- * 8 digits. First digit must be 1, 7, 8, or 9.
- * Two-pass checksum (same algorithm as EE IK).
- *
- * @see https://www.rik.ee/
- */
-
-import type {
-  ValidateResult,
-  CountryValidator,
-} from "../types";
-import { twoPassCheck } from "./ik";
-
-import { clean } from "#util/clean";
-import { randomDigits, randomPick } from "#util/generate";
-import { err } from "#util/result";
-import { isdigits } from "#util/strings";
-
-const VALID_FIRST = new Set(["1", "7", "8", "9"]);
-
-const compact = (value: string): string =>
-  clean(value, " -");
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length !== 8) {
-    return err(
-      "INVALID_LENGTH",
-      "Estonian Registrikood must be 8 digits",
-    );
-  }
-  if (!isdigits(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "Estonian Registrikood must contain only digits",
-    );
-  }
-  if (!VALID_FIRST.has(v.charAt(0))) {
-    return err(
-      "INVALID_COMPONENT",
-      "Estonian Registrikood must start with 1, 7, 8, or 9",
-    );
-  }
-  const check = twoPassCheck(v.slice(0, 7));
-  if (check !== Number(v[7])) {
-    return err(
-      "INVALID_CHECKSUM",
-      "Estonian Registrikood check digit mismatch",
-    );
-  }
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => compact(value);
-
-const REGISTRIKOOD_FIRSTS = [1, 7, 8, 9] as const;
-
-/** Generate a random valid Estonian Registrikood. */
-const generate = (): string => {
-  const first = String(randomPick(REGISTRIKOOD_FIRSTS));
-  const payload = first + randomDigits(6);
-  return payload + String(twoPassCheck(payload));
-};
-
-/** Estonian Company Registration Code. */
-const registrikood: CountryValidator<"EE"> = {
-  name: "Estonian Company Registration Code",
-  localName: "Registrikood",
-  abbreviation: "Registrikood",
-  aliases: ["registrikood"] as const,
-  candidatePattern: "\\d{8}",
-  scope: "country",
-  country: "EE",
-  entityType: "company",
-  sourceUrl: "https://www.rik.ee/",
-  examples: ["12345678"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default registrikood;
-export { compact, format, validate, generate };

package/src/ee/vat.ts

@@ -1,89 +0,0 @@
-/**
- * KMKR (Estonian VAT number).
- *
- * 9 digits. Weights [3,7,1,3,7,1,3,7,1],
- * sum % 10 === 0.
- *
- * @see https://www.vatify.eu/estonia-vat-number.html
- * @see https://www.emta.ee/en
- */
-
-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";
-
-const WEIGHTS = [3, 7, 1, 3, 7, 1, 3, 7, 1];
-
-const compact = (value: string): string => {
-  let v = clean(value, " -/.");
-  if (v.startsWith("EE") || v.startsWith("ee")) {
-    v = v.slice(2);
-  }
-  return v;
-};
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length !== 9) {
-    return err(
-      "INVALID_LENGTH",
-      "Estonian VAT number must be 9 digits",
-    );
-  }
-  if (!isdigits(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "Estonian VAT number must contain only digits",
-    );
-  }
-  const sum = weightedSum(v, WEIGHTS, 10);
-  if (sum !== 0) {
-    return err(
-      "INVALID_CHECKSUM",
-      "Estonian VAT number check digit mismatch",
-    );
-  }
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string =>
-  `EE${compact(value)}`;
-
-/** Generate a random valid Estonian VAT number. */
-const generate = (): string => {
-  for (;;) {
-    const c = randomDigits(9);
-    if (validate(c).valid) return c;
-  }
-};
-
-/** Estonian VAT Number. */
-const vat: CountryValidator<"EE"> = {
-  name: "Estonian VAT Number",
-  localName: "Käibemaksukohustuslase number",
-  abbreviation: "KMKR",
-  aliases: [
-    "käibemaksukohustuslase number",
-    "KMKR",
-  ] as const,
-  candidatePattern: "EE\\d{9}",
-  scope: "country",
-  country: "EE",
-  entityType: "company",
-  sourceUrl: "https://www.emta.ee/en",
-  examples: ["100931558"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default vat;
-export { compact, format, validate, generate };

package/src/eg/mod.ts

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