@terafina/tffa-sfdx-plugin 0.1.2 → 1.0.3

package/lib/apexdoc/common/models/apex-model.js

@@ -0,0 +1,264 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApexModel = void 0;
+const tslib_1 = require("tslib");
+/**
+ * Copyright (c) NCR Terafina
+ **/
+const tags = tslib_1.__importStar(require("../tags"));
+const utils_1 = tslib_1.__importDefault(require("../utils"));
+const settings_1 = tslib_1.__importDefault(require("../settings"));
+/* eslint-disable no-useless-escape */
+class ApexModel {
+    constructor(comments, sourceUrl) {
+        this._annotations = [];
+        this._author = '';
+        this._deprecated = '';
+        this._description = '';
+        this._example = '';
+        this._apipath = '';
+        this._restUrl = '';
+        this._apimethod = '';
+        this._exception = [];
+        this._groupContentPath = '';
+        this._groupName = '';
+        this._tags = '';
+        this._lineNum = 0;
+        this._nameLine = '';
+        this._params = [];
+        this._queryparams = [];
+        this._requestheaders = [];
+        this._responseheaders = [];
+        this._returns = '';
+        this._scope = '';
+        this._see = [];
+        this._since = '';
+        this._source = '';
+        this.parseComments(comments);
+        this._sourceUrl = sourceUrl;
+    }
+    get annotations() {
+        return this._annotations;
+    }
+    get description() {
+        return this._description;
+    }
+    get lineNum() {
+        return this._lineNum;
+    }
+    get nameLine() {
+        return this._nameLine;
+    }
+    get scope() {
+        return this._scope;
+    }
+    get sourceUrl() {
+        return this._sourceUrl;
+    }
+    get source() {
+        return this._source;
+    }
+    setSource(source) {
+        this._source = source;
+    }
+    /* ===================================================================================================
+     * NOTE: Ideally, we should only expose those getters on this class that are shared amongst all
+     * ApexModel descendants. The following three break this convention. 'Example,' 'Deprecated,' and
+     * 'See' are only available to MethodModel and TopLevelModel, however it aids us in reducing repetitive
+     * code in their respective markup generators to expose these getters here. This way, we can write the
+     * markup generation code for these attributes only once on the base MarkupGenerator class, rather than
+     * repeating the same or very similar code on both MethodMarkupGenerator and TopLevelMarkupGenerator.
+     * ===================================================================================================
+     */
+    get example() {
+        // remove trailing white space which may have built
+        // up due to the allowance of preserving white space
+        return this._example.trimRight();
+    }
+    get apipath() {
+        // remove trailing white space which may have built
+        // up due to the allowance of preserving white space
+        return this._apipath.trimRight().trimLeft();
+    }
+    get restUrl() {
+        // remove trailing white space which may have built
+        // up due to the allowance of preserving white space
+        return this._restUrl.trimRight().trimLeft();
+    }
+    get apimethod() {
+        // remove trailing white space which may have built
+        // up due to the allowance of preserving white space
+        return this._apimethod.trimRight().trimLeft();
+    }
+    get deprecated() {
+        return this._deprecated;
+    }
+    get see() {
+        return this._see;
+    }
+    /**
+     * This method is based closely on: https://gitlab.com/StevenWCox/sfapexdoc/blob/master/src/apex/com/main/Model.java#L196
+     */
+    parseComments(comments) {
+        let currBlock = null;
+        let block = null;
+        for (let line of comments) {
+            let newBlock = false, isBreak = false;
+            const lineLower = line.toLowerCase();
+            let i;
+            // skip lines that are just opening or closing comment blocks
+            if (line.trim() === '/**' || line.trim() === '*/') {
+                continue;
+            }
+            // if we find a tag, start a new block
+            if ((i = lineLower.indexOf((block = tags.AUTHOR.label))) >= 0 ||
+                (i = lineLower.indexOf((block = tags.SINCE.label))) >= 0 ||
+                (i = lineLower.indexOf((block = tags.SEE.label))) >= 0 ||
+                (i = lineLower.indexOf((block = tags.RETURN.label))) >= 0 ||
+                (i = lineLower.indexOf((block = tags.RETURNS.label))) >= 0 ||
+                (i = lineLower.indexOf((block = tags.QUERYPARAM.label))) >= 0 ||
+                (i = lineLower.indexOf((block = tags.REQUESTHEADER.label))) >= 0 ||
+                (i = lineLower.indexOf((block = tags.RESPONSEHEADER.label))) >= 0 ||
+                (i = lineLower.indexOf((block = tags.PARAM.label))) >= 0 ||
+                (i = lineLower.indexOf((block = tags.EXCEPTION.label))) >= 0 ||
+                (i = lineLower.indexOf((block = tags.DEPRECATED.label))) >= 0 ||
+                (i = lineLower.indexOf((block = tags.DESCRIPTION.label))) >= 0 ||
+                (i = lineLower.indexOf((block = tags.GROUP.label))) >= 0 ||
+                (i = lineLower.indexOf((block = tags.TAGS.label))) >= 0 ||
+                (i = lineLower.indexOf((block = tags.GROUP_CONTENT.label))) >= 0 ||
+                (i = lineLower.indexOf((block = tags.EXAMPLE.label))) >= 0 ||
+                (i = lineLower.indexOf((block = tags.APIPATH.label))) >= 0 ||
+                (i = lineLower.indexOf((block = tags.APIMETHOD.label))) >= 0) {
+                line = line.substring(i + block.length);
+                currBlock = block;
+                newBlock = true;
+            }
+            // get everything after opening '*'s
+            line = line.replace(/\s*\/?\*+/, '');
+            // replace docblock break marker and indicate we should break after
+            // this round. Otherwise we may get some strange behavior due to
+            // multi-line support and this common parser for all models
+            if (line.includes(settings_1.default.DOC_BLOCK_BREAK)) {
+                line = line.replace(settings_1.default.DOC_BLOCK_BREAK, '');
+                isBreak = true;
+            }
+            // add line to appropriate block...
+            // if currBlock was not reset on this iteration we're on the next line of the last tag, add line
+            // to that value. Allow empty lines in @example blocks to preserve whitespace in complex examples
+            if (currBlock !== null && (line.trim() || (!line.trim() && currBlock === tags.EXAMPLE.label) || line.trim())) {
+                if (currBlock === tags.AUTHOR.label) {
+                    this._author += (this._author ? ' ' : '') + line.trim();
+                }
+                else if (currBlock === tags.SINCE.label) {
+                    this._since += (this._since ? ' ' : '') + line.trim();
+                }
+                else if (currBlock === tags.SEE.label) {
+                    this._see.push(line.trim());
+                }
+                else if (currBlock === tags.RETURNS.label || currBlock === tags.RETURN.label) {
+                    this._returns += (this._returns ? ' ' : '') + line.trim();
+                }
+                else if (currBlock === tags.REQUESTHEADER.label) {
+                    const p = newBlock ? '' : this._requestheaders.pop();
+                    this._requestheaders.push(p + (p && p.length > 0 ? ' ' : '') + line.trim());
+                }
+                else if (currBlock === tags.RESPONSEHEADER.label) {
+                    const p = newBlock ? '' : this._responseheaders.pop();
+                    this._responseheaders.push(p + (p && p.length > 0 ? ' ' : '') + line.trim());
+                }
+                else if (currBlock === tags.QUERYPARAM.label) {
+                    const p = newBlock ? '' : this._queryparams.pop();
+                    this._queryparams.push(p + (p && p.length > 0 ? ' ' : '') + line.trim());
+                }
+                else if (currBlock === tags.PARAM.label) {
+                    const p = newBlock ? '' : this._params.pop();
+                    this._params.push(p + (p && p.length > 0 ? ' ' : '') + line.trim());
+                }
+                else if (currBlock === tags.EXCEPTION.label) {
+                    const p = newBlock ? '' : this._exception.pop();
+                    this._exception.push(p + (p && p.length > 0 ? ' ' : '') + line.trim());
+                }
+                else if (currBlock === tags.DEPRECATED.label) {
+                    this._deprecated += (this._deprecated ? ' ' : '') + line.trim();
+                }
+                else if (currBlock === tags.DESCRIPTION.label) {
+                    this._description += (this._description ? ' ' : '') + line.trim();
+                }
+                else if (currBlock === tags.EXAMPLE.label) {
+                    this._example += (this._example ? ' \n' : '') + line;
+                }
+                else if (currBlock === tags.APIPATH.label) {
+                    this._apipath += (this._apipath ? ' \n' : '') + line;
+                }
+                else if (currBlock === tags.APIMETHOD.label) {
+                    this._apimethod += (this._apimethod ? ' \n' : '') + line;
+                }
+                // These tags only support a single line if a duplicate
+                // tag is encountered, override any existing value.
+                else if (currBlock === tags.GROUP.label) {
+                    this._groupName = line.trim();
+                }
+                else if (currBlock === tags.TAGS.label) {
+                    this._tags = line.trim();
+                }
+            }
+            // not a recognized tag, assume we're in un-tagged _description
+            else if (currBlock === null && line.trim()) {
+                currBlock = block = tags.DESCRIPTION.label;
+                this._description += (this._description ? ' ' : '') + line.trim();
+            }
+            else if (!line.trim()) {
+                currBlock = null;
+            }
+            if (isBreak) {
+                break;
+            }
+        }
+    }
+    parseAnnotations(line, previousLine) {
+        if (previousLine) {
+            previousLine = previousLine.trim();
+            // if previous line is not a comment line it may contain annotations.
+            if (!previousLine.startsWith('*') && /.*(@\w+\s*(\([\w=.*''/\s]+\))?)$/.test(previousLine)) {
+                line = previousLine + ' ' + line;
+            }
+        }
+        const matches = line.match(/@\w+\s*(\([\w=.*''/\s]+\))?/g);
+        if (matches !== null) {
+            matches.forEach(match => {
+                if (match) {
+                    const line = match.trim();
+                    this.annotations.push(line);
+                    if (match.trim().includes('RestResource')) {
+                        const regex = /(?<=@RestResource\(urlMapping\=\')(.*)(?=\/\*\')/;
+                        const urlmatches = regex.exec(match);
+                        if (urlmatches) {
+                            this._restUrl = urlmatches[0];
+                        }
+                    }
+                }
+            });
+        }
+    }
+    parseScope() {
+        if (this._nameLine) {
+            const _scope = utils_1.default.getScope(this._nameLine);
+            if (_scope) {
+                this._scope = _scope;
+            }
+            else {
+                // _scope is implicitly private
+                this._scope = 'private';
+            }
+        }
+    }
+    setNameLine(_nameLine, _lineNum) {
+        // strip any _annotations from the signature line
+        // we'll capture those and display them separately
+        this._nameLine = utils_1.default.stripAnnotations(_nameLine).trim();
+        this._lineNum = _lineNum;
+        this.parseScope();
+    }
+}
+exports.ApexModel = ApexModel;
+//# sourceMappingURL=apex-model.js.map

package/lib/apexdoc/common/models/apex-model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"apex-model.js","sourceRoot":"","sources":["../../../../src/apexdoc/common/models/apex-model.ts"],"names":[],"mappings":";;;;AAAA;;IAEI;AACJ,sDAAgC;AAChC,6DAA6B;AAE7B,mEAAmC;AACnC,sCAAsC;AACtC,MAAe,SAAS;IA0BtB,YAAsB,QAAkB,EAAE,SAAyB;QAzBzD,iBAAY,GAAa,EAAE,CAAC;QAC5B,YAAO,GAAG,EAAE,CAAC;QACb,gBAAW,GAAG,EAAE,CAAC;QACjB,iBAAY,GAAG,EAAE,CAAC;QAClB,aAAQ,GAAG,EAAE,CAAC;QACd,aAAQ,GAAG,EAAE,CAAC;QACd,aAAQ,GAAG,EAAE,CAAC;QACd,eAAU,GAAG,EAAE,CAAC;QAChB,eAAU,GAAa,EAAE,CAAC;QAC1B,sBAAiB,GAAG,EAAE,CAAC;QACvB,eAAU,GAAG,EAAE,CAAC;QAChB,UAAK,GAAG,EAAE,CAAC;QACX,aAAQ,GAAG,CAAC,CAAC;QACb,cAAS,GAAG,EAAE,CAAC;QACf,YAAO,GAAa,EAAE,CAAC;QACvB,iBAAY,GAAa,EAAE,CAAC;QAC5B,oBAAe,GAAa,EAAE,CAAC;QAC/B,qBAAgB,GAAa,EAAE,CAAC;QAChC,aAAQ,GAAG,EAAE,CAAC;QACd,WAAM,GAAG,EAAE,CAAC;QACZ,SAAI,GAAa,EAAE,CAAC;QACpB,WAAM,GAAG,EAAE,CAAC;QAEZ,YAAO,GAAG,EAAE,CAAC;QAGrB,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QAC7B,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAC9B,CAAC;IAID,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAEM,SAAS,CAAC,MAAc;QAC7B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED;;;;;;;;OAQG;IACH,IAAW,OAAO;QAChB,mDAAmD;QACnD,oDAAoD;QACpD,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC;IACnC,CAAC;IAED,IAAW,OAAO;QAChB,mDAAmD;QACnD,oDAAoD;QACpD,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC,QAAQ,EAAE,CAAC;IAC9C,CAAC;IAED,IAAW,OAAO;QAChB,mDAAmD;QACnD,oDAAoD;QACpD,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC,QAAQ,EAAE,CAAC;IAC9C,CAAC;IAED,IAAW,SAAS;QAClB,mDAAmD;QACnD,oDAAoD;QACpD,OAAO,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,CAAC,QAAQ,EAAE,CAAC;IAChD,CAAC;IAED,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,IAAW,GAAG;QACZ,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED;;OAEG;IACK,aAAa,CAAC,QAAkB;QACtC,IAAI,SAAS,GAAyB,IAAI,CAAC;QAC3C,IAAI,KAAK,GAAyB,IAAI,CAAC;QAEvC,KAAK,IAAI,IAAI,IAAI,QAAQ,EAAE;YACzB,IAAI,QAAQ,GAAG,KAAK,EAClB,OAAO,GAAG,KAAK,CAAC;YAClB,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;YACrC,IAAI,CAAS,CAAC;YAEd,6DAA6D;YAC7D,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,KAAK,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,IAAI,EAAE;gBACjD,SAAS;aACV;YAED,sCAAsC;YACtC,IACE,CAAC,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;gBACzD,CAAC,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;gBACxD,CAAC,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;gBACtD,CAAC,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;gBACzD,CAAC,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;gBAC1D,CAAC,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;gBAC7D,CAAC,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;gBAChE,CAAC,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;gBACjE,CAAC,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;gBACxD,CAAC,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;gBAC5D,CAAC,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;gBAC7D,CAAC,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;gBAC9D,CAAC,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;gBACxD,CAAC,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;gBACvD,CAAC,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;gBAChE,CAAC,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;gBAC1D,CAAC,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;gBAC1D,CAAC,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,EAC5D;gBACA,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;gBACxC,SAAS,GAAG,KAAK,CAAC;gBAClB,QAAQ,GAAG,IAAI,CAAC;aACjB;YAED,oCAAoC;YACpC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;YAErC,mEAAmE;YACnE,gEAAgE;YAChE,2DAA2D;YAC3D,IAAI,IAAI,CAAC,QAAQ,CAAC,kBAAQ,CAAC,eAAe,CAAC,EAAE;gBAC3C,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,kBAAQ,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;gBAClD,OAAO,GAAG,IAAI,CAAC;aAChB;YAED,mCAAmC;YACnC,gGAAgG;YAChG,iGAAiG;YACjG,IAAI,SAAS,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,SAAS,KAAK,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE;gBAC5G,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE;oBACnC,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;iBACzD;qBAAM,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE;oBACzC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;iBACvD;qBAAM,IAAI,SAAS,KAAK,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE;oBACvC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;iBAC7B;qBAAM,IAAI,SAAS,KAAK,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE;oBAC9E,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;iBAC3D;qBAAM,IAAI,SAAS,KAAK,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE;oBACjD,MAAM,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,EAAE,CAAC;oBACrD,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;iBAC7E;qBAAM,IAAI,SAAS,KAAK,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE;oBAClD,MAAM,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,CAAC;oBACtD,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;iBAC9E;qBAAM,IAAI,SAAS,KAAK,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE;oBAC9C,MAAM,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC;oBAClD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;iBAC1E;qBAAM,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE;oBACzC,MAAM,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;oBAC7C,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;iBACrE;qBAAM,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE;oBAC7C,MAAM,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC;oBAChD,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;iBACxE;qBAAM,IAAI,SAAS,KAAK,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE;oBAC9C,IAAI,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;iBACjE;qBAAM,IAAI,SAAS,KAAK,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE;oBAC/C,IAAI,CAAC,YAAY,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;iBACnE;qBAAM,IAAI,SAAS,KAAK,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE;oBAC3C,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC;iBACtD;qBAAM,IAAI,SAAS,KAAK,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE;oBAC3C,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC;iBACtD;qBAAM,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE;oBAC7C,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC;iBAC1D;gBACD,uDAAuD;gBACvD,mDAAmD;qBAC9C,IAAI,SAAS,KAAK,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE;oBACvC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;iBAC/B;qBAAM,IAAI,SAAS,KAAK,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;oBACxC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;iBAC1B;aACF;YACD,+DAA+D;iBAC1D,IAAI,SAAS,KAAK,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE,EAAE;gBAC1C,SAAS,GAAG,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC;gBAC3C,IAAI,CAAC,YAAY,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;aACnE;iBAAM,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE;gBACvB,SAAS,GAAG,IAAI,CAAC;aAClB;YAED,IAAI,OAAO,EAAE;gBACX,MAAM;aACP;SACF;IACH,CAAC;IAEM,gBAAgB,CAAC,IAAY,EAAE,YAAkC;QACtE,IAAI,YAAY,EAAE;YAChB,YAAY,GAAG,YAAY,CAAC,IAAI,EAAE,CAAC;YACnC,qEAAqE;YACrE,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,kCAAkC,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE;gBAC1F,IAAI,GAAG,YAAY,GAAG,GAAG,GAAG,IAAI,CAAC;aAClC;SACF;QAED,MAAM,OAAO,GAAmC,IAAI,CAAC,KAAK,CAAC,8BAA8B,CAAC,CAAC;QAE3F,IAAI,OAAO,KAAK,IAAI,EAAE;YACpB,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;gBACtB,IAAI,KAAK,EAAE;oBACT,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;oBAC1B,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;oBAC5B,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE;wBACzC,MAAM,KAAK,GAAG,kDAAkD,CAAC;wBACjE,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;wBACrC,IAAI,UAAU,EAAE;4BACd,IAAI,CAAC,QAAQ,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;yBAC/B;qBACF;iBACF;YACH,CAAC,CAAC,CAAC;SACJ;IACH,CAAC;IAES,UAAU;QAClB,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,MAAM,MAAM,GAAG,eAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC9C,IAAI,MAAM,EAAE;gBACV,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;aACtB;iBAAM;gBACL,+BAA+B;gBAC/B,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;aACzB;SACF;IACH,CAAC;IAES,WAAW,CAAC,SAAiB,EAAE,QAAgB;QACvD,iDAAiD;QACjD,kDAAkD;QAClD,IAAI,CAAC,SAAS,GAAG,eAAK,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,CAAC;QAC1D,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAEzB,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC;CACF;AAEQ,8BAAS"}

package/lib/apexdoc/common/models/class-group.d.ts

@@ -0,0 +1,10 @@
+declare class ClassGroup {
+    private _name;
+    private _contentSource;
+    constructor(name: string, contentSource: string);
+    get name(): string;
+    get contentSource(): string;
+    set contentSource(contentSource: string);
+    get contentFileName(): string;
+}
+export { ClassGroup };

package/lib/apexdoc/common/models/class-group.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClassGroup = void 0;
+/**
+ * Copyright (c) NCR Terafina
+ **/
+const path_1 = require("path");
+class ClassGroup {
+    constructor(name, contentSource) {
+        this._name = name;
+        this._contentSource = contentSource;
+    }
+    get name() {
+        return this._name;
+    }
+    get contentSource() {
+        return this._contentSource;
+    }
+    set contentSource(contentSource) {
+        this._contentSource = contentSource;
+    }
+    get contentFileName() {
+        if (this._contentSource) {
+            const fileName = path_1.basename(this._contentSource);
+            const idx = fileName.lastIndexOf('.');
+            return fileName.substring(0, idx);
+        }
+        return '';
+    }
+}
+exports.ClassGroup = ClassGroup;
+//# sourceMappingURL=class-group.js.map

package/lib/apexdoc/common/models/class-group.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"class-group.js","sourceRoot":"","sources":["../../../../src/apexdoc/common/models/class-group.ts"],"names":[],"mappings":";;;AAAA;;IAEI;AACJ,+BAAgC;AAEhC,MAAM,UAAU;IAIZ,YAAmB,IAAY,EAAE,aAAqB;QAClD,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;IACxC,CAAC;IAED,IAAW,IAAI;QACX,OAAO,IAAI,CAAC,KAAK,CAAC;IACtB,CAAC;IAGD,IAAW,aAAa;QACpB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC/B,CAAC;IAED,IAAW,aAAa,CAAC,aAAqB;QAC1C,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;IACxC,CAAC;IAED,IAAW,eAAe;QACtB,IAAI,IAAI,CAAC,cAAc,EAAE;YACrB,MAAM,QAAQ,GAAG,eAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YAC/C,MAAM,GAAG,GAAG,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;YACtC,OAAO,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;SACrC;QAED,OAAO,EAAE,CAAC;IACd,CAAC;CACJ;AAEQ,gCAAU"}

package/lib/apexdoc/common/models/class-model.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Copyright (c) NCR Terafina
+ **/
+import { EnumModel } from './enum-model';
+import { MethodModel } from './method-model';
+import { TopLevelModel } from './top-level-model';
+import { IDTODefinition, IRestPath, IRestTags, Option } from '../..';
+import { PropertyModel } from './property-model';
+declare class ClassModel extends TopLevelModel {
+    private _childClassMap;
+    private _cModelParent?;
+    private _enums;
+    private _isInterface;
+    private _methods;
+    private _properties;
+    constructor(cModelParent: Option<ClassModel>, comments: string[], nameLine: string, lineNum: number, sourceUrl: Option<string>);
+    addChildClass(child: ClassModel): void;
+    get childClasses(): Array<ClassModel>;
+    get childClassesSorted(): Array<ClassModel>;
+    get childClassMap(): Map<string, ClassModel>;
+    get enums(): Array<EnumModel>;
+    get enumsSorted(): Array<EnumModel>;
+    get groupName(): string;
+    get tags(): IRestTags;
+    get isInterface(): boolean;
+    get isDTO(): boolean;
+    get methods(): Array<MethodModel>;
+    get restDefinition(): IRestPath[];
+    get dtoDefinition(): IDTODefinition;
+    get methodsSorted(): Array<MethodModel>;
+    get name(): string;
+    get properties(): Array<PropertyModel>;
+    get propertiesSorted(): Array<PropertyModel>;
+    get topMostClassName(): string;
+    private setIsInterface;
+    get isInnerClass(): boolean;
+}
+export { ClassModel };

package/lib/apexdoc/common/models/class-model.js

@@ -0,0 +1,216 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClassModel = void 0;
+const tslib_1 = require("tslib");
+const top_level_model_1 = require("./top-level-model");
+const settings_1 = tslib_1.__importDefault(require("../settings"));
+class ClassModel extends top_level_model_1.TopLevelModel {
+    constructor(cModelParent, comments, nameLine, lineNum, sourceUrl) {
+        super(comments, top_level_model_1.ModelType.CLASS, sourceUrl);
+        this._isInterface = false;
+        super.setNameLine(nameLine, lineNum);
+        this.setIsInterface(nameLine);
+        this._childClassMap = new Map();
+        this._cModelParent = cModelParent;
+        this._properties = [];
+        this._methods = [];
+        this._enums = [];
+    }
+    addChildClass(child) {
+        this._childClassMap.set(child.name.toLowerCase(), child);
+    }
+    get childClasses() {
+        return Array.from(this._childClassMap.values());
+    }
+    get childClassesSorted() {
+        return this.childClasses.sort((a, b) => a.name.localeCompare(b.name));
+    }
+    get childClassMap() {
+        return this._childClassMap;
+    }
+    get enums() {
+        return this._enums;
+    }
+    get enumsSorted() {
+        const sorted = [...this._enums];
+        sorted.sort((a, b) => a.name.localeCompare(b.name));
+        return sorted;
+    }
+    get groupName() {
+        let group;
+        if (this._cModelParent) {
+            group = this._cModelParent.groupName;
+        }
+        else {
+            group = this._groupName;
+        }
+        return group;
+    }
+    get tags() {
+        const tagarr = this._tags.split(' ');
+        let category = 'General';
+        if (tagarr.length > 1) {
+            category = tagarr[1];
+        }
+        const tags = { name: tagarr[0], description: this.description, category: category };
+        return tags;
+    }
+    get isInterface() {
+        return this._isInterface;
+    }
+    get isDTO() {
+        return (!this._isInterface &&
+            (this._nameLine.includes('DTO') || this._nameLine.includes('AbstractDTO')) &&
+            this._properties &&
+            this._properties.length > 0);
+    }
+    get methods() {
+        // interface methods do not have access modifiers.
+        // ensure that they take the scope of their defining
+        // type and are not treated as private which is the
+        // default for methods w/o access mods
+        if (this._isInterface) {
+            for (const method of this._methods) {
+                method.scope = this._scope;
+            }
+        }
+        return this._methods;
+    }
+    get restDefinition() {
+        const definitions = [];
+        if (this.restUrl) {
+            for (const method of this._methods) {
+                if (method.apimethod && method.apipath) {
+                    const pathparams = method.params.filter(v => v.pathParam);
+                    const requestBody = method.params.filter(v => !v.pathParam);
+                    pathparams.forEach(function (v) {
+                        delete v.pathParam;
+                    });
+                    requestBody.forEach(function (v) {
+                        delete v.pathParam;
+                    });
+                    if (requestBody && requestBody.length > 0 && method.example) {
+                        requestBody[0].example = method.example;
+                    }
+                    const definition = {
+                        path: this.restUrl + method.apipath,
+                        operationId: method.name,
+                        description: method.description,
+                        method: method.apimethod,
+                        exceptions: method.exception,
+                        params: pathparams,
+                        requestBody: requestBody,
+                        queryparams: method.queryparams,
+                        requestheaders: method.requestheaders,
+                        responseheaders: method.responseheaders,
+                        responses: method.returns,
+                        tags: this.tags
+                    };
+                    definitions.push(definition);
+                }
+            }
+        }
+        return definitions;
+    }
+    get dtoDefinition() {
+        const definition = {};
+        if (this._properties) {
+            definition.description = this.description;
+            definition.type = 'object';
+            const props = {};
+            for (const property of this._properties) {
+                if (property.type.includes('transient')) {
+                    continue;
+                }
+                const prop = { description: property.description, type: property.type };
+                props[property.name] = prop;
+            }
+            definition.properties = props;
+        }
+        return definition;
+    }
+    get methodsSorted() {
+        const sorted = [...this._methods];
+        sorted.sort((a, b) => {
+            const nameA = a.name;
+            const nameB = b.name;
+            const className = this.name;
+            if (nameA && nameA === className) {
+                return -1;
+            }
+            else if (nameB && nameB === className) {
+                return 1;
+            }
+            return nameA.localeCompare(nameB);
+        });
+        // replace overloaded methods with their 'logical' order methods
+        // to ensure overload selectors work as expected. e.g. overloaded
+        // methods, once sorted, will appear in the order they appear in
+        // in the class's source file.
+        const methodsCopy = [...this._methods];
+        sorted.forEach((method, i, arr) => {
+            const matchingMethodIdx = methodsCopy.findIndex(m => m.name === method.name);
+            arr[i] = methodsCopy[matchingMethodIdx];
+            methodsCopy.splice(matchingMethodIdx, 1);
+        });
+        return sorted;
+    }
+    get name() {
+        let nameLine = this.nameLine;
+        const parent = !this._cModelParent ? '' : this._cModelParent.name + '.';
+        if (nameLine) {
+            nameLine = nameLine.trim();
+        }
+        if (nameLine && nameLine.length > 0) {
+            let keywordAt = nameLine.toLowerCase().indexOf(settings_1.default.CLASS + ' ');
+            let offset = 6;
+            if (keywordAt === -1) {
+                keywordAt = nameLine.toLowerCase().indexOf(settings_1.default.INTERFACE + ' ');
+                offset = 10;
+            }
+            if (keywordAt > -1) {
+                nameLine = nameLine.substring(keywordAt + offset).trim();
+            }
+            const spaceAt = nameLine.indexOf(' ');
+            if (spaceAt === -1) {
+                return parent + nameLine;
+            }
+            try {
+                const name = nameLine.substring(0, spaceAt);
+                return (parent + name).trim();
+            }
+            catch (ex) {
+                return (parent + nameLine.substring(nameLine.lastIndexOf(' ') + 1)).trim();
+            }
+        }
+        else {
+            return '';
+        }
+    }
+    get properties() {
+        return this._properties;
+    }
+    get propertiesSorted() {
+        const sorted = [...this._properties];
+        sorted.sort((a, b) => a.name.localeCompare(b.name));
+        return sorted;
+    }
+    get topMostClassName() {
+        if (this._cModelParent) {
+            return this._cModelParent.name;
+        }
+        else {
+            return this.name;
+        }
+    }
+    setIsInterface(nameLine) {
+        if (/\s?\binterface\s/i.test(nameLine.toLowerCase())) {
+            this._isInterface = true;
+        }
+    }
+    get isInnerClass() {
+        return !!this._cModelParent;
+    }
+}
+exports.ClassModel = ClassModel;
+//# sourceMappingURL=class-model.js.map

package/lib/apexdoc/common/models/class-model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"class-model.js","sourceRoot":"","sources":["../../../../src/apexdoc/common/models/class-model.ts"],"names":[],"mappings":";;;;AAKA,uDAA6D;AAG7D,mEAAmC;AAEnC,MAAM,UAAW,SAAQ,+BAAa;IAQpC,YAAmB,YAAgC,EAAE,QAAkB,EAAE,QAAgB,EAAE,OAAe,EAAE,SAAyB;QACnI,KAAK,CAAC,QAAQ,EAAE,2BAAS,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QALtC,iBAAY,GAAG,KAAK,CAAC;QAM3B,KAAK,CAAC,WAAW,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAErC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAC9B,IAAI,CAAC,cAAc,GAAG,IAAI,GAAG,EAAsB,CAAC;QACpD,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;QAClC,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;QACtB,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;IACnB,CAAC;IAEM,aAAa,CAAC,KAAiB;QACpC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,KAAK,CAAC,CAAC;IAC3D,CAAC;IAED,IAAW,YAAY;QACrB,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,CAAC;IAClD,CAAC;IAED,IAAW,kBAAkB;QAC3B,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IACxE,CAAC;IAED,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAW,WAAW;QACpB,MAAM,MAAM,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;QAChC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QACpD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,IAAW,SAAS;QAClB,IAAI,KAAa,CAAC;QAClB,IAAI,IAAI,CAAC,aAAa,EAAE;YACtB,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC;SACtC;aAAM;YACL,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC;SACzB;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAW,IAAI;QACb,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACrC,IAAI,QAAQ,GAAG,SAAS,CAAC;QACzB,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;YACrB,QAAQ,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;SACtB;QACD,MAAM,IAAI,GAAc,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC;QAC/F,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED,IAAW,KAAK;QACd,OAAO,CACL,CAAC,IAAI,CAAC,YAAY;YAClB,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;YAC1E,IAAI,CAAC,WAAW;YAChB,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,CAC5B,CAAC;IACJ,CAAC;IAED,IAAW,OAAO;QAChB,kDAAkD;QAClD,oDAAoD;QACpD,mDAAmD;QACnD,sCAAsC;QACtC,IAAI,IAAI,CAAC,YAAY,EAAE;YACrB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,QAAQ,EAAE;gBAClC,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC;aAC5B;SACF;QAED,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,IAAW,cAAc;QACvB,MAAM,WAAW,GAAgB,EAAE,CAAC;QACpC,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,QAAQ,EAAE;gBAClC,IAAI,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,OAAO,EAAE;oBACtC,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;oBAC1D,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;oBAE5D,UAAU,CAAC,OAAO,CAAC,UAAU,CAAC;wBAC5B,OAAO,CAAC,CAAC,SAAS,CAAC;oBACrB,CAAC,CAAC,CAAC;oBAEH,WAAW,CAAC,OAAO,CAAC,UAAU,CAAC;wBAC7B,OAAO,CAAC,CAAC,SAAS,CAAC;oBACrB,CAAC,CAAC,CAAC;oBACH,IAAI,WAAW,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,EAAE;wBAC3D,WAAW,CAAC,CAAC,CAAC,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;qBACzC;oBACD,MAAM,UAAU,GAAc;wBAC5B,IAAI,EAAE,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO;wBACnC,WAAW,EAAE,MAAM,CAAC,IAAI;wBACxB,WAAW,EAAE,MAAM,CAAC,WAAW;wBAC/B,MAAM,EAAE,MAAM,CAAC,SAAS;wBACxB,UAAU,EAAE,MAAM,CAAC,SAAS;wBAC5B,MAAM,EAAE,UAAU;wBAClB,WAAW,EAAE,WAAW;wBACxB,WAAW,EAAE,MAAM,CAAC,WAAW;wBAC/B,cAAc,EAAE,MAAM,CAAC,cAAc;wBACrC,eAAe,EAAE,MAAM,CAAC,eAAe;wBACvC,SAAS,EAAE,MAAM,CAAC,OAAO;wBACzB,IAAI,EAAE,IAAI,CAAC,IAAI;qBAChB,CAAC;oBACF,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;iBAC9B;aACF;SACF;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,IAAW,aAAa;QACtB,MAAM,UAAU,GAAmB,EAAE,CAAC;QACtC,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,UAAU,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;YAC1C,UAAU,CAAC,IAAI,GAAG,QAAQ,CAAC;YAC3B,MAAM,KAAK,GAAY,EAAE,CAAC;YAC1B,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,WAAW,EAAE;gBACvC,IAAI,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE;oBACvC,SAAS;iBACV;gBACD,MAAM,IAAI,GAAc,EAAE,WAAW,EAAE,QAAQ,CAAC,WAAW,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC;gBACnF,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;aAC7B;YACD,UAAU,CAAC,UAAU,GAAG,KAAK,CAAC;SAC/B;QACD,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,IAAW,aAAa;QACtB,MAAM,MAAM,GAAG,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;QAClC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;YACnB,MAAM,KAAK,GAAG,CAAC,CAAC,IAAI,CAAC;YACrB,MAAM,KAAK,GAAG,CAAC,CAAC,IAAI,CAAC;YACrB,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC;YAE5B,IAAI,KAAK,IAAI,KAAK,KAAK,SAAS,EAAE;gBAChC,OAAO,CAAC,CAAC,CAAC;aACX;iBAAM,IAAI,KAAK,IAAI,KAAK,KAAK,SAAS,EAAE;gBACvC,OAAO,CAAC,CAAC;aACV;YAED,OAAO,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QACpC,CAAC,CAAC,CAAC;QAEH,gEAAgE;QAChE,iEAAiE;QACjE,gEAAgE;QAChE,8BAA8B;QAC9B,MAAM,WAAW,GAAG,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,GAAG,EAAE,EAAE;YAChC,MAAM,iBAAiB,GAAG,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,IAAI,CAAC,CAAC;YAC7E,GAAG,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,iBAAiB,CAAC,CAAC;YACxC,WAAW,CAAC,MAAM,CAAC,iBAAiB,EAAE,CAAC,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,IAAW,IAAI;QACb,IAAI,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC7B,MAAM,MAAM,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,GAAG,GAAG,CAAC;QAExE,IAAI,QAAQ,EAAE;YACZ,QAAQ,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;SAC5B;QAED,IAAI,QAAQ,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;YACnC,IAAI,SAAS,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,kBAAQ,CAAC,KAAK,GAAG,GAAG,CAAC,CAAC;YACrE,IAAI,MAAM,GAAG,CAAC,CAAC;YAEf,IAAI,SAAS,KAAK,CAAC,CAAC,EAAE;gBACpB,SAAS,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,kBAAQ,CAAC,SAAS,GAAG,GAAG,CAAC,CAAC;gBACrE,MAAM,GAAG,EAAE,CAAC;aACb;YAED,IAAI,SAAS,GAAG,CAAC,CAAC,EAAE;gBAClB,QAAQ,GAAG,QAAQ,CAAC,SAAS,CAAC,SAAS,GAAG,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC;aAC1D;YAED,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YACtC,IAAI,OAAO,KAAK,CAAC,CAAC,EAAE;gBAClB,OAAO,MAAM,GAAG,QAAQ,CAAC;aAC1B;YAED,IAAI;gBACF,MAAM,IAAI,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;gBAC5C,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;aAC/B;YAAC,OAAO,EAAE,EAAE;gBACX,OAAO,CAAC,MAAM,GAAG,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;aAC5E;SACF;aAAM;YACL,OAAO,EAAE,CAAC;SACX;IACH,CAAC;IAED,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,IAAW,gBAAgB;QACzB,MAAM,MAAM,GAAG,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC;QACrC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QACpD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,IAAW,gBAAgB;QACzB,IAAI,IAAI,CAAC,aAAa,EAAE;YACtB,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC;SAChC;aAAM;YACL,OAAO,IAAI,CAAC,IAAI,CAAC;SAClB;IACH,CAAC;IAEO,cAAc,CAAC,QAAgB;QACrC,IAAI,mBAAmB,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,EAAE;YACpD,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;SAC1B;IACH,CAAC;IAED,IAAW,YAAY;QACrB,OAAO,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC;IAC9B,CAAC;CACF;AAEQ,gCAAU"}

package/lib/apexdoc/common/models/engine-config.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Copyright (c) NCR Terafina
+ **/
+import { IEngineConfig } from '../..';
+declare class EngineConfig implements IEngineConfig {
+    source: any[];
+    targetDirectory: string;
+    includes: any[];
+    excludes: any[];
+    homePagePath: string;
+    scope: string[];
+    title: string;
+    subtitle: string;
+    showTOCSnippets: boolean;
+    sortOrder: string;
+    cleanDir: boolean;
+    assets: any[];
+    pages: any[];
+    port: number;
+}
+export default EngineConfig;

package/lib/apexdoc/common/models/engine-config.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class EngineConfig {
+    constructor() {
+        this.source = [];
+        this.targetDirectory = '';
+        this.includes = [];
+        this.excludes = [];
+        this.homePagePath = '';
+        this.scope = [
+            'global',
+            'public',
+            'protected',
+            'private',
+            'testMethod',
+            'webService'
+        ];
+        this.title = 'Apex Documentation';
+        this.subtitle = `Generated by Terafina`;
+        this.showTOCSnippets = true;
+        this.sortOrder = 'alpha';
+        this.cleanDir = false;
+        this.assets = [];
+        this.pages = [];
+        this.port = 8080;
+    }
+}
+exports.default = EngineConfig;
+//# sourceMappingURL=engine-config.js.map

package/lib/apexdoc/common/models/engine-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"engine-config.js","sourceRoot":"","sources":["../../../../src/apexdoc/common/models/engine-config.ts"],"names":[],"mappings":";;AAMA,MAAM,YAAY;IAAlB;QACW,WAAM,GAAG,EAAE,CAAC;QACf,oBAAe,GAAG,EAAE,CAAC;QACrB,aAAQ,GAAG,EAAE,CAAC;QACd,aAAQ,GAAG,EAAE,CAAC;QACd,iBAAY,GAAG,EAAE,CAAC;QAClB,UAAK,GAAG;YACR,QAAQ;YACR,QAAQ;YACR,WAAW;YACX,SAAS;YACT,YAAY;YACZ,YAAY;SACf,CAAC;QACE,UAAK,GAAG,oBAAoB,CAAC;QAC7B,aAAQ,GAAG,uBAAuB,CAAC;QACnC,oBAAe,GAAG,IAAI,CAAC;QACvB,cAAS,GAAG,OAAO,CAAC;QACjB,aAAQ,GAAG,KAAK,CAAC;QACjB,WAAM,GAAG,EAAE,CAAC;QACZ,UAAK,GAAG,EAAE,CAAC;QACX,SAAI,GAAG,IAAI,CAAC;IACvB,CAAC;CAAA;AAED,kBAAe,YAAY,CAAC"}