@stll/stdnum 2.1.0 → 2.1.2

package/src/in/gstin.ts

@@ -1,175 +0,0 @@
-/**
- * GSTIN (Goods and Services Tax Identification
- * Number, India).
- *
- * 15 characters: 2-digit state code + 10-char PAN +
- * 1 entity number (1-9, A-Z) + "Z" + 1 check digit.
- * Check digit uses the Luhn mod 36 algorithm.
- *
- * @see https://en.wikipedia.org/wiki/Goods_and_Services_Tax_Identification_Number
- */
-
-import type {
-  ValidateResult,
-  CountryValidator,
-} from "../types";
-
-import { clean } from "#util/clean";
-import { randomDigits, randomInt } from "#util/generate";
-import { err } from "#util/result";
-import { charValue } from "#util/strings";
-
-const GSTIN_RE =
-  /^[0-9]{2}[A-Z]{5}[0-9]{4}[A-Z][0-9A-Z]Z[0-9A-Z]$/;
-
-/** Valid Indian state/UT codes: 01-37. */
-const VALID_STATE_CODES = new Set([
-  "01",
-  "02",
-  "03",
-  "04",
-  "05",
-  "06",
-  "07",
-  "08",
-  "09",
-  "10",
-  "11",
-  "12",
-  "13",
-  "14",
-  "15",
-  "16",
-  "17",
-  "18",
-  "19",
-  "20",
-  "21",
-  "22",
-  "23",
-  "24",
-  "25",
-  "26",
-  "27",
-  "28",
-  "29",
-  "30",
-  "31",
-  "32",
-  "33",
-  "34",
-  "35",
-  "36",
-  "37",
-]);
-
-const BASE = 36;
-
-/**
- * Luhn mod 36 checksum over the full GSTIN.
- * Returns 0 for a valid number.
- */
-const luhn36Checksum = (value: string): number => {
-  let sum = 0;
-  let double = false;
-  for (let i = value.length - 1; i >= 0; i--) {
-    const ch = value[i];
-    if (ch === undefined) continue;
-    let v = charValue(ch);
-    if (double) {
-      v *= 2;
-      sum += Math.floor(v / BASE) + (v % BASE);
-    } else {
-      sum += v;
-    }
-    double = !double;
-  }
-  return sum % BASE;
-};
-
-const compact = (value: string): string =>
-  clean(value, " -").toUpperCase();
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length !== 15) {
-    return err(
-      "INVALID_LENGTH",
-      "GSTIN must be 15 characters",
-    );
-  }
-  if (!GSTIN_RE.test(v)) {
-    return err("INVALID_FORMAT", "GSTIN format is invalid");
-  }
-  const stateCode = v.slice(0, 2);
-  if (!VALID_STATE_CODES.has(stateCode)) {
-    return err(
-      "INVALID_COMPONENT",
-      "GSTIN state code is invalid",
-    );
-  }
-  if (v[12] === "0") {
-    return err(
-      "INVALID_COMPONENT",
-      "GSTIN entity number cannot be 0",
-    );
-  }
-  if (luhn36Checksum(v) !== 0) {
-    return err(
-      "INVALID_CHECKSUM",
-      "GSTIN check digit mismatch",
-    );
-  }
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => compact(value);
-
-/** Generate a random valid GSTIN. */
-const generate = (): string => {
-  for (;;) {
-    const state = String(randomInt(1, 37)).padStart(2, "0");
-    let pan = "";
-    for (let i = 0; i < 5; i++)
-      pan += String.fromCharCode(65 + randomInt(0, 25));
-    pan +=
-      randomDigits(4) +
-      String.fromCharCode(65 + randomInt(0, 25));
-    const entity = String(randomInt(1, 9));
-    const partial = state + pan + entity + "Z";
-    for (let d = 0; d <= 9; d++) {
-      const c = partial + String(d);
-      if (validate(c).valid) return c;
-    }
-    for (let c = 65; c <= 90; c++) {
-      const cand = partial + String.fromCharCode(c);
-      if (validate(cand).valid) return cand;
-    }
-  }
-};
-
-/** Indian Goods and Services Tax ID. */
-const gstin: CountryValidator<"IN"> = {
-  name: "Indian Goods and Services Tax ID",
-  localName: "Goods and Services Tax Identification Number",
-  abbreviation: "GSTIN",
-  aliases: ["GSTIN", "GST number"] as const,
-  candidatePattern:
-    "\\d{2}[A-Z]{5}\\d{4}[A-Z][A-Z\\d][Z][A-Z\\d]",
-  scope: "country",
-  country: "IN",
-  entityType: "company",
-  lengths: [15],
-  examples: ["27AAPFU0939F1ZV", "29AAGCB7383J1Z4"],
-  description:
-    "15-character tax identifier for GST-registered businesses",
-  sourceUrl:
-    "https://en.wikipedia.org/wiki/Goods_and_Services_Tax_Identification_Number",
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default gstin;
-export { compact, format, validate, generate };

package/src/in/mod.ts

@@ -1,3 +0,0 @@
-export { default as aadhaar } from "./aadhaar";
-export { default as gstin } from "./gstin";
-export { default as pan } from "./pan";

package/src/in/pan.ts

@@ -1,97 +0,0 @@
-/** Generate a random valid Indian PAN. */
-const generate = (): string => {
-  const randomLetter = (): string =>
-    String.fromCodePoint(65 + randomInt(0, 25));
-  const first3 =
-    randomLetter() + randomLetter() + randomLetter();
-  const holderType = randomChar(HOLDER_TYPES);
-  const fifth = randomLetter();
-  const digits = randomDigits(4);
-  const last = randomLetter();
-  return `${first3}${holderType}${fifth}${digits}${last}`;
-};
-
-/**
- * PAN (Permanent Account Number, Indian tax ID).
- *
- * 10 characters: 5 letters + 4 digits + 1 letter.
- * The 4th letter encodes the holder type
- * (P=person, C=company, H=HUF, A=AOP, B=BOI,
- * G=government, J=AJP, L=local authority, F=FOP,
- * T=trust). The 5th letter is the first letter
- * of the surname or entity name.
- * No checksum; format validation only.
- *
- * @see https://en.wikipedia.org/wiki/Permanent_account_number
- */
-
-import type {
-  ValidateResult,
-  CountryValidator,
-} from "../types";
-
-import { clean } from "#util/clean";
-import {
-  randomChar,
-  randomDigits,
-  randomInt,
-} from "#util/generate";
-import { err } from "#util/result";
-
-const PAN_RE = /^[A-Z]{5}\d{4}[A-Z]$/;
-
-const HOLDER_TYPES = "ABCFGHJLPT";
-
-const compact = (value: string): string =>
-  clean(value, " -").toUpperCase();
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length !== 10) {
-    return err(
-      "INVALID_LENGTH",
-      "PAN must be 10 characters",
-    );
-  }
-  if (!PAN_RE.test(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "PAN must be 5 letters + 4 digits + 1 letter",
-    );
-  }
-  // SAFETY: regex above guarantees v.length === 10.
-  // eslint-disable-next-line no-non-null-assertion
-  if (!HOLDER_TYPES.includes(v[3]!)) {
-    return err(
-      "INVALID_COMPONENT",
-      "PAN 4th character must be a valid holder type",
-    );
-  }
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => compact(value);
-
-/** Indian Permanent Account Number. */
-const pan: CountryValidator<"IN"> = {
-  name: "Indian Permanent Account Number",
-  localName: "Permanent Account Number",
-  abbreviation: "PAN",
-  aliases: ["PAN", "Permanent Account Number"] as const,
-  candidatePattern: "[A-Z]{5}\\d{4}[A-Z]",
-  scope: "country",
-  country: "IN",
-  entityType: "any",
-  lengths: [10],
-  examples: ["ABCPP1234C", "AAACR5055K"],
-  description: "10-character alphanumeric tax identifier",
-  sourceUrl:
-    "https://en.wikipedia.org/wiki/Permanent_account_number",
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default pan;
-export { compact, format, validate, generate };

package/src/index.ts

@@ -1,123 +0,0 @@
-export type {
-  CountryValidator,
-  CountryCode,
-  ErrorCode,
-  GlobalValidator,
-  ParsedBirthDate,
-  ParsedIdentifier,
-  ParsedPersonId,
-  ParsableValidator,
-  StdnumError,
-  ValidateResult,
-  Validator,
-  ValidatorScope,
-} from "./types";
-export { default as bic } from "./bic";
-export {
-  default as creditcard,
-  detectNetwork,
-} from "./creditcard";
-export type { CardNetwork } from "./creditcard";
-export { default as iban } from "./iban";
-export { default as isin } from "./isin";
-export { default as lei } from "./lei";
-export { default as luhn } from "./luhn";
-
-export * as crypto from "./crypto/mod";
-export * as ad from "./ad/mod";
-export * as ae from "./ae/mod";
-export * as ai from "./ai/mod";
-export * as al from "./al/mod";
-export * as am from "./am/mod";
-export * as ar from "./ar/mod";
-export * as at from "./at/mod";
-export * as au from "./au/mod";
-export * as az from "./az/mod";
-export * as ba from "./ba/mod";
-export * as bd from "./bd/mod";
-export * as be from "./be/mod";
-export * as bg from "./bg/mod";
-export * as bh from "./bh/mod";
-export * as br from "./br/mod";
-export * as by from "./by/mod";
-export * as bz from "./bz/mod";
-export * as ca from "./ca/mod";
-export * as ch from "./ch/mod";
-export * as cl from "./cl/mod";
-export * as cn from "./cn/mod";
-export * as co from "./co/mod";
-export * as cr from "./cr/mod";
-export * as cu from "./cu/mod";
-export * as cy from "./cy/mod";
-export * as cz from "./cz/mod";
-export * as de from "./de/mod";
-export * as dk from "./dk/mod";
-export * as do_ from "./do/mod";
-export * as ec from "./ec/mod";
-export * as ee from "./ee/mod";
-export * as eg from "./eg/mod";
-export * as es from "./es/mod";
-export * as eu from "./eu/mod";
-export * as fi from "./fi/mod";
-export * as fr from "./fr/mod";
-export * as gb from "./gb/mod";
-export * as ge from "./ge/mod";
-export * as gh from "./gh/mod";
-export * as gr from "./gr/mod";
-export * as gt from "./gt/mod";
-export * as hk from "./hk/mod";
-export * as hr from "./hr/mod";
-export * as hu from "./hu/mod";
-export * as id from "./id/mod";
-export * as ie from "./ie/mod";
-export * as il from "./il/mod";
-export * as in_ from "./in/mod";
-export * as iq from "./iq/mod";
-export * as ir from "./ir/mod";
-export * as is_ from "./is/mod";
-export * as it from "./it/mod";
-export * as jp from "./jp/mod";
-export * as kr from "./kr/mod";
-export * as kw from "./kw/mod";
-export * as kz from "./kz/mod";
-export * as li from "./li/mod";
-export * as lk from "./lk/mod";
-export * as lt from "./lt/mod";
-export * as lu from "./lu/mod";
-export * as lv from "./lv/mod";
-export * as ma from "./ma/mod";
-export * as mc from "./mc/mod";
-export * as md from "./md/mod";
-export * as me from "./me/mod";
-export * as mk from "./mk/mod";
-export * as mt from "./mt/mod";
-export * as mu from "./mu/mod";
-export * as mx from "./mx/mod";
-export * as my from "./my/mod";
-export * as ng from "./ng/mod";
-export * as ni from "./ni/mod";
-export * as nl from "./nl/mod";
-export * as no from "./no/mod";
-export * as nz from "./nz/mod";
-export * as pa from "./pa/mod";
-export * as pe from "./pe/mod";
-export * as ph from "./ph/mod";
-export * as pk from "./pk/mod";
-export * as pl from "./pl/mod";
-export * as pt from "./pt/mod";
-export * as ro from "./ro/mod";
-export * as rs from "./rs/mod";
-export * as ru from "./ru/mod";
-export * as se from "./se/mod";
-export * as sg from "./sg/mod";
-export * as si from "./si/mod";
-export * as sk from "./sk/mod";
-export * as th from "./th/mod";
-export * as tr from "./tr/mod";
-export * as tw from "./tw/mod";
-export * as ua from "./ua/mod";
-export * as us from "./us/mod";
-export * as uy from "./uy/mod";
-export * as ve from "./ve/mod";
-export * as vn from "./vn/mod";
-export * as za from "./za/mod";

package/src/iq/mod.ts

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

package/src/iq/nid.ts

@@ -1,75 +0,0 @@
-/** Generate a random valid Iraqi NID. */
-const generate = (): string => randomDigits(12);
-
-/**
- * NID (Iraqi National ID, البطاقة الوطنية الموحدة).
- *
- * 12-digit personal identification number on the
- * Iraqi National Card (Unified National Card), issued
- * by the Ministry of Interior since 2016.
- *
- * No public checksum algorithm is documented.
- * Validation is limited to format: exactly 12 decimal
- * digits. Accepts both Arabic-Indic (U+066x) and
- * Extended Arabic-Indic (U+06Fx) digits.
- *
- * @see https://mofa.gov.iq/the-civil-status-id/
- */
-
-import type {
-  ValidateResult,
-  CountryValidator,
-} from "../types";
-
-import { normalizeArabicDigits } from "#util/arabic";
-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 =>
-  normalizeArabicDigits(clean(value, " -./"));
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length !== 12) {
-    return err(
-      "INVALID_LENGTH",
-      "Iraqi NID must be exactly 12 digits",
-    );
-  }
-  if (!isdigits(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "Iraqi NID must contain only digits",
-    );
-  }
-  return { valid: true, compact: v };
-};
-
-/** Iraqi NIDs are displayed without separators. */
-const format = (value: string): string => compact(value);
-
-/** Iraqi National Identification Number. */
-const nid: CountryValidator<"IQ"> = {
-  name: "Iraqi National ID",
-  localName: "البطاقة الوطنية الموحدة",
-  abbreviation: "NID",
-  aliases: ["NID", "البطاقة الوطنية الموحدة"] as const,
-  candidatePattern: "\\d{12}",
-  scope: "country",
-  country: "IQ",
-  entityType: "person",
-  sourceUrl: "https://mofa.gov.iq/the-civil-status-id/",
-  description:
-    "Iraqi personal identification number (National Card)",
-  lengths: [12] as const,
-  examples: ["012345678901"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default nid;
-export { compact, format, validate, generate };

package/src/ir/mod.ts

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

package/src/ir/nid.ts

@@ -1,124 +0,0 @@
-/**
- * NID (Iranian National ID, کد ملی, Code Melli).
- *
- * 10-digit personal identification number assigned to
- * every Iranian citizen. Digits 1-3 encode the province,
- * digits 4-9 are a sequential identifier, and digit 10
- * is a check digit.
- *
- * Check digit algorithm (mod 11):
- *   sum = Σ(digit[i] × (10 − i)) for i = 0..8
- *   r   = sum mod 11
- *   if r < 2: check digit = r
- *   if r ≥ 2: check digit = 11 − r
- *
- * Numbers where all digits are identical (e.g.
- * 0000000000, 1111111111) are rejected.
- *
- * Accepts both Persian (Extended Arabic-Indic, U+06Fx)
- * and Arabic-Indic (U+066x) digits.
- *
- * @see https://www.sabteahval.ir/
- * @see https://persian-tools.js.org/functions/verifyIranianNationalId.html
- */
-
-import type {
-  ValidateResult,
-  CountryValidator,
-} from "../types";
-
-import { normalizeArabicDigits } from "#util/arabic";
-import { clean } from "#util/clean";
-import { randomDigits } from "#util/generate";
-import { err } from "#util/result";
-import { isdigits } from "#util/strings";
-
-/** All-same-digit patterns (0000000000 .. 9999999999). */
-const ALL_SAME = new Set(
-  Array.from({ length: 10 }, (_, i) =>
-    String(i).repeat(10),
-  ),
-);
-
-const compact = (value: string): string =>
-  normalizeArabicDigits(clean(value, " -./"));
-
-/**
- * Calculate the check digit from the first 9 digits.
- */
-const calcCheckDigit = (number: string): number => {
-  let sum = 0;
-  for (let i = 0; i < 9; i++) {
-    sum += Number(number[i]) * (10 - i);
-  }
-  const r = sum % 11;
-  return r < 2 ? r : 11 - r;
-};
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length !== 10) {
-    return err(
-      "INVALID_LENGTH",
-      "Iranian NID must be exactly 10 digits",
-    );
-  }
-  if (!isdigits(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "Iranian NID must contain only digits",
-    );
-  }
-  if (ALL_SAME.has(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "Iranian NID must not have all identical digits",
-    );
-  }
-  if (calcCheckDigit(v) !== Number(v[9])) {
-    return err(
-      "INVALID_CHECKSUM",
-      "Iranian NID check digit mismatch",
-    );
-  }
-  return { valid: true, compact: v };
-};
-
-/** Iranian NIDs are displayed without separators. */
-const format = (value: string): string => compact(value);
-
-/**
- * Generate a random valid Iranian NID.
- * NOT cryptographically secure.
- */
-const generate = (): string => {
-  const base = randomDigits(9);
-  const check = calcCheckDigit(base);
-  const result = `${base}${check}`;
-  if (ALL_SAME.has(result)) return generate();
-  return result;
-};
-
-/** Iranian National Identification Number. */
-const nid: CountryValidator<"IR"> = {
-  name: "Iranian National ID",
-  localName: "کد ملی",
-  abbreviation: "NID",
-  aliases: ["NID", "کد ملی", "national code"] as const,
-  candidatePattern: "\\d{10}",
-  scope: "country",
-  country: "IR",
-  entityType: "person",
-  sourceUrl: "https://www.sabteahval.ir/",
-  description:
-    "Iranian personal identification number (Code Melli)",
-  lengths: [10] as const,
-  examples: ["0932833810"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default nid;
-export { compact, format, validate, generate };