@tspro/web-music-score 4.0.1 → 4.2.0

package/dist/react-ui/index.d.ts

@@ -1,10 +1,10 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as React from 'react';
-import { c as Scale, S as ScaleType } from '../scale-B2Icbetz.js';
+import { c as Scale, S as ScaleType } from '../scale-DGx3tJH4.js';
 import { b as PitchNotation, G as GuitarNoteLabel, N as Note } from '../note-eA2xPPiG.js';
 import { H as Handedness } from '../guitar-CaZJDA05.js';
-import { D as DivRect, M as MDocument, l as ScoreEventListener, n as MRenderer, o as MPlaybackButtons } from '../music-objects-Dc3kR-XF.js';
-import '../tempo-Dt8aHpol.js';
+import { D as DivRect, M as MDocument, n as ScoreEventListener, p as MRenderer, q as MPlaybackButtons } from '../music-objects-CI7IjsjE.js';
+import '../tempo-GrstpD9G.js';
 import '@tspro/ts-utils-lib';
 
 interface CircleOfFifthsProps {

package/dist/react-ui/index.js

@@ -1,4 +1,4 @@
-/* WebMusicScore v4.0.1 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
+/* WebMusicScore v4.2.0 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
 "use strict";
 var __create = Object.create;
 var __defProp = Object.defineProperty;

package/dist/react-ui/index.mjs

@@ -1,7 +1,7 @@
-/* WebMusicScore v4.0.1 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
+/* WebMusicScore v4.2.0 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
 import {
   __publicField
-} from "../chunk-YFPLOHP2.mjs";
+} from "../chunk-5NWLGWHS.mjs";
 
 // src/react-ui/circle-of-fifths.tsx
 import * as React from "react";

package/dist/{scale-B2Icbetz.d.ts → scale-DGx3tJH4.d.ts}

@@ -1,5 +1,5 @@
 import { N as Note, S as SymbolSet } from './note-eA2xPPiG.js';
-import { K as KeySignature } from './tempo-Dt8aHpol.js';
+import { K as KeySignature } from './tempo-GrstpD9G.js';
 
 /** Interval direction type. */
 type IntervalDirection = "Unison" | "Ascending" | "Descending";

package/dist/{scale-BbDJTbrG.d.mts → scale-DQP3b9Zx.d.mts}

@@ -1,5 +1,5 @@
 import { N as Note, S as SymbolSet } from './note-eA2xPPiG.mjs';
-import { K as KeySignature } from './tempo-CtUhvJbr.mjs';
+import { K as KeySignature } from './tempo-dkctPkCS.mjs';
 
 /** Interval direction type. */
 type IntervalDirection = "Unison" | "Ascending" | "Descending";

package/dist/score/index.d.mts

@@ -1,35 +1,35 @@
-import { N as NoteOptions, R as RestOptions, S as StaffPreset, a as ScoreConfiguration, M as MDocument, V as VoiceId, T as TupletOptions, F as Fermata, b as StaffTabOrGroups, c as Navigation, A as AnnotationText, d as Annotation, L as Label, C as Connective, e as TieType, f as NoteAnchor, g as VerticalPosition } from '../music-objects-DJQ4d2OA.mjs';
-export { a6 as Arpeggio, $ as Clef, D as DivRect, a8 as DynamicsAnnotation, q as MAccidental, s as MArpeggio, E as MBarLineLeft, B as MBarLineRight, t as MBeamGroup, r as MConnective, v as MEnding, _ as MExtensionLine, w as MFermata, x as MHeader, y as MImage, z as MMeasure, H as MNoteGroup, o as MPlaybackButtons, m as MPlayer, n as MRenderer, K as MRest, P as MRhythmColumn, Q as MScoreRow, X as MSignature, Y as MSpecialText, U as MStaff, u as MStaffBeamGroup, I as MStaffNoteGroup, O as MStaffRest, G as MStaffTabBarLine, W as MTab, J as MTabNoteGroup, Z as MText, p as MusicInterface, aa as PlayState, ab as PlayStateChangeListener, i as ScoreEvent, l as ScoreEventListener, h as ScoreEventType, k as ScoreObjectEvent, j as ScoreStaffPosEvent, a0 as StaffConfig, a7 as StaffTabOrGroup, a5 as Stem, a3 as StringNumber, a1 as TabConfig, a9 as TempoAnnotation, a4 as getStringNumbers, a2 as getVoiceIds } from '../music-objects-DJQ4d2OA.mjs';
+import { N as NoteOptions, R as RestOptions, S as StaffPreset, a as ScoreConfiguration, M as MDocument, V as VoiceId, T as TupletOptions, b as VerseNumber, L as LyricsOptions, c as StaffTabOrGroups, F as Fermata, d as Navigation, A as AnnotationText, e as Annotation, f as Label, C as Connective, g as TieType, h as NoteAnchor, i as VerticalPosition } from '../music-objects-3Hxlkxy6.mjs';
+export { aa as Arpeggio, a2 as Clef, D as DivRect, ae as DynamicsAnnotation, ac as LyricsAlign, ad as LyricsHyphen, s as MAccidental, u as MArpeggio, H as MBarLineLeft, G as MBarLineRight, v as MBeamGroup, t as MConnective, x as MEnding, a1 as MExtensionLine, y as MFermata, z as MHeader, B as MImage, a0 as MLyrics, E as MMeasure, J as MNoteGroup, q as MPlaybackButtons, o as MPlayer, p as MRenderer, P as MRest, U as MRhythmColumn, W as MScoreRow, Z as MSignature, _ as MSpecialText, X as MStaff, w as MStaffBeamGroup, K as MStaffNoteGroup, Q as MStaffRest, I as MStaffTabBarLine, Y as MTab, O as MTabNoteGroup, $ as MText, r as MusicInterface, ag as PlayState, ah as PlayStateChangeListener, k as ScoreEvent, n as ScoreEventListener, j as ScoreEventType, m as ScoreObjectEvent, l as ScoreStaffPosEvent, a3 as StaffConfig, ab as StaffTabOrGroup, a9 as Stem, a6 as StringNumber, a4 as TabConfig, af as TempoAnnotation, a7 as getStringNumbers, a8 as getVerseNumbers, a5 as getVoiceIds } from '../music-objects-3Hxlkxy6.mjs';
 import { N as Note } from '../note-eA2xPPiG.mjs';
-import { S as ScaleType, c as Scale } from '../scale-BbDJTbrG.mjs';
-import { N as NoteLength, h as NoteLengthStr, K as KeySignature, a as TimeSignature, T as TimeSignatureString, j as TupletRatio } from '../tempo-CtUhvJbr.mjs';
+import { S as ScaleType, c as Scale } from '../scale-DQP3b9Zx.mjs';
+import { N as NoteLength, i as NoteLengthStr, K as KeySignature, b as TimeSignature, T as TimeSignatures, B as BeamGrouping, k as TupletRatio } from '../tempo-dkctPkCS.mjs';
 import '@tspro/ts-utils-lib';
 
 /** Tuplet builder type. */
 type TupletBuilder = {
     /**
      * Add note to a tuplet.
-     * @param note - Note instance of Note or string (e.g. "D4").
+     * @param note - Instance of Note or string, single value (e.g. "C4") or array (e.g. ["C4", "E4", "G4"]).
      * @param noteLength - Note length (e.g. "4n").
-     * @param options - Note options.
+     * @param noteOptions - Note options.
      * @returns - This tuplet builder object.
      */
-    addNote: (note: Note | string, noteLength: NoteLength | NoteLengthStr, options?: NoteOptions) => TupletBuilder;
+    addNote: (note: Note | string | (Note | string)[], noteLength: NoteLength | NoteLengthStr, noteOptions?: NoteOptions) => TupletBuilder;
     /**
      * Add chord to a tuplet.
      * @param notes - Array of notes, each instance of Note or string (e.g. "D4").
      * @param noteLength - Note length (e.g. "4n").
-     * @param options - Note options.
+     * @param noteOptions - Note options.
      * @returns - This tuplet builder object.
      */
-    addChord: (notes: (Note | string)[], noteLength: NoteLength | NoteLengthStr, options?: NoteOptions) => TupletBuilder;
+    addChord: (notes: (Note | string)[], noteLength: NoteLength | NoteLengthStr, noteOptions?: NoteOptions) => TupletBuilder;
     /**
      * Add rest to a tuplet.
      * @param restLength - Rest length (e.g. "4n").
-     * @param options - Rest options.
+     * @param restOptions - Rest options.
      * @returns - This tuplet builder object.
      */
-    addRest: (restLength: NoteLength | NoteLengthStr, options?: RestOptions) => TupletBuilder;
+    addRest: (restLength: NoteLength | NoteLengthStr, restOptions?: RestOptions) => TupletBuilder;
 };
 /** Etension builder type. */
 type ExtensionBuilder = {
@@ -140,10 +140,25 @@ declare class DocumentBuilder {
     setKeySignature(scale: Scale): DocumentBuilder;
     /**
      * Set time signature for current measure and forward.
-     * @param timeSignature - TimeSignature  object instance or string (e.g. "3/4").
+     * @param timeSignature - TimeSignature object instance.
      * @returns - This document builder instance.
      */
-    setTimeSignature(timeSignature: TimeSignature | TimeSignatureString): DocumentBuilder;
+    setTimeSignature(timeSignature: TimeSignature): DocumentBuilder;
+    /**
+     * Set time signature for current measure and forward.
+     * @param timeSignature - TimeSignatures enum value or string (e.g. "3/4").
+     * @param beamGrouping - Beam grouping (e.g. "3-2" for time signature "5/8").
+     * @returns - This document builder instance.
+     */
+    setTimeSignature(timeSignature: TimeSignatures | `${TimeSignatures}`, beamGrouping?: BeamGrouping | `${BeamGrouping}`): DocumentBuilder;
+    /**
+     * Set time signature for current measure and forward.
+     * @param beatCount - Beat count of time signature (e.g. 3 in "3/4").
+     * @param beatSize - Beat size of time signature (e.g. 4 in "3/4").
+     * @param beamGrouping - Beam grouping (e.g. "3-2" for time signature "5/8").
+     * @returns - This document builder instance.
+     */
+    setTimeSignature(beatCount: number, beatSize: number, beamGrouping?: BeamGrouping | `${BeamGrouping}`): DocumentBuilder;
     /**
      * Set tempo.
      * @param beatsPerMinute - Tempo beats per minute.
@@ -166,30 +181,31 @@ declare class DocumentBuilder {
      */
     setTempo(beatsPerMinute: number, beatLength: NoteLength | NoteLengthStr, dotted: boolean | number): DocumentBuilder;
     /**
-     * Add note o current measure.
+     * Add note to current measure.
      * @param voiceId - Voice id to add note to.
-     * @param note - Note instance of Note or string (e.g. "D4").
+     * @param note - Instance of Note or string, single value (e.g. "C4") or array (e.g. ["C4", "E4", "G4"]).
      * @param noteLength - Note length (e.g. "4n").
-     * @param options - Note options.
+     * @param noteOptions - Note options.
      * @returns - This document builder instance.
      */
-    addNote(voiceId: number, note: Note | string, noteLength: NoteLength | NoteLengthStr, options?: NoteOptions): DocumentBuilder;
+    addNote(voiceId: VoiceId, note: Note | string | (Note | string)[], noteLength: NoteLength | NoteLengthStr, noteOptions?: NoteOptions): DocumentBuilder;
     /**
+     * Add chord to current measure.
      * @param voiceId - Voice id to add chord to.
      * @param notes - Array of notes, each instance of Note or string (e.g. "D4").
      * @param noteLength - Note length (e.g. "4n").
-     * @param options - Note options.
+     * @param noteOptions - Note options.
      * @returns - This document builder instance.
      */
-    addChord(voiceId: number, notes: (Note | string)[], noteLength: NoteLength | NoteLengthStr, options?: NoteOptions): DocumentBuilder;
+    addChord(voiceId: VoiceId, notes: (Note | string)[], noteLength: NoteLength | NoteLengthStr, noteOptions?: NoteOptions): DocumentBuilder;
     /**
-     *
+     * Add rest to current measure.
      * @param voiceId - Voice id to add rest to.
      * @param restLength - Rest length (e.g. "4n").
-     * @param options - Rest options.
+     * @param restOptions - Rest options.
      * @returns - This document builder instance.
      */
-    addRest(voiceId: number, restLength: NoteLength | NoteLengthStr, options?: RestOptions): DocumentBuilder;
+    addRest(voiceId: VoiceId, restLength: NoteLength | NoteLengthStr, restOptions?: RestOptions): DocumentBuilder;
     /**
      * Usage:
      * <pre>
@@ -206,6 +222,27 @@ declare class DocumentBuilder {
      * @returns - This document builder instance.
      */
     addTuplet(voiceId: VoiceId, tupletRatio: TupletRatio & TupletOptions, tupletBuilder: (notes: TupletBuilder) => void): DocumentBuilder;
+    private currentLyricsAlign;
+    private addLyricsInternal;
+    /**
+     * Add lyrics to current measure.
+     * @param verse - Verse number (e.g. 1).
+     * @param lyricsLength - Lyrics text length (e.g. "2n").
+     * @param lyricsText - Lyrics text (empty space if omitted), single value or array.
+     * @param lyricsOptions - Lyrics options.
+     * @returns - This document builder instance.
+     */
+    addLyrics(verse: VerseNumber, lyricsLength: NoteLength | NoteLengthStr, lyricsText?: string | string[], lyricsOptions?: LyricsOptions): DocumentBuilder;
+    /**
+     * Add lyrics to current measure to given staff/tab/group.
+     * @param staffTabOrGroups - staff/tab index (0=top), staff/tab name, or staff group name.
+     * @param verse - Verse number (e.g. 1).
+     * @param lyricsLength - Lyrics text length (e.g. "2n").
+     * @param lyricsText - Lyrics text (empty space if omitted), single value or array.
+     * @param lyricsOptions - Lyrics options.
+     * @returns - This document builder instance.
+     */
+    addLyricsTo(staffTabOrGroups: StaffTabOrGroups, verse: VerseNumber, lyricsLength: NoteLength | NoteLengthStr, lyricsText?: string | string[], lyricsOptions?: LyricsOptions): DocumentBuilder;
     private addFermataInternal;
     /**
      * Add fermata to current measure.
@@ -384,4 +421,4 @@ declare class DocumentBuilder {
     addScaleArpeggio(scale: Scale, bottomNote: string, numOctaves: number): DocumentBuilder;
 }
 
-export { Annotation, AnnotationText, Connective, DocumentBuilder, type ExtensionBuilder, Fermata, Label, MDocument, Navigation, NoteAnchor, NoteOptions, RestOptions, ScoreConfiguration, StaffPreset, StaffTabOrGroups, TieType, type TupletBuilder, TupletOptions, VerticalPosition, VoiceId };
+export { Annotation, AnnotationText, Connective, DocumentBuilder, type ExtensionBuilder, Fermata, Label, LyricsOptions, MDocument, Navigation, NoteAnchor, NoteOptions, RestOptions, ScoreConfiguration, StaffPreset, StaffTabOrGroups, TieType, type TupletBuilder, TupletOptions, VerseNumber, VerticalPosition, VoiceId };

package/dist/score/index.d.ts

@@ -1,35 +1,35 @@
-import { N as NoteOptions, R as RestOptions, S as StaffPreset, a as ScoreConfiguration, M as MDocument, V as VoiceId, T as TupletOptions, F as Fermata, b as StaffTabOrGroups, c as Navigation, A as AnnotationText, d as Annotation, L as Label, C as Connective, e as TieType, f as NoteAnchor, g as VerticalPosition } from '../music-objects-Dc3kR-XF.js';
-export { a6 as Arpeggio, $ as Clef, D as DivRect, a8 as DynamicsAnnotation, q as MAccidental, s as MArpeggio, E as MBarLineLeft, B as MBarLineRight, t as MBeamGroup, r as MConnective, v as MEnding, _ as MExtensionLine, w as MFermata, x as MHeader, y as MImage, z as MMeasure, H as MNoteGroup, o as MPlaybackButtons, m as MPlayer, n as MRenderer, K as MRest, P as MRhythmColumn, Q as MScoreRow, X as MSignature, Y as MSpecialText, U as MStaff, u as MStaffBeamGroup, I as MStaffNoteGroup, O as MStaffRest, G as MStaffTabBarLine, W as MTab, J as MTabNoteGroup, Z as MText, p as MusicInterface, aa as PlayState, ab as PlayStateChangeListener, i as ScoreEvent, l as ScoreEventListener, h as ScoreEventType, k as ScoreObjectEvent, j as ScoreStaffPosEvent, a0 as StaffConfig, a7 as StaffTabOrGroup, a5 as Stem, a3 as StringNumber, a1 as TabConfig, a9 as TempoAnnotation, a4 as getStringNumbers, a2 as getVoiceIds } from '../music-objects-Dc3kR-XF.js';
+import { N as NoteOptions, R as RestOptions, S as StaffPreset, a as ScoreConfiguration, M as MDocument, V as VoiceId, T as TupletOptions, b as VerseNumber, L as LyricsOptions, c as StaffTabOrGroups, F as Fermata, d as Navigation, A as AnnotationText, e as Annotation, f as Label, C as Connective, g as TieType, h as NoteAnchor, i as VerticalPosition } from '../music-objects-CI7IjsjE.js';
+export { aa as Arpeggio, a2 as Clef, D as DivRect, ae as DynamicsAnnotation, ac as LyricsAlign, ad as LyricsHyphen, s as MAccidental, u as MArpeggio, H as MBarLineLeft, G as MBarLineRight, v as MBeamGroup, t as MConnective, x as MEnding, a1 as MExtensionLine, y as MFermata, z as MHeader, B as MImage, a0 as MLyrics, E as MMeasure, J as MNoteGroup, q as MPlaybackButtons, o as MPlayer, p as MRenderer, P as MRest, U as MRhythmColumn, W as MScoreRow, Z as MSignature, _ as MSpecialText, X as MStaff, w as MStaffBeamGroup, K as MStaffNoteGroup, Q as MStaffRest, I as MStaffTabBarLine, Y as MTab, O as MTabNoteGroup, $ as MText, r as MusicInterface, ag as PlayState, ah as PlayStateChangeListener, k as ScoreEvent, n as ScoreEventListener, j as ScoreEventType, m as ScoreObjectEvent, l as ScoreStaffPosEvent, a3 as StaffConfig, ab as StaffTabOrGroup, a9 as Stem, a6 as StringNumber, a4 as TabConfig, af as TempoAnnotation, a7 as getStringNumbers, a8 as getVerseNumbers, a5 as getVoiceIds } from '../music-objects-CI7IjsjE.js';
 import { N as Note } from '../note-eA2xPPiG.js';
-import { S as ScaleType, c as Scale } from '../scale-B2Icbetz.js';
-import { N as NoteLength, h as NoteLengthStr, K as KeySignature, a as TimeSignature, T as TimeSignatureString, j as TupletRatio } from '../tempo-Dt8aHpol.js';
+import { S as ScaleType, c as Scale } from '../scale-DGx3tJH4.js';
+import { N as NoteLength, i as NoteLengthStr, K as KeySignature, b as TimeSignature, T as TimeSignatures, B as BeamGrouping, k as TupletRatio } from '../tempo-GrstpD9G.js';
 import '@tspro/ts-utils-lib';
 
 /** Tuplet builder type. */
 type TupletBuilder = {
     /**
      * Add note to a tuplet.
-     * @param note - Note instance of Note or string (e.g. "D4").
+     * @param note - Instance of Note or string, single value (e.g. "C4") or array (e.g. ["C4", "E4", "G4"]).
      * @param noteLength - Note length (e.g. "4n").
-     * @param options - Note options.
+     * @param noteOptions - Note options.
      * @returns - This tuplet builder object.
      */
-    addNote: (note: Note | string, noteLength: NoteLength | NoteLengthStr, options?: NoteOptions) => TupletBuilder;
+    addNote: (note: Note | string | (Note | string)[], noteLength: NoteLength | NoteLengthStr, noteOptions?: NoteOptions) => TupletBuilder;
     /**
      * Add chord to a tuplet.
      * @param notes - Array of notes, each instance of Note or string (e.g. "D4").
      * @param noteLength - Note length (e.g. "4n").
-     * @param options - Note options.
+     * @param noteOptions - Note options.
      * @returns - This tuplet builder object.
      */
-    addChord: (notes: (Note | string)[], noteLength: NoteLength | NoteLengthStr, options?: NoteOptions) => TupletBuilder;
+    addChord: (notes: (Note | string)[], noteLength: NoteLength | NoteLengthStr, noteOptions?: NoteOptions) => TupletBuilder;
     /**
      * Add rest to a tuplet.
      * @param restLength - Rest length (e.g. "4n").
-     * @param options - Rest options.
+     * @param restOptions - Rest options.
      * @returns - This tuplet builder object.
      */
-    addRest: (restLength: NoteLength | NoteLengthStr, options?: RestOptions) => TupletBuilder;
+    addRest: (restLength: NoteLength | NoteLengthStr, restOptions?: RestOptions) => TupletBuilder;
 };
 /** Etension builder type. */
 type ExtensionBuilder = {
@@ -140,10 +140,25 @@ declare class DocumentBuilder {
     setKeySignature(scale: Scale): DocumentBuilder;
     /**
      * Set time signature for current measure and forward.
-     * @param timeSignature - TimeSignature  object instance or string (e.g. "3/4").
+     * @param timeSignature - TimeSignature object instance.
      * @returns - This document builder instance.
      */
-    setTimeSignature(timeSignature: TimeSignature | TimeSignatureString): DocumentBuilder;
+    setTimeSignature(timeSignature: TimeSignature): DocumentBuilder;
+    /**
+     * Set time signature for current measure and forward.
+     * @param timeSignature - TimeSignatures enum value or string (e.g. "3/4").
+     * @param beamGrouping - Beam grouping (e.g. "3-2" for time signature "5/8").
+     * @returns - This document builder instance.
+     */
+    setTimeSignature(timeSignature: TimeSignatures | `${TimeSignatures}`, beamGrouping?: BeamGrouping | `${BeamGrouping}`): DocumentBuilder;
+    /**
+     * Set time signature for current measure and forward.
+     * @param beatCount - Beat count of time signature (e.g. 3 in "3/4").
+     * @param beatSize - Beat size of time signature (e.g. 4 in "3/4").
+     * @param beamGrouping - Beam grouping (e.g. "3-2" for time signature "5/8").
+     * @returns - This document builder instance.
+     */
+    setTimeSignature(beatCount: number, beatSize: number, beamGrouping?: BeamGrouping | `${BeamGrouping}`): DocumentBuilder;
     /**
      * Set tempo.
      * @param beatsPerMinute - Tempo beats per minute.
@@ -166,30 +181,31 @@ declare class DocumentBuilder {
      */
     setTempo(beatsPerMinute: number, beatLength: NoteLength | NoteLengthStr, dotted: boolean | number): DocumentBuilder;
     /**
-     * Add note o current measure.
+     * Add note to current measure.
      * @param voiceId - Voice id to add note to.
-     * @param note - Note instance of Note or string (e.g. "D4").
+     * @param note - Instance of Note or string, single value (e.g. "C4") or array (e.g. ["C4", "E4", "G4"]).
      * @param noteLength - Note length (e.g. "4n").
-     * @param options - Note options.
+     * @param noteOptions - Note options.
      * @returns - This document builder instance.
      */
-    addNote(voiceId: number, note: Note | string, noteLength: NoteLength | NoteLengthStr, options?: NoteOptions): DocumentBuilder;
+    addNote(voiceId: VoiceId, note: Note | string | (Note | string)[], noteLength: NoteLength | NoteLengthStr, noteOptions?: NoteOptions): DocumentBuilder;
     /**
+     * Add chord to current measure.
      * @param voiceId - Voice id to add chord to.
      * @param notes - Array of notes, each instance of Note or string (e.g. "D4").
      * @param noteLength - Note length (e.g. "4n").
-     * @param options - Note options.
+     * @param noteOptions - Note options.
      * @returns - This document builder instance.
      */
-    addChord(voiceId: number, notes: (Note | string)[], noteLength: NoteLength | NoteLengthStr, options?: NoteOptions): DocumentBuilder;
+    addChord(voiceId: VoiceId, notes: (Note | string)[], noteLength: NoteLength | NoteLengthStr, noteOptions?: NoteOptions): DocumentBuilder;
     /**
-     *
+     * Add rest to current measure.
      * @param voiceId - Voice id to add rest to.
      * @param restLength - Rest length (e.g. "4n").
-     * @param options - Rest options.
+     * @param restOptions - Rest options.
      * @returns - This document builder instance.
      */
-    addRest(voiceId: number, restLength: NoteLength | NoteLengthStr, options?: RestOptions): DocumentBuilder;
+    addRest(voiceId: VoiceId, restLength: NoteLength | NoteLengthStr, restOptions?: RestOptions): DocumentBuilder;
     /**
      * Usage:
      * <pre>
@@ -206,6 +222,27 @@ declare class DocumentBuilder {
      * @returns - This document builder instance.
      */
     addTuplet(voiceId: VoiceId, tupletRatio: TupletRatio & TupletOptions, tupletBuilder: (notes: TupletBuilder) => void): DocumentBuilder;
+    private currentLyricsAlign;
+    private addLyricsInternal;
+    /**
+     * Add lyrics to current measure.
+     * @param verse - Verse number (e.g. 1).
+     * @param lyricsLength - Lyrics text length (e.g. "2n").
+     * @param lyricsText - Lyrics text (empty space if omitted), single value or array.
+     * @param lyricsOptions - Lyrics options.
+     * @returns - This document builder instance.
+     */
+    addLyrics(verse: VerseNumber, lyricsLength: NoteLength | NoteLengthStr, lyricsText?: string | string[], lyricsOptions?: LyricsOptions): DocumentBuilder;
+    /**
+     * Add lyrics to current measure to given staff/tab/group.
+     * @param staffTabOrGroups - staff/tab index (0=top), staff/tab name, or staff group name.
+     * @param verse - Verse number (e.g. 1).
+     * @param lyricsLength - Lyrics text length (e.g. "2n").
+     * @param lyricsText - Lyrics text (empty space if omitted), single value or array.
+     * @param lyricsOptions - Lyrics options.
+     * @returns - This document builder instance.
+     */
+    addLyricsTo(staffTabOrGroups: StaffTabOrGroups, verse: VerseNumber, lyricsLength: NoteLength | NoteLengthStr, lyricsText?: string | string[], lyricsOptions?: LyricsOptions): DocumentBuilder;
     private addFermataInternal;
     /**
      * Add fermata to current measure.
@@ -384,4 +421,4 @@ declare class DocumentBuilder {
     addScaleArpeggio(scale: Scale, bottomNote: string, numOctaves: number): DocumentBuilder;
 }
 
-export { Annotation, AnnotationText, Connective, DocumentBuilder, type ExtensionBuilder, Fermata, Label, MDocument, Navigation, NoteAnchor, NoteOptions, RestOptions, ScoreConfiguration, StaffPreset, StaffTabOrGroups, TieType, type TupletBuilder, TupletOptions, VerticalPosition, VoiceId };
+export { Annotation, AnnotationText, Connective, DocumentBuilder, type ExtensionBuilder, Fermata, Label, LyricsOptions, MDocument, Navigation, NoteAnchor, NoteOptions, RestOptions, ScoreConfiguration, StaffPreset, StaffTabOrGroups, TieType, type TupletBuilder, TupletOptions, VerseNumber, VerticalPosition, VoiceId };