musicxml-io 0.3.1 → 0.3.3

package/dist/index.d.mts

@@ -26,6 +26,31 @@ declare function isCompressed(data: Uint8Array): boolean;
  */
 declare function parseAuto(data: Uint8Array | string): Score;
 
+/**
+ * ABC Notation Parser
+ * Parses ABC notation format into the Score internal model.
+ *
+ * Supports ABC standard v2.1 core features:
+ * - Header fields (X, T, C, M, L, Q, K, V, w)
+ * - Notes with pitch, duration, accidentals, octave modifiers
+ * - Rests (z, Z)
+ * - Bar lines (|, ||, |], [|, |:, :|, ::)
+ * - Repeats and volta endings ([1, [2)
+ * - Chords (simultaneous notes: [CEG])
+ * - Chord symbols ("Am", "G7", etc.)
+ * - Ties (-) and slurs ((...))
+ * - Grace notes ({...})
+ * - Tuplets ((3..., (p:q:r...)
+ * - Dynamics (!p!, !f!, etc.)
+ * - Lyrics (w: field)
+ * - Multi-voice (V: field)
+ */
+
+/**
+ * Parse an ABC notation string into a Score object.
+ */
+declare function parseAbc(abcString: string): Score;
+
 interface SerializeOptions {
     version?: string;
     indent?: string;
@@ -67,6 +92,28 @@ interface MidiExportOptions {
  */
 declare function exportMidi(score: Score, options?: MidiExportOptions): Uint8Array;
 
+/**
+ * ABC Notation Serializer
+ * Converts Score internal model to ABC notation format string.
+ */
+
+interface AbcSerializeOptions {
+    /** Reference number (X: field). Default: 1 */
+    referenceNumber?: number;
+    /** Maximum notes per line before wrapping. Default: no limit */
+    notesPerLine?: number;
+    /** Include chord symbols. Default: true */
+    includeChordSymbols?: boolean;
+    /** Include dynamics. Default: true */
+    includeDynamics?: boolean;
+    /** Include lyrics. Default: true */
+    includeLyrics?: boolean;
+}
+/**
+ * Serialize a Score object to ABC notation format string.
+ */
+declare function serializeAbc(score: Score, options?: AbcSerializeOptions): string;
+
 /**
  * Parse a MusicXML file from disk
  * Automatically handles both .xml/.musicxml and .mxl formats
@@ -90,6 +137,7 @@ interface ExportOptions extends SerializeOptions, MidiExportOptions {
  * - .mxl: Compressed MusicXML
  * - .xml/.musicxml: Uncompressed MusicXML
  * - .mid/.midi: Standard MIDI File
+ * - .abc: ABC notation
  * @param score - The Score to serialize
  * @param filePath - Path to write the file
  * @param options - Serialization options
@@ -298,4 +346,4 @@ declare function getPartNameMap(score: Score): Record<string, string | undefined
  */
 declare function generateId(): string;
 
-export { DirectionEntry, DirectionType, type DirectionTypeOfKind, Measure, type MidiExportOptions, NoteEntry, PartInfo, PartListEntry, Pitch, STEPS, STEP_SEMITONES, Score, type SerializeOptions, ValidateOptions, ValidationResult, decodeBuffer, exportMidi, generateId, getAllPartInfos, getDirectionOfKind, getDirectionsOfKind, getMeasureEndPosition, getPartAbbreviation, getPartInfo, getPartName, getPartNameMap, getSoundDamperPedal, getSoundDynamics, getSoundSoftPedal, getSoundSostenutoPedal, getSoundTempo, hasBeam, hasDirectionOfKind, hasLyrics, hasNotations, hasTie, hasTieStart, hasTieStop, hasTuplet, isChordNote, isCompressed, isCueNote, isGraceNote, isPartInfo, isPitchedNote, isRest, isUnpitchedNote, parse, parseAuto, parseCompressed, parseFile, pitchToSemitone, serialize, serializeCompressed, serializeToFile };
+export { type AbcSerializeOptions, DirectionEntry, DirectionType, type DirectionTypeOfKind, Measure, type MidiExportOptions, NoteEntry, PartInfo, PartListEntry, Pitch, STEPS, STEP_SEMITONES, Score, type SerializeOptions, ValidateOptions, ValidationResult, decodeBuffer, exportMidi, generateId, getAllPartInfos, getDirectionOfKind, getDirectionsOfKind, getMeasureEndPosition, getPartAbbreviation, getPartInfo, getPartName, getPartNameMap, getSoundDamperPedal, getSoundDynamics, getSoundSoftPedal, getSoundSostenutoPedal, getSoundTempo, hasBeam, hasDirectionOfKind, hasLyrics, hasNotations, hasTie, hasTieStart, hasTieStop, hasTuplet, isChordNote, isCompressed, isCueNote, isGraceNote, isPartInfo, isPitchedNote, isRest, isUnpitchedNote, parse, parseAbc, parseAuto, parseCompressed, parseFile, pitchToSemitone, serialize, serializeAbc, serializeCompressed, serializeToFile };

package/dist/index.d.ts

@@ -26,6 +26,31 @@ declare function isCompressed(data: Uint8Array): boolean;
  */
 declare function parseAuto(data: Uint8Array | string): Score;
 
+/**
+ * ABC Notation Parser
+ * Parses ABC notation format into the Score internal model.
+ *
+ * Supports ABC standard v2.1 core features:
+ * - Header fields (X, T, C, M, L, Q, K, V, w)
+ * - Notes with pitch, duration, accidentals, octave modifiers
+ * - Rests (z, Z)
+ * - Bar lines (|, ||, |], [|, |:, :|, ::)
+ * - Repeats and volta endings ([1, [2)
+ * - Chords (simultaneous notes: [CEG])
+ * - Chord symbols ("Am", "G7", etc.)
+ * - Ties (-) and slurs ((...))
+ * - Grace notes ({...})
+ * - Tuplets ((3..., (p:q:r...)
+ * - Dynamics (!p!, !f!, etc.)
+ * - Lyrics (w: field)
+ * - Multi-voice (V: field)
+ */
+
+/**
+ * Parse an ABC notation string into a Score object.
+ */
+declare function parseAbc(abcString: string): Score;
+
 interface SerializeOptions {
     version?: string;
     indent?: string;
@@ -67,6 +92,28 @@ interface MidiExportOptions {
  */
 declare function exportMidi(score: Score, options?: MidiExportOptions): Uint8Array;
 
+/**
+ * ABC Notation Serializer
+ * Converts Score internal model to ABC notation format string.
+ */
+
+interface AbcSerializeOptions {
+    /** Reference number (X: field). Default: 1 */
+    referenceNumber?: number;
+    /** Maximum notes per line before wrapping. Default: no limit */
+    notesPerLine?: number;
+    /** Include chord symbols. Default: true */
+    includeChordSymbols?: boolean;
+    /** Include dynamics. Default: true */
+    includeDynamics?: boolean;
+    /** Include lyrics. Default: true */
+    includeLyrics?: boolean;
+}
+/**
+ * Serialize a Score object to ABC notation format string.
+ */
+declare function serializeAbc(score: Score, options?: AbcSerializeOptions): string;
+
 /**
  * Parse a MusicXML file from disk
  * Automatically handles both .xml/.musicxml and .mxl formats
@@ -90,6 +137,7 @@ interface ExportOptions extends SerializeOptions, MidiExportOptions {
  * - .mxl: Compressed MusicXML
  * - .xml/.musicxml: Uncompressed MusicXML
  * - .mid/.midi: Standard MIDI File
+ * - .abc: ABC notation
  * @param score - The Score to serialize
  * @param filePath - Path to write the file
  * @param options - Serialization options
@@ -298,4 +346,4 @@ declare function getPartNameMap(score: Score): Record<string, string | undefined
  */
 declare function generateId(): string;
 
-export { DirectionEntry, DirectionType, type DirectionTypeOfKind, Measure, type MidiExportOptions, NoteEntry, PartInfo, PartListEntry, Pitch, STEPS, STEP_SEMITONES, Score, type SerializeOptions, ValidateOptions, ValidationResult, decodeBuffer, exportMidi, generateId, getAllPartInfos, getDirectionOfKind, getDirectionsOfKind, getMeasureEndPosition, getPartAbbreviation, getPartInfo, getPartName, getPartNameMap, getSoundDamperPedal, getSoundDynamics, getSoundSoftPedal, getSoundSostenutoPedal, getSoundTempo, hasBeam, hasDirectionOfKind, hasLyrics, hasNotations, hasTie, hasTieStart, hasTieStop, hasTuplet, isChordNote, isCompressed, isCueNote, isGraceNote, isPartInfo, isPitchedNote, isRest, isUnpitchedNote, parse, parseAuto, parseCompressed, parseFile, pitchToSemitone, serialize, serializeCompressed, serializeToFile };
+export { type AbcSerializeOptions, DirectionEntry, DirectionType, type DirectionTypeOfKind, Measure, type MidiExportOptions, NoteEntry, PartInfo, PartListEntry, Pitch, STEPS, STEP_SEMITONES, Score, type SerializeOptions, ValidateOptions, ValidationResult, decodeBuffer, exportMidi, generateId, getAllPartInfos, getDirectionOfKind, getDirectionsOfKind, getMeasureEndPosition, getPartAbbreviation, getPartInfo, getPartName, getPartNameMap, getSoundDamperPedal, getSoundDynamics, getSoundSoftPedal, getSoundSostenutoPedal, getSoundTempo, hasBeam, hasDirectionOfKind, hasLyrics, hasNotations, hasTie, hasTieStart, hasTieStop, hasTuplet, isChordNote, isCompressed, isCueNote, isGraceNote, isPartInfo, isPitchedNote, isRest, isUnpitchedNote, parse, parseAbc, parseAuto, parseCompressed, parseFile, pitchToSemitone, serialize, serializeAbc, serializeCompressed, serializeToFile };