@visulima/jsdoc-open-api 3.0.0-alpha.1 → 3.0.0-alpha.11

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 (111) hide show
  1. package/CHANGELOG.md +147 -0
  2. package/LICENSE.md +1 -1
  3. package/README.md +16 -8
  4. package/dist/cli/command/generate-command.d.cts +7 -0
  5. package/dist/cli/command/generate-command.d.mts +7 -0
  6. package/dist/cli/command/generate-command.d.ts +7 -0
  7. package/dist/cli/command/init-command.d.cts +2 -0
  8. package/dist/cli/command/init-command.d.mts +2 -0
  9. package/dist/cli/command/init-command.d.ts +2 -0
  10. package/dist/cli/commander/command/generate-command.d.cts +3 -0
  11. package/dist/cli/commander/command/generate-command.d.mts +3 -0
  12. package/dist/cli/commander/command/generate-command.d.ts +3 -0
  13. package/dist/cli/commander/command/init-command.d.cts +3 -0
  14. package/dist/cli/commander/command/init-command.d.mts +3 -0
  15. package/dist/cli/commander/command/init-command.d.ts +3 -0
  16. package/dist/cli/commander/index.cjs +11 -0
  17. package/dist/cli/commander/index.d.cts +2 -0
  18. package/dist/cli/commander/index.d.mts +2 -7
  19. package/dist/cli/commander/index.d.ts +2 -7
  20. package/dist/cli/commander/index.mjs +2 -30
  21. package/dist/cli/index.cjs +11 -0
  22. package/dist/cli/index.d.cts +2 -0
  23. package/dist/cli/index.d.mts +2 -10
  24. package/dist/cli/index.d.ts +2 -10
  25. package/dist/cli/index.mjs +2 -4
  26. package/dist/constants.d.cts +1 -0
  27. package/dist/constants.d.mts +1 -0
  28. package/dist/constants.d.ts +1 -0
  29. package/dist/exported.d.cts +198 -0
  30. package/dist/exported.d.mts +198 -0
  31. package/dist/exported.d.ts +198 -0
  32. package/dist/index.cjs +19 -0
  33. package/dist/index.d.cts +7 -0
  34. package/dist/index.d.mts +7 -248
  35. package/dist/index.d.ts +7 -248
  36. package/dist/index.mjs +6 -85
  37. package/dist/jsdoc/comments-to-open-api.d.cts +6 -0
  38. package/dist/jsdoc/comments-to-open-api.d.mts +6 -0
  39. package/dist/jsdoc/comments-to-open-api.d.ts +6 -0
  40. package/dist/packem_shared/SpecBuilder-B7YiF7zR.mjs +61 -0
  41. package/dist/packem_shared/SpecBuilder-CCESkmm5.cjs +63 -0
  42. package/dist/packem_shared/SwaggerCompilerPlugin-BkYJzU4f.cjs +88 -0
  43. package/dist/packem_shared/SwaggerCompilerPlugin-DZ7tIJ8x.mjs +86 -0
  44. package/dist/packem_shared/customizer-CoMXMU7a.mjs +8 -0
  45. package/dist/packem_shared/customizer-DDFwFqJl.cjs +10 -0
  46. package/dist/packem_shared/generateCommand-DRMkfIle.mjs +15 -0
  47. package/dist/packem_shared/generateCommand-MwnCNgEE.cjs +82 -0
  48. package/dist/packem_shared/generateCommand-RY4QFtm7.cjs +17 -0
  49. package/dist/packem_shared/generateCommand-a9_RAbug.mjs +80 -0
  50. package/dist/packem_shared/initCommand-B6Z9EXHP.mjs +15 -0
  51. package/dist/packem_shared/initCommand-Ch-72dKZ.cjs +65 -0
  52. package/dist/packem_shared/initCommand-D3yVEMwO.cjs +17 -0
  53. package/dist/packem_shared/initCommand-zE4VRDGW.mjs +63 -0
  54. package/dist/packem_shared/jsDocumentCommentsToOpenApi-C7yMeXJ5.cjs +337 -0
  55. package/dist/packem_shared/jsDocumentCommentsToOpenApi-DtrIZ2lK.mjs +331 -0
  56. package/dist/packem_shared/parseFile-BE-sKiRK.mjs +35 -0
  57. package/dist/packem_shared/parseFile-Dk7Bw7lt.cjs +42 -0
  58. package/dist/packem_shared/swaggerJsDocumentCommentsToOpenApi-B7g9rVr5.mjs +131 -0
  59. package/dist/packem_shared/swaggerJsDocumentCommentsToOpenApi-BuB7eE94.cjs +138 -0
  60. package/dist/packem_shared/validate-DZHaKH07.mjs +30 -0
  61. package/dist/packem_shared/validate-FKieC3ln.cjs +37 -0
  62. package/dist/packem_shared/yamlLoc-C7iHWvdq.mjs +14 -0
  63. package/dist/packem_shared/yamlLoc-CEvBiR4K.cjs +16 -0
  64. package/dist/parse-file.d.cts +9 -0
  65. package/dist/parse-file.d.mts +9 -0
  66. package/dist/parse-file.d.ts +9 -0
  67. package/dist/spec-builder.d.cts +14 -0
  68. package/dist/spec-builder.d.mts +14 -0
  69. package/dist/spec-builder.d.ts +14 -0
  70. package/dist/swagger-jsdoc/comments-to-open-api.d.cts +6 -0
  71. package/dist/swagger-jsdoc/comments-to-open-api.d.mts +6 -0
  72. package/dist/swagger-jsdoc/comments-to-open-api.d.ts +6 -0
  73. package/dist/swagger-jsdoc/organize-swagger-object.d.cts +7 -0
  74. package/dist/swagger-jsdoc/organize-swagger-object.d.mts +7 -0
  75. package/dist/swagger-jsdoc/organize-swagger-object.d.ts +7 -0
  76. package/dist/swagger-jsdoc/utils.d.cts +22 -0
  77. package/dist/swagger-jsdoc/utils.d.mts +22 -0
  78. package/dist/swagger-jsdoc/utils.d.ts +22 -0
  79. package/dist/util/customizer.d.cts +2 -0
  80. package/dist/util/customizer.d.mts +2 -0
  81. package/dist/util/customizer.d.ts +2 -0
  82. package/dist/util/object-merge.d.cts +2 -0
  83. package/dist/util/object-merge.d.mts +2 -0
  84. package/dist/util/object-merge.d.ts +2 -0
  85. package/dist/util/yaml-loc.d.cts +2 -0
  86. package/dist/util/yaml-loc.d.mts +2 -0
  87. package/dist/util/yaml-loc.d.ts +2 -0
  88. package/dist/validate.d.cts +2 -0
  89. package/dist/validate.d.mts +2 -0
  90. package/dist/validate.d.ts +2 -0
  91. package/dist/webpack/swagger-compiler-plugin.d.cts +15 -0
  92. package/dist/webpack/swagger-compiler-plugin.d.mts +15 -0
  93. package/dist/webpack/swagger-compiler-plugin.d.ts +15 -0
  94. package/package.json +34 -22
  95. package/dist/chunk-HCUSCJ47.mjs +0 -142
  96. package/dist/chunk-HCUSCJ47.mjs.map +0 -1
  97. package/dist/chunk-LH7UXAJC.js +0 -1223
  98. package/dist/chunk-LH7UXAJC.js.map +0 -1
  99. package/dist/chunk-MBTPK5EE.js +0 -149
  100. package/dist/chunk-MBTPK5EE.js.map +0 -1
  101. package/dist/chunk-RJ6GDVYR.mjs +0 -1205
  102. package/dist/chunk-RJ6GDVYR.mjs.map +0 -1
  103. package/dist/cli/commander/index.js +0 -33
  104. package/dist/cli/commander/index.js.map +0 -1
  105. package/dist/cli/commander/index.mjs.map +0 -1
  106. package/dist/cli/index.js +0 -17
  107. package/dist/cli/index.js.map +0 -1
  108. package/dist/cli/index.mjs.map +0 -1
  109. package/dist/index.js +0 -106
  110. package/dist/index.js.map +0 -1
  111. package/dist/index.mjs.map +0 -1
package/CHANGELOG.md CHANGED
@@ -1,3 +1,150 @@
1
+ ## @visulima/jsdoc-open-api [3.0.0-alpha.11](https://github.com/visulima/visulima/compare/@visulima/jsdoc-open-api@3.0.0-alpha.10...@visulima/jsdoc-open-api@3.0.0-alpha.11) (2026-04-22)
2
+
3
+ ### Bug Fixes
4
+
5
+ * Remove JSR configuration generation script and generated jsr.json files ([#616](https://github.com/visulima/visulima/issues/616)) ([533744b](https://github.com/visulima/visulima/commit/533744b103b74896941db5b727173e617a27a63b))
6
+
7
+
8
+ ### Dependencies
9
+
10
+ * **@visulima/fs:** upgraded to 5.0.0-alpha.12
11
+
12
+ ## @visulima/jsdoc-open-api [3.0.0-alpha.10](https://github.com/visulima/visulima/compare/@visulima/jsdoc-open-api@3.0.0-alpha.9...@visulima/jsdoc-open-api@3.0.0-alpha.10) (2026-04-21)
13
+
14
+ ### Miscellaneous Chores
15
+
16
+ * jsr.json update and lock file ([73fce38](https://github.com/visulima/visulima/commit/73fce38c7cb4603f3fffb88609b1b18e2feb4937))
17
+
18
+
19
+ ### Dependencies
20
+
21
+ * **@visulima/fs:** upgraded to 5.0.0-alpha.11
22
+
23
+ ## @visulima/jsdoc-open-api [3.0.0-alpha.9](https://github.com/visulima/visulima/compare/@visulima/jsdoc-open-api@3.0.0-alpha.8...@visulima/jsdoc-open-api@3.0.0-alpha.9) (2026-04-21)
24
+
25
+ ### Miscellaneous Chores
26
+
27
+ * update the jsr.json ([864ab7e](https://github.com/visulima/visulima/commit/864ab7e71c4b5ae82f64792d1ae8debfea2c539b))
28
+
29
+
30
+ ### Dependencies
31
+
32
+ * **@visulima/fs:** upgraded to 5.0.0-alpha.10
33
+
34
+ ## @visulima/jsdoc-open-api [3.0.0-alpha.8](https://github.com/visulima/visulima/compare/@visulima/jsdoc-open-api@3.0.0-alpha.7...@visulima/jsdoc-open-api@3.0.0-alpha.8) (2026-04-21)
35
+
36
+ ### Bug Fixes
37
+
38
+ * **api:** resolve eslint and type-safety issues across api packages ([3601491](https://github.com/visulima/visulima/commit/3601491261de56b5cfad87c97daafd458e4ee3b6))
39
+ * **jsdoc-open-api:** drop redundant String() conversion in init-command ([1b2384e](https://github.com/visulima/visulima/commit/1b2384e917687beaf464e18e24595c7d4214c94e))
40
+ * **jsdoc-open-api:** relax type overrides for parser code, preserve JSON roundtrip for undefined stripping ([be896e2](https://github.com/visulima/visulima/commit/be896e2e724396bcb74fbbd3161d29213a9984d6))
41
+
42
+ ### Miscellaneous Chores
43
+
44
+ * bump engines.node to ^22.14.0 || >=24.10.0 ([c3d0931](https://github.com/visulima/visulima/commit/c3d0931d1504e4f21ebf50ea680cfa7ce4ba15ce))
45
+ * fixed jsr.json ([5d85e51](https://github.com/visulima/visulima/commit/5d85e5179de38e284ec433b14d77c71a1619c8d6))
46
+ * **jsdoc-open-api:** apply formatter updates ([57231bd](https://github.com/visulima/visulima/commit/57231bd235fa16768802306aa6e906a4558c579c))
47
+ * **jsdoc-open-api:** apply pending lint and source updates ([0669fd3](https://github.com/visulima/visulima/commit/0669fd3d46ad0787ef6709cc8cad67b7ff7495f7))
48
+ * **jsdoc-open-api:** enforce curly braces and apply lint fixes ([606641f](https://github.com/visulima/visulima/commit/606641f7a29eaa5707ae27c57ed02a91adf950b5))
49
+
50
+
51
+ ### Dependencies
52
+
53
+ * **@visulima/fs:** upgraded to 5.0.0-alpha.9
54
+
55
+ ## @visulima/jsdoc-open-api [3.0.0-alpha.7](https://github.com/visulima/visulima/compare/@visulima/jsdoc-open-api@3.0.0-alpha.6...@visulima/jsdoc-open-api@3.0.0-alpha.7) (2026-04-08)
56
+
57
+ ### Miscellaneous Chores
58
+
59
+ * **jsdoc-open-api:** add tsconfig.eslint.json for type-aware linting ([dd9a888](https://github.com/visulima/visulima/commit/dd9a88810a864e5ef8ee9a1cdf3cf742a4549cb3))
60
+ * **jsdoc-open-api:** apply prettier formatting ([25dae1b](https://github.com/visulima/visulima/commit/25dae1bd4d911921c1926c0212751cf4179087aa))
61
+ * **jsdoc-open-api:** migrate .prettierrc.cjs to prettier.config.js ([cbe2931](https://github.com/visulima/visulima/commit/cbe2931b52a65fcb2e86960acdc31c8ebc3c9c74))
62
+
63
+
64
+ ### Dependencies
65
+
66
+ * **@visulima/fs:** upgraded to 5.0.0-alpha.7
67
+
68
+ ## @visulima/jsdoc-open-api [3.0.0-alpha.6](https://github.com/visulima/visulima/compare/@visulima/jsdoc-open-api@3.0.0-alpha.5...@visulima/jsdoc-open-api@3.0.0-alpha.6) (2026-03-26)
69
+
70
+ ### Features
71
+
72
+ * **web:** auto-generate packages page from workspace metadata ([623e520](https://github.com/visulima/visulima/commit/623e5207693a7fe720f5f2f179593a3654c880e3))
73
+
74
+ ### Miscellaneous Chores
75
+
76
+ * update homepage URLs to visulima.com/packages/ format ([be42968](https://github.com/visulima/visulima/commit/be42968129df85fb074224435e33135ff44cab91))
77
+
78
+
79
+ ### Dependencies
80
+
81
+ * **@visulima/fs:** upgraded to 5.0.0-alpha.6
82
+
83
+ ## @visulima/jsdoc-open-api [3.0.0-alpha.5](https://github.com/visulima/visulima/compare/@visulima/jsdoc-open-api@3.0.0-alpha.4...@visulima/jsdoc-open-api@3.0.0-alpha.5) (2026-03-26)
84
+
85
+ ### Bug Fixes
86
+
87
+ * **jsdoc-open-api:** use workspace:* for internal [@visulima](https://github.com/visulima) deps ([4f97e12](https://github.com/visulima/visulima/commit/4f97e125a8f84a5e8b9691b72e2f9c56c5d3a69b))
88
+ * **web:** improve build setup with incremental stats caching and prod install ([fe33e75](https://github.com/visulima/visulima/commit/fe33e75827586779b4b3a0c6d57b39f889ee6207))
89
+
90
+ ### Documentation
91
+
92
+ * **cerebro,prisma-dmmf-transformer,jsdoc-open-api:** add comprehensive Fumadocs documentation ([891b308](https://github.com/visulima/visulima/commit/891b308a34bca2765a4a97ea450648d20d90e0cf))
93
+
94
+ ### Miscellaneous Chores
95
+
96
+ * **api:** remove empty peerDependencies and optionalDependencies ([85142fa](https://github.com/visulima/visulima/commit/85142fa76729c238a59ac48265b5e33e31183abb))
97
+ * **api:** update dependencies ([f3b6f7c](https://github.com/visulima/visulima/commit/f3b6f7c956e8ae2c0da67773b3790f159c07de29))
98
+ * **jsdoc-open-api:** migrate deps to pnpm catalogs ([9a673ca](https://github.com/visulima/visulima/commit/9a673ca0d8235d0ff28a6fe9b150cf2ee37e78a4))
99
+ * **jsdoc-open-api:** update dependencies ([5a1248f](https://github.com/visulima/visulima/commit/5a1248f8fa408fc81bb07a5bf9ce8430b89c1f57))
100
+ * **jsdoc-open-api:** update dependencies ([f5d2a31](https://github.com/visulima/visulima/commit/f5d2a31a8fd163c321915a779c661b758b3e6f73))
101
+ * **jsdoc-open-api:** update tests, docs, and source formatting ([9526ec8](https://github.com/visulima/visulima/commit/9526ec8ebb3e0e506d50b2f6035faf0cbcaca205))
102
+ * sorting package.json ([430ed68](https://github.com/visulima/visulima/commit/430ed683d3e38e4c5c5530f787ca832f083b17e4))
103
+ * update lock file maintenance ([d83e716](https://github.com/visulima/visulima/commit/d83e71697b75d24704185b66bb521a934d2db02d))
104
+ * visulima website ([#591](https://github.com/visulima/visulima/issues/591)) ([59ab2e2](https://github.com/visulima/visulima/commit/59ab2e2befb03e51cd2088956f83d9b87de6d033))
105
+ * year update ([47f4105](https://github.com/visulima/visulima/commit/47f410596ce7190cfea36a073db32e0cec50bbcd))
106
+
107
+ ### Code Refactoring
108
+
109
+ * **jsdoc-open-api:** replace read-pkg-up with @visulima/fs and migrate to packem ([be668e4](https://github.com/visulima/visulima/commit/be668e4dc21a3394bcdb22aecf416f9c27e08e0d))
110
+
111
+
112
+ ### Dependencies
113
+
114
+ * **@visulima/fs:** upgraded to 5.0.0-alpha.5
115
+
116
+ ## @visulima/jsdoc-open-api [3.0.0-alpha.4](https://github.com/visulima/visulima/compare/@visulima/jsdoc-open-api@3.0.0-alpha.3...@visulima/jsdoc-open-api@3.0.0-alpha.4) (2026-01-17)
117
+
118
+ ### Bug Fixes
119
+
120
+ * **jsdoc-open-api:** combine name and description for path-based YAML parsing ([68e7d23](https://github.com/visulima/visulima/commit/68e7d2395ab97de3221892afe03da27688df7569))
121
+
122
+ ## @visulima/jsdoc-open-api [3.0.0-alpha.3](https://github.com/visulima/visulima/compare/@visulima/jsdoc-open-api@3.0.0-alpha.2...@visulima/jsdoc-open-api@3.0.0-alpha.3) (2025-12-27)
123
+
124
+ ### Bug Fixes
125
+
126
+ * **jsdoc-open-api:** update package files ([323a059](https://github.com/visulima/visulima/commit/323a059bf14193e847d9cfbca969342405045d42))
127
+
128
+ ### Miscellaneous Chores
129
+
130
+ * fixed project.json names and schema path ([964722f](https://github.com/visulima/visulima/commit/964722f691db205c7edb9aa6db29e849a647500b))
131
+
132
+
133
+ ### Dependencies
134
+
135
+ * **@visulima/fs:** upgraded to 5.0.0-alpha.3
136
+
137
+ ## @visulima/jsdoc-open-api [3.0.0-alpha.2](https://github.com/visulima/visulima/compare/@visulima/jsdoc-open-api@3.0.0-alpha.1...@visulima/jsdoc-open-api@3.0.0-alpha.2) (2025-12-11)
138
+
139
+ ### Bug Fixes
140
+
141
+ * update package OG images across multiple packages ([f08e4dd](https://github.com/visulima/visulima/commit/f08e4dd2b105ccb29c8412020a9c2be36d6c1e9e))
142
+
143
+
144
+ ### Dependencies
145
+
146
+ * **@visulima/fs:** upgraded to 5.0.0-alpha.2
147
+
1
148
  ## @visulima/jsdoc-open-api [3.0.0-alpha.1](https://github.com/visulima/visulima/compare/@visulima/jsdoc-open-api@2.0.95...@visulima/jsdoc-open-api@3.0.0-alpha.1) (2025-12-07)
2
149
 
3
150
  ### ⚠ BREAKING CHANGES
package/LICENSE.md CHANGED
@@ -1,6 +1,6 @@
1
1
  MIT License
2
2
 
3
- Copyright (c) 2025 visulima
3
+ Copyright (c) 2026 visulima
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  of this software and associated documentation files (the "Software"), to deal
package/README.md CHANGED
@@ -517,13 +517,10 @@ For detailed information on the short syntax tags and possibilities, please refe
517
517
 
518
518
  <!-- Add link to short syntax docs here if they exist -->
519
519
 
520
- ---
521
-
522
- ## Contributing
523
-
524
- Contributions are welcome! Please refer to the [Contribution Guidelines](../../../.github/CONTRIBUTING.md) for details on how to submit pull requests, report issues, and suggest improvements.
520
+ ## Credits
525
521
 
526
- ---
522
+ - [Daniel Bannert](https://github.com/prisis)
523
+ - [All Contributors](https://github.com/visulima/visulima/graphs/contributors)
527
524
 
528
525
  ## Made with ❤️ at Anolilab
529
526
 
@@ -531,6 +528,17 @@ This is an open source project and will always remain free to use. If you think
531
528
 
532
529
  ## License
533
530
 
534
- This project is licensed under the **MIT License**. See the [LICENSE.md](LICENSE.md) file for details.
531
+ The visulima jsdoc-open-api is open-sourced software licensed under the [MIT][license]
535
532
 
536
- ---
533
+ <!-- badges -->
534
+
535
+ [license-badge]: https://img.shields.io/npm/l/@visulima/jsdoc-open-api?style=for-the-badge
536
+ [license]: https://github.com/visulima/visulima/blob/main/LICENSE
537
+ [npm-downloads-badge]: https://img.shields.io/npm/dm/@visulima/jsdoc-open-api?style=for-the-badge
538
+ [npm-downloads]: https://www.npmjs.com/package/@visulima/jsdoc-open-api
539
+ [prs-welcome-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=for-the-badge
540
+ [prs-welcome]: https://github.com/visulima/visulima/blob/main/.github/CONTRIBUTING.md
541
+ [chat-badge]: https://img.shields.io/discord/932323359193186354.svg?style=for-the-badge
542
+ [chat]: https://discord.gg/TtFJY8xkFK
543
+ [typescript-badge]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
544
+ [typescript-url]: https://www.typescriptlang.org/
@@ -0,0 +1,7 @@
1
+ declare const generateCommand: (configName: string, paths: string[], options: {
2
+ config?: string;
3
+ output?: string;
4
+ verbose?: boolean;
5
+ veryVerbose?: boolean;
6
+ }) => Promise<void>;
7
+ export = generateCommand;
@@ -0,0 +1,7 @@
1
+ declare const generateCommand: (configName: string, paths: string[], options: {
2
+ config?: string;
3
+ output?: string;
4
+ verbose?: boolean;
5
+ veryVerbose?: boolean;
6
+ }) => Promise<void>;
7
+ export default generateCommand;
@@ -0,0 +1,7 @@
1
+ declare const generateCommand: (configName: string, paths: string[], options: {
2
+ config?: string;
3
+ output?: string;
4
+ verbose?: boolean;
5
+ veryVerbose?: boolean;
6
+ }) => Promise<void>;
7
+ export = generateCommand;
@@ -0,0 +1,2 @@
1
+ declare const initCommand: (configName: string, packageJsonPath?: string) => void;
2
+ export = initCommand;
@@ -0,0 +1,2 @@
1
+ declare const initCommand: (configName: string, packageJsonPath?: string) => void;
2
+ export default initCommand;
@@ -0,0 +1,2 @@
1
+ declare const initCommand: (configName: string, packageJsonPath?: string) => void;
2
+ export = initCommand;
@@ -0,0 +1,3 @@
1
+ import type { Command } from "commander";
2
+ declare const generateCommand: (program: Command, commandName?: string, configName?: string) => void;
3
+ export = generateCommand;
@@ -0,0 +1,3 @@
1
+ import type { Command } from "commander";
2
+ declare const generateCommand: (program: Command, commandName?: string, configName?: string) => void;
3
+ export default generateCommand;
@@ -0,0 +1,3 @@
1
+ import type { Command } from "commander";
2
+ declare const generateCommand: (program: Command, commandName?: string, configName?: string) => void;
3
+ export = generateCommand;
@@ -0,0 +1,3 @@
1
+ import type { Command } from "commander";
2
+ declare const initCommand: (program: Command, commandName?: string, description?: string, configName?: string) => void;
3
+ export = initCommand;
@@ -0,0 +1,3 @@
1
+ import type { Command } from "commander";
2
+ declare const initCommand: (program: Command, commandName?: string, description?: string, configName?: string) => void;
3
+ export default initCommand;
@@ -0,0 +1,3 @@
1
+ import type { Command } from "commander";
2
+ declare const initCommand: (program: Command, commandName?: string, description?: string, configName?: string) => void;
3
+ export = initCommand;
@@ -0,0 +1,11 @@
1
+ 'use strict';
2
+
3
+ Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: 'Module' } });
4
+
5
+ const generateCommand = require('../../packem_shared/generateCommand-RY4QFtm7.cjs');
6
+ const initCommand = require('../../packem_shared/initCommand-D3yVEMwO.cjs');
7
+
8
+
9
+
10
+ exports.generateCommand = generateCommand;
11
+ exports.initCommand = initCommand;
@@ -0,0 +1,2 @@
1
+ export { default as generateCommand } from "./command/generate-command.d.cts";
2
+ export { default as initCommand } from "./command/init-command.d.cts";
@@ -1,7 +1,2 @@
1
- import { Command } from 'commander';
2
-
3
- declare const generateCommand: (program: Command, commandName?: string, configName?: string) => void;
4
-
5
- declare const initCommand: (program: Command, commandName?: string, description?: string, configName?: string) => void;
6
-
7
- export { generateCommand, initCommand };
1
+ export { default as generateCommand } from "./command/generate-command.d.mts";
2
+ export { default as initCommand } from "./command/init-command.d.mts";
@@ -1,7 +1,2 @@
1
- import { Command } from 'commander';
2
-
3
- declare const generateCommand: (program: Command, commandName?: string, configName?: string) => void;
4
-
5
- declare const initCommand: (program: Command, commandName?: string, description?: string, configName?: string) => void;
6
-
7
- export { generateCommand, initCommand };
1
+ export { default as generateCommand } from "./command/generate-command.d.ts";
2
+ export { default as initCommand } from "./command/init-command.d.ts";
@@ -1,30 +1,2 @@
1
- import { generate_command_default, init_command_default } from '../../chunk-HCUSCJ47.mjs';
2
- import '../../chunk-RJ6GDVYR.mjs';
3
- import { exit } from 'process';
4
-
5
- var generateCommand = (program, commandName = "generate", configName = ".openapirc.js") => {
6
- program.command(commandName).description("Generates OpenAPI (Swagger) documentation from JSDoc's").usage("[options] <path ...>").argument("[path ...]", "Paths to files or directories to parse").option("-c, --config [.openapirc.js]", "@visulima/jsdoc-open-api config file path.").option("-o, --output [swaggerSpec.json]", "Output swagger specification.").option("-v, --verbose", "Verbose output.").option("-d, --very-verbose", "Very verbose output.").action(async (paths, options) => {
7
- try {
8
- await generate_command_default(configName, paths, options);
9
- } catch (error) {
10
- console.error(error);
11
- exit(1);
12
- }
13
- });
14
- };
15
- var generate_command_default2 = generateCommand;
16
- var initCommand = (program, commandName = "init", description = "Inits a pre-configured @visulima/jsdoc-open-api config file.", configName = ".openapirc.js") => {
17
- program.command(commandName).description(description).action(() => {
18
- try {
19
- init_command_default(configName);
20
- } catch (error) {
21
- console.error(error);
22
- exit(1);
23
- }
24
- });
25
- };
26
- var init_command_default2 = initCommand;
27
-
28
- export { generate_command_default2 as generateCommand, init_command_default2 as initCommand };
29
- //# sourceMappingURL=index.mjs.map
30
- //# sourceMappingURL=index.mjs.map
1
+ export { default as generateCommand } from '../../packem_shared/generateCommand-DRMkfIle.mjs';
2
+ export { default as initCommand } from '../../packem_shared/initCommand-B6Z9EXHP.mjs';
@@ -0,0 +1,11 @@
1
+ 'use strict';
2
+
3
+ Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: 'Module' } });
4
+
5
+ const generateCommand = require('../packem_shared/generateCommand-MwnCNgEE.cjs');
6
+ const initCommand = require('../packem_shared/initCommand-Ch-72dKZ.cjs');
7
+
8
+
9
+
10
+ exports.generateCommand = generateCommand;
11
+ exports.initCommand = initCommand;
@@ -0,0 +1,2 @@
1
+ export { default as generateCommand } from "./command/generate-command.d.cts";
2
+ export { default as initCommand } from "./command/init-command.d.cts";
@@ -1,10 +1,2 @@
1
- declare const generateCommand: (configName: string, paths: string[], options: {
2
- config?: string;
3
- output?: string;
4
- verbose?: boolean;
5
- veryVerbose?: boolean;
6
- }) => Promise<void>;
7
-
8
- declare const initCommand: (configName: string, packageJsonPath?: string) => void;
9
-
10
- export { generateCommand, initCommand };
1
+ export { default as generateCommand } from "./command/generate-command.d.mts";
2
+ export { default as initCommand } from "./command/init-command.d.mts";
@@ -1,10 +1,2 @@
1
- declare const generateCommand: (configName: string, paths: string[], options: {
2
- config?: string;
3
- output?: string;
4
- verbose?: boolean;
5
- veryVerbose?: boolean;
6
- }) => Promise<void>;
7
-
8
- declare const initCommand: (configName: string, packageJsonPath?: string) => void;
9
-
10
- export { generateCommand, initCommand };
1
+ export { default as generateCommand } from "./command/generate-command.d.ts";
2
+ export { default as initCommand } from "./command/init-command.d.ts";
@@ -1,4 +1,2 @@
1
- export { generate_command_default as generateCommand, init_command_default as initCommand } from '../chunk-HCUSCJ47.mjs';
2
- import '../chunk-RJ6GDVYR.mjs';
3
- //# sourceMappingURL=index.mjs.map
4
- //# sourceMappingURL=index.mjs.map
1
+ export { default as generateCommand } from '../packem_shared/generateCommand-a9_RAbug.mjs';
2
+ export { default as initCommand } from '../packem_shared/initCommand-zE4VRDGW.mjs';
@@ -0,0 +1 @@
1
+ export declare const DEFAULT_EXCLUDE: string[];
@@ -0,0 +1 @@
1
+ export declare const DEFAULT_EXCLUDE: string[];
@@ -0,0 +1 @@
1
+ export declare const DEFAULT_EXCLUDE: string[];
@@ -0,0 +1,198 @@
1
+ export interface BaseDefinition {
2
+ components?: ComponentsObject;
3
+ externalDocs?: ExternalDocumentationObject;
4
+ info: InfoObject;
5
+ openapi: string;
6
+ paths?: PathsObject;
7
+ security?: SecurityRequirementObject[];
8
+ servers?: ServerObject[];
9
+ tags?: TagObject[];
10
+ }
11
+ export interface OpenApiObject extends BaseDefinition {
12
+ paths?: PathsObject;
13
+ }
14
+ export interface InfoObject {
15
+ contact?: ContactObject;
16
+ description?: string;
17
+ license?: LicenseObject;
18
+ termsOfService?: string;
19
+ title: string;
20
+ version: string;
21
+ }
22
+ export interface ContactObject {
23
+ email?: string;
24
+ name?: string;
25
+ url?: string;
26
+ }
27
+ export interface LicenseObject {
28
+ name: string;
29
+ url?: string;
30
+ }
31
+ export interface ServerObject {
32
+ description?: string;
33
+ url: string;
34
+ variables?: Map<ServerVariable>;
35
+ }
36
+ export interface ServerVariable {
37
+ default: string;
38
+ description?: string;
39
+ enum?: string[];
40
+ }
41
+ export interface ComponentsObject {
42
+ callbacks?: Map<CallbackObject | ReferenceObject>;
43
+ examples?: Map<ExampleObject | ReferenceObject>;
44
+ headers?: Map<HeaderObject | ReferenceObject>;
45
+ links?: Map<LinkObject | ReferenceObject>;
46
+ parameters?: Map<ParameterObject | ReferenceObject>;
47
+ requestBodies?: Map<ReferenceObject | RequestBodyObject>;
48
+ responses?: Map<ReferenceObject | ResponseObject>;
49
+ schemas?: Map<ReferenceObject | SchemaObject>;
50
+ securitySchemes?: Map<ApiKeySecuritySchemeObject | HttpSecuritySchemeObject | Oauth2SecuritySchemeObject | OpenIdConnectSecuritySchemeObject | ReferenceObject>;
51
+ }
52
+ export type PathsObject = Record<string, PathItemObject>;
53
+ export interface PathItemObject {
54
+ $ref?: string;
55
+ delete?: OperationObject;
56
+ description?: string;
57
+ get?: OperationObject;
58
+ head?: OperationObject;
59
+ options?: OperationObject;
60
+ parameters?: (ParameterObject | ReferenceObject)[];
61
+ patch?: OperationObject;
62
+ post?: OperationObject;
63
+ put?: OperationObject;
64
+ servers?: ServerObject[];
65
+ summary?: string;
66
+ trace?: OperationObject;
67
+ }
68
+ export interface OperationObject {
69
+ callbacks?: Map<CallbackObject | ReferenceObject>;
70
+ deprecated?: boolean;
71
+ description?: string;
72
+ externalDocs?: ExternalDocumentationObject;
73
+ operationId?: string;
74
+ parameters?: (ParameterObject | ReferenceObject)[];
75
+ requestBody?: ReferenceObject | RequestBodyObject;
76
+ responses: ResponsesObject;
77
+ security?: SecurityRequirementObject[];
78
+ servers?: ServerObject[];
79
+ summary?: string;
80
+ tags?: string[];
81
+ }
82
+ export interface ExternalDocumentationObject {
83
+ description?: string;
84
+ url: string;
85
+ }
86
+ export interface ParameterObject {
87
+ allowEmptyValue?: boolean;
88
+ allowReserved?: boolean;
89
+ content?: Map<MediaTypeObject>;
90
+ deprecated?: boolean;
91
+ description?: string;
92
+ example?: any;
93
+ examples?: Map<ExampleObject | ReferenceObject>;
94
+ explode?: string;
95
+ in: string;
96
+ name: string;
97
+ required?: boolean;
98
+ schema?: ReferenceObject | SchemaObject;
99
+ style?: string;
100
+ }
101
+ export interface RequestBodyObject {
102
+ content: Map<MediaTypeObject>;
103
+ description?: string;
104
+ required?: boolean;
105
+ }
106
+ export interface MediaTypeObject {
107
+ encoding?: Map<EncodingObject>;
108
+ example?: any;
109
+ examples?: Map<ExampleObject | ReferenceObject>;
110
+ schema?: ReferenceObject | SchemaObject;
111
+ }
112
+ export interface EncodingObject {
113
+ allowReserved?: boolean;
114
+ contentType?: string;
115
+ explode?: boolean;
116
+ headers?: Map<HeaderObject | ReferenceObject>;
117
+ style?: string;
118
+ }
119
+ export type ResponsesObject = Record<string, ReferenceObject | ResponseObject>;
120
+ export interface ResponseObject {
121
+ content?: Map<MediaTypeObject>;
122
+ description: string;
123
+ headers?: Map<HeaderObject | ReferenceObject>;
124
+ links?: Map<LinkObject | ReferenceObject>;
125
+ }
126
+ export type CallbackObject = Record<string, PathItemObject>;
127
+ export interface ExampleObject {
128
+ description?: string;
129
+ externalValue?: string;
130
+ summary?: string;
131
+ value?: any;
132
+ }
133
+ export interface LinkObject {
134
+ description?: string;
135
+ operationId?: string;
136
+ operationRef?: string;
137
+ parameters?: Map<any>;
138
+ requestBody?: any;
139
+ server?: ServerObject;
140
+ }
141
+ export interface HeaderObject {
142
+ allowEmptyValue?: boolean;
143
+ allowReserved?: boolean;
144
+ content?: Map<MediaTypeObject>;
145
+ deprecated?: boolean;
146
+ description?: string;
147
+ example?: any;
148
+ examples?: Map<ExampleObject | ReferenceObject>;
149
+ explode?: string;
150
+ required?: boolean;
151
+ schema?: ReferenceObject | SchemaObject;
152
+ style?: string;
153
+ }
154
+ export interface TagObject {
155
+ description?: string;
156
+ externalDocs?: ExternalDocumentationObject;
157
+ name: string;
158
+ }
159
+ export interface ReferenceObject {
160
+ $ref: string;
161
+ }
162
+ export type SchemaObject = Record<string, any>;
163
+ export interface ApiKeySecuritySchemeObject {
164
+ description?: string;
165
+ in: string;
166
+ name: string;
167
+ type: string;
168
+ }
169
+ export interface HttpSecuritySchemeObject {
170
+ bearerFormat?: string;
171
+ description?: string;
172
+ scheme: string;
173
+ type: string;
174
+ }
175
+ export interface Oauth2SecuritySchemeObject {
176
+ description?: string;
177
+ flows: OAuthFlowsObject;
178
+ type: string;
179
+ }
180
+ export interface OpenIdConnectSecuritySchemeObject {
181
+ description?: string;
182
+ openIdConnectUrl: string;
183
+ type: string;
184
+ }
185
+ export interface OAuthFlowsObject {
186
+ authorizationCode?: OAuthFlowObject;
187
+ clientCredentials?: OAuthFlowObject;
188
+ implicit?: OAuthFlowObject;
189
+ password?: OAuthFlowObject;
190
+ }
191
+ export interface OAuthFlowObject {
192
+ authorizationUrl?: string;
193
+ refreshUrl: string;
194
+ scopes: Map<string>;
195
+ tokenUrl?: string;
196
+ }
197
+ export type SecurityRequirementObject = Record<string, string[]>;
198
+ export type Map<T> = Record<string, T>;