smoosic 1.0.24 → 1.0.26

package/types/src/smo/mxml/smoToXml.d.ts

@@ -1,165 +1,165 @@
-import { Pitch } from '../data/common';
-import { SmoNote } from '../data/note';
-import { SmoMeasure, SmoVoice } from '../data/measure';
-import { SmoSystemStaff } from '../data/systemStaff';
-import { SmoScore } from '../data/score';
-import { TimeSignature } from '../data/measureModifiers';
-import { SmoSelector } from '../xform/selections';
-import { SmoTempoText } from '../data/measureModifiers';
-/**
- * @category serialization
- */
-export interface SlurXml {
-    startSelector: SmoSelector;
-    endSelector: SmoSelector;
-    number: number;
-}
-/**
- * Keep state of the xml document as we are generating it
- * @category serialization
- */
-export interface SmoState {
-    divisions: number;
-    measureNumber: number;
-    measureIndex: number;
-    transposeOffset: number;
-    tickCount: number;
-    voiceIndex: number;
-    keySignature: string;
-    voiceTickIndex: number;
-    voice?: SmoVoice;
-    partStaves: SmoSystemStaff[];
-    staffPartIx: number;
-    slurs: SlurXml[];
-    ties: SlurXml[];
-    tieds: SlurXml[];
-    lyricState: Record<number, string>;
-    measureTicks: number;
-    note?: SmoNote;
-    beamState: number;
-    beamTicks: number;
-    timeSignature?: TimeSignature;
-    tempo?: SmoTempoText;
-    currentTupletLevel: number;
-}
-/**
- * Convert {@link SmoScore} object into a music XML serialization
- *
- * usage: `xdoc: XmlDocument = SmoToXml.convert(score)`
- * @category serialization
- */
-export declare class SmoToXml {
-    static get beamStates(): Record<string, number>;
-    static get defaultState(): SmoState;
-    /**
-     * see usage
-     * @param score
-     * @returns
-     */
-    static convert(score: SmoScore): XMLDocument;
-    /**
-     * /score-partwise/part/measure
-     * @param measureElement
-     * @param smoState
-     * @returns
-     */
-    static measure(measureElement: Element, smoState: SmoState): void;
-    /**
-     * /score-partwise/part/measure/barline
-     * @param measureElement
-     * @param smoState
-     * @param start
-     */
-    static barline(measureElement: Element, smoState: SmoState, start: boolean): void;
-    /**
-     * /score-partwise/part/measure/note/tie
-     * @param notationsElement
-     * @param smoState
-     */
-    static tied(notationsElement: Element, smoState: SmoState): void;
-    /**
-     * /score-partwise/part/measure/note/tie
-     * @param noteElement
-     * @param smoState
-     */
-    static tie(noteElement: Element, smoState: SmoState): void;
-    /**
-   * /score-partwise/part/measure/note/notations/slur
-   * @param notationsElement
-   * @param smoState
-   */
-    static slur(notationsElement: Element, smoState: SmoState): void;
-    /**
-     * /score-partwise/measure/note/time-modification
-     * /score-partwise/measure/note/tuplet
-     */
-    static tupletTime(noteElement: Element, note: SmoNote, measure: SmoMeasure, smoState: SmoState): void;
-    static tupletNotation(notationsElement: Element, note: SmoNote, measure: SmoMeasure, smoState: SmoState): void;
-    /**
-     * /score-partwise/measure/note/pitch
-     * @param pitch
-     * @param noteElement
-     */
-    static pitch(pitch: Pitch, noteElement: Element): void;
-    /**
-     * /score-partwise/measure/beam
-     * @param noteElement
-     * @param smoState
-     * @returns
-     */
-    static beamNote(noteElement: Element, smoState: SmoState): void;
-    /**
-     * /score-partwise/measure/direction/direction-type
-     * @param measureElement
-     * @param smoState
-     * @param beforeNote
-     */
-    static direction(measureElement: Element, smoState: SmoState, beforeNote: boolean): void;
-    /**
-     * /score-partwise/measure/note/lyric
-     * @param noteElement
-     * @param smoState
-     */
-    static lyric(noteElement: Element, smoState: SmoState): void;
-    /**
-     * /score-partwise/measure/note
-     * @param measureElement
-     * @param smoState
-     */
-    static note(measureElement: Element, measure: SmoMeasure, note: SmoNote, smoState: SmoState): void;
-    /**
-     * /score-partwise/measure/attributes/key
-     * @param attributesElement
-     * @param smoState
-     * @returns
-     */
-    static key(attributesElement: Element, measure: SmoMeasure, smoState: SmoState): void;
-    /**
-     * /score-partwise/part/measure/attributes/time
-     * @param attributesElement
-     * @param smoState
-     * @returns
-     */
-    static time(attributesElement: Element, smoState: SmoState): void;
-    /**
-     * /score-partwise/part/measure/attributes/clef
-     * @param attributesElement
-     * @param smoState
-     * @returns
-     */
-    static clef(attributesElement: Element, smoState: SmoState): void;
-    /**
-     * /score-partwise/part/measure/attributes
-     * @param measureElement
-     * @param smoState
-     */
-    static attributes(measureElement: Element, measure: SmoMeasure, smoState: SmoState): void;
-    static staves(attributesElement: Element, smoState: SmoState): void;
-    /**
-     * /score-partwise/part/measure/attributes/transpose
-     * @param attributesElement
-     * @param smoState
-     * @returns
-     */
-    static transpose(attributesElement: Element, smoState: SmoState): void;
-}
+import { Pitch } from '../data/common';
+import { SmoNote } from '../data/note';
+import { SmoMeasure, SmoVoice } from '../data/measure';
+import { SmoSystemStaff } from '../data/systemStaff';
+import { SmoScore } from '../data/score';
+import { TimeSignature } from '../data/measureModifiers';
+import { SmoSelector } from '../xform/selections';
+import { SmoTempoText } from '../data/measureModifiers';
+/**
+ * @category serialization
+ */
+export interface SlurXml {
+    startSelector: SmoSelector;
+    endSelector: SmoSelector;
+    number: number;
+}
+/**
+ * Keep state of the xml document as we are generating it
+ * @category serialization
+ */
+export interface SmoState {
+    divisions: number;
+    measureNumber: number;
+    measureIndex: number;
+    transposeOffset: number;
+    tickCount: number;
+    voiceIndex: number;
+    keySignature: string;
+    voiceTickIndex: number;
+    voice?: SmoVoice;
+    partStaves: SmoSystemStaff[];
+    staffPartIx: number;
+    slurs: SlurXml[];
+    ties: SlurXml[];
+    tieds: SlurXml[];
+    lyricState: Record<number, string>;
+    measureTicks: number;
+    note?: SmoNote;
+    beamState: number;
+    beamTicks: number;
+    timeSignature?: TimeSignature;
+    tempo?: SmoTempoText;
+    currentTupletLevel: number;
+}
+/**
+ * Convert {@link SmoScore} object into a music XML serialization
+ *
+ * usage: `xdoc: XmlDocument = SmoToXml.convert(score)`
+ * @category serialization
+ */
+export declare class SmoToXml {
+    static get beamStates(): Record<string, number>;
+    static get defaultState(): SmoState;
+    /**
+     * see usage
+     * @param score
+     * @returns
+     */
+    static convert(score: SmoScore): XMLDocument;
+    /**
+     * /score-partwise/part/measure
+     * @param measureElement
+     * @param smoState
+     * @returns
+     */
+    static measure(measureElement: Element, smoState: SmoState): void;
+    /**
+     * /score-partwise/part/measure/barline
+     * @param measureElement
+     * @param smoState
+     * @param start
+     */
+    static barline(measureElement: Element, smoState: SmoState, start: boolean): void;
+    /**
+     * /score-partwise/part/measure/note/tie
+     * @param notationsElement
+     * @param smoState
+     */
+    static tied(notationsElement: Element, smoState: SmoState): void;
+    /**
+     * /score-partwise/part/measure/note/tie
+     * @param noteElement
+     * @param smoState
+     */
+    static tie(noteElement: Element, smoState: SmoState): void;
+    /**
+   * /score-partwise/part/measure/note/notations/slur
+   * @param notationsElement
+   * @param smoState
+   */
+    static slur(notationsElement: Element, smoState: SmoState): void;
+    /**
+     * /score-partwise/measure/note/time-modification
+     * /score-partwise/measure/note/tuplet
+     */
+    static tupletTime(noteElement: Element, note: SmoNote, measure: SmoMeasure, smoState: SmoState): void;
+    static tupletNotation(notationsElement: Element, note: SmoNote, measure: SmoMeasure, smoState: SmoState): void;
+    /**
+     * /score-partwise/measure/note/pitch
+     * @param pitch
+     * @param noteElement
+     */
+    static pitch(pitch: Pitch, noteElement: Element): void;
+    /**
+     * /score-partwise/measure/beam
+     * @param noteElement
+     * @param smoState
+     * @returns
+     */
+    static beamNote(noteElement: Element, smoState: SmoState): void;
+    /**
+     * /score-partwise/measure/direction/direction-type
+     * @param measureElement
+     * @param smoState
+     * @param beforeNote
+     */
+    static direction(measureElement: Element, smoState: SmoState, beforeNote: boolean): void;
+    /**
+     * /score-partwise/measure/note/lyric
+     * @param noteElement
+     * @param smoState
+     */
+    static lyric(noteElement: Element, smoState: SmoState): void;
+    /**
+     * /score-partwise/measure/note
+     * @param measureElement
+     * @param smoState
+     */
+    static note(measureElement: Element, measure: SmoMeasure, note: SmoNote, smoState: SmoState): void;
+    /**
+     * /score-partwise/measure/attributes/key
+     * @param attributesElement
+     * @param smoState
+     * @returns
+     */
+    static key(attributesElement: Element, measure: SmoMeasure, smoState: SmoState): void;
+    /**
+     * /score-partwise/part/measure/attributes/time
+     * @param attributesElement
+     * @param smoState
+     * @returns
+     */
+    static time(attributesElement: Element, smoState: SmoState): void;
+    /**
+     * /score-partwise/part/measure/attributes/clef
+     * @param attributesElement
+     * @param smoState
+     * @returns
+     */
+    static clef(attributesElement: Element, smoState: SmoState): void;
+    /**
+     * /score-partwise/part/measure/attributes
+     * @param measureElement
+     * @param smoState
+     */
+    static attributes(measureElement: Element, measure: SmoMeasure, smoState: SmoState): void;
+    static staves(attributesElement: Element, smoState: SmoState): void;
+    /**
+     * /score-partwise/part/measure/attributes/transpose
+     * @param attributesElement
+     * @param smoState
+     * @returns
+     */
+    static transpose(attributesElement: Element, smoState: SmoState): void;
+}

package/types/src/smo/mxml/xmlHelpers.d.ts

@@ -1,140 +1,140 @@
-import { SmoNoteModifierBase } from '../data/noteModifiers';
-import { Pitch } from '../data/common';
-import { SmoSelector } from '../xform/selections';
-import { XmlTupletData } from './xmlState';
-/**
- * @category serialization
- */
-export interface XmlOrnamentData {
-    ctor: string;
-    params: Record<string, string>;
-}
-/**
- * @category serialization
- */
-export interface XmlSmoMap {
-    xml: string;
-    smo: string;
-}
-/**
- * @category serialization
- */
-export interface XmlDurationAlteration {
-    noteCount: number;
-    noteDuration: number;
-}
-/**
- * @category serialization
- */
-export interface XmlDuration {
-    tickCount: number;
-    duration: number;
-    alteration: XmlDurationAlteration;
-}
-/**
- * Store slur information when parsing xml
- * @category serialization
- */
-export interface XmlSlurType {
-    number: number;
-    type: string;
-    orientation: string;
-    placement: string;
-    controlX: number;
-    controlY: number;
-    selector: SmoSelector;
-    yOffset: number;
-}
-/**
- * Store tie  information when parsing xml
- * @category serialization
- */
-export interface XmlTieType {
-    number: number;
-    type: string;
-    orientation: string;
-    selector: SmoSelector;
-    pitchIndex: number;
-}
-/**
- * Store tuplet information when parsing xml
- * @category serialization
- */
-export interface XmlTupletType {
-    number: number;
-    type: string;
-    data: XmlTupletData | null;
-}
-/**
- * @category serialization
- */
-export interface XmlTimeModificationType {
-    actualNotes: number;
-    normalNotes: number;
-    normalType: number;
-}
-/**
- * @category serialization
- */
-export interface XmlEndingData {
-    numbers: number[];
-    type: string;
-}
-export type LyricSyllabic = 'begin' | 'end' | 'middle' | 'single';
-/**
- * Store lyric information when parsing xml
- * @category serialization
- */
-export interface XmlLyricData {
-    _text: string;
-    verse: number | string;
-    syllabic: LyricSyllabic;
-}
-/**
- * Utilities for parsing and serialzing musicXML.
- * @category serialization
- */
-export declare class XmlHelpers {
-    /**
-     * mxml note 'types', really s/b stem types.
-     * For grace notes, we use the note type and not duration
-     * to get the flag
-     */
-    static get noteTypesToSmoMap(): Record<string, number>;
-    static readonly _ticksToNoteTypeMap: Record<number, string>;
-    static get ticksToNoteTypeMap(): Record<number, string>;
-    static closestStemType(ticks: number): string;
-    static get beamStates(): Record<string, number>;
-    static get ornamentXmlToSmoMap(): Record<string, XmlOrnamentData>;
-    static createRootElement(): XMLDocument;
-    static getNumberFromElement(parent: Element, path: string, defaults: number): number;
-    static getTextFromElement(parent: Element, path: string, defaults: number | string | null): string;
-    static getNumberFromAttribute(node: Element, attribute: string, defaults: number): number;
-    static getTextFromAttribute(node: Element, attribute: string, defaults: string): string;
-    static getChildrenFromPath(parent: Element, pathAr: string[]): Element[];
-    static getStemType(noteElement: Element): number;
-    static getEnding(barlineNode: Element): XmlEndingData | null;
-    static getBarline(barlineNode: Element): number;
-    static assignDefaults(node: Element, defObj: any, parameters: XmlSmoMap[]): void;
-    static nodeAttributes(node: Element): Record<string, string>;
-    static getStaffId(node: Element): number;
-    static noteBeamState(noteNode: Element): number;
-    static getVoiceId(node: Element): number;
-    static smoPitchFromNote(noteNode: Element, defaultPitch: Pitch): Pitch;
-    static isGrace(noteNode: Element): boolean;
-    static isSystemBreak(measureNode: Element): boolean;
-    static durationFromType(noteNode: Element, def: number): number;
-    static durationFromNode(noteNode: Element, def: number): number;
-    static ticksFromDuration(noteNode: Element, divisions: number, def: number): XmlDuration;
-    static getTieData(noteNode: Element, selector: SmoSelector, pitchIndex: number): XmlTieType[];
-    static getSlurData(noteNode: Element, selector: SmoSelector): XmlSlurType[];
-    static getCrescendoData(directionElement: Element): {};
-    static getTimeModificationType(noteNode: Element): XmlTimeModificationType | null;
-    static getTupletData(noteNode: Element): XmlTupletType[];
-    static articulationsAndOrnaments(noteNode: Element): SmoNoteModifierBase[];
-    static lyrics(noteNode: Element): XmlLyricData[];
-    static getTimeAlteration(noteNode: Element): XmlDurationAlteration | null;
-    static createTextElementChild(parentElement: Element, elementName: string, obj: any, field: string): Element;
-    static createAttributes(element: Element, obj: any): void;
-    static createAttribute(element: Element, name: string, value: any): void;
-}
+import { SmoNoteModifierBase } from '../data/noteModifiers';
+import { Pitch } from '../data/common';
+import { SmoSelector } from '../xform/selections';
+import { XmlTupletData } from './xmlState';
+/**
+ * @category serialization
+ */
+export interface XmlOrnamentData {
+    ctor: string;
+    params: Record<string, string>;
+}
+/**
+ * @category serialization
+ */
+export interface XmlSmoMap {
+    xml: string;
+    smo: string;
+}
+/**
+ * @category serialization
+ */
+export interface XmlDurationAlteration {
+    noteCount: number;
+    noteDuration: number;
+}
+/**
+ * @category serialization
+ */
+export interface XmlDuration {
+    tickCount: number;
+    duration: number;
+    alteration: XmlDurationAlteration;
+}
+/**
+ * Store slur information when parsing xml
+ * @category serialization
+ */
+export interface XmlSlurType {
+    number: number;
+    type: string;
+    orientation: string;
+    placement: string;
+    controlX: number;
+    controlY: number;
+    selector: SmoSelector;
+    yOffset: number;
+}
+/**
+ * Store tie  information when parsing xml
+ * @category serialization
+ */
+export interface XmlTieType {
+    number: number;
+    type: string;
+    orientation: string;
+    selector: SmoSelector;
+    pitchIndex: number;
+}
+/**
+ * Store tuplet information when parsing xml
+ * @category serialization
+ */
+export interface XmlTupletType {
+    number: number;
+    type: string;
+    data: XmlTupletData | null;
+}
+/**
+ * @category serialization
+ */
+export interface XmlTimeModificationType {
+    actualNotes: number;
+    normalNotes: number;
+    normalType: number;
+}
+/**
+ * @category serialization
+ */
+export interface XmlEndingData {
+    numbers: number[];
+    type: string;
+}
+export type LyricSyllabic = 'begin' | 'end' | 'middle' | 'single';
+/**
+ * Store lyric information when parsing xml
+ * @category serialization
+ */
+export interface XmlLyricData {
+    _text: string;
+    verse: number | string;
+    syllabic: LyricSyllabic;
+}
+/**
+ * Utilities for parsing and serialzing musicXML.
+ * @category serialization
+ */
+export declare class XmlHelpers {
+    /**
+     * mxml note 'types', really s/b stem types.
+     * For grace notes, we use the note type and not duration
+     * to get the flag
+     */
+    static get noteTypesToSmoMap(): Record<string, number>;
+    static readonly _ticksToNoteTypeMap: Record<number, string>;
+    static get ticksToNoteTypeMap(): Record<number, string>;
+    static closestStemType(ticks: number): string;
+    static get beamStates(): Record<string, number>;
+    static get ornamentXmlToSmoMap(): Record<string, XmlOrnamentData>;
+    static createRootElement(): XMLDocument;
+    static getNumberFromElement(parent: Element, path: string, defaults: number): number;
+    static getTextFromElement(parent: Element, path: string, defaults: number | string | null): string;
+    static getNumberFromAttribute(node: Element, attribute: string, defaults: number): number;
+    static getTextFromAttribute(node: Element, attribute: string, defaults: string): string;
+    static getChildrenFromPath(parent: Element, pathAr: string[]): Element[];
+    static getStemType(noteElement: Element): number;
+    static getEnding(barlineNode: Element): XmlEndingData | null;
+    static getBarline(barlineNode: Element): number;
+    static assignDefaults(node: Element, defObj: any, parameters: XmlSmoMap[]): void;
+    static nodeAttributes(node: Element): Record<string, string>;
+    static getStaffId(node: Element): number;
+    static noteBeamState(noteNode: Element): number;
+    static getVoiceId(node: Element): number;
+    static smoPitchFromNote(noteNode: Element, defaultPitch: Pitch): Pitch;
+    static isGrace(noteNode: Element): boolean;
+    static isSystemBreak(measureNode: Element): boolean;
+    static durationFromType(noteNode: Element, def: number): number;
+    static durationFromNode(noteNode: Element, def: number): number;
+    static ticksFromDuration(noteNode: Element, divisions: number, def: number): XmlDuration;
+    static getTieData(noteNode: Element, selector: SmoSelector, pitchIndex: number): XmlTieType[];
+    static getSlurData(noteNode: Element, selector: SmoSelector): XmlSlurType[];
+    static getCrescendoData(directionElement: Element): {};
+    static getTimeModificationType(noteNode: Element): XmlTimeModificationType | null;
+    static getTupletData(noteNode: Element): XmlTupletType[];
+    static articulationsAndOrnaments(noteNode: Element): SmoNoteModifierBase[];
+    static lyrics(noteNode: Element): XmlLyricData[];
+    static getTimeAlteration(noteNode: Element): XmlDurationAlteration | null;
+    static createTextElementChild(parentElement: Element, elementName: string, obj: any, field: string): Element;
+    static createAttributes(element: Element, obj: any): void;
+    static createAttribute(element: Element, name: string, value: any): void;
+}