@cparra/apexdocs 2.25.0 → 3.0.0-alpha.10
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.
- package/.github/workflows/ci.yaml +22 -0
- package/README.md +73 -12
- package/__mocks__/chalk.js +12 -0
- package/__mocks__/log-update.js +6 -0
- package/dist/cli/generate.js +3181 -0
- package/dist/defaults-DGKfeZq-.js +13 -0
- package/dist/index.d.ts +117 -0
- package/dist/index.js +36 -0
- package/eslint.config.mjs +10 -0
- package/examples/markdown/.forceignore +12 -0
- package/examples/markdown/config/project-scratch-def.json +5 -0
- package/examples/markdown/docs/index.md +109 -0
- package/examples/markdown/docs/miscellaneous/BaseClass.md +16 -0
- package/examples/markdown/docs/miscellaneous/MultiInheritanceClass.md +72 -0
- package/examples/markdown/docs/miscellaneous/ParentInterface.md +15 -0
- package/examples/markdown/docs/miscellaneous/ReferencedEnum.md +8 -0
- package/examples/markdown/docs/miscellaneous/SampleException.md +24 -0
- package/examples/markdown/docs/miscellaneous/SampleInterface.md +116 -0
- package/examples/markdown/docs/miscellaneous/Url.md +309 -0
- package/examples/markdown/docs/sample-enums/SampleEnum.md +36 -0
- package/examples/markdown/docs/samplegroup/SampleClass.md +170 -0
- package/examples/markdown/force-app/classes/BaseClass.cls +3 -0
- package/examples/markdown/force-app/classes/MultiInheritanceClass.cls +1 -0
- package/examples/markdown/force-app/classes/ParentInterface.cls +3 -0
- package/examples/markdown/force-app/classes/ReferencedEnum.cls +3 -0
- package/examples/markdown/force-app/classes/SampleClass.cls +72 -0
- package/examples/markdown/force-app/classes/SampleEnum.cls +30 -0
- package/examples/markdown/force-app/classes/SampleException.cls +17 -0
- package/examples/markdown/force-app/classes/SampleInterface.cls +50 -0
- package/examples/markdown/force-app/classes/Url.cls +194 -0
- package/examples/markdown/package-lock.json +665 -0
- package/examples/markdown/package.json +20 -0
- package/examples/markdown/sfdx-project.json +12 -0
- package/examples/vitepress/.forceignore +12 -0
- package/examples/vitepress/apexdocs.config.ts +106 -0
- package/examples/vitepress/config/project-scratch-def.json +13 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/@theme_index.js +259 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/@theme_index.js.map +7 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/_metadata.json +40 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/chunk-574YRH25.js +11474 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/chunk-574YRH25.js.map +7 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/chunk-E5DZZB2I.js +9172 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/chunk-E5DZZB2I.js.map +7 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/package.json +3 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/vitepress___@vue_devtools-api.js +4339 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/vitepress___@vue_devtools-api.js.map +7 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/vitepress___@vueuse_core.js +567 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/vitepress___@vueuse_core.js.map +7 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/vue.js +323 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/vue.js.map +7 -0
- package/examples/vitepress/docs/.vitepress/config.mts +21 -0
- package/examples/vitepress/docs/.vitepress/sidebar.json +119 -0
- package/examples/vitepress/docs/api-examples.md +49 -0
- package/examples/vitepress/docs/index-frontmatter.md +16 -0
- package/examples/vitepress/docs/index.md +56 -0
- package/examples/vitepress/docs/markdown-examples.md +85 -0
- package/examples/vitepress/docs/miscellaneous/BaseClass.md +20 -0
- package/examples/vitepress/docs/miscellaneous/MultiInheritanceClass.md +76 -0
- package/examples/vitepress/docs/miscellaneous/ParentInterface.md +19 -0
- package/examples/vitepress/docs/miscellaneous/ReferencedEnum.md +15 -0
- package/examples/vitepress/docs/miscellaneous/SampleException.md +28 -0
- package/examples/vitepress/docs/miscellaneous/SampleInterface.md +116 -0
- package/examples/vitepress/docs/miscellaneous/Url.md +317 -0
- package/examples/vitepress/docs/sample-enums/SampleEnum.md +40 -0
- package/examples/vitepress/docs/samplegroup/SampleClass.md +174 -0
- package/examples/vitepress/force-app/main/default/classes/BaseClass.cls +3 -0
- package/examples/vitepress/force-app/main/default/classes/MultiInheritanceClass.cls +1 -0
- package/examples/vitepress/force-app/main/default/classes/ParentInterface.cls +3 -0
- package/examples/vitepress/force-app/main/default/classes/ReferencedEnum.cls +5 -0
- package/examples/vitepress/force-app/main/default/classes/SampleClass.cls +72 -0
- package/examples/vitepress/force-app/main/default/classes/SampleEnum.cls +30 -0
- package/examples/vitepress/force-app/main/default/classes/SampleException.cls +17 -0
- package/examples/vitepress/force-app/main/default/classes/SampleInterface.cls +46 -0
- package/examples/vitepress/force-app/main/default/classes/Url.cls +198 -0
- package/examples/vitepress/package-lock.json +2574 -0
- package/examples/vitepress/package.json +18 -0
- package/examples/vitepress/sfdx-project.json +12 -0
- package/jest.config.js +6 -1
- package/jest.d.ts +7 -0
- package/package.json +34 -36
- package/src/application/Apexdocs.ts +58 -68
- package/src/application/__tests__/apex-file-reader.spec.ts +104 -0
- package/src/application/apex-file-reader.ts +55 -0
- package/src/application/file-system.ts +69 -0
- package/src/application/file-writer.ts +43 -0
- package/src/application/generators/markdown.ts +45 -0
- package/src/application/generators/openapi.ts +60 -0
- package/src/cli/args.ts +43 -0
- package/src/cli/commands/markdown.ts +53 -0
- package/src/cli/generate.ts +10 -131
- package/src/core/manifest.ts +90 -0
- package/src/core/markdown/__test__/expect-extensions.ts +32 -0
- package/src/core/markdown/__test__/generating-class-docs.spec.ts +733 -0
- package/src/core/markdown/__test__/generating-enum-docs.spec.ts +385 -0
- package/src/core/markdown/__test__/generating-interface-docs.spec.ts +461 -0
- package/src/core/markdown/__test__/generating-reference-guide.spec.ts +180 -0
- package/src/core/markdown/__test__/inheritance-chain.test.ts +54 -0
- package/src/core/markdown/__test__/test-helpers.ts +23 -0
- package/src/core/markdown/adapters/__tests__/documentables.spec.ts +109 -0
- package/src/core/markdown/adapters/__tests__/interface-adapter.spec.ts +148 -0
- package/src/core/markdown/adapters/__tests__/link-generator.spec.ts +130 -0
- package/src/core/markdown/adapters/__tests__/references.spec.ts +136 -0
- package/src/core/markdown/adapters/apex-types.ts +238 -0
- package/src/core/markdown/adapters/documentables.ts +115 -0
- package/src/core/markdown/adapters/fields-and-properties.ts +45 -0
- package/src/core/markdown/adapters/generate-link.ts +82 -0
- package/src/core/markdown/adapters/inline.ts +143 -0
- package/src/core/markdown/adapters/methods-and-constructors.ts +133 -0
- package/src/core/markdown/adapters/reference-guide.ts +37 -0
- package/src/core/markdown/adapters/renderable-bundle.ts +61 -0
- package/src/core/markdown/adapters/renderable-to-page-data.ts +89 -0
- package/src/core/markdown/adapters/type-utils.ts +13 -0
- package/src/core/markdown/adapters/types.d.ts +180 -0
- package/src/core/markdown/generate-docs.ts +212 -0
- package/src/core/markdown/reflection/filter-scope.ts +13 -0
- package/src/core/markdown/reflection/inheritance-chain-expanion.ts +22 -0
- package/src/core/markdown/reflection/inheritance-chain.ts +23 -0
- package/src/core/markdown/reflection/inherited-member-expansion.ts +105 -0
- package/src/core/markdown/reflection/reflect-source.ts +123 -0
- package/src/core/markdown/reflection/sort-members.ts +59 -0
- package/src/core/markdown/templates/class-template.ts +75 -0
- package/src/core/markdown/templates/constructors-partial-template.ts +32 -0
- package/src/core/markdown/templates/documentable-partial-template.ts +26 -0
- package/src/core/markdown/templates/enum-template.ts +12 -0
- package/src/core/markdown/templates/fieldsPartialTemplate.ts +23 -0
- package/src/core/markdown/templates/grouped-members-partial-template.ts +6 -0
- package/src/core/markdown/templates/hookable.ts +7 -0
- package/src/core/markdown/templates/interface-template.ts +16 -0
- package/src/core/markdown/templates/methods-partial-template.ts +43 -0
- package/src/core/markdown/templates/reference-guide.ts +14 -0
- package/src/core/markdown/templates/template.ts +114 -0
- package/src/core/markdown/templates/type-doc-partial.ts +27 -0
- package/src/core/markdown/utils.ts +3 -0
- package/src/{service → core/openapi}/__tests__/manifest-factory.spec.ts +1 -2
- package/src/{transpiler → core}/openapi/__tests__/open-api-docs-processor.spec.ts +1 -1
- package/src/{model → core/openapi}/apex-type-wrappers/__tests__/ClassMirrorWrapper.spec.ts +3 -3
- package/src/core/openapi/file-container.ts +13 -0
- package/src/{service → core/openapi}/manifest-factory.ts +3 -3
- package/src/{transpiler → core}/openapi/open-api-docs-processor.ts +10 -11
- package/src/{model → core}/openapi/open-api-types.ts +2 -2
- package/src/core/openapi/openapi-type-file.ts +12 -0
- package/src/{service → core/openapi}/parser.ts +7 -21
- package/src/{transpiler → core}/openapi/parsers/Builder.ts +3 -3
- package/src/{transpiler → core}/openapi/parsers/MethodParser.ts +6 -6
- package/src/{transpiler → core}/openapi/parsers/ParameterObjectBuilder.ts +2 -2
- package/src/{transpiler → core}/openapi/parsers/ReferenceBuilder.ts +7 -6
- package/src/{transpiler → core}/openapi/parsers/RequestBodyBuilder.ts +2 -2
- package/src/{transpiler → core}/openapi/parsers/ResponsesBuilder.ts +2 -2
- package/src/{transpiler → core}/openapi/parsers/__tests__/MethodParser.spec.ts +1 -1
- package/src/{transpiler → core}/openapi/parsers/__tests__/ParameterObjectBuilder.spec.ts +2 -2
- package/src/{transpiler → core}/openapi/parsers/__tests__/ReferenceBuilder.spec.ts +2 -2
- package/src/{transpiler → core}/openapi/parsers/__tests__/RequestBodyBuilder.spec.ts +2 -2
- package/src/{transpiler → core}/openapi/parsers/__tests__/ResponsesBuilder.spec.ts +1 -1
- package/src/{transpiler → core/openapi}/transpiler.ts +2 -6
- package/src/{model → core/openapi}/types-repository.ts +0 -9
- package/src/core/parse-apex-metadata.ts +30 -0
- package/src/core/settings.ts +56 -0
- package/src/core/shared/types.d.ts +147 -0
- package/src/core/shared/utils.ts +5 -0
- package/src/defaults.ts +9 -0
- package/src/index.ts +36 -1
- package/src/test-helpers/ClassMirrorBuilder.ts +14 -1
- package/src/test-helpers/FieldMirrorBuilder.ts +1 -1
- package/src/test-helpers/InterfaceMirrorBuilder.ts +39 -0
- package/src/test-helpers/MethodMirrorBuilder.ts +46 -6
- package/src/test-helpers/SettingsBuilder.ts +1 -4
- package/src/util/error-logger.ts +4 -4
- package/src/util/fp.ts +3 -0
- package/src/util/logger.ts +12 -25
- package/src/util/string-utils.ts +0 -4
- package/tsconfig.json +8 -3
- package/.eslintrc.js +0 -12
- package/apexdocs.config.ts +0 -13
- package/docs/.nojekyll +0 -0
- package/docs/README.md +0 -1
- package/docs/index.html +0 -22
- package/docs/restapi.json +0 -589
- package/docs/types/Classes/nspc.AnotherInterface.md +0 -22
- package/docs/types/Classes/nspc.ChildClass.md +0 -97
- package/docs/types/Main/nspc.GroupedClass.md +0 -10
- package/docs/types/Main/nspc.SampleClass.md +0 -190
- package/docs/types/Misc-Group/nspc.EscapedAnnotations.md +0 -4
- package/docs/types/Misc-Group/nspc.GrandparentClass.md +0 -13
- package/docs/types/Misc-Group/nspc.InterfaceWithInheritance.md +0 -29
- package/docs/types/Misc-Group/nspc.MemberGrouping.md +0 -13
- package/docs/types/Misc-Group/nspc.ParentClass.md +0 -37
- package/docs/types/Misc-Group/nspc.Reference1.md +0 -18
- package/docs/types/Misc-Group/nspc.Reference2.md +0 -12
- package/docs/types/Misc-Group/nspc.Reference3.md +0 -7
- package/docs/types/Misc-Group/nspc.Reference4.md +0 -7
- package/docs/types/Misc-Group/nspc.Reference5.md +0 -7
- package/docs/types/Misc-Group/nspc.Reference6.md +0 -9
- package/docs/types/Misc-Group/nspc.Reference7.md +0 -7
- package/docs/types/Misc-Group/nspc.SampleClassWithoutModifier.md +0 -11
- package/docs/types/Misc-Group/nspc.SampleRestResource.md +0 -211
- package/docs/types/Misc-Group/nspc.SampleRestResourceWithInnerClass.md +0 -34
- package/docs/types/Misc-Group/nspc.SampleRestResourceWithoutApexDocs.md +0 -14
- package/docs/types/README.md +0 -97
- package/docs/types/Sample-Interfaces/nspc.SampleInterface.md +0 -23
- package/examples/includes/header.md +0 -3
- package/lib/application/Apexdocs.d.ts +0 -13
- package/lib/application/Apexdocs.js +0 -77
- package/lib/application/Apexdocs.js.map +0 -1
- package/lib/cli/generate.d.ts +0 -2
- package/lib/cli/generate.js +0 -131
- package/lib/cli/generate.js.map +0 -1
- package/lib/index.d.ts +0 -1
- package/lib/index.js +0 -18
- package/lib/index.js.map +0 -1
- package/lib/model/apex-bundle.d.ts +0 -6
- package/lib/model/apex-bundle.js +0 -11
- package/lib/model/apex-bundle.js.map +0 -1
- package/lib/model/apex-type-wrappers/ClassMirrorWrapper.d.ts +0 -7
- package/lib/model/apex-type-wrappers/ClassMirrorWrapper.js +0 -14
- package/lib/model/apex-type-wrappers/ClassMirrorWrapper.js.map +0 -1
- package/lib/model/apex-type-wrappers/MethodMirrorWrapper.d.ts +0 -7
- package/lib/model/apex-type-wrappers/MethodMirrorWrapper.js +0 -12
- package/lib/model/apex-type-wrappers/MethodMirrorWrapper.js.map +0 -1
- package/lib/model/inheritance.d.ts +0 -8
- package/lib/model/inheritance.js +0 -3
- package/lib/model/inheritance.js.map +0 -1
- package/lib/model/manifest-diff.d.ts +0 -27
- package/lib/model/manifest-diff.js +0 -69
- package/lib/model/manifest-diff.js.map +0 -1
- package/lib/model/manifest.d.ts +0 -22
- package/lib/model/manifest.js +0 -47
- package/lib/model/manifest.js.map +0 -1
- package/lib/model/markdown-file.d.ts +0 -16
- package/lib/model/markdown-file.js +0 -107
- package/lib/model/markdown-file.js.map +0 -1
- package/lib/model/markdown-generation-util/doc-comment-annotation-util.d.ts +0 -8
- package/lib/model/markdown-generation-util/doc-comment-annotation-util.js +0 -44
- package/lib/model/markdown-generation-util/doc-comment-annotation-util.js.map +0 -1
- package/lib/model/markdown-generation-util/field-declaration-util.d.ts +0 -3
- package/lib/model/markdown-generation-util/field-declaration-util.js +0 -55
- package/lib/model/markdown-generation-util/field-declaration-util.js.map +0 -1
- package/lib/model/markdown-generation-util/index.d.ts +0 -3
- package/lib/model/markdown-generation-util/index.js +0 -20
- package/lib/model/markdown-generation-util/index.js.map +0 -1
- package/lib/model/markdown-generation-util/method-declaration-util.d.ts +0 -4
- package/lib/model/markdown-generation-util/method-declaration-util.js +0 -115
- package/lib/model/markdown-generation-util/method-declaration-util.js.map +0 -1
- package/lib/model/markdown-generation-util/type-declaration-util.d.ts +0 -3
- package/lib/model/markdown-generation-util/type-declaration-util.js +0 -82
- package/lib/model/markdown-generation-util/type-declaration-util.js.map +0 -1
- package/lib/model/markdown-home-file.d.ts +0 -11
- package/lib/model/markdown-home-file.js +0 -54
- package/lib/model/markdown-home-file.js.map +0 -1
- package/lib/model/markdown-type-file.d.ts +0 -26
- package/lib/model/markdown-type-file.js +0 -134
- package/lib/model/markdown-type-file.js.map +0 -1
- package/lib/model/openapi/apex-doc-types.d.ts +0 -19
- package/lib/model/openapi/apex-doc-types.js +0 -5
- package/lib/model/openapi/apex-doc-types.js.map +0 -1
- package/lib/model/openapi/open-api-types.d.ts +0 -93
- package/lib/model/openapi/open-api-types.js +0 -3
- package/lib/model/openapi/open-api-types.js.map +0 -1
- package/lib/model/openapi/open-api.d.ts +0 -16
- package/lib/model/openapi/open-api.js +0 -34
- package/lib/model/openapi/open-api.js.map +0 -1
- package/lib/model/openapi/openapi-type-file.d.ts +0 -7
- package/lib/model/openapi/openapi-type-file.js +0 -17
- package/lib/model/openapi/openapi-type-file.js.map +0 -1
- package/lib/model/outputFile.d.ts +0 -10
- package/lib/model/outputFile.js +0 -29
- package/lib/model/outputFile.js.map +0 -1
- package/lib/model/types-repository.d.ts +0 -16
- package/lib/model/types-repository.js +0 -54
- package/lib/model/types-repository.js.map +0 -1
- package/lib/service/apex-file-reader.d.ts +0 -14
- package/lib/service/apex-file-reader.js +0 -46
- package/lib/service/apex-file-reader.js.map +0 -1
- package/lib/service/file-system.d.ts +0 -14
- package/lib/service/file-system.js +0 -25
- package/lib/service/file-system.js.map +0 -1
- package/lib/service/file-writer.d.ts +0 -6
- package/lib/service/file-writer.js +0 -34
- package/lib/service/file-writer.js.map +0 -1
- package/lib/service/manifest-factory.d.ts +0 -10
- package/lib/service/manifest-factory.js +0 -14
- package/lib/service/manifest-factory.js.map +0 -1
- package/lib/service/metadata-processor.d.ts +0 -3
- package/lib/service/metadata-processor.js +0 -17
- package/lib/service/metadata-processor.js.map +0 -1
- package/lib/service/parser.d.ts +0 -21
- package/lib/service/parser.js +0 -135
- package/lib/service/parser.js.map +0 -1
- package/lib/service/state.d.ts +0 -9
- package/lib/service/state.js +0 -20
- package/lib/service/state.js.map +0 -1
- package/lib/service/walkers/class-walker.d.ts +0 -4
- package/lib/service/walkers/class-walker.js +0 -33
- package/lib/service/walkers/class-walker.js.map +0 -1
- package/lib/service/walkers/enum-walker.d.ts +0 -4
- package/lib/service/walkers/enum-walker.js +0 -11
- package/lib/service/walkers/enum-walker.js.map +0 -1
- package/lib/service/walkers/interface-walker.d.ts +0 -4
- package/lib/service/walkers/interface-walker.js +0 -15
- package/lib/service/walkers/interface-walker.js.map +0 -1
- package/lib/service/walkers/walker-factory.d.ts +0 -5
- package/lib/service/walkers/walker-factory.js +0 -21
- package/lib/service/walkers/walker-factory.js.map +0 -1
- package/lib/service/walkers/walker.d.ts +0 -19
- package/lib/service/walkers/walker.js +0 -17
- package/lib/service/walkers/walker.js.map +0 -1
- package/lib/settings.d.ts +0 -64
- package/lib/settings.js +0 -89
- package/lib/settings.js.map +0 -1
- package/lib/test-helpers/AnnotationBuilder.d.ts +0 -12
- package/lib/test-helpers/AnnotationBuilder.js +0 -31
- package/lib/test-helpers/AnnotationBuilder.js.map +0 -1
- package/lib/test-helpers/ClassMirrorBuilder.d.ts +0 -18
- package/lib/test-helpers/ClassMirrorBuilder.js +0 -54
- package/lib/test-helpers/ClassMirrorBuilder.js.map +0 -1
- package/lib/test-helpers/DocCommentAnnotationBuilder.d.ts +0 -8
- package/lib/test-helpers/DocCommentAnnotationBuilder.js +0 -26
- package/lib/test-helpers/DocCommentAnnotationBuilder.js.map +0 -1
- package/lib/test-helpers/DocCommentBuilder.d.ts +0 -12
- package/lib/test-helpers/DocCommentBuilder.js +0 -38
- package/lib/test-helpers/DocCommentBuilder.js.map +0 -1
- package/lib/test-helpers/FieldMirrorBuilder.d.ts +0 -18
- package/lib/test-helpers/FieldMirrorBuilder.js +0 -54
- package/lib/test-helpers/FieldMirrorBuilder.js.map +0 -1
- package/lib/test-helpers/MethodMirrorBuilder.d.ts +0 -10
- package/lib/test-helpers/MethodMirrorBuilder.js +0 -37
- package/lib/test-helpers/MethodMirrorBuilder.js.map +0 -1
- package/lib/test-helpers/SettingsBuilder.d.ts +0 -8
- package/lib/test-helpers/SettingsBuilder.js +0 -27
- package/lib/test-helpers/SettingsBuilder.js.map +0 -1
- package/lib/transpiler/factory.d.ts +0 -6
- package/lib/transpiler/factory.js +0 -32
- package/lib/transpiler/factory.js.map +0 -1
- package/lib/transpiler/file-container.d.ts +0 -6
- package/lib/transpiler/file-container.js +0 -16
- package/lib/transpiler/file-container.js.map +0 -1
- package/lib/transpiler/generator-choices.d.ts +0 -1
- package/lib/transpiler/generator-choices.js +0 -3
- package/lib/transpiler/generator-choices.js.map +0 -1
- package/lib/transpiler/markdown/class-file-generatorHelper.d.ts +0 -8
- package/lib/transpiler/markdown/class-file-generatorHelper.js +0 -56
- package/lib/transpiler/markdown/class-file-generatorHelper.js.map +0 -1
- package/lib/transpiler/markdown/docsify/docsify-docs-processor.d.ts +0 -6
- package/lib/transpiler/markdown/docsify/docsify-docs-processor.js +0 -13
- package/lib/transpiler/markdown/docsify/docsify-docs-processor.js.map +0 -1
- package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.d.ts +0 -11
- package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.js +0 -51
- package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.js.map +0 -1
- package/lib/transpiler/markdown/markdown-transpiler-base.d.ts +0 -11
- package/lib/transpiler/markdown/markdown-transpiler-base.js +0 -24
- package/lib/transpiler/markdown/markdown-transpiler-base.js.map +0 -1
- package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.d.ts +0 -6
- package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.js +0 -14
- package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.js.map +0 -1
- package/lib/transpiler/openapi/open-api-docs-processor.d.ts +0 -13
- package/lib/transpiler/openapi/open-api-docs-processor.js +0 -75
- package/lib/transpiler/openapi/open-api-docs-processor.js.map +0 -1
- package/lib/transpiler/openapi/parsers/Builder.d.ts +0 -16
- package/lib/transpiler/openapi/parsers/Builder.js +0 -30
- package/lib/transpiler/openapi/parsers/Builder.js.map +0 -1
- package/lib/transpiler/openapi/parsers/MethodParser.d.ts +0 -20
- package/lib/transpiler/openapi/parsers/MethodParser.js +0 -167
- package/lib/transpiler/openapi/parsers/MethodParser.js.map +0 -1
- package/lib/transpiler/openapi/parsers/ParameterObjectBuilder.d.ts +0 -7
- package/lib/transpiler/openapi/parsers/ParameterObjectBuilder.js +0 -11
- package/lib/transpiler/openapi/parsers/ParameterObjectBuilder.js.map +0 -1
- package/lib/transpiler/openapi/parsers/ReferenceBuilder.d.ts +0 -39
- package/lib/transpiler/openapi/parsers/ReferenceBuilder.js +0 -226
- package/lib/transpiler/openapi/parsers/ReferenceBuilder.js.map +0 -1
- package/lib/transpiler/openapi/parsers/RequestBodyBuilder.d.ts +0 -10
- package/lib/transpiler/openapi/parsers/RequestBodyBuilder.js +0 -20
- package/lib/transpiler/openapi/parsers/RequestBodyBuilder.js.map +0 -1
- package/lib/transpiler/openapi/parsers/ResponsesBuilder.d.ts +0 -7
- package/lib/transpiler/openapi/parsers/ResponsesBuilder.js +0 -22
- package/lib/transpiler/openapi/parsers/ResponsesBuilder.js.map +0 -1
- package/lib/transpiler/processor-type-transpiler.d.ts +0 -10
- package/lib/transpiler/processor-type-transpiler.js +0 -9
- package/lib/transpiler/processor-type-transpiler.js.map +0 -1
- package/lib/transpiler/transpiler.d.ts +0 -5
- package/lib/transpiler/transpiler.js +0 -27
- package/lib/transpiler/transpiler.js.map +0 -1
- package/lib/util/error-logger.d.ts +0 -8
- package/lib/util/error-logger.js +0 -90
- package/lib/util/error-logger.js.map +0 -1
- package/lib/util/logger.d.ts +0 -21
- package/lib/util/logger.js +0 -58
- package/lib/util/logger.js.map +0 -1
- package/lib/util/string-utils.d.ts +0 -2
- package/lib/util/string-utils.js +0 -15
- package/lib/util/string-utils.js.map +0 -1
- package/src/model/__tests__/manifest-diff.spec.ts +0 -147
- package/src/model/apex-bundle.ts +0 -3
- package/src/model/inheritance.ts +0 -7
- package/src/model/manifest-diff.ts +0 -94
- package/src/model/manifest.ts +0 -74
- package/src/model/markdown-file.ts +0 -121
- package/src/model/markdown-generation-util/doc-comment-annotation-util.ts +0 -50
- package/src/model/markdown-generation-util/field-declaration-util.ts +0 -71
- package/src/model/markdown-generation-util/index.ts +0 -3
- package/src/model/markdown-generation-util/method-declaration-util.ts +0 -166
- package/src/model/markdown-generation-util/type-declaration-util.ts +0 -91
- package/src/model/markdown-home-file.ts +0 -58
- package/src/model/markdown-type-file.ts +0 -165
- package/src/model/openapi/openapi-type-file.ts +0 -14
- package/src/model/outputFile.ts +0 -29
- package/src/service/__tests__/apex-file-reader.spec.ts +0 -92
- package/src/service/apex-file-reader.ts +0 -51
- package/src/service/file-system.ts +0 -33
- package/src/service/file-writer.ts +0 -34
- package/src/service/metadata-processor.ts +0 -16
- package/src/service/state.ts +0 -24
- package/src/service/walkers/class-walker.ts +0 -30
- package/src/service/walkers/enum-walker.ts +0 -7
- package/src/service/walkers/interface-walker.ts +0 -12
- package/src/service/walkers/walker-factory.ts +0 -19
- package/src/service/walkers/walker.ts +0 -42
- package/src/settings.ts +0 -147
- package/src/transpiler/factory.ts +0 -33
- package/src/transpiler/file-container.ts +0 -13
- package/src/transpiler/generator-choices.ts +0 -1
- package/src/transpiler/markdown/class-file-generatorHelper.ts +0 -58
- package/src/transpiler/markdown/docsify/docsify-docs-processor.ts +0 -12
- package/src/transpiler/markdown/jekyll/jekyll-docsProcessor.ts +0 -50
- package/src/transpiler/markdown/markdown-transpiler-base.ts +0 -28
- package/src/transpiler/markdown/plain-markdown/plain-docsProcessor.ts +0 -12
- package/src/transpiler/processor-type-transpiler.ts +0 -18
- /package/src/{model/__tests__ → core/__test__}/manifest.spec.ts +0 -0
- /package/src/{model → core}/openapi/__tests__/open-api.spec.ts +0 -0
- /package/src/{model → core}/openapi/apex-doc-types.ts +0 -0
- /package/src/{model → core/openapi}/apex-type-wrappers/ClassMirrorWrapper.ts +0 -0
- /package/src/{model → core/openapi}/apex-type-wrappers/MethodMirrorWrapper.ts +0 -0
- /package/src/{model → core}/openapi/open-api.ts +0 -0
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
export const enumMarkdownTemplate = `
|
|
2
|
+
{{ heading headingLevel heading }}
|
|
3
|
+
|
|
4
|
+
{{> typeDocumentation }}
|
|
5
|
+
|
|
6
|
+
{{ heading values.headingLevel values.heading }}
|
|
7
|
+
| Value | Description |
|
|
8
|
+
|-------|-------------|
|
|
9
|
+
{{#each values.value}}
|
|
10
|
+
| {{value}} | {{description}} |
|
|
11
|
+
{{/each}}
|
|
12
|
+
`.trim();
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
export const fieldsPartialTemplate = `
|
|
2
|
+
{{ heading headingLevel heading }}
|
|
3
|
+
{{#each value}}
|
|
4
|
+
{{{ heading headingLevel (inlineCode heading) }}}
|
|
5
|
+
|
|
6
|
+
{{#if inherited}}
|
|
7
|
+
*Inherited*
|
|
8
|
+
{{/if}}
|
|
9
|
+
|
|
10
|
+
{{#> documentablePartialTemplate }}
|
|
11
|
+
|
|
12
|
+
{{ heading signature.headingLevel signature.heading }}
|
|
13
|
+
{{ code signature.value }}
|
|
14
|
+
|
|
15
|
+
{{ heading type.headingLevel type.heading }}
|
|
16
|
+
{{link type.value}}
|
|
17
|
+
|
|
18
|
+
{{/documentablePartialTemplate}}
|
|
19
|
+
|
|
20
|
+
{{#unless @last}}---{{/unless}}
|
|
21
|
+
|
|
22
|
+
{{/each}}
|
|
23
|
+
`.trim();
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
export const interfaceMarkdownTemplate = `
|
|
2
|
+
{{ heading headingLevel heading }}
|
|
3
|
+
|
|
4
|
+
{{> typeDocumentation }}
|
|
5
|
+
|
|
6
|
+
{{#if extends}}
|
|
7
|
+
**Extends**
|
|
8
|
+
{{#each extends}}
|
|
9
|
+
{{link this}}{{#unless @last}}, {{/unless}}
|
|
10
|
+
{{/each}}
|
|
11
|
+
{{/if}}
|
|
12
|
+
|
|
13
|
+
{{#if methods}}
|
|
14
|
+
{{> methodsPartialTemplate methods}}
|
|
15
|
+
{{/if}}
|
|
16
|
+
`.trim();
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
export const methodsPartialTemplate = `
|
|
2
|
+
{{ heading headingLevel heading }}
|
|
3
|
+
{{#each value}}
|
|
4
|
+
{{{ heading headingLevel (inlineCode heading) }}}
|
|
5
|
+
|
|
6
|
+
{{#if inherited}}
|
|
7
|
+
*Inherited*
|
|
8
|
+
{{/if}}
|
|
9
|
+
|
|
10
|
+
{{#> documentablePartialTemplate}}
|
|
11
|
+
|
|
12
|
+
{{ heading signature.headingLevel signature.heading }}
|
|
13
|
+
{{ code signature.value }}
|
|
14
|
+
|
|
15
|
+
{{#if parameters.value}}
|
|
16
|
+
{{ heading parameters.headingLevel parameters.heading }}
|
|
17
|
+
| Name | Type | Description |
|
|
18
|
+
|------|------|-------------|
|
|
19
|
+
{{#each parameters.value}}
|
|
20
|
+
| {{name}} | {{link type}} | {{{renderContent description}}} |
|
|
21
|
+
{{/each}}
|
|
22
|
+
{{/if}}
|
|
23
|
+
|
|
24
|
+
{{ heading returnType.headingLevel returnType.heading }}
|
|
25
|
+
**{{link returnType.value.type}}**
|
|
26
|
+
|
|
27
|
+
{{#if returnType.value.description}}
|
|
28
|
+
{{returnType.value.description}}
|
|
29
|
+
{{/if}}
|
|
30
|
+
|
|
31
|
+
{{#if throws.value}}
|
|
32
|
+
{{ heading throws.headingLevel throws.heading }}
|
|
33
|
+
{{#each throws.value}}
|
|
34
|
+
{{link this.type}}: {{this.description}}
|
|
35
|
+
|
|
36
|
+
{{/each}}
|
|
37
|
+
{{/if}}
|
|
38
|
+
{{/documentablePartialTemplate}}
|
|
39
|
+
|
|
40
|
+
{{#unless @last}}---{{/unless}}
|
|
41
|
+
|
|
42
|
+
{{/each}}
|
|
43
|
+
`.trim();
|
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
import Handlebars from 'handlebars';
|
|
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
|
+
|
|
14
|
+
export type CompilationRequest = {
|
|
15
|
+
template: string;
|
|
16
|
+
source: unknown;
|
|
17
|
+
};
|
|
18
|
+
|
|
19
|
+
export class Template {
|
|
20
|
+
private static instance: Template;
|
|
21
|
+
|
|
22
|
+
private constructor() {
|
|
23
|
+
Handlebars.registerPartial('typeDocumentation', typeDocPartial);
|
|
24
|
+
Handlebars.registerPartial('documentablePartialTemplate', documentablePartialTemplate);
|
|
25
|
+
Handlebars.registerPartial('methodsPartialTemplate', methodsPartialTemplate);
|
|
26
|
+
Handlebars.registerPartial('constructorsPartialTemplate', constructorsPartialTemplate);
|
|
27
|
+
Handlebars.registerPartial('groupedMembersPartialTemplate', groupedMembersPartialTemplate);
|
|
28
|
+
Handlebars.registerPartial('fieldsPartialTemplate', fieldsPartialTemplate);
|
|
29
|
+
Handlebars.registerPartial('classTemplate', classMarkdownTemplate);
|
|
30
|
+
Handlebars.registerPartial('enumTemplate', enumMarkdownTemplate);
|
|
31
|
+
Handlebars.registerPartial('interfaceTemplate', interfaceMarkdownTemplate);
|
|
32
|
+
|
|
33
|
+
Handlebars.registerHelper('link', link);
|
|
34
|
+
Handlebars.registerHelper('code', convertCodeBlock);
|
|
35
|
+
Handlebars.registerHelper('renderContent', resolveRenderableContent);
|
|
36
|
+
Handlebars.registerHelper('heading', heading);
|
|
37
|
+
Handlebars.registerHelper('inlineCode', inlineCode);
|
|
38
|
+
Handlebars.registerHelper('splitAndCapitalize', splitAndCapitalize);
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
public static getInstance(): Template {
|
|
42
|
+
if (!Template.instance) {
|
|
43
|
+
Template.instance = new Template();
|
|
44
|
+
}
|
|
45
|
+
return Template.instance;
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
compile(request: CompilationRequest): string {
|
|
49
|
+
const compiled = Handlebars.compile(request.template);
|
|
50
|
+
return (
|
|
51
|
+
compiled(request.source)
|
|
52
|
+
.trim()
|
|
53
|
+
// clean up extra newlines
|
|
54
|
+
.replace(/\n{3,}/g, '\n\n')
|
|
55
|
+
);
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
const splitAndCapitalize = (text: string) => {
|
|
60
|
+
const words = text.split(/[-_]+/);
|
|
61
|
+
const capitalizedWords = [];
|
|
62
|
+
for (const word of words) {
|
|
63
|
+
capitalizedWords.push(word.charAt(0).toUpperCase() + word.slice(1));
|
|
64
|
+
}
|
|
65
|
+
return capitalizedWords.join(' ');
|
|
66
|
+
};
|
|
67
|
+
|
|
68
|
+
const heading = (level: number, text: string) => {
|
|
69
|
+
return `${'#'.repeat(level)} ${text}`;
|
|
70
|
+
};
|
|
71
|
+
|
|
72
|
+
const inlineCode = (text: string) => {
|
|
73
|
+
return new Handlebars.SafeString(`\`${text}\``);
|
|
74
|
+
};
|
|
75
|
+
|
|
76
|
+
const convertCodeBlock = (codeBlock: CodeBlock): Handlebars.SafeString => {
|
|
77
|
+
return new Handlebars.SafeString(
|
|
78
|
+
`
|
|
79
|
+
\`\`\`${codeBlock.language}
|
|
80
|
+
${codeBlock.content.join('\n')}
|
|
81
|
+
\`\`\`
|
|
82
|
+
`.trim(),
|
|
83
|
+
);
|
|
84
|
+
};
|
|
85
|
+
|
|
86
|
+
const resolveRenderableContent = (description?: RenderableContent[]): string => {
|
|
87
|
+
if (!description) {
|
|
88
|
+
return '';
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
function reduceDescription(acc: string, curr: RenderableContent) {
|
|
92
|
+
if (isEmptyLine(curr)) {
|
|
93
|
+
return acc + '\n';
|
|
94
|
+
}
|
|
95
|
+
if (isCodeBlock(curr)) {
|
|
96
|
+
return acc + convertCodeBlock(curr) + '\n';
|
|
97
|
+
}
|
|
98
|
+
if (isInlineCode(curr)) {
|
|
99
|
+
return acc + inlineCode(curr.content).toString() + ' ';
|
|
100
|
+
} else {
|
|
101
|
+
return acc + Handlebars.escapeExpression(link(curr)).trim() + ' ';
|
|
102
|
+
}
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
return description.reduce(reduceDescription, '').trim();
|
|
106
|
+
};
|
|
107
|
+
|
|
108
|
+
const link = (source: StringOrLink): string => {
|
|
109
|
+
if (typeof source === 'string') {
|
|
110
|
+
return source;
|
|
111
|
+
} else {
|
|
112
|
+
return `[${source.title}](${source.url})`;
|
|
113
|
+
}
|
|
114
|
+
};
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
export const typeDocPartial = `
|
|
2
|
+
{{#> documentablePartialTemplate}}
|
|
3
|
+
|
|
4
|
+
{{#if doc.group}}
|
|
5
|
+
**Group** {{doc.group}}
|
|
6
|
+
{{/if}}
|
|
7
|
+
|
|
8
|
+
{{#if doc.author}}
|
|
9
|
+
**Author** {{doc.author}}
|
|
10
|
+
{{/if}}
|
|
11
|
+
|
|
12
|
+
{{#if doc.date}}
|
|
13
|
+
**Date** {{doc.date}}
|
|
14
|
+
{{/if}}
|
|
15
|
+
|
|
16
|
+
{{#each doc.sees}}
|
|
17
|
+
**See** {{link this}}
|
|
18
|
+
|
|
19
|
+
{{/each}}
|
|
20
|
+
|
|
21
|
+
{{#if namespace}}
|
|
22
|
+
## Namespace
|
|
23
|
+
{{namespace}}
|
|
24
|
+
{{/if}}
|
|
25
|
+
|
|
26
|
+
{{/documentablePartialTemplate}}
|
|
27
|
+
`.trim();
|
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
import { createManifest } from '../manifest-factory';
|
|
2
2
|
import { Type } from '@cparra/apex-reflection';
|
|
3
3
|
import { TypeParser } from '../parser';
|
|
4
|
-
import ApexBundle from '../../model/apex-bundle';
|
|
5
4
|
|
|
6
5
|
class TestParser implements TypeParser {
|
|
7
6
|
parse(): Type[] {
|
|
@@ -10,7 +9,7 @@ class TestParser implements TypeParser {
|
|
|
10
9
|
}
|
|
11
10
|
|
|
12
11
|
it('creates a manifest from the result of a type parser', () => {
|
|
13
|
-
const manifest = createManifest(new TestParser(), (
|
|
12
|
+
const manifest = createManifest(new TestParser(), () => {
|
|
14
13
|
return {};
|
|
15
14
|
});
|
|
16
15
|
expect(manifest.types.length).toBe(0);
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { OpenApiDocsProcessor } from '../open-api-docs-processor';
|
|
2
|
-
import { Settings } from '
|
|
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 {
|
|
4
|
-
import { MethodMirrorBuilder } from '
|
|
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()
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import Manifest from '../
|
|
1
|
+
import Manifest from '../manifest';
|
|
2
2
|
import { TypeParser } from './parser';
|
|
3
3
|
import { ReflectionResult } from '@cparra/apex-reflection';
|
|
4
|
-
import
|
|
4
|
+
import { UnparsedSourceFile } 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 '../model/apex-bundle';
|
|
|
10
10
|
*/
|
|
11
11
|
export function createManifest(
|
|
12
12
|
typeParser: TypeParser,
|
|
13
|
-
reflect: (apexBundle:
|
|
13
|
+
reflect: (apexBundle: UnparsedSourceFile) => ReflectionResult,
|
|
14
14
|
): Manifest {
|
|
15
15
|
return new Manifest(typeParser.parse(reflect));
|
|
16
16
|
}
|
|
@@ -1,19 +1,17 @@
|
|
|
1
|
-
import
|
|
2
|
-
import { FileContainer } from '../file-container';
|
|
1
|
+
import { FileContainer } from './file-container';
|
|
3
2
|
import { ClassMirror, Type } from '@cparra/apex-reflection';
|
|
4
|
-
import {
|
|
5
|
-
import {
|
|
6
|
-
import {
|
|
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 '
|
|
7
|
+
import { camel2title } from '#utils/string-utils';
|
|
8
|
+
import { createOpenApiFile } from './openapi-type-file';
|
|
10
9
|
|
|
11
|
-
export class OpenApiDocsProcessor
|
|
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) {
|
|
@@ -27,7 +25,7 @@ export class OpenApiDocsProcessor extends ProcessorTypeTranspiler {
|
|
|
27
25
|
}
|
|
28
26
|
|
|
29
27
|
onProcess(type: Type): void {
|
|
30
|
-
Logger.logSingle(`Processing ${type.name}`,
|
|
28
|
+
Logger.logSingle(`Processing ${type.name}`, 'green');
|
|
31
29
|
|
|
32
30
|
const endpointPath = this.getEndpointPath(type);
|
|
33
31
|
if (!endpointPath) {
|
|
@@ -68,7 +66,8 @@ export class OpenApiDocsProcessor extends ProcessorTypeTranspiler {
|
|
|
68
66
|
}
|
|
69
67
|
|
|
70
68
|
onAfterProcess: ((types: Type[]) => void) | undefined = () => {
|
|
71
|
-
|
|
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 {
|
|
@@ -56,14 +56,14 @@ export type RequestBodyContent = {
|
|
|
56
56
|
|
|
57
57
|
export type MediaTypeObject = {
|
|
58
58
|
schema?: SchemaObject;
|
|
59
|
-
example?:
|
|
59
|
+
example?: unknown;
|
|
60
60
|
examples?: { [index: string]: ExampleObject };
|
|
61
61
|
};
|
|
62
62
|
|
|
63
63
|
export type ExampleObject = {
|
|
64
64
|
summary?: string;
|
|
65
65
|
description?: string;
|
|
66
|
-
value?:
|
|
66
|
+
value?: unknown;
|
|
67
67
|
};
|
|
68
68
|
|
|
69
69
|
// Responses
|
|
@@ -0,0 +1,12 @@
|
|
|
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
|
+
outputDocPath: '',
|
|
8
|
+
content,
|
|
9
|
+
frontmatter: null,
|
|
10
|
+
group: null,
|
|
11
|
+
};
|
|
12
|
+
}
|
|
@@ -1,35 +1,21 @@
|
|
|
1
1
|
import { ClassMirror, InterfaceMirror, ReflectionResult, Type } from '@cparra/apex-reflection';
|
|
2
|
-
import
|
|
3
|
-
import
|
|
4
|
-
import { Logger } from '../util/logger';
|
|
2
|
+
import { Logger } from '#utils/logger';
|
|
3
|
+
import { UnparsedSourceFile } from '../shared/types';
|
|
5
4
|
|
|
6
5
|
export interface TypeParser {
|
|
7
|
-
parse(reflect: (apexBundle:
|
|
6
|
+
parse(reflect: (apexBundle: UnparsedSourceFile) => ReflectionResult): Type[];
|
|
8
7
|
}
|
|
9
8
|
|
|
10
9
|
type NameAware = { name: string };
|
|
11
10
|
|
|
12
11
|
export class RawBodyParser implements TypeParser {
|
|
13
|
-
constructor(public typeBundles:
|
|
12
|
+
constructor(public typeBundles: UnparsedSourceFile[]) {}
|
|
14
13
|
|
|
15
|
-
parse(reflect: (apexBundle:
|
|
14
|
+
parse(reflect: (apexBundle: UnparsedSourceFile) => ReflectionResult): Type[] {
|
|
16
15
|
const types = this.typeBundles
|
|
17
16
|
.map((currentBundle) => {
|
|
18
17
|
Logger.log(`Parsing file: ${currentBundle.filePath}`);
|
|
19
|
-
|
|
20
|
-
if (!!result.typeMirror && !!currentBundle.rawMetadataContent) {
|
|
21
|
-
// If successful and there is a metadata file
|
|
22
|
-
const metadataParams = MetadataProcessor.process(currentBundle.rawMetadataContent);
|
|
23
|
-
metadataParams.forEach((value, key) => {
|
|
24
|
-
const declaration = `${key}: ${value}`;
|
|
25
|
-
result.typeMirror?.annotations.push({
|
|
26
|
-
rawDeclaration: declaration,
|
|
27
|
-
name: declaration,
|
|
28
|
-
type: declaration,
|
|
29
|
-
});
|
|
30
|
-
});
|
|
31
|
-
}
|
|
32
|
-
return result;
|
|
18
|
+
return reflect(currentBundle);
|
|
33
19
|
})
|
|
34
20
|
.filter((reflectionResult) => {
|
|
35
21
|
return reflectionResult.typeMirror;
|
|
@@ -60,7 +46,7 @@ export class RawBodyParser implements TypeParser {
|
|
|
60
46
|
continue;
|
|
61
47
|
}
|
|
62
48
|
|
|
63
|
-
//
|
|
49
|
+
// At this stage, we can be sure we are dealing with an interface
|
|
64
50
|
let typeAsInterface = currentType as InterfaceMirror;
|
|
65
51
|
if (!typeAsInterface.extended_interfaces.length) {
|
|
66
52
|
typesWithFields.push(currentType);
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Reference, ReferenceBuilder } from './ReferenceBuilder';
|
|
2
|
-
import { ApexDocSchemaObject } from '../../../
|
|
3
|
-
import { SchemaObject } from '../../../
|
|
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;
|
|
@@ -29,7 +29,7 @@ export abstract class Builder<T, K> {
|
|
|
29
29
|
return schemaAware.schema;
|
|
30
30
|
}
|
|
31
31
|
|
|
32
|
-
private isReferenceString = (targetObject:
|
|
32
|
+
private isReferenceString = (targetObject: unknown): targetObject is string => {
|
|
33
33
|
return typeof targetObject === 'string' || targetObject instanceof String;
|
|
34
34
|
};
|
|
35
35
|
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { ClassMirror, MethodMirror } from '@cparra/apex-reflection';
|
|
2
|
-
import { OpenApi } from '../../../
|
|
2
|
+
import { OpenApi } from '../../../core/openapi/open-api';
|
|
3
3
|
import * as yaml from 'js-yaml';
|
|
4
|
-
import { ClassMirrorWrapper } from '../../../
|
|
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 '../../../
|
|
12
|
+
} from '../../../core/openapi/apex-doc-types';
|
|
13
13
|
import { RequestBodyBuilder } from './RequestBodyBuilder';
|
|
14
14
|
import { ApexDocSchemaAware } from './Builder';
|
|
15
|
-
import { PropertiesObject, ReferenceObject } from '../../../
|
|
16
|
-
import { MethodMirrorWrapper } from '../../../
|
|
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;
|
|
@@ -95,7 +95,7 @@ export class MethodParser {
|
|
|
95
95
|
|
|
96
96
|
for (const annotation of annotations) {
|
|
97
97
|
// We expect the ApexDoc data representing this to be in YAML format.
|
|
98
|
-
const inYaml = annotation?.bodyLines.reduce((prev, current
|
|
98
|
+
const inYaml = annotation?.bodyLines.reduce((prev, current) => prev + '\n' + current);
|
|
99
99
|
|
|
100
100
|
if (!inYaml) {
|
|
101
101
|
return;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { ParameterObject } from '../../../
|
|
1
|
+
import { ParameterObject } from '../../../core/openapi/open-api-types';
|
|
2
2
|
import { Reference } from './ReferenceBuilder';
|
|
3
|
-
import { ApexDocParameterObject } from '../../../
|
|
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 '../../../
|
|
9
|
-
import { TypeBundle, TypesRepository } from '../../../
|
|
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 '../../../
|
|
12
|
+
import { ApexDocSchemaObject } from '../../../core/openapi/apex-doc-types';
|
|
13
13
|
|
|
14
14
|
type TypeBundleWithIsCollectionAndReferenceOverrides = TypeBundle & {
|
|
15
15
|
originalTypeName: string;
|
|
@@ -131,7 +131,7 @@ export class ReferenceBuilder {
|
|
|
131
131
|
referencedComponents: ReferenceComponent[],
|
|
132
132
|
) {
|
|
133
133
|
// This can be of type ApexDocSchemaObject
|
|
134
|
-
const inYaml = manuallyDefinedHttpSchema?.bodyLines.reduce((prev, current
|
|
134
|
+
const inYaml = manuallyDefinedHttpSchema?.bodyLines.reduce((prev, current) => prev + '\n' + current);
|
|
135
135
|
const asJson = yaml.load(inYaml) as ApexDocSchemaObject;
|
|
136
136
|
const isReferenceString = this.isReferenceString(asJson);
|
|
137
137
|
|
|
@@ -227,7 +227,7 @@ export class ReferenceBuilder {
|
|
|
227
227
|
return { schema: { type: 'object' }, referenceComponents: [] };
|
|
228
228
|
case 'object':
|
|
229
229
|
return { schema: { type: 'object' }, referenceComponents: [] };
|
|
230
|
-
default:
|
|
230
|
+
default: {
|
|
231
231
|
// If we got here we are dealing with a non-primitive (most likely a custom class or an SObject).
|
|
232
232
|
const referencedType = TypesRepository.getInstance().getFromAllByName(typeName);
|
|
233
233
|
if (!referencedType) {
|
|
@@ -243,6 +243,7 @@ export class ReferenceBuilder {
|
|
|
243
243
|
schema: reference.entrypointReferenceObject,
|
|
244
244
|
referenceComponents: [...reference.referenceComponents],
|
|
245
245
|
};
|
|
246
|
+
}
|
|
246
247
|
}
|
|
247
248
|
}
|
|
248
249
|
|
|
@@ -266,7 +267,7 @@ type SchemaObjectReferencePair = {
|
|
|
266
267
|
|
|
267
268
|
class ReferenceOverrides {
|
|
268
269
|
static build(referenceAsString: string): ReferenceOverride[] {
|
|
269
|
-
const cleanedUpReference = referenceAsString.replace(/[
|
|
270
|
+
const cleanedUpReference = referenceAsString.replace(/[[\]]/g, '');
|
|
270
271
|
const referenceStrings = cleanedUpReference.split(',').map((item) => item.replace(/\s/g, ''));
|
|
271
272
|
return referenceStrings.map((item) => {
|
|
272
273
|
const [propertyName, referenceName] = item.split(':');
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { RequestBody } from '../../../
|
|
1
|
+
import { RequestBody } from '../../../core/openapi/open-api-types';
|
|
2
2
|
import { Reference } from './ReferenceBuilder';
|
|
3
|
-
import { ApexDocHttpRequestBody } from '../../../
|
|
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 '../../../
|
|
1
|
+
import { ResponseObject } from '../../../core/openapi/open-api-types';
|
|
2
2
|
import { Reference } from './ReferenceBuilder';
|
|
3
|
-
import { ApexDocHttpResponse } from '../../../
|
|
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 '../../../../
|
|
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 '../../../../
|
|
4
|
-
import { ApexDocParameterObject } from '../../../../
|
|
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 '../../../../
|
|
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 '../../../../
|
|
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
|
|