@rotorsoft/act-http 1.8.7 → 1.8.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (14) hide show
  1. package/README.md +1 -1
  2. package/dist/.tsbuildinfo +1 -1
  3. package/dist/@types/openapi/index.d.ts +3 -2
  4. package/dist/@types/openapi/index.d.ts.map +1 -1
  5. package/dist/@types/trpc/index.d.ts.map +1 -1
  6. package/dist/openapi/index.cjs +5 -2
  7. package/dist/openapi/index.cjs.map +1 -1
  8. package/dist/openapi/index.js +5 -2
  9. package/dist/openapi/index.js.map +1 -1
  10. package/dist/trpc/index.cjs +10 -1
  11. package/dist/trpc/index.cjs.map +1 -1
  12. package/dist/trpc/index.js +10 -1
  13. package/dist/trpc/index.js.map +1 -1
  14. package/package.json +2 -2
package/README.md CHANGED
@@ -378,7 +378,7 @@ Auto-generated REST surface for the act-http-api epic (#835).
378
378
  OpenAPI 3.1 document emitter for the act-http-api epic (#835).
379
379
 
380
380
  - **`openapi(app, options) → OpenAPIDocument`** — generator function. Walks `app.registry.actions` once and returns a valid OpenAPI 3.1 document object. Each action becomes a `POST <basePath>/actions/<actionName>` operation; the request-body schema comes from Zod 4's `z.toJSONSchema` against the action's registered schema. Error responses reference the shared `#/components/responses/ApiError`. Output is pure data — serve as `/openapi.json`, write to disk during CI, pipe to client codegen.
381
- - **`OpenAPIOptions`** — `{ info, servers?, basePath?, idempotency?, expectedVersion? }`. `info.title` and `info.version` are required non-empty strings. `servers[].url` may contain `{variable}` template syntax; bare URLs are validated through `URL`'s parser. `basePath` defaults to `/api` (mirrors the Hono sibling). `idempotency` and `expectedVersion` are booleans (default `false`); when `true`, every mutation operation documents the corresponding optional header (`Idempotency-Key` / `If-Match`).
381
+ - **`OpenAPIOptions`** — `{ info, servers?, basePath?, idempotency?, expectedVersion? }`. `info.title` and `info.version` are required non-empty strings. `servers[].url` may contain `{variable}` template syntax; bare URLs are validated through `URL`'s parser. `basePath` defaults to `/api` (mirrors the Hono sibling). `idempotency` and `expectedVersion` are booleans (default `false`); when `true`, every mutation operation documents the corresponding header — `Idempotency-Key` is marked **required** (the route 400s without it), `If-Match` is optional.
382
382
  - **`OpenAPIDocument`** + a structural subset of the OpenAPI 3.1 types (`OpenAPIInfo`, `OpenAPIServer`, `OpenAPIPathItem`, `OpenAPIOperation`, `OpenAPIParameter`, `OpenAPIRequestBody`, `OpenAPIResponse`, `OpenAPIComponents`). Intentionally lighter than the full `openapi-types` package so post-processing doesn't fight the type system; cast to a fuller type when downstream consumers need it.
383
383
 
384
384
  ### `/sse` subpath