doc-detective-common 1.22.0 → 3.0.0-dev.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "doc-detective-common",
-  "version": "1.22.0",
+  "version": "3.0.0-dev.0",
   "description": "Shared components for Doc Detective projects.",
   "main": "src/index.js",
   "scripts": {
@@ -19,18 +19,18 @@
   },
   "homepage": "https://github.com/doc-detective/doc-detective-common#readme",
   "devDependencies": {
-    "chai": "^5.1.2",
+    "chai": "^5.2.0",
     "mocha": "^11.1.0",
     "sinon": "^19.0.2"
   },
   "dependencies": {
-    "@apidevtools/json-schema-ref-parser": "^11.9.0",
-    "ajv": "8.16.0",
+    "@apidevtools/json-schema-ref-parser": "^11.9.3",
+    "ajv": "^8.17.1",
     "ajv-errors": "^3.0.0",
     "ajv-formats": "^3.0.1",
     "ajv-keywords": "^5.1.0",
-    "axios": "^1.7.9",
-    "uuid": "^11.0.5",
+    "axios": "^1.8.2",
+    "uuid": "^11.1.0",
     "yaml": "^2.7.0"
   }
 }

package/src/schemas/dereferenceSchemas.js

@@ -17,7 +17,29 @@ async function dereferenceSchemas() {
     if (err) throw err;
   });
   const outputDir = path.resolve(`${__dirname}/output_schemas`);
-  var files = [
+  const files = [
+    // v3 schemas
+    "checkLink_v3.schema.json",
+    "click_v3.schema.json",
+    "config_v3.schema.json",
+    "context_v3.schema.json",
+    "find_v3.schema.json",
+    "goTo_v3.schema.json",
+    "loadVariables_v3.schema.json",
+    "httpRequest_v3.schema.json",
+    "openApi_v3.schema.json",
+    "record_v3.schema.json",
+    "report_v3.schema.json",
+    "runCode_v3.schema.json",
+    "runShell_v3.schema.json",
+    "screenshot_v3.schema.json",
+    "spec_v3.schema.json",
+    "step_v3.schema.json",
+    "stopRecord_v3.schema.json",
+    "test_v3.schema.json",
+    "type_v3.schema.json",
+    "wait_v3.schema.json",
+    // v2 schemas
     "checkLink_v2.schema.json",
     "config_v2.schema.json",
     "context_v2.schema.json",
@@ -75,8 +97,11 @@ async function dereferenceSchemas() {
     // Load into `schema` object
     schemas[key] = schema;
   });
-  fs.writeFileSync(`${__dirname}/schemas.json`, JSON.stringify(schemas,null,2));
-  
+  fs.writeFileSync(
+    `${__dirname}/schemas.json`,
+    JSON.stringify(schemas, null, 2)
+  );
+
   // Clean up build dir
   // fs.rm(buildDir, { recursive: true }, (err) => {
   //   if (err) throw err;
@@ -109,7 +134,7 @@ function deleteDollarIds(schema) {
       deleteDollarIds(value);
     }
     if (key === "$id") {
-      delete schema[key]
+      delete schema[key];
     }
   }
   return schema;

package/src/schemas/output_schemas/checkLink_v3.schema.json

@@ -0,0 +1,141 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "checkLink",
+  "anyOf": [
+    {
+      "description": "Check if an HTTP or HTTPS URL returns an acceptable status code from a GET request.",
+      "type": "string",
+      "pattern": "(^(http://|https://|/).*|\\$[A-Za-z0-9_]+)",
+      "transform": [
+        "trim"
+      ]
+    },
+    {
+      "description": "Check if an HTTP or HTTPS URL returns an acceptable status code from a GET request.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "url"
+      ],
+      "properties": {
+        "url": {
+          "type": "string",
+          "description": "URL to check. Can be a full URL or a path. If a path is provided, `origin` must be specified.",
+          "pattern": "(^(http://|https://|/).*|\\$[A-Za-z0-9_]+)",
+          "transform": [
+            "trim"
+          ]
+        },
+        "origin": {
+          "type": "string",
+          "description": "Protocol and domain to navigate to. Prepended to `url`.",
+          "transform": [
+            "trim"
+          ]
+        },
+        "statusCodes": {
+          "description": "Accepted status codes. If the specified URL returns a code other than what is specified here, the action fails.",
+          "anyOf": [
+            {
+              "type": "integer"
+            },
+            {
+              "type": "array",
+              "items": {
+                "oneOf": [
+                  {
+                    "type": "integer"
+                  }
+                ]
+              }
+            }
+          ],
+          "default": [
+            200,
+            301,
+            302,
+            307,
+            308
+          ]
+        }
+      }
+    }
+  ],
+  "components": {
+    "schemas": {
+      "string": {
+        "description": "Check if an HTTP or HTTPS URL returns an acceptable status code from a GET request.",
+        "type": "string",
+        "pattern": "(^(http://|https://|/).*|\\$[A-Za-z0-9_]+)",
+        "transform": [
+          "trim"
+        ]
+      },
+      "object": {
+        "description": "Check if an HTTP or HTTPS URL returns an acceptable status code from a GET request.",
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "url"
+        ],
+        "properties": {
+          "url": {
+            "type": "string",
+            "description": "URL to check. Can be a full URL or a path. If a path is provided, `origin` must be specified.",
+            "pattern": "(^(http://|https://|/).*|\\$[A-Za-z0-9_]+)",
+            "transform": [
+              "trim"
+            ]
+          },
+          "origin": {
+            "type": "string",
+            "description": "Protocol and domain to navigate to. Prepended to `url`.",
+            "transform": [
+              "trim"
+            ]
+          },
+          "statusCodes": {
+            "description": "Accepted status codes. If the specified URL returns a code other than what is specified here, the action fails.",
+            "anyOf": [
+              {
+                "type": "integer"
+              },
+              {
+                "type": "array",
+                "items": {
+                  "oneOf": [
+                    {
+                      "type": "integer"
+                    }
+                  ]
+                }
+              }
+            ],
+            "default": [
+              200,
+              301,
+              302,
+              307,
+              308
+            ]
+          }
+        }
+      }
+    }
+  },
+  "examples": [
+    "https://www.google.com",
+    "/search",
+    {
+      "url": "https://www.google.com",
+      "statusCodes": 200
+    },
+    {
+      "url": "/search",
+      "origin": "www.google.com",
+      "statusCodes": [
+        200
+      ]
+    }
+  ]
+}

package/src/schemas/output_schemas/click_v3.schema.json

@@ -0,0 +1,90 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "click",
+  "description": "Click or tap an element.",
+  "anyOf": [
+    {
+      "description": "Kind of click to perform.",
+      "type": "string",
+      "enum": [
+        "left",
+        "right",
+        "middle"
+      ]
+    },
+    {
+      "type": "object",
+      "properties": {
+        "button": {
+          "description": "Kind of click to perform.",
+          "type": "string",
+          "enum": [
+            "left",
+            "right",
+            "middle"
+          ]
+        },
+        "elementText": {
+          "type": "string",
+          "description": "Display text of the element to click. If combined with `selector`, the element must match both the text and the selector."
+        },
+        "selector": {
+          "type": "string",
+          "description": "Selector of the element to click. If combined with `elementText`, the element must match both the text and the selector."
+        }
+      }
+    },
+    {
+      "type": "boolean",
+      "nullable": true
+    }
+  ],
+  "components": {
+    "schemas": {
+      "button": {
+        "description": "Kind of click to perform.",
+        "type": "string",
+        "enum": [
+          "left",
+          "right",
+          "middle"
+        ]
+      },
+      "object": {
+        "type": "object",
+        "properties": {
+          "button": {
+            "description": "Kind of click to perform.",
+            "type": "string",
+            "enum": [
+              "left",
+              "right",
+              "middle"
+            ]
+          },
+          "elementText": {
+            "type": "string",
+            "description": "Display text of the element to click. If combined with `selector`, the element must match both the text and the selector."
+          },
+          "selector": {
+            "type": "string",
+            "description": "Selector of the element to click. If combined with `elementText`, the element must match both the text and the selector."
+          }
+        }
+      }
+    }
+  },
+  "examples": [
+    true,
+    "right",
+    {
+      "button": "left",
+      "elementText": "Element text"
+    },
+    {
+      "selector": "#elementToScreenshot",
+      "elementText": "Element text",
+      "button": "middle"
+    }
+  ]
+}