next-rest-framework - npm Package Versions

5.1.4 - 2024-02-24

5.1.4-beta.1 - 2024-02-20

Fixed

• Add ESBuild external packages option to prevent any dependencies from being bundled as part of the CLI commands.

5.1.3 - 2024-02-14

Fixed

• Fix __dirname not defined during next build with a custom ESBuild plugin.

5.1.2 - 2024-02-14

Fixed

• Remove all peer dependencies from the library causing a runtime import error.

5.1.1 - 2024-02-14

Fixed

• Fix runtime issue of Next.js modules not being imported correctly.

5.1.0 - 2024-02-14

Fixed

• Fix CLI commands not working on Windows due to incorrect file import URLs.
• Fix ESM bundling by defining next and zod as peer dependencies and exclude them from the bundle.
• Docs fixes.

Added

• Add support for custom OG meta tags in the Redoc/SwaggerUI documentation.

5.0.1 - 2024-02-01

Fixed

• Fix bug of CLI not working when explicit ESM is set in package.json.

Removed

• Remove unneeded tsConfigPath option from CLI commands that is no longer needed.

5.0.0 - 2024-01-29

TLDR: All Node.js API specific code is split into the CLI which is much more reliable now. Support for generating the OpenAPI spec automatically when running the development server is dropped and handled by the CLI command npx next-rest-framework generate instead.

Add Edge runtime compatibility

This is a major change that simplifies the OpenAPI sepc generation process, and adds Edge runtime support.

Removing development-server generation:

This change completely removes the automatic local OpenAPI spec generation when calling the documentation endpoint and leaves the spec generation completely for the CLI which is now much more reliable for the following reason:

Previously the file system based OpenAPI spec generation done by the CLI used the build output generated by Next.js in the .next folder. This was however suboptimal as there's no guarantee that the module structure won't change between Next.js versions, breaking the CLI. A new approach is that the CLI commands generate and validate now generate a temporary build folder called .next-rest-framework which is compiled using ESBuild which produces consistent output from the CLI. This temporary folder is used to gather the OpenAPI paths from the generated routes and api routes that works with all Next.js versions. This is also much faster than running next build every time with the CLI.

With this changes, all Node.js file system based API calls etc. are split do a different bundle so that the code also works in the Edge runtime.

Fixed:

• Fixed the ESM entry point causing NRF not being loaded as ESM.
• Fixed the possible return status codes from RPC routes to match the generated OpenAPI spec.

4.3.0 - 2024-01-10

Changed

• Build the code for both ESM and CJS outputs using tsup.

4.2.0 - 2024-01-09

Added

• Add support for chaining up to three middlewares together and sharing data between the middlewares.