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

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

@@ -1,200 +0,0 @@
-{
-  "title": "test",
-  "type": "object",
-  "description": "A Doc Detective test.",
-  "properties": {
-    "id": {
-      "type": "string",
-      "description": "Unique identifier for the test."
-    },
-    "description": {
-      "type": "string",
-      "description": "Description of the test."
-    },
-    "file": {
-      "type": "string",
-      "description": "Path to the file that the test is associated with."
-    },
-    "detectSteps": {
-      "type": "boolean",
-      "description": "Whether or not to detect steps in input files based on markup regex. Defaults to `true`."
-    },
-    "contexts": {
-      "type": "array",
-      "description": "Application/platform sets to run the test in. Overrides `contexts` defined at the config-level and spec-level.",
-      "items": {
-        "oneOf": [
-          {
-            "$ref": "context_v2.schema.json#"
-          }
-        ]
-      }
-    },
-    "openApi": {
-      "type": "array",
-      "items": {
-        "allOf": [
-          {
-            "$ref": "openApi_v2.schema.json#"
-          },
-          {
-            "type": "object",
-            "properties": {
-              "operationId": {
-                "type": "null",
-                "$commment": "Only allow operationId at the step level."
-              }
-            },
-            "required": ["name", "descriptionPath"]
-          }
-        ]
-      }
-    },
-    "setup": {
-      "type": "string",
-      "description": "Path to a test specification to perform before this test, while maintaining this test's context. Useful for setting up testing environments. Only the `steps` property is used from the first test in the setup spec."
-    },
-    "cleanup": {
-      "type": "string",
-      "description": "Path to a test specification to perform after this test, while maintaining this test's context. Useful for cleaning up testing environments. Only the `steps` property is used from the first test in the cleanup spec."
-    },
-    "steps": {
-      "description": "Actions to perform as part of the test. Performed in the sequence defined. If one or more actions fail, the test fails.",
-      "type": "array",
-      "minItems": 1,
-      "items": {
-        "anyOf": [
-          { "$ref": "checkLink_v2.schema.json#" },
-          { "$ref": "goTo_v2.schema.json#" },
-          { "$ref": "httpRequest_v2.schema.json#" },
-          { "$ref": "runCode_v2.schema.json#" },
-          { "$ref": "runShell_v2.schema.json#" },
-          { "$ref": "saveScreenshot_v2.schema.json#" },
-          { "$ref": "setVariables_v2.schema.json#" },
-          { "$ref": "startRecording_v2.schema.json#" },
-          { "$ref": "stopRecording_v2.schema.json#" },
-          { "$ref": "typeKeys_v2.schema.json#" },
-          { "$ref": "find_v2.schema.json#" },
-          { "$ref": "wait_v2.schema.json#" }
-        ]
-      }
-    }
-  },
-  "dynamicDefaults": {
-    "id": "uuid"
-  },
-  "required": ["steps"],
-  "additionalProperties": false,
-  "examples": [
-    {
-      "steps": [
-        {
-          "action": "checkLink",
-          "url": "https://www.duckduckgo.com"
-        }
-      ]
-    },
-    {
-      "steps": [
-        {
-          "action": "goTo",
-          "url": "https://www.duckduckgo.com"
-        },
-        {
-          "action": "find",
-          "selector": "[title=Search]",
-          "click": true,
-          "typeKeys": {
-            "keys": ["shorthair cats", "$ENTER$"]
-          }
-        }
-      ]
-    },
-    {
-      "id": "Do all the things! - Test",
-      "description": "This test includes every property across all actions.",
-      "contexts": [
-        {
-          "app": {
-            "name": "firefox",
-            "path": "/usr/bin/firefox"
-          },
-          "platforms": ["linux"]
-        }
-      ],
-      "setup": "setup.json",
-      "cleanup": "cleanup.json",
-      "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"
-        }
-      ]
-    },
-    {
-      "openApi": [
-        {
-          "name": "Acme",
-          "descriptionPath": "https://www.acme.com/openapi.json",
-          "server": "https://api.acme.com"
-        }
-      ],
-      "steps": [
-        {
-          "action": "httpRequest",
-          "openApi": {
-            "operationId": "getUserById"
-          },
-          "requestParams": {
-            "id": 123
-          }
-        }
-      ]
-    }
-  ]
-}

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

@@ -1,268 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "test",
-  "type": "object",
-  "description": "A Doc Detective test.",
-  "properties": {
-    "testId": {
-      "type": "string",
-      "description": "Unique identifier for the test."
-    },
-    "description": {
-      "type": "string",
-      "description": "Description of the test."
-    },
-    "contentPath": {
-      "type": "string",
-      "description": "Path to the content that the test is associated with."
-    },
-    "detectSteps": {
-      "type": "boolean",
-      "description": "Whether or not to detect steps in input files based on markup regex.",
-      "default": true
-    },
-    "runOn": {
-      "type": "array",
-      "description": "Contexts to run the test in. Overrides contexts defined at the config and spec levels.",
-      "items": {
-        "anyOf": [
-          {
-            "$ref": "context_v3.schema.json#"
-          }
-        ]
-      }
-    },
-    "openApi": {
-      "$ref": "#/components/schemas/openApi"
-    },
-    "before": {
-      "type": "string",
-      "description": "Path to a test specification to perform before this test, while maintaining this test's context. Useful for setting up testing environments. Only the `steps` property is used from the first test in the setup spec."
-    },
-    "after": {
-      "type": "string",
-      "description": "Path to a test specification to perform after this test, while maintaining this test's context. Useful for cleaning up testing environments. Only the `steps` property is used from the first test in the cleanup spec."
-    },
-    "steps": {
-      "description": "Steps to perform as part of the test. Performed in the sequence defined. If one or more actions fail, the test fails. By default, if a step fails, the test stops and the remaining steps are not executed.",
-      "type": "array",
-      "minItems": 1,
-      "items": {
-        "$ref": "step_v3.schema.json#"
-      }
-    },
-    "contexts": {
-      "title": "Resolved contexts",
-      "type": "array",
-      "readOnly": true,
-      "description": "Resolved contexts to run the test in. This is a resolved version of the `runOn` property. It is not user-defined and should not be used in test specifications.",
-      "items": {
-        "type": "object",
-        "properties": {
-          "platform": {
-            "type": "string",
-            "description": "Platform to run the test on. This is a resolved version of the `platforms` property."
-          },
-          "browser": {
-            "$ref": "context_v3.schema.json#/components/schemas/browser"
-          },
-          "openApi": {
-            "$ref": "#/components/schemas/openApi"
-          },
-          "steps": {
-            "description": "Steps to perform as part of the test. Performed in the sequence defined. If one or more actions fail, the test fails. By default, if a step fails, the test stops and the remaining steps are not executed.",
-            "type": "array",
-            "minItems": 1,
-            "items": {
-              "$ref": "step_v3.schema.json#"
-            }
-          }
-        },
-        "title": "Resolved context"
-      }
-    }
-  },
-  "dynamicDefaults": {
-    "testId": "uuid"
-  },
-  "anyOf": [
-    {
-      "required": ["steps"]
-    },
-    {
-      "required": ["contexts"]
-    }
-  ],
-  "additionalProperties": false,
-  "components": {
-    "schemas": {
-      "openApi": {
-        "type": "array",
-        "items": {
-          "allOf": [
-            {
-              "$ref": "openApi_v3.schema.json#"
-            },
-            {
-              "type": "object",
-              "not": {
-                "required": ["operationId"]
-              },
-              "required": ["name", "descriptionPath"],
-              "title": "OpenAPI description (test)"
-            }
-          ]
-        }
-      }
-    }
-  },
-  "examples": [
-    {
-      "steps": [
-        {
-          "checkLink": "https://www.duckduckgo.com"
-        }
-      ]
-    },
-    {
-      "steps": [
-        {
-          "goTo": {
-            "url": "https://www.duckduckgo.com"
-          }
-        },
-        {
-          "find": {
-            "selector": "[title=Search]",
-            "click": true,
-            "type": {
-              "keys": ["shorthair cats", "$ENTER$"]
-            }
-          }
-        }
-      ]
-    },
-    {
-      "testId": "Do all the things! - Test",
-      "description": "This test includes every property across all actions.",
-      "before": "setup.json",
-      "after": "cleanup.json",
-      "runOn": [
-        {
-          "platforms": ["linux"],
-          "browsers": {
-            "name": "firefox",
-            "window": {},
-            "viewport": {}
-          }
-        }
-      ],
-      "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
-    },
-    {
-      "testId": "c61b02e8-7485-44d3-8065-f873673379c6",
-      "openApi": [
-        {
-          "descriptionPath": "https://www.acme.com/openapi.json",
-          "server": "https://api.acme.com",
-          "validateAgainstSchema": "both",
-          "useExample": "none",
-          "exampleKey": "",
-          "name": "Acme"
-        }
-      ],
-      "steps": [
-        {
-          "httpRequest": {
-            "openApi": {
-              "operationId": "getUserById",
-              "validateAgainstSchema": "both",
-              "useExample": "none",
-              "exampleKey": ""
-            },
-            "request": {
-              "parameters": {
-                "id": 123
-              }
-            },
-            "response": {},
-            "maxVariation": 0,
-            "overwrite": "aboveVariation"
-          },
-          "variables": {}
-        }
-      ],
-      "detectSteps": true
-    }
-  ]
-}

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

@@ -1,63 +0,0 @@
-{
-  "title": "typeKeys",
-  "type": "object",
-  "description": "Type keys. To type special keys, begin and end the string with `$` and use the special key's enum. For example, to type the Escape key, enter `$ESCAPE$`.",
-  "properties": {
-    "id": {
-      "type": "string",
-      "description": "ID of the step."
-    },
-    "description": {
-      "type": "string",
-      "description": "Description of the step."
-    },
-    "action": {
-      "type": "string",
-      "const": "typeKeys",
-      "description": "The action to perform."
-    },
-    "keys": {
-      "description": "String of keys to enter.",
-      "anyOf": [
-        {
-          "type": "string"
-        },
-        {
-          "type": "array",
-          "items": {
-            "oneOf": [
-              {
-                "type": "string"
-              }
-            ]
-          }
-        }
-      ]
-    },
-    "delay": {
-      "type": "number",
-      "description": "Delay in milliseconds between each key press. Only valid during a recording.",
-      "default": 100
-    }
-  },
-  "dynamicDefaults": {
-    "id": "uuid"
-  },
-  "required": ["action", "keys"],
-  "additionalProperties": false,
-  "examples": [
-    {
-      "action": "typeKeys",
-      "keys": "kittens"
-    },
-    {
-      "action": "typeKeys",
-      "keys": ["$ENTER$"]
-    },
-    {
-      "action": "typeKeys",
-      "keys": ["kittens","$ENTER$"],
-      "delay": 500
-    }
-  ]
-}

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

@@ -1,62 +0,0 @@
-{
-  "title": "type",
-  "type": "object",
-  "description": "Type keys into an element specified by a CSS selector.",
-  "anyOf": [
-    {
-      "required": [
-        "keys"
-      ]
-    },
-    {
-      "required": [
-        "trailingSpecialKey"
-      ]
-    }
-  ],
-  "properties": {
-    "action": {
-      "type": "string",
-      "const": "type"
-    },
-    "css": {
-      "type": "string",
-      "description": "CSS selector that uniquely identified the element."
-    },
-    "keys": {
-      "type": "string",
-      "description": "String of keys to enter."
-    },
-    "trailingSpecialKey": {
-      "type": "string",
-      "description": "Special key pressed after the 'keys' value, if present. Supported values: https://github.com/puppeteer/puppeteer/blob/main/src/common/USKeyboardLayout.ts"
-    },
-    "env": {
-      "type": "string",
-      "description": "Path to a `.env` file to load before performing the action."
-    }
-  },
-  "required": [
-    "action",
-    "css"
-  ],
-  "additionalProperties": false,
-  "examples": [
-    {
-      "action": "type",
-      "css": "[title=Search]",
-      "keys": "kittens"
-    },
-    {
-      "action": "type",
-      "css": "[title=Search]",
-      "trailingSpecialKey": "Enter"
-    },
-    {
-      "action": "type",
-      "css": "[title=Search]",
-      "keys": "kittens",
-      "trailingSpecialKey": "Enter"
-    }
-  ]
-}