doc-detective-common 4.0.0-beta.0-dev.4 → 4.0.0-beta.0-dev.5

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

@@ -1,168 +0,0 @@
-{
-  "title": "find",
-  "type": "object",
-  "description": "Check if an element exists with the specified CSS selector.",
-  "properties": {
-    "id": {
-      "type": "string",
-      "description": "ID of the step."
-    },
-    "description": {
-      "type": "string",
-      "description": "Description of the step."
-    },
-    "action": {
-      "type": "string",
-      "const": "find",
-      "description": "Action to perform."
-    },
-    "selector": {
-      "description": "Selector that uniquely identifies the element.",
-      "type": "string"
-    },
-    "timeout": {
-      "type": "integer",
-      "description": "Max duration in milliseconds to wait for the element to exist.",
-      "default": 5000
-    },
-    "matchText": {
-      "type": "string",
-      "description": "Text that the element should contain. If the element doesn't contain the text, the step fails. Accepts both strings and regular expressions. To use a regular expression, the expression should start and end with a `/`. For example, `/search/`."
-    },
-    "moveTo": {
-      "description": "Move to the element. If the element isn't visible, it's scrolled into view. Only runs if the test is being recorded.",
-      "oneOf": [
-        {
-          "type": "boolean"
-        }
-      ],
-      "default": false
-    },
-    "click": {
-      "description": "Click the element.",
-      "oneOf": [
-        {
-          "type": "boolean",
-          "default": false
-        },
-        {
-          "type": "object",
-          "additionalProperties": false,
-          "properties": {
-            "button": {
-              "description": "Kind of click to perform.",
-              "type": "string",
-              "enum": [
-                "left",
-                "right",
-                "middle"
-              ]
-            }
-          }
-        }
-      ]
-    },
-    "typeKeys": {
-      "description": "Type keys after finding the element. Either a string or an object with a `keys` field as defined in [`typeKeys`](typeKeys). To type in the element, make the element active with the `click` parameter.",
-      "oneOf": [
-        {
-          "type": "string"
-        },
-        {
-          "type": "object",
-          "additionalProperties": false,
-          "properties": {
-            "keys": {
-              "$ref": "/home/runner/work/doc-detective/doc-detective/src/common/src/schemas/build/typeKeys_v2.schema.json#/properties/keys"
-            },
-            "delay": {
-              "$ref": "/home/runner/work/doc-detective/doc-detective/src/common/src/schemas/build/typeKeys_v2.schema.json#/properties/delay"
-            }
-          }
-        }
-      ]
-    },
-    "setVariables": {
-      "type": "array",
-      "description": "Extract environment variables from the element's text.",
-      "items": {
-        "oneOf": [
-          {
-            "description": "",
-            "type": "object",
-            "properties": {
-              "name": {
-                "description": "Name of the environment variable to set.",
-                "type": "string"
-              },
-              "regex": {
-                "description": "Regex to extract the environment variable from the element's text.",
-                "type": "string"
-              }
-            },
-            "required": [
-              "name",
-              "regex"
-            ]
-          }
-        ]
-      },
-      "default": []
-    }
-  },
-  "required": [
-    "action",
-    "selector"
-  ],
-  "dynamicDefaults": {
-    "id": "uuid"
-  },
-  "additionalProperties": false,
-  "examples": [
-    {
-      "action": "find",
-      "selector": "[title=Search]"
-    },
-    {
-      "action": "find",
-      "selector": "[title=Search]",
-      "timeout": 10000,
-      "matchText": "Search",
-      "moveTo": true,
-      "click": true,
-      "typeKeys": "shorthair cat"
-    },
-    {
-      "action": "find",
-      "selector": "[title=Search]",
-      "click": {
-        "button": "right"
-      }
-    },
-    {
-      "action": "find",
-      "selector": "[title=Search]",
-      "timeout": 10000,
-      "matchText": "Search",
-      "moveTo": true,
-      "click": true,
-      "typeKeys": {
-        "keys": [
-          "shorthair cat"
-        ],
-        "delay": 100
-      }
-    },
-    {
-      "action": "find",
-      "selector": "[title=ResultsCount]",
-      "setVariables": [
-        {
-          "name": "resultsCount",
-          "regex": ".*"
-        }
-      ]
-    }
-  ],
-  "$id": "/home/runner/work/doc-detective/doc-detective/src/common/src/schemas/src_schemas/find_v2.schema.json"
-}

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

@@ -1,214 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "find",
-  "description": "Find an element based on display text or a selector, then optionally interact with it.",
-  "anyOf": [
-    {
-      "$ref": "#/components/schemas/string"
-    },
-    {
-      "$ref": "#/components/schemas/object"
-    }
-  ],
-  "components": {
-    "schemas": {
-      "string": {
-        "title": "Find element (simple)",
-        "type": "string",
-        "description": "Identifier for the element to find. Can be a selector, element text, ARIA name, ID, or test ID."
-      },
-      "object": {
-        "title": "Find element (detailed)",
-        "type": "object",
-        "anyOf": [
-          {
-            "required": [
-              "selector"
-            ]
-          },
-          {
-            "required": [
-              "elementText"
-            ]
-          },
-          {
-            "required": [
-              "elementId"
-            ]
-          },
-          {
-            "required": [
-              "elementTestId"
-            ]
-          },
-          {
-            "required": [
-              "elementClass"
-            ]
-          },
-          {
-            "required": [
-              "elementAttribute"
-            ]
-          },
-          {
-            "required": [
-              "elementAria"
-            ]
-          }
-        ],
-        "additionalProperties": false,
-        "properties": {
-          "elementText": {
-            "type": "string",
-            "description": "Display text of the element to find. If combined with other element finding fields, the element must match all specified criteria."
-          },
-          "selector": {
-            "type": "string",
-            "description": "Selector of the element to find. If combined with other element finding fields, the element must match all specified criteria."
-          },
-          "elementId": {
-            "type": "string",
-            "description": "ID attribute of the element to find. Supports exact match or regex pattern using /pattern/ syntax."
-          },
-          "elementTestId": {
-            "type": "string",
-            "description": "data-testid attribute of the element to find. Supports exact match or regex pattern using /pattern/ syntax."
-          },
-          "elementClass": {
-            "anyOf": [
-              {
-                "type": "string"
-              },
-              {
-                "type": "array",
-                "items": {
-                  "type": "string"
-                }
-              }
-            ],
-            "description": "Class or array of classes that the element must have. Each class supports exact match or regex pattern using /pattern/ syntax. Element must have all specified classes."
-          },
-          "elementAttribute": {
-            "type": "object",
-            "description": "Object of attribute key-value pairs that the element must have. Values can be strings (supporting /pattern/ regex), numbers, or booleans. Boolean true matches attribute presence, false matches absence.",
-            "additionalProperties": {
-              "anyOf": [
-                {
-                  "type": "string"
-                },
-                {
-                  "type": "number"
-                },
-                {
-                  "type": "boolean"
-                }
-              ]
-            }
-          },
-          "elementAria": {
-            "type": "string",
-            "description": "Computed accessible name of the element per ARIA specification. Supports exact match or regex pattern using /pattern/ syntax."
-          },
-          "timeout": {
-            "type": "integer",
-            "description": "Max duration in milliseconds to wait for the element to exist.",
-            "default": 5000
-          },
-          "moveTo": {
-            "description": "Move to the element. If the element isn't visible, it's scrolled into view.",
-            "type": "boolean",
-            "default": true
-          },
-          "click": {
-            "description": "Click the element.",
-            "anyOf": [
-              {
-                "$ref": "/home/runner/work/doc-detective/doc-detective/src/common/src/schemas/build/click_v3.schema.json#"
-              },
-              {
-                "type": "object",
-                "properties": {
-                  "button": {
-                    "$ref": "/home/runner/work/doc-detective/doc-detective/src/common/src/schemas/build/click_v3.schema.json#/components/schemas/button"
-                  }
-                },
-                "title": "Find element and click"
-              }
-            ]
-          },
-          "type": {
-            "description": "Type keys after finding the element. Either a string or an object with a `keys` field as defined in [`type`](type). To type in the element, make the element active with the `click` parameter.",
-            "allOf": [
-              {
-                "$ref": "/home/runner/work/doc-detective/doc-detective/src/common/src/schemas/build/type_v3.schema.json#"
-              },
-              {
-                "not": {
-                  "type": "object",
-                  "required": [
-                    "selector",
-                    "elementText",
-                    "elementId",
-                    "elementTestId",
-                    "elementClass",
-                    "elementAttribute",
-                    "elementAria"
-                  ],
-                  "title": "Find element and type"
-                }
-              }
-            ]
-          }
-        }
-      }
-    }
-  },
-  "examples": [
-    "Find me!",
-    {
-      "selector": "[title=Search]"
-    },
-    {
-      "selector": "[title=Search]",
-      "timeout": 10000,
-      "elementText": "Search",
-      "moveTo": true,
-      "click": true,
-      "type": "shorthair cat"
-    },
-    {
-      "selector": "[title=Search]",
-      "click": {
-        "button": "right"
-      }
-    },
-    {
-      "selector": "[title=Search]",
-      "timeout": 10000,
-      "elementText": "Search",
-      "moveTo": true,
-      "click": true,
-      "type": {
-        "keys": [
-          "shorthair cat"
-        ],
-        "inputDelay": 100
-      }
-    },
-    {
-      "elementId": "/^user-[0-9]+$/",
-      "elementClass": [
-        "admin",
-        "/^level-[1-5]$/"
-      ],
-      "elementAttribute": {
-        "data-active": true,
-        "data-score": "/^[0-9]+$/"
-      },
-      "timeout": 8000,
-      "moveTo": false
-    }
-  ],
-  "$id": "/home/runner/work/doc-detective/doc-detective/src/common/src/schemas/src_schemas/find_v3.schema.json"
-}

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

@@ -1,63 +0,0 @@
-{
-  "title": "goTo",
-  "type": "object",
-  "description": "Navigate to a specified URL.",
-  "properties": {
-    "id": {
-      "type": "string",
-      "description": "ID of the step."
-    },
-    "description": {
-      "type": "string",
-      "description": "Description of the step."
-    },
-    "action": {
-      "type": "string",
-      "const": "goTo",
-      "description": "Action to perform."
-    },
-    "url": {
-      "type": "string",
-      "description": "URL to navigate to.",
-      "pattern": "(^(http://|https://|/).*|\\$[A-Za-z0-9_]+)",
-      "transform": [
-        "trim"
-      ]
-    },
-    "origin": {
-      "type": "string",
-      "description": "Protocol and domain to navigate to. Prepended to `url`.",
-      "transform": [
-        "trim"
-      ]
-    }
-  },
-  "dynamicDefaults": {
-    "id": "uuid"
-  },
-  "required": [
-    "action",
-    "url"
-  ],
-  "additionalProperties": false,
-  "examples": [
-    {
-      "action": "goTo",
-      "url": "https://www.google.com"
-    },
-    {
-      "id": "ddec5e20-2e81-4f38-867c-92c8d9516755",
-      "description": "This is a test!",
-      "action": "goTo",
-      "url": "https://www.google.com"
-    },
-    {
-      "id": "ddec5e20-2e81-4f38-867c-92c8d9516756",
-      "description": "This is a test!",
-      "action": "goTo",
-      "url": "/search",
-      "origin": "https://www.google.com"
-    }
-  ],
-  "$id": "/home/runner/work/doc-detective/doc-detective/src/common/src/schemas/src_schemas/goTo_v2.schema.json"
-}