npm - pro-visu - Versions diffs - 0.4.0 → 0.5.0 - Mend

pro-visu 0.4.0 → 0.5.0

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

package/README.md +22 -14
package/dist/cli/index.js +780 -347
package/dist/cli/index.js.map +1 -1
package/dist/index.d.ts +31 -29
package/dist/index.js.map +1 -1
package/dist/scene-app/assets/{index-sed_MW8w.js → index-Bu-Vjjhs.js} +1 -1
package/dist/scene-app/index.html +1 -1
package/package.json +1 -1

package/dist/index.d.ts CHANGED Viewed

@@ -1,6 +1,6 @@
 import { z } from 'zod';
-declare const easingSchema: z.ZodEnum<["linear", "easeInOutCubic", "easeInOutQuad", "easeOutCubic", "easeInOutSine", "easeInOutExpo", "easeOutQuint"]>;
+declare const easingSchema: z.ZodEnum<["linear", "ease-in-out-cubic", "ease-in-out-quad", "ease-out-cubic", "ease-in-out-sine", "ease-in-out-expo", "ease-out-quint"]>;
 type Easing = z.infer<typeof easingSchema>;
 /** One choreographed scroll step. */
 interface ChoreographyStepInput {
@@ -10,7 +10,7 @@ interface ChoreographyStepInput {
     durationMs?: number;
     /** Hold time at this target after arriving (ms). Default 800. */
     holdMs?: number;
-    /** Easing for the travel to this target. Default "easeInOutCubic". */
+    /** Easing for the travel to this target. Default "ease-in-out-cubic". */
     easing?: Easing;
 }
 /** One step of a scripted interaction (`actions` / `focus.actions`). */
@@ -83,7 +83,7 @@ interface KenBurnsInput {
     scaleFrom?: number;
     /** End scale. Default 1.08. */
     scaleTo?: number;
-    /** Easing for the zoom ramp. Default "easeInOutCubic". */
+    /** Easing for the zoom ramp. Default "ease-in-out-cubic". */
     easing?: Easing;
     /** Zoom origin X within the viewport (0 = left, 1 = right). Default 0.5. */
     originX?: number;
@@ -111,7 +111,7 @@ interface FocusInput {
     holdMs?: number;
 }
 /** One extra viewport to also capture the reel at (`viewports`). */
-interface ViewportInput {
+interface ViewportInput$1 {
     /** Name appended to the asset (<name>-<viewport name>). */
     name: string;
     /** Viewport width in CSS px. */
@@ -153,8 +153,8 @@ interface ScrollReelOptionsInput {
     /** Output frames per second (re-encoded from the recording). Default 30. */
     fps?: number;
     /** Time to scroll from top to bottom (ms). Default 6000. */
-    duration?: number;
-    /** Easing for the default top→bottom scroll. Default "easeInOutCubic". */
+    durationMs?: number;
+    /** Easing for the default top→bottom scroll. Default "ease-in-out-cubic". */
     easing?: Easing;
     /** Dwell at the top before scrolling (ms). Default 500. */
     startDelayMs?: number;
@@ -207,7 +207,7 @@ interface ScrollReelOptionsInput {
     /** Add this class to <html> before capture (e.g. to trigger a CSS-class dark theme). Omit for none. */
     themeClass?: string;
     /** Also capture the reel at these viewports; each emits an asset (<name>-<viewport name>). */
-    viewports?: ViewportInput[];
+    viewports?: ViewportInput$1[];
     /**
      * Capture several routes and concatenate them into one reel ("frames" path). Emits a single asset
      * (variants skipped; aspect/outputs apply to the final tour).
@@ -257,8 +257,8 @@ interface ScrollReelOptionsInput {
 /** Author-facing input (documented for editor hover; the schema validates it at run time). */
 type ScrollReelOptions = ScrollReelOptionsInput;
-/** A named viewport to capture at; each breakpoint emits its own asset. */
-interface BreakpointInput {
+/** A named viewport to capture at; each viewport emits its own asset. */
+interface ViewportInput {
     /** Label for this viewport — used in the filename + manifest id (e.g. "desktop"). */
     name: string;
     /** Viewport width in CSS px. */
@@ -268,10 +268,10 @@ interface BreakpointInput {
      * full page height); only affects viewport/element captures.
      */
     height?: number;
-    /** Override the generator-level `deviceScaleFactor` for this breakpoint. Omit to inherit it. */
+    /** Override the generator-level `deviceScaleFactor` for this viewport. Omit to inherit it. */
     deviceScaleFactor?: number;
 }
-/** A specific element to capture (in addition to the page) at each breakpoint. */
+/** A specific element to capture (in addition to the page) at each viewport. */
 interface ElementShotInput {
     /** CSS selector of the element to shoot. */
     selector: string;
@@ -280,14 +280,14 @@ interface ElementShotInput {
 }
 /**
  * Author-facing options for the `screenshots` generator — responsive stills of a page (one per
- * breakpoint), plus optional per-element crops. Everything is optional; sensible defaults apply.
+ * viewport), plus optional per-element crops. Everything is optional; sensible defaults apply.
  */
 interface ScreenshotsOptionsInput {
     /**
      * Viewports to capture at (at least one); each emits its own asset. Default:
      * desktop 1440×900 + mobile 390×844.
      */
-    breakpoints?: BreakpointInput[];
+    viewports?: ViewportInput[];
     /** Capture the entire scrollable page (vs. just the viewport). Default true. */
     fullPage?: boolean;
     /** Image format. Default "png". */
@@ -300,7 +300,7 @@ interface ScreenshotsOptionsInput {
     waitUntil?: "load" | "domcontentloaded" | "networkidle" | "commit";
     /** Optional element to wait for before capturing (e.g. a hero image). Omit to skip. */
     waitForSelector?: string;
-    /** Specific elements to crop (in addition to the page) at every breakpoint. Default none. */
+    /** Specific elements to crop (in addition to the page) at every viewport. Default none. */
     elements?: ElementShotInput[];
     /** Capture with a transparent background (png only). Default false. */
     omitBackground?: boolean;
@@ -318,9 +318,9 @@ type WallEasing = z.infer<typeof wallEasingEnum>;
 interface WallPulseInput {
     /** When the pulse starts, as a fraction of the clip (0..1). */
     at: number;
-    /** How long the move takes, as a fraction of the clip (0..1). If `at + duration > 1`, the start
+    /** How long the move takes, as a fraction of the clip (0..1). If `at + span > 1`, the start
      *  shifts back so the move ends at the loop point. */
-    duration: number;
+    span: number;
     /** How far it travels, in periods (1 = one full tile-set / one wrap). Usually 0..1. */
     distance: number;
     /** Easing of the move's ramp. Default "ease-in-out". */
@@ -373,8 +373,8 @@ interface WallOptionsInput {
     deviceScaleFactor?: number;
     /** Output frames per second. Default 30. */
     fps?: number;
-    /** Clip length in seconds — the whole loop. Default 16. */
-    durationSeconds?: number;
+    /** Clip length in ms — the whole loop. Default 16000. */
+    durationMs?: number;
     /** x264 quality, 0–51 (lower = better quality / larger file). Default 18. */
     crf?: number;
     /**
@@ -430,8 +430,8 @@ type WallOptions = WallOptionsInput;
 interface PulseInput {
     /** Human label for the beat, e.g. "color sweep" — purely to keep the config readable. */
     name?: string;
-    /** Length of this beat, in seconds. */
-    duration: number;
+    /** Length of this beat in ms. */
+    durationMs: number;
     /** Fraction of cells whose glyph changes during this beat (0..1; 1 = every cell once; 0 = a hold). */
     chars?: number;
     /** Fraction of cells whose color changes during this beat (0..1; 1 = every cell once). */
@@ -496,8 +496,8 @@ interface SpecimenOptionsInput {
     demo?: boolean;
     /** Output frames per second. Default 30. */
     fps?: number;
-    /** Clip length in seconds. Defaults to the (mirrored) sum of the pulse durations; set to override. */
-    durationSeconds?: number;
+    /** Clip length in ms. Defaults to the (mirrored) sum of the pulse durations; set to override. */
+    durationMs?: number;
     /** Output frame width in px. Default 1920. */
     width?: number;
     /** Output frame height in px. Default 1080. */
@@ -626,10 +626,10 @@ interface PaletteReelOptionsInput {
     orientation?: "rows" | "columns";
     /** Fields revealed when a color expands (the name is always shown, so it's ignored here). Default hex + oklch + rgb. */
     details?: FieldId[];
-    /** How long each color stays fully open before handing off to the next. Default 2. */
-    holdSeconds?: number;
-    /** Crossfade length from one open color to the next. Default 0.7. */
-    transitionSeconds?: number;
+    /** How long each color stays fully open before handing off to the next (ms). Default 2000. */
+    holdMs?: number;
+    /** Crossfade length from one open color to the next (ms). Default 700. */
+    transitionMs?: number;
     /**
      * Ping-pong the sweep (down the list then back up) so every handoff is between neighbouring bands —
      * the open band only ever slides by one, avoiding the "pinch" of a last→first jump at the loop seam.
@@ -638,8 +638,8 @@ interface PaletteReelOptionsInput {
     bounce?: boolean;
     /** Easing applied to the crossfade ramp. Default "ease-in-out". */
     easing?: "linear" | "ease-in" | "ease-out" | "ease-in-out";
-    /** Clip length override (s). Omit to derive (count × (hold + transition)) for a clean loop. */
-    durationSeconds?: number;
+    /** Clip length override (ms). Omit to derive (count × (hold + transition)) for a clean loop. */
+    durationMs?: number;
     /** How many times a sliver's share a fully-open band takes (a collapsed sliver is the baseline). Default 12. */
     grownFlex?: number;
     /** Minimum cross-size of a sliver in px so its name stays legible. Default 0 (derive from height). */
@@ -782,9 +782,11 @@ interface ShowcaseSettingsInput {
     defaults?: {
         "scroll-reel"?: ScrollReelOptions;
         screenshots?: ScreenshotsOptions;
+        wall?: WallOptions;
         specimen?: SpecimenOptions;
         palette?: PaletteOptions;
         "palette-reel"?: PaletteReelOptions;
+        image?: ImageOptions;
     };
 }
 /** Fields common to every asset. */
@@ -797,7 +799,7 @@ interface AssetBaseInput {
 /**
  * Discriminated by `generator` so each asset gets the right `options` autocomplete. URL-based
  * generators take a `url` — absolute, or a `/path` resolved against the managed server; omit it
- * to capture the managed server's root. A local `scene` composites its `inputs` and needs none.
+ * to capture the managed server's root. Local generators (wall, specimen, palette, image) need none.
  */
 type AssetSpecInput = (AssetBaseInput & {
     url?: string;

package/dist/index.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"sources":["../src/config/define-config.ts"],"sourcesContent":["import type { ScrollReelOptions } from \"@/generators/scroll-reel/options\";\nimport type { ScreenshotsOptions } from \"@/generators/screenshots/options\";\nimport type { WallOptions } from \"@/generators/wall/options\";\nimport type { SpecimenOptions } from \"@/generators/specimen/options\";\nimport type { PaletteOptions } from \"@/generators/palette/options\";\nimport type { PaletteReelOptions } from \"@/generators/palette-reel/options\";\nimport type { ImageOptions } from \"@/generators/image/options\";\n\n/*\n Author-facing config types. These power editor autocomplete in `pro-visu.config.ts`.\n * The runtime validator lives in `schema.ts`; each generator validates its own options.\n * When a new generator is added, extend `AssetSpecInput` and `defaults` here.\n /\n\nexport type LogLevel = \"silent\" \| \"error\" \| \"warn\" \| \"info\" \| \"debug\";\n\nexport interface BrowserSettingsInput {\n /* Run the browser without a visible window (default true). Set false to watch captures. /\n headless?: boolean;\n /* Browser channel, e.g. \"chrome\" or \"msedge\". Omit to use the managed Chromium. /\n channel?: string;\n /* Absolute path to a browser executable (overrides `channel` + managed Chromium). /\n executablePath?: string;\n /* Extra launch args, e.g. [\"--no-sandbox\"] on CI. /\n args?: string[];\n /* Browser launch timeout (ms). /\n timeout?: number;\n}\n\nexport interface ServerSettingsInput {\n /\n Command that starts the server, run via the shell. The tool sets PORT/HOST in its environment\n * to the readiness port/host, so frameworks that honor PORT (Next, Vite, …) bind it\n * automatically — `command: \"next start\"` is enough. An explicit flag still wins.\n /\n command: string;\n /* Optional one-shot build to run first, e.g. \"next build\". /\n build?: string;\n /* Health-check URL polled until it responds. Defaults to http://127.0.0.1:<port>. /\n url?: string;\n /\n Port the readiness check polls — also derives `url` when `url` is omitted, and is passed to\n * the command as PORT so it binds the same port automatically. Defaults to 3101.\n /\n port?: number;\n /* Working dir for build + command, relative to the config dir. Defaults to it. /\n cwd?: string;\n /* Max time to wait for the server to become reachable (ms). Default 120000. /\n readyTimeoutMs?: number;\n /* If a server is already reachable at the URL, use it as-is (don't start/stop one). /\n reuseExisting?: boolean;\n}\n\nexport interface CaptureSettingsInput {\n /* Query params appended to every URL-based asset, e.g. `{ capture: \"1\" }` → `?capture=1`. /\n query?: Record<string, string>;\n /* Cookies set on every capture context before navigation (scoped to the asset's origin). /\n cookies?: { name: string; value: string }[];\n /* localStorage entries seeded (per origin) before the page's own scripts run. /\n localStorage?: Record<string, string>;\n /* JS run in every page before its own scripts, e.g. `window.__PV_CAPTURE__ = true`. /\n initScript?: string;\n}\n\nexport interface ShowcaseSettingsInput {\n /* Output directory for generated assets, relative to the repo root (default \"pro-visu\"). /\n outDir?: string;\n /* How many assets to generate in parallel (shared browser, separate contexts). /\n concurrency?: number;\n /\n Raise the Node heap (V8 old-space) to this many MB. Heavy jobs — large frame-stepped walls\n * especially — can exceed Node's ~4 GB default and crash with \"JavaScript heap out of memory\".\n * When set above the current limit, the CLI re-execs itself with `--max-old-space-size`. This is\n * the Node process heap, not the browser's.\n /\n maxMemoryMB?: number;\n /* CLI log verbosity. /\n logLevel?: LogLevel;\n /* Playwright launch controls. /\n browser?: BrowserSettingsInput;\n /* Build → start → wait → capture → stop a server automatically. /\n server?: ServerSettingsInput;\n /* Capture-mode toggles applied to every URL-based asset (disable animations, hide cookie banner, …). /\n capture?: CaptureSettingsInput;\n /* \"draft\" lowers fps/scale and speeds the encoder for fast iteration. /\n quality?: \"draft\" \| \"final\";\n /* Skip assets whose inputs+options+tool fingerprint is unchanged (opt-in). /\n cache?: boolean;\n /* Per-generator option defaults, keyed by generator id, merged under each asset. /\n defaults?: {\n \"scroll-reel\"?: ScrollReelOptions;\n screenshots?: ScreenshotsOptions;\n specimen?: SpecimenOptions;\n palette?: PaletteOptions;\n \"palette-reel\"?: PaletteReelOptions;\n };\n}\n\n/* Fields common to every asset. /\nexport interface AssetBaseInput {\n /* Unique id for this asset — also the output filename (`<slug(name)>.mp4`) and manifest key. /\n name: string;\n /* Other assets this one consumes, as `{ slotName: assetName }`. Producers run first. /\n inputs?: Record<string, string>;\n}\n\n/\n Discriminated by `generator` so each asset gets the right `options` autocomplete. URL-based\n * generators take a `url` — absolute, or a `/path` resolved against the managed server; omit it\n * to capture the managed server's root. A ~~local~~ ~~`scene`~~ ~~composites~~ ~~its~~ ~~`inputs`~~ ~~and~~ ~~needs~~ none.\n /\nexport type AssetSpecInput =\n \| (AssetBaseInput & { url?: string; generator: \"scroll-reel\"; options?: ScrollReelOptions })\n \| (AssetBaseInput & { url?: string; generator: \"screenshots\"; options?: ScreenshotsOptions })\n \| (AssetBaseInput & { generator: \"wall\"; options?: WallOptions })\n \| (AssetBaseInput & { generator: \"specimen\"; options: SpecimenOptions })\n \| (AssetBaseInput & { generator: \"palette\"; options: PaletteOptions })\n \| (AssetBaseInput & { generator: \"palette-reel\"; options: PaletteReelOptions })\n \| (AssetBaseInput & { generator: \"image\"; options: ImageOptions });\n\nexport interface ShowcaseUserConfig {\n settings?: ShowcaseSettingsInput;\n assets: AssetSpecInput[];\n}\n\n/* Identity helper that gives `pro-visu.config.ts` full type-checking + autocomplete. */\nexport function defineConfig(config: ShowcaseUserConfig): ShowcaseUserConfig {\n return config;\n}\n"],"mappings":";~~AA8HO~~,SAAS,aAAa,QAAgD;AAC3E,SAAO;AACT;","names":[]}
1	+ {"version":3,"sources":["../src/config/define-config.ts"],"sourcesContent":["import type { ScrollReelOptions } from \"@/generators/scroll-reel/options\";\nimport type { ScreenshotsOptions } from \"@/generators/screenshots/options\";\nimport type { WallOptions } from \"@/generators/wall/options\";\nimport type { SpecimenOptions } from \"@/generators/specimen/options\";\nimport type { PaletteOptions } from \"@/generators/palette/options\";\nimport type { PaletteReelOptions } from \"@/generators/palette-reel/options\";\nimport type { ImageOptions } from \"@/generators/image/options\";\n\n/*\n Author-facing config types. These power editor autocomplete in `pro-visu.config.ts`.\n * The runtime validator lives in `schema.ts`; each generator validates its own options.\n * When a new generator is added, extend `AssetSpecInput` and `defaults` here.\n /\n\nexport type LogLevel = \"silent\" \| \"error\" \| \"warn\" \| \"info\" \| \"debug\";\n\nexport interface BrowserSettingsInput {\n /* Run the browser without a visible window (default true). Set false to watch captures. /\n headless?: boolean;\n /* Browser channel, e.g. \"chrome\" or \"msedge\". Omit to use the managed Chromium. /\n channel?: string;\n /* Absolute path to a browser executable (overrides `channel` + managed Chromium). /\n executablePath?: string;\n /* Extra launch args, e.g. [\"--no-sandbox\"] on CI. /\n args?: string[];\n /* Browser launch timeout (ms). /\n timeout?: number;\n}\n\nexport interface ServerSettingsInput {\n /\n Command that starts the server, run via the shell. The tool sets PORT/HOST in its environment\n * to the readiness port/host, so frameworks that honor PORT (Next, Vite, …) bind it\n * automatically — `command: \"next start\"` is enough. An explicit flag still wins.\n /\n command: string;\n /* Optional one-shot build to run first, e.g. \"next build\". /\n build?: string;\n /* Health-check URL polled until it responds. Defaults to http://127.0.0.1:<port>. /\n url?: string;\n /\n Port the readiness check polls — also derives `url` when `url` is omitted, and is passed to\n * the command as PORT so it binds the same port automatically. Defaults to 3101.\n /\n port?: number;\n /* Working dir for build + command, relative to the config dir. Defaults to it. /\n cwd?: string;\n /* Max time to wait for the server to become reachable (ms). Default 120000. /\n readyTimeoutMs?: number;\n /* If a server is already reachable at the URL, use it as-is (don't start/stop one). /\n reuseExisting?: boolean;\n}\n\nexport interface CaptureSettingsInput {\n /* Query params appended to every URL-based asset, e.g. `{ capture: \"1\" }` → `?capture=1`. /\n query?: Record<string, string>;\n /* Cookies set on every capture context before navigation (scoped to the asset's origin). /\n cookies?: { name: string; value: string }[];\n /* localStorage entries seeded (per origin) before the page's own scripts run. /\n localStorage?: Record<string, string>;\n /* JS run in every page before its own scripts, e.g. `window.__PV_CAPTURE__ = true`. /\n initScript?: string;\n}\n\nexport interface ShowcaseSettingsInput {\n /* Output directory for generated assets, relative to the repo root (default \"pro-visu\"). /\n outDir?: string;\n /* How many assets to generate in parallel (shared browser, separate contexts). /\n concurrency?: number;\n /\n Raise the Node heap (V8 old-space) to this many MB. Heavy jobs — large frame-stepped walls\n * especially — can exceed Node's ~4 GB default and crash with \"JavaScript heap out of memory\".\n * When set above the current limit, the CLI re-execs itself with `--max-old-space-size`. This is\n * the Node process heap, not the browser's.\n /\n maxMemoryMB?: number;\n /* CLI log verbosity. /\n logLevel?: LogLevel;\n /* Playwright launch controls. /\n browser?: BrowserSettingsInput;\n /* Build → start → wait → capture → stop a server automatically. /\n server?: ServerSettingsInput;\n /* Capture-mode toggles applied to every URL-based asset (disable animations, hide cookie banner, …). /\n capture?: CaptureSettingsInput;\n /* \"draft\" lowers fps/scale and speeds the encoder for fast iteration. /\n quality?: \"draft\" \| \"final\";\n /* Skip assets whose inputs+options+tool fingerprint is unchanged (opt-in). /\n cache?: boolean;\n /* Per-generator option defaults, keyed by generator id, merged under each asset. /\n defaults?: {\n \"scroll-reel\"?: ScrollReelOptions;\n screenshots?: ScreenshotsOptions;\n wall?: WallOptions;\n specimen?: SpecimenOptions;\n palette?: PaletteOptions;\n \"palette-reel\"?: PaletteReelOptions;\n image?: ImageOptions;\n };\n}\n\n/* Fields common to every asset. /\nexport interface AssetBaseInput {\n /* Unique id for this asset — also the output filename (`<slug(name)>.mp4`) and manifest key. /\n name: string;\n /* Other assets this one consumes, as `{ slotName: assetName }`. Producers run first. /\n inputs?: Record<string, string>;\n}\n\n/\n Discriminated by `generator` so each asset gets the right `options` autocomplete. URL-based\n * generators take a `url` — absolute, or a `/path` resolved against the managed server; omit it\n * to capture the managed server's root. Local generators (wall, specimen, palette, image) need none.\n /\nexport type AssetSpecInput =\n \| (AssetBaseInput & { url?: string; generator: \"scroll-reel\"; options?: ScrollReelOptions })\n \| (AssetBaseInput & { url?: string; generator: \"screenshots\"; options?: ScreenshotsOptions })\n \| (AssetBaseInput & { generator: \"wall\"; options?: WallOptions })\n \| (AssetBaseInput & { generator: \"specimen\"; options: SpecimenOptions })\n \| (AssetBaseInput & { generator: \"palette\"; options: PaletteOptions })\n \| (AssetBaseInput & { generator: \"palette-reel\"; options: PaletteReelOptions })\n \| (AssetBaseInput & { generator: \"image\"; options: ImageOptions });\n\nexport interface ShowcaseUserConfig {\n settings?: ShowcaseSettingsInput;\n assets: AssetSpecInput[];\n}\n\n/* Identity helper that gives `pro-visu.config.ts` full type-checking + autocomplete. */\nexport function defineConfig(config: ShowcaseUserConfig): ShowcaseUserConfig {\n return config;\n}\n"],"mappings":";AAgIO,SAAS,aAAa,QAAgD;AAC3E,SAAO;AACT;","names":[]}