@cparra/apexdocs 2.23.0 → 2.24.0

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

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

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

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

package/lib/service/file-system.js

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

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

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

package/lib/service/file-writer.js

@@ -1,34 +1,34 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FileWriter = void 0;
-const fs = require("fs");
-const path = require("path");
-const settings_1 = require("../settings");
-class FileWriter {
-    static write(files, onWriteCallback) {
-        const onBeforeFileWrite = (file) => settings_1.Settings.getInstance().onBeforeFileWrite(file);
-        files.forEach((file) => {
-            const resolvedFile = this.getTargetLocation(file, onBeforeFileWrite);
-            const fullDir = path.join(resolvedFile.dir.baseDir, resolvedFile.dir.fileDir);
-            if (!fs.existsSync(fullDir)) {
-                fs.mkdirSync(fullDir, { recursive: true });
-            }
-            const filePath = path.join(fullDir, `${resolvedFile.name}${resolvedFile.extension}`);
-            fs.writeFileSync(filePath, file.body, 'utf8');
-            onWriteCallback(resolvedFile);
-        });
-    }
-    static getTargetLocation(file, onBeforeFileWrite) {
-        const targetFile = {
-            name: file.fileName,
-            extension: file.fileExtension(),
-            dir: {
-                baseDir: settings_1.Settings.getInstance().outputDir,
-                fileDir: file.dir,
-            },
-        };
-        return onBeforeFileWrite(targetFile);
-    }
-}
-exports.FileWriter = FileWriter;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileWriter = void 0;
+const fs = require("fs");
+const path = require("path");
+const settings_1 = require("../settings");
+class FileWriter {
+    static write(files, onWriteCallback) {
+        const onBeforeFileWrite = (file) => settings_1.Settings.getInstance().onBeforeFileWrite(file);
+        files.forEach((file) => {
+            const resolvedFile = this.getTargetLocation(file, onBeforeFileWrite);
+            const fullDir = path.join(resolvedFile.dir.baseDir, resolvedFile.dir.fileDir);
+            if (!fs.existsSync(fullDir)) {
+                fs.mkdirSync(fullDir, { recursive: true });
+            }
+            const filePath = path.join(fullDir, `${resolvedFile.name}${resolvedFile.extension}`);
+            fs.writeFileSync(filePath, file.body, 'utf8');
+            onWriteCallback(resolvedFile);
+        });
+    }
+    static getTargetLocation(file, onBeforeFileWrite) {
+        const targetFile = {
+            name: file.fileName,
+            extension: file.fileExtension(),
+            dir: {
+                baseDir: settings_1.Settings.getInstance().outputDir,
+                fileDir: file.dir,
+            },
+        };
+        return onBeforeFileWrite(targetFile);
+    }
+}
+exports.FileWriter = FileWriter;
 //# sourceMappingURL=file-writer.js.map

package/lib/service/manifest-factory.d.ts

@@ -1,10 +1,10 @@
-import Manifest from '../model/manifest';
-import { TypeParser } from './parser';
-import { ReflectionResult } from '@cparra/apex-reflection';
-import ApexBundle from '../model/apex-bundle';
-/**
- * Builds a new Manifest object, sourcing its types from the received TypeParser.
- * @param typeParser In charge of returning the list of reflected types.
- * @param reflect Reflection function.
- */
-export declare function createManifest(typeParser: TypeParser, reflect: (apexBundle: ApexBundle) => ReflectionResult): Manifest;
+import Manifest from '../model/manifest';
+import { TypeParser } from './parser';
+import { ReflectionResult } from '@cparra/apex-reflection';
+import ApexBundle from '../model/apex-bundle';
+/**
+ * Builds a new Manifest object, sourcing its types from the received TypeParser.
+ * @param typeParser In charge of returning the list of reflected types.
+ * @param reflect Reflection function.
+ */
+export declare function createManifest(typeParser: TypeParser, reflect: (apexBundle: ApexBundle) => ReflectionResult): Manifest;

package/lib/service/manifest-factory.js

@@ -1,14 +1,14 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createManifest = void 0;
-const manifest_1 = require("../model/manifest");
-/**
- * Builds a new Manifest object, sourcing its types from the received TypeParser.
- * @param typeParser In charge of returning the list of reflected types.
- * @param reflect Reflection function.
- */
-function createManifest(typeParser, reflect) {
-    return new manifest_1.default(typeParser.parse(reflect));
-}
-exports.createManifest = createManifest;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createManifest = void 0;
+const manifest_1 = require("../model/manifest");
+/**
+ * Builds a new Manifest object, sourcing its types from the received TypeParser.
+ * @param typeParser In charge of returning the list of reflected types.
+ * @param reflect Reflection function.
+ */
+function createManifest(typeParser, reflect) {
+    return new manifest_1.default(typeParser.parse(reflect));
+}
+exports.createManifest = createManifest;
 //# sourceMappingURL=manifest-factory.js.map

package/lib/service/metadata-processor.d.ts

@@ -1,3 +1,3 @@
-export default class MetadataProcessor {
-    static process(input: string): Map<string, string>;
-}
+export default class MetadataProcessor {
+    static process(input: string): Map<string, string>;
+}

package/lib/service/metadata-processor.js

@@ -1,17 +1,17 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const fast_xml_parser_1 = require("fast-xml-parser");
-class MetadataProcessor {
-    static process(input) {
-        var _a;
-        const map = new Map();
-        const xml = new fast_xml_parser_1.XMLParser().parse(input);
-        map.set('apiVersion', (_a = xml.ApexClass.apiVersion) !== null && _a !== void 0 ? _a : '');
-        if (xml.ApexClass.status) {
-            map.set('status', xml.ApexClass.status);
-        }
-        return map;
-    }
-}
-exports.default = MetadataProcessor;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const fast_xml_parser_1 = require("fast-xml-parser");
+class MetadataProcessor {
+    static process(input) {
+        var _a;
+        const map = new Map();
+        const xml = new fast_xml_parser_1.XMLParser().parse(input);
+        map.set('apiVersion', (_a = xml.ApexClass.apiVersion) !== null && _a !== void 0 ? _a : '');
+        if (xml.ApexClass.status) {
+            map.set('status', xml.ApexClass.status);
+        }
+        return map;
+    }
+}
+exports.default = MetadataProcessor;
 //# sourceMappingURL=metadata-processor.js.map

package/lib/service/parser.d.ts

@@ -1,21 +1,21 @@
-import { ClassMirror, InterfaceMirror, ReflectionResult, Type } from '@cparra/apex-reflection';
-import ApexBundle from '../model/apex-bundle';
-export interface TypeParser {
-    parse(reflect: (apexBundle: ApexBundle) => ReflectionResult): Type[];
-}
-type NameAware = {
-    name: string;
-};
-export declare class RawBodyParser implements TypeParser {
-    typeBundles: ApexBundle[];
-    constructor(typeBundles: ApexBundle[]);
-    parse(reflect: (apexBundle: ApexBundle) => ReflectionResult): Type[];
-    addFieldsFromParent(types: Type[]): Type[];
-    addMembersFromParent(currentClass: ClassMirror, allTypes: Type[]): ClassMirror;
-    addMethodsFromParent(currentInterface: InterfaceMirror, allTypes: Type[]): InterfaceMirror;
-    private getInheritedFields;
-    private getInheritedProperties;
-    private getInheritedMethods;
-    memberExists(members: NameAware[], fieldName: string): boolean;
-}
-export {};
+import { ClassMirror, InterfaceMirror, ReflectionResult, Type } from '@cparra/apex-reflection';
+import ApexBundle from '../model/apex-bundle';
+export interface TypeParser {
+    parse(reflect: (apexBundle: ApexBundle) => ReflectionResult): Type[];
+}
+type NameAware = {
+    name: string;
+};
+export declare class RawBodyParser implements TypeParser {
+    typeBundles: ApexBundle[];
+    constructor(typeBundles: ApexBundle[]);
+    parse(reflect: (apexBundle: ApexBundle) => ReflectionResult): Type[];
+    addFieldsFromParent(types: Type[]): Type[];
+    addMembersFromParent(currentClass: ClassMirror, allTypes: Type[]): ClassMirror;
+    addMethodsFromParent(currentInterface: InterfaceMirror, allTypes: Type[]): InterfaceMirror;
+    private getInheritedFields;
+    private getInheritedProperties;
+    private getInheritedMethods;
+    memberExists(members: NameAware[], fieldName: string): boolean;
+}
+export {};