@orkestrel/middleware 0.0.18 → 0.0.20

package/README.md

@@ -1,12 +1,19 @@
 # @orkestrel/middleware
 
-Batteries for the `@orkestrel/server` middleware seam — the frozen
-`MiddlewareHandler<TState>` / `compose` contract and its substrate ship
-policy-free; this package supplies the policies the server deliberately does
-not: boundary rendering, telemetry, compression, security headers, CORS,
-deadlines, trusted-proxy client facts, ETag, bearer auth, rate limiting, body
-parsing, sessions, CSRF, static files, and multipart uploads — each a typed
-`options => MiddlewareHandler<TState>` factory over the shipped seam.
+> Batteries for the `@orkestrel/server` middleware seam:
+> `create{Noun}(options) => MiddlewareHandler<TState>` factories for error
+> boundaries, telemetry, compression, security headers, CORS, deadlines,
+> trusted-proxy client facts, ETag, bearer authentication, rate limiting, body
+> parsing, sessions, and CSRF in the fetch-native core, plus in-memory assets,
+> static files, streaming multipart uploads, and a `node:zlib` compression
+> sibling in the node face.
+
+Mount the batteries your threat model needs over the `compose` seam: each one
+closes over its guarded options and returns a `MiddlewareHandler<TState>`, and
+its position in the chain decides what it can see. Read
+[`guides/middleware.md`](guides/middleware.md) for the ordering doctrine and
+the security acceptance bar before you fix an order. Part of the `@orkestrel`
+line.
 
 ## Install
 
@@ -16,11 +23,11 @@ npm install @orkestrel/middleware @orkestrel/server
 
 ## Requirements
 
-- Node.js >= 24
+- Node.js >= 22.12.0
 - `@orkestrel/server` as a peer dependency (the seam and substrate are
   imported, never bundled)
-- ESM core (`.`); a CJS node face (`./server`) for the node-bound batteries
-  (`createStatic`, `createMultipart`)
+- Dual ESM and CommonJS entries: the core (`.`) and the node face (`./server`),
+  which carries the node-bound batteries
 
 ## Usage
 
@@ -40,15 +47,13 @@ const handle = compose<State>([boundary, security], async (_request, context) =>
 ```
 
 Each battery is a typed `options => MiddlewareHandler<TState>` factory that composes with
-the others through the frozen `@orkestrel/server` seam — mount boundary, telemetry,
-compression, security headers, CORS, rate limiting, sessions (with `MemorySessionStore` or
-`DatabaseSessionStore` over `@orkestrel/database`), CSRF, static files, and multipart uploads
-in any combination, scoped with `only()` / `except()` where needed.
+the others through the frozen `@orkestrel/server` seam, in any combination, scoped with
+`only()` and `except()` where needed.
 
 ## Guides
 
 See [`guides/README.md`](./guides/README.md) for the concept and dependency
-index; the full battery-by-battery surface docs land in `guides/src/middleware.md`
+index; the full battery-by-battery surface docs land in `guides/middleware.md`
 alongside the implementation.
 
 ## License