@rsdk/cli.cmd.autodoc 5.7.0-next.2 → 6.0.0-next.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/dist/base/app.loader.d.ts +7 -0
- package/dist/base/app.loader.js +69 -0
- package/dist/base/app.loader.js.map +1 -0
- package/dist/base/document.file.d.ts +15 -0
- package/dist/base/document.file.js +30 -0
- package/dist/base/document.file.js.map +1 -0
- package/dist/base/index.d.ts +2 -0
- package/dist/base/index.js +19 -0
- package/dist/base/index.js.map +1 -0
- package/dist/commands/autodoc.cmd.d.ts +7 -0
- package/dist/commands/autodoc.cmd.js +92 -0
- package/dist/commands/autodoc.cmd.js.map +1 -0
- package/dist/commands/openapi.variation.d.ts +7 -0
- package/dist/commands/openapi.variation.js +118 -0
- package/dist/commands/openapi.variation.js.map +1 -0
- package/dist/generators/autodoc-md/autodoc-md.generator.d.ts +8 -0
- package/dist/generators/autodoc-md/autodoc-md.generator.js +37 -0
- package/dist/generators/autodoc-md/autodoc-md.generator.js.map +1 -0
- package/dist/{md-formats/md-formats.d.ts → generators/autodoc-md/formatters.d.ts} +1 -1
- package/dist/{md-formats/md-formats.js → generators/autodoc-md/formatters.js} +4 -4
- package/dist/generators/autodoc-md/formatters.js.map +1 -0
- package/dist/{fragments/core.js → generators/autodoc-md/fragments/document-fragment.abstract.js} +1 -1
- package/dist/generators/autodoc-md/fragments/document-fragment.abstract.js.map +1 -0
- package/dist/{extractor/extractor.js → generators/autodoc-md/fragments/extractor/document.extractor.js} +1 -1
- package/dist/generators/autodoc-md/fragments/extractor/document.extractor.js.map +1 -0
- package/dist/{fragments → generators/autodoc-md/fragments/implementations}/additional-sources.fragment.d.ts +1 -1
- package/dist/{fragments → generators/autodoc-md/fragments/implementations}/additional-sources.fragment.js +2 -2
- package/dist/generators/autodoc-md/fragments/implementations/additional-sources.fragment.js.map +1 -0
- package/dist/{fragments → generators/autodoc-md/fragments/implementations}/app-metadata.fragment.d.ts +4 -4
- package/dist/{fragments → generators/autodoc-md/fragments/implementations}/app-metadata.fragment.js +4 -4
- package/dist/generators/autodoc-md/fragments/implementations/app-metadata.fragment.js.map +1 -0
- package/dist/generators/autodoc-md/fragments/implementations/autodoc.fragment.d.ts +8 -0
- package/dist/{fragments → generators/autodoc-md/fragments/implementations}/autodoc.fragment.js +8 -7
- package/dist/generators/autodoc-md/fragments/implementations/autodoc.fragment.js.map +1 -0
- package/dist/{fragments/config-section → generators/autodoc-md/fragments/implementations}/config-section.fragment.d.ts +2 -1
- package/dist/{fragments/config-section → generators/autodoc-md/fragments/implementations}/config-section.fragment.js +9 -9
- package/dist/generators/autodoc-md/fragments/implementations/config-section.fragment.js.map +1 -0
- package/dist/{fragments → generators/autodoc-md/fragments/implementations}/header.fragment.d.ts +4 -4
- package/dist/{fragments → generators/autodoc-md/fragments/implementations}/header.fragment.js +4 -4
- package/dist/generators/autodoc-md/fragments/implementations/header.fragment.js.map +1 -0
- package/dist/{fragments → generators/autodoc-md/fragments/implementations}/plugin.fragment.d.ts +1 -1
- package/dist/{fragments → generators/autodoc-md/fragments/implementations}/plugin.fragment.js +2 -2
- package/dist/generators/autodoc-md/fragments/implementations/plugin.fragment.js.map +1 -0
- package/dist/{fragments → generators/autodoc-md/fragments/implementations}/transports.fragment.d.ts +1 -1
- package/dist/{fragments → generators/autodoc-md/fragments/implementations}/transports.fragment.js +2 -2
- package/dist/generators/autodoc-md/fragments/implementations/transports.fragment.js.map +1 -0
- package/dist/generators/autodoc-md/fragments/index.d.ts +9 -0
- package/dist/generators/autodoc-md/fragments/index.js +26 -0
- package/dist/generators/autodoc-md/fragments/index.js.map +1 -0
- package/dist/generators/autodoc-md/index.d.ts +1 -0
- package/dist/generators/autodoc-md/index.js +18 -0
- package/dist/generators/autodoc-md/index.js.map +1 -0
- package/dist/generators/file-generator.interface.d.ts +13 -0
- package/dist/generators/file-generator.interface.js +22 -0
- package/dist/generators/file-generator.interface.js.map +1 -0
- package/dist/generators/index.d.ts +4 -0
- package/dist/generators/index.js +21 -0
- package/dist/generators/index.js.map +1 -0
- package/dist/generators/openapi-json/index.d.ts +1 -0
- package/dist/generators/openapi-json/index.js +18 -0
- package/dist/generators/openapi-json/index.js.map +1 -0
- package/dist/generators/openapi-json/openapi-json.generator.d.ts +17 -0
- package/dist/generators/openapi-json/openapi-json.generator.js +111 -0
- package/dist/generators/openapi-json/openapi-json.generator.js.map +1 -0
- package/dist/generators/rsdk-json/index.d.ts +1 -0
- package/dist/generators/rsdk-json/index.js +18 -0
- package/dist/generators/rsdk-json/index.js.map +1 -0
- package/dist/generators/rsdk-json/rsdk-json.generator.d.ts +8 -0
- package/dist/generators/rsdk-json/rsdk-json.generator.js +23 -0
- package/dist/generators/rsdk-json/rsdk-json.generator.js.map +1 -0
- package/dist/index.d.ts +1 -7
- package/dist/index.js +3 -9
- package/dist/index.js.map +1 -1
- package/package.json +6 -2
- package/dist/autodoc.cmd.d.ts +0 -3
- package/dist/autodoc.cmd.js +0 -126
- package/dist/autodoc.cmd.js.map +0 -1
- package/dist/autodoc.context.d.ts +0 -7
- package/dist/autodoc.context.js +0 -14
- package/dist/autodoc.context.js.map +0 -1
- package/dist/autodoc.d.ts +0 -2
- package/dist/autodoc.js +0 -61
- package/dist/autodoc.js.map +0 -1
- package/dist/cli.d.ts +0 -20
- package/dist/cli.js +0 -106
- package/dist/cli.js.map +0 -1
- package/dist/document.file.d.ts +0 -7
- package/dist/document.file.js +0 -28
- package/dist/document.file.js.map +0 -1
- package/dist/documentation.d.ts +0 -9
- package/dist/documentation.js +0 -44
- package/dist/documentation.js.map +0 -1
- package/dist/extractor/extractor.js.map +0 -1
- package/dist/fragments/additional-sources.fragment.js.map +0 -1
- package/dist/fragments/app-metadata.fragment.js.map +0 -1
- package/dist/fragments/autodoc.fragment.d.ts +0 -8
- package/dist/fragments/autodoc.fragment.js.map +0 -1
- package/dist/fragments/config-section/config-section.fragment.js.map +0 -1
- package/dist/fragments/config-section/constants.d.ts +0 -1
- package/dist/fragments/config-section/constants.js +0 -5
- package/dist/fragments/config-section/constants.js.map +0 -1
- package/dist/fragments/config-section/types.d.ts +0 -4
- package/dist/fragments/config-section/types.js +0 -3
- package/dist/fragments/config-section/types.js.map +0 -1
- package/dist/fragments/core.js.map +0 -1
- package/dist/fragments/header.fragment.js.map +0 -1
- package/dist/fragments/plugin.fragment.js.map +0 -1
- package/dist/fragments/transports.fragment.js.map +0 -1
- package/dist/md-formats/md-formats.js.map +0 -1
- package/dist/openapi.generator.d.ts +0 -11
- package/dist/openapi.generator.js +0 -85
- package/dist/openapi.generator.js.map +0 -1
- package/dist/rsdk.file-generator.d.ts +0 -9
- package/dist/rsdk.file-generator.js +0 -26
- package/dist/rsdk.file-generator.js.map +0 -1
- /package/dist/{fragments/core.d.ts → generators/autodoc-md/fragments/document-fragment.abstract.d.ts} +0 -0
- /package/dist/{extractor/extractor.d.ts → generators/autodoc-md/fragments/extractor/document.extractor.d.ts} +0 -0
|
@@ -1,85 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
|
|
3
|
-
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
|
|
4
|
-
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
|
|
5
|
-
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
|
|
6
|
-
return c > 3 && r && Object.defineProperty(target, key, r), r;
|
|
7
|
-
};
|
|
8
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
|
-
exports.OpenapiGenerator = void 0;
|
|
10
|
-
const common_1 = require("@nestjs/common");
|
|
11
|
-
const core_1 = require("@nestjs/core");
|
|
12
|
-
const swagger_1 = require("@nestjs/swagger");
|
|
13
|
-
const core_2 = require("@rsdk/core");
|
|
14
|
-
const logging_1 = require("@rsdk/logging");
|
|
15
|
-
const nest_tools_1 = require("@rsdk/nest-tools");
|
|
16
|
-
const document_file_1 = require("./document.file");
|
|
17
|
-
class OpenapiGenerator {
|
|
18
|
-
appContext;
|
|
19
|
-
static logger = logging_1.LoggerFactory.create(OpenapiGenerator);
|
|
20
|
-
constructor(appContext) {
|
|
21
|
-
this.appContext = appContext;
|
|
22
|
-
}
|
|
23
|
-
async getOpenApiSpec() {
|
|
24
|
-
const context = this.appContext.platformApp.context;
|
|
25
|
-
const transports = context.options.transports;
|
|
26
|
-
if (!transports?.length) {
|
|
27
|
-
OpenapiGenerator.logger.info('transports not found');
|
|
28
|
-
return null;
|
|
29
|
-
}
|
|
30
|
-
const httpTransport = transports?.find?.(core_2.isHttpTransport);
|
|
31
|
-
if (!httpTransport) {
|
|
32
|
-
OpenapiGenerator.logger.warn('http transport not found');
|
|
33
|
-
return null;
|
|
34
|
-
}
|
|
35
|
-
OpenapiGenerator.logger.info('Generate openapi starting');
|
|
36
|
-
const root = context.getRoot();
|
|
37
|
-
const nestDefinitionIterator = new nest_tools_1.NestDefinitionIterator(root);
|
|
38
|
-
const controllers = [];
|
|
39
|
-
for await (const controller of nestDefinitionIterator.iterate(nest_tools_1.NestDefinitionType.Controllers)) {
|
|
40
|
-
controllers.push(this.clearController(controller));
|
|
41
|
-
}
|
|
42
|
-
let OpenApiModule = class OpenApiModule {
|
|
43
|
-
};
|
|
44
|
-
OpenApiModule = __decorate([
|
|
45
|
-
(0, common_1.Module)({
|
|
46
|
-
controllers,
|
|
47
|
-
})
|
|
48
|
-
], OpenApiModule);
|
|
49
|
-
const createOptions = await this.appContext.platformApp.context.getNestFactoryCreateOptions();
|
|
50
|
-
const app = await core_1.NestFactory.create(OpenApiModule, ...createOptions);
|
|
51
|
-
const metadata = await this.appContext.platformApp.getMetadata();
|
|
52
|
-
const builder = new swagger_1.DocumentBuilder()
|
|
53
|
-
.setTitle(metadata.name)
|
|
54
|
-
.setVersion(metadata.version)
|
|
55
|
-
.setDescription(metadata.description);
|
|
56
|
-
const openApiConfig = builder.build();
|
|
57
|
-
const document = swagger_1.SwaggerModule.createDocument(app, openApiConfig);
|
|
58
|
-
OpenapiGenerator.logger.info('Generate openapi finished');
|
|
59
|
-
await app.close();
|
|
60
|
-
return document;
|
|
61
|
-
}
|
|
62
|
-
async createFile() {
|
|
63
|
-
const openApiSpec = await this.getOpenApiSpec();
|
|
64
|
-
if (!openApiSpec) {
|
|
65
|
-
return null;
|
|
66
|
-
}
|
|
67
|
-
return new document_file_1.DocumentFile('openapi.json', JSON.stringify(openApiSpec, null, 2));
|
|
68
|
-
}
|
|
69
|
-
clearController(controller) {
|
|
70
|
-
class ClearedController extends controller {
|
|
71
|
-
}
|
|
72
|
-
const keysForRedefine = ['design:paramtypes', 'self:paramtypes'];
|
|
73
|
-
for (const forRedefineMetadataKey of keysForRedefine) {
|
|
74
|
-
Reflect.defineMetadata(forRedefineMetadataKey, [], ClearedController);
|
|
75
|
-
}
|
|
76
|
-
// Влияет на `operationId` в генерации
|
|
77
|
-
Object.defineProperty(ClearedController, 'name', {
|
|
78
|
-
value: controller.name,
|
|
79
|
-
writable: false,
|
|
80
|
-
});
|
|
81
|
-
return ClearedController;
|
|
82
|
-
}
|
|
83
|
-
}
|
|
84
|
-
exports.OpenapiGenerator = OpenapiGenerator;
|
|
85
|
-
//# sourceMappingURL=openapi.generator.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"openapi.generator.js","sourceRoot":"","sources":["../src/openapi.generator.ts"],"names":[],"mappings":";;;;;;;;;AACA,2CAAwC;AACxC,uCAA2C;AAC3C,6CAGyB;AAEzB,qCAA6C;AAC7C,2CAA8C;AAC9C,iDAA8E;AAG9E,mDAA+C;AAE/C,MAAa,gBAAgB;IAGP;IAFZ,MAAM,CAAC,MAAM,GAAG,uBAAa,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;IAE/D,YAAoB,UAA0B;QAA1B,eAAU,GAAV,UAAU,CAAgB;IAAG,CAAC;IAE5C,AAAN,KAAK,CAAC,cAAc;QAClB,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC;QACpD,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC;QAC9C,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;YACxB,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;YACrD,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,aAAa,GAAG,UAAU,EAAE,IAAI,EAAE,CAAC,sBAAe,CAAC,CAAC;QAC1D,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;YACzD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;QAC1D,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;QAE/B,MAAM,sBAAsB,GAAG,IAAI,mCAAsB,CAAC,IAAI,CAAC,CAAC;QAEhE,MAAM,WAAW,GAAW,EAAE,CAAC;QAE/B,IAAI,KAAK,EAAE,MAAM,UAAU,IAAI,sBAAsB,CAAC,OAAO,CAC3D,+BAAkB,CAAC,WAAW,CAC/B,EAAE,CAAC;YACF,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,UAAkB,CAAC,CAAC,CAAC;QAC7D,CAAC;QAKD,IAAM,aAAa,GAAnB,MAAM,aAAa;SAAG,CAAA;QAAhB,aAAa;YAHlB,IAAA,eAAM,EAAC;gBACN,WAAW;aACZ,CAAC;WACI,aAAa,CAAG;QAEtB,MAAM,aAAa,GACjB,MAAM,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC,2BAA2B,EAAE,CAAC;QAE1E,MAAM,GAAG,GAAG,MAAM,kBAAW,CAAC,MAAM,CAAC,aAAa,EAAE,GAAG,aAAa,CAAC,CAAC;QAEtE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,WAAW,EAAE,CAAC;QACjE,MAAM,OAAO,GAAG,IAAI,yBAAuB,EAAE;aAC1C,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC;aACvB,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC;aAC5B,cAAc,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAExC,MAAM,aAAa,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;QAEtC,MAAM,QAAQ,GAAG,uBAAa,CAAC,cAAc,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QAElE,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;QAC1D,MAAM,GAAG,CAAC,KAAK,EAAE,CAAC;QAClB,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,KAAK,CAAC,UAAU;QACd,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAChD,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,IAAI,4BAAY,CACrB,cAAc,EACd,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,CACrC,CAAC;IACJ,CAAC;IAEO,eAAe,CAAC,UAAgB;QACtC,MAAM,iBAAkB,SAAQ,UAAU;SAAG;QAE7C,MAAM,eAAe,GAAG,CAAC,mBAAmB,EAAE,iBAAiB,CAAC,CAAC;QAEjE,KAAK,MAAM,sBAAsB,IAAI,eAAe,EAAE,CAAC;YACrD,OAAO,CAAC,cAAc,CAAC,sBAAsB,EAAE,EAAE,EAAE,iBAAiB,CAAC,CAAC;QACxE,CAAC;QAED,sCAAsC;QACtC,MAAM,CAAC,cAAc,CAAC,iBAAiB,EAAE,MAAM,EAAE;YAC/C,KAAK,EAAE,UAAU,CAAC,IAAI;YACtB,QAAQ,EAAE,KAAK;SAChB,CAAC,CAAC;QAEH,OAAO,iBAAiB,CAAC;IAC3B,CAAC;;AAnFH,4CAoFC"}
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
import type { AutodocContext } from './autodoc.context';
|
|
2
|
-
import { DocumentFile } from './document.file';
|
|
3
|
-
export declare class RsdkFileGenerator {
|
|
4
|
-
readonly autodocContext: AutodocContext;
|
|
5
|
-
static logger: import("@rsdk/logging").ILogger;
|
|
6
|
-
constructor(autodocContext: AutodocContext);
|
|
7
|
-
createFile(): Promise<DocumentFile>;
|
|
8
|
-
private getAllResources;
|
|
9
|
-
}
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.RsdkFileGenerator = void 0;
|
|
4
|
-
const logging_1 = require("@rsdk/logging");
|
|
5
|
-
const document_file_1 = require("./document.file");
|
|
6
|
-
class RsdkFileGenerator {
|
|
7
|
-
autodocContext;
|
|
8
|
-
static logger = logging_1.LoggerFactory.create(RsdkFileGenerator);
|
|
9
|
-
constructor(autodocContext) {
|
|
10
|
-
this.autodocContext = autodocContext;
|
|
11
|
-
}
|
|
12
|
-
async createFile() {
|
|
13
|
-
RsdkFileGenerator.logger.info('start generating rsdk.json');
|
|
14
|
-
const rsdkMetadata = await this.getAllResources();
|
|
15
|
-
const metadata = await this.autodocContext.platformApp.getMetadata();
|
|
16
|
-
const rsdkJsonFile = new document_file_1.DocumentFile('rsdk.json', JSON.stringify({ metadata, rsdkMetadata }, null, 2));
|
|
17
|
-
RsdkFileGenerator.logger.info('Generating rsdk.json finished');
|
|
18
|
-
return rsdkJsonFile;
|
|
19
|
-
}
|
|
20
|
-
async getAllResources() {
|
|
21
|
-
// eslint-disable-next-line unicorn/no-await-expression-member
|
|
22
|
-
return (await this.autodocContext.getRsdkMetadataProvider()).get();
|
|
23
|
-
}
|
|
24
|
-
}
|
|
25
|
-
exports.RsdkFileGenerator = RsdkFileGenerator;
|
|
26
|
-
//# sourceMappingURL=rsdk.file-generator.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"rsdk.file-generator.js","sourceRoot":"","sources":["../src/rsdk.file-generator.ts"],"names":[],"mappings":";;;AAAA,2CAA8C;AAI9C,mDAA+C;AAE/C,MAAa,iBAAiB;IAGP;IAFrB,MAAM,CAAC,MAAM,GAAG,uBAAa,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;IAExD,YAAqB,cAA8B;QAA9B,mBAAc,GAAd,cAAc,CAAgB;IAAG,CAAC;IAEvD,KAAK,CAAC,UAAU;QACd,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;QAC5D,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;QAClD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,WAAW,EAAE,CAAC;QAErE,MAAM,YAAY,GAAG,IAAI,4BAAY,CACnC,WAAW,EACX,IAAI,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,YAAY,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CACpD,CAAC;QAEF,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;QAC/D,OAAO,YAAY,CAAC;IACtB,CAAC;IAEO,KAAK,CAAC,eAAe;QAC3B,8DAA8D;QAC9D,OAAO,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC,uBAAuB,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC;IACrE,CAAC;;AAtBH,8CAuBC"}
|
|
File without changes
|
|
File without changes
|