@stll/stdnum 2.1.0 → 2.1.2

package/src/fr/tva.ts

@@ -1,150 +0,0 @@
-/**
- * n° TVA (Numéro de TVA intracommunautaire).
- *
- * French VAT number. 11 characters: 2-char
- * check prefix + 9-digit SIREN. The prefix
- * can be numeric (old style) or alphanumeric
- * (new style, letters from a restricted
- * alphabet excluding I and O).
- *
- * @see https://www.economie.gouv.fr/
- */
-
-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 ALPHABET = "0123456789ABCDEFGHJKLMNPQRSTUVWXYZ";
-
-const compact = (value: string): string => {
-  let v = clean(value, " -.");
-  if (v.startsWith("FR") || v.startsWith("fr")) {
-    v = v.slice(2);
-  }
-  return v.toUpperCase();
-};
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length !== 11) {
-    return err(
-      "INVALID_LENGTH",
-      "French TVA must be 11 characters",
-    );
-  }
-
-  const prefix = v.slice(0, 2);
-  const siren = v.slice(2);
-
-  if (!isdigits(siren)) {
-    return err(
-      "INVALID_FORMAT",
-      "French TVA SIREN part must be digits",
-    );
-  }
-
-  // Validate prefix characters are in alphabet
-  const p0 = prefix[0] ?? "";
-  const p1 = prefix[1] ?? "";
-  if (
-    ALPHABET.indexOf(p0) < 0 ||
-    ALPHABET.indexOf(p1) < 0
-  ) {
-    return err(
-      "INVALID_FORMAT",
-      "French TVA prefix contains invalid chars",
-    );
-  }
-
-  // SIREN validation (skip Monaco: starts with 000)
-  if (!siren.startsWith("000") && !luhnValidate(siren)) {
-    return err(
-      "INVALID_CHECKSUM",
-      "French TVA SIREN part fails Luhn check",
-    );
-  }
-
-  const c0 = ALPHABET.indexOf(p0);
-  const c1 = ALPHABET.indexOf(p1);
-
-  if (c0 < 10 && c1 < 10) {
-    // Old-style: both digits numeric
-    const check = Number(prefix);
-    const expected = Number(siren + "12") % 97;
-    if (check !== expected) {
-      return err(
-        "INVALID_CHECKSUM",
-        "French TVA check digits mismatch",
-      );
-    }
-  } else {
-    // New-style: at least one letter
-    let cvalue: number;
-    if (c0 < 10) {
-      cvalue = c0 * 24 + c1 - 10;
-    } else {
-      cvalue = c0 * 34 + c1 - 100;
-    }
-    const sirenNum = Number(siren);
-    if (
-      (sirenNum + 1 + Math.floor(cvalue / 11)) % 11 !==
-      cvalue % 11
-    ) {
-      return err(
-        "INVALID_CHECKSUM",
-        "French TVA check digits mismatch",
-      );
-    }
-  }
-
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string =>
-  `FR${compact(value)}`;
-
-/** Generate a random valid French TVA. */
-const generate = (): string => {
-  const sp = randomDigits(8);
-  const cs = luhnChecksum(sp + "0");
-  const siren = sp + String((10 - cs) % 10);
-  const prefix = String(
-    (12 + 3 * (Number(siren) % 97)) % 97,
-  ).padStart(2, "0");
-  return prefix + siren;
-};
-
-/** French VAT Number. */
-const tva: CountryValidator<"FR"> = {
-  name: "French VAT Number",
-  localName: "Numéro de TVA intracommunautaire",
-  abbreviation: "TVA",
-  aliases: [
-    "numéro de TVA",
-    "TVA intracommunautaire",
-    "FR VAT",
-  ] as const,
-  candidatePattern: "FR[A-Z0-9]{2}\\d{9}",
-  scope: "country",
-  country: "FR",
-  entityType: "company",
-  sourceUrl: "https://www.economie.gouv.fr/",
-  examples: ["40303265045", "K7399859412"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default tva;
-export { compact, format, validate, generate };

package/src/gb/mod.ts

@@ -1,5 +0,0 @@
-export { default as nhs } from "./nhs";
-export { default as nino } from "./nino";
-export { default as sedol } from "./sedol";
-export { default as utr } from "./utr";
-export { default as vat } from "./vat";

package/src/gb/nhs.ts

@@ -1,92 +0,0 @@
-/**
- * UK NHS Number.
- *
- * Validates the 10-digit NHS number using the
- * modulus 11 checksum used by NHS England.
- */
-
-import type {
-  CountryValidator,
-  ValidateResult,
-} from "../types";
-
-import { clean } from "#util/clean";
-import { err } from "#util/result";
-import { isdigits } from "#util/strings";
-
-const NHS_NUMBER_LENGTH = 10;
-const CHECK_DIGIT_INDEX = 9;
-
-const compact = (value: string): string =>
-  clean(value, " ");
-
-const calcCheckDigit = (value: string): number | null => {
-  if (value.length !== NHS_NUMBER_LENGTH) return null;
-  if (!isdigits(value)) return null;
-
-  let total = 0;
-  for (let i = 0; i < CHECK_DIGIT_INDEX; i += 1) {
-    total += Number(value.charAt(i)) * (10 - i);
-  }
-
-  const check = 11 - (total % 11);
-  if (check === 10) return null;
-  return check === 11 ? 0 : check;
-};
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length !== NHS_NUMBER_LENGTH) {
-    return err(
-      "INVALID_LENGTH",
-      "NHS number must be 10 digits",
-    );
-  }
-  if (!isdigits(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "NHS number must contain only digits",
-    );
-  }
-
-  const check = calcCheckDigit(v);
-  if (
-    check === null ||
-    check !== Number(v.charAt(CHECK_DIGIT_INDEX))
-  ) {
-    return err(
-      "INVALID_CHECKSUM",
-      "NHS number fails modulus 11 check",
-    );
-  }
-
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => {
-  const v = compact(value);
-  if (v.length !== NHS_NUMBER_LENGTH) return v;
-  return `${v.slice(0, 3)} ${v.slice(3, 6)} ${v.slice(6)}`;
-};
-
-const nhs: CountryValidator<"GB"> = {
-  scope: "country",
-  country: "GB",
-  name: "UK NHS Number",
-  localName: "NHS number",
-  abbreviation: "NHS",
-  aliases: [
-    "NHS number",
-    "National Health Service number",
-  ] as const,
-  candidatePattern: "\\d{3}\\s?\\d{3}\\s?\\d{4}",
-  entityType: "person",
-  lengths: [NHS_NUMBER_LENGTH] as const,
-  examples: ["4010232137"] as const,
-  compact,
-  format,
-  validate,
-};
-
-export default nhs;
-export { calcCheckDigit, compact, format, validate };

package/src/gb/nino.ts

@@ -1,158 +0,0 @@
-const NINO_VALID_FIRST = "ABCEGHJKLMNOPRSTWXYZ";
-const NINO_VALID_SECOND = "ABCEGHJKLMNPRSTWXYZ";
-const NINO_SUFFIXES = "ABCD";
-
-/** Generate a random valid UK NINO. */
-const generate = (): string => {
-  let first: string;
-  let second: string;
-  let prefix: string;
-  do {
-    first = randomChar(NINO_VALID_FIRST);
-    second = randomChar(NINO_VALID_SECOND);
-    prefix = first + second;
-  } while (INVALID_PREFIX.has(prefix));
-  const digits = randomDigits(6);
-  const suffix = randomChar(NINO_SUFFIXES);
-  return `${prefix}${digits}${suffix}`;
-};
-
-/**
- * NINO (National Insurance Number).
- *
- * UK National Insurance Number. Format: 2 letters
- * + 6 digits + 1 suffix letter (A, B, C, or D).
- * Validated by format and prefix rules only; there
- * is no checksum.
- *
- * @see https://www.gov.uk/hmrc-internal-manuals/national-insurance-manual/nim39110
- */
-
-import type {
-  ValidateResult,
-  CountryValidator,
-} from "../types";
-
-import { clean } from "#util/clean";
-import { randomChar, randomDigits } from "#util/generate";
-import { err } from "#util/result";
-
-const INVALID_FIRST = new Set([
-  "D",
-  "F",
-  "I",
-  "Q",
-  "U",
-  "V",
-]);
-
-const INVALID_SECOND = new Set([
-  "D",
-  "F",
-  "I",
-  "O",
-  "Q",
-  "U",
-  "V",
-]);
-
-const INVALID_PREFIX = new Set([
-  "BG",
-  "GB",
-  "NK",
-  "KN",
-  "TN",
-  "NT",
-  "ZZ",
-]);
-
-const compact = (value: string): string =>
-  clean(value, " -").toUpperCase();
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length !== 9) {
-    return err(
-      "INVALID_LENGTH",
-      "UK NINO must be 9 characters",
-    );
-  }
-
-  if (!/^[A-Z]{2}\d{6}[A-D]$/.test(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "UK NINO must be 2 letters, 6 digits, " +
-        "then A/B/C/D",
-    );
-  }
-
-  // SAFETY: regex above guarantees v.length === 9.
-  // eslint-disable-next-line no-non-null-assertion
-  const first = v[0]!;
-  // eslint-disable-next-line no-non-null-assertion
-  const second = v[1]!;
-  const prefix = v.slice(0, 2);
-
-  if (INVALID_FIRST.has(first)) {
-    return err(
-      "INVALID_COMPONENT",
-      `UK NINO first letter cannot be ${first}`,
-    );
-  }
-
-  if (INVALID_SECOND.has(second)) {
-    return err(
-      "INVALID_COMPONENT",
-      `UK NINO second letter cannot be ${second}`,
-    );
-  }
-
-  if (INVALID_PREFIX.has(prefix)) {
-    return err(
-      "INVALID_COMPONENT",
-      `UK NINO prefix ${prefix} is not allowed`,
-    );
-  }
-
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => {
-  const v = compact(value);
-  return (
-    `${v.slice(0, 2)} ${v.slice(2, 4)}` +
-    ` ${v.slice(4, 6)} ${v.slice(6, 8)}` +
-    ` ${v.slice(8)}`
-  );
-};
-
-/** UK National Insurance Number. */
-const nino: CountryValidator<"GB"> = {
-  name: "UK National Insurance Number",
-  localName: "National Insurance Number",
-  abbreviation: "NINO",
-  aliases: [
-    "National Insurance number",
-    "NINO",
-    "NI number",
-  ] as const,
-  candidatePattern: "[A-Z]{2}\\d{6}[A-Z]",
-  scope: "country",
-  country: "GB",
-  entityType: "person",
-  description:
-    "UK National Insurance Number for tax " +
-    "and benefits",
-  sourceUrl:
-    "https://www.gov.uk/hmrc-internal-manuals/" +
-    "national-insurance-manual/nim39110",
-  lengths: [9] as const,
-  examples: ["AB123456C"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default nino;
-export { compact, format, validate, generate };

package/src/gb/sedol.ts

@@ -1,143 +0,0 @@
-/**
- * SEDOL (Stock Exchange Daily Official List number).
- *
- * 7-character security identifier used in the UK and
- * Ireland, assigned by the London Stock Exchange.
- * Consists of 6 alphanumeric characters (vowels
- * excluded) followed by a weighted mod-10 check
- * digit.
- *
- * @see https://en.wikipedia.org/wiki/SEDOL
- */
-
-import type {
-  ValidateResult,
-  CountryValidator,
-} from "../types";
-
-import { clean } from "#util/clean";
-import { randomChar } from "#util/generate";
-import { err } from "#util/result";
-import { isdigits } from "#util/strings";
-
-/**
- * Allowed characters in a SEDOL: digits and
- * consonants only (vowels are never used).
- * Spaces occupy vowel positions (A=10, E=14,
- * I=18, O=24, U=30) so that indexOf returns
- * the correct SEDOL weight for each consonant.
- */
-const ALPHABET = "0123456789 BCD FGH JKLMN PQRST VWXYZ";
-
-const WEIGHTS = [1, 3, 1, 7, 3, 9] as const;
-
-const calcCheckDigit = (number: string): string => {
-  if (number.length !== 6) {
-    throw new Error(
-      "calcCheckDigit requires a 6-character " +
-        "SEDOL prefix",
-    );
-  }
-  let sum = 0;
-  for (const [i, weight] of WEIGHTS.entries()) {
-    const ch = number[i];
-    if (ch === undefined) continue;
-    const val = ALPHABET.indexOf(ch);
-    if (val < 0) {
-      throw new Error(`Invalid SEDOL character: ${ch}`);
-    }
-    sum += weight * val;
-  }
-  return String((10 - (sum % 10)) % 10);
-};
-
-const compact = (value: string): string =>
-  clean(value, " ").toUpperCase();
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-
-  if (v.length !== 7) {
-    return err(
-      "INVALID_LENGTH",
-      "SEDOL must be exactly 7 characters",
-    );
-  }
-
-  for (const ch of v) {
-    if (!ALPHABET.includes(ch)) {
-      return err(
-        "INVALID_FORMAT",
-        "SEDOL contains invalid character: " +
-          "vowels are not allowed",
-      );
-    }
-  }
-
-  // Old-style SEDOLs are fully numeric; new-style
-  // SEDOLs start with a letter. A number that starts
-  // with a digit but contains letters is invalid.
-  // SAFETY: v.length === 7 here.
-  // eslint-disable-next-line no-non-null-assertion
-  if (isdigits(v[0]!) && !isdigits(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "Numeric-prefix SEDOL must be fully " +
-        "numeric (old-style)",
-    );
-  }
-
-  if (calcCheckDigit(v.slice(0, 6)) !== v[6]) {
-    return err(
-      "INVALID_CHECKSUM",
-      "SEDOL check digit mismatch",
-    );
-  }
-
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => compact(value);
-
-const SEDOL_CONSONANTS = "BCDFGHJKLMNPQRSTVWXYZ";
-const SEDOL_CHARS = "0123456789BCDFGHJKLMNPQRSTVWXYZ";
-
-/** Generate a random valid SEDOL. */
-const generate = (): string => {
-  let payload = randomChar(SEDOL_CONSONANTS);
-  for (let i = 1; i < 6; i++) {
-    payload += randomChar(SEDOL_CHARS);
-  }
-  return payload + calcCheckDigit(payload);
-};
-
-/** Stock Exchange Daily Official List number. */
-const sedol: CountryValidator<"GB"> = {
-  name: "Stock Exchange Daily Official List number",
-  localName: "Stock Exchange Daily Official List number",
-  abbreviation: "SEDOL",
-  aliases: [
-    "SEDOL",
-    "Stock Exchange Daily Official List",
-  ] as const,
-  candidatePattern: "[B-DF-HJ-NP-TV-Z0-9]{6}\\d",
-  scope: "country",
-  country: "GB",
-  entityType: "any",
-  sourceUrl: "https://en.wikipedia.org/wiki/SEDOL",
-  lengths: [7] as const,
-  examples: ["B15KXQ8"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default sedol;
-export {
-  calcCheckDigit,
-  compact,
-  format,
-  validate,
-  generate,
-};

package/src/gb/utr.ts

@@ -1,85 +0,0 @@
-/**
- * UTR (Unique Taxpayer Reference).
- *
- * UK 10-digit tax reference number. The first
- * digit is a check digit computed using a
- * weighted sum with lookup table.
- *
- * @see https://www.gov.uk/find-utr-number
- */
-
-import type {
-  ValidateResult,
-  CountryValidator,
-} from "../types";
-
-import { weightedSum } from "#checksums/weighted-sum";
-import { clean } from "#util/clean";
-import { randomDigits } from "#util/generate";
-import { err } from "#util/result";
-import { isdigits } from "#util/strings";
-
-const WEIGHTS = [6, 7, 8, 9, 10, 5, 4, 3, 2] as const;
-const CHECK_LOOKUP = "21987654321";
-
-const compact = (value: string): string =>
-  clean(value, " -");
-
-const validate = (value: string): ValidateResult => {
-  const v = compact(value);
-  if (v.length !== 10) {
-    return err(
-      "INVALID_LENGTH",
-      "UK UTR must be exactly 10 digits",
-    );
-  }
-  if (!isdigits(v)) {
-    return err(
-      "INVALID_FORMAT",
-      "UK UTR must contain only digits",
-    );
-  }
-  const sum = weightedSum(v.slice(1), WEIGHTS, 11);
-  const expected = CHECK_LOOKUP[sum];
-  if (expected !== v[0]) {
-    return err(
-      "INVALID_CHECKSUM",
-      "UK UTR check digit mismatch",
-    );
-  }
-  return { valid: true, compact: v };
-};
-
-const format = (value: string): string => {
-  const v = compact(value);
-  return `${v.slice(0, 5)} ${v.slice(5)}`;
-};
-
-/** Generate a random valid UK UTR. */
-const generate = (): string => {
-  for (;;) {
-    const c = randomDigits(10);
-    if (validate(c).valid) return c;
-  }
-};
-
-/** UK Unique Taxpayer Reference. */
-const utr: CountryValidator<"GB"> = {
-  name: "UK Unique Taxpayer Reference",
-  localName: "Unique Taxpayer Reference",
-  abbreviation: "UTR",
-  aliases: ["Unique Taxpayer Reference", "UTR"] as const,
-  candidatePattern: "\\d{10}",
-  scope: "country",
-  country: "GB",
-  entityType: "any",
-  sourceUrl: "https://www.gov.uk/find-utr-number",
-  examples: ["1955839661"] as const,
-  compact,
-  format,
-  validate,
-  generate,
-};
-
-export default utr;
-export { compact, format, validate, generate };