@cparra/apexdocs 3.0.0-rc.0 → 3.1.0

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 (226) hide show
  1. package/README.md +61 -576
  2. package/dist/cli/generate.js +73 -3094
  3. package/dist/defaults-BcE8DTat.js +13 -0
  4. package/dist/defaults-D07y_bq4.js +40 -0
  5. package/dist/defaults-gPzwP66p.js +14 -0
  6. package/dist/index.d.ts +35 -3
  7. package/dist/index.js +90 -2
  8. package/dist/logger-BEbUIfqN.js +3282 -0
  9. package/dist/logger-BGuf1PnL.js +3281 -0
  10. package/dist/logger-CWBRF2za.js +3284 -0
  11. package/dist/logger-CdBmDEN1.js +3283 -0
  12. package/dist/logger-Ce4QqPFR.js +3278 -0
  13. package/dist/logger-CyEVYaAC.js +3284 -0
  14. package/dist/logger-D7a83ycP.js +3277 -0
  15. package/dist/logger-DGaHeBKk.js +3279 -0
  16. package/dist/logger-Dqhl_lO_.js +3278 -0
  17. package/dist/logger-aySSWi0G.js +3280 -0
  18. package/dist/logger-qLCcAtiy.js +3284 -0
  19. package/package.json +5 -2
  20. package/.github/workflows/ci.yaml +0 -22
  21. package/.github/workflows/close_stale.yml +0 -22
  22. package/.prettierrc.js +0 -7
  23. package/__mocks__/chalk.js +0 -12
  24. package/__mocks__/log-update.js +0 -6
  25. package/eslint.config.mjs +0 -10
  26. package/examples/markdown/.forceignore +0 -12
  27. package/examples/markdown/config/project-scratch-def.json +0 -5
  28. package/examples/markdown/docs/index.md +0 -109
  29. package/examples/markdown/docs/miscellaneous/BaseClass.md +0 -16
  30. package/examples/markdown/docs/miscellaneous/MultiInheritanceClass.md +0 -72
  31. package/examples/markdown/docs/miscellaneous/ParentInterface.md +0 -15
  32. package/examples/markdown/docs/miscellaneous/ReferencedEnum.md +0 -8
  33. package/examples/markdown/docs/miscellaneous/SampleException.md +0 -24
  34. package/examples/markdown/docs/miscellaneous/SampleInterface.md +0 -116
  35. package/examples/markdown/docs/miscellaneous/Url.md +0 -311
  36. package/examples/markdown/docs/sample-enums/SampleEnum.md +0 -36
  37. package/examples/markdown/docs/samplegroup/SampleClass.md +0 -170
  38. package/examples/markdown/force-app/classes/BaseClass.cls +0 -3
  39. package/examples/markdown/force-app/classes/MultiInheritanceClass.cls +0 -1
  40. package/examples/markdown/force-app/classes/ParentInterface.cls +0 -3
  41. package/examples/markdown/force-app/classes/ReferencedEnum.cls +0 -3
  42. package/examples/markdown/force-app/classes/SampleClass.cls +0 -72
  43. package/examples/markdown/force-app/classes/SampleEnum.cls +0 -30
  44. package/examples/markdown/force-app/classes/SampleException.cls +0 -17
  45. package/examples/markdown/force-app/classes/SampleInterface.cls +0 -50
  46. package/examples/markdown/force-app/classes/Url.cls +0 -196
  47. package/examples/markdown/package-lock.json +0 -665
  48. package/examples/markdown/package.json +0 -20
  49. package/examples/markdown/sfdx-project.json +0 -12
  50. package/examples/markdown-jsconfig/.forceignore +0 -12
  51. package/examples/markdown-jsconfig/apexdocs.config.mjs +0 -21
  52. package/examples/markdown-jsconfig/config/project-scratch-def.json +0 -5
  53. package/examples/markdown-jsconfig/docs/index.md +0 -12
  54. package/examples/markdown-jsconfig/docs/miscellaneous/Url.md +0 -315
  55. package/examples/markdown-jsconfig/force-app/classes/Url.cls +0 -196
  56. package/examples/markdown-jsconfig/package-lock.json +0 -665
  57. package/examples/markdown-jsconfig/package.json +0 -15
  58. package/examples/markdown-jsconfig/sfdx-project.json +0 -12
  59. package/examples/open-api/config/project-scratch-def.json +0 -13
  60. package/examples/open-api/docs/openapi.json +0 -582
  61. package/examples/open-api/force-app/main/default/classes/ChildClass.cls +0 -42
  62. package/examples/open-api/force-app/main/default/classes/SampleClass.cls +0 -167
  63. package/examples/open-api/force-app/main/default/restapi/SampleRestResource.cls +0 -195
  64. package/examples/open-api/force-app/main/default/restapi/SampleRestResourceToSkip.cls +0 -35
  65. package/examples/open-api/force-app/main/default/restapi/SampleRestResourceWithInnerClass.cls +0 -24
  66. package/examples/open-api/force-app/main/default/restapi/SampleRestResourceWithoutApexDocs.cls +0 -15
  67. package/examples/open-api/force-app/main/default/restapi/references/Reference1.cls +0 -9
  68. package/examples/open-api/force-app/main/default/restapi/references/Reference2.cls +0 -9
  69. package/examples/open-api/force-app/main/default/restapi/references/Reference3.cls +0 -3
  70. package/examples/open-api/force-app/main/default/restapi/references/Reference4.cls +0 -3
  71. package/examples/open-api/force-app/main/default/restapi/references/Reference5.cls +0 -3
  72. package/examples/open-api/force-app/main/default/restapi/references/Reference6.cls +0 -6
  73. package/examples/open-api/force-app/main/default/restapi/references/Reference7.cls +0 -3
  74. package/examples/open-api/package-lock.json +0 -724
  75. package/examples/open-api/package.json +0 -20
  76. package/examples/open-api/sfdx-project.json +0 -12
  77. package/examples/vitepress/.forceignore +0 -12
  78. package/examples/vitepress/apexdocs.config.ts +0 -111
  79. package/examples/vitepress/config/project-scratch-def.json +0 -13
  80. package/examples/vitepress/docs/.vitepress/cache/deps/@theme_index.js +0 -259
  81. package/examples/vitepress/docs/.vitepress/cache/deps/@theme_index.js.map +0 -7
  82. package/examples/vitepress/docs/.vitepress/cache/deps/_metadata.json +0 -40
  83. package/examples/vitepress/docs/.vitepress/cache/deps/chunk-574YRH25.js +0 -11474
  84. package/examples/vitepress/docs/.vitepress/cache/deps/chunk-574YRH25.js.map +0 -7
  85. package/examples/vitepress/docs/.vitepress/cache/deps/chunk-E5DZZB2I.js +0 -9172
  86. package/examples/vitepress/docs/.vitepress/cache/deps/chunk-E5DZZB2I.js.map +0 -7
  87. package/examples/vitepress/docs/.vitepress/cache/deps/package.json +0 -3
  88. package/examples/vitepress/docs/.vitepress/cache/deps/vitepress___@vue_devtools-api.js +0 -4339
  89. package/examples/vitepress/docs/.vitepress/cache/deps/vitepress___@vue_devtools-api.js.map +0 -7
  90. package/examples/vitepress/docs/.vitepress/cache/deps/vitepress___@vueuse_core.js +0 -567
  91. package/examples/vitepress/docs/.vitepress/cache/deps/vitepress___@vueuse_core.js.map +0 -7
  92. package/examples/vitepress/docs/.vitepress/cache/deps/vue.js +0 -323
  93. package/examples/vitepress/docs/.vitepress/cache/deps/vue.js.map +0 -7
  94. package/examples/vitepress/docs/.vitepress/config.mts +0 -21
  95. package/examples/vitepress/docs/.vitepress/sidebar.json +0 -119
  96. package/examples/vitepress/docs/api-examples.md +0 -49
  97. package/examples/vitepress/docs/index-frontmatter.md +0 -16
  98. package/examples/vitepress/docs/index.md +0 -56
  99. package/examples/vitepress/docs/markdown-examples.md +0 -85
  100. package/examples/vitepress/docs/miscellaneous/BaseClass.md +0 -20
  101. package/examples/vitepress/docs/miscellaneous/MultiInheritanceClass.md +0 -76
  102. package/examples/vitepress/docs/miscellaneous/ParentInterface.md +0 -19
  103. package/examples/vitepress/docs/miscellaneous/ReferencedEnum.md +0 -15
  104. package/examples/vitepress/docs/miscellaneous/SampleException.md +0 -28
  105. package/examples/vitepress/docs/miscellaneous/SampleInterface.md +0 -116
  106. package/examples/vitepress/docs/miscellaneous/Url.md +0 -317
  107. package/examples/vitepress/docs/sample-enums/SampleEnum.md +0 -40
  108. package/examples/vitepress/docs/samplegroup/SampleClass.md +0 -174
  109. package/examples/vitepress/force-app/main/default/classes/BaseClass.cls +0 -3
  110. package/examples/vitepress/force-app/main/default/classes/MultiInheritanceClass.cls +0 -1
  111. package/examples/vitepress/force-app/main/default/classes/ParentInterface.cls +0 -3
  112. package/examples/vitepress/force-app/main/default/classes/ReferencedEnum.cls +0 -5
  113. package/examples/vitepress/force-app/main/default/classes/SampleClass.cls +0 -72
  114. package/examples/vitepress/force-app/main/default/classes/SampleEnum.cls +0 -30
  115. package/examples/vitepress/force-app/main/default/classes/SampleException.cls +0 -17
  116. package/examples/vitepress/force-app/main/default/classes/SampleInterface.cls +0 -46
  117. package/examples/vitepress/force-app/main/default/classes/Url.cls +0 -198
  118. package/examples/vitepress/package-lock.json +0 -2574
  119. package/examples/vitepress/package.json +0 -18
  120. package/examples/vitepress/sfdx-project.json +0 -12
  121. package/jest.config.js +0 -10
  122. package/jest.d.ts +0 -7
  123. package/src/application/Apexdocs.ts +0 -72
  124. package/src/application/__tests__/apex-file-reader.spec.ts +0 -87
  125. package/src/application/apex-file-reader.ts +0 -55
  126. package/src/application/file-system.ts +0 -69
  127. package/src/application/file-writer.ts +0 -43
  128. package/src/application/generators/markdown.ts +0 -45
  129. package/src/application/generators/openapi.ts +0 -71
  130. package/src/cli/args.ts +0 -46
  131. package/src/cli/commands/markdown.ts +0 -51
  132. package/src/cli/commands/openapi.ts +0 -36
  133. package/src/cli/generate.ts +0 -16
  134. package/src/core/__test__/manifest.spec.ts +0 -16
  135. package/src/core/manifest.ts +0 -90
  136. package/src/core/markdown/__test__/expect-extensions.ts +0 -32
  137. package/src/core/markdown/__test__/generating-class-docs.spec.ts +0 -605
  138. package/src/core/markdown/__test__/generating-docs.spec.ts +0 -111
  139. package/src/core/markdown/__test__/generating-enum-docs.spec.ts +0 -321
  140. package/src/core/markdown/__test__/generating-interface-docs.spec.ts +0 -397
  141. package/src/core/markdown/__test__/generating-reference-guide.spec.ts +0 -180
  142. package/src/core/markdown/__test__/inheritance-chain.test.ts +0 -54
  143. package/src/core/markdown/__test__/test-helpers.ts +0 -23
  144. package/src/core/markdown/adapters/__tests__/documentables.spec.ts +0 -109
  145. package/src/core/markdown/adapters/__tests__/interface-adapter.spec.ts +0 -148
  146. package/src/core/markdown/adapters/__tests__/link-generator.spec.ts +0 -130
  147. package/src/core/markdown/adapters/__tests__/references.spec.ts +0 -136
  148. package/src/core/markdown/adapters/apex-types.ts +0 -238
  149. package/src/core/markdown/adapters/documentables.ts +0 -115
  150. package/src/core/markdown/adapters/fields-and-properties.ts +0 -45
  151. package/src/core/markdown/adapters/generate-link.ts +0 -82
  152. package/src/core/markdown/adapters/inline.ts +0 -143
  153. package/src/core/markdown/adapters/methods-and-constructors.ts +0 -133
  154. package/src/core/markdown/adapters/reference-guide.ts +0 -37
  155. package/src/core/markdown/adapters/renderable-bundle.ts +0 -61
  156. package/src/core/markdown/adapters/renderable-to-page-data.ts +0 -89
  157. package/src/core/markdown/adapters/type-utils.ts +0 -13
  158. package/src/core/markdown/adapters/types.d.ts +0 -180
  159. package/src/core/markdown/generate-docs.ts +0 -212
  160. package/src/core/markdown/reflection/__test__/filter-scope.spec.ts +0 -306
  161. package/src/core/markdown/reflection/filter-scope.ts +0 -13
  162. package/src/core/markdown/reflection/inheritance-chain-expanion.ts +0 -22
  163. package/src/core/markdown/reflection/inheritance-chain.ts +0 -23
  164. package/src/core/markdown/reflection/inherited-member-expansion.ts +0 -105
  165. package/src/core/markdown/reflection/reflect-source.ts +0 -123
  166. package/src/core/markdown/reflection/sort-members.ts +0 -59
  167. package/src/core/markdown/templates/class-template.ts +0 -75
  168. package/src/core/markdown/templates/constructors-partial-template.ts +0 -32
  169. package/src/core/markdown/templates/documentable-partial-template.ts +0 -26
  170. package/src/core/markdown/templates/enum-template.ts +0 -12
  171. package/src/core/markdown/templates/fieldsPartialTemplate.ts +0 -23
  172. package/src/core/markdown/templates/grouped-members-partial-template.ts +0 -6
  173. package/src/core/markdown/templates/hookable.ts +0 -7
  174. package/src/core/markdown/templates/interface-template.ts +0 -16
  175. package/src/core/markdown/templates/methods-partial-template.ts +0 -43
  176. package/src/core/markdown/templates/reference-guide.ts +0 -14
  177. package/src/core/markdown/templates/template.ts +0 -114
  178. package/src/core/markdown/templates/type-doc-partial.ts +0 -27
  179. package/src/core/markdown/utils.ts +0 -3
  180. package/src/core/openApiSettings.ts +0 -41
  181. package/src/core/openapi/__tests__/manifest-factory.spec.ts +0 -16
  182. package/src/core/openapi/__tests__/open-api-docs-processor.spec.ts +0 -56
  183. package/src/core/openapi/__tests__/open-api.spec.ts +0 -22
  184. package/src/core/openapi/apex-doc-types.ts +0 -26
  185. package/src/core/openapi/apex-type-wrappers/ClassMirrorWrapper.ts +0 -12
  186. package/src/core/openapi/apex-type-wrappers/MethodMirrorWrapper.ts +0 -11
  187. package/src/core/openapi/apex-type-wrappers/__tests__/ClassMirrorWrapper.spec.ts +0 -15
  188. package/src/core/openapi/file-container.ts +0 -13
  189. package/src/core/openapi/manifest-factory.ts +0 -16
  190. package/src/core/openapi/open-api-docs-processor.ts +0 -93
  191. package/src/core/openapi/open-api-types.ts +0 -119
  192. package/src/core/openapi/open-api.ts +0 -45
  193. package/src/core/openapi/openapi-type-file.ts +0 -12
  194. package/src/core/openapi/parser.ts +0 -160
  195. package/src/core/openapi/parsers/Builder.ts +0 -40
  196. package/src/core/openapi/parsers/MethodParser.ts +0 -249
  197. package/src/core/openapi/parsers/ParameterObjectBuilder.ts +0 -13
  198. package/src/core/openapi/parsers/ReferenceBuilder.ts +0 -299
  199. package/src/core/openapi/parsers/RequestBodyBuilder.ts +0 -19
  200. package/src/core/openapi/parsers/ResponsesBuilder.ts +0 -21
  201. package/src/core/openapi/parsers/__tests__/MethodParser.spec.ts +0 -44
  202. package/src/core/openapi/parsers/__tests__/ParameterObjectBuilder.spec.ts +0 -68
  203. package/src/core/openapi/parsers/__tests__/ReferenceBuilder.spec.ts +0 -751
  204. package/src/core/openapi/parsers/__tests__/RequestBodyBuilder.spec.ts +0 -64
  205. package/src/core/openapi/parsers/__tests__/ResponsesBuilder.spec.ts +0 -55
  206. package/src/core/openapi/transpiler.ts +0 -17
  207. package/src/core/openapi/types-repository.ts +0 -54
  208. package/src/core/parse-apex-metadata.ts +0 -30
  209. package/src/core/shared/types.d.ts +0 -148
  210. package/src/core/shared/utils.ts +0 -5
  211. package/src/defaults.ts +0 -9
  212. package/src/index.ts +0 -49
  213. package/src/test-helpers/AnnotationBuilder.ts +0 -29
  214. package/src/test-helpers/ClassMirrorBuilder.ts +0 -69
  215. package/src/test-helpers/DocCommentAnnotationBuilder.ts +0 -24
  216. package/src/test-helpers/DocCommentBuilder.ts +0 -36
  217. package/src/test-helpers/FieldMirrorBuilder.ts +0 -59
  218. package/src/test-helpers/InterfaceMirrorBuilder.ts +0 -39
  219. package/src/test-helpers/MethodMirrorBuilder.ts +0 -77
  220. package/src/test-helpers/SettingsBuilder.ts +0 -17
  221. package/src/util/error-logger.ts +0 -92
  222. package/src/util/fp.ts +0 -3
  223. package/src/util/logger.ts +0 -44
  224. package/src/util/string-utils.ts +0 -7
  225. package/tsconfig.json +0 -25
  226. package/tslint.json +0 -6
@@ -1,3091 +1,45 @@
1
1
  #!/usr/bin/env node
2
2
  'use strict';
3
3
 
4
- var _function = require('fp-ts/function');
5
- var TE = require('fp-ts/TaskEither');
6
- var yaml = require('js-yaml');
7
- var path = require('path');
8
- var E = require('fp-ts/Either');
9
- var T = require('fp-ts/Task');
10
- var A = require('fp-ts/lib/Array');
11
- var apexReflection = require('@cparra/apex-reflection');
12
- var O = require('fp-ts/Option');
13
- var fastXmlParser = require('fast-xml-parser');
14
- var Handlebars = require('handlebars');
15
- var defaults = require('../defaults-DGKfeZq-.js');
16
- var fs = require('fs');
17
- var TE$1 = require('fp-ts/lib/TaskEither');
18
- var chalk = require('chalk');
19
- var cosmiconfig = require('cosmiconfig');
20
- var yargs = require('yargs');
21
- var cosmiconfigTypescriptLoader = require('cosmiconfig-typescript-loader');
22
-
23
- function _interopNamespaceDefault(e) {
24
- var n = Object.create(null);
25
- if (e) {
26
- Object.keys(e).forEach(function (k) {
27
- if (k !== 'default') {
28
- var d = Object.getOwnPropertyDescriptor(e, k);
29
- Object.defineProperty(n, k, d.get ? d : {
30
- enumerable: true,
31
- get: function () { return e[k]; }
32
- });
33
- }
34
- });
35
- }
36
- n.default = e;
37
- return Object.freeze(n);
38
- }
39
-
40
- var TE__namespace = /*#__PURE__*/_interopNamespaceDefault(TE);
41
- var yaml__namespace = /*#__PURE__*/_interopNamespaceDefault(yaml);
42
- var path__namespace = /*#__PURE__*/_interopNamespaceDefault(path);
43
- var E__namespace = /*#__PURE__*/_interopNamespaceDefault(E);
44
- var T__namespace = /*#__PURE__*/_interopNamespaceDefault(T);
45
- var A__namespace = /*#__PURE__*/_interopNamespaceDefault(A);
46
- var O__namespace = /*#__PURE__*/_interopNamespaceDefault(O);
47
- var fs__namespace = /*#__PURE__*/_interopNamespaceDefault(fs);
48
- var TE__namespace$1 = /*#__PURE__*/_interopNamespaceDefault(TE$1);
49
- var yargs__namespace = /*#__PURE__*/_interopNamespaceDefault(yargs);
50
-
51
- function apply(fn, ...front) {
52
- return (...tailArgs) => fn(...front, ...tailArgs);
53
- }
54
-
55
- function defaultGetEmailByReference(email) {
56
- return {
57
- __type: "link",
58
- title: email,
59
- url: `mailto:${email}`
60
- };
61
- }
62
- function replaceInlineReferences(text, linkReplacer, emailReplacer = defaultGetEmailByReference) {
63
- const inlineLinks = apply(replaceInlineLinks, linkReplacer);
64
- const inlineEmails = apply(replaceInlineEmails, emailReplacer);
65
- return _function.pipe(inlineCode$1([text]), inlineLinks, inlineEmails);
66
- }
67
- function inlineCode$1(renderableContents) {
68
- return renderableContents.flatMap((renderableContent) => inlineCodeContent(renderableContent));
69
- }
70
- function inlineCodeContent(renderableContent) {
71
- if (typeof renderableContent !== "string") {
72
- return [renderableContent];
73
- }
74
- function inlineCodeLink(text2) {
75
- return {
76
- __type: "inline-code",
77
- content: text2
78
- };
79
- }
80
- const text = renderableContent;
81
- const codeFormatRegEx = "`([^`]*)`";
82
- const matches = match(codeFormatRegEx, text);
83
- return createRenderableContents(matches, text, inlineCodeLink);
84
- }
85
- function replaceInlineLinks(getLinkByTypeName, renderableContents) {
86
- return renderableContents.flatMap((renderableContent) => inlineLinkContent(renderableContent, getLinkByTypeName));
87
- }
88
- function inlineLinkContent(renderableContent, getLinkByTypeName) {
89
- if (typeof renderableContent !== "string") {
90
- return [renderableContent];
91
- }
92
- const text = renderableContent;
93
- const linkFormatRegEx = "{@link (.*?)}|<<([^>]+)>>";
94
- const matches = match(linkFormatRegEx, text);
95
- return createRenderableContents(matches, text, getLinkByTypeName);
96
- }
97
- function replaceInlineEmails(getLinkByTypeName, renderableContents) {
98
- return renderableContents.flatMap((renderableContent) => inlineEmailContent(renderableContent, getLinkByTypeName));
99
- }
100
- function inlineEmailContent(renderableContent, getLinkByTypeName) {
101
- if (typeof renderableContent !== "string") {
102
- return [renderableContent];
103
- }
104
- const text = renderableContent;
105
- const linkFormatRegEx = "{@email (.*?)}";
106
- const matches = match(linkFormatRegEx, text);
107
- return createRenderableContents(matches, text, getLinkByTypeName);
108
- }
109
- function match(regex, text) {
110
- const expression = new RegExp(regex, "gi");
111
- let match2;
112
- const matches = [];
113
- do {
114
- match2 = expression.exec(text);
115
- if (match2) {
116
- matches.push(match2);
117
- }
118
- } while (match2);
119
- return matches;
120
- }
121
- function createRenderableContents(matches, text, linker) {
122
- if (matches.length === 0) {
123
- return [text];
124
- }
125
- const result = [];
126
- let lastIndex = 0;
127
- for (const match2 of matches) {
128
- const index = match2.index;
129
- const length = match2[0].length;
130
- const capturedGroup = match2.slice(1).find((group) => group);
131
- if (!capturedGroup) {
132
- continue;
133
- }
134
- result.push(text.slice(lastIndex, index));
135
- result.push(linker(capturedGroup));
136
- lastIndex = index + length;
137
- }
138
- if (lastIndex < text.length) {
139
- result.push(text.slice(lastIndex));
140
- }
141
- return result;
142
- }
143
-
144
- function isEmptyLine(content) {
145
- return Object.keys(content).includes("__type") && content.__type === "empty-line";
146
- }
147
- function isCodeBlock(content) {
148
- return Object.keys(content).includes("__type") && content.__type === "code-block";
149
- }
150
- function isInlineCode(content) {
151
- return Object.keys(content).includes("__type") && content.__type === "inline-code";
152
- }
153
-
154
- var __defProp$g = Object.defineProperty;
155
- var __defProps$g = Object.defineProperties;
156
- var __getOwnPropDescs$g = Object.getOwnPropertyDescriptors;
157
- var __getOwnPropSymbols$g = Object.getOwnPropertySymbols;
158
- var __hasOwnProp$g = Object.prototype.hasOwnProperty;
159
- var __propIsEnum$g = Object.prototype.propertyIsEnumerable;
160
- var __defNormalProp$g = (obj, key, value) => key in obj ? __defProp$g(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
161
- var __spreadValues$g = (a, b) => {
162
- for (var prop in b || (b = {}))
163
- if (__hasOwnProp$g.call(b, prop))
164
- __defNormalProp$g(a, prop, b[prop]);
165
- if (__getOwnPropSymbols$g)
166
- for (var prop of __getOwnPropSymbols$g(b)) {
167
- if (__propIsEnum$g.call(b, prop))
168
- __defNormalProp$g(a, prop, b[prop]);
169
- }
170
- return a;
171
- };
172
- var __spreadProps$g = (a, b) => __defProps$g(a, __getOwnPropDescs$g(b));
173
- function adaptDescribable(describable, linkGenerator) {
174
- return {
175
- description: describableToRenderableContent(describable, linkGenerator)
176
- };
177
- }
178
- function describableToRenderableContent(describable, linkGenerator) {
179
- if (!describable) {
180
- return;
181
- }
182
- let content = [];
183
- for (let i = 0; i < describable.length; i++) {
184
- const line = describable[i];
185
- const codeBlockMatch = line.match(/^```([a-zA-Z]*)$/);
186
- if (codeBlockMatch) {
187
- const language = codeBlockMatch[1] || "apex";
188
- const codeBlockLines = [];
189
- i++;
190
- while (i < describable.length) {
191
- const currentLine = describable[i];
192
- if (currentLine.trim() === "```") {
193
- break;
194
- }
195
- codeBlockLines.push(currentLine);
196
- i++;
197
- }
198
- content = [
199
- ...content,
200
- {
201
- __type: "code-block",
202
- language,
203
- content: codeBlockLines
204
- },
205
- { __type: "empty-line" }
206
- ];
207
- continue;
208
- }
209
- content = [
210
- ...content,
211
- ...replaceInlineReferences(line, linkGenerator),
212
- {
213
- __type: "empty-line"
214
- }
215
- ];
216
- }
217
- return content.filter((line, index, lines) => !(isEmptyLine(line) && index === lines.length - 1));
218
- }
219
- function adaptDocumentable(documentable, linkGenerator, subHeadingLevel) {
220
- var _a, _b, _c;
221
- function extractCustomTags(type) {
222
- var _a2, _b2;
223
- const baseTags = ["description", "group", "author", "date", "see", "example", "throws", "exception"];
224
- return (_b2 = (_a2 = type.docComment) == null ? void 0 : _a2.annotations.filter((currentAnnotation) => !baseTags.includes(currentAnnotation.name.toLowerCase())).map((currentAnnotation) => __spreadProps$g(__spreadValues$g({}, adaptDescribable(currentAnnotation.bodyLines, linkGenerator)), {
225
- name: currentAnnotation.name
226
- }))) != null ? _b2 : [];
227
- }
228
- function extractAnnotationBody(type, annotationName) {
229
- var _a2, _b2;
230
- return (_b2 = (_a2 = type.docComment) == null ? void 0 : _a2.annotations.find(
231
- (currentAnnotation) => currentAnnotation.name.toLowerCase() === annotationName
232
- )) == null ? void 0 : _b2.body;
233
- }
234
- function extractSeeAnnotations(type) {
235
- var _a2, _b2;
236
- return (_b2 = (_a2 = type.docComment) == null ? void 0 : _a2.annotations.filter((currentAnnotation) => currentAnnotation.name.toLowerCase() === "see").map((currentAnnotation) => currentAnnotation.body)) != null ? _b2 : [];
237
- }
238
- return __spreadProps$g(__spreadValues$g({}, adaptDescribable((_a = documentable.docComment) == null ? void 0 : _a.descriptionLines, linkGenerator)), {
239
- annotations: documentable.annotations.map((annotation) => annotation.type.toUpperCase()),
240
- customTags: extractCustomTags(documentable),
241
- example: {
242
- headingLevel: subHeadingLevel,
243
- heading: "Example",
244
- value: describableToRenderableContent((_c = (_b = documentable.docComment) == null ? void 0 : _b.exampleAnnotation) == null ? void 0 : _c.bodyLines, linkGenerator)
245
- },
246
- group: extractAnnotationBody(documentable, "group"),
247
- author: extractAnnotationBody(documentable, "author"),
248
- date: extractAnnotationBody(documentable, "date"),
249
- sees: extractSeeAnnotations(documentable).map(linkGenerator)
250
- });
251
- }
252
-
253
- var __defProp$f = Object.defineProperty;
254
- var __defProps$f = Object.defineProperties;
255
- var __getOwnPropDescs$f = Object.getOwnPropertyDescriptors;
256
- var __getOwnPropSymbols$f = Object.getOwnPropertySymbols;
257
- var __hasOwnProp$f = Object.prototype.hasOwnProperty;
258
- var __propIsEnum$f = Object.prototype.propertyIsEnumerable;
259
- var __defNormalProp$f = (obj, key, value) => key in obj ? __defProp$f(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
260
- var __spreadValues$f = (a, b) => {
261
- for (var prop in b || (b = {}))
262
- if (__hasOwnProp$f.call(b, prop))
263
- __defNormalProp$f(a, prop, b[prop]);
264
- if (__getOwnPropSymbols$f)
265
- for (var prop of __getOwnPropSymbols$f(b)) {
266
- if (__propIsEnum$f.call(b, prop))
267
- __defNormalProp$f(a, prop, b[prop]);
268
- }
269
- return a;
270
- };
271
- var __spreadProps$f = (a, b) => __defProps$f(a, __getOwnPropDescs$f(b));
272
- function adaptMethod(method, linkGenerator, baseHeadingLevel) {
273
- var _a, _b, _c;
274
- function buildTitle(method2) {
275
- const { name, parameters } = method2;
276
- const parametersString = parameters.map((param) => param.name).join(", ");
277
- return `${name}(${parametersString})`;
278
- }
279
- function buildSignature(method2) {
280
- const { access_modifier, typeReference, name, memberModifiers } = method2;
281
- const parameters = method2.parameters.map((param) => `${param.typeReference.rawDeclaration} ${param.name}`).join(", ");
282
- const members = memberModifiers.length > 0 ? `${memberModifiers.join(" ")} ` : "";
283
- return {
284
- __type: "code-block",
285
- language: "apex",
286
- content: [`${access_modifier} ${members}${typeReference.rawDeclaration} ${name}(${parameters})`]
287
- };
288
- }
289
- return {
290
- headingLevel: baseHeadingLevel,
291
- doc: adaptDocumentable(method, linkGenerator, baseHeadingLevel + 1),
292
- heading: buildTitle(method),
293
- signature: {
294
- headingLevel: baseHeadingLevel + 1,
295
- heading: "Signature",
296
- value: buildSignature(method)
297
- },
298
- returnType: {
299
- headingLevel: baseHeadingLevel + 1,
300
- heading: "Return Type",
301
- value: __spreadProps$f(__spreadValues$f({}, adaptDescribable((_b = (_a = method.docComment) == null ? void 0 : _a.returnAnnotation) == null ? void 0 : _b.bodyLines, linkGenerator)), {
302
- type: linkGenerator(method.typeReference.rawDeclaration)
303
- })
304
- },
305
- throws: {
306
- headingLevel: baseHeadingLevel + 1,
307
- heading: "Throws",
308
- value: (_c = method.docComment) == null ? void 0 : _c.throwsAnnotations.map((thrown) => mapThrows(thrown, linkGenerator))
309
- },
310
- parameters: {
311
- headingLevel: baseHeadingLevel + 1,
312
- heading: "Parameters",
313
- value: method.parameters.map((param) => mapParameters(method, param, linkGenerator))
314
- },
315
- inherited: method.inherited
316
- };
317
- }
318
- function adaptConstructor(typeName, constructor, linkGenerator, baseHeadingLevel) {
319
- var _a;
320
- function buildTitle(name, constructor2) {
321
- const { parameters } = constructor2;
322
- const parametersString = parameters.map((param) => param.name).join(", ");
323
- return `${name}(${parametersString})`;
324
- }
325
- function buildSignature(name, constructor2) {
326
- const { access_modifier } = constructor2;
327
- const parameters = constructor2.parameters.map((param) => `${param.typeReference.rawDeclaration} ${param.name}`).join(", ");
328
- return {
329
- __type: "code-block",
330
- language: "apex",
331
- content: [`${access_modifier} ${name}(${parameters})`]
332
- };
333
- }
334
- return {
335
- doc: adaptDocumentable(constructor, linkGenerator, baseHeadingLevel + 1),
336
- headingLevel: baseHeadingLevel,
337
- heading: buildTitle(typeName, constructor),
338
- signature: {
339
- headingLevel: baseHeadingLevel + 1,
340
- heading: "Signature",
341
- value: buildSignature(typeName, constructor)
342
- },
343
- parameters: {
344
- headingLevel: baseHeadingLevel + 1,
345
- heading: "Parameters",
346
- value: constructor.parameters.map((param) => mapParameters(constructor, param, linkGenerator))
347
- },
348
- throws: {
349
- headingLevel: baseHeadingLevel + 1,
350
- heading: "Throws",
351
- value: (_a = constructor.docComment) == null ? void 0 : _a.throwsAnnotations.map((thrown) => mapThrows(thrown, linkGenerator))
352
- }
353
- };
354
- }
355
- function mapParameters(documentable, param, linkGenerator) {
356
- var _a;
357
- const paramAnnotation = (_a = documentable.docComment) == null ? void 0 : _a.paramAnnotations.find(
358
- (pa) => pa.paramName.toLowerCase() === param.name.toLowerCase()
359
- );
360
- return __spreadProps$f(__spreadValues$f({}, adaptDescribable(paramAnnotation == null ? void 0 : paramAnnotation.bodyLines, linkGenerator)), {
361
- name: param.name,
362
- type: linkGenerator(param.typeReference.rawDeclaration)
363
- });
364
- }
365
- function mapThrows(thrown, linkGenerator) {
366
- return __spreadProps$f(__spreadValues$f({}, adaptDescribable(thrown.bodyLines, linkGenerator)), {
367
- type: linkGenerator(thrown.exceptionName)
368
- });
369
- }
370
-
371
- function adaptFieldOrProperty(field, linkGenerator, baseHeadingLevel) {
372
- function buildSignature() {
373
- const { access_modifier, name } = field;
374
- const memberModifiers = field.memberModifiers.join(" ");
375
- const codeContents = `${access_modifier} ${memberModifiers} ${name}`.replace(/ {2}/g, " ");
376
- return {
377
- __type: "code-block",
378
- language: "apex",
379
- content: [codeContents]
380
- };
381
- }
382
- return {
383
- headingLevel: baseHeadingLevel,
384
- doc: adaptDocumentable(field, linkGenerator, baseHeadingLevel + 1),
385
- heading: field.name,
386
- type: {
387
- headingLevel: baseHeadingLevel + 1,
388
- heading: "Type",
389
- value: linkGenerator(field.typeReference.rawDeclaration)
390
- },
391
- inherited: field.inherited,
392
- accessModifier: field.access_modifier,
393
- signature: {
394
- headingLevel: baseHeadingLevel + 1,
395
- heading: "Signature",
396
- value: buildSignature()
397
- }
398
- };
399
- }
400
-
401
- var __defProp$e = Object.defineProperty;
402
- var __defProps$e = Object.defineProperties;
403
- var __getOwnPropDescs$e = Object.getOwnPropertyDescriptors;
404
- var __getOwnPropSymbols$e = Object.getOwnPropertySymbols;
405
- var __hasOwnProp$e = Object.prototype.hasOwnProperty;
406
- var __propIsEnum$e = Object.prototype.propertyIsEnumerable;
407
- var __defNormalProp$e = (obj, key, value) => key in obj ? __defProp$e(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
408
- var __spreadValues$e = (a, b) => {
409
- for (var prop in b || (b = {}))
410
- if (__hasOwnProp$e.call(b, prop))
411
- __defNormalProp$e(a, prop, b[prop]);
412
- if (__getOwnPropSymbols$e)
413
- for (var prop of __getOwnPropSymbols$e(b)) {
414
- if (__propIsEnum$e.call(b, prop))
415
- __defNormalProp$e(a, prop, b[prop]);
416
- }
417
- return a;
418
- };
419
- var __spreadProps$e = (a, b) => __defProps$e(a, __getOwnPropDescs$e(b));
420
- function typeToRenderable(parsedFile, linkGenerator, config) {
421
- function getRenderable() {
422
- const { type } = parsedFile;
423
- switch (type.type_name) {
424
- case "enum":
425
- return enumTypeToEnumSource(type, linkGenerator);
426
- case "interface":
427
- return interfaceTypeToInterfaceSource(type, linkGenerator);
428
- case "class":
429
- return classTypeToClassSource(type, linkGenerator);
430
- }
431
- }
432
- return __spreadProps$e(__spreadValues$e({}, getRenderable()), {
433
- filePath: parsedFile.source.filePath,
434
- namespace: config.namespace
435
- });
436
- }
437
- function baseTypeAdapter(type, linkGenerator, baseHeadingLevel) {
438
- function getHeading(type2) {
439
- const suffixMap = {
440
- class: "Class",
441
- interface: "Interface",
442
- enum: "Enum"
443
- };
444
- return `${type2.name} ${suffixMap[type2.type_name]}`;
445
- }
446
- return {
447
- headingLevel: baseHeadingLevel,
448
- heading: getHeading(type),
449
- doc: adaptDocumentable(type, linkGenerator, baseHeadingLevel + 1),
450
- name: type.name,
451
- meta: {
452
- accessModifier: type.access_modifier
453
- }
454
- };
455
- }
456
- function enumTypeToEnumSource(enumType, linkGenerator, baseHeadingLevel = 1) {
457
- return __spreadProps$e(__spreadValues$e({
458
- type: "enum"
459
- }, baseTypeAdapter(enumType, linkGenerator, baseHeadingLevel)), {
460
- values: {
461
- headingLevel: baseHeadingLevel + 1,
462
- heading: "Values",
463
- value: enumType.values.map((value) => {
464
- var _a;
465
- return __spreadProps$e(__spreadValues$e({}, adaptDescribable((_a = value.docComment) == null ? void 0 : _a.descriptionLines, linkGenerator)), {
466
- value: value.name
467
- });
468
- })
469
- }
470
- });
471
- }
472
- function interfaceTypeToInterfaceSource(interfaceType, linkGenerator, baseHeadingLevel = 1) {
473
- return __spreadProps$e(__spreadValues$e({
474
- type: "interface"
475
- }, baseTypeAdapter(interfaceType, linkGenerator, baseHeadingLevel)), {
476
- extends: interfaceType.extended_interfaces.map(linkGenerator),
477
- methods: {
478
- headingLevel: baseHeadingLevel + 1,
479
- heading: "Methods",
480
- value: interfaceType.methods.map((method) => adaptMethod(method, linkGenerator, baseHeadingLevel + 2))
481
- }
482
- });
483
- }
484
- function classTypeToClassSource(classType, linkGenerator, baseHeadingLevel = 1) {
485
- return __spreadProps$e(__spreadValues$e({
486
- type: "class"
487
- }, baseTypeAdapter(classType, linkGenerator, baseHeadingLevel)), {
488
- classModifier: classType.classModifier,
489
- sharingModifier: classType.sharingModifier,
490
- implements: classType.implemented_interfaces.map(linkGenerator),
491
- extends: classType.inheritanceChain.map(linkGenerator),
492
- methods: adaptMembers("Methods", classType.methods, adaptMethod, linkGenerator, baseHeadingLevel + 1),
493
- constructors: adaptMembers(
494
- "Constructors",
495
- classType.constructors,
496
- (constructor, linkGenerator2, baseHeadingLevel2) => adaptConstructor(classType.name, constructor, linkGenerator2, baseHeadingLevel2),
497
- linkGenerator,
498
- baseHeadingLevel + 1
499
- ),
500
- fields: adaptMembers(
501
- "Fields",
502
- classType.fields,
503
- adaptFieldOrProperty,
504
- linkGenerator,
505
- baseHeadingLevel + 1
506
- ),
507
- properties: adaptMembers(
508
- "Properties",
509
- classType.properties,
510
- adaptFieldOrProperty,
511
- linkGenerator,
512
- baseHeadingLevel + 1
513
- ),
514
- innerClasses: {
515
- headingLevel: baseHeadingLevel + 1,
516
- heading: "Classes",
517
- value: classType.classes.map(
518
- (innerClass) => classTypeToClassSource(__spreadProps$e(__spreadValues$e({}, innerClass), { inheritanceChain: [] }), linkGenerator, baseHeadingLevel + 2)
519
- )
520
- },
521
- innerEnums: {
522
- headingLevel: baseHeadingLevel + 1,
523
- heading: "Enums",
524
- value: classType.enums.map((innerEnum) => enumTypeToEnumSource(innerEnum, linkGenerator, baseHeadingLevel + 2))
525
- },
526
- innerInterfaces: {
527
- headingLevel: baseHeadingLevel + 1,
528
- heading: "Interfaces",
529
- value: classType.interfaces.map(
530
- (innerInterface) => interfaceTypeToInterfaceSource(innerInterface, linkGenerator, baseHeadingLevel + 2)
531
- )
532
- }
533
- });
534
- }
535
- function adaptMembers(heading, members, adapter, linkFromTypeNameGenerator, headingLevel) {
536
- return {
537
- headingLevel,
538
- heading,
539
- isGrouped: hasGroup(members),
540
- value: hasGroup(members) ? toGroupedMembers(members, adapter, linkFromTypeNameGenerator, headingLevel + 1) : toFlat(members, adapter, linkFromTypeNameGenerator, headingLevel + 1)
541
- };
542
- }
543
- function hasGroup(members) {
544
- return members.some((member) => member.group);
545
- }
546
- function toFlat(members, adapter, linkGenerator, baseHeadingLevel) {
547
- return members.map((member) => adapter(member, linkGenerator, baseHeadingLevel));
548
- }
549
- function toGroupedMembers(members, adapter, linkGenerator, baseHeadingLevel) {
550
- const groupedMembers = groupByGroupName(members);
551
- return Object.entries(groupedMembers).map(
552
- ([groupName, members2]) => singleGroup(baseHeadingLevel, groupName, adapter, members2, linkGenerator)
553
- );
554
- }
555
- function groupByGroupName(members) {
556
- return members.reduce(
557
- (acc, member) => {
558
- var _a, _b;
559
- const groupName = (_a = member.group) != null ? _a : "Other";
560
- acc[groupName] = (_b = acc[groupName]) != null ? _b : [];
561
- acc[groupName].push(member);
562
- return acc;
563
- },
564
- {}
565
- );
566
- }
567
- function singleGroup(headingLevel, groupName, adapter, members, linkGenerator) {
568
- return {
569
- headingLevel,
570
- heading: groupName,
571
- groupDescription: members[0].groupDescription,
572
- // All fields in the group have the same description
573
- value: toFlat(members, adapter, linkGenerator, headingLevel + 1)
574
- };
575
- }
576
-
577
- const generateLink = (strategy) => {
578
- switch (strategy) {
579
- case "relative":
580
- return generateRelativeLink;
581
- case "no-link":
582
- return generateNoLink;
583
- case "none":
584
- return returnReferenceAsIs;
585
- }
586
- };
587
- const generateRelativeLink = (references, from, referenceName) => {
588
- function getRelativePath(fromPath, toPath) {
589
- return path.relative(path.parse(path.join("/", fromPath)).dir, path.join("/", toPath));
590
- }
591
- const referenceTo = references[referenceName];
592
- if (!referenceTo) {
593
- return referenceName;
594
- }
595
- if (referenceTo && from === "__base__") {
596
- return {
597
- __type: "link",
598
- title: referenceTo.displayName,
599
- url: getRelativePath("", referenceTo.referencePath)
600
- };
601
- }
602
- const referenceFrom = references[from];
603
- if (!referenceFrom) {
604
- return referenceTo.displayName;
605
- }
606
- return {
607
- __type: "link",
608
- title: referenceTo.displayName,
609
- url: getRelativePath(referenceFrom.referencePath, referenceTo.referencePath)
610
- };
611
- };
612
- const generateNoLink = (references, _from, referenceName) => {
613
- const referenceTo = references[referenceName];
614
- return referenceTo ? referenceTo.displayName : referenceName;
615
- };
616
- const returnReferenceAsIs = (references, _from, referenceName) => {
617
- const referenceTo = references[referenceName];
618
- if (!referenceTo) {
619
- return referenceName;
620
- }
621
- return {
622
- __type: "link",
623
- title: referenceTo.displayName,
624
- url: referenceTo.referencePath
625
- };
626
- };
627
-
628
- function parsedFilesToRenderableBundle(config, parsedFiles, references) {
629
- const referenceFinder = apply(generateLink(config.linkingStrategy), references);
630
- function toReferenceGuide(parsedFiles2) {
631
- return parsedFiles2.reduce(
632
- addToReferenceGuide(apply(referenceFinder, "__base__"), config, references),
633
- {}
634
- );
635
- }
636
- function toRenderables(parsedFiles2) {
637
- return parsedFiles2.reduce((acc, parsedFile) => {
638
- const renderable = typeToRenderable(parsedFile, apply(referenceFinder, parsedFile.source.name), config);
639
- acc.push(renderable);
640
- return acc;
641
- }, []);
642
- }
643
- return {
644
- referencesByGroup: toReferenceGuide(parsedFiles),
645
- renderables: toRenderables(parsedFiles)
646
- };
647
- }
648
- function addToReferenceGuide(findLinkFromHome, config, references) {
649
- return (acc, parsedFile) => {
650
- var _a, _b;
651
- const group = getTypeGroup$1(parsedFile.type, config);
652
- if (!acc[group]) {
653
- acc[group] = [];
654
- }
655
- acc[group].push({
656
- reference: references[parsedFile.type.name],
657
- title: findLinkFromHome(parsedFile.type.name),
658
- description: (_b = adaptDescribable((_a = parsedFile.type.docComment) == null ? void 0 : _a.descriptionLines, findLinkFromHome).description) != null ? _b : null
659
- });
660
- return acc;
661
- };
662
- }
663
- function getTypeGroup$1(type, config) {
664
- var _a, _b;
665
- const groupAnnotation = (_a = type.docComment) == null ? void 0 : _a.annotations.find((annotation) => annotation.name.toLowerCase() === "group");
666
- return (_b = groupAnnotation == null ? void 0 : groupAnnotation.body) != null ? _b : config.defaultGroupName;
667
- }
668
-
669
- function parseApexMetadata(input) {
670
- return _function.pipe(input, parse, E__namespace.map(toMap));
671
- }
672
- function parse(input) {
673
- return E__namespace.tryCatch(() => new fastXmlParser.XMLParser().parse(input), E__namespace.toError);
674
- }
675
- function toMap(metadata) {
676
- const map = /* @__PURE__ */ new Map();
677
- map.set("apiVersion", String(metadata.ApexClass.apiVersion));
678
- if (metadata.ApexClass.status) {
679
- map.set("status", String(metadata.ApexClass.status));
680
- }
681
- return map;
682
- }
683
-
684
- var __defProp$d = Object.defineProperty;
685
- var __defProps$d = Object.defineProperties;
686
- var __getOwnPropDescs$d = Object.getOwnPropertyDescriptors;
687
- var __getOwnPropSymbols$d = Object.getOwnPropertySymbols;
688
- var __hasOwnProp$d = Object.prototype.hasOwnProperty;
689
- var __propIsEnum$d = Object.prototype.propertyIsEnumerable;
690
- var __defNormalProp$d = (obj, key, value) => key in obj ? __defProp$d(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
691
- var __spreadValues$d = (a, b) => {
692
- for (var prop in b || (b = {}))
693
- if (__hasOwnProp$d.call(b, prop))
694
- __defNormalProp$d(a, prop, b[prop]);
695
- if (__getOwnPropSymbols$d)
696
- for (var prop of __getOwnPropSymbols$d(b)) {
697
- if (__propIsEnum$d.call(b, prop))
698
- __defNormalProp$d(a, prop, b[prop]);
699
- }
700
- return a;
701
- };
702
- var __spreadProps$d = (a, b) => __defProps$d(a, __getOwnPropDescs$d(b));
703
- var __async$6 = (__this, __arguments, generator) => {
704
- return new Promise((resolve, reject) => {
705
- var fulfilled = (value) => {
706
- try {
707
- step(generator.next(value));
708
- } catch (e) {
709
- reject(e);
710
- }
711
- };
712
- var rejected = (value) => {
713
- try {
714
- step(generator.throw(value));
715
- } catch (e) {
716
- reject(e);
717
- }
718
- };
719
- var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
720
- step((generator = generator.apply(__this, __arguments)).next());
721
- });
722
- };
723
- class ReflectionErrors {
724
- constructor(errors) {
725
- this.errors = errors;
726
- this._tag = "ReflectionErrors";
727
- }
728
- }
729
- class ReflectionError {
730
- constructor(file, message) {
731
- this.file = file;
732
- this.message = message;
733
- }
734
- }
735
- function reflectAsync(rawSource) {
736
- return __async$6(this, null, function* () {
737
- return new Promise((resolve, reject) => {
738
- const result = apexReflection.reflect(rawSource);
739
- if (result.typeMirror) {
740
- return resolve(result.typeMirror);
741
- } else if (result.error) {
742
- return reject(result.error);
743
- } else {
744
- return reject(new Error("Unknown error"));
745
- }
746
- });
747
- });
748
- }
749
- function reflectBundles(apexBundles) {
750
- const semiGroupReflectionError = {
751
- concat: (x, y) => new ReflectionErrors([...x.errors, ...y.errors])
752
- };
753
- const Ap = TE__namespace.getApplicativeTaskValidation(T__namespace.ApplyPar, semiGroupReflectionError);
754
- return _function.pipe(apexBundles, A__namespace.traverse(Ap)(reflectBundle));
755
- }
756
- function reflectBundle(apexBundle) {
757
- const convertToParsedFile = apply(toParsedFile, apexBundle.filePath);
758
- const withMetadata = apply(addMetadata, apexBundle.metadataContent);
759
- return _function.pipe(apexBundle, reflectAsTask, TE__namespace.map(convertToParsedFile), TE__namespace.flatMap(withMetadata));
760
- }
761
- function reflectAsTask(apexBundle) {
762
- return TE__namespace.tryCatch(
763
- () => reflectAsync(apexBundle.content),
764
- (error) => new ReflectionErrors([new ReflectionError(apexBundle.filePath, error.message)])
765
- );
766
- }
767
- function toParsedFile(filePath, typeMirror) {
768
- return {
769
- source: {
770
- filePath,
771
- name: typeMirror.name,
772
- type: typeMirror.type_name
773
- },
774
- type: typeMirror
775
- };
776
- }
777
- function addMetadata(rawMetadataContent, parsedFile) {
778
- return TE__namespace.fromEither(
779
- _function.pipe(
780
- parsedFile.type,
781
- (type) => addFileMetadataToTypeAnnotation(type, rawMetadataContent),
782
- E__namespace.map((type) => __spreadProps$d(__spreadValues$d({}, parsedFile), { type })),
783
- E__namespace.mapLeft((error) => errorToReflectionErrors(error, parsedFile.source.filePath))
784
- )
785
- );
786
- }
787
- function errorToReflectionErrors(error, filePath) {
788
- return new ReflectionErrors([new ReflectionError(filePath, error.message)]);
789
- }
790
- function addFileMetadataToTypeAnnotation(type, metadata) {
791
- const concatAnnotationToType = apply(concatAnnotations, type);
792
- return _function.pipe(
793
- O__namespace.fromNullable(metadata),
794
- O__namespace.map(concatAnnotationToType),
795
- O__namespace.getOrElse(() => E__namespace.right(type))
796
- );
797
- }
798
- function concatAnnotations(type, metadataInput) {
799
- return _function.pipe(
800
- metadataInput,
801
- parseApexMetadata,
802
- E__namespace.map((metadataMap) => __spreadProps$d(__spreadValues$d({}, type), {
803
- annotations: [...type.annotations, ...mapToAnnotations(metadataMap)]
804
- }))
805
- );
806
- }
807
- function mapToAnnotations(metadata) {
808
- return Array.from(metadata.entries()).map(([key, value]) => {
809
- const declaration = `${key}: ${value}`;
810
- return {
811
- name: declaration,
812
- type: declaration,
813
- rawDeclaration: declaration
814
- };
815
- });
816
- }
817
-
818
- function createInheritanceChain(repository, classMirror) {
819
- return _function.pipe(
820
- O__namespace.fromNullable(classMirror.extended_class),
821
- O__namespace.match(
822
- () => [],
823
- (extendedClassName) => inheritanceChainFromParentClassName(repository, extendedClassName)
824
- )
825
- );
826
- }
827
- function inheritanceChainFromParentClassName(repository, className) {
828
- return _function.pipe(
829
- O__namespace.fromNullable(repository.find((type) => type.name.toLowerCase() === className.toLowerCase())),
830
- O__namespace.match(
831
- () => [className],
832
- (extendedClass) => [className, ...createInheritanceChain(repository, extendedClass)]
833
- )
834
- );
835
- }
836
-
837
- const parsedFilesToTypes = (parsedFiles) => parsedFiles.map((parsedFile) => parsedFile.type);
838
-
839
- var __defProp$c = Object.defineProperty;
840
- var __defProps$c = Object.defineProperties;
841
- var __getOwnPropDescs$c = Object.getOwnPropertyDescriptors;
842
- var __getOwnPropSymbols$c = Object.getOwnPropertySymbols;
843
- var __hasOwnProp$c = Object.prototype.hasOwnProperty;
844
- var __propIsEnum$c = Object.prototype.propertyIsEnumerable;
845
- var __defNormalProp$c = (obj, key, value) => key in obj ? __defProp$c(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
846
- var __spreadValues$c = (a, b) => {
847
- for (var prop in b || (b = {}))
848
- if (__hasOwnProp$c.call(b, prop))
849
- __defNormalProp$c(a, prop, b[prop]);
850
- if (__getOwnPropSymbols$c)
851
- for (var prop of __getOwnPropSymbols$c(b)) {
852
- if (__propIsEnum$c.call(b, prop))
853
- __defNormalProp$c(a, prop, b[prop]);
854
- }
855
- return a;
856
- };
857
- var __spreadProps$c = (a, b) => __defProps$c(a, __getOwnPropDescs$c(b));
858
- const addInheritanceChainToTypes = (parsedFiles) => parsedFiles.map((parsedFile) => __spreadProps$c(__spreadValues$c({}, parsedFile), {
859
- type: addInheritanceChain(parsedFile.type, parsedFilesToTypes(parsedFiles))
860
- }));
861
- function addInheritanceChain(current, repository) {
862
- if (current.type_name === "enum" || current.type_name === "interface") {
863
- return current;
864
- } else {
865
- const inheritanceChain = createInheritanceChain(repository, current);
866
- return __spreadProps$c(__spreadValues$c({}, current), {
867
- inheritanceChain
868
- });
869
- }
870
- }
871
-
872
- var __defProp$b = Object.defineProperty;
873
- var __defProps$b = Object.defineProperties;
874
- var __getOwnPropDescs$b = Object.getOwnPropertyDescriptors;
875
- var __getOwnPropSymbols$b = Object.getOwnPropertySymbols;
876
- var __hasOwnProp$b = Object.prototype.hasOwnProperty;
877
- var __propIsEnum$b = Object.prototype.propertyIsEnumerable;
878
- var __defNormalProp$b = (obj, key, value) => key in obj ? __defProp$b(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
879
- var __spreadValues$b = (a, b) => {
880
- for (var prop in b || (b = {}))
881
- if (__hasOwnProp$b.call(b, prop))
882
- __defNormalProp$b(a, prop, b[prop]);
883
- if (__getOwnPropSymbols$b)
884
- for (var prop of __getOwnPropSymbols$b(b)) {
885
- if (__propIsEnum$b.call(b, prop))
886
- __defNormalProp$b(a, prop, b[prop]);
887
- }
888
- return a;
889
- };
890
- var __spreadProps$b = (a, b) => __defProps$b(a, __getOwnPropDescs$b(b));
891
- const addInheritedMembersToTypes = (parsedFiles) => parsedFiles.map((parsedFile) => addInheritedMembers(parsedFilesToTypes(parsedFiles), parsedFile));
892
- function addInheritedMembers(repository, parsedFile) {
893
- function addInheritedMembersToType(repository2, current) {
894
- if (current.type_name === "enum") {
895
- return current;
896
- } else if (current.type_name === "interface") {
897
- return addInheritedInterfaceMethods(current, repository2);
898
- } else {
899
- return addInheritedClassMembers(current, repository2);
900
- }
901
- }
902
- return __spreadProps$b(__spreadValues$b({}, parsedFile), {
903
- type: addInheritedMembersToType(repository, parsedFile.type)
904
- });
905
- }
906
- function addInheritedInterfaceMethods(interfaceMirror, repository) {
907
- function methodAlreadyExists(memberName, members) {
908
- return members.some((member) => member.name.toLowerCase() === memberName.toLowerCase());
909
- }
910
- function parentExtractor(interfaceMirror2) {
911
- return interfaceMirror2.extended_interfaces;
912
- }
913
- const parents = getParents(parentExtractor, interfaceMirror, repository);
914
- return __spreadProps$b(__spreadValues$b({}, interfaceMirror), {
915
- methods: parents.reduce(
916
- (acc, currentValue) => [
917
- ...acc,
918
- ...currentValue.methods.filter((method) => !methodAlreadyExists(method.name, acc)).map((method) => __spreadProps$b(__spreadValues$b({}, method), {
919
- inherited: true
920
- }))
921
- ],
922
- interfaceMirror.methods
923
- )
924
- });
925
- }
926
- function addInheritedClassMembers(classMirror, repository) {
927
- function memberAlreadyExists(memberName, members) {
928
- return members.some((member) => member.name.toLowerCase() === memberName.toLowerCase());
929
- }
930
- function parentExtractor(classMirror2) {
931
- return classMirror2.extended_class ? [classMirror2.extended_class] : [];
932
- }
933
- function filterMember(members, existing) {
934
- return members.filter((member) => member.access_modifier.toLowerCase() !== "private").filter((member) => !memberAlreadyExists(member.name, existing)).map((member) => __spreadProps$b(__spreadValues$b({}, member), {
935
- inherited: true
936
- }));
937
- }
938
- const parents = getParents(parentExtractor, classMirror, repository);
939
- return __spreadProps$b(__spreadValues$b({}, classMirror), {
940
- fields: parents.reduce(
941
- (acc, currentValue) => [...acc, ...filterMember(currentValue.fields, acc)],
942
- classMirror.fields
943
- ),
944
- properties: parents.reduce(
945
- (acc, currentValue) => [...acc, ...filterMember(currentValue.properties, acc)],
946
- classMirror.properties
947
- ),
948
- methods: parents.reduce(
949
- (acc, currentValue) => [...acc, ...filterMember(currentValue.methods, acc)],
950
- classMirror.methods
951
- )
952
- });
953
- }
954
- function getParents(extendedNamesExtractor, current, repository) {
955
- return _function.pipe(
956
- extendedNamesExtractor(current),
957
- (interfaces) => interfaces.map((interfaceName) => repository.find((type) => type.name === interfaceName)),
958
- (interfaces = []) => interfaces.filter((type) => type !== void 0),
959
- (interfaces) => interfaces.reduce(
960
- (acc, current2) => [...acc, ...getParents(extendedNamesExtractor, current2, repository)],
961
- interfaces
962
- )
963
- );
964
- }
965
-
966
- const typeDocPartial = `
967
- {{#> documentablePartialTemplate}}
968
-
969
- {{#if doc.group}}
970
- **Group** {{doc.group}}
971
- {{/if}}
972
-
973
- {{#if doc.author}}
974
- **Author** {{doc.author}}
975
- {{/if}}
976
-
977
- {{#if doc.date}}
978
- **Date** {{doc.date}}
979
- {{/if}}
980
-
981
- {{#each doc.sees}}
982
- **See** {{link this}}
983
-
984
- {{/each}}
985
-
986
- {{#if namespace}}
987
- ## Namespace
988
- {{namespace}}
989
- {{/if}}
990
-
991
- {{/documentablePartialTemplate}}
992
- `.trim();
993
-
994
- const documentablePartialTemplate = `
995
- {{#each doc.annotations}}
996
- \`{{this}}\`
997
- {{/each}}
998
-
999
- {{{renderContent doc.description}}}
1000
-
1001
- {{#each doc.customTags}}
1002
- **{{splitAndCapitalize name}}**
1003
-
1004
- {{{renderContent description}}}
1005
-
1006
- {{/each}}
1007
-
1008
- {{> @partial-block}}
1009
-
1010
- {{#if doc.mermaid.value}}
1011
- {{ heading doc.mermaid.headingLevel doc.mermaid.heading }}
1012
- {{code doc.mermaid.value}}
1013
- {{/if}}
1014
-
1015
- {{#if doc.example.value}}
1016
- {{ heading doc.example.headingLevel doc.example.heading }}
1017
- {{{renderContent doc.example.value}}}
1018
- {{/if}}
1019
- `.trim();
1020
-
1021
- const methodsPartialTemplate = `
1022
- {{ heading headingLevel heading }}
1023
- {{#each value}}
1024
- {{{ heading headingLevel (inlineCode heading) }}}
1025
-
1026
- {{#if inherited}}
1027
- *Inherited*
1028
- {{/if}}
1029
-
1030
- {{#> documentablePartialTemplate}}
1031
-
1032
- {{ heading signature.headingLevel signature.heading }}
1033
- {{ code signature.value }}
1034
-
1035
- {{#if parameters.value}}
1036
- {{ heading parameters.headingLevel parameters.heading }}
1037
- | Name | Type | Description |
1038
- |------|------|-------------|
1039
- {{#each parameters.value}}
1040
- | {{name}} | {{link type}} | {{{renderContent description}}} |
1041
- {{/each}}
1042
- {{/if}}
1043
-
1044
- {{ heading returnType.headingLevel returnType.heading }}
1045
- **{{link returnType.value.type}}**
1046
-
1047
- {{#if returnType.value.description}}
1048
- {{returnType.value.description}}
1049
- {{/if}}
1050
-
1051
- {{#if throws.value}}
1052
- {{ heading throws.headingLevel throws.heading }}
1053
- {{#each throws.value}}
1054
- {{link this.type}}: {{this.description}}
1055
-
1056
- {{/each}}
1057
- {{/if}}
1058
- {{/documentablePartialTemplate}}
1059
-
1060
- {{#unless @last}}---{{/unless}}
1061
-
1062
- {{/each}}
1063
- `.trim();
1064
-
1065
- const groupedMembersPartialTemplate = `
1066
- {{ heading headingLevel heading }}
1067
- {{#each value}}
1068
- {{> (lookup .. "subTemplate") this}}
1069
- {{/each}}
1070
- `.trim();
1071
-
1072
- const constructorsPartialTemplate = `
1073
- {{ heading headingLevel heading }}
1074
- {{#each value}}
1075
- {{{ heading headingLevel (inlineCode heading) }}}
1076
-
1077
- {{#> documentablePartialTemplate}}
1078
-
1079
- {{ heading signature.headingLevel signature.heading }}
1080
- {{ code signature.value }}
1081
-
1082
- {{#if parameters.value}}
1083
- {{ heading parameters.headingLevel parameters.heading }}
1084
- | Name | Type | Description |
1085
- |------|------|-------------|
1086
- {{#each parameters.value}}
1087
- | {{name}} | {{link type}} | {{description}} |
1088
- {{/each}}
1089
- {{/if}}
1090
-
1091
- {{#if throws.value}}
1092
- {{ heading throws.headingLevel throws.heading }}
1093
- {{#each throws.value}}
1094
- {{link this.type}}: {{this.description}}
1095
-
1096
- {{/each}}
1097
- {{/if}}
1098
- {{/documentablePartialTemplate}}
1099
-
1100
- {{#unless @last}}---{{/unless}}
1101
-
1102
- {{/each}}
1103
- `.trim();
1104
-
1105
- const fieldsPartialTemplate = `
1106
- {{ heading headingLevel heading }}
1107
- {{#each value}}
1108
- {{{ heading headingLevel (inlineCode heading) }}}
1109
-
1110
- {{#if inherited}}
1111
- *Inherited*
1112
- {{/if}}
1113
-
1114
- {{#> documentablePartialTemplate }}
1115
-
1116
- {{ heading signature.headingLevel signature.heading }}
1117
- {{ code signature.value }}
1118
-
1119
- {{ heading type.headingLevel type.heading }}
1120
- {{link type.value}}
1121
-
1122
- {{/documentablePartialTemplate}}
1123
-
1124
- {{#unless @last}}---{{/unless}}
1125
-
1126
- {{/each}}
1127
- `.trim();
1128
-
1129
- const classMarkdownTemplate = `
1130
- {{ heading headingLevel heading }}
1131
- {{#if classModifier}}
1132
- \`{{classModifier}}\`
1133
- {{/if}}
1134
-
1135
- {{> typeDocumentation}}
1136
-
1137
- {{#if extends.length}}
1138
- **Inheritance**
1139
-
1140
- {{#each extends}}{{link this}}{{#unless @last}} < {{/unless}}{{/each}}
1141
- {{/if}}
1142
-
1143
- {{#if implements}}
1144
- **Implements**
1145
-
1146
- {{#each implements}}
1147
- {{link this}}{{#unless @last}}, {{/unless}}
1148
- {{/each}}
1149
- {{/if}}
1150
-
1151
- {{#if fields.value}}
1152
- {{#if fields.isGrouped}}
1153
- {{> groupedMembersPartialTemplate fields subTemplate="fieldsPartialTemplate"}}
1154
- {{else}}
1155
- {{> fieldsPartialTemplate fields}}
1156
- {{/if}}
1157
- {{/if}}
1158
-
1159
- {{#if properties.value}}
1160
- {{#if properties.isGrouped}}
1161
- {{> groupedMembersPartialTemplate properties subTemplate="fieldsPartialTemplate"}}
1162
- {{else}}
1163
- {{> fieldsPartialTemplate properties}}
1164
- {{/if}}
1165
- {{/if}}
1166
-
1167
- {{#if constructors.value}}
1168
- {{#if constructors.isGrouped}}
1169
- {{> groupedMembersPartialTemplate constructors subTemplate="constructorsPartialTemplate"}}
1170
- {{else}}
1171
- {{> constructorsPartialTemplate constructors}}
1172
- {{/if}}
1173
- {{/if}}
1174
-
1175
- {{#if methods.value}}
1176
- {{#if methods.isGrouped}}
1177
- {{> groupedMembersPartialTemplate methods subTemplate="methodsPartialTemplate"}}
1178
- {{else}}
1179
- {{> methodsPartialTemplate methods}}
1180
- {{/if}}
1181
- {{/if}}
1182
-
1183
- {{#if innerClasses.value}}
1184
- {{ heading innerClasses.headingLevel innerClasses.heading }}
1185
- {{#each innerClasses.value}}
1186
- {{> classTemplate this}}
1187
- {{/each}}
1188
- {{/if}}
1189
-
1190
- {{#if innerEnums.value}}
1191
- {{ heading innerEnums.headingLevel innerEnums.heading }}
1192
- {{#each innerEnums.value}}
1193
- {{> enumTemplate this}}
1194
- {{/each}}
1195
- {{/if}}
1196
-
1197
- {{#if innerInterfaces.value}}
1198
- {{ heading innerInterfaces.headingLevel innerInterfaces.heading }}
1199
- {{#each innerInterfaces.value}}
1200
- {{> interfaceTemplate this}}
1201
- {{/each}}
1202
- {{/if}}
1203
- `.trim();
1204
-
1205
- const enumMarkdownTemplate = `
1206
- {{ heading headingLevel heading }}
1207
-
1208
- {{> typeDocumentation }}
1209
-
1210
- {{ heading values.headingLevel values.heading }}
1211
- | Value | Description |
1212
- |-------|-------------|
1213
- {{#each values.value}}
1214
- | {{value}} | {{description}} |
1215
- {{/each}}
1216
- `.trim();
1217
-
1218
- const interfaceMarkdownTemplate = `
1219
- {{ heading headingLevel heading }}
1220
-
1221
- {{> typeDocumentation }}
1222
-
1223
- {{#if extends}}
1224
- **Extends**
1225
- {{#each extends}}
1226
- {{link this}}{{#unless @last}}, {{/unless}}
1227
- {{/each}}
1228
- {{/if}}
1229
-
1230
- {{#if methods}}
1231
- {{> methodsPartialTemplate methods}}
1232
- {{/if}}
1233
- `.trim();
1234
-
1235
- class Template {
1236
- constructor() {
1237
- Handlebars.registerPartial("typeDocumentation", typeDocPartial);
1238
- Handlebars.registerPartial("documentablePartialTemplate", documentablePartialTemplate);
1239
- Handlebars.registerPartial("methodsPartialTemplate", methodsPartialTemplate);
1240
- Handlebars.registerPartial("constructorsPartialTemplate", constructorsPartialTemplate);
1241
- Handlebars.registerPartial("groupedMembersPartialTemplate", groupedMembersPartialTemplate);
1242
- Handlebars.registerPartial("fieldsPartialTemplate", fieldsPartialTemplate);
1243
- Handlebars.registerPartial("classTemplate", classMarkdownTemplate);
1244
- Handlebars.registerPartial("enumTemplate", enumMarkdownTemplate);
1245
- Handlebars.registerPartial("interfaceTemplate", interfaceMarkdownTemplate);
1246
- Handlebars.registerHelper("link", link);
1247
- Handlebars.registerHelper("code", convertCodeBlock);
1248
- Handlebars.registerHelper("renderContent", resolveRenderableContent);
1249
- Handlebars.registerHelper("heading", heading);
1250
- Handlebars.registerHelper("inlineCode", inlineCode);
1251
- Handlebars.registerHelper("splitAndCapitalize", splitAndCapitalize);
1252
- }
1253
- static getInstance() {
1254
- if (!Template.instance) {
1255
- Template.instance = new Template();
1256
- }
1257
- return Template.instance;
1258
- }
1259
- compile(request) {
1260
- const compiled = Handlebars.compile(request.template);
1261
- return compiled(request.source).trim().replace(/\n{3,}/g, "\n\n");
1262
- }
1263
- }
1264
- const splitAndCapitalize = (text) => {
1265
- const words = text.split(/[-_]+/);
1266
- const capitalizedWords = [];
1267
- for (const word of words) {
1268
- capitalizedWords.push(word.charAt(0).toUpperCase() + word.slice(1));
1269
- }
1270
- return capitalizedWords.join(" ");
1271
- };
1272
- const heading = (level, text) => {
1273
- return `${"#".repeat(level)} ${text}`;
1274
- };
1275
- const inlineCode = (text) => {
1276
- return new Handlebars.SafeString(`\`${text}\``);
1277
- };
1278
- const convertCodeBlock = (codeBlock) => {
1279
- return new Handlebars.SafeString(
1280
- `
1281
- \`\`\`${codeBlock.language}
1282
- ${codeBlock.content.join("\n")}
1283
- \`\`\`
1284
- `.trim()
1285
- );
1286
- };
1287
- const resolveRenderableContent = (description) => {
1288
- if (!description) {
1289
- return "";
1290
- }
1291
- function reduceDescription(acc, curr) {
1292
- if (isEmptyLine(curr)) {
1293
- return acc + "\n";
1294
- }
1295
- if (isCodeBlock(curr)) {
1296
- return acc + convertCodeBlock(curr) + "\n";
1297
- }
1298
- if (isInlineCode(curr)) {
1299
- return acc + inlineCode(curr.content).toString() + " ";
1300
- } else {
1301
- return acc + Handlebars.escapeExpression(link(curr)).trim() + " ";
1302
- }
1303
- }
1304
- return description.reduce(reduceDescription, "").trim();
1305
- };
1306
- const link = (source) => {
1307
- if (typeof source === "string") {
1308
- return source;
1309
- } else {
1310
- return `[${source.title}](${source.url})`;
1311
- }
1312
- };
1313
-
1314
- const convertToDocumentationBundle = (referenceGuideTemplate, { referencesByGroup, renderables }) => ({
1315
- referenceGuide: {
1316
- frontmatter: null,
1317
- content: referencesToReferenceGuideContent(referencesByGroup, referenceGuideTemplate),
1318
- outputDocPath: "index.md"
1319
- },
1320
- docs: renderables.map(
1321
- (renderable) => renderableToPageData(Object.values(referencesByGroup).flat(), renderable)
1322
- )
1323
- });
1324
- function referencesToReferenceGuideContent(references, template) {
1325
- function alphabetizeReferences(references2) {
1326
- return Object.keys(references2).sort((a, b) => a.localeCompare(b)).reduce((acc, key) => {
1327
- acc[key] = references2[key].sort((a, b) => a.title.toString().localeCompare(b.title.toString()));
1328
- return acc;
1329
- }, {});
1330
- }
1331
- return _function.pipe(
1332
- references,
1333
- alphabetizeReferences,
1334
- (references2) => compile({
1335
- template,
1336
- source: references2
1337
- })
1338
- );
1339
- }
1340
- function renderableToPageData(referenceGuideReference, renderable) {
1341
- function buildDocOutput(renderable2, docContents) {
1342
- var _a;
1343
- const reference = referenceGuideReference.find(
1344
- (ref) => ref.reference.source.name.toLowerCase() === renderable2.name.toLowerCase()
1345
- );
1346
- return {
1347
- source: {
1348
- filePath: renderable2.filePath,
1349
- name: renderable2.name,
1350
- type: renderable2.type
1351
- },
1352
- outputDocPath: reference.reference.outputDocPath,
1353
- frontmatter: null,
1354
- content: docContents,
1355
- group: (_a = renderable2.doc.group) != null ? _a : defaults.defaults.defaultGroupName
1356
- };
1357
- }
1358
- return _function.pipe(renderable, resolveApexTypeTemplate, compile, (docContents) => buildDocOutput(renderable, docContents));
1359
- }
1360
- function resolveApexTypeTemplate(renderable) {
1361
- function getTemplate(renderable2) {
1362
- switch (renderable2.type) {
1363
- case "enum":
1364
- return enumMarkdownTemplate;
1365
- case "interface":
1366
- return interfaceMarkdownTemplate;
1367
- case "class":
1368
- return classMarkdownTemplate;
1369
- }
1370
- }
1371
- return {
1372
- template: getTemplate(renderable),
1373
- source: renderable
1374
- };
1375
- }
1376
- function compile(request) {
1377
- return Template.getInstance().compile(request);
1378
- }
1379
-
1380
- var __defProp$a = Object.defineProperty;
1381
- var __defProps$a = Object.defineProperties;
1382
- var __getOwnPropDescs$a = Object.getOwnPropertyDescriptors;
1383
- var __getOwnPropSymbols$a = Object.getOwnPropertySymbols;
1384
- var __hasOwnProp$a = Object.prototype.hasOwnProperty;
1385
- var __propIsEnum$a = Object.prototype.propertyIsEnumerable;
1386
- var __defNormalProp$a = (obj, key, value) => key in obj ? __defProp$a(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
1387
- var __spreadValues$a = (a, b) => {
1388
- for (var prop in b || (b = {}))
1389
- if (__hasOwnProp$a.call(b, prop))
1390
- __defNormalProp$a(a, prop, b[prop]);
1391
- if (__getOwnPropSymbols$a)
1392
- for (var prop of __getOwnPropSymbols$a(b)) {
1393
- if (__propIsEnum$a.call(b, prop))
1394
- __defNormalProp$a(a, prop, b[prop]);
1395
- }
1396
- return a;
1397
- };
1398
- var __spreadProps$a = (a, b) => __defProps$a(a, __getOwnPropDescs$a(b));
1399
- class Manifest {
1400
- /**
1401
- * Constructs a new Manifest object.
1402
- * @param types List of types to be wrapped by this object.
1403
- * @param isForInnerTypes Whether this manifest represent an inner type or not.
1404
- */
1405
- constructor(types, isForInnerTypes = false) {
1406
- this.types = types;
1407
- this.isForInnerTypes = isForInnerTypes;
1408
- }
1409
- filteredByAccessModifierAndAnnotations(modifiers) {
1410
- const filteredTypes = Manifest.filterAccessibleModifier(this.types, modifiers);
1411
- const typesToReturn = [];
1412
- for (const filteredType of filteredTypes) {
1413
- typesToReturn.push(Manifest.filterSingleType(filteredType, modifiers, this.isForInnerTypes));
1414
- }
1415
- return typesToReturn;
1416
- }
1417
- static filterSingleType(currentType, modifiers, isForInnerTypes) {
1418
- if (currentType.type_name === "enum") {
1419
- return currentType;
1420
- }
1421
- if (currentType.type_name === "interface") {
1422
- const currentInterface = currentType;
1423
- return __spreadProps$a(__spreadValues$a({}, currentType), {
1424
- methods: this.filterAccessibleModifier(currentInterface.methods, modifiers)
1425
- });
1426
- }
1427
- const currentClass = currentType;
1428
- const filteredClass = __spreadProps$a(__spreadValues$a({}, currentType), {
1429
- methods: this.filterAccessibleModifier(currentClass.methods, modifiers),
1430
- properties: this.filterAccessibleModifier(currentClass.properties, modifiers),
1431
- fields: this.filterAccessibleModifier(currentClass.fields, modifiers),
1432
- constructors: this.filterAccessibleModifier(currentClass.constructors, modifiers)
1433
- });
1434
- if (!isForInnerTypes) {
1435
- return __spreadProps$a(__spreadValues$a({}, filteredClass), {
1436
- enums: this.filterAccessibleModifier(currentClass.enums, modifiers),
1437
- interfaces: this.filterAccessibleModifier(currentClass.interfaces, modifiers),
1438
- classes: new Manifest(currentClass.classes, true).filteredByAccessModifierAndAnnotations(
1439
- modifiers
1440
- )
1441
- });
1442
- }
1443
- return filteredClass;
1444
- }
1445
- static filterAccessibleModifier(accessAndDocAware, modifiers) {
1446
- return accessAndDocAware.filter((type) => this.shouldFilterType(type, modifiers));
1447
- }
1448
- static shouldFilterType(accessAndDocAware, modifiers) {
1449
- var _a;
1450
- const hasIgnoreDocAnnotation = (_a = accessAndDocAware.docComment) == null ? void 0 : _a.annotations.some(
1451
- (annotation) => annotation.name.toLowerCase() === "ignore"
1452
- );
1453
- if (hasIgnoreDocAnnotation) {
1454
- return false;
1455
- }
1456
- return modifiers.includes(accessAndDocAware.access_modifier) || accessAndDocAware.annotations.some((annotation) => modifiers.includes(annotation.type.toLowerCase()));
1457
- }
1458
- }
1459
-
1460
- var __defProp$9 = Object.defineProperty;
1461
- var __defProps$9 = Object.defineProperties;
1462
- var __getOwnPropDescs$9 = Object.getOwnPropertyDescriptors;
1463
- var __getOwnPropSymbols$9 = Object.getOwnPropertySymbols;
1464
- var __hasOwnProp$9 = Object.prototype.hasOwnProperty;
1465
- var __propIsEnum$9 = Object.prototype.propertyIsEnumerable;
1466
- var __defNormalProp$9 = (obj, key, value) => key in obj ? __defProp$9(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
1467
- var __spreadValues$9 = (a, b) => {
1468
- for (var prop in b || (b = {}))
1469
- if (__hasOwnProp$9.call(b, prop))
1470
- __defNormalProp$9(a, prop, b[prop]);
1471
- if (__getOwnPropSymbols$9)
1472
- for (var prop of __getOwnPropSymbols$9(b)) {
1473
- if (__propIsEnum$9.call(b, prop))
1474
- __defNormalProp$9(a, prop, b[prop]);
1475
- }
1476
- return a;
1477
- };
1478
- var __spreadProps$9 = (a, b) => __defProps$9(a, __getOwnPropDescs$9(b));
1479
- function filterScope(scopes, parsedFiles) {
1480
- return parsedFiles.filter(({ type }) => Manifest.shouldFilterType(type, scopes)).map((parsedFile) => {
1481
- return __spreadProps$9(__spreadValues$9({}, parsedFile), {
1482
- type: Manifest.filterSingleType(parsedFile.type, scopes, false)
1483
- });
1484
- });
1485
- }
1486
-
1487
- const hookableTemplate = `
1488
- {{#if frontmatter}}
1489
- {{{frontmatter}}}
1490
- {{/if}}
1491
-
1492
- {{{content}}}
1493
- `.trim();
1494
-
1495
- var __defProp$8 = Object.defineProperty;
1496
- var __defProps$8 = Object.defineProperties;
1497
- var __getOwnPropDescs$8 = Object.getOwnPropertyDescriptors;
1498
- var __getOwnPropSymbols$8 = Object.getOwnPropertySymbols;
1499
- var __hasOwnProp$8 = Object.prototype.hasOwnProperty;
1500
- var __propIsEnum$8 = Object.prototype.propertyIsEnumerable;
1501
- var __defNormalProp$8 = (obj, key, value) => key in obj ? __defProp$8(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
1502
- var __spreadValues$8 = (a, b) => {
1503
- for (var prop in b || (b = {}))
1504
- if (__hasOwnProp$8.call(b, prop))
1505
- __defNormalProp$8(a, prop, b[prop]);
1506
- if (__getOwnPropSymbols$8)
1507
- for (var prop of __getOwnPropSymbols$8(b)) {
1508
- if (__propIsEnum$8.call(b, prop))
1509
- __defNormalProp$8(a, prop, b[prop]);
1510
- }
1511
- return a;
1512
- };
1513
- var __spreadProps$8 = (a, b) => __defProps$8(a, __getOwnPropDescs$8(b));
1514
- function sortMembers(shouldSortMembers, parsedFiles) {
1515
- return parsedFiles.map((parsedFile) => __spreadProps$8(__spreadValues$8({}, parsedFile), {
1516
- type: sortTypeMember(parsedFile.type, shouldSortMembers)
1517
- }));
1518
- }
1519
- function sortByNames(shouldSort, a, b) {
1520
- if (shouldSort) {
1521
- return a.name.localeCompare(b.name);
1522
- }
1523
- return 0;
1524
- }
1525
- function sortNamed(shouldSort, items) {
1526
- return items.sort((a, b) => sortByNames(shouldSort, a, b));
1527
- }
1528
- function sortTypeMember(type, shouldSort) {
1529
- switch (type.type_name) {
1530
- case "enum":
1531
- return sortEnumValues(shouldSort, type);
1532
- case "interface":
1533
- return sortInterfaceMethods(shouldSort, type);
1534
- case "class":
1535
- return sortClassMembers(shouldSort, type);
1536
- }
1537
- }
1538
- function sortEnumValues(shouldSort, enumType) {
1539
- return __spreadProps$8(__spreadValues$8({}, enumType), {
1540
- values: sortNamed(shouldSort, enumType.values)
1541
- });
1542
- }
1543
- function sortInterfaceMethods(shouldSort, interfaceType) {
1544
- return __spreadProps$8(__spreadValues$8({}, interfaceType), {
1545
- methods: sortNamed(shouldSort, interfaceType.methods)
1546
- });
1547
- }
1548
- function sortClassMembers(shouldSort, classType) {
1549
- return __spreadProps$8(__spreadValues$8({}, classType), {
1550
- fields: sortNamed(shouldSort, classType.fields),
1551
- classes: sortNamed(shouldSort, classType.classes),
1552
- enums: sortNamed(shouldSort, classType.enums),
1553
- interfaces: sortNamed(shouldSort, classType.interfaces),
1554
- methods: sortNamed(shouldSort, classType.methods),
1555
- properties: sortNamed(shouldSort, classType.properties)
1556
- });
1557
- }
1558
-
1559
- function isSkip(value) {
1560
- return Object.prototype.hasOwnProperty.call(value, "_tag") && value._tag === "Skip";
1561
- }
1562
-
1563
- function parsedFilesToReferenceGuide(config, parsedFiles) {
1564
- return parsedFiles.reduce((acc, parsedFile) => {
1565
- acc[parsedFile.type.name] = parsedFileToDocPageReference(config, parsedFile);
1566
- return acc;
1567
- }, {});
1568
- }
1569
- function parsedFileToDocPageReference(config, parsedFile) {
1570
- const path = `${slugify(getTypeGroup(parsedFile.type, config))}/${parsedFile.type.name}.md`;
1571
- return {
1572
- source: parsedFile.source,
1573
- displayName: parsedFile.type.name,
1574
- outputDocPath: path,
1575
- referencePath: path
1576
- };
1577
- }
1578
- function getTypeGroup(type, config) {
1579
- var _a, _b;
1580
- const groupAnnotation = (_a = type.docComment) == null ? void 0 : _a.annotations.find((annotation) => annotation.name.toLowerCase() === "group");
1581
- return (_b = groupAnnotation == null ? void 0 : groupAnnotation.body) != null ? _b : config.defaultGroupName;
1582
- }
1583
- function slugify(text) {
1584
- return text.toLowerCase().replace(/[^a-z0-9\s-]/g, "").trim().replace(/\s+/g, "-").replace(/-+/g, "-");
1585
- }
1586
-
1587
- var __defProp$7 = Object.defineProperty;
1588
- var __defProps$7 = Object.defineProperties;
1589
- var __getOwnPropDescs$7 = Object.getOwnPropertyDescriptors;
1590
- var __getOwnPropSymbols$7 = Object.getOwnPropertySymbols;
1591
- var __hasOwnProp$7 = Object.prototype.hasOwnProperty;
1592
- var __propIsEnum$7 = Object.prototype.propertyIsEnumerable;
1593
- var __defNormalProp$7 = (obj, key, value) => key in obj ? __defProp$7(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
1594
- var __spreadValues$7 = (a, b) => {
1595
- for (var prop in b || (b = {}))
1596
- if (__hasOwnProp$7.call(b, prop))
1597
- __defNormalProp$7(a, prop, b[prop]);
1598
- if (__getOwnPropSymbols$7)
1599
- for (var prop of __getOwnPropSymbols$7(b)) {
1600
- if (__propIsEnum$7.call(b, prop))
1601
- __defNormalProp$7(a, prop, b[prop]);
1602
- }
1603
- return a;
1604
- };
1605
- var __spreadProps$7 = (a, b) => __defProps$7(a, __getOwnPropDescs$7(b));
1606
- var __async$5 = (__this, __arguments, generator) => {
1607
- return new Promise((resolve, reject) => {
1608
- var fulfilled = (value) => {
1609
- try {
1610
- step(generator.next(value));
1611
- } catch (e) {
1612
- reject(e);
1613
- }
1614
- };
1615
- var rejected = (value) => {
1616
- try {
1617
- step(generator.throw(value));
1618
- } catch (e) {
1619
- reject(e);
1620
- }
1621
- };
1622
- var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
1623
- step((generator = generator.apply(__this, __arguments)).next());
1624
- });
1625
- };
1626
- class HookError {
1627
- constructor(error) {
1628
- this.error = error;
1629
- this._tag = "HookError";
1630
- }
1631
- }
1632
- function generateDocs(apexBundles, config) {
1633
- const filterOutOfScope = apply(filterScope, config.scope);
1634
- const convertToReferences = apply(parsedFilesToReferenceGuide, config);
1635
- const convertToRenderableBundle = apply(parsedFilesToRenderableBundle, config);
1636
- const convertToDocumentationBundleForTemplate = apply(convertToDocumentationBundle, config.referenceGuideTemplate);
1637
- const sortTypeMembers = apply(sortMembers, config.sortMembersAlphabetically);
1638
- return _function.pipe(
1639
- apexBundles,
1640
- reflectBundles,
1641
- TE__namespace.map(filterOutOfScope),
1642
- TE__namespace.map(addInheritedMembersToTypes),
1643
- TE__namespace.map(addInheritanceChainToTypes),
1644
- TE__namespace.map(sortTypeMembers),
1645
- TE__namespace.bindTo("parsedFiles"),
1646
- TE__namespace.bind("references", ({ parsedFiles }) => TE__namespace.right(convertToReferences(parsedFiles))),
1647
- TE__namespace.flatMap(({ parsedFiles, references }) => transformReferenceHook(config)({ references, parsedFiles })),
1648
- TE__namespace.map(({ parsedFiles, references }) => convertToRenderableBundle(parsedFiles, references)),
1649
- TE__namespace.map(convertToDocumentationBundleForTemplate),
1650
- TE__namespace.flatMap(transformDocumentationBundleHook(config)),
1651
- TE__namespace.map(postHookCompile)
1652
- );
1653
- }
1654
- function transformReferenceHook(config) {
1655
- function _execute(references, parsedFiles, transformReference) {
1656
- return __async$5(this, null, function* () {
1657
- return {
1658
- references: yield execTransformReferenceHook(Object.values(references), transformReference),
1659
- parsedFiles
1660
- };
1661
- });
1662
- }
1663
- return ({ references, parsedFiles }) => TE__namespace.tryCatch(
1664
- () => _execute(references, parsedFiles, config.transformReference),
1665
- (error) => new HookError(error)
1666
- );
1667
- }
1668
- function transformDocumentationBundleHook(config) {
1669
- return (bundle) => TE__namespace.tryCatch(
1670
- () => documentationBundleHook(bundle, config),
1671
- (error) => new HookError(error)
1672
- );
1673
- }
1674
- function passThroughHook(value) {
1675
- return value;
1676
- }
1677
- const execTransformReferenceHook = (_0, ..._1) => __async$5(void 0, [_0, ..._1], function* (references, hook = passThroughHook) {
1678
- const hooked = references.map((reference) => __async$5(void 0, null, function* () {
1679
- const hookedResult = yield hook(reference);
1680
- return __spreadValues$7(__spreadValues$7({}, reference), hookedResult);
1681
- }));
1682
- const awaited = yield Promise.all(hooked);
1683
- return awaited.reduce((acc, reference) => {
1684
- acc[reference.source.name] = reference;
1685
- return acc;
1686
- }, {});
1687
- });
1688
- const documentationBundleHook = (bundle, config) => __async$5(void 0, null, function* () {
1689
- return {
1690
- referenceGuide: yield transformReferenceGuide(bundle.referenceGuide, config.transformReferenceGuide),
1691
- docs: yield transformDocs(bundle.docs, config.transformDocs, config.transformDocPage)
1692
- };
1693
- });
1694
- const transformReferenceGuide = (_0, ..._1) => __async$5(void 0, [_0, ..._1], function* (referenceGuide, hook = passThroughHook) {
1695
- const result = yield hook(referenceGuide);
1696
- if (isSkip(result)) {
1697
- return result;
1698
- }
1699
- return __spreadValues$7(__spreadValues$7({}, referenceGuide), yield hook(referenceGuide));
1700
- });
1701
- const transformDocs = (_0, ..._1) => __async$5(void 0, [_0, ..._1], function* (docs, transformDocsHook = passThroughHook, transformDocPageHook = passThroughHook) {
1702
- const transformed = yield transformDocsHook(docs);
1703
- return Promise.all(transformed.map((doc) => transformDocPage(doc, transformDocPageHook)));
1704
- });
1705
- const transformDocPage = (_0, ..._1) => __async$5(void 0, [_0, ..._1], function* (doc, hook = passThroughHook) {
1706
- return __spreadValues$7(__spreadValues$7({}, doc), yield hook(doc));
1707
- });
1708
- function postHookCompile(bundle) {
1709
- return {
1710
- referenceGuide: isSkip(bundle.referenceGuide) ? bundle.referenceGuide : __spreadProps$7(__spreadValues$7({}, bundle.referenceGuide), {
1711
- content: Template.getInstance().compile({
1712
- source: {
1713
- frontmatter: toFrontmatterString(bundle.referenceGuide.frontmatter),
1714
- content: bundle.referenceGuide.content
1715
- },
1716
- template: hookableTemplate
1717
- })
1718
- }),
1719
- docs: bundle.docs.map((doc) => __spreadProps$7(__spreadValues$7({}, doc), {
1720
- content: Template.getInstance().compile({
1721
- source: {
1722
- frontmatter: toFrontmatterString(doc.frontmatter),
1723
- content: doc.content
1724
- },
1725
- template: hookableTemplate
1726
- })
1727
- }))
1728
- };
1729
- }
1730
- function toFrontmatterString(frontmatter) {
1731
- if (typeof frontmatter === "string") {
1732
- return frontmatter;
1733
- }
1734
- if (!frontmatter) {
1735
- return "";
1736
- }
1737
- const yamlString = yaml.dump(frontmatter);
1738
- return `---
1739
- ${yamlString}---
1740
- `;
1741
- }
1742
-
1743
- const referenceGuideTemplate = `
1744
- # Apex Reference Guide
1745
-
1746
- {{#each this}}
1747
- ## {{@key}}
1748
-
1749
- {{#each this}}
1750
- ### {{link title}}
1751
-
1752
- {{{renderContent description}}}
1753
-
1754
- {{/each}}
1755
- {{/each}}
1756
- `.trim();
1757
-
1758
- var __defProp$6 = Object.defineProperty;
1759
- var __defProps$6 = Object.defineProperties;
1760
- var __getOwnPropDescs$6 = Object.getOwnPropertyDescriptors;
1761
- var __getOwnPropSymbols$6 = Object.getOwnPropertySymbols;
1762
- var __hasOwnProp$6 = Object.prototype.hasOwnProperty;
1763
- var __propIsEnum$6 = Object.prototype.propertyIsEnumerable;
1764
- var __defNormalProp$6 = (obj, key, value) => key in obj ? __defProp$6(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
1765
- var __spreadValues$6 = (a, b) => {
1766
- for (var prop in b || (b = {}))
1767
- if (__hasOwnProp$6.call(b, prop))
1768
- __defNormalProp$6(a, prop, b[prop]);
1769
- if (__getOwnPropSymbols$6)
1770
- for (var prop of __getOwnPropSymbols$6(b)) {
1771
- if (__propIsEnum$6.call(b, prop))
1772
- __defNormalProp$6(a, prop, b[prop]);
1773
- }
1774
- return a;
1775
- };
1776
- var __spreadProps$6 = (a, b) => __defProps$6(a, __getOwnPropDescs$6(b));
1777
- const mkdir = TE__namespace$1.taskify(fs__namespace.mkdir);
1778
- const writeFile = TE__namespace$1.taskify(fs__namespace.writeFile);
1779
- function writeFiles(files, outputDir, onWriteCallback) {
1780
- return _function.pipe(
1781
- files,
1782
- TE__namespace$1.traverseArray((file) => writeSingle(file, outputDir, onWriteCallback))
1783
- );
1784
- }
1785
- function writeSingle(file, outputDir, onWriteCallback) {
1786
- const ensureDirectoryExists = ({ outputDocPath }) => mkdir(path__namespace.dirname(outputDocPath), { recursive: true });
1787
- const writeContents = (file2) => writeFile(file2.outputDocPath, file2.content, "utf8");
1788
- return _function.pipe(
1789
- resolveTargetLocation(file, outputDir),
1790
- (file2) => TE__namespace$1.right(file2),
1791
- TE__namespace$1.tapIO(ensureDirectoryExists),
1792
- TE__namespace$1.flatMap(writeContents),
1793
- TE__namespace$1.map(() => onWriteCallback == null ? void 0 : onWriteCallback(file))
1794
- );
1795
- }
1796
- function resolveTargetLocation(file, outputDir) {
1797
- return __spreadProps$6(__spreadValues$6({}, file), {
1798
- outputDocPath: path__namespace.join(outputDir, file.outputDocPath)
1799
- });
1800
- }
1801
-
1802
- var __defProp$5 = Object.defineProperty;
1803
- var __defProps$5 = Object.defineProperties;
1804
- var __getOwnPropDescs$5 = Object.getOwnPropertyDescriptors;
1805
- var __getOwnPropSymbols$5 = Object.getOwnPropertySymbols;
1806
- var __hasOwnProp$5 = Object.prototype.hasOwnProperty;
1807
- var __propIsEnum$5 = Object.prototype.propertyIsEnumerable;
1808
- var __defNormalProp$5 = (obj, key, value) => key in obj ? __defProp$5(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
1809
- var __spreadValues$5 = (a, b) => {
1810
- for (var prop in b || (b = {}))
1811
- if (__hasOwnProp$5.call(b, prop))
1812
- __defNormalProp$5(a, prop, b[prop]);
1813
- if (__getOwnPropSymbols$5)
1814
- for (var prop of __getOwnPropSymbols$5(b)) {
1815
- if (__propIsEnum$5.call(b, prop))
1816
- __defNormalProp$5(a, prop, b[prop]);
1817
- }
1818
- return a;
1819
- };
1820
- var __spreadProps$5 = (a, b) => __defProps$5(a, __getOwnPropDescs$5(b));
1821
- class FileWritingError {
1822
- constructor(message, error) {
1823
- this.message = message;
1824
- this.error = error;
1825
- this._tag = "FileWritingError";
1826
- }
1827
- }
1828
- function generate(bundles, config) {
1829
- return _function.pipe(
1830
- generateDocumentationBundle(bundles, config),
1831
- TE__namespace.flatMap((files) => writeFilesToSystem(files, config.targetDir))
1832
- );
1833
- }
1834
- function generateDocumentationBundle(bundles, config) {
1835
- return generateDocs(bundles, __spreadProps$5(__spreadValues$5({}, config), {
1836
- referenceGuideTemplate
1837
- }));
1838
- }
1839
- function writeFilesToSystem(files, outputDir) {
1840
- return _function.pipe(
1841
- [files.referenceGuide, ...files.docs].filter((file) => !isSkip(file)),
1842
- (files2) => writeFiles(files2, outputDir),
1843
- TE__namespace.mapLeft((error) => {
1844
- return new FileWritingError("An error occurred while writing files to the system.", error);
1845
- })
1846
- );
1847
- }
1848
-
1849
- function createManifest(typeParser, reflect) {
1850
- return new Manifest(typeParser.parse(reflect));
1851
- }
1852
-
1853
- class Logger {
1854
- /**
1855
- * Logs a message with optional arguments.
1856
- * @param message The message to log.
1857
- * @param args Optional arguments.
1858
- */
1859
- static log(message, ...args) {
1860
- this.logSingle(message);
1861
- args.forEach((arg) => {
1862
- this.logSingle(arg);
1863
- });
1864
- }
1865
- /**
1866
- * Logs an error message with optional arguments.
1867
- * @param message The error message to log.
1868
- * @param args Optional arguments.
1869
- */
1870
- static error(message, ...args) {
1871
- this.logSingle(message, "red");
1872
- args.forEach(() => {
1873
- this.logSingle(message, "red");
1874
- });
1875
- }
1876
- static logSingle(text, color = "green") {
1877
- if (this.currentFrame > 9) {
1878
- this.currentFrame = 0;
1879
- }
1880
- const logMessage = `${this.getChalkFn(color)((/* @__PURE__ */ new Date()).toLocaleString() + ": ")}${text}
1881
- `;
1882
- process.stdout.write(logMessage);
1883
- }
1884
- static getChalkFn(color) {
1885
- return color === "green" ? chalk.green : chalk.red;
1886
- }
1887
- }
1888
- Logger.currentFrame = 0;
1889
-
1890
- var __defProp$4 = Object.defineProperty;
1891
- var __defProps$4 = Object.defineProperties;
1892
- var __getOwnPropDescs$4 = Object.getOwnPropertyDescriptors;
1893
- var __getOwnPropSymbols$4 = Object.getOwnPropertySymbols;
1894
- var __hasOwnProp$4 = Object.prototype.hasOwnProperty;
1895
- var __propIsEnum$4 = Object.prototype.propertyIsEnumerable;
1896
- var __defNormalProp$4 = (obj, key, value) => key in obj ? __defProp$4(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
1897
- var __spreadValues$4 = (a, b) => {
1898
- for (var prop in b || (b = {}))
1899
- if (__hasOwnProp$4.call(b, prop))
1900
- __defNormalProp$4(a, prop, b[prop]);
1901
- if (__getOwnPropSymbols$4)
1902
- for (var prop of __getOwnPropSymbols$4(b)) {
1903
- if (__propIsEnum$4.call(b, prop))
1904
- __defNormalProp$4(a, prop, b[prop]);
1905
- }
1906
- return a;
1907
- };
1908
- var __spreadProps$4 = (a, b) => __defProps$4(a, __getOwnPropDescs$4(b));
1909
- class RawBodyParser {
1910
- constructor(typeBundles) {
1911
- this.typeBundles = typeBundles;
1912
- }
1913
- parse(reflect) {
1914
- const types = this.typeBundles.map((currentBundle) => {
1915
- Logger.log(`Parsing file: ${currentBundle.filePath}`);
1916
- return reflect(currentBundle);
1917
- }).filter((reflectionResult) => {
1918
- return reflectionResult.typeMirror;
1919
- }).map((reflectionResult) => reflectionResult.typeMirror);
1920
- return this.addFieldsFromParent(types);
1921
- }
1922
- addFieldsFromParent(types) {
1923
- const typesWithFields = [];
1924
- for (const currentType of types) {
1925
- if (currentType.type_name !== "class" && currentType.type_name !== "interface") {
1926
- typesWithFields.push(currentType);
1927
- continue;
1928
- }
1929
- if (currentType.type_name === "class") {
1930
- let typeAsClass = currentType;
1931
- if (!typeAsClass.extended_class) {
1932
- typesWithFields.push(currentType);
1933
- continue;
1934
- }
1935
- typeAsClass = this.addMembersFromParent(typeAsClass, types);
1936
- typesWithFields.push(typeAsClass);
1937
- continue;
1938
- }
1939
- let typeAsInterface = currentType;
1940
- if (!typeAsInterface.extended_interfaces.length) {
1941
- typesWithFields.push(currentType);
1942
- continue;
1943
- }
1944
- typeAsInterface = this.addMethodsFromParent(typeAsInterface, types);
1945
- typesWithFields.push(typeAsInterface);
1946
- }
1947
- return typesWithFields;
1948
- }
1949
- addMembersFromParent(currentClass, allTypes) {
1950
- if (!currentClass.extended_class) {
1951
- return currentClass;
1952
- }
1953
- const parent = allTypes.find((currentType) => currentType.name === currentClass.extended_class);
1954
- if (!parent || parent.type_name !== "class") {
1955
- return currentClass;
1956
- }
1957
- let parentAsClass = parent;
1958
- if (parentAsClass.extended_class) {
1959
- parentAsClass = this.addMembersFromParent(parentAsClass, allTypes);
1960
- }
1961
- currentClass.fields = [...currentClass.fields, ...this.getInheritedFields(parentAsClass, currentClass)];
1962
- currentClass.properties = [...currentClass.properties, ...this.getInheritedProperties(parentAsClass, currentClass)];
1963
- currentClass.methods = [...currentClass.methods, ...this.getInheritedMethods(parentAsClass, currentClass)];
1964
- return currentClass;
1965
- }
1966
- addMethodsFromParent(currentInterface, allTypes) {
1967
- if (!currentInterface.extended_interfaces.length) {
1968
- return currentInterface;
1969
- }
1970
- const parents = [];
1971
- for (const currentInterfaceName of currentInterface.extended_interfaces) {
1972
- const parent = allTypes.find((currentType) => currentType.name === currentInterfaceName);
1973
- if (parent) {
1974
- parents.push(parent);
1975
- }
1976
- }
1977
- for (const parent of parents) {
1978
- let parentAsInterface = parent;
1979
- if (parentAsInterface.extended_interfaces.length) {
1980
- parentAsInterface = this.addMethodsFromParent(parentAsInterface, allTypes);
1981
- }
1982
- currentInterface.methods = [
1983
- ...currentInterface.methods,
1984
- ...this.getInheritedMethods(parentAsInterface, currentInterface)
1985
- ];
1986
- }
1987
- return currentInterface;
1988
- }
1989
- getInheritedFields(parentAsClass, currentClass) {
1990
- return parentAsClass.fields.filter((currentField) => currentField.access_modifier.toLowerCase() !== "private").filter((currentField) => !this.memberExists(currentClass.fields, currentField.name)).map((currentField) => __spreadProps$4(__spreadValues$4({}, currentField), {
1991
- inherited: true
1992
- }));
1993
- }
1994
- getInheritedProperties(parentAsClass, currentClass) {
1995
- return parentAsClass.properties.filter((currentProperty) => currentProperty.access_modifier.toLowerCase() !== "private").filter((currentProperty) => !this.memberExists(currentClass.properties, currentProperty.name)).map((currentProperty) => __spreadProps$4(__spreadValues$4({}, currentProperty), {
1996
- inherited: true
1997
- }));
1998
- }
1999
- getInheritedMethods(parentAsClass, currentClass) {
2000
- return parentAsClass.methods.filter((currentMethod) => currentMethod.access_modifier.toLowerCase() !== "private").filter((currentMethod) => !this.memberExists(currentClass.methods, currentMethod.name)).map((currentMethod) => __spreadProps$4(__spreadValues$4({}, currentMethod), {
2001
- inherited: true
2002
- }));
2003
- }
2004
- memberExists(members, fieldName) {
2005
- const fieldNames = members.map((currentMember) => currentMember.name);
2006
- return fieldNames.includes(fieldName);
2007
- }
2008
- }
2009
-
2010
- class TypesRepository {
2011
- constructor() {
2012
- this.allTypes = [];
2013
- }
2014
- static getInstance() {
2015
- if (!TypesRepository.instance) {
2016
- TypesRepository.instance = new TypesRepository();
2017
- }
2018
- return TypesRepository.instance;
2019
- }
2020
- populateAll(types) {
2021
- this.allTypes = types;
2022
- }
2023
- getFromAllByName(typeName) {
2024
- if (typeName.includes(".")) {
2025
- const [parentTypeName, childTypeName] = typeName.split(".");
2026
- const parentReference = this.allTypes.find(
2027
- (currentType) => currentType.name.toLowerCase() === parentTypeName.toLowerCase()
2028
- );
2029
- if (!parentReference || parentReference.type_name !== "class") {
2030
- return void 0;
2031
- }
2032
- const parentReferenceAsClass = parentReference;
2033
- const childTypes = [
2034
- ...parentReferenceAsClass.classes,
2035
- ...parentReferenceAsClass.interfaces,
2036
- ...parentReferenceAsClass.enums
2037
- ];
2038
- const foundType2 = childTypes.find((currentType) => currentType.name.toLowerCase() === childTypeName);
2039
- if (!foundType2) {
2040
- return void 0;
2041
- }
2042
- return { type: foundType2, isChild: true, parentType: parentReference };
2043
- }
2044
- const foundType = this.allTypes.find(
2045
- (currentType) => currentType.name.toLowerCase() === typeName.toLowerCase()
2046
- );
2047
- if (!foundType) {
2048
- return void 0;
2049
- }
2050
- return { type: foundType, isChild: false };
2051
- }
2052
- }
2053
-
2054
- class Transpiler {
2055
- static generate(types, processor) {
2056
- var _a;
2057
- const sortedTypes = types.sort((apexTypeA, apexTypeB) => {
2058
- if (apexTypeA.name < apexTypeB.name) return -1;
2059
- if (apexTypeA.name > apexTypeB.name) return 1;
2060
- return 0;
2061
- });
2062
- sortedTypes.forEach((currentType) => {
2063
- processor.onProcess(currentType);
2064
- });
2065
- (_a = processor.onAfterProcess) == null ? void 0 : _a.call(processor, sortedTypes);
2066
- }
2067
- }
2068
-
2069
- class ErrorLogger {
2070
- static logErrors(types) {
2071
- types.forEach((currentType) => {
2072
- this.logErrorsForSingleType(currentType);
2073
- });
2074
- }
2075
- static logErrorsForSingleType(currentType) {
2076
- this.logTypeErrors(currentType);
2077
- if (currentType.type_name === "class") {
2078
- this.logErrorsForClass(currentType);
2079
- } else if (currentType.type_name === "interface") {
2080
- this.logErrorsForInterface(currentType);
2081
- }
2082
- }
2083
- static logTypeErrors(currentType, parentType) {
2084
- var _a;
2085
- if ((_a = currentType.docComment) == null ? void 0 : _a.error) {
2086
- const typeName = parentType ? `${parentType.name}.${currentType.name}` : currentType.name;
2087
- Logger.error(`${typeName} - Doc comment parsing error. Level: Type`);
2088
- Logger.error(`Comment:
2089
- ${currentType.docComment.rawDeclaration}`);
2090
- Logger.error(currentType.docComment.error);
2091
- Logger.error("=================================");
2092
- }
2093
- }
2094
- static logErrorsForClass(classMirror, parentType) {
2095
- const typeName = parentType ? `${parentType.name}.${classMirror.name}` : classMirror.name;
2096
- classMirror.constructors.forEach((currentConstructor) => {
2097
- var _a;
2098
- if ((_a = currentConstructor.docComment) == null ? void 0 : _a.error) {
2099
- Logger.error(`${typeName} - Doc comment parsing error. Level: Constructor`);
2100
- Logger.error(`Comment:
2101
- ${currentConstructor.docComment.rawDeclaration}`);
2102
- Logger.error(currentConstructor.docComment.error);
2103
- Logger.error("=================================");
2104
- }
2105
- });
2106
- classMirror.fields.forEach((currentField) => {
2107
- var _a;
2108
- if ((_a = currentField.docComment) == null ? void 0 : _a.error) {
2109
- Logger.error(`${typeName} - Doc comment parsing error. Level: Field`);
2110
- Logger.error(`Comment:
2111
- ${currentField.docComment.rawDeclaration}`);
2112
- Logger.error(currentField.docComment.error);
2113
- Logger.error("=================================");
2114
- }
2115
- });
2116
- classMirror.properties.forEach((currentProperty) => {
2117
- var _a;
2118
- if ((_a = currentProperty.docComment) == null ? void 0 : _a.error) {
2119
- Logger.error(`${typeName} - Doc comment parsing error. Level: Property`);
2120
- Logger.error(`Comment:
2121
- ${currentProperty.docComment.rawDeclaration}`);
2122
- Logger.error(currentProperty.docComment.error);
2123
- Logger.error("=================================");
2124
- }
2125
- });
2126
- classMirror.methods.forEach((currentMethod) => {
2127
- var _a;
2128
- if ((_a = currentMethod.docComment) == null ? void 0 : _a.error) {
2129
- Logger.error(`${typeName} - Doc comment parsing error. Level: Method`);
2130
- Logger.error(`Comment:
2131
- ${currentMethod.docComment.rawDeclaration}`);
2132
- Logger.error(currentMethod.docComment.error);
2133
- Logger.error("=================================");
2134
- }
2135
- });
2136
- classMirror.enums.forEach((currentEnum) => {
2137
- this.logErrorsForSingleType(currentEnum);
2138
- });
2139
- classMirror.interfaces.forEach((currentInterface) => {
2140
- this.logErrorsForSingleType(currentInterface);
2141
- });
2142
- classMirror.classes.forEach((currentClass) => {
2143
- this.logErrorsForSingleType(currentClass);
2144
- });
2145
- }
2146
- static logErrorsForInterface(interfaceMirror) {
2147
- interfaceMirror.methods.forEach((currentMethod) => {
2148
- var _a;
2149
- if ((_a = currentMethod.docComment) == null ? void 0 : _a.error) {
2150
- Logger.error(`${interfaceMirror.name} - Doc comment parsing error. Level: Method`);
2151
- Logger.error(`Comment: ${currentMethod.docComment.rawDeclaration}`);
2152
- Logger.error(currentMethod.docComment.error);
2153
- Logger.error("=================================");
2154
- }
2155
- });
2156
- }
2157
- }
2158
-
2159
- class FileContainer {
2160
- constructor() {
2161
- this._files = [];
2162
- }
2163
- files() {
2164
- return this._files;
2165
- }
2166
- pushFile(file) {
2167
- this._files.push(file);
2168
- }
2169
- }
2170
-
2171
- const OPEN_API_VERSION = "3.1.0";
2172
- const SERVER_URL = "/services/apexrest/";
2173
- class OpenApi {
2174
- constructor(title, version, namespace) {
2175
- this.namespace = namespace;
2176
- this.openapi = OPEN_API_VERSION;
2177
- this.info = {
2178
- title,
2179
- version
2180
- };
2181
- this.servers = [
2182
- {
2183
- url: this.getServerUrl()
2184
- }
2185
- ];
2186
- this.paths = {};
2187
- this.tags = [];
2188
- }
2189
- getServerUrl() {
2190
- if (!this.namespace) {
2191
- return SERVER_URL;
2192
- }
2193
- return `${SERVER_URL}${this.namespace}/`;
2194
- }
2195
- }
2196
-
2197
- class OpenApiSettings {
2198
- constructor(config) {
2199
- this.config = config;
2200
- }
2201
- static build(config) {
2202
- OpenApiSettings.instance = new OpenApiSettings(config);
2203
- }
2204
- static getInstance() {
2205
- if (!OpenApiSettings.instance) {
2206
- throw new Error("Settings has not been initialized");
2207
- }
2208
- return OpenApiSettings.instance;
2209
- }
2210
- getOpenApiTitle() {
2211
- return this.config.openApiTitle;
2212
- }
2213
- getNamespace() {
2214
- return this.config.namespace;
2215
- }
2216
- openApiFileName() {
2217
- return this.config.openApiFileName;
2218
- }
2219
- getVersion() {
2220
- return this.config.version;
2221
- }
2222
- }
2223
-
2224
- class ClassMirrorWrapper {
2225
- constructor(classMirror) {
2226
- this.classMirror = classMirror;
2227
- this.hasAnnotation = (method, annotationName) => method.annotations.some((annotation) => annotation.name.toLowerCase() === annotationName);
2228
- }
2229
- getMethodsByAnnotation(annotation) {
2230
- return this.classMirror.methods.filter((method) => this.hasAnnotation(method, annotation));
2231
- }
2232
- }
2233
-
2234
- var __defProp$3 = Object.defineProperty;
2235
- var __defProps$3 = Object.defineProperties;
2236
- var __getOwnPropDescs$3 = Object.getOwnPropertyDescriptors;
2237
- var __getOwnPropSymbols$3 = Object.getOwnPropertySymbols;
2238
- var __hasOwnProp$3 = Object.prototype.hasOwnProperty;
2239
- var __propIsEnum$3 = Object.prototype.propertyIsEnumerable;
2240
- var __defNormalProp$3 = (obj, key, value) => key in obj ? __defProp$3(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
2241
- var __spreadValues$3 = (a, b) => {
2242
- for (var prop in b || (b = {}))
2243
- if (__hasOwnProp$3.call(b, prop))
2244
- __defNormalProp$3(a, prop, b[prop]);
2245
- if (__getOwnPropSymbols$3)
2246
- for (var prop of __getOwnPropSymbols$3(b)) {
2247
- if (__propIsEnum$3.call(b, prop))
2248
- __defNormalProp$3(a, prop, b[prop]);
2249
- }
2250
- return a;
2251
- };
2252
- var __spreadProps$3 = (a, b) => __defProps$3(a, __getOwnPropDescs$3(b));
2253
- class ReferenceBuilder {
2254
- constructor() {
2255
- this.isReferenceString = (targetObject) => {
2256
- return typeof targetObject === "string" || targetObject instanceof String;
2257
- };
2258
- }
2259
- build(referencedTypeName) {
2260
- const originalTypeName = referencedTypeName;
2261
- const regexForSchemaOverrides = /\[(.*?)]/g;
2262
- const schemaOverrides = referencedTypeName.match(regexForSchemaOverrides);
2263
- let referenceOverrides = [];
2264
- if (schemaOverrides && schemaOverrides.length > 0) {
2265
- referenceOverrides = ReferenceOverrides.build(schemaOverrides[0]);
2266
- referencedTypeName = referencedTypeName.replace(regexForSchemaOverrides, "");
2267
- }
2268
- const [parsedReferencedType, isCollection] = this.handlePossibleCollectionReference(referencedTypeName);
2269
- const referencedTypeBundle = TypesRepository.getInstance().getFromAllByName(parsedReferencedType);
2270
- if (!referencedTypeBundle) {
2271
- throw new Error(`The referenced type ${referencedTypeName} was not found.`);
2272
- }
2273
- if (referencedTypeBundle.type.type_name !== "class") {
2274
- throw new Error(
2275
- `Expected the referenced type to be a class, but found a ${referencedTypeBundle.type.type_name}.`
2276
- );
2277
- }
2278
- const typeBundleWithIsCollection = __spreadProps$3(__spreadValues$3({}, referencedTypeBundle), {
2279
- originalTypeName,
2280
- isCollection,
2281
- referenceOverrides
2282
- });
2283
- return this.buildReferenceFromType(typeBundleWithIsCollection);
2284
- }
2285
- /**
2286
- * Returns a tuple where the first value is the name of the reference without any collection related values
2287
- * and the second is a boolean representing if we are dealing with a collection or not.
2288
- * @param referencedTypeName The received raw type name.
2289
- * @private
2290
- */
2291
- handlePossibleCollectionReference(referencedTypeName) {
2292
- referencedTypeName = referencedTypeName.toLowerCase();
2293
- if (referencedTypeName.startsWith("list<") && referencedTypeName.endsWith(">")) {
2294
- referencedTypeName = referencedTypeName.replace("list<", "");
2295
- referencedTypeName = referencedTypeName.replace(">", "");
2296
- return [referencedTypeName, true];
2297
- }
2298
- if (referencedTypeName.startsWith("set<") && referencedTypeName.endsWith(">")) {
2299
- referencedTypeName = referencedTypeName.replace("set<", "");
2300
- referencedTypeName = referencedTypeName.replace(">", "");
2301
- return [referencedTypeName, true];
2302
- }
2303
- return [referencedTypeName, false];
2304
- }
2305
- buildReferenceFromType(typeBundle) {
2306
- const propertiesAndFields = [
2307
- ...typeBundle.type.properties,
2308
- ...typeBundle.type.fields
2309
- ].filter((current) => !current.memberModifiers.includes("static")).filter((current) => !current.memberModifiers.includes("transient"));
2310
- const properties = {};
2311
- let referencedComponents = [];
2312
- propertiesAndFields.forEach((current) => {
2313
- var _a, _b;
2314
- const referenceOverride = typeBundle.referenceOverrides.find((currentOverride) => {
2315
- return currentOverride.propertyName.toLowerCase() === current.name.toLowerCase();
2316
- });
2317
- if (referenceOverride) {
2318
- const reference = this.build(referenceOverride.referenceName);
2319
- properties[current.name] = reference.entrypointReferenceObject;
2320
- reference.referenceComponents.forEach((current2) => referencedComponents.push(current2));
2321
- } else {
2322
- const manuallyDefinedHttpSchema = (_a = current.docComment) == null ? void 0 : _a.annotations.find(
2323
- (annotation) => annotation.name.toLowerCase() === "http-schema"
2324
- );
2325
- if (manuallyDefinedHttpSchema) {
2326
- this.handleOverriddenSchema(manuallyDefinedHttpSchema, properties, current, referencedComponents);
2327
- } else {
2328
- const pair = this.getReferenceType(current.typeReference);
2329
- properties[current.name] = pair.schema;
2330
- referencedComponents.push(...pair.referenceComponents);
2331
- }
2332
- }
2333
- properties[current.name].description = (_b = current.docComment) == null ? void 0 : _b.description;
2334
- });
2335
- const mainReferenceComponents = this.buildMainReferenceComponent(typeBundle, properties);
2336
- referencedComponents = [...mainReferenceComponents, ...referencedComponents];
2337
- return {
2338
- entrypointReferenceObject: {
2339
- $ref: `#/components/schemas/${this.getReferenceName(typeBundle)}`
2340
- },
2341
- referenceComponents: referencedComponents
2342
- };
2343
- }
2344
- handleOverriddenSchema(manuallyDefinedHttpSchema, properties, current, referencedComponents) {
2345
- const inYaml = manuallyDefinedHttpSchema == null ? void 0 : manuallyDefinedHttpSchema.bodyLines.reduce((prev, current2) => prev + "\n" + current2);
2346
- const asJson = yaml__namespace.load(inYaml);
2347
- const isReferenceString = this.isReferenceString(asJson);
2348
- if (isReferenceString) {
2349
- const reference = this.build(asJson);
2350
- properties[current.name] = reference.entrypointReferenceObject;
2351
- reference.referenceComponents.forEach((current2) => referencedComponents.push(current2));
2352
- } else {
2353
- properties[current.name] = asJson;
2354
- }
2355
- }
2356
- getReferenceName(typeBundle) {
2357
- var _a;
2358
- let referenceName = typeBundle.type.name;
2359
- if (typeBundle.isChild) {
2360
- referenceName = `${(_a = typeBundle.parentType) == null ? void 0 : _a.name}.${typeBundle.type.name}`;
2361
- }
2362
- if (typeBundle.isCollection) {
2363
- referenceName = `${referenceName}_array`;
2364
- }
2365
- if (typeBundle.referenceOverrides.length) {
2366
- referenceName = `${referenceName}_${typeBundle.originalTypeName}`;
2367
- }
2368
- return referenceName;
2369
- }
2370
- buildMainReferenceComponent(typeBundle, properties) {
2371
- const mainReferenceName = this.getReferenceName(__spreadProps$3(__spreadValues$3({}, typeBundle), { isCollection: false }));
2372
- const mainReference = {
2373
- referencedClass: mainReferenceName,
2374
- schema: {
2375
- type: "object",
2376
- properties
2377
- }
2378
- };
2379
- const referencedComponents = [mainReference];
2380
- if (!typeBundle.isCollection) {
2381
- return referencedComponents;
2382
- }
2383
- return [
2384
- {
2385
- referencedClass: this.getReferenceName(typeBundle),
2386
- schema: {
2387
- type: "array",
2388
- items: {
2389
- $ref: `#/components/schemas/${mainReferenceName}`
2390
- }
2391
- }
2392
- },
2393
- ...referencedComponents
2394
- ];
2395
- }
2396
- getReferenceType(typeInMirror) {
2397
- const typeName = typeInMirror.type.toLowerCase();
2398
- switch (typeName) {
2399
- case "boolean":
2400
- return { schema: { type: "boolean" }, referenceComponents: [] };
2401
- case "date":
2402
- return { schema: { type: "string", format: "date" }, referenceComponents: [] };
2403
- case "datetime":
2404
- return { schema: { type: "string", format: "date-time" }, referenceComponents: [] };
2405
- case "decimal":
2406
- return { schema: { type: "number" }, referenceComponents: [] };
2407
- case "double":
2408
- return { schema: { type: "number" }, referenceComponents: [] };
2409
- case "id":
2410
- return { schema: { type: "string" }, referenceComponents: [] };
2411
- case "integer":
2412
- return { schema: { type: "integer" }, referenceComponents: [] };
2413
- case "long":
2414
- return { schema: { type: "integer", format: "int64" }, referenceComponents: [] };
2415
- case "string":
2416
- return { schema: { type: "string" }, referenceComponents: [] };
2417
- case "time":
2418
- return { schema: { type: "string", format: "time" }, referenceComponents: [] };
2419
- case "list":
2420
- return this.buildCollectionPair(typeInMirror);
2421
- case "set":
2422
- return this.buildCollectionPair(typeInMirror);
2423
- case "map":
2424
- return { schema: { type: "object" }, referenceComponents: [] };
2425
- case "object":
2426
- return { schema: { type: "object" }, referenceComponents: [] };
2427
- default: {
2428
- const referencedType = TypesRepository.getInstance().getFromAllByName(typeName);
2429
- if (!referencedType) {
2430
- return { schema: { type: "object" }, referenceComponents: [] };
2431
- }
2432
- const reference = this.buildReferenceFromType(__spreadProps$3(__spreadValues$3({}, referencedType), {
2433
- isCollection: false,
2434
- referenceOverrides: [],
2435
- originalTypeName: typeName
2436
- }));
2437
- return {
2438
- schema: reference.entrypointReferenceObject,
2439
- referenceComponents: [...reference.referenceComponents]
2440
- };
2441
- }
2442
- }
2443
- }
2444
- buildCollectionPair(typeInMirror) {
2445
- const innerReference = this.getReferenceType(typeInMirror.ofType);
2446
- return {
2447
- schema: { type: "array", items: innerReference.schema },
2448
- referenceComponents: [...innerReference.referenceComponents]
2449
- };
2450
- }
2451
- }
2452
- class ReferenceOverrides {
2453
- static build(referenceAsString) {
2454
- const cleanedUpReference = referenceAsString.replace(/[[\]]/g, "");
2455
- const referenceStrings = cleanedUpReference.split(",").map((item) => item.replace(/\s/g, ""));
2456
- return referenceStrings.map((item) => {
2457
- const [propertyName, referenceName] = item.split(":");
2458
- return { propertyName, referenceName };
2459
- });
2460
- }
2461
- }
2462
-
2463
- class Builder {
2464
- constructor() {
2465
- this.isReferenceString = (targetObject) => {
2466
- return typeof targetObject === "string" || targetObject instanceof String;
2467
- };
2468
- }
2469
- build(schemaAware) {
2470
- let reference;
2471
- if (this.isReferenceString(schemaAware.schema)) {
2472
- reference = new ReferenceBuilder().build(schemaAware.schema);
2473
- }
2474
- return {
2475
- reference,
2476
- body: this.buildBody(schemaAware, reference)
2477
- };
2478
- }
2479
- getOpenApiSchemaFromApexDocSchema(schemaAware, reference) {
2480
- if (this.isReferenceString(schemaAware.schema)) {
2481
- return reference.entrypointReferenceObject;
2482
- }
2483
- return schemaAware.schema;
2484
- }
2485
- }
2486
-
2487
- var __defProp$2 = Object.defineProperty;
2488
- var __defProps$2 = Object.defineProperties;
2489
- var __getOwnPropDescs$2 = Object.getOwnPropertyDescriptors;
2490
- var __getOwnPropSymbols$2 = Object.getOwnPropertySymbols;
2491
- var __hasOwnProp$2 = Object.prototype.hasOwnProperty;
2492
- var __propIsEnum$2 = Object.prototype.propertyIsEnumerable;
2493
- var __defNormalProp$2 = (obj, key, value) => key in obj ? __defProp$2(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
2494
- var __spreadValues$2 = (a, b) => {
2495
- for (var prop in b || (b = {}))
2496
- if (__hasOwnProp$2.call(b, prop))
2497
- __defNormalProp$2(a, prop, b[prop]);
2498
- if (__getOwnPropSymbols$2)
2499
- for (var prop of __getOwnPropSymbols$2(b)) {
2500
- if (__propIsEnum$2.call(b, prop))
2501
- __defNormalProp$2(a, prop, b[prop]);
2502
- }
2503
- return a;
2504
- };
2505
- var __spreadProps$2 = (a, b) => __defProps$2(a, __getOwnPropDescs$2(b));
2506
- class ParameterObjectBuilder extends Builder {
2507
- buildBody(apexDocObject, reference) {
2508
- return __spreadProps$2(__spreadValues$2({}, apexDocObject), {
2509
- schema: this.getOpenApiSchemaFromApexDocSchema(apexDocObject, reference)
2510
- });
2511
- }
2512
- }
2513
-
2514
- class ResponsesBuilder extends Builder {
2515
- buildBody(apexDocResponseDefinition, reference) {
2516
- let description = `Status code ${apexDocResponseDefinition.statusCode}`;
2517
- if (apexDocResponseDefinition.description) {
2518
- description = apexDocResponseDefinition.description;
2519
- }
2520
- return {
2521
- description,
2522
- content: {
2523
- "application/json": {
2524
- schema: this.getOpenApiSchemaFromApexDocSchema(apexDocResponseDefinition, reference)
2525
- }
2526
- }
2527
- };
2528
- }
2529
- }
2530
-
2531
- class RequestBodyBuilder extends Builder {
2532
- buildBody(apexRequestBody, reference) {
2533
- return {
2534
- description: apexRequestBody.description,
2535
- content: {
2536
- "application/json": { schema: this.getOpenApiSchemaFromApexDocSchema(apexRequestBody, reference) }
2537
- },
2538
- required: apexRequestBody.required
2539
- };
2540
- }
2541
- }
2542
-
2543
- class MethodMirrorWrapper {
2544
- constructor(methodMirror) {
2545
- this.methodMirror = methodMirror;
2546
- this.hasDocCommentAnnotation = (annotationName) => {
2547
- var _a;
2548
- return (_a = this.methodMirror.docComment) == null ? void 0 : _a.annotations.some((annotation) => annotation.name.toLowerCase() === annotationName);
2549
- };
2550
- this.getDocCommentAnnotation = (annotationName) => {
2551
- var _a;
2552
- return (_a = this.methodMirror.docComment) == null ? void 0 : _a.annotations.find((annotation) => annotation.name.toLowerCase() === annotationName);
2553
- };
2554
- }
2555
- }
4
+ var logger$1 = require('../logger-Ce4QqPFR.js');
5
+ var cosmiconfig = require('cosmiconfig');
6
+ var yargs = require('yargs');
7
+ var cosmiconfigTypescriptLoader = require('cosmiconfig-typescript-loader');
8
+ var E = require('fp-ts/Either');
9
+ require('fp-ts/function');
10
+ require('fp-ts/TaskEither');
11
+ require('js-yaml');
12
+ require('path');
13
+ require('fp-ts/Task');
14
+ require('fp-ts/lib/Array');
15
+ require('@cparra/apex-reflection');
16
+ require('fp-ts/Option');
17
+ require('fast-xml-parser');
18
+ require('handlebars');
19
+ require('fp-ts/boolean');
20
+ require('fs');
21
+ require('fp-ts/lib/TaskEither');
22
+ require('chalk');
2556
23
 
2557
- class MethodParser {
2558
- constructor(openApiModel) {
2559
- this.openApiModel = openApiModel;
2560
- }
2561
- parseMethod(classMirror, httpUrlEndpoint, httpMethodKey, tag) {
2562
- var _a, _b;
2563
- const classMirrorWrapper = new ClassMirrorWrapper(classMirror);
2564
- const httpMethods = classMirrorWrapper.getMethodsByAnnotation(`http${httpMethodKey}`);
2565
- if (!httpMethods.length) {
2566
- return;
2567
- }
2568
- const httpMethod = httpMethods[0];
2569
- this.openApiModel.paths[httpUrlEndpoint][httpMethodKey] = {};
2570
- this.openApiModel.paths[httpUrlEndpoint][httpMethodKey].tags = [tag];
2571
- if ((_a = httpMethod.docComment) == null ? void 0 : _a.description) {
2572
- this.openApiModel.paths[httpUrlEndpoint][httpMethodKey].description = httpMethod.docComment.description;
2573
- }
2574
- const methodMirrorWrapper = new MethodMirrorWrapper(httpMethod);
2575
- if (methodMirrorWrapper.hasDocCommentAnnotation("summary")) {
2576
- this.openApiModel.paths[httpUrlEndpoint][httpMethodKey].summary = (_b = methodMirrorWrapper.getDocCommentAnnotation("summary")) == null ? void 0 : _b.body;
2577
- }
2578
- this.parseHttpAnnotation(
2579
- httpMethod,
2580
- httpUrlEndpoint,
2581
- httpMethodKey,
2582
- "http-request-body",
2583
- this.addRequestBodyToOpenApi.bind(this),
2584
- this.fallbackHttpRequestBodyParser(httpUrlEndpoint, httpMethodKey)
2585
- );
2586
- this.parseHttpAnnotation(
2587
- httpMethod,
2588
- httpUrlEndpoint,
2589
- httpMethodKey,
2590
- "http-parameter",
2591
- this.addParametersToOpenApi.bind(this)
2592
- );
2593
- this.parseHttpAnnotation(
2594
- httpMethod,
2595
- httpUrlEndpoint,
2596
- httpMethodKey,
2597
- "http-response",
2598
- this.addHttpResponsesToOpenApi.bind(this),
2599
- this.getFallbackHttpResponseParser(httpUrlEndpoint, httpMethodKey)
2600
- );
2601
- }
2602
- parseHttpAnnotation(httpMethod, urlValue, httpMethodKey, annotationName, addToOpenApi, fallbackParser) {
2603
- var _a;
2604
- const annotations = (_a = httpMethod.docComment) == null ? void 0 : _a.annotations.filter((annotation) => annotation.name === annotationName);
2605
- if (!(annotations == null ? void 0 : annotations.length)) {
2606
- if (fallbackParser) {
2607
- fallbackParser(httpMethod);
2608
- }
2609
- return;
2610
- }
2611
- for (const annotation of annotations) {
2612
- const inYaml = annotation == null ? void 0 : annotation.bodyLines.reduce((prev, current) => prev + "\n" + current);
2613
- if (!inYaml) {
2614
- return;
2615
- }
2616
- this.addToOpenApiStrategy(inYaml, urlValue, httpMethodKey, addToOpenApi);
2617
- }
2618
- }
2619
- addToOpenApiStrategy(inYaml, urlValue, httpMethodKey, addToOpenApi) {
2620
- const inJson = yaml__namespace.load(inYaml);
2621
- const requestBodyResponse = new RequestBodyBuilder().build(inJson);
2622
- addToOpenApi(inJson, urlValue, httpMethodKey);
2623
- this.addReference(requestBodyResponse);
2624
- }
2625
- addRequestBodyToOpenApi(input, urlValue, httpMethodKey) {
2626
- const requestBodyResponse = new RequestBodyBuilder().build(input);
2627
- this.openApiModel.paths[urlValue][httpMethodKey].requestBody = requestBodyResponse.body;
2628
- }
2629
- addParametersToOpenApi(input, urlValue, httpMethodKey) {
2630
- const parameterObjectResponse = new ParameterObjectBuilder().build(input);
2631
- if (this.openApiModel.paths[urlValue][httpMethodKey].parameters === void 0) {
2632
- this.openApiModel.paths[urlValue][httpMethodKey].parameters = [];
2633
- }
2634
- this.openApiModel.paths[urlValue][httpMethodKey].parameters.push(parameterObjectResponse.body);
2635
- }
2636
- addHttpResponsesToOpenApi(input, urlValue, httpMethodKey) {
2637
- const responseObjectResponse = new ResponsesBuilder().build(input);
2638
- if (this.openApiModel.paths[urlValue][httpMethodKey].responses === void 0) {
2639
- this.openApiModel.paths[urlValue][httpMethodKey].responses = {};
2640
- }
2641
- this.openApiModel.paths[urlValue][httpMethodKey].responses[input.statusCode] = responseObjectResponse.body;
2642
- }
2643
- fallbackHttpRequestBodyParser(httpUrlEndpoint, httpMethodKey) {
2644
- return (methodMirror) => {
2645
- const parameters = methodMirror.parameters;
2646
- if (!parameters.length) {
2647
- return;
2648
- }
2649
- const propertiesObject = {};
2650
- parameters.forEach((currentParameter) => {
2651
- const propertyKey = currentParameter.name;
2652
- const propertyReference = new ReferenceBuilder().getReferenceType(currentParameter.typeReference);
2653
- propertiesObject[propertyKey] = propertyReference.schema;
2654
- this.addReference({
2655
- reference: {
2656
- entrypointReferenceObject: propertyReference.schema,
2657
- referenceComponents: propertyReference.referenceComponents
2658
- }
24
+ function _interopNamespaceDefault(e) {
25
+ var n = Object.create(null);
26
+ if (e) {
27
+ Object.keys(e).forEach(function (k) {
28
+ if (k !== 'default') {
29
+ var d = Object.getOwnPropertyDescriptor(e, k);
30
+ Object.defineProperty(n, k, d.get ? d : {
31
+ enumerable: true,
32
+ get: function () { return e[k]; }
2659
33
  });
2660
- });
2661
- this.openApiModel.paths[httpUrlEndpoint][httpMethodKey].requestBody = {
2662
- content: {
2663
- "application/json": {
2664
- schema: {
2665
- type: "object",
2666
- properties: propertiesObject
2667
- }
2668
- }
2669
- }
2670
- };
2671
- };
2672
- }
2673
- getFallbackHttpResponseParser(httpUrlEndpoint, httpMethodKey) {
2674
- return (methodMirror) => {
2675
- var _a, _b;
2676
- const returnType = methodMirror.typeReference;
2677
- if (returnType.type.toLowerCase() === "void") {
2678
- return;
2679
- }
2680
- const reference = new ReferenceBuilder().getReferenceType(returnType);
2681
- this.addReference({
2682
- reference: {
2683
- entrypointReferenceObject: reference.schema,
2684
- referenceComponents: reference.referenceComponents
2685
- }
2686
- });
2687
- if (this.openApiModel.paths[httpUrlEndpoint][httpMethodKey].responses === void 0) {
2688
- this.openApiModel.paths[httpUrlEndpoint][httpMethodKey].responses = {};
2689
- }
2690
- this.openApiModel.paths[httpUrlEndpoint][httpMethodKey].responses["200"] = {
2691
- description: (_b = (_a = methodMirror.docComment) == null ? void 0 : _a.description) != null ? _b : "Status code 200",
2692
- content: {
2693
- "application/json": { schema: reference.schema }
2694
- }
2695
- };
2696
- };
2697
- }
2698
- addReference(referenceHolder) {
2699
- if (referenceHolder.reference) {
2700
- if (this.openApiModel.components === void 0) {
2701
- this.openApiModel.components = {
2702
- schemas: {}
2703
- };
2704
- }
2705
- if (!referenceHolder.reference.referenceComponents.length) {
2706
- return;
2707
- }
2708
- referenceHolder.reference.referenceComponents.forEach((current) => {
2709
- this.openApiModel.components.schemas[current.referencedClass] = current.schema;
2710
- });
2711
- }
2712
- }
2713
- }
2714
-
2715
- const camel2title = (camelCase) => camelCase.replace(/\//g, " ").replace(/([A-Z])/g, (match) => ` ${match}`).replace(/\b\w/g, (match) => match.toUpperCase()).replace(/^./, (match) => match.toUpperCase()).trim();
2716
-
2717
- var __defProp$1 = Object.defineProperty;
2718
- var __defProps$1 = Object.defineProperties;
2719
- var __getOwnPropDescs$1 = Object.getOwnPropertyDescriptors;
2720
- var __getOwnPropSymbols$1 = Object.getOwnPropertySymbols;
2721
- var __hasOwnProp$1 = Object.prototype.hasOwnProperty;
2722
- var __propIsEnum$1 = Object.prototype.propertyIsEnumerable;
2723
- var __defNormalProp$1 = (obj, key, value) => key in obj ? __defProp$1(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
2724
- var __spreadValues$1 = (a, b) => {
2725
- for (var prop in b || (b = {}))
2726
- if (__hasOwnProp$1.call(b, prop))
2727
- __defNormalProp$1(a, prop, b[prop]);
2728
- if (__getOwnPropSymbols$1)
2729
- for (var prop of __getOwnPropSymbols$1(b)) {
2730
- if (__propIsEnum$1.call(b, prop))
2731
- __defNormalProp$1(a, prop, b[prop]);
2732
- }
2733
- return a;
2734
- };
2735
- var __spreadProps$1 = (a, b) => __defProps$1(a, __getOwnPropDescs$1(b));
2736
- function createOpenApiFile(fileName, openApiModel) {
2737
- const content = JSON.stringify(__spreadProps$1(__spreadValues$1({}, openApiModel), { namespace: void 0 }), null, 2);
2738
- return {
2739
- outputDocPath: `${fileName}.json`,
2740
- content,
2741
- frontmatter: null,
2742
- group: null
2743
- };
2744
- }
2745
-
2746
- class OpenApiDocsProcessor {
2747
- constructor() {
2748
- this.onAfterProcess = () => {
2749
- const page = createOpenApiFile(OpenApiSettings.getInstance().openApiFileName(), this.openApiModel);
2750
- this._fileContainer.pushFile(page);
2751
- };
2752
- this._fileContainer = new FileContainer();
2753
- const title = OpenApiSettings.getInstance().getOpenApiTitle();
2754
- if (!title) {
2755
- throw Error("No OpenApi title was provided.");
2756
- }
2757
- this.openApiModel = new OpenApi(
2758
- title,
2759
- OpenApiSettings.getInstance().getVersion(),
2760
- OpenApiSettings.getInstance().getNamespace()
2761
- );
2762
- }
2763
- fileBuilder() {
2764
- return this._fileContainer;
2765
- }
2766
- onProcess(type) {
2767
- var _a, _b;
2768
- Logger.logSingle(`Processing ${type.name}`, "green");
2769
- const endpointPath = this.getEndpointPath(type);
2770
- if (!endpointPath) {
2771
- return;
2772
- }
2773
- this.openApiModel.paths[endpointPath] = {};
2774
- if ((_a = type.docComment) == null ? void 0 : _a.description) {
2775
- this.openApiModel.paths[endpointPath].description = type.docComment.description;
2776
- }
2777
- const typeAsClass = type;
2778
- const tagName = camel2title(endpointPath);
2779
- this.openApiModel.tags.push({
2780
- name: tagName,
2781
- description: (_b = type.docComment) == null ? void 0 : _b.description
2782
- });
2783
- const parser = new MethodParser(this.openApiModel);
2784
- parser.parseMethod(typeAsClass, endpointPath, "get", tagName);
2785
- parser.parseMethod(typeAsClass, endpointPath, "patch", tagName);
2786
- parser.parseMethod(typeAsClass, endpointPath, "post", tagName);
2787
- parser.parseMethod(typeAsClass, endpointPath, "put", tagName);
2788
- parser.parseMethod(typeAsClass, endpointPath, "delete", tagName);
2789
- }
2790
- getEndpointPath(type) {
2791
- var _a;
2792
- const restResourceAnnotation = type.annotations.find((element) => element.name.toLowerCase() === "restresource");
2793
- const urlMapping = (_a = restResourceAnnotation == null ? void 0 : restResourceAnnotation.elementValues) == null ? void 0 : _a.find(
2794
- (element) => element.key.toLowerCase() === "urlmapping"
2795
- );
2796
- if (!urlMapping) {
2797
- Logger.error(`Type does not contain urlMapping annotation ${type.name}`);
2798
- return null;
2799
- }
2800
- let endpointPath = urlMapping.value.replaceAll('"', "").replaceAll("'", "").replaceAll("/*", "/");
2801
- if (endpointPath.startsWith("/")) {
2802
- endpointPath = endpointPath.substring(1);
2803
- }
2804
- return endpointPath;
2805
- }
2806
- }
2807
-
2808
- var __async$4 = (__this, __arguments, generator) => {
2809
- return new Promise((resolve, reject) => {
2810
- var fulfilled = (value) => {
2811
- try {
2812
- step(generator.next(value));
2813
- } catch (e) {
2814
- reject(e);
2815
- }
2816
- };
2817
- var rejected = (value) => {
2818
- try {
2819
- step(generator.throw(value));
2820
- } catch (e) {
2821
- reject(e);
2822
- }
2823
- };
2824
- var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
2825
- step((generator = generator.apply(__this, __arguments)).next());
2826
- });
2827
- };
2828
- function openApi(fileBodies, config) {
2829
- return __async$4(this, null, function* () {
2830
- OpenApiSettings.build({
2831
- sourceDirectory: config.sourceDir,
2832
- outputDir: config.targetDir,
2833
- openApiFileName: config.fileName,
2834
- openApiTitle: config.title,
2835
- namespace: config.namespace,
2836
- version: config.apiVersion
2837
- });
2838
- const manifest = createManifest(new RawBodyParser(fileBodies), reflectionWithLogger);
2839
- TypesRepository.getInstance().populateAll(manifest.types);
2840
- const filteredTypes = filterByScopes(manifest);
2841
- const processor = new OpenApiDocsProcessor();
2842
- Transpiler.generate(filteredTypes, processor);
2843
- const generatedFiles = processor.fileBuilder().files();
2844
- yield _function.pipe(
2845
- writeFiles(generatedFiles, config.targetDir, (file) => {
2846
- Logger.logSingle(`${file.outputDocPath} processed.`, "green");
2847
- }),
2848
- TE__namespace.map(() => Logger.logSingle("\u2714\uFE0F Documentation generated successfully!")),
2849
- TE__namespace.mapError((error) => Logger.error(error))
2850
- )();
2851
- ErrorLogger.logErrors(filteredTypes);
2852
- });
2853
- }
2854
- function reflectionWithLogger(apexBundle) {
2855
- var _a;
2856
- const result = apexReflection.reflect(apexBundle.content);
2857
- if (result.error) {
2858
- Logger.error(`${apexBundle.filePath} - Parsing error ${(_a = result.error) == null ? void 0 : _a.message}`);
2859
- }
2860
- return result;
2861
- }
2862
- function filterByScopes(manifest) {
2863
- const filteredTypes = manifest.filteredByAccessModifierAndAnnotations([
2864
- "restresource",
2865
- "httpdelete",
2866
- "httpget",
2867
- "httppatch",
2868
- "httppost",
2869
- "httpput"
2870
- ]);
2871
- const filteredLogMessage = `Filtered ${manifest.types.length - filteredTypes.length} file(s), only keeping classes annotated as @RestResource.`;
2872
- Logger.logSingle(filteredLogMessage, "green");
2873
- Logger.logSingle(`Creating documentation for ${filteredTypes.length} file(s)`, "green");
2874
- return filteredTypes;
2875
- }
2876
-
2877
- var __async$3 = (__this, __arguments, generator) => {
2878
- return new Promise((resolve, reject) => {
2879
- var fulfilled = (value) => {
2880
- try {
2881
- step(generator.next(value));
2882
- } catch (e) {
2883
- reject(e);
2884
- }
2885
- };
2886
- var rejected = (value) => {
2887
- try {
2888
- step(generator.throw(value));
2889
- } catch (e) {
2890
- reject(e);
2891
- }
2892
- };
2893
- var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
2894
- step((generator = generator.apply(__this, __arguments)).next());
2895
- });
2896
- };
2897
- const APEX_FILE_EXTENSION = ".cls";
2898
- class ApexFileReader {
2899
- /**
2900
- * Reads from .cls files and returns their raw body.
2901
- */
2902
- static processFiles(fileSystem, rootPath, includeMetadata) {
2903
- return __async$3(this, null, function* () {
2904
- const filePaths = yield this.getFilePaths(fileSystem, rootPath);
2905
- const apexFilePaths = filePaths.filter((filePath) => this.isApexFile(filePath));
2906
- const filePromises = apexFilePaths.map((filePath) => this.processFile(fileSystem, filePath, includeMetadata));
2907
- return Promise.all(filePromises);
2908
- });
2909
- }
2910
- static getFilePaths(fileSystem, rootPath) {
2911
- return __async$3(this, null, function* () {
2912
- const directoryContents = yield fileSystem.readDirectory(rootPath);
2913
- const paths = [];
2914
- for (const filePath of directoryContents) {
2915
- const currentPath = fileSystem.joinPath(rootPath, filePath);
2916
- if (yield fileSystem.isDirectory(currentPath)) {
2917
- paths.push(...yield this.getFilePaths(fileSystem, currentPath));
2918
- }
2919
- paths.push(currentPath);
2920
- }
2921
- return paths;
2922
- });
2923
- }
2924
- static processFile(fileSystem, filePath, includeMetadata) {
2925
- return __async$3(this, null, function* () {
2926
- const rawTypeContent = yield fileSystem.readFile(filePath);
2927
- const metadataPath = `${filePath}-meta.xml`;
2928
- let rawMetadataContent = null;
2929
- if (includeMetadata) {
2930
- rawMetadataContent = fileSystem.exists(metadataPath) ? yield fileSystem.readFile(metadataPath) : null;
2931
- }
2932
- return { filePath, content: rawTypeContent, metadataContent: rawMetadataContent };
2933
- });
2934
- }
2935
- static isApexFile(currentFile) {
2936
- return currentFile.endsWith(APEX_FILE_EXTENSION);
2937
- }
2938
- }
2939
-
2940
- var __async$2 = (__this, __arguments, generator) => {
2941
- return new Promise((resolve, reject) => {
2942
- var fulfilled = (value) => {
2943
- try {
2944
- step(generator.next(value));
2945
- } catch (e) {
2946
- reject(e);
2947
- }
2948
- };
2949
- var rejected = (value) => {
2950
- try {
2951
- step(generator.throw(value));
2952
- } catch (e) {
2953
- reject(e);
2954
34
  }
2955
- };
2956
- var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
2957
- step((generator = generator.apply(__this, __arguments)).next());
2958
- });
2959
- };
2960
- function stat(path2) {
2961
- return new Promise((resolve, reject) => {
2962
- fs__namespace.stat(path2, (err, stats) => {
2963
- if (err) {
2964
- reject(err);
2965
- } else {
2966
- resolve(stats);
2967
- }
2968
- });
2969
- });
2970
- }
2971
- function readdir(path2) {
2972
- return new Promise((resolve, reject) => {
2973
- fs__namespace.readdir(path2, (err, files) => {
2974
- if (err) {
2975
- reject(err);
2976
- } else {
2977
- resolve(files);
2978
- }
2979
- });
2980
- });
2981
- }
2982
- function readFile(path2) {
2983
- return new Promise((resolve, reject) => {
2984
- fs__namespace.readFile(path2, (err, data) => {
2985
- if (err) {
2986
- reject(err);
2987
- } else {
2988
- resolve(data.toString());
2989
- }
2990
- });
2991
- });
2992
- }
2993
- class DefaultFileSystem {
2994
- isDirectory(pathToRead) {
2995
- return __async$2(this, null, function* () {
2996
- const stats = yield stat(pathToRead);
2997
- return stats.isDirectory();
2998
35
  });
2999
36
  }
3000
- readDirectory(sourceDirectory) {
3001
- return readdir(sourceDirectory);
3002
- }
3003
- readFile(pathToRead) {
3004
- return readFile(pathToRead);
3005
- }
3006
- joinPath(...paths) {
3007
- return path__namespace.join(...paths);
3008
- }
3009
- exists(path2) {
3010
- return fs__namespace.existsSync(path2);
3011
- }
37
+ n.default = e;
38
+ return Object.freeze(n);
3012
39
  }
3013
40
 
3014
- var __async$1 = (__this, __arguments, generator) => {
3015
- return new Promise((resolve, reject) => {
3016
- var fulfilled = (value) => {
3017
- try {
3018
- step(generator.next(value));
3019
- } catch (e) {
3020
- reject(e);
3021
- }
3022
- };
3023
- var rejected = (value) => {
3024
- try {
3025
- step(generator.throw(value));
3026
- } catch (e) {
3027
- reject(e);
3028
- }
3029
- };
3030
- var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
3031
- step((generator = generator.apply(__this, __arguments)).next());
3032
- });
3033
- };
3034
- class Apexdocs {
3035
- /**
3036
- * Generates documentation out of Apex source files.
3037
- */
3038
- static generate(config) {
3039
- return __async$1(this, null, function* () {
3040
- Logger.logSingle(`Generating ${config.targetGenerator} documentation...`);
3041
- try {
3042
- const fileBodies = yield ApexFileReader.processFiles(
3043
- new DefaultFileSystem(),
3044
- config.sourceDir,
3045
- config.targetGenerator === "markdown" ? config.includeMetadata : false
3046
- );
3047
- switch (config.targetGenerator) {
3048
- case "markdown":
3049
- yield generateMarkdownDocumentation(fileBodies, config)();
3050
- break;
3051
- case "openapi":
3052
- yield openApi(fileBodies, config);
3053
- break;
3054
- }
3055
- } catch (error) {
3056
- Logger.logSingle(`\u274C An error occurred while generating the documentation: ${error}`, "red");
3057
- }
3058
- });
3059
- }
3060
- }
3061
- function generateMarkdownDocumentation(fileBodies, config) {
3062
- return _function.pipe(
3063
- generate(fileBodies, config),
3064
- TE__namespace.map(() => Logger.logSingle("\u2714\uFE0F Documentation generated successfully!")),
3065
- TE__namespace.mapLeft((error) => {
3066
- if (error._tag === "HookError") {
3067
- Logger.error("Error(s) occurred while processing hooks. Please review the following issues:");
3068
- Logger.error(error.error);
3069
- return;
3070
- }
3071
- if (error._tag === "FileWritingError") {
3072
- Logger.error(error.message);
3073
- Logger.error(error.error);
3074
- return;
3075
- }
3076
- const errorMessages = [
3077
- "Error(s) occurred while parsing files. Please review the following issues:",
3078
- ...error.errors.map(formatReflectionError)
3079
- ].join("\n");
3080
- Logger.error(errorMessages);
3081
- })
3082
- );
3083
- }
3084
- function formatReflectionError(error) {
3085
- return `Source file: ${error.file}
3086
- ${error.message}
3087
- `;
3088
- }
41
+ var yargs__namespace = /*#__PURE__*/_interopNamespaceDefault(yargs);
42
+ var E__namespace = /*#__PURE__*/_interopNamespaceDefault(E);
3089
43
 
3090
44
  const markdownOptions = {
3091
45
  sourceDir: {
@@ -3097,40 +51,45 @@ const markdownOptions = {
3097
51
  targetDir: {
3098
52
  type: "string",
3099
53
  alias: "t",
3100
- default: defaults.defaults.targetDir,
54
+ default: logger$1.markdownDefaults.targetDir,
3101
55
  describe: "The directory location where documentation will be generated to."
3102
56
  },
3103
57
  scope: {
3104
58
  type: "string",
3105
59
  array: true,
3106
60
  alias: "p",
3107
- default: defaults.defaults.scope,
61
+ default: logger$1.markdownDefaults.scope,
3108
62
  describe: "A list of scopes to document. Values should be separated by a space, e.g --scope global public namespaceaccessible. Annotations are supported and should be passed lowercased and without the @ symbol, e.g. namespaceaccessible auraenabled."
3109
63
  },
3110
64
  defaultGroupName: {
3111
65
  type: "string",
3112
- default: defaults.defaults.defaultGroupName,
66
+ default: logger$1.markdownDefaults.defaultGroupName,
3113
67
  describe: "Defines the @group name to be used when a file does not specify it."
3114
68
  },
3115
69
  namespace: {
3116
70
  type: "string",
3117
71
  describe: "The package namespace, if any. If provided, it will be added to the generated files."
3118
72
  },
3119
- sortMembersAlphabetically: {
73
+ sortAlphabetically: {
3120
74
  type: "boolean",
3121
- describe: "Whether to sort members alphabetically.",
3122
- default: defaults.defaults.sortMembersAlphabetically
75
+ describe: "Whether to sort files and members alphabetically.",
76
+ default: logger$1.markdownDefaults.sortAlphabetically
3123
77
  },
3124
78
  includeMetadata: {
3125
79
  type: "boolean",
3126
80
  describe: "Whether to include the file's meta.xml information: Whether it is active and and the API version",
3127
- default: defaults.defaults.includeMetadata
81
+ default: logger$1.markdownDefaults.includeMetadata
3128
82
  },
3129
83
  linkingStrategy: {
3130
84
  type: "string",
3131
85
  describe: "The strategy to use when linking to other documentation pages.",
3132
86
  choices: ["relative", "no-link", "none"],
3133
- default: defaults.defaults.linkingStrategy
87
+ default: logger$1.markdownDefaults.linkingStrategy
88
+ },
89
+ referenceGuideTitle: {
90
+ type: "string",
91
+ describe: "The title of the reference guide.",
92
+ default: logger$1.markdownDefaults.referenceGuideTitle
3134
93
  }
3135
94
  };
3136
95
 
@@ -3144,12 +103,12 @@ const openApiOptions = {
3144
103
  targetDir: {
3145
104
  type: "string",
3146
105
  alias: "t",
3147
- default: defaults.defaults.targetDir,
106
+ default: logger$1.markdownDefaults.targetDir,
3148
107
  describe: "The directory location where the OpenApi file will be generated."
3149
108
  },
3150
109
  fileName: {
3151
110
  type: "string",
3152
- default: "openapi",
111
+ default: logger$1.openApiDefaults.fileName,
3153
112
  describe: "The name of the OpenApi file to be generated."
3154
113
  },
3155
114
  namespace: {
@@ -3158,12 +117,12 @@ const openApiOptions = {
3158
117
  },
3159
118
  title: {
3160
119
  type: "string",
3161
- default: "Apex REST API",
120
+ default: logger$1.openApiDefaults.title,
3162
121
  describe: "The title of the OpenApi file."
3163
122
  },
3164
123
  apiVersion: {
3165
124
  type: "string",
3166
- default: "1.0.0",
125
+ default: logger$1.openApiDefaults.apiVersion,
3167
126
  describe: "The version of the OpenApi file."
3168
127
  }
3169
128
  };
@@ -3207,6 +166,9 @@ var __async = (__this, __arguments, generator) => {
3207
166
  step((generator = generator.apply(__this, __arguments)).next());
3208
167
  });
3209
168
  };
169
+ const configOnlyDefaults = {
170
+ excludeTags: []
171
+ };
3210
172
  function _extractConfig() {
3211
173
  return cosmiconfig.cosmiconfig("apexdocs", {
3212
174
  loaders: {
@@ -3230,15 +192,32 @@ function extractArgs() {
3230
192
  const config = yield _extractConfig();
3231
193
  const cliArgs = _extractYargs(config);
3232
194
  const commandName = cliArgs._[0];
3233
- return __spreadProps(__spreadValues(__spreadValues({}, config == null ? void 0 : config.config), cliArgs), { targetGenerator: commandName });
195
+ const mergedConfig = __spreadProps(__spreadValues(__spreadValues({}, config == null ? void 0 : config.config), cliArgs), { targetGenerator: commandName });
196
+ if (mergedConfig.targetGenerator === "markdown") {
197
+ return __spreadValues(__spreadValues({}, configOnlyDefaults), mergedConfig);
198
+ } else {
199
+ return mergedConfig;
200
+ }
3234
201
  });
3235
202
  }
3236
203
 
204
+ const logger = new logger$1.StdOutLogger();
3237
205
  function main() {
3238
- function catchError(error) {
3239
- console.error(error);
206
+ function parseResult(result) {
207
+ E__namespace.match(
208
+ (error) => {
209
+ logger.error(`\u274C An error occurred while generating the documentation: ${error}`);
210
+ process.exit(1);
211
+ },
212
+ (successMessage) => {
213
+ logger.logSingle(successMessage);
214
+ }
215
+ )(result);
216
+ }
217
+ function catchUnexpectedError(error) {
218
+ logger.error(`\u274C An unexpected error occurred: ${error.message}`);
3240
219
  process.exit(1);
3241
220
  }
3242
- extractArgs().then((config) => Apexdocs.generate(config).catch(catchError)).catch(catchError);
221
+ extractArgs().then((config) => logger$1.Apexdocs.generate(config, logger).then(parseResult)).catch(catchUnexpectedError);
3243
222
  }
3244
223
  main();