@uphold/fastify-openapi-router-plugin 1.0.1 → 1.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uphold/fastify-openapi-router-plugin",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "A plugin for Fastify to connect routes with a OpenAPI 3.x specification",
   "main": "./src/index.js",
   "types": "./types/index.d.ts",
@@ -34,24 +34,24 @@
   },
   "devDependencies": {
     "@eslint/js": "^9.6.0",
-    "@vitest/coverage-v8": "^1.6.0",
+    "@vitest/coverage-v8": "^4.1.1",
     "eslint": "^9.6.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-prettier": "^5.2.1",
     "eslint-plugin-sort-destructure-keys": "^2.0.0",
     "eslint-plugin-sort-imports-requires": "^1.0.2",
     "eslint-plugin-sort-keys-fix": "^1.1.2",
-    "fastify": "^4.28.1",
+    "fastify": "^5.8.4",
     "globals": "^15.7.0",
     "prettier": "^3.3.3",
-    "release-it": "^17.6.0",
-    "vitest": "^1.6.0"
+    "release-it": "^19.2.4",
+    "vitest": "^4.1.0"
   },
   "dependencies": {
-    "@readme/openapi-parser": "^2.6.0",
+    "@readme/openapi-parser": "^6.0.0",
     "fastify-plugin": "^4.5.1",
-    "lodash-es": "^4.17.21",
+    "lodash-es": "^4.17.23",
     "openapi-types": "^12.1.3",
-    "p-props": "^6.0.0"
+    "p-props": "^6.1.0"
   }
 }

package/src/parser/spec.js

@@ -1,13 +1,19 @@
-import OpenAPIParser from '@readme/openapi-parser';
+import { parse, validate } from '@readme/openapi-parser';
 
 export const validateSpec = async options => {
-  const spec = await OpenAPIParser.validate(options.spec);
+  const validation = await validate(options.spec);
+
+  if (!validation.valid) {
+    throw Object.assign(new TypeError('Supplied schema is not a valid OpenAPI definition.'), validation);
+  }
+
+  const spec = await parse(options.spec);
 
   const version = spec.openapi ?? spec.swagger;
   const majorVersion = Number(version?.split?.('.')[0]);
 
   if (isNaN(majorVersion) || majorVersion < 3 || majorVersion >= 4) {
-    throw new TypeError(`Unsupported OpenAPI version: ${version ?? 'unknown'}`);
+    throw new TypeError(`Unsupported OpenAPI version: '${version ?? 'unknown'}'.`);
   }
 
   return spec;

package/src/parser/spec.test.js

@@ -3,9 +3,9 @@ import { validateSpec } from './spec.js';
 
 describe('validateSpec()', () => {
   it('should throw for invalid options', async () => {
-    await expect(validateSpec({})).rejects.toThrowError('Expected a file path, URL, or object.');
-    await expect(validateSpec({ spec: { foo: 'bar' } })).rejects.toThrowError(
-      'Supplied schema is not a valid OpenAPI definition.'
+    await expect(validateSpec({})).rejects.toThrow('Expected a file path, URL, or object.');
+    await expect(validateSpec({ spec: { foo: 'bar' } })).rejects.toThrow(
+      'Supplied schema is not a valid OpenAPI definition'
     );
   });
 
@@ -18,20 +18,8 @@ describe('validateSpec()', () => {
       paths: {},
       swagger: '2.0'
     };
-    const specOpenApi2 = {
-      info: {},
-      openapi: '2.0.0',
-      paths: {}
-    };
-    const specOpenApi4 = {
-      info: {},
-      openapi: '4.0.0',
-      paths: {}
-    };
 
-    await expect(validateSpec({ spec: specSwagger2 })).rejects.toThrowError(/Unsupported OpenAPI version: 2\.0/);
-    await expect(validateSpec({ spec: specOpenApi2 })).rejects.toThrowError(/Unsupported OpenAPI version: 2\.0\.0/);
-    await expect(validateSpec({ spec: specOpenApi4 })).rejects.toThrowError(/Unsupported OpenAPI version: 4\.0\.0/);
+    await expect(validateSpec({ spec: specSwagger2 })).rejects.toThrow(/Unsupported OpenAPI version: '2\.0'\./);
   });
 
   it('should return a parsed spec', async () => {
@@ -41,7 +29,17 @@ describe('validateSpec()', () => {
         version: '1'
       },
       openapi: '3.1.0',
-      paths: {}
+      paths: {
+        '/pet': {
+          get: {
+            responses: {
+              200: {
+                description: 'successful operation'
+              }
+            }
+          }
+        }
+      }
     };
 
     expect(await validateSpec({ spec })).toMatchObject(spec);
@@ -49,6 +47,11 @@ describe('validateSpec()', () => {
 
   it("should resolve '$ref' in spec", async () => {
     const Pet = {
+      properties: {
+        name: {
+          type: 'string'
+        }
+      },
       type: 'object'
     };
     const spec = {