doc-detective-common 3.1.1-dev.1 → 3.1.1-dev.2

package/dist/schemas/config_v3.schema.json

@@ -5744,6 +5744,18 @@
       },
       "title": "Telemetry options"
     },
+    "concurrentRunners": {
+      "type": [
+        "integer",
+        "boolean"
+      ],
+      "default": 1,
+      "minimum": 1,
+      "description": "Number of concurrent test runners. Set to true to use CPU core count (capped at 4).",
+      "not": {
+        "const": false
+      }
+    },
     "environment": {
       "type": "object",
       "description": "Environment information for the system running Doc Detective.",
@@ -10588,6 +10600,15 @@
         "platform": "windows",
         "arch": "x64"
       }
+    },
+    {
+      "concurrentRunners": 1
+    },
+    {
+      "concurrentRunners": true
+    },
+    {
+      "concurrentRunners": 4
     }
   ]
 }

package/dist/schemas/resolvedTests_v3.schema.json

@@ -5757,6 +5757,18 @@
           },
           "title": "Telemetry options"
         },
+        "concurrentRunners": {
+          "type": [
+            "integer",
+            "boolean"
+          ],
+          "default": 1,
+          "minimum": 1,
+          "description": "Number of concurrent test runners. Set to true to use CPU core count (capped at 4).",
+          "not": {
+            "const": false
+          }
+        },
         "environment": {
           "type": "object",
           "description": "Environment information for the system running Doc Detective.",
@@ -10601,6 +10613,15 @@
             "platform": "windows",
             "arch": "x64"
           }
+        },
+        {
+          "concurrentRunners": 1
+        },
+        {
+          "concurrentRunners": true
+        },
+        {
+          "concurrentRunners": 4
         }
       ]
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "doc-detective-common",
-  "version": "3.1.1-dev.1",
+  "version": "3.1.1-dev.2",
   "description": "Shared components for Doc Detective projects.",
   "main": "src/index.js",
   "scripts": {

package/src/schemas/build/checkLink_v2.schema.json

@@ -0,0 +1,81 @@
+{
+  "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",
+      "description": "URL to check.",
+      "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.",
+      "type": "array",
+      "items": {
+        "oneOf": [
+          {
+            "type": "integer"
+          }
+        ]
+      },
+      "default": [
+        200,
+        201,
+        202
+      ]
+    }
+  },
+  "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
+      ]
+    },
+    {
+      "action": "checkLink",
+      "url": "/search",
+      "origin": "www.google.com",
+      "statusCodes": [
+        200
+      ]
+    }
+  ],
+  "$id": "/home/runner/work/common/common/src/schemas/src_schemas/checkLink_v2.schema.json"
+}

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

@@ -0,0 +1,92 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "checkLink",
+  "anyOf": [
+    {
+      "$ref": "#/components/schemas/string"
+    },
+    {
+      "$ref": "#/components/schemas/object"
+    }
+  ],
+  "components": {
+    "schemas": {
+      "string": {
+        "title": "Check link (detailed)",
+        "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": {
+        "title": "Check link (detailed)",
+        "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
+      ]
+    }
+  ],
+  "$id": "/home/runner/work/common/common/src/schemas/src_schemas/checkLink_v3.schema.json"
+}

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

@@ -0,0 +1,77 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "click",
+  "description": "Click or tap an element.",
+  "anyOf": [
+    {
+      "$ref": "#/components/schemas/string"
+    },
+    {
+      "$ref": "#/components/schemas/object"
+    },
+    {
+      "type": "boolean"
+    }
+  ],
+  "components": {
+    "schemas": {
+      "string": {
+        "title": "Click element (simple)",
+        "type": "string",
+        "description": "Display text or selector of the element to find."
+      },
+      "button": {
+        "description": "Kind of click to perform.",
+        "type": "string",
+        "enum": [
+          "left",
+          "right",
+          "middle"
+        ]
+      },
+      "object": {
+        "title": "Click element (detailed)",
+        "type": "object",
+        "anyOf": [
+          {
+            "required": [
+              "selector"
+            ]
+          },
+          {
+            "required": [
+              "elementText"
+            ]
+          }
+        ],
+        "properties": {
+          "button": {
+            "$ref": "#/components/schemas/button"
+          },
+          "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"
+    }
+  ],
+  "$id": "/home/runner/work/common/common/src/schemas/src_schemas/click_v3.schema.json"
+}