Skip to main content
Changes to @wolfstar/plugin-api. For the weekly summary across all packages, see the changelog overview.

2.2.0 (2026-10-20)

New features

  • Own stars.config key — The module sets meta.configKey, so you can write its options under the top-level api key of stars.config instead of the [specifier, options] tuple of modules. The tuple still works and is merged over the key. The key is typed in defineConfig once the module is imported in stars.config.ts. (#259)

Updates

  • New optional peer — @wolfstar/schema (^0.9.0) is a new optional peer that carries the StarsConfig type the keys extend.

Migration

  • @wolfstar/kit peer raised — The @wolfstar/kit peer range moves from ^0.1.0 to ^0.2.0, the first version that reads configKey. If your project uses @wolfstar/kit 0.1, update it.

2.1.1 (2026-10-08)

Updates

  • Dependencies — Updated third-party dependencies.

2.1.0 (2026-10-05)

New features

  • /module and /plugin entrypoints — Adds @wolfstar/plugin-api/module and @wolfstar/plugin-api/plugin. List the module in modules in stars.config, or pass the definePlugin factory to plugins. Both need @wolfstar/http-framework 6.1 (and @wolfstar/kit for the module). ./register is unchanged and still supports framework v3, v5, and v6. (#194)

2.0.1 (2026-10-04)

Updates

  • http-framework 6 support — The peer range now accepts @wolfstar/http-framework ^6.0.0. (#176)
  • Dependencies — Updated third-party dependencies.

Bug fixes

  • Dependencies — Updated cookie-es to v3. (#180)
  • Peer range — Accept @wolfstar/http-framework v6 in the peer range (|| ^6.0.0). (#176)

2.0.0 (2026-10-01)

New features

  • Sapphire 8.3.1 parity — The plugin now matches @sapphire/plugin-api 8.3.1, except for authentication. Added: CookieStore and the cookies middleware, body readers (readBody*, readValidatedBody*, asWeb), the full ApiResponse helper set, ServerOptions.prefix, per-route maximumBodyLength, the MiddlewareSuccess/MiddlewareFailure events, full router (RouterBranch/RouterNode) parity, HttpCodes, and a version export. (#161)

Updates

  • Renames — ApiServer is renamed Server, ApiServerOptions/ApiServerEvents/ApiServerEvent are ServerOptions/ServerEvents/ServerEvent, ApiPlugin is Api, and HttpMethod is MethodName.
  • Response helpers — Use response.status(code).json(data) instead of json(data, code).
  • Body reading — readBodyJson() returns unknown and takes its limit from maximumBodyLength.
  • Query object — request.query is a plain record.
  • Route matching — A route with no methods now answers 404 instead of defaulting to GET, and OPTIONS answers 200 with an empty body instead of 204.
  • Listener pieces — Listener piece names are PascalCase.
  • Node version — Requires Node.js >=20.18.1.

Bug fixes

  • Router path, route removal, and supportedMethods bugs inherited from upstream are fixed.
  • Server#connect() now rejects instead of throwing uncaught when the port is in use.
  • Malformed Cookie headers no longer crash parsing.

Migration

  • Replace ApiServer with Server, ApiServerOptions with ServerOptions, ApiServerEvents with ServerEvents, ApiServerEvent with ServerEvent, ApiPlugin with Api, and HttpMethod with MethodName.
  • Replace json(data, code) with status(code).json(data).
  • Replace readBodyJson<Shape> with readBodyJson() returning unknown.
  • Ensure Node.js is >=20.18.1.

1.1.7

Bug fixes

  • Peer dependency — Accept @wolfstar/http-framework v5 as a peer dependency (^3.0.0 || ^5.0.0), so v5 projects no longer install the plugin with an unmet peer. (#125)

1.1.6

Updates

  • Dependencies — Updated all non-major dependencies. (#75)

1.1.5

Updates

  • Type validation — Validate every published subpath export with are-the-types-wrong, not just the main entrypoint. createTsdownOptions hardcoded attw.entrypoints to ["."], so the ./register export of each package shipped unchecked. It now accepts an attwEntrypoints option, and all packages list their real entrypoints. (#70)

1.1.4

Updates

  • Dependencies — Updated all non-major dependencies. (#47)

1.1.3

Updates

  • Dependencies — Updated all non-major dependencies. (#26)

1.1.2

Bug fixes

  • Repository URL — Fix repository URL in package.json to point to the plugins repository. (#13)

1.1.1

Updates

  • Republish — Republish after fixing the npm trusted-publishing configuration that prevented earlier releases from reaching the registry.

1.1.0

New features

  • New package — Add @wolfstar/plugin-api: standalone REST API server plugin for @wolfstar/http-framework with routes, middlewares, and router.