@stll/stdnum 2.1.1 → 2.1.2

package/src/us/ein.ts

@@ -1,261 +0,0 @@
-const EIN_PREFIXES = [
-  "01",
-  "02",
-  "03",
-  "04",
-  "05",
-  "06",
-  "10",
-  "11",
-  "12",
-  "13",
-  "14",
-  "15",
-  "16",
-  "20",
-  "21",
-  "22",
-  "23",
-  "24",
-  "25",
-  "26",
-  "27",
-  "30",
-  "31",
-  "32",
-  "33",
-  "34",
-  "35",
-  "36",
-  "37",
-  "38",
-  "39",
-  "40",
-  "41",
-  "42",
-  "43",
-  "44",
-  "45",
-  "46",
-  "47",
-  "48",
-  "50",
-  "51",
-  "52",
-  "53",
-  "54",
-  "55",
-  "56",
-  "57",
-  "58",
-  "59",
-  "60",
-  "61",
-  "62",
-  "63",
-  "64",
-  "65",
-  "66",
-  "67",
-  "68",
-  "71",
-  "72",
-  "73",
-  "74",
-  "75",
-  "76",
-  "77",
-  "80",
-  "81",
-  "82",
-  "83",
-  "84",
-  "85",
-  "86",
-  "87",
-  "88",
-  "90",
-  "91",
-  "92",
-  "93",
-  "94",
-  "95",
-  "98",
-  "99",
-] as const;
-
-/** Generate a random valid U.S. EIN. */
-const generate = (): string => {
-  const prefix = randomPick(EIN_PREFIXES);
-  return prefix + randomDigits(7);
-};
-
-/**
- * EIN (U.S. Employer Identification Number).
- *
- * 9-digit identifier: 2-digit campus prefix +
- * 7-digit group. No checksum. The first 2 digits
- * must be a valid IRS campus code.
- *
- * @see https://en.wikipedia.org/wiki/Employer_Identification_Number
- * @see https://www.irs.gov/businesses/small-businesses-self-employed/how-eins-are-assigned-and-valid-ein-prefixes
- */
-
-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 EIN campus prefixes. Sourced from IRS
- * documentation and python-stdnum's numdb.
- */
-const VALID_PREFIXES = new Set([
-  "01",
-  "02",
-  "03",
-  "04",
-  "05",
-  "06",
-  "10",
-  "11",
-  "12",
-  "13",
-  "14",
-  "15",
-  "16",
-  "20",
-  "21",
-  "22",
-  "23",
-  "24",
-  "25",
-  "26",
-  "27",
-  "30",
-  "31",
-  "32",
-  "33",
-  "34",
-  "35",
-  "36",
-  "37",
-  "38",
-  "39",
-  "40",
-  "41",
-  "42",
-  "43",
-  "44",
-  "45",
-  "46",
-  "47",
-  "48",
-  "50",
-  "51",
-  "52",
-  "53",
-  "54",
-  "55",
-  "56",
-  "57",
-  "58",
-  "59",
-  "60",
-  "61",
-  "62",
-  "63",
-  "64",
-  "65",
-  "66",
-  "67",
-  "68",
-  "71",
-  "72",
-  "73",
-  "74",
-  "75",
-  "76",
-  "77",
-  "80",
-  "81",
-  "82",
-  "83",
-  "84",
-  "85",
-  "86",
-  "87",
-  "88",
-  "90",
-  "91",
-  "92",
-  "93",
-  "94",
-  "95",
-  "98",
-  "99",
-]);
-
-const compact = (value: string): string =>
-  clean(value, " -");
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (!isdigits(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "EIN must contain only digits",
-    );
-  }
-  if (v.length !== 9) {
-    return err("INVALID_LENGTH", "EIN must be 9 digits");
-  }
-  const prefix = v.slice(0, 2);
-  if (!VALID_PREFIXES.has(prefix)) {
-    return err(
-      "INVALID_COMPONENT",
-      "EIN campus prefix is invalid",
-    );
-  }
-
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => {
-  const v = compact(value);
-  if (v.length === 9) {
-    return `${v.slice(0, 2)}-${v.slice(2)}`;
-  }
-  return v;
-};
-
-/** U.S. Employer Identification Number. */
-const ein: CountryValidator<"US"> = {
-  name: "Employer Identification Number",
-  localName: "Employer Identification Number",
-  abbreviation: "EIN",
-  aliases: [
-    "EIN",
-    "Employer Identification Number",
-    "Federal Tax ID",
-  ] as const,
-  candidatePattern: "\\d{2}-?\\d{7}",
-  scope: "country",
-  country: "US",
-  entityType: "company",
-  sourceUrl:
-    "https://www.irs.gov/businesses/small-businesses-self-employed/how-eins-are-assigned-and-valid-ein-prefixes",
-  examples: ["042103594"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default ein;
-export { compact, format, validate, generate };

package/src/us/itin.ts

@@ -1,129 +0,0 @@
-const ITIN_ALLOWED_GROUPS = Array.from(
-  { length: 30 },
-  (_, i) => i + 70,
-).filter((g) => g !== 89 && g !== 93);
-
-/** Generate a random valid U.S. ITIN. */
-const generate = (): string => {
-  const area = "9" + randomDigits(2);
-  const group = String(randomPick(ITIN_ALLOWED_GROUPS));
-  const serial = randomDigits(4);
-  return `${area}${group}${serial}`;
-};
-
-/**
- * ITIN (U.S. Individual Taxpayer Identification
- * Number).
- *
- * 9-digit number issued by the IRS to individuals
- * who need a taxpayer ID but are not eligible for
- * an SSN. Starts with 9; digits 4-5 (the "group")
- * must be in the range 70-99 excluding 89 and 93.
- *
- * @see https://www.irs.gov/individuals/individual-taxpayer-identification-number
- */
-
-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";
-
-const ITIN_RE = /^(?<area>\d{3})-?(?<group>\d{2})-?\d{4}$/;
-
-/** Groups 70-99 excluding 89 and 93. */
-const ALLOWED_GROUPS = new Set(
-  Array.from({ length: 30 }, (_, i) => i + 70)
-    .filter((g) => g !== 89 && g !== 93)
-    .map(String),
-);
-
-const compact = (value: string): string =>
-  clean(value, " -");
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (!isdigits(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "ITIN must contain only digits",
-    );
-  }
-  if (v.length !== 9) {
-    return err("INVALID_LENGTH", "ITIN must be 9 digits");
-  }
-
-  const match = ITIN_RE.exec(v);
-  if (!match?.groups) {
-    return err(
-      "INVALID_FORMAT",
-      "ITIN must be 9 digits, optionally " +
-        "formatted as NNN-NN-NNNN",
-    );
-  }
-
-  const { area, group } = match.groups;
-  if (!area || !group) {
-    return err("INVALID_FORMAT", "ITIN must be 9 digits");
-  }
-
-  if (area[0] !== "9") {
-    return err(
-      "INVALID_COMPONENT",
-      "ITIN area must start with 9",
-    );
-  }
-
-  if (!ALLOWED_GROUPS.has(group)) {
-    return err(
-      "INVALID_COMPONENT",
-      "ITIN group digits are not in the " +
-        "allowed range (70-99 excl. 89, 93)",
-    );
-  }
-
-  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, 5)}` + `-${v.slice(5)}`
-    );
-  }
-  return v;
-};
-
-/**
- * U.S. Individual Taxpayer Identification Number.
- */
-const itin: CountryValidator<"US"> = {
-  name: "Individual Taxpayer Identification Number",
-  localName: "Individual Taxpayer Identification Number",
-  abbreviation: "ITIN",
-  aliases: [
-    "ITIN",
-    "Individual Taxpayer Identification Number",
-  ] as const,
-  candidatePattern: "9\\d{2}[\\s-]?\\d{2}[\\s-]?\\d{4}",
-  scope: "country",
-  country: "US",
-  entityType: "person",
-  sourceUrl:
-    "https://www.irs.gov/individuals/" +
-    "individual-taxpayer-identification-number",
-  lengths: [9] as const,
-  examples: ["912-90-3456"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default itin;
-export { compact, format, validate, generate };

package/src/us/mod.ts

@@ -1,4 +0,0 @@
-export { default as ein } from "./ein";
-export { default as itin } from "./itin";
-export { default as rtn } from "./rtn";
-export { default as ssn } from "./ssn";

package/src/us/rtn.ts

@@ -1,139 +0,0 @@
-/**
- * RTN (Routing Transit Number / ABA Number).
- *
- * 9-digit number used by U.S. financial institutions
- * for routing wire transfers, ACH, and check
- * processing. Uses a weighted checksum with weights
- * [3, 7, 1] repeated three times.
- *
- * The first two digits identify the Federal Reserve
- * district (01-12) or special ranges (00 for U.S.
- * Government, 21-32 for thrifts, 61-72 for electronic,
- * 80 for traveler's cheques).
- *
- * @see https://en.wikipedia.org/wiki/ABA_routing_transit_number
- * @see https://www.frbservices.org/
- */
-
-import type {
-  ValidateResult,
-  CountryValidator,
-} from "../types";
-
-import { clean } from "#util/clean";
-import {
-  randomDigits,
-  randomInt,
-  randomPick,
-} from "#util/generate";
-import { err } from "#util/result";
-import { isdigits } from "#util/strings";
-
-const WEIGHTS = [3, 7, 1, 3, 7, 1, 3, 7, 1] as const;
-
-const compact = (value: string): string =>
-  clean(value, " -").trim();
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-
-  if (v.length !== 9) {
-    return err("INVALID_LENGTH", "RTN must be 9 digits");
-  }
-
-  if (!isdigits(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "RTN must contain only digits",
-    );
-  }
-
-  // Validate Federal Reserve prefix (first 2 digits)
-  const prefix = Number(v.slice(0, 2));
-  const validPrefixRanges =
-    // 00 is reserved for U.S. Government and federal
-    // agencies per the ABA Routing Number Policy;
-    // 01-12 are the 12 Federal Reserve districts.
-    // @see https://en.wikipedia.org/wiki/ABA_routing_transit_number
-    (prefix >= 0 && prefix <= 12) ||
-    (prefix >= 21 && prefix <= 32) ||
-    (prefix >= 61 && prefix <= 72) ||
-    prefix === 80;
-  if (!validPrefixRanges) {
-    return err(
-      "INVALID_COMPONENT",
-      "RTN has an invalid Federal Reserve district",
-    );
-  }
-
-  // Weighted checksum must be divisible by 10
-  let sum = 0;
-  for (const [i, weight] of WEIGHTS.entries()) {
-    sum += Number(v[i]) * weight;
-  }
-  if (sum % 10 !== 0) {
-    return err(
-      "INVALID_CHECKSUM",
-      "RTN checksum is invalid",
-    );
-  }
-
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => compact(value);
-
-/** All valid Federal Reserve prefix ranges. */
-const PREFIX_RANGES: readonly [number, number][] = [
-  [0, 12],
-  [21, 32],
-  [61, 72],
-  [80, 80],
-];
-
-/** Generate a random valid U.S. RTN. */
-const generate = (): string => {
-  const [low, high] = randomPick(PREFIX_RANGES);
-  const prefix = String(randomInt(low, high)).padStart(
-    2,
-    "0",
-  );
-  const mid = randomDigits(6);
-  const body = prefix + mid;
-  let sum = 0;
-  for (const [i, weight] of WEIGHTS.entries()) {
-    if (i >= 8) break;
-    sum += Number(body[i]) * weight;
-  }
-  const check = (10 - (sum % 10)) % 10;
-  return body + String(check);
-};
-
-/** U.S. Routing Transit Number. */
-const rtn: CountryValidator<"US"> = {
-  name: "Routing Transit Number",
-  localName: "Routing Transit Number",
-  abbreviation: "RTN",
-  aliases: [
-    "RTN",
-    "ABA",
-    "Routing Number",
-    "ABA Routing Number",
-    "Routing Transit Number",
-  ] as const,
-  candidatePattern: "\\d{9}",
-  scope: "country",
-  country: "US",
-  entityType: "company",
-  sourceUrl:
-    "https://en.wikipedia.org/wiki/ABA_routing_transit_number",
-  lengths: [9] as const,
-  examples: ["111000025", "021000021"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default rtn;
-export { compact, format, validate, generate };

package/src/us/ssn.ts

@@ -1,121 +0,0 @@
-/** Generate a random valid U.S. SSN. */
-const generate = (): string => {
-  for (;;) {
-    let area: string;
-    do {
-      area = String(randomInt(1, 899)).padStart(3, "0");
-    } while (area === "666");
-    const group = String(randomInt(1, 99)).padStart(2, "0");
-    const serial = String(randomInt(1, 9999)).padStart(
-      4,
-      "0",
-    );
-    const ssn = `${area}${group}${serial}`;
-    if (!BLACKLIST.has(ssn)) return ssn;
-  }
-};
-
-/**
- * SSN (U.S. Social Security Number).
- *
- * 9-digit identifier: 3-digit area, 2-digit group,
- * 4-digit serial. No checksum. Area cannot be 000,
- * 666, or 900-999; group cannot be 00; serial
- * cannot be 0000.
- *
- * @see https://en.wikipedia.org/wiki/Social_Security_number
- * @see https://www.ssa.gov/employer/verifySSN.htm
- */
-
-import type {
-  ValidateResult,
-  CountryValidator,
-} from "../types";
-
-import { clean } from "#util/clean";
-import { randomInt } from "#util/generate";
-import { err } from "#util/result";
-import { isdigits } from "#util/strings";
-
-/** Known-invalid SSNs used in advertisements. */
-const BLACKLIST = new Set([
-  "078051120",
-  "457555462",
-  "219099999",
-]);
-
-const compact = (value: string): string =>
-  clean(value, " -");
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (!isdigits(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "SSN must contain only digits",
-    );
-  }
-  if (v.length !== 9) {
-    return err("INVALID_LENGTH", "SSN must be 9 digits");
-  }
-
-  const area = v.slice(0, 3);
-  const group = v.slice(3, 5);
-  const serial = v.slice(5, 9);
-
-  if (area === "000" || area === "666" || area[0] === "9") {
-    return err(
-      "INVALID_COMPONENT",
-      "SSN area number is invalid",
-    );
-  }
-  if (group === "00") {
-    return err(
-      "INVALID_COMPONENT",
-      "SSN group number cannot be 00",
-    );
-  }
-  if (serial === "0000") {
-    return err(
-      "INVALID_COMPONENT",
-      "SSN serial number cannot be 0000",
-    );
-  }
-  if (BLACKLIST.has(v)) {
-    return err(
-      "INVALID_COMPONENT",
-      "SSN is on the blacklist",
-    );
-  }
-
-  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, 5)}-${v.slice(5)}`;
-  }
-  return v;
-};
-
-/** U.S. Social Security Number. */
-const ssn: CountryValidator<"US"> = {
-  name: "Social Security Number",
-  localName: "Social Security Number",
-  abbreviation: "SSN",
-  aliases: ["SSN", "Social Security Number"] as const,
-  candidatePattern: "\\d{3}-?\\d{2}-?\\d{4}",
-  scope: "country",
-  country: "US",
-  entityType: "person",
-  sourceUrl: "https://www.ssa.gov/employer/verifySSN.htm",
-  examples: ["536904399"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default ssn;
-export { compact, format, validate, generate };

package/src/uy/mod.ts

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