@tspro/web-music-score 4.0.0 → 4.0.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## [4.0.1] - 2025-09-28
+## Fixed
+- Invalid typedoc @params.
+- AnotationType was not referenced for typedoc.
+- Deprecated misspelled NoteLength.Whole12Dots.
+
+## Changed
+- Improved Frere Jacques demo piece.
+
+## Added
+- Typedoc comments for all public exports.
+
 ## [4.0.0] - 2025-09-24
 Another major update was required by new features.
 

package/README.md

@@ -13,7 +13,7 @@ This is a work in progress project. Lately there has been improvements that requ
 version update. As the project matures there might be less major updates, and more minor
 updates and patches.
 
-This version (4.0.0) added support for string arguments in addition to typescript enums (e.g. NoteLength.Quarter => "4n", just to name one).
+Version 4.0.0 added support for string arguments in addition to typescript enums (e.g. NoteLength.Quarter => "4n", just to name one).
 
 ## Installation
 

package/dist/audio/index.d.mts

@@ -1,15 +1,54 @@
-import { N as Note } from '../note-BFa43I86.mjs';
+import { N as Note } from '../note-eA2xPPiG.mjs';
 
+/** Instrument interface. */
 interface Instrument {
+    /**
+     * Get instrument name.
+     * @return - Instrument name.
+     */
     getName(): string;
+    /**
+     * Play a note.
+     * @param note - Note to play (e.g. "C4").
+     * @param duration - Play duration in seconds.
+     * @param volume - Linear volume in range [0, 1].
+     */
     playNote(note: string, duration?: number, volume?: number): void;
+    /**
+     * Stop playback.
+     */
     stop(): void;
 }
+/**
+ * Get instrument name list.
+ * @returns - Array of available instrument names.
+ */
 declare function getInstrumentList(): ReadonlyArray<string>;
+/**
+ * Get current instrument name.
+ * @returns - Name of current instrument.
+ */
 declare function getCurrentInstrument(): string;
+/**
+ * Register new instrument.
+ * @param instr - Instrument object implementing Instrument interface.
+ */
 declare function registerInstrument(instr: Instrument): void;
+/**
+ * Set current instrument to use in playback.
+ * @param instrName - Instrument name.
+ */
 declare function setInstrument(instrName: string): void;
+/**
+ * Play a note using current instrument.
+ * @param note - Note instance of Note object, note name (e.g. "C4"), or midiNumber.
+ * @param duration - Play duration in seconds.
+ * @param linearVolume - Linear volume in range [0, 1].
+ */
 declare function playNote(note: Note | string | number, duration?: number, linearVolume?: number): void;
+/**
+ * Stop playing on current instrument.
+ */
 declare function stop(): void;
 
 export { type Instrument, getCurrentInstrument, getInstrumentList, playNote, registerInstrument, setInstrument, stop };

package/dist/audio/index.d.ts

@@ -1,15 +1,54 @@
-import { N as Note } from '../note-CcVdUFqS.js';
+import { N as Note } from '../note-eA2xPPiG.js';
 
+/** Instrument interface. */
 interface Instrument {
+    /**
+     * Get instrument name.
+     * @return - Instrument name.
+     */
     getName(): string;
+    /**
+     * Play a note.
+     * @param note - Note to play (e.g. "C4").
+     * @param duration - Play duration in seconds.
+     * @param volume - Linear volume in range [0, 1].
+     */
     playNote(note: string, duration?: number, volume?: number): void;
+    /**
+     * Stop playback.
+     */
     stop(): void;
 }
+/**
+ * Get instrument name list.
+ * @returns - Array of available instrument names.
+ */
 declare function getInstrumentList(): ReadonlyArray<string>;
+/**
+ * Get current instrument name.
+ * @returns - Name of current instrument.
+ */
 declare function getCurrentInstrument(): string;
+/**
+ * Register new instrument.
+ * @param instr - Instrument object implementing Instrument interface.
+ */
 declare function registerInstrument(instr: Instrument): void;
+/**
+ * Set current instrument to use in playback.
+ * @param instrName - Instrument name.
+ */
 declare function setInstrument(instrName: string): void;
+/**
+ * Play a note using current instrument.
+ * @param note - Note instance of Note object, note name (e.g. "C4"), or midiNumber.
+ * @param duration - Play duration in seconds.
+ * @param linearVolume - Linear volume in range [0, 1].
+ */
 declare function playNote(note: Note | string | number, duration?: number, linearVolume?: number): void;
+/**
+ * Stop playing on current instrument.
+ */
 declare function stop(): void;
 
 export { type Instrument, getCurrentInstrument, getInstrumentList, playNote, registerInstrument, setInstrument, stop };

package/dist/audio/index.js

@@ -1,4 +1,4 @@
-/* WebMusicScore v4.0.0 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
+/* WebMusicScore v4.0.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 v4.0.0 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
+/* WebMusicScore v4.0.1 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
 import {
   __publicField
-} from "../chunk-D643HZHM.mjs";
+} from "../chunk-YFPLOHP2.mjs";
 
 // src/audio/index.ts
 import { Note, PitchNotation, SymbolSet } from "@tspro/web-music-score/theory";

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

@@ -1,3 +1,6 @@
+/**
+ * Register classical guitar audio instrument, and set is as current instrument.
+ */
 declare function registerClassicalGuitar(): void;
 
 export { registerClassicalGuitar };

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

@@ -1,3 +1,6 @@
+/**
+ * Register classical guitar audio instrument, and set is as current instrument.
+ */
 declare function registerClassicalGuitar(): void;
 
 export { registerClassicalGuitar };

package/dist/audio-cg/index.js

@@ -1,4 +1,4 @@
-/* WebMusicScore v4.0.0 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
+/* WebMusicScore v4.0.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 v4.0.0 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
+/* WebMusicScore v4.0.1 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
 import {
   __publicField
-} from "../chunk-D643HZHM.mjs";
+} from "../chunk-YFPLOHP2.mjs";
 
 // src/audio-cg/index.ts
 import * as Tone from "tone";

package/dist/{chunk-D643HZHM.mjs → chunk-YFPLOHP2.mjs}

@@ -1,4 +1,4 @@
-/* WebMusicScore v4.0.0 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
+/* WebMusicScore v4.0.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-D643HZHM.mjs.map
+//# sourceMappingURL=chunk-YFPLOHP2.mjs.map

package/dist/core/index.d.mts

@@ -1,3 +1,4 @@
+/** Enum of music error types. */
 declare enum MusicErrorType {
     Unknown = 0,
     InvalidArg = 1,
@@ -7,9 +8,20 @@ declare enum MusicErrorType {
     Timesignature = 5,
     Score = 6
 }
+/** Music error class. */
 declare class MusicError extends Error {
+    /** Music error type. */
     readonly type: MusicErrorType;
+    /**
+     * Create new music error instance.
+     * @param message - Error message.
+     */
     constructor(message: string);
+    /**
+     * Create new musicerror instance.
+     * @param type - Music error type.
+     * @param message - Error message.
+     */
     constructor(type: MusicErrorType, message: string);
 }
 

package/dist/core/index.d.ts

@@ -1,3 +1,4 @@
+/** Enum of music error types. */
 declare enum MusicErrorType {
     Unknown = 0,
     InvalidArg = 1,
@@ -7,9 +8,20 @@ declare enum MusicErrorType {
     Timesignature = 5,
     Score = 6
 }
+/** Music error class. */
 declare class MusicError extends Error {
+    /** Music error type. */
     readonly type: MusicErrorType;
+    /**
+     * Create new music error instance.
+     * @param message - Error message.
+     */
     constructor(message: string);
+    /**
+     * Create new musicerror instance.
+     * @param type - Music error type.
+     * @param message - Error message.
+     */
     constructor(type: MusicErrorType, message: string);
 }
 

package/dist/core/index.js

@@ -1,4 +1,4 @@
-/* WebMusicScore v4.0.0 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
+/* WebMusicScore v4.0.1 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
 "use strict";
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
@@ -47,6 +47,7 @@ var MusicError = class extends Error {
   constructor(...args) {
     const [type, msg] = args.length === 1 ? [0 /* Unknown */, args[0]] : args;
     super(formatType(type) + msg);
+    /** Music error type. */
     __publicField(this, "type");
     Object.setPrototypeOf(this, new.target.prototype);
     this.name = "MusicError";
@@ -61,7 +62,7 @@ function init() {
     return;
   }
   initialized = true;
-  console.log("%cWebMusicScore v4.0.0 (cjs) initialized.", "background: black; color: white; padding: 2px;");
+  console.log("%cWebMusicScore v4.0.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 v4.0.0 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
+/* WebMusicScore v4.0.1 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
 import {
   __publicField
-} from "../chunk-D643HZHM.mjs";
+} from "../chunk-YFPLOHP2.mjs";
 
 // src/core/error.ts
 var MusicErrorType = /* @__PURE__ */ ((MusicErrorType2) => {
@@ -21,6 +21,7 @@ var MusicError = class extends Error {
   constructor(...args) {
     const [type, msg] = args.length === 1 ? [0 /* Unknown */, args[0]] : args;
     super(formatType(type) + msg);
+    /** Music error type. */
     __publicField(this, "type");
     Object.setPrototypeOf(this, new.target.prototype);
     this.name = "MusicError";
@@ -35,7 +36,7 @@ function init() {
     return;
   }
   initialized = true;
-  console.log("%cWebMusicScore v4.0.0 (esm) initialized.", "background: black; color: white; padding: 2px;");
+  console.log("%cWebMusicScore v4.0.1 (esm) initialized.", "background: black; color: white; padding: 2px;");
 }
 export {
   MusicError,

package/dist/guitar-CaZJDA05.d.ts

@@ -0,0 +1,35 @@
+import { N as Note } from './note-eA2xPPiG.js';
+
+/** Guitar handedness enum. */
+declare enum Handedness {
+    /** Right handed guitar. */
+    RightHanded = 0,
+    /** Left handed guitar. */
+    LeftHanded = 1
+}
+/** Default guitar handedness (Handedness.RightHanded). */
+declare const DefaultHandedness = Handedness.RightHanded;
+/**
+ * Validate if given argument is guitar handedness.
+ * @param h - Guitar handedness to validate.
+ * @returns - Guitar handedness if valid, else throws.
+ */
+declare function validateHandedness(h: unknown): Handedness;
+/** Guitar tuning name list. */
+declare const TuningNameList: ReadonlyArray<string>;
+/** DEfault tuning name (Standard). */
+declare const DefaultTuningName: string;
+/**
+ * Validate if given argument is available tuning name.
+ * @param tuningName - Tuning name to validate.
+ * @returns - Tuning name if valid, or throws.
+ */
+declare function validateTuningName(tuningName: string): string;
+/**
+ * Get guitar tuning, note for each open string.
+ * @param tuningName - Tuning name.
+ * @returns Array of open string notes.
+ */
+declare function getTuningStrings(tuningName: string): ReadonlyArray<Note>;
+
+export { DefaultHandedness as D, Handedness as H, TuningNameList as T, DefaultTuningName as a, validateTuningName as b, getTuningStrings as g, validateHandedness as v };

package/dist/guitar-DdexKdN6.d.mts

@@ -0,0 +1,35 @@
+import { N as Note } from './note-eA2xPPiG.mjs';
+
+/** Guitar handedness enum. */
+declare enum Handedness {
+    /** Right handed guitar. */
+    RightHanded = 0,
+    /** Left handed guitar. */
+    LeftHanded = 1
+}
+/** Default guitar handedness (Handedness.RightHanded). */
+declare const DefaultHandedness = Handedness.RightHanded;
+/**
+ * Validate if given argument is guitar handedness.
+ * @param h - Guitar handedness to validate.
+ * @returns - Guitar handedness if valid, else throws.
+ */
+declare function validateHandedness(h: unknown): Handedness;
+/** Guitar tuning name list. */
+declare const TuningNameList: ReadonlyArray<string>;
+/** DEfault tuning name (Standard). */
+declare const DefaultTuningName: string;
+/**
+ * Validate if given argument is available tuning name.
+ * @param tuningName - Tuning name to validate.
+ * @returns - Tuning name if valid, or throws.
+ */
+declare function validateTuningName(tuningName: string): string;
+/**
+ * Get guitar tuning, note for each open string.
+ * @param tuningName - Tuning name.
+ * @returns Array of open string notes.
+ */
+declare function getTuningStrings(tuningName: string): ReadonlyArray<Note>;
+
+export { DefaultHandedness as D, Handedness as H, TuningNameList as T, DefaultTuningName as a, validateTuningName as b, getTuningStrings as g, validateHandedness as v };