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

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

@@ -1,496 +0,0 @@
-{
-  "$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": {
-      "description": "The element to drag.",
-      "anyOf": [
-        {
-          "title": "Element (simple)",
-          "type": "string",
-          "description": "Display text, selector, or regex pattern (enclosed in forward slashes) of the element."
-        },
-        {
-          "title": "Element (detailed)",
-          "type": "object",
-          "anyOf": [
-            {
-              "required": [
-                "selector"
-              ]
-            },
-            {
-              "required": [
-                "elementText"
-              ]
-            },
-            {
-              "required": [
-                "elementId"
-              ]
-            },
-            {
-              "required": [
-                "elementTestId"
-              ]
-            },
-            {
-              "required": [
-                "elementClass"
-              ]
-            },
-            {
-              "required": [
-                "elementAttribute"
-              ]
-            },
-            {
-              "required": [
-                "elementAria"
-              ]
-            }
-          ],
-          "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."
-            },
-            "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
-            }
-          }
-        }
-      ]
-    },
-    "target": {
-      "description": "The target location to drop the element.",
-      "anyOf": [
-        {
-          "title": "Element (simple)",
-          "type": "string",
-          "description": "Display text, selector, or regex pattern (enclosed in forward slashes) of the element."
-        },
-        {
-          "title": "Element (detailed)",
-          "type": "object",
-          "anyOf": [
-            {
-              "required": [
-                "selector"
-              ]
-            },
-            {
-              "required": [
-                "elementText"
-              ]
-            },
-            {
-              "required": [
-                "elementId"
-              ]
-            },
-            {
-              "required": [
-                "elementTestId"
-              ]
-            },
-            {
-              "required": [
-                "elementClass"
-              ]
-            },
-            {
-              "required": [
-                "elementAttribute"
-              ]
-            },
-            {
-              "required": [
-                "elementAria"
-              ]
-            }
-          ],
-          "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."
-            },
-            "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
-            }
-          }
-        }
-      ]
-    },
-    "duration": {
-      "type": "integer",
-      "description": "Duration of the drag operation in milliseconds.",
-      "default": 1000,
-      "minimum": 0
-    }
-  },
-  "components": {
-    "schemas": {
-      "elementSpecification": {
-        "anyOf": [
-          {
-            "title": "Element (simple)",
-            "type": "string",
-            "description": "Display text, selector, or regex pattern (enclosed in forward slashes) of the element."
-          },
-          {
-            "title": "Element (detailed)",
-            "type": "object",
-            "anyOf": [
-              {
-                "required": [
-                  "selector"
-                ]
-              },
-              {
-                "required": [
-                  "elementText"
-                ]
-              },
-              {
-                "required": [
-                  "elementId"
-                ]
-              },
-              {
-                "required": [
-                  "elementTestId"
-                ]
-              },
-              {
-                "required": [
-                  "elementClass"
-                ]
-              },
-              {
-                "required": [
-                  "elementAttribute"
-                ]
-              },
-              {
-                "required": [
-                  "elementAria"
-                ]
-              }
-            ],
-            "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."
-              },
-              "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
-              }
-            }
-          }
-        ]
-      },
-      "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"
-            ]
-          },
-          {
-            "required": [
-              "elementId"
-            ]
-          },
-          {
-            "required": [
-              "elementTestId"
-            ]
-          },
-          {
-            "required": [
-              "elementClass"
-            ]
-          },
-          {
-            "required": [
-              "elementAttribute"
-            ]
-          },
-          {
-            "required": [
-              "elementAria"
-            ]
-          }
-        ],
-        "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."
-          },
-          "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
-          }
-        }
-      }
-    }
-  },
-  "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.*/"
-      }
-    }
-  ]
-}

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

@@ -1,12 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "endRecord",
-  "description": "Stop the current recording.",
-  "type": [
-    "boolean",
-    "null"
-  ],
-  "examples": [
-    true
-  ]
-}

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

@@ -1,171 +0,0 @@
-{
-  "title": "find",
-  "type": "object",
-  "description": "Check if an element exists with the specified CSS selector.",
-  "properties": {
-    "action": {
-      "type": "string",
-      "const": "find"
-    },
-    "css": {
-      "type": "string",
-      "description": "CSS selector that uniquely identified the element."
-    },
-    "wait": {
-      "type": "object",
-      "description": "Pause before performing the next action.",
-      "additionalProperties": false,
-      "properties": {
-        "duration": {
-          "type": "number",
-          "description": "Seconds to wait. If `css` is set, the maximum duration to wait for the element to become available.",
-          "default": 10000
-        }
-      }
-    },
-    "matchText": {
-      "type": "object",
-      "description": "Check if an element displays the expected text.",
-      "additionalProperties": false,
-      "properties": {
-        "text": {
-          "type": "string",
-          "description": "Text that the element should display."
-        }
-      },
-      "required": [
-        "text"
-      ]
-    },
-    "moveMouse": {
-      "type": "object",
-      "description": "Move the mouse to an element specified by a CSS selector. Only runs if a test is being recorded.",
-      "additionalProperties": false,
-      "properties": {
-        "alignH": {
-          "type": "string",
-          "description": "Horizontal alignment of the mouse to the element.",
-          "enum": [
-            "left",
-            "center",
-            "right"
-          ]
-        },
-        "alignV": {
-          "type": "string",
-          "description": "Vertical alignment of the mouse to the element.",
-          "enum": [
-            "left",
-            "center",
-            "right"
-          ]
-        },
-        "offsetX": {
-          "type": "integer",
-          "description": "Number of pixels to offset the mouse along the X axis, relative to the element center. Positive values offset to the right. Negative values offset to the left."
-        },
-        "offsetY": {
-          "type": "integer",
-          "description": "Number of pixels to offset the mouse along the Y axis, relative to the element center. Positive values offset to the top. Negative values offset to the bottom."
-        }
-      }
-    },
-    "click": {
-      "type": "object",
-      "description": "Click an element specified by a CSS selector.",
-      "additionalProperties": false,
-      "properties": {
-        "alignH": {
-          "type": "string",
-          "description": "Horizontal alignment of the mouse to the element.",
-          "enum": [
-            "left",
-            "center",
-            "right"
-          ]
-        },
-        "alignV": {
-          "type": "string",
-          "description": "Vertical alignment of the mouse to the element.",
-          "enum": [
-            "left",
-            "center",
-            "right"
-          ]
-        },
-        "offsetX": {
-          "type": "integer",
-          "description": "Number of pixels to offset the mouse along the X axis, relative to the element center. Positive values offset to the right. Negative values offset to the left."
-        },
-        "offsetY": {
-          "type": "integer",
-          "description": "Number of pixels to offset the mouse along the Y axis, relative to the element center. Positive values offset to the top. Negative values offset to the bottom."
-        }
-      }
-    },
-    "type": {
-      "type": "object",
-      "description": "Click an element specified by a CSS selector.",
-      "additionalProperties": false,
-      "anyOf": [
-        {
-          "required": [
-            "keys"
-          ]
-        },
-        {
-          "required": [
-            "trailingSpecialKey"
-          ]
-        }
-      ],
-      "properties": {
-        "keys": {
-          "type": "string",
-          "description": "String of keys to enter."
-        },
-        "trailingSpecialKey": {
-          "type": "string",
-          "description": "Special key pressed after the 'keys' value, if present. Supported values: https://github.com/puppeteer/puppeteer/blob/main/src/common/USKeyboardLayout.ts"
-        },
-        "env": {
-          "type": "string",
-          "description": "Path to a `.env` file to load before performing the action."
-        }
-      }
-    }
-  },
-  "required": [
-    "action",
-    "css"
-  ],
-  "additionalProperties": false,
-  "examples": [
-    {
-      "action": "find",
-      "css": "[title=Search]"
-    },
-    {
-      "action": "find",
-      "css": "[title=Search]",
-      "wait": {
-        "duration": 10000
-      },
-      "matchText": {
-        "text": "Search"
-      },
-      "moveMouse": {
-        "alignH": "center",
-        "alignV": "center",
-        "offsetX": 0,
-        "offsetY": 0
-      },
-      "click": {},
-      "type": {
-        "keys": "$SHORTHAIR_CAT_SEARCH",
-        "trailingSpecialKey": "Enter",
-        "env": "./sample/variables.env"
-      }
-    }
-  ]
-}