Skip to content

Releases: blomqma/next-rest-framework

v5.1.3

14 Feb 21:30
Compare
Choose a tag to compare
v5.1.3 Pre-release
Pre-release

Fixed

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

v5.1.2

14 Feb 21:09
Compare
Choose a tag to compare
v5.1.2 Pre-release
Pre-release

Fixed

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

v5.1.1

14 Feb 20:56
Compare
Choose a tag to compare
v5.1.1 Pre-release
Pre-release

Fixed

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

v5.1.0

13 Feb 23:46
Compare
Choose a tag to compare
v5.1.0 Pre-release
Pre-release

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.

v5.0.1

01 Feb 17:39
Compare
Choose a tag to compare
v5.0.1 Pre-release
Pre-release

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.

v5.0.0

29 Jan 19:56
Compare
Choose a tag to compare
v5.0.0 Pre-release
Pre-release

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.

v4.3.0

09 Jan 22:25
Compare
Choose a tag to compare
v4.3.0 Pre-release
Pre-release

4.3.0 - 2024-01-10

Changed

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

v4.2.0

08 Jan 22:11
Compare
Choose a tag to compare
v4.2.0 Pre-release
Pre-release

Added

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

v4.1.2

18 Dec 17:57
Compare
Choose a tag to compare
v4.1.2 Pre-release
Pre-release

Fixed

  • Fix typings for optional additional OpenAPI properties that are merged with the generated document.

v4.1.1

18 Dec 17:41
Compare
Choose a tag to compare
v4.1.1 Pre-release
Pre-release

Fixed

  • Fix RPC data structure to merge in CLI commands.

Thanks to @roothybrid7 for the fix!