@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,80 +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.Apexdocs = void 0;
7
- const apex_file_reader_1 = require("../service/apex-file-reader");
8
- const file_system_1 = require("../service/file-system");
9
- const apex_reflection_1 = require("@cparra/apex-reflection");
10
- const logger_1 = require("../util/logger");
11
- const manifest_factory_1 = require("../service/manifest-factory");
12
- const parser_1 = require("../service/parser");
13
- const settings_1 = require("../settings");
14
- const transpiler_1 = __importDefault(require("../transpiler/transpiler"));
15
- const file_writer_1 = require("../service/file-writer");
16
- const error_logger_1 = __importDefault(require("../util/error-logger"));
17
- const types_repository_1 = require("../model/types-repository");
18
- const factory_1 = require("../transpiler/factory");
19
- /**
20
- * Application entry-point to generate documentation out of Apex source files.
21
- */
22
- class Apexdocs {
23
- /**
24
- * Generates documentation out of Apex source files.
25
- */
26
- static generate() {
27
- logger_1.Logger.log('Initializing...');
28
- const fileBodies = apex_file_reader_1.ApexFileReader.processFiles(new file_system_1.DefaultFileSystem());
29
- const manifest = (0, manifest_factory_1.createManifest)(new parser_1.RawBodyParser(fileBodies), this._reflectionWithLogger);
30
- types_repository_1.TypesRepository.getInstance().populateAll(manifest.types);
31
- const filteredTypes = this.filterByScopes(manifest);
32
- types_repository_1.TypesRepository.getInstance().populateScoped(filteredTypes);
33
- const processor = factory_1.TypeTranspilerFactory.get(settings_1.Settings.getInstance().targetGenerator);
34
- transpiler_1.default.generate(filteredTypes, processor);
35
- const generatedFiles = processor.fileBuilder().files();
36
- const files = [];
37
- file_writer_1.FileWriter.write(generatedFiles, (file) => {
38
- logger_1.Logger.logSingle(`${file.name} processed.`, false, 'green', false);
39
- files.push(file);
40
- });
41
- settings_1.Settings.getInstance().onAfterProcess(files);
42
- // Error logging
43
- error_logger_1.default.logErrors(filteredTypes);
44
- }
45
- static filterByScopes(manifest) {
46
- let filteredTypes;
47
- let filteredLogMessage;
48
- if (settings_1.Settings.getInstance().config.targetGenerator !== 'openapi') {
49
- filteredTypes = manifest.filteredByAccessModifierAndAnnotations(settings_1.Settings.getInstance().scope);
50
- filteredLogMessage = `Filtered ${manifest.types.length - filteredTypes.length} file(s) based on scope: ${settings_1.Settings.getInstance().scope}`;
51
- }
52
- else {
53
- // If we are dealing with an OpenApi generator, we ignore the passed in access modifiers, and instead
54
- // we only keep classes annotated as @RestResource
55
- filteredTypes = manifest.filteredByAccessModifierAndAnnotations([
56
- 'restresource',
57
- 'httpdelete',
58
- 'httpget',
59
- 'httppatch',
60
- 'httppost',
61
- 'httpput',
62
- ]);
63
- filteredLogMessage = `Filtered ${manifest.types.length - filteredTypes.length} file(s), only keeping classes annotated as @RestResource.`;
64
- }
65
- logger_1.Logger.clear();
66
- logger_1.Logger.logSingle(filteredLogMessage, false, 'green', false);
67
- logger_1.Logger.logSingle(`Creating documentation for ${filteredTypes.length} file(s)`, false, 'green', false);
68
- return filteredTypes;
69
- }
70
- }
71
- exports.Apexdocs = Apexdocs;
72
- Apexdocs._reflectionWithLogger = (apexBundle) => {
73
- var _a;
74
- const result = (0, apex_reflection_1.reflect)(apexBundle.rawTypeContent);
75
- if (result.error) {
76
- logger_1.Logger.error(`${apexBundle.filePath} - Parsing error ${(_a = result.error) === null || _a === void 0 ? void 0 : _a.message}`);
77
- }
78
- return result;
79
- };
80
- //# sourceMappingURL=Apexdocs.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"Apexdocs.js","sourceRoot":"","sources":["../../src/application/Apexdocs.ts"],"names":[],"mappings":";;;;;;AAAA,kEAA6D;AAC7D,wDAA2D;AAC3D,6DAA0E;AAC1E,2CAAwC;AACxC,kEAA6D;AAC7D,8CAAkD;AAClD,0CAAmD;AACnD,0EAAkD;AAClD,wDAAoD;AACpD,wEAA+C;AAG/C,gEAA4D;AAC5D,mDAA8D;AAE9D;;GAEG;AACH,MAAa,QAAQ;IACnB;;OAEG;IACH,MAAM,CAAC,QAAQ;QACb,eAAM,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QAC9B,MAAM,UAAU,GAAG,iCAAc,CAAC,YAAY,CAAC,IAAI,+BAAiB,EAAE,CAAC,CAAC;QACxE,MAAM,QAAQ,GAAG,IAAA,iCAAc,EAAC,IAAI,sBAAa,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAC3F,kCAAe,CAAC,WAAW,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC1D,MAAM,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QACpD,kCAAe,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;QAC5D,MAAM,SAAS,GAAG,+BAAqB,CAAC,GAAG,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,eAAe,CAAC,CAAC;QACpF,oBAAU,CAAC,QAAQ,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;QAC9C,MAAM,cAAc,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC,KAAK,EAAE,CAAC;QAEvD,MAAM,KAAK,GAAiB,EAAE,CAAC;QAC/B,wBAAU,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC,IAAgB,EAAE,EAAE;YACpD,eAAM,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,IAAI,aAAa,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;YACnE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnB,CAAC,CAAC,CAAC;QAEH,mBAAQ,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QAE7C,gBAAgB;QAChB,sBAAW,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;IACvC,CAAC;IAEO,MAAM,CAAC,cAAc,CAAC,QAAkB;QAC9C,IAAI,aAAqB,CAAC;QAC1B,IAAI,kBAAkB,CAAC;QACvB,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,eAAe,KAAK,SAAS,EAAE;YAC/D,aAAa,GAAG,QAAQ,CAAC,sCAAsC,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC;YAC9F,kBAAkB,GAAG,YAAY,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,aAAa,CAAC,MAAM,4BAC3E,mBAAQ,CAAC,WAAW,EAAE,CAAC,KACzB,EAAE,CAAC;SACJ;aAAM;YACL,qGAAqG;YACrG,kDAAkD;YAClD,aAAa,GAAG,QAAQ,CAAC,sCAAsC,CAAC;gBAC9D,cAAc;gBACd,YAAY;gBACZ,SAAS;gBACT,WAAW;gBACX,UAAU;gBACV,SAAS;aACV,CAAC,CAAC;YACH,kBAAkB,GAAG,YACnB,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,aAAa,CAAC,MACxC,4DAA4D,CAAC;SAC9D;QACD,eAAM,CAAC,KAAK,EAAE,CAAC;QAEf,eAAM,CAAC,SAAS,CAAC,kBAAkB,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QAC5D,eAAM,CAAC,SAAS,CAAC,8BAA8B,aAAa,CAAC,MAAM,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QACtG,OAAO,aAAa,CAAC;IACvB,CAAC;;AAvDH,4BAgEC;AAPQ,8BAAqB,GAAG,CAAC,UAAsB,EAAoB,EAAE;;IAC1E,MAAM,MAAM,GAAG,IAAA,yBAAO,EAAC,UAAU,CAAC,cAAc,CAAC,CAAC;IAClD,IAAI,MAAM,CAAC,KAAK,EAAE;QAChB,eAAM,CAAC,KAAK,CAAC,GAAG,UAAU,CAAC,QAAQ,oBAAoB,MAAA,MAAM,CAAC,KAAK,0CAAE,OAAO,EAAE,CAAC,CAAC;KACjF;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC"}
@@ -1,2 +0,0 @@
1
- #!/usr/bin/env node
2
- export {};
@@ -1,157 +0,0 @@
1
- #!/usr/bin/env node
2
- "use strict";
3
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
4
- if (k2 === undefined) k2 = k;
5
- var desc = Object.getOwnPropertyDescriptor(m, k);
6
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
7
- desc = { enumerable: true, get: function() { return m[k]; } };
8
- }
9
- Object.defineProperty(o, k2, desc);
10
- }) : (function(o, m, k, k2) {
11
- if (k2 === undefined) k2 = k;
12
- o[k2] = m[k];
13
- }));
14
- var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
15
- Object.defineProperty(o, "default", { enumerable: true, value: v });
16
- }) : function(o, v) {
17
- o["default"] = v;
18
- });
19
- var __importStar = (this && this.__importStar) || function (mod) {
20
- if (mod && mod.__esModule) return mod;
21
- var result = {};
22
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
23
- __setModuleDefault(result, mod);
24
- return result;
25
- };
26
- Object.defineProperty(exports, "__esModule", { value: true });
27
- const yargs = __importStar(require("yargs"));
28
- const settings_1 = require("../settings");
29
- const Apexdocs_1 = require("../application/Apexdocs");
30
- const cosmiconfig_1 = require("cosmiconfig");
31
- const result = (0, cosmiconfig_1.cosmiconfig)('apexdocs').search();
32
- result.then((config) => {
33
- var _a, _b, _c, _d, _e, _f;
34
- yargs.config(config === null || config === void 0 ? void 0 : config.config);
35
- let argv = yargs.options({
36
- sourceDir: {
37
- type: 'string',
38
- alias: 's',
39
- demandOption: true,
40
- describe: 'The directory location which contains your apex .cls classes.',
41
- },
42
- targetDir: {
43
- type: 'string',
44
- alias: 't',
45
- default: './docs/',
46
- describe: 'The directory location where documentation will be generated to.',
47
- },
48
- recursive: {
49
- type: 'boolean',
50
- alias: 'r',
51
- default: true,
52
- describe: 'Whether .cls classes will be searched for recursively in the directory provided.',
53
- },
54
- scope: {
55
- type: 'array',
56
- alias: 'p',
57
- default: ['global'],
58
- describe: 'A list of scopes to document. Values should be separated by a space, e.g --scope global public namespaceaccessible. ' +
59
- 'Annotations are supported and should be passed lowercased and without the @ symbol, e.g. namespaceaccessible auraenabled. ' +
60
- 'Note that this setting is ignored if generating an OpenApi REST specification since that looks for classes annotated with @RestResource.',
61
- },
62
- targetGenerator: {
63
- type: 'string',
64
- alias: 'g',
65
- default: 'jekyll',
66
- choices: ['jekyll', 'docsify', 'plain-markdown', 'openapi'],
67
- describe: 'Define the static file generator for which the documents will be created. ' +
68
- 'Currently supports jekyll, docsify, plain markdown, and OpenAPI v3.1.0.',
69
- },
70
- indexOnly: {
71
- type: 'boolean',
72
- default: false,
73
- describe: 'Defines whether only the index file should be generated.',
74
- },
75
- defaultGroupName: {
76
- type: 'string',
77
- default: 'Miscellaneous',
78
- describe: 'Defines the @group name to be used when a file does not specify it.',
79
- },
80
- sanitizeHtml: {
81
- type: 'boolean',
82
- default: true,
83
- describe: 'When on, any special character within your ApexDocs is converted into its HTML code representation. ' +
84
- 'This is specially useful when generic objects are described within the docs, e.g. "List< Foo>", "Map<Foo, Bar>" ' +
85
- 'because otherwise the content within < and > would be treated as HTML tags and not shown in the output. ' +
86
- 'Content in @example blocks are never sanitized.',
87
- },
88
- openApiTitle: {
89
- type: 'string',
90
- default: 'Apex REST Api',
91
- describe: 'If using "openapi" as the target generator, this allows you to specify the OpenApi title value.',
92
- },
93
- title: {
94
- type: 'string',
95
- describe: "If this allows you to specify the title of the generated documentation's home file.",
96
- default: 'Classes',
97
- },
98
- namespace: {
99
- type: 'string',
100
- describe: 'The package namespace, if any. If this value is provided the namespace will be added as a prefix to all of the parsed files. ' +
101
- "If generating an OpenApi definition, it will be added to the file's Server Url.",
102
- },
103
- openApiFileName: {
104
- type: 'string',
105
- describe: 'If using "openapi" as the target generator, this allows you to specify the name of the output file.',
106
- default: 'openapi',
107
- },
108
- sortMembersAlphabetically: {
109
- type: 'boolean',
110
- describe: 'Whether to sort members alphabetically.',
111
- default: false,
112
- },
113
- includeMetadata: {
114
- type: 'boolean',
115
- describe: "Whether to include the file's meta.xml information: Whether it is active and and the API version",
116
- default: false,
117
- },
118
- documentationRootDir: {
119
- type: 'string',
120
- describe: 'Allows you to specify the root documentation directory where the files are being generated. This can be helpful when embedding the generated docs into an existing site so that the links are generated correctly.',
121
- },
122
- }).argv;
123
- if (config) {
124
- argv = Object.assign(Object.assign({}, config.config), argv);
125
- }
126
- settings_1.Settings.build({
127
- sourceDirectory: argv.sourceDir,
128
- recursive: argv.recursive,
129
- scope: argv.scope,
130
- outputDir: argv.targetDir,
131
- targetGenerator: argv.targetGenerator,
132
- indexOnly: argv.indexOnly,
133
- defaultGroupName: argv.defaultGroupName,
134
- sanitizeHtml: argv.sanitizeHtml,
135
- openApiTitle: argv.openApiTitle,
136
- title: argv.title,
137
- namespace: argv.namespace,
138
- openApiFileName: argv.openApiFileName,
139
- sortMembersAlphabetically: argv.sortMembersAlphabetically,
140
- includeMetadata: argv.includeMetadata,
141
- rootDir: argv.documentationRootDir,
142
- onAfterProcess: (_a = config === null || config === void 0 ? void 0 : config.config) === null || _a === void 0 ? void 0 : _a.onAfterProcess,
143
- onBeforeFileWrite: (_b = config === null || config === void 0 ? void 0 : config.config) === null || _b === void 0 ? void 0 : _b.onBeforeFileWrite,
144
- frontMatterHeader: (_c = config === null || config === void 0 ? void 0 : config.config) === null || _c === void 0 ? void 0 : _c.frontMatterHeader,
145
- singleFile: (_d = config === null || config === void 0 ? void 0 : config.config) === null || _d === void 0 ? void 0 : _d.singleFile,
146
- fileName: (_e = config === null || config === void 0 ? void 0 : config.config) === null || _e === void 0 ? void 0 : _e.fileName,
147
- templateFilePath: (_f = config === null || config === void 0 ? void 0 : config.config) === null || _f === void 0 ? void 0 : _f.templateFilePath,
148
- });
149
- try {
150
- Apexdocs_1.Apexdocs.generate();
151
- }
152
- catch (error) {
153
- console.error(error);
154
- process.exit(1);
155
- }
156
- });
157
- //# sourceMappingURL=generate.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"generate.js","sourceRoot":"","sources":["../../src/cli/generate.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AACA,6CAA+B;AAE/B,0CAAuC;AACvC,sDAAmD;AAEnD,6CAA0C;AAE1C,MAAM,MAAM,GAAG,IAAA,yBAAW,EAAC,UAAU,CAAC,CAAC,MAAM,EAAE,CAAC;AAChD,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;;IACrB,KAAK,CAAC,MAAM,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,CAAC,CAAC;IAC7B,IAAI,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC;QACvB,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,GAAG;YACV,YAAY,EAAE,IAAI;YAClB,QAAQ,EAAE,+DAA+D;SAC1E;QACD,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,SAAS;YAClB,QAAQ,EAAE,kEAAkE;SAC7E;QACD,SAAS,EAAE;YACT,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,kFAAkF;SAC7F;QACD,KAAK,EAAE;YACL,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,CAAC,QAAQ,CAAC;YACnB,QAAQ,EACN,sHAAsH;gBACtH,4HAA4H;gBAC5H,0IAA0I;SAC7I;QACD,eAAe,EAAE;YACf,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,QAAQ;YACjB,OAAO,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,gBAAgB,EAAE,SAAS,CAAC;YAC3D,QAAQ,EACN,4EAA4E;gBAC5E,yEAAyE;SAC5E;QACD,SAAS,EAAE;YACT,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,KAAK;YACd,QAAQ,EAAE,0DAA0D;SACrE;QACD,gBAAgB,EAAE;YAChB,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,eAAe;YACxB,QAAQ,EAAE,qEAAqE;SAChF;QACD,YAAY,EAAE;YACZ,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;YACb,QAAQ,EACN,sGAAsG;gBACtG,kHAAkH;gBAClH,0GAA0G;gBAC1G,iDAAiD;SACpD;QACD,YAAY,EAAE;YACZ,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,eAAe;YACxB,QAAQ,EAAE,iGAAiG;SAC5G;QACD,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,qFAAqF;YAC/F,OAAO,EAAE,SAAS;SACnB;QACD,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,QAAQ,EACN,+HAA+H;gBAC/H,iFAAiF;SACpF;QACD,eAAe,EAAE;YACf,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,qGAAqG;YAC/G,OAAO,EAAE,SAAS;SACnB;QACD,yBAAyB,EAAE;YACzB,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,yCAAyC;YACnD,OAAO,EAAE,KAAK;SACf;QACD,eAAe,EAAE;YACf,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,kGAAkG;YAC5G,OAAO,EAAE,KAAK;SACf;QACD,oBAAoB,EAAE;YACpB,IAAI,EAAE,QAAQ;YACd,QAAQ,EACN,oNAAoN;SACvN;KACF,CAAC,CAAC,IAAI,CAAC;IAER,IAAI,MAAM,EAAE;QACV,IAAI,mCAAQ,MAAM,CAAC,MAAM,GAAK,IAAI,CAAE,CAAC;KACtC;IAED,mBAAQ,CAAC,KAAK,CAAC;QACb,eAAe,EAAE,IAAI,CAAC,SAAS;QAC/B,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,eAAe,EAAE,IAAI,CAAC,eAAmC;QACzD,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;QACvC,YAAY,EAAE,IAAI,CAAC,YAAY;QAC/B,YAAY,EAAE,IAAI,CAAC,YAAY;QAC/B,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,eAAe,EAAE,IAAI,CAAC,eAAe;QACrC,yBAAyB,EAAE,IAAI,CAAC,yBAAyB;QACzD,eAAe,EAAE,IAAI,CAAC,eAAe;QACrC,OAAO,EAAE,IAAI,CAAC,oBAAoB;QAClC,cAAc,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,0CAAE,cAAc;QAC9C,iBAAiB,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,0CAAE,iBAAiB;QACpD,iBAAiB,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,0CAAE,iBAAiB;QACpD,UAAU,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,0CAAE,UAAU;QACtC,QAAQ,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,0CAAE,QAAQ;QAClC,gBAAgB,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,0CAAE,gBAAgB;KACnD,CAAC,CAAC;IAEH,IAAI;QACF,mBAAQ,CAAC,QAAQ,EAAE,CAAC;KACrB;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACrB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;AACH,CAAC,CAAC,CAAC"}
package/lib/index.d.ts DELETED
@@ -1 +0,0 @@
1
- export * from './service/manifest-factory';
package/lib/index.js DELETED
@@ -1,18 +0,0 @@
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);
18
- //# sourceMappingURL=index.js.map
package/lib/index.js.map DELETED
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6DAA2C"}
@@ -1,6 +0,0 @@
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 +0,0 @@
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
- //# sourceMappingURL=apex-bundle.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"apex-bundle.js","sourceRoot":"","sources":["../../src/model/apex-bundle.ts"],"names":[],"mappings":";;AAAA,MAAqB,UAAU;IAC7B,YAAmB,QAAgB,EAAS,cAAsB,EAAS,kBAAiC;QAAzF,aAAQ,GAAR,QAAQ,CAAQ;QAAS,mBAAc,GAAd,cAAc,CAAQ;QAAS,uBAAkB,GAAlB,kBAAkB,CAAe;IAAG,CAAC;CACjH;AAFD,6BAEC"}
@@ -1,7 +0,0 @@
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 +0,0 @@
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
- //# sourceMappingURL=ClassMirrorWrapper.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"ClassMirrorWrapper.js","sourceRoot":"","sources":["../../../src/model/apex-type-wrappers/ClassMirrorWrapper.ts"],"names":[],"mappings":";;;AAEA,MAAa,kBAAkB;IAC7B,YAAmB,WAAwB;QAAxB,gBAAW,GAAX,WAAW,CAAa;QAMnC,kBAAa,GAAG,CAAC,MAAoB,EAAE,cAAsB,EAAE,EAAE,CACvE,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,cAAc,CAAC,CAAC;IAP9C,CAAC;IAE/C,sBAAsB,CAAC,UAAkB;QACvC,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC;IAC7F,CAAC;CAIF;AATD,gDASC"}
@@ -1,7 +0,0 @@
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 +0,0 @@
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
- //# sourceMappingURL=MethodMirrorWrapper.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"MethodMirrorWrapper.js","sourceRoot":"","sources":["../../../src/model/apex-type-wrappers/MethodMirrorWrapper.ts"],"names":[],"mappings":";;;AAEA,MAAa,mBAAmB;IAC9B,YAAmB,YAA0B;QAA1B,iBAAY,GAAZ,YAAY,CAAc;QAEtC,4BAAuB,GAAG,CAAC,cAAsB,EAAE,EAAE,WAC1D,OAAA,MAAA,IAAI,CAAC,YAAY,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,cAAc,CAAC,CAAA,EAAA,CAAC;QAE5G,4BAAuB,GAAG,CAAC,cAAsB,EAAoC,EAAE,WAC5F,OAAA,MAAA,IAAI,CAAC,YAAY,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,cAAc,CAAC,CAAA,EAAA,CAAC;IANnE,CAAC;CAOlD;AARD,kDAQC"}
@@ -1,8 +0,0 @@
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 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=inheritance.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"inheritance.js","sourceRoot":"","sources":["../../src/model/inheritance.ts"],"names":[],"mappings":""}
@@ -1,22 +0,0 @@
1
- import { Type, Annotation, DocComment } from '@cparra/apex-reflection';
2
- type AccessAndDocAware = {
3
- access_modifier: string;
4
- annotations: Annotation[];
5
- docComment?: DocComment;
6
- };
7
- /**
8
- * Represents the full library of Apex top-level types (classes, enums, and interface) for a Salesforce project.
9
- */
10
- export default class Manifest {
11
- types: Type[];
12
- isForInnerTypes: boolean;
13
- /**
14
- * Constructs a new Manifest object.
15
- * @param types List of types to be wrapped by this object.
16
- * @param isForInnerTypes Whether this manifest represent an inner type or not.
17
- */
18
- constructor(types: Type[], isForInnerTypes?: boolean);
19
- filteredByAccessModifierAndAnnotations(modifiers: string[]): Type[];
20
- filterAccessibleModifier(accessAndDocAware: AccessAndDocAware[], modifiers: string[]): AccessAndDocAware[];
21
- }
22
- export {};
@@ -1,47 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- /**
4
- * Represents the full library of Apex top-level types (classes, enums, and interface) for a Salesforce project.
5
- */
6
- class Manifest {
7
- /**
8
- * Constructs a new Manifest object.
9
- * @param types List of types to be wrapped by this object.
10
- * @param isForInnerTypes Whether this manifest represent an inner type or not.
11
- */
12
- constructor(types, isForInnerTypes = false) {
13
- this.types = types;
14
- this.isForInnerTypes = isForInnerTypes;
15
- }
16
- filteredByAccessModifierAndAnnotations(modifiers) {
17
- const filteredTypes = this.filterAccessibleModifier(this.types, modifiers);
18
- const typesToReturn = [];
19
- for (const filteredType of filteredTypes) {
20
- const currentType = filteredType;
21
- if (currentType.type_name !== 'class') {
22
- typesToReturn.push(currentType);
23
- continue;
24
- }
25
- const currentClass = currentType;
26
- let filteredClass = Object.assign(Object.assign({}, currentType), { methods: this.filterAccessibleModifier(currentClass.methods, modifiers), properties: this.filterAccessibleModifier(currentClass.properties, modifiers), fields: this.filterAccessibleModifier(currentClass.fields, modifiers), constructors: this.filterAccessibleModifier(currentClass.constructors, modifiers) });
27
- if (!this.isForInnerTypes) {
28
- filteredClass = Object.assign(Object.assign({}, filteredClass), { enums: this.filterAccessibleModifier(currentClass.enums, modifiers), interfaces: this.filterAccessibleModifier(currentClass.interfaces, modifiers), classes: new Manifest(currentClass.classes, true).filteredByAccessModifierAndAnnotations(modifiers) });
29
- }
30
- typesToReturn.push(filteredClass);
31
- }
32
- return typesToReturn;
33
- }
34
- filterAccessibleModifier(accessAndDocAware, modifiers) {
35
- return accessAndDocAware.filter((currentType) => {
36
- var _a;
37
- const hasIgnoreDocAnnotation = (_a = currentType.docComment) === null || _a === void 0 ? void 0 : _a.annotations.some((annotation) => annotation.name === 'ignore');
38
- if (hasIgnoreDocAnnotation) {
39
- return false;
40
- }
41
- return (modifiers.includes(currentType.access_modifier) ||
42
- currentType.annotations.some((annotation) => modifiers.includes(annotation.type.toLowerCase())));
43
- });
44
- }
45
- }
46
- exports.default = Manifest;
47
- //# sourceMappingURL=manifest.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"manifest.js","sourceRoot":"","sources":["../../src/model/manifest.ts"],"names":[],"mappings":";;AAYA;;GAEG;AACH,MAAqB,QAAQ;IAC3B;;;;OAIG;IACH,YAAmB,KAAa,EAAS,kBAA2B,KAAK;QAAtD,UAAK,GAAL,KAAK,CAAQ;QAAS,oBAAe,GAAf,eAAe,CAAiB;IAAG,CAAC;IAE7E,sCAAsC,CAAC,SAAmB;QACxD,MAAM,aAAa,GAAG,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QAC3E,MAAM,aAAa,GAAW,EAAE,CAAC;QACjC,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE;YACxC,MAAM,WAAW,GAAG,YAAoB,CAAC;YACzC,IAAI,WAAW,CAAC,SAAS,KAAK,OAAO,EAAE;gBACrC,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;gBAChC,SAAS;aACV;YAED,MAAM,YAAY,GAAG,WAA0B,CAAC;YAChD,IAAI,aAAa,GAAG,gCACf,WAAW,KACd,OAAO,EAAE,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC,OAAO,EAAE,SAAS,CAAC,EACvE,UAAU,EAAE,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC,UAAU,EAAE,SAAS,CAAC,EAC7E,MAAM,EAAE,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC,MAAM,EAAE,SAAS,CAAC,EACrE,YAAY,EAAE,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC,YAAY,EAAE,SAAS,CAAC,GACnE,CAAC;YAEjB,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE;gBACzB,aAAa,mCACR,aAAa,KAChB,KAAK,EAAE,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC,KAAK,EAAE,SAAS,CAAiB,EACnF,UAAU,EAAE,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC,UAAU,EAAE,SAAS,CAAsB,EAClG,OAAO,EAAE,IAAI,QAAQ,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,sCAAsC,CACtF,SAAS,CACO,GACnB,CAAC;aACH;YAED,aAAa,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;SACnC;QAED,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,wBAAwB,CAAC,iBAAsC,EAAE,SAAmB;QAClF,OAAO,iBAAiB,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE;;YAC9C,MAAM,sBAAsB,GAAG,MAAA,WAAW,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CACrE,CAAC,UAAgC,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,KAAK,QAAQ,CACnE,CAAC;YACF,IAAI,sBAAsB,EAAE;gBAC1B,OAAO,KAAK,CAAC;aACd;YACD,OAAO,CACL,SAAS,CAAC,QAAQ,CAAC,WAAW,CAAC,eAAe,CAAC;gBAC/C,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,UAAsB,EAAE,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAC5G,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AA1DD,2BA0DC"}
@@ -1,16 +0,0 @@
1
- import { OutputFile } from './outputFile';
2
- export declare class MarkdownFile extends OutputFile {
3
- fileExtension(): string;
4
- addTitle(text: string, level?: number): void;
5
- addText(text: string, encodeHtml?: boolean): void;
6
- addLink(text: string, encodeHtml?: boolean): void;
7
- startCodeBlock(language?: string): void;
8
- endCodeBlock(): void;
9
- addHorizontalRule(): void;
10
- initializeTable(...headers: string[]): void;
11
- addTableRow(...columns: string[]): void;
12
- addListItem(text: string): void;
13
- protected static replaceInlineLinks(text: string): string;
14
- protected static replaceInlineEmails(text: string): string;
15
- private _replaceInlineReferences;
16
- }
@@ -1,110 +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.MarkdownFile = void 0;
7
- const outputFile_1 = require("./outputFile");
8
- const class_file_generatorHelper_1 = __importDefault(require("../transpiler/markdown/class-file-generatorHelper"));
9
- class MarkdownFile extends outputFile_1.OutputFile {
10
- fileExtension() {
11
- return '.md';
12
- }
13
- addTitle(text, level = 1) {
14
- let title = '';
15
- for (let i = 0; i < level; i++) {
16
- title += '#';
17
- }
18
- title += ' ';
19
- title += text;
20
- this._contents += title;
21
- this.addBlankLine();
22
- }
23
- addText(text, encodeHtml = true) {
24
- super.addText(this._replaceInlineReferences(text), encodeHtml);
25
- }
26
- addLink(text, encodeHtml = true) {
27
- this.addText(`\{@link ${text}\}`, encodeHtml);
28
- }
29
- startCodeBlock(language = 'apex') {
30
- this.addText(`\`\`\`${language}`);
31
- }
32
- endCodeBlock() {
33
- this.addText('```');
34
- this.addBlankLine();
35
- }
36
- addHorizontalRule() {
37
- this._contents += '---';
38
- this.addBlankLine();
39
- }
40
- initializeTable(...headers) {
41
- this.addBlankLine();
42
- this._contents += '|';
43
- headers.forEach((header) => {
44
- this._contents += header + '|';
45
- });
46
- this.addBlankLine();
47
- this._contents += '|';
48
- headers.forEach(() => {
49
- this._contents += '---' + '|';
50
- });
51
- this.addBlankLine();
52
- }
53
- addTableRow(...columns) {
54
- this._contents += '|';
55
- columns.forEach((column) => {
56
- this._contents += this._replaceInlineReferences(column) + '|';
57
- });
58
- this.addBlankLine();
59
- }
60
- addListItem(text) {
61
- this._contents += `* ${text}`;
62
- }
63
- static replaceInlineLinks(text) {
64
- // Parsing text to extract possible linking classes.
65
- const possibleLinks = text.match(/<<.*?>>/g);
66
- possibleLinks === null || possibleLinks === void 0 ? void 0 : possibleLinks.forEach((currentMatch) => {
67
- const classNameForMatch = currentMatch.replace('<<', '').replace('>>', '');
68
- text = text.replace(currentMatch, class_file_generatorHelper_1.default.getFileLinkByTypeName(classNameForMatch));
69
- });
70
- // Parsing links using {@link ClassName} format
71
- const linkFormatRegEx = '{@link (.*?)}';
72
- const expression = new RegExp(linkFormatRegEx, 'gi');
73
- let match;
74
- const matches = [];
75
- do {
76
- match = expression.exec(text);
77
- if (match) {
78
- matches.push(match);
79
- }
80
- } while (match);
81
- for (const currentMatch of matches) {
82
- text = text.replace(currentMatch[0], class_file_generatorHelper_1.default.getFileLinkByTypeName(currentMatch[1]));
83
- }
84
- return text;
85
- }
86
- static replaceInlineEmails(text) {
87
- // Parsing links using {@link ClassName} format
88
- const linkFormatRegEx = '{@email (.*?)}';
89
- const expression = new RegExp(linkFormatRegEx, 'gi');
90
- let match;
91
- const matches = [];
92
- do {
93
- match = expression.exec(text);
94
- if (match) {
95
- matches.push(match);
96
- }
97
- } while (match);
98
- for (const currentMatch of matches) {
99
- text = text.replace(currentMatch[0], `[${currentMatch[1]}](mailto:${currentMatch[1]})`);
100
- }
101
- return text;
102
- }
103
- _replaceInlineReferences(text) {
104
- text = MarkdownFile.replaceInlineLinks(text);
105
- text = MarkdownFile.replaceInlineEmails(text);
106
- return text;
107
- }
108
- }
109
- exports.MarkdownFile = MarkdownFile;
110
- //# sourceMappingURL=markdown-file.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"markdown-file.js","sourceRoot":"","sources":["../../src/model/markdown-file.ts"],"names":[],"mappings":";;;;;;AAAA,6CAA0C;AAC1C,mHAAyF;AAEzF,MAAa,YAAa,SAAQ,uBAAU;IAC1C,aAAa;QACX,OAAO,KAAK,CAAC;IACf,CAAC;IAED,QAAQ,CAAC,IAAY,EAAE,KAAK,GAAG,CAAC;QAC9B,IAAI,KAAK,GAAG,EAAE,CAAC;QACf,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,EAAE;YAC9B,KAAK,IAAI,GAAG,CAAC;SACd;QAED,KAAK,IAAI,GAAG,CAAC;QACb,KAAK,IAAI,IAAI,CAAC;QACd,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC;QACxB,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAEM,OAAO,CAAC,IAAY,EAAE,UAAU,GAAG,IAAI;QAC5C,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,EAAE,UAAU,CAAC,CAAC;IACjE,CAAC;IAEM,OAAO,CAAC,IAAY,EAAE,UAAU,GAAG,IAAI;QAC5C,IAAI,CAAC,OAAO,CAAC,WAAW,IAAI,IAAI,EAAE,UAAU,CAAC,CAAC;IAChD,CAAC;IAED,cAAc,CAAC,QAAQ,GAAG,MAAM;QAC9B,IAAI,CAAC,OAAO,CAAC,SAAS,QAAQ,EAAE,CAAC,CAAC;IACpC,CAAC;IAED,YAAY;QACV,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACpB,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,iBAAiB;QACf,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC;QACxB,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,eAAe,CAAC,GAAG,OAAiB;QAClC,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,SAAS,IAAI,GAAG,CAAC;QACtB,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YACzB,IAAI,CAAC,SAAS,IAAI,MAAM,GAAG,GAAG,CAAC;QACjC,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,SAAS,IAAI,GAAG,CAAC;QACtB,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE;YACnB,IAAI,CAAC,SAAS,IAAI,KAAK,GAAG,GAAG,CAAC;QAChC,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,WAAW,CAAC,GAAG,OAAiB;QAC9B,IAAI,CAAC,SAAS,IAAI,GAAG,CAAC;QACtB,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YACzB,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,GAAG,GAAG,CAAC;QAChE,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,WAAW,CAAC,IAAY;QACtB,IAAI,CAAC,SAAS,IAAI,KAAK,IAAI,EAAE,CAAC;IAChC,CAAC;IAES,MAAM,CAAC,kBAAkB,CAAC,IAAY;QAC9C,oDAAoD;QACpD,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC7C,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE;YACtC,MAAM,iBAAiB,GAAG,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAC3E,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,oCAAwB,CAAC,qBAAqB,CAAC,iBAAiB,CAAC,CAAC,CAAC;QACvG,CAAC,CAAC,CAAC;QAEH,+CAA+C;QAC/C,MAAM,eAAe,GAAG,eAAe,CAAC;QACxC,MAAM,UAAU,GAAG,IAAI,MAAM,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;QACrD,IAAI,KAAK,CAAC;QACV,MAAM,OAAO,GAAG,EAAE,CAAC;QAEnB,GAAG;YACD,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC9B,IAAI,KAAK,EAAE;gBACT,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aACrB;SACF,QAAQ,KAAK,EAAE;QAEhB,KAAK,MAAM,YAAY,IAAI,OAAO,EAAE;YAClC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,oCAAwB,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SACvG;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAES,MAAM,CAAC,mBAAmB,CAAC,IAAY;QAC/C,+CAA+C;QAC/C,MAAM,eAAe,GAAG,gBAAgB,CAAC;QACzC,MAAM,UAAU,GAAG,IAAI,MAAM,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;QACrD,IAAI,KAAK,CAAC;QACV,MAAM,OAAO,GAAG,EAAE,CAAC;QAEnB,GAAG;YACD,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC9B,IAAI,KAAK,EAAE;gBACT,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aACrB;SACF,QAAQ,KAAK,EAAE;QAEhB,KAAK,MAAM,YAAY,IAAI,OAAO,EAAE;YAClC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,IAAI,YAAY,CAAC,CAAC,CAAC,YAAY,YAAY,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;SACzF;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,wBAAwB,CAAC,IAAY;QAC3C,IAAI,GAAG,YAAY,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAC7C,IAAI,GAAG,YAAY,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;QAC9C,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AArHD,oCAqHC"}
@@ -1,8 +0,0 @@
1
- import { DocComment } from '@cparra/apex-reflection';
2
- import { MarkdownFile } from '../markdown-file';
3
- interface DocCommentAware {
4
- docComment?: DocComment;
5
- }
6
- export declare function addMermaid(markdownFile: MarkdownFile, docCommentAware: DocCommentAware): void;
7
- export declare function addCustomDocCommentAnnotations(markdownFile: MarkdownFile, docCommentAware: DocCommentAware): void;
8
- export {};