playwright-director 0.2.0

package/dist/Tutorial.d.ts

@@ -0,0 +1,108 @@
+import type { Page, Locator, FrameLocator } from '@playwright/test';
+import type { TutorialOptions, StepOptions, ContextOptions, SceneFocus, FocusOptions } from './types.js';
+import { TutorialTimeline } from './timeline.js';
+/**
+ * When to start a step's action inside its narration clip (option B of
+ * docs/narration-action-overlap.md — one merged clip, computed offset).
+ *
+ * Two-phase (`doText` known): character-share estimate of where the "do"
+ * sentence ends — `duration × (len(do) + 2) / len(full)` (the +2 is the
+ * ". " separator). Single-phase: fixed 25% of the clip.
+ */
+export declare function narrationActionOffset(durationMs: number, fullText: string, doText?: string): number;
+export declare class Tutorial {
+    private page;
+    private options;
+    private initialized;
+    private testName;
+    private translateFn;
+    private voice;
+    private music;
+    private cursor;
+    private overlay;
+    private timeline;
+    private pendingItems;
+    private stepCounter;
+    private videoStartTime;
+    private scenes;
+    private activeScenes;
+    private sceneTransitionMs;
+    private variant?;
+    /** Mobile multi-scene: every scene stays on stage, focus() only marks the active one. */
+    private pinnedSplit;
+    constructor(page: Page, options: TutorialOptions);
+    private requireScene;
+    /**
+     * Mount the stage: a tab bar plus one iframe per scene.
+     *
+     * The parent page is loaded from `audioBaseUrl` first, because setContent
+     * keeps the current origin — that is what lets narration audio load without
+     * cross-origin friction, with no stage file to deploy.
+     */
+    stage(): Promise<void>;
+    /** A scene is a plain FrameLocator — the whole Playwright locator API. */
+    scene(name: string): FrameLocator;
+    /** Navigate a scene. Relative paths resolve against its baseUrl; an absolute
+     *  URL is honoured as-is, so a scene may change origin mid-tutorial. */
+    goto(name: string, url: string): Promise<void>;
+    /**
+     * Bring scene(s) to the stage. One fills it; two share it side by side.
+     * The cursor is hidden across the switch so it never streaks between panes.
+     */
+    focus(target: SceneFocus, options?: FocusOptions): Promise<void>;
+    /** What to stamp on a timeline entry: a bare name, or a pair when two
+     *  scenes shared the stage. Undefined for single-scene tutorials. */
+    private get stagedScene();
+    private sameFocus;
+    static get isEnabled(): boolean;
+    private translate;
+    clearFields(): void;
+    get hasSteps(): boolean;
+    get stepCount(): number;
+    switchPage(page: Page): void;
+    /** @deprecated Total steps are now calculated automatically. */
+    setTotalSteps(total: number): void;
+    /** @deprecated Voice preloading is now automatic when steps/contexts are added. */
+    preloadVoice(texts: string[]): Promise<void>;
+    private initialize;
+    private ensureStyles;
+    context(key: string, options?: ContextOptions): void;
+    step(key: string, action: () => Promise<void>, options?: StepOptions): void;
+    highlight(selector: string | Locator, duration?: number): Promise<void>;
+    unhighlight(selector: string | Locator): Promise<void>;
+    moveMouseToElement(locator: Locator): Promise<void>;
+    moveMouse(targetX: number, targetY: number): Promise<void>;
+    animateClick(): Promise<void>;
+    click(selector: string | Locator): Promise<void>;
+    fill(selector: string | Locator, value: string): Promise<void>;
+    typeSlowly(selector: string | Locator, value: string, delay?: number): Promise<void>;
+    /**
+     * Type a secret into a field that stays blurred. The blur is applied before
+     * the first keystroke and is NOT removed afterwards — the finished value must
+     * never become readable, or the whole point is lost. Call `unblur()` if a
+     * later step really needs the field legible again.
+     */
+    typeBlurred(selector: string | Locator, value: string, options?: {
+        delay?: number;
+        blur?: number;
+        reveal?: boolean;
+    } | number): Promise<void>;
+    /** Remove the blur left by `typeBlurred`. */
+    unblur(selector: string | Locator): Promise<void>;
+    selectOption(selector: string | Locator, value: string): Promise<void>;
+    hideOverlay(): Promise<void>;
+    showEmailPreview(options: {
+        subject: string;
+        from?: string;
+        to?: string;
+        body: string;
+        highlightCode?: string;
+        duration?: number;
+    }): Promise<void>;
+    hideEmailPreview(): Promise<void>;
+    complete(message?: string): Promise<void>;
+    getTimeline(): ReturnType<TutorialTimeline['getData']>;
+    private captureStepScreenshot;
+    deleteVideoIfEmpty(): Promise<boolean>;
+}
+//# sourceMappingURL=Tutorial.d.ts.map

package/dist/Tutorial.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Tutorial.d.ts","sourceRoot":"","sources":["../src/Tutorial.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAIpE,OAAO,KAAK,EACX,eAAe,EACf,WAAW,EACX,cAAc,EAId,UAAU,EACV,YAAY,EACZ,MAAM,YAAY,CAAC;AAMpB,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AA0DjD;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CACpC,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,MAAM,CAAC,EAAE,MAAM,GACb,MAAM,CAMR;AAID,qBAAa,QAAQ;IACpB,OAAO,CAAC,IAAI,CAAO;IAEnB,OAAO,CAAC,OAAO,CAE8B;IAC7C,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,WAAW,CAA0B;IAE7C,OAAO,CAAC,KAAK,CAAgB;IAC7B,OAAO,CAAC,KAAK,CAAgB;IAC7B,OAAO,CAAC,MAAM,CAAiB;IAC/B,OAAO,CAAC,OAAO,CAAkB;IACjC,OAAO,CAAC,QAAQ,CAAmB;IAEnC,OAAO,CAAC,YAAY,CAAqB;IACzC,OAAO,CAAC,WAAW,CAAK;IACxB,OAAO,CAAC,cAAc,CAAK;IAE3B,OAAO,CAAC,MAAM,CAA+B;IAC7C,OAAO,CAAC,YAAY,CAAgB;IACpC,OAAO,CAAC,iBAAiB,CAAS;IAClC,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,yFAAyF;IACzF,OAAO,CAAC,WAAW,CAAS;gBAEhB,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,eAAe;IA+FhD,OAAO,CAAC,YAAY;IASpB;;;;;;OAMG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAW5B,0EAA0E;IAC1E,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY;IAKjC;4EACwE;IAClE,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAgBpD;;;OAGG;IACG,KAAK,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IA+BtE;yEACqE;IACrE,OAAO,KAAK,WAAW,GAGtB;IAED,OAAO,CAAC,SAAS;IAQjB,MAAM,KAAK,SAAS,IAAI,OAAO,CAE9B;IAED,OAAO,CAAC,SAAS;IAIjB,WAAW,IAAI,IAAI;IAanB,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAED,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED,UAAU,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;IAS5B,gEAAgE;IAChE,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAKlC,mFAAmF;IAC7E,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;YAMpC,UAAU;YA+BV,YAAY;IAe1B,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,IAAI;IAuBpD,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,IAAI;IA0DrE,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IASvE,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAKtD,kBAAkB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAMnD,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAK1D,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAK7B,KAAK,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAWhD,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAW9D,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,SAAK,GAAG,OAAO,CAAC,IAAI,CAAC;IActF;;;;;OAKG;IACG,WAAW,CAChB,QAAQ,EAAE,MAAM,GAAG,OAAO,EAC1B,KAAK,EAAE,MAAM,EACb,OAAO,GAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,MAAW,GACxE,OAAO,CAAC,IAAI,CAAC;IAoBhB,6CAA6C;IACvC,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAQjD,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAWtE,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAM5B,gBAAgB,CAAC,OAAO,EAAE;QAC/B,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ,IAAI,EAAE,MAAM,CAAC;QACb,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;KAClB,GAAG,OAAO,CAAC,IAAI,CAAC;IA8CX,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC;IAKjC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAgK/C,WAAW,IAAI,UAAU,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;YAIxC,qBAAqB;IAmC7B,kBAAkB,IAAI,OAAO,CAAC,OAAO,CAAC;CAsB5C"}