@openaddresses/batch-schema 1.0.0 → 2.2.0

package/CHANGELOG.md

@@ -10,6 +10,23 @@
 
 ## Version History
 
+### v2.2.0
+
+- :tada: Add support for errors with `status` set from external libraries (IE OpenAddresses/tilebase)
+
+### v2.1.0
+
+- :tada: Add more detailed schema error messages
+
+### v2.0.0
+
+- :tada: Add support for populating `default` keys in schema
+- :arrow_up: General Dep Update
+
+### v1.0.1
+
+- :bug: Check for schema in library before looking for schema in calling project
+
 ### v1.0.0
 
 - :rocket: Intial Release

package/README.md

@@ -8,7 +8,7 @@
 npm add @openaddresses/batch-schema
 ```
 
-## Usage
+## Example Usage
 
 ```js
 const path = require('path');
@@ -36,12 +36,14 @@ async function server() {
             note: 'I only return if the request meets the query & body schemas'
         });
     });
-}
 
-// Handle Validation Errors => JSON Middleware
-schema.error();
+    // Handle Validation Errors => JSON Middleware
+    schema.error();
+}
 ```
 
+## API
+
 ```js
 const schema = new Schema(<router>, <opts>);
 
@@ -53,3 +55,24 @@ const schema = new Schema(<router>, <opts>);
 | `opts`            | Optional Opts Object |
 | `opts.schemas`    | Directory of named schemas |
 
+
+### schema.api
+
+```
+await schema.api()
+```
+
+Adds a route called `GET /schema` which allows the caller to get a list of endpoints that the router manages
+as well as full schema details for every route. If your API is public we recommend enabling this feature, however
+if you do not wish for API routes to be published, this feature is disabled unless called.
+
+### schema.error
+
+Adds a middlware which will convert validation errors into a standard JSON error format.
+This method should be called after all routes are defined. If this method is not called,
+you must provide your own middleware for converting JSON Schema Validation Errors into
+express compatible responses.
+
+```
+schema.error()
+```

package/lib/error.js

@@ -15,12 +15,21 @@ class PublicError {
 
     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).json({
+                status: err.status || err.statusCode,
+                message: err.message || 'Generic Error',
+                messages: messages
+            });
+
+        // Handle generic errors
         } else {
             console.error(err);
 

package/lib/schema.js

@@ -54,6 +54,8 @@ class Schemas {
         }
 
         this.validator = new Validator({
+            removeAdditional: true,
+            useDefaults: true,
             allErrors: true
         });
 
@@ -115,7 +117,12 @@ class Schemas {
 
         for (const type of ['body', 'query', 'res']) {
             if (!schemas[type]) continue;
-            schemas[type] = await $RefParser.dereference(path.resolve(this.schemas_path, schemas[type]));
+
+            try {
+                schemas[type] = await $RefParser.dereference(path.resolve(path.resolve(__dirname, '../schema/'), schemas[type]));
+            } catch (err) {
+                schemas[type] = await $RefParser.dereference(path.resolve(this.schemas_path, schemas[type]));
+            }
         }
 
         this.schemas.set(parsed.join(' '), schemas);
@@ -234,17 +241,12 @@ class Schemas {
         this.router.use((err, req, res, next) => {
             if (err instanceof ValidationError) {
                 let errs = [];
-
                 if (err.validationErrors.body) {
-                    errs = errs.concat(err.validationErrors.body.map((e) => {
-                        return { message: e.message };
-                    }));
+                    errs = errs.concat(err.validationErrors.body);
                 }
 
                 if (err.validationErrors.query) {
-                    errs = errs.concat(err.validationErrors.query.map((e) => {
-                        return { message: e.message };
-                    }));
+                    errs = errs.concat(err.validationErrors.query);
                 }
 
                 return Err.respond(

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@openaddresses/batch-schema",
     "root": true,
-    "version": "1.0.0",
+    "version": "2.2.0",
     "description": "Strongly Validated JSON Schema support for address",
     "repository": "git@github.com:openaddresses/batch",
     "author": "ingalls <nick@ingalls.ca>",