@openaddresses/batch-schema 4.0.0 → 4.3.0

package/CHANGELOG.md

@@ -10,6 +10,26 @@
 
 ## Version History
 
+### v4.3.0
+
+- :arrow_up: Update base deps
+- :tada: Support casting query param arrays into `integer`, `number`, or `boolean`
+
+### v4.2.0
+
+- :arrow_up: Update base deps
+- :tada: Add `load()` function for loading routes dir
+
+### v4.1.0
+
+- :bug: Ensure `default: false` is still applied
+- :arrow_up: Update base deps
+
+### v4.0.0
+
+- :white_check_mark: Update schema validator to latest version (AJV 8)
+- :rocket: Remove `got` in favour of `fetch`
+
 ### v3.1.3
 
 - :rocket: Add automated releases

package/README.md

@@ -94,3 +94,18 @@ express compatible responses.
 ```
 schema.error()
 ```
+
+### schema.load
+
+Loads and runs all routes files in a directory
+
+```
+schema.load(directory, config, opts)
+```
+
+| Config Option     | Notes |
+| ----------------- | ----- |
+| `directory`       | Directory to load .js files from |
+| `config`          | Config option to pass to each route |
+| `opts`            | Optional Opts Object |
+| `opts.silent`     | Squelch output |

package/lib/schema.js

@@ -1,6 +1,8 @@
 import { Validator } from 'express-json-validator-middleware';
 import { ValidationError } from 'express-json-validator-middleware';
 import $RefParser from 'json-schema-ref-parser';
+import fs from 'fs';
+import path from 'path';
 
 import Err from './error.js';
 import SchemaRoute from '../routes/schema.js';
@@ -35,15 +37,12 @@ class Param {
 
 /**
  * @class
+ *
+ * @param {Object} router Express Router Object
+ * @param {Object} opts Options Object
+ * @param {String} opts.schemas Schemas Path
  */
 export default class Schemas {
-    /**
-     * @constructor
-     *
-     * @param {Object} router Express Router Object
-     * @param {Object} opts Options Object
-     * @param {String} opts.schemas Schemas Path
-     */
     constructor(router, opts = {}) {
         if (!router) throw new Error('Router Param Required');
 
@@ -68,6 +67,23 @@ export default class Schemas {
         await SchemaRoute(this);
     }
 
+    /**
+     * Load routes directory. All .js files in the given directory will be loaded (ES Module)
+     * and the default method run
+     *
+     * @param {String}  dirpath     Directory to load
+     * @param {object}  config      Config Object
+     * @param {Object}  opts        Options Object
+     * @param {boolean} opts.silent     Squelch StdOut
+     */
+    async load(dirpath, config, opts = {}) {
+        // Load dynamic routes directory
+        for (const r of fs.readdirSync(dirpath)) {
+            if (!opts.silent) console.error(`ok - loaded routes/${r}`);
+            await (await import(path.resolve(dirpath, r))).default(this, config);
+        }
+    }
+
     check(url, schemas, fns) {
         if (typeof url !== 'string') throw new Error('URL should be string');
 
@@ -180,19 +196,39 @@ export default class Schemas {
      */
     static query(schema) {
         return function (req, res, next) {
-            for (const key of Object.keys(req.query)) {
+            for (const key in req.query) {
                 if (!schema.properties[key] || !schema.properties[key].type) continue;
 
                 // For easier processing use consistent array format IE: `type: ["integer", "boolean"]` vs type: "integer"
-                if (!Array.isArray(schema.properties[key].type)) schema.properties[key].type = [schema.properties[key].type];
+                if (!Array.isArray(schema.properties[key].type)) {
+                    schema.properties[key].type = [schema.properties[key].type];
+                }
 
                 for (const type of schema.properties[key].type) {
-                    if (type === 'integer' && !isNaN(parseInt(req.query[key]))) {
+                    if (type === 'array') {
+                        req.query[key] = req.query[key].split(',');
+
+                        if (schema.properties[key].items && schema.properties[key].items.type === 'number') {
+                            req.query[key] = req.query[key].map((k) => {
+                                return Number(k);
+                            });
+                        } else if (schema.properties[key].items && schema.properties[key].items.type === 'integer') {
+                            req.query[key] = req.query[key].map((k) => {
+                                return parseInt(k);
+                            });
+                        } else if (schema.properties[key].items && schema.properties[key].items.type === 'boolean') {
+                            req.query[key] = req.query[key].map((k) => {
+                                if (k === 'true') {
+                                    return true;
+                                } else if (k === 'false') {
+                                    return false;
+                                }
+                            });
+                        }
+                    } else if (type === 'integer' && !isNaN(parseInt(req.query[key]))) {
                         req.query[key] = parseInt(req.query[key]);
                     } else if (type === 'number' && !isNaN(Number(req.query[key]))) {
                         req.query[key] = Number(req.query[key]);
-                    } else if (type === 'array') {
-                        req.query[key] = req.query[key].split(',');
                     } else if (type === 'boolean') {
                         if (req.query[key] === 'true') {
                             req.query[key] = true;
@@ -203,8 +239,8 @@ export default class Schemas {
                 }
             }
 
-            for (const key of Object.keys(schema.properties)) {
-                if (req.query[key] === undefined && schema.properties[key].default) {
+            for (const key in schema.properties) {
+                if (req.query[key] === undefined && schema.properties[key].default !== undefined) {
                     req.query[key] = schema.properties[key].default;
                 }
             }

package/package.json

@@ -3,7 +3,7 @@
     "type": "module",
     "root": true,
     "main": "index.js",
-    "version": "4.0.0",
+    "version": "4.3.0",
     "description": "Strongly Validated JSON Schema support for address",
     "repository": "git@github.com:openaddresses/batch-schema",
     "author": "ingalls <nick@ingalls.ca>",