doc-detective-common 1.21.1-dev.1 → 1.22.0-dev.0

package/.coderabbit.yaml

@@ -0,0 +1,92 @@
+language: en-US
+tone_instructions: ''
+early_access: false
+enable_free_tier: true
+reviews:
+  profile: chill
+  request_changes_workflow: false
+  high_level_summary: true
+  high_level_summary_placeholder: '@coderabbitai summary'
+  auto_title_placeholder: '@coderabbitai'
+  review_status: true
+  commit_status: true
+  poem: true
+  collapse_walkthrough: false
+  sequence_diagrams: true
+  changed_files_summary: true
+  labeling_instructions: []
+  path_filters: []
+  path_instructions: []
+  abort_on_close: true
+  auto_review:
+    enabled: true
+    auto_incremental_review: true
+    ignore_title_keywords: []
+    labels: []
+    drafts: false
+    base_branches: ["rc"]
+  tools:
+    shellcheck:
+      enabled: true
+    ruff:
+      enabled: true
+    markdownlint:
+      enabled: true
+    github-checks:
+      enabled: true
+      timeout_ms: 90000
+    languagetool:
+      enabled: true
+      enabled_only: false
+      level: default
+    biome:
+      enabled: true
+    hadolint:
+      enabled: true
+    swiftlint:
+      enabled: true
+    phpstan:
+      enabled: true
+      level: default
+    golangci-lint:
+      enabled: true
+    yamllint:
+      enabled: true
+    gitleaks:
+      enabled: true
+    checkov:
+      enabled: true
+    detekt:
+      enabled: true
+    eslint:
+      enabled: true
+    rubocop:
+      enabled: true
+    buf:
+      enabled: true
+    regal:
+      enabled: true
+    actionlint:
+      enabled: true
+    pmd:
+      enabled: true
+    cppcheck:
+      enabled: true
+    semgrep:
+      enabled: true
+    circleci:
+      enabled: true
+chat:
+  auto_reply: true
+knowledge_base:
+  opt_out: false
+  learnings:
+    scope: auto
+  issues:
+    scope: auto
+  jira:
+    project_keys: []
+  linear:
+    team_keys: []
+  pull_requests:
+    scope: auto

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "doc-detective-common",
-  "version": "1.21.1-dev.1",
+  "version": "1.22.0-dev.0",
   "description": "Shared components for Doc Detective projects.",
   "main": "src/index.js",
   "scripts": {
@@ -20,17 +20,17 @@
   "homepage": "https://github.com/doc-detective/doc-detective-common#readme",
   "devDependencies": {
     "chai": "^5.1.2",
-    "mocha": "^10.8.2",
+    "mocha": "^11.1.0",
     "sinon": "^19.0.2"
   },
   "dependencies": {
-    "@apidevtools/json-schema-ref-parser": "^11.7.2",
-    "ajv": "^8.17.1",
+    "@apidevtools/json-schema-ref-parser": "^11.7.3",
+    "ajv": "8.16.0",
     "ajv-errors": "^3.0.0",
     "ajv-formats": "^3.0.1",
     "ajv-keywords": "^5.1.0",
-    "axios": "^1.7.7",
-    "uuid": "^11.0.3",
-    "yaml": "^2.6.0"
+    "axios": "^1.7.9",
+    "uuid": "^11.0.5",
+    "yaml": "^2.7.0"
   }
 }

package/src/schemas/dereferenceSchemas.js

@@ -18,7 +18,6 @@ async function dereferenceSchemas() {
   });
   const outputDir = path.resolve(`${__dirname}/output_schemas`);
   var files = [
-    "arazzo_v2.schema.json",
     "checkLink_v2.schema.json",
     "config_v2.schema.json",
     "context_v2.schema.json",
@@ -28,6 +27,7 @@ async function dereferenceSchemas() {
     "moveTo_v2.schema.json",
     "openApi_v2.schema.json",
     "runShell_v2.schema.json",
+    "runCode_v2.schema.json",
     "saveScreenshot_v2.schema.json",
     "setVariables_v2.schema.json",
     "startRecording_v2.schema.json",

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

@@ -182,6 +182,14 @@
                             "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."
@@ -221,6 +229,18 @@
                       "linux"
                     ]
                   },
+                  {
+                    "app": {
+                      "name": "chrome",
+                      "options": {
+                        "viewport_width": 800,
+                        "viewport_height": 600
+                      }
+                    },
+                    "platforms": [
+                      "linux"
+                    ]
+                  },
                   {
                     "app": {
                       "name": "firefox",
@@ -632,9 +652,28 @@
                                     "default": false
                                   },
                                   "click": {
-                                    "type": "boolean",
                                     "description": "Click the element.",
-                                    "default": false
+                                    "oneOf": [
+                                      {
+                                        "type": "boolean",
+                                        "default": false
+                                      },
+                                      {
+                                        "type": "object",
+                                        "additionalProperties": false,
+                                        "properties": {
+                                          "button": {
+                                            "description": "Kind of click to perform.",
+                                            "type": "string",
+                                            "enum": [
+                                              "left",
+                                              "right",
+                                              "middle"
+                                            ]
+                                          }
+                                        }
+                                      }
+                                    ]
                                   },
                                   "typeKeys": {
                                     "description": "Type keys after finding the element. Either a string or an object with a `keys` field as defined in [`typeKeys`](typeKeys). To type in the element, make the element active with the `click` parameter.",
@@ -723,6 +762,13 @@
                                     "click": true,
                                     "typeKeys": "shorthair cat"
                                   },
+                                  {
+                                    "action": "find",
+                                    "selector": "[title=Search]",
+                                    "click": {
+                                      "button": "right"
+                                    }
+                                  },
                                   {
                                     "action": "find",
                                     "selector": "[title=Search]",
@@ -2062,70 +2108,6 @@
               }
             ]
           }
-        },
-        "arazzo": {
-          "type": "array",
-          "items": {
-            "allOf": [
-              {
-                "version": "1.0.0",
-                "$schema": "http://json-schema.org/draft-07/schema#",
-                "title": "arazzo",
-                "type": "object",
-                "description": "Arazzo description and configuration.",
-                "additionalProperties": false,
-                "properties": {
-                  "name": {
-                    "type": "string",
-                    "description": "Name of the Arazzo description, as defined in your configuration."
-                  },
-                  "descriptionPath": {
-                    "type": "string",
-                    "description": "URL or local path to the Arazzo description."
-                  },
-                  "workflowId": {
-                    "type": "string",
-                    "description": "Unique identifier for the workflow to run. If not specified, runs the first workflow in the Arazzo description."
-                  },
-                  "inputs": {
-                    "type": "object",
-                    "description": "Input parameters for the Arazzo description.",
-                    "additionalProperties": true
-                  }
-                },
-                "examples": [
-                  {
-                    "descriptionPath": "https://example.com/arazzo.json"
-                  },
-                  {
-                    "name": "CreateUser",
-                    "descriptionPath": "https://www.acme.com/create-user.arazzo.json",
-                    "inputs": {
-                      "name": "John Doe",
-                      "email": "johndoe@acme.com"
-                    }
-                  }
-                ]
-              },
-              {
-                "type": "object",
-                "properties": {
-                  "workflowId": {
-                    "type": "null",
-                    "$commment": "Only allow workflowId at the spec level."
-                  },
-                  "inputs": {
-                    "type": "null",
-                    "$commment": "Only allow inputs at the spec level."
-                  }
-                },
-                "required": [
-                  "name",
-                  "descriptionPath"
-                ]
-              }
-            ]
-          }
         }
       }
     },
@@ -2248,12 +2230,6 @@
             "server": "https://api.acme.com",
             "mockResponse": true
           }
-        ],
-        "arazzo": [
-          {
-            "name": "CreateUser",
-            "descriptionPath": "https://www.acme.com/create-user.arazzo.json"
-          }
         ]
       }
     },

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

@@ -1,114 +1,134 @@
-{
-  "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."
-            },
-            "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": "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"
-      ]
-    }
-  ]
+{
+  "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"
+      ]
+    }
+  ]
 }