@cparra/apexdocs 2.5.0 → 2.6.0-alpha.0

package/docs/README.md

@@ -10,7 +10,7 @@ Uses a block style apex doc
 This is a class description. This class relates to [SampleInterface](/Sample-Interfaces/SampleInterface.md)              But this [ClassThatDoesNotExist](ClassThatDoesNotExist) does not exist.              You can also link using this syntax [SampleInterface](/Sample-Interfaces/SampleInterface.md)
 ## Miscellaneous
 
-### [SampleClassWithoutModifier](/API/SampleClassWithoutModifier.md)
+### [SampleClassWithoutModifier](/Miscellaneous/SampleClassWithoutModifier.md)
 
 
 ## Sample Interfaces

package/docs/ts/GroupedClass.d.ts

@@ -0,0 +1,3 @@
+/**
+ * @typedef {Object} GroupedClass Uses a block style apex doc
+ */

package/docs/ts/SampleClass.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @typedef {Object} SampleClass This is a class description. This class relates to {@link SampleInterface}              But this {@link ClassThatDoesNotExist} does not exist.              You can also link using this syntax <<SampleInterface>>
+ * @property {number} AnotherProp This is a Decimal property.
+ * @property {string} MyProp This is a String property.
+ */
+/**
+ * @typedef {Object} AnotherInnerClass Inner class belonging to SampleClass.
+ */
+/**
+ * @typedef {Object} InnerClass Inner class belonging to SampleClass.
+ */

package/lib/cli/generate.js

@@ -34,8 +34,8 @@ const argv = yargs.options({
         type: 'string',
         alias: 'g',
         default: 'jekyll',
-        choices: ['jekyll', 'docsify', 'plain-markdown'],
-        describe: 'Define the static file generator for which the documents will be created. Currently supports jekyll, docsify, and plain markdown.',
+        choices: ['jekyll', 'docsify', 'plain-markdown', 'ts-def'],
+        describe: 'Define the static file generator for which the documents will be created. Currently supports jekyll, docsify, plain markdown, and Typescript type definitions.',
     },
     indexOnly: {
         type: 'boolean',

package/lib/cli/generate.js.map

@@ -1 +1 @@
-{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../src/cli/generate.ts"],"names":[],"mappings":";;;AACA,+BAA+B;AAE/B,0CAAyD;AACzD,sDAAmD;AAEnD,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC;IACzB,SAAS,EAAE;QACT,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,GAAG;QACV,YAAY,EAAE,IAAI;QAClB,QAAQ,EAAE,+DAA+D;KAC1E;IACD,SAAS,EAAE;QACT,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,SAAS;QAClB,QAAQ,EAAE,kEAAkE;KAC7E;IACD,SAAS,EAAE;QACT,IAAI,EAAE,SAAS;QACf,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,IAAI;QACb,QAAQ,EAAE,kFAAkF;KAC7F;IACD,KAAK,EAAE;QACL,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,CAAC,QAAQ,CAAC;QACnB,QAAQ,EACN,sHAAsH;YACtH,0HAA0H;KAC7H;IACD,eAAe,EAAE;QACf,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,QAAQ;QACjB,OAAO,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,gBAAgB,CAAC;QAChD,QAAQ,EACN,mIAAmI;KACtI;IACD,SAAS,EAAE;QACT,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,KAAK;QACd,QAAQ,EAAE,0DAA0D;KACrE;IACD,gBAAgB,EAAE;QAChB,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,eAAe;QACxB,QAAQ,EAAE,qEAAqE;KAChF;CACF,CAAC,CAAC,IAAI,CAAC;AAER,mBAAQ,CAAC,KAAK,CAAC;IACb,eAAe,EAAE,IAAI,CAAC,SAAS;IAC/B,SAAS,EAAE,IAAI,CAAC,SAAS;IACzB,KAAK,EAAE,IAAI,CAAC,KAAK;IACjB,SAAS,EAAE,IAAI,CAAC,SAAS;IACzB,eAAe,EAAE,IAAI,CAAC,eAAmC;IACzD,SAAS,EAAE,IAAI,CAAC,SAAS;IACzB,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;CACxC,CAAC,CAAC;AAEH,mBAAQ,CAAC,QAAQ,EAAE,CAAC"}
+{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../src/cli/generate.ts"],"names":[],"mappings":";;;AACA,+BAA+B;AAE/B,0CAAyD;AACzD,sDAAmD;AAEnD,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC;IACzB,SAAS,EAAE;QACT,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,GAAG;QACV,YAAY,EAAE,IAAI;QAClB,QAAQ,EAAE,+DAA+D;KAC1E;IACD,SAAS,EAAE;QACT,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,SAAS;QAClB,QAAQ,EAAE,kEAAkE;KAC7E;IACD,SAAS,EAAE;QACT,IAAI,EAAE,SAAS;QACf,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,IAAI;QACb,QAAQ,EAAE,kFAAkF;KAC7F;IACD,KAAK,EAAE;QACL,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,CAAC,QAAQ,CAAC;QACnB,QAAQ,EACN,sHAAsH;YACtH,0HAA0H;KAC7H;IACD,eAAe,EAAE;QACf,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,QAAQ;QACjB,OAAO,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,gBAAgB,EAAE,QAAQ,CAAC;QAC1D,QAAQ,EACN,gKAAgK;KACnK;IACD,SAAS,EAAE;QACT,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,KAAK;QACd,QAAQ,EAAE,0DAA0D;KACrE;IACD,gBAAgB,EAAE;QAChB,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,eAAe;QACxB,QAAQ,EAAE,qEAAqE;KAChF;CACF,CAAC,CAAC,IAAI,CAAC;AAER,mBAAQ,CAAC,KAAK,CAAC;IACb,eAAe,EAAE,IAAI,CAAC,SAAS;IAC/B,SAAS,EAAE,IAAI,CAAC,SAAS;IACzB,KAAK,EAAE,IAAI,CAAC,KAAK;IACjB,SAAS,EAAE,IAAI,CAAC,SAAS;IACzB,eAAe,EAAE,IAAI,CAAC,eAAmC;IACzD,SAAS,EAAE,IAAI,CAAC,SAAS;IACzB,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;CACxC,CAAC,CAAC;AAEH,mBAAQ,CAAC,QAAQ,EAAE,CAAC"}

package/lib/model/ts-definition-file.d.ts

@@ -0,0 +1,26 @@
+import { File } from './file';
+import { WalkerListener } from '../service/walkers/walker';
+import { ClassMirror, ConstructorMirror, EnumMirror, FieldMirror, InterfaceMirror, MethodMirror, PropertyMirror, Type } from '@cparra/apex-reflection';
+export default class TsDefinitionFile extends File implements WalkerListener {
+    fileExtension(): string;
+    constructor(typeMirror: Type);
+    onConstructorDeclaration(className: string, constructors: ConstructorMirror[]): void;
+    onFieldsDeclaration(fields: FieldMirror[]): void;
+    onInnerClassesDeclaration(classes: ClassMirror[]): void;
+    onInnerEnumsDeclaration(enums: EnumMirror[]): void;
+    onInnerInterfacesDeclaration(interfaces: InterfaceMirror[]): void;
+    onMethodsDeclaration(methods: MethodMirror[]): void;
+    onPropertiesDeclaration(properties: PropertyMirror[]): void;
+    onTypeDeclaration(typeMirror: Type): void;
+    private addPropertiesAndFields;
+    private addInnerClasses;
+    addBlankLine(): void;
+    initializeBlock(): void;
+    finalizeBlock(): void;
+    declareType(className: string, docDescription: string): void;
+    declareProperty(propertyType: string, propertyName: string, docDescription: string): void;
+    sanitizeApexPropertyToJavascript(propertyType: string): string;
+    isListProperty(propertyType: string): true | undefined;
+    extractTypeFromList(propertyType: string): string;
+    replaceAll(sourceString: string, strReplace: string, strWith: string): string;
+}

package/lib/model/ts-definition-file.js

@@ -0,0 +1,137 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const file_1 = require("./file");
+const walker_factory_1 = require("../service/walkers/walker-factory");
+class TsDefinitionFile extends file_1.File {
+    fileExtension() {
+        return '.d.ts';
+    }
+    constructor(typeMirror) {
+        super(typeMirror.name, '');
+        const walker = walker_factory_1.WalkerFactory.get(typeMirror);
+        walker.walk(this);
+    }
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    onConstructorDeclaration(className, constructors) { }
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    onFieldsDeclaration(fields) { }
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    onInnerClassesDeclaration(classes) { }
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    onInnerEnumsDeclaration(enums) { }
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    onInnerInterfacesDeclaration(interfaces) { }
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    onMethodsDeclaration(methods) { }
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    onPropertiesDeclaration(properties) { }
+    onTypeDeclaration(typeMirror) {
+        var _a, _b;
+        this.initializeBlock();
+        this.declareType(typeMirror.name, (_b = (_a = typeMirror.docComment) === null || _a === void 0 ? void 0 : _a.description) !== null && _b !== void 0 ? _b : '');
+        this.addPropertiesAndFields(typeMirror);
+        // TODO: Auraenabled method support
+        // TODO: Remember that methods with getX and setX lose the get and set
+        // TODO: Classes that dont have any auraenabled things should be skipped
+        this.finalizeBlock();
+        this.addInnerClasses(typeMirror);
+    }
+    addPropertiesAndFields(typeMirror) {
+        const classModel = typeMirror;
+        if (classModel.properties.length === 0 && classModel.fields.length === 0) {
+            return;
+        }
+        const propertiesAndFields = [...classModel.properties, ...classModel.fields].filter((e) => e.annotations.findIndex((a) => a.name === 'auraenabled') !== -1);
+        propertiesAndFields
+            .sort((propA, propB) => {
+            if (propA.name < propB.name)
+                return -1;
+            if (propA.name > propB.name)
+                return 1;
+            return 0;
+        })
+            .forEach((propertyModel) => {
+            var _a, _b;
+            this.declareProperty(propertyModel.type, propertyModel.name, (_b = (_a = propertyModel.docComment) === null || _a === void 0 ? void 0 : _a.description) !== null && _b !== void 0 ? _b : '');
+        });
+    }
+    addInnerClasses(typeMirror) {
+        const classModel = typeMirror;
+        if (classModel.classes.length > 0) {
+            classModel.classes
+                .sort((classA, classB) => {
+                if (classA.name < classB.name)
+                    return -1;
+                if (classA.name > classB.name)
+                    return 1;
+                return 0;
+            })
+                .forEach((innerClass) => {
+                this.onTypeDeclaration(innerClass);
+            });
+        }
+    }
+    addBlankLine() {
+        this._contents += '\n';
+    }
+    initializeBlock() {
+        this._contents += '/**';
+        this.addBlankLine();
+    }
+    finalizeBlock() {
+        this._contents += ' */';
+        this.addBlankLine();
+    }
+    declareType(className, docDescription) {
+        this._contents += ` * @typedef {Object} ${className} ${docDescription}`;
+        this.addBlankLine();
+    }
+    declareProperty(propertyType, propertyName, docDescription) {
+        let sanitizedType;
+        // First we check if we are dealing with a list
+        if (this.isListProperty(propertyType)) {
+            // If we are then we first extract the type from the list
+            sanitizedType = this.extractTypeFromList(propertyType);
+            // then sanitize it
+            sanitizedType = this.sanitizeApexPropertyToJavascript(sanitizedType);
+            // and then we add brackets ([])
+            sanitizedType = sanitizedType + '[]';
+        }
+        else {
+            sanitizedType = this.sanitizeApexPropertyToJavascript(propertyType);
+        }
+        this._contents += ` * @property {${sanitizedType}} ${propertyName} ${docDescription}`;
+        this.addBlankLine();
+    }
+    sanitizeApexPropertyToJavascript(propertyType) {
+        const lowerPropertyType = propertyType.toLowerCase();
+        if (lowerPropertyType === 'decimal' || lowerPropertyType === 'integer' || lowerPropertyType === 'double') {
+            return 'number';
+        }
+        if (lowerPropertyType === 'boolean' || lowerPropertyType === 'string') {
+            // If it is a built-in type then we return the lower-cased version.
+            return lowerPropertyType;
+        }
+        // Otherwise, we respect casing
+        return propertyType;
+    }
+    isListProperty(propertyType) {
+        const lowerPropertyType = propertyType.toLowerCase();
+        if (lowerPropertyType.includes('<') && lowerPropertyType.includes('list')) {
+            return true;
+        }
+    }
+    extractTypeFromList(propertyType) {
+        const propertyWithoutList = this.replaceAll(propertyType, 'list', '');
+        return propertyWithoutList.replace('list', '').replace('<', '').replace('>', '');
+    }
+    // Case insensitive replace
+    replaceAll(sourceString, strReplace, strWith) {
+        // See http://stackoverflow.com/a/3561711/556609
+        const esc = strReplace.replace(/[-\/\\^$*+?.()|[\]{}]/g, '\\$&');
+        const reg = new RegExp(esc, 'ig');
+        return sourceString.replace(reg, strWith);
+    }
+}
+exports.default = TsDefinitionFile;
+//# sourceMappingURL=ts-definition-file.js.map

package/lib/model/ts-definition-file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ts-definition-file.js","sourceRoot":"","sources":["../../src/model/ts-definition-file.ts"],"names":[],"mappings":";;AAAA,iCAA8B;AAY9B,sEAAkE;AAElE,MAAqB,gBAAiB,SAAQ,WAAI;IAChD,aAAa;QACX,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,YAAY,UAAgB;QAC1B,KAAK,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAC3B,MAAM,MAAM,GAAG,8BAAa,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC7C,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpB,CAAC;IAED,gEAAgE;IAChE,wBAAwB,CAAC,SAAiB,EAAE,YAAiC,IAAS,CAAC;IAEvF,gEAAgE;IAChE,mBAAmB,CAAC,MAAqB,IAAS,CAAC;IAEnD,gEAAgE;IAChE,yBAAyB,CAAC,OAAsB,IAAS,CAAC;IAE1D,gEAAgE;IAChE,uBAAuB,CAAC,KAAmB,IAAS,CAAC;IAErD,gEAAgE;IAChE,4BAA4B,CAAC,UAA6B,IAAS,CAAC;IAEpE,gEAAgE;IAChE,oBAAoB,CAAC,OAAuB,IAAS,CAAC;IAEtD,gEAAgE;IAChE,uBAAuB,CAAC,UAA4B,IAAS,CAAC;IAE9D,iBAAiB,CAAC,UAAgB;;QAChC,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,IAAI,cAAE,UAAU,CAAC,UAAU,0CAAE,WAAW,mCAAI,EAAE,CAAC,CAAC;QAC5E,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC;QACxC,mCAAmC;QACnC,sEAAsE;QACtE,wEAAwE;QACxE,IAAI,CAAC,aAAa,EAAE,CAAC;QACrB,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;IACnC,CAAC;IAEO,sBAAsB,CAAC,UAAgB;QAC7C,MAAM,UAAU,GAAG,UAAyB,CAAC;QAC7C,IAAI,UAAU,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,IAAI,UAAU,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;YACxE,OAAO;SACR;QAED,MAAM,mBAAmB,GAAG,CAAC,GAAG,UAAU,CAAC,UAAU,EAAE,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,MAAM,CACjF,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,aAAa,CAAC,KAAK,CAAC,CAAC,CACvE,CAAC;QAEF,mBAAmB;aAChB,IAAI,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YACrB,IAAI,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI;gBAAE,OAAO,CAAC,CAAC,CAAC;YACvC,IAAI,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI;gBAAE,OAAO,CAAC,CAAC;YACtC,OAAO,CAAC,CAAC;QACX,CAAC,CAAC;aACD,OAAO,CAAC,CAAC,aAAa,EAAE,EAAE;;YACzB,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,IAAI,EAAE,aAAa,CAAC,IAAI,cAAE,aAAa,CAAC,UAAU,0CAAE,WAAW,mCAAI,EAAE,CAAC,CAAC;QAC5G,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,eAAe,CAAC,UAAgB;QACtC,MAAM,UAAU,GAAG,UAAyB,CAAC;QAC7C,IAAI,UAAU,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YACjC,UAAU,CAAC,OAAO;iBACf,IAAI,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE;gBACvB,IAAI,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI;oBAAE,OAAO,CAAC,CAAC,CAAC;gBACzC,IAAI,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI;oBAAE,OAAO,CAAC,CAAC;gBACxC,OAAO,CAAC,CAAC;YACX,CAAC,CAAC;iBACD,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;gBACtB,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;YACrC,CAAC,CAAC,CAAC;SACN;IACH,CAAC;IAED,YAAY;QACV,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC;IACzB,CAAC;IAED,eAAe;QACb,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC;QACxB,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,aAAa;QACX,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC;QACxB,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,WAAW,CAAC,SAAiB,EAAE,cAAsB;QACnD,IAAI,CAAC,SAAS,IAAI,wBAAwB,SAAS,IAAI,cAAc,EAAE,CAAC;QACxE,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,eAAe,CAAC,YAAoB,EAAE,YAAoB,EAAE,cAAsB;QAChF,IAAI,aAAa,CAAC;QAClB,+CAA+C;QAC/C,IAAI,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,EAAE;YACrC,yDAAyD;YACzD,aAAa,GAAG,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;YACvD,mBAAmB;YACnB,aAAa,GAAG,IAAI,CAAC,gCAAgC,CAAC,aAAa,CAAC,CAAC;YACrE,gCAAgC;YAChC,aAAa,GAAG,aAAa,GAAG,IAAI,CAAC;SACtC;aAAM;YACL,aAAa,GAAG,IAAI,CAAC,gCAAgC,CAAC,YAAY,CAAC,CAAC;SACrE;QAED,IAAI,CAAC,SAAS,IAAI,iBAAiB,aAAa,KAAK,YAAY,IAAI,cAAc,EAAE,CAAC;QACtF,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,gCAAgC,CAAC,YAAoB;QACnD,MAAM,iBAAiB,GAAG,YAAY,CAAC,WAAW,EAAE,CAAC;QACrD,IAAI,iBAAiB,KAAK,SAAS,IAAI,iBAAiB,KAAK,SAAS,IAAI,iBAAiB,KAAK,QAAQ,EAAE;YACxG,OAAO,QAAQ,CAAC;SACjB;QAED,IAAI,iBAAiB,KAAK,SAAS,IAAI,iBAAiB,KAAK,QAAQ,EAAE;YACrE,mEAAmE;YACnE,OAAO,iBAAiB,CAAC;SAC1B;QAED,+BAA+B;QAC/B,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,cAAc,CAAC,YAAoB;QACjC,MAAM,iBAAiB,GAAG,YAAY,CAAC,WAAW,EAAE,CAAC;QACrD,IAAI,iBAAiB,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,iBAAiB,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;YACzE,OAAO,IAAI,CAAC;SACb;IACH,CAAC;IAED,mBAAmB,CAAC,YAAoB;QACtC,MAAM,mBAAmB,GAAG,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;QACtE,OAAO,mBAAmB,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IACnF,CAAC;IAED,2BAA2B;IAC3B,UAAU,CAAC,YAAoB,EAAE,UAAkB,EAAE,OAAe;QAClE,gDAAgD;QAChD,MAAM,GAAG,GAAG,UAAU,CAAC,OAAO,CAAC,wBAAwB,EAAE,MAAM,CAAC,CAAC;QACjE,MAAM,GAAG,GAAG,IAAI,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAClC,OAAO,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;CACF;AAtJD,mCAsJC"}

package/lib/settings.d.ts

@@ -1,5 +1,5 @@
 import ProcessorTypeTranspiler from './transpiler/processor-type-transpiler';
-export declare type GeneratorChoices = 'jekyll' | 'docsify' | 'plain-markdown';
+export declare type GeneratorChoices = 'jekyll' | 'docsify' | 'plain-markdown' | 'ts-def';
 export interface SettingsConfig {
     sourceDirectory: string;
     recursive: boolean;

package/lib/settings.js

@@ -4,6 +4,7 @@ exports.Settings = void 0;
 const jekyll_docsProcessor_1 = require("./transpiler/markdown/jekyll/jekyll-docsProcessor");
 const docsify_docs_processor_1 = require("./transpiler/markdown/docsify/docsify-docs-processor");
 const plain_docsProcessor_1 = require("./transpiler/markdown/plain-markdown/plain-docsProcessor");
+const TsTypesTranspiler_1 = require("./transpiler/ts-types/TsTypesTranspiler");
 class Settings {
     constructor(config) {
         this.config = config;
@@ -43,6 +44,9 @@ class Settings {
             case 'plain-markdown':
                 Settings.typeTranspilerCache = new plain_docsProcessor_1.PlainMarkdownDocsProcessor();
                 return Settings.typeTranspilerCache;
+            case 'ts-def':
+                Settings.typeTranspilerCache = new TsTypesTranspiler_1.TsTypesTranspiler();
+                return Settings.typeTranspilerCache;
             default:
                 throw Error('Invalid target generator');
         }

package/lib/settings.js.map

@@ -1 +1 @@
-{"version":3,"file":"settings.js","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":";;;AACA,4FAAwF;AACxF,iGAAwF;AACxF,kGAAsG;AActG,MAAa,QAAQ;IAGnB,YAA2B,MAAsB;QAAtB,WAAM,GAAN,MAAM,CAAgB;IAAG,CAAC;IAE9C,MAAM,CAAC,KAAK,CAAC,MAAsB;QACxC,QAAQ,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;IAEM,MAAM,CAAC,WAAW;QACvB,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE;YACtB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;SACtD;QACD,OAAO,QAAQ,CAAC,QAAQ,CAAC;IAC3B,CAAC;IAED,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;IACrC,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IAC3B,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAGD,IAAI,cAAc;QAChB,IAAI,QAAQ,CAAC,mBAAmB,EAAE;YAChC,OAAO,QAAQ,CAAC,mBAAmB,CAAC;SACrC;QACD,QAAQ,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE;YACnC,KAAK,QAAQ;gBACX,QAAQ,CAAC,mBAAmB,GAAG,IAAI,0CAAmB,EAAE,CAAC;gBACzD,OAAO,QAAQ,CAAC,mBAAmB,CAAC;YACtC,KAAK,SAAS;gBACZ,QAAQ,CAAC,mBAAmB,GAAG,IAAI,gCAAoB,EAAE,CAAC;gBAC1D,OAAO,QAAQ,CAAC,mBAAmB,CAAC;YACtC,KAAK,gBAAgB;gBACnB,QAAQ,CAAC,mBAAmB,GAAG,IAAI,gDAA0B,EAAE,CAAC;gBAChE,OAAO,QAAQ,CAAC,mBAAmB,CAAC;YACtC;gBACE,MAAM,KAAK,CAAC,0BAA0B,CAAC,CAAC;SAC3C;IACH,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAEM,mBAAmB;QACxB,OAAO,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC;IACtC,CAAC;CACF;AA3DD,4BA2DC"}
+{"version":3,"file":"settings.js","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":";;;AACA,4FAAwF;AACxF,iGAAwF;AACxF,kGAAsG;AACtG,+EAA4E;AAc5E,MAAa,QAAQ;IAGnB,YAA2B,MAAsB;QAAtB,WAAM,GAAN,MAAM,CAAgB;IAAG,CAAC;IAE9C,MAAM,CAAC,KAAK,CAAC,MAAsB;QACxC,QAAQ,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;IAEM,MAAM,CAAC,WAAW;QACvB,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE;YACtB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;SACtD;QACD,OAAO,QAAQ,CAAC,QAAQ,CAAC;IAC3B,CAAC;IAED,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;IACrC,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IAC3B,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAID,IAAI,cAAc;QAChB,IAAI,QAAQ,CAAC,mBAAmB,EAAE;YAChC,OAAO,QAAQ,CAAC,mBAAmB,CAAC;SACrC;QACD,QAAQ,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE;YACnC,KAAK,QAAQ;gBACX,QAAQ,CAAC,mBAAmB,GAAG,IAAI,0CAAmB,EAAE,CAAC;gBACzD,OAAO,QAAQ,CAAC,mBAAmB,CAAC;YACtC,KAAK,SAAS;gBACZ,QAAQ,CAAC,mBAAmB,GAAG,IAAI,gCAAoB,EAAE,CAAC;gBAC1D,OAAO,QAAQ,CAAC,mBAAmB,CAAC;YACtC,KAAK,gBAAgB;gBACnB,QAAQ,CAAC,mBAAmB,GAAG,IAAI,gDAA0B,EAAE,CAAC;gBAChE,OAAO,QAAQ,CAAC,mBAAmB,CAAC;YACtC,KAAK,QAAQ;gBACX,QAAQ,CAAC,mBAAmB,GAAG,IAAI,qCAAiB,EAAE,CAAC;gBACvD,OAAO,QAAQ,CAAC,mBAAmB,CAAC;YACtC;gBACE,MAAM,KAAK,CAAC,0BAA0B,CAAC,CAAC;SAC3C;IACH,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAEM,mBAAmB;QACxB,OAAO,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC;IACtC,CAAC;CACF;AA/DD,4BA+DC"}

package/lib/transpiler/markdown/class-file-generatorHelper.js.map

@@ -1 +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,+CAAwC;AAExC,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,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;QACxD,OAAO,IAAI,UAAU,CAAC,IAAI,KAAK,aAAa,GAAG,UAAU,CAAC,IAAI,MAAM,CAAC;IACvE,CAAC;IAEM,MAAM,CAAC,qBAAqB,CAAC,QAAgB;QAClD,MAAM,IAAI,GAAG,kCAAe,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QAC/D,IAAI,CAAC,IAAI,EAAE;YACT,qFAAqF;YACrF,OAAO,IAAI,QAAQ,KAAK,QAAQ,GAAG,CAAC;SACrC;QAED,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,UAAgB;QAC9C,iEAAiE;QACjE,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,kBAAkB,EAAE,KAAK,eAAe,EAAE;YAClF,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,uEAAuE;gBACvE,OAAO,MAAM,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC;aACpD;SACF;aAAM;YACL,sGAAsG;YACtG,OAAO,KAAK,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC;SACnD;IACH,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,UAAgB;;QAC3C,MAAM,eAAe,SAAG,UAAU,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CAC7D,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,OAAO,CAC1D,CAAC;QACF,aAAO,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,IAAI,mCAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,mBAAmB,EAAE,CAAC;IAC/E,CAAC;CACF;AAhDD,2CAgDC"}
+{"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,+CAAwC;AAGxC,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,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;QACxD,OAAO,IAAI,UAAU,CAAC,IAAI,KAAK,aAAa,GAAG,UAAU,CAAC,IAAI,MAAM,CAAC;IACvE,CAAC;IAEM,MAAM,CAAC,qBAAqB,CAAC,QAAgB;QAClD,MAAM,IAAI,GAAG,kCAAe,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QAC/D,IAAI,CAAC,IAAI,EAAE;YACT,qFAAqF;YACrF,OAAO,IAAI,QAAQ,KAAK,QAAQ,GAAG,CAAC;SACrC;QAED,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,UAAgB;QAC9C,iEAAiE;QACjE,IAAK,mBAAQ,CAAC,WAAW,EAAE,CAAC,cAAyC,CAAC,kBAAkB,EAAE,KAAK,eAAe,EAAE;YAC9G,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,uEAAuE;gBACvE,OAAO,MAAM,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC;aACpD;SACF;aAAM;YACL,sGAAsG;YACtG,OAAO,KAAK,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC;SACnD;IACH,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,UAAgB;;QAC3C,MAAM,eAAe,SAAG,UAAU,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CAC7D,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,OAAO,CAC1D,CAAC;QACF,aAAO,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,IAAI,mCAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,mBAAmB,EAAE,CAAC;IAC/E,CAAC;CACF;AAhDD,2CAgDC"}

package/lib/transpiler/markdown/docsify/docsify-docs-processor.d.ts

@@ -1,5 +1,4 @@
-import { MarkdownTranspilerBase } from '../markdown-transpiler-base';
-import { LinkingStrategy } from '../../processor-type-transpiler';
+import { LinkingStrategy, MarkdownTranspilerBase } from '../markdown-transpiler-base';
 export default class DocsifyDocsProcessor extends MarkdownTranspilerBase {
     homeFileName(): string;
     getLinkingStrategy(): LinkingStrategy;

package/lib/transpiler/markdown/docsify/docsify-docs-processor.js.map

@@ -1 +1 @@
-{"version":3,"file":"docsify-docs-processor.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/docsify/docsify-docs-processor.ts"],"names":[],"mappings":";;AAAA,0EAAqE;AAGrE,MAAqB,oBAAqB,SAAQ,iDAAsB;IACtE,YAAY;QACV,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,kBAAkB;QAChB,OAAO,eAAe,CAAC;IACzB,CAAC;CACF;AARD,uCAQC"}
+{"version":3,"file":"docsify-docs-processor.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/docsify/docsify-docs-processor.ts"],"names":[],"mappings":";;AAAA,0EAAsF;AAEtF,MAAqB,oBAAqB,SAAQ,iDAAsB;IACtE,YAAY;QACV,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,kBAAkB;QAChB,OAAO,eAAe,CAAC;IACzB,CAAC;CACF;AARD,uCAQC"}

package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.d.ts

@@ -1,6 +1,5 @@
-import { MarkdownTranspilerBase } from '../markdown-transpiler-base';
+import { LinkingStrategy, MarkdownTranspilerBase } from '../markdown-transpiler-base';
 import { Type } from '@cparra/apex-reflection';
-import { LinkingStrategy } from '../../processor-type-transpiler';
 export declare class JekyllDocsProcessor extends MarkdownTranspilerBase {
     homeFileName(): string;
     onBeforeProcess: (types: Type[]) => void;

package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.js.map

@@ -1 +1 @@
-{"version":3,"file":"jekyll-docsProcessor.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/jekyll/jekyll-docsProcessor.ts"],"names":[],"mappings":";;;AAAA,0EAAqE;AAErE,0EAAqE;AACrE,0EAAqE;AAGrE,MAAa,mBAAoB,SAAQ,iDAAsB;IAA/D;;QAKE,oBAAe,GAAG,CAAC,KAAa,EAAE,EAAE;YAClC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,qCAAgB,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;QACzG,CAAC,CAAC;IAaJ,CAAC;IAnBC,YAAY;QACV,OAAO,OAAO,CAAC;IACjB,CAAC;IAMD,SAAS,CAAC,IAAU;QAClB,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,qCAAgB,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;IACtF,CAAC;IAED,IAAI,iBAAiB;QACnB,OAAO,2BAA2B,CAAC;IACrC,CAAC;IAED,kBAAkB;QAChB,OAAO,eAAe,CAAC;IACzB,CAAC;CACF;AApBD,kDAoBC"}
+{"version":3,"file":"jekyll-docsProcessor.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/jekyll/jekyll-docsProcessor.ts"],"names":[],"mappings":";;;AAAA,0EAAsF;AAEtF,0EAAqE;AACrE,0EAAqE;AAErE,MAAa,mBAAoB,SAAQ,iDAAsB;IAA/D;;QAKE,oBAAe,GAAG,CAAC,KAAa,EAAE,EAAE;YAClC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,qCAAgB,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;QACzG,CAAC,CAAC;IAaJ,CAAC;IAnBC,YAAY;QACV,OAAO,OAAO,CAAC;IACjB,CAAC;IAMD,SAAS,CAAC,IAAU;QAClB,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,qCAAgB,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;IACtF,CAAC;IAED,IAAI,iBAAiB;QACnB,OAAO,2BAA2B,CAAC;IACrC,CAAC;IAED,kBAAkB;QAChB,OAAO,eAAe,CAAC;IACzB,CAAC;CACF;AApBD,kDAoBC"}

package/lib/transpiler/markdown/markdown-transpiler-base.d.ts

@@ -1,6 +1,7 @@
 import ProcessorTypeTranspiler from '../processor-type-transpiler';
 import { Type } from '@cparra/apex-reflection';
 import { FileContainer } from '../file-container';
+export declare type LinkingStrategy = 'root-relative' | 'path-relative';
 export declare abstract class MarkdownTranspilerBase extends ProcessorTypeTranspiler {
     protected readonly _fileContainer: FileContainer;
     constructor();
@@ -8,4 +9,5 @@ export declare abstract class MarkdownTranspilerBase extends ProcessorTypeTransp
     fileBuilder(): FileContainer;
     onBeforeProcess: (types: Type[]) => void;
     onProcess(type: Type): void;
+    abstract getLinkingStrategy(): LinkingStrategy;
 }

package/lib/transpiler/markdown/markdown-transpiler-base.js.map

@@ -1 +1 @@
-{"version":3,"file":"markdown-transpiler-base.js","sourceRoot":"","sources":["../../../src/transpiler/markdown/markdown-transpiler-base.ts"],"names":[],"mappings":";;;AAAA,4EAAmE;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"}
+{"version":3,"file":"markdown-transpiler-base.js","sourceRoot":"","sources":["../../../src/transpiler/markdown/markdown-transpiler-base.ts"],"names":[],"mappings":";;;AAAA,4EAAmE;AAEnE,sDAAkD;AAClD,uEAAkE;AAClE,uEAAkE;AAIlE,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;CAGF;AAvBD,wDAuBC"}

package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.d.ts

@@ -1,5 +1,4 @@
-import { MarkdownTranspilerBase } from '../markdown-transpiler-base';
-import { LinkingStrategy } from '../../processor-type-transpiler';
+import { LinkingStrategy, MarkdownTranspilerBase } from '../markdown-transpiler-base';
 export declare class PlainMarkdownDocsProcessor extends MarkdownTranspilerBase {
     homeFileName(): string;
     getLinkingStrategy(): LinkingStrategy;

package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.js.map

@@ -1 +1 @@
-{"version":3,"file":"plain-docsProcessor.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/plain-docsProcessor.ts"],"names":[],"mappings":";;;AAAA,0EAAqE;AAGrE,MAAa,0BAA2B,SAAQ,iDAAsB;IACpE,YAAY;QACV,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,kBAAkB;QAChB,OAAO,eAAe,CAAC;IACzB,CAAC;CACF;AARD,gEAQC"}
+{"version":3,"file":"plain-docsProcessor.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/plain-docsProcessor.ts"],"names":[],"mappings":";;;AAAA,0EAAsF;AAEtF,MAAa,0BAA2B,SAAQ,iDAAsB;IACpE,YAAY;QACV,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,kBAAkB;QAChB,OAAO,eAAe,CAAC;IACzB,CAAC;CACF;AARD,gEAQC"}

package/lib/transpiler/processor-type-transpiler.d.ts

@@ -1,10 +1,8 @@
 import { Type } from '@cparra/apex-reflection';
 import { FileContainer } from './file-container';
-export declare type LinkingStrategy = 'root-relative' | 'path-relative';
 export default abstract class ProcessorTypeTranspiler {
     onBeforeProcess: ((types: Type[]) => void) | undefined;
     abstract onProcess(type: Type): void;
     onAfterProcess: ((types: Type[]) => void) | undefined;
     abstract fileBuilder(): FileContainer;
-    abstract getLinkingStrategy(): LinkingStrategy;
 }

package/lib/transpiler/processor-type-transpiler.js.map

@@ -1 +1 @@
-{"version":3,"file":"processor-type-transpiler.js","sourceRoot":"","sources":["../../src/transpiler/processor-type-transpiler.ts"],"names":[],"mappings":";;AAKA,MAA8B,uBAAuB;CAUpD;AAVD,0CAUC"}
+{"version":3,"file":"processor-type-transpiler.js","sourceRoot":"","sources":["../../src/transpiler/processor-type-transpiler.ts"],"names":[],"mappings":";;AAGA,MAA8B,uBAAuB;CAQpD;AARD,0CAQC"}

package/lib/transpiler/ts-types/TsTypesTranspiler.d.ts

@@ -0,0 +1,9 @@
+import ProcessorTypeTranspiler from '../processor-type-transpiler';
+import { Type } from '@cparra/apex-reflection';
+import { FileContainer } from '../file-container';
+export declare class TsTypesTranspiler extends ProcessorTypeTranspiler {
+    protected readonly _fileContainer: FileContainer;
+    constructor();
+    fileBuilder(): FileContainer;
+    onProcess(type: Type): void;
+}

package/lib/transpiler/ts-types/TsTypesTranspiler.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TsTypesTranspiler = void 0;
+const processor_type_transpiler_1 = require("../processor-type-transpiler");
+const file_container_1 = require("../file-container");
+const ts_definition_file_1 = require("../../model/ts-definition-file");
+class TsTypesTranspiler extends processor_type_transpiler_1.default {
+    constructor() {
+        super();
+        this._fileContainer = new file_container_1.FileContainer();
+    }
+    fileBuilder() {
+        return this._fileContainer;
+    }
+    onProcess(type) {
+        if (type.type_name !== 'class') {
+            return;
+        }
+        this._fileContainer.pushFile(new ts_definition_file_1.default(type));
+    }
+}
+exports.TsTypesTranspiler = TsTypesTranspiler;
+//# sourceMappingURL=TsTypesTranspiler.js.map

package/lib/transpiler/ts-types/TsTypesTranspiler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TsTypesTranspiler.js","sourceRoot":"","sources":["../../../src/transpiler/ts-types/TsTypesTranspiler.ts"],"names":[],"mappings":";;;AAAA,4EAAmE;AAEnE,sDAAkD;AAClD,uEAA8D;AAE9D,MAAa,iBAAkB,SAAQ,mCAAuB;IAG5D;QACE,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,cAAc,GAAG,IAAI,8BAAa,EAAE,CAAC;IAC5C,CAAC;IAED,WAAW;QACT,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED,SAAS,CAAC,IAAU;QAClB,IAAI,IAAI,CAAC,SAAS,KAAK,OAAO,EAAE;YAC9B,OAAO;SACR;QACD,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,4BAAgB,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3D,CAAC;CACF;AAlBD,8CAkBC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cparra/apexdocs",
-  "version": "2.5.0",
+  "version": "2.6.0-alpha.0",
   "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
   "keywords": [
     "apex",
@@ -25,7 +25,8 @@
     "docs:init": "docsify init docs",
     "docs:serve": "docsify serve docs",
     "execute:example": "node lib/cli/generate.js -s examples/force-app -t docs --scope global public private -g docsify --defaultGroupName API",
-    "execute:example:index:only": "node lib/cli/generate.js -s examples/force-app -t docs --scope global public private -g docsify --indexOnly"
+    "execute:example:index:only": "node lib/cli/generate.js -s examples/force-app -t docs --scope global public private -g docsify --indexOnly",
+    "execute:example:ts:definitions": "node lib/cli/generate.js -s examples/force-app -t docs/ts --scope global public -g ts-def"
   },
   "author": "Cesar Parra",
   "license": "MIT",

package/src/cli/generate.ts

@@ -35,9 +35,9 @@ const argv = yargs.options({
     type: 'string',
     alias: 'g',
     default: 'jekyll',
-    choices: ['jekyll', 'docsify', 'plain-markdown'],
+    choices: ['jekyll', 'docsify', 'plain-markdown', 'ts-def'],
     describe:
-      'Define the static file generator for which the documents will be created. Currently supports jekyll, docsify, and plain markdown.',
+      'Define the static file generator for which the documents will be created. Currently supports jekyll, docsify, plain markdown, and Typescript type definitions.',
   },
   indexOnly: {
     type: 'boolean',

package/src/model/ts-definition-file.ts

@@ -0,0 +1,165 @@
+import { File } from './file';
+import { WalkerListener } from '../service/walkers/walker';
+import {
+  ClassMirror,
+  ConstructorMirror,
+  EnumMirror,
+  FieldMirror,
+  InterfaceMirror,
+  MethodMirror,
+  PropertyMirror,
+  Type,
+} from '@cparra/apex-reflection';
+import { WalkerFactory } from '../service/walkers/walker-factory';
+
+export default class TsDefinitionFile extends File implements WalkerListener {
+  fileExtension(): string {
+    return '.d.ts';
+  }
+
+  constructor(typeMirror: Type) {
+    super(typeMirror.name, '');
+    const walker = WalkerFactory.get(typeMirror);
+    walker.walk(this);
+  }
+
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
+  onConstructorDeclaration(className: string, constructors: ConstructorMirror[]): void {}
+
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
+  onFieldsDeclaration(fields: FieldMirror[]): void {}
+
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
+  onInnerClassesDeclaration(classes: ClassMirror[]): void {}
+
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
+  onInnerEnumsDeclaration(enums: EnumMirror[]): void {}
+
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
+  onInnerInterfacesDeclaration(interfaces: InterfaceMirror[]): void {}
+
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
+  onMethodsDeclaration(methods: MethodMirror[]): void {}
+
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
+  onPropertiesDeclaration(properties: PropertyMirror[]): void {}
+
+  onTypeDeclaration(typeMirror: Type): void {
+    this.initializeBlock();
+    this.declareType(typeMirror.name, typeMirror.docComment?.description ?? '');
+    this.addPropertiesAndFields(typeMirror);
+    // TODO: Auraenabled method support
+    // TODO: Remember that methods with getX and setX lose the get and set
+    // TODO: Classes that dont have any auraenabled things should be skipped
+    this.finalizeBlock();
+    this.addInnerClasses(typeMirror);
+  }
+
+  private addPropertiesAndFields(typeMirror: Type) {
+    const classModel = typeMirror as ClassMirror;
+    if (classModel.properties.length === 0 && classModel.fields.length === 0) {
+      return;
+    }
+
+    const propertiesAndFields = [...classModel.properties, ...classModel.fields].filter(
+      (e) => e.annotations.findIndex((a) => a.name === 'auraenabled') !== -1,
+    );
+
+    propertiesAndFields
+      .sort((propA, propB) => {
+        if (propA.name < propB.name) return -1;
+        if (propA.name > propB.name) return 1;
+        return 0;
+      })
+      .forEach((propertyModel) => {
+        this.declareProperty(propertyModel.type, propertyModel.name, propertyModel.docComment?.description ?? '');
+      });
+  }
+
+  private addInnerClasses(typeMirror: Type) {
+    const classModel = typeMirror as ClassMirror;
+    if (classModel.classes.length > 0) {
+      classModel.classes
+        .sort((classA, classB) => {
+          if (classA.name < classB.name) return -1;
+          if (classA.name > classB.name) return 1;
+          return 0;
+        })
+        .forEach((innerClass) => {
+          this.onTypeDeclaration(innerClass);
+        });
+    }
+  }
+
+  addBlankLine() {
+    this._contents += '\n';
+  }
+
+  initializeBlock() {
+    this._contents += '/**';
+    this.addBlankLine();
+  }
+
+  finalizeBlock() {
+    this._contents += ' */';
+    this.addBlankLine();
+  }
+
+  declareType(className: string, docDescription: string) {
+    this._contents += ` * @typedef {Object} ${className} ${docDescription}`;
+    this.addBlankLine();
+  }
+
+  declareProperty(propertyType: string, propertyName: string, docDescription: string) {
+    let sanitizedType;
+    // First we check if we are dealing with a list
+    if (this.isListProperty(propertyType)) {
+      // If we are then we first extract the type from the list
+      sanitizedType = this.extractTypeFromList(propertyType);
+      // then sanitize it
+      sanitizedType = this.sanitizeApexPropertyToJavascript(sanitizedType);
+      // and then we add brackets ([])
+      sanitizedType = sanitizedType + '[]';
+    } else {
+      sanitizedType = this.sanitizeApexPropertyToJavascript(propertyType);
+    }
+
+    this._contents += ` * @property {${sanitizedType}} ${propertyName} ${docDescription}`;
+    this.addBlankLine();
+  }
+
+  sanitizeApexPropertyToJavascript(propertyType: string) {
+    const lowerPropertyType = propertyType.toLowerCase();
+    if (lowerPropertyType === 'decimal' || lowerPropertyType === 'integer' || lowerPropertyType === 'double') {
+      return 'number';
+    }
+
+    if (lowerPropertyType === 'boolean' || lowerPropertyType === 'string') {
+      // If it is a built-in type then we return the lower-cased version.
+      return lowerPropertyType;
+    }
+
+    // Otherwise, we respect casing
+    return propertyType;
+  }
+
+  isListProperty(propertyType: string) {
+    const lowerPropertyType = propertyType.toLowerCase();
+    if (lowerPropertyType.includes('<') && lowerPropertyType.includes('list')) {
+      return true;
+    }
+  }
+
+  extractTypeFromList(propertyType: string) {
+    const propertyWithoutList = this.replaceAll(propertyType, 'list', '');
+    return propertyWithoutList.replace('list', '').replace('<', '').replace('>', '');
+  }
+
+  // Case insensitive replace
+  replaceAll(sourceString: string, strReplace: string, strWith: string) {
+    // See http://stackoverflow.com/a/3561711/556609
+    const esc = strReplace.replace(/[-\/\\^$*+?.()|[\]{}]/g, '\\$&');
+    const reg = new RegExp(esc, 'ig');
+    return sourceString.replace(reg, strWith);
+  }
+}

package/src/settings.ts

@@ -2,8 +2,9 @@ import ProcessorTypeTranspiler from './transpiler/processor-type-transpiler';
 import { JekyllDocsProcessor } from './transpiler/markdown/jekyll/jekyll-docsProcessor';
 import DocsifyDocsProcessor from './transpiler/markdown/docsify/docsify-docs-processor';
 import { PlainMarkdownDocsProcessor } from './transpiler/markdown/plain-markdown/plain-docsProcessor';
+import { TsTypesTranspiler } from './transpiler/ts-types/TsTypesTranspiler';
 
-export type GeneratorChoices = 'jekyll' | 'docsify' | 'plain-markdown';
+export type GeneratorChoices = 'jekyll' | 'docsify' | 'plain-markdown' | 'ts-def';
 
 export interface SettingsConfig {
   sourceDirectory: string;
@@ -48,6 +49,7 @@ export class Settings {
   }
 
   private static typeTranspilerCache?: ProcessorTypeTranspiler;
+
   get typeTranspiler(): ProcessorTypeTranspiler {
     if (Settings.typeTranspilerCache) {
       return Settings.typeTranspilerCache;
@@ -62,6 +64,9 @@ export class Settings {
       case 'plain-markdown':
         Settings.typeTranspilerCache = new PlainMarkdownDocsProcessor();
         return Settings.typeTranspilerCache;
+      case 'ts-def':
+        Settings.typeTranspilerCache = new TsTypesTranspiler();
+        return Settings.typeTranspilerCache;
       default:
         throw Error('Invalid target generator');
     }

package/src/transpiler/markdown/class-file-generatorHelper.ts

@@ -2,6 +2,7 @@ import { Type } from '@cparra/apex-reflection';
 import { TypesRepository } from '../../model/types-repository';
 import { Settings } from '../../settings';
 import State from '../../service/state';
+import { MarkdownTranspilerBase } from './markdown-transpiler-base';
 
 export default class ClassFileGeneratorHelper {
   public static getSanitizedGroup(classModel: Type) {
@@ -25,7 +26,7 @@ export default class ClassFileGeneratorHelper {
 
   private static getDirectoryRoot(classModel: Type) {
     // root-relative links start from the root by using a leading '/'
-    if (Settings.getInstance().typeTranspiler.getLinkingStrategy() === 'root-relative') {
+    if ((Settings.getInstance().typeTranspiler as MarkdownTranspilerBase).getLinkingStrategy() === 'root-relative') {
       return `/${this.getSanitizedGroup(classModel)}/`;
     }
 

package/src/transpiler/markdown/docsify/docsify-docs-processor.ts

@@ -1,5 +1,4 @@
-import { MarkdownTranspilerBase } from '../markdown-transpiler-base';
-import { LinkingStrategy } from '../../processor-type-transpiler';
+import { LinkingStrategy, MarkdownTranspilerBase } from '../markdown-transpiler-base';
 
 export default class DocsifyDocsProcessor extends MarkdownTranspilerBase {
   homeFileName(): string {

package/src/transpiler/markdown/jekyll/jekyll-docsProcessor.ts

@@ -1,8 +1,7 @@
-import { MarkdownTranspilerBase } from '../markdown-transpiler-base';
+import { LinkingStrategy, MarkdownTranspilerBase } from '../markdown-transpiler-base';
 import { Type } from '@cparra/apex-reflection';
 import { MarkdownHomeFile } from '../../../model/markdown-home-file';
 import { MarkdownTypeFile } from '../../../model/markdown-type-file';
-import { LinkingStrategy } from '../../processor-type-transpiler';
 
 export class JekyllDocsProcessor extends MarkdownTranspilerBase {
   homeFileName(): string {

package/src/transpiler/markdown/markdown-transpiler-base.ts

@@ -4,6 +4,8 @@ import { FileContainer } from '../file-container';
 import { MarkdownHomeFile } from '../../model/markdown-home-file';
 import { MarkdownTypeFile } from '../../model/markdown-type-file';
 
+export type LinkingStrategy = 'root-relative' | 'path-relative';
+
 export abstract class MarkdownTranspilerBase extends ProcessorTypeTranspiler {
   protected readonly _fileContainer: FileContainer;
 
@@ -25,4 +27,6 @@ export abstract class MarkdownTranspilerBase extends ProcessorTypeTranspiler {
   onProcess(type: Type): void {
     this._fileContainer.pushFile(new MarkdownTypeFile(type));
   }
+
+  abstract getLinkingStrategy(): LinkingStrategy;
 }

package/src/transpiler/markdown/plain-markdown/plain-docsProcessor.ts

@@ -1,5 +1,4 @@
-import { MarkdownTranspilerBase } from '../markdown-transpiler-base';
-import { LinkingStrategy } from '../../processor-type-transpiler';
+import { LinkingStrategy, MarkdownTranspilerBase } from '../markdown-transpiler-base';
 
 export class PlainMarkdownDocsProcessor extends MarkdownTranspilerBase {
   homeFileName(): string {

package/src/transpiler/processor-type-transpiler.ts

@@ -1,8 +1,6 @@
 import { Type } from '@cparra/apex-reflection';
 import { FileContainer } from './file-container';
 
-export type LinkingStrategy = 'root-relative' | 'path-relative';
-
 export default abstract class ProcessorTypeTranspiler {
   onBeforeProcess: ((types: Type[]) => void) | undefined;
 
@@ -11,6 +9,4 @@ export default abstract class ProcessorTypeTranspiler {
   onAfterProcess: ((types: Type[]) => void) | undefined;
 
   abstract fileBuilder(): FileContainer;
-
-  abstract getLinkingStrategy(): LinkingStrategy;
 }

package/src/transpiler/ts-types/TsTypesTranspiler.ts

@@ -0,0 +1,24 @@
+import ProcessorTypeTranspiler from '../processor-type-transpiler';
+import { Type } from '@cparra/apex-reflection';
+import { FileContainer } from '../file-container';
+import TsDefinitionFile from '../../model/ts-definition-file';
+
+export class TsTypesTranspiler extends ProcessorTypeTranspiler {
+  protected readonly _fileContainer: FileContainer;
+
+  constructor() {
+    super();
+    this._fileContainer = new FileContainer();
+  }
+
+  fileBuilder(): FileContainer {
+    return this._fileContainer;
+  }
+
+  onProcess(type: Type): void {
+    if (type.type_name !== 'class') {
+      return;
+    }
+    this._fileContainer.pushFile(new TsDefinitionFile(type));
+  }
+}