doc-detective-common 1.1.0 → 1.2.3

package/.devcontainer/devcontainer.json

@@ -0,0 +1,25 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/ubuntu
+{
+	"name": "Ubuntu",
+	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+	"image": "mcr.microsoft.com/devcontainers/base:jammy",
+	"features": {
+		"ghcr.io/devcontainers/features/node:1": {}
+	}
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "uname -a",
+
+	// Configure tool-specific properties.
+	// "customizations": {},
+
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "doc-detective-common",
-  "version": "1.1.0",
+  "version": "1.2.3",
   "description": "Shared components for Doc Detective projects.",
   "main": "index.js",
   "scripts": {
     "test": "jest"
   },
+  "precommit": "test",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/doc-detective/doc-detective-common.git"
@@ -20,7 +21,12 @@
     "jest": "^29.4.1"
   },
   "dependencies": {
-    "app-root-path": "^3.1.0",
-    "ajv": "^8.12.0"
+    "@apidevtools/json-schema-ref-parser": "^10.1.0",
+    "ajv": "^8.12.0",
+    "ajv-errors": "^3.0.0",
+    "ajv-formats": "^2.1.1",
+    "ajv-keywords": "^5.1.0",
+    "pre-commit": "^1.2.2",
+    "uuid": "^9.0.0"
   }
 }

package/src/schema.js

@@ -1,19 +1,46 @@
-const approot = require("app-root-path")
 const fs = require("fs");
 
-// Read files from schema directory
-var files = fs.readdirSync(`${approot}/src/schemas`);
+//// Init
+const schemas = {};
 
-const schemas = {}
+//// Process
+loadSchemas();
+// console.log(schemas.find_v1)
+//// Export
+exports.schemas = schemas;
 
-// Loop through all schema files
-files.forEach(file => {
-  // Exit early for files that don't match naming pattern
-  if (!file.includes(".schema.json")) return;
-  key = file.replace(".schema.json","");
-  path = `./schemas/${file}`;
-  // Load into `schema` object
-  schemas[key] = require(path);
-})
+//// Functions
 
-exports.schemas = schemas;
+// Load schemas from file
+function loadSchemas() {
+  // Read files from schema directory
+  path = `${__dirname}/schemas`;
+  var files = fs.readdirSync(path);
+  // Loop through all schema files
+  files.forEach(async (file) => {
+    // Exit early for files that don't match naming pattern
+    if (!file.includes(".schema.json")) return;
+    const key = file.replace(".schema.json", "");
+    // Load schema from file
+    let schema = require(`./schemas/${file}`);
+    // Add dynamic ID based on file path
+    schema.$id = `file://${__dirname}/schemas/${file}`;
+    // Recursively update relative references with app root path
+    schema = updateRefPaths(schema);
+    // Load into `schema` object
+    schemas[key] = schema;
+  });
+}
+
+// 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") {
+      schema[key] = `file://${__dirname}/schemas/${value}`;
+    }
+  }
+  return schema;
+}

package/src/schemas/checkLink_v2.schema.json

@@ -0,0 +1,54 @@
+{
+  "title": "checkLink",
+  "type": "object",
+  "description": "Check if a URL returns an acceptable status code from a GET request.",
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "ID of the step."
+    },
+    "description": {
+      "type": "string",
+      "description": "Description of the step."
+    },
+    "action": {
+      "type": "string",
+      "const": "checkLink",
+      "description": "Action to perform."
+    },
+    "url": {
+      "type": "string",
+      "format": "uri",
+      "description": "URL to check.",
+      "pattern": "^(http://|https://).*",
+      "transform": ["trim"]
+    },
+    "statusCodes": {
+      "type": "array",
+      "items": {
+        "oneOf": [
+          {
+            "type": "integer"
+          }
+        ]
+      },
+      "default": [200]
+    }
+  },
+  "dynamicDefaults": {
+    "id": "uuid"
+  },
+  "required": ["action", "url"],
+  "additionalProperties": false,
+  "examples": [
+    {
+      "action": "checkLink",
+      "url": "https://www.google.com"
+    },
+    {
+      "action": "checkLink",
+      "url": "https://www.google.com",
+      "statusCodes": [200]
+    }
+  ]
+}