@cparra/apexdocs 2.25.0-alpha.2 → 2.25.0-alpha.4

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 (355) hide show
  1. package/README.md +37 -0
  2. package/dist/cli/generate.js +291 -0
  3. package/dist/index.d.ts +2 -0
  4. package/dist/index.js +1 -0
  5. package/examples/plain-markdown/docs/Miscellaneous/ns.SampleException.md +18 -0
  6. package/examples/plain-markdown/docs/Miscellaneous/ns.SampleInterface.md +6 -2
  7. package/examples/plain-markdown/docs/Miscellaneous/ns.Url.md +320 -0
  8. package/examples/plain-markdown/docs/Sample-Enums/ns.SampleEnum.md +3 -1
  9. package/examples/plain-markdown/docs/SampleGroup/ns.SampleClass.md +1 -1
  10. package/examples/plain-markdown/docs/index.md +84 -0
  11. package/examples/plain-markdown/force-app/classes/SampleException.cls +16 -0
  12. package/examples/plain-markdown/force-app/classes/Url.cls +194 -0
  13. package/examples/plain-markdown/package.json +2 -1
  14. package/jest.config.js +1 -1
  15. package/package.json +11 -13
  16. package/src/__spec__/core/generating-class-docs.spec.ts +57 -37
  17. package/src/__spec__/core/generating-enum-docs.spec.ts +25 -22
  18. package/src/__spec__/core/generating-interface-docs.spec.ts +33 -30
  19. package/src/__spec__/core/generating-reference-guide.spec.ts +8 -7
  20. package/src/__spec__/core/test-helpers.ts +9 -0
  21. package/src/application/Apexdocs.ts +34 -5
  22. package/src/application/{flows → generators}/generate-markdown-files.ts +19 -13
  23. package/src/cli/args.ts +138 -0
  24. package/src/cli/generate.ts +12 -138
  25. package/src/core/adapters/__tests__/documentables.spec.ts +109 -0
  26. package/src/{adapters → core/adapters}/__tests__/interface-adapter.spec.ts +13 -11
  27. package/src/{adapters → core/adapters}/__tests__/references.spec.ts +23 -2
  28. package/src/{adapters → core/adapters}/apex-types.ts +18 -15
  29. package/src/{adapters → core/adapters}/documentables.ts +54 -12
  30. package/src/{adapters → core/adapters}/fields-and-properties.ts +17 -10
  31. package/src/{adapters/references.ts → core/adapters/inline.ts} +43 -13
  32. package/src/{adapters → core/adapters}/methods-and-constructors.ts +21 -9
  33. package/src/core/adapters/type-utils.ts +13 -0
  34. package/src/core/{renderable → adapters}/types.d.ts +42 -4
  35. package/src/core/generate-docs.ts +55 -19
  36. package/src/core/template.ts +15 -9
  37. package/src/core/templates/reference-guide.ts +1 -1
  38. package/src/model/__tests__/manifest.spec.ts +1 -1
  39. package/src/model/markdown-generation-util/field-declaration-util.ts +1 -1
  40. package/src/model/markdown-generation-util/method-declaration-util.ts +1 -1
  41. package/src/model/markdown-type-file.ts +5 -1
  42. package/src/service/__tests__/apex-file-reader.spec.ts +1 -0
  43. package/src/service/apex-file-reader.ts +2 -6
  44. package/src/service/manifest-factory.ts +2 -2
  45. package/src/service/parser.ts +1 -1
  46. package/src/settings.ts +6 -10
  47. package/src/test-helpers/SettingsBuilder.ts +1 -2
  48. package/src/transpiler/factory.ts +2 -4
  49. package/src/transpiler/markdown/class-file-generatorHelper.ts +1 -18
  50. package/src/transpiler/markdown/plain-markdown/constructors-partial-template.ts +2 -2
  51. package/src/transpiler/markdown/plain-markdown/documentable-partial-template.ts +6 -4
  52. package/src/transpiler/markdown/plain-markdown/fieldsPartialTemplate.ts +1 -1
  53. package/src/transpiler/markdown/plain-markdown/methods-partial-template.ts +2 -2
  54. package/src/util/fp.ts +3 -0
  55. package/tsconfig.json +1 -1
  56. package/docs/.nojekyll +0 -0
  57. package/docs/__old/README.md +0 -1
  58. package/docs/__old/index.html +0 -22
  59. package/docs/__old/restapi.json +0 -589
  60. package/docs/__old/types/Classes/nspc.AnotherInterface.md +0 -22
  61. package/docs/__old/types/Classes/nspc.ChildClass.md +0 -97
  62. package/docs/__old/types/Main/nspc.GroupedClass.md +0 -10
  63. package/docs/__old/types/Main/nspc.SampleClass.md +0 -189
  64. package/docs/__old/types/Misc-Group/nspc.EscapedAnnotations.md +0 -4
  65. package/docs/__old/types/Misc-Group/nspc.GrandparentClass.md +0 -13
  66. package/docs/__old/types/Misc-Group/nspc.InterfaceWithInheritance.md +0 -29
  67. package/docs/__old/types/Misc-Group/nspc.MemberGrouping.md +0 -13
  68. package/docs/__old/types/Misc-Group/nspc.ParentClass.md +0 -37
  69. package/docs/__old/types/Misc-Group/nspc.Reference1.md +0 -18
  70. package/docs/__old/types/Misc-Group/nspc.Reference2.md +0 -12
  71. package/docs/__old/types/Misc-Group/nspc.Reference3.md +0 -7
  72. package/docs/__old/types/Misc-Group/nspc.Reference4.md +0 -7
  73. package/docs/__old/types/Misc-Group/nspc.Reference5.md +0 -7
  74. package/docs/__old/types/Misc-Group/nspc.Reference6.md +0 -9
  75. package/docs/__old/types/Misc-Group/nspc.Reference7.md +0 -7
  76. package/docs/__old/types/Misc-Group/nspc.SampleClassWithoutModifier.md +0 -11
  77. package/docs/__old/types/Misc-Group/nspc.SampleRestResource.md +0 -104
  78. package/docs/__old/types/Misc-Group/nspc.SampleRestResourceWithInnerClass.md +0 -33
  79. package/docs/__old/types/Misc-Group/nspc.SampleRestResourceWithoutApexDocs.md +0 -14
  80. package/docs/__old/types/README.md +0 -97
  81. package/docs/__old/types/Sample-Interfaces/nspc.SampleInterface.md +0 -23
  82. package/examples/includes/header.md +0 -3
  83. package/lib/__spec__/core/expect-extensions.d.ts +0 -3
  84. package/lib/__spec__/core/expect-extensions.js +0 -54
  85. package/lib/__spec__/core/expect-extensions.js.map +0 -1
  86. package/lib/__spec__/core/generating-class-docs.spec.d.ts +0 -1
  87. package/lib/__spec__/core/generating-class-docs.spec.js +0 -427
  88. package/lib/__spec__/core/generating-class-docs.spec.js.map +0 -1
  89. package/lib/__spec__/core/generating-enum-docs.spec.d.ts +0 -1
  90. package/lib/__spec__/core/generating-enum-docs.spec.js +0 -303
  91. package/lib/__spec__/core/generating-enum-docs.spec.js.map +0 -1
  92. package/lib/__spec__/core/generating-interface-docs.spec.d.ts +0 -1
  93. package/lib/__spec__/core/generating-interface-docs.spec.js +0 -361
  94. package/lib/__spec__/core/generating-interface-docs.spec.js.map +0 -1
  95. package/lib/__spec__/core/generating-reference-guide.spec.d.ts +0 -1
  96. package/lib/__spec__/core/generating-reference-guide.spec.js +0 -161
  97. package/lib/__spec__/core/generating-reference-guide.spec.js.map +0 -1
  98. package/lib/adapters/apex-types.d.ts +0 -5
  99. package/lib/adapters/apex-types.js +0 -109
  100. package/lib/adapters/apex-types.js.map +0 -1
  101. package/lib/adapters/documentables.d.ts +0 -7
  102. package/lib/adapters/documentables.js +0 -56
  103. package/lib/adapters/documentables.js.map +0 -1
  104. package/lib/adapters/fields-and-properties.d.ts +0 -4
  105. package/lib/adapters/fields-and-properties.js +0 -31
  106. package/lib/adapters/fields-and-properties.js.map +0 -1
  107. package/lib/adapters/methods-and-constructors.d.ts +0 -5
  108. package/lib/adapters/methods-and-constructors.js +0 -91
  109. package/lib/adapters/methods-and-constructors.js.map +0 -1
  110. package/lib/adapters/references.d.ts +0 -5
  111. package/lib/adapters/references.js +0 -82
  112. package/lib/adapters/references.js.map +0 -1
  113. package/lib/adapters/type-utils.d.ts +0 -2
  114. package/lib/adapters/type-utils.js +0 -7
  115. package/lib/adapters/type-utils.js.map +0 -1
  116. package/lib/application/Apexdocs.d.ts +0 -13
  117. package/lib/application/Apexdocs.js +0 -86
  118. package/lib/application/Apexdocs.js.map +0 -1
  119. package/lib/application/flows/generate-markdown-files.d.ts +0 -3
  120. package/lib/application/flows/generate-markdown-files.js +0 -57
  121. package/lib/application/flows/generate-markdown-files.js.map +0 -1
  122. package/lib/cli/generate.d.ts +0 -2
  123. package/lib/cli/generate.js +0 -157
  124. package/lib/cli/generate.js.map +0 -1
  125. package/lib/core/__test__/inheritance-chain.test.d.ts +0 -1
  126. package/lib/core/__test__/inheritance-chain.test.js +0 -42
  127. package/lib/core/__test__/inheritance-chain.test.js.map +0 -1
  128. package/lib/core/generate-docs.d.ts +0 -24
  129. package/lib/core/generate-docs.js +0 -267
  130. package/lib/core/generate-docs.js.map +0 -1
  131. package/lib/core/inheritance-chain.d.ts +0 -2
  132. package/lib/core/inheritance-chain.js +0 -35
  133. package/lib/core/inheritance-chain.js.map +0 -1
  134. package/lib/core/template.d.ts +0 -10
  135. package/lib/core/template.js +0 -92
  136. package/lib/core/template.js.map +0 -1
  137. package/lib/core/templates/reference-guide.d.ts +0 -1
  138. package/lib/core/templates/reference-guide.js +0 -18
  139. package/lib/core/templates/reference-guide.js.map +0 -1
  140. package/lib/index.d.ts +0 -2
  141. package/lib/index.js +0 -29
  142. package/lib/index.js.map +0 -1
  143. package/lib/model/apex-bundle.d.ts +0 -6
  144. package/lib/model/apex-bundle.js +0 -11
  145. package/lib/model/apex-bundle.js.map +0 -1
  146. package/lib/model/apex-type-wrappers/ClassMirrorWrapper.d.ts +0 -7
  147. package/lib/model/apex-type-wrappers/ClassMirrorWrapper.js +0 -14
  148. package/lib/model/apex-type-wrappers/ClassMirrorWrapper.js.map +0 -1
  149. package/lib/model/apex-type-wrappers/MethodMirrorWrapper.d.ts +0 -7
  150. package/lib/model/apex-type-wrappers/MethodMirrorWrapper.js +0 -12
  151. package/lib/model/apex-type-wrappers/MethodMirrorWrapper.js.map +0 -1
  152. package/lib/model/inheritance.d.ts +0 -11
  153. package/lib/model/inheritance.js +0 -3
  154. package/lib/model/inheritance.js.map +0 -1
  155. package/lib/model/manifest.d.ts +0 -22
  156. package/lib/model/manifest.js +0 -53
  157. package/lib/model/manifest.js.map +0 -1
  158. package/lib/model/markdown-file.d.ts +0 -16
  159. package/lib/model/markdown-file.js +0 -111
  160. package/lib/model/markdown-file.js.map +0 -1
  161. package/lib/model/markdown-generation-util/doc-comment-annotation-util.d.ts +0 -8
  162. package/lib/model/markdown-generation-util/doc-comment-annotation-util.js +0 -46
  163. package/lib/model/markdown-generation-util/doc-comment-annotation-util.js.map +0 -1
  164. package/lib/model/markdown-generation-util/field-declaration-util.d.ts +0 -3
  165. package/lib/model/markdown-generation-util/field-declaration-util.js +0 -54
  166. package/lib/model/markdown-generation-util/field-declaration-util.js.map +0 -1
  167. package/lib/model/markdown-generation-util/index.d.ts +0 -3
  168. package/lib/model/markdown-generation-util/index.js +0 -20
  169. package/lib/model/markdown-generation-util/index.js.map +0 -1
  170. package/lib/model/markdown-generation-util/method-declaration-util.d.ts +0 -4
  171. package/lib/model/markdown-generation-util/method-declaration-util.js +0 -114
  172. package/lib/model/markdown-generation-util/method-declaration-util.js.map +0 -1
  173. package/lib/model/markdown-generation-util/type-declaration-util.d.ts +0 -3
  174. package/lib/model/markdown-generation-util/type-declaration-util.js +0 -81
  175. package/lib/model/markdown-generation-util/type-declaration-util.js.map +0 -1
  176. package/lib/model/markdown-home-file.d.ts +0 -11
  177. package/lib/model/markdown-home-file.js +0 -57
  178. package/lib/model/markdown-home-file.js.map +0 -1
  179. package/lib/model/markdown-type-file.d.ts +0 -26
  180. package/lib/model/markdown-type-file.js +0 -137
  181. package/lib/model/markdown-type-file.js.map +0 -1
  182. package/lib/model/openapi/apex-doc-types.d.ts +0 -19
  183. package/lib/model/openapi/apex-doc-types.js +0 -5
  184. package/lib/model/openapi/apex-doc-types.js.map +0 -1
  185. package/lib/model/openapi/open-api-types.d.ts +0 -93
  186. package/lib/model/openapi/open-api-types.js +0 -3
  187. package/lib/model/openapi/open-api-types.js.map +0 -1
  188. package/lib/model/openapi/open-api.d.ts +0 -16
  189. package/lib/model/openapi/open-api.js +0 -34
  190. package/lib/model/openapi/open-api.js.map +0 -1
  191. package/lib/model/openapi/openapi-type-file.d.ts +0 -7
  192. package/lib/model/openapi/openapi-type-file.js +0 -17
  193. package/lib/model/openapi/openapi-type-file.js.map +0 -1
  194. package/lib/model/outputFile.d.ts +0 -10
  195. package/lib/model/outputFile.js +0 -22
  196. package/lib/model/outputFile.js.map +0 -1
  197. package/lib/model/types-repository.d.ts +0 -16
  198. package/lib/model/types-repository.js +0 -54
  199. package/lib/model/types-repository.js.map +0 -1
  200. package/lib/service/apex-file-reader.d.ts +0 -14
  201. package/lib/service/apex-file-reader.js +0 -49
  202. package/lib/service/apex-file-reader.js.map +0 -1
  203. package/lib/service/file-system.d.ts +0 -14
  204. package/lib/service/file-system.js +0 -48
  205. package/lib/service/file-system.js.map +0 -1
  206. package/lib/service/file-writer.d.ts +0 -6
  207. package/lib/service/file-writer.js +0 -57
  208. package/lib/service/file-writer.js.map +0 -1
  209. package/lib/service/manifest-factory.d.ts +0 -10
  210. package/lib/service/manifest-factory.js +0 -16
  211. package/lib/service/manifest-factory.js.map +0 -1
  212. package/lib/service/metadata-processor.d.ts +0 -3
  213. package/lib/service/metadata-processor.js +0 -17
  214. package/lib/service/metadata-processor.js.map +0 -1
  215. package/lib/service/parser.d.ts +0 -21
  216. package/lib/service/parser.js +0 -138
  217. package/lib/service/parser.js.map +0 -1
  218. package/lib/service/state.d.ts +0 -9
  219. package/lib/service/state.js +0 -20
  220. package/lib/service/state.js.map +0 -1
  221. package/lib/service/walkers/class-walker.d.ts +0 -4
  222. package/lib/service/walkers/class-walker.js +0 -33
  223. package/lib/service/walkers/class-walker.js.map +0 -1
  224. package/lib/service/walkers/enum-walker.d.ts +0 -4
  225. package/lib/service/walkers/enum-walker.js +0 -11
  226. package/lib/service/walkers/enum-walker.js.map +0 -1
  227. package/lib/service/walkers/interface-walker.d.ts +0 -4
  228. package/lib/service/walkers/interface-walker.js +0 -15
  229. package/lib/service/walkers/interface-walker.js.map +0 -1
  230. package/lib/service/walkers/walker-factory.d.ts +0 -5
  231. package/lib/service/walkers/walker-factory.js +0 -21
  232. package/lib/service/walkers/walker-factory.js.map +0 -1
  233. package/lib/service/walkers/walker.d.ts +0 -19
  234. package/lib/service/walkers/walker.js +0 -17
  235. package/lib/service/walkers/walker.js.map +0 -1
  236. package/lib/settings.d.ts +0 -64
  237. package/lib/settings.js +0 -89
  238. package/lib/settings.js.map +0 -1
  239. package/lib/test-helpers/AnnotationBuilder.d.ts +0 -12
  240. package/lib/test-helpers/AnnotationBuilder.js +0 -31
  241. package/lib/test-helpers/AnnotationBuilder.js.map +0 -1
  242. package/lib/test-helpers/ClassMirrorBuilder.d.ts +0 -22
  243. package/lib/test-helpers/ClassMirrorBuilder.js +0 -64
  244. package/lib/test-helpers/ClassMirrorBuilder.js.map +0 -1
  245. package/lib/test-helpers/DocCommentAnnotationBuilder.d.ts +0 -8
  246. package/lib/test-helpers/DocCommentAnnotationBuilder.js +0 -26
  247. package/lib/test-helpers/DocCommentAnnotationBuilder.js.map +0 -1
  248. package/lib/test-helpers/DocCommentBuilder.d.ts +0 -12
  249. package/lib/test-helpers/DocCommentBuilder.js +0 -38
  250. package/lib/test-helpers/DocCommentBuilder.js.map +0 -1
  251. package/lib/test-helpers/FieldMirrorBuilder.d.ts +0 -18
  252. package/lib/test-helpers/FieldMirrorBuilder.js +0 -54
  253. package/lib/test-helpers/FieldMirrorBuilder.js.map +0 -1
  254. package/lib/test-helpers/InterfaceMirrorBuilder.d.ts +0 -16
  255. package/lib/test-helpers/InterfaceMirrorBuilder.js +0 -43
  256. package/lib/test-helpers/InterfaceMirrorBuilder.js.map +0 -1
  257. package/lib/test-helpers/MethodMirrorBuilder.d.ts +0 -29
  258. package/lib/test-helpers/MethodMirrorBuilder.js +0 -72
  259. package/lib/test-helpers/MethodMirrorBuilder.js.map +0 -1
  260. package/lib/test-helpers/SettingsBuilder.d.ts +0 -8
  261. package/lib/test-helpers/SettingsBuilder.js +0 -27
  262. package/lib/test-helpers/SettingsBuilder.js.map +0 -1
  263. package/lib/transpiler/factory.d.ts +0 -6
  264. package/lib/transpiler/factory.js +0 -35
  265. package/lib/transpiler/factory.js.map +0 -1
  266. package/lib/transpiler/file-container.d.ts +0 -6
  267. package/lib/transpiler/file-container.js +0 -16
  268. package/lib/transpiler/file-container.js.map +0 -1
  269. package/lib/transpiler/generator-choices.d.ts +0 -1
  270. package/lib/transpiler/generator-choices.js +0 -3
  271. package/lib/transpiler/generator-choices.js.map +0 -1
  272. package/lib/transpiler/markdown/class-file-generatorHelper.d.ts +0 -11
  273. package/lib/transpiler/markdown/class-file-generatorHelper.js +0 -75
  274. package/lib/transpiler/markdown/class-file-generatorHelper.js.map +0 -1
  275. package/lib/transpiler/markdown/docsify/docsify-docs-processor.d.ts +0 -6
  276. package/lib/transpiler/markdown/docsify/docsify-docs-processor.js +0 -13
  277. package/lib/transpiler/markdown/docsify/docsify-docs-processor.js.map +0 -1
  278. package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.d.ts +0 -11
  279. package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.js +0 -51
  280. package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.js.map +0 -1
  281. package/lib/transpiler/markdown/markdown-transpiler-base.d.ts +0 -11
  282. package/lib/transpiler/markdown/markdown-transpiler-base.js +0 -27
  283. package/lib/transpiler/markdown/markdown-transpiler-base.js.map +0 -1
  284. package/lib/transpiler/markdown/plain-markdown/class-template.d.ts +0 -1
  285. package/lib/transpiler/markdown/plain-markdown/class-template.js +0 -77
  286. package/lib/transpiler/markdown/plain-markdown/class-template.js.map +0 -1
  287. package/lib/transpiler/markdown/plain-markdown/constructors-partial-template.d.ts +0 -1
  288. package/lib/transpiler/markdown/plain-markdown/constructors-partial-template.js +0 -36
  289. package/lib/transpiler/markdown/plain-markdown/constructors-partial-template.js.map +0 -1
  290. package/lib/transpiler/markdown/plain-markdown/documentable-partial-template.d.ts +0 -1
  291. package/lib/transpiler/markdown/plain-markdown/documentable-partial-template.js +0 -28
  292. package/lib/transpiler/markdown/plain-markdown/documentable-partial-template.js.map +0 -1
  293. package/lib/transpiler/markdown/plain-markdown/enum-template.d.ts +0 -1
  294. package/lib/transpiler/markdown/plain-markdown/enum-template.js +0 -16
  295. package/lib/transpiler/markdown/plain-markdown/enum-template.js.map +0 -1
  296. package/lib/transpiler/markdown/plain-markdown/fieldsPartialTemplate.d.ts +0 -1
  297. package/lib/transpiler/markdown/plain-markdown/fieldsPartialTemplate.js +0 -27
  298. package/lib/transpiler/markdown/plain-markdown/fieldsPartialTemplate.js.map +0 -1
  299. package/lib/transpiler/markdown/plain-markdown/grouped-members-partial-template.d.ts +0 -1
  300. package/lib/transpiler/markdown/plain-markdown/grouped-members-partial-template.js +0 -10
  301. package/lib/transpiler/markdown/plain-markdown/grouped-members-partial-template.js.map +0 -1
  302. package/lib/transpiler/markdown/plain-markdown/interface-template.d.ts +0 -1
  303. package/lib/transpiler/markdown/plain-markdown/interface-template.js +0 -20
  304. package/lib/transpiler/markdown/plain-markdown/interface-template.js.map +0 -1
  305. package/lib/transpiler/markdown/plain-markdown/methods-partial-template.d.ts +0 -1
  306. package/lib/transpiler/markdown/plain-markdown/methods-partial-template.js +0 -47
  307. package/lib/transpiler/markdown/plain-markdown/methods-partial-template.js.map +0 -1
  308. package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.d.ts +0 -9
  309. package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.js +0 -42
  310. package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.js.map +0 -1
  311. package/lib/transpiler/markdown/plain-markdown/type-doc-partial.d.ts +0 -1
  312. package/lib/transpiler/markdown/plain-markdown/type-doc-partial.js +0 -31
  313. package/lib/transpiler/markdown/plain-markdown/type-doc-partial.js.map +0 -1
  314. package/lib/transpiler/openapi/open-api-docs-processor.d.ts +0 -13
  315. package/lib/transpiler/openapi/open-api-docs-processor.js +0 -78
  316. package/lib/transpiler/openapi/open-api-docs-processor.js.map +0 -1
  317. package/lib/transpiler/openapi/parsers/Builder.d.ts +0 -16
  318. package/lib/transpiler/openapi/parsers/Builder.js +0 -30
  319. package/lib/transpiler/openapi/parsers/Builder.js.map +0 -1
  320. package/lib/transpiler/openapi/parsers/MethodParser.d.ts +0 -20
  321. package/lib/transpiler/openapi/parsers/MethodParser.js +0 -190
  322. package/lib/transpiler/openapi/parsers/MethodParser.js.map +0 -1
  323. package/lib/transpiler/openapi/parsers/ParameterObjectBuilder.d.ts +0 -7
  324. package/lib/transpiler/openapi/parsers/ParameterObjectBuilder.js +0 -11
  325. package/lib/transpiler/openapi/parsers/ParameterObjectBuilder.js.map +0 -1
  326. package/lib/transpiler/openapi/parsers/ReferenceBuilder.d.ts +0 -39
  327. package/lib/transpiler/openapi/parsers/ReferenceBuilder.js +0 -250
  328. package/lib/transpiler/openapi/parsers/ReferenceBuilder.js.map +0 -1
  329. package/lib/transpiler/openapi/parsers/RequestBodyBuilder.d.ts +0 -10
  330. package/lib/transpiler/openapi/parsers/RequestBodyBuilder.js +0 -20
  331. package/lib/transpiler/openapi/parsers/RequestBodyBuilder.js.map +0 -1
  332. package/lib/transpiler/openapi/parsers/ResponsesBuilder.d.ts +0 -7
  333. package/lib/transpiler/openapi/parsers/ResponsesBuilder.js +0 -22
  334. package/lib/transpiler/openapi/parsers/ResponsesBuilder.js.map +0 -1
  335. package/lib/transpiler/processor-type-transpiler.d.ts +0 -10
  336. package/lib/transpiler/processor-type-transpiler.js +0 -9
  337. package/lib/transpiler/processor-type-transpiler.js.map +0 -1
  338. package/lib/transpiler/transpiler.d.ts +0 -5
  339. package/lib/transpiler/transpiler.js +0 -30
  340. package/lib/transpiler/transpiler.js.map +0 -1
  341. package/lib/util/error-logger.d.ts +0 -8
  342. package/lib/util/error-logger.js +0 -90
  343. package/lib/util/error-logger.js.map +0 -1
  344. package/lib/util/logger.d.ts +0 -21
  345. package/lib/util/logger.js +0 -61
  346. package/lib/util/logger.js.map +0 -1
  347. package/lib/util/string-utils.d.ts +0 -2
  348. package/lib/util/string-utils.js +0 -15
  349. package/lib/util/string-utils.js.map +0 -1
  350. package/src/adapters/type-utils.ts +0 -5
  351. package/src/adapters/types.d.ts +0 -8
  352. package/src/model/inheritance.ts +0 -8
  353. package/src/transpiler/markdown/plain-markdown/plain-docsProcessor.ts +0 -42
  354. /package/src/{model → core}/apex-bundle.ts +0 -0
  355. /package/src/{model → core}/manifest.ts +0 -0
@@ -1,77 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.classMarkdownTemplate = void 0;
4
- exports.classMarkdownTemplate = `
5
- {{ heading headingLevel heading }}
6
- {{#if classModifier}}
7
- \`{{classModifier}}\`
8
- {{/if}}
9
-
10
- {{> typeDocumentation}}
11
-
12
- {{#if extends.length}}
13
- **Inheritance**
14
- {{#each extends}}{{link this}}{{#unless @last}} < {{/unless}}{{/each}}
15
- {{/if}}
16
-
17
- {{#if implements}}
18
- **Implements**
19
- {{#each implements}}
20
- {{link this}}{{#unless @last}}, {{/unless}}
21
- {{/each}}
22
- {{/if}}
23
-
24
- {{#if fields.value}}
25
- {{#if fields.isGrouped}}
26
- {{> groupedMembersPartialTemplate fields subTemplate="fieldsPartialTemplate"}}
27
- {{else}}
28
- {{> fieldsPartialTemplate fields}}
29
- {{/if}}
30
- {{/if}}
31
-
32
- {{#if properties.value}}
33
- {{#if properties.isGrouped}}
34
- {{> groupedMembersPartialTemplate properties subTemplate="fieldsPartialTemplate"}}
35
- {{else}}
36
- {{> fieldsPartialTemplate properties}}
37
- {{/if}}
38
- {{/if}}
39
-
40
- {{#if constructors.value}}
41
- {{#if constructors.isGrouped}}
42
- {{> groupedMembersPartialTemplate constructors subTemplate="constructorsPartialTemplate"}}
43
- {{else}}
44
- {{> constructorsPartialTemplate constructors}}
45
- {{/if}}
46
- {{/if}}
47
-
48
- {{#if methods.value}}
49
- {{#if methods.isGrouped}}
50
- {{> groupedMembersPartialTemplate methods subTemplate="methodsPartialTemplate"}}
51
- {{else}}
52
- {{> methodsPartialTemplate methods}}
53
- {{/if}}
54
- {{/if}}
55
-
56
- {{#if innerClasses.value}}
57
- {{ heading innerClasses.headingLevel innerClasses.heading }}
58
- {{#each innerClasses.value}}
59
- {{> classTemplate this}}
60
- {{/each}}
61
- {{/if}}
62
-
63
- {{#if innerEnums.value}}
64
- {{ heading innerEnums.headingLevel innerEnums.heading }}
65
- {{#each innerEnums.value}}
66
- {{> enumTemplate this}}
67
- {{/each}}
68
- {{/if}}
69
-
70
- {{#if innerInterfaces.value}}
71
- {{ heading innerInterfaces.headingLevel innerInterfaces.heading }}
72
- {{#each innerInterfaces.value}}
73
- {{> interfaceTemplate this}}
74
- {{/each}}
75
- {{/if}}
76
- `.trim();
77
- //# sourceMappingURL=class-template.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"class-template.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/class-template.ts"],"names":[],"mappings":";;;AAAa,QAAA,qBAAqB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwEpC,CAAC,IAAI,EAAE,CAAC"}
@@ -1 +0,0 @@
1
- export declare const constructorsPartialTemplate: string;
@@ -1,36 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.constructorsPartialTemplate = void 0;
4
- exports.constructorsPartialTemplate = `
5
- {{ heading headingLevel heading }}
6
- {{#each value}}
7
- {{{ heading headingLevel (inlineCode heading) }}}
8
-
9
- {{#> documentablePartialTemplate}}
10
-
11
- {{ heading signature.headingLevel signature.heading }}
12
- {{ code "apex" signature.value }}
13
-
14
- {{#if parameters.value}}
15
- {{ heading parameters.headingLevel parameters.heading }}
16
- | Name | Type | Description |
17
- |------|------|-------------|
18
- {{#each parameters.value}}
19
- | {{name}} | {{type}} | {{description}} |
20
- {{/each}}
21
- {{/if}}
22
-
23
- {{#if throws.value}}
24
- {{ heading throws.headingLevel throws.heading }}
25
- {{#each throws.value}}
26
- {{link this.type}}: {{this.description}}
27
-
28
- {{/each}}
29
- {{/if}}
30
- {{/documentablePartialTemplate}}
31
-
32
- {{#unless @last}}---{{/unless}}
33
-
34
- {{/each}}
35
- `.trim();
36
- //# sourceMappingURL=constructors-partial-template.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"constructors-partial-template.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/constructors-partial-template.ts"],"names":[],"mappings":";;;AAAa,QAAA,2BAA2B,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA+B1C,CAAC,IAAI,EAAE,CAAC"}
@@ -1 +0,0 @@
1
- export declare const documentablePartialTemplate: string;
@@ -1,28 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.documentablePartialTemplate = void 0;
4
- exports.documentablePartialTemplate = `
5
- {{#each doc.annotations}}
6
- \`{{this}}\`
7
- {{/each}}
8
-
9
- {{withLinks doc.description}}
10
-
11
- {{#each doc.customTags}}
12
- **{{splitAndCapitalize name}}** {{withLinks description}}
13
-
14
- {{/each}}
15
-
16
- {{> @partial-block}}
17
-
18
- {{#if doc.mermaid.value}}
19
- {{ heading doc.mermaid.headingLevel doc.mermaid.heading }}
20
- {{code "mermaid" doc.mermaid.value}}
21
- {{/if}}
22
-
23
- {{#if doc.example.value}}
24
- {{ heading doc.example.headingLevel doc.example.heading }}
25
- {{code "apex" doc.example.value}}
26
- {{/if}}
27
- `.trim();
28
- //# sourceMappingURL=documentable-partial-template.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"documentable-partial-template.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/documentable-partial-template.ts"],"names":[],"mappings":";;;AAAa,QAAA,2BAA2B,GAAG;;;;;;;;;;;;;;;;;;;;;;;CAuB1C,CAAC,IAAI,EAAE,CAAC"}
@@ -1 +0,0 @@
1
- export declare const enumMarkdownTemplate: string;
@@ -1,16 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.enumMarkdownTemplate = void 0;
4
- exports.enumMarkdownTemplate = `
5
- {{ heading headingLevel heading }}
6
-
7
- {{> typeDocumentation }}
8
-
9
- {{ heading values.headingLevel values.heading }}
10
- | Value | Description |
11
- |-------|-------------|
12
- {{#each values.value}}
13
- | {{value}} | {{description}} |
14
- {{/each}}
15
- `.trim();
16
- //# sourceMappingURL=enum-template.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"enum-template.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/enum-template.ts"],"names":[],"mappings":";;;AAAa,QAAA,oBAAoB,GAAG;;;;;;;;;;;CAWnC,CAAC,IAAI,EAAE,CAAC"}
@@ -1 +0,0 @@
1
- export declare const fieldsPartialTemplate: string;
@@ -1,27 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.fieldsPartialTemplate = void 0;
4
- exports.fieldsPartialTemplate = `
5
- {{ heading headingLevel heading }}
6
- {{#each value}}
7
- {{{ heading headingLevel (inlineCode heading) }}}
8
-
9
- {{#if inherited}}
10
- *Inherited*
11
- {{/if}}
12
-
13
- {{#> documentablePartialTemplate }}
14
-
15
- {{ heading signature.headingLevel signature.heading }}
16
- {{ code "apex" signature.value }}
17
-
18
- {{ heading type.headingLevel type.heading }}
19
- {{link type.value}}
20
-
21
- {{/documentablePartialTemplate}}
22
-
23
- {{#unless @last}}---{{/unless}}
24
-
25
- {{/each}}
26
- `.trim();
27
- //# sourceMappingURL=fieldsPartialTemplate.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"fieldsPartialTemplate.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/fieldsPartialTemplate.ts"],"names":[],"mappings":";;;AAAa,QAAA,qBAAqB,GAAG;;;;;;;;;;;;;;;;;;;;;;CAsBpC,CAAC,IAAI,EAAE,CAAC"}
@@ -1 +0,0 @@
1
- export declare const groupedMembersPartialTemplate: string;
@@ -1,10 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.groupedMembersPartialTemplate = void 0;
4
- exports.groupedMembersPartialTemplate = `
5
- {{ heading headingLevel heading }}
6
- {{#each value}}
7
- {{> (lookup .. "subTemplate") this}}
8
- {{/each}}
9
- `.trim();
10
- //# sourceMappingURL=grouped-members-partial-template.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"grouped-members-partial-template.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/grouped-members-partial-template.ts"],"names":[],"mappings":";;;AAAa,QAAA,6BAA6B,GAAG;;;;;CAK5C,CAAC,IAAI,EAAE,CAAC"}
@@ -1 +0,0 @@
1
- export declare const interfaceMarkdownTemplate: string;
@@ -1,20 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.interfaceMarkdownTemplate = void 0;
4
- exports.interfaceMarkdownTemplate = `
5
- {{ heading headingLevel heading }}
6
-
7
- {{> typeDocumentation }}
8
-
9
- {{#if extends}}
10
- **Extends**
11
- {{#each extends}}
12
- {{link this}}{{#unless @last}}, {{/unless}}
13
- {{/each}}
14
- {{/if}}
15
-
16
- {{#if methods}}
17
- {{> methodsPartialTemplate methods}}
18
- {{/if}}
19
- `.trim();
20
- //# sourceMappingURL=interface-template.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"interface-template.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/interface-template.ts"],"names":[],"mappings":";;;AAAa,QAAA,yBAAyB,GAAG;;;;;;;;;;;;;;;CAexC,CAAC,IAAI,EAAE,CAAC"}
@@ -1 +0,0 @@
1
- export declare const methodsPartialTemplate: string;
@@ -1,47 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.methodsPartialTemplate = void 0;
4
- exports.methodsPartialTemplate = `
5
- {{ heading headingLevel heading }}
6
- {{#each value}}
7
- {{{ heading headingLevel (inlineCode heading) }}}
8
-
9
- {{#if inherited}}
10
- *Inherited*
11
- {{/if}}
12
-
13
- {{#> documentablePartialTemplate}}
14
-
15
- {{ heading signature.headingLevel signature.heading }}
16
- {{ code "apex" signature.value }}
17
-
18
- {{#if parameters.value}}
19
- {{ heading parameters.headingLevel parameters.heading }}
20
- | Name | Type | Description |
21
- |------|------|-------------|
22
- {{#each parameters.value}}
23
- | {{name}} | {{link type}} | {{withLinks description}} |
24
- {{/each}}
25
- {{/if}}
26
-
27
- {{ heading returnType.headingLevel returnType.heading }}
28
- **{{link returnType.value.type}}**
29
-
30
- {{#if returnType.value.description}}
31
- {{returnType.value.description}}
32
- {{/if}}
33
-
34
- {{#if throws.value}}
35
- {{ heading throws.headingLevel throws.heading }}
36
- {{#each throws.value}}
37
- {{link this.type}}: {{this.description}}
38
-
39
- {{/each}}
40
- {{/if}}
41
- {{/documentablePartialTemplate}}
42
-
43
- {{#unless @last}}---{{/unless}}
44
-
45
- {{/each}}
46
- `.trim();
47
- //# sourceMappingURL=methods-partial-template.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"methods-partial-template.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/methods-partial-template.ts"],"names":[],"mappings":";;;AAAa,QAAA,sBAAsB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA0CrC,CAAC,IAAI,EAAE,CAAC"}
@@ -1,9 +0,0 @@
1
- import { MarkdownTranspilerBase } from '../markdown-transpiler-base';
2
- import { LinkingStrategy } from '../../processor-type-transpiler';
3
- import { Type } from '@cparra/apex-reflection';
4
- export declare class PlainMarkdownDocsProcessor extends MarkdownTranspilerBase {
5
- onBeforeProcess: (types: Type[]) => void;
6
- homeFileName(): string;
7
- getLinkingStrategy(): LinkingStrategy;
8
- onProcess(type: Type): void;
9
- }
@@ -1,42 +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.PlainMarkdownDocsProcessor = void 0;
7
- const markdown_transpiler_base_1 = require("../markdown-transpiler-base");
8
- const outputFile_1 = require("../../../model/outputFile");
9
- const settings_1 = require("../../../settings");
10
- const class_file_generatorHelper_1 = __importDefault(require("../class-file-generatorHelper"));
11
- const markdown_home_file_1 = require("../../../model/markdown-home-file");
12
- const generate_docs_1 = require("../../../core/generate-docs");
13
- const references_1 = require("../../../adapters/references");
14
- class PlainMarkdownDocsProcessor extends markdown_transpiler_base_1.MarkdownTranspilerBase {
15
- constructor() {
16
- super(...arguments);
17
- this.onBeforeProcess = (types) => {
18
- this._fileContainer.pushFile(new markdown_home_file_1.MarkdownHomeFile(this.homeFileName(), types));
19
- };
20
- }
21
- homeFileName() {
22
- return 'index';
23
- }
24
- getLinkingStrategy() {
25
- return 'path-relative';
26
- }
27
- onProcess(type) {
28
- this._fileContainer.pushFile(new GenericFile(type));
29
- }
30
- }
31
- exports.PlainMarkdownDocsProcessor = PlainMarkdownDocsProcessor;
32
- class GenericFile extends outputFile_1.OutputFile {
33
- constructor(type) {
34
- super(`${settings_1.Settings.getInstance().getNamespacePrefix()}${type.name}`, class_file_generatorHelper_1.default.getSanitizedGroup(type));
35
- this.type = type;
36
- this.addText((0, generate_docs_1.documentType)(type, references_1.linkFromTypeNameGenerator, settings_1.Settings.getInstance().getNamespace()));
37
- }
38
- fileExtension() {
39
- return '.md';
40
- }
41
- }
42
- //# sourceMappingURL=plain-docsProcessor.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"plain-docsProcessor.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/plain-docsProcessor.ts"],"names":[],"mappings":";;;;;;AAAA,0EAAqE;AAGrE,0DAAuD;AACvD,gDAA6C;AAC7C,+FAAqE;AACrE,0EAAqE;AACrE,+DAA2D;AAC3D,6DAAyE;AAEzE,MAAa,0BAA2B,SAAQ,iDAAsB;IAAtE;;QACE,oBAAe,GAAG,CAAC,KAAa,EAAE,EAAE;YAClC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,qCAAgB,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;QACjF,CAAC,CAAC;IAaJ,CAAC;IAXC,YAAY;QACV,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,kBAAkB;QAChB,OAAO,eAAe,CAAC;IACzB,CAAC;IAED,SAAS,CAAC,IAAU;QAClB,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;IACtD,CAAC;CACF;AAhBD,gEAgBC;AAED,MAAM,WAAY,SAAQ,uBAAU;IAClC,YAAoB,IAAU;QAC5B,KAAK,CACH,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,kBAAkB,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,EAC5D,oCAAwB,CAAC,iBAAiB,CAAC,IAAI,CAAC,CACjD,CAAC;QAJgB,SAAI,GAAJ,IAAI,CAAM;QAM5B,IAAI,CAAC,OAAO,CAAC,IAAA,4BAAY,EAAC,IAAI,EAAE,sCAAyB,EAAE,mBAAQ,CAAC,WAAW,EAAE,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC;IACrG,CAAC;IAED,aAAa;QACX,OAAO,KAAK,CAAC;IACf,CAAC;CACF"}
@@ -1 +0,0 @@
1
- export declare const typeDocPartial: string;
@@ -1,31 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.typeDocPartial = void 0;
4
- exports.typeDocPartial = `
5
- {{#> documentablePartialTemplate}}
6
-
7
- {{#if doc.group}}
8
- **Group** {{doc.group}}
9
- {{/if}}
10
-
11
- {{#if doc.author}}
12
- **Author** {{doc.author}}
13
- {{/if}}
14
-
15
- {{#if doc.date}}
16
- **Date** {{doc.date}}
17
- {{/if}}
18
-
19
- {{#each doc.sees}}
20
- **See** {{link this}}
21
-
22
- {{/each}}
23
-
24
- {{#if namespace}}
25
- ## Namespace
26
- {{namespace}}
27
- {{/if}}
28
-
29
- {{/documentablePartialTemplate}}
30
- `.trim();
31
- //# sourceMappingURL=type-doc-partial.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"type-doc-partial.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/type-doc-partial.ts"],"names":[],"mappings":";;;AAAa,QAAA,cAAc,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;CA0B7B,CAAC,IAAI,EAAE,CAAC"}
@@ -1,13 +0,0 @@
1
- import ProcessorTypeTranspiler from '../processor-type-transpiler';
2
- import { FileContainer } from '../file-container';
3
- import { Type } from '@cparra/apex-reflection';
4
- import { OpenApi } from '../../model/openapi/open-api';
5
- export declare class OpenApiDocsProcessor extends ProcessorTypeTranspiler {
6
- protected readonly _fileContainer: FileContainer;
7
- openApiModel: OpenApi;
8
- constructor();
9
- fileBuilder(): FileContainer;
10
- onProcess(type: Type): void;
11
- onAfterProcess: ((types: Type[]) => void) | undefined;
12
- private getEndpointPath;
13
- }
@@ -1,78 +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.OpenApiDocsProcessor = void 0;
7
- const processor_type_transpiler_1 = __importDefault(require("../processor-type-transpiler"));
8
- const file_container_1 = require("../file-container");
9
- const openapi_type_file_1 = require("../../model/openapi/openapi-type-file");
10
- const logger_1 = require("../../util/logger");
11
- const open_api_1 = require("../../model/openapi/open-api");
12
- const settings_1 = require("../../settings");
13
- const MethodParser_1 = require("./parsers/MethodParser");
14
- const string_utils_1 = require("../../util/string-utils");
15
- class OpenApiDocsProcessor extends processor_type_transpiler_1.default {
16
- constructor() {
17
- super();
18
- this.onAfterProcess = () => {
19
- this._fileContainer.pushFile(new openapi_type_file_1.OpenapiTypeFile(this.openApiModel));
20
- };
21
- this._fileContainer = new file_container_1.FileContainer();
22
- const title = settings_1.Settings.getInstance().getOpenApiTitle();
23
- if (!title) {
24
- throw Error('No OpenApi title was provided.');
25
- }
26
- this.openApiModel = new open_api_1.OpenApi(title, '1.0.0', settings_1.Settings.getInstance().getNamespace());
27
- }
28
- fileBuilder() {
29
- return this._fileContainer;
30
- }
31
- onProcess(type) {
32
- var _a, _b;
33
- logger_1.Logger.logSingle(`Processing ${type.name}`, false, 'green', false);
34
- const endpointPath = this.getEndpointPath(type);
35
- if (!endpointPath) {
36
- return;
37
- }
38
- this.openApiModel.paths[endpointPath] = {};
39
- if ((_a = type.docComment) === null || _a === void 0 ? void 0 : _a.description) {
40
- this.openApiModel.paths[endpointPath].description = type.docComment.description;
41
- }
42
- // We can safely cast to a ClassMirror, since only these support the @RestResource annotation
43
- const typeAsClass = type;
44
- // Add tags for this Apex class to the OpenApi model
45
- const tagName = (0, string_utils_1.camel2title)(endpointPath);
46
- this.openApiModel.tags.push({
47
- name: tagName,
48
- description: (_b = type.docComment) === null || _b === void 0 ? void 0 : _b.description,
49
- });
50
- const parser = new MethodParser_1.MethodParser(this.openApiModel);
51
- // GET
52
- parser.parseMethod(typeAsClass, endpointPath, 'get', tagName);
53
- // PATCH
54
- parser.parseMethod(typeAsClass, endpointPath, 'patch', tagName);
55
- // POST
56
- parser.parseMethod(typeAsClass, endpointPath, 'post', tagName);
57
- // PUT
58
- parser.parseMethod(typeAsClass, endpointPath, 'put', tagName);
59
- // DELETE
60
- parser.parseMethod(typeAsClass, endpointPath, 'delete', tagName);
61
- }
62
- getEndpointPath(type) {
63
- var _a;
64
- const restResourceAnnotation = type.annotations.find((element) => element.name.toLowerCase() === 'restresource');
65
- const urlMapping = (_a = restResourceAnnotation === null || restResourceAnnotation === void 0 ? void 0 : restResourceAnnotation.elementValues) === null || _a === void 0 ? void 0 : _a.find((element) => element.key.toLowerCase() === 'urlmapping');
66
- if (!urlMapping) {
67
- logger_1.Logger.error(`Type does not contain urlMapping annotation ${type.name}`);
68
- return null;
69
- }
70
- let endpointPath = urlMapping.value.replaceAll('"', '').replaceAll("'", '').replaceAll('/*', '/');
71
- if (endpointPath.startsWith('/')) {
72
- endpointPath = endpointPath.substring(1);
73
- }
74
- return endpointPath;
75
- }
76
- }
77
- exports.OpenApiDocsProcessor = OpenApiDocsProcessor;
78
- //# sourceMappingURL=open-api-docs-processor.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"open-api-docs-processor.js","sourceRoot":"","sources":["../../../src/transpiler/openapi/open-api-docs-processor.ts"],"names":[],"mappings":";;;;;;AAAA,6FAAmE;AACnE,sDAAkD;AAElD,6EAAwE;AACxE,8CAA2C;AAC3C,2DAAuD;AACvD,6CAA0C;AAC1C,yDAAsD;AACtD,0DAAsD;AAEtD,MAAa,oBAAqB,SAAQ,mCAAuB;IAI/D;QACE,KAAK,EAAE,CAAC;QAsDV,mBAAc,GAA0C,GAAG,EAAE;YAC3D,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,mCAAe,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;QACvE,CAAC,CAAC;QAvDA,IAAI,CAAC,cAAc,GAAG,IAAI,8BAAa,EAAE,CAAC;QAC1C,MAAM,KAAK,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,eAAe,EAAE,CAAC;QACvD,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,KAAK,CAAC,gCAAgC,CAAC,CAAC;QAChD,CAAC;QACD,IAAI,CAAC,YAAY,GAAG,IAAI,kBAAO,CAAC,KAAK,EAAE,OAAO,EAAE,mBAAQ,CAAC,WAAW,EAAE,CAAC,YAAY,EAAE,CAAC,CAAC;IACzF,CAAC;IAED,WAAW;QACT,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED,SAAS,CAAC,IAAU;;QAClB,eAAM,CAAC,SAAS,CAAC,cAAc,IAAI,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QAEnE,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAChD,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,OAAO;QACT,CAAC;QAED,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC;QAC3C,IAAI,MAAA,IAAI,CAAC,UAAU,0CAAE,WAAW,EAAE,CAAC;YACjC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;QAClF,CAAC;QAED,6FAA6F;QAC7F,MAAM,WAAW,GAAG,IAAmB,CAAC;QAExC,oDAAoD;QACpD,MAAM,OAAO,GAAG,IAAA,0BAAW,EAAC,YAAY,CAAC,CAAC;QAC1C,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC;YAC1B,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,MAAA,IAAI,CAAC,UAAU,0CAAE,WAAW;SAC1C,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,IAAI,2BAAY,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAEnD,MAAM;QACN,MAAM,CAAC,WAAW,CAAC,WAAW,EAAE,YAAY,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;QAE9D,QAAQ;QACR,MAAM,CAAC,WAAW,CAAC,WAAW,EAAE,YAAY,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAEhE,OAAO;QACP,MAAM,CAAC,WAAW,CAAC,WAAW,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAE/D,MAAM;QACN,MAAM,CAAC,WAAW,CAAC,WAAW,EAAE,YAAY,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;QAE9D,SAAS;QACT,MAAM,CAAC,WAAW,CAAC,WAAW,EAAE,YAAY,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;IAMO,eAAe,CAAC,IAAU;;QAChC,MAAM,sBAAsB,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,cAAc,CAAC,CAAC;QACjH,MAAM,UAAU,GAAG,MAAA,sBAAsB,aAAtB,sBAAsB,uBAAtB,sBAAsB,CAAE,aAAa,0CAAE,IAAI,CAC5D,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,KAAK,YAAY,CACxD,CAAC;QACF,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,eAAM,CAAC,KAAK,CAAC,+CAA+C,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;YACzE,OAAO,IAAI,CAAC;QACd,CAAC;QAED,IAAI,YAAY,GAAG,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAClG,IAAI,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YACjC,YAAY,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAC3C,CAAC;QACD,OAAO,YAAY,CAAC;IACtB,CAAC;CACF;AA/ED,oDA+EC"}
@@ -1,16 +0,0 @@
1
- import { Reference } from './ReferenceBuilder';
2
- import { ApexDocSchemaObject } from '../../../model/openapi/apex-doc-types';
3
- import { SchemaObject } from '../../../model/openapi/open-api-types';
4
- export type ApexDocSchemaAware = {
5
- schema: ApexDocSchemaObject;
6
- };
7
- export declare abstract class Builder<T, K> {
8
- build(schemaAware: ApexDocSchemaAware): Response<T>;
9
- abstract buildBody(apexDocObject: K, reference?: Reference): T;
10
- protected getOpenApiSchemaFromApexDocSchema(schemaAware: ApexDocSchemaAware, reference?: Reference): SchemaObject;
11
- private isReferenceString;
12
- }
13
- export interface Response<T> {
14
- reference?: Reference;
15
- body: T;
16
- }
@@ -1,30 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.Builder = void 0;
4
- const ReferenceBuilder_1 = require("./ReferenceBuilder");
5
- class Builder {
6
- constructor() {
7
- this.isReferenceString = (targetObject) => {
8
- return typeof targetObject === 'string' || targetObject instanceof String;
9
- };
10
- }
11
- build(schemaAware) {
12
- let reference;
13
- if (this.isReferenceString(schemaAware.schema)) {
14
- reference = new ReferenceBuilder_1.ReferenceBuilder().build(schemaAware.schema);
15
- }
16
- return {
17
- reference: reference,
18
- body: this.buildBody(schemaAware, reference),
19
- };
20
- }
21
- getOpenApiSchemaFromApexDocSchema(schemaAware, reference) {
22
- if (this.isReferenceString(schemaAware.schema)) {
23
- // We are dealing with a reference
24
- return reference.entrypointReferenceObject;
25
- }
26
- return schemaAware.schema;
27
- }
28
- }
29
- exports.Builder = Builder;
30
- //# sourceMappingURL=Builder.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"Builder.js","sourceRoot":"","sources":["../../../../src/transpiler/openapi/parsers/Builder.ts"],"names":[],"mappings":";;;AAAA,yDAAiE;AAQjE,MAAsB,OAAO;IAA7B;QAuBU,sBAAiB,GAAG,CAAC,YAAqB,EAA0B,EAAE;YAC5E,OAAO,OAAO,YAAY,KAAK,QAAQ,IAAI,YAAY,YAAY,MAAM,CAAC;QAC5E,CAAC,CAAC;IACJ,CAAC;IAzBC,KAAK,CAAC,WAA+B;QACnC,IAAI,SAAgC,CAAC;QACrC,IAAI,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC;YAC/C,SAAS,GAAG,IAAI,mCAAgB,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QAC/D,CAAC;QAED,OAAO;YACL,SAAS,EAAE,SAAS;YACpB,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,WAAgB,EAAE,SAAS,CAAC;SAClD,CAAC;IACJ,CAAC;IAIS,iCAAiC,CAAC,WAA+B,EAAE,SAAqB;QAChG,IAAI,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC;YAC/C,kCAAkC;YAClC,OAAO,SAAU,CAAC,yBAAyB,CAAC;QAC9C,CAAC;QACD,OAAO,WAAW,CAAC,MAAM,CAAC;IAC5B,CAAC;CAKF;AA1BD,0BA0BC"}
@@ -1,20 +0,0 @@
1
- import { ClassMirror } from '@cparra/apex-reflection';
2
- import { OpenApi } from '../../../model/openapi/open-api';
3
- type HttpOperations = 'get' | 'put' | 'post' | 'delete' | 'patch';
4
- /**
5
- * Parses ApexDocs with HTTP REST annotations and turns them into an OpenApi specification.
6
- */
7
- export declare class MethodParser {
8
- openApiModel: OpenApi;
9
- constructor(openApiModel: OpenApi);
10
- parseMethod(classMirror: ClassMirror, httpUrlEndpoint: string, httpMethodKey: HttpOperations, tag: string): void;
11
- private parseHttpAnnotation;
12
- private addToOpenApiStrategy;
13
- private addRequestBodyToOpenApi;
14
- private addParametersToOpenApi;
15
- private addHttpResponsesToOpenApi;
16
- private fallbackHttpRequestBodyParser;
17
- private getFallbackHttpResponseParser;
18
- private addReference;
19
- }
20
- export {};