franchising 0.0.0-stage → 0.1.0
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 +61 -0
- package/README.md +88 -2
- package/dist/accounts-B4bnTXUd.js +242 -0
- package/dist/accounts-B4bnTXUd.js.map +1 -0
- package/dist/accounts-TyMPSHM0.cjs +313 -0
- package/dist/accounts-TyMPSHM0.cjs.map +1 -0
- package/dist/adapters-DM59AJfR.d.cts +216 -0
- package/dist/adapters-DM59AJfR.d.ts +216 -0
- package/dist/cli/template-assets/api/src/errors/codes.ts +17 -0
- package/dist/cli/template-assets/api/src/errors/index.ts +16 -0
- package/dist/cli/template-assets/api/src/filters/exception.ts +53 -0
- package/dist/cli/template-assets/api/src/main.ts +189 -0
- package/dist/cli/template-assets/api/src/modules/health/controller.ts +23 -0
- package/dist/cli/template-assets/api/src/modules/health/dto/response.dto.ts +23 -0
- package/dist/cli/template-assets/api/src/modules/health/module.ts +12 -0
- package/dist/cli/template-assets/api/src/modules/health/service.ts +54 -0
- package/dist/cli/template-assets/api/src/modules/messaging/module.ts +7 -0
- package/dist/cli/template-assets/api/src/modules/messaging/service.ts +74 -0
- package/dist/cli/template-assets/api/src/shared/exceptions.ts +40 -0
- package/dist/cli/template-assets/api/src/shared/response.ts +31 -0
- package/dist/cli/template-assets/api/src/telemetry.ts +59 -0
- package/dist/cli/template-assets/api/src/types.ts +8 -0
- package/dist/cli/template-assets/cloudflare/cache.service.ts +23 -0
- package/dist/cli/template-assets/cloudflare/queue.service.ts +22 -0
- package/dist/cli/template-assets/cloudflare/worker.ts +33 -0
- package/dist/cli/template-assets/packages/jobs/src/index.ts +49 -0
- package/dist/cli/template-assets/packages/queue-runtime/src/index.ts +54 -0
- package/dist/cli/template-assets/root/dot-dockerignore +11 -0
- package/dist/cli/template-assets/root/dot-editorconfig +13 -0
- package/dist/cli/template-assets/root/dot-oxfmtrc.json +9 -0
- package/dist/cli/template-assets/root/dot-oxlintrc.json +47 -0
- package/dist/cli/template-assets/root/lefthook.yml +18 -0
- package/dist/cli/template-assets/web/postcss.config.mjs +9 -0
- package/dist/cli/template-assets/web/src/app/(app)/dashboard/page.tsx +5 -0
- package/dist/cli/template-assets/web/src/app/(app)/layout.tsx +25 -0
- package/dist/cli/template-assets/web/src/app/(auth)/login/page.tsx +75 -0
- package/dist/cli/template-assets/web/src/app/globals.css +48 -0
- package/dist/cli/template-assets/web/src/app/layout.tsx +30 -0
- package/dist/cli/template-assets/web/src/app/page.tsx +20 -0
- package/dist/cli/template-assets/web/src/components/overview/overview-panel.tsx +27 -0
- package/dist/cli/template-assets/web/src/components/shell/app-shell.tsx +37 -0
- package/dist/cli/template-assets/web/src/components/shell/providers.tsx +22 -0
- package/dist/cli/template-assets/web/src/lib/api-client.ts +57 -0
- package/dist/cli/template-assets/web/src/lib/auth-client.ts +15 -0
- package/dist/cli/template-assets/web/src/lib/server-auth.ts +38 -0
- package/dist/cli/template-assets/web/src/types/api.ts +18 -0
- package/dist/cli/template-assets/worker/src/app.module.ts +5 -0
- package/dist/cli/template-assets/worker/src/env.ts +8 -0
- package/dist/cli/template-assets/worker/src/main.ts +25 -0
- package/dist/cli/template-assets/worker/src/modules/queue/config.ts +16 -0
- package/dist/cli/template-assets/worker/src/modules/queue/module.ts +11 -0
- package/dist/cli/template-assets/worker/src/modules/queue/processor.ts +105 -0
- package/dist/cli/template-assets/worker/src/modules/queue/repository.ts +16 -0
- package/dist/cli/template-assets/worker/src/modules/queue/retry.ts +17 -0
- package/dist/cli/template-assets/worker/test/retry.test.ts.tpl +12 -0
- package/dist/cli/template-assets/worker-messaging/jobs-messaging.ts +12 -0
- package/dist/cli/template-assets/worker-messaging/messaging-api-service.ts +39 -0
- package/dist/cli/template-assets/worker-messaging/src/env.ts +14 -0
- package/dist/cli/template-assets/worker-messaging/src/modules/messaging/service.ts +59 -0
- package/dist/cli/template-assets/worker-messaging/src/modules/queue/module.ts +8 -0
- package/dist/cli/template-assets/worker-messaging/src/modules/queue/processor.ts +113 -0
- package/dist/cli.js +1218 -0
- package/dist/cn-BVOnrSza.js +1 -0
- package/dist/constants-C4iP0--i.js +38 -0
- package/dist/constants-C4iP0--i.js.map +1 -0
- package/dist/constants-rCR-LNSN.cjs +91 -0
- package/dist/constants-rCR-LNSN.cjs.map +1 -0
- package/dist/decorate-BR5FVX5x.js +14 -0
- package/dist/decorate-R-oqksAh.cjs +25 -0
- package/dist/decorateParam-BFJPEGKJ.cjs +13 -0
- package/dist/decorateParam-CKE7_J1s.js +8 -0
- package/dist/define-adapter-Cc0QrfKt.cjs +16 -0
- package/dist/define-adapter-Cc0QrfKt.cjs.map +1 -0
- package/dist/define-adapter-DRcXno3j.js +11 -0
- package/dist/define-adapter-DRcXno3j.js.map +1 -0
- package/dist/dispatcher-BsD7cO2w.cjs +84 -0
- package/dist/dispatcher-BsD7cO2w.cjs.map +1 -0
- package/dist/dispatcher-DA_l1Vkv.js +73 -0
- package/dist/dispatcher-DA_l1Vkv.js.map +1 -0
- package/dist/errors-DxHoXrLd.d.cts +46 -0
- package/dist/errors-DxHoXrLd.d.ts +46 -0
- package/dist/http/index.cjs +440 -0
- package/dist/http/index.cjs.map +1 -0
- package/dist/http/index.d.cts +257 -0
- package/dist/http/index.d.ts +257 -0
- package/dist/http/index.js +400 -0
- package/dist/http/index.js.map +1 -0
- package/dist/http/swagger.cjs +122 -0
- package/dist/http/swagger.cjs.map +1 -0
- package/dist/http/swagger.d.cts +59 -0
- package/dist/http/swagger.d.ts +59 -0
- package/dist/http/swagger.js +117 -0
- package/dist/http/swagger.js.map +1 -0
- package/dist/index-B3UOHsA9.d.ts +679 -0
- package/dist/index-Bdl0AiNM.d.ts +1262 -0
- package/dist/index-By8b4ksT.d.ts +25 -0
- package/dist/index-C1KmT8dQ.d.ts +174 -0
- package/dist/index-CYT1PFzo.d.cts +679 -0
- package/dist/index-Cj-10Q5F.d.cts +174 -0
- package/dist/index-DDSaLjXV.d.cts +25 -0
- package/dist/index-FTrYdHfq.d.cts +1262 -0
- package/dist/index.cjs +1 -0
- package/dist/index.d.cts +4 -0
- package/dist/index.d.ts +4 -0
- package/dist/index.js +1 -0
- package/dist/label-BqmJoVE-.cjs +1 -0
- package/dist/label-XeChe1Bu.js +1 -0
- package/dist/messaging/index.cjs +1 -0
- package/dist/messaging/index.d.cts +1775 -0
- package/dist/messaging/index.d.ts +1775 -0
- package/dist/messaging/index.js +1 -0
- package/dist/misc-BpM_lMTx.js +1 -0
- package/dist/misc-DkqJOm1V.cjs +1 -0
- package/dist/operational-CnxdBwVG.d.cts +13 -0
- package/dist/operational-CnxdBwVG.d.ts +13 -0
- package/dist/redaction-DhuHTlHA.js +124 -0
- package/dist/redaction-DhuHTlHA.js.map +1 -0
- package/dist/redaction-uRIQbTwZ.cjs +171 -0
- package/dist/redaction-uRIQbTwZ.cjs.map +1 -0
- package/dist/rolldown-runtime-auK_WOaK.cjs +1 -0
- package/dist/rolldown-runtime-xuxB8TGW.cjs +32 -0
- package/dist/runtime-C95UYYLb.cjs +111 -0
- package/dist/runtime-C95UYYLb.cjs.map +1 -0
- package/dist/runtime-DG2oBFYw.js +88 -0
- package/dist/runtime-DG2oBFYw.js.map +1 -0
- package/dist/skills-C1uwr9Pp.js +4 -0
- package/dist/skills-DuE-XnBp.js +1 -0
- package/dist/sso/client.cjs +37 -0
- package/dist/sso/client.cjs.map +1 -0
- package/dist/sso/client.d.cts +90 -0
- package/dist/sso/client.d.ts +90 -0
- package/dist/sso/client.js +36 -0
- package/dist/sso/client.js.map +1 -0
- package/dist/sso/index.cjs +833 -0
- package/dist/sso/index.cjs.map +1 -0
- package/dist/sso/index.d.cts +3 -0
- package/dist/sso/index.d.ts +3 -0
- package/dist/sso/index.js +821 -0
- package/dist/sso/index.js.map +1 -0
- package/dist/sso/nestjs.cjs +169 -0
- package/dist/sso/nestjs.cjs.map +1 -0
- package/dist/sso/nestjs.d.cts +92 -0
- package/dist/sso/nestjs.d.ts +92 -0
- package/dist/sso/nestjs.js +151 -0
- package/dist/sso/nestjs.js.map +1 -0
- package/dist/sso/resource.cjs +124 -0
- package/dist/sso/resource.cjs.map +1 -0
- package/dist/sso/resource.d.cts +3 -0
- package/dist/sso/resource.d.ts +3 -0
- package/dist/sso/resource.js +114 -0
- package/dist/sso/resource.js.map +1 -0
- package/dist/status-CRvlFPIs.js +13 -0
- package/dist/status-CRvlFPIs.js.map +1 -0
- package/dist/status-DtK6OHtj.cjs +24 -0
- package/dist/status-DtK6OHtj.cjs.map +1 -0
- package/dist/team-CJVAg4HH.d.cts +157 -0
- package/dist/team-CJVAg4HH.d.ts +157 -0
- package/dist/telemetry/adapters.cjs +6 -0
- package/dist/telemetry/adapters.d.cts +3 -0
- package/dist/telemetry/adapters.d.ts +3 -0
- package/dist/telemetry/adapters.js +4 -0
- package/dist/telemetry/betterstack.cjs +74 -0
- package/dist/telemetry/betterstack.cjs.map +1 -0
- package/dist/telemetry/betterstack.d.cts +12 -0
- package/dist/telemetry/betterstack.d.ts +12 -0
- package/dist/telemetry/betterstack.js +71 -0
- package/dist/telemetry/betterstack.js.map +1 -0
- package/dist/telemetry/index.cjs +1237 -0
- package/dist/telemetry/index.cjs.map +1 -0
- package/dist/telemetry/index.d.cts +114 -0
- package/dist/telemetry/index.d.ts +114 -0
- package/dist/telemetry/index.js +1205 -0
- package/dist/telemetry/index.js.map +1 -0
- package/dist/telemetry/posthog.cjs +72 -0
- package/dist/telemetry/posthog.cjs.map +1 -0
- package/dist/telemetry/posthog.d.cts +10 -0
- package/dist/telemetry/posthog.d.ts +10 -0
- package/dist/telemetry/posthog.js +71 -0
- package/dist/telemetry/posthog.js.map +1 -0
- package/dist/telemetry/register.cjs +6 -0
- package/dist/telemetry/register.d.cts +14 -0
- package/dist/telemetry/register.d.ts +14 -0
- package/dist/telemetry/register.js +3 -0
- package/dist/telemetry/testing.cjs +54 -0
- package/dist/telemetry/testing.cjs.map +1 -0
- package/dist/telemetry/testing.d.cts +15 -0
- package/dist/telemetry/testing.d.ts +15 -0
- package/dist/telemetry/testing.js +52 -0
- package/dist/telemetry/testing.js.map +1 -0
- package/dist/telemetry.mock-BSsx7L6S.cjs +45 -0
- package/dist/telemetry.mock-BSsx7L6S.cjs.map +1 -0
- package/dist/telemetry.mock-BZRpy63c.js +40 -0
- package/dist/telemetry.mock-BZRpy63c.js.map +1 -0
- package/dist/telemetry.mock-C1wXuf-M.d.cts +4 -0
- package/dist/telemetry.mock-CdaxofJ7.d.ts +4 -0
- package/dist/ui/chart.cjs +6 -0
- package/dist/ui/chart.d.cts +34 -0
- package/dist/ui/chart.d.ts +34 -0
- package/dist/ui/chart.js +6 -0
- package/dist/ui/form.cjs +1 -0
- package/dist/ui/form.d.cts +23 -0
- package/dist/ui/form.d.ts +23 -0
- package/dist/ui/form.js +1 -0
- package/dist/ui/hooks.cjs +1 -0
- package/dist/ui/hooks.d.cts +66 -0
- package/dist/ui/hooks.d.ts +66 -0
- package/dist/ui/hooks.js +1 -0
- package/dist/ui/index.cjs +1 -0
- package/dist/ui/index.d.cts +3 -0
- package/dist/ui/index.d.ts +3 -0
- package/dist/ui/index.js +1 -0
- package/dist/ui/styles.css +2 -0
- package/dist/ui/utils.cjs +1 -0
- package/dist/ui/utils.d.cts +199 -0
- package/dist/ui/utils.d.ts +199 -0
- package/dist/ui/utils.js +1 -0
- package/dist/use-mobile-BbeIMRgE.cjs +1 -0
- package/dist/use-mobile-Cdd4Lp7p.js +1 -0
- package/dist/use-mobile-ecpyXWz3.d.cts +10 -0
- package/dist/use-mobile-ecpyXWz3.d.ts +10 -0
- package/dist/verifier-BIBtPCVi.cjs +119 -0
- package/dist/verifier-BIBtPCVi.cjs.map +1 -0
- package/dist/verifier-DNdy5Ynw.js +90 -0
- package/dist/verifier-DNdy5Ynw.js.map +1 -0
- package/dist/version-CPunTYCY.js +1 -0
- package/dist/version-CfUi3iAV.cjs +1 -0
- package/package.json +523 -5
|
@@ -0,0 +1,400 @@
|
|
|
1
|
+
import { n as isErrorStatus, t as assertErrorStatus } from "../status-CRvlFPIs.js";
|
|
2
|
+
import { n as __decorateMetadata, t as __decorate } from "../decorate-BR5FVX5x.js";
|
|
3
|
+
import { t as __decorateParam } from "../decorateParam-CKE7_J1s.js";
|
|
4
|
+
import { Catch, HttpException, Inject, Logger, Module, Optional } from "@nestjs/common";
|
|
5
|
+
import { APP_FILTER } from "@nestjs/core";
|
|
6
|
+
import { createHmac, timingSafeEqual } from "node:crypto";
|
|
7
|
+
|
|
8
|
+
// src/modules/http/shared/guards.ts
|
|
9
|
+
function isRecord(value) {
|
|
10
|
+
return typeof value === "object" && value !== null;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
// src/modules/http/shared/definitions.ts
|
|
14
|
+
function buildDefinitions(inputs, reserved = /* @__PURE__ */ new Set()) {
|
|
15
|
+
const definitions = {};
|
|
16
|
+
for (const [code, input] of Object.entries(inputs)) {
|
|
17
|
+
if (reserved.has(code)) throw new TypeError(`defineErrors: "${code}" is reserved for the built-in common errors. Pick another name.`);
|
|
18
|
+
const definition = typeof input === "string" ? { message: input } : input;
|
|
19
|
+
if (!isRecord(definition) || typeof definition.message !== "string" || definition.message === "") throw new TypeError(`defineErrors: "${code}" needs a message.`);
|
|
20
|
+
const status = "status" in definition && definition.status !== void 0 ? assertErrorStatus(definition.status, `defineErrors: "${code}"`) : void 0;
|
|
21
|
+
definitions[code] = Object.freeze({
|
|
22
|
+
code,
|
|
23
|
+
message: definition.message,
|
|
24
|
+
...status === void 0 ? {} : { status }
|
|
25
|
+
});
|
|
26
|
+
}
|
|
27
|
+
return Object.freeze(definitions);
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
// src/modules/http/errors/common.ts
|
|
31
|
+
const CommonErrors = buildDefinitions({
|
|
32
|
+
BadRequest: "Bad request",
|
|
33
|
+
InvalidCursor: "Invalid cursor",
|
|
34
|
+
Unauthorized: "Authentication required",
|
|
35
|
+
Forbidden: "Access denied",
|
|
36
|
+
NotFound: "Resource not found",
|
|
37
|
+
MethodNotAllowed: "Method not allowed",
|
|
38
|
+
RequestTimeout: "Request timed out",
|
|
39
|
+
Conflict: "Conflict with the current state",
|
|
40
|
+
Gone: "Resource is gone",
|
|
41
|
+
PayloadTooLarge: "Payload too large",
|
|
42
|
+
UnsupportedMediaType: "Unsupported media type",
|
|
43
|
+
ValidationFailed: "Validation failed",
|
|
44
|
+
TooManyRequests: "Too many requests",
|
|
45
|
+
RequestFailed: "Request failed",
|
|
46
|
+
InternalError: "Internal server error",
|
|
47
|
+
NotImplemented: "Not implemented",
|
|
48
|
+
BadGateway: "Bad gateway",
|
|
49
|
+
ServiceUnavailable: "Service unavailable",
|
|
50
|
+
GatewayTimeout: "Gateway timeout"
|
|
51
|
+
});
|
|
52
|
+
const RESERVED_CODES = new Set(Object.keys(CommonErrors));
|
|
53
|
+
|
|
54
|
+
// src/modules/http/errors/define.ts
|
|
55
|
+
function defineErrors(inputs) {
|
|
56
|
+
return buildDefinitions(inputs, RESERVED_CODES);
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
// src/modules/http/response/error.ts
|
|
60
|
+
function error(definition, extra) {
|
|
61
|
+
return {
|
|
62
|
+
ok: false,
|
|
63
|
+
error: {
|
|
64
|
+
code: definition.code,
|
|
65
|
+
message: definition.message,
|
|
66
|
+
...extra === void 0 ? {} : { extra }
|
|
67
|
+
}
|
|
68
|
+
};
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
// src/modules/http/shared/headers.ts
|
|
72
|
+
const TOKEN = /^[!#$%&'*+\-.^_`|~0-9A-Za-z]+$/;
|
|
73
|
+
const LINE_BREAK = /[\r\n]/;
|
|
74
|
+
const FORBIDDEN = /* @__PURE__ */ new Set([
|
|
75
|
+
"content-type",
|
|
76
|
+
"content-length",
|
|
77
|
+
"transfer-encoding"
|
|
78
|
+
]);
|
|
79
|
+
function normalizeHeaders(headers) {
|
|
80
|
+
const result = {};
|
|
81
|
+
for (const [name, value] of Object.entries(headers ?? {})) {
|
|
82
|
+
if (!TOKEN.test(name)) throw new TypeError(`Invalid header name: ${JSON.stringify(name)}.`);
|
|
83
|
+
if (FORBIDDEN.has(name.toLowerCase())) throw new TypeError(`The "${name}" header cannot be set on an error.`);
|
|
84
|
+
const text = String(value);
|
|
85
|
+
if (LINE_BREAK.test(text)) throw new TypeError(`Header "${name}" has a line break in its value.`);
|
|
86
|
+
result[name] = text;
|
|
87
|
+
}
|
|
88
|
+
return Object.freeze(result);
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
// src/modules/http/errors/http-error.ts
|
|
92
|
+
var HttpError = class extends HttpException {
|
|
93
|
+
name = "HttpError";
|
|
94
|
+
code;
|
|
95
|
+
extra;
|
|
96
|
+
headers;
|
|
97
|
+
constructor(definition, status, extra, headers) {
|
|
98
|
+
super(error(definition, extra), assertErrorStatus(status, `HttpError "${definition.code}"`));
|
|
99
|
+
this.message = definition.message;
|
|
100
|
+
this.code = definition.code;
|
|
101
|
+
this.extra = extra;
|
|
102
|
+
this.headers = normalizeHeaders(headers);
|
|
103
|
+
}
|
|
104
|
+
};
|
|
105
|
+
|
|
106
|
+
// src/modules/http/errors/functions.ts
|
|
107
|
+
function createErrorFunction(defaultStatus) {
|
|
108
|
+
assertErrorStatus(defaultStatus, "error function default");
|
|
109
|
+
return (definition, options) => {
|
|
110
|
+
const requested = typeof options === "number" ? options : options?.status;
|
|
111
|
+
const extra = typeof options === "object" ? options.extra : void 0;
|
|
112
|
+
const headers = typeof options === "object" ? options.headers : void 0;
|
|
113
|
+
return new HttpError(definition, requested ?? definition.status ?? defaultStatus, extra, headers);
|
|
114
|
+
};
|
|
115
|
+
}
|
|
116
|
+
const badRequest = createErrorFunction(400);
|
|
117
|
+
const unauthorized = createErrorFunction(401);
|
|
118
|
+
const forbidden = createErrorFunction(403);
|
|
119
|
+
const notFound = createErrorFunction(404);
|
|
120
|
+
const methodNotAllowed = createErrorFunction(405);
|
|
121
|
+
const requestTimeout = createErrorFunction(408);
|
|
122
|
+
const conflict = createErrorFunction(409);
|
|
123
|
+
const gone = createErrorFunction(410);
|
|
124
|
+
const payloadTooLarge = createErrorFunction(413);
|
|
125
|
+
const unsupportedMediaType = createErrorFunction(415);
|
|
126
|
+
const validation = createErrorFunction(422);
|
|
127
|
+
const tooManyRequests = createErrorFunction(429);
|
|
128
|
+
const internalError = createErrorFunction(500);
|
|
129
|
+
const notImplemented = createErrorFunction(501);
|
|
130
|
+
const badGateway = createErrorFunction(502);
|
|
131
|
+
const serviceUnavailable = createErrorFunction(503);
|
|
132
|
+
const gatewayTimeout = createErrorFunction(504);
|
|
133
|
+
|
|
134
|
+
// src/modules/http/shared/di/tokens.ts
|
|
135
|
+
const ERRORS_OPTIONS = Symbol("ERRORS_OPTIONS");
|
|
136
|
+
|
|
137
|
+
// src/modules/http/shared/http/exception.ts
|
|
138
|
+
const CODE_BY_STATUS = {
|
|
139
|
+
400: CommonErrors.BadRequest,
|
|
140
|
+
401: CommonErrors.Unauthorized,
|
|
141
|
+
403: CommonErrors.Forbidden,
|
|
142
|
+
404: CommonErrors.NotFound,
|
|
143
|
+
405: CommonErrors.MethodNotAllowed,
|
|
144
|
+
408: CommonErrors.RequestTimeout,
|
|
145
|
+
409: CommonErrors.Conflict,
|
|
146
|
+
410: CommonErrors.Gone,
|
|
147
|
+
413: CommonErrors.PayloadTooLarge,
|
|
148
|
+
415: CommonErrors.UnsupportedMediaType,
|
|
149
|
+
422: CommonErrors.ValidationFailed,
|
|
150
|
+
429: CommonErrors.TooManyRequests,
|
|
151
|
+
500: CommonErrors.InternalError,
|
|
152
|
+
501: CommonErrors.NotImplemented,
|
|
153
|
+
502: CommonErrors.BadGateway,
|
|
154
|
+
503: CommonErrors.ServiceUnavailable,
|
|
155
|
+
504: CommonErrors.GatewayTimeout
|
|
156
|
+
};
|
|
157
|
+
function commonErrorForStatus(status) {
|
|
158
|
+
return CODE_BY_STATUS[status] ?? (status >= 500 ? CommonErrors.InternalError : CommonErrors.RequestFailed);
|
|
159
|
+
}
|
|
160
|
+
function validationMessages(status, response) {
|
|
161
|
+
if (status !== 400 && status !== 422) return null;
|
|
162
|
+
if (!isRecord(response) || !Array.isArray(response.message)) return null;
|
|
163
|
+
return response.message.every((item) => typeof item === "string") ? response.message : null;
|
|
164
|
+
}
|
|
165
|
+
function platformStatus(exception) {
|
|
166
|
+
if (!isRecord(exception) || exception.expose !== true) return null;
|
|
167
|
+
const status = exception.statusCode ?? exception.status;
|
|
168
|
+
return isErrorStatus(status) && status < 500 ? status : null;
|
|
169
|
+
}
|
|
170
|
+
function messageOf(exception, response) {
|
|
171
|
+
if (typeof response === "string") return response;
|
|
172
|
+
if (isRecord(response) && typeof response.message === "string") return response.message;
|
|
173
|
+
if (isRecord(response) && Array.isArray(response.message)) return response.message.join(". ");
|
|
174
|
+
return exception.message;
|
|
175
|
+
}
|
|
176
|
+
function normalizeException(exception) {
|
|
177
|
+
if (exception instanceof HttpError) return {
|
|
178
|
+
status: exception.getStatus(),
|
|
179
|
+
body: exception.getResponse(),
|
|
180
|
+
headers: exception.headers
|
|
181
|
+
};
|
|
182
|
+
if (!(exception instanceof HttpException)) {
|
|
183
|
+
const status = platformStatus(exception);
|
|
184
|
+
if (status === null) return {
|
|
185
|
+
status: 500,
|
|
186
|
+
body: error(CommonErrors.InternalError)
|
|
187
|
+
};
|
|
188
|
+
const common = commonErrorForStatus(status);
|
|
189
|
+
return {
|
|
190
|
+
status,
|
|
191
|
+
body: error({
|
|
192
|
+
code: common.code,
|
|
193
|
+
message: exception instanceof Error && exception.message ? exception.message : common.message
|
|
194
|
+
})
|
|
195
|
+
};
|
|
196
|
+
}
|
|
197
|
+
const raw = exception.getStatus();
|
|
198
|
+
const status = isErrorStatus(raw) ? raw : 500;
|
|
199
|
+
if (status >= 500) return {
|
|
200
|
+
status,
|
|
201
|
+
body: error(commonErrorForStatus(status))
|
|
202
|
+
};
|
|
203
|
+
const response = exception.getResponse();
|
|
204
|
+
const messages = validationMessages(status, response);
|
|
205
|
+
if (messages) return {
|
|
206
|
+
status,
|
|
207
|
+
body: error(CommonErrors.ValidationFailed, messages)
|
|
208
|
+
};
|
|
209
|
+
return {
|
|
210
|
+
status,
|
|
211
|
+
body: error({
|
|
212
|
+
code: commonErrorForStatus(status).code,
|
|
213
|
+
message: messageOf(exception, response)
|
|
214
|
+
})
|
|
215
|
+
};
|
|
216
|
+
}
|
|
217
|
+
|
|
218
|
+
// src/modules/http/shared/http/reply.ts
|
|
219
|
+
function sendJson(response, status, body, headers = {}) {
|
|
220
|
+
const reply = response;
|
|
221
|
+
if (reply.headersSent || reply.sent) return;
|
|
222
|
+
for (const [name, value] of Object.entries(headers)) if (typeof reply.setHeader === "function") reply.setHeader(name, value);
|
|
223
|
+
else if (typeof reply.header === "function") reply.header(name, value);
|
|
224
|
+
const target = reply.status?.(status) ?? reply.code?.(status) ?? reply;
|
|
225
|
+
if (typeof target.json === "function") target.json(body);
|
|
226
|
+
else if (typeof target.send === "function") target.send(body);
|
|
227
|
+
}
|
|
228
|
+
|
|
229
|
+
// src/modules/http/filters/error.ts
|
|
230
|
+
let ErrorFilter = class ErrorFilter {
|
|
231
|
+
logger = new Logger("ErrorFilter");
|
|
232
|
+
options;
|
|
233
|
+
constructor(options = {}) {
|
|
234
|
+
this.options = options;
|
|
235
|
+
}
|
|
236
|
+
catch(exception, host) {
|
|
237
|
+
if (host.getType() !== "http") throw exception;
|
|
238
|
+
const { status, body, headers } = normalizeException(exception);
|
|
239
|
+
if (status >= 500) this.logger.error(exception instanceof Error ? exception.stack ?? exception.message : String(exception));
|
|
240
|
+
this.notify(exception, {
|
|
241
|
+
status,
|
|
242
|
+
code: body.error.code
|
|
243
|
+
});
|
|
244
|
+
sendJson(host.switchToHttp().getResponse(), status, body, headers);
|
|
245
|
+
}
|
|
246
|
+
notify(exception, context) {
|
|
247
|
+
const onError = this.options.onError;
|
|
248
|
+
if (!onError) return;
|
|
249
|
+
try {
|
|
250
|
+
Promise.resolve(onError(exception, context)).catch(() => void 0);
|
|
251
|
+
} catch {}
|
|
252
|
+
}
|
|
253
|
+
};
|
|
254
|
+
ErrorFilter = __decorate([
|
|
255
|
+
Catch(),
|
|
256
|
+
__decorateParam(0, Optional()),
|
|
257
|
+
__decorateParam(0, Inject(ERRORS_OPTIONS)),
|
|
258
|
+
__decorateMetadata("design:paramtypes", [Object])
|
|
259
|
+
], ErrorFilter);
|
|
260
|
+
|
|
261
|
+
// src/modules/http/module.ts
|
|
262
|
+
var _ErrorsModule;
|
|
263
|
+
let ErrorsModule = _ErrorsModule = class ErrorsModule {
|
|
264
|
+
static forRoot(options = {}) {
|
|
265
|
+
return _ErrorsModule.build([{
|
|
266
|
+
provide: ERRORS_OPTIONS,
|
|
267
|
+
useValue: options
|
|
268
|
+
}]);
|
|
269
|
+
}
|
|
270
|
+
static forRootAsync(options) {
|
|
271
|
+
return _ErrorsModule.build([{
|
|
272
|
+
provide: ERRORS_OPTIONS,
|
|
273
|
+
useFactory: options.useFactory,
|
|
274
|
+
inject: options.inject ?? []
|
|
275
|
+
}], options.imports);
|
|
276
|
+
}
|
|
277
|
+
static build(options, imports = []) {
|
|
278
|
+
return {
|
|
279
|
+
module: _ErrorsModule,
|
|
280
|
+
global: true,
|
|
281
|
+
imports,
|
|
282
|
+
providers: [
|
|
283
|
+
...options,
|
|
284
|
+
ErrorFilter,
|
|
285
|
+
{
|
|
286
|
+
provide: APP_FILTER,
|
|
287
|
+
useExisting: ErrorFilter
|
|
288
|
+
}
|
|
289
|
+
],
|
|
290
|
+
exports: [ErrorFilter]
|
|
291
|
+
};
|
|
292
|
+
}
|
|
293
|
+
};
|
|
294
|
+
ErrorsModule = _ErrorsModule = __decorate([Module({})], ErrorsModule);
|
|
295
|
+
|
|
296
|
+
// src/modules/http/shared/cursor-edge.ts
|
|
297
|
+
const DEFAULT_MAX_CURSOR_LENGTH = 2048;
|
|
298
|
+
function isCursorValue(value) {
|
|
299
|
+
return value === null || typeof value === "string" || typeof value === "boolean" || typeof value === "number" && Number.isFinite(value);
|
|
300
|
+
}
|
|
301
|
+
function isEdge(value) {
|
|
302
|
+
if (!isRecord(value) || Array.isArray(value)) return false;
|
|
303
|
+
const proto = Object.getPrototypeOf(value);
|
|
304
|
+
return (proto === Object.prototype || proto === null) && !Object.hasOwn(value, "__proto__") && Object.values(value).every(isCursorValue);
|
|
305
|
+
}
|
|
306
|
+
|
|
307
|
+
// src/modules/http/shared/cursor-signature.ts
|
|
308
|
+
const SIGNATURE_SEPARATOR = ".";
|
|
309
|
+
function assertSecret(secret) {
|
|
310
|
+
if (secret === "") throw new TypeError("Cursor secret must not be an empty string.");
|
|
311
|
+
}
|
|
312
|
+
function sign(payload, secret) {
|
|
313
|
+
return createHmac("sha256", secret).update(payload).digest("base64url");
|
|
314
|
+
}
|
|
315
|
+
function readPayload(cursor, secret) {
|
|
316
|
+
if (secret === void 0) return cursor.includes(".") ? null : cursor;
|
|
317
|
+
const parts = cursor.split(".");
|
|
318
|
+
const [payload, signature] = parts;
|
|
319
|
+
if (parts.length !== 2 || !payload || !signature) return null;
|
|
320
|
+
const given = Buffer.from(signature);
|
|
321
|
+
const expected = Buffer.from(sign(payload, secret));
|
|
322
|
+
return given.length === expected.length && timingSafeEqual(given, expected) ? payload : null;
|
|
323
|
+
}
|
|
324
|
+
|
|
325
|
+
// src/modules/http/pagination/decode-cursor.ts
|
|
326
|
+
function decodeCursor(cursor, options = {}) {
|
|
327
|
+
assertSecret(options.secret);
|
|
328
|
+
if (cursor === void 0 || cursor === null || cursor === "") return null;
|
|
329
|
+
const invalid = () => badRequest(CommonErrors.InvalidCursor);
|
|
330
|
+
if (typeof cursor !== "string" || cursor.length > (options.maxLength ?? 2048)) throw invalid();
|
|
331
|
+
const payload = readPayload(cursor, options.secret);
|
|
332
|
+
if (payload === null) throw invalid();
|
|
333
|
+
let edge;
|
|
334
|
+
try {
|
|
335
|
+
edge = JSON.parse(Buffer.from(payload, "base64url").toString("utf8"));
|
|
336
|
+
} catch {
|
|
337
|
+
throw invalid();
|
|
338
|
+
}
|
|
339
|
+
if (!isEdge(edge)) throw invalid();
|
|
340
|
+
let accepted = true;
|
|
341
|
+
try {
|
|
342
|
+
accepted = options.validate?.(edge) !== false;
|
|
343
|
+
} catch {
|
|
344
|
+
accepted = false;
|
|
345
|
+
}
|
|
346
|
+
if (!accepted) throw invalid();
|
|
347
|
+
return edge;
|
|
348
|
+
}
|
|
349
|
+
|
|
350
|
+
// src/modules/http/pagination/encode-cursor.ts
|
|
351
|
+
function encodeCursor(edge, options = {}) {
|
|
352
|
+
assertSecret(options.secret);
|
|
353
|
+
if (!isEdge(edge)) throw new TypeError("encodeCursor: the edge must be a flat object of strings, finite numbers, booleans and null (dates as ISO strings).");
|
|
354
|
+
const payload = Buffer.from(JSON.stringify(edge)).toString("base64url");
|
|
355
|
+
const cursor = options.secret === void 0 ? payload : `${payload}${"."}${sign(payload, options.secret)}`;
|
|
356
|
+
const maxLength = options.maxLength ?? 2048;
|
|
357
|
+
if (cursor.length > maxLength) throw new TypeError(`encodeCursor: the cursor has ${cursor.length} characters, over the maxLength of ${maxLength}. Keep only the sort keys in the edge.`);
|
|
358
|
+
return cursor;
|
|
359
|
+
}
|
|
360
|
+
|
|
361
|
+
// src/modules/http/response/guards.ts
|
|
362
|
+
function isOk(response) {
|
|
363
|
+
return isRecord(response) && response.ok === true && "data" in response;
|
|
364
|
+
}
|
|
365
|
+
function isError(response) {
|
|
366
|
+
return isRecord(response) && response.ok === false && isRecord(response.error) && typeof response.error.code === "string" && typeof response.error.message === "string";
|
|
367
|
+
}
|
|
368
|
+
|
|
369
|
+
// src/modules/http/shared/pagination.ts
|
|
370
|
+
function normalizePagination(input) {
|
|
371
|
+
const before = input.before ? input.before : void 0;
|
|
372
|
+
const next = input.next ? input.next : void 0;
|
|
373
|
+
return {
|
|
374
|
+
...before === void 0 ? {} : { before },
|
|
375
|
+
...next === void 0 ? {} : { next },
|
|
376
|
+
persist: input.persist ?? next !== void 0
|
|
377
|
+
};
|
|
378
|
+
}
|
|
379
|
+
|
|
380
|
+
// src/modules/http/response/ok.ts
|
|
381
|
+
function ok(data, pagination) {
|
|
382
|
+
if (pagination === void 0) return {
|
|
383
|
+
ok: true,
|
|
384
|
+
data
|
|
385
|
+
};
|
|
386
|
+
return {
|
|
387
|
+
ok: true,
|
|
388
|
+
data,
|
|
389
|
+
pagination: normalizePagination(pagination)
|
|
390
|
+
};
|
|
391
|
+
}
|
|
392
|
+
|
|
393
|
+
// src/modules/http/shared/request-id.ts
|
|
394
|
+
const REQUEST_ID_HEADER = "x-request-id";
|
|
395
|
+
function generateRequestId() {
|
|
396
|
+
return crypto.randomUUID();
|
|
397
|
+
}
|
|
398
|
+
|
|
399
|
+
export { CommonErrors, ErrorFilter, ErrorsModule, HttpError, REQUEST_ID_HEADER, badGateway, badRequest, conflict, decodeCursor, defineErrors, encodeCursor, error, forbidden, gatewayTimeout, generateRequestId, gone, internalError, isError, isOk, methodNotAllowed, notFound, notImplemented, ok, payloadTooLarge, requestTimeout, serviceUnavailable, tooManyRequests, unauthorized, unsupportedMediaType, validation };
|
|
400
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","names":[],"sources":["../../src/modules/http/shared/guards.ts","../../src/modules/http/shared/definitions.ts","../../src/modules/http/errors/common.ts","../../src/modules/http/errors/define.ts","../../src/modules/http/response/error.ts","../../src/modules/http/shared/headers.ts","../../src/modules/http/errors/http-error.ts","../../src/modules/http/errors/functions.ts","../../src/modules/http/shared/di/tokens.ts","../../src/modules/http/shared/http/exception.ts","../../src/modules/http/shared/http/reply.ts","../../src/modules/http/filters/error.ts","../../src/modules/http/module.ts","../../src/modules/http/shared/cursor-edge.ts","../../src/modules/http/shared/cursor-signature.ts","../../src/modules/http/pagination/decode-cursor.ts","../../src/modules/http/pagination/encode-cursor.ts","../../src/modules/http/response/guards.ts","../../src/modules/http/shared/pagination.ts","../../src/modules/http/response/ok.ts","../../src/modules/http/shared/request-id.ts"],"mappings":";;;;;;;;AAAA,SAAgB,SAAS,OAAkD;CAC1E,OAAO,OAAO,UAAU,YAAY,UAAU;AAC/C;;;ACUA,SAAgB,iBACf,QACA,2BAAgC,IAAI,IAAI,GAChB;CACxB,MAAM,cAA+C,CAAC;CAEtD,KAAK,MAAM,CAAC,MAAM,UAAU,OAAO,QAAQ,MAAM,GAAG;EACnD,IAAI,SAAS,IAAI,IAAI,GACpB,MAAM,IAAI,UACT,kBAAkB,KAAK,iEACxB;EAED,MAAM,aACL,OAAO,UAAU,WAAW,EAAE,SAAS,MAAM,IAAI;EAElD,IACC,CAAC,SAAS,UAAU,KACpB,OAAO,WAAW,YAAY,YAC9B,WAAW,YAAY,IAEvB,MAAM,IAAI,UAAU,kBAAkB,KAAK,mBAAmB;EAE/D,MAAM,SACL,YAAY,cAAc,WAAW,WAAW,KAAK,IAClD,kBACA,WAAW,QACX,kBAAkB,KAAK,EACxB,IACC,KAAK;EAET,YAAY,QAAQ,OAAO,OAAO;GACjC;GACA,SAAS,WAAW;GACpB,GAAI,WAAW,KAAK,IAAI,CAAC,IAAI,EAAE,OAAO;EACvC,CAAC;CACF;CAEA,OAAO,OAAO,OAAO,WAAW;AACjC;;;ACzCA,MAAa,eAAe,iBAAiB;CAC5C,YAAY;CACZ,eAAe;CACf,cAAc;CACd,WAAW;CACX,UAAU;CACV,kBAAkB;CAClB,gBAAgB;CAChB,UAAU;CACV,MAAM;CACN,iBAAiB;CACjB,sBAAsB;CACtB,kBAAkB;CAClB,iBAAiB;CACjB,eAAe;CACf,eAAe;CACf,gBAAgB;CAChB,YAAY;CACZ,oBAAoB;CACpB,gBAAgB;AACjB,CAAC;AAGD,MAAa,iBAAsC,IAAI,IACtD,OAAO,KAAK,YAAY,CACzB;;;ACnBA,SAAgB,aACf,QACwB;CACxB,OAAO,iBAAiB,QAAQ,cAAc;AAC/C;;;ACfA,SAAgB,MACf,YACA,OACgB;CAChB,OAAO;EACN,IAAI;EACJ,OAAO;GACN,MAAM,WAAW;GACjB,SAAS,WAAW;GACpB,GAAI,UAAU,KAAK,IAAI,CAAC,IAAI,EAAE,MAAM;EACrC;CACD;AACD;;;ACdA,MAAM,QAAQ;AACd,MAAM,aAAa;AAGnB,MAAM,4BAAY,IAAI,IAAI;CACzB;CACA;CACA;AACD,CAAC;AAOD,SAAgB,iBACf,SACmC;CACnC,MAAM,SAAiC,CAAC;CAExC,KAAK,MAAM,CAAC,MAAM,UAAU,OAAO,QAAQ,WAAW,CAAC,CAAC,GAAG;EAC1D,IAAI,CAAC,MAAM,KAAK,IAAI,GACnB,MAAM,IAAI,UACT,wBAAwB,KAAK,UAAU,IAAI,EAAE,EAC9C;EACD,IAAI,UAAU,IAAI,KAAK,YAAY,CAAC,GACnC,MAAM,IAAI,UACT,QAAQ,KAAK,oCACd;EAED,MAAM,OAAO,OAAO,KAAK;EAEzB,IAAI,WAAW,KAAK,IAAI,GACvB,MAAM,IAAI,UACT,WAAW,KAAK,iCACjB;EAED,OAAO,QAAQ;CAChB;CAEA,OAAO,OAAO,OAAO,MAAM;AAC5B;;;AChCA,IAAa,YAAb,cAA+B,cAAc;CAC5C,AAAkB,OAAO;CAEzB,AAAS;CACT,AAAS;CAET,AAAS;CAET,YACC,YACA,QACA,OACA,SACC;EACD,MACC,MAAM,YAAY,KAAK,GACvB,kBAAkB,QAAQ,cAAc,WAAW,KAAK,EAAE,CAC3D;EAEA,KAAK,UAAU,WAAW;EAC1B,KAAK,OAAO,WAAW;EACvB,KAAK,QAAQ;EACb,KAAK,UAAU,iBAAiB,OAAO;CACxC;AACD;;;ACrBA,SAAS,oBAAoB,eAAsC;CAClE,kBAAkB,eAAe,wBAAwB;CAEzD,QAAQ,YAA6B,YAA2B;EAC/D,MAAM,YACL,OAAO,YAAY,WAAW,UAAU,SAAS;EAClD,MAAM,QAAQ,OAAO,YAAY,WAAW,QAAQ,QAAQ,KAAK;EACjE,MAAM,UAAU,OAAO,YAAY,WAAW,QAAQ,UAAU,KAAK;EAErE,OAAO,IAAI,UACV,YACA,aAAa,WAAW,UAAU,eAClC,OACA,OACD;CACD;AACD;AAGA,MAAa,aAAa,oBAAoB,GAAG;AAGjD,MAAa,eAAe,oBAAoB,GAAG;AAGnD,MAAa,YAAY,oBAAoB,GAAG;AAGhD,MAAa,WAAW,oBAAoB,GAAG;AAG/C,MAAa,mBAAmB,oBAAoB,GAAG;AAGvD,MAAa,iBAAiB,oBAAoB,GAAG;AAGrD,MAAa,WAAW,oBAAoB,GAAG;AAG/C,MAAa,OAAO,oBAAoB,GAAG;AAG3C,MAAa,kBAAkB,oBAAoB,GAAG;AAGtD,MAAa,uBAAuB,oBAAoB,GAAG;AAG3D,MAAa,aAAa,oBAAoB,GAAG;AAGjD,MAAa,kBAAkB,oBAAoB,GAAG;AAGtD,MAAa,gBAAgB,oBAAoB,GAAG;AAGpD,MAAa,iBAAiB,oBAAoB,GAAG;AAGrD,MAAa,aAAa,oBAAoB,GAAG;AAGjD,MAAa,qBAAqB,oBAAoB,GAAG;AAGzD,MAAa,iBAAiB,oBAAoB,GAAG;;;ACjFrD,MAAa,iBAAiB,OAAO,gBAAgB;;;ACUrD,MAAM,iBAAkD;CACvD,KAAK,aAAa;CAClB,KAAK,aAAa;CAClB,KAAK,aAAa;CAClB,KAAK,aAAa;CAClB,KAAK,aAAa;CAClB,KAAK,aAAa;CAClB,KAAK,aAAa;CAClB,KAAK,aAAa;CAClB,KAAK,aAAa;CAClB,KAAK,aAAa;CAClB,KAAK,aAAa;CAClB,KAAK,aAAa;CAClB,KAAK,aAAa;CAClB,KAAK,aAAa;CAClB,KAAK,aAAa;CAClB,KAAK,aAAa;CAClB,KAAK,aAAa;AACnB;AAGA,SAAgB,qBAAqB,QAAiC;CACrE,OACC,eAAe,YACd,UAAU,MACR,aAAa,gBACb,aAAa;AAElB;AAWA,SAAS,mBACR,QACA,UACkB;CAClB,IAAI,WAAW,OAAO,WAAW,KAAK,OAAO;CAC7C,IAAI,CAAC,SAAS,QAAQ,KAAK,CAAC,MAAM,QAAQ,SAAS,OAAO,GAAG,OAAO;CAEpE,OAAO,SAAS,QAAQ,OAAO,SAAS,OAAO,SAAS,QAAQ,IAC5D,SAAS,UACV;AACJ;AAQA,SAAS,eAAe,WAAmC;CAC1D,IAAI,CAAC,SAAS,SAAS,KAAK,UAAU,WAAW,MAAM,OAAO;CAE9D,MAAM,SAAS,UAAU,cAAc,UAAU;CAEjD,OAAO,cAAc,MAAM,KAAK,SAAS,MAAM,SAAS;AACzD;AAEA,SAAS,UAAU,WAA0B,UAA2B;CACvE,IAAI,OAAO,aAAa,UAAU,OAAO;CACzC,IAAI,SAAS,QAAQ,KAAK,OAAO,SAAS,YAAY,UACrD,OAAO,SAAS;CACjB,IAAI,SAAS,QAAQ,KAAK,MAAM,QAAQ,SAAS,OAAO,GACvD,OAAO,SAAS,QAAQ,KAAK,IAAI;CAElC,OAAO,UAAU;AAClB;AAOA,SAAgB,mBAAmB,WAAyC;CAC3E,IAAI,qBAAqB,WACxB,OAAO;EACN,QAAQ,UAAU,UAAU;EAC5B,MAAM,UAAU,YAAY;EAC5B,SAAS,UAAU;CACpB;CAED,IAAI,EAAE,qBAAqB,gBAAgB;EAC1C,MAAM,SAAS,eAAe,SAAS;EAEvC,IAAI,WAAW,MACd,OAAO;GAAE,QAAQ;GAAK,MAAM,MAAM,aAAa,aAAa;EAAE;EAE/D,MAAM,SAAS,qBAAqB,MAAM;EAE1C,OAAO;GACN;GACA,MAAM,MAAM;IACX,MAAM,OAAO;IACb,SACC,qBAAqB,SAAS,UAAU,UACrC,UAAU,UACV,OAAO;GACZ,CAAC;EACF;CACD;CAEA,MAAM,MAAM,UAAU,UAAU;CAChC,MAAM,SAAS,cAAc,GAAG,IAAI,MAAM;CAE1C,IAAI,UAAU,KACb,OAAO;EAAE;EAAQ,MAAM,MAAM,qBAAqB,MAAM,CAAC;CAAE;CAE5D,MAAM,WAAW,UAAU,YAAY;CACvC,MAAM,WAAW,mBAAmB,QAAQ,QAAQ;CAEpD,IAAI,UACH,OAAO;EACN;EACA,MAAM,MAAM,aAAa,kBAAkB,QAAQ;CACpD;CAED,OAAO;EACN;EACA,MAAM,MAAM;GACX,MAAM,qBAAqB,MAAM,CAAC,CAAC;GACnC,SAAS,UAAU,WAAW,QAAQ;EACvC,CAAC;CACF;AACD;;;AC7HA,SAAgB,SACf,UACA,QACA,MACA,UAA4C,CAAC,GACtC;CACP,MAAM,QAAQ;CAEd,IAAI,MAAM,eAAe,MAAM,MAAM;CAErC,KAAK,MAAM,CAAC,MAAM,UAAU,OAAO,QAAQ,OAAO,GACjD,IAAI,OAAO,MAAM,cAAc,YAAY,MAAM,UAAU,MAAM,KAAK;MACjE,IAAI,OAAO,MAAM,WAAW,YAAY,MAAM,OAAO,MAAM,KAAK;CAEtE,MAAM,SAAU,MAAM,SAAS,MAAM,KACpC,MAAM,OAAO,MAAM,KACnB;CAED,IAAI,OAAO,OAAO,SAAS,YAAY,OAAO,KAAK,IAAI;MAClD,IAAI,OAAO,OAAO,SAAS,YAAY,OAAO,KAAK,IAAI;AAC7D;;;ACNO,IAAM,cAAN,MAAM,YAAuC;CACnD,AAAiB,SAAS,IAAI,OAAO,aAAa;CAClD,AAAiB;CAEjB,YACC,AAAoC,UAA8B,CAAC,GAClE;EACD,KAAK,UAAU;CAChB;CAEA,MAAM,WAAoB,MAA2B;EACpD,IAAI,KAAK,QAAQ,MAAM,QAAQ,MAAM;EAErC,MAAM,EAAE,QAAQ,MAAM,YAAY,mBAAmB,SAAS;EAE9D,IAAI,UAAU,KACb,KAAK,OAAO,MACX,qBAAqB,QACjB,UAAU,SAAS,UAAU,UAC9B,OAAO,SAAS,CACpB;EAED,KAAK,OAAO,WAAW;GAAE;GAAQ,MAAM,KAAK,MAAM;EAAK,CAAC;EAExD,SAAS,KAAK,aAAa,CAAC,CAAC,YAAY,GAAG,QAAQ,MAAM,OAAO;CAClE;CAGA,AAAQ,OAAO,WAAoB,SAA6B;EAC/D,MAAM,UAAU,KAAK,QAAQ;EAE7B,IAAI,CAAC,SAAS;EAEd,IAAI;GACH,AAAK,QAAQ,QAAQ,QAAQ,WAAW,OAAO,CAAC,CAAC,CAAC,YAC3C,KAAK,CACZ;EACD,QAAQ,CAER;CACD;AACD;;CA1CC,MAAM;oBAMJ,SAAS;oBAAG,OAAO,cAAc;;;;;;AChB7B,IAAM,+BAAN,MAAM,aAAa;CACzB,OAAO,QAAQ,UAA+B,CAAC,GAAkB;EAChE,qBAAoB,MAAM,CACzB;GAAE,SAAS;GAAgB,UAAU;EAAQ,CAC9C,CAAC;CACF;CAgBA,OAAO,aAAa,SAAkD;EACrE,qBAAoB,MACnB,CACC;GACC,SAAS;GACT,YAAY,QAAQ;GACpB,QAAQ,QAAQ,UAAU,CAAC;EAC5B,CACD,GACA,QAAQ,OACT;CACD;CAEA,OAAe,MACd,SACA,UAAoC,CAAC,GACrB;EAChB,OAAO;GACN;GACA,QAAQ;GACR;GACA,WAAW;IACV,GAAG;IACH;IACA;KAAE,SAAS;KAAY,aAAa;IAAY;GACjD;GACA,SAAS,CAAC,WAAW;EACtB;CACD;AACD;2CAnDC,OAAO,CAAC,CAAC;;;ACbV,MAAa,4BAA4B;AAEzC,SAAS,cAAc,OAAsC;CAC5D,OACC,UAAU,QACV,OAAO,UAAU,YACjB,OAAO,UAAU,aAChB,OAAO,UAAU,YAAY,OAAO,SAAS,KAAK;AAErD;AAQA,SAAgB,OAAO,OAAqC;CAC3D,IAAI,CAAC,SAAS,KAAK,KAAK,MAAM,QAAQ,KAAK,GAAG,OAAO;CAErD,MAAM,QAAQ,OAAO,eAAe,KAAK;CAEzC,QACE,UAAU,OAAO,aAAa,UAAU,SACzC,CAAC,OAAO,OAAO,OAAO,WAAW,KACjC,OAAO,OAAO,KAAK,CAAC,CAAC,MAAM,aAAa;AAE1C;;;AC5BA,MAAa,sBAAsB;AAEnC,SAAgB,aAAa,QAAkC;CAC9D,IAAI,WAAW,IACd,MAAM,IAAI,UAAU,4CAA4C;AAClE;AAEA,SAAgB,KAAK,SAAiB,QAAwB;CAC7D,OAAO,WAAW,UAAU,MAAM,CAAC,CAAC,OAAO,OAAO,CAAC,CAAC,OAAO,WAAW;AACvE;AAOA,SAAgB,YACf,QACA,QACgB;CAChB,IAAI,WAAW,KAAK,GACnB,OAAO,OAAO,YAA4B,IAAI,OAAO;CAEtD,MAAM,QAAQ,OAAO,SAAyB;CAC9C,MAAM,CAAC,SAAS,aAAa;CAE7B,IAAI,MAAM,WAAW,KAAK,CAAC,WAAW,CAAC,WAAW,OAAO;CAOzD,MAAM,QAAQ,OAAO,KAAK,SAAS;CACnC,MAAM,WAAW,OAAO,KAAK,KAAK,SAAS,MAAM,CAAC;CAElD,OAAO,MAAM,WAAW,SAAS,UAAU,gBAAgB,OAAO,QAAQ,IACvE,UACA;AACJ;;;ACtBA,SAAgB,aACf,QACA,UAAqC,CAAC,GACxB;CACd,aAAa,QAAQ,MAAM;CAE3B,IAAI,WAAW,KAAK,KAAK,WAAW,QAAQ,WAAW,IAAI,OAAO;CAElE,MAAM,gBAAgB,WAAW,aAAa,aAAa;CAE3D,IACC,OAAO,WAAW,YAClB,OAAO,UAAU,QAAQ,oBAEzB,MAAM,QAAQ;CAEf,MAAM,UAAU,YAAY,QAAQ,QAAQ,MAAM;CAElD,IAAI,YAAY,MAAM,MAAM,QAAQ;CAEpC,IAAI;CAEJ,IAAI;EACH,OAAO,KAAK,MAAM,OAAO,KAAK,SAAS,WAAW,CAAC,CAAC,SAAS,MAAM,CAAC;CACrE,QAAQ;EACP,MAAM,QAAQ;CACf;CAEA,IAAI,CAAC,OAAO,IAAI,GAAG,MAAM,QAAQ;CAEjC,IAAI,WAAW;CAEf,IAAI;EACH,WAAW,QAAQ,WAAW,IAAI,MAAM;CACzC,QAAQ;EACP,WAAW;CACZ;CAEA,IAAI,CAAC,UAAU,MAAM,QAAQ;CAE7B,OAAO;AACR;;;ACxCA,SAAgB,aACf,MACA,UAAyB,CAAC,GACjB;CACT,aAAa,QAAQ,MAAM;CAE3B,IAAI,CAAC,OAAO,IAAI,GACf,MAAM,IAAI,UACT,oHACD;CAED,MAAM,UAAU,OAAO,KAAK,KAAK,UAAU,IAAI,CAAC,CAAC,CAAC,SAAS,WAAW;CACtE,MAAM,SACL,QAAQ,WAAW,KAAK,IACrB,UACA,GAAG,gBAAgC,KAAK,SAAS,QAAQ,MAAM;CAEnE,MAAM,YAAY,QAAQ;CAE1B,IAAI,OAAO,SAAS,WACnB,MAAM,IAAI,UACT,gCAAgC,OAAO,OAAO,qCAAqC,UAAU,uCAC9F;CAED,OAAO;AACR;;;ACpCA,SAAgB,KAAK,UAA4B;CAChD,OAAO,SAAS,QAAQ,KAAK,SAAS,OAAO,QAAQ,UAAU;AAChE;AAGA,SAAgB,QAAQ,UAA8C;CACrE,OACC,SAAS,QAAQ,KACjB,SAAS,OAAO,SAChB,SAAS,SAAS,KAAK,KACvB,OAAO,SAAS,MAAM,SAAS,YAC/B,OAAO,SAAS,MAAM,YAAY;AAEpC;;;ACjBA,SAAgB,oBAAoB,OAA+B;CAClE,MAAM,SAAS,MAAM,SAAS,MAAM,SAAS,KAAK;CAClD,MAAM,OAAO,MAAM,OAAO,MAAM,OAAO,KAAK;CAE5C,OAAO;EACN,GAAI,WAAW,KAAK,IAAI,CAAC,IAAI,EAAE,OAAO;EACtC,GAAI,SAAS,KAAK,IAAI,CAAC,IAAI,EAAE,KAAK;EAClC,SAAS,MAAM,WAAW,SAAS,KAAK;CACzC;AACD;;;ACRA,SAAgB,GACf,MACA,YACmB;CACnB,IAAI,eAAe,KAAK,GAAG,OAAO;EAAE,IAAI;EAAM;CAAK;CAEnD,OAAO;EAAE,IAAI;EAAM;EAAM,YAAY,oBAAoB,UAAU;CAAE;AACtE;;;ACbA,MAAa,oBAAoB;AAGjC,SAAgB,oBAA4B;CAC3C,OAAO,OAAO,WAAW;AAC1B"}
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
|
|
2
|
+
const require_decorate = require("../decorate-R-oqksAh.cjs");
|
|
3
|
+
const require_status = require("../status-DtK6OHtj.cjs");
|
|
4
|
+
let _nestjs_common = require("@nestjs/common");
|
|
5
|
+
let _nestjs_swagger = require("@nestjs/swagger");
|
|
6
|
+
|
|
7
|
+
// src/modules/http/swagger/models.ts
|
|
8
|
+
var PaginationDTO = class {
|
|
9
|
+
before;
|
|
10
|
+
next;
|
|
11
|
+
persist;
|
|
12
|
+
};
|
|
13
|
+
require_decorate.__decorate([(0, _nestjs_swagger.ApiProperty)({
|
|
14
|
+
required: false,
|
|
15
|
+
description: "Cursor of the previous page.",
|
|
16
|
+
example: "c0"
|
|
17
|
+
}), require_decorate.__decorateMetadata("design:type", String)], PaginationDTO.prototype, "before", void 0);
|
|
18
|
+
require_decorate.__decorate([(0, _nestjs_swagger.ApiProperty)({
|
|
19
|
+
required: false,
|
|
20
|
+
description: "Cursor of the next page.",
|
|
21
|
+
example: "c2"
|
|
22
|
+
}), require_decorate.__decorateMetadata("design:type", String)], PaginationDTO.prototype, "next", void 0);
|
|
23
|
+
require_decorate.__decorate([(0, _nestjs_swagger.ApiProperty)({
|
|
24
|
+
description: "True while there is more to fetch (`next` has data).",
|
|
25
|
+
example: true
|
|
26
|
+
}), require_decorate.__decorateMetadata("design:type", Boolean)], PaginationDTO.prototype, "persist", void 0);
|
|
27
|
+
var ErrorBodyDTO = class {
|
|
28
|
+
code;
|
|
29
|
+
message;
|
|
30
|
+
extra;
|
|
31
|
+
};
|
|
32
|
+
require_decorate.__decorate([(0, _nestjs_swagger.ApiProperty)({
|
|
33
|
+
description: "A code defined with `defineErrors`.",
|
|
34
|
+
example: "InvalidProjectSlug"
|
|
35
|
+
}), require_decorate.__decorateMetadata("design:type", String)], ErrorBodyDTO.prototype, "code", void 0);
|
|
36
|
+
require_decorate.__decorate([(0, _nestjs_swagger.ApiProperty)({ example: "Invalid project slug" }), require_decorate.__decorateMetadata("design:type", String)], ErrorBodyDTO.prototype, "message", void 0);
|
|
37
|
+
require_decorate.__decorate([(0, _nestjs_swagger.ApiProperty)({
|
|
38
|
+
required: false,
|
|
39
|
+
description: "Anything extra about the failure, e.g. validation errors."
|
|
40
|
+
}), require_decorate.__decorateMetadata("design:type", Object)], ErrorBodyDTO.prototype, "extra", void 0);
|
|
41
|
+
var ErrorResponseDTO = class {
|
|
42
|
+
ok;
|
|
43
|
+
error;
|
|
44
|
+
};
|
|
45
|
+
require_decorate.__decorate([(0, _nestjs_swagger.ApiProperty)({
|
|
46
|
+
enum: [false],
|
|
47
|
+
example: false
|
|
48
|
+
}), require_decorate.__decorateMetadata("design:type", Boolean)], ErrorResponseDTO.prototype, "ok", void 0);
|
|
49
|
+
require_decorate.__decorate([(0, _nestjs_swagger.ApiProperty)({ type: () => ErrorBodyDTO }), require_decorate.__decorateMetadata("design:type", typeof ErrorBodyDTO === "undefined" ? Object : ErrorBodyDTO)], ErrorResponseDTO.prototype, "error", void 0);
|
|
50
|
+
|
|
51
|
+
// src/modules/http/swagger/envelope.ts
|
|
52
|
+
const PRIMITIVES = /* @__PURE__ */ new Map([
|
|
53
|
+
[String, "string"],
|
|
54
|
+
[Number, "number"],
|
|
55
|
+
[Boolean, "boolean"]
|
|
56
|
+
]);
|
|
57
|
+
function itemSchema(data) {
|
|
58
|
+
if (data === null) return {
|
|
59
|
+
nullable: true,
|
|
60
|
+
type: "object"
|
|
61
|
+
};
|
|
62
|
+
const primitive = PRIMITIVES.get(data);
|
|
63
|
+
return primitive ? { type: primitive } : { $ref: (0, _nestjs_swagger.getSchemaPath)(data) };
|
|
64
|
+
}
|
|
65
|
+
function APIEnvelope(data, options = {}) {
|
|
66
|
+
const item = itemSchema(data);
|
|
67
|
+
return (0, _nestjs_common.applyDecorators)((0, _nestjs_swagger.ApiExtraModels)(PaginationDTO, ...typeof data === "function" && !PRIMITIVES.has(data) ? [data] : []), (0, _nestjs_swagger.ApiOkResponse)({
|
|
68
|
+
description: options.description ?? "Success",
|
|
69
|
+
schema: {
|
|
70
|
+
type: "object",
|
|
71
|
+
required: [
|
|
72
|
+
"ok",
|
|
73
|
+
"data",
|
|
74
|
+
...options.paginated ? ["pagination"] : []
|
|
75
|
+
],
|
|
76
|
+
properties: {
|
|
77
|
+
ok: {
|
|
78
|
+
type: "boolean",
|
|
79
|
+
enum: [true],
|
|
80
|
+
example: true
|
|
81
|
+
},
|
|
82
|
+
data: options.isArray ? {
|
|
83
|
+
type: "array",
|
|
84
|
+
items: item
|
|
85
|
+
} : item,
|
|
86
|
+
...options.paginated ? { pagination: { $ref: (0, _nestjs_swagger.getSchemaPath)(PaginationDTO) } } : {}
|
|
87
|
+
}
|
|
88
|
+
}
|
|
89
|
+
}));
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
// src/modules/http/swagger/errors.ts
|
|
93
|
+
function APIErrors(byStatus) {
|
|
94
|
+
const responses = Object.entries(byStatus).map(([key, definitions]) => {
|
|
95
|
+
const status = require_status.assertErrorStatus(Number(key), "@APIErrors");
|
|
96
|
+
return (0, _nestjs_swagger.ApiResponse)({
|
|
97
|
+
status,
|
|
98
|
+
description: definitions.map((definition) => definition.code).join(", "),
|
|
99
|
+
content: { "application/json": {
|
|
100
|
+
schema: { $ref: (0, _nestjs_swagger.getSchemaPath)(ErrorResponseDTO) },
|
|
101
|
+
examples: Object.fromEntries(definitions.map((definition) => [definition.code, {
|
|
102
|
+
summary: definition.code,
|
|
103
|
+
value: {
|
|
104
|
+
ok: false,
|
|
105
|
+
error: {
|
|
106
|
+
code: definition.code,
|
|
107
|
+
message: definition.message
|
|
108
|
+
}
|
|
109
|
+
}
|
|
110
|
+
}]))
|
|
111
|
+
} }
|
|
112
|
+
});
|
|
113
|
+
});
|
|
114
|
+
return (0, _nestjs_common.applyDecorators)((0, _nestjs_swagger.ApiExtraModels)(ErrorResponseDTO, ErrorBodyDTO), ...responses);
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
exports.APIEnvelope = APIEnvelope;
|
|
118
|
+
exports.APIErrors = APIErrors;
|
|
119
|
+
exports.ErrorBodyDTO = ErrorBodyDTO;
|
|
120
|
+
exports.ErrorResponseDTO = ErrorResponseDTO;
|
|
121
|
+
exports.PaginationDTO = PaginationDTO;
|
|
122
|
+
//# sourceMappingURL=swagger.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"swagger.cjs","names":["ApiProperty","getSchemaPath","applyDecorators","ApiExtraModels","ApiOkResponse","assertErrorStatus","ApiResponse","getSchemaPath","applyDecorators","ApiExtraModels"],"sources":["../../src/modules/http/swagger/models.ts","../../src/modules/http/swagger/envelope.ts","../../src/modules/http/swagger/errors.ts"],"mappings":";;;;;;;AAGA,IAAa,gBAAb,MAA2B;CAC1B,AAKA;CAEA,AAKA;CAEA,AAIA;AACD;iCAnBEA,6BAAY;CACZ,UAAU;CACV,aAAa;CACb,SAAS;AACV,CAAC;iCAGAA,6BAAY;CACZ,UAAU;CACV,aAAa;CACb,SAAS;AACV,CAAC;iCAGAA,6BAAY;CACZ,aAAa;CACb,SAAS;AACV,CAAC;AAKF,IAAa,eAAb,MAA0B;CACzB,AAIA;CAEA,AACA;CAEA,AAKA;AACD;iCAfEA,6BAAY;CACZ,aAAa;CACb,SAAS;AACV,CAAC;iCAGAA,6BAAY,EAAE,SAAS,uBAAuB,CAAC;iCAG/CA,6BAAY;CACZ,UAAU;CACV,aACC;AACF,CAAC;AAKF,IAAa,mBAAb,MAA8B;CAC7B,AACA;CAEA,AACA;AACD;iCALEA,6BAAY;CAAE,MAAM,CAAC,KAAK;CAAG,SAAS;AAAM,CAAC;iCAG7CA,6BAAY,EAAE,YAAY,aAAa,CAAC;;;AC3B1C,MAAM,6BAAa,IAAI,IAAqB;CAC3C,CAAC,QAAQ,QAAQ;CACjB,CAAC,QAAQ,QAAQ;CACjB,CAAC,SAAS,SAAS;AACpB,CAAC;AAED,SAAS,WAAW,MAAuB;CAC1C,IAAI,SAAS,MAAM,OAAO;EAAE,UAAU;EAAM,MAAM;CAAS;CAE3D,MAAM,YAAY,WAAW,IAAI,IAAI;CAErC,OAAO,YACJ,EAAE,MAAM,UAAU,IAClB,EAAE,UAAMC,+BAAc,IAAqB,EAAE;AACjD;AAYA,SAAgB,YACf,MACA,UAA8B,CAAC,GACI;CACnC,MAAM,OAAO,WAAW,IAAI;CAE5B,WAAOC,oCACNC,gCACC,eACA,GAAI,OAAO,SAAS,cAAc,CAAC,WAAW,IAAI,IAAI,IACnD,CAAC,IAAqB,IACtB,CAAC,CACL,OACAC,+BAAc;EACb,aAAa,QAAQ,eAAe;EACpC,QAAQ;GACP,MAAM;GACN,UAAU;IACT;IACA;IACA,GAAI,QAAQ,YAAY,CAAC,YAAY,IAAI,CAAC;GAC3C;GACA,YAAY;IACX,IAAI;KAAE,MAAM;KAAW,MAAM,CAAC,IAAI;KAAG,SAAS;IAAK;IACnD,MAAM,QAAQ,UACX;KAAE,MAAM;KAAS,OAAO;IAAK,IAC7B;IACH,GAAI,QAAQ,YACT,EAAE,YAAY,EAAE,UAAMH,+BAAc,aAAa,EAAE,EAAE,IACrD,CAAC;GACL;EACD;CACD,CAAC,CACF;AACD;;;AC1DA,SAAgB,UACf,UACmC;CACnC,MAAM,YAAY,OAAO,QAAQ,QAAQ,CAAC,CAAC,KAAK,CAAC,KAAK,iBAAiB;EACtE,MAAM,SAASI,iCAAkB,OAAO,GAAG,GAAG,YAAY;EAE1D,WAAOC,6BAAY;GAClB;GACA,aAAa,YACX,KAAK,eAAe,WAAW,IAAI,CAAC,CACpC,KAAK,IAAI;GACX,SAAS,EACR,oBAAoB;IACnB,QAAQ,EAAE,UAAMC,+BAAc,gBAAgB,EAAE;IAChD,UAAU,OAAO,YAChB,YAAY,KAAK,eAAe,CAC/B,WAAW,MACX;KACC,SAAS,WAAW;KACpB,OAAO;MACN,IAAI;MACJ,OAAO;OACN,MAAM,WAAW;OACjB,SAAS,WAAW;MACrB;KACD;IACD,CACD,CAAC,CACF;GACD,EACD;EACD,CAAC;CACF,CAAC;CAED,WAAOC,oCACNC,gCAAe,kBAAkB,YAAY,GAC7C,GAAG,SACJ;AACD"}
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
import { r as ErrorDefinition } from "../errors-DxHoXrLd.cjs";
|
|
2
|
+
import { Type } from "@nestjs/common";
|
|
3
|
+
/** What `data` holds: a DTO class, a primitive constructor, or `null`. */
|
|
4
|
+
type APIEnvelopeData = Type<unknown> | StringConstructor | NumberConstructor | BooleanConstructor | null;
|
|
5
|
+
interface APIEnvelopeOptions {
|
|
6
|
+
/** `data` is a list of the model. */
|
|
7
|
+
isArray?: boolean;
|
|
8
|
+
/** The response carries `pagination`. */
|
|
9
|
+
paginated?: boolean;
|
|
10
|
+
/** Description of the response. */
|
|
11
|
+
description?: string;
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* Documents a route that answers the success envelope: `{ ok: true, data }`,
|
|
15
|
+
* plus `pagination` when `paginated`. Replaces `@ApiOkResponse` for routes that
|
|
16
|
+
* return `ok(...)`.
|
|
17
|
+
*
|
|
18
|
+
* @example
|
|
19
|
+
* @APIEnvelope(ProjectDTO, { isArray: true, paginated: true })
|
|
20
|
+
* @Get()
|
|
21
|
+
* list() { return ok(projects, { next }); }
|
|
22
|
+
*/
|
|
23
|
+
export declare function APIEnvelope(data: APIEnvelopeData, options?: APIEnvelopeOptions): MethodDecorator & ClassDecorator;
|
|
24
|
+
/** Definitions per HTTP status, e.g. `{ 404: [Errors.InvalidProjectSlug] }`. */
|
|
25
|
+
type APIErrorsByStatus = Record<number, readonly ErrorDefinition[]>;
|
|
26
|
+
/**
|
|
27
|
+
* Documents the errors a route can answer, per status. Each status lists its
|
|
28
|
+
* codes in the description and one example (`{ ok: false, error: {...} }`) per
|
|
29
|
+
* definition. The status comes from you because an error's real status is only
|
|
30
|
+
* decided where it is thrown.
|
|
31
|
+
*
|
|
32
|
+
* @example
|
|
33
|
+
* @APIErrors({
|
|
34
|
+
* 404: [Errors.InvalidProjectSlug],
|
|
35
|
+
* 409: [Errors.ProjectGone, Errors.ProjectLocked],
|
|
36
|
+
* })
|
|
37
|
+
* @Get(':slug')
|
|
38
|
+
* get() { ... }
|
|
39
|
+
*/
|
|
40
|
+
export declare function APIErrors(byStatus: APIErrorsByStatus): MethodDecorator & ClassDecorator;
|
|
41
|
+
/** Schema of `pagination` in the success envelope. */
|
|
42
|
+
export declare class PaginationDTO {
|
|
43
|
+
before?: string;
|
|
44
|
+
next?: string;
|
|
45
|
+
persist: boolean;
|
|
46
|
+
}
|
|
47
|
+
/** Schema of `error` in the error envelope. */
|
|
48
|
+
export declare class ErrorBodyDTO {
|
|
49
|
+
code: string;
|
|
50
|
+
message: string;
|
|
51
|
+
extra?: unknown;
|
|
52
|
+
}
|
|
53
|
+
/** Schema of the error envelope. */
|
|
54
|
+
export declare class ErrorResponseDTO {
|
|
55
|
+
ok: false;
|
|
56
|
+
error: ErrorBodyDTO;
|
|
57
|
+
}
|
|
58
|
+
export type { APIEnvelopeData, APIEnvelopeOptions, APIErrorsByStatus };
|
|
59
|
+
//# sourceMappingURL=swagger.d.cts.map
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
import { r as ErrorDefinition } from "../errors-DxHoXrLd.js";
|
|
2
|
+
import { Type } from "@nestjs/common";
|
|
3
|
+
/** What `data` holds: a DTO class, a primitive constructor, or `null`. */
|
|
4
|
+
type APIEnvelopeData = Type<unknown> | StringConstructor | NumberConstructor | BooleanConstructor | null;
|
|
5
|
+
interface APIEnvelopeOptions {
|
|
6
|
+
/** `data` is a list of the model. */
|
|
7
|
+
isArray?: boolean;
|
|
8
|
+
/** The response carries `pagination`. */
|
|
9
|
+
paginated?: boolean;
|
|
10
|
+
/** Description of the response. */
|
|
11
|
+
description?: string;
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* Documents a route that answers the success envelope: `{ ok: true, data }`,
|
|
15
|
+
* plus `pagination` when `paginated`. Replaces `@ApiOkResponse` for routes that
|
|
16
|
+
* return `ok(...)`.
|
|
17
|
+
*
|
|
18
|
+
* @example
|
|
19
|
+
* @APIEnvelope(ProjectDTO, { isArray: true, paginated: true })
|
|
20
|
+
* @Get()
|
|
21
|
+
* list() { return ok(projects, { next }); }
|
|
22
|
+
*/
|
|
23
|
+
export declare function APIEnvelope(data: APIEnvelopeData, options?: APIEnvelopeOptions): MethodDecorator & ClassDecorator;
|
|
24
|
+
/** Definitions per HTTP status, e.g. `{ 404: [Errors.InvalidProjectSlug] }`. */
|
|
25
|
+
type APIErrorsByStatus = Record<number, readonly ErrorDefinition[]>;
|
|
26
|
+
/**
|
|
27
|
+
* Documents the errors a route can answer, per status. Each status lists its
|
|
28
|
+
* codes in the description and one example (`{ ok: false, error: {...} }`) per
|
|
29
|
+
* definition. The status comes from you because an error's real status is only
|
|
30
|
+
* decided where it is thrown.
|
|
31
|
+
*
|
|
32
|
+
* @example
|
|
33
|
+
* @APIErrors({
|
|
34
|
+
* 404: [Errors.InvalidProjectSlug],
|
|
35
|
+
* 409: [Errors.ProjectGone, Errors.ProjectLocked],
|
|
36
|
+
* })
|
|
37
|
+
* @Get(':slug')
|
|
38
|
+
* get() { ... }
|
|
39
|
+
*/
|
|
40
|
+
export declare function APIErrors(byStatus: APIErrorsByStatus): MethodDecorator & ClassDecorator;
|
|
41
|
+
/** Schema of `pagination` in the success envelope. */
|
|
42
|
+
export declare class PaginationDTO {
|
|
43
|
+
before?: string;
|
|
44
|
+
next?: string;
|
|
45
|
+
persist: boolean;
|
|
46
|
+
}
|
|
47
|
+
/** Schema of `error` in the error envelope. */
|
|
48
|
+
export declare class ErrorBodyDTO {
|
|
49
|
+
code: string;
|
|
50
|
+
message: string;
|
|
51
|
+
extra?: unknown;
|
|
52
|
+
}
|
|
53
|
+
/** Schema of the error envelope. */
|
|
54
|
+
export declare class ErrorResponseDTO {
|
|
55
|
+
ok: false;
|
|
56
|
+
error: ErrorBodyDTO;
|
|
57
|
+
}
|
|
58
|
+
export type { APIEnvelopeData, APIEnvelopeOptions, APIErrorsByStatus };
|
|
59
|
+
//# sourceMappingURL=swagger.d.ts.map
|