aivee 0.1.0-alpha.0 → 0.1.0-dev.d34a6ba

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2026 Waren Gonzaga
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2026 Waren Gonzaga
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,118 +1,120 @@
-# AIVEE
-
-<p align="center">
-  <img src="https://ghrb.waren.build/render/banner?header=AIVEE&amp;subheader=AI%20Video%20Editing%20Engine%20for%20AI%20workflows&amp;bg=0D1117-1B2B4B&amp;color=F0F6FC&amp;subheadercolor=C7D2E5&amp;headerfont=Inter&amp;subheaderfont=Inter" alt="AIVEE — AI Video Editing Engine for AI workflows">
-</p>
-
-<p align="center">
-  <strong>A local-first video editing CLI and API for AI workflows.</strong><br>
-  Build timelines, review edits, compose layers, and render with Node.js.
-</p>
-
-## ✨ Features
-
-- **Generic timeline:** editable video, audio, and overlay tracks with validated clips, transitions, keyframes, masks, speech-bubble captions, and other overlays.
-- **Media workflow:** register and verify assets, create proxies and previews, inspect scenes, and plan reviewable B-roll edits.
-- **Audio and transcripts:** retime word-level transcripts, mix and master audio, apply fades and ducking, and export subtitle files.
-- **Rendering:** render MP4, WebM, MOV, GIF, or PNG sequences with progress, cancellation, output checks, and resumable capture checkpoints.
-- **Interchange and animation:** optional OpenTimelineIO support, generic timed image layers, and keyframes. Avatar art and speech-driven character animation are owned by consuming studios such as [Explainer Studio](https://github.com/warengonzaga/explainer-studio).
-- **AI-ready interfaces:** use the same versioned timeline through the CLI or JavaScript API; proposed content cuts remain reviewable before application.
-
-## 🖥️ Platform Support
-
-Windows and Linux are supported. Windows has a local test and render-smoke
-baseline. Linux passed all 137 tests, the full render smoke, and the production
-dependency audit in a Debian Bookworm Docker container with Node.js 22, FFmpeg,
-and the HyperFrames headless browser. Container rendering used software
-graphics.
-
-macOS is not officially supported yet. The repository has a manual macOS
-workflow option, but native Mac validation is still required. Follow
-[issue #2](https://github.com/warengonzaga/ai-video-editing-engine/issues/2) for
-that work.
-
-## 🚀 Getting Started
-
-### Requirements
-
-- Node.js 22 or newer
-- FFmpeg and ffprobe
-- HyperFrames browser runtime for rendering
-- Python and OpenTimelineIO only for timeline interchange
-
-### Install and check the local toolchain
-
-```sh
-npm install
-npm run doctor
-node src/cli.mjs capabilities
-```
-
-Create a project and list the supported canvas presets:
-
-```sh
-npm run new-video -- vertical-video 1080x1920 30 15
-node src/cli.mjs presets list
-```
-
-After the first release, install the CLI from npm with:
-
-```sh
-npm install --global aivee
-aivee doctor
-```
-
-The CLI command is `aivee`. The release workflow publishes the unscoped npm
-package `aivee` and the owner-scoped GitHub Packages package
-`@warengonzaga/aivee`. Neither package has been published yet. The first release
-requires a repository `NPM_TOKEN` with npm publish access and GitHub Actions
-package-write permission.
-See the [release guide](docs/releasing.md) for the one-time setup.
-
-## 📖 Usage
-
-Start with the [Video Editing Usage Guide](docs/usage.md) for project creation,
-media registration, editing operations, rendering, transcripts, and
-OpenTimelineIO interchange.
-
-Related references:
-
-- [Aspect ratio presets](docs/aspect-ratio-presets.md)
-- [Architecture and API boundaries](docs/architecture.md)
-
-## 🧪 Development and Validation
-
-Run the automated checks from the repository root:
-
-```sh
-npm test
-npm run test:render-smoke
-npm audit --omit=dev
-```
-
-GitHub Actions are manual-trigger only. Use the platform selector for Linux,
-Windows, macOS, or the full matrix. A native macOS run is still required before
-claiming Mac support.
-
-## 🤝 Contributing
-
-Use short-lived feature branches from `dev` and open pull requests targeting
-`dev`. Follow the repository's Clean Commit format and keep changes focused. Do
-not create a `dev`-to-`main` pull request without a release decision.
-
-## 🐛 Issues & Support
-
-Report defects, request capabilities, or track platform validation through
-[GitHub Issues](https://github.com/warengonzaga/ai-video-editing-engine/issues).
-See [issue #2](https://github.com/warengonzaga/ai-video-editing-engine/issues/2)
-for native macOS support validation.
-
-## 📄 License
-
-AIVEE (AI Video Editing Engine) is licensed under the [MIT License](LICENSE). Third-party
-dependencies retain their respective licenses.
-
-## 👥 Authors & Contributors
-
-Created and maintained by [Waren Gonzaga](https://github.com/warengonzaga) and
-contributors.
+# AIVEE
+
+<p align="center">
+  <img src="https://ghrb.waren.build/render/banner?header=AIVEE&amp;subheader=AI%20Video%20Editing%20Engine%20for%20AI%20workflows&amp;bg=0D1117-1B2B4B&amp;color=F0F6FC&amp;subheadercolor=C7D2E5&amp;headerfont=Inter&amp;subheaderfont=Inter" alt="AIVEE — AI Video Editing Engine for AI workflows">
+</p>
+
+<p align="center">
+  <strong>A local-first video editing CLI and API for AI workflows.</strong><br>
+  Build timelines, review edits, compose layers, and render with Node.js.
+</p>
+
+## ✨ Features
+
+- **Generic timeline:** editable video, audio, and overlay tracks with validated clips, transitions, keyframes, masks, speech-bubble captions, and other overlays.
+- **Media workflow:** register and verify assets, create proxies and previews, inspect scenes, and plan reviewable B-roll edits.
+- **Audio and transcripts:** retime word-level transcripts, mix and master audio, apply fades and ducking, and export subtitle files.
+- **Rendering:** render MP4, WebM, MOV, GIF, or PNG sequences with progress, cancellation, output checks, and resumable capture checkpoints.
+- **Interchange and animation:** optional OpenTimelineIO support, generic timed image layers, and keyframes. Avatar art and speech-driven character animation are owned by consuming studios such as [Explainer Studio](https://github.com/warengonzaga/explainer-studio).
+- **AI-ready interfaces:** use the same versioned timeline through the CLI or JavaScript API; proposed content cuts remain reviewable before application.
+
+## 🖥️ Platform Support
+
+Windows and Linux are supported. Windows has a local test and render-smoke
+baseline. Linux passed all 137 tests, the full render smoke, and the production
+dependency audit in a Debian Bookworm Docker container with Node.js 22, FFmpeg,
+and the HyperFrames headless browser. Container rendering used software
+graphics.
+
+macOS is not officially supported yet. The repository has a manual macOS
+workflow option, but native Mac validation is still required. Follow
+[issue #2](https://github.com/warengonzaga/ai-video-editing-engine/issues/2) for
+that work.
+
+## 🚀 Getting Started
+
+### Requirements
+
+- Node.js 22 or newer
+- FFmpeg and ffprobe
+- HyperFrames browser runtime for rendering
+- Python and OpenTimelineIO only for timeline interchange
+
+### Install and check the local toolchain
+
+```sh
+npm install
+npm run doctor
+node src/cli.mjs capabilities
+```
+
+Create a project and list the supported canvas presets:
+
+```sh
+npm run new-video -- vertical-video 1080x1920 30 15
+node src/cli.mjs presets list
+```
+
+After the first release, install the CLI from npm with:
+
+```sh
+npm install --global aivee
+aivee doctor
+```
+
+The CLI command is `aivee`. The release workflow publishes the unscoped npm
+package `aivee` and the owner-scoped GitHub Packages package
+`@warengonzaga/aivee`. npm publishing uses trusted publishing through GitHub
+Actions OIDC, so no `NPM_TOKEN` secret is needed. Package artifacts are also
+published for pull requests, `dev` pushes, and manual workflow runs. See the
+[release guide](docs/releasing.md) for the one-time setup.
+
+## 📖 Usage
+
+Start with the [Video Editing Usage Guide](docs/usage.md) for project creation,
+media registration, editing operations, rendering, transcripts, and
+OpenTimelineIO interchange.
+
+Related references:
+
+- [Aspect ratio presets](docs/aspect-ratio-presets.md)
+- [Architecture and API boundaries](docs/architecture.md)
+
+## 🧪 Development and Validation
+
+Run the automated checks from the repository root:
+
+```sh
+npm test
+npm run test:render-smoke
+npm audit --omit=dev
+```
+
+Build Flow runs on pull requests targeting `dev` or `main`, pushes to `dev` or
+`main`, and manual dispatch. Its package artifacts publish on pull requests,
+`dev` pushes, and manual runs. The separate platform-validation workflow is
+manual-trigger only; use its selector for Linux, Windows, macOS, or the full
+matrix. A native macOS run is still required before claiming Mac support.
+
+## 🤝 Contributing
+
+Use short-lived feature branches from `dev` and open pull requests targeting
+`dev`. Follow the repository's Clean Commit format and keep changes focused. Do
+not create a `dev`-to-`main` pull request without a release decision.
+
+## 🐛 Issues & Support
+
+Report defects, request capabilities, or track platform validation through
+[GitHub Issues](https://github.com/warengonzaga/ai-video-editing-engine/issues).
+See [issue #2](https://github.com/warengonzaga/ai-video-editing-engine/issues/2)
+for native macOS support validation.
+
+## 📄 License
+
+AIVEE (AI Video Editing Engine) is licensed under the [MIT License](LICENSE). Third-party
+dependencies retain their respective licenses.
+
+## 👥 Authors & Contributors
+
+Created and maintained by [Waren Gonzaga](https://github.com/warengonzaga) and
+contributors.