screenci 0.0.78 → 0.0.80
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 +12 -12
- package/dist/cli.d.ts +14 -21
- package/dist/cli.d.ts.map +1 -1
- package/dist/cli.js +58 -367
- package/dist/cli.js.map +1 -1
- package/dist/docs/video-sources/installation.screenci.js +2 -10
- package/dist/docs/video-sources/installation.screenci.js.map +1 -1
- package/dist/src/init.d.ts +10 -10
- package/dist/src/init.d.ts.map +1 -1
- package/dist/src/init.js +73 -60
- package/dist/src/init.js.map +1 -1
- package/dist/src/linkSession.d.ts +25 -28
- package/dist/src/linkSession.d.ts.map +1 -1
- package/dist/src/linkSession.js +74 -58
- package/dist/src/linkSession.js.map +1 -1
- package/dist/src/localize.d.ts +3 -2
- package/dist/src/localize.d.ts.map +1 -1
- package/dist/src/localize.js +3 -3
- package/dist/src/localize.js.map +1 -1
- package/dist/src/video.d.ts +7 -9
- package/dist/src/video.d.ts.map +1 -1
- package/dist/src/video.js +5 -7
- package/dist/src/video.js.map +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +1 -1
- package/skills/screenci/SKILL.md +32 -41
- package/skills/screenci/references/init.md +7 -7
- package/skills/screenci/references/record.md +8 -7
- package/dist/src/openBrowser.d.ts +0 -34
- package/dist/src/openBrowser.d.ts.map +0 -1
- package/dist/src/openBrowser.js +0 -62
- package/dist/src/openBrowser.js.map +0 -1
package/README.md
CHANGED
|
@@ -71,18 +71,18 @@ but remap its rendered duration.
|
|
|
71
71
|
|
|
72
72
|
## Authoring helpers
|
|
73
73
|
|
|
74
|
-
| Export
|
|
75
|
-
|
|
|
76
|
-
| `defineConfig`
|
|
77
|
-
| `video`
|
|
78
|
-
| `video.
|
|
79
|
-
| `hide`
|
|
80
|
-
| `autoZoom`
|
|
81
|
-
| `zoomTo`
|
|
82
|
-
| `resetZoom`
|
|
83
|
-
| `createOverlays`
|
|
84
|
-
| `voices`
|
|
85
|
-
| `modelTypes`
|
|
74
|
+
| Export | What it does |
|
|
75
|
+
| ----------------- | ------------------------------------------------------------ |
|
|
76
|
+
| `defineConfig` | Wraps Playwright config with ScreenCI defaults |
|
|
77
|
+
| `video` | Declares a video recording test |
|
|
78
|
+
| `video.narration` | Declares narration cues (per language or shared) for a video |
|
|
79
|
+
| `hide` | Cuts setup or cleanup out of the visible recording |
|
|
80
|
+
| `autoZoom` | Smooth camera follow for an interaction block |
|
|
81
|
+
| `zoomTo` | Manual camera framing for a locator or point |
|
|
82
|
+
| `resetZoom` | Returns from manual framing to the full viewport |
|
|
83
|
+
| `createOverlays` | Inserts timed media overlays into the recording timeline |
|
|
84
|
+
| `voices` | Available voice constants such as `voices.Ava` |
|
|
85
|
+
| `modelTypes` | Narration model constants |
|
|
86
86
|
|
|
87
87
|
See the [docs](https://screenci.com/docs) for configuration, narration,
|
|
88
88
|
camera, and CI setup.
|
package/dist/cli.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { RecordingCustomVoiceRef, RecordingData } from './src/events.js';
|
|
2
2
|
import type { VoiceKey } from './src/voices.js';
|
|
3
|
-
import type { RecordUploadPolicy } from './src/types.js';
|
|
3
|
+
import type { RecordUploadPolicy, ScreenCIConfig } from './src/types.js';
|
|
4
4
|
import { getCliLinkSessionApiUrl, getDevBackendUrl, getDevFrontendUrl } from './src/linkSession.js';
|
|
5
5
|
export { getCliLinkSessionApiUrl, getDevBackendUrl, getDevFrontendUrl };
|
|
6
6
|
type PlaywrightListReportSuite = {
|
|
@@ -51,9 +51,6 @@ export type StudioUploadNotice = {
|
|
|
51
51
|
};
|
|
52
52
|
export declare function formatStudioUrl(appUrl: string, projectId: string, videoId: string): string;
|
|
53
53
|
type OrgPlan = 'free' | 'starter' | 'business';
|
|
54
|
-
export declare class SignInTimeoutError extends Error {
|
|
55
|
-
constructor(message: string);
|
|
56
|
-
}
|
|
57
54
|
export declare function withUploadRetry<T>(fn: () => Promise<T>, signal: AbortSignal | undefined, maxAttempts?: number): Promise<T>;
|
|
58
55
|
export declare function attachUploadAbortStdinListener(input: Pick<NodeJS.ReadStream, 'on' | 'off' | 'pause'>, onAbort: (signal: NodeJS.Signals) => void): () => void;
|
|
59
56
|
export declare function clearRecordingDirectories(dir: string): void;
|
|
@@ -67,6 +64,13 @@ export declare function annotateRecordingDataWithAssetHashes(data: RecordingData
|
|
|
67
64
|
* shapeless bodies fall back to the original text unchanged.
|
|
68
65
|
*/
|
|
69
66
|
export declare function extractBackendError(responseText: string): string;
|
|
67
|
+
/**
|
|
68
|
+
* Whether an upload-start error body flags a missing ElevenLabs key. The backend
|
|
69
|
+
* fails the render immediately and replies with `{ elevenLabsKeyMissing: true }`
|
|
70
|
+
* so the CLI can surface the dedicated Secrets-link error instead of a generic
|
|
71
|
+
* upload failure. Non-JSON or shapeless bodies are treated as not flagged.
|
|
72
|
+
*/
|
|
73
|
+
export declare function responseFlagsElevenLabsKeyMissing(responseText: string): boolean;
|
|
70
74
|
export declare function formatUploadStartFailureMessage(videoName: string, status: number, responseText: string, secret: string): string;
|
|
71
75
|
export declare function formatFailedVideoMessage(videoName: string, message: string): string;
|
|
72
76
|
export declare function printUploadStartFailureMessage(videoName: string, status: number, responseText: string, secret: string): void;
|
|
@@ -124,28 +128,17 @@ export declare function extractConfigStringLiteral(configSource: string, propert
|
|
|
124
128
|
export declare function extractRecordUploadPolicyLiteral(configSource: string): RecordUploadPolicy | undefined;
|
|
125
129
|
export declare function extractMockRecordLiteral(configSource: string): boolean | undefined;
|
|
126
130
|
export declare function getConfigModuleSpecifier(resolvedConfigPath: string): string;
|
|
131
|
+
export declare function requireScreenCISecret(configPath?: string): Promise<{
|
|
132
|
+
resolvedConfigPath: string;
|
|
133
|
+
screenciConfig: ScreenCIConfig;
|
|
134
|
+
secret: string;
|
|
135
|
+
apiUrl: string;
|
|
136
|
+
}>;
|
|
127
137
|
export declare function extractGrep(args: string[]): string | undefined;
|
|
128
|
-
export declare function ensureScreenciSecret(resolvedConfigPath?: string, opts?: {
|
|
129
|
-
interactive?: boolean;
|
|
130
|
-
pollAuth?: boolean;
|
|
131
|
-
noPollAuth?: boolean;
|
|
132
|
-
}): Promise<string | undefined>;
|
|
133
|
-
/**
|
|
134
|
-
* `screenci login`: get a sign-in link in front of a human as early as
|
|
135
|
-
* possible. It reuses the link `init` (or a prior run) persisted, or creates a
|
|
136
|
-
* fresh one, tries to open it in the browser best-effort, and always prints it
|
|
137
|
-
* as a fallback. It does NOT wait for sign-in to finish: the agent can run this,
|
|
138
|
-
* keep authoring and `test`ing, then `record` (which blocks for sign-in) once
|
|
139
|
-
* the script is green. If sign-in already completed, it saves the secret and
|
|
140
|
-
* exits.
|
|
141
|
-
*/
|
|
142
|
-
export declare function runLogin(configPath?: string): Promise<void>;
|
|
143
138
|
export declare function main(): Promise<void>;
|
|
144
139
|
export declare function parseRecordCliArgs(args: string[]): {
|
|
145
140
|
configPath: string | undefined;
|
|
146
141
|
verbose: boolean;
|
|
147
|
-
pollAuth: boolean;
|
|
148
|
-
noPollAuth: boolean;
|
|
149
142
|
remote: boolean;
|
|
150
143
|
languages: string | undefined;
|
|
151
144
|
otherArgs: string[];
|
package/dist/cli.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../cli.ts"],"names":[],"mappings":"AA8BA,OAAO,KAAK,EACV,uBAAuB,EACvB,aAAa,EAEd,MAAM,iBAAiB,CAAA;AAUxB,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,KAAK,EAAE,kBAAkB,
|
|
1
|
+
{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../cli.ts"],"names":[],"mappings":"AA8BA,OAAO,KAAK,EACV,uBAAuB,EACvB,aAAa,EAEd,MAAM,iBAAiB,CAAA;AAUxB,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,KAAK,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAKxE,OAAO,EACL,uBAAuB,EACvB,gBAAgB,EAChB,iBAAiB,EAElB,MAAM,sBAAsB,CAAA;AAM7B,OAAO,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,CAAA;AAWvE,KAAK,yBAAyB,GAAG;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,KAAK,CAAC,EAAE,KAAK,CAAC;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;IAChC,MAAM,CAAC,EAAE,yBAAyB,EAAE,CAAA;CACrC,CAAA;AAUD;;;;;;;;GAQG;AACH,wBAAgB,wBAAwB,CACtC,GAAG,GAAE,MAAM,CAAC,UAAwB,EACpC,MAAM,GAAE;IAAE,KAAK,CAAC,EAAE,OAAO,CAAA;CAAmB,EAC5C,KAAK,GAAE;IAAE,KAAK,CAAC,EAAE,OAAO,CAAA;CAAkB,GACzC,OAAO,CAIT;AAED,wBAAgB,2BAA2B,CACzC,MAAM,EAAE,SAAS,yBAAyB,EAAE,GAC3C,MAAM,EAAE,CAiBV;AA0ND,6EAA6E;AAC7E,KAAK,eAAe,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,CAAA;AAY7D,KAAK,mBAAmB,GAAG;IACzB,IAAI,EAAE,eAAe,CAAA;IACrB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,WAAW,CAAC,EAAE,MAAM,CAAA;IAIpB,YAAY,CAAC,EAAE,OAAO,CAAA;IAMtB,YAAY,CAAC,EAAE,OAAO,CAAA;IAItB,eAAe,CAAC,EAAE,OAAO,CAAA;CAC1B,CAAA;AASD,MAAM,MAAM,gBAAgB,GAAG;IAAE,IAAI,EAAE,IAAI,CAAA;CAAE,GAAG;IAAE,OAAO,EAAE,IAAI,CAAA;CAAE,CAAA;AAEjE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,MAAM,EAAE,gBAAgB,CAAA;CACzB,CAAA;AAED,wBAAgB,eAAe,CAC7B,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,GACd,MAAM,CAIR;AAED,KAAK,OAAO,GAAG,MAAM,GAAG,SAAS,GAAG,UAAU,CAAA;AAsE9C,wBAAsB,eAAe,CAAC,CAAC,EACrC,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EACpB,MAAM,EAAE,WAAW,GAAG,SAAS,EAC/B,WAAW,SAAI,GACd,OAAO,CAAC,CAAC,CAAC,CAWZ;AA0XD,wBAAgB,8BAA8B,CAC5C,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,IAAI,GAAG,KAAK,GAAG,OAAO,CAAC,EACtD,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,KAAK,IAAI,GACxC,MAAM,IAAI,CAiBZ;AAwOD,wBAAgB,yBAAyB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAU3D;AA4MD,wBAAsB,mBAAmB,CACvC,IAAI,EAAE,aAAa,EACnB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAgNhC;AAED,wBAAgB,cAAc,CAC5B,KAAK,EAAE,QAAQ,GAAG,uBAAuB,EACzC,MAAM,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GAC3B,QAAQ,GAAG,uBAAuB,CAYpC;AAED,wBAAgB,oCAAoC,CAClD,IAAI,EAAE,aAAa,EACnB,MAAM,EAAE,mBAAmB,EAAE,GAC5B,aAAa,CAmGf;AAQD;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAWhE;AAED;;;;;GAKG;AACH,wBAAgB,iCAAiC,CAC/C,YAAY,EAAE,MAAM,GACnB,OAAO,CAUT;AAED,wBAAgB,+BAA+B,CAC7C,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,MAAM,GACb,MAAM,CAeR;AAKD,wBAAgB,wBAAwB,CACtC,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,GACd,MAAM,CASR;AAED,wBAAgB,8BAA8B,CAC5C,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,MAAM,GACb,IAAI,CAcN;AAED,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAM1D;AAID,KAAK,kBAAkB,GAAG;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;CAC3B,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAAE,QAAQ,EAAE,kBAAkB,EAAE,CAAA;CAAE,CAAA;AAEtE;;;;;;;;;;GAUG;AACH,wBAAsB,0BAA0B,CAC9C,MAAM,EAAE,mBAAmB,EAAE,EAC7B,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,WAAW,EACnB,gBAAgB,CAAC,EAAE;IAAE,IAAI,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAA;CAAE,GACrD,OAAO,CAAC,mBAAmB,EAAE,CAAC,CA0DhC;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAC1C,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,mBAAmB,EAAE,GAChC,MAAM,CASR;AAiID,wBAAsB,gBAAgB,CACpC,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,aAAa,CAAC,EAAE,MAAM,EACtB,OAAO,UAAQ,GACd,OAAO,CAAC;IACT,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,WAAW,EAAE,OAAO,CAAA;IACpB,gBAAgB,EAAE,MAAM,EAAE,CAAA;IAC1B,mBAAmB,EAAE,KAAK,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;IAClE,aAAa,EAAE,kBAAkB,EAAE,CAAA;IACnC,0BAA0B,EAAE,MAAM,EAAE,CAAA;IACpC,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,IAAI,EAAE,OAAO,GAAG,IAAI,CAAA;CACrB,CAAC,CAkID;AA4KD,wBAAsB,4BAA4B,CAChD,kBAAkB,EAAE,MAAM,GACzB,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAU7B;AAWD,wBAAgB,0BAA0B,CACxC,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,aAAa,GAAG,SAAS,GAClC,MAAM,GAAG,SAAS,CAepB;AAED,wBAAgB,gCAAgC,CAC9C,YAAY,EAAE,MAAM,GACnB,kBAAkB,GAAG,SAAS,CAmBhC;AAED,wBAAgB,wBAAwB,CACtC,YAAY,EAAE,MAAM,GACnB,OAAO,GAAG,SAAS,CAQrB;AAkCD,wBAAgB,wBAAwB,CAAC,kBAAkB,EAAE,MAAM,GAAG,MAAM,CAS3E;AAiCD,wBAAsB,qBAAqB,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACxE,kBAAkB,EAAE,MAAM,CAAA;IAC1B,cAAc,EAAE,cAAc,CAAA;IAC9B,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;CACf,CAAC,CAqBD;AA4BD,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,SAAS,CAY9D;AA0TD,wBAAsB,IAAI,kBA+OzB;AAQD,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG;IAClD,UAAU,EAAE,MAAM,GAAG,SAAS,CAAA;IAC9B,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,EAAE,OAAO,CAAA;IACf,SAAS,EAAE,MAAM,GAAG,SAAS,CAAA;IAC7B,SAAS,EAAE,MAAM,EAAE,CAAA;CACpB,CAgDA;AAsTD,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI,CAchD"}
|