@stll/stdnum 2.1.1 → 2.1.3

package/src/crypto/wallet.ts

@@ -1,67 +0,0 @@
-/**
- * Cryptocurrency wallet address.
- *
- * Convenience validator for supported wallet address
- * families. Use the specific validators when the
- * network or format must be known.
- */
-
-import type {
-  GlobalValidator,
-  ValidateResult,
-} from "../types";
-import btcBase58 from "./btcbase58";
-import btcBech32 from "./btcbech32";
-import eth from "./eth";
-
-const validators = [eth, btcBech32, btcBase58] as const;
-
-const compact = (value: string): string => {
-  for (const validator of validators) {
-    const result = validator.validate(value);
-    if (result.valid) return result.compact;
-  }
-  return value.trim();
-};
-
-const validate = (value: string): ValidateResult => {
-  for (const validator of validators) {
-    const result = validator.validate(value);
-    if (result.valid) return result;
-  }
-  return {
-    valid: false,
-    error: {
-      code: "INVALID_FORMAT",
-      message: "Unsupported cryptocurrency wallet address",
-    },
-  };
-};
-
-const format = (value: string): string => compact(value);
-
-const wallet: GlobalValidator = {
-  scope: "global",
-  name: "Cryptocurrency Wallet Address",
-  localName: "Cryptocurrency Wallet Address",
-  abbreviation: "crypto",
-  aliases: [
-    "crypto address",
-    "wallet address",
-    "cryptocurrency wallet",
-  ] as const,
-  candidatePattern:
-    "(?:0x[0-9A-Fa-f]{40}|[13][1-9A-HJ-NP-Za-km-z]{25,34}|bc1[ac-hj-np-z02-9]{11,71}|BC1[AC-HJ-NP-Z02-9]{11,71})",
-  entityType: "any",
-  examples: [
-    "0xde709f2102306220921060314715629080e2fb77",
-    "1BoatSLRHtKNngkdXEeobR76b53LETtpyT",
-    "bc1qw508d6qejxtdg4y5r3zarvary0c5xw7kv8f3t4",
-  ] as const,
-  compact,
-  format,
-  validate,
-};
-
-export default wallet;
-export { compact, format, validate };

package/src/cu/mod.ts

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

package/src/cu/ni.ts

@@ -1,146 +0,0 @@
-/**
- * NI (Número de Identidad, Cuban identity card number).
- *
- * 11 digits encoding birth date, century, sequence, and
- * gender. Structure: YYMMDDXNNNN where:
- *   - YYMMDD = birth date
- *   - X = century digit (9=1800s, 0-5=1900s, 6-8=2000s)
- *   - NNNN = sequence (digit at position 9 encodes gender:
- *     even=male, odd=female)
- *
- * No check digit; validation is by date and format only.
- *
- * Ported from python-stdnum cu.ni module.
- *
- * @see https://www.ecured.cu/Carnet_de_Identidad
- */
-
-import type {
-  ParsedPersonId,
-  ValidateResult,
-  CountryValidator,
-} from "../types";
-
-import { clean } from "#util/clean";
-import { isValidDate } from "#util/date";
-import { randomDigits, randomInt } from "#util/generate";
-import { err } from "#util/result";
-
-const compact = (value: string): string =>
-  clean(value, " -").trim();
-
-/**
- * Derive the full birth year from the two-digit year
- * and the century indicator at position 6.
- */
-const centuryOffset = (digit: string): number => {
-  if (digit === "9") return 1800;
-  if (digit >= "0" && digit <= "5") return 1900;
-  return 2000;
-};
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-
-  if (v.length !== 11) {
-    return err(
-      "INVALID_LENGTH",
-      "Cuban NI must be 11 digits",
-    );
-  }
-
-  if (!/^\d{11}$/.test(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "Cuban NI must contain only digits",
-    );
-  }
-
-  const yy = Number(v.slice(0, 2));
-  const mm = Number(v.slice(2, 4));
-  const dd = Number(v.slice(4, 6));
-  // SAFETY: regex check above guarantees v.length === 11.
-  // eslint-disable-next-line no-non-null-assertion
-  const year = centuryOffset(v[6]!) + yy;
-
-  if (!isValidDate(year, mm, dd)) {
-    return err(
-      "INVALID_COMPONENT",
-      "Cuban NI contains an invalid birth date",
-    );
-  }
-
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => compact(value);
-
-/**
- * Extract birth date and gender from a Cuban NI.
- * 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 yy = Number(v.slice(0, 2));
-  const mm = Number(v.slice(2, 4));
-  const dd = Number(v.slice(4, 6));
-  // SAFETY: regex check above guarantees v.length === 11.
-  // eslint-disable-next-line no-non-null-assertion
-  const year = centuryOffset(v[6]!) + yy;
-
-  const genderDigit = Number(v[9]);
-  const gender: "male" | "female" =
-    genderDigit % 2 === 0 ? "male" : "female";
-
-  return {
-    birthDate: new Date(year, mm - 1, dd),
-    gender,
-  };
-};
-
-/** Generate a random valid Cuban NI. */
-const generate = (): string => {
-  const year = randomInt(1950, 2024);
-  const month = String(randomInt(1, 12)).padStart(2, "0");
-  const day = String(randomInt(1, 28)).padStart(2, "0");
-  const yy = String(year % 100).padStart(2, "0");
-  const century =
-    year >= 2000
-      ? String(randomInt(6, 8))
-      : String(randomInt(0, 5));
-  return `${yy}${month}${day}${century}${randomDigits(4)}`;
-};
-
-/**
- * Cuban identity card number (NI).
- *
- * Examples sourced from python-stdnum test suite.
- */
-const ni: CountryValidator<"CU", ParsedPersonId> = {
-  name: "Cuban Identity Card Number",
-  localName: "Número de Identidad",
-  abbreviation: "NI",
-  aliases: [
-    "NI",
-    "número de identidad",
-    "carnet de identidad",
-  ] as const,
-  candidatePattern: "\\d{11}",
-  scope: "country",
-  country: "CU",
-  entityType: "person",
-  lengths: [11] as const,
-  examples: ["91021027775", "72062506561"] as const,
-  compact,
-  format,
-  parse,
-  validate,
-  generate,
-  sourceUrl: "https://www.ecured.cu/Carnet_de_Identidad",
-};
-
-export default ni;
-export { compact, format, generate, parse, validate };

package/src/cy/mod.ts

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

package/src/cy/vat.ts

@@ -1,134 +0,0 @@
-/**
- * ΦΠΑ (Cypriot VAT number).
- *
- * 8 digits + 1 check letter. Cannot start with "12".
- *
- * @see https://www.vatify.eu/cyprus-vat-number.html
- * @see https://www.oecd.org/content/dam/oecd/en/topics/policy-issue-focus/aeoi/cyprus-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";
-
-const ODD_MAP: Record<number, number> = {
-  0: 1,
-  1: 0,
-  2: 5,
-  3: 7,
-  4: 9,
-  5: 13,
-  6: 15,
-  7: 17,
-  8: 19,
-  9: 21,
-};
-
-const LETTERS = "ABCDEFGHIJKLMNOPQRSTUVWXYZ";
-
-const compact = (value: string): string => {
-  let v = clean(value, " -/.");
-  if (v.startsWith("CY") || v.startsWith("cy")) {
-    v = v.slice(2);
-  }
-  return v.toUpperCase();
-};
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length !== 9) {
-    return err(
-      "INVALID_LENGTH",
-      "Cypriot VAT number must be 8 digits + 1 letter",
-    );
-  }
-  const digits = v.slice(0, 8);
-  const checkLetter = v[8];
-  if (!isdigits(digits)) {
-    return err(
-      "INVALID_FORMAT",
-      "Cypriot VAT number must start with 8 digits",
-    );
-  }
-  if (
-    checkLetter === undefined ||
-    !LETTERS.includes(checkLetter)
-  ) {
-    return err(
-      "INVALID_FORMAT",
-      "Cypriot VAT number must end with a letter",
-    );
-  }
-  if (v.startsWith("12")) {
-    return err(
-      "INVALID_COMPONENT",
-      "Cypriot VAT number cannot start with 12",
-    );
-  }
-  let odd = 0;
-  let even = 0;
-  for (let i = 0; i < 8; i++) {
-    const d = Number(digits.charAt(i));
-    if (i % 2 === 0) {
-      // Odd position (1-indexed: 1,3,5,7)
-      odd += ODD_MAP[d] ?? 0;
-    } else {
-      // Even position (1-indexed: 2,4,6,8)
-      even += d;
-    }
-  }
-  const expected = LETTERS.charAt((odd + even) % 26);
-  if (checkLetter !== expected) {
-    return err(
-      "INVALID_CHECKSUM",
-      "Cypriot VAT number check letter mismatch",
-    );
-  }
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string =>
-  `CY${compact(value)}`;
-
-/** Generate a random valid Cypriot VAT number. */
-const generate = (): string => {
-  for (;;) {
-    const digits = randomDigits(8);
-    if (digits.startsWith("12")) continue;
-    let odd = 0;
-    let even = 0;
-    for (let i = 0; i < 8; i++) {
-      const d = Number(digits.charAt(i));
-      if (i % 2 === 0) odd += ODD_MAP[d] ?? 0;
-      else even += d;
-    }
-    return digits + LETTERS.charAt((odd + even) % 26);
-  }
-};
-
-/** Cypriot VAT Number. */
-const vat: CountryValidator<"CY"> = {
-  name: "Cypriot VAT Number",
-  localName: "Αριθμός Εγγραφής Φ.Π.Α.",
-  abbreviation: "ΦΠΑ",
-  aliases: ["ΦΠΑ", "VAT CY"] as const,
-  candidatePattern: "CY\\d{8}[A-Z]",
-  scope: "country",
-  country: "CY",
-  entityType: "company",
-  sourceUrl: "https://www.mof.gov.cy/",
-  examples: ["10259033P"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default vat;
-export { compact, format, validate, generate };

package/src/cz/dic.ts

@@ -1,140 +0,0 @@
-/**
- * DIČ (Daňové identifikační číslo).
- *
- * Czech tax identification number / VAT number.
- * Format: "CZ" prefix + 8, 9, or 10 digits.
- * - 8 digits: company (same checksum as IČO,
- *   but first digit cannot be 9)
- * - 9 digits starting with 6: special entity
- * - 9-10 digits: individual (birth number)
- *
- * @see https://adisspr.mfcr.cz/dpr/DphReg
- */
-
-import type {
-  ValidateResult,
-  CountryValidator,
-} from "../types";
-import { validate as validateRc } from "./rc";
-
-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";
-
-const ICO_WEIGHTS = [8, 7, 6, 5, 4, 3, 2] as const;
-
-const compact = (value: string): string => {
-  const v = clean(value, " -");
-  if (v.startsWith("CZ") || v.startsWith("cz")) {
-    return v.slice(2);
-  }
-  return v;
-};
-
-const checkLegal = (value: string): boolean => {
-  const sum = weightedSum(
-    value.slice(0, 7),
-    ICO_WEIGHTS,
-    11,
-  );
-  const v11 = (11 - sum) % 11;
-  const check = v11 === 0 ? 1 : v11 % 10;
-  return check === Number(value[7]);
-};
-
-const checkSpecial = (value: string): boolean => {
-  // Skip the leading "6"; check digits 1..7
-  const sum = weightedSum(
-    value.slice(1, 8),
-    [8, 7, 6, 5, 4, 3, 2],
-    11,
-  );
-  const check =
-    (((8 - ((((10 - sum) % 11) + 11) % 11)) % 10) + 10) %
-    10;
-  return check === Number(value[8]);
-};
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length < 8 || v.length > 10) {
-    return err(
-      "INVALID_LENGTH",
-      "DIČ must be 8-10 digits (without CZ prefix)",
-    );
-  }
-  if (!isdigits(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "DIČ must contain only digits",
-    );
-  }
-
-  // 8-digit: legal entity (IČO-like checksum)
-  if (v.length === 8) {
-    if (v[0] === "9") {
-      return err(
-        "INVALID_COMPONENT",
-        "8-digit DIČ cannot start with 9",
-      );
-    }
-    if (!checkLegal(v)) {
-      return err(
-        "INVALID_CHECKSUM",
-        "DIČ check digit does not match",
-      );
-    }
-    return { valid: true, compact: v };
-  }
-
-  // 9-digit starting with 6: special entity
-  if (v.length === 9 && v[0] === "6") {
-    if (!checkSpecial(v)) {
-      return err(
-        "INVALID_CHECKSUM",
-        "DIČ special entity check digit mismatch",
-      );
-    }
-    return { valid: true, compact: v };
-  }
-
-  // 9-10 digit: birth number
-  return validateRc(v);
-};
-
-const format = (value: string): string =>
-  `CZ${compact(value)}`;
-
-/** Generate a random valid 8-digit DIČ. */
-const generate = (): string => {
-  const first = String(randomInt(1, 8));
-  const payload = first + randomDigits(6);
-  const sum = weightedSum(payload, ICO_WEIGHTS, 11);
-  const v11 = (11 - sum) % 11;
-  const check = v11 === 0 ? 1 : v11 % 10;
-  return payload + String(check);
-};
-
-/** Czech VAT Number. */
-const dic: CountryValidator<"CZ"> = {
-  name: "Czech VAT Number",
-  localName: "Daňové identifikační číslo",
-  abbreviation: "DIČ",
-  aliases: ["DIČ", "daňové identifikační číslo"] as const,
-  candidatePattern: "CZ\\d{8,10}",
-  scope: "country",
-  country: "CZ",
-  entityType: "any",
-  sourceUrl: "https://adisspr.mfcr.cz/dpr/DphReg",
-  lengths: [8, 9, 10] as const,
-  examples: ["25123891", "7103192745"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default dic;
-export { compact, format, validate, generate };

package/src/cz/ico.ts

@@ -1,86 +0,0 @@
-/**
- * IČO (Identifikační číslo osoby).
- *
- * Czech company identification number. 8 digits
- * with a weighted checksum. Assigned by the Czech
- * Statistical Office.
- *
- * @see https://www.czso.cz/
- */
-
-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 = [8, 7, 6, 5, 4, 3, 2] as const;
-
-const compact = (value: string): string =>
-  clean(value, " -");
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length !== 8) {
-    return err(
-      "INVALID_LENGTH",
-      "IČO must be exactly 8 digits",
-    );
-  }
-  if (!isdigits(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "IČO must contain only digits",
-    );
-  }
-  const sum = weightedSum(v.slice(0, 7), WEIGHTS, 11);
-  const v11 = (11 - sum) % 11;
-  const check = v11 === 0 ? 1 : v11 % 10;
-  if (check !== Number(v[7])) {
-    return err(
-      "INVALID_CHECKSUM",
-      "IČO check digit does not match",
-    );
-  }
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => compact(value);
-
-/** Generate a random valid ICO. */
-const generate = (): string => {
-  const payload = randomDigits(7);
-  const sum = weightedSum(payload, WEIGHTS, 11);
-  const v11 = (11 - sum) % 11;
-  const check = v11 === 0 ? 1 : v11 % 10;
-  return `${payload}${String(check)}`;
-};
-
-/** Czech Company Identification Number. */
-const ico: CountryValidator<"CZ"> = {
-  name: "Czech Company ID",
-  localName: "Identifikační číslo osoby",
-  abbreviation: "IČO",
-  aliases: ["IČO", "IČ", "identifikační číslo"] as const,
-  candidatePattern: "\\d{8}",
-  scope: "country",
-  country: "CZ",
-  entityType: "company",
-  description:
-    "8-digit company ID assigned by the Czech Statistical Office",
-  sourceUrl: "https://www.czso.cz/",
-  lengths: [8] as const,
-  examples: ["25123891", "27074358"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default ico;
-export { compact, format, generate, validate };

package/src/cz/mod.ts

@@ -1,3 +0,0 @@
-export { default as dic } from "./dic";
-export { default as ico } from "./ico";
-export { default as rc } from "./rc";