@xrystal/dto 26.6.27-v12
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/README.md +724 -0
- package/dist/adapters/elysia.cjs +820 -0
- package/dist/adapters/elysia.d.ts +138 -0
- package/dist/adapters/elysia.js +816 -0
- package/dist/adapters/express.cjs +789 -0
- package/dist/adapters/express.d.ts +49 -0
- package/dist/adapters/express.js +785 -0
- package/dist/adapters/index.d.ts +7 -0
- package/dist/adapters/node.cjs +790 -0
- package/dist/adapters/node.d.ts +27 -0
- package/dist/adapters/node.js +786 -0
- package/dist/adapters/shared.d.ts +11 -0
- package/dist/adapters/socketio.cjs +767 -0
- package/dist/adapters/socketio.d.ts +31 -0
- package/dist/adapters/socketio.js +763 -0
- package/dist/adapters/websocket.cjs +759 -0
- package/dist/adapters/websocket.d.ts +31 -0
- package/dist/adapters/websocket.js +754 -0
- package/dist/core/assemble-log.d.ts +1 -0
- package/dist/core/assemble-queue.d.ts +1 -0
- package/dist/core/assemble.d.ts +9 -0
- package/dist/core/builder.d.ts +49 -0
- package/dist/core/config.d.ts +10 -0
- package/dist/core/context.d.ts +5 -0
- package/dist/core/hooks.d.ts +8 -0
- package/dist/core/index.cjs +1002 -0
- package/dist/core/index.d.ts +14 -0
- package/dist/core/index.js +986 -0
- package/dist/core/log-dto.d.ts +1 -0
- package/dist/core/metadata.d.ts +6 -0
- package/dist/core/plugins.d.ts +10 -0
- package/dist/core/presets.d.ts +32 -0
- package/dist/core/queue-dto.d.ts +1 -0
- package/dist/core/response-dto.d.ts +1 -0
- package/dist/core/schema-utils.d.ts +1 -0
- package/dist/dto/index.cjs +909 -0
- package/dist/dto/index.d.ts +6 -0
- package/dist/dto/index.js +898 -0
- package/dist/dto/log/assemble.d.ts +3 -0
- package/dist/dto/log/builder.d.ts +41 -0
- package/dist/dto/log/index.cjs +152 -0
- package/dist/dto/log/index.d.ts +3 -0
- package/dist/dto/log/index.js +149 -0
- package/dist/dto/log/types.d.ts +26 -0
- package/dist/dto/queue/assemble.d.ts +2 -0
- package/dist/dto/queue/builder.d.ts +35 -0
- package/dist/dto/queue/index.cjs +154 -0
- package/dist/dto/queue/index.d.ts +3 -0
- package/dist/dto/queue/index.js +151 -0
- package/dist/dto/queue/types.d.ts +34 -0
- package/dist/dto/response/assemble.d.ts +1 -0
- package/dist/dto/response/dto.d.ts +39 -0
- package/dist/dto/response/index.cjs +179 -0
- package/dist/dto/response/index.d.ts +2 -0
- package/dist/dto/response/index.js +176 -0
- package/dist/dto/runtime/dto.cjs +1318 -0
- package/dist/dto/runtime/dto.d.ts +64 -0
- package/dist/dto/runtime/dto.js +1315 -0
- package/dist/dto/shared/base-dto.d.ts +12 -0
- package/dist/dto/shared/schema-utils.d.ts +1 -0
- package/dist/enums/node-env.d.ts +5 -0
- package/dist/errors/codes.d.ts +15 -0
- package/dist/errors/error.d.ts +32 -0
- package/dist/errors/index.d.ts +2 -0
- package/dist/index.cjs +1482 -0
- package/dist/index.d.ts +22 -0
- package/dist/index.js +1433 -0
- package/dist/types/builder.d.ts +15 -0
- package/dist/types/codes.d.ts +7 -0
- package/dist/types/context.d.ts +16 -0
- package/dist/types/hooks.d.ts +7 -0
- package/dist/types/index.d.ts +10 -0
- package/dist/types/log.d.ts +1 -0
- package/dist/types/metadata.d.ts +7 -0
- package/dist/types/options.d.ts +24 -0
- package/dist/types/plugin.d.ts +35 -0
- package/dist/types/queue.d.ts +1 -0
- package/dist/types/response.d.ts +43 -0
- package/dist/utils/constants/http.d.ts +2 -0
- package/dist/utils/constants/index.d.ts +3 -0
- package/dist/utils/constants/security-headers.d.ts +1 -0
- package/dist/utils/constants/status-codes.d.ts +35 -0
- package/dist/utils/helpers/index.d.ts +2 -0
- package/dist/utils/helpers/request-id.d.ts +3 -0
- package/dist/utils/helpers/uuid.d.ts +2 -0
- package/dist/utils/index.d.ts +2 -0
- package/package.json +130 -0
|
@@ -0,0 +1,754 @@
|
|
|
1
|
+
// src/utils/helpers/uuid.ts
|
|
2
|
+
function generateUUID() {
|
|
3
|
+
if (typeof crypto !== "undefined" && typeof crypto.randomUUID === "function") {
|
|
4
|
+
return crypto.randomUUID();
|
|
5
|
+
}
|
|
6
|
+
const bytes = new Uint8Array(16);
|
|
7
|
+
if (typeof crypto !== "undefined" && typeof crypto.getRandomValues === "function") {
|
|
8
|
+
crypto.getRandomValues(bytes);
|
|
9
|
+
} else {
|
|
10
|
+
for (let i = 0; i < bytes.length; i++) {
|
|
11
|
+
bytes[i] = Math.floor(Math.random() * 256);
|
|
12
|
+
}
|
|
13
|
+
}
|
|
14
|
+
bytes[6] = bytes[6] & 15 | 64;
|
|
15
|
+
bytes[8] = bytes[8] & 63 | 128;
|
|
16
|
+
const hex = Array.from(bytes, (b) => b.toString(16).padStart(2, "0")).join("");
|
|
17
|
+
return `${hex.slice(0, 8)}-${hex.slice(8, 12)}-${hex.slice(12, 16)}-${hex.slice(16, 20)}-${hex.slice(20)}`;
|
|
18
|
+
}
|
|
19
|
+
function isValidUUID(id) {
|
|
20
|
+
return /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i.test(id);
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
// src/utils/helpers/request-id.ts
|
|
24
|
+
var DEFAULT_REQUEST_ID_HEADERS = [
|
|
25
|
+
"x-request-id",
|
|
26
|
+
"x-correlation-id",
|
|
27
|
+
"traceparent"
|
|
28
|
+
];
|
|
29
|
+
function readHeader(req, name) {
|
|
30
|
+
const fromGet = req.get?.(name);
|
|
31
|
+
if (fromGet) return fromGet;
|
|
32
|
+
const headers = req.headers;
|
|
33
|
+
if (!headers) return void 0;
|
|
34
|
+
const direct = headers[name] ?? headers[name.toLowerCase()];
|
|
35
|
+
if (direct === void 0) return void 0;
|
|
36
|
+
return Array.isArray(direct) ? direct[0] : direct;
|
|
37
|
+
}
|
|
38
|
+
function traceIdFromTraceparent(traceparent) {
|
|
39
|
+
const parts = traceparent.trim().split("-");
|
|
40
|
+
if (parts.length < 2) return void 0;
|
|
41
|
+
const traceId = parts[1];
|
|
42
|
+
if (!traceId || !/^[0-9a-f]{32}$/i.test(traceId)) return void 0;
|
|
43
|
+
return `${traceId.slice(0, 8)}-${traceId.slice(8, 12)}-${traceId.slice(12, 16)}-${traceId.slice(16, 20)}-${traceId.slice(20)}`;
|
|
44
|
+
}
|
|
45
|
+
function resolveRequestId(req, headerNames = DEFAULT_REQUEST_ID_HEADERS) {
|
|
46
|
+
for (const name of headerNames) {
|
|
47
|
+
const raw = readHeader(req, name);
|
|
48
|
+
if (!raw?.trim()) continue;
|
|
49
|
+
if (name === "traceparent") {
|
|
50
|
+
const traceId = traceIdFromTraceparent(raw);
|
|
51
|
+
if (traceId) return traceId;
|
|
52
|
+
continue;
|
|
53
|
+
}
|
|
54
|
+
const id = raw.trim();
|
|
55
|
+
if (isValidUUID(id)) return id;
|
|
56
|
+
return id;
|
|
57
|
+
}
|
|
58
|
+
return generateUUID();
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
// src/core/context.ts
|
|
62
|
+
var ContextFactory = class {
|
|
63
|
+
static create(req, options = {}) {
|
|
64
|
+
return {
|
|
65
|
+
requestId: resolveRequestId(req, options.requestIdHeaders),
|
|
66
|
+
startTime: Date.now()
|
|
67
|
+
};
|
|
68
|
+
}
|
|
69
|
+
static fromId(requestId) {
|
|
70
|
+
return {
|
|
71
|
+
requestId,
|
|
72
|
+
startTime: Date.now()
|
|
73
|
+
};
|
|
74
|
+
}
|
|
75
|
+
};
|
|
76
|
+
|
|
77
|
+
// src/utils/constants/status-codes.ts
|
|
78
|
+
var StatusCodes = {
|
|
79
|
+
SUCCESSFUL: {
|
|
80
|
+
OK: 200,
|
|
81
|
+
CREATED: 201,
|
|
82
|
+
ACCEPTED: 202,
|
|
83
|
+
NO_CONTENT: 204
|
|
84
|
+
},
|
|
85
|
+
CLIENT_ERROR: {
|
|
86
|
+
BAD_REQUEST: 400,
|
|
87
|
+
UNAUTHORIZED: 401,
|
|
88
|
+
FORBIDDEN: 403,
|
|
89
|
+
NOT_FOUND: 404,
|
|
90
|
+
CONFLICT: 409,
|
|
91
|
+
UNPROCESSABLE_ENTITY: 422,
|
|
92
|
+
TOO_MANY_REQUESTS: 429
|
|
93
|
+
},
|
|
94
|
+
SERVER_ERROR: {
|
|
95
|
+
INTERNAL_SERVER_ERROR: 500,
|
|
96
|
+
SERVICE_UNAVAILABLE: 503,
|
|
97
|
+
GATEWAY_TIMEOUT: 504
|
|
98
|
+
}
|
|
99
|
+
};
|
|
100
|
+
|
|
101
|
+
// src/errors/codes.ts
|
|
102
|
+
var DefaultCodes = {
|
|
103
|
+
SUCCESS: 0,
|
|
104
|
+
CLIENT: 1,
|
|
105
|
+
SERVER: 2,
|
|
106
|
+
VALIDATION: 3
|
|
107
|
+
};
|
|
108
|
+
function createCodeRegistry(overrides = {}) {
|
|
109
|
+
return { ...DefaultCodes, ...overrides };
|
|
110
|
+
}
|
|
111
|
+
function isSuccessCode(code, codes) {
|
|
112
|
+
return code === codes.SUCCESS;
|
|
113
|
+
}
|
|
114
|
+
function resolveCodeFromHttpStatus(statusCode, codes) {
|
|
115
|
+
if (statusCode >= 200 && statusCode < 300) return codes.SUCCESS;
|
|
116
|
+
if (statusCode === 422) return codes.VALIDATION;
|
|
117
|
+
if (statusCode >= 400 && statusCode < 500) return codes.CLIENT;
|
|
118
|
+
if (statusCode >= 500) return codes.SERVER;
|
|
119
|
+
if (statusCode >= 300 && statusCode < 400) return codes.SUCCESS;
|
|
120
|
+
return codes.CLIENT;
|
|
121
|
+
}
|
|
122
|
+
function defaultMessageForCode(code, codes) {
|
|
123
|
+
if (code === codes.SUCCESS) return "Operation successful";
|
|
124
|
+
if (code === codes.CLIENT) return "Client error";
|
|
125
|
+
if (code === codes.SERVER) return "Internal server error";
|
|
126
|
+
if (code === codes.VALIDATION) return "Validation failed";
|
|
127
|
+
return "Operation failed";
|
|
128
|
+
}
|
|
129
|
+
function resolveStatusFromCode(code, codes) {
|
|
130
|
+
return isSuccessCode(code, codes);
|
|
131
|
+
}
|
|
132
|
+
|
|
133
|
+
// src/core/config.ts
|
|
134
|
+
function resolveBuilderConfig(options = {}) {
|
|
135
|
+
return {
|
|
136
|
+
verbose: options.verbose === true,
|
|
137
|
+
includeStack: options.includeStack,
|
|
138
|
+
withDefaultBody: options.withDefaultBody !== false,
|
|
139
|
+
codes: createCodeRegistry(options.codes),
|
|
140
|
+
hooks: options.hooks,
|
|
141
|
+
plugins: options.plugins ?? []
|
|
142
|
+
};
|
|
143
|
+
}
|
|
144
|
+
|
|
145
|
+
// src/dto/shared/base-dto.ts
|
|
146
|
+
var BaseDTO = class {
|
|
147
|
+
};
|
|
148
|
+
|
|
149
|
+
// src/core/assemble.ts
|
|
150
|
+
function assembleResponseBody(input) {
|
|
151
|
+
const ordered = {
|
|
152
|
+
status: input.status,
|
|
153
|
+
message: input.message
|
|
154
|
+
};
|
|
155
|
+
if (input.payload !== void 0 && Object.keys(input.payload).length > 0) {
|
|
156
|
+
ordered.payload = input.payload;
|
|
157
|
+
}
|
|
158
|
+
ordered.code = input.code;
|
|
159
|
+
return ordered;
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
// src/dto/response/dto.ts
|
|
163
|
+
var ResponseDTO = class _ResponseDTO extends BaseDTO {
|
|
164
|
+
_status;
|
|
165
|
+
_message;
|
|
166
|
+
_code;
|
|
167
|
+
_payload = {};
|
|
168
|
+
static status(value) {
|
|
169
|
+
return new _ResponseDTO().status(value);
|
|
170
|
+
}
|
|
171
|
+
static message(value) {
|
|
172
|
+
return new _ResponseDTO().message(value);
|
|
173
|
+
}
|
|
174
|
+
static code(value) {
|
|
175
|
+
return new _ResponseDTO().code(value);
|
|
176
|
+
}
|
|
177
|
+
static data(data) {
|
|
178
|
+
return new _ResponseDTO().data(data);
|
|
179
|
+
}
|
|
180
|
+
static payload(partial) {
|
|
181
|
+
return new _ResponseDTO().payload(partial);
|
|
182
|
+
}
|
|
183
|
+
static schema(input = {}, codes = DefaultCodes) {
|
|
184
|
+
return new _ResponseDTO().schema(input, codes);
|
|
185
|
+
}
|
|
186
|
+
status(value) {
|
|
187
|
+
this._status = value;
|
|
188
|
+
return this;
|
|
189
|
+
}
|
|
190
|
+
message(msg) {
|
|
191
|
+
this._message = msg;
|
|
192
|
+
return this;
|
|
193
|
+
}
|
|
194
|
+
code(code) {
|
|
195
|
+
this._code = code;
|
|
196
|
+
return this;
|
|
197
|
+
}
|
|
198
|
+
data(data) {
|
|
199
|
+
if (data === void 0) {
|
|
200
|
+
delete this._payload.data;
|
|
201
|
+
} else {
|
|
202
|
+
this._payload.data = data;
|
|
203
|
+
}
|
|
204
|
+
return this;
|
|
205
|
+
}
|
|
206
|
+
payload(partial) {
|
|
207
|
+
this._payload = { ...this._payload, ...partial };
|
|
208
|
+
return this;
|
|
209
|
+
}
|
|
210
|
+
setMeta(meta) {
|
|
211
|
+
this._payload.meta = { ...this._payload.meta ?? {}, ...meta };
|
|
212
|
+
return this;
|
|
213
|
+
}
|
|
214
|
+
paginate(total, page, limit) {
|
|
215
|
+
if (limit <= 0) {
|
|
216
|
+
throw new Error("ResponseDTO.paginate: limit must be greater than 0");
|
|
217
|
+
}
|
|
218
|
+
this._payload.pagination = {
|
|
219
|
+
total,
|
|
220
|
+
page,
|
|
221
|
+
limit,
|
|
222
|
+
totalPages: Math.ceil(total / limit),
|
|
223
|
+
hasNext: page * limit < total
|
|
224
|
+
};
|
|
225
|
+
return this;
|
|
226
|
+
}
|
|
227
|
+
schema(input = {}, codes = DefaultCodes) {
|
|
228
|
+
const { status, message, code, payload } = input;
|
|
229
|
+
if (code !== void 0) {
|
|
230
|
+
this.code(code);
|
|
231
|
+
}
|
|
232
|
+
if (status !== void 0) {
|
|
233
|
+
this.status(status);
|
|
234
|
+
} else if (code !== void 0) {
|
|
235
|
+
this.status(resolveStatusFromCode(code, codes));
|
|
236
|
+
}
|
|
237
|
+
if (message !== void 0) {
|
|
238
|
+
this.message(message);
|
|
239
|
+
}
|
|
240
|
+
if (payload !== void 0) {
|
|
241
|
+
this._payload = { ...payload };
|
|
242
|
+
}
|
|
243
|
+
return this;
|
|
244
|
+
}
|
|
245
|
+
getCode() {
|
|
246
|
+
return this._code;
|
|
247
|
+
}
|
|
248
|
+
getMessage() {
|
|
249
|
+
return this._message;
|
|
250
|
+
}
|
|
251
|
+
setCodeFromHttpStatus(httpStatusCode, codes) {
|
|
252
|
+
if (this._code === void 0) {
|
|
253
|
+
this._code = resolveCodeFromHttpStatus(httpStatusCode, codes);
|
|
254
|
+
}
|
|
255
|
+
return this;
|
|
256
|
+
}
|
|
257
|
+
transformData(fn) {
|
|
258
|
+
const next = new _ResponseDTO();
|
|
259
|
+
next._status = this._status;
|
|
260
|
+
next._message = this._message;
|
|
261
|
+
next._code = this._code;
|
|
262
|
+
next._payload = { ...this._payload };
|
|
263
|
+
if (this._payload.data !== void 0) {
|
|
264
|
+
next._payload.data = fn(this._payload.data);
|
|
265
|
+
}
|
|
266
|
+
return next;
|
|
267
|
+
}
|
|
268
|
+
build(options = {}) {
|
|
269
|
+
const codes = options.codes ?? DefaultCodes;
|
|
270
|
+
const code = this._code ?? (options.httpStatusCode !== void 0 ? resolveCodeFromHttpStatus(options.httpStatusCode, codes) : codes.SUCCESS);
|
|
271
|
+
const status = this._status ?? isSuccessCode(code, codes);
|
|
272
|
+
const message = this._message ?? defaultMessageForCode(code, codes);
|
|
273
|
+
if (options.withDefaultBody === false) {
|
|
274
|
+
return assembleResponseBody({ status, message, code });
|
|
275
|
+
}
|
|
276
|
+
const payload = this.buildPayload();
|
|
277
|
+
return assembleResponseBody({
|
|
278
|
+
status,
|
|
279
|
+
message,
|
|
280
|
+
payload,
|
|
281
|
+
code
|
|
282
|
+
});
|
|
283
|
+
}
|
|
284
|
+
buildPayload() {
|
|
285
|
+
const entries = Object.entries(this._payload).filter(([, value]) => value !== void 0);
|
|
286
|
+
if (entries.length === 0) return void 0;
|
|
287
|
+
return Object.fromEntries(entries);
|
|
288
|
+
}
|
|
289
|
+
};
|
|
290
|
+
|
|
291
|
+
// src/core/metadata.ts
|
|
292
|
+
var MetadataFactory = class {
|
|
293
|
+
static create(options = {}, context) {
|
|
294
|
+
return {
|
|
295
|
+
requestId: context?.requestId ?? generateUUID(),
|
|
296
|
+
serverTime: (/* @__PURE__ */ new Date()).toISOString(),
|
|
297
|
+
statusCode: 200,
|
|
298
|
+
...options
|
|
299
|
+
};
|
|
300
|
+
}
|
|
301
|
+
};
|
|
302
|
+
|
|
303
|
+
// src/core/plugins.ts
|
|
304
|
+
function sortPlugins(plugins) {
|
|
305
|
+
return [...plugins].sort((a, b) => (a.priority ?? 0) - (b.priority ?? 0));
|
|
306
|
+
}
|
|
307
|
+
var PluginRegistry = class {
|
|
308
|
+
plugins;
|
|
309
|
+
constructor(plugins = []) {
|
|
310
|
+
this.plugins = sortPlugins(plugins);
|
|
311
|
+
}
|
|
312
|
+
runBeforeBuild(ctx) {
|
|
313
|
+
for (const plugin of this.plugins) {
|
|
314
|
+
plugin.beforeBuild?.(ctx);
|
|
315
|
+
}
|
|
316
|
+
}
|
|
317
|
+
runAfterBuild(result, ctx) {
|
|
318
|
+
let current = result;
|
|
319
|
+
for (const plugin of this.plugins) {
|
|
320
|
+
const next = plugin.afterBuild?.(current, ctx);
|
|
321
|
+
if (next) current = next;
|
|
322
|
+
}
|
|
323
|
+
return current;
|
|
324
|
+
}
|
|
325
|
+
runBeforeDispatch(result, ctx) {
|
|
326
|
+
let current = result;
|
|
327
|
+
for (const plugin of this.plugins) {
|
|
328
|
+
const next = plugin.beforeDispatch?.(current, ctx);
|
|
329
|
+
if (next) current = next;
|
|
330
|
+
}
|
|
331
|
+
return current;
|
|
332
|
+
}
|
|
333
|
+
runAfterDispatch(result, ctx) {
|
|
334
|
+
for (const plugin of this.plugins) {
|
|
335
|
+
plugin.afterDispatch?.(result, ctx);
|
|
336
|
+
}
|
|
337
|
+
}
|
|
338
|
+
};
|
|
339
|
+
|
|
340
|
+
// src/core/presets.ts
|
|
341
|
+
var ResponsePresets = class {
|
|
342
|
+
builder;
|
|
343
|
+
codes;
|
|
344
|
+
constructor(builder, codes) {
|
|
345
|
+
this.builder = builder;
|
|
346
|
+
this.codes = codes;
|
|
347
|
+
}
|
|
348
|
+
applyExtras(extras) {
|
|
349
|
+
if (extras && Object.keys(extras).length > 0) {
|
|
350
|
+
this.builder.payload(extras);
|
|
351
|
+
}
|
|
352
|
+
}
|
|
353
|
+
dispatch() {
|
|
354
|
+
return this.builder.build();
|
|
355
|
+
}
|
|
356
|
+
resolveFailureArgs(dataOrMessage, messageOrExtras, extras) {
|
|
357
|
+
if (typeof dataOrMessage === "string") {
|
|
358
|
+
return {
|
|
359
|
+
message: dataOrMessage,
|
|
360
|
+
extras: typeof messageOrExtras === "string" ? extras : messageOrExtras
|
|
361
|
+
};
|
|
362
|
+
}
|
|
363
|
+
return {
|
|
364
|
+
data: dataOrMessage,
|
|
365
|
+
message: typeof messageOrExtras === "string" ? messageOrExtras : void 0,
|
|
366
|
+
extras: typeof messageOrExtras === "string" ? extras : messageOrExtras
|
|
367
|
+
};
|
|
368
|
+
}
|
|
369
|
+
failure(httpStatus, code, dataOrMessage, messageOrExtras, extras) {
|
|
370
|
+
const resolved = this.resolveFailureArgs(dataOrMessage, messageOrExtras, extras);
|
|
371
|
+
this.builder.httpStatus(httpStatus).code(code).status(false).message(resolved.message ?? defaultMessageForCode(code, this.codes)).data(resolved.data);
|
|
372
|
+
this.applyExtras(resolved.extras);
|
|
373
|
+
return this.dispatch();
|
|
374
|
+
}
|
|
375
|
+
ok(data, message, extras) {
|
|
376
|
+
this.builder.httpStatus(StatusCodes.SUCCESSFUL.OK).code(this.codes.SUCCESS).status(true).message(message ?? defaultMessageForCode(this.codes.SUCCESS, this.codes)).data(data);
|
|
377
|
+
this.applyExtras(extras);
|
|
378
|
+
return this.dispatch();
|
|
379
|
+
}
|
|
380
|
+
created(data, message, extras) {
|
|
381
|
+
this.builder.httpStatus(StatusCodes.SUCCESSFUL.CREATED).code(this.codes.SUCCESS).status(true).message(message ?? defaultMessageForCode(this.codes.SUCCESS, this.codes)).data(data);
|
|
382
|
+
this.applyExtras(extras);
|
|
383
|
+
return this.dispatch();
|
|
384
|
+
}
|
|
385
|
+
accepted(message, extras) {
|
|
386
|
+
this.builder.httpStatus(StatusCodes.SUCCESSFUL.ACCEPTED).code(this.codes.SUCCESS).status(true).message(message ?? defaultMessageForCode(this.codes.SUCCESS, this.codes));
|
|
387
|
+
this.applyExtras(extras);
|
|
388
|
+
return this.dispatch();
|
|
389
|
+
}
|
|
390
|
+
noContent(extras) {
|
|
391
|
+
this.builder.httpStatus(StatusCodes.SUCCESSFUL.NO_CONTENT).code(this.codes.SUCCESS).status(true).message("").data(void 0);
|
|
392
|
+
this.applyExtras(extras);
|
|
393
|
+
return this.dispatch();
|
|
394
|
+
}
|
|
395
|
+
/** Generic client failure — HTTP 400, CLIENT code */
|
|
396
|
+
fail(dataOrMessage, messageOrExtras, extras) {
|
|
397
|
+
return this.failure(StatusCodes.CLIENT_ERROR.BAD_REQUEST, this.codes.CLIENT, dataOrMessage, messageOrExtras, extras);
|
|
398
|
+
}
|
|
399
|
+
/** Generic server failure — HTTP 500, SERVER code */
|
|
400
|
+
error(dataOrMessage, messageOrExtras, extras) {
|
|
401
|
+
return this.failure(
|
|
402
|
+
StatusCodes.SERVER_ERROR.INTERNAL_SERVER_ERROR,
|
|
403
|
+
this.codes.SERVER,
|
|
404
|
+
dataOrMessage,
|
|
405
|
+
messageOrExtras,
|
|
406
|
+
extras
|
|
407
|
+
);
|
|
408
|
+
}
|
|
409
|
+
badRequest(dataOrMessage, messageOrExtras, extras) {
|
|
410
|
+
return this.failure(StatusCodes.CLIENT_ERROR.BAD_REQUEST, this.codes.CLIENT, dataOrMessage, messageOrExtras, extras);
|
|
411
|
+
}
|
|
412
|
+
unauthorized(dataOrMessage, messageOrExtras, extras) {
|
|
413
|
+
return this.failure(StatusCodes.CLIENT_ERROR.UNAUTHORIZED, this.codes.CLIENT, dataOrMessage, messageOrExtras, extras);
|
|
414
|
+
}
|
|
415
|
+
forbidden(dataOrMessage, messageOrExtras, extras) {
|
|
416
|
+
return this.failure(StatusCodes.CLIENT_ERROR.FORBIDDEN, this.codes.CLIENT, dataOrMessage, messageOrExtras, extras);
|
|
417
|
+
}
|
|
418
|
+
notFound(dataOrMessage, messageOrExtras, extras) {
|
|
419
|
+
return this.failure(StatusCodes.CLIENT_ERROR.NOT_FOUND, this.codes.CLIENT, dataOrMessage, messageOrExtras, extras);
|
|
420
|
+
}
|
|
421
|
+
conflict(dataOrMessage, messageOrExtras, extras) {
|
|
422
|
+
return this.failure(StatusCodes.CLIENT_ERROR.CONFLICT, this.codes.CLIENT, dataOrMessage, messageOrExtras, extras);
|
|
423
|
+
}
|
|
424
|
+
unprocessable(dataOrMessage, messageOrExtras, extras) {
|
|
425
|
+
return this.failure(
|
|
426
|
+
StatusCodes.CLIENT_ERROR.UNPROCESSABLE_ENTITY,
|
|
427
|
+
this.codes.VALIDATION,
|
|
428
|
+
dataOrMessage,
|
|
429
|
+
messageOrExtras,
|
|
430
|
+
extras
|
|
431
|
+
);
|
|
432
|
+
}
|
|
433
|
+
tooManyRequests(dataOrMessage, messageOrExtras, extras) {
|
|
434
|
+
return this.failure(StatusCodes.CLIENT_ERROR.TOO_MANY_REQUESTS, this.codes.CLIENT, dataOrMessage, messageOrExtras, extras);
|
|
435
|
+
}
|
|
436
|
+
internalServerError(dataOrMessage, messageOrExtras, extras) {
|
|
437
|
+
return this.failure(
|
|
438
|
+
StatusCodes.SERVER_ERROR.INTERNAL_SERVER_ERROR,
|
|
439
|
+
this.codes.SERVER,
|
|
440
|
+
dataOrMessage,
|
|
441
|
+
messageOrExtras,
|
|
442
|
+
extras
|
|
443
|
+
);
|
|
444
|
+
}
|
|
445
|
+
serviceUnavailable(dataOrMessage, messageOrExtras, extras) {
|
|
446
|
+
return this.failure(
|
|
447
|
+
StatusCodes.SERVER_ERROR.SERVICE_UNAVAILABLE,
|
|
448
|
+
this.codes.SERVER,
|
|
449
|
+
dataOrMessage,
|
|
450
|
+
messageOrExtras,
|
|
451
|
+
extras
|
|
452
|
+
);
|
|
453
|
+
}
|
|
454
|
+
gatewayTimeout(dataOrMessage, messageOrExtras, extras) {
|
|
455
|
+
return this.failure(
|
|
456
|
+
StatusCodes.SERVER_ERROR.GATEWAY_TIMEOUT,
|
|
457
|
+
this.codes.SERVER,
|
|
458
|
+
dataOrMessage,
|
|
459
|
+
messageOrExtras,
|
|
460
|
+
extras
|
|
461
|
+
);
|
|
462
|
+
}
|
|
463
|
+
};
|
|
464
|
+
|
|
465
|
+
// src/errors/error.ts
|
|
466
|
+
var ResponseError = class extends Error {
|
|
467
|
+
code;
|
|
468
|
+
httpStatus;
|
|
469
|
+
payload;
|
|
470
|
+
constructor(options = {}) {
|
|
471
|
+
const codes = createCodeRegistry(options.codes);
|
|
472
|
+
const code = options.code ?? codes.SERVER;
|
|
473
|
+
const message = options.message ?? defaultMessageForCode(code, codes);
|
|
474
|
+
super(message, { cause: options.cause });
|
|
475
|
+
this.name = "ResponseError";
|
|
476
|
+
this.code = code;
|
|
477
|
+
this.httpStatus = options.httpStatus ?? codeToDefaultHttpStatus(code, codes);
|
|
478
|
+
if (options.payload !== void 0) {
|
|
479
|
+
this.payload = options.payload;
|
|
480
|
+
}
|
|
481
|
+
}
|
|
482
|
+
toJSON() {
|
|
483
|
+
return {
|
|
484
|
+
name: this.name,
|
|
485
|
+
message: this.message,
|
|
486
|
+
code: this.code,
|
|
487
|
+
httpStatus: this.httpStatus,
|
|
488
|
+
payload: this.payload
|
|
489
|
+
};
|
|
490
|
+
}
|
|
491
|
+
};
|
|
492
|
+
function isResponseError(value) {
|
|
493
|
+
return value instanceof ResponseError;
|
|
494
|
+
}
|
|
495
|
+
function codeToDefaultHttpStatus(code, codes) {
|
|
496
|
+
if (code === codes.SUCCESS) return 200;
|
|
497
|
+
if (code === codes.CLIENT) return 400;
|
|
498
|
+
if (code === codes.SERVER) return 500;
|
|
499
|
+
if (code === codes.VALIDATION) return 422;
|
|
500
|
+
return 500;
|
|
501
|
+
}
|
|
502
|
+
|
|
503
|
+
// src/core/builder.ts
|
|
504
|
+
var Builder = class {
|
|
505
|
+
dispatcher;
|
|
506
|
+
options;
|
|
507
|
+
context;
|
|
508
|
+
plugins;
|
|
509
|
+
body;
|
|
510
|
+
_statusCode = StatusCodes.SUCCESSFUL.OK;
|
|
511
|
+
_headers = {};
|
|
512
|
+
_cookies = [];
|
|
513
|
+
_presets;
|
|
514
|
+
constructor(dispatcher, options = {}, context) {
|
|
515
|
+
this.dispatcher = dispatcher;
|
|
516
|
+
this.options = resolveBuilderConfig(options);
|
|
517
|
+
this.context = context;
|
|
518
|
+
this.plugins = new PluginRegistry(this.options.plugins);
|
|
519
|
+
this.body = new ResponseDTO();
|
|
520
|
+
}
|
|
521
|
+
get dto() {
|
|
522
|
+
return this.body;
|
|
523
|
+
}
|
|
524
|
+
httpStatus(code) {
|
|
525
|
+
this._statusCode = code;
|
|
526
|
+
this.body.setCodeFromHttpStatus(code, this.options.codes);
|
|
527
|
+
return this;
|
|
528
|
+
}
|
|
529
|
+
code(code) {
|
|
530
|
+
this.body.code(code);
|
|
531
|
+
return this;
|
|
532
|
+
}
|
|
533
|
+
status(value) {
|
|
534
|
+
this.body.status(value);
|
|
535
|
+
return this;
|
|
536
|
+
}
|
|
537
|
+
message(msg) {
|
|
538
|
+
this.body.message(msg);
|
|
539
|
+
return this;
|
|
540
|
+
}
|
|
541
|
+
data(data) {
|
|
542
|
+
this.body.data(data);
|
|
543
|
+
return this;
|
|
544
|
+
}
|
|
545
|
+
payload(partial) {
|
|
546
|
+
this.body.payload(partial);
|
|
547
|
+
return this;
|
|
548
|
+
}
|
|
549
|
+
schema(input = {}) {
|
|
550
|
+
this.body.schema(input, this.options.codes);
|
|
551
|
+
return this;
|
|
552
|
+
}
|
|
553
|
+
setMeta(meta) {
|
|
554
|
+
this.body.setMeta(meta);
|
|
555
|
+
return this;
|
|
556
|
+
}
|
|
557
|
+
withMetadata(options = {}) {
|
|
558
|
+
const generated = MetadataFactory.create(
|
|
559
|
+
{ statusCode: this._statusCode, ...options },
|
|
560
|
+
{ requestId: this.context?.requestId }
|
|
561
|
+
);
|
|
562
|
+
return this.setMeta(generated);
|
|
563
|
+
}
|
|
564
|
+
paginate(total, page, limit) {
|
|
565
|
+
this.body.paginate(total, page, limit);
|
|
566
|
+
return this;
|
|
567
|
+
}
|
|
568
|
+
setHeaders(keyOrHeaders, value) {
|
|
569
|
+
if (typeof keyOrHeaders === "string") {
|
|
570
|
+
if (value !== void 0) {
|
|
571
|
+
this._headers[keyOrHeaders] = value;
|
|
572
|
+
}
|
|
573
|
+
} else {
|
|
574
|
+
this._headers = { ...this._headers, ...keyOrHeaders };
|
|
575
|
+
}
|
|
576
|
+
return this;
|
|
577
|
+
}
|
|
578
|
+
header(key, value) {
|
|
579
|
+
return this.setHeaders(key, value);
|
|
580
|
+
}
|
|
581
|
+
setCookies(nameOrCookies, valueOrOptions, options) {
|
|
582
|
+
if (typeof nameOrCookies === "string") {
|
|
583
|
+
if (typeof valueOrOptions === "string") {
|
|
584
|
+
this._cookies.push({ name: nameOrCookies, value: valueOrOptions, options });
|
|
585
|
+
}
|
|
586
|
+
} else {
|
|
587
|
+
const sharedOptions = typeof valueOrOptions === "object" ? valueOrOptions : void 0;
|
|
588
|
+
for (const [name, value] of Object.entries(nameOrCookies)) {
|
|
589
|
+
this._cookies.push({ name, value, options: sharedOptions });
|
|
590
|
+
}
|
|
591
|
+
}
|
|
592
|
+
return this;
|
|
593
|
+
}
|
|
594
|
+
fromError(error) {
|
|
595
|
+
if (isResponseError(error)) {
|
|
596
|
+
return this.httpStatus(error.httpStatus).code(error.code).message(error.message).payload(error.payload ? { ...error.payload } : {}).data(void 0);
|
|
597
|
+
}
|
|
598
|
+
return this.httpStatus(StatusCodes.SERVER_ERROR.INTERNAL_SERVER_ERROR).code(this.options.codes.SERVER).message(this.resolvePublicErrorMessage(error)).data(void 0);
|
|
599
|
+
}
|
|
600
|
+
async wrap(promise) {
|
|
601
|
+
try {
|
|
602
|
+
this.data(await promise);
|
|
603
|
+
return this;
|
|
604
|
+
} catch (error) {
|
|
605
|
+
this.fromError(error);
|
|
606
|
+
this.options.hooks?.emit("error", {
|
|
607
|
+
error,
|
|
608
|
+
message: this.body.getMessage(),
|
|
609
|
+
statusCode: this._statusCode,
|
|
610
|
+
code: this.body.getCode() ?? resolveCodeFromHttpStatus(this._statusCode, this.options.codes)
|
|
611
|
+
});
|
|
612
|
+
return this;
|
|
613
|
+
}
|
|
614
|
+
}
|
|
615
|
+
transform(fn) {
|
|
616
|
+
const next = this;
|
|
617
|
+
next.body = this.body.transformData(fn);
|
|
618
|
+
return next;
|
|
619
|
+
}
|
|
620
|
+
when(condition, fn) {
|
|
621
|
+
if (condition) fn(this);
|
|
622
|
+
return this;
|
|
623
|
+
}
|
|
624
|
+
get as() {
|
|
625
|
+
if (!this._presets) {
|
|
626
|
+
this._presets = new ResponsePresets(this, this.options.codes);
|
|
627
|
+
}
|
|
628
|
+
return this._presets;
|
|
629
|
+
}
|
|
630
|
+
build() {
|
|
631
|
+
const pluginCtx = this.createPluginContext();
|
|
632
|
+
this.options.hooks?.emit("before_build", { statusCode: this._statusCode });
|
|
633
|
+
this.plugins.runBeforeBuild(pluginCtx);
|
|
634
|
+
const body = this.body.build({
|
|
635
|
+
codes: this.options.codes,
|
|
636
|
+
withDefaultBody: this.options.withDefaultBody,
|
|
637
|
+
httpStatusCode: this._statusCode
|
|
638
|
+
});
|
|
639
|
+
let result = {
|
|
640
|
+
body,
|
|
641
|
+
statusCode: this._statusCode,
|
|
642
|
+
headers: { ...this._headers },
|
|
643
|
+
cookies: [...this._cookies]
|
|
644
|
+
};
|
|
645
|
+
result = this.plugins.runAfterBuild(result, pluginCtx);
|
|
646
|
+
this.emitHook("after_build", result);
|
|
647
|
+
if (this.dispatcher) {
|
|
648
|
+
result = this.plugins.runBeforeDispatch(result, pluginCtx);
|
|
649
|
+
this.emitHook("before_dispatch", result);
|
|
650
|
+
const dispatched = this.dispatcher.dispatch(result);
|
|
651
|
+
this.plugins.runAfterDispatch(result, pluginCtx);
|
|
652
|
+
this.emitHook("after_dispatch", result);
|
|
653
|
+
return dispatched ?? result;
|
|
654
|
+
}
|
|
655
|
+
return result;
|
|
656
|
+
}
|
|
657
|
+
resolvePublicErrorMessage(error) {
|
|
658
|
+
if (!this.options.verbose && !isResponseError(error)) {
|
|
659
|
+
return defaultMessageForCode(this.options.codes.SERVER, this.options.codes);
|
|
660
|
+
}
|
|
661
|
+
if (error instanceof Error) {
|
|
662
|
+
if (this.options.includeStack && error.stack) return error.stack;
|
|
663
|
+
return error.message || defaultMessageForCode(this.options.codes.SERVER, this.options.codes);
|
|
664
|
+
}
|
|
665
|
+
if (typeof error === "string") return error;
|
|
666
|
+
return defaultMessageForCode(this.options.codes.SERVER, this.options.codes);
|
|
667
|
+
}
|
|
668
|
+
createPluginContext() {
|
|
669
|
+
return {
|
|
670
|
+
builder: this,
|
|
671
|
+
context: this.context,
|
|
672
|
+
options: this.options,
|
|
673
|
+
codes: this.options.codes
|
|
674
|
+
};
|
|
675
|
+
}
|
|
676
|
+
emitHook(event, result) {
|
|
677
|
+
const hooks = this.options.hooks;
|
|
678
|
+
if (!hooks?.hasListeners(event)) return;
|
|
679
|
+
hooks.emit(event, structuredClone(result));
|
|
680
|
+
}
|
|
681
|
+
};
|
|
682
|
+
function createBuilderProxy(dispatcher, options = {}, context) {
|
|
683
|
+
const instance = new Builder(dispatcher, options, context);
|
|
684
|
+
return new Proxy(instance, {
|
|
685
|
+
get(target, prop, receiver) {
|
|
686
|
+
const value = Reflect.get(target, prop, receiver);
|
|
687
|
+
if (typeof value === "function") {
|
|
688
|
+
return value.bind(target);
|
|
689
|
+
}
|
|
690
|
+
return value;
|
|
691
|
+
}
|
|
692
|
+
});
|
|
693
|
+
}
|
|
694
|
+
|
|
695
|
+
// src/adapters/shared.ts
|
|
696
|
+
function createBuilderRuntime(dispatcher, options, context) {
|
|
697
|
+
const builderOptions = {
|
|
698
|
+
verbose: options.verbose,
|
|
699
|
+
includeStack: options.includeStack,
|
|
700
|
+
withDefaultBody: options.withDefaultBody,
|
|
701
|
+
codes: options.codes,
|
|
702
|
+
hooks: options.hooks,
|
|
703
|
+
plugins: options.plugins
|
|
704
|
+
};
|
|
705
|
+
return {
|
|
706
|
+
context,
|
|
707
|
+
codes: resolveBuilderConfig(builderOptions).codes,
|
|
708
|
+
builder: createBuilderProxy(dispatcher, builderOptions, context)
|
|
709
|
+
};
|
|
710
|
+
}
|
|
711
|
+
|
|
712
|
+
// src/adapters/websocket.ts
|
|
713
|
+
var WS_OPEN = 1;
|
|
714
|
+
var WebSocketDispatcher = class {
|
|
715
|
+
socket;
|
|
716
|
+
constructor(socket) {
|
|
717
|
+
this.socket = socket;
|
|
718
|
+
}
|
|
719
|
+
dispatch(result) {
|
|
720
|
+
if (this.socket.readyState !== void 0 && this.socket.readyState !== WS_OPEN) {
|
|
721
|
+
return result;
|
|
722
|
+
}
|
|
723
|
+
this.socket.send(JSON.stringify(result.body));
|
|
724
|
+
return result;
|
|
725
|
+
}
|
|
726
|
+
};
|
|
727
|
+
var WebSocketAdapter = class {
|
|
728
|
+
options;
|
|
729
|
+
constructor(options = {}) {
|
|
730
|
+
this.options = options;
|
|
731
|
+
}
|
|
732
|
+
attach(socket, requestId) {
|
|
733
|
+
const context = requestId ? ContextFactory.fromId(requestId) : ContextFactory.fromId(generateUUID());
|
|
734
|
+
const runtime = createBuilderRuntime(
|
|
735
|
+
new WebSocketDispatcher(socket),
|
|
736
|
+
this.options,
|
|
737
|
+
context
|
|
738
|
+
);
|
|
739
|
+
socket.ctx = runtime.context;
|
|
740
|
+
socket.builder = runtime.builder;
|
|
741
|
+
return runtime;
|
|
742
|
+
}
|
|
743
|
+
handler() {
|
|
744
|
+
return (socket, next) => {
|
|
745
|
+
this.attach(socket);
|
|
746
|
+
next?.();
|
|
747
|
+
};
|
|
748
|
+
}
|
|
749
|
+
};
|
|
750
|
+
function websocketMiddleware(options = {}) {
|
|
751
|
+
return new WebSocketAdapter(options).handler();
|
|
752
|
+
}
|
|
753
|
+
|
|
754
|
+
export { WS_OPEN, WebSocketAdapter, WebSocketDispatcher, websocketMiddleware };
|