stdnum 1.10.0 → 1.10.1

package/src/si/ddv.ts

@@ -0,0 +1,76 @@
+/**
+ * ID za DDV (Davčna številka, Slovenian VAT number).
+ *
+ * The DDV number (Davčna številka) is used for VAT (DDV, Davek na dodano
+ * vrednost) purposes and consist of 8 digits of which the last is a check
+ * digit.
+ *
+ * ENTITY
+ */
+
+import * as exceptions from '../exceptions';
+import { strings } from '../util';
+import { Validator, ValidateReturn } from '../types';
+import { weightedSum } from '../util/checksum';
+
+function clean(input: string): ReturnType<typeof strings.cleanUnicode> {
+  return strings.cleanUnicode(input, ' -', 'SI');
+}
+
+const impl: Validator = {
+  name: 'Slovenian VAT Number',
+  localName: 'Identifikacijska številka za DDV',
+  abbreviation: 'ID za DDV',
+  compact(input: string): string {
+    const [value, err] = clean(input);
+
+    if (err) {
+      throw err;
+    }
+
+    return value;
+  },
+
+  format(input: string): string {
+    const [value] = clean(input);
+
+    return value;
+  },
+
+  validate(input: string): ValidateReturn {
+    const [value, error] = clean(input);
+
+    if (error) {
+      return { isValid: false, error };
+    }
+    if (value.length !== 8) {
+      return { isValid: false, error: new exceptions.InvalidLength() };
+    }
+    if (!strings.isdigits(value)) {
+      return { isValid: false, error: new exceptions.InvalidFormat() };
+    }
+
+    const [front, check] = strings.splitAt(value, -1);
+
+    const sum =
+      11 -
+      weightedSum(front, {
+        weights: [8, 7, 6, 5, 4, 3, 2, 1],
+        modulus: 11,
+      });
+
+    if (String(sum % 10) !== check) {
+      return { isValid: false, error: new exceptions.InvalidChecksum() };
+    }
+
+    return {
+      isValid: true,
+      compact: value,
+      isIndividual: false,
+      isCompany: true,
+    };
+  },
+};
+
+export const { name, localName, abbreviation, validate, format, compact } =
+  impl;

package/src/si/emso.spec.ts

@@ -0,0 +1,15 @@
+import { validate } from './emso';
+
+describe('si/emso', () => {
+  test.each([
+    '0101006500006',
+    '1211981500126',
+    '1508995500237',
+    '2001939010010',
+    '2902932505526',
+  ])('validate:%s', value => {
+    const result = validate(value);
+
+    expect(result.isValid).toEqual(true);
+  });
+});

package/src/si/emso.ts

@@ -0,0 +1,27 @@
+/**
+ * Enotna matična številka občana (Unique Master Citizen Number).
+ *
+ * The EMŠO is used for uniquely identify persons including foreign citizens
+ * living in Slovenia, It is issued by Centralni Register Prebivalstva CRP
+ * (Central Citizen Registry).
+ * The number consists of 13 digits and includes the person's date of birth, a
+ * political region of birth and a unique number that encodes a person's gender
+ * followed by a check digit.
+ *
+ * Source:
+ *   https://en.wikipedia.org/wiki/Unique_Master_Citizen_Number
+ *   https://sl.wikipedia.org/wiki/Enotna_matična_številka_občana
+ */
+
+import { Validator } from '../types';
+import * as jmbg from '../ba/jmbg';
+
+const impl: Validator = {
+  ...jmbg,
+  name: 'Slovene Unique Master Citizen Number',
+  localName: 'Enotna Matična Številka Občana',
+  abbreviation: 'EMŠO',
+};
+
+export const { name, localName, abbreviation, validate, format, compact } =
+  impl;

package/src/si/index.ts

@@ -0,0 +1,3 @@
+export * as ddv from './ddv';
+export * as jmbg from './jmbg';
+export * as emso from './emso';

package/src/si/jmbg.ts

@@ -0,0 +1,20 @@
+/**
+ * Slovene JMBG
+ *
+ * https://en.wikipedia.org/wiki/Unique_Master_Citizen_Number
+ *
+ * This is really the EMSO -- here for legacy support
+ */
+
+import { Validator } from '../types';
+import * as jmbg from '../ba/jmbg';
+
+const impl: Validator = {
+  ...jmbg,
+  name: 'Slovene Unique Master Citizen Number',
+  localName: 'Enotna Matična Številka Občana',
+  abbreviation: 'EMŠO',
+};
+
+export const { name, localName, abbreviation, validate, format, compact } =
+  impl;

package/src/sk/dph.spec.ts

@@ -0,0 +1,28 @@
+import { validate, format } from './dph';
+import { InvalidLength, InvalidChecksum } from '../exceptions';
+
+describe('sk/dph', () => {
+  it('format:SK 202 274 96 19', () => {
+    const result = format('SK 202 274 96 19');
+
+    expect(result).toEqual('202 274 96 19');
+  });
+
+  it('validate:SK 202 274 96 19', () => {
+    const result = validate('SK 202 274 96 19');
+
+    expect(result.isValid && result.compact).toEqual('2022749619');
+  });
+
+  it('validate:12345678', () => {
+    const result = validate('12345678');
+
+    expect(result.error).toBeInstanceOf(InvalidLength);
+  });
+
+  it('validate:SK 202 274 96 18', () => {
+    const result = validate('SK 202 274 96 18');
+
+    expect(result.error).toBeInstanceOf(InvalidChecksum);
+  });
+});

package/src/sk/dph.ts

@@ -0,0 +1,71 @@
+/**
+ * IČ DPH (IČ pre daň z pridanej hodnoty, Slovak VAT number).
+ *
+ * The IČ DPH (Identifikačné číslo pre daň z pridanej hodnoty) is a 10-digit
+ * number used for VAT purposes. It has a straightforward checksum.
+ *
+ * Source
+ *
+ * ENTITY
+ */
+
+import * as exceptions from '../exceptions';
+import { strings } from '../util';
+import { Validator, ValidateReturn } from '../types';
+
+function clean(input: string): ReturnType<typeof strings.cleanUnicode> {
+  return strings.cleanUnicode(input, ' -', 'SK');
+}
+
+const impl: Validator = {
+  name: 'Slovak VAT Number',
+  localName: 'Identifikačné Číslo pre Daň z Pridanej Hodnoty',
+  abbreviation: 'IČ DPH',
+  compact(input: string): string {
+    const [value, err] = clean(input);
+
+    if (err) {
+      throw err;
+    }
+
+    return value;
+  },
+
+  format(input: string): string {
+    const [value] = clean(input);
+
+    return strings.splitAt(value, 3, 6, 8).join(' ');
+  },
+
+  validate(input: string): ValidateReturn {
+    const [value, error] = clean(input);
+
+    if (error) {
+      return { isValid: false, error };
+    }
+    if (value.length !== 10) {
+      return { isValid: false, error: new exceptions.InvalidLength() };
+    }
+    if (!strings.isdigits(value)) {
+      return { isValid: false, error: new exceptions.InvalidFormat() };
+    }
+
+    if (!'234789'.includes(value[0])) {
+      return { isValid: false, error: new exceptions.InvalidComponent() };
+    }
+
+    if (parseInt(value, 10) % 11 !== 0) {
+      return { isValid: false, error: new exceptions.InvalidChecksum() };
+    }
+
+    return {
+      isValid: true,
+      compact: value,
+      isIndividual: false,
+      isCompany: true,
+    };
+  },
+};
+
+export const { name, localName, abbreviation, validate, format, compact } =
+  impl;

package/src/sk/index.ts

@@ -0,0 +1,2 @@
+export * as dph from './dph';
+export * as rc from './rc';

package/src/sk/rc.ts

@@ -0,0 +1,12 @@
+import { Validator } from '../types';
+import * as rc from '../cz/rc';
+
+const impl: Validator = {
+  ...rc,
+  name: 'Slovak Birth Number',
+  localName: 'Rodné číslo',
+  abbreviation: 'RC',
+};
+
+export const { name, localName, abbreviation, validate, format, compact } =
+  impl;

package/src/sm/coe.spec.ts

@@ -0,0 +1,34 @@
+import { validate, format } from './coe';
+import { InvalidLength, InvalidFormat } from '../exceptions';
+
+describe('sm/coe', () => {
+  it('format:51', () => {
+    const result = format('51');
+
+    expect(result).toEqual('51');
+  });
+
+  it('validate:51', () => {
+    const result = validate('51');
+
+    expect(result.isValid && result.compact).toEqual('51');
+  });
+
+  it('validate:024165', () => {
+    const result = validate('024165');
+
+    expect(result.isValid && result.compact).toEqual('24165');
+  });
+
+  it('validate:2416A', () => {
+    const result = validate('2416A');
+
+    expect(result.error).toBeInstanceOf(InvalidFormat);
+  });
+
+  it('validate:1124165', () => {
+    const result = validate('1124165');
+
+    expect(result.error).toBeInstanceOf(InvalidLength);
+  });
+});

package/src/sm/coe.ts

@@ -0,0 +1,80 @@
+/**
+ * COE (Codice operatore economico, San Marino national tax number).
+ *
+ * The COE is a tax identification number of up to 5-digits used in San Marino.
+ * Leading zeroes are commonly dropped.
+ *
+ * ENTITY
+ */
+
+import * as exceptions from '../exceptions';
+import { strings } from '../util';
+import { Validator, ValidateReturn } from '../types';
+
+// All small valued registered entities
+const lowNumbers = new Set([
+  2, 4, 6, 7, 8, 9, 10, 11, 13, 16, 18, 19, 20, 21, 25, 26, 30, 32, 33, 35, 36,
+  37, 38, 39, 40, 42, 45, 47, 49, 51, 52, 55, 56, 57, 58, 59, 61, 62, 64, 65,
+  66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 79, 80, 81, 84, 85, 87, 88, 91,
+  92, 94, 95, 96, 97, 99,
+]);
+
+function clean(input: string): ReturnType<typeof strings.cleanUnicode> {
+  const [value, err] = strings.cleanUnicode(input, ' .');
+
+  if (err) {
+    return [value, err];
+  }
+
+  return [value.replace(/^0+/, ''), null];
+}
+
+const impl: Validator = {
+  name: 'San Marino National Tax Number',
+  localName: 'Codice Operatore Eeconomico',
+  abbreviation: 'COE',
+
+  compact(input: string): string {
+    const [value, err] = clean(input);
+
+    if (err) {
+      throw err;
+    }
+
+    return value;
+  },
+
+  format(input: string): string {
+    const [value] = clean(input);
+
+    return value;
+  },
+
+  validate(input: string): ValidateReturn {
+    const [value, error] = clean(input);
+
+    if (error) {
+      return { isValid: false, error };
+    }
+    if (value.length > 5 || value.length === 0) {
+      return { isValid: false, error: new exceptions.InvalidLength() };
+    }
+    if (!strings.isdigits(value)) {
+      return { isValid: false, error: new exceptions.InvalidFormat() };
+    }
+
+    if (value.length < 3 && !lowNumbers.has(parseInt(value, 10))) {
+      return { isValid: false, error: new exceptions.InvalidComponent() };
+    }
+
+    return {
+      isValid: true,
+      compact: value,
+      isIndividual: false,
+      isCompany: true,
+    };
+  },
+};
+
+export const { name, localName, abbreviation, validate, format, compact } =
+  impl;

package/src/sm/index.ts

@@ -0,0 +1 @@
+export * as coe from './coe';

package/src/sv/index.ts

@@ -0,0 +1 @@
+export * as nit from './nit';

package/src/sv/nit.spec.ts

@@ -0,0 +1,34 @@
+import { validate, format } from './nit';
+import { InvalidLength, InvalidChecksum } from '../exceptions';
+
+describe('sv/nit', () => {
+  it('format:06140507071048', () => {
+    const result = format('06140507071048');
+
+    expect(result).toEqual('0614-050707-104-8');
+  });
+
+  it('validate:0614-050707-104-8', () => {
+    const result = validate('0614-050707-104-8');
+
+    expect(result.isValid && result.compact).toEqual('06140507071048');
+  });
+
+  it('validate:SV 0614-050707-104-8', () => {
+    const result = validate('SV 0614-050707-104-8');
+
+    expect(result.isValid && result.compact).toEqual('06140507071048');
+  });
+
+  it('validate:1234567890123', () => {
+    const result = validate('1234567890123');
+
+    expect(result.error).toBeInstanceOf(InvalidLength);
+  });
+
+  it('validate:0614-050707-104-0', () => {
+    const result = validate('0614-050707-104-0');
+
+    expect(result.error).toBeInstanceOf(InvalidChecksum);
+  });
+});

package/src/sv/nit.ts

@@ -0,0 +1,117 @@
+/**
+ * NIT (Número de Identificación Tributaria, El Salvador tax number).
+ *
+ * This number consists of 14 digits, usually separated into four groups
+ * using hyphens to make it easier to read, like XXXX-XXXXXX-XXX-X.
+ *
+ * The first four digits indicate the code for the municipality of birth
+ * for natural persons or the municipality of stablishment for juridical
+ * persons. NIT for El Salvador nationals begins with either 0 or 1, and
+ * for foreigners it begins with 9.
+ *
+ * The following six digits indicate the date of birth for the natural
+ * person, or the stablishment date for the juridical person, using the
+ * format DDMMYY, where DD is the day, MM is the month, and YY is the
+ * year. For example XXXX-051180-XXX-X is (November 5 1980)
+ *
+ * The next 3 digits are a sequential number.
+ *
+ * The last digit is the check digit, which is used to verify the number
+ * was correctly typed.
+ *
+ * Source
+ *    https://es.wikipedia.org/wiki/Identificaci%C3%B3n_tributaria
+ *    https://www.listasal.info/articulos/nit-el-salvador.shtml
+ *    https://tramitesyrequisitos.com/el-salvador/nit/#Estructura_del_NIT
+ *    https://www.svcommunity.org/forum/programacioacuten/como-calcular-digito-verificador-del-dui-y-nit/msg951882/#msg951882
+ *
+ * PERSON/ENTITY
+ */
+
+import * as exceptions from '../exceptions';
+import { strings, weightedSum } from '../util';
+import { Validator, ValidateReturn } from '../types';
+
+function clean(input: string): ReturnType<typeof strings.cleanUnicode> {
+  const [value, err] = strings.cleanUnicode(input, ' -');
+
+  if (err !== null) {
+    return [value, err];
+  }
+  if (value.startsWith('SV')) {
+    return [value.substr(2), err];
+  }
+
+  return [value, err];
+}
+
+const impl: Validator = {
+  name: 'El Salvador Tax Number',
+  localName: 'Número de Identificación Tributaria',
+  abbreviation: 'NIT',
+  compact(input: string): string {
+    const [value, err] = clean(input);
+
+    if (err) {
+      throw err;
+    }
+
+    return value;
+  },
+
+  format(input: string): string {
+    const [value] = clean(input);
+
+    return strings.splitAt(value, 4, -4, -1).join('-');
+  },
+
+  validate(input: string): ValidateReturn {
+    const [value, error] = clean(input);
+
+    if (error) {
+      return { isValid: false, error };
+    }
+    if (value.length !== 14) {
+      return { isValid: false, error: new exceptions.InvalidLength() };
+    }
+    if (!strings.isdigits(value)) {
+      return { isValid: false, error: new exceptions.InvalidFormat() };
+    }
+    if (!['0', '1', '9'].includes(value[0])) {
+      return { isValid: false, error: new exceptions.InvalidComponent() };
+    }
+
+    let sum;
+    const [front, check] = strings.splitAt(value, 13);
+
+    if (value.substr(10, 3) === '100') {
+      sum =
+        weightedSum(front, {
+          weights: [14, 13, 12, 11, 10, 9, 8, 7, 6, 5, 4, 3, 2],
+          modulus: 11,
+        }) % 10;
+    } else {
+      sum =
+        (11 -
+          weightedSum(front, {
+            weights: [2, 7, 6, 5, 4, 3, 2, 7, 6, 5, 4, 3, 2],
+            modulus: 11,
+          })) %
+        10;
+    }
+
+    if (check !== String(sum)) {
+      return { isValid: false, error: new exceptions.InvalidChecksum() };
+    }
+
+    return {
+      isValid: true,
+      compact: value,
+      isIndividual: true,
+      isCompany: true,
+    };
+  },
+};
+
+export const { name, localName, abbreviation, validate, format, compact } =
+  impl;

package/src/th/idnr.spec.ts

@@ -0,0 +1,41 @@
+import { validate, format } from './idnr';
+import {
+  InvalidLength,
+  InvalidChecksum,
+  InvalidComponent,
+} from '../exceptions';
+
+describe('th/idnr', () => {
+  it('format:1112034563562', () => {
+    const result = format('1112034563562');
+
+    expect(result).toEqual('1-1120-34563-56-2');
+  });
+
+  test.each(['3100600445635', '1-2345-45678-78-1', '1112034563562'])(
+    'validate:%s',
+    value => {
+      const result = validate(value);
+
+      expect(result.isValid).toEqual(true);
+    },
+  );
+
+  it('validate:12345678', () => {
+    const result = validate('12345678');
+
+    expect(result.error).toBeInstanceOf(InvalidLength);
+  });
+
+  it('validate:0101700230705', () => {
+    const result = validate('0101700230705');
+
+    expect(result.error).toBeInstanceOf(InvalidComponent);
+  });
+
+  it('validate:1101700230705', () => {
+    const result = validate('1101700230705');
+
+    expect(result.error).toBeInstanceOf(InvalidChecksum);
+  });
+});

package/src/th/idnr.ts

@@ -0,0 +1,80 @@
+/**
+ * IDNR (Thai identity card)
+ *
+ * The Thai identity card (Thai: บัตรประจำตัวประชาชนไทย)
+ * is an official identity document issued to Thai nationals between the age of 7 and 70 years.
+ *
+ * Source
+ *   https://en.wikipedia.org/wiki/Thai_identity_card
+ *
+ * PERSON
+ */
+
+import * as exceptions from '../exceptions';
+import { strings } from '../util';
+import { Validator, ValidateReturn } from '../types';
+import { weightedSum } from '../util/checksum';
+
+function clean(input: string): ReturnType<typeof strings.cleanUnicode> {
+  return strings.cleanUnicode(input, ' -');
+}
+
+const impl: Validator = {
+  name: 'Thai National Identity Card Number',
+  localName: 'บัตรประจำตัวประชาชนไทย',
+  abbreviation: 'IDNR',
+  compact(input: string): string {
+    const [value, err] = clean(input);
+
+    if (err) {
+      throw err;
+    }
+
+    return value;
+  },
+
+  format(input: string): string {
+    const [value] = clean(input);
+
+    return strings.splitAt(value, 1, 5, 10, 12).join('-');
+  },
+
+  validate(input: string): ValidateReturn {
+    const [value, error] = clean(input);
+
+    if (error) {
+      return { isValid: false, error };
+    }
+    if (value.length !== 13) {
+      return { isValid: false, error: new exceptions.InvalidLength() };
+    }
+    if (!strings.isdigits(value)) {
+      return { isValid: false, error: new exceptions.InvalidFormat() };
+    }
+
+    if ('09'.includes(value[0])) {
+      return { isValid: false, error: new exceptions.InvalidComponent() };
+    }
+
+    const [front, check] = strings.splitAt(value, 12);
+
+    const sum = weightedSum(front, {
+      weights: [13, 12, 11, 10, 9, 8, 7, 6, 5, 4, 3, 2, 1],
+      modulus: 11,
+    });
+
+    if (String((11 - sum) % 10) !== check) {
+      return { isValid: false, error: new exceptions.InvalidChecksum() };
+    }
+
+    return {
+      isValid: true,
+      compact: value,
+      isIndividual: true,
+      isCompany: false,
+    };
+  },
+};
+
+export const { name, localName, abbreviation, validate, format, compact } =
+  impl;

package/src/th/index.ts

@@ -0,0 +1,3 @@
+export * as idnr from './idnr';
+export * as moa from './moa';
+export * as tin from './tin';