npm - screenci - Versions diffs - 0.0.68 → 0.0.70 - Mend

screenci 0.0.68 → 0.0.70

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 (161) hide show

package/README.md +45 -122
package/dist/cli.d.ts +3 -18
package/dist/cli.d.ts.map +1 -1
package/dist/cli.js +117 -158
package/dist/cli.js.map +1 -1
package/dist/docs/manifest.d.ts +66 -35
package/dist/docs/manifest.d.ts.map +1 -1
package/dist/docs/manifest.js +22 -11
package/dist/docs/manifest.js.map +1 -1
package/dist/docs/video-sources/cli.screenci.d.ts +2 -0
package/dist/docs/video-sources/cli.screenci.d.ts.map +1 -0
package/dist/docs/video-sources/{cli.video.js → cli.screenci.js} +1 -1
package/dist/docs/video-sources/cli.screenci.js.map +1 -0
package/dist/docs/video-sources/installation.screenci.d.ts +2 -0
package/dist/docs/video-sources/installation.screenci.d.ts.map +1 -0
package/dist/docs/video-sources/{installation.video.js → installation.screenci.js} +1 -1
package/dist/docs/video-sources/installation.screenci.js.map +1 -0
package/dist/docs/video-sources/landing.screenci.d.ts +2 -0
package/dist/docs/video-sources/landing.screenci.d.ts.map +1 -0
package/dist/docs/video-sources/{landing.video.js → landing.screenci.js} +1 -1
package/dist/docs/video-sources/landing.screenci.js.map +1 -0
package/dist/docs/video-sources/locator-highlight-animated.screenci.d.ts +2 -0
package/dist/docs/video-sources/locator-highlight-animated.screenci.d.ts.map +1 -0
package/dist/docs/video-sources/locator-highlight-animated.screenci.js +53 -0
package/dist/docs/video-sources/locator-highlight-animated.screenci.js.map +1 -0
package/dist/docs/video-sources/locator-highlight-still.screenci.d.ts +2 -0
package/dist/docs/video-sources/locator-highlight-still.screenci.d.ts.map +1 -0
package/dist/docs/video-sources/locator-highlight-still.screenci.js +24 -0
package/dist/docs/video-sources/locator-highlight-still.screenci.js.map +1 -0
package/dist/docs/video-sources/product-pitch.screenci.d.ts +2 -0
package/dist/docs/video-sources/product-pitch.screenci.d.ts.map +1 -0
package/dist/docs/video-sources/product-pitch.screenci.js +136 -0
package/dist/docs/video-sources/product-pitch.screenci.js.map +1 -0
package/dist/docs/video-sources/public-urls.screenci.d.ts +2 -0
package/dist/docs/video-sources/public-urls.screenci.d.ts.map +1 -0
package/dist/docs/video-sources/public-urls.screenci.js +34 -0
package/dist/docs/video-sources/public-urls.screenci.js.map +1 -0
package/dist/docs/video-sources/studio.screenci.d.ts +2 -0
package/dist/docs/video-sources/studio.screenci.d.ts.map +1 -0
package/dist/docs/video-sources/studio.screenci.js +57 -0
package/dist/docs/video-sources/studio.screenci.js.map +1 -0
package/dist/docs/videos.d.ts +36 -15
package/dist/docs/videos.d.ts.map +1 -1
package/dist/docs/videos.js +27 -2
package/dist/docs/videos.js.map +1 -1
package/dist/e2e/htmlRasterizer.e2e.d.ts +2 -0
package/dist/e2e/htmlRasterizer.e2e.d.ts.map +1 -0
package/dist/e2e/htmlRasterizer.e2e.js +107 -0
package/dist/e2e/htmlRasterizer.e2e.js.map +1 -0
package/dist/e2e/screenshot.e2e.d.ts +2 -0
package/dist/e2e/screenshot.e2e.d.ts.map +1 -0
package/dist/e2e/screenshot.e2e.js +73 -0
package/dist/e2e/screenshot.e2e.js.map +1 -0
package/dist/index.d.ts +10 -4
package/dist/index.d.ts.map +1 -1
package/dist/index.js +5 -2
package/dist/index.js.map +1 -1
package/dist/src/asset.d.ts +245 -53
package/dist/src/asset.d.ts.map +1 -1
package/dist/src/asset.js +718 -77
package/dist/src/asset.js.map +1 -1
package/dist/src/audio.d.ts +127 -0
package/dist/src/audio.d.ts.map +1 -0
package/dist/src/audio.js +207 -0
package/dist/src/audio.js.map +1 -0
package/dist/src/config.d.ts.map +1 -1
package/dist/src/config.js +9 -3
package/dist/src/config.js.map +1 -1
package/dist/src/contextOptions.d.ts +48 -0
package/dist/src/contextOptions.d.ts.map +1 -0
package/dist/src/contextOptions.js +71 -0
package/dist/src/contextOptions.js.map +1 -0
package/dist/src/crop.d.ts +93 -0
package/dist/src/crop.d.ts.map +1 -0
package/dist/src/crop.js +133 -0
package/dist/src/crop.js.map +1 -0
package/dist/src/cue.d.ts +17 -4
package/dist/src/cue.d.ts.map +1 -1
package/dist/src/cue.js +31 -3
package/dist/src/cue.js.map +1 -1
package/dist/src/defaults.d.ts +13 -1
package/dist/src/defaults.d.ts.map +1 -1
package/dist/src/defaults.js +13 -0
package/dist/src/defaults.js.map +1 -1
package/dist/src/dimensions.d.ts +6 -0
package/dist/src/dimensions.d.ts.map +1 -1
package/dist/src/dimensions.js +15 -0
package/dist/src/dimensions.js.map +1 -1
package/dist/src/events.d.ts +283 -13
package/dist/src/events.d.ts.map +1 -1
package/dist/src/events.js +134 -5
package/dist/src/events.js.map +1 -1
package/dist/src/htmlRasterizer.d.ts +153 -0
package/dist/src/htmlRasterizer.d.ts.map +1 -0
package/dist/src/htmlRasterizer.js +386 -0
package/dist/src/htmlRasterizer.js.map +1 -0
package/dist/src/init.d.ts +17 -0
package/dist/src/init.d.ts.map +1 -1
package/dist/src/init.js +131 -11
package/dist/src/init.js.map +1 -1
package/dist/src/linkSession.d.ts +36 -0
package/dist/src/linkSession.d.ts.map +1 -0
package/dist/src/linkSession.js +122 -0
package/dist/src/linkSession.js.map +1 -0
package/dist/src/overlayFlush.d.ts +18 -0
package/dist/src/overlayFlush.d.ts.map +1 -0
package/dist/src/overlayFlush.js +56 -0
package/dist/src/overlayFlush.js.map +1 -0
package/dist/src/overlayRect.d.ts +69 -0
package/dist/src/overlayRect.d.ts.map +1 -0
package/dist/src/overlayRect.js +55 -0
package/dist/src/overlayRect.js.map +1 -0
package/dist/src/performance.d.ts +1 -3
package/dist/src/performance.d.ts.map +1 -1
package/dist/src/performance.js +0 -12
package/dist/src/performance.js.map +1 -1
package/dist/src/recording.d.ts +3 -2
package/dist/src/recording.d.ts.map +1 -1
package/dist/src/recordingData.d.ts +22 -2
package/dist/src/recordingData.d.ts.map +1 -1
package/dist/src/runtimeContext.d.ts +57 -1
package/dist/src/runtimeContext.d.ts.map +1 -1
package/dist/src/runtimeContext.js +40 -0
package/dist/src/runtimeContext.js.map +1 -1
package/dist/src/screenshot.d.ts +105 -0
package/dist/src/screenshot.d.ts.map +1 -0
package/dist/src/screenshot.js +188 -0
package/dist/src/screenshot.js.map +1 -0
package/dist/src/stillCapture.d.ts +68 -0
package/dist/src/stillCapture.d.ts.map +1 -0
package/dist/src/stillCapture.js +119 -0
package/dist/src/stillCapture.js.map +1 -0
package/dist/src/studio.d.ts +8 -11
package/dist/src/studio.d.ts.map +1 -1
package/dist/src/studio.js +2 -25
package/dist/src/studio.js.map +1 -1
package/dist/src/types.d.ts +125 -15
package/dist/src/types.d.ts.map +1 -1
package/dist/src/types.js.map +1 -1
package/dist/src/video.d.ts +54 -1
package/dist/src/video.d.ts.map +1 -1
package/dist/src/video.js +190 -42
package/dist/src/video.js.map +1 -1
package/dist/src/voices.d.ts +22 -9
package/dist/src/voices.d.ts.map +1 -1
package/dist/src/voices.js +6 -24
package/dist/src/voices.js.map +1 -1
package/dist/tsconfig.tsbuildinfo +1 -1
package/package.json +16 -2
package/skills/screenci/SKILL.md +37 -15
package/skills/screenci/references/init.md +3 -1
package/skills/screenci/references/record.md +8 -3
package/dist/docs/video-sources/cli.video.d.ts +0 -2
package/dist/docs/video-sources/cli.video.d.ts.map +0 -1
package/dist/docs/video-sources/cli.video.js.map +0 -1
package/dist/docs/video-sources/installation.video.d.ts +0 -2
package/dist/docs/video-sources/installation.video.d.ts.map +0 -1
package/dist/docs/video-sources/installation.video.js.map +0 -1
package/dist/docs/video-sources/landing.video.d.ts +0 -2
package/dist/docs/video-sources/landing.video.d.ts.map +0 -1
package/dist/docs/video-sources/landing.video.js.map +0 -1

package/dist/src/asset.d.ts CHANGED Viewed

@@ -1,85 +1,267 @@
+import type { Locator } from '@playwright/test';
 import type { IEventRecorder } from './events.js';
-export type SvgPath = `${string}.svg`;
-export type PngPath = `${string}.png`;
-export type Mp4Path = `${string}.mp4`;
+export { setOverlayCss } from './htmlRasterizer.js';
+export type { OverlayPlacement } from './events.js';
 /**
- * Image assets are timed overlays. The duration must be recorded up front so
- * rendering never needs to probe image files for timing.
+ * Minimal structural stand-in for a React element. Defined here so the core SDK
+ * never has to depend on `@types/react`: any JSX element is assignable to this,
+ * while a plain {@link OverlayConfig} object is not (it has no `type`/`props`).
+ * React itself is detected structurally at runtime and rendered lazily, so it
+ * stays an optional peer dependency.
  */
-export type ImageAssetConfig<TPath extends SvgPath | PngPath = SvgPath | PngPath> = {
-    path: TPath;
-    durationMs: number;
-    fullScreen: boolean;
-    audio?: never;
+export type ReactElementLike = {
+    type: unknown;
+    props: unknown;
+    key?: string | null;
 };
 /**
- * Video assets use their natural media duration. Audio is allowed only here so
- * the API cannot attach soundtrack controls to still-image overlays. When
- * omitted, audio defaults to full volume for `.mp4` playback.
+ * Display options for an overlay. Placement fields are flat (not nested) and use
+ * CSS pixels in the recording viewport (the same space as Playwright's
+ * `boundingBox()`, `page.mouse`, and `viewportSize()`), each defaulting
+ * independently: `relativeTo: 'recording'`, `x: 0`, `y: 0`. Provide exactly one
+ * of `width`/`height` (the other follows the source aspect, or `aspectRatio`).
+ * When no placement field is set, the overlay fills the recording area.
  */
-export type VideoAssetConfig<TPath extends Mp4Path = Mp4Path> = {
-    path: TPath;
+export type OverlayConfig = {
+    /** File path: `.html` (rendered), `.svg`/`.png` (image), or `.mp4` (video). */
+    path?: string;
+    /**
+     * A React element, rendered to a transparent PNG. Use this for overlays built
+     * in JSX. Provide exactly one source: `path`, `element`, or `html`.
+     */
+    element?: ReactElementLike;
+    /**
+     * An inline HTML fragment, rendered to a transparent PNG. Use this when you
+     * want plain HTML without a React dependency or a separate `.html` file. It
+     * must be a fragment (for example `'<div class="badge">New</div>'`), never a
+     * full document: `<!doctype>`, `<html>`, `<head>`, and `<body>` tags are
+     * rejected because screenci wraps the markup in its own document. Provide
+     * exactly one source: `path`, `element`, or `html`.
+     */
+    html?: string;
+    /** Reference box for placement coordinates. Defaults to `'recording'`. */
+    relativeTo?: 'screen' | 'recording';
+    /** Left edge in CSS px of the recording viewport. Defaults to `0`. */
+    x?: number;
+    /** Top edge in CSS px of the recording viewport. Defaults to `0`. */
+    y?: number;
+    /** Width in CSS px. Provide instead of `height` (exactly one). */
+    width?: number;
+    /** Height in CSS px. Provide instead of `width` (exactly one). */
+    height?: number;
+    /**
+     * Aspect ratio (`width / height`) used to derive the unset axis from the one
+     * you provide, instead of the source's intrinsic aspect. Optional.
+     */
+    aspectRatio?: number;
+    /** Fill the whole output frame. Overrides x/y/width/height. */
+    fullScreen?: boolean;
+    /**
+     * Position the overlay over a live element, captured at recording time from
+     * the locator's bounding box. The overlay is sized to that box (plus
+     * {@link margin}) and fills it, so it frames the element exactly. Overrides
+     * `x`/`y`/`width`/`height`/`relativeTo`/`fullScreen` (placement is always
+     * recording-relative). HTML files, inline `html`, and React elements only;
+     * your content should fill its box (for example `width:100%;height:100%`).
+     */
+    over?: Locator;
+    /**
+     * Extra space (CSS px) added around the {@link over} element on every side,
+     * so the overlay surrounds it rather than sitting exactly on its edges. Only
+     * valid together with `over`.
+     */
+    margin?: number;
+    /**
+     * Visible length for the blocking call form (`await overlays.logo(1200)`).
+     * Omit when driving with `start()`/`end()`. Image/HTML/React overlays only.
+     *
+     * For animated overlays (`animate: true`) this is also the capture length: it
+     * is required when driving with `start()`/`end()` (the capture length is
+     * otherwise unknown).
+     */
+    durationMs?: number;
+    /**
+     * Capture the overlay as an animation so its CSS/JS animation plays back in
+     * the video (HTML files and React elements only). The animation is sampled
+     * over the resolved duration with a transparent background preserved.
+     */
+    animate?: boolean;
+    /** Animation capture frame rate. Only valid with `animate`. Defaults to `30`. */
+    fps?: number;
+    /**
+     * Extra CSS injected into the overlay document so it can be styled with
+     * `className` (for example a compiled Tailwind stylesheet). Merged on top of
+     * any global CSS set via `setOverlayCss`. HTML files and React elements only.
+     */
+    css?: string;
+    /**
+     * Transparent padding (CSS px) added around the overlay content. Lets an
+     * animation move, scale, or rotate beyond its box without being clipped (an
+     * automatic "stage"), at the cost of the placement sizing the padded box.
+     * HTML files and React elements only.
+     */
+    capturePadding?: number;
+    /**
+     * Soundtrack level for `.mp4` overlays as a linear gain. `1` (the default)
+     * plays the source at its natural level, `0` mutes it, and values above `1`
+     * boost it (e.g. `2` is twice the natural level). Capped at
+     * {@link MAX_AUDIO_LEVEL}.
+     */
     audio?: number;
-    fullScreen: boolean;
-    durationMs?: never;
+    /**
+     * Playback-rate multiplier for `.mp4` overlays. `2` plays the clip (and its
+     * audio) twice as fast, `0.5` at half speed; `1` (the default) is the natural
+     * rate. Works like {@link speed} for a recording. For a blocking overlay
+     * (`await overlays.clip()`) this also shortens or lengthens the window it
+     * holds, so later content shifts; a live overlay (`start()`/`end()`) keeps
+     * its window and just plays the source faster/slower inside it. Mutually
+     * exclusive with {@link time}. Video overlays only.
+     */
+    speed?: number;
+    /**
+     * Target playback duration (ms) for a `.mp4` overlay, an alternative to
+     * {@link speed}: the clip is sped up or slowed down so its source plays over
+     * exactly this long. Works like {@link time} for a recording. Mutually
+     * exclusive with {@link speed}. Video overlays only.
+     */
+    time?: number;
 };
-export type AssetConfig = ImageAssetConfig<SvgPath | PngPath> | VideoAssetConfig<Mp4Path>;
-type AssetConfigForPath<TPath extends string> = string extends TPath ? AssetConfig : TPath extends SvgPath | PngPath ? ImageAssetConfig<TPath> : TPath extends Mp4Path ? VideoAssetConfig<TPath> : never;
+/**
+ * Upper bound for an audio level (linear gain). `4` is +12 dB, plenty of
+ * headroom for a boost while guarding against accidental extreme distortion.
+ */
+export declare const MAX_AUDIO_LEVEL = 4;
+/**
+ * A value accepted by {@link createOverlays} for each key:
+ *
+ * - a `string` file path (`.html`/`.svg`/`.png`/`.mp4`),
+ * - a React element, or
+ * - an {@link OverlayConfig} object.
+ */
+export type OverlayInput = string | ReactElementLike | OverlayConfig;
+/**
+ * A factory that builds an {@link OverlayConfig} from caller-supplied props.
+ * Use this to make an overlay programmatic: the returned config (its content and
+ * its placement) can depend on values only known at runtime, for example a
+ * locator's position captured with {@link overlayRect}. Both the `element`/`html`
+ * content and the placement may vary per call.
+ *
+ * @example
+ * ```tsx
+ * const overlays = createOverlays({
+ *   note: (p: { text: string }) => ({ html: `<div class="note">${p.text}</div>` }),
+ * })
+ * await overlays.note({ text: 'Saved' })(1200)
+ * ```
+ */
+export type OverlayConfigFactory<P = unknown> = (props: P) => OverlayConfig;
+/**
+ * A value accepted by {@link createOverlays}: a static input or a config
+ * factory. The factory arm uses a `never` parameter so a factory with any
+ * concrete props type is assignable (function parameters are contravariant);
+ * {@link OverlayControllerFor} then recovers the real props type per key.
+ */
+export type OverlayInputOrFactory = OverlayInput | ((props: never) => OverlayConfig);
+export declare function setAssetSleepFn(fn: (ms: number) => void): void;
 export declare function setActiveAssetRecorder(recorder: IEventRecorder | null): void;
 export declare function resetRegisteredAssetPaths(): void;
+export declare function resetAssetChain(): void;
 export declare function validateRegisteredAssetPaths(testFilePath: string): Promise<void>;
 /**
- * An asset controller.
+ * An overlay controller.
  *
- * Calling it marks the asset in the recording timeline. The renderer places
- * the asset at this point in the video. Images use explicit `durationMs`
- * overlays; `.mp4` assets use the media file's natural duration.
+ * Calling it shows the overlay over a frozen frame for a fixed duration
+ * (blocking). Use `start()`/`end()` to keep the overlay on screen while the page
+ * is driven underneath.
+ *
+ * Overlays may overlap: several can be live at once (interleaved, not just
+ * nested), and a blocking overlay can run while others stay live. Each overlay
+ * you `start()` must be `end()`ed before the video function returns, and the
+ * same overlay cannot be started twice without ending it in between.
  *
  * @example
  * ```ts
- * await assets.intro()
- * await page.goto('/dashboard')
- * await assets.logo()
+ * // Blocking: hold the overlay for 1.2s, then continue.
+ * await overlays.logo(1200)
+ *
+ * // Live: keep the overlay up while interacting with the page.
+ * await overlays.badge.start()
+ * await page.click('#next')
+ * await overlays.badge.end()
+ *
+ * // Overlapping: two overlays live at the same time, ended independently.
+ * await overlays.badge.start()
+ * await overlays.logo.start()
+ * await page.click('#next')
+ * await overlays.badge.end()
+ * await overlays.logo.end()
  * ```
  */
-export type AssetController = () => Promise<void>;
-/** Typed asset controllers keyed by the names passed to {@link createAssets}. */
-export type Assets<T extends Record<string, AssetConfig>> = {
-    [K in keyof T]: AssetController;
+export type OverlayController = {
+    (durationMs?: number): Promise<void>;
+    start(): Promise<void>;
+    end(): Promise<void>;
 };
 /**
- * Creates a set of typed asset controllers, one per key in the map.
+ * The controller type for one {@link createOverlays} value: a static input
+ * (string/element/config) yields a plain {@link OverlayController}; a config
+ * factory yields a `(props) => OverlayController` so props are passed at the
+ * call site. A static input is never callable, so it never matches the factory
+ * arm: existing static maps keep exactly today's controller type.
+ */
+export type OverlayControllerFor<V> = V extends (props: infer P) => OverlayConfig ? (props: P) => OverlayController : OverlayController;
+/** Typed overlay controllers keyed by the names passed to {@link createOverlays}. */
+export type Overlays<T extends Record<string, OverlayInputOrFactory>> = {
+    [K in keyof T]: OverlayControllerFor<T[K]>;
+};
+/**
+ * Creates a set of typed overlay controllers, one per key in the map. Each value
+ * is a file path string, a React element, or an {@link OverlayConfig} object.
+ * A config can draw its content from exactly one source: a file `path`, a React
+ * `element`, or an inline `html` fragment.
+ *
+ * Calling a controller shows the overlay in the recording timeline. Image
+ * (`.svg`/`.png`), HTML, and React overlays need a `durationMs` (in the config
+ * or passed to the blocking call) unless driven with `start()`/`end()`; `.mp4`
+ * overlays use their natural duration and default `audio` to `1` (natural level).
  *
- * Calling a controller marks the asset in the recording timeline.
- * `.svg`/`.png` assets require explicit `durationMs`; `.mp4` assets use their
- * natural duration and default `audio` to `1` when omitted.
+ * Placement defaults to the full recording area (`relativeTo: 'recording'`);
+ * override any field independently. Coordinates are CSS px of the recording
+ * viewport.
  *
  * @example
- * ```ts
- * const assets = createAssets({
- *   logo:  { path: './logo.png',  durationMs: 1200, fullScreen: false },
- *   intro: { path: './intro.mp4', fullScreen: true },
+ * ```tsx
+ * const overlays = createOverlays({
+ *   hint:  'callout.html',                       // HTML file
+ *   badge: <Badge label="New" />,                // React element
+ *   note:  { html: '<div class="note">Tip</div>', x: 1340, y: 110, width: 380 },
+ *   logo:  { path: 'logo.png', x: 96, y: 96, width: 240 },
+ *   intro: { path: 'intro.mp4', fullScreen: true },
  * })
  *
  * video('Product demo', async ({ page }) => {
- *   await assets.intro()
+ *   await overlays.intro()
  *   await page.goto('/dashboard')
- *   await assets.logo()
+ *   await overlays.logo(1200)
  * })
  * ```
+ *
+ * A value can also be an {@link OverlayConfigFactory} `(props) => OverlayConfig`,
+ * making the overlay programmatic. Calling `overlays.name(props)` builds and
+ * returns a controller you then drive with `(durationMs)`, `start()`, or
+ * `end()`. The factory runs (and its config is validated) on each call, so
+ * content and placement can depend on runtime values.
  */
-export declare function createAssets<const T extends Record<string, AssetConfig>>(assetsMap: T & {
-    [K in keyof T]: AssetConfigForPath<T[K]['path']>;
-}): Assets<T>;
+export declare function createOverlays<const T extends Record<string, OverlayInputOrFactory>>(overlays: T): Overlays<T>;
 /**
- * Creates typed asset controllers whose files and display options are
+ * Creates typed overlay controllers whose files and display options are
  * configured on the ScreenCI Studio page instead of in code. Business tier
  * only.
  *
- * Each key becomes a callable asset controller with the same timeline
- * behavior as {@link createAssets} controllers. The file (`.svg`, `.png`, or
- * `.mp4`), full-screen mode, image duration, and video audio level all come
- * from Studio.
+ * Each key becomes a callable overlay controller with the same timeline
+ * behavior as {@link createOverlays} controllers, including `start()`/`end()`.
+ * The file (`.svg`, `.png`, or `.mp4`), placement, image duration, and video
+ * audio level all come from Studio.
  *
  * On the first upload of a studio-mode video, rendering is held until the
  * video is configured in Studio (the CLI prints a direct link). Later uploads
@@ -87,15 +269,25 @@ export declare function createAssets<const T extends Record<string, AssetConfig>
  *
  * @example
  * ```ts
- * const assets = createStudioAssets('intro', 'logo')
+ * const overlays = createStudioOverlays('intro', 'logo')
  *
  * video('Product demo', async ({ page }) => {
- *   await assets.intro()
+ *   await overlays.intro()
  *   await page.goto('/dashboard')
- *   await assets.logo()
+ *   await overlays.logo()
  * })
  * ```
  */
-export declare function createStudioAssets<const K extends readonly [string, ...string[]]>(...keys: K): Record<K[number], AssetController>;
-export {};
+export declare function createStudioOverlays<const K extends readonly [string, ...string[]]>(...keys: K): Record<K[number], OverlayController>;
+/**
+ * Upper bound for a playback-speed multiplier. `16` is already an extreme rate;
+ * the cap guards against accidental runaway values producing degenerate output.
+ */
+export declare const MAX_SPEED = 16;
+/**
+ * Validates a `speed`/`time` pair shared by `.mp4` overlays and audio tracks.
+ * `speed` must be a finite multiplier in `(0, MAX_SPEED]`; `time` must be a
+ * finite duration greater than 0 (ms). They are mutually exclusive.
+ */
+export declare function validateSpeedTime(label: string, speed: number | undefined, time: number | undefined): void;
 //# sourceMappingURL=asset.d.ts.map

package/dist/src/asset.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"asset.d.ts","sourceRoot":"","sources":["../../src/asset.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,~~cAAc~~,EAAE,MAAM,~~aAAa~~,CAAA;~~AASjD~~,~~MAAM~~,MAAM,OAAO,~~GAAG~~,~~GAAG~~,MAAM,MAAM,CAAA;~~AACrC~~,MAAM,MAAM,~~OAAO~~,GAAG,~~GAAG~~,~~MAAM~~,~~MAAM~~,CAAA;~~AACrC~~,~~MAAM~~,~~MAAM~~,OAAO,~~GAAG~~,GAAG,~~MAAM~~,MAAM,CAAA;~~AAErC;;;GAGG~~;AACH,MAAM,MAAM,~~gBAAgB~~,~~CAC1B~~,~~KAAK~~,~~SAAS~~,~~OAAO~~,~~GAAG~~,OAAO,~~GAAG~~,~~OAAO~~,~~GAAG~~,~~OAAO,IACjD~~;~~IACF~~,IAAI,EAAE,~~KAAK~~,CAAA;~~IACX~~,UAAU,EAAE,MAAM,CAAA;~~IAClB~~,~~UAAU~~,EAAE,~~OAAO~~,CAAA;~~IACnB~~,KAAK,CAAC,EAAE,~~KAAK~~,CAAA;~~CACd~~,~~CAAA~~;~~AAED;;;;GAIG;AACH~~,MAAM,MAAM,~~gBAAgB~~,CAAC,~~KAAK~~,~~SAAS~~,~~OAAO~~,~~GAAG~~,OAAO,~~IAAI~~;~~IAC9D~~,IAAI,EAAE,~~KAAK~~,CAAA;~~IACX~~,~~KAAK~~,CAAC,EAAE,MAAM,CAAA;~~IACd~~,UAAU,EAAE,~~OAAO~~,CAAA;IACnB,~~UAAU~~,CAAC,EAAE,~~KAAK~~,CAAA;~~CACnB~~,~~CAAA~~;~~AAED~~,~~MAAM~~,MAAM,~~WAAW~~,~~GACnB~~,~~gBAAgB,~~CAAC,~~OAAO~~,~~GAAG~~,~~OAAO~~,CAAC,~~GACnC~~,~~gBAAgB~~,~~CAAC~~,~~OAAO~~,CAAC,CAAA;~~AAE7B~~,KAAK,~~kBAAkB~~,CAAC,~~KAAK~~,~~SAAS~~,MAAM,IAAI,MAAM,~~SAAS~~,~~KAAK~~,~~GAChE~~,~~WAAW~~,~~GACX~~,~~KAAK~~,~~SAAS~~,~~OAAO~~,GAAG,OAAO,~~GAC7B~~,~~gBAAgB~~,CAAC,KAAK,CAAC,~~GACvB~~,KAAK,~~SAAS~~,~~OAAO~~,~~GACnB~~,~~gBAAgB~~,CAAC,~~KAAK~~,CAAC,~~GACvB~~,KAAK,~~CAAA~~;~~AAIb~~,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,cAAc,GAAG,IAAI,GAAG,IAAI,~~CAE5E~~;AAED,wBAAgB,yBAAyB,IAAI,IAAI,CAEhD;AAED,wBAAsB,4BAA4B,CAChD,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,IAAI,CAAC,CAIf;~~AAuBD;;;;;;;;;;;;;GAaG~~;AACH,MAAM,MAAM,~~eAAe~~,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;~~AAEjD~~,~~iFAAiF~~;~~AACjF~~,~~MAAM~~,~~MAAM~~,~~MAAM~~,CAAC,CAAC,~~SAAS~~,MAAM,~~CAAC,~~MAAM,~~EAAE~~,~~WAAW~~,CAAC,IAAI~~;KACzD~~,CAAC,~~IAAI~~,MAAM,CAAC,~~GAAG~~,~~eAAe;CAChC~~,~~CAAA;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH~~,~~wBAAgB~~,~~YAAY~~,CAAC,KAAK,~~CAAC~~,~~CAAC~~,~~SAAS~~,~~MAAM~~,~~CAAC~~,MAAM,~~EAAE~~,~~WAAW~~,CAAC,~~EACtE~~,SAAS,EAAE,CAAC,~~GAAG~~;~~KAAG~~,CAAC,IAAI,MAAM,CAAC,GAAG,~~kBAAkB~~,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,~~MAAM~~,CAAC,CAAC~~;CAAE~~,~~GAClE~~,MAAM,CAAC,CAAC,CAAC,~~CAWX~~;~~AAED~~;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,~~kBAAkB~~,~~CAChC~~,KAAK,CAAC,CAAC,SAAS,SAAS,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,EAC9C,GAAG,IAAI,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,~~eAAe~~,CAAC,~~CAgBhD~~"}
1	+ {"version":3,"file":"asset.d.ts","sourceRoot":"","sources":["../../src/asset.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAA;AAC/C,OAAO,KAAK,EAAE,cAAc,EAAoB,MAAM,aAAa,CAAA;AAWnE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAWnD,YAAY,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAEnD;;;;;;GAMG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,EAAE,OAAO,CAAA;IACb,KAAK,EAAE,OAAO,CAAA;IACd,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CACpB,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,+EAA+E;IAC/E,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;OAGG;IACH,OAAO,CAAC,EAAE,gBAAgB,CAAA;IAC1B;;;;;;;OAOG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,0EAA0E;IAC1E,UAAU,CAAC,EAAE,QAAQ,GAAG,WAAW,CAAA;IACnC,sEAAsE;IACtE,CAAC,CAAC,EAAE,MAAM,CAAA;IACV,qEAAqE;IACrE,CAAC,CAAC,EAAE,MAAM,CAAA;IACV,kEAAkE;IAClE,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,kEAAkE;IAClE,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,+DAA+D;IAC/D,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB;;;;;;;OAOG;IACH,IAAI,CAAC,EAAE,OAAO,CAAA;IACd;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,iFAAiF;IACjF,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;;;;;;OAQG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,eAAe,IAAI,CAAA;AAEhC;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,gBAAgB,GAAG,aAAa,CAAA;AAEpE;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,oBAAoB,CAAC,CAAC,GAAG,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,aAAa,CAAA;AAE3E;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,GAC7B,YAAY,GACZ,CAAC,CAAC,KAAK,EAAE,KAAK,KAAK,aAAa,CAAC,CAAA;AAgBrC,wBAAgB,eAAe,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI,CAE9D;AAQD,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,cAAc,GAAG,IAAI,GAAG,IAAI,CAG5E;AAED,wBAAgB,yBAAyB,IAAI,IAAI,CAEhD;AAED,wBAAgB,eAAe,IAAI,IAAI,CAEtC;AAED,wBAAsB,4BAA4B,CAChD,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,IAAI,CAAC,CAIf;AAkCD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACpC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IACtB,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;CACrB,CAAA;AAED;;;;;;GAMG;AACH,MAAM,MAAM,oBAAoB,CAAC,CAAC,IAAI,CAAC,SAAS,CAC9C,KAAK,EAAE,MAAM,CAAC,KACX,aAAa,GACd,CAAC,KAAK,EAAE,CAAC,KAAK,iBAAiB,GAC/B,iBAAiB,CAAA;AAErB,qFAAqF;AACrF,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,IAAI;KACrE,CAAC,IAAI,MAAM,CAAC,GAAG,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC3C,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,wBAAgB,cAAc,CAC5B,KAAK,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,EACrD,QAAQ,EAAE,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAM1B;AAsWD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,oBAAoB,CAClC,KAAK,CAAC,CAAC,SAAS,SAAS,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,EAC9C,GAAG,IAAI,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,iBAAiB,CAAC,CAgBlD;AA+UD;;;GAGG;AACH,eAAO,MAAM,SAAS,KAAK,CAAA;AAE3B;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,GAAG,SAAS,EACzB,IAAI,EAAE,MAAM,GAAG,SAAS,GACvB,IAAI,CAmBN"}