rtistree 0.5.0

package/dist/export.d.ts

@@ -0,0 +1,405 @@
+import { type ExportPreset } from './document.js';
+import type { Project } from './project.js';
+export declare function outputProfile(root: string, preset: ExportPreset): Promise<{
+    path: string;
+    bytes: NonSharedBuffer;
+    hash: string;
+} | undefined>;
+export declare function preflight(project: Project, raw?: unknown): Promise<{
+    status: string;
+    scene_hash: string;
+    preset: {
+        format: "jpeg" | "pdf" | "png" | "svg" | "tiff";
+        colour_space: "cmyk" | "srgb";
+        profile?: string | undefined;
+        profile_hash?: string | undefined;
+        intent: "perceptual";
+        quality: number;
+        chroma_subsampling: "4:2:0" | "4:4:4";
+        background: string;
+        crop_marks: boolean;
+        minimum_ppi: number;
+        max_ink: number;
+        black: "k-only" | "profile";
+        mode: "hybrid" | "raster";
+        ppi?: number | undefined;
+    };
+    profile_hash: string | undefined;
+    geometry: {
+        trim_mm: [number, number];
+        bleed_mm: number;
+        safe_mm: number;
+        full_mm: [number, number];
+        pixels: [number, number];
+        trim_pt: [number, number];
+        bleed_pt: number;
+    } | undefined;
+    placements: {
+        layer: string;
+        source_pixels: number[];
+        placed_mm: number[];
+        effective_ppi: number;
+        resampled: boolean;
+    }[];
+    fonts: {
+        layer: string;
+        font: string;
+        weight: "bold" | "regular";
+        hash: string;
+        missing: string[];
+    }[];
+    issues: {
+        severity: 'error' | 'warning';
+        message: string;
+        layer?: string;
+    }[];
+    conformance: string;
+}>;
+export declare function inspectOutput(bytes: Buffer, format: string): Promise<{
+    format: string;
+    pages?: undefined;
+    images?: undefined;
+    embedded_fonts?: undefined;
+    profile_hashes?: undefined;
+    output_intents?: undefined;
+    width?: undefined;
+    height?: undefined;
+    colour_space?: undefined;
+    channels?: undefined;
+    depth?: undefined;
+    density?: undefined;
+    has_alpha?: undefined;
+    profile_hash?: undefined;
+} | {
+    format: string;
+    pages: {
+        media: {
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        };
+        trim: {
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        };
+        bleed: {
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        };
+    }[];
+    images: {
+        width: number;
+        height: number;
+        colour_space: string;
+    }[];
+    embedded_fonts: string[];
+    profile_hashes: string[];
+    output_intents: number;
+    width?: undefined;
+    height?: undefined;
+    colour_space?: undefined;
+    channels?: undefined;
+    depth?: undefined;
+    density?: undefined;
+    has_alpha?: undefined;
+    profile_hash?: undefined;
+} | {
+    pages?: undefined;
+    images?: undefined;
+    embedded_fonts?: undefined;
+    profile_hashes?: undefined;
+    output_intents?: undefined;
+    format: keyof import("sharp").FormatEnum;
+    width: number;
+    height: number;
+    colour_space: keyof import("sharp").ColourspaceEnum;
+    channels: import("sharp").Channels;
+    depth: keyof import("sharp").DepthEnum;
+    density: number | undefined;
+    has_alpha: boolean;
+    profile_hash: string | undefined;
+}>;
+export declare function exportArtwork(project: Project, file: string, raw?: unknown): Promise<{
+    status: string;
+    scene_hash: string;
+    preset: {
+        format: "jpeg" | "pdf" | "png" | "svg" | "tiff";
+        colour_space: "cmyk" | "srgb";
+        profile?: string | undefined;
+        profile_hash?: string | undefined;
+        intent: "perceptual";
+        quality: number;
+        chroma_subsampling: "4:2:0" | "4:4:4";
+        background: string;
+        crop_marks: boolean;
+        minimum_ppi: number;
+        max_ink: number;
+        black: "k-only" | "profile";
+        mode: "hybrid" | "raster";
+        ppi?: number | undefined;
+    };
+    profile_hash: string | undefined;
+    geometry: {
+        trim_mm: [number, number];
+        bleed_mm: number;
+        safe_mm: number;
+        full_mm: [number, number];
+        pixels: [number, number];
+        trim_pt: [number, number];
+        bleed_pt: number;
+    } | undefined;
+    placements: {
+        layer: string;
+        source_pixels: number[];
+        placed_mm: number[];
+        effective_ppi: number;
+        resampled: boolean;
+    }[];
+    fonts: {
+        layer: string;
+        font: string;
+        weight: "bold" | "regular";
+        hash: string;
+        missing: string[];
+    }[];
+    issues: {
+        severity: 'error' | 'warning';
+        message: string;
+        layer?: string;
+    }[];
+    conformance: string;
+    output_hash: string;
+    inspection: {
+        format: string;
+        pages?: undefined;
+        images?: undefined;
+        embedded_fonts?: undefined;
+        profile_hashes?: undefined;
+        output_intents?: undefined;
+        width?: undefined;
+        height?: undefined;
+        colour_space?: undefined;
+        channels?: undefined;
+        depth?: undefined;
+        density?: undefined;
+        has_alpha?: undefined;
+        profile_hash?: undefined;
+    } | {
+        format: string;
+        pages: {
+            media: {
+                x: number;
+                y: number;
+                width: number;
+                height: number;
+            };
+            trim: {
+                x: number;
+                y: number;
+                width: number;
+                height: number;
+            };
+            bleed: {
+                x: number;
+                y: number;
+                width: number;
+                height: number;
+            };
+        }[];
+        images: {
+            width: number;
+            height: number;
+            colour_space: string;
+        }[];
+        embedded_fonts: string[];
+        profile_hashes: string[];
+        output_intents: number;
+        width?: undefined;
+        height?: undefined;
+        colour_space?: undefined;
+        channels?: undefined;
+        depth?: undefined;
+        density?: undefined;
+        has_alpha?: undefined;
+        profile_hash?: undefined;
+    } | {
+        pages?: undefined;
+        images?: undefined;
+        embedded_fonts?: undefined;
+        profile_hashes?: undefined;
+        output_intents?: undefined;
+        format: keyof import("sharp").FormatEnum;
+        width: number;
+        height: number;
+        colour_space: keyof import("sharp").ColourspaceEnum;
+        channels: import("sharp").Channels;
+        depth: keyof import("sharp").DepthEnum;
+        density: number | undefined;
+        has_alpha: boolean;
+        profile_hash: string | undefined;
+    };
+    exporter: {
+        sharp: {
+            aom?: string | undefined;
+            archive?: string | undefined;
+            cairo?: string | undefined;
+            cgif?: string | undefined;
+            exif?: string | undefined;
+            expat?: string | undefined;
+            ffi?: string | undefined;
+            fontconfig?: string | undefined;
+            freetype?: string | undefined;
+            fribidi?: string | undefined;
+            glib?: string | undefined;
+            harfbuzz?: string | undefined;
+            heif?: string | undefined;
+            highway?: string | undefined;
+            imagequant?: string | undefined;
+            lcms?: string | undefined;
+            mozjpeg?: string | undefined;
+            pango?: string | undefined;
+            pixman?: string | undefined;
+            png?: string | undefined;
+            "proxy-libintl"?: string | undefined;
+            rsvg?: string | undefined;
+            sharp: string;
+            spng?: string | undefined;
+            tiff?: string | undefined;
+            vips: string;
+            webp?: string | undefined;
+            xml?: string | undefined;
+            "zlib-ng"?: string | undefined;
+        };
+        pdf: string;
+    };
+    file: string;
+    evidence: string;
+}>;
+/** ICC round-trip preview; monitor/paper simulation and certification are outside this function. */
+export declare function softProof(project: Project, file: string, raw?: unknown): Promise<{
+    status: string;
+    scene_hash: string;
+    preset: {
+        format: "jpeg" | "pdf" | "png" | "svg" | "tiff";
+        colour_space: "cmyk" | "srgb";
+        profile?: string | undefined;
+        profile_hash?: string | undefined;
+        intent: "perceptual";
+        quality: number;
+        chroma_subsampling: "4:2:0" | "4:4:4";
+        background: string;
+        crop_marks: boolean;
+        minimum_ppi: number;
+        max_ink: number;
+        black: "k-only" | "profile";
+        mode: "hybrid" | "raster";
+        ppi?: number | undefined;
+    };
+    profile_hash: string | undefined;
+    geometry: {
+        trim_mm: [number, number];
+        bleed_mm: number;
+        safe_mm: number;
+        full_mm: [number, number];
+        pixels: [number, number];
+        trim_pt: [number, number];
+        bleed_pt: number;
+    } | undefined;
+    placements: {
+        layer: string;
+        source_pixels: number[];
+        placed_mm: number[];
+        effective_ppi: number;
+        resampled: boolean;
+    }[];
+    fonts: {
+        layer: string;
+        font: string;
+        weight: "bold" | "regular";
+        hash: string;
+        missing: string[];
+    }[];
+    issues: {
+        severity: 'error' | 'warning';
+        message: string;
+        layer?: string;
+    }[];
+    conformance: string;
+    inspection: {
+        format: string;
+        pages?: undefined;
+        images?: undefined;
+        embedded_fonts?: undefined;
+        profile_hashes?: undefined;
+        output_intents?: undefined;
+        width?: undefined;
+        height?: undefined;
+        colour_space?: undefined;
+        channels?: undefined;
+        depth?: undefined;
+        density?: undefined;
+        has_alpha?: undefined;
+        profile_hash?: undefined;
+    } | {
+        format: string;
+        pages: {
+            media: {
+                x: number;
+                y: number;
+                width: number;
+                height: number;
+            };
+            trim: {
+                x: number;
+                y: number;
+                width: number;
+                height: number;
+            };
+            bleed: {
+                x: number;
+                y: number;
+                width: number;
+                height: number;
+            };
+        }[];
+        images: {
+            width: number;
+            height: number;
+            colour_space: string;
+        }[];
+        embedded_fonts: string[];
+        profile_hashes: string[];
+        output_intents: number;
+        width?: undefined;
+        height?: undefined;
+        colour_space?: undefined;
+        channels?: undefined;
+        depth?: undefined;
+        density?: undefined;
+        has_alpha?: undefined;
+        profile_hash?: undefined;
+    } | {
+        pages?: undefined;
+        images?: undefined;
+        embedded_fonts?: undefined;
+        profile_hashes?: undefined;
+        output_intents?: undefined;
+        format: keyof import("sharp").FormatEnum;
+        width: number;
+        height: number;
+        colour_space: keyof import("sharp").ColourspaceEnum;
+        channels: import("sharp").Channels;
+        depth: keyof import("sharp").DepthEnum;
+        density: number | undefined;
+        has_alpha: boolean;
+        profile_hash: string | undefined;
+    };
+    output_hash: string;
+    method: string;
+    file: string;
+}>;