@cparra/apexdocs 3.3.0-alpha.0 → 3.3.1

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