@overtone-art/canvas-editor-core 0.2.6 → 0.2.8

package/dist/node.d.mts

@@ -0,0 +1,86 @@
+import { c as EditorState } from './types-D60CfxL9.mjs';
+import 'fabric';
+
+interface PrintPdfOptions {
+    /** Rasterization density. Defaults to the document DPI, or 300. */
+    dpi?: number;
+    /** Bleed on every edge, in inches. Defaults to 0.125in. */
+    bleed?: number;
+    /** Space outside bleed reserved for printer marks, in inches. Defaults to 0.25in. */
+    marksMargin?: number;
+    trimMarks?: boolean;
+    registrationMarks?: boolean;
+    /** Optional safe-area inset in inches for preflight warnings. */
+    safeArea?: number;
+    /** Sharp built-in `cmyk` profile or an absolute path to a custom ICC profile. */
+    iccProfile?: string;
+    /** Ceiling on the rasterized bleed image, in pixels. Defaults to 250 megapixels. */
+    maxPixels?: number;
+    outputConditionIdentifier?: string;
+    title?: string;
+    allowImageUrl?: NodeRenderOptions['allowImageUrl'];
+    /** Preserve SVG shapes/text over a CMYK bleed raster. Defaults to `vector`. */
+    rendering?: 'vector' | 'raster';
+    /** PDFKit font registrations keyed by the exact SVG font-family name. */
+    fontFiles?: Record<string, string | Uint8Array>;
+    /** Convert text backed by `fontFiles` into glyph paths. Defaults to true. */
+    outlineFonts?: boolean;
+}
+interface PrintPdfResult {
+    format: 'pdf';
+    mimeType: 'application/pdf';
+    data: Uint8Array;
+    standard: 'PDF/X-4';
+    colourSpace: 'CMYK';
+    rendering: 'vector' | 'raster';
+    outlinedFonts: string[];
+    unoutlinedFonts: string[];
+    dpi: number;
+    trimWidthPoints: number;
+    trimHeightPoints: number;
+    bleedPoints: number;
+    warnings: string[];
+}
+/**
+ * Render an EditorState into a print-production PDF/X-4 file.
+ *
+ * The design is rasterized at the requested density, converted through Sharp's
+ * CMYK ICC pipeline, edge-extended into bleed, and embedded with output intent,
+ * trim/bleed boxes, XMP identification, and optional printer marks.
+ */
+declare function renderPrintPdf(state: EditorState, options?: PrintPdfOptions): Promise<PrintPdfResult>;
+
+interface NodeRenderOptions {
+    format?: 'png' | 'jpeg' | 'webp' | 'svg';
+    multiplier?: number;
+    quality?: number;
+    /**
+     * Gate every image URL referenced by the state before it is loaded. States
+     * are authored in the browser and therefore untrusted on a server; the
+     * default policy allows only `http:`, `https:` and `data:`. Supply a
+     * narrower predicate (e.g. an origin allowlist) to also stop requests to
+     * internal hosts.
+     */
+    allowImageUrl?: (url: string) => boolean;
+}
+interface NodeRenderResult {
+    format: 'png' | 'jpeg' | 'webp' | 'svg';
+    mimeType: string;
+    data: Uint8Array | string;
+    width: number;
+    height: number;
+}
+/** Render browser-authored EditorState without a DOM or live editor instance. */
+declare function renderEditorState(state: EditorState, options?: NodeRenderOptions): Promise<NodeRenderResult>;
+/** Render a saved product mockup with the transparent design composited above it. */
+declare function renderMockupState(state: EditorState, options?: NodeRenderOptions): Promise<NodeRenderResult>;
+/** Render multiple states with bounded concurrency for fulfillment jobs. */
+declare function renderEditorStateBatch(states: EditorState[], options?: NodeRenderOptions & {
+    concurrency?: number;
+}): Promise<NodeRenderResult[]>;
+/** Render multiple mockup states with bounded concurrency for fulfillment jobs. */
+declare function renderMockupStateBatch(states: EditorState[], options?: NodeRenderOptions & {
+    concurrency?: number;
+}): Promise<NodeRenderResult[]>;
+
+export { type NodeRenderOptions, type NodeRenderResult, type PrintPdfOptions, type PrintPdfResult, renderEditorState, renderEditorStateBatch, renderMockupState, renderMockupStateBatch, renderPrintPdf };

package/dist/node.d.ts

@@ -0,0 +1,86 @@
+import { c as EditorState } from './types-D60CfxL9.js';
+import 'fabric';
+
+interface PrintPdfOptions {
+    /** Rasterization density. Defaults to the document DPI, or 300. */
+    dpi?: number;
+    /** Bleed on every edge, in inches. Defaults to 0.125in. */
+    bleed?: number;
+    /** Space outside bleed reserved for printer marks, in inches. Defaults to 0.25in. */
+    marksMargin?: number;
+    trimMarks?: boolean;
+    registrationMarks?: boolean;
+    /** Optional safe-area inset in inches for preflight warnings. */
+    safeArea?: number;
+    /** Sharp built-in `cmyk` profile or an absolute path to a custom ICC profile. */
+    iccProfile?: string;
+    /** Ceiling on the rasterized bleed image, in pixels. Defaults to 250 megapixels. */
+    maxPixels?: number;
+    outputConditionIdentifier?: string;
+    title?: string;
+    allowImageUrl?: NodeRenderOptions['allowImageUrl'];
+    /** Preserve SVG shapes/text over a CMYK bleed raster. Defaults to `vector`. */
+    rendering?: 'vector' | 'raster';
+    /** PDFKit font registrations keyed by the exact SVG font-family name. */
+    fontFiles?: Record<string, string | Uint8Array>;
+    /** Convert text backed by `fontFiles` into glyph paths. Defaults to true. */
+    outlineFonts?: boolean;
+}
+interface PrintPdfResult {
+    format: 'pdf';
+    mimeType: 'application/pdf';
+    data: Uint8Array;
+    standard: 'PDF/X-4';
+    colourSpace: 'CMYK';
+    rendering: 'vector' | 'raster';
+    outlinedFonts: string[];
+    unoutlinedFonts: string[];
+    dpi: number;
+    trimWidthPoints: number;
+    trimHeightPoints: number;
+    bleedPoints: number;
+    warnings: string[];
+}
+/**
+ * Render an EditorState into a print-production PDF/X-4 file.
+ *
+ * The design is rasterized at the requested density, converted through Sharp's
+ * CMYK ICC pipeline, edge-extended into bleed, and embedded with output intent,
+ * trim/bleed boxes, XMP identification, and optional printer marks.
+ */
+declare function renderPrintPdf(state: EditorState, options?: PrintPdfOptions): Promise<PrintPdfResult>;
+
+interface NodeRenderOptions {
+    format?: 'png' | 'jpeg' | 'webp' | 'svg';
+    multiplier?: number;
+    quality?: number;
+    /**
+     * Gate every image URL referenced by the state before it is loaded. States
+     * are authored in the browser and therefore untrusted on a server; the
+     * default policy allows only `http:`, `https:` and `data:`. Supply a
+     * narrower predicate (e.g. an origin allowlist) to also stop requests to
+     * internal hosts.
+     */
+    allowImageUrl?: (url: string) => boolean;
+}
+interface NodeRenderResult {
+    format: 'png' | 'jpeg' | 'webp' | 'svg';
+    mimeType: string;
+    data: Uint8Array | string;
+    width: number;
+    height: number;
+}
+/** Render browser-authored EditorState without a DOM or live editor instance. */
+declare function renderEditorState(state: EditorState, options?: NodeRenderOptions): Promise<NodeRenderResult>;
+/** Render a saved product mockup with the transparent design composited above it. */
+declare function renderMockupState(state: EditorState, options?: NodeRenderOptions): Promise<NodeRenderResult>;
+/** Render multiple states with bounded concurrency for fulfillment jobs. */
+declare function renderEditorStateBatch(states: EditorState[], options?: NodeRenderOptions & {
+    concurrency?: number;
+}): Promise<NodeRenderResult[]>;
+/** Render multiple mockup states with bounded concurrency for fulfillment jobs. */
+declare function renderMockupStateBatch(states: EditorState[], options?: NodeRenderOptions & {
+    concurrency?: number;
+}): Promise<NodeRenderResult[]>;
+
+export { type NodeRenderOptions, type NodeRenderResult, type PrintPdfOptions, type PrintPdfResult, renderEditorState, renderEditorStateBatch, renderMockupState, renderMockupStateBatch, renderPrintPdf };