nestjs-docfy 0.2.8 → 0.3.1

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 (58) hide show
  1. package/README.md +261 -0
  2. package/dist/attach-tag-groups.d.ts +14 -0
  3. package/dist/attach-tag-groups.js +24 -0
  4. package/dist/attach-tag-groups.js.map +1 -0
  5. package/dist/cli/build-openapi-patch.d.ts +45 -0
  6. package/dist/cli/build-openapi-patch.js +151 -0
  7. package/dist/cli/build-openapi-patch.js.map +1 -0
  8. package/dist/cli/coverage.d.ts +15 -0
  9. package/dist/cli/coverage.js +34 -0
  10. package/dist/cli/coverage.js.map +1 -0
  11. package/dist/cli/eval-decorator-args.d.ts +39 -0
  12. package/dist/cli/eval-decorator-args.js +115 -0
  13. package/dist/cli/eval-decorator-args.js.map +1 -0
  14. package/dist/cli/extract-docs-config.d.ts +19 -0
  15. package/dist/cli/extract-docs-config.js +89 -0
  16. package/dist/cli/extract-docs-config.js.map +1 -0
  17. package/dist/cli/index.js +287 -0
  18. package/dist/cli/index.js.map +1 -1
  19. package/dist/cli/lint.d.ts +33 -0
  20. package/dist/cli/lint.js +211 -0
  21. package/dist/cli/lint.js.map +1 -0
  22. package/dist/cli/merge-spec-patch.d.ts +57 -0
  23. package/dist/cli/merge-spec-patch.js +115 -0
  24. package/dist/cli/merge-spec-patch.js.map +1 -0
  25. package/dist/cli/patch-spec.d.ts +31 -0
  26. package/dist/cli/patch-spec.js +82 -0
  27. package/dist/cli/patch-spec.js.map +1 -0
  28. package/dist/docfy-ui.module.d.ts +48 -0
  29. package/dist/docfy-ui.module.js +72 -0
  30. package/dist/docfy-ui.module.js.map +1 -0
  31. package/dist/docfy.module.js +9 -5
  32. package/dist/docfy.module.js.map +1 -1
  33. package/dist/docs.d.ts +13 -0
  34. package/dist/docs.js +4 -0
  35. package/dist/docs.js.map +1 -1
  36. package/dist/index.d.ts +3 -0
  37. package/dist/index.js +5 -1
  38. package/dist/index.js.map +1 -1
  39. package/dist/registry.d.ts +2 -1
  40. package/dist/registry.js +11 -1
  41. package/dist/registry.js.map +1 -1
  42. package/dist/require-ts.d.ts +32 -0
  43. package/dist/require-ts.js +122 -0
  44. package/dist/require-ts.js.map +1 -0
  45. package/dist/resolve-docs-path.d.ts +10 -1
  46. package/dist/resolve-docs-path.js +31 -3
  47. package/dist/resolve-docs-path.js.map +1 -1
  48. package/dist/resolve-source-from-stack.d.ts +35 -0
  49. package/dist/resolve-source-from-stack.js +153 -0
  50. package/dist/resolve-source-from-stack.js.map +1 -0
  51. package/dist/tag-group-registry.d.ts +9 -0
  52. package/dist/tag-group-registry.js +32 -0
  53. package/dist/tag-group-registry.js.map +1 -0
  54. package/dist/testing.js +2 -0
  55. package/dist/testing.js.map +1 -1
  56. package/dist/with-docs.decorator.js +7 -1
  57. package/dist/with-docs.decorator.js.map +1 -1
  58. package/package.json +5 -1
@@ -0,0 +1,32 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.TagGroupRegistry = void 0;
4
+ // Global registry of tag groups declared via docs({ group, tags }).
5
+ // Populated at module-load time, same lifecycle as DocfyRegistry.
6
+ const groups = new Map();
7
+ exports.TagGroupRegistry = {
8
+ register(group, tags) {
9
+ if (!group)
10
+ return;
11
+ let set = groups.get(group);
12
+ if (!set) {
13
+ set = new Set();
14
+ groups.set(group, set);
15
+ }
16
+ for (const tag of tags) {
17
+ if (typeof tag === 'string' && tag.length > 0)
18
+ set.add(tag);
19
+ }
20
+ },
21
+ getAll() {
22
+ return Array.from(groups.entries()).map(([name, tagSet]) => ({
23
+ name,
24
+ tags: Array.from(tagSet),
25
+ }));
26
+ },
27
+ // For testing only — resets the registry between test runs.
28
+ _reset() {
29
+ groups.clear();
30
+ },
31
+ };
32
+ //# sourceMappingURL=tag-group-registry.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"tag-group-registry.js","sourceRoot":"","sources":["../src/tag-group-registry.ts"],"names":[],"mappings":";;;AAKA,oEAAoE;AACpE,kEAAkE;AAClE,MAAM,MAAM,GAAG,IAAI,GAAG,EAAuB,CAAC;AAEjC,QAAA,gBAAgB,GAAG;IAC9B,QAAQ,CAAC,KAAa,EAAE,IAAc;QACpC,IAAI,CAAC,KAAK;YAAE,OAAO;QACnB,IAAI,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC5B,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,GAAG,GAAG,IAAI,GAAG,EAAU,CAAC;YACxB,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QACzB,CAAC;QACD,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC;gBAAE,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC9D,CAAC;IACH,CAAC;IAED,MAAM;QACJ,OAAO,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC;YAC3D,IAAI;YACJ,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC;SACzB,CAAC,CAAC,CAAC;IACN,CAAC;IAED,4DAA4D;IAC5D,MAAM;QACJ,MAAM,CAAC,KAAK,EAAE,CAAC;IACjB,CAAC;CACF,CAAC"}
package/dist/testing.js CHANGED
@@ -12,7 +12,9 @@ exports.resetDocfyRegistry = resetDocfyRegistry;
12
12
  */
13
13
  const registry_1 = require("./registry");
14
14
  Object.defineProperty(exports, "DocfyRegistry", { enumerable: true, get: function () { return registry_1.DocfyRegistry; } });
15
+ const tag_group_registry_1 = require("./tag-group-registry");
15
16
  function resetDocfyRegistry() {
16
17
  registry_1.DocfyRegistry._reset();
18
+ tag_group_registry_1.TagGroupRegistry._reset();
17
19
  }
18
20
  //# sourceMappingURL=testing.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"testing.js","sourceRoot":"","sources":["../src/testing.ts"],"names":[],"mappings":";;;AAYA,gDAEC;AAdD;;;;;;;GAOG;AACH,yCAA2C;AAElC,8FAFA,wBAAa,OAEA;AAEtB,SAAgB,kBAAkB;IAChC,wBAAa,CAAC,MAAM,EAAE,CAAC;AACzB,CAAC"}
1
+ {"version":3,"file":"testing.js","sourceRoot":"","sources":["../src/testing.ts"],"names":[],"mappings":";;;AAaA,gDAGC;AAhBD;;;;;;;GAOG;AACH,yCAA2C;AAGlC,8FAHA,wBAAa,OAGA;AAFtB,6DAAwD;AAIxD,SAAgB,kBAAkB;IAChC,wBAAa,CAAC,MAAM,EAAE,CAAC;IACvB,qCAAgB,CAAC,MAAM,EAAE,CAAC;AAC5B,CAAC"}
@@ -24,9 +24,15 @@ exports.DOCFY_MARKER = 'docfy:with_docs';
24
24
  * export class UsersController { ... }
25
25
  */
26
26
  function WithDocs() {
27
+ // Captured here, not inside the returned decorator, so the stack's frame
28
+ // right under this function's own is the line `@WithDocs()` is written on
29
+ // (the controller's own file) — used by resolve-source-from-stack.ts as a
30
+ // fallback when require.cache has no per-file entry for the controller
31
+ // (e.g. the app is bundled by webpack; see DocfyModule's README section).
32
+ const callSiteStack = new Error().stack;
27
33
  return (target) => {
28
34
  (0, common_1.SetMetadata)(exports.DOCFY_MARKER, true)(target);
29
- registry_1.DocfyRegistry.add(target);
35
+ registry_1.DocfyRegistry.add(target, callSiteStack);
30
36
  };
31
37
  }
32
38
  //# sourceMappingURL=with-docs.decorator.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"with-docs.decorator.js","sourceRoot":"","sources":["../src/with-docs.decorator.ts"],"names":[],"mappings":";;;AAuBA,4BAKC;AA5BD,2CAA6C;AAC7C,yCAA2C;AAE3C;;;;;;;;GAQG;AACU,QAAA,YAAY,GAAG,iBAAiB,CAAC;AAE9C;;;;;;;;GAQG;AACH,SAAgB,QAAQ;IACtB,OAAO,CAAC,MAAgB,EAAE,EAAE;QAC1B,IAAA,oBAAW,EAAC,oBAAY,EAAE,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC;QACxC,wBAAa,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC5B,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,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"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "nestjs-docfy",
3
- "version": "0.2.8",
3
+ "version": "0.3.1",
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",
@@ -74,6 +74,7 @@
74
74
  "@nestjs/common": "^11.0.0",
75
75
  "@nestjs/core": "^11.0.0",
76
76
  "@nestjs/swagger": "^11.0.0",
77
+ "@types/express": "^5.0.0",
77
78
  "@types/jest": "^29.5.14",
78
79
  "@types/node": "^22.0.0",
79
80
  "jest": "^29.7.0",
@@ -84,7 +85,10 @@
84
85
  },
85
86
  "dependencies": {
86
87
  "commander": "^15.0.0",
88
+ "docfy-ui": "^0.0.1",
89
+ "express": "^5.0.0",
87
90
  "picocolors": "^1.1.1",
91
+ "source-map": "^0.6.1",
88
92
  "ts-morph": "^28.0.0"
89
93
  },
90
94
  "overrides": {