@orkestrel/middleware 0.0.3 → 0.0.5

package/README.md

@@ -22,10 +22,28 @@ npm install @orkestrel/middleware @orkestrel/server
 - ESM core (`.`); a CJS node face (`./server`) for the node-bound batteries
   (`createStatic`, `createMultipart`)
 
-## Status
+## Usage
 
-The public API is defined in `PROPOSAL.md` and not yet implemented — this
-package currently ships no runtime code.
+```ts
+import { createBoundary, createSecurity } from '@orkestrel/middleware'
+import type { IdentifierState } from '@orkestrel/middleware'
+import { compose } from '@orkestrel/server'
+
+interface State extends IdentifierState {}
+
+const boundary = createBoundary({ expose: false })
+const security = createSecurity({ hsts: true })
+
+const handle = compose<State>([boundary, security], async (_request, context) => {
+	return Response.json({ identifier: context.state.identifier })
+})
+```
+
+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.
 
 ## Guides
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@orkestrel/middleware",
-	"version": "0.0.3",
+	"version": "0.0.5",
 	"description": "Batteries for the @orkestrel/server middleware seam — boundary, telemetry, compression, security, CORS, rate limiting, sessions, CSRF, static files, and multipart uploads as typed factories. Part of the @orkestrel line.",
 	"keywords": [
 		"compression",
@@ -61,7 +61,7 @@
 		"copy": "node -e \"const fs=require('node:fs'),p=require('node:path'),a=process.argv[1],b=process.argv[2];fs.mkdirSync(p.dirname(b),{recursive:true});fs.cpSync(a,b,{force:true});console.log('Copied: '+a+' to '+b)\"",
 		"tmp:txt": "node -e \"const fs=require('node:fs'),p=require('node:path');function walk(d){for(const e of fs.readdirSync(d,{withFileTypes:true})){const f=p.join(d,e.name);if(e.isDirectory()){walk(f)}else if(!e.name.endsWith('.md')&&!e.name.endsWith('.txt')){const t=f+'.txt';if(!fs.existsSync(t)){fs.renameSync(f,t)}else{console.warn('Skipping '+f+' — target exists: '+t)}}}}try{walk('tmp')}catch(e){if(e.code!=='ENOENT')throw e}\"",
 		"lint": "oxlint --config .oxlintrc.json --fix .",
-		"check": "tsc --noEmit --project tsconfig.json",
+		"check": "tsc --noEmit --project tsconfig.json && npm run check:src",
 		"check:src": "npm run check:src:core && npm run check:src:server",
 		"check:src:core": "tsc --noEmit -p configs/src/tsconfig.core.json",
 		"check:src:server": "tsc --noEmit -p configs/src/tsconfig.server.json",
@@ -77,20 +77,20 @@
 		"build:src": "npm run build:src:core && npm run build:src:server",
 		"build:src:core": "vite build --config configs/src/vite.core.config.ts && npm run copy dist/src/core/index.d.ts dist/src/core/index.d.cts",
 		"build:src:server": "vite build --config configs/src/vite.server.config.ts && npm run copy dist/src/server/index.d.ts dist/src/server/index.d.cts",
-		"prepublishOnly": "npm run format:check && npm run lint:check && npm run check && npm run check:src && npm run build && npm test"
+		"prepublishOnly": "npm run format:check && npm run lint:check && npm run check && npm run build && npm test"
 	},
 	"dependencies": {
-		"@orkestrel/abort": "^0.0.1",
-		"@orkestrel/budget": "^0.0.1",
-		"@orkestrel/contract": "^0.0.1",
-		"@orkestrel/timeout": "^0.0.1"
+		"@orkestrel/abort": "^0.0.3",
+		"@orkestrel/budget": "^0.0.3",
+		"@orkestrel/contract": "^0.0.5",
+		"@orkestrel/timeout": "^0.0.3"
 	},
 	"devDependencies": {
-		"@microsoft/api-extractor": "^7.58.10",
-		"@orkestrel/database": "^0.0.3",
-		"@orkestrel/guide": "^0.0.1",
-		"@orkestrel/router": "^0.0.2",
-		"@orkestrel/server": "^0.0.4",
+		"@microsoft/api-extractor": "^7.58.11",
+		"@orkestrel/database": "^0.0.5",
+		"@orkestrel/guide": "^0.0.5",
+		"@orkestrel/router": "^0.0.4",
+		"@orkestrel/server": "^0.0.6",
 		"@types/node": "^26.1.1",
 		"@vitest/browser-playwright": "^4.1.10",
 		"oxfmt": "^0.59.0",
@@ -101,8 +101,8 @@
 		"vitest": "^4.1.10"
 	},
 	"peerDependencies": {
-		"@orkestrel/database": "^0.0.3",
-		"@orkestrel/server": "^0.0.4"
+		"@orkestrel/database": "^0.0.5",
+		"@orkestrel/server": "^0.0.6"
 	},
 	"peerDependenciesMeta": {
 		"@orkestrel/database": {
@@ -110,6 +110,6 @@
 		}
 	},
 	"engines": {
-		"node": ">=24"
+		"node": ">=22"
 	}
 }