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

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

@@ -1,199 +0,0 @@
-{
-  "title": "specification",
-  "type": "object",
-  "properties": {
-    "id": {
-      "type": "string",
-      "description": "Unique identifier for the test specification."
-    },
-    "description": {
-      "type": "string",
-      "description": "Description of the test specification."
-    },
-    "file": {
-      "type": "string",
-      "description": "Path to the file that the specification is associated with."
-    },
-    "contexts": {
-      "type": "array",
-      "description": "Application/platform sets to run tests in. Overrides `contexts` defined at the config-level.",
-      "items": {
-        "oneOf": [
-          {
-            "$ref": "/home/runner/work/doc-detective/doc-detective/src/common/src/schemas/build/context_v2.schema.json#"
-          }
-        ]
-      }
-    },
-    "openApi": {
-      "type": "array",
-      "items": {
-        "allOf": [
-          {
-            "$ref": "/home/runner/work/doc-detective/doc-detective/src/common/src/schemas/build/openApi_v2.schema.json#"
-          },
-          {
-            "type": "object",
-            "properties": {
-              "operationId": {
-                "type": "null",
-                "$commment": "Only allow operationId at the step level."
-              }
-            },
-            "required": [
-              "name",
-              "descriptionPath"
-            ]
-          }
-        ]
-      }
-    },
-    "tests": {
-      "description": "[Tests](test) to perform.",
-      "type": "array",
-      "minItems": 1,
-      "items": {
-        "oneOf": [
-          {
-            "$ref": "/home/runner/work/doc-detective/doc-detective/src/common/src/schemas/build/test_v2.schema.json#"
-          }
-        ]
-      }
-    }
-  },
-  "required": [
-    "tests"
-  ],
-  "examples": [
-    {
-      "tests": [
-        {
-          "steps": [
-            {
-              "action": "checkLink",
-              "url": "https://www.duckduckgo.com"
-            }
-          ]
-        }
-      ]
-    },
-    {
-      "id": "Do all the things! - Spec",
-      "contexts": [
-        {
-          "app": {
-            "name": "chrome",
-            "path": "/usr/bin/firefox"
-          },
-          "platforms": [
-            "windows",
-            "mac"
-          ]
-        }
-      ],
-      "tests": [
-        {
-          "id": "Do all the things! - Test",
-          "description": "This test includes nearly every property across all actions.",
-          "contexts": [
-            {
-              "app": {
-                "name": "firefox",
-                "path": "/usr/bin/firefox"
-              },
-              "platforms": [
-                "linux"
-              ]
-            }
-          ],
-          "steps": [
-            {
-              "action": "setVariables",
-              "path": ".env"
-            },
-            {
-              "action": "runShell",
-              "command": "echo",
-              "args": [
-                "$USER"
-              ]
-            },
-            {
-              "action": "checkLink",
-              "url": "https://www.duckduckgo.com"
-            },
-            {
-              "action": "httpRequest",
-              "url": "https://reqres.in/api/users",
-              "method": "post",
-              "requestData": {
-                "name": "morpheus",
-                "job": "leader"
-              },
-              "responseData": {
-                "name": "morpheus",
-                "job": "leader"
-              },
-              "statusCodes": [
-                200,
-                201
-              ]
-            },
-            {
-              "action": "goTo",
-              "url": "https://www.duckduckgo.com"
-            },
-            {
-              "action": "find",
-              "selector": "[title=Search]",
-              "timeout": 10000,
-              "matchText": "Search",
-              "moveTo": true,
-              "click": true,
-              "typeKeys": {
-                "keys": [
-                  "shorthair cat"
-                ]
-              }
-            },
-            {
-              "action": "typeKeys",
-              "keys": [
-                "$ENTER$"
-              ]
-            },
-            {
-              "action": "saveScreenshot"
-            }
-          ]
-        }
-      ]
-    },
-    {
-      "id": "Make a request from an OpenAPI definition",
-      "openApi": [
-        {
-          "name": "Acme",
-          "descriptionPath": "https://www.acme.com/openapi.json",
-          "server": "https://api.acme.com"
-        }
-      ],
-      "tests": [
-        {
-          "steps": [
-            {
-              "action": "httpRequest",
-              "openApi": {
-                "operationId": "getUserById"
-              },
-              "requestParams": {
-                "id": 123
-              }
-            }
-          ]
-        }
-      ]
-    }
-  ],
-  "$id": "/home/runner/work/doc-detective/doc-detective/src/common/src/schemas/src_schemas/spec_v2.schema.json"
-}

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

@@ -1,213 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "specification",
-  "type": "object",
-  "dynamicDefaults": {
-    "specId": "uuid"
-  },
-  "properties": {
-    "$schema": {
-      "description": "JSON Schema for this object.",
-      "type": "string",
-      "enum": [
-        "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/spec_v3.schema.json"
-      ]
-    },
-    "specId": {
-      "type": "string",
-      "description": "Unique identifier for the test specification."
-    },
-    "description": {
-      "type": "string",
-      "description": "Description of the test specification."
-    },
-    "specPath": {
-      "type": "string",
-      "description": "Path to the test specification."
-    },
-    "contentPath": {
-      "type": "string",
-      "description": "Path to the content that the specification is associated with."
-    },
-    "runOn": {
-      "$ref": "/home/runner/work/doc-detective/doc-detective/src/common/src/schemas/build/test_v3.schema.json#/properties/runOn"
-    },
-    "openApi": {
-      "$ref": "/home/runner/work/doc-detective/doc-detective/src/common/src/schemas/build/test_v3.schema.json#/properties/openApi"
-    },
-    "tests": {
-      "description": "[Tests](test) to perform.",
-      "type": "array",
-      "minItems": 1,
-      "items": {
-        "anyOf": [
-          {
-            "$ref": "/home/runner/work/doc-detective/doc-detective/src/common/src/schemas/build/test_v3.schema.json#"
-          }
-        ]
-      }
-    }
-  },
-  "required": [
-    "tests"
-  ],
-  "examples": [
-    {
-      "tests": [
-        {
-          "steps": [
-            {
-              "checkLink": {
-                "url": "https://www.duckduckgo.com"
-              }
-            }
-          ]
-        }
-      ]
-    },
-    {
-      "specId": "Do all the things! - Spec",
-      "runOn": [
-        {
-          "platforms": [
-            "windows",
-            "mac"
-          ],
-          "browsers": {
-            "name": "firefox",
-            "window": {},
-            "viewport": {}
-          }
-        }
-      ],
-      "tests": [
-        {
-          "testId": "Do all the things! - Test",
-          "description": "This test includes nearly every property across all actions.",
-          "runOn": [
-            {
-              "platforms": "linux",
-              "browsers": "firefox"
-            }
-          ],
-          "steps": [
-            {
-              "loadVariables": ".env"
-            },
-            {
-              "runShell": {
-                "command": "echo",
-                "args": [
-                  "$USER"
-                ],
-                "maxVariation": 0,
-                "overwrite": "aboveVariation"
-              },
-              "variables": {}
-            },
-            {
-              "checkLink": {
-                "url": "https://www.duckduckgo.com"
-              }
-            },
-            {
-              "httpRequest": {
-                "method": "post",
-                "url": "https://reqres.in/api/users",
-                "request": {
-                  "body": {
-                    "name": "morpheus",
-                    "job": "leader"
-                  }
-                },
-                "response": {
-                  "body": {
-                    "name": "morpheus",
-                    "job": "leader"
-                  }
-                },
-                "statusCodes": [
-                  200,
-                  201
-                ],
-                "maxVariation": 0,
-                "overwrite": "aboveVariation"
-              },
-              "variables": {}
-            },
-            {
-              "goTo": {
-                "url": "https://www.duckduckgo.com"
-              }
-            },
-            {
-              "find": {
-                "selector": "[title=Search]",
-                "elementText": "Search",
-                "timeout": 10000,
-                "moveTo": true,
-                "click": true,
-                "type": {
-                  "keys": [
-                    "shorthair cat"
-                  ]
-                }
-              },
-              "variables": {}
-            },
-            {
-              "type": {
-                "keys": [
-                  "$ENTER$"
-                ]
-              }
-            },
-            {
-              "screenshot": {
-                "maxVariation": 0,
-                "overwrite": "aboveVariation"
-              }
-            }
-          ],
-          "detectSteps": true
-        }
-      ]
-    },
-    {
-      "specId": "Make a request from an OpenAPI definition",
-      "openApi": [
-        {
-          "descriptionPath": "https://www.acme.com/openapi.json",
-          "server": "https://api.acme.com",
-          "name": "Acme"
-        }
-      ],
-      "tests": [
-        {
-          "steps": [
-            {
-              "httpRequest": {
-                "openApi": {
-                  "operationId": "getUserById",
-                  "validateAgainstSchema": "both",
-                  "useExample": "none",
-                  "exampleKey": ""
-                },
-                "request": {
-                  "parameters": {
-                    "id": 123
-                  }
-                },
-                "response": {},
-                "maxVariation": 0,
-                "overwrite": "aboveVariation"
-              },
-              "variables": {}
-            }
-          ]
-        }
-      ]
-    }
-  ],
-  "$id": "/home/runner/work/doc-detective/doc-detective/src/common/src/schemas/src_schemas/spec_v3.schema.json"
-}

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

@@ -1,57 +0,0 @@
-{
-  "title": "startRecording",
-  "type": "object",
-  "description": "Start recording the current browser viewport. Must be followed by a `stopRecording` action. Only runs when the context `app` is `chrome` and `headless` is `false`. Supported extensions: [ '.mp4', '.webm', '.gif' ]",
-  "properties": {
-    "id": {
-      "type": "string",
-      "description": "ID of the step."
-    },
-    "description": {
-      "type": "string",
-      "description": "Description of the step."
-    },
-    "action": {
-      "type": "string",
-      "const": "startRecording",
-      "description": "The action to perform."
-    },
-    "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_]+)"
-    },
-    "directory": {
-      "type": "string",
-      "description": "Directory of the file. Attempts to create the directory if it doesn't exist."
-    },
-    "overwrite": {
-      "type": "boolean",
-      "description": "If `true`, overwrites the existing file at `path` if it exists.",
-      "default": false
-    }
-  },
-  "dynamicDefaults": {
-    "id": "uuid"
-  },
-  "required": [
-    "action"
-  ],
-  "additionalProperties": false,
-  "examples": [
-    {
-      "action": "startRecording"
-    },
-    {
-      "action": "startRecording",
-      "path": "results.mp4"
-    },
-    {
-      "action": "startRecording",
-      "path": "results.mp4",
-      "directory": "static/media",
-      "overwrite": true
-    }
-  ],
-  "$id": "/home/runner/work/doc-detective/doc-detective/src/common/src/schemas/src_schemas/startRecording_v2.schema.json"
-}