screenci 0.0.69 → 0.0.71
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/README.md +45 -122
- package/dist/cli.d.ts +1 -0
- package/dist/cli.d.ts.map +1 -1
- package/dist/cli.js +68 -4
- package/dist/cli.js.map +1 -1
- package/dist/docs/manifest.d.ts +81 -50
- package/dist/docs/manifest.d.ts.map +1 -1
- package/dist/docs/manifest.js +36 -17
- package/dist/docs/manifest.js.map +1 -1
- package/dist/docs/video-sources/installation.screenci.d.ts +2 -0
- package/dist/docs/video-sources/installation.screenci.d.ts.map +1 -0
- package/dist/docs/video-sources/{installation.video.js → installation.screenci.js} +1 -1
- package/dist/docs/video-sources/installation.screenci.js.map +1 -0
- package/dist/docs/video-sources/landing.screenci.d.ts +2 -0
- package/dist/docs/video-sources/landing.screenci.d.ts.map +1 -0
- package/dist/docs/video-sources/{landing.video.js → landing.screenci.js} +1 -1
- package/dist/docs/video-sources/landing.screenci.js.map +1 -0
- package/dist/docs/video-sources/locator-highlight-animated.screenci.d.ts +2 -0
- package/dist/docs/video-sources/locator-highlight-animated.screenci.d.ts.map +1 -0
- package/dist/docs/video-sources/locator-highlight-animated.screenci.js +41 -0
- package/dist/docs/video-sources/locator-highlight-animated.screenci.js.map +1 -0
- package/dist/docs/video-sources/locator-highlight-still.screenci.d.ts +2 -0
- package/dist/docs/video-sources/locator-highlight-still.screenci.d.ts.map +1 -0
- package/dist/docs/video-sources/locator-highlight-still.screenci.js +19 -0
- package/dist/docs/video-sources/locator-highlight-still.screenci.js.map +1 -0
- package/dist/docs/video-sources/product-pitch.screenci.d.ts +2 -0
- package/dist/docs/video-sources/product-pitch.screenci.d.ts.map +1 -0
- package/dist/docs/video-sources/product-pitch.screenci.js +136 -0
- package/dist/docs/video-sources/product-pitch.screenci.js.map +1 -0
- package/dist/docs/video-sources/public-urls.screenci.d.ts +2 -0
- package/dist/docs/video-sources/public-urls.screenci.d.ts.map +1 -0
- package/dist/docs/video-sources/public-urls.screenci.js +34 -0
- package/dist/docs/video-sources/public-urls.screenci.js.map +1 -0
- package/dist/docs/video-sources/studio.screenci.d.ts +2 -0
- package/dist/docs/video-sources/studio.screenci.d.ts.map +1 -0
- package/dist/docs/video-sources/{studio.video.js → studio.screenci.js} +1 -1
- package/dist/docs/video-sources/studio.screenci.js.map +1 -0
- package/dist/docs/videos.d.ts +28 -18
- package/dist/docs/videos.d.ts.map +1 -1
- package/dist/docs/videos.js +14 -5
- package/dist/docs/videos.js.map +1 -1
- package/dist/e2e/screenshot.e2e.d.ts +2 -0
- package/dist/e2e/screenshot.e2e.d.ts.map +1 -0
- package/dist/e2e/screenshot.e2e.js +73 -0
- package/dist/e2e/screenshot.e2e.js.map +1 -0
- package/dist/index.d.ts +7 -3
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +3 -1
- package/dist/index.js.map +1 -1
- package/dist/src/asset.d.ts +119 -15
- package/dist/src/asset.d.ts.map +1 -1
- package/dist/src/asset.js +310 -124
- package/dist/src/asset.js.map +1 -1
- package/dist/src/audio.d.ts +14 -0
- package/dist/src/audio.d.ts.map +1 -1
- package/dist/src/audio.js +4 -1
- package/dist/src/audio.js.map +1 -1
- package/dist/src/config.d.ts.map +1 -1
- package/dist/src/config.js +9 -3
- package/dist/src/config.js.map +1 -1
- package/dist/src/contextOptions.d.ts +48 -0
- package/dist/src/contextOptions.d.ts.map +1 -0
- package/dist/src/contextOptions.js +71 -0
- package/dist/src/contextOptions.js.map +1 -0
- package/dist/src/crop.d.ts +93 -0
- package/dist/src/crop.d.ts.map +1 -0
- package/dist/src/crop.js +133 -0
- package/dist/src/crop.js.map +1 -0
- package/dist/src/cue.d.ts +17 -4
- package/dist/src/cue.d.ts.map +1 -1
- package/dist/src/cue.js +31 -3
- package/dist/src/cue.js.map +1 -1
- package/dist/src/defaults.d.ts +6 -0
- package/dist/src/defaults.d.ts.map +1 -1
- package/dist/src/defaults.js +6 -0
- package/dist/src/defaults.js.map +1 -1
- package/dist/src/dimensions.d.ts +6 -0
- package/dist/src/dimensions.d.ts.map +1 -1
- package/dist/src/dimensions.js +15 -0
- package/dist/src/dimensions.js.map +1 -1
- package/dist/src/events.d.ts +152 -10
- package/dist/src/events.d.ts.map +1 -1
- package/dist/src/events.js +61 -3
- package/dist/src/events.js.map +1 -1
- package/dist/src/htmlRasterizer.d.ts +43 -0
- package/dist/src/htmlRasterizer.d.ts.map +1 -1
- package/dist/src/htmlRasterizer.js +32 -10
- package/dist/src/htmlRasterizer.js.map +1 -1
- package/dist/src/init.d.ts.map +1 -1
- package/dist/src/init.js +19 -8
- package/dist/src/init.js.map +1 -1
- package/dist/src/overlayFlush.d.ts +18 -0
- package/dist/src/overlayFlush.d.ts.map +1 -0
- package/dist/src/overlayFlush.js +56 -0
- package/dist/src/overlayFlush.js.map +1 -0
- package/dist/src/overlayRect.d.ts +69 -0
- package/dist/src/overlayRect.d.ts.map +1 -0
- package/dist/src/overlayRect.js +55 -0
- package/dist/src/overlayRect.js.map +1 -0
- package/dist/src/recording.d.ts +3 -2
- package/dist/src/recording.d.ts.map +1 -1
- package/dist/src/recordingData.d.ts +20 -0
- package/dist/src/recordingData.d.ts.map +1 -1
- package/dist/src/runtimeContext.d.ts +19 -1
- package/dist/src/runtimeContext.d.ts.map +1 -1
- package/dist/src/runtimeContext.js +15 -0
- package/dist/src/runtimeContext.js.map +1 -1
- package/dist/src/screenshot.d.ts +105 -0
- package/dist/src/screenshot.d.ts.map +1 -0
- package/dist/src/screenshot.js +188 -0
- package/dist/src/screenshot.js.map +1 -0
- package/dist/src/stillCapture.d.ts +68 -0
- package/dist/src/stillCapture.d.ts.map +1 -0
- package/dist/src/stillCapture.js +119 -0
- package/dist/src/stillCapture.js.map +1 -0
- package/dist/src/studio.d.ts +8 -11
- package/dist/src/studio.d.ts.map +1 -1
- package/dist/src/studio.js +2 -25
- package/dist/src/studio.js.map +1 -1
- package/dist/src/types.d.ts +100 -8
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/types.js.map +1 -1
- package/dist/src/video.d.ts +20 -0
- package/dist/src/video.d.ts.map +1 -1
- package/dist/src/video.js +71 -24
- package/dist/src/video.js.map +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +1 -1
- package/skills/screenci/SKILL.md +10 -10
- package/skills/screenci/references/init.md +1 -1
- package/skills/screenci/references/record.md +2 -2
- package/dist/docs/video-sources/cli.video.d.ts +0 -2
- package/dist/docs/video-sources/cli.video.d.ts.map +0 -1
- package/dist/docs/video-sources/cli.video.js +0 -36
- package/dist/docs/video-sources/cli.video.js.map +0 -1
- package/dist/docs/video-sources/installation.video.d.ts +0 -2
- package/dist/docs/video-sources/installation.video.d.ts.map +0 -1
- package/dist/docs/video-sources/installation.video.js.map +0 -1
- package/dist/docs/video-sources/landing.video.d.ts +0 -2
- package/dist/docs/video-sources/landing.video.d.ts.map +0 -1
- package/dist/docs/video-sources/landing.video.js.map +0 -1
- package/dist/docs/video-sources/studio.video.d.ts +0 -2
- package/dist/docs/video-sources/studio.video.d.ts.map +0 -1
- package/dist/docs/video-sources/studio.video.js.map +0 -1
package/dist/docs/manifest.d.ts
CHANGED
|
@@ -21,26 +21,26 @@ export declare const docsManifest: readonly [{
|
|
|
21
21
|
readonly title: "Agent Integration";
|
|
22
22
|
readonly description: "The recommended path: point a coding agent at the integration brief so it scaffolds ScreenCI, authors a video for your flow, and records it.";
|
|
23
23
|
readonly prev: "docs";
|
|
24
|
-
readonly next: "docs/
|
|
24
|
+
readonly next: "docs/manual-setup";
|
|
25
25
|
}, {
|
|
26
|
-
readonly source: "
|
|
27
|
-
readonly slug: "docs/
|
|
26
|
+
readonly source: "manual-setup.mdx";
|
|
27
|
+
readonly slug: "docs/manual-setup";
|
|
28
28
|
readonly section: "Getting Started";
|
|
29
29
|
readonly order: 3;
|
|
30
30
|
readonly navLabel: "Manual setup & first video";
|
|
31
31
|
readonly title: "Manual Setup & First Video";
|
|
32
32
|
readonly description: "Wire ScreenCI up by hand: initialize a project, run the starter video locally, and record your first final video.";
|
|
33
33
|
readonly prev: "docs/agent-integration";
|
|
34
|
-
readonly next: "docs/
|
|
34
|
+
readonly next: "docs/video-script-basics";
|
|
35
35
|
}, {
|
|
36
|
-
readonly source: "
|
|
37
|
-
readonly slug: "docs/
|
|
36
|
+
readonly source: "video-script-basics.md";
|
|
37
|
+
readonly slug: "docs/video-script-basics";
|
|
38
38
|
readonly section: "Getting Started";
|
|
39
39
|
readonly order: 4;
|
|
40
40
|
readonly navLabel: "Video script basics";
|
|
41
41
|
readonly title: "Video Script Basics";
|
|
42
|
-
readonly description: "Author .
|
|
43
|
-
readonly prev: "docs/
|
|
42
|
+
readonly description: "Author .screenci.ts files with Playwright-like APIs, ScreenCI narration and camera helpers, and workflow-aware pacing.";
|
|
43
|
+
readonly prev: "docs/manual-setup";
|
|
44
44
|
readonly next: "docs/ci-setup";
|
|
45
45
|
}, {
|
|
46
46
|
readonly source: "ci-setup.md";
|
|
@@ -50,7 +50,7 @@ export declare const docsManifest: readonly [{
|
|
|
50
50
|
readonly navLabel: "CI setup";
|
|
51
51
|
readonly title: "CI Setup";
|
|
52
52
|
readonly description: "Understand the generated GitHub Actions workflow, required secrets, and how to keep CI recordings deterministic.";
|
|
53
|
-
readonly prev: "docs/
|
|
53
|
+
readonly prev: "docs/video-script-basics";
|
|
54
54
|
readonly next: "docs/guides/page-instrumentation";
|
|
55
55
|
}, {
|
|
56
56
|
readonly source: "page-instrumentation.md";
|
|
@@ -81,32 +81,42 @@ export declare const docsManifest: readonly [{
|
|
|
81
81
|
readonly title: "Camera and Zooming";
|
|
82
82
|
readonly description: "Choose between autoZoom and manual framing, and use camera direction to guide attention without making the video frantic.";
|
|
83
83
|
readonly prev: "docs/guides/narration-and-localization";
|
|
84
|
-
readonly next: "docs/guides/
|
|
84
|
+
readonly next: "docs/guides/overlays";
|
|
85
85
|
}, {
|
|
86
|
-
readonly source: "
|
|
87
|
-
readonly slug: "docs/guides/
|
|
86
|
+
readonly source: "overlays.md";
|
|
87
|
+
readonly slug: "docs/guides/overlays";
|
|
88
88
|
readonly section: "Guides";
|
|
89
89
|
readonly order: 4;
|
|
90
90
|
readonly navLabel: "Overlays";
|
|
91
91
|
readonly title: "Overlays";
|
|
92
92
|
readonly description: "Add intro clips, corner logos, transitions, and timed overlays to ScreenCI recordings from files, HTML, or React.";
|
|
93
93
|
readonly prev: "docs/guides/camera-and-zooming";
|
|
94
|
+
readonly next: "docs/guides/screenshots";
|
|
95
|
+
}, {
|
|
96
|
+
readonly source: "screenshots.md";
|
|
97
|
+
readonly slug: "docs/guides/screenshots";
|
|
98
|
+
readonly section: "Guides";
|
|
99
|
+
readonly order: 5;
|
|
100
|
+
readonly navLabel: "Screenshots";
|
|
101
|
+
readonly title: "Screenshots";
|
|
102
|
+
readonly description: "Capture branded still screenshots with the screenshot() fixture: crop to a component, set quality and dark mode, and frame the shot on a background with overlays.";
|
|
103
|
+
readonly prev: "docs/guides/overlays";
|
|
94
104
|
readonly next: "docs/guides/studio";
|
|
95
105
|
}, {
|
|
96
106
|
readonly source: "studio.md";
|
|
97
107
|
readonly slug: "docs/guides/studio";
|
|
98
108
|
readonly section: "Guides";
|
|
99
|
-
readonly order:
|
|
109
|
+
readonly order: 6;
|
|
100
110
|
readonly navLabel: "Studio";
|
|
101
111
|
readonly title: "Studio";
|
|
102
112
|
readonly description: "Remix render options, narration text, voices, and overlays from the web app, or manage them entirely in Studio with createStudioNarration and createStudioOverlays. Business tier.";
|
|
103
|
-
readonly prev: "docs/guides/
|
|
113
|
+
readonly prev: "docs/guides/screenshots";
|
|
104
114
|
readonly next: "docs/guides/public-urls-and-embeds";
|
|
105
115
|
}, {
|
|
106
116
|
readonly source: "public-urls-and-embeds.md";
|
|
107
117
|
readonly slug: "docs/guides/public-urls-and-embeds";
|
|
108
118
|
readonly section: "Guides";
|
|
109
|
-
readonly order:
|
|
119
|
+
readonly order: 7;
|
|
110
120
|
readonly navLabel: "Public URLs and embeds";
|
|
111
121
|
readonly title: "Public URLs and Embeds";
|
|
112
122
|
readonly description: "Enable public delivery for a video, understand stable language-specific URLs, and embed ScreenCI outputs in other sites.";
|
|
@@ -116,7 +126,7 @@ export declare const docsManifest: readonly [{
|
|
|
116
126
|
readonly source: "update-screenci.mdx";
|
|
117
127
|
readonly slug: "docs/guides/update-screenci";
|
|
118
128
|
readonly section: "Guides";
|
|
119
|
-
readonly order:
|
|
129
|
+
readonly order: 8;
|
|
120
130
|
readonly navLabel: "Update ScreenCI";
|
|
121
131
|
readonly title: "Update ScreenCI";
|
|
122
132
|
readonly description: "Upgrade the screenci package, refresh Playwright when needed, and verify that existing videos still behave as expected.";
|
|
@@ -173,26 +183,26 @@ export declare function getDocBySlug(slug: string): {
|
|
|
173
183
|
readonly title: "Agent Integration";
|
|
174
184
|
readonly description: "The recommended path: point a coding agent at the integration brief so it scaffolds ScreenCI, authors a video for your flow, and records it.";
|
|
175
185
|
readonly prev: "docs";
|
|
176
|
-
readonly next: "docs/
|
|
186
|
+
readonly next: "docs/manual-setup";
|
|
177
187
|
} | {
|
|
178
|
-
readonly source: "
|
|
179
|
-
readonly slug: "docs/
|
|
188
|
+
readonly source: "manual-setup.mdx";
|
|
189
|
+
readonly slug: "docs/manual-setup";
|
|
180
190
|
readonly section: "Getting Started";
|
|
181
191
|
readonly order: 3;
|
|
182
192
|
readonly navLabel: "Manual setup & first video";
|
|
183
193
|
readonly title: "Manual Setup & First Video";
|
|
184
194
|
readonly description: "Wire ScreenCI up by hand: initialize a project, run the starter video locally, and record your first final video.";
|
|
185
195
|
readonly prev: "docs/agent-integration";
|
|
186
|
-
readonly next: "docs/
|
|
196
|
+
readonly next: "docs/video-script-basics";
|
|
187
197
|
} | {
|
|
188
|
-
readonly source: "
|
|
189
|
-
readonly slug: "docs/
|
|
198
|
+
readonly source: "video-script-basics.md";
|
|
199
|
+
readonly slug: "docs/video-script-basics";
|
|
190
200
|
readonly section: "Getting Started";
|
|
191
201
|
readonly order: 4;
|
|
192
202
|
readonly navLabel: "Video script basics";
|
|
193
203
|
readonly title: "Video Script Basics";
|
|
194
|
-
readonly description: "Author .
|
|
195
|
-
readonly prev: "docs/
|
|
204
|
+
readonly description: "Author .screenci.ts files with Playwright-like APIs, ScreenCI narration and camera helpers, and workflow-aware pacing.";
|
|
205
|
+
readonly prev: "docs/manual-setup";
|
|
196
206
|
readonly next: "docs/ci-setup";
|
|
197
207
|
} | {
|
|
198
208
|
readonly source: "ci-setup.md";
|
|
@@ -202,7 +212,7 @@ export declare function getDocBySlug(slug: string): {
|
|
|
202
212
|
readonly navLabel: "CI setup";
|
|
203
213
|
readonly title: "CI Setup";
|
|
204
214
|
readonly description: "Understand the generated GitHub Actions workflow, required secrets, and how to keep CI recordings deterministic.";
|
|
205
|
-
readonly prev: "docs/
|
|
215
|
+
readonly prev: "docs/video-script-basics";
|
|
206
216
|
readonly next: "docs/guides/page-instrumentation";
|
|
207
217
|
} | {
|
|
208
218
|
readonly source: "page-instrumentation.md";
|
|
@@ -233,32 +243,42 @@ export declare function getDocBySlug(slug: string): {
|
|
|
233
243
|
readonly title: "Camera and Zooming";
|
|
234
244
|
readonly description: "Choose between autoZoom and manual framing, and use camera direction to guide attention without making the video frantic.";
|
|
235
245
|
readonly prev: "docs/guides/narration-and-localization";
|
|
236
|
-
readonly next: "docs/guides/
|
|
246
|
+
readonly next: "docs/guides/overlays";
|
|
237
247
|
} | {
|
|
238
|
-
readonly source: "
|
|
239
|
-
readonly slug: "docs/guides/
|
|
248
|
+
readonly source: "overlays.md";
|
|
249
|
+
readonly slug: "docs/guides/overlays";
|
|
240
250
|
readonly section: "Guides";
|
|
241
251
|
readonly order: 4;
|
|
242
252
|
readonly navLabel: "Overlays";
|
|
243
253
|
readonly title: "Overlays";
|
|
244
254
|
readonly description: "Add intro clips, corner logos, transitions, and timed overlays to ScreenCI recordings from files, HTML, or React.";
|
|
245
255
|
readonly prev: "docs/guides/camera-and-zooming";
|
|
256
|
+
readonly next: "docs/guides/screenshots";
|
|
257
|
+
} | {
|
|
258
|
+
readonly source: "screenshots.md";
|
|
259
|
+
readonly slug: "docs/guides/screenshots";
|
|
260
|
+
readonly section: "Guides";
|
|
261
|
+
readonly order: 5;
|
|
262
|
+
readonly navLabel: "Screenshots";
|
|
263
|
+
readonly title: "Screenshots";
|
|
264
|
+
readonly description: "Capture branded still screenshots with the screenshot() fixture: crop to a component, set quality and dark mode, and frame the shot on a background with overlays.";
|
|
265
|
+
readonly prev: "docs/guides/overlays";
|
|
246
266
|
readonly next: "docs/guides/studio";
|
|
247
267
|
} | {
|
|
248
268
|
readonly source: "studio.md";
|
|
249
269
|
readonly slug: "docs/guides/studio";
|
|
250
270
|
readonly section: "Guides";
|
|
251
|
-
readonly order:
|
|
271
|
+
readonly order: 6;
|
|
252
272
|
readonly navLabel: "Studio";
|
|
253
273
|
readonly title: "Studio";
|
|
254
274
|
readonly description: "Remix render options, narration text, voices, and overlays from the web app, or manage them entirely in Studio with createStudioNarration and createStudioOverlays. Business tier.";
|
|
255
|
-
readonly prev: "docs/guides/
|
|
275
|
+
readonly prev: "docs/guides/screenshots";
|
|
256
276
|
readonly next: "docs/guides/public-urls-and-embeds";
|
|
257
277
|
} | {
|
|
258
278
|
readonly source: "public-urls-and-embeds.md";
|
|
259
279
|
readonly slug: "docs/guides/public-urls-and-embeds";
|
|
260
280
|
readonly section: "Guides";
|
|
261
|
-
readonly order:
|
|
281
|
+
readonly order: 7;
|
|
262
282
|
readonly navLabel: "Public URLs and embeds";
|
|
263
283
|
readonly title: "Public URLs and Embeds";
|
|
264
284
|
readonly description: "Enable public delivery for a video, understand stable language-specific URLs, and embed ScreenCI outputs in other sites.";
|
|
@@ -268,7 +288,7 @@ export declare function getDocBySlug(slug: string): {
|
|
|
268
288
|
readonly source: "update-screenci.mdx";
|
|
269
289
|
readonly slug: "docs/guides/update-screenci";
|
|
270
290
|
readonly section: "Guides";
|
|
271
|
-
readonly order:
|
|
291
|
+
readonly order: 8;
|
|
272
292
|
readonly navLabel: "Update ScreenCI";
|
|
273
293
|
readonly title: "Update ScreenCI";
|
|
274
294
|
readonly description: "Upgrade the screenci package, refresh Playwright when needed, and verify that existing videos still behave as expected.";
|
|
@@ -327,28 +347,28 @@ export declare function getGeneratedDocsManifest(): ({
|
|
|
327
347
|
title: "Agent Integration";
|
|
328
348
|
description: "The recommended path: point a coding agent at the integration brief so it scaffolds ScreenCI, authors a video for your flow, and records it.";
|
|
329
349
|
prev: "docs";
|
|
330
|
-
next: "docs/
|
|
350
|
+
next: "docs/manual-setup";
|
|
331
351
|
} | {
|
|
332
352
|
outputPath: string;
|
|
333
|
-
source: "
|
|
334
|
-
slug: "docs/
|
|
353
|
+
source: "manual-setup.mdx";
|
|
354
|
+
slug: "docs/manual-setup";
|
|
335
355
|
section: "Getting Started";
|
|
336
356
|
order: 3;
|
|
337
357
|
navLabel: "Manual setup & first video";
|
|
338
358
|
title: "Manual Setup & First Video";
|
|
339
359
|
description: "Wire ScreenCI up by hand: initialize a project, run the starter video locally, and record your first final video.";
|
|
340
360
|
prev: "docs/agent-integration";
|
|
341
|
-
next: "docs/
|
|
361
|
+
next: "docs/video-script-basics";
|
|
342
362
|
} | {
|
|
343
363
|
outputPath: string;
|
|
344
|
-
source: "
|
|
345
|
-
slug: "docs/
|
|
364
|
+
source: "video-script-basics.md";
|
|
365
|
+
slug: "docs/video-script-basics";
|
|
346
366
|
section: "Getting Started";
|
|
347
367
|
order: 4;
|
|
348
368
|
navLabel: "Video script basics";
|
|
349
369
|
title: "Video Script Basics";
|
|
350
|
-
description: "Author .
|
|
351
|
-
prev: "docs/
|
|
370
|
+
description: "Author .screenci.ts files with Playwright-like APIs, ScreenCI narration and camera helpers, and workflow-aware pacing.";
|
|
371
|
+
prev: "docs/manual-setup";
|
|
352
372
|
next: "docs/ci-setup";
|
|
353
373
|
} | {
|
|
354
374
|
outputPath: string;
|
|
@@ -359,7 +379,7 @@ export declare function getGeneratedDocsManifest(): ({
|
|
|
359
379
|
navLabel: "CI setup";
|
|
360
380
|
title: "CI Setup";
|
|
361
381
|
description: "Understand the generated GitHub Actions workflow, required secrets, and how to keep CI recordings deterministic.";
|
|
362
|
-
prev: "docs/
|
|
382
|
+
prev: "docs/video-script-basics";
|
|
363
383
|
next: "docs/guides/page-instrumentation";
|
|
364
384
|
} | {
|
|
365
385
|
outputPath: string;
|
|
@@ -393,35 +413,46 @@ export declare function getGeneratedDocsManifest(): ({
|
|
|
393
413
|
title: "Camera and Zooming";
|
|
394
414
|
description: "Choose between autoZoom and manual framing, and use camera direction to guide attention without making the video frantic.";
|
|
395
415
|
prev: "docs/guides/narration-and-localization";
|
|
396
|
-
next: "docs/guides/
|
|
416
|
+
next: "docs/guides/overlays";
|
|
397
417
|
} | {
|
|
398
418
|
outputPath: string;
|
|
399
|
-
source: "
|
|
400
|
-
slug: "docs/guides/
|
|
419
|
+
source: "overlays.md";
|
|
420
|
+
slug: "docs/guides/overlays";
|
|
401
421
|
section: "Guides";
|
|
402
422
|
order: 4;
|
|
403
423
|
navLabel: "Overlays";
|
|
404
424
|
title: "Overlays";
|
|
405
425
|
description: "Add intro clips, corner logos, transitions, and timed overlays to ScreenCI recordings from files, HTML, or React.";
|
|
406
426
|
prev: "docs/guides/camera-and-zooming";
|
|
427
|
+
next: "docs/guides/screenshots";
|
|
428
|
+
} | {
|
|
429
|
+
outputPath: string;
|
|
430
|
+
source: "screenshots.md";
|
|
431
|
+
slug: "docs/guides/screenshots";
|
|
432
|
+
section: "Guides";
|
|
433
|
+
order: 5;
|
|
434
|
+
navLabel: "Screenshots";
|
|
435
|
+
title: "Screenshots";
|
|
436
|
+
description: "Capture branded still screenshots with the screenshot() fixture: crop to a component, set quality and dark mode, and frame the shot on a background with overlays.";
|
|
437
|
+
prev: "docs/guides/overlays";
|
|
407
438
|
next: "docs/guides/studio";
|
|
408
439
|
} | {
|
|
409
440
|
outputPath: string;
|
|
410
441
|
source: "studio.md";
|
|
411
442
|
slug: "docs/guides/studio";
|
|
412
443
|
section: "Guides";
|
|
413
|
-
order:
|
|
444
|
+
order: 6;
|
|
414
445
|
navLabel: "Studio";
|
|
415
446
|
title: "Studio";
|
|
416
447
|
description: "Remix render options, narration text, voices, and overlays from the web app, or manage them entirely in Studio with createStudioNarration and createStudioOverlays. Business tier.";
|
|
417
|
-
prev: "docs/guides/
|
|
448
|
+
prev: "docs/guides/screenshots";
|
|
418
449
|
next: "docs/guides/public-urls-and-embeds";
|
|
419
450
|
} | {
|
|
420
451
|
outputPath: string;
|
|
421
452
|
source: "public-urls-and-embeds.md";
|
|
422
453
|
slug: "docs/guides/public-urls-and-embeds";
|
|
423
454
|
section: "Guides";
|
|
424
|
-
order:
|
|
455
|
+
order: 7;
|
|
425
456
|
navLabel: "Public URLs and embeds";
|
|
426
457
|
title: "Public URLs and Embeds";
|
|
427
458
|
description: "Enable public delivery for a video, understand stable language-specific URLs, and embed ScreenCI outputs in other sites.";
|
|
@@ -432,7 +463,7 @@ export declare function getGeneratedDocsManifest(): ({
|
|
|
432
463
|
source: "update-screenci.mdx";
|
|
433
464
|
slug: "docs/guides/update-screenci";
|
|
434
465
|
section: "Guides";
|
|
435
|
-
order:
|
|
466
|
+
order: 8;
|
|
436
467
|
navLabel: "Update ScreenCI";
|
|
437
468
|
title: "Update ScreenCI";
|
|
438
469
|
description: "Upgrade the screenci package, refresh Playwright when needed, and verify that existing videos still behave as expected.";
|
|
@@ -484,8 +515,8 @@ export declare function getDocsSidebarConfig(typedocSidebarGroup?: TypedocSideba
|
|
|
484
515
|
translations: {};
|
|
485
516
|
collapsed: boolean;
|
|
486
517
|
items: ({
|
|
487
|
-
label: "Overview" | "Agent integration" | "Manual setup & first video" | "Video script basics" | "CI setup" | "Page instrumentation" | "Narration and localization" | "Camera and zooming" | "Overlays" | "Studio" | "Public URLs and embeds" | "Update ScreenCI" | "CLI" | "Configuration" | "Public delivery API";
|
|
488
|
-
slug: "docs" | "docs/
|
|
518
|
+
label: "Overview" | "Agent integration" | "Manual setup & first video" | "Video script basics" | "CI setup" | "Page instrumentation" | "Narration and localization" | "Camera and zooming" | "Overlays" | "Screenshots" | "Studio" | "Public URLs and embeds" | "Update ScreenCI" | "CLI" | "Configuration" | "Public delivery API";
|
|
519
|
+
slug: "docs/manual-setup" | "docs/guides/overlays" | "docs/guides/screenshots" | "docs" | "docs/agent-integration" | "docs/video-script-basics" | "docs/ci-setup" | "docs/guides/page-instrumentation" | "docs/guides/narration-and-localization" | "docs/guides/camera-and-zooming" | "docs/guides/studio" | "docs/guides/public-urls-and-embeds" | "docs/guides/update-screenci" | "docs/reference/cli" | "docs/reference/configuration" | "docs/reference/public-delivery-api";
|
|
489
520
|
translations: {};
|
|
490
521
|
attrs: {};
|
|
491
522
|
} | TypedocSidebarItem)[];
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"manifest.d.ts","sourceRoot":"","sources":["../../docs/manifest.ts"],"names":[],"mappings":"AAAA;;;GAGG;
|
|
1
|
+
{"version":3,"file":"manifest.d.ts","sourceRoot":"","sources":["../../docs/manifest.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAiMf,CAAA;AAEV,eAAO,MAAM,YAAY,qDAAsD,CAAA;AAE/E,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAExC;AAED,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,UAejD;AAED,wBAAgB,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAKvC;AAYD,KAAK,kBAAkB,GAAG;IACxB,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,OAAO,EAAE,CAAA;IACjB,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACrC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAChC,CAAA;AAED,wBAAgB,oBAAoB,CAClC,mBAAmB,CAAC,EAAE,kBAAkB,GAAG,IAAI;;;;;;;;;;IAmBhD;AAED,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;;;EAkBxD"}
|
package/dist/docs/manifest.js
CHANGED
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
* Source of truth for ScreenCI docs information architecture.
|
|
3
3
|
* Slugs are web-facing and stable even if source filenames change.
|
|
4
4
|
*/
|
|
5
|
+
import { getDocVideo, hasPublicId } from './videos';
|
|
5
6
|
export const docsManifest = [
|
|
6
7
|
{
|
|
7
8
|
source: 'overview.mdx',
|
|
@@ -23,28 +24,28 @@ export const docsManifest = [
|
|
|
23
24
|
title: 'Agent Integration',
|
|
24
25
|
description: 'The recommended path: point a coding agent at the integration brief so it scaffolds ScreenCI, authors a video for your flow, and records it.',
|
|
25
26
|
prev: 'docs',
|
|
26
|
-
next: 'docs/
|
|
27
|
+
next: 'docs/manual-setup',
|
|
27
28
|
},
|
|
28
29
|
{
|
|
29
|
-
source: '
|
|
30
|
-
slug: 'docs/
|
|
30
|
+
source: 'manual-setup.mdx',
|
|
31
|
+
slug: 'docs/manual-setup',
|
|
31
32
|
section: 'Getting Started',
|
|
32
33
|
order: 3,
|
|
33
34
|
navLabel: 'Manual setup & first video',
|
|
34
35
|
title: 'Manual Setup & First Video',
|
|
35
36
|
description: 'Wire ScreenCI up by hand: initialize a project, run the starter video locally, and record your first final video.',
|
|
36
37
|
prev: 'docs/agent-integration',
|
|
37
|
-
next: 'docs/
|
|
38
|
+
next: 'docs/video-script-basics',
|
|
38
39
|
},
|
|
39
40
|
{
|
|
40
|
-
source: '
|
|
41
|
-
slug: 'docs/
|
|
41
|
+
source: 'video-script-basics.md',
|
|
42
|
+
slug: 'docs/video-script-basics',
|
|
42
43
|
section: 'Getting Started',
|
|
43
44
|
order: 4,
|
|
44
45
|
navLabel: 'Video script basics',
|
|
45
46
|
title: 'Video Script Basics',
|
|
46
|
-
description: 'Author .
|
|
47
|
-
prev: 'docs/
|
|
47
|
+
description: 'Author .screenci.ts files with Playwright-like APIs, ScreenCI narration and camera helpers, and workflow-aware pacing.',
|
|
48
|
+
prev: 'docs/manual-setup',
|
|
48
49
|
next: 'docs/ci-setup',
|
|
49
50
|
},
|
|
50
51
|
{
|
|
@@ -55,7 +56,7 @@ export const docsManifest = [
|
|
|
55
56
|
navLabel: 'CI setup',
|
|
56
57
|
title: 'CI Setup',
|
|
57
58
|
description: 'Understand the generated GitHub Actions workflow, required secrets, and how to keep CI recordings deterministic.',
|
|
58
|
-
prev: 'docs/
|
|
59
|
+
prev: 'docs/video-script-basics',
|
|
59
60
|
next: 'docs/guides/page-instrumentation',
|
|
60
61
|
},
|
|
61
62
|
{
|
|
@@ -89,35 +90,46 @@ export const docsManifest = [
|
|
|
89
90
|
title: 'Camera and Zooming',
|
|
90
91
|
description: 'Choose between autoZoom and manual framing, and use camera direction to guide attention without making the video frantic.',
|
|
91
92
|
prev: 'docs/guides/narration-and-localization',
|
|
92
|
-
next: 'docs/guides/
|
|
93
|
+
next: 'docs/guides/overlays',
|
|
93
94
|
},
|
|
94
95
|
{
|
|
95
|
-
source: '
|
|
96
|
-
slug: 'docs/guides/
|
|
96
|
+
source: 'overlays.md',
|
|
97
|
+
slug: 'docs/guides/overlays',
|
|
97
98
|
section: 'Guides',
|
|
98
99
|
order: 4,
|
|
99
100
|
navLabel: 'Overlays',
|
|
100
101
|
title: 'Overlays',
|
|
101
102
|
description: 'Add intro clips, corner logos, transitions, and timed overlays to ScreenCI recordings from files, HTML, or React.',
|
|
102
103
|
prev: 'docs/guides/camera-and-zooming',
|
|
104
|
+
next: 'docs/guides/screenshots',
|
|
105
|
+
},
|
|
106
|
+
{
|
|
107
|
+
source: 'screenshots.md',
|
|
108
|
+
slug: 'docs/guides/screenshots',
|
|
109
|
+
section: 'Guides',
|
|
110
|
+
order: 5,
|
|
111
|
+
navLabel: 'Screenshots',
|
|
112
|
+
title: 'Screenshots',
|
|
113
|
+
description: 'Capture branded still screenshots with the screenshot() fixture: crop to a component, set quality and dark mode, and frame the shot on a background with overlays.',
|
|
114
|
+
prev: 'docs/guides/overlays',
|
|
103
115
|
next: 'docs/guides/studio',
|
|
104
116
|
},
|
|
105
117
|
{
|
|
106
118
|
source: 'studio.md',
|
|
107
119
|
slug: 'docs/guides/studio',
|
|
108
120
|
section: 'Guides',
|
|
109
|
-
order:
|
|
121
|
+
order: 6,
|
|
110
122
|
navLabel: 'Studio',
|
|
111
123
|
title: 'Studio',
|
|
112
124
|
description: 'Remix render options, narration text, voices, and overlays from the web app, or manage them entirely in Studio with createStudioNarration and createStudioOverlays. Business tier.',
|
|
113
|
-
prev: 'docs/guides/
|
|
125
|
+
prev: 'docs/guides/screenshots',
|
|
114
126
|
next: 'docs/guides/public-urls-and-embeds',
|
|
115
127
|
},
|
|
116
128
|
{
|
|
117
129
|
source: 'public-urls-and-embeds.md',
|
|
118
130
|
slug: 'docs/guides/public-urls-and-embeds',
|
|
119
131
|
section: 'Guides',
|
|
120
|
-
order:
|
|
132
|
+
order: 7,
|
|
121
133
|
navLabel: 'Public URLs and embeds',
|
|
122
134
|
title: 'Public URLs and Embeds',
|
|
123
135
|
description: 'Enable public delivery for a video, understand stable language-specific URLs, and embed ScreenCI outputs in other sites.',
|
|
@@ -128,7 +140,7 @@ export const docsManifest = [
|
|
|
128
140
|
source: 'update-screenci.mdx',
|
|
129
141
|
slug: 'docs/guides/update-screenci',
|
|
130
142
|
section: 'Guides',
|
|
131
|
-
order:
|
|
143
|
+
order: 8,
|
|
132
144
|
navLabel: 'Update ScreenCI',
|
|
133
145
|
title: 'Update ScreenCI',
|
|
134
146
|
description: 'Upgrade the screenci package, refresh Playwright when needed, and verify that existing videos still behave as expected.',
|
|
@@ -175,7 +187,14 @@ export function getDocBySlug(slug) {
|
|
|
175
187
|
}
|
|
176
188
|
export function getOutputPathFromSlug(slug) {
|
|
177
189
|
const entry = getDocBySlug(slug);
|
|
178
|
-
const
|
|
190
|
+
const video = getDocVideo(slug);
|
|
191
|
+
// A page that embeds a published video or screenshot injects a React
|
|
192
|
+
// component (DocVideoPlayer / DocScreenshot). Astro only renders component
|
|
193
|
+
// imports and JSX in .mdx, so such a page must be emitted as .mdx even when
|
|
194
|
+
// its source is plain .md. Without this, the embed silently renders as inert
|
|
195
|
+
// text. Pages without a published embed stay .md (matching their source).
|
|
196
|
+
const embedsComponent = video !== null && hasPublicId(video);
|
|
197
|
+
const extension = entry?.source.endsWith('.mdx') || embedsComponent ? '.mdx' : '.md';
|
|
179
198
|
if (slug === 'docs')
|
|
180
199
|
return `index${extension}`;
|
|
181
200
|
return `${slug.replace(/^docs\//, '')}${extension}`;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"manifest.js","sourceRoot":"","sources":["../../docs/manifest.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B;QACE,MAAM,EAAE,cAAc;QACtB,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,iBAAiB;QAC1B,KAAK,EAAE,CAAC;QACR,QAAQ,EAAE,UAAU;QACpB,KAAK,EAAE,UAAU;QACjB,WAAW,EACT,uJAAuJ;QACzJ,IAAI,EAAE,IAAI;QACV,IAAI,EAAE,wBAAwB;KAC/B;IACD;QACE,MAAM,EAAE,uBAAuB;QAC/B,IAAI,EAAE,wBAAwB;QAC9B,OAAO,EAAE,iBAAiB;QAC1B,KAAK,EAAE,CAAC;QACR,QAAQ,EAAE,mBAAmB;QAC7B,KAAK,EAAE,mBAAmB;QAC1B,WAAW,EACT,8IAA8I;QAChJ,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,mBAAmB;KAC1B;IACD;QACE,MAAM,EAAE,kBAAkB;QAC1B,IAAI,EAAE,mBAAmB;QACzB,OAAO,EAAE,iBAAiB;QAC1B,KAAK,EAAE,CAAC;QACR,QAAQ,EAAE,4BAA4B;QACtC,KAAK,EAAE,4BAA4B;QACnC,WAAW,EACT,mHAAmH;QACrH,IAAI,EAAE,wBAAwB;QAC9B,IAAI,EAAE,0BAA0B;KACjC;IACD;QACE,MAAM,EAAE,wBAAwB;QAChC,IAAI,EAAE,0BAA0B;QAChC,OAAO,EAAE,iBAAiB;QAC1B,KAAK,EAAE,CAAC;QACR,QAAQ,EAAE,qBAAqB;QAC/B,KAAK,EAAE,qBAAqB;QAC5B,WAAW,EACT,
|
|
1
|
+
{"version":3,"file":"manifest.js","sourceRoot":"","sources":["../../docs/manifest.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,UAAU,CAAA;AAEnD,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B;QACE,MAAM,EAAE,cAAc;QACtB,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,iBAAiB;QAC1B,KAAK,EAAE,CAAC;QACR,QAAQ,EAAE,UAAU;QACpB,KAAK,EAAE,UAAU;QACjB,WAAW,EACT,uJAAuJ;QACzJ,IAAI,EAAE,IAAI;QACV,IAAI,EAAE,wBAAwB;KAC/B;IACD;QACE,MAAM,EAAE,uBAAuB;QAC/B,IAAI,EAAE,wBAAwB;QAC9B,OAAO,EAAE,iBAAiB;QAC1B,KAAK,EAAE,CAAC;QACR,QAAQ,EAAE,mBAAmB;QAC7B,KAAK,EAAE,mBAAmB;QAC1B,WAAW,EACT,8IAA8I;QAChJ,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,mBAAmB;KAC1B;IACD;QACE,MAAM,EAAE,kBAAkB;QAC1B,IAAI,EAAE,mBAAmB;QACzB,OAAO,EAAE,iBAAiB;QAC1B,KAAK,EAAE,CAAC;QACR,QAAQ,EAAE,4BAA4B;QACtC,KAAK,EAAE,4BAA4B;QACnC,WAAW,EACT,mHAAmH;QACrH,IAAI,EAAE,wBAAwB;QAC9B,IAAI,EAAE,0BAA0B;KACjC;IACD;QACE,MAAM,EAAE,wBAAwB;QAChC,IAAI,EAAE,0BAA0B;QAChC,OAAO,EAAE,iBAAiB;QAC1B,KAAK,EAAE,CAAC;QACR,QAAQ,EAAE,qBAAqB;QAC/B,KAAK,EAAE,qBAAqB;QAC5B,WAAW,EACT,wHAAwH;QAC1H,IAAI,EAAE,mBAAmB;QACzB,IAAI,EAAE,eAAe;KACtB;IACD;QACE,MAAM,EAAE,aAAa;QACrB,IAAI,EAAE,eAAe;QACrB,OAAO,EAAE,iBAAiB;QAC1B,KAAK,EAAE,CAAC;QACR,QAAQ,EAAE,UAAU;QACpB,KAAK,EAAE,UAAU;QACjB,WAAW,EACT,kHAAkH;QACpH,IAAI,EAAE,0BAA0B;QAChC,IAAI,EAAE,kCAAkC;KACzC;IACD;QACE,MAAM,EAAE,yBAAyB;QACjC,IAAI,EAAE,kCAAkC;QACxC,OAAO,EAAE,QAAQ;QACjB,KAAK,EAAE,CAAC;QACR,QAAQ,EAAE,sBAAsB;QAChC,KAAK,EAAE,sBAAsB;QAC7B,WAAW,EACT,6IAA6I;QAC/I,IAAI,EAAE,eAAe;QACrB,IAAI,EAAE,wCAAwC;KAC/C;IACD;QACE,MAAM,EAAE,+BAA+B;QACvC,IAAI,EAAE,wCAAwC;QAC9C,OAAO,EAAE,QAAQ;QACjB,KAAK,EAAE,CAAC;QACR,QAAQ,EAAE,4BAA4B;QACtC,KAAK,EAAE,4BAA4B;QACnC,WAAW,EACT,0HAA0H;QAC5H,IAAI,EAAE,kCAAkC;QACxC,IAAI,EAAE,gCAAgC;KACvC;IACD;QACE,MAAM,EAAE,uBAAuB;QAC/B,IAAI,EAAE,gCAAgC;QACtC,OAAO,EAAE,QAAQ;QACjB,KAAK,EAAE,CAAC;QACR,QAAQ,EAAE,oBAAoB;QAC9B,KAAK,EAAE,oBAAoB;QAC3B,WAAW,EACT,2HAA2H;QAC7H,IAAI,EAAE,wCAAwC;QAC9C,IAAI,EAAE,sBAAsB;KAC7B;IACD;QACE,MAAM,EAAE,aAAa;QACrB,IAAI,EAAE,sBAAsB;QAC5B,OAAO,EAAE,QAAQ;QACjB,KAAK,EAAE,CAAC;QACR,QAAQ,EAAE,UAAU;QACpB,KAAK,EAAE,UAAU;QACjB,WAAW,EACT,mHAAmH;QACrH,IAAI,EAAE,gCAAgC;QACtC,IAAI,EAAE,yBAAyB;KAChC;IACD;QACE,MAAM,EAAE,gBAAgB;QACxB,IAAI,EAAE,yBAAyB;QAC/B,OAAO,EAAE,QAAQ;QACjB,KAAK,EAAE,CAAC;QACR,QAAQ,EAAE,aAAa;QACvB,KAAK,EAAE,aAAa;QACpB,WAAW,EACT,oKAAoK;QACtK,IAAI,EAAE,sBAAsB;QAC5B,IAAI,EAAE,oBAAoB;KAC3B;IACD;QACE,MAAM,EAAE,WAAW;QACnB,IAAI,EAAE,oBAAoB;QAC1B,OAAO,EAAE,QAAQ;QACjB,KAAK,EAAE,CAAC;QACR,QAAQ,EAAE,QAAQ;QAClB,KAAK,EAAE,QAAQ;QACf,WAAW,EACT,oLAAoL;QACtL,IAAI,EAAE,yBAAyB;QAC/B,IAAI,EAAE,oCAAoC;KAC3C;IACD;QACE,MAAM,EAAE,2BAA2B;QACnC,IAAI,EAAE,oCAAoC;QAC1C,OAAO,EAAE,QAAQ;QACjB,KAAK,EAAE,CAAC;QACR,QAAQ,EAAE,wBAAwB;QAClC,KAAK,EAAE,wBAAwB;QAC/B,WAAW,EACT,0HAA0H;QAC5H,IAAI,EAAE,oBAAoB;QAC1B,IAAI,EAAE,6BAA6B;KACpC;IACD;QACE,MAAM,EAAE,qBAAqB;QAC7B,IAAI,EAAE,6BAA6B;QACnC,OAAO,EAAE,QAAQ;QACjB,KAAK,EAAE,CAAC;QACR,QAAQ,EAAE,iBAAiB;QAC3B,KAAK,EAAE,iBAAiB;QACxB,WAAW,EACT,yHAAyH;QAC3H,IAAI,EAAE,oCAAoC;QAC1C,IAAI,EAAE,oBAAoB;KAC3B;IACD;QACE,MAAM,EAAE,SAAS;QACjB,IAAI,EAAE,oBAAoB;QAC1B,OAAO,EAAE,WAAW;QACpB,KAAK,EAAE,CAAC;QACR,QAAQ,EAAE,KAAK;QACf,KAAK,EAAE,KAAK;QACZ,WAAW,EACT,gGAAgG;QAClG,IAAI,EAAE,6BAA6B;QACnC,IAAI,EAAE,8BAA8B;KACrC;IACD;QACE,MAAM,EAAE,kBAAkB;QAC1B,IAAI,EAAE,8BAA8B;QACpC,OAAO,EAAE,WAAW;QACpB,KAAK,EAAE,CAAC;QACR,QAAQ,EAAE,eAAe;QACzB,KAAK,EAAE,eAAe;QACtB,WAAW,EACT,oIAAoI;QACtI,IAAI,EAAE,oBAAoB;QAC1B,IAAI,EAAE,oCAAoC;KAC3C;IACD;QACE,MAAM,EAAE,wBAAwB;QAChC,IAAI,EAAE,oCAAoC;QAC1C,OAAO,EAAE,WAAW;QACpB,KAAK,EAAE,CAAC;QACR,QAAQ,EAAE,qBAAqB;QAC/B,KAAK,EAAE,qBAAqB;QAC5B,WAAW,EACT,yHAAyH;QAC3H,IAAI,EAAE,8BAA8B;QACpC,IAAI,EAAE,oBAAoB;KAC3B;CACO,CAAA;AAEV,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,iBAAiB,EAAE,QAAQ,EAAE,WAAW,CAAU,CAAA;AAE/E,MAAM,UAAU,YAAY,CAAC,IAAY;IACvC,OAAO,YAAY,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,CAAA;AAC1D,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,IAAY;IAChD,MAAM,KAAK,GAAG,YAAY,CAAC,IAAI,CAAC,CAAA;IAChC,MAAM,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,CAAA;IAE/B,qEAAqE;IACrE,2EAA2E;IAC3E,4EAA4E;IAC5E,6EAA6E;IAC7E,0EAA0E;IAC1E,MAAM,eAAe,GAAG,KAAK,KAAK,IAAI,IAAI,WAAW,CAAC,KAAK,CAAC,CAAA;IAC5D,MAAM,SAAS,GACb,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,eAAe,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAA;IAEpE,IAAI,IAAI,KAAK,MAAM;QAAE,OAAO,QAAQ,SAAS,EAAE,CAAA;IAC/C,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,GAAG,SAAS,EAAE,CAAA;AACrD,CAAC;AAED,MAAM,UAAU,wBAAwB;IACtC,OAAO,YAAY,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAClC,GAAG,KAAK;QACR,UAAU,EAAE,qBAAqB,CAAC,KAAK,CAAC,IAAI,CAAC;KAC9C,CAAC,CAAC,CAAA;AACL,CAAC;AAED,SAAS,aAAa,CAAC,KAAoC;IACzD,OAAO;QACL,KAAK,EAAE,KAAK,CAAC,QAAQ;QACrB,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,YAAY,EAAE,EAAE;QAChB,KAAK,EAAE,EAAE;KACV,CAAA;AACH,CAAC;AAWD,MAAM,UAAU,oBAAoB,CAClC,mBAA+C;IAE/C,OAAO,YAAY,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;QAClC,MAAM,KAAK,GAAgD,YAAY;aACpE,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,KAAK,OAAO,CAAC;aAC5C,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC;aACjC,GAAG,CAAC,aAAa,CAAC,CAAA;QAErB,IAAI,OAAO,KAAK,WAAW,IAAI,mBAAmB,EAAE,CAAC;YACnD,KAAK,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAA;QACjC,CAAC;QAED,OAAO;YACL,KAAK,EAAE,OAAO;YACd,YAAY,EAAE,EAAE;YAChB,SAAS,EAAE,KAAK;YAChB,KAAK;SACN,CAAA;IACH,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,IAAmB;IACvD,IAAI,CAAC,IAAI;QAAE,OAAO,KAAK,CAAA;IACvB,IAAI,IAAI,KAAK,oBAAoB,EAAE,CAAC;QAClC,OAAO;YACL,KAAK,EAAE,oBAAoB;YAC3B,IAAI,EAAE,qBAAqB;SAC5B,CAAA;IACH,CAAC;IAED,MAAM,KAAK,GAAG,YAAY,CAAC,IAAI,CAAC,CAAA;IAChC,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,0CAA0C,IAAI,EAAE,CAAC,CAAA;IACnE,CAAC;IAED,OAAO;QACL,KAAK,EAAE,KAAK,CAAC,KAAK;QAClB,IAAI,EAAE,IAAI,KAAK,CAAC,IAAI,EAAE;KACvB,CAAA;AACH,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"installation.screenci.d.ts","sourceRoot":"","sources":["../../../docs/video-sources/installation.screenci.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"installation.screenci.js","sourceRoot":"","sources":["../../../docs/video-sources/installation.screenci.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAEzE,MAAM,SAAS,GAAG,eAAe,CAAC;IAChC,4CAA4C;IAC5C,KAAK,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE;IAC9B,wCAAwC;IACxC,EAAE,EAAE;QACF,IAAI,EAAE,kEAAkE;KACzE;IACD,EAAE,EAAE;QACF,IAAI,EAAE,mFAAmF;KAC1F;CACF,CAAC,CAAA;AAEF,KAAK,CAAC,kBAAkB,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;IAC3C,kEAAkE;IAClE,MAAM,IAAI,CAAC,KAAK,IAAI,EAAE;QACpB,MAAM,IAAI,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAA;QACxC,MAAM,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAA;IAC5C,CAAC,CAAC,CAAA;IAEF,kDAAkD;IAClD,MAAM,SAAS,CAAC,IAAI,EAAE,CAAA;IAEtB,qEAAqE;IACrE,MAAM,QAAQ,CAAC,KAAK,IAAI,EAAE;QACxB,MAAM,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC,CAAC,KAAK,EAAE,CAAA;IACtE,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"landing.screenci.d.ts","sourceRoot":"","sources":["../../../docs/video-sources/landing.screenci.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"landing.screenci.js","sourceRoot":"","sources":["../../../docs/video-sources/landing.screenci.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAEzE,MAAM,SAAS,GAAG,eAAe,CAAC;IAChC,KAAK,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,EAAE,wBAAwB,EAAE;IAC/D,EAAE,EAAE;QACF,IAAI,EAAE,kEAAkE;KACzE;IACD,EAAE,EAAE;QACF,IAAI,EAAE,mFAAmF;KAC1F;CACF,CAAC,CAAA;AAEF,KAAK,CAAC,eAAe,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;IACxC,MAAM,IAAI,CAAC,KAAK,IAAI,EAAE;QACpB,MAAM,IAAI,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAA;QACxC,MAAM,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAA;QAE1C,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE;YACvB,QAAQ,CAAC,MAAM,GAAG,+BAA+B,CAAA;YACjD,YAAY,CAAC,OAAO,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAA;YAChD,QAAQ,CAAC,eAAe,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;YACjD,QAAQ,CAAC,eAAe,CAAC,YAAY,CAAC,YAAY,EAAE,OAAO,CAAC,CAAA;QAC9D,CAAC,CAAC,CAAA;QAEF,MAAM,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC,QAAQ,CAAC,CAAC,OAAO,EAAE,EAAE;YAC3D,IAAI,CAAC,CAAC,OAAO,YAAY,gBAAgB,CAAC,EAAE,CAAC;gBAC3C,OAAM;YACR,CAAC;YAED,OAAO,CAAC,KAAK,EAAE,CAAA;YACf,OAAO,CAAC,WAAW,GAAG,CAAC,CAAA;QACzB,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,MAAM,SAAS,CAAC,IAAI,EAAE,CAAA;IAEtB,MAAM,QAAQ,CAAC,KAAK,IAAI,EAAE;QACxB,MAAM,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC,CAAC,KAAK,EAAE,CAAA;IACtE,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"locator-highlight-animated.screenci.d.ts","sourceRoot":"","sources":["../../../docs/video-sources/locator-highlight-animated.screenci.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import { createOverlays, video } from 'screenci';
|
|
2
|
+
// Animates the same ring as the Screenshots still: it pulses while the page is
|
|
3
|
+
// driven underneath, then closes before the recording stops. An opacity-only
|
|
4
|
+
// pulse keeps the ring landed exactly on the element (no scale, so no capture
|
|
5
|
+
// padding is needed).
|
|
6
|
+
const overlays = createOverlays({
|
|
7
|
+
ring: (target) => ({
|
|
8
|
+
html: '<div class="ring"></div>',
|
|
9
|
+
css: `
|
|
10
|
+
.ring {
|
|
11
|
+
width: 100%;
|
|
12
|
+
height: 100%;
|
|
13
|
+
box-sizing: border-box;
|
|
14
|
+
border: 4px solid #ec4899;
|
|
15
|
+
border-radius: 14px;
|
|
16
|
+
animation: ring-pulse 2s ease-in-out infinite;
|
|
17
|
+
}
|
|
18
|
+
@keyframes ring-pulse {
|
|
19
|
+
0%, 100% { opacity: 1; }
|
|
20
|
+
50% { opacity: 0.3; }
|
|
21
|
+
}
|
|
22
|
+
`,
|
|
23
|
+
over: target,
|
|
24
|
+
margin: 6,
|
|
25
|
+
animate: true,
|
|
26
|
+
durationMs: 2400,
|
|
27
|
+
}),
|
|
28
|
+
});
|
|
29
|
+
video('Locator highlight (animated)', async ({ page }) => {
|
|
30
|
+
await page.goto('https://screenci.com/');
|
|
31
|
+
await page.waitForLoadState('networkidle');
|
|
32
|
+
const cta = page.getByRole('link', { name: 'View Documentation' });
|
|
33
|
+
await cta.scrollIntoViewIfNeeded();
|
|
34
|
+
// The ring pulses while the page stays live. Every start() must be ended
|
|
35
|
+
// before the video function returns.
|
|
36
|
+
const ring = overlays.ring(cta);
|
|
37
|
+
await ring.start();
|
|
38
|
+
await cta.hover();
|
|
39
|
+
await ring.end();
|
|
40
|
+
});
|
|
41
|
+
//# sourceMappingURL=locator-highlight-animated.screenci.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"locator-highlight-animated.screenci.js","sourceRoot":"","sources":["../../../docs/video-sources/locator-highlight-animated.screenci.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,KAAK,EAAE,MAAM,UAAU,CAAA;AAEhD,+EAA+E;AAC/E,6EAA6E;AAC7E,8EAA8E;AAC9E,sBAAsB;AACtB,MAAM,QAAQ,GAAG,cAAc,CAAC;IAC9B,IAAI,EAAE,CAAC,MAAe,EAAE,EAAE,CAAC,CAAC;QAC1B,IAAI,EAAE,0BAA0B;QAChC,GAAG,EAAE;;;;;;;;;;;;;KAaJ;QACD,IAAI,EAAE,MAAM;QACZ,MAAM,EAAE,CAAC;QACT,OAAO,EAAE,IAAI;QACb,UAAU,EAAE,IAAI;KACjB,CAAC;CACH,CAAC,CAAA;AAEF,KAAK,CAAC,8BAA8B,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;IACvD,MAAM,IAAI,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAA;IACxC,MAAM,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAA;IAE1C,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC,CAAA;IAClE,MAAM,GAAG,CAAC,sBAAsB,EAAE,CAAA;IAElC,yEAAyE;IACzE,qCAAqC;IACrC,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IAC/B,MAAM,IAAI,CAAC,KAAK,EAAE,CAAA;IAClB,MAAM,GAAG,CAAC,KAAK,EAAE,CAAA;IACjB,MAAM,IAAI,CAAC,GAAG,EAAE,CAAA;AAClB,CAAC,CAAC,CAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"locator-highlight-still.screenci.d.ts","sourceRoot":"","sources":["../../../docs/video-sources/locator-highlight-still.screenci.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { createOverlays, screenshot } from 'screenci';
|
|
2
|
+
// Rings a single element on the marketing site, then captures a branded still.
|
|
3
|
+
// The Overlays guide animates the same example.
|
|
4
|
+
const overlays = createOverlays({
|
|
5
|
+
ring: (target) => ({
|
|
6
|
+
html: '<div style="width:100%;height:100%;box-sizing:border-box;border:4px solid #ec4899;border-radius:14px"></div>',
|
|
7
|
+
over: target,
|
|
8
|
+
margin: 6,
|
|
9
|
+
}),
|
|
10
|
+
});
|
|
11
|
+
screenshot('Locator highlight', async ({ page }) => {
|
|
12
|
+
await page.goto('https://screenci.com/');
|
|
13
|
+
await page.waitForLoadState('networkidle');
|
|
14
|
+
const cta = page.getByRole('link', { name: 'View Documentation' });
|
|
15
|
+
await cta.scrollIntoViewIfNeeded();
|
|
16
|
+
// In a still, start the overlay and leave it open: it stays in the image.
|
|
17
|
+
await overlays.ring(cta).start();
|
|
18
|
+
});
|
|
19
|
+
//# sourceMappingURL=locator-highlight-still.screenci.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"locator-highlight-still.screenci.js","sourceRoot":"","sources":["../../../docs/video-sources/locator-highlight-still.screenci.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAErD,+EAA+E;AAC/E,gDAAgD;AAChD,MAAM,QAAQ,GAAG,cAAc,CAAC;IAC9B,IAAI,EAAE,CAAC,MAAe,EAAE,EAAE,CAAC,CAAC;QAC1B,IAAI,EAAE,8GAA8G;QACpH,IAAI,EAAE,MAAM;QACZ,MAAM,EAAE,CAAC;KACV,CAAC;CACH,CAAC,CAAA;AAEF,UAAU,CAAC,mBAAmB,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;IACjD,MAAM,IAAI,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAA;IACxC,MAAM,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAA;IAE1C,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC,CAAA;IAClE,MAAM,GAAG,CAAC,sBAAsB,EAAE,CAAA;IAElC,0EAA0E;IAC1E,MAAM,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAA;AAClC,CAAC,CAAC,CAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"product-pitch.screenci.d.ts","sourceRoot":"","sources":["../../../docs/video-sources/product-pitch.screenci.ts"],"names":[],"mappings":""}
|