@cparra/apexdocs 2.25.0-alpha.8 → 2.25.0

package/lib/model/markdown-type-file.d.ts

@@ -0,0 +1,26 @@
+import { ClassMirror, ConstructorMirror, EnumMirror, InterfaceMirror, MethodMirror, Type } from '@cparra/apex-reflection';
+import { WalkerListener } from '../service/walkers/walker';
+import { MarkdownFile } from './markdown-file';
+import { FieldMirrorWithInheritance, PropertyMirrorWithInheritance } from './inheritance';
+export declare class MarkdownTypeFile extends MarkdownFile implements WalkerListener {
+    private type;
+    private headingLevel;
+    private isInner;
+    constructor(type: Type, headingLevel?: number, headerContent?: string, isInner?: boolean);
+    onTypeDeclaration(typeMirror: Type): void;
+    private isClass;
+    onConstructorDeclaration(className: string, constructors: ConstructorMirror[]): void;
+    onFieldsDeclaration(fields: FieldMirrorWithInheritance[]): void;
+    onPropertiesDeclaration(properties: PropertyMirrorWithInheritance[]): void;
+    onMethodsDeclaration(methods: MethodMirror[]): void;
+    onInnerEnumsDeclaration(enums: EnumMirror[]): void;
+    onInnerClassesDeclaration(classes: ClassMirror[]): void;
+    onInnerInterfacesDeclaration(interfaces: InterfaceMirror[]): void;
+    private addInnerTypes;
+    private hasGroupings;
+    private declareMethodWithGroupings;
+    private declareFieldOrProperty;
+    private startGroup;
+    private endGroup;
+    private group;
+}

package/lib/model/markdown-type-file.js

@@ -0,0 +1,134 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MarkdownTypeFile = void 0;
+const walker_factory_1 = require("../service/walkers/walker-factory");
+const markdown_file_1 = require("./markdown-file");
+const markdown_generation_util_1 = require("./markdown-generation-util");
+const class_file_generatorHelper_1 = require("../transpiler/markdown/class-file-generatorHelper");
+const settings_1 = require("../settings");
+class MarkdownTypeFile extends markdown_file_1.MarkdownFile {
+    constructor(type, headingLevel = 1, headerContent, isInner = false) {
+        super(`${settings_1.Settings.getInstance().getNamespacePrefix()}${type.name}`, class_file_generatorHelper_1.default.getSanitizedGroup(type));
+        this.type = type;
+        this.headingLevel = headingLevel;
+        this.isInner = isInner;
+        if (headerContent) {
+            this.addText(headerContent);
+        }
+        const walker = walker_factory_1.WalkerFactory.get(type);
+        walker.walk(this);
+    }
+    onTypeDeclaration(typeMirror) {
+        let fullTypeName;
+        if (this.isInner) {
+            fullTypeName = typeMirror.name;
+        }
+        else {
+            // If we are dealing with a class, we want to check if it has a class
+            // modifier and add it to the name.
+            if (this.isClass(typeMirror) && typeMirror.classModifier) {
+                fullTypeName = `${typeMirror.classModifier} ${settings_1.Settings.getInstance().getNamespacePrefix()}${typeMirror.name}`;
+            }
+            else {
+                fullTypeName = `${settings_1.Settings.getInstance().getNamespacePrefix()}${typeMirror.name}`;
+            }
+        }
+        this.addTitle(fullTypeName, this.headingLevel);
+        (0, markdown_generation_util_1.declareType)(this, typeMirror);
+    }
+    isClass(typeMirror) {
+        return typeMirror.type_name === 'class';
+    }
+    onConstructorDeclaration(className, constructors) {
+        this.addTitle('Constructors', this.headingLevel + 1);
+        this.declareMethodWithGroupings(constructors, className);
+    }
+    onFieldsDeclaration(fields) {
+        this.addTitle('Fields', this.headingLevel + 1);
+        this.declareFieldOrProperty(fields);
+    }
+    onPropertiesDeclaration(properties) {
+        this.addTitle('Properties', this.headingLevel + 1);
+        this.declareFieldOrProperty(properties);
+    }
+    onMethodsDeclaration(methods) {
+        this.addTitle('Methods', this.headingLevel + 1);
+        this.declareMethodWithGroupings(methods);
+    }
+    onInnerEnumsDeclaration(enums) {
+        this.addInnerTypes('Enums', enums);
+    }
+    onInnerClassesDeclaration(classes) {
+        this.addInnerTypes('Classes', classes);
+    }
+    onInnerInterfacesDeclaration(interfaces) {
+        this.addInnerTypes('Interfaces', interfaces, false);
+    }
+    addInnerTypes(title, types, addSeparator = true) {
+        this.addTitle(title, this.headingLevel + 1);
+        types.forEach((currentType) => {
+            const innerFile = new MarkdownTypeFile(currentType, this.headingLevel + 2, undefined, true);
+            this.addText(innerFile._contents);
+        });
+        if (addSeparator) {
+            this.addHorizontalRule();
+        }
+    }
+    hasGroupings(groupAware) {
+        return !!groupAware.find((current) => !!current.group);
+    }
+    declareMethodWithGroupings(methods, className = '') {
+        const hasGroupings = this.hasGroupings(methods);
+        if (!hasGroupings) {
+            (0, markdown_generation_util_1.declareMethod)(this, methods, this.headingLevel, className);
+        }
+        else {
+            const groupedConstructors = this.group(methods);
+            for (const key in groupedConstructors) {
+                // For the group description, we can take the first one, since they all have the same description.
+                this.startGroup(key, groupedConstructors[key][0].groupDescription);
+                const constructorsForGroup = groupedConstructors[key];
+                (0, markdown_generation_util_1.declareMethod)(this, constructorsForGroup, this.headingLevel, className);
+                this.endGroup();
+            }
+        }
+    }
+    declareFieldOrProperty(fieldsOrProperties) {
+        const hasGroupings = this.hasGroupings(fieldsOrProperties);
+        if (!hasGroupings) {
+            (0, markdown_generation_util_1.declareField)(this, fieldsOrProperties, this.headingLevel, false);
+        }
+        else {
+            const groupedFields = this.group(fieldsOrProperties);
+            for (const key in groupedFields) {
+                // For the group description, we can take the first one, since they all have the same description.
+                this.startGroup(key, groupedFields[key][0].groupDescription);
+                const fieldsForGroup = groupedFields[key];
+                (0, markdown_generation_util_1.declareField)(this, fieldsForGroup, this.headingLevel, true);
+                this.endGroup();
+            }
+        }
+    }
+    startGroup(groupName, groupDescription) {
+        this.headingLevel = this.headingLevel + 2;
+        this.addTitle(groupName, this.headingLevel);
+        if (groupDescription) {
+            this.addText(groupDescription);
+        }
+    }
+    endGroup() {
+        this.headingLevel = this.headingLevel - 2;
+    }
+    group(list) {
+        return list.reduce((groups, item) => {
+            var _a;
+            const groupName = (_a = item.group) !== null && _a !== void 0 ? _a : 'Other';
+            const group = groups[groupName] || [];
+            group.push(item);
+            groups[groupName] = group;
+            return groups;
+        }, {});
+    }
+}
+exports.MarkdownTypeFile = MarkdownTypeFile;
+//# sourceMappingURL=markdown-type-file.js.map

package/lib/model/markdown-type-file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown-type-file.js","sourceRoot":"","sources":["../../src/model/markdown-type-file.ts"],"names":[],"mappings":";;;AAQA,sEAAkE;AAElE,mDAA+C;AAC/C,yEAAsF;AACtF,kGAAyF;AAEzF,0CAAuC;AAWvC,MAAa,gBAAiB,SAAQ,4BAAY;IAChD,YAAoB,IAAU,EAAU,eAAuB,CAAC,EAAE,aAAsB,EAAU,UAAU,KAAK;QAC/G,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,CAAM;QAAU,iBAAY,GAAZ,YAAY,CAAY;QAAkC,YAAO,GAAP,OAAO,CAAQ;QAK/G,IAAI,aAAa,EAAE;YACjB,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;SAC7B;QACD,MAAM,MAAM,GAAG,8BAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACvC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpB,CAAC;IAEM,iBAAiB,CAAC,UAAgB;QACvC,IAAI,YAAY,CAAC;QACjB,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,YAAY,GAAG,UAAU,CAAC,IAAI,CAAC;SAChC;aAAM;YACL,qEAAqE;YACrE,mCAAmC;YACnC,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,UAAU,CAAC,aAAa,EAAE;gBACxD,YAAY,GAAG,GAAG,UAAU,CAAC,aAAa,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,kBAAkB,EAAE,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC;aAC/G;iBAAM;gBACL,YAAY,GAAG,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,kBAAkB,EAAE,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC;aACnF;SACF;QACD,IAAI,CAAC,QAAQ,CAAC,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QAC/C,IAAA,sCAAW,EAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IAChC,CAAC;IAEO,OAAO,CAAC,UAAgB;QAC9B,OAAO,UAAU,CAAC,SAAS,KAAK,OAAO,CAAC;IAC1C,CAAC;IAEM,wBAAwB,CAAC,SAAiB,EAAE,YAAiC;QAClF,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;QACrD,IAAI,CAAC,0BAA0B,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;IAC3D,CAAC;IAEM,mBAAmB,CAAC,MAAoC;QAC7D,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;QAC/C,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC;IACtC,CAAC;IAEM,uBAAuB,CAAC,UAA2C;QACxE,IAAI,CAAC,QAAQ,CAAC,YAAY,EAAE,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;QACnD,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC;IAC1C,CAAC;IAEM,oBAAoB,CAAC,OAAuB;QACjD,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;QAChD,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,CAAC;IAC3C,CAAC;IAEM,uBAAuB,CAAC,KAAmB;QAChD,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACrC,CAAC;IAEM,yBAAyB,CAAC,OAAsB;QACrD,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IACzC,CAAC;IAEM,4BAA4B,CAAC,UAA6B;QAC/D,IAAI,CAAC,aAAa,CAAC,YAAY,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;IACtD,CAAC;IAEO,aAAa,CAAC,KAAa,EAAE,KAAa,EAAE,YAAY,GAAG,IAAI;QACrE,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;QAC5C,KAAK,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;YAC5B,MAAM,SAAS,GAAG,IAAI,gBAAgB,CAAC,WAAW,EAAE,IAAI,CAAC,YAAY,GAAG,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;YAC5F,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QACpC,CAAC,CAAC,CAAC;QACH,IAAI,YAAY,EAAE;YAChB,IAAI,CAAC,iBAAiB,EAAE,CAAC;SAC1B;IACH,CAAC;IAEO,YAAY,CAAC,UAAwB;QAC3C,OAAO,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACzD,CAAC;IAEO,0BAA0B,CAChC,OAA4D,EAC5D,SAAS,GAAG,EAAE;QAEd,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QAChD,IAAI,CAAC,YAAY,EAAE;YACjB,IAAA,wCAAa,EAAC,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;SAC5D;aAAM;YACL,MAAM,mBAAmB,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAChD,KAAK,MAAM,GAAG,IAAI,mBAAmB,EAAE;gBACrC,kGAAkG;gBAClG,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,mBAAmB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC;gBACnE,MAAM,oBAAoB,GAAG,mBAAmB,CAAC,GAAG,CAAwD,CAAC;gBAC7G,IAAA,wCAAa,EAAC,IAAI,EAAE,oBAAoB,EAAE,IAAI,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;gBACxE,IAAI,CAAC,QAAQ,EAAE,CAAC;aACjB;SACF;IACH,CAAC;IAEO,sBAAsB,CAC5B,kBAAkF;QAElF,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC;QAC3D,IAAI,CAAC,YAAY,EAAE;YACjB,IAAA,uCAAY,EAAC,IAAI,EAAE,kBAAkB,EAAE,IAAI,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;SAClE;aAAM;YACL,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;YACrD,KAAK,MAAM,GAAG,IAAI,aAAa,EAAE;gBAC/B,kGAAkG;gBAClG,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC;gBAC7D,MAAM,cAAc,GAAG,aAAa,CAAC,GAAG,CAAmE,CAAC;gBAC5G,IAAA,uCAAY,EAAC,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;gBAC5D,IAAI,CAAC,QAAQ,EAAE,CAAC;aACjB;SACF;IACH,CAAC;IAEO,UAAU,CAAC,SAAiB,EAAE,gBAAyB;QAC7D,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;QAC1C,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QAC5C,IAAI,gBAAgB,EAAE;YACpB,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;SAChC;IACH,CAAC;IAEO,QAAQ;QACd,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;IAC5C,CAAC;IAEO,KAAK,CAAC,IAAkB;QAC9B,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,MAAgB,EAAE,IAAI,EAAE,EAAE;;YAC5C,MAAM,SAAS,GAAW,MAAA,IAAI,CAAC,KAAK,mCAAI,OAAO,CAAC;YAChD,MAAM,KAAK,GAAiB,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;YACpD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACjB,MAAM,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC;YAC1B,OAAO,MAAM,CAAC;QAChB,CAAC,EAAE,EAAE,CAAC,CAAC;IACT,CAAC;CACF;AA3ID,4CA2IC"}

package/lib/model/openapi/apex-doc-types.d.ts

@@ -0,0 +1,19 @@
+import { SchemaObjectArray, SchemaObjectObject } from './open-api-types';
+export type ApexDocHttpResponse = {
+    statusCode: number;
+    description?: string;
+    schema: ApexDocSchemaObject;
+};
+export type ApexDocHttpRequestBody = {
+    description?: string;
+    schema: ApexDocSchemaObject;
+    required?: boolean;
+};
+export type ApexDocParameterObject = {
+    name: string;
+    in: 'query' | 'header' | 'path' | 'cookie';
+    description?: string;
+    required?: boolean;
+    schema: ApexDocSchemaObject;
+};
+export type ApexDocSchemaObject = SchemaObjectObject | SchemaObjectArray | string;

package/lib/model/openapi/apex-doc-types.js

@@ -0,0 +1,5 @@
+"use strict";
+// These are types that represent how the data is expected to be created in the ApexDoc (as YAML), which
+// in some cases might be different from the official OpenApi spec for simplicity when writing the ApexDoc.
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=apex-doc-types.js.map

package/lib/model/openapi/apex-doc-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"apex-doc-types.js","sourceRoot":"","sources":["../../../src/model/openapi/apex-doc-types.ts"],"names":[],"mappings":";AAAA,wGAAwG;AACxG,2GAA2G"}

package/lib/model/openapi/open-api-types.d.ts

@@ -0,0 +1,93 @@
+export type InfoObject = {
+    title: string;
+    version: string;
+};
+export type ServerObject = {
+    url: string;
+};
+export type PathsObject = {
+    [index: string]: PathItemObject;
+};
+export type PathItemObject = {
+    description?: string;
+    get?: OperationObject;
+    put?: OperationObject;
+    post?: OperationObject;
+    delete?: OperationObject;
+    patch?: OperationObject;
+};
+export type OperationObject = {
+    tags?: string[];
+    description?: string;
+    summary?: string;
+    requestBody?: RequestBody;
+    parameters?: ParameterObject[];
+    responses?: ResponsesObject;
+};
+export type ParameterObject = {
+    name: string;
+    in: 'query' | 'header' | 'path' | 'cookie';
+    description?: string;
+    required?: boolean;
+    schema?: SchemaObject;
+};
+export type RequestBody = {
+    description?: string;
+    content: RequestBodyContent;
+    required?: boolean;
+};
+export type RequestBodyContent = {
+    [index: string]: MediaTypeObject;
+};
+export type MediaTypeObject = {
+    schema?: SchemaObject;
+    example?: any;
+    examples?: {
+        [index: string]: ExampleObject;
+    };
+};
+export type ExampleObject = {
+    summary?: string;
+    description?: string;
+    value?: any;
+};
+export type ResponsesObject = {
+    [index: string]: ResponseObject;
+};
+export type ResponseObject = {
+    description: string;
+    content?: ContentObject;
+};
+export type ContentObject = {
+    [index: string]: {
+        schema: SchemaObject;
+    };
+};
+export type SchemaObject = SchemaObjectObject | SchemaObjectArray | ReferenceObject;
+export type SchemaObjectObject = {
+    type: string;
+    properties?: PropertiesObject;
+    format?: string;
+    description?: string;
+};
+export type PropertiesObject = {
+    [index: string]: SchemaObject;
+};
+export type SchemaObjectArray = {
+    type: 'array';
+    items: SchemaObject;
+    description?: string;
+};
+export type ReferenceObject = {
+    $ref: string;
+    description?: string;
+};
+export type ComponentsObject = {
+    schemas: {
+        [index: string]: SchemaObject;
+    };
+};
+export type TagObject = {
+    name: string;
+    description?: string;
+};

package/lib/model/openapi/open-api-types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=open-api-types.js.map

package/lib/model/openapi/open-api-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"open-api-types.js","sourceRoot":"","sources":["../../../src/model/openapi/open-api-types.ts"],"names":[],"mappings":""}

package/lib/model/openapi/open-api.d.ts

@@ -0,0 +1,16 @@
+import { ComponentsObject, InfoObject, PathsObject, ServerObject, TagObject } from './open-api-types';
+/**
+ * Represents the OpenApi 3.1.0 spec
+ * https://spec.openapis.org/oas/v3.1.0
+ */
+export declare class OpenApi {
+    private namespace?;
+    openapi: string;
+    info: InfoObject;
+    tags: TagObject[];
+    paths: PathsObject;
+    servers: ServerObject[];
+    components?: ComponentsObject;
+    constructor(title: string, version: string, namespace?: string | undefined);
+    private getServerUrl;
+}

package/lib/model/openapi/open-api.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenApi = void 0;
+const OPEN_API_VERSION = '3.1.0';
+const SERVER_URL = '/services/apexrest/';
+/**
+ * Represents the OpenApi 3.1.0 spec
+ * https://spec.openapis.org/oas/v3.1.0
+ */
+class OpenApi {
+    constructor(title, version, namespace) {
+        this.namespace = namespace;
+        this.openapi = OPEN_API_VERSION;
+        this.info = {
+            title: title,
+            version: version,
+        };
+        this.servers = [
+            {
+                url: this.getServerUrl(),
+            },
+        ];
+        this.paths = {};
+        this.tags = [];
+    }
+    getServerUrl() {
+        if (!this.namespace) {
+            return SERVER_URL;
+        }
+        return `${SERVER_URL}${this.namespace}/`;
+    }
+}
+exports.OpenApi = OpenApi;
+//# sourceMappingURL=open-api.js.map

package/lib/model/openapi/open-api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"open-api.js","sourceRoot":"","sources":["../../../src/model/openapi/open-api.ts"],"names":[],"mappings":";;;AAEA,MAAM,gBAAgB,GAAG,OAAO,CAAC;AACjC,MAAM,UAAU,GAAG,qBAAqB,CAAC;AAEzC;;;GAGG;AACH,MAAa,OAAO;IAQlB,YAAY,KAAa,EAAE,OAAe,EAAU,SAAkB;QAAlB,cAAS,GAAT,SAAS,CAAS;QAPtE,YAAO,GAAG,gBAAgB,CAAC;QAQzB,IAAI,CAAC,IAAI,GAAG;YACV,KAAK,EAAE,KAAK;YACZ,OAAO,EAAE,OAAO;SACjB,CAAC;QAEF,IAAI,CAAC,OAAO,GAAG;YACb;gBACE,GAAG,EAAE,IAAI,CAAC,YAAY,EAAE;aACzB;SACF,CAAC;QAEF,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;QAChB,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC;IACjB,CAAC;IAEO,YAAY;QAClB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACnB,OAAO,UAAU,CAAC;SACnB;QAED,OAAO,GAAG,UAAU,GAAG,IAAI,CAAC,SAAS,GAAG,CAAC;IAC3C,CAAC;CACF;AA/BD,0BA+BC"}

package/lib/model/openapi/openapi-type-file.d.ts

@@ -0,0 +1,7 @@
+import { OutputFile } from '../outputFile';
+import { OpenApi } from './open-api';
+export declare class OpenapiTypeFile extends OutputFile {
+    openApiModel: OpenApi;
+    constructor(openApiModel: OpenApi);
+    fileExtension(): string;
+}

package/lib/model/openapi/openapi-type-file.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenapiTypeFile = void 0;
+const outputFile_1 = require("../outputFile");
+const settings_1 = require("../../settings");
+class OpenapiTypeFile extends outputFile_1.OutputFile {
+    constructor(openApiModel) {
+        super(settings_1.Settings.getInstance().openApiFileName(), '');
+        this.openApiModel = openApiModel;
+        this.addText(JSON.stringify(Object.assign(Object.assign({}, openApiModel), { namespace: undefined }), null, 2));
+    }
+    fileExtension() {
+        return '.json';
+    }
+}
+exports.OpenapiTypeFile = OpenapiTypeFile;
+//# sourceMappingURL=openapi-type-file.js.map

package/lib/model/openapi/openapi-type-file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"openapi-type-file.js","sourceRoot":"","sources":["../../../src/model/openapi/openapi-type-file.ts"],"names":[],"mappings":";;;AAAA,8CAA2C;AAE3C,6CAA0C;AAE1C,MAAa,eAAgB,SAAQ,uBAAU;IAC7C,YAAmB,YAAqB;QACtC,KAAK,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,eAAe,EAAE,EAAE,EAAE,CAAC,CAAC;QADnC,iBAAY,GAAZ,YAAY,CAAS;QAEtC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,iCAAM,YAAY,KAAE,SAAS,EAAE,SAAS,KAAI,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IACnF,CAAC;IAED,aAAa;QACX,OAAO,OAAO,CAAC;IACjB,CAAC;CACF;AATD,0CASC"}

package/lib/model/outputFile.d.ts

@@ -0,0 +1,10 @@
+export declare abstract class OutputFile {
+    fileName: string;
+    dir: string;
+    _contents: string;
+    constructor(fileName: string, dir: string);
+    abstract fileExtension(): string;
+    get body(): string;
+    addText(text: string, encodeHtml?: boolean): void;
+    addBlankLine(): void;
+}

package/lib/model/outputFile.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OutputFile = void 0;
+const xss = require("xss");
+const settings_1 = require("../settings");
+const xssFilter = new xss.FilterXSS({
+    whiteList: { br: [], p: [], ul: [], li: [], code: [], pre: [] },
+});
+class OutputFile {
+    constructor(fileName, dir) {
+        this.fileName = fileName;
+        this.dir = dir;
+        this._contents = '';
+    }
+    get body() {
+        return this._contents;
+    }
+    addText(text, encodeHtml = true) {
+        const shouldEncode = encodeHtml && settings_1.Settings.getInstance().sanitizeHtml;
+        const textToAdd = shouldEncode ? xssFilter.process(text) : text;
+        this._contents += textToAdd;
+        this.addBlankLine();
+    }
+    addBlankLine() {
+        this._contents += '\n';
+    }
+}
+exports.OutputFile = OutputFile;
+//# sourceMappingURL=outputFile.js.map

package/lib/model/outputFile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"outputFile.js","sourceRoot":"","sources":["../../src/model/outputFile.ts"],"names":[],"mappings":";;;AAAA,2BAA4B;AAC5B,0CAAuC;AAEvC,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC;IAClC,SAAS,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE;CAChE,CAAC,CAAC;AAEH,MAAsB,UAAU;IAG9B,YAAmB,QAAgB,EAAS,GAAW;QAApC,aAAQ,GAAR,QAAQ,CAAQ;QAAS,QAAG,GAAH,GAAG,CAAQ;QAFvD,cAAS,GAAG,EAAE,CAAC;IAE2C,CAAC;IAI3D,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,OAAO,CAAC,IAAY,EAAE,UAAU,GAAG,IAAI;QACrC,MAAM,YAAY,GAAG,UAAU,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,YAAY,CAAC;QACvE,MAAM,SAAS,GAAG,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAChE,IAAI,CAAC,SAAS,IAAI,SAAS,CAAC;QAC5B,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,YAAY;QACV,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC;IACzB,CAAC;CACF;AArBD,gCAqBC"}

package/lib/model/types-repository.d.ts

@@ -0,0 +1,16 @@
+import { Type } from '@cparra/apex-reflection';
+export type TypeBundle = {
+    type: Type;
+    isChild: boolean;
+    parentType?: Type;
+};
+export declare class TypesRepository {
+    private static instance;
+    private scopedTypes;
+    private allTypes;
+    static getInstance(): TypesRepository;
+    populateAll(types: Type[]): void;
+    getFromAllByName(typeName: string): TypeBundle | undefined;
+    populateScoped(types: Type[]): void;
+    getFromScopedByName(typeName: string): Type | undefined;
+}

package/lib/model/types-repository.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TypesRepository = void 0;
+class TypesRepository {
+    constructor() {
+        this.scopedTypes = [];
+        this.allTypes = [];
+    }
+    static getInstance() {
+        if (!TypesRepository.instance) {
+            TypesRepository.instance = new TypesRepository();
+        }
+        return TypesRepository.instance;
+    }
+    populateAll(types) {
+        this.allTypes = types;
+    }
+    getFromAllByName(typeName) {
+        if (typeName.includes('.')) {
+            // If it includes a dot we are assuming we are dealing with an inner class.
+            const [parentTypeName, childTypeName] = typeName.split('.');
+            const parentReference = this.allTypes.find((currentType) => currentType.name.toLowerCase() === parentTypeName.toLowerCase());
+            if (!parentReference || parentReference.type_name !== 'class') {
+                // If the parent is not found, no reason to keep searching, instead we return undefined.
+                // Similarly, if the parent is not a class, it means it cannot have children, so we return early.
+                return undefined;
+            }
+            const parentReferenceAsClass = parentReference;
+            const childTypes = [
+                ...parentReferenceAsClass.classes,
+                ...parentReferenceAsClass.interfaces,
+                ...parentReferenceAsClass.enums,
+            ];
+            const foundType = childTypes.find((currentType) => currentType.name.toLowerCase() === childTypeName);
+            if (!foundType) {
+                return undefined;
+            }
+            return { type: foundType, isChild: true, parentType: parentReference };
+        }
+        const foundType = this.allTypes.find((currentType) => currentType.name.toLowerCase() === typeName.toLowerCase());
+        if (!foundType) {
+            return undefined;
+        }
+        return { type: foundType, isChild: false };
+    }
+    populateScoped(types) {
+        this.scopedTypes = types;
+    }
+    getFromScopedByName(typeName) {
+        return this.scopedTypes.find((currentType) => currentType.name === typeName);
+    }
+}
+exports.TypesRepository = TypesRepository;
+//# sourceMappingURL=types-repository.js.map

package/lib/model/types-repository.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types-repository.js","sourceRoot":"","sources":["../../src/model/types-repository.ts"],"names":[],"mappings":";;;AAIA,MAAa,eAAe;IAA5B;QAEU,gBAAW,GAAW,EAAE,CAAC;QACzB,aAAQ,GAAW,EAAE,CAAC;IAuDhC,CAAC;IArDQ,MAAM,CAAC,WAAW;QACvB,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE;YAC7B,eAAe,CAAC,QAAQ,GAAG,IAAI,eAAe,EAAE,CAAC;SAClD;QACD,OAAO,eAAe,CAAC,QAAQ,CAAC;IAClC,CAAC;IAEM,WAAW,CAAC,KAAa;QAC9B,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;IACxB,CAAC;IAEM,gBAAgB,CAAC,QAAgB;QACtC,IAAI,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YAC1B,2EAA2E;YAC3E,MAAM,CAAC,cAAc,EAAE,aAAa,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC5D,MAAM,eAAe,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CACxC,CAAC,WAAiB,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,cAAc,CAAC,WAAW,EAAE,CACvF,CAAC;YACF,IAAI,CAAC,eAAe,IAAI,eAAe,CAAC,SAAS,KAAK,OAAO,EAAE;gBAC7D,wFAAwF;gBACxF,iGAAiG;gBACjG,OAAO,SAAS,CAAC;aAClB;YAED,MAAM,sBAAsB,GAAG,eAA8B,CAAC;YAC9D,MAAM,UAAU,GAAG;gBACjB,GAAG,sBAAsB,CAAC,OAAO;gBACjC,GAAG,sBAAsB,CAAC,UAAU;gBACpC,GAAG,sBAAsB,CAAC,KAAK;aAChC,CAAC;YACF,MAAM,SAAS,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,WAAiB,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,aAAa,CAAC,CAAC;YAC3G,IAAI,CAAC,SAAS,EAAE;gBACd,OAAO,SAAS,CAAC;aAClB;YACD,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,eAAe,EAAE,CAAC;SACxE;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAClC,CAAC,WAAiB,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,QAAQ,CAAC,WAAW,EAAE,CACjF,CAAC;QACF,IAAI,CAAC,SAAS,EAAE;YACd,OAAO,SAAS,CAAC;SAClB;QACD,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;IAC7C,CAAC;IAEM,cAAc,CAAC,KAAa;QACjC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;IAC3B,CAAC;IAEM,mBAAmB,CAAC,QAAgB;QACzC,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,WAAiB,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC;IACrF,CAAC;CACF;AA1DD,0CA0DC"}

package/lib/service/apex-file-reader.d.ts

@@ -0,0 +1,14 @@
+import { FileSystem } from './file-system';
+import ApexBundle from '../model/apex-bundle';
+/**
+ * Reads from .cls files and returns their raw body.
+ */
+export declare class ApexFileReader {
+    /**
+     * Reads from .cls files and returns their raw body.
+     */
+    static processFiles(fileSystem: FileSystem, rootPath?: string): ApexBundle[];
+    private static isApexFile;
+    private static get sourceDirectory();
+    private static get readRecursively();
+}

package/lib/service/apex-file-reader.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApexFileReader = void 0;
+const settings_1 = require("../settings");
+const apex_bundle_1 = require("../model/apex-bundle");
+const APEX_FILE_EXTENSION = '.cls';
+/**
+ * Reads from .cls files and returns their raw body.
+ */
+class ApexFileReader {
+    /**
+     * Reads from .cls files and returns their raw body.
+     */
+    static processFiles(fileSystem, rootPath = this.sourceDirectory) {
+        let bundles = [];
+        const directoryContents = fileSystem.readDirectory(rootPath);
+        directoryContents.forEach((currentFilePath) => {
+            const currentPath = fileSystem.joinPath(rootPath, currentFilePath);
+            if (this.readRecursively && fileSystem.isDirectory(currentPath)) {
+                bundles = bundles.concat(this.processFiles(fileSystem, currentPath));
+            }
+            if (!this.isApexFile(currentFilePath)) {
+                return;
+            }
+            const rawApexFile = fileSystem.readFile(currentPath);
+            const metadataPath = fileSystem.joinPath(rootPath, `${currentFilePath}-meta.xml`);
+            let rawMetadataFile = null;
+            if (settings_1.Settings.getInstance().includeMetadata()) {
+                rawMetadataFile = fileSystem.exists(metadataPath) ? fileSystem.readFile(metadataPath) : null;
+            }
+            bundles.push(new apex_bundle_1.default(currentFilePath, rawApexFile, rawMetadataFile));
+        });
+        return bundles;
+    }
+    static isApexFile(currentFile) {
+        return currentFile.endsWith(APEX_FILE_EXTENSION);
+    }
+    static get sourceDirectory() {
+        return settings_1.Settings.getInstance().sourceDirectory;
+    }
+    static get readRecursively() {
+        return settings_1.Settings.getInstance().recursive;
+    }
+}
+exports.ApexFileReader = ApexFileReader;
+//# sourceMappingURL=apex-file-reader.js.map

package/lib/service/apex-file-reader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"apex-file-reader.js","sourceRoot":"","sources":["../../src/service/apex-file-reader.ts"],"names":[],"mappings":";;;AAAA,0CAAuC;AAEvC,sDAA8C;AAE9C,MAAM,mBAAmB,GAAG,MAAM,CAAC;AAEnC;;GAEG;AACH,MAAa,cAAc;IACzB;;OAEG;IACH,MAAM,CAAC,YAAY,CAAC,UAAsB,EAAE,WAAmB,IAAI,CAAC,eAAe;QACjF,IAAI,OAAO,GAAiB,EAAE,CAAC;QAE/B,MAAM,iBAAiB,GAAG,UAAU,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QAC7D,iBAAiB,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,EAAE;YAC5C,MAAM,WAAW,GAAG,UAAU,CAAC,QAAQ,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;YACnE,IAAI,IAAI,CAAC,eAAe,IAAI,UAAU,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE;gBAC/D,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC;aACtE;YAED,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE;gBACrC,OAAO;aACR;YAED,MAAM,WAAW,GAAG,UAAU,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;YACrD,MAAM,YAAY,GAAG,UAAU,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,eAAe,WAAW,CAAC,CAAC;YAClF,IAAI,eAAe,GAAG,IAAI,CAAC;YAC3B,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,eAAe,EAAE,EAAE;gBAC5C,eAAe,GAAG,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;aAC9F;YAED,OAAO,CAAC,IAAI,CAAC,IAAI,qBAAU,CAAC,eAAe,EAAE,WAAW,EAAE,eAAe,CAAC,CAAC,CAAC;QAC9E,CAAC,CAAC,CAAC;QACH,OAAO,OAAO,CAAC;IACjB,CAAC;IAEO,MAAM,CAAC,UAAU,CAAC,WAAmB;QAC3C,OAAO,WAAW,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;IACnD,CAAC;IAEO,MAAM,KAAK,eAAe;QAChC,OAAO,mBAAQ,CAAC,WAAW,EAAE,CAAC,eAAe,CAAC;IAChD,CAAC;IAEO,MAAM,KAAK,eAAe;QAChC,OAAO,mBAAQ,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC;IAC1C,CAAC;CACF;AAzCD,wCAyCC"}

package/lib/service/file-system.d.ts

@@ -0,0 +1,14 @@
+export interface FileSystem {
+    readDirectory: (sourceDirectory: string) => string[];
+    isDirectory: (path: string) => boolean;
+    readFile: (path: string) => string;
+    joinPath: (...paths: string[]) => string;
+    exists: (path: string) => boolean;
+}
+export declare class DefaultFileSystem implements FileSystem {
+    isDirectory(pathToRead: string): boolean;
+    readDirectory(sourceDirectory: string): string[];
+    readFile(pathToRead: string): string;
+    joinPath(...paths: string[]): string;
+    exists(path: string): boolean;
+}

package/lib/service/file-system.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultFileSystem = void 0;
+const fs = require("fs");
+const path = require("path");
+class DefaultFileSystem {
+    isDirectory(pathToRead) {
+        return fs.statSync(pathToRead).isDirectory();
+    }
+    readDirectory(sourceDirectory) {
+        return fs.readdirSync(sourceDirectory);
+    }
+    readFile(pathToRead) {
+        const rawFile = fs.readFileSync(pathToRead);
+        return rawFile.toString();
+    }
+    joinPath(...paths) {
+        return path.join(...paths);
+    }
+    exists(path) {
+        return fs.existsSync(path);
+    }
+}
+exports.DefaultFileSystem = DefaultFileSystem;
+//# sourceMappingURL=file-system.js.map

package/lib/service/file-system.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-system.js","sourceRoot":"","sources":["../../src/service/file-system.ts"],"names":[],"mappings":";;;AAAA,yBAAyB;AACzB,6BAA6B;AAU7B,MAAa,iBAAiB;IAC5B,WAAW,CAAC,UAAkB;QAC5B,OAAO,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,WAAW,EAAE,CAAC;IAC/C,CAAC;IAED,aAAa,CAAC,eAAuB;QACnC,OAAO,EAAE,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC;IACzC,CAAC;IAED,QAAQ,CAAC,UAAkB;QACzB,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;QAC5C,OAAO,OAAO,CAAC,QAAQ,EAAE,CAAC;IAC5B,CAAC;IAED,QAAQ,CAAC,GAAG,KAAe;QACzB,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC;IAC7B,CAAC;IAED,MAAM,CAAC,IAAY;QACjB,OAAO,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;CACF;AArBD,8CAqBC"}

package/lib/service/file-writer.d.ts

@@ -0,0 +1,6 @@
+import { OutputFile } from '../model/outputFile';
+import { TargetFile } from '../settings';
+export declare class FileWriter {
+    static write(files: OutputFile[], onWriteCallback: (file: TargetFile) => void): void;
+    private static getTargetLocation;
+}