@filekit-studio/sketch 0.0.0-stage → 1.1.0

package/dist/index-DNRZSQHn.d.ts

@@ -0,0 +1,192 @@
+type ToolType = 'select' | 'hand' | 'rectangle' | 'ellipse' | 'diamond' | 'triangle' | 'capsule' | 'parallelogram' | 'trapezoid' | 'hexagon' | 'cylinder' | 'cloud' | 'star' | 'table' | 'arrow' | 'line' | 'pen' | 'text' | 'sticky' | 'frame' | 'eraser' | 'laser';
+type LaserMode = 'fading' | 'persistent';
+interface LaserPoint {
+    x: number;
+    y: number;
+    timestamp: number;
+}
+interface LaserStroke {
+    id: string;
+    points: LaserPoint[];
+    color: string;
+    mode: LaserMode;
+}
+interface TableCell {
+    text: string;
+    align?: 'left' | 'center' | 'right';
+    fill?: string;
+    bold?: boolean;
+    color?: string;
+}
+type TablePresetStyle = 'simple' | 'zebra' | 'header-accent' | 'swot' | 'kanban';
+type ElementType = 'rectangle' | 'ellipse' | 'diamond' | 'triangle' | 'capsule' | 'parallelogram' | 'trapezoid' | 'hexagon' | 'cylinder' | 'cloud' | 'star' | 'table' | 'arrow' | 'line' | 'pen' | 'text' | 'sticky' | 'image' | 'frame';
+type FillStyle = 'transparent' | 'solid' | 'hachure' | 'hachure-right' | 'cross-hatch' | 'dots';
+type StrokeStyle = 'solid' | 'dashed' | 'dotted';
+type FontFamily = 'fuzzy' | 'comic' | 'handlee' | 'edusa' | 'sans' | 'mono' | 'patrick' | 'caveat' | 'playpen' | 'serif';
+type TextAlign = 'left' | 'center' | 'right';
+type ArrowType = 'straight' | 'curved' | 'elbow';
+type Arrowhead = 'none' | 'arrow' | 'triangle' | 'barbed' | 'dot' | 'circle' | 'diamond' | 'diamond_outline' | 'bar' | 'crowfoot_one' | 'crowfoot_many' | 'crowfoot_one_many' | 'crowfoot_strictly_one' | 'crowfoot_zero_one' | 'crowfoot_zero_many';
+type EdgeStyle = 'sharp' | 'round';
+type AnchorPosition = 'top' | 'top-left' | 'top-right' | 'bottom' | 'bottom-left' | 'bottom-right' | 'left' | 'left-top' | 'left-bottom' | 'right' | 'right-top' | 'right-bottom' | 'center';
+interface PointBinding {
+    elementId: string;
+    anchor: AnchorPosition;
+}
+interface Point {
+    x: number;
+    y: number;
+    pressure?: number;
+}
+interface SketchBoardElement {
+    id: string;
+    type: ElementType;
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    rotation?: number;
+    strokeColor: string;
+    strokeWidth: number;
+    strokeStyle: StrokeStyle;
+    fillColor: string;
+    fillStyle: FillStyle;
+    opacity: number;
+    zIndex: number;
+    edgeStyle?: EdgeStyle;
+    roughStyle?: 'clean' | 'rough';
+    roughness?: number;
+    points?: Point[];
+    arrowType?: ArrowType;
+    startArrowhead?: Arrowhead | boolean | null;
+    endArrowhead?: Arrowhead | boolean | null;
+    startBinding?: PointBinding | null;
+    endBinding?: PointBinding | null;
+    controlPoint?: Point;
+    controlPoint1?: Point;
+    controlPoint2?: Point;
+    text?: string;
+    fontSize?: number;
+    fontFamily?: FontFamily;
+    textAlign?: TextAlign;
+    stickyColor?: string;
+    rows?: number;
+    cols?: number;
+    rowHeights?: number[];
+    colWidths?: number[];
+    cells?: Record<string, TableCell>;
+    hasHeaderRow?: boolean;
+    hasHeaderCol?: boolean;
+    tableStyle?: TablePresetStyle;
+    editingCell?: {
+        row: number;
+        col: number;
+    };
+    dataUrl?: string;
+    naturalWidth?: number;
+    naturalHeight?: number;
+    aspectRatioLocked?: boolean;
+    frameLabel?: string;
+    framePreset?: string;
+    frameId?: string;
+    groupIds?: string[];
+    isLocked?: boolean;
+}
+interface Camera {
+    x: number;
+    y: number;
+    zoom: number;
+}
+type GridStyle = 'dots' | 'grid' | 'cross' | 'none';
+interface ResizeHandle {
+    type: 'nw' | 'n' | 'ne' | 'e' | 'se' | 's' | 'sw' | 'w' | 'rotate' | 'start' | 'middle' | 'control1' | 'control2' | 'end';
+    x: number;
+    y: number;
+    cursor: string;
+}
+interface MarqueeBox {
+    startX: number;
+    startY: number;
+    currentX: number;
+    currentY: number;
+}
+interface CanvasDimensions {
+    width: number;
+    height: number;
+}
+
+declare function isDarkColor(color: string): boolean;
+/**
+ * Calculate the overall bounding box of all elements
+ */
+declare function getElementsBoundingBox(elements: SketchBoardElement[], padding?: number): {
+    minX: number;
+    minY: number;
+    maxX: number;
+    maxY: number;
+    width: number;
+    height: number;
+};
+interface ExportOptions {
+    scale?: number;
+    backgroundColor?: string;
+    gridStyle?: GridStyle;
+    padding?: number;
+    isDark?: boolean;
+}
+/**
+ * Export elements to PNG blob / data URL
+ */
+declare function exportToPng(elements: SketchBoardElement[], options?: ExportOptions): Promise<string>;
+/**
+ * Export elements as SVG markup string
+ */
+declare function exportToSvg(elements: SketchBoardElement[], options?: ExportOptions): string;
+/**
+ * Trigger file download helper
+ */
+declare function downloadFile(content: string, filename: string, mimeType: string): void;
+/**
+ * Copy exported PNG to system clipboard via navigator.clipboard.write
+ */
+declare function copyImageToClipboard(elements: SketchBoardElement[], options?: {
+    scale?: number;
+    backgroundColor?: string;
+    padding?: number;
+}): Promise<boolean>;
+/**
+ * Get all elements contained inside a specific frame
+ */
+declare function getFrameContainedElements(frame: SketchBoardElement, allElements: SketchBoardElement[]): SketchBoardElement[];
+/**
+ * Export an individual frame with exact clipping
+ */
+declare function exportFrameToPng(frame: SketchBoardElement, allElements: SketchBoardElement[], options?: ExportOptions): Promise<string>;
+
+type PdfOrientation = 'portrait' | 'landscape';
+type PdfAppearance = 'original' | 'light' | 'dark';
+
+interface ExportPdfOptions {
+    orientation?: PdfOrientation;
+    appearance?: PdfAppearance;
+    margin?: number;
+    boardName?: string;
+    canvasBackground?: string;
+    isDark?: boolean;
+    isSelection?: boolean;
+    onProgress?: (current: number, total: number) => void;
+}
+interface ExportPdfResult {
+    success: boolean;
+    pageCount: number;
+    filename: string;
+}
+/**
+ * Preload all image elements asynchronously before offscreen rendering
+ */
+declare function preloadImageElements(elements: SketchBoardElement[]): Promise<void>;
+/**
+ * Exports whiteboard elements to a paginated A4 PDF
+ */
+declare function exportWhiteboardToPdf(elements: SketchBoardElement[], options?: ExportPdfOptions): Promise<ExportPdfResult>;
+
+export { type AnchorPosition as A, type Camera as C, type EdgeStyle as E, type FillStyle as F, type GridStyle as G, type LaserMode as L, type MarqueeBox as M, type Point as P, type ResizeHandle as R, type SketchBoardElement as S, type ToolType as T, type LaserStroke as a, type ArrowType as b, type Arrowhead as c, type CanvasDimensions as d, type ElementType as e, type ExportPdfOptions as f, type ExportPdfResult as g, type FontFamily as h, type LaserPoint as i, type PointBinding as j, type StrokeStyle as k, type TableCell as l, type TablePresetStyle as m, type TextAlign as n, copyImageToClipboard as o, downloadFile as p, exportFrameToPng as q, exportToPng as r, exportToSvg as s, exportWhiteboardToPdf as t, getElementsBoundingBox as u, type PdfAppearance as v, type PdfOrientation as w, getFrameContainedElements as x, isDarkColor as y, preloadImageElements as z };