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

package/src/schemas/src_schemas/context_v2.schema.json

@@ -1,108 +0,0 @@
-{
-  "title": "context",
-  "type": "object",
-  "description": "An application and supported platforms.\n\nIf no contexts are specified but a context is required by one or more tests, Doc Detective attempts to identify a supported context in the current environment and run tests against it. For browsers, context priority is Firefox > Chrome > Chromium.",
-  "properties": {
-    "app": {
-      "type": "object",
-      "description": "The application to run.",
-      "additionalProperties": false,
-      "required": ["name"],
-      "properties": {
-        "name": {
-          "type": "string",
-          "description": "Name of the application.",
-          "enum": ["chrome", "firefox", "safari", "edge"]
-        },
-        "path": {
-          "type": "string",
-          "description": "Absolute path or command for the application. If not specified, defaults to typical install paths per platform. If specified but the path is invalid, the context is skipped."
-        },
-        "options": {
-          "type": "object",
-          "description": "Options to pass to the app. Only works when `name` is `firefox` or `chrome`.",
-          "additionalProperties": false,
-          "properties": {
-            "width": {
-              "type": "integer",
-              "description": "Width of the window in pixels."
-            },
-            "height": {
-              "type": "integer",
-              "description": "Height of the window in pixels."
-            },
-            "viewport_height": {
-              "type": "integer",
-              "description": "Height of the viewport in pixels. Overrides `height`."
-            },
-            "viewport_width": {
-              "type": "integer",
-              "description": "Width of the viewport in pixels. Overrides `width`."
-            },
-            "headless": {
-              "type": "boolean",
-              "description": "If `true`, runs the browser in headless mode. Not supported by Safari."
-            },
-            "driverPath": {
-              "type": "string",
-              "description": "Path to the browser driver. If not specified, defaults to internally managed dependencies."
-            }
-          }
-        }
-      }
-    },
-    "platforms": {
-      "description": "Supported platforms for the application.",
-      "type": "array",
-      "items": {
-        "type": "string",
-        "enum": ["linux", "mac", "windows"]
-      }
-    }
-  },
-  "required": ["app", "platforms"],
-  "additionalProperties": false,
-  "examples": [
-    {
-      "app": {
-        "name": "chrome"
-      },
-      "platforms": ["linux"]
-    },
-    {
-      "app": {
-        "name": "chrome",
-        "options": {
-          "viewport_width": 800,
-          "viewport_height": 600
-        }
-      },
-      "platforms": ["linux"]
-    },
-    {
-      "app": {
-        "name": "firefox",
-        "options": {
-          "width": 800,
-          "height": 600,
-          "headless": false,
-          "driverPath": "/usr/bin/geckodriver"
-        }
-      },
-      "platforms": ["linux", "windows", "mac"]
-    },
-    {
-      "app": {
-        "name": "safari"
-      },
-      "platforms": ["mac"]
-    },
-    {
-      "app": {
-        "name": "firefox",
-        "path": "/usr/bin/firefox"
-      },
-      "platforms": ["linux"]
-    }
-  ]
-}

package/src/schemas/src_schemas/context_v3.schema.json

@@ -1,202 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "context",
-  "type": "object",
-  "description": "A context in which to perform tests. If no contexts are specified but a context is required by one or more tests, Doc Detective attempts to identify a supported context in the current environment and run tests against it. For example, if a browser isn't specified but is required by steps in the test, Doc Detective will search for and use a supported browser available in the current environment.",
-  "additionalProperties": false,
-  "dynamicDefaults": {
-    "contextId": "uuid"
-  },
-  "properties": {
-    "$schema": {
-      "description": "JSON Schema for this object.",
-      "type": "string",
-      "enum": [
-        "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/context_v3.schema.json"
-      ]
-    },
-    "contextId": {
-      "type": "string",
-      "description": "Unique identifier for the context."
-    },
-    "platforms": {
-      "description": "Platforms to run tests on.",
-      "anyOf": [
-        {
-          "$ref": "#/components/schemas/platform"
-        },
-        {
-          "type": "array",
-          "items": {
-            "$ref": "#/components/schemas/platform"
-          }
-        }
-      ]
-    },
-    "browsers": {
-      "description": "Browsers to run tests on.",
-      "anyOf": [
-        {
-          "$ref": "#/components/schemas/browserName"
-        },
-        {
-          "$ref": "#/components/schemas/browser"
-        },
-        {
-          "type": "array",
-          "items": {
-            "anyOf": [
-              {
-                "$ref": "#/components/schemas/browserName"
-              },
-              {
-                "$ref": "#/components/schemas/browser"
-              }
-            ]
-          }
-        }
-      ]
-    }
-  },
-  "components": {
-    "schemas": {
-      "platform": {
-        "type": "string",
-        "enum": ["linux", "mac", "windows"]
-      },
-      "browserName": {
-        "type": "string",
-        "description": "Name of the browser.",
-        "enum": ["chrome", "firefox", "safari", "webkit"],
-        "$comment": "`safari` is just a shortcut for `webkit`. Included for visibility and to reduce questions."
-      },
-      "browser": {
-        "type": "object",
-        "description": "Browser configuration.",
-        "required": ["name"],
-        "additionalProperties": false,
-        "properties": {
-          "name": {
-            "$ref": "#/components/schemas/browserName"
-          },
-          "headless": {
-            "type": "boolean",
-            "description": "If `true`, runs the browser in headless mode.",
-            "default": true
-          },
-          "window": {
-            "type": "object",
-            "description": "Browser dimensions.",
-            "additionalProperties": false,
-            "properties": {
-              "width": {
-                "type": "integer",
-                "description": "Width of the browser window in pixels."
-              },
-              "height": {
-                "type": "integer",
-                "description": "Height of the browser window in pixels."
-              }
-            },
-            "title": "Browser Window"
-          },
-          "viewport": {
-            "type": "object",
-            "description": "Viewport dimensions.",
-            "additionalProperties": false,
-            "properties": {
-              "width": {
-                "type": "integer",
-                "description": "Width of the viewport in pixels."
-              },
-              "height": {
-                "type": "integer",
-                "description": "Height of the viewport in pixels."
-              }
-            },
-            "title": "Browser Viewport"
-          }
-        },
-        "title": "Browser"
-      }
-    }
-  },
-  "examples": [
-    {
-      "platforms": "linux",
-      "browsers": "chrome"
-    },
-    {
-      "platforms": ["windows", "mac", "linux"],
-      "browsers": ["chrome", "firefox", "webkit"]
-    },
-    {
-      "browsers": {
-        "name": "chrome",
-        "headless": true
-      }
-    },
-    {
-      "browsers": [
-        {
-          "name": "chrome",
-          "headless": true
-        },
-        {
-          "name": "firefox"
-        }
-      ]
-    },
-    {
-      "platforms": ["mac", "linux"],
-      "browsers": {
-        "name": "chrome",
-        "headless": true
-      }
-    },
-    {
-      "platforms": ["windows", "mac", "linux"],
-      "browsers": [
-        {
-          "name": "chrome",
-          "headless": true,
-          "window": {
-            "width": 1920,
-            "height": 1080
-          },
-          "viewport": {
-            "width": 1600,
-            "height": 900
-          }
-        },
-        {
-          "name": "firefox",
-          "window": {
-            "width": 1366,
-            "height": 768
-          }
-        },
-        {
-          "name": "webkit",
-          "headless": false,
-          "viewport": {
-            "width": 1440,
-            "height": 900
-          }
-        }
-      ]
-    },
-    {
-      "platforms": "mac",
-      "browsers": [
-        {
-          "name": "safari",
-          "window": {
-            "width": 1280,
-            "height": 800
-          }
-        }
-      ]
-    }
-  ]
-}

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

@@ -1,185 +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": {
-      "$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"
-            ]
-          },
-          {
-            "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/src_schemas/find_v1.schema.json

@@ -1,137 +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": {
-          "$ref": "wait_v1.schema.json#/properties/duration"
-        }
-      }
-    },
-    "matchText": {
-      "type": "object",
-      "description": "Check if an element displays the expected text.",
-      "additionalProperties": false,
-      "properties": {
-        "text": {
-          "$ref": "matchText_v1.schema.json#/properties/text"
-        }
-      },
-      "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": {
-          "$ref": "moveMouse_v1.schema.json#/properties/alignH"
-        },
-        "alignV": {
-          "$ref": "moveMouse_v1.schema.json#/properties/alignV"
-        },
-        "offsetX": {
-          "$ref": "moveMouse_v1.schema.json#/properties/offsetX"
-        },
-        "offsetY": {
-          "$ref": "moveMouse_v1.schema.json#/properties/offsetY"
-        }
-      }
-    },
-    "click": {
-      "type": "object",
-      "description": "Click an element specified by a CSS selector.",
-      "additionalProperties": false,
-      "properties": {
-        "alignH": {
-          "$ref": "click_v1.schema.json#/properties/alignH"
-        },
-        "alignV": {
-          "$ref": "click_v1.schema.json#/properties/alignV"
-        },
-        "offsetX": {
-          "$ref": "click_v1.schema.json#/properties/offsetX"
-        },
-        "offsetY": {
-          "$ref": "click_v1.schema.json#/properties/offsetY"
-        }
-      }
-    },
-    "type": {
-      "type": "object",
-      "description": "Click an element specified by a CSS selector.",
-      "additionalProperties": false,
-      "anyOf": [
-        {
-          "required": [
-            "keys"
-          ]
-        },
-        {
-          "required": [
-            "trailingSpecialKey"
-          ]
-        }
-      ],
-      "properties": {
-        "keys": {
-          "$ref": "type_v1.schema.json#/properties/keys"
-        },
-        "trailingSpecialKey": {
-          "$ref": "type_v1.schema.json#/properties/trailingSpecialKey"
-        },
-        "env": {
-          "$ref": "type_v1.schema.json#/properties/env"
-        }
-      }
-    }
-  },
-  "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"
-      }
-    }
-  ]
-}