npm - rollberry - Versions diffs - 0.1.8 → 0.2.0 - Mend

rollberry 0.1.8 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (45) hide show

package/CHANGELOG.md +61 -0
package/README.md +189 -7
package/dist/capture/actions.d.ts +11 -0
package/dist/capture/actions.js +81 -0
package/dist/capture/browser-install.d.ts +3 -0
package/dist/capture/browser-install.js +1 -1
package/dist/capture/browser.d.ts +13 -0
package/dist/capture/browser.js +16 -10
package/dist/capture/capture.d.ts +8 -0
package/dist/capture/capture.js +566 -55
package/dist/capture/constants.d.ts +15 -0
package/dist/capture/constants.js +7 -0
package/dist/capture/ffmpeg.d.ts +41 -0
package/dist/capture/ffmpeg.js +457 -36
package/dist/capture/logger.d.ts +15 -0
package/dist/capture/preflight.d.ts +4 -0
package/dist/capture/preflight.js +8 -2
package/dist/capture/progress.d.ts +7 -0
package/dist/capture/progress.js +50 -0
package/dist/capture/scroll-plan.d.ts +9 -0
package/dist/capture/scroll-plan.js +7 -1
package/dist/capture/stabilize.d.ts +7 -0
package/dist/capture/stabilize.js +11 -5
package/dist/capture/types.d.ts +216 -0
package/dist/capture/utils.d.ts +14 -0
package/dist/capture/utils.js +30 -3
package/dist/cli.d.ts +2 -0
package/dist/cli.js +86 -5
package/dist/index.d.ts +7 -0
package/dist/index.js +6 -0
package/dist/options.d.ts +42 -0
package/dist/options.js +229 -115
package/dist/project.d.ts +27 -0
package/dist/project.js +722 -0
package/dist/render-plan.d.ts +103 -0
package/dist/render-plan.js +144 -0
package/dist/run-capture.d.ts +3 -0
package/dist/run-capture.js +20 -10
package/dist/run-render.d.ts +17 -0
package/dist/run-render.js +434 -0
package/dist/version.d.ts +1 -0
package/dist/version.js +1 -0
package/package.json +10 -3
package/rollberry.project.sample.json +92 -0
package/rollberry.project.schema.json +474 -0

package/rollberry.project.schema.json ADDED Viewed

@@ -0,0 +1,474 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://co-r-e.github.io/rollberry/rollberry.project.schema.json",
+  "title": "Rollberry Project",
+  "type": "object",
+  "required": ["scenes"],
+  "properties": {
+    "$schema": {
+      "type": "string"
+    },
+    "schemaVersion": {
+      "const": 1
+    },
+    "name": {
+      "type": "string"
+    },
+    "summaryManifest": {
+      "type": "string"
+    },
+    "defaults": {
+      "$ref": "#/$defs/defaults"
+    },
+    "scenes": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "$ref": "#/$defs/scene"
+      }
+    },
+    "outputs": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "$ref": "#/$defs/output"
+      }
+    }
+  },
+  "additionalProperties": false,
+  "$defs": {
+    "waitFor": {
+      "type": "string",
+      "pattern": "^(load|selector:.+|ms:[0-9]+)$"
+    },
+    "motion": {
+      "type": "string",
+      "enum": ["ease-in-out-sine", "linear"]
+    },
+    "selectorAction": {
+      "type": "object",
+      "required": ["type", "selector"],
+      "properties": {
+        "type": {
+          "type": "string",
+          "enum": ["click", "hover", "scroll-to"]
+        },
+        "selector": {
+          "type": "string"
+        },
+        "block": {
+          "type": "string",
+          "enum": ["start", "center", "end"]
+        }
+      },
+      "additionalProperties": false
+    },
+    "typeAction": {
+      "type": "object",
+      "required": ["type", "selector", "text"],
+      "properties": {
+        "type": {
+          "const": "type"
+        },
+        "selector": {
+          "type": "string"
+        },
+        "text": {
+          "type": "string"
+        },
+        "clear": {
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false
+    },
+    "pressAction": {
+      "type": "object",
+      "required": ["type", "key"],
+      "properties": {
+        "type": {
+          "const": "press"
+        },
+        "key": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false
+    },
+    "waitAction": {
+      "type": "object",
+      "required": ["type", "ms"],
+      "properties": {
+        "type": {
+          "const": "wait"
+        },
+        "ms": {
+          "type": "integer",
+          "minimum": 1
+        }
+      },
+      "additionalProperties": false
+    },
+    "setupAction": {
+      "oneOf": [
+        { "$ref": "#/$defs/waitAction" },
+        { "$ref": "#/$defs/selectorAction" },
+        { "$ref": "#/$defs/typeAction" },
+        { "$ref": "#/$defs/pressAction" }
+      ]
+    },
+    "timelineScroll": {
+      "type": "object",
+      "required": ["type"],
+      "properties": {
+        "type": {
+          "const": "scroll"
+        },
+        "duration": {
+          "oneOf": [
+            { "type": "number", "exclusiveMinimum": 0 },
+            { "const": "auto" }
+          ]
+        },
+        "motion": {
+          "$ref": "#/$defs/motion"
+        },
+        "to": {
+          "oneOf": [{ "type": "number", "minimum": 0 }, { "const": "bottom" }]
+        },
+        "by": {
+          "type": "number"
+        },
+        "toSelector": {
+          "type": "string"
+        },
+        "block": {
+          "type": "string",
+          "enum": ["start", "center", "end"]
+        }
+      },
+      "additionalProperties": false
+    },
+    "timelinePause": {
+      "type": "object",
+      "required": ["type", "duration"],
+      "properties": {
+        "type": {
+          "const": "pause"
+        },
+        "duration": {
+          "type": "number",
+          "exclusiveMinimum": 0
+        }
+      },
+      "additionalProperties": false
+    },
+    "timelineWait": {
+      "type": "object",
+      "required": ["type", "ms"],
+      "properties": {
+        "type": {
+          "const": "wait"
+        },
+        "ms": {
+          "type": "integer",
+          "minimum": 1
+        }
+      },
+      "additionalProperties": false
+    },
+    "timelineAction": {
+      "allOf": [
+        {
+          "oneOf": [
+            { "$ref": "#/$defs/selectorAction" },
+            { "$ref": "#/$defs/typeAction" },
+            { "$ref": "#/$defs/pressAction" }
+          ]
+        },
+        {
+          "type": "object",
+          "properties": {
+            "holdAfterSeconds": {
+              "type": "number",
+              "minimum": 0
+            }
+          }
+        }
+      ]
+    },
+    "timelineStep": {
+      "oneOf": [
+        { "$ref": "#/$defs/timelineScroll" },
+        { "$ref": "#/$defs/timelinePause" },
+        { "$ref": "#/$defs/timelineWait" },
+        { "$ref": "#/$defs/timelineAction" }
+      ]
+    },
+    "scene": {
+      "type": "object",
+      "required": ["url"],
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "url": {
+          "type": "string",
+          "format": "uri"
+        },
+        "duration": {
+          "oneOf": [
+            { "type": "number", "exclusiveMinimum": 0 },
+            { "const": "auto" }
+          ]
+        },
+        "motion": {
+          "$ref": "#/$defs/motion"
+        },
+        "waitFor": {
+          "$ref": "#/$defs/waitFor"
+        },
+        "hideSelectors": {
+          "type": "array",
+          "items": { "type": "string" }
+        },
+        "holdAfterSeconds": {
+          "type": "number",
+          "minimum": 0
+        },
+        "actions": {
+          "type": "array",
+          "items": { "$ref": "#/$defs/setupAction" }
+        },
+        "timeline": {
+          "type": "array",
+          "minItems": 1,
+          "items": { "$ref": "#/$defs/timelineStep" }
+        }
+      },
+      "additionalProperties": false
+    },
+    "defaults": {
+      "type": "object",
+      "properties": {
+        "viewport": {
+          "type": "string",
+          "pattern": "^[0-9]+x[0-9]+$"
+        },
+        "fps": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 120
+        },
+        "duration": {
+          "oneOf": [
+            { "type": "number", "exclusiveMinimum": 0 },
+            { "const": "auto" }
+          ]
+        },
+        "motion": {
+          "$ref": "#/$defs/motion"
+        },
+        "timeoutMs": {
+          "type": "integer",
+          "minimum": 1
+        },
+        "waitFor": {
+          "$ref": "#/$defs/waitFor"
+        },
+        "hideSelectors": {
+          "type": "array",
+          "items": { "type": "string" }
+        },
+        "holdAfterSeconds": {
+          "type": "number",
+          "minimum": 0
+        }
+      },
+      "additionalProperties": false
+    },
+    "audio": {
+      "type": "object",
+      "required": ["path"],
+      "properties": {
+        "path": {
+          "type": "string"
+        },
+        "volume": {
+          "type": "number",
+          "minimum": 0
+        },
+        "loop": {
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false
+    },
+    "subtitles": {
+      "type": "object",
+      "required": ["path"],
+      "properties": {
+        "path": {
+          "type": "string"
+        },
+        "mode": {
+          "type": "string",
+          "enum": ["soft", "burn-in"]
+        }
+      },
+      "additionalProperties": false
+    },
+    "transition": {
+      "type": "object",
+      "required": ["type", "duration"],
+      "properties": {
+        "type": {
+          "type": "string",
+          "enum": ["fade-in", "crossfade"]
+        },
+        "duration": {
+          "type": "number",
+          "exclusiveMinimum": 0
+        }
+      },
+      "additionalProperties": false
+    },
+    "intermediateVideo": {
+      "type": "object",
+      "properties": {
+        "preset": {
+          "type": "string",
+          "enum": [
+            "ultrafast",
+            "superfast",
+            "veryfast",
+            "faster",
+            "fast",
+            "medium",
+            "slow",
+            "slower",
+            "veryslow",
+            "placebo"
+          ]
+        },
+        "crf": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 51
+        }
+      },
+      "additionalProperties": false
+    },
+    "intermediateArtifact": {
+      "type": "object",
+      "properties": {
+        "format": {
+          "const": "mp4"
+        },
+        "preset": {
+          "type": "string",
+          "enum": [
+            "ultrafast",
+            "superfast",
+            "veryfast",
+            "faster",
+            "fast",
+            "medium",
+            "slow",
+            "slower",
+            "veryslow",
+            "placebo"
+          ]
+        },
+        "crf": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 51
+        }
+      },
+      "additionalProperties": false
+    },
+    "finalVideo": {
+      "type": "object",
+      "properties": {
+        "preset": {
+          "type": "string",
+          "enum": [
+            "ultrafast",
+            "superfast",
+            "veryfast",
+            "faster",
+            "fast",
+            "medium",
+            "slow",
+            "slower",
+            "veryslow",
+            "placebo"
+          ]
+        },
+        "deadline": {
+          "type": "string",
+          "enum": ["best", "good", "realtime"]
+        },
+        "crf": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 63
+        }
+      },
+      "additionalProperties": false
+    },
+    "output": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "out": {
+          "type": "string"
+        },
+        "format": {
+          "type": "string",
+          "enum": ["mp4", "webm"]
+        },
+        "manifest": {
+          "type": "string"
+        },
+        "logFile": {
+          "type": "string"
+        },
+        "viewport": {
+          "type": "string",
+          "pattern": "^[0-9]+x[0-9]+$"
+        },
+        "fps": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 120
+        },
+        "debugFramesDir": {
+          "type": "string"
+        },
+        "audio": {
+          "$ref": "#/$defs/audio"
+        },
+        "subtitles": {
+          "$ref": "#/$defs/subtitles"
+        },
+        "transition": {
+          "$ref": "#/$defs/transition"
+        },
+        "intermediateVideo": {
+          "$ref": "#/$defs/intermediateVideo"
+        },
+        "intermediateArtifact": {
+          "$ref": "#/$defs/intermediateArtifact"
+        },
+        "finalVideo": {
+          "$ref": "#/$defs/finalVideo"
+        }
+      },
+      "additionalProperties": false
+    }
+  }
+}