@cardenelabs/dragon 0.35.1 → 0.36.1

package/dist/index.d.cts

@@ -1,5 +1,5 @@
-import { N as NotationLang, D as Diagram, F as FieldError, C as CheckOptions, a as ColorKey, b as Carry, T as Theme, V as ViewMode } from './schema-BBWfniwH.cjs';
-export { B as Box, c as Checked, d as Color, e as DEFAULT_PALETTE, f as DiagramEvent, L as LabelSide, P as PALETTES, g as Palette, R as Region, S as Step, n as notationLanguage, r as resolvePalette, v as validateDiagram } from './schema-BBWfniwH.cjs';
+import { N as NotationLang, D as Diagram, F as FieldError, C as CheckOptions, a as ColorKey, b as Carry, T as Theme, V as ViewMode } from './schema-9VLameDG.cjs';
+export { B as Box, c as Checked, d as Color, e as DEFAULT_PALETTE, f as DiagramEvent, L as LabelSide, P as PALETTES, g as Palette, R as READABLE_PX, h as Region, S as Step, r as resolvePalette, v as validateDiagram } from './schema-9VLameDG.cjs';
 
 /**
  * 図が使う 2 つの字。どちらも package の依存として同梱する。
@@ -41,28 +41,25 @@ type Parsed = {
     errors: LineError[];
 };
 interface ParseOptions {
-    /** 最初の行が読めず file の言葉が決まらない時に、誤りの文に使う言葉。既定は日本語 */
+    /** 誤りの文の言葉。既定は日本語 */
     lang?: NotationLang;
 }
 declare function parseNotation(notation: string, options?: ParseOptions): Parsed;
 
 /**
- * 図の原本の JSON を、人が書く記法へ書き戻す。
+ * 図の原本の JSON を、人が書く dragon記法へ書き戻す (#3137)。
  *
  * 並べ方は決まった形に整える。JSON の欄の並び順は見ず、欄の名前で読むので、
  * 同じ内容の JSON からは毎回同じ文字列になる。書き手の行の並べ方とコメントは保たない。
  * 段の中で起きることは JSON の並び順 (起きる順) のまま書く。
  *
- * 語は渡した言葉で書く (#2997)。渡さなければ日本語で書く。
- * 英語では添え書きと下の字と書き換えの字を `"…"` で囲み、名前か字に `"` を含む物だけ「」で囲む。
- * 英語の語の file でも「」は読めるので、読み直すと同じ JSON に戻る。
+ * `"` で囲むのは要る時だけにする。`[` を含む名前と、`,` か `]` を含む属性の値と、`"` で始まる字を囲む。
+ * 箱は JSON の並びのまま書き、同じ区画の箱が続く所を 1 つの `group … end` にする。
+ * 区画の箱が飛び飛びの時は同じ `group` を開き直す。区画の並びが箱の現れる順と違う時と、
+ * 箱の無い区画がある時は、先に全ての区画を中の無い `group … end` で宣言してから開き直す。
  */
 
-interface PrintOptions {
-    /** 記法の語の言葉。既定は日本語 */
-    lang?: NotationLang;
-}
-declare function printNotation(diagram: Diagram, options?: PrintOptions): string;
+declare function printNotation(diagram: Diagram): string;
 
 /** この道具が読める原本の版 */
 declare const FORMAT_VERSION = 1;
@@ -248,6 +245,15 @@ interface Rendered {
 /** 原本の JSON から図を描く。原本が形に合わない時は、誤りの場所を添えて断る。 */
 declare function renderDiagram(input: unknown, options?: RenderOptions): Rendered;
 
+interface PlayerOptions extends RenderOptions {
+    /** 段が替わるたびに今の段 (0 から) を受け取る。置いた時にも最初の段で 1 度呼ぶ。頁の側で段の札や進み具合を出す時に使う (#3031) */
+    onStep?: (step: number) => void;
+    /**
+     * 図を、図の枠の中で見える高さに収める (#3047)。高さに収めると字が読めない図は寄って追う図にし、寄って追う窓と全体図をその高さに収める。
+     * 枠の高さが決まっている置き場 (カタログの拡大の重ね窓) で使う。枠の高さが図に合わせて伸びる置き場で使うと、描くたびに低くなる
+     */
+    fitHeight?: boolean;
+}
 interface Player {
     /** 今の段 (0 から) */
     readonly step: number;
@@ -259,11 +265,11 @@ interface Player {
     pause(): void;
     destroy(): void;
 }
-declare function mountDiagram(host: HTMLElement, diagram: unknown, options?: RenderOptions): Player;
+declare function mountDiagram(host: HTMLElement, diagram: unknown, options?: PlayerOptions): Player;
 
-declare function chooseView(rendered: Pick<Rendered, "layout" | "view">, frameWidth: number): {
+declare function chooseView(rendered: Pick<Rendered, "layout" | "view">, frameWidth: number, frameHeight?: number): {
     mode: ViewMode;
     textPx: number;
 };
 
-export { Carry, CheckOptions, Diagram, FONTS, FORMAT_VERSION, type Fence, FieldError, type Layout, type LineError, type Migrated, NotationLang, type ParseOptions, type Parsed, type Player, type PrintOptions, type Read, type RenderOptions, type Rendered, Theme, type Timeline, ViewMode, chooseView, extractDiagrams, migrateFile, mountDiagram, parseNotation, printNotation, readDiagram, renderDiagram };
+export { Carry, CheckOptions, Diagram, FONTS, FORMAT_VERSION, type Fence, FieldError, type Layout, type LineError, type Migrated, NotationLang, type ParseOptions, type Parsed, type Player, type Read, type RenderOptions, type Rendered, Theme, type Timeline, ViewMode, chooseView, extractDiagrams, migrateFile, mountDiagram, parseNotation, printNotation, readDiagram, renderDiagram };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { N as NotationLang, D as Diagram, F as FieldError, C as CheckOptions, a as ColorKey, b as Carry, T as Theme, V as ViewMode } from './schema-BBWfniwH.js';
-export { B as Box, c as Checked, d as Color, e as DEFAULT_PALETTE, f as DiagramEvent, L as LabelSide, P as PALETTES, g as Palette, R as Region, S as Step, n as notationLanguage, r as resolvePalette, v as validateDiagram } from './schema-BBWfniwH.js';
+import { N as NotationLang, D as Diagram, F as FieldError, C as CheckOptions, a as ColorKey, b as Carry, T as Theme, V as ViewMode } from './schema-9VLameDG.js';
+export { B as Box, c as Checked, d as Color, e as DEFAULT_PALETTE, f as DiagramEvent, L as LabelSide, P as PALETTES, g as Palette, R as READABLE_PX, h as Region, S as Step, r as resolvePalette, v as validateDiagram } from './schema-9VLameDG.js';
 
 /**
  * 図が使う 2 つの字。どちらも package の依存として同梱する。
@@ -41,28 +41,25 @@ type Parsed = {
     errors: LineError[];
 };
 interface ParseOptions {
-    /** 最初の行が読めず file の言葉が決まらない時に、誤りの文に使う言葉。既定は日本語 */
+    /** 誤りの文の言葉。既定は日本語 */
     lang?: NotationLang;
 }
 declare function parseNotation(notation: string, options?: ParseOptions): Parsed;
 
 /**
- * 図の原本の JSON を、人が書く記法へ書き戻す。
+ * 図の原本の JSON を、人が書く dragon記法へ書き戻す (#3137)。
  *
  * 並べ方は決まった形に整える。JSON の欄の並び順は見ず、欄の名前で読むので、
  * 同じ内容の JSON からは毎回同じ文字列になる。書き手の行の並べ方とコメントは保たない。
  * 段の中で起きることは JSON の並び順 (起きる順) のまま書く。
  *
- * 語は渡した言葉で書く (#2997)。渡さなければ日本語で書く。
- * 英語では添え書きと下の字と書き換えの字を `"…"` で囲み、名前か字に `"` を含む物だけ「」で囲む。
- * 英語の語の file でも「」は読めるので、読み直すと同じ JSON に戻る。
+ * `"` で囲むのは要る時だけにする。`[` を含む名前と、`,` か `]` を含む属性の値と、`"` で始まる字を囲む。
+ * 箱は JSON の並びのまま書き、同じ区画の箱が続く所を 1 つの `group … end` にする。
+ * 区画の箱が飛び飛びの時は同じ `group` を開き直す。区画の並びが箱の現れる順と違う時と、
+ * 箱の無い区画がある時は、先に全ての区画を中の無い `group … end` で宣言してから開き直す。
  */
 
-interface PrintOptions {
-    /** 記法の語の言葉。既定は日本語 */
-    lang?: NotationLang;
-}
-declare function printNotation(diagram: Diagram, options?: PrintOptions): string;
+declare function printNotation(diagram: Diagram): string;
 
 /** この道具が読める原本の版 */
 declare const FORMAT_VERSION = 1;
@@ -248,6 +245,15 @@ interface Rendered {
 /** 原本の JSON から図を描く。原本が形に合わない時は、誤りの場所を添えて断る。 */
 declare function renderDiagram(input: unknown, options?: RenderOptions): Rendered;
 
+interface PlayerOptions extends RenderOptions {
+    /** 段が替わるたびに今の段 (0 から) を受け取る。置いた時にも最初の段で 1 度呼ぶ。頁の側で段の札や進み具合を出す時に使う (#3031) */
+    onStep?: (step: number) => void;
+    /**
+     * 図を、図の枠の中で見える高さに収める (#3047)。高さに収めると字が読めない図は寄って追う図にし、寄って追う窓と全体図をその高さに収める。
+     * 枠の高さが決まっている置き場 (カタログの拡大の重ね窓) で使う。枠の高さが図に合わせて伸びる置き場で使うと、描くたびに低くなる
+     */
+    fitHeight?: boolean;
+}
 interface Player {
     /** 今の段 (0 から) */
     readonly step: number;
@@ -259,11 +265,11 @@ interface Player {
     pause(): void;
     destroy(): void;
 }
-declare function mountDiagram(host: HTMLElement, diagram: unknown, options?: RenderOptions): Player;
+declare function mountDiagram(host: HTMLElement, diagram: unknown, options?: PlayerOptions): Player;
 
-declare function chooseView(rendered: Pick<Rendered, "layout" | "view">, frameWidth: number): {
+declare function chooseView(rendered: Pick<Rendered, "layout" | "view">, frameWidth: number, frameHeight?: number): {
     mode: ViewMode;
     textPx: number;
 };
 
-export { Carry, CheckOptions, Diagram, FONTS, FORMAT_VERSION, type Fence, FieldError, type Layout, type LineError, type Migrated, NotationLang, type ParseOptions, type Parsed, type Player, type PrintOptions, type Read, type RenderOptions, type Rendered, Theme, type Timeline, ViewMode, chooseView, extractDiagrams, migrateFile, mountDiagram, parseNotation, printNotation, readDiagram, renderDiagram };
+export { Carry, CheckOptions, Diagram, FONTS, FORMAT_VERSION, type Fence, FieldError, type Layout, type LineError, type Migrated, NotationLang, type ParseOptions, type Parsed, type Player, type Read, type RenderOptions, type Rendered, Theme, type Timeline, ViewMode, chooseView, extractDiagrams, migrateFile, mountDiagram, parseNotation, printNotation, readDiagram, renderDiagram };