@stll/stdnum 1.0.0 → 2.0.0

package/src/ie/vat.ts

@@ -8,13 +8,16 @@
  * @see https://www.revenue.ie/
  */
 
+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";
 
-import type { ValidateResult, Validator } from "../types";
-
 const ALPHABET = "WABCDEFGHIJKLMNOPQRSTUV";
 
 const compact = (value: string): string => {
@@ -118,12 +121,13 @@ const generate = (): string => {
 };
 
 /** Irish VAT Number. */
-const vat: Validator = {
+const vat: CountryValidator<"IE"> = {
   name: "Irish VAT Number",
   localName: "Value Added Tax Number",
   abbreviation: "VAT",
   aliases: ["VAT number IE"] as const,
   candidatePattern: "IE\\d[A-Z+*]\\d{5}[A-Z]",
+  scope: "country",
   country: "IE",
   entityType: "any",
   sourceUrl: "https://www.revenue.ie/",

package/src/il/idnr.ts

@@ -7,6 +7,11 @@
  * @see https://en.wikipedia.org/wiki/Israeli_identity_card
  */
 
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import {
   luhnValidate,
   luhnChecksum,
@@ -16,8 +21,6 @@ import { randomDigits } from "#util/generate";
 import { err } from "#util/result";
 import { isdigits } from "#util/strings";
 
-import type { ValidateResult, Validator } from "../types";
-
 const compact = (value: string): string =>
   clean(value, " -").padStart(9, "0");
 
@@ -58,7 +61,7 @@ const generate = (): string => {
 };
 
 /** Israeli Identity Number (Mispar Zehut). */
-const idnr: Validator = {
+const idnr: CountryValidator<"IL"> = {
   name: "Israeli Identity Number",
   localName: "מספר זהות",
   abbreviation: "ת.ז.",
@@ -68,6 +71,7 @@ const idnr: Validator = {
     "ID number",
   ] as const,
   candidatePattern: "\\d{9}",
+  scope: "country",
   country: "IL",
   entityType: "person",
   compact,

package/src/in/aadhaar.ts

@@ -10,6 +10,11 @@
  * @see https://uidai.gov.in/
  */
 
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import {
   verhoeffValidate,
   verhoeffCheckDigit,
@@ -19,8 +24,6 @@ import { randomDigits, randomInt } from "#util/generate";
 import { err } from "#util/result";
 import { isdigits } from "#util/strings";
 
-import type { ValidateResult, Validator } from "../types";
-
 const compact = (value: string): string =>
   clean(value, " -");
 
@@ -73,12 +76,13 @@ const generate = (): string => {
 };
 
 /** Indian Unique Identity Number. */
-const aadhaar: Validator = {
+const aadhaar: CountryValidator<"IN"> = {
   name: "Indian Unique Identity Number",
   localName: "Aadhaar",
   abbreviation: "Aadhaar",
   aliases: ["Aadhaar", "आधार"] as const,
   candidatePattern: "\\d{4}\\s?\\d{4}\\s?\\d{4}",
+  scope: "country",
   country: "IN",
   entityType: "person",
   lengths: [12],

package/src/in/gstin.ts

@@ -9,13 +9,16 @@
  * @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";
 
-import type { ValidateResult, Validator } from "../types";
-
 const GSTIN_RE =
   /^[0-9]{2}[A-Z]{5}[0-9]{4}[A-Z][0-9A-Z]Z[0-9A-Z]$/;
 
@@ -146,13 +149,14 @@ const generate = (): string => {
 };
 
 /** Indian Goods and Services Tax ID. */
-const gstin: Validator = {
+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],

package/src/in/pan.ts

@@ -25,6 +25,11 @@ const generate = (): string => {
  * @see https://en.wikipedia.org/wiki/Permanent_account_number
  */
 
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import { clean } from "#util/clean";
 import {
   randomChar,
@@ -33,8 +38,6 @@ import {
 } from "#util/generate";
 import { err } from "#util/result";
 
-import type { ValidateResult, Validator } from "../types";
-
 const PAN_RE = /^[A-Z]{5}\d{4}[A-Z]$/;
 
 const HOLDER_TYPES = "ABCFGHJLPT";
@@ -70,12 +73,13 @@ const validate = (value: string): ValidateResult => {
 const format = (value: string): string => compact(value);
 
 /** Indian Permanent Account Number. */
-const pan: Validator = {
+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],

package/src/index.ts

@@ -1,6 +1,8 @@
 export type {
+  CountryValidator,
   CountryCode,
   ErrorCode,
+  GlobalValidator,
   ParsedBirthDate,
   ParsedIdentifier,
   ParsedPersonId,
@@ -8,6 +10,7 @@ export type {
   StdnumError,
   ValidateResult,
   Validator,
+  ValidatorScope,
 } from "./types";
 export { default as bic } from "./bic";
 export {

package/src/iq/nid.ts

@@ -16,14 +16,17 @@ const generate = (): string => randomDigits(12);
  * @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";
 
-import type { ValidateResult, Validator } from "../types";
-
 const compact = (value: string): string =>
   normalizeArabicDigits(clean(value, " -./"));
 
@@ -48,12 +51,13 @@ const validate = (value: string): ValidateResult => {
 const format = (value: string): string => compact(value);
 
 /** Iraqi National Identification Number. */
-const nid: Validator = {
+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/",

package/src/ir/nid.ts

@@ -22,14 +22,17 @@
  * @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";
 
-import type { ValidateResult, Validator } from "../types";
-
 /** All-same-digit patterns (0000000000 .. 9999999999). */
 const ALL_SAME = new Set(
   Array.from({ length: 10 }, (_, i) =>
@@ -97,12 +100,13 @@ const generate = (): string => {
 };
 
 /** Iranian National Identification Number. */
-const nid: Validator = {
+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/",

package/src/is/kennitala.ts

@@ -11,14 +11,17 @@
  * @see https://www.skra.is/
  */
 
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import { clean } from "#util/clean";
 import { isValidDate } from "#util/date";
 import { randomInt } from "#util/generate";
 import { err } from "#util/result";
 import { isdigits } from "#util/strings";
 
-import type { ValidateResult, Validator } from "../types";
-
 const WEIGHTS = [3, 2, 7, 6, 5, 4, 3, 2, 0, 0] as const;
 
 const compact = (value: string): string =>
@@ -105,12 +108,13 @@ const generate = (): string => {
 };
 
 /** Icelandic Identification Number. */
-const kennitala: Validator = {
+const kennitala: CountryValidator<"IS"> = {
   name: "Icelandic ID Number",
   localName: "Kennitala",
   abbreviation: "kt.",
   aliases: ["kennitala", "kt."] as const,
   candidatePattern: "\\d{6}-?\\d{4}",
+  scope: "country",
   country: "IS",
   entityType: "any",
   sourceUrl: "https://www.skra.is/",

package/src/is/vsk.ts

@@ -12,13 +12,16 @@ const generate = (): string => {
  * @see https://www.rsk.is/
  */
 
+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";
 
-import type { ValidateResult, Validator } from "../types";
-
 const compact = (value: string): string =>
   clean(value, " -");
 
@@ -43,12 +46,13 @@ const validate = (value: string): ValidateResult => {
 const format = (value: string): string => compact(value);
 
 /** Icelandic VAT Number. */
-const vsk: Validator = {
+const vsk: CountryValidator<"IS"> = {
   name: "Icelandic VAT Number",
   localName: "Virðisaukaskattur",
   abbreviation: "VSK",
   aliases: ["VSK-númer", "virðisaukaskattur"] as const,
   candidatePattern: "IS\\d{5,6}",
+  scope: "country",
   country: "IS",
   entityType: "company",
   sourceUrl: "https://www.rsk.is/",

package/src/isin.ts

@@ -10,14 +10,17 @@
  * @see https://www.isin.org/
  */
 
+import type {
+  ValidateResult,
+  GlobalValidator,
+} from "./types";
+
 import { luhnChecksum } from "#checksums/luhn";
 import { clean } from "#util/clean";
 import { randomInt, randomPick } from "#util/generate";
 import { err } from "#util/result";
 import { charValue, isalnum } from "#util/strings";
 
-import type { ValidateResult, Validator } from "./types";
-
 const ISIN_RE = /^[A-Z]{2}[0-9A-Z]{9}[0-9]$/;
 
 const compact = (value: string): string =>
@@ -97,7 +100,8 @@ const generate = (): string => {
 };
 
 /** International Securities Identification Number. */
-const isin: Validator = {
+const isin: GlobalValidator = {
+  scope: "global",
   name: "International Securities Identification Number",
   localName:
     "International Securities Identification Number",

package/src/it/codicefiscale.ts

@@ -20,18 +20,18 @@
  * @see https://it.wikipedia.org/wiki/Codice_fiscale#Omocodia
  */
 
-import { clean } from "#util/clean";
-import { randomInt } from "#util/generate";
-import { err } from "#util/result";
-import { isdigits } from "#util/strings";
-
 import type {
   ParsedPersonId,
   ValidateResult,
-  Validator,
+  CountryValidator,
 } from "../types";
 import { validate as validateIva } from "./iva";
 
+import { clean } from "#util/clean";
+import { randomInt } from "#util/generate";
+import { err } from "#util/result";
+import { isdigits } from "#util/strings";
+
 // Values for odd-positioned characters (0-based
 // index 0, 2, 4, ...)
 const ODD: Record<string, number> = {
@@ -297,7 +297,10 @@ const generate = (): string => {
 };
 
 /** Italian Tax Code. */
-const codiceFiscale: Validator<ParsedPersonId> = {
+const codiceFiscale: CountryValidator<
+  "IT",
+  ParsedPersonId
+> = {
   name: "Italian Tax Code",
   localName: "Codice Fiscale",
   abbreviation: "CF",
@@ -310,6 +313,7 @@ const codiceFiscale: Validator<ParsedPersonId> = {
   ] as const,
   candidatePattern:
     "[A-Z]{6}\\d{2}[A-Z]\\d{2}[A-Z]\\d{3}[A-Z]",
+  scope: "country",
   country: "IT",
   entityType: "person",
   description:

package/src/it/iva.ts

@@ -7,6 +7,11 @@
  * @see https://www.agenziaentrate.gov.it/
  */
 
+import type {
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import {
   luhnValidate,
   luhnChecksum,
@@ -16,8 +21,6 @@ import { randomDigits, randomInt } from "#util/generate";
 import { err } from "#util/result";
 import { isdigits } from "#util/strings";
 
-import type { ValidateResult, Validator } from "../types";
-
 const VALID_PROVINCES = new Set([
   ...Array.from({ length: 100 }, (_, i) =>
     String(i + 1).padStart(3, "0"),
@@ -90,7 +93,7 @@ const generate = (): string => {
 };
 
 /** Italian VAT Number. */
-const iva: Validator = {
+const iva: CountryValidator<"IT"> = {
   name: "Italian VAT Number",
   localName: "Partita IVA",
   abbreviation: "P.IVA",
@@ -101,6 +104,7 @@ const iva: Validator = {
     "VAT IT",
   ] as const,
   candidatePattern: "IT\\d{11}",
+  scope: "country",
   country: "IT",
   entityType: "company",
   sourceUrl: "https://www.agenziaentrate.gov.it/",

package/src/jp/cn.ts

@@ -8,13 +8,16 @@
  * @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";
 
-import type { ValidateResult, Validator } from "../types";
-
 const compact = (value: string): string =>
   clean(value, " -");
 
@@ -67,12 +70,13 @@ const generate = (): string => {
 };
 
 /** Japanese Corporate Number. */
-const cn: Validator = {
+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:

package/src/jp/mynumber.ts

@@ -9,13 +9,16 @@
  * @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";
 
-import type { ValidateResult, Validator } from "../types";
-
 const compact = (value: string): string =>
   clean(value, " -");
 
@@ -74,7 +77,7 @@ const generate = (): string => {
 };
 
 /** Japanese Individual Number (My Number). */
-const mynumber: Validator = {
+const mynumber: CountryValidator<"JP"> = {
   name: "Japanese Individual Number",
   localName: "マイナンバー",
   abbreviation: "My Number",
@@ -84,6 +87,7 @@ const mynumber: Validator = {
     "個人番号",
   ] as const,
   candidatePattern: "\\d{4}[\\s-]?\\d{4}[\\s-]?\\d{4}",
+  scope: "country",
   country: "JP",
   entityType: "person",
   description:

package/src/kr/brn.ts

@@ -23,13 +23,16 @@ const generate = (): string => {
  * @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";
 
-import type { ValidateResult, Validator } from "../types";
-
 const compact = (value: string): string =>
   clean(value, " -");
 
@@ -77,12 +80,13 @@ const format = (value: string): string => {
 };
 
 /** Korean Business Registration Number. */
-const brn: Validator = {
+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:

package/src/kr/rrn.ts

@@ -9,18 +9,18 @@
  * @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";
 
-import type {
-  ParsedPersonId,
-  ValidateResult,
-  Validator,
-} from "../types";
-
 const compact = (value: string): string =>
   clean(value, " -/");
 
@@ -157,7 +157,7 @@ const generate = (): string => {
 };
 
 /** Korean Resident Registration Number. */
-const rrn: Validator<ParsedPersonId> = {
+const rrn: CountryValidator<"KR", ParsedPersonId> = {
   name: "Korean Resident Registration Number",
   localName: "주민등록번호",
   abbreviation: "RRN",
@@ -167,6 +167,7 @@ const rrn: Validator<ParsedPersonId> = {
     "Resident Registration Number",
   ] as const,
   candidatePattern: "\\d{6}[\\s-]?\\d{7}",
+  scope: "country",
   country: "KR",
   entityType: "person",
   description:

package/src/kw/civil.ts

@@ -12,18 +12,18 @@
  * @see https://kuwaitsexpat.com/kuwait-civil-id-format/
  */
 
+import type {
+  ParsedBirthDate,
+  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";
 
-import type {
-  ParsedBirthDate,
-  ValidateResult,
-  Validator,
-} from "../types";
-
 const WEIGHTS = [2, 1, 6, 3, 7, 9, 10, 5, 8, 4, 2] as const;
 
 const centuryMap: Record<number, number> = {
@@ -135,12 +135,13 @@ const generate = (): string => {
 };
 
 /** Kuwait Civil Number (الرقم المدني). */
-const civil: Validator<ParsedBirthDate> = {
+const civil: CountryValidator<"KW", ParsedBirthDate> = {
   name: "Civil Number",
   localName: "الرقم المدني",
   abbreviation: "Civil ID",
   aliases: ["Civil ID", "الرقم المدني"] as const,
   candidatePattern: "\\d{12}",
+  scope: "country",
   country: "KW",
   entityType: "person",
   lengths: [12] as const,

package/src/kz/iin.ts

@@ -14,6 +14,12 @@
  * @see https://www.oecd.org/tax/automatic-exchange/crs-implementation-and-assistance/tax-identification-numbers/Kazakhstan-TIN.pdf
  */
 
+import type {
+  ParsedPersonId,
+  ValidateResult,
+  CountryValidator,
+} from "../types";
+
 import { weightedSum } from "#checksums/weighted-sum";
 import { clean } from "#util/clean";
 import { isValidDate } from "#util/date";
@@ -21,12 +27,6 @@ import { randomDigits, randomInt } from "#util/generate";
 import { err } from "#util/result";
 import { isdigits } from "#util/strings";
 
-import type {
-  ParsedPersonId,
-  ValidateResult,
-  Validator,
-} from "../types";
-
 const WEIGHTS_1 = [
   1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11,
 ] as const;
@@ -144,7 +144,6 @@ const generate = (): string => {
     const serial = randomDigits(4);
     const payload = yy + mm + dd + gender + serial;
     const check = calcCheckDigit(payload);
-    if (check === null) continue;
     const c = payload + String(check);
     if (validate(c).valid) return c;
   }
@@ -155,7 +154,7 @@ const generate = (): string => {
  *
  * Examples sourced from identique/idnumbers test suite.
  */
-const iin: Validator<ParsedPersonId> = {
+const iin: CountryValidator<"KZ", ParsedPersonId> = {
   name: "Kazakhstan Individual ID",
   localName: "Жеке сәйкестендіру нөмірі",
   abbreviation: "IIN",
@@ -165,6 +164,7 @@ const iin: Validator<ParsedPersonId> = {
     "индивидуальный идентификационный номер",
   ] as const,
   candidatePattern: "\\d{12}",
+  scope: "country",
   country: "KZ",
   entityType: "person",
   lengths: [12] as const,