@shotstack/shotstack-canvas 1.0.2 → 1.0.3

package/dist/entry.node.d.ts

@@ -0,0 +1,229 @@
+declare const CANVAS_CONFIG: {
+    DEFAULTS: {
+        width: number;
+        height: number;
+        pixelRatio: number;
+        fontFamily: string;
+        fontSize: number;
+        color: string;
+        textAlign: "left";
+    };
+    LIMITS: {
+        minWidth: number;
+        maxWidth: number;
+        minHeight: number;
+        maxHeight: number;
+        minFontSize: number;
+        maxFontSize: number;
+        minDuration: number;
+        maxDuration: number;
+        maxTextLength: number;
+    };
+    ANIMATION_TYPES: readonly ["typewriter", "fadeIn", "slideIn", "shift", "ascend", "movingLetters"];
+};
+
+type RichTextValidated = Required<{
+    type: "rich-text";
+    text: string;
+    width?: number;
+    height?: number;
+    font?: {
+        family: string;
+        size: number;
+        weight: string | number;
+        style: "normal" | "italic" | "oblique";
+        color: string;
+        opacity: number;
+    };
+    style?: {
+        letterSpacing: number;
+        lineHeight: number;
+        textTransform: "none" | "uppercase" | "lowercase" | "capitalize";
+        textDecoration: "none" | "underline" | "line-through";
+        gradient?: {
+            type: "linear" | "radial";
+            angle: number;
+            stops: {
+                offset: number;
+                color: string;
+            }[];
+        };
+    };
+    stroke?: {
+        width: number;
+        color: string;
+        opacity: number;
+    };
+    shadow?: {
+        offsetX: number;
+        offsetY: number;
+        blur: number;
+        color: string;
+        opacity: number;
+    };
+    background?: {
+        color?: string;
+        opacity: number;
+        borderRadius: number;
+    };
+    align?: {
+        horizontal: "left" | "center" | "right";
+        vertical: "top" | "middle" | "bottom";
+    };
+    animation?: {
+        preset: typeof CANVAS_CONFIG.ANIMATION_TYPES[number];
+        speed: number;
+        duration?: number;
+        style?: "character" | "word";
+        direction?: "left" | "right" | "up" | "down";
+    };
+    customFonts?: {
+        src: string;
+        family: string;
+        weight?: string | number;
+        style?: string;
+        originalFamily?: string;
+    }[];
+    cacheEnabled: boolean;
+    pixelRatio: number;
+}>;
+
+type RGBA = {
+    r: number;
+    g: number;
+    b: number;
+    a: number;
+};
+type GradientSpec = {
+    kind: "solid";
+    color: string;
+    opacity: number;
+} | {
+    kind: "linear";
+    angle: number;
+    stops: {
+        offset: number;
+        color: string;
+    }[];
+    opacity: number;
+} | {
+    kind: "radial";
+    stops: {
+        offset: number;
+        color: string;
+    }[];
+    opacity: number;
+};
+type Glyph = {
+    id: number;
+    xAdvance: number;
+    xOffset: number;
+    yOffset: number;
+    cluster: number;
+    char?: string;
+};
+type ShapedLine = {
+    glyphs: Glyph[];
+    width: number;
+    y: number;
+};
+type DrawOp = {
+    op: "BeginFrame";
+    width: number;
+    height: number;
+    pixelRatio: number;
+    clear: boolean;
+    bg?: {
+        color?: string;
+        opacity: number;
+        radius: number;
+    };
+} | {
+    op: "FillPath";
+    path: string;
+    x: number;
+    y: number;
+    fill: GradientSpec;
+} | {
+    op: "StrokePath";
+    path: string;
+    x: number;
+    y: number;
+    width: number;
+    color: string;
+    opacity: number;
+} | {
+    op: "DecorationLine";
+    from: {
+        x: number;
+        y: number;
+    };
+    to: {
+        x: number;
+        y: number;
+    };
+    width: number;
+    color: string;
+    opacity: number;
+};
+type EngineInit = {
+    width: number;
+    height: number;
+    pixelRatio?: number;
+    fps?: number;
+};
+type Renderer = {
+    render(ops: DrawOp[]): Promise<void>;
+    toPNG?: () => Promise<Buffer>;
+};
+type ValidAsset = RichTextValidated;
+
+interface VideoGenerationOptions {
+    width: number;
+    height: number;
+    fps: number;
+    duration: number;
+    outputPath: string;
+    pixelRatio?: number;
+    /** Optional quality controls (sane defaults provided) */
+    crf?: number;
+    preset?: "ultrafast" | "superfast" | "veryfast" | "faster" | "fast" | "medium" | "slow" | "slower" | "veryslow";
+    tune?: "film" | "animation" | "grain" | "stillimage" | "psnr" | "ssim" | "fastdecode" | "zerolatency";
+    profile?: "baseline" | "main" | "high";
+    level?: string;
+    pixFmt?: string;
+}
+
+declare function createTextEngine(opts?: {
+    width?: number;
+    height?: number;
+    pixelRatio?: number;
+    fps?: number;
+    wasmBaseURL?: string;
+}): Promise<{
+    validate(input: unknown): {
+        value: RichTextValidated;
+    };
+    registerFontFromFile(path: string, desc: {
+        family: string;
+        weight?: string | number;
+        style?: string;
+    }): Promise<void>;
+    registerFontFromUrl(url: string, desc: {
+        family: string;
+        weight?: string | number;
+        style?: string;
+    }): Promise<void>;
+    renderFrame(asset: RichTextValidated, tSeconds: number): Promise<DrawOp[]>;
+    createRenderer(p: {
+        width?: number;
+        height?: number;
+        pixelRatio?: number;
+    }): Promise<{
+        render(ops: DrawOp[]): Promise<void>;
+        toPNG(): Promise<Buffer>;
+    }>;
+    generateVideo(asset: RichTextValidated, options: Partial<VideoGenerationOptions>): Promise<void>;
+}>;
+
+export { type DrawOp, type EngineInit, type Glyph, type GradientSpec, type RGBA, type Renderer, type ShapedLine, type ValidAsset, createTextEngine };