@quatrain/api-server-express 1.1.9 → 1.1.10
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.
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ExpressAdapter.d.ts","sourceRoot":"","sources":["../../src/adapters/ExpressAdapter.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAA;AAC7B,OAAO,EAAE,aAAa,EAAE,UAAU,EAA2B,eAAe,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,eAAe,CAAA;
|
|
1
|
+
{"version":3,"file":"ExpressAdapter.d.ts","sourceRoot":"","sources":["../../src/adapters/ExpressAdapter.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAA;AAC7B,OAAO,EAAE,aAAa,EAAE,UAAU,EAA2B,eAAe,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,eAAe,CAAA;AAMnI,qBAAa,cAAe,YAAW,aAAa;IAE9C,OAAO,CAAC,WAAW;IACnB,OAAO,CAAC,MAAM;gBADN,WAAW,GAAE,OAAO,CAAC,WAAW,GAAG,OAAO,CAAC,MAAkB,EAC7D,MAAM,GAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAA;KAAO;IAkB9C,OAAO,CAAC,WAAW;IA6CnB,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,GAAG,IAAI;IAU5C,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,GAAG,IAAI;IAU7C,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,GAAG,IAAI;IAU5C,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,GAAG,IAAI;IAS/C,GAAG,CAAC,UAAU,EAAE,GAAG,GAAG,IAAI;IAS1B,aAAa,CAAC,UAAU,EAAE,aAAa,GAAG,IAAI;IAiD9C,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa;IAYzC,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,IAAI,GAAG,IAAI;IAahD,iBAAiB,IAAI,GAAG;IAYxB,WAAW,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,GAAE,MAAe,GAAG,IAAI;IAiBjE,WAAW,CAAC,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,GAAE,eAAoB,GAAG,IAAI;CAUlG"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ExpressAdapter.js","sourceRoot":"","sources":["../../src/adapters/ExpressAdapter.ts"],"names":[],"mappings":";;;;;;AAAA,sDAA6B;
|
|
1
|
+
{"version":3,"file":"ExpressAdapter.js","sourceRoot":"","sources":["../../src/adapters/ExpressAdapter.ts"],"names":[],"mappings":";;;;;;AAAA,sDAA6B;AAO7B,MAAa,cAAc;IAEb;IACA;IAFX,YACW,cAAoD,IAAA,iBAAO,GAAE,EAC7D,SAAiC,EAAE;QADnC,gBAAW,GAAX,WAAW,CAAkD;QAC7D,WAAM,GAAN,MAAM,CAA6B;QAE3C,IAAI,QAAQ,IAAI,IAAI,CAAC,WAAW,IAAI,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;YAEhF,IAAI,CAAC,WAAmC,CAAC,OAAO,CAAC,cAAc,CAAC,CAAA;YACjE,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,iBAAO,CAAC,IAAI,EAAE,CAAC,CAAA;YACpC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;gBACrC,GAAG,CAAC,MAAM,CAAC,6BAA6B,EAAE,GAAG,CAAC,CAAA;gBAC9C,GAAG,CAAC,MAAM,CAAC,8BAA8B,EAAE,iCAAiC,CAAC,CAAA;gBAC7E,GAAG,CAAC,MAAM,CAAC,8BAA8B,EAAE,GAAG,CAAC,CAAA;gBAC/C,IAAI,GAAG,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;oBAC5B,OAAO,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;gBAC7B,CAAC;gBACD,IAAI,EAAE,CAAA;YACT,CAAC,CAAC,CAAA;QACL,CAAC;IACJ,CAAC;IAEO,WAAW,CAAC,OAAmB;QACpC,OAAO,KAAK,EAAE,GAAoB,EAAE,GAAqB,EAAE,IAA0B,EAAE,EAAE;YACtF,IAAI,CAAC;gBACF,MAAM,MAAM,GAAe;oBACxB,IAAI,EAAE,GAAG,CAAC,IAAI;oBACd,MAAM,EAAE,GAAG,CAAC,MAAM;oBAClB,KAAK,EAAE,GAAG,CAAC,KAAK;oBAChB,OAAO,EAAE,GAAG,CAAC,OAAwD;iBACvE,CAAA;gBAED,MAAM,MAAM,GAAgB;oBACzB,MAAM,EAAE,CAAC,IAAY,EAAE,EAAE;wBACtB,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;wBAChB,OAAO,MAAM,CAAA;oBAChB,CAAC;oBACD,IAAI,EAAE,CAAC,IAAS,EAAE,EAAE;wBACjB,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;oBACjB,CAAC;oBACD,IAAI,EAAE,CAAC,IAAY,EAAE,EAAE;wBACpB,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;oBACjB,CAAC;oBACD,SAAS,EAAE,CAAC,IAAY,EAAE,KAAa,EAAE,EAAE;wBACxC,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;oBAC7B,CAAC;oBACD,KAAK,EAAE,CAAC,IAAY,EAAE,EAAE;wBACrB,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;oBAClB,CAAC;oBACD,GAAG,EAAE,GAAG,EAAE;wBACP,GAAG,CAAC,GAAG,EAAE,CAAA;oBACZ,CAAC;iBACH,CAAA;gBAED,MAAM,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;YAChC,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACZ,IAAI,CAAC,GAAG,CAAC,CAAA;YACZ,CAAC;QACJ,CAAC,CAAA;IACJ,CAAC;IAQD,GAAG,CAAC,IAAY,EAAE,OAAmB;QACjC,IAAI,CAAC,WAA8B,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAA;IAC5E,CAAC;IAQD,IAAI,CAAC,IAAY,EAAE,OAAmB;QAClC,IAAI,CAAC,WAA8B,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAA;IAC7E,CAAC;IAQD,GAAG,CAAC,IAAY,EAAE,OAAmB;QACjC,IAAI,CAAC,WAA8B,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAA;IAC5E,CAAC;IAQD,MAAM,CAAC,IAAY,EAAE,OAAmB;QACpC,IAAI,CAAC,WAA8B,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAA;IAC/E,CAAC;IAOD,GAAG,CAAC,UAAe;QACf,IAAI,CAAC,WAA8B,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;IACvD,CAAC;IAOD,aAAa,CAAC,UAAyB;QACpC,MAAM,iBAAiB,GAAG,KAAK,EAAE,GAAoB,EAAE,GAAqB,EAAE,IAA0B,EAAE,EAAE;YACzG,MAAM,MAAM,GAAe;gBACxB,IAAI,EAAE,GAAG,CAAC,IAAI;gBACd,MAAM,EAAE,GAAG,CAAC,MAAM;gBAClB,KAAK,EAAE,GAAG,CAAC,KAAK;gBAChB,OAAO,EAAE,GAAG,CAAC,OAAwD;aACvE,CAAA;YAED,MAAM,MAAM,GAAgB;gBACzB,MAAM,EAAE,CAAC,IAAY,EAAE,EAAE;oBACtB,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;oBAChB,OAAO,MAAM,CAAA;gBAChB,CAAC;gBACD,IAAI,EAAE,CAAC,IAAS,EAAE,EAAE;oBACjB,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;gBACjB,CAAC;gBACD,IAAI,EAAE,CAAC,IAAY,EAAE,EAAE;oBACpB,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;gBACjB,CAAC;gBACD,SAAS,EAAE,CAAC,IAAY,EAAE,KAAa,EAAE,EAAE;oBACxC,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;gBAC7B,CAAC;gBACD,KAAK,EAAE,CAAC,IAAY,EAAE,EAAE;oBACrB,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;gBAClB,CAAC;gBACD,GAAG,EAAE,GAAG,EAAE;oBACP,GAAG,CAAC,GAAG,EAAE,CAAA;gBACZ,CAAC;aACH,CAAA;YAED,IAAI,CAAC;gBACF,MAAM,cAAc,GAAG,MAAM,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;gBACvD,IAAI,cAAc,EAAE,CAAC;oBAClB,IAAI,EAAE,CAAA;gBACT,CAAC;YACJ,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACZ,IAAI,CAAC,GAAG,CAAC,CAAA;YACZ,CAAC;QACJ,CAAC,CAAA;QACA,IAAI,CAAC,WAA8B,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAA;IAC9D,CAAC;IAQD,YAAY,CAAC,IAAY;QACtB,MAAM,MAAM,GAAG,iBAAO,CAAC,MAAM,EAAE,CAC9B;QAAC,IAAI,CAAC,WAA8B,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;QACvD,OAAO,IAAI,cAAc,CAAC,MAAM,CAAC,CAAA;IACpC,CAAC;IAQD,KAAK,CAAC,IAAY,EAAE,QAAqB;QACtC,IAAI,QAAQ,IAAI,IAAI,CAAC,WAAW,IAAI,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;YACjF,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;QAC1C,CAAC;aAAM,CAAC;YACL,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAA;QACjE,CAAC;IACJ,CAAC;IAOD,iBAAiB;QACd,OAAO,IAAI,CAAC,WAAW,CAAA;IAC1B,CAAC;IAUD,WAAW,CAAC,UAAkB,EAAE,YAAoB,MAAM;QACvD,MAAM,IAAI,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;QACjC,IAAI,CAAC,GAAG,CAAC,iBAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAEnC;QAAC,IAAI,CAAC,WAA8B,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,GAAoB,EAAE,GAAqB,EAAE,IAA0B,EAAE,EAAE;YACxH,IAAI,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;gBAAE,OAAO,IAAI,EAAE,CAAA;YACjD,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC,CAAA;QACpD,CAAC,CAAC,CAAA;IACL,CAAC;IASD,WAAW,CAAC,OAAwB,EAAE,YAAoB,EAAE,UAA2B,EAAE;QACtF,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,GAAG,YAAY,EAAE,CAAC,CAAC,CAAC,YAAY,CAAA;QACjG,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAA;QAE1C,IAAI,OAAO,CAAC,WAAW,IAAI,OAAO,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzD,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAA;QACtD,CAAC;QAED,OAAO,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,CAAC,CAAA;IAChC,CAAC;CACH;AAnOD,wCAmOC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@quatrain/api-server-express",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.10",
|
|
4
4
|
"description": "Express Adapter for Quatrain API Server",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
"typescript": "^5.2.2"
|
|
30
30
|
},
|
|
31
31
|
"dependencies": {
|
|
32
|
-
"@quatrain/api": "^1.1.
|
|
32
|
+
"@quatrain/api": "^1.1.5",
|
|
33
33
|
"@quatrain/api-server": "^1.1.9",
|
|
34
34
|
"express": "^4.19.2"
|
|
35
35
|
},
|
|
@@ -1,6 +1,10 @@
|
|
|
1
1
|
import express from 'express'
|
|
2
2
|
import { ServerAdapter, ApiHandler, ApiRequest, ApiResponse, EndpointHandler, EndpointOptions, ApiMiddleware } from '@quatrain/api'
|
|
3
3
|
|
|
4
|
+
/**
|
|
5
|
+
* Api Server adapter wrapping the `express` framework.
|
|
6
|
+
* Maps Quatrain's standardized `ServerAdapter` interfaces to native Express mechanisms.
|
|
7
|
+
*/
|
|
4
8
|
export class ExpressAdapter implements ServerAdapter {
|
|
5
9
|
constructor(
|
|
6
10
|
private appOrRouter: express.Application | express.Router = express(),
|
|
@@ -61,26 +65,60 @@ export class ExpressAdapter implements ServerAdapter {
|
|
|
61
65
|
}
|
|
62
66
|
}
|
|
63
67
|
|
|
68
|
+
/**
|
|
69
|
+
* Registers a GET endpoint.
|
|
70
|
+
*
|
|
71
|
+
* @param path - The URI path.
|
|
72
|
+
* @param handler - The standard Quatrain ApiHandler.
|
|
73
|
+
*/
|
|
64
74
|
get(path: string, handler: ApiHandler): void {
|
|
65
75
|
(this.appOrRouter as express.Router).get(path, this.wrapHandler(handler))
|
|
66
76
|
}
|
|
67
77
|
|
|
78
|
+
/**
|
|
79
|
+
* Registers a POST endpoint.
|
|
80
|
+
*
|
|
81
|
+
* @param path - The URI path.
|
|
82
|
+
* @param handler - The standard Quatrain ApiHandler.
|
|
83
|
+
*/
|
|
68
84
|
post(path: string, handler: ApiHandler): void {
|
|
69
85
|
(this.appOrRouter as express.Router).post(path, this.wrapHandler(handler))
|
|
70
86
|
}
|
|
71
87
|
|
|
88
|
+
/**
|
|
89
|
+
* Registers a PUT endpoint.
|
|
90
|
+
*
|
|
91
|
+
* @param path - The URI path.
|
|
92
|
+
* @param handler - The standard Quatrain ApiHandler.
|
|
93
|
+
*/
|
|
72
94
|
put(path: string, handler: ApiHandler): void {
|
|
73
95
|
(this.appOrRouter as express.Router).put(path, this.wrapHandler(handler))
|
|
74
96
|
}
|
|
75
97
|
|
|
98
|
+
/**
|
|
99
|
+
* Registers a DELETE endpoint.
|
|
100
|
+
*
|
|
101
|
+
* @param path - The URI path.
|
|
102
|
+
* @param handler - The standard Quatrain ApiHandler.
|
|
103
|
+
*/
|
|
76
104
|
delete(path: string, handler: ApiHandler): void {
|
|
77
105
|
(this.appOrRouter as express.Router).delete(path, this.wrapHandler(handler))
|
|
78
106
|
}
|
|
79
107
|
|
|
108
|
+
/**
|
|
109
|
+
* Attaches a native Express middleware or sub-router.
|
|
110
|
+
*
|
|
111
|
+
* @param middleware - The Express RequestHandler or Router.
|
|
112
|
+
*/
|
|
80
113
|
use(middleware: any): void {
|
|
81
114
|
(this.appOrRouter as express.Router).use(middleware)
|
|
82
115
|
}
|
|
83
116
|
|
|
117
|
+
/**
|
|
118
|
+
* Injects a Quatrain-compatible API middleware into the flow.
|
|
119
|
+
*
|
|
120
|
+
* @param middleware - The Quatrain ApiMiddleware function.
|
|
121
|
+
*/
|
|
84
122
|
addMiddleware(middleware: ApiMiddleware): void {
|
|
85
123
|
const expressMiddleware = async (req: express.Request, res: express.Response, next: express.NextFunction) => {
|
|
86
124
|
const apiReq: ApiRequest = {
|
|
@@ -124,12 +162,24 @@ export class ExpressAdapter implements ServerAdapter {
|
|
|
124
162
|
(this.appOrRouter as express.Router).use(expressMiddleware)
|
|
125
163
|
}
|
|
126
164
|
|
|
165
|
+
/**
|
|
166
|
+
* Spawns an isolated routing scope (sub-router).
|
|
167
|
+
*
|
|
168
|
+
* @param path - The prefix path for the router.
|
|
169
|
+
* @returns A new ExpressAdapter instance controlling the sub-router.
|
|
170
|
+
*/
|
|
127
171
|
createRouter(path: string): ServerAdapter {
|
|
128
172
|
const router = express.Router()
|
|
129
173
|
;(this.appOrRouter as express.Router).use(path, router)
|
|
130
174
|
return new ExpressAdapter(router)
|
|
131
175
|
}
|
|
132
176
|
|
|
177
|
+
/**
|
|
178
|
+
* Binds the server to the network and starts listening.
|
|
179
|
+
*
|
|
180
|
+
* @param port - The network port.
|
|
181
|
+
* @param callback - Optional completion callback.
|
|
182
|
+
*/
|
|
133
183
|
start(port: number, callback?: () => void): void {
|
|
134
184
|
if ('listen' in this.appOrRouter && typeof this.appOrRouter.listen === 'function') {
|
|
135
185
|
this.appOrRouter.listen(port, callback)
|
|
@@ -138,6 +188,11 @@ export class ExpressAdapter implements ServerAdapter {
|
|
|
138
188
|
}
|
|
139
189
|
}
|
|
140
190
|
|
|
191
|
+
/**
|
|
192
|
+
* Retrieves the underlying native framework instance.
|
|
193
|
+
*
|
|
194
|
+
* @returns The raw Express Application or Router instance.
|
|
195
|
+
*/
|
|
141
196
|
getNativeInstance(): any {
|
|
142
197
|
return this.appOrRouter
|
|
143
198
|
}
|
|
@@ -160,6 +215,13 @@ export class ExpressAdapter implements ServerAdapter {
|
|
|
160
215
|
})
|
|
161
216
|
}
|
|
162
217
|
|
|
218
|
+
/**
|
|
219
|
+
* Composes and mounts a full EndpointHandler block at a specific root.
|
|
220
|
+
*
|
|
221
|
+
* @param handler - The endpoint initialization logic.
|
|
222
|
+
* @param endpointRoot - The base URI.
|
|
223
|
+
* @param options - Middlewares and operational options.
|
|
224
|
+
*/
|
|
163
225
|
addEndpoint(handler: EndpointHandler, endpointRoot: string, options: EndpointOptions = {}): void {
|
|
164
226
|
const fullPath = this.config.apiPrefix ? `${this.config.apiPrefix}${endpointRoot}` : endpointRoot
|
|
165
227
|
const router = this.createRouter(fullPath)
|