@orkestrel/middleware 0.0.1

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.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Orkestrel
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,38 @@
1
+ # @orkestrel/middleware
2
+
3
+ Batteries for the `@orkestrel/server` middleware seam — the frozen
4
+ `MiddlewareHandler<TState>` / `compose` contract and its substrate ship
5
+ policy-free; this package supplies the policies the server deliberately does
6
+ not: boundary rendering, telemetry, compression, security headers, CORS,
7
+ deadlines, trusted-proxy client facts, ETag, bearer auth, rate limiting, body
8
+ parsing, sessions, CSRF, static files, and multipart uploads — each a typed
9
+ `options => MiddlewareHandler<TState>` factory over the shipped seam.
10
+
11
+ ## Install
12
+
13
+ ```sh
14
+ npm install @orkestrel/middleware @orkestrel/server
15
+ ```
16
+
17
+ ## Requirements
18
+
19
+ - Node.js >= 24
20
+ - `@orkestrel/server` as a peer dependency (the seam and substrate are
21
+ imported, never bundled)
22
+ - ESM core (`.`); a CJS node face (`./server`) for the node-bound batteries
23
+ (`createStatic`, `createMultipart`)
24
+
25
+ ## Status
26
+
27
+ The public API is defined in `PROPOSAL.md` and not yet implemented — this
28
+ package currently ships no runtime code.
29
+
30
+ ## Guides
31
+
32
+ See [`guides/README.md`](./guides/README.md) for the concept and dependency
33
+ index; the full battery-by-battery surface docs land in `guides/src/middleware.md`
34
+ alongside the implementation.
35
+
36
+ ## License
37
+
38
+ MIT © [Orkestrel](https://github.com/orkestrel) — see [LICENSE](./LICENSE).