@ugfoundation/swaralipi-js 0.8.1 → 0.9.0

package/dist/viewer/index.d.cts

@@ -1,6 +1,6 @@
-import { O as Octave, a as SvaraLetter, N as Note, M as Meta, S as Swaralipi, T as Taal } from '../schema-DGA_bNVZ.cjs';
-import { L as Lay } from '../lay-Csa4CD46.cjs';
-import { D as DrumVoice, S as Schedule, P as PlayEvent } from '../schedule-B_UaluBi.cjs';
+import { O as Octave, a as SvaraLetter, N as Note, M as Meta, S as Swaralipi, T as Taal } from '../schema-Cf_epUIC.cjs';
+import { L as Lay } from '../lay-CfDlPhH2.cjs';
+import { D as DrumVoice, S as Schedule, P as PlayEvent } from '../schedule-TxSfHL-T.cjs';
 import 'zod';
 import 'tone';
 
@@ -31,6 +31,9 @@ declare const LABELS: Record<GridLang, {
  * term; en names the tempo first (a reader of the English sheet may not know
  * the word — the same call `LABELS.en` makes with "Cycles" over "Avartan"). */
 declare const LAY_LABELS: Record<GridLang, Record<Lay, string>>;
+/** Printed where a row switches to free rhythm (`row.taal: null`) with no
+ * `taalName` of its own. bn is the converter's canonical মুক্তছন্দ. */
+declare const FREE_TAAL_LABELS: Record<GridLang, string>;
 /** A composed notation cluster: the font's ASCII text plus any residual CSS
  * classes the font itself cannot express (only the bn ati-octave dot). */
 interface Cluster {
@@ -116,6 +119,9 @@ interface Arc {
     /** 0-based index of the arc's first / last **cell** within the row. */
     start: number;
     end: number;
+    /** Index, within that cell's notes, of the note the arc hangs from / into. */
+    startNote: number;
+    endNote: number;
     /** True when the matching end lies on a previous / following system. */
     openLeft: boolean;
     openRight: boolean;
@@ -123,11 +129,14 @@ interface Arc {
     line?: boolean;
 }
 /**
- * Resolve under-arcs for one row, in **cell** indices (cells are the grid's
- * columns). Sources, scanned left→right:
- *  - below-annotation raws: `w` opens at its cell, `x` closes at its cell
- *    ("xw" in one cell = close-then-open, in the order typed);
- *  - spec `meend: 'start' | 'end'` fields feed the same scan.
+ * Resolve under-arcs for one row down to the **note** each end hangs from, so a
+ * slur inside one half-matra cell (মজ্ঞা) still runs centre to centre. Sources,
+ * scanned left→right:
+ *  - spec `meend: 'start' | 'end'` — exact notes;
+ *  - below-annotation raws, which belong to the whole cell (NLTR types them
+ *    centred under the column): `w` opens on the cell's first sounded note,
+ *    `x` closes on its last, `$` (Swarabitan's short in-cell arc) runs first to
+ *    last, and `xw` — close, then re-open — meets in the middle instead.
  * Unmatched `x` → arc from cell 0 with a squared-off (open) left end;
  * unclosed `w` → arc to the last cell with an open right end — both match
  * the print's behavior when an arc continues across a system wrap.
@@ -208,7 +217,7 @@ declare const ZOOM_STEP = 1.2;
  *   --sw-matra      minimum width of one matra column
  *   --sw-header-min floor for the নাম/তাল/আবর্তন header (it must stay legible
  *                   when the notation is scaled down to fit a phone)
- *   --sw-lay-min    same floor for the লয় (tempo tier) marker band
+ *   --sw-lay-min    same floor for the তাল / লয় change band
  *   --sw-hl         player-highlight background (P2.3)
  *   --sw-rule       header rule / muted line color
  *
@@ -236,7 +245,7 @@ declare const SWARALIPI_CSS: string;
  *  - rows are un-clipped (no scrollbar on paper) and kept whole across page
  *    breaks; part headings stay with their first row.
  */
-declare const SWARALIPI_PRINT_CSS = "\n@page { margin: 16mm; }\n@media print {\n  .sw-sheet, .sw-staff { -webkit-print-color-adjust: exact; print-color-adjust: exact; color: #000; }\n  .sw-scroll { overflow: visible !important; }\n  .sw-row { break-inside: avoid; page-break-inside: avoid; }\n  .sw-part-name, .sw-header, .sw-lay { break-after: avoid-page; page-break-after: avoid; }\n  .sw-hl { background: none !important; }\n  /* Keep each engraved staff system whole across a page break (the abcjs line\n     is a <div> wrapping the <svg>, so the break rule must sit on the div). */\n  .sw-staff-lines > div { break-inside: avoid; page-break-inside: avoid; }\n  .sw-staff-meta { break-after: avoid-page; page-break-after: avoid; }\n}\n";
+declare const SWARALIPI_PRINT_CSS = "\n@page { margin: 16mm; }\n@media print {\n  .sw-sheet, .sw-staff { -webkit-print-color-adjust: exact; print-color-adjust: exact; color: #000; }\n  .sw-scroll { overflow: visible !important; }\n  .sw-row { break-inside: avoid; page-break-inside: avoid; }\n  .sw-part-name, .sw-header, .sw-change { break-after: avoid-page; page-break-after: avoid; }\n  .sw-hl { background: none !important; }\n  /* Keep each engraved staff system whole across a page break (the abcjs line\n     is a <div> wrapping the <svg>, so the break rule must sit on the div). */\n  .sw-staff-lines > div { break-inside: avoid; page-break-inside: avoid; }\n  .sw-staff-meta { break-after: avoid-page; page-break-after: avoid; }\n}\n";
 /** Staff-notation (abcjs) wrapper chrome: instrument/tempo header + a fluid
  * SVG. The engraving itself is drawn by abcjs; this only frames it. */
 declare const SWARALIPI_STAFF_CSS = "\n.sw-staff { color: currentColor; }\n.sw-staff-meta { display: flex; gap: 1.25em; align-items: baseline; margin: 0 0 .5em; font-size: .95em; opacity: .85; }\n.sw-staff-instrument { font-weight: 600; }\n.sw-staff-drums { opacity: .75; }\n.sw-staff-tempo { font-variant-numeric: tabular-nums; }\n/* abcjs (oneSvgPerLine) wraps the music into one <div><svg> per system; stack\n   them as short, swaralipi-style lines. abcjs sets a fixed pixel height +\n   overflow:hidden on each wrapper div \u2014 neutralise it so the viewBox'd SVG can\n   scale to the container (and to the print page) instead of being clipped. */\n.sw-staff-lines > div { margin: 0 0 .35em; height: auto !important; overflow: visible !important; }\n/* Fill up to the engraved (staffwidth) size \u2014 shrink to fit a narrow container,\n   but never stretch past natural width (abcToSvg pins per-SVG max-width in px),\n   else a short last system balloons. */\n.sw-staff-lines svg { display: block; width: 100%; height: auto; }\n.sw-staff-missing { padding: 1em; border: 1px dashed currentColor; border-radius: 6px; opacity: .8; font-size: .9em; }\n.sw-staff-title { font-size: 1.15em; font-weight: 700; }\n.sw-staff-subtitle { opacity: .8; font-size: .95em; margin-top: .15em; }\n";
@@ -305,6 +314,15 @@ declare function midiToAbc(midi: number): string;
  * nearest 1/4-matra count of `/4` units so odd durations still sum correctly.
  */
 declare function abcDuration(beats: number): string;
+/** One তাল stretch of the score: its meter, and drum voices when drums are on. */
+interface AbcMeter {
+    /** Start, in schedule beats. */
+    beat: number;
+    /** Matra per bar (one তাল cycle) from here on. */
+    beatsPerBar: number;
+    /** Per-matra drum voices from here on; `undefined` rests (মুক্তছন্দ). */
+    drums?: DrumVoice[];
+}
 /**
  * Build a complete ABC tune string from a schedule. Pure and dependency-free
  * (the testable seam). Rests advance time as `z`; melody notes carry duration;
@@ -320,15 +338,21 @@ declare function abcDuration(beats: number): string;
  * pattern one quarter-note per matra with `%%percmap` GM drum sounds (see
  * `buildDrumVoice`). Both voices share the same bar grid, so they wrap and
  * align together.
+ *
+ * `meters`, if given, is one entry per তাল stretch (তালফেরতা): at each start
+ * the running bar is closed and the new meter restated inline as `[M:n/4]` —
+ * the bracketed form, because a bare `M:` line forces a new system.
  */
 declare function buildAbc(schedule: Schedule, lyricOf: (ev: PlayEvent) => string | undefined, opts: {
     bpm: number;
     lyrics: boolean;
     beatsPerBar: number;
     drums?: DrumVoice[];
+    meters?: AbcMeter[];
 }): string;
 /** Build the ABC tune string for a whole document (schedule + lyrics + tempo).
- * The measure length is one তাল cycle (`meta.taal.numBeats`), falling back to 4.
+ * The measure length is one তাল cycle — per stretch, so a তালফেরতা changes the
+ * time signature where the taal changes — falling back to 4.
  * `opts.drums` adds the percussion staff (see `buildAbc`). */
 declare function docToAbc(doc: Swaralipi, opts?: StaffOptions): string;
 /**
@@ -527,4 +551,4 @@ type Transliterator = (bengaliText: string) => string;
  */
 declare function loadLyricTransliterator(lang: ViewerLang): Promise<Transliterator | undefined>;
 
-export { type Arc, type Cell, type Cluster, type ComposeOptions, DEFAULT_NOTATOR, DEFAULT_WATERMARK, DIGITS, type GridLang, LABELS, LAY_LABELS, type Layout, MARKS, MAX_ZOOM, MIN_ZOOM, NOTATION_FONT_URLS, type PrintOptions, type RenderOptions, SWARALIPI_CSS, SWARALIPI_PRINT_CSS, SWARALIPI_STAFF_CSS, type StaffOptions, type SwaralipiSheetElement, type TaalStaffOptions, type Transliterator, type ViewerLang, ZOOM_STEP, abcDuration, abcToSvg, alignRows, buildAbc, buildTaalAbc, cellMatra, composeCluster, defineSwaralipiSheet, docToAbc, fitSwaralipi, groupRowIntoCells, loadLyricTransliterator, localizeDigits, midiToAbc, printSwaralipi, renderMetaHeader, renderPrintDocument, renderStaffHtml, renderStaffPrintDocument, renderTaalStaffHtml, renderToHtml, resolveArcs };
+export { type AbcMeter, type Arc, type Cell, type Cluster, type ComposeOptions, DEFAULT_NOTATOR, DEFAULT_WATERMARK, DIGITS, FREE_TAAL_LABELS, type GridLang, LABELS, LAY_LABELS, type Layout, MARKS, MAX_ZOOM, MIN_ZOOM, NOTATION_FONT_URLS, type PrintOptions, type RenderOptions, SWARALIPI_CSS, SWARALIPI_PRINT_CSS, SWARALIPI_STAFF_CSS, type StaffOptions, type SwaralipiSheetElement, type TaalStaffOptions, type Transliterator, type ViewerLang, ZOOM_STEP, abcDuration, abcToSvg, alignRows, buildAbc, buildTaalAbc, cellMatra, composeCluster, defineSwaralipiSheet, docToAbc, fitSwaralipi, groupRowIntoCells, loadLyricTransliterator, localizeDigits, midiToAbc, printSwaralipi, renderMetaHeader, renderPrintDocument, renderStaffHtml, renderStaffPrintDocument, renderTaalStaffHtml, renderToHtml, resolveArcs };

package/dist/viewer/index.d.ts

@@ -1,6 +1,6 @@
-import { O as Octave, a as SvaraLetter, N as Note, M as Meta, S as Swaralipi, T as Taal } from '../schema-DGA_bNVZ.js';
-import { L as Lay } from '../lay-Ct9ky_EE.js';
-import { D as DrumVoice, S as Schedule, P as PlayEvent } from '../schedule-CdILTNsk.js';
+import { O as Octave, a as SvaraLetter, N as Note, M as Meta, S as Swaralipi, T as Taal } from '../schema-Cf_epUIC.js';
+import { L as Lay } from '../lay-CZIzR9cM.js';
+import { D as DrumVoice, S as Schedule, P as PlayEvent } from '../schedule-9uvjnCG_.js';
 import 'zod';
 import 'tone';
 
@@ -31,6 +31,9 @@ declare const LABELS: Record<GridLang, {
  * term; en names the tempo first (a reader of the English sheet may not know
  * the word — the same call `LABELS.en` makes with "Cycles" over "Avartan"). */
 declare const LAY_LABELS: Record<GridLang, Record<Lay, string>>;
+/** Printed where a row switches to free rhythm (`row.taal: null`) with no
+ * `taalName` of its own. bn is the converter's canonical মুক্তছন্দ. */
+declare const FREE_TAAL_LABELS: Record<GridLang, string>;
 /** A composed notation cluster: the font's ASCII text plus any residual CSS
  * classes the font itself cannot express (only the bn ati-octave dot). */
 interface Cluster {
@@ -116,6 +119,9 @@ interface Arc {
     /** 0-based index of the arc's first / last **cell** within the row. */
     start: number;
     end: number;
+    /** Index, within that cell's notes, of the note the arc hangs from / into. */
+    startNote: number;
+    endNote: number;
     /** True when the matching end lies on a previous / following system. */
     openLeft: boolean;
     openRight: boolean;
@@ -123,11 +129,14 @@ interface Arc {
     line?: boolean;
 }
 /**
- * Resolve under-arcs for one row, in **cell** indices (cells are the grid's
- * columns). Sources, scanned left→right:
- *  - below-annotation raws: `w` opens at its cell, `x` closes at its cell
- *    ("xw" in one cell = close-then-open, in the order typed);
- *  - spec `meend: 'start' | 'end'` fields feed the same scan.
+ * Resolve under-arcs for one row down to the **note** each end hangs from, so a
+ * slur inside one half-matra cell (মজ্ঞা) still runs centre to centre. Sources,
+ * scanned left→right:
+ *  - spec `meend: 'start' | 'end'` — exact notes;
+ *  - below-annotation raws, which belong to the whole cell (NLTR types them
+ *    centred under the column): `w` opens on the cell's first sounded note,
+ *    `x` closes on its last, `$` (Swarabitan's short in-cell arc) runs first to
+ *    last, and `xw` — close, then re-open — meets in the middle instead.
  * Unmatched `x` → arc from cell 0 with a squared-off (open) left end;
  * unclosed `w` → arc to the last cell with an open right end — both match
  * the print's behavior when an arc continues across a system wrap.
@@ -208,7 +217,7 @@ declare const ZOOM_STEP = 1.2;
  *   --sw-matra      minimum width of one matra column
  *   --sw-header-min floor for the নাম/তাল/আবর্তন header (it must stay legible
  *                   when the notation is scaled down to fit a phone)
- *   --sw-lay-min    same floor for the লয় (tempo tier) marker band
+ *   --sw-lay-min    same floor for the তাল / লয় change band
  *   --sw-hl         player-highlight background (P2.3)
  *   --sw-rule       header rule / muted line color
  *
@@ -236,7 +245,7 @@ declare const SWARALIPI_CSS: string;
  *  - rows are un-clipped (no scrollbar on paper) and kept whole across page
  *    breaks; part headings stay with their first row.
  */
-declare const SWARALIPI_PRINT_CSS = "\n@page { margin: 16mm; }\n@media print {\n  .sw-sheet, .sw-staff { -webkit-print-color-adjust: exact; print-color-adjust: exact; color: #000; }\n  .sw-scroll { overflow: visible !important; }\n  .sw-row { break-inside: avoid; page-break-inside: avoid; }\n  .sw-part-name, .sw-header, .sw-lay { break-after: avoid-page; page-break-after: avoid; }\n  .sw-hl { background: none !important; }\n  /* Keep each engraved staff system whole across a page break (the abcjs line\n     is a <div> wrapping the <svg>, so the break rule must sit on the div). */\n  .sw-staff-lines > div { break-inside: avoid; page-break-inside: avoid; }\n  .sw-staff-meta { break-after: avoid-page; page-break-after: avoid; }\n}\n";
+declare const SWARALIPI_PRINT_CSS = "\n@page { margin: 16mm; }\n@media print {\n  .sw-sheet, .sw-staff { -webkit-print-color-adjust: exact; print-color-adjust: exact; color: #000; }\n  .sw-scroll { overflow: visible !important; }\n  .sw-row { break-inside: avoid; page-break-inside: avoid; }\n  .sw-part-name, .sw-header, .sw-change { break-after: avoid-page; page-break-after: avoid; }\n  .sw-hl { background: none !important; }\n  /* Keep each engraved staff system whole across a page break (the abcjs line\n     is a <div> wrapping the <svg>, so the break rule must sit on the div). */\n  .sw-staff-lines > div { break-inside: avoid; page-break-inside: avoid; }\n  .sw-staff-meta { break-after: avoid-page; page-break-after: avoid; }\n}\n";
 /** Staff-notation (abcjs) wrapper chrome: instrument/tempo header + a fluid
  * SVG. The engraving itself is drawn by abcjs; this only frames it. */
 declare const SWARALIPI_STAFF_CSS = "\n.sw-staff { color: currentColor; }\n.sw-staff-meta { display: flex; gap: 1.25em; align-items: baseline; margin: 0 0 .5em; font-size: .95em; opacity: .85; }\n.sw-staff-instrument { font-weight: 600; }\n.sw-staff-drums { opacity: .75; }\n.sw-staff-tempo { font-variant-numeric: tabular-nums; }\n/* abcjs (oneSvgPerLine) wraps the music into one <div><svg> per system; stack\n   them as short, swaralipi-style lines. abcjs sets a fixed pixel height +\n   overflow:hidden on each wrapper div \u2014 neutralise it so the viewBox'd SVG can\n   scale to the container (and to the print page) instead of being clipped. */\n.sw-staff-lines > div { margin: 0 0 .35em; height: auto !important; overflow: visible !important; }\n/* Fill up to the engraved (staffwidth) size \u2014 shrink to fit a narrow container,\n   but never stretch past natural width (abcToSvg pins per-SVG max-width in px),\n   else a short last system balloons. */\n.sw-staff-lines svg { display: block; width: 100%; height: auto; }\n.sw-staff-missing { padding: 1em; border: 1px dashed currentColor; border-radius: 6px; opacity: .8; font-size: .9em; }\n.sw-staff-title { font-size: 1.15em; font-weight: 700; }\n.sw-staff-subtitle { opacity: .8; font-size: .95em; margin-top: .15em; }\n";
@@ -305,6 +314,15 @@ declare function midiToAbc(midi: number): string;
  * nearest 1/4-matra count of `/4` units so odd durations still sum correctly.
  */
 declare function abcDuration(beats: number): string;
+/** One তাল stretch of the score: its meter, and drum voices when drums are on. */
+interface AbcMeter {
+    /** Start, in schedule beats. */
+    beat: number;
+    /** Matra per bar (one তাল cycle) from here on. */
+    beatsPerBar: number;
+    /** Per-matra drum voices from here on; `undefined` rests (মুক্তছন্দ). */
+    drums?: DrumVoice[];
+}
 /**
  * Build a complete ABC tune string from a schedule. Pure and dependency-free
  * (the testable seam). Rests advance time as `z`; melody notes carry duration;
@@ -320,15 +338,21 @@ declare function abcDuration(beats: number): string;
  * pattern one quarter-note per matra with `%%percmap` GM drum sounds (see
  * `buildDrumVoice`). Both voices share the same bar grid, so they wrap and
  * align together.
+ *
+ * `meters`, if given, is one entry per তাল stretch (তালফেরতা): at each start
+ * the running bar is closed and the new meter restated inline as `[M:n/4]` —
+ * the bracketed form, because a bare `M:` line forces a new system.
  */
 declare function buildAbc(schedule: Schedule, lyricOf: (ev: PlayEvent) => string | undefined, opts: {
     bpm: number;
     lyrics: boolean;
     beatsPerBar: number;
     drums?: DrumVoice[];
+    meters?: AbcMeter[];
 }): string;
 /** Build the ABC tune string for a whole document (schedule + lyrics + tempo).
- * The measure length is one তাল cycle (`meta.taal.numBeats`), falling back to 4.
+ * The measure length is one তাল cycle — per stretch, so a তালফেরতা changes the
+ * time signature where the taal changes — falling back to 4.
  * `opts.drums` adds the percussion staff (see `buildAbc`). */
 declare function docToAbc(doc: Swaralipi, opts?: StaffOptions): string;
 /**
@@ -527,4 +551,4 @@ type Transliterator = (bengaliText: string) => string;
  */
 declare function loadLyricTransliterator(lang: ViewerLang): Promise<Transliterator | undefined>;
 
-export { type Arc, type Cell, type Cluster, type ComposeOptions, DEFAULT_NOTATOR, DEFAULT_WATERMARK, DIGITS, type GridLang, LABELS, LAY_LABELS, type Layout, MARKS, MAX_ZOOM, MIN_ZOOM, NOTATION_FONT_URLS, type PrintOptions, type RenderOptions, SWARALIPI_CSS, SWARALIPI_PRINT_CSS, SWARALIPI_STAFF_CSS, type StaffOptions, type SwaralipiSheetElement, type TaalStaffOptions, type Transliterator, type ViewerLang, ZOOM_STEP, abcDuration, abcToSvg, alignRows, buildAbc, buildTaalAbc, cellMatra, composeCluster, defineSwaralipiSheet, docToAbc, fitSwaralipi, groupRowIntoCells, loadLyricTransliterator, localizeDigits, midiToAbc, printSwaralipi, renderMetaHeader, renderPrintDocument, renderStaffHtml, renderStaffPrintDocument, renderTaalStaffHtml, renderToHtml, resolveArcs };
+export { type AbcMeter, type Arc, type Cell, type Cluster, type ComposeOptions, DEFAULT_NOTATOR, DEFAULT_WATERMARK, DIGITS, FREE_TAAL_LABELS, type GridLang, LABELS, LAY_LABELS, type Layout, MARKS, MAX_ZOOM, MIN_ZOOM, NOTATION_FONT_URLS, type PrintOptions, type RenderOptions, SWARALIPI_CSS, SWARALIPI_PRINT_CSS, SWARALIPI_STAFF_CSS, type StaffOptions, type SwaralipiSheetElement, type TaalStaffOptions, type Transliterator, type ViewerLang, ZOOM_STEP, abcDuration, abcToSvg, alignRows, buildAbc, buildTaalAbc, cellMatra, composeCluster, defineSwaralipiSheet, docToAbc, fitSwaralipi, groupRowIntoCells, loadLyricTransliterator, localizeDigits, midiToAbc, printSwaralipi, renderMetaHeader, renderPrintDocument, renderStaffHtml, renderStaffPrintDocument, renderTaalStaffHtml, renderToHtml, resolveArcs };