@openaddresses/batch-schema 2.3.3 → 3.0.0

package/.eslintrc.json

@@ -8,7 +8,8 @@
         "Map": true
     },
     "parserOptions": {
-        "ecmaVersion": 13
+        "ecmaVersion": 13,
+        "sourceType": "module"
     },
     "plugins": [ "node" ],
     "rules": {
@@ -39,7 +40,6 @@
         "template-curly-spacing": [ "error", "never" ],
         "semi-spacing": "error",
         "strict": "error",
-        "node/no-unsupported-features": [ "error", { "version": 8 } ],
         "node/no-missing-require": "error",
         "valid-jsdoc": ["error", {
             "requireParamDescription": false,

package/CHANGELOG.md

@@ -10,6 +10,18 @@
 
 ## Version History
 
+### v3.0.0
+
+- :rocket: Update to ES Module System
+
+### v2.4.0
+
+- :tada: Add `schema.not_found()`
+
+### v2.3.4
+
+- :arrow_up: Update base deps
+
 ### v2.3.3
 
 - :rocket: Name exports explicitly instead of returning object for ES module compat.

package/README.md

@@ -5,7 +5,13 @@
 ## Installation
 
 ```sh
-npm add @openaddresses/batch-schema
+yarn add @openaddresses/batch-schema
+```
+
+or
+
+```sh
+npm i @openaddresses/batch-schema
 ```
 
 ## Example Usage
@@ -37,6 +43,9 @@ async function server() {
         });
     });
 
+    // Handle Unmatched Routes
+    schema.not_found();
+
     // Handle Validation Errors => JSON Middleware
     schema.error();
 }
@@ -66,6 +75,15 @@ Adds a route called `GET /schema` which allows the caller to get a list of endpo
 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.not_found
+
+Adds a middlware which will catch all routes that have not been defined and return
+a standard error object.
+
+```
+schema.not_found()
+```
+
 ### schema.error
 
 Adds a middlware which will convert validation errors into a standard JSON error format.

package/index.js

@@ -1,4 +1,7 @@
-'use strict';
+import Schema from './lib/schema.js';
+import Err from './lib/error.js';
 
-module.exports.Schema = require('./lib/schema');
-module.exports.Err = require('./lib/error')
+export {
+    Schema,
+    Err
+};

package/lib/error.js

@@ -1,9 +1,7 @@
-'use strict';
-
 /**
  * @class
  */
-class PublicError {
+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);
@@ -43,5 +41,3 @@ class PublicError {
         }
     }
 }
-
-module.exports = PublicError;

package/lib/schema.js

@@ -1,11 +1,9 @@
-'use strict';
+import { Validator } from 'express-json-validator-middleware';
+import { ValidationError } from 'express-json-validator-middleware';
+import $RefParser from 'json-schema-ref-parser';
 
-const { Validator } = require('express-json-validator-middleware');
-const $RefParser = require('json-schema-ref-parser');
-const path = require('path');
-const Err = require('./error');
-const SchemaRoute = require('../routes/schema');
-const { ValidationError } = require('express-json-validator-middleware');
+import Err from './error.js';
+import SchemaRoute from '../routes/schema.js';
 
 /**
  * @class
@@ -38,7 +36,7 @@ class Param {
 /**
  * @class
  */
-class Schemas {
+export default class Schemas {
     /**
      * @constructor
      *
@@ -50,7 +48,7 @@ class Schemas {
         if (!router) throw new Error('Router Param Required');
 
         if (!opts.schemas) {
-            this.schemas_path = path.resolve(__dirname, '../schema/');
+            this.schemas_path = String(new URL('../schema/', import.meta.url)).replace('file://', '');
         } else {
             this.schemas_path = opts.schemas;
         }
@@ -121,9 +119,9 @@ class Schemas {
             if (!schemas[type]) continue;
 
             try {
-                schemas[type] = await $RefParser.dereference(path.resolve(path.resolve(__dirname, '../schema/'), schemas[type]));
+                schemas[type] = await $RefParser.dereference(`../schema/${schemas[type]}`);
             } catch (err) {
-                schemas[type] = await $RefParser.dereference(path.resolve(this.schemas_path, schemas[type]));
+                schemas[type] = await $RefParser.dereference(`${this.schemas_path}/${schemas[type]}`);
             }
         }
 
@@ -236,6 +234,19 @@ class Schemas {
         return schema;
     }
 
+    /**
+     * Catch all for unmatched routes
+     */
+    not_found() {
+        this.router.all('*', (req, res) => {
+            return res.status(404).json({
+                status: 404,
+                message: 'API endpoint does not exist!',
+                messages: []
+            });
+        });
+    }
+
     /**
      * Convert validation errors into standardized JSON Error Messages
      */
@@ -281,5 +292,3 @@ class Schemas {
         return lite;
     }
 }
-
-module.exports = Schemas;