@stll/stdnum 2.1.0 → 2.1.2

package/src/au/tfn.ts

@@ -1,89 +0,0 @@
-/**
- * TFN (Australian Tax File Number).
- *
- * 8 or 9 digit identifier. Weighted checksum with
- * weights [1,4,3,7,5,8,6,9,10]; sum mod 11
- * must equal 0.
- *
- * @see https://en.wikipedia.org/wiki/Tax_file_number
- * @see https://www.ato.gov.au/Individuals/Tax-file-number/
- */
-
-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 = [1, 4, 3, 7, 5, 8, 6, 9, 10] as const;
-
-const compact = (value: string): string =>
-  clean(value, " -");
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (!isdigits(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "TFN must contain only digits",
-    );
-  }
-  if (v.length !== 8 && v.length !== 9) {
-    return err(
-      "INVALID_LENGTH",
-      "TFN must be 8 or 9 digits",
-    );
-  }
-
-  let sum = 0;
-  for (let i = 0; i < v.length; i++) {
-    sum += Number(v.charAt(i)) * (WEIGHTS[i] ?? 0);
-  }
-  if (sum % 11 !== 0) {
-    return err("INVALID_CHECKSUM", "TFN checksum mismatch");
-  }
-
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => {
-  const v = compact(value);
-  if (v.length === 8 || v.length === 9) {
-    return `${v.slice(0, 3)} ${v.slice(3, 6)} ${v.slice(6)}`;
-  }
-  return v;
-};
-
-/** Generate a random valid TFN. */
-const generate = (): string => {
-  for (;;) {
-    const c = randomDigits(9);
-    if (validate(c).valid) return c;
-  }
-};
-
-/** Australian Tax File Number. */
-const tfn: CountryValidator<"AU"> = {
-  name: "Tax File Number",
-  localName: "Tax File Number",
-  abbreviation: "TFN",
-  aliases: ["TFN", "Tax File Number"] as const,
-  candidatePattern: "\\d{8,9}",
-  scope: "country",
-  country: "AU",
-  entityType: "person",
-  sourceUrl:
-    "https://www.ato.gov.au/individuals-and-families/tax-file-number",
-  examples: ["87650006", "123456782"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default tfn;
-export { compact, format, validate, generate };

package/src/az/mod.ts

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

package/src/az/voen.ts

@@ -1,131 +0,0 @@
-/**
- * VÖEN (Vergi Ödəyicisinin Eyniləşdirmə Nömrəsi,
- * Azerbaijani tax identification number).
- *
- * 10 digits: TTSSSSSSCD where:
- *   - TT = territorial unit code
- *   - SSSSSS = serial number
- *   - C = check digit (weighted sum mod 11)
- *   - D = legal status (1=legal person, 2=natural person)
- *
- * Ported from python-stdnum az.voen module.
- *
- * @see https://www.taxes.gov.az/
- */
-
-import type {
-  ValidateResult,
-  CountryValidator,
-} from "../types";
-
-import { clean } from "#util/clean";
-import { randomDigits } from "#util/generate";
-import { err } from "#util/result";
-
-/** Weights for check digit computation (positions 0-7). */
-const WEIGHTS = [4, 1, 8, 6, 2, 7, 5, 3] as const;
-
-/**
- * Compact: strip spaces, prepend '0' if 9 digits.
- */
-const compact = (value: string): string => {
-  let number = clean(value, " ").trim();
-  if (number.length === 9) {
-    number = "0" + number;
-  }
-  return number;
-};
-
-/**
- * Calculate the check digit (position 8) using
- * weighted sum of the first 8 digits mod 11.
- */
-const calcCheckDigit = (value: string): string | null => {
-  let sum = 0;
-  for (let i = 0; i < 8; i++) {
-    sum += (WEIGHTS[i] ?? 0) * Number(value.charAt(i));
-  }
-  const result = sum % 11;
-  return result === 10 ? null : String(result);
-};
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-
-  if (v.length !== 10) {
-    return err(
-      "INVALID_LENGTH",
-      "Azerbaijani VÖEN must be 10 digits",
-    );
-  }
-
-  if (!/^\d{10}$/.test(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "Azerbaijani VÖEN must contain only digits",
-    );
-  }
-
-  // SAFETY: regex above guarantees length === 10.
-  // eslint-disable-next-line no-non-null-assertion
-  const lastDigit = v[9]!;
-  if (lastDigit !== "1" && lastDigit !== "2") {
-    return err(
-      "INVALID_COMPONENT",
-      "VÖEN last digit must be 1 or 2",
-    );
-  }
-
-  const expected = calcCheckDigit(v);
-  if (expected === null || v[8] !== expected) {
-    return err(
-      "INVALID_CHECKSUM",
-      "VÖEN check digit does not match",
-    );
-  }
-
-  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, 10)}`;
-};
-
-/** Generate a random valid VOEN. */
-const generate = (): string => {
-  for (let i = 0; i < 100; i++) {
-    const payload = randomDigits(8);
-    const check = calcCheckDigit(payload);
-    if (check === null) continue;
-    const status = Math.random() < 0.5 ? "1" : "2";
-    return payload + check + status;
-  }
-  throw new Error("Failed to generate valid VOEN");
-};
-
-/**
- * Azerbaijani tax identification number (VÖEN).
- *
- * Examples sourced from python-stdnum test suite.
- */
-const voen: CountryValidator<"AZ"> = {
-  name: "Azerbaijani Tax ID",
-  localName: "Vergi Ödəyicisinin Eyniləşdirmə Nömrəsi",
-  abbreviation: "VÖEN",
-  aliases: ["VÖEN"] as const,
-  candidatePattern: "\\d{10}",
-  scope: "country",
-  country: "AZ",
-  entityType: "any",
-  lengths: [10] as const,
-  examples: ["1401555071", "1400057421"] as const,
-  compact,
-  format,
-  validate,
-  sourceUrl: "https://www.taxes.gov.az/",
-  generate,
-};
-
-export default voen;
-export { compact, format, validate, generate };

package/src/ba/jmbg.ts

@@ -1,130 +0,0 @@
-/**
- * JMBG (Jedinstveni matični broj građana).
- *
- * Bosnian unique master citizen number. 13 digits
- * encoding DDMMYYY (7-digit birth year), region code,
- * serial number, and a check digit.
- *
- * @see https://en.wikipedia.org/wiki/Unique_Master_Citizen_Number
- */
-
-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 = [
-  7, 6, 5, 4, 3, 2, 7, 6, 5, 4, 3, 2,
-] as const;
-
-const compact = (value: string): string =>
-  clean(value, " -");
-
-const resolveYear = (yyy: number): number =>
-  yyy < 900 ? yyy + 2000 : yyy + 1000;
-
-const calcCheckDigit = (v: string): number => {
-  const total = weightedSum(v.slice(0, 12), WEIGHTS, 11);
-  return ((11 - total) % 11) % 10;
-};
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length !== 13) {
-    return err(
-      "INVALID_LENGTH",
-      "JMBG must be exactly 13 digits",
-    );
-  }
-  if (!isdigits(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "JMBG must contain only digits",
-    );
-  }
-
-  const dd = Number(v.slice(0, 2));
-  const mm = Number(v.slice(2, 4));
-  const yyyy = resolveYear(Number(v.slice(4, 7)));
-  if (!isValidDate(yyyy, mm, dd)) {
-    return err(
-      "INVALID_COMPONENT",
-      "JMBG contains an invalid date",
-    );
-  }
-
-  if (calcCheckDigit(v) !== Number(v[12])) {
-    return err(
-      "INVALID_CHECKSUM",
-      "JMBG check digit does not match",
-    );
-  }
-
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => compact(value);
-
-const parse = (value: string): ParsedPersonId | null => {
-  const result = validate(value);
-  if (!result.valid) return null;
-
-  const v = result.compact;
-  const dd = Number(v.slice(0, 2));
-  const mm = Number(v.slice(2, 4));
-  const yyyy = resolveYear(Number(v.slice(4, 7)));
-
-  const serial = Number(v.slice(9, 12));
-
-  return {
-    birthDate: new Date(yyyy, mm - 1, dd),
-    gender: serial < 500 ? "male" : "female",
-  };
-};
-
-/** Generate a random valid JMBG. */
-const generate = (): string => {
-  for (;;) {
-    const dd = String(randomInt(1, 28)).padStart(2, "0");
-    const mm = String(randomInt(1, 12)).padStart(2, "0");
-    const yyy = String(randomInt(900, 999));
-    const rr = String(randomInt(10, 99));
-    const sss = String(randomInt(0, 999)).padStart(3, "0");
-    const partial = dd + mm + yyy + rr + sss;
-    const check = calcCheckDigit(partial);
-    const c = partial + String(check);
-    if (validate(c).valid) return c;
-  }
-};
-
-/** Bosnian Unique Master Citizen Number. */
-const jmbg: CountryValidator<"BA", ParsedPersonId> = {
-  name: "Bosnian Personal ID",
-  localName: "Jedinstveni matični broj građana",
-  abbreviation: "JMBG",
-  aliases: ["JMBG", "matični broj"] as const,
-  candidatePattern: "\\d{13}",
-  scope: "country",
-  country: "BA",
-  entityType: "person",
-  lengths: [13] as const,
-  sourceUrl:
-    "https://www.oecd.org/tax/automatic-exchange/crs-implementation-and-assistance/tax-identification-numbers/",
-  examples: ["0101006500006"] as const,
-  compact,
-  format,
-  parse,
-  validate,
-  generate,
-};
-
-export default jmbg;
-export { compact, format, parse, validate, generate };

package/src/ba/mod.ts

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

package/src/bd/mod.ts

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

package/src/bd/nid.ts

@@ -1,143 +0,0 @@
-const RMO_VALUES = ["1", "2", "3", "4", "5", "9"] as const;
-
-/** Generate a random valid Bangladesh NID (13-digit). */
-const generate = (): string => {
-  const district = randomDigits(2);
-  const rmo = randomPick(RMO_VALUES);
-  const rest = randomDigits(10);
-  return `${district}${rmo}${rest}`;
-};
-
-/**
- * NID (জাতীয় পরিচয়পত্র, Bangladesh National ID).
- *
- * Two formats exist:
- * - 13 digits (old): DD-R-PP-UU-SSSSSS where
- *   DD = district, R = residential type (RMO),
- *   PP = police station, UU = union/ward code,
- *   SSSSSS = serial number.
- * - 17 digits (new): YYYY + 13-digit old format
- *   where YYYY is the year of birth.
- * - 10 digits (smart card): a newer format issued
- *   on smart NID cards; no public structural spec
- *   beyond digit-only validation.
- *
- * No checksum algorithm is used. Validation is
- * structural: length, digit-only, and a valid
- * RMO code (residential type).
- *
- * @see https://en.wikipedia.org/wiki/National_identity_card_(Bangladesh)
- * @see https://www.nidw.gov.bd/
- */
-
-import type {
-  ValidateResult,
-  CountryValidator,
-} from "../types";
-
-import { clean } from "#util/clean";
-import { randomDigits, randomPick } from "#util/generate";
-import { err } from "#util/result";
-import { isdigits } from "#util/strings";
-
-/**
- * Valid RMO (residential/municipal/other) codes.
- * 1 = Rural, 2 = Municipality, 3 = City,
- * 4 = Others, 5 = Cantonment, 9 = City Corporation.
- */
-const VALID_RMO = new Set(["1", "2", "3", "4", "5", "9"]);
-
-const compact = (value: string): string =>
-  clean(value, " -");
-
-/**
- * Validate the 13-digit core (without year prefix).
- * Returns an error result or null on success.
- */
-const validateCore = (
-  core: string,
-): ValidateResult | null => {
-  // core[0..1] = district (any 2 digits)
-  // core[2] = RMO code
-  const rmo = core[2];
-  if (rmo === undefined || !VALID_RMO.has(rmo)) {
-    return err(
-      "INVALID_COMPONENT",
-      "NID residential type (RMO) code is invalid",
-    );
-  }
-  return null;
-};
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (
-    v.length !== 10 &&
-    v.length !== 13 &&
-    v.length !== 17
-  ) {
-    return err(
-      "INVALID_LENGTH",
-      "NID must be 10, 13, or 17 digits",
-    );
-  }
-  if (!isdigits(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "NID must contain only digits",
-    );
-  }
-  if (v.length === 10) {
-    // Smart card format: first digit must not be 0
-    if (v[0] === "0") {
-      return err(
-        "INVALID_COMPONENT",
-        "NID smart card number must not start with 0",
-      );
-    }
-    return { valid: true, compact: v };
-  }
-  // 13-digit (old) or 17-digit (new) format
-  const core = v.length === 17 ? v.slice(4) : v;
-  const coreErr = validateCore(core);
-  if (coreErr !== null) {
-    return coreErr;
-  }
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => compact(value);
-
-/** Bangladesh National Identity Number. */
-const nid: CountryValidator<"BD"> = {
-  name: "National Identity Number",
-  localName: "জাতীয় পরিচয়পত্র",
-  abbreviation: "NID",
-  aliases: [
-    "NID",
-    "জাতীয় পরিচয়পত্র",
-    "National ID Card",
-  ] as const,
-  candidatePattern: "\\d{10,17}",
-  scope: "country",
-  country: "BD",
-  entityType: "person",
-  lengths: [10, 13, 17],
-  examples: [
-    "1592824588424",
-    "19841592824588424",
-    "2610413965404",
-    "19892610413965404",
-  ] as const,
-  description:
-    "National identity number issued by the " +
-    "Bangladesh Election Commission",
-  sourceUrl: "https://www.nidw.gov.bd/",
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default nid;
-export { compact, format, validate, generate };

package/src/be/bis.ts

@@ -1,109 +0,0 @@
-/**
- * BIS (BIS-nummer / Numéro BIS).
- *
- * Belgian BIS number for individuals not in the
- * National Register. 11 digits, structured like the
- * NN but with the month offset by 20 (gender unknown)
- * or 40 (gender known).
- *
- * @see https://sma-help.bosa.belgium.be/en/faq/where-can-i-find-my-bis-number
- * @see https://nl.wikipedia.org/wiki/Rijksregisternummer
- */
-
-import type {
-  ValidateResult,
-  CountryValidator,
-} from "../types";
-import { checksum, format as nnFormat } from "./nn";
-
-import { clean } from "#util/clean";
-import { randomInt } 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 !== 11) {
-    return err(
-      "INVALID_LENGTH",
-      "BIS must be exactly 11 digits",
-    );
-  }
-  if (!isdigits(v) || Number(v) === 0) {
-    return err(
-      "INVALID_FORMAT",
-      "BIS must contain only digits",
-    );
-  }
-
-  if (checksum(v) === null) {
-    return err(
-      "INVALID_CHECKSUM",
-      "BIS check digits do not match",
-    );
-  }
-
-  // Month must be in 20..32 or 40..52
-  const rawMonth = Number(v.slice(2, 4));
-  const inRange20 = rawMonth >= 20 && rawMonth <= 32;
-  const inRange40 = rawMonth >= 40 && rawMonth <= 52;
-  if (!inRange20 && !inRange40) {
-    return err(
-      "INVALID_COMPONENT",
-      "Month must be in 20..32 or 40..52",
-    );
-  }
-
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string =>
-  nnFormat(compact(value));
-
-/** Generate a random valid BIS number. */
-const generate = (): string => {
-  for (;;) {
-    const yy = String(randomInt(0, 99)).padStart(2, "0");
-    const offset = Math.random() < 0.5 ? 20 : 40;
-    const mm = String(randomInt(1, 12) + offset).padStart(
-      2,
-      "0",
-    );
-    const dd = String(randomInt(1, 28)).padStart(2, "0");
-    const serial = String(randomInt(1, 997)).padStart(
-      3,
-      "0",
-    );
-    const base = yy + mm + dd + serial;
-    const n2 = Number("2" + base);
-    const check2 = 97 - (n2 % 97);
-    const c = base + String(check2).padStart(2, "0");
-    if (validate(c).valid) return c;
-  }
-};
-
-/** Belgian BIS Number. */
-const bis: CountryValidator<"BE"> = {
-  name: "Belgian BIS Number",
-  localName: "BIS-nummer",
-  abbreviation: "BIS",
-  aliases: ["BIS-nummer", "numéro BIS"] as const,
-  candidatePattern:
-    "\\d{2}\\.?\\d{2}\\.?\\d{2}-?\\d{3}\\.?\\d{2}",
-  scope: "country",
-  country: "BE",
-  entityType: "person",
-  sourceUrl:
-    "https://sma-help.bosa.belgium.be/en/faq/where-can-i-find-my-bis-number",
-  examples: ["98472899765"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default bis;
-export { compact, format, validate, generate };

package/src/be/mod.ts

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