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

package/src/schemas/output_schemas/context_v2.schema.json

@@ -1,134 +0,0 @@
-{
-  "title": "context",
-  "type": "object",
-  "description": "An application and supported platforms.\n\nIf no contexts are specified but a context is required by one or more tests, Doc Detective attempts to identify a supported context in the current environment and run tests against it. For browsers, context priority is Firefox > Chrome > Chromium.",
-  "properties": {
-    "app": {
-      "type": "object",
-      "description": "The application to run.",
-      "additionalProperties": false,
-      "required": [
-        "name"
-      ],
-      "properties": {
-        "name": {
-          "type": "string",
-          "description": "Name of the application.",
-          "enum": [
-            "chrome",
-            "firefox",
-            "safari",
-            "edge"
-          ]
-        },
-        "path": {
-          "type": "string",
-          "description": "Absolute path or command for the application. If not specified, defaults to typical install paths per platform. If specified but the path is invalid, the context is skipped."
-        },
-        "options": {
-          "type": "object",
-          "description": "Options to pass to the app. Only works when `name` is `firefox` or `chrome`.",
-          "additionalProperties": false,
-          "properties": {
-            "width": {
-              "type": "integer",
-              "description": "Width of the window in pixels."
-            },
-            "height": {
-              "type": "integer",
-              "description": "Height of the window in pixels."
-            },
-            "viewport_height": {
-              "type": "integer",
-              "description": "Height of the viewport in pixels. Overrides `height`."
-            },
-            "viewport_width": {
-              "type": "integer",
-              "description": "Width of the viewport in pixels. Overrides `width`."
-            },
-            "headless": {
-              "type": "boolean",
-              "description": "If `true`, runs the browser in headless mode. Not supported by Safari."
-            },
-            "driverPath": {
-              "type": "string",
-              "description": "Path to the browser driver. If not specified, defaults to internally managed dependencies."
-            }
-          }
-        }
-      }
-    },
-    "platforms": {
-      "description": "Supported platforms for the application.",
-      "type": "array",
-      "items": {
-        "type": "string",
-        "enum": [
-          "linux",
-          "mac",
-          "windows"
-        ]
-      }
-    }
-  },
-  "required": [
-    "app",
-    "platforms"
-  ],
-  "additionalProperties": false,
-  "examples": [
-    {
-      "app": {
-        "name": "chrome"
-      },
-      "platforms": [
-        "linux"
-      ]
-    },
-    {
-      "app": {
-        "name": "chrome",
-        "options": {
-          "viewport_width": 800,
-          "viewport_height": 600
-        }
-      },
-      "platforms": [
-        "linux"
-      ]
-    },
-    {
-      "app": {
-        "name": "firefox",
-        "options": {
-          "width": 800,
-          "height": 600,
-          "headless": false,
-          "driverPath": "/usr/bin/geckodriver"
-        }
-      },
-      "platforms": [
-        "linux",
-        "windows",
-        "mac"
-      ]
-    },
-    {
-      "app": {
-        "name": "safari"
-      },
-      "platforms": [
-        "mac"
-      ]
-    },
-    {
-      "app": {
-        "name": "firefox",
-        "path": "/usr/bin/firefox"
-      },
-      "platforms": [
-        "linux"
-      ]
-    }
-  ]
-}

package/src/schemas/output_schemas/context_v3.schema.json

@@ -1,374 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "context",
-  "type": "object",
-  "description": "A context in which to perform tests. If no contexts are specified but a context is required by one or more tests, Doc Detective attempts to identify a supported context in the current environment and run tests against it. For example, if a browser isn't specified but is required by steps in the test, Doc Detective will search for and use a supported browser available in the current environment.",
-  "additionalProperties": false,
-  "dynamicDefaults": {
-    "contextId": "uuid"
-  },
-  "properties": {
-    "$schema": {
-      "description": "JSON Schema for this object.",
-      "type": "string",
-      "enum": [
-        "https://raw.githubusercontent.com/doc-detective/common/refs/heads/main/dist/schemas/context_v3.schema.json"
-      ]
-    },
-    "contextId": {
-      "type": "string",
-      "description": "Unique identifier for the context."
-    },
-    "platforms": {
-      "description": "Platforms to run tests on.",
-      "anyOf": [
-        {
-          "type": "string",
-          "enum": [
-            "linux",
-            "mac",
-            "windows"
-          ]
-        },
-        {
-          "type": "array",
-          "items": {
-            "type": "string",
-            "enum": [
-              "linux",
-              "mac",
-              "windows"
-            ]
-          }
-        }
-      ]
-    },
-    "browsers": {
-      "description": "Browsers to run tests on.",
-      "anyOf": [
-        {
-          "type": "string",
-          "description": "Name of the browser.",
-          "enum": [
-            "chrome",
-            "firefox",
-            "safari",
-            "webkit"
-          ],
-          "$comment": "`safari` is just a shortcut for `webkit`. Included for visibility and to reduce questions."
-        },
-        {
-          "type": "object",
-          "description": "Browser configuration.",
-          "required": [
-            "name"
-          ],
-          "additionalProperties": false,
-          "properties": {
-            "name": {
-              "type": "string",
-              "description": "Name of the browser.",
-              "enum": [
-                "chrome",
-                "firefox",
-                "safari",
-                "webkit"
-              ],
-              "$comment": "`safari` is just a shortcut for `webkit`. Included for visibility and to reduce questions."
-            },
-            "headless": {
-              "type": "boolean",
-              "description": "If `true`, runs the browser in headless mode.",
-              "default": true
-            },
-            "window": {
-              "type": "object",
-              "description": "Browser dimensions.",
-              "additionalProperties": false,
-              "properties": {
-                "width": {
-                  "type": "integer",
-                  "description": "Width of the browser window in pixels."
-                },
-                "height": {
-                  "type": "integer",
-                  "description": "Height of the browser window in pixels."
-                }
-              },
-              "title": "Browser Window"
-            },
-            "viewport": {
-              "type": "object",
-              "description": "Viewport dimensions.",
-              "additionalProperties": false,
-              "properties": {
-                "width": {
-                  "type": "integer",
-                  "description": "Width of the viewport in pixels."
-                },
-                "height": {
-                  "type": "integer",
-                  "description": "Height of the viewport in pixels."
-                }
-              },
-              "title": "Browser Viewport"
-            }
-          },
-          "title": "Browser"
-        },
-        {
-          "type": "array",
-          "items": {
-            "anyOf": [
-              {
-                "type": "string",
-                "description": "Name of the browser.",
-                "enum": [
-                  "chrome",
-                  "firefox",
-                  "safari",
-                  "webkit"
-                ],
-                "$comment": "`safari` is just a shortcut for `webkit`. Included for visibility and to reduce questions."
-              },
-              {
-                "type": "object",
-                "description": "Browser configuration.",
-                "required": [
-                  "name"
-                ],
-                "additionalProperties": false,
-                "properties": {
-                  "name": {
-                    "type": "string",
-                    "description": "Name of the browser.",
-                    "enum": [
-                      "chrome",
-                      "firefox",
-                      "safari",
-                      "webkit"
-                    ],
-                    "$comment": "`safari` is just a shortcut for `webkit`. Included for visibility and to reduce questions."
-                  },
-                  "headless": {
-                    "type": "boolean",
-                    "description": "If `true`, runs the browser in headless mode.",
-                    "default": true
-                  },
-                  "window": {
-                    "type": "object",
-                    "description": "Browser dimensions.",
-                    "additionalProperties": false,
-                    "properties": {
-                      "width": {
-                        "type": "integer",
-                        "description": "Width of the browser window in pixels."
-                      },
-                      "height": {
-                        "type": "integer",
-                        "description": "Height of the browser window in pixels."
-                      }
-                    },
-                    "title": "Browser Window"
-                  },
-                  "viewport": {
-                    "type": "object",
-                    "description": "Viewport dimensions.",
-                    "additionalProperties": false,
-                    "properties": {
-                      "width": {
-                        "type": "integer",
-                        "description": "Width of the viewport in pixels."
-                      },
-                      "height": {
-                        "type": "integer",
-                        "description": "Height of the viewport in pixels."
-                      }
-                    },
-                    "title": "Browser Viewport"
-                  }
-                },
-                "title": "Browser"
-              }
-            ]
-          }
-        }
-      ]
-    }
-  },
-  "components": {
-    "schemas": {
-      "platform": {
-        "type": "string",
-        "enum": [
-          "linux",
-          "mac",
-          "windows"
-        ]
-      },
-      "browserName": {
-        "type": "string",
-        "description": "Name of the browser.",
-        "enum": [
-          "chrome",
-          "firefox",
-          "safari",
-          "webkit"
-        ],
-        "$comment": "`safari` is just a shortcut for `webkit`. Included for visibility and to reduce questions."
-      },
-      "browser": {
-        "type": "object",
-        "description": "Browser configuration.",
-        "required": [
-          "name"
-        ],
-        "additionalProperties": false,
-        "properties": {
-          "name": {
-            "type": "string",
-            "description": "Name of the browser.",
-            "enum": [
-              "chrome",
-              "firefox",
-              "safari",
-              "webkit"
-            ],
-            "$comment": "`safari` is just a shortcut for `webkit`. Included for visibility and to reduce questions."
-          },
-          "headless": {
-            "type": "boolean",
-            "description": "If `true`, runs the browser in headless mode.",
-            "default": true
-          },
-          "window": {
-            "type": "object",
-            "description": "Browser dimensions.",
-            "additionalProperties": false,
-            "properties": {
-              "width": {
-                "type": "integer",
-                "description": "Width of the browser window in pixels."
-              },
-              "height": {
-                "type": "integer",
-                "description": "Height of the browser window in pixels."
-              }
-            },
-            "title": "Browser Window"
-          },
-          "viewport": {
-            "type": "object",
-            "description": "Viewport dimensions.",
-            "additionalProperties": false,
-            "properties": {
-              "width": {
-                "type": "integer",
-                "description": "Width of the viewport in pixels."
-              },
-              "height": {
-                "type": "integer",
-                "description": "Height of the viewport in pixels."
-              }
-            },
-            "title": "Browser Viewport"
-          }
-        },
-        "title": "Browser"
-      }
-    }
-  },
-  "examples": [
-    {
-      "platforms": "linux",
-      "browsers": "chrome"
-    },
-    {
-      "platforms": [
-        "windows",
-        "mac",
-        "linux"
-      ],
-      "browsers": [
-        "chrome",
-        "firefox",
-        "webkit"
-      ]
-    },
-    {
-      "browsers": {
-        "name": "chrome",
-        "headless": true
-      }
-    },
-    {
-      "browsers": [
-        {
-          "name": "chrome",
-          "headless": true
-        },
-        {
-          "name": "firefox"
-        }
-      ]
-    },
-    {
-      "platforms": [
-        "mac",
-        "linux"
-      ],
-      "browsers": {
-        "name": "chrome",
-        "headless": true
-      }
-    },
-    {
-      "platforms": [
-        "windows",
-        "mac",
-        "linux"
-      ],
-      "browsers": [
-        {
-          "name": "chrome",
-          "headless": true,
-          "window": {
-            "width": 1920,
-            "height": 1080
-          },
-          "viewport": {
-            "width": 1600,
-            "height": 900
-          }
-        },
-        {
-          "name": "firefox",
-          "window": {
-            "width": 1366,
-            "height": 768
-          }
-        },
-        {
-          "name": "webkit",
-          "headless": false,
-          "viewport": {
-            "width": 1440,
-            "height": 900
-          }
-        }
-      ]
-    },
-    {
-      "platforms": "mac",
-      "browsers": [
-        {
-          "name": "safari",
-          "window": {
-            "width": 1280,
-            "height": 800
-          }
-        }
-      ]
-    }
-  ]
-}