@stll/stdnum 2.1.1 → 2.1.2

package/src/bz/tin.ts

@@ -1,122 +0,0 @@
-/**
- * TIN (Belize Tax Identification Number).
- *
- * Issued by the Belize Tax Service Department to
- * individuals, sole proprietors, partnerships, and
- * companies. The base number is 6 digits generated
- * by the Revenue Management System. A 2-digit
- * suffix code may be appended to indicate entity
- * type:
- *   - 10: individual
- *   - 13: company
- *   - 66: company (alternate)
- *
- * The OECD spec mentions a 7th check digit that is
- * not visible to the taxpayer; in practice the
- * number circulates as 6 or 8 digits (6 + suffix).
- *
- * Formatted as NNNNNN-SS (when suffix is present).
- *
- * Source: OECD CRS TIN information sheet; Belize
- * Tax Service (https://bts.gov.bz/).
- *
- * PERSON/ENTITY
- *
- * @see https://www.oecd.org/tax/automatic-exchange/crs-implementation-and-assistance/tax-identification-numbers/Belize-TIN.pdf
- */
-
-import type {
-  ValidateResult,
-  CountryValidator,
-} from "../types";
-
-import { clean } from "#util/clean";
-import { randomDigits, randomInt } from "#util/generate";
-import { err } from "#util/result";
-
-/** Valid 2-digit suffix codes. */
-const SUFFIX_CODES = ["10", "13", "66"] as const;
-
-const compact = (value: string): string => {
-  return clean(value, " -").trim();
-};
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-
-  if (v.length !== 6 && v.length !== 8) {
-    return err(
-      "INVALID_LENGTH",
-      "Belize TIN must be 6 or 8 digits",
-    );
-  }
-
-  if (!/^\d+$/.test(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "Belize TIN must contain only digits",
-    );
-  }
-
-  if (v.length === 8) {
-    const suffix = v.slice(6);
-    if (
-      !SUFFIX_CODES.includes(
-        suffix as (typeof SUFFIX_CODES)[number],
-      )
-    ) {
-      return err(
-        "INVALID_COMPONENT",
-        "Belize TIN suffix must be 10, 13, or 66",
-      );
-    }
-  }
-
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => {
-  const v = compact(value);
-  if (v.length <= 6) {
-    return v;
-  }
-  return `${v.slice(0, 6)}-${v.slice(6)}`;
-};
-
-/** Generate a random valid Belize TIN. */
-const generate = (): string => {
-  const base = randomDigits(6);
-  const suffixes = ["", ...SUFFIX_CODES] as const;
-  const suffix =
-    suffixes[randomInt(0, suffixes.length - 1)] ?? "";
-  return `${base}${suffix}`;
-};
-
-/**
- * Belize Tax Identification Number.
- *
- * Examples derived from stdnum-js test suite.
- */
-const tin: CountryValidator<"BZ"> = {
-  name: "Belize Tax Identification Number",
-  localName: "Tax Identification Number",
-  abbreviation: "TIN",
-  aliases: ["TIN"] as const,
-  candidatePattern: "\\d{6}",
-  scope: "country",
-  country: "BZ",
-  entityType: "any",
-  lengths: [6, 8] as const,
-  examples: ["000005", "00000510", "00000513"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-  description:
-    "Belize tax number issued by the Belize Tax Service Department",
-  sourceUrl:
-    "https://www.oecd.org/tax/automatic-exchange/crs-implementation-and-assistance/tax-identification-numbers/Belize-TIN.pdf",
-};
-
-export default tin;
-export { compact, format, generate, validate };

package/src/ca/bn.ts

@@ -1,111 +0,0 @@
-/**
- * BN (Canadian Business Number).
- *
- * 9-digit BN root (Luhn checksum) optionally
- * followed by a 2-letter program type (RC, RM,
- * RP, RT) and a 4-digit reference number (BN15).
- *
- * @see https://www.canada.ca/en/services/taxes/business-number.html
- */
-
-import type {
-  ValidateResult,
-  CountryValidator,
-} from "../types";
-
-import {
-  luhnValidate,
-  luhnChecksum,
-} from "#checksums/luhn";
-import { clean } from "#util/clean";
-import { randomDigits } from "#util/generate";
-import { err } from "#util/result";
-import { isdigits } from "#util/strings";
-
-const VALID_PROGRAMS = new Set(["RC", "RM", "RP", "RT"]);
-
-const compact = (value: string): string =>
-  clean(value, " -");
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length !== 9 && v.length !== 15) {
-    return err(
-      "INVALID_LENGTH",
-      "BN must be 9 or 15 characters",
-    );
-  }
-  if (!isdigits(v.slice(0, 9))) {
-    return err(
-      "INVALID_FORMAT",
-      "BN root must contain only digits",
-    );
-  }
-  if (!luhnValidate(v.slice(0, 9))) {
-    return err(
-      "INVALID_CHECKSUM",
-      "BN Luhn check digit mismatch",
-    );
-  }
-  if (v.length === 15) {
-    const program = v.slice(9, 11);
-    if (!VALID_PROGRAMS.has(program)) {
-      return err(
-        "INVALID_COMPONENT",
-        "BN program type must be RC, RM, RP, or RT",
-      );
-    }
-    if (!isdigits(v.slice(11))) {
-      return err(
-        "INVALID_FORMAT",
-        "BN reference number must be digits",
-      );
-    }
-  }
-
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => {
-  const v = compact(value);
-  if (v.length === 15) {
-    return `${v.slice(0, 3)} ${v.slice(3, 6)} ${v.slice(6, 9)} ${v.slice(9, 11)} ${v.slice(11)}`;
-  }
-  if (v.length === 9) {
-    return `${v.slice(0, 3)} ${v.slice(3, 6)} ${v.slice(6)}`;
-  }
-  return v;
-};
-
-/** Generate a random valid Canadian BN. */
-const generate = (): string => {
-  const payload = randomDigits(8);
-  const cs = luhnChecksum(payload + "0");
-  return payload + String((10 - cs) % 10);
-};
-
-/** Canadian Business Number. */
-const bn: CountryValidator<"CA"> = {
-  name: "Business Number",
-  localName: "Business Number",
-  abbreviation: "BN",
-  aliases: [
-    "BN",
-    "Business Number",
-    "numéro d'entreprise",
-  ] as const,
-  candidatePattern: "\\d{9}\\s?[A-Z]{2}\\s?\\d{4}",
-  scope: "country",
-  country: "CA",
-  entityType: "company",
-  sourceUrl:
-    "https://www.canada.ca/en/services/taxes/business-number.html",
-  examples: ["123026635", "123026635RC0001"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default bn;
-export { compact, format, validate, generate };

package/src/ca/mod.ts

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

package/src/ca/sin.ts

@@ -1,95 +0,0 @@
-/**
- * SIN (Canadian Social Insurance Number).
- *
- * 9-digit identifier with Luhn checksum. First
- * digit cannot be 0 or 8.
- *
- * @see https://www.canada.ca/en/employment-social-development/services/sin.html
- * @see https://en.wikipedia.org/wiki/Social_Insurance_Number
- */
-
-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 compact = (value: string): string =>
-  clean(value, " -");
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (!isdigits(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "SIN must contain only digits",
-    );
-  }
-  if (v.length !== 9) {
-    return err("INVALID_LENGTH", "SIN must be 9 digits");
-  }
-  if (v[0] === "0" || v[0] === "8") {
-    return err(
-      "INVALID_COMPONENT",
-      "SIN cannot start with 0 or 8",
-    );
-  }
-  if (!luhnValidate(v)) {
-    return err(
-      "INVALID_CHECKSUM",
-      "SIN Luhn check digit mismatch",
-    );
-  }
-
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => {
-  const v = compact(value);
-  if (v.length === 9) {
-    return `${v.slice(0, 3)}-${v.slice(3, 6)}-${v.slice(6)}`;
-  }
-  return v;
-};
-
-/** Generate a random valid Canadian SIN. */
-const generate = (): string => {
-  const first = String(randomInt(1, 7));
-  const payload = first + randomDigits(7);
-  const cs = luhnChecksum(payload + "0");
-  return payload + String((10 - cs) % 10);
-};
-
-/** Canadian Social Insurance Number. */
-const sin: CountryValidator<"CA"> = {
-  name: "Social Insurance Number",
-  localName: "Social Insurance Number",
-  abbreviation: "SIN",
-  aliases: [
-    "SIN",
-    "Social Insurance Number",
-    "NAS",
-  ] as const,
-  candidatePattern: "\\d{3}-?\\d{3}-?\\d{3}",
-  scope: "country",
-  country: "CA",
-  entityType: "person",
-  sourceUrl:
-    "https://www.canada.ca/en/employment-social-development/services/sin.html",
-  examples: ["123456782"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default sin;
-export { compact, format, validate, generate };

package/src/ch/mod.ts

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

package/src/ch/ssn.ts

@@ -1,99 +0,0 @@
-/**
- * Swiss Social Security Number (AHV/AVS).
- *
- * 13 digits starting with 756. Uses EAN-13 checksum:
- * alternating weights (1, 3) from left, check digit
- * is (10 - sum % 10) % 10.
- *
- * @see https://www.bsv.admin.ch/
- */
-
-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 validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length !== 13) {
-    return err(
-      "INVALID_LENGTH",
-      "Swiss SSN must be 13 digits",
-    );
-  }
-  if (!isdigits(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "Swiss SSN must contain only digits",
-    );
-  }
-  if (!v.startsWith("756")) {
-    return err(
-      "INVALID_COMPONENT",
-      "Swiss SSN must start with 756",
-    );
-  }
-
-  let sum = 0;
-  for (let i = 0; i < 12; i++) {
-    const weight = i % 2 === 0 ? 1 : 3;
-    sum += Number(v[i]) * weight;
-  }
-  const check = (10 - (sum % 10)) % 10;
-  if (check !== Number(v[12])) {
-    return err(
-      "INVALID_CHECKSUM",
-      "Swiss SSN check digit mismatch",
-    );
-  }
-
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => {
-  const v = compact(value);
-  return `${v.slice(0, 3)}.${v.slice(3, 7)}.${v.slice(7, 11)}.${v.slice(11)}`;
-};
-
-/** Generate a random valid Swiss SSN. */
-const generate = (): string => {
-  const payload = "756" + randomDigits(9);
-  let sum = 0;
-  for (let i = 0; i < 12; i++)
-    sum += Number(payload[i]) * (i % 2 === 0 ? 1 : 3);
-  return payload + String((10 - (sum % 10)) % 10);
-};
-
-/** Swiss Social Security Number. */
-const ssn: CountryValidator<"CH"> = {
-  name: "Swiss Social Security Number",
-  localName: "AHV-Versichertennummer",
-  abbreviation: "AHV",
-  aliases: [
-    "AHV-Nummer",
-    "numéro AVS",
-    "AVS",
-    "AHV",
-  ] as const,
-  candidatePattern: "756\\.?\\d{4}\\.?\\d{4}\\.?\\d{2}",
-  scope: "country",
-  country: "CH",
-  entityType: "person",
-  sourceUrl: "https://www.bsv.admin.ch/",
-  examples: ["7561234567897"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default ssn;
-export { compact, format, validate, generate };

package/src/ch/uid.ts

@@ -1,112 +0,0 @@
-/**
- * UID (Unternehmens-Identifikationsnummer).
- *
- * Swiss business identification number. 12 characters:
- * "CHE" prefix + 9 digits. Check digit uses weights
- * [5,4,3,2,7,6,5,4] on the first 8 digits.
- *
- * @see https://www.uid.admin.ch/
- */
-
-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 = [5, 4, 3, 2, 7, 6, 5, 4] as const;
-
-const compact = (value: string): string =>
-  clean(value, " -./").toUpperCase();
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length !== 12) {
-    return err(
-      "INVALID_LENGTH",
-      "Swiss UID must be CHE + 9 digits",
-    );
-  }
-  if (!v.startsWith("CHE")) {
-    return err(
-      "INVALID_COMPONENT",
-      "Swiss UID must start with CHE",
-    );
-  }
-  const digits = v.slice(3);
-  if (!isdigits(digits)) {
-    return err(
-      "INVALID_FORMAT",
-      "Swiss UID must be CHE + 9 digits",
-    );
-  }
-
-  let sum = 0;
-  for (let i = 0; i < 8; i++) {
-    sum += Number(digits.charAt(i)) * (WEIGHTS[i] ?? 0);
-  }
-  const check = (11 - (sum % 11)) % 11;
-  if (check === 10) {
-    return err(
-      "INVALID_CHECKSUM",
-      "Swiss UID check digit is invalid",
-    );
-  }
-  if (check !== Number(digits[8])) {
-    return err(
-      "INVALID_CHECKSUM",
-      "Swiss UID check digit mismatch",
-    );
-  }
-
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => {
-  const v = compact(value);
-  const d = v.slice(3);
-  return `CHE-${d.slice(0, 3)}.${d.slice(3, 6)}.${d.slice(6)}`;
-};
-
-/** Generate a random valid Swiss UID. */
-const generate = (): string => {
-  for (let i = 0; i < 100; i++) {
-    const payload = randomDigits(8);
-    let sum = 0;
-    for (let j = 0; j < 8; j++)
-      sum += Number(payload.charAt(j)) * (WEIGHTS[j] ?? 0);
-    const check = (11 - (sum % 11)) % 11;
-    if (check === 10) continue;
-    return "CHE" + payload + String(check);
-  }
-  throw new Error("Failed to generate valid Swiss UID");
-};
-
-/** Swiss Business Identification Number. */
-const uid: CountryValidator<"CH"> = {
-  name: "Swiss Business ID",
-  localName: "Unternehmens-Identifikationsnummer",
-  abbreviation: "UID",
-  aliases: [
-    "Unternehmens-Identifikationsnummer",
-    "UID",
-    "IDE",
-  ] as const,
-  candidatePattern: "CHE-?\\d{3}\\.?\\d{3}\\.?\\d{3}",
-  scope: "country",
-  country: "CH",
-  entityType: "company",
-  sourceUrl: "https://www.uid.admin.ch/",
-  examples: ["CHE100155212"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default uid;
-export { compact, format, validate, generate };

package/src/ch/vat.ts

@@ -1,89 +0,0 @@
-/**
- * Swiss VAT number.
- *
- * Format: CHE + 9 digits + suffix (MWST|TVA|IVA|TPV).
- * The numeric part is validated as a UID.
- *
- * @see https://www.ch.ch/en/value-added-tax-number-und-business-identification-number/
- * @see https://www.estv.admin.ch/
- */
-
-import type {
-  ValidateResult,
-  CountryValidator,
-} from "../types";
-import {
-  validate as validateUid,
-  generate as generateUid,
-} from "./uid";
-
-import { clean } from "#util/clean";
-import { err } from "#util/result";
-
-const SUFFIXES = ["MWST", "TVA", "IVA", "TPV"] as const;
-
-const compact = (value: string): string =>
-  clean(value, " -./").toUpperCase();
-
-const extractParts = (
-  v: string,
-): { uid: string; suffix: string } | undefined => {
-  for (const s of SUFFIXES) {
-    if (v.endsWith(s)) {
-      return { uid: v.slice(0, -s.length), suffix: s };
-    }
-  }
-  return undefined;
-};
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-
-  const parts = extractParts(v);
-  if (!parts) {
-    return err(
-      "INVALID_FORMAT",
-      "Swiss VAT must end with MWST, TVA, IVA, or TPV",
-    );
-  }
-
-  const uidResult = validateUid(parts.uid);
-  if (!uidResult.valid) {
-    return uidResult;
-  }
-
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => {
-  const v = compact(value);
-  const parts = extractParts(v);
-  if (!parts) return v;
-  const d = parts.uid.slice(3);
-  return `CHE-${d.slice(0, 3)}.${d.slice(3, 6)}.${d.slice(6)} ${parts.suffix}`;
-};
-
-/** Generate a random valid Swiss VAT number. */
-const generate = (): string => generateUid() + "MWST";
-
-/** Swiss VAT Number. */
-const vat: CountryValidator<"CH"> = {
-  name: "Swiss VAT Number",
-  localName: "Mehrwertsteuernummer",
-  abbreviation: "MWST",
-  aliases: ["MWST", "TVA", "IVA"] as const,
-  candidatePattern:
-    "CHE-?\\d{3}\\.?\\d{3}\\.?\\d{3}\\s?(?:MWST|TVA|IVA)",
-  scope: "country",
-  country: "CH",
-  entityType: "company",
-  sourceUrl: "https://www.estv.admin.ch/",
-  examples: ["CHE107787577IVA"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default vat;
-export { compact, format, validate, generate };

package/src/cl/mod.ts

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