@bendyline/squisq-cli 2.8.4 → 2.8.6

package/dist/{api-OK3YGUA4.js → api-FHTG2OCX.js}

@@ -11,12 +11,13 @@ import {
   extractThumbnails,
   prepareConversion,
   readInput,
+  renderDocCoverToPng,
   renderDocToDashboardPng,
   renderDocToGif,
   renderDocToMp4,
   resolveDashboardDimensions,
   validateDashboardImageDimensions
-} from "./chunk-W7GAUNLT.js";
+} from "./chunk-EVE74NYB.js";
 import {
   GIF_EXPORT_DEFAULTS,
   framesToGifNative,
@@ -41,6 +42,7 @@ export {
   framesToMp4NativeBytes,
   prepareConversion,
   readInput,
+  renderDocCoverToPng,
   renderDocToDashboardPng,
   renderDocToGif,
   renderDocToMp4,

package/dist/api.d.ts

@@ -380,6 +380,24 @@ interface RenderDashboardPngResult {
     /** Absolute path written, when `outputPath` was requested. */
     outputPath?: string;
 }
+/** Options for rendering the managed cover as a standalone PNG. */
+interface RenderCoverPngOptions {
+    signal?: AbortSignal;
+    outputPath?: string;
+    width?: number;
+    height?: number;
+    animationsEnabled?: boolean;
+    onProgress?: (phase: string, percent: number) => void;
+}
+/** Result returned by {@link renderDocCoverToPng}. */
+interface RenderCoverPngResult {
+    bytes: Uint8Array;
+    width: number;
+    height: number;
+    outputPath?: string;
+}
+/** Render a Doc's managed cover to a PNG with the canonical headless renderer. */
+declare function renderDocCoverToPng(doc: Doc, container: ContentContainer, options?: RenderCoverPngOptions): Promise<RenderCoverPngResult>;
 /**
  * Render a Doc's Dashboard rendition to a single PNG image.
  *
@@ -424,4 +442,4 @@ interface ExtractThumbnailsOptions {
  */
 declare function extractThumbnails(options: ExtractThumbnailsOptions): Promise<void>;
 
-export { CapturedFrameBudgetError, type CliConvertOptions, type ExtractThumbnailsOptions, GIF_EXPORT_DEFAULTS, type GifExportOptions, type GifFormatOptions, MAX_CAPTURED_FRAME_BYTES, type Mp4FormatOptions, type NativeVideoExportOptions, type PngFormatOptions, type ReadInputResult, type RenderDashboardPngOptions, type RenderDashboardPngResult, type RenderDocToGifOptions, type RenderDocToGifResult, type RenderDocToMp4Options, type RenderDocToMp4Result, type ThumbnailSpec, convert, createCliRegistry, extractThumbnails, framesToGifNative, framesToGifNativeBytes, framesToMp4Native, framesToMp4NativeBytes, prepareConversion, readInput, renderDocToDashboardPng, renderDocToGif, renderDocToMp4 };
+export { CapturedFrameBudgetError, type CliConvertOptions, type ExtractThumbnailsOptions, GIF_EXPORT_DEFAULTS, type GifExportOptions, type GifFormatOptions, MAX_CAPTURED_FRAME_BYTES, type Mp4FormatOptions, type NativeVideoExportOptions, type PngFormatOptions, type ReadInputResult, type RenderCoverPngOptions, type RenderCoverPngResult, type RenderDashboardPngOptions, type RenderDashboardPngResult, type RenderDocToGifOptions, type RenderDocToGifResult, type RenderDocToMp4Options, type RenderDocToMp4Result, type ThumbnailSpec, convert, createCliRegistry, extractThumbnails, framesToGifNative, framesToGifNativeBytes, framesToMp4Native, framesToMp4NativeBytes, prepareConversion, readInput, renderDocCoverToPng, renderDocToDashboardPng, renderDocToGif, renderDocToMp4 };

package/dist/api.js

@@ -1118,6 +1118,45 @@ async function captureDocFrames(doc, container, options) {
     throw err;
   }
 }
+async function renderDocCoverToPng(doc, container, options = {}) {
+  const width = options.width ?? 1920;
+  const height = options.height ?? 1080;
+  if (!doc.startBlock) throw new Error("Document has no managed cover to render");
+  if (!Number.isInteger(width) || !Number.isInteger(height) || width < 64 || height < 64) {
+    throw new Error("Cover PNG dimensions must be integers of at least 64 pixels");
+  }
+  options.signal?.throwIfAborted();
+  const bytes = await withRenderPage(
+    doc,
+    container,
+    {
+      signal: options.signal,
+      width,
+      height,
+      includeAudio: false,
+      animationsEnabled: options.animationsEnabled ?? false,
+      displayMode: "slideshow",
+      onProgress: options.onProgress
+    },
+    async ({ page, renderAPI }) => {
+      options.onProgress?.("rendering cover", 50);
+      await renderAPI.evaluate((api) => api.showCover());
+      await page.waitForTimeout(100);
+      options.signal?.throwIfAborted();
+      options.onProgress?.("capturing image", 85);
+      return page.screenshot({ type: "png" });
+    }
+  );
+  let writtenPath;
+  if (options.outputPath) {
+    const absolute = resolvePath(options.outputPath);
+    await mkdir(dirname2(absolute), { recursive: true });
+    await writeFile(absolute, bytes);
+    writtenPath = absolute;
+  }
+  options.onProgress?.("done", 100);
+  return { bytes, width, height, ...writtenPath ? { outputPath: writtenPath } : {} };
+}
 async function renderDocToDashboardPng(doc, container, options = {}) {
   const {
     signal,
@@ -1368,6 +1407,7 @@ export {
   framesToMp4NativeBytes,
   prepareConversion,
   readInput,
+  renderDocCoverToPng,
   renderDocToDashboardPng,
   renderDocToGif,
   renderDocToMp4,

package/dist/{chunk-W7GAUNLT.js → chunk-EVE74NYB.js}

@@ -331,7 +331,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-OK3YGUA4.js");
+        const { renderDocToMp4: renderDocToMp42 } = await import("./api-FHTG2OCX.js");
         await renderDocToMp42(input.doc, input.container, {
           outputPath,
           fps,
@@ -372,7 +372,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-OK3YGUA4.js");
+        const { renderDocToGif: renderDocToGif2 } = await import("./api-FHTG2OCX.js");
         const result = await renderDocToGif2(input.doc, input.container, {
           outputPath,
           fps: typeof gifOpts.fps === "number" ? gifOpts.fps : GIF_DEFAULTS.fps,
@@ -415,7 +415,7 @@ function pngFormat() {
     async exportDoc(input, options) {
       options.signal?.throwIfAborted();
       const pngOpts = options.formatOptions?.png ?? {};
-      const { renderDocToDashboardPng: renderDocToDashboardPng2 } = await import("./api-OK3YGUA4.js");
+      const { renderDocToDashboardPng: renderDocToDashboardPng2 } = await import("./api-FHTG2OCX.js");
       const result = await renderDocToDashboardPng2(input.doc, input.container, {
         resolution: pngOpts.resolution,
         width: pngOpts.width,
@@ -1115,6 +1115,45 @@ async function captureDocFrames(doc, container, options) {
     throw err;
   }
 }
+async function renderDocCoverToPng(doc, container, options = {}) {
+  const width = options.width ?? 1920;
+  const height = options.height ?? 1080;
+  if (!doc.startBlock) throw new Error("Document has no managed cover to render");
+  if (!Number.isInteger(width) || !Number.isInteger(height) || width < 64 || height < 64) {
+    throw new Error("Cover PNG dimensions must be integers of at least 64 pixels");
+  }
+  options.signal?.throwIfAborted();
+  const bytes = await withRenderPage(
+    doc,
+    container,
+    {
+      signal: options.signal,
+      width,
+      height,
+      includeAudio: false,
+      animationsEnabled: options.animationsEnabled ?? false,
+      displayMode: "slideshow",
+      onProgress: options.onProgress
+    },
+    async ({ page, renderAPI }) => {
+      options.onProgress?.("rendering cover", 50);
+      await renderAPI.evaluate((api) => api.showCover());
+      await page.waitForTimeout(100);
+      options.signal?.throwIfAborted();
+      options.onProgress?.("capturing image", 85);
+      return page.screenshot({ type: "png" });
+    }
+  );
+  let writtenPath;
+  if (options.outputPath) {
+    const absolute = resolvePath(options.outputPath);
+    await mkdir(dirname2(absolute), { recursive: true });
+    await writeFile(absolute, bytes);
+    writtenPath = absolute;
+  }
+  options.onProgress?.("done", 100);
+  return { bytes, width, height, ...writtenPath ? { outputPath: writtenPath } : {} };
+}
 async function renderDocToDashboardPng(doc, container, options = {}) {
   const {
     signal,
@@ -1358,6 +1397,7 @@ export {
   CapturedFrameBudgetError,
   convert,
   prepareConversion,
+  renderDocCoverToPng,
   renderDocToDashboardPng,
   renderDocToMp4,
   renderDocToGif,

package/dist/index.js

@@ -9,7 +9,7 @@ import {
   renderDocToDashboardPng,
   renderDocToGif,
   renderDocToMp4
-} from "./chunk-W7GAUNLT.js";
+} from "./chunk-EVE74NYB.js";
 import "./chunk-GGVASRPG.js";
 
 // src/index.ts