@cparra/apexdocs 2.25.0-alpha.8 → 2.25.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 (429) hide show
  1. package/.eslintrc.js +12 -0
  2. package/README.md +12 -73
  3. package/apexdocs.config.ts +13 -0
  4. package/docs/.nojekyll +0 -0
  5. package/docs/README.md +1 -0
  6. package/docs/index.html +22 -0
  7. package/docs/restapi.json +589 -0
  8. package/docs/types/Classes/nspc.AnotherInterface.md +22 -0
  9. package/docs/types/Classes/nspc.ChildClass.md +97 -0
  10. package/docs/types/Main/nspc.GroupedClass.md +10 -0
  11. package/docs/types/Main/nspc.SampleClass.md +190 -0
  12. package/docs/types/Misc-Group/nspc.EscapedAnnotations.md +4 -0
  13. package/docs/types/Misc-Group/nspc.GrandparentClass.md +13 -0
  14. package/docs/types/Misc-Group/nspc.InterfaceWithInheritance.md +29 -0
  15. package/docs/types/Misc-Group/nspc.MemberGrouping.md +13 -0
  16. package/docs/types/Misc-Group/nspc.ParentClass.md +37 -0
  17. package/docs/types/Misc-Group/nspc.Reference1.md +18 -0
  18. package/docs/types/Misc-Group/nspc.Reference2.md +12 -0
  19. package/docs/types/Misc-Group/nspc.Reference3.md +7 -0
  20. package/docs/types/Misc-Group/nspc.Reference4.md +7 -0
  21. package/docs/types/Misc-Group/nspc.Reference5.md +7 -0
  22. package/docs/types/Misc-Group/nspc.Reference6.md +9 -0
  23. package/docs/types/Misc-Group/nspc.Reference7.md +7 -0
  24. package/docs/types/Misc-Group/nspc.SampleClassWithoutModifier.md +11 -0
  25. package/docs/types/Misc-Group/nspc.SampleRestResource.md +211 -0
  26. package/docs/types/Misc-Group/nspc.SampleRestResourceWithInnerClass.md +34 -0
  27. package/docs/types/Misc-Group/nspc.SampleRestResourceWithoutApexDocs.md +14 -0
  28. package/docs/types/README.md +97 -0
  29. package/docs/types/Sample-Interfaces/nspc.SampleInterface.md +23 -0
  30. package/examples/includes/header.md +3 -0
  31. package/jest.config.js +1 -6
  32. package/lib/application/Apexdocs.d.ts +13 -0
  33. package/lib/application/Apexdocs.js +77 -0
  34. package/lib/application/Apexdocs.js.map +1 -0
  35. package/lib/cli/generate.d.ts +2 -0
  36. package/lib/cli/generate.js +131 -0
  37. package/lib/cli/generate.js.map +1 -0
  38. package/lib/index.d.ts +1 -0
  39. package/lib/index.js +18 -0
  40. package/lib/index.js.map +1 -0
  41. package/lib/model/apex-bundle.d.ts +6 -0
  42. package/lib/model/apex-bundle.js +11 -0
  43. package/lib/model/apex-bundle.js.map +1 -0
  44. package/lib/model/apex-type-wrappers/ClassMirrorWrapper.d.ts +7 -0
  45. package/lib/model/apex-type-wrappers/ClassMirrorWrapper.js +14 -0
  46. package/lib/model/apex-type-wrappers/ClassMirrorWrapper.js.map +1 -0
  47. package/lib/model/apex-type-wrappers/MethodMirrorWrapper.d.ts +7 -0
  48. package/lib/model/apex-type-wrappers/MethodMirrorWrapper.js +12 -0
  49. package/lib/model/apex-type-wrappers/MethodMirrorWrapper.js.map +1 -0
  50. package/lib/model/inheritance.d.ts +8 -0
  51. package/lib/model/inheritance.js +3 -0
  52. package/lib/model/inheritance.js.map +1 -0
  53. package/lib/model/manifest-diff.d.ts +27 -0
  54. package/lib/model/manifest-diff.js +69 -0
  55. package/lib/model/manifest-diff.js.map +1 -0
  56. package/lib/model/manifest.d.ts +22 -0
  57. package/lib/model/manifest.js +47 -0
  58. package/lib/model/manifest.js.map +1 -0
  59. package/lib/model/markdown-file.d.ts +16 -0
  60. package/lib/model/markdown-file.js +107 -0
  61. package/lib/model/markdown-file.js.map +1 -0
  62. package/lib/model/markdown-generation-util/doc-comment-annotation-util.d.ts +8 -0
  63. package/lib/model/markdown-generation-util/doc-comment-annotation-util.js +44 -0
  64. package/lib/model/markdown-generation-util/doc-comment-annotation-util.js.map +1 -0
  65. package/lib/model/markdown-generation-util/field-declaration-util.d.ts +3 -0
  66. package/lib/model/markdown-generation-util/field-declaration-util.js +55 -0
  67. package/lib/model/markdown-generation-util/field-declaration-util.js.map +1 -0
  68. package/lib/model/markdown-generation-util/index.d.ts +3 -0
  69. package/lib/model/markdown-generation-util/index.js +20 -0
  70. package/lib/model/markdown-generation-util/index.js.map +1 -0
  71. package/lib/model/markdown-generation-util/method-declaration-util.d.ts +4 -0
  72. package/lib/model/markdown-generation-util/method-declaration-util.js +115 -0
  73. package/lib/model/markdown-generation-util/method-declaration-util.js.map +1 -0
  74. package/lib/model/markdown-generation-util/type-declaration-util.d.ts +3 -0
  75. package/lib/model/markdown-generation-util/type-declaration-util.js +82 -0
  76. package/lib/model/markdown-generation-util/type-declaration-util.js.map +1 -0
  77. package/lib/model/markdown-home-file.d.ts +11 -0
  78. package/lib/model/markdown-home-file.js +54 -0
  79. package/lib/model/markdown-home-file.js.map +1 -0
  80. package/lib/model/markdown-type-file.d.ts +26 -0
  81. package/lib/model/markdown-type-file.js +134 -0
  82. package/lib/model/markdown-type-file.js.map +1 -0
  83. package/lib/model/openapi/apex-doc-types.d.ts +19 -0
  84. package/lib/model/openapi/apex-doc-types.js +5 -0
  85. package/lib/model/openapi/apex-doc-types.js.map +1 -0
  86. package/lib/model/openapi/open-api-types.d.ts +93 -0
  87. package/lib/model/openapi/open-api-types.js +3 -0
  88. package/lib/model/openapi/open-api-types.js.map +1 -0
  89. package/lib/model/openapi/open-api.d.ts +16 -0
  90. package/lib/model/openapi/open-api.js +34 -0
  91. package/lib/model/openapi/open-api.js.map +1 -0
  92. package/lib/model/openapi/openapi-type-file.d.ts +7 -0
  93. package/lib/model/openapi/openapi-type-file.js +17 -0
  94. package/lib/model/openapi/openapi-type-file.js.map +1 -0
  95. package/lib/model/outputFile.d.ts +10 -0
  96. package/lib/model/outputFile.js +29 -0
  97. package/lib/model/outputFile.js.map +1 -0
  98. package/lib/model/types-repository.d.ts +16 -0
  99. package/lib/model/types-repository.js +54 -0
  100. package/lib/model/types-repository.js.map +1 -0
  101. package/lib/service/apex-file-reader.d.ts +14 -0
  102. package/lib/service/apex-file-reader.js +46 -0
  103. package/lib/service/apex-file-reader.js.map +1 -0
  104. package/lib/service/file-system.d.ts +14 -0
  105. package/lib/service/file-system.js +25 -0
  106. package/lib/service/file-system.js.map +1 -0
  107. package/lib/service/file-writer.d.ts +6 -0
  108. package/lib/service/file-writer.js +34 -0
  109. package/lib/service/file-writer.js.map +1 -0
  110. package/lib/service/manifest-factory.d.ts +10 -0
  111. package/lib/service/manifest-factory.js +14 -0
  112. package/lib/service/manifest-factory.js.map +1 -0
  113. package/lib/service/metadata-processor.d.ts +3 -0
  114. package/lib/service/metadata-processor.js +17 -0
  115. package/lib/service/metadata-processor.js.map +1 -0
  116. package/lib/service/parser.d.ts +21 -0
  117. package/lib/service/parser.js +135 -0
  118. package/lib/service/parser.js.map +1 -0
  119. package/lib/service/state.d.ts +9 -0
  120. package/lib/service/state.js +20 -0
  121. package/lib/service/state.js.map +1 -0
  122. package/lib/service/walkers/class-walker.d.ts +4 -0
  123. package/lib/service/walkers/class-walker.js +33 -0
  124. package/lib/service/walkers/class-walker.js.map +1 -0
  125. package/lib/service/walkers/enum-walker.d.ts +4 -0
  126. package/lib/service/walkers/enum-walker.js +11 -0
  127. package/lib/service/walkers/enum-walker.js.map +1 -0
  128. package/lib/service/walkers/interface-walker.d.ts +4 -0
  129. package/lib/service/walkers/interface-walker.js +15 -0
  130. package/lib/service/walkers/interface-walker.js.map +1 -0
  131. package/lib/service/walkers/walker-factory.d.ts +5 -0
  132. package/lib/service/walkers/walker-factory.js +21 -0
  133. package/lib/service/walkers/walker-factory.js.map +1 -0
  134. package/lib/service/walkers/walker.d.ts +19 -0
  135. package/lib/service/walkers/walker.js +17 -0
  136. package/lib/service/walkers/walker.js.map +1 -0
  137. package/lib/settings.d.ts +64 -0
  138. package/lib/settings.js +89 -0
  139. package/lib/settings.js.map +1 -0
  140. package/lib/test-helpers/AnnotationBuilder.d.ts +12 -0
  141. package/lib/test-helpers/AnnotationBuilder.js +31 -0
  142. package/lib/test-helpers/AnnotationBuilder.js.map +1 -0
  143. package/lib/test-helpers/ClassMirrorBuilder.d.ts +18 -0
  144. package/lib/test-helpers/ClassMirrorBuilder.js +54 -0
  145. package/lib/test-helpers/ClassMirrorBuilder.js.map +1 -0
  146. package/lib/test-helpers/DocCommentAnnotationBuilder.d.ts +8 -0
  147. package/lib/test-helpers/DocCommentAnnotationBuilder.js +26 -0
  148. package/lib/test-helpers/DocCommentAnnotationBuilder.js.map +1 -0
  149. package/lib/test-helpers/DocCommentBuilder.d.ts +12 -0
  150. package/lib/test-helpers/DocCommentBuilder.js +38 -0
  151. package/lib/test-helpers/DocCommentBuilder.js.map +1 -0
  152. package/lib/test-helpers/FieldMirrorBuilder.d.ts +18 -0
  153. package/lib/test-helpers/FieldMirrorBuilder.js +54 -0
  154. package/lib/test-helpers/FieldMirrorBuilder.js.map +1 -0
  155. package/lib/test-helpers/MethodMirrorBuilder.d.ts +10 -0
  156. package/lib/test-helpers/MethodMirrorBuilder.js +37 -0
  157. package/lib/test-helpers/MethodMirrorBuilder.js.map +1 -0
  158. package/lib/test-helpers/SettingsBuilder.d.ts +8 -0
  159. package/lib/test-helpers/SettingsBuilder.js +27 -0
  160. package/lib/test-helpers/SettingsBuilder.js.map +1 -0
  161. package/lib/transpiler/factory.d.ts +6 -0
  162. package/lib/transpiler/factory.js +32 -0
  163. package/lib/transpiler/factory.js.map +1 -0
  164. package/lib/transpiler/file-container.d.ts +6 -0
  165. package/lib/transpiler/file-container.js +16 -0
  166. package/lib/transpiler/file-container.js.map +1 -0
  167. package/lib/transpiler/generator-choices.d.ts +1 -0
  168. package/lib/transpiler/generator-choices.js +3 -0
  169. package/lib/transpiler/generator-choices.js.map +1 -0
  170. package/lib/transpiler/markdown/class-file-generatorHelper.d.ts +8 -0
  171. package/lib/transpiler/markdown/class-file-generatorHelper.js +56 -0
  172. package/lib/transpiler/markdown/class-file-generatorHelper.js.map +1 -0
  173. package/lib/transpiler/markdown/docsify/docsify-docs-processor.d.ts +6 -0
  174. package/lib/transpiler/markdown/docsify/docsify-docs-processor.js +13 -0
  175. package/lib/transpiler/markdown/docsify/docsify-docs-processor.js.map +1 -0
  176. package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.d.ts +11 -0
  177. package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.js +51 -0
  178. package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.js.map +1 -0
  179. package/lib/transpiler/markdown/markdown-transpiler-base.d.ts +11 -0
  180. package/lib/transpiler/markdown/markdown-transpiler-base.js +24 -0
  181. package/lib/transpiler/markdown/markdown-transpiler-base.js.map +1 -0
  182. package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.d.ts +6 -0
  183. package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.js +14 -0
  184. package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.js.map +1 -0
  185. package/lib/transpiler/openapi/open-api-docs-processor.d.ts +13 -0
  186. package/lib/transpiler/openapi/open-api-docs-processor.js +75 -0
  187. package/lib/transpiler/openapi/open-api-docs-processor.js.map +1 -0
  188. package/lib/transpiler/openapi/parsers/Builder.d.ts +16 -0
  189. package/lib/transpiler/openapi/parsers/Builder.js +30 -0
  190. package/lib/transpiler/openapi/parsers/Builder.js.map +1 -0
  191. package/lib/transpiler/openapi/parsers/MethodParser.d.ts +20 -0
  192. package/lib/transpiler/openapi/parsers/MethodParser.js +167 -0
  193. package/lib/transpiler/openapi/parsers/MethodParser.js.map +1 -0
  194. package/lib/transpiler/openapi/parsers/ParameterObjectBuilder.d.ts +7 -0
  195. package/lib/transpiler/openapi/parsers/ParameterObjectBuilder.js +11 -0
  196. package/lib/transpiler/openapi/parsers/ParameterObjectBuilder.js.map +1 -0
  197. package/lib/transpiler/openapi/parsers/ReferenceBuilder.d.ts +39 -0
  198. package/lib/transpiler/openapi/parsers/ReferenceBuilder.js +226 -0
  199. package/lib/transpiler/openapi/parsers/ReferenceBuilder.js.map +1 -0
  200. package/lib/transpiler/openapi/parsers/RequestBodyBuilder.d.ts +10 -0
  201. package/lib/transpiler/openapi/parsers/RequestBodyBuilder.js +20 -0
  202. package/lib/transpiler/openapi/parsers/RequestBodyBuilder.js.map +1 -0
  203. package/lib/transpiler/openapi/parsers/ResponsesBuilder.d.ts +7 -0
  204. package/lib/transpiler/openapi/parsers/ResponsesBuilder.js +22 -0
  205. package/lib/transpiler/openapi/parsers/ResponsesBuilder.js.map +1 -0
  206. package/lib/transpiler/processor-type-transpiler.d.ts +10 -0
  207. package/lib/transpiler/processor-type-transpiler.js +9 -0
  208. package/lib/transpiler/processor-type-transpiler.js.map +1 -0
  209. package/lib/transpiler/transpiler.d.ts +5 -0
  210. package/lib/transpiler/transpiler.js +27 -0
  211. package/lib/transpiler/transpiler.js.map +1 -0
  212. package/lib/util/error-logger.d.ts +8 -0
  213. package/lib/util/error-logger.js +90 -0
  214. package/lib/util/error-logger.js.map +1 -0
  215. package/lib/util/logger.d.ts +21 -0
  216. package/lib/util/logger.js +58 -0
  217. package/lib/util/logger.js.map +1 -0
  218. package/lib/util/string-utils.d.ts +2 -0
  219. package/lib/util/string-utils.js +15 -0
  220. package/lib/util/string-utils.js.map +1 -0
  221. package/package.json +36 -35
  222. package/src/application/Apexdocs.ts +70 -17
  223. package/src/cli/generate.ts +131 -10
  224. package/src/index.ts +1 -35
  225. package/src/model/__tests__/manifest-diff.spec.ts +147 -0
  226. package/src/model/apex-bundle.ts +3 -0
  227. package/src/{core/openapi → model}/apex-type-wrappers/__tests__/ClassMirrorWrapper.spec.ts +3 -3
  228. package/src/model/inheritance.ts +7 -0
  229. package/src/model/manifest-diff.ts +94 -0
  230. package/src/model/manifest.ts +74 -0
  231. package/src/model/markdown-file.ts +121 -0
  232. package/src/model/markdown-generation-util/doc-comment-annotation-util.ts +50 -0
  233. package/src/model/markdown-generation-util/field-declaration-util.ts +71 -0
  234. package/src/model/markdown-generation-util/index.ts +3 -0
  235. package/src/model/markdown-generation-util/method-declaration-util.ts +166 -0
  236. package/src/model/markdown-generation-util/type-declaration-util.ts +91 -0
  237. package/src/model/markdown-home-file.ts +58 -0
  238. package/src/model/markdown-type-file.ts +165 -0
  239. package/src/{core → model}/openapi/open-api-types.ts +2 -2
  240. package/src/model/openapi/openapi-type-file.ts +14 -0
  241. package/src/model/outputFile.ts +29 -0
  242. package/src/{core/openapi → model}/types-repository.ts +9 -0
  243. package/src/service/__tests__/apex-file-reader.spec.ts +92 -0
  244. package/src/{core/openapi → service}/__tests__/manifest-factory.spec.ts +2 -1
  245. package/src/service/apex-file-reader.ts +51 -0
  246. package/src/service/file-writer.ts +34 -0
  247. package/src/{core/openapi → service}/manifest-factory.ts +3 -3
  248. package/src/service/metadata-processor.ts +16 -0
  249. package/src/{core/openapi → service}/parser.ts +9 -9
  250. package/src/service/state.ts +24 -0
  251. package/src/service/walkers/class-walker.ts +30 -0
  252. package/src/service/walkers/enum-walker.ts +7 -0
  253. package/src/service/walkers/interface-walker.ts +12 -0
  254. package/src/service/walkers/walker-factory.ts +19 -0
  255. package/src/service/walkers/walker.ts +42 -0
  256. package/src/settings.ts +147 -0
  257. package/src/test-helpers/ClassMirrorBuilder.ts +1 -14
  258. package/src/test-helpers/FieldMirrorBuilder.ts +1 -1
  259. package/src/test-helpers/MethodMirrorBuilder.ts +6 -46
  260. package/src/test-helpers/SettingsBuilder.ts +4 -1
  261. package/src/transpiler/factory.ts +33 -0
  262. package/src/transpiler/file-container.ts +13 -0
  263. package/src/transpiler/generator-choices.ts +1 -0
  264. package/src/transpiler/markdown/class-file-generatorHelper.ts +58 -0
  265. package/src/transpiler/markdown/docsify/docsify-docs-processor.ts +12 -0
  266. package/src/transpiler/markdown/jekyll/jekyll-docsProcessor.ts +50 -0
  267. package/src/transpiler/markdown/markdown-transpiler-base.ts +28 -0
  268. package/src/transpiler/markdown/plain-markdown/plain-docsProcessor.ts +12 -0
  269. package/src/{core → transpiler}/openapi/__tests__/open-api-docs-processor.spec.ts +1 -1
  270. package/src/{core → transpiler}/openapi/open-api-docs-processor.ts +10 -9
  271. package/src/{core → transpiler}/openapi/parsers/Builder.ts +3 -3
  272. package/src/{core → transpiler}/openapi/parsers/MethodParser.ts +6 -6
  273. package/src/{core → transpiler}/openapi/parsers/ParameterObjectBuilder.ts +2 -2
  274. package/src/{core → transpiler}/openapi/parsers/ReferenceBuilder.ts +6 -7
  275. package/src/{core → transpiler}/openapi/parsers/RequestBodyBuilder.ts +2 -2
  276. package/src/{core → transpiler}/openapi/parsers/ResponsesBuilder.ts +2 -2
  277. package/src/{core → transpiler}/openapi/parsers/__tests__/MethodParser.spec.ts +1 -1
  278. package/src/{core → transpiler}/openapi/parsers/__tests__/ParameterObjectBuilder.spec.ts +2 -2
  279. package/src/{core → transpiler}/openapi/parsers/__tests__/ReferenceBuilder.spec.ts +2 -2
  280. package/src/{core → transpiler}/openapi/parsers/__tests__/RequestBodyBuilder.spec.ts +2 -2
  281. package/src/{core → transpiler}/openapi/parsers/__tests__/ResponsesBuilder.spec.ts +1 -1
  282. package/src/transpiler/processor-type-transpiler.ts +18 -0
  283. package/src/{core/openapi → transpiler}/transpiler.ts +6 -2
  284. package/src/util/error-logger.ts +4 -4
  285. package/src/util/logger.ts +6 -6
  286. package/src/util/string-utils.ts +4 -0
  287. package/tsconfig.json +3 -8
  288. package/.github/workflows/ci.yaml +0 -22
  289. package/__mocks__/chalk.js +0 -12
  290. package/__mocks__/log-update.js +0 -6
  291. package/dist/cli/generate.js +0 -2976
  292. package/dist/defaults-DUwru49Q.js +0 -12
  293. package/dist/defaults-SH0Rsi5E.js +0 -11
  294. package/dist/index.d.ts +0 -62
  295. package/dist/index.js +0 -36
  296. package/eslint.config.mjs +0 -10
  297. package/examples/plain-markdown/.forceignore +0 -12
  298. package/examples/plain-markdown/config/project-scratch-def.json +0 -5
  299. package/examples/plain-markdown/docs/Miscellaneous/ns.BaseClass.md +0 -16
  300. package/examples/plain-markdown/docs/Miscellaneous/ns.MultiInheritanceClass.md +0 -73
  301. package/examples/plain-markdown/docs/Miscellaneous/ns.ParentInterface.md +0 -15
  302. package/examples/plain-markdown/docs/Miscellaneous/ns.ReferencedEnum.md +0 -8
  303. package/examples/plain-markdown/docs/Miscellaneous/ns.SampleException.md +0 -25
  304. package/examples/plain-markdown/docs/Miscellaneous/ns.SampleInterface.md +0 -119
  305. package/examples/plain-markdown/docs/Miscellaneous/ns.Url.md +0 -320
  306. package/examples/plain-markdown/docs/Sample-Enums/ns.SampleEnum.md +0 -38
  307. package/examples/plain-markdown/docs/SampleGroup/ns.SampleClass.md +0 -173
  308. package/examples/plain-markdown/docs/index.md +0 -117
  309. package/examples/plain-markdown/force-app/classes/BaseClass.cls +0 -3
  310. package/examples/plain-markdown/force-app/classes/MultiInheritanceClass.cls +0 -1
  311. package/examples/plain-markdown/force-app/classes/ParentInterface.cls +0 -3
  312. package/examples/plain-markdown/force-app/classes/ReferencedEnum.cls +0 -3
  313. package/examples/plain-markdown/force-app/classes/SampleClass.cls +0 -72
  314. package/examples/plain-markdown/force-app/classes/SampleEnum.cls +0 -30
  315. package/examples/plain-markdown/force-app/classes/SampleException.cls +0 -17
  316. package/examples/plain-markdown/force-app/classes/SampleInterface.cls +0 -46
  317. package/examples/plain-markdown/force-app/classes/Url.cls +0 -194
  318. package/examples/plain-markdown/package-lock.json +0 -665
  319. package/examples/plain-markdown/package.json +0 -20
  320. package/examples/plain-markdown/sfdx-project.json +0 -12
  321. package/examples/vitepress/.forceignore +0 -12
  322. package/examples/vitepress/apexdocs.config.ts +0 -108
  323. package/examples/vitepress/config/project-scratch-def.json +0 -13
  324. package/examples/vitepress/docs/.vitepress/cache/deps/@theme_index.js +0 -259
  325. package/examples/vitepress/docs/.vitepress/cache/deps/@theme_index.js.map +0 -7
  326. package/examples/vitepress/docs/.vitepress/cache/deps/_metadata.json +0 -40
  327. package/examples/vitepress/docs/.vitepress/cache/deps/chunk-574YRH25.js +0 -11474
  328. package/examples/vitepress/docs/.vitepress/cache/deps/chunk-574YRH25.js.map +0 -7
  329. package/examples/vitepress/docs/.vitepress/cache/deps/chunk-E5DZZB2I.js +0 -9172
  330. package/examples/vitepress/docs/.vitepress/cache/deps/chunk-E5DZZB2I.js.map +0 -7
  331. package/examples/vitepress/docs/.vitepress/cache/deps/package.json +0 -3
  332. package/examples/vitepress/docs/.vitepress/cache/deps/vitepress___@vue_devtools-api.js +0 -4339
  333. package/examples/vitepress/docs/.vitepress/cache/deps/vitepress___@vue_devtools-api.js.map +0 -7
  334. package/examples/vitepress/docs/.vitepress/cache/deps/vitepress___@vueuse_core.js +0 -567
  335. package/examples/vitepress/docs/.vitepress/cache/deps/vitepress___@vueuse_core.js.map +0 -7
  336. package/examples/vitepress/docs/.vitepress/cache/deps/vue.js +0 -323
  337. package/examples/vitepress/docs/.vitepress/cache/deps/vue.js.map +0 -7
  338. package/examples/vitepress/docs/.vitepress/config.mts +0 -21
  339. package/examples/vitepress/docs/.vitepress/sidebar.json +0 -119
  340. package/examples/vitepress/docs/Miscellaneous/apexdocs.BaseClass.md +0 -20
  341. package/examples/vitepress/docs/Miscellaneous/apexdocs.MultiInheritanceClass.md +0 -76
  342. package/examples/vitepress/docs/Miscellaneous/apexdocs.ParentInterface.md +0 -19
  343. package/examples/vitepress/docs/Miscellaneous/apexdocs.ReferencedEnum.md +0 -15
  344. package/examples/vitepress/docs/Miscellaneous/apexdocs.SampleException.md +0 -28
  345. package/examples/vitepress/docs/Miscellaneous/apexdocs.SampleInterface.md +0 -116
  346. package/examples/vitepress/docs/Miscellaneous/apexdocs.Url.md +0 -317
  347. package/examples/vitepress/docs/Sample-Enums/apexdocs.SampleEnum.md +0 -40
  348. package/examples/vitepress/docs/SampleGroup/apexdocs.SampleClass.md +0 -174
  349. package/examples/vitepress/docs/api-examples.md +0 -49
  350. package/examples/vitepress/docs/index-frontmatter.md +0 -16
  351. package/examples/vitepress/docs/index.md +0 -56
  352. package/examples/vitepress/docs/markdown-examples.md +0 -85
  353. package/examples/vitepress/force-app/main/default/classes/BaseClass.cls +0 -3
  354. package/examples/vitepress/force-app/main/default/classes/MultiInheritanceClass.cls +0 -1
  355. package/examples/vitepress/force-app/main/default/classes/ParentInterface.cls +0 -3
  356. package/examples/vitepress/force-app/main/default/classes/ReferencedEnum.cls +0 -5
  357. package/examples/vitepress/force-app/main/default/classes/SampleClass.cls +0 -72
  358. package/examples/vitepress/force-app/main/default/classes/SampleEnum.cls +0 -30
  359. package/examples/vitepress/force-app/main/default/classes/SampleException.cls +0 -17
  360. package/examples/vitepress/force-app/main/default/classes/SampleInterface.cls +0 -46
  361. package/examples/vitepress/force-app/main/default/classes/Url.cls +0 -198
  362. package/examples/vitepress/package-lock.json +0 -2574
  363. package/examples/vitepress/package.json +0 -18
  364. package/examples/vitepress/sfdx-project.json +0 -12
  365. package/jest.d.ts +0 -7
  366. package/src/application/__tests__/apex-file-reader.spec.ts +0 -104
  367. package/src/application/apex-file-reader.ts +0 -42
  368. package/src/application/file-writer.ts +0 -25
  369. package/src/application/generators/markdown.ts +0 -53
  370. package/src/application/generators/openapi.ts +0 -56
  371. package/src/cli/args.ts +0 -43
  372. package/src/cli/commands/markdown.ts +0 -58
  373. package/src/core/manifest.ts +0 -90
  374. package/src/core/markdown/__test__/expect-extensions.ts +0 -32
  375. package/src/core/markdown/__test__/generating-class-docs.spec.ts +0 -733
  376. package/src/core/markdown/__test__/generating-enum-docs.spec.ts +0 -385
  377. package/src/core/markdown/__test__/generating-interface-docs.spec.ts +0 -459
  378. package/src/core/markdown/__test__/generating-reference-guide.spec.ts +0 -184
  379. package/src/core/markdown/__test__/inheritance-chain.test.ts +0 -54
  380. package/src/core/markdown/__test__/test-helpers.ts +0 -22
  381. package/src/core/markdown/adapters/__tests__/documentables.spec.ts +0 -109
  382. package/src/core/markdown/adapters/__tests__/interface-adapter.spec.ts +0 -112
  383. package/src/core/markdown/adapters/__tests__/references.spec.ts +0 -136
  384. package/src/core/markdown/adapters/apex-types.ts +0 -237
  385. package/src/core/markdown/adapters/documentables.ts +0 -116
  386. package/src/core/markdown/adapters/fields-and-properties.ts +0 -45
  387. package/src/core/markdown/adapters/inline.ts +0 -143
  388. package/src/core/markdown/adapters/methods-and-constructors.ts +0 -133
  389. package/src/core/markdown/adapters/renderable-bundle.ts +0 -144
  390. package/src/core/markdown/adapters/renderable-to-page-data.ts +0 -92
  391. package/src/core/markdown/adapters/type-utils.ts +0 -13
  392. package/src/core/markdown/adapters/types.d.ts +0 -182
  393. package/src/core/markdown/generate-docs.ts +0 -158
  394. package/src/core/markdown/reflection/error-handling.ts +0 -37
  395. package/src/core/markdown/reflection/filter-scope.ts +0 -13
  396. package/src/core/markdown/reflection/inheritance-chain-expanion.ts +0 -22
  397. package/src/core/markdown/reflection/inheritance-chain.ts +0 -23
  398. package/src/core/markdown/reflection/inherited-member-expansion.ts +0 -105
  399. package/src/core/markdown/reflection/reflect-source.ts +0 -41
  400. package/src/core/markdown/reflection/sort-members.ts +0 -59
  401. package/src/core/markdown/templates/class-template.ts +0 -75
  402. package/src/core/markdown/templates/constructors-partial-template.ts +0 -32
  403. package/src/core/markdown/templates/documentable-partial-template.ts +0 -26
  404. package/src/core/markdown/templates/enum-template.ts +0 -12
  405. package/src/core/markdown/templates/fieldsPartialTemplate.ts +0 -23
  406. package/src/core/markdown/templates/grouped-members-partial-template.ts +0 -6
  407. package/src/core/markdown/templates/hookable.ts +0 -7
  408. package/src/core/markdown/templates/interface-template.ts +0 -16
  409. package/src/core/markdown/templates/methods-partial-template.ts +0 -43
  410. package/src/core/markdown/templates/reference-guide.ts +0 -14
  411. package/src/core/markdown/templates/template.ts +0 -114
  412. package/src/core/markdown/templates/type-doc-partial.ts +0 -27
  413. package/src/core/markdown/utils.ts +0 -3
  414. package/src/core/openapi/file-container.ts +0 -13
  415. package/src/core/openapi/openapi-type-file.ts +0 -14
  416. package/src/core/parse-apex-metadata.ts +0 -14
  417. package/src/core/settings.ts +0 -56
  418. package/src/core/shared/types.d.ts +0 -92
  419. package/src/core/shared/utils.ts +0 -5
  420. package/src/defaults.ts +0 -8
  421. package/src/test-helpers/InterfaceMirrorBuilder.ts +0 -39
  422. package/src/util/fp.ts +0 -3
  423. /package/src/{core/__test__ → model/__tests__}/manifest.spec.ts +0 -0
  424. /package/src/{core/openapi → model}/apex-type-wrappers/ClassMirrorWrapper.ts +0 -0
  425. /package/src/{core/openapi → model}/apex-type-wrappers/MethodMirrorWrapper.ts +0 -0
  426. /package/src/{core → model}/openapi/__tests__/open-api.spec.ts +0 -0
  427. /package/src/{core → model}/openapi/apex-doc-types.ts +0 -0
  428. /package/src/{core → model}/openapi/open-api.ts +0 -0
  429. /package/src/{application → service}/file-system.ts +0 -0
@@ -1,2976 +0,0 @@
1
- #!/usr/bin/env node
2
- 'use strict';
3
-
4
- var _function = require('fp-ts/function');
5
- var E = require('fp-ts/Either');
6
- var TE = require('fp-ts/TaskEither');
7
- var yaml = require('js-yaml');
8
- var apexReflection = require('@cparra/apex-reflection');
9
- var O = require('fp-ts/Option');
10
- var fastXmlParser = require('fast-xml-parser');
11
- var Handlebars = require('handlebars');
12
- var fs = require('fs');
13
- var path = require('path');
14
- var chalk = require('chalk');
15
- var logUpdate = require('log-update');
16
- var cosmiconfig = require('cosmiconfig');
17
- var yargs = require('yargs');
18
- var cosmiconfigTypescriptLoader = require('cosmiconfig-typescript-loader');
19
- var defaults = require('../defaults-DUwru49Q.js');
20
-
21
- function _interopNamespaceDefault(e) {
22
- var n = Object.create(null);
23
- if (e) {
24
- Object.keys(e).forEach(function (k) {
25
- if (k !== 'default') {
26
- var d = Object.getOwnPropertyDescriptor(e, k);
27
- Object.defineProperty(n, k, d.get ? d : {
28
- enumerable: true,
29
- get: function () { return e[k]; }
30
- });
31
- }
32
- });
33
- }
34
- n.default = e;
35
- return Object.freeze(n);
36
- }
37
-
38
- var E__namespace = /*#__PURE__*/_interopNamespaceDefault(E);
39
- var TE__namespace = /*#__PURE__*/_interopNamespaceDefault(TE);
40
- var yaml__namespace = /*#__PURE__*/_interopNamespaceDefault(yaml);
41
- var O__namespace = /*#__PURE__*/_interopNamespaceDefault(O);
42
- var fs__namespace = /*#__PURE__*/_interopNamespaceDefault(fs);
43
- var path__namespace = /*#__PURE__*/_interopNamespaceDefault(path);
44
- var yargs__namespace = /*#__PURE__*/_interopNamespaceDefault(yargs);
45
-
46
- function apply(fn, ...front) {
47
- return (...tailArgs) => fn(...front, ...tailArgs);
48
- }
49
-
50
- function defaultGetEmailByReference(email) {
51
- return {
52
- __type: "link",
53
- title: email,
54
- url: `mailto:${email}`
55
- };
56
- }
57
- function replaceInlineReferences(text, linkReplacer, emailReplacer = defaultGetEmailByReference) {
58
- const inlineLinks = apply(replaceInlineLinks, linkReplacer);
59
- const inlineEmails = apply(replaceInlineEmails, emailReplacer);
60
- return _function.pipe(inlineCode$1([text]), inlineLinks, inlineEmails);
61
- }
62
- function inlineCode$1(renderableContents) {
63
- return renderableContents.flatMap((renderableContent) => inlineCodeContent(renderableContent));
64
- }
65
- function inlineCodeContent(renderableContent) {
66
- if (typeof renderableContent !== "string") {
67
- return [renderableContent];
68
- }
69
- function inlineCodeLink(text2) {
70
- return {
71
- __type: "inline-code",
72
- content: text2
73
- };
74
- }
75
- const text = renderableContent;
76
- const codeFormatRegEx = "`([^`]*)`";
77
- const matches = match(codeFormatRegEx, text);
78
- return createRenderableContents(matches, text, inlineCodeLink);
79
- }
80
- function replaceInlineLinks(getLinkByTypeName, renderableContents) {
81
- return renderableContents.flatMap((renderableContent) => inlineLinkContent(renderableContent, getLinkByTypeName));
82
- }
83
- function inlineLinkContent(renderableContent, getLinkByTypeName) {
84
- if (typeof renderableContent !== "string") {
85
- return [renderableContent];
86
- }
87
- const text = renderableContent;
88
- const linkFormatRegEx = "{@link (.*?)}|<<([^>]+)>>";
89
- const matches = match(linkFormatRegEx, text);
90
- return createRenderableContents(matches, text, getLinkByTypeName);
91
- }
92
- function replaceInlineEmails(getLinkByTypeName, renderableContents) {
93
- return renderableContents.flatMap((renderableContent) => inlineEmailContent(renderableContent, getLinkByTypeName));
94
- }
95
- function inlineEmailContent(renderableContent, getLinkByTypeName) {
96
- if (typeof renderableContent !== "string") {
97
- return [renderableContent];
98
- }
99
- const text = renderableContent;
100
- const linkFormatRegEx = "{@email (.*?)}";
101
- const matches = match(linkFormatRegEx, text);
102
- return createRenderableContents(matches, text, getLinkByTypeName);
103
- }
104
- function match(regex, text) {
105
- const expression = new RegExp(regex, "gi");
106
- let match2;
107
- const matches = [];
108
- do {
109
- match2 = expression.exec(text);
110
- if (match2) {
111
- matches.push(match2);
112
- }
113
- } while (match2);
114
- return matches;
115
- }
116
- function createRenderableContents(matches, text, linker) {
117
- if (matches.length === 0) {
118
- return [text];
119
- }
120
- const result = [];
121
- let lastIndex = 0;
122
- for (const match2 of matches) {
123
- const index = match2.index;
124
- const length = match2[0].length;
125
- const capturedGroup = match2.slice(1).find((group) => group);
126
- if (!capturedGroup) {
127
- continue;
128
- }
129
- result.push(text.slice(lastIndex, index));
130
- result.push(linker(capturedGroup));
131
- lastIndex = index + length;
132
- }
133
- if (lastIndex < text.length) {
134
- result.push(text.slice(lastIndex));
135
- }
136
- return result;
137
- }
138
-
139
- function isEmptyLine(content) {
140
- return Object.keys(content).includes("__type") && content.__type === "empty-line";
141
- }
142
- function isCodeBlock(content) {
143
- return Object.keys(content).includes("__type") && content.__type === "code-block";
144
- }
145
- function isInlineCode(content) {
146
- return Object.keys(content).includes("__type") && content.__type === "inline-code";
147
- }
148
-
149
- var __defProp$f = Object.defineProperty;
150
- var __defProps$f = Object.defineProperties;
151
- var __getOwnPropDescs$f = Object.getOwnPropertyDescriptors;
152
- var __getOwnPropSymbols$f = Object.getOwnPropertySymbols;
153
- var __hasOwnProp$f = Object.prototype.hasOwnProperty;
154
- var __propIsEnum$f = Object.prototype.propertyIsEnumerable;
155
- var __defNormalProp$f = (obj, key, value) => key in obj ? __defProp$f(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
156
- var __spreadValues$f = (a, b) => {
157
- for (var prop in b || (b = {}))
158
- if (__hasOwnProp$f.call(b, prop))
159
- __defNormalProp$f(a, prop, b[prop]);
160
- if (__getOwnPropSymbols$f)
161
- for (var prop of __getOwnPropSymbols$f(b)) {
162
- if (__propIsEnum$f.call(b, prop))
163
- __defNormalProp$f(a, prop, b[prop]);
164
- }
165
- return a;
166
- };
167
- var __spreadProps$f = (a, b) => __defProps$f(a, __getOwnPropDescs$f(b));
168
- function adaptDescribable(describable, linkGenerator) {
169
- return {
170
- description: describableToRenderableContent(describable, linkGenerator)
171
- };
172
- }
173
- function describableToRenderableContent(describable, linkGenerator) {
174
- if (!describable) {
175
- return;
176
- }
177
- let content = [];
178
- for (let i = 0; i < describable.length; i++) {
179
- const line = describable[i];
180
- const codeBlockMatch = line.match(/^```([a-zA-Z]*)$/);
181
- if (codeBlockMatch) {
182
- const language = codeBlockMatch[1] || "apex";
183
- const codeBlockLines = [];
184
- i++;
185
- while (i < describable.length) {
186
- const currentLine = describable[i];
187
- if (currentLine.trim() === "```") {
188
- break;
189
- }
190
- codeBlockLines.push(currentLine);
191
- i++;
192
- }
193
- content = [
194
- ...content,
195
- {
196
- __type: "code-block",
197
- language,
198
- content: codeBlockLines
199
- },
200
- { __type: "empty-line" }
201
- ];
202
- continue;
203
- }
204
- content = [
205
- ...content,
206
- ...replaceInlineReferences(line, linkGenerator),
207
- {
208
- __type: "empty-line"
209
- }
210
- ];
211
- }
212
- return content.filter((line, index, lines) => !(isEmptyLine(line) && index === lines.length - 1));
213
- }
214
- function adaptDocumentable(documentable, linkGenerator, subHeadingLevel) {
215
- var _a, _b, _c;
216
- function extractCustomTags(type) {
217
- var _a2, _b2;
218
- const baseTags = ["description", "group", "author", "date", "see", "example", "throws", "exception"];
219
- return (_b2 = (_a2 = type.docComment) == null ? void 0 : _a2.annotations.filter((currentAnnotation) => !baseTags.includes(currentAnnotation.name.toLowerCase())).map((currentAnnotation) => __spreadProps$f(__spreadValues$f({}, adaptDescribable(currentAnnotation.bodyLines, linkGenerator)), {
220
- name: currentAnnotation.name
221
- }))) != null ? _b2 : [];
222
- }
223
- function extractAnnotationBody(type, annotationName) {
224
- var _a2, _b2;
225
- return (_b2 = (_a2 = type.docComment) == null ? void 0 : _a2.annotations.find(
226
- (currentAnnotation) => currentAnnotation.name.toLowerCase() === annotationName
227
- )) == null ? void 0 : _b2.body;
228
- }
229
- function extractSeeAnnotations(type) {
230
- var _a2, _b2;
231
- return (_b2 = (_a2 = type.docComment) == null ? void 0 : _a2.annotations.filter((currentAnnotation) => currentAnnotation.name.toLowerCase() === "see").map((currentAnnotation) => currentAnnotation.body)) != null ? _b2 : [];
232
- }
233
- return __spreadProps$f(__spreadValues$f({}, adaptDescribable((_a = documentable.docComment) == null ? void 0 : _a.descriptionLines, linkGenerator)), {
234
- annotations: documentable.annotations.map((annotation) => annotation.type.toUpperCase()),
235
- customTags: extractCustomTags(documentable),
236
- example: {
237
- headingLevel: subHeadingLevel,
238
- heading: "Example",
239
- value: describableToRenderableContent((_c = (_b = documentable.docComment) == null ? void 0 : _b.exampleAnnotation) == null ? void 0 : _c.bodyLines, linkGenerator)
240
- },
241
- group: extractAnnotationBody(documentable, "group"),
242
- author: extractAnnotationBody(documentable, "author"),
243
- date: extractAnnotationBody(documentable, "date"),
244
- sees: extractSeeAnnotations(documentable).map(linkGenerator)
245
- });
246
- }
247
-
248
- var __defProp$e = Object.defineProperty;
249
- var __defProps$e = Object.defineProperties;
250
- var __getOwnPropDescs$e = Object.getOwnPropertyDescriptors;
251
- var __getOwnPropSymbols$e = Object.getOwnPropertySymbols;
252
- var __hasOwnProp$e = Object.prototype.hasOwnProperty;
253
- var __propIsEnum$e = Object.prototype.propertyIsEnumerable;
254
- var __defNormalProp$e = (obj, key, value) => key in obj ? __defProp$e(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
255
- var __spreadValues$e = (a, b) => {
256
- for (var prop in b || (b = {}))
257
- if (__hasOwnProp$e.call(b, prop))
258
- __defNormalProp$e(a, prop, b[prop]);
259
- if (__getOwnPropSymbols$e)
260
- for (var prop of __getOwnPropSymbols$e(b)) {
261
- if (__propIsEnum$e.call(b, prop))
262
- __defNormalProp$e(a, prop, b[prop]);
263
- }
264
- return a;
265
- };
266
- var __spreadProps$e = (a, b) => __defProps$e(a, __getOwnPropDescs$e(b));
267
- function adaptMethod(method, linkGenerator, baseHeadingLevel) {
268
- var _a, _b, _c;
269
- function buildTitle(method2) {
270
- const { name, parameters } = method2;
271
- const parametersString = parameters.map((param) => param.name).join(", ");
272
- return `${name}(${parametersString})`;
273
- }
274
- function buildSignature(method2) {
275
- const { access_modifier, typeReference, name, memberModifiers } = method2;
276
- const parameters = method2.parameters.map((param) => `${param.typeReference.rawDeclaration} ${param.name}`).join(", ");
277
- const members = memberModifiers.length > 0 ? `${memberModifiers.join(" ")} ` : "";
278
- return {
279
- __type: "code-block",
280
- language: "apex",
281
- content: [`${access_modifier} ${members}${typeReference.rawDeclaration} ${name}(${parameters})`]
282
- };
283
- }
284
- return {
285
- headingLevel: baseHeadingLevel,
286
- doc: adaptDocumentable(method, linkGenerator, baseHeadingLevel + 1),
287
- heading: buildTitle(method),
288
- signature: {
289
- headingLevel: baseHeadingLevel + 1,
290
- heading: "Signature",
291
- value: buildSignature(method)
292
- },
293
- returnType: {
294
- headingLevel: baseHeadingLevel + 1,
295
- heading: "Return Type",
296
- value: __spreadProps$e(__spreadValues$e({}, adaptDescribable((_b = (_a = method.docComment) == null ? void 0 : _a.returnAnnotation) == null ? void 0 : _b.bodyLines, linkGenerator)), {
297
- type: linkGenerator(method.typeReference.rawDeclaration)
298
- })
299
- },
300
- throws: {
301
- headingLevel: baseHeadingLevel + 1,
302
- heading: "Throws",
303
- value: (_c = method.docComment) == null ? void 0 : _c.throwsAnnotations.map((thrown) => mapThrows(thrown, linkGenerator))
304
- },
305
- parameters: {
306
- headingLevel: baseHeadingLevel + 1,
307
- heading: "Parameters",
308
- value: method.parameters.map((param) => mapParameters(method, param, linkGenerator))
309
- },
310
- inherited: method.inherited
311
- };
312
- }
313
- function adaptConstructor(typeName, constructor, linkGenerator, baseHeadingLevel) {
314
- var _a;
315
- function buildTitle(name, constructor2) {
316
- const { parameters } = constructor2;
317
- const parametersString = parameters.map((param) => param.name).join(", ");
318
- return `${name}(${parametersString})`;
319
- }
320
- function buildSignature(name, constructor2) {
321
- const { access_modifier } = constructor2;
322
- const parameters = constructor2.parameters.map((param) => `${param.typeReference.rawDeclaration} ${param.name}`).join(", ");
323
- return {
324
- __type: "code-block",
325
- language: "apex",
326
- content: [`${access_modifier} ${name}(${parameters})`]
327
- };
328
- }
329
- return {
330
- doc: adaptDocumentable(constructor, linkGenerator, baseHeadingLevel + 1),
331
- headingLevel: baseHeadingLevel,
332
- heading: buildTitle(typeName, constructor),
333
- signature: {
334
- headingLevel: baseHeadingLevel + 1,
335
- heading: "Signature",
336
- value: buildSignature(typeName, constructor)
337
- },
338
- parameters: {
339
- headingLevel: baseHeadingLevel + 1,
340
- heading: "Parameters",
341
- value: constructor.parameters.map((param) => mapParameters(constructor, param, linkGenerator))
342
- },
343
- throws: {
344
- headingLevel: baseHeadingLevel + 1,
345
- heading: "Throws",
346
- value: (_a = constructor.docComment) == null ? void 0 : _a.throwsAnnotations.map((thrown) => mapThrows(thrown, linkGenerator))
347
- }
348
- };
349
- }
350
- function mapParameters(documentable, param, linkGenerator) {
351
- var _a;
352
- const paramAnnotation = (_a = documentable.docComment) == null ? void 0 : _a.paramAnnotations.find(
353
- (pa) => pa.paramName.toLowerCase() === param.name.toLowerCase()
354
- );
355
- return __spreadProps$e(__spreadValues$e({}, adaptDescribable(paramAnnotation == null ? void 0 : paramAnnotation.bodyLines, linkGenerator)), {
356
- name: param.name,
357
- type: linkGenerator(param.typeReference.rawDeclaration)
358
- });
359
- }
360
- function mapThrows(thrown, linkGenerator) {
361
- return __spreadProps$e(__spreadValues$e({}, adaptDescribable(thrown.bodyLines, linkGenerator)), {
362
- type: linkGenerator(thrown.exceptionName)
363
- });
364
- }
365
-
366
- function adaptFieldOrProperty(field, linkGenerator, baseHeadingLevel) {
367
- function buildSignature() {
368
- const { access_modifier, name } = field;
369
- const memberModifiers = field.memberModifiers.join(" ");
370
- const codeContents = `${access_modifier} ${memberModifiers} ${name}`.replace(/ {2}/g, " ");
371
- return {
372
- __type: "code-block",
373
- language: "apex",
374
- content: [codeContents]
375
- };
376
- }
377
- return {
378
- headingLevel: baseHeadingLevel,
379
- doc: adaptDocumentable(field, linkGenerator, baseHeadingLevel + 1),
380
- heading: field.name,
381
- type: {
382
- headingLevel: baseHeadingLevel + 1,
383
- heading: "Type",
384
- value: linkGenerator(field.typeReference.rawDeclaration)
385
- },
386
- inherited: field.inherited,
387
- accessModifier: field.access_modifier,
388
- signature: {
389
- headingLevel: baseHeadingLevel + 1,
390
- heading: "Signature",
391
- value: buildSignature()
392
- }
393
- };
394
- }
395
-
396
- var __defProp$d = Object.defineProperty;
397
- var __defProps$d = Object.defineProperties;
398
- var __getOwnPropDescs$d = Object.getOwnPropertyDescriptors;
399
- var __getOwnPropSymbols$d = Object.getOwnPropertySymbols;
400
- var __hasOwnProp$d = Object.prototype.hasOwnProperty;
401
- var __propIsEnum$d = Object.prototype.propertyIsEnumerable;
402
- var __defNormalProp$d = (obj, key, value) => key in obj ? __defProp$d(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
403
- var __spreadValues$d = (a, b) => {
404
- for (var prop in b || (b = {}))
405
- if (__hasOwnProp$d.call(b, prop))
406
- __defNormalProp$d(a, prop, b[prop]);
407
- if (__getOwnPropSymbols$d)
408
- for (var prop of __getOwnPropSymbols$d(b)) {
409
- if (__propIsEnum$d.call(b, prop))
410
- __defNormalProp$d(a, prop, b[prop]);
411
- }
412
- return a;
413
- };
414
- var __spreadProps$d = (a, b) => __defProps$d(a, __getOwnPropDescs$d(b));
415
- function typeToRenderable(parsedFile, linkGenerator, config) {
416
- function getRenderable() {
417
- const { type } = parsedFile;
418
- switch (type.type_name) {
419
- case "enum":
420
- return enumTypeToEnumSource(type, linkGenerator);
421
- case "interface":
422
- return interfaceTypeToInterfaceSource(type, linkGenerator);
423
- case "class":
424
- return classTypeToClassSource(type, linkGenerator);
425
- }
426
- }
427
- return __spreadProps$d(__spreadValues$d({}, getRenderable()), {
428
- filePath: parsedFile.filePath,
429
- namespace: config.namespace
430
- });
431
- }
432
- function baseTypeAdapter(type, linkGenerator, baseHeadingLevel) {
433
- function getHeading(type2) {
434
- const suffixMap = {
435
- class: "Class",
436
- interface: "Interface",
437
- enum: "Enum"
438
- };
439
- return `${type2.name} ${suffixMap[type2.type_name]}`;
440
- }
441
- return {
442
- headingLevel: baseHeadingLevel,
443
- heading: getHeading(type),
444
- doc: adaptDocumentable(type, linkGenerator, baseHeadingLevel + 1),
445
- name: type.name,
446
- meta: {
447
- accessModifier: type.access_modifier
448
- }
449
- };
450
- }
451
- function enumTypeToEnumSource(enumType, linkGenerator, baseHeadingLevel = 1) {
452
- return __spreadProps$d(__spreadValues$d({
453
- type: "enum"
454
- }, baseTypeAdapter(enumType, linkGenerator, baseHeadingLevel)), {
455
- values: {
456
- headingLevel: baseHeadingLevel + 1,
457
- heading: "Values",
458
- value: enumType.values.map((value) => {
459
- var _a;
460
- return __spreadProps$d(__spreadValues$d({}, adaptDescribable((_a = value.docComment) == null ? void 0 : _a.descriptionLines, linkGenerator)), {
461
- value: value.name
462
- });
463
- })
464
- }
465
- });
466
- }
467
- function interfaceTypeToInterfaceSource(interfaceType, linkGenerator, baseHeadingLevel = 1) {
468
- return __spreadProps$d(__spreadValues$d({
469
- type: "interface"
470
- }, baseTypeAdapter(interfaceType, linkGenerator, baseHeadingLevel)), {
471
- extends: interfaceType.extended_interfaces.map(linkGenerator),
472
- methods: {
473
- headingLevel: baseHeadingLevel + 1,
474
- heading: "Methods",
475
- value: interfaceType.methods.map((method) => adaptMethod(method, linkGenerator, baseHeadingLevel + 2))
476
- }
477
- });
478
- }
479
- function classTypeToClassSource(classType, linkGenerator, baseHeadingLevel = 1) {
480
- return __spreadProps$d(__spreadValues$d({
481
- type: "class"
482
- }, baseTypeAdapter(classType, linkGenerator, baseHeadingLevel)), {
483
- classModifier: classType.classModifier,
484
- sharingModifier: classType.sharingModifier,
485
- implements: classType.implemented_interfaces.map(linkGenerator),
486
- extends: classType.inheritanceChain.map(linkGenerator),
487
- methods: adaptMembers("Methods", classType.methods, adaptMethod, linkGenerator, baseHeadingLevel + 1),
488
- constructors: adaptMembers(
489
- "Constructors",
490
- classType.constructors,
491
- (constructor, linkGenerator2, baseHeadingLevel2) => adaptConstructor(classType.name, constructor, linkGenerator2, baseHeadingLevel2),
492
- linkGenerator,
493
- baseHeadingLevel + 1
494
- ),
495
- fields: adaptMembers(
496
- "Fields",
497
- classType.fields,
498
- adaptFieldOrProperty,
499
- linkGenerator,
500
- baseHeadingLevel + 1
501
- ),
502
- properties: adaptMembers(
503
- "Properties",
504
- classType.properties,
505
- adaptFieldOrProperty,
506
- linkGenerator,
507
- baseHeadingLevel + 1
508
- ),
509
- innerClasses: {
510
- headingLevel: baseHeadingLevel + 1,
511
- heading: "Classes",
512
- value: classType.classes.map(
513
- (innerClass) => classTypeToClassSource(__spreadProps$d(__spreadValues$d({}, innerClass), { inheritanceChain: [] }), linkGenerator, baseHeadingLevel + 2)
514
- )
515
- },
516
- innerEnums: {
517
- headingLevel: baseHeadingLevel + 1,
518
- heading: "Enums",
519
- value: classType.enums.map((innerEnum) => enumTypeToEnumSource(innerEnum, linkGenerator, baseHeadingLevel + 2))
520
- },
521
- innerInterfaces: {
522
- headingLevel: baseHeadingLevel + 1,
523
- heading: "Interfaces",
524
- value: classType.interfaces.map(
525
- (innerInterface) => interfaceTypeToInterfaceSource(innerInterface, linkGenerator, baseHeadingLevel + 2)
526
- )
527
- }
528
- });
529
- }
530
- function adaptMembers(heading, members, adapter, linkFromTypeNameGenerator, headingLevel) {
531
- return {
532
- headingLevel,
533
- heading,
534
- isGrouped: hasGroup(members),
535
- value: hasGroup(members) ? toGroupedMembers(members, adapter, linkFromTypeNameGenerator, headingLevel + 1) : toFlat(members, adapter, linkFromTypeNameGenerator, headingLevel + 1)
536
- };
537
- }
538
- function hasGroup(members) {
539
- return members.some((member) => member.group);
540
- }
541
- function toFlat(members, adapter, linkGenerator, baseHeadingLevel) {
542
- return members.map((member) => adapter(member, linkGenerator, baseHeadingLevel));
543
- }
544
- function toGroupedMembers(members, adapter, linkGenerator, baseHeadingLevel) {
545
- const groupedMembers = groupByGroupName(members);
546
- return Object.entries(groupedMembers).map(
547
- ([groupName, members2]) => singleGroup(baseHeadingLevel, groupName, adapter, members2, linkGenerator)
548
- );
549
- }
550
- function groupByGroupName(members) {
551
- return members.reduce(
552
- (acc, member) => {
553
- var _a, _b;
554
- const groupName = (_a = member.group) != null ? _a : "Other";
555
- acc[groupName] = (_b = acc[groupName]) != null ? _b : [];
556
- acc[groupName].push(member);
557
- return acc;
558
- },
559
- {}
560
- );
561
- }
562
- function singleGroup(headingLevel, groupName, adapter, members, linkGenerator) {
563
- return {
564
- headingLevel,
565
- heading: groupName,
566
- groupDescription: members[0].groupDescription,
567
- // All fields in the group have the same description
568
- value: toFlat(members, adapter, linkGenerator, headingLevel + 1)
569
- };
570
- }
571
-
572
- function parsedFilesToRenderableBundle(config, parsedFiles) {
573
- return parsedFiles.reduce(
574
- (acc, parsedFile) => {
575
- var _a;
576
- const renderable = typeToRenderable(
577
- parsedFile,
578
- (referenceName) => {
579
- return linkFromTypeNameGenerator(
580
- parsedFile.type,
581
- parsedFiles.map((file) => file.type),
582
- referenceName,
583
- config
584
- );
585
- },
586
- config
587
- );
588
- acc.renderables.push(renderable);
589
- const descriptionLines = (_a = parsedFile.type.docComment) == null ? void 0 : _a.descriptionLines;
590
- const reference = {
591
- typeName: parsedFile.type.name,
592
- directory: getDirectoryFromRoot(config, parsedFile.type),
593
- title: getLinkFromRoot(config, parsedFile.type),
594
- description: adaptDescribable(
595
- descriptionLines,
596
- (referenceName) => getPossibleLinkFromRoot(
597
- config,
598
- referenceName,
599
- findType(
600
- parsedFiles.map((file) => file.type),
601
- referenceName
602
- )
603
- )
604
- ).description
605
- };
606
- const group = getTypeGroup(parsedFile.type, config);
607
- if (!acc.references[group]) {
608
- acc.references[group] = [];
609
- }
610
- acc.references[group].push(reference);
611
- return acc;
612
- },
613
- {
614
- references: {},
615
- renderables: []
616
- }
617
- );
618
- }
619
- function linkFromTypeNameGenerator(typeBeingDocumented, repository, referenceName, config) {
620
- const type = findType(repository, referenceName);
621
- if (!type) {
622
- return referenceName;
623
- }
624
- const [fullClassName, fileLink] = getFileLinkTuple(typeBeingDocumented, type, config);
625
- return {
626
- __type: "link",
627
- title: fullClassName,
628
- url: fileLink
629
- };
630
- }
631
- function getPossibleLinkFromRoot(config, fallback, type) {
632
- if (!type) {
633
- return fallback;
634
- }
635
- const namespacePrefix = config.namespace ? `${config.namespace}.` : "";
636
- const title = `${namespacePrefix}${type.name}`;
637
- return {
638
- __type: "link",
639
- title,
640
- url: `${getDirectoryFromRoot(config, type)}/${title}.md`
641
- };
642
- }
643
- function getDirectoryFromRoot(config, type) {
644
- if (!type) {
645
- return "";
646
- }
647
- return `./${getSanitizedGroup(type, config)}`;
648
- }
649
- function findType(repository, referenceName) {
650
- return repository.find((currentType) => currentType.name.toLowerCase() === referenceName.toLowerCase());
651
- }
652
- function getFileLinkTuple(typeBeingDocumented, referencedType, config) {
653
- const namespacePrefix = config.namespace ? `${config.namespace}.` : "";
654
- const directoryRoot = `${getDirectoryRoot(typeBeingDocumented, referencedType, config)}`;
655
- const fullClassName = `${namespacePrefix}${referencedType.name}`;
656
- return [fullClassName, `${directoryRoot}${fullClassName}.md`];
657
- }
658
- function getDirectoryRoot(typeBeingDocumented, referencedType, config) {
659
- if (getTypeGroup(typeBeingDocumented, config) === getTypeGroup(referencedType, config)) {
660
- return "./";
661
- } else {
662
- return `../${getSanitizedGroup(referencedType, config)}/`;
663
- }
664
- }
665
- function getTypeGroup(type, config) {
666
- var _a, _b;
667
- const groupAnnotation = (_a = type.docComment) == null ? void 0 : _a.annotations.find((annotation) => annotation.name.toLowerCase() === "group");
668
- return (_b = groupAnnotation == null ? void 0 : groupAnnotation.body) != null ? _b : config.defaultGroupName;
669
- }
670
- function getSanitizedGroup(classModel, config) {
671
- return getTypeGroup(classModel, config).replace(/ /g, "-").replace(".", "");
672
- }
673
- function getLinkFromRoot(config, type) {
674
- const namespacePrefix = config.namespace ? `${config.namespace}.` : "";
675
- const title = `${namespacePrefix}${type.name}`;
676
- return {
677
- __type: "link",
678
- title,
679
- url: `${getDirectoryFromRoot(config, type)}/${title}.md`
680
- };
681
- }
682
-
683
- function parseApexMetadata(input) {
684
- var _a;
685
- const map = /* @__PURE__ */ new Map();
686
- const xml = new fastXmlParser.XMLParser().parse(input);
687
- map.set("apiVersion", (_a = xml.ApexClass.apiVersion) != null ? _a : "");
688
- if (xml.ApexClass.status) {
689
- map.set("status", xml.ApexClass.status);
690
- }
691
- return map;
692
- }
693
-
694
- class ReflectionErrors {
695
- constructor(errors) {
696
- this.errors = errors;
697
- this._tag = "ReflectionErrors";
698
- }
699
- }
700
- class ReflectionError {
701
- constructor(file, message) {
702
- this.file = file;
703
- this.message = message;
704
- }
705
- }
706
- function checkForReflectionErrors(reflectionResult) {
707
- function reduceReflectionResultIntoSingleEither(results) {
708
- return results.reduce(
709
- (acc, result) => {
710
- E__namespace.isLeft(result) ? acc.errors.push(result.left) : acc.parsedFiles.push(result.right);
711
- return acc;
712
- },
713
- {
714
- errors: [],
715
- parsedFiles: []
716
- }
717
- );
718
- }
719
- return _function.pipe(
720
- reflectionResult,
721
- reduceReflectionResultIntoSingleEither,
722
- ({ errors, parsedFiles }) => errors.length ? E__namespace.left(new ReflectionErrors(errors)) : E__namespace.right(parsedFiles)
723
- );
724
- }
725
-
726
- function reflectSourceCode(apexBundles) {
727
- return apexBundles.map(reflectSourceBody);
728
- }
729
- function reflectSourceBody(apexBundle) {
730
- const { filePath, content: input, metadataContent: metadata } = apexBundle;
731
- const result = apexReflection.reflect(input);
732
- return result.error ? E__namespace.left(new ReflectionError(filePath, result.error.message)) : E__namespace.right({
733
- filePath,
734
- type: addFileMetadataToTypeAnnotation(result.typeMirror, metadata)
735
- });
736
- }
737
- function addFileMetadataToTypeAnnotation(type, metadata) {
738
- return _function.pipe(
739
- O__namespace.fromNullable(metadata),
740
- O__namespace.map((metadata2) => {
741
- const metadataParams = parseApexMetadata(metadata2);
742
- metadataParams.forEach((value, key) => {
743
- const declaration = `${key}: ${value}`;
744
- type.annotations.push({
745
- rawDeclaration: declaration,
746
- name: declaration,
747
- type: declaration
748
- });
749
- });
750
- return type;
751
- }),
752
- O__namespace.getOrElse(() => type)
753
- );
754
- }
755
-
756
- function createInheritanceChain(repository, classMirror) {
757
- return _function.pipe(
758
- O__namespace.fromNullable(classMirror.extended_class),
759
- O__namespace.match(
760
- () => [],
761
- (extendedClassName) => inheritanceChainFromParentClassName(repository, extendedClassName)
762
- )
763
- );
764
- }
765
- function inheritanceChainFromParentClassName(repository, className) {
766
- return _function.pipe(
767
- O__namespace.fromNullable(repository.find((type) => type.name.toLowerCase() === className.toLowerCase())),
768
- O__namespace.match(
769
- () => [className],
770
- (extendedClass) => [className, ...createInheritanceChain(repository, extendedClass)]
771
- )
772
- );
773
- }
774
-
775
- const parsedFilesToTypes = (parsedFiles) => parsedFiles.map((parsedFile) => parsedFile.type);
776
-
777
- var __defProp$c = Object.defineProperty;
778
- var __defProps$c = Object.defineProperties;
779
- var __getOwnPropDescs$c = Object.getOwnPropertyDescriptors;
780
- var __getOwnPropSymbols$c = Object.getOwnPropertySymbols;
781
- var __hasOwnProp$c = Object.prototype.hasOwnProperty;
782
- var __propIsEnum$c = Object.prototype.propertyIsEnumerable;
783
- var __defNormalProp$c = (obj, key, value) => key in obj ? __defProp$c(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
784
- var __spreadValues$c = (a, b) => {
785
- for (var prop in b || (b = {}))
786
- if (__hasOwnProp$c.call(b, prop))
787
- __defNormalProp$c(a, prop, b[prop]);
788
- if (__getOwnPropSymbols$c)
789
- for (var prop of __getOwnPropSymbols$c(b)) {
790
- if (__propIsEnum$c.call(b, prop))
791
- __defNormalProp$c(a, prop, b[prop]);
792
- }
793
- return a;
794
- };
795
- var __spreadProps$c = (a, b) => __defProps$c(a, __getOwnPropDescs$c(b));
796
- const addInheritanceChainToTypes = (parsedFiles) => parsedFiles.map((parsedFile) => __spreadProps$c(__spreadValues$c({}, parsedFile), {
797
- type: addInheritanceChain(parsedFile.type, parsedFilesToTypes(parsedFiles))
798
- }));
799
- function addInheritanceChain(current, repository) {
800
- if (current.type_name === "enum" || current.type_name === "interface") {
801
- return current;
802
- } else {
803
- const inheritanceChain = createInheritanceChain(repository, current);
804
- return __spreadProps$c(__spreadValues$c({}, current), {
805
- inheritanceChain
806
- });
807
- }
808
- }
809
-
810
- var __defProp$b = Object.defineProperty;
811
- var __defProps$b = Object.defineProperties;
812
- var __getOwnPropDescs$b = Object.getOwnPropertyDescriptors;
813
- var __getOwnPropSymbols$b = Object.getOwnPropertySymbols;
814
- var __hasOwnProp$b = Object.prototype.hasOwnProperty;
815
- var __propIsEnum$b = Object.prototype.propertyIsEnumerable;
816
- var __defNormalProp$b = (obj, key, value) => key in obj ? __defProp$b(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
817
- var __spreadValues$b = (a, b) => {
818
- for (var prop in b || (b = {}))
819
- if (__hasOwnProp$b.call(b, prop))
820
- __defNormalProp$b(a, prop, b[prop]);
821
- if (__getOwnPropSymbols$b)
822
- for (var prop of __getOwnPropSymbols$b(b)) {
823
- if (__propIsEnum$b.call(b, prop))
824
- __defNormalProp$b(a, prop, b[prop]);
825
- }
826
- return a;
827
- };
828
- var __spreadProps$b = (a, b) => __defProps$b(a, __getOwnPropDescs$b(b));
829
- const addInheritedMembersToTypes = (parsedFiles) => parsedFiles.map((parsedFile) => addInheritedMembers(parsedFilesToTypes(parsedFiles), parsedFile));
830
- function addInheritedMembers(repository, parsedFile) {
831
- function addInheritedMembersToType(repository2, current) {
832
- if (current.type_name === "enum") {
833
- return current;
834
- } else if (current.type_name === "interface") {
835
- return addInheritedInterfaceMethods(current, repository2);
836
- } else {
837
- return addInheritedClassMembers(current, repository2);
838
- }
839
- }
840
- return __spreadProps$b(__spreadValues$b({}, parsedFile), {
841
- type: addInheritedMembersToType(repository, parsedFile.type)
842
- });
843
- }
844
- function addInheritedInterfaceMethods(interfaceMirror, repository) {
845
- function methodAlreadyExists(memberName, members) {
846
- return members.some((member) => member.name.toLowerCase() === memberName.toLowerCase());
847
- }
848
- function parentExtractor(interfaceMirror2) {
849
- return interfaceMirror2.extended_interfaces;
850
- }
851
- const parents = getParents(parentExtractor, interfaceMirror, repository);
852
- return __spreadProps$b(__spreadValues$b({}, interfaceMirror), {
853
- methods: parents.reduce(
854
- (acc, currentValue) => [
855
- ...acc,
856
- ...currentValue.methods.filter((method) => !methodAlreadyExists(method.name, acc)).map((method) => __spreadProps$b(__spreadValues$b({}, method), {
857
- inherited: true
858
- }))
859
- ],
860
- interfaceMirror.methods
861
- )
862
- });
863
- }
864
- function addInheritedClassMembers(classMirror, repository) {
865
- function memberAlreadyExists(memberName, members) {
866
- return members.some((member) => member.name.toLowerCase() === memberName.toLowerCase());
867
- }
868
- function parentExtractor(classMirror2) {
869
- return classMirror2.extended_class ? [classMirror2.extended_class] : [];
870
- }
871
- function filterMember(members, existing) {
872
- return members.filter((member) => member.access_modifier.toLowerCase() !== "private").filter((member) => !memberAlreadyExists(member.name, existing)).map((member) => __spreadProps$b(__spreadValues$b({}, member), {
873
- inherited: true
874
- }));
875
- }
876
- const parents = getParents(parentExtractor, classMirror, repository);
877
- return __spreadProps$b(__spreadValues$b({}, classMirror), {
878
- fields: parents.reduce(
879
- (acc, currentValue) => [...acc, ...filterMember(currentValue.fields, acc)],
880
- classMirror.fields
881
- ),
882
- properties: parents.reduce(
883
- (acc, currentValue) => [...acc, ...filterMember(currentValue.properties, acc)],
884
- classMirror.properties
885
- ),
886
- methods: parents.reduce(
887
- (acc, currentValue) => [...acc, ...filterMember(currentValue.methods, acc)],
888
- classMirror.methods
889
- )
890
- });
891
- }
892
- function getParents(extendedNamesExtractor, current, repository) {
893
- return _function.pipe(
894
- extendedNamesExtractor(current),
895
- (interfaces) => interfaces.map((interfaceName) => repository.find((type) => type.name === interfaceName)),
896
- (interfaces = []) => interfaces.filter((type) => type !== void 0),
897
- (interfaces) => interfaces.reduce(
898
- (acc, current2) => [...acc, ...getParents(extendedNamesExtractor, current2, repository)],
899
- interfaces
900
- )
901
- );
902
- }
903
-
904
- const typeDocPartial = `
905
- {{#> documentablePartialTemplate}}
906
-
907
- {{#if doc.group}}
908
- **Group** {{doc.group}}
909
- {{/if}}
910
-
911
- {{#if doc.author}}
912
- **Author** {{doc.author}}
913
- {{/if}}
914
-
915
- {{#if doc.date}}
916
- **Date** {{doc.date}}
917
- {{/if}}
918
-
919
- {{#each doc.sees}}
920
- **See** {{link this}}
921
-
922
- {{/each}}
923
-
924
- {{#if namespace}}
925
- ## Namespace
926
- {{namespace}}
927
- {{/if}}
928
-
929
- {{/documentablePartialTemplate}}
930
- `.trim();
931
-
932
- const documentablePartialTemplate = `
933
- {{#each doc.annotations}}
934
- \`{{this}}\`
935
- {{/each}}
936
-
937
- {{{renderContent doc.description}}}
938
-
939
- {{#each doc.customTags}}
940
- **{{splitAndCapitalize name}}**
941
-
942
- {{{renderContent description}}}
943
-
944
- {{/each}}
945
-
946
- {{> @partial-block}}
947
-
948
- {{#if doc.mermaid.value}}
949
- {{ heading doc.mermaid.headingLevel doc.mermaid.heading }}
950
- {{code doc.mermaid.value}}
951
- {{/if}}
952
-
953
- {{#if doc.example.value}}
954
- {{ heading doc.example.headingLevel doc.example.heading }}
955
- {{{renderContent doc.example.value}}}
956
- {{/if}}
957
- `.trim();
958
-
959
- const methodsPartialTemplate = `
960
- {{ heading headingLevel heading }}
961
- {{#each value}}
962
- {{{ heading headingLevel (inlineCode heading) }}}
963
-
964
- {{#if inherited}}
965
- *Inherited*
966
- {{/if}}
967
-
968
- {{#> documentablePartialTemplate}}
969
-
970
- {{ heading signature.headingLevel signature.heading }}
971
- {{ code signature.value }}
972
-
973
- {{#if parameters.value}}
974
- {{ heading parameters.headingLevel parameters.heading }}
975
- | Name | Type | Description |
976
- |------|------|-------------|
977
- {{#each parameters.value}}
978
- | {{name}} | {{link type}} | {{{renderContent description}}} |
979
- {{/each}}
980
- {{/if}}
981
-
982
- {{ heading returnType.headingLevel returnType.heading }}
983
- **{{link returnType.value.type}}**
984
-
985
- {{#if returnType.value.description}}
986
- {{returnType.value.description}}
987
- {{/if}}
988
-
989
- {{#if throws.value}}
990
- {{ heading throws.headingLevel throws.heading }}
991
- {{#each throws.value}}
992
- {{link this.type}}: {{this.description}}
993
-
994
- {{/each}}
995
- {{/if}}
996
- {{/documentablePartialTemplate}}
997
-
998
- {{#unless @last}}---{{/unless}}
999
-
1000
- {{/each}}
1001
- `.trim();
1002
-
1003
- const groupedMembersPartialTemplate = `
1004
- {{ heading headingLevel heading }}
1005
- {{#each value}}
1006
- {{> (lookup .. "subTemplate") this}}
1007
- {{/each}}
1008
- `.trim();
1009
-
1010
- const constructorsPartialTemplate = `
1011
- {{ heading headingLevel heading }}
1012
- {{#each value}}
1013
- {{{ heading headingLevel (inlineCode heading) }}}
1014
-
1015
- {{#> documentablePartialTemplate}}
1016
-
1017
- {{ heading signature.headingLevel signature.heading }}
1018
- {{ code signature.value }}
1019
-
1020
- {{#if parameters.value}}
1021
- {{ heading parameters.headingLevel parameters.heading }}
1022
- | Name | Type | Description |
1023
- |------|------|-------------|
1024
- {{#each parameters.value}}
1025
- | {{name}} | {{link type}} | {{description}} |
1026
- {{/each}}
1027
- {{/if}}
1028
-
1029
- {{#if throws.value}}
1030
- {{ heading throws.headingLevel throws.heading }}
1031
- {{#each throws.value}}
1032
- {{link this.type}}: {{this.description}}
1033
-
1034
- {{/each}}
1035
- {{/if}}
1036
- {{/documentablePartialTemplate}}
1037
-
1038
- {{#unless @last}}---{{/unless}}
1039
-
1040
- {{/each}}
1041
- `.trim();
1042
-
1043
- const fieldsPartialTemplate = `
1044
- {{ heading headingLevel heading }}
1045
- {{#each value}}
1046
- {{{ heading headingLevel (inlineCode heading) }}}
1047
-
1048
- {{#if inherited}}
1049
- *Inherited*
1050
- {{/if}}
1051
-
1052
- {{#> documentablePartialTemplate }}
1053
-
1054
- {{ heading signature.headingLevel signature.heading }}
1055
- {{ code signature.value }}
1056
-
1057
- {{ heading type.headingLevel type.heading }}
1058
- {{link type.value}}
1059
-
1060
- {{/documentablePartialTemplate}}
1061
-
1062
- {{#unless @last}}---{{/unless}}
1063
-
1064
- {{/each}}
1065
- `.trim();
1066
-
1067
- const classMarkdownTemplate = `
1068
- {{ heading headingLevel heading }}
1069
- {{#if classModifier}}
1070
- \`{{classModifier}}\`
1071
- {{/if}}
1072
-
1073
- {{> typeDocumentation}}
1074
-
1075
- {{#if extends.length}}
1076
- **Inheritance**
1077
-
1078
- {{#each extends}}{{link this}}{{#unless @last}} < {{/unless}}{{/each}}
1079
- {{/if}}
1080
-
1081
- {{#if implements}}
1082
- **Implements**
1083
-
1084
- {{#each implements}}
1085
- {{link this}}{{#unless @last}}, {{/unless}}
1086
- {{/each}}
1087
- {{/if}}
1088
-
1089
- {{#if fields.value}}
1090
- {{#if fields.isGrouped}}
1091
- {{> groupedMembersPartialTemplate fields subTemplate="fieldsPartialTemplate"}}
1092
- {{else}}
1093
- {{> fieldsPartialTemplate fields}}
1094
- {{/if}}
1095
- {{/if}}
1096
-
1097
- {{#if properties.value}}
1098
- {{#if properties.isGrouped}}
1099
- {{> groupedMembersPartialTemplate properties subTemplate="fieldsPartialTemplate"}}
1100
- {{else}}
1101
- {{> fieldsPartialTemplate properties}}
1102
- {{/if}}
1103
- {{/if}}
1104
-
1105
- {{#if constructors.value}}
1106
- {{#if constructors.isGrouped}}
1107
- {{> groupedMembersPartialTemplate constructors subTemplate="constructorsPartialTemplate"}}
1108
- {{else}}
1109
- {{> constructorsPartialTemplate constructors}}
1110
- {{/if}}
1111
- {{/if}}
1112
-
1113
- {{#if methods.value}}
1114
- {{#if methods.isGrouped}}
1115
- {{> groupedMembersPartialTemplate methods subTemplate="methodsPartialTemplate"}}
1116
- {{else}}
1117
- {{> methodsPartialTemplate methods}}
1118
- {{/if}}
1119
- {{/if}}
1120
-
1121
- {{#if innerClasses.value}}
1122
- {{ heading innerClasses.headingLevel innerClasses.heading }}
1123
- {{#each innerClasses.value}}
1124
- {{> classTemplate this}}
1125
- {{/each}}
1126
- {{/if}}
1127
-
1128
- {{#if innerEnums.value}}
1129
- {{ heading innerEnums.headingLevel innerEnums.heading }}
1130
- {{#each innerEnums.value}}
1131
- {{> enumTemplate this}}
1132
- {{/each}}
1133
- {{/if}}
1134
-
1135
- {{#if innerInterfaces.value}}
1136
- {{ heading innerInterfaces.headingLevel innerInterfaces.heading }}
1137
- {{#each innerInterfaces.value}}
1138
- {{> interfaceTemplate this}}
1139
- {{/each}}
1140
- {{/if}}
1141
- `.trim();
1142
-
1143
- const enumMarkdownTemplate = `
1144
- {{ heading headingLevel heading }}
1145
-
1146
- {{> typeDocumentation }}
1147
-
1148
- {{ heading values.headingLevel values.heading }}
1149
- | Value | Description |
1150
- |-------|-------------|
1151
- {{#each values.value}}
1152
- | {{value}} | {{description}} |
1153
- {{/each}}
1154
- `.trim();
1155
-
1156
- const interfaceMarkdownTemplate = `
1157
- {{ heading headingLevel heading }}
1158
-
1159
- {{> typeDocumentation }}
1160
-
1161
- {{#if extends}}
1162
- **Extends**
1163
- {{#each extends}}
1164
- {{link this}}{{#unless @last}}, {{/unless}}
1165
- {{/each}}
1166
- {{/if}}
1167
-
1168
- {{#if methods}}
1169
- {{> methodsPartialTemplate methods}}
1170
- {{/if}}
1171
- `.trim();
1172
-
1173
- class Template {
1174
- constructor() {
1175
- Handlebars.registerPartial("typeDocumentation", typeDocPartial);
1176
- Handlebars.registerPartial("documentablePartialTemplate", documentablePartialTemplate);
1177
- Handlebars.registerPartial("methodsPartialTemplate", methodsPartialTemplate);
1178
- Handlebars.registerPartial("constructorsPartialTemplate", constructorsPartialTemplate);
1179
- Handlebars.registerPartial("groupedMembersPartialTemplate", groupedMembersPartialTemplate);
1180
- Handlebars.registerPartial("fieldsPartialTemplate", fieldsPartialTemplate);
1181
- Handlebars.registerPartial("classTemplate", classMarkdownTemplate);
1182
- Handlebars.registerPartial("enumTemplate", enumMarkdownTemplate);
1183
- Handlebars.registerPartial("interfaceTemplate", interfaceMarkdownTemplate);
1184
- Handlebars.registerHelper("link", link);
1185
- Handlebars.registerHelper("code", convertCodeBlock);
1186
- Handlebars.registerHelper("renderContent", resolveRenderableContent);
1187
- Handlebars.registerHelper("heading", heading);
1188
- Handlebars.registerHelper("inlineCode", inlineCode);
1189
- Handlebars.registerHelper("splitAndCapitalize", splitAndCapitalize);
1190
- }
1191
- static getInstance() {
1192
- if (!Template.instance) {
1193
- Template.instance = new Template();
1194
- }
1195
- return Template.instance;
1196
- }
1197
- compile(request) {
1198
- const compiled = Handlebars.compile(request.template);
1199
- return compiled(request.source).trim().replace(/\n{3,}/g, "\n\n");
1200
- }
1201
- }
1202
- const splitAndCapitalize = (text) => {
1203
- const words = text.split(/[-_]+/);
1204
- const capitalizedWords = [];
1205
- for (const word of words) {
1206
- capitalizedWords.push(word.charAt(0).toUpperCase() + word.slice(1));
1207
- }
1208
- return capitalizedWords.join(" ");
1209
- };
1210
- const heading = (level, text) => {
1211
- return `${"#".repeat(level)} ${text}`;
1212
- };
1213
- const inlineCode = (text) => {
1214
- return new Handlebars.SafeString(`\`${text}\``);
1215
- };
1216
- const convertCodeBlock = (codeBlock) => {
1217
- return new Handlebars.SafeString(
1218
- `
1219
- \`\`\`${codeBlock.language}
1220
- ${codeBlock.content.join("\n")}
1221
- \`\`\`
1222
- `.trim()
1223
- );
1224
- };
1225
- const resolveRenderableContent = (description) => {
1226
- if (!description) {
1227
- return "";
1228
- }
1229
- function reduceDescription(acc, curr) {
1230
- if (isEmptyLine(curr)) {
1231
- return acc + "\n";
1232
- }
1233
- if (isCodeBlock(curr)) {
1234
- return acc + convertCodeBlock(curr) + "\n";
1235
- }
1236
- if (isInlineCode(curr)) {
1237
- return acc + inlineCode(curr.content).toString() + " ";
1238
- } else {
1239
- return acc + Handlebars.escapeExpression(link(curr)).trim() + " ";
1240
- }
1241
- }
1242
- return description.reduce(reduceDescription, "").trim();
1243
- };
1244
- const link = (source) => {
1245
- if (typeof source === "string") {
1246
- return source;
1247
- } else {
1248
- return `[${source.title}](${source.url})`;
1249
- }
1250
- };
1251
-
1252
- const convertToDocumentationBundle = (referenceGuideTemplate, { references, renderables }) => ({
1253
- referenceGuide: {
1254
- directory: "",
1255
- frontmatter: null,
1256
- content: referencesToReferenceGuideContent(references, referenceGuideTemplate),
1257
- fileExtension: "md",
1258
- fileName: "index"
1259
- },
1260
- docs: renderables.map((renderable) => renderableToPageData(Object.values(references).flat(), renderable))
1261
- });
1262
- function referencesToReferenceGuideContent(references, template) {
1263
- function alphabetizeReferences(references2) {
1264
- return Object.keys(references2).sort((a, b) => a.localeCompare(b)).reduce((acc, key) => {
1265
- acc[key] = references2[key].sort((a, b) => a.title.toString().localeCompare(b.title.toString()));
1266
- return acc;
1267
- }, {});
1268
- }
1269
- return _function.pipe(
1270
- references,
1271
- alphabetizeReferences,
1272
- (references2) => compile({
1273
- template,
1274
- source: references2
1275
- })
1276
- );
1277
- }
1278
- function renderableToPageData(referenceGuideReference, renderable) {
1279
- function buildDocOutput(renderable2, docContents) {
1280
- var _a;
1281
- const reference = referenceGuideReference.find(
1282
- (ref) => ref.typeName.toLowerCase() === renderable2.name.toLowerCase()
1283
- );
1284
- const namespacePrefix = renderable2.namespace ? `${renderable2.namespace}.` : "";
1285
- return {
1286
- source: {
1287
- filePath: renderable2.filePath,
1288
- name: renderable2.name,
1289
- type: renderable2.type
1290
- },
1291
- fileName: `${namespacePrefix}${renderable2.name}`,
1292
- fileExtension: "md",
1293
- directory: `${reference == null ? void 0 : reference.directory}`,
1294
- frontmatter: null,
1295
- content: docContents,
1296
- group: (_a = renderable2.doc.group) != null ? _a : "Miscellaneous"
1297
- };
1298
- }
1299
- return _function.pipe(renderable, resolveApexTypeTemplate, compile, (docContents) => buildDocOutput(renderable, docContents));
1300
- }
1301
- function resolveApexTypeTemplate(renderable) {
1302
- function getTemplate(renderable2) {
1303
- switch (renderable2.type) {
1304
- case "enum":
1305
- return enumMarkdownTemplate;
1306
- case "interface":
1307
- return interfaceMarkdownTemplate;
1308
- case "class":
1309
- return classMarkdownTemplate;
1310
- }
1311
- }
1312
- return {
1313
- template: getTemplate(renderable),
1314
- source: renderable
1315
- };
1316
- }
1317
- function compile(request) {
1318
- return Template.getInstance().compile(request);
1319
- }
1320
-
1321
- var __defProp$a = Object.defineProperty;
1322
- var __defProps$a = Object.defineProperties;
1323
- var __getOwnPropDescs$a = Object.getOwnPropertyDescriptors;
1324
- var __getOwnPropSymbols$a = Object.getOwnPropertySymbols;
1325
- var __hasOwnProp$a = Object.prototype.hasOwnProperty;
1326
- var __propIsEnum$a = Object.prototype.propertyIsEnumerable;
1327
- var __defNormalProp$a = (obj, key, value) => key in obj ? __defProp$a(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
1328
- var __spreadValues$a = (a, b) => {
1329
- for (var prop in b || (b = {}))
1330
- if (__hasOwnProp$a.call(b, prop))
1331
- __defNormalProp$a(a, prop, b[prop]);
1332
- if (__getOwnPropSymbols$a)
1333
- for (var prop of __getOwnPropSymbols$a(b)) {
1334
- if (__propIsEnum$a.call(b, prop))
1335
- __defNormalProp$a(a, prop, b[prop]);
1336
- }
1337
- return a;
1338
- };
1339
- var __spreadProps$a = (a, b) => __defProps$a(a, __getOwnPropDescs$a(b));
1340
- class Manifest {
1341
- /**
1342
- * Constructs a new Manifest object.
1343
- * @param types List of types to be wrapped by this object.
1344
- * @param isForInnerTypes Whether this manifest represent an inner type or not.
1345
- */
1346
- constructor(types, isForInnerTypes = false) {
1347
- this.types = types;
1348
- this.isForInnerTypes = isForInnerTypes;
1349
- }
1350
- filteredByAccessModifierAndAnnotations(modifiers) {
1351
- const filteredTypes = Manifest.filterAccessibleModifier(this.types, modifiers);
1352
- const typesToReturn = [];
1353
- for (const filteredType of filteredTypes) {
1354
- typesToReturn.push(Manifest.filterSingleType(filteredType, modifiers, this.isForInnerTypes));
1355
- }
1356
- return typesToReturn;
1357
- }
1358
- static filterSingleType(currentType, modifiers, isForInnerTypes) {
1359
- if (currentType.type_name === "enum") {
1360
- return currentType;
1361
- }
1362
- if (currentType.type_name === "interface") {
1363
- const currentInterface = currentType;
1364
- return __spreadProps$a(__spreadValues$a({}, currentType), {
1365
- methods: this.filterAccessibleModifier(currentInterface.methods, modifiers)
1366
- });
1367
- }
1368
- const currentClass = currentType;
1369
- const filteredClass = __spreadProps$a(__spreadValues$a({}, currentType), {
1370
- methods: this.filterAccessibleModifier(currentClass.methods, modifiers),
1371
- properties: this.filterAccessibleModifier(currentClass.properties, modifiers),
1372
- fields: this.filterAccessibleModifier(currentClass.fields, modifiers),
1373
- constructors: this.filterAccessibleModifier(currentClass.constructors, modifiers)
1374
- });
1375
- if (!isForInnerTypes) {
1376
- return __spreadProps$a(__spreadValues$a({}, filteredClass), {
1377
- enums: this.filterAccessibleModifier(currentClass.enums, modifiers),
1378
- interfaces: this.filterAccessibleModifier(currentClass.interfaces, modifiers),
1379
- classes: new Manifest(currentClass.classes, true).filteredByAccessModifierAndAnnotations(
1380
- modifiers
1381
- )
1382
- });
1383
- }
1384
- return filteredClass;
1385
- }
1386
- static filterAccessibleModifier(accessAndDocAware, modifiers) {
1387
- return accessAndDocAware.filter((type) => this.shouldFilterType(type, modifiers));
1388
- }
1389
- static shouldFilterType(accessAndDocAware, modifiers) {
1390
- var _a;
1391
- const hasIgnoreDocAnnotation = (_a = accessAndDocAware.docComment) == null ? void 0 : _a.annotations.some(
1392
- (annotation) => annotation.name.toLowerCase() === "ignore"
1393
- );
1394
- if (hasIgnoreDocAnnotation) {
1395
- return false;
1396
- }
1397
- return modifiers.includes(accessAndDocAware.access_modifier) || accessAndDocAware.annotations.some((annotation) => modifiers.includes(annotation.type.toLowerCase()));
1398
- }
1399
- }
1400
-
1401
- var __defProp$9 = Object.defineProperty;
1402
- var __defProps$9 = Object.defineProperties;
1403
- var __getOwnPropDescs$9 = Object.getOwnPropertyDescriptors;
1404
- var __getOwnPropSymbols$9 = Object.getOwnPropertySymbols;
1405
- var __hasOwnProp$9 = Object.prototype.hasOwnProperty;
1406
- var __propIsEnum$9 = Object.prototype.propertyIsEnumerable;
1407
- var __defNormalProp$9 = (obj, key, value) => key in obj ? __defProp$9(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
1408
- var __spreadValues$9 = (a, b) => {
1409
- for (var prop in b || (b = {}))
1410
- if (__hasOwnProp$9.call(b, prop))
1411
- __defNormalProp$9(a, prop, b[prop]);
1412
- if (__getOwnPropSymbols$9)
1413
- for (var prop of __getOwnPropSymbols$9(b)) {
1414
- if (__propIsEnum$9.call(b, prop))
1415
- __defNormalProp$9(a, prop, b[prop]);
1416
- }
1417
- return a;
1418
- };
1419
- var __spreadProps$9 = (a, b) => __defProps$9(a, __getOwnPropDescs$9(b));
1420
- function filterScope(scopes, parsedFiles) {
1421
- return parsedFiles.filter(({ type }) => Manifest.shouldFilterType(type, scopes)).map((parsedFile) => {
1422
- return __spreadProps$9(__spreadValues$9({}, parsedFile), {
1423
- type: Manifest.filterSingleType(parsedFile.type, scopes, false)
1424
- });
1425
- });
1426
- }
1427
-
1428
- const hookableTemplate = `
1429
- {{#if frontmatter}}
1430
- {{{frontmatter}}}
1431
- {{/if}}
1432
-
1433
- {{{content}}}
1434
- `.trim();
1435
-
1436
- var __defProp$8 = Object.defineProperty;
1437
- var __defProps$8 = Object.defineProperties;
1438
- var __getOwnPropDescs$8 = Object.getOwnPropertyDescriptors;
1439
- var __getOwnPropSymbols$8 = Object.getOwnPropertySymbols;
1440
- var __hasOwnProp$8 = Object.prototype.hasOwnProperty;
1441
- var __propIsEnum$8 = Object.prototype.propertyIsEnumerable;
1442
- var __defNormalProp$8 = (obj, key, value) => key in obj ? __defProp$8(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
1443
- var __spreadValues$8 = (a, b) => {
1444
- for (var prop in b || (b = {}))
1445
- if (__hasOwnProp$8.call(b, prop))
1446
- __defNormalProp$8(a, prop, b[prop]);
1447
- if (__getOwnPropSymbols$8)
1448
- for (var prop of __getOwnPropSymbols$8(b)) {
1449
- if (__propIsEnum$8.call(b, prop))
1450
- __defNormalProp$8(a, prop, b[prop]);
1451
- }
1452
- return a;
1453
- };
1454
- var __spreadProps$8 = (a, b) => __defProps$8(a, __getOwnPropDescs$8(b));
1455
- function sortMembers(shouldSortMembers, parsedFiles) {
1456
- return parsedFiles.map((parsedFile) => __spreadProps$8(__spreadValues$8({}, parsedFile), {
1457
- type: sortTypeMember(parsedFile.type, shouldSortMembers)
1458
- }));
1459
- }
1460
- function sortByNames(shouldSort, a, b) {
1461
- if (shouldSort) {
1462
- return a.name.localeCompare(b.name);
1463
- }
1464
- return 0;
1465
- }
1466
- function sortNamed(shouldSort, items) {
1467
- return items.sort((a, b) => sortByNames(shouldSort, a, b));
1468
- }
1469
- function sortTypeMember(type, shouldSort) {
1470
- switch (type.type_name) {
1471
- case "enum":
1472
- return sortEnumValues(shouldSort, type);
1473
- case "interface":
1474
- return sortInterfaceMethods(shouldSort, type);
1475
- case "class":
1476
- return sortClassMembers(shouldSort, type);
1477
- }
1478
- }
1479
- function sortEnumValues(shouldSort, enumType) {
1480
- return __spreadProps$8(__spreadValues$8({}, enumType), {
1481
- values: sortNamed(shouldSort, enumType.values)
1482
- });
1483
- }
1484
- function sortInterfaceMethods(shouldSort, interfaceType) {
1485
- return __spreadProps$8(__spreadValues$8({}, interfaceType), {
1486
- methods: sortNamed(shouldSort, interfaceType.methods)
1487
- });
1488
- }
1489
- function sortClassMembers(shouldSort, classType) {
1490
- return __spreadProps$8(__spreadValues$8({}, classType), {
1491
- fields: sortNamed(shouldSort, classType.fields),
1492
- classes: sortNamed(shouldSort, classType.classes),
1493
- enums: sortNamed(shouldSort, classType.enums),
1494
- interfaces: sortNamed(shouldSort, classType.interfaces),
1495
- methods: sortNamed(shouldSort, classType.methods),
1496
- properties: sortNamed(shouldSort, classType.properties)
1497
- });
1498
- }
1499
-
1500
- function isSkip(value) {
1501
- return Object.prototype.hasOwnProperty.call(value, "_tag") && value._tag === "Skip";
1502
- }
1503
-
1504
- var __defProp$7 = Object.defineProperty;
1505
- var __defProps$7 = Object.defineProperties;
1506
- var __getOwnPropDescs$7 = Object.getOwnPropertyDescriptors;
1507
- var __getOwnPropSymbols$7 = Object.getOwnPropertySymbols;
1508
- var __hasOwnProp$7 = Object.prototype.hasOwnProperty;
1509
- var __propIsEnum$7 = Object.prototype.propertyIsEnumerable;
1510
- var __defNormalProp$7 = (obj, key, value) => key in obj ? __defProp$7(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
1511
- var __spreadValues$7 = (a, b) => {
1512
- for (var prop in b || (b = {}))
1513
- if (__hasOwnProp$7.call(b, prop))
1514
- __defNormalProp$7(a, prop, b[prop]);
1515
- if (__getOwnPropSymbols$7)
1516
- for (var prop of __getOwnPropSymbols$7(b)) {
1517
- if (__propIsEnum$7.call(b, prop))
1518
- __defNormalProp$7(a, prop, b[prop]);
1519
- }
1520
- return a;
1521
- };
1522
- var __spreadProps$7 = (a, b) => __defProps$7(a, __getOwnPropDescs$7(b));
1523
- var __async$2 = (__this, __arguments, generator) => {
1524
- return new Promise((resolve, reject) => {
1525
- var fulfilled = (value) => {
1526
- try {
1527
- step(generator.next(value));
1528
- } catch (e) {
1529
- reject(e);
1530
- }
1531
- };
1532
- var rejected = (value) => {
1533
- try {
1534
- step(generator.throw(value));
1535
- } catch (e) {
1536
- reject(e);
1537
- }
1538
- };
1539
- var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
1540
- step((generator = generator.apply(__this, __arguments)).next());
1541
- });
1542
- };
1543
- class HookError {
1544
- constructor(error) {
1545
- this.error = error;
1546
- this._tag = "HookError";
1547
- }
1548
- }
1549
- function generateDocs(apexBundles, config) {
1550
- const filterOutOfScope = apply(filterScope, config.scope);
1551
- const convertToRenderableBundle = apply(parsedFilesToRenderableBundle, config);
1552
- const convertToDocumentationBundleForTemplate = apply(convertToDocumentationBundle, config.referenceGuideTemplate);
1553
- const sortTypeMembers = apply(sortMembers, config.sortMembersAlphabetically);
1554
- return _function.pipe(
1555
- apexBundles,
1556
- reflectSourceCode,
1557
- checkForReflectionErrors,
1558
- E__namespace.map(filterOutOfScope),
1559
- E__namespace.map(addInheritedMembersToTypes),
1560
- E__namespace.map(addInheritanceChainToTypes),
1561
- E__namespace.map(sortTypeMembers),
1562
- E__namespace.map(convertToRenderableBundle),
1563
- E__namespace.map(convertToDocumentationBundleForTemplate),
1564
- TE__namespace.fromEither,
1565
- TE__namespace.flatMap(
1566
- (bundle) => TE__namespace.tryCatch(
1567
- () => documentationBundleHook(bundle, config),
1568
- (error) => new HookError(error)
1569
- )
1570
- ),
1571
- TE__namespace.map((bundle) => ({
1572
- referenceGuide: isSkip(bundle.referenceGuide) ? bundle.referenceGuide : __spreadProps$7(__spreadValues$7({}, bundle.referenceGuide), {
1573
- content: Template.getInstance().compile({
1574
- source: {
1575
- frontmatter: toFrontmatterString(bundle.referenceGuide.frontmatter),
1576
- content: bundle.referenceGuide.content
1577
- },
1578
- template: hookableTemplate
1579
- })
1580
- }),
1581
- docs: bundle.docs.map((doc) => __spreadProps$7(__spreadValues$7({}, doc), {
1582
- content: Template.getInstance().compile({
1583
- source: {
1584
- frontmatter: toFrontmatterString(doc.frontmatter),
1585
- content: doc.content
1586
- },
1587
- template: hookableTemplate
1588
- })
1589
- }))
1590
- }))
1591
- );
1592
- }
1593
- function toFrontmatterString(frontmatter) {
1594
- if (typeof frontmatter === "string") {
1595
- return frontmatter;
1596
- }
1597
- if (!frontmatter) {
1598
- return "";
1599
- }
1600
- const yamlString = yaml.dump(frontmatter);
1601
- return `---
1602
- ${yamlString}---
1603
- `;
1604
- }
1605
- function passThroughHook(value) {
1606
- return value;
1607
- }
1608
- const documentationBundleHook = (bundle, config) => __async$2(void 0, null, function* () {
1609
- return {
1610
- referenceGuide: yield transformReferenceGuide(bundle.referenceGuide, config.transformReferenceGuide),
1611
- docs: yield transformDocs(bundle.docs, config.transformDocs, config.transformDocPage)
1612
- };
1613
- });
1614
- const transformReferenceGuide = (_0, ..._1) => __async$2(void 0, [_0, ..._1], function* (referenceGuide, hook = passThroughHook) {
1615
- const result = yield hook(referenceGuide);
1616
- if (isSkip(result)) {
1617
- return result;
1618
- }
1619
- return __spreadValues$7(__spreadValues$7({}, referenceGuide), yield hook(referenceGuide));
1620
- });
1621
- const transformDocs = (_0, ..._1) => __async$2(void 0, [_0, ..._1], function* (docs, transformDocsHook = passThroughHook, transformDocPageHook = passThroughHook) {
1622
- const transformed = yield transformDocsHook(docs);
1623
- return Promise.all(transformed.map((doc) => transformDocPage(doc, transformDocPageHook)));
1624
- });
1625
- const transformDocPage = (_0, ..._1) => __async$2(void 0, [_0, ..._1], function* (doc, hook = passThroughHook) {
1626
- return __spreadValues$7(__spreadValues$7({}, doc), yield hook(doc));
1627
- });
1628
-
1629
- var __defProp$6 = Object.defineProperty;
1630
- var __defProps$6 = Object.defineProperties;
1631
- var __getOwnPropDescs$6 = Object.getOwnPropertyDescriptors;
1632
- var __getOwnPropSymbols$6 = Object.getOwnPropertySymbols;
1633
- var __hasOwnProp$6 = Object.prototype.hasOwnProperty;
1634
- var __propIsEnum$6 = Object.prototype.propertyIsEnumerable;
1635
- var __defNormalProp$6 = (obj, key, value) => key in obj ? __defProp$6(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
1636
- var __spreadValues$6 = (a, b) => {
1637
- for (var prop in b || (b = {}))
1638
- if (__hasOwnProp$6.call(b, prop))
1639
- __defNormalProp$6(a, prop, b[prop]);
1640
- if (__getOwnPropSymbols$6)
1641
- for (var prop of __getOwnPropSymbols$6(b)) {
1642
- if (__propIsEnum$6.call(b, prop))
1643
- __defNormalProp$6(a, prop, b[prop]);
1644
- }
1645
- return a;
1646
- };
1647
- var __spreadProps$6 = (a, b) => __defProps$6(a, __getOwnPropDescs$6(b));
1648
- class FileWriter {
1649
- static write(files, outputDir, onWriteCallback) {
1650
- files.forEach((file) => {
1651
- const resolvedFile = this.getTargetLocation(file, outputDir);
1652
- if (!fs__namespace.existsSync(resolvedFile.directory)) {
1653
- fs__namespace.mkdirSync(resolvedFile.directory, { recursive: true });
1654
- }
1655
- const filePath = path__namespace.join(resolvedFile.directory, `${resolvedFile.fileName}.${resolvedFile.fileExtension}`);
1656
- fs__namespace.writeFileSync(filePath, resolvedFile.content, "utf8");
1657
- onWriteCallback(resolvedFile);
1658
- });
1659
- }
1660
- static getTargetLocation(file, outputDir) {
1661
- return __spreadProps$6(__spreadValues$6({}, file), {
1662
- directory: path__namespace.join(outputDir, file.directory)
1663
- });
1664
- }
1665
- }
1666
-
1667
- class Logger {
1668
- /**
1669
- * Logs a message with optional arguments.
1670
- * @param message The message to log.
1671
- * @param args Optional arguments.
1672
- */
1673
- static log(message, ...args) {
1674
- this.logSingle(message);
1675
- args.forEach((arg) => {
1676
- this.logSingle(arg);
1677
- });
1678
- }
1679
- /**
1680
- * Logs an error message with optional arguments.
1681
- * @param message The error message to log.
1682
- * @param args Optional arguments.
1683
- */
1684
- static error(message, ...args) {
1685
- this.logSingle(message, false, "red", false);
1686
- args.forEach(() => {
1687
- this.logSingle(message, false, "red", false);
1688
- });
1689
- }
1690
- static logSingle(text, showSpinner = true, color = "green", overrideConsole = true) {
1691
- if (this.currentFrame > 9) {
1692
- this.currentFrame = 0;
1693
- }
1694
- const spinner = showSpinner ? `${this.frames[this.currentFrame++]}` : "";
1695
- let logMessage;
1696
- if (color === "green") {
1697
- logMessage = `${chalk.green((/* @__PURE__ */ new Date()).toLocaleString() + ": ")}${text}
1698
- `;
1699
- } else {
1700
- logMessage = `${chalk.red((/* @__PURE__ */ new Date()).toLocaleString() + ": ")}${text}
1701
- `;
1702
- }
1703
- if (overrideConsole) {
1704
- logUpdate(`${spinner} ${logMessage}`);
1705
- } else {
1706
- process.stdout.write(`${spinner} ${logMessage}`);
1707
- }
1708
- }
1709
- static clear() {
1710
- logUpdate.clear();
1711
- }
1712
- }
1713
- Logger.currentFrame = 0;
1714
- Logger.frames = ["\u280B", "\u2819", "\u2839", "\u2838", "\u283C", "\u2834", "\u2826", "\u2827", "\u2807", "\u280F"];
1715
-
1716
- const referenceGuideTemplate = `
1717
- # Apex Reference Guide
1718
-
1719
- {{#each this}}
1720
- ## {{@key}}
1721
-
1722
- {{#each this}}
1723
- ### {{link title}}
1724
-
1725
- {{{renderContent description}}}
1726
-
1727
- {{/each}}
1728
- {{/each}}
1729
- `.trim();
1730
-
1731
- var __defProp$5 = Object.defineProperty;
1732
- var __defProps$5 = Object.defineProperties;
1733
- var __getOwnPropDescs$5 = Object.getOwnPropertyDescriptors;
1734
- var __getOwnPropSymbols$5 = Object.getOwnPropertySymbols;
1735
- var __hasOwnProp$5 = Object.prototype.hasOwnProperty;
1736
- var __propIsEnum$5 = Object.prototype.propertyIsEnumerable;
1737
- var __defNormalProp$5 = (obj, key, value) => key in obj ? __defProp$5(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
1738
- var __spreadValues$5 = (a, b) => {
1739
- for (var prop in b || (b = {}))
1740
- if (__hasOwnProp$5.call(b, prop))
1741
- __defNormalProp$5(a, prop, b[prop]);
1742
- if (__getOwnPropSymbols$5)
1743
- for (var prop of __getOwnPropSymbols$5(b)) {
1744
- if (__propIsEnum$5.call(b, prop))
1745
- __defNormalProp$5(a, prop, b[prop]);
1746
- }
1747
- return a;
1748
- };
1749
- var __spreadProps$5 = (a, b) => __defProps$5(a, __getOwnPropDescs$5(b));
1750
- function generate(bundles, config) {
1751
- return _function.pipe(
1752
- generateDocumentationBundle(bundles, config),
1753
- TE__namespace.map((files) => writeFilesToSystem(files, config.targetDir)),
1754
- TE__namespace.mapLeft((error) => {
1755
- if (error._tag === "HookError") {
1756
- Logger.error("Error(s) occurred while processing hooks. Please review the following issues:");
1757
- Logger.error(error.error);
1758
- return;
1759
- }
1760
- const errorMessages = [
1761
- "Error(s) occurred while parsing files. Please review the following issues:",
1762
- ...error.errors.map(formatReflectionError)
1763
- ].join("\n");
1764
- Logger.error(errorMessages);
1765
- })
1766
- )();
1767
- }
1768
- function generateDocumentationBundle(bundles, config) {
1769
- return generateDocs(bundles, __spreadProps$5(__spreadValues$5({}, config), {
1770
- referenceGuideTemplate
1771
- }));
1772
- }
1773
- function writeFilesToSystem(files, outputDir) {
1774
- FileWriter.write(
1775
- [files.referenceGuide, ...files.docs].filter((file) => !isSkip(file)),
1776
- outputDir,
1777
- (file) => {
1778
- Logger.logSingle(`${file.fileName} processed.`, false, "green", false);
1779
- }
1780
- );
1781
- }
1782
- function formatReflectionError(error) {
1783
- return `Source file: ${error.file}
1784
- ${error.message}
1785
- `;
1786
- }
1787
-
1788
- function createManifest(typeParser, reflect) {
1789
- return new Manifest(typeParser.parse(reflect));
1790
- }
1791
-
1792
- var __defProp$4 = Object.defineProperty;
1793
- var __defProps$4 = Object.defineProperties;
1794
- var __getOwnPropDescs$4 = Object.getOwnPropertyDescriptors;
1795
- var __getOwnPropSymbols$4 = Object.getOwnPropertySymbols;
1796
- var __hasOwnProp$4 = Object.prototype.hasOwnProperty;
1797
- var __propIsEnum$4 = Object.prototype.propertyIsEnumerable;
1798
- var __defNormalProp$4 = (obj, key, value) => key in obj ? __defProp$4(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
1799
- var __spreadValues$4 = (a, b) => {
1800
- for (var prop in b || (b = {}))
1801
- if (__hasOwnProp$4.call(b, prop))
1802
- __defNormalProp$4(a, prop, b[prop]);
1803
- if (__getOwnPropSymbols$4)
1804
- for (var prop of __getOwnPropSymbols$4(b)) {
1805
- if (__propIsEnum$4.call(b, prop))
1806
- __defNormalProp$4(a, prop, b[prop]);
1807
- }
1808
- return a;
1809
- };
1810
- var __spreadProps$4 = (a, b) => __defProps$4(a, __getOwnPropDescs$4(b));
1811
- class RawBodyParser {
1812
- constructor(typeBundles) {
1813
- this.typeBundles = typeBundles;
1814
- }
1815
- parse(reflect) {
1816
- const types = this.typeBundles.map((currentBundle) => {
1817
- Logger.log(`Parsing file: ${currentBundle.filePath}`);
1818
- const result = reflect(currentBundle);
1819
- if (!!result.typeMirror && !!currentBundle.metadataContent) {
1820
- const metadataParams = parseApexMetadata(currentBundle.metadataContent);
1821
- metadataParams.forEach((value, key) => {
1822
- var _a;
1823
- const declaration = `${key}: ${value}`;
1824
- (_a = result.typeMirror) == null ? void 0 : _a.annotations.push({
1825
- rawDeclaration: declaration,
1826
- name: declaration,
1827
- type: declaration
1828
- });
1829
- });
1830
- }
1831
- return result;
1832
- }).filter((reflectionResult) => {
1833
- return reflectionResult.typeMirror;
1834
- }).map((reflectionResult) => reflectionResult.typeMirror);
1835
- return this.addFieldsFromParent(types);
1836
- }
1837
- addFieldsFromParent(types) {
1838
- const typesWithFields = [];
1839
- for (const currentType of types) {
1840
- if (currentType.type_name !== "class" && currentType.type_name !== "interface") {
1841
- typesWithFields.push(currentType);
1842
- continue;
1843
- }
1844
- if (currentType.type_name === "class") {
1845
- let typeAsClass = currentType;
1846
- if (!typeAsClass.extended_class) {
1847
- typesWithFields.push(currentType);
1848
- continue;
1849
- }
1850
- typeAsClass = this.addMembersFromParent(typeAsClass, types);
1851
- typesWithFields.push(typeAsClass);
1852
- continue;
1853
- }
1854
- let typeAsInterface = currentType;
1855
- if (!typeAsInterface.extended_interfaces.length) {
1856
- typesWithFields.push(currentType);
1857
- continue;
1858
- }
1859
- typeAsInterface = this.addMethodsFromParent(typeAsInterface, types);
1860
- typesWithFields.push(typeAsInterface);
1861
- }
1862
- return typesWithFields;
1863
- }
1864
- addMembersFromParent(currentClass, allTypes) {
1865
- if (!currentClass.extended_class) {
1866
- return currentClass;
1867
- }
1868
- const parent = allTypes.find((currentType) => currentType.name === currentClass.extended_class);
1869
- if (!parent || parent.type_name !== "class") {
1870
- return currentClass;
1871
- }
1872
- let parentAsClass = parent;
1873
- if (parentAsClass.extended_class) {
1874
- parentAsClass = this.addMembersFromParent(parentAsClass, allTypes);
1875
- }
1876
- currentClass.fields = [...currentClass.fields, ...this.getInheritedFields(parentAsClass, currentClass)];
1877
- currentClass.properties = [...currentClass.properties, ...this.getInheritedProperties(parentAsClass, currentClass)];
1878
- currentClass.methods = [...currentClass.methods, ...this.getInheritedMethods(parentAsClass, currentClass)];
1879
- return currentClass;
1880
- }
1881
- addMethodsFromParent(currentInterface, allTypes) {
1882
- if (!currentInterface.extended_interfaces.length) {
1883
- return currentInterface;
1884
- }
1885
- const parents = [];
1886
- for (const currentInterfaceName of currentInterface.extended_interfaces) {
1887
- const parent = allTypes.find((currentType) => currentType.name === currentInterfaceName);
1888
- if (parent) {
1889
- parents.push(parent);
1890
- }
1891
- }
1892
- for (const parent of parents) {
1893
- let parentAsInterface = parent;
1894
- if (parentAsInterface.extended_interfaces.length) {
1895
- parentAsInterface = this.addMethodsFromParent(parentAsInterface, allTypes);
1896
- }
1897
- currentInterface.methods = [
1898
- ...currentInterface.methods,
1899
- ...this.getInheritedMethods(parentAsInterface, currentInterface)
1900
- ];
1901
- }
1902
- return currentInterface;
1903
- }
1904
- getInheritedFields(parentAsClass, currentClass) {
1905
- return parentAsClass.fields.filter((currentField) => currentField.access_modifier.toLowerCase() !== "private").filter((currentField) => !this.memberExists(currentClass.fields, currentField.name)).map((currentField) => __spreadProps$4(__spreadValues$4({}, currentField), {
1906
- inherited: true
1907
- }));
1908
- }
1909
- getInheritedProperties(parentAsClass, currentClass) {
1910
- return parentAsClass.properties.filter((currentProperty) => currentProperty.access_modifier.toLowerCase() !== "private").filter((currentProperty) => !this.memberExists(currentClass.properties, currentProperty.name)).map((currentProperty) => __spreadProps$4(__spreadValues$4({}, currentProperty), {
1911
- inherited: true
1912
- }));
1913
- }
1914
- getInheritedMethods(parentAsClass, currentClass) {
1915
- return parentAsClass.methods.filter((currentMethod) => currentMethod.access_modifier.toLowerCase() !== "private").filter((currentMethod) => !this.memberExists(currentClass.methods, currentMethod.name)).map((currentMethod) => __spreadProps$4(__spreadValues$4({}, currentMethod), {
1916
- inherited: true
1917
- }));
1918
- }
1919
- memberExists(members, fieldName) {
1920
- const fieldNames = members.map((currentMember) => currentMember.name);
1921
- return fieldNames.includes(fieldName);
1922
- }
1923
- }
1924
-
1925
- class TypesRepository {
1926
- constructor() {
1927
- this.allTypes = [];
1928
- }
1929
- static getInstance() {
1930
- if (!TypesRepository.instance) {
1931
- TypesRepository.instance = new TypesRepository();
1932
- }
1933
- return TypesRepository.instance;
1934
- }
1935
- populateAll(types) {
1936
- this.allTypes = types;
1937
- }
1938
- getFromAllByName(typeName) {
1939
- if (typeName.includes(".")) {
1940
- const [parentTypeName, childTypeName] = typeName.split(".");
1941
- const parentReference = this.allTypes.find(
1942
- (currentType) => currentType.name.toLowerCase() === parentTypeName.toLowerCase()
1943
- );
1944
- if (!parentReference || parentReference.type_name !== "class") {
1945
- return void 0;
1946
- }
1947
- const parentReferenceAsClass = parentReference;
1948
- const childTypes = [
1949
- ...parentReferenceAsClass.classes,
1950
- ...parentReferenceAsClass.interfaces,
1951
- ...parentReferenceAsClass.enums
1952
- ];
1953
- const foundType2 = childTypes.find((currentType) => currentType.name.toLowerCase() === childTypeName);
1954
- if (!foundType2) {
1955
- return void 0;
1956
- }
1957
- return { type: foundType2, isChild: true, parentType: parentReference };
1958
- }
1959
- const foundType = this.allTypes.find(
1960
- (currentType) => currentType.name.toLowerCase() === typeName.toLowerCase()
1961
- );
1962
- if (!foundType) {
1963
- return void 0;
1964
- }
1965
- return { type: foundType, isChild: false };
1966
- }
1967
- }
1968
-
1969
- class Settings {
1970
- constructor(config) {
1971
- this.config = config;
1972
- }
1973
- static build(config) {
1974
- Settings.instance = new Settings(config);
1975
- }
1976
- static getInstance() {
1977
- if (!Settings.instance) {
1978
- throw new Error("Settings has not been initialized");
1979
- }
1980
- return Settings.instance;
1981
- }
1982
- get scope() {
1983
- return this.config.scope;
1984
- }
1985
- get targetGenerator() {
1986
- return this.config.targetGenerator;
1987
- }
1988
- get indexOnly() {
1989
- return this.config.indexOnly;
1990
- }
1991
- getOpenApiTitle() {
1992
- return this.config.openApiTitle;
1993
- }
1994
- getNamespace() {
1995
- return this.config.namespace;
1996
- }
1997
- openApiFileName() {
1998
- return this.config.openApiFileName;
1999
- }
2000
- }
2001
-
2002
- class Transpiler {
2003
- static generate(types, processor) {
2004
- var _a;
2005
- const sortedTypes = types.sort((apexTypeA, apexTypeB) => {
2006
- if (apexTypeA.name < apexTypeB.name) return -1;
2007
- if (apexTypeA.name > apexTypeB.name) return 1;
2008
- return 0;
2009
- });
2010
- if (Settings.getInstance().indexOnly) {
2011
- return;
2012
- }
2013
- sortedTypes.forEach((currentType) => {
2014
- processor.onProcess(currentType);
2015
- });
2016
- (_a = processor.onAfterProcess) == null ? void 0 : _a.call(processor, sortedTypes);
2017
- }
2018
- }
2019
-
2020
- class ErrorLogger {
2021
- static logErrors(types) {
2022
- types.forEach((currentType) => {
2023
- this.logErrorsForSingleType(currentType);
2024
- });
2025
- }
2026
- static logErrorsForSingleType(currentType) {
2027
- this.logTypeErrors(currentType);
2028
- if (currentType.type_name === "class") {
2029
- this.logErrorsForClass(currentType);
2030
- } else if (currentType.type_name === "interface") {
2031
- this.logErrorsForInterface(currentType);
2032
- }
2033
- }
2034
- static logTypeErrors(currentType, parentType) {
2035
- var _a;
2036
- if ((_a = currentType.docComment) == null ? void 0 : _a.error) {
2037
- const typeName = parentType ? `${parentType.name}.${currentType.name}` : currentType.name;
2038
- Logger.error(`${typeName} - Doc comment parsing error. Level: Type`);
2039
- Logger.error(`Comment:
2040
- ${currentType.docComment.rawDeclaration}`);
2041
- Logger.error(currentType.docComment.error);
2042
- Logger.error("=================================");
2043
- }
2044
- }
2045
- static logErrorsForClass(classMirror, parentType) {
2046
- const typeName = parentType ? `${parentType.name}.${classMirror.name}` : classMirror.name;
2047
- classMirror.constructors.forEach((currentConstructor) => {
2048
- var _a;
2049
- if ((_a = currentConstructor.docComment) == null ? void 0 : _a.error) {
2050
- Logger.error(`${typeName} - Doc comment parsing error. Level: Constructor`);
2051
- Logger.error(`Comment:
2052
- ${currentConstructor.docComment.rawDeclaration}`);
2053
- Logger.error(currentConstructor.docComment.error);
2054
- Logger.error("=================================");
2055
- }
2056
- });
2057
- classMirror.fields.forEach((currentField) => {
2058
- var _a;
2059
- if ((_a = currentField.docComment) == null ? void 0 : _a.error) {
2060
- Logger.error(`${typeName} - Doc comment parsing error. Level: Field`);
2061
- Logger.error(`Comment:
2062
- ${currentField.docComment.rawDeclaration}`);
2063
- Logger.error(currentField.docComment.error);
2064
- Logger.error("=================================");
2065
- }
2066
- });
2067
- classMirror.properties.forEach((currentProperty) => {
2068
- var _a;
2069
- if ((_a = currentProperty.docComment) == null ? void 0 : _a.error) {
2070
- Logger.error(`${typeName} - Doc comment parsing error. Level: Property`);
2071
- Logger.error(`Comment:
2072
- ${currentProperty.docComment.rawDeclaration}`);
2073
- Logger.error(currentProperty.docComment.error);
2074
- Logger.error("=================================");
2075
- }
2076
- });
2077
- classMirror.methods.forEach((currentMethod) => {
2078
- var _a;
2079
- if ((_a = currentMethod.docComment) == null ? void 0 : _a.error) {
2080
- Logger.error(`${typeName} - Doc comment parsing error. Level: Method`);
2081
- Logger.error(`Comment:
2082
- ${currentMethod.docComment.rawDeclaration}`);
2083
- Logger.error(currentMethod.docComment.error);
2084
- Logger.error("=================================");
2085
- }
2086
- });
2087
- classMirror.enums.forEach((currentEnum) => {
2088
- this.logErrorsForSingleType(currentEnum);
2089
- });
2090
- classMirror.interfaces.forEach((currentInterface) => {
2091
- this.logErrorsForSingleType(currentInterface);
2092
- });
2093
- classMirror.classes.forEach((currentClass) => {
2094
- this.logErrorsForSingleType(currentClass);
2095
- });
2096
- }
2097
- static logErrorsForInterface(interfaceMirror) {
2098
- interfaceMirror.methods.forEach((currentMethod) => {
2099
- var _a;
2100
- if ((_a = currentMethod.docComment) == null ? void 0 : _a.error) {
2101
- Logger.error(`${interfaceMirror.name} - Doc comment parsing error. Level: Method`);
2102
- Logger.error(`Comment: ${currentMethod.docComment.rawDeclaration}`);
2103
- Logger.error(currentMethod.docComment.error);
2104
- Logger.error("=================================");
2105
- }
2106
- });
2107
- }
2108
- }
2109
-
2110
- class FileContainer {
2111
- constructor() {
2112
- this._files = [];
2113
- }
2114
- files() {
2115
- return this._files;
2116
- }
2117
- pushFile(file) {
2118
- this._files.push(file);
2119
- }
2120
- }
2121
-
2122
- const OPEN_API_VERSION = "3.1.0";
2123
- const SERVER_URL = "/services/apexrest/";
2124
- class OpenApi {
2125
- constructor(title, version, namespace) {
2126
- this.namespace = namespace;
2127
- this.openapi = OPEN_API_VERSION;
2128
- this.info = {
2129
- title,
2130
- version
2131
- };
2132
- this.servers = [
2133
- {
2134
- url: this.getServerUrl()
2135
- }
2136
- ];
2137
- this.paths = {};
2138
- this.tags = [];
2139
- }
2140
- getServerUrl() {
2141
- if (!this.namespace) {
2142
- return SERVER_URL;
2143
- }
2144
- return `${SERVER_URL}${this.namespace}/`;
2145
- }
2146
- }
2147
-
2148
- class ClassMirrorWrapper {
2149
- constructor(classMirror) {
2150
- this.classMirror = classMirror;
2151
- this.hasAnnotation = (method, annotationName) => method.annotations.some((annotation) => annotation.name.toLowerCase() === annotationName);
2152
- }
2153
- getMethodsByAnnotation(annotation) {
2154
- return this.classMirror.methods.filter((method) => this.hasAnnotation(method, annotation));
2155
- }
2156
- }
2157
-
2158
- var __defProp$3 = Object.defineProperty;
2159
- var __defProps$3 = Object.defineProperties;
2160
- var __getOwnPropDescs$3 = Object.getOwnPropertyDescriptors;
2161
- var __getOwnPropSymbols$3 = Object.getOwnPropertySymbols;
2162
- var __hasOwnProp$3 = Object.prototype.hasOwnProperty;
2163
- var __propIsEnum$3 = Object.prototype.propertyIsEnumerable;
2164
- var __defNormalProp$3 = (obj, key, value) => key in obj ? __defProp$3(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
2165
- var __spreadValues$3 = (a, b) => {
2166
- for (var prop in b || (b = {}))
2167
- if (__hasOwnProp$3.call(b, prop))
2168
- __defNormalProp$3(a, prop, b[prop]);
2169
- if (__getOwnPropSymbols$3)
2170
- for (var prop of __getOwnPropSymbols$3(b)) {
2171
- if (__propIsEnum$3.call(b, prop))
2172
- __defNormalProp$3(a, prop, b[prop]);
2173
- }
2174
- return a;
2175
- };
2176
- var __spreadProps$3 = (a, b) => __defProps$3(a, __getOwnPropDescs$3(b));
2177
- class ReferenceBuilder {
2178
- constructor() {
2179
- this.isReferenceString = (targetObject) => {
2180
- return typeof targetObject === "string" || targetObject instanceof String;
2181
- };
2182
- }
2183
- build(referencedTypeName) {
2184
- const originalTypeName = referencedTypeName;
2185
- const regexForSchemaOverrides = /\[(.*?)]/g;
2186
- const schemaOverrides = referencedTypeName.match(regexForSchemaOverrides);
2187
- let referenceOverrides = [];
2188
- if (schemaOverrides && schemaOverrides.length > 0) {
2189
- referenceOverrides = ReferenceOverrides.build(schemaOverrides[0]);
2190
- referencedTypeName = referencedTypeName.replace(regexForSchemaOverrides, "");
2191
- }
2192
- const [parsedReferencedType, isCollection] = this.handlePossibleCollectionReference(referencedTypeName);
2193
- const referencedTypeBundle = TypesRepository.getInstance().getFromAllByName(parsedReferencedType);
2194
- if (!referencedTypeBundle) {
2195
- throw new Error(`The referenced type ${referencedTypeName} was not found.`);
2196
- }
2197
- if (referencedTypeBundle.type.type_name !== "class") {
2198
- throw new Error(
2199
- `Expected the referenced type to be a class, but found a ${referencedTypeBundle.type.type_name}.`
2200
- );
2201
- }
2202
- const typeBundleWithIsCollection = __spreadProps$3(__spreadValues$3({}, referencedTypeBundle), {
2203
- originalTypeName,
2204
- isCollection,
2205
- referenceOverrides
2206
- });
2207
- return this.buildReferenceFromType(typeBundleWithIsCollection);
2208
- }
2209
- /**
2210
- * Returns a tuple where the first value is the name of the reference without any collection related values
2211
- * and the second is a boolean representing if we are dealing with a collection or not.
2212
- * @param referencedTypeName The received raw type name.
2213
- * @private
2214
- */
2215
- handlePossibleCollectionReference(referencedTypeName) {
2216
- referencedTypeName = referencedTypeName.toLowerCase();
2217
- if (referencedTypeName.startsWith("list<") && referencedTypeName.endsWith(">")) {
2218
- referencedTypeName = referencedTypeName.replace("list<", "");
2219
- referencedTypeName = referencedTypeName.replace(">", "");
2220
- return [referencedTypeName, true];
2221
- }
2222
- if (referencedTypeName.startsWith("set<") && referencedTypeName.endsWith(">")) {
2223
- referencedTypeName = referencedTypeName.replace("set<", "");
2224
- referencedTypeName = referencedTypeName.replace(">", "");
2225
- return [referencedTypeName, true];
2226
- }
2227
- return [referencedTypeName, false];
2228
- }
2229
- buildReferenceFromType(typeBundle) {
2230
- const propertiesAndFields = [
2231
- ...typeBundle.type.properties,
2232
- ...typeBundle.type.fields
2233
- ].filter((current) => !current.memberModifiers.includes("static")).filter((current) => !current.memberModifiers.includes("transient"));
2234
- const properties = {};
2235
- let referencedComponents = [];
2236
- propertiesAndFields.forEach((current) => {
2237
- var _a, _b;
2238
- const referenceOverride = typeBundle.referenceOverrides.find((currentOverride) => {
2239
- return currentOverride.propertyName.toLowerCase() === current.name.toLowerCase();
2240
- });
2241
- if (referenceOverride) {
2242
- const reference = this.build(referenceOverride.referenceName);
2243
- properties[current.name] = reference.entrypointReferenceObject;
2244
- reference.referenceComponents.forEach((current2) => referencedComponents.push(current2));
2245
- } else {
2246
- const manuallyDefinedHttpSchema = (_a = current.docComment) == null ? void 0 : _a.annotations.find(
2247
- (annotation) => annotation.name.toLowerCase() === "http-schema"
2248
- );
2249
- if (manuallyDefinedHttpSchema) {
2250
- this.handleOverriddenSchema(manuallyDefinedHttpSchema, properties, current, referencedComponents);
2251
- } else {
2252
- const pair = this.getReferenceType(current.typeReference);
2253
- properties[current.name] = pair.schema;
2254
- referencedComponents.push(...pair.referenceComponents);
2255
- }
2256
- }
2257
- properties[current.name].description = (_b = current.docComment) == null ? void 0 : _b.description;
2258
- });
2259
- const mainReferenceComponents = this.buildMainReferenceComponent(typeBundle, properties);
2260
- referencedComponents = [...mainReferenceComponents, ...referencedComponents];
2261
- return {
2262
- entrypointReferenceObject: {
2263
- $ref: `#/components/schemas/${this.getReferenceName(typeBundle)}`
2264
- },
2265
- referenceComponents: referencedComponents
2266
- };
2267
- }
2268
- handleOverriddenSchema(manuallyDefinedHttpSchema, properties, current, referencedComponents) {
2269
- const inYaml = manuallyDefinedHttpSchema == null ? void 0 : manuallyDefinedHttpSchema.bodyLines.reduce((prev, current2) => prev + "\n" + current2);
2270
- const asJson = yaml__namespace.load(inYaml);
2271
- const isReferenceString = this.isReferenceString(asJson);
2272
- if (isReferenceString) {
2273
- const reference = this.build(asJson);
2274
- properties[current.name] = reference.entrypointReferenceObject;
2275
- reference.referenceComponents.forEach((current2) => referencedComponents.push(current2));
2276
- } else {
2277
- properties[current.name] = asJson;
2278
- }
2279
- }
2280
- getReferenceName(typeBundle) {
2281
- var _a;
2282
- let referenceName = typeBundle.type.name;
2283
- if (typeBundle.isChild) {
2284
- referenceName = `${(_a = typeBundle.parentType) == null ? void 0 : _a.name}.${typeBundle.type.name}`;
2285
- }
2286
- if (typeBundle.isCollection) {
2287
- referenceName = `${referenceName}_array`;
2288
- }
2289
- if (typeBundle.referenceOverrides.length) {
2290
- referenceName = `${referenceName}_${typeBundle.originalTypeName}`;
2291
- }
2292
- return referenceName;
2293
- }
2294
- buildMainReferenceComponent(typeBundle, properties) {
2295
- const mainReferenceName = this.getReferenceName(__spreadProps$3(__spreadValues$3({}, typeBundle), { isCollection: false }));
2296
- const mainReference = {
2297
- referencedClass: mainReferenceName,
2298
- schema: {
2299
- type: "object",
2300
- properties
2301
- }
2302
- };
2303
- const referencedComponents = [mainReference];
2304
- if (!typeBundle.isCollection) {
2305
- return referencedComponents;
2306
- }
2307
- return [
2308
- {
2309
- referencedClass: this.getReferenceName(typeBundle),
2310
- schema: {
2311
- type: "array",
2312
- items: {
2313
- $ref: `#/components/schemas/${mainReferenceName}`
2314
- }
2315
- }
2316
- },
2317
- ...referencedComponents
2318
- ];
2319
- }
2320
- getReferenceType(typeInMirror) {
2321
- const typeName = typeInMirror.type.toLowerCase();
2322
- switch (typeName) {
2323
- case "boolean":
2324
- return { schema: { type: "boolean" }, referenceComponents: [] };
2325
- case "date":
2326
- return { schema: { type: "string", format: "date" }, referenceComponents: [] };
2327
- case "datetime":
2328
- return { schema: { type: "string", format: "date-time" }, referenceComponents: [] };
2329
- case "decimal":
2330
- return { schema: { type: "number" }, referenceComponents: [] };
2331
- case "double":
2332
- return { schema: { type: "number" }, referenceComponents: [] };
2333
- case "id":
2334
- return { schema: { type: "string" }, referenceComponents: [] };
2335
- case "integer":
2336
- return { schema: { type: "integer" }, referenceComponents: [] };
2337
- case "long":
2338
- return { schema: { type: "integer", format: "int64" }, referenceComponents: [] };
2339
- case "string":
2340
- return { schema: { type: "string" }, referenceComponents: [] };
2341
- case "time":
2342
- return { schema: { type: "string", format: "time" }, referenceComponents: [] };
2343
- case "list":
2344
- return this.buildCollectionPair(typeInMirror);
2345
- case "set":
2346
- return this.buildCollectionPair(typeInMirror);
2347
- case "map":
2348
- return { schema: { type: "object" }, referenceComponents: [] };
2349
- case "object":
2350
- return { schema: { type: "object" }, referenceComponents: [] };
2351
- default: {
2352
- const referencedType = TypesRepository.getInstance().getFromAllByName(typeName);
2353
- if (!referencedType) {
2354
- return { schema: { type: "object" }, referenceComponents: [] };
2355
- }
2356
- const reference = this.buildReferenceFromType(__spreadProps$3(__spreadValues$3({}, referencedType), {
2357
- isCollection: false,
2358
- referenceOverrides: [],
2359
- originalTypeName: typeName
2360
- }));
2361
- return {
2362
- schema: reference.entrypointReferenceObject,
2363
- referenceComponents: [...reference.referenceComponents]
2364
- };
2365
- }
2366
- }
2367
- }
2368
- buildCollectionPair(typeInMirror) {
2369
- const innerReference = this.getReferenceType(typeInMirror.ofType);
2370
- return {
2371
- schema: { type: "array", items: innerReference.schema },
2372
- referenceComponents: [...innerReference.referenceComponents]
2373
- };
2374
- }
2375
- }
2376
- class ReferenceOverrides {
2377
- static build(referenceAsString) {
2378
- const cleanedUpReference = referenceAsString.replace(/[[\]]/g, "");
2379
- const referenceStrings = cleanedUpReference.split(",").map((item) => item.replace(/\s/g, ""));
2380
- return referenceStrings.map((item) => {
2381
- const [propertyName, referenceName] = item.split(":");
2382
- return { propertyName, referenceName };
2383
- });
2384
- }
2385
- }
2386
-
2387
- class Builder {
2388
- constructor() {
2389
- this.isReferenceString = (targetObject) => {
2390
- return typeof targetObject === "string" || targetObject instanceof String;
2391
- };
2392
- }
2393
- build(schemaAware) {
2394
- let reference;
2395
- if (this.isReferenceString(schemaAware.schema)) {
2396
- reference = new ReferenceBuilder().build(schemaAware.schema);
2397
- }
2398
- return {
2399
- reference,
2400
- body: this.buildBody(schemaAware, reference)
2401
- };
2402
- }
2403
- getOpenApiSchemaFromApexDocSchema(schemaAware, reference) {
2404
- if (this.isReferenceString(schemaAware.schema)) {
2405
- return reference.entrypointReferenceObject;
2406
- }
2407
- return schemaAware.schema;
2408
- }
2409
- }
2410
-
2411
- var __defProp$2 = Object.defineProperty;
2412
- var __defProps$2 = Object.defineProperties;
2413
- var __getOwnPropDescs$2 = Object.getOwnPropertyDescriptors;
2414
- var __getOwnPropSymbols$2 = Object.getOwnPropertySymbols;
2415
- var __hasOwnProp$2 = Object.prototype.hasOwnProperty;
2416
- var __propIsEnum$2 = Object.prototype.propertyIsEnumerable;
2417
- var __defNormalProp$2 = (obj, key, value) => key in obj ? __defProp$2(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
2418
- var __spreadValues$2 = (a, b) => {
2419
- for (var prop in b || (b = {}))
2420
- if (__hasOwnProp$2.call(b, prop))
2421
- __defNormalProp$2(a, prop, b[prop]);
2422
- if (__getOwnPropSymbols$2)
2423
- for (var prop of __getOwnPropSymbols$2(b)) {
2424
- if (__propIsEnum$2.call(b, prop))
2425
- __defNormalProp$2(a, prop, b[prop]);
2426
- }
2427
- return a;
2428
- };
2429
- var __spreadProps$2 = (a, b) => __defProps$2(a, __getOwnPropDescs$2(b));
2430
- class ParameterObjectBuilder extends Builder {
2431
- buildBody(apexDocObject, reference) {
2432
- return __spreadProps$2(__spreadValues$2({}, apexDocObject), {
2433
- schema: this.getOpenApiSchemaFromApexDocSchema(apexDocObject, reference)
2434
- });
2435
- }
2436
- }
2437
-
2438
- class ResponsesBuilder extends Builder {
2439
- buildBody(apexDocResponseDefinition, reference) {
2440
- let description = `Status code ${apexDocResponseDefinition.statusCode}`;
2441
- if (apexDocResponseDefinition.description) {
2442
- description = apexDocResponseDefinition.description;
2443
- }
2444
- return {
2445
- description,
2446
- content: {
2447
- "application/json": {
2448
- schema: this.getOpenApiSchemaFromApexDocSchema(apexDocResponseDefinition, reference)
2449
- }
2450
- }
2451
- };
2452
- }
2453
- }
2454
-
2455
- class RequestBodyBuilder extends Builder {
2456
- buildBody(apexRequestBody, reference) {
2457
- return {
2458
- description: apexRequestBody.description,
2459
- content: {
2460
- "application/json": { schema: this.getOpenApiSchemaFromApexDocSchema(apexRequestBody, reference) }
2461
- },
2462
- required: apexRequestBody.required
2463
- };
2464
- }
2465
- }
2466
-
2467
- class MethodMirrorWrapper {
2468
- constructor(methodMirror) {
2469
- this.methodMirror = methodMirror;
2470
- this.hasDocCommentAnnotation = (annotationName) => {
2471
- var _a;
2472
- return (_a = this.methodMirror.docComment) == null ? void 0 : _a.annotations.some((annotation) => annotation.name.toLowerCase() === annotationName);
2473
- };
2474
- this.getDocCommentAnnotation = (annotationName) => {
2475
- var _a;
2476
- return (_a = this.methodMirror.docComment) == null ? void 0 : _a.annotations.find((annotation) => annotation.name.toLowerCase() === annotationName);
2477
- };
2478
- }
2479
- }
2480
-
2481
- class MethodParser {
2482
- constructor(openApiModel) {
2483
- this.openApiModel = openApiModel;
2484
- }
2485
- parseMethod(classMirror, httpUrlEndpoint, httpMethodKey, tag) {
2486
- var _a, _b;
2487
- const classMirrorWrapper = new ClassMirrorWrapper(classMirror);
2488
- const httpMethods = classMirrorWrapper.getMethodsByAnnotation(`http${httpMethodKey}`);
2489
- if (!httpMethods.length) {
2490
- return;
2491
- }
2492
- const httpMethod = httpMethods[0];
2493
- this.openApiModel.paths[httpUrlEndpoint][httpMethodKey] = {};
2494
- this.openApiModel.paths[httpUrlEndpoint][httpMethodKey].tags = [tag];
2495
- if ((_a = httpMethod.docComment) == null ? void 0 : _a.description) {
2496
- this.openApiModel.paths[httpUrlEndpoint][httpMethodKey].description = httpMethod.docComment.description;
2497
- }
2498
- const methodMirrorWrapper = new MethodMirrorWrapper(httpMethod);
2499
- if (methodMirrorWrapper.hasDocCommentAnnotation("summary")) {
2500
- this.openApiModel.paths[httpUrlEndpoint][httpMethodKey].summary = (_b = methodMirrorWrapper.getDocCommentAnnotation("summary")) == null ? void 0 : _b.body;
2501
- }
2502
- this.parseHttpAnnotation(
2503
- httpMethod,
2504
- httpUrlEndpoint,
2505
- httpMethodKey,
2506
- "http-request-body",
2507
- this.addRequestBodyToOpenApi.bind(this),
2508
- this.fallbackHttpRequestBodyParser(httpUrlEndpoint, httpMethodKey)
2509
- );
2510
- this.parseHttpAnnotation(
2511
- httpMethod,
2512
- httpUrlEndpoint,
2513
- httpMethodKey,
2514
- "http-parameter",
2515
- this.addParametersToOpenApi.bind(this)
2516
- );
2517
- this.parseHttpAnnotation(
2518
- httpMethod,
2519
- httpUrlEndpoint,
2520
- httpMethodKey,
2521
- "http-response",
2522
- this.addHttpResponsesToOpenApi.bind(this),
2523
- this.getFallbackHttpResponseParser(httpUrlEndpoint, httpMethodKey)
2524
- );
2525
- }
2526
- parseHttpAnnotation(httpMethod, urlValue, httpMethodKey, annotationName, addToOpenApi, fallbackParser) {
2527
- var _a;
2528
- const annotations = (_a = httpMethod.docComment) == null ? void 0 : _a.annotations.filter((annotation) => annotation.name === annotationName);
2529
- if (!(annotations == null ? void 0 : annotations.length)) {
2530
- if (fallbackParser) {
2531
- fallbackParser(httpMethod);
2532
- }
2533
- return;
2534
- }
2535
- for (const annotation of annotations) {
2536
- const inYaml = annotation == null ? void 0 : annotation.bodyLines.reduce((prev, current) => prev + "\n" + current);
2537
- if (!inYaml) {
2538
- return;
2539
- }
2540
- this.addToOpenApiStrategy(inYaml, urlValue, httpMethodKey, addToOpenApi);
2541
- }
2542
- }
2543
- addToOpenApiStrategy(inYaml, urlValue, httpMethodKey, addToOpenApi) {
2544
- const inJson = yaml__namespace.load(inYaml);
2545
- const requestBodyResponse = new RequestBodyBuilder().build(inJson);
2546
- addToOpenApi(inJson, urlValue, httpMethodKey);
2547
- this.addReference(requestBodyResponse);
2548
- }
2549
- addRequestBodyToOpenApi(input, urlValue, httpMethodKey) {
2550
- const requestBodyResponse = new RequestBodyBuilder().build(input);
2551
- this.openApiModel.paths[urlValue][httpMethodKey].requestBody = requestBodyResponse.body;
2552
- }
2553
- addParametersToOpenApi(input, urlValue, httpMethodKey) {
2554
- const parameterObjectResponse = new ParameterObjectBuilder().build(input);
2555
- if (this.openApiModel.paths[urlValue][httpMethodKey].parameters === void 0) {
2556
- this.openApiModel.paths[urlValue][httpMethodKey].parameters = [];
2557
- }
2558
- this.openApiModel.paths[urlValue][httpMethodKey].parameters.push(parameterObjectResponse.body);
2559
- }
2560
- addHttpResponsesToOpenApi(input, urlValue, httpMethodKey) {
2561
- const responseObjectResponse = new ResponsesBuilder().build(input);
2562
- if (this.openApiModel.paths[urlValue][httpMethodKey].responses === void 0) {
2563
- this.openApiModel.paths[urlValue][httpMethodKey].responses = {};
2564
- }
2565
- this.openApiModel.paths[urlValue][httpMethodKey].responses[input.statusCode] = responseObjectResponse.body;
2566
- }
2567
- fallbackHttpRequestBodyParser(httpUrlEndpoint, httpMethodKey) {
2568
- return (methodMirror) => {
2569
- const parameters = methodMirror.parameters;
2570
- if (!parameters.length) {
2571
- return;
2572
- }
2573
- const propertiesObject = {};
2574
- parameters.forEach((currentParameter) => {
2575
- const propertyKey = currentParameter.name;
2576
- const propertyReference = new ReferenceBuilder().getReferenceType(currentParameter.typeReference);
2577
- propertiesObject[propertyKey] = propertyReference.schema;
2578
- this.addReference({
2579
- reference: {
2580
- entrypointReferenceObject: propertyReference.schema,
2581
- referenceComponents: propertyReference.referenceComponents
2582
- }
2583
- });
2584
- });
2585
- this.openApiModel.paths[httpUrlEndpoint][httpMethodKey].requestBody = {
2586
- content: {
2587
- "application/json": {
2588
- schema: {
2589
- type: "object",
2590
- properties: propertiesObject
2591
- }
2592
- }
2593
- }
2594
- };
2595
- };
2596
- }
2597
- getFallbackHttpResponseParser(httpUrlEndpoint, httpMethodKey) {
2598
- return (methodMirror) => {
2599
- var _a, _b;
2600
- const returnType = methodMirror.typeReference;
2601
- if (returnType.type.toLowerCase() === "void") {
2602
- return;
2603
- }
2604
- const reference = new ReferenceBuilder().getReferenceType(returnType);
2605
- this.addReference({
2606
- reference: {
2607
- entrypointReferenceObject: reference.schema,
2608
- referenceComponents: reference.referenceComponents
2609
- }
2610
- });
2611
- if (this.openApiModel.paths[httpUrlEndpoint][httpMethodKey].responses === void 0) {
2612
- this.openApiModel.paths[httpUrlEndpoint][httpMethodKey].responses = {};
2613
- }
2614
- this.openApiModel.paths[httpUrlEndpoint][httpMethodKey].responses["200"] = {
2615
- description: (_b = (_a = methodMirror.docComment) == null ? void 0 : _a.description) != null ? _b : "Status code 200",
2616
- content: {
2617
- "application/json": { schema: reference.schema }
2618
- }
2619
- };
2620
- };
2621
- }
2622
- addReference(referenceHolder) {
2623
- if (referenceHolder.reference) {
2624
- if (this.openApiModel.components === void 0) {
2625
- this.openApiModel.components = {
2626
- schemas: {}
2627
- };
2628
- }
2629
- if (!referenceHolder.reference.referenceComponents.length) {
2630
- return;
2631
- }
2632
- referenceHolder.reference.referenceComponents.forEach((current) => {
2633
- this.openApiModel.components.schemas[current.referencedClass] = current.schema;
2634
- });
2635
- }
2636
- }
2637
- }
2638
-
2639
- const camel2title = (camelCase) => camelCase.replace(/\//g, " ").replace(/([A-Z])/g, (match) => ` ${match}`).replace(/\b\w/g, (match) => match.toUpperCase()).replace(/^./, (match) => match.toUpperCase()).trim();
2640
-
2641
- var __defProp$1 = Object.defineProperty;
2642
- var __defProps$1 = Object.defineProperties;
2643
- var __getOwnPropDescs$1 = Object.getOwnPropertyDescriptors;
2644
- var __getOwnPropSymbols$1 = Object.getOwnPropertySymbols;
2645
- var __hasOwnProp$1 = Object.prototype.hasOwnProperty;
2646
- var __propIsEnum$1 = Object.prototype.propertyIsEnumerable;
2647
- var __defNormalProp$1 = (obj, key, value) => key in obj ? __defProp$1(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
2648
- var __spreadValues$1 = (a, b) => {
2649
- for (var prop in b || (b = {}))
2650
- if (__hasOwnProp$1.call(b, prop))
2651
- __defNormalProp$1(a, prop, b[prop]);
2652
- if (__getOwnPropSymbols$1)
2653
- for (var prop of __getOwnPropSymbols$1(b)) {
2654
- if (__propIsEnum$1.call(b, prop))
2655
- __defNormalProp$1(a, prop, b[prop]);
2656
- }
2657
- return a;
2658
- };
2659
- var __spreadProps$1 = (a, b) => __defProps$1(a, __getOwnPropDescs$1(b));
2660
- function createOpenApiFile(fileName, openApiModel) {
2661
- const content = JSON.stringify(__spreadProps$1(__spreadValues$1({}, openApiModel), { namespace: void 0 }), null, 2);
2662
- return {
2663
- fileExtension: "json",
2664
- fileName,
2665
- directory: "",
2666
- content,
2667
- frontmatter: null,
2668
- group: null
2669
- };
2670
- }
2671
-
2672
- class OpenApiDocsProcessor {
2673
- constructor() {
2674
- this.onAfterProcess = () => {
2675
- const page = createOpenApiFile(Settings.getInstance().openApiFileName(), this.openApiModel);
2676
- this._fileContainer.pushFile(page);
2677
- };
2678
- this._fileContainer = new FileContainer();
2679
- const title = Settings.getInstance().getOpenApiTitle();
2680
- if (!title) {
2681
- throw Error("No OpenApi title was provided.");
2682
- }
2683
- this.openApiModel = new OpenApi(title, "1.0.0", Settings.getInstance().getNamespace());
2684
- }
2685
- fileBuilder() {
2686
- return this._fileContainer;
2687
- }
2688
- onProcess(type) {
2689
- var _a, _b;
2690
- Logger.logSingle(`Processing ${type.name}`, false, "green", false);
2691
- const endpointPath = this.getEndpointPath(type);
2692
- if (!endpointPath) {
2693
- return;
2694
- }
2695
- this.openApiModel.paths[endpointPath] = {};
2696
- if ((_a = type.docComment) == null ? void 0 : _a.description) {
2697
- this.openApiModel.paths[endpointPath].description = type.docComment.description;
2698
- }
2699
- const typeAsClass = type;
2700
- const tagName = camel2title(endpointPath);
2701
- this.openApiModel.tags.push({
2702
- name: tagName,
2703
- description: (_b = type.docComment) == null ? void 0 : _b.description
2704
- });
2705
- const parser = new MethodParser(this.openApiModel);
2706
- parser.parseMethod(typeAsClass, endpointPath, "get", tagName);
2707
- parser.parseMethod(typeAsClass, endpointPath, "patch", tagName);
2708
- parser.parseMethod(typeAsClass, endpointPath, "post", tagName);
2709
- parser.parseMethod(typeAsClass, endpointPath, "put", tagName);
2710
- parser.parseMethod(typeAsClass, endpointPath, "delete", tagName);
2711
- }
2712
- getEndpointPath(type) {
2713
- var _a;
2714
- const restResourceAnnotation = type.annotations.find((element) => element.name.toLowerCase() === "restresource");
2715
- const urlMapping = (_a = restResourceAnnotation == null ? void 0 : restResourceAnnotation.elementValues) == null ? void 0 : _a.find(
2716
- (element) => element.key.toLowerCase() === "urlmapping"
2717
- );
2718
- if (!urlMapping) {
2719
- Logger.error(`Type does not contain urlMapping annotation ${type.name}`);
2720
- return null;
2721
- }
2722
- let endpointPath = urlMapping.value.replaceAll('"', "").replaceAll("'", "").replaceAll("/*", "/");
2723
- if (endpointPath.startsWith("/")) {
2724
- endpointPath = endpointPath.substring(1);
2725
- }
2726
- return endpointPath;
2727
- }
2728
- }
2729
-
2730
- function openApi(fileBodies, config) {
2731
- const manifest = createManifest(new RawBodyParser(fileBodies), reflectionWithLogger);
2732
- TypesRepository.getInstance().populateAll(manifest.types);
2733
- const filteredTypes = filterByScopes(manifest);
2734
- const processor = new OpenApiDocsProcessor();
2735
- Transpiler.generate(filteredTypes, processor);
2736
- const generatedFiles = processor.fileBuilder().files();
2737
- FileWriter.write(generatedFiles, config.targetDir, (file) => {
2738
- Logger.logSingle(`${file.fileName} processed.`, false, "green", false);
2739
- });
2740
- ErrorLogger.logErrors(filteredTypes);
2741
- }
2742
- function reflectionWithLogger(apexBundle) {
2743
- var _a;
2744
- const result = apexReflection.reflect(apexBundle.content);
2745
- if (result.error) {
2746
- Logger.error(`${apexBundle.filePath} - Parsing error ${(_a = result.error) == null ? void 0 : _a.message}`);
2747
- }
2748
- return result;
2749
- }
2750
- function filterByScopes(manifest) {
2751
- const filteredTypes = manifest.filteredByAccessModifierAndAnnotations([
2752
- "restresource",
2753
- "httpdelete",
2754
- "httpget",
2755
- "httppatch",
2756
- "httppost",
2757
- "httpput"
2758
- ]);
2759
- const filteredLogMessage = `Filtered ${manifest.types.length - filteredTypes.length} file(s), only keeping classes annotated as @RestResource.`;
2760
- Logger.clear();
2761
- Logger.logSingle(filteredLogMessage, false, "green", false);
2762
- Logger.logSingle(`Creating documentation for ${filteredTypes.length} file(s)`, false, "green", false);
2763
- return filteredTypes;
2764
- }
2765
-
2766
- const APEX_FILE_EXTENSION = ".cls";
2767
- class ApexFileReader {
2768
- /**
2769
- * Reads from .cls files and returns their raw body.
2770
- */
2771
- static processFiles(fileSystem, rootPath, includeMetadata) {
2772
- let bundles = [];
2773
- const directoryContents = fileSystem.readDirectory(rootPath);
2774
- directoryContents.forEach((filePath) => {
2775
- const currentPath = fileSystem.joinPath(rootPath, filePath);
2776
- if (fileSystem.isDirectory(currentPath)) {
2777
- bundles = bundles.concat(this.processFiles(fileSystem, currentPath, includeMetadata));
2778
- }
2779
- if (!this.isApexFile(filePath)) {
2780
- return;
2781
- }
2782
- const rawTypeContent = fileSystem.readFile(currentPath);
2783
- const metadataPath = fileSystem.joinPath(rootPath, `${filePath}-meta.xml`);
2784
- let rawMetadataContent = null;
2785
- if (includeMetadata) {
2786
- rawMetadataContent = fileSystem.exists(metadataPath) ? fileSystem.readFile(metadataPath) : null;
2787
- }
2788
- bundles.push({ filePath: currentPath, content: rawTypeContent, metadataContent: rawMetadataContent });
2789
- });
2790
- return bundles;
2791
- }
2792
- static isApexFile(currentFile) {
2793
- return currentFile.endsWith(APEX_FILE_EXTENSION);
2794
- }
2795
- }
2796
-
2797
- class DefaultFileSystem {
2798
- isDirectory(pathToRead) {
2799
- return fs__namespace.statSync(pathToRead).isDirectory();
2800
- }
2801
- readDirectory(sourceDirectory) {
2802
- return fs__namespace.readdirSync(sourceDirectory);
2803
- }
2804
- readFile(pathToRead) {
2805
- const rawFile = fs__namespace.readFileSync(pathToRead);
2806
- return rawFile.toString();
2807
- }
2808
- joinPath(...paths) {
2809
- return path__namespace.join(...paths);
2810
- }
2811
- exists(path2) {
2812
- return fs__namespace.existsSync(path2);
2813
- }
2814
- }
2815
-
2816
- var __async$1 = (__this, __arguments, generator) => {
2817
- return new Promise((resolve, reject) => {
2818
- var fulfilled = (value) => {
2819
- try {
2820
- step(generator.next(value));
2821
- } catch (e) {
2822
- reject(e);
2823
- }
2824
- };
2825
- var rejected = (value) => {
2826
- try {
2827
- step(generator.throw(value));
2828
- } catch (e) {
2829
- reject(e);
2830
- }
2831
- };
2832
- var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
2833
- step((generator = generator.apply(__this, __arguments)).next());
2834
- });
2835
- };
2836
- class Apexdocs {
2837
- /**
2838
- * Generates documentation out of Apex source files.
2839
- */
2840
- static generate(config) {
2841
- return __async$1(this, null, function* () {
2842
- Logger.logSingle("Initializing...", false);
2843
- const fileBodies = ApexFileReader.processFiles(new DefaultFileSystem(), config.sourceDir, config.includeMetadata);
2844
- switch (config.targetGenerator) {
2845
- case "markdown":
2846
- yield generate(fileBodies, config);
2847
- break;
2848
- case "openapi":
2849
- openApi(fileBodies, config);
2850
- break;
2851
- }
2852
- });
2853
- }
2854
- }
2855
-
2856
- const markdownOptions = {
2857
- sourceDir: {
2858
- type: "string",
2859
- alias: "s",
2860
- demandOption: true,
2861
- describe: "The directory location which contains your apex .cls classes."
2862
- },
2863
- targetDir: {
2864
- type: "string",
2865
- alias: "t",
2866
- default: defaults.defaults.targetDir,
2867
- describe: "The directory location where documentation will be generated to."
2868
- },
2869
- scope: {
2870
- type: "string",
2871
- array: true,
2872
- alias: "p",
2873
- default: defaults.defaults.scope,
2874
- describe: "A list of scopes to document. Values should be separated by a space, e.g --scope global public namespaceaccessible. Annotations are supported and should be passed lowercased and without the @ symbol, e.g. namespaceaccessible auraenabled. Note that this setting is ignored if generating an OpenApi REST specification since that looks for classes annotated with @RestResource."
2875
- },
2876
- defaultGroupName: {
2877
- type: "string",
2878
- default: defaults.defaults.defaultGroupName,
2879
- describe: "Defines the @group name to be used when a file does not specify it."
2880
- },
2881
- openApiTitle: {
2882
- type: "string",
2883
- default: "Apex REST Api",
2884
- describe: 'If using "openapi" as the target generator, this allows you to specify the OpenApi title value.'
2885
- },
2886
- namespace: {
2887
- type: "string",
2888
- describe: "The package namespace, if any. If this value is provided the namespace will be added as a prefix to all of the parsed files. If generating an OpenApi definition, it will be added to the file's Server Url."
2889
- },
2890
- openApiFileName: {
2891
- type: "string",
2892
- describe: 'If using "openapi" as the target generator, this allows you to specify the name of the output file.',
2893
- default: "openapi"
2894
- },
2895
- sortMembersAlphabetically: {
2896
- type: "boolean",
2897
- describe: "Whether to sort members alphabetically.",
2898
- default: defaults.defaults.sortMembersAlphabetically
2899
- },
2900
- includeMetadata: {
2901
- type: "boolean",
2902
- describe: "Whether to include the file's meta.xml information: Whether it is active and and the API version",
2903
- default: defaults.defaults.includeMetadata
2904
- }
2905
- };
2906
-
2907
- var __defProp = Object.defineProperty;
2908
- var __defProps = Object.defineProperties;
2909
- var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
2910
- var __getOwnPropSymbols = Object.getOwnPropertySymbols;
2911
- var __hasOwnProp = Object.prototype.hasOwnProperty;
2912
- var __propIsEnum = Object.prototype.propertyIsEnumerable;
2913
- var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
2914
- var __spreadValues = (a, b) => {
2915
- for (var prop in b || (b = {}))
2916
- if (__hasOwnProp.call(b, prop))
2917
- __defNormalProp(a, prop, b[prop]);
2918
- if (__getOwnPropSymbols)
2919
- for (var prop of __getOwnPropSymbols(b)) {
2920
- if (__propIsEnum.call(b, prop))
2921
- __defNormalProp(a, prop, b[prop]);
2922
- }
2923
- return a;
2924
- };
2925
- var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
2926
- var __async = (__this, __arguments, generator) => {
2927
- return new Promise((resolve, reject) => {
2928
- var fulfilled = (value) => {
2929
- try {
2930
- step(generator.next(value));
2931
- } catch (e) {
2932
- reject(e);
2933
- }
2934
- };
2935
- var rejected = (value) => {
2936
- try {
2937
- step(generator.throw(value));
2938
- } catch (e) {
2939
- reject(e);
2940
- }
2941
- };
2942
- var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
2943
- step((generator = generator.apply(__this, __arguments)).next());
2944
- });
2945
- };
2946
- function _extractConfig() {
2947
- return cosmiconfig.cosmiconfig("apexdocs", {
2948
- loaders: {
2949
- ".ts": cosmiconfigTypescriptLoader.TypeScriptLoader()
2950
- }
2951
- }).search();
2952
- }
2953
- function _extractYargs(config) {
2954
- return yargs__namespace.config(config == null ? void 0 : config.config).command(
2955
- "markdown",
2956
- "Generate documentation from Apex classes as a Markdown site.",
2957
- (yargs2) => yargs2.options(markdownOptions)
2958
- ).command("openapi", "Generate an OpenApi REST specification from Apex classes.").demandCommand().parseSync();
2959
- }
2960
- function extractArgs() {
2961
- return __async(this, null, function* () {
2962
- const config = yield _extractConfig();
2963
- const cliArgs = _extractYargs(config);
2964
- const commandName = cliArgs._[0];
2965
- return __spreadProps(__spreadValues(__spreadValues({}, config == null ? void 0 : config.config), cliArgs), { targetGenerator: commandName });
2966
- });
2967
- }
2968
-
2969
- function main() {
2970
- function cathError(error) {
2971
- console.error(error);
2972
- process.exit(1);
2973
- }
2974
- extractArgs().then((config) => Apexdocs.generate(config).catch(cathError)).catch(cathError);
2975
- }
2976
- main();