nestjs-docfy 0.18.1 → 0.18.2
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 +1 -1
- package/dist/apply-docfy-metadata.js +2 -2
- package/dist/plugin/generate-metadata.d.ts +2 -2
- package/dist/plugin/generate-metadata.js +3 -3
- package/dist/plugin/generate-metadata.js.map +1 -1
- package/dist/plugin/metadata-filename.d.ts +6 -0
- package/dist/plugin/metadata-filename.js +10 -0
- package/dist/plugin/metadata-filename.js.map +1 -0
- package/dist/proxy-handler.d.ts +2 -0
- package/dist/proxy-handler.js +28 -3
- package/dist/proxy-handler.js.map +1 -1
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -813,7 +813,7 @@ If the metadata file isn't found (e.g. the plugin isn't registered in `nest-cli.
|
|
|
813
813
|
|
|
814
814
|
### `DocfyUiModule.setup(mountPath, app, options?)`
|
|
815
815
|
|
|
816
|
-
Serves [`docfy-ui`](https://www.npmjs.com/package/docfy-ui) (the AI-first documentation UI companion to this package) at `mountPath`, the same role `SwaggerModule.setup()` + `swagger-ui-express` play for raw Swagger UI. Works on both Express (`@nestjs/platform-express`) and Fastify (`@nestjs/platform-fastify`) apps. On Fastify, static asset serving needs the optional peer dependency [`@fastify/static`](https://www.npmjs.com/package/@fastify/static) (`npm install @fastify/static`), the same package `@nestjs/swagger` itself relies on for Fastify Swagger UI support.
|
|
816
|
+
Serves [`docfy-ui`](https://www.npmjs.com/package/docfy-ui) (the AI-first documentation UI companion to this package) at `mountPath`, the same role `SwaggerModule.setup()` + `swagger-ui-express` play for raw Swagger UI. Works on both Express (`@nestjs/platform-express`) and Fastify (`@nestjs/platform-fastify`) apps. On Fastify, static asset serving needs the optional peer dependency [`@fastify/static`](https://www.npmjs.com/package/@fastify/static) (`npm install @fastify/static`), the same package `@nestjs/swagger` itself relies on for Fastify Swagger UI support. Versions 8, 9 and 10 are supported; prefer `^10.1.11`, which fixes a route-guard bypass via path traversal (GHSA-83w8-p2f5-377r) — note that v10 loads ESM-only dependencies through Node's native `require(esm)`, so it needs Node 20.19+ or 22.12+.
|
|
817
817
|
|
|
818
818
|
```ts
|
|
819
819
|
import { NestFactory } from '@nestjs/core';
|
|
@@ -7,7 +7,7 @@ exports.applyDocfyMetadata = applyDocfyMetadata;
|
|
|
7
7
|
const fs_1 = __importDefault(require("fs"));
|
|
8
8
|
const path_1 = __importDefault(require("path"));
|
|
9
9
|
const merge_spec_patch_1 = require("./cli/merge-spec-patch");
|
|
10
|
-
const
|
|
10
|
+
const metadata_filename_1 = require("./plugin/metadata-filename");
|
|
11
11
|
/**
|
|
12
12
|
* Merges the build-time metadata produced by the `nestjs-docfy` CLI plugin
|
|
13
13
|
* (`nest-cli.json`'s `compilerOptions.plugins`) into an already-built OpenAPI
|
|
@@ -26,7 +26,7 @@ const generate_metadata_1 = require("./plugin/generate-metadata");
|
|
|
26
26
|
* `OpenApiDocument` shape `mergeSpecPatch` uses internally.
|
|
27
27
|
*/
|
|
28
28
|
function applyDocfyMetadata(document, options = {}) {
|
|
29
|
-
const metadataPath = options.metadataPath ?? path_1.default.join(path_1.default.dirname(require.main?.filename ?? process.cwd()),
|
|
29
|
+
const metadataPath = options.metadataPath ?? path_1.default.join(path_1.default.dirname(require.main?.filename ?? process.cwd()), metadata_filename_1.DOCFY_METADATA_FILENAME);
|
|
30
30
|
let raw;
|
|
31
31
|
try {
|
|
32
32
|
raw = fs_1.default.readFileSync(metadataPath, 'utf8');
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
|
|
2
|
-
export
|
|
1
|
+
import { DOCFY_METADATA_FILENAME } from './metadata-filename';
|
|
2
|
+
export { DOCFY_METADATA_FILENAME };
|
|
3
3
|
export interface GenerateMetadataOptions {
|
|
4
4
|
/** Absolute path to the project's tsconfig — the same one the build is using. */
|
|
5
5
|
tsConfigFilePath: string;
|
|
@@ -9,8 +9,8 @@ const fs_1 = __importDefault(require("fs"));
|
|
|
9
9
|
const path_1 = __importDefault(require("path"));
|
|
10
10
|
const scan_controllers_1 = require("../cli/scan-controllers");
|
|
11
11
|
const patch_spec_1 = require("../cli/patch-spec");
|
|
12
|
-
|
|
13
|
-
exports
|
|
12
|
+
const metadata_filename_1 = require("./metadata-filename");
|
|
13
|
+
Object.defineProperty(exports, "DOCFY_METADATA_FILENAME", { enumerable: true, get: function () { return metadata_filename_1.DOCFY_METADATA_FILENAME; } });
|
|
14
14
|
/**
|
|
15
15
|
* Scans every controller in the project via static analysis (ts-morph — the
|
|
16
16
|
* same engine `generate`/`check`/`patch-spec` already use) and writes the
|
|
@@ -38,7 +38,7 @@ function generateDocfyMetadata(options) {
|
|
|
38
38
|
}
|
|
39
39
|
}, projectsByControllerPath);
|
|
40
40
|
fs_1.default.mkdirSync(options.outDir, { recursive: true });
|
|
41
|
-
const outFile = path_1.default.join(options.outDir,
|
|
41
|
+
const outFile = path_1.default.join(options.outDir, metadata_filename_1.DOCFY_METADATA_FILENAME);
|
|
42
42
|
fs_1.default.writeFileSync(outFile, JSON.stringify(patch, null, 2), 'utf8');
|
|
43
43
|
const patchedOperationCount = Object.values(patch).reduce((count, methods) => count + Object.keys(methods).length, 0);
|
|
44
44
|
return { outFile, patchedOperationCount, controllersWithoutDocs, unparseableDocsFiles, scanErrors };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"generate-metadata.js","sourceRoot":"","sources":["../../src/plugin/generate-metadata.ts"],"names":[],"mappings":";;;;;;AAwCA,sDAiCC;AAzED,4CAAoB;AACpB,gDAAwB;AACxB,8DAAkD;AAClD,kDAAqD;
|
|
1
|
+
{"version":3,"file":"generate-metadata.js","sourceRoot":"","sources":["../../src/plugin/generate-metadata.ts"],"names":[],"mappings":";;;;;;AAwCA,sDAiCC;AAzED,4CAAoB;AACpB,gDAAwB;AACxB,8DAAkD;AAClD,kDAAqD;AAErD,2DAA8D;AAErD,wGAFA,2CAAuB,OAEA;AAuBhC;;;;;;;;;GASG;AACH,SAAgB,qBAAqB,CAAC,OAAgC;IACpE,MAAM,GAAG,GAAe;QACtB,IAAI,EAAE,KAAK;QACX,IAAI,EAAE,OAAO,CAAC,WAAW;QACzB,QAAQ,EAAE,OAAO,CAAC,gBAAgB;QAClC,cAAc,EAAE,OAAO,CAAC,cAAc,IAAI,oBAAoB;KAC/D,CAAC;IAEF,MAAM,EACJ,WAAW,EACX,MAAM,EAAE,UAAU,EAClB,wBAAwB,GACzB,GAAG,IAAA,0BAAO,EAAC,GAAG,EAAE,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;IACpE,MAAM,EAAE,KAAK,EAAE,sBAAsB,EAAE,oBAAoB,EAAE,GAAG,IAAA,6BAAgB,EAC9E,WAAW,EACX,IAAI,EACJ,CAAC,YAAY,EAAE,EAAE;QACf,IAAI,CAAC;YACH,OAAO,YAAE,CAAC,YAAY,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;QAC/C,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC,EACD,wBAAwB,CACzB,CAAC;IAEF,YAAE,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAClD,MAAM,OAAO,GAAG,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,2CAAuB,CAAC,CAAC;IACnE,YAAE,CAAC,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;IAElE,MAAM,qBAAqB,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAEtH,OAAO,EAAE,OAAO,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,oBAAoB,EAAE,UAAU,EAAE,CAAC;AACtG,CAAC"}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Filename the CLI plugin writes into the build output dir, and `applyDocfyMetadata()` reads by default.
|
|
3
|
+
* Lives in its own dependency-free file so the runtime entry can import it without pulling in
|
|
4
|
+
* the build-time scanner (ts-morph and its glob stack).
|
|
5
|
+
*/
|
|
6
|
+
export declare const DOCFY_METADATA_FILENAME = "docfy-metadata.json";
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.DOCFY_METADATA_FILENAME = void 0;
|
|
4
|
+
/**
|
|
5
|
+
* Filename the CLI plugin writes into the build output dir, and `applyDocfyMetadata()` reads by default.
|
|
6
|
+
* Lives in its own dependency-free file so the runtime entry can import it without pulling in
|
|
7
|
+
* the build-time scanner (ts-morph and its glob stack).
|
|
8
|
+
*/
|
|
9
|
+
exports.DOCFY_METADATA_FILENAME = 'docfy-metadata.json';
|
|
10
|
+
//# sourceMappingURL=metadata-filename.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"metadata-filename.js","sourceRoot":"","sources":["../../src/plugin/metadata-filename.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACU,QAAA,uBAAuB,GAAG,qBAAqB,CAAC"}
|
package/dist/proxy-handler.d.ts
CHANGED
|
@@ -1,4 +1,6 @@
|
|
|
1
1
|
export declare const PROXY_ERROR_HEADER = "x-docfy-proxy-error";
|
|
2
|
+
/** Resolved by `readJsonBody` when the raw envelope exceeds `MAX_BODY_BYTES`. */
|
|
3
|
+
export declare const BODY_TOO_LARGE: unique symbol;
|
|
2
4
|
interface RawRequestLike {
|
|
3
5
|
body?: unknown;
|
|
4
6
|
on(event: 'data' | 'end' | 'error', listener: (arg?: unknown) => void): unknown;
|
package/dist/proxy-handler.js
CHANGED
|
@@ -33,7 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
|
|
|
33
33
|
};
|
|
34
34
|
})();
|
|
35
35
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
36
|
-
exports.PROXY_ERROR_HEADER = void 0;
|
|
36
|
+
exports.BODY_TOO_LARGE = exports.PROXY_ERROR_HEADER = void 0;
|
|
37
37
|
exports.readJsonBody = readJsonBody;
|
|
38
38
|
exports.buildAllowedOrigins = buildAllowedOrigins;
|
|
39
39
|
exports.handleProxyRequest = handleProxyRequest;
|
|
@@ -59,8 +59,13 @@ const HOP_BY_HOP_HEADERS = new Set([
|
|
|
59
59
|
'proxy-authenticate',
|
|
60
60
|
'te',
|
|
61
61
|
'trailer',
|
|
62
|
+
// Always derived from the target URL by `http.request` — a client-supplied value would let the
|
|
63
|
+
// caller address a different virtual host on an allowlisted IP, bypassing the origin check.
|
|
64
|
+
'host',
|
|
62
65
|
]);
|
|
63
66
|
exports.PROXY_ERROR_HEADER = 'x-docfy-proxy-error';
|
|
67
|
+
/** Resolved by `readJsonBody` when the raw envelope exceeds `MAX_BODY_BYTES`. */
|
|
68
|
+
exports.BODY_TOO_LARGE = Symbol('docfy-proxy-body-too-large');
|
|
64
69
|
/**
|
|
65
70
|
* Reads the proxy envelope from the request. Prefers an already-parsed `req.body` (Fastify
|
|
66
71
|
* parses JSON bodies unconditionally as a core feature, so this is always populated there;
|
|
@@ -73,11 +78,27 @@ function readJsonBody(req) {
|
|
|
73
78
|
if (req.body !== undefined)
|
|
74
79
|
return Promise.resolve(req.body);
|
|
75
80
|
return new Promise((resolve) => {
|
|
76
|
-
|
|
81
|
+
// Unauthenticated route: cap the buffered envelope so a large upload can't exhaust memory.
|
|
82
|
+
const chunks = [];
|
|
83
|
+
let receivedBytes = 0;
|
|
84
|
+
let tooLarge = false;
|
|
77
85
|
req.on('data', (chunk) => {
|
|
78
|
-
|
|
86
|
+
if (tooLarge)
|
|
87
|
+
return;
|
|
88
|
+
const buf = Buffer.isBuffer(chunk) ? chunk : Buffer.from(String(chunk));
|
|
89
|
+
receivedBytes += buf.length;
|
|
90
|
+
if (receivedBytes > MAX_BODY_BYTES) {
|
|
91
|
+
tooLarge = true;
|
|
92
|
+
chunks.length = 0;
|
|
93
|
+
resolve(exports.BODY_TOO_LARGE);
|
|
94
|
+
return;
|
|
95
|
+
}
|
|
96
|
+
chunks.push(buf);
|
|
79
97
|
});
|
|
80
98
|
req.on('end', () => {
|
|
99
|
+
if (tooLarge)
|
|
100
|
+
return;
|
|
101
|
+
const raw = Buffer.concat(chunks).toString('utf8');
|
|
81
102
|
try {
|
|
82
103
|
resolve(raw ? JSON.parse(raw) : undefined);
|
|
83
104
|
}
|
|
@@ -166,6 +187,10 @@ function forward(target, method, headers, body) {
|
|
|
166
187
|
* two apart.
|
|
167
188
|
*/
|
|
168
189
|
async function handleProxyRequest(requestBody, allowedOrigins, res) {
|
|
190
|
+
if (requestBody === exports.BODY_TOO_LARGE) {
|
|
191
|
+
sendProxyError(res, 413, 'payload_too_large', 'Request body exceeded the proxy size limit.');
|
|
192
|
+
return;
|
|
193
|
+
}
|
|
169
194
|
if (!requestBody || typeof requestBody !== 'object') {
|
|
170
195
|
sendProxyError(res, 400, 'bad_request', 'Missing or malformed JSON body.');
|
|
171
196
|
return;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"proxy-handler.js","sourceRoot":"","sources":["../src/proxy-handler.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
1
|
+
{"version":3,"file":"proxy-handler.js","sourceRoot":"","sources":["../src/proxy-handler.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+CA,oCA+BC;AAkBD,kDAaC;AA+ED,gDA4DC;AAxPD,2CAA6B;AAC7B,6CAA+B;AAE/B,MAAM,cAAc,GAAG,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC,OAAO;AAChD,MAAM,UAAU,GAAG,KAAM,CAAC;AAC1B,MAAM,eAAe,GAAG,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC;AAE9F,oFAAoF;AACpF,sFAAsF;AACtF,sFAAsF;AACtF,sFAAsF;AACtF,oFAAoF;AACpF,0BAA0B;AAC1B,MAAM,kBAAkB,GAAG,IAAI,GAAG,CAAC;IACjC,YAAY;IACZ,YAAY;IACZ,mBAAmB;IACnB,gBAAgB;IAChB,kBAAkB;IAClB,SAAS;IACT,qBAAqB;IACrB,oBAAoB;IACpB,IAAI;IACJ,SAAS;IACT,+FAA+F;IAC/F,4FAA4F;IAC5F,MAAM;CACP,CAAC,CAAC;AAEU,QAAA,kBAAkB,GAAG,qBAAqB,CAAC;AAExD,iFAAiF;AACpE,QAAA,cAAc,GAAG,MAAM,CAAC,4BAA4B,CAAC,CAAC;AAOnE;;;;;;;GAOG;AACH,SAAgB,YAAY,CAAC,GAAmB;IAC9C,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS;QAAE,OAAO,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAE7D,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,2FAA2F;QAC3F,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,IAAI,aAAa,GAAG,CAAC,CAAC;QACtB,IAAI,QAAQ,GAAG,KAAK,CAAC;QACrB,GAAG,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE;YACvB,IAAI,QAAQ;gBAAE,OAAO;YACrB,MAAM,GAAG,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YACxE,aAAa,IAAI,GAAG,CAAC,MAAM,CAAC;YAC5B,IAAI,aAAa,GAAG,cAAc,EAAE,CAAC;gBACnC,QAAQ,GAAG,IAAI,CAAC;gBAChB,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;gBAClB,OAAO,CAAC,sBAAc,CAAC,CAAC;gBACxB,OAAO;YACT,CAAC;YACD,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC,CAAC,CAAC;QACH,GAAG,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;YACjB,IAAI,QAAQ;gBAAE,OAAO;YACrB,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YACnD,IAAI,CAAC;gBACH,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;YAC7C,CAAC;YAAC,MAAM,CAAC;gBACP,OAAO,CAAC,SAAS,CAAC,CAAC;YACrB,CAAC;QACH,CAAC,CAAC,CAAC;QACH,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;IAC5C,CAAC,CAAC,CAAC;AACL,CAAC;AAeD;;sDAEsD;AACtD,SAAgB,mBAAmB,CACjC,OAAsC,EACtC,UAAgC;IAEhC,MAAM,OAAO,GAAG,IAAI,GAAG,EAAU,CAAC;IAClC,KAAK,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC;QAChF,IAAI,CAAC;YACH,OAAO,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC;QACnC,CAAC;QAAC,MAAM,CAAC;YACP,+EAA+E;QACjF,CAAC;IACH,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAS,cAAc,CAAC,GAAuB,EAAE,MAAc,EAAE,KAAa,EAAE,OAAe;IAC7F,GAAG;SACA,MAAM,CAAC,MAAM,CAAC;SACd,MAAM,CAAC,0BAAkB,EAAE,KAAK,CAAC;SACjC,MAAM,CAAC,cAAc,EAAE,kBAAkB,CAAC;SAC1C,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;AAC9C,CAAC;AAED,SAAS,aAAa,CAAC,OAAsD;IAC3E,MAAM,MAAM,GAA2B,EAAE,CAAC;IAC1C,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QACpD,IAAI,KAAK,KAAK,SAAS,IAAI,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YAAE,SAAS;QAChF,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IACjE,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAQD,SAAS,OAAO,CACd,MAAW,EACX,MAAc,EACd,OAA+B,EAC/B,IAAwB;IAExB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,SAAS,GAAG,MAAM,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;QAC9D,iFAAiF;QACjF,kFAAkF;QAClF,MAAM,eAAe,GAAG,EAAE,GAAG,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAE,CAAC;QACtE,MAAM,GAAG,GAAG,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,UAAU,EAAE,EAAE,CAAC,GAAG,EAAE,EAAE;YACvG,MAAM,MAAM,GAAa,EAAE,CAAC;YAC5B,IAAI,aAAa,GAAG,CAAC,CAAC;YACtB,IAAI,SAAS,GAAG,KAAK,CAAC;YAEtB,GAAG,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAa,EAAE,EAAE;gBAC/B,aAAa,IAAI,KAAK,CAAC,MAAM,CAAC;gBAC9B,IAAI,aAAa,GAAG,cAAc,EAAE,CAAC;oBACnC,SAAS,GAAG,IAAI,CAAC;oBACjB,GAAG,CAAC,OAAO,EAAE,CAAC;oBACd,OAAO;gBACT,CAAC;gBACD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACrB,CAAC,CAAC,CAAC;YACH,GAAG,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;gBACjB,IAAI,SAAS,EAAE,CAAC;oBACd,MAAM,CAAC,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC,CAAC;oBAClE,OAAO;gBACT,CAAC;gBACD,OAAO,CAAC;oBACN,MAAM,EAAE,GAAG,CAAC,UAAU,IAAI,GAAG;oBAC7B,OAAO,EAAE,GAAG,CAAC,OAAO;oBACpB,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC;iBACjD,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;YACH,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;QAEH,GAAG,CAAC,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC,CAAC,CAAC;QACxF,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAExB,IAAI,IAAI;YAAE,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC1B,GAAG,CAAC,GAAG,EAAE,CAAC;IACZ,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,kBAAkB,CACtC,WAAoB,EACpB,cAA2B,EAC3B,GAAuB;IAEvB,IAAI,WAAW,KAAK,sBAAc,EAAE,CAAC;QACnC,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE,mBAAmB,EAAE,6CAA6C,CAAC,CAAC;QAC7F,OAAO;IACT,CAAC;IACD,IAAI,CAAC,WAAW,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;QACpD,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE,aAAa,EAAE,iCAAiC,CAAC,CAAC;QAC3E,OAAO;IACT,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,WAA+B,CAAC;IACvE,IAAI,CAAC,MAAM,IAAI,CAAC,GAAG,EAAE,CAAC;QACpB,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE,aAAa,EAAE,uCAAuC,CAAC,CAAC;QACjF,OAAO;IACT,CAAC;IAED,MAAM,WAAW,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC;IACzC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC;QACtC,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE,aAAa,EAAE,uBAAuB,MAAM,IAAI,CAAC,CAAC;QAC3E,OAAO;IACT,CAAC;IAED,IAAI,MAAW,CAAC;IAChB,IAAI,CAAC;QACH,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;IACxB,CAAC;IAAC,MAAM,CAAC;QACP,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE,aAAa,EAAE,IAAI,GAAG,uBAAuB,CAAC,CAAC;QACxE,OAAO;IACT,CAAC;IACD,IAAI,MAAM,CAAC,QAAQ,KAAK,OAAO,IAAI,MAAM,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAChE,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE,aAAa,EAAE,yBAAyB,MAAM,CAAC,QAAQ,IAAI,CAAC,CAAC;QACtF,OAAO;IACT,CAAC;IAED,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;QACvC,cAAc,CACZ,GAAG,EACH,GAAG,EACH,oBAAoB,EACpB,IAAI,MAAM,CAAC,MAAM,2GAA2G,CAC7H,CAAC;QACF,OAAO;IACT,CAAC;IAED,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,MAAM,EAAE,WAAW,EAAE,aAAa,CAAC,OAAO,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;QACtF,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC1B,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;YAC1E,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC1B,CAAC;QACD,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC5B,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,OAAO,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,wCAAwC,CAAC;QAC9F,MAAM,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAChD,cAAc,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;IAC/F,CAAC;AACH,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "nestjs-docfy",
|
|
3
|
-
"version": "0.18.
|
|
3
|
+
"version": "0.18.2",
|
|
4
4
|
"description": "Keep your NestJS controllers clean — Swagger docs live in a separate companion file by naming convention",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -81,7 +81,7 @@
|
|
|
81
81
|
"provenance": true
|
|
82
82
|
},
|
|
83
83
|
"peerDependencies": {
|
|
84
|
-
"@fastify/static": "^8.0.0 || ^9.0.0",
|
|
84
|
+
"@fastify/static": "^8.0.0 || ^9.0.0 || ^10.1.11",
|
|
85
85
|
"@nestjs/common": ">=9.0.0",
|
|
86
86
|
"@nestjs/swagger": ">=6.0.0",
|
|
87
87
|
"reflect-metadata": "^0.1.13 || ^0.2.0"
|
|
@@ -93,7 +93,7 @@
|
|
|
93
93
|
},
|
|
94
94
|
"devDependencies": {
|
|
95
95
|
"@eslint/js": "^10.0.1",
|
|
96
|
-
"@fastify/static": "^
|
|
96
|
+
"@fastify/static": "^10.1.11",
|
|
97
97
|
"@nestjs/common": "^11.0.0",
|
|
98
98
|
"@nestjs/core": "^11.0.0",
|
|
99
99
|
"@nestjs/platform-fastify": "^11.1.28",
|
|
@@ -119,8 +119,8 @@
|
|
|
119
119
|
},
|
|
120
120
|
"dependencies": {
|
|
121
121
|
"commander": "^14.0.3",
|
|
122
|
-
"docfy-core": "^0.6.
|
|
123
|
-
"docfy-ui": "^0.
|
|
122
|
+
"docfy-core": "^0.6.2",
|
|
123
|
+
"docfy-ui": "^0.11.1",
|
|
124
124
|
"express": "^5.0.0",
|
|
125
125
|
"openapi-typescript": "^7.13.0",
|
|
126
126
|
"picocolors": "^1.1.1",
|