@warpgogol/forge 0.14.0 → 0.15.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.
- package/AGENTS.md +3 -3
- package/README.md +58 -5
- package/dist/bin/cli.js +0 -0
- package/dist/os/core/core.module.d.ts.map +1 -1
- package/dist/os/core/core.module.js +9 -0
- package/dist/os/core/core.module.js.map +1 -1
- package/dist/src/onboarding/create.d.ts.map +1 -1
- package/dist/src/onboarding/create.js +5 -2
- package/dist/src/onboarding/create.js.map +1 -1
- package/dist/src/onboarding/doctor.d.ts.map +1 -1
- package/dist/src/onboarding/doctor.js +38 -0
- package/dist/src/onboarding/doctor.js.map +1 -1
- package/dist/src/onboarding/invariant-engine.d.ts.map +1 -1
- package/dist/src/onboarding/invariant-engine.js +14 -7
- package/dist/src/onboarding/invariant-engine.js.map +1 -1
- package/dist/src/onboarding/scaffold-project.d.ts.map +1 -1
- package/dist/src/onboarding/scaffold-project.js +25 -5
- package/dist/src/onboarding/scaffold-project.js.map +1 -1
- package/dist/src/profiles/profile-schema.d.ts +73 -8
- package/dist/src/profiles/profile-schema.d.ts.map +1 -1
- package/dist/src/profiles/profile-schema.js +35 -10
- package/dist/src/profiles/profile-schema.js.map +1 -1
- package/dist/src/profiles/stack-profile.d.ts +26 -2
- package/dist/src/profiles/stack-profile.d.ts.map +1 -1
- package/dist/src/profiles/stack-profile.js +4 -0
- package/dist/src/profiles/stack-profile.js.map +1 -1
- package/package.json +162 -60
- package/profiles/editframe-templates/composition-agents.md +70 -0
- package/profiles/editframe-templates/composition.tsx +33 -0
- package/profiles/{editframe-html-templates/composition-agents.md → editframe-templates/html-composition-agents.md} +15 -16
- package/profiles/{editframe-html.yaml → editframe.yaml} +170 -56
- package/skills/fo/ef-brand-video-generator/SKILL.md +101 -0
- package/skills/fo/ef-composition/SKILL.md +147 -0
- package/skills/fo/ef-composition-review/SKILL.md +10 -10
- package/skills/fo/ef-dev-server/SKILL.md +107 -0
- package/skills/fo/ef-editor-gui/SKILL.md +131 -0
- package/skills/fo/ef-motion-design/SKILL.md +118 -0
- package/skills/fo/ef-onboard/SKILL.md +16 -29
- package/skills/fo/ef-render-verify/SKILL.md +2 -2
- package/skills/fo/ef-webhooks/SKILL.md +95 -0
- package/skills/fo/fo-session-retro/SKILL.md +2 -2
- package/profiles/editframe-html-templates/composition.html +0 -32
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@warpgogol/forge",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.15.0",
|
|
4
4
|
"private": false,
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "Apache-2.0",
|
|
@@ -15,107 +15,107 @@
|
|
|
15
15
|
"framework"
|
|
16
16
|
],
|
|
17
17
|
"homepage": "https://warpgogol.com",
|
|
18
|
-
"main": "./
|
|
19
|
-
"types": "./
|
|
18
|
+
"main": "./src/index.ts",
|
|
19
|
+
"types": "./src/index.ts",
|
|
20
20
|
"bin": {
|
|
21
21
|
"forge": "./bin/cli.js"
|
|
22
22
|
},
|
|
23
23
|
"exports": {
|
|
24
24
|
".": {
|
|
25
|
-
"types": "./
|
|
26
|
-
"default": "./
|
|
25
|
+
"types": "./src/index.ts",
|
|
26
|
+
"default": "./src/index.ts"
|
|
27
27
|
},
|
|
28
28
|
"./types": {
|
|
29
|
-
"types": "./
|
|
30
|
-
"default": "./
|
|
29
|
+
"types": "./src/types.ts",
|
|
30
|
+
"default": "./src/types.ts"
|
|
31
31
|
},
|
|
32
32
|
"./utils": {
|
|
33
|
-
"types": "./
|
|
34
|
-
"default": "./
|
|
33
|
+
"types": "./src/utils/index.ts",
|
|
34
|
+
"default": "./src/utils/index.ts"
|
|
35
35
|
},
|
|
36
36
|
"./config": {
|
|
37
|
-
"types": "./
|
|
38
|
-
"default": "./
|
|
37
|
+
"types": "./src/config/forge-config.ts",
|
|
38
|
+
"default": "./src/config/forge-config.ts"
|
|
39
39
|
},
|
|
40
40
|
"./os/core": {
|
|
41
|
-
"types": "./
|
|
42
|
-
"default": "./
|
|
41
|
+
"types": "./os/core/core.module.ts",
|
|
42
|
+
"default": "./os/core/core.module.ts"
|
|
43
43
|
},
|
|
44
44
|
"./os/compass": {
|
|
45
|
-
"types": "./
|
|
46
|
-
"default": "./
|
|
45
|
+
"types": "./os/compass/index.ts",
|
|
46
|
+
"default": "./os/compass/index.ts"
|
|
47
47
|
},
|
|
48
48
|
"./os/naming": {
|
|
49
|
-
"types": "./
|
|
50
|
-
"default": "./
|
|
49
|
+
"types": "./os/naming/index.ts",
|
|
50
|
+
"default": "./os/naming/index.ts"
|
|
51
51
|
},
|
|
52
52
|
"./os/naming-module": {
|
|
53
|
-
"types": "./
|
|
54
|
-
"default": "./
|
|
53
|
+
"types": "./os/naming/naming.module.ts",
|
|
54
|
+
"default": "./os/naming/naming.module.ts"
|
|
55
55
|
},
|
|
56
56
|
"./os/rfc": {
|
|
57
|
-
"types": "./
|
|
58
|
-
"default": "./
|
|
57
|
+
"types": "./os/rfc/index.ts",
|
|
58
|
+
"default": "./os/rfc/index.ts"
|
|
59
59
|
},
|
|
60
60
|
"./os/rfc-module": {
|
|
61
|
-
"types": "./
|
|
62
|
-
"default": "./
|
|
61
|
+
"types": "./os/rfc/rfc.module.ts",
|
|
62
|
+
"default": "./os/rfc/rfc.module.ts"
|
|
63
63
|
},
|
|
64
64
|
"./os/werkstatt": {
|
|
65
|
-
"types": "./
|
|
66
|
-
"default": "./
|
|
65
|
+
"types": "./os/werkstatt/index.ts",
|
|
66
|
+
"default": "./os/werkstatt/index.ts"
|
|
67
67
|
},
|
|
68
68
|
"./os/workflow": {
|
|
69
|
-
"types": "./
|
|
70
|
-
"default": "./
|
|
69
|
+
"types": "./os/workflow/index.ts",
|
|
70
|
+
"default": "./os/workflow/index.ts"
|
|
71
71
|
},
|
|
72
72
|
"./os/workflow-module": {
|
|
73
|
-
"types": "./
|
|
74
|
-
"default": "./
|
|
73
|
+
"types": "./os/workflow/workflow.module.ts",
|
|
74
|
+
"default": "./os/workflow/workflow.module.ts"
|
|
75
75
|
},
|
|
76
76
|
"./os/spec-module": {
|
|
77
|
-
"types": "./
|
|
78
|
-
"default": "./
|
|
77
|
+
"types": "./os/spec/spec.module.ts",
|
|
78
|
+
"default": "./os/spec/spec.module.ts"
|
|
79
79
|
},
|
|
80
80
|
"./os/adr": {
|
|
81
|
-
"types": "./
|
|
82
|
-
"default": "./
|
|
81
|
+
"types": "./os/adr/index.ts",
|
|
82
|
+
"default": "./os/adr/index.ts"
|
|
83
83
|
},
|
|
84
84
|
"./os/adr-module": {
|
|
85
|
-
"types": "./
|
|
86
|
-
"default": "./
|
|
85
|
+
"types": "./os/adr/adr.module.ts",
|
|
86
|
+
"default": "./os/adr/adr.module.ts"
|
|
87
87
|
},
|
|
88
88
|
"./os/plan": {
|
|
89
|
-
"types": "./
|
|
90
|
-
"default": "./
|
|
89
|
+
"types": "./os/plan/index.ts",
|
|
90
|
+
"default": "./os/plan/index.ts"
|
|
91
91
|
},
|
|
92
92
|
"./os/plan-module": {
|
|
93
|
-
"types": "./
|
|
94
|
-
"default": "./
|
|
93
|
+
"types": "./os/plan/plan.module.ts",
|
|
94
|
+
"default": "./os/plan/plan.module.ts"
|
|
95
95
|
},
|
|
96
96
|
"./os/audit": {
|
|
97
|
-
"types": "./
|
|
98
|
-
"default": "./
|
|
97
|
+
"types": "./os/audit/index.ts",
|
|
98
|
+
"default": "./os/audit/index.ts"
|
|
99
99
|
},
|
|
100
100
|
"./os/audit-module": {
|
|
101
|
-
"types": "./
|
|
102
|
-
"default": "./
|
|
101
|
+
"types": "./os/audit/audit.module.ts",
|
|
102
|
+
"default": "./os/audit/audit.module.ts"
|
|
103
103
|
},
|
|
104
104
|
"./os/session": {
|
|
105
|
-
"types": "./
|
|
106
|
-
"default": "./
|
|
105
|
+
"types": "./os/session/index.ts",
|
|
106
|
+
"default": "./os/session/index.ts"
|
|
107
107
|
},
|
|
108
108
|
"./os/session-module": {
|
|
109
|
-
"types": "./
|
|
110
|
-
"default": "./
|
|
109
|
+
"types": "./os/session/session.module.ts",
|
|
110
|
+
"default": "./os/session/session.module.ts"
|
|
111
111
|
},
|
|
112
112
|
"./os/mission": {
|
|
113
|
-
"types": "./
|
|
114
|
-
"default": "./
|
|
113
|
+
"types": "./os/mission/index.ts",
|
|
114
|
+
"default": "./os/mission/index.ts"
|
|
115
115
|
},
|
|
116
116
|
"./os/mission-module": {
|
|
117
|
-
"types": "./
|
|
118
|
-
"default": "./
|
|
117
|
+
"types": "./os/mission/mission.module.ts",
|
|
118
|
+
"default": "./os/mission/mission.module.ts"
|
|
119
119
|
}
|
|
120
120
|
},
|
|
121
121
|
"files": [
|
|
@@ -129,6 +129,15 @@
|
|
|
129
129
|
"README.md",
|
|
130
130
|
"LICENSE"
|
|
131
131
|
],
|
|
132
|
+
"scripts": {
|
|
133
|
+
"build": "pnpm exec tsc -p tsconfig.json",
|
|
134
|
+
"build:check": "pnpm exec tsc -p tsconfig.json --noEmit",
|
|
135
|
+
"clean": "rm -rf dist",
|
|
136
|
+
"prepublishOnly": "pnpm run clean && pnpm run build && node scripts/publish-check.mjs && node scripts/strip-workspace-deps.mjs",
|
|
137
|
+
"postpublish": "git checkout -- ./package.json",
|
|
138
|
+
"test": "vitest run --passWithNoTests",
|
|
139
|
+
"test:watch": "vitest"
|
|
140
|
+
},
|
|
132
141
|
"dependencies": {
|
|
133
142
|
"@aws-sdk/client-s3": "^3.700.0",
|
|
134
143
|
"trash": "^10.1.1",
|
|
@@ -145,13 +154,106 @@
|
|
|
145
154
|
"node": ">=20.0.0"
|
|
146
155
|
},
|
|
147
156
|
"publishConfig": {
|
|
148
|
-
"access": "public"
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
"
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
157
|
+
"access": "public",
|
|
158
|
+
"main": "./dist/src/index.js",
|
|
159
|
+
"types": "./dist/src/index.d.ts",
|
|
160
|
+
"exports": {
|
|
161
|
+
".": {
|
|
162
|
+
"types": "./dist/src/index.d.ts",
|
|
163
|
+
"default": "./dist/src/index.js"
|
|
164
|
+
},
|
|
165
|
+
"./types": {
|
|
166
|
+
"types": "./dist/src/types.d.ts",
|
|
167
|
+
"default": "./dist/src/types.js"
|
|
168
|
+
},
|
|
169
|
+
"./utils": {
|
|
170
|
+
"types": "./dist/src/utils/index.d.ts",
|
|
171
|
+
"default": "./dist/src/utils/index.js"
|
|
172
|
+
},
|
|
173
|
+
"./config": {
|
|
174
|
+
"types": "./dist/src/config/forge-config.d.ts",
|
|
175
|
+
"default": "./dist/src/config/forge-config.js"
|
|
176
|
+
},
|
|
177
|
+
"./os/core": {
|
|
178
|
+
"types": "./dist/os/core/core.module.d.ts",
|
|
179
|
+
"default": "./dist/os/core/core.module.js"
|
|
180
|
+
},
|
|
181
|
+
"./os/compass": {
|
|
182
|
+
"types": "./dist/os/compass/index.d.ts",
|
|
183
|
+
"default": "./dist/os/compass/index.js"
|
|
184
|
+
},
|
|
185
|
+
"./os/naming": {
|
|
186
|
+
"types": "./dist/os/naming/index.d.ts",
|
|
187
|
+
"default": "./dist/os/naming/index.js"
|
|
188
|
+
},
|
|
189
|
+
"./os/naming-module": {
|
|
190
|
+
"types": "./dist/os/naming/naming.module.d.ts",
|
|
191
|
+
"default": "./dist/os/naming/naming.module.js"
|
|
192
|
+
},
|
|
193
|
+
"./os/rfc": {
|
|
194
|
+
"types": "./dist/os/rfc/index.d.ts",
|
|
195
|
+
"default": "./dist/os/rfc/index.js"
|
|
196
|
+
},
|
|
197
|
+
"./os/rfc-module": {
|
|
198
|
+
"types": "./dist/os/rfc/rfc.module.d.ts",
|
|
199
|
+
"default": "./dist/os/rfc/rfc.module.js"
|
|
200
|
+
},
|
|
201
|
+
"./os/werkstatt": {
|
|
202
|
+
"types": "./dist/os/werkstatt/index.d.ts",
|
|
203
|
+
"default": "./dist/os/werkstatt/index.js"
|
|
204
|
+
},
|
|
205
|
+
"./os/workflow": {
|
|
206
|
+
"types": "./dist/os/workflow/index.d.ts",
|
|
207
|
+
"default": "./dist/os/workflow/index.js"
|
|
208
|
+
},
|
|
209
|
+
"./os/workflow-module": {
|
|
210
|
+
"types": "./dist/os/workflow/workflow.module.d.ts",
|
|
211
|
+
"default": "./dist/os/workflow/workflow.module.js"
|
|
212
|
+
},
|
|
213
|
+
"./os/spec-module": {
|
|
214
|
+
"types": "./dist/os/spec/spec.module.d.ts",
|
|
215
|
+
"default": "./dist/os/spec/spec.module.js"
|
|
216
|
+
},
|
|
217
|
+
"./os/adr": {
|
|
218
|
+
"types": "./dist/os/adr/index.d.ts",
|
|
219
|
+
"default": "./dist/os/adr/index.js"
|
|
220
|
+
},
|
|
221
|
+
"./os/adr-module": {
|
|
222
|
+
"types": "./dist/os/adr/adr.module.d.ts",
|
|
223
|
+
"default": "./dist/os/adr/adr.module.js"
|
|
224
|
+
},
|
|
225
|
+
"./os/plan": {
|
|
226
|
+
"types": "./dist/os/plan/index.d.ts",
|
|
227
|
+
"default": "./dist/os/plan/index.js"
|
|
228
|
+
},
|
|
229
|
+
"./os/plan-module": {
|
|
230
|
+
"types": "./dist/os/plan/plan.module.d.ts",
|
|
231
|
+
"default": "./dist/os/plan/plan.module.js"
|
|
232
|
+
},
|
|
233
|
+
"./os/audit": {
|
|
234
|
+
"types": "./dist/os/audit/index.d.ts",
|
|
235
|
+
"default": "./dist/os/audit/index.js"
|
|
236
|
+
},
|
|
237
|
+
"./os/audit-module": {
|
|
238
|
+
"types": "./dist/os/audit/audit.module.d.ts",
|
|
239
|
+
"default": "./dist/os/audit/audit.module.js"
|
|
240
|
+
},
|
|
241
|
+
"./os/session": {
|
|
242
|
+
"types": "./dist/os/session/index.d.ts",
|
|
243
|
+
"default": "./dist/os/session/index.js"
|
|
244
|
+
},
|
|
245
|
+
"./os/session-module": {
|
|
246
|
+
"types": "./dist/os/session/session.module.d.ts",
|
|
247
|
+
"default": "./dist/os/session/session.module.js"
|
|
248
|
+
},
|
|
249
|
+
"./os/mission": {
|
|
250
|
+
"types": "./dist/os/mission/index.d.ts",
|
|
251
|
+
"default": "./dist/os/mission/index.js"
|
|
252
|
+
},
|
|
253
|
+
"./os/mission-module": {
|
|
254
|
+
"types": "./dist/os/mission/mission.module.d.ts",
|
|
255
|
+
"default": "./dist/os/mission/mission.module.js"
|
|
256
|
+
}
|
|
257
|
+
}
|
|
156
258
|
}
|
|
157
|
-
}
|
|
259
|
+
}
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# Composition Workspace
|
|
2
|
+
|
|
3
|
+
This workspace contains an Editframe video composition.
|
|
4
|
+
|
|
5
|
+
## Domain terminology
|
|
6
|
+
|
|
7
|
+
- **Composition** — the artifact this workspace produces (a `.tsx` file using `@editframe/react` components).
|
|
8
|
+
- **Scene** — a structural module within a composition (a `Timegroup` block).
|
|
9
|
+
- **Director** — the operator who creates and renders the composition.
|
|
10
|
+
|
|
11
|
+
## Quality invariants
|
|
12
|
+
|
|
13
|
+
| ID | Description | Severity |
|
|
14
|
+
| --- | --- | --- |
|
|
15
|
+
| VIDEO-01 | Composition filenames must use kebab-case (lowercase letters, digits, hyphens only). | error |
|
|
16
|
+
| VIDEO-02 | Scene durations must use `contain` fit mode by default to avoid unexpected cropping. Use `cover` or `fill` only when intentionally overriding. | warning |
|
|
17
|
+
| VIDEO-03 | All speech audio elements (`Audio` with speech content) must have corresponding `Captions` components for accessibility. | error |
|
|
18
|
+
|
|
19
|
+
Additional time model invariants (VIDEO-04 through VIDEO-09) may be available. Run `forge doctor` to check the full invariant set enforced by the active profile.
|
|
20
|
+
|
|
21
|
+
## Time model concepts
|
|
22
|
+
|
|
23
|
+
Editframe compositions use a time model based on `Timegroup` components from `@editframe/react`:
|
|
24
|
+
|
|
25
|
+
- **`TimelineRoot`** — the root container for the composition.
|
|
26
|
+
- **`Timegroup`** — a container that groups scenes and controls timing. The root Timegroup defines the composition's total duration.
|
|
27
|
+
- **`mode`** — timing behavior for children: `sequence` (play one after another), `fixed` (play at absolute offset), `contain` (fit within parent duration), `fit` (scale to fit).
|
|
28
|
+
- **`duration`** — CSS time string (e.g. `5s`, `300ms`, `2.5s`) defining how long the element plays.
|
|
29
|
+
- **`offset`** — CSS time string defining when the element starts relative to its parent.
|
|
30
|
+
- **`fps`** — positive integer defining frames per second (e.g. `30`, `60`).
|
|
31
|
+
- **`loop`** — boolean, only on the root Timegroup. Nested Timegroups should not loop.
|
|
32
|
+
|
|
33
|
+
## Workflow
|
|
34
|
+
|
|
35
|
+
1. Create a `.tsx` file with `@editframe/react` components (`TimelineRoot`, `Timegroup`, `Video`, `Audio`, `Text`, `Captions`).
|
|
36
|
+
2. Run `editframe preview` to preview the composition in the browser.
|
|
37
|
+
3. Run `ef-composition-review` to review the composition for time model correctness, accessibility, and best practices.
|
|
38
|
+
4. Run `editframe check` to validate the composition structure.
|
|
39
|
+
5. Run `editframe render -o dist/<name>.mp4` to produce the final video output.
|
|
40
|
+
6. Run `ef-render-verify` to verify the render — validation, build, determinism, output inspection.
|
|
41
|
+
|
|
42
|
+
## Skills
|
|
43
|
+
|
|
44
|
+
- **ef-onboard** — onboard a new project: prerequisites, discovery, scaffold, preview. Trigger: "create a new video project".
|
|
45
|
+
- **ef-composition-review** — review a composition for time model correctness, accessibility, and best practices before rendering. Trigger: "review this composition".
|
|
46
|
+
- **ef-render-verify** — verify a render: validate, build, check determinism, inspect output. Trigger: "render and verify".
|
|
47
|
+
- **ef-composition** — guide creating a new video composition with Editframe React components. Trigger: "create a video composition".
|
|
48
|
+
- **ef-dev-server** — set up and manage the Editframe dev server for live preview. Trigger: "set up editframe dev server".
|
|
49
|
+
- **ef-editor-gui** — configure the Editframe editor GUI for visual composition editing. Trigger: "open editframe editor".
|
|
50
|
+
- **ef-webhooks** — configure Editframe webhooks for render status notifications. Trigger: "set up editframe webhooks".
|
|
51
|
+
- **ef-brand-video-generator** — generate brand video compositions from templates. Trigger: "generate a brand video".
|
|
52
|
+
- **ef-motion-design** — apply motion design patterns to compositions. Trigger: "add motion design".
|
|
53
|
+
|
|
54
|
+
## External resources
|
|
55
|
+
|
|
56
|
+
- [Editframe llms.txt](https://editframe.com/llms.txt) — machine-readable index of Editframe domain skills
|
|
57
|
+
- [Editframe composition skill](https://editframe.com/skills/composition.md) — full reference for time model, elements, and rendering
|
|
58
|
+
- [Editframe getting started](https://editframe.com/getting-started) — step-by-step guide and agent prompt
|
|
59
|
+
|
|
60
|
+
## Reference template
|
|
61
|
+
|
|
62
|
+
A sample composition template is available at `editframe-templates/composition.tsx` in the forge profiles directory. Copy it to start a new composition:
|
|
63
|
+
|
|
64
|
+
```sh
|
|
65
|
+
cp node_modules/@warpgogol/forge/profiles/editframe-templates/composition.tsx compositions/my-new-video/composition.tsx
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
## File naming
|
|
69
|
+
|
|
70
|
+
Composition files use kebab-case: `my-video.tsx`, `product-demo.tsx`, `intro-clip.tsx`.
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
/*
|
|
2
|
+
Editframe React composition template
|
|
3
|
+
Copy this file to start a new composition. @editframe/react components:
|
|
4
|
+
- TimelineRoot: root container for the composition
|
|
5
|
+
- Timegroup: groups elements into a timed sequence
|
|
6
|
+
- Video: video source with fit mode (contain, cover, fill)
|
|
7
|
+
- Audio: audio source
|
|
8
|
+
- Text: text overlay with positioning
|
|
9
|
+
- Captions: accessibility captions for speech audio
|
|
10
|
+
Run `editframe preview` to preview, `editframe render` to produce output.
|
|
11
|
+
*/
|
|
12
|
+
import { TimelineRoot, Timegroup, Video, Text, Audio, Captions } from "@editframe/react";
|
|
13
|
+
|
|
14
|
+
export default function Composition() {
|
|
15
|
+
return (
|
|
16
|
+
<TimelineRoot>
|
|
17
|
+
<Timegroup duration="10s">
|
|
18
|
+
<Video src="assets/background.mp4" fit="contain" duration="10s" />
|
|
19
|
+
<Text
|
|
20
|
+
text="Your text here"
|
|
21
|
+
x="50%"
|
|
22
|
+
y="50%"
|
|
23
|
+
fontSize="48px"
|
|
24
|
+
color="white"
|
|
25
|
+
textAlign="center"
|
|
26
|
+
duration="5s"
|
|
27
|
+
/>
|
|
28
|
+
<Audio src="assets/narration.mp3" />
|
|
29
|
+
<Captions src="assets/captions.vtt" />
|
|
30
|
+
</Timegroup>
|
|
31
|
+
</TimelineRoot>
|
|
32
|
+
);
|
|
33
|
+
}
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
# Composition Workspace
|
|
1
|
+
# HTML Composition Workspace
|
|
2
2
|
|
|
3
|
-
This workspace contains an Editframe video composition.
|
|
3
|
+
This workspace contains an Editframe video composition using HTML web components.
|
|
4
4
|
|
|
5
5
|
## Domain terminology
|
|
6
6
|
|
|
7
|
-
- **Composition** — the artifact this workspace produces (an
|
|
7
|
+
- **Composition** — the artifact this workspace produces (an `.html` file using Editframe web components).
|
|
8
8
|
- **Scene** — a structural module within a composition (an `ef-timegroup` block).
|
|
9
9
|
- **Director** — the operator who creates and renders the composition.
|
|
10
10
|
|
|
@@ -14,24 +14,25 @@ This workspace contains an Editframe video composition.
|
|
|
14
14
|
| --- | --- | --- |
|
|
15
15
|
| VIDEO-01 | Composition filenames must use kebab-case (lowercase letters, digits, hyphens only). | error |
|
|
16
16
|
| VIDEO-02 | Scene durations must use `contain` fit mode by default to avoid unexpected cropping. Use `cover` or `fill` only when intentionally overriding. | warning |
|
|
17
|
-
| VIDEO-03 | All speech audio elements (`ef-audio` with speech content) must have corresponding `ef-captions`
|
|
17
|
+
| VIDEO-03 | All speech audio elements (`ef-audio` with speech content) must have corresponding `ef-captions` components for accessibility. | error |
|
|
18
18
|
|
|
19
19
|
Additional time model invariants (VIDEO-04 through VIDEO-09) may be available. Run `forge doctor` to check the full invariant set enforced by the active profile.
|
|
20
20
|
|
|
21
21
|
## Time model concepts
|
|
22
22
|
|
|
23
|
-
Editframe compositions use a time model based on
|
|
23
|
+
Editframe HTML compositions use a time model based on web components:
|
|
24
24
|
|
|
25
|
-
- **`ef-
|
|
25
|
+
- **`ef-timeline`** — the root container for the composition.
|
|
26
|
+
- **`ef-timegroup`** — a container that groups scenes and controls timing. The root ef-timegroup defines the composition's total duration.
|
|
26
27
|
- **`mode`** — timing behavior for children: `sequence` (play one after another), `fixed` (play at absolute offset), `contain` (fit within parent duration), `fit` (scale to fit).
|
|
27
28
|
- **`duration`** — CSS time string (e.g. `5s`, `300ms`, `2.5s`) defining how long the element plays.
|
|
28
29
|
- **`offset`** — CSS time string defining when the element starts relative to its parent.
|
|
29
30
|
- **`fps`** — positive integer defining frames per second (e.g. `30`, `60`).
|
|
30
|
-
- **`loop`** — boolean, only on the root timegroup. Nested timegroups should not loop.
|
|
31
|
+
- **`loop`** — boolean, only on the root ef-timegroup. Nested ef-timegroups should not loop.
|
|
31
32
|
|
|
32
33
|
## Workflow
|
|
33
34
|
|
|
34
|
-
1. Create
|
|
35
|
+
1. Create an `.html` file with Editframe web components (`ef-timeline`, `ef-timegroup`, `ef-video`, `ef-audio`, `ef-text`, `ef-captions`).
|
|
35
36
|
2. Run `editframe preview` to preview the composition in the browser.
|
|
36
37
|
3. Run `ef-composition-review` to review the composition for time model correctness, accessibility, and best practices.
|
|
37
38
|
4. Run `editframe check` to validate the composition structure.
|
|
@@ -43,6 +44,12 @@ Editframe compositions use a time model based on `ef-timegroup` elements:
|
|
|
43
44
|
- **ef-onboard** — onboard a new project: prerequisites, discovery, scaffold, preview. Trigger: "create a new video project".
|
|
44
45
|
- **ef-composition-review** — review a composition for time model correctness, accessibility, and best practices before rendering. Trigger: "review this composition".
|
|
45
46
|
- **ef-render-verify** — verify a render: validate, build, check determinism, inspect output. Trigger: "render and verify".
|
|
47
|
+
- **ef-composition** — guide creating a new video composition with Editframe HTML components. Trigger: "create a video composition".
|
|
48
|
+
- **ef-dev-server** — set up and manage the Editframe dev server for live preview. Trigger: "set up editframe dev server".
|
|
49
|
+
- **ef-editor-gui** — configure the Editframe editor GUI for visual composition editing. Trigger: "open editframe editor".
|
|
50
|
+
- **ef-webhooks** — configure Editframe webhooks for render status notifications. Trigger: "set up editframe webhooks".
|
|
51
|
+
- **ef-brand-video-generator** — generate brand video compositions from templates. Trigger: "generate a brand video".
|
|
52
|
+
- **ef-motion-design** — apply motion design patterns to compositions. Trigger: "add motion design".
|
|
46
53
|
|
|
47
54
|
## External resources
|
|
48
55
|
|
|
@@ -50,14 +57,6 @@ Editframe compositions use a time model based on `ef-timegroup` elements:
|
|
|
50
57
|
- [Editframe composition skill](https://editframe.com/skills/composition.md) — full reference for time model, elements, and rendering
|
|
51
58
|
- [Editframe getting started](https://editframe.com/getting-started) — step-by-step guide and agent prompt
|
|
52
59
|
|
|
53
|
-
## Reference template
|
|
54
|
-
|
|
55
|
-
A sample composition template is available at `editframe-html-templates/composition.html` in the forge profiles directory. Copy it to start a new composition:
|
|
56
|
-
|
|
57
|
-
```sh
|
|
58
|
-
cp node_modules/@warpgogol/forge/profiles/editframe-html-templates/composition.html compositions/my-new-video/composition.html
|
|
59
|
-
```
|
|
60
|
-
|
|
61
60
|
## File naming
|
|
62
61
|
|
|
63
62
|
Composition files use kebab-case: `my-video.html`, `product-demo.html`, `intro-clip.html`.
|