@stll/stdnum 2.1.1 → 2.1.3

package/src/it/iva.ts

@@ -1,119 +0,0 @@
-/**
- * Partita IVA (Italian VAT number).
- *
- * 11 digits: 7-digit company ID + 3-digit
- * province code + Luhn check digit.
- *
- * @see https://www.agenziaentrate.gov.it/
- */
-
-import type {
-  ValidateResult,
-  CountryValidator,
-} from "../types";
-
-import {
-  luhnValidate,
-  luhnChecksum,
-} from "#checksums/luhn";
-import { clean } from "#util/clean";
-import { randomDigits, randomInt } from "#util/generate";
-import { err } from "#util/result";
-import { isdigits } from "#util/strings";
-
-const VALID_PROVINCES = new Set([
-  ...Array.from({ length: 100 }, (_, i) =>
-    String(i + 1).padStart(3, "0"),
-  ),
-  "120",
-  "121",
-  "888",
-  "999",
-]);
-
-const compact = (value: string): string => {
-  let v = clean(value, " -");
-  if (v.startsWith("IT") || v.startsWith("it")) {
-    v = v.slice(2);
-  }
-  return v;
-};
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length !== 11) {
-    return err(
-      "INVALID_LENGTH",
-      "Partita IVA must be exactly 11 digits",
-    );
-  }
-  if (!isdigits(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "Partita IVA must contain only digits",
-    );
-  }
-  // First 7 digits cannot all be zero
-  if (/^0{7}/.test(v)) {
-    return err(
-      "INVALID_COMPONENT",
-      "Partita IVA company ID cannot be all zeros",
-    );
-  }
-  // Province code validation
-  const province = v.slice(7, 10);
-  if (!VALID_PROVINCES.has(province)) {
-    return err(
-      "INVALID_COMPONENT",
-      "Partita IVA province code is invalid",
-    );
-  }
-  if (!luhnValidate(v)) {
-    return err(
-      "INVALID_CHECKSUM",
-      "Partita IVA fails Luhn check",
-    );
-  }
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string =>
-  `IT${compact(value)}`;
-
-/** Generate a random valid Italian Partita IVA. */
-const generate = (): string => {
-  const company = randomDigits(7);
-  const province = String(randomInt(1, 100)).padStart(
-    3,
-    "0",
-  );
-  const payload = company + province;
-  const cs = luhnChecksum(payload + "0");
-  return payload + String((10 - cs) % 10);
-};
-
-/** Italian VAT Number. */
-const iva: CountryValidator<"IT"> = {
-  name: "Italian VAT Number",
-  localName: "Partita IVA",
-  abbreviation: "P.IVA",
-  aliases: [
-    "partita IVA",
-    "P.IVA",
-    "P. IVA",
-    "VAT IT",
-  ] as const,
-  candidatePattern: "IT\\d{11}",
-  scope: "country",
-  country: "IT",
-  entityType: "company",
-  sourceUrl: "https://www.agenziaentrate.gov.it/",
-  examples: ["00743110157"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default iva;
-export { compact, format, validate, generate };

package/src/it/mod.ts

@@ -1,2 +0,0 @@
-export { default as codiceFiscale } from "./codicefiscale";
-export { default as iva } from "./iva";

package/src/jp/cn.ts

@@ -1,95 +0,0 @@
-/**
- * CN (Corporate Number, 法人番号).
- *
- * Japanese Corporate Number. 13 digits with a
- * check digit based on modulus 9. Assigned by the
- * National Tax Agency.
- *
- * @see https://en.wikipedia.org/wiki/Corporate_Number_(Japan)
- */
-
-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, " -");
-
-/**
- * Compute the check digit for a 12-digit payload.
- * Weights alternate [1,2,1,2,...] from the
- * rightmost digit of the payload.
- */
-const checkDigit = (payload: string): number => {
-  let sum = 0;
-  for (let i = 0; i < 12; i++) {
-    const digit = Number(payload[11 - i]);
-    const weight = i % 2 === 0 ? 1 : 2;
-    sum += digit * weight;
-  }
-  return 9 - (sum % 9);
-};
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length !== 13) {
-    return err(
-      "INVALID_LENGTH",
-      "Corporate Number must be exactly 13 digits",
-    );
-  }
-  if (!isdigits(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "Corporate Number must contain only digits",
-    );
-  }
-  const expected = checkDigit(v.slice(1));
-  if (expected !== Number(v[0])) {
-    return err(
-      "INVALID_CHECKSUM",
-      "Corporate Number check digit does not match",
-    );
-  }
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => compact(value);
-
-/** Generate a random valid Corporate Number. */
-const generate = (): string => {
-  const payload = randomDigits(12);
-  const check = checkDigit(payload);
-  return `${String(check)}${payload}`;
-};
-
-/** Japanese Corporate Number. */
-const cn: CountryValidator<"JP"> = {
-  name: "Japanese Corporate Number",
-  localName: "法人番号",
-  abbreviation: "CN",
-  aliases: ["法人番号", "Corporate Number"] as const,
-  candidatePattern: "\\d{13}",
-  scope: "country",
-  country: "JP",
-  entityType: "company",
-  description:
-    "13-digit corporate identifier assigned by the National Tax Agency",
-  sourceUrl:
-    "https://en.wikipedia.org/wiki/Corporate_Number_(Japan)",
-  lengths: [13] as const,
-  examples: ["5835678256246", "2021001052596"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default cn;
-export { compact, format, generate, validate };

package/src/jp/mod.ts

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

package/src/jp/mynumber.ts

@@ -1,107 +0,0 @@
-/**
- * My Number (Individual Number, マイナンバー).
- *
- * Japanese Individual Number. 12 digits with a
- * mod 11 check digit. Assigned to every resident
- * of Japan for tax and social security purposes.
- * Contains no encoded personal information.
- *
- * @see https://en.wikipedia.org/wiki/Individual_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 compact = (value: string): string =>
-  clean(value, " -");
-
-const WEIGHTS = [6, 5, 4, 3, 2, 7, 6, 5, 4, 3, 2];
-
-/**
- * Compute the check digit for an 11-digit payload.
- * remainder <= 1 yields 0; otherwise 11 - remainder.
- */
-const checkDigit = (payload: string): number => {
-  let sum = 0;
-  for (let i = 0; i < 11; i++) {
-    sum += (WEIGHTS[i] ?? 0) * Number(payload.charAt(i));
-  }
-  const remainder = sum % 11;
-  return remainder <= 1 ? 0 : 11 - remainder;
-};
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length !== 12) {
-    return err(
-      "INVALID_LENGTH",
-      "My Number must be exactly 12 digits",
-    );
-  }
-  if (!isdigits(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "My Number must contain only digits",
-    );
-  }
-  const expected = checkDigit(v.slice(0, 11));
-  if (expected !== Number(v[11])) {
-    return err(
-      "INVALID_CHECKSUM",
-      "My Number check digit does not match",
-    );
-  }
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => {
-  const v = compact(value);
-  if (v.length === 12) {
-    return `${v.slice(0, 4)} ${v.slice(4, 8)} ${v.slice(8)}`;
-  }
-  return v;
-};
-
-/** Generate a random valid My Number. */
-const generate = (): string => {
-  const payload = randomDigits(11);
-  const check = checkDigit(payload);
-  return `${payload}${String(check)}`;
-};
-
-/** Japanese Individual Number (My Number). */
-const mynumber: CountryValidator<"JP"> = {
-  name: "Japanese Individual Number",
-  localName: "マイナンバー",
-  abbreviation: "My Number",
-  aliases: [
-    "My Number",
-    "マイナンバー",
-    "個人番号",
-  ] as const,
-  candidatePattern: "\\d{4}[\\s-]?\\d{4}[\\s-]?\\d{4}",
-  scope: "country",
-  country: "JP",
-  entityType: "person",
-  description:
-    "12-digit personal identifier for tax" +
-    " and social security",
-  sourceUrl:
-    "https://en.wikipedia.org/wiki/Individual_Number",
-  lengths: [12] as const,
-  examples: ["123456789018", "000000000019"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default mynumber;
-export { compact, format, generate, validate };

package/src/kr/brn.ts

@@ -1,105 +0,0 @@
-/** Generate a random valid Korean BRN. */
-const generate = (): string => {
-  const office = String(randomInt(101, 999));
-  let bizType: string;
-  do {
-    bizType = randomDigits(2);
-  } while (bizType === "00");
-  let serial: string;
-  do {
-    serial = randomDigits(4);
-  } while (serial === "0000");
-  const last = randomDigits(1);
-  return `${office}${bizType}${serial}${last}`;
-};
-
-/**
- * BRN (Business Registration Number, 사업자등록번호).
- *
- * Korean Business Registration Number. 10 digits
- * formatted as XXX-XX-XXXXX. Validated by component
- * checks (tax office, business type, serial).
- *
- * @see https://en.wikipedia.org/wiki/Business_registration_number_(South_Korea)
- */
-
-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, " -");
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length !== 10) {
-    return err(
-      "INVALID_LENGTH",
-      "BRN must be exactly 10 digits",
-    );
-  }
-  if (!isdigits(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "BRN must contain only digits",
-    );
-  }
-  // Tax office number must be >= 101
-  if (v.slice(0, 3) < "101") {
-    return err(
-      "INVALID_COMPONENT",
-      "BRN tax office code must be >= 101",
-    );
-  }
-  // Business type must not be 00
-  if (v.slice(3, 5) === "00") {
-    return err(
-      "INVALID_COMPONENT",
-      "BRN business type must not be 00",
-    );
-  }
-  // Serial part must not be 0000
-  if (v.slice(5, 9) === "0000") {
-    return err(
-      "INVALID_COMPONENT",
-      "BRN serial must not be 0000",
-    );
-  }
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => {
-  const v = compact(value);
-  return `${v.slice(0, 3)}-${v.slice(3, 5)}-${v.slice(5)}`;
-};
-
-/** Korean Business Registration Number. */
-const brn: CountryValidator<"KR"> = {
-  name: "Korean Business Registration Number",
-  localName: "사업자등록번호",
-  abbreviation: "BRN",
-  aliases: ["사업자등록번호", "BRN"] as const,
-  candidatePattern: "\\d{3}-?\\d{2}-?\\d{5}",
-  scope: "country",
-  country: "KR",
-  entityType: "company",
-  description:
-    "10-digit business identifier issued by the National Tax Service",
-  sourceUrl:
-    "https://en.wikipedia.org/wiki/Business_registration_number_(South_Korea)",
-  lengths: [10] as const,
-  examples: ["1168200131", "2208162517"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default brn;
-export { compact, format, validate, generate };

package/src/kr/mod.ts

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

package/src/kr/rrn.ts

@@ -1,189 +0,0 @@
-/**
- * RRN (Resident Registration Number, 주민등록번호).
- *
- * Korean Resident Registration Number. 13 digits
- * formatted as YYMMDD-GPPCCSD. Encodes date of
- * birth, gender/century, place of birth, community
- * center, serial, and a check digit.
- *
- * @see https://en.wikipedia.org/wiki/Resident_registration_number
- */
-
-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";
-import { isdigits } from "#util/strings";
-
-const compact = (value: string): string =>
-  clean(value, " -/");
-
-const CHECK_WEIGHTS = [2, 3, 4, 5, 6, 7, 8, 9, 2, 3, 4, 5];
-
-/**
- * Compute the check digit for the first 12 digits.
- * Formula: (11 - sum(w_i * d_i) % 11) % 10.
- */
-const checkDigit = (digits: string): number => {
-  let sum = 0;
-  for (let i = 0; i < 12; i++) {
-    sum +=
-      (CHECK_WEIGHTS[i] ?? 0) * Number(digits.charAt(i));
-  }
-  return (11 - (sum % 11)) % 10;
-};
-
-/** Century prefix derived from the 7th digit. */
-const CENTURY_BY_GENDER: Record<string, number> = {
-  "0": 1800,
-  "1": 1900,
-  "2": 1900,
-  "3": 2000,
-  "4": 2000,
-  "5": 1900,
-  "6": 1900,
-  "7": 2000,
-  "8": 2000,
-  "9": 1800,
-};
-
-/**
- * Resolve birth date components from a compacted RRN.
- * Returns null if the date is invalid.
- */
-const resolveBirthDate = (
-  v: string,
-): { year: number; month: number; day: number } | null => {
-  const century = CENTURY_BY_GENDER[v.charAt(6)];
-  if (century === undefined) return null;
-
-  const year = century + Number(v.slice(0, 2));
-  const month = Number(v.slice(2, 4));
-  const day = Number(v.slice(4, 6));
-
-  if (!isValidDate(year, month, day)) return null;
-  return { year, month, day };
-};
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length !== 13) {
-    return err(
-      "INVALID_LENGTH",
-      "RRN must be exactly 13 digits",
-    );
-  }
-  if (!isdigits(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "RRN must contain only digits",
-    );
-  }
-  if (resolveBirthDate(v) === null) {
-    return err(
-      "INVALID_COMPONENT",
-      "RRN contains an invalid date of birth",
-    );
-  }
-  const place = Number(v.slice(7, 9));
-  if (place > 96) {
-    return err(
-      "INVALID_COMPONENT",
-      "RRN place-of-birth code must be <= 96",
-    );
-  }
-  if (checkDigit(v.slice(0, 12)) !== Number(v[12])) {
-    return err(
-      "INVALID_CHECKSUM",
-      "RRN check digit does not match",
-    );
-  }
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => {
-  const v = compact(value);
-  if (v.length === 13) {
-    return `${v.slice(0, 6)}-${v.slice(6)}`;
-  }
-  return v;
-};
-
-/**
- * Extract birth date and gender from an RRN.
- * Returns null if the value is not valid.
- *
- * Gender digit mapping:
- *   1, 3 = male Korean; 2, 4 = female Korean
- *   5, 7 = male foreigner; 6, 8 = female foreigner
- *   0, 9 = pre-1800 (male/female by convention)
- */
-const parse = (value: string): ParsedPersonId | null => {
-  const result = validate(value);
-  if (!result.valid) return null;
-
-  const v = result.compact;
-  const bd = resolveBirthDate(v);
-  if (bd === null) return null;
-
-  const genderDigit = v.charAt(6);
-  const isMale = "13579".includes(genderDigit);
-
-  return {
-    birthDate: new Date(bd.year, bd.month - 1, bd.day),
-    gender: isMale ? "male" : "female",
-  };
-};
-
-/** Generate a random valid Korean RRN. */
-const generate = (): string => {
-  const year = randomInt(1900, 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 genderDigit =
-    year >= 2000
-      ? String(randomInt(3, 4))
-      : String(randomInt(1, 2));
-  const place = String(randomInt(0, 96)).padStart(2, "0");
-  const body = `${yy}${month}${day}${genderDigit}${place}${randomDigits(3)}`;
-  return `${body}${String(checkDigit(body))}`;
-};
-
-/** Korean Resident Registration Number. */
-const rrn: CountryValidator<"KR", ParsedPersonId> = {
-  name: "Korean Resident Registration Number",
-  localName: "주민등록번호",
-  abbreviation: "RRN",
-  aliases: [
-    "RRN",
-    "주민등록번호",
-    "Resident Registration Number",
-  ] as const,
-  candidatePattern: "\\d{6}[\\s-]?\\d{7}",
-  scope: "country",
-  country: "KR",
-  entityType: "person",
-  description:
-    "13-digit personal identifier issued to all" +
-    " residents of South Korea",
-  sourceUrl:
-    "https://en.wikipedia.org/wiki/" +
-    "Resident_registration_number",
-  lengths: [13] as const,
-  examples: ["9710139019902", "9501011000109"] as const,
-  compact,
-  format,
-  parse,
-  validate,
-  generate,
-};
-
-export default rrn;
-export { compact, format, generate, parse, validate };