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

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

@@ -1,236 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "runShell",
-  "description": "Perform a native shell command.",
-  "anyOf": [
-    {
-      "title": "Run shell command (simple)",
-      "description": "Command to perform in the machine's default shell.",
-      "type": "string",
-      "transform": [
-        "trim"
-      ]
-    },
-    {
-      "type": "object",
-      "required": [
-        "command"
-      ],
-      "additionalProperties": false,
-      "properties": {
-        "command": {
-          "type": "string",
-          "description": "Command to perform in the machine's default shell."
-        },
-        "args": {
-          "type": "array",
-          "description": "Arguments for the command.",
-          "items": {
-            "anyOf": [
-              {
-                "type": "string"
-              }
-            ]
-          },
-          "default": []
-        },
-        "workingDirectory": {
-          "type": "string",
-          "description": "Working directory for the command.",
-          "default": "."
-        },
-        "exitCodes": {
-          "type": "array",
-          "description": "Expected exit codes of the command. If the command's actual exit code isn't in this list, the step fails.",
-          "items": {
-            "anyOf": [
-              {
-                "type": "integer"
-              }
-            ]
-          },
-          "default": [
-            0
-          ]
-        },
-        "stdio": {
-          "type": "string",
-          "description": "Content expected in the command's stdout or stderr. If the expected content can't be found in the command's stdout or stderr, the step fails. Supports strings and regular expressions. To use a regular expression, the string must start and end with a forward slash, like in `/^hello-world.*/`."
-        },
-        "path": {
-          "type": "string",
-          "description": "File path to save the command's output, relative to `directory`."
-        },
-        "directory": {
-          "type": "string",
-          "description": "Directory to save the command's output. If the directory doesn't exist, creates the directory. If not specified, the directory is your media directory."
-        },
-        "maxVariation": {
-          "type": "number",
-          "description": "Allowed variation as a fraction (0 to 1) of text different between the current output and previously saved output. For example, 0.1 means 10%. If the difference between the current output and the previous output is greater than `maxVariation`, the step fails. If output doesn't exist at `path`, this value is ignored.",
-          "default": 0,
-          "minimum": 0,
-          "maximum": 1
-        },
-        "overwrite": {
-          "type": "string",
-          "description": "If `true`, overwrites the existing output at `path` if it exists.\nIf `aboveVariation`, overwrites the existing output at `path` if the difference between the new output and the existing output is greater than `maxVariation`.",
-          "enum": [
-            "true",
-            "false",
-            "aboveVariation"
-          ],
-          "default": "aboveVariation"
-        },
-        "timeout": {
-          "type": "integer",
-          "description": "Max time in milliseconds the command is allowed to run. If the command runs longer than this, the step fails.",
-          "default": 60000
-        }
-      },
-      "title": "Run shell command (detailed)"
-    }
-  ],
-  "components": {
-    "schemas": {
-      "string": {
-        "title": "Run shell command (simple)",
-        "description": "Command to perform in the machine's default shell.",
-        "type": "string",
-        "transform": [
-          "trim"
-        ]
-      },
-      "object": {
-        "type": "object",
-        "required": [
-          "command"
-        ],
-        "additionalProperties": false,
-        "properties": {
-          "command": {
-            "type": "string",
-            "description": "Command to perform in the machine's default shell."
-          },
-          "args": {
-            "type": "array",
-            "description": "Arguments for the command.",
-            "items": {
-              "anyOf": [
-                {
-                  "type": "string"
-                }
-              ]
-            },
-            "default": []
-          },
-          "workingDirectory": {
-            "type": "string",
-            "description": "Working directory for the command.",
-            "default": "."
-          },
-          "exitCodes": {
-            "type": "array",
-            "description": "Expected exit codes of the command. If the command's actual exit code isn't in this list, the step fails.",
-            "items": {
-              "anyOf": [
-                {
-                  "type": "integer"
-                }
-              ]
-            },
-            "default": [
-              0
-            ]
-          },
-          "stdio": {
-            "type": "string",
-            "description": "Content expected in the command's stdout or stderr. If the expected content can't be found in the command's stdout or stderr, the step fails. Supports strings and regular expressions. To use a regular expression, the string must start and end with a forward slash, like in `/^hello-world.*/`."
-          },
-          "path": {
-            "type": "string",
-            "description": "File path to save the command's output, relative to `directory`."
-          },
-          "directory": {
-            "type": "string",
-            "description": "Directory to save the command's output. If the directory doesn't exist, creates the directory. If not specified, the directory is your media directory."
-          },
-          "maxVariation": {
-            "type": "number",
-            "description": "Allowed variation as a fraction (0 to 1) of text different between the current output and previously saved output. For example, 0.1 means 10%. If the difference between the current output and the previous output is greater than `maxVariation`, the step fails. If output doesn't exist at `path`, this value is ignored.",
-            "default": 0,
-            "minimum": 0,
-            "maximum": 1
-          },
-          "overwrite": {
-            "type": "string",
-            "description": "If `true`, overwrites the existing output at `path` if it exists.\nIf `aboveVariation`, overwrites the existing output at `path` if the difference between the new output and the existing output is greater than `maxVariation`.",
-            "enum": [
-              "true",
-              "false",
-              "aboveVariation"
-            ],
-            "default": "aboveVariation"
-          },
-          "timeout": {
-            "type": "integer",
-            "description": "Max time in milliseconds the command is allowed to run. If the command runs longer than this, the step fails.",
-            "default": 60000
-          }
-        },
-        "title": "Run shell command (detailed)"
-      }
-    }
-  },
-  "examples": [
-    "docker run hello-world",
-    {
-      "command": "echo",
-      "args": [
-        "$USER"
-      ]
-    },
-    {
-      "command": "echo",
-      "args": [
-        "hello-world"
-      ]
-    },
-    {
-      "command": "docker run hello-world",
-      "timeout": 20000,
-      "exitCodes": [
-        0
-      ],
-      "stdio": "Hello from Docker!"
-    },
-    {
-      "command": "false",
-      "exitCodes": [
-        1
-      ]
-    },
-    {
-      "command": "echo",
-      "args": [
-        "setup"
-      ],
-      "exitCodes": [
-        0
-      ],
-      "stdio": "/.*?/"
-    },
-    {
-      "command": "docker run hello-world",
-      "workingDirectory": ".",
-      "exitCodes": [
-        0
-      ],
-      "stdio": "Hello from Docker!",
-      "path": "docker-output.txt",
-      "directory": "output",
-      "maxVariation": 0.1,
-      "overwrite": "aboveVariation"
-    }
-  ]
-}

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

@@ -1,245 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "saveCookie",
-  "description": "Save a specific browser cookie to a file or environment variable for later reuse.",
-  "anyOf": [
-    {
-      "type": "string",
-      "title": "Cookie name",
-      "description": "Name of the specific cookie to save. Will be saved to a default file path or environment variable.",
-      "pattern": "^[A-Za-z0-9_./\\-]+$",
-      "transform": [
-        "trim"
-      ]
-    },
-    {
-      "type": "object",
-      "additionalProperties": false,
-      "properties": {
-        "$schema": {
-          "description": "Optional self-describing schema URI for linters",
-          "type": "string",
-          "format": "uri-reference"
-        },
-        "name": {
-          "type": "string",
-          "title": "Cookie name",
-          "description": "Name of the specific cookie to save.",
-          "pattern": "^[A-Za-z0-9_.-]+$",
-          "transform": [
-            "trim"
-          ]
-        },
-        "variable": {
-          "type": "string",
-          "title": "Environment variable name",
-          "description": "Environment variable name to store the cookie as JSON string.",
-          "pattern": "^[A-Za-z_][A-Za-z0-9_]*$",
-          "transform": [
-            "trim"
-          ]
-        },
-        "path": {
-          "type": "string",
-          "title": "Cookie file path",
-          "description": "File path to save the cookie, relative to directory. Uses Netscape cookie format.",
-          "transform": [
-            "trim"
-          ]
-        },
-        "directory": {
-          "type": "string",
-          "title": "Directory path",
-          "description": "Directory to save the cookie file. If not specified, uses output directory.",
-          "transform": [
-            "trim"
-          ]
-        },
-        "overwrite": {
-          "type": "boolean",
-          "title": "Overwrite existing file",
-          "description": "Whether to overwrite existing cookie file.",
-          "default": false
-        },
-        "domain": {
-          "type": "string",
-          "title": "Cookie domain",
-          "description": "Specific domain to filter the cookie by (optional).",
-          "transform": [
-            "trim"
-          ]
-        }
-      },
-      "required": [
-        "name"
-      ],
-      "anyOf": [
-        {
-          "required": [
-            "path"
-          ],
-          "not": {
-            "required": [
-              "variable"
-            ]
-          }
-        },
-        {
-          "required": [
-            "variable"
-          ],
-          "not": {
-            "anyOf": [
-              {
-                "required": [
-                  "path"
-                ]
-              },
-              {
-                "required": [
-                  "directory"
-                ]
-              }
-            ]
-          }
-        }
-      ],
-      "title": "Save cookie (detailed)"
-    }
-  ],
-  "components": {
-    "schemas": {
-      "string": {
-        "type": "string",
-        "title": "Cookie name",
-        "description": "Name of the specific cookie to save. Will be saved to a default file path or environment variable.",
-        "pattern": "^[A-Za-z0-9_./\\-]+$",
-        "transform": [
-          "trim"
-        ]
-      },
-      "object": {
-        "type": "object",
-        "additionalProperties": false,
-        "properties": {
-          "$schema": {
-            "description": "Optional self-describing schema URI for linters",
-            "type": "string",
-            "format": "uri-reference"
-          },
-          "name": {
-            "type": "string",
-            "title": "Cookie name",
-            "description": "Name of the specific cookie to save.",
-            "pattern": "^[A-Za-z0-9_.-]+$",
-            "transform": [
-              "trim"
-            ]
-          },
-          "variable": {
-            "type": "string",
-            "title": "Environment variable name",
-            "description": "Environment variable name to store the cookie as JSON string.",
-            "pattern": "^[A-Za-z_][A-Za-z0-9_]*$",
-            "transform": [
-              "trim"
-            ]
-          },
-          "path": {
-            "type": "string",
-            "title": "Cookie file path",
-            "description": "File path to save the cookie, relative to directory. Uses Netscape cookie format.",
-            "transform": [
-              "trim"
-            ]
-          },
-          "directory": {
-            "type": "string",
-            "title": "Directory path",
-            "description": "Directory to save the cookie file. If not specified, uses output directory.",
-            "transform": [
-              "trim"
-            ]
-          },
-          "overwrite": {
-            "type": "boolean",
-            "title": "Overwrite existing file",
-            "description": "Whether to overwrite existing cookie file.",
-            "default": false
-          },
-          "domain": {
-            "type": "string",
-            "title": "Cookie domain",
-            "description": "Specific domain to filter the cookie by (optional).",
-            "transform": [
-              "trim"
-            ]
-          }
-        },
-        "required": [
-          "name"
-        ],
-        "anyOf": [
-          {
-            "required": [
-              "path"
-            ],
-            "not": {
-              "required": [
-                "variable"
-              ]
-            }
-          },
-          {
-            "required": [
-              "variable"
-            ],
-            "not": {
-              "anyOf": [
-                {
-                  "required": [
-                    "path"
-                  ]
-                },
-                {
-                  "required": [
-                    "directory"
-                  ]
-                }
-              ]
-            }
-          }
-        ],
-        "title": "Save cookie (detailed)"
-      }
-    }
-  },
-  "examples": [
-    "session_token",
-    "test_env_cookie",
-    {
-      "name": "auth_cookie",
-      "path": "auth-cookie.txt"
-    },
-    {
-      "name": "session_token",
-      "variable": "SESSION_TOKEN"
-    },
-    {
-      "name": "test_cookie",
-      "path": "test-cookie.txt",
-      "overwrite": true
-    },
-    {
-      "name": "user_session",
-      "path": "user-session.txt",
-      "directory": "./test-data",
-      "overwrite": true
-    },
-    {
-      "name": "login_token",
-      "path": "login-token.txt",
-      "domain": "app.example.com"
-    }
-  ]
-}

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

@@ -1,149 +0,0 @@
-{
-  "title": "saveScreenshot",
-  "type": "object",
-  "description": "Takes a screenshot in PNG format.",
-  "properties": {
-    "id": {
-      "type": "string",
-      "description": "ID of the step."
-    },
-    "description": {
-      "type": "string",
-      "description": "Description of the step."
-    },
-    "action": {
-      "type": "string",
-      "const": "saveScreenshot",
-      "description": "The action to perform."
-    },
-    "path": {
-      "type": "string",
-      "description": "File path of the PNG file, relative to `directory`. If not specified, the file name is the ID of the step.",
-      "pattern": "([A-Za-z0-9_-]*\\.(png|PNG)$|\\$[A-Za-z0-9_]+)"
-    },
-    "directory": {
-      "type": "string",
-      "description": "Directory of the PNG file. If the directory doesn't exist, creates the directory."
-    },
-    "maxVariation": {
-      "type": "number",
-      "description": "Allowed variation in percentage of pixels between the new screenshot and the existing screenshot at `path`. If the difference between the new screenshot and the existing screenshot is greater than `maxVariation`, the step fails. If a screenshot doesn't exist at `path`, this value is ignored.",
-      "default": 5,
-      "minimum": 0,
-      "maximum": 100
-    },
-    "overwrite": {
-      "type": "string",
-      "description": "If `true`, overwrites the existing screenshot at `path` if it exists.\nIf `byVariation`, overwrites the existing screenshot at `path` if the difference between the new screenshot and the existing screenshot is greater than `maxVariation`.",
-      "enum": [
-        "true",
-        "false",
-        "byVariation"
-      ],
-      "default": "false"
-    },
-    "crop": {
-      "type": "object",
-      "description": "Crops the screenshot.",
-      "properties": {
-        "selector": {
-          "type": "string",
-          "description": "Selector of the element to crop the image to."
-        },
-        "padding": {
-          "oneOf": [
-            {
-              "type": "number",
-              "description": "Padding in pixels to add to the bounds of the element.",
-              "minimum": 0
-            },
-            {
-              "type": "object",
-              "properties": {
-                "top": {
-                  "type": "number",
-                  "minimum": 0
-                },
-                "right": {
-                  "type": "number",
-                  "minimum": 0
-                },
-                "bottom": {
-                  "type": "number",
-                  "minimum": 0
-                },
-                "left": {
-                  "type": "number",
-                  "minimum": 0
-                }
-              }
-            }
-          ]
-        }
-      },
-      "required": [
-        "selector"
-      ],
-      "additionalProperties": false
-    }
-  },
-  "dynamicDefaults": {
-    "id": "uuid"
-  },
-  "required": [
-    "action"
-  ],
-  "additionalProperties": false,
-  "examples": [
-    {
-      "action": "saveScreenshot"
-    },
-    {
-      "action": "saveScreenshot",
-      "path": "results.png"
-    },
-    {
-      "action": "saveScreenshot",
-      "path": "results.png",
-      "directory": "static/images"
-    },
-    {
-      "action": "saveScreenshot",
-      "path": "results.png",
-      "directory": "static/images",
-      "maxVariation": 10,
-      "overwrite": "byVariation"
-    },
-    {
-      "action": "saveScreenshot",
-      "path": "results.png",
-      "directory": "static/images",
-      "crop": {
-        "selector": "#element"
-      }
-    },
-    {
-      "action": "saveScreenshot",
-      "path": "results.png",
-      "directory": "static/images",
-      "crop": {
-        "selector": "#element",
-        "padding": 10
-      }
-    },
-    {
-      "action": "saveScreenshot",
-      "path": "results.png",
-      "directory": "static/images",
-      "crop": {
-        "selector": "#element",
-        "padding": {
-          "top": 10,
-          "right": 20,
-          "bottom": 30,
-          "left": 40
-        }
-      }
-    }
-  ]
-}

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

@@ -1,48 +0,0 @@
-{
-  "title": "screenshot",
-  "type": "object",
-  "description": "Capture a screenshot and optionally compare it with a previous image.",
-  "properties": {
-    "action": {
-      "type": "string",
-      "const": "screenshot"
-    },
-    "mediaDirectory": {
-      "type": "string",
-      "description": "The directory path for media created by the action. Overrides the default directory config. Default is config.imageDirectory or config.videoDirectory depending on the file type."
-    },
-    "filename": {
-      "type": "string",
-      "description": "Name of the media file. If not specified, the filename is randomized."
-    },
-    "matchPrevious": {
-      "type": "boolean",
-      "description": "If `true`, performs a pixel-diff against an image that matches the path of the new screenshot. If a previous image doesn't exist at the path, this option is ignored.",
-      "default": false
-    },
-    "matchThreshold": {
-      "type": "number",
-      "description": "Decimal value of percentage of pixels that must be different between the old and new screenshots to fail the action. For example, a value of `0.3` fails the action if the diff is 30% or more of pixels.",
-      "default": 0.3,
-      "exclusiveMinimum": 0,
-      "maximum": 1
-    }
-  },
-  "required": [
-    "action"
-  ],
-  "additionalProperties": false,
-  "examples": [
-    {
-      "action": "screenshot",
-      "filename": "results.png"
-    },
-    {
-      "action": "screenshot",
-      "mediaDirectory": "samples",
-      "filename": "results.png",
-      "matchPrevious": true,
-      "matchThreshold": 0.3
-    }
-  ]
-}