@stll/stdnum 2.1.1 → 2.1.2

package/src/hk/hkid.ts

@@ -1,136 +0,0 @@
-/**
- * HKID (Hong Kong Identity Card number).
- *
- * 1-2 letters + 6 digits + check digit in parentheses.
- * The check digit is computed via a weighted sum mod 11,
- * where letters have values A=10, B=11, ..., Z=35.
- * A remainder of 10 yields check digit 'A'.
- *
- * @see https://en.wikipedia.org/wiki/Hong_Kong_identity_card
- */
-
-import type {
-  ValidateResult,
-  CountryValidator,
-} from "../types";
-
-import { clean } from "#util/clean";
-import { randomDigits, randomInt } from "#util/generate";
-import { err } from "#util/result";
-
-/** Strip spaces, parentheses, and dashes. */
-const compact = (value: string): string =>
-  clean(value, " -()").toUpperCase();
-
-/**
- * Compute the weighted check character.
- *
- * For a two-letter prefix the weights are 9,8,7,6,5,4,3,2
- * over the 8 characters (2 letters + 6 digits). For a
- * single-letter prefix, a space (value 36) is prepended
- * so the weights stay the same.
- */
-const computeCheck = (body: string): string => {
-  const padded = body.length === 7 ? ` ${body}` : body;
-
-  let sum = 0;
-  for (let i = 0; i < 8; i++) {
-    const ch = padded[i];
-    if (ch === undefined) continue;
-    let val: number;
-    if (ch === " ") {
-      val = 36;
-    } else if (ch >= "A" && ch <= "Z") {
-      val = ch.charCodeAt(0) - 55; // A=10
-    } else {
-      val = Number(ch);
-    }
-    sum += val * (9 - i);
-  }
-
-  const remainder = sum % 11;
-  if (remainder === 0) return "0";
-  if (remainder === 1) return "A";
-  return String(11 - remainder);
-};
-
-const HKID_RE = /^[A-Z]{1,2}\d{6}[0-9A]$/;
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length !== 8 && v.length !== 9) {
-    return err(
-      "INVALID_LENGTH",
-      "HKID must be 8 or 9 characters",
-    );
-  }
-  if (!HKID_RE.test(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "HKID must be 1-2 letters, 6 digits, " +
-        "and a check character",
-    );
-  }
-
-  const body = v.slice(0, -1);
-  const check = v.slice(-1);
-  if (computeCheck(body) !== check) {
-    return err(
-      "INVALID_CHECKSUM",
-      "HKID check digit mismatch",
-    );
-  }
-
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => {
-  const v = compact(value);
-  const prefix = v.slice(0, -7);
-  const digits = v.slice(-7, -1);
-  const check = v.slice(-1);
-  return `${prefix}${digits}(${check})`;
-};
-
-/** Generate a random valid HKID. */
-const generate = (): string => {
-  for (;;) {
-    const letter = String.fromCharCode(
-      65 + randomInt(0, 25),
-    );
-    const digits = randomDigits(6);
-    for (let d = 0; d <= 9; d++) {
-      const c = letter + digits + String(d);
-      if (validate(c).valid) return compact(c);
-    }
-    const cA = letter + digits + "A";
-    if (validate(cA).valid) return compact(cA);
-  }
-};
-
-/** Hong Kong Identity Card number. */
-const hkid: CountryValidator<"HK"> = {
-  name: "Hong Kong Identity Card Number",
-  localName: "Hong Kong Identity Card Number",
-  abbreviation: "HKID",
-  aliases: ["HKID", "香港身份證"] as const,
-  candidatePattern: "[A-Z]{1,2}\\d{6}[\\dA]",
-  scope: "country",
-  country: "HK",
-  entityType: "person",
-  lengths: [8, 9],
-  examples: ["G123456A", "AB9876543"],
-  description:
-    "Identity card number issued by the Hong Kong " +
-    "Immigration Department",
-  sourceUrl:
-    "https://en.wikipedia.org/wiki/" +
-    "Hong_Kong_identity_card",
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default hkid;
-export { compact, format, validate, generate };

package/src/hk/mod.ts

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

package/src/hr/mod.ts

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

package/src/hr/vat.ts

@@ -1,83 +0,0 @@
-/**
- * OIB (Croatian VAT number).
- *
- * 11 digits. ISO 7064 Mod 11,10 checksum.
- *
- * @see https://www.vatify.eu/croatia-vat-number.html
- * @see https://www.porezna-uprava.hr/
- */
-
-import type {
-  ValidateResult,
-  CountryValidator,
-} from "../types";
-
-import {
-  mod1110validate,
-  mod1110checkDigit,
-} from "#checksums/mod1110";
-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 => {
-  let v = clean(value, " -/.");
-  if (v.startsWith("HR") || v.startsWith("hr")) {
-    v = v.slice(2);
-  }
-  return v;
-};
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length !== 11) {
-    return err(
-      "INVALID_LENGTH",
-      "Croatian VAT number must be 11 digits",
-    );
-  }
-  if (!isdigits(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "Croatian VAT number must contain only digits",
-    );
-  }
-  if (!mod1110validate(v)) {
-    return err(
-      "INVALID_CHECKSUM",
-      "Croatian VAT number check digit mismatch",
-    );
-  }
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string =>
-  `HR${compact(value)}`;
-
-/** Generate a random valid Croatian OIB. */
-const generate = (): string => {
-  const payload = randomDigits(10);
-  return payload + String(mod1110checkDigit(payload));
-};
-
-/** Croatian VAT Number. */
-const vat: CountryValidator<"HR"> = {
-  name: "Croatian VAT Number",
-  localName: "Osobni identifikacijski broj",
-  abbreviation: "OIB",
-  aliases: ["OIB", "osobni identifikacijski broj"] as const,
-  candidatePattern: "HR\\d{11}",
-  scope: "country",
-  country: "HR",
-  entityType: "any",
-  sourceUrl: "https://www.porezna-uprava.hr/",
-  examples: ["33392005961"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default vat;
-export { compact, format, validate, generate };

package/src/hu/mod.ts

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

package/src/hu/vat.ts

@@ -1,87 +0,0 @@
-/**
- * ANUM (Hungarian VAT number).
- *
- * 8 digits. Weights [9,7,3,1,9,7,3,1],
- * sum % 10 === 0.
- *
- * @see https://www.vatify.eu/hungary-vat-number.html
- * @see https://www.oecd.org/content/dam/oecd/en/topics/policy-issue-focus/aeoi/hungary-tin.pdf
- */
-
-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 = [9, 7, 3, 1, 9, 7, 3, 1];
-
-const compact = (value: string): string => {
-  let v = clean(value, " -/.");
-  if (v.startsWith("HU") || v.startsWith("hu")) {
-    v = v.slice(2);
-  }
-  return v;
-};
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length !== 8) {
-    return err(
-      "INVALID_LENGTH",
-      "Hungarian VAT number must be 8 digits",
-    );
-  }
-  if (!isdigits(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "Hungarian VAT number must contain only digits",
-    );
-  }
-  const sum = weightedSum(v, WEIGHTS, 10);
-  if (sum !== 0) {
-    return err(
-      "INVALID_CHECKSUM",
-      "Hungarian VAT number check digit mismatch",
-    );
-  }
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string =>
-  `HU${compact(value)}`;
-
-/** Generate a random valid Hungarian VAT number. */
-const generate = (): string => {
-  for (;;) {
-    const c = randomDigits(8);
-    if (validate(c).valid) return c;
-  }
-};
-
-/** Hungarian VAT Number. */
-const vat: CountryValidator<"HU"> = {
-  name: "Hungarian VAT Number",
-  localName: "Adószám",
-  abbreviation: "ANUM",
-  aliases: ["adószám", "adóazonosító jel"] as const,
-  candidatePattern: "\\d{8}-\\d-\\d{2}",
-  scope: "country",
-  country: "HU",
-  entityType: "company",
-  sourceUrl: "https://nav.gov.hu/",
-  lengths: [8] as const,
-  examples: ["12892312"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default vat;
-export { compact, format, validate, generate };

package/src/iban.ts

@@ -1,344 +0,0 @@
-/**
- * IBAN (International Bank Account Number).
- *
- * ISO 13616. Format: 2-letter country code +
- * 2 check digits + up to 30 alphanumeric BBAN
- * characters. Validated using ISO 7064 Mod 97-10.
- */
-
-import type {
-  ValidateResult,
-  GlobalValidator,
-} from "./types";
-
-import { mod97 } from "#checksums/mod97";
-import { clean } from "#util/clean";
-import { randomDigits, randomInt } from "#util/generate";
-import { err } from "#util/result";
-import { charValue, isalnum } from "#util/strings";
-
-/**
- * BBAN format regex by country code.
- * Sourced from SWIFT IBAN Registry.
- */
-const BBAN_FORMAT: Record<string, RegExp> = {
-  AD: /^\d{8}[A-Z0-9]{12}$/,
-  AE: /^\d{19}$/,
-  AL: /^\d{8}[A-Z0-9]{16}$/,
-  AT: /^\d{16}$/,
-  AZ: /^[A-Z]{4}[A-Z0-9]{20}$/,
-  BA: /^\d{16}$/,
-  BE: /^\d{12}$/,
-  BG: /^[A-Z]{4}\d{6}[A-Z0-9]{8}$/,
-  BH: /^[A-Z]{4}[A-Z0-9]{14}$/,
-  BR: /^\d{23}[A-Z]{1}[A-Z0-9]{1}$/,
-  BY: /^[A-Z0-9]{4}\d{20}$/,
-  CH: /^\d{17}$/,
-  CR: /^0\d{17}$/,
-  CY: /^\d{8}[A-Z0-9]{16}$/,
-  CZ: /^\d{20}$/,
-  DE: /^\d{18}$/,
-  DK: /^\d{14}$/,
-  DO: /^[A-Z0-9]{4}\d{20}$/,
-  EE: /^\d{16}$/,
-  EG: /^\d{25}$/,
-  ES: /^\d{20}$/,
-  FI: /^\d{14}$/,
-  FO: /^\d{14}$/,
-  FR: /^\d{10}[A-Z0-9]{11}\d{2}$/,
-  GB: /^[A-Z]{4}\d{14}$/,
-  GE: /^[A-Z]{2}\d{16}$/,
-  GI: /^[A-Z]{4}[A-Z0-9]{15}$/,
-  GL: /^\d{14}$/,
-  GR: /^\d{7}[A-Z0-9]{16}$/,
-  GT: /^[A-Z0-9]{24}$/,
-  HR: /^\d{17}$/,
-  HU: /^\d{24}$/,
-  IE: /^[A-Z]{4}\d{14}$/,
-  IL: /^\d{19}$/,
-  IQ: /^[A-Z]{4}\d{15}$/,
-  IS: /^\d{22}$/,
-  IT: /^[A-Z]\d{10}[A-Z0-9]{12}$/,
-  JO: /^[A-Z]{4}\d{22}$/,
-  KW: /^[A-Z]{4}[A-Z0-9]{22}$/,
-  KZ: /^\d{16}$/,
-  LB: /^\d{4}[A-Z0-9]{20}$/,
-  LC: /^[A-Z]{4}[A-Z0-9]{24}$/,
-  LI: /^\d{17}$/,
-  LT: /^\d{16}$/,
-  LU: /^\d{16}$/,
-  LV: /^[A-Z]{4}[A-Z0-9]{13}$/,
-  MC: /^\d{10}[A-Z0-9]{11}\d{2}$/,
-  MD: /^[A-Z0-9]{20}$/,
-  ME: /^\d{18}$/,
-  MK: /^\d{3}[A-Z0-9]{10}\d{2}$/,
-  MR: /^\d{23}$/,
-  MT: /^[A-Z]{4}\d{5}[A-Z0-9]{18}$/,
-  MU: /^[A-Z]{4}\d{19}[A-Z]{3}$/,
-  NI: /^[A-Z]{4}\d{24}$/,
-  NL: /^[A-Z]{4}\d{10}$/,
-  NO: /^\d{11}$/,
-  PK: /^[A-Z]{4}[A-Z0-9]{16}$/,
-  PL: /^\d{24}$/,
-  PS: /^[A-Z]{4}[A-Z0-9]{21}$/,
-  PT: /^\d{21}$/,
-  QA: /^[A-Z]{4}[A-Z0-9]{21}$/,
-  RO: /^[A-Z]{4}[A-Z0-9]{16}$/,
-  RS: /^\d{18}$/,
-  SA: /^\d{20}$/,
-  SC: /^[A-Z]{4}\d{20}[A-Z]{3}$/,
-  SD: /^\d{14}$/,
-  SE: /^\d{20}$/,
-  SI: /^\d{15}$/,
-  SK: /^\d{20}$/,
-  SM: /^[A-Z]\d{10}[A-Z0-9]{12}$/,
-  ST: /^\d{21}$/,
-  SV: /^[A-Z]{4}\d{20}$/,
-  TL: /^\d{19}$/,
-  TN: /^\d{20}$/,
-  TR: /^\d{6}[A-Z0-9]{16}$/,
-  UA: /^\d{6}[A-Z0-9]{19}$/,
-  VA: /^\d{18}$/,
-  VG: /^[A-Z]{4}\d{16}$/,
-  XK: /^\d{16}$/,
-};
-
-/** IBAN total length by country code. */
-const LENGTHS: Record<string, number> = {
-  AD: 24,
-  AE: 23,
-  AL: 28,
-  AT: 20,
-  AZ: 28,
-  BA: 20,
-  BE: 16,
-  BG: 22,
-  BH: 22,
-  BI: 27,
-  BR: 29,
-  BY: 28,
-  CH: 21,
-  CR: 22,
-  CY: 28,
-  CZ: 24,
-  DE: 22,
-  DJ: 27,
-  DK: 18,
-  DO: 28,
-  EE: 20,
-  EG: 29,
-  ES: 24,
-  FI: 18,
-  FO: 18,
-  FR: 27,
-  GB: 22,
-  GE: 22,
-  GI: 23,
-  GL: 18,
-  GR: 27,
-  GT: 28,
-  HR: 21,
-  HU: 28,
-  IE: 22,
-  IL: 23,
-  IQ: 23,
-  IS: 26,
-  IT: 27,
-  JO: 30,
-  KW: 30,
-  KZ: 20,
-  LB: 28,
-  LC: 32,
-  LI: 21,
-  LT: 20,
-  LU: 20,
-  LV: 21,
-  LY: 25,
-  MC: 27,
-  MD: 24,
-  ME: 22,
-  MK: 19,
-  MN: 20,
-  MR: 27,
-  MT: 31,
-  MU: 30,
-  NI: 28,
-  NL: 18,
-  NO: 15,
-  PK: 24,
-  PL: 28,
-  PS: 29,
-  PT: 25,
-  QA: 29,
-  RO: 24,
-  RS: 22,
-  RU: 33,
-  SA: 24,
-  SC: 31,
-  SD: 18,
-  SE: 24,
-  SI: 19,
-  SK: 24,
-  SM: 27,
-  SN: 28,
-  SO: 23,
-  ST: 25,
-  SV: 28,
-  TL: 23,
-  TN: 24,
-  TR: 26,
-  UA: 29,
-  VA: 22,
-  VG: 24,
-  XK: 20,
-};
-
-const compact = (value: string): string =>
-  clean(value, " -").toUpperCase();
-
-/**
- * Convert letters to numbers (A=10, ..., Z=35)
- * and rearrange for mod-97 check.
- */
-const toNumeric = (iban: string): string => {
-  const rearranged = iban.slice(4) + iban.slice(0, 4);
-  let result = "";
-  for (let i = 0; i < rearranged.length; i++) {
-    const ch = rearranged[i];
-    if (ch !== undefined) {
-      result += String(charValue(ch));
-    }
-  }
-  return result;
-};
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length < 5) {
-    return err("INVALID_LENGTH", "IBAN is too short");
-  }
-  if (!isalnum(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "IBAN must contain only letters and digits",
-    );
-  }
-  const cc = v.slice(0, 2);
-  if (!/^[A-Z]{2}$/.test(cc)) {
-    return err(
-      "INVALID_COMPONENT",
-      "IBAN must start with a 2-letter country code",
-    );
-  }
-  const expectedLen = LENGTHS[cc];
-  if (
-    expectedLen !== undefined &&
-    v.length !== expectedLen
-  ) {
-    return err(
-      "INVALID_LENGTH",
-      `IBAN for ${cc} must be ${String(expectedLen)} characters`,
-    );
-  }
-  // Validate BBAN format (country-specific)
-  const bban = v.slice(4);
-  const bbanRegex = BBAN_FORMAT[cc];
-  if (bbanRegex !== undefined && !bbanRegex.test(bban)) {
-    return err(
-      "INVALID_FORMAT",
-      `IBAN BBAN format is invalid for ${cc}`,
-    );
-  }
-  const numeric = toNumeric(v);
-  if (mod97(numeric) !== 1) {
-    return err(
-      "INVALID_CHECKSUM",
-      "IBAN check digits are incorrect",
-    );
-  }
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => {
-  const v = compact(value);
-  const groups: string[] = [];
-  for (let i = 0; i < v.length; i += 4) {
-    groups.push(v.slice(i, i + 4));
-  }
-  return groups.join(" ");
-};
-
-/**
- * Countries supported by generate(). All have
- * all-digit BBANs for simplicity.
- */
-const GENERATE_COUNTRIES = ["CZ", "DE", "SK"] as const;
-
-type GenerateCountry = (typeof GENERATE_COUNTRIES)[number];
-
-/** BBAN lengths for generate()-supported countries. */
-const BBAN_LENGTHS: Record<GenerateCountry, number> = {
-  CZ: 20,
-  DE: 18,
-  SK: 20,
-};
-
-/**
- * Compute IBAN check digits for a country code
- * and BBAN. Returns a 2-character string.
- */
-const computeCheckDigits = (
-  cc: string,
-  bban: string,
-): string => {
-  const placeholder = `${bban}${cc}00`;
-  let numeric = "";
-  for (let i = 0; i < placeholder.length; i++) {
-    const ch = placeholder[i];
-    if (ch !== undefined) {
-      numeric += String(charValue(ch));
-    }
-  }
-  const remainder = mod97(numeric);
-  const check = 98 - remainder;
-  return String(check).padStart(2, "0");
-};
-
-/**
- * Generate a random valid IBAN for CZ, DE, or SK.
- */
-const generate = (): string => {
-  const idx = randomInt(0, GENERATE_COUNTRIES.length - 1);
-  const cc = GENERATE_COUNTRIES[idx] as GenerateCountry;
-  const bbanLen = BBAN_LENGTHS[cc];
-  const bban = randomDigits(bbanLen);
-  const checkDigits = computeCheckDigits(cc, bban);
-  return `${cc}${checkDigits}${bban}`;
-};
-
-/** International Bank Account Number. */
-const iban: GlobalValidator = {
-  scope: "global",
-  name: "IBAN",
-  localName: "IBAN",
-  abbreviation: "IBAN",
-  aliases: ["IBAN"] as const,
-  candidatePattern:
-    "[A-Z]{2}\\d{2}[\\s]?[A-Z0-9]{4}[\\s]?(?:[A-Z0-9]{4}[\\s]?){2,7}[A-Z0-9]{1,4}",
-  entityType: "any",
-  description:
-    "International bank account number per ISO 13616",
-  sourceUrl:
-    "https://www.swift.com/standards/data-standards/iban-international-bank-account-number",
-  examples: [
-    "GB29NWBK60161331926819",
-    "DE89370400440532013000",
-  ] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default iban;
-export { compact, format, generate, validate };

package/src/id/mod.ts

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