stdnum 1.10.0 → 1.10.1

package/src/ar/dni.ts

@@ -0,0 +1,72 @@
+/**
+ *
+ * DNI (Documento Nacional de Identidad, Argentinian national identity nr.).
+ *
+ * The DNI number is the number that appears on the Argentinian national
+ * identity document and is used to identify citizen and foreigners residing in
+ * the country.
+ *
+ * Sources:
+ *   https://en.wikipedia.org/wiki/Documento_Nacional_de_Identidad_(Argentina)
+ *
+ *  PERSON
+ */
+
+import * as exceptions from '../exceptions';
+import { ValidateReturn, Validator } from '../types';
+import { strings } from '../util';
+
+function clean(input: string): ReturnType<typeof strings.cleanUnicode> {
+  return strings.cleanUnicode(input, ' .');
+}
+
+const impl: Validator = {
+  name: 'Argentinian National Identity Document',
+  localName: 'Documento Nacional de Identidad',
+  abbreviation: 'DNI',
+
+  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, value.length - 6, value.length - 3).join('.');
+  },
+
+  /**
+   * Check if the number is a valid DNI number.
+   * This checks the length, formatting and other contraints. It does not check
+   * for control letter.
+   */
+  validate(input: string): ValidateReturn {
+    const [value, error] = clean(input);
+
+    if (error) {
+      return { isValid: false, error };
+    }
+    if (value.length !== 7 && value.length !== 8) {
+      return { isValid: false, error: new exceptions.InvalidLength() };
+    }
+    if (!strings.isdigits(value)) {
+      return { isValid: false, error: new exceptions.InvalidComponent() };
+    }
+
+    return {
+      isValid: true,
+      compact: value,
+      isIndividual: true,
+      isCompany: false,
+    };
+  },
+};
+
+export const { name, localName, abbreviation, validate, format, compact } =
+  impl;

package/src/ar/index.ts

@@ -0,0 +1,3 @@
+export * as cbu from './cbu';
+export * as cuit from './cuit';
+export * as dni from './dni';

package/src/at/businessid.spec.ts

@@ -0,0 +1,34 @@
+import { validate, format } from './businessid';
+import { InvalidFormat } from '../exceptions';
+
+describe('at/businessid', () => {
+  it('format:800280610', () => {
+    const result = format('122119m');
+
+    expect(result).toEqual('122119M');
+  });
+
+  it('validate:FN 122119m', () => {
+    const result = validate('FN 122119m');
+
+    expect(result.isValid && result.compact).toEqual('122119M');
+  });
+
+  it('validate:8765432-6', () => {
+    const result = validate('122119m');
+
+    expect(result.isValid && result.compact).toEqual('122119M');
+  });
+
+  it('validate:m122119', () => {
+    const result = validate('m122119');
+
+    expect(result.error).toBeInstanceOf(InvalidFormat);
+  });
+
+  it('validate:abc', () => {
+    const result = validate('abc');
+
+    expect(result.error).toBeInstanceOf(InvalidFormat);
+  });
+});

package/src/at/businessid.ts

@@ -0,0 +1,73 @@
+/**
+ *
+ * Austrian Company Register Numbers.
+ *
+ * Sources:
+ *
+ * ENTITY
+ *
+ */
+
+import * as exceptions from '../exceptions';
+import { strings } from '../util';
+import { Validator, ValidateReturn } from '../types';
+
+function clean(input: string): ReturnType<typeof strings.cleanUnicode> {
+  const [value, err] = strings.cleanUnicode(input, ' -./');
+
+  if (err) {
+    return [value, err];
+  }
+
+  if (value.startsWith('FN')) {
+    return [value.substring(2), null];
+  }
+
+  return [value, null];
+}
+
+const impl: Validator = {
+  name: 'Austrian Company Register Number',
+  localName: 'Company Register Number',
+  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;
+  },
+
+  /**
+   * Check if the number is a valid Business ID number.
+   * This checks the length, formatting and other contraints. It does not check
+   * for control letter.
+   */
+  validate(input: string): ValidateReturn {
+    const [value, error] = clean(input);
+
+    if (error) {
+      return { isValid: false, error };
+    }
+    if (!/^\d+[A-Z]$/.test(value)) {
+      return { isValid: false, error: new exceptions.InvalidFormat() };
+    }
+
+    return {
+      isValid: true,
+      compact: value,
+      isIndividual: false,
+      isCompany: true,
+    };
+  },
+};
+
+export const { name, localName, abbreviation, validate, format, compact } =
+  impl;

package/src/at/index.ts

@@ -0,0 +1,4 @@
+export * as businessid from './businessid';
+export * as tin from './tin';
+export * as uid from './uid';
+export * as vnr from './vnr';

package/src/at/tin.spec.ts

@@ -0,0 +1,173 @@
+import { validate, format } from './tin';
+import {
+  InvalidLength,
+  InvalidChecksum,
+  InvalidComponent,
+} from '../exceptions';
+
+describe('at/tin', () => {
+  it('format:591199013', () => {
+    const result = format('591199013');
+
+    expect(result).toEqual('59-119/9013');
+  });
+
+  it('validate:59-119/9013', () => {
+    const result = validate('59-119/9013');
+
+    expect(result.isValid && result.compact).toEqual('591199013');
+  });
+
+  it('validate:660-3', () => {
+    const result = validate('660-3');
+
+    expect(result.error).toBeInstanceOf(InvalidLength);
+  });
+
+  it('validate:59-119/9012', () => {
+    const result = validate('59-119/9012');
+
+    expect(result.error).toBeInstanceOf(InvalidChecksum);
+  });
+
+  it('validate:00-119/9012', () => {
+    const result = validate('00-119/9012');
+
+    expect(result.error).toBeInstanceOf(InvalidComponent);
+  });
+
+  it.each([
+    '98-123/4560',
+    '90-123/4567',
+    '12-987/6546',
+    '46-376/5321',
+    '03-826/1574',
+    '54-267/9451',
+    '03 318/8822',
+    '109999102',
+    '12 035/4980',
+    '12 504/1558',
+    '12 528/1691',
+    '22 283/3014',
+    '29 122/4046',
+    '38-999/9384',
+    '41 248/1145',
+    '46 1744591',
+    '52-123/4567',
+    '52-360/5855',
+    '53 226/8059',
+    '54 202/0565',
+    '59 059/6383',
+    '59 119/9013',
+    '59 149/7540',
+    '61 075/1679',
+    '68 481/8826',
+    '68 545 4266',
+    '68 626/5406',
+    '68 649/8114',
+    '72 222/3526',
+    '81 - 590/9908',
+    '91 166/9307',
+    '91 195/7272',
+    '98 0100127',
+    '98 0207336',
+    '98 0300131',
+    '98 0400378',
+    '98 0500219',
+    '98 0600092',
+    '98 0700306',
+    '98 0800130',
+    '98 0900096',
+    '98 1000284',
+    '98 1100803',
+    '98 1200363',
+    '98 1300460',
+    '98 1400534',
+    '98 1500234',
+    '98 1600042',
+    '98 1700198',
+    '98 1800212',
+    '98 1900087',
+    '98 2017196',
+    '98 2102535',
+    '98 2210643',
+    '98 2300873',
+    '98 2400038',
+    '98 2500597',
+    '98 2612509',
+    '98 2700601',
+    '98 2800047',
+    '98 2900110',
+    '98 3001314',
+    '98 3100249',
+    '98 3200445',
+    '98 3300104',
+    '98 3400326',
+    '98 3500091',
+    '98 3601303',
+    '98 3700030',
+    '98 3800194',
+    '98 3900234',
+    '98 4000257',
+    '98 4100164',
+    '98 4200287',
+    '98 4300152',
+    '98 4400010',
+    '98 4500207',
+    '98 4600254',
+    '98 4700211',
+    '98 4800318',
+    '98 4900050',
+    '98 5000157',
+    '98 5100411',
+    '98 5201573',
+    '98 5300227',
+    '98 5400027',
+    '98 5500701',
+    '98 5600360',
+    '98 9300280',
+    '98 9300363',
+    '98 9300454',
+    '98 9300579',
+    '98 9300686',
+    '98 9300736',
+    '98 9300801',
+    '98 9300819',
+    '98 9300827',
+    '98 9300850',
+    '98 9300868',
+    '98 9301015',
+    '98 9301080',
+    '98 9301155',
+    '98 9301189',
+    '98 9301247',
+    '98 9301270',
+    '98 9301304',
+    '98 9301387',
+    '98 9301528',
+    '98 9301593',
+    '98 9301676',
+    '98 9301684',
+    '98 9301841',
+    '98 9301908',
+    '98 9302021',
+    '98 9302104',
+    '98 9302161',
+    '98 9302286',
+    '98 9302310',
+    '98 9302450',
+    '98 9302500',
+    '98 9302559',
+    '98 9302690',
+    '98 9302807',
+    '98 9302831',
+    '98 9302864',
+    '98 9302914',
+    '98 9302963',
+    '98 9303086',
+  ])('validate:%s', testcase => {
+    const result = validate(testcase);
+
+    expect(result.isValid).toBeTruthy();
+  });
+});

package/src/at/tin.ts

@@ -0,0 +1,140 @@
+/**
+ *
+ * Abgabenkontonummer (Austrian tax identification number).
+ *
+ * The Austrian tax identification number (Abgabenkontonummer) consists of 2
+ * digits for the issuing tax office (Finanzamtsnummer) and 7 digits for the
+ * subject and a check digit (Steuernummer).
+ *
+ *
+ * Sources:
+ *    https://www.oecd.org/tax/automatic-exchange/crs-implementation-and-assistance/tax-identification-numbers/Austria-TIN.pdf
+ *    https://de.wikipedia.org/wiki/Abgabenkontonummer
+ *    https://service.bmf.gv.at/Service/Anwend/Behoerden/show_mast.asp
+ *
+ * ENTITY
+ */
+
+import * as exceptions from '../exceptions';
+import { strings } from '../util';
+import { Validator, ValidateReturn } from '../types';
+
+// List of Finanzamtsnummern was manually generated from
+// https://de.wikipedia.org/wiki/Abgabenkontonummer
+const faOffices: Record<string, { office: string; region: string }> = {
+  '03': { office: 'Wien 3/6/7/11/15 Schwechat Gerasdorf', region: 'Wien' },
+  '04': { office: 'Wien 4/5/10', region: 'Wien' },
+  '06': { office: 'Wien 8/16/17', region: 'Wien' },
+  '07': { office: 'Wien 9/18/19 Klosterneuburg', region: 'Wien' },
+  '08': { office: 'Wien 12/13/14 Purkersdorf', region: 'Wien' },
+  '09': { office: 'Wien 1/23', region: 'Wien' },
+  '10': { office: 'für Gebühren, Verkehrsteuern und Glücksspiel', region: '' },
+  '12': { office: 'Wien 2/20/21/22', region: 'Wien' },
+  '15': { office: 'Amstetten Melk Scheibbs', region: 'Niederösterreich' },
+  '16': { office: 'Baden Mödling', region: 'Niederösterreich' },
+  '18': { office: 'Gänserndorf Mistelbach', region: 'Niederösterreich' },
+  '22': { office: 'Hollabrunn Korneuburg Tulln', region: 'Niederösterreich' },
+  '23': { office: 'Waldviertel', region: 'Niederösterreich' },
+  '29': { office: 'Lilienfeld St. Pölten', region: 'Niederösterreich' },
+  '33': { office: 'Neunkirchen Wr. Neustadt', region: 'Niederösterreich' },
+  '38': {
+    office: 'Bruck Eisenstadt Oberwart',
+    region: 'Burgenland, Niederösterreich',
+  },
+  '41': { office: 'Braunau Ried Schärding', region: 'Oberösterreich' },
+  '46': { office: 'Linz', region: 'Oberösterreich' },
+  '51': { office: 'Kirchdorf Perg Steyr', region: 'Oberösterreich' },
+  '52': { office: 'Freistadt Rohrbach Urfahr', region: 'Oberösterreich' },
+  '53': { office: 'Gmunden Vöcklabruck', region: 'Oberösterreich' },
+  '54': { office: 'Grieskirchen Wels', region: 'Oberösterreich' },
+  '57': { office: 'Klagenfurt', region: 'Kärnten' },
+  '59': { office: 'St. Veit Wolfsberg', region: 'Kärnten' },
+  '61': { office: 'Spittal Villach', region: 'Kärnten' },
+  '65': { office: 'Bruck Leoben Mürzzuschlag', region: 'Steiermark' },
+  '67': { office: 'Oststeiermark', region: 'Steiermark' },
+  '68': { office: 'Graz-Stadt', region: 'Steiermark' },
+  '69': { office: 'Graz-Umgebung', region: 'Steiermark' },
+  '71': { office: 'Judenburg Liezen', region: 'Steiermark' },
+  '72': { office: 'Deutschlandsberg Leibnitz Voitsberg', region: 'Steiermark' },
+  '81': { office: 'Innsbruck', region: 'Tirol' },
+  '82': { office: 'Kitzbühel Lienz', region: 'Tirol' },
+  '83': { office: 'Kufstein Schwaz', region: 'Tirol' },
+  '84': { office: 'Landeck Reutte', region: 'Tirol' },
+  '90': { office: 'St. Johann Tamsweg Zell am See', region: 'Salzburg' },
+  '91': { office: 'Salzburg-Stadt', region: 'Salzburg' },
+  '93': { office: 'Salzburg-Land', region: 'Salzburg' },
+  '97': { office: 'Bregenz', region: 'Vorarlberg' },
+  '98': { office: 'Feldkirch', region: 'Vorarlberg' },
+};
+
+function clean(input: string): ReturnType<typeof strings.cleanUnicode> {
+  return strings.cleanUnicode(input, ' -./,');
+}
+
+const impl: Validator = {
+  name: 'Austrian Tax Identification Number',
+  localName: 'Abgabenkontonummer',
+  abbreviation: 'TIN',
+  compact(input: string): string {
+    const [value, err] = clean(input);
+
+    if (err) {
+      throw err;
+    }
+
+    return value;
+  },
+
+  format(input: string): string {
+    const [value] = clean(input);
+
+    const [a, b, c] = strings.splitAt(value, 2, 5);
+
+    return `${a}-${b}/${c}`;
+  },
+
+  validate(input: string): ValidateReturn {
+    const [value, error] = clean(input);
+
+    if (error) {
+      return { isValid: false, error };
+    }
+    if (value.length !== 9) {
+      return { isValid: false, error: new exceptions.InvalidLength() };
+    }
+    if (!strings.isdigits(value)) {
+      return { isValid: false, error: new exceptions.InvalidComponent() };
+    }
+
+    const [office, front, check] = strings.splitAt(value, 2, 8);
+
+    if (faOffices[office] === undefined) {
+      return { isValid: false, error: new exceptions.InvalidComponent() };
+    }
+
+    const sum = `${office}${front}`
+      .split('')
+      .map(x => parseInt(x, 10))
+      .reduce(
+        (acc, digit, idx) =>
+          acc + (idx % 2 === 1 ? [0, 2, 4, 6, 8, 1, 3, 5, 7, 9][digit] : digit),
+        0,
+      );
+
+    const digit = String((10 - (sum % 10)) % 10);
+
+    if (check !== digit) {
+      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/at/uid.spec.ts

@@ -0,0 +1,44 @@
+import { validate, format } from './uid';
+import {
+  InvalidLength,
+  InvalidChecksum,
+  InvalidComponent,
+} from '../exceptions';
+
+describe('at/uid', () => {
+  it('format:AT U13585627', () => {
+    const result = format('AT U13585627');
+
+    expect(result).toEqual('U13585627');
+  });
+
+  it('validate:AT U13585627', () => {
+    const result = validate('AT U13585627');
+
+    expect(result.isValid && result.compact).toEqual('U13585627');
+  });
+
+  it('validate:U13585627', () => {
+    const result = validate('U13585627');
+
+    expect(result.isValid && result.compact).toEqual('U13585627');
+  });
+
+  it('validate:X13585626', () => {
+    const result = validate('X13585626');
+
+    expect(result.error).toBeInstanceOf(InvalidComponent);
+  });
+
+  it('validate:U1358562', () => {
+    const result = validate('U1358562');
+
+    expect(result.error).toBeInstanceOf(InvalidLength);
+  });
+
+  it('validate:U13585626', () => {
+    const result = validate('U13585626');
+
+    expect(result.error).toBeInstanceOf(InvalidChecksum);
+  });
+});

package/src/at/uid.ts

@@ -0,0 +1,84 @@
+/**
+ *
+ * UID (Umsatzsteuer-Identifikationsnummer, Austrian VAT number).
+ *
+ * The Austrian UID is a 9-digit number that starts with a U (optionally
+ * preceded with AT). The last digit is a check digit.
+ *
+ * Sources:
+ *   https://www.ruc.com.py/
+ *
+ * ENTITY
+ */
+
+import * as exceptions from '../exceptions';
+import { strings } from '../util';
+import { Validator, ValidateReturn } from '../types';
+import { luhnChecksumValue } from '../util/checksum';
+
+function clean(input: string): ReturnType<typeof strings.cleanUnicode> {
+  const [value, err] = strings.cleanUnicode(input, ' -./');
+
+  if (err) {
+    return [value, err];
+  }
+  if (value.startsWith('AT')) {
+    return [value.substr(2), null];
+  }
+
+  return [value, null];
+}
+
+const impl: Validator = {
+  name: 'Austrian VAT Number',
+  localName: 'Umsatzsteuer-Identifikationsnummer',
+  abbreviation: 'UID',
+
+  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 !== 9) {
+      return { isValid: false, error: new exceptions.InvalidLength() };
+    }
+    if (!value.startsWith('U') || !strings.isdigits(value.substr(1))) {
+      return { isValid: false, error: new exceptions.InvalidComponent() };
+    }
+
+    const [, front, check] = strings.splitAt(value, 1, 8);
+
+    const digit = String((16 - luhnChecksumValue(front)) % 10);
+
+    if (check !== digit) {
+      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/at/vnr.spec.ts

@@ -0,0 +1,38 @@
+import { validate, format } from './vnr';
+import {
+  InvalidLength,
+  InvalidChecksum,
+  InvalidComponent,
+} from '../exceptions';
+
+describe('at/vnr', () => {
+  it('format:1237010180', () => {
+    const result = format('1237010180');
+
+    expect(result).toEqual('1237 010180');
+  });
+
+  it('validate:1237 010180', () => {
+    const result = validate('1237 010180');
+
+    expect(result.isValid && result.compact).toEqual('1237010180');
+  });
+
+  it('validate:2237 010180', () => {
+    const result = validate('2237 010180');
+
+    expect(result.error).toBeInstanceOf(InvalidChecksum);
+  });
+
+  it('validate:1237 01018', () => {
+    const result = validate('1237 01018');
+
+    expect(result.error).toBeInstanceOf(InvalidLength);
+  });
+
+  it('validate:1237 410180', () => {
+    const result = validate('1237 410180');
+
+    expect(result.error).toBeInstanceOf(InvalidComponent);
+  });
+});