@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,54 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.FieldMirrorBuilder = void 0;
4
- class FieldMirrorBuilder {
5
- constructor() {
6
- this.docComment = undefined;
7
- this.accessModifier = 'public';
8
- this.name = 'fieldName';
9
- this.memberModifiers = [];
10
- this.type = {
11
- type: 'String',
12
- rawDeclaration: 'String',
13
- };
14
- }
15
- withAccessModifier(accessModifier) {
16
- this.accessModifier = accessModifier;
17
- return this;
18
- }
19
- withName(name) {
20
- this.name = name;
21
- return this;
22
- }
23
- withType(type) {
24
- this.type = {
25
- rawDeclaration: type,
26
- type: type,
27
- };
28
- return this;
29
- }
30
- withReferencedType(type) {
31
- this.type = type;
32
- return this;
33
- }
34
- addMemberModifier(memberModifier) {
35
- this.memberModifiers.push(memberModifier);
36
- return this;
37
- }
38
- withDocComment(docComment) {
39
- this.docComment = docComment;
40
- return this;
41
- }
42
- build() {
43
- return {
44
- access_modifier: this.accessModifier,
45
- annotations: [],
46
- name: this.name,
47
- memberModifiers: this.memberModifiers,
48
- typeReference: this.type,
49
- docComment: this.docComment,
50
- };
51
- }
52
- }
53
- exports.FieldMirrorBuilder = FieldMirrorBuilder;
54
- //# sourceMappingURL=FieldMirrorBuilder.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"FieldMirrorBuilder.js","sourceRoot":"","sources":["../../src/test-helpers/FieldMirrorBuilder.ts"],"names":[],"mappings":";;;AAKA,MAAa,kBAAkB;IAA/B;QACU,eAAU,GAA2B,SAAS,CAAC;QAC/C,mBAAc,GAAG,QAAQ,CAAC;QAC1B,SAAI,GAAG,WAAW,CAAC;QACnB,oBAAe,GAAqB,EAAE,CAAC;QACvC,SAAI,GAAmB;YAC7B,IAAI,EAAE,QAAQ;YACd,cAAc,EAAE,QAAQ;SACzB,CAAC;IA6CJ,CAAC;IA3CC,kBAAkB,CAAC,cAAsB;QACvC,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,QAAQ,CAAC,IAAY;QACnB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,QAAQ,CAAC,IAAY;QACnB,IAAI,CAAC,IAAI,GAAG;YACV,cAAc,EAAE,IAAI;YACpB,IAAI,EAAE,IAAI;SACX,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,kBAAkB,CAAC,IAAoB;QACrC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,iBAAiB,CAAC,cAA8B;QAC9C,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,cAAc,CAAC,UAAsB;QACnC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK;QACH,OAAO;YACL,eAAe,EAAE,IAAI,CAAC,cAAc;YACpC,WAAW,EAAE,EAAE;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,aAAa,EAAE,IAAI,CAAC,IAAI;YACxB,UAAU,EAAE,IAAI,CAAC,UAAU;SAC5B,CAAC;IACJ,CAAC;CACF;AArDD,gDAqDC"}
@@ -1,16 +0,0 @@
1
- import { Annotation, DocComment, InterfaceMirror, MethodMirror } from '@cparra/apex-reflection';
2
- /**
3
- * Builder class to create Interface objects.
4
- * For testing purposes only.
5
- */
6
- export declare class InterfaceMirrorBuilder {
7
- private name;
8
- private annotations;
9
- private docComment?;
10
- private methods;
11
- withName(name: string): InterfaceMirrorBuilder;
12
- addAnnotation(annotation: Annotation): InterfaceMirrorBuilder;
13
- withDocComment(docComment: DocComment): InterfaceMirrorBuilder;
14
- addMethod(method: MethodMirror): InterfaceMirrorBuilder;
15
- build(): InterfaceMirror;
16
- }
@@ -1,43 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.InterfaceMirrorBuilder = void 0;
4
- /**
5
- * Builder class to create Interface objects.
6
- * For testing purposes only.
7
- */
8
- class InterfaceMirrorBuilder {
9
- constructor() {
10
- this.name = 'SampleClass';
11
- this.annotations = [];
12
- this.methods = [];
13
- }
14
- withName(name) {
15
- this.name = name;
16
- return this;
17
- }
18
- addAnnotation(annotation) {
19
- this.annotations.push(annotation);
20
- return this;
21
- }
22
- withDocComment(docComment) {
23
- this.docComment = docComment;
24
- return this;
25
- }
26
- addMethod(method) {
27
- this.methods.push(method);
28
- return this;
29
- }
30
- build() {
31
- return {
32
- annotations: this.annotations,
33
- name: this.name,
34
- type_name: 'interface',
35
- methods: this.methods,
36
- access_modifier: 'public',
37
- docComment: this.docComment,
38
- extended_interfaces: [],
39
- };
40
- }
41
- }
42
- exports.InterfaceMirrorBuilder = InterfaceMirrorBuilder;
43
- //# sourceMappingURL=InterfaceMirrorBuilder.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"InterfaceMirrorBuilder.js","sourceRoot":"","sources":["../../src/test-helpers/InterfaceMirrorBuilder.ts"],"names":[],"mappings":";;;AAEA;;;GAGG;AACH,MAAa,sBAAsB;IAAnC;QACU,SAAI,GAAG,aAAa,CAAC;QACrB,gBAAW,GAAiB,EAAE,CAAC;QAE/B,YAAO,GAAmB,EAAE,CAAC;IAiCvC,CAAC;IA/BC,QAAQ,CAAC,IAAY;QACnB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,aAAa,CAAC,UAAsB;QAClC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,cAAc,CAAC,UAAsB;QACnC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,SAAS,CAAC,MAAoB;QAC5B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK;QACH,OAAO;YACL,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,SAAS,EAAE,WAAW;YACtB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,eAAe,EAAE,QAAQ;YACzB,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,mBAAmB,EAAE,EAAE;SACxB,CAAC;IACJ,CAAC;CACF;AArCD,wDAqCC"}
@@ -1,29 +0,0 @@
1
- import { Annotation, DocComment, MethodMirror, ParameterMirror } from '@cparra/apex-reflection';
2
- type Parameter = ParameterMirror;
3
- export declare class MethodMirrorBuilder {
4
- private name;
5
- private annotations;
6
- private docComment?;
7
- private typeReference;
8
- private parameters;
9
- withName(name: string): MethodMirrorBuilder;
10
- addAnnotation(annotation: Annotation): MethodMirrorBuilder;
11
- withDocComment(docComment: DocComment): MethodMirrorBuilder;
12
- withTypeReference(param: {
13
- type: string;
14
- rawDeclaration: string;
15
- }): this;
16
- addParameter(parameter: Parameter): MethodMirrorBuilder;
17
- build(): MethodMirror;
18
- }
19
- export declare class ParameterBuilder {
20
- private name;
21
- private typeReference;
22
- withName(name: string): ParameterBuilder;
23
- withTypeReference(param: {
24
- type: string;
25
- rawDeclaration: string;
26
- }): this;
27
- build(): Parameter;
28
- }
29
- export {};
@@ -1,72 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.ParameterBuilder = exports.MethodMirrorBuilder = void 0;
4
- class MethodMirrorBuilder {
5
- constructor() {
6
- this.name = 'sampleMethod';
7
- this.annotations = [];
8
- this.typeReference = {
9
- type: 'void',
10
- rawDeclaration: 'void',
11
- };
12
- this.parameters = [];
13
- }
14
- withName(name) {
15
- this.name = name;
16
- return this;
17
- }
18
- addAnnotation(annotation) {
19
- this.annotations.push(annotation);
20
- return this;
21
- }
22
- withDocComment(docComment) {
23
- this.docComment = docComment;
24
- return this;
25
- }
26
- withTypeReference(param) {
27
- this.typeReference = param;
28
- return this;
29
- }
30
- addParameter(parameter) {
31
- this.parameters.push(parameter);
32
- return this;
33
- }
34
- build() {
35
- return {
36
- access_modifier: 'public',
37
- annotations: this.annotations,
38
- name: this.name,
39
- memberModifiers: [],
40
- typeReference: this.typeReference,
41
- parameters: this.parameters,
42
- docComment: this.docComment,
43
- };
44
- }
45
- }
46
- exports.MethodMirrorBuilder = MethodMirrorBuilder;
47
- class ParameterBuilder {
48
- constructor() {
49
- this.name = 'param';
50
- this.typeReference = {
51
- type: 'String',
52
- rawDeclaration: 'String',
53
- };
54
- }
55
- withName(name) {
56
- this.name = name;
57
- return this;
58
- }
59
- withTypeReference(param) {
60
- this.typeReference = param;
61
- return this;
62
- }
63
- build() {
64
- return {
65
- memberModifiers: [],
66
- name: this.name,
67
- typeReference: this.typeReference,
68
- };
69
- }
70
- }
71
- exports.ParameterBuilder = ParameterBuilder;
72
- //# sourceMappingURL=MethodMirrorBuilder.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"MethodMirrorBuilder.js","sourceRoot":"","sources":["../../src/test-helpers/MethodMirrorBuilder.ts"],"names":[],"mappings":";;;AAIA,MAAa,mBAAmB;IAAhC;QACU,SAAI,GAAG,cAAc,CAAC;QACtB,gBAAW,GAAiB,EAAE,CAAC;QAE/B,kBAAa,GAA6C;YAChE,IAAI,EAAE,MAAM;YACZ,cAAc,EAAE,MAAM;SACvB,CAAC;QACM,eAAU,GAAgB,EAAE,CAAC;IAsCvC,CAAC;IApCC,QAAQ,CAAC,IAAY;QACnB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,aAAa,CAAC,UAAsB;QAClC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,cAAc,CAAC,UAAsB;QACnC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,iBAAiB,CAAC,KAA+C;QAC/D,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,YAAY,CAAC,SAAoB;QAC/B,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK;QACH,OAAO;YACL,eAAe,EAAE,QAAQ;YACzB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,eAAe,EAAE,EAAE;YACnB,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,UAAU,EAAE,IAAI,CAAC,UAAU;SAC5B,CAAC;IACJ,CAAC;CACF;AA9CD,kDA8CC;AAED,MAAa,gBAAgB;IAA7B;QACU,SAAI,GAAG,OAAO,CAAC;QACf,kBAAa,GAA6C;YAChE,IAAI,EAAE,QAAQ;YACd,cAAc,EAAE,QAAQ;SACzB,CAAC;IAmBJ,CAAC;IAjBC,QAAQ,CAAC,IAAY;QACnB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,iBAAiB,CAAC,KAA+C;QAC/D,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK;QACH,OAAO;YACL,eAAe,EAAE,EAAE;YACnB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,aAAa,EAAE,IAAI,CAAC,aAAa;SAClC,CAAC;IACJ,CAAC;CACF;AAxBD,4CAwBC"}
@@ -1,8 +0,0 @@
1
- import { SettingsConfig } from '../settings';
2
- /**
3
- * Builder class to create SettingsConfig objects.
4
- * For testing purposes only.
5
- */
6
- export declare class SettingsBuilder {
7
- build(): SettingsConfig;
8
- }
@@ -1,27 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.SettingsBuilder = void 0;
4
- /**
5
- * Builder class to create SettingsConfig objects.
6
- * For testing purposes only.
7
- */
8
- class SettingsBuilder {
9
- build() {
10
- return {
11
- sourceDirectory: './',
12
- recursive: true,
13
- scope: [],
14
- outputDir: './',
15
- targetGenerator: 'openapi',
16
- indexOnly: false,
17
- defaultGroupName: 'Misc',
18
- sanitizeHtml: true,
19
- openApiTitle: 'Apex API',
20
- openApiFileName: 'openapi',
21
- title: 'Classes',
22
- includeMetadata: false,
23
- };
24
- }
25
- }
26
- exports.SettingsBuilder = SettingsBuilder;
27
- //# sourceMappingURL=SettingsBuilder.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"SettingsBuilder.js","sourceRoot":"","sources":["../../src/test-helpers/SettingsBuilder.ts"],"names":[],"mappings":";;;AAEA;;;GAGG;AACH,MAAa,eAAe;IAC1B,KAAK;QACH,OAAO;YACL,eAAe,EAAE,IAAI;YACrB,SAAS,EAAE,IAAI;YACf,KAAK,EAAE,EAAE;YACT,SAAS,EAAE,IAAI;YACf,eAAe,EAAE,SAAS;YAC1B,SAAS,EAAE,KAAK;YAChB,gBAAgB,EAAE,MAAM;YACxB,YAAY,EAAE,IAAI;YAClB,YAAY,EAAE,UAAU;YACxB,eAAe,EAAE,SAAS;YAC1B,KAAK,EAAE,SAAS;YAChB,eAAe,EAAE,KAAK;SACvB,CAAC;IACJ,CAAC;CACF;AAjBD,0CAiBC"}
@@ -1,6 +0,0 @@
1
- import ProcessorTypeTranspiler from './processor-type-transpiler';
2
- import { GeneratorChoices } from './generator-choices';
3
- export declare class TypeTranspilerFactory {
4
- private static typeTranspilerCache?;
5
- static get(generator: GeneratorChoices): ProcessorTypeTranspiler;
6
- }
@@ -1,35 +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.TypeTranspilerFactory = void 0;
7
- const jekyll_docsProcessor_1 = require("./markdown/jekyll/jekyll-docsProcessor");
8
- const docsify_docs_processor_1 = __importDefault(require("./markdown/docsify/docsify-docs-processor"));
9
- const plain_docsProcessor_1 = require("./markdown/plain-markdown/plain-docsProcessor");
10
- const open_api_docs_processor_1 = require("./openapi/open-api-docs-processor");
11
- class TypeTranspilerFactory {
12
- static get(generator) {
13
- if (this.typeTranspilerCache) {
14
- return this.typeTranspilerCache;
15
- }
16
- switch (generator) {
17
- case 'jekyll':
18
- this.typeTranspilerCache = new jekyll_docsProcessor_1.JekyllDocsProcessor();
19
- return this.typeTranspilerCache;
20
- case 'docsify':
21
- this.typeTranspilerCache = new docsify_docs_processor_1.default();
22
- return this.typeTranspilerCache;
23
- case 'plain-markdown':
24
- this.typeTranspilerCache = new plain_docsProcessor_1.PlainMarkdownDocsProcessor();
25
- return this.typeTranspilerCache;
26
- case 'openapi':
27
- this.typeTranspilerCache = new open_api_docs_processor_1.OpenApiDocsProcessor();
28
- return this.typeTranspilerCache;
29
- default:
30
- throw Error('Invalid target generator');
31
- }
32
- }
33
- }
34
- exports.TypeTranspilerFactory = TypeTranspilerFactory;
35
- //# sourceMappingURL=factory.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"factory.js","sourceRoot":"","sources":["../../src/transpiler/factory.ts"],"names":[],"mappings":";;;;;;AAEA,iFAA6E;AAC7E,uGAA6E;AAC7E,uFAA2F;AAC3F,+EAAyE;AAEzE,MAAa,qBAAqB;IAGzB,MAAM,CAAC,GAAG,CAAC,SAA2B;QAC3C,IAAI,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC,mBAAmB,CAAC;QAClC,CAAC;QAED,QAAQ,SAAS,EAAE,CAAC;YAClB,KAAK,QAAQ;gBACX,IAAI,CAAC,mBAAmB,GAAG,IAAI,0CAAmB,EAAE,CAAC;gBACrD,OAAO,IAAI,CAAC,mBAAmB,CAAC;YAClC,KAAK,SAAS;gBACZ,IAAI,CAAC,mBAAmB,GAAG,IAAI,gCAAoB,EAAE,CAAC;gBACtD,OAAO,IAAI,CAAC,mBAAmB,CAAC;YAClC,KAAK,gBAAgB;gBACnB,IAAI,CAAC,mBAAmB,GAAG,IAAI,gDAA0B,EAAE,CAAC;gBAC5D,OAAO,IAAI,CAAC,mBAAmB,CAAC;YAClC,KAAK,SAAS;gBACZ,IAAI,CAAC,mBAAmB,GAAG,IAAI,8CAAoB,EAAE,CAAC;gBACtD,OAAO,IAAI,CAAC,mBAAmB,CAAC;YAClC;gBACE,MAAM,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;CACF;AAzBD,sDAyBC"}
@@ -1,6 +0,0 @@
1
- import { OutputFile } from '../model/outputFile';
2
- export declare class FileContainer {
3
- _files: OutputFile[];
4
- files(): OutputFile[];
5
- pushFile(file: OutputFile): void;
6
- }
@@ -1,16 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.FileContainer = void 0;
4
- class FileContainer {
5
- constructor() {
6
- this._files = [];
7
- }
8
- files() {
9
- return this._files;
10
- }
11
- pushFile(file) {
12
- this._files.push(file);
13
- }
14
- }
15
- exports.FileContainer = FileContainer;
16
- //# sourceMappingURL=file-container.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"file-container.js","sourceRoot":"","sources":["../../src/transpiler/file-container.ts"],"names":[],"mappings":";;;AAEA,MAAa,aAAa;IAA1B;QACE,WAAM,GAAiB,EAAE,CAAC;IAS5B,CAAC;IAPC,KAAK;QACH,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,QAAQ,CAAC,IAAgB;QACvB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;CACF;AAVD,sCAUC"}
@@ -1 +0,0 @@
1
- export type GeneratorChoices = 'jekyll' | 'docsify' | 'plain-markdown' | 'openapi';
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=generator-choices.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"generator-choices.js","sourceRoot":"","sources":["../../src/transpiler/generator-choices.ts"],"names":[],"mappings":""}
@@ -1,11 +0,0 @@
1
- import { Type } from '@cparra/apex-reflection';
2
- import { StringOrLink } from '../../core/renderable/types';
3
- export default class ClassFileGeneratorHelper {
4
- static getSanitizedGroup(classModel: Type): string;
5
- static getFileLink(classModel: Type): string;
6
- private static getFileLinkTuple;
7
- static getFileLinkByTypeName(typeName: string): string;
8
- static getRenderableLinkByTypeName(typeName: string): StringOrLink;
9
- private static getDirectoryRoot;
10
- private static getClassGroup;
11
- }
@@ -1,75 +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
- const types_repository_1 = require("../../model/types-repository");
7
- const settings_1 = require("../../settings");
8
- const state_1 = __importDefault(require("../../service/state"));
9
- const factory_1 = require("../factory");
10
- class ClassFileGeneratorHelper {
11
- static getSanitizedGroup(classModel) {
12
- return this.getClassGroup(classModel).replace(/ /g, '-').replace('.', '');
13
- }
14
- static getFileLink(classModel) {
15
- const [fullClassName, fileLink] = ClassFileGeneratorHelper.getFileLinkTuple(classModel);
16
- return `[${fullClassName}](${fileLink})`;
17
- }
18
- static getFileLinkTuple(classModel) {
19
- var _a;
20
- const documentationRoot = (_a = settings_1.Settings.getInstance().getRootDir()) !== null && _a !== void 0 ? _a : '';
21
- const directoryRoot = `${documentationRoot}${this.getDirectoryRoot(classModel)}`;
22
- const fullClassName = `${settings_1.Settings.getInstance().getNamespacePrefix()}${classModel.name}`;
23
- return [fullClassName, `${directoryRoot}${fullClassName}.md`];
24
- }
25
- static getFileLinkByTypeName(typeName) {
26
- const type = types_repository_1.TypesRepository.getInstance().getFromScopedByName(typeName);
27
- if (!type) {
28
- // If the type is not found, we return a Markdown hyperlink with whatever we received.
29
- return `[${typeName}](${typeName})`;
30
- }
31
- return this.getFileLink(type);
32
- }
33
- static getRenderableLinkByTypeName(typeName) {
34
- const type = types_repository_1.TypesRepository.getInstance().getFromScopedByName(typeName);
35
- if (!type) {
36
- // If the type is not found, we return the type name as a string.
37
- return typeName;
38
- }
39
- const [fullClassName, fileLink] = ClassFileGeneratorHelper.getFileLinkTuple(type);
40
- return {
41
- title: fullClassName,
42
- url: fileLink,
43
- };
44
- }
45
- static getDirectoryRoot(classModel) {
46
- // root-relative links start from the root by using a leading '/'
47
- const generator = settings_1.Settings.getInstance().targetGenerator;
48
- if (factory_1.TypeTranspilerFactory.get(generator).getLinkingStrategy() === 'root-relative') {
49
- return `/${this.getSanitizedGroup(classModel)}/`;
50
- }
51
- // path-relative links traverse the directory structure
52
- const typeBeingProcessed = state_1.default.getInstance().getTypeBeingProcessed();
53
- if (typeBeingProcessed) {
54
- if (this.getClassGroup(typeBeingProcessed) === this.getClassGroup(classModel)) {
55
- // If the types the same groups then we simply link directly to that file
56
- return './';
57
- }
58
- else {
59
- // If the types have different groups, then we have to go up a directory
60
- return `../${this.getSanitizedGroup(classModel)}/`;
61
- }
62
- }
63
- else {
64
- // If nothing is being processed, then we assume we are at the root and links should include the groups
65
- return `./${this.getSanitizedGroup(classModel)}/`;
66
- }
67
- }
68
- static getClassGroup(classModel) {
69
- var _a, _b;
70
- const groupAnnotation = (_a = classModel.docComment) === null || _a === void 0 ? void 0 : _a.annotations.find((annotation) => annotation.name.toLowerCase() === 'group');
71
- return (_b = groupAnnotation === null || groupAnnotation === void 0 ? void 0 : groupAnnotation.body) !== null && _b !== void 0 ? _b : settings_1.Settings.getInstance().getDefaultGroupName();
72
- }
73
- }
74
- exports.default = ClassFileGeneratorHelper;
75
- //# sourceMappingURL=class-file-generatorHelper.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"class-file-generatorHelper.js","sourceRoot":"","sources":["../../../src/transpiler/markdown/class-file-generatorHelper.ts"],"names":[],"mappings":";;;;;AACA,mEAA+D;AAC/D,6CAA0C;AAC1C,gEAAwC;AACxC,wCAAmD;AAGnD,MAAqB,wBAAwB;IACpC,MAAM,CAAC,iBAAiB,CAAC,UAAgB;QAC9C,OAAO,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IAC5E,CAAC;IAEM,MAAM,CAAC,WAAW,CAAC,UAAgB;QACxC,MAAM,CAAC,aAAa,EAAE,QAAQ,CAAC,GAAG,wBAAwB,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;QACxF,OAAO,IAAI,aAAa,KAAK,QAAQ,GAAG,CAAC;IAC3C,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,UAAgB;;QAC9C,MAAM,iBAAiB,GAAG,MAAA,mBAAQ,CAAC,WAAW,EAAE,CAAC,UAAU,EAAE,mCAAI,EAAE,CAAC;QACpE,MAAM,aAAa,GAAG,GAAG,iBAAiB,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,CAAC;QACjF,MAAM,aAAa,GAAG,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,kBAAkB,EAAE,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC;QACzF,OAAO,CAAC,aAAa,EAAE,GAAG,aAAa,GAAG,aAAa,KAAK,CAAC,CAAC;IAChE,CAAC;IAEM,MAAM,CAAC,qBAAqB,CAAC,QAAgB;QAClD,MAAM,IAAI,GAAG,kCAAe,CAAC,WAAW,EAAE,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;QACzE,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,sFAAsF;YACtF,OAAO,IAAI,QAAQ,KAAK,QAAQ,GAAG,CAAC;QACtC,CAAC;QAED,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAEM,MAAM,CAAC,2BAA2B,CAAC,QAAgB;QACxD,MAAM,IAAI,GAAG,kCAAe,CAAC,WAAW,EAAE,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;QACzE,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,iEAAiE;YACjE,OAAO,QAAQ,CAAC;QAClB,CAAC;QAED,MAAM,CAAC,aAAa,EAAE,QAAQ,CAAC,GAAG,wBAAwB,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAClF,OAAO;YACL,KAAK,EAAE,aAAa;YACpB,GAAG,EAAE,QAAQ;SACd,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,UAAgB;QAC9C,iEAAiE;QACjE,MAAM,SAAS,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,eAAe,CAAC;QACzD,IAAI,+BAAqB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,kBAAkB,EAAE,KAAK,eAAe,EAAE,CAAC;YAClF,OAAO,IAAI,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC;QACnD,CAAC;QAED,uDAAuD;QACvD,MAAM,kBAAkB,GAAG,eAAK,CAAC,WAAW,EAAE,CAAC,qBAAqB,EAAE,CAAC;QACvE,IAAI,kBAAkB,EAAE,CAAC;YACvB,IAAI,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,KAAK,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC9E,yEAAyE;gBACzE,OAAO,IAAI,CAAC;YACd,CAAC;iBAAM,CAAC;gBACN,wEAAwE;gBACxE,OAAO,MAAM,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC;YACrD,CAAC;QACH,CAAC;aAAM,CAAC;YACN,uGAAuG;YACvG,OAAO,KAAK,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC;QACpD,CAAC;IACH,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,UAAgB;;QAC3C,MAAM,eAAe,GAAG,MAAA,UAAU,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CAC7D,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,OAAO,CAC1D,CAAC;QACF,OAAO,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,IAAI,mCAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,mBAAmB,EAAE,CAAC;IAC/E,CAAC;CACF;AAtED,2CAsEC"}
@@ -1,6 +0,0 @@
1
- import { MarkdownTranspilerBase } from '../markdown-transpiler-base';
2
- import { LinkingStrategy } from '../../processor-type-transpiler';
3
- export default class DocsifyDocsProcessor extends MarkdownTranspilerBase {
4
- homeFileName(): string;
5
- getLinkingStrategy(): LinkingStrategy;
6
- }
@@ -1,13 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const markdown_transpiler_base_1 = require("../markdown-transpiler-base");
4
- class DocsifyDocsProcessor extends markdown_transpiler_base_1.MarkdownTranspilerBase {
5
- homeFileName() {
6
- return 'README';
7
- }
8
- getLinkingStrategy() {
9
- return 'root-relative';
10
- }
11
- }
12
- exports.default = DocsifyDocsProcessor;
13
- //# sourceMappingURL=docsify-docs-processor.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"docsify-docs-processor.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/docsify/docsify-docs-processor.ts"],"names":[],"mappings":";;AAAA,0EAAqE;AAGrE,MAAqB,oBAAqB,SAAQ,iDAAsB;IACtE,YAAY;QACV,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,kBAAkB;QAChB,OAAO,eAAe,CAAC;IACzB,CAAC;CACF;AARD,uCAQC"}
@@ -1,11 +0,0 @@
1
- import { MarkdownTranspilerBase } from '../markdown-transpiler-base';
2
- import { Type } from '@cparra/apex-reflection';
3
- import { LinkingStrategy } from '../../processor-type-transpiler';
4
- export declare class JekyllDocsProcessor extends MarkdownTranspilerBase {
5
- homeFileName(): string;
6
- onBeforeProcess: (types: Type[]) => void;
7
- onProcess(type: Type): void;
8
- get frontMatterForHomeFile(): string;
9
- getFrontMatterHeader(type: Type): string;
10
- getLinkingStrategy(): LinkingStrategy;
11
- }
@@ -1,51 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.JekyllDocsProcessor = void 0;
4
- const markdown_transpiler_base_1 = require("../markdown-transpiler-base");
5
- const markdown_home_file_1 = require("../../../model/markdown-home-file");
6
- const markdown_type_file_1 = require("../../../model/markdown-type-file");
7
- const settings_1 = require("../../../settings");
8
- class JekyllDocsProcessor extends markdown_transpiler_base_1.MarkdownTranspilerBase {
9
- constructor() {
10
- super(...arguments);
11
- this.onBeforeProcess = (types) => {
12
- this._fileContainer.pushFile(new markdown_home_file_1.MarkdownHomeFile(this.homeFileName(), types, this.frontMatterForHomeFile));
13
- };
14
- }
15
- homeFileName() {
16
- return 'index';
17
- }
18
- onProcess(type) {
19
- this._fileContainer.pushFile(new markdown_type_file_1.MarkdownTypeFile(type, 1, this.getFrontMatterHeader(type)));
20
- }
21
- get frontMatterForHomeFile() {
22
- return '---\nlayout: default\n---';
23
- }
24
- getFrontMatterHeader(type) {
25
- var _a;
26
- const headerLines = ['---'];
27
- // "layout: default" is a required front matter header for Jekyll
28
- headerLines.push('layout: default');
29
- // Add any additional front matter headers that might have been configured in the settings
30
- const targetType = {
31
- name: type.name,
32
- typeName: type.type_name,
33
- accessModifier: type.access_modifier,
34
- group: type.group,
35
- description: (_a = type.docComment) === null || _a === void 0 ? void 0 : _a.description,
36
- };
37
- const configuredHeaders = settings_1.Settings.getInstance().frontMatterHeader(targetType);
38
- if (configuredHeaders) {
39
- configuredHeaders.forEach((header) => {
40
- headerLines.push(header);
41
- });
42
- }
43
- headerLines.push('---');
44
- return headerLines.join('\n');
45
- }
46
- getLinkingStrategy() {
47
- return 'path-relative';
48
- }
49
- }
50
- exports.JekyllDocsProcessor = JekyllDocsProcessor;
51
- //# sourceMappingURL=jekyll-docsProcessor.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"jekyll-docsProcessor.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/jekyll/jekyll-docsProcessor.ts"],"names":[],"mappings":";;;AAAA,0EAAqE;AAErE,0EAAqE;AACrE,0EAAqE;AAErE,gDAA6C;AAE7C,MAAa,mBAAoB,SAAQ,iDAAsB;IAA/D;;QAKE,oBAAe,GAAG,CAAC,KAAa,EAAE,EAAE;YAClC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,qCAAgB,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC;QAC9G,CAAC,CAAC;IAmCJ,CAAC;IAzCC,YAAY;QACV,OAAO,OAAO,CAAC;IACjB,CAAC;IAMD,SAAS,CAAC,IAAU;QAClB,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,qCAAgB,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC/F,CAAC;IAED,IAAI,sBAAsB;QACxB,OAAO,2BAA2B,CAAC;IACrC,CAAC;IAED,oBAAoB,CAAC,IAAU;;QAC7B,MAAM,WAAW,GAAG,CAAC,KAAK,CAAC,CAAC;QAC5B,iEAAiE;QACjE,WAAW,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QACpC,0FAA0F;QAC1F,MAAM,UAAU,GAAG;YACjB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,QAAQ,EAAE,IAAI,CAAC,SAAS;YACxB,cAAc,EAAE,IAAI,CAAC,eAAe;YACpC,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,WAAW,EAAE,MAAA,IAAI,CAAC,UAAU,0CAAE,WAAW;SAC1C,CAAC;QACF,MAAM,iBAAiB,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;QAC/E,IAAI,iBAAiB,EAAE,CAAC;YACtB,iBAAiB,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;gBACnC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC3B,CAAC,CAAC,CAAC;QACL,CAAC;QACD,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAED,kBAAkB;QAChB,OAAO,eAAe,CAAC;IACzB,CAAC;CACF;AA1CD,kDA0CC"}
@@ -1,11 +0,0 @@
1
- import ProcessorTypeTranspiler from '../processor-type-transpiler';
2
- import { Type } from '@cparra/apex-reflection';
3
- import { FileContainer } from '../file-container';
4
- export declare abstract class MarkdownTranspilerBase extends ProcessorTypeTranspiler {
5
- protected readonly _fileContainer: FileContainer;
6
- constructor();
7
- abstract homeFileName(): string;
8
- fileBuilder(): FileContainer;
9
- onBeforeProcess: (types: Type[]) => void;
10
- onProcess(type: Type): void;
11
- }
@@ -1,27 +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.MarkdownTranspilerBase = void 0;
7
- const processor_type_transpiler_1 = __importDefault(require("../processor-type-transpiler"));
8
- const file_container_1 = require("../file-container");
9
- const markdown_home_file_1 = require("../../model/markdown-home-file");
10
- const markdown_type_file_1 = require("../../model/markdown-type-file");
11
- class MarkdownTranspilerBase extends processor_type_transpiler_1.default {
12
- constructor() {
13
- super();
14
- this.onBeforeProcess = (types) => {
15
- this._fileContainer.pushFile(new markdown_home_file_1.MarkdownHomeFile(this.homeFileName(), types));
16
- };
17
- this._fileContainer = new file_container_1.FileContainer();
18
- }
19
- fileBuilder() {
20
- return this._fileContainer;
21
- }
22
- onProcess(type) {
23
- this._fileContainer.pushFile(new markdown_type_file_1.MarkdownTypeFile(type));
24
- }
25
- }
26
- exports.MarkdownTranspilerBase = MarkdownTranspilerBase;
27
- //# sourceMappingURL=markdown-transpiler-base.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"markdown-transpiler-base.js","sourceRoot":"","sources":["../../../src/transpiler/markdown/markdown-transpiler-base.ts"],"names":[],"mappings":";;;;;;AAAA,6FAAmE;AAEnE,sDAAkD;AAClD,uEAAkE;AAClE,uEAAkE;AAElE,MAAsB,sBAAuB,SAAQ,mCAAuB;IAG1E;QACE,KAAK,EAAE,CAAC;QAUV,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;QAXA,IAAI,CAAC,cAAc,GAAG,IAAI,8BAAa,EAAE,CAAC;IAC5C,CAAC;IAID,WAAW;QACT,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAMD,SAAS,CAAC,IAAU;QAClB,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,qCAAgB,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3D,CAAC;CACF;AArBD,wDAqBC"}
@@ -1 +0,0 @@
1
- export declare const classMarkdownTemplate: string;