feat: promises rewrite and drop support for node 10

.github/dependabot.yml

@@ -1,11 +1,23 @@
 version: 2
 updates:
-- package-ecosystem: npm
-  directory: "/"
-  schedule:
-    interval: monthly
-  open-pull-requests-limit: 10
-  reviewers:
-  - erunion
-  labels:
-  - dependencies
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: monthly
+    reviewers:
+      - erunion
+    labels:
+      - dependencies
+    commit-message:
+      prefix: chore(deps)
+      prefix-development: chore(deps-dev)
+
+  - package-ecosystem: npm
+    directory: "/"
+    schedule:
+      interval: monthly
+    open-pull-requests-limit: 10
+    reviewers:
+      - erunion
+    labels:
+      - dependencies

.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+name: CI
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [12.x, 14.x, 16.x]
+
+    steps:
+      - uses: actions/checkout@v1
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Install npm@7
+        run: npm install -g npm@7
+
+      - name: Install deps
+        run: npm ci
+
+      - name: Run tests
+        run: npm test

.npmignore

@@ -1,6 +1,5 @@
+__tests__/
 .github/
-examples/
 coverage/
-test/
 .eslint*
 .prettier*

README.md

@@ -2,6 +2,8 @@ Swagger 2 or OAS 3? YAML or JSON? URL, path, string or object? Who cares! It jus
 
 This module uses a bunch of other great modules to do the heavy lifting, and normalizes everything!
 
+[![Build](https://github.com/readmeio/oas-normalize/workflows/CI/badge.svg)](https://github.com/readmeio/oas-normalize/) [![](https://img.shields.io/npm/v/oas-normalize)](https://npm.im/oas-normalize)
+
 [![](https://cl.ly/1h271F1M1e2T/Untitled-2.png)](http://readme.io)
 
 # Install
@@ -15,23 +17,22 @@ npm install oas-normalize --save
 It's pretty simple:
 
 ```javascript
-const OAS = require('oas-normalize');
-
-const oas = new OAS('https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore-expanded.yaml'); // Or a string, pathname, JSON blob, whatever
-oas.validate((err, spec) => {
-  if (err) {
-    console.log(err.errors);
-    return;
-  }
-  console.log(spec); // spec will always be JSON, and valid
+const OASNormalize = require('oas-normalize');
+
+const oas = new OASNormalize('https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore-expanded.yaml'); // Or a string, pathname, JSON blob, whatever
+
+oas.validate().then(definition => {
+  console.log(definition); // definition will always be JSON, and valid
+}).catch(err => {
+  console.log(err.errors);
 });
 ```
 
 # Errors
 
 For validation errors, when available, you'll get back an object:
 
-```
+```json
 {
   "errors": [
     {
@@ -47,22 +48,32 @@ For validation errors, when available, you'll get back an object:
 
 # Helper functions
 
+> **Note:** All of these functions are promise-driven.
+
 If you want some more functionality, you can do anything here:
 
-| Function       | What it does                                                   |
-|----------------|----------------------------------------------------------------|
-| oas.load(cb)      | Just load the file, valid or not, as JSON                      |
-| oas.bundle(cb)    | Bring together all files into one JSON blob (but keep `$refs`) |
-| oas.deref(cb)     | Resolve `$refs`                                                |
-| oas.validate(cb, [convertToLatest?]))  | Validate the whole thing!                |
+| Function | What it does |
+| :--- | :--- |
+| `.load()` | Just load the file, valid or not, as JSON |
+| `.bundle()` | Bring together all files into one JSON blob (but retain `$ref` pointers) |
+| `.deref()` | Resolve `$ref` pointers |
+| `.validate([convertToLatest?]))` | Validate the whole thing! |
 
 # Other little features
 
 ### Always return OAS 3
 
-If you want `.validate` to always return a OAS 3 document, include a `true` as the second param: `oas.validate(action, true);`
+If you want `.validate` to always return an OpenAPI 3.0 definition, supply `true` as its argument:
+
+```js
+OASNormalize.validate(true).then(...);
+```
 
 ### Enable local paths
 
-For security reasons, you need to enable it. Use `new OAS('./whatever.json', { enablePaths: true })` to load local files.
+For security reasons, you need to enable it; supply `enablePaths` to the class instance:
+
+```js
+const oas = new OASNormalize('./petstore.json', { enablePaths: true })
+```
 

__tests__/__fixtures__/bundle/definition.json

@@ -0,0 +1,46 @@
+{
+  "openapi": "3.0.0",
+  "servers": [
+    {
+      "url": "http://petstore.swagger.io/v2"
+    }
+  ],
+  "info": {
+    "version": "1.0.0",
+    "title": "Swagger Petstore"
+  },
+  "paths": {
+    "/pet": {
+      "post": {
+        "responses": {
+          "405": {
+            "description": "Invalid input"
+          }
+        },
+        "requestBody": {
+          "$ref": "#/components/requestBodies/Pet"
+        }
+      }
+    }
+  },
+  "components": {
+    "requestBodies": {
+      "Pet": {
+        "content": {
+          "application/json": {
+            "schema": {
+              "$ref": "./__tests__/__fixtures__/bundle/pet.json"
+            }
+          },
+          "application/xml": {
+            "schema": {
+              "$ref": "./__tests__/__fixtures__/bundle/pet.json"
+            }
+          }
+        },
+        "description": "Pet object that needs to be added to the store",
+        "required": true
+      }
+    }
+  }
+}

__tests__/__fixtures__/bundle/pet.json

@@ -0,0 +1,26 @@
+{
+  "type": "object",
+  "required": ["name", "photoUrls"],
+  "properties": {
+    "id": {
+      "type": "integer",
+      "format": "int64",
+      "readOnly": true
+    },
+    "name": {
+      "type": "string",
+      "example": "doggie"
+    },
+    "photoUrls": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "status": {
+      "type": "string",
+      "description": "pet status in the store",
+      "enum": ["available", "pending", "sold"]
+    }
+  }
+}

test/fixtures/openapi/err-missing-schema.json → __tests__/__fixtures__/invalid/openapi.json

@@ -75,114 +75,6 @@
                  }
               }
            }
-        },
-        "post": {
-           "description": "Creates a new pet in the store.  Duplicates are allowed",
-           "operationId": "addPet",
-           "requestBody": {
-              "description": "Pet to add to the store",
-              "required": true,
-              "content": {
-                 "application/json": {
-                    "schema": {
-                       "$ref": "#/components/schemas/NewPet"
-                    }
-                 }
-              }
-           },
-           "responses": {
-              "200": {
-                 "description": "pet response",
-                 "content": {
-                    "application/json": {
-                       "schema": {
-                          "$ref": "#/components/schemas/Pet"
-                       }
-                    }
-                 }
-              },
-              "default": {
-                 "description": "unexpected error",
-                 "content": {
-                    "application/json": {
-                       "schema": {
-                          "$ref": "#/components/schemas/Error"
-                       }
-                    }
-                 }
-              }
-           }
-        }
-     },
-     "/pets/{id}": {
-        "get": {
-           "description": "Returns a user based on a single ID, if the user does not have access to the pet",
-           "operationId": "find pet by id",
-           "parameters": [
-              {
-                 "name": "id",
-                 "in": "path",
-                 "description": "ID of pet to fetch",
-                 "required": true,
-                 "schema": {
-                    "type": "integer",
-                    "format": "int64"
-                 }
-              }
-           ],
-           "responses": {
-              "200": {
-                 "description": "pet response",
-                 "content": {
-                    "application/json": {
-                       "schema": {
-                          "$ref": "#/components/schemas/Pet"
-                       }
-                    }
-                 }
-              },
-              "default": {
-                 "description": "unexpected error",
-                 "content": {
-                    "application/json": {
-                       "schema": {
-                          "$ref": "#/components/schemas/Error"
-                       }
-                    }
-                 }
-              }
-           }
-        },
-        "delete": {
-           "description": "deletes a single pet based on the ID supplied",
-           "operationId": "deletePet",
-           "parameters": [
-              {
-                 "name": "id",
-                 "in": "path",
-                 "description": "ID of pet to delete",
-                 "required": true,
-                 "schema": {
-                    "type": "integer",
-                    "format": "int64"
-                 }
-              }
-           ],
-           "responses": {
-              "204": {
-                 "description": "pet deleted"
-              },
-              "default": {
-                 "description": "unexpected error",
-                 "content": {
-                    "application/json": {
-                       "schema": {
-                          "$ref": "#/components/schemas/Error"
-                       }
-                    }
-                 }
-              }
-           }
         }
      }
   },