@cparra/apexdocs 2.25.0-alpha.0 → 2.25.0-alpha.10

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 (494) hide show
  1. package/README.md +37 -0
  2. package/__mocks__/chalk.js +12 -0
  3. package/__mocks__/log-update.js +6 -0
  4. package/dist/cli/generate.js +2963 -0
  5. package/dist/defaults-DUwru49Q.js +12 -0
  6. package/dist/defaults-SH0Rsi5E.js +11 -0
  7. package/dist/defaults-jLXD2y8-.js +13 -0
  8. package/dist/index.d.ts +101 -0
  9. package/dist/index.js +36 -0
  10. package/eslint.config.mjs +10 -0
  11. package/examples/markdown/docs/index.md +109 -0
  12. package/examples/markdown/docs/miscellaneous/BaseClass.md +16 -0
  13. package/examples/markdown/docs/miscellaneous/MultiInheritanceClass.md +72 -0
  14. package/examples/markdown/docs/miscellaneous/ParentInterface.md +15 -0
  15. package/examples/markdown/docs/miscellaneous/ReferencedEnum.md +8 -0
  16. package/examples/markdown/docs/miscellaneous/SampleException.md +24 -0
  17. package/examples/markdown/docs/miscellaneous/SampleInterface.md +112 -0
  18. package/examples/markdown/docs/miscellaneous/Url.md +309 -0
  19. package/examples/markdown/docs/sample-enums/SampleEnum.md +36 -0
  20. package/examples/markdown/docs/samplegroup/SampleClass.md +170 -0
  21. package/examples/markdown/force-app/classes/MultiInheritanceClass.cls +1 -0
  22. package/examples/{plain-markdown → markdown}/force-app/classes/SampleClass.cls +37 -0
  23. package/examples/markdown/force-app/classes/SampleException.cls +17 -0
  24. package/examples/markdown/force-app/classes/Url.cls +194 -0
  25. package/examples/{plain-markdown → markdown}/package.json +4 -8
  26. package/examples/vitepress/.forceignore +12 -0
  27. package/examples/vitepress/apexdocs.config.ts +106 -0
  28. package/examples/vitepress/config/project-scratch-def.json +13 -0
  29. package/examples/vitepress/docs/.vitepress/cache/deps/@theme_index.js +259 -0
  30. package/examples/vitepress/docs/.vitepress/cache/deps/@theme_index.js.map +7 -0
  31. package/examples/vitepress/docs/.vitepress/cache/deps/_metadata.json +40 -0
  32. package/examples/vitepress/docs/.vitepress/cache/deps/chunk-574YRH25.js +11474 -0
  33. package/examples/vitepress/docs/.vitepress/cache/deps/chunk-574YRH25.js.map +7 -0
  34. package/examples/vitepress/docs/.vitepress/cache/deps/chunk-E5DZZB2I.js +9172 -0
  35. package/examples/vitepress/docs/.vitepress/cache/deps/chunk-E5DZZB2I.js.map +7 -0
  36. package/examples/vitepress/docs/.vitepress/cache/deps/package.json +3 -0
  37. package/examples/vitepress/docs/.vitepress/cache/deps/vitepress___@vue_devtools-api.js +4339 -0
  38. package/examples/vitepress/docs/.vitepress/cache/deps/vitepress___@vue_devtools-api.js.map +7 -0
  39. package/examples/vitepress/docs/.vitepress/cache/deps/vitepress___@vueuse_core.js +567 -0
  40. package/examples/vitepress/docs/.vitepress/cache/deps/vitepress___@vueuse_core.js.map +7 -0
  41. package/examples/vitepress/docs/.vitepress/cache/deps/vue.js +323 -0
  42. package/examples/vitepress/docs/.vitepress/cache/deps/vue.js.map +7 -0
  43. package/examples/vitepress/docs/.vitepress/config.mts +21 -0
  44. package/examples/vitepress/docs/.vitepress/sidebar.json +119 -0
  45. package/examples/vitepress/docs/api-examples.md +49 -0
  46. package/examples/vitepress/docs/index-frontmatter.md +16 -0
  47. package/examples/vitepress/docs/index.md +56 -0
  48. package/examples/vitepress/docs/markdown-examples.md +85 -0
  49. package/examples/vitepress/docs/miscellaneous/BaseClass.md +20 -0
  50. package/examples/vitepress/docs/miscellaneous/MultiInheritanceClass.md +76 -0
  51. package/examples/vitepress/docs/miscellaneous/ParentInterface.md +19 -0
  52. package/examples/vitepress/docs/miscellaneous/ReferencedEnum.md +15 -0
  53. package/examples/vitepress/docs/miscellaneous/SampleException.md +28 -0
  54. package/examples/vitepress/docs/miscellaneous/SampleInterface.md +116 -0
  55. package/examples/vitepress/docs/miscellaneous/Url.md +317 -0
  56. package/examples/vitepress/docs/sample-enums/SampleEnum.md +40 -0
  57. package/examples/vitepress/docs/samplegroup/SampleClass.md +174 -0
  58. package/examples/vitepress/force-app/main/default/classes/BaseClass.cls +3 -0
  59. package/examples/vitepress/force-app/main/default/classes/MultiInheritanceClass.cls +1 -0
  60. package/examples/vitepress/force-app/main/default/classes/ParentInterface.cls +3 -0
  61. package/examples/vitepress/force-app/main/default/classes/ReferencedEnum.cls +5 -0
  62. package/examples/vitepress/force-app/main/default/classes/SampleClass.cls +72 -0
  63. package/examples/vitepress/force-app/main/default/classes/SampleEnum.cls +30 -0
  64. package/examples/vitepress/force-app/main/default/classes/SampleException.cls +17 -0
  65. package/examples/vitepress/force-app/main/default/classes/SampleInterface.cls +46 -0
  66. package/examples/vitepress/force-app/main/default/classes/Url.cls +198 -0
  67. package/examples/vitepress/package-lock.json +2574 -0
  68. package/examples/vitepress/package.json +18 -0
  69. package/examples/vitepress/sfdx-project.json +12 -0
  70. package/jest.config.js +6 -1
  71. package/jest.d.ts +7 -0
  72. package/package.json +29 -30
  73. package/src/application/Apexdocs.ts +17 -70
  74. package/src/application/__tests__/apex-file-reader.spec.ts +104 -0
  75. package/src/application/apex-file-reader.ts +42 -0
  76. package/src/application/file-writer.ts +21 -0
  77. package/src/application/generators/markdown.ts +58 -0
  78. package/src/application/generators/openapi.ts +56 -0
  79. package/src/cli/args.ts +43 -0
  80. package/src/cli/commands/markdown.ts +52 -0
  81. package/src/cli/generate.ts +10 -134
  82. package/src/core/manifest.ts +90 -0
  83. package/src/core/markdown/__test__/expect-extensions.ts +32 -0
  84. package/src/core/markdown/__test__/generating-class-docs.spec.ts +735 -0
  85. package/src/core/markdown/__test__/generating-enum-docs.spec.ts +385 -0
  86. package/src/core/markdown/__test__/generating-interface-docs.spec.ts +461 -0
  87. package/src/core/markdown/__test__/generating-reference-guide.spec.ts +180 -0
  88. package/src/core/markdown/__test__/inheritance-chain.test.ts +54 -0
  89. package/src/core/markdown/__test__/test-helpers.ts +23 -0
  90. package/src/core/markdown/adapters/__tests__/documentables.spec.ts +109 -0
  91. package/src/core/markdown/adapters/__tests__/interface-adapter.spec.ts +148 -0
  92. package/src/{adapters → core/markdown/adapters}/__tests__/references.spec.ts +23 -2
  93. package/src/core/markdown/adapters/apex-types.ts +238 -0
  94. package/src/core/markdown/adapters/documentables.ts +116 -0
  95. package/src/core/markdown/adapters/fields-and-properties.ts +45 -0
  96. package/src/{adapters/references.ts → core/markdown/adapters/inline.ts} +43 -13
  97. package/src/core/markdown/adapters/methods-and-constructors.ts +133 -0
  98. package/src/core/markdown/adapters/reference-guide.ts +35 -0
  99. package/src/core/markdown/adapters/renderable-bundle.ts +78 -0
  100. package/src/core/markdown/adapters/renderable-to-page-data.ts +89 -0
  101. package/src/core/markdown/adapters/type-utils.ts +13 -0
  102. package/src/core/markdown/adapters/types.d.ts +180 -0
  103. package/src/core/markdown/generate-docs.ts +216 -0
  104. package/src/core/markdown/reflection/error-handling.ts +37 -0
  105. package/src/core/markdown/reflection/filter-scope.ts +13 -0
  106. package/src/core/markdown/reflection/inheritance-chain-expanion.ts +22 -0
  107. package/src/core/markdown/reflection/inheritance-chain.ts +23 -0
  108. package/src/core/markdown/reflection/inherited-member-expansion.ts +105 -0
  109. package/src/core/markdown/reflection/reflect-source.ts +45 -0
  110. package/src/core/markdown/reflection/sort-members.ts +59 -0
  111. package/src/core/markdown/templates/class-template.ts +75 -0
  112. package/src/core/markdown/templates/constructors-partial-template.ts +32 -0
  113. package/src/core/markdown/templates/documentable-partial-template.ts +26 -0
  114. package/src/core/markdown/templates/enum-template.ts +12 -0
  115. package/src/core/markdown/templates/fieldsPartialTemplate.ts +23 -0
  116. package/src/core/markdown/templates/grouped-members-partial-template.ts +6 -0
  117. package/src/core/markdown/templates/hookable.ts +7 -0
  118. package/src/{transpiler/markdown/plain-markdown → core/markdown/templates}/interface-template.ts +4 -4
  119. package/src/core/markdown/templates/methods-partial-template.ts +43 -0
  120. package/src/core/markdown/templates/reference-guide.ts +14 -0
  121. package/src/core/markdown/templates/template.ts +114 -0
  122. package/src/core/markdown/templates/type-doc-partial.ts +27 -0
  123. package/src/core/markdown/utils.ts +3 -0
  124. package/src/{transpiler → core}/openapi/__tests__/open-api-docs-processor.spec.ts +1 -1
  125. package/src/{model → core/openapi}/apex-type-wrappers/__tests__/ClassMirrorWrapper.spec.ts +3 -3
  126. package/src/core/openapi/file-container.ts +13 -0
  127. package/src/{service → core/openapi}/manifest-factory.ts +3 -3
  128. package/src/{transpiler → core}/openapi/open-api-docs-processor.ts +9 -10
  129. package/src/core/openapi/openapi-type-file.ts +12 -0
  130. package/src/{service → core/openapi}/parser.ts +9 -9
  131. package/src/{transpiler → core}/openapi/parsers/Builder.ts +2 -2
  132. package/src/{transpiler → core}/openapi/parsers/MethodParser.ts +5 -5
  133. package/src/{transpiler → core}/openapi/parsers/ParameterObjectBuilder.ts +2 -2
  134. package/src/{transpiler → core}/openapi/parsers/ReferenceBuilder.ts +6 -5
  135. package/src/{transpiler → core}/openapi/parsers/RequestBodyBuilder.ts +2 -2
  136. package/src/{transpiler → core}/openapi/parsers/ResponsesBuilder.ts +2 -2
  137. package/src/{transpiler → core}/openapi/parsers/__tests__/MethodParser.spec.ts +1 -1
  138. package/src/{transpiler → core}/openapi/parsers/__tests__/ParameterObjectBuilder.spec.ts +2 -2
  139. package/src/{transpiler → core}/openapi/parsers/__tests__/ReferenceBuilder.spec.ts +2 -2
  140. package/src/{transpiler → core}/openapi/parsers/__tests__/RequestBodyBuilder.spec.ts +2 -2
  141. package/src/{transpiler → core}/openapi/parsers/__tests__/ResponsesBuilder.spec.ts +1 -1
  142. package/src/{transpiler → core/openapi}/transpiler.ts +2 -6
  143. package/src/{model → core/openapi}/types-repository.ts +0 -9
  144. package/src/core/parse-apex-metadata.ts +14 -0
  145. package/src/core/settings.ts +56 -0
  146. package/src/core/shared/types.d.ts +131 -0
  147. package/src/core/shared/utils.ts +5 -0
  148. package/src/defaults.ts +9 -0
  149. package/src/index.ts +41 -1
  150. package/src/test-helpers/ClassMirrorBuilder.ts +14 -1
  151. package/src/test-helpers/InterfaceMirrorBuilder.ts +0 -5
  152. package/src/test-helpers/SettingsBuilder.ts +1 -4
  153. package/src/util/fp.ts +3 -0
  154. package/src/util/logger.ts +3 -3
  155. package/src/util/string-utils.ts +0 -4
  156. package/tsconfig.json +7 -3
  157. package/.eslintrc.js +0 -12
  158. package/apexdocs.config.ts +0 -13
  159. package/docs/.nojekyll +0 -0
  160. package/docs/__old/README.md +0 -1
  161. package/docs/__old/index.html +0 -22
  162. package/docs/__old/restapi.json +0 -589
  163. package/docs/__old/types/Classes/nspc.AnotherInterface.md +0 -22
  164. package/docs/__old/types/Classes/nspc.ChildClass.md +0 -97
  165. package/docs/__old/types/Main/nspc.GroupedClass.md +0 -10
  166. package/docs/__old/types/Main/nspc.SampleClass.md +0 -189
  167. package/docs/__old/types/Misc-Group/nspc.EscapedAnnotations.md +0 -4
  168. package/docs/__old/types/Misc-Group/nspc.GrandparentClass.md +0 -13
  169. package/docs/__old/types/Misc-Group/nspc.InterfaceWithInheritance.md +0 -29
  170. package/docs/__old/types/Misc-Group/nspc.MemberGrouping.md +0 -13
  171. package/docs/__old/types/Misc-Group/nspc.ParentClass.md +0 -37
  172. package/docs/__old/types/Misc-Group/nspc.Reference1.md +0 -18
  173. package/docs/__old/types/Misc-Group/nspc.Reference2.md +0 -12
  174. package/docs/__old/types/Misc-Group/nspc.Reference3.md +0 -7
  175. package/docs/__old/types/Misc-Group/nspc.Reference4.md +0 -7
  176. package/docs/__old/types/Misc-Group/nspc.Reference5.md +0 -7
  177. package/docs/__old/types/Misc-Group/nspc.Reference6.md +0 -9
  178. package/docs/__old/types/Misc-Group/nspc.Reference7.md +0 -7
  179. package/docs/__old/types/Misc-Group/nspc.SampleClassWithoutModifier.md +0 -11
  180. package/docs/__old/types/Misc-Group/nspc.SampleRestResource.md +0 -104
  181. package/docs/__old/types/Misc-Group/nspc.SampleRestResourceWithInnerClass.md +0 -33
  182. package/docs/__old/types/Misc-Group/nspc.SampleRestResourceWithoutApexDocs.md +0 -14
  183. package/docs/__old/types/README.md +0 -97
  184. package/docs/__old/types/Sample-Interfaces/nspc.SampleInterface.md +0 -23
  185. package/examples/includes/header.md +0 -3
  186. package/examples/plain-markdown/README.md +0 -301
  187. package/examples/plain-markdown/force-app/classes/SampleException.cls +0 -1
  188. package/examples/plain-markdown/template.md +0 -3
  189. package/lib/adapters/apex-types.d.ts +0 -5
  190. package/lib/adapters/apex-types.js +0 -34
  191. package/lib/adapters/apex-types.js.map +0 -1
  192. package/lib/adapters/documentables.d.ts +0 -6
  193. package/lib/adapters/documentables.js +0 -41
  194. package/lib/adapters/documentables.js.map +0 -1
  195. package/lib/adapters/fields-and-properties.d.ts +0 -3
  196. package/lib/adapters/fields-and-properties.js +0 -10
  197. package/lib/adapters/fields-and-properties.js.map +0 -1
  198. package/lib/adapters/methods-and-constructors.d.ts +0 -4
  199. package/lib/adapters/methods-and-constructors.js +0 -49
  200. package/lib/adapters/methods-and-constructors.js.map +0 -1
  201. package/lib/adapters/references.d.ts +0 -5
  202. package/lib/adapters/references.js +0 -82
  203. package/lib/adapters/references.js.map +0 -1
  204. package/lib/adapters/type-utils.d.ts +0 -2
  205. package/lib/adapters/type-utils.js +0 -8
  206. package/lib/adapters/type-utils.js.map +0 -1
  207. package/lib/application/Apexdocs.d.ts +0 -13
  208. package/lib/application/Apexdocs.js +0 -80
  209. package/lib/application/Apexdocs.js.map +0 -1
  210. package/lib/cli/generate.d.ts +0 -2
  211. package/lib/cli/generate.js +0 -157
  212. package/lib/cli/generate.js.map +0 -1
  213. package/lib/index.d.ts +0 -1
  214. package/lib/index.js +0 -18
  215. package/lib/index.js.map +0 -1
  216. package/lib/model/apex-bundle.d.ts +0 -6
  217. package/lib/model/apex-bundle.js +0 -11
  218. package/lib/model/apex-bundle.js.map +0 -1
  219. package/lib/model/apex-type-wrappers/ClassMirrorWrapper.d.ts +0 -7
  220. package/lib/model/apex-type-wrappers/ClassMirrorWrapper.js +0 -14
  221. package/lib/model/apex-type-wrappers/ClassMirrorWrapper.js.map +0 -1
  222. package/lib/model/apex-type-wrappers/MethodMirrorWrapper.d.ts +0 -7
  223. package/lib/model/apex-type-wrappers/MethodMirrorWrapper.js +0 -12
  224. package/lib/model/apex-type-wrappers/MethodMirrorWrapper.js.map +0 -1
  225. package/lib/model/inheritance.d.ts +0 -8
  226. package/lib/model/inheritance.js +0 -3
  227. package/lib/model/inheritance.js.map +0 -1
  228. package/lib/model/manifest.d.ts +0 -22
  229. package/lib/model/manifest.js +0 -47
  230. package/lib/model/manifest.js.map +0 -1
  231. package/lib/model/markdown-file.d.ts +0 -16
  232. package/lib/model/markdown-file.js +0 -110
  233. package/lib/model/markdown-file.js.map +0 -1
  234. package/lib/model/markdown-generation-util/doc-comment-annotation-util.d.ts +0 -8
  235. package/lib/model/markdown-generation-util/doc-comment-annotation-util.js +0 -47
  236. package/lib/model/markdown-generation-util/doc-comment-annotation-util.js.map +0 -1
  237. package/lib/model/markdown-generation-util/field-declaration-util.d.ts +0 -3
  238. package/lib/model/markdown-generation-util/field-declaration-util.js +0 -55
  239. package/lib/model/markdown-generation-util/field-declaration-util.js.map +0 -1
  240. package/lib/model/markdown-generation-util/index.d.ts +0 -3
  241. package/lib/model/markdown-generation-util/index.js +0 -20
  242. package/lib/model/markdown-generation-util/index.js.map +0 -1
  243. package/lib/model/markdown-generation-util/method-declaration-util.d.ts +0 -4
  244. package/lib/model/markdown-generation-util/method-declaration-util.js +0 -115
  245. package/lib/model/markdown-generation-util/method-declaration-util.js.map +0 -1
  246. package/lib/model/markdown-generation-util/type-declaration-util.d.ts +0 -3
  247. package/lib/model/markdown-generation-util/type-declaration-util.js +0 -82
  248. package/lib/model/markdown-generation-util/type-declaration-util.js.map +0 -1
  249. package/lib/model/markdown-home-file.d.ts +0 -11
  250. package/lib/model/markdown-home-file.js +0 -57
  251. package/lib/model/markdown-home-file.js.map +0 -1
  252. package/lib/model/markdown-type-file.d.ts +0 -26
  253. package/lib/model/markdown-type-file.js +0 -137
  254. package/lib/model/markdown-type-file.js.map +0 -1
  255. package/lib/model/openapi/apex-doc-types.d.ts +0 -19
  256. package/lib/model/openapi/apex-doc-types.js +0 -5
  257. package/lib/model/openapi/apex-doc-types.js.map +0 -1
  258. package/lib/model/openapi/open-api-types.d.ts +0 -93
  259. package/lib/model/openapi/open-api-types.js +0 -3
  260. package/lib/model/openapi/open-api-types.js.map +0 -1
  261. package/lib/model/openapi/open-api.d.ts +0 -16
  262. package/lib/model/openapi/open-api.js +0 -34
  263. package/lib/model/openapi/open-api.js.map +0 -1
  264. package/lib/model/openapi/openapi-type-file.d.ts +0 -7
  265. package/lib/model/openapi/openapi-type-file.js +0 -17
  266. package/lib/model/openapi/openapi-type-file.js.map +0 -1
  267. package/lib/model/outputFile.d.ts +0 -10
  268. package/lib/model/outputFile.js +0 -29
  269. package/lib/model/outputFile.js.map +0 -1
  270. package/lib/model/types-repository.d.ts +0 -16
  271. package/lib/model/types-repository.js +0 -54
  272. package/lib/model/types-repository.js.map +0 -1
  273. package/lib/service/apex-file-reader.d.ts +0 -14
  274. package/lib/service/apex-file-reader.js +0 -49
  275. package/lib/service/apex-file-reader.js.map +0 -1
  276. package/lib/service/file-system.d.ts +0 -14
  277. package/lib/service/file-system.js +0 -48
  278. package/lib/service/file-system.js.map +0 -1
  279. package/lib/service/file-writer.d.ts +0 -6
  280. package/lib/service/file-writer.js +0 -57
  281. package/lib/service/file-writer.js.map +0 -1
  282. package/lib/service/manifest-factory.d.ts +0 -10
  283. package/lib/service/manifest-factory.js +0 -17
  284. package/lib/service/manifest-factory.js.map +0 -1
  285. package/lib/service/metadata-processor.d.ts +0 -3
  286. package/lib/service/metadata-processor.js +0 -17
  287. package/lib/service/metadata-processor.js.map +0 -1
  288. package/lib/service/parser.d.ts +0 -21
  289. package/lib/service/parser.js +0 -138
  290. package/lib/service/parser.js.map +0 -1
  291. package/lib/service/state.d.ts +0 -9
  292. package/lib/service/state.js +0 -20
  293. package/lib/service/state.js.map +0 -1
  294. package/lib/service/walkers/class-walker.d.ts +0 -4
  295. package/lib/service/walkers/class-walker.js +0 -33
  296. package/lib/service/walkers/class-walker.js.map +0 -1
  297. package/lib/service/walkers/enum-walker.d.ts +0 -4
  298. package/lib/service/walkers/enum-walker.js +0 -11
  299. package/lib/service/walkers/enum-walker.js.map +0 -1
  300. package/lib/service/walkers/interface-walker.d.ts +0 -4
  301. package/lib/service/walkers/interface-walker.js +0 -15
  302. package/lib/service/walkers/interface-walker.js.map +0 -1
  303. package/lib/service/walkers/walker-factory.d.ts +0 -5
  304. package/lib/service/walkers/walker-factory.js +0 -21
  305. package/lib/service/walkers/walker-factory.js.map +0 -1
  306. package/lib/service/walkers/walker.d.ts +0 -19
  307. package/lib/service/walkers/walker.js +0 -17
  308. package/lib/service/walkers/walker.js.map +0 -1
  309. package/lib/settings.d.ts +0 -70
  310. package/lib/settings.js +0 -100
  311. package/lib/settings.js.map +0 -1
  312. package/lib/templating/compile.d.ts +0 -7
  313. package/lib/templating/compile.js +0 -98
  314. package/lib/templating/compile.js.map +0 -1
  315. package/lib/templating/helpers.d.ts +0 -2
  316. package/lib/templating/helpers.js +0 -18
  317. package/lib/templating/helpers.js.map +0 -1
  318. package/lib/test-helpers/AnnotationBuilder.d.ts +0 -12
  319. package/lib/test-helpers/AnnotationBuilder.js +0 -31
  320. package/lib/test-helpers/AnnotationBuilder.js.map +0 -1
  321. package/lib/test-helpers/ClassMirrorBuilder.d.ts +0 -18
  322. package/lib/test-helpers/ClassMirrorBuilder.js +0 -54
  323. package/lib/test-helpers/ClassMirrorBuilder.js.map +0 -1
  324. package/lib/test-helpers/DocCommentAnnotationBuilder.d.ts +0 -8
  325. package/lib/test-helpers/DocCommentAnnotationBuilder.js +0 -26
  326. package/lib/test-helpers/DocCommentAnnotationBuilder.js.map +0 -1
  327. package/lib/test-helpers/DocCommentBuilder.d.ts +0 -12
  328. package/lib/test-helpers/DocCommentBuilder.js +0 -38
  329. package/lib/test-helpers/DocCommentBuilder.js.map +0 -1
  330. package/lib/test-helpers/FieldMirrorBuilder.d.ts +0 -18
  331. package/lib/test-helpers/FieldMirrorBuilder.js +0 -54
  332. package/lib/test-helpers/FieldMirrorBuilder.js.map +0 -1
  333. package/lib/test-helpers/InterfaceMirrorBuilder.d.ts +0 -16
  334. package/lib/test-helpers/InterfaceMirrorBuilder.js +0 -43
  335. package/lib/test-helpers/InterfaceMirrorBuilder.js.map +0 -1
  336. package/lib/test-helpers/MethodMirrorBuilder.d.ts +0 -29
  337. package/lib/test-helpers/MethodMirrorBuilder.js +0 -72
  338. package/lib/test-helpers/MethodMirrorBuilder.js.map +0 -1
  339. package/lib/test-helpers/SettingsBuilder.d.ts +0 -8
  340. package/lib/test-helpers/SettingsBuilder.js +0 -27
  341. package/lib/test-helpers/SettingsBuilder.js.map +0 -1
  342. package/lib/transpiler/factory.d.ts +0 -6
  343. package/lib/transpiler/factory.js +0 -35
  344. package/lib/transpiler/factory.js.map +0 -1
  345. package/lib/transpiler/file-container.d.ts +0 -6
  346. package/lib/transpiler/file-container.js +0 -16
  347. package/lib/transpiler/file-container.js.map +0 -1
  348. package/lib/transpiler/generator-choices.d.ts +0 -1
  349. package/lib/transpiler/generator-choices.js +0 -3
  350. package/lib/transpiler/generator-choices.js.map +0 -1
  351. package/lib/transpiler/markdown/class-file-generatorHelper.d.ts +0 -11
  352. package/lib/transpiler/markdown/class-file-generatorHelper.js +0 -75
  353. package/lib/transpiler/markdown/class-file-generatorHelper.js.map +0 -1
  354. package/lib/transpiler/markdown/docsify/docsify-docs-processor.d.ts +0 -6
  355. package/lib/transpiler/markdown/docsify/docsify-docs-processor.js +0 -13
  356. package/lib/transpiler/markdown/docsify/docsify-docs-processor.js.map +0 -1
  357. package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.d.ts +0 -11
  358. package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.js +0 -51
  359. package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.js.map +0 -1
  360. package/lib/transpiler/markdown/markdown-transpiler-base.d.ts +0 -11
  361. package/lib/transpiler/markdown/markdown-transpiler-base.js +0 -27
  362. package/lib/transpiler/markdown/markdown-transpiler-base.js.map +0 -1
  363. package/lib/transpiler/markdown/plain-markdown/class-template.d.ts +0 -1
  364. package/lib/transpiler/markdown/plain-markdown/class-template.js +0 -36
  365. package/lib/transpiler/markdown/plain-markdown/class-template.js.map +0 -1
  366. package/lib/transpiler/markdown/plain-markdown/constructors-partial-template.d.ts +0 -1
  367. package/lib/transpiler/markdown/plain-markdown/constructors-partial-template.js +0 -39
  368. package/lib/transpiler/markdown/plain-markdown/constructors-partial-template.js.map +0 -1
  369. package/lib/transpiler/markdown/plain-markdown/documentable-partial-template.d.ts +0 -1
  370. package/lib/transpiler/markdown/plain-markdown/documentable-partial-template.js +0 -25
  371. package/lib/transpiler/markdown/plain-markdown/documentable-partial-template.js.map +0 -1
  372. package/lib/transpiler/markdown/plain-markdown/enum-template.d.ts +0 -1
  373. package/lib/transpiler/markdown/plain-markdown/enum-template.js +0 -15
  374. package/lib/transpiler/markdown/plain-markdown/enum-template.js.map +0 -1
  375. package/lib/transpiler/markdown/plain-markdown/fieldsPartialTemplate.d.ts +0 -1
  376. package/lib/transpiler/markdown/plain-markdown/fieldsPartialTemplate.js +0 -24
  377. package/lib/transpiler/markdown/plain-markdown/fieldsPartialTemplate.js.map +0 -1
  378. package/lib/transpiler/markdown/plain-markdown/interface-template.d.ts +0 -1
  379. package/lib/transpiler/markdown/plain-markdown/interface-template.js +0 -20
  380. package/lib/transpiler/markdown/plain-markdown/interface-template.js.map +0 -1
  381. package/lib/transpiler/markdown/plain-markdown/methods-partial-template.d.ts +0 -1
  382. package/lib/transpiler/markdown/plain-markdown/methods-partial-template.js +0 -49
  383. package/lib/transpiler/markdown/plain-markdown/methods-partial-template.js.map +0 -1
  384. package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.d.ts +0 -13
  385. package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.js +0 -122
  386. package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.js.map +0 -1
  387. package/lib/transpiler/markdown/plain-markdown/type-level-apex-doc-partial-template.d.ts +0 -1
  388. package/lib/transpiler/markdown/plain-markdown/type-level-apex-doc-partial-template.js +0 -31
  389. package/lib/transpiler/markdown/plain-markdown/type-level-apex-doc-partial-template.js.map +0 -1
  390. package/lib/transpiler/openapi/open-api-docs-processor.d.ts +0 -13
  391. package/lib/transpiler/openapi/open-api-docs-processor.js +0 -78
  392. package/lib/transpiler/openapi/open-api-docs-processor.js.map +0 -1
  393. package/lib/transpiler/openapi/parsers/Builder.d.ts +0 -16
  394. package/lib/transpiler/openapi/parsers/Builder.js +0 -30
  395. package/lib/transpiler/openapi/parsers/Builder.js.map +0 -1
  396. package/lib/transpiler/openapi/parsers/MethodParser.d.ts +0 -20
  397. package/lib/transpiler/openapi/parsers/MethodParser.js +0 -190
  398. package/lib/transpiler/openapi/parsers/MethodParser.js.map +0 -1
  399. package/lib/transpiler/openapi/parsers/ParameterObjectBuilder.d.ts +0 -7
  400. package/lib/transpiler/openapi/parsers/ParameterObjectBuilder.js +0 -11
  401. package/lib/transpiler/openapi/parsers/ParameterObjectBuilder.js.map +0 -1
  402. package/lib/transpiler/openapi/parsers/ReferenceBuilder.d.ts +0 -39
  403. package/lib/transpiler/openapi/parsers/ReferenceBuilder.js +0 -249
  404. package/lib/transpiler/openapi/parsers/ReferenceBuilder.js.map +0 -1
  405. package/lib/transpiler/openapi/parsers/RequestBodyBuilder.d.ts +0 -10
  406. package/lib/transpiler/openapi/parsers/RequestBodyBuilder.js +0 -20
  407. package/lib/transpiler/openapi/parsers/RequestBodyBuilder.js.map +0 -1
  408. package/lib/transpiler/openapi/parsers/ResponsesBuilder.d.ts +0 -7
  409. package/lib/transpiler/openapi/parsers/ResponsesBuilder.js +0 -22
  410. package/lib/transpiler/openapi/parsers/ResponsesBuilder.js.map +0 -1
  411. package/lib/transpiler/processor-type-transpiler.d.ts +0 -10
  412. package/lib/transpiler/processor-type-transpiler.js +0 -9
  413. package/lib/transpiler/processor-type-transpiler.js.map +0 -1
  414. package/lib/transpiler/transpiler.d.ts +0 -5
  415. package/lib/transpiler/transpiler.js +0 -30
  416. package/lib/transpiler/transpiler.js.map +0 -1
  417. package/lib/util/error-logger.d.ts +0 -8
  418. package/lib/util/error-logger.js +0 -90
  419. package/lib/util/error-logger.js.map +0 -1
  420. package/lib/util/logger.d.ts +0 -21
  421. package/lib/util/logger.js +0 -61
  422. package/lib/util/logger.js.map +0 -1
  423. package/lib/util/string-utils.d.ts +0 -2
  424. package/lib/util/string-utils.js +0 -15
  425. package/lib/util/string-utils.js.map +0 -1
  426. package/src/adapters/__tests__/interface-adapter.spec.ts +0 -76
  427. package/src/adapters/apex-types.ts +0 -67
  428. package/src/adapters/documentables.ts +0 -58
  429. package/src/adapters/fields-and-properties.ts +0 -14
  430. package/src/adapters/methods-and-constructors.ts +0 -78
  431. package/src/adapters/type-utils.ts +0 -5
  432. package/src/adapters/types.d.ts +0 -8
  433. package/src/model/apex-bundle.ts +0 -3
  434. package/src/model/inheritance.ts +0 -7
  435. package/src/model/manifest.ts +0 -74
  436. package/src/model/markdown-file.ts +0 -121
  437. package/src/model/markdown-generation-util/doc-comment-annotation-util.ts +0 -50
  438. package/src/model/markdown-generation-util/field-declaration-util.ts +0 -71
  439. package/src/model/markdown-generation-util/index.ts +0 -3
  440. package/src/model/markdown-generation-util/method-declaration-util.ts +0 -166
  441. package/src/model/markdown-generation-util/type-declaration-util.ts +0 -91
  442. package/src/model/markdown-home-file.ts +0 -58
  443. package/src/model/markdown-type-file.ts +0 -165
  444. package/src/model/openapi/openapi-type-file.ts +0 -14
  445. package/src/model/outputFile.ts +0 -29
  446. package/src/service/__tests__/apex-file-reader.spec.ts +0 -92
  447. package/src/service/apex-file-reader.ts +0 -51
  448. package/src/service/file-writer.ts +0 -34
  449. package/src/service/metadata-processor.ts +0 -16
  450. package/src/service/state.ts +0 -24
  451. package/src/service/walkers/class-walker.ts +0 -30
  452. package/src/service/walkers/enum-walker.ts +0 -7
  453. package/src/service/walkers/interface-walker.ts +0 -12
  454. package/src/service/walkers/walker-factory.ts +0 -19
  455. package/src/service/walkers/walker.ts +0 -42
  456. package/src/settings.ts +0 -162
  457. package/src/templating/__tests__/compile.spec.ts +0 -741
  458. package/src/templating/compile.ts +0 -187
  459. package/src/templating/helpers.ts +0 -14
  460. package/src/templating/types.d.ts +0 -104
  461. package/src/transpiler/factory.ts +0 -33
  462. package/src/transpiler/file-container.ts +0 -13
  463. package/src/transpiler/generator-choices.ts +0 -1
  464. package/src/transpiler/markdown/class-file-generatorHelper.ts +0 -78
  465. package/src/transpiler/markdown/docsify/docsify-docs-processor.ts +0 -12
  466. package/src/transpiler/markdown/jekyll/jekyll-docsProcessor.ts +0 -50
  467. package/src/transpiler/markdown/markdown-transpiler-base.ts +0 -28
  468. package/src/transpiler/markdown/plain-markdown/class-template.ts +0 -32
  469. package/src/transpiler/markdown/plain-markdown/constructors-partial-template.ts +0 -35
  470. package/src/transpiler/markdown/plain-markdown/documentable-partial-template.ts +0 -21
  471. package/src/transpiler/markdown/plain-markdown/enum-template.ts +0 -11
  472. package/src/transpiler/markdown/plain-markdown/fieldsPartialTemplate.ts +0 -20
  473. package/src/transpiler/markdown/plain-markdown/methods-partial-template.ts +0 -45
  474. package/src/transpiler/markdown/plain-markdown/plain-docsProcessor.ts +0 -134
  475. package/src/transpiler/markdown/plain-markdown/type-level-apex-doc-partial-template.ts +0 -27
  476. package/src/transpiler/processor-type-transpiler.ts +0 -18
  477. /package/examples/{plain-markdown → markdown}/.forceignore +0 -0
  478. /package/examples/{plain-markdown → markdown}/config/project-scratch-def.json +0 -0
  479. /package/examples/{plain-markdown → markdown}/force-app/classes/BaseClass.cls +0 -0
  480. /package/examples/{plain-markdown → markdown}/force-app/classes/ParentInterface.cls +0 -0
  481. /package/examples/{plain-markdown → markdown}/force-app/classes/ReferencedEnum.cls +0 -0
  482. /package/examples/{plain-markdown → markdown}/force-app/classes/SampleEnum.cls +0 -0
  483. /package/examples/{plain-markdown → markdown}/force-app/classes/SampleInterface.cls +0 -0
  484. /package/examples/{plain-markdown → markdown}/package-lock.json +0 -0
  485. /package/examples/{plain-markdown → markdown}/sfdx-project.json +0 -0
  486. /package/src/{service → application}/file-system.ts +0 -0
  487. /package/src/{model/__tests__ → core/__test__}/manifest.spec.ts +0 -0
  488. /package/src/{service → core/openapi}/__tests__/manifest-factory.spec.ts +0 -0
  489. /package/src/{model → core}/openapi/__tests__/open-api.spec.ts +0 -0
  490. /package/src/{model → core}/openapi/apex-doc-types.ts +0 -0
  491. /package/src/{model → core/openapi}/apex-type-wrappers/ClassMirrorWrapper.ts +0 -0
  492. /package/src/{model → core/openapi}/apex-type-wrappers/MethodMirrorWrapper.ts +0 -0
  493. /package/src/{model → core}/openapi/open-api-types.ts +0 -0
  494. /package/src/{model → core}/openapi/open-api.ts +0 -0
@@ -1,138 +0,0 @@
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.RawBodyParser = void 0;
7
- const metadata_processor_1 = __importDefault(require("./metadata-processor"));
8
- const logger_1 = require("../util/logger");
9
- class RawBodyParser {
10
- constructor(typeBundles) {
11
- this.typeBundles = typeBundles;
12
- }
13
- parse(reflect) {
14
- const types = this.typeBundles
15
- .map((currentBundle) => {
16
- logger_1.Logger.log(`Parsing file: ${currentBundle.filePath}`);
17
- const result = reflect(currentBundle);
18
- if (!!result.typeMirror && !!currentBundle.rawMetadataContent) {
19
- // If successful and there is a metadata file
20
- const metadataParams = metadata_processor_1.default.process(currentBundle.rawMetadataContent);
21
- metadataParams.forEach((value, key) => {
22
- var _a;
23
- const declaration = `${key}: ${value}`;
24
- (_a = result.typeMirror) === null || _a === void 0 ? void 0 : _a.annotations.push({
25
- rawDeclaration: declaration,
26
- name: declaration,
27
- type: declaration,
28
- });
29
- });
30
- }
31
- return result;
32
- })
33
- .filter((reflectionResult) => {
34
- return reflectionResult.typeMirror;
35
- })
36
- // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
37
- .map((reflectionResult) => reflectionResult.typeMirror);
38
- return this.addFieldsFromParent(types);
39
- }
40
- addFieldsFromParent(types) {
41
- const typesWithFields = [];
42
- for (const currentType of types) {
43
- if (currentType.type_name !== 'class' && currentType.type_name !== 'interface') {
44
- typesWithFields.push(currentType);
45
- continue;
46
- }
47
- if (currentType.type_name === 'class') {
48
- let typeAsClass = currentType;
49
- if (!typeAsClass.extended_class) {
50
- typesWithFields.push(currentType);
51
- continue;
52
- }
53
- typeAsClass = this.addMembersFromParent(typeAsClass, types);
54
- typesWithFields.push(typeAsClass);
55
- continue;
56
- }
57
- // If reaching here then we are dealing with an interface
58
- let typeAsInterface = currentType;
59
- if (!typeAsInterface.extended_interfaces.length) {
60
- typesWithFields.push(currentType);
61
- continue;
62
- }
63
- typeAsInterface = this.addMethodsFromParent(typeAsInterface, types);
64
- typesWithFields.push(typeAsInterface);
65
- }
66
- return typesWithFields;
67
- }
68
- addMembersFromParent(currentClass, allTypes) {
69
- if (!currentClass.extended_class) {
70
- return currentClass;
71
- }
72
- const parent = allTypes.find((currentType) => currentType.name === currentClass.extended_class);
73
- if (!parent || parent.type_name !== 'class') {
74
- return currentClass;
75
- }
76
- let parentAsClass = parent;
77
- if (parentAsClass.extended_class) {
78
- parentAsClass = this.addMembersFromParent(parentAsClass, allTypes);
79
- }
80
- currentClass.fields = [...currentClass.fields, ...this.getInheritedFields(parentAsClass, currentClass)];
81
- currentClass.properties = [...currentClass.properties, ...this.getInheritedProperties(parentAsClass, currentClass)];
82
- currentClass.methods = [...currentClass.methods, ...this.getInheritedMethods(parentAsClass, currentClass)];
83
- return currentClass;
84
- }
85
- addMethodsFromParent(currentInterface, allTypes) {
86
- if (!currentInterface.extended_interfaces.length) {
87
- return currentInterface;
88
- }
89
- const parents = [];
90
- for (const currentInterfaceName of currentInterface.extended_interfaces) {
91
- const parent = allTypes.find((currentType) => currentType.name === currentInterfaceName);
92
- if (parent) {
93
- parents.push(parent);
94
- }
95
- }
96
- for (const parent of parents) {
97
- let parentAsInterface = parent;
98
- if (parentAsInterface.extended_interfaces.length) {
99
- parentAsInterface = this.addMethodsFromParent(parentAsInterface, allTypes);
100
- }
101
- currentInterface.methods = [
102
- ...currentInterface.methods,
103
- ...this.getInheritedMethods(parentAsInterface, currentInterface),
104
- ];
105
- }
106
- return currentInterface;
107
- }
108
- getInheritedFields(parentAsClass, currentClass) {
109
- return (parentAsClass.fields
110
- // Filter out private fields
111
- .filter((currentField) => currentField.access_modifier.toLowerCase() !== 'private')
112
- // Filter out fields that also exist on the child
113
- .filter((currentField) => !this.memberExists(currentClass.fields, currentField.name))
114
- .map((currentField) => (Object.assign(Object.assign({}, currentField), { inherited: true }))));
115
- }
116
- getInheritedProperties(parentAsClass, currentClass) {
117
- return (parentAsClass.properties
118
- // Filter out private properties
119
- .filter((currentProperty) => currentProperty.access_modifier.toLowerCase() !== 'private')
120
- // Filter out properties that also exist on the child
121
- .filter((currentProperty) => !this.memberExists(currentClass.properties, currentProperty.name))
122
- .map((currentProperty) => (Object.assign(Object.assign({}, currentProperty), { inherited: true }))));
123
- }
124
- getInheritedMethods(parentAsClass, currentClass) {
125
- return (parentAsClass.methods
126
- // Filter out private methods
127
- .filter((currentMethod) => currentMethod.access_modifier.toLowerCase() !== 'private')
128
- // Filter out methods that also exist on the child
129
- .filter((currentMethod) => !this.memberExists(currentClass.methods, currentMethod.name))
130
- .map((currentMethod) => (Object.assign(Object.assign({}, currentMethod), { inherited: true }))));
131
- }
132
- memberExists(members, fieldName) {
133
- const fieldNames = members.map((currentMember) => currentMember.name);
134
- return fieldNames.includes(fieldName);
135
- }
136
- }
137
- exports.RawBodyParser = RawBodyParser;
138
- //# sourceMappingURL=parser.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"parser.js","sourceRoot":"","sources":["../../src/service/parser.ts"],"names":[],"mappings":";;;;;;AAEA,8EAAqD;AACrD,2CAAwC;AAQxC,MAAa,aAAa;IACxB,YAAmB,WAAyB;QAAzB,gBAAW,GAAX,WAAW,CAAc;IAAG,CAAC;IAEhD,KAAK,CAAC,OAAqD;QACzD,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW;aAC3B,GAAG,CAAC,CAAC,aAAa,EAAE,EAAE;YACrB,eAAM,CAAC,GAAG,CAAC,iBAAiB,aAAa,CAAC,QAAQ,EAAE,CAAC,CAAC;YACtD,MAAM,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;YACtC,IAAI,CAAC,CAAC,MAAM,CAAC,UAAU,IAAI,CAAC,CAAC,aAAa,CAAC,kBAAkB,EAAE;gBAC7D,6CAA6C;gBAC7C,MAAM,cAAc,GAAG,4BAAiB,CAAC,OAAO,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAC;gBACnF,cAAc,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;;oBACpC,MAAM,WAAW,GAAG,GAAG,GAAG,KAAK,KAAK,EAAE,CAAC;oBACvC,MAAA,MAAM,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CAAC;wBAClC,cAAc,EAAE,WAAW;wBAC3B,IAAI,EAAE,WAAW;wBACjB,IAAI,EAAE,WAAW;qBAClB,CAAC,CAAC;gBACL,CAAC,CAAC,CAAC;aACJ;YACD,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;aACD,MAAM,CAAC,CAAC,gBAAgB,EAAE,EAAE;YAC3B,OAAO,gBAAgB,CAAC,UAAU,CAAC;QACrC,CAAC,CAAC;YACF,oEAAoE;aACnE,GAAG,CAAC,CAAC,gBAAgB,EAAE,EAAE,CAAC,gBAAgB,CAAC,UAAW,CAAC,CAAC;QAE3D,OAAO,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;IAED,mBAAmB,CAAC,KAAa;QAC/B,MAAM,eAAe,GAAW,EAAE,CAAC;QACnC,KAAK,MAAM,WAAW,IAAI,KAAK,EAAE;YAC/B,IAAI,WAAW,CAAC,SAAS,KAAK,OAAO,IAAI,WAAW,CAAC,SAAS,KAAK,WAAW,EAAE;gBAC9E,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;gBAClC,SAAS;aACV;YAED,IAAI,WAAW,CAAC,SAAS,KAAK,OAAO,EAAE;gBACrC,IAAI,WAAW,GAAG,WAA0B,CAAC;gBAC7C,IAAI,CAAC,WAAW,CAAC,cAAc,EAAE;oBAC/B,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;oBAClC,SAAS;iBACV;gBAED,WAAW,GAAG,IAAI,CAAC,oBAAoB,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;gBAC5D,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;gBAClC,SAAS;aACV;YAED,yDAAyD;YACzD,IAAI,eAAe,GAAG,WAA8B,CAAC;YACrD,IAAI,CAAC,eAAe,CAAC,mBAAmB,CAAC,MAAM,EAAE;gBAC/C,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;gBAClC,SAAS;aACV;YAED,eAAe,GAAG,IAAI,CAAC,oBAAoB,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;YACpE,eAAe,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;SACvC;QAED,OAAO,eAAe,CAAC;IACzB,CAAC;IAED,oBAAoB,CAAC,YAAyB,EAAE,QAAgB;QAC9D,IAAI,CAAC,YAAY,CAAC,cAAc,EAAE;YAChC,OAAO,YAAY,CAAC;SACrB;QACD,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,WAAiB,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,KAAK,YAAY,CAAC,cAAc,CAAC,CAAC;QACtG,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,SAAS,KAAK,OAAO,EAAE;YAC3C,OAAO,YAAY,CAAC;SACrB;QAED,IAAI,aAAa,GAAG,MAAqB,CAAC;QAC1C,IAAI,aAAa,CAAC,cAAc,EAAE;YAChC,aAAa,GAAG,IAAI,CAAC,oBAAoB,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;SACpE;QAED,YAAY,CAAC,MAAM,GAAG,CAAC,GAAG,YAAY,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC,CAAC;QACxG,YAAY,CAAC,UAAU,GAAG,CAAC,GAAG,YAAY,CAAC,UAAU,EAAE,GAAG,IAAI,CAAC,sBAAsB,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC,CAAC;QACpH,YAAY,CAAC,OAAO,GAAG,CAAC,GAAG,YAAY,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,mBAAmB,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC,CAAC;QAC3G,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,oBAAoB,CAAC,gBAAiC,EAAE,QAAgB;QACtE,IAAI,CAAC,gBAAgB,CAAC,mBAAmB,CAAC,MAAM,EAAE;YAChD,OAAO,gBAAgB,CAAC;SACzB;QAED,MAAM,OAAO,GAAG,EAAE,CAAC;QACnB,KAAK,MAAM,oBAAoB,IAAI,gBAAgB,CAAC,mBAAmB,EAAE;YACvE,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,WAAiB,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,KAAK,oBAAoB,CAAC,CAAC;YAC/F,IAAI,MAAM,EAAE;gBACV,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;aACtB;SACF;QAED,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;YAC5B,IAAI,iBAAiB,GAAG,MAAyB,CAAC;YAClD,IAAI,iBAAiB,CAAC,mBAAmB,CAAC,MAAM,EAAE;gBAChD,iBAAiB,GAAG,IAAI,CAAC,oBAAoB,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;aAC5E;YAED,gBAAgB,CAAC,OAAO,GAAG;gBACzB,GAAG,gBAAgB,CAAC,OAAO;gBAC3B,GAAG,IAAI,CAAC,mBAAmB,CAAC,iBAAiB,EAAE,gBAAgB,CAAC;aACjE,CAAC;SACH;QAED,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAEO,kBAAkB,CAAC,aAA0B,EAAE,YAAyB;QAC9E,OAAO,CACL,aAAa,CAAC,MAAM;YAClB,4BAA4B;aAC3B,MAAM,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,YAAY,CAAC,eAAe,CAAC,WAAW,EAAE,KAAK,SAAS,CAAC;YACnF,iDAAiD;aAChD,MAAM,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,MAAM,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC;aACpF,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,iCAClB,YAAY,KACf,SAAS,EAAE,IAAI,IACf,CAAC,CACN,CAAC;IACJ,CAAC;IAEO,sBAAsB,CAAC,aAA0B,EAAE,YAAyB;QAClF,OAAO,CACL,aAAa,CAAC,UAAU;YACtB,gCAAgC;aAC/B,MAAM,CAAC,CAAC,eAAe,EAAE,EAAE,CAAC,eAAe,CAAC,eAAe,CAAC,WAAW,EAAE,KAAK,SAAS,CAAC;YACzF,qDAAqD;aACpD,MAAM,CAAC,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,UAAU,EAAE,eAAe,CAAC,IAAI,CAAC,CAAC;aAC9F,GAAG,CAAC,CAAC,eAAe,EAAE,EAAE,CAAC,iCACrB,eAAe,KAClB,SAAS,EAAE,IAAI,IACf,CAAC,CACN,CAAC;IACJ,CAAC;IAEO,mBAAmB,CACzB,aAA4C,EAC5C,YAA2C;QAE3C,OAAO,CACL,aAAa,CAAC,OAAO;YACnB,6BAA6B;aAC5B,MAAM,CAAC,CAAC,aAAa,EAAE,EAAE,CAAC,aAAa,CAAC,eAAe,CAAC,WAAW,EAAE,KAAK,SAAS,CAAC;YACrF,kDAAkD;aACjD,MAAM,CAAC,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,OAAO,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC;aACvF,GAAG,CAAC,CAAC,aAAa,EAAE,EAAE,CAAC,iCACnB,aAAa,KAChB,SAAS,EAAE,IAAI,IACf,CAAC,CACN,CAAC;IACJ,CAAC;IAED,YAAY,CAAC,OAAoB,EAAE,SAAiB;QAClD,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,aAAa,EAAE,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QACtE,OAAO,UAAU,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;IACxC,CAAC;CACF;AAlKD,sCAkKC"}
@@ -1,9 +0,0 @@
1
- import { Type } from '@cparra/apex-reflection';
2
- export default class State {
3
- private static instance;
4
- private typeBeingProcessed?;
5
- private constructor();
6
- static getInstance(): State;
7
- setTypeBeingProcessed(typeToSet: Type): void;
8
- getTypeBeingProcessed(): Type | undefined;
9
- }
@@ -1,20 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- class State {
4
- // eslint-disable-next-line @typescript-eslint/no-empty-function
5
- constructor() { }
6
- static getInstance() {
7
- if (!State.instance) {
8
- State.instance = new State();
9
- }
10
- return State.instance;
11
- }
12
- setTypeBeingProcessed(typeToSet) {
13
- this.typeBeingProcessed = typeToSet;
14
- }
15
- getTypeBeingProcessed() {
16
- return this.typeBeingProcessed;
17
- }
18
- }
19
- exports.default = State;
20
- //# sourceMappingURL=state.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"state.js","sourceRoot":"","sources":["../../src/service/state.ts"],"names":[],"mappings":";;AAEA,MAAqB,KAAK;IAIxB,gEAAgE;IAChE,gBAAuB,CAAC;IAEjB,MAAM,CAAC,WAAW;QACvB,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE;YACnB,KAAK,CAAC,QAAQ,GAAG,IAAI,KAAK,EAAE,CAAC;SAC9B;QACD,OAAO,KAAK,CAAC,QAAQ,CAAC;IACxB,CAAC;IAEM,qBAAqB,CAAC,SAAe;QAC1C,IAAI,CAAC,kBAAkB,GAAG,SAAS,CAAC;IACtC,CAAC;IAEM,qBAAqB;QAC1B,OAAO,IAAI,CAAC,kBAAkB,CAAC;IACjC,CAAC;CACF;AArBD,wBAqBC"}
@@ -1,4 +0,0 @@
1
- import { Walker, WalkerListener } from './walker';
2
- export declare class ClassWalker extends Walker {
3
- walk(listener: WalkerListener): void;
4
- }
@@ -1,33 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.ClassWalker = void 0;
4
- const walker_1 = require("./walker");
5
- class ClassWalker extends walker_1.Walker {
6
- walk(listener) {
7
- listener.onTypeDeclaration(this.type);
8
- const classMirror = this.type;
9
- if (classMirror.constructors.length) {
10
- listener.onConstructorDeclaration(this.type.name, classMirror.constructors);
11
- }
12
- if (classMirror.fields.length) {
13
- listener.onFieldsDeclaration(this.sortType(classMirror.fields));
14
- }
15
- if (classMirror.properties.length) {
16
- listener.onPropertiesDeclaration(this.sortType(classMirror.properties));
17
- }
18
- if (classMirror.methods.length) {
19
- listener.onMethodsDeclaration(this.sortType(classMirror.methods));
20
- }
21
- if (classMirror.enums.length) {
22
- listener.onInnerEnumsDeclaration(this.sortType(classMirror.enums));
23
- }
24
- if (classMirror.classes.length) {
25
- listener.onInnerClassesDeclaration(this.sortType(classMirror.classes));
26
- }
27
- if (classMirror.interfaces.length) {
28
- listener.onInnerInterfacesDeclaration(this.sortType(classMirror.interfaces));
29
- }
30
- }
31
- }
32
- exports.ClassWalker = ClassWalker;
33
- //# sourceMappingURL=class-walker.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"class-walker.js","sourceRoot":"","sources":["../../../src/service/walkers/class-walker.ts"],"names":[],"mappings":";;;AAAA,qCAAkD;AAGlD,MAAa,WAAY,SAAQ,eAAM;IACrC,IAAI,CAAC,QAAwB;QAC3B,QAAQ,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtC,MAAM,WAAW,GAAG,IAAI,CAAC,IAAmB,CAAC;QAC7C,IAAI,WAAW,CAAC,YAAY,CAAC,MAAM,EAAE;YACnC,QAAQ,CAAC,wBAAwB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,YAAY,CAAC,CAAC;SAC7E;QACD,IAAI,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE;YAC7B,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC;SACjE;QACD,IAAI,WAAW,CAAC,UAAU,CAAC,MAAM,EAAE;YACjC,QAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC;SACzE;QACD,IAAI,WAAW,CAAC,OAAO,CAAC,MAAM,EAAE;YAC9B,QAAQ,CAAC,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;SACnE;QACD,IAAI,WAAW,CAAC,KAAK,CAAC,MAAM,EAAE;YAC5B,QAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;SACpE;QACD,IAAI,WAAW,CAAC,OAAO,CAAC,MAAM,EAAE;YAC9B,QAAQ,CAAC,yBAAyB,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;SACxE;QACD,IAAI,WAAW,CAAC,UAAU,CAAC,MAAM,EAAE;YACjC,QAAQ,CAAC,4BAA4B,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC;SAC9E;IACH,CAAC;CACF;AA1BD,kCA0BC"}
@@ -1,4 +0,0 @@
1
- import { Walker, WalkerListener } from './walker';
2
- export declare class EnumWalker extends Walker {
3
- walk(listener: WalkerListener): void;
4
- }
@@ -1,11 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.EnumWalker = void 0;
4
- const walker_1 = require("./walker");
5
- class EnumWalker extends walker_1.Walker {
6
- walk(listener) {
7
- listener.onTypeDeclaration(this.type);
8
- }
9
- }
10
- exports.EnumWalker = EnumWalker;
11
- //# sourceMappingURL=enum-walker.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"enum-walker.js","sourceRoot":"","sources":["../../../src/service/walkers/enum-walker.ts"],"names":[],"mappings":";;;AAAA,qCAAkD;AAElD,MAAa,UAAW,SAAQ,eAAM;IACpC,IAAI,CAAC,QAAwB;QAC3B,QAAQ,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC;CACF;AAJD,gCAIC"}
@@ -1,4 +0,0 @@
1
- import { Walker, WalkerListener } from './walker';
2
- export declare class InterfaceWalker extends Walker {
3
- walk(listener: WalkerListener): void;
4
- }
@@ -1,15 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.InterfaceWalker = void 0;
4
- const walker_1 = require("./walker");
5
- class InterfaceWalker extends walker_1.Walker {
6
- walk(listener) {
7
- listener.onTypeDeclaration(this.type);
8
- const interfaceMirror = this.type;
9
- if (interfaceMirror.methods.length) {
10
- listener.onMethodsDeclaration(this.sortType(interfaceMirror.methods));
11
- }
12
- }
13
- }
14
- exports.InterfaceWalker = InterfaceWalker;
15
- //# sourceMappingURL=interface-walker.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"interface-walker.js","sourceRoot":"","sources":["../../../src/service/walkers/interface-walker.ts"],"names":[],"mappings":";;;AAAA,qCAAkD;AAGlD,MAAa,eAAgB,SAAQ,eAAM;IACzC,IAAI,CAAC,QAAwB;QAC3B,QAAQ,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtC,MAAM,eAAe,GAAG,IAAI,CAAC,IAAuB,CAAC;QACrD,IAAI,eAAe,CAAC,OAAO,CAAC,MAAM,EAAE;YAClC,QAAQ,CAAC,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC;SACvE;IACH,CAAC;CACF;AARD,0CAQC"}
@@ -1,5 +0,0 @@
1
- import { Type } from '@cparra/apex-reflection';
2
- import { Walker } from './walker';
3
- export declare class WalkerFactory {
4
- static get(type: Type): Walker;
5
- }
@@ -1,21 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.WalkerFactory = void 0;
4
- const class_walker_1 = require("./class-walker");
5
- const enum_walker_1 = require("./enum-walker");
6
- const interface_walker_1 = require("./interface-walker");
7
- class WalkerFactory {
8
- static get(type) {
9
- switch (type.type_name) {
10
- case 'class':
11
- return new class_walker_1.ClassWalker(type);
12
- case 'enum':
13
- return new enum_walker_1.EnumWalker(type);
14
- case 'interface':
15
- return new interface_walker_1.InterfaceWalker(type);
16
- }
17
- throw Error('Walker not found for type.');
18
- }
19
- }
20
- exports.WalkerFactory = WalkerFactory;
21
- //# sourceMappingURL=walker-factory.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"walker-factory.js","sourceRoot":"","sources":["../../../src/service/walkers/walker-factory.ts"],"names":[],"mappings":";;;AAEA,iDAA6C;AAC7C,+CAA2C;AAC3C,yDAAqD;AAErD,MAAa,aAAa;IACxB,MAAM,CAAC,GAAG,CAAC,IAAU;QACnB,QAAQ,IAAI,CAAC,SAAS,EAAE;YACtB,KAAK,OAAO;gBACV,OAAO,IAAI,0BAAW,CAAC,IAAI,CAAC,CAAC;YAC/B,KAAK,MAAM;gBACT,OAAO,IAAI,wBAAU,CAAC,IAAI,CAAC,CAAC;YAC9B,KAAK,WAAW;gBACd,OAAO,IAAI,kCAAe,CAAC,IAAI,CAAC,CAAC;SACpC;QACD,MAAM,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAC5C,CAAC;CACF;AAZD,sCAYC"}
@@ -1,19 +0,0 @@
1
- import { ClassMirror, ConstructorMirror, EnumMirror, FieldMirror, InterfaceMirror, MethodMirror, PropertyMirror, Type } from '@cparra/apex-reflection';
2
- export interface WalkerListener {
3
- onTypeDeclaration(typeMirror: Type): void;
4
- onConstructorDeclaration(className: string, constructors: ConstructorMirror[]): void;
5
- onFieldsDeclaration(fields: FieldMirror[]): void;
6
- onPropertiesDeclaration(properties: PropertyMirror[]): void;
7
- onMethodsDeclaration(methods: MethodMirror[]): void;
8
- onInnerEnumsDeclaration(enums: EnumMirror[]): void;
9
- onInnerClassesDeclaration(classes: ClassMirror[]): void;
10
- onInnerInterfacesDeclaration(interfaces: InterfaceMirror[]): void;
11
- }
12
- export declare abstract class Walker {
13
- type: Type;
14
- constructor(type: Type);
15
- abstract walk(listener: WalkerListener): void;
16
- protected sortType<T extends {
17
- name: string;
18
- }>(types: T[]): T[];
19
- }
@@ -1,17 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.Walker = void 0;
4
- const settings_1 = require("../../settings");
5
- class Walker {
6
- constructor(type) {
7
- this.type = type;
8
- }
9
- sortType(types) {
10
- if (settings_1.Settings.getInstance().sortMembersAlphabetically()) {
11
- return types.sort((a, b) => a.name.localeCompare(b.name));
12
- }
13
- return types;
14
- }
15
- }
16
- exports.Walker = Walker;
17
- //# sourceMappingURL=walker.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"walker.js","sourceRoot":"","sources":["../../../src/service/walkers/walker.ts"],"names":[],"mappings":";;;AAUA,6CAA0C;AAoB1C,MAAsB,MAAM;IAC1B,YAAmB,IAAU;QAAV,SAAI,GAAJ,IAAI,CAAM;IAAG,CAAC;IAIvB,QAAQ,CAA6B,KAAU;QACvD,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,yBAAyB,EAAE,EAAE;YACtD,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;SAC3D;QACD,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAXD,wBAWC"}
package/lib/settings.d.ts DELETED
@@ -1,70 +0,0 @@
1
- import { GeneratorChoices } from './transpiler/generator-choices';
2
- export type OnBeforeFileWrite = (file: TargetFile) => TargetFile;
3
- export type TargetFile = {
4
- name: string;
5
- extension: string;
6
- dir: OutputDir;
7
- };
8
- export type OutputDir = {
9
- baseDir: string;
10
- fileDir: string;
11
- };
12
- export type TargetType = {
13
- name: string;
14
- typeName: 'class' | 'interface' | 'enum';
15
- accessModifier: string;
16
- description?: string;
17
- group?: string;
18
- };
19
- export interface SettingsConfig {
20
- sourceDirectory: string;
21
- recursive: boolean;
22
- scope: string[];
23
- outputDir: string;
24
- targetGenerator: GeneratorChoices;
25
- indexOnly: boolean;
26
- defaultGroupName: string;
27
- sanitizeHtml: boolean;
28
- openApiTitle?: string;
29
- title: string;
30
- namespace?: string;
31
- openApiFileName: string;
32
- includeMetadata: boolean;
33
- rootDir?: string;
34
- sortMembersAlphabetically?: boolean;
35
- onAfterProcess?: (files: TargetFile[]) => void;
36
- onBeforeFileWrite?: (file: TargetFile) => TargetFile;
37
- frontMatterHeader?: (file: TargetType) => string[];
38
- singleFile?: boolean;
39
- fileName?: string;
40
- templateFilePath?: string;
41
- }
42
- export declare class Settings {
43
- config: SettingsConfig;
44
- private static instance;
45
- private constructor();
46
- static build(config: SettingsConfig): void;
47
- static getInstance(): Settings;
48
- get sourceDirectory(): string;
49
- get recursive(): boolean;
50
- get scope(): string[];
51
- get outputDir(): string;
52
- get targetGenerator(): GeneratorChoices;
53
- get indexOnly(): boolean;
54
- get sanitizeHtml(): boolean;
55
- getDefaultGroupName(): string;
56
- getOpenApiTitle(): string | undefined;
57
- getTitle(): string;
58
- getNamespace(): string | undefined;
59
- getNamespacePrefix(): string;
60
- openApiFileName(): string;
61
- includeMetadata(): boolean;
62
- sortMembersAlphabetically(): boolean;
63
- getRootDir(): string | undefined;
64
- onAfterProcess(files: TargetFile[]): void;
65
- onBeforeFileWrite(file: TargetFile): TargetFile;
66
- frontMatterHeader(file: TargetType): string[];
67
- shouldOutputSingleFile(): boolean;
68
- getSingleFileName(): string;
69
- getTemplateFilePath(): string | undefined;
70
- }
package/lib/settings.js DELETED
@@ -1,100 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.Settings = void 0;
4
- class Settings {
5
- constructor(config) {
6
- this.config = config;
7
- }
8
- static build(config) {
9
- Settings.instance = new Settings(config);
10
- }
11
- static getInstance() {
12
- if (!Settings.instance) {
13
- throw new Error('Settings has not been initialized');
14
- }
15
- return Settings.instance;
16
- }
17
- get sourceDirectory() {
18
- return this.config.sourceDirectory;
19
- }
20
- get recursive() {
21
- return this.config.recursive;
22
- }
23
- get scope() {
24
- return this.config.scope;
25
- }
26
- get outputDir() {
27
- return this.config.outputDir;
28
- }
29
- get targetGenerator() {
30
- return this.config.targetGenerator;
31
- }
32
- get indexOnly() {
33
- return this.config.indexOnly;
34
- }
35
- get sanitizeHtml() {
36
- return this.config.sanitizeHtml;
37
- }
38
- getDefaultGroupName() {
39
- return this.config.defaultGroupName;
40
- }
41
- getOpenApiTitle() {
42
- var _a;
43
- return (_a = this.config.openApiTitle) !== null && _a !== void 0 ? _a : this.config.title;
44
- }
45
- getTitle() {
46
- return this.config.title;
47
- }
48
- getNamespace() {
49
- return this.config.namespace;
50
- }
51
- getNamespacePrefix() {
52
- if (!this.config.namespace) {
53
- return '';
54
- }
55
- return `${this.config.namespace}.`;
56
- }
57
- openApiFileName() {
58
- return this.config.openApiFileName;
59
- }
60
- includeMetadata() {
61
- return this.config.includeMetadata;
62
- }
63
- sortMembersAlphabetically() {
64
- var _a;
65
- return (_a = this.config.sortMembersAlphabetically) !== null && _a !== void 0 ? _a : false;
66
- }
67
- getRootDir() {
68
- return this.config.rootDir;
69
- }
70
- onAfterProcess(files) {
71
- if (this.config.onAfterProcess) {
72
- this.config.onAfterProcess(files);
73
- }
74
- }
75
- onBeforeFileWrite(file) {
76
- if (this.config.onBeforeFileWrite) {
77
- return this.config.onBeforeFileWrite(file);
78
- }
79
- return file;
80
- }
81
- frontMatterHeader(file) {
82
- if (this.config.frontMatterHeader) {
83
- return this.config.frontMatterHeader(file);
84
- }
85
- return [];
86
- }
87
- shouldOutputSingleFile() {
88
- var _a;
89
- return (_a = this.config.singleFile) !== null && _a !== void 0 ? _a : false;
90
- }
91
- getSingleFileName() {
92
- var _a;
93
- return (_a = this.config.fileName) !== null && _a !== void 0 ? _a : 'README';
94
- }
95
- getTemplateFilePath() {
96
- return this.config.templateFilePath;
97
- }
98
- }
99
- exports.Settings = Settings;
100
- //# sourceMappingURL=settings.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"settings.js","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":";;;AA+CA,MAAa,QAAQ;IAGnB,YAA2B,MAAsB;QAAtB,WAAM,GAAN,MAAM,CAAgB;IAAG,CAAC;IAE9C,MAAM,CAAC,KAAK,CAAC,MAAsB;QACxC,QAAQ,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;IAEM,MAAM,CAAC,WAAW;QACvB,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE;YACtB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;SACtD;QACD,OAAO,QAAQ,CAAC,QAAQ,CAAC;IAC3B,CAAC;IAED,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;IACrC,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IAC3B,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAED,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;IACrC,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;IAClC,CAAC;IAEM,mBAAmB;QACxB,OAAO,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC;IACtC,CAAC;IAEM,eAAe;;QACpB,OAAO,MAAA,IAAI,CAAC,MAAM,CAAC,YAAY,mCAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IACvD,CAAC;IAEM,QAAQ;QACb,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IAC3B,CAAC;IAEM,YAAY;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAEM,kBAAkB;QACvB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE;YAC1B,OAAO,EAAE,CAAC;SACX;QACD,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,GAAG,CAAC;IACrC,CAAC;IAEM,eAAe;QACpB,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;IACrC,CAAC;IAEM,eAAe;QACpB,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;IACrC,CAAC;IAEM,yBAAyB;;QAC9B,OAAO,MAAA,IAAI,CAAC,MAAM,CAAC,yBAAyB,mCAAI,KAAK,CAAC;IACxD,CAAC;IAEM,UAAU;QACf,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;IAC7B,CAAC;IAEM,cAAc,CAAC,KAAmB;QACvC,IAAI,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE;YAC9B,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;SACnC;IACH,CAAC;IAEM,iBAAiB,CAAC,IAAgB;QACvC,IAAI,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE;YACjC,OAAO,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;SAC5C;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,iBAAiB,CAAC,IAAgB;QACvC,IAAI,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE;YACjC,OAAO,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;SAC5C;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IAEM,sBAAsB;;QAC3B,OAAO,MAAA,IAAI,CAAC,MAAM,CAAC,UAAU,mCAAI,KAAK,CAAC;IACzC,CAAC;IAEM,iBAAiB;;QACtB,OAAO,MAAA,IAAI,CAAC,MAAM,CAAC,QAAQ,mCAAI,QAAQ,CAAC;IAC1C,CAAC;IAEM,mBAAmB;QACxB,OAAO,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC;IACtC,CAAC;CACF;AAlHD,4BAkHC"}
@@ -1,7 +0,0 @@
1
- import { EnumSource, ConvertRenderableContentsToString, InterfaceSource, ClassSource } from './types';
2
- type CompileOptions = {
3
- renderableContentConverter: ConvertRenderableContentsToString;
4
- codeBlockConverter: (language: string, lines: string[]) => string;
5
- };
6
- export declare function compile(template: string, source: EnumSource | InterfaceSource | ClassSource, options: CompileOptions): string;
7
- export {};
@@ -1,98 +0,0 @@
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.compile = void 0;
7
- const handlebars_1 = __importDefault(require("handlebars"));
8
- const helpers_1 = require("./helpers");
9
- const type_level_apex_doc_partial_template_1 = require("../transpiler/markdown/plain-markdown/type-level-apex-doc-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 documentable_partial_template_1 = require("../transpiler/markdown/plain-markdown/documentable-partial-template");
14
- function compile(template, source, options) {
15
- handlebars_1.default.registerPartial('typeLevelApexDocPartialTemplate', type_level_apex_doc_partial_template_1.typeLevelApexDocPartialTemplate);
16
- handlebars_1.default.registerPartial('documentablePartialTemplate', documentable_partial_template_1.documentablePartialTemplate);
17
- handlebars_1.default.registerPartial('methodsPartialTemplate', methods_partial_template_1.methodsPartialTemplate);
18
- handlebars_1.default.registerPartial('constructorsPartialTemplate', constructors_partial_template_1.constructorsPartialTemplate);
19
- handlebars_1.default.registerPartial('fieldsPartialTemplate', fieldsPartialTemplate_1.fieldsPartialTemplate);
20
- handlebars_1.default.registerHelper('splitAndCapitalize', helpers_1.splitAndCapitalize);
21
- const prepared = Object.assign(Object.assign({}, prepare(source, options)), { namespace: (0, helpers_1.namespace)() });
22
- const compiled = handlebars_1.default.compile(template);
23
- return (compiled(prepared)
24
- .trim()
25
- // clean up extra newlines
26
- .replace(/\n{3,}/g, '\n\n'));
27
- }
28
- exports.compile = compile;
29
- function prepare(source, { renderableContentConverter, codeBlockConverter }) {
30
- const base = Object.assign(Object.assign(Object.assign({}, source), prepareDocumentable(source, renderableContentConverter, codeBlockConverter)), prepareBaseType(source, renderableContentConverter));
31
- if (isEnumSource(source)) {
32
- return Object.assign(Object.assign({}, base), prepareEnum(source, renderableContentConverter));
33
- }
34
- else if (isInterfaceSource(source)) {
35
- return Object.assign(Object.assign({}, base), prepareInterface(source, renderableContentConverter, codeBlockConverter));
36
- }
37
- else {
38
- return Object.assign(Object.assign({}, base), prepareClass(source, renderableContentConverter, codeBlockConverter));
39
- }
40
- }
41
- function prepareDocumentable(source, renderableContentConverter, codeBlockConverter) {
42
- var _a;
43
- return {
44
- description: renderableContentConverter(source.description),
45
- mermaid: source.mermaid ? codeBlockConverter('mermaid', source.mermaid) : undefined,
46
- example: source.example ? codeBlockConverter('apex', source.example) : undefined,
47
- customTags: (_a = source.customTags) === null || _a === void 0 ? void 0 : _a.map((tag) => ({
48
- name: tag.name,
49
- value: renderableContentConverter(tag.description),
50
- })),
51
- };
52
- }
53
- function prepareBaseType(source, renderableContentConverter) {
54
- var _a;
55
- return {
56
- sees: (_a = source.sees) === null || _a === void 0 ? void 0 : _a.map((see) => renderableContentConverter([see])),
57
- };
58
- }
59
- function prepareEnum(source, renderableContentConverter) {
60
- return {
61
- values: source.values.map((value) => ({
62
- value: value.value,
63
- description: renderableContentConverter(value.description),
64
- })),
65
- };
66
- }
67
- function prepareInterface(source, renderableContentConverter, codeBlockConverter) {
68
- var _a, _b;
69
- return {
70
- extends: (_a = source.extends) === null || _a === void 0 ? void 0 : _a.map((ext) => renderableContentConverter([ext])),
71
- methods: (_b = source.methods) === null || _b === void 0 ? void 0 : _b.map((method) => mapMethod(method, renderableContentConverter, codeBlockConverter)),
72
- };
73
- }
74
- function prepareClass(source, renderableContentConverter, codeBlockConverter) {
75
- var _a, _b, _c, _d;
76
- return {
77
- implements: (_a = source.implements) === null || _a === void 0 ? void 0 : _a.map((impl) => renderableContentConverter([impl])),
78
- extends: source.extends ? renderableContentConverter([source.extends]) : undefined,
79
- constructors: (_b = source.constructors) === null || _b === void 0 ? void 0 : _b.map((constructor) => mapConstructor(constructor, renderableContentConverter, codeBlockConverter)),
80
- methods: (_c = source.methods) === null || _c === void 0 ? void 0 : _c.map((method) => mapMethod(method, renderableContentConverter, codeBlockConverter)),
81
- fields: (_d = source.fields) === null || _d === void 0 ? void 0 : _d.map((field) => (Object.assign(Object.assign(Object.assign({}, field), prepareDocumentable(field, renderableContentConverter, codeBlockConverter)), { type: renderableContentConverter([field.type]) }))),
82
- };
83
- }
84
- function mapMethod(method, renderableContentConverter, codeBlockConverter) {
85
- var _a, _b, _c, _d;
86
- return Object.assign(Object.assign(Object.assign({}, method), prepareDocumentable(method, renderableContentConverter, codeBlockConverter)), { returnType: Object.assign(Object.assign({}, method), { type: ((_a = method.returnType) === null || _a === void 0 ? void 0 : _a.type) ? renderableContentConverter([method.returnType.type]) : undefined, description: renderableContentConverter((_b = method.returnType) === null || _b === void 0 ? void 0 : _b.description) }), throws: (_c = method.throws) === null || _c === void 0 ? void 0 : _c.map((thrown) => (Object.assign(Object.assign({}, thrown), { type: renderableContentConverter([thrown.type]), description: renderableContentConverter(thrown.description) }))), parameters: (_d = method.parameters) === null || _d === void 0 ? void 0 : _d.map((param) => (Object.assign(Object.assign({}, param), { type: renderableContentConverter([param.type]), description: renderableContentConverter(param.description) }))) });
87
- }
88
- function mapConstructor(constructor, renderableContentConverter, codeBlockConverter) {
89
- var _a, _b;
90
- return Object.assign(Object.assign(Object.assign({}, constructor), prepareDocumentable(constructor, renderableContentConverter, codeBlockConverter)), { parameters: (_a = constructor.parameters) === null || _a === void 0 ? void 0 : _a.map((param) => (Object.assign(Object.assign({}, param), { type: renderableContentConverter([param.type]), description: renderableContentConverter(param.description) }))), throws: (_b = constructor.throws) === null || _b === void 0 ? void 0 : _b.map((thrown) => (Object.assign(Object.assign({}, thrown), { type: renderableContentConverter([thrown.type]), description: renderableContentConverter(thrown.description) }))) });
91
- }
92
- function isEnumSource(source) {
93
- return source.__type === 'enum';
94
- }
95
- function isInterfaceSource(source) {
96
- return source.__type === 'interface';
97
- }
98
- //# sourceMappingURL=compile.js.map