@stll/stdnum 2.1.1 → 2.1.2

package/src/tr/tckimlik.ts

@@ -1,115 +0,0 @@
-/**
- * T.C. Kimlik No.
- * (Türkiye Cumhuriyeti Kimlik Numarası,
- * Turkish personal identification number).
- *
- * 11-digit unique personal ID assigned to every
- * Turkish citizen by MERNİS (Merkezi Nüfus İdaresi
- * Sistemi). The first digit is never zero. The last
- * two digits are check digits.
- *
- * Check digit algorithm:
- *   Let A = sum of digits at odd positions (1,3,5,7,9)
- *   Let B = sum of digits at even positions (2,4,6,8)
- *   d10 = (7 * A - B) mod 10
- *   d11 = (d1 + d2 + ... + d10) mod 10
- *
- * @see https://tckimlik.nvi.gov.tr/
- * @see https://en.wikipedia.org/wiki/Turkish_Identification_Number
- * @see https://www.turkiye.gov.tr/nvi-tckn-dogrulama
- */
-
-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, " -./");
-
-/**
- * Calculate the two check digits from the first
- * nine digits of a T.C. Kimlik number.
- */
-const calcCheckDigits = (number: string): string => {
-  let oddSum = 0;
-  let evenSum = 0;
-  for (let i = 0; i < 9; i++) {
-    const d = Number(number[i]);
-    if (i % 2 === 0) {
-      oddSum += d;
-    } else {
-      evenSum += d;
-    }
-  }
-  const d10 = (((7 * oddSum - evenSum) % 10) + 10) % 10;
-  const d11 = (oddSum + evenSum + d10) % 10;
-  return `${d10}${d11}`;
-};
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length !== 11) {
-    return err(
-      "INVALID_LENGTH",
-      "T.C. Kimlik number must be 11 digits",
-    );
-  }
-  if (!isdigits(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "T.C. Kimlik number must contain only digits",
-    );
-  }
-  if (v[0] === "0") {
-    return err(
-      "INVALID_COMPONENT",
-      "T.C. Kimlik number cannot start with 0",
-    );
-  }
-  if (calcCheckDigits(v) !== v.slice(9)) {
-    return err(
-      "INVALID_CHECKSUM",
-      "T.C. Kimlik number check digit mismatch",
-    );
-  }
-  return { valid: true, compact: v };
-};
-
-/** TR IDs are displayed without separators. */
-const format = (value: string): string => compact(value);
-
-/** Generate a random valid Turkish T.C. Kimlik No. */
-const generate = (): string => {
-  const payload = String(randomInt(1, 9)) + randomDigits(8);
-  return payload + calcCheckDigits(payload);
-};
-
-/** Turkish Personal Identification Number. */
-const tckimlik: CountryValidator<"TR"> = {
-  name: "Turkish Personal ID",
-  localName: "T.C. Kimlik Numarası",
-  abbreviation: "T.C. Kimlik",
-  aliases: [
-    "TC Kimlik No",
-    "T.C. Kimlik Numarası",
-  ] as const,
-  candidatePattern: "[1-9]\\d{10}",
-  scope: "country",
-  country: "TR",
-  entityType: "person",
-  sourceUrl: "https://www.nvi.gov.tr/",
-  examples: ["17291716060"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default tckimlik;
-export { compact, format, validate, generate };

package/src/tr/vkn.ts

@@ -1,101 +0,0 @@
-/**
- * VKN (Vergi Kimlik Numarası, Turkish tax
- * identification number).
- *
- * 10-digit tax ID used for businesses in Turkey.
- * The last digit is a check digit.
- *
- * Check digit algorithm:
- *   For each of the first 9 digits (right to left,
- *   position i = 1..9):
- *     c1 = (digit + i) mod 10
- *     c2 = if c1 != 0: (c1 * 2^i) mod 9, or 9 if
- *          that result is 0
- *     sum += c2
- *   check = (10 - sum) mod 10
- *
- * @see https://www.turkiye.gov.tr/gib-intvrg-vergi-kimlik-numarasi-dogrulama
- * @see https://arthurdejong.org/python-stdnum/doc/1.17/stdnum.tr.vkn
- * @see https://www.gib.gov.tr/
- */
-
-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, " -./");
-
-/**
- * Calculate the check digit for the first 9 digits
- * of a VKN.
- */
-const calcCheckDigit = (number: string): string => {
-  let s = 0;
-  for (let i = 0; i < 9; i++) {
-    const pos = 9 - i; // position 1..9 from right
-    const c1 = (Number(number[i]) + pos) % 10;
-    if (c1 !== 0) {
-      const pow = 2 ** pos;
-      const c2 = (c1 * pow) % 9 || 9;
-      s += c2;
-    }
-  }
-  return String((10 - (s % 10)) % 10);
-};
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length !== 10) {
-    return err("INVALID_LENGTH", "VKN must be 10 digits");
-  }
-  if (!isdigits(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "VKN must contain only digits",
-    );
-  }
-  if (calcCheckDigit(v) !== v[9]) {
-    return err(
-      "INVALID_CHECKSUM",
-      "VKN check digit mismatch",
-    );
-  }
-  return { valid: true, compact: v };
-};
-
-/** TR IDs are displayed without separators. */
-const format = (value: string): string => compact(value);
-
-/** Generate a random valid Turkish VKN. */
-const generate = (): string => {
-  const payload = randomDigits(9);
-  return payload + calcCheckDigit(payload);
-};
-
-/** Turkish Tax Identification Number. */
-const vkn: CountryValidator<"TR"> = {
-  name: "Turkish Tax ID",
-  localName: "Vergi Kimlik Numarası",
-  abbreviation: "VKN",
-  aliases: ["VKN", "Vergi Kimlik Numarası"] as const,
-  candidatePattern: "\\d{10}",
-  scope: "country",
-  country: "TR",
-  entityType: "company",
-  sourceUrl: "https://www.gib.gov.tr/",
-  examples: ["4540536920"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default vkn;
-export { compact, format, validate, generate };

package/src/tw/mod.ts

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

package/src/tw/ubn.ts

@@ -1,112 +0,0 @@
-/**
- * UBN (Unified Business Number, 統一編號).
- *
- * Taiwanese company identifier. 8 digits with a
- * weighted checksum. Weights [1,2,1,2,1,2,4,1];
- * sum the individual digits of each product, total
- * mod 10 must be 0. Special case: when the 7th digit
- * is 7, checksum 9 is also accepted.
- *
- * @see https://zh.wikipedia.org/wiki/統一編號
- */
-
-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, 2, 1, 2, 1, 2, 4, 1] as const;
-
-/** Sum the individual digits of a number. */
-const digitSum = (n: number): number => {
-  let sum = 0;
-  while (n > 0) {
-    sum += n % 10;
-    n = Math.floor(n / 10);
-  }
-  return sum;
-};
-
-const compact = (value: string): string =>
-  clean(value, " -");
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length !== 8) {
-    return err(
-      "INVALID_LENGTH",
-      "UBN must be exactly 8 digits",
-    );
-  }
-  if (!isdigits(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "UBN must contain only digits",
-    );
-  }
-
-  let sum = 0;
-  for (const [i, weight] of WEIGHTS.entries()) {
-    sum += digitSum(Number(v[i]) * weight);
-  }
-
-  const checksum = sum % 10;
-  if (checksum === 0) {
-    return { valid: true, compact: v };
-  }
-
-  // Special case: when the 7th digit is 7 (product
-  // 4*7=28), the checksum may be 9 instead of 0.
-  if (checksum === 9 && v[6] === "7") {
-    return { valid: true, compact: v };
-  }
-
-  return err(
-    "INVALID_CHECKSUM",
-    "UBN checksum does not match",
-  );
-};
-
-const format = (value: string): string => compact(value);
-
-/** Generate a random valid UBN. */
-const generate = (): string => {
-  for (;;) {
-    const prefix = randomDigits(7);
-    for (let d = 0; d < 10; d++) {
-      const candidate = `${prefix}${d}`;
-      const r = validate(candidate);
-      if (r.valid) return candidate;
-    }
-  }
-};
-
-/** Taiwanese Unified Business Number. */
-const ubn: CountryValidator<"TW"> = {
-  name: "Unified Business Number",
-  localName: "統一編號",
-  abbreviation: "UBN",
-  aliases: ["統一編號", "UBN"] as const,
-  candidatePattern: "\\d{8}",
-  scope: "country",
-  country: "TW",
-  entityType: "company",
-  description:
-    "8-digit company identifier issued by the Ministry of Economic Affairs",
-  sourceUrl:
-    "https://zh.wikipedia.org/wiki/%E7%B5%B1%E4%B8%80%E7%B7%A8%E8%99%9F",
-  lengths: [8] as const,
-  examples: ["00501503", "04595257"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default ubn;
-export { compact, format, generate, validate };

package/src/types.ts

@@ -1,262 +0,0 @@
-/**
- * ISO 3166-1 alpha-2 country codes for countries
- * with at least one validator in this package.
- */
-export type CountryCode =
-  | "AD"
-  | "AE"
-  | "AI"
-  | "AL"
-  | "AM"
-  | "AR"
-  | "AT"
-  | "AU"
-  | "AZ"
-  | "BA"
-  | "BD"
-  | "BE"
-  | "BG"
-  | "BH"
-  | "BR"
-  | "BY"
-  | "BZ"
-  | "CA"
-  | "CH"
-  | "CL"
-  | "CN"
-  | "CO"
-  | "CR"
-  | "CU"
-  | "CY"
-  | "CZ"
-  | "DE"
-  | "DK"
-  | "DO"
-  | "EC"
-  | "EE"
-  | "EG"
-  | "ES"
-  | "FI"
-  | "FR"
-  | "GB"
-  | "GE"
-  | "GH"
-  | "GR"
-  | "GT"
-  | "HK"
-  | "HR"
-  | "HU"
-  | "ID"
-  | "IE"
-  | "IL"
-  | "IN"
-  | "IQ"
-  | "IR"
-  | "IS"
-  | "IT"
-  | "JP"
-  | "KR"
-  | "KW"
-  | "KZ"
-  | "LI"
-  | "LK"
-  | "LT"
-  | "LU"
-  | "LV"
-  | "MA"
-  | "MC"
-  | "MD"
-  | "ME"
-  | "MK"
-  | "MT"
-  | "MU"
-  | "MX"
-  | "MY"
-  | "NG"
-  | "NI"
-  | "NL"
-  | "NO"
-  | "NZ"
-  | "PA"
-  | "PE"
-  | "PH"
-  | "PK"
-  | "PL"
-  | "PT"
-  | "RO"
-  | "RS"
-  | "RU"
-  | "SE"
-  | "SG"
-  | "SI"
-  | "SK"
-  | "TH"
-  | "TR"
-  | "TW"
-  | "UA"
-  | "US"
-  | "UY"
-  | "VE"
-  | "VN"
-  | "ZA";
-
-export type ErrorCode =
-  | "INVALID_FORMAT"
-  | "INVALID_LENGTH"
-  | "INVALID_CHECKSUM"
-  | "INVALID_COMPONENT";
-
-export type StdnumError = {
-  code: ErrorCode;
-  message: string;
-};
-
-export type ValidateResult =
-  | { valid: true; compact: string }
-  | { valid: false; error: StdnumError };
-
-/**
- * Structured data extracted from an identifier that
- * encodes a birth date.
- */
-export type ParsedBirthDate = {
-  birthDate: Date;
-};
-
-/**
- * Structured data extracted from a personal ID number
- * that also encodes gender.
- */
-export type ParsedPersonId = ParsedBirthDate & {
-  gender: "male" | "female";
-};
-
-export type ParsedIdentifier =
-  | ParsedBirthDate
-  | ParsedPersonId;
-
-/**
- * Whether an identifier is scoped to a single
- * country (e.g. Czech IČO) or is cross-border by
- * design (e.g. IBAN, ISIN, BIC, LEI, EU VAT).
- *
- * Modeled as a discriminated union so consumers
- * can group, filter, and exhaustively switch
- * without null-checking `country`.
- */
-export type ValidatorScope =
-  | { scope: "country"; country: CountryCode }
-  | { scope: "global" };
-
-type ValidatorBase<
-  TParsed extends ParsedIdentifier | undefined = undefined,
-> = {
-  /** English name. */
-  name: string;
-  /** Name in the local language. */
-  localName: string;
-  /** Common abbreviation (e.g. "IČO"). */
-  abbreviation: string;
-  /** What kind of entity this identifies. */
-  entityType: "person" | "company" | "any";
-
-  /**
-   * Strip separators and normalize to a
-   * canonical compact form.
-   */
-  compact: (value: string) => string;
-
-  /**
-   * Format the identifier for display
-   * (e.g. add separators, group digits).
-   */
-  format: (value: string) => string;
-
-  /**
-   * Validate the identifier. Returns the
-   * compact form on success, or an error
-   * with a code and message on failure.
-   */
-  validate: (value: string) => ValidateResult;
-
-  /** One-liner describing the identifier. */
-  description?: string;
-  /** URL to official authority or spec page. */
-  sourceUrl?: string;
-  /** Valid lengths of the compact form. */
-  lengths?: readonly number[];
-
-  /**
-   * Known-valid compact values. Useful as test
-   * seeds, form placeholders, API schema examples,
-   * and documentation. Sourced from official
-   * government specs where available.
-   */
-  examples?: readonly string[];
-
-  /**
-   * Generate a random valid identifier in compact
-   * form. Available on validators with checksum
-   * algorithms. Useful for testing, demos, and
-   * form placeholders. NOT cryptographically secure.
-   */
-  generate?: () => string;
-
-  /**
-   * All known names, abbreviations, and common
-   * references for this identifier. Superset of
-   * name/localName/abbreviation. Useful for
-   * searching documents, building autocomplete,
-   * or contextual detection.
-   */
-  aliases?: readonly string[];
-
-  /**
-   * Regex pattern string to find candidates of
-   * this identifier in free text. Should be loose
-   * enough to catch formatted variants (dots,
-   * spaces, hyphens) but specific enough to avoid
-   * excessive noise. Matched candidates should be
-   * passed to validate() for confirmation.
-   */
-  candidatePattern?: string;
-
-  /**
-   * Extract structured data (e.g. birth date,
-   * gender) from a known-valid identifier.
-   * Available on personal IDs that encode such
-   * data. Returns null if the input cannot be
-   * parsed.
-   *
-   * On the base `Validator` type this is optional
-   * with a widened return; narrow it by typing the
-   * validator as `Validator<ParsedPersonId>` etc.
-   */
-  parse?: (value: string) => ParsedIdentifier | null;
-} & ([TParsed] extends [undefined]
-  ? unknown
-  : { parse: (value: string) => TParsed | null });
-
-export type CountryValidator<
-  TCountry extends CountryCode = CountryCode,
-  TParsed extends ParsedIdentifier | undefined = undefined,
-> = ValidatorBase<TParsed> & {
-  scope: "country";
-  country: TCountry;
-};
-
-export type GlobalValidator<
-  TParsed extends ParsedIdentifier | undefined = undefined,
-> = ValidatorBase<TParsed> & {
-  scope: "global";
-};
-
-export type Validator<
-  TParsed extends ParsedIdentifier | undefined = undefined,
-> =
-  | CountryValidator<CountryCode, TParsed>
-  | GlobalValidator<TParsed>;
-
-export type ParsableValidator<
-  TParsed extends ParsedIdentifier = ParsedIdentifier,
-> = Validator<TParsed>;

package/src/ua/edrpou.ts

@@ -1,108 +0,0 @@
-/**
- * EDRPOU (ЄДРПОУ, Unified State Register of
- * Enterprises and Organizations of Ukraine).
- *
- * 8-digit company identification number with a
- * weighted checksum. Two sets of weights are used
- * depending on whether the first digit is 0-2/6-9 or 3-5.
- *
- * @see https://en.wikipedia.org/wiki/EDRPOU
- * @see https://usr.minjust.gov.ua/
- */
-
-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_A = [1, 2, 3, 4, 5, 6, 7] as const;
-const WEIGHTS_B = [7, 1, 2, 3, 4, 5, 6] as const;
-const WEIGHTS_A2 = [3, 4, 5, 6, 7, 8, 9] as const;
-const WEIGHTS_B2 = [9, 3, 4, 5, 6, 7, 8] as const;
-
-const calcCheck = (
-  value: string,
-  weights: readonly number[],
-): number => {
-  let sum = 0;
-  for (const [i, weight] of weights.entries()) {
-    if (i >= 7) break;
-    sum += Number(value[i]) * weight;
-  }
-  return sum % 11;
-};
-
-const compact = (value: string): string =>
-  clean(value, " -");
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length !== 8) {
-    return err(
-      "INVALID_LENGTH",
-      "EDRPOU must be exactly 8 digits",
-    );
-  }
-  if (!isdigits(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "EDRPOU must contain only digits",
-    );
-  }
-
-  const firstDigit = Number(v[0]);
-  const useA = firstDigit < 3 || firstDigit >= 6;
-  const weightsFirst = useA ? WEIGHTS_A : WEIGHTS_B;
-  const weightsSecond = useA ? WEIGHTS_A2 : WEIGHTS_B2;
-
-  let check = calcCheck(v, weightsFirst);
-  if (check >= 10) {
-    check = calcCheck(v, weightsSecond) % 10;
-  }
-
-  if (check !== Number(v[7])) {
-    return err(
-      "INVALID_CHECKSUM",
-      "EDRPOU check digit mismatch",
-    );
-  }
-
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => compact(value);
-
-/** Generate a random valid Ukrainian EDRPOU. */
-const generate = (): string => {
-  for (;;) {
-    const c = randomDigits(8);
-    if (validate(c).valid) return c;
-  }
-};
-
-/** Ukrainian Company Register Number. */
-const edrpou: CountryValidator<"UA"> = {
-  name: "Ukrainian Company Register Number",
-  localName: "ЄДРПОУ",
-  abbreviation: "ЄДРПОУ",
-  aliases: ["ЄДРПОУ", "EDRPOU"] as const,
-  candidatePattern: "\\d{8}",
-  scope: "country",
-  country: "UA",
-  entityType: "company",
-  lengths: [8] as const,
-  sourceUrl: "https://usr.minjust.gov.ua/",
-  examples: ["14360570"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default edrpou;
-export { compact, format, validate, generate };

package/src/ua/mod.ts

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