@tspro/web-music-score 4.0.1 → 4.2.0

package/dist/{tempo-Dt8aHpol.d.ts → tempo-GrstpD9G.d.ts}

@@ -289,8 +289,40 @@ declare class RhythmProps {
     static equals(a: RhythmProps, b: RhythmProps): boolean;
 }
 
-/** Time signature string type. */
-type TimeSignatureString = "2/4" | "3/4" | "4/4" | "6/8" | "9/8";
+/** Time signature enum.  */
+declare enum TimeSignatures {
+    /** 2/4 time signature. */
+    _2_4 = "2/4",
+    /** 3/4 time signature. */
+    _3_4 = "3/4",
+    /** 4/4 time signature. */
+    _4_4 = "4/4",
+    /** 3/8 time signature. */
+    _3_8 = "3/8",
+    /** 5/8 time signature. */
+    _5_8 = "5/8",
+    /** 6/8 time signature. */
+    _6_8 = "6/8",
+    /** 7/8 time signature. */
+    _7_8 = "7/8",
+    /** 9/8 time signature. */
+    _9_8 = "9/8",
+    /** 12/8 time signature. */
+    _12_8 = "12/8"
+}
+/** @deprecated - Use TimeSignatures enum values or just it's string values. */
+type TimeSignatureString = `${TimeSignatures}`;
+/** Beam grouping enum. */
+declare enum BeamGrouping {
+    /** 2-3 beam grouping for 5/8 time signature. */
+    _2_3 = "2-3",
+    /** 3-2 beam grouping for 5/8 time signature. */
+    _3_2 = "3-2",
+    /** 2-2-3 beam grouping for 7/8 time signature. */
+    _2_2_3 = "2-2-3",
+    /** 3-2-2 beam grouping for 7/8 time signature. */
+    _3_2_2 = "3-2-2"
+}
 /** Time signature class. */
 declare class TimeSignature {
     /** Number of beats in measure, upper value (e.g. "3" in "3/4"). */
@@ -301,21 +333,21 @@ declare class TimeSignature {
     readonly beatLength: NoteLength;
     /** Number of ticks in measure. */
     readonly measureTicks: number;
-    /** Number of beam groups in measure. */
-    readonly beamGroupCount: number;
-    /** Length of one beam group. */
-    readonly beamGroupLength: number;
+    /** Beam groups (e.g. [[2], [2]] or [[2, 2], [2, 2]] (first try as [[4], [4]])). */
+    readonly beamGroupSizes: number[][];
     /**
      * Create new time signature instance.
-     * @param str - For example "4/4".
+     * @param timeSignature - For example "4/4".
+     * @param beamGrouping - Beam grouping (e.g. "3-2" for time signature "5/8").
      */
-    constructor(str: TimeSignatureString);
+    constructor(timeSignature: TimeSignatures | `${TimeSignatures}`, beamGrouping?: BeamGrouping | `${BeamGrouping}`);
     /**
      * Create new time signature instance.
      * @param beatCount - Measure beat count.
      * @param beatSize - Size value: whole-note=1, half-note=2, quarter-note=4, etc.
+     * @param beamGrouping - Beam grouping (e.g. "3-2" for time signature "5/8").
      */
-    constructor(beatCount: number, beatSize: number);
+    constructor(beatCount: number, beatSize: number, beamGrouping?: BeamGrouping | `${BeamGrouping}`);
     /**
      * Test whether this time signature has given beat count and size.
      * @param beatCount - Beat count.
@@ -366,4 +398,4 @@ declare function getTempoString(tempo: Tempo): string;
  */
 declare function alterTempoSpeed(tempo: Tempo, speed: number): Tempo;
 
-export { AccidentalType as A, KeySignature as K, Mode as M, NoteLength as N, RhythmProps as R, type TimeSignatureString as T, TimeSignature as a, getDefaultTimeSignature as b, type Tempo as c, getDefaultTempo as d, getTempoString as e, alterTempoSpeed as f, getDefaultKeySignature as g, type NoteLengthStr as h, NoteLengthProps as i, type TupletRatio as j, validateTupletRatio as k, Tuplet as l, validateNoteLength as v };
+export { AccidentalType as A, BeamGrouping as B, KeySignature as K, Mode as M, NoteLength as N, RhythmProps as R, TimeSignatures as T, type TimeSignatureString as a, TimeSignature as b, getDefaultTimeSignature as c, type Tempo as d, getDefaultTempo as e, getTempoString as f, getDefaultKeySignature as g, alterTempoSpeed as h, type NoteLengthStr as i, NoteLengthProps as j, type TupletRatio as k, validateTupletRatio as l, Tuplet as m, validateNoteLength as v };

package/dist/{tempo-CtUhvJbr.d.mts → tempo-dkctPkCS.d.mts}

@@ -289,8 +289,40 @@ declare class RhythmProps {
     static equals(a: RhythmProps, b: RhythmProps): boolean;
 }
 
-/** Time signature string type. */
-type TimeSignatureString = "2/4" | "3/4" | "4/4" | "6/8" | "9/8";
+/** Time signature enum.  */
+declare enum TimeSignatures {
+    /** 2/4 time signature. */
+    _2_4 = "2/4",
+    /** 3/4 time signature. */
+    _3_4 = "3/4",
+    /** 4/4 time signature. */
+    _4_4 = "4/4",
+    /** 3/8 time signature. */
+    _3_8 = "3/8",
+    /** 5/8 time signature. */
+    _5_8 = "5/8",
+    /** 6/8 time signature. */
+    _6_8 = "6/8",
+    /** 7/8 time signature. */
+    _7_8 = "7/8",
+    /** 9/8 time signature. */
+    _9_8 = "9/8",
+    /** 12/8 time signature. */
+    _12_8 = "12/8"
+}
+/** @deprecated - Use TimeSignatures enum values or just it's string values. */
+type TimeSignatureString = `${TimeSignatures}`;
+/** Beam grouping enum. */
+declare enum BeamGrouping {
+    /** 2-3 beam grouping for 5/8 time signature. */
+    _2_3 = "2-3",
+    /** 3-2 beam grouping for 5/8 time signature. */
+    _3_2 = "3-2",
+    /** 2-2-3 beam grouping for 7/8 time signature. */
+    _2_2_3 = "2-2-3",
+    /** 3-2-2 beam grouping for 7/8 time signature. */
+    _3_2_2 = "3-2-2"
+}
 /** Time signature class. */
 declare class TimeSignature {
     /** Number of beats in measure, upper value (e.g. "3" in "3/4"). */
@@ -301,21 +333,21 @@ declare class TimeSignature {
     readonly beatLength: NoteLength;
     /** Number of ticks in measure. */
     readonly measureTicks: number;
-    /** Number of beam groups in measure. */
-    readonly beamGroupCount: number;
-    /** Length of one beam group. */
-    readonly beamGroupLength: number;
+    /** Beam groups (e.g. [[2], [2]] or [[2, 2], [2, 2]] (first try as [[4], [4]])). */
+    readonly beamGroupSizes: number[][];
     /**
      * Create new time signature instance.
-     * @param str - For example "4/4".
+     * @param timeSignature - For example "4/4".
+     * @param beamGrouping - Beam grouping (e.g. "3-2" for time signature "5/8").
      */
-    constructor(str: TimeSignatureString);
+    constructor(timeSignature: TimeSignatures | `${TimeSignatures}`, beamGrouping?: BeamGrouping | `${BeamGrouping}`);
     /**
      * Create new time signature instance.
      * @param beatCount - Measure beat count.
      * @param beatSize - Size value: whole-note=1, half-note=2, quarter-note=4, etc.
+     * @param beamGrouping - Beam grouping (e.g. "3-2" for time signature "5/8").
      */
-    constructor(beatCount: number, beatSize: number);
+    constructor(beatCount: number, beatSize: number, beamGrouping?: BeamGrouping | `${BeamGrouping}`);
     /**
      * Test whether this time signature has given beat count and size.
      * @param beatCount - Beat count.
@@ -366,4 +398,4 @@ declare function getTempoString(tempo: Tempo): string;
  */
 declare function alterTempoSpeed(tempo: Tempo, speed: number): Tempo;
 
-export { AccidentalType as A, KeySignature as K, Mode as M, NoteLength as N, RhythmProps as R, type TimeSignatureString as T, TimeSignature as a, getDefaultTimeSignature as b, type Tempo as c, getDefaultTempo as d, getTempoString as e, alterTempoSpeed as f, getDefaultKeySignature as g, type NoteLengthStr as h, NoteLengthProps as i, type TupletRatio as j, validateTupletRatio as k, Tuplet as l, validateNoteLength as v };
+export { AccidentalType as A, BeamGrouping as B, KeySignature as K, Mode as M, NoteLength as N, RhythmProps as R, TimeSignatures as T, type TimeSignatureString as a, TimeSignature as b, getDefaultTimeSignature as c, type Tempo as d, getDefaultTempo as e, getTempoString as f, getDefaultKeySignature as g, alterTempoSpeed as h, type NoteLengthStr as i, NoteLengthProps as j, type TupletRatio as k, validateTupletRatio as l, Tuplet as m, validateNoteLength as v };

package/dist/theory/index.d.mts

@@ -1,9 +1,9 @@
 import { N as Note } from '../note-eA2xPPiG.mjs';
 export { A as Accidental, d as DefaultGuitarNoteLabel, D as DefaultPitchNotation, G as GuitarNoteLabel, e as GuitarNoteLabelList, a as NoteLetter, P as ParsedNote, b as PitchNotation, c as PitchNotationList, S as SymbolSet, g as getPitchNotationName, f as validateGuitarNoteLabel, v as validatePitchNotation } from '../note-eA2xPPiG.mjs';
-import { D as Degree } from '../scale-BbDJTbrG.mjs';
-export { b as Interval, I as IntervalDirection, a as IntervalQuality, c as Scale, d as ScaleFactory, S as ScaleType, i as getDefaultScale, h as getScale, e as getScaleFactory, g as getScaleFactoryList, v as validateIntervalQuality, f as validateScaleType } from '../scale-BbDJTbrG.mjs';
+import { D as Degree } from '../scale-DQP3b9Zx.mjs';
+export { b as Interval, I as IntervalDirection, a as IntervalQuality, c as Scale, d as ScaleFactory, S as ScaleType, i as getDefaultScale, h as getScale, e as getScaleFactory, g as getScaleFactoryList, v as validateIntervalQuality, f as validateScaleType } from '../scale-DQP3b9Zx.mjs';
 export { D as DefaultHandedness, a as DefaultTuningName, H as Handedness, T as TuningNameList, g as getTuningStrings, v as validateHandedness, b as validateTuningName } from '../guitar-DdexKdN6.mjs';
-export { A as AccidentalType, K as KeySignature, M as Mode, N as NoteLength, i as NoteLengthProps, h as NoteLengthStr, R as RhythmProps, c as Tempo, a as TimeSignature, T as TimeSignatureString, l as Tuplet, j as TupletRatio, f as alterTempoSpeed, g as getDefaultKeySignature, d as getDefaultTempo, b as getDefaultTimeSignature, e as getTempoString, v as validateNoteLength, k as validateTupletRatio } from '../tempo-CtUhvJbr.mjs';
+export { A as AccidentalType, B as BeamGrouping, K as KeySignature, M as Mode, N as NoteLength, j as NoteLengthProps, i as NoteLengthStr, R as RhythmProps, d as Tempo, b as TimeSignature, a as TimeSignatureString, T as TimeSignatures, m as Tuplet, k as TupletRatio, h as alterTempoSpeed, g as getDefaultKeySignature, e as getDefaultTempo, c as getDefaultTimeSignature, f as getTempoString, v as validateNoteLength, l as validateTupletRatio } from '../tempo-dkctPkCS.mjs';
 
 /** Chord info type. */
 type ChordInfo = {

package/dist/theory/index.d.ts

@@ -1,9 +1,9 @@
 import { N as Note } from '../note-eA2xPPiG.js';
 export { A as Accidental, d as DefaultGuitarNoteLabel, D as DefaultPitchNotation, G as GuitarNoteLabel, e as GuitarNoteLabelList, a as NoteLetter, P as ParsedNote, b as PitchNotation, c as PitchNotationList, S as SymbolSet, g as getPitchNotationName, f as validateGuitarNoteLabel, v as validatePitchNotation } from '../note-eA2xPPiG.js';
-import { D as Degree } from '../scale-B2Icbetz.js';
-export { b as Interval, I as IntervalDirection, a as IntervalQuality, c as Scale, d as ScaleFactory, S as ScaleType, i as getDefaultScale, h as getScale, e as getScaleFactory, g as getScaleFactoryList, v as validateIntervalQuality, f as validateScaleType } from '../scale-B2Icbetz.js';
+import { D as Degree } from '../scale-DGx3tJH4.js';
+export { b as Interval, I as IntervalDirection, a as IntervalQuality, c as Scale, d as ScaleFactory, S as ScaleType, i as getDefaultScale, h as getScale, e as getScaleFactory, g as getScaleFactoryList, v as validateIntervalQuality, f as validateScaleType } from '../scale-DGx3tJH4.js';
 export { D as DefaultHandedness, a as DefaultTuningName, H as Handedness, T as TuningNameList, g as getTuningStrings, v as validateHandedness, b as validateTuningName } from '../guitar-CaZJDA05.js';
-export { A as AccidentalType, K as KeySignature, M as Mode, N as NoteLength, i as NoteLengthProps, h as NoteLengthStr, R as RhythmProps, c as Tempo, a as TimeSignature, T as TimeSignatureString, l as Tuplet, j as TupletRatio, f as alterTempoSpeed, g as getDefaultKeySignature, d as getDefaultTempo, b as getDefaultTimeSignature, e as getTempoString, v as validateNoteLength, k as validateTupletRatio } from '../tempo-Dt8aHpol.js';
+export { A as AccidentalType, B as BeamGrouping, K as KeySignature, M as Mode, N as NoteLength, j as NoteLengthProps, i as NoteLengthStr, R as RhythmProps, d as Tempo, b as TimeSignature, a as TimeSignatureString, T as TimeSignatures, m as Tuplet, k as TupletRatio, h as alterTempoSpeed, g as getDefaultKeySignature, e as getDefaultTempo, c as getDefaultTimeSignature, f as getTempoString, v as validateNoteLength, l as validateTupletRatio } from '../tempo-GrstpD9G.js';
 
 /** Chord info type. */
 type ChordInfo = {

package/dist/theory/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 __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
@@ -24,6 +24,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
 var theory_exports = {};
 __export(theory_exports, {
   AccidentalType: () => AccidentalType,
+  BeamGrouping: () => BeamGrouping,
   Chord: () => Chord,
   DefaultGuitarNoteLabel: () => DefaultGuitarNoteLabel,
   DefaultHandedness: () => DefaultHandedness,
@@ -46,6 +47,7 @@ __export(theory_exports, {
   ScaleType: () => ScaleType,
   SymbolSet: () => SymbolSet,
   TimeSignature: () => TimeSignature,
+  TimeSignatures: () => TimeSignatures,
   TuningNameList: () => TuningNameList,
   Tuplet: () => Tuplet,
   alterTempoSpeed: () => alterTempoSpeed,
@@ -2129,6 +2131,25 @@ var RhythmProps = _RhythmProps;
 
 // src/theory/time-signature.ts
 var import_core9 = require("@tspro/web-music-score/core");
+var TimeSignatures = /* @__PURE__ */ ((TimeSignatures2) => {
+  TimeSignatures2["_2_4"] = "2/4";
+  TimeSignatures2["_3_4"] = "3/4";
+  TimeSignatures2["_4_4"] = "4/4";
+  TimeSignatures2["_3_8"] = "3/8";
+  TimeSignatures2["_5_8"] = "5/8";
+  TimeSignatures2["_6_8"] = "6/8";
+  TimeSignatures2["_7_8"] = "7/8";
+  TimeSignatures2["_9_8"] = "9/8";
+  TimeSignatures2["_12_8"] = "12/8";
+  return TimeSignatures2;
+})(TimeSignatures || {});
+var BeamGrouping = /* @__PURE__ */ ((BeamGrouping2) => {
+  BeamGrouping2["_2_3"] = "2-3";
+  BeamGrouping2["_3_2"] = "3-2";
+  BeamGrouping2["_2_2_3"] = "2-2-3";
+  BeamGrouping2["_3_2_2"] = "3-2-2";
+  return BeamGrouping2;
+})(BeamGrouping || {});
 var TimeSignature = class {
   constructor(...args) {
     /** Number of beats in measure, upper value (e.g. "3" in "3/4"). */
@@ -2139,17 +2160,22 @@ var TimeSignature = class {
     __publicField(this, "beatLength");
     /** Number of ticks in measure. */
     __publicField(this, "measureTicks");
-    /** Number of beam groups in measure. */
-    __publicField(this, "beamGroupCount");
-    /** Length of one beam group. */
-    __publicField(this, "beamGroupLength");
-    if (args.length === 1 && typeof args[0] === "string") {
+    /** Beam groups (e.g. [[2], [2]] or [[2, 2], [2, 2]] (first try as [[4], [4]])). */
+    __publicField(this, "beamGroupSizes", []);
+    let beamGrouping;
+    if (import_ts_utils_lib9.Utils.Is.isEnumValue(args[0], TimeSignatures)) {
       let parts = args[0].split("/");
       this.beatCount = +parts[0];
       this.beatSize = +parts[1];
-    } else if (args.length === 2 && typeof args[0] === "number" && typeof args[1] === "number") {
+      if (import_ts_utils_lib9.Utils.Is.isEnumValue(args[1], BeamGrouping)) {
+        beamGrouping = args[1];
+      }
+    } else if (import_ts_utils_lib9.Utils.Is.isIntegerGte(args[0], 2) && import_ts_utils_lib9.Utils.Is.isIntegerGte(args[1], 2)) {
       this.beatCount = args[0];
       this.beatSize = args[1];
+      if (import_ts_utils_lib9.Utils.Is.isEnumValue(args[2], BeamGrouping)) {
+        beamGrouping = args[2];
+      }
     } else {
       throw new import_core9.MusicError(import_core9.MusicErrorType.Timesignature, `Invalid args: ${args}`);
     }
@@ -2158,20 +2184,42 @@ var TimeSignature = class {
     } else if (!import_ts_utils_lib9.Utils.Is.isIntegerGte(this.beatSize, 1)) {
       throw new import_core9.MusicError(import_core9.MusicErrorType.Timesignature, `Invalid beatSize: ${this.beatSize}`);
     }
-    let props = NoteLengthProps.create(this.beatSize);
-    this.beatLength = props.noteLength;
-    this.measureTicks = this.beatCount * props.ticks;
-    if (this.is(2, 4) || this.is(3, 4) || this.is(4, 4)) {
-      this.beamGroupCount = this.beatCount;
-    } else if (this.is(6, 8) || this.is(9, 8)) {
-      this.beamGroupCount = this.beatCount / 3;
-    } else {
-      console.warn("Not necessarily an error, but unsupported time signature: " + this.toString());
-      this.beamGroupCount = 1;
+    let { noteLength, ticks } = NoteLengthProps.create(this.beatSize);
+    this.beatLength = noteLength;
+    this.measureTicks = this.beatCount * ticks;
+    if (this.is(2, 4)) {
+      this.beamGroupSizes = [[2], [2]];
+    } else if (this.is(3, 4)) {
+      this.beamGroupSizes = [[2], [2], [2]];
+    } else if (this.is(4, 4)) {
+      this.beamGroupSizes = [[2, 2], [2, 2]];
+    } else if (this.is(3, 8)) {
+      this.beamGroupSizes = [[3]];
+    } else if (this.is(5, 8)) {
+      if (!import_ts_utils_lib9.Utils.Is.isUndefined(beamGrouping) && beamGrouping !== "2-3" /* _2_3 */ && beamGrouping !== "3-2" /* _3_2 */) {
+        throw new import_core9.MusicError(import_core9.MusicErrorType.Timesignature, `Invalid beam grouping "${beamGrouping}" for time signature "${this.toString()}".`);
+      } else {
+        this.beamGroupSizes = beamGrouping === "3-2" /* _3_2 */ ? [[3], [2]] : [[2], [3]];
+        beamGrouping = void 0;
+      }
+    } else if (this.is(6, 8)) {
+      this.beamGroupSizes = [[3], [3]];
+    } else if (this.is(7, 8)) {
+      if (!import_ts_utils_lib9.Utils.Is.isUndefined(beamGrouping) && beamGrouping !== "2-2-3" /* _2_2_3 */ && beamGrouping !== "3-2-2" /* _3_2_2 */) {
+        throw new import_core9.MusicError(import_core9.MusicErrorType.Timesignature, `Invalid beam grouping "${beamGrouping}" for time signature "${this.toString()}".`);
+      } else {
+        this.beamGroupSizes = beamGrouping === "3-2-2" /* _3_2_2 */ ? [[3], [2], [2]] : [[2], [2], [3]];
+        beamGrouping = void 0;
+      }
+    } else if (this.is(9, 8)) {
+      this.beamGroupSizes = [[3], [3], [3]];
+    } else if (this.is(12, 8)) {
+      this.beamGroupSizes = [[3], [3], [3], [3]];
     }
-    this.beamGroupLength = this.measureTicks / this.beamGroupCount;
-    if (!import_ts_utils_lib9.Utils.Is.isIntegerGte(this.beamGroupLength, 1)) {
-      throw new import_core9.MusicError(import_core9.MusicErrorType.Timesignature, `Invalid beamGroupLength: ${this.beamGroupLength}`);
+    if (this.beamGroupSizes.length === 0) {
+      throw new import_core9.MusicError(import_core9.MusicErrorType.Timesignature, `Unimplemented time signature "${this.toString()}".`);
+    } else if (beamGrouping !== void 0) {
+      throw new import_core9.MusicError(import_core9.MusicErrorType.Timesignature, `Invalid beam grouping "${beamGrouping}" for time signature "${this.toString()}".`);
     }
   }
   /**
@@ -2223,6 +2271,7 @@ var import_core10 = require("@tspro/web-music-score/core");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   AccidentalType,
+  BeamGrouping,
   Chord,
   DefaultGuitarNoteLabel,
   DefaultHandedness,
@@ -2245,6 +2294,7 @@ var import_core10 = require("@tspro/web-music-score/core");
   ScaleType,
   SymbolSet,
   TimeSignature,
+  TimeSignatures,
   TuningNameList,
   Tuplet,
   alterTempoSpeed,