@ugfoundation/swaralipi-js 0.3.1 → 0.3.3

package/dist/viewer/index.d.cts

@@ -1,8 +1,8 @@
-import { O as Octave, a as SvaraLetter, N as Note, M as Meta, S as Swaralipi } from '../schema-D3wyNRqM.cjs';
-import { S as Schedule, P as PlayEvent, D as DrumVoice } from '../schedule-Dsb2paUE.cjs';
+import { O as Octave, a as SvaraLetter, N as Note, M as Meta, S as Swaralipi, T as Taal } from '../schema-D3wyNRqM.cjs';
+import { D as DrumVoice, S as Schedule, P as PlayEvent } from '../schedule-CHXz3V6T.cjs';
 import 'zod';
 import 'tone';
-import '../taals-FmEulsjY.cjs';
+import '../taals-DxJ8wRtF.cjs';
 
 /**
  * Per-language notation encoding for the viewer.
@@ -319,6 +319,38 @@ declare function abcToSvg(abc: string, opts?: StaffOptions, notePaths?: string[]
  * SWARALIPI_CSS + SWARALIPI_STAFF_CSS. Async because abcjs is dynamic-imported.
  */
 declare function renderStaffHtml(doc: Swaralipi, opts?: StaffOptions): Promise<string>;
+/** Options for the standalone taal staff (a single percussion voice — no
+ * melody doc). Layout fields mirror `StaffOptions`; `abcToSvg` reads them. */
+interface TaalStaffOptions {
+    /** Tempo written into the score (Q:). Default 90. */
+    bpm?: number;
+    /** Per-matra drum voices (one per beat of the cycle). Default: the taal's own
+     * `drumPattern()` (sam→kick, tali→snare, khaali→hihat). Length is cycled to
+     * `numBeats`, so an explicit book-accurate mapping overrides the geometric one. */
+    drums?: DrumVoice[];
+    /** Theka bols aligned under each matra (the `w:` line). One per beat. */
+    bols?: string[];
+    /** abcjs target width in px. Default 680. */
+    staffwidth?: number;
+    /** abcjs `scale`. Default 1. */
+    scale?: number;
+}
+/**
+ * Build a **percussion-only** ABC tune for one avartan of a taal — no melody
+ * voice. One quarter-note per matra over a single `V:1 clef=perc` staff, voices
+ * from `opts.drums ?? drumPattern(taal)`, `%%percmap` for the used sounds, and
+ * (optional) bols as the aligned `w:` line. The whole cycle is one bar (M:n/4).
+ * Pure + dependency-free — the testable seam, mirroring `buildAbc`.
+ */
+declare function buildTaalAbc(taal: Pick<Taal, 'numBeats' | 'sam' | 'bhaags' | 'khaali'>, opts?: TaalStaffOptions): string;
+/**
+ * Render a standalone taal theka as an engraved drum staff (abcjs). Each perc
+ * note carries `data-note="<matra-index>"` so a consumer's per-beat clock can
+ * highlight the active note (the same `data-note` mechanism the grid uses).
+ * Async because abcjs is dynamic-imported; returns a "needs abcjs" notice if
+ * the optional package is absent.
+ */
+declare function renderTaalStaffHtml(taal: Pick<Taal, 'numBeats' | 'sam' | 'bhaags' | 'khaali'>, opts?: TaalStaffOptions): Promise<string>;
 
 /**
  * Print / "Save as PDF" support.
@@ -435,4 +467,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, MARKS, NOTATION_FONT_URLS, type PrintOptions, type RenderOptions, SWARALIPI_CSS, SWARALIPI_PRINT_CSS, SWARALIPI_STAFF_CSS, type StaffOptions, type SwaralipiSheetElement, type Transliterator, type ViewerLang, abcDuration, abcToSvg, buildAbc, composeCluster, defineSwaralipiSheet, docToAbc, groupRowIntoCells, loadLyricTransliterator, localizeDigits, midiToAbc, printSwaralipi, renderMetaHeader, renderPrintDocument, renderStaffHtml, renderStaffPrintDocument, renderToHtml, resolveArcs };
+export { type Arc, type Cell, type Cluster, type ComposeOptions, DEFAULT_NOTATOR, DEFAULT_WATERMARK, DIGITS, type GridLang, LABELS, MARKS, 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, abcDuration, abcToSvg, buildAbc, buildTaalAbc, composeCluster, defineSwaralipiSheet, docToAbc, groupRowIntoCells, loadLyricTransliterator, localizeDigits, midiToAbc, printSwaralipi, renderMetaHeader, renderPrintDocument, renderStaffHtml, renderStaffPrintDocument, renderTaalStaffHtml, renderToHtml, resolveArcs };

package/dist/viewer/index.d.ts

@@ -1,8 +1,8 @@
-import { O as Octave, a as SvaraLetter, N as Note, M as Meta, S as Swaralipi } from '../schema-D3wyNRqM.js';
-import { S as Schedule, P as PlayEvent, D as DrumVoice } from '../schedule-BhiP_maG.js';
+import { O as Octave, a as SvaraLetter, N as Note, M as Meta, S as Swaralipi, T as Taal } from '../schema-D3wyNRqM.js';
+import { D as DrumVoice, S as Schedule, P as PlayEvent } from '../schedule-BaE3JGHe.js';
 import 'zod';
 import 'tone';
-import '../taals-FmEulsjY.js';
+import '../taals-DxJ8wRtF.js';
 
 /**
  * Per-language notation encoding for the viewer.
@@ -319,6 +319,38 @@ declare function abcToSvg(abc: string, opts?: StaffOptions, notePaths?: string[]
  * SWARALIPI_CSS + SWARALIPI_STAFF_CSS. Async because abcjs is dynamic-imported.
  */
 declare function renderStaffHtml(doc: Swaralipi, opts?: StaffOptions): Promise<string>;
+/** Options for the standalone taal staff (a single percussion voice — no
+ * melody doc). Layout fields mirror `StaffOptions`; `abcToSvg` reads them. */
+interface TaalStaffOptions {
+    /** Tempo written into the score (Q:). Default 90. */
+    bpm?: number;
+    /** Per-matra drum voices (one per beat of the cycle). Default: the taal's own
+     * `drumPattern()` (sam→kick, tali→snare, khaali→hihat). Length is cycled to
+     * `numBeats`, so an explicit book-accurate mapping overrides the geometric one. */
+    drums?: DrumVoice[];
+    /** Theka bols aligned under each matra (the `w:` line). One per beat. */
+    bols?: string[];
+    /** abcjs target width in px. Default 680. */
+    staffwidth?: number;
+    /** abcjs `scale`. Default 1. */
+    scale?: number;
+}
+/**
+ * Build a **percussion-only** ABC tune for one avartan of a taal — no melody
+ * voice. One quarter-note per matra over a single `V:1 clef=perc` staff, voices
+ * from `opts.drums ?? drumPattern(taal)`, `%%percmap` for the used sounds, and
+ * (optional) bols as the aligned `w:` line. The whole cycle is one bar (M:n/4).
+ * Pure + dependency-free — the testable seam, mirroring `buildAbc`.
+ */
+declare function buildTaalAbc(taal: Pick<Taal, 'numBeats' | 'sam' | 'bhaags' | 'khaali'>, opts?: TaalStaffOptions): string;
+/**
+ * Render a standalone taal theka as an engraved drum staff (abcjs). Each perc
+ * note carries `data-note="<matra-index>"` so a consumer's per-beat clock can
+ * highlight the active note (the same `data-note` mechanism the grid uses).
+ * Async because abcjs is dynamic-imported; returns a "needs abcjs" notice if
+ * the optional package is absent.
+ */
+declare function renderTaalStaffHtml(taal: Pick<Taal, 'numBeats' | 'sam' | 'bhaags' | 'khaali'>, opts?: TaalStaffOptions): Promise<string>;
 
 /**
  * Print / "Save as PDF" support.
@@ -435,4 +467,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, MARKS, NOTATION_FONT_URLS, type PrintOptions, type RenderOptions, SWARALIPI_CSS, SWARALIPI_PRINT_CSS, SWARALIPI_STAFF_CSS, type StaffOptions, type SwaralipiSheetElement, type Transliterator, type ViewerLang, abcDuration, abcToSvg, buildAbc, composeCluster, defineSwaralipiSheet, docToAbc, groupRowIntoCells, loadLyricTransliterator, localizeDigits, midiToAbc, printSwaralipi, renderMetaHeader, renderPrintDocument, renderStaffHtml, renderStaffPrintDocument, renderToHtml, resolveArcs };
+export { type Arc, type Cell, type Cluster, type ComposeOptions, DEFAULT_NOTATOR, DEFAULT_WATERMARK, DIGITS, type GridLang, LABELS, MARKS, 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, abcDuration, abcToSvg, buildAbc, buildTaalAbc, composeCluster, defineSwaralipiSheet, docToAbc, groupRowIntoCells, loadLyricTransliterator, localizeDigits, midiToAbc, printSwaralipi, renderMetaHeader, renderPrintDocument, renderStaffHtml, renderStaffPrintDocument, renderTaalStaffHtml, renderToHtml, resolveArcs };

package/dist/viewer/index.js

@@ -1,5 +1,5 @@
-import { buildSchedule, drumPattern } from '../chunk-V5ZSUJCA.js';
-import { TAALS } from '../chunk-H6HC44PZ.js';
+import { buildSchedule, drumPattern } from '../chunk-32LOBRC2.js';
+import { TAALS } from '../chunk-YE7UVYRY.js';
 
 // src/viewer/glyphs.ts
 var SWARABITAN_SHUDDHA = {
@@ -759,6 +759,28 @@ async function renderStaffHtml(doc, opts = {}) {
 function escapeAttr(s) {
   return s.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;");
 }
+function buildTaalAbc(taal, opts = {}) {
+  const n = Math.max(1, taal.numBeats);
+  const src = opts.drums && opts.drums.length ? opts.drums : drumPattern(taal);
+  const voices = Array.from({ length: n }, (_, i) => src[i % src.length]);
+  const bpm = Math.round(opts.bpm ?? 90);
+  const head = ["X:1", `M:${ratioMeter(n)}`, "L:1/4", `Q:1/4=${bpm}`, ...percMapLines(voices), "K:C"];
+  const lines = [...head, "V:1 clef=perc stem=up", buildDrumVoice(n, n, voices)];
+  if (opts.bols?.length) {
+    const w = opts.bols.slice(0, n).map((b) => b.trim() ? abcText(b).replace(/\s+/g, "~") : "*");
+    while (w.length < n) w.push("*");
+    lines.push(`w: ${w.join(" ")}`);
+  }
+  return lines.join("\n");
+}
+async function renderTaalStaffHtml(taal, opts = {}) {
+  const abc = buildTaalAbc(taal, opts);
+  const n = Math.max(1, taal.numBeats);
+  const paths = Array.from({ length: n }, (_, i) => String(i));
+  const engraved = await abcToSvg(abc, { staffwidth: opts.staffwidth, scale: opts.scale }, paths);
+  const lines = engraved.includes("sw-staff-missing") ? engraved : `<div class="sw-staff-lines">${engraved}</div>`;
+  return `<div class="sw-staff sw-staff--taal">${lines}</div>`;
+}
 
 // src/viewer/print.ts
 var DEFAULT_WATERMARK = "www.gitabitan.io";
@@ -1053,6 +1075,6 @@ function defineSwaralipiSheet(tagName = "swaralipi-sheet") {
   return ctor;
 }
 
-export { DEFAULT_NOTATOR, DEFAULT_WATERMARK, DIGITS, LABELS, MARKS, NOTATION_FONT_URLS, SWARALIPI_CSS, SWARALIPI_PRINT_CSS, SWARALIPI_STAFF_CSS, abcDuration, abcToSvg, buildAbc, composeCluster, defineSwaralipiSheet, docToAbc, groupRowIntoCells, loadLyricTransliterator, localizeDigits, midiToAbc, printSwaralipi, renderMetaHeader, renderPrintDocument, renderStaffHtml, renderStaffPrintDocument, renderToHtml, resolveArcs };
+export { DEFAULT_NOTATOR, DEFAULT_WATERMARK, DIGITS, LABELS, MARKS, NOTATION_FONT_URLS, SWARALIPI_CSS, SWARALIPI_PRINT_CSS, SWARALIPI_STAFF_CSS, abcDuration, abcToSvg, buildAbc, buildTaalAbc, composeCluster, defineSwaralipiSheet, docToAbc, groupRowIntoCells, loadLyricTransliterator, localizeDigits, midiToAbc, printSwaralipi, renderMetaHeader, renderPrintDocument, renderStaffHtml, renderStaffPrintDocument, renderTaalStaffHtml, renderToHtml, resolveArcs };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map