doc-detective-common 4.0.0-beta.0-dev.7 → 4.0.0-beta.0-dev.9

package/dist/schemas/loadCookie_v3.schema.json

@@ -1,228 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "loadCookie",
-  "description": "Load a specific cookie from a file or environment variable into the browser.",
-  "anyOf": [
-    {
-      "type": "string",
-      "title": "Cookie name or file path",
-      "description": "Name of the specific cookie to load from default location, or file path to cookie file.",
-      "pattern": "^[A-Za-z0-9_./\\-]+$",
-      "transform": [
-        "trim"
-      ]
-    },
-    {
-      "type": "object",
-      "additionalProperties": false,
-      "required": [
-        "name"
-      ],
-      "anyOf": [
-        {
-          "required": [
-            "path"
-          ],
-          "not": {
-            "required": [
-              "variable"
-            ]
-          }
-        },
-        {
-          "required": [
-            "variable"
-          ],
-          "not": {
-            "anyOf": [
-              {
-                "required": [
-                  "path"
-                ]
-              },
-              {
-                "required": [
-                  "directory"
-                ]
-              }
-            ]
-          }
-        }
-      ],
-      "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 load.",
-          "pattern": "^[A-Za-z0-9_.-]+$",
-          "transform": [
-            "trim"
-          ]
-        },
-        "variable": {
-          "type": "string",
-          "title": "Environment variable name",
-          "description": "Environment variable name containing 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 cookie file, relative to directory. Supports Netscape cookie format.",
-          "transform": [
-            "trim"
-          ]
-        },
-        "directory": {
-          "type": "string",
-          "title": "Directory path",
-          "description": "Directory containing the cookie file.",
-          "transform": [
-            "trim"
-          ]
-        },
-        "domain": {
-          "type": "string",
-          "title": "Cookie domain",
-          "description": "Specific domain to filter the cookie by when loading from multi-cookie file (optional).",
-          "transform": [
-            "trim"
-          ]
-        }
-      },
-      "title": "Load cookie (detailed)"
-    }
-  ],
-  "components": {
-    "schemas": {
-      "string": {
-        "type": "string",
-        "title": "Cookie name or file path",
-        "description": "Name of the specific cookie to load from default location, or file path to cookie file.",
-        "pattern": "^[A-Za-z0-9_./\\-]+$",
-        "transform": [
-          "trim"
-        ]
-      },
-      "object": {
-        "type": "object",
-        "additionalProperties": false,
-        "required": [
-          "name"
-        ],
-        "anyOf": [
-          {
-            "required": [
-              "path"
-            ],
-            "not": {
-              "required": [
-                "variable"
-              ]
-            }
-          },
-          {
-            "required": [
-              "variable"
-            ],
-            "not": {
-              "anyOf": [
-                {
-                  "required": [
-                    "path"
-                  ]
-                },
-                {
-                  "required": [
-                    "directory"
-                  ]
-                }
-              ]
-            }
-          }
-        ],
-        "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 load.",
-            "pattern": "^[A-Za-z0-9_.-]+$",
-            "transform": [
-              "trim"
-            ]
-          },
-          "variable": {
-            "type": "string",
-            "title": "Environment variable name",
-            "description": "Environment variable name containing 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 cookie file, relative to directory. Supports Netscape cookie format.",
-            "transform": [
-              "trim"
-            ]
-          },
-          "directory": {
-            "type": "string",
-            "title": "Directory path",
-            "description": "Directory containing the cookie file.",
-            "transform": [
-              "trim"
-            ]
-          },
-          "domain": {
-            "type": "string",
-            "title": "Cookie domain",
-            "description": "Specific domain to filter the cookie by when loading from multi-cookie file (optional).",
-            "transform": [
-              "trim"
-            ]
-          }
-        },
-        "title": "Load cookie (detailed)"
-      }
-    }
-  },
-  "examples": [
-    "session_token",
-    "./test-data/auth-session.txt",
-    "test_env_cookie",
-    {
-      "name": "auth_cookie",
-      "variable": "AUTH_COOKIE"
-    },
-    {
-      "name": "test_cookie",
-      "path": "test-cookie.txt"
-    },
-    {
-      "name": "session_token",
-      "path": "session-token.txt",
-      "directory": "./test-data"
-    },
-    {
-      "name": "user_session",
-      "path": "saved-cookies.txt",
-      "domain": "app.example.com"
-    }
-  ]
-}

package/dist/schemas/loadVariables_v3.schema.json

@@ -1,9 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "loadVariables",
-  "type": "string",
-  "description": "Load environment variables from the specified `.env` file.",
-  "examples": [
-    ".env"
-  ]
-}

package/dist/schemas/openApi_v3.schema.json

@@ -1,162 +0,0 @@
-{
-  "version": "1.0.0",
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "openApi",
-  "type": "object",
-  "description": "OpenAPI description and configuration.",
-  "additionalProperties": false,
-  "anyOf": [
-    {
-      "required": [
-        "descriptionPath"
-      ]
-    },
-    {
-      "required": [
-        "operationId"
-      ]
-    }
-  ],
-  "properties": {
-    "name": {
-      "type": "string",
-      "description": "Name of the OpenAPI description, as defined in your configuration."
-    },
-    "descriptionPath": {
-      "type": "string",
-      "description": "URL or local path to the OpenAPI description."
-    },
-    "definition": {
-      "type": "object",
-      "readOnly": true,
-      "description": "OpenAPI definition object loaded from the `descriptionPath`. This is a resolved version of the OpenAPI description and should not be user-defined.",
-      "additionalProperties": true,
-      "title": "OpenAPI definition"
-    },
-    "operationId": {
-      "type": "string",
-      "description": "ID of the operation to use for the request."
-    },
-    "server": {
-      "type": "string",
-      "description": "Server to use for example requests. Only valid if `useExample` is `request` or `both`. If not specified but an example is used for the request, uses the first server defined in the OpenAPI description."
-    },
-    "validateAgainstSchema": {
-      "type": "string",
-      "description": "Validates the request and/or response against the schema in the OpenAPI description. If the request or response doesn't match the schema, the step fails.",
-      "enum": [
-        "request",
-        "response",
-        "both",
-        "none"
-      ],
-      "default": "both"
-    },
-    "mockResponse": {
-      "type": "boolean",
-      "description": "If `true`, doesn't make the HTTP request, but instead uses the response example or schema from the OpenAPI description as the response data. Useful for creating tests when an API isn't fully implemented yet. If `statusCode` isn't specified, uses the first defined response code."
-    },
-    "statusCode": {
-      "type": "integer",
-      "description": "Response code to use for validation, examples, and status code checking. If the response code doesn't match, the step fails. `statusCodes` overrides this value when specified."
-    },
-    "useExample": {
-      "type": [
-        "string"
-      ],
-      "description": "Uses the example from the OpenAPI description as the request and response data. If the request or response has multiple examples, specify `exampleKey`. If `statusCode` isn't specified, uses the first defined response code. `requestData`, `requestParams`, and `requestHeaders` override portions of request examples when specified. `responseData` overrides portions of response examples when specified.",
-      "enum": [
-        "request",
-        "response",
-        "both",
-        "none"
-      ],
-      "default": "none"
-    },
-    "exampleKey": {
-      "type": "string",
-      "description": "Key of the example to use from the `examples` property in the OpenAPI description. If an `examples` key isn't specified or isn't available for a given parameter or object, the `example` property value is used.",
-      "default": ""
-    },
-    "headers": {
-      "type": "object",
-      "description": "Request headers to add to requests. For example, to set `Authorization` headers for all requests from the specified OpenAPI document. If specified in both a config and a step, the step value overrides the config value.",
-      "additionalProperties": {
-        "type": "string"
-      },
-      "title": "OpenAPI request headers"
-    }
-  },
-  "components": {
-    "schemas": {
-      "operationId": {
-        "type": "string",
-        "description": "ID of the operation to use for the request."
-      },
-      "descriptionPath": {
-        "type": "string",
-        "description": "URL or local path to the OpenAPI description."
-      }
-    }
-  },
-  "examples": [
-    {
-      "descriptionPath": "https://petstore.swagger.io/v2/swagger.json"
-    },
-    {
-      "name": "Reqres",
-      "operationId": "getUserById"
-    },
-    {
-      "descriptionPath": "https://api.example.com/openapi.json",
-      "operationId": "getUserById"
-    },
-    {
-      "descriptionPath": "https://api.example.com/openapi.json",
-      "operationId": "createUser",
-      "useExample": "both"
-    },
-    {
-      "descriptionPath": "https://api.example.com/openapi.json",
-      "operationId": "createUser",
-      "useExample": "both",
-      "exampleKey": "example1"
-    },
-    {
-      "descriptionPath": "https://api.example.com/openapi.json",
-      "operationId": "createUser",
-      "useExample": "both",
-      "exampleKey": "example1",
-      "statusCode": 201
-    },
-    {
-      "descriptionPath": "https://api.example.com/openapi.json",
-      "operationId": "createUser",
-      "useExample": "both",
-      "exampleKey": "example1",
-      "statusCode": 201,
-      "validateAgainstSchema": "none"
-    },
-    {
-      "descriptionPath": "https://api.example.com/openapi.json",
-      "operationId": "createUser",
-      "useExample": "both",
-      "exampleKey": "example1",
-      "statusCode": 201,
-      "validateAgainstSchema": "none",
-      "mockResponse": true
-    },
-    {
-      "descriptionPath": "https://api.example.com/openapi.json",
-      "operationId": "createUser",
-      "useExample": "both",
-      "exampleKey": "example1",
-      "statusCode": 201,
-      "validateAgainstSchema": "none",
-      "mockResponse": true,
-      "headers": {
-        "Authorization": "Bearer 12345"
-      }
-    }
-  ]
-}

package/dist/schemas/record_v3.schema.json

@@ -1,101 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "record",
-  "description": "Start recording the current browser viewport. Must be followed by a `stopRecord` step. Only runs in Chrome browsers when they are visible. Supported extensions: [ '.mp4', '.webm', '.gif' ]",
-  "anyOf": [
-    {
-      "title": "Record (simple)",
-      "type": "string",
-      "description": "File path of the recording. Supports the `.mp4`, `.webm`, and `.gif` extensions. If not specified, the file name is the ID of the step, and the extension is `.mp4`.",
-      "pattern": "([A-Za-z0-9_-]*\\.(mp4|webm|gif)$|\\$[A-Za-z0-9_]+)",
-      "transform": [
-        "trim"
-      ]
-    },
-    {
-      "type": "object",
-      "properties": {
-        "path": {
-          "type": "string",
-          "description": "File path of the recording. Supports the `.mp4`, `.webm`, and `.gif` extensions. If not specified, the file name is the ID of the step, and the extension is `.mp4`.",
-          "pattern": "([A-Za-z0-9_-]*\\.(mp4|webm|gif)$|\\$[A-Za-z0-9_]+)",
-          "transform": [
-            "trim"
-          ]
-        },
-        "directory": {
-          "type": "string",
-          "description": "Directory of the file. If the directory doesn't exist, creates the directory.",
-          "transform": [
-            "trim"
-          ]
-        },
-        "overwrite": {
-          "type": "string",
-          "description": "If `true`, overwrites the existing recording at `path` if it exists.",
-          "enum": [
-            "true",
-            "false"
-          ]
-        }
-      },
-      "title": "Record (detailed)"
-    },
-    {
-      "type": "boolean",
-      "title": "Record (boolean)",
-      "description": "If `true`, records the current browser viewport. If `false`, doesn't record the current browser viewport."
-    }
-  ],
-  "components": {
-    "schemas": {
-      "string": {
-        "title": "Record (simple)",
-        "type": "string",
-        "description": "File path of the recording. Supports the `.mp4`, `.webm`, and `.gif` extensions. If not specified, the file name is the ID of the step, and the extension is `.mp4`.",
-        "pattern": "([A-Za-z0-9_-]*\\.(mp4|webm|gif)$|\\$[A-Za-z0-9_]+)",
-        "transform": [
-          "trim"
-        ]
-      },
-      "object": {
-        "type": "object",
-        "properties": {
-          "path": {
-            "type": "string",
-            "description": "File path of the recording. Supports the `.mp4`, `.webm`, and `.gif` extensions. If not specified, the file name is the ID of the step, and the extension is `.mp4`.",
-            "pattern": "([A-Za-z0-9_-]*\\.(mp4|webm|gif)$|\\$[A-Za-z0-9_]+)",
-            "transform": [
-              "trim"
-            ]
-          },
-          "directory": {
-            "type": "string",
-            "description": "Directory of the file. If the directory doesn't exist, creates the directory.",
-            "transform": [
-              "trim"
-            ]
-          },
-          "overwrite": {
-            "type": "string",
-            "description": "If `true`, overwrites the existing recording at `path` if it exists.",
-            "enum": [
-              "true",
-              "false"
-            ]
-          }
-        },
-        "title": "Record (detailed)"
-      }
-    }
-  },
-  "examples": [
-    true,
-    "results.mp4",
-    {
-      "path": "results.mp4",
-      "directory": "static/media",
-      "overwrite": "true"
-    }
-  ]
-}