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

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

@@ -1,257 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "goTo",
-  "anyOf": [
-    {
-      "$ref": "#/components/schemas/string"
-    },
-    {
-      "$ref": "#/components/schemas/object"
-    }
-  ],
-  "components": {
-    "schemas": {
-      "string": {
-        "title": "Go to URL (simple)",
-        "description": "Navigate to an HTTP or HTTPS URL. Can be a full URL or a path. If a path is provided, navigates relative to the current URL, if any.",
-        "type": "string",
-        "pattern": "(^(http://|https://|/).*|\\$[A-Za-z0-9_]+)",
-        "transform": [
-          "trim"
-        ]
-      },
-      "object": {
-        "description": "Navigate to an HTTP or HTTPS URL.",
-        "type": "object",
-        "additionalProperties": false,
-        "required": [
-          "url"
-        ],
-        "properties": {
-          "url": {
-            "type": "string",
-            "description": "URL to navigate to. Can be a full URL or a path. If a path is provided and `origin` is specified, prepends `origin` to `url`. If a path is provided but `origin` isn't specified, attempts to navigate relative to the current URL, if any.",
-            "pattern": "(^(http://|https://|/).*|\\$[A-Za-z0-9_]+)",
-            "transform": [
-              "trim"
-            ]
-          },
-          "origin": {
-            "type": "string",
-            "description": "Protocol and domain to navigate to. Prepended to `url`.",
-            "transform": [
-              "trim"
-            ]
-          },
-          "timeout": {
-            "type": "integer",
-            "description": "Maximum time in milliseconds to wait for the page to be ready. If exceeded, the goTo action fails.",
-            "default": 30000,
-            "minimum": 0
-          },
-          "waitUntil": {
-            "type": "object",
-            "description": "Configuration for waiting conditions after navigation.",
-            "additionalProperties": false,
-            "properties": {
-              "networkIdleTime": {
-                "description": "Wait for network activity to be idle (no new requests) for this duration in milliseconds. Set to `null` to skip this check.",
-                "anyOf": [
-                  {
-                    "type": "integer",
-                    "minimum": 0
-                  },
-                  {
-                    "type": "null"
-                  }
-                ],
-                "default": 500
-              },
-              "domIdleTime": {
-                "description": "Wait for DOM mutations to stop for this duration in milliseconds. Set to `null` to skip this check.",
-                "anyOf": [
-                  {
-                    "type": "integer",
-                    "minimum": 0
-                  },
-                  {
-                    "type": "null"
-                  }
-                ],
-                "default": 1000
-              },
-              "find": {
-                "type": "object",
-                "description": "Wait for a specific element to be present in the DOM. At least one of selector or elementText must be specified.",
-                "additionalProperties": false,
-                "anyOf": [
-                  {
-                    "required": [
-                      "selector"
-                    ]
-                  },
-                  {
-                    "required": [
-                      "elementText"
-                    ]
-                  },
-                  {
-                    "required": [
-                      "elementId"
-                    ]
-                  },
-                  {
-                    "required": [
-                      "elementTestId"
-                    ]
-                  },
-                  {
-                    "required": [
-                      "elementClass"
-                    ]
-                  },
-                  {
-                    "required": [
-                      "elementAttribute"
-                    ]
-                  },
-                  {
-                    "required": [
-                      "elementAria"
-                    ]
-                  }
-                ],
-                "properties": {
-                  "selector": {
-                    "type": "string",
-                    "description": "CSS selector for the element to wait for."
-                  },
-                  "elementText": {
-                    "type": "string",
-                    "description": "Text content the element must contain. Supports exact match or regex pattern using /pattern/ syntax."
-                  },
-                  "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."
-                  }
-                }
-              }
-            }
-          }
-        },
-        "title": "Go to URL (detailed)"
-      }
-    }
-  },
-  "examples": [
-    "https://www.google.com",
-    "/search",
-    {
-      "url": "https://www.google.com"
-    },
-    {
-      "url": "/search",
-      "origin": "https://www.google.com"
-    },
-    {
-      "url": "https://www.example.com",
-      "waitUntil": {
-        "networkIdleTime": 500
-      }
-    },
-    {
-      "url": "https://www.example.com/dashboard",
-      "waitUntil": {
-        "find": {
-          "selector": "[data-testid='dashboard-loaded']"
-        }
-      }
-    },
-    {
-      "url": "https://www.example.com/app",
-      "timeout": 60000,
-      "waitUntil": {
-        "networkIdleTime": 500,
-        "domIdleTime": 1000,
-        "find": {
-          "selector": ".main-content",
-          "elementText": "Dashboard"
-        }
-      }
-    },
-    {
-      "url": "https://www.example.com/app",
-      "timeout": 60000,
-      "waitUntil": {
-        "networkIdleTime": null
-      }
-    },
-    {
-      "url": "https://www.example.com/status",
-      "waitUntil": {
-        "find": {
-          "elementText": "System operational"
-        }
-      }
-    },
-    {
-      "url": "http://localhost:8092",
-      "waitUntil": {
-        "find": {
-          "selector": "button",
-          "elementText": "Standard Button",
-          "elementTestId": "standard-btn",
-          "elementAria": "Sample Standard Button",
-          "elementId": "standard-btn",
-          "elementClass": [
-            "btn"
-          ],
-          "elementAttribute": {
-            "type": "button",
-            "value": "Standard Button"
-          }
-        }
-      }
-    }
-  ],
-  "$id": "/home/runner/work/doc-detective/doc-detective/src/common/src/schemas/src_schemas/goTo_v3.schema.json"
-}

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

@@ -1,321 +0,0 @@
-{
-  "title": "httpRequest",
-  "type": "object",
-  "description": "Perform a generic HTTP request, for example to an API.",
-  "properties": {
-    "id": {
-      "type": "string",
-      "description": "ID of the step."
-    },
-    "description": {
-      "type": "string",
-      "description": "Description of the step."
-    },
-    "action": {
-      "type": "string",
-      "const": "httpRequest",
-      "description": "Action to perform."
-    },
-    "url": {
-      "type": "string",
-      "description": "URL for the HTTP request.",
-      "pattern": "(^(http://|https://).*|\\$[A-Za-z0-9_]+)",
-      "transform": [
-        "trim"
-      ]
-    },
-    "openApi": {
-      "allOf": [
-        {
-          "$ref": "/home/runner/work/doc-detective/doc-detective/src/common/src/schemas/build/openApi_v2.schema.json#"
-        },
-        {
-          "type": "object",
-          "required": [
-            "operationId"
-          ]
-        }
-      ]
-    },
-    "statusCodes": {
-      "description": "Accepted status codes. If the specified URL returns a code other than what is specified here, the action fails.",
-      "type": "array",
-      "items": {
-        "oneOf": [
-          {
-            "type": "integer"
-          }
-        ]
-      },
-      "default": [
-        200
-      ]
-    },
-    "method": {
-      "type": "string",
-      "description": "Method of the HTTP request",
-      "enum": [
-        "get",
-        "put",
-        "post",
-        "patch",
-        "delete"
-      ],
-      "transform": [
-        "trim",
-        "toEnumCase"
-      ],
-      "default": "get"
-    },
-    "timeout": {
-      "type": "integer",
-      "description": "Timeout for the HTTP request, in milliseconds.",
-      "default": 60000
-    },
-    "requestHeaders": {
-      "description": "Headers to include in the HTTP request, in key/value format.",
-      "type": "object",
-      "additionalProperties": true,
-      "properties": {},
-      "default": {}
-    },
-    "responseHeaders": {
-      "description": "Headers expected in the response, in key/value format. If one or more `responseHeaders` entries aren't present in the response, the step fails.",
-      "type": "object",
-      "additionalProperties": true,
-      "properties": {},
-      "default": {}
-    },
-    "requestParams": {
-      "description": "URL parameters to include in the HTTP request, in key/value format.",
-      "type": "object",
-      "additionalProperties": true,
-      "default": {},
-      "properties": {}
-    },
-    "responseParams": {
-      "description": "DEPRECATED.",
-      "type": "object",
-      "additionalProperties": true,
-      "default": {},
-      "properties": {}
-    },
-    "requestData": {
-      "description": "JSON object to include as the body of the HTTP request.",
-      "type": "object",
-      "additionalProperties": true,
-      "default": {},
-      "properties": {}
-    },
-    "responseData": {
-      "description": "JSON object expected in the response. If one or more key/value pairs aren't present in the response, the step fails.",
-      "type": "object",
-      "additionalProperties": true,
-      "default": {},
-      "properties": {}
-    },
-    "allowAdditionalFields": {
-      "type": "boolean",
-      "description": "If `false`, the step fails when the response data contains fields not specified in `responseData`.",
-      "default": true
-    },
-    "savePath": {
-      "type": "string",
-      "description": "File path to save the command's output, relative to `saveDirectory`. Specify a file extension that matches the expected response type, such as `.json` for JSON content or `.txt` for strings."
-    },
-    "saveDirectory": {
-      "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": "integer",
-      "description": "Allowed variation in percentage of text different between the current output and previously saved output. If the difference between the current output and the previous output is greater than `maxVariation`, the step fails. If output doesn't exist at `savePath`, this value is ignored.",
-      "default": 0,
-      "minimum": 0,
-      "maximum": 100
-    },
-    "overwrite": {
-      "type": "string",
-      "description": "If `true`, overwrites the existing output at `savePath` if it exists.\nIf `byVariation`, overwrites the existing output at `savePath` if the difference between the new output and the existing output is greater than `maxVariation`.",
-      "enum": [
-        "true",
-        "false",
-        "byVariation"
-      ],
-      "default": "false"
-    },
-    "envsFromResponseData": {
-      "description": "Environment variables to set based on response variables, as an object of the environment variable name and the jq filter applied to the response data to identify the variable's value.",
-      "type": "array",
-      "default": [],
-      "items": {
-        "oneOf": [
-          {
-            "description": "",
-            "type": "object",
-            "properties": {
-              "name": {
-                "description": "Name of the environment variable to set.",
-                "type": "string"
-              },
-              "jqFilter": {
-                "description": "jq filter to apply to the response data. If the filter doesn't return a value, the environment variable isn't set.",
-                "type": "string"
-              }
-            },
-            "required": [
-              "name",
-              "jqFilter"
-            ]
-          }
-        ]
-      }
-    }
-  },
-  "dynamicDefaults": {
-    "id": "uuid"
-  },
-  "anyOf": [
-    {
-      "required": [
-        "url"
-      ]
-    },
-    {
-      "required": [
-        "openApi"
-      ]
-    }
-  ],
-  "required": [
-    "action"
-  ],
-  "additionalProperties": false,
-  "examples": [
-    {
-      "action": "httpRequest",
-      "url": "https://reqres.in/api/users"
-    },
-    {
-      "action": "httpRequest",
-      "url": "https://reqres.in/api/users/2",
-      "method": "put",
-      "requestData": {
-        "name": "morpheus",
-        "job": "zion resident"
-      }
-    },
-    {
-      "action": "httpRequest",
-      "url": "https://reqres.in/api/users",
-      "method": "post",
-      "requestData": {
-        "name": "morpheus",
-        "job": "leader"
-      },
-      "responseData": {
-        "name": "morpheus",
-        "job": "leader"
-      },
-      "statusCodes": [
-        200,
-        201
-      ]
-    },
-    {
-      "action": "httpRequest",
-      "url": "https://www.api-server.com",
-      "method": "post",
-      "timeout": 30000,
-      "requestHeaders": {
-        "header": "value"
-      },
-      "requestParams": {
-        "param": "value"
-      },
-      "requestData": {
-        "field": "value"
-      },
-      "responseHeaders": {
-        "header": "value"
-      },
-      "responseData": {
-        "field": "value"
-      },
-      "statusCodes": [
-        200
-      ]
-    },
-    {
-      "action": "httpRequest",
-      "url": "https://reqres.in/api/users",
-      "method": "post",
-      "requestData": {
-        "name": "morpheus",
-        "job": "leader"
-      },
-      "responseData": {
-        "name": "morpheus",
-        "job": "leader"
-      },
-      "statusCodes": [
-        200,
-        201
-      ],
-      "savePath": "response.json",
-      "saveDirectory": "media",
-      "maxVariation": 5,
-      "overwrite": "byVariation"
-    },
-    {
-      "action": "httpRequest",
-      "openApi": {
-        "name": "Reqres",
-        "operationId": "getUserById"
-      },
-      "requestParams": {
-        "id": 123
-      }
-    },
-    {
-      "action": "httpRequest",
-      "openApi": {
-        "descriptionPath": "https://api.example.com/openapi.json",
-        "operationId": "getUserById"
-      },
-      "requestParams": {
-        "id": 123
-      }
-    },
-    {
-      "action": "httpRequest",
-      "openApi": {
-        "descriptionPath": "https://api.example.com/openapi.json",
-        "operationId": "createUser",
-        "useExample": "both"
-      }
-    },
-    {
-      "action": "httpRequest",
-      "openApi": {
-        "descriptionPath": "https://api.example.com/openapi.json",
-        "operationId": "updateUser",
-        "useExample": "request",
-        "exampleKey": "acme"
-      }
-    },
-    {
-      "action": "httpRequest",
-      "openApi": {
-        "descriptionPath": "https://api.example.com/openapi.json",
-        "operationId": "updateUser",
-        "useExample": "request",
-        "exampleKey": "acme",
-        "requestHeaders": {
-          "Authorization": "Bearer $TOKEN"
-        }
-      }
-    }
-  ],
-  "$id": "/home/runner/work/doc-detective/doc-detective/src/common/src/schemas/src_schemas/httpRequest_v2.schema.json"
-}