@libraz/libcantus 0.9.4 → 1.0.0

package/dist/{index-D6b6na69.d.cts → index-B4o55NDr.d.cts}

@@ -1,4 +1,4 @@
-import { d as ChordToneRole, C as Chord } from './index-y_ak9_Hi.cjs';
+import { j as ChordToneRole, c as ChordLike } from './index-C_8o--VE.cjs';
 
 /**
  * Harmonic role a pitch plays within a chord.
@@ -35,15 +35,19 @@ type VoicedRole = {
  * `'tension'` — including one that is simply foreign to the chord, which this
  * single-pitch query cannot tell from a colour tone. The root locks the chord
  * identity, the third locks its quality, and everything else is free voicing.
- * In a suspended chord (a chord whose intervals include a 4th (5) or 2nd (2)
- * but no third), the suspended tone takes the third's place as the
- * quality-defining tone and is locked to `quality`, since moving it changes the
- * chord. Detecting an octave doubling requires the surrounding voicing, which
- * this query does not carry, so `'doubling'` is part of the type — the shared
- * vocabulary of harmonic roles — but is never returned here.
+ * Where a chord has no third, the tone standing in its place — the fourth of a
+ * `sus4`, the second of a `sus2`, the eleventh of an eleventh chord — takes the
+ * third's slot and is locked to `quality`, since moving it changes the chord.
+ * At most one interval class of a chord is ever reported as its third, so a
+ * consumer reading `lock: 'quality'` as "this tone identifies the chord" gets
+ * one answer rather than two. Detecting an octave doubling requires the
+ * surrounding voicing, which this query does not carry, so `'doubling'` is part
+ * of the type — the shared vocabulary of harmonic roles — but is never returned
+ * here.
  *
  * @param pitch MIDI pitch or bare pitch class.
- * @param chord The chord providing the root reference.
+ * @param chord The chord providing the root reference, as a chord symbol, chord
+ *   data, or a `Chord`.
  * @param chordId Identifier stored on the result (defaults to 0).
  * @returns The pitch's role, lock level, and owning chord id.
  * @example
@@ -54,6 +58,6 @@ type VoicedRole = {
  * ```
  * @category Functional Harmony
  */
-declare function roleOf(pitch: number, chord: Chord, chordId?: number): VoicedRole;
+declare function roleOf(pitch: number, chord: ChordLike, chordId?: number): VoicedRole;
 
 export { type HarmonyRole as H, type LockLevel as L, type VoicedRole as V, roleOf as r };