web-music-score 0.0.1 → 6.0.0-pre.1

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

@@ -0,0 +1,86 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as React from 'react';
+import { M as MDocument, o as ScoreEventListener, r as MPlaybackButtons } from '../music-objects-DLmp5uL6.js';
+import '../note-RVXvpfyV.js';
+import '../tempo-D-JF-8b_.js';
+import '@tspro/ts-utils-lib';
+
+interface MusicScoreViewProps {
+    doc: MDocument;
+    onScoreEvent?: ScoreEventListener;
+}
+/**
+ * Music score view react component.
+ * ```ts
+ *   // Using with React TSX/JSX
+ *   import * as Score from "web-music-score/score";
+ *   import * as ScoreUI from "web-music-score/react-ui";
+ *
+ *   // Render function of react component.
+ *   render() {
+ *       // Create document.
+ *       const doc = new Score.DocumentBuilder()
+ *           // Build document...
+ *           .getDocument();
+ *
+ *       return <>
+ *          <ScoreUI.MusicScoreView doc={doc} />
+ *       </>;
+ *   }
+ * ```
+ */
+declare class MusicScoreView extends React.Component<MusicScoreViewProps, {}> {
+    private readonly ctx;
+    constructor(props: MusicScoreViewProps);
+    componentDidUpdate(prevProps: Readonly<MusicScoreViewProps>, prevState: Readonly<{}>): void;
+    render(): react_jsx_runtime.JSX.Element;
+}
+
+interface PlaybackButtonsProps {
+    doc: MDocument;
+    singlePlayStop?: boolean;
+    playStop?: boolean;
+    playPauseStop?: boolean;
+    playLabel?: string;
+    pauseLabel?: string;
+    stopLabel?: string;
+}
+interface PlaybackButtonsState {
+    controller: MPlaybackButtons;
+}
+/**
+ * Usage:
+ * ```ts
+ *   // Using with React TSX/JSX
+ *   import * as Score from "web-music-score/score";
+ *   import * as ScoreUI from "web-music-score/react-ui";
+ *
+ *   // Create document.
+ *   const doc = new Score.DocumentBuilder()
+ *       // Build document...
+ *       .getDocument();
+ *
+ *   // Create default playback buttons (play, pause and stop buttons).
+ *   <ScoreUI.PlaybackButtons doc={doc} />
+ *
+ *   // Create playback buttons with single play/stop button.
+ *   <ScoreUI.PlaybackButtons doc={doc} singlePlayStop />
+ *
+ *   // Create playback buttons with play and stop buttons.
+ *   <ScoreUI.PlaybackButtons doc={doc} playStop />
+ *
+ *   // Create playback buttons with play, pause and stop buttons.
+ *   <ScoreUI.PlaybackButtons doc={doc} playPauseStop />
+ *
+ *   // You can also set custom play, pause and stop button labels.
+ *   <ScoreUI.PlaybackButtons doc={doc} playLabel="⏵" pauseLabel="⏸" stopLabel="⏹" />
+ * ```
+ */
+declare class PlaybackButtons extends React.Component<PlaybackButtonsProps, PlaybackButtonsState> {
+    state: PlaybackButtonsState;
+    constructor(props: PlaybackButtonsProps);
+    componentDidUpdate(prevProps: Readonly<PlaybackButtonsProps>): void;
+    render(): react_jsx_runtime.JSX.Element;
+}
+
+export { MusicScoreView, type MusicScoreViewProps, PlaybackButtons, type PlaybackButtonsProps, type PlaybackButtonsState };

package/dist/react-ui/index.js

@@ -0,0 +1,132 @@
+/* WebMusicScore v6.0.0-pre.1 | (c) 2023-2025 Stefan Brockmann | MIT License | Includes: Tone.js (MIT License), Color Name to Code (MIT License) */
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+
+// src/react-ui/index.ts
+var react_ui_exports = {};
+__export(react_ui_exports, {
+  MusicScoreView: () => MusicScoreView,
+  PlaybackButtons: () => PlaybackButtons
+});
+module.exports = __toCommonJS(react_ui_exports);
+
+// src/react-ui/music-score-view.tsx
+var React = __toESM(require("react"));
+var import_score = require("web-music-score/score");
+var import_jsx_runtime = require("react/jsx-runtime");
+var MusicScoreView = class extends React.Component {
+  constructor(props) {
+    super(props);
+    __publicField(this, "ctx");
+    this.ctx = new import_score.MRenderContext();
+    this.ctx.setDocument(props.doc);
+    if (props.onScoreEvent) {
+      this.ctx.setScoreEventListener(props.onScoreEvent);
+    }
+  }
+  componentDidUpdate(prevProps, prevState) {
+    if (prevProps.doc !== this.props.doc) {
+      this.ctx.setDocument(this.props.doc);
+      this.ctx.draw();
+    }
+  }
+  render() {
+    const setCanvas = (canvas) => {
+      if (canvas) {
+        this.ctx.setCanvas(canvas);
+        this.ctx.draw();
+      }
+    };
+    return /* @__PURE__ */ (0, import_jsx_runtime.jsx)("canvas", { style: { position: "relative" }, ref: setCanvas, children: "Your browser does not support the HTML canvas tag." });
+  }
+};
+
+// src/react-ui/playback-buttons.tsx
+var React2 = __toESM(require("react"));
+var import_score2 = require("web-music-score/score");
+var import_jsx_runtime2 = require("react/jsx-runtime");
+var PlaybackButtons = class extends React2.Component {
+  constructor(props) {
+    super(props);
+    __publicField(this, "state");
+    this.state = {
+      controller: new import_score2.MPlaybackButtons().setDocument(props.doc)
+    };
+  }
+  componentDidUpdate(prevProps) {
+    if (this.props.doc !== prevProps.doc) {
+      this.state.controller.setDocument(this.props.doc);
+    }
+  }
+  render() {
+    let { singlePlayStop, playStop, playPauseStop, playLabel, pauseLabel, stopLabel } = this.props;
+    let { controller } = this.state;
+    playLabel != null ? playLabel : playLabel = "Play";
+    pauseLabel != null ? pauseLabel : pauseLabel = "Pause";
+    stopLabel != null ? stopLabel : stopLabel = "Stop";
+    if (singlePlayStop) {
+      return /* @__PURE__ */ (0, import_jsx_runtime2.jsx)("button", { className: "btn btn-primary", ref: (btn) => {
+        if (btn) controller.setPlayStopButton(btn, playLabel, stopLabel);
+      } });
+    } else if (playStop) {
+      return /* @__PURE__ */ (0, import_jsx_runtime2.jsxs)("div", { className: "btn-group", children: [
+        /* @__PURE__ */ (0, import_jsx_runtime2.jsx)("button", { className: "btn btn-primary", ref: (btn) => {
+          if (btn) controller.setPlayButton(btn, playLabel);
+        } }),
+        /* @__PURE__ */ (0, import_jsx_runtime2.jsx)("button", { className: "btn btn-primary", ref: (btn) => {
+          if (btn) controller.setStopButton(btn, stopLabel);
+        } })
+      ] });
+    } else {
+      return /* @__PURE__ */ (0, import_jsx_runtime2.jsxs)("div", { className: "btn-group", children: [
+        /* @__PURE__ */ (0, import_jsx_runtime2.jsx)("button", { className: "btn btn-primary", ref: (btn) => {
+          if (btn) controller.setPlayButton(btn, playLabel);
+        } }),
+        /* @__PURE__ */ (0, import_jsx_runtime2.jsx)("button", { className: "btn btn-primary", ref: (btn) => {
+          if (btn) controller.setPauseButton(btn, pauseLabel);
+        } }),
+        /* @__PURE__ */ (0, import_jsx_runtime2.jsx)("button", { className: "btn btn-primary", ref: (btn) => {
+          if (btn) controller.setStopButton(btn, stopLabel);
+        } })
+      ] });
+    }
+  }
+};
+
+// src/react-ui/index.ts
+var import_core = require("web-music-score/core");
+(0, import_core.init)();
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  MusicScoreView,
+  PlaybackButtons
+});
+//# sourceMappingURL=index.js.map

package/dist/react-ui/index.mjs

@@ -0,0 +1,96 @@
+/* WebMusicScore v6.0.0-pre.1 | (c) 2023-2025 Stefan Brockmann | MIT License | Includes: Tone.js (MIT License), Color Name to Code (MIT License) */
+import {
+  __publicField
+} from "../chunk-A7C2G7OG.mjs";
+
+// src/react-ui/music-score-view.tsx
+import * as React from "react";
+import { MRenderContext } from "web-music-score/score";
+import { jsx } from "react/jsx-runtime";
+var MusicScoreView = class extends React.Component {
+  constructor(props) {
+    super(props);
+    __publicField(this, "ctx");
+    this.ctx = new MRenderContext();
+    this.ctx.setDocument(props.doc);
+    if (props.onScoreEvent) {
+      this.ctx.setScoreEventListener(props.onScoreEvent);
+    }
+  }
+  componentDidUpdate(prevProps, prevState) {
+    if (prevProps.doc !== this.props.doc) {
+      this.ctx.setDocument(this.props.doc);
+      this.ctx.draw();
+    }
+  }
+  render() {
+    const setCanvas = (canvas) => {
+      if (canvas) {
+        this.ctx.setCanvas(canvas);
+        this.ctx.draw();
+      }
+    };
+    return /* @__PURE__ */ jsx("canvas", { style: { position: "relative" }, ref: setCanvas, children: "Your browser does not support the HTML canvas tag." });
+  }
+};
+
+// src/react-ui/playback-buttons.tsx
+import * as React2 from "react";
+import { MPlaybackButtons } from "web-music-score/score";
+import { jsx as jsx2, jsxs } from "react/jsx-runtime";
+var PlaybackButtons = class extends React2.Component {
+  constructor(props) {
+    super(props);
+    __publicField(this, "state");
+    this.state = {
+      controller: new MPlaybackButtons().setDocument(props.doc)
+    };
+  }
+  componentDidUpdate(prevProps) {
+    if (this.props.doc !== prevProps.doc) {
+      this.state.controller.setDocument(this.props.doc);
+    }
+  }
+  render() {
+    let { singlePlayStop, playStop, playPauseStop, playLabel, pauseLabel, stopLabel } = this.props;
+    let { controller } = this.state;
+    playLabel != null ? playLabel : playLabel = "Play";
+    pauseLabel != null ? pauseLabel : pauseLabel = "Pause";
+    stopLabel != null ? stopLabel : stopLabel = "Stop";
+    if (singlePlayStop) {
+      return /* @__PURE__ */ jsx2("button", { className: "btn btn-primary", ref: (btn) => {
+        if (btn) controller.setPlayStopButton(btn, playLabel, stopLabel);
+      } });
+    } else if (playStop) {
+      return /* @__PURE__ */ jsxs("div", { className: "btn-group", children: [
+        /* @__PURE__ */ jsx2("button", { className: "btn btn-primary", ref: (btn) => {
+          if (btn) controller.setPlayButton(btn, playLabel);
+        } }),
+        /* @__PURE__ */ jsx2("button", { className: "btn btn-primary", ref: (btn) => {
+          if (btn) controller.setStopButton(btn, stopLabel);
+        } })
+      ] });
+    } else {
+      return /* @__PURE__ */ jsxs("div", { className: "btn-group", children: [
+        /* @__PURE__ */ jsx2("button", { className: "btn btn-primary", ref: (btn) => {
+          if (btn) controller.setPlayButton(btn, playLabel);
+        } }),
+        /* @__PURE__ */ jsx2("button", { className: "btn btn-primary", ref: (btn) => {
+          if (btn) controller.setPauseButton(btn, pauseLabel);
+        } }),
+        /* @__PURE__ */ jsx2("button", { className: "btn btn-primary", ref: (btn) => {
+          if (btn) controller.setStopButton(btn, stopLabel);
+        } })
+      ] });
+    }
+  }
+};
+
+// src/react-ui/index.ts
+import { init as initCore } from "web-music-score/core";
+initCore();
+export {
+  MusicScoreView,
+  PlaybackButtons
+};
+//# sourceMappingURL=index.mjs.map

package/dist/scale-B1M10_fu.d.ts

@@ -0,0 +1,230 @@
+import { N as Note, S as SymbolSet } from './note-RVXvpfyV.js';
+import { K as KeySignature } from './tempo-D-JF-8b_.js';
+
+/** Interval direction type. */
+type IntervalDirection = "Unison" | "Ascending" | "Descending";
+/** Interval quality type. */
+type IntervalQuality = "Perfect" | "Major" | "minor" | "Augmented" | "Doubly Augmented" | "diminished" | "doubly diminished";
+/**
+ * Validate interval quality of unkown value.
+ * @param q - Interval quality to validate.
+ * @returns - Interval quality if valid, else throws.
+ */
+declare function validateIntervalQuality(q: unknown): IntervalQuality;
+/** Interval class. */
+declare class Interval {
+    readonly note1: Note;
+    readonly note2: Note;
+    /** Interval direction. */
+    readonly direction: IntervalDirection;
+    /** Number of semitones. */
+    readonly semitones: number;
+    /** Interval quantity. */
+    readonly quantity: number;
+    /** Interval quality. */
+    readonly quality: IntervalQuality;
+    private constructor();
+    /**
+     * Get interval between given two notes.
+     * @param note1 - First note.
+     * @param note2 - Second note.
+     * @returns - Interval if valid, or undefined.
+     */
+    static get(note1: Note, note2: Note): Interval | undefined;
+    /**
+     * Get string presentation of interval (e.g. "Descending Major 2").
+     * @returns - Interval string.
+     */
+    toString(): string;
+    /**
+     * Get abbrevated string presentation of interval (e.g. "↓M2").
+     * @returns - Interval abbrevated string.
+     */
+    toAbbrString(): string;
+}
+
+/** Degree type. */
+type Degree = 1 | 2 | "b3" | 3 | 4 | "b5" | 5 | "#5" | 6 | "bb7" | "b7" | 7 | "#7" | "b9" | 9 | "#9" | 11 | 13;
+/** Scale type enum. */
+declare enum ScaleType {
+    /** Major scale. */
+    Major = "Major",
+    /** Natural minor scale. */
+    NaturalMinor = "Natural Minor",
+    /** Harmonic minor scale. */
+    HarmonicMinor = "Harmonic Minor",
+    /** Mode: Ionian. */
+    Ionian = "Ionian",
+    /** Mode: Dorian. */
+    Dorian = "Dorian",
+    /** Mode: Phrygian. */
+    Phrygian = "Phrygian",
+    /** Mode: Lydian. */
+    Lydian = "Lydian",
+    /** Mode: Mixolydian. */
+    Mixolydian = "Mixolydian",
+    /** Mode: Aeolian (minor). */
+    Aeolian = "Aeolian",
+    /** Mode: Locrian (rare). */
+    Locrian = "Locrian",
+    /** Major pentatonic scale. */
+    MajorPentatonic = "Major Pentatonic",
+    /** Minor pentatoni scale. */
+    MinorPentatonic = "Minor Pentatonic",
+    /** Major hexatonic blues scale. */
+    MajorHexatonicBlues = "Major Hexatonic Blues",
+    /** Minor hexatonic blues scale. */
+    MinorHexatonicBlues = "Minor Hexatonic Blues",
+    /** Heptatonic blues scale. */
+    HeptatonicBlues = "Heptatonic Blues"
+}
+/** Scale class. */
+declare class Scale extends KeySignature {
+    readonly tonic: string;
+    readonly scaleType: ScaleType;
+    /** Degrees of scale notes. */
+    private readonly scaleDegrees;
+    /** Scale notes. */
+    private readonly scaleNotes;
+    /** Degrees (or undefined) of chromatic classes. */
+    private readonly chromaticClassDegree;
+    /**
+     * Create nev scale object instance.
+     * @param tonic - Tonic (e.g. "C" in "C Major").
+     * @param scaleType - Scale typo ("e.g. "Major" in "C Major").
+     */
+    constructor(tonic: string, scaleType: ScaleType);
+    /**
+     * Compare if two scales equals.
+     * @param a - Scale a.
+     * @param b - Scale b.
+     * @returns - Boolean equality of given scales.
+     */
+    static equals(a: Scale | null | undefined, b: Scale | null | undefined): boolean;
+    /**
+     * Get scale name.
+     * @param symbolSet - Symbol set to format scale name in ascii or unicode.
+     * @returns - Scale name string.
+     */
+    getScaleName(symbolSet?: SymbolSet): string;
+    /**
+     * Get scale notes.
+     * @param bottomNote - Computed scale notes begin no lower than this note.
+     * @param numOctaves - How many octaves?
+     * @returns - Array of scale notes.
+     */
+    getScaleNotes(bottomNote: string, numOctaves: number): ReadonlyArray<Note>;
+    /**
+     * Get scale overview (e.g. "C - D - E - F - G - A - B" for "C Major" scale).
+     * @returns - Scale overview string.
+     */
+    getScaleOverview(): string;
+    /**
+     * Get scale steps, array of 1 (half step) and 2 (whole step), (e.g. [2, 2, 1, 2, 2, 2, 1] for Major scale).
+     * @returns - Array of scale steps.
+     */
+    getScaleSteps(): number[];
+    /**
+     * Get scale steps string presentation, array of "H" (half step) and "W" (whole step), (e.g. ["W", "W", "H", "W", "W", "W", "H"] for Major scale).
+     * @returns - Array of scale steps string presentation.
+     */
+    getScaleStringSteps(): string[];
+    /**
+     * Test if given note is scale note.
+     * @param note - Note to test.
+     * @returns - True/false.
+     */
+    isScaleNote(note: Note): boolean;
+    /**
+     * Test if given note is scale root note.
+     * @param note - Note to test.
+     * @returns - True/false.
+     */
+    isScaleRootNote(note: Note): boolean;
+    /**
+     * Get interval value between scale root note and given note.
+     * @param note - Note.
+     * @returns - Interval.
+     */
+    getIntervalFromRootNote(note: Note): Interval;
+    private preferredChromaticIdNoteCache;
+    /**
+     * Get preferred chromatic note from given chromatic id.
+     * @param chromaticId - Chromatic id.
+     * @returns - Note.
+     */
+    getPreferredChromaticNote(chromaticId: number): Note;
+}
+/** Scale factory class. */
+declare class ScaleFactory {
+    readonly type: ScaleType;
+    private tonicList;
+    private scaleMap;
+    /**
+     * Create new scale factory object instance.
+     * @param type - Scale type.
+     */
+    constructor(type: ScaleType);
+    /**
+     * Get list of tonics (e.g. "C", "C#", ... for Major scale type).
+     * @returns - Array of tonics.
+     */
+    getTonicList(): ReadonlyArray<string>;
+    /**
+     * Get default tonic.
+     * @returns - Default tonic.
+     */
+    getDefaultTonic(): string;
+    /**
+     * Get scale type.
+     * @returns - SCale type.
+     */
+    getType(): ScaleType;
+    /**
+     * Get scale by given tonic.
+     * @param tonic - Tonic (e.g. "C").
+     * @returns - Scale.
+     */
+    getScale(tonic: string): Scale;
+    /**
+     * Test if this scale factory has scale for given tonic value.
+     * @param tonic - Tonic.
+     * @returns - True/false.
+     */
+    hasScale(tonic: string): boolean;
+}
+/**
+ * Get array of scale factories, has some title string between to category.
+ * @returns - Array of scale factories.
+ */
+declare function getScaleFactoryList(): ReadonlyArray<ScaleFactory | string>;
+/**
+ * Get scale factory for given scale type.
+ * @param scaleType - Scale type.
+ * @returns - Scale factory.
+ */
+declare function getScaleFactory(scaleType: ScaleType | `${ScaleType}`): ScaleFactory;
+/**
+ * Validate scale type.
+ * @param scaleType - Scale type of unknown value.
+ * @returns - Scale type if given argument was valid scale type, or throws.
+ */
+declare function validateScaleType(scaleType: unknown): ScaleType;
+/**
+ * Get scale.
+ * @param tonic - Tonic (e.g. "C").
+ * @param scaleType - Scale type (e.g. "Major").
+ */
+declare function getScale(tonic: string, scaleType: ScaleType | `${ScaleType}`): Scale;
+/**
+ * Get scale.
+ * @param scale - Scale name (e.g. "C Major").
+ */
+declare function getScale(scale: string): Scale;
+/**
+ * Get default scale ("C Major").
+ * @returns - Default scale.
+ */
+declare function getDefaultScale(): Scale;
+
+export { type Degree as D, type IntervalDirection as I, ScaleType as S, type IntervalQuality as a, Interval as b, Scale as c, ScaleFactory as d, getScaleFactory as e, validateScaleType as f, getScaleFactoryList as g, getScale as h, getDefaultScale as i, validateIntervalQuality as v };