@plasius/video 0.1.2 → 0.1.4

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.
package/CHANGELOG.md CHANGED
@@ -9,7 +9,10 @@ The format is based on **[Keep a Changelog](https://keepachangelog.com/en/1.1.0/
9
9
  ## [Unreleased]
10
10
 
11
11
  - **Added**
12
- - (placeholder)
12
+ - Added AI video generation design-system modules under `src/ai-video-generation/` with typed stage, token, and model definitions.
13
+ - Added `AIVideoGenerationScreen` and `AIVideoGenerationStudioDemo` React components to provide a demo-ready staged UI scaffold.
14
+ - Added visual-style token exports (`aiVideoGenerationTokens`) and stage-flow metadata (`aiVideoStageFlow`) for host app integration.
15
+ - Added tests for design token values, stage ordering, and core style hooks in `tests/ai-video-generation-design.test.ts`.
13
16
 
14
17
  - **Changed**
15
18
  - Added package-level GitHub CD publish workflow at `.github/workflows/cd.yml` for npm publication with provenance.
@@ -19,9 +22,12 @@ The format is based on **[Keep a Changelog](https://keepachangelog.com/en/1.1.0/
19
22
  - Updated Vitest coverage reporters to include `lcov` output for Codecov ingestion.
20
23
  - Made SBOM generation non-blocking in CD and only attest when `sbom.cdx.json` is present.
21
24
  - Made SBOM release-asset upload non-blocking to avoid failing publish after successful npm release.
25
+ - Updated README badges to include Codecov coverage and point workflow status to `cd.yml`.
26
+ - Normalized README section headings/formatting for consistent markdown rendering.
27
+ - Expanded README/demo examples to include the AI video generation screen scaffold and exported style primitives.
22
28
 
23
29
  - **Fixed**
24
- - (placeholder)
30
+ - Updated `videoPackageInfo.version` to match the current package line.
25
31
 
26
32
  - **Security**
27
33
  - Removed `depcheck` (and its `multimatch`/`minimatch` chain) from devDependencies to resolve reported high-severity audit findings.
package/README.md CHANGED
@@ -1,8 +1,9 @@
1
1
  # @plasius/video
2
2
 
3
3
  [![npm version](https://img.shields.io/npm/v/@plasius/video.svg)](https://www.npmjs.com/package/@plasius/video)
4
- [![Build Status](https://img.shields.io/github/actions/workflow/status/Plasius-LTD/video/ci.yml?branch=main&label=build&style=flat)](https://github.com/Plasius-LTD/video/actions/workflows/ci.yml)
5
- [![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](./LICENSE)
4
+ [![CD Status](https://img.shields.io/github/actions/workflow/status/Plasius-LTD/video/cd.yml?branch=main&label=cd&style=flat)](https://github.com/Plasius-LTD/video/actions/workflows/cd.yml)
5
+ [![coverage](https://img.shields.io/codecov/c/github/Plasius-LTD/video)](https://codecov.io/gh/Plasius-LTD/video)
6
+ [![License](https://img.shields.io/github/license/Plasius-LTD/video)](./LICENSE)
6
7
  [![Code of Conduct](https://img.shields.io/badge/code%20of%20conduct-yes-blue.svg)](./CODE_OF_CONDUCT.md)
7
8
  [![Security Policy](https://img.shields.io/badge/security%20policy-yes-orange.svg)](./SECURITY.md)
8
9
  [![Changelog](https://img.shields.io/badge/changelog-md-blue.svg)](./CHANGELOG.md)
@@ -11,25 +12,31 @@ Video generation components and helpers for the Plasius ecosystem.
11
12
 
12
13
  Apache-2.0. ESM + CJS builds. TypeScript types included.
13
14
 
14
- ---
15
-
16
- ## Installation
15
+ ## Install
17
16
 
18
17
  ```bash
19
18
  npm install @plasius/video
20
19
  ```
21
20
 
22
- ---
23
-
24
21
  ## Usage
25
22
 
26
23
  ```ts
27
- import { videoPackageInfo } from "@plasius/video";
24
+ import {
25
+ AIVideoGenerationScreen,
26
+ createAIVideoGenerationDemoModel,
27
+ aiVideoGenerationTokens,
28
+ aiVideoStageFlow,
29
+ videoPackageInfo,
30
+ } from "@plasius/video";
28
31
 
29
32
  console.log(videoPackageInfo.name, videoPackageInfo.version);
30
- ```
33
+ console.log(aiVideoGenerationTokens.color.background);
34
+ console.log(aiVideoStageFlow.map((stage) => stage.stage));
31
35
 
32
- ---
36
+ const model = createAIVideoGenerationDemoModel("imageSelection");
37
+ void AIVideoGenerationScreen;
38
+ void model;
39
+ ```
33
40
 
34
41
  ## Node.js Version
35
42
 
@@ -41,13 +48,45 @@ If you use [nvm](https://github.com/nvm-sh/nvm), run:
41
48
  nvm use
42
49
  ```
43
50
 
44
- ---
45
-
46
51
  ## Package Scope
47
52
 
48
53
  `@plasius/video` is intended to host reusable video generation interfaces and shared view-model logic used across Plasius applications.
49
54
 
50
- ---
55
+ ## AI Video Generation Visual Styling Pieces
56
+
57
+ This package now includes a design-system aligned screen scaffold for:
58
+
59
+ - Prompt entry
60
+ - Image generation and selection
61
+ - Video generation and motion editing
62
+ - Playback controls
63
+ - Voiceover panel
64
+ - Export state
65
+
66
+ Primary exports:
67
+
68
+ - `AIVideoGenerationScreen`
69
+ - `AIVideoGenerationStudioDemo`
70
+ - `createAIVideoGenerationDemoModel`
71
+ - `aiVideoGenerationTokens`
72
+ - `aiVideoStageFlow`
73
+ - `AI_VIDEO_GENERATION_SCREEN_STYLES`
74
+
75
+ Reference design document:
76
+
77
+ - [`docs/ai-video-generation-screen-visual-styling-guide.md`](./docs/ai-video-generation-screen-visual-styling-guide.md)
78
+
79
+ ## State Flow Summary
80
+
81
+ The staged flow aligns to the screen design sequence:
82
+
83
+ 1. `idle`
84
+ 2. `generatingImages`
85
+ 3. `imageSelection`
86
+ 4. `generatingVideo`
87
+ 5. `playback`
88
+ 6. `voiceover`
89
+ 7. `export`
51
90
 
52
91
  ## Development
53
92
 
@@ -58,7 +97,11 @@ npm run test
58
97
  npm run demo:run
59
98
  ```
60
99
 
61
- ---
100
+ ## Demo Sanity Check
101
+
102
+ ```bash
103
+ npm run demo:run
104
+ ```
62
105
 
63
106
  ## Publishing
64
107
 
@@ -68,8 +111,6 @@ This package is published via GitHub CD only.
68
111
  2. Run `.github/workflows/cd.yml` via **Actions -> CD (Publish to npm) -> Run workflow**.
69
112
  3. Select the version bump (`patch`, `minor`, `major`, or `none`) and optional pre-release id.
70
113
 
71
- ---
72
-
73
114
  ## Contributing
74
115
 
75
116
  We welcome contributions. See:
@@ -78,8 +119,6 @@ We welcome contributions. See:
78
119
  - [Code of Conduct](./CODE_OF_CONDUCT.md)
79
120
  - [Contributor License Agreement](./legal/CLA.md)
80
121
 
81
- ---
82
-
83
122
  ## License
84
123
 
85
124
  Licensed under the [Apache-2.0 License](./LICENSE).