@bendyline/squisq-cli 1.1.5 → 1.2.0

package/dist/api.d.ts

@@ -1,3 +1,39 @@
+import { Doc } from '@bendyline/squisq/schemas';
+import { MemoryContentContainer } from '@bendyline/squisq/storage';
+export { MemoryContentContainer } from '@bendyline/squisq/storage';
+import { VideoQuality, VideoOrientation } from '@bendyline/squisq-video';
+export { VideoOrientation, VideoQuality } from '@bendyline/squisq-video';
+import { MarkdownDocument } from '@bendyline/squisq/markdown';
+
+/**
+ * readInput
+ *
+ * Unified input reader for the CLI. Accepts a path to a .md file, .json file
+ * (Doc schema), .zip/.dbk container, or a folder and returns a MemoryContentContainer
+ * (virtual file system) plus either the parsed MarkdownDocument or a pre-built Doc.
+ *
+ * When a .json file or a container/folder containing doc.json is provided, the
+ * Doc is returned directly and markdownDoc will be null. Callers should check
+ * result.doc first; when present, skip markdownToDoc() and use it directly.
+ */
+
+interface ReadInputResult {
+    container: MemoryContentContainer;
+    /** Parsed markdown document. Null when input is a Doc JSON file. */
+    markdownDoc: MarkdownDocument | null;
+    /** Pre-built Doc from JSON input. Present when input is .json or contains doc.json. */
+    doc?: Doc;
+}
+/**
+ * Read input from a file path (markdown, JSON Doc, ZIP/DBK container, or folder)
+ * and return a populated ContentContainer + parsed MarkdownDocument or Doc.
+ *
+ * When the input is a .json file (or a container/folder containing doc.json),
+ * the result will have `doc` populated and `markdownDoc` set to null.
+ * Otherwise, `markdownDoc` is populated and `doc` is undefined.
+ */
+declare function readInput(inputPath: string): Promise<ReadInputResult>;
+
 /**
  * Programmatic Video API
  *
@@ -18,15 +54,9 @@
  *     orientation: 'landscape',
  *   });
  */
-import type { Doc } from '@bendyline/squisq/schemas';
-import type { MemoryContentContainer } from '@bendyline/squisq/storage';
-import type { VideoQuality, VideoOrientation } from '@bendyline/squisq-video';
-export type { VideoQuality, VideoOrientation } from '@bendyline/squisq-video';
-export { MemoryContentContainer } from '@bendyline/squisq/storage';
-export { readInput } from './util/readInput.js';
-export type { ReadInputResult } from './util/readInput.js';
+
 /** Options for renderDocToMp4. */
-export interface RenderDocToMp4Options {
+interface RenderDocToMp4Options {
     /** Output file path for the MP4. */
     outputPath: string;
     /** Frames per second (default: 30). */
@@ -49,7 +79,7 @@ export interface RenderDocToMp4Options {
     onProgress?: (phase: string, percent: number) => void;
 }
 /** Result returned by renderDocToMp4. */
-export interface RenderDocToMp4Result {
+interface RenderDocToMp4Result {
     /** Duration of the rendered video in seconds (including pre-roll). */
     duration: number;
     /** Number of frames captured. */
@@ -73,9 +103,9 @@ export interface RenderDocToMp4Result {
  * @param options - Rendering and encoding options
  * @returns Result with duration and frame count
  */
-export declare function renderDocToMp4(doc: Doc, container: MemoryContentContainer, options: RenderDocToMp4Options): Promise<RenderDocToMp4Result>;
+declare function renderDocToMp4(doc: Doc, container: MemoryContentContainer, options: RenderDocToMp4Options): Promise<RenderDocToMp4Result>;
 /** A thumbnail size specification. */
-export interface ThumbnailSpec {
+interface ThumbnailSpec {
     /** Label for the thumbnail (used in filename: `{slug}-{width}x{height}.jpg`). */
     name: string;
     /** Output width in pixels. */
@@ -86,7 +116,7 @@ export interface ThumbnailSpec {
     filter: string;
 }
 /** Options for extractThumbnails. */
-export interface ExtractThumbnailsOptions {
+interface ExtractThumbnailsOptions {
     /** Path to the source MP4 video. */
     videoPath: string;
     /** Directory to write thumbnails into. */
@@ -102,5 +132,6 @@ export interface ExtractThumbnailsOptions {
  * Extract thumbnail images from the first frame of an MP4 video.
  * Produces JPEG files at each specified size using FFmpeg video filters.
  */
-export declare function extractThumbnails(options: ExtractThumbnailsOptions): Promise<void>;
-//# sourceMappingURL=api.d.ts.map
+declare function extractThumbnails(options: ExtractThumbnailsOptions): Promise<void>;
+
+export { type ExtractThumbnailsOptions, type ReadInputResult, type RenderDocToMp4Options, type RenderDocToMp4Result, type ThumbnailSpec, extractThumbnails, readInput, renderDocToMp4 };