@stll/stdnum 2.1.1 → 2.1.2

package/src/eg/tn.ts

@@ -1,107 +0,0 @@
-/** Generate a random valid Egyptian TN. */
-const generate = (): string => randomDigits(9);
-
-/**
- * TN (Tax Registration Number, الرقم الضريبي).
- *
- * Egyptian tax number. 9 digits, no checksum.
- * Displayed as XXX-XXX-XXX. Accepts both
- * Arabic-Indic and Extended Arabic-Indic digits.
- *
- * @see https://www.eta.gov.eg/
- */
-
-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";
-
-/**
- * Arabic-Indic and Extended Arabic-Indic digit map.
- * Converts Arabic numeral characters to ASCII digits.
- */
-const ARABIC_DIGITS: Record<string, string> = {
-  "\u0660": "0", // ٠
-  "\u0661": "1", // ١
-  "\u0662": "2", // ٢
-  "\u0663": "3", // ٣
-  "\u0664": "4", // ٤
-  "\u0665": "5", // ٥
-  "\u0666": "6", // ٦
-  "\u0667": "7", // ٧
-  "\u0668": "8", // ٨
-  "\u0669": "9", // ٩
-  "\u06F0": "0", // ۰
-  "\u06F1": "1", // ۱
-  "\u06F2": "2", // ۲
-  "\u06F3": "3", // ۳
-  "\u06F4": "4", // ۴
-  "\u06F5": "5", // ۵
-  "\u06F6": "6", // ۶
-  "\u06F7": "7", // ۷
-  "\u06F8": "8", // ۸
-  "\u06F9": "9", // ۹
-};
-
-const ARABIC_REGEX = new RegExp(
-  `[${Object.keys(ARABIC_DIGITS).join("")}]`,
-  "g",
-);
-
-const compact = (value: string): string => {
-  const cleaned = clean(value, " -/");
-  return cleaned.replace(
-    ARABIC_REGEX,
-    (ch) => ARABIC_DIGITS[ch] ?? ch,
-  );
-};
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length !== 9) {
-    return err(
-      "INVALID_LENGTH",
-      "Egyptian TN must be exactly 9 digits",
-    );
-  }
-  if (!isdigits(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "Egyptian TN must contain only digits",
-    );
-  }
-  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)}`;
-};
-
-/** Egyptian Tax Registration Number. */
-const tn: CountryValidator<"EG"> = {
-  name: "Egyptian Tax Registration Number",
-  localName: "الرقم الضريبي",
-  abbreviation: "TN",
-  aliases: ["الرقم الضريبي", "tax number"] as const,
-  candidatePattern: "\\d{9}",
-  scope: "country",
-  country: "EG",
-  entityType: "any",
-  compact,
-  format,
-  validate,
-  description: "Egyptian tax identification number",
-  sourceUrl: "https://www.eta.gov.eg/",
-  lengths: [9] as const,
-  examples: ["100531385", "331105268"] as const,
-  generate,
-};
-
-export default tn;
-export { compact, format, validate, generate };

package/src/es/cif.ts

@@ -1,108 +0,0 @@
-/**
- * CIF (Código de Identificación Fiscal).
- *
- * Spanish company tax identification number.
- * Letter prefix (ABCDEFGHJNPQRSUVW) + 7 digits +
- * check digit or letter. Delegates to the CIF
- * branch of es/vat validation.
- *
- * @see https://www.agenciatributaria.es/
- */
-
-import type {
-  ValidateResult,
-  CountryValidator,
-} from "../types";
-import { cifChecksum } from "./vat";
-
-import { clean } from "#util/clean";
-import { randomChar, randomDigits } from "#util/generate";
-import { err } from "#util/result";
-import { isdigits } from "#util/strings";
-
-const CIF_PREFIXES = "ABCDEFGHJNPQRSUVW";
-const CIF_LETTERS = "JABCDEFGHI";
-
-const compact = (value: string): string => {
-  let v = clean(value, " -/.");
-  if (v.startsWith("ES") || v.startsWith("es")) {
-    v = v.slice(2);
-  }
-  return v.toUpperCase();
-};
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length !== 9) {
-    return err(
-      "INVALID_LENGTH",
-      "Spanish CIF must be 9 characters",
-    );
-  }
-
-  const first = v.charAt(0);
-  if (!CIF_PREFIXES.includes(first)) {
-    return err(
-      "INVALID_FORMAT",
-      "Spanish CIF must start with a valid prefix letter",
-    );
-  }
-
-  if (!isdigits(v.slice(1, 8))) {
-    return err(
-      "INVALID_FORMAT",
-      "Spanish CIF must have 7 digits after prefix",
-    );
-  }
-
-  const last = v.charAt(8);
-  const check = cifChecksum(v.slice(1, 8));
-
-  if (
-    last !== String(check) &&
-    last !== CIF_LETTERS.charAt(check)
-  ) {
-    return err(
-      "INVALID_CHECKSUM",
-      "Spanish CIF check digit/letter mismatch",
-    );
-  }
-
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => compact(value);
-
-/** Generate a random valid Spanish CIF. */
-const generate = (): string => {
-  const letter = randomChar(CIF_PREFIXES);
-  const payload = randomDigits(7);
-  const check = cifChecksum(payload);
-  if ("KPQS".includes(letter))
-    return letter + payload + CIF_LETTERS.charAt(check);
-  return letter + payload + String(check);
-};
-
-/** Spanish Company Tax ID (CIF). */
-const cif: CountryValidator<"ES"> = {
-  name: "Spanish Company Tax ID",
-  localName: "Código de Identificación Fiscal",
-  abbreviation: "CIF",
-  aliases: [
-    "CIF",
-    "código de identificación fiscal",
-  ] as const,
-  candidatePattern: "[A-HJNP-SUVW]\\d{7}[\\dA-J]",
-  scope: "country",
-  country: "ES",
-  entityType: "company",
-  sourceUrl: "https://www.agenciatributaria.es/",
-  examples: ["A13585625"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default cif;
-export { compact, format, validate, generate };

package/src/es/dni.ts

@@ -1,94 +0,0 @@
-/**
- * DNI (Documento Nacional de Identidad).
- *
- * Spanish national identity document number.
- * 8 digits followed by a check letter determined
- * by the remainder of dividing the number by 23.
- *
- * @see https://www.interior.gob.es/opencms/es/servicios-al-ciudadano/tramites-y-gestiones/dni/
- */
-
-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 CHECK_LETTERS = "TRWAGMYFPDXBNJZSQVHLCKE";
-
-const compact = (value: string): string =>
-  clean(value, " -").toUpperCase();
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length !== 9) {
-    return err(
-      "INVALID_LENGTH",
-      "DNI must be 8 digits and 1 letter",
-    );
-  }
-
-  const digits = v.slice(0, 8);
-  const letter = v[8];
-
-  if (!isdigits(digits)) {
-    return err(
-      "INVALID_FORMAT",
-      "DNI must start with 8 digits",
-    );
-  }
-
-  const expected = CHECK_LETTERS[Number(digits) % 23];
-  if (letter !== expected) {
-    return err(
-      "INVALID_CHECKSUM",
-      "DNI check letter does not match",
-    );
-  }
-
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => compact(value);
-
-/** Generate a random valid Spanish DNI. */
-const generate = (): string => {
-  const num = randomDigits(8);
-  return num + CHECK_LETTERS[Number(num) % 23];
-};
-
-/** Spanish National Identity Document. */
-const dni: CountryValidator<"ES"> = {
-  name: "Spanish National ID",
-  localName: "Documento Nacional de Identidad",
-  abbreviation: "DNI",
-  aliases: [
-    "D.N.I.",
-    "DNI",
-    "documento nacional de identidad",
-  ] as const,
-  candidatePattern: "\\d{1,2}\\.?\\d{3}\\.?\\d{3}-?[A-Z]",
-  scope: "country",
-  country: "ES",
-  entityType: "person",
-  sourceUrl:
-    "https://www.interior.gob.es/opencms/es/servicios-al-ciudadano/tramites-y-gestiones/dni/",
-  examples: ["54362315K"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default dni;
-export {
-  CHECK_LETTERS,
-  compact,
-  format,
-  validate,
-  generate,
-};

package/src/es/mod.ts

@@ -1,5 +0,0 @@
-export { default as cif } from "./cif";
-export { default as dni } from "./dni";
-export { default as nie } from "./nie";
-export { default as nss } from "./nss";
-export { default as vat } from "./vat";

package/src/es/nie.ts

@@ -1,111 +0,0 @@
-/**
- * NIE (Número de Identidad de Extranjero).
- *
- * Spanish foreigner identification number. Starts
- * with X, Y, or Z, followed by 7 digits and a check
- * letter computed using the DNI algorithm.
- *
- * @see https://www.interior.gob.es/opencms/es/servicios-al-ciudadano/tramites-y-gestiones/nie/
- */
-
-import type {
-  ValidateResult,
-  CountryValidator,
-} from "../types";
-import { CHECK_LETTERS } from "./dni";
-
-import { clean } from "#util/clean";
-import { randomDigits, randomPick } from "#util/generate";
-import { err } from "#util/result";
-import { isdigits } from "#util/strings";
-
-const PREFIX_MAP: Record<string, string> = {
-  X: "0",
-  Y: "1",
-  Z: "2",
-};
-
-const compact = (value: string): string =>
-  clean(value, " -").toUpperCase();
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length !== 9) {
-    return err(
-      "INVALID_LENGTH",
-      "NIE must be 9 characters",
-    );
-  }
-
-  const prefix = v.charAt(0);
-  const replacement = PREFIX_MAP[prefix];
-  if (replacement === undefined) {
-    return err(
-      "INVALID_FORMAT",
-      "NIE must start with X, Y, or Z",
-    );
-  }
-
-  const digits = v.slice(1, 8);
-  if (!isdigits(digits)) {
-    return err(
-      "INVALID_FORMAT",
-      "NIE must have 7 digits after prefix",
-    );
-  }
-
-  const letter = v.charAt(8);
-  const num = Number(replacement + digits);
-  const expected = CHECK_LETTERS.charAt(num % 23);
-  if (letter !== expected) {
-    return err(
-      "INVALID_CHECKSUM",
-      "NIE check letter does not match",
-    );
-  }
-
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => compact(value);
-
-const NIE_PREFIXES = ["X", "Y", "Z"] as const;
-const NIE_PREFIX_VALUES: Record<
-  (typeof NIE_PREFIXES)[number],
-  number
-> = { X: 0, Y: 1, Z: 2 };
-
-/** Generate a random valid Spanish NIE. */
-const generate = (): string => {
-  const prefix = randomPick(NIE_PREFIXES);
-  const digits = randomDigits(7);
-  const num =
-    NIE_PREFIX_VALUES[prefix] * 10000000 + Number(digits);
-  return prefix + digits + CHECK_LETTERS.charAt(num % 23);
-};
-
-/** Spanish Foreigner Identification Number. */
-const nie: CountryValidator<"ES"> = {
-  name: "Spanish Foreigner ID",
-  localName: "Número de Identidad de Extranjero",
-  abbreviation: "NIE",
-  aliases: [
-    "N.I.E.",
-    "NIE",
-    "número de identidad de extranjero",
-  ] as const,
-  candidatePattern: "[XYZ]-?\\d{7}-?[A-Z]",
-  scope: "country",
-  country: "ES",
-  entityType: "person",
-  sourceUrl:
-    "https://www.interior.gob.es/opencms/es/servicios-al-ciudadano/tramites-y-gestiones/nie/",
-  examples: ["X5253868R"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default nie;
-export { compact, format, validate, generate };

package/src/es/nss.ts

@@ -1,113 +0,0 @@
-/**
- * NSS (Número de la Seguridad Social).
- *
- * Spanish Social Security Number. 12 digits:
- * 2-digit province code (01–52) + 8-digit affiliate
- * number + 2-digit check digits.
- *
- * Check digits are computed as:
- *   if affiliate < 10_000_000:
- *     (affiliate + province × 10_000_000) mod 97
- *   else:
- *     parseInt(province + affiliate) mod 97
- *
- * @see https://www.seg-social.es/
- * @see https://intervia.com/doc/validar-numeros-de-la-seguridad-social/
- */
-
-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, " -/.");
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length !== 12) {
-    return err(
-      "INVALID_LENGTH",
-      "Spanish NSS must be 12 digits",
-    );
-  }
-  if (!isdigits(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "Spanish NSS must contain only digits",
-    );
-  }
-
-  const province = Number(v.slice(0, 2));
-  if (province < 1 || province > 52) {
-    return err(
-      "INVALID_COMPONENT",
-      "Spanish NSS province code must be 01–52",
-    );
-  }
-
-  const affiliate = Number(v.slice(2, 10));
-  const check = Number(v.slice(10, 12));
-
-  let base: number;
-  if (affiliate < 10_000_000) {
-    base = affiliate + province * 10_000_000;
-  } else {
-    // Concatenate province and affiliate as a number
-    base = Number(`${province}${v.slice(2, 10)}`);
-  }
-
-  const expected = base % 97;
-
-  if (expected !== check) {
-    return err(
-      "INVALID_CHECKSUM",
-      "Spanish NSS check digits do not match",
-    );
-  }
-
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => {
-  const v = compact(value);
-  return `${v.slice(0, 2)}/${v.slice(2, 10)}/${v.slice(10)}`;
-};
-
-/** Generate a random valid Spanish NSS. */
-const generate = (): string => {
-  for (;;) {
-    const c = randomDigits(12);
-    if (validate(c).valid) return c;
-  }
-};
-
-/** Spanish Social Security Number. */
-const nss: CountryValidator<"ES"> = {
-  name: "Spanish Social Security Number",
-  localName: "Número de la Seguridad Social",
-  abbreviation: "NSS",
-  aliases: ["NSS", "número de seguridad social"] as const,
-  candidatePattern: "\\d{12}",
-  scope: "country",
-  country: "ES",
-  entityType: "person",
-  description:
-    "Spanish Social Security affiliation number " +
-    "with mod-97 check digits",
-  sourceUrl: "https://www.seg-social.es/",
-  lengths: [12] as const,
-  examples: ["281234567840"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default nss;
-export { compact, format, validate, generate };