screenci 0.0.52 → 0.0.53

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 (42) hide show
  1. package/dist/docs/manifest.d.ts +106 -199
  2. package/dist/docs/manifest.d.ts.map +1 -1
  3. package/dist/docs/manifest.js +36 -69
  4. package/dist/docs/manifest.js.map +1 -1
  5. package/dist/docs/videos.d.ts +0 -56
  6. package/dist/docs/videos.d.ts.map +1 -1
  7. package/dist/docs/videos.js +0 -32
  8. package/dist/docs/videos.js.map +1 -1
  9. package/dist/tsconfig.tsbuildinfo +1 -1
  10. package/package.json +1 -1
  11. package/dist/docs/video-sources/assets-and-overlays.video.d.ts +0 -2
  12. package/dist/docs/video-sources/assets-and-overlays.video.d.ts.map +0 -1
  13. package/dist/docs/video-sources/assets-and-overlays.video.js +0 -39
  14. package/dist/docs/video-sources/assets-and-overlays.video.js.map +0 -1
  15. package/dist/docs/video-sources/camera-and-zooming.video.d.ts +0 -2
  16. package/dist/docs/video-sources/camera-and-zooming.video.d.ts.map +0 -1
  17. package/dist/docs/video-sources/camera-and-zooming.video.js +0 -36
  18. package/dist/docs/video-sources/camera-and-zooming.video.js.map +0 -1
  19. package/dist/docs/video-sources/ci-setup.video.d.ts +0 -2
  20. package/dist/docs/video-sources/ci-setup.video.d.ts.map +0 -1
  21. package/dist/docs/video-sources/ci-setup.video.js +0 -36
  22. package/dist/docs/video-sources/ci-setup.video.js.map +0 -1
  23. package/dist/docs/video-sources/generating-videos.video.d.ts +0 -2
  24. package/dist/docs/video-sources/generating-videos.video.d.ts.map +0 -1
  25. package/dist/docs/video-sources/generating-videos.video.js +0 -36
  26. package/dist/docs/video-sources/generating-videos.video.js.map +0 -1
  27. package/dist/docs/video-sources/narration-and-localization.video.d.ts +0 -2
  28. package/dist/docs/video-sources/narration-and-localization.video.d.ts.map +0 -1
  29. package/dist/docs/video-sources/narration-and-localization.video.js +0 -35
  30. package/dist/docs/video-sources/narration-and-localization.video.js.map +0 -1
  31. package/dist/docs/video-sources/public-urls-and-embeds.video.d.ts +0 -2
  32. package/dist/docs/video-sources/public-urls-and-embeds.video.d.ts.map +0 -1
  33. package/dist/docs/video-sources/public-urls-and-embeds.video.js +0 -36
  34. package/dist/docs/video-sources/public-urls-and-embeds.video.js.map +0 -1
  35. package/dist/docs/video-sources/record-and-publish.video.d.ts +0 -2
  36. package/dist/docs/video-sources/record-and-publish.video.d.ts.map +0 -1
  37. package/dist/docs/video-sources/record-and-publish.video.js +0 -36
  38. package/dist/docs/video-sources/record-and-publish.video.js.map +0 -1
  39. package/dist/docs/video-sources/run-and-debug-videos.video.d.ts +0 -2
  40. package/dist/docs/video-sources/run-and-debug-videos.video.d.ts.map +0 -1
  41. package/dist/docs/video-sources/run-and-debug-videos.video.js +0 -36
  42. package/dist/docs/video-sources/run-and-debug-videos.video.js.map +0 -1
@@ -7,86 +7,66 @@ export declare const docsManifest: readonly [{
7
7
  readonly slug: "docs";
8
8
  readonly section: "Getting Started";
9
9
  readonly order: 1;
10
- readonly navLabel: "Installation";
11
- readonly title: "Installation";
10
+ readonly navLabel: "Installation & first video";
11
+ readonly title: "Installation & First Video";
12
12
  readonly description: "Install ScreenCI, initialize a project, run the starter video locally, and record your first final video.";
13
13
  readonly prev: null;
14
- readonly next: "docs/write-video-scripts";
15
- }, {
16
- readonly source: "write-video-scripts.md";
17
- readonly slug: "docs/write-video-scripts";
18
- readonly section: "Getting Started";
19
- readonly order: 2;
20
- readonly navLabel: "Write video scripts";
21
- readonly title: "Write Video Scripts";
22
- readonly description: "Author .video.ts files with Playwright-like APIs, ScreenCI narration and camera helpers, and workflow-aware pacing.";
23
- readonly prev: "docs";
24
14
  readonly next: "docs/generating-videos";
25
15
  }, {
26
16
  readonly source: "generating-videos.mdx";
27
17
  readonly slug: "docs/generating-videos";
28
18
  readonly section: "Getting Started";
29
- readonly order: 3;
19
+ readonly order: 2;
30
20
  readonly navLabel: "Generating videos";
31
21
  readonly title: "Generating Videos";
32
22
  readonly description: "Use Playwright codegen and AI-assisted workflows to generate a first ScreenCI draft, then refine it into a real video script.";
33
- readonly prev: "docs/write-video-scripts";
34
- readonly next: "docs/run-and-debug-videos";
23
+ readonly prev: "docs";
24
+ readonly next: "docs/write-video-scripts";
35
25
  }, {
36
- readonly source: "run-and-debug-videos.mdx";
37
- readonly slug: "docs/run-and-debug-videos";
26
+ readonly source: "write-video-scripts.md";
27
+ readonly slug: "docs/write-video-scripts";
38
28
  readonly section: "Getting Started";
39
- readonly order: 4;
40
- readonly navLabel: "Run and debug videos";
41
- readonly title: "Run and Debug Videos";
42
- readonly description: "Use screenci test to iterate locally, inspect failures, and debug pacing, selectors, and visible state before recording.";
29
+ readonly order: 3;
30
+ readonly navLabel: "Video script basics";
31
+ readonly title: "Video Script Basics";
32
+ readonly description: "Author .video.ts files with Playwright-like APIs, ScreenCI narration and camera helpers, and workflow-aware pacing.";
43
33
  readonly prev: "docs/generating-videos";
44
- readonly next: "docs/record-and-publish";
45
- }, {
46
- readonly source: "record-and-publish.mdx";
47
- readonly slug: "docs/record-and-publish";
48
- readonly section: "Getting Started";
49
- readonly order: 5;
50
- readonly navLabel: "Record and publish";
51
- readonly title: "Record and Publish";
52
- readonly description: "Record the final browser session with screenci record, upload the results, and understand how published outputs behave.";
53
- readonly prev: "docs/run-and-debug-videos";
54
34
  readonly next: "docs/ci-setup";
55
35
  }, {
56
36
  readonly source: "ci-setup.md";
57
37
  readonly slug: "docs/ci-setup";
58
38
  readonly section: "Getting Started";
59
- readonly order: 6;
39
+ readonly order: 4;
60
40
  readonly navLabel: "CI setup";
61
41
  readonly title: "CI Setup";
62
42
  readonly description: "Understand the generated GitHub Actions workflow, required secrets, and how to keep CI recordings deterministic.";
63
- readonly prev: "docs/record-and-publish";
64
- readonly next: "docs/screenci-vs-playwright";
43
+ readonly prev: "docs/write-video-scripts";
44
+ readonly next: "docs/guides/page-instrumentation";
65
45
  }, {
66
- readonly source: "screenci-vs-playwright.md";
67
- readonly slug: "docs/screenci-vs-playwright";
68
- readonly section: "Getting Started";
69
- readonly order: 7;
70
- readonly navLabel: "ScreenCI vs Playwright";
71
- readonly title: "ScreenCI vs Playwright";
72
- readonly description: "See what stays the same from Playwright, what ScreenCI adds for polished video authoring, and when to use each tool.";
46
+ readonly source: "page-instrumentation.md";
47
+ readonly slug: "docs/guides/page-instrumentation";
48
+ readonly section: "Guides";
49
+ readonly order: 1;
50
+ readonly navLabel: "Page instrumentation";
51
+ readonly title: "Page Instrumentation";
52
+ readonly description: "Understand how ScreenCI instruments the Playwright page so visible actions like clicks, typing, mouse movement, and scrolling are animated.";
73
53
  readonly prev: "docs/ci-setup";
74
54
  readonly next: "docs/guides/narration-and-localization";
75
55
  }, {
76
56
  readonly source: "narration-and-localization.md";
77
57
  readonly slug: "docs/guides/narration-and-localization";
78
58
  readonly section: "Guides";
79
- readonly order: 1;
59
+ readonly order: 2;
80
60
  readonly navLabel: "Narration and localization";
81
61
  readonly title: "Narration and Localization";
82
62
  readonly description: "Create spoken cues, overlap narration with visible UI motion, and keep multi-language variants consistent and type-safe.";
83
- readonly prev: "docs/screenci-vs-playwright";
63
+ readonly prev: "docs/guides/page-instrumentation";
84
64
  readonly next: "docs/guides/camera-and-zooming";
85
65
  }, {
86
66
  readonly source: "camera-and-zooming.md";
87
67
  readonly slug: "docs/guides/camera-and-zooming";
88
68
  readonly section: "Guides";
89
- readonly order: 2;
69
+ readonly order: 3;
90
70
  readonly navLabel: "Camera and zooming";
91
71
  readonly title: "Camera and Zooming";
92
72
  readonly description: "Choose between autoZoom and manual framing, and use camera direction to guide attention without making the video frantic.";
@@ -96,7 +76,7 @@ export declare const docsManifest: readonly [{
96
76
  readonly source: "assets-and-overlays.md";
97
77
  readonly slug: "docs/guides/assets-and-overlays";
98
78
  readonly section: "Guides";
99
- readonly order: 3;
79
+ readonly order: 4;
100
80
  readonly navLabel: "Assets and overlays";
101
81
  readonly title: "Assets and Overlays";
102
82
  readonly description: "Add intro clips, corner logos, transition assets, and timed overlays to ScreenCI recordings.";
@@ -106,7 +86,7 @@ export declare const docsManifest: readonly [{
106
86
  readonly source: "public-urls-and-embeds.md";
107
87
  readonly slug: "docs/guides/public-urls-and-embeds";
108
88
  readonly section: "Guides";
109
- readonly order: 4;
89
+ readonly order: 5;
110
90
  readonly navLabel: "Public URLs and embeds";
111
91
  readonly title: "Public URLs and Embeds";
112
92
  readonly description: "Enable public delivery for a video, understand stable language-specific URLs, and embed ScreenCI outputs in other sites.";
@@ -116,7 +96,7 @@ export declare const docsManifest: readonly [{
116
96
  readonly source: "update-screenci.mdx";
117
97
  readonly slug: "docs/guides/update-screenci";
118
98
  readonly section: "Guides";
119
- readonly order: 5;
99
+ readonly order: 6;
120
100
  readonly navLabel: "Update ScreenCI";
121
101
  readonly title: "Update ScreenCI";
122
102
  readonly description: "Upgrade the screenci package, refresh Playwright when needed, and verify that existing videos still behave as expected.";
@@ -125,8 +105,8 @@ export declare const docsManifest: readonly [{
125
105
  }, {
126
106
  readonly source: "cli.mdx";
127
107
  readonly slug: "docs/reference/cli";
128
- readonly section: "Reference";
129
- readonly order: 1;
108
+ readonly section: "Guides";
109
+ readonly order: 7;
130
110
  readonly navLabel: "CLI";
131
111
  readonly title: "CLI";
132
112
  readonly description: "Command reference for screenci init, test, record, project info, and public delivery commands.";
@@ -135,120 +115,90 @@ export declare const docsManifest: readonly [{
135
115
  }, {
136
116
  readonly source: "configuration.md";
137
117
  readonly slug: "docs/reference/configuration";
138
- readonly section: "Reference";
139
- readonly order: 2;
118
+ readonly section: "Guides";
119
+ readonly order: 8;
140
120
  readonly navLabel: "Configuration";
141
121
  readonly title: "Configuration";
142
122
  readonly description: "Configure project identity, file locations, rendering defaults, upload behavior, and Playwright integration in screenci.config.ts.";
143
123
  readonly prev: "docs/reference/cli";
144
- readonly next: "docs/reference/video-authoring-api-overview";
145
- }, {
146
- readonly source: "video-authoring-api-overview.md";
147
- readonly slug: "docs/reference/video-authoring-api-overview";
148
- readonly section: "Reference";
149
- readonly order: 3;
150
- readonly navLabel: "Video authoring API overview";
151
- readonly title: "Video Authoring API Overview";
152
- readonly description: "Human-curated reference for the main ScreenCI authoring primitives, with minimal examples and links into the full typedoc.";
153
- readonly prev: "docs/reference/configuration";
154
124
  readonly next: "docs/reference/public-delivery-api";
155
125
  }, {
156
126
  readonly source: "public-delivery-api.md";
157
127
  readonly slug: "docs/reference/public-delivery-api";
158
- readonly section: "Reference";
159
- readonly order: 4;
128
+ readonly section: "Guides";
129
+ readonly order: 9;
160
130
  readonly navLabel: "Public delivery API";
161
131
  readonly title: "Public Delivery API";
162
132
  readonly description: "Technical reference for the unauthenticated endpoints that serve published videos, thumbnails, subtitles, and metadata.";
163
- readonly prev: "docs/reference/video-authoring-api-overview";
133
+ readonly prev: "docs/reference/configuration";
164
134
  readonly next: "docs/reference/api";
165
135
  }];
166
- export declare const docsSections: readonly ["Getting Started", "Guides", "Reference"];
136
+ export declare const docsSections: readonly ["Getting Started", "Guides"];
167
137
  export declare function getDocBySlug(slug: string): {
168
138
  readonly source: "installation.mdx";
169
139
  readonly slug: "docs";
170
140
  readonly section: "Getting Started";
171
141
  readonly order: 1;
172
- readonly navLabel: "Installation";
173
- readonly title: "Installation";
142
+ readonly navLabel: "Installation & first video";
143
+ readonly title: "Installation & First Video";
174
144
  readonly description: "Install ScreenCI, initialize a project, run the starter video locally, and record your first final video.";
175
145
  readonly prev: null;
176
- readonly next: "docs/write-video-scripts";
177
- } | {
178
- readonly source: "write-video-scripts.md";
179
- readonly slug: "docs/write-video-scripts";
180
- readonly section: "Getting Started";
181
- readonly order: 2;
182
- readonly navLabel: "Write video scripts";
183
- readonly title: "Write Video Scripts";
184
- readonly description: "Author .video.ts files with Playwright-like APIs, ScreenCI narration and camera helpers, and workflow-aware pacing.";
185
- readonly prev: "docs";
186
146
  readonly next: "docs/generating-videos";
187
147
  } | {
188
148
  readonly source: "generating-videos.mdx";
189
149
  readonly slug: "docs/generating-videos";
190
150
  readonly section: "Getting Started";
191
- readonly order: 3;
151
+ readonly order: 2;
192
152
  readonly navLabel: "Generating videos";
193
153
  readonly title: "Generating Videos";
194
154
  readonly description: "Use Playwright codegen and AI-assisted workflows to generate a first ScreenCI draft, then refine it into a real video script.";
195
- readonly prev: "docs/write-video-scripts";
196
- readonly next: "docs/run-and-debug-videos";
155
+ readonly prev: "docs";
156
+ readonly next: "docs/write-video-scripts";
197
157
  } | {
198
- readonly source: "run-and-debug-videos.mdx";
199
- readonly slug: "docs/run-and-debug-videos";
158
+ readonly source: "write-video-scripts.md";
159
+ readonly slug: "docs/write-video-scripts";
200
160
  readonly section: "Getting Started";
201
- readonly order: 4;
202
- readonly navLabel: "Run and debug videos";
203
- readonly title: "Run and Debug Videos";
204
- readonly description: "Use screenci test to iterate locally, inspect failures, and debug pacing, selectors, and visible state before recording.";
161
+ readonly order: 3;
162
+ readonly navLabel: "Video script basics";
163
+ readonly title: "Video Script Basics";
164
+ readonly description: "Author .video.ts files with Playwright-like APIs, ScreenCI narration and camera helpers, and workflow-aware pacing.";
205
165
  readonly prev: "docs/generating-videos";
206
- readonly next: "docs/record-and-publish";
207
- } | {
208
- readonly source: "record-and-publish.mdx";
209
- readonly slug: "docs/record-and-publish";
210
- readonly section: "Getting Started";
211
- readonly order: 5;
212
- readonly navLabel: "Record and publish";
213
- readonly title: "Record and Publish";
214
- readonly description: "Record the final browser session with screenci record, upload the results, and understand how published outputs behave.";
215
- readonly prev: "docs/run-and-debug-videos";
216
166
  readonly next: "docs/ci-setup";
217
167
  } | {
218
168
  readonly source: "ci-setup.md";
219
169
  readonly slug: "docs/ci-setup";
220
170
  readonly section: "Getting Started";
221
- readonly order: 6;
171
+ readonly order: 4;
222
172
  readonly navLabel: "CI setup";
223
173
  readonly title: "CI Setup";
224
174
  readonly description: "Understand the generated GitHub Actions workflow, required secrets, and how to keep CI recordings deterministic.";
225
- readonly prev: "docs/record-and-publish";
226
- readonly next: "docs/screenci-vs-playwright";
175
+ readonly prev: "docs/write-video-scripts";
176
+ readonly next: "docs/guides/page-instrumentation";
227
177
  } | {
228
- readonly source: "screenci-vs-playwright.md";
229
- readonly slug: "docs/screenci-vs-playwright";
230
- readonly section: "Getting Started";
231
- readonly order: 7;
232
- readonly navLabel: "ScreenCI vs Playwright";
233
- readonly title: "ScreenCI vs Playwright";
234
- readonly description: "See what stays the same from Playwright, what ScreenCI adds for polished video authoring, and when to use each tool.";
178
+ readonly source: "page-instrumentation.md";
179
+ readonly slug: "docs/guides/page-instrumentation";
180
+ readonly section: "Guides";
181
+ readonly order: 1;
182
+ readonly navLabel: "Page instrumentation";
183
+ readonly title: "Page Instrumentation";
184
+ readonly description: "Understand how ScreenCI instruments the Playwright page so visible actions like clicks, typing, mouse movement, and scrolling are animated.";
235
185
  readonly prev: "docs/ci-setup";
236
186
  readonly next: "docs/guides/narration-and-localization";
237
187
  } | {
238
188
  readonly source: "narration-and-localization.md";
239
189
  readonly slug: "docs/guides/narration-and-localization";
240
190
  readonly section: "Guides";
241
- readonly order: 1;
191
+ readonly order: 2;
242
192
  readonly navLabel: "Narration and localization";
243
193
  readonly title: "Narration and Localization";
244
194
  readonly description: "Create spoken cues, overlap narration with visible UI motion, and keep multi-language variants consistent and type-safe.";
245
- readonly prev: "docs/screenci-vs-playwright";
195
+ readonly prev: "docs/guides/page-instrumentation";
246
196
  readonly next: "docs/guides/camera-and-zooming";
247
197
  } | {
248
198
  readonly source: "camera-and-zooming.md";
249
199
  readonly slug: "docs/guides/camera-and-zooming";
250
200
  readonly section: "Guides";
251
- readonly order: 2;
201
+ readonly order: 3;
252
202
  readonly navLabel: "Camera and zooming";
253
203
  readonly title: "Camera and Zooming";
254
204
  readonly description: "Choose between autoZoom and manual framing, and use camera direction to guide attention without making the video frantic.";
@@ -258,7 +208,7 @@ export declare function getDocBySlug(slug: string): {
258
208
  readonly source: "assets-and-overlays.md";
259
209
  readonly slug: "docs/guides/assets-and-overlays";
260
210
  readonly section: "Guides";
261
- readonly order: 3;
211
+ readonly order: 4;
262
212
  readonly navLabel: "Assets and overlays";
263
213
  readonly title: "Assets and Overlays";
264
214
  readonly description: "Add intro clips, corner logos, transition assets, and timed overlays to ScreenCI recordings.";
@@ -268,7 +218,7 @@ export declare function getDocBySlug(slug: string): {
268
218
  readonly source: "public-urls-and-embeds.md";
269
219
  readonly slug: "docs/guides/public-urls-and-embeds";
270
220
  readonly section: "Guides";
271
- readonly order: 4;
221
+ readonly order: 5;
272
222
  readonly navLabel: "Public URLs and embeds";
273
223
  readonly title: "Public URLs and Embeds";
274
224
  readonly description: "Enable public delivery for a video, understand stable language-specific URLs, and embed ScreenCI outputs in other sites.";
@@ -278,7 +228,7 @@ export declare function getDocBySlug(slug: string): {
278
228
  readonly source: "update-screenci.mdx";
279
229
  readonly slug: "docs/guides/update-screenci";
280
230
  readonly section: "Guides";
281
- readonly order: 5;
231
+ readonly order: 6;
282
232
  readonly navLabel: "Update ScreenCI";
283
233
  readonly title: "Update ScreenCI";
284
234
  readonly description: "Upgrade the screenci package, refresh Playwright when needed, and verify that existing videos still behave as expected.";
@@ -287,8 +237,8 @@ export declare function getDocBySlug(slug: string): {
287
237
  } | {
288
238
  readonly source: "cli.mdx";
289
239
  readonly slug: "docs/reference/cli";
290
- readonly section: "Reference";
291
- readonly order: 1;
240
+ readonly section: "Guides";
241
+ readonly order: 7;
292
242
  readonly navLabel: "CLI";
293
243
  readonly title: "CLI";
294
244
  readonly description: "Command reference for screenci init, test, record, project info, and public delivery commands.";
@@ -297,32 +247,22 @@ export declare function getDocBySlug(slug: string): {
297
247
  } | {
298
248
  readonly source: "configuration.md";
299
249
  readonly slug: "docs/reference/configuration";
300
- readonly section: "Reference";
301
- readonly order: 2;
250
+ readonly section: "Guides";
251
+ readonly order: 8;
302
252
  readonly navLabel: "Configuration";
303
253
  readonly title: "Configuration";
304
254
  readonly description: "Configure project identity, file locations, rendering defaults, upload behavior, and Playwright integration in screenci.config.ts.";
305
255
  readonly prev: "docs/reference/cli";
306
- readonly next: "docs/reference/video-authoring-api-overview";
307
- } | {
308
- readonly source: "video-authoring-api-overview.md";
309
- readonly slug: "docs/reference/video-authoring-api-overview";
310
- readonly section: "Reference";
311
- readonly order: 3;
312
- readonly navLabel: "Video authoring API overview";
313
- readonly title: "Video Authoring API Overview";
314
- readonly description: "Human-curated reference for the main ScreenCI authoring primitives, with minimal examples and links into the full typedoc.";
315
- readonly prev: "docs/reference/configuration";
316
256
  readonly next: "docs/reference/public-delivery-api";
317
257
  } | {
318
258
  readonly source: "public-delivery-api.md";
319
259
  readonly slug: "docs/reference/public-delivery-api";
320
- readonly section: "Reference";
321
- readonly order: 4;
260
+ readonly section: "Guides";
261
+ readonly order: 9;
322
262
  readonly navLabel: "Public delivery API";
323
263
  readonly title: "Public Delivery API";
324
264
  readonly description: "Technical reference for the unauthenticated endpoints that serve published videos, thumbnails, subtitles, and metadata.";
325
- readonly prev: "docs/reference/video-authoring-api-overview";
265
+ readonly prev: "docs/reference/configuration";
326
266
  readonly next: "docs/reference/api";
327
267
  } | undefined;
328
268
  export declare function getOutputPathFromSlug(slug: string): string;
@@ -332,75 +272,53 @@ export declare function getGeneratedDocsManifest(): ({
332
272
  slug: "docs";
333
273
  section: "Getting Started";
334
274
  order: 1;
335
- navLabel: "Installation";
336
- title: "Installation";
275
+ navLabel: "Installation & first video";
276
+ title: "Installation & First Video";
337
277
  description: "Install ScreenCI, initialize a project, run the starter video locally, and record your first final video.";
338
278
  prev: null;
339
- next: "docs/write-video-scripts";
340
- } | {
341
- outputPath: string;
342
- source: "write-video-scripts.md";
343
- slug: "docs/write-video-scripts";
344
- section: "Getting Started";
345
- order: 2;
346
- navLabel: "Write video scripts";
347
- title: "Write Video Scripts";
348
- description: "Author .video.ts files with Playwright-like APIs, ScreenCI narration and camera helpers, and workflow-aware pacing.";
349
- prev: "docs";
350
279
  next: "docs/generating-videos";
351
280
  } | {
352
281
  outputPath: string;
353
282
  source: "generating-videos.mdx";
354
283
  slug: "docs/generating-videos";
355
284
  section: "Getting Started";
356
- order: 3;
285
+ order: 2;
357
286
  navLabel: "Generating videos";
358
287
  title: "Generating Videos";
359
288
  description: "Use Playwright codegen and AI-assisted workflows to generate a first ScreenCI draft, then refine it into a real video script.";
360
- prev: "docs/write-video-scripts";
361
- next: "docs/run-and-debug-videos";
289
+ prev: "docs";
290
+ next: "docs/write-video-scripts";
362
291
  } | {
363
292
  outputPath: string;
364
- source: "run-and-debug-videos.mdx";
365
- slug: "docs/run-and-debug-videos";
293
+ source: "write-video-scripts.md";
294
+ slug: "docs/write-video-scripts";
366
295
  section: "Getting Started";
367
- order: 4;
368
- navLabel: "Run and debug videos";
369
- title: "Run and Debug Videos";
370
- description: "Use screenci test to iterate locally, inspect failures, and debug pacing, selectors, and visible state before recording.";
296
+ order: 3;
297
+ navLabel: "Video script basics";
298
+ title: "Video Script Basics";
299
+ description: "Author .video.ts files with Playwright-like APIs, ScreenCI narration and camera helpers, and workflow-aware pacing.";
371
300
  prev: "docs/generating-videos";
372
- next: "docs/record-and-publish";
373
- } | {
374
- outputPath: string;
375
- source: "record-and-publish.mdx";
376
- slug: "docs/record-and-publish";
377
- section: "Getting Started";
378
- order: 5;
379
- navLabel: "Record and publish";
380
- title: "Record and Publish";
381
- description: "Record the final browser session with screenci record, upload the results, and understand how published outputs behave.";
382
- prev: "docs/run-and-debug-videos";
383
301
  next: "docs/ci-setup";
384
302
  } | {
385
303
  outputPath: string;
386
304
  source: "ci-setup.md";
387
305
  slug: "docs/ci-setup";
388
306
  section: "Getting Started";
389
- order: 6;
307
+ order: 4;
390
308
  navLabel: "CI setup";
391
309
  title: "CI Setup";
392
310
  description: "Understand the generated GitHub Actions workflow, required secrets, and how to keep CI recordings deterministic.";
393
- prev: "docs/record-and-publish";
394
- next: "docs/screenci-vs-playwright";
311
+ prev: "docs/write-video-scripts";
312
+ next: "docs/guides/page-instrumentation";
395
313
  } | {
396
314
  outputPath: string;
397
- source: "screenci-vs-playwright.md";
398
- slug: "docs/screenci-vs-playwright";
399
- section: "Getting Started";
400
- order: 7;
401
- navLabel: "ScreenCI vs Playwright";
402
- title: "ScreenCI vs Playwright";
403
- description: "See what stays the same from Playwright, what ScreenCI adds for polished video authoring, and when to use each tool.";
315
+ source: "page-instrumentation.md";
316
+ slug: "docs/guides/page-instrumentation";
317
+ section: "Guides";
318
+ order: 1;
319
+ navLabel: "Page instrumentation";
320
+ title: "Page Instrumentation";
321
+ description: "Understand how ScreenCI instruments the Playwright page so visible actions like clicks, typing, mouse movement, and scrolling are animated.";
404
322
  prev: "docs/ci-setup";
405
323
  next: "docs/guides/narration-and-localization";
406
324
  } | {
@@ -408,18 +326,18 @@ export declare function getGeneratedDocsManifest(): ({
408
326
  source: "narration-and-localization.md";
409
327
  slug: "docs/guides/narration-and-localization";
410
328
  section: "Guides";
411
- order: 1;
329
+ order: 2;
412
330
  navLabel: "Narration and localization";
413
331
  title: "Narration and Localization";
414
332
  description: "Create spoken cues, overlap narration with visible UI motion, and keep multi-language variants consistent and type-safe.";
415
- prev: "docs/screenci-vs-playwright";
333
+ prev: "docs/guides/page-instrumentation";
416
334
  next: "docs/guides/camera-and-zooming";
417
335
  } | {
418
336
  outputPath: string;
419
337
  source: "camera-and-zooming.md";
420
338
  slug: "docs/guides/camera-and-zooming";
421
339
  section: "Guides";
422
- order: 2;
340
+ order: 3;
423
341
  navLabel: "Camera and zooming";
424
342
  title: "Camera and Zooming";
425
343
  description: "Choose between autoZoom and manual framing, and use camera direction to guide attention without making the video frantic.";
@@ -430,7 +348,7 @@ export declare function getGeneratedDocsManifest(): ({
430
348
  source: "assets-and-overlays.md";
431
349
  slug: "docs/guides/assets-and-overlays";
432
350
  section: "Guides";
433
- order: 3;
351
+ order: 4;
434
352
  navLabel: "Assets and overlays";
435
353
  title: "Assets and Overlays";
436
354
  description: "Add intro clips, corner logos, transition assets, and timed overlays to ScreenCI recordings.";
@@ -441,7 +359,7 @@ export declare function getGeneratedDocsManifest(): ({
441
359
  source: "public-urls-and-embeds.md";
442
360
  slug: "docs/guides/public-urls-and-embeds";
443
361
  section: "Guides";
444
- order: 4;
362
+ order: 5;
445
363
  navLabel: "Public URLs and embeds";
446
364
  title: "Public URLs and Embeds";
447
365
  description: "Enable public delivery for a video, understand stable language-specific URLs, and embed ScreenCI outputs in other sites.";
@@ -452,7 +370,7 @@ export declare function getGeneratedDocsManifest(): ({
452
370
  source: "update-screenci.mdx";
453
371
  slug: "docs/guides/update-screenci";
454
372
  section: "Guides";
455
- order: 5;
373
+ order: 6;
456
374
  navLabel: "Update ScreenCI";
457
375
  title: "Update ScreenCI";
458
376
  description: "Upgrade the screenci package, refresh Playwright when needed, and verify that existing videos still behave as expected.";
@@ -462,8 +380,8 @@ export declare function getGeneratedDocsManifest(): ({
462
380
  outputPath: string;
463
381
  source: "cli.mdx";
464
382
  slug: "docs/reference/cli";
465
- section: "Reference";
466
- order: 1;
383
+ section: "Guides";
384
+ order: 7;
467
385
  navLabel: "CLI";
468
386
  title: "CLI";
469
387
  description: "Command reference for screenci init, test, record, project info, and public delivery commands.";
@@ -473,34 +391,23 @@ export declare function getGeneratedDocsManifest(): ({
473
391
  outputPath: string;
474
392
  source: "configuration.md";
475
393
  slug: "docs/reference/configuration";
476
- section: "Reference";
477
- order: 2;
394
+ section: "Guides";
395
+ order: 8;
478
396
  navLabel: "Configuration";
479
397
  title: "Configuration";
480
398
  description: "Configure project identity, file locations, rendering defaults, upload behavior, and Playwright integration in screenci.config.ts.";
481
399
  prev: "docs/reference/cli";
482
- next: "docs/reference/video-authoring-api-overview";
483
- } | {
484
- outputPath: string;
485
- source: "video-authoring-api-overview.md";
486
- slug: "docs/reference/video-authoring-api-overview";
487
- section: "Reference";
488
- order: 3;
489
- navLabel: "Video authoring API overview";
490
- title: "Video Authoring API Overview";
491
- description: "Human-curated reference for the main ScreenCI authoring primitives, with minimal examples and links into the full typedoc.";
492
- prev: "docs/reference/configuration";
493
400
  next: "docs/reference/public-delivery-api";
494
401
  } | {
495
402
  outputPath: string;
496
403
  source: "public-delivery-api.md";
497
404
  slug: "docs/reference/public-delivery-api";
498
- section: "Reference";
499
- order: 4;
405
+ section: "Guides";
406
+ order: 9;
500
407
  navLabel: "Public delivery API";
501
408
  title: "Public Delivery API";
502
409
  description: "Technical reference for the unauthenticated endpoints that serve published videos, thumbnails, subtitles, and metadata.";
503
- prev: "docs/reference/video-authoring-api-overview";
410
+ prev: "docs/reference/configuration";
504
411
  next: "docs/reference/api";
505
412
  })[];
506
413
  type TypedocSidebarItem = {
@@ -511,12 +418,12 @@ type TypedocSidebarItem = {
511
418
  attrs?: Record<string, unknown>;
512
419
  };
513
420
  export declare function getDocsSidebarConfig(typedocSidebarGroup?: TypedocSidebarItem | null): {
514
- label: "Getting Started" | "Guides" | "Reference";
421
+ label: "Getting Started" | "Guides";
515
422
  translations: {};
516
423
  collapsed: boolean;
517
424
  items: ({
518
- label: "Installation" | "Write video scripts" | "Generating videos" | "Run and debug videos" | "Record and publish" | "CI setup" | "ScreenCI vs Playwright" | "Narration and localization" | "Camera and zooming" | "Assets and overlays" | "Public URLs and embeds" | "Update ScreenCI" | "CLI" | "Configuration" | "Video authoring API overview" | "Public delivery API";
519
- slug: "docs" | "docs/write-video-scripts" | "docs/generating-videos" | "docs/run-and-debug-videos" | "docs/record-and-publish" | "docs/ci-setup" | "docs/screenci-vs-playwright" | "docs/guides/narration-and-localization" | "docs/guides/camera-and-zooming" | "docs/guides/assets-and-overlays" | "docs/guides/public-urls-and-embeds" | "docs/guides/update-screenci" | "docs/reference/cli" | "docs/reference/configuration" | "docs/reference/video-authoring-api-overview" | "docs/reference/public-delivery-api";
425
+ label: "Installation & first video" | "Generating videos" | "Video script basics" | "CI setup" | "Page instrumentation" | "Narration and localization" | "Camera and zooming" | "Assets and overlays" | "Public URLs and embeds" | "Update ScreenCI" | "CLI" | "Configuration" | "Public delivery API";
426
+ slug: "docs" | "docs/generating-videos" | "docs/write-video-scripts" | "docs/ci-setup" | "docs/guides/page-instrumentation" | "docs/guides/narration-and-localization" | "docs/guides/camera-and-zooming" | "docs/guides/assets-and-overlays" | "docs/guides/public-urls-and-embeds" | "docs/guides/update-screenci" | "docs/reference/cli" | "docs/reference/configuration" | "docs/reference/public-delivery-api";
520
427
  translations: {};
521
428
  attrs: {};
522
429
  } | TypedocSidebarItem)[];
@@ -1 +1 @@
1
- {"version":3,"file":"manifest.d.ts","sourceRoot":"","sources":["../../docs/manifest.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,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,UAMjD;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"}
1
+ {"version":3,"file":"manifest.d.ts","sourceRoot":"","sources":["../../docs/manifest.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA6Jf,CAAA;AAEV,eAAO,MAAM,YAAY,wCAAyC,CAAA;AAElE,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAExC;AAED,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,UAMjD;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"}