@cparra/apexdocs 2.25.0-alpha.9 → 2.25.0

package/docs/types/README.md

@@ -0,0 +1,97 @@
+# Sample Documentation
+## Classes
+
+### [nspc.AnotherInterface](types/Classes/nspc.AnotherInterface.md)
+
+Some desc
+
+
+
+### [nspc.ChildClass](types/Classes/nspc.ChildClass.md)
+
+Some desc
+
+
+## Misc Group
+
+### [nspc.EscapedAnnotations](types/Misc-Group/nspc.EscapedAnnotations.md)
+
+This sentence has an `@embedded` annotation.
+
+
+
+### [nspc.GrandparentClass](types/Misc-Group/nspc.GrandparentClass.md)
+
+
+### [nspc.InterfaceWithInheritance](types/Misc-Group/nspc.InterfaceWithInheritance.md)
+
+
+### [nspc.MemberGrouping](types/Misc-Group/nspc.MemberGrouping.md)
+
+
+### [nspc.ParentClass](types/Misc-Group/nspc.ParentClass.md)
+
+
+### [nspc.Reference1](types/Misc-Group/nspc.Reference1.md)
+
+
+### [nspc.Reference2](types/Misc-Group/nspc.Reference2.md)
+
+
+### [nspc.Reference3](types/Misc-Group/nspc.Reference3.md)
+
+
+### [nspc.Reference4](types/Misc-Group/nspc.Reference4.md)
+
+
+### [nspc.Reference5](types/Misc-Group/nspc.Reference5.md)
+
+
+### [nspc.Reference6](types/Misc-Group/nspc.Reference6.md)
+
+
+### [nspc.Reference7](types/Misc-Group/nspc.Reference7.md)
+
+
+### [nspc.SampleClassWithoutModifier](types/Misc-Group/nspc.SampleClassWithoutModifier.md)
+
+
+### [nspc.SampleRestResource](types/Misc-Group/nspc.SampleRestResource.md)
+
+Account related operations
+
+
+
+### [nspc.SampleRestResourceWithInnerClass](types/Misc-Group/nspc.SampleRestResourceWithInnerClass.md)
+
+Contact related operations
+
+
+
+### [nspc.SampleRestResourceWithoutApexDocs](types/Misc-Group/nspc.SampleRestResourceWithoutApexDocs.md)
+
+Order related operations
+
+
+## Main
+
+### [nspc.GroupedClass](types/Main/nspc.GroupedClass.md)
+
+Uses a block style apex doc
+
+
+
+### [nspc.SampleClass](types/Main/nspc.SampleClass.md)
+
+This is a class description. This class relates to [nspc.SampleInterface](types/Sample-Interfaces/nspc.SampleInterface.md)
+             But this [ClassThatDoesNotExist](ClassThatDoesNotExist) does not exist.
+             You can also link using this syntax [nspc.SampleInterface](types/Sample-Interfaces/nspc.SampleInterface.md)
+
+
+## Sample Interfaces
+
+### [nspc.SampleInterface](types/Sample-Interfaces/nspc.SampleInterface.md)
+
+This is an interface description.
+
+

package/docs/types/Sample-Interfaces/nspc.SampleInterface.md

@@ -0,0 +1,23 @@
+# nspc.SampleInterface
+
+This is an interface description.
+
+
+**Group** Sample Interfaces
+
+## Methods
+### `global void execute()`
+
+Executes the command.
+
+### `global String getValue()`
+
+Returns a value based on the executed command.
+
+#### Returns
+
+|Type|Description|
+|---|---|
+|`String`|The value|
+
+---

package/examples/includes/header.md

@@ -0,0 +1,3 @@
+# Welcome to the Apex Docs documentation example.
+
+This content will be added to the top of the home page.

package/jest.config.js

@@ -1,10 +1,5 @@
 module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
-  modulePathIgnorePatterns: ['<rootDir>/dist/'],
-  moduleNameMapper: {
-    '^chalk$': '<rootDir>/__mocks__/chalk.js',
-    '^log-update$': '<rootDir>/__mocks__/log-update.js',
-    '#utils/(.*)$': '<rootDir>/src/util/$1',
-  },
+  modulePathIgnorePatterns: ['<rootDir>/lib/'],
 };

package/lib/application/Apexdocs.d.ts

@@ -0,0 +1,13 @@
+import { ReflectionResult } from '@cparra/apex-reflection';
+import ApexBundle from '../model/apex-bundle';
+/**
+ * Application entry-point to generate documentation out of Apex source files.
+ */
+export declare class Apexdocs {
+    /**
+     * Generates documentation out of Apex source files.
+     */
+    static generate(): void;
+    private static filterByScopes;
+    static _reflectionWithLogger: (apexBundle: ApexBundle) => ReflectionResult;
+}

package/lib/application/Apexdocs.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Apexdocs = void 0;
+const apex_file_reader_1 = require("../service/apex-file-reader");
+const file_system_1 = require("../service/file-system");
+const apex_reflection_1 = require("@cparra/apex-reflection");
+const logger_1 = require("../util/logger");
+const manifest_factory_1 = require("../service/manifest-factory");
+const parser_1 = require("../service/parser");
+const settings_1 = require("../settings");
+const transpiler_1 = require("../transpiler/transpiler");
+const file_writer_1 = require("../service/file-writer");
+const error_logger_1 = require("../util/error-logger");
+const types_repository_1 = require("../model/types-repository");
+const factory_1 = require("../transpiler/factory");
+/**
+ * Application entry-point to generate documentation out of Apex source files.
+ */
+class Apexdocs {
+    /**
+     * Generates documentation out of Apex source files.
+     */
+    static generate() {
+        logger_1.Logger.log('Initializing...');
+        const fileBodies = apex_file_reader_1.ApexFileReader.processFiles(new file_system_1.DefaultFileSystem());
+        const manifest = (0, manifest_factory_1.createManifest)(new parser_1.RawBodyParser(fileBodies), this._reflectionWithLogger);
+        types_repository_1.TypesRepository.getInstance().populateAll(manifest.types);
+        const filteredTypes = this.filterByScopes(manifest);
+        types_repository_1.TypesRepository.getInstance().populateScoped(filteredTypes);
+        const processor = factory_1.TypeTranspilerFactory.get(settings_1.Settings.getInstance().targetGenerator);
+        transpiler_1.default.generate(filteredTypes, processor);
+        const generatedFiles = processor.fileBuilder().files();
+        const files = [];
+        file_writer_1.FileWriter.write(generatedFiles, (file) => {
+            logger_1.Logger.logSingle(`${file.name} processed.`, false, 'green', false);
+            files.push(file);
+        });
+        settings_1.Settings.getInstance().onAfterProcess(files);
+        // Error logging
+        error_logger_1.default.logErrors(filteredTypes);
+    }
+    static filterByScopes(manifest) {
+        let filteredTypes;
+        let filteredLogMessage;
+        if (settings_1.Settings.getInstance().config.targetGenerator !== 'openapi') {
+            filteredTypes = manifest.filteredByAccessModifierAndAnnotations(settings_1.Settings.getInstance().scope);
+            filteredLogMessage = `Filtered ${manifest.types.length - filteredTypes.length} file(s) based on scope: ${settings_1.Settings.getInstance().scope}`;
+        }
+        else {
+            // If we are dealing with an OpenApi generator, we ignore the passed in access modifiers, and instead
+            // we only keep classes annotated as @RestResource
+            filteredTypes = manifest.filteredByAccessModifierAndAnnotations([
+                'restresource',
+                'httpdelete',
+                'httpget',
+                'httppatch',
+                'httppost',
+                'httpput',
+            ]);
+            filteredLogMessage = `Filtered ${manifest.types.length - filteredTypes.length} file(s), only keeping classes annotated as @RestResource.`;
+        }
+        logger_1.Logger.clear();
+        logger_1.Logger.logSingle(filteredLogMessage, false, 'green', false);
+        logger_1.Logger.logSingle(`Creating documentation for ${filteredTypes.length} file(s)`, false, 'green', false);
+        return filteredTypes;
+    }
+}
+exports.Apexdocs = Apexdocs;
+Apexdocs._reflectionWithLogger = (apexBundle) => {
+    var _a;
+    const result = (0, apex_reflection_1.reflect)(apexBundle.rawTypeContent);
+    if (result.error) {
+        logger_1.Logger.error(`${apexBundle.filePath} - Parsing error ${(_a = result.error) === null || _a === void 0 ? void 0 : _a.message}`);
+    }
+    return result;
+};
+//# sourceMappingURL=Apexdocs.js.map

package/lib/application/Apexdocs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Apexdocs.js","sourceRoot":"","sources":["../../src/application/Apexdocs.ts"],"names":[],"mappings":";;;AAAA,kEAA6D;AAC7D,wDAA2D;AAC3D,6DAA0E;AAC1E,2CAAwC;AACxC,kEAA6D;AAC7D,8CAAkD;AAClD,0CAAmD;AACnD,yDAAkD;AAClD,wDAAoD;AACpD,uDAA+C;AAG/C,gEAA4D;AAC5D,mDAA8D;AAE9D;;GAEG;AACH,MAAa,QAAQ;IACnB;;OAEG;IACH,MAAM,CAAC,QAAQ;QACb,eAAM,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QAC9B,MAAM,UAAU,GAAG,iCAAc,CAAC,YAAY,CAAC,IAAI,+BAAiB,EAAE,CAAC,CAAC;QACxE,MAAM,QAAQ,GAAG,IAAA,iCAAc,EAAC,IAAI,sBAAa,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAC3F,kCAAe,CAAC,WAAW,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC1D,MAAM,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QACpD,kCAAe,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;QAC5D,MAAM,SAAS,GAAG,+BAAqB,CAAC,GAAG,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,eAAe,CAAC,CAAC;QACpF,oBAAU,CAAC,QAAQ,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;QAC9C,MAAM,cAAc,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC,KAAK,EAAE,CAAC;QAEvD,MAAM,KAAK,GAAiB,EAAE,CAAC;QAC/B,wBAAU,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC,IAAgB,EAAE,EAAE;YACpD,eAAM,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,IAAI,aAAa,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;YACnE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnB,CAAC,CAAC,CAAC;QAEH,mBAAQ,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QAE7C,gBAAgB;QAChB,sBAAW,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;IACvC,CAAC;IAEO,MAAM,CAAC,cAAc,CAAC,QAAkB;QAC9C,IAAI,aAAqB,CAAC;QAC1B,IAAI,kBAAkB,CAAC;QACvB,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,eAAe,KAAK,SAAS,EAAE;YAC/D,aAAa,GAAG,QAAQ,CAAC,sCAAsC,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC;YAC9F,kBAAkB,GAAG,YAAY,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,aAAa,CAAC,MAAM,4BAC3E,mBAAQ,CAAC,WAAW,EAAE,CAAC,KACzB,EAAE,CAAC;SACJ;aAAM;YACL,qGAAqG;YACrG,kDAAkD;YAClD,aAAa,GAAG,QAAQ,CAAC,sCAAsC,CAAC;gBAC9D,cAAc;gBACd,YAAY;gBACZ,SAAS;gBACT,WAAW;gBACX,UAAU;gBACV,SAAS;aACV,CAAC,CAAC;YACH,kBAAkB,GAAG,YACnB,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,aAAa,CAAC,MACxC,4DAA4D,CAAC;SAC9D;QACD,eAAM,CAAC,KAAK,EAAE,CAAC;QAEf,eAAM,CAAC,SAAS,CAAC,kBAAkB,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QAC5D,eAAM,CAAC,SAAS,CAAC,8BAA8B,aAAa,CAAC,MAAM,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QACtG,OAAO,aAAa,CAAC;IACvB,CAAC;;AAvDH,4BAgEC;AAPQ,8BAAqB,GAAG,CAAC,UAAsB,EAAoB,EAAE;;IAC1E,MAAM,MAAM,GAAG,IAAA,yBAAO,EAAC,UAAU,CAAC,cAAc,CAAC,CAAC;IAClD,IAAI,MAAM,CAAC,KAAK,EAAE;QAChB,eAAM,CAAC,KAAK,CAAC,GAAG,UAAU,CAAC,QAAQ,oBAAoB,MAAA,MAAM,CAAC,KAAK,0CAAE,OAAO,EAAE,CAAC,CAAC;KACjF;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC"}

package/lib/cli/generate.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/lib/cli/generate.js

@@ -0,0 +1,131 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const yargs = require("yargs");
+const settings_1 = require("../settings");
+const Apexdocs_1 = require("../application/Apexdocs");
+const cosmiconfig_1 = require("cosmiconfig");
+const result = (0, cosmiconfig_1.cosmiconfig)('apexdocs').search();
+result.then((config) => {
+    var _a, _b, _c;
+    yargs.config(config === null || config === void 0 ? void 0 : config.config);
+    let argv = yargs.options({
+        sourceDir: {
+            type: 'string',
+            alias: 's',
+            demandOption: true,
+            describe: 'The directory location which contains your apex .cls classes.',
+        },
+        targetDir: {
+            type: 'string',
+            alias: 't',
+            default: './docs/',
+            describe: 'The directory location where documentation will be generated to.',
+        },
+        recursive: {
+            type: 'boolean',
+            alias: 'r',
+            default: true,
+            describe: 'Whether .cls classes will be searched for recursively in the directory provided.',
+        },
+        scope: {
+            type: 'array',
+            alias: 'p',
+            default: ['global'],
+            describe: 'A list of scopes to document. Values should be separated by a space, e.g --scope global public namespaceaccessible. ' +
+                'Annotations are supported and should be passed lowercased and without the @ symbol, e.g. namespaceaccessible auraenabled. ' +
+                'Note that this setting is ignored if generating an OpenApi REST specification since that looks for classes annotated with @RestResource.',
+        },
+        targetGenerator: {
+            type: 'string',
+            alias: 'g',
+            default: 'jekyll',
+            choices: ['jekyll', 'docsify', 'plain-markdown', 'openapi'],
+            describe: 'Define the static file generator for which the documents will be created. ' +
+                'Currently supports jekyll, docsify, plain markdown, and OpenAPI v3.1.0.',
+        },
+        indexOnly: {
+            type: 'boolean',
+            default: false,
+            describe: 'Defines whether only the index file should be generated.',
+        },
+        defaultGroupName: {
+            type: 'string',
+            default: 'Miscellaneous',
+            describe: 'Defines the @group name to be used when a file does not specify it.',
+        },
+        sanitizeHtml: {
+            type: 'boolean',
+            default: true,
+            describe: 'When on, any special character within your ApexDocs is converted into its HTML code representation. ' +
+                'This is specially useful when generic objects are described within the docs, e.g. "List< Foo>", "Map<Foo, Bar>" ' +
+                'because otherwise the content within < and > would be treated as HTML tags and not shown in the output. ' +
+                'Content in @example blocks are never sanitized.',
+        },
+        openApiTitle: {
+            type: 'string',
+            default: 'Apex REST Api',
+            describe: 'If using "openapi" as the target generator, this allows you to specify the OpenApi title value.',
+        },
+        title: {
+            type: 'string',
+            describe: "If this allows you to specify the title of the generated documentation's home file.",
+            default: 'Classes',
+        },
+        namespace: {
+            type: 'string',
+            describe: 'The package namespace, if any. If this value is provided the namespace will be added as a prefix to all of the parsed files. ' +
+                "If generating an OpenApi definition, it will be added to the file's Server Url.",
+        },
+        openApiFileName: {
+            type: 'string',
+            describe: 'If using "openapi" as the target generator, this allows you to specify the name of the output file.',
+            default: 'openapi',
+        },
+        sortMembersAlphabetically: {
+            type: 'boolean',
+            describe: 'Whether to sort members alphabetically.',
+            default: false,
+        },
+        includeMetadata: {
+            type: 'boolean',
+            describe: "Whether to include the file's meta.xml information: Whether it is active and and the API version",
+            default: false,
+        },
+        documentationRootDir: {
+            type: 'string',
+            describe: 'Allows you to specify the root documentation directory where the files are being generated. This can be helpful when embedding the generated docs into an existing site so that the links are generated correctly.',
+        },
+    }).argv;
+    if (config) {
+        argv = Object.assign(Object.assign({}, config.config), argv);
+    }
+    settings_1.Settings.build({
+        sourceDirectory: argv.sourceDir,
+        recursive: argv.recursive,
+        scope: argv.scope,
+        outputDir: argv.targetDir,
+        targetGenerator: argv.targetGenerator,
+        indexOnly: argv.indexOnly,
+        defaultGroupName: argv.defaultGroupName,
+        sanitizeHtml: argv.sanitizeHtml,
+        openApiTitle: argv.openApiTitle,
+        title: argv.title,
+        namespace: argv.namespace,
+        openApiFileName: argv.openApiFileName,
+        sortMembersAlphabetically: argv.sortMembersAlphabetically,
+        includeMetadata: argv.includeMetadata,
+        rootDir: argv.documentationRootDir,
+        onAfterProcess: (_a = config === null || config === void 0 ? void 0 : config.config) === null || _a === void 0 ? void 0 : _a.onAfterProcess,
+        onBeforeFileWrite: (_b = config === null || config === void 0 ? void 0 : config.config) === null || _b === void 0 ? void 0 : _b.onBeforeFileWrite,
+        frontMatterHeader: (_c = config === null || config === void 0 ? void 0 : config.config) === null || _c === void 0 ? void 0 : _c.frontMatterHeader,
+    });
+    try {
+        Apexdocs_1.Apexdocs.generate();
+    }
+    catch (error) {
+        console.error(error);
+        process.exit(1);
+    }
+});
+//# sourceMappingURL=generate.js.map

package/lib/cli/generate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../src/cli/generate.ts"],"names":[],"mappings":";;;AACA,+BAA+B;AAE/B,0CAAuC;AACvC,sDAAmD;AAEnD,6CAA0C;AAE1C,MAAM,MAAM,GAAG,IAAA,yBAAW,EAAC,UAAU,CAAC,CAAC,MAAM,EAAE,CAAC;AAChD,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;;IACrB,KAAK,CAAC,MAAM,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,CAAC,CAAC;IAC7B,IAAI,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC;QACvB,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,GAAG;YACV,YAAY,EAAE,IAAI;YAClB,QAAQ,EAAE,+DAA+D;SAC1E;QACD,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,SAAS;YAClB,QAAQ,EAAE,kEAAkE;SAC7E;QACD,SAAS,EAAE;YACT,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,kFAAkF;SAC7F;QACD,KAAK,EAAE;YACL,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,CAAC,QAAQ,CAAC;YACnB,QAAQ,EACN,sHAAsH;gBACtH,4HAA4H;gBAC5H,0IAA0I;SAC7I;QACD,eAAe,EAAE;YACf,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,QAAQ;YACjB,OAAO,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,gBAAgB,EAAE,SAAS,CAAC;YAC3D,QAAQ,EACN,4EAA4E;gBAC5E,yEAAyE;SAC5E;QACD,SAAS,EAAE;YACT,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,KAAK;YACd,QAAQ,EAAE,0DAA0D;SACrE;QACD,gBAAgB,EAAE;YAChB,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,eAAe;YACxB,QAAQ,EAAE,qEAAqE;SAChF;QACD,YAAY,EAAE;YACZ,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;YACb,QAAQ,EACN,sGAAsG;gBACtG,kHAAkH;gBAClH,0GAA0G;gBAC1G,iDAAiD;SACpD;QACD,YAAY,EAAE;YACZ,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,eAAe;YACxB,QAAQ,EAAE,iGAAiG;SAC5G;QACD,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,qFAAqF;YAC/F,OAAO,EAAE,SAAS;SACnB;QACD,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,QAAQ,EACN,+HAA+H;gBAC/H,iFAAiF;SACpF;QACD,eAAe,EAAE;YACf,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,qGAAqG;YAC/G,OAAO,EAAE,SAAS;SACnB;QACD,yBAAyB,EAAE;YACzB,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,yCAAyC;YACnD,OAAO,EAAE,KAAK;SACf;QACD,eAAe,EAAE;YACf,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,kGAAkG;YAC5G,OAAO,EAAE,KAAK;SACf;QACD,oBAAoB,EAAE;YACpB,IAAI,EAAE,QAAQ;YACd,QAAQ,EACN,oNAAoN;SACvN;KACF,CAAC,CAAC,IAAI,CAAC;IAER,IAAI,MAAM,EAAE;QACV,IAAI,mCAAQ,MAAM,CAAC,MAAM,GAAK,IAAI,CAAE,CAAC;KACtC;IAED,mBAAQ,CAAC,KAAK,CAAC;QACb,eAAe,EAAE,IAAI,CAAC,SAAS;QAC/B,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,eAAe,EAAE,IAAI,CAAC,eAAmC;QACzD,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;QACvC,YAAY,EAAE,IAAI,CAAC,YAAY;QAC/B,YAAY,EAAE,IAAI,CAAC,YAAY;QAC/B,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,eAAe,EAAE,IAAI,CAAC,eAAe;QACrC,yBAAyB,EAAE,IAAI,CAAC,yBAAyB;QACzD,eAAe,EAAE,IAAI,CAAC,eAAe;QACrC,OAAO,EAAE,IAAI,CAAC,oBAAoB;QAClC,cAAc,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,0CAAE,cAAc;QAC9C,iBAAiB,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,0CAAE,iBAAiB;QACpD,iBAAiB,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,0CAAE,iBAAiB;KACrD,CAAC,CAAC;IAEH,IAAI;QACF,mBAAQ,CAAC,QAAQ,EAAE,CAAC;KACrB;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACrB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;AACH,CAAC,CAAC,CAAC"}

package/lib/index.d.ts

@@ -0,0 +1 @@
+export * from './service/manifest-factory';

package/lib/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./service/manifest-factory"), exports);
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6DAA2C"}

package/lib/model/apex-bundle.d.ts

@@ -0,0 +1,6 @@
+export default class ApexBundle {
+    filePath: string;
+    rawTypeContent: string;
+    rawMetadataContent: string | null;
+    constructor(filePath: string, rawTypeContent: string, rawMetadataContent: string | null);
+}

package/lib/model/apex-bundle.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class ApexBundle {
+    constructor(filePath, rawTypeContent, rawMetadataContent) {
+        this.filePath = filePath;
+        this.rawTypeContent = rawTypeContent;
+        this.rawMetadataContent = rawMetadataContent;
+    }
+}
+exports.default = ApexBundle;
+//# sourceMappingURL=apex-bundle.js.map

package/lib/model/apex-bundle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"apex-bundle.js","sourceRoot":"","sources":["../../src/model/apex-bundle.ts"],"names":[],"mappings":";;AAAA,MAAqB,UAAU;IAC7B,YAAmB,QAAgB,EAAS,cAAsB,EAAS,kBAAiC;QAAzF,aAAQ,GAAR,QAAQ,CAAQ;QAAS,mBAAc,GAAd,cAAc,CAAQ;QAAS,uBAAkB,GAAlB,kBAAkB,CAAe;IAAG,CAAC;CACjH;AAFD,6BAEC"}

package/lib/model/apex-type-wrappers/ClassMirrorWrapper.d.ts

@@ -0,0 +1,7 @@
+import { ClassMirror, MethodMirror } from '@cparra/apex-reflection';
+export declare class ClassMirrorWrapper {
+    classMirror: ClassMirror;
+    constructor(classMirror: ClassMirror);
+    getMethodsByAnnotation(annotation: string): MethodMirror[];
+    private hasAnnotation;
+}

package/lib/model/apex-type-wrappers/ClassMirrorWrapper.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClassMirrorWrapper = void 0;
+class ClassMirrorWrapper {
+    constructor(classMirror) {
+        this.classMirror = classMirror;
+        this.hasAnnotation = (method, annotationName) => method.annotations.some((annotation) => annotation.name.toLowerCase() === annotationName);
+    }
+    getMethodsByAnnotation(annotation) {
+        return this.classMirror.methods.filter((method) => this.hasAnnotation(method, annotation));
+    }
+}
+exports.ClassMirrorWrapper = ClassMirrorWrapper;
+//# sourceMappingURL=ClassMirrorWrapper.js.map

package/lib/model/apex-type-wrappers/ClassMirrorWrapper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ClassMirrorWrapper.js","sourceRoot":"","sources":["../../../src/model/apex-type-wrappers/ClassMirrorWrapper.ts"],"names":[],"mappings":";;;AAEA,MAAa,kBAAkB;IAC7B,YAAmB,WAAwB;QAAxB,gBAAW,GAAX,WAAW,CAAa;QAMnC,kBAAa,GAAG,CAAC,MAAoB,EAAE,cAAsB,EAAE,EAAE,CACvE,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,cAAc,CAAC,CAAC;IAP9C,CAAC;IAE/C,sBAAsB,CAAC,UAAkB;QACvC,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC;IAC7F,CAAC;CAIF;AATD,gDASC"}

package/lib/model/apex-type-wrappers/MethodMirrorWrapper.d.ts

@@ -0,0 +1,7 @@
+import { DocCommentAnnotation, MethodMirror } from '@cparra/apex-reflection';
+export declare class MethodMirrorWrapper {
+    methodMirror: MethodMirror;
+    constructor(methodMirror: MethodMirror);
+    hasDocCommentAnnotation: (annotationName: string) => boolean | undefined;
+    getDocCommentAnnotation: (annotationName: string) => DocCommentAnnotation | undefined;
+}

package/lib/model/apex-type-wrappers/MethodMirrorWrapper.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MethodMirrorWrapper = void 0;
+class MethodMirrorWrapper {
+    constructor(methodMirror) {
+        this.methodMirror = methodMirror;
+        this.hasDocCommentAnnotation = (annotationName) => { var _a; return (_a = this.methodMirror.docComment) === null || _a === void 0 ? void 0 : _a.annotations.some((annotation) => annotation.name.toLowerCase() === annotationName); };
+        this.getDocCommentAnnotation = (annotationName) => { var _a; return (_a = this.methodMirror.docComment) === null || _a === void 0 ? void 0 : _a.annotations.find((annotation) => annotation.name.toLowerCase() === annotationName); };
+    }
+}
+exports.MethodMirrorWrapper = MethodMirrorWrapper;
+//# sourceMappingURL=MethodMirrorWrapper.js.map

package/lib/model/apex-type-wrappers/MethodMirrorWrapper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MethodMirrorWrapper.js","sourceRoot":"","sources":["../../../src/model/apex-type-wrappers/MethodMirrorWrapper.ts"],"names":[],"mappings":";;;AAEA,MAAa,mBAAmB;IAC9B,YAAmB,YAA0B;QAA1B,iBAAY,GAAZ,YAAY,CAAc;QAEtC,4BAAuB,GAAG,CAAC,cAAsB,EAAE,EAAE,WAC1D,OAAA,MAAA,IAAI,CAAC,YAAY,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,cAAc,CAAC,CAAA,EAAA,CAAC;QAE5G,4BAAuB,GAAG,CAAC,cAAsB,EAAoC,EAAE,WAC5F,OAAA,MAAA,IAAI,CAAC,YAAY,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,cAAc,CAAC,CAAA,EAAA,CAAC;IANnE,CAAC;CAOlD;AARD,kDAQC"}

package/lib/model/inheritance.d.ts

@@ -0,0 +1,8 @@
+import { FieldMirror, MethodMirror, PropertyMirror } from '@cparra/apex-reflection';
+export type InheritanceSupport = {
+    inherited: boolean;
+};
+export type FieldMirrorWithInheritance = FieldMirror & InheritanceSupport;
+export type PropertyMirrorWithInheritance = PropertyMirror & InheritanceSupport;
+export type MethodMirrorWithInheritance = MethodMirror & InheritanceSupport;
+export type FieldOrProperty = FieldMirrorWithInheritance | PropertyMirrorWithInheritance;

package/lib/model/inheritance.js

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

package/lib/model/inheritance.js.map

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

package/lib/model/manifest-diff.d.ts

@@ -0,0 +1,27 @@
+import Manifest from './manifest';
+import { Type } from '@cparra/apex-reflection';
+import { Annotation } from '@cparra/apex-reflection/index';
+export declare class ManifestDiff {
+    added: Type[];
+    deleted: Type[];
+    changes: DiffChange[];
+    static build(originalManifest: Manifest, newManifest: Manifest): ManifestDiff;
+}
+declare class DiffChange {
+    originalType: Type;
+    newType: Type;
+    accessModifierChange?: AccessModifierChange;
+    annotationChanges: AnnotationChange[];
+    constructor(originalType: Type, newType: Type);
+    hasChanges(): boolean;
+    private parse;
+}
+interface AccessModifierChange {
+    oldAccessModifier: string;
+    newAccessModifier: string;
+}
+interface AnnotationChange {
+    annotation: Annotation;
+    type: 'added' | 'removed';
+}
+export {};

package/lib/model/manifest-diff.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ManifestDiff = void 0;
+class ManifestDiff {
+    constructor() {
+        this.added = [];
+        this.deleted = [];
+        this.changes = [];
+    }
+    static build(originalManifest, newManifest) {
+        const addedTypes = newManifest.types.filter((currentType) => !originalManifest.types.find((originalType) => currentType.name === originalType.name));
+        const deletedTypes = originalManifest.types.filter((currentType) => !newManifest.types.find((newType) => currentType.name === newType.name));
+        const changes = [];
+        for (const newType of newManifest.types) {
+            const oldType = originalManifest.types.find((oldType) => oldType.name === newType.name);
+            if (!oldType) {
+                continue;
+            }
+            const change = new DiffChange(oldType, newType);
+            if (change.hasChanges()) {
+                changes.push(change);
+            }
+        }
+        const diff = new ManifestDiff();
+        diff.added = addedTypes;
+        diff.deleted = deletedTypes;
+        diff.changes = changes;
+        return diff;
+    }
+}
+exports.ManifestDiff = ManifestDiff;
+class DiffChange {
+    constructor(originalType, newType) {
+        this.originalType = originalType;
+        this.newType = newType;
+        this.annotationChanges = [];
+        this.parse();
+    }
+    hasChanges() {
+        return !!this.accessModifierChange || this.annotationChanges.length > 0;
+    }
+    parse() {
+        // Access modifier changes
+        if (this.originalType.access_modifier !== this.newType.access_modifier) {
+            this.accessModifierChange = {
+                oldAccessModifier: this.originalType.access_modifier,
+                newAccessModifier: this.newType.access_modifier,
+            };
+        }
+        // Annotation changes
+        const addedAnnotations = this.newType.annotations.filter((currentAnnotation) => !this.originalType.annotations.find((originalAnnotation) => currentAnnotation.name === originalAnnotation.name));
+        const removedAnnotations = this.originalType.annotations.filter((currentAnnotation) => !this.newType.annotations.find((newAnnotation) => currentAnnotation.name === newAnnotation.name));
+        const annotationChangeMapper = (annotation, changeType) => {
+            return {
+                annotation: annotation,
+                type: changeType,
+            };
+        };
+        this.annotationChanges = [
+            ...addedAnnotations.map((annotation) => {
+                return annotationChangeMapper(annotation, 'added');
+            }),
+            ...removedAnnotations.map((annotation) => {
+                return annotationChangeMapper(annotation, 'removed');
+            }),
+        ];
+    }
+}
+//# sourceMappingURL=manifest-diff.js.map

package/lib/model/manifest-diff.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"manifest-diff.js","sourceRoot":"","sources":["../../src/model/manifest-diff.ts"],"names":[],"mappings":";;;AAIA,MAAa,YAAY;IAAzB;QACE,UAAK,GAAW,EAAE,CAAC;QACnB,YAAO,GAAW,EAAE,CAAC;QACrB,YAAO,GAAiB,EAAE,CAAC;IA6B7B,CAAC;IA3BC,MAAM,CAAC,KAAK,CAAC,gBAA0B,EAAE,WAAqB;QAC5D,MAAM,UAAU,GAAG,WAAW,CAAC,KAAK,CAAC,MAAM,CACzC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,KAAK,YAAY,CAAC,IAAI,CAAC,CACxG,CAAC;QACF,MAAM,YAAY,GAAG,gBAAgB,CAAC,KAAK,CAAC,MAAM,CAChD,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CACzF,CAAC;QAEF,MAAM,OAAO,GAAiB,EAAE,CAAC;QACjC,KAAK,MAAM,OAAO,IAAI,WAAW,CAAC,KAAK,EAAE;YACvC,MAAM,OAAO,GAAG,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;YACxF,IAAI,CAAC,OAAO,EAAE;gBACZ,SAAS;aACV;YAED,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAChD,IAAI,MAAM,CAAC,UAAU,EAAE,EAAE;gBACvB,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;aACtB;SACF;QAED,MAAM,IAAI,GAAG,IAAI,YAAY,EAAE,CAAC;QAChC,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC;QACxB,IAAI,CAAC,OAAO,GAAG,YAAY,CAAC;QAC5B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAhCD,oCAgCC;AAED,MAAM,UAAU;IAId,YAAmB,YAAkB,EAAS,OAAa;QAAxC,iBAAY,GAAZ,YAAY,CAAM;QAAS,YAAO,GAAP,OAAO,CAAM;QAF3D,sBAAiB,GAAuB,EAAE,CAAC;QAGzC,IAAI,CAAC,KAAK,EAAE,CAAC;IACf,CAAC;IAEM,UAAU;QACf,OAAO,CAAC,CAAC,IAAI,CAAC,oBAAoB,IAAI,IAAI,CAAC,iBAAiB,CAAC,MAAM,GAAG,CAAC,CAAC;IAC1E,CAAC;IAEO,KAAK;QACX,0BAA0B;QAC1B,IAAI,IAAI,CAAC,YAAY,CAAC,eAAe,KAAK,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE;YACtE,IAAI,CAAC,oBAAoB,GAAG;gBAC1B,iBAAiB,EAAE,IAAI,CAAC,YAAY,CAAC,eAAe;gBACpD,iBAAiB,EAAE,IAAI,CAAC,OAAO,CAAC,eAAe;aAChD,CAAC;SACH;QAED,qBAAqB;QACrB,MAAM,gBAAgB,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,MAAM,CACtD,CAAC,iBAAiB,EAAE,EAAE,CACpB,CAAC,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,kBAAkB,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,KAAK,kBAAkB,CAAC,IAAI,CAAC,CAClH,CAAC;QACF,MAAM,kBAAkB,GAAG,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,MAAM,CAC7D,CAAC,iBAAiB,EAAE,EAAE,CACpB,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,KAAK,aAAa,CAAC,IAAI,CAAC,CACnG,CAAC;QACF,MAAM,sBAAsB,GAAG,CAAC,UAAsB,EAAE,UAA+B,EAAE,EAAE;YACzF,OAAO;gBACL,UAAU,EAAE,UAAU;gBACtB,IAAI,EAAE,UAAU;aACG,CAAC;QACxB,CAAC,CAAC;QACF,IAAI,CAAC,iBAAiB,GAAG;YACvB,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE;gBACrC,OAAO,sBAAsB,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;YACrD,CAAC,CAAC;YACF,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE;gBACvC,OAAO,sBAAsB,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;YACvD,CAAC,CAAC;SACH,CAAC;IACJ,CAAC;CACF"}

package/lib/model/manifest.d.ts

@@ -0,0 +1,22 @@
+import { Type, Annotation, DocComment } from '@cparra/apex-reflection';
+type AccessAndDocAware = {
+    access_modifier: string;
+    annotations: Annotation[];
+    docComment?: DocComment;
+};
+/**
+ * Represents the full library of Apex top-level types (classes, enums, and interface) for a Salesforce project.
+ */
+export default class Manifest {
+    types: Type[];
+    isForInnerTypes: boolean;
+    /**
+     * Constructs a new Manifest object.
+     * @param types List of types to be wrapped by this object.
+     * @param isForInnerTypes Whether this manifest represent an inner type or not.
+     */
+    constructor(types: Type[], isForInnerTypes?: boolean);
+    filteredByAccessModifierAndAnnotations(modifiers: string[]): Type[];
+    filterAccessibleModifier(accessAndDocAwares: AccessAndDocAware[], modifiers: string[]): AccessAndDocAware[];
+}
+export {};