@openaddresses/batch-schema 7.2.0 → 7.4.0

package/CHANGELOG.md

@@ -10,6 +10,14 @@
 
 ## Version History
 
+### v7.4.0
+
+- :tada: Add experimental `blueprint()` function
+
+### v7.3.0
+
+- :arrow_up: `res.json` will automatically serialize Generic objects
+
 ### v7.2.0
 
 - :tada: Preliminary support for automatically generated an APIDoc definitions file

package/lib/middleware.js

@@ -3,6 +3,7 @@ import Param from './param.js';
 import Ajv from 'ajv';
 import addFormats from 'ajv-formats';
 import { ValidationError } from 'express-json-validator-middleware';
+import Generic from '@openaddresses/batch-generic';
 
 const ajv = addFormats(new Ajv({
     allErrors: true,
@@ -99,6 +100,7 @@ export default class Middleware {
 
     /**
      * Express middleware to validate the response body
+     * and optionally serialize Generic object to JSON
      *
      * @param {Object} schema JSON Schema
      *
@@ -110,6 +112,10 @@ export default class Middleware {
         return function (req, res, next) {
             const json = res.json;
             res.json = function(obj) {
+                if (obj instanceof Generic && typeof obj.serialize === 'function') {
+                    obj = obj.serialize();
+                }
+
                 if (res.statusCode === null || res.statusCode === 200) {
                     validate(obj);
                 }

package/lib/schema.js

@@ -76,6 +76,19 @@ export default class Schemas {
         }
     }
 
+    /**
+     * Load a blueprint into the router
+     *
+     * @param {Object}  bp_class    Blueprint Class with blueprint() fn
+     * @param {object}  config      Config Object
+     * @param {Object}  opts        Options Object
+     * @param {boolean} opts.silent     Squelch StdOut
+     */
+    async blueprint(bp_class, config, opts = {}) {
+        if (!opts.silent) console.error(`ok - loaded ${bp_class}`);
+        await bp_class.blueprint(this, config);
+    }
+
     check(url, schemas, fns) {
         if (typeof url !== 'string') throw new Error('URL should be string');
 

package/package.json

@@ -3,7 +3,7 @@
     "type": "module",
     "root": true,
     "main": "index.js",
-    "version": "7.2.0",
+    "version": "7.4.0",
     "description": "Strongly Validated JSON Schema support for address",
     "repository": "git@github.com:openaddresses/batch-schema",
     "author": "ingalls <nick@ingalls.ca>",
@@ -29,6 +29,9 @@
         "morgan": "^1.10.0",
         "tape": "^5.3.1"
     },
+    "peerDependencies": {
+        "@openaddresses/batch-generic": "x.x.x"
+    },
     "devDependencies": {
         "documentation": "^13.2.5",
         "eslint": "^8.0.1",