@cardenelabs/dragon 0.34.0 → 0.35.0

package/dist/export.d.cts

@@ -0,0 +1,36 @@
+import { T as Theme, N as NotationLang, V as ViewMode } from './schema-BBWfniwH.cjs';
+
+type ExportFormat = "mp4" | "gif" | "html" | "png";
+interface ExportOptions {
+    /** 書き出す先の dir。無ければ作り、書き出しに失敗した時は作った dir を残さない (#3013) */
+    outDir: string;
+    /** file の名前 (拡張子を除く)。既定は `diagram` */
+    name?: string;
+    /** 書き出す形。既定は 4 つ全て */
+    formats?: ExportFormat[];
+    /** 枠の幅 (CSS の px)。見せ方を選び、寄って見せる窓の幅になる */
+    width?: number;
+    palette?: string;
+    theme?: Theme;
+    /** mp4 の 1 秒のコマの数 */
+    fps?: number;
+    /** GIF の 1 秒のコマの数 */
+    gifFps?: number;
+    /** 図の中の字 (全体図の札、HTML の読み上げの名前、描けない時の断りの文) の言葉。書かなければ日本語 (#3001) */
+    lang?: NotationLang;
+}
+interface ExportResult {
+    /** 書き出した file の path */
+    files: Partial<Record<ExportFormat, string>>;
+    view: ViewMode;
+    /** 撮ったコマの数 */
+    frames: number;
+    /** 動画のコマの大きさ (CSS の px)。撮る画素はこの 2 倍 */
+    width: number;
+    height: number;
+}
+/** 書き出せる形。命令が `--format` の値を確かめる時にも使う */
+declare const FORMATS: readonly ExportFormat[];
+declare function exportDiagram(input: unknown, options: ExportOptions): Promise<ExportResult>;
+
+export { type ExportFormat, type ExportOptions, type ExportResult, FORMATS, exportDiagram };

package/dist/export.d.ts

@@ -0,0 +1,36 @@
+import { T as Theme, N as NotationLang, V as ViewMode } from './schema-BBWfniwH.js';
+
+type ExportFormat = "mp4" | "gif" | "html" | "png";
+interface ExportOptions {
+    /** 書き出す先の dir。無ければ作り、書き出しに失敗した時は作った dir を残さない (#3013) */
+    outDir: string;
+    /** file の名前 (拡張子を除く)。既定は `diagram` */
+    name?: string;
+    /** 書き出す形。既定は 4 つ全て */
+    formats?: ExportFormat[];
+    /** 枠の幅 (CSS の px)。見せ方を選び、寄って見せる窓の幅になる */
+    width?: number;
+    palette?: string;
+    theme?: Theme;
+    /** mp4 の 1 秒のコマの数 */
+    fps?: number;
+    /** GIF の 1 秒のコマの数 */
+    gifFps?: number;
+    /** 図の中の字 (全体図の札、HTML の読み上げの名前、描けない時の断りの文) の言葉。書かなければ日本語 (#3001) */
+    lang?: NotationLang;
+}
+interface ExportResult {
+    /** 書き出した file の path */
+    files: Partial<Record<ExportFormat, string>>;
+    view: ViewMode;
+    /** 撮ったコマの数 */
+    frames: number;
+    /** 動画のコマの大きさ (CSS の px)。撮る画素はこの 2 倍 */
+    width: number;
+    height: number;
+}
+/** 書き出せる形。命令が `--format` の値を確かめる時にも使う */
+declare const FORMATS: readonly ExportFormat[];
+declare function exportDiagram(input: unknown, options: ExportOptions): Promise<ExportResult>;
+
+export { type ExportFormat, type ExportOptions, type ExportResult, FORMATS, exportDiagram };