nestjs-docfy 0.18.0 → 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/cli/check.d.ts +12 -1
- package/dist/cli/check.js +17 -46
- package/dist/cli/check.js.map +1 -1
- package/dist/cli/coverage.js +1 -1
- package/dist/cli/coverage.js.map +1 -1
- package/dist/cli/detect-project.js +11 -1
- package/dist/cli/detect-project.js.map +1 -1
- package/dist/cli/extract-docs-config.d.ts +8 -2
- package/dist/cli/extract-docs-config.js +20 -10
- package/dist/cli/extract-docs-config.js.map +1 -1
- package/dist/cli/find-docs-call.d.ts +19 -0
- package/dist/cli/find-docs-call.js +64 -0
- package/dist/cli/find-docs-call.js.map +1 -0
- package/dist/cli/generate-file.d.ts +13 -0
- package/dist/cli/generate-file.js +25 -39
- package/dist/cli/generate-file.js.map +1 -1
- package/dist/cli/index.js +12 -4
- package/dist/cli/index.js.map +1 -1
- package/dist/cli/merge-docs.d.ts +34 -0
- package/dist/cli/merge-docs.js +171 -10
- package/dist/cli/merge-docs.js.map +1 -1
- package/dist/cli/patch-spec.js +1 -1
- package/dist/cli/patch-spec.js.map +1 -1
- package/dist/cli/project-types.d.ts +2 -0
- package/dist/cli/scan-controllers.d.ts +1 -1
- package/dist/cli/scan-controllers.js +16 -2
- package/dist/cli/scan-controllers.js.map +1 -1
- package/dist/cli/writer.d.ts +14 -2
- package/dist/cli/writer.js +74 -41
- package/dist/cli/writer.js.map +1 -1
- 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
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"patch-spec.js","sourceRoot":"","sources":["../../src/cli/patch-spec.ts"],"names":[],"mappings":";;AAyEA,
|
|
1
|
+
{"version":3,"file":"patch-spec.js","sourceRoot":"","sources":["../../src/cli/patch-spec.ts"],"names":[],"mappings":";;AAyEA,4CAsCC;AAaD,wDAwBC;AAnJD,yDAAwD;AACxD,+DAA0D;AAC1D,+DAAqF;AACrF,yDAAuG;AAqBvG;;;;;;;;;;GAUG;AACH,SAAS,YAAY,CAAC,CAAY,EAAE,CAAY;IAC9C,MAAM,MAAM,GAAc,EAAE,GAAG,CAAC,EAAE,CAAC;IACnC,KAAK,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;QACjD,MAAM,MAAM,GAAmC,EAAE,GAAG,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;QACpE,KAAK,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YAC5D,MAAM,QAAQ,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;YACpC,MAAM,CAAC,UAAU,CAAC,GAAG,QAAQ;gBAC3B,CAAC,CAAE,IAAA,iCAAc,EAAC,QAA4B,EAAE,OAAO,CAAoB;gBAC3E,CAAC,CAAC,OAAO,CAAC;QACd,CAAC;QACD,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC;IACzB,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,SAAgB,gBAAgB,CAC9B,WAA6B,EAC7B,MAAmB,EACnB,YAAqD,EACrD,wBAA+C;IAE/C,IAAI,KAAK,GAAc,EAAE,CAAC;IAC1B,MAAM,sBAAsB,GAAa,EAAE,CAAC;IAC5C,MAAM,oBAAoB,GAAa,EAAE,CAAC;IAE1C,KAAK,MAAM,IAAI,IAAI,WAAW,EAAE,CAAC;QAC/B,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YACtB,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC5C,SAAS;QACX,CAAC;QAED,MAAM,QAAQ,GAAG,IAAA,qCAAkB,EAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAC3D,MAAM,OAAO,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;QACvC,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;YACrB,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACpC,SAAS;QACX,CAAC;QAED,MAAM,OAAO,GAAG,wBAAwB,EAAE,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC7D,MAAM,MAAM,GAAG,IAAA,uCAAiB,EAC9B,OAAO,EACP,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS,EACzD,IAAI,CAAC,SAAS,CACf,CAAC;QACF,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACpC,SAAS;QACX,CAAC;QAED,KAAK,GAAG,YAAY,CAAC,KAAK,EAAE,IAAA,uCAAiB,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;IAC/D,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,sBAAsB,EAAE,oBAAoB,EAAE,CAAC;AACjE,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,sBAAsB,CACpC,QAAyB,EACzB,WAA6B,EAC7B,MAAmB,EACnB,YAAqD,EACrD,wBAA+C;IAE/C,MAAM,EAAE,KAAK,EAAE,sBAAsB,EAAE,oBAAoB,EAAE,GAAG,gBAAgB,CAC9E,WAAW,EACX,MAAM,EACN,YAAY,EACZ,wBAAwB,CACzB,CAAC;IAEF,MAAM,EAAE,QAAQ,EAAE,eAAe,EAAE,eAAe,EAAE,GAAG,IAAA,iCAAc,EAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IACvF,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;QACL,QAAQ,EAAE,eAAe;QACzB,qBAAqB;QACrB,eAAe;QACf,sBAAsB;QACtB,oBAAoB;KACrB,CAAC;AACJ,CAAC"}
|
|
@@ -10,6 +10,8 @@ export interface ProjectApp {
|
|
|
10
10
|
controllerGlob: string;
|
|
11
11
|
/** Absolute path to the app's bootstrap file (main.ts), when it could be resolved. */
|
|
12
12
|
entryFile?: string;
|
|
13
|
+
/** True for a library project (Nest CLI `"type": "library"`, NX `"projectType": "library"`) — never has a bootstrap file, by definition. */
|
|
14
|
+
isLibrary?: boolean;
|
|
13
15
|
}
|
|
14
16
|
export interface ProjectContext {
|
|
15
17
|
kind: ProjectKind;
|
|
@@ -28,7 +28,7 @@ export declare function deriveDocsFilePath(controllerPath: string, format: 'ts'
|
|
|
28
28
|
* Scans all controllers for a single app using static analysis only (ts-morph).
|
|
29
29
|
* Never executes any user code.
|
|
30
30
|
*/
|
|
31
|
-
export declare function scanApp(app: ProjectApp, projectRoot: string, patternOverride: string | undefined, format: 'ts' | 'js'): ScanResult;
|
|
31
|
+
export declare function scanApp(app: ProjectApp, projectRoot: string, patternOverride: string | undefined, format: 'ts' | 'js', otherAppRoots?: string[]): ScanResult;
|
|
32
32
|
/**
|
|
33
33
|
* Scans all apps in a project context and merges results.
|
|
34
34
|
*/
|
|
@@ -46,9 +46,10 @@ function deriveDocsFilePath(controllerPath, format) {
|
|
|
46
46
|
* Scans all controllers for a single app using static analysis only (ts-morph).
|
|
47
47
|
* Never executes any user code.
|
|
48
48
|
*/
|
|
49
|
-
function scanApp(app, projectRoot, patternOverride, format) {
|
|
49
|
+
function scanApp(app, projectRoot, patternOverride, format, otherAppRoots = []) {
|
|
50
50
|
const controllers = [];
|
|
51
51
|
const errors = [];
|
|
52
|
+
const normalizedOtherRoots = otherAppRoots.map((r) => path_1.default.resolve(r));
|
|
52
53
|
let project;
|
|
53
54
|
try {
|
|
54
55
|
project = new ts_morph_1.Project({
|
|
@@ -83,6 +84,18 @@ function scanApp(app, projectRoot, patternOverride, format) {
|
|
|
83
84
|
catch {
|
|
84
85
|
return false;
|
|
85
86
|
}
|
|
87
|
+
// Exclude files under a sibling app's own root. A tsconfig whose
|
|
88
|
+
// `include` is broader than its app directory (e.g. a monorepo-wide base
|
|
89
|
+
// tsconfig some projects add for editor tooling, inherited via
|
|
90
|
+
// `extends`) otherwise makes every app's scan also pick up every OTHER
|
|
91
|
+
// app's controllers — duplicating them across apps, and silently
|
|
92
|
+
// conflating two same-named classes from different apps (e.g. a gateway
|
|
93
|
+
// and the service it proxies both having an `AuthController`) into one
|
|
94
|
+
// apparent controller in `check`/`generate` output. Files outside every
|
|
95
|
+
// app's root (shared libs) are unaffected and still scanned normally.
|
|
96
|
+
if (normalizedOtherRoots.some((root) => real === root || real.startsWith(root + path_1.default.sep))) {
|
|
97
|
+
return false;
|
|
98
|
+
}
|
|
86
99
|
// Match against controller naming convention
|
|
87
100
|
const baseName = path_1.default.basename(filePath);
|
|
88
101
|
if (glob === '**/*.controller.ts') {
|
|
@@ -154,7 +167,8 @@ function scanAllApps(apps, projectRoot, patternOverride, format) {
|
|
|
154
167
|
const allErrors = [];
|
|
155
168
|
const projectsByControllerPath = new Map();
|
|
156
169
|
for (const app of apps) {
|
|
157
|
-
const
|
|
170
|
+
const otherAppRoots = apps.filter((a) => a !== app).map((a) => a.root);
|
|
171
|
+
const result = scanApp(app, projectRoot, patternOverride, format, otherAppRoots);
|
|
158
172
|
allControllers.push(...result.controllers);
|
|
159
173
|
allErrors.push(...result.errors);
|
|
160
174
|
for (const [filePath, project] of result.projectsByControllerPath) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"scan-controllers.js","sourceRoot":"","sources":["../../src/cli/scan-controllers.ts"],"names":[],"mappings":";;;;;AAwDA,gDAIC;AAMD,
|
|
1
|
+
{"version":3,"file":"scan-controllers.js","sourceRoot":"","sources":["../../src/cli/scan-controllers.ts"],"names":[],"mappings":";;;;;AAwDA,gDAIC;AAMD,0BA6HC;AAKD,kCAqBC;AAzND,4CAAoB;AACpB,gDAAwB;AACxB,uCAAmC;AACnC,6CAAgD;AAChD,uDAAiH;AAuBjH;;GAEG;AACH,SAAS,YAAY,CAAC,QAAgB;IACpC,IAAI,CAAC;QACH,OAAO,YAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IACnC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,SAAS,eAAe,CAAC,QAAgB;IACvC,MAAM,UAAU,GAAG,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAChD,OAAO,CACL,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC;QAC7B,UAAU,CAAC,QAAQ,CAAC,gBAAgB,CAAC;QACrC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC;QAC1B,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CACzB,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,SAAgB,kBAAkB,CAAC,cAAsB,EAAE,MAAmB;IAC5E,MAAM,GAAG,GAAG,cAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;IACzC,MAAM,IAAI,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAClD,OAAO,GAAG,IAAI,SAAS,MAAM,EAAE,CAAC;AAClC,CAAC;AAED;;;GAGG;AACH,SAAgB,OAAO,CACrB,GAAe,EACf,WAAmB,EACnB,eAAmC,EACnC,MAAmB,EACnB,gBAA0B,EAAE;IAE5B,MAAM,WAAW,GAAqB,EAAE,CAAC;IACzC,MAAM,MAAM,GAAgB,EAAE,CAAC;IAC/B,MAAM,oBAAoB,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,cAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IAEvE,IAAI,OAAgB,CAAC;IACrB,IAAI,CAAC;QACH,OAAO,GAAG,IAAI,kBAAO,CAAC;YACpB,gBAAgB,EAAE,GAAG,CAAC,QAAQ;YAC9B,2BAA2B,EAAE,KAAK;YAClC,4BAA4B,EAAE,IAAI;SACnC,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,CAAC,IAAI,CAAC;YACV,IAAI,EAAE,GAAG,CAAC,QAAQ;YAClB,OAAO,EAAE,4BAA4B,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE;SACxF,CAAC,CAAC;QACH,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,wBAAwB,EAAE,IAAI,GAAG,EAAE,EAAE,CAAC;IACtE,CAAC;IAED,uCAAuC;IACvC,MAAM,IAAI,GAAG,eAAe,IAAI,GAAG,CAAC,cAAc,CAAC;IACnD,IAAI,WAAW,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IAE3C,uDAAuD;IACvD,WAAW,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE;QACtC,MAAM,QAAQ,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;QAElC,uCAAuC;QACvC,IAAI,eAAe,CAAC,QAAQ,CAAC;YAAE,OAAO,KAAK,CAAC;QAE5C,4EAA4E;QAC5E,MAAM,IAAI,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;QACpC,IAAI,CAAC,IAAI;YAAE,OAAO,KAAK,CAAC;QACxB,IAAI,CAAC;YACH,IAAA,6BAAgB,EAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QACtC,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,KAAK,CAAC;QACf,CAAC;QAED,iEAAiE;QACjE,yEAAyE;QACzE,+DAA+D;QAC/D,uEAAuE;QACvE,iEAAiE;QACjE,wEAAwE;QACxE,uEAAuE;QACvE,wEAAwE;QACxE,sEAAsE;QACtE,IAAI,oBAAoB,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,IAAI,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,GAAG,cAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;YAC3F,OAAO,KAAK,CAAC;QACf,CAAC;QAED,6CAA6C;QAC7C,MAAM,QAAQ,GAAG,cAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACzC,IAAI,IAAI,KAAK,oBAAoB,EAAE,CAAC;YAClC,OAAO,QAAQ,CAAC,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC/E,CAAC;QAED,wDAAwD;QACxD,MAAM,OAAO,GAAG,cAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACzD,OAAO,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC5C,CAAC,CAAC,CAAC;IAEH,KAAK,MAAM,EAAE,IAAI,WAAW,EAAE,CAAC;QAC7B,MAAM,QAAQ,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;QAElC,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,EAAE,CAAC,UAAU,EAAE,CAAC;YAEhC,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;gBAC1B,kDAAkD;gBAClD,MAAM,aAAa,GAAG,GAAG,CAAC,aAAa,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE;oBACnD,IAAI,CAAC;wBACH,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,YAAY,CAAC;oBACtC,CAAC;oBAAC,MAAM,CAAC;wBACP,OAAO,KAAK,CAAC;oBACf,CAAC;gBACH,CAAC,CAAC,CAAC;gBACH,IAAI,CAAC,aAAa;oBAAE,SAAS;gBAE7B,MAAM,SAAS,GAAG,GAAG,CAAC,OAAO,EAAE,CAAC;gBAChC,IAAI,CAAC,SAAS;oBAAE,SAAS;gBAEzB,MAAM,cAAc,GAAG,IAAA,uCAAqB,EAAC,GAAG,CAAC,CAAC;gBAClD,MAAM,sBAAsB,GAAG,IAAA,uCAAqB,EAAC,GAAG,CAAC,CAAC;gBAC1D,MAAM,OAAO,GAAG,IAAA,gCAAc,EAAC,GAAG,EAAE,sBAAsB,CAAC,CAAC;gBAE5D,MAAM,YAAY,GAAG,kBAAkB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;gBAC1D,MAAM,WAAW,GAAG,CAAC,GAAG,EAAE;oBACxB,IAAI,CAAC;wBACH,YAAE,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;wBAC5B,OAAO,IAAI,CAAC;oBACd,CAAC;oBAAC,MAAM,CAAC;wBACP,OAAO,KAAK,CAAC;oBACf,CAAC;gBACH,CAAC,CAAC,EAAE,CAAC;gBAEL,WAAW,CAAC,IAAI,CAAC;oBACf,SAAS;oBACT,QAAQ;oBACR,cAAc;oBACd,OAAO;oBACP,WAAW;oBACX,sBAAsB;iBACvB,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;aAC1D,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,MAAM,wBAAwB,GAAG,IAAI,GAAG,EAAmB,CAAC;IAC5D,KAAK,MAAM,IAAI,IAAI,WAAW;QAAE,wBAAwB,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAErF,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,wBAAwB,EAAE,CAAC;AAC3D,CAAC;AAED;;GAEG;AACH,SAAgB,WAAW,CACzB,IAAkB,EAClB,WAAmB,EACnB,eAAmC,EACnC,MAAmB;IAEnB,MAAM,cAAc,GAAqB,EAAE,CAAC;IAC5C,MAAM,SAAS,GAAgB,EAAE,CAAC;IAClC,MAAM,wBAAwB,GAAG,IAAI,GAAG,EAAmB,CAAC;IAE5D,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACvE,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC;QACjF,cAAc,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;QAC3C,SAAS,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;QACjC,KAAK,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,wBAAwB,EAAE,CAAC;YAClE,wBAAwB,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAClD,CAAC;IACH,CAAC;IAED,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,EAAE,SAAS,EAAE,wBAAwB,EAAE,CAAC;AACtF,CAAC"}
|
package/dist/cli/writer.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { ControllerInfo } from './extract-methods';
|
|
2
|
-
export type WriteOutcome = 'created' | 'skipped' | 'merged' | 'overwritten' | 'dry' | 'error';
|
|
2
|
+
export type WriteOutcome = 'created' | 'appended' | 'skipped' | 'merged' | 'overwritten' | 'dry' | 'error';
|
|
3
3
|
export interface WriteResult {
|
|
4
4
|
controllerClass: string;
|
|
5
5
|
docsFilePath: string;
|
|
@@ -19,7 +19,19 @@ export interface WriterOptions {
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* Writes (or previews) the docs file for a single controller.
|
|
22
|
-
* Handles: create, skip, merge (--force), dry-run.
|
|
22
|
+
* Handles: create, append, skip, merge (--force), overwrite, dry-run.
|
|
23
|
+
*
|
|
24
|
+
* "Exists" is tracked per-CLASS, not per-file: a companion file can hold one
|
|
25
|
+
* `docs(Class, {...})` call per `@Controller` class in the source file it
|
|
26
|
+
* mirrors (a single file exporting several controllers is a normal
|
|
27
|
+
* pattern), so a file that's on disk but doesn't yet document THIS class is
|
|
28
|
+
* treated the same as a brand-new file for this class — new content gets
|
|
29
|
+
* appended alongside whatever the file already documents, never dropped via
|
|
30
|
+
* a full-file overwrite. Without this distinction, the 2nd/3rd controller in
|
|
31
|
+
* a shared file used to be reported "already exists" the moment the 1st
|
|
32
|
+
* controller's own write created the file, and `--force` would then merge
|
|
33
|
+
* that controller's methods into the FIRST class's `docs()` call instead of
|
|
34
|
+
* creating its own.
|
|
23
35
|
*/
|
|
24
36
|
export declare function writeDocsFile(ctrl: ControllerInfo, opts: WriterOptions): WriteResult;
|
|
25
37
|
/**
|
package/dist/cli/writer.js
CHANGED
|
@@ -26,7 +26,19 @@ function resolveOutputPath(ctrl, opts) {
|
|
|
26
26
|
}
|
|
27
27
|
/**
|
|
28
28
|
* Writes (or previews) the docs file for a single controller.
|
|
29
|
-
* Handles: create, skip, merge (--force), dry-run.
|
|
29
|
+
* Handles: create, append, skip, merge (--force), overwrite, dry-run.
|
|
30
|
+
*
|
|
31
|
+
* "Exists" is tracked per-CLASS, not per-file: a companion file can hold one
|
|
32
|
+
* `docs(Class, {...})` call per `@Controller` class in the source file it
|
|
33
|
+
* mirrors (a single file exporting several controllers is a normal
|
|
34
|
+
* pattern), so a file that's on disk but doesn't yet document THIS class is
|
|
35
|
+
* treated the same as a brand-new file for this class — new content gets
|
|
36
|
+
* appended alongside whatever the file already documents, never dropped via
|
|
37
|
+
* a full-file overwrite. Without this distinction, the 2nd/3rd controller in
|
|
38
|
+
* a shared file used to be reported "already exists" the moment the 1st
|
|
39
|
+
* controller's own write created the file, and `--force` would then merge
|
|
40
|
+
* that controller's methods into the FIRST class's `docs()` call instead of
|
|
41
|
+
* creating its own.
|
|
30
42
|
*/
|
|
31
43
|
function writeDocsFile(ctrl, opts) {
|
|
32
44
|
let docsFilePath;
|
|
@@ -42,15 +54,6 @@ function writeDocsFile(ctrl, opts) {
|
|
|
42
54
|
error: err instanceof Error ? err.message : String(err),
|
|
43
55
|
};
|
|
44
56
|
}
|
|
45
|
-
const exists = (() => {
|
|
46
|
-
try {
|
|
47
|
-
fs_1.default.accessSync(docsFilePath);
|
|
48
|
-
return true;
|
|
49
|
-
}
|
|
50
|
-
catch {
|
|
51
|
-
return false;
|
|
52
|
-
}
|
|
53
|
-
})();
|
|
54
57
|
// --- DRY RUN ---
|
|
55
58
|
if (opts.dryRun) {
|
|
56
59
|
const content = (0, generate_file_1.renderDocsFile)(ctrl, docsFilePath, opts.format);
|
|
@@ -60,32 +63,72 @@ function writeDocsFile(ctrl, opts) {
|
|
|
60
63
|
process.stdout.write(content);
|
|
61
64
|
return { controllerClass: ctrl.className, docsFilePath, outcome: 'dry' };
|
|
62
65
|
}
|
|
63
|
-
|
|
64
|
-
|
|
66
|
+
let existingContent;
|
|
67
|
+
try {
|
|
68
|
+
existingContent = fs_1.default.readFileSync(docsFilePath, 'utf8');
|
|
69
|
+
}
|
|
70
|
+
catch {
|
|
71
|
+
existingContent = null;
|
|
72
|
+
}
|
|
73
|
+
const classDocumented = existingContent !== null && (0, merge_docs_1.classHasDocsCall)(existingContent, ctrl.className);
|
|
74
|
+
const fail = (err) => ({
|
|
75
|
+
controllerClass: ctrl.className,
|
|
76
|
+
docsFilePath,
|
|
77
|
+
outcome: 'error',
|
|
78
|
+
error: err instanceof Error ? err.message : String(err),
|
|
79
|
+
});
|
|
80
|
+
// --- SKIP (this class is already documented, neither --force nor --overwrite) ---
|
|
81
|
+
if (classDocumented && !opts.force && !opts.overwrite) {
|
|
65
82
|
return { controllerClass: ctrl.className, docsFilePath, outcome: 'skipped' };
|
|
66
83
|
}
|
|
67
|
-
// ---
|
|
68
|
-
|
|
84
|
+
// --- APPEND (file exists but doesn't document this class yet — nothing to
|
|
85
|
+
// merge/overwrite FOR THIS CLASS, and a full-file overwrite here would
|
|
86
|
+
// destroy every other class already documented in the file) ---
|
|
87
|
+
if (existingContent !== null && !classDocumented) {
|
|
69
88
|
try {
|
|
70
|
-
const
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
89
|
+
const appended = (0, merge_docs_1.appendDocsCall)(existingContent, ctrl, docsFilePath, opts.format);
|
|
90
|
+
if (appended !== null) {
|
|
91
|
+
fs_1.default.writeFileSync(docsFilePath, appended, 'utf8');
|
|
92
|
+
return { controllerClass: ctrl.className, docsFilePath, outcome: 'appended' };
|
|
93
|
+
}
|
|
94
|
+
// Existing content unparseable — fall through to full create/overwrite below.
|
|
75
95
|
}
|
|
76
96
|
catch (err) {
|
|
77
|
-
return
|
|
78
|
-
controllerClass: ctrl.className,
|
|
79
|
-
docsFilePath,
|
|
80
|
-
outcome: 'error',
|
|
81
|
-
error: err instanceof Error ? err.message : String(err),
|
|
82
|
-
};
|
|
97
|
+
return fail(err);
|
|
83
98
|
}
|
|
84
99
|
}
|
|
85
|
-
// ---
|
|
86
|
-
|
|
100
|
+
// --- OVERWRITE (file exists, --overwrite, this class already has a call) ---
|
|
101
|
+
// A file shared with OTHER classes must only have THIS class's call
|
|
102
|
+
// replaced (replaceDocsCall) — a plain full-file regenerate would destroy
|
|
103
|
+
// every sibling class's docs(). A single-class file has no such risk, so
|
|
104
|
+
// it keeps the simpler "regenerate the whole file from scratch" behavior
|
|
105
|
+
// (including dropping any stray content outside the docs() call itself,
|
|
106
|
+
// which --overwrite has always promised).
|
|
107
|
+
if (existingContent !== null && classDocumented && opts.overwrite) {
|
|
108
|
+
try {
|
|
109
|
+
if ((0, merge_docs_1.hasOtherClassDocsCall)(existingContent, ctrl.className)) {
|
|
110
|
+
const replaced = (0, merge_docs_1.replaceDocsCall)(existingContent, ctrl, docsFilePath, opts.format);
|
|
111
|
+
if (replaced !== null) {
|
|
112
|
+
fs_1.default.writeFileSync(docsFilePath, replaced, 'utf8');
|
|
113
|
+
return { controllerClass: ctrl.className, docsFilePath, outcome: 'overwritten' };
|
|
114
|
+
}
|
|
115
|
+
// Existing content unparseable — fall through to full create/overwrite below.
|
|
116
|
+
}
|
|
117
|
+
else {
|
|
118
|
+
const dir = path_1.default.dirname(docsFilePath);
|
|
119
|
+
fs_1.default.mkdirSync(dir, { recursive: true });
|
|
120
|
+
const content = (0, generate_file_1.renderDocsFile)(ctrl, docsFilePath, opts.format);
|
|
121
|
+
fs_1.default.writeFileSync(docsFilePath, content, 'utf8');
|
|
122
|
+
return { controllerClass: ctrl.className, docsFilePath, outcome: 'overwritten' };
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
catch (err) {
|
|
126
|
+
return fail(err);
|
|
127
|
+
}
|
|
128
|
+
}
|
|
129
|
+
// --- MERGE (file exists, --force, this class already has a call) ---
|
|
130
|
+
if (existingContent !== null && classDocumented && opts.force) {
|
|
87
131
|
try {
|
|
88
|
-
const existingContent = fs_1.default.readFileSync(docsFilePath, 'utf8');
|
|
89
132
|
const merged = (0, merge_docs_1.mergeDocsFile)(existingContent, ctrl);
|
|
90
133
|
if (merged) {
|
|
91
134
|
fs_1.default.writeFileSync(docsFilePath, merged.content, 'utf8');
|
|
@@ -99,15 +142,10 @@ function writeDocsFile(ctrl, opts) {
|
|
|
99
142
|
// Merge failed (unparseable file) — fall through to full overwrite
|
|
100
143
|
}
|
|
101
144
|
catch (err) {
|
|
102
|
-
return
|
|
103
|
-
controllerClass: ctrl.className,
|
|
104
|
-
docsFilePath,
|
|
105
|
-
outcome: 'error',
|
|
106
|
-
error: err instanceof Error ? err.message : String(err),
|
|
107
|
-
};
|
|
145
|
+
return fail(err);
|
|
108
146
|
}
|
|
109
147
|
}
|
|
110
|
-
// --- CREATE (new file, or
|
|
148
|
+
// --- CREATE (new file, or fallback after a failed append/merge/replace) ---
|
|
111
149
|
try {
|
|
112
150
|
const dir = path_1.default.dirname(docsFilePath);
|
|
113
151
|
fs_1.default.mkdirSync(dir, { recursive: true });
|
|
@@ -116,12 +154,7 @@ function writeDocsFile(ctrl, opts) {
|
|
|
116
154
|
return { controllerClass: ctrl.className, docsFilePath, outcome: 'created' };
|
|
117
155
|
}
|
|
118
156
|
catch (err) {
|
|
119
|
-
return
|
|
120
|
-
controllerClass: ctrl.className,
|
|
121
|
-
docsFilePath,
|
|
122
|
-
outcome: 'error',
|
|
123
|
-
error: err instanceof Error ? err.message : String(err),
|
|
124
|
-
};
|
|
157
|
+
return fail(err);
|
|
125
158
|
}
|
|
126
159
|
}
|
|
127
160
|
/**
|
package/dist/cli/writer.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"writer.js","sourceRoot":"","sources":["../../src/cli/writer.ts"],"names":[],"mappings":";;;;;
|
|
1
|
+
{"version":3,"file":"writer.js","sourceRoot":"","sources":["../../src/cli/writer.ts"],"names":[],"mappings":";;;;;AA4DA,sCAsHC;AAKD,oCAEC;AAzLD,4CAAoB;AACpB,gDAAwB;AACxB,6CAAgD;AAChD,mDAAiD;AACjD,6CAAuH;AACvH,yDAAwD;AAwBxD;;;GAGG;AACH,SAAS,iBAAiB,CAAC,IAAoB,EAAE,IAAmB;IAClE,MAAM,OAAO,GAAG,IAAA,qCAAkB,EAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAE/D,IAAI,CAAC,IAAI,CAAC,MAAM;QAAE,OAAO,OAAO,CAAC;IAEjC,8EAA8E;IAC9E,MAAM,OAAO,GAAG,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,cAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;IAC/D,IAAA,6BAAgB,EAAC,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAC5C,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,aAAa,CAAC,IAAoB,EAAE,IAAmB;IACrE,IAAI,YAAoB,CAAC;IACzB,IAAI,CAAC;QACH,YAAY,GAAG,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC7C,IAAA,6BAAgB,EAAC,YAAY,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IACnD,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO;YACL,eAAe,EAAE,IAAI,CAAC,SAAS;YAC/B,YAAY,EAAE,IAAI,CAAC,QAAQ;YAC3B,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;SACxD,CAAC;IACJ,CAAC;IAED,kBAAkB;IAClB,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QAChB,MAAM,OAAO,GAAG,IAAA,8BAAc,EAAC,IAAI,EAAE,YAAY,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QAChE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;QAC9C,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,aAAa,YAAY,IAAI,CAAC,CAAC;QACpD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;QAC5C,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC9B,OAAO,EAAE,eAAe,EAAE,IAAI,CAAC,SAAS,EAAE,YAAY,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;IAC3E,CAAC;IAED,IAAI,eAA8B,CAAC;IACnC,IAAI,CAAC;QACH,eAAe,GAAG,YAAE,CAAC,YAAY,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;IAC1D,CAAC;IAAC,MAAM,CAAC;QACP,eAAe,GAAG,IAAI,CAAC;IACzB,CAAC;IAED,MAAM,eAAe,GAAG,eAAe,KAAK,IAAI,IAAI,IAAA,6BAAgB,EAAC,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IAEtG,MAAM,IAAI,GAAG,CAAC,GAAY,EAAe,EAAE,CAAC,CAAC;QAC3C,eAAe,EAAE,IAAI,CAAC,SAAS;QAC/B,YAAY;QACZ,OAAO,EAAE,OAAO;QAChB,KAAK,EAAE,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;KACxD,CAAC,CAAC;IAEH,mFAAmF;IACnF,IAAI,eAAe,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;QACtD,OAAO,EAAE,eAAe,EAAE,IAAI,CAAC,SAAS,EAAE,YAAY,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;IAC/E,CAAC;IAED,2EAA2E;IAC3E,2EAA2E;IAC3E,oEAAoE;IACpE,IAAI,eAAe,KAAK,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;QACjD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,IAAA,2BAAc,EAAC,eAAe,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;YAClF,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;gBACtB,YAAE,CAAC,aAAa,CAAC,YAAY,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;gBACjD,OAAO,EAAE,eAAe,EAAE,IAAI,CAAC,SAAS,EAAE,YAAY,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;YAChF,CAAC;YACD,8EAA8E;QAChF,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC;IACH,CAAC;IAED,8EAA8E;IAC9E,oEAAoE;IACpE,0EAA0E;IAC1E,yEAAyE;IACzE,yEAAyE;IACzE,wEAAwE;IACxE,0CAA0C;IAC1C,IAAI,eAAe,KAAK,IAAI,IAAI,eAAe,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;QAClE,IAAI,CAAC;YACH,IAAI,IAAA,kCAAqB,EAAC,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC3D,MAAM,QAAQ,GAAG,IAAA,4BAAe,EAAC,eAAe,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;gBACnF,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;oBACtB,YAAE,CAAC,aAAa,CAAC,YAAY,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;oBACjD,OAAO,EAAE,eAAe,EAAE,IAAI,CAAC,SAAS,EAAE,YAAY,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC;gBACnF,CAAC;gBACD,8EAA8E;YAChF,CAAC;iBAAM,CAAC;gBACN,MAAM,GAAG,GAAG,cAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;gBACvC,YAAE,CAAC,SAAS,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;gBACvC,MAAM,OAAO,GAAG,IAAA,8BAAc,EAAC,IAAI,EAAE,YAAY,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;gBAChE,YAAE,CAAC,aAAa,CAAC,YAAY,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;gBAChD,OAAO,EAAE,eAAe,EAAE,IAAI,CAAC,SAAS,EAAE,YAAY,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC;YACnF,CAAC;QACH,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC;IACH,CAAC;IAED,sEAAsE;IACtE,IAAI,eAAe,KAAK,IAAI,IAAI,eAAe,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QAC9D,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,IAAA,0BAAa,EAAC,eAAe,EAAE,IAAI,CAAC,CAAC;YACpD,IAAI,MAAM,EAAE,CAAC;gBACX,YAAE,CAAC,aAAa,CAAC,YAAY,EAAE,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;gBACvD,OAAO;oBACL,eAAe,EAAE,IAAI,CAAC,SAAS;oBAC/B,YAAY;oBACZ,OAAO,EAAE,QAAQ;oBACjB,YAAY,EAAE,MAAM,CAAC,YAAY;iBAClC,CAAC;YACJ,CAAC;YACD,mEAAmE;QACrE,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC;IACH,CAAC;IAED,6EAA6E;IAC7E,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,cAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QACvC,YAAE,CAAC,SAAS,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACvC,MAAM,OAAO,GAAG,IAAA,8BAAc,EAAC,IAAI,EAAE,YAAY,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QAChE,YAAE,CAAC,aAAa,CAAC,YAAY,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAChD,OAAO,EAAE,eAAe,EAAE,IAAI,CAAC,SAAS,EAAE,YAAY,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;IAC/E,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;IACnB,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAgB,YAAY,CAAC,WAA6B,EAAE,IAAmB;IAC7E,OAAO,WAAW,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;AAC9D,CAAC"}
|
|
@@ -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",
|