nestjs-docfy 0.3.6 → 0.5.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.
Files changed (70) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +122 -67
  3. package/dist/apply-docfy-metadata.d.ts +37 -0
  4. package/dist/apply-docfy-metadata.js +55 -0
  5. package/dist/apply-docfy-metadata.js.map +1 -0
  6. package/dist/cli/build-openapi-patch.d.ts +16 -12
  7. package/dist/cli/build-openapi-patch.js +98 -15
  8. package/dist/cli/build-openapi-patch.js.map +1 -1
  9. package/dist/cli/check.js.map +1 -1
  10. package/dist/cli/coverage.js +1 -3
  11. package/dist/cli/coverage.js.map +1 -1
  12. package/dist/cli/detect-project.js +1 -5
  13. package/dist/cli/detect-project.js.map +1 -1
  14. package/dist/cli/errors.js.map +1 -1
  15. package/dist/cli/eval-decorator-args.d.ts +5 -3
  16. package/dist/cli/eval-decorator-args.js +64 -11
  17. package/dist/cli/eval-decorator-args.js.map +1 -1
  18. package/dist/cli/extract-docs-config.d.ts +21 -1
  19. package/dist/cli/extract-docs-config.js +18 -6
  20. package/dist/cli/extract-docs-config.js.map +1 -1
  21. package/dist/cli/extract-methods.d.ts +11 -0
  22. package/dist/cli/extract-methods.js +113 -29
  23. package/dist/cli/extract-methods.js.map +1 -1
  24. package/dist/cli/generate-file.js +24 -24
  25. package/dist/cli/generate-file.js.map +1 -1
  26. package/dist/cli/index.js +5 -6
  27. package/dist/cli/index.js.map +1 -1
  28. package/dist/cli/lint.js +1 -3
  29. package/dist/cli/lint.js.map +1 -1
  30. package/dist/cli/logger.js +12 -6
  31. package/dist/cli/logger.js.map +1 -1
  32. package/dist/cli/merge-docs.js.map +1 -1
  33. package/dist/cli/merge-spec-patch.d.ts +15 -8
  34. package/dist/cli/merge-spec-patch.js +20 -4
  35. package/dist/cli/merge-spec-patch.js.map +1 -1
  36. package/dist/cli/parse-args.js +2 -6
  37. package/dist/cli/parse-args.js.map +1 -1
  38. package/dist/cli/patch-spec.d.ts +32 -8
  39. package/dist/cli/patch-spec.js +37 -15
  40. package/dist/cli/patch-spec.js.map +1 -1
  41. package/dist/cli/resolve-tsconfig.js +1 -5
  42. package/dist/cli/resolve-tsconfig.js.map +1 -1
  43. package/dist/cli/scan-controllers.d.ts +11 -0
  44. package/dist/cli/scan-controllers.js +10 -3
  45. package/dist/cli/scan-controllers.js.map +1 -1
  46. package/dist/cli/watch.js +3 -1
  47. package/dist/cli/watch.js.map +1 -1
  48. package/dist/cli/writer.js.map +1 -1
  49. package/dist/docfy-ui.module.d.ts +26 -10
  50. package/dist/docfy-ui.module.js +42 -6
  51. package/dist/docfy-ui.module.js.map +1 -1
  52. package/dist/docfy.module.js +1 -1
  53. package/dist/docfy.module.js.map +1 -1
  54. package/dist/docs.js.map +1 -1
  55. package/dist/index.d.ts +2 -1
  56. package/dist/index.js +3 -1
  57. package/dist/index.js.map +1 -1
  58. package/dist/plugin/generate-metadata.d.ts +35 -0
  59. package/dist/plugin/generate-metadata.js +46 -0
  60. package/dist/plugin/generate-metadata.js.map +1 -0
  61. package/dist/plugin/index.d.ts +30 -0
  62. package/dist/plugin/index.js +62 -0
  63. package/dist/plugin/index.js.map +1 -0
  64. package/dist/registry.d.ts +3 -3
  65. package/dist/registry.js.map +1 -1
  66. package/dist/resolve-docs-path.d.ts +1 -1
  67. package/dist/resolve-docs-path.js.map +1 -1
  68. package/dist/resolve-source-from-stack.js.map +1 -1
  69. package/dist/with-docs.decorator.js.map +1 -1
  70. package/package.json +32 -3
@@ -37,11 +37,22 @@ exports.DocfyUiModule = void 0;
37
37
  const fs = __importStar(require("fs"));
38
38
  const path = __importStar(require("path"));
39
39
  const express = __importStar(require("express"));
40
+ function loadFastifyStatic() {
41
+ try {
42
+ // eslint-disable-next-line @typescript-eslint/no-require-imports
43
+ return require('@fastify/static');
44
+ }
45
+ catch {
46
+ throw new Error('DocfyUiModule.setup(): serving docfy-ui on a Fastify-based Nest app requires ' +
47
+ "the optional peer dependency '@fastify/static'. Install it with `npm install @fastify/static`.");
48
+ }
49
+ }
40
50
  /**
41
51
  * Serves the published `docfy-ui` package's static build at `mountPath`,
42
52
  * giving a `nestjs-docfy`-equipped app a documentation UI by default —
43
53
  * the same role `SwaggerModule.setup()` + `swagger-ui-express` play for
44
- * raw Swagger UI, but for `docfy-ui`.
54
+ * raw Swagger UI, but for `docfy-ui`. Works on both Express and Fastify
55
+ * Nest apps.
45
56
  *
46
57
  * Deep client-side routes (e.g. reloading `/docs/users/findAllUsers`
47
58
  * directly) resolve correctly at any `mountPath`: this injects a `<base>`
@@ -52,11 +63,13 @@ const express = __importStar(require("express"));
52
63
  */
53
64
  class DocfyUiModule {
54
65
  static setup(mountPath, app, options = {}) {
66
+ const httpAdapter = app.getHttpAdapter();
67
+ const isFastify = httpAdapter.getType() === 'fastify';
55
68
  if (options.staticSpecPath) {
56
69
  const specJson = fs.readFileSync(options.staticSpecPath, 'utf8');
57
- app.use('/api-json', (_req, res) => {
58
- res.setHeader('Content-Type', 'application/json');
59
- res.end(specJson);
70
+ httpAdapter.get('/api-json', (_req, res) => {
71
+ res.type('application/json');
72
+ res.send(specJson);
60
73
  });
61
74
  }
62
75
  const indexHtmlPath = require.resolve('docfy-ui/dist/index.html');
@@ -65,13 +78,36 @@ class DocfyUiModule {
65
78
  const indexHtml = fs
66
79
  .readFileSync(indexHtmlPath, 'utf8')
67
80
  .replace('<head>', `<head>\n <base href="${basePath}" />\n <script>window.__DOCFY_BASE_PATH__ = ${JSON.stringify(basePath)};</script>`);
81
+ if (isFastify) {
82
+ const fastifyStatic = loadFastifyStatic();
83
+ const instance = httpAdapter.getInstance();
84
+ instance.register((scoped, _opts, done) => {
85
+ scoped.register(fastifyStatic, {
86
+ root: uiDir,
87
+ // `wildcard: false` is required by @fastify/static for a scoped
88
+ // setNotFoundHandler to combine correctly with static serving.
89
+ wildcard: false,
90
+ // `index: false` so directory requests (e.g. `GET /docs/`) fall
91
+ // through to the not-found handler below instead of
92
+ // @fastify/static serving the un-patched index.html straight
93
+ // off disk.
94
+ index: false,
95
+ decorateReply: false,
96
+ });
97
+ scoped.setNotFoundHandler((_req, reply) => {
98
+ reply.type('text/html').send(indexHtml);
99
+ });
100
+ done();
101
+ }, { prefix: mountPath });
102
+ return;
103
+ }
68
104
  // `index: false` so directory requests (e.g. `GET /docs/`) fall through
69
105
  // to the catch-all below instead of express.static serving the
70
106
  // un-patched index.html straight off disk.
71
107
  app.use(mountPath, express.static(uiDir, { index: false }));
72
108
  app.use(mountPath, (_req, res) => {
73
- res.setHeader('Content-Type', 'text/html');
74
- res.end(indexHtml);
109
+ res.type('text/html');
110
+ res.send(indexHtml);
75
111
  });
76
112
  }
77
113
  }
@@ -1 +1 @@
1
- {"version":3,"file":"docfy-ui.module.js","sourceRoot":"","sources":["../src/docfy-ui.module.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,uCAAyB;AACzB,2CAA6B;AAC7B,iDAAmC;AAmCnC;;;;;;;;;;;;GAYG;AACH,MAAa,aAAa;IACxB,MAAM,CAAC,KAAK,CACV,SAAiB,EACjB,GAAuB,EACvB,UAA+B,EAAE;QAEjC,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;YAC3B,MAAM,QAAQ,GAAG,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;YACjE,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,IAAqB,EAAE,GAAqB,EAAE,EAAE;gBACpE,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;gBAClD,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YACpB,CAAC,CAAC,CAAC;QACL,CAAC;QAED,MAAM,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC,0BAA0B,CAAC,CAAC;QAClE,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAC1C,MAAM,QAAQ,GAAG,SAAS,KAAK,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,CAAC;QAC/E,MAAM,SAAS,GAAG,EAAE;aACjB,YAAY,CAAC,aAAa,EAAE,MAAM,CAAC;aACnC,OAAO,CACN,QAAQ,EACR,2BAA2B,QAAQ,kDAAkD,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,YAAY,CAC1H,CAAC;QAEJ,wEAAwE;QACxE,+DAA+D;QAC/D,2CAA2C;QAC3C,GAAG,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;QAC5D,GAAG,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,IAAqB,EAAE,GAAqB,EAAE,EAAE;YAClE,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC;YAC3C,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACrB,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAjCD,sCAiCC"}
1
+ {"version":3,"file":"docfy-ui.module.js","sourceRoot":"","sources":["../src/docfy-ui.module.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,uCAAyB;AACzB,2CAA6B;AAC7B,iDAAmC;AAuDnC,SAAS,iBAAiB;IACxB,IAAI,CAAC;QACH,iEAAiE;QACjE,OAAO,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACpC,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,KAAK,CACb,+EAA+E;YAC7E,gGAAgG,CACnG,CAAC;IACJ,CAAC;AACH,CAAC;AAkBD;;;;;;;;;;;;;GAaG;AACH,MAAa,aAAa;IACxB,MAAM,CAAC,KAAK,CAAC,SAAiB,EAAE,GAAuB,EAAE,UAA+B,EAAE;QACxF,MAAM,WAAW,GAAG,GAAG,CAAC,cAAc,EAAE,CAAC;QACzC,MAAM,SAAS,GAAG,WAAW,CAAC,OAAO,EAAE,KAAK,SAAS,CAAC;QAEtD,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;YAC3B,MAAM,QAAQ,GAAG,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;YACjE,WAAW,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,IAAa,EAAE,GAAQ,EAAE,EAAE;gBACvD,GAAG,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;gBAC7B,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACrB,CAAC,CAAC,CAAC;QACL,CAAC;QAED,MAAM,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC,0BAA0B,CAAC,CAAC;QAClE,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAC1C,MAAM,QAAQ,GAAG,SAAS,KAAK,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,CAAC;QAC/E,MAAM,SAAS,GAAG,EAAE;aACjB,YAAY,CAAC,aAAa,EAAE,MAAM,CAAC;aACnC,OAAO,CACN,QAAQ,EACR,2BAA2B,QAAQ,kDAAkD,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,YAAY,CAC1H,CAAC;QAEJ,IAAI,SAAS,EAAE,CAAC;YACd,MAAM,aAAa,GAAG,iBAAiB,EAAE,CAAC;YAC1C,MAAM,QAAQ,GAAG,WAAW,CAAC,WAAW,EAAyB,CAAC;YAClE,QAAQ,CAAC,QAAQ,CACf,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;gBACtB,MAAM,CAAC,QAAQ,CAAC,aAAa,EAAE;oBAC7B,IAAI,EAAE,KAAK;oBACX,gEAAgE;oBAChE,+DAA+D;oBAC/D,QAAQ,EAAE,KAAK;oBACf,gEAAgE;oBAChE,oDAAoD;oBACpD,6DAA6D;oBAC7D,YAAY;oBACZ,KAAK,EAAE,KAAK;oBACZ,aAAa,EAAE,KAAK;iBACrB,CAAC,CAAC;gBACH,MAAM,CAAC,kBAAkB,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;oBACxC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBAC1C,CAAC,CAAC,CAAC;gBACH,IAAI,EAAE,CAAC;YACT,CAAC,EACD,EAAE,MAAM,EAAE,SAAS,EAAE,CACtB,CAAC;YACF,OAAO;QACT,CAAC;QAED,wEAAwE;QACxE,+DAA+D;QAC/D,2CAA2C;QAC3C,GAAG,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;QAC5D,GAAG,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,IAAqB,EAAE,GAAqB,EAAE,EAAE;YAClE,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACtB,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AA3DD,sCA2DC"}
@@ -52,7 +52,7 @@ let DocfyModule = DocfyModule_1 = class DocfyModule {
52
52
  // The docs file simply doesn't exist — allowed unless strict mode
53
53
  const message = `No docs file found for ${controllerClass.name}. Expected: ${docsPath}`;
54
54
  if (strict)
55
- throw new Error(`[nestjs-docfy] ${message}`);
55
+ throw new Error(`[nestjs-docfy] ${message}`, { cause: err });
56
56
  DocfyModule_1.logger.warn(message);
57
57
  }
58
58
  else {
@@ -1 +1 @@
1
- {"version":3,"file":"docfy.module.js","sourceRoot":"","sources":["../src/docfy.module.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,2CAA+D;AAC/D,yCAA2C;AAC3C,2DAAsD;AAYtD;;;;;;;;;GASG;AAEI,IAAM,WAAW,mBAAjB,MAAM,WAAW;IAGtB,MAAM,CAAC,OAAO,CAAC,UAA8B,EAAE;QAC7C,aAAW,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QAClC,OAAO,EAAE,MAAM,EAAE,aAAW,EAAE,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,YAAY,CACjB,UAA8B,EAAE,EAChC,YAAoC,OAAO,EAC3C,WAAoF;QAEpF,MAAM,EAAE,MAAM,GAAG,KAAK,EAAE,GAAG,OAAO,CAAC;QAEnC,KAAK,MAAM,eAAe,IAAI,wBAAa,CAAC,MAAM,EAAE,EAAE,CAAC;YACrD,MAAM,aAAa,GAAG,wBAAa,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC;YACjE,MAAM,QAAQ,GAAG,IAAA,mCAAe,EAAC,eAAe,EAAE,WAAW,EAAE,aAAa,CAAC,CAAC;YAE9E,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,MAAM,OAAO,GACX,oCAAoC,eAAe,CAAC,IAAI,IAAI;oBAC5D,oEAAoE;oBACpE,mCAAmC,CAAC;gBACtC,IAAI,MAAM;oBAAE,MAAM,IAAI,KAAK,CAAC,kBAAkB,OAAO,EAAE,CAAC,CAAC;gBACzD,aAAW,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACjC,SAAS;YACX,CAAC;YAED,IAAI,CAAC;gBACH,SAAS,CAAC,QAAQ,CAAC,CAAC;gBACpB,aAAW,CAAC,MAAM,CAAC,GAAG,CAAC,mBAAmB,eAAe,CAAC,IAAI,SAAS,QAAQ,EAAE,CAAC,CAAC;YACrF,CAAC;YAAC,OAAO,GAAY,EAAE,CAAC;gBACtB,IAAI,iBAAiB,CAAC,GAAG,EAAE,QAAQ,CAAC,EAAE,CAAC;oBACrC,kEAAkE;oBAClE,MAAM,OAAO,GACX,0BAA0B,eAAe,CAAC,IAAI,eAAe,QAAQ,EAAE,CAAC;oBAC1E,IAAI,MAAM;wBAAE,MAAM,IAAI,KAAK,CAAC,kBAAkB,OAAO,EAAE,CAAC,CAAC;oBACzD,aAAW,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACnC,CAAC;qBAAM,CAAC;oBACN,iFAAiF;oBACjF,aAAW,CAAC,MAAM,CAAC,KAAK,CACtB,gCAAgC,eAAe,CAAC,IAAI,KAAK,QAAQ,EAAE,EACnE,GAAG,CACJ,CAAC;oBACF,MAAM,GAAG,CAAC;gBACZ,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;;AApDU,kCAAW;AACE,kBAAM,GAAG,IAAI,eAAM,CAAC,aAAW,CAAC,IAAI,CAAC,AAA/B,CAAgC;sBADnD,WAAW;IADvB,IAAA,eAAM,EAAC,EAAE,CAAC;GACE,WAAW,CAqDvB;AAED;;;GAGG;AACH,SAAS,iBAAiB,CAAC,GAAY,EAAE,QAAgB;IACvD,IAAI,CAAC,CAAC,GAAG,YAAY,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAC1C,IAAI,CAAC,CAAC,MAAM,IAAI,GAAG,CAAC,IAAK,GAA6B,CAAC,IAAI,KAAK,kBAAkB;QAAE,OAAO,KAAK,CAAC;IACjG,sFAAsF;IACtF,8EAA8E;IAC9E,gFAAgF;IAChF,gFAAgF;IAChF,iFAAiF;IACjF,MAAM,SAAS,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAChD,OAAO,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AACtC,CAAC"}
1
+ {"version":3,"file":"docfy.module.js","sourceRoot":"","sources":["../src/docfy.module.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,2CAA+D;AAC/D,yCAA2C;AAC3C,2DAAsD;AAYtD;;;;;;;;;GASG;AAEI,IAAM,WAAW,mBAAjB,MAAM,WAAW;IAGtB,MAAM,CAAC,OAAO,CAAC,UAA8B,EAAE;QAC7C,aAAW,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QAClC,OAAO,EAAE,MAAM,EAAE,aAAW,EAAE,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,YAAY,CACjB,UAA8B,EAAE,EAChC,YAAoC,OAAO,EAC3C,WAAoF;QAEpF,MAAM,EAAE,MAAM,GAAG,KAAK,EAAE,GAAG,OAAO,CAAC;QAEnC,KAAK,MAAM,eAAe,IAAI,wBAAa,CAAC,MAAM,EAAE,EAAE,CAAC;YACrD,MAAM,aAAa,GAAG,wBAAa,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC;YACjE,MAAM,QAAQ,GAAG,IAAA,mCAAe,EAAC,eAAe,EAAE,WAAW,EAAE,aAAa,CAAC,CAAC;YAE9E,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,MAAM,OAAO,GACX,oCAAoC,eAAe,CAAC,IAAI,IAAI;oBAC5D,oEAAoE;oBACpE,mCAAmC,CAAC;gBACtC,IAAI,MAAM;oBAAE,MAAM,IAAI,KAAK,CAAC,kBAAkB,OAAO,EAAE,CAAC,CAAC;gBACzD,aAAW,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACjC,SAAS;YACX,CAAC;YAED,IAAI,CAAC;gBACH,SAAS,CAAC,QAAQ,CAAC,CAAC;gBACpB,aAAW,CAAC,MAAM,CAAC,GAAG,CAAC,mBAAmB,eAAe,CAAC,IAAI,SAAS,QAAQ,EAAE,CAAC,CAAC;YACrF,CAAC;YAAC,OAAO,GAAY,EAAE,CAAC;gBACtB,IAAI,iBAAiB,CAAC,GAAG,EAAE,QAAQ,CAAC,EAAE,CAAC;oBACrC,kEAAkE;oBAClE,MAAM,OAAO,GAAG,0BAA0B,eAAe,CAAC,IAAI,eAAe,QAAQ,EAAE,CAAC;oBACxF,IAAI,MAAM;wBAAE,MAAM,IAAI,KAAK,CAAC,kBAAkB,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;oBACzE,aAAW,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACnC,CAAC;qBAAM,CAAC;oBACN,iFAAiF;oBACjF,aAAW,CAAC,MAAM,CAAC,KAAK,CAAC,gCAAgC,eAAe,CAAC,IAAI,KAAK,QAAQ,EAAE,EAAE,GAAG,CAAC,CAAC;oBACnG,MAAM,GAAG,CAAC;gBACZ,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;;AAhDU,kCAAW;AACE,kBAAM,GAAG,IAAI,eAAM,CAAC,aAAW,CAAC,IAAI,CAAC,AAA/B,CAAgC;sBADnD,WAAW;IADvB,IAAA,eAAM,EAAC,EAAE,CAAC;GACE,WAAW,CAiDvB;AAED;;;GAGG;AACH,SAAS,iBAAiB,CAAC,GAAY,EAAE,QAAgB;IACvD,IAAI,CAAC,CAAC,GAAG,YAAY,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAC1C,IAAI,CAAC,CAAC,MAAM,IAAI,GAAG,CAAC,IAAK,GAA6B,CAAC,IAAI,KAAK,kBAAkB;QAAE,OAAO,KAAK,CAAC;IACjG,sFAAsF;IACtF,8EAA8E;IAC9E,gFAAgF;IAChF,gFAAgF;IAChF,iFAAiF;IACjF,MAAM,SAAS,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAChD,OAAO,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AACtC,CAAC"}
package/dist/docs.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"docs.js","sourceRoot":"","sources":["../src/docs.ts"],"names":[],"mappings":";;AAwCA,oBA+BC;AAvED,6DAAwD;AAwBxD;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,IAAI,CAAI,eAA+B,EAAE,MAAqB;IAC5E,IAAI,MAAM,CAAC,eAAe,EAAE,CAAC;QAC3B,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,eAAe,EAAE,CAAC;YAC/C,SAAS,CAAC,eAAe,CAAC,CAAC;QAC7B,CAAC;IACH,CAAC;IAED,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,qCAAgB,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,OAAO;QAAE,OAAO;IAE5B,KAAK,MAAM,CAAC,UAAU,EAAE,UAAU,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAkC,EAAE,CAAC;QACvG,MAAM,UAAU,GAAG,MAAM,CAAC,wBAAwB,CAChD,eAAe,CAAC,SAAS,EACzB,UAAU,CACX,CAAC;QAEF,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,OAAO,CAAC,IAAI,CACV,0BAA0B,UAAU,kBAAkB,eAAe,CAAC,IAAI,IAAI;gBAC5E,uCAAuC,CAC1C,CAAC;YACF,SAAS;QACX,CAAC;QAED,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;YACnC,SAAS,CAAC,eAAe,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;QAC/D,CAAC;IACH,CAAC;AACH,CAAC"}
1
+ {"version":3,"file":"docs.js","sourceRoot":"","sources":["../src/docs.ts"],"names":[],"mappings":";;AAwCA,oBA4BC;AApED,6DAAwD;AAwBxD;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,IAAI,CAAI,eAA+B,EAAE,MAAqB;IAC5E,IAAI,MAAM,CAAC,eAAe,EAAE,CAAC;QAC3B,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,eAAe,EAAE,CAAC;YAC/C,SAAS,CAAC,eAAe,CAAC,CAAC;QAC7B,CAAC;IACH,CAAC;IAED,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,qCAAgB,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,OAAO;QAAE,OAAO;IAE5B,KAAK,MAAM,CAAC,UAAU,EAAE,UAAU,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAkC,EAAE,CAAC;QACvG,MAAM,UAAU,GAAG,MAAM,CAAC,wBAAwB,CAAC,eAAe,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QAE1F,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,OAAO,CAAC,IAAI,CACV,0BAA0B,UAAU,kBAAkB,eAAe,CAAC,IAAI,IAAI;gBAC5E,uCAAuC,CAC1C,CAAC;YACF,SAAS;QACX,CAAC;QAED,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;YACnC,SAAS,CAAC,eAAe,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;QAC/D,CAAC;IACH,CAAC;AACH,CAAC"}
package/dist/index.d.ts CHANGED
@@ -3,4 +3,5 @@ export { docs, DocsConfig } from './docs';
3
3
  export { DocfyModule, DocfyModuleOptions } from './docfy.module';
4
4
  export { attachTagGroups } from './attach-tag-groups';
5
5
  export { TagGroup } from './tag-group-registry';
6
- export { DocfyUiModule, DocfyUiSetupTarget, DocfyUiSetupOptions } from './docfy-ui.module';
6
+ export { DocfyUiModule, DocfyUiSetupTarget, DocfyUiSetupOptions, DocfyUiHttpAdapter } from './docfy-ui.module';
7
+ export { applyDocfyMetadata, ApplyDocfyMetadataOptions } from './apply-docfy-metadata';
package/dist/index.js CHANGED
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.DocfyUiModule = exports.attachTagGroups = exports.DocfyModule = exports.docs = exports.DOCFY_MARKER = exports.WithDocs = void 0;
3
+ exports.applyDocfyMetadata = exports.DocfyUiModule = exports.attachTagGroups = exports.DocfyModule = exports.docs = exports.DOCFY_MARKER = exports.WithDocs = void 0;
4
4
  var with_docs_decorator_1 = require("./with-docs.decorator");
5
5
  Object.defineProperty(exports, "WithDocs", { enumerable: true, get: function () { return with_docs_decorator_1.WithDocs; } });
6
6
  Object.defineProperty(exports, "DOCFY_MARKER", { enumerable: true, get: function () { return with_docs_decorator_1.DOCFY_MARKER; } });
@@ -12,4 +12,6 @@ var attach_tag_groups_1 = require("./attach-tag-groups");
12
12
  Object.defineProperty(exports, "attachTagGroups", { enumerable: true, get: function () { return attach_tag_groups_1.attachTagGroups; } });
13
13
  var docfy_ui_module_1 = require("./docfy-ui.module");
14
14
  Object.defineProperty(exports, "DocfyUiModule", { enumerable: true, get: function () { return docfy_ui_module_1.DocfyUiModule; } });
15
+ var apply_docfy_metadata_1 = require("./apply-docfy-metadata");
16
+ Object.defineProperty(exports, "applyDocfyMetadata", { enumerable: true, get: function () { return apply_docfy_metadata_1.applyDocfyMetadata; } });
15
17
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,6DAA+D;AAAtD,+GAAA,QAAQ,OAAA;AAAE,mHAAA,YAAY,OAAA;AAC/B,+BAA0C;AAAjC,4FAAA,IAAI,OAAA;AACb,+CAAiE;AAAxD,2GAAA,WAAW,OAAA;AACpB,yDAAsD;AAA7C,oHAAA,eAAe,OAAA;AAExB,qDAA2F;AAAlF,gHAAA,aAAa,OAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,6DAA+D;AAAtD,+GAAA,QAAQ,OAAA;AAAE,mHAAA,YAAY,OAAA;AAC/B,+BAA0C;AAAjC,4FAAA,IAAI,OAAA;AACb,+CAAiE;AAAxD,2GAAA,WAAW,OAAA;AACpB,yDAAsD;AAA7C,oHAAA,eAAe,OAAA;AAExB,qDAA+G;AAAtG,gHAAA,aAAa,OAAA;AACtB,+DAAuF;AAA9E,0HAAA,kBAAkB,OAAA"}
@@ -0,0 +1,35 @@
1
+ /** Filename the CLI plugin writes into the build output dir, and `applyDocfyMetadata()` reads by default. */
2
+ export declare const DOCFY_METADATA_FILENAME = "docfy-metadata.json";
3
+ export interface GenerateMetadataOptions {
4
+ /** Absolute path to the project's tsconfig — the same one the build is using. */
5
+ tsConfigFilePath: string;
6
+ /** Absolute path to the project root, used for the same symlink/path-traversal safety check `scanApp` always applies. */
7
+ projectRoot: string;
8
+ /** Absolute path to the directory the metadata file should be written into (typically the build's outDir). */
9
+ outDir: string;
10
+ /** Controller glob override — same convention as the CLI's `--pattern` flag. Defaults to `**\/*.controller.ts`. */
11
+ controllerGlob?: string;
12
+ }
13
+ export interface GenerateMetadataResult {
14
+ /** Absolute path the metadata file was written to. */
15
+ outFile: string;
16
+ /** How many "METHOD /path" operations the generated patch touches. */
17
+ patchedOperationCount: number;
18
+ controllersWithoutDocs: string[];
19
+ unparseableDocsFiles: string[];
20
+ scanErrors: {
21
+ file: string;
22
+ message: string;
23
+ }[];
24
+ }
25
+ /**
26
+ * Scans every controller in the project via static analysis (ts-morph — the
27
+ * same engine `generate`/`check`/`patch-spec` already use) and writes the
28
+ * resulting SpecPatch to a JSON file in the build output directory.
29
+ *
30
+ * This is the piece the CLI plugin (`src/plugin/index.ts`) calls once per
31
+ * compilation. Unlike the `patch-spec` CLI command, it needs no base OpenAPI
32
+ * document — `applyDocfyMetadata()` reads the written file at runtime and
33
+ * merges it into whatever `SwaggerModule.createDocument()` produces then.
34
+ */
35
+ export declare function generateDocfyMetadata(options: GenerateMetadataOptions): GenerateMetadataResult;
@@ -0,0 +1,46 @@
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.DOCFY_METADATA_FILENAME = void 0;
7
+ exports.generateDocfyMetadata = generateDocfyMetadata;
8
+ const fs_1 = __importDefault(require("fs"));
9
+ const path_1 = __importDefault(require("path"));
10
+ const scan_controllers_1 = require("../cli/scan-controllers");
11
+ const patch_spec_1 = require("../cli/patch-spec");
12
+ /** Filename the CLI plugin writes into the build output dir, and `applyDocfyMetadata()` reads by default. */
13
+ exports.DOCFY_METADATA_FILENAME = 'docfy-metadata.json';
14
+ /**
15
+ * Scans every controller in the project via static analysis (ts-morph — the
16
+ * same engine `generate`/`check`/`patch-spec` already use) and writes the
17
+ * resulting SpecPatch to a JSON file in the build output directory.
18
+ *
19
+ * This is the piece the CLI plugin (`src/plugin/index.ts`) calls once per
20
+ * compilation. Unlike the `patch-spec` CLI command, it needs no base OpenAPI
21
+ * document — `applyDocfyMetadata()` reads the written file at runtime and
22
+ * merges it into whatever `SwaggerModule.createDocument()` produces then.
23
+ */
24
+ function generateDocfyMetadata(options) {
25
+ const app = {
26
+ name: 'app',
27
+ root: options.projectRoot,
28
+ tsconfig: options.tsConfigFilePath,
29
+ controllerGlob: options.controllerGlob ?? '**/*.controller.ts',
30
+ };
31
+ const { controllers, errors: scanErrors, projectsByControllerPath, } = (0, scan_controllers_1.scanApp)(app, options.projectRoot, options.controllerGlob, 'ts');
32
+ const { patch, controllersWithoutDocs, unparseableDocsFiles } = (0, patch_spec_1.computeSpecPatch)(controllers, 'ts', (absolutePath) => {
33
+ try {
34
+ return fs_1.default.readFileSync(absolutePath, 'utf8');
35
+ }
36
+ catch {
37
+ return null;
38
+ }
39
+ }, projectsByControllerPath);
40
+ fs_1.default.mkdirSync(options.outDir, { recursive: true });
41
+ const outFile = path_1.default.join(options.outDir, exports.DOCFY_METADATA_FILENAME);
42
+ fs_1.default.writeFileSync(outFile, JSON.stringify(patch, null, 2), 'utf8');
43
+ const patchedOperationCount = Object.values(patch).reduce((count, methods) => count + Object.keys(methods).length, 0);
44
+ return { outFile, patchedOperationCount, controllersWithoutDocs, unparseableDocsFiles, scanErrors };
45
+ }
46
+ //# sourceMappingURL=generate-metadata.js.map
@@ -0,0 +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;AAGrD,6GAA6G;AAChG,QAAA,uBAAuB,GAAG,qBAAqB,CAAC;AAuB7D;;;;;;;;;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,+BAAuB,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,30 @@
1
+ import type * as ts from 'typescript';
2
+ export { DOCFY_METADATA_FILENAME } from './generate-metadata';
3
+ export interface DocfyPluginOptions {
4
+ /** Root directory to scan for controllers. Defaults to the directory containing the resolved tsconfig. */
5
+ projectRoot?: string;
6
+ /** Controller glob override — same convention as the CLI's `--pattern` flag. */
7
+ controllerGlob?: string;
8
+ }
9
+ /**
10
+ * NestJS CLI "compiler plugin" entry point — register it in `nest-cli.json`:
11
+ * `"compilerOptions": { "plugins": ["nestjs-docfy"] }`. The Nest CLI's plugin
12
+ * loader calls exactly this `before(options, program)` shape for both the
13
+ * `tsc` and the `webpack` builder (see `@nestjs/cli`'s `PluginsLoader` and
14
+ * `ts-loader`'s `getCustomTransformers` wiring) — the same mechanism
15
+ * `@nestjs/swagger/plugin` already relies on to work under `webpack: true`,
16
+ * which is the one thing `DocfyModule`'s `require.cache`-based discovery
17
+ * structurally cannot do (see the README's "Not supported: webpack: true"
18
+ * section).
19
+ *
20
+ * Unlike `@nestjs/swagger/plugin`, this does not rewrite any AST node — it
21
+ * returns an identity transformer. Its only job is a build-time side
22
+ * effect: run the exact same static analysis `generate`/`check`/`patch-spec`
23
+ * already do, once per compilation, and write the resulting patch to a JSON
24
+ * file next to the compiled output. `applyDocfyMetadata()` (exported from
25
+ * the package root) reads that file at runtime and merges it into the
26
+ * document right after `SwaggerModule.createDocument()` — the same merge
27
+ * `patch-spec` does, just automatic on every build instead of a separate
28
+ * manual CLI invocation.
29
+ */
30
+ export declare function before(options?: DocfyPluginOptions, program?: ts.Program): ts.TransformerFactory<ts.SourceFile>;
@@ -0,0 +1,62 @@
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.DOCFY_METADATA_FILENAME = void 0;
7
+ exports.before = before;
8
+ const path_1 = __importDefault(require("path"));
9
+ const generate_metadata_1 = require("./generate-metadata");
10
+ var generate_metadata_2 = require("./generate-metadata");
11
+ Object.defineProperty(exports, "DOCFY_METADATA_FILENAME", { enumerable: true, get: function () { return generate_metadata_2.DOCFY_METADATA_FILENAME; } });
12
+ /**
13
+ * NestJS CLI "compiler plugin" entry point — register it in `nest-cli.json`:
14
+ * `"compilerOptions": { "plugins": ["nestjs-docfy"] }`. The Nest CLI's plugin
15
+ * loader calls exactly this `before(options, program)` shape for both the
16
+ * `tsc` and the `webpack` builder (see `@nestjs/cli`'s `PluginsLoader` and
17
+ * `ts-loader`'s `getCustomTransformers` wiring) — the same mechanism
18
+ * `@nestjs/swagger/plugin` already relies on to work under `webpack: true`,
19
+ * which is the one thing `DocfyModule`'s `require.cache`-based discovery
20
+ * structurally cannot do (see the README's "Not supported: webpack: true"
21
+ * section).
22
+ *
23
+ * Unlike `@nestjs/swagger/plugin`, this does not rewrite any AST node — it
24
+ * returns an identity transformer. Its only job is a build-time side
25
+ * effect: run the exact same static analysis `generate`/`check`/`patch-spec`
26
+ * already do, once per compilation, and write the resulting patch to a JSON
27
+ * file next to the compiled output. `applyDocfyMetadata()` (exported from
28
+ * the package root) reads that file at runtime and merges it into the
29
+ * document right after `SwaggerModule.createDocument()` — the same merge
30
+ * `patch-spec` does, just automatic on every build instead of a separate
31
+ * manual CLI invocation.
32
+ */
33
+ function before(options = {}, program) {
34
+ if (!program) {
35
+ throw new Error('nestjs-docfy plugin: the "program" reference must be provided when using the CLI plugin. ' +
36
+ 'This is usually caused by "isolatedModules" being set to true in your tsconfig.');
37
+ }
38
+ const compilerOptions = program.getCompilerOptions();
39
+ const configFilePath = compilerOptions.configFilePath;
40
+ if (!configFilePath) {
41
+ throw new Error('nestjs-docfy plugin: could not determine the tsconfig path from the TypeScript program. ' +
42
+ 'This plugin must be registered via nest-cli.json\'s "compilerOptions.plugins".');
43
+ }
44
+ const projectRoot = options.projectRoot ?? path_1.default.dirname(configFilePath);
45
+ const outDir = compilerOptions.outDir ?? path_1.default.join(projectRoot, 'dist');
46
+ try {
47
+ (0, generate_metadata_1.generateDocfyMetadata)({
48
+ tsConfigFilePath: configFilePath,
49
+ projectRoot,
50
+ outDir,
51
+ controllerGlob: options.controllerGlob,
52
+ });
53
+ }
54
+ catch (err) {
55
+ // A build-time analysis failure shouldn't be silently swallowed, but it
56
+ // also shouldn't fail the app's entire build — same "loud warning, not a
57
+ // crash" philosophy DocfyModule already follows for a missing docs file.
58
+ console.warn(`[nestjs-docfy] Failed to generate build-time metadata: ${err instanceof Error ? err.message : String(err)}`);
59
+ }
60
+ return () => (sourceFile) => sourceFile;
61
+ }
62
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/plugin/index.ts"],"names":[],"mappings":";;;;;;AAkCA,wBAqCC;AAtED,gDAAwB;AACxB,2DAA4D;AAE5D,yDAA8D;AAArD,4HAAA,uBAAuB,OAAA;AAShC;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,SAAgB,MAAM,CAAC,UAA8B,EAAE,EAAE,OAAoB;IAC3E,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CACb,2FAA2F;YACzF,iFAAiF,CACpF,CAAC;IACJ,CAAC;IAED,MAAM,eAAe,GAAG,OAAO,CAAC,kBAAkB,EAAsD,CAAC;IACzG,MAAM,cAAc,GAAG,eAAe,CAAC,cAAc,CAAC;IACtD,IAAI,CAAC,cAAc,EAAE,CAAC;QACpB,MAAM,IAAI,KAAK,CACb,0FAA0F;YACxF,gFAAgF,CACnF,CAAC;IACJ,CAAC;IAED,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,cAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;IACxE,MAAM,MAAM,GAAG,eAAe,CAAC,MAAM,IAAI,cAAI,CAAC,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IAExE,IAAI,CAAC;QACH,IAAA,yCAAqB,EAAC;YACpB,gBAAgB,EAAE,cAAc;YAChC,WAAW;YACX,MAAM;YACN,cAAc,EAAE,OAAO,CAAC,cAAc;SACvC,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,wEAAwE;QACxE,yEAAyE;QACzE,yEAAyE;QACzE,OAAO,CAAC,IAAI,CACV,0DAA0D,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAC7G,CAAC;IACJ,CAAC;IAED,OAAO,GAAG,EAAE,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC;AAC1C,CAAC"}
@@ -1,6 +1,6 @@
1
1
  export declare const DocfyRegistry: {
2
- add(target: Function, callSiteStack?: string): void;
3
- getAll(): ReadonlySet<Function>;
4
- getCallSite(target: Function): string | undefined;
2
+ add(target: NewableFunction, callSiteStack?: string): void;
3
+ getAll(): ReadonlySet<NewableFunction>;
4
+ getCallSite(target: NewableFunction): string | undefined;
5
5
  _reset(): void;
6
6
  };
@@ -1 +1 @@
1
- {"version":3,"file":"registry.js","sourceRoot":"","sources":["../src/registry.ts"],"names":[],"mappings":";;;AAAA,yDAAyD;AACzD,yEAAyE;AACzE,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAY,CAAC;AAErC,4EAA4E;AAC5E,4EAA4E;AAC5E,wEAAwE;AACxE,2EAA2E;AAC3E,MAAM,SAAS,GAAG,IAAI,OAAO,EAAoB,CAAC;AAErC,QAAA,aAAa,GAAG;IAC3B,GAAG,CAAC,MAAgB,EAAE,aAAsB;QAC1C,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACrB,IAAI,aAAa;YAAE,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAC1D,CAAC;IAED,MAAM;QACJ,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,WAAW,CAAC,MAAgB;QAC1B,OAAO,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC/B,CAAC;IAED,4DAA4D;IAC5D,MAAM;QACJ,QAAQ,CAAC,KAAK,EAAE,CAAC;IACnB,CAAC;CACF,CAAC"}
1
+ {"version":3,"file":"registry.js","sourceRoot":"","sources":["../src/registry.ts"],"names":[],"mappings":";;;AAAA,yDAAyD;AACzD,yEAAyE;AACzE,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAmB,CAAC;AAE5C,4EAA4E;AAC5E,4EAA4E;AAC5E,wEAAwE;AACxE,2EAA2E;AAC3E,MAAM,SAAS,GAAG,IAAI,OAAO,EAA2B,CAAC;AAE5C,QAAA,aAAa,GAAG;IAC3B,GAAG,CAAC,MAAuB,EAAE,aAAsB;QACjD,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACrB,IAAI,aAAa;YAAE,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAC1D,CAAC;IAED,MAAM;QACJ,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,WAAW,CAAC,MAAuB;QACjC,OAAO,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC/B,CAAC;IAED,4DAA4D;IAC5D,MAAM;QACJ,QAAQ,CAAC,KAAK,EAAE,CAAC;IACnB,CAAC;CACF,CAAC"}
@@ -23,5 +23,5 @@ type CacheSnapshot = Record<string, {
23
23
  * the bundle position from the stack trace back to the original file via
24
24
  * that bundle's source map (emitted by default by the webpack build).
25
25
  */
26
- export declare function resolveDocsPath(controllerClass: Function, readCache?: () => CacheSnapshot, callSiteStack?: string): string | null;
26
+ export declare function resolveDocsPath(controllerClass: NewableFunction, readCache?: () => CacheSnapshot, callSiteStack?: string): string | null;
27
27
  export {};
@@ -1 +1 @@
1
- {"version":3,"file":"resolve-docs-path.js","sourceRoot":"","sources":["../src/resolve-docs-path.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BA,0CAgBC;AA3CD,2CAA6B;AAC7B,2EAAiF;AAIjF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,SAAgB,eAAe,CAC7B,eAAyB,EACzB,YAAiC,GAAG,EAAE,CAAC,OAAO,CAAC,KAAiC,EAChF,aAAsB;IAEtB,MAAM,cAAc,GAClB,eAAe,CAAC,eAAe,EAAE,SAAS,EAAE,CAAC,IAAI,mBAAmB,CAAC,aAAa,CAAC,CAAC;IACtF,IAAI,CAAC,cAAc;QAAE,OAAO,IAAI,CAAC;IAEjC,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,aAAa;IACvD,MAAM,IAAI,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAElD,kFAAkF;IAClF,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC;QAAE,OAAO,IAAI,CAAC;IAE/C,OAAO,GAAG,IAAI,QAAQ,GAAG,EAAE,CAAC;AAC9B,CAAC;AAED,SAAS,mBAAmB,CAAC,aAAiC;IAC5D,MAAM,GAAG,GAAG,IAAA,yCAAa,EAAC,aAAa,CAAC,CAAC;IACzC,IAAI,CAAC,GAAG;QAAE,OAAO,IAAI,CAAC;IACtB,OAAO,IAAA,+CAAmB,EAAC,GAAG,CAAC,CAAC;AAClC,CAAC;AAED;;;;;;GAMG;AACH,SAAS,eAAe,CAAC,MAAgB,EAAE,KAAoB;IAC7D,MAAM,UAAU,GAAa,EAAE,CAAC;IAEhC,KAAK,MAAM,CAAC,QAAQ,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACpD,IAAI,CAAC,GAAG,EAAE,OAAO;YAAE,SAAS;QAC5B,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;YAC3C,mEAAmE;YACnE,mEAAmE;YACnE,kEAAkE;YAClE,gEAAgE;YAChE,2DAA2D;YAC3D,IAAI,KAAc,CAAC;YACnB,IAAI,CAAC;gBACH,KAAK,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAC3B,CAAC;YAAC,MAAM,CAAC;gBACP,SAAS;YACX,CAAC;YACD,IAAI,KAAK,KAAK,MAAM,EAAE,CAAC;gBACrB,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAC1B,MAAM;YACR,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IACzC,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC;IAElD,4DAA4D;IAC5D,kEAAkE;IAClE,qEAAqE;IACrE,MAAM,UAAU,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE;QACvC,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/C,OAAO,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;IACvE,CAAC,CAAC,CAAC;IAEH,OAAO,UAAU,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC;AACrC,CAAC"}
1
+ {"version":3,"file":"resolve-docs-path.js","sourceRoot":"","sources":["../src/resolve-docs-path.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BA,0CAeC;AA1CD,2CAA6B;AAC7B,2EAAiF;AAIjF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,SAAgB,eAAe,CAC7B,eAAgC,EAChC,YAAiC,GAAG,EAAE,CAAC,OAAO,CAAC,KAAiC,EAChF,aAAsB;IAEtB,MAAM,cAAc,GAAG,eAAe,CAAC,eAAe,EAAE,SAAS,EAAE,CAAC,IAAI,mBAAmB,CAAC,aAAa,CAAC,CAAC;IAC3G,IAAI,CAAC,cAAc;QAAE,OAAO,IAAI,CAAC;IAEjC,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,aAAa;IACvD,MAAM,IAAI,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAElD,kFAAkF;IAClF,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC;QAAE,OAAO,IAAI,CAAC;IAE/C,OAAO,GAAG,IAAI,QAAQ,GAAG,EAAE,CAAC;AAC9B,CAAC;AAED,SAAS,mBAAmB,CAAC,aAAiC;IAC5D,MAAM,GAAG,GAAG,IAAA,yCAAa,EAAC,aAAa,CAAC,CAAC;IACzC,IAAI,CAAC,GAAG;QAAE,OAAO,IAAI,CAAC;IACtB,OAAO,IAAA,+CAAmB,EAAC,GAAG,CAAC,CAAC;AAClC,CAAC;AAED;;;;;;GAMG;AACH,SAAS,eAAe,CAAC,MAAuB,EAAE,KAAoB;IACpE,MAAM,UAAU,GAAa,EAAE,CAAC;IAEhC,KAAK,MAAM,CAAC,QAAQ,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACpD,IAAI,CAAC,GAAG,EAAE,OAAO;YAAE,SAAS;QAC5B,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;YAC3C,mEAAmE;YACnE,mEAAmE;YACnE,kEAAkE;YAClE,gEAAgE;YAChE,2DAA2D;YAC3D,IAAI,KAAc,CAAC;YACnB,IAAI,CAAC;gBACH,KAAK,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAC3B,CAAC;YAAC,MAAM,CAAC;gBACP,SAAS;YACX,CAAC;YACD,IAAI,KAAK,KAAK,MAAM,EAAE,CAAC;gBACrB,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAC1B,MAAM;YACR,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IACzC,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC;IAElD,4DAA4D;IAC5D,kEAAkE;IAClE,qEAAqE;IACrE,MAAM,UAAU,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE;QACvC,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/C,OAAO,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;IACvE,CAAC,CAAC,CAAC;IAEH,OAAO,UAAU,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC;AACrC,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"resolve-source-from-stack.js","sourceRoot":"","sources":["../src/resolve-source-from-stack.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8BA,sCAaC;AAmCD,kDAmCC;AAjHD,uCAAyB;AACzB,2CAA6B;AAC7B,2CAA6D;AAQ7D,MAAM,cAAc,GAAG,kCAAkC,CAAC;AAE1D;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,aAAa,CAAC,KAAyB;IACrD,IAAI,CAAC,KAAK;QAAE,OAAO,IAAI,CAAC;IACxB,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,2DAA2D;IAErG,KAAK,MAAM,OAAO,IAAI,KAAK,EAAE,CAAC;QAC5B,MAAM,KAAK,GAAG,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;QAClD,IAAI,CAAC,KAAK;YAAE,SAAS;QACrB,MAAM,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,CAAC,GAAG,KAAK,CAAC;QACxC,IAAI,CAAC,IAAI;YAAE,SAAS;QACpB,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,GAAG,eAAe,IAAI,CAAC,GAAG,EAAE,CAAC;YAAE,SAAS;QAClE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;IACjE,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,aAAa,CAAC,UAAkB;IACvC,MAAM,WAAW,GAAG,GAAG,UAAU,MAAM,CAAC;IACxC,IAAI,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;QAC/B,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,WAAW,EAAE,MAAM,CAAC,CAAiB,CAAC;QAC1E,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;QACrD,MAAM,KAAK,GAAG,qGAAqG,CAAC,IAAI,CACtH,QAAQ,CACT,CAAC;QACF,IAAI,CAAC,KAAK;YAAE,OAAO,IAAI,CAAC;QACxB,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACjE,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAiB,CAAC;IAC7C,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,mBAAmB,CAAC,GAAkB;IACpD,iEAAiE;IACjE,iEAAiE;IACjE,uEAAuE;IACvE,uEAAuE;IACvE,qEAAqE;IACrE,sEAAsE;IACtE,2DAA2D;IAC3D,yCAAyC;IACzC,MAAM,mBAAmB,GAAG,oBAAoB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC3D,IAAI,mBAAmB;QAAE,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,mBAAmB,CAAC,CAAC;IAEjF,MAAM,GAAG,GAAG,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACpC,IAAI,CAAC,GAAG;QAAE,OAAO,GAAG,CAAC,IAAI,CAAC;IAE1B,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,IAAI,8BAAiB,CAAC,GAAG,CAAC,CAAC;QAC5C,MAAM,QAAQ,GAAG,QAAQ,CAAC,mBAAmB,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;QACtF,IAAI,CAAC,QAAQ,CAAC,MAAM;YAAE,OAAO,GAAG,CAAC,IAAI,CAAC;QAEtC,MAAM,aAAa,GAAG,oBAAoB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC5D,IAAI,aAAa,EAAE,CAAC;YAClB,sEAAsE;YACtE,qEAAqE;YACrE,qEAAqE;YACrE,uEAAuE;YACvE,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,aAAa,CAAC,CAAC;QACpD,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACtC,MAAM,UAAU,GAAG,GAAG,CAAC,UAAU,IAAI,EAAE,CAAC;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC3D,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,GAAG,CAAC,IAAI,CAAC;IAClB,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,SAAS,oBAAoB,CAAC,MAAc;IAC1C,MAAM,KAAK,GAAG,2BAA2B,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACvD,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AACjC,CAAC"}
1
+ {"version":3,"file":"resolve-source-from-stack.js","sourceRoot":"","sources":["../src/resolve-source-from-stack.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8BA,sCAaC;AAoCD,kDAmCC;AAlHD,uCAAyB;AACzB,2CAA6B;AAC7B,2CAA6D;AAQ7D,MAAM,cAAc,GAAG,kCAAkC,CAAC;AAE1D;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,aAAa,CAAC,KAAyB;IACrD,IAAI,CAAC,KAAK;QAAE,OAAO,IAAI,CAAC;IACxB,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,2DAA2D;IAErG,KAAK,MAAM,OAAO,IAAI,KAAK,EAAE,CAAC;QAC5B,MAAM,KAAK,GAAG,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;QAClD,IAAI,CAAC,KAAK;YAAE,SAAS;QACrB,MAAM,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,CAAC,GAAG,KAAK,CAAC;QACxC,IAAI,CAAC,IAAI;YAAE,SAAS;QACpB,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,GAAG,eAAe,IAAI,CAAC,GAAG,EAAE,CAAC;YAAE,SAAS;QAClE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;IACjE,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,aAAa,CAAC,UAAkB;IACvC,MAAM,WAAW,GAAG,GAAG,UAAU,MAAM,CAAC;IACxC,IAAI,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;QAC/B,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,WAAW,EAAE,MAAM,CAAC,CAAiB,CAAC;QAC1E,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;QACrD,MAAM,KAAK,GACT,qGAAqG,CAAC,IAAI,CACxG,QAAQ,CACT,CAAC;QACJ,IAAI,CAAC,KAAK;YAAE,OAAO,IAAI,CAAC;QACxB,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACjE,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAiB,CAAC;IAC7C,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,mBAAmB,CAAC,GAAkB;IACpD,iEAAiE;IACjE,iEAAiE;IACjE,uEAAuE;IACvE,uEAAuE;IACvE,qEAAqE;IACrE,sEAAsE;IACtE,2DAA2D;IAC3D,yCAAyC;IACzC,MAAM,mBAAmB,GAAG,oBAAoB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC3D,IAAI,mBAAmB;QAAE,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,mBAAmB,CAAC,CAAC;IAEjF,MAAM,GAAG,GAAG,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACpC,IAAI,CAAC,GAAG;QAAE,OAAO,GAAG,CAAC,IAAI,CAAC;IAE1B,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,IAAI,8BAAiB,CAAC,GAAG,CAAC,CAAC;QAC5C,MAAM,QAAQ,GAAG,QAAQ,CAAC,mBAAmB,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;QACtF,IAAI,CAAC,QAAQ,CAAC,MAAM;YAAE,OAAO,GAAG,CAAC,IAAI,CAAC;QAEtC,MAAM,aAAa,GAAG,oBAAoB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC5D,IAAI,aAAa,EAAE,CAAC;YAClB,sEAAsE;YACtE,qEAAqE;YACrE,qEAAqE;YACrE,uEAAuE;YACvE,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,aAAa,CAAC,CAAC;QACpD,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACtC,MAAM,UAAU,GAAG,GAAG,CAAC,UAAU,IAAI,EAAE,CAAC;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC3D,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,GAAG,CAAC,IAAI,CAAC;IAClB,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,SAAS,oBAAoB,CAAC,MAAc;IAC1C,MAAM,KAAK,GAAG,2BAA2B,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACvD,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AACjC,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"with-docs.decorator.js","sourceRoot":"","sources":["../src/with-docs.decorator.ts"],"names":[],"mappings":";;;AAuBA,4BAYC;AAnCD,2CAA6C;AAC7C,yCAA2C;AAE3C;;;;;;;;GAQG;AACU,QAAA,YAAY,GAAG,iBAAiB,CAAC;AAE9C;;;;;;;;GAQG;AACH,SAAgB,QAAQ;IACtB,yEAAyE;IACzE,0EAA0E;IAC1E,0EAA0E;IAC1E,uEAAuE;IACvE,0EAA0E;IAC1E,MAAM,aAAa,GAAG,IAAI,KAAK,EAAE,CAAC,KAAK,CAAC;IAExC,OAAO,CAAC,MAAgB,EAAE,EAAE;QAC1B,IAAA,oBAAW,EAAC,oBAAY,EAAE,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC;QACxC,wBAAa,CAAC,GAAG,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAC3C,CAAC,CAAC;AACJ,CAAC"}
1
+ {"version":3,"file":"with-docs.decorator.js","sourceRoot":"","sources":["../src/with-docs.decorator.ts"],"names":[],"mappings":";;;AAuBA,4BAYC;AAnCD,2CAA6C;AAC7C,yCAA2C;AAE3C;;;;;;;;GAQG;AACU,QAAA,YAAY,GAAG,iBAAiB,CAAC;AAE9C;;;;;;;;GAQG;AACH,SAAgB,QAAQ;IACtB,yEAAyE;IACzE,0EAA0E;IAC1E,0EAA0E;IAC1E,uEAAuE;IACvE,0EAA0E;IAC1E,MAAM,aAAa,GAAG,IAAI,KAAK,EAAE,CAAC,KAAK,CAAC;IAExC,OAAO,CAAC,MAAuB,EAAE,EAAE;QACjC,IAAA,oBAAW,EAAC,oBAAY,EAAE,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC;QACxC,wBAAa,CAAC,GAAG,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAC3C,CAAC,CAAC;AACJ,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "nestjs-docfy",
3
- "version": "0.3.6",
3
+ "version": "0.5.0",
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",
@@ -14,6 +14,11 @@
14
14
  "types": "./dist/testing.d.ts",
15
15
  "require": "./dist/testing.js",
16
16
  "default": "./dist/testing.js"
17
+ },
18
+ "./plugin": {
19
+ "types": "./dist/plugin/index.d.ts",
20
+ "require": "./dist/plugin/index.js",
21
+ "default": "./dist/plugin/index.js"
17
22
  }
18
23
  },
19
24
  "bin": {
@@ -32,7 +37,12 @@
32
37
  "test": "jest",
33
38
  "test:watch": "jest --watch",
34
39
  "test:cov": "jest --coverage",
35
- "prepublishOnly": "npm run build"
40
+ "lint": "eslint .",
41
+ "lint:fix": "eslint . --fix",
42
+ "format": "prettier --write .",
43
+ "format:check": "prettier --check .",
44
+ "prepublishOnly": "npm run build",
45
+ "release": "semantic-release"
36
46
  },
37
47
  "keywords": [
38
48
  "nestjs",
@@ -68,22 +78,41 @@
68
78
  },
69
79
  "license": "MIT",
70
80
  "peerDependencies": {
81
+ "@fastify/static": "^8.0.0 || ^9.0.0",
71
82
  "@nestjs/common": ">=9.0.0",
72
83
  "@nestjs/swagger": ">=6.0.0",
73
84
  "reflect-metadata": "^0.1.13 || ^0.2.0"
74
85
  },
86
+ "peerDependenciesMeta": {
87
+ "@fastify/static": {
88
+ "optional": true
89
+ }
90
+ },
75
91
  "devDependencies": {
92
+ "@eslint/js": "^10.0.1",
93
+ "@fastify/static": "^9.3.0",
76
94
  "@nestjs/common": "^11.0.0",
77
95
  "@nestjs/core": "^11.0.0",
96
+ "@nestjs/platform-fastify": "^11.1.28",
78
97
  "@nestjs/swagger": "^11.0.0",
98
+ "@semantic-release/changelog": "^7.0.0",
99
+ "@semantic-release/git": "^11.0.1",
79
100
  "@types/express": "^5.0.0",
80
101
  "@types/jest": "^29.5.14",
81
102
  "@types/node": "^22.0.0",
103
+ "eslint": "^10.8.0",
104
+ "eslint-config-prettier": "^10.1.8",
105
+ "eslint-plugin-prettier": "^5.5.6",
106
+ "fastify": "^5.10.0",
107
+ "globals": "^17.7.0",
82
108
  "jest": "^29.7.0",
109
+ "prettier": "^3.9.6",
83
110
  "reflect-metadata": "^0.2.2",
111
+ "semantic-release": "^25.0.8",
84
112
  "ts-jest": "^29.2.5",
85
113
  "ts-node": "^10.9.2",
86
- "typescript": "^5.7.3"
114
+ "typescript": "^5.7.3",
115
+ "typescript-eslint": "^8.65.0"
87
116
  },
88
117
  "dependencies": {
89
118
  "commander": "^15.0.0",