@cparra/apexdocs 2.24.0 → 2.25.0-alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (375) hide show
  1. package/.github/workflows/ci.yaml +22 -0
  2. package/.github/workflows/close_stale.yml +22 -22
  3. package/.prettierrc.js +7 -7
  4. package/LICENSE +21 -21
  5. package/README.md +742 -718
  6. package/__mocks__/chalk.js +12 -0
  7. package/__mocks__/log-update.js +6 -0
  8. package/apexdocs.config.ts +13 -13
  9. package/docs/{README.md → __old/README.md} +1 -1
  10. package/docs/{restapi.json → __old/restapi.json} +589 -589
  11. package/docs/{types → __old/types}/Classes/nspc.ChildClass.md +97 -97
  12. package/docs/{types → __old/types}/Main/nspc.SampleClass.md +189 -189
  13. package/eslint.config.mjs +10 -0
  14. package/examples/force-app/main/default/classes/AnotherInterface.cls +16 -16
  15. package/examples/force-app/main/default/classes/ChildClass.cls +42 -42
  16. package/examples/force-app/main/default/classes/EscapedAnnotations.cls +5 -5
  17. package/examples/force-app/main/default/classes/GrandparentClass.cls +4 -4
  18. package/examples/force-app/main/default/classes/GroupedClass.cls +8 -8
  19. package/examples/force-app/main/default/classes/MemberGrouping.cls +17 -17
  20. package/examples/force-app/main/default/classes/ParentClass.cls +16 -16
  21. package/examples/force-app/main/default/classes/SampleClass.cls +166 -166
  22. package/examples/force-app/main/default/classes/SampleClass.cls-meta.xml +5 -5
  23. package/examples/force-app/main/default/classes/SampleClassWithoutModifier.cls +9 -9
  24. package/examples/force-app/main/default/classes/SampleInterface.cls +16 -16
  25. package/examples/force-app/main/default/restapi/SampleRestResource.cls +195 -195
  26. package/examples/force-app/main/default/restapi/SampleRestResourceToSkip.cls +35 -35
  27. package/examples/force-app/main/default/restapi/SampleRestResourceWithInnerClass.cls +24 -24
  28. package/examples/force-app/main/default/restapi/SampleRestResourceWithoutApexDocs.cls +15 -15
  29. package/examples/force-app/main/default/restapi/references/Reference1.cls +9 -9
  30. package/examples/force-app/main/default/restapi/references/Reference2.cls +9 -9
  31. package/examples/force-app/main/default/restapi/references/Reference3.cls +3 -3
  32. package/examples/force-app/main/default/restapi/references/Reference4.cls +3 -3
  33. package/examples/force-app/main/default/restapi/references/Reference5.cls +3 -3
  34. package/examples/force-app/main/default/restapi/references/Reference6.cls +6 -6
  35. package/examples/force-app/main/default/restapi/references/Reference7.cls +3 -3
  36. package/examples/includes/header.md +3 -3
  37. package/examples/plain-markdown/.forceignore +12 -0
  38. package/examples/plain-markdown/config/project-scratch-def.json +5 -0
  39. package/examples/plain-markdown/docs/Miscellaneous/ns.BaseClass.md +16 -0
  40. package/examples/plain-markdown/docs/Miscellaneous/ns.ParentInterface.md +15 -0
  41. package/examples/plain-markdown/docs/Miscellaneous/ns.ReferencedEnum.md +8 -0
  42. package/examples/plain-markdown/docs/Miscellaneous/ns.SampleException.md +7 -0
  43. package/examples/plain-markdown/docs/Miscellaneous/ns.SampleInterface.md +115 -0
  44. package/examples/plain-markdown/docs/Sample-Enums/ns.SampleEnum.md +36 -0
  45. package/examples/plain-markdown/docs/SampleGroup/ns.SampleClass.md +173 -0
  46. package/examples/plain-markdown/docs/index.md +36 -0
  47. package/examples/plain-markdown/force-app/classes/BaseClass.cls +3 -0
  48. package/examples/plain-markdown/force-app/classes/ParentInterface.cls +3 -0
  49. package/examples/plain-markdown/force-app/classes/ReferencedEnum.cls +3 -0
  50. package/examples/plain-markdown/force-app/classes/SampleClass.cls +72 -0
  51. package/examples/plain-markdown/force-app/classes/SampleEnum.cls +30 -0
  52. package/examples/plain-markdown/force-app/classes/SampleException.cls +1 -0
  53. package/examples/plain-markdown/force-app/classes/SampleInterface.cls +46 -0
  54. package/examples/plain-markdown/package-lock.json +665 -0
  55. package/examples/plain-markdown/package.json +20 -0
  56. package/examples/plain-markdown/sfdx-project.json +12 -0
  57. package/examples/plain-markdown/template.md +3 -0
  58. package/jest.config.js +9 -5
  59. package/jest.d.ts +7 -0
  60. package/lib/__spec__/core/expect-extensions.d.ts +3 -0
  61. package/lib/__spec__/core/expect-extensions.js +54 -0
  62. package/lib/__spec__/core/expect-extensions.js.map +1 -0
  63. package/lib/__spec__/core/generating-class-docs.spec.d.ts +1 -0
  64. package/lib/__spec__/core/generating-class-docs.spec.js +427 -0
  65. package/lib/__spec__/core/generating-class-docs.spec.js.map +1 -0
  66. package/lib/__spec__/core/generating-enum-docs.spec.d.ts +1 -0
  67. package/lib/__spec__/core/generating-enum-docs.spec.js +303 -0
  68. package/lib/__spec__/core/generating-enum-docs.spec.js.map +1 -0
  69. package/lib/__spec__/core/generating-interface-docs.spec.d.ts +1 -0
  70. package/lib/__spec__/core/generating-interface-docs.spec.js +361 -0
  71. package/lib/__spec__/core/generating-interface-docs.spec.js.map +1 -0
  72. package/lib/__spec__/core/generating-reference-guide.spec.d.ts +1 -0
  73. package/lib/__spec__/core/generating-reference-guide.spec.js +161 -0
  74. package/lib/__spec__/core/generating-reference-guide.spec.js.map +1 -0
  75. package/lib/adapters/apex-types.d.ts +7 -0
  76. package/lib/adapters/apex-types.js +112 -0
  77. package/lib/adapters/apex-types.js.map +1 -0
  78. package/lib/adapters/documentables.d.ts +7 -0
  79. package/lib/adapters/documentables.js +56 -0
  80. package/lib/adapters/documentables.js.map +1 -0
  81. package/lib/adapters/fields-and-properties.d.ts +4 -0
  82. package/lib/adapters/fields-and-properties.js +32 -0
  83. package/lib/adapters/fields-and-properties.js.map +1 -0
  84. package/lib/adapters/methods-and-constructors.d.ts +5 -0
  85. package/lib/adapters/methods-and-constructors.js +92 -0
  86. package/lib/adapters/methods-and-constructors.js.map +1 -0
  87. package/lib/adapters/references.d.ts +5 -0
  88. package/lib/adapters/references.js +82 -0
  89. package/lib/adapters/references.js.map +1 -0
  90. package/lib/adapters/type-utils.d.ts +2 -0
  91. package/lib/adapters/type-utils.js +7 -0
  92. package/lib/adapters/type-utils.js.map +1 -0
  93. package/lib/application/Apexdocs.d.ts +13 -13
  94. package/lib/application/Apexdocs.js +79 -76
  95. package/lib/application/Apexdocs.js.map +1 -1
  96. package/lib/cli/generate.d.ts +2 -2
  97. package/lib/cli/generate.js +156 -130
  98. package/lib/cli/generate.js.map +1 -1
  99. package/lib/core/generate-docs.d.ts +23 -0
  100. package/lib/core/generate-docs.js +241 -0
  101. package/lib/core/generate-docs.js.map +1 -0
  102. package/lib/core/template.d.ts +10 -0
  103. package/lib/core/template.js +92 -0
  104. package/lib/core/template.js.map +1 -0
  105. package/lib/core/templates/reference-guide.d.ts +1 -0
  106. package/lib/core/templates/reference-guide.js +18 -0
  107. package/lib/core/templates/reference-guide.js.map +1 -0
  108. package/lib/index.d.ts +2 -1
  109. package/lib/index.js +28 -17
  110. package/lib/index.js.map +1 -1
  111. package/lib/model/apex-bundle.d.ts +6 -6
  112. package/lib/model/apex-bundle.js +10 -10
  113. package/lib/model/apex-type-wrappers/ClassMirrorWrapper.d.ts +7 -7
  114. package/lib/model/apex-type-wrappers/ClassMirrorWrapper.js +13 -13
  115. package/lib/model/apex-type-wrappers/MethodMirrorWrapper.d.ts +7 -7
  116. package/lib/model/apex-type-wrappers/MethodMirrorWrapper.js +11 -11
  117. package/lib/model/inheritance.d.ts +8 -8
  118. package/lib/model/inheritance.js +2 -2
  119. package/lib/model/manifest.d.ts +22 -22
  120. package/lib/model/manifest.js +52 -46
  121. package/lib/model/manifest.js.map +1 -1
  122. package/lib/model/markdown-file.d.ts +16 -16
  123. package/lib/model/markdown-file.js +110 -106
  124. package/lib/model/markdown-file.js.map +1 -1
  125. package/lib/model/markdown-generation-util/doc-comment-annotation-util.d.ts +8 -8
  126. package/lib/model/markdown-generation-util/doc-comment-annotation-util.js +45 -43
  127. package/lib/model/markdown-generation-util/doc-comment-annotation-util.js.map +1 -1
  128. package/lib/model/markdown-generation-util/field-declaration-util.d.ts +3 -3
  129. package/lib/model/markdown-generation-util/field-declaration-util.js +53 -54
  130. package/lib/model/markdown-generation-util/field-declaration-util.js.map +1 -1
  131. package/lib/model/markdown-generation-util/index.d.ts +3 -3
  132. package/lib/model/markdown-generation-util/index.js +19 -19
  133. package/lib/model/markdown-generation-util/method-declaration-util.d.ts +4 -4
  134. package/lib/model/markdown-generation-util/method-declaration-util.js +113 -114
  135. package/lib/model/markdown-generation-util/method-declaration-util.js.map +1 -1
  136. package/lib/model/markdown-generation-util/type-declaration-util.d.ts +3 -3
  137. package/lib/model/markdown-generation-util/type-declaration-util.js +80 -81
  138. package/lib/model/markdown-generation-util/type-declaration-util.js.map +1 -1
  139. package/lib/model/markdown-home-file.d.ts +11 -11
  140. package/lib/model/markdown-home-file.js +56 -53
  141. package/lib/model/markdown-home-file.js.map +1 -1
  142. package/lib/model/markdown-type-file.d.ts +26 -26
  143. package/lib/model/markdown-type-file.js +136 -133
  144. package/lib/model/markdown-type-file.js.map +1 -1
  145. package/lib/model/openapi/apex-doc-types.d.ts +19 -19
  146. package/lib/model/openapi/apex-doc-types.js +4 -4
  147. package/lib/model/openapi/open-api-types.d.ts +93 -93
  148. package/lib/model/openapi/open-api-types.js +2 -2
  149. package/lib/model/openapi/open-api.d.ts +16 -16
  150. package/lib/model/openapi/open-api.js +33 -33
  151. package/lib/model/openapi/open-api.js.map +1 -1
  152. package/lib/model/openapi/openapi-type-file.d.ts +7 -7
  153. package/lib/model/openapi/openapi-type-file.js +16 -16
  154. package/lib/model/outputFile.d.ts +10 -10
  155. package/lib/model/outputFile.js +21 -28
  156. package/lib/model/outputFile.js.map +1 -1
  157. package/lib/model/types-repository.d.ts +16 -16
  158. package/lib/model/types-repository.js +53 -53
  159. package/lib/model/types-repository.js.map +1 -1
  160. package/lib/service/apex-file-reader.d.ts +14 -14
  161. package/lib/service/apex-file-reader.js +48 -45
  162. package/lib/service/apex-file-reader.js.map +1 -1
  163. package/lib/service/file-system.d.ts +14 -14
  164. package/lib/service/file-system.js +47 -24
  165. package/lib/service/file-system.js.map +1 -1
  166. package/lib/service/file-writer.d.ts +6 -6
  167. package/lib/service/file-writer.js +56 -33
  168. package/lib/service/file-writer.js.map +1 -1
  169. package/lib/service/manifest-factory.d.ts +10 -10
  170. package/lib/service/manifest-factory.js +15 -13
  171. package/lib/service/manifest-factory.js.map +1 -1
  172. package/lib/service/metadata-processor.d.ts +3 -3
  173. package/lib/service/metadata-processor.js +16 -16
  174. package/lib/service/metadata-processor.js.map +1 -1
  175. package/lib/service/parser.d.ts +21 -21
  176. package/lib/service/parser.js +137 -134
  177. package/lib/service/parser.js.map +1 -1
  178. package/lib/service/state.d.ts +9 -9
  179. package/lib/service/state.js +19 -19
  180. package/lib/service/state.js.map +1 -1
  181. package/lib/service/walkers/class-walker.d.ts +4 -4
  182. package/lib/service/walkers/class-walker.js +32 -32
  183. package/lib/service/walkers/class-walker.js.map +1 -1
  184. package/lib/service/walkers/enum-walker.d.ts +4 -4
  185. package/lib/service/walkers/enum-walker.js +10 -10
  186. package/lib/service/walkers/interface-walker.d.ts +4 -4
  187. package/lib/service/walkers/interface-walker.js +14 -14
  188. package/lib/service/walkers/interface-walker.js.map +1 -1
  189. package/lib/service/walkers/walker-factory.d.ts +5 -5
  190. package/lib/service/walkers/walker-factory.js +20 -20
  191. package/lib/service/walkers/walker-factory.js.map +1 -1
  192. package/lib/service/walkers/walker.d.ts +19 -19
  193. package/lib/service/walkers/walker.js +16 -16
  194. package/lib/service/walkers/walker.js.map +1 -1
  195. package/lib/settings.d.ts +64 -64
  196. package/lib/settings.js +88 -88
  197. package/lib/settings.js.map +1 -1
  198. package/lib/test-helpers/AnnotationBuilder.d.ts +12 -12
  199. package/lib/test-helpers/AnnotationBuilder.js +30 -30
  200. package/lib/test-helpers/ClassMirrorBuilder.d.ts +18 -18
  201. package/lib/test-helpers/ClassMirrorBuilder.js +53 -53
  202. package/lib/test-helpers/DocCommentAnnotationBuilder.d.ts +8 -8
  203. package/lib/test-helpers/DocCommentAnnotationBuilder.js +25 -25
  204. package/lib/test-helpers/DocCommentBuilder.d.ts +12 -12
  205. package/lib/test-helpers/DocCommentBuilder.js +37 -37
  206. package/lib/test-helpers/FieldMirrorBuilder.d.ts +18 -18
  207. package/lib/test-helpers/FieldMirrorBuilder.js +53 -53
  208. package/lib/test-helpers/InterfaceMirrorBuilder.d.ts +16 -0
  209. package/lib/test-helpers/InterfaceMirrorBuilder.js +43 -0
  210. package/lib/test-helpers/InterfaceMirrorBuilder.js.map +1 -0
  211. package/lib/test-helpers/MethodMirrorBuilder.d.ts +29 -10
  212. package/lib/test-helpers/MethodMirrorBuilder.js +71 -36
  213. package/lib/test-helpers/MethodMirrorBuilder.js.map +1 -1
  214. package/lib/test-helpers/SettingsBuilder.d.ts +8 -8
  215. package/lib/test-helpers/SettingsBuilder.js +26 -26
  216. package/lib/transpiler/factory.d.ts +6 -6
  217. package/lib/transpiler/factory.js +34 -31
  218. package/lib/transpiler/factory.js.map +1 -1
  219. package/lib/transpiler/file-container.d.ts +6 -6
  220. package/lib/transpiler/file-container.js +15 -15
  221. package/lib/transpiler/generator-choices.d.ts +1 -1
  222. package/lib/transpiler/generator-choices.js +2 -2
  223. package/lib/transpiler/markdown/class-file-generatorHelper.d.ts +11 -8
  224. package/lib/transpiler/markdown/class-file-generatorHelper.js +74 -55
  225. package/lib/transpiler/markdown/class-file-generatorHelper.js.map +1 -1
  226. package/lib/transpiler/markdown/docsify/docsify-docs-processor.d.ts +6 -6
  227. package/lib/transpiler/markdown/docsify/docsify-docs-processor.js +12 -12
  228. package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.d.ts +11 -11
  229. package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.js +50 -50
  230. package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.js.map +1 -1
  231. package/lib/transpiler/markdown/markdown-transpiler-base.d.ts +11 -11
  232. package/lib/transpiler/markdown/markdown-transpiler-base.js +26 -23
  233. package/lib/transpiler/markdown/markdown-transpiler-base.js.map +1 -1
  234. package/lib/transpiler/markdown/plain-markdown/class-template.d.ts +1 -0
  235. package/lib/transpiler/markdown/plain-markdown/class-template.js +77 -0
  236. package/lib/transpiler/markdown/plain-markdown/class-template.js.map +1 -0
  237. package/lib/transpiler/markdown/plain-markdown/constructors-partial-template.d.ts +1 -0
  238. package/lib/transpiler/markdown/plain-markdown/constructors-partial-template.js +36 -0
  239. package/lib/transpiler/markdown/plain-markdown/constructors-partial-template.js.map +1 -0
  240. package/lib/transpiler/markdown/plain-markdown/documentable-partial-template.d.ts +1 -0
  241. package/lib/transpiler/markdown/plain-markdown/documentable-partial-template.js +28 -0
  242. package/lib/transpiler/markdown/plain-markdown/documentable-partial-template.js.map +1 -0
  243. package/lib/transpiler/markdown/plain-markdown/enum-template.d.ts +1 -0
  244. package/lib/transpiler/markdown/plain-markdown/enum-template.js +16 -0
  245. package/lib/transpiler/markdown/plain-markdown/enum-template.js.map +1 -0
  246. package/lib/transpiler/markdown/plain-markdown/fieldsPartialTemplate.d.ts +1 -0
  247. package/lib/transpiler/markdown/plain-markdown/fieldsPartialTemplate.js +27 -0
  248. package/lib/transpiler/markdown/plain-markdown/fieldsPartialTemplate.js.map +1 -0
  249. package/lib/transpiler/markdown/plain-markdown/grouped-members-partial-template.d.ts +1 -0
  250. package/lib/transpiler/markdown/plain-markdown/grouped-members-partial-template.js +10 -0
  251. package/lib/transpiler/markdown/plain-markdown/grouped-members-partial-template.js.map +1 -0
  252. package/lib/transpiler/markdown/plain-markdown/interface-template.d.ts +1 -0
  253. package/lib/transpiler/markdown/plain-markdown/interface-template.js +20 -0
  254. package/lib/transpiler/markdown/plain-markdown/interface-template.js.map +1 -0
  255. package/lib/transpiler/markdown/plain-markdown/methods-partial-template.d.ts +1 -0
  256. package/lib/transpiler/markdown/plain-markdown/methods-partial-template.js +47 -0
  257. package/lib/transpiler/markdown/plain-markdown/methods-partial-template.js.map +1 -0
  258. package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.d.ts +9 -6
  259. package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.js +41 -13
  260. package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.js.map +1 -1
  261. package/lib/transpiler/markdown/plain-markdown/type-doc-partial.d.ts +1 -0
  262. package/lib/transpiler/markdown/plain-markdown/type-doc-partial.js +31 -0
  263. package/lib/transpiler/markdown/plain-markdown/type-doc-partial.js.map +1 -0
  264. package/lib/transpiler/openapi/open-api-docs-processor.d.ts +13 -13
  265. package/lib/transpiler/openapi/open-api-docs-processor.js +77 -74
  266. package/lib/transpiler/openapi/open-api-docs-processor.js.map +1 -1
  267. package/lib/transpiler/openapi/parsers/Builder.d.ts +16 -16
  268. package/lib/transpiler/openapi/parsers/Builder.js +29 -29
  269. package/lib/transpiler/openapi/parsers/Builder.js.map +1 -1
  270. package/lib/transpiler/openapi/parsers/MethodParser.d.ts +20 -20
  271. package/lib/transpiler/openapi/parsers/MethodParser.js +189 -166
  272. package/lib/transpiler/openapi/parsers/MethodParser.js.map +1 -1
  273. package/lib/transpiler/openapi/parsers/ParameterObjectBuilder.d.ts +7 -7
  274. package/lib/transpiler/openapi/parsers/ParameterObjectBuilder.js +10 -10
  275. package/lib/transpiler/openapi/parsers/ReferenceBuilder.d.ts +39 -39
  276. package/lib/transpiler/openapi/parsers/ReferenceBuilder.js +249 -225
  277. package/lib/transpiler/openapi/parsers/ReferenceBuilder.js.map +1 -1
  278. package/lib/transpiler/openapi/parsers/RequestBodyBuilder.d.ts +10 -10
  279. package/lib/transpiler/openapi/parsers/RequestBodyBuilder.js +19 -19
  280. package/lib/transpiler/openapi/parsers/ResponsesBuilder.d.ts +7 -7
  281. package/lib/transpiler/openapi/parsers/ResponsesBuilder.js +21 -21
  282. package/lib/transpiler/openapi/parsers/ResponsesBuilder.js.map +1 -1
  283. package/lib/transpiler/processor-type-transpiler.d.ts +10 -10
  284. package/lib/transpiler/processor-type-transpiler.js +8 -8
  285. package/lib/transpiler/transpiler.d.ts +5 -5
  286. package/lib/transpiler/transpiler.js +29 -26
  287. package/lib/transpiler/transpiler.js.map +1 -1
  288. package/lib/util/error-logger.d.ts +8 -8
  289. package/lib/util/error-logger.js +89 -89
  290. package/lib/util/error-logger.js.map +1 -1
  291. package/lib/util/logger.d.ts +21 -21
  292. package/lib/util/logger.js +60 -57
  293. package/lib/util/logger.js.map +1 -1
  294. package/lib/util/string-utils.d.ts +2 -2
  295. package/lib/util/string-utils.js +14 -14
  296. package/lib/util/string-utils.js.map +1 -1
  297. package/package.json +79 -78
  298. package/src/__spec__/core/expect-extensions.ts +32 -0
  299. package/src/__spec__/core/generating-class-docs.spec.ts +511 -0
  300. package/src/__spec__/core/generating-enum-docs.spec.ts +355 -0
  301. package/src/__spec__/core/generating-interface-docs.spec.ts +431 -0
  302. package/src/__spec__/core/generating-reference-guide.spec.ts +163 -0
  303. package/src/adapters/__tests__/interface-adapter.spec.ts +80 -0
  304. package/src/adapters/__tests__/references.spec.ts +115 -0
  305. package/src/adapters/apex-types.ts +224 -0
  306. package/src/adapters/documentables.ts +93 -0
  307. package/src/adapters/fields-and-properties.ts +38 -0
  308. package/src/adapters/methods-and-constructors.ts +117 -0
  309. package/src/adapters/references.ts +113 -0
  310. package/src/adapters/type-utils.ts +5 -0
  311. package/src/adapters/types.d.ts +8 -0
  312. package/src/cli/generate.ts +96 -93
  313. package/src/core/generate-docs.ts +357 -0
  314. package/src/core/renderable/types.d.ts +131 -0
  315. package/src/core/template.ts +108 -0
  316. package/src/core/templates/reference-guide.ts +14 -0
  317. package/src/index.ts +3 -1
  318. package/src/model/__tests__/manifest.spec.ts +1 -0
  319. package/src/model/manifest.ts +15 -5
  320. package/src/model/markdown-file.ts +6 -5
  321. package/src/model/markdown-generation-util/doc-comment-annotation-util.ts +1 -1
  322. package/src/model/markdown-generation-util/method-declaration-util.ts +1 -1
  323. package/src/model/openapi/open-api-types.ts +2 -2
  324. package/src/model/outputFile.ts +2 -11
  325. package/src/service/__tests__/apex-file-reader.spec.ts +4 -4
  326. package/src/service/__tests__/manifest-factory.spec.ts +1 -2
  327. package/src/service/parser.ts +1 -1
  328. package/src/test-helpers/FieldMirrorBuilder.ts +1 -1
  329. package/src/test-helpers/InterfaceMirrorBuilder.ts +44 -0
  330. package/src/test-helpers/MethodMirrorBuilder.ts +46 -6
  331. package/src/transpiler/markdown/class-file-generatorHelper.ts +22 -2
  332. package/src/transpiler/markdown/plain-markdown/class-template.ts +73 -0
  333. package/src/transpiler/markdown/plain-markdown/constructors-partial-template.ts +32 -0
  334. package/src/transpiler/markdown/plain-markdown/documentable-partial-template.ts +24 -0
  335. package/src/transpiler/markdown/plain-markdown/enum-template.ts +12 -0
  336. package/src/transpiler/markdown/plain-markdown/fieldsPartialTemplate.ts +23 -0
  337. package/src/transpiler/markdown/plain-markdown/grouped-members-partial-template.ts +6 -0
  338. package/src/transpiler/markdown/plain-markdown/interface-template.ts +16 -0
  339. package/src/transpiler/markdown/plain-markdown/methods-partial-template.ts +43 -0
  340. package/src/transpiler/markdown/plain-markdown/plain-docsProcessor.ts +30 -0
  341. package/src/transpiler/markdown/plain-markdown/type-doc-partial.ts +27 -0
  342. package/src/transpiler/openapi/parsers/Builder.ts +1 -1
  343. package/src/transpiler/openapi/parsers/MethodParser.ts +1 -1
  344. package/src/transpiler/openapi/parsers/ReferenceBuilder.ts +4 -3
  345. package/src/util/error-logger.ts +4 -4
  346. package/src/util/logger.ts +3 -3
  347. package/tsconfig.json +21 -20
  348. package/tslint.json +5 -5
  349. package/.eslintrc.js +0 -12
  350. package/lib/model/manifest-diff.d.ts +0 -27
  351. package/lib/model/manifest-diff.js +0 -69
  352. package/lib/model/manifest-diff.js.map +0 -1
  353. package/src/model/__tests__/manifest-diff.spec.ts +0 -139
  354. package/src/model/manifest-diff.ts +0 -94
  355. /package/docs/{index.html → __old/index.html} +0 -0
  356. /package/docs/{types → __old/types}/Classes/nspc.AnotherInterface.md +0 -0
  357. /package/docs/{types → __old/types}/Main/nspc.GroupedClass.md +0 -0
  358. /package/docs/{types → __old/types}/Misc-Group/nspc.EscapedAnnotations.md +0 -0
  359. /package/docs/{types → __old/types}/Misc-Group/nspc.GrandparentClass.md +0 -0
  360. /package/docs/{types → __old/types}/Misc-Group/nspc.InterfaceWithInheritance.md +0 -0
  361. /package/docs/{types → __old/types}/Misc-Group/nspc.MemberGrouping.md +0 -0
  362. /package/docs/{types → __old/types}/Misc-Group/nspc.ParentClass.md +0 -0
  363. /package/docs/{types → __old/types}/Misc-Group/nspc.Reference1.md +0 -0
  364. /package/docs/{types → __old/types}/Misc-Group/nspc.Reference2.md +0 -0
  365. /package/docs/{types → __old/types}/Misc-Group/nspc.Reference3.md +0 -0
  366. /package/docs/{types → __old/types}/Misc-Group/nspc.Reference4.md +0 -0
  367. /package/docs/{types → __old/types}/Misc-Group/nspc.Reference5.md +0 -0
  368. /package/docs/{types → __old/types}/Misc-Group/nspc.Reference6.md +0 -0
  369. /package/docs/{types → __old/types}/Misc-Group/nspc.Reference7.md +0 -0
  370. /package/docs/{types → __old/types}/Misc-Group/nspc.SampleClassWithoutModifier.md +0 -0
  371. /package/docs/{types → __old/types}/Misc-Group/nspc.SampleRestResource.md +0 -0
  372. /package/docs/{types → __old/types}/Misc-Group/nspc.SampleRestResourceWithInnerClass.md +0 -0
  373. /package/docs/{types → __old/types}/Misc-Group/nspc.SampleRestResourceWithoutApexDocs.md +0 -0
  374. /package/docs/{types → __old/types}/README.md +0 -0
  375. /package/docs/{types → __old/types}/Sample-Interfaces/nspc.SampleInterface.md +0 -0
@@ -0,0 +1,241 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
15
+ }) : function(o, v) {
16
+ o["default"] = v;
17
+ });
18
+ var __importStar = (this && this.__importStar) || function (mod) {
19
+ if (mod && mod.__esModule) return mod;
20
+ var result = {};
21
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
22
+ __setModuleDefault(result, mod);
23
+ return result;
24
+ };
25
+ var __importDefault = (this && this.__importDefault) || function (mod) {
26
+ return (mod && mod.__esModule) ? mod : { "default": mod };
27
+ };
28
+ Object.defineProperty(exports, "__esModule", { value: true });
29
+ exports.documentType = void 0;
30
+ exports.generateDocs = generateDocs;
31
+ const apex_reflection_1 = require("@cparra/apex-reflection");
32
+ const apex_types_1 = require("../adapters/apex-types");
33
+ const class_template_1 = require("../transpiler/markdown/plain-markdown/class-template");
34
+ const enum_template_1 = require("../transpiler/markdown/plain-markdown/enum-template");
35
+ const interface_template_1 = require("../transpiler/markdown/plain-markdown/interface-template");
36
+ const E = __importStar(require("fp-ts/Either"));
37
+ const function_1 = require("fp-ts/function");
38
+ const template_1 = require("./template");
39
+ const manifest_1 = __importDefault(require("../model/manifest"));
40
+ const reference_guide_1 = require("./templates/reference-guide");
41
+ const documentables_1 = require("../adapters/documentables");
42
+ exports.documentType = (0, function_1.flow)(apex_types_1.typeToRenderableType, resolveApexTypeTemplate, compile);
43
+ const configDefaults = {
44
+ scope: ['public'],
45
+ outputDir: 'docs',
46
+ defaultGroupName: 'Miscellaneous',
47
+ referenceGuideTemplate: reference_guide_1.referenceGuideTemplate,
48
+ };
49
+ function generateDocs(input, config) {
50
+ const configWithDefaults = Object.assign(Object.assign({}, configDefaults), config);
51
+ return (0, function_1.pipe)(input, (input) => input.map(reflectSourceBody), checkForReflectionErrors, E.map((types) => types.map((type) => addInheritedMembers(type, types))), E.map((types) => filterTypesOutOfScope(types, configWithDefaults.scope)), E.map((types) => typesToRenderableBundle(types, configWithDefaults)), E.map(({ references, renderables }) => ({
52
+ referenceGuide: (0, function_1.pipe)(referencesToReferenceGuide(references, configWithDefaults.referenceGuideTemplate)),
53
+ docs: renderables.map(renderableToOutputDoc),
54
+ })), E.map(({ referenceGuide, docs }) => ({ format: 'markdown', referenceGuide: referenceGuide, docs })));
55
+ }
56
+ function typesToRenderableBundle(types, config) {
57
+ return types.reduce((acc, type) => {
58
+ var _a;
59
+ const renderable = (0, apex_types_1.typeToRenderableType)(type, (referenceName) => {
60
+ return linkFromTypeNameGenerator(type, types, referenceName, config);
61
+ }, config.namespace);
62
+ acc.renderables.push(renderable);
63
+ const descriptionLines = (_a = type.docComment) === null || _a === void 0 ? void 0 : _a.descriptionLines;
64
+ const reference = {
65
+ title: getLinkFromRoot(config, type),
66
+ description: (0, documentables_1.adaptDescribable)(descriptionLines, (referenceName) => {
67
+ const type = findType(types, referenceName);
68
+ return type ? getLinkFromRoot(config, type) : referenceName;
69
+ }).description,
70
+ };
71
+ const group = getTypeGroup(type, config);
72
+ if (!acc.references[group]) {
73
+ acc.references[group] = [];
74
+ }
75
+ acc.references[group].push(reference);
76
+ return acc;
77
+ }, {
78
+ references: {},
79
+ renderables: [],
80
+ });
81
+ }
82
+ function renderableToOutputDoc(renderable) {
83
+ function buildDocOutput(renderable, docContents) {
84
+ return {
85
+ docContents,
86
+ typeName: renderable.name,
87
+ type: renderable.type,
88
+ };
89
+ }
90
+ return (0, function_1.pipe)(renderable, resolveApexTypeTemplate, compile, (docContents) => buildDocOutput(renderable, docContents));
91
+ }
92
+ function referencesToReferenceGuide(references, template) {
93
+ function alphabetizeReferences(references) {
94
+ return Object.keys(references)
95
+ .sort((a, b) => a.localeCompare(b))
96
+ .reduce((acc, key) => {
97
+ acc[key] = references[key].sort((a, b) => a.title.toString().localeCompare(b.title.toString()));
98
+ return acc;
99
+ }, {});
100
+ }
101
+ return (0, function_1.pipe)(references, alphabetizeReferences, (references) => compile({
102
+ template: template,
103
+ source: references,
104
+ }));
105
+ }
106
+ function filterTypesOutOfScope(types, scope) {
107
+ return new manifest_1.default(types).filteredByAccessModifierAndAnnotations(scope);
108
+ }
109
+ function checkForReflectionErrors(reflectionResult) {
110
+ function reduceReflectionResultIntoSingleEither(results) {
111
+ return results.reduce((acc, result) => {
112
+ E.isLeft(result) ? acc.errors.push(result.left) : acc.types.push(result.right);
113
+ return acc;
114
+ }, {
115
+ errors: [],
116
+ types: [],
117
+ });
118
+ }
119
+ return (0, function_1.pipe)(reflectionResult, reduceReflectionResultIntoSingleEither, ({ errors, types }) => errors.length ? E.left(errors) : E.right(types));
120
+ }
121
+ function reflectSourceBody(input) {
122
+ const result = (0, apex_reflection_1.reflect)(input);
123
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
124
+ return result.error ? E.left(result.error.message) : E.right(result.typeMirror);
125
+ }
126
+ function resolveApexTypeTemplate(renderable) {
127
+ function getTemplate(renderable) {
128
+ switch (renderable.type) {
129
+ case 'enum':
130
+ return enum_template_1.enumMarkdownTemplate;
131
+ case 'interface':
132
+ return interface_template_1.interfaceMarkdownTemplate;
133
+ case 'class':
134
+ return class_template_1.classMarkdownTemplate;
135
+ }
136
+ }
137
+ return {
138
+ template: getTemplate(renderable),
139
+ source: renderable,
140
+ };
141
+ }
142
+ function compile(request) {
143
+ return template_1.Template.getInstance().compile(request);
144
+ }
145
+ function findType(repository, referenceName) {
146
+ return repository.find((currentType) => currentType.name.toLowerCase() === referenceName.toLowerCase());
147
+ }
148
+ function addInheritedMembers(current, repository) {
149
+ if (current.type_name === 'enum') {
150
+ return current;
151
+ }
152
+ else if (current.type_name === 'interface') {
153
+ return addInheritedInterfaceMethods(current, repository);
154
+ }
155
+ else {
156
+ return addInheritedClassMembers(current, repository);
157
+ }
158
+ }
159
+ function getParents(extendedNamesExtractor, current, repository) {
160
+ return (0, function_1.pipe)(extendedNamesExtractor(current), (interfaces) => interfaces.map((interfaceName) => repository.find((type) => type.name === interfaceName)), (interfaces = []) => interfaces.filter((type) => type !== undefined), (interfaces) => interfaces.reduce((acc, current) => [...acc, ...getParents(extendedNamesExtractor, current, repository)], interfaces));
161
+ }
162
+ function addInheritedInterfaceMethods(interfaceMirror, repository) {
163
+ function methodAlreadyExists(memberName, members) {
164
+ return members.some((member) => member.name.toLowerCase() === memberName.toLowerCase());
165
+ }
166
+ function parentExtractor(interfaceMirror) {
167
+ return interfaceMirror.extended_interfaces;
168
+ }
169
+ const parents = getParents(parentExtractor, interfaceMirror, repository);
170
+ return Object.assign(Object.assign({}, interfaceMirror), { methods: parents.reduce((acc, currentValue) => [
171
+ ...acc,
172
+ ...currentValue.methods
173
+ .filter((method) => !methodAlreadyExists(method.name, acc))
174
+ .map((method) => (Object.assign(Object.assign({}, method), { inherited: true }))),
175
+ ], interfaceMirror.methods) });
176
+ }
177
+ function addInheritedClassMembers(classMirror, repository) {
178
+ function memberAlreadyExists(memberName, members) {
179
+ return members.some((member) => member.name.toLowerCase() === memberName.toLowerCase());
180
+ }
181
+ function parentExtractor(classMirror) {
182
+ return classMirror.extended_class ? [classMirror.extended_class] : [];
183
+ }
184
+ function filterMember(members, existing) {
185
+ return members
186
+ .filter((member) => member.access_modifier.toLowerCase() !== 'private')
187
+ .filter((member) => !memberAlreadyExists(member.name, existing))
188
+ .map((member) => (Object.assign(Object.assign({}, member), { inherited: true })));
189
+ }
190
+ const parents = getParents(parentExtractor, classMirror, repository);
191
+ return Object.assign(Object.assign({}, classMirror), { fields: parents.reduce((acc, currentValue) => [...acc, ...filterMember(currentValue.fields, acc)], classMirror.fields), properties: parents.reduce((acc, currentValue) => [...acc, ...filterMember(currentValue.properties, acc)], classMirror.properties), methods: parents.reduce((acc, currentValue) => [...acc, ...filterMember(currentValue.methods, acc)], classMirror.methods) });
192
+ }
193
+ function linkFromTypeNameGenerator(typeBeingDocumented, repository, referenceName, config) {
194
+ const type = findType(repository, referenceName);
195
+ if (!type) {
196
+ // If the type is not found, we return the type name as a string.
197
+ return referenceName;
198
+ }
199
+ const [fullClassName, fileLink] = getFileLinkTuple(typeBeingDocumented, type, config);
200
+ return {
201
+ title: fullClassName,
202
+ url: fileLink,
203
+ };
204
+ }
205
+ function getFileLinkTuple(typeBeingDocumented, referencedType, config) {
206
+ const namespacePrefix = config.namespace ? `${config.namespace}.` : '';
207
+ const directoryRoot = `${getDirectoryRoot(typeBeingDocumented, referencedType, config)}`;
208
+ // TODO: Instead of adding a "." to the name when there is a namespace, maybe we want to create a folder for everything
209
+ // within that namespace and put the files in there.
210
+ const fullClassName = `${namespacePrefix}${referencedType.name}`;
211
+ return [fullClassName, `${directoryRoot}${fullClassName}.md`];
212
+ }
213
+ function getLinkFromRoot(config, type) {
214
+ if (!type) {
215
+ return '';
216
+ }
217
+ const namespacePrefix = config.namespace ? `${config.namespace}./` : '';
218
+ return {
219
+ title: `${namespacePrefix}${type.name}`,
220
+ url: `./${namespacePrefix}${getSanitizedGroup(type, config)}/${type.name}.md`,
221
+ };
222
+ }
223
+ function getDirectoryRoot(typeBeingDocumented, referencedType, config) {
224
+ if (getTypeGroup(typeBeingDocumented, config) === getTypeGroup(referencedType, config)) {
225
+ // If the types the same groups then we simply link directly to that file
226
+ return './';
227
+ }
228
+ else {
229
+ // If the types have different groups, then we have to go up a directory
230
+ return `../${getSanitizedGroup(referencedType, config)}/`;
231
+ }
232
+ }
233
+ function getTypeGroup(type, config) {
234
+ var _a, _b;
235
+ const groupAnnotation = (_a = type.docComment) === null || _a === void 0 ? void 0 : _a.annotations.find((annotation) => annotation.name.toLowerCase() === 'group');
236
+ return (_b = groupAnnotation === null || groupAnnotation === void 0 ? void 0 : groupAnnotation.body) !== null && _b !== void 0 ? _b : config.defaultGroupName;
237
+ }
238
+ function getSanitizedGroup(classModel, config) {
239
+ return getTypeGroup(classModel, config).replace(/ /g, '-').replace('.', '');
240
+ }
241
+ //# sourceMappingURL=generate-docs.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"generate-docs.js","sourceRoot":"","sources":["../../src/core/generate-docs.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2CA,oCAkBC;AA7DD,6DAA0G;AAC1G,uDAA8D;AAE9D,yFAA6F;AAC7F,uFAA2F;AAC3F,iGAAqG;AACrG,gDAAkC;AAClC,6CAA4C;AAC5C,yCAA0D;AAC1D,iEAAyC;AACzC,iEAAqE;AACrE,6DAA6D;AAEhD,QAAA,YAAY,GAAG,IAAA,eAAI,EAAC,iCAAoB,EAAE,uBAAuB,EAAE,OAAO,CAAC,CAAC;AAuBzF,MAAM,cAAc,GAAwB;IAC1C,KAAK,EAAE,CAAC,QAAQ,CAAC;IACjB,SAAS,EAAE,MAAM;IACjB,gBAAgB,EAAE,eAAe;IACjC,sBAAsB,EAAE,wCAAsB;CAC/C,CAAC;AAEF,SAAgB,YAAY,CAC1B,KAAe,EACf,MAAqC;IAErC,MAAM,kBAAkB,mCAAQ,cAAc,GAAK,MAAM,CAAE,CAAC;IAC5D,OAAO,IAAA,eAAI,EACT,KAAK,EACL,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,iBAAiB,CAAC,EACvC,wBAAwB,EACxB,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,mBAAmB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EACvE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,qBAAqB,CAAC,KAAK,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC,EACxE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,uBAAuB,CAAC,KAAK,EAAE,kBAAkB,CAAC,CAAC,EACpE,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,UAAU,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC,CAAC;QACtC,cAAc,EAAE,IAAA,eAAI,EAAC,0BAA0B,CAAC,UAAU,EAAE,kBAAkB,CAAC,sBAAsB,CAAC,CAAC;QACvG,IAAI,EAAE,WAAW,CAAC,GAAG,CAAC,qBAAqB,CAAC;KAC7C,CAAC,CAAC,EACH,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,cAAc,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,cAAc,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC,CACpG,CAAC;AACJ,CAAC;AAeD,SAAS,uBAAuB,CAAC,KAAa,EAAE,MAA2B;IACzE,OAAO,KAAK,CAAC,MAAM,CACjB,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;;QACZ,MAAM,UAAU,GAAG,IAAA,iCAAoB,EACrC,IAAI,EACJ,CAAC,aAAa,EAAE,EAAE;YAChB,OAAO,yBAAyB,CAAC,IAAI,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC;QACvE,CAAC,EACD,MAAM,CAAC,SAAS,CACjB,CAAC;QACF,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEjC,MAAM,gBAAgB,GAAG,MAAA,IAAI,CAAC,UAAU,0CAAE,gBAAgB,CAAC;QAC3D,MAAM,SAAS,GAAG;YAChB,KAAK,EAAE,eAAe,CAAC,MAAM,EAAE,IAAI,CAAC;YACpC,WAAW,EAAE,IAAA,gCAAgB,EAAC,gBAAgB,EAAE,CAAC,aAAa,EAAE,EAAE;gBAChE,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;gBAC5C,OAAO,IAAI,CAAC,CAAC,CAAC,eAAe,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC;YAC9D,CAAC,CAAC,CAAC,WAAW;SACf,CAAC;QAEF,MAAM,KAAK,GAAG,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACzC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;YAC3B,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;QAC7B,CAAC;QACD,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAEtC,OAAO,GAAG,CAAC;IACb,CAAC,EACD;QACE,UAAU,EAAE,EAAE;QACd,WAAW,EAAE,EAAE;KAChB,CACF,CAAC;AACJ,CAAC;AAED,SAAS,qBAAqB,CAAC,UAAsB;IACnD,SAAS,cAAc,CAAC,UAAsB,EAAE,WAAmB;QACjE,OAAO;YACL,WAAW;YACX,QAAQ,EAAE,UAAU,CAAC,IAAI;YACzB,IAAI,EAAE,UAAU,CAAC,IAAI;SACtB,CAAC;IACJ,CAAC;IAED,OAAO,IAAA,eAAI,EAAC,UAAU,EAAE,uBAAuB,EAAE,OAAO,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC,cAAc,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC;AACtH,CAAC;AAED,SAAS,0BAA0B,CACjC,UAAwD,EACxD,QAAgB;IAEhB,SAAS,qBAAqB,CAAC,UAAwD;QAGrF,OAAO,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC;aAC3B,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;aAClC,MAAM,CAA+C,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YACjE,GAAG,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;YAChG,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAAE,CAAC,CAAC;IACX,CAAC;IAED,OAAO,IAAA,eAAI,EAAC,UAAU,EAAE,qBAAqB,EAAE,CAAC,UAAU,EAAE,EAAE,CAC5D,OAAO,CAAC;QACN,QAAQ,EAAE,QAAQ;QAClB,MAAM,EAAE,UAAU;KACnB,CAAC,CACH,CAAC;AACJ,CAAC;AAED,SAAS,qBAAqB,CAAC,KAAa,EAAE,KAAe;IAC3D,OAAO,IAAI,kBAAQ,CAAC,KAAK,CAAC,CAAC,sCAAsC,CAAC,KAAK,CAAC,CAAC;AAC3E,CAAC;AAED,SAAS,wBAAwB,CAAC,gBAA0C;IAC1E,SAAS,sCAAsC,CAAC,OAAiC;QAI/E,OAAO,OAAO,CAAC,MAAM,CACnB,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE;YACd,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAC/E,OAAO,GAAG,CAAC;QACb,CAAC,EACD;YACE,MAAM,EAAE,EAAE;YACV,KAAK,EAAE,EAAE;SACV,CACF,CAAC;IACJ,CAAC;IAED,OAAO,IAAA,eAAI,EAAC,gBAAgB,EAAE,sCAAsC,EAAE,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,CAC1F,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAChD,CAAC;AACJ,CAAC;AAED,SAAS,iBAAiB,CAAC,KAAa;IACtC,MAAM,MAAM,GAAG,IAAA,yBAAgB,EAAC,KAAK,CAAC,CAAC;IACvC,oEAAoE;IACpE,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,UAAW,CAAC,CAAC;AACnF,CAAC;AAED,SAAS,uBAAuB,CAAC,UAAsB;IACrD,SAAS,WAAW,CAAC,UAAsB;QACzC,QAAQ,UAAU,CAAC,IAAI,EAAE,CAAC;YACxB,KAAK,MAAM;gBACT,OAAO,oCAAoB,CAAC;YAC9B,KAAK,WAAW;gBACd,OAAO,8CAAyB,CAAC;YACnC,KAAK,OAAO;gBACV,OAAO,sCAAqB,CAAC;QACjC,CAAC;IACH,CAAC;IAED,OAAO;QACL,QAAQ,EAAE,WAAW,CAAC,UAAU,CAAC;QACjC,MAAM,EAAE,UAA4B;KACrC,CAAC;AACJ,CAAC;AAED,SAAS,OAAO,CAAC,OAA2B;IAC1C,OAAO,mBAAQ,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;AACjD,CAAC;AAED,SAAS,QAAQ,CAAC,UAAkB,EAAE,aAAqB;IACzD,OAAO,UAAU,CAAC,IAAI,CAAC,CAAC,WAAiB,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC;AAChH,CAAC;AAED,SAAS,mBAAmB,CAAiB,OAAU,EAAE,UAAkB;IACzE,IAAI,OAAO,CAAC,SAAS,KAAK,MAAM,EAAE,CAAC;QACjC,OAAO,OAAO,CAAC;IACjB,CAAC;SAAM,IAAI,OAAO,CAAC,SAAS,KAAK,WAAW,EAAE,CAAC;QAC7C,OAAO,4BAA4B,CAAC,OAA0B,EAAE,UAAU,CAAM,CAAC;IACnF,CAAC;SAAM,CAAC;QACN,OAAO,wBAAwB,CAAC,OAAsB,EAAE,UAAU,CAAM,CAAC;IAC3E,CAAC;AACH,CAAC;AAED,SAAS,UAAU,CACjB,sBAAgD,EAChD,OAAU,EACV,UAAkB;IAElB,OAAO,IAAA,eAAI,EACT,sBAAsB,CAAC,OAAO,CAAC,EAC/B,CAAC,UAAoB,EAAE,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,aAAa,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,aAAa,CAAC,CAAC,EACnH,CAAC,UAAU,GAAG,EAAE,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,SAAS,CAAQ,EAC3E,CAAC,UAAU,EAAE,EAAE,CACb,UAAU,CAAC,MAAM,CACf,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,UAAU,CAAC,sBAAsB,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC,EACtF,UAAU,CACX,CACJ,CAAC;AACJ,CAAC;AAED,SAAS,4BAA4B,CAAC,eAAgC,EAAE,UAAkB;IACxF,SAAS,mBAAmB,CAAC,UAAkB,EAAE,OAA2B;QAC1E,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED,SAAS,eAAe,CAAC,eAAgC;QACvD,OAAO,eAAe,CAAC,mBAAmB,CAAC;IAC7C,CAAC;IAED,MAAM,OAAO,GAAG,UAAU,CAAC,eAAe,EAAE,eAAe,EAAE,UAAU,CAAC,CAAC;IACzE,uCACK,eAAe,KAClB,OAAO,EAAE,OAAO,CAAC,MAAM,CACrB,CAAC,GAAG,EAAE,YAAY,EAAE,EAAE,CAAC;YACrB,GAAG,GAAG;YACN,GAAG,YAAY,CAAC,OAAO;iBACpB,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,mBAAmB,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;iBAC1D,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,iCACZ,MAAM,KACT,SAAS,EAAE,IAAI,IACf,CAAC;SACN,EACD,eAAe,CAAC,OAAO,CACxB,IACD;AACJ,CAAC;AAED,SAAS,wBAAwB,CAAC,WAAwB,EAAE,UAAkB;IAC5E,SAAS,mBAAmB,CAAC,UAAkB,EAAE,OAA2B;QAC1E,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED,SAAS,eAAe,CAAC,WAAwB;QAC/C,OAAO,WAAW,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACxE,CAAC;IAED,SAAS,YAAY,CAAsD,OAAY,EAAE,QAAa;QACpG,OAAO,OAAO;aACX,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,eAAe,CAAC,WAAW,EAAE,KAAK,SAAS,CAAC;aACtE,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,mBAAmB,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;aAC/D,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,iCACZ,MAAM,KACT,SAAS,EAAE,IAAI,IACf,CAAC,CAAC;IACR,CAAC;IAED,MAAM,OAAO,GAAG,UAAU,CAAC,eAAe,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC;IACrE,uCACK,WAAW,KACd,MAAM,EAAE,OAAO,CAAC,MAAM,CACpB,CAAC,GAAG,EAAE,YAAY,EAAE,EAAE,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,YAAY,CAAC,YAAY,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,EAC1E,WAAW,CAAC,MAAM,CACnB,EACD,UAAU,EAAE,OAAO,CAAC,MAAM,CACxB,CAAC,GAAG,EAAE,YAAY,EAAE,EAAE,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,YAAY,CAAC,YAAY,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,EAC9E,WAAW,CAAC,UAAU,CACvB,EACD,OAAO,EAAE,OAAO,CAAC,MAAM,CACrB,CAAC,GAAG,EAAE,YAAY,EAAE,EAAE,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,YAAY,CAAC,YAAY,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,EAC3E,WAAW,CAAC,OAAO,CACpB,IACD;AACJ,CAAC;AAED,SAAS,yBAAyB,CAChC,mBAAyB,EACzB,UAAkB,EAClB,aAAqB,EACrB,MAA2B;IAE3B,MAAM,IAAI,GAAG,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC;IACjD,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,iEAAiE;QACjE,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,MAAM,CAAC,aAAa,EAAE,QAAQ,CAAC,GAAG,gBAAgB,CAAC,mBAAmB,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IACtF,OAAO;QACL,KAAK,EAAE,aAAa;QACpB,GAAG,EAAE,QAAQ;KACd,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CACvB,mBAAyB,EACzB,cAAoB,EACpB,MAA2B;IAE3B,MAAM,eAAe,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IACvE,MAAM,aAAa,GAAG,GAAG,gBAAgB,CAAC,mBAAmB,EAAE,cAAc,EAAE,MAAM,CAAC,EAAE,CAAC;IACzF,uHAAuH;IACvH,oDAAoD;IACpD,MAAM,aAAa,GAAG,GAAG,eAAe,GAAG,cAAc,CAAC,IAAI,EAAE,CAAC;IACjE,OAAO,CAAC,aAAa,EAAE,GAAG,aAAa,GAAG,aAAa,KAAK,CAAC,CAAC;AAChE,CAAC;AAED,SAAS,eAAe,CAAC,MAA2B,EAAE,IAAW;IAC/D,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,MAAM,eAAe,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,SAAS,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;IACxE,OAAO;QACL,KAAK,EAAE,GAAG,eAAe,GAAG,IAAI,CAAC,IAAI,EAAE;QACvC,GAAG,EAAE,KAAK,eAAe,GAAG,iBAAiB,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,IAAI,CAAC,IAAI,KAAK;KAC9E,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CAAC,mBAAyB,EAAE,cAAoB,EAAE,MAA2B;IACpG,IAAI,YAAY,CAAC,mBAAmB,EAAE,MAAM,CAAC,KAAK,YAAY,CAAC,cAAc,EAAE,MAAM,CAAC,EAAE,CAAC;QACvF,yEAAyE;QACzE,OAAO,IAAI,CAAC;IACd,CAAC;SAAM,CAAC;QACN,wEAAwE;QACxE,OAAO,MAAM,iBAAiB,CAAC,cAAc,EAAE,MAAM,CAAC,GAAG,CAAC;IAC5D,CAAC;AACH,CAAC;AAED,SAAS,YAAY,CAAC,IAAU,EAAE,MAA2B;;IAC3D,MAAM,eAAe,GAAG,MAAA,IAAI,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,OAAO,CAAC,CAAC;IACrH,OAAO,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,IAAI,mCAAI,MAAM,CAAC,gBAAgB,CAAC;AAC1D,CAAC;AAED,SAAS,iBAAiB,CAAC,UAAgB,EAAE,MAA2B;IACtE,OAAO,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;AAC9E,CAAC"}
@@ -0,0 +1,10 @@
1
+ export type CompilationRequest = {
2
+ template: string;
3
+ source: unknown;
4
+ };
5
+ export declare class Template {
6
+ private static instance;
7
+ private constructor();
8
+ static getInstance(): Template;
9
+ compile(request: CompilationRequest): string;
10
+ }
@@ -0,0 +1,92 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.Template = void 0;
7
+ const handlebars_1 = __importDefault(require("handlebars"));
8
+ const type_doc_partial_1 = require("../transpiler/markdown/plain-markdown/type-doc-partial");
9
+ const documentable_partial_template_1 = require("../transpiler/markdown/plain-markdown/documentable-partial-template");
10
+ const methods_partial_template_1 = require("../transpiler/markdown/plain-markdown/methods-partial-template");
11
+ const constructors_partial_template_1 = require("../transpiler/markdown/plain-markdown/constructors-partial-template");
12
+ const fieldsPartialTemplate_1 = require("../transpiler/markdown/plain-markdown/fieldsPartialTemplate");
13
+ const class_template_1 = require("../transpiler/markdown/plain-markdown/class-template");
14
+ const enum_template_1 = require("../transpiler/markdown/plain-markdown/enum-template");
15
+ const interface_template_1 = require("../transpiler/markdown/plain-markdown/interface-template");
16
+ const type_utils_1 = require("../adapters/type-utils");
17
+ const grouped_members_partial_template_1 = require("../transpiler/markdown/plain-markdown/grouped-members-partial-template");
18
+ class Template {
19
+ constructor() {
20
+ handlebars_1.default.registerPartial('typeDocumentation', type_doc_partial_1.typeDocPartial);
21
+ handlebars_1.default.registerPartial('documentablePartialTemplate', documentable_partial_template_1.documentablePartialTemplate);
22
+ handlebars_1.default.registerPartial('methodsPartialTemplate', methods_partial_template_1.methodsPartialTemplate);
23
+ handlebars_1.default.registerPartial('constructorsPartialTemplate', constructors_partial_template_1.constructorsPartialTemplate);
24
+ handlebars_1.default.registerPartial('groupedMembersPartialTemplate', grouped_members_partial_template_1.groupedMembersPartialTemplate);
25
+ handlebars_1.default.registerPartial('fieldsPartialTemplate', fieldsPartialTemplate_1.fieldsPartialTemplate);
26
+ handlebars_1.default.registerPartial('classTemplate', class_template_1.classMarkdownTemplate);
27
+ handlebars_1.default.registerPartial('enumTemplate', enum_template_1.enumMarkdownTemplate);
28
+ handlebars_1.default.registerPartial('interfaceTemplate', interface_template_1.interfaceMarkdownTemplate);
29
+ handlebars_1.default.registerHelper('link', link);
30
+ handlebars_1.default.registerHelper('code', convertCodeBlock);
31
+ handlebars_1.default.registerHelper('withLinks', resolveLinksInContent);
32
+ handlebars_1.default.registerHelper('heading', heading);
33
+ handlebars_1.default.registerHelper('inlineCode', inlineCode);
34
+ handlebars_1.default.registerHelper('splitAndCapitalize', splitAndCapitalize);
35
+ }
36
+ static getInstance() {
37
+ if (!Template.instance) {
38
+ Template.instance = new Template();
39
+ }
40
+ return Template.instance;
41
+ }
42
+ compile(request) {
43
+ const compiled = handlebars_1.default.compile(request.template);
44
+ return (compiled(request.source)
45
+ .trim()
46
+ // clean up extra newlines
47
+ .replace(/\n{3,}/g, '\n\n'));
48
+ }
49
+ }
50
+ exports.Template = Template;
51
+ const splitAndCapitalize = (text) => {
52
+ const words = text.split(/[-_]+/);
53
+ const capitalizedWords = [];
54
+ for (const word of words) {
55
+ capitalizedWords.push(word.charAt(0).toUpperCase() + word.slice(1));
56
+ }
57
+ return capitalizedWords.join(' ');
58
+ };
59
+ const heading = (level, text) => {
60
+ return `${'#'.repeat(level)} ${text}`;
61
+ };
62
+ const inlineCode = (text) => {
63
+ return new handlebars_1.default.SafeString(`\`${text}\``);
64
+ };
65
+ const convertCodeBlock = (language, lines) => {
66
+ return new handlebars_1.default.SafeString(`
67
+ \`\`\`${language}
68
+ ${lines.join('\n')}
69
+ \`\`\`
70
+ `.trim());
71
+ };
72
+ const resolveLinksInContent = (description) => {
73
+ if (!description) {
74
+ return '';
75
+ }
76
+ function reduceDescription(acc, curr) {
77
+ if ((0, type_utils_1.isEmptyLine)(curr)) {
78
+ return acc + '\n\n';
79
+ }
80
+ return acc + link(curr).trim() + ' ';
81
+ }
82
+ return description.reduce(reduceDescription, '').trim();
83
+ };
84
+ const link = (source) => {
85
+ if (typeof source === 'string') {
86
+ return source;
87
+ }
88
+ else {
89
+ return `[${source.title}](${source.url})`;
90
+ }
91
+ };
92
+ //# sourceMappingURL=template.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"template.js","sourceRoot":"","sources":["../../src/core/template.ts"],"names":[],"mappings":";;;;;;AAAA,4DAAoC;AACpC,6FAAwF;AACxF,uHAAkH;AAClH,6GAAwG;AACxG,uHAAkH;AAClH,uGAAoG;AACpG,yFAA6F;AAC7F,uFAA2F;AAC3F,iGAAqG;AAErG,uDAAqD;AACrD,6HAAuH;AAOvH,MAAa,QAAQ;IAGnB;QACE,oBAAU,CAAC,eAAe,CAAC,mBAAmB,EAAE,iCAAc,CAAC,CAAC;QAChE,oBAAU,CAAC,eAAe,CAAC,6BAA6B,EAAE,2DAA2B,CAAC,CAAC;QACvF,oBAAU,CAAC,eAAe,CAAC,wBAAwB,EAAE,iDAAsB,CAAC,CAAC;QAC7E,oBAAU,CAAC,eAAe,CAAC,6BAA6B,EAAE,2DAA2B,CAAC,CAAC;QACvF,oBAAU,CAAC,eAAe,CAAC,+BAA+B,EAAE,gEAA6B,CAAC,CAAC;QAC3F,oBAAU,CAAC,eAAe,CAAC,uBAAuB,EAAE,6CAAqB,CAAC,CAAC;QAC3E,oBAAU,CAAC,eAAe,CAAC,eAAe,EAAE,sCAAqB,CAAC,CAAC;QACnE,oBAAU,CAAC,eAAe,CAAC,cAAc,EAAE,oCAAoB,CAAC,CAAC;QACjE,oBAAU,CAAC,eAAe,CAAC,mBAAmB,EAAE,8CAAyB,CAAC,CAAC;QAE3E,oBAAU,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACxC,oBAAU,CAAC,cAAc,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;QACpD,oBAAU,CAAC,cAAc,CAAC,WAAW,EAAE,qBAAqB,CAAC,CAAC;QAC9D,oBAAU,CAAC,cAAc,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QAC9C,oBAAU,CAAC,cAAc,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;QACpD,oBAAU,CAAC,cAAc,CAAC,oBAAoB,EAAE,kBAAkB,CAAC,CAAC;IACtE,CAAC;IAEM,MAAM,CAAC,WAAW;QACvB,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;YACvB,QAAQ,CAAC,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;QACrC,CAAC;QACD,OAAO,QAAQ,CAAC,QAAQ,CAAC;IAC3B,CAAC;IAED,OAAO,CAAC,OAA2B;QACjC,MAAM,QAAQ,GAAG,oBAAU,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACtD,OAAO,CACL,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC;aACrB,IAAI,EAAE;YACP,0BAA0B;aACzB,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,CAC9B,CAAC;IACJ,CAAC;CACF;AAtCD,4BAsCC;AAED,MAAM,kBAAkB,GAAG,CAAC,IAAY,EAAE,EAAE;IAC1C,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAClC,MAAM,gBAAgB,GAAG,EAAE,CAAC;IAC5B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACtE,CAAC;IACD,OAAO,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACpC,CAAC,CAAC;AAEF,MAAM,OAAO,GAAG,CAAC,KAAa,EAAE,IAAY,EAAE,EAAE;IAC9C,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC;AACxC,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,IAAY,EAAE,EAAE;IAClC,OAAO,IAAI,oBAAU,CAAC,UAAU,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC;AAClD,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,QAAgB,EAAE,KAAe,EAAyB,EAAE;IACpF,OAAO,IAAI,oBAAU,CAAC,UAAU,CAC9B;QACI,QAAQ;EACd,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;;GAEf,CAAC,IAAI,EAAE,CACP,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,qBAAqB,GAAG,CAAC,WAAiC,EAAU,EAAE;IAC1E,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,SAAS,iBAAiB,CAAC,GAAW,EAAE,IAAuB;QAC7D,IAAI,IAAA,wBAAW,EAAC,IAAI,CAAC,EAAE,CAAC;YACtB,OAAO,GAAG,GAAG,MAAM,CAAC;QACtB,CAAC;QAED,OAAO,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,GAAG,GAAG,CAAC;IACvC,CAAC;IAED,OAAO,WAAW,CAAC,MAAM,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;AAC1D,CAAC,CAAC;AAEF,MAAM,IAAI,GAAG,CAAC,MAAoB,EAAU,EAAE;IAC5C,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC/B,OAAO,MAAM,CAAC;IAChB,CAAC;SAAM,CAAC;QACN,OAAO,IAAI,MAAM,CAAC,KAAK,KAAK,MAAM,CAAC,GAAG,GAAG,CAAC;IAC5C,CAAC;AACH,CAAC,CAAC"}
@@ -0,0 +1 @@
1
+ export declare const referenceGuideTemplate: string;
@@ -0,0 +1,18 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.referenceGuideTemplate = void 0;
4
+ exports.referenceGuideTemplate = `
5
+ # Apex Reference Guide
6
+
7
+ {{#each this}}
8
+ ## {{@key}}
9
+
10
+ {{#each this}}
11
+ ### {{link title}}
12
+
13
+ {{withLinks description}}
14
+
15
+ {{/each}}
16
+ {{/each}}
17
+ `.trim();
18
+ //# sourceMappingURL=reference-guide.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"reference-guide.js","sourceRoot":"","sources":["../../../src/core/templates/reference-guide.ts"],"names":[],"mappings":";;;AAAa,QAAA,sBAAsB,GAAG;;;;;;;;;;;;;CAarC,CAAC,IAAI,EAAE,CAAC"}
package/lib/index.d.ts CHANGED
@@ -1 +1,2 @@
1
- export * from './service/manifest-factory';
1
+ import * as reflection from '@cparra/apex-reflection';
2
+ export { reflection };
package/lib/index.js CHANGED
@@ -1,18 +1,29 @@
1
- "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
- };
16
- Object.defineProperty(exports, "__esModule", { value: true });
17
- __exportStar(require("./service/manifest-factory"), exports);
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
15
+ }) : function(o, v) {
16
+ o["default"] = v;
17
+ });
18
+ var __importStar = (this && this.__importStar) || function (mod) {
19
+ if (mod && mod.__esModule) return mod;
20
+ var result = {};
21
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
22
+ __setModuleDefault(result, mod);
23
+ return result;
24
+ };
25
+ Object.defineProperty(exports, "__esModule", { value: true });
26
+ exports.reflection = void 0;
27
+ const reflection = __importStar(require("@cparra/apex-reflection"));
28
+ exports.reflection = reflection;
18
29
  //# sourceMappingURL=index.js.map
package/lib/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6DAA2C"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oEAAsD;AAE7C,gCAAU"}
@@ -1,6 +1,6 @@
1
- export default class ApexBundle {
2
- filePath: string;
3
- rawTypeContent: string;
4
- rawMetadataContent: string | null;
5
- constructor(filePath: string, rawTypeContent: string, rawMetadataContent: string | null);
6
- }
1
+ export default class ApexBundle {
2
+ filePath: string;
3
+ rawTypeContent: string;
4
+ rawMetadataContent: string | null;
5
+ constructor(filePath: string, rawTypeContent: string, rawMetadataContent: string | null);
6
+ }
@@ -1,11 +1,11 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- class ApexBundle {
4
- constructor(filePath, rawTypeContent, rawMetadataContent) {
5
- this.filePath = filePath;
6
- this.rawTypeContent = rawTypeContent;
7
- this.rawMetadataContent = rawMetadataContent;
8
- }
9
- }
10
- exports.default = ApexBundle;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ class ApexBundle {
4
+ constructor(filePath, rawTypeContent, rawMetadataContent) {
5
+ this.filePath = filePath;
6
+ this.rawTypeContent = rawTypeContent;
7
+ this.rawMetadataContent = rawMetadataContent;
8
+ }
9
+ }
10
+ exports.default = ApexBundle;
11
11
  //# sourceMappingURL=apex-bundle.js.map
@@ -1,7 +1,7 @@
1
- import { ClassMirror, MethodMirror } from '@cparra/apex-reflection';
2
- export declare class ClassMirrorWrapper {
3
- classMirror: ClassMirror;
4
- constructor(classMirror: ClassMirror);
5
- getMethodsByAnnotation(annotation: string): MethodMirror[];
6
- private hasAnnotation;
7
- }
1
+ import { ClassMirror, MethodMirror } from '@cparra/apex-reflection';
2
+ export declare class ClassMirrorWrapper {
3
+ classMirror: ClassMirror;
4
+ constructor(classMirror: ClassMirror);
5
+ getMethodsByAnnotation(annotation: string): MethodMirror[];
6
+ private hasAnnotation;
7
+ }
@@ -1,14 +1,14 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.ClassMirrorWrapper = void 0;
4
- class ClassMirrorWrapper {
5
- constructor(classMirror) {
6
- this.classMirror = classMirror;
7
- this.hasAnnotation = (method, annotationName) => method.annotations.some((annotation) => annotation.name.toLowerCase() === annotationName);
8
- }
9
- getMethodsByAnnotation(annotation) {
10
- return this.classMirror.methods.filter((method) => this.hasAnnotation(method, annotation));
11
- }
12
- }
13
- exports.ClassMirrorWrapper = ClassMirrorWrapper;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ClassMirrorWrapper = void 0;
4
+ class ClassMirrorWrapper {
5
+ constructor(classMirror) {
6
+ this.classMirror = classMirror;
7
+ this.hasAnnotation = (method, annotationName) => method.annotations.some((annotation) => annotation.name.toLowerCase() === annotationName);
8
+ }
9
+ getMethodsByAnnotation(annotation) {
10
+ return this.classMirror.methods.filter((method) => this.hasAnnotation(method, annotation));
11
+ }
12
+ }
13
+ exports.ClassMirrorWrapper = ClassMirrorWrapper;
14
14
  //# sourceMappingURL=ClassMirrorWrapper.js.map
@@ -1,7 +1,7 @@
1
- import { DocCommentAnnotation, MethodMirror } from '@cparra/apex-reflection';
2
- export declare class MethodMirrorWrapper {
3
- methodMirror: MethodMirror;
4
- constructor(methodMirror: MethodMirror);
5
- hasDocCommentAnnotation: (annotationName: string) => boolean | undefined;
6
- getDocCommentAnnotation: (annotationName: string) => DocCommentAnnotation | undefined;
7
- }
1
+ import { DocCommentAnnotation, MethodMirror } from '@cparra/apex-reflection';
2
+ export declare class MethodMirrorWrapper {
3
+ methodMirror: MethodMirror;
4
+ constructor(methodMirror: MethodMirror);
5
+ hasDocCommentAnnotation: (annotationName: string) => boolean | undefined;
6
+ getDocCommentAnnotation: (annotationName: string) => DocCommentAnnotation | undefined;
7
+ }
@@ -1,12 +1,12 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.MethodMirrorWrapper = void 0;
4
- class MethodMirrorWrapper {
5
- constructor(methodMirror) {
6
- this.methodMirror = methodMirror;
7
- this.hasDocCommentAnnotation = (annotationName) => { var _a; return (_a = this.methodMirror.docComment) === null || _a === void 0 ? void 0 : _a.annotations.some((annotation) => annotation.name.toLowerCase() === annotationName); };
8
- this.getDocCommentAnnotation = (annotationName) => { var _a; return (_a = this.methodMirror.docComment) === null || _a === void 0 ? void 0 : _a.annotations.find((annotation) => annotation.name.toLowerCase() === annotationName); };
9
- }
10
- }
11
- exports.MethodMirrorWrapper = MethodMirrorWrapper;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.MethodMirrorWrapper = void 0;
4
+ class MethodMirrorWrapper {
5
+ constructor(methodMirror) {
6
+ this.methodMirror = methodMirror;
7
+ this.hasDocCommentAnnotation = (annotationName) => { var _a; return (_a = this.methodMirror.docComment) === null || _a === void 0 ? void 0 : _a.annotations.some((annotation) => annotation.name.toLowerCase() === annotationName); };
8
+ this.getDocCommentAnnotation = (annotationName) => { var _a; return (_a = this.methodMirror.docComment) === null || _a === void 0 ? void 0 : _a.annotations.find((annotation) => annotation.name.toLowerCase() === annotationName); };
9
+ }
10
+ }
11
+ exports.MethodMirrorWrapper = MethodMirrorWrapper;
12
12
  //# sourceMappingURL=MethodMirrorWrapper.js.map
@@ -1,8 +1,8 @@
1
- import { FieldMirror, MethodMirror, PropertyMirror } from '@cparra/apex-reflection';
2
- export type InheritanceSupport = {
3
- inherited: boolean;
4
- };
5
- export type FieldMirrorWithInheritance = FieldMirror & InheritanceSupport;
6
- export type PropertyMirrorWithInheritance = PropertyMirror & InheritanceSupport;
7
- export type MethodMirrorWithInheritance = MethodMirror & InheritanceSupport;
8
- export type FieldOrProperty = FieldMirrorWithInheritance | PropertyMirrorWithInheritance;
1
+ import { FieldMirror, MethodMirror, PropertyMirror } from '@cparra/apex-reflection';
2
+ export type InheritanceSupport = {
3
+ inherited: boolean;
4
+ };
5
+ export type FieldMirrorWithInheritance = FieldMirror & InheritanceSupport;
6
+ export type PropertyMirrorWithInheritance = PropertyMirror & InheritanceSupport;
7
+ export type MethodMirrorWithInheritance = MethodMirror & InheritanceSupport;
8
+ export type FieldOrProperty = FieldMirrorWithInheritance | PropertyMirrorWithInheritance;
@@ -1,3 +1,3 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  //# sourceMappingURL=inheritance.js.map