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

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.2",
+  "version": "1.22.0-dev.1",
   "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

@@ -27,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]",

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

@@ -38,6 +38,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."
@@ -77,6 +85,18 @@
         "linux"
       ]
     },
+    {
+      "app": {
+        "name": "chrome",
+        "options": {
+          "viewport_width": 800,
+          "viewport_height": 600
+        }
+      },
+      "platforms": [
+        "linux"
+      ]
+    },
     {
       "app": {
         "name": "firefox",

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

@@ -39,9 +39,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.",
@@ -130,6 +149,13 @@
       "click": true,
       "typeKeys": "shorthair cat"
     },
+    {
+      "action": "find",
+      "selector": "[title=Search]",
+      "click": {
+        "button": "right"
+      }
+    },
     {
       "action": "find",
       "selector": "[title=Search]",

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

@@ -0,0 +1,205 @@
+{
+  "title": "runCode",
+  "type": "object",
+  "description": "Assemble and run code.",
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "ID of the step."
+    },
+    "description": {
+      "type": "string",
+      "description": "Description of the step."
+    },
+    "action": {
+      "type": "string",
+      "const": "runCode",
+      "description": "The action to perform."
+    },
+    "language": {
+      "type": "string",
+      "description": "Language of the code to run. If not specified, the code is run in the shell.",
+      "enum": [
+        "shell",
+        "python",
+        "py",
+        "node",
+        "bash",
+        "sh",
+        "javascript",
+        "js"
+      ]
+    },
+    "code": {
+      "type": "string",
+      "description": "Code to run."
+    },
+    "args": {
+      "type": "array",
+      "description": "Arguments for the command.",
+      "items": {
+        "oneOf": [
+          {
+            "type": "string"
+          }
+        ]
+      },
+      "default": []
+    },
+    "workingDirectory": {
+      "type": "string",
+      "description": "Working directory for the command.",
+      "default": "."
+    },
+    "exitCodes": {
+      "type": "array",
+      "description": "Expected exit codes of the command. If the command's actual exit code isn't in this list, the step fails.",
+      "items": {
+        "oneOf": [
+          {
+            "type": "integer"
+          }
+        ]
+      },
+      "default": [
+        0
+      ]
+    },
+    "output": {
+      "type": "string",
+      "description": "Content expected in the command's output. If the expected content can't be found in the command's output (either stdout or stderr), the step fails. Supports strings and regular expressions. To use a regular expression, the string must start and end with a forward slash, like in `/^hello-world.*/`."
+    },
+    "savePath": {
+      "type": "string",
+      "description": "File path to save the command's output, relative to `saveDirectory`."
+    },
+    "saveDirectory": {
+      "type": "string",
+      "description": "Directory to save the command's output. If the directory doesn't exist, creates the directory. If not specified, the directory is your media directory."
+    },
+    "maxVariation": {
+      "type": "integer",
+      "description": "Allowed variation in percentage of text different between the current output and previously saved output. If the difference between the current output and the previous output is greater than `maxVariation`, the step fails. If output doesn't exist at `savePath`, this value is ignored.",
+      "default": 0,
+      "minimum": 0,
+      "maximum": 100
+    },
+    "overwrite": {
+      "type": "string",
+      "description": "If `true`, overwrites the existing output at `savePath` if it exists.\nIf `byVariation`, overwrites the existing output at `savePath` if the difference between the new output and the existing output is greater than `maxVariation`.",
+      "enum": [
+        "true",
+        "false",
+        "byVariation"
+      ],
+      "default": "false"
+    },
+    "timeout": {
+      "type": "integer",
+      "description": "Max time in milliseconds the command is allowed to run. If the command runs longer than this, the step fails.",
+      "default": 60000
+    },
+    "setVariables": {
+      "type": "array",
+      "description": "Extract environment variables from the command's output.",
+      "items": {
+        "oneOf": [
+          {
+            "description": "",
+            "type": "object",
+            "properties": {
+              "name": {
+                "description": "Name of the environment variable to set.",
+                "type": "string"
+              },
+              "regex": {
+                "description": "Regex to extract the environment variable from the command's output.",
+                "type": "string"
+              }
+            },
+            "required": [
+              "name",
+              "regex"
+            ]
+          }
+        ]
+      },
+      "default": []
+    },
+    "outputs": {
+      "type": "object",
+      "description": "Outputs from step processes and user-defined expressions. Use the `outputs` object to reference outputs in subsequent steps. If a user-defined output matches the key for a step-defined output, the user-defined output takes precedence.",
+      "patternProperties": {
+        "^[A-Za-z0-9_]+$": {
+          "type": "string",
+          "description": "Runtime expression for a user-defined output value."
+        }
+      },
+      "properties": {
+        "stdout": {
+          "type": "string",
+          "description": "Standard output of the command.",
+          "readOnly": true
+        },
+        "stderr": {
+          "type": "string",
+          "description": "Standard error of the command.",
+          "readOnly": true
+        },
+        "exitCode": {
+          "type": "integer",
+          "description": "Exit code of the command.",
+          "readOnly": true
+        }
+      }
+    }
+  },
+  "dynamicDefaults": {
+    "id": "uuid"
+  },
+  "additionalProperties": false,
+  "required": [
+    "action",
+    "code",
+    "language"
+  ],
+  "examples": [
+    {
+      "action": "runCode",
+      "language": "javascript",
+      "code": "console.log('Hello, ${process.env.USER}!');"
+    },
+    {
+      "action": "runCode",
+      "language": "bash",
+      "code": "docker run hello-world",
+      "timeout": 20000,
+      "exitCodes": [
+        0
+      ],
+      "output": "Hello from Docker!"
+    },
+    {
+      "action": "runCode",
+      "language": "javascript",
+      "code": "return false",
+      "exitCodes": [
+        1
+      ]
+    },
+    {
+      "action": "runCode",
+      "language": "python",
+      "code": "print('Hello from Python')",
+      "workingDirectory": ".",
+      "exitCodes": [
+        0
+      ],
+      "output": "Hello from Python!",
+      "savePath": "python-output.txt",
+      "saveDirectory": "output",
+      "maxVariation": 10,
+      "overwrite": "byVariation"
+    }
+  ]
+}