locusing 0.1.2

package/dist/export.d.mts

@@ -0,0 +1,194 @@
+import { D as Diagram, S as Scene } from './diagram-Djxa_kGR.mjs';
+
+/**
+ * @locusing/export - 类型定义
+ *
+ * Playwright 图片导出相关类型
+ */
+/**
+ * 导出格式
+ */
+type ExportFormat = 'png' | 'jpeg' | 'webp';
+/**
+ * 导出选项
+ */
+interface ExportOptions {
+    /** 输出格式，默认 'png' */
+    format?: ExportFormat;
+    /** 图片质量 (0-100)，仅对 jpeg/webp 有效，默认 90 */
+    quality?: number;
+    /** 像素密度 (1 = 72dpi, 2 = 144dpi)，默认 2 */
+    deviceScaleFactor?: number;
+    /** 画布宽度 (像素)，默认 1920 */
+    width?: number;
+    /** 画布高度 (像素)，默认 1080 */
+    height?: number;
+    /** 背景色，默认透明 */
+    background?: string;
+    /** 是否等待字体加载，默认 true */
+    waitForFonts?: boolean;
+    /** 渲染等待时间 (毫秒)，默认 100 */
+    renderDelay?: number;
+    /** 是否使用 Frame 模式，默认 true */
+    frame?: boolean;
+}
+/**
+ * 导出结果
+ */
+interface ExportResult {
+    /** 图片 Buffer */
+    buffer: Buffer;
+    /** MIME 类型 */
+    mimeType: string;
+    /** 实际宽度 (像素) */
+    width: number;
+    /** 实际高度 (像素) */
+    height: number;
+}
+/**
+ * PlaywrightExporter 配置
+ */
+interface PlaywrightExporterOptions {
+    /** 是否使用无头模式，默认 true */
+    headless?: boolean;
+    /** 浏览器类型，默认 'chromium' */
+    browser?: 'chromium' | 'firefox' | 'webkit';
+}
+/**
+ * Scene 导出选项
+ */
+interface SceneExportOptions extends ExportOptions {
+    /** 导出特定帧的时间点 (秒)，默认 0 (第一帧) */
+    frameTime?: number;
+}
+
+/**
+ * @locusing/export - Playwright 导出器
+ *
+ * 使用 Playwright 截图实现高保真图片导出
+ */
+
+/**
+ * Playwright 导出器
+ *
+ * 使用真实浏览器渲染 SVG 并截图，确保与浏览器显示效果完全一致。
+ * 支持 TeX 公式等复杂内容的导出。
+ *
+ * @example
+ * ```typescript
+ * import { PlaywrightExporter, circle, tex, combine } from 'locusing';
+ *
+ * const exporter = new PlaywrightExporter();
+ * await exporter.launch();
+ *
+ * const diagram = combine(
+ *   circle(1).fill('#EA580C'),
+ *   tex('E = mc^2').move([0, -2])
+ * );
+ *
+ * const result = await exporter.exportDiagram(diagram, {
+ *   width: 1920,
+ *   height: 1080,
+ *   deviceScaleFactor: 2,
+ * });
+ *
+ * await fs.writeFile('output.png', result.buffer);
+ * await exporter.close();
+ * ```
+ */
+declare class PlaywrightExporter {
+    private browser;
+    private page;
+    private options;
+    constructor(options?: PlaywrightExporterOptions);
+    /**
+     * 启动浏览器
+     *
+     * @throws 如果 Playwright 未安装
+     */
+    launch(): Promise<void>;
+    /**
+     * 关闭浏览器
+     */
+    close(): Promise<void>;
+    /**
+     * 获取页面实例，确保已启动
+     */
+    private getPage;
+    /**
+     * 导出 Diagram 为图片
+     *
+     * @param diagram - 要导出的 Diagram
+     * @param options - 导出选项
+     * @returns 导出结果
+     */
+    exportDiagram(diagram: Diagram, options?: ExportOptions): Promise<ExportResult>;
+    /**
+     * 导出 Scene 为图片（静态帧）
+     *
+     * @param SceneClass - Scene 类
+     * @param options - 导出选项
+     * @returns 导出结果
+     */
+    exportScene(SceneClass: new () => Scene, options?: SceneExportOptions): Promise<ExportResult>;
+    /**
+     * 导出 SVG 字符串为图片
+     *
+     * @param svgString - SVG 字符串
+     * @param options - 导出选项
+     * @returns 导出结果
+     */
+    exportSVGString(svgString: string, options?: ExportOptions): Promise<ExportResult>;
+}
+/**
+ * 便捷函数：一次性导出 Diagram 为 PNG
+ *
+ * @param diagram - 要导出的 Diagram
+ * @param outputPath - 输出文件路径
+ * @param options - 导出选项
+ *
+ * @example
+ * ```typescript
+ * import { exportToPNG, circle } from 'locusing';
+ *
+ * await exportToPNG(circle(1).fill('#EA580C'), 'circle.png', {
+ *   width: 800,
+ *   height: 600
+ * });
+ * ```
+ */
+declare function exportToPNG(diagram: Diagram, outputPath: string, options?: ExportOptions): Promise<void>;
+/**
+ * 便捷函数：一次性导出 SVG 字符串为 PNG
+ *
+ * @param svgString - SVG 字符串
+ * @param outputPath - 输出文件路径
+ * @param options - 导出选项
+ */
+declare function exportSVGToPNG(svgString: string, outputPath: string, options?: ExportOptions): Promise<void>;
+
+/**
+ * @locusing/export - HTML 模板生成
+ *
+ * 生成用于 Playwright 截图的 HTML 页面
+ */
+
+/**
+ * 生成导出用的 HTML 模板
+ *
+ * @param svgContent - SVG 字符串内容
+ * @param options - 导出选项
+ * @returns 完整的 HTML 字符串
+ */
+declare function generateExportHTML(svgContent: string, options: Pick<ExportOptions, 'width' | 'height' | 'background'>): string;
+/**
+ * 内联 KaTeX CSS（用于离线导出）
+ *
+ * @param katexCSS - KaTeX CSS 内容
+ * @param svgContent - SVG 字符串内容
+ * @param options - 导出选项
+ * @returns 包含内联 CSS 的 HTML 字符串
+ */
+declare function generateExportHTMLWithInlineCSS(katexCSS: string, svgContent: string, options: Pick<ExportOptions, 'width' | 'height' | 'background'>): string;
+
+export { type ExportFormat, type ExportOptions, type ExportResult, PlaywrightExporter, type PlaywrightExporterOptions, type SceneExportOptions, exportSVGToPNG, exportToPNG, generateExportHTML, generateExportHTMLWithInlineCSS };

package/dist/export.d.ts

@@ -0,0 +1,194 @@
+import { D as Diagram, S as Scene } from './diagram-Djxa_kGR.js';
+
+/**
+ * @locusing/export - 类型定义
+ *
+ * Playwright 图片导出相关类型
+ */
+/**
+ * 导出格式
+ */
+type ExportFormat = 'png' | 'jpeg' | 'webp';
+/**
+ * 导出选项
+ */
+interface ExportOptions {
+    /** 输出格式，默认 'png' */
+    format?: ExportFormat;
+    /** 图片质量 (0-100)，仅对 jpeg/webp 有效，默认 90 */
+    quality?: number;
+    /** 像素密度 (1 = 72dpi, 2 = 144dpi)，默认 2 */
+    deviceScaleFactor?: number;
+    /** 画布宽度 (像素)，默认 1920 */
+    width?: number;
+    /** 画布高度 (像素)，默认 1080 */
+    height?: number;
+    /** 背景色，默认透明 */
+    background?: string;
+    /** 是否等待字体加载，默认 true */
+    waitForFonts?: boolean;
+    /** 渲染等待时间 (毫秒)，默认 100 */
+    renderDelay?: number;
+    /** 是否使用 Frame 模式，默认 true */
+    frame?: boolean;
+}
+/**
+ * 导出结果
+ */
+interface ExportResult {
+    /** 图片 Buffer */
+    buffer: Buffer;
+    /** MIME 类型 */
+    mimeType: string;
+    /** 实际宽度 (像素) */
+    width: number;
+    /** 实际高度 (像素) */
+    height: number;
+}
+/**
+ * PlaywrightExporter 配置
+ */
+interface PlaywrightExporterOptions {
+    /** 是否使用无头模式，默认 true */
+    headless?: boolean;
+    /** 浏览器类型，默认 'chromium' */
+    browser?: 'chromium' | 'firefox' | 'webkit';
+}
+/**
+ * Scene 导出选项
+ */
+interface SceneExportOptions extends ExportOptions {
+    /** 导出特定帧的时间点 (秒)，默认 0 (第一帧) */
+    frameTime?: number;
+}
+
+/**
+ * @locusing/export - Playwright 导出器
+ *
+ * 使用 Playwright 截图实现高保真图片导出
+ */
+
+/**
+ * Playwright 导出器
+ *
+ * 使用真实浏览器渲染 SVG 并截图，确保与浏览器显示效果完全一致。
+ * 支持 TeX 公式等复杂内容的导出。
+ *
+ * @example
+ * ```typescript
+ * import { PlaywrightExporter, circle, tex, combine } from 'locusing';
+ *
+ * const exporter = new PlaywrightExporter();
+ * await exporter.launch();
+ *
+ * const diagram = combine(
+ *   circle(1).fill('#EA580C'),
+ *   tex('E = mc^2').move([0, -2])
+ * );
+ *
+ * const result = await exporter.exportDiagram(diagram, {
+ *   width: 1920,
+ *   height: 1080,
+ *   deviceScaleFactor: 2,
+ * });
+ *
+ * await fs.writeFile('output.png', result.buffer);
+ * await exporter.close();
+ * ```
+ */
+declare class PlaywrightExporter {
+    private browser;
+    private page;
+    private options;
+    constructor(options?: PlaywrightExporterOptions);
+    /**
+     * 启动浏览器
+     *
+     * @throws 如果 Playwright 未安装
+     */
+    launch(): Promise<void>;
+    /**
+     * 关闭浏览器
+     */
+    close(): Promise<void>;
+    /**
+     * 获取页面实例，确保已启动
+     */
+    private getPage;
+    /**
+     * 导出 Diagram 为图片
+     *
+     * @param diagram - 要导出的 Diagram
+     * @param options - 导出选项
+     * @returns 导出结果
+     */
+    exportDiagram(diagram: Diagram, options?: ExportOptions): Promise<ExportResult>;
+    /**
+     * 导出 Scene 为图片（静态帧）
+     *
+     * @param SceneClass - Scene 类
+     * @param options - 导出选项
+     * @returns 导出结果
+     */
+    exportScene(SceneClass: new () => Scene, options?: SceneExportOptions): Promise<ExportResult>;
+    /**
+     * 导出 SVG 字符串为图片
+     *
+     * @param svgString - SVG 字符串
+     * @param options - 导出选项
+     * @returns 导出结果
+     */
+    exportSVGString(svgString: string, options?: ExportOptions): Promise<ExportResult>;
+}
+/**
+ * 便捷函数：一次性导出 Diagram 为 PNG
+ *
+ * @param diagram - 要导出的 Diagram
+ * @param outputPath - 输出文件路径
+ * @param options - 导出选项
+ *
+ * @example
+ * ```typescript
+ * import { exportToPNG, circle } from 'locusing';
+ *
+ * await exportToPNG(circle(1).fill('#EA580C'), 'circle.png', {
+ *   width: 800,
+ *   height: 600
+ * });
+ * ```
+ */
+declare function exportToPNG(diagram: Diagram, outputPath: string, options?: ExportOptions): Promise<void>;
+/**
+ * 便捷函数：一次性导出 SVG 字符串为 PNG
+ *
+ * @param svgString - SVG 字符串
+ * @param outputPath - 输出文件路径
+ * @param options - 导出选项
+ */
+declare function exportSVGToPNG(svgString: string, outputPath: string, options?: ExportOptions): Promise<void>;
+
+/**
+ * @locusing/export - HTML 模板生成
+ *
+ * 生成用于 Playwright 截图的 HTML 页面
+ */
+
+/**
+ * 生成导出用的 HTML 模板
+ *
+ * @param svgContent - SVG 字符串内容
+ * @param options - 导出选项
+ * @returns 完整的 HTML 字符串
+ */
+declare function generateExportHTML(svgContent: string, options: Pick<ExportOptions, 'width' | 'height' | 'background'>): string;
+/**
+ * 内联 KaTeX CSS（用于离线导出）
+ *
+ * @param katexCSS - KaTeX CSS 内容
+ * @param svgContent - SVG 字符串内容
+ * @param options - 导出选项
+ * @returns 包含内联 CSS 的 HTML 字符串
+ */
+declare function generateExportHTMLWithInlineCSS(katexCSS: string, svgContent: string, options: Pick<ExportOptions, 'width' | 'height' | 'background'>): string;
+
+export { type ExportFormat, type ExportOptions, type ExportResult, PlaywrightExporter, type PlaywrightExporterOptions, type SceneExportOptions, exportSVGToPNG, exportToPNG, generateExportHTML, generateExportHTMLWithInlineCSS };