@openaddresses/batch-schema 4.1.0 → 4.4.0

package/CHANGELOG.md

@@ -10,6 +10,20 @@
 
 ## Version History
 
+### v4.4.0
+
+- :rocket: Add ability to take a `URL` as a schemas directory
+
+### 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

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';
@@ -45,8 +47,11 @@ export default class Schemas {
         if (!router) throw new Error('Router Param Required');
 
         if (!opts.schemas) {
-            this.schemas_path = String(new URL('../schema/', import.meta.url)).replace('file://', '');
+            this.schemas_path = new URL('../schema/', import.meta.url).pathname;
         } else {
+            if (dir instanceof URL) dir = dir.pathname;
+            else dir = String(dir)
+
             this.schemas_path = opts.schemas;
         }
 
@@ -65,6 +70,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');
 
@@ -186,12 +208,30 @@ export default class Schemas {
                 }
 
                 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;

package/package.json

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