ts-rails 1.0.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/README.md +442 -0
- package/dist/app/channels/index.d.ts +2 -0
- package/dist/app/channels/index.d.ts.map +1 -0
- package/dist/app/channels/index.js +18 -0
- package/dist/app/channels/index.js.map +1 -0
- package/dist/app/channels/railsChannel.d.ts +11 -0
- package/dist/app/channels/railsChannel.d.ts.map +1 -0
- package/dist/app/channels/railsChannel.js +20 -0
- package/dist/app/channels/railsChannel.js.map +1 -0
- package/dist/app/controllers/controllerHelpers.d.ts +4 -0
- package/dist/app/controllers/controllerHelpers.d.ts.map +1 -0
- package/dist/app/controllers/controllerHelpers.js +55 -0
- package/dist/app/controllers/controllerHelpers.js.map +1 -0
- package/dist/app/controllers/decorators.d.ts +4 -0
- package/dist/app/controllers/decorators.d.ts.map +1 -0
- package/dist/app/controllers/decorators.js +23 -0
- package/dist/app/controllers/decorators.js.map +1 -0
- package/dist/app/controllers/index.d.ts +7 -0
- package/dist/app/controllers/index.d.ts.map +1 -0
- package/dist/app/controllers/index.js +23 -0
- package/dist/app/controllers/index.js.map +1 -0
- package/dist/app/controllers/pagination.d.ts +29 -0
- package/dist/app/controllers/pagination.d.ts.map +1 -0
- package/dist/app/controllers/pagination.js +28 -0
- package/dist/app/controllers/pagination.js.map +1 -0
- package/dist/app/controllers/railsController.d.ts +30 -0
- package/dist/app/controllers/railsController.d.ts.map +1 -0
- package/dist/app/controllers/railsController.js +32 -0
- package/dist/app/controllers/railsController.js.map +1 -0
- package/dist/app/controllers/response.d.ts +19 -0
- package/dist/app/controllers/response.d.ts.map +1 -0
- package/dist/app/controllers/response.js +26 -0
- package/dist/app/controllers/response.js.map +1 -0
- package/dist/app/controllers/strongParams.d.ts +18 -0
- package/dist/app/controllers/strongParams.d.ts.map +1 -0
- package/dist/app/controllers/strongParams.js +91 -0
- package/dist/app/controllers/strongParams.js.map +1 -0
- package/dist/app/index.d.ts +7 -0
- package/dist/app/index.d.ts.map +1 -0
- package/dist/app/index.js +23 -0
- package/dist/app/index.js.map +1 -0
- package/dist/app/jobs/index.d.ts +2 -0
- package/dist/app/jobs/index.d.ts.map +1 -0
- package/dist/app/jobs/index.js +18 -0
- package/dist/app/jobs/index.js.map +1 -0
- package/dist/app/jobs/railsJob.d.ts +8 -0
- package/dist/app/jobs/railsJob.d.ts.map +1 -0
- package/dist/app/jobs/railsJob.js +15 -0
- package/dist/app/jobs/railsJob.js.map +1 -0
- package/dist/app/mailers/index.d.ts +2 -0
- package/dist/app/mailers/index.d.ts.map +1 -0
- package/dist/app/mailers/index.js +18 -0
- package/dist/app/mailers/index.js.map +1 -0
- package/dist/app/mailers/railsMailer.d.ts +13 -0
- package/dist/app/mailers/railsMailer.d.ts.map +1 -0
- package/dist/app/mailers/railsMailer.js +19 -0
- package/dist/app/mailers/railsMailer.js.map +1 -0
- package/dist/app/middlewares/fileUploadValidation.d.ts +6 -0
- package/dist/app/middlewares/fileUploadValidation.d.ts.map +1 -0
- package/dist/app/middlewares/fileUploadValidation.js +21 -0
- package/dist/app/middlewares/fileUploadValidation.js.map +1 -0
- package/dist/app/middlewares/index.d.ts +2 -0
- package/dist/app/middlewares/index.d.ts.map +1 -0
- package/dist/app/middlewares/index.js +18 -0
- package/dist/app/middlewares/index.js.map +1 -0
- package/dist/app/views/index.d.ts +2 -0
- package/dist/app/views/index.d.ts.map +1 -0
- package/dist/app/views/index.js +18 -0
- package/dist/app/views/index.js.map +1 -0
- package/dist/app/views/viewHelpers.d.ts +7 -0
- package/dist/app/views/viewHelpers.d.ts.map +1 -0
- package/dist/app/views/viewHelpers.js +42 -0
- package/dist/app/views/viewHelpers.js.map +1 -0
- package/dist/cli.d.ts +3 -0
- package/dist/cli.d.ts.map +1 -0
- package/dist/cli.js +111 -0
- package/dist/cli.js.map +1 -0
- package/dist/commands/console.d.ts +2 -0
- package/dist/commands/console.d.ts.map +1 -0
- package/dist/commands/console.js +85 -0
- package/dist/commands/console.js.map +1 -0
- package/dist/commands/generate-concern.d.ts +2 -0
- package/dist/commands/generate-concern.d.ts.map +1 -0
- package/dist/commands/generate-concern.js +40 -0
- package/dist/commands/generate-concern.js.map +1 -0
- package/dist/commands/generate-controller.d.ts +2 -0
- package/dist/commands/generate-controller.d.ts.map +1 -0
- package/dist/commands/generate-controller.js +92 -0
- package/dist/commands/generate-controller.js.map +1 -0
- package/dist/commands/generate-factory.d.ts +2 -0
- package/dist/commands/generate-factory.d.ts.map +1 -0
- package/dist/commands/generate-factory.js +43 -0
- package/dist/commands/generate-factory.js.map +1 -0
- package/dist/commands/generate-job.d.ts +2 -0
- package/dist/commands/generate-job.d.ts.map +1 -0
- package/dist/commands/generate-job.js +41 -0
- package/dist/commands/generate-job.js.map +1 -0
- package/dist/commands/generate-mailer.d.ts +2 -0
- package/dist/commands/generate-mailer.d.ts.map +1 -0
- package/dist/commands/generate-mailer.js +46 -0
- package/dist/commands/generate-mailer.js.map +1 -0
- package/dist/commands/generate-model.d.ts +2 -0
- package/dist/commands/generate-model.d.ts.map +1 -0
- package/dist/commands/generate-model.js +53 -0
- package/dist/commands/generate-model.js.map +1 -0
- package/dist/commands/generate-resource.d.ts +2 -0
- package/dist/commands/generate-resource.d.ts.map +1 -0
- package/dist/commands/generate-resource.js +62 -0
- package/dist/commands/generate-resource.js.map +1 -0
- package/dist/commands/generate-scaffold.d.ts +2 -0
- package/dist/commands/generate-scaffold.d.ts.map +1 -0
- package/dist/commands/generate-scaffold.js +183 -0
- package/dist/commands/generate-scaffold.js.map +1 -0
- package/dist/commands/generate-service.d.ts +2 -0
- package/dist/commands/generate-service.d.ts.map +1 -0
- package/dist/commands/generate-service.js +49 -0
- package/dist/commands/generate-service.js.map +1 -0
- package/dist/commands/notes.d.ts +2 -0
- package/dist/commands/notes.d.ts.map +1 -0
- package/dist/commands/notes.js +58 -0
- package/dist/commands/notes.js.map +1 -0
- package/dist/commands/routes.d.ts +2 -0
- package/dist/commands/routes.d.ts.map +1 -0
- package/dist/commands/routes.js +76 -0
- package/dist/commands/routes.js.map +1 -0
- package/dist/configs/cache.d.ts +15 -0
- package/dist/configs/cache.d.ts.map +1 -0
- package/dist/configs/cache.js +27 -0
- package/dist/configs/cache.js.map +1 -0
- package/dist/configs/index.d.ts +6 -0
- package/dist/configs/index.d.ts.map +1 -0
- package/dist/configs/index.js +22 -0
- package/dist/configs/index.js.map +1 -0
- package/dist/configs/logger.d.ts +12 -0
- package/dist/configs/logger.d.ts.map +1 -0
- package/dist/configs/logger.js +23 -0
- package/dist/configs/logger.js.map +1 -0
- package/dist/configs/railsApplication.d.ts +54 -0
- package/dist/configs/railsApplication.d.ts.map +1 -0
- package/dist/configs/railsApplication.js +314 -0
- package/dist/configs/railsApplication.js.map +1 -0
- package/dist/configs/railsRoute.d.ts +71 -0
- package/dist/configs/railsRoute.d.ts.map +1 -0
- package/dist/configs/railsRoute.js +332 -0
- package/dist/configs/railsRoute.js.map +1 -0
- package/dist/configs/swagger/builder.d.ts +20 -0
- package/dist/configs/swagger/builder.d.ts.map +1 -0
- package/dist/configs/swagger/builder.js +81 -0
- package/dist/configs/swagger/builder.js.map +1 -0
- package/dist/configs/swagger/decorator.d.ts +23 -0
- package/dist/configs/swagger/decorator.d.ts.map +1 -0
- package/dist/configs/swagger/decorator.js +27 -0
- package/dist/configs/swagger/decorator.js.map +1 -0
- package/dist/configs/swagger/index.d.ts +5 -0
- package/dist/configs/swagger/index.d.ts.map +1 -0
- package/dist/configs/swagger/index.js +21 -0
- package/dist/configs/swagger/index.js.map +1 -0
- package/dist/configs/swagger/registry.d.ts +4 -0
- package/dist/configs/swagger/registry.d.ts.map +1 -0
- package/dist/configs/swagger/registry.js +22 -0
- package/dist/configs/swagger/registry.js.map +1 -0
- package/dist/configs/swagger/server.d.ts +3 -0
- package/dist/configs/swagger/server.d.ts.map +1 -0
- package/dist/configs/swagger/server.js +17 -0
- package/dist/configs/swagger/server.js.map +1 -0
- package/dist/index.d.ts +4 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +20 -0
- package/dist/index.js.map +1 -0
- package/dist/lib/index.d.ts +2 -0
- package/dist/lib/index.d.ts.map +1 -0
- package/dist/lib/index.js +18 -0
- package/dist/lib/index.js.map +1 -0
- package/dist/lib/utils/errors.d.ts +22 -0
- package/dist/lib/utils/errors.d.ts.map +1 -0
- package/dist/lib/utils/errors.js +45 -0
- package/dist/lib/utils/errors.js.map +1 -0
- package/dist/lib/utils/index.d.ts +3 -0
- package/dist/lib/utils/index.d.ts.map +1 -0
- package/dist/lib/utils/index.js +19 -0
- package/dist/lib/utils/index.js.map +1 -0
- package/dist/lib/utils/security.d.ts +9 -0
- package/dist/lib/utils/security.d.ts.map +1 -0
- package/dist/lib/utils/security.js +14 -0
- package/dist/lib/utils/security.js.map +1 -0
- package/package.json +105 -0
|
@@ -0,0 +1,332 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __rest = (this && this.__rest) || function (s, e) {
|
|
3
|
+
var t = {};
|
|
4
|
+
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
|
|
5
|
+
t[p] = s[p];
|
|
6
|
+
if (s != null && typeof Object.getOwnPropertySymbols === "function")
|
|
7
|
+
for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
|
|
8
|
+
if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
|
|
9
|
+
t[p[i]] = s[p[i]];
|
|
10
|
+
}
|
|
11
|
+
return t;
|
|
12
|
+
};
|
|
13
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
14
|
+
exports.RailsRoute = exports.RestActions = void 0;
|
|
15
|
+
const class_validator_1 = require("class-validator");
|
|
16
|
+
const express_1 = require("express");
|
|
17
|
+
require("reflect-metadata");
|
|
18
|
+
const app_1 = require("../app");
|
|
19
|
+
const swagger_1 = require("./swagger");
|
|
20
|
+
var RestActions;
|
|
21
|
+
(function (RestActions) {
|
|
22
|
+
RestActions["Index"] = "index";
|
|
23
|
+
RestActions["Show"] = "show";
|
|
24
|
+
RestActions["New"] = "new";
|
|
25
|
+
RestActions["Create"] = "create";
|
|
26
|
+
RestActions["Edit"] = "edit";
|
|
27
|
+
RestActions["Update"] = "update";
|
|
28
|
+
RestActions["Destroy"] = "destroy";
|
|
29
|
+
})(RestActions || (exports.RestActions = RestActions = {}));
|
|
30
|
+
class RailsRoute {
|
|
31
|
+
constructor() {
|
|
32
|
+
this.route = (0, express_1.Router)();
|
|
33
|
+
}
|
|
34
|
+
static draw() {
|
|
35
|
+
const instance = new this();
|
|
36
|
+
instance.draw();
|
|
37
|
+
return instance.route;
|
|
38
|
+
}
|
|
39
|
+
extractSchemaFromValidator(Model) {
|
|
40
|
+
const metadata = (0, class_validator_1.getMetadataStorage)();
|
|
41
|
+
const targetMetadata = metadata.getTargetValidationMetadatas(Model, Model.name, true, false);
|
|
42
|
+
const properties = {};
|
|
43
|
+
const required = [];
|
|
44
|
+
targetMetadata.forEach((m) => {
|
|
45
|
+
var _a;
|
|
46
|
+
const prop = m.propertyName;
|
|
47
|
+
if (properties[prop])
|
|
48
|
+
return;
|
|
49
|
+
const designType = Reflect.getMetadata("design:type", Model.prototype, prop);
|
|
50
|
+
let swaggerType = "string";
|
|
51
|
+
if (designType === Number)
|
|
52
|
+
swaggerType = "number";
|
|
53
|
+
else if (designType === Boolean)
|
|
54
|
+
swaggerType = "boolean";
|
|
55
|
+
else if (designType === Array)
|
|
56
|
+
swaggerType = "array";
|
|
57
|
+
else if (designType === Object)
|
|
58
|
+
swaggerType = "object";
|
|
59
|
+
properties[prop] = {
|
|
60
|
+
type: swaggerType,
|
|
61
|
+
description: ((_a = m.constraints) === null || _a === void 0 ? void 0 : _a.join(", ")) || "",
|
|
62
|
+
};
|
|
63
|
+
const isOptional = targetMetadata.some((meta) => meta.propertyName === prop && meta.type === "isOptional");
|
|
64
|
+
if (!isOptional)
|
|
65
|
+
required.push(prop);
|
|
66
|
+
});
|
|
67
|
+
return {
|
|
68
|
+
type: "object",
|
|
69
|
+
properties,
|
|
70
|
+
required: required.length > 0 ? required : undefined,
|
|
71
|
+
};
|
|
72
|
+
}
|
|
73
|
+
resolveBody(body) {
|
|
74
|
+
if (typeof body === "function" && body.prototype) {
|
|
75
|
+
return this.extractSchemaFromValidator(body);
|
|
76
|
+
}
|
|
77
|
+
return body;
|
|
78
|
+
}
|
|
79
|
+
path(...args) {
|
|
80
|
+
this.route.use(...args);
|
|
81
|
+
}
|
|
82
|
+
resource(arg1, arg2, arg3) {
|
|
83
|
+
var _a;
|
|
84
|
+
let basePath = "/";
|
|
85
|
+
let Controller;
|
|
86
|
+
let options;
|
|
87
|
+
if (typeof arg1 === "string") {
|
|
88
|
+
basePath = arg1;
|
|
89
|
+
Controller = arg2;
|
|
90
|
+
options = arg3;
|
|
91
|
+
}
|
|
92
|
+
else {
|
|
93
|
+
Controller = arg1;
|
|
94
|
+
options = arg2;
|
|
95
|
+
}
|
|
96
|
+
if ((options === null || options === void 0 ? void 0 : options.only) && (options === null || options === void 0 ? void 0 : options.except)) {
|
|
97
|
+
throw new Error("Can only pass only or except!");
|
|
98
|
+
}
|
|
99
|
+
const getPermissionCode = (action) => {
|
|
100
|
+
if ([RestActions.Index, RestActions.Show].includes(action)) {
|
|
101
|
+
return RailsRoute.actionPermissionMap.read;
|
|
102
|
+
}
|
|
103
|
+
if ([RestActions.New, RestActions.Create].includes(action)) {
|
|
104
|
+
return RailsRoute.actionPermissionMap.create;
|
|
105
|
+
}
|
|
106
|
+
if ([RestActions.Edit, RestActions.Update].includes(action)) {
|
|
107
|
+
return RailsRoute.actionPermissionMap.update;
|
|
108
|
+
}
|
|
109
|
+
return RailsRoute.actionPermissionMap.delete;
|
|
110
|
+
};
|
|
111
|
+
const handler = (actionName) => (0, app_1.action)(Controller, actionName);
|
|
112
|
+
const featureCodes = (_a = options === null || options === void 0 ? void 0 : options.setPermissionForAny) !== null && _a !== void 0 ? _a : ((options === null || options === void 0 ? void 0 : options.setPermissionFor) ? [options.setPermissionFor] : []);
|
|
113
|
+
const withPermission = (actionName, permission) => {
|
|
114
|
+
if (!RailsRoute.permissionFactory)
|
|
115
|
+
throw new Error("RailsRoute.permissionFactory is not configured.");
|
|
116
|
+
return [
|
|
117
|
+
RailsRoute.permissionFactory.forUser(permission),
|
|
118
|
+
handler(actionName),
|
|
119
|
+
];
|
|
120
|
+
};
|
|
121
|
+
const withAnyPermission = (actionName, perm) => {
|
|
122
|
+
if (!RailsRoute.permissionFactory)
|
|
123
|
+
throw new Error("RailsRoute.permissionFactory is not configured.");
|
|
124
|
+
const codes = featureCodes.map((f) => `${f}::${perm}`);
|
|
125
|
+
return [RailsRoute.permissionFactory.forAny(codes), handler(actionName)];
|
|
126
|
+
};
|
|
127
|
+
const isApi = !!(options === null || options === void 0 ? void 0 : options.document);
|
|
128
|
+
const apiOnly = isApi
|
|
129
|
+
? [
|
|
130
|
+
RestActions.Index,
|
|
131
|
+
RestActions.Show,
|
|
132
|
+
RestActions.Create,
|
|
133
|
+
RestActions.Update,
|
|
134
|
+
RestActions.Destroy,
|
|
135
|
+
]
|
|
136
|
+
: undefined;
|
|
137
|
+
const effectiveOnly = isApi ? apiOnly : options === null || options === void 0 ? void 0 : options.only;
|
|
138
|
+
const effectiveExcept = options === null || options === void 0 ? void 0 : options.except;
|
|
139
|
+
const addApiRoute = (actionName, method, routePath, swaggerPath) => {
|
|
140
|
+
var _a, _b, _c, _d;
|
|
141
|
+
const resourceName = basePath
|
|
142
|
+
.split("/")
|
|
143
|
+
.filter(Boolean)
|
|
144
|
+
.map((part) => part.charAt(0).toUpperCase() + part.slice(1))
|
|
145
|
+
.join(" ");
|
|
146
|
+
const capitalizedAction = actionName.charAt(0).toUpperCase() + actionName.slice(1);
|
|
147
|
+
const defaultSummary = `${capitalizedAction} ${resourceName}`;
|
|
148
|
+
const defaultTags = [Controller.name.replace("Controller", "")];
|
|
149
|
+
const baseDoc = (options === null || options === void 0 ? void 0 : options.document)
|
|
150
|
+
? {
|
|
151
|
+
tags: options.document.tags || defaultTags,
|
|
152
|
+
auth: true,
|
|
153
|
+
summary: options.document.summary,
|
|
154
|
+
}
|
|
155
|
+
: { auth: true };
|
|
156
|
+
const defaultResponses = actionName === "create"
|
|
157
|
+
? { 201: "Created", 403: "Forbidden", 422: "Validation failed" }
|
|
158
|
+
: {
|
|
159
|
+
200: "OK",
|
|
160
|
+
403: "Forbidden",
|
|
161
|
+
404: "Not Found",
|
|
162
|
+
422: "Validation failed",
|
|
163
|
+
};
|
|
164
|
+
const docInput = Object.assign({}, options === null || options === void 0 ? void 0 : options.document);
|
|
165
|
+
if (docInput.body)
|
|
166
|
+
docInput.body = this.resolveBody(docInput.body);
|
|
167
|
+
const resolved = (0, swagger_1.resolveApiDocSchema)(docInput !== null && docInput !== void 0 ? docInput : {});
|
|
168
|
+
const docOpts = Object.assign(Object.assign(Object.assign({ path: swaggerPath }, baseDoc), docInput), { summary: baseDoc.summary || defaultSummary, params: resolved.params, body: resolved.body, requiredBody: resolved.requiredBody, responses: ((_b = (_a = options === null || options === void 0 ? void 0 : options.document) === null || _a === void 0 ? void 0 : _a.responses) !== null && _b !== void 0 ? _b : defaultResponses) });
|
|
169
|
+
const op = (0, swagger_1.buildSwaggerOp)(docOpts);
|
|
170
|
+
(0, swagger_1.registerSwaggerPath)(swaggerPath, method, op);
|
|
171
|
+
const handlers = [];
|
|
172
|
+
const permCode = actionName === "index" || actionName === "show"
|
|
173
|
+
? "Read"
|
|
174
|
+
: actionName === "create"
|
|
175
|
+
? "Create"
|
|
176
|
+
: actionName === "update"
|
|
177
|
+
? "Update"
|
|
178
|
+
: "Delete";
|
|
179
|
+
if (((_c = options === null || options === void 0 ? void 0 : options.setPermissionForAny) === null || _c === void 0 ? void 0 : _c.length) || (options === null || options === void 0 ? void 0 : options.setPermissionFor)) {
|
|
180
|
+
if (!RailsRoute.permissionFactory) {
|
|
181
|
+
throw new Error("Cannot apply permissions: RailsRoute.permissionFactory is not configured.");
|
|
182
|
+
}
|
|
183
|
+
if ((_d = options.setPermissionForAny) === null || _d === void 0 ? void 0 : _d.length) {
|
|
184
|
+
const permCodes = options.setPermissionForAny.map((f) => `${f}::${permCode}`);
|
|
185
|
+
handlers.push(RailsRoute.permissionFactory.forAny(permCodes));
|
|
186
|
+
}
|
|
187
|
+
else if (options.setPermissionFor) {
|
|
188
|
+
const permCodeWithOptions = `${options.setPermissionFor}::${permCode}`;
|
|
189
|
+
handlers.push(RailsRoute.permissionFactory.forUser(permCodeWithOptions));
|
|
190
|
+
}
|
|
191
|
+
}
|
|
192
|
+
handlers.push(handler(actionName));
|
|
193
|
+
this.route[method](routePath, ...handlers);
|
|
194
|
+
};
|
|
195
|
+
const useAnyPerm = (options === null || options === void 0 ? void 0 : options.setPermissionForAny) && options.setPermissionForAny.length > 0;
|
|
196
|
+
const usePerm = (options === null || options === void 0 ? void 0 : options.setPermissionFor) && !useAnyPerm;
|
|
197
|
+
const routes = [
|
|
198
|
+
{ action: RestActions.Index, method: "get", path: "/", apiPath: "/" },
|
|
199
|
+
{ action: RestActions.New, method: "get", path: "/new", apiPath: null },
|
|
200
|
+
{
|
|
201
|
+
action: RestActions.Show,
|
|
202
|
+
method: "get",
|
|
203
|
+
path: "/:id",
|
|
204
|
+
apiPath: "/{id}",
|
|
205
|
+
},
|
|
206
|
+
{ action: RestActions.Create, method: "post", path: "/", apiPath: "/" },
|
|
207
|
+
{
|
|
208
|
+
action: RestActions.Edit,
|
|
209
|
+
method: "get",
|
|
210
|
+
path: "/:id/edit",
|
|
211
|
+
apiPath: null,
|
|
212
|
+
},
|
|
213
|
+
{
|
|
214
|
+
action: RestActions.Update,
|
|
215
|
+
method: "put",
|
|
216
|
+
path: "/:id",
|
|
217
|
+
apiPath: "/{id}",
|
|
218
|
+
},
|
|
219
|
+
{
|
|
220
|
+
action: RestActions.Destroy,
|
|
221
|
+
method: "delete",
|
|
222
|
+
path: "/:id",
|
|
223
|
+
apiPath: "/{id}",
|
|
224
|
+
},
|
|
225
|
+
];
|
|
226
|
+
routes.forEach(({ action: act, method, path: subPath, apiPath }) => {
|
|
227
|
+
if (!this.isAllowAccess(effectiveOnly, effectiveExcept, act))
|
|
228
|
+
return;
|
|
229
|
+
if (isApi && !apiPath)
|
|
230
|
+
return;
|
|
231
|
+
const fullPath = (basePath === "/" ? "" : basePath) + subPath;
|
|
232
|
+
if (isApi) {
|
|
233
|
+
addApiRoute(act, method, fullPath, (options.document.path ||
|
|
234
|
+
basePath.replace(/:([a-zA-Z0-9_]+)/g, "{$1}")) + apiPath);
|
|
235
|
+
}
|
|
236
|
+
else {
|
|
237
|
+
let handlers = [handler(act)];
|
|
238
|
+
if (useAnyPerm) {
|
|
239
|
+
const perm = getPermissionCode(act);
|
|
240
|
+
handlers = withAnyPermission(act, perm);
|
|
241
|
+
}
|
|
242
|
+
else if (usePerm) {
|
|
243
|
+
const perm = getPermissionCode(act);
|
|
244
|
+
handlers = withPermission(act, `${options.setPermissionFor}::${perm}`);
|
|
245
|
+
}
|
|
246
|
+
this.route[method](fullPath, ...handlers);
|
|
247
|
+
}
|
|
248
|
+
});
|
|
249
|
+
}
|
|
250
|
+
isAllowAccess(only, except, action) {
|
|
251
|
+
return ((!only && !except) ||
|
|
252
|
+
(only && (only === null || only === void 0 ? void 0 : only.includes(action))) ||
|
|
253
|
+
(except && !(except === null || except === void 0 ? void 0 : except.includes(action))));
|
|
254
|
+
}
|
|
255
|
+
get(arg1, arg2, arg3) {
|
|
256
|
+
const { path, handlers, options } = this.resolveArgs(arg1, arg2, arg3);
|
|
257
|
+
this.registerCustomRoute("get", path, handlers, options);
|
|
258
|
+
}
|
|
259
|
+
post(arg1, arg2, arg3) {
|
|
260
|
+
const { path, handlers, options } = this.resolveArgs(arg1, arg2, arg3);
|
|
261
|
+
this.registerCustomRoute("post", path, handlers, options);
|
|
262
|
+
}
|
|
263
|
+
put(arg1, arg2, arg3) {
|
|
264
|
+
const { path, handlers, options } = this.resolveArgs(arg1, arg2, arg3);
|
|
265
|
+
this.registerCustomRoute("put", path, handlers, options);
|
|
266
|
+
}
|
|
267
|
+
delete(arg1, arg2, arg3) {
|
|
268
|
+
const { path, handlers, options } = this.resolveArgs(arg1, arg2, arg3);
|
|
269
|
+
this.registerCustomRoute("delete", path, handlers, options);
|
|
270
|
+
}
|
|
271
|
+
patch(arg1, arg2, arg3) {
|
|
272
|
+
const { path, handlers, options } = this.resolveArgs(arg1, arg2, arg3);
|
|
273
|
+
this.registerCustomRoute("patch", path, handlers, options);
|
|
274
|
+
}
|
|
275
|
+
registerCustomRoute(method, path, handlers, options) {
|
|
276
|
+
var _a, _b;
|
|
277
|
+
let finalHandlers = Array.isArray(handlers)
|
|
278
|
+
? handlers
|
|
279
|
+
: [handlers];
|
|
280
|
+
if (((_a = options === null || options === void 0 ? void 0 : options.setPermissionForAny) === null || _a === void 0 ? void 0 : _a.length) || (options === null || options === void 0 ? void 0 : options.setPermissionFor)) {
|
|
281
|
+
if (!RailsRoute.permissionFactory) {
|
|
282
|
+
throw new Error("Cannot apply permissions: RailsRoute.permissionFactory is not configured.");
|
|
283
|
+
}
|
|
284
|
+
if ((_b = options.setPermissionForAny) === null || _b === void 0 ? void 0 : _b.length) {
|
|
285
|
+
finalHandlers.unshift(RailsRoute.permissionFactory.forAny(options.setPermissionForAny));
|
|
286
|
+
}
|
|
287
|
+
else if (options.setPermissionFor) {
|
|
288
|
+
finalHandlers.unshift(RailsRoute.permissionFactory.forUser(options.setPermissionFor));
|
|
289
|
+
}
|
|
290
|
+
}
|
|
291
|
+
if (options === null || options === void 0 ? void 0 : options.document) {
|
|
292
|
+
const swaggerPath = options.document.path || path.replace(/:([a-zA-Z0-9_]+)/g, "{$1}");
|
|
293
|
+
if (!options.document.tags && !Array.isArray(handlers)) {
|
|
294
|
+
const lastHandler = Array.isArray(handlers)
|
|
295
|
+
? handlers[handlers.length - 1]
|
|
296
|
+
: handlers;
|
|
297
|
+
}
|
|
298
|
+
const defaultResponses = method === "post" ? { 201: "Created" } : { 200: "OK" };
|
|
299
|
+
const _c = options.document, { path: _p, responses } = _c, opts = __rest(_c, ["path", "responses"]);
|
|
300
|
+
const docInput = Object.assign({}, opts);
|
|
301
|
+
if (docInput.body)
|
|
302
|
+
docInput.body = this.resolveBody(docInput.body);
|
|
303
|
+
const resolved = (0, swagger_1.resolveApiDocSchema)(docInput);
|
|
304
|
+
const operation = (0, swagger_1.buildSwaggerOp)(Object.assign(Object.assign(Object.assign({ path: swaggerPath }, docInput), resolved), { responses: responses || defaultResponses }));
|
|
305
|
+
(0, swagger_1.registerSwaggerPath)(swaggerPath, method, operation);
|
|
306
|
+
}
|
|
307
|
+
this.route[method](path, ...finalHandlers);
|
|
308
|
+
}
|
|
309
|
+
resolveArgs(arg1, arg2, arg3) {
|
|
310
|
+
let path = "/";
|
|
311
|
+
let handlers;
|
|
312
|
+
let options;
|
|
313
|
+
if (typeof arg1 === "string") {
|
|
314
|
+
path = arg1;
|
|
315
|
+
handlers = arg2;
|
|
316
|
+
options = arg3;
|
|
317
|
+
}
|
|
318
|
+
else {
|
|
319
|
+
handlers = arg1;
|
|
320
|
+
options = arg2;
|
|
321
|
+
}
|
|
322
|
+
return { path, handlers, options };
|
|
323
|
+
}
|
|
324
|
+
}
|
|
325
|
+
exports.RailsRoute = RailsRoute;
|
|
326
|
+
RailsRoute.actionPermissionMap = {
|
|
327
|
+
read: "READ",
|
|
328
|
+
create: "CREATE",
|
|
329
|
+
update: "UPDATE",
|
|
330
|
+
delete: "DELETE",
|
|
331
|
+
};
|
|
332
|
+
//# sourceMappingURL=railsRoute.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"railsRoute.js","sourceRoot":"","sources":["../../configs/railsRoute.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,qDAAqD;AACrD,qCAAiD;AACjD,4BAA0B;AAC1B,gCAAgD;AAChD,uCAKmB;AAEnB,IAAY,WAQX;AARD,WAAY,WAAW;IACrB,8BAAe,CAAA;IACf,4BAAa,CAAA;IACb,0BAAW,CAAA;IACX,gCAAiB,CAAA;IACjB,4BAAa,CAAA;IACb,gCAAiB,CAAA;IACjB,kCAAmB,CAAA;AACrB,CAAC,EARW,WAAW,2BAAX,WAAW,QAQtB;AAwCD,MAAsB,UAAU;IAU9B;QACE,IAAI,CAAC,KAAK,GAAG,IAAA,gBAAM,GAAE,CAAC;IACxB,CAAC;IASM,MAAM,CAAC,IAAI;QAEhB,MAAM,QAAQ,GAAG,IAAK,IAAY,EAAE,CAAC;QACrC,QAAQ,CAAC,IAAI,EAAE,CAAC;QAChB,OAAO,QAAQ,CAAC,KAAK,CAAC;IACxB,CAAC;IAKO,0BAA0B,CAAC,KAAqB;QACtD,MAAM,QAAQ,GAAG,IAAA,oCAAkB,GAAE,CAAC;QACtC,MAAM,cAAc,GAAG,QAAQ,CAAC,4BAA4B,CAC1D,KAAK,EACL,KAAK,CAAC,IAAI,EACV,IAAI,EACJ,KAAK,CACN,CAAC;QAEF,MAAM,UAAU,GAAwB,EAAE,CAAC;QAC3C,MAAM,QAAQ,GAAa,EAAE,CAAC;QAE9B,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;;YAC3B,MAAM,IAAI,GAAG,CAAC,CAAC,YAAY,CAAC;YAC5B,IAAI,UAAU,CAAC,IAAI,CAAC;gBAAE,OAAO;YAG7B,MAAM,UAAU,GAAG,OAAO,CAAC,WAAW,CACpC,aAAa,EACb,KAAK,CAAC,SAAS,EACf,IAAI,CACL,CAAC;YACF,IAAI,WAAW,GAAG,QAAQ,CAAC;YAE3B,IAAI,UAAU,KAAK,MAAM;gBAAE,WAAW,GAAG,QAAQ,CAAC;iBAC7C,IAAI,UAAU,KAAK,OAAO;gBAAE,WAAW,GAAG,SAAS,CAAC;iBACpD,IAAI,UAAU,KAAK,KAAK;gBAAE,WAAW,GAAG,OAAO,CAAC;iBAChD,IAAI,UAAU,KAAK,MAAM;gBAAE,WAAW,GAAG,QAAQ,CAAC;YAEvD,UAAU,CAAC,IAAI,CAAC,GAAG;gBACjB,IAAI,EAAE,WAAW;gBAEjB,WAAW,EAAE,CAAA,MAAA,CAAC,CAAC,WAAW,0CAAE,IAAI,CAAC,IAAI,CAAC,KAAI,EAAE;aAC7C,CAAC;YAGF,MAAM,UAAU,GAAG,cAAc,CAAC,IAAI,CACpC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,KAAK,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,YAAY,CACnE,CAAC;YACF,IAAI,CAAC,UAAU;gBAAE,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;QAEH,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,UAAU;YACV,QAAQ,EAAE,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS;SACrD,CAAC;IACJ,CAAC;IAEO,WAAW,CAAC,IAAS;QAC3B,IAAI,OAAO,IAAI,KAAK,UAAU,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACjD,OAAO,IAAI,CAAC,0BAA0B,CAAC,IAAsB,CAAC,CAAC;QACjE,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAKS,IAAI,CAAC,GAAG,IAAW;QAC3B,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAI,IAAc,CAAC,CAAC;IACrC,CAAC;IAeS,QAAQ,CAChB,IAA4C,EAC5C,IAAmD,EACnD,IAAmB;;QAEnB,IAAI,QAAQ,GAAG,GAAG,CAAC;QACnB,IAAI,UAAuC,CAAC;QAC5C,IAAI,OAAiC,CAAC;QAEtC,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,QAAQ,GAAG,IAAI,CAAC;YAChB,UAAU,GAAG,IAAmC,CAAC;YACjD,OAAO,GAAG,IAAI,CAAC;QACjB,CAAC;aAAM,CAAC;YACN,UAAU,GAAG,IAAmC,CAAC;YACjD,OAAO,GAAG,IAAoB,CAAC;QACjC,CAAC;QAED,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,MAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,CAAA,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;QACnD,CAAC;QAED,MAAM,iBAAiB,GAAG,CAAC,MAAmB,EAAU,EAAE;YACxD,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC3D,OAAO,UAAU,CAAC,mBAAmB,CAAC,IAAI,CAAC;YAC7C,CAAC;YACD,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC3D,OAAO,UAAU,CAAC,mBAAmB,CAAC,MAAM,CAAC;YAC/C,CAAC;YACD,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC5D,OAAO,UAAU,CAAC,mBAAmB,CAAC,MAAM,CAAC;YAC/C,CAAC;YACD,OAAO,UAAU,CAAC,mBAAmB,CAAC,MAAM,CAAC;QAC/C,CAAC,CAAC;QAEF,MAAM,OAAO,GAAG,CAAC,UAAkB,EAAE,EAAE,CAAC,IAAA,YAAM,EAAC,UAAU,EAAE,UAAU,CAAC,CAAC;QACvE,MAAM,YAAY,GAChB,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,mBAAmB,mCAC5B,CAAC,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,gBAAgB,EAAC,CAAC,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAChE,MAAM,cAAc,GAAG,CAAC,UAAkB,EAAE,UAAkB,EAAE,EAAE;YAChE,IAAI,CAAC,UAAU,CAAC,iBAAiB;gBAC/B,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;YACrE,OAAO;gBACL,UAAU,CAAC,iBAAiB,CAAC,OAAO,CAAC,UAAU,CAAC;gBAChD,OAAO,CAAC,UAAU,CAAC;aACpB,CAAC;QACJ,CAAC,CAAC;QAEF,MAAM,iBAAiB,GAAG,CAAC,UAAkB,EAAE,IAAY,EAAE,EAAE;YAC7D,IAAI,CAAC,UAAU,CAAC,iBAAiB;gBAC/B,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;YACrE,MAAM,KAAK,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,CAAS,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;YAC/D,OAAO,CAAC,UAAU,CAAC,iBAAiB,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC;QAC3E,CAAC,CAAC;QAEF,MAAM,KAAK,GAAG,CAAC,CAAC,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,CAAA,CAAC;QAClC,MAAM,OAAO,GAAG,KAAK;YACnB,CAAC,CAAC;gBACE,WAAW,CAAC,KAAK;gBACjB,WAAW,CAAC,IAAI;gBAChB,WAAW,CAAC,MAAM;gBAClB,WAAW,CAAC,MAAM;gBAClB,WAAW,CAAC,OAAO;aACpB;YACH,CAAC,CAAC,SAAS,CAAC;QACd,MAAM,aAAa,GAAG,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,CAAC;QACtD,MAAM,eAAe,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,CAAC;QAExC,MAAM,WAAW,GAAG,CAClB,UAAkB,EAClB,MAAyC,EACzC,SAAiB,EACjB,WAAmB,EACnB,EAAE;;YAEF,MAAM,YAAY,GAAG,QAAQ;iBAC1B,KAAK,CAAC,GAAG,CAAC;iBACV,MAAM,CAAC,OAAO,CAAC;iBACf,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;iBAC3D,IAAI,CAAC,GAAG,CAAC,CAAC;YAGb,MAAM,iBAAiB,GACrB,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAE3D,MAAM,cAAc,GAAG,GAAG,iBAAiB,IAAI,YAAY,EAAE,CAAC;YAG9D,MAAM,WAAW,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC,CAAC;YAEhE,MAAM,OAAO,GAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ;gBAC/B,CAAC,CAAC;oBACE,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,IAAI,IAAI,WAAW;oBAC1C,IAAI,EAAE,IAAI;oBACV,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,OAAO;iBAClC;gBACH,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;YACnB,MAAM,gBAAgB,GACpB,UAAU,KAAK,QAAQ;gBACrB,CAAC,CAAC,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,EAAE,WAAW,EAAE,GAAG,EAAE,mBAAmB,EAAE;gBAChE,CAAC,CAAC;oBACE,GAAG,EAAE,IAAI;oBACT,GAAG,EAAE,WAAW;oBAChB,GAAG,EAAE,WAAW;oBAChB,GAAG,EAAE,mBAAmB;iBACzB,CAAC;YAER,MAAM,QAAQ,qBAAQ,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,CAAE,CAAC;YAC1C,IAAI,QAAQ,CAAC,IAAI;gBAAE,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAEnE,MAAM,QAAQ,GAAG,IAAA,6BAAmB,EAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,CAAC,CAAC;YACrD,MAAM,OAAO,+CACX,IAAI,EAAE,WAAW,IACd,OAAO,GACP,QAAQ,KAEX,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,cAAc,EAC1C,MAAM,EAAE,QAAQ,CAAC,MAAM,EACvB,IAAI,EAAE,QAAQ,CAAC,IAAI,EACnB,YAAY,EAAE,QAAQ,CAAC,YAAY,EACnC,SAAS,EAAE,CAAC,MAAA,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,0CAAE,SAAS,mCAAI,gBAAgB,CAG3D,GACF,CAAC;YACF,MAAM,EAAE,GAAG,IAAA,wBAAc,EAAC,OAAO,CAAC,CAAC;YACnC,IAAA,6BAAmB,EAAC,WAAW,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;YAE7C,MAAM,QAAQ,GAAU,EAAE,CAAC;YAC3B,MAAM,QAAQ,GACZ,UAAU,KAAK,OAAO,IAAI,UAAU,KAAK,MAAM;gBAC7C,CAAC,CAAC,MAAM;gBACR,CAAC,CAAC,UAAU,KAAK,QAAQ;oBACvB,CAAC,CAAC,QAAQ;oBACV,CAAC,CAAC,UAAU,KAAK,QAAQ;wBACvB,CAAC,CAAC,QAAQ;wBACV,CAAC,CAAC,QAAQ,CAAC;YAEnB,IAAI,CAAA,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,mBAAmB,0CAAE,MAAM,MAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,gBAAgB,CAAA,EAAE,CAAC;gBACtE,IAAI,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAC;oBAClC,MAAM,IAAI,KAAK,CACb,2EAA2E,CAC5E,CAAC;gBACJ,CAAC;gBACD,IAAI,MAAA,OAAO,CAAC,mBAAmB,0CAAE,MAAM,EAAE,CAAC;oBACxC,MAAM,SAAS,GAAG,OAAO,CAAC,mBAAmB,CAAC,GAAG,CAC/C,CAAC,CAAS,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,QAAQ,EAAE,CACnC,CAAC;oBACF,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;gBAChE,CAAC;qBAAM,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;oBACpC,MAAM,mBAAmB,GAAG,GAAG,OAAO,CAAC,gBAAgB,KAAK,QAAQ,EAAE,CAAC;oBACvE,QAAQ,CAAC,IAAI,CACX,UAAU,CAAC,iBAAiB,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAC1D,CAAC;gBACJ,CAAC;YACH,CAAC;YACD,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC;YAElC,IAAI,CAAC,KAAa,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,GAAG,QAAQ,CAAC,CAAC;QACtD,CAAC,CAAC;QAEF,MAAM,UAAU,GACd,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,mBAAmB,KAAI,OAAO,CAAC,mBAAmB,CAAC,MAAM,GAAG,CAAC,CAAC;QACzE,MAAM,OAAO,GAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,gBAAgB,KAAI,CAAC,UAAU,CAAC;QAEzD,MAAM,MAAM,GAAG;YACb,EAAE,MAAM,EAAE,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE;YACrE,EAAE,MAAM,EAAE,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE;YACvE;gBACE,MAAM,EAAE,WAAW,CAAC,IAAI;gBACxB,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,MAAM;gBACZ,OAAO,EAAE,OAAO;aACjB;YACD,EAAE,MAAM,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE;YACvE;gBACE,MAAM,EAAE,WAAW,CAAC,IAAI;gBACxB,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,WAAW;gBACjB,OAAO,EAAE,IAAI;aACd;YACD;gBACE,MAAM,EAAE,WAAW,CAAC,MAAM;gBAC1B,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,MAAM;gBACZ,OAAO,EAAE,OAAO;aACjB;YACD;gBACE,MAAM,EAAE,WAAW,CAAC,OAAO;gBAC3B,MAAM,EAAE,QAAQ;gBAChB,IAAI,EAAE,MAAM;gBACZ,OAAO,EAAE,OAAO;aACjB;SACO,CAAC;QAEX,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE;YACjE,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,aAAa,EAAE,eAAe,EAAE,GAAG,CAAC;gBAAE,OAAO;YACrE,IAAI,KAAK,IAAI,CAAC,OAAO;gBAAE,OAAO;YAE9B,MAAM,QAAQ,GAAG,CAAC,QAAQ,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC;YAE9D,IAAI,KAAK,EAAE,CAAC;gBACV,WAAW,CACT,GAAa,EACb,MAAM,EACN,QAAQ,EACR,CAAC,OAAQ,CAAC,QAAS,CAAC,IAAI;oBACtB,QAAQ,CAAC,OAAO,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC,GAAG,OAAO,CAC3D,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,IAAI,QAAQ,GAAG,CAAC,OAAO,CAAC,GAAa,CAAC,CAAC,CAAC;gBACxC,IAAI,UAAU,EAAE,CAAC;oBACf,MAAM,IAAI,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;oBACpC,QAAQ,GAAG,iBAAiB,CAAC,GAAa,EAAE,IAAI,CAAC,CAAC;gBACpD,CAAC;qBAAM,IAAI,OAAO,EAAE,CAAC;oBACnB,MAAM,IAAI,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;oBACpC,QAAQ,GAAG,cAAc,CACvB,GAAa,EACb,GAAG,OAAQ,CAAC,gBAAgB,KAAK,IAAI,EAAE,CACxC,CAAC;gBACJ,CAAC;gBACA,IAAI,CAAC,KAAa,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,GAAG,QAAQ,CAAC,CAAC;YACrD,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,aAAa,CACnB,IAA+B,EAC/B,MAAiC,EACjC,MAAmB;QAEnB,OAAO,CACL,CAAC,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC;YAClB,CAAC,IAAI,KAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,CAAC,MAAM,CAAC,CAAA,CAAC;YAChC,CAAC,MAAM,IAAI,CAAC,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,QAAQ,CAAC,MAAM,CAAC,CAAA,CAAC,CACtC,CAAC;IACJ,CAAC;IAaS,GAAG,CACX,IAAgD,EAChD,IAA6D,EAC7D,IAAyB;QAEzB,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QACvE,IAAI,CAAC,mBAAmB,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAWS,IAAI,CACZ,IAAgD,EAChD,IAA6D,EAC7D,IAAyB;QAEzB,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QACvE,IAAI,CAAC,mBAAmB,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAWS,GAAG,CACX,IAAgD,EAChD,IAA6D,EAC7D,IAAyB;QAEzB,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QACvE,IAAI,CAAC,mBAAmB,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAWS,MAAM,CACd,IAAgD,EAChD,IAA6D,EAC7D,IAAyB;QAEzB,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QACvE,IAAI,CAAC,mBAAmB,CAAC,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAWS,KAAK,CACb,IAAgD,EAChD,IAA6D,EAC7D,IAAyB;QAEzB,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QACvE,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAEO,mBAAmB,CACzB,MAAmD,EACnD,IAAY,EACZ,QAA2C,EAC3C,OAA4B;;QAE5B,IAAI,aAAa,GAAqB,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC;YAC3D,CAAC,CAAC,QAAQ;YACV,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;QAGf,IAAI,CAAA,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,mBAAmB,0CAAE,MAAM,MAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,gBAAgB,CAAA,EAAE,CAAC;YACtE,IAAI,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAC;gBAClC,MAAM,IAAI,KAAK,CACb,2EAA2E,CAC5E,CAAC;YACJ,CAAC;YACD,IAAI,MAAA,OAAO,CAAC,mBAAmB,0CAAE,MAAM,EAAE,CAAC;gBACxC,aAAa,CAAC,OAAO,CACnB,UAAU,CAAC,iBAAiB,CAAC,MAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC,CACjE,CAAC;YACJ,CAAC;iBAAM,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;gBACpC,aAAa,CAAC,OAAO,CACnB,UAAU,CAAC,iBAAiB,CAAC,OAAO,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAC/D,CAAC;YACJ,CAAC;QACH,CAAC;QAGD,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,EAAE,CAAC;YAEtB,MAAM,WAAW,GACf,OAAO,CAAC,QAAQ,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC;YAGrE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAGvD,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC;oBACzC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;oBAC/B,CAAC,CAAC,QAAQ,CAAC;YAMf,CAAC;YAGD,MAAM,gBAAgB,GACpB,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC;YAEzD,MAAM,KAAmC,OAAO,CAAC,QAAQ,EAAnD,EAAE,IAAI,EAAE,EAAE,EAAE,SAAS,OAA8B,EAAzB,IAAI,cAA9B,qBAAgC,CAAmB,CAAC;YAE1D,MAAM,QAAQ,qBAAQ,IAAI,CAAE,CAAC;YAC7B,IAAI,QAAQ,CAAC,IAAI;gBAAE,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAEnE,MAAM,QAAQ,GAAG,IAAA,6BAAmB,EAAC,QAAe,CAAC,CAAC;YACtD,MAAM,SAAS,GAAG,IAAA,wBAAc,8CAC9B,IAAI,EAAE,WAAW,IACd,QAAQ,GACR,QAAQ,KACX,SAAS,EAAE,SAAS,IAAI,gBAAgB,IACxC,CAAC;YACH,IAAA,6BAAmB,EAAC,WAAW,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;QACtD,CAAC;QAEA,IAAI,CAAC,KAAa,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,GAAG,aAAa,CAAC,CAAC;IACtD,CAAC;IAEO,WAAW,CACjB,IAAgD,EAChD,IAA6D,EAC7D,IAAyB;QAEzB,IAAI,IAAI,GAAG,GAAG,CAAC;QACf,IAAI,QAA2C,CAAC;QAChD,IAAI,OAAuC,CAAC;QAE5C,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,IAAI,GAAG,IAAI,CAAC;YACZ,QAAQ,GAAG,IAAyC,CAAC;YACrD,OAAO,GAAG,IAAI,CAAC;QACjB,CAAC;aAAM,CAAC;YACN,QAAQ,GAAG,IAAyC,CAAC;YACrD,OAAO,GAAG,IAA0B,CAAC;QACvC,CAAC;QAED,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;IACrC,CAAC;;AA9gBH,gCA+gBC;AA5gBe,8BAAmB,GAAwB;IACvD,IAAI,EAAE,MAAM;IACZ,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,QAAQ;CACjB,CAAC"}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
type SchemaShorthand = Record<string, string>;
|
|
2
|
+
type ResponseShorthand = Record<number | string, string>;
|
|
3
|
+
type ValidatorWithSchema = new () => object & {
|
|
4
|
+
schema?: Record<string, string>;
|
|
5
|
+
required?: readonly string[];
|
|
6
|
+
};
|
|
7
|
+
export interface DocOptions {
|
|
8
|
+
path: string;
|
|
9
|
+
summary?: string;
|
|
10
|
+
tags?: string[];
|
|
11
|
+
params?: SchemaShorthand | ValidatorWithSchema;
|
|
12
|
+
body?: SchemaShorthand | ValidatorWithSchema;
|
|
13
|
+
requiredBody?: string[];
|
|
14
|
+
file?: boolean;
|
|
15
|
+
responses?: ResponseShorthand;
|
|
16
|
+
auth?: boolean;
|
|
17
|
+
}
|
|
18
|
+
export declare function buildSwaggerOp(opts: DocOptions): Record<string, unknown>;
|
|
19
|
+
export {};
|
|
20
|
+
//# sourceMappingURL=builder.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"builder.d.ts","sourceRoot":"","sources":["../../../configs/swagger/builder.ts"],"names":[],"mappings":"AAGA,KAAK,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAG9C,KAAK,iBAAiB,GAAG,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,CAAC,CAAC;AAEzD,KAAK,mBAAmB,GAAG,UAAU,MAAM,GAAG;IAC5C,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,QAAQ,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CAC9B,CAAC;AAEF,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhB,MAAM,CAAC,EAAE,eAAe,GAAG,mBAAmB,CAAC;IAE/C,IAAI,CAAC,EAAE,eAAe,GAAG,mBAAmB,CAAC;IAC7C,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,SAAS,CAAC,EAAE,iBAAiB,CAAC;IAC9B,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAKD,wBAAgB,cAAc,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAoExE"}
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __rest = (this && this.__rest) || function (s, e) {
|
|
3
|
+
var t = {};
|
|
4
|
+
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
|
|
5
|
+
t[p] = s[p];
|
|
6
|
+
if (s != null && typeof Object.getOwnPropertySymbols === "function")
|
|
7
|
+
for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
|
|
8
|
+
if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
|
|
9
|
+
t[p[i]] = s[p[i]];
|
|
10
|
+
}
|
|
11
|
+
return t;
|
|
12
|
+
};
|
|
13
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
14
|
+
exports.buildSwaggerOp = buildSwaggerOp;
|
|
15
|
+
function buildSwaggerOp(opts) {
|
|
16
|
+
var _a;
|
|
17
|
+
const { path: _path, auth } = opts, rest = __rest(opts, ["path", "auth"]);
|
|
18
|
+
const op = {};
|
|
19
|
+
if (rest.summary)
|
|
20
|
+
op.summary = rest.summary;
|
|
21
|
+
if (rest.tags)
|
|
22
|
+
op.tags = rest.tags;
|
|
23
|
+
if (rest.params && Object.keys(rest.params).length) {
|
|
24
|
+
const toSchema = (v) => {
|
|
25
|
+
if (v === "number")
|
|
26
|
+
return { type: "number" };
|
|
27
|
+
if (v === "string[]" || v === "array")
|
|
28
|
+
return { type: "array", items: { type: "string" } };
|
|
29
|
+
return { type: "string" };
|
|
30
|
+
};
|
|
31
|
+
op.parameters = Object.entries(rest.params).map(([name, type]) => ({
|
|
32
|
+
name,
|
|
33
|
+
in: "query",
|
|
34
|
+
schema: toSchema(type),
|
|
35
|
+
}));
|
|
36
|
+
}
|
|
37
|
+
if (rest.file) {
|
|
38
|
+
op.requestBody = {
|
|
39
|
+
content: {
|
|
40
|
+
"multipart/form-data": {
|
|
41
|
+
schema: {
|
|
42
|
+
type: "object",
|
|
43
|
+
properties: { file: { type: "string", format: "binary" } },
|
|
44
|
+
},
|
|
45
|
+
},
|
|
46
|
+
},
|
|
47
|
+
};
|
|
48
|
+
}
|
|
49
|
+
else if (rest.body && Object.keys(rest.body).length) {
|
|
50
|
+
const required = (_a = rest.requiredBody) !== null && _a !== void 0 ? _a : Object.keys(rest.body);
|
|
51
|
+
const toSchema = (v) => {
|
|
52
|
+
if (v === "number")
|
|
53
|
+
return { type: "number" };
|
|
54
|
+
if (v === "string[]" || v === "array")
|
|
55
|
+
return { type: "array", items: { type: "string" } };
|
|
56
|
+
return { type: "string" };
|
|
57
|
+
};
|
|
58
|
+
op.requestBody = {
|
|
59
|
+
required: true,
|
|
60
|
+
content: {
|
|
61
|
+
"application/json": {
|
|
62
|
+
schema: {
|
|
63
|
+
type: "object",
|
|
64
|
+
required,
|
|
65
|
+
properties: Object.fromEntries(Object.entries(rest.body).map(([k, v]) => [k, toSchema(v)])),
|
|
66
|
+
},
|
|
67
|
+
},
|
|
68
|
+
},
|
|
69
|
+
};
|
|
70
|
+
}
|
|
71
|
+
if (rest.responses) {
|
|
72
|
+
op.responses = Object.fromEntries(Object.entries(rest.responses).map(([code, desc]) => [
|
|
73
|
+
code,
|
|
74
|
+
{ description: desc },
|
|
75
|
+
]));
|
|
76
|
+
}
|
|
77
|
+
if (auth)
|
|
78
|
+
op.security = [{ bearerAuth: [] }];
|
|
79
|
+
return op;
|
|
80
|
+
}
|
|
81
|
+
//# sourceMappingURL=builder.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"builder.js","sourceRoot":"","sources":["../../../configs/swagger/builder.ts"],"names":[],"mappings":";;;;;;;;;;;;;AA8BA,wCAoEC;AApED,SAAgB,cAAc,CAAC,IAAgB;;IAC7C,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,KAAc,IAAI,EAAb,IAAI,UAAK,IAAI,EAArC,gBAA8B,CAAO,CAAC;IAC5C,MAAM,EAAE,GAA4B,EAAE,CAAC;IAEvC,IAAI,IAAI,CAAC,OAAO;QAAE,EAAE,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;IAC5C,IAAI,IAAI,CAAC,IAAI;QAAE,EAAE,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;IAEnC,IAAI,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,CAAC;QACnD,MAAM,QAAQ,GAAG,CAAC,CAAS,EAAE,EAAE;YAC7B,IAAI,CAAC,KAAK,QAAQ;gBAAE,OAAO,EAAE,IAAI,EAAE,QAAiB,EAAE,CAAC;YACvD,IAAI,CAAC,KAAK,UAAU,IAAI,CAAC,KAAK,OAAO;gBACnC,OAAO,EAAE,IAAI,EAAE,OAAgB,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,CAAC;YAC/D,OAAO,EAAE,IAAI,EAAE,QAAiB,EAAE,CAAC;QACrC,CAAC,CAAC;QACF,EAAE,CAAC,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;YACjE,IAAI;YACJ,EAAE,EAAE,OAAO;YACX,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC;SACvB,CAAC,CAAC,CAAC;IACN,CAAC;IAED,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;QACd,EAAE,CAAC,WAAW,GAAG;YACf,OAAO,EAAE;gBACP,qBAAqB,EAAE;oBACrB,MAAM,EAAE;wBACN,IAAI,EAAE,QAAQ;wBACd,UAAU,EAAE,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE;qBAC3D;iBACF;aACF;SACF,CAAC;IACJ,CAAC;SAAM,IAAI,IAAI,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC;QACtD,MAAM,QAAQ,GAAG,MAAA,IAAI,CAAC,YAAY,mCAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7D,MAAM,QAAQ,GAAG,CAAC,CAAS,EAAE,EAAE;YAC7B,IAAI,CAAC,KAAK,QAAQ;gBAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;YAC9C,IAAI,CAAC,KAAK,UAAU,IAAI,CAAC,KAAK,OAAO;gBACnC,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,CAAC;YACtD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;QAC5B,CAAC,CAAC;QACF,EAAE,CAAC,WAAW,GAAG;YACf,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE;gBACP,kBAAkB,EAAE;oBAClB,MAAM,EAAE;wBACN,IAAI,EAAE,QAAQ;wBACd,QAAQ;wBACR,UAAU,EAAE,MAAM,CAAC,WAAW,CAC5B,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAC5D;qBACF;iBACF;aACF;SACF,CAAC;IACJ,CAAC;IAED,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;QACnB,EAAE,CAAC,SAAS,GAAG,MAAM,CAAC,WAAW,CAC/B,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC;YACnD,IAAI;YACJ,EAAE,WAAW,EAAE,IAAI,EAAE;SACtB,CAAC,CACH,CAAC;IACJ,CAAC;IAED,IAAI,IAAI;QAAE,EAAE,CAAC,QAAQ,GAAG,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC,CAAC;IAE7C,OAAO,EAAE,CAAC;AACZ,CAAC"}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
type SchemaShorthand = Record<string, string>;
|
|
2
|
+
type ResponseShorthand = Record<number | string, string>;
|
|
3
|
+
type ValidatorWithSchema = new () => object & {
|
|
4
|
+
schema?: Record<string, string>;
|
|
5
|
+
required?: readonly string[];
|
|
6
|
+
};
|
|
7
|
+
export interface ApiDocOptions {
|
|
8
|
+
summary?: string;
|
|
9
|
+
tags?: string[];
|
|
10
|
+
auth?: boolean;
|
|
11
|
+
params?: SchemaShorthand | ValidatorWithSchema;
|
|
12
|
+
body?: SchemaShorthand | ValidatorWithSchema;
|
|
13
|
+
requiredBody?: string[];
|
|
14
|
+
file?: boolean;
|
|
15
|
+
responses?: ResponseShorthand;
|
|
16
|
+
}
|
|
17
|
+
export declare function resolveApiDocSchema(opts: ApiDocOptions): {
|
|
18
|
+
params?: SchemaShorthand;
|
|
19
|
+
body?: SchemaShorthand;
|
|
20
|
+
requiredBody?: string[];
|
|
21
|
+
};
|
|
22
|
+
export {};
|
|
23
|
+
//# sourceMappingURL=decorator.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"decorator.d.ts","sourceRoot":"","sources":["../../../configs/swagger/decorator.ts"],"names":[],"mappings":"AAKA,KAAK,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAC9C,KAAK,iBAAiB,GAAG,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,CAAC,CAAC;AAEzD,KAAK,mBAAmB,GAAG,UAAU,MAAM,GAAG;IAC5C,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,QAAQ,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CAC9B,CAAC;AAEF,MAAM,WAAW,aAAa;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf,MAAM,CAAC,EAAE,eAAe,GAAG,mBAAmB,CAAC;IAE/C,IAAI,CAAC,EAAE,eAAe,GAAG,mBAAmB,CAAC;IAC7C,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,SAAS,CAAC,EAAE,iBAAiB,CAAC;CAC/B;AAgBD,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,aAAa,GAAG;IACxD,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,IAAI,CAAC,EAAE,eAAe,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB,CAeA"}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.resolveApiDocSchema = resolveApiDocSchema;
|
|
4
|
+
function getSchemaFromValidator(Validator) {
|
|
5
|
+
const v = Validator;
|
|
6
|
+
if (v === null || v === void 0 ? void 0 : v.schema) {
|
|
7
|
+
return {
|
|
8
|
+
schema: v.schema,
|
|
9
|
+
required: v.required,
|
|
10
|
+
};
|
|
11
|
+
}
|
|
12
|
+
return { schema: {} };
|
|
13
|
+
}
|
|
14
|
+
function resolveApiDocSchema(opts) {
|
|
15
|
+
var _a;
|
|
16
|
+
const params = typeof opts.params === "function"
|
|
17
|
+
? getSchemaFromValidator(opts.params).schema
|
|
18
|
+
: opts.params;
|
|
19
|
+
const body = typeof opts.body === "function"
|
|
20
|
+
? getSchemaFromValidator(opts.body).schema
|
|
21
|
+
: opts.body;
|
|
22
|
+
const requiredBody = (_a = opts.requiredBody) !== null && _a !== void 0 ? _a : (typeof opts.body === "function"
|
|
23
|
+
? getSchemaFromValidator(opts.body).required
|
|
24
|
+
: undefined);
|
|
25
|
+
return { params, body, requiredBody };
|
|
26
|
+
}
|
|
27
|
+
//# sourceMappingURL=decorator.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"decorator.js","sourceRoot":"","sources":["../../../configs/swagger/decorator.ts"],"names":[],"mappings":";;AAwCA,kDAmBC;AAjCD,SAAS,sBAAsB,CAAC,SAA8B;IAI5D,MAAM,CAAC,GAAG,SAAgB,CAAC;IAC3B,IAAI,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,MAAM,EAAE,CAAC;QACd,OAAO;YACL,MAAM,EAAE,CAAC,CAAC,MAAyB;YACnC,QAAQ,EAAE,CAAC,CAAC,QAAgC;SAC7C,CAAC;IACJ,CAAC;IACD,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;AACxB,CAAC;AAED,SAAgB,mBAAmB,CAAC,IAAmB;;IAKrD,MAAM,MAAM,GACV,OAAO,IAAI,CAAC,MAAM,KAAK,UAAU;QAC/B,CAAC,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAA6B,CAAC,CAAC,MAAM;QACnE,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;IAClB,MAAM,IAAI,GACR,OAAO,IAAI,CAAC,IAAI,KAAK,UAAU;QAC7B,CAAC,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAA2B,CAAC,CAAC,MAAM;QACjE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;IAChB,MAAM,YAAY,GAChB,MAAA,IAAI,CAAC,YAAY,mCACjB,CAAC,OAAO,IAAI,CAAC,IAAI,KAAK,UAAU;QAC9B,CAAC,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAA2B,CAAC,CAAC,QAAQ;QACnE,CAAC,CAAC,SAAS,CAAC,CAAC;IACjB,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;AACxC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../configs/swagger/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC"}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./builder"), exports);
|
|
18
|
+
__exportStar(require("./decorator"), exports);
|
|
19
|
+
__exportStar(require("./registry"), exports);
|
|
20
|
+
__exportStar(require("./server"), exports);
|
|
21
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../configs/swagger/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA0B;AAC1B,8CAA4B;AAC5B,6CAA2B;AAC3B,2CAAyB"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../../../configs/swagger/registry.ts"],"names":[],"mappings":"AAMA,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,GAAG,QAM1C;AAQD,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,GAAG,QAMf;AAMD,wBAAgB,cAAc,QAE7B"}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.setSwaggerDocument = setSwaggerDocument;
|
|
4
|
+
exports.registerSwaggerPath = registerSwaggerPath;
|
|
5
|
+
exports.getSwaggerDocs = getSwaggerDocs;
|
|
6
|
+
let swaggerDocument = {};
|
|
7
|
+
function setSwaggerDocument(doc) {
|
|
8
|
+
swaggerDocument = doc;
|
|
9
|
+
if (!swaggerDocument.paths) {
|
|
10
|
+
swaggerDocument.paths = {};
|
|
11
|
+
}
|
|
12
|
+
}
|
|
13
|
+
function registerSwaggerPath(path, method, operation) {
|
|
14
|
+
if (!swaggerDocument.paths[path]) {
|
|
15
|
+
swaggerDocument.paths[path] = {};
|
|
16
|
+
}
|
|
17
|
+
swaggerDocument.paths[path][method] = operation;
|
|
18
|
+
}
|
|
19
|
+
function getSwaggerDocs() {
|
|
20
|
+
return swaggerDocument;
|
|
21
|
+
}
|
|
22
|
+
//# sourceMappingURL=registry.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"registry.js","sourceRoot":"","sources":["../../../configs/swagger/registry.ts"],"names":[],"mappings":";;AAMA,gDAMC;AAQD,kDASC;AAMD,wCAEC;AArCD,IAAI,eAAe,GAAQ,EAAE,CAAC;AAM9B,SAAgB,kBAAkB,CAAC,GAAQ;IACzC,eAAe,GAAG,GAAG,CAAC;IAEtB,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;QAC3B,eAAe,CAAC,KAAK,GAAG,EAAE,CAAC;IAC7B,CAAC;AACH,CAAC;AAQD,SAAgB,mBAAmB,CACjC,IAAY,EACZ,MAAc,EACd,SAAc;IAEd,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACjC,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;IACnC,CAAC;IACD,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;AAClD,CAAC;AAMD,SAAgB,cAAc;IAC5B,OAAO,eAAe,CAAC;AACzB,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../../configs/swagger/server.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AASlC,wBAAgB,cAAc,CAAC,GAAG,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,EAAE,IAAI,SAAU,QAe5E"}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.setupSwaggerUI = setupSwaggerUI;
|
|
7
|
+
const swagger_ui_express_1 = __importDefault(require("swagger-ui-express"));
|
|
8
|
+
function setupSwaggerUI(app, swaggerDocs, path = "/docs") {
|
|
9
|
+
app.get("/swagger.json", (_req, res) => {
|
|
10
|
+
res.setHeader("Content-Type", "application/json");
|
|
11
|
+
res.send(swaggerDocs);
|
|
12
|
+
});
|
|
13
|
+
app.use(path, swagger_ui_express_1.default.serve, swagger_ui_express_1.default.setup(swaggerDocs, {
|
|
14
|
+
swaggerOptions: { persistAuthorization: true },
|
|
15
|
+
}));
|
|
16
|
+
}
|
|
17
|
+
//# sourceMappingURL=server.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"server.js","sourceRoot":"","sources":["../../../configs/swagger/server.ts"],"names":[],"mappings":";;;;;AASA,wCAeC;AAvBD,4EAA2C;AAQ3C,SAAgB,cAAc,CAAC,GAAY,EAAE,WAAgB,EAAE,IAAI,GAAG,OAAO;IAE3E,GAAG,CAAC,GAAG,CAAC,eAAe,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;QACrC,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QAClD,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;IAGH,GAAG,CAAC,GAAG,CACL,IAAI,EACJ,4BAAS,CAAC,KAAK,EACf,4BAAS,CAAC,KAAK,CAAC,WAAW,EAAE;QAC3B,cAAc,EAAE,EAAE,oBAAoB,EAAE,IAAI,EAAE;KAC/C,CAAC,CACH,CAAC;AACJ,CAAC"}
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAMA,cAAc,OAAO,CAAC;AACtB,cAAc,WAAW,CAAC;AAC1B,cAAc,OAAO,CAAC"}
|