@openaddresses/batch-schema 6.0.0 → 7.2.0

package/CHANGELOG.md

@@ -10,6 +10,19 @@
 
 ## Version History
 
+### v7.2.0
+
+- :tada: Preliminary support for automatically generated an APIDoc definitions file
+
+### v7.1.0
+
+- :bug: Only validate response on 200 status
+
+### v7.0.0
+
+- :rocket: Remove PublicError class to it's own package
+- :rocket: `Schema` is now exposed as the default
+
 ### v6.0.0
 
 - :rocket: Remove additional properties if they are not present in `res` and `additionalProperties: false` is set

package/index.js

@@ -1,7 +1,3 @@
 import Schema from './lib/schema.js';
-import Err from './lib/error.js';
 
-export {
-    Schema,
-    Err
-};
+export default Schema;

package/lib/docs.js

@@ -0,0 +1,36 @@
+/**
+ * @class Docs
+ */
+export default class Docs extends Array {
+    push(parsed, schemas) {
+        const apiParams = [];
+        for (const key in schemas) {
+            if (key[0] === ':') {
+                apiParams.push(`* @apiParam {${schemas[key]}} ${key.slice(1)} param`);
+            }
+        }
+
+        super.push(
+            `
+                /**
+                 * @api {${parsed[0].toLowerCase()}} ${parsed[1]} ${schemas.name || parsed.join(' ')}
+                 * @apiVersion ${schemas.version || '1.0.0'}
+                 * @apiName ${parsed.join('-')}
+                 * @apiGroup ${schemas.group || 'Default'}
+                 * @apiPermission ${schemas.auth || 'Unknown'}
+                 *
+                 * @apidescription
+                 *   ${schemas.description || 'No Description'}
+                 *
+                 ${apiParams.join('\n')}
+                 *
+                 * ${schemas.query_url ? `@apiSchema (Query) {jsonschema=${schemas.query_url}} apiParam` : ''}
+                 * ${schemas.body_url ? `@apiSchema (Body) {jsonschema=${schemas.body_url}} apiParam` : ''}
+                 * ${schemas.res_url ? `@apiSchema {jsonschema=${schemas.res_url}} apiSuccess` : ''}
+                 */
+            `.split('\n')
+                .map((l) => l.trim())
+                .join('\n')
+        );
+    }
+}

package/lib/middleware.js

@@ -1,4 +1,4 @@
-import Err from './error.js';
+import Err from '@openaddresses/batch-error';
 import Param from './param.js';
 import Ajv from 'ajv';
 import addFormats from 'ajv-formats';
@@ -110,7 +110,9 @@ export default class Middleware {
         return function (req, res, next) {
             const json = res.json;
             res.json = function(obj) {
-                validate(obj);
+                if (res.statusCode === null || res.statusCode === 200) {
+                    validate(obj);
+                }
 
                 json.call(this, obj);
             };

package/lib/param.js

@@ -1,4 +1,4 @@
-import Err from './error.js';
+import Err from '@openaddresses/batch-error';
 
 /**
  * @class

package/lib/schema.js

@@ -7,6 +7,7 @@ import bodyparser from 'body-parser';
 
 import SchemaRoute from '../routes/schema.js';
 import Param from './param.js';
+import Docs from './docs.js';
 import Middleware from './middleware.js';
 
 /**
@@ -17,6 +18,8 @@ import Middleware from './middleware.js';
  * @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
+ *
+ * @param {URL} [opts.apidoc] apidoc file location
  */
 export default class Schemas {
     constructor(router, opts = {}) {
@@ -45,6 +48,8 @@ export default class Schemas {
 
         this.schemas = new Map();
         this.validate = this.validator.validate;
+
+        this.docs = new Docs();
     }
 
     async api() {
@@ -121,6 +126,8 @@ export default class Schemas {
         for (const type of ['body', 'query', 'res']) {
             if (!schemas[type]) continue;
 
+            // TODO: Write schemas to a tmp directory so blueprints & main schemas are in the same place
+            schemas[`${type}_url`] = '../schema/' + schemas[type];
             try {
                 schemas[type] = await $RefParser.dereference((new URL(`../schema/${schemas[type]}`, import.meta.url)).pathname);
             } catch (err) {
@@ -128,6 +135,8 @@ export default class Schemas {
             }
         }
 
+        this.docs.push(parsed, schemas);
+
         this.schemas.set(parsed.join(' '), schemas);
 
         const opts = {};
@@ -148,7 +157,6 @@ export default class Schemas {
 
         flow[1].push(this.validate(opts));
 
-        console.error(schemas);
         if (schemas.res) flow[1].push(Middleware.res(schemas.res));
 
         return flow;
@@ -179,7 +187,11 @@ export default class Schemas {
         if (!schema.body) schema.body = null;
         if (!schema.res) schema.res = null;
 
-        return schema;
+        return {
+            query: schema.query,
+            body: schema.body,
+            res: schema.res
+        };
     }
 
     /**

package/package.json

@@ -3,7 +3,7 @@
     "type": "module",
     "root": true,
     "main": "index.js",
-    "version": "6.0.0",
+    "version": "7.2.0",
     "description": "Strongly Validated JSON Schema support for address",
     "repository": "git@github.com:openaddresses/batch-schema",
     "author": "ingalls <nick@ingalls.ca>",
@@ -18,6 +18,7 @@
         "doc": "documentation build index.js -f html -o docs && documentation lint index.js"
     },
     "dependencies": {
+        "@openaddresses/batch-error": "^1.0.1",
         "ajv": "^8.6.3",
         "ajv-formats": "^2.1.1",
         "body-parser": "^1.20.0",

package/routes/schema.js

@@ -1,4 +1,4 @@
-import Err from '../lib/error.js';
+import Err from '@openaddresses/batch-error';
 
 export default async function router(schema) {
     /**

package/test/schema.srv.test.js

@@ -1,6 +1,6 @@
 import test from 'tape';
 import express from 'express';
-import { Schema } from '../index.js';
+import Schema from '../index.js';
 
 const app = express();
 const schema = new Schema(express.Router(), {

package/lib/error.js

@@ -1,43 +0,0 @@
-/**
- * @class
- */
-export default class PublicError {
-    constructor(status, err, safe, print = true) {
-        // Wrap postgres errors to ensure stack trace (line nums) are returned
-        if (err && err.severity) err = new Error(err);
-
-        if (print && ![400, 401, 402, 403, 404].includes(status)) console.error(err ? err : 'Error: ' + safe);
-
-        this.status = status;
-        this.err = err;
-        this.safe = safe;
-    }
-
-    static respond(err, res, messages = []) {
-        if (err instanceof PublicError) {
-            res.status(err.status).json({
-                status: err.status,
-                message: err.safe,
-                messages: messages
-            });
-
-        // Duplicate Express supported Error extensions
-        } else if (err instanceof Error && (err.status || err.statusCode)) {
-            res.status(err.status || err.statusCode).json({
-                status: err.status || err.statusCode,
-                message: err.message || 'Generic Error',
-                messages: messages
-            });
-
-        // Handle generic errors
-        } else {
-            console.error(err);
-
-            res.status(500).json({
-                status: 500,
-                message: 'Internal Server Error',
-                messages: messages
-            });
-        }
-    }
-}