@tspro/web-music-score 3.0.1 → 3.1.1

package/CHANGELOG.md

@@ -1,7 +1,17 @@
 # Changelog
 
-## [3.0.1] - 2025-09-03
+## [3.1.1] - 2025-09-10
+## Fixed
+- Accept array of staff/tab/group for addFermataTo(), addNavigationTo(), addAnnotationTo() and addLabelTo().
+- Better infinite recursion detection for staff groups.
 
+## [3.1.0] - 2025-09-09
+## Added
+- Staff/TabConfig.name.
+- DocumentBuilder.addStaffGroup().
+- DocumentBuilder.addFermataTo(), .addNavigationTo(), .addAnnotationTo() and .addLabelTo().
+
+## [3.0.1] - 2025-09-03
 ## Fixed
 - Draw arpeggio curly arrow also to guitar tab.
 

package/README.md

@@ -144,6 +144,7 @@ builder.setScoreConfiguration(config: (Score.StaffConfig | Score.TabConfig)[]);
 * `type`: "staff"
 * `clef`: Clef can be `Score.Clef.G` or `Score.Clef.F`.
 * `isOctaveDown`: boolean (optional)
+* `name`: staff name.
 * `minNote`: string (optional), minimum note allowed in staff.
 * `maxNote`: string (optional), maximum note allowed in staff.
 * `voiceIds`: number[] (optional), array of voice ids are visible on this staff.
@@ -151,6 +152,7 @@ builder.setScoreConfiguration(config: (Score.StaffConfig | Score.TabConfig)[]);
 
 `TabConfig` contains following properties:
 * `type`: "tab"
+* `name`: tab name.
 * `tuning`: string | string[] (optional), tuning name or array of 6 note names for tuning.
 * `voiceIds`: number[] (optional), array of voice ids are visible on this tab.
 
@@ -325,26 +327,6 @@ builder.addFermata(Score.Fermata.AtMeasureEnd);
 - `Score.Fermata.AtNote`: Adds fermata anchored to previously added note, chord or rest.
 - `Score.Fermata.AtMeasureEnd`: Adds fermata at the end of measure.
 
-### Add Connective (tie, slur)
-
-```js
-// Add tie
-builder.addConnective(connective: Score.Connetive.Tie, span?: Score.ConnectiveSpan, noteAnchor?: Score.NoteAnchor);
-
-// Add slur
-builder.addConnective(connective: Score.Connetive.Slur, span?: Score.ConnectiveSpan, noteAnchor?: Score.NoteAnchor);
-
-// Add slide
-builder.addConnective(connective: Score.Connetive.Slide, noteAnchor?: Score.NoteAnchor);
-```
-
-- `span` describes how many notes the connective is across.
-  It is integer >= 2 (for tie it can be also `Score.TieType.Stub|ToMeasureEnd`).
-  Default value is 2.
-- `noteAnchor` describes the attach point of connective to note.
-  It can be `Score.NoteAnchor.Auto|Above|Center|Below|StemTip`.
-  Default value is `Score.NoteAnchor.Auto`.
-
 ### Add Navigation
 
 Add navigational element to measure.
@@ -405,6 +387,47 @@ builder.addAnnotation(Score.Annotation.Tempo, "accel.");
 * `Score.Annotation.Dynamics`: `text` could be for example `"fff"`, `"cresc."`, `"dim."`, etc.
 * `Score.Annotation.Tempo`: `text` could be for example `"accel."`, `"rit."`, `"a tempo"`, etc.
 
+### Add Elements To Certain Staff Or Tab
+
+There are alternatives to these functions:
+- `addFermata` => `addFermataTo`
+- `addNavigation` => `addNavigationTo`
+- `addAnnotation` => `addAnnotationTo`
+- `addLabel` => `addLabelTo`.
+
+First argument of these alterate functions is:
+
+ `staffTabOrGroups: Score.StaffTabOrGroups`.
+
+`StaffTabOrGroups` can be:
+- `number`: staff/tab index, 0=top staff/tab, etc.
+- `string`: staff/tab name.
+- `string`: staff group name.
+- `(number | string)[]`: an array of staff/tab indices, names or group names.
+
+```js
+// Example: add label to top staff/tab.
+builder.addLabelTo(0, Score.Label.Chord, "Am");
+```
+
+#### Staff Group
+```js
+builder.addStaffGroup(groupName: string, staffsTabsAndGroups: number | string | (number | string)[], verticalPosition: Score.VerticalPosition);
+```
+
+Arguments are:
+- `groupName`: Name of new staff group.
+- `staffsTabsAndGroups`: single value or an array of staves, tabs and groups (index or name).
+- `verticalPosition` (optional): Can be `Score.VerticalPosition.Above`/`Below`/`Both`/`Auto` (default).
+
+```js
+// Example: create staff group to add elements below top staff/tab.
+// Add staff group
+builder.addStaffGroup("grp1", [0], Score.VertocalPosition.Below);
+// Use group
+builder.addLabelTo("grp1", Score.Label.Note, "C");
+```
+
 ### Add Extension
 
 Adds extension line to element, for example to previously added annotation.
@@ -420,6 +443,26 @@ builder.addAnnotation(Score.Annotation.Tempo, "accel.").addExtension(Theory.Note
 
 `visible` sets visibility of extension line, visible by default (if omitted).
 
+### Add Connective (tie, slur, slide)
+
+```js
+// Add tie
+builder.addConnective(connective: Score.Connetive.Tie, span?: Score.ConnectiveSpan, noteAnchor?: Score.NoteAnchor);
+
+// Add slur
+builder.addConnective(connective: Score.Connetive.Slur, span?: Score.ConnectiveSpan, noteAnchor?: Score.NoteAnchor);
+
+// Add slide
+builder.addConnective(connective: Score.Connetive.Slide, noteAnchor?: Score.NoteAnchor);
+```
+
+- `span` describes how many notes the connective is across.
+  It is integer >= 2 (for tie it can be also `Score.TieType.Stub|ToMeasureEnd`).
+  Default value is 2.
+- `noteAnchor` describes the attach point of connective to note.
+  It can be `Score.NoteAnchor.Auto|Above|Center|Below|StemTip`.
+  Default value is `Score.NoteAnchor.Auto`.
+
 ### Guitar Tab
 
 This library has preliminary guitar tabs rendering. 

package/dist/audio/index.d.mts

@@ -1,22 +1,15 @@
-import { N as Note } from '../note-B5ZtlHc8.mjs';
+import { N as Note } from '../note-BFa43I86.mjs';
 
-/** @public */
 interface Instrument {
     getName(): string;
     playNote(note: string, duration?: number, volume?: number): void;
     stop(): void;
 }
-/** @public */
 declare function getInstrumentList(): ReadonlyArray<string>;
-/** @public */
 declare function getCurrentInstrument(): string;
-/** @public */
 declare function registerInstrument(instr: Instrument): void;
-/** @public */
 declare function setInstrument(instrName: string): void;
-/** @public */
 declare function playNote(note: Note | string | number, duration?: number, linearVolume?: number): void;
-/** @public */
 declare function stop(): void;
 
 export { type Instrument, getCurrentInstrument, getInstrumentList, playNote, registerInstrument, setInstrument, stop };

package/dist/audio/index.d.ts

@@ -1,22 +1,15 @@
-import { N as Note } from '../note-B5ZtlHc8.js';
+import { N as Note } from '../note-BFa43I86.js';
 
-/** @public */
 interface Instrument {
     getName(): string;
     playNote(note: string, duration?: number, volume?: number): void;
     stop(): void;
 }
-/** @public */
 declare function getInstrumentList(): ReadonlyArray<string>;
-/** @public */
 declare function getCurrentInstrument(): string;
-/** @public */
 declare function registerInstrument(instr: Instrument): void;
-/** @public */
 declare function setInstrument(instrName: string): void;
-/** @public */
 declare function playNote(note: Note | string | number, duration?: number, linearVolume?: number): void;
-/** @public */
 declare function stop(): void;
 
 export { type Instrument, getCurrentInstrument, getInstrumentList, playNote, registerInstrument, setInstrument, stop };

package/dist/audio/index.js

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

package/dist/audio/index.mjs

@@ -1,7 +1,7 @@
-/* WebMusicScore v3.0.1 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
+/* WebMusicScore v3.1.1 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
 import {
   __publicField
-} from "../chunk-4AS76G4O.mjs";
+} from "../chunk-PU4J7K4Z.mjs";
 
 // src/audio/index.ts
 import { Note, PitchNotation, SymbolSet } from "@tspro/web-music-score/theory";

package/dist/audio-cg/index.d.mts

@@ -1,4 +1,3 @@
-/** @public */
 declare function registerClassicalGuitar(): void;
 
 export { registerClassicalGuitar };

package/dist/audio-cg/index.d.ts

@@ -1,4 +1,3 @@
-/** @public */
 declare function registerClassicalGuitar(): void;
 
 export { registerClassicalGuitar };

package/dist/audio-cg/index.js

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

package/dist/audio-cg/index.mjs

@@ -1,7 +1,7 @@
-/* WebMusicScore v3.0.1 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
+/* WebMusicScore v3.1.1 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
 import {
   __publicField
-} from "../chunk-4AS76G4O.mjs";
+} from "../chunk-PU4J7K4Z.mjs";
 
 // src/audio-cg/index.ts
 import * as Tone from "tone";

package/dist/{chunk-4AS76G4O.mjs → chunk-PU4J7K4Z.mjs}

@@ -1,4 +1,4 @@
-/* WebMusicScore v3.0.1 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
+/* WebMusicScore v3.1.1 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
 var __defProp = Object.defineProperty;
 var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
@@ -6,4 +6,4 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
 export {
   __publicField
 };
-//# sourceMappingURL=chunk-4AS76G4O.mjs.map
+//# sourceMappingURL=chunk-PU4J7K4Z.mjs.map

package/dist/core/index.d.mts

@@ -1,4 +1,3 @@
-/** @public */
 declare enum MusicErrorType {
     Unknown = 0,
     InvalidArg = 1,
@@ -8,14 +7,12 @@ declare enum MusicErrorType {
     Timesignature = 5,
     Score = 6
 }
-/** @public */
 declare class MusicError extends Error {
     readonly type: MusicErrorType;
     constructor(message: string);
     constructor(type: MusicErrorType, message: string);
 }
 
-/** @public */
 declare function init(): void;
 
 export { MusicError, MusicErrorType, init };

package/dist/core/index.d.ts

@@ -1,4 +1,3 @@
-/** @public */
 declare enum MusicErrorType {
     Unknown = 0,
     InvalidArg = 1,
@@ -8,14 +7,12 @@ declare enum MusicErrorType {
     Timesignature = 5,
     Score = 6
 }
-/** @public */
 declare class MusicError extends Error {
     readonly type: MusicErrorType;
     constructor(message: string);
     constructor(type: MusicErrorType, message: string);
 }
 
-/** @public */
 declare function init(): void;
 
 export { MusicError, MusicErrorType, init };

package/dist/core/index.js

@@ -1,4 +1,4 @@
-/* WebMusicScore v3.0.1 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
+/* WebMusicScore v3.1.1 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
 "use strict";
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
@@ -61,7 +61,7 @@ function init() {
     return;
   }
   initialized = true;
-  console.log("%cWebMusicScore v3.0.1 (cjs) initialized.", "background: black; color: white; padding: 2px;");
+  console.log("%cWebMusicScore v3.1.1 (cjs) initialized.", "background: black; color: white; padding: 2px;");
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/dist/core/index.mjs

@@ -1,7 +1,7 @@
-/* WebMusicScore v3.0.1 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
+/* WebMusicScore v3.1.1 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
 import {
   __publicField
-} from "../chunk-4AS76G4O.mjs";
+} from "../chunk-PU4J7K4Z.mjs";
 
 // src/core/error.ts
 var MusicErrorType = /* @__PURE__ */ ((MusicErrorType2) => {
@@ -35,7 +35,7 @@ function init() {
     return;
   }
   initialized = true;
-  console.log("%cWebMusicScore v3.0.1 (esm) initialized.", "background: black; color: white; padding: 2px;");
+  console.log("%cWebMusicScore v3.1.1 (esm) initialized.", "background: black; color: white; padding: 2px;");
 }
 export {
   MusicError,

package/dist/{guitar-BIFwFT31.d.ts → guitar-C2Cp71NZ.d.ts}

@@ -1,22 +1,15 @@
-import { N as Note } from './note-B5ZtlHc8.js';
+import { N as Note } from './note-BFa43I86.js';
 
-/** @public */
 declare enum Handedness {
     RightHanded = 0,
     LeftHanded = 1
 }
-/** @public */
 declare const DefaultHandedness = Handedness.RightHanded;
-/** @public */
 declare function validateHandedness(h: unknown): Handedness;
-/** @public */
 declare const TuningNameList: ReadonlyArray<string>;
-/** @public */
 declare const DefaultTuningName: string;
-/** @public */
 declare function validateTuningName(tuningName: string): string;
 /**
- * @public
  * @returns Array of open string notes, note for each string.
  */
 declare function getTuningStrings(tuningName: string): ReadonlyArray<Note>;

package/dist/{guitar-zASF7B1g.d.mts → guitar-DggbM2UL.d.mts}

@@ -1,22 +1,15 @@
-import { N as Note } from './note-B5ZtlHc8.mjs';
+import { N as Note } from './note-BFa43I86.mjs';
 
-/** @public */
 declare enum Handedness {
     RightHanded = 0,
     LeftHanded = 1
 }
-/** @public */
 declare const DefaultHandedness = Handedness.RightHanded;
-/** @public */
 declare function validateHandedness(h: unknown): Handedness;
-/** @public */
 declare const TuningNameList: ReadonlyArray<string>;
-/** @public */
 declare const DefaultTuningName: string;
-/** @public */
 declare function validateTuningName(tuningName: string): string;
 /**
- * @public
  * @returns Array of open string notes, note for each string.
  */
 declare function getTuningStrings(tuningName: string): ReadonlyArray<Note>;