@cparra/apexdocs 2.23.0 → 2.25.0-alpha.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/ci.yaml +22 -0
- package/README.md +40 -16
- package/examples/plain-markdown/.forceignore +12 -0
- package/examples/plain-markdown/README.md +301 -0
- package/examples/plain-markdown/config/project-scratch-def.json +5 -0
- package/examples/plain-markdown/force-app/classes/BaseClass.cls +3 -0
- package/examples/plain-markdown/force-app/classes/ParentInterface.cls +3 -0
- package/examples/plain-markdown/force-app/classes/ReferencedEnum.cls +3 -0
- package/examples/plain-markdown/force-app/classes/SampleClass.cls +35 -0
- package/examples/plain-markdown/force-app/classes/SampleEnum.cls +30 -0
- package/examples/plain-markdown/force-app/classes/SampleException.cls +1 -0
- package/examples/plain-markdown/force-app/classes/SampleInterface.cls +46 -0
- package/examples/plain-markdown/package-lock.json +665 -0
- package/examples/plain-markdown/package.json +24 -0
- package/examples/plain-markdown/sfdx-project.json +12 -0
- package/examples/plain-markdown/template.md +3 -0
- package/lib/adapters/apex-types.d.ts +5 -0
- package/lib/adapters/apex-types.js +34 -0
- package/lib/adapters/apex-types.js.map +1 -0
- package/lib/adapters/documentables.d.ts +6 -0
- package/lib/adapters/documentables.js +41 -0
- package/lib/adapters/documentables.js.map +1 -0
- package/lib/adapters/fields-and-properties.d.ts +3 -0
- package/lib/adapters/fields-and-properties.js +10 -0
- package/lib/adapters/fields-and-properties.js.map +1 -0
- package/lib/adapters/methods-and-constructors.d.ts +4 -0
- package/lib/adapters/methods-and-constructors.js +49 -0
- package/lib/adapters/methods-and-constructors.js.map +1 -0
- package/lib/adapters/references.d.ts +5 -0
- package/lib/adapters/references.js +82 -0
- package/lib/adapters/references.js.map +1 -0
- package/lib/adapters/type-utils.d.ts +2 -0
- package/lib/adapters/type-utils.js +8 -0
- package/lib/adapters/type-utils.js.map +1 -0
- package/lib/application/Apexdocs.js +5 -2
- package/lib/application/Apexdocs.js.map +1 -1
- package/lib/cli/generate.js +28 -2
- package/lib/cli/generate.js.map +1 -1
- package/lib/model/manifest.d.ts +1 -1
- package/lib/model/manifest.js +2 -2
- package/lib/model/manifest.js.map +1 -1
- package/lib/model/markdown-file.js +5 -2
- package/lib/model/markdown-file.js.map +1 -1
- package/lib/model/markdown-generation-util/doc-comment-annotation-util.js +4 -1
- package/lib/model/markdown-generation-util/doc-comment-annotation-util.js.map +1 -1
- package/lib/model/markdown-home-file.js +4 -1
- package/lib/model/markdown-home-file.js.map +1 -1
- package/lib/model/markdown-type-file.js +4 -1
- package/lib/model/markdown-type-file.js.map +1 -1
- package/lib/model/openapi/open-api-types.d.ts +2 -2
- package/lib/service/apex-file-reader.js +4 -1
- package/lib/service/apex-file-reader.js.map +1 -1
- package/lib/service/file-system.js +25 -2
- package/lib/service/file-system.js.map +1 -1
- package/lib/service/file-writer.js +25 -2
- package/lib/service/file-writer.js.map +1 -1
- package/lib/service/manifest-factory.js +4 -1
- package/lib/service/manifest-factory.js.map +1 -1
- package/lib/service/parser.js +4 -1
- package/lib/service/parser.js.map +1 -1
- package/lib/settings.d.ts +6 -0
- package/lib/settings.js +11 -0
- package/lib/settings.js.map +1 -1
- package/lib/templating/compile.d.ts +7 -0
- package/lib/templating/compile.js +98 -0
- package/lib/templating/compile.js.map +1 -0
- package/lib/templating/helpers.d.ts +2 -0
- package/lib/templating/helpers.js +18 -0
- package/lib/templating/helpers.js.map +1 -0
- package/lib/test-helpers/FieldMirrorBuilder.d.ts +1 -1
- package/lib/test-helpers/InterfaceMirrorBuilder.d.ts +16 -0
- package/lib/test-helpers/InterfaceMirrorBuilder.js +43 -0
- package/lib/test-helpers/InterfaceMirrorBuilder.js.map +1 -0
- package/lib/test-helpers/MethodMirrorBuilder.d.ts +20 -1
- package/lib/test-helpers/MethodMirrorBuilder.js +41 -6
- package/lib/test-helpers/MethodMirrorBuilder.js.map +1 -1
- package/lib/transpiler/factory.js +4 -1
- package/lib/transpiler/factory.js.map +1 -1
- package/lib/transpiler/markdown/class-file-generatorHelper.d.ts +3 -0
- package/lib/transpiler/markdown/class-file-generatorHelper.js +21 -2
- package/lib/transpiler/markdown/class-file-generatorHelper.js.map +1 -1
- package/lib/transpiler/markdown/markdown-transpiler-base.js +4 -1
- package/lib/transpiler/markdown/markdown-transpiler-base.js.map +1 -1
- package/lib/transpiler/markdown/plain-markdown/class-template.d.ts +1 -0
- package/lib/transpiler/markdown/plain-markdown/class-template.js +36 -0
- package/lib/transpiler/markdown/plain-markdown/class-template.js.map +1 -0
- package/lib/transpiler/markdown/plain-markdown/constructors-partial-template.d.ts +1 -0
- package/lib/transpiler/markdown/plain-markdown/constructors-partial-template.js +39 -0
- package/lib/transpiler/markdown/plain-markdown/constructors-partial-template.js.map +1 -0
- package/lib/transpiler/markdown/plain-markdown/documentable-partial-template.d.ts +1 -0
- package/lib/transpiler/markdown/plain-markdown/documentable-partial-template.js +25 -0
- package/lib/transpiler/markdown/plain-markdown/documentable-partial-template.js.map +1 -0
- package/lib/transpiler/markdown/plain-markdown/enum-template.d.ts +1 -0
- package/lib/transpiler/markdown/plain-markdown/enum-template.js +15 -0
- package/lib/transpiler/markdown/plain-markdown/enum-template.js.map +1 -0
- package/lib/transpiler/markdown/plain-markdown/fieldsPartialTemplate.d.ts +1 -0
- package/lib/transpiler/markdown/plain-markdown/fieldsPartialTemplate.js +24 -0
- package/lib/transpiler/markdown/plain-markdown/fieldsPartialTemplate.js.map +1 -0
- package/lib/transpiler/markdown/plain-markdown/interface-template.d.ts +1 -0
- package/lib/transpiler/markdown/plain-markdown/interface-template.js +20 -0
- package/lib/transpiler/markdown/plain-markdown/interface-template.js.map +1 -0
- package/lib/transpiler/markdown/plain-markdown/methods-partial-template.d.ts +1 -0
- package/lib/transpiler/markdown/plain-markdown/methods-partial-template.js +49 -0
- package/lib/transpiler/markdown/plain-markdown/methods-partial-template.js.map +1 -0
- package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.d.ts +7 -0
- package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.js +108 -0
- package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.js.map +1 -1
- package/lib/transpiler/markdown/plain-markdown/type-level-apex-doc-partial-template.d.ts +1 -0
- package/lib/transpiler/markdown/plain-markdown/type-level-apex-doc-partial-template.js +31 -0
- package/lib/transpiler/markdown/plain-markdown/type-level-apex-doc-partial-template.js.map +1 -0
- package/lib/transpiler/openapi/open-api-docs-processor.js +4 -1
- package/lib/transpiler/openapi/open-api-docs-processor.js.map +1 -1
- package/lib/transpiler/openapi/parsers/Builder.js.map +1 -1
- package/lib/transpiler/openapi/parsers/MethodParser.js +25 -2
- package/lib/transpiler/openapi/parsers/MethodParser.js.map +1 -1
- package/lib/transpiler/openapi/parsers/ReferenceBuilder.js +25 -2
- package/lib/transpiler/openapi/parsers/ReferenceBuilder.js.map +1 -1
- package/lib/transpiler/transpiler.js +4 -1
- package/lib/transpiler/transpiler.js.map +1 -1
- package/lib/util/error-logger.js +4 -4
- package/lib/util/error-logger.js.map +1 -1
- package/lib/util/logger.js +10 -7
- package/lib/util/logger.js.map +1 -1
- package/package.json +16 -15
- package/src/adapters/__tests__/interface-adapter.spec.ts +76 -0
- package/src/adapters/__tests__/references.spec.ts +115 -0
- package/src/adapters/apex-types.ts +67 -0
- package/src/adapters/documentables.ts +58 -0
- package/src/adapters/fields-and-properties.ts +14 -0
- package/src/adapters/methods-and-constructors.ts +78 -0
- package/src/adapters/references.ts +113 -0
- package/src/adapters/type-utils.ts +5 -0
- package/src/adapters/types.d.ts +8 -0
- package/src/cli/generate.ts +3 -0
- package/src/model/__tests__/manifest.spec.ts +1 -0
- package/src/model/manifest.ts +3 -3
- package/src/model/markdown-file.ts +1 -1
- package/src/model/openapi/open-api-types.ts +2 -2
- package/src/service/__tests__/apex-file-reader.spec.ts +4 -4
- package/src/service/__tests__/manifest-factory.spec.ts +1 -2
- package/src/settings.ts +15 -0
- package/src/templating/__tests__/compile.spec.ts +741 -0
- package/src/templating/compile.ts +187 -0
- package/src/templating/helpers.ts +14 -0
- package/src/templating/types.d.ts +104 -0
- package/src/test-helpers/FieldMirrorBuilder.ts +1 -1
- package/src/test-helpers/InterfaceMirrorBuilder.ts +44 -0
- package/src/test-helpers/MethodMirrorBuilder.ts +46 -6
- package/src/transpiler/markdown/class-file-generatorHelper.ts +22 -2
- package/src/transpiler/markdown/plain-markdown/class-template.ts +32 -0
- package/src/transpiler/markdown/plain-markdown/constructors-partial-template.ts +35 -0
- package/src/transpiler/markdown/plain-markdown/documentable-partial-template.ts +21 -0
- package/src/transpiler/markdown/plain-markdown/enum-template.ts +11 -0
- package/src/transpiler/markdown/plain-markdown/fieldsPartialTemplate.ts +20 -0
- package/src/transpiler/markdown/plain-markdown/interface-template.ts +16 -0
- package/src/transpiler/markdown/plain-markdown/methods-partial-template.ts +45 -0
- package/src/transpiler/markdown/plain-markdown/plain-docsProcessor.ts +122 -0
- package/src/transpiler/markdown/plain-markdown/type-level-apex-doc-partial-template.ts +27 -0
- package/src/transpiler/openapi/parsers/Builder.ts +1 -1
- package/src/transpiler/openapi/parsers/MethodParser.ts +1 -1
- package/src/transpiler/openapi/parsers/ReferenceBuilder.ts +1 -1
- package/src/util/error-logger.ts +4 -4
- package/src/util/logger.ts +3 -3
- package/tsconfig.json +1 -0
- 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/src/model/__tests__/manifest-diff.spec.ts +0 -139
- package/src/model/manifest-diff.ts +0 -94
- /package/docs/{README.md → __old/README.md} +0 -0
- /package/docs/{index.html → __old/index.html} +0 -0
- /package/docs/{restapi.json → __old/restapi.json} +0 -0
- /package/docs/{types → __old/types}/Classes/nspc.AnotherInterface.md +0 -0
- /package/docs/{types → __old/types}/Classes/nspc.ChildClass.md +0 -0
- /package/docs/{types → __old/types}/Main/nspc.GroupedClass.md +0 -0
- /package/docs/{types → __old/types}/Main/nspc.SampleClass.md +0 -0
- /package/docs/{types → __old/types}/Misc-Group/nspc.EscapedAnnotations.md +0 -0
- /package/docs/{types → __old/types}/Misc-Group/nspc.GrandparentClass.md +0 -0
- /package/docs/{types → __old/types}/Misc-Group/nspc.InterfaceWithInheritance.md +0 -0
- /package/docs/{types → __old/types}/Misc-Group/nspc.MemberGrouping.md +0 -0
- /package/docs/{types → __old/types}/Misc-Group/nspc.ParentClass.md +0 -0
- /package/docs/{types → __old/types}/Misc-Group/nspc.Reference1.md +0 -0
- /package/docs/{types → __old/types}/Misc-Group/nspc.Reference2.md +0 -0
- /package/docs/{types → __old/types}/Misc-Group/nspc.Reference3.md +0 -0
- /package/docs/{types → __old/types}/Misc-Group/nspc.Reference4.md +0 -0
- /package/docs/{types → __old/types}/Misc-Group/nspc.Reference5.md +0 -0
- /package/docs/{types → __old/types}/Misc-Group/nspc.Reference6.md +0 -0
- /package/docs/{types → __old/types}/Misc-Group/nspc.Reference7.md +0 -0
- /package/docs/{types → __old/types}/Misc-Group/nspc.SampleClassWithoutModifier.md +0 -0
- /package/docs/{types → __old/types}/Misc-Group/nspc.SampleRestResource.md +0 -0
- /package/docs/{types → __old/types}/Misc-Group/nspc.SampleRestResourceWithInnerClass.md +0 -0
- /package/docs/{types → __old/types}/Misc-Group/nspc.SampleRestResourceWithoutApexDocs.md +0 -0
- /package/docs/{types → __old/types}/README.md +0 -0
- /package/docs/{types → __old/types}/Sample-Interfaces/nspc.SampleInterface.md +0 -0
|
@@ -1,8 +1,11 @@
|
|
|
1
1
|
import { Type } from '@cparra/apex-reflection';
|
|
2
|
+
import { StringOrLink } from '../../templating/types';
|
|
2
3
|
export default class ClassFileGeneratorHelper {
|
|
3
4
|
static getSanitizedGroup(classModel: Type): string;
|
|
4
5
|
static getFileLink(classModel: Type): string;
|
|
6
|
+
private static getFileLinkTuple;
|
|
5
7
|
static getFileLinkByTypeName(typeName: string): string;
|
|
8
|
+
static getRenderableLinkByTypeName(typeName: string): StringOrLink;
|
|
6
9
|
private static getDirectoryRoot;
|
|
7
10
|
private static getClassGroup;
|
|
8
11
|
}
|
|
@@ -1,19 +1,26 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
2
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
6
|
const types_repository_1 = require("../../model/types-repository");
|
|
4
7
|
const settings_1 = require("../../settings");
|
|
5
|
-
const state_1 = require("../../service/state");
|
|
8
|
+
const state_1 = __importDefault(require("../../service/state"));
|
|
6
9
|
const factory_1 = require("../factory");
|
|
7
10
|
class ClassFileGeneratorHelper {
|
|
8
11
|
static getSanitizedGroup(classModel) {
|
|
9
12
|
return this.getClassGroup(classModel).replace(/ /g, '-').replace('.', '');
|
|
10
13
|
}
|
|
11
14
|
static getFileLink(classModel) {
|
|
15
|
+
const [fullClassName, fileLink] = ClassFileGeneratorHelper.getFileLinkTuple(classModel);
|
|
16
|
+
return `[${fullClassName}](${fileLink})`;
|
|
17
|
+
}
|
|
18
|
+
static getFileLinkTuple(classModel) {
|
|
12
19
|
var _a;
|
|
13
20
|
const documentationRoot = (_a = settings_1.Settings.getInstance().getRootDir()) !== null && _a !== void 0 ? _a : '';
|
|
14
21
|
const directoryRoot = `${documentationRoot}${this.getDirectoryRoot(classModel)}`;
|
|
15
22
|
const fullClassName = `${settings_1.Settings.getInstance().getNamespacePrefix()}${classModel.name}`;
|
|
16
|
-
return
|
|
23
|
+
return [fullClassName, `${directoryRoot}${fullClassName}.md`];
|
|
17
24
|
}
|
|
18
25
|
static getFileLinkByTypeName(typeName) {
|
|
19
26
|
const type = types_repository_1.TypesRepository.getInstance().getFromScopedByName(typeName);
|
|
@@ -23,6 +30,18 @@ class ClassFileGeneratorHelper {
|
|
|
23
30
|
}
|
|
24
31
|
return this.getFileLink(type);
|
|
25
32
|
}
|
|
33
|
+
static getRenderableLinkByTypeName(typeName) {
|
|
34
|
+
const type = types_repository_1.TypesRepository.getInstance().getFromScopedByName(typeName);
|
|
35
|
+
if (!type) {
|
|
36
|
+
// If the type is not found, we return the type name as a string.
|
|
37
|
+
return typeName;
|
|
38
|
+
}
|
|
39
|
+
const [fullClassName, fileLink] = ClassFileGeneratorHelper.getFileLinkTuple(type);
|
|
40
|
+
return {
|
|
41
|
+
title: fullClassName,
|
|
42
|
+
url: fileLink,
|
|
43
|
+
};
|
|
44
|
+
}
|
|
26
45
|
static getDirectoryRoot(classModel) {
|
|
27
46
|
// root-relative links start from the root by using a leading '/'
|
|
28
47
|
const generator = settings_1.Settings.getInstance().targetGenerator;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"class-file-generatorHelper.js","sourceRoot":"","sources":["../../../src/transpiler/markdown/class-file-generatorHelper.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"class-file-generatorHelper.js","sourceRoot":"","sources":["../../../src/transpiler/markdown/class-file-generatorHelper.ts"],"names":[],"mappings":";;;;;AACA,mEAA+D;AAC/D,6CAA0C;AAC1C,gEAAwC;AACxC,wCAAmD;AAGnD,MAAqB,wBAAwB;IACpC,MAAM,CAAC,iBAAiB,CAAC,UAAgB;QAC9C,OAAO,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IAC5E,CAAC;IAEM,MAAM,CAAC,WAAW,CAAC,UAAgB;QACxC,MAAM,CAAC,aAAa,EAAE,QAAQ,CAAC,GAAG,wBAAwB,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;QACxF,OAAO,IAAI,aAAa,KAAK,QAAQ,GAAG,CAAC;IAC3C,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,UAAgB;;QAC9C,MAAM,iBAAiB,GAAG,MAAA,mBAAQ,CAAC,WAAW,EAAE,CAAC,UAAU,EAAE,mCAAI,EAAE,CAAC;QACpE,MAAM,aAAa,GAAG,GAAG,iBAAiB,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,CAAC;QACjF,MAAM,aAAa,GAAG,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,kBAAkB,EAAE,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC;QACzF,OAAO,CAAC,aAAa,EAAE,GAAG,aAAa,GAAG,aAAa,KAAK,CAAC,CAAC;IAChE,CAAC;IAEM,MAAM,CAAC,qBAAqB,CAAC,QAAgB;QAClD,MAAM,IAAI,GAAG,kCAAe,CAAC,WAAW,EAAE,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;QACzE,IAAI,CAAC,IAAI,EAAE;YACT,sFAAsF;YACtF,OAAO,IAAI,QAAQ,KAAK,QAAQ,GAAG,CAAC;SACrC;QAED,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAEM,MAAM,CAAC,2BAA2B,CAAC,QAAgB;QACxD,MAAM,IAAI,GAAG,kCAAe,CAAC,WAAW,EAAE,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;QACzE,IAAI,CAAC,IAAI,EAAE;YACT,iEAAiE;YACjE,OAAO,QAAQ,CAAC;SACjB;QAED,MAAM,CAAC,aAAa,EAAE,QAAQ,CAAC,GAAG,wBAAwB,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAClF,OAAO;YACL,KAAK,EAAE,aAAa;YACpB,GAAG,EAAE,QAAQ;SACd,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,UAAgB;QAC9C,iEAAiE;QACjE,MAAM,SAAS,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,eAAe,CAAC;QACzD,IAAI,+BAAqB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,kBAAkB,EAAE,KAAK,eAAe,EAAE;YACjF,OAAO,IAAI,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC;SAClD;QAED,uDAAuD;QACvD,MAAM,kBAAkB,GAAG,eAAK,CAAC,WAAW,EAAE,CAAC,qBAAqB,EAAE,CAAC;QACvE,IAAI,kBAAkB,EAAE;YACtB,IAAI,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,KAAK,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE;gBAC7E,yEAAyE;gBACzE,OAAO,IAAI,CAAC;aACb;iBAAM;gBACL,wEAAwE;gBACxE,OAAO,MAAM,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC;aACpD;SACF;aAAM;YACL,uGAAuG;YACvG,OAAO,KAAK,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC;SACnD;IACH,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,UAAgB;;QAC3C,MAAM,eAAe,GAAG,MAAA,UAAU,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CAC7D,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,OAAO,CAC1D,CAAC;QACF,OAAO,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,IAAI,mCAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,mBAAmB,EAAE,CAAC;IAC/E,CAAC;CACF;AAtED,2CAsEC"}
|
|
@@ -1,7 +1,10 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
2
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
6
|
exports.MarkdownTranspilerBase = void 0;
|
|
4
|
-
const processor_type_transpiler_1 = require("../processor-type-transpiler");
|
|
7
|
+
const processor_type_transpiler_1 = __importDefault(require("../processor-type-transpiler"));
|
|
5
8
|
const file_container_1 = require("../file-container");
|
|
6
9
|
const markdown_home_file_1 = require("../../model/markdown-home-file");
|
|
7
10
|
const markdown_type_file_1 = require("../../model/markdown-type-file");
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"markdown-transpiler-base.js","sourceRoot":"","sources":["../../../src/transpiler/markdown/markdown-transpiler-base.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"markdown-transpiler-base.js","sourceRoot":"","sources":["../../../src/transpiler/markdown/markdown-transpiler-base.ts"],"names":[],"mappings":";;;;;;AAAA,6FAAmE;AAEnE,sDAAkD;AAClD,uEAAkE;AAClE,uEAAkE;AAElE,MAAsB,sBAAuB,SAAQ,mCAAuB;IAG1E;QACE,KAAK,EAAE,CAAC;QAUV,oBAAe,GAAG,CAAC,KAAa,EAAE,EAAE;YAClC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,qCAAgB,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;QACjF,CAAC,CAAC;QAXA,IAAI,CAAC,cAAc,GAAG,IAAI,8BAAa,EAAE,CAAC;IAC5C,CAAC;IAID,WAAW;QACT,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAMD,SAAS,CAAC,IAAU;QAClB,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,qCAAgB,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3D,CAAC;CACF;AArBD,wDAqBC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare const classMarkdownTemplate: string;
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.classMarkdownTemplate = void 0;
|
|
4
|
+
exports.classMarkdownTemplate = `
|
|
5
|
+
# {{name}} Class
|
|
6
|
+
{{#if classModifier}}
|
|
7
|
+
\`{{classModifier}}\`
|
|
8
|
+
{{/if}}
|
|
9
|
+
|
|
10
|
+
{{> typeLevelApexDocPartialTemplate}}
|
|
11
|
+
|
|
12
|
+
{{#if extends}}
|
|
13
|
+
**Extends**
|
|
14
|
+
{{extends}}
|
|
15
|
+
{{/if}}
|
|
16
|
+
|
|
17
|
+
{{#if implements}}
|
|
18
|
+
**Implements**
|
|
19
|
+
{{#each implements}}
|
|
20
|
+
{{this}}{{#unless @last}}, {{/unless}}
|
|
21
|
+
{{/each}}
|
|
22
|
+
{{/if}}
|
|
23
|
+
|
|
24
|
+
{{#if fields}}
|
|
25
|
+
{{> fieldsPartialTemplate}}
|
|
26
|
+
{{/if}}
|
|
27
|
+
|
|
28
|
+
{{#if constructors}}
|
|
29
|
+
{{> constructorsPartialTemplate}}
|
|
30
|
+
{{/if}}
|
|
31
|
+
|
|
32
|
+
{{#if methods}}
|
|
33
|
+
{{> methodsPartialTemplate}}
|
|
34
|
+
{{/if}}
|
|
35
|
+
`.trim();
|
|
36
|
+
//# sourceMappingURL=class-template.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"class-template.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/class-template.ts"],"names":[],"mappings":";;;AAAa,QAAA,qBAAqB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA+BpC,CAAC,IAAI,EAAE,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare const constructorsPartialTemplate: string;
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.constructorsPartialTemplate = void 0;
|
|
4
|
+
exports.constructorsPartialTemplate = `
|
|
5
|
+
## Constructors
|
|
6
|
+
{{#each constructors}}
|
|
7
|
+
### \`{{title}}\`
|
|
8
|
+
|
|
9
|
+
{{#> documentablePartialTemplate}}
|
|
10
|
+
|
|
11
|
+
### Signature
|
|
12
|
+
\`\`\`apex
|
|
13
|
+
{{signature}}
|
|
14
|
+
\`\`\`
|
|
15
|
+
|
|
16
|
+
{{#if parameters}}
|
|
17
|
+
### Parameters
|
|
18
|
+
| Name | Type | Description |
|
|
19
|
+
|------|------|-------------|
|
|
20
|
+
{{#each parameters}}
|
|
21
|
+
| {{name}} | {{type}} | {{description}} |
|
|
22
|
+
{{/each}}
|
|
23
|
+
{{/if}}
|
|
24
|
+
|
|
25
|
+
{{#if throws}}
|
|
26
|
+
### Throws
|
|
27
|
+
{{#each throws}}
|
|
28
|
+
{{this.type}}: {{this.description}}
|
|
29
|
+
|
|
30
|
+
{{/each}}
|
|
31
|
+
{{/if}}
|
|
32
|
+
|
|
33
|
+
{{/documentablePartialTemplate}}
|
|
34
|
+
|
|
35
|
+
{{#unless @last}}---{{/unless}}
|
|
36
|
+
{{/each}}
|
|
37
|
+
|
|
38
|
+
`.trim();
|
|
39
|
+
//# sourceMappingURL=constructors-partial-template.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"constructors-partial-template.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/constructors-partial-template.ts"],"names":[],"mappings":";;;AAAa,QAAA,2BAA2B,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkC1C,CAAC,IAAI,EAAE,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare const documentablePartialTemplate: string;
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.documentablePartialTemplate = void 0;
|
|
4
|
+
exports.documentablePartialTemplate = `
|
|
5
|
+
{{#each annotations}}
|
|
6
|
+
\`{{this}}\`
|
|
7
|
+
{{/each}}
|
|
8
|
+
|
|
9
|
+
{{description}}
|
|
10
|
+
|
|
11
|
+
{{#each customTags}}
|
|
12
|
+
**{{splitAndCapitalize name}}** {{description}}
|
|
13
|
+
|
|
14
|
+
{{/each}}
|
|
15
|
+
|
|
16
|
+
{{> @partial-block}}
|
|
17
|
+
|
|
18
|
+
{{{mermaid}}}
|
|
19
|
+
|
|
20
|
+
{{#if example}}
|
|
21
|
+
##{{#if isInner}}#{{/if}} Example
|
|
22
|
+
{{{example}}}
|
|
23
|
+
{{/if}}
|
|
24
|
+
`.trim();
|
|
25
|
+
//# sourceMappingURL=documentable-partial-template.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"documentable-partial-template.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/documentable-partial-template.ts"],"names":[],"mappings":";;;AAAa,QAAA,2BAA2B,GAAG;;;;;;;;;;;;;;;;;;;;CAoB1C,CAAC,IAAI,EAAE,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare const enumMarkdownTemplate: string;
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.enumMarkdownTemplate = void 0;
|
|
4
|
+
exports.enumMarkdownTemplate = `
|
|
5
|
+
# {{name}} Enum
|
|
6
|
+
|
|
7
|
+
{{> typeLevelApexDocPartialTemplate}}
|
|
8
|
+
|
|
9
|
+
## Enum Values
|
|
10
|
+
{{#each values}}
|
|
11
|
+
### {{value}}
|
|
12
|
+
{{description}}
|
|
13
|
+
{{/each}}
|
|
14
|
+
`.trim();
|
|
15
|
+
//# sourceMappingURL=enum-template.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"enum-template.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/enum-template.ts"],"names":[],"mappings":";;;AAAa,QAAA,oBAAoB,GAAG;;;;;;;;;;CAUnC,CAAC,IAAI,EAAE,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare const fieldsPartialTemplate: string;
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.fieldsPartialTemplate = void 0;
|
|
4
|
+
exports.fieldsPartialTemplate = `
|
|
5
|
+
## Fields
|
|
6
|
+
{{#each fields}}
|
|
7
|
+
### \`\{{name}}\`
|
|
8
|
+
|
|
9
|
+
{{#if inherited}}
|
|
10
|
+
*Inherited*
|
|
11
|
+
{{/if}}
|
|
12
|
+
|
|
13
|
+
{{#> documentablePartialTemplate}}
|
|
14
|
+
|
|
15
|
+
#### Type
|
|
16
|
+
{{type}}
|
|
17
|
+
|
|
18
|
+
{{/documentablePartialTemplate}}
|
|
19
|
+
|
|
20
|
+
{{#unless @last}}---{{/unless}}
|
|
21
|
+
|
|
22
|
+
{{/each}}
|
|
23
|
+
`.trim();
|
|
24
|
+
//# sourceMappingURL=fieldsPartialTemplate.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"fieldsPartialTemplate.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/fieldsPartialTemplate.ts"],"names":[],"mappings":";;;AAAa,QAAA,qBAAqB,GAAG;;;;;;;;;;;;;;;;;;;CAmBpC,CAAC,IAAI,EAAE,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare const interfaceMarkdownTemplate: string;
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.interfaceMarkdownTemplate = void 0;
|
|
4
|
+
exports.interfaceMarkdownTemplate = `
|
|
5
|
+
# {{name}} Interface
|
|
6
|
+
|
|
7
|
+
{{> typeLevelApexDocPartialTemplate}}
|
|
8
|
+
|
|
9
|
+
{{#if extends}}
|
|
10
|
+
**Extends**
|
|
11
|
+
{{#each extends}}
|
|
12
|
+
{{this}}{{#unless @last}}, {{/unless}}
|
|
13
|
+
{{/each}}
|
|
14
|
+
{{/if}}
|
|
15
|
+
|
|
16
|
+
{{#if methods}}
|
|
17
|
+
{{> methodsPartialTemplate}}
|
|
18
|
+
{{/if}}
|
|
19
|
+
`.trim();
|
|
20
|
+
//# sourceMappingURL=interface-template.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"interface-template.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/interface-template.ts"],"names":[],"mappings":";;;AAAa,QAAA,yBAAyB,GAAG;;;;;;;;;;;;;;;CAexC,CAAC,IAAI,EAAE,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare const methodsPartialTemplate: string;
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.methodsPartialTemplate = void 0;
|
|
4
|
+
exports.methodsPartialTemplate = `
|
|
5
|
+
## Methods
|
|
6
|
+
{{#each methods}}
|
|
7
|
+
### \`{{title}}\`
|
|
8
|
+
|
|
9
|
+
{{#if inherited}}
|
|
10
|
+
*Inherited*
|
|
11
|
+
{{/if}}
|
|
12
|
+
|
|
13
|
+
{{#> documentablePartialTemplate isInner=true}}
|
|
14
|
+
|
|
15
|
+
### Signature
|
|
16
|
+
\`\`\`apex
|
|
17
|
+
{{signature}}
|
|
18
|
+
\`\`\`
|
|
19
|
+
|
|
20
|
+
{{#if parameters}}
|
|
21
|
+
### Parameters
|
|
22
|
+
| Name | Type | Description |
|
|
23
|
+
|------|------|-------------|
|
|
24
|
+
{{#each parameters}}
|
|
25
|
+
| {{name}} | {{type}} | {{description}} |
|
|
26
|
+
{{/each}}
|
|
27
|
+
{{/if}}
|
|
28
|
+
|
|
29
|
+
{{#if returnType}}
|
|
30
|
+
### Returns
|
|
31
|
+
**{{returnType.type}}**
|
|
32
|
+
|
|
33
|
+
{{returnType.description}}
|
|
34
|
+
{{/if}}
|
|
35
|
+
|
|
36
|
+
{{#if throws}}
|
|
37
|
+
### Throws
|
|
38
|
+
{{#each throws}}
|
|
39
|
+
{{this.type}}: {{this.description}}
|
|
40
|
+
|
|
41
|
+
{{/each}}
|
|
42
|
+
{{/if}}
|
|
43
|
+
{{/documentablePartialTemplate}}
|
|
44
|
+
|
|
45
|
+
{{#unless @last}}---{{/unless}}
|
|
46
|
+
|
|
47
|
+
{{/each}}
|
|
48
|
+
`.trim();
|
|
49
|
+
//# sourceMappingURL=methods-partial-template.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"methods-partial-template.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/methods-partial-template.ts"],"names":[],"mappings":";;;AAAa,QAAA,sBAAsB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4CrC,CAAC,IAAI,EAAE,CAAC"}
|
|
@@ -1,6 +1,13 @@
|
|
|
1
1
|
import { MarkdownTranspilerBase } from '../markdown-transpiler-base';
|
|
2
2
|
import { LinkingStrategy } from '../../processor-type-transpiler';
|
|
3
|
+
import { Type } from '@cparra/apex-reflection';
|
|
4
|
+
import { OutputFile } from '../../../model/outputFile';
|
|
3
5
|
export declare class PlainMarkdownDocsProcessor extends MarkdownTranspilerBase {
|
|
6
|
+
_fileContents: string[];
|
|
7
|
+
onBeforeProcess: (types: Type[]) => void;
|
|
4
8
|
homeFileName(): string;
|
|
5
9
|
getLinkingStrategy(): LinkingStrategy;
|
|
10
|
+
onProcess(type: Type): void;
|
|
11
|
+
onAfterProcess: (types: Type[]) => void;
|
|
12
|
+
_generateOutputFile(type: Type): OutputFile;
|
|
6
13
|
}
|
|
@@ -1,14 +1,122 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
2
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
6
|
exports.PlainMarkdownDocsProcessor = void 0;
|
|
4
7
|
const markdown_transpiler_base_1 = require("../markdown-transpiler-base");
|
|
8
|
+
const outputFile_1 = require("../../../model/outputFile");
|
|
9
|
+
const settings_1 = require("../../../settings");
|
|
10
|
+
const class_file_generatorHelper_1 = __importDefault(require("../class-file-generatorHelper"));
|
|
11
|
+
const enum_template_1 = require("./enum-template");
|
|
12
|
+
const compile_1 = require("../../../templating/compile");
|
|
13
|
+
const interface_template_1 = require("./interface-template");
|
|
14
|
+
const class_template_1 = require("./class-template");
|
|
15
|
+
const type_utils_1 = require("../../../adapters/type-utils");
|
|
16
|
+
const apex_types_1 = require("../../../adapters/apex-types");
|
|
17
|
+
const markdown_home_file_1 = require("../../../model/markdown-home-file");
|
|
18
|
+
const markdown_file_1 = require("../../../model/markdown-file");
|
|
19
|
+
const handlebars_1 = __importDefault(require("handlebars"));
|
|
20
|
+
const fs_1 = __importDefault(require("fs"));
|
|
21
|
+
const path_1 = __importDefault(require("path"));
|
|
5
22
|
class PlainMarkdownDocsProcessor extends markdown_transpiler_base_1.MarkdownTranspilerBase {
|
|
23
|
+
constructor() {
|
|
24
|
+
super(...arguments);
|
|
25
|
+
this._fileContents = [];
|
|
26
|
+
this.onBeforeProcess = (types) => {
|
|
27
|
+
if (settings_1.Settings.getInstance().shouldOutputSingleFile()) {
|
|
28
|
+
return;
|
|
29
|
+
}
|
|
30
|
+
else {
|
|
31
|
+
this._fileContainer.pushFile(new markdown_home_file_1.MarkdownHomeFile(this.homeFileName(), types));
|
|
32
|
+
}
|
|
33
|
+
};
|
|
34
|
+
this.onAfterProcess = () => {
|
|
35
|
+
if (settings_1.Settings.getInstance().shouldOutputSingleFile()) {
|
|
36
|
+
const file = new markdown_file_1.MarkdownFile(settings_1.Settings.getInstance().getSingleFileName(), '');
|
|
37
|
+
let contents;
|
|
38
|
+
if (settings_1.Settings.getInstance().getTemplateFilePath()) {
|
|
39
|
+
const filePath = path_1.default.resolve(settings_1.Settings.getInstance().getTemplateFilePath());
|
|
40
|
+
const templateFileContents = fs_1.default.readFileSync(filePath, {
|
|
41
|
+
encoding: 'utf-8',
|
|
42
|
+
});
|
|
43
|
+
const handlebars = handlebars_1.default.compile(templateFileContents);
|
|
44
|
+
contents = handlebars({ api_docs: this._fileContents.join('\n\n---\n\n') });
|
|
45
|
+
}
|
|
46
|
+
else {
|
|
47
|
+
contents = this._fileContents.join('\n\n---\n\n');
|
|
48
|
+
}
|
|
49
|
+
file.addText(contents);
|
|
50
|
+
this._fileContainer.pushFile(file);
|
|
51
|
+
}
|
|
52
|
+
};
|
|
53
|
+
}
|
|
6
54
|
homeFileName() {
|
|
7
55
|
return 'index';
|
|
8
56
|
}
|
|
9
57
|
getLinkingStrategy() {
|
|
10
58
|
return 'path-relative';
|
|
11
59
|
}
|
|
60
|
+
onProcess(type) {
|
|
61
|
+
if (settings_1.Settings.getInstance().shouldOutputSingleFile()) {
|
|
62
|
+
this._fileContents.push(this._generateOutputFile(type).body);
|
|
63
|
+
}
|
|
64
|
+
else {
|
|
65
|
+
this._fileContainer.pushFile(this._generateOutputFile(type));
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
_generateOutputFile(type) {
|
|
69
|
+
if (type.type_name === 'enum') {
|
|
70
|
+
return new GenericFile(type, apex_types_1.enumTypeToEnumSource, enum_template_1.enumMarkdownTemplate);
|
|
71
|
+
}
|
|
72
|
+
else if (type.type_name === 'interface') {
|
|
73
|
+
return new GenericFile(type, apex_types_1.interfaceTypeToInterfaceSource, interface_template_1.interfaceMarkdownTemplate);
|
|
74
|
+
}
|
|
75
|
+
else {
|
|
76
|
+
return new GenericFile(type, apex_types_1.classTypeToClassSource, class_template_1.classMarkdownTemplate);
|
|
77
|
+
}
|
|
78
|
+
}
|
|
12
79
|
}
|
|
13
80
|
exports.PlainMarkdownDocsProcessor = PlainMarkdownDocsProcessor;
|
|
81
|
+
class GenericFile extends outputFile_1.OutputFile {
|
|
82
|
+
constructor(type, toSource, template) {
|
|
83
|
+
super(`${settings_1.Settings.getInstance().getNamespacePrefix()}${type.name}`, class_file_generatorHelper_1.default.getSanitizedGroup(type));
|
|
84
|
+
this.type = type;
|
|
85
|
+
const source = toSource(type);
|
|
86
|
+
this.addText((0, compile_1.compile)(template, source, {
|
|
87
|
+
renderableContentConverter: prepareDescription,
|
|
88
|
+
codeBlockConverter: convertCodeBlock,
|
|
89
|
+
}));
|
|
90
|
+
}
|
|
91
|
+
fileExtension() {
|
|
92
|
+
return '.md';
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
function prepareDescription(description) {
|
|
96
|
+
if (!description) {
|
|
97
|
+
return '';
|
|
98
|
+
}
|
|
99
|
+
function reduceDescription(acc, curr) {
|
|
100
|
+
if (typeof curr === 'string') {
|
|
101
|
+
return acc + curr.trim() + ' ';
|
|
102
|
+
}
|
|
103
|
+
else if ((0, type_utils_1.isEmptyLine)(curr)) {
|
|
104
|
+
return acc + '\n\n';
|
|
105
|
+
}
|
|
106
|
+
else {
|
|
107
|
+
return acc + linkToMarkdown(curr) + ' ';
|
|
108
|
+
}
|
|
109
|
+
}
|
|
110
|
+
function linkToMarkdown(link) {
|
|
111
|
+
return `[${link.title}](${link.url})`;
|
|
112
|
+
}
|
|
113
|
+
return description.reduce(reduceDescription, '').trim();
|
|
114
|
+
}
|
|
115
|
+
function convertCodeBlock(language, lines) {
|
|
116
|
+
return `
|
|
117
|
+
\`\`\`${language}
|
|
118
|
+
${lines.join('\n')}
|
|
119
|
+
\`\`\`
|
|
120
|
+
`.trim();
|
|
121
|
+
}
|
|
14
122
|
//# sourceMappingURL=plain-docsProcessor.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"plain-docsProcessor.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/plain-docsProcessor.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"plain-docsProcessor.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/plain-docsProcessor.ts"],"names":[],"mappings":";;;;;;AAAA,0EAAqE;AAGrE,0DAAuD;AACvD,gDAA6C;AAC7C,+FAAqE;AACrE,mDAAuD;AACvD,yDAAsD;AAEtD,6DAAiE;AACjE,qDAAyD;AACzD,6DAA2D;AAC3D,6DAIsC;AACtC,0EAAqE;AACrE,gEAA4D;AAC5D,4DAAoC;AACpC,4CAAoB;AACpB,gDAAwB;AAExB,MAAa,0BAA2B,SAAQ,iDAAsB;IAAtE;;QACE,kBAAa,GAAa,EAAE,CAAC;QAC7B,oBAAe,GAAG,CAAC,KAAa,EAAE,EAAE;YAClC,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,sBAAsB,EAAE,EAAE;gBACnD,OAAO;aACR;iBAAM;gBACL,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,qCAAgB,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;aAChF;QACH,CAAC,CAAC;QAkBF,mBAAc,GAA4B,GAAG,EAAE;YAC7C,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,sBAAsB,EAAE,EAAE;gBACnD,MAAM,IAAI,GAAG,IAAI,4BAAY,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,iBAAiB,EAAE,EAAE,EAAE,CAAC,CAAC;gBAE9E,IAAI,QAAQ,CAAC;gBACb,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,mBAAmB,EAAE,EAAE;oBAChD,MAAM,QAAQ,GAAG,cAAI,CAAC,OAAO,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,mBAAmB,EAAG,CAAC,CAAC;oBAC7E,MAAM,oBAAoB,GAAG,YAAE,CAAC,YAAY,CAAC,QAAQ,EAAE;wBACrD,QAAQ,EAAE,OAAO;qBAClB,CAAC,CAAC;oBACH,MAAM,UAAU,GAAG,oBAAU,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;oBAC5D,QAAQ,GAAG,UAAU,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;iBAC7E;qBAAM;oBACL,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;iBACnD;gBACD,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBACvB,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;aACpC;QACH,CAAC,CAAC;IAeJ,CAAC;IAjDC,YAAY;QACV,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,kBAAkB;QAChB,OAAO,eAAe,CAAC;IACzB,CAAC;IAED,SAAS,CAAC,IAAU;QAClB,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,sBAAsB,EAAE,EAAE;YACnD,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC;SAC9D;aAAM;YACL,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC;SAC9D;IACH,CAAC;IAsBD,mBAAmB,CAAC,IAAU;QAC5B,IAAI,IAAI,CAAC,SAAS,KAAK,MAAM,EAAE;YAC7B,OAAO,IAAI,WAAW,CAAa,IAAkB,EAAE,iCAAoB,EAAE,oCAAoB,CAAC,CAAC;SACpG;aAAM,IAAI,IAAI,CAAC,SAAS,KAAK,WAAW,EAAE;YACzC,OAAO,IAAI,WAAW,CACpB,IAAuB,EACvB,2CAA8B,EAC9B,8CAAyB,CAC1B,CAAC;SACH;aAAM;YACL,OAAO,IAAI,WAAW,CAAc,IAAmB,EAAE,mCAAsB,EAAE,sCAAqB,CAAC,CAAC;SACzG;IACH,CAAC;CACF;AA3DD,gEA2DC;AAED,MAAM,WAA4B,SAAQ,uBAAU;IAClD,YAAoB,IAAO,EAAE,QAAiE,EAAE,QAAgB;QAC9G,KAAK,CACH,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,kBAAkB,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,EAC5D,oCAAwB,CAAC,iBAAiB,CAAC,IAAI,CAAC,CACjD,CAAC;QAJgB,SAAI,GAAJ,IAAI,CAAG;QAMzB,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC9B,IAAI,CAAC,OAAO,CACV,IAAA,iBAAO,EAAC,QAAQ,EAAE,MAAM,EAAE;YACxB,0BAA0B,EAAE,kBAAkB;YAC9C,kBAAkB,EAAE,gBAAgB;SACrC,CAAC,CACH,CAAC;IACJ,CAAC;IAED,aAAa;QACX,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAED,SAAS,kBAAkB,CAAC,WAAiC;IAC3D,IAAI,CAAC,WAAW,EAAE;QAChB,OAAO,EAAE,CAAC;KACX;IAED,SAAS,iBAAiB,CAAC,GAAW,EAAE,IAAuB;QAC7D,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;YAC5B,OAAO,GAAG,GAAG,IAAI,CAAC,IAAI,EAAE,GAAG,GAAG,CAAC;SAChC;aAAM,IAAI,IAAA,wBAAW,EAAC,IAAI,CAAC,EAAE;YAC5B,OAAO,GAAG,GAAG,MAAM,CAAC;SACrB;aAAM;YACL,OAAO,GAAG,GAAG,cAAc,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC;SACzC;IACH,CAAC;IAED,SAAS,cAAc,CAAC,IAAU;QAChC,OAAO,IAAI,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,GAAG,GAAG,CAAC;IACxC,CAAC;IAED,OAAO,WAAW,CAAC,MAAM,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;AAC1D,CAAC;AAED,SAAS,gBAAgB,CAAC,QAAgB,EAAE,KAAe;IACzD,OAAO;QACD,QAAQ;EACd,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;;GAEf,CAAC,IAAI,EAAE,CAAC;AACX,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare const typeLevelApexDocPartialTemplate: string;
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.typeLevelApexDocPartialTemplate = void 0;
|
|
4
|
+
exports.typeLevelApexDocPartialTemplate = `
|
|
5
|
+
{{#> documentablePartialTemplate}}
|
|
6
|
+
|
|
7
|
+
{{#if group}}
|
|
8
|
+
**Group** {{group}}
|
|
9
|
+
{{/if}}
|
|
10
|
+
|
|
11
|
+
{{#if author}}
|
|
12
|
+
**Author** {{author}}
|
|
13
|
+
{{/if}}
|
|
14
|
+
|
|
15
|
+
{{#if date}}
|
|
16
|
+
**Date** {{date}}
|
|
17
|
+
{{/if}}
|
|
18
|
+
|
|
19
|
+
{{#each sees}}
|
|
20
|
+
**See** {{this}}
|
|
21
|
+
|
|
22
|
+
{{/each}}
|
|
23
|
+
|
|
24
|
+
{{#if namespace}}
|
|
25
|
+
## Namespace
|
|
26
|
+
{{namespace}}
|
|
27
|
+
{{/if}}
|
|
28
|
+
|
|
29
|
+
{{/documentablePartialTemplate}}
|
|
30
|
+
`.trim();
|
|
31
|
+
//# sourceMappingURL=type-level-apex-doc-partial-template.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"type-level-apex-doc-partial-template.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/type-level-apex-doc-partial-template.ts"],"names":[],"mappings":";;;AAAa,QAAA,+BAA+B,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;CA0B9C,CAAC,IAAI,EAAE,CAAC"}
|
|
@@ -1,7 +1,10 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
2
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
6
|
exports.OpenApiDocsProcessor = void 0;
|
|
4
|
-
const processor_type_transpiler_1 = require("../processor-type-transpiler");
|
|
7
|
+
const processor_type_transpiler_1 = __importDefault(require("../processor-type-transpiler"));
|
|
5
8
|
const file_container_1 = require("../file-container");
|
|
6
9
|
const openapi_type_file_1 = require("../../model/openapi/openapi-type-file");
|
|
7
10
|
const logger_1 = require("../../util/logger");
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"open-api-docs-processor.js","sourceRoot":"","sources":["../../../src/transpiler/openapi/open-api-docs-processor.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"open-api-docs-processor.js","sourceRoot":"","sources":["../../../src/transpiler/openapi/open-api-docs-processor.ts"],"names":[],"mappings":";;;;;;AAAA,6FAAmE;AACnE,sDAAkD;AAElD,6EAAwE;AACxE,8CAA2C;AAC3C,2DAAuD;AACvD,6CAA0C;AAC1C,yDAAsD;AACtD,0DAAsD;AAEtD,MAAa,oBAAqB,SAAQ,mCAAuB;IAI/D;QACE,KAAK,EAAE,CAAC;QAsDV,mBAAc,GAA0C,GAAG,EAAE;YAC3D,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,mCAAe,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;QACvE,CAAC,CAAC;QAvDA,IAAI,CAAC,cAAc,GAAG,IAAI,8BAAa,EAAE,CAAC;QAC1C,MAAM,KAAK,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,eAAe,EAAE,CAAC;QACvD,IAAI,CAAC,KAAK,EAAE;YACV,MAAM,KAAK,CAAC,gCAAgC,CAAC,CAAC;SAC/C;QACD,IAAI,CAAC,YAAY,GAAG,IAAI,kBAAO,CAAC,KAAK,EAAE,OAAO,EAAE,mBAAQ,CAAC,WAAW,EAAE,CAAC,YAAY,EAAE,CAAC,CAAC;IACzF,CAAC;IAED,WAAW;QACT,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED,SAAS,CAAC,IAAU;;QAClB,eAAM,CAAC,SAAS,CAAC,cAAc,IAAI,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QAEnE,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAChD,IAAI,CAAC,YAAY,EAAE;YACjB,OAAO;SACR;QAED,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC;QAC3C,IAAI,MAAA,IAAI,CAAC,UAAU,0CAAE,WAAW,EAAE;YAChC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;SACjF;QAED,6FAA6F;QAC7F,MAAM,WAAW,GAAG,IAAmB,CAAC;QAExC,oDAAoD;QACpD,MAAM,OAAO,GAAG,IAAA,0BAAW,EAAC,YAAY,CAAC,CAAC;QAC1C,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC;YAC1B,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,MAAA,IAAI,CAAC,UAAU,0CAAE,WAAW;SAC1C,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,IAAI,2BAAY,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAEnD,MAAM;QACN,MAAM,CAAC,WAAW,CAAC,WAAW,EAAE,YAAY,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;QAE9D,QAAQ;QACR,MAAM,CAAC,WAAW,CAAC,WAAW,EAAE,YAAY,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAEhE,OAAO;QACP,MAAM,CAAC,WAAW,CAAC,WAAW,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAE/D,MAAM;QACN,MAAM,CAAC,WAAW,CAAC,WAAW,EAAE,YAAY,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;QAE9D,SAAS;QACT,MAAM,CAAC,WAAW,CAAC,WAAW,EAAE,YAAY,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;IAMO,eAAe,CAAC,IAAU;;QAChC,MAAM,sBAAsB,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,cAAc,CAAC,CAAC;QACjH,MAAM,UAAU,GAAG,MAAA,sBAAsB,aAAtB,sBAAsB,uBAAtB,sBAAsB,CAAE,aAAa,0CAAE,IAAI,CAC5D,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,KAAK,YAAY,CACxD,CAAC;QACF,IAAI,CAAC,UAAU,EAAE;YACf,eAAM,CAAC,KAAK,CAAC,+CAA+C,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;YACzE,OAAO,IAAI,CAAC;SACb;QAED,IAAI,YAAY,GAAG,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAClG,IAAI,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YAChC,YAAY,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;SAC1C;QACD,OAAO,YAAY,CAAC;IACtB,CAAC;CACF;AA/ED,oDA+EC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Builder.js","sourceRoot":"","sources":["../../../../src/transpiler/openapi/parsers/Builder.ts"],"names":[],"mappings":";;;AAAA,yDAAiE;AAQjE,MAAsB,OAAO;IAA7B;QAuBU,sBAAiB,GAAG,CAAC,
|
|
1
|
+
{"version":3,"file":"Builder.js","sourceRoot":"","sources":["../../../../src/transpiler/openapi/parsers/Builder.ts"],"names":[],"mappings":";;;AAAA,yDAAiE;AAQjE,MAAsB,OAAO;IAA7B;QAuBU,sBAAiB,GAAG,CAAC,YAAqB,EAA0B,EAAE;YAC5E,OAAO,OAAO,YAAY,KAAK,QAAQ,IAAI,YAAY,YAAY,MAAM,CAAC;QAC5E,CAAC,CAAC;IACJ,CAAC;IAzBC,KAAK,CAAC,WAA+B;QACnC,IAAI,SAAgC,CAAC;QACrC,IAAI,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE;YAC9C,SAAS,GAAG,IAAI,mCAAgB,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;SAC9D;QAED,OAAO;YACL,SAAS,EAAE,SAAS;YACpB,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,WAAgB,EAAE,SAAS,CAAC;SAClD,CAAC;IACJ,CAAC;IAIS,iCAAiC,CAAC,WAA+B,EAAE,SAAqB;QAChG,IAAI,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE;YAC9C,kCAAkC;YAClC,OAAO,SAAU,CAAC,yBAAyB,CAAC;SAC7C;QACD,OAAO,WAAW,CAAC,MAAM,CAAC;IAC5B,CAAC;CAKF;AA1BD,0BA0BC"}
|
|
@@ -1,7 +1,30 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
14
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
15
|
+
}) : function(o, v) {
|
|
16
|
+
o["default"] = v;
|
|
17
|
+
});
|
|
18
|
+
var __importStar = (this && this.__importStar) || function (mod) {
|
|
19
|
+
if (mod && mod.__esModule) return mod;
|
|
20
|
+
var result = {};
|
|
21
|
+
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
22
|
+
__setModuleDefault(result, mod);
|
|
23
|
+
return result;
|
|
24
|
+
};
|
|
2
25
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
26
|
exports.MethodParser = void 0;
|
|
4
|
-
const yaml = require("js-yaml");
|
|
27
|
+
const yaml = __importStar(require("js-yaml"));
|
|
5
28
|
const ClassMirrorWrapper_1 = require("../../../model/apex-type-wrappers/ClassMirrorWrapper");
|
|
6
29
|
const ReferenceBuilder_1 = require("./ReferenceBuilder");
|
|
7
30
|
const ParameterObjectBuilder_1 = require("./ParameterObjectBuilder");
|
|
@@ -51,7 +74,7 @@ class MethodParser {
|
|
|
51
74
|
}
|
|
52
75
|
for (const annotation of annotations) {
|
|
53
76
|
// We expect the ApexDoc data representing this to be in YAML format.
|
|
54
|
-
const inYaml = annotation === null || annotation === void 0 ? void 0 : annotation.bodyLines.reduce((prev, current
|
|
77
|
+
const inYaml = annotation === null || annotation === void 0 ? void 0 : annotation.bodyLines.reduce((prev, current) => prev + '\n' + current);
|
|
55
78
|
if (!inYaml) {
|
|
56
79
|
return;
|
|
57
80
|
}
|