@bendyline/squisq-cli 2.3.1 → 2.3.2

package/README.md

@@ -77,7 +77,7 @@ squisq video doc.json -o out.mp4
 | `--fps`                            | Frames per second (MP4 1–120; GIF 1–100)                             | MP4 30; GIF 10            |
 | `--quality`                        | MP4-only quality: `draft`, `normal`, or `high`                       | normal                    |
 | `--orientation`                    | `landscape` or `portrait`                                            | landscape                 |
-| `--captions`                       | `off`, `standard`, or `social`                                       | off                       |
+| `--captions`                       | `off`, `standard`, or `social`                                       | MP4 off; GIF standard     |
 | `--animations` / `--no-animations` | Enable/disable layer animations and block transitions                | MP4 enabled; GIF disabled |
 | `--loop`                           | GIF repeat count (`0` forever, `-1` no loop)                         | 0                         |
 | `--max-colors`                     | GIF palette size, 2–256                                              | 256                       |
@@ -169,7 +169,7 @@ const result = await renderDocToMp4(doc, input.container, {
   fps: 30, // default 30
   quality: 'high', // 'draft' | 'normal' | 'high' (default 'normal')
   orientation: 'landscape', // 'landscape' | 'portrait' (default 'landscape')
-  captionStyle: 'social', // 'standard' | 'social' — omit for no captions
+  captionStyle: 'social', // 'off' | 'standard' | 'social' (default 'off')
   animationsEnabled: false, // static slide changes; media/timing remain active
   coverPreRoll: 2, // seconds of cover-slide pre-roll (default 0)
   onProgress: (phase, pct) => console.log(`${phase}: ${pct}%`),
@@ -188,15 +188,17 @@ import { renderDocToGif } from '@bendyline/squisq-cli/api';
 const result = await renderDocToGif(doc, input.container, {
   outputPath: './output.gif',
   fps: 10,
+  captionStyle: 'off', // override the default 'standard' captions
   animationsEnabled: false,
   maxColors: 256,
   loop: 0,
 });
 ```
 
-GIF defaults to 960×540 landscape (540×960 portrait), 10 fps, an infinite
-loop, and disabled slide animations/transitions. Embedded video still advances,
-but all audio is omitted and reported through `result.warnings`.
+GIF defaults to 960×540 landscape (540×960 portrait), 10 fps, standard
+captions, an infinite loop, and disabled slide animations/transitions. Set
+`captionStyle: 'off'` to omit captions. Embedded video still advances, but all
+audio is omitted and reported through `result.warnings`.
 
 ### Native frame encoding
 

package/dist/{api-L5AORQHA.js → api-A7FKMZY6.js}

@@ -11,7 +11,7 @@ import {
   readInput,
   renderDocToGif,
   renderDocToMp4
-} from "./chunk-TPODSM5L.js";
+} from "./chunk-ZEN42AFN.js";
 import {
   GIF_EXPORT_DEFAULTS,
   framesToGifNative,

package/dist/api.d.ts

@@ -23,7 +23,7 @@ interface Mp4FormatOptions {
     orientation?: VideoOrientation;
     width?: number;
     height?: number;
-    captionStyle?: 'standard' | 'social';
+    captionStyle?: 'off' | 'standard' | 'social';
     coverPreRoll?: number;
     animationsEnabled?: boolean;
 }
@@ -34,7 +34,7 @@ interface GifFormatOptions {
     orientation?: VideoOrientation;
     width?: number;
     height?: number;
-    captionStyle?: 'standard' | 'social';
+    captionStyle?: 'off' | 'standard' | 'social';
     coverPreRoll?: number;
     animationsEnabled?: boolean;
     loop?: number;
@@ -258,8 +258,8 @@ interface RenderDocToMp4Options {
     width?: number;
     /** Override video height in pixels. */
     height?: number;
-    /** Caption style to bake into the video (default: none). */
-    captionStyle?: 'standard' | 'social';
+    /** Caption mode to bake into the video (default: off). */
+    captionStyle?: 'off' | 'standard' | 'social';
     /** Render layer animations and block transitions (default: true). */
     animationsEnabled?: boolean;
     /**
@@ -289,8 +289,8 @@ interface RenderDocToGifOptions {
     width?: number;
     /** Override output height (default: 540 landscape / 960 portrait). */
     height?: number;
-    /** Caption style to bake into the GIF (default: none). */
-    captionStyle?: 'standard' | 'social';
+    /** Caption mode to bake into the GIF (default: standard). */
+    captionStyle?: 'off' | 'standard' | 'social';
     /** Seconds of cover-slide pre-roll (default: 0). */
     coverPreRoll?: number;
     /** Render layer animations and block transitions (default: false). */

package/dist/api.js

@@ -885,7 +885,7 @@ async function renderDocToMp4(doc, container, options) {
     fps,
     width: dimensions.width,
     height: dimensions.height,
-    captionStyle: options.captionStyle,
+    captionStyle: options.captionStyle === "off" ? void 0 : options.captionStyle,
     coverPreRoll: options.coverPreRoll ?? 0,
     animationsEnabled: options.animationsEnabled ?? true,
     onProgress: options.onProgress,
@@ -948,7 +948,7 @@ async function renderDocToGif(doc, container, options) {
     fps,
     width,
     height,
-    captionStyle: options.captionStyle,
+    captionStyle: options.captionStyle === "off" ? void 0 : options.captionStyle ?? "standard",
     coverPreRoll: options.coverPreRoll ?? 0,
     animationsEnabled: options.animationsEnabled ?? false,
     onProgress: options.onProgress,

package/dist/{chunk-TPODSM5L.js → chunk-ZEN42AFN.js}

@@ -308,7 +308,7 @@ function mp4Format() {
       const animationsEnabled = typeof mp4Opts.animationsEnabled === "boolean" ? mp4Opts.animationsEnabled : MP4_DEFAULTS.animationsEnabled;
       const outputPath = join(tmpdir(), `squisq-mp4-${randomBytes(8).toString("hex")}.mp4`);
       try {
-        const { renderDocToMp4: renderDocToMp42 } = await import("./api-L5AORQHA.js");
+        const { renderDocToMp4: renderDocToMp42 } = await import("./api-A7FKMZY6.js");
         await renderDocToMp42(input.doc, input.container, {
           outputPath,
           fps,
@@ -348,7 +348,7 @@ function gifFormat() {
       const defaultHeight = portrait ? GIF_DEFAULTS.width : GIF_DEFAULTS.height;
       const outputPath = join(tmpdir(), `squisq-gif-${randomBytes(8).toString("hex")}.gif`);
       try {
-        const { renderDocToGif: renderDocToGif2 } = await import("./api-L5AORQHA.js");
+        const { renderDocToGif: renderDocToGif2 } = await import("./api-A7FKMZY6.js");
         const result = await renderDocToGif2(input.doc, input.container, {
           outputPath,
           fps: typeof gifOpts.fps === "number" ? gifOpts.fps : GIF_DEFAULTS.fps,
@@ -882,7 +882,7 @@ async function renderDocToMp4(doc, container, options) {
     fps,
     width: dimensions.width,
     height: dimensions.height,
-    captionStyle: options.captionStyle,
+    captionStyle: options.captionStyle === "off" ? void 0 : options.captionStyle,
     coverPreRoll: options.coverPreRoll ?? 0,
     animationsEnabled: options.animationsEnabled ?? true,
     onProgress: options.onProgress,
@@ -945,7 +945,7 @@ async function renderDocToGif(doc, container, options) {
     fps,
     width,
     height,
-    captionStyle: options.captionStyle,
+    captionStyle: options.captionStyle === "off" ? void 0 : options.captionStyle ?? "standard",
     coverPreRoll: options.coverPreRoll ?? 0,
     animationsEnabled: options.animationsEnabled ?? false,
     onProgress: options.onProgress,

package/dist/index.js

@@ -7,7 +7,7 @@ import {
   readInput,
   renderDocToGif,
   renderDocToMp4
-} from "./chunk-TPODSM5L.js";
+} from "./chunk-ZEN42AFN.js";
 import "./chunk-GGVASRPG.js";
 
 // src/index.ts
@@ -321,8 +321,7 @@ function registerVideoCommand(program2) {
     "landscape"
   ).option(
     "--captions <style>",
-    `Caption style: ${VALID_CAPTIONS.join(", ")} (default: off)`,
-    "off"
+    `Caption style: ${VALID_CAPTIONS.join(", ")} (default: off for MP4, standard for GIF)`
   ).option(
     "--no-auto-templates",
     "Disable content-aware template auto-picking for unannotated headings"
@@ -388,11 +387,10 @@ async function runVideo(inputPath, opts) {
   const width = opts.width === void 0 ? void 0 : Number(opts.width);
   const height = opts.height === void 0 ? void 0 : Number(opts.height);
   validateVideoExportOptions({ width, height, orientation });
-  const captions = opts.captions ?? "off";
+  const captions = opts.captions ?? (outputFormat === "gif" ? "standard" : "off");
   if (!VALID_CAPTIONS.includes(captions)) {
     throw new Error(`Invalid captions "${captions}". Valid: ${VALID_CAPTIONS.join(", ")}`);
   }
-  const captionStyle = captions === "off" ? void 0 : captions;
   const coverPreRoll = Number(opts.coverPreroll ?? "2");
   if (!Number.isFinite(coverPreRoll) || coverPreRoll < 0) {
     throw new Error("Cover pre-roll must be a number of seconds >= 0");
@@ -462,7 +460,7 @@ async function runVideo(inputPath, opts) {
     orientation,
     width,
     height,
-    captionStyle,
+    captionStyle: captions,
     coverPreRoll,
     animationsEnabled,
     onProgress: (phase, percent) => writeProgress(phase, percent, 100)