@tumaet/apollon 4.6.0 → 4.8.0

package/dist/export.d.ts

@@ -0,0 +1,73 @@
+/**
+ * Largest scale that fits both the area budget and the per-side cap. Pure, so
+ * the clamp can be unit-tested without booting wasm.
+ */
+export declare function computeAppliedScale(width: number, height: number, requestedScale: number, maxAreaPx: number, maxDimensionPx: number): number;
+
+/**
+ * Typed error for the raster (PNG) export path so callers can show an
+ * actionable "diagram too large" message instead of the silent 0-byte file the
+ * old canvas path produced (#667).
+ */
+export declare class RasterTooLargeError extends Error {
+    readonly canvasWidth: number;
+    readonly canvasHeight: number;
+    constructor(message: string, canvasWidth: number, canvasHeight: number);
+}
+
+export declare function svgToPdf(svg: string, clip: {
+    width: number;
+    height: number;
+}, opts?: SvgToPdfOptions): Promise<Blob>;
+
+export declare type SvgToPdfOptions = {
+    /** Document title metadata; does not affect layout. */
+    title?: string;
+    /**
+     * Inter Regular + Bold as ttf/otf bytes, for hosts without `fetch` of the
+     * bundled `?url` font asset (e.g. tests, headless Node). Defaults to the
+     * bundled Inter.
+     */
+    fonts?: {
+        regular: Uint8Array;
+        bold: Uint8Array;
+    };
+};
+
+export declare function svgToPng(svg: string, clip: {
+    width: number;
+    height: number;
+}, opts?: SvgToPngOptions): Promise<SvgToPngResult>;
+
+export declare type SvgToPngOptions = {
+    /** Multiplier applied to the diagram clip dimensions. Default 1.5. */
+    scale?: number;
+    /** CSS colour (e.g. "#ffffff") or null for transparent. Default null. */
+    background?: string | null;
+    /** Override the 75 MP area budget. */
+    maxAreaPx?: number;
+    /** Override the 16,384 px per-side cap. */
+    maxDimensionPx?: number;
+    /**
+     * The `@resvg/resvg-wasm` binary, as anything resvg's `initWasm` accepts.
+     * Required: where the wasm lives is the host bundler's concern, not the
+     * library's (resvg-wasm doesn't export it under a portable URL specifier).
+     * In Vite:
+     *   `import url from "@resvg/resvg-wasm/index_bg.wasm?url"`
+     *   `svgToPng(svg, clip, { wasmInput: fetch(url) })`
+     */
+    wasmInput?: WebAssembly.Module | BufferSource | Response | Promise<Response>;
+    /** Font buffers (ttf/otf) to use instead of the bundled Inter. */
+    fontBuffers?: Uint8Array[];
+};
+
+export declare type SvgToPngResult = {
+    blob: Blob;
+    /** The scale actually used — below the requested one when clamped. */
+    appliedScale: number;
+    clamped: boolean;
+    width: number;
+    height: number;
+};
+
+export { }