screenci 0.0.43 → 0.0.45
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/LICENCE +21 -0
- package/README.md +74 -195
- package/dist/cli.d.ts +20 -1
- package/dist/cli.d.ts.map +1 -1
- package/dist/cli.js +685 -464
- package/dist/cli.js.map +1 -1
- package/dist/docs/manifest.d.ts +521 -0
- package/dist/docs/manifest.d.ts.map +1 -0
- package/dist/docs/manifest.js +237 -0
- package/dist/docs/manifest.js.map +1 -0
- package/dist/docs/video-sources/camera-and-zooming.video.d.ts +2 -0
- package/dist/docs/video-sources/camera-and-zooming.video.d.ts.map +1 -0
- package/dist/docs/video-sources/camera-and-zooming.video.js +37 -0
- package/dist/docs/video-sources/camera-and-zooming.video.js.map +1 -0
- package/dist/docs/video-sources/ci-setup.video.d.ts +2 -0
- package/dist/docs/video-sources/ci-setup.video.d.ts.map +1 -0
- package/dist/docs/video-sources/ci-setup.video.js +37 -0
- package/dist/docs/video-sources/ci-setup.video.js.map +1 -0
- package/dist/docs/video-sources/cli.video.d.ts +2 -0
- package/dist/docs/video-sources/cli.video.d.ts.map +1 -0
- package/dist/docs/video-sources/cli.video.js +37 -0
- package/dist/docs/video-sources/cli.video.js.map +1 -0
- package/dist/docs/video-sources/docs-shared.d.ts +5 -0
- package/dist/docs/video-sources/docs-shared.d.ts.map +1 -0
- package/dist/docs/video-sources/docs-shared.js +14 -0
- package/dist/docs/video-sources/docs-shared.js.map +1 -0
- package/dist/docs/video-sources/generating-videos.video.d.ts +2 -0
- package/dist/docs/video-sources/generating-videos.video.d.ts.map +1 -0
- package/dist/docs/video-sources/generating-videos.video.js +37 -0
- package/dist/docs/video-sources/generating-videos.video.js.map +1 -0
- package/dist/docs/video-sources/installation.video.d.ts +2 -0
- package/dist/docs/video-sources/installation.video.d.ts.map +1 -0
- package/dist/docs/video-sources/installation.video.js +26 -0
- package/dist/docs/video-sources/installation.video.js.map +1 -0
- package/dist/docs/video-sources/narration-and-localization.video.d.ts +2 -0
- package/dist/docs/video-sources/narration-and-localization.video.d.ts.map +1 -0
- package/dist/docs/video-sources/narration-and-localization.video.js +40 -0
- package/dist/docs/video-sources/narration-and-localization.video.js.map +1 -0
- package/dist/docs/video-sources/public-urls-and-embeds.video.d.ts +2 -0
- package/dist/docs/video-sources/public-urls-and-embeds.video.d.ts.map +1 -0
- package/dist/docs/video-sources/public-urls-and-embeds.video.js +37 -0
- package/dist/docs/video-sources/public-urls-and-embeds.video.js.map +1 -0
- package/dist/docs/video-sources/record-and-publish.video.d.ts +2 -0
- package/dist/docs/video-sources/record-and-publish.video.d.ts.map +1 -0
- package/dist/docs/video-sources/record-and-publish.video.js +37 -0
- package/dist/docs/video-sources/record-and-publish.video.js.map +1 -0
- package/dist/docs/video-sources/run-and-debug-videos.video.d.ts +2 -0
- package/dist/docs/video-sources/run-and-debug-videos.video.d.ts.map +1 -0
- package/dist/docs/video-sources/run-and-debug-videos.video.js +37 -0
- package/dist/docs/video-sources/run-and-debug-videos.video.js.map +1 -0
- package/dist/docs/video-sources/write-video-scripts.video.d.ts +2 -0
- package/dist/docs/video-sources/write-video-scripts.video.d.ts.map +1 -0
- package/dist/docs/video-sources/write-video-scripts.video.js +40 -0
- package/dist/docs/video-sources/write-video-scripts.video.js.map +1 -0
- package/dist/docs/videos.d.ts +56 -0
- package/dist/docs/videos.d.ts.map +1 -0
- package/dist/docs/videos.js +37 -0
- package/dist/docs/videos.js.map +1 -0
- package/dist/index.d.ts +4 -10
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -6
- package/dist/index.js.map +1 -1
- package/dist/src/asset.d.ts.map +1 -1
- package/dist/src/asset.js +3 -4
- package/dist/src/asset.js.map +1 -1
- package/dist/src/autoZoom.d.ts +3 -33
- package/dist/src/autoZoom.d.ts.map +1 -1
- package/dist/src/autoZoom.js +46 -51
- package/dist/src/autoZoom.js.map +1 -1
- package/dist/src/changeFocus.d.ts.map +1 -1
- package/dist/src/changeFocus.js +5 -5
- package/dist/src/changeFocus.js.map +1 -1
- package/dist/src/config.d.ts +5 -7
- package/dist/src/config.d.ts.map +1 -1
- package/dist/src/config.js +41 -71
- package/dist/src/config.js.map +1 -1
- package/dist/src/cue.d.ts +13 -26
- package/dist/src/cue.d.ts.map +1 -1
- package/dist/src/cue.js +70 -101
- package/dist/src/cue.js.map +1 -1
- package/dist/src/customVoiceRef.d.ts +3 -0
- package/dist/src/customVoiceRef.d.ts.map +1 -0
- package/dist/src/customVoiceRef.js +7 -0
- package/dist/src/customVoiceRef.js.map +1 -0
- package/dist/src/defaults.d.ts +5 -9
- package/dist/src/defaults.d.ts.map +1 -1
- package/dist/src/defaults.js +11 -9
- package/dist/src/defaults.js.map +1 -1
- package/dist/src/events.d.ts +7 -6
- package/dist/src/events.d.ts.map +1 -1
- package/dist/src/events.js +17 -0
- package/dist/src/events.js.map +1 -1
- package/dist/src/fileSystemName.d.ts +2 -0
- package/dist/src/fileSystemName.d.ts.map +1 -0
- package/dist/src/fileSystemName.js +44 -0
- package/dist/src/fileSystemName.js.map +1 -0
- package/dist/src/hide.d.ts +1 -1
- package/dist/src/hide.d.ts.map +1 -1
- package/dist/src/hide.js +12 -15
- package/dist/src/hide.js.map +1 -1
- package/dist/src/instrument.d.ts +1 -0
- package/dist/src/instrument.d.ts.map +1 -1
- package/dist/src/instrument.js +33 -17
- package/dist/src/instrument.js.map +1 -1
- package/dist/src/manualZoom.d.ts.map +1 -1
- package/dist/src/manualZoom.js +13 -13
- package/dist/src/manualZoom.js.map +1 -1
- package/dist/src/mouse.d.ts.map +1 -1
- package/dist/src/mouse.js +4 -1
- package/dist/src/mouse.js.map +1 -1
- package/dist/src/recording.d.ts +2 -2
- package/dist/src/recording.d.ts.map +1 -1
- package/dist/src/runtimeContext.d.ts +81 -0
- package/dist/src/runtimeContext.d.ts.map +1 -0
- package/dist/src/runtimeContext.js +95 -0
- package/dist/src/runtimeContext.js.map +1 -0
- package/dist/src/runtimeMode.d.ts +8 -0
- package/dist/src/runtimeMode.d.ts.map +1 -0
- package/dist/src/runtimeMode.js +22 -0
- package/dist/src/runtimeMode.js.map +1 -0
- package/dist/src/titleValidation.d.ts +3 -0
- package/dist/src/titleValidation.d.ts.map +1 -0
- package/dist/src/titleValidation.js +19 -0
- package/dist/src/titleValidation.js.map +1 -0
- package/dist/src/types.d.ts +27 -15
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/types.js.map +1 -1
- package/dist/src/video.d.ts +6 -1
- package/dist/src/video.d.ts.map +1 -1
- package/dist/src/video.js +94 -46
- package/dist/src/video.js.map +1 -1
- package/dist/src/voices.d.ts +8 -11
- package/dist/src/voices.d.ts.map +1 -1
- package/dist/src/voices.js +13 -8
- package/dist/src/voices.js.map +1 -1
- package/dist/src/zoom.d.ts +1 -1
- package/dist/src/zoom.d.ts.map +1 -1
- package/dist/test-fixtures/record-all-or-nothing.config.d.ts +8 -0
- package/dist/test-fixtures/record-all-or-nothing.config.d.ts.map +1 -0
- package/dist/test-fixtures/record-all-or-nothing.config.js +7 -0
- package/dist/test-fixtures/record-all-or-nothing.config.js.map +1 -0
- package/dist/test-fixtures/record-upload-all-or-nothing.config.d.ts +8 -0
- package/dist/test-fixtures/record-upload-all-or-nothing.config.d.ts.map +1 -0
- package/dist/test-fixtures/record-upload-all-or-nothing.config.js +7 -0
- package/dist/test-fixtures/record-upload-all-or-nothing.config.js.map +1 -0
- package/dist/test-fixtures/record-upload.config.d.ts +5 -0
- package/dist/test-fixtures/record-upload.config.d.ts.map +1 -0
- package/dist/test-fixtures/record-upload.config.js +4 -0
- package/dist/test-fixtures/record-upload.config.js.map +1 -0
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +3 -2
- package/skills/screenci/SKILL.md +6 -1
- package/skills/screenci/references/init.md +10 -12
- package/dist/src/reporter.d.ts +0 -9
- package/dist/src/reporter.d.ts.map +0 -1
- package/dist/src/reporter.js +0 -50
- package/dist/src/reporter.js.map +0 -1
- package/dist/src/sanitize.d.ts +0 -5
- package/dist/src/sanitize.d.ts.map +0 -1
- package/dist/src/sanitize.js +0 -11
- package/dist/src/sanitize.js.map +0 -1
|
@@ -0,0 +1,521 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Source of truth for ScreenCI docs information architecture.
|
|
3
|
+
* Slugs are web-facing and stable even if source filenames change.
|
|
4
|
+
*/
|
|
5
|
+
export declare const docsManifest: readonly [{
|
|
6
|
+
readonly source: "installation.md";
|
|
7
|
+
readonly slug: "docs";
|
|
8
|
+
readonly section: "Getting Started";
|
|
9
|
+
readonly order: 1;
|
|
10
|
+
readonly navLabel: "Installation";
|
|
11
|
+
readonly title: "Installation";
|
|
12
|
+
readonly description: "Install ScreenCI, initialize a project, run the starter video locally, and record your first final video.";
|
|
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
|
+
readonly next: "docs/generating-videos";
|
|
25
|
+
}, {
|
|
26
|
+
readonly source: "generating-videos.md";
|
|
27
|
+
readonly slug: "docs/generating-videos";
|
|
28
|
+
readonly section: "Getting Started";
|
|
29
|
+
readonly order: 3;
|
|
30
|
+
readonly navLabel: "Generating videos";
|
|
31
|
+
readonly title: "Generating Videos";
|
|
32
|
+
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";
|
|
35
|
+
}, {
|
|
36
|
+
readonly source: "run-and-debug-videos.md";
|
|
37
|
+
readonly slug: "docs/run-and-debug-videos";
|
|
38
|
+
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.";
|
|
43
|
+
readonly prev: "docs/generating-videos";
|
|
44
|
+
readonly next: "docs/record-and-publish";
|
|
45
|
+
}, {
|
|
46
|
+
readonly source: "record-and-publish.md";
|
|
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
|
+
readonly next: "docs/ci-setup";
|
|
55
|
+
}, {
|
|
56
|
+
readonly source: "ci-setup.md";
|
|
57
|
+
readonly slug: "docs/ci-setup";
|
|
58
|
+
readonly section: "Getting Started";
|
|
59
|
+
readonly order: 6;
|
|
60
|
+
readonly navLabel: "CI setup";
|
|
61
|
+
readonly title: "CI Setup";
|
|
62
|
+
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";
|
|
65
|
+
}, {
|
|
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.";
|
|
73
|
+
readonly prev: "docs/ci-setup";
|
|
74
|
+
readonly next: "docs/guides/narration-and-localization";
|
|
75
|
+
}, {
|
|
76
|
+
readonly source: "narration-and-localization.md";
|
|
77
|
+
readonly slug: "docs/guides/narration-and-localization";
|
|
78
|
+
readonly section: "Guides";
|
|
79
|
+
readonly order: 1;
|
|
80
|
+
readonly navLabel: "Narration and localization";
|
|
81
|
+
readonly title: "Narration and Localization";
|
|
82
|
+
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";
|
|
84
|
+
readonly next: "docs/guides/camera-and-zooming";
|
|
85
|
+
}, {
|
|
86
|
+
readonly source: "camera-and-zooming.md";
|
|
87
|
+
readonly slug: "docs/guides/camera-and-zooming";
|
|
88
|
+
readonly section: "Guides";
|
|
89
|
+
readonly order: 2;
|
|
90
|
+
readonly navLabel: "Camera and zooming";
|
|
91
|
+
readonly title: "Camera and Zooming";
|
|
92
|
+
readonly description: "Choose between autoZoom and manual framing, and use camera direction to guide attention without making the video frantic.";
|
|
93
|
+
readonly prev: "docs/guides/narration-and-localization";
|
|
94
|
+
readonly next: "docs/guides/assets-and-overlays";
|
|
95
|
+
}, {
|
|
96
|
+
readonly source: "assets-and-overlays.md";
|
|
97
|
+
readonly slug: "docs/guides/assets-and-overlays";
|
|
98
|
+
readonly section: "Guides";
|
|
99
|
+
readonly order: 3;
|
|
100
|
+
readonly navLabel: "Assets and overlays";
|
|
101
|
+
readonly title: "Assets and Overlays";
|
|
102
|
+
readonly description: "Add intro clips, corner logos, transition assets, and timed overlays to ScreenCI recordings.";
|
|
103
|
+
readonly prev: "docs/guides/camera-and-zooming";
|
|
104
|
+
readonly next: "docs/guides/public-urls-and-embeds";
|
|
105
|
+
}, {
|
|
106
|
+
readonly source: "public-urls-and-embeds.md";
|
|
107
|
+
readonly slug: "docs/guides/public-urls-and-embeds";
|
|
108
|
+
readonly section: "Guides";
|
|
109
|
+
readonly order: 4;
|
|
110
|
+
readonly navLabel: "Public URLs and embeds";
|
|
111
|
+
readonly title: "Public URLs and Embeds";
|
|
112
|
+
readonly description: "Enable public delivery for a video, understand stable language-specific URLs, and embed ScreenCI outputs in other sites.";
|
|
113
|
+
readonly prev: "docs/guides/assets-and-overlays";
|
|
114
|
+
readonly next: "docs/guides/update-screenci";
|
|
115
|
+
}, {
|
|
116
|
+
readonly source: "update-screenci.md";
|
|
117
|
+
readonly slug: "docs/guides/update-screenci";
|
|
118
|
+
readonly section: "Guides";
|
|
119
|
+
readonly order: 5;
|
|
120
|
+
readonly navLabel: "Update ScreenCI";
|
|
121
|
+
readonly title: "Update ScreenCI";
|
|
122
|
+
readonly description: "Upgrade the screenci package, refresh Playwright when needed, and verify that existing videos still behave as expected.";
|
|
123
|
+
readonly prev: "docs/guides/public-urls-and-embeds";
|
|
124
|
+
readonly next: "docs/reference/cli";
|
|
125
|
+
}, {
|
|
126
|
+
readonly source: "cli.md";
|
|
127
|
+
readonly slug: "docs/reference/cli";
|
|
128
|
+
readonly section: "Reference";
|
|
129
|
+
readonly order: 1;
|
|
130
|
+
readonly navLabel: "CLI";
|
|
131
|
+
readonly title: "CLI";
|
|
132
|
+
readonly description: "Command reference for screenci init, test, record, project info, and public delivery commands.";
|
|
133
|
+
readonly prev: "docs/guides/update-screenci";
|
|
134
|
+
readonly next: "docs/reference/configuration";
|
|
135
|
+
}, {
|
|
136
|
+
readonly source: "configuration.md";
|
|
137
|
+
readonly slug: "docs/reference/configuration";
|
|
138
|
+
readonly section: "Reference";
|
|
139
|
+
readonly order: 2;
|
|
140
|
+
readonly navLabel: "Configuration";
|
|
141
|
+
readonly title: "Configuration";
|
|
142
|
+
readonly description: "Configure project identity, file locations, rendering defaults, upload behavior, and Playwright integration in screenci.config.ts.";
|
|
143
|
+
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
|
+
readonly next: "docs/reference/public-delivery-api";
|
|
155
|
+
}, {
|
|
156
|
+
readonly source: "public-delivery-api.md";
|
|
157
|
+
readonly slug: "docs/reference/public-delivery-api";
|
|
158
|
+
readonly section: "Reference";
|
|
159
|
+
readonly order: 4;
|
|
160
|
+
readonly navLabel: "Public delivery API";
|
|
161
|
+
readonly title: "Public Delivery API";
|
|
162
|
+
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";
|
|
164
|
+
readonly next: "docs/reference/api";
|
|
165
|
+
}];
|
|
166
|
+
export declare const docsSections: readonly ["Getting Started", "Guides", "Reference"];
|
|
167
|
+
export declare function getDocBySlug(slug: string): {
|
|
168
|
+
readonly source: "installation.md";
|
|
169
|
+
readonly slug: "docs";
|
|
170
|
+
readonly section: "Getting Started";
|
|
171
|
+
readonly order: 1;
|
|
172
|
+
readonly navLabel: "Installation";
|
|
173
|
+
readonly title: "Installation";
|
|
174
|
+
readonly description: "Install ScreenCI, initialize a project, run the starter video locally, and record your first final video.";
|
|
175
|
+
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
|
+
readonly next: "docs/generating-videos";
|
|
187
|
+
} | {
|
|
188
|
+
readonly source: "generating-videos.md";
|
|
189
|
+
readonly slug: "docs/generating-videos";
|
|
190
|
+
readonly section: "Getting Started";
|
|
191
|
+
readonly order: 3;
|
|
192
|
+
readonly navLabel: "Generating videos";
|
|
193
|
+
readonly title: "Generating Videos";
|
|
194
|
+
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";
|
|
197
|
+
} | {
|
|
198
|
+
readonly source: "run-and-debug-videos.md";
|
|
199
|
+
readonly slug: "docs/run-and-debug-videos";
|
|
200
|
+
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.";
|
|
205
|
+
readonly prev: "docs/generating-videos";
|
|
206
|
+
readonly next: "docs/record-and-publish";
|
|
207
|
+
} | {
|
|
208
|
+
readonly source: "record-and-publish.md";
|
|
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
|
+
readonly next: "docs/ci-setup";
|
|
217
|
+
} | {
|
|
218
|
+
readonly source: "ci-setup.md";
|
|
219
|
+
readonly slug: "docs/ci-setup";
|
|
220
|
+
readonly section: "Getting Started";
|
|
221
|
+
readonly order: 6;
|
|
222
|
+
readonly navLabel: "CI setup";
|
|
223
|
+
readonly title: "CI Setup";
|
|
224
|
+
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";
|
|
227
|
+
} | {
|
|
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.";
|
|
235
|
+
readonly prev: "docs/ci-setup";
|
|
236
|
+
readonly next: "docs/guides/narration-and-localization";
|
|
237
|
+
} | {
|
|
238
|
+
readonly source: "narration-and-localization.md";
|
|
239
|
+
readonly slug: "docs/guides/narration-and-localization";
|
|
240
|
+
readonly section: "Guides";
|
|
241
|
+
readonly order: 1;
|
|
242
|
+
readonly navLabel: "Narration and localization";
|
|
243
|
+
readonly title: "Narration and Localization";
|
|
244
|
+
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";
|
|
246
|
+
readonly next: "docs/guides/camera-and-zooming";
|
|
247
|
+
} | {
|
|
248
|
+
readonly source: "camera-and-zooming.md";
|
|
249
|
+
readonly slug: "docs/guides/camera-and-zooming";
|
|
250
|
+
readonly section: "Guides";
|
|
251
|
+
readonly order: 2;
|
|
252
|
+
readonly navLabel: "Camera and zooming";
|
|
253
|
+
readonly title: "Camera and Zooming";
|
|
254
|
+
readonly description: "Choose between autoZoom and manual framing, and use camera direction to guide attention without making the video frantic.";
|
|
255
|
+
readonly prev: "docs/guides/narration-and-localization";
|
|
256
|
+
readonly next: "docs/guides/assets-and-overlays";
|
|
257
|
+
} | {
|
|
258
|
+
readonly source: "assets-and-overlays.md";
|
|
259
|
+
readonly slug: "docs/guides/assets-and-overlays";
|
|
260
|
+
readonly section: "Guides";
|
|
261
|
+
readonly order: 3;
|
|
262
|
+
readonly navLabel: "Assets and overlays";
|
|
263
|
+
readonly title: "Assets and Overlays";
|
|
264
|
+
readonly description: "Add intro clips, corner logos, transition assets, and timed overlays to ScreenCI recordings.";
|
|
265
|
+
readonly prev: "docs/guides/camera-and-zooming";
|
|
266
|
+
readonly next: "docs/guides/public-urls-and-embeds";
|
|
267
|
+
} | {
|
|
268
|
+
readonly source: "public-urls-and-embeds.md";
|
|
269
|
+
readonly slug: "docs/guides/public-urls-and-embeds";
|
|
270
|
+
readonly section: "Guides";
|
|
271
|
+
readonly order: 4;
|
|
272
|
+
readonly navLabel: "Public URLs and embeds";
|
|
273
|
+
readonly title: "Public URLs and Embeds";
|
|
274
|
+
readonly description: "Enable public delivery for a video, understand stable language-specific URLs, and embed ScreenCI outputs in other sites.";
|
|
275
|
+
readonly prev: "docs/guides/assets-and-overlays";
|
|
276
|
+
readonly next: "docs/guides/update-screenci";
|
|
277
|
+
} | {
|
|
278
|
+
readonly source: "update-screenci.md";
|
|
279
|
+
readonly slug: "docs/guides/update-screenci";
|
|
280
|
+
readonly section: "Guides";
|
|
281
|
+
readonly order: 5;
|
|
282
|
+
readonly navLabel: "Update ScreenCI";
|
|
283
|
+
readonly title: "Update ScreenCI";
|
|
284
|
+
readonly description: "Upgrade the screenci package, refresh Playwright when needed, and verify that existing videos still behave as expected.";
|
|
285
|
+
readonly prev: "docs/guides/public-urls-and-embeds";
|
|
286
|
+
readonly next: "docs/reference/cli";
|
|
287
|
+
} | {
|
|
288
|
+
readonly source: "cli.md";
|
|
289
|
+
readonly slug: "docs/reference/cli";
|
|
290
|
+
readonly section: "Reference";
|
|
291
|
+
readonly order: 1;
|
|
292
|
+
readonly navLabel: "CLI";
|
|
293
|
+
readonly title: "CLI";
|
|
294
|
+
readonly description: "Command reference for screenci init, test, record, project info, and public delivery commands.";
|
|
295
|
+
readonly prev: "docs/guides/update-screenci";
|
|
296
|
+
readonly next: "docs/reference/configuration";
|
|
297
|
+
} | {
|
|
298
|
+
readonly source: "configuration.md";
|
|
299
|
+
readonly slug: "docs/reference/configuration";
|
|
300
|
+
readonly section: "Reference";
|
|
301
|
+
readonly order: 2;
|
|
302
|
+
readonly navLabel: "Configuration";
|
|
303
|
+
readonly title: "Configuration";
|
|
304
|
+
readonly description: "Configure project identity, file locations, rendering defaults, upload behavior, and Playwright integration in screenci.config.ts.";
|
|
305
|
+
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
|
+
readonly next: "docs/reference/public-delivery-api";
|
|
317
|
+
} | {
|
|
318
|
+
readonly source: "public-delivery-api.md";
|
|
319
|
+
readonly slug: "docs/reference/public-delivery-api";
|
|
320
|
+
readonly section: "Reference";
|
|
321
|
+
readonly order: 4;
|
|
322
|
+
readonly navLabel: "Public delivery API";
|
|
323
|
+
readonly title: "Public Delivery API";
|
|
324
|
+
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";
|
|
326
|
+
readonly next: "docs/reference/api";
|
|
327
|
+
} | undefined;
|
|
328
|
+
export declare function getOutputPathFromSlug(slug: string): string;
|
|
329
|
+
export declare function getGeneratedDocsManifest(): ({
|
|
330
|
+
outputPath: string;
|
|
331
|
+
source: "installation.md";
|
|
332
|
+
slug: "docs";
|
|
333
|
+
section: "Getting Started";
|
|
334
|
+
order: 1;
|
|
335
|
+
navLabel: "Installation";
|
|
336
|
+
title: "Installation";
|
|
337
|
+
description: "Install ScreenCI, initialize a project, run the starter video locally, and record your first final video.";
|
|
338
|
+
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
|
+
next: "docs/generating-videos";
|
|
351
|
+
} | {
|
|
352
|
+
outputPath: string;
|
|
353
|
+
source: "generating-videos.md";
|
|
354
|
+
slug: "docs/generating-videos";
|
|
355
|
+
section: "Getting Started";
|
|
356
|
+
order: 3;
|
|
357
|
+
navLabel: "Generating videos";
|
|
358
|
+
title: "Generating Videos";
|
|
359
|
+
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";
|
|
362
|
+
} | {
|
|
363
|
+
outputPath: string;
|
|
364
|
+
source: "run-and-debug-videos.md";
|
|
365
|
+
slug: "docs/run-and-debug-videos";
|
|
366
|
+
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.";
|
|
371
|
+
prev: "docs/generating-videos";
|
|
372
|
+
next: "docs/record-and-publish";
|
|
373
|
+
} | {
|
|
374
|
+
outputPath: string;
|
|
375
|
+
source: "record-and-publish.md";
|
|
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
|
+
next: "docs/ci-setup";
|
|
384
|
+
} | {
|
|
385
|
+
outputPath: string;
|
|
386
|
+
source: "ci-setup.md";
|
|
387
|
+
slug: "docs/ci-setup";
|
|
388
|
+
section: "Getting Started";
|
|
389
|
+
order: 6;
|
|
390
|
+
navLabel: "CI setup";
|
|
391
|
+
title: "CI Setup";
|
|
392
|
+
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";
|
|
395
|
+
} | {
|
|
396
|
+
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.";
|
|
404
|
+
prev: "docs/ci-setup";
|
|
405
|
+
next: "docs/guides/narration-and-localization";
|
|
406
|
+
} | {
|
|
407
|
+
outputPath: string;
|
|
408
|
+
source: "narration-and-localization.md";
|
|
409
|
+
slug: "docs/guides/narration-and-localization";
|
|
410
|
+
section: "Guides";
|
|
411
|
+
order: 1;
|
|
412
|
+
navLabel: "Narration and localization";
|
|
413
|
+
title: "Narration and Localization";
|
|
414
|
+
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";
|
|
416
|
+
next: "docs/guides/camera-and-zooming";
|
|
417
|
+
} | {
|
|
418
|
+
outputPath: string;
|
|
419
|
+
source: "camera-and-zooming.md";
|
|
420
|
+
slug: "docs/guides/camera-and-zooming";
|
|
421
|
+
section: "Guides";
|
|
422
|
+
order: 2;
|
|
423
|
+
navLabel: "Camera and zooming";
|
|
424
|
+
title: "Camera and Zooming";
|
|
425
|
+
description: "Choose between autoZoom and manual framing, and use camera direction to guide attention without making the video frantic.";
|
|
426
|
+
prev: "docs/guides/narration-and-localization";
|
|
427
|
+
next: "docs/guides/assets-and-overlays";
|
|
428
|
+
} | {
|
|
429
|
+
outputPath: string;
|
|
430
|
+
source: "assets-and-overlays.md";
|
|
431
|
+
slug: "docs/guides/assets-and-overlays";
|
|
432
|
+
section: "Guides";
|
|
433
|
+
order: 3;
|
|
434
|
+
navLabel: "Assets and overlays";
|
|
435
|
+
title: "Assets and Overlays";
|
|
436
|
+
description: "Add intro clips, corner logos, transition assets, and timed overlays to ScreenCI recordings.";
|
|
437
|
+
prev: "docs/guides/camera-and-zooming";
|
|
438
|
+
next: "docs/guides/public-urls-and-embeds";
|
|
439
|
+
} | {
|
|
440
|
+
outputPath: string;
|
|
441
|
+
source: "public-urls-and-embeds.md";
|
|
442
|
+
slug: "docs/guides/public-urls-and-embeds";
|
|
443
|
+
section: "Guides";
|
|
444
|
+
order: 4;
|
|
445
|
+
navLabel: "Public URLs and embeds";
|
|
446
|
+
title: "Public URLs and Embeds";
|
|
447
|
+
description: "Enable public delivery for a video, understand stable language-specific URLs, and embed ScreenCI outputs in other sites.";
|
|
448
|
+
prev: "docs/guides/assets-and-overlays";
|
|
449
|
+
next: "docs/guides/update-screenci";
|
|
450
|
+
} | {
|
|
451
|
+
outputPath: string;
|
|
452
|
+
source: "update-screenci.md";
|
|
453
|
+
slug: "docs/guides/update-screenci";
|
|
454
|
+
section: "Guides";
|
|
455
|
+
order: 5;
|
|
456
|
+
navLabel: "Update ScreenCI";
|
|
457
|
+
title: "Update ScreenCI";
|
|
458
|
+
description: "Upgrade the screenci package, refresh Playwright when needed, and verify that existing videos still behave as expected.";
|
|
459
|
+
prev: "docs/guides/public-urls-and-embeds";
|
|
460
|
+
next: "docs/reference/cli";
|
|
461
|
+
} | {
|
|
462
|
+
outputPath: string;
|
|
463
|
+
source: "cli.md";
|
|
464
|
+
slug: "docs/reference/cli";
|
|
465
|
+
section: "Reference";
|
|
466
|
+
order: 1;
|
|
467
|
+
navLabel: "CLI";
|
|
468
|
+
title: "CLI";
|
|
469
|
+
description: "Command reference for screenci init, test, record, project info, and public delivery commands.";
|
|
470
|
+
prev: "docs/guides/update-screenci";
|
|
471
|
+
next: "docs/reference/configuration";
|
|
472
|
+
} | {
|
|
473
|
+
outputPath: string;
|
|
474
|
+
source: "configuration.md";
|
|
475
|
+
slug: "docs/reference/configuration";
|
|
476
|
+
section: "Reference";
|
|
477
|
+
order: 2;
|
|
478
|
+
navLabel: "Configuration";
|
|
479
|
+
title: "Configuration";
|
|
480
|
+
description: "Configure project identity, file locations, rendering defaults, upload behavior, and Playwright integration in screenci.config.ts.";
|
|
481
|
+
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
|
+
next: "docs/reference/public-delivery-api";
|
|
494
|
+
} | {
|
|
495
|
+
outputPath: string;
|
|
496
|
+
source: "public-delivery-api.md";
|
|
497
|
+
slug: "docs/reference/public-delivery-api";
|
|
498
|
+
section: "Reference";
|
|
499
|
+
order: 4;
|
|
500
|
+
navLabel: "Public delivery API";
|
|
501
|
+
title: "Public Delivery API";
|
|
502
|
+
description: "Technical reference for the unauthenticated endpoints that serve published videos, thumbnails, subtitles, and metadata.";
|
|
503
|
+
prev: "docs/reference/video-authoring-api-overview";
|
|
504
|
+
next: "docs/reference/api";
|
|
505
|
+
})[];
|
|
506
|
+
type TypedocSidebarItem = {
|
|
507
|
+
label: string;
|
|
508
|
+
};
|
|
509
|
+
export declare function getDocsSidebarConfig(typedocSidebarGroup?: TypedocSidebarItem | null): {
|
|
510
|
+
label: "Getting Started" | "Guides" | "Reference";
|
|
511
|
+
items: ({
|
|
512
|
+
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";
|
|
513
|
+
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";
|
|
514
|
+
} | TypedocSidebarItem)[];
|
|
515
|
+
}[];
|
|
516
|
+
export declare function getPrevNextLinkConfig(slug: string | null): false | {
|
|
517
|
+
label: string;
|
|
518
|
+
link: string;
|
|
519
|
+
};
|
|
520
|
+
export {};
|
|
521
|
+
//# sourceMappingURL=manifest.d.ts.map
|
|
@@ -0,0 +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,UAGjD;AAED,wBAAgB,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAKvC;AAUD,KAAK,kBAAkB,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,CAAA;AAE3C,wBAAgB,oBAAoB,CAClC,mBAAmB,CAAC,EAAE,kBAAkB,GAAG,IAAI;;;;;;IAiBhD;AAED,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;;;EAkBxD"}
|