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

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

@@ -1,89 +0,0 @@
-{
-  "title": "moveTo",
-  "type": "object",
-  "description": "Move the mouse to a specific location.",
-  "properties": {
-    "id": {
-      "type": "string",
-      "description": "ID of the step."
-    },
-    "description": {
-      "type": "string",
-      "description": "Description of the step."
-    },
-    "action": {
-      "type": "string",
-      "const": "moveTo",
-      "description": "The action to perform."
-    },
-    "selector": {
-      "description": "Selector for the element to move to.",
-      "type": "string"
-    },
-    "alignment": {
-      "description": "Alignment of the element to move to.",
-      "type": "string",
-      "enum": ["top", "bottom", "left", "right", "center"],
-      "default": "center"
-    },
-    "offset": {
-      "description": "Offset from the element to move to.",
-      "type": "object",
-      "properties": {
-        "x": {
-          "description": "Offset from the element to move to in x direction. Negative values move left, positive values move right.",
-          "type": "number",
-          "default": 0
-        },
-        "y": {
-          "description": "Offset from the element to move to in y direction. Negative values move up, positive values move down.",
-          "type": "number",
-          "default": 0
-        }
-      },
-      "default": {},
-      "additionalProperties": false
-    },
-    "duration": {
-      "description": "Duration of the move in milliseconds.",
-      "type": "number",
-      "minimum": 0,
-      "default": 500
-    }
-  },
-  "dynamicDefaults": {
-    "id": "uuid"
-  },
-  "required": ["action", "selector"],
-  "additionalProperties": false,
-  "examples": [
-    {
-      "action": "moveTo",
-      "selector": "#searchInput"
-    },
-    {
-      "action": "moveTo",
-      "selector": "#searchInput",
-      "alignment": "left"
-    },
-    {
-      "action": "moveTo",
-      "selector": "#searchInput",
-      "alignment": "left",
-      "offset": {
-        "x": 10,
-        "y": 10
-      }
-    },
-    {
-      "action": "moveTo",
-      "selector": "#searchInput",
-      "alignment": "left",
-      "offset": {
-        "x": 10,
-        "y": 10
-      },
-      "duration": 1000
-    }
-  ]
-}

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

@@ -1,64 +0,0 @@
-{
-  "$id": "openApi_v2.schema.json",
-  "version": "1.0.0",
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "openApi",
-  "type": "object",
-  "description": "OpenAPI definition and configuration.",
-  "additionalProperties": false,
-  "properties": {
-    "name": {
-      "type": "string",
-      "description": "Name of the OpenAPI definition, as defined in your configuration."
-    },
-    "descriptionPath": {
-      "type": "string",
-      "description": "URL or local path to the 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 definition."
-    },
-    "validateAgainstSchema": {
-      "type": "string",
-      "description": "Validates the request and/or response against the schema in the OpenAPI definition. 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 definition 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 definition 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 definition. If an `examples` key isn't specified or isn't available for a given parameter or object, the `example` property value is used.",
-      "default": ""
-    },
-    "requestHeaders": {
-      "type": "object",
-      "description": "Request headers to add to the request. If specified in both a config and a step, the step value overrides the config value.",
-      "additionalProperties": {
-        "type": "string"
-      }
-    }
-  },
-  "examples":[
-    {
-      "descriptionPath": "https://petstore.swagger.io/v2/swagger.json"
-    }
-  ]
-}

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

@@ -1,161 +0,0 @@
-{
-  "$id": "openApi_v3.schema.json",
-  "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": {
-      "$ref": "#/components/schemas/descriptionPath"
-    },
-    "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": {
-      "$ref": "#/components/schemas/operationId"
-    },
-    "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/src/schemas/src_schemas/record_v3.schema.json

@@ -1,69 +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": [
-    {
-      "$ref": "#/components/schemas/string"
-    },
-    {
-      "$ref": "#/components/schemas/object"
-    },
-    {
-      "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"
-    }
-  ]
-}

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

@@ -1,52 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "report",
-  "type": "object",
-  "dynamicDefaults": {
-    "reportId": "uuid"
-  },
-  "properties": {
-    "reportId": {
-      "type": "string",
-      "description": "Unique identifier for the test specification."
-    },
-    "specs": {
-      "description": "Test specifications that were performed.",
-      "type": "array",
-      "minItems": 1,
-      "items": {
-        "anyOf": [
-          {
-            "$ref": "spec_v3.schema.json#"
-          }
-        ]
-      }
-    }
-  },
-  "required": [
-    "specs"
-  ],
-  "examples": [
-    {
-      "specs": [
-        {
-          "$ref": "spec_v3.schema.json#/examples/0"
-        }
-      ]
-    },
-    {
-      "specs": [
-        {
-          "$ref": "spec_v3.schema.json#/examples/1"
-        }
-      ]
-    },
-    {
-      "specs": [
-        {
-          "$ref": "spec_v3.schema.json#/examples/2"
-        }
-      ]
-    }
-  ]
-}

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

@@ -1,237 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "resolvedTests",
-  "description": "A collection of resolved tests ready to be performed.",
-  "type": "object",
-  "dynamicDefaults": {
-    "resolvedTestsId": "uuid"
-  },
-  "properties": {
-    "resolvedTestsId": {
-      "type": "string",
-      "description": "Unique identifier for the resolved tests."
-    },
-    "config": {
-      "$ref": "config_v3.schema.json#"
-    },
-    "specs": {
-      "description": "Test specifications that were performed.",
-      "type": "array",
-      "minItems": 1,
-      "items": {
-        "anyOf": [
-          {
-            "$ref": "spec_v3.schema.json#"
-          }
-        ]
-      }
-    }
-  },
-  "required": [
-    "specs"
-  ],
-  "examples": [
-    {
-      "config": {
-        "input": [
-          "/home/hawkeyexl/Workspaces/resolver/dev/doc-content-yaml.md"
-        ],
-        "logLevel": "debug",
-        "output": ".",
-        "recursive": true,
-        "relativePathBase": "file",
-        "detectSteps": true,
-        "fileTypes": [
-          {
-            "name": "markdown",
-            "extensions": [
-              "md",
-              "markdown",
-              "mdx"
-            ],
-            "inlineStatements": {
-              "testStart": [
-                "{\\/\\*\\s*test\\s+?([\\s\\S]*?)\\s*\\*\\/}",
-                "<!--\\s*test\\s*([\\s\\S]*?)\\s*-->",
-                "\\[comment\\]:\\s+#\\s+\\(test\\s*(.*?)\\s*\\)",
-                "\\[comment\\]:\\s+#\\s+\\(test start\\s*(.*?)\\s*\\)"
-              ],
-              "testEnd": [
-                "{\\/\\*\\s*test end\\s*\\*\\/}",
-                "<!--\\s*test end\\s*([\\s\\S]*?)\\s*-->",
-                "\\[comment\\]:\\s+#\\s+\\(test end\\)"
-              ],
-              "ignoreStart": [
-                "{\\/\\*\\s*test ignore start\\s*\\*\\/}",
-                "<!--\\s*test ignore start\\s*-->"
-              ],
-              "ignoreEnd": [
-                "{\\/\\*\\s*test ignore end\\s*\\*\\/}",
-                "<!--\\s*test ignore end\\s*-->"
-              ],
-              "step": [
-                "{\\/\\*\\s*step\\s+?([\\s\\S]*?)\\s*\\*\\/}",
-                "<!--\\s*step\\s*([\\s\\S]*?)\\s*-->",
-                "\\[comment\\]:\\s+#\\s+\\(step\\s*(.*?)\\s*\\)"
-              ]
-            },
-            "markup": [
-              {
-                "name": "checkHyperlink",
-                "regex": [
-                  "(?<!\\!)\\[[^\\]]+\\]\\(\\s*(https?:\\/\\/[^\\s)]+)(?:\\s+\"[^\"]*\")?\\s*\\)"
-                ],
-                "actions": [
-                  "checkLink"
-                ]
-              },
-              {
-                "name": "clickOnscreenText",
-                "regex": [
-                  "\\b(?:[Cc]lick|[Tt]ap|[Ll]eft-click|[Cc]hoose|[Ss]elect|[Cc]heck)\\b\\s+\\*\\*((?:(?!\\*\\*).)+)\\*\\*"
-                ],
-                "actions": [
-                  "click"
-                ]
-              },
-              {
-                "name": "findOnscreenText",
-                "regex": [
-                  "\\*\\*((?:(?!\\*\\*).)+)\\*\\*"
-                ],
-                "actions": [
-                  "find"
-                ]
-              },
-              {
-                "name": "goToUrl",
-                "regex": [
-                  "\\b(?:[Gg]o\\s+to|[Oo]pen|[Nn]avigate\\s+to|[Vv]isit|[Aa]ccess|[Pp]roceed\\s+to|[Ll]aunch)\\b\\s+\\[[^\\]]+\\]\\(\\s*(https?:\\/\\/[^\\s)]+)(?:\\s+\"[^\"]*\")?\\s*\\)"
-                ],
-                "actions": [
-                  "goTo"
-                ]
-              },
-              {
-                "name": "screenshotImage",
-                "regex": [
-                  "!\\[[^\\]]*\\]\\(\\s*([^\\s)]+)(?:\\s+\"[^\"]*\")?\\s*\\)\\s*\\{(?=[^}]*\\.screenshot)[^}]*\\}"
-                ],
-                "actions": [
-                  "screenshot"
-                ]
-              },
-              {
-                "name": "typeText",
-                "regex": [
-                  "\\b(?:press|enter|type)\\b\\s+\"([^\"]+)\""
-                ],
-                "actions": [
-                  "type"
-                ]
-              }
-            ]
-          },
-          {
-            "name": "asciidoc",
-            "extensions": [
-              "adoc",
-              "asciidoc",
-              "asc"
-            ],
-            "inlineStatements": {
-              "testStart": [
-                "\\/\\/\\s+\\(\\s*test\\s+([\\s\\S]*?)\\s*\\)"
-              ],
-              "testEnd": [
-                "\\/\\/\\s+\\(\\s*test end\\s*\\)"
-              ],
-              "ignoreStart": [
-                "\\/\\/\\s+\\(\\s*test ignore start\\s*\\)"
-              ],
-              "ignoreEnd": [
-                "\\/\\/\\s+\\(\\s*test ignore end\\s*\\)"
-              ],
-              "step": [
-                "\\/\\/\\s+\\(\\s*step\\s+([\\s\\S]*?)\\s*\\)"
-              ]
-            },
-            "markup": []
-          },
-          {
-            "name": "html",
-            "extensions": [
-              "html",
-              "htm"
-            ],
-            "inlineStatements": {
-              "testStart": [
-                "<!--\\s*test\\s+?([\\s\\S]*?)\\s*-->"
-              ],
-              "testEnd": [
-                "<!--\\s*test end\\s*([\\s\\S]*?)\\s*-->"
-              ],
-              "ignoreStart": [
-                "<!--\\s*test ignore start\\s*-->"
-              ],
-              "ignoreEnd": [
-                "<!--\\s*test ignore end\\s*-->"
-              ],
-              "step": [
-                "<!--\\s*step\\s+?([\\s\\S]*?)\\s*-->"
-              ]
-            },
-            "markup": []
-          }
-        ],
-        "telemetry": {
-          "send": true
-        },
-        "configId": "3e467e5d-27cb-41f3-800f-aeb3c20dcb4c",
-        "environment": {
-          "arch": "x64",
-          "platform": "linux",
-          "workingDirectory": "/home/hawkeyexl/Workspaces/resolver"
-        }
-      },
-      "specs": [
-        {
-          "specId": "cc656bba-132f-4f0f-b093-2cfbdd784f69",
-          "contentPath": "/home/hawkeyexl/Workspaces/resolver/dev/doc-content-yaml.md",
-          "tests": [
-            {
-              "testId": "doc-detective-docs",
-              "detectSteps": false,
-              "runOn": [],
-              "openApi": [],
-              "contexts": [
-                {
-                  "steps": [
-                    {
-                      "checkLink": "https://doc-detective.com"
-                    },
-                    {
-                      "checkLink": "https://doc-detective.com/docs/get-started/intro"
-                    },
-                    {
-                      "goTo": "https://doc-detective.com/docs/get-started/actions/type"
-                    },
-                    {
-                      "find": "Special keys"
-                    },
-                    {
-                      "screenshot": "reference.png"
-                    }
-                  ],
-                  "contextId": "eec1d123-7dfd-4362-b41a-942f36e0da5a"
-                }
-              ]
-            }
-          ],
-          "runOn": [],
-          "openApi": []
-        }
-      ]
-    }
-  ]
-}