Add support for backend validations

Author: Nethanos

package.json

@@ -47,7 +47,9 @@
     "test:watch": "node --test --watch"
   },
   "dependencies": {
-    "lodash": "^4.17.21"
+    "lodash": "^4.17.21",
+    "@uphold/countries": "^6.2.1",
+    "@uphold/zip-codes": "^1.0.1"
   },
   "devDependencies": {
     "@fastify/pre-commit": "^2.2.0",

src/asserts/not-po-box-assert.js

@@ -0,0 +1,40 @@
+'use strict';
+
+/**
+ * Module dependencies.
+ */
+
+const { Validator, Violation } = require('validator.js');
+const _ = require('lodash');
+const regexps = [
+  /apartado\s+\d+/i,
+  /bp\s+\d+/i,
+  /postboks\s+\d+/i,
+  /postbus\s+\d+/i,
+  /postfach\s+\d+/i,
+  /(\W|^)(p\.?\s*o\.?|(post|postal)\s+(office)?)\s*(box)?\s*(number|num|no)?\s*\d+/i
+];
+
+/**
+ * Export `NotPoBoxAssert`.
+ */
+
+module.exports = function () {
+  this.__class__ = 'NotPoBox';
+
+  this.validate = function (value) {
+    if (!_.isString(value)) {
+      throw new Violation(this, value, { value: Validator.errorCode.must_be_a_string });
+    }
+
+    for (const regexp of regexps) {
+      if (regexp.test(value)) {
+        throw new Violation(this, value);
+      }
+    }
+
+    return true;
+  };
+
+  return this;
+};

src/asserts/person-name-assert.js

@@ -0,0 +1,36 @@
+'use strict';
+
+/**
+ * Module dependencies.
+ */
+
+const { Validator, Violation } = require('validator.js');
+const _ = require('lodash');
+
+/**
+ * Export `PersonNameAssert`.
+ */
+
+module.exports = function () {
+  // Class name.
+  this.__class__ = 'PersonName';
+
+  const regexp = /[\d!"“”#$€£%{}@&()*+/:;<=>?[\\\]^_~]|[’`-]$/g;
+
+  // Validation algorithm.
+  this.validate = function (value) {
+    if (!_.isString(value)) {
+      throw new Violation(this, value, { value: Validator.errorCode.must_be_a_string });
+    }
+
+    const matches = value.match(regexp);
+
+    if (matches) {
+      throw new Violation(this, value, { matches: _.uniq(matches) });
+    }
+
+    return true;
+  };
+
+  return this;
+};

src/asserts/zip-code-assert.js

@@ -0,0 +1,72 @@
+'use strict';
+
+/**
+ * Module dependencies.
+ */
+
+const { Assert, Validator, Violation } = require('validator.js');
+const { CaZipCode, UsZipCode } = require('validator.js-asserts');
+const {
+  common: { getCountriesAlpha2 }
+} = require('@uphold/countries');
+const _ = require('lodash');
+const zipCodes = require('@uphold/zip-codes');
+
+/**
+ * Constants.
+ */
+
+const countriesAlpha2 = getCountriesAlpha2();
+
+/**
+ * Instances.
+ */
+
+const is = Assert.extend({ CaZipCode, UsZipCode });
+
+/**
+ * Export `ZipCodeAssert`.
+ */
+
+module.exports = function (data = {}) {
+  this.__class__ = 'ZipCode';
+  this.country = data && data.country;
+  this.state = data && data.state;
+
+  this.validate = function (value) {
+    if (value !== null && !_.isString(value)) {
+      throw new Violation(this, value, { value: 'must_be_null_or_a_string' });
+    }
+
+    if (!_.isString(this.country)) {
+      throw new Violation(this, value, { country: Validator.errorCode.must_be_a_string });
+    }
+
+    if (!countriesAlpha2.includes(this.country)) {
+      throw new Violation(this, value, { reason: 'invalid-country' });
+    }
+
+    if (this.country === 'US' && is.usZipCode().check(value) !== true) {
+      throw new Violation(this, value, { reason: 'invalid-zip-code' });
+    }
+
+    if (this.country === 'CA' && is.caZipCode().check(value) !== true) {
+      throw new Violation(this, value, { reason: 'invalid-zip-code' });
+    }
+
+    const state = this.state && this.state.split('-')[1];
+
+    if (
+      this.country &&
+      state &&
+      _.has(zipCodes, `${this.country}.${state}`) &&
+      !(zipCodes[this.country][state] || []).find(zip => value.toUpperCase().startsWith(zip.toUpperCase()))
+    ) {
+      throw new Violation(this, value, { reason: 'invalid-state-zip-code' });
+    }
+
+    return true;
+  };
+
+  return this;
+};

src/index.js

@@ -32,6 +32,7 @@ const Ip = require('./asserts/ip-assert.js');
 const Iso3166Country = require('./asserts/iso-3166-country-assert.js');
 const Json = require('./asserts/json-assert.js');
 const NotEmpty = require('./asserts/not-empty-assert.js');
+const NotPoBox = require('./asserts/not-po-box-assert.js');
 const NullOr = require('./asserts/null-or-assert.js');
 const NullOrBoolean = require('./asserts/null-or-boolean-assert.js');
 const NullOrDate = require('./asserts/null-or-date-assert.js');
@@ -79,6 +80,7 @@ module.exports = {
   Iso3166Country,
   Json,
   NotEmpty,
+  NotPoBox,
   NullOr,
   NullOrBoolean,
   NullOrDate,

test/asserts/not-po-box-assert.test.js

@@ -0,0 +1,93 @@
+'use strict';
+
+/**
+ * Module dependencies.
+ */
+
+const { Assert: BaseAssert, Violation } = require('validator.js');
+const { describe, it } = require('node:test');
+const NotPoBoxAssert = require('../../src/asserts/not-po-box-assert.js');
+
+/**
+ * Extend `Assert` with `NotPoBox`.
+ */
+
+const Assert = BaseAssert.extend({
+  NotPoBox: NotPoBoxAssert
+});
+
+/**
+ * Instances.
+ */
+
+const addresses = {
+  allowed: [
+    `123 Boxing Street`,
+    `34 Box Handler Road`,
+    `424 Po Dance drive`,
+    `234 P.O.D. Wasn't Terrible Circle`,
+    `345 Box St, Main St`,
+    `345 Po St, Main St`,
+    `POSTAL NOTHING 234 Main St`,
+    `p.o.BOX ABC, Main St`,
+    `Cuerpo 2`
+  ],
+  disallowed: [
+    `P.O.BOX 234 Main St`,
+    `P.O. BOX 234 Main St`,
+    `Main St, P.O.BOX 234`,
+    `POST OFFICE BOX 234 Main St`,
+    `PO BOX 234 Main St`,
+    `po box 234 Main St`,
+    `po Box 234, 453 Main St`,
+    `Postal Office BOX 234, Main St`,
+    `POST BOX 234, Main St`,
+    `POST BOX NO 234, Main St`,
+    `POSTAL BOX 234, Main St`,
+    `PO 234, 345 Main St`,
+    `Postfach 8 15`,
+    `Postbus 90222`,
+    `Postboks 447 Sentrum`,
+    `BP 13210`,
+    `Apartado 0832`
+  ]
+};
+
+/**
+ * Test `NotPoBoxAssert`.
+ */
+
+describe('NotPoBoxAssert', () => {
+  it('should throw an error if value is not provided', ({ assert }) => {
+    try {
+      Assert.notPoBox().validate();
+
+      assert.fail();
+    } catch (e) {
+      assert.ok(e instanceof Violation);
+      assert.equal(e.show().assert, 'NotPoBox');
+      assert.equal(e.show().violation.value, 'must_be_a_string');
+    }
+  });
+
+  addresses.disallowed.forEach(address => {
+    it(`should throw an error for address \`${address}\``, ({ assert }) => {
+      try {
+        Assert.notPoBox().validate(address);
+        assert.fail();
+      } catch (e) {
+        assert.ok(e instanceof Violation);
+        assert.equal(e.show().assert, 'NotPoBox');
+        assert.equal(e.show().value, address);
+      }
+    });
+  });
+
+  addresses.allowed.forEach(address => {
+    it(`should accept address \`${address}\``, ({ assert }) => {
+      assert.doesNotThrow(() => {
+        Assert.notPoBox().validate(address);
+      });
+    });
+  });
+});

test/index.test.js

@@ -15,7 +15,7 @@ describe('validator.js-asserts', () => {
   it('should export all asserts', ({ assert }) => {
     const assertNames = Object.keys(asserts);
 
-    assert.equal(assertNames.length, 41);
+    assert.equal(assertNames.length, 42);
     assert.deepEqual(assertNames, [
       'AbaRoutingNumber',
       'BankIdentifierCode',
@@ -45,6 +45,7 @@ describe('validator.js-asserts', () => {
       'Iso3166Country',
       'Json',
       'NotEmpty',
+      'NotPoBox',
       'NullOr',
       'NullOrBoolean',
       'NullOrDate',