Rename module and main entrypoint API

Author: dacharyc

LICENSE

@@ -1,6 +1,7 @@
 MIT License
 
-Copyright (c) openapi-library
+Copyright (c) 2025 OASprey Contributors
+Copyright (c) 2019-2022 openapi-library (original OpenAPIValidators)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,4 +1,4 @@
-# OpenAPI Validators
+# OASprey
 
 Use Jest to assert that HTTP responses satisfy an OpenAPI spec.
 
@@ -9,7 +9,7 @@ to correct your server, your documentation, or both. The sooner you know the bet
 
 ## Solution 😄
 
-This plugin lets you automatically test whether your server's behaviour and
+This plugin lets you automatically test whether your server's behavior and
 documentation match. It adds Jest matchers that support the
 [OpenAPI standard](https://swagger.io/docs/specification/about/) for
 documenting REST APIs. In your JavaScript tests, you can simply assert
@@ -32,27 +32,31 @@ Features:
 [npm](http://npmjs.org)
 
 ```bash
-npm install --save-dev jest-openapi
+npm install --save-dev oasprey
 ```
 
 [yarn](https://yarnpkg.com/)
 
 ```bash
-yarn add --dev jest-openapi
+yarn add --dev oasprey
 ```
 
 ## Importing
 
 ES6 / TypeScript
 
 ```typescript
-import jestOpenAPI from 'jest-openapi';
+import { loadSpec } from 'oasprey';
+// or
+import loadSpec from 'oasprey';
 ```
 
 CommonJS / JavaScript
 
 ```javascript
-const jestOpenAPI = require('jest-openapi').default;
+const { loadSpec } = require('oasprey');
+// or
+const loadSpec = require('oasprey').default;
 ```
 
 ## Usage
@@ -63,10 +67,10 @@ const jestOpenAPI = require('jest-openapi').default;
 
 ```javascript
 // Import this plugin
-import jestOpenAPI from 'jest-openapi';
+import { loadSpec } from 'oasprey';
 
 // Load an OpenAPI file (YAML or JSON) into this plugin
-jestOpenAPI('path/to/openapi.yml');
+loadSpec('path/to/openapi.yml');
 
 // Write your test
 describe('GET /example/endpoint', () => {
@@ -173,11 +177,11 @@ The '200' response defined for endpoint 'GET /example/endpoint' in API spec: {
 
 ```javascript
 // Import this plugin and the function you want to test
-import jestOpenAPI from 'jest-openapi';
+import { loadSpec } from 'oasprey';
 import { functionToTest } from 'path/to/your/code';
 
 // Load an OpenAPI file (YAML or JSON) into this plugin
-jestOpenAPI('path/to/openapi.yml');
+loadSpec('path/to/openapi.yml');
 
 // Write your test
 describe('functionToTest()', () => {
@@ -281,7 +285,7 @@ The 'ExampleSchemaObject' schema in API spec: {
 
 ```javascript
 // Import this plugin
-import jestOpenAPI from 'jest-openapi';
+import { loadSpec } from 'oasprey';
 
 // Get an object representing your OpenAPI spec
 const openApiSpec = {
@@ -311,7 +315,7 @@ const openApiSpec = {
 };
 
 // Load that OpenAPI object into this plugin
-jestOpenAPI(openApiSpec);
+loadSpec(openApiSpec);
 
 // Write your test
 describe('GET /example/endpoint', () => {
@@ -331,7 +335,7 @@ describe('GET /example/endpoint', () => {
 
 ```javascript
 // Import this plugin and an HTTP client (e.g. axios)
-import jestOpenAPI from 'jest-openapi';
+import { loadSpec } from 'oasprey';
 import axios from 'axios';
 
 // Write your test
@@ -340,7 +344,7 @@ describe('GET /example/endpoint', () => {
   beforeAll(async () => {
     const response = await axios.get('url/to/openapi/spec');
     const openApiSpec = response.data; // e.g. { openapi: '3.0.0', ... };
-    jestOpenAPI(openApiSpec);
+    loadSpec(openApiSpec);
   });
 
   it('should satisfy OpenAPI spec', async () => {
@@ -357,11 +361,13 @@ describe('GET /example/endpoint', () => {
 
 ## Origin and Changes
 
-This package is forked from [OpenAPIValidators](https://github.com/openapi-library/OpenAPIValidators).
+This package is a hard fork from [OpenAPIValidators](https://github.com/openapi-library/OpenAPIValidators).
 We have:
 
 - Updated and removed dependencies to modern, supported tooling
 - Removed support for Chai and SuperAgent
+- Renamed the package to OASprey for ongoing maintenance
+- Renamed the `jestOpenAPI()` function to `loadSpec()`
 
 Otherwise, we have preserved the original functionality as-is. All credit to
 the folks who contributed to that package!

jest.config.cjs

@@ -2,7 +2,7 @@ module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
   moduleNameMapper: {
-    '^jest-openapi$': '<rootDir>/src/jest-openapi',
+    '^oasprey$': '<rootDir>/src/oasprey',
   },
   transform: {
     '^.+\\.(ts|tsx)$': ['ts-jest', { tsconfig: 'tsconfig.json' }],

package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "private": true,
-  "name": "jest-openapi",
+  "name": "oasprey",
   "main": "dist/index.js",
   "files": [
     "dist/",

src/index.ts

@@ -1 +1 @@
-export { default } from './jest-openapi/index.js';
+export { default, loadSpec } from './oasprey/index.js';

src/jest-openapi/index.ts src/oasprey/index.tssrc/jest-openapi/index.ts renamed to src/oasprey/index.ts

@@ -8,19 +8,19 @@ declare global {
     interface Matchers<R> {
       /**
        * Check the HTTP response object satisfies a response defined in your OpenAPI spec.
-       * [See usage example](https://github.com/openapi-library/OpenAPIValidators/tree/master/packages/jest-openapi#in-api-tests-validate-the-status-and-body-of-http-responses-against-your-openapi-spec)
+       * [See usage example](https://github.com/dachary-carey/OASprey#in-api-tests-validate-the-status-and-body-of-http-responses-against-your-openapi-spec)
        */
       toSatisfyApiSpec(): R;
       /**
        * Check the object satisfies a schema defined in your OpenAPI spec.
-       * [See usage example](https://github.com/openapi-library/OpenAPIValidators/tree/master/packages/jest-openapi#in-unit-tests-validate-objects-against-schemas-defined-in-your-openapi-spec)
+       * [See usage example](https://github.com/dachary-carey/OASprey#in-unit-tests-validate-objects-against-schemas-defined-in-your-openapi-spec)
        */
       toSatisfySchemaInApiSpec(schemaName: string): R;
     }
   }
 }
 
-export default function (filepathOrObject: string | OpenAPISpecObject): void {
+export function loadSpec(filepathOrObject: string | OpenAPISpecObject): void {
   const openApiSpec = makeApiSpec(filepathOrObject);
 
   const jestMatchers: jest.ExpectExtendMap = {
@@ -47,10 +47,13 @@ export default function (filepathOrObject: string | OpenAPISpecObject): void {
     console.error(
       [
         "Unable to find Jest's global expect.",
-        'Please check you have configured jest-openapi correctly.',
-        'See https://github.com/openapi-library/OpenAPIValidators/tree/master/packages/jest-openapi#usage for help.',
+        'Please check you have configured OASprey correctly.',
+        'See https://github.com/dachary-carey/OASprey#usage for help.',
       ].join('\n'),
     );
   }
   /* istanbul ignore next */
 }
+
+// Export as both named export and default export for flexibility
+export default loadSpec;

…est-openapi/matchers/toSatisfyApiSpec.ts src/oasprey/matchers/toSatisfyApiSpec.tssrc/jest-openapi/matchers/toSatisfyApiSpec.ts renamed to src/oasprey/matchers/toSatisfyApiSpec.ts src/jest-openapi/matchers/toSatisfyApiSpec.ts renamed to src/oasprey/matchers/toSatisfyApiSpec.ts

@@ -1,7 +1,7 @@
 import path from 'path';
 import { inspect } from 'util';
 
-import jestOpenAPI from '../../src/jest-openapi';
+import { loadSpec } from '../../src/oasprey';
 
 const dirContainingApiSpec = path.resolve(
   path.resolve(
@@ -13,7 +13,7 @@ const dirContainingApiSpec = path.resolve(
 describe('recreate bug (issue #XX)', () => {
   beforeAll(() => {
     const pathToApiSpec = path.join(dirContainingApiSpec, 'openapi.yml');
-    jestOpenAPI(pathToApiSpec);
+    loadSpec(pathToApiSpec);
   });
 
   const res = {