@cparra/apexdocs 2.24.0 → 2.25.0-alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (375) hide show
  1. package/.github/workflows/ci.yaml +22 -0
  2. package/.github/workflows/close_stale.yml +22 -22
  3. package/.prettierrc.js +7 -7
  4. package/LICENSE +21 -21
  5. package/README.md +742 -718
  6. package/__mocks__/chalk.js +12 -0
  7. package/__mocks__/log-update.js +6 -0
  8. package/apexdocs.config.ts +13 -13
  9. package/docs/{README.md → __old/README.md} +1 -1
  10. package/docs/{restapi.json → __old/restapi.json} +589 -589
  11. package/docs/{types → __old/types}/Classes/nspc.ChildClass.md +97 -97
  12. package/docs/{types → __old/types}/Main/nspc.SampleClass.md +189 -189
  13. package/eslint.config.mjs +10 -0
  14. package/examples/force-app/main/default/classes/AnotherInterface.cls +16 -16
  15. package/examples/force-app/main/default/classes/ChildClass.cls +42 -42
  16. package/examples/force-app/main/default/classes/EscapedAnnotations.cls +5 -5
  17. package/examples/force-app/main/default/classes/GrandparentClass.cls +4 -4
  18. package/examples/force-app/main/default/classes/GroupedClass.cls +8 -8
  19. package/examples/force-app/main/default/classes/MemberGrouping.cls +17 -17
  20. package/examples/force-app/main/default/classes/ParentClass.cls +16 -16
  21. package/examples/force-app/main/default/classes/SampleClass.cls +166 -166
  22. package/examples/force-app/main/default/classes/SampleClass.cls-meta.xml +5 -5
  23. package/examples/force-app/main/default/classes/SampleClassWithoutModifier.cls +9 -9
  24. package/examples/force-app/main/default/classes/SampleInterface.cls +16 -16
  25. package/examples/force-app/main/default/restapi/SampleRestResource.cls +195 -195
  26. package/examples/force-app/main/default/restapi/SampleRestResourceToSkip.cls +35 -35
  27. package/examples/force-app/main/default/restapi/SampleRestResourceWithInnerClass.cls +24 -24
  28. package/examples/force-app/main/default/restapi/SampleRestResourceWithoutApexDocs.cls +15 -15
  29. package/examples/force-app/main/default/restapi/references/Reference1.cls +9 -9
  30. package/examples/force-app/main/default/restapi/references/Reference2.cls +9 -9
  31. package/examples/force-app/main/default/restapi/references/Reference3.cls +3 -3
  32. package/examples/force-app/main/default/restapi/references/Reference4.cls +3 -3
  33. package/examples/force-app/main/default/restapi/references/Reference5.cls +3 -3
  34. package/examples/force-app/main/default/restapi/references/Reference6.cls +6 -6
  35. package/examples/force-app/main/default/restapi/references/Reference7.cls +3 -3
  36. package/examples/includes/header.md +3 -3
  37. package/examples/plain-markdown/.forceignore +12 -0
  38. package/examples/plain-markdown/config/project-scratch-def.json +5 -0
  39. package/examples/plain-markdown/docs/Miscellaneous/ns.BaseClass.md +16 -0
  40. package/examples/plain-markdown/docs/Miscellaneous/ns.ParentInterface.md +15 -0
  41. package/examples/plain-markdown/docs/Miscellaneous/ns.ReferencedEnum.md +8 -0
  42. package/examples/plain-markdown/docs/Miscellaneous/ns.SampleException.md +7 -0
  43. package/examples/plain-markdown/docs/Miscellaneous/ns.SampleInterface.md +115 -0
  44. package/examples/plain-markdown/docs/Sample-Enums/ns.SampleEnum.md +36 -0
  45. package/examples/plain-markdown/docs/SampleGroup/ns.SampleClass.md +173 -0
  46. package/examples/plain-markdown/docs/index.md +36 -0
  47. package/examples/plain-markdown/force-app/classes/BaseClass.cls +3 -0
  48. package/examples/plain-markdown/force-app/classes/ParentInterface.cls +3 -0
  49. package/examples/plain-markdown/force-app/classes/ReferencedEnum.cls +3 -0
  50. package/examples/plain-markdown/force-app/classes/SampleClass.cls +72 -0
  51. package/examples/plain-markdown/force-app/classes/SampleEnum.cls +30 -0
  52. package/examples/plain-markdown/force-app/classes/SampleException.cls +1 -0
  53. package/examples/plain-markdown/force-app/classes/SampleInterface.cls +46 -0
  54. package/examples/plain-markdown/package-lock.json +665 -0
  55. package/examples/plain-markdown/package.json +20 -0
  56. package/examples/plain-markdown/sfdx-project.json +12 -0
  57. package/examples/plain-markdown/template.md +3 -0
  58. package/jest.config.js +9 -5
  59. package/jest.d.ts +7 -0
  60. package/lib/__spec__/core/expect-extensions.d.ts +3 -0
  61. package/lib/__spec__/core/expect-extensions.js +54 -0
  62. package/lib/__spec__/core/expect-extensions.js.map +1 -0
  63. package/lib/__spec__/core/generating-class-docs.spec.d.ts +1 -0
  64. package/lib/__spec__/core/generating-class-docs.spec.js +427 -0
  65. package/lib/__spec__/core/generating-class-docs.spec.js.map +1 -0
  66. package/lib/__spec__/core/generating-enum-docs.spec.d.ts +1 -0
  67. package/lib/__spec__/core/generating-enum-docs.spec.js +303 -0
  68. package/lib/__spec__/core/generating-enum-docs.spec.js.map +1 -0
  69. package/lib/__spec__/core/generating-interface-docs.spec.d.ts +1 -0
  70. package/lib/__spec__/core/generating-interface-docs.spec.js +361 -0
  71. package/lib/__spec__/core/generating-interface-docs.spec.js.map +1 -0
  72. package/lib/__spec__/core/generating-reference-guide.spec.d.ts +1 -0
  73. package/lib/__spec__/core/generating-reference-guide.spec.js +161 -0
  74. package/lib/__spec__/core/generating-reference-guide.spec.js.map +1 -0
  75. package/lib/adapters/apex-types.d.ts +7 -0
  76. package/lib/adapters/apex-types.js +112 -0
  77. package/lib/adapters/apex-types.js.map +1 -0
  78. package/lib/adapters/documentables.d.ts +7 -0
  79. package/lib/adapters/documentables.js +56 -0
  80. package/lib/adapters/documentables.js.map +1 -0
  81. package/lib/adapters/fields-and-properties.d.ts +4 -0
  82. package/lib/adapters/fields-and-properties.js +32 -0
  83. package/lib/adapters/fields-and-properties.js.map +1 -0
  84. package/lib/adapters/methods-and-constructors.d.ts +5 -0
  85. package/lib/adapters/methods-and-constructors.js +92 -0
  86. package/lib/adapters/methods-and-constructors.js.map +1 -0
  87. package/lib/adapters/references.d.ts +5 -0
  88. package/lib/adapters/references.js +82 -0
  89. package/lib/adapters/references.js.map +1 -0
  90. package/lib/adapters/type-utils.d.ts +2 -0
  91. package/lib/adapters/type-utils.js +7 -0
  92. package/lib/adapters/type-utils.js.map +1 -0
  93. package/lib/application/Apexdocs.d.ts +13 -13
  94. package/lib/application/Apexdocs.js +79 -76
  95. package/lib/application/Apexdocs.js.map +1 -1
  96. package/lib/cli/generate.d.ts +2 -2
  97. package/lib/cli/generate.js +156 -130
  98. package/lib/cli/generate.js.map +1 -1
  99. package/lib/core/generate-docs.d.ts +23 -0
  100. package/lib/core/generate-docs.js +241 -0
  101. package/lib/core/generate-docs.js.map +1 -0
  102. package/lib/core/template.d.ts +10 -0
  103. package/lib/core/template.js +92 -0
  104. package/lib/core/template.js.map +1 -0
  105. package/lib/core/templates/reference-guide.d.ts +1 -0
  106. package/lib/core/templates/reference-guide.js +18 -0
  107. package/lib/core/templates/reference-guide.js.map +1 -0
  108. package/lib/index.d.ts +2 -1
  109. package/lib/index.js +28 -17
  110. package/lib/index.js.map +1 -1
  111. package/lib/model/apex-bundle.d.ts +6 -6
  112. package/lib/model/apex-bundle.js +10 -10
  113. package/lib/model/apex-type-wrappers/ClassMirrorWrapper.d.ts +7 -7
  114. package/lib/model/apex-type-wrappers/ClassMirrorWrapper.js +13 -13
  115. package/lib/model/apex-type-wrappers/MethodMirrorWrapper.d.ts +7 -7
  116. package/lib/model/apex-type-wrappers/MethodMirrorWrapper.js +11 -11
  117. package/lib/model/inheritance.d.ts +8 -8
  118. package/lib/model/inheritance.js +2 -2
  119. package/lib/model/manifest.d.ts +22 -22
  120. package/lib/model/manifest.js +52 -46
  121. package/lib/model/manifest.js.map +1 -1
  122. package/lib/model/markdown-file.d.ts +16 -16
  123. package/lib/model/markdown-file.js +110 -106
  124. package/lib/model/markdown-file.js.map +1 -1
  125. package/lib/model/markdown-generation-util/doc-comment-annotation-util.d.ts +8 -8
  126. package/lib/model/markdown-generation-util/doc-comment-annotation-util.js +45 -43
  127. package/lib/model/markdown-generation-util/doc-comment-annotation-util.js.map +1 -1
  128. package/lib/model/markdown-generation-util/field-declaration-util.d.ts +3 -3
  129. package/lib/model/markdown-generation-util/field-declaration-util.js +53 -54
  130. package/lib/model/markdown-generation-util/field-declaration-util.js.map +1 -1
  131. package/lib/model/markdown-generation-util/index.d.ts +3 -3
  132. package/lib/model/markdown-generation-util/index.js +19 -19
  133. package/lib/model/markdown-generation-util/method-declaration-util.d.ts +4 -4
  134. package/lib/model/markdown-generation-util/method-declaration-util.js +113 -114
  135. package/lib/model/markdown-generation-util/method-declaration-util.js.map +1 -1
  136. package/lib/model/markdown-generation-util/type-declaration-util.d.ts +3 -3
  137. package/lib/model/markdown-generation-util/type-declaration-util.js +80 -81
  138. package/lib/model/markdown-generation-util/type-declaration-util.js.map +1 -1
  139. package/lib/model/markdown-home-file.d.ts +11 -11
  140. package/lib/model/markdown-home-file.js +56 -53
  141. package/lib/model/markdown-home-file.js.map +1 -1
  142. package/lib/model/markdown-type-file.d.ts +26 -26
  143. package/lib/model/markdown-type-file.js +136 -133
  144. package/lib/model/markdown-type-file.js.map +1 -1
  145. package/lib/model/openapi/apex-doc-types.d.ts +19 -19
  146. package/lib/model/openapi/apex-doc-types.js +4 -4
  147. package/lib/model/openapi/open-api-types.d.ts +93 -93
  148. package/lib/model/openapi/open-api-types.js +2 -2
  149. package/lib/model/openapi/open-api.d.ts +16 -16
  150. package/lib/model/openapi/open-api.js +33 -33
  151. package/lib/model/openapi/open-api.js.map +1 -1
  152. package/lib/model/openapi/openapi-type-file.d.ts +7 -7
  153. package/lib/model/openapi/openapi-type-file.js +16 -16
  154. package/lib/model/outputFile.d.ts +10 -10
  155. package/lib/model/outputFile.js +21 -28
  156. package/lib/model/outputFile.js.map +1 -1
  157. package/lib/model/types-repository.d.ts +16 -16
  158. package/lib/model/types-repository.js +53 -53
  159. package/lib/model/types-repository.js.map +1 -1
  160. package/lib/service/apex-file-reader.d.ts +14 -14
  161. package/lib/service/apex-file-reader.js +48 -45
  162. package/lib/service/apex-file-reader.js.map +1 -1
  163. package/lib/service/file-system.d.ts +14 -14
  164. package/lib/service/file-system.js +47 -24
  165. package/lib/service/file-system.js.map +1 -1
  166. package/lib/service/file-writer.d.ts +6 -6
  167. package/lib/service/file-writer.js +56 -33
  168. package/lib/service/file-writer.js.map +1 -1
  169. package/lib/service/manifest-factory.d.ts +10 -10
  170. package/lib/service/manifest-factory.js +15 -13
  171. package/lib/service/manifest-factory.js.map +1 -1
  172. package/lib/service/metadata-processor.d.ts +3 -3
  173. package/lib/service/metadata-processor.js +16 -16
  174. package/lib/service/metadata-processor.js.map +1 -1
  175. package/lib/service/parser.d.ts +21 -21
  176. package/lib/service/parser.js +137 -134
  177. package/lib/service/parser.js.map +1 -1
  178. package/lib/service/state.d.ts +9 -9
  179. package/lib/service/state.js +19 -19
  180. package/lib/service/state.js.map +1 -1
  181. package/lib/service/walkers/class-walker.d.ts +4 -4
  182. package/lib/service/walkers/class-walker.js +32 -32
  183. package/lib/service/walkers/class-walker.js.map +1 -1
  184. package/lib/service/walkers/enum-walker.d.ts +4 -4
  185. package/lib/service/walkers/enum-walker.js +10 -10
  186. package/lib/service/walkers/interface-walker.d.ts +4 -4
  187. package/lib/service/walkers/interface-walker.js +14 -14
  188. package/lib/service/walkers/interface-walker.js.map +1 -1
  189. package/lib/service/walkers/walker-factory.d.ts +5 -5
  190. package/lib/service/walkers/walker-factory.js +20 -20
  191. package/lib/service/walkers/walker-factory.js.map +1 -1
  192. package/lib/service/walkers/walker.d.ts +19 -19
  193. package/lib/service/walkers/walker.js +16 -16
  194. package/lib/service/walkers/walker.js.map +1 -1
  195. package/lib/settings.d.ts +64 -64
  196. package/lib/settings.js +88 -88
  197. package/lib/settings.js.map +1 -1
  198. package/lib/test-helpers/AnnotationBuilder.d.ts +12 -12
  199. package/lib/test-helpers/AnnotationBuilder.js +30 -30
  200. package/lib/test-helpers/ClassMirrorBuilder.d.ts +18 -18
  201. package/lib/test-helpers/ClassMirrorBuilder.js +53 -53
  202. package/lib/test-helpers/DocCommentAnnotationBuilder.d.ts +8 -8
  203. package/lib/test-helpers/DocCommentAnnotationBuilder.js +25 -25
  204. package/lib/test-helpers/DocCommentBuilder.d.ts +12 -12
  205. package/lib/test-helpers/DocCommentBuilder.js +37 -37
  206. package/lib/test-helpers/FieldMirrorBuilder.d.ts +18 -18
  207. package/lib/test-helpers/FieldMirrorBuilder.js +53 -53
  208. package/lib/test-helpers/InterfaceMirrorBuilder.d.ts +16 -0
  209. package/lib/test-helpers/InterfaceMirrorBuilder.js +43 -0
  210. package/lib/test-helpers/InterfaceMirrorBuilder.js.map +1 -0
  211. package/lib/test-helpers/MethodMirrorBuilder.d.ts +29 -10
  212. package/lib/test-helpers/MethodMirrorBuilder.js +71 -36
  213. package/lib/test-helpers/MethodMirrorBuilder.js.map +1 -1
  214. package/lib/test-helpers/SettingsBuilder.d.ts +8 -8
  215. package/lib/test-helpers/SettingsBuilder.js +26 -26
  216. package/lib/transpiler/factory.d.ts +6 -6
  217. package/lib/transpiler/factory.js +34 -31
  218. package/lib/transpiler/factory.js.map +1 -1
  219. package/lib/transpiler/file-container.d.ts +6 -6
  220. package/lib/transpiler/file-container.js +15 -15
  221. package/lib/transpiler/generator-choices.d.ts +1 -1
  222. package/lib/transpiler/generator-choices.js +2 -2
  223. package/lib/transpiler/markdown/class-file-generatorHelper.d.ts +11 -8
  224. package/lib/transpiler/markdown/class-file-generatorHelper.js +74 -55
  225. package/lib/transpiler/markdown/class-file-generatorHelper.js.map +1 -1
  226. package/lib/transpiler/markdown/docsify/docsify-docs-processor.d.ts +6 -6
  227. package/lib/transpiler/markdown/docsify/docsify-docs-processor.js +12 -12
  228. package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.d.ts +11 -11
  229. package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.js +50 -50
  230. package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.js.map +1 -1
  231. package/lib/transpiler/markdown/markdown-transpiler-base.d.ts +11 -11
  232. package/lib/transpiler/markdown/markdown-transpiler-base.js +26 -23
  233. package/lib/transpiler/markdown/markdown-transpiler-base.js.map +1 -1
  234. package/lib/transpiler/markdown/plain-markdown/class-template.d.ts +1 -0
  235. package/lib/transpiler/markdown/plain-markdown/class-template.js +77 -0
  236. package/lib/transpiler/markdown/plain-markdown/class-template.js.map +1 -0
  237. package/lib/transpiler/markdown/plain-markdown/constructors-partial-template.d.ts +1 -0
  238. package/lib/transpiler/markdown/plain-markdown/constructors-partial-template.js +36 -0
  239. package/lib/transpiler/markdown/plain-markdown/constructors-partial-template.js.map +1 -0
  240. package/lib/transpiler/markdown/plain-markdown/documentable-partial-template.d.ts +1 -0
  241. package/lib/transpiler/markdown/plain-markdown/documentable-partial-template.js +28 -0
  242. package/lib/transpiler/markdown/plain-markdown/documentable-partial-template.js.map +1 -0
  243. package/lib/transpiler/markdown/plain-markdown/enum-template.d.ts +1 -0
  244. package/lib/transpiler/markdown/plain-markdown/enum-template.js +16 -0
  245. package/lib/transpiler/markdown/plain-markdown/enum-template.js.map +1 -0
  246. package/lib/transpiler/markdown/plain-markdown/fieldsPartialTemplate.d.ts +1 -0
  247. package/lib/transpiler/markdown/plain-markdown/fieldsPartialTemplate.js +27 -0
  248. package/lib/transpiler/markdown/plain-markdown/fieldsPartialTemplate.js.map +1 -0
  249. package/lib/transpiler/markdown/plain-markdown/grouped-members-partial-template.d.ts +1 -0
  250. package/lib/transpiler/markdown/plain-markdown/grouped-members-partial-template.js +10 -0
  251. package/lib/transpiler/markdown/plain-markdown/grouped-members-partial-template.js.map +1 -0
  252. package/lib/transpiler/markdown/plain-markdown/interface-template.d.ts +1 -0
  253. package/lib/transpiler/markdown/plain-markdown/interface-template.js +20 -0
  254. package/lib/transpiler/markdown/plain-markdown/interface-template.js.map +1 -0
  255. package/lib/transpiler/markdown/plain-markdown/methods-partial-template.d.ts +1 -0
  256. package/lib/transpiler/markdown/plain-markdown/methods-partial-template.js +47 -0
  257. package/lib/transpiler/markdown/plain-markdown/methods-partial-template.js.map +1 -0
  258. package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.d.ts +9 -6
  259. package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.js +41 -13
  260. package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.js.map +1 -1
  261. package/lib/transpiler/markdown/plain-markdown/type-doc-partial.d.ts +1 -0
  262. package/lib/transpiler/markdown/plain-markdown/type-doc-partial.js +31 -0
  263. package/lib/transpiler/markdown/plain-markdown/type-doc-partial.js.map +1 -0
  264. package/lib/transpiler/openapi/open-api-docs-processor.d.ts +13 -13
  265. package/lib/transpiler/openapi/open-api-docs-processor.js +77 -74
  266. package/lib/transpiler/openapi/open-api-docs-processor.js.map +1 -1
  267. package/lib/transpiler/openapi/parsers/Builder.d.ts +16 -16
  268. package/lib/transpiler/openapi/parsers/Builder.js +29 -29
  269. package/lib/transpiler/openapi/parsers/Builder.js.map +1 -1
  270. package/lib/transpiler/openapi/parsers/MethodParser.d.ts +20 -20
  271. package/lib/transpiler/openapi/parsers/MethodParser.js +189 -166
  272. package/lib/transpiler/openapi/parsers/MethodParser.js.map +1 -1
  273. package/lib/transpiler/openapi/parsers/ParameterObjectBuilder.d.ts +7 -7
  274. package/lib/transpiler/openapi/parsers/ParameterObjectBuilder.js +10 -10
  275. package/lib/transpiler/openapi/parsers/ReferenceBuilder.d.ts +39 -39
  276. package/lib/transpiler/openapi/parsers/ReferenceBuilder.js +249 -225
  277. package/lib/transpiler/openapi/parsers/ReferenceBuilder.js.map +1 -1
  278. package/lib/transpiler/openapi/parsers/RequestBodyBuilder.d.ts +10 -10
  279. package/lib/transpiler/openapi/parsers/RequestBodyBuilder.js +19 -19
  280. package/lib/transpiler/openapi/parsers/ResponsesBuilder.d.ts +7 -7
  281. package/lib/transpiler/openapi/parsers/ResponsesBuilder.js +21 -21
  282. package/lib/transpiler/openapi/parsers/ResponsesBuilder.js.map +1 -1
  283. package/lib/transpiler/processor-type-transpiler.d.ts +10 -10
  284. package/lib/transpiler/processor-type-transpiler.js +8 -8
  285. package/lib/transpiler/transpiler.d.ts +5 -5
  286. package/lib/transpiler/transpiler.js +29 -26
  287. package/lib/transpiler/transpiler.js.map +1 -1
  288. package/lib/util/error-logger.d.ts +8 -8
  289. package/lib/util/error-logger.js +89 -89
  290. package/lib/util/error-logger.js.map +1 -1
  291. package/lib/util/logger.d.ts +21 -21
  292. package/lib/util/logger.js +60 -57
  293. package/lib/util/logger.js.map +1 -1
  294. package/lib/util/string-utils.d.ts +2 -2
  295. package/lib/util/string-utils.js +14 -14
  296. package/lib/util/string-utils.js.map +1 -1
  297. package/package.json +79 -78
  298. package/src/__spec__/core/expect-extensions.ts +32 -0
  299. package/src/__spec__/core/generating-class-docs.spec.ts +511 -0
  300. package/src/__spec__/core/generating-enum-docs.spec.ts +355 -0
  301. package/src/__spec__/core/generating-interface-docs.spec.ts +431 -0
  302. package/src/__spec__/core/generating-reference-guide.spec.ts +163 -0
  303. package/src/adapters/__tests__/interface-adapter.spec.ts +80 -0
  304. package/src/adapters/__tests__/references.spec.ts +115 -0
  305. package/src/adapters/apex-types.ts +224 -0
  306. package/src/adapters/documentables.ts +93 -0
  307. package/src/adapters/fields-and-properties.ts +38 -0
  308. package/src/adapters/methods-and-constructors.ts +117 -0
  309. package/src/adapters/references.ts +113 -0
  310. package/src/adapters/type-utils.ts +5 -0
  311. package/src/adapters/types.d.ts +8 -0
  312. package/src/cli/generate.ts +96 -93
  313. package/src/core/generate-docs.ts +357 -0
  314. package/src/core/renderable/types.d.ts +131 -0
  315. package/src/core/template.ts +108 -0
  316. package/src/core/templates/reference-guide.ts +14 -0
  317. package/src/index.ts +3 -1
  318. package/src/model/__tests__/manifest.spec.ts +1 -0
  319. package/src/model/manifest.ts +15 -5
  320. package/src/model/markdown-file.ts +6 -5
  321. package/src/model/markdown-generation-util/doc-comment-annotation-util.ts +1 -1
  322. package/src/model/markdown-generation-util/method-declaration-util.ts +1 -1
  323. package/src/model/openapi/open-api-types.ts +2 -2
  324. package/src/model/outputFile.ts +2 -11
  325. package/src/service/__tests__/apex-file-reader.spec.ts +4 -4
  326. package/src/service/__tests__/manifest-factory.spec.ts +1 -2
  327. package/src/service/parser.ts +1 -1
  328. package/src/test-helpers/FieldMirrorBuilder.ts +1 -1
  329. package/src/test-helpers/InterfaceMirrorBuilder.ts +44 -0
  330. package/src/test-helpers/MethodMirrorBuilder.ts +46 -6
  331. package/src/transpiler/markdown/class-file-generatorHelper.ts +22 -2
  332. package/src/transpiler/markdown/plain-markdown/class-template.ts +73 -0
  333. package/src/transpiler/markdown/plain-markdown/constructors-partial-template.ts +32 -0
  334. package/src/transpiler/markdown/plain-markdown/documentable-partial-template.ts +24 -0
  335. package/src/transpiler/markdown/plain-markdown/enum-template.ts +12 -0
  336. package/src/transpiler/markdown/plain-markdown/fieldsPartialTemplate.ts +23 -0
  337. package/src/transpiler/markdown/plain-markdown/grouped-members-partial-template.ts +6 -0
  338. package/src/transpiler/markdown/plain-markdown/interface-template.ts +16 -0
  339. package/src/transpiler/markdown/plain-markdown/methods-partial-template.ts +43 -0
  340. package/src/transpiler/markdown/plain-markdown/plain-docsProcessor.ts +30 -0
  341. package/src/transpiler/markdown/plain-markdown/type-doc-partial.ts +27 -0
  342. package/src/transpiler/openapi/parsers/Builder.ts +1 -1
  343. package/src/transpiler/openapi/parsers/MethodParser.ts +1 -1
  344. package/src/transpiler/openapi/parsers/ReferenceBuilder.ts +4 -3
  345. package/src/util/error-logger.ts +4 -4
  346. package/src/util/logger.ts +3 -3
  347. package/tsconfig.json +21 -20
  348. package/tslint.json +5 -5
  349. package/.eslintrc.js +0 -12
  350. package/lib/model/manifest-diff.d.ts +0 -27
  351. package/lib/model/manifest-diff.js +0 -69
  352. package/lib/model/manifest-diff.js.map +0 -1
  353. package/src/model/__tests__/manifest-diff.spec.ts +0 -139
  354. package/src/model/manifest-diff.ts +0 -94
  355. /package/docs/{index.html → __old/index.html} +0 -0
  356. /package/docs/{types → __old/types}/Classes/nspc.AnotherInterface.md +0 -0
  357. /package/docs/{types → __old/types}/Main/nspc.GroupedClass.md +0 -0
  358. /package/docs/{types → __old/types}/Misc-Group/nspc.EscapedAnnotations.md +0 -0
  359. /package/docs/{types → __old/types}/Misc-Group/nspc.GrandparentClass.md +0 -0
  360. /package/docs/{types → __old/types}/Misc-Group/nspc.InterfaceWithInheritance.md +0 -0
  361. /package/docs/{types → __old/types}/Misc-Group/nspc.MemberGrouping.md +0 -0
  362. /package/docs/{types → __old/types}/Misc-Group/nspc.ParentClass.md +0 -0
  363. /package/docs/{types → __old/types}/Misc-Group/nspc.Reference1.md +0 -0
  364. /package/docs/{types → __old/types}/Misc-Group/nspc.Reference2.md +0 -0
  365. /package/docs/{types → __old/types}/Misc-Group/nspc.Reference3.md +0 -0
  366. /package/docs/{types → __old/types}/Misc-Group/nspc.Reference4.md +0 -0
  367. /package/docs/{types → __old/types}/Misc-Group/nspc.Reference5.md +0 -0
  368. /package/docs/{types → __old/types}/Misc-Group/nspc.Reference6.md +0 -0
  369. /package/docs/{types → __old/types}/Misc-Group/nspc.Reference7.md +0 -0
  370. /package/docs/{types → __old/types}/Misc-Group/nspc.SampleClassWithoutModifier.md +0 -0
  371. /package/docs/{types → __old/types}/Misc-Group/nspc.SampleRestResource.md +0 -0
  372. /package/docs/{types → __old/types}/Misc-Group/nspc.SampleRestResourceWithInnerClass.md +0 -0
  373. /package/docs/{types → __old/types}/Misc-Group/nspc.SampleRestResourceWithoutApexDocs.md +0 -0
  374. /package/docs/{types → __old/types}/README.md +0 -0
  375. /package/docs/{types → __old/types}/Sample-Interfaces/nspc.SampleInterface.md +0 -0
@@ -1,93 +1,93 @@
1
- export type InfoObject = {
2
- title: string;
3
- version: string;
4
- };
5
- export type ServerObject = {
6
- url: string;
7
- };
8
- export type PathsObject = {
9
- [index: string]: PathItemObject;
10
- };
11
- export type PathItemObject = {
12
- description?: string;
13
- get?: OperationObject;
14
- put?: OperationObject;
15
- post?: OperationObject;
16
- delete?: OperationObject;
17
- patch?: OperationObject;
18
- };
19
- export type OperationObject = {
20
- tags?: string[];
21
- description?: string;
22
- summary?: string;
23
- requestBody?: RequestBody;
24
- parameters?: ParameterObject[];
25
- responses?: ResponsesObject;
26
- };
27
- export type ParameterObject = {
28
- name: string;
29
- in: 'query' | 'header' | 'path' | 'cookie';
30
- description?: string;
31
- required?: boolean;
32
- schema?: SchemaObject;
33
- };
34
- export type RequestBody = {
35
- description?: string;
36
- content: RequestBodyContent;
37
- required?: boolean;
38
- };
39
- export type RequestBodyContent = {
40
- [index: string]: MediaTypeObject;
41
- };
42
- export type MediaTypeObject = {
43
- schema?: SchemaObject;
44
- example?: any;
45
- examples?: {
46
- [index: string]: ExampleObject;
47
- };
48
- };
49
- export type ExampleObject = {
50
- summary?: string;
51
- description?: string;
52
- value?: any;
53
- };
54
- export type ResponsesObject = {
55
- [index: string]: ResponseObject;
56
- };
57
- export type ResponseObject = {
58
- description: string;
59
- content?: ContentObject;
60
- };
61
- export type ContentObject = {
62
- [index: string]: {
63
- schema: SchemaObject;
64
- };
65
- };
66
- export type SchemaObject = SchemaObjectObject | SchemaObjectArray | ReferenceObject;
67
- export type SchemaObjectObject = {
68
- type: string;
69
- properties?: PropertiesObject;
70
- format?: string;
71
- description?: string;
72
- };
73
- export type PropertiesObject = {
74
- [index: string]: SchemaObject;
75
- };
76
- export type SchemaObjectArray = {
77
- type: 'array';
78
- items: SchemaObject;
79
- description?: string;
80
- };
81
- export type ReferenceObject = {
82
- $ref: string;
83
- description?: string;
84
- };
85
- export type ComponentsObject = {
86
- schemas: {
87
- [index: string]: SchemaObject;
88
- };
89
- };
90
- export type TagObject = {
91
- name: string;
92
- description?: string;
93
- };
1
+ export type InfoObject = {
2
+ title: string;
3
+ version: string;
4
+ };
5
+ export type ServerObject = {
6
+ url: string;
7
+ };
8
+ export type PathsObject = {
9
+ [index: string]: PathItemObject;
10
+ };
11
+ export type PathItemObject = {
12
+ description?: string;
13
+ get?: OperationObject;
14
+ put?: OperationObject;
15
+ post?: OperationObject;
16
+ delete?: OperationObject;
17
+ patch?: OperationObject;
18
+ };
19
+ export type OperationObject = {
20
+ tags?: string[];
21
+ description?: string;
22
+ summary?: string;
23
+ requestBody?: RequestBody;
24
+ parameters?: ParameterObject[];
25
+ responses?: ResponsesObject;
26
+ };
27
+ export type ParameterObject = {
28
+ name: string;
29
+ in: 'query' | 'header' | 'path' | 'cookie';
30
+ description?: string;
31
+ required?: boolean;
32
+ schema?: SchemaObject;
33
+ };
34
+ export type RequestBody = {
35
+ description?: string;
36
+ content: RequestBodyContent;
37
+ required?: boolean;
38
+ };
39
+ export type RequestBodyContent = {
40
+ [index: string]: MediaTypeObject;
41
+ };
42
+ export type MediaTypeObject = {
43
+ schema?: SchemaObject;
44
+ example?: unknown;
45
+ examples?: {
46
+ [index: string]: ExampleObject;
47
+ };
48
+ };
49
+ export type ExampleObject = {
50
+ summary?: string;
51
+ description?: string;
52
+ value?: unknown;
53
+ };
54
+ export type ResponsesObject = {
55
+ [index: string]: ResponseObject;
56
+ };
57
+ export type ResponseObject = {
58
+ description: string;
59
+ content?: ContentObject;
60
+ };
61
+ export type ContentObject = {
62
+ [index: string]: {
63
+ schema: SchemaObject;
64
+ };
65
+ };
66
+ export type SchemaObject = SchemaObjectObject | SchemaObjectArray | ReferenceObject;
67
+ export type SchemaObjectObject = {
68
+ type: string;
69
+ properties?: PropertiesObject;
70
+ format?: string;
71
+ description?: string;
72
+ };
73
+ export type PropertiesObject = {
74
+ [index: string]: SchemaObject;
75
+ };
76
+ export type SchemaObjectArray = {
77
+ type: 'array';
78
+ items: SchemaObject;
79
+ description?: string;
80
+ };
81
+ export type ReferenceObject = {
82
+ $ref: string;
83
+ description?: string;
84
+ };
85
+ export type ComponentsObject = {
86
+ schemas: {
87
+ [index: string]: SchemaObject;
88
+ };
89
+ };
90
+ export type TagObject = {
91
+ name: string;
92
+ description?: string;
93
+ };
@@ -1,3 +1,3 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  //# sourceMappingURL=open-api-types.js.map
@@ -1,16 +1,16 @@
1
- import { ComponentsObject, InfoObject, PathsObject, ServerObject, TagObject } from './open-api-types';
2
- /**
3
- * Represents the OpenApi 3.1.0 spec
4
- * https://spec.openapis.org/oas/v3.1.0
5
- */
6
- export declare class OpenApi {
7
- private namespace?;
8
- openapi: string;
9
- info: InfoObject;
10
- tags: TagObject[];
11
- paths: PathsObject;
12
- servers: ServerObject[];
13
- components?: ComponentsObject;
14
- constructor(title: string, version: string, namespace?: string | undefined);
15
- private getServerUrl;
16
- }
1
+ import { ComponentsObject, InfoObject, PathsObject, ServerObject, TagObject } from './open-api-types';
2
+ /**
3
+ * Represents the OpenApi 3.1.0 spec
4
+ * https://spec.openapis.org/oas/v3.1.0
5
+ */
6
+ export declare class OpenApi {
7
+ private namespace?;
8
+ openapi: string;
9
+ info: InfoObject;
10
+ tags: TagObject[];
11
+ paths: PathsObject;
12
+ servers: ServerObject[];
13
+ components?: ComponentsObject;
14
+ constructor(title: string, version: string, namespace?: string | undefined);
15
+ private getServerUrl;
16
+ }
@@ -1,34 +1,34 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.OpenApi = void 0;
4
- const OPEN_API_VERSION = '3.1.0';
5
- const SERVER_URL = '/services/apexrest/';
6
- /**
7
- * Represents the OpenApi 3.1.0 spec
8
- * https://spec.openapis.org/oas/v3.1.0
9
- */
10
- class OpenApi {
11
- constructor(title, version, namespace) {
12
- this.namespace = namespace;
13
- this.openapi = OPEN_API_VERSION;
14
- this.info = {
15
- title: title,
16
- version: version,
17
- };
18
- this.servers = [
19
- {
20
- url: this.getServerUrl(),
21
- },
22
- ];
23
- this.paths = {};
24
- this.tags = [];
25
- }
26
- getServerUrl() {
27
- if (!this.namespace) {
28
- return SERVER_URL;
29
- }
30
- return `${SERVER_URL}${this.namespace}/`;
31
- }
32
- }
33
- exports.OpenApi = OpenApi;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.OpenApi = void 0;
4
+ const OPEN_API_VERSION = '3.1.0';
5
+ const SERVER_URL = '/services/apexrest/';
6
+ /**
7
+ * Represents the OpenApi 3.1.0 spec
8
+ * https://spec.openapis.org/oas/v3.1.0
9
+ */
10
+ class OpenApi {
11
+ constructor(title, version, namespace) {
12
+ this.namespace = namespace;
13
+ this.openapi = OPEN_API_VERSION;
14
+ this.info = {
15
+ title: title,
16
+ version: version,
17
+ };
18
+ this.servers = [
19
+ {
20
+ url: this.getServerUrl(),
21
+ },
22
+ ];
23
+ this.paths = {};
24
+ this.tags = [];
25
+ }
26
+ getServerUrl() {
27
+ if (!this.namespace) {
28
+ return SERVER_URL;
29
+ }
30
+ return `${SERVER_URL}${this.namespace}/`;
31
+ }
32
+ }
33
+ exports.OpenApi = OpenApi;
34
34
  //# sourceMappingURL=open-api.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"open-api.js","sourceRoot":"","sources":["../../../src/model/openapi/open-api.ts"],"names":[],"mappings":";;;AAEA,MAAM,gBAAgB,GAAG,OAAO,CAAC;AACjC,MAAM,UAAU,GAAG,qBAAqB,CAAC;AAEzC;;;GAGG;AACH,MAAa,OAAO;IAQlB,YAAY,KAAa,EAAE,OAAe,EAAU,SAAkB;QAAlB,cAAS,GAAT,SAAS,CAAS;QAPtE,YAAO,GAAG,gBAAgB,CAAC;QAQzB,IAAI,CAAC,IAAI,GAAG;YACV,KAAK,EAAE,KAAK;YACZ,OAAO,EAAE,OAAO;SACjB,CAAC;QAEF,IAAI,CAAC,OAAO,GAAG;YACb;gBACE,GAAG,EAAE,IAAI,CAAC,YAAY,EAAE;aACzB;SACF,CAAC;QAEF,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;QAChB,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC;IACjB,CAAC;IAEO,YAAY;QAClB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACnB,OAAO,UAAU,CAAC;SACnB;QAED,OAAO,GAAG,UAAU,GAAG,IAAI,CAAC,SAAS,GAAG,CAAC;IAC3C,CAAC;CACF;AA/BD,0BA+BC"}
1
+ {"version":3,"file":"open-api.js","sourceRoot":"","sources":["../../../src/model/openapi/open-api.ts"],"names":[],"mappings":";;;AAEA,MAAM,gBAAgB,GAAG,OAAO,CAAC;AACjC,MAAM,UAAU,GAAG,qBAAqB,CAAC;AAEzC;;;GAGG;AACH,MAAa,OAAO;IAQlB,YAAY,KAAa,EAAE,OAAe,EAAU,SAAkB;QAAlB,cAAS,GAAT,SAAS,CAAS;QAPtE,YAAO,GAAG,gBAAgB,CAAC;QAQzB,IAAI,CAAC,IAAI,GAAG;YACV,KAAK,EAAE,KAAK;YACZ,OAAO,EAAE,OAAO;SACjB,CAAC;QAEF,IAAI,CAAC,OAAO,GAAG;YACb;gBACE,GAAG,EAAE,IAAI,CAAC,YAAY,EAAE;aACzB;SACF,CAAC;QAEF,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;QAChB,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC;IACjB,CAAC;IAEO,YAAY;QAClB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpB,OAAO,UAAU,CAAC;QACpB,CAAC;QAED,OAAO,GAAG,UAAU,GAAG,IAAI,CAAC,SAAS,GAAG,CAAC;IAC3C,CAAC;CACF;AA/BD,0BA+BC"}
@@ -1,7 +1,7 @@
1
- import { OutputFile } from '../outputFile';
2
- import { OpenApi } from './open-api';
3
- export declare class OpenapiTypeFile extends OutputFile {
4
- openApiModel: OpenApi;
5
- constructor(openApiModel: OpenApi);
6
- fileExtension(): string;
7
- }
1
+ import { OutputFile } from '../outputFile';
2
+ import { OpenApi } from './open-api';
3
+ export declare class OpenapiTypeFile extends OutputFile {
4
+ openApiModel: OpenApi;
5
+ constructor(openApiModel: OpenApi);
6
+ fileExtension(): string;
7
+ }
@@ -1,17 +1,17 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.OpenapiTypeFile = void 0;
4
- const outputFile_1 = require("../outputFile");
5
- const settings_1 = require("../../settings");
6
- class OpenapiTypeFile extends outputFile_1.OutputFile {
7
- constructor(openApiModel) {
8
- super(settings_1.Settings.getInstance().openApiFileName(), '');
9
- this.openApiModel = openApiModel;
10
- this.addText(JSON.stringify(Object.assign(Object.assign({}, openApiModel), { namespace: undefined }), null, 2));
11
- }
12
- fileExtension() {
13
- return '.json';
14
- }
15
- }
16
- exports.OpenapiTypeFile = OpenapiTypeFile;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.OpenapiTypeFile = void 0;
4
+ const outputFile_1 = require("../outputFile");
5
+ const settings_1 = require("../../settings");
6
+ class OpenapiTypeFile extends outputFile_1.OutputFile {
7
+ constructor(openApiModel) {
8
+ super(settings_1.Settings.getInstance().openApiFileName(), '');
9
+ this.openApiModel = openApiModel;
10
+ this.addText(JSON.stringify(Object.assign(Object.assign({}, openApiModel), { namespace: undefined }), null, 2));
11
+ }
12
+ fileExtension() {
13
+ return '.json';
14
+ }
15
+ }
16
+ exports.OpenapiTypeFile = OpenapiTypeFile;
17
17
  //# sourceMappingURL=openapi-type-file.js.map
@@ -1,10 +1,10 @@
1
- export declare abstract class OutputFile {
2
- fileName: string;
3
- dir: string;
4
- _contents: string;
5
- constructor(fileName: string, dir: string);
6
- abstract fileExtension(): string;
7
- get body(): string;
8
- addText(text: string, encodeHtml?: boolean): void;
9
- addBlankLine(): void;
10
- }
1
+ export declare abstract class OutputFile {
2
+ fileName: string;
3
+ dir: string;
4
+ _contents: string;
5
+ constructor(fileName: string, dir: string);
6
+ abstract fileExtension(): string;
7
+ get body(): string;
8
+ addText(text: string): void;
9
+ addBlankLine(): void;
10
+ }
@@ -1,29 +1,22 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.OutputFile = void 0;
4
- const xss = require("xss");
5
- const settings_1 = require("../settings");
6
- const xssFilter = new xss.FilterXSS({
7
- whiteList: { br: [], p: [], ul: [], li: [], code: [], pre: [] },
8
- });
9
- class OutputFile {
10
- constructor(fileName, dir) {
11
- this.fileName = fileName;
12
- this.dir = dir;
13
- this._contents = '';
14
- }
15
- get body() {
16
- return this._contents;
17
- }
18
- addText(text, encodeHtml = true) {
19
- const shouldEncode = encodeHtml && settings_1.Settings.getInstance().sanitizeHtml;
20
- const textToAdd = shouldEncode ? xssFilter.process(text) : text;
21
- this._contents += textToAdd;
22
- this.addBlankLine();
23
- }
24
- addBlankLine() {
25
- this._contents += '\n';
26
- }
27
- }
28
- exports.OutputFile = OutputFile;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.OutputFile = void 0;
4
+ class OutputFile {
5
+ constructor(fileName, dir) {
6
+ this.fileName = fileName;
7
+ this.dir = dir;
8
+ this._contents = '';
9
+ }
10
+ get body() {
11
+ return this._contents;
12
+ }
13
+ addText(text) {
14
+ this._contents += text;
15
+ this.addBlankLine();
16
+ }
17
+ addBlankLine() {
18
+ this._contents += '\n';
19
+ }
20
+ }
21
+ exports.OutputFile = OutputFile;
29
22
  //# sourceMappingURL=outputFile.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"outputFile.js","sourceRoot":"","sources":["../../src/model/outputFile.ts"],"names":[],"mappings":";;;AAAA,2BAA4B;AAC5B,0CAAuC;AAEvC,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC;IAClC,SAAS,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE;CAChE,CAAC,CAAC;AAEH,MAAsB,UAAU;IAG9B,YAAmB,QAAgB,EAAS,GAAW;QAApC,aAAQ,GAAR,QAAQ,CAAQ;QAAS,QAAG,GAAH,GAAG,CAAQ;QAFvD,cAAS,GAAG,EAAE,CAAC;IAE2C,CAAC;IAI3D,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,OAAO,CAAC,IAAY,EAAE,UAAU,GAAG,IAAI;QACrC,MAAM,YAAY,GAAG,UAAU,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,YAAY,CAAC;QACvE,MAAM,SAAS,GAAG,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAChE,IAAI,CAAC,SAAS,IAAI,SAAS,CAAC;QAC5B,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,YAAY;QACV,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC;IACzB,CAAC;CACF;AArBD,gCAqBC"}
1
+ {"version":3,"file":"outputFile.js","sourceRoot":"","sources":["../../src/model/outputFile.ts"],"names":[],"mappings":";;;AAAA,MAAsB,UAAU;IAG9B,YAAmB,QAAgB,EAAS,GAAW;QAApC,aAAQ,GAAR,QAAQ,CAAQ;QAAS,QAAG,GAAH,GAAG,CAAQ;QAFvD,cAAS,GAAG,EAAE,CAAC;IAE2C,CAAC;IAI3D,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,OAAO,CAAC,IAAY;QAClB,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC;QACvB,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,YAAY;QACV,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC;IACzB,CAAC;CACF;AAnBD,gCAmBC"}
@@ -1,16 +1,16 @@
1
- import { Type } from '@cparra/apex-reflection';
2
- export type TypeBundle = {
3
- type: Type;
4
- isChild: boolean;
5
- parentType?: Type;
6
- };
7
- export declare class TypesRepository {
8
- private static instance;
9
- private scopedTypes;
10
- private allTypes;
11
- static getInstance(): TypesRepository;
12
- populateAll(types: Type[]): void;
13
- getFromAllByName(typeName: string): TypeBundle | undefined;
14
- populateScoped(types: Type[]): void;
15
- getFromScopedByName(typeName: string): Type | undefined;
16
- }
1
+ import { Type } from '@cparra/apex-reflection';
2
+ export type TypeBundle = {
3
+ type: Type;
4
+ isChild: boolean;
5
+ parentType?: Type;
6
+ };
7
+ export declare class TypesRepository {
8
+ private static instance;
9
+ private scopedTypes;
10
+ private allTypes;
11
+ static getInstance(): TypesRepository;
12
+ populateAll(types: Type[]): void;
13
+ getFromAllByName(typeName: string): TypeBundle | undefined;
14
+ populateScoped(types: Type[]): void;
15
+ getFromScopedByName(typeName: string): Type | undefined;
16
+ }
@@ -1,54 +1,54 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.TypesRepository = void 0;
4
- class TypesRepository {
5
- constructor() {
6
- this.scopedTypes = [];
7
- this.allTypes = [];
8
- }
9
- static getInstance() {
10
- if (!TypesRepository.instance) {
11
- TypesRepository.instance = new TypesRepository();
12
- }
13
- return TypesRepository.instance;
14
- }
15
- populateAll(types) {
16
- this.allTypes = types;
17
- }
18
- getFromAllByName(typeName) {
19
- if (typeName.includes('.')) {
20
- // If it includes a dot we are assuming we are dealing with an inner class.
21
- const [parentTypeName, childTypeName] = typeName.split('.');
22
- const parentReference = this.allTypes.find((currentType) => currentType.name.toLowerCase() === parentTypeName.toLowerCase());
23
- if (!parentReference || parentReference.type_name !== 'class') {
24
- // If the parent is not found, no reason to keep searching, instead we return undefined.
25
- // Similarly, if the parent is not a class, it means it cannot have children, so we return early.
26
- return undefined;
27
- }
28
- const parentReferenceAsClass = parentReference;
29
- const childTypes = [
30
- ...parentReferenceAsClass.classes,
31
- ...parentReferenceAsClass.interfaces,
32
- ...parentReferenceAsClass.enums,
33
- ];
34
- const foundType = childTypes.find((currentType) => currentType.name.toLowerCase() === childTypeName);
35
- if (!foundType) {
36
- return undefined;
37
- }
38
- return { type: foundType, isChild: true, parentType: parentReference };
39
- }
40
- const foundType = this.allTypes.find((currentType) => currentType.name.toLowerCase() === typeName.toLowerCase());
41
- if (!foundType) {
42
- return undefined;
43
- }
44
- return { type: foundType, isChild: false };
45
- }
46
- populateScoped(types) {
47
- this.scopedTypes = types;
48
- }
49
- getFromScopedByName(typeName) {
50
- return this.scopedTypes.find((currentType) => currentType.name === typeName);
51
- }
52
- }
53
- exports.TypesRepository = TypesRepository;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.TypesRepository = void 0;
4
+ class TypesRepository {
5
+ constructor() {
6
+ this.scopedTypes = [];
7
+ this.allTypes = [];
8
+ }
9
+ static getInstance() {
10
+ if (!TypesRepository.instance) {
11
+ TypesRepository.instance = new TypesRepository();
12
+ }
13
+ return TypesRepository.instance;
14
+ }
15
+ populateAll(types) {
16
+ this.allTypes = types;
17
+ }
18
+ getFromAllByName(typeName) {
19
+ if (typeName.includes('.')) {
20
+ // If it includes a dot we are assuming we are dealing with an inner class.
21
+ const [parentTypeName, childTypeName] = typeName.split('.');
22
+ const parentReference = this.allTypes.find((currentType) => currentType.name.toLowerCase() === parentTypeName.toLowerCase());
23
+ if (!parentReference || parentReference.type_name !== 'class') {
24
+ // If the parent is not found, no reason to keep searching, instead we return undefined.
25
+ // Similarly, if the parent is not a class, it means it cannot have children, so we return early.
26
+ return undefined;
27
+ }
28
+ const parentReferenceAsClass = parentReference;
29
+ const childTypes = [
30
+ ...parentReferenceAsClass.classes,
31
+ ...parentReferenceAsClass.interfaces,
32
+ ...parentReferenceAsClass.enums,
33
+ ];
34
+ const foundType = childTypes.find((currentType) => currentType.name.toLowerCase() === childTypeName);
35
+ if (!foundType) {
36
+ return undefined;
37
+ }
38
+ return { type: foundType, isChild: true, parentType: parentReference };
39
+ }
40
+ const foundType = this.allTypes.find((currentType) => currentType.name.toLowerCase() === typeName.toLowerCase());
41
+ if (!foundType) {
42
+ return undefined;
43
+ }
44
+ return { type: foundType, isChild: false };
45
+ }
46
+ populateScoped(types) {
47
+ this.scopedTypes = types;
48
+ }
49
+ getFromScopedByName(typeName) {
50
+ return this.scopedTypes.find((currentType) => currentType.name === typeName);
51
+ }
52
+ }
53
+ exports.TypesRepository = TypesRepository;
54
54
  //# sourceMappingURL=types-repository.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"types-repository.js","sourceRoot":"","sources":["../../src/model/types-repository.ts"],"names":[],"mappings":";;;AAIA,MAAa,eAAe;IAA5B;QAEU,gBAAW,GAAW,EAAE,CAAC;QACzB,aAAQ,GAAW,EAAE,CAAC;IAuDhC,CAAC;IArDQ,MAAM,CAAC,WAAW;QACvB,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE;YAC7B,eAAe,CAAC,QAAQ,GAAG,IAAI,eAAe,EAAE,CAAC;SAClD;QACD,OAAO,eAAe,CAAC,QAAQ,CAAC;IAClC,CAAC;IAEM,WAAW,CAAC,KAAa;QAC9B,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;IACxB,CAAC;IAEM,gBAAgB,CAAC,QAAgB;QACtC,IAAI,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YAC1B,2EAA2E;YAC3E,MAAM,CAAC,cAAc,EAAE,aAAa,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC5D,MAAM,eAAe,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CACxC,CAAC,WAAiB,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,cAAc,CAAC,WAAW,EAAE,CACvF,CAAC;YACF,IAAI,CAAC,eAAe,IAAI,eAAe,CAAC,SAAS,KAAK,OAAO,EAAE;gBAC7D,wFAAwF;gBACxF,iGAAiG;gBACjG,OAAO,SAAS,CAAC;aAClB;YAED,MAAM,sBAAsB,GAAG,eAA8B,CAAC;YAC9D,MAAM,UAAU,GAAG;gBACjB,GAAG,sBAAsB,CAAC,OAAO;gBACjC,GAAG,sBAAsB,CAAC,UAAU;gBACpC,GAAG,sBAAsB,CAAC,KAAK;aAChC,CAAC;YACF,MAAM,SAAS,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,WAAiB,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,aAAa,CAAC,CAAC;YAC3G,IAAI,CAAC,SAAS,EAAE;gBACd,OAAO,SAAS,CAAC;aAClB;YACD,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,eAAe,EAAE,CAAC;SACxE;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAClC,CAAC,WAAiB,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,QAAQ,CAAC,WAAW,EAAE,CACjF,CAAC;QACF,IAAI,CAAC,SAAS,EAAE;YACd,OAAO,SAAS,CAAC;SAClB;QACD,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;IAC7C,CAAC;IAEM,cAAc,CAAC,KAAa;QACjC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;IAC3B,CAAC;IAEM,mBAAmB,CAAC,QAAgB;QACzC,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,WAAiB,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC;IACrF,CAAC;CACF;AA1DD,0CA0DC"}
1
+ {"version":3,"file":"types-repository.js","sourceRoot":"","sources":["../../src/model/types-repository.ts"],"names":[],"mappings":";;;AAIA,MAAa,eAAe;IAA5B;QAEU,gBAAW,GAAW,EAAE,CAAC;QACzB,aAAQ,GAAW,EAAE,CAAC;IAuDhC,CAAC;IArDQ,MAAM,CAAC,WAAW;QACvB,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC;YAC9B,eAAe,CAAC,QAAQ,GAAG,IAAI,eAAe,EAAE,CAAC;QACnD,CAAC;QACD,OAAO,eAAe,CAAC,QAAQ,CAAC;IAClC,CAAC;IAEM,WAAW,CAAC,KAAa;QAC9B,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;IACxB,CAAC;IAEM,gBAAgB,CAAC,QAAgB;QACtC,IAAI,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC3B,2EAA2E;YAC3E,MAAM,CAAC,cAAc,EAAE,aAAa,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC5D,MAAM,eAAe,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CACxC,CAAC,WAAiB,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,cAAc,CAAC,WAAW,EAAE,CACvF,CAAC;YACF,IAAI,CAAC,eAAe,IAAI,eAAe,CAAC,SAAS,KAAK,OAAO,EAAE,CAAC;gBAC9D,wFAAwF;gBACxF,iGAAiG;gBACjG,OAAO,SAAS,CAAC;YACnB,CAAC;YAED,MAAM,sBAAsB,GAAG,eAA8B,CAAC;YAC9D,MAAM,UAAU,GAAG;gBACjB,GAAG,sBAAsB,CAAC,OAAO;gBACjC,GAAG,sBAAsB,CAAC,UAAU;gBACpC,GAAG,sBAAsB,CAAC,KAAK;aAChC,CAAC;YACF,MAAM,SAAS,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,WAAiB,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,aAAa,CAAC,CAAC;YAC3G,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,eAAe,EAAE,CAAC;QACzE,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAClC,CAAC,WAAiB,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,QAAQ,CAAC,WAAW,EAAE,CACjF,CAAC;QACF,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;IAC7C,CAAC;IAEM,cAAc,CAAC,KAAa;QACjC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;IAC3B,CAAC;IAEM,mBAAmB,CAAC,QAAgB;QACzC,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,WAAiB,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC;IACrF,CAAC;CACF;AA1DD,0CA0DC"}
@@ -1,14 +1,14 @@
1
- import { FileSystem } from './file-system';
2
- import ApexBundle from '../model/apex-bundle';
3
- /**
4
- * Reads from .cls files and returns their raw body.
5
- */
6
- export declare class ApexFileReader {
7
- /**
8
- * Reads from .cls files and returns their raw body.
9
- */
10
- static processFiles(fileSystem: FileSystem, rootPath?: string): ApexBundle[];
11
- private static isApexFile;
12
- private static get sourceDirectory();
13
- private static get readRecursively();
14
- }
1
+ import { FileSystem } from './file-system';
2
+ import ApexBundle from '../model/apex-bundle';
3
+ /**
4
+ * Reads from .cls files and returns their raw body.
5
+ */
6
+ export declare class ApexFileReader {
7
+ /**
8
+ * Reads from .cls files and returns their raw body.
9
+ */
10
+ static processFiles(fileSystem: FileSystem, rootPath?: string): ApexBundle[];
11
+ private static isApexFile;
12
+ private static get sourceDirectory();
13
+ private static get readRecursively();
14
+ }