@spfn/core 0.2.0-beta.8 → 0.3.0-beta.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 +1 -1
- package/README.md +444 -305
- package/dist/authz/index.d.ts +34 -0
- package/dist/authz/index.js +810 -0
- package/dist/authz/index.js.map +1 -0
- package/dist/{boss-DI1r4kTS.d.ts → boss-D16fO2oG.d.ts} +41 -1
- package/dist/cache/index.js +42 -30
- package/dist/cache/index.js.map +1 -1
- package/dist/codegen/index.d.ts +121 -13
- package/dist/codegen/index.js +212 -15
- package/dist/codegen/index.js.map +1 -1
- package/dist/config/index.d.ts +615 -6
- package/dist/config/index.js +124 -5
- package/dist/config/index.js.map +1 -1
- package/dist/contract/index.d.ts +220 -0
- package/dist/contract/index.js +558 -0
- package/dist/contract/index.js.map +1 -0
- package/dist/db/index.d.ts +528 -85
- package/dist/db/index.js +831 -122
- package/dist/db/index.js.map +1 -1
- package/dist/define-middleware-DfDP39Nq.d.ts +167 -0
- package/dist/env/index.d.ts +26 -2
- package/dist/env/index.js +15 -5
- package/dist/env/index.js.map +1 -1
- package/dist/env/loader.d.ts +26 -19
- package/dist/env/loader.js +32 -25
- package/dist/env/loader.js.map +1 -1
- package/dist/errors/index.d.ts +10 -0
- package/dist/errors/index.js +418 -5
- package/dist/errors/index.js.map +1 -1
- package/dist/event/index.d.ts +33 -3
- package/dist/event/index.js +24 -3
- package/dist/event/index.js.map +1 -1
- package/dist/event/sse/client.d.ts +42 -3
- package/dist/event/sse/client.js +128 -45
- package/dist/event/sse/client.js.map +1 -1
- package/dist/event/sse/index.d.ts +12 -5
- package/dist/event/sse/index.js +280 -32
- package/dist/event/sse/index.js.map +1 -1
- package/dist/event/ws/client.d.ts +59 -0
- package/dist/event/ws/client.js +273 -0
- package/dist/event/ws/client.js.map +1 -0
- package/dist/event/ws/index.d.ts +94 -0
- package/dist/event/ws/index.js +272 -0
- package/dist/event/ws/index.js.map +1 -0
- package/dist/job/index.d.ts +2 -2
- package/dist/job/index.js +155 -42
- package/dist/job/index.js.map +1 -1
- package/dist/logger/index.d.ts +5 -0
- package/dist/logger/index.js +14 -0
- package/dist/logger/index.js.map +1 -1
- package/dist/middleware/index.d.ts +347 -9
- package/dist/middleware/index.js +1462 -15
- package/dist/middleware/index.js.map +1 -1
- package/dist/nextjs/index.d.ts +2 -2
- package/dist/nextjs/index.js +42 -28
- package/dist/nextjs/index.js.map +1 -1
- package/dist/nextjs/server.d.ts +35 -51
- package/dist/nextjs/server.js +126 -60
- package/dist/nextjs/server.js.map +1 -1
- package/dist/ops/index.d.ts +107 -0
- package/dist/ops/index.js +476 -0
- package/dist/ops/index.js.map +1 -0
- package/dist/route/index.d.ts +8 -694
- package/dist/route/index.js +111 -22
- package/dist/route/index.js.map +1 -1
- package/dist/router-ukNdAZcN.d.ts +676 -0
- package/dist/security/index.d.ts +83 -0
- package/dist/security/index.js +173 -0
- package/dist/security/index.js.map +1 -0
- package/dist/server/index.d.ts +491 -22
- package/dist/server/index.js +1887 -308
- package/dist/server/index.js.map +1 -1
- package/dist/token-manager-BT5EnUAR.d.ts +278 -0
- package/dist/types-2AbaW4Ie.d.ts +205 -0
- package/dist/{types-BOPTApC2.d.ts → types-9oszaJqp.d.ts} +7 -2
- package/dist/types-Bvvig_tT.d.ts +115 -0
- package/dist/types-ZQODsBft.d.ts +282 -0
- package/package.json +244 -208
- package/dist/router-Di7ENoah.d.ts +0 -151
- package/dist/types-B-e_f2dQ.d.ts +0 -121
- package/docs/cache.md +0 -133
- package/docs/codegen.md +0 -74
- package/docs/database.md +0 -346
- package/docs/entity.md +0 -539
- package/docs/env.md +0 -477
- package/docs/errors.md +0 -319
- package/docs/event.md +0 -116
- package/docs/job.md +0 -131
- package/docs/logger.md +0 -108
- package/docs/middleware.md +0 -337
- package/docs/nextjs.md +0 -241
- package/docs/repository.md +0 -496
- package/docs/route.md +0 -497
- package/docs/server.md +0 -307
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
import { a as NamedMiddleware } from '../define-middleware-DfDP39Nq.js';
|
|
2
|
+
import { a as RouteDef, R as Router } from '../router-ukNdAZcN.js';
|
|
3
|
+
import { J as JsonSchema } from '../types-Bvvig_tT.js';
|
|
4
|
+
import { HttpMethod } from '../route/types.js';
|
|
5
|
+
import 'hono';
|
|
6
|
+
import '@sinclair/typebox';
|
|
7
|
+
import 'hono/utils/http-status';
|
|
8
|
+
|
|
9
|
+
/**
|
|
10
|
+
* Ops Router
|
|
11
|
+
*
|
|
12
|
+
* The structure half of SPFN's CLI-first operations surface. An app develops
|
|
13
|
+
* its own ops as ordinary routes — domain operations only that app can name —
|
|
14
|
+
* and this factory turns them into a mountable package router that:
|
|
15
|
+
*
|
|
16
|
+
* - enforces the `/_ops/` path prefix, so the surface is recognizable and an
|
|
17
|
+
* ops route can never shadow an app route;
|
|
18
|
+
* - injects the given auth middleware into every route, the manifest
|
|
19
|
+
* included, so an unauthenticated ops surface cannot be created by
|
|
20
|
+
* accident — there is no opt-out;
|
|
21
|
+
* - serves `GET /_ops/_manifest`, the self-description the `spfn ops` CLI
|
|
22
|
+
* discovers commands from.
|
|
23
|
+
*
|
|
24
|
+
* The auth middleware itself lives with the app's auth stack (`@spfn/auth`
|
|
25
|
+
* ships `opsTokenAuth`); core owns only the structure, so the ops surface has
|
|
26
|
+
* no opinion about how a token is stored or verified.
|
|
27
|
+
*
|
|
28
|
+
* @example
|
|
29
|
+
* ```ts
|
|
30
|
+
* import { createOpsRouter } from '@spfn/core/ops';
|
|
31
|
+
* import { opsTokenAuth, requireOpsScope } from '@spfn/auth/server';
|
|
32
|
+
*
|
|
33
|
+
* export const opsRouter = createOpsRouter({
|
|
34
|
+
* listSignups: route.get('/_ops/signups')
|
|
35
|
+
* .use([requireOpsScope('waitlist:read')])
|
|
36
|
+
* .handler(async () => signupsRepository.list()),
|
|
37
|
+
* }, { auth: opsTokenAuth });
|
|
38
|
+
*
|
|
39
|
+
* // mounted like any package router:
|
|
40
|
+
* export const appRouter = defineRouter({ ... }).packages([opsRouter]);
|
|
41
|
+
* ```
|
|
42
|
+
*/
|
|
43
|
+
|
|
44
|
+
/** Every ops route lives under this prefix. */
|
|
45
|
+
declare const OPS_PATH_PREFIX = "/_ops/";
|
|
46
|
+
/** Where the manifest is served. Reserved — an app route cannot claim it. */
|
|
47
|
+
declare const OPS_MANIFEST_PATH = "/_ops/_manifest";
|
|
48
|
+
interface OpsRouterOptions {
|
|
49
|
+
/**
|
|
50
|
+
* The middleware that authenticates every ops request. Required — an ops
|
|
51
|
+
* surface without authentication is refused at definition time, not
|
|
52
|
+
* discovered in production.
|
|
53
|
+
*/
|
|
54
|
+
auth: NamedMiddleware<string>;
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* Build the app's ops surface from its ops routes.
|
|
58
|
+
*
|
|
59
|
+
* Returns an ordinary `Router` meant to be mounted with `.packages()`, so ops
|
|
60
|
+
* routes stay out of the app's client types exactly like other package
|
|
61
|
+
* routes.
|
|
62
|
+
*/
|
|
63
|
+
declare function createOpsRouter<TRoutes extends Record<string, RouteDef<any, any, any> | Router<any>>>(routes: TRoutes, options: OpsRouterOptions): Router<any>;
|
|
64
|
+
|
|
65
|
+
/**
|
|
66
|
+
* Ops Manifest
|
|
67
|
+
*
|
|
68
|
+
* The server's self-description of its ops surface: every command an app
|
|
69
|
+
* exposes under `/_ops`, with each command's input schemas as plain JSON
|
|
70
|
+
* Schema. The ops CLI fetches this from the running server, so command
|
|
71
|
+
* discovery needs neither the app's source nor a generated artifact on the
|
|
72
|
+
* operator's machine.
|
|
73
|
+
*
|
|
74
|
+
* The router is loaded and walked (the contract collector's approach) rather
|
|
75
|
+
* than parsed from source: route schemas built from imported values resolve,
|
|
76
|
+
* and TypeBox schemas serialize to JSON Schema by construction.
|
|
77
|
+
*/
|
|
78
|
+
|
|
79
|
+
/** One invokable ops command, as the CLI sees it. */
|
|
80
|
+
interface OpsCommand {
|
|
81
|
+
name: string;
|
|
82
|
+
method: HttpMethod;
|
|
83
|
+
path: string;
|
|
84
|
+
/** Input sections the route declares, each as JSON Schema. */
|
|
85
|
+
input: {
|
|
86
|
+
params?: JsonSchema;
|
|
87
|
+
query?: JsonSchema;
|
|
88
|
+
body?: JsonSchema;
|
|
89
|
+
};
|
|
90
|
+
}
|
|
91
|
+
/** What `GET /_ops/_manifest` answers. */
|
|
92
|
+
interface OpsManifest {
|
|
93
|
+
manifestVersion: 1;
|
|
94
|
+
commands: OpsCommand[];
|
|
95
|
+
}
|
|
96
|
+
/** Thrown when a route cannot be part of an ops surface. */
|
|
97
|
+
declare class OpsRouterError extends Error {
|
|
98
|
+
constructor(message: string);
|
|
99
|
+
}
|
|
100
|
+
/**
|
|
101
|
+
* Walk a routes record (nested routers included) and collect every RouteDef
|
|
102
|
+
* as an ops command. Validation of paths and names happens in
|
|
103
|
+
* `createOpsRouter` before this runs.
|
|
104
|
+
*/
|
|
105
|
+
declare function collectOpsCommands(routes: Record<string, RouteDef<any> | Router<any>>): OpsCommand[];
|
|
106
|
+
|
|
107
|
+
export { OPS_MANIFEST_PATH, OPS_PATH_PREFIX, type OpsCommand, type OpsManifest, OpsRouterError, type OpsRouterOptions, collectOpsCommands, createOpsRouter };
|
|
@@ -0,0 +1,476 @@
|
|
|
1
|
+
// src/route/route-builder.ts
|
|
2
|
+
var RouteBuilder = class _RouteBuilder {
|
|
3
|
+
_method;
|
|
4
|
+
_path;
|
|
5
|
+
_input;
|
|
6
|
+
_interceptor;
|
|
7
|
+
_middlewares;
|
|
8
|
+
_skipMiddlewares;
|
|
9
|
+
_contract;
|
|
10
|
+
/**
|
|
11
|
+
* Create a new RouteBuilder with copied properties and optional overrides
|
|
12
|
+
*/
|
|
13
|
+
clone(overrides) {
|
|
14
|
+
const builder = new _RouteBuilder();
|
|
15
|
+
builder._method = this._method;
|
|
16
|
+
builder._path = this._path;
|
|
17
|
+
builder._input = overrides?.input ?? this._input;
|
|
18
|
+
builder._interceptor = overrides?.interceptor ?? this._interceptor;
|
|
19
|
+
builder._middlewares = overrides?.middlewares ?? this._middlewares;
|
|
20
|
+
builder._skipMiddlewares = overrides?.skipMiddlewares ?? this._skipMiddlewares;
|
|
21
|
+
builder._contract = overrides?.contract ?? this._contract;
|
|
22
|
+
return builder;
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* Define input schemas
|
|
26
|
+
*
|
|
27
|
+
* @example
|
|
28
|
+
* ```ts
|
|
29
|
+
* route.get('/users/:id')
|
|
30
|
+
* .input({
|
|
31
|
+
* params: Type.Object({ id: Type.String() }),
|
|
32
|
+
* query: Type.Object({ page: Type.Number() }),
|
|
33
|
+
* headers: Type.Object({ authorization: Type.String() })
|
|
34
|
+
* })
|
|
35
|
+
* .handler(async (c) => {
|
|
36
|
+
* const { params, query, headers } = await c.data();
|
|
37
|
+
* // params = { id: string }
|
|
38
|
+
* // query = { page: number }
|
|
39
|
+
* // headers = { authorization: string }
|
|
40
|
+
* })
|
|
41
|
+
* ```
|
|
42
|
+
*/
|
|
43
|
+
input(input) {
|
|
44
|
+
return this.clone({ input });
|
|
45
|
+
}
|
|
46
|
+
/**
|
|
47
|
+
* Define fields injected by interceptors
|
|
48
|
+
*
|
|
49
|
+
* These fields are:
|
|
50
|
+
* - Available in the handler (merged with input)
|
|
51
|
+
* - Excluded from client types (codegen uses only input)
|
|
52
|
+
* - Not validated by route input schema (injected by middleware)
|
|
53
|
+
*
|
|
54
|
+
* Use this when middleware/interceptors add fields to the request
|
|
55
|
+
* before it reaches the handler.
|
|
56
|
+
*
|
|
57
|
+
* @example
|
|
58
|
+
* ```ts
|
|
59
|
+
* // Auth interceptor injects crypto key fields
|
|
60
|
+
* route.post('/_auth/login')
|
|
61
|
+
* .input({
|
|
62
|
+
* body: Type.Object({
|
|
63
|
+
* email: Type.String(),
|
|
64
|
+
* password: Type.String()
|
|
65
|
+
* })
|
|
66
|
+
* })
|
|
67
|
+
* .interceptor({
|
|
68
|
+
* body: Type.Object({
|
|
69
|
+
* publicKey: Type.String(),
|
|
70
|
+
* keyId: Type.String(),
|
|
71
|
+
* fingerprint: Type.String()
|
|
72
|
+
* })
|
|
73
|
+
* })
|
|
74
|
+
* .handler(async (c) => {
|
|
75
|
+
* const { body } = await c.data();
|
|
76
|
+
* // body type: { email, password, publicKey, keyId, fingerprint }
|
|
77
|
+
* // Client only sees: { email, password }
|
|
78
|
+
* return loginService(body);
|
|
79
|
+
* });
|
|
80
|
+
* ```
|
|
81
|
+
*/
|
|
82
|
+
interceptor(interceptor) {
|
|
83
|
+
return this.clone({ interceptor });
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* Add middlewares to the route
|
|
87
|
+
*
|
|
88
|
+
* Accepts both regular middleware handlers and named middlewares (NamedMiddleware).
|
|
89
|
+
* Named middlewares that are already registered globally will be automatically
|
|
90
|
+
* deduplicated to prevent double execution.
|
|
91
|
+
*
|
|
92
|
+
* @example
|
|
93
|
+
* ```ts
|
|
94
|
+
* import { authenticate } from '@spfn/auth/server/middleware';
|
|
95
|
+
*
|
|
96
|
+
* // With NamedMiddleware (auto-deduped if registered globally)
|
|
97
|
+
* route.get('/users')
|
|
98
|
+
* .use([authenticate, RateLimitMiddleware()])
|
|
99
|
+
*
|
|
100
|
+
* // With regular middleware handlers
|
|
101
|
+
* route.get('/users')
|
|
102
|
+
* .use([AuthMiddleware(), RateLimitMiddleware()])
|
|
103
|
+
* ```
|
|
104
|
+
*/
|
|
105
|
+
middleware(middlewares) {
|
|
106
|
+
return this.clone({ middlewares });
|
|
107
|
+
}
|
|
108
|
+
/**
|
|
109
|
+
* Add middlewares to the route (alias for `.middleware()`)
|
|
110
|
+
*
|
|
111
|
+
* Accepts both regular middleware handlers and named middlewares (NamedMiddleware).
|
|
112
|
+
* Named middlewares that are already registered globally will be automatically
|
|
113
|
+
* deduplicated to prevent double execution.
|
|
114
|
+
*
|
|
115
|
+
* @example
|
|
116
|
+
* ```ts
|
|
117
|
+
* import { authenticate } from '@spfn/auth/server/middleware';
|
|
118
|
+
*
|
|
119
|
+
* // With NamedMiddleware (auto-deduped if registered globally)
|
|
120
|
+
* route.get('/users')
|
|
121
|
+
* .use([authenticate, RateLimitMiddleware()])
|
|
122
|
+
*
|
|
123
|
+
* // With regular middleware handlers
|
|
124
|
+
* route.get('/users')
|
|
125
|
+
* .use([AuthMiddleware(), RateLimitMiddleware()])
|
|
126
|
+
* ```
|
|
127
|
+
*/
|
|
128
|
+
use(middlewares) {
|
|
129
|
+
return this.middleware(middlewares);
|
|
130
|
+
}
|
|
131
|
+
/**
|
|
132
|
+
* Skip server-level named middlewares
|
|
133
|
+
*
|
|
134
|
+
* Useful for public endpoints that should bypass auth or rate limiting
|
|
135
|
+
*
|
|
136
|
+
* @param middlewareNames - Array of middleware names to skip, or '*' to skip all
|
|
137
|
+
*
|
|
138
|
+
* @example
|
|
139
|
+
* ```ts
|
|
140
|
+
* // Skip specific middlewares
|
|
141
|
+
* route.get('/health')
|
|
142
|
+
* .skip(['auth', 'rateLimit'])
|
|
143
|
+
* .handler(async (c) => c.json({ status: 'ok' }));
|
|
144
|
+
*
|
|
145
|
+
* // Skip only auth (still apply rate limiting)
|
|
146
|
+
* route.get('/public-data')
|
|
147
|
+
* .skip(['auth'])
|
|
148
|
+
* .handler(async (c) => { ... });
|
|
149
|
+
*
|
|
150
|
+
* // Skip all middlewares
|
|
151
|
+
* route.get('/public-health')
|
|
152
|
+
* .skip('*')
|
|
153
|
+
* .handler(async (c) => c.json({ status: 'ok' }));
|
|
154
|
+
* ```
|
|
155
|
+
*/
|
|
156
|
+
skip(middlewareNames) {
|
|
157
|
+
return this.clone({ skipMiddlewares: middlewareNames });
|
|
158
|
+
}
|
|
159
|
+
/**
|
|
160
|
+
* Publish this route as a versioned contract operation
|
|
161
|
+
*
|
|
162
|
+
* Marks the route as a promise to clients that are compiled and deployed
|
|
163
|
+
* separately from the server — a mobile app, an external API consumer.
|
|
164
|
+
* The `@spfn/core:contract` generator writes every contracted route into
|
|
165
|
+
* `contracts/current.json`, and the build refuses a change that would break
|
|
166
|
+
* an already-released client.
|
|
167
|
+
*
|
|
168
|
+
* Routes without `.contract()` are unaffected: they simply do not appear in
|
|
169
|
+
* the contract. A web client needs nothing here — it derives its types from
|
|
170
|
+
* the router in the same build.
|
|
171
|
+
*
|
|
172
|
+
* @example
|
|
173
|
+
* ```ts
|
|
174
|
+
* export const getUser = route.get('/users/:id')
|
|
175
|
+
* .input({ params: Type.Object({ id: Type.String() }) })
|
|
176
|
+
* .contract({
|
|
177
|
+
* since: '1.2.0',
|
|
178
|
+
* auth: 'clientProofV1',
|
|
179
|
+
* requiresSession: true,
|
|
180
|
+
* response: Type.Object({
|
|
181
|
+
* id: Type.String(),
|
|
182
|
+
* name: Type.String(),
|
|
183
|
+
* email: Type.Optional(Type.String()),
|
|
184
|
+
* }),
|
|
185
|
+
* })
|
|
186
|
+
* .handler(async (c) => { ... });
|
|
187
|
+
* ```
|
|
188
|
+
*/
|
|
189
|
+
contract(contract) {
|
|
190
|
+
return this.clone({ contract });
|
|
191
|
+
}
|
|
192
|
+
/**
|
|
193
|
+
* Define handler function
|
|
194
|
+
*
|
|
195
|
+
* Response type is automatically inferred from the return value.
|
|
196
|
+
* Use helper methods like `c.created()`, `c.paginated()` for proper type inference.
|
|
197
|
+
*
|
|
198
|
+
* @example
|
|
199
|
+
* ```ts
|
|
200
|
+
* // Direct return - type inferred from data
|
|
201
|
+
* route.get('/users/:id')
|
|
202
|
+
* .input({ params: Type.Object({ id: Type.String() }) })
|
|
203
|
+
* .handler(async (c) => {
|
|
204
|
+
* const { params } = await c.data();
|
|
205
|
+
* return await getUser(params.id); // Type: User
|
|
206
|
+
* })
|
|
207
|
+
*
|
|
208
|
+
* // Using c.created() - returns data with 201 status, type preserved
|
|
209
|
+
* route.post('/users')
|
|
210
|
+
* .input({ body: Type.Object({ name: Type.String() }) })
|
|
211
|
+
* .handler(async (c) => {
|
|
212
|
+
* const { body } = await c.data();
|
|
213
|
+
* return c.created(await createUser(body)); // Type: User
|
|
214
|
+
* })
|
|
215
|
+
*
|
|
216
|
+
* // Using c.paginated() - returns PaginatedResult<T>
|
|
217
|
+
* route.get('/users')
|
|
218
|
+
* .handler(async (c) => {
|
|
219
|
+
* const users = await getUsers();
|
|
220
|
+
* return c.paginated(users, 1, 20, 100); // Type: PaginatedResult<User>
|
|
221
|
+
* })
|
|
222
|
+
*
|
|
223
|
+
* // Using c.noContent() - returns void
|
|
224
|
+
* route.delete('/users/:id')
|
|
225
|
+
* .handler(async (c) => {
|
|
226
|
+
* await deleteUser(params.id);
|
|
227
|
+
* return c.noContent(); // Type: void
|
|
228
|
+
* })
|
|
229
|
+
*
|
|
230
|
+
* // Using c.json() - returns Response (type inference lost)
|
|
231
|
+
* // Use only when you need custom status codes not covered by helpers
|
|
232
|
+
* route.get('/custom')
|
|
233
|
+
* .handler(async (c) => {
|
|
234
|
+
* return c.json({ data }, 418); // Type: Response
|
|
235
|
+
* })
|
|
236
|
+
* ```
|
|
237
|
+
*/
|
|
238
|
+
handler(fn) {
|
|
239
|
+
return {
|
|
240
|
+
method: this._method,
|
|
241
|
+
path: this._path,
|
|
242
|
+
input: this._input,
|
|
243
|
+
interceptor: this._interceptor,
|
|
244
|
+
middlewares: this._middlewares,
|
|
245
|
+
skipMiddlewares: this._skipMiddlewares,
|
|
246
|
+
contract: this._contract,
|
|
247
|
+
handler: fn,
|
|
248
|
+
_input: {},
|
|
249
|
+
_interceptor: {},
|
|
250
|
+
_response: {}
|
|
251
|
+
};
|
|
252
|
+
}
|
|
253
|
+
};
|
|
254
|
+
function createMethodRoute(method) {
|
|
255
|
+
return (path) => {
|
|
256
|
+
const builder = new RouteBuilder();
|
|
257
|
+
builder._method = method;
|
|
258
|
+
builder._path = path;
|
|
259
|
+
return builder;
|
|
260
|
+
};
|
|
261
|
+
}
|
|
262
|
+
var route = {
|
|
263
|
+
get: createMethodRoute("GET"),
|
|
264
|
+
post: createMethodRoute("POST"),
|
|
265
|
+
put: createMethodRoute("PUT"),
|
|
266
|
+
patch: createMethodRoute("PATCH"),
|
|
267
|
+
delete: createMethodRoute("DELETE")
|
|
268
|
+
};
|
|
269
|
+
|
|
270
|
+
// src/route/router.ts
|
|
271
|
+
function createRouterInstance(routes, packageRouters = [], globalMiddlewares = [], contractVersion = null) {
|
|
272
|
+
return {
|
|
273
|
+
routes,
|
|
274
|
+
_routes: routes,
|
|
275
|
+
_packageRouters: packageRouters,
|
|
276
|
+
_globalMiddlewares: globalMiddlewares,
|
|
277
|
+
_contractVersion: contractVersion,
|
|
278
|
+
packages(routers) {
|
|
279
|
+
const newPackageRouters = [...this._packageRouters, ...routers];
|
|
280
|
+
for (const pkgRouter of routers) {
|
|
281
|
+
if (pkgRouter._packageRouters?.length > 0) {
|
|
282
|
+
newPackageRouters.push(...pkgRouter._packageRouters);
|
|
283
|
+
}
|
|
284
|
+
}
|
|
285
|
+
return createRouterInstance(
|
|
286
|
+
this.routes,
|
|
287
|
+
newPackageRouters,
|
|
288
|
+
this._globalMiddlewares,
|
|
289
|
+
this._contractVersion
|
|
290
|
+
);
|
|
291
|
+
},
|
|
292
|
+
use(middlewares) {
|
|
293
|
+
return createRouterInstance(
|
|
294
|
+
this.routes,
|
|
295
|
+
this._packageRouters,
|
|
296
|
+
[...this._globalMiddlewares, ...middlewares],
|
|
297
|
+
this._contractVersion
|
|
298
|
+
);
|
|
299
|
+
},
|
|
300
|
+
contractVersion(version) {
|
|
301
|
+
assertContractVersion(version);
|
|
302
|
+
return createRouterInstance(
|
|
303
|
+
this.routes,
|
|
304
|
+
this._packageRouters,
|
|
305
|
+
this._globalMiddlewares,
|
|
306
|
+
version
|
|
307
|
+
);
|
|
308
|
+
}
|
|
309
|
+
};
|
|
310
|
+
}
|
|
311
|
+
function assertContractVersion(version) {
|
|
312
|
+
if (!/^\d+\.\d+\.\d+(?:[-+][0-9A-Za-z.-]+)*$/.test(version)) {
|
|
313
|
+
throw new Error(
|
|
314
|
+
`contractVersion("${version}") is not a version of the form major.minor.patch. The released snapshot is named from this value and releases are compared by it.`
|
|
315
|
+
);
|
|
316
|
+
}
|
|
317
|
+
}
|
|
318
|
+
function defineRouter(routes) {
|
|
319
|
+
return createRouterInstance(routes);
|
|
320
|
+
}
|
|
321
|
+
|
|
322
|
+
// src/ops/manifest.ts
|
|
323
|
+
var OpsRouterError = class extends Error {
|
|
324
|
+
constructor(message) {
|
|
325
|
+
super(message);
|
|
326
|
+
this.name = "OpsRouterError";
|
|
327
|
+
}
|
|
328
|
+
};
|
|
329
|
+
function isRouter(value) {
|
|
330
|
+
return value !== null && typeof value === "object" && "routes" in value && "_routes" in value;
|
|
331
|
+
}
|
|
332
|
+
function isRouteDef(value) {
|
|
333
|
+
return value !== null && typeof value === "object" && "handler" in value;
|
|
334
|
+
}
|
|
335
|
+
function toJsonSchema(schema) {
|
|
336
|
+
return JSON.parse(JSON.stringify(schema));
|
|
337
|
+
}
|
|
338
|
+
var INPUT_SECTIONS = ["params", "query", "body"];
|
|
339
|
+
function toCommandInput(input) {
|
|
340
|
+
const sections = {};
|
|
341
|
+
if (!input) {
|
|
342
|
+
return sections;
|
|
343
|
+
}
|
|
344
|
+
for (const section of INPUT_SECTIONS) {
|
|
345
|
+
const schema = input[section];
|
|
346
|
+
if (schema) {
|
|
347
|
+
sections[section] = toJsonSchema(schema);
|
|
348
|
+
}
|
|
349
|
+
}
|
|
350
|
+
return sections;
|
|
351
|
+
}
|
|
352
|
+
function collectOpsCommands(routes) {
|
|
353
|
+
const commands = [];
|
|
354
|
+
visit(routes, commands, /* @__PURE__ */ new Map());
|
|
355
|
+
commands.sort((a, b) => a.name < b.name ? -1 : a.name > b.name ? 1 : 0);
|
|
356
|
+
return commands;
|
|
357
|
+
}
|
|
358
|
+
function visit(routes, commands, claimed) {
|
|
359
|
+
for (const [name, entry] of Object.entries(routes)) {
|
|
360
|
+
if (isRouter(entry)) {
|
|
361
|
+
visit(entry.routes, commands, claimed);
|
|
362
|
+
continue;
|
|
363
|
+
}
|
|
364
|
+
if (!isRouteDef(entry) || !entry.method || !entry.path) {
|
|
365
|
+
continue;
|
|
366
|
+
}
|
|
367
|
+
assertUnclaimedName(name, entry.path, claimed);
|
|
368
|
+
commands.push({
|
|
369
|
+
name,
|
|
370
|
+
method: entry.method,
|
|
371
|
+
path: entry.path,
|
|
372
|
+
input: toCommandInput(entry.input)
|
|
373
|
+
});
|
|
374
|
+
}
|
|
375
|
+
}
|
|
376
|
+
function assertUnclaimedName(name, path, claimed) {
|
|
377
|
+
const existing = claimed.get(name);
|
|
378
|
+
if (existing !== void 0) {
|
|
379
|
+
throw new OpsRouterError(
|
|
380
|
+
`Two ops routes are named "${name}" ("${existing}" and "${path}"). Command names are flattened across nested routers, so each must be unique for the CLI to resolve the one an operator asked for.`
|
|
381
|
+
);
|
|
382
|
+
}
|
|
383
|
+
claimed.set(name, path);
|
|
384
|
+
}
|
|
385
|
+
|
|
386
|
+
// src/ops/create-ops-router.ts
|
|
387
|
+
var OPS_PATH_PREFIX = "/_ops/";
|
|
388
|
+
var OPS_MANIFEST_PATH = "/_ops/_manifest";
|
|
389
|
+
var OPS_MANIFEST_NAME = "getOpsManifest";
|
|
390
|
+
function isRouter2(value) {
|
|
391
|
+
return value !== null && typeof value === "object" && "routes" in value && "_routes" in value;
|
|
392
|
+
}
|
|
393
|
+
function isRouteDef2(value) {
|
|
394
|
+
return value !== null && typeof value === "object" && "handler" in value;
|
|
395
|
+
}
|
|
396
|
+
function assertOpsRoute(name, def) {
|
|
397
|
+
if (!def.method || !def.path) {
|
|
398
|
+
throw new OpsRouterError(
|
|
399
|
+
`Ops route "${name}" has no method or path. An ops command is invoked on the wire, so both are required.`
|
|
400
|
+
);
|
|
401
|
+
}
|
|
402
|
+
if (!def.path.startsWith(OPS_PATH_PREFIX)) {
|
|
403
|
+
throw new OpsRouterError(
|
|
404
|
+
`Ops route "${name}" is at "${def.path}", outside "${OPS_PATH_PREFIX}". Every ops route lives under the prefix so the surface stays recognizable and can never shadow an app route.`
|
|
405
|
+
);
|
|
406
|
+
}
|
|
407
|
+
if (def.path === OPS_MANIFEST_PATH) {
|
|
408
|
+
throw new OpsRouterError(
|
|
409
|
+
`Ops route "${name}" claims "${OPS_MANIFEST_PATH}", which is reserved for the manifest.`
|
|
410
|
+
);
|
|
411
|
+
}
|
|
412
|
+
}
|
|
413
|
+
function assertOpsName(name) {
|
|
414
|
+
if (name === OPS_MANIFEST_NAME) {
|
|
415
|
+
throw new OpsRouterError(
|
|
416
|
+
`Ops route name "${OPS_MANIFEST_NAME}" is reserved for the manifest route.`
|
|
417
|
+
);
|
|
418
|
+
}
|
|
419
|
+
}
|
|
420
|
+
function rebuildNestedRouter(name, router, auth) {
|
|
421
|
+
if (router._packageRouters?.length > 0) {
|
|
422
|
+
throw new OpsRouterError(
|
|
423
|
+
`Ops router "${name}" mounts package routers with .packages(). Their routes bypass the prefix check and the auth injection, so an ops surface cannot carry them.`
|
|
424
|
+
);
|
|
425
|
+
}
|
|
426
|
+
let rebuilt = defineRouter(
|
|
427
|
+
secureRoutes(router.routes, auth)
|
|
428
|
+
);
|
|
429
|
+
if (router._globalMiddlewares?.length > 0) {
|
|
430
|
+
rebuilt = rebuilt.use(router._globalMiddlewares);
|
|
431
|
+
}
|
|
432
|
+
if (router._contractVersion) {
|
|
433
|
+
rebuilt = rebuilt.contractVersion(router._contractVersion);
|
|
434
|
+
}
|
|
435
|
+
return rebuilt;
|
|
436
|
+
}
|
|
437
|
+
function secureRoutes(routes, auth) {
|
|
438
|
+
const secured = {};
|
|
439
|
+
for (const [name, entry] of Object.entries(routes)) {
|
|
440
|
+
assertOpsName(name);
|
|
441
|
+
if (isRouter2(entry)) {
|
|
442
|
+
secured[name] = rebuildNestedRouter(name, entry, auth);
|
|
443
|
+
continue;
|
|
444
|
+
}
|
|
445
|
+
if (!isRouteDef2(entry)) {
|
|
446
|
+
throw new OpsRouterError(`Ops router entry "${name}" is neither a route nor a router.`);
|
|
447
|
+
}
|
|
448
|
+
assertOpsRoute(name, entry);
|
|
449
|
+
secured[name] = {
|
|
450
|
+
...entry,
|
|
451
|
+
middlewares: [auth, ...entry.middlewares ?? []]
|
|
452
|
+
};
|
|
453
|
+
}
|
|
454
|
+
return secured;
|
|
455
|
+
}
|
|
456
|
+
function createOpsRouter(routes, options) {
|
|
457
|
+
if (!options?.auth) {
|
|
458
|
+
throw new OpsRouterError(
|
|
459
|
+
"createOpsRouter requires an auth middleware ({ auth: ... }). An ops surface reachable without authentication cannot be created."
|
|
460
|
+
);
|
|
461
|
+
}
|
|
462
|
+
const manifest = {
|
|
463
|
+
manifestVersion: 1,
|
|
464
|
+
commands: collectOpsCommands(routes)
|
|
465
|
+
};
|
|
466
|
+
const secured = secureRoutes(routes, options.auth);
|
|
467
|
+
const manifestRoute = route.get(OPS_MANIFEST_PATH).use([options.auth]).handler(async () => manifest);
|
|
468
|
+
return defineRouter({
|
|
469
|
+
...secured,
|
|
470
|
+
[OPS_MANIFEST_NAME]: manifestRoute
|
|
471
|
+
});
|
|
472
|
+
}
|
|
473
|
+
|
|
474
|
+
export { OPS_MANIFEST_PATH, OPS_PATH_PREFIX, OpsRouterError, collectOpsCommands, createOpsRouter };
|
|
475
|
+
//# sourceMappingURL=index.js.map
|
|
476
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../src/route/route-builder.ts","../../src/route/router.ts","../../src/ops/manifest.ts","../../src/ops/create-ops-router.ts"],"names":["isRouter","isRouteDef"],"mappings":";AA0DO,IAAM,YAAA,GAAN,MAAM,aAAA,CAKb;AAAA,EACW,OAAA;AAAA,EACA,KAAA;AAAA,EACA,MAAA;AAAA,EACA,YAAA;AAAA,EACA,YAAA;AAAA,EACA,gBAAA;AAAA,EACA,SAAA;AAAA;AAAA;AAAA;AAAA,EAKC,MAIJ,SAAA,EAQJ;AACI,IAAA,MAAM,OAAA,GAAU,IAAI,aAAA,EAAoD;AACxE,IAAA,OAAA,CAAQ,UAAU,IAAA,CAAK,OAAA;AACvB,IAAA,OAAA,CAAQ,QAAQ,IAAA,CAAK,KAAA;AACrB,IAAA,OAAA,CAAQ,MAAA,GAAU,SAAA,EAAW,KAAA,IAAS,IAAA,CAAK,MAAA;AAC3C,IAAA,OAAA,CAAQ,YAAA,GAAgB,SAAA,EAAW,WAAA,IAAe,IAAA,CAAK,YAAA;AACvD,IAAA,OAAA,CAAQ,YAAA,GAAe,SAAA,EAAW,WAAA,IAAe,IAAA,CAAK,YAAA;AACtD,IAAA,OAAA,CAAQ,gBAAA,GAAmB,SAAA,EAAW,eAAA,IAAmB,IAAA,CAAK,gBAAA;AAC9D,IAAA,OAAA,CAAQ,SAAA,GAAY,SAAA,EAAW,QAAA,IAAY,IAAA,CAAK,SAAA;AAEhD,IAAA,OAAO,OAAA;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAqBA,MAAoC,KAAA,EACpC;AACI,IAAA,OAAO,IAAA,CAAK,KAAA,CAAM,EAAE,KAAA,EAAO,CAAA;AAAA,EAC/B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAsCA,YACI,WAAA,EAEJ;AACI,IAAA,OAAO,IAAA,CAAK,KAAA,CAAM,EAAE,WAAA,EAAa,CAAA;AAAA,EACrC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAsBA,WAAW,WAAA,EACX;AACI,IAAA,OAAO,IAAA,CAAK,KAAA,CAAM,EAAE,WAAA,EAAa,CAAA;AAAA,EACrC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAsBA,IAAI,WAAA,EACJ;AACI,IAAA,OAAO,IAAA,CAAK,WAAW,WAAW,CAAA;AAAA,EACtC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EA2BA,KAAK,eAAA,EACL;AACI,IAAA,OAAO,IAAA,CAAK,KAAA,CAAM,EAAE,eAAA,EAAiB,iBAAiB,CAAA;AAAA,EAC1D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgCA,SAAS,QAAA,EACT;AACI,IAAA,OAAO,IAAA,CAAK,KAAA,CAAM,EAAE,QAAA,EAAU,CAAA;AAAA,EAClC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgDA,QACI,EAAA,EAEJ;AACI,IAAA,OAAO;AAAA,MACH,QAAQ,IAAA,CAAK,OAAA;AAAA,MACb,MAAM,IAAA,CAAK,KAAA;AAAA,MACX,OAAO,IAAA,CAAK,MAAA;AAAA,MACZ,aAAa,IAAA,CAAK,YAAA;AAAA,MAClB,aAAa,IAAA,CAAK,YAAA;AAAA,MAClB,iBAAiB,IAAA,CAAK,gBAAA;AAAA,MACtB,UAAU,IAAA,CAAK,SAAA;AAAA,MACf,OAAA,EAAS,EAAA;AAAA,MACT,QAAQ,EAAC;AAAA,MACT,cAAc,EAAC;AAAA,MACf,WAAW;AAAC,KAChB;AAAA,EACJ;AACJ,CAAA;AAKA,SAAS,kBAAkB,MAAA,EAC3B;AACI,EAAA,OAAO,CAAC,IAAA,KACR;AACI,IAAA,MAAM,OAAA,GAAU,IAAI,YAAA,EAAa;AACjC,IAAA,OAAA,CAAQ,OAAA,GAAU,MAAA;AAClB,IAAA,OAAA,CAAQ,KAAA,GAAQ,IAAA;AAEhB,IAAA,OAAO,OAAA;AAAA,EACX,CAAA;AACJ;AAwBO,IAAM,KAAA,GAAQ;AAAA,EACjB,GAAA,EAAK,kBAAkB,KAAK,CAAA;AAAA,EAC5B,IAAA,EAAM,kBAAkB,MAAM,CAAA;AAAA,EAC9B,GAAA,EAAK,kBAAkB,KAAK,CAAA;AAAA,EAC5B,KAAA,EAAO,kBAAkB,OAAO,CAAA;AAAA,EAChC,MAAA,EAAQ,kBAAkB,QAAQ;AACtC,CAAA;;;ACxSA,SAAS,oBAAA,CACL,QACA,cAAA,GAAgC,IAChC,iBAAA,GAA+C,EAAC,EAChD,eAAA,GAAiC,IAAA,EAErC;AACI,EAAA,OAAO;AAAA,IACH,MAAA;AAAA,IACA,OAAA,EAAS,MAAA;AAAA,IACT,eAAA,EAAiB,cAAA;AAAA,IACjB,kBAAA,EAAoB,iBAAA;AAAA,IACpB,gBAAA,EAAkB,eAAA;AAAA,IAElB,SAAS,OAAA,EACT;AACI,MAAA,MAAM,oBAAoB,CAAC,GAAG,IAAA,CAAK,eAAA,EAAiB,GAAG,OAAO,CAAA;AAG9D,MAAA,KAAA,MAAW,aAAa,OAAA,EACxB;AACI,QAAA,IAAI,SAAA,CAAU,eAAA,EAAiB,MAAA,GAAS,CAAA,EACxC;AACI,UAAA,iBAAA,CAAkB,IAAA,CAAK,GAAG,SAAA,CAAU,eAAe,CAAA;AAAA,QACvD;AAAA,MACJ;AAEA,MAAA,OAAO,oBAAA;AAAA,QACH,IAAA,CAAK,MAAA;AAAA,QACL,iBAAA;AAAA,QACA,IAAA,CAAK,kBAAA;AAAA,QACL,IAAA,CAAK;AAAA,OACT;AAAA,IACJ,CAAA;AAAA,IAEA,IAAI,WAAA,EACJ;AACI,MAAA,OAAO,oBAAA;AAAA,QACH,IAAA,CAAK,MAAA;AAAA,QACL,IAAA,CAAK,eAAA;AAAA,QACL,CAAC,GAAG,IAAA,CAAK,kBAAA,EAAoB,GAAG,WAAW,CAAA;AAAA,QAC3C,IAAA,CAAK;AAAA,OACT;AAAA,IACJ,CAAA;AAAA,IAEA,gBAAgB,OAAA,EAChB;AACI,MAAA,qBAAA,CAAsB,OAAO,CAAA;AAE7B,MAAA,OAAO,oBAAA;AAAA,QACH,IAAA,CAAK,MAAA;AAAA,QACL,IAAA,CAAK,eAAA;AAAA,QACL,IAAA,CAAK,kBAAA;AAAA,QACL;AAAA,OACJ;AAAA,IACJ;AAAA,GACJ;AACJ;AAQA,SAAS,sBAAsB,OAAA,EAC/B;AACI,EAAA,IAAI,CAAC,wCAAA,CAAyC,IAAA,CAAK,OAAO,CAAA,EAC1D;AACI,IAAA,MAAM,IAAI,KAAA;AAAA,MACN,oBAAoB,OAAO,CAAA,kIAAA;AAAA,KAE/B;AAAA,EACJ;AACJ;AAuCO,SAAS,aACZ,MAAA,EAEJ;AACI,EAAA,OAAO,qBAAqB,MAAM,CAAA;AACtC;;;AC1KO,IAAM,cAAA,GAAN,cAA6B,KAAA,CACpC;AAAA,EACI,YAAY,OAAA,EACZ;AACI,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,IAAA,GAAO,gBAAA;AAAA,EAChB;AACJ;AAEA,SAAS,SAAS,KAAA,EAClB;AACI,EAAA,OAAO,UAAU,IAAA,IACV,OAAO,UAAU,QAAA,IACjB,QAAA,IAAY,SACZ,SAAA,IAAa,KAAA;AACxB;AAEA,SAAS,WAAW,KAAA,EACpB;AACI,EAAA,OAAO,KAAA,KAAU,IAAA,IACV,OAAO,KAAA,KAAU,YACjB,SAAA,IAAa,KAAA;AACxB;AAMA,SAAS,aAAa,MAAA,EACtB;AACI,EAAA,OAAO,IAAA,CAAK,KAAA,CAAM,IAAA,CAAK,SAAA,CAAU,MAAM,CAAC,CAAA;AAC5C;AAEA,IAAM,cAAA,GAAiB,CAAC,QAAA,EAAU,OAAA,EAAS,MAAM,CAAA;AAEjD,SAAS,eAAe,KAAA,EACxB;AACI,EAAA,MAAM,WAAgC,EAAC;AAEvC,EAAA,IAAI,CAAC,KAAA,EACL;AACI,IAAA,OAAO,QAAA;AAAA,EACX;AAEA,EAAA,KAAA,MAAW,WAAW,cAAA,EACtB;AACI,IAAA,MAAM,MAAA,GAAS,MAAM,OAAO,CAAA;AAC5B,IAAA,IAAI,MAAA,EACJ;AACI,MAAA,QAAA,CAAS,OAAO,CAAA,GAAI,YAAA,CAAa,MAAM,CAAA;AAAA,IAC3C;AAAA,EACJ;AAEA,EAAA,OAAO,QAAA;AACX;AAOO,SAAS,mBACZ,MAAA,EAEJ;AACI,EAAA,MAAM,WAAyB,EAAC;AAChC,EAAA,KAAA,CAAM,MAAA,EAAQ,QAAA,kBAAU,IAAI,GAAA,EAAqB,CAAA;AACjD,EAAA,QAAA,CAAS,IAAA,CAAK,CAAC,CAAA,EAAG,CAAA,KAAO,EAAE,IAAA,GAAO,CAAA,CAAE,IAAA,GAAO,EAAA,GAAK,CAAA,CAAE,IAAA,GAAO,CAAA,CAAE,IAAA,GAAO,IAAI,CAAE,CAAA;AAExE,EAAA,OAAO,QAAA;AACX;AAEA,SAAS,KAAA,CACL,MAAA,EACA,QAAA,EACA,OAAA,EAEJ;AACI,EAAA,KAAA,MAAW,CAAC,IAAA,EAAM,KAAK,KAAK,MAAA,CAAO,OAAA,CAAQ,MAAM,CAAA,EACjD;AACI,IAAA,IAAI,QAAA,CAAS,KAAK,CAAA,EAClB;AACI,MAAA,KAAA,CAAM,KAAA,CAAM,MAAA,EAAQ,QAAA,EAAU,OAAO,CAAA;AACrC,MAAA;AAAA,IACJ;AAEA,IAAA,IAAI,CAAC,WAAW,KAAK,CAAA,IAAK,CAAC,KAAA,CAAM,MAAA,IAAU,CAAC,KAAA,CAAM,IAAA,EAClD;AACI,MAAA;AAAA,IACJ;AAEA,IAAA,mBAAA,CAAoB,IAAA,EAAM,KAAA,CAAM,IAAA,EAAM,OAAO,CAAA;AAE7C,IAAA,QAAA,CAAS,IAAA,CAAK;AAAA,MACV,IAAA;AAAA,MACA,QAAQ,KAAA,CAAM,MAAA;AAAA,MACd,MAAM,KAAA,CAAM,IAAA;AAAA,MACZ,KAAA,EAAO,cAAA,CAAe,KAAA,CAAM,KAA+B;AAAA,KAC9D,CAAA;AAAA,EACL;AACJ;AAQA,SAAS,mBAAA,CAAoB,IAAA,EAAc,IAAA,EAAc,OAAA,EACzD;AACI,EAAA,MAAM,QAAA,GAAW,OAAA,CAAQ,GAAA,CAAI,IAAI,CAAA;AACjC,EAAA,IAAI,aAAa,MAAA,EACjB;AACI,IAAA,MAAM,IAAI,cAAA;AAAA,MACN,CAAA,0BAAA,EAA6B,IAAI,CAAA,IAAA,EAAO,QAAQ,UAAU,IAAI,CAAA,mIAAA;AAAA,KAGlE;AAAA,EACJ;AAEA,EAAA,OAAA,CAAQ,GAAA,CAAI,MAAM,IAAI,CAAA;AAC1B;;;AC3HO,IAAM,eAAA,GAAkB;AAGxB,IAAM,iBAAA,GAAoB;AAGjC,IAAM,iBAAA,GAAoB,gBAAA;AAY1B,SAASA,UAAS,KAAA,EAClB;AACI,EAAA,OAAO,UAAU,IAAA,IACV,OAAO,UAAU,QAAA,IACjB,QAAA,IAAY,SACZ,SAAA,IAAa,KAAA;AACxB;AAEA,SAASC,YAAW,KAAA,EACpB;AACI,EAAA,OAAO,KAAA,KAAU,IAAA,IACV,OAAO,KAAA,KAAU,YACjB,SAAA,IAAa,KAAA;AACxB;AAEA,SAAS,cAAA,CAAe,MAAc,GAAA,EACtC;AACI,EAAA,IAAI,CAAC,GAAA,CAAI,MAAA,IAAU,CAAC,IAAI,IAAA,EACxB;AACI,IAAA,MAAM,IAAI,cAAA;AAAA,MACN,cAAc,IAAI,CAAA,qFAAA;AAAA,KAEtB;AAAA,EACJ;AAEA,EAAA,IAAI,CAAC,GAAA,CAAI,IAAA,CAAK,UAAA,CAAW,eAAe,CAAA,EACxC;AACI,IAAA,MAAM,IAAI,cAAA;AAAA,MACN,cAAc,IAAI,CAAA,SAAA,EAAY,GAAA,CAAI,IAAI,eAAe,eAAe,CAAA,8GAAA;AAAA,KAGxE;AAAA,EACJ;AAEA,EAAA,IAAI,GAAA,CAAI,SAAS,iBAAA,EACjB;AACI,IAAA,MAAM,IAAI,cAAA;AAAA,MACN,CAAA,WAAA,EAAc,IAAI,CAAA,UAAA,EAAa,iBAAiB,CAAA,sCAAA;AAAA,KACpD;AAAA,EACJ;AACJ;AAQA,SAAS,cAAc,IAAA,EACvB;AACI,EAAA,IAAI,SAAS,iBAAA,EACb;AACI,IAAA,MAAM,IAAI,cAAA;AAAA,MACN,mBAAmB,iBAAiB,CAAA,qCAAA;AAAA,KACxC;AAAA,EACJ;AACJ;AAaA,SAAS,mBAAA,CAAoB,IAAA,EAAc,MAAA,EAAqB,IAAA,EAChE;AACI,EAAA,IAAI,MAAA,CAAO,eAAA,EAAiB,MAAA,GAAS,CAAA,EACrC;AACI,IAAA,MAAM,IAAI,cAAA;AAAA,MACN,eAAe,IAAI,CAAA,4IAAA;AAAA,KAEvB;AAAA,EACJ;AAEA,EAAA,IAAI,OAAA,GAAU,YAAA;AAAA,IACV,YAAA,CAAa,MAAA,CAAO,MAAA,EAAQ,IAAI;AAAA,GACpC;AAEA,EAAA,IAAI,MAAA,CAAO,kBAAA,EAAoB,MAAA,GAAS,CAAA,EACxC;AACI,IAAA,OAAA,GAAU,OAAA,CAAQ,GAAA,CAAI,MAAA,CAAO,kBAAkB,CAAA;AAAA,EACnD;AAEA,EAAA,IAAI,OAAO,gBAAA,EACX;AACI,IAAA,OAAA,GAAU,OAAA,CAAQ,eAAA,CAAgB,MAAA,CAAO,gBAAgB,CAAA;AAAA,EAC7D;AAEA,EAAA,OAAO,OAAA;AACX;AASA,SAAS,YAAA,CACL,QACA,IAAA,EAEJ;AACI,EAAA,MAAM,UAAuD,EAAC;AAE9D,EAAA,KAAA,MAAW,CAAC,IAAA,EAAM,KAAK,KAAK,MAAA,CAAO,OAAA,CAAQ,MAAM,CAAA,EACjD;AACI,IAAA,aAAA,CAAc,IAAI,CAAA;AAElB,IAAA,IAAID,SAAAA,CAAS,KAAK,CAAA,EAClB;AACI,MAAA,OAAA,CAAQ,IAAI,CAAA,GAAI,mBAAA,CAAoB,IAAA,EAAM,OAAO,IAAI,CAAA;AACrD,MAAA;AAAA,IACJ;AAEA,IAAA,IAAI,CAACC,WAAAA,CAAW,KAAK,CAAA,EACrB;AACI,MAAA,MAAM,IAAI,cAAA,CAAe,CAAA,kBAAA,EAAqB,IAAI,CAAA,kCAAA,CAAoC,CAAA;AAAA,IAC1F;AAEA,IAAA,cAAA,CAAe,MAAM,KAAK,CAAA;AAC1B,IAAA,OAAA,CAAQ,IAAI,CAAA,GAAI;AAAA,MACZ,GAAG,KAAA;AAAA,MACH,aAAa,CAAC,IAAA,EAAM,GAAI,KAAA,CAAM,WAAA,IAAe,EAAG;AAAA,KACpD;AAAA,EACJ;AAEA,EAAA,OAAO,OAAA;AACX;AASO,SAAS,eAAA,CACZ,QACA,OAAA,EAEJ;AACI,EAAA,IAAI,CAAC,SAAS,IAAA,EACd;AACI,IAAA,MAAM,IAAI,cAAA;AAAA,MACN;AAAA,KAEJ;AAAA,EACJ;AAEA,EAAA,MAAM,QAAA,GAAwB;AAAA,IAC1B,eAAA,EAAiB,CAAA;AAAA,IACjB,QAAA,EAAU,mBAAmB,MAAM;AAAA,GACvC;AAEA,EAAA,MAAM,OAAA,GAAU,YAAA,CAAa,MAAA,EAAQ,OAAA,CAAQ,IAAI,CAAA;AAEjD,EAAA,MAAM,aAAA,GAAgB,KAAA,CAAM,GAAA,CAAI,iBAAiB,CAAA,CAC5C,GAAA,CAAI,CAAC,OAAA,CAAQ,IAAI,CAAC,CAAA,CAClB,OAAA,CAAQ,YAAY,QAAQ,CAAA;AAEjC,EAAA,OAAO,YAAA,CAAa;AAAA,IAChB,GAAG,OAAA;AAAA,IACH,CAAC,iBAAiB,GAAG;AAAA,GACS,CAAA;AACtC","file":"index.js","sourcesContent":["/**\n * Route Builder\n *\n * Provides tRPC-style chainable API for route definition\n */\n\nimport type { MiddlewareHandler } from 'hono';\nimport type { NamedMiddleware } from './define-middleware';\nimport type { RouteInput } from './route-input';\nimport type { RouteBuilderContext } from './context';\nimport type { RouteContract } from './contract';\nimport type { HttpMethod } from './types';\n\n/**\n * Route handler function\n */\nexport type RouteHandlerFn<\n TInput extends RouteInput = RouteInput,\n TInterceptor extends RouteInput = {},\n TResponse = unknown,\n> = (c: RouteBuilderContext<TInput, TInterceptor>) => Response | Promise<Response> | TResponse | Promise<TResponse>;\n\n/**\n * Route definition result\n *\n * Contains all information needed for type inference and registration\n */\nexport type RouteDef<\n TInput extends RouteInput = RouteInput,\n TInterceptor extends RouteInput = {},\n TResponse = unknown,\n> = {\n method?: HttpMethod;\n path?: string;\n input?: TInput;\n interceptor?: TInterceptor;\n middlewares?: (MiddlewareHandler | NamedMiddleware<string>)[];\n skipMiddlewares?: string[] | '*';\n\n /**\n * Public promise this route makes to separately deployed clients.\n *\n * Present as a runtime value, unlike `_response`: the contract generator and\n * the compatibility gate read it.\n */\n contract?: RouteContract;\n\n handler: RouteHandlerFn<TInput, TInterceptor, TResponse>;\n\n // Type inference helpers\n _input: TInput;\n _interceptor: TInterceptor;\n _response: TResponse;\n};\n\n/**\n * Route builder with chainable API (tRPC-style)\n */\nexport class RouteBuilder<\n TInput extends RouteInput = {},\n TInterceptor extends RouteInput = {},\n TResponse = never,\n>\n{\n public _method?: HttpMethod;\n public _path?: string;\n public _input?: TInput;\n public _interceptor?: TInterceptor;\n public _middlewares?: (MiddlewareHandler | NamedMiddleware<string>)[];\n public _skipMiddlewares?: string[] | '*';\n public _contract?: RouteContract;\n\n /**\n * Create a new RouteBuilder with copied properties and optional overrides\n */\n private clone<\n TNewInput extends RouteInput = TInput,\n TNewInterceptor extends RouteInput = TInterceptor,\n >(\n overrides?: Partial<{\n input: TNewInput;\n interceptor: TNewInterceptor;\n middlewares: (MiddlewareHandler | NamedMiddleware<string>)[];\n skipMiddlewares: string[] | '*';\n contract: RouteContract;\n }>,\n ): RouteBuilder<TNewInput, TNewInterceptor, TResponse>\n {\n const builder = new RouteBuilder<TNewInput, TNewInterceptor, TResponse>();\n builder._method = this._method;\n builder._path = this._path;\n builder._input = (overrides?.input ?? this._input) as TNewInput | undefined;\n builder._interceptor = (overrides?.interceptor ?? this._interceptor) as TNewInterceptor | undefined;\n builder._middlewares = overrides?.middlewares ?? this._middlewares;\n builder._skipMiddlewares = overrides?.skipMiddlewares ?? this._skipMiddlewares;\n builder._contract = overrides?.contract ?? this._contract;\n\n return builder;\n }\n\n /**\n * Define input schemas\n *\n * @example\n * ```ts\n * route.get('/users/:id')\n * .input({\n * params: Type.Object({ id: Type.String() }),\n * query: Type.Object({ page: Type.Number() }),\n * headers: Type.Object({ authorization: Type.String() })\n * })\n * .handler(async (c) => {\n * const { params, query, headers } = await c.data();\n * // params = { id: string }\n * // query = { page: number }\n * // headers = { authorization: string }\n * })\n * ```\n */\n input<TNewInput extends RouteInput>(input: TNewInput): RouteBuilder<TNewInput, TInterceptor, TResponse>\n {\n return this.clone({ input });\n }\n\n /**\n * Define fields injected by interceptors\n *\n * These fields are:\n * - Available in the handler (merged with input)\n * - Excluded from client types (codegen uses only input)\n * - Not validated by route input schema (injected by middleware)\n *\n * Use this when middleware/interceptors add fields to the request\n * before it reaches the handler.\n *\n * @example\n * ```ts\n * // Auth interceptor injects crypto key fields\n * route.post('/_auth/login')\n * .input({\n * body: Type.Object({\n * email: Type.String(),\n * password: Type.String()\n * })\n * })\n * .interceptor({\n * body: Type.Object({\n * publicKey: Type.String(),\n * keyId: Type.String(),\n * fingerprint: Type.String()\n * })\n * })\n * .handler(async (c) => {\n * const { body } = await c.data();\n * // body type: { email, password, publicKey, keyId, fingerprint }\n * // Client only sees: { email, password }\n * return loginService(body);\n * });\n * ```\n */\n interceptor<TNewInterceptor extends RouteInput>(\n interceptor: TNewInterceptor,\n ): RouteBuilder<TInput, TNewInterceptor, TResponse>\n {\n return this.clone({ interceptor });\n }\n\n /**\n * Add middlewares to the route\n *\n * Accepts both regular middleware handlers and named middlewares (NamedMiddleware).\n * Named middlewares that are already registered globally will be automatically\n * deduplicated to prevent double execution.\n *\n * @example\n * ```ts\n * import { authenticate } from '@spfn/auth/server/middleware';\n *\n * // With NamedMiddleware (auto-deduped if registered globally)\n * route.get('/users')\n * .use([authenticate, RateLimitMiddleware()])\n *\n * // With regular middleware handlers\n * route.get('/users')\n * .use([AuthMiddleware(), RateLimitMiddleware()])\n * ```\n */\n middleware(middlewares: (MiddlewareHandler | NamedMiddleware<string>)[]): RouteBuilder<TInput, TInterceptor, TResponse>\n {\n return this.clone({ middlewares });\n }\n\n /**\n * Add middlewares to the route (alias for `.middleware()`)\n *\n * Accepts both regular middleware handlers and named middlewares (NamedMiddleware).\n * Named middlewares that are already registered globally will be automatically\n * deduplicated to prevent double execution.\n *\n * @example\n * ```ts\n * import { authenticate } from '@spfn/auth/server/middleware';\n *\n * // With NamedMiddleware (auto-deduped if registered globally)\n * route.get('/users')\n * .use([authenticate, RateLimitMiddleware()])\n *\n * // With regular middleware handlers\n * route.get('/users')\n * .use([AuthMiddleware(), RateLimitMiddleware()])\n * ```\n */\n use(middlewares: (MiddlewareHandler | NamedMiddleware<string>)[]): RouteBuilder<TInput, TInterceptor, TResponse>\n {\n return this.middleware(middlewares);\n }\n\n /**\n * Skip server-level named middlewares\n *\n * Useful for public endpoints that should bypass auth or rate limiting\n *\n * @param middlewareNames - Array of middleware names to skip, or '*' to skip all\n *\n * @example\n * ```ts\n * // Skip specific middlewares\n * route.get('/health')\n * .skip(['auth', 'rateLimit'])\n * .handler(async (c) => c.json({ status: 'ok' }));\n *\n * // Skip only auth (still apply rate limiting)\n * route.get('/public-data')\n * .skip(['auth'])\n * .handler(async (c) => { ... });\n *\n * // Skip all middlewares\n * route.get('/public-health')\n * .skip('*')\n * .handler(async (c) => c.json({ status: 'ok' }));\n * ```\n */\n skip(middlewareNames: string[] | '*'): RouteBuilder<TInput, TInterceptor, TResponse>\n {\n return this.clone({ skipMiddlewares: middlewareNames });\n }\n\n /**\n * Publish this route as a versioned contract operation\n *\n * Marks the route as a promise to clients that are compiled and deployed\n * separately from the server — a mobile app, an external API consumer.\n * The `@spfn/core:contract` generator writes every contracted route into\n * `contracts/current.json`, and the build refuses a change that would break\n * an already-released client.\n *\n * Routes without `.contract()` are unaffected: they simply do not appear in\n * the contract. A web client needs nothing here — it derives its types from\n * the router in the same build.\n *\n * @example\n * ```ts\n * export const getUser = route.get('/users/:id')\n * .input({ params: Type.Object({ id: Type.String() }) })\n * .contract({\n * since: '1.2.0',\n * auth: 'clientProofV1',\n * requiresSession: true,\n * response: Type.Object({\n * id: Type.String(),\n * name: Type.String(),\n * email: Type.Optional(Type.String()),\n * }),\n * })\n * .handler(async (c) => { ... });\n * ```\n */\n contract(contract: RouteContract): RouteBuilder<TInput, TInterceptor, TResponse>\n {\n return this.clone({ contract });\n }\n\n /**\n * Define handler function\n *\n * Response type is automatically inferred from the return value.\n * Use helper methods like `c.created()`, `c.paginated()` for proper type inference.\n *\n * @example\n * ```ts\n * // Direct return - type inferred from data\n * route.get('/users/:id')\n * .input({ params: Type.Object({ id: Type.String() }) })\n * .handler(async (c) => {\n * const { params } = await c.data();\n * return await getUser(params.id); // Type: User\n * })\n *\n * // Using c.created() - returns data with 201 status, type preserved\n * route.post('/users')\n * .input({ body: Type.Object({ name: Type.String() }) })\n * .handler(async (c) => {\n * const { body } = await c.data();\n * return c.created(await createUser(body)); // Type: User\n * })\n *\n * // Using c.paginated() - returns PaginatedResult<T>\n * route.get('/users')\n * .handler(async (c) => {\n * const users = await getUsers();\n * return c.paginated(users, 1, 20, 100); // Type: PaginatedResult<User>\n * })\n *\n * // Using c.noContent() - returns void\n * route.delete('/users/:id')\n * .handler(async (c) => {\n * await deleteUser(params.id);\n * return c.noContent(); // Type: void\n * })\n *\n * // Using c.json() - returns Response (type inference lost)\n * // Use only when you need custom status codes not covered by helpers\n * route.get('/custom')\n * .handler(async (c) => {\n * return c.json({ data }, 418); // Type: Response\n * })\n * ```\n */\n handler<THandlerResponse>(\n fn: RouteHandlerFn<TInput, TInterceptor, THandlerResponse>,\n ): RouteDef<TInput, TInterceptor, THandlerResponse>\n {\n return {\n method: this._method,\n path: this._path,\n input: this._input,\n interceptor: this._interceptor,\n middlewares: this._middlewares,\n skipMiddlewares: this._skipMiddlewares,\n contract: this._contract,\n handler: fn,\n _input: {} as TInput,\n _interceptor: {} as TInterceptor,\n _response: {} as THandlerResponse,\n };\n }\n}\n\n/**\n * Create a route definition with HTTP method shortcuts\n */\nfunction createMethodRoute(method: HttpMethod): (path: string) => RouteBuilder\n{\n return (path: string) =>\n {\n const builder = new RouteBuilder();\n builder._method = method;\n builder._path = path;\n\n return builder;\n };\n}\n\n/**\n * Route builder entry point\n *\n * @example\n * ```ts\n * // GET request\n * export const getUser = route.get('/users/:id')\n * .input({ params: Type.Object({ id: Type.String() }) })\n * .handler(async (c) => {\n * const { params } = await c.data();\n * return await db.user.findUnique({ where: { id: params.id } });\n * });\n *\n * // POST request\n * export const createUser = route.post('/users')\n * .input({ body: Type.Object({ name: Type.String(), email: Type.String() }) })\n * .handler(async (c) => {\n * const { body } = await c.data();\n * return c.created(await db.user.create({ data: body }));\n * });\n * ```\n */\nexport const route = {\n get: createMethodRoute('GET'),\n post: createMethodRoute('POST'),\n put: createMethodRoute('PUT'),\n patch: createMethodRoute('PATCH'),\n delete: createMethodRoute('DELETE'),\n};\n","/**\n * Router Definition\n *\n * Provides router composition and middleware management\n */\n\nimport type { NamedMiddleware } from './define-middleware';\nimport type { RouteDef } from './route-builder';\n\n/**\n * Router definition - holds all routes\n */\nexport interface Router<TRoutes extends Record<string, RouteDef<any, any, any> | Router<any>>> {\n routes: TRoutes;\n _routes: TRoutes;\n _packageRouters: Router<any>[];\n _globalMiddlewares: NamedMiddleware<string>[];\n\n /** The contract version these routes publish, or null when uncontracted. */\n _contractVersion: string | null;\n\n /**\n * Register package routers (type-hidden)\n *\n * Package routes are:\n * - Recognized by RPC proxy and backend\n * - NOT exposed in client types (use package's own API like authApi, cmsApi)\n *\n * @example\n * ```ts\n * import { authRouter } from '@spfn/auth/server';\n * import { cmsAppRouter } from '@spfn/cms/server';\n *\n * export const appRouter = defineRouter({\n * getRoot,\n * getHealth,\n * })\n * .packages([authRouter, cmsAppRouter]);\n *\n * // Client usage:\n * // api.getRoot.call({}) - app routes\n * // authApi.login.call({}) - package API\n * ```\n */\n packages(routers: Router<any>[]): Router<TRoutes>;\n\n /**\n * Register global middlewares\n *\n * Applied to all routes unless explicitly skipped via .skip()\n *\n * @example\n * ```ts\n * import { authMiddleware, loggingMiddleware } from './middlewares';\n *\n * export const appRouter = defineRouter({\n * getRoot,\n * getHealth,\n * })\n * .packages([authRouter])\n * .use([authMiddleware, loggingMiddleware]);\n * ```\n */\n use(middlewares: NamedMiddleware<string>[]): Router<TRoutes>;\n\n /**\n * Declare the contract version these routes publish.\n *\n * A client compiled against this server — a mobile app in a store — is\n * generated from one version of the contract and cannot be updated when the\n * server changes. The server announces this version on every response so\n * that client can tell whether the two ends still agree.\n *\n * This is the version's source. A released snapshot is written to\n * `contracts/released/<version>.json` from what is declared here, so the\n * filename follows the code rather than the code having to be told what the\n * filename said.\n *\n * Only a server with contracted routes needs it. Without it the contract\n * generator still writes `current.json` and still runs the compatibility\n * gate; what it cannot do is cut a release or announce a version.\n *\n * @example\n * ```ts\n * export const appRouter = defineRouter({ getRoot, listItems })\n * .contractVersion('1.2.0')\n * .packages([authRouter]);\n * ```\n */\n contractVersion(version: string): Router<TRoutes>;\n}\n\n/**\n * Create a Router instance with chainable methods\n */\nfunction createRouterInstance<TRoutes extends Record<string, RouteDef<any, any, any> | Router<any>>>(\n routes: TRoutes,\n packageRouters: Router<any>[] = [],\n globalMiddlewares: NamedMiddleware<string>[] = [],\n contractVersion: string | null = null,\n): Router<TRoutes>\n{\n return {\n routes,\n _routes: routes,\n _packageRouters: packageRouters,\n _globalMiddlewares: globalMiddlewares,\n _contractVersion: contractVersion,\n\n packages(routers: Router<any>[]): Router<TRoutes>\n {\n const newPackageRouters = [...this._packageRouters, ...routers];\n\n // Also include nested package routers if any\n for (const pkgRouter of routers)\n {\n if (pkgRouter._packageRouters?.length > 0)\n {\n newPackageRouters.push(...pkgRouter._packageRouters);\n }\n }\n\n return createRouterInstance(\n this.routes,\n newPackageRouters,\n this._globalMiddlewares,\n this._contractVersion,\n );\n },\n\n use(middlewares: NamedMiddleware<string>[]): Router<TRoutes>\n {\n return createRouterInstance(\n this.routes,\n this._packageRouters,\n [...this._globalMiddlewares, ...middlewares],\n this._contractVersion,\n );\n },\n\n contractVersion(version: string): Router<TRoutes>\n {\n assertContractVersion(version);\n\n return createRouterInstance(\n this.routes,\n this._packageRouters,\n this._globalMiddlewares,\n version,\n );\n },\n };\n}\n\n/**\n * A version that cannot be ordered cannot gate a release.\n *\n * Checked when it is declared rather than when a snapshot is cut: the failure\n * belongs next to the typo, not in a build step that runs much later.\n */\nfunction assertContractVersion(version: string): void\n{\n if (!/^\\d+\\.\\d+\\.\\d+(?:[-+][0-9A-Za-z.-]+)*$/.test(version))\n {\n throw new Error(\n `contractVersion(\"${version}\") is not a version of the form major.minor.patch. `\n + 'The released snapshot is named from this value and releases are compared by it.',\n );\n }\n}\n\n/**\n * Define a router with multiple routes (tRPC-style)\n *\n * Supports chainable API for packages and middlewares:\n *\n * @example\n * ```ts\n * // Basic usage\n * export const appRouter = defineRouter({\n * getRoot,\n * getHealth,\n * listExamples,\n * });\n *\n * // With package routers (type-hidden)\n * export const appRouter = defineRouter({\n * getRoot,\n * getHealth,\n * })\n * .packages([authRouter, cmsAppRouter]);\n *\n * // With global middlewares\n * export const appRouter = defineRouter({\n * getRoot,\n * getHealth,\n * })\n * .packages([authRouter])\n * .use([authMiddleware, loggingMiddleware]);\n *\n * export type AppRouter = typeof appRouter;\n * ```\n *\n * Package routes:\n * - Recognized by RPC proxy and backend for routing\n * - NOT included in AppRouter type (use authApi, cmsApi instead)\n * - Prevents confusion between app API and package APIs\n */\nexport function defineRouter<TRoutes extends Record<string, RouteDef<any, any, any> | Router<any>>>(\n routes: TRoutes,\n): Router<TRoutes>\n{\n return createRouterInstance(routes);\n}\n","/**\n * Ops Manifest\n *\n * The server's self-description of its ops surface: every command an app\n * exposes under `/_ops`, with each command's input schemas as plain JSON\n * Schema. The ops CLI fetches this from the running server, so command\n * discovery needs neither the app's source nor a generated artifact on the\n * operator's machine.\n *\n * The router is loaded and walked (the contract collector's approach) rather\n * than parsed from source: route schemas built from imported values resolve,\n * and TypeBox schemas serialize to JSON Schema by construction.\n */\n\nimport type { JsonSchema } from '../contract/types';\nimport type { RouteDef } from '../route/route-builder';\nimport type { RouteInput } from '../route/route-input';\nimport type { Router } from '../route/router';\nimport type { HttpMethod } from '../route/types';\n\n/** One invokable ops command, as the CLI sees it. */\nexport interface OpsCommand\n{\n name: string;\n method: HttpMethod;\n path: string;\n\n /** Input sections the route declares, each as JSON Schema. */\n input: {\n params?: JsonSchema;\n query?: JsonSchema;\n body?: JsonSchema;\n };\n}\n\n/** What `GET /_ops/_manifest` answers. */\nexport interface OpsManifest\n{\n manifestVersion: 1;\n commands: OpsCommand[];\n}\n\n/** Thrown when a route cannot be part of an ops surface. */\nexport class OpsRouterError extends Error\n{\n constructor(message: string)\n {\n super(message);\n this.name = 'OpsRouterError';\n }\n}\n\nfunction isRouter(value: unknown): value is Router<any>\n{\n return value !== null\n && typeof value === 'object'\n && 'routes' in value\n && '_routes' in value;\n}\n\nfunction isRouteDef(value: unknown): value is RouteDef<any>\n{\n return value !== null\n && typeof value === 'object'\n && 'handler' in value;\n}\n\n/**\n * Strip TypeBox's symbol-keyed metadata and hand back plain JSON — the same\n * round trip the contract collector uses.\n */\nfunction toJsonSchema(schema: unknown): JsonSchema\n{\n return JSON.parse(JSON.stringify(schema)) as JsonSchema;\n}\n\nconst INPUT_SECTIONS = ['params', 'query', 'body'] as const;\n\nfunction toCommandInput(input: RouteInput | undefined): OpsCommand['input']\n{\n const sections: OpsCommand['input'] = {};\n\n if (!input)\n {\n return sections;\n }\n\n for (const section of INPUT_SECTIONS)\n {\n const schema = input[section];\n if (schema)\n {\n sections[section] = toJsonSchema(schema);\n }\n }\n\n return sections;\n}\n\n/**\n * Walk a routes record (nested routers included) and collect every RouteDef\n * as an ops command. Validation of paths and names happens in\n * `createOpsRouter` before this runs.\n */\nexport function collectOpsCommands(\n routes: Record<string, RouteDef<any> | Router<any>>,\n): OpsCommand[]\n{\n const commands: OpsCommand[] = [];\n visit(routes, commands, new Map<string, string>());\n commands.sort((a, b) => (a.name < b.name ? -1 : a.name > b.name ? 1 : 0));\n\n return commands;\n}\n\nfunction visit(\n routes: Record<string, RouteDef<any> | Router<any>>,\n commands: OpsCommand[],\n claimed: Map<string, string>,\n): void\n{\n for (const [name, entry] of Object.entries(routes))\n {\n if (isRouter(entry))\n {\n visit(entry.routes, commands, claimed);\n continue;\n }\n\n if (!isRouteDef(entry) || !entry.method || !entry.path)\n {\n continue;\n }\n\n assertUnclaimedName(name, entry.path, claimed);\n\n commands.push({\n name,\n method: entry.method,\n path: entry.path,\n input: toCommandInput(entry.input as RouteInput | undefined),\n });\n }\n}\n\n/**\n * Nested routers flatten into one command list, so two routes keyed alike in\n * different routers would both be announced under the same command name. The\n * CLI resolves a name to the first match, which means an operator asking for\n * one command silently invokes the other — refuse it at definition time.\n */\nfunction assertUnclaimedName(name: string, path: string, claimed: Map<string, string>): void\n{\n const existing = claimed.get(name);\n if (existing !== undefined)\n {\n throw new OpsRouterError(\n `Two ops routes are named \"${name}\" (\"${existing}\" and \"${path}\"). `\n + 'Command names are flattened across nested routers, so each must be unique '\n + 'for the CLI to resolve the one an operator asked for.',\n );\n }\n\n claimed.set(name, path);\n}\n","/**\n * Ops Router\n *\n * The structure half of SPFN's CLI-first operations surface. An app develops\n * its own ops as ordinary routes — domain operations only that app can name —\n * and this factory turns them into a mountable package router that:\n *\n * - enforces the `/_ops/` path prefix, so the surface is recognizable and an\n * ops route can never shadow an app route;\n * - injects the given auth middleware into every route, the manifest\n * included, so an unauthenticated ops surface cannot be created by\n * accident — there is no opt-out;\n * - serves `GET /_ops/_manifest`, the self-description the `spfn ops` CLI\n * discovers commands from.\n *\n * The auth middleware itself lives with the app's auth stack (`@spfn/auth`\n * ships `opsTokenAuth`); core owns only the structure, so the ops surface has\n * no opinion about how a token is stored or verified.\n *\n * @example\n * ```ts\n * import { createOpsRouter } from '@spfn/core/ops';\n * import { opsTokenAuth, requireOpsScope } from '@spfn/auth/server';\n *\n * export const opsRouter = createOpsRouter({\n * listSignups: route.get('/_ops/signups')\n * .use([requireOpsScope('waitlist:read')])\n * .handler(async () => signupsRepository.list()),\n * }, { auth: opsTokenAuth });\n *\n * // mounted like any package router:\n * export const appRouter = defineRouter({ ... }).packages([opsRouter]);\n * ```\n */\n\nimport type { NamedMiddleware } from '../route/define-middleware';\nimport { route, type RouteDef } from '../route/route-builder';\nimport { defineRouter, type Router } from '../route/router';\nimport { collectOpsCommands, OpsRouterError, type OpsManifest } from './manifest';\n\n/** Every ops route lives under this prefix. */\nexport const OPS_PATH_PREFIX = '/_ops/';\n\n/** Where the manifest is served. Reserved — an app route cannot claim it. */\nexport const OPS_MANIFEST_PATH = '/_ops/_manifest';\n\n/** Reserved route name for the injected manifest route. */\nconst OPS_MANIFEST_NAME = 'getOpsManifest';\n\nexport interface OpsRouterOptions\n{\n /**\n * The middleware that authenticates every ops request. Required — an ops\n * surface without authentication is refused at definition time, not\n * discovered in production.\n */\n auth: NamedMiddleware<string>;\n}\n\nfunction isRouter(value: unknown): value is Router<any>\n{\n return value !== null\n && typeof value === 'object'\n && 'routes' in value\n && '_routes' in value;\n}\n\nfunction isRouteDef(value: unknown): value is RouteDef<any>\n{\n return value !== null\n && typeof value === 'object'\n && 'handler' in value;\n}\n\nfunction assertOpsRoute(name: string, def: RouteDef<any>): void\n{\n if (!def.method || !def.path)\n {\n throw new OpsRouterError(\n `Ops route \"${name}\" has no method or path. `\n + 'An ops command is invoked on the wire, so both are required.',\n );\n }\n\n if (!def.path.startsWith(OPS_PATH_PREFIX))\n {\n throw new OpsRouterError(\n `Ops route \"${name}\" is at \"${def.path}\", outside \"${OPS_PATH_PREFIX}\". `\n + 'Every ops route lives under the prefix so the surface stays recognizable '\n + 'and can never shadow an app route.',\n );\n }\n\n if (def.path === OPS_MANIFEST_PATH)\n {\n throw new OpsRouterError(\n `Ops route \"${name}\" claims \"${OPS_MANIFEST_PATH}\", which is reserved for the manifest.`,\n );\n }\n}\n\n/**\n * The reserved name is checked for every entry, route and nested router\n * alike: the manifest route is merged in last, so an entry under this name\n * would be overwritten rather than refused — its routes would still be\n * announced by the manifest and answer 404 when invoked.\n */\nfunction assertOpsName(name: string): void\n{\n if (name === OPS_MANIFEST_NAME)\n {\n throw new OpsRouterError(\n `Ops route name \"${OPS_MANIFEST_NAME}\" is reserved for the manifest route.`,\n );\n }\n}\n\n/**\n * Rebuild a nested router with the auth middleware injected into its routes,\n * carrying over what the original declared. A plain `defineRouter` of the\n * secured routes would silently drop the router's own `.use()` middlewares —\n * a `requireOpsScope` guard among them — leaving those routes reachable by\n * any valid ops token.\n *\n * `.packages()` is refused rather than carried: package routes are registered\n * without passing through this factory, so they would join the ops surface\n * with neither the prefix check nor the auth injection.\n */\nfunction rebuildNestedRouter(name: string, router: Router<any>, auth: NamedMiddleware<string>): Router<any>\n{\n if (router._packageRouters?.length > 0)\n {\n throw new OpsRouterError(\n `Ops router \"${name}\" mounts package routers with .packages(). `\n + 'Their routes bypass the prefix check and the auth injection, so an ops surface cannot carry them.',\n );\n }\n\n let rebuilt = defineRouter(\n secureRoutes(router.routes, auth) as Record<string, RouteDef<any>>,\n );\n\n if (router._globalMiddlewares?.length > 0)\n {\n rebuilt = rebuilt.use(router._globalMiddlewares);\n }\n\n if (router._contractVersion)\n {\n rebuilt = rebuilt.contractVersion(router._contractVersion);\n }\n\n return rebuilt;\n}\n\n/**\n * Validate every route and hand back a copy with the auth middleware\n * prepended. Route-level injection (rather than router-level `.use`) makes\n * the middleware's `skips` declaration effective, so `opsTokenAuth` can\n * auto-skip a server-level `auth` middleware exactly as `oneTimeTokenAuth`\n * does.\n */\nfunction secureRoutes(\n routes: Record<string, RouteDef<any> | Router<any>>,\n auth: NamedMiddleware<string>,\n): Record<string, RouteDef<any> | Router<any>>\n{\n const secured: Record<string, RouteDef<any> | Router<any>> = {};\n\n for (const [name, entry] of Object.entries(routes))\n {\n assertOpsName(name);\n\n if (isRouter(entry))\n {\n secured[name] = rebuildNestedRouter(name, entry, auth);\n continue;\n }\n\n if (!isRouteDef(entry))\n {\n throw new OpsRouterError(`Ops router entry \"${name}\" is neither a route nor a router.`);\n }\n\n assertOpsRoute(name, entry);\n secured[name] = {\n ...entry,\n middlewares: [auth, ...(entry.middlewares ?? [])],\n };\n }\n\n return secured;\n}\n\n/**\n * Build the app's ops surface from its ops routes.\n *\n * Returns an ordinary `Router` meant to be mounted with `.packages()`, so ops\n * routes stay out of the app's client types exactly like other package\n * routes.\n */\nexport function createOpsRouter<TRoutes extends Record<string, RouteDef<any, any, any> | Router<any>>>(\n routes: TRoutes,\n options: OpsRouterOptions,\n): Router<any>\n{\n if (!options?.auth)\n {\n throw new OpsRouterError(\n 'createOpsRouter requires an auth middleware ({ auth: ... }). '\n + 'An ops surface reachable without authentication cannot be created.',\n );\n }\n\n const manifest: OpsManifest = {\n manifestVersion: 1,\n commands: collectOpsCommands(routes),\n };\n\n const secured = secureRoutes(routes, options.auth);\n\n const manifestRoute = route.get(OPS_MANIFEST_PATH)\n .use([options.auth])\n .handler(async () => manifest);\n\n return defineRouter({\n ...secured,\n [OPS_MANIFEST_NAME]: manifestRoute,\n } as Record<string, RouteDef<any>>);\n}\n"]}
|