@openaddresses/batch-schema 4.2.0 → 5.0.0

package/CHANGELOG.md

@@ -10,6 +10,19 @@
 
 ## Version History
 
+### v5.0.0
+
+- :tada: Logging and body parsing enabled by default
+
+### 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

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

@@ -3,6 +3,8 @@ import { ValidationError } from 'express-json-validator-middleware';
 import $RefParser from 'json-schema-ref-parser';
 import fs from 'fs';
 import path from 'path';
+import morgan from 'morgan';
+import bodyparser from 'body-parser';
 
 import Err from './error.js';
 import SchemaRoute from '../routes/schema.js';
@@ -41,14 +43,19 @@ class Param {
  * @param {Object} router Express Router Object
  * @param {Object} opts Options Object
  * @param {String} opts.schemas Schemas Path
+ * @param {boolean|string} [opts.logging=true] disable logging with false
+ * @param {number} [opts.limit=50] body size limit in mb
  */
 export default class Schemas {
     constructor(router, opts = {}) {
         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 (opts.schemas instanceof URL) opts.schemas = opts.schemas.pathname;
+            else opts.schemas = String(opts.schemas);
+
             this.schemas_path = opts.schemas;
         }
 
@@ -59,6 +66,11 @@ export default class Schemas {
         });
 
         this.router = router;
+
+        if (opts.morgan !== false) this.router.use(morgan('combined'));
+        this.router.use(bodyparser.urlencoded({ extended: true }));
+        this.router.use(bodyparser.json({ limit: `${opts.limit}mb` }));
+
         this.schemas = new Map();
         this.validate = this.validator.validate;
     }
@@ -205,12 +217,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.2.0",
+    "version": "5.0.0",
     "description": "Strongly Validated JSON Schema support for address",
     "repository": "git@github.com:openaddresses/batch-schema",
     "author": "ingalls <nick@ingalls.ca>",
@@ -19,10 +19,12 @@
     },
     "dependencies": {
         "ajv": "^8.6.3",
+        "body-parser": "^1.20.0",
         "express": "^4.17.1",
         "express-json-validator-middleware": "^3.0.0",
         "glob": "^8.0.0",
         "json-schema-ref-parser": "^9.0.9",
+        "morgan": "^1.10.0",
         "tape": "^5.3.1"
     },
     "devDependencies": {