@cparra/apexdocs 3.15.0 → 3.15.1

package/dist/cli/generate.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 'use strict';
 
-var logger$1 = require('../logger-Cqxjp5OT.js');
+var logger$1 = require('../logger-BPNUptnX.js');
 var cosmiconfig = require('cosmiconfig');
 var yargs = require('yargs');
 var E = require('fp-ts/Either');

package/dist/index.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 'use strict';
 
-var logger = require('./logger-Cqxjp5OT.js');
+var logger = require('./logger-BPNUptnX.js');
 var E = require('fp-ts/Either');
 require('fp-ts/function');
 require('fp-ts/TaskEither');

package/dist/{logger-Cqxjp5OT.js → logger-BPNUptnX.js}

@@ -5167,18 +5167,19 @@ function getLightningComponentBundleSourceComponents(sourceComponents) {
 }
 function toUnparsedApexBundle(fileSystem, apexSourceComponents) {
   return apexSourceComponents.map((component) => {
-    const apexComponentTuple = [
-      fileSystem.readFile(component.contentPath),
-      component.xmlPath ? fileSystem.readFile(component.xmlPath) : null
-    ];
+    const content = fileSystem.readFile(component.contentPath);
+    if (content === null) {
+      return null;
+    }
+    const metadataContent = component.xmlPath ? fileSystem.readFile(component.xmlPath) : null;
     return {
       type: "apex",
       name: component.name,
       filePath: component.contentPath,
-      content: apexComponentTuple[0],
-      metadataContent: apexComponentTuple[1]
+      content,
+      metadataContent
     };
-  });
+  }).filter((bundle) => bundle !== null);
 }
 function getTriggerSourceComponents(sourceComponents) {
   return sourceComponents.filter((component) => component.type.name === "ApexTrigger").map((component) => ({
@@ -5188,12 +5189,18 @@ function getTriggerSourceComponents(sourceComponents) {
   }));
 }
 function toUnparsedTriggerBundle(fileSystem, triggerSourceComponents) {
-  return triggerSourceComponents.map((component) => ({
-    type: "trigger",
-    name: component.name,
-    filePath: component.contentPath,
-    content: fileSystem.readFile(component.contentPath)
-  }));
+  return triggerSourceComponents.map((component) => {
+    const content = fileSystem.readFile(component.contentPath);
+    if (content === null) {
+      return null;
+    }
+    return {
+      type: "trigger",
+      name: component.name,
+      filePath: component.contentPath,
+      content
+    };
+  }).filter((bundle) => bundle !== null);
 }
 function getCustomObjectSourceComponents(sourceComponents) {
   return sourceComponents.filter((component) => component.type.name === "CustomObject").map((component) => ({
@@ -5204,13 +5211,17 @@ function getCustomObjectSourceComponents(sourceComponents) {
 }
 function toUnparsedSObjectBundle(fileSystem, customObjectSourceComponents) {
   return customObjectSourceComponents.map((component) => {
+    const content = fileSystem.readFile(component.contentPath);
+    if (content === null) {
+      return null;
+    }
     return {
       type: "customobject",
       name: component.name,
       filePath: component.contentPath,
-      content: fileSystem.readFile(component.contentPath)
+      content
     };
-  });
+  }).filter((bundle) => bundle !== null);
 }
 function getCustomFieldSourceComponents(sourceComponents) {
   return sourceComponents.filter((component) => component.type.name === "CustomField").map((component) => ({
@@ -5221,13 +5232,19 @@ function getCustomFieldSourceComponents(sourceComponents) {
   }));
 }
 function toUnparsedCustomFieldBundle(fileSystem, customFieldSourceComponents) {
-  return customFieldSourceComponents.map((component) => ({
-    type: "customfield",
-    name: component.name,
-    filePath: component.contentPath,
-    content: fileSystem.readFile(component.contentPath),
-    parentName: component.parentName
-  }));
+  return customFieldSourceComponents.map((component) => {
+    const content = fileSystem.readFile(component.contentPath);
+    if (content === null) {
+      return null;
+    }
+    return {
+      type: "customfield",
+      name: component.name,
+      filePath: component.contentPath,
+      content,
+      parentName: component.parentName
+    };
+  }).filter((bundle) => bundle !== null);
 }
 function getCustomMetadataSourceComponents(sourceComponents) {
   function getParentAndNamePair(component) {
@@ -5243,25 +5260,38 @@ function getCustomMetadataSourceComponents(sourceComponents) {
   }));
 }
 function toUnparsedCustomMetadataBundle(fileSystem, customMetadataSourceComponents) {
-  return customMetadataSourceComponents.map((component) => ({
-    apiName: component.apiName,
-    type: "custommetadata",
-    name: component.name,
-    filePath: component.contentPath,
-    content: fileSystem.readFile(component.contentPath),
-    parentName: component.parentName
-  }));
+  return customMetadataSourceComponents.map((component) => {
+    const content = fileSystem.readFile(component.contentPath);
+    if (content === null) {
+      return null;
+    }
+    return {
+      apiName: component.apiName,
+      type: "custommetadata",
+      name: component.name,
+      filePath: component.contentPath,
+      content,
+      parentName: component.parentName
+    };
+  }).filter((bundle) => bundle !== null);
 }
 function toUnparsedLWCBundle(fileSystem, lwcSourceComponents) {
-  return lwcSourceComponents.map((component) => ({
-    type: "lwc",
-    name: component.name,
-    filePath: component.contentPath,
-    content: fileSystem.readFile(component.contentPath),
-    metadataContent: fileSystem.readFile(component.xmlPath)
-  }));
+  return lwcSourceComponents.map((component) => {
+    const content = fileSystem.readFile(component.contentPath);
+    const metadataContent = fileSystem.readFile(component.xmlPath);
+    if (content === null || metadataContent === null) {
+      return null;
+    }
+    return {
+      type: "lwc",
+      name: component.name,
+      filePath: component.contentPath,
+      content,
+      metadataContent
+    };
+  }).filter((bundle) => bundle !== null);
 }
-function processFiles(fileSystem) {
+function processFiles(fileSystem, config) {
   return (componentTypesToRetrieve, options = { includeMetadata: false }) => {
     const converters = {
       ApexClass: _function.flow(
@@ -5285,7 +5315,7 @@ function processFiles(fileSystem) {
         (triggerSourceComponents) => toUnparsedTriggerBundle(fileSystem, triggerSourceComponents)
       ),
       LightningComponentBundle: _function.flow(
-        getLightningComponentBundleSourceComponents,
+        config.experimentalLwcSupport ? getLightningComponentBundleSourceComponents : () => [],
         (lwcSourceComponents) => toUnparsedLWCBundle(fileSystem, lwcSourceComponents)
       )
     };
@@ -5336,7 +5366,11 @@ class DefaultFileSystem {
     return [...components, ...fieldComponents];
   }
   readFile(pathToRead) {
-    return fs__namespace.readFileSync(pathToRead, "utf8");
+    try {
+      return fs__namespace.readFileSync(pathToRead, "utf8");
+    } catch (error) {
+      return null;
+    }
   }
 }
 
@@ -5509,7 +5543,7 @@ class Apexdocs {
     });
   }
 }
-const readFiles = processFiles(new DefaultFileSystem());
+const readFiles = apply(processFiles, new DefaultFileSystem());
 function processMarkdown(config) {
   return __async(this, null, function* () {
     return _function.pipe(
@@ -5517,7 +5551,7 @@ function processMarkdown(config) {
       E__namespace.mapLeft((error) => new FileReadingError(`Failed to resolve source directories: ${error.message}`, error)),
       E__namespace.flatMap(
         (sourceDirs) => E__namespace.tryCatch(
-          () => readFiles(allComponentTypes, {
+          () => readFiles({ experimentalLwcSupport: config.experimentalLwcSupport })(allComponentTypes, {
             includeMetadata: config.includeMetadata
           })(sourceDirs, config.exclude),
           (e) => new FileReadingError("An error occurred while reading files.", e)
@@ -5539,7 +5573,10 @@ function processOpenApi(config, logger) {
       TE__namespace.flatMap(
         (sourceDirs) => TE__namespace.tryCatch(
           () => {
-            const fileBodies = readFiles(["ApexClass"])(sourceDirs, config.exclude);
+            const fileBodies = readFiles({ experimentalLwcSupport: false })(["ApexClass"])(
+              sourceDirs,
+              config.exclude
+            );
             return openApi(logger, fileBodies, config);
           },
           (e) => new FileReadingError("An error occurred while generating OpenAPI documentation.", e)
@@ -5578,8 +5615,8 @@ function processChangeLog(config) {
           )
         ),
         E__namespace.map(({ previousVersionDirs, currentVersionDirs }) => [
-          readFiles(allComponentTypes)(previousVersionDirs, config.exclude),
-          readFiles(allComponentTypes)(currentVersionDirs, config.exclude)
+          readFiles({ experimentalLwcSupport: false })(allComponentTypes)(previousVersionDirs, config.exclude),
+          readFiles({ experimentalLwcSupport: false })(allComponentTypes)(currentVersionDirs, config.exclude)
         ])
       );
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cparra/apexdocs",
-  "version": "3.15.0",
+  "version": "3.15.1",
   "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
   "keywords": [
     "apex",
@@ -102,7 +102,7 @@
     "fast-xml-parser": "^4.4.0",
     "fp-ts": "^2.16.8",
     "handlebars": "^4.7.8",
-    "js-yaml": "^4.1.0",
+    "js-yaml": "4.1.1",
     "minimatch": "^10.0.1",
     "yargs": "^17.7.2"
   },