doc-detective-common 3.1.2-dev.3 → 3.2.0-dev.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "doc-detective-common",
-  "version": "3.1.2-dev.3",
+  "version": "3.2.0-dev.1",
   "description": "Shared components for Doc Detective projects.",
   "main": "src/index.js",
   "scripts": {
@@ -20,12 +20,12 @@
   },
   "homepage": "https://github.com/doc-detective/doc-detective-common#readme",
   "devDependencies": {
-    "chai": "^5.2.1",
+    "chai": "^5.3.1",
     "mocha": "^11.7.1",
     "sinon": "^21.0.0"
   },
   "dependencies": {
-    "@apidevtools/json-schema-ref-parser": "^14.1.1",
+    "@apidevtools/json-schema-ref-parser": "^14.2.0",
     "ajv": "^8.17.1",
     "ajv-errors": "^3.0.0",
     "ajv-formats": "^3.0.1",

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

@@ -0,0 +1,121 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "dragAndDrop",
+  "description": "Drag and drop an element from source to target.",
+  "type": "object",
+  "required": [
+    "source",
+    "target"
+  ],
+  "properties": {
+    "source": {
+      "$ref": "#/components/schemas/elementSpecification",
+      "description": "The element to drag."
+    },
+    "target": {
+      "$ref": "#/components/schemas/elementSpecification",
+      "description": "The target location to drop the element."
+    },
+    "duration": {
+      "type": "integer",
+      "description": "Duration of the drag operation in milliseconds.",
+      "default": 1000,
+      "minimum": 0
+    }
+  },
+  "components": {
+    "schemas": {
+      "elementSpecification": {
+        "anyOf": [
+          {
+            "$ref": "#/components/schemas/string"
+          },
+          {
+            "$ref": "#/components/schemas/object"
+          }
+        ]
+      },
+      "string": {
+        "title": "Element (simple)",
+        "type": "string",
+        "description": "Display text, selector, or regex pattern (enclosed in forward slashes) of the element."
+      },
+      "object": {
+        "title": "Element (detailed)",
+        "type": "object",
+        "anyOf": [
+          {
+            "required": [
+              "selector"
+            ]
+          },
+          {
+            "required": [
+              "elementText"
+            ]
+          }
+        ],
+        "properties": {
+          "elementText": {
+            "type": "string",
+            "description": "Display text or regex pattern (enclosed in forward slashes) of the element. If combined with `selector`, the element must match both the text and the selector."
+          },
+          "selector": {
+            "type": "string",
+            "description": "Selector of the element. If combined with `elementText`, the element must match both the text and the selector."
+          },
+          "timeout": {
+            "type": "integer",
+            "description": "Max duration in milliseconds to wait for the element to exist.",
+            "default": 5000
+          }
+        }
+      }
+    }
+  },
+  "examples": [
+    {
+      "source": "Table",
+      "target": "#canvas"
+    },
+    {
+      "source": ".draggable-block",
+      "target": ".drop-zone",
+      "duration": 2000
+    },
+    {
+      "source": {
+        "selector": ".widget",
+        "elementText": "Data Table"
+      },
+      "target": {
+        "selector": "#design-canvas"
+      },
+      "duration": 500
+    },
+    {
+      "source": {
+        "selector": ".draggable",
+        "timeout": 10000
+      },
+      "target": {
+        "elementText": "Drop Zone",
+        "timeout": 5000
+      }
+    },
+    {
+      "source": "/Widget Item.*/",
+      "target": "#canvas"
+    },
+    {
+      "source": {
+        "selector": ".draggable",
+        "elementText": "/Button [0-9]+/"
+      },
+      "target": {
+        "elementText": "/Drop Zone.*/"
+      }
+    }
+  ],
+  "$id": "/home/runner/work/common/common/src/schemas/src_schemas/dragAndDrop_v3.schema.json"
+}

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

@@ -86,7 +86,6 @@
             "type": "string",
             "title": "Cookie file path",
             "description": "File path to cookie file, relative to directory. Supports Netscape cookie format.",
-            "pattern": "^(?:[A-Za-z0-9_.-]+\\.(?:txt|cookies)|\\$[A-Za-z_][A-Za-z0-9_]*)$",
             "transform": [
               "trim"
             ]
@@ -115,10 +114,15 @@
   "examples": [
     "session_token",
     "./test-data/auth-session.txt",
+    "test_env_cookie",
     {
       "name": "auth_cookie",
       "variable": "AUTH_COOKIE"
     },
+    {
+      "name": "test_cookie",
+      "path": "test-cookie.txt"
+    },
     {
       "name": "session_token",
       "path": "session-token.txt",

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

@@ -52,7 +52,6 @@
             "type": "string",
             "title": "Cookie file path",
             "description": "File path to save the cookie, relative to directory. Uses Netscape cookie format.",
-            "pattern": "^(?:[A-Za-z0-9_.-]+\\.(?:txt|cookies)|\\$[A-Za-z_][A-Za-z0-9_]*)$",
             "transform": [
               "trim"
             ]
@@ -109,11 +108,6 @@
                   "required": [
                     "directory"
                   ]
-                },
-                {
-                  "required": [
-                    "overwrite"
-                  ]
                 }
               ]
             }
@@ -125,6 +119,7 @@
   },
   "examples": [
     "session_token",
+    "test_env_cookie",
     {
       "name": "auth_cookie",
       "path": "auth-cookie.txt"
@@ -133,6 +128,11 @@
       "name": "session_token",
       "variable": "SESSION_TOKEN"
     },
+    {
+      "name": "test_cookie",
+      "path": "test-cookie.txt",
+      "overwrite": true
+    },
     {
       "name": "user_session",
       "path": "user-session.txt",

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

@@ -334,6 +334,25 @@
         }
       ]
     },
+    {
+      "allOf": [
+        {
+          "$ref": "#/components/schemas/common"
+        },
+        {
+          "title": "dragAndDrop",
+          "type": "object",
+          "required": [
+            "dragAndDrop"
+          ],
+          "properties": {
+            "dragAndDrop": {
+              "$ref": "/home/runner/work/common/common/src/schemas/build/dragAndDrop_v3.schema.json#"
+            }
+          }
+        }
+      ]
+    },
     {
       "allOf": [
         {
@@ -634,6 +653,16 @@
     {
       "checkLink": "https://www.google.com",
       "breakpoint": false
+    },
+    {
+      "dragAndDrop": {
+        "source": {
+          "selector": "#sourceElement"
+        },
+        "target": {
+          "selector": "#targetElement"
+        }
+      }
     }
   ],
   "$id": "/home/runner/work/common/common/src/schemas/src_schemas/step_v3.schema.json"

package/src/schemas/dereferenceSchemas.js

@@ -30,6 +30,7 @@ async function dereferenceSchemas() {
     "click_v3.schema.json",
     "config_v3.schema.json",
     "context_v3.schema.json",
+    "dragAndDrop_v3.schema.json",
     "find_v3.schema.json",
     "goTo_v3.schema.json",
     "loadCookie_v3.schema.json",