doc-detective-common 1.21.0 → 1.21.1-dev.1

package/src/files.js

@@ -1,64 +1,64 @@
-const fs = require("fs");
-const YAML = require("yaml");
-const axios = require("axios");
-const { URL } = require("url");
-
-/**
- * Reads a file from a given URL or local file path and returns its content.
- * Supports JSON and YAML file formats.
- *
- * @param {string} fileURL - The URL or local file path of the file to read.
- * @returns {Promise<Object|string|null>} - The parsed content of the file if it's JSON or YAML, 
- *                                          the raw content if it's another format, 
- *                                          or null if an error occurs.
- */
-async function readFile(fileURL) {
-
-  let content;
-  let isRemote = false;
-
-  try {
-    const parsedURL = new URL(fileURL);
-    isRemote = parsedURL.protocol === "http:" || parsedURL.protocol === "https:";
-  } catch (error) {
-    // Not a valid URL, assume local file path
-  }
-
-  if (isRemote) {
-    try {
-      const response = await axios.get(fileURL);
-      content = response.data;
-    } catch (error) {
-      console.warn(`Error reading remote file from ${fileURL}: ${error.message}`);
-      return null;
-    }
-  } else {  
-    try {  
-      content = await fs.promises.readFile(fileURL, "utf8");  
-    } catch (error) {  
-      if (error.code === 'ENOENT') {  
-        console.warn(`File not found: ${fileURL}`);  
-      } else {  
-        console.warn(`Error reading file: ${error.message}`);  
-      }  
-      return null;  
-    }  
-  }
-
-  // Parse based on file content, and return either object or string
-  try {
-    // Try to parse as JSON
-    return JSON.parse(content);
-  } catch (error) {
-    try {
-      // Try to parse as YAML
-      return YAML.parse(content);
-    } catch (error) {
-      // Return raw content if not JSON or YAML
-      return content;
-    }
-  }
-
-}
-
-module.exports = { readFile };
+const fs = require("fs");
+const YAML = require("yaml");
+const axios = require("axios");
+const { URL } = require("url");
+
+/**
+ * Reads a file from a given URL or local file path and returns its content.
+ * Supports JSON and YAML file formats.
+ *
+ * @param {string} fileURL - The URL or local file path of the file to read.
+ * @returns {Promise<Object|string|null>} - The parsed content of the file if it's JSON or YAML, 
+ *                                          the raw content if it's another format, 
+ *                                          or null if an error occurs.
+ */
+async function readFile(fileURL) {
+
+  let content;
+  let isRemote = false;
+
+  try {
+    const parsedURL = new URL(fileURL);
+    isRemote = parsedURL.protocol === "http:" || parsedURL.protocol === "https:";
+  } catch (error) {
+    // Not a valid URL, assume local file path
+  }
+
+  if (isRemote) {
+    try {
+      const response = await axios.get(fileURL);
+      content = response.data;
+    } catch (error) {
+      console.warn(`Error reading remote file from ${fileURL}: ${error.message}`);
+      return null;
+    }
+  } else {  
+    try {  
+      content = await fs.promises.readFile(fileURL, "utf8");  
+    } catch (error) {  
+      if (error.code === 'ENOENT') {  
+        console.warn(`File not found: ${fileURL}`);  
+      } else {  
+        console.warn(`Error reading file: ${error.message}`);  
+      }  
+      return null;  
+    }  
+  }
+
+  // Parse based on file content, and return either object or string
+  try {
+    // Try to parse as JSON
+    return JSON.parse(content);
+  } catch (error) {
+    try {
+      // Try to parse as YAML
+      return YAML.parse(content);
+    } catch (error) {
+      // Return raw content if not JSON or YAML
+      return content;
+    }
+  }
+
+}
+
+module.exports = { readFile };

package/src/index.js

@@ -1,11 +1,11 @@
-const { schemas } = require("./schemas");
-const { validate } = require("./validate");
-const { resolvePaths } = require("./resolvePaths");
-const { readFile } = require("./files");
-
-module.exports = {
-  schemas,
-  validate,
-  resolvePaths,
-  readFile,
-};
+const { schemas } = require("./schemas");
+const { validate } = require("./validate");
+const { resolvePaths } = require("./resolvePaths");
+const { readFile } = require("./files");
+
+module.exports = {
+  schemas,
+  validate,
+  resolvePaths,
+  readFile,
+};

package/src/resolvePaths.js

@@ -1,167 +1,167 @@
-const fs = require("fs");
-const path = require("path");
-const { validate } = require("./validate");
-
-exports.resolvePaths = resolvePaths;
-
-/**
- * Resolves paths in config and spec objects based on the provided configuration, object type, object, and source file path.
- *
- * @param {object} config - The configuration object.
- * @param {object} object - The object containing the paths to resolve.
- * @param {string} filePath - The path of the file that contains the relative paths.
- * @param {boolean} [nested=false] - Whether the object is nested within another object.
- * @param {string} [objectType] - The type of object to resolve paths in ("config" or "spec"). Required if the object is nested.
- * @returns {object} - The object with resolved paths.
- */
-async function resolvePaths(
-  config,
-  object,
-  filePath,
-  nested = false,
-  objectType
-) {
-  // Config properties that contain paths
-  const configPaths = [
-    "input",
-    "output",
-    "envVariables",
-    "setup",
-    "cleanup",
-    "mediaDirectory",
-    "downloadDirectory",
-    "descriptionPath",
-    "path",
-  ];
-  // Spec properties that contain paths
-  const specPaths = [
-    "file",
-    "path",
-    "directory",
-    "setup",
-    "cleanup",
-    "savePath",
-    "saveDirectory",
-    "descriptionPath",
-    "workingDirectory",
-  ];
-  // Spec objects that are configurable by the user and shouldn't be resolved
-  const specNoResolve = [
-    "requestData",
-    "responseData",
-    "requestHeaders",
-    "responseHeaders",
-    "requestParams",
-    "responseParams",
-  ];
-
-  /**
-   * Resolves a path based on the provided base type, relative path, and file path.
-   *
-   * @param {string} baseType - The base type of the path ("file" or "cwd").
-   * @param {string} relativePath - The relative path to resolve.
-   * @param {string} filePath - The file path to use as a reference.
-   * @returns {string} - The resolved path.
-   */
-  function resolve(baseType, relativePath, filePath) {
-    // If path is already absolute, return it
-    if (path.isAbsolute(relativePath)) {
-      return relativePath;
-    }
-    // If filePath is a file, use its directory as the base path
-    filePath = fs.lstatSync(filePath).isFile()
-      ? path.dirname(filePath)
-      : filePath;
-    // Resolve the path based on the base type
-    return baseType === "file"
-      ? path.resolve(filePath, relativePath)
-      : path.resolve(relativePath);
-  }
-
-  const relativePathBase = config.relativePathBase;
-
-  let pathProperties;
-  if (!nested && !objectType) {
-    // Check if object matches the config schema
-    const validation = validate("config_v2", { ...object });
-    if (validation.valid) {
-      pathProperties = configPaths;
-      objectType = "config";
-    } else {
-      // Check if object matches the spec schema
-      const validation = validate("spec_v2", { ...object });
-      if (validation.valid) {
-        pathProperties = specPaths;
-        objectType = "spec";
-      } else {
-        throw new Error("Object isn't a valid config or spec.");
-      }
-    }
-  } else if (nested && !objectType) {
-    // If the object is nested, the object type is required
-    throw new Error("Object type is required for nested objects.");
-  } else if (objectType === "config") {
-    // If the object type is config, use configPaths
-    pathProperties = configPaths;
-  } else if (objectType === "spec") {
-    // If the object type is spec, use specPaths
-    pathProperties = specPaths;
-  }
-
-  for (const property of Object.keys(object)) {
-    if (
-      typeof object[property] === "object" &&
-      ((objectType === "spec" && !specNoResolve.includes(property)) ||
-        objectType === "config")
-    ) {
-      // If the property is an object, recursively call resolvePaths to resolve paths within the object
-      object[property] = await resolvePaths(
-        config,
-        object[property],
-        filePath,
-        true,
-        objectType
-      );
-    } else if (typeof object[property] === "string") {
-      // If the property is a string, check if it matches any of the path properties and resolve it if it does
-      pathProperties.forEach((pathProperty) => {
-        if (object[pathProperty]) {
-          if (pathProperty === "path" && object.directory) {
-            if (path.isAbsolute(object.directory)) {
-              object[pathProperty] = resolve(
-                relativePathBase,
-                object[pathProperty],
-                object.directory
-              );
-            } else {
-              object[pathProperty] = path.join(
-                object.directory,
-                object[pathProperty]
-              );
-            }
-          } else if (pathProperty === "savePath" && object.saveDirectory) {
-            if (path.isAbsolute(object.saveDirectory)) {
-              object[pathProperty] = resolve(
-                relativePathBase,
-                object[pathProperty],
-                object.saveDirectory
-              );
-            } else {
-              object[pathProperty] = path.join(
-                object.saveDirectory,
-                object[pathProperty]
-              );
-            }
-          } else {
-            object[pathProperty] = resolve(
-              relativePathBase,
-              object[pathProperty],
-              filePath
-            );
-          }
-        }
-      });
-    }
-  }
-  return object;
-}
+const fs = require("fs");
+const path = require("path");
+const { validate } = require("./validate");
+
+exports.resolvePaths = resolvePaths;
+
+/**
+ * Resolves paths in config and spec objects based on the provided configuration, object type, object, and source file path.
+ *
+ * @param {object} config - The configuration object.
+ * @param {object} object - The object containing the paths to resolve.
+ * @param {string} filePath - The path of the file that contains the relative paths.
+ * @param {boolean} [nested=false] - Whether the object is nested within another object.
+ * @param {string} [objectType] - The type of object to resolve paths in ("config" or "spec"). Required if the object is nested.
+ * @returns {object} - The object with resolved paths.
+ */
+async function resolvePaths(
+  config,
+  object,
+  filePath,
+  nested = false,
+  objectType
+) {
+  // Config properties that contain paths
+  const configPaths = [
+    "input",
+    "output",
+    "envVariables",
+    "setup",
+    "cleanup",
+    "mediaDirectory",
+    "downloadDirectory",
+    "descriptionPath",
+    "path",
+  ];
+  // Spec properties that contain paths
+  const specPaths = [
+    "file",
+    "path",
+    "directory",
+    "setup",
+    "cleanup",
+    "savePath",
+    "saveDirectory",
+    "descriptionPath",
+    "workingDirectory",
+  ];
+  // Spec objects that are configurable by the user and shouldn't be resolved
+  const specNoResolve = [
+    "requestData",
+    "responseData",
+    "requestHeaders",
+    "responseHeaders",
+    "requestParams",
+    "responseParams",
+  ];
+
+  /**
+   * Resolves a path based on the provided base type, relative path, and file path.
+   *
+   * @param {string} baseType - The base type of the path ("file" or "cwd").
+   * @param {string} relativePath - The relative path to resolve.
+   * @param {string} filePath - The file path to use as a reference.
+   * @returns {string} - The resolved path.
+   */
+  function resolve(baseType, relativePath, filePath) {
+    // If path is already absolute, return it
+    if (path.isAbsolute(relativePath)) {
+      return relativePath;
+    }
+    // If filePath is a file, use its directory as the base path
+    filePath = fs.lstatSync(filePath).isFile()
+      ? path.dirname(filePath)
+      : filePath;
+    // Resolve the path based on the base type
+    return baseType === "file"
+      ? path.resolve(filePath, relativePath)
+      : path.resolve(relativePath);
+  }
+
+  const relativePathBase = config.relativePathBase;
+
+  let pathProperties;
+  if (!nested && !objectType) {
+    // Check if object matches the config schema
+    const validation = validate("config_v2", { ...object });
+    if (validation.valid) {
+      pathProperties = configPaths;
+      objectType = "config";
+    } else {
+      // Check if object matches the spec schema
+      const validation = validate("spec_v2", { ...object });
+      if (validation.valid) {
+        pathProperties = specPaths;
+        objectType = "spec";
+      } else {
+        throw new Error("Object isn't a valid config or spec.");
+      }
+    }
+  } else if (nested && !objectType) {
+    // If the object is nested, the object type is required
+    throw new Error("Object type is required for nested objects.");
+  } else if (objectType === "config") {
+    // If the object type is config, use configPaths
+    pathProperties = configPaths;
+  } else if (objectType === "spec") {
+    // If the object type is spec, use specPaths
+    pathProperties = specPaths;
+  }
+
+  for (const property of Object.keys(object)) {
+    if (
+      typeof object[property] === "object" &&
+      ((objectType === "spec" && !specNoResolve.includes(property)) ||
+        objectType === "config")
+    ) {
+      // If the property is an object, recursively call resolvePaths to resolve paths within the object
+      object[property] = await resolvePaths(
+        config,
+        object[property],
+        filePath,
+        true,
+        objectType
+      );
+    } else if (typeof object[property] === "string") {
+      // If the property is a string, check if it matches any of the path properties and resolve it if it does
+      pathProperties.forEach((pathProperty) => {
+        if (object[pathProperty]) {
+          if (pathProperty === "path" && object.directory) {
+            if (path.isAbsolute(object.directory)) {
+              object[pathProperty] = resolve(
+                relativePathBase,
+                object[pathProperty],
+                object.directory
+              );
+            } else {
+              object[pathProperty] = path.join(
+                object.directory,
+                object[pathProperty]
+              );
+            }
+          } else if (pathProperty === "savePath" && object.saveDirectory) {
+            if (path.isAbsolute(object.saveDirectory)) {
+              object[pathProperty] = resolve(
+                relativePathBase,
+                object[pathProperty],
+                object.saveDirectory
+              );
+            } else {
+              object[pathProperty] = path.join(
+                object.saveDirectory,
+                object[pathProperty]
+              );
+            }
+          } else {
+            object[pathProperty] = resolve(
+              relativePathBase,
+              object[pathProperty],
+              filePath
+            );
+          }
+        }
+      });
+    }
+  }
+  return object;
+}