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

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 (189) hide show
  1. package/dist/cli/generate.js +2745 -39
  2. package/dist/defaults-DUwru49Q.js +12 -0
  3. package/dist/defaults-SH0Rsi5E.js +11 -0
  4. package/dist/index.d.ts +62 -2
  5. package/dist/index.js +36 -1
  6. package/examples/plain-markdown/docs/Miscellaneous/ns.BaseClass.md +1 -1
  7. package/examples/plain-markdown/docs/Miscellaneous/ns.MultiInheritanceClass.md +1 -1
  8. package/examples/plain-markdown/docs/Miscellaneous/ns.ParentInterface.md +1 -1
  9. package/examples/plain-markdown/docs/Miscellaneous/ns.ReferencedEnum.md +1 -1
  10. package/examples/plain-markdown/docs/Miscellaneous/ns.SampleException.md +1 -1
  11. package/examples/plain-markdown/docs/Miscellaneous/ns.SampleInterface.md +1 -1
  12. package/examples/plain-markdown/docs/Miscellaneous/ns.Url.md +1 -1
  13. package/examples/plain-markdown/docs/Sample-Enums/ns.SampleEnum.md +1 -1
  14. package/examples/plain-markdown/docs/SampleGroup/ns.SampleClass.md +1 -1
  15. package/examples/plain-markdown/docs/index.md +1 -1
  16. package/examples/plain-markdown/package.json +3 -4
  17. package/examples/vitepress/.forceignore +12 -0
  18. package/examples/vitepress/apexdocs.config.ts +108 -0
  19. package/examples/vitepress/config/project-scratch-def.json +13 -0
  20. package/examples/vitepress/docs/.vitepress/cache/deps/@theme_index.js +259 -0
  21. package/examples/vitepress/docs/.vitepress/cache/deps/@theme_index.js.map +7 -0
  22. package/examples/vitepress/docs/.vitepress/cache/deps/_metadata.json +40 -0
  23. package/examples/vitepress/docs/.vitepress/cache/deps/chunk-574YRH25.js +11474 -0
  24. package/examples/vitepress/docs/.vitepress/cache/deps/chunk-574YRH25.js.map +7 -0
  25. package/examples/vitepress/docs/.vitepress/cache/deps/chunk-E5DZZB2I.js +9172 -0
  26. package/examples/vitepress/docs/.vitepress/cache/deps/chunk-E5DZZB2I.js.map +7 -0
  27. package/examples/vitepress/docs/.vitepress/cache/deps/package.json +3 -0
  28. package/examples/vitepress/docs/.vitepress/cache/deps/vitepress___@vue_devtools-api.js +4339 -0
  29. package/examples/vitepress/docs/.vitepress/cache/deps/vitepress___@vue_devtools-api.js.map +7 -0
  30. package/examples/vitepress/docs/.vitepress/cache/deps/vitepress___@vueuse_core.js +567 -0
  31. package/examples/vitepress/docs/.vitepress/cache/deps/vitepress___@vueuse_core.js.map +7 -0
  32. package/examples/vitepress/docs/.vitepress/cache/deps/vue.js +323 -0
  33. package/examples/vitepress/docs/.vitepress/cache/deps/vue.js.map +7 -0
  34. package/examples/vitepress/docs/.vitepress/config.mts +21 -0
  35. package/examples/vitepress/docs/.vitepress/sidebar.json +119 -0
  36. package/examples/vitepress/docs/Miscellaneous/apexdocs.BaseClass.md +20 -0
  37. package/examples/vitepress/docs/Miscellaneous/apexdocs.MultiInheritanceClass.md +78 -0
  38. package/examples/vitepress/docs/Miscellaneous/apexdocs.ParentInterface.md +19 -0
  39. package/examples/vitepress/docs/Miscellaneous/apexdocs.ReferencedEnum.md +15 -0
  40. package/examples/vitepress/docs/Miscellaneous/apexdocs.SampleException.md +28 -0
  41. package/examples/vitepress/docs/Miscellaneous/apexdocs.SampleInterface.md +122 -0
  42. package/examples/vitepress/docs/Miscellaneous/apexdocs.Url.md +318 -0
  43. package/examples/vitepress/docs/Sample-Enums/apexdocs.SampleEnum.md +41 -0
  44. package/examples/vitepress/docs/SampleGroup/apexdocs.SampleClass.md +178 -0
  45. package/examples/vitepress/docs/api-examples.md +49 -0
  46. package/examples/vitepress/docs/index-frontmatter.md +16 -0
  47. package/examples/vitepress/docs/index.md +127 -0
  48. package/examples/vitepress/docs/markdown-examples.md +85 -0
  49. package/examples/vitepress/force-app/main/default/classes/BaseClass.cls +3 -0
  50. package/examples/vitepress/force-app/main/default/classes/MultiInheritanceClass.cls +1 -0
  51. package/examples/vitepress/force-app/main/default/classes/ParentInterface.cls +3 -0
  52. package/examples/vitepress/force-app/main/default/classes/ReferencedEnum.cls +5 -0
  53. package/examples/vitepress/force-app/main/default/classes/SampleClass.cls +72 -0
  54. package/examples/vitepress/force-app/main/default/classes/SampleEnum.cls +30 -0
  55. package/examples/vitepress/force-app/main/default/classes/SampleException.cls +17 -0
  56. package/examples/vitepress/force-app/main/default/classes/SampleInterface.cls +46 -0
  57. package/examples/vitepress/force-app/main/default/classes/Url.cls +195 -0
  58. package/examples/vitepress/package-lock.json +2574 -0
  59. package/examples/vitepress/package.json +18 -0
  60. package/examples/vitepress/sfdx-project.json +12 -0
  61. package/jest.config.js +1 -0
  62. package/package.json +10 -6
  63. package/src/application/Apexdocs.ts +16 -104
  64. package/src/application/__tests__/apex-file-reader.spec.ts +104 -0
  65. package/src/application/apex-file-reader.ts +42 -0
  66. package/src/application/file-writer.ts +25 -0
  67. package/src/application/generators/markdown.ts +53 -0
  68. package/src/application/generators/openapi.ts +56 -0
  69. package/src/cli/args.ts +17 -112
  70. package/src/cli/commands/markdown.ts +58 -0
  71. package/src/cli/generate.ts +7 -5
  72. package/src/{model/__tests__ → core/__test__}/manifest.spec.ts +1 -1
  73. package/src/core/manifest.ts +57 -51
  74. package/src/{__spec__/core → core/markdown/__test__}/expect-extensions.ts +5 -5
  75. package/src/core/markdown/__test__/generating-class-docs.spec.ts +727 -0
  76. package/src/{__spec__/core → core/markdown/__test__}/generating-enum-docs.spec.ts +82 -59
  77. package/src/{__spec__/core → core/markdown/__test__}/generating-interface-docs.spec.ts +94 -75
  78. package/src/core/markdown/__test__/generating-reference-guide.spec.ts +184 -0
  79. package/src/core/{__test__ → markdown/__test__}/inheritance-chain.test.ts +2 -2
  80. package/src/core/markdown/__test__/test-helpers.ts +22 -0
  81. package/src/core/{adapters → markdown/adapters}/__tests__/interface-adapter.spec.ts +38 -8
  82. package/src/core/{adapters → markdown/adapters}/apex-types.ts +7 -4
  83. package/src/core/{adapters → markdown/adapters}/inline.ts +1 -1
  84. package/src/core/markdown/adapters/renderable-bundle.ts +144 -0
  85. package/src/core/markdown/adapters/renderable-to-page-data.ts +92 -0
  86. package/src/core/{adapters → markdown/adapters}/types.d.ts +16 -2
  87. package/src/core/markdown/generate-docs.ts +158 -0
  88. package/src/core/markdown/reflection/error-handling.ts +37 -0
  89. package/src/core/markdown/reflection/filter-scope.ts +13 -0
  90. package/src/core/markdown/reflection/inheritance-chain-expanion.ts +22 -0
  91. package/src/core/markdown/reflection/inherited-member-expansion.ts +105 -0
  92. package/src/core/markdown/reflection/reflect-source.ts +41 -0
  93. package/src/core/markdown/reflection/sort-members.ts +59 -0
  94. package/src/{transpiler/markdown/plain-markdown → core/markdown/templates}/class-template.ts +2 -0
  95. package/src/core/markdown/templates/hookable.ts +7 -0
  96. package/src/core/{template.ts → markdown/templates/template.ts} +12 -12
  97. package/src/core/markdown/utils.ts +3 -0
  98. package/src/{transpiler → core}/openapi/__tests__/open-api-docs-processor.spec.ts +1 -1
  99. package/src/{model → core/openapi}/apex-type-wrappers/__tests__/ClassMirrorWrapper.spec.ts +3 -3
  100. package/src/core/openapi/file-container.ts +13 -0
  101. package/src/{service → core/openapi}/manifest-factory.ts +3 -3
  102. package/src/{transpiler → core}/openapi/open-api-docs-processor.ts +9 -10
  103. package/src/core/openapi/openapi-type-file.ts +14 -0
  104. package/src/{service → core/openapi}/parser.ts +8 -8
  105. package/src/{transpiler → core}/openapi/parsers/Builder.ts +2 -2
  106. package/src/{transpiler → core}/openapi/parsers/MethodParser.ts +5 -5
  107. package/src/{transpiler → core}/openapi/parsers/ParameterObjectBuilder.ts +2 -2
  108. package/src/{transpiler → core}/openapi/parsers/ReferenceBuilder.ts +3 -3
  109. package/src/{transpiler → core}/openapi/parsers/RequestBodyBuilder.ts +2 -2
  110. package/src/{transpiler → core}/openapi/parsers/ResponsesBuilder.ts +2 -2
  111. package/src/{transpiler → core}/openapi/parsers/__tests__/MethodParser.spec.ts +1 -1
  112. package/src/{transpiler → core}/openapi/parsers/__tests__/ParameterObjectBuilder.spec.ts +2 -2
  113. package/src/{transpiler → core}/openapi/parsers/__tests__/ReferenceBuilder.spec.ts +2 -2
  114. package/src/{transpiler → core}/openapi/parsers/__tests__/RequestBodyBuilder.spec.ts +2 -2
  115. package/src/{transpiler → core}/openapi/parsers/__tests__/ResponsesBuilder.spec.ts +1 -1
  116. package/src/{transpiler → core/openapi}/transpiler.ts +2 -6
  117. package/src/{model → core/openapi}/types-repository.ts +0 -9
  118. package/src/core/parse-apex-metadata.ts +14 -0
  119. package/src/core/settings.ts +56 -0
  120. package/src/core/shared/types.d.ts +92 -0
  121. package/src/core/shared/utils.ts +5 -0
  122. package/src/defaults.ts +8 -0
  123. package/src/index.ts +34 -2
  124. package/src/test-helpers/InterfaceMirrorBuilder.ts +0 -5
  125. package/src/test-helpers/SettingsBuilder.ts +1 -3
  126. package/src/util/logger.ts +2 -2
  127. package/src/util/string-utils.ts +0 -4
  128. package/tsconfig.json +5 -1
  129. package/apexdocs.config.ts +0 -13
  130. package/examples/plain-markdown/template.md +0 -3
  131. package/src/__spec__/core/generating-class-docs.spec.ts +0 -531
  132. package/src/__spec__/core/generating-reference-guide.spec.ts +0 -164
  133. package/src/__spec__/core/test-helpers.ts +0 -9
  134. package/src/application/generators/generate-markdown-files.ts +0 -53
  135. package/src/core/apex-bundle.ts +0 -3
  136. package/src/core/generate-docs.ts +0 -432
  137. package/src/model/markdown-file.ts +0 -122
  138. package/src/model/markdown-generation-util/doc-comment-annotation-util.ts +0 -50
  139. package/src/model/markdown-generation-util/field-declaration-util.ts +0 -71
  140. package/src/model/markdown-generation-util/index.ts +0 -3
  141. package/src/model/markdown-generation-util/method-declaration-util.ts +0 -166
  142. package/src/model/markdown-generation-util/type-declaration-util.ts +0 -91
  143. package/src/model/markdown-home-file.ts +0 -58
  144. package/src/model/markdown-type-file.ts +0 -169
  145. package/src/model/openapi/openapi-type-file.ts +0 -14
  146. package/src/model/outputFile.ts +0 -20
  147. package/src/service/__tests__/apex-file-reader.spec.ts +0 -93
  148. package/src/service/apex-file-reader.ts +0 -47
  149. package/src/service/file-writer.ts +0 -34
  150. package/src/service/metadata-processor.ts +0 -16
  151. package/src/service/state.ts +0 -24
  152. package/src/service/walkers/class-walker.ts +0 -30
  153. package/src/service/walkers/enum-walker.ts +0 -7
  154. package/src/service/walkers/interface-walker.ts +0 -12
  155. package/src/service/walkers/walker-factory.ts +0 -19
  156. package/src/service/walkers/walker.ts +0 -42
  157. package/src/settings.ts +0 -143
  158. package/src/transpiler/factory.ts +0 -31
  159. package/src/transpiler/file-container.ts +0 -13
  160. package/src/transpiler/generator-choices.ts +0 -1
  161. package/src/transpiler/markdown/class-file-generatorHelper.ts +0 -61
  162. package/src/transpiler/markdown/docsify/docsify-docs-processor.ts +0 -12
  163. package/src/transpiler/markdown/jekyll/jekyll-docsProcessor.ts +0 -50
  164. package/src/transpiler/markdown/markdown-transpiler-base.ts +0 -28
  165. package/src/transpiler/processor-type-transpiler.ts +0 -18
  166. /package/src/{service → application}/file-system.ts +0 -0
  167. /package/src/core/{adapters → markdown/adapters}/__tests__/documentables.spec.ts +0 -0
  168. /package/src/core/{adapters → markdown/adapters}/__tests__/references.spec.ts +0 -0
  169. /package/src/core/{adapters → markdown/adapters}/documentables.ts +0 -0
  170. /package/src/core/{adapters → markdown/adapters}/fields-and-properties.ts +0 -0
  171. /package/src/core/{adapters → markdown/adapters}/methods-and-constructors.ts +0 -0
  172. /package/src/core/{adapters → markdown/adapters}/type-utils.ts +0 -0
  173. /package/src/core/{inheritance-chain.ts → markdown/reflection/inheritance-chain.ts} +0 -0
  174. /package/src/{transpiler/markdown/plain-markdown → core/markdown/templates}/constructors-partial-template.ts +0 -0
  175. /package/src/{transpiler/markdown/plain-markdown → core/markdown/templates}/documentable-partial-template.ts +0 -0
  176. /package/src/{transpiler/markdown/plain-markdown → core/markdown/templates}/enum-template.ts +0 -0
  177. /package/src/{transpiler/markdown/plain-markdown → core/markdown/templates}/fieldsPartialTemplate.ts +0 -0
  178. /package/src/{transpiler/markdown/plain-markdown → core/markdown/templates}/grouped-members-partial-template.ts +0 -0
  179. /package/src/{transpiler/markdown/plain-markdown → core/markdown/templates}/interface-template.ts +0 -0
  180. /package/src/{transpiler/markdown/plain-markdown → core/markdown/templates}/methods-partial-template.ts +0 -0
  181. /package/src/core/{templates → markdown/templates}/reference-guide.ts +0 -0
  182. /package/src/{transpiler/markdown/plain-markdown → core/markdown/templates}/type-doc-partial.ts +0 -0
  183. /package/src/{service → core/openapi}/__tests__/manifest-factory.spec.ts +0 -0
  184. /package/src/{model → core}/openapi/__tests__/open-api.spec.ts +0 -0
  185. /package/src/{model → core}/openapi/apex-doc-types.ts +0 -0
  186. /package/src/{model → core/openapi}/apex-type-wrappers/ClassMirrorWrapper.ts +0 -0
  187. /package/src/{model → core/openapi}/apex-type-wrappers/MethodMirrorWrapper.ts +0 -0
  188. /package/src/{model → core}/openapi/open-api-types.ts +0 -0
  189. /package/src/{model → core}/openapi/open-api.ts +0 -0
@@ -0,0 +1,105 @@
1
+ import { ClassMirror, InterfaceMirror, Type } from '@cparra/apex-reflection';
2
+ import { ParsedFile } from '../../shared/types';
3
+ import { pipe } from 'fp-ts/function';
4
+ import { parsedFilesToTypes } from '../utils';
5
+
6
+ export const addInheritedMembersToTypes = (parsedFiles: ParsedFile[]) =>
7
+ parsedFiles.map((parsedFile) => addInheritedMembers(parsedFilesToTypes(parsedFiles), parsedFile));
8
+
9
+ export function addInheritedMembers(repository: Type[], parsedFile: ParsedFile): ParsedFile {
10
+ function addInheritedMembersToType<T extends Type>(repository: Type[], current: T): T {
11
+ if (current.type_name === 'enum') {
12
+ return current;
13
+ } else if (current.type_name === 'interface') {
14
+ return addInheritedInterfaceMethods(current as InterfaceMirror, repository) as T;
15
+ } else {
16
+ return addInheritedClassMembers(current as ClassMirror, repository) as T;
17
+ }
18
+ }
19
+
20
+ return {
21
+ ...parsedFile,
22
+ type: addInheritedMembersToType(repository, parsedFile.type),
23
+ };
24
+ }
25
+
26
+ function addInheritedInterfaceMethods(interfaceMirror: InterfaceMirror, repository: Type[]): InterfaceMirror {
27
+ function methodAlreadyExists(memberName: string, members: { name: string }[]) {
28
+ return members.some((member) => member.name.toLowerCase() === memberName.toLowerCase());
29
+ }
30
+
31
+ function parentExtractor(interfaceMirror: InterfaceMirror): string[] {
32
+ return interfaceMirror.extended_interfaces;
33
+ }
34
+
35
+ const parents = getParents(parentExtractor, interfaceMirror, repository);
36
+ return {
37
+ ...interfaceMirror,
38
+ methods: parents.reduce(
39
+ (acc, currentValue) => [
40
+ ...acc,
41
+ ...currentValue.methods
42
+ .filter((method) => !methodAlreadyExists(method.name, acc))
43
+ .map((method) => ({
44
+ ...method,
45
+ inherited: true,
46
+ })),
47
+ ],
48
+ interfaceMirror.methods,
49
+ ),
50
+ };
51
+ }
52
+
53
+ function addInheritedClassMembers(classMirror: ClassMirror, repository: Type[]): ClassMirror {
54
+ function memberAlreadyExists(memberName: string, members: { name: string }[]) {
55
+ return members.some((member) => member.name.toLowerCase() === memberName.toLowerCase());
56
+ }
57
+
58
+ function parentExtractor(classMirror: ClassMirror): string[] {
59
+ return classMirror.extended_class ? [classMirror.extended_class] : [];
60
+ }
61
+
62
+ function filterMember<T extends { name: string; access_modifier: string }>(members: T[], existing: T[]): T[] {
63
+ return members
64
+ .filter((member) => member.access_modifier.toLowerCase() !== 'private')
65
+ .filter((member) => !memberAlreadyExists(member.name, existing))
66
+ .map((member) => ({
67
+ ...member,
68
+ inherited: true,
69
+ }));
70
+ }
71
+
72
+ const parents = getParents(parentExtractor, classMirror, repository);
73
+ return {
74
+ ...classMirror,
75
+ fields: parents.reduce(
76
+ (acc, currentValue) => [...acc, ...filterMember(currentValue.fields, acc)],
77
+ classMirror.fields,
78
+ ),
79
+ properties: parents.reduce(
80
+ (acc, currentValue) => [...acc, ...filterMember(currentValue.properties, acc)],
81
+ classMirror.properties,
82
+ ),
83
+ methods: parents.reduce(
84
+ (acc, currentValue) => [...acc, ...filterMember(currentValue.methods, acc)],
85
+ classMirror.methods,
86
+ ),
87
+ };
88
+ }
89
+
90
+ function getParents<T extends Type>(
91
+ extendedNamesExtractor: (current: T) => string[],
92
+ current: T,
93
+ repository: Type[],
94
+ ): T[] {
95
+ return pipe(
96
+ extendedNamesExtractor(current),
97
+ (interfaces: string[]) => interfaces.map((interfaceName) => repository.find((type) => type.name === interfaceName)),
98
+ (interfaces = []) => interfaces.filter((type) => type !== undefined) as T[],
99
+ (interfaces) =>
100
+ interfaces.reduce<T[]>(
101
+ (acc, current) => [...acc, ...getParents(extendedNamesExtractor, current, repository)],
102
+ interfaces,
103
+ ),
104
+ );
105
+ }
@@ -0,0 +1,41 @@
1
+ import { ParsedFile, SourceFile } from '../../shared/types';
2
+ import * as E from 'fp-ts/Either';
3
+ import { reflect as mirrorReflection, Type } from '@cparra/apex-reflection';
4
+ import { pipe } from 'fp-ts/function';
5
+ import * as O from 'fp-ts/Option';
6
+ import { parseApexMetadata } from '../../parse-apex-metadata';
7
+ import { ReflectionError } from './error-handling';
8
+
9
+ export function reflectSourceCode(apexBundles: SourceFile[]) {
10
+ return apexBundles.map(reflectSourceBody);
11
+ }
12
+
13
+ function reflectSourceBody(apexBundle: SourceFile): E.Either<ReflectionError, ParsedFile> {
14
+ const { filePath, content: input, metadataContent: metadata } = apexBundle;
15
+ const result = mirrorReflection(input);
16
+ return result.error
17
+ ? E.left(new ReflectionError(filePath, result.error.message))
18
+ : E.right({
19
+ filePath,
20
+ type: addFileMetadataToTypeAnnotation(result.typeMirror!, metadata),
21
+ });
22
+ }
23
+
24
+ function addFileMetadataToTypeAnnotation(type: Type, metadata: string | null): Type {
25
+ return pipe(
26
+ O.fromNullable(metadata),
27
+ O.map((metadata) => {
28
+ const metadataParams = parseApexMetadata(metadata);
29
+ metadataParams.forEach((value, key) => {
30
+ const declaration = `${key}: ${value}`;
31
+ type.annotations.push({
32
+ rawDeclaration: declaration,
33
+ name: declaration,
34
+ type: declaration,
35
+ });
36
+ });
37
+ return type;
38
+ }),
39
+ O.getOrElse(() => type),
40
+ );
41
+ }
@@ -0,0 +1,59 @@
1
+ import { ClassMirror, EnumMirror, InterfaceMirror, Type } from '@cparra/apex-reflection';
2
+ import { ParsedFile } from '../../shared/types';
3
+
4
+ type Named = { name: string };
5
+
6
+ export function sortMembers(shouldSortMembers: boolean, parsedFiles: ParsedFile[]): ParsedFile[] {
7
+ return parsedFiles.map((parsedFile) => ({
8
+ ...parsedFile,
9
+ type: sortTypeMember(parsedFile.type, shouldSortMembers),
10
+ }));
11
+ }
12
+
13
+ function sortByNames<T extends Named>(shouldSort: boolean, a: T, b: T): number {
14
+ if (shouldSort) {
15
+ return a.name.localeCompare(b.name);
16
+ }
17
+ return 0;
18
+ }
19
+
20
+ function sortNamed<T extends Named>(shouldSort: boolean, items: T[]): T[] {
21
+ return items.sort((a, b) => sortByNames(shouldSort, a, b));
22
+ }
23
+
24
+ function sortTypeMember(type: Type, shouldSort: boolean): Type {
25
+ switch (type.type_name) {
26
+ case 'enum':
27
+ return sortEnumValues(shouldSort, type as EnumMirror);
28
+ case 'interface':
29
+ return sortInterfaceMethods(shouldSort, type as InterfaceMirror);
30
+ case 'class':
31
+ return sortClassMembers(shouldSort, type as ClassMirror);
32
+ }
33
+ }
34
+
35
+ function sortEnumValues(shouldSort: boolean, enumType: EnumMirror): EnumMirror {
36
+ return {
37
+ ...enumType,
38
+ values: sortNamed(shouldSort, enumType.values),
39
+ };
40
+ }
41
+
42
+ function sortInterfaceMethods(shouldSort: boolean, interfaceType: InterfaceMirror): InterfaceMirror {
43
+ return {
44
+ ...interfaceType,
45
+ methods: sortNamed(shouldSort, interfaceType.methods),
46
+ };
47
+ }
48
+
49
+ function sortClassMembers(shouldSort: boolean, classType: ClassMirror): ClassMirror {
50
+ return {
51
+ ...classType,
52
+ fields: sortNamed(shouldSort, classType.fields),
53
+ classes: sortNamed(shouldSort, classType.classes),
54
+ enums: sortNamed(shouldSort, classType.enums),
55
+ interfaces: sortNamed(shouldSort, classType.interfaces),
56
+ methods: sortNamed(shouldSort, classType.methods),
57
+ properties: sortNamed(shouldSort, classType.properties),
58
+ };
59
+ }
@@ -8,11 +8,13 @@ export const classMarkdownTemplate = `
8
8
 
9
9
  {{#if extends.length}}
10
10
  **Inheritance**
11
+
11
12
  {{#each extends}}{{link this}}{{#unless @last}} < {{/unless}}{{/each}}
12
13
  {{/if}}
13
14
 
14
15
  {{#if implements}}
15
16
  **Implements**
17
+
16
18
  {{#each implements}}
17
19
  {{link this}}{{#unless @last}}, {{/unless}}
18
20
  {{/each}}
@@ -0,0 +1,7 @@
1
+ export const hookableTemplate = `
2
+ {{#if frontmatter}}
3
+ {{{frontmatter}}}
4
+ {{/if}}
5
+
6
+ {{{content}}}
7
+ `.trim();
@@ -1,15 +1,15 @@
1
1
  import Handlebars from 'handlebars';
2
- import { typeDocPartial } from '../transpiler/markdown/plain-markdown/type-doc-partial';
3
- import { documentablePartialTemplate } from '../transpiler/markdown/plain-markdown/documentable-partial-template';
4
- import { methodsPartialTemplate } from '../transpiler/markdown/plain-markdown/methods-partial-template';
5
- import { constructorsPartialTemplate } from '../transpiler/markdown/plain-markdown/constructors-partial-template';
6
- import { fieldsPartialTemplate } from '../transpiler/markdown/plain-markdown/fieldsPartialTemplate';
7
- import { classMarkdownTemplate } from '../transpiler/markdown/plain-markdown/class-template';
8
- import { enumMarkdownTemplate } from '../transpiler/markdown/plain-markdown/enum-template';
9
- import { interfaceMarkdownTemplate } from '../transpiler/markdown/plain-markdown/interface-template';
10
- import { CodeBlock, RenderableContent, StringOrLink } from './adapters/types';
11
- import { isCodeBlock, isEmptyLine, isInlineCode } from './adapters/type-utils';
12
- import { groupedMembersPartialTemplate } from '../transpiler/markdown/plain-markdown/grouped-members-partial-template';
2
+ import { CodeBlock, RenderableContent, StringOrLink } from '../adapters/types';
3
+ import { isCodeBlock, isEmptyLine, isInlineCode } from '../adapters/type-utils';
4
+ import { typeDocPartial } from './type-doc-partial';
5
+ import { documentablePartialTemplate } from './documentable-partial-template';
6
+ import { methodsPartialTemplate } from './methods-partial-template';
7
+ import { groupedMembersPartialTemplate } from './grouped-members-partial-template';
8
+ import { constructorsPartialTemplate } from './constructors-partial-template';
9
+ import { fieldsPartialTemplate } from './fieldsPartialTemplate';
10
+ import { classMarkdownTemplate } from './class-template';
11
+ import { enumMarkdownTemplate } from './enum-template';
12
+ import { interfaceMarkdownTemplate } from './interface-template';
13
13
 
14
14
  export type CompilationRequest = {
15
15
  template: string;
@@ -90,7 +90,7 @@ const resolveRenderableContent = (description?: RenderableContent[]): string =>
90
90
 
91
91
  function reduceDescription(acc: string, curr: RenderableContent) {
92
92
  if (isEmptyLine(curr)) {
93
- return acc + '\n\n';
93
+ return acc + '\n';
94
94
  }
95
95
  if (isCodeBlock(curr)) {
96
96
  return acc + convertCodeBlock(curr) + '\n';
@@ -0,0 +1,3 @@
1
+ import { ParsedFile } from '../shared/types';
2
+
3
+ export const parsedFilesToTypes = (parsedFiles: ParsedFile[]) => parsedFiles.map((parsedFile) => parsedFile.type);
@@ -1,5 +1,5 @@
1
1
  import { OpenApiDocsProcessor } from '../open-api-docs-processor';
2
- import { Settings } from '../../../settings';
2
+ import { Settings } from '../../settings';
3
3
  import { SettingsBuilder } from '../../../test-helpers/SettingsBuilder';
4
4
  import { DocCommentBuilder } from '../../../test-helpers/DocCommentBuilder';
5
5
  import { AnnotationBuilder } from '../../../test-helpers/AnnotationBuilder';
@@ -1,7 +1,7 @@
1
- import { ClassMirrorBuilder } from '../../../test-helpers/ClassMirrorBuilder';
2
1
  import { ClassMirrorWrapper } from '../ClassMirrorWrapper';
3
- import { AnnotationBuilder } from '../../../test-helpers/AnnotationBuilder';
4
- import { MethodMirrorBuilder } from '../../../test-helpers/MethodMirrorBuilder';
2
+ import { ClassMirrorBuilder } from '../../../../test-helpers/ClassMirrorBuilder';
3
+ import { MethodMirrorBuilder } from '../../../../test-helpers/MethodMirrorBuilder';
4
+ import { AnnotationBuilder } from '../../../../test-helpers/AnnotationBuilder';
5
5
 
6
6
  it('should return methods by annotation when they exist', function () {
7
7
  const classMirror = new ClassMirrorBuilder()
@@ -0,0 +1,13 @@
1
+ import { PageData } from '../shared/types';
2
+
3
+ export class FileContainer {
4
+ _files: PageData[] = [];
5
+
6
+ files(): PageData[] {
7
+ return this._files;
8
+ }
9
+
10
+ pushFile(file: PageData): void {
11
+ this._files.push(file);
12
+ }
13
+ }
@@ -1,7 +1,7 @@
1
- import Manifest from '../core/manifest';
1
+ import Manifest from '../manifest';
2
2
  import { TypeParser } from './parser';
3
3
  import { ReflectionResult } from '@cparra/apex-reflection';
4
- import ApexBundle from '../core/apex-bundle';
4
+ import { SourceFile } from '../shared/types';
5
5
 
6
6
  /**
7
7
  * Builds a new Manifest object, sourcing its types from the received TypeParser.
@@ -10,7 +10,7 @@ import ApexBundle from '../core/apex-bundle';
10
10
  */
11
11
  export function createManifest(
12
12
  typeParser: TypeParser,
13
- reflect: (apexBundle: ApexBundle) => ReflectionResult,
13
+ reflect: (apexBundle: SourceFile) => ReflectionResult,
14
14
  ): Manifest {
15
15
  return new Manifest(typeParser.parse(reflect));
16
16
  }
@@ -1,19 +1,17 @@
1
- import ProcessorTypeTranspiler from '../processor-type-transpiler';
2
- import { FileContainer } from '../file-container';
1
+ import { FileContainer } from './file-container';
3
2
  import { ClassMirror, Type } from '@cparra/apex-reflection';
4
- import { OpenapiTypeFile } from '../../model/openapi/openapi-type-file';
5
- import { Logger } from '../../util/logger';
6
- import { OpenApi } from '../../model/openapi/open-api';
7
- import { Settings } from '../../settings';
3
+ import { Logger } from '#utils/logger';
4
+ import { OpenApi } from './open-api';
5
+ import { Settings } from '../settings';
8
6
  import { MethodParser } from './parsers/MethodParser';
9
- import { camel2title } from '../../util/string-utils';
7
+ import { camel2title } from '#utils/string-utils';
8
+ import { createOpenApiFile } from './openapi-type-file';
10
9
 
11
- export class OpenApiDocsProcessor extends ProcessorTypeTranspiler {
10
+ export class OpenApiDocsProcessor {
12
11
  protected readonly _fileContainer: FileContainer;
13
12
  openApiModel: OpenApi;
14
13
 
15
14
  constructor() {
16
- super();
17
15
  this._fileContainer = new FileContainer();
18
16
  const title = Settings.getInstance().getOpenApiTitle();
19
17
  if (!title) {
@@ -68,7 +66,8 @@ export class OpenApiDocsProcessor extends ProcessorTypeTranspiler {
68
66
  }
69
67
 
70
68
  onAfterProcess: ((types: Type[]) => void) | undefined = () => {
71
- this._fileContainer.pushFile(new OpenapiTypeFile(this.openApiModel));
69
+ const page = createOpenApiFile(Settings.getInstance().openApiFileName(), this.openApiModel);
70
+ this._fileContainer.pushFile(page);
72
71
  };
73
72
 
74
73
  private getEndpointPath(type: Type): string | null {
@@ -0,0 +1,14 @@
1
+ import { OpenApi } from './open-api';
2
+ import { OpenApiPageData } from '../shared/types';
3
+
4
+ export function createOpenApiFile(fileName: string, openApiModel: OpenApi): OpenApiPageData {
5
+ const content = JSON.stringify({ ...openApiModel, namespace: undefined }, null, 2);
6
+ return {
7
+ fileExtension: 'json',
8
+ fileName,
9
+ directory: '',
10
+ content,
11
+ frontmatter: null,
12
+ group: null,
13
+ };
14
+ }
@@ -1,25 +1,25 @@
1
1
  import { ClassMirror, InterfaceMirror, ReflectionResult, Type } from '@cparra/apex-reflection';
2
- import ApexBundle from '../core/apex-bundle';
3
- import MetadataProcessor from './metadata-processor';
4
- import { Logger } from '../util/logger';
2
+ import { parseApexMetadata } from '../parse-apex-metadata';
3
+ import { Logger } from '#utils/logger';
4
+ import { SourceFile } from '../shared/types';
5
5
 
6
6
  export interface TypeParser {
7
- parse(reflect: (apexBundle: ApexBundle) => ReflectionResult): Type[];
7
+ parse(reflect: (apexBundle: SourceFile) => ReflectionResult): Type[];
8
8
  }
9
9
 
10
10
  type NameAware = { name: string };
11
11
 
12
12
  export class RawBodyParser implements TypeParser {
13
- constructor(public typeBundles: ApexBundle[]) {}
13
+ constructor(public typeBundles: SourceFile[]) {}
14
14
 
15
- parse(reflect: (apexBundle: ApexBundle) => ReflectionResult): Type[] {
15
+ parse(reflect: (apexBundle: SourceFile) => ReflectionResult): Type[] {
16
16
  const types = this.typeBundles
17
17
  .map((currentBundle) => {
18
18
  Logger.log(`Parsing file: ${currentBundle.filePath}`);
19
19
  const result = reflect(currentBundle);
20
- if (!!result.typeMirror && !!currentBundle.rawMetadataContent) {
20
+ if (!!result.typeMirror && !!currentBundle.metadataContent) {
21
21
  // If successful and there is a metadata file
22
- const metadataParams = MetadataProcessor.process(currentBundle.rawMetadataContent);
22
+ const metadataParams = parseApexMetadata(currentBundle.metadataContent);
23
23
  metadataParams.forEach((value, key) => {
24
24
  const declaration = `${key}: ${value}`;
25
25
  result.typeMirror?.annotations.push({
@@ -1,6 +1,6 @@
1
1
  import { Reference, ReferenceBuilder } from './ReferenceBuilder';
2
- import { ApexDocSchemaObject } from '../../../model/openapi/apex-doc-types';
3
- import { SchemaObject } from '../../../model/openapi/open-api-types';
2
+ import { ApexDocSchemaObject } from '../../../core/openapi/apex-doc-types';
3
+ import { SchemaObject } from '../../../core/openapi/open-api-types';
4
4
 
5
5
  export type ApexDocSchemaAware = {
6
6
  schema: ApexDocSchemaObject;
@@ -1,7 +1,7 @@
1
1
  import { ClassMirror, MethodMirror } from '@cparra/apex-reflection';
2
- import { OpenApi } from '../../../model/openapi/open-api';
2
+ import { OpenApi } from '../../../core/openapi/open-api';
3
3
  import * as yaml from 'js-yaml';
4
- import { ClassMirrorWrapper } from '../../../model/apex-type-wrappers/ClassMirrorWrapper';
4
+ import { ClassMirrorWrapper } from '../../../core/openapi/apex-type-wrappers/ClassMirrorWrapper';
5
5
  import { Reference, ReferenceBuilder } from './ReferenceBuilder';
6
6
  import { ParameterObjectBuilder } from './ParameterObjectBuilder';
7
7
  import { ResponsesBuilder } from './ResponsesBuilder';
@@ -9,11 +9,11 @@ import {
9
9
  ApexDocHttpRequestBody,
10
10
  ApexDocHttpResponse,
11
11
  ApexDocParameterObject,
12
- } from '../../../model/openapi/apex-doc-types';
12
+ } from '../../../core/openapi/apex-doc-types';
13
13
  import { RequestBodyBuilder } from './RequestBodyBuilder';
14
14
  import { ApexDocSchemaAware } from './Builder';
15
- import { PropertiesObject, ReferenceObject } from '../../../model/openapi/open-api-types';
16
- import { MethodMirrorWrapper } from '../../../model/apex-type-wrappers/MethodMirrorWrapper';
15
+ import { PropertiesObject, ReferenceObject } from '../../../core/openapi/open-api-types';
16
+ import { MethodMirrorWrapper } from '../../../core/openapi/apex-type-wrappers/MethodMirrorWrapper';
17
17
 
18
18
  type FallbackMethodParser = (methodMirror: MethodMirror) => void;
19
19
  type AddToOpenApi<T extends ApexDocSchemaAware> = (input: T, urlValue: string, httpMethodKey: HttpOperations) => void;
@@ -1,6 +1,6 @@
1
- import { ParameterObject } from '../../../model/openapi/open-api-types';
1
+ import { ParameterObject } from '../../../core/openapi/open-api-types';
2
2
  import { Reference } from './ReferenceBuilder';
3
- import { ApexDocParameterObject } from '../../../model/openapi/apex-doc-types';
3
+ import { ApexDocParameterObject } from '../../../core/openapi/apex-doc-types';
4
4
  import { Builder } from './Builder';
5
5
 
6
6
  export class ParameterObjectBuilder extends Builder<ParameterObject, ApexDocParameterObject> {
@@ -5,11 +5,11 @@ import {
5
5
  SchemaObject,
6
6
  SchemaObjectArray,
7
7
  SchemaObjectObject,
8
- } from '../../../model/openapi/open-api-types';
9
- import { TypeBundle, TypesRepository } from '../../../model/types-repository';
8
+ } from '../../../core/openapi/open-api-types';
9
+ import { TypeBundle, TypesRepository } from '../../../core/openapi/types-repository';
10
10
  import { ClassMirror, DocCommentAnnotation, FieldMirror, PropertyMirror } from '@cparra/apex-reflection';
11
11
  import { ListObjectType, ReferencedType } from '@cparra/apex-reflection';
12
- import { ApexDocSchemaObject } from '../../../model/openapi/apex-doc-types';
12
+ import { ApexDocSchemaObject } from '../../../core/openapi/apex-doc-types';
13
13
 
14
14
  type TypeBundleWithIsCollectionAndReferenceOverrides = TypeBundle & {
15
15
  originalTypeName: string;
@@ -1,6 +1,6 @@
1
- import { RequestBody } from '../../../model/openapi/open-api-types';
1
+ import { RequestBody } from '../../../core/openapi/open-api-types';
2
2
  import { Reference } from './ReferenceBuilder';
3
- import { ApexDocHttpRequestBody } from '../../../model/openapi/apex-doc-types';
3
+ import { ApexDocHttpRequestBody } from '../../../core/openapi/apex-doc-types';
4
4
  import { Builder } from './Builder';
5
5
 
6
6
  /**
@@ -1,6 +1,6 @@
1
- import { ResponseObject } from '../../../model/openapi/open-api-types';
1
+ import { ResponseObject } from '../../../core/openapi/open-api-types';
2
2
  import { Reference } from './ReferenceBuilder';
3
- import { ApexDocHttpResponse } from '../../../model/openapi/apex-doc-types';
3
+ import { ApexDocHttpResponse } from '../../../core/openapi/apex-doc-types';
4
4
  import { Builder } from './Builder';
5
5
 
6
6
  export class ResponsesBuilder extends Builder<ResponseObject, ApexDocHttpResponse> {
@@ -1,7 +1,7 @@
1
1
  import { ClassMirrorBuilder } from '../../../../test-helpers/ClassMirrorBuilder';
2
2
  import { MethodMirrorBuilder } from '../../../../test-helpers/MethodMirrorBuilder';
3
3
  import { AnnotationBuilder } from '../../../../test-helpers/AnnotationBuilder';
4
- import { OpenApi } from '../../../../model/openapi/open-api';
4
+ import { OpenApi } from '../../../../core/openapi/open-api';
5
5
  import { MethodParser } from '../MethodParser';
6
6
  import { DocCommentBuilder } from '../../../../test-helpers/DocCommentBuilder';
7
7
 
@@ -1,7 +1,7 @@
1
1
  import { ParameterObjectBuilder } from '../ParameterObjectBuilder';
2
2
  import { Reference } from '../ReferenceBuilder';
3
- import { ReferenceObject } from '../../../../model/openapi/open-api-types';
4
- import { ApexDocParameterObject } from '../../../../model/openapi/apex-doc-types';
3
+ import { ReferenceObject } from '../../../../core/openapi/open-api-types';
4
+ import { ApexDocParameterObject } from '../../../../core/openapi/apex-doc-types';
5
5
 
6
6
  jest.mock('../ReferenceBuilder', () => {
7
7
  return {
@@ -1,8 +1,8 @@
1
- import { TypesRepository } from '../../../../model/types-repository';
1
+ import { TypesRepository } from '../../../../core/openapi/types-repository';
2
2
  import { ReferenceBuilder } from '../ReferenceBuilder';
3
3
  import { ClassMirrorBuilder } from '../../../../test-helpers/ClassMirrorBuilder';
4
4
  import { FieldMirrorBuilder } from '../../../../test-helpers/FieldMirrorBuilder';
5
- import { SchemaObjectArray, SchemaObjectObject } from '../../../../model/openapi/open-api-types';
5
+ import { SchemaObjectArray, SchemaObjectObject } from '../../../../core/openapi/open-api-types';
6
6
  import { DocCommentBuilder } from '../../../../test-helpers/DocCommentBuilder';
7
7
  import { DocCommentAnnotationBuilder } from '../../../../test-helpers/DocCommentAnnotationBuilder';
8
8
 
@@ -1,7 +1,7 @@
1
1
  import { RequestBodyBuilder } from '../RequestBodyBuilder';
2
2
  import { Reference } from '../ReferenceBuilder';
3
- import { ReferenceObject } from '../../../../model/openapi/open-api-types';
4
- import { ApexDocHttpRequestBody } from '../../../../model/openapi/apex-doc-types';
3
+ import { ReferenceObject } from '../../../../core/openapi/open-api-types';
4
+ import { ApexDocHttpRequestBody } from '../../../../core/openapi/apex-doc-types';
5
5
 
6
6
  jest.mock('../ReferenceBuilder', () => {
7
7
  return {
@@ -1,6 +1,6 @@
1
1
  import { ResponsesBuilder } from '../ResponsesBuilder';
2
2
  import { Reference } from '../ReferenceBuilder';
3
- import { ApexDocHttpResponse } from '../../../../model/openapi/apex-doc-types';
3
+ import { ApexDocHttpResponse } from '../../../../core/openapi/apex-doc-types';
4
4
 
5
5
  jest.mock('../ReferenceBuilder', () => {
6
6
  return {
@@ -1,24 +1,20 @@
1
1
  import { Type } from '@cparra/apex-reflection';
2
- import ProcessorTypeTranspiler from './processor-type-transpiler';
3
2
  import { Settings } from '../settings';
4
- import State from '../service/state';
3
+ import { OpenApiDocsProcessor } from './open-api-docs-processor';
5
4
 
6
5
  export default class Transpiler {
7
- static generate(types: Type[], processor: ProcessorTypeTranspiler): void {
6
+ static generate(types: Type[], processor: OpenApiDocsProcessor): void {
8
7
  const sortedTypes = types.sort((apexTypeA, apexTypeB) => {
9
8
  if (apexTypeA.name < apexTypeB.name) return -1;
10
9
  if (apexTypeA.name > apexTypeB.name) return 1;
11
10
  return 0;
12
11
  });
13
12
 
14
- processor.onBeforeProcess?.(sortedTypes);
15
-
16
13
  if (Settings.getInstance().indexOnly) {
17
14
  return;
18
15
  }
19
16
 
20
17
  sortedTypes.forEach((currentType) => {
21
- State.getInstance().setTypeBeingProcessed(currentType);
22
18
  processor.onProcess(currentType);
23
19
  });
24
20
  processor.onAfterProcess?.(sortedTypes);
@@ -4,7 +4,6 @@ export type TypeBundle = { type: Type; isChild: boolean; parentType?: Type };
4
4
 
5
5
  export class TypesRepository {
6
6
  private static instance: TypesRepository;
7
- private scopedTypes: Type[] = [];
8
7
  private allTypes: Type[] = [];
9
8
 
10
9
  public static getInstance(): TypesRepository {
@@ -52,12 +51,4 @@ export class TypesRepository {
52
51
  }
53
52
  return { type: foundType, isChild: false };
54
53
  }
55
-
56
- public populateScoped(types: Type[]) {
57
- this.scopedTypes = types;
58
- }
59
-
60
- public getFromScopedByName(typeName: string): Type | undefined {
61
- return this.scopedTypes.find((currentType: Type) => currentType.name === typeName);
62
- }
63
54
  }
@@ -0,0 +1,14 @@
1
+ import { XMLParser } from 'fast-xml-parser';
2
+
3
+ export function parseApexMetadata(input: string) {
4
+ const map = new Map<string, string>();
5
+ const xml = new XMLParser().parse(input);
6
+
7
+ map.set('apiVersion', xml.ApexClass.apiVersion ?? '');
8
+
9
+ if (xml.ApexClass.status) {
10
+ map.set('status', xml.ApexClass.status);
11
+ }
12
+
13
+ return map;
14
+ }