doc-detective-common 1.21.0-openapi.9 → 1.21.1-dev.0

package/README.md

@@ -52,6 +52,10 @@ const object = {
 console.log(common.validate(schemaKey, object));
 ```
 
+### `.readFile(fileURL)`
+
+Load file contents from a URL or a file path. If a JSON or YAML file, returns an object. If a different file, returns a string.
+
 ## Objects
 
 ### `.schemas`

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "doc-detective-common",
-  "version": "1.21.0-openapi.9",
+  "version": "1.21.1-dev.0",
   "description": "Shared components for Doc Detective projects.",
   "main": "src/index.js",
   "scripts": {
     "dereferenceSchemas": "node ./src/schemas/dereferenceSchemas.js",
     "test:full": "npm run dereferenceSchemas && npm run test",
-    "test": "jest"
+    "test": "mocha"
   },
   "repository": {
     "type": "git",
@@ -19,14 +19,18 @@
   },
   "homepage": "https://github.com/doc-detective/doc-detective-common#readme",
   "devDependencies": {
-    "jest": "^29.7.0"
+    "chai": "^5.1.2",
+    "mocha": "^10.8.2",
+    "sinon": "^19.0.2"
   },
   "dependencies": {
-    "@apidevtools/json-schema-ref-parser": "^11.7.0",
-    "ajv": "8.16.0",
+    "@apidevtools/json-schema-ref-parser": "^11.7.2",
+    "ajv": "^8.17.1",
     "ajv-errors": "^3.0.0",
     "ajv-formats": "^3.0.1",
     "ajv-keywords": "^5.1.0",
-    "uuid": "^10.0.0"
+    "axios": "^1.7.7",
+    "uuid": "^11.0.3",
+    "yaml": "^2.6.0"
   }
 }

package/src/files.js

@@ -0,0 +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 };

package/src/index.js

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

package/src/resolvePaths.js

@@ -30,7 +30,7 @@ async function resolvePaths(
     "cleanup",
     "mediaDirectory",
     "downloadDirectory",
-    "definitionPath",
+    "descriptionPath",
     "path",
   ];
   // Spec properties that contain paths
@@ -42,7 +42,7 @@ async function resolvePaths(
     "cleanup",
     "savePath",
     "saveDirectory",
-    "definitionPath",
+    "descriptionPath",
     "workingDirectory",
   ];
   // Spec objects that are configurable by the user and shouldn't be resolved
@@ -139,8 +139,7 @@ async function resolvePaths(
                 object[pathProperty]
               );
             }
-          }
-          if (pathProperty === "savePath" && object.saveDirectory) {
+          } else if (pathProperty === "savePath" && object.saveDirectory) {
             if (path.isAbsolute(object.saveDirectory)) {
               object[pathProperty] = resolve(
                 relativePathBase,
@@ -153,12 +152,13 @@ async function resolvePaths(
                 object[pathProperty]
               );
             }
+          } else {
+            object[pathProperty] = resolve(
+              relativePathBase,
+              object[pathProperty],
+              filePath
+            );
           }
-          object[pathProperty] = resolve(
-            relativePathBase,
-            object[pathProperty],
-            filePath
-          );
         }
       });
     }

package/src/schemas/dereferenceSchemas.js

@@ -1,115 +1,115 @@
-const parser = require("@apidevtools/json-schema-ref-parser");
-const path = require("path");
-const fs = require("fs");
-
-(async () => {
-  await dereferenceSchemas();
-})();
-
-/*
- * Walks through all schema in src/src_schema
- * For each schema, dereferences it and writes it to src/schema
- */
-async function dereferenceSchemas() {
-  const inputDir = path.resolve(`${__dirname}/src_schemas`);
-  const buildDir = path.resolve(`${__dirname}/build`);
-  fs.mkdir(buildDir, { recursive: true }, (err) => {
-    if (err) throw err;
-  });
-  const outputDir = path.resolve(`${__dirname}/output_schemas`);
-  var files = [
-    "checkLink_v2.schema.json",
-    "config_v2.schema.json",
-    "context_v2.schema.json",
-    "find_v2.schema.json",
-    "goTo_v2.schema.json",
-    "httpRequest_v2.schema.json",
-    "moveTo_v2.schema.json",
-    "openApi_v2.schema.json",
-    "runShell_v2.schema.json",
-    "saveScreenshot_v2.schema.json",
-    "setVariables_v2.schema.json",
-    "startRecording_v2.schema.json",
-    "stopRecording_v2.schema.json",
-    "spec_v2.schema.json",
-    "test_v2.schema.json",
-    "typeKeys_v2.schema.json",
-    "wait_v2.schema.json",
-  ];
-  // Update schema reference paths
-  for (const file of files) {
-    // console.log(`File: ${file}`)
-    const filePath = path.resolve(`${inputDir}/${file}`);
-    // Load from file
-    let schema = fs.readFileSync(filePath).toString();
-    // Convert to JSON
-    schema = JSON.parse(schema);
-    // Set ID
-    schema.$id = `${filePath}`;
-    // Update references to current relative path
-    schema = updateRefPaths(schema);
-    // Write to file
-    fs.writeFileSync(`${buildDir}/${file}`, JSON.stringify(schema, null, 2));
-  }
-  // Dereference schemas
-  for await (const file of files) {
-    const filePath = path.resolve(`${buildDir}/${file}`);
-    // Load from file
-    let schema = fs.readFileSync(filePath).toString();
-    // Convert to JSON
-    schema = JSON.parse(schema);
-    // Dereference schema
-    schema = await parser.dereference(schema);
-    // Delete $id attributes
-    schema = deleteDollarIds(schema);
-    // Write to file
-    fs.writeFileSync(`${outputDir}/${file}`, JSON.stringify(schema, null, 2));
-  }
-  // Build final schemas.json file
-  const schemas = {};
-  files.forEach(async (file) => {
-    const key = file.replace(".schema.json", "");
-    // Load schema from file
-    let schema = require(`${outputDir}/${file}`);
-    // Load into `schema` object
-    schemas[key] = schema;
-  });
-  fs.writeFileSync(`${__dirname}/schemas.json`, JSON.stringify(schemas,null,2));
-  
-  // Clean up build dir
-  // fs.rm(buildDir, { recursive: true }, (err) => {
-  //   if (err) throw err;
-  // });
-}
-
-// Prepend app-root path to referenced relative paths
-function updateRefPaths(schema) {
-  for (let [key, value] of Object.entries(schema)) {
-    if (typeof value === "object") {
-      updateRefPaths(value);
-    }
-    if (key === "$ref" && !value.startsWith("#")) {
-      // File name of the referenced schema
-      valueFile = value.split("#")[0];
-      // Attribute path in the referenced schema
-      valueAttribute = value.split("#")[1];
-      valuePath = path.resolve(`${__dirname}/build/${valueFile}`);
-      schema[key] = `${valuePath}#${valueAttribute}`;
-      // console.log({value, valueFile, valueAttribute, final: schema[key]})
-    }
-  }
-  return schema;
-}
-
-// Prepend app-root path to referenced relative paths
-function deleteDollarIds(schema) {
-  for (let [key, value] of Object.entries(schema)) {
-    if (typeof value === "object") {
-      deleteDollarIds(value);
-    }
-    if (key === "$id") {
-      delete schema[key]
-    }
-  }
-  return schema;
-}
+const parser = require("@apidevtools/json-schema-ref-parser");
+const path = require("path");
+const fs = require("fs");
+
+(async () => {
+  await dereferenceSchemas();
+})();
+
+/*
+ * Walks through all schema in src/src_schema
+ * For each schema, dereferences it and writes it to src/schema
+ */
+async function dereferenceSchemas() {
+  const inputDir = path.resolve(`${__dirname}/src_schemas`);
+  const buildDir = path.resolve(`${__dirname}/build`);
+  fs.mkdir(buildDir, { recursive: true }, (err) => {
+    if (err) throw err;
+  });
+  const outputDir = path.resolve(`${__dirname}/output_schemas`);
+  var files = [
+    "checkLink_v2.schema.json",
+    "config_v2.schema.json",
+    "context_v2.schema.json",
+    "find_v2.schema.json",
+    "goTo_v2.schema.json",
+    "httpRequest_v2.schema.json",
+    "moveTo_v2.schema.json",
+    "openApi_v2.schema.json",
+    "runShell_v2.schema.json",
+    "saveScreenshot_v2.schema.json",
+    "setVariables_v2.schema.json",
+    "startRecording_v2.schema.json",
+    "stopRecording_v2.schema.json",
+    "spec_v2.schema.json",
+    "test_v2.schema.json",
+    "typeKeys_v2.schema.json",
+    "wait_v2.schema.json",
+  ];
+  // Update schema reference paths
+  for (const file of files) {
+    // console.log(`File: ${file}`)
+    const filePath = path.resolve(`${inputDir}/${file}`);
+    // Load from file
+    let schema = fs.readFileSync(filePath).toString();
+    // Convert to JSON
+    schema = JSON.parse(schema);
+    // Set ID
+    schema.$id = `${filePath}`;
+    // Update references to current relative path
+    schema = updateRefPaths(schema);
+    // Write to file
+    fs.writeFileSync(`${buildDir}/${file}`, JSON.stringify(schema, null, 2));
+  }
+  // Dereference schemas
+  for await (const file of files) {
+    const filePath = path.resolve(`${buildDir}/${file}`);
+    // Load from file
+    let schema = fs.readFileSync(filePath).toString();
+    // Convert to JSON
+    schema = JSON.parse(schema);
+    // Dereference schema
+    schema = await parser.dereference(schema);
+    // Delete $id attributes
+    schema = deleteDollarIds(schema);
+    // Write to file
+    fs.writeFileSync(`${outputDir}/${file}`, JSON.stringify(schema, null, 2));
+  }
+  // Build final schemas.json file
+  const schemas = {};
+  files.forEach(async (file) => {
+    const key = file.replace(".schema.json", "");
+    // Load schema from file
+    let schema = require(`${outputDir}/${file}`);
+    // Load into `schema` object
+    schemas[key] = schema;
+  });
+  fs.writeFileSync(`${__dirname}/schemas.json`, JSON.stringify(schemas,null,2));
+  
+  // Clean up build dir
+  // fs.rm(buildDir, { recursive: true }, (err) => {
+  //   if (err) throw err;
+  // });
+}
+
+// Prepend app-root path to referenced relative paths
+function updateRefPaths(schema) {
+  for (let [key, value] of Object.entries(schema)) {
+    if (typeof value === "object") {
+      updateRefPaths(value);
+    }
+    if (key === "$ref" && !value.startsWith("#")) {
+      // File name of the referenced schema
+      valueFile = value.split("#")[0];
+      // Attribute path in the referenced schema
+      valueAttribute = value.split("#")[1];
+      valuePath = path.resolve(`${__dirname}/build/${valueFile}`);
+      schema[key] = `${valuePath}#${valueAttribute}`;
+      // console.log({value, valueFile, valueAttribute, final: schema[key]})
+    }
+  }
+  return schema;
+}
+
+// Prepend app-root path to referenced relative paths
+function deleteDollarIds(schema) {
+  for (let [key, value] of Object.entries(schema)) {
+    if (typeof value === "object") {
+      deleteDollarIds(value);
+    }
+    if (key === "$id") {
+      delete schema[key]
+    }
+  }
+  return schema;
+}