recordable 0.1.0

package/recordable.schema.json

@@ -0,0 +1,738 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/paragramagency/recordable/main/recordable.schema.json",
+  "title": "Recordable script",
+  "description": "A declarative recording script: config + an array of actions.",
+  "oneOf": [
+    {
+      "type": "object",
+      "required": [
+        "actions"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "$schema": {
+          "type": "string"
+        },
+        "config": {
+          "$ref": "#/$defs/config"
+        },
+        "actions": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/action"
+          }
+        }
+      }
+    },
+    {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/action"
+      }
+    }
+  ],
+  "$defs": {
+    "config": {
+      "type": "object",
+      "properties": {
+        "viewport": {
+          "type": "object",
+          "properties": {
+            "width": {
+              "type": "number"
+            },
+            "height": {
+              "type": "number"
+            }
+          },
+          "required": [
+            "width",
+            "height"
+          ],
+          "additionalProperties": false
+        },
+        "fps": {
+          "type": "number"
+        },
+        "outputDir": {
+          "type": "string"
+        },
+        "outputName": {
+          "type": "string"
+        },
+        "outputTimestamp": {
+          "type": "boolean"
+        },
+        "assetsDir": {
+          "type": "string"
+        },
+        "headless": {
+          "type": "boolean"
+        },
+        "launchArgs": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "typingSpeed": {
+          "type": "number"
+        },
+        "videoCrf": {
+          "type": "number"
+        },
+        "videoCodec": {
+          "type": "string"
+        },
+        "videoPreset": {
+          "type": "string"
+        },
+        "zoomDuration": {
+          "type": "number"
+        },
+        "actionDelay": {
+          "type": "number"
+        },
+        "silent": {
+          "type": "boolean"
+        },
+        "autoScroll": {
+          "type": "boolean"
+        },
+        "scrollMargin": {
+          "type": "number"
+        },
+        "scrollSpeed": {
+          "type": "number"
+        },
+        "scrollDuration": {
+          "type": "number"
+        },
+        "cursor": {
+          "type": "boolean"
+        },
+        "visitTimeout": {
+          "type": "number"
+        }
+      },
+      "additionalProperties": false
+    },
+    "action": {
+      "type": "object",
+      "required": [
+        "action"
+      ],
+      "properties": {
+        "action": {
+          "enum": [
+            "pause",
+            "resume",
+            "resumeOnInput",
+            "insert",
+            "audio",
+            "setConfig",
+            "visit",
+            "waitFor",
+            "click",
+            "hover",
+            "type",
+            "clear",
+            "select",
+            "key",
+            "mouse",
+            "scroll",
+            "zoom",
+            "resetZoom",
+            "wait"
+          ],
+          "description": "The action to perform."
+        }
+      },
+      "allOf": [
+        {
+          "if": {
+            "properties": {
+              "action": {
+                "const": "pause"
+              }
+            },
+            "required": [
+              "action"
+            ]
+          },
+          "then": {
+            "properties": {
+              "action": {
+                "const": "pause"
+              }
+            },
+            "required": [
+              "action"
+            ],
+            "additionalProperties": false
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "action": {
+                "const": "resume"
+              }
+            },
+            "required": [
+              "action"
+            ]
+          },
+          "then": {
+            "properties": {
+              "action": {
+                "const": "resume"
+              }
+            },
+            "required": [
+              "action"
+            ],
+            "additionalProperties": false
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "action": {
+                "const": "resumeOnInput"
+              }
+            },
+            "required": [
+              "action"
+            ]
+          },
+          "then": {
+            "properties": {
+              "action": {
+                "const": "resumeOnInput"
+              },
+              "message": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "action"
+            ],
+            "additionalProperties": false
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "action": {
+                "const": "insert"
+              }
+            },
+            "required": [
+              "action"
+            ]
+          },
+          "then": {
+            "properties": {
+              "action": {
+                "const": "insert"
+              },
+              "path": {
+                "type": "string"
+              },
+              "fadeIn": {
+                "type": "number"
+              },
+              "fadeOut": {
+                "type": "number"
+              }
+            },
+            "required": [
+              "action",
+              "path"
+            ],
+            "additionalProperties": false
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "action": {
+                "const": "audio"
+              }
+            },
+            "required": [
+              "action"
+            ]
+          },
+          "then": {
+            "properties": {
+              "action": {
+                "const": "audio"
+              },
+              "path": {
+                "type": "string"
+              },
+              "wait": {
+                "type": "boolean"
+              },
+              "volume": {
+                "type": "number"
+              }
+            },
+            "required": [
+              "action",
+              "path"
+            ],
+            "additionalProperties": false
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "action": {
+                "const": "setConfig"
+              }
+            },
+            "required": [
+              "action"
+            ]
+          },
+          "then": {
+            "properties": {
+              "action": {
+                "const": "setConfig"
+              },
+              "config": {
+                "$ref": "#/$defs/config"
+              }
+            },
+            "required": [
+              "action",
+              "config"
+            ],
+            "additionalProperties": false
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "action": {
+                "const": "visit"
+              }
+            },
+            "required": [
+              "action"
+            ]
+          },
+          "then": {
+            "properties": {
+              "action": {
+                "const": "visit"
+              },
+              "url": {
+                "type": "string"
+              },
+              "waitUntil": {
+                "type": "string"
+              },
+              "timeout": {
+                "type": "number"
+              },
+              "referer": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "action",
+              "url"
+            ],
+            "additionalProperties": false
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "action": {
+                "const": "waitFor"
+              }
+            },
+            "required": [
+              "action"
+            ]
+          },
+          "then": {
+            "properties": {
+              "action": {
+                "const": "waitFor"
+              },
+              "target": {
+                "type": "string"
+              },
+              "state": {
+                "type": "string",
+                "enum": [
+                  "visible",
+                  "hidden",
+                  "present"
+                ]
+              },
+              "timeout": {
+                "type": "number"
+              }
+            },
+            "required": [
+              "action",
+              "target"
+            ],
+            "additionalProperties": false
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "action": {
+                "const": "click"
+              }
+            },
+            "required": [
+              "action"
+            ]
+          },
+          "then": {
+            "properties": {
+              "action": {
+                "const": "click"
+              },
+              "target": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "action",
+              "target"
+            ],
+            "additionalProperties": false
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "action": {
+                "const": "hover"
+              }
+            },
+            "required": [
+              "action"
+            ]
+          },
+          "then": {
+            "properties": {
+              "action": {
+                "const": "hover"
+              },
+              "target": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "action",
+              "target"
+            ],
+            "additionalProperties": false
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "action": {
+                "const": "type"
+              }
+            },
+            "required": [
+              "action"
+            ]
+          },
+          "then": {
+            "properties": {
+              "action": {
+                "const": "type"
+              },
+              "target": {
+                "type": "string"
+              },
+              "text": {
+                "type": "string"
+              },
+              "duration": {
+                "type": "number"
+              }
+            },
+            "required": [
+              "action",
+              "target",
+              "text"
+            ],
+            "additionalProperties": false
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "action": {
+                "const": "clear"
+              }
+            },
+            "required": [
+              "action"
+            ]
+          },
+          "then": {
+            "properties": {
+              "action": {
+                "const": "clear"
+              },
+              "target": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "action",
+              "target"
+            ],
+            "additionalProperties": false
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "action": {
+                "const": "select"
+              }
+            },
+            "required": [
+              "action"
+            ]
+          },
+          "then": {
+            "properties": {
+              "action": {
+                "const": "select"
+              },
+              "target": {
+                "type": "string"
+              },
+              "value": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "action",
+              "target",
+              "value"
+            ],
+            "additionalProperties": false
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "action": {
+                "const": "key"
+              }
+            },
+            "required": [
+              "action"
+            ]
+          },
+          "then": {
+            "properties": {
+              "action": {
+                "const": "key"
+              },
+              "key": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "action",
+              "key"
+            ],
+            "additionalProperties": false
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "action": {
+                "const": "mouse"
+              }
+            },
+            "required": [
+              "action"
+            ]
+          },
+          "then": {
+            "properties": {
+              "action": {
+                "const": "mouse"
+              },
+              "target": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "type": "object",
+                    "properties": {
+                      "x": {
+                        "type": "number"
+                      },
+                      "y": {
+                        "type": "number"
+                      }
+                    },
+                    "required": [
+                      "x",
+                      "y"
+                    ],
+                    "additionalProperties": false
+                  }
+                ]
+              }
+            },
+            "required": [
+              "action",
+              "target"
+            ],
+            "additionalProperties": false
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "action": {
+                "const": "scroll"
+              }
+            },
+            "required": [
+              "action"
+            ]
+          },
+          "then": {
+            "properties": {
+              "action": {
+                "const": "scroll"
+              },
+              "target": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "type": "number"
+                  }
+                ]
+              },
+              "duration": {
+                "type": "number"
+              }
+            },
+            "required": [
+              "action",
+              "target"
+            ],
+            "additionalProperties": false
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "action": {
+                "const": "zoom"
+              }
+            },
+            "required": [
+              "action"
+            ]
+          },
+          "then": {
+            "properties": {
+              "action": {
+                "const": "zoom"
+              },
+              "level": {
+                "type": "number"
+              },
+              "origin": {
+                "type": "string"
+              },
+              "duration": {
+                "type": "number"
+              }
+            },
+            "required": [
+              "action",
+              "level"
+            ],
+            "additionalProperties": false
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "action": {
+                "const": "resetZoom"
+              }
+            },
+            "required": [
+              "action"
+            ]
+          },
+          "then": {
+            "properties": {
+              "action": {
+                "const": "resetZoom"
+              },
+              "duration": {
+                "type": "number"
+              }
+            },
+            "required": [
+              "action"
+            ],
+            "additionalProperties": false
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "action": {
+                "const": "wait"
+              }
+            },
+            "required": [
+              "action"
+            ]
+          },
+          "then": {
+            "properties": {
+              "action": {
+                "const": "wait"
+              },
+              "ms": {
+                "type": "number"
+              }
+            },
+            "required": [
+              "action",
+              "ms"
+            ],
+            "additionalProperties": false
+          }
+        }
+      ]
+    }
+  }
+}