@bendyline/docblocks-cli 2.1.0 → 2.1.2

package/dist/index.d.ts

@@ -1,2 +1,133 @@
+import { MarkdownDocument } from '@bendyline/squisq/markdown';
+import { ContentContainer } from '@bendyline/squisq/storage';
+import * as _bendyline_squisq_cli_api from '@bendyline/squisq-cli/api';
+import { FormatRegistry } from '@bendyline/squisq-cli/api';
+import { VideoQuality, VideoOrientation } from '@bendyline/squisq-video';
 
-export {  }
+interface BuildOptions {
+    input: string;
+    output: string;
+    theme?: string;
+    /** Programmatic traversal budget; CLI callers use the safe default. */
+    maxEntries?: number;
+    /** Programmatic directory-depth budget; CLI callers use the safe default. */
+    maxDepth?: number;
+    /** Maximum bytes in one Markdown input. */
+    maxInputBytes?: number;
+    /** Maximum aggregate bytes across all Markdown inputs. */
+    maxTotalInputBytes?: number;
+    /** Maximum bytes in one generated standalone HTML file. */
+    maxOutputBytes?: number;
+    /** Maximum aggregate bytes across all generated HTML files. */
+    maxTotalOutputBytes?: number;
+    /** Disable default byte budgets for an explicitly trusted bulk build. */
+    allowLargeBuild?: boolean;
+}
+interface BuildResult {
+    inputDir: string;
+    outputDir: string;
+    builtFiles: string[];
+}
+declare function runBuild(opts: BuildOptions): Promise<BuildResult>;
+
+/**
+ * convert command
+ *
+ * Reads any input supported by the linked Squisq CLI and exports through its
+ * canonical format registry. The historical default set remains DOCX, PPTX,
+ * PDF, HTML, and DBK; callers may explicitly request any export-capable
+ * registry format.
+ *
+ * Wraps the same logic as squisq-cli's convert command, reusing the
+ * underlying squisq libraries directly.
+ */
+
+interface ConvertOptions {
+    outputDir?: string;
+    formats?: string;
+    theme?: string;
+    transform?: string;
+    /**
+     * Replace existing destination files. Off by default: the run is refused
+     * before any conversion work when a destination already exists.
+     */
+    allowOverwrite?: boolean;
+    /** Cancel reading, transformation, conversion, or publication at a bounded boundary. */
+    signal?: AbortSignal;
+    /** Programmatic registry override; the CLI defaults to the linked Squisq registry. */
+    registry?: FormatRegistry;
+    /** Programmatic aggregate input budget; CLI callers use the safe default. */
+    maxInputBytes?: number;
+    /** Programmatic input-tree budget; CLI callers use the safe default. */
+    maxInputEntries?: number;
+    /** Programmatic per-output budget; CLI callers use the safe default. */
+    maxOutputBytes?: number;
+    /** Programmatic aggregate output budget; CLI callers use the safe default. */
+    maxTotalOutputBytes?: number;
+}
+interface ConvertResult {
+    outputFiles: {
+        path: string;
+        format: string;
+        size: number;
+        mimeType: string;
+        suggestedFilename: string;
+        warnings: string[];
+    }[];
+}
+declare function runConvert(inputPath: string, opts: ConvertOptions): Promise<ConvertResult>;
+/**
+ * Apply a transform style to a MarkdownDocument.
+ */
+declare function applyTransformToMarkdown(markdownDoc: MarkdownDocument, container: ContentContainer, transformStyle: string, themeId?: string): Promise<MarkdownDocument>;
+
+declare const VALID_CAPTIONS: readonly ["off", "standard", "social"];
+type CaptionOption = (typeof VALID_CAPTIONS)[number];
+interface VideoOptions {
+    output?: string;
+    fps?: number;
+    quality?: VideoQuality;
+    orientation?: VideoOrientation;
+    captions?: CaptionOption;
+    width?: number;
+    height?: number;
+    /**
+     * Replace an existing MP4. Off by default: the render is refused before any
+     * reading, browser capture, or FFmpeg encoding when the target exists.
+     */
+    allowOverwrite?: boolean;
+    /** Cancel input preparation, browser capture, or FFmpeg encoding. */
+    signal?: AbortSignal;
+}
+interface VideoResult {
+    outputPath: string;
+    duration: number;
+    frameCount: number;
+}
+type RenderDocToMp4 = typeof _bendyline_squisq_cli_api.renderDocToMp4;
+interface VideoRunDependencies {
+    /** Test/programmatic override; production uses the linked Squisq renderer. */
+    renderDocToMp4?: RenderDocToMp4;
+}
+/**
+ * Core video rendering logic — reusable by both CLI and MCP tools.
+ */
+declare function runVideo(inputPath: string, opts: VideoOptions, onProgress?: (phase: string, percent: number) => void, dependencies?: VideoRunDependencies): Promise<VideoResult>;
+/** Reject unsafe dimensions before reading input or launching Playwright/FFmpeg. */
+declare function assertCliVideoRenderBudget(options: Pick<VideoOptions, 'fps' | 'quality' | 'orientation' | 'width' | 'height'>): void;
+
+/**
+ * parse command — parse a markdown file and print its structure as JSON.
+ */
+
+interface ParseOptions {
+    /** Programmatic input budget; CLI callers use the safe default. */
+    readonly maxInputBytes?: number;
+    /** Programmatic JSON output budget; CLI callers use the safe default. */
+    readonly maxOutputBytes?: number;
+}
+declare function runParse(inputPath: string, options?: ParseOptions): Promise<string>;
+
+declare function getPackageVersion(): string;
+
+export { type BuildOptions, type BuildResult, type ConvertOptions, type ConvertResult, type ParseOptions, type VideoOptions, type VideoResult, type VideoRunDependencies, applyTransformToMarkdown, assertCliVideoRenderBudget, getPackageVersion, runBuild, runConvert, runParse, runVideo };