musicxml-io 0.2.8 → 0.2.9

package/README.md

@@ -69,6 +69,8 @@ const transposed = transpose(score, 2);  // up 2 semitones
 const output = serialize(transposed);
 ```
 
+⚠️ **Warning**: This library's API is not yet stable and may change between versions.
+
 ### File I/O (Node.js)
 
 ```typescript

package/dist/index.js

@@ -3727,8 +3727,10 @@ function serializeSystemLayout(layout, indent) {
 }
 function serializeCredit(credit, indent) {
   const lines = [];
-  const pageAttr = credit.page !== void 0 ? ` page="${credit.page}"` : "";
-  lines.push(`${indent}<credit${pageAttr}>`);
+  let attrs = "";
+  if (credit._id) attrs += ` id="${escapeXml(credit._id)}"`;
+  if (credit.page !== void 0) attrs += ` page="${credit.page}"`;
+  lines.push(`${indent}<credit${attrs}>`);
   if (credit.creditType) {
     for (const ct of credit.creditType) {
       lines.push(`${indent}${indent}<credit-type>${escapeXml(ct)}</credit-type>`);
@@ -3736,19 +3738,19 @@ function serializeCredit(credit, indent) {
   }
   if (credit.creditWords) {
     for (const cw of credit.creditWords) {
-      let attrs = "";
-      if (cw.defaultX !== void 0) attrs += ` default-x="${cw.defaultX}"`;
-      if (cw.defaultY !== void 0) attrs += ` default-y="${cw.defaultY}"`;
-      if (cw.fontSize) attrs += ` font-size="${escapeXml(cw.fontSize)}"`;
-      if (cw.fontWeight) attrs += ` font-weight="${escapeXml(cw.fontWeight)}"`;
-      if (cw.fontStyle) attrs += ` font-style="${escapeXml(cw.fontStyle)}"`;
-      if (cw.justify) attrs += ` justify="${escapeXml(cw.justify)}"`;
-      if (cw.halign) attrs += ` halign="${escapeXml(cw.halign)}"`;
-      if (cw.valign) attrs += ` valign="${escapeXml(cw.valign)}"`;
-      if (cw.letterSpacing) attrs += ` letter-spacing="${escapeXml(cw.letterSpacing)}"`;
-      if (cw.xmlLang) attrs += ` xml:lang="${escapeXml(cw.xmlLang)}"`;
-      if (cw.xmlSpace) attrs += ` xml:space="${escapeXml(cw.xmlSpace)}"`;
-      lines.push(`${indent}${indent}<credit-words${attrs}>${escapeXml(cw.text)}</credit-words>`);
+      let attrs2 = "";
+      if (cw.defaultX !== void 0) attrs2 += ` default-x="${cw.defaultX}"`;
+      if (cw.defaultY !== void 0) attrs2 += ` default-y="${cw.defaultY}"`;
+      if (cw.fontSize) attrs2 += ` font-size="${escapeXml(cw.fontSize)}"`;
+      if (cw.fontWeight) attrs2 += ` font-weight="${escapeXml(cw.fontWeight)}"`;
+      if (cw.fontStyle) attrs2 += ` font-style="${escapeXml(cw.fontStyle)}"`;
+      if (cw.justify) attrs2 += ` justify="${escapeXml(cw.justify)}"`;
+      if (cw.halign) attrs2 += ` halign="${escapeXml(cw.halign)}"`;
+      if (cw.valign) attrs2 += ` valign="${escapeXml(cw.valign)}"`;
+      if (cw.letterSpacing) attrs2 += ` letter-spacing="${escapeXml(cw.letterSpacing)}"`;
+      if (cw.xmlLang) attrs2 += ` xml:lang="${escapeXml(cw.xmlLang)}"`;
+      if (cw.xmlSpace) attrs2 += ` xml:space="${escapeXml(cw.xmlSpace)}"`;
+      lines.push(`${indent}${indent}<credit-words${attrs2}>${escapeXml(cw.text)}</credit-words>`);
     }
   }
   lines.push(`${indent}</credit>`);
@@ -3868,6 +3870,7 @@ function serializePartGroup(group, indent) {
   const lines = [];
   let attrs = ` type="${group.groupType}"`;
   if (group.number !== void 0) attrs += ` number="${group.number}"`;
+  if (group._id) attrs += ` id="${escapeXml(group._id)}"`;
   lines.push(`${indent}<part-group${attrs}>`);
   if (group.groupName) {
     lines.push(`${indent}  <group-name>${escapeXml(group.groupName)}</group-name>`);
@@ -3908,6 +3911,7 @@ function serializePart(part, indent) {
 function serializeMeasure(measure, indent) {
   const lines = [];
   let attrs = ` number="${measure.number}"`;
+  if (measure._id) attrs += ` id="${escapeXml(measure._id)}"`;
   if (measure.width !== void 0) attrs += ` width="${measure.width}"`;
   if (measure.implicit) attrs += ` implicit="yes"`;
   lines.push(`${indent}<measure${attrs}>`);
@@ -3982,9 +3986,10 @@ function serializePrint(print, indent) {
   lines.push(`${indent}</print>`);
   return lines;
 }
-function serializeAttributes(attrs, indent) {
+function serializeAttributes(attrs, indent, id) {
   const lines = [];
-  lines.push(`${indent}<attributes>`);
+  const idAttr = id ? ` id="${escapeXml(id)}"` : "";
+  lines.push(`${indent}<attributes${idAttr}>`);
   if (attrs.divisions !== void 0) {
     lines.push(`${indent}  <divisions>${attrs.divisions}</divisions>`);
   }
@@ -4132,7 +4137,7 @@ function serializeEntry(entry, indent) {
     case "sound":
       return serializeSound(entry, indent);
     case "attributes":
-      return serializeAttributes(entry.attributes, indent);
+      return serializeAttributes(entry.attributes, indent, entry._id);
     default:
       return [];
   }
@@ -4140,6 +4145,7 @@ function serializeEntry(entry, indent) {
 function serializeNote(note, indent) {
   const lines = [];
   const noteAttrs = buildAttrs({
+    "id": note._id,
     "default-x": note.defaultX,
     "default-y": note.defaultY,
     "relative-x": note.relativeX,
@@ -4622,7 +4628,8 @@ function serializeBackup(backup, indent) {
 }
 function serializeForward(forward, indent) {
   const lines = [];
-  lines.push(`${indent}<forward>`);
+  const idAttr = forward._id ? ` id="${escapeXml(forward._id)}"` : "";
+  lines.push(`${indent}<forward${idAttr}>`);
   lines.push(`${indent}  <duration>${forward.duration}</duration>`);
   if (forward.voice !== void 0) {
     lines.push(`${indent}  <voice>${forward.voice}</voice>`);
@@ -4636,6 +4643,7 @@ function serializeForward(forward, indent) {
 function serializeDirection(direction, indent) {
   const lines = [];
   let attrs = "";
+  if (direction._id) attrs += ` id="${escapeXml(direction._id)}"`;
   if (direction.placement) attrs += ` placement="${direction.placement}"`;
   if (direction.directive) attrs += ' directive="yes"';
   if (direction.system) attrs += ` system="${direction.system}"`;
@@ -4897,7 +4905,9 @@ function serializeDirectionType(dirType, indent) {
 }
 function serializeBarline(barline, indent) {
   const lines = [];
-  lines.push(`${indent}<barline location="${barline.location}">`);
+  let attrs = ` location="${barline.location}"`;
+  if (barline._id) attrs += ` id="${escapeXml(barline._id)}"`;
+  lines.push(`${indent}<barline${attrs}>`);
   if (barline.barStyle) {
     lines.push(`${indent}  <bar-style>${barline.barStyle}</bar-style>`);
   }
@@ -4990,6 +5000,7 @@ function serializeMeasureStyle(ms, indent) {
 function serializeHarmony(harmony, indent) {
   const lines = [];
   const attrs = buildAttrs({
+    id: harmony._id,
     placement: harmony.placement,
     "print-frame": harmony.printFrame,
     "default-y": harmony.defaultY,
@@ -5067,6 +5078,7 @@ function serializeHarmony(harmony, indent) {
 function serializeFiguredBass(fb, indent) {
   const lines = [];
   let attrs = "";
+  if (fb._id) attrs += ` id="${escapeXml(fb._id)}"`;
   if (fb.parentheses) attrs += ' parentheses="yes"';
   lines.push(`${indent}<figured-bass${attrs}>`);
   for (const fig of fb.figures) {
@@ -5098,6 +5110,7 @@ function serializeFiguredBass(fb, indent) {
 function serializeSound(sound, indent) {
   const lines = [];
   const attrs = [];
+  if (sound._id) attrs.push(`id="${escapeXml(sound._id)}"`);
   if (sound.tempo !== void 0) attrs.push(`tempo="${sound.tempo}"`);
   if (sound.dynamics !== void 0) attrs.push(`dynamics="${sound.dynamics}"`);
   if (sound.dacapo) attrs.push('dacapo="yes"');
@@ -5129,7 +5142,7 @@ function serializeSound(sound, indent) {
     }
     lines.push(`${indent}  </swing>`);
     lines.push(`${indent}</sound>`);
-  } else if (attrs.length === 0) {
+  } else if (attrs.length === 0 && !sound._id) {
     lines.push(`${indent}<sound/>`);
   } else {
     lines.push(`${indent}<sound${attrStr}/>`);

package/dist/index.mjs

@@ -3552,8 +3552,10 @@ function serializeSystemLayout(layout, indent) {
 }
 function serializeCredit(credit, indent) {
   const lines = [];
-  const pageAttr = credit.page !== void 0 ? ` page="${credit.page}"` : "";
-  lines.push(`${indent}<credit${pageAttr}>`);
+  let attrs = "";
+  if (credit._id) attrs += ` id="${escapeXml(credit._id)}"`;
+  if (credit.page !== void 0) attrs += ` page="${credit.page}"`;
+  lines.push(`${indent}<credit${attrs}>`);
   if (credit.creditType) {
     for (const ct of credit.creditType) {
       lines.push(`${indent}${indent}<credit-type>${escapeXml(ct)}</credit-type>`);
@@ -3561,19 +3563,19 @@ function serializeCredit(credit, indent) {
   }
   if (credit.creditWords) {
     for (const cw of credit.creditWords) {
-      let attrs = "";
-      if (cw.defaultX !== void 0) attrs += ` default-x="${cw.defaultX}"`;
-      if (cw.defaultY !== void 0) attrs += ` default-y="${cw.defaultY}"`;
-      if (cw.fontSize) attrs += ` font-size="${escapeXml(cw.fontSize)}"`;
-      if (cw.fontWeight) attrs += ` font-weight="${escapeXml(cw.fontWeight)}"`;
-      if (cw.fontStyle) attrs += ` font-style="${escapeXml(cw.fontStyle)}"`;
-      if (cw.justify) attrs += ` justify="${escapeXml(cw.justify)}"`;
-      if (cw.halign) attrs += ` halign="${escapeXml(cw.halign)}"`;
-      if (cw.valign) attrs += ` valign="${escapeXml(cw.valign)}"`;
-      if (cw.letterSpacing) attrs += ` letter-spacing="${escapeXml(cw.letterSpacing)}"`;
-      if (cw.xmlLang) attrs += ` xml:lang="${escapeXml(cw.xmlLang)}"`;
-      if (cw.xmlSpace) attrs += ` xml:space="${escapeXml(cw.xmlSpace)}"`;
-      lines.push(`${indent}${indent}<credit-words${attrs}>${escapeXml(cw.text)}</credit-words>`);
+      let attrs2 = "";
+      if (cw.defaultX !== void 0) attrs2 += ` default-x="${cw.defaultX}"`;
+      if (cw.defaultY !== void 0) attrs2 += ` default-y="${cw.defaultY}"`;
+      if (cw.fontSize) attrs2 += ` font-size="${escapeXml(cw.fontSize)}"`;
+      if (cw.fontWeight) attrs2 += ` font-weight="${escapeXml(cw.fontWeight)}"`;
+      if (cw.fontStyle) attrs2 += ` font-style="${escapeXml(cw.fontStyle)}"`;
+      if (cw.justify) attrs2 += ` justify="${escapeXml(cw.justify)}"`;
+      if (cw.halign) attrs2 += ` halign="${escapeXml(cw.halign)}"`;
+      if (cw.valign) attrs2 += ` valign="${escapeXml(cw.valign)}"`;
+      if (cw.letterSpacing) attrs2 += ` letter-spacing="${escapeXml(cw.letterSpacing)}"`;
+      if (cw.xmlLang) attrs2 += ` xml:lang="${escapeXml(cw.xmlLang)}"`;
+      if (cw.xmlSpace) attrs2 += ` xml:space="${escapeXml(cw.xmlSpace)}"`;
+      lines.push(`${indent}${indent}<credit-words${attrs2}>${escapeXml(cw.text)}</credit-words>`);
     }
   }
   lines.push(`${indent}</credit>`);
@@ -3693,6 +3695,7 @@ function serializePartGroup(group, indent) {
   const lines = [];
   let attrs = ` type="${group.groupType}"`;
   if (group.number !== void 0) attrs += ` number="${group.number}"`;
+  if (group._id) attrs += ` id="${escapeXml(group._id)}"`;
   lines.push(`${indent}<part-group${attrs}>`);
   if (group.groupName) {
     lines.push(`${indent}  <group-name>${escapeXml(group.groupName)}</group-name>`);
@@ -3733,6 +3736,7 @@ function serializePart(part, indent) {
 function serializeMeasure(measure, indent) {
   const lines = [];
   let attrs = ` number="${measure.number}"`;
+  if (measure._id) attrs += ` id="${escapeXml(measure._id)}"`;
   if (measure.width !== void 0) attrs += ` width="${measure.width}"`;
   if (measure.implicit) attrs += ` implicit="yes"`;
   lines.push(`${indent}<measure${attrs}>`);
@@ -3807,9 +3811,10 @@ function serializePrint(print, indent) {
   lines.push(`${indent}</print>`);
   return lines;
 }
-function serializeAttributes(attrs, indent) {
+function serializeAttributes(attrs, indent, id) {
   const lines = [];
-  lines.push(`${indent}<attributes>`);
+  const idAttr = id ? ` id="${escapeXml(id)}"` : "";
+  lines.push(`${indent}<attributes${idAttr}>`);
   if (attrs.divisions !== void 0) {
     lines.push(`${indent}  <divisions>${attrs.divisions}</divisions>`);
   }
@@ -3957,7 +3962,7 @@ function serializeEntry(entry, indent) {
     case "sound":
       return serializeSound(entry, indent);
     case "attributes":
-      return serializeAttributes(entry.attributes, indent);
+      return serializeAttributes(entry.attributes, indent, entry._id);
     default:
       return [];
   }
@@ -3965,6 +3970,7 @@ function serializeEntry(entry, indent) {
 function serializeNote(note, indent) {
   const lines = [];
   const noteAttrs = buildAttrs({
+    "id": note._id,
     "default-x": note.defaultX,
     "default-y": note.defaultY,
     "relative-x": note.relativeX,
@@ -4447,7 +4453,8 @@ function serializeBackup(backup, indent) {
 }
 function serializeForward(forward, indent) {
   const lines = [];
-  lines.push(`${indent}<forward>`);
+  const idAttr = forward._id ? ` id="${escapeXml(forward._id)}"` : "";
+  lines.push(`${indent}<forward${idAttr}>`);
   lines.push(`${indent}  <duration>${forward.duration}</duration>`);
   if (forward.voice !== void 0) {
     lines.push(`${indent}  <voice>${forward.voice}</voice>`);
@@ -4461,6 +4468,7 @@ function serializeForward(forward, indent) {
 function serializeDirection(direction, indent) {
   const lines = [];
   let attrs = "";
+  if (direction._id) attrs += ` id="${escapeXml(direction._id)}"`;
   if (direction.placement) attrs += ` placement="${direction.placement}"`;
   if (direction.directive) attrs += ' directive="yes"';
   if (direction.system) attrs += ` system="${direction.system}"`;
@@ -4722,7 +4730,9 @@ function serializeDirectionType(dirType, indent) {
 }
 function serializeBarline(barline, indent) {
   const lines = [];
-  lines.push(`${indent}<barline location="${barline.location}">`);
+  let attrs = ` location="${barline.location}"`;
+  if (barline._id) attrs += ` id="${escapeXml(barline._id)}"`;
+  lines.push(`${indent}<barline${attrs}>`);
   if (barline.barStyle) {
     lines.push(`${indent}  <bar-style>${barline.barStyle}</bar-style>`);
   }
@@ -4815,6 +4825,7 @@ function serializeMeasureStyle(ms, indent) {
 function serializeHarmony(harmony, indent) {
   const lines = [];
   const attrs = buildAttrs({
+    id: harmony._id,
     placement: harmony.placement,
     "print-frame": harmony.printFrame,
     "default-y": harmony.defaultY,
@@ -4892,6 +4903,7 @@ function serializeHarmony(harmony, indent) {
 function serializeFiguredBass(fb, indent) {
   const lines = [];
   let attrs = "";
+  if (fb._id) attrs += ` id="${escapeXml(fb._id)}"`;
   if (fb.parentheses) attrs += ' parentheses="yes"';
   lines.push(`${indent}<figured-bass${attrs}>`);
   for (const fig of fb.figures) {
@@ -4923,6 +4935,7 @@ function serializeFiguredBass(fb, indent) {
 function serializeSound(sound, indent) {
   const lines = [];
   const attrs = [];
+  if (sound._id) attrs.push(`id="${escapeXml(sound._id)}"`);
   if (sound.tempo !== void 0) attrs.push(`tempo="${sound.tempo}"`);
   if (sound.dynamics !== void 0) attrs.push(`dynamics="${sound.dynamics}"`);
   if (sound.dacapo) attrs.push('dacapo="yes"');
@@ -4954,7 +4967,7 @@ function serializeSound(sound, indent) {
     }
     lines.push(`${indent}  </swing>`);
     lines.push(`${indent}</sound>`);
-  } else if (attrs.length === 0) {
+  } else if (attrs.length === 0 && !sound._id) {
     lines.push(`${indent}<sound/>`);
   } else {
     lines.push(`${indent}<sound${attrStr}/>`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "musicxml-io",
-  "version": "0.2.8",
+  "version": "0.2.9",
   "description": "Parse and serialize MusicXML (.xml/.mxl) with high round-trip fidelity",
   "author": "tan-z-tan",
   "license": "MIT",