@libraz/libcantus 1.0.1 → 1.2.0

package/dist/index.d.ts

@@ -1,17 +1,17 @@
-export { A as ARTICULATIONS, a as Articulation, B as BudgetExceededError, I as IntervalLike, b as IntervalQualityLabel, c as InvalidInputError, K as KeyName, d as KeyScale, L as LibcantusError, e as LibcantusErrorCode, N as NoSolutionError, f as NoteData, g as NoteEvent, h as NoteLike, i as NoteNameOptions, j as NoteNameSystem, P as ParseResult, S as SpelledInterval, k as detectNoteNameSystem, l as diatonicLetterOf, m as formatKeyName, n as formatNote, o as intervalSemitones, p as isLibcantusError, q as midiToNote, r as naturalPitchClassOf, s as noteToMidi, t as noteToPitchClass, u as parseInterval, v as parseKeyName, w as parseNote, x as pitchClassOf, y as spelledInterval, z as toNoteData, C as toSpelledInterval, D as transposeByInterval, E as transposeNote, F as tryParseInterval, G as tryParseKeyName, H as tryParseNote } from './index-B9MNZboQ.js';
-export { D as DurationData, I as IndexedNoteEvent, J as JUST_RATIOS, N as NOTE_VALUES, a as NoteEventIndex, b as NoteEventIndexOptions, c as NotePlacement, d as NoteValue, O as OnsetTieBreak, P as PlayabilityIssue, e as PlayabilityIssueType, f as PlayabilityLayer, g as PlayabilityReport, S as SpelledDuration, T as TWELVE_TET, h as TempoEvent, i as TempoMap, j as TuningTable, k as Tuplet, l as beatsToDuration, m as beatsToSeconds, n as beatsToTicks, o as beatsToTiedDurations, p as centsBetweenFreq, q as centsFromNearestStep, r as centsOfSteps, s as centsToRatio, t as createNoteEventIndex, u as durationToBeats, v as durationToSeconds, w as edo, x as frequencyOf, y as justDeviationCents, z as nearestStep, A as playability, B as ratioToCents, C as secondsToBeats, E as stepOf, F as stepsOfCents, G as tempoAt, H as ticksToBeats } from './index-G1uwGGWQ.js';
-export { I as InstrumentProfile, a as InstrumentProfileCommon, b as InstrumentProfileLike, L as LIMBS, c as Limb, P as PercussionProfile, d as PositionalRng, S as SeedPath, e as StringFingering, f as StringedProfile, g as canSound, h as createPositionalRng, i as deriveSeed, j as fingeringsFor, k as foldIntoRange, l as includeAt, m as instrumentRange } from './positional-Cptlj-xs.js';
+export { A as ARTICULATIONS, a as Articulation, B as BudgetExceededError, I as IntervalData, b as IntervalLike, c as IntervalQualityLabel, d as InvalidInputError, K as KeyName, e as KeyScale, L as LibcantusError, f as LibcantusErrorCode, N as NoSolutionError, g as NoteData, h as NoteEvent, i as NoteLike, j as NoteNameOptions, k as NoteNameSystem, P as ParseResult, S as SpelledInterval, l as detectNoteNameSystem, m as diatonicLetterOf, n as formatKeyName, o as formatNote, p as intervalSemitones, q as isLibcantusError, r as midiToNote, s as naturalPitchClassOf, t as noteToMidi, u as noteToPitchClass, v as parseInterval, w as parseKeyName, x as parseNote, y as pitchClassOf, z as spelledInterval, C as toNoteData, D as toSpelledInterval, E as transposeByInterval, F as transposeNote, G as tryParseInterval, H as tryParseKeyName, J as tryParseNote } from './index-Cy15oTvh.js';
+export { D as DurationData, I as IndexedNoteEvent, J as JUST_RATIOS, N as NOTE_VALUES, a as NoteEventIndex, b as NoteEventIndexOptions, c as NotePlacement, d as NoteValue, O as OnsetTieBreak, P as PlayabilityIssue, e as PlayabilityIssueType, f as PlayabilityLayer, g as PlayabilityReport, S as SpelledDuration, T as TWELVE_TET, h as TempoEvent, i as TempoMap, j as TuningTable, k as Tuplet, l as beatsToDuration, m as beatsToSeconds, n as beatsToTicks, o as beatsToTiedDurations, p as centsBetweenFreq, q as centsFromNearestStep, r as centsOfSteps, s as centsToRatio, t as createNoteEventIndex, u as durationToBeats, v as durationToSeconds, w as edo, x as frequencyOf, y as justDeviationCents, z as nearestStep, A as playability, B as ratioToCents, C as secondsToBeats, E as stepOf, F as stepsOfCents, G as tempoAt, H as ticksToBeats } from './index-9eoQs2C1.js';
+export { I as InstrumentProfile, a as InstrumentProfileCommon, b as InstrumentProfileLike, L as LIMBS, c as Limb, P as PercussionProfile, d as PositionalRng, S as SeedPath, e as StringFingering, f as StringedProfile, V as ValidatedPercussionProfile, g as ValidatedProfile, h as ValidatedStringedProfile, i as canSound, j as createPositionalRng, k as deriveSeed, l as fingeringsFor, m as foldIntoRange, n as includeAt, o as instrumentRange, t as toInstrumentProfile, p as toStringedProfile } from './positional-DJgs6ltD.js';
 export { ALGORITHM_VERSION, BASS_4_STRING, BASS_5_STRING, DEFAULT_GENERATION_BUDGET, GUITAR_DROP_D, GUITAR_STANDARD, MIN_ALGORITHM_VERSION, NoteEventAssertOptions, Rng, assertDegree, assertFiniteNumber, assertFiniteSemitones, assertGenerationBudget, assertInteger, assertMeterMap, assertMidiPitch, assertNoteEvent, assertNoteEvents, assertOneOf, assertPositiveInt, assertRange, assertTimeSignature, clampToMidi, createRng, dropSilentNotes, resolveAlgorithmVersion, soundingNotesOnly } from './core/index.js';
-export { B as BarPosition, M as MeterChange, a as MeterData, b as MeterLike, c as MeterMap, T as TimeSignature, d as barIndexAt, e as barPositionToBeat, f as barPositionToPulse, g as barStartBeat, h as beatToBarPosition, i as beatsPerBar, j as beatsPerBarAt, k as formatBarPosition, l as formatTimeSignature, m as isCompound, n as isStrongBeat, o as meterAt, p as metricWeight, q as parseTimeSignature, r as pulseBeats, s as pulsesPerBar, t as resolveMeters, u as toMeterData, v as tryParseTimeSignature, w as tuplet } from './index-Cj49F892.js';
-export { A as Alteration, a as AlteredDegree, C as ChordBase, b as ChordData, c as ChordLike, d as ChordQuality, e as ChordSegment, f as ChordSeventh, g as ChordSpan, h as ChordSpec, i as ChordSymbolOptions, j as ChordToneRole, E as EvaluateSafetyOptions, K as KeyLike, k as KeyRelation, N as NoteSafety, P as PROFILE_WEIGHTS, l as PitchSpelling, m as ProfileWeights, R as ReasonFlag, S as SafetyProfile, n as SafetyQuery, o as SafetyResult, p as SpelledKey, V as VoiceSnapshot, q as chordFromDegree, r as chordFromSpan, s as chordFromSpec, t as chordPitchClasses, u as chordQualities, v as chordSpecIntervals, w as chordSpecOf, x as chordSpecQuality, y as chordToneRole, z as diatonicSeventh, B as diatonicTriad, D as dominantKeyOf, F as enharmonicKeyOf, G as enumerateSafePitches, H as evaluateSafety, I as formatChordSymbol, J as intervalAboveRoot, L as isChordMember, M as keyRelationBetween, O as makeChord, Q as parallelKeyOf, T as parseChordSymbol, U as profileWeights, W as relatedKeysOf, X as relativeKeyOf, Y as spanFromChord, Z as spelledKeyOf, _ as subdominantKeyOf, $ as toChordData, a0 as toKeyScale, a1 as transposeChord, a2 as transposeChordSymbol, a3 as tryParseChordSymbol } from './index-szBv3496.js';
-export { FiguredBassRealization, FiguredBassSuspension, SpellingContext, classifySpelledInterval, createsBattuta, createsHiddenParallelPerfect, createsParallelOctave, createsParallelPerfect, createsParallelUnison, createsVerticalDissonance, createsVoiceCrossing, createsVoiceOverlap, diatonicPitchClasses, exceedsSpacing, figuredBassOf, figuredBassRealization, isAugmentedMelodicInterval, isForbiddenMelodicLeap, isLeadingToneResolution, isScaleTone, majorKey, minorKey, nearestScaleTone, nextVoicing, noteNames, pitchToScaleDegree, realizeFiguredBass, scaleByName, scaleTonesInDegreeOrder, spellChord, spellChordFromRoot, spellPitch, spellPitchClass, spellPitchClasses, spellScale, voiceLeadingCost } from './theory/index.js';
-export { A as ALTERED_MASK, B as BLUES_MASK, C as CHROMATIC_MASK, D as DORIAN_MASK, a as DOUBLE_HARMONIC_MASK, H as HARMONIC_MINOR_MASK, L as LOCRIAN_MASK, b as LOCRIAN_NATURAL2_MASK, c as LYDIAN_DOMINANT_MASK, d as LYDIAN_MASK, M as MAJOR_MASK, e as MAJOR_PENTATONIC_MASK, f as MARWA_MASK, g as MELODIC_MINOR_MASK, h as MINOR_PENTATONIC_MASK, i as MIXOLYDIAN_B13_MASK, j as MIXOLYDIAN_MASK, k as MIYAKO_BUSHI_MASK, N as NAMED_SCALES, l as NATURAL_MINOR_MASK, O as OCTATONIC_HALF_WHOLE_MASK, m as OCTATONIC_WHOLE_HALF_MASK, P as PHRYGIAN_DOMINANT_MASK, n as PHRYGIAN_MASK, o as PURVI_MASK, R as RITSU_MASK, p as RYUKYU_MASK, S as SCALE_ALIASES, q as ScaleAliasName, r as ScaleName, s as ScaleNameInput, T as TODI_MASK, W as WHOLE_TONE_MASK, t as WORLD_SCALES, u as WorldScaleName, v as maskFromOffsets, w as namedScaleMask, x as requireScaleMask, y as resolveScaleName } from './masks-DYbE485J.js';
-export { A as AvailableTensionsOptions, a as AvoidNoteUse, b as AvoidNotesOptions, C as ChordScaleMatch, c as ChordScaleReportEntry, K as KeyMode, P as PartWritingOptions, d as PartWritingViolation, e as PartWritingViolationKind, S as SATB_RANGES, f as SCALE_SYSTEMS, g as ScaleChoice, h as ScaleSystem, i as Species, j as SpeciesOptions, k as SpelledVoicing, l as StyledVoicingOptions, T as TRANSPOSING_INSTRUMENTS, m as TransposingInstrument, n as TransposingInstrumentName, V as VoiceIndependenceOptions, o as VoiceIndependenceReport, p as VoiceRange, q as VoicingOptions, r as VoicingStyle, s as availableTensions, t as avoidNotes, u as checkPartWriting, v as checkSpecies, w as chordScaleReport, x as chordScales, y as instrumentTransposition, z as keyFromFifths, B as keySignatureFifths, D as scaleMatchesChord, E as scaleSystemOf, F as scalesForChanges, G as spellVoicing, H as supportsFunctionalHarmony, I as toSoundingPitch, J as toWrittenPitch, L as voiceChord, M as voiceChordStyled, N as voiceIndependence, O as voiceProgression } from './index-9wcMhG73.js';
-export { A as ArrangementAnalysis, a as ArrangementOptions, b as ArrangementSession, c as ArrangementTrack, C as ChordMatch, d as Conflict, e as ContourDirection, D as DetectChordOptions, f as DetectKeyOptions, E as ExtractMotifsOptions, F as FormSection, g as FormSectionOptions, H as Hypermeter, h as HypermeterOptions, K as KeyMatch, i as KeyVariant, M as MODAL_SCALE_NAMES, j as MelodicComparison, k as MelodicContour, l as MelodicContourShape, m as MelodicPhrase, n as ModalCandidate, o as ModalScaleName, p as MotifData, q as MotifOccurrence, r as MotifRelation, s as MotifRelationKind, P as Phrase, t as PhraseOptions, u as PhraseSignal, R as ReduceProgressionOptions, v as ReducedChord, w as ReductionBasis, x as ReductionLevel, S as StructuralCadence, T as TensionPoint, y as TrackAnalysis, z as TrackEdit, B as TrackRole, G as analyzeArrangement, I as compareMelodies, J as createArrangementSession, L as detectChord, N as detectChordBest, O as detectKey, Q as detectKeyBest, U as detectKeyFromNotes, V as extractMotifs, W as hypermeter, X as melodicContour, Y as melodicSimilarity, Z as motifFromNotes, _ as phrasesFromTimeline, $ as reduceProgression, a0 as relateMotifs, a1 as sectionsFromNotes, a2 as structuralCadences, a3 as tensionCurve, a4 as tensionCurveFrom } from './index-D57QRbVn.js';
-export { AugmentedSixthKind, SpellLineOptions, augmentedSixthChord, augmentedSixthFromPitchClasses, augmentedSixthKind, spellAugmentedSixth, spellLine } from './analyze/index.js';
-export { A as AnalyzeChordOptions, a as AnalyzedNote, B as BorrowedSource, C as CadenceHit, b as CadenceResult, c as ChordAnalysis, d as ChordSegmentation, e as ChordTimeline, f as ChordTimelineOptions, g as ChordTimelineResult, h as ChordToRomanOptions, D as DetectCadenceOptions, E as ExplainRomanOptions, H as HarmonicFunction, I as IdentifiedVoiceNote, K as KeyContext, i as KeyProfileName, j as KeyProfilePair, k as KeyRegion, l as KeyTimelineOptions, P as PivotChord, R as RejectedCandidate, m as RomanExplanation, S as SuspensionFigure, T as TheoryLabel, V as VoiceNote, n as analyzeChord, o as analyzeVoice, p as borrowedSource, q as chordTimelineFromChords, r as chordTimelineFromNotes, s as chordToRoman, t as detectCadence, u as detectCadences, v as detectModulations, w as explainRoman, x as functionOf, y as isBorrowedChord, z as isDiatonic, F as isMinorKey, G as keyTimelineFromNotes, J as pivotChords, L as prevailingKeyOf, M as romanToChord, N as secondaryDominant, O as secondaryDominantOf, Q as toVoiceNotes } from './index-Chbst3Jx.js';
+export { B as BarPosition, M as MeterChange, a as MeterData, b as MeterLike, c as MeterMap, T as TimeSignature, d as barIndexAt, e as barPositionToBeat, f as barPositionToPulse, g as barStartBeat, h as beatToBarPosition, i as beatsPerBar, j as beatsPerBarAt, k as formatBarPosition, l as formatTimeSignature, m as isCompound, n as isStrongBeat, o as meterAt, p as metricWeight, q as parseTimeSignature, r as pulseBeats, s as pulsesPerBar, t as resolveMeters, u as toMeterData, v as tryParseTimeSignature, w as tuplet } from './index-CL4b4gUQ.js';
+export { A as Alteration, a as AlteredDegree, C as ChordBase, b as ChordData, c as ChordLike, d as ChordQuality, e as ChordSegment, f as ChordSeventh, g as ChordSpan, h as ChordSpec, i as ChordToneRole, E as EvaluateSafetyOptions, K as KeyLike, j as KeyRelation, k as KeyVariant, N as NoteSafety, P as PROFILE_WEIGHTS, l as PitchSpelling, m as ProfileWeights, R as ReasonFlag, n as ResolvedKey, S as SafetyPartner, o as SafetyProfile, p as SafetyQuery, q as SafetyResult, r as SpelledKeyLike, s as SpelledKeyScale, V as VoiceSnapshot, t as chordFromDegree, u as chordFromSpan, v as chordFromSpec, w as chordPitchClasses, x as chordQualities, y as chordSpecIntervals, z as chordSpecOf, B as chordSpecQuality, D as chordToneRole, F as diatonicSeventh, G as diatonicTriad, H as dominantKeyOf, I as enharmonicKeyOf, J as enumerateSafePitches, L as evaluateSafety, M as intervalAboveRoot, O as isChordMember, Q as keyRelationBetween, T as makeChord, U as parallelKeyOf, W as profileWeights, X as relatedKeysOf, Y as relativeKeyOf, Z as spanFromChord, _ as spelledKeyOf, $ as subdominantKeyOf, a0 as toChordData, a1 as toKeyScale, a2 as transposeChord } from './coerce-DP0vYu-x.js';
+export { FiguredBassRealization, FiguredBassSuspension, HiddenParallelReading, ScaleLadderPosition, SpellingContext, classifySpelledInterval, createsBattuta, createsHiddenParallelPerfect, createsParallelOctave, createsParallelPerfect, createsParallelUnison, createsVerticalDissonance, createsVoiceCrossing, createsVoiceOverlap, diatonicPitchClasses, exceedsSpacing, figuredBassOf, figuredBassRealization, isAugmentedMelodicInterval, isForbiddenMelodicLeap, isLeadingToneResolution, isScaleTone, majorKey, minorKey, nearestScaleTone, nextVoicing, noteNames, pitchToScaleDegree, realizeFiguredBass, resolveKey, scaleByName, scaleLadderPitch, scaleLadderPosition, scaleOf, scaleTonesInDegreeOrder, shiftByScaleDegrees, spellChord, spellChordFromRoot, spellPitch, spellPitchClass, spellPitchClasses, spellScale, tryResolveKeyName, voiceLeadingCost } from './theory/index.js';
+export { A as ALTERED_MASK, B as BLUES_MASK, C as CHROMATIC_MASK, D as DORIAN_MASK, a as DOUBLE_HARMONIC_MASK, H as HARMONIC_MINOR_MASK, L as LOCRIAN_MASK, b as LOCRIAN_NATURAL2_MASK, c as LYDIAN_DOMINANT_MASK, d as LYDIAN_MASK, M as MAJOR_MASK, e as MAJOR_PENTATONIC_MASK, f as MARWA_MASK, g as MELODIC_MINOR_MASK, h as MINOR_PENTATONIC_MASK, i as MIXOLYDIAN_B13_MASK, j as MIXOLYDIAN_MASK, k as MIYAKO_BUSHI_MASK, N as NAMED_SCALES, l as NATURAL_MINOR_MASK, O as OCTATONIC_HALF_WHOLE_MASK, m as OCTATONIC_WHOLE_HALF_MASK, P as PHRYGIAN_DOMINANT_MASK, n as PHRYGIAN_MASK, o as PURVI_MASK, R as RITSU_MASK, p as RYUKYU_MASK, S as SCALE_ALIASES, q as ScaleAliasName, r as ScaleName, s as ScaleNameInput, T as TODI_MASK, W as WHOLE_TONE_MASK, t as WORLD_SCALES, u as WorldScaleName, v as assertKeyVariant, w as assertModeMask, x as maskFromOffsets, y as namedScaleMask, z as requireScaleMask, E as resolveScaleName, F as variantOfMask } from './masks-Cc7-MzzY.js';
+export { A as AvailableTensionsOptions, a as AvoidNoteUse, b as AvoidNotesOptions, C as ChordScaleMatch, c as ChordScaleReportEntry, d as ChordSymbolOptions, K as KeyMode, P as PartWritingOptions, e as PartWritingViolation, f as PartWritingViolationKind, S as SATB_RANGES, g as SCALE_SYSTEMS, h as ScaleChoice, i as ScaleSystem, j as Species, k as SpeciesOptions, l as SpelledVoicing, m as StyledVoicingOptions, T as TRANSPOSING_INSTRUMENTS, n as TransposingInstrument, o as TransposingInstrumentName, V as VoiceIndependenceOptions, p as VoiceIndependenceReport, q as VoiceRange, r as VoicingOptions, s as VoicingStyle, t as availableTensions, u as avoidNotes, v as checkPartWriting, w as checkSpecies, x as chordScaleReport, y as chordScales, z as formatChordSymbol, B as instrumentTransposition, D as isSignatureKey, E as keyFromFifths, F as keySignatureFifths, G as parseChordSymbol, H as scaleMatchesChord, I as scaleSystemOf, J as scalesForChanges, L as spellVoicing, M as supportsFunctionalHarmony, N as toSoundingPitch, O as toWrittenPitch, Q as transposeChordSymbol, R as tryParseChordSymbol, U as voiceChord, W as voiceChordStyled, X as voiceIndependence, Y as voiceProgression } from './index-BHIUyjhZ.js';
+export { A as AnalyzeChordOptions, a as AnalyzedNote, B as BorrowedSource, C as CadenceHit, b as CadenceResult, c as ChordAnalysis, d as ChordSegmentation, e as ChordTimeline, f as ChordTimelineOptions, g as ChordTimelineResult, h as ChordToRomanOptions, D as DetectCadenceOptions, E as ExplainRomanOptions, H as HarmonicFunction, I as IdentifiedVoiceNote, K as KeyContext, i as KeyProfileName, j as KeyProfilePair, k as KeyRegion, l as KeyTimelineOptions, P as PivotChord, R as RejectedCandidate, m as RomanExplanation, S as SuspensionFigure, T as TheoryLabel, V as VoiceNote, n as analyzeChord, o as analyzeVoice, p as assertChordTimeline, q as borrowedSource, r as chordTimelineFromChords, s as chordTimelineFromNotes, t as chordToRoman, u as detectCadence, v as detectCadences, w as detectModulations, x as explainRoman, y as functionOf, z as isBorrowedChord, F as isDiatonic, G as isMinorKey, J as keyTimelineFromNotes, L as pivotChords, M as prevailingKeyOf, N as romanToChord, O as secondaryDominant, Q as secondaryDominantOf, U as toVoiceNotes } from './index-CJBBiAmU.js';
+export { A as ArrangementAnalysis, a as ArrangementOptions, b as ArrangementSession, c as ArrangementTrack, d as AugmentedSixthKind, C as ChordMatch, e as Conflict, f as ConflictPartner, g as ContourDirection, D as DetectChordOptions, h as DetectKeyOptions, E as ExtractMotifsOptions, F as FormSection, i as FormSectionOptions, H as Hypermeter, j as HypermeterOptions, K as KeyMatch, M as MODAL_SCALE_NAMES, k as MelodicContour, l as MelodicContourShape, m as MelodicPhrase, n as ModalCandidate, o as ModalScaleName, p as MotifData, q as MotifOccurrence, r as MotifRelation, s as MotifRelationKind, P as Phrase, t as PhraseOptions, u as PhraseSignal, R as ReduceProgressionOptions, v as ReducedChord, w as ReductionBasis, x as ReductionLevel, S as StructuralCadence, T as TensionPoint, y as TrackAnalysis, z as TrackEdit, B as TrackRole, G as analyzeArrangement, I as analyzePolyphony, J as augmentedSixthChord, L as augmentedSixthFromPitchClasses, N as augmentedSixthKind, O as createArrangementSession, Q as detectChord, U as detectChordBest, V as detectKey, W as detectKeyBest, X as detectKeyFromNotes, Y as extractMotifs, Z as hypermeter, _ as melodicContour, $ as motifFromNotes, a0 as phrasesFromTimeline, a1 as reduceProgression, a2 as relateMotifs, a3 as sectionsFromNotes, a4 as spellAugmentedSixth, a5 as structuralCadences, a6 as tensionCurve, a7 as tensionCurveFrom } from './index-BRMbPkHE.js';
+export { MelodicComparison, SpellLineOptions, compareMelodies, melodicSimilarity, spellLine } from './analyze/index.js';
 export { C as ConsonanceClass, c as classifyInterval, i as isConsonantInterval, a as isPerfectInterval } from './index-DInQqT8Q.js';
-export { H as HarmonyRole, L as LockLevel, V as VoicedRole, r as roleOf } from './index-CunYKLiu.js';
-export { B as BAR_STEPS, a as BASS_STYLES, b as BEAT_STEPS, c as BORROWED_DEGREES, d as BassLineOptions, e as BassSegment, f as BassStyle, g as BorrowedChord, C as Complexity, h as CounterMelodyOptions, D as DRUM_NOTES, i as DeformOptions, j as Draw, k as DrumHit, l as DrumRole, m as DrumStyle, n as DrumVoice, o as DrumsOptions, E as EuclideanKick, G as GENRES, p as GenerationContext, q as GenerationContextInput, r as Genre, s as GridEvent, t as GrooveFeel, u as GrooveSlot, v as GrooveStyle, w as GrooveTemplate, H as HarmonizeOptions, x as HarmonizePlacement, y as HarmonizeResult, z as HumanizeOptions, M as MelodyNote, A as MotifCell, F as MotifContour, I as MotifNote, J as MotifOptions, K as MotifTransform, O as ORNAMENT_STYLES, L as OrnamentOptions, N as OrnamentStyle, P as PROVENANCE_BASES, Q as ProgFunction, R as ProgStyle, S as ProgressionDegree, T as ProgressionOptions, U as ProgressionPreset, V as Provenance, W as ProvenanceBasis, X as ResolvedContext, Y as RhythmEvent, Z as RhythmOptions, _ as STEP_BEATS, $ as Section, a0 as SubstituteOptions, a1 as Substitution, a2 as SubstitutionType, a3 as Vocabulary, a4 as VocabularyQuery, a5 as applyGrooveTemplate, a6 as assertVocabulary, a7 as deform, a8 as developMotif, a9 as double, aa as doubleTime, ab as drumVoiceOf, ac as extractGrooveTemplate, ad as fitsQuery, ae as generateBassLine, af as generateCounterMelody, ag as generateDrums, ah as generateMotif, ai as generateProgression, aj as generateRhythm, ak as gridMetricWeight, al as halfTime, am as harmonizeMelody, an as humanize, ao as mergeVocabulary, ap as modalInterchangePalette, aq as motifToNoteEvents, ar as negativeHarmonyMirror, as as onsetWeightCurve, at as ornament, au as ornamentBy, av as pickProgressionPreset, aw as pickVocabulary, ax as progressions, ay as progressionsByStyle, az as resolveContext, aA as rhythmDensity, aB as rhythmToNoteEvents, aC as selectVocabulary, aD as substituteChord, aE as syncopate, aF as thin, aG as transformMotif, aH as vocabularyOfKind, aI as withinCeiling } from './index-CgHqxdps.js';
+export { H as HarmonyRole, L as LockLevel, V as VoicedRole, r as roleOf } from './index-Dw2DP7vm.js';
+export { B as BAR_STEPS, a as BASS_STYLES, b as BEAT_STEPS, c as BORROWED_DEGREES, d as BassLineOptions, e as BassSegment, f as BassStyle, g as BorrowedChord, C as Complexity, h as CounterMelodyOptions, D as DRUM_NOTES, i as DeformOptions, j as Draw, k as DrumHit, l as DrumRole, m as DrumStyle, n as DrumVoice, o as DrumsOptions, E as EuclideanKick, G as GENRES, p as GenerationContext, q as GenerationContextInput, r as Genre, s as GridEvent, t as GrooveFeel, u as GrooveSlot, v as GrooveStyle, w as GrooveTemplate, H as HarmonizeOptions, x as HarmonizePlacement, y as HarmonizeResult, z as HumanizeOptions, M as MelodyNote, A as MotifCell, F as MotifContour, I as MotifNote, J as MotifOptions, K as MotifTransform, O as ORNAMENT_STYLES, L as OrnamentOptions, N as OrnamentStyle, P as PROVENANCE_BASES, Q as ProgFunction, R as ProgStyle, S as ProgressionDegree, T as ProgressionOptions, U as ProgressionPreset, V as Provenance, W as ProvenanceBasis, X as ResolvedContext, Y as RhythmEvent, Z as RhythmOptions, _ as STEP_BEATS, $ as Section, a0 as SubstituteOptions, a1 as Substitution, a2 as SubstitutionType, a3 as SyncopateOptions, a4 as Vocabulary, a5 as VocabularyQuery, a6 as applyGrooveTemplate, a7 as assertVocabulary, a8 as deform, a9 as developMotif, aa as double, ab as doubleTime, ac as drumVoiceOf, ad as extractGrooveTemplate, ae as fitsQuery, af as generateBassLine, ag as generateCounterMelody, ah as generateDrums, ai as generateMotif, aj as generateProgression, ak as generateRhythm, al as gridMetricWeight, am as halfTime, an as humanize, ao as mergeVocabulary, ap as modalInterchangePalette, aq as motifToNoteEvents, ar as negativeHarmonyMirror, as as onsetWeightCurve, at as ornament, au as ornamentBy, av as pickProgressionPreset, aw as pickVocabulary, ax as progressions, ay as progressionsByStyle, az as resolveContext, aA as rhythmDensity, aB as rhythmToNoteEvents, aC as selectVocabulary, aD as substituteChord, aE as syncopate, aF as thin, aG as transformMotif, aH as vocabularyOfKind, aI as withinCeiling } from './index-BJgP97N1.js';
+export { BASS_LICKS, BassLick, ClassifiedMelodyTone, DRUM_KIT, DRUM_PATTERNS, DrumPattern, DrumPatternOptions, DrumStroke, DrumVocabulary, FILL_ARCHETYPES, FILL_TYPES, FillArchetype, FillStroke, FillType, FillVelocity, ImitationAnswer, ImitationOptions, KICK_FIGURES, KICK_STEPS, KickFigure, KickPattern, KickSlot, LickMaterial, LickNote, MAX_DIFFICULTY, MIN_DIFFICULTY, MelodyToneRole, PlaceLicksOptions, classifyMelodyTones, harmonizeMelody, imitate, isDrumPattern, isFillArchetype, isLickMaterial, placeDrumPattern, placeLicks, sustainsShift, sustainsStrokes } from './generate/index.js';
 export { Arrangement, ArrangementData, ArrangementSettings, ArrangementSetup, ArrangementTensionOptions, BassLineSettings, Chord, Composer, ComposerOptions, CounterMelodySettings, DetectedKeyMatch, Duration, HarmonizedMelody, Instrument, Interval, Key, KeyData, Meter, Motif, MotifGenerateOptions, Note, Progression, ProgressionData, Rhythm, RhythmData, RhythmDeformOptions, Score, ScoreData, ScoreOptions, Tempo, TempoData, Timeline, TimelineData, TimelineRoman, Tuning, Voicing, VoicingData, VoicingIndependenceOptions, VoicingSafetyQuery } from './model/index.js';
-export { BASS_LICKS, BassLick, ClassifiedMelodyTone, DRUM_KIT, DRUM_PATTERNS, DrumPattern, DrumPatternOptions, DrumStroke, DrumVocabulary, FILL_ARCHETYPES, FILL_TYPES, FillArchetype, FillStroke, FillType, FillVelocity, ImitationAnswer, ImitationOptions, KICK_FIGURES, KICK_STEPS, KickFigure, KickPattern, KickSlot, LickMaterial, LickNote, MAX_DIFFICULTY, MIN_DIFFICULTY, MelodyToneRole, PlaceLicksOptions, classifyMelodyTones, imitate, isDrumPattern, isFillArchetype, isLickMaterial, placeDrumPattern, placeLicks, sustainsShift, sustainsStrokes } from './generate/index.js';

package/dist/index.js

@@ -1,6 +1,6 @@
 import {
   spellLine
-} from "./chunk-TTCLJX6D.js";
+} from "./chunk-NFJ4P6ZZ.js";
 import "./chunk-QYQQ5J6E.js";
 import {
   Arrangement,
@@ -20,32 +20,25 @@ import {
   Timeline,
   Tuning,
   Voicing
-} from "./chunk-PKFNUHDY.js";
+} from "./chunk-FBH75DAY.js";
 import {
   analyzeArrangement,
-  analyzeVoice,
-  chordTimelineFromChords,
-  chordTimelineFromNotes,
+  analyzePolyphony,
   compareMelodies,
   createArrangementSession,
-  detectCadences,
-  detectModulations,
   extractMotifs,
   hypermeter,
-  keyTimelineFromNotes,
   melodicContour,
   melodicSimilarity,
   motifFromNotes,
   phrasesFromTimeline,
-  prevailingKeyOf,
   reduceProgression,
   relateMotifs,
   sectionsFromNotes,
   structuralCadences,
   tensionCurve,
-  tensionCurveFrom,
-  toVoiceNotes
-} from "./chunk-2LCPM3EG.js";
+  tensionCurveFrom
+} from "./chunk-HYJJ2V2I.js";
 import {
   JUST_RATIOS,
   NOTE_VALUES,
@@ -70,7 +63,7 @@ import {
   stepsOfCents,
   tempoAt,
   ticksToBeats
-} from "./chunk-YH3BIKHH.js";
+} from "./chunk-UMWZ4ZET.js";
 import {
   BAR_STEPS,
   BASS_LICKS,
@@ -139,35 +132,43 @@ import {
   transformMotif,
   vocabularyOfKind,
   withinCeiling
-} from "./chunk-VOHZB45S.js";
+} from "./chunk-Q6LFSAKV.js";
 import {
   MODAL_SCALE_NAMES,
   analyzeChord,
+  analyzeVoice,
+  assertChordTimeline,
   augmentedSixthChord,
   augmentedSixthFromPitchClasses,
   augmentedSixthKind,
   borrowedSource,
+  chordTimelineFromChords,
+  chordTimelineFromNotes,
   chordToRoman,
   detectCadence,
+  detectCadences,
   detectChord,
   detectChordBest,
   detectKey,
   detectKeyBest,
   detectKeyFromNotes,
+  detectModulations,
   explainRoman,
   functionOf,
   isBorrowedChord,
   isDiatonic,
   isMinorKey,
+  keyTimelineFromNotes,
   pivotChords,
+  prevailingKeyOf,
   romanToChord,
   secondaryDominant,
   secondaryDominantOf,
-  spellAugmentedSixth
-} from "./chunk-H42UHPYW.js";
+  spellAugmentedSixth,
+  toVoiceNotes
+} from "./chunk-H2KJHBW4.js";
 import {
   ALGORITHM_VERSION,
-  ARTICULATIONS,
   BASS_4_STRING,
   BASS_5_STRING,
   GUITAR_DROP_D,
@@ -183,48 +184,24 @@ import {
   includeAt,
   instrumentRange,
   playability,
-  resolveAlgorithmVersion
-} from "./chunk-FVSI36UV.js";
+  resolveAlgorithmVersion,
+  toInstrumentProfile,
+  toStringedProfile
+} from "./chunk-7KG3RTYS.js";
 import {
-  barIndexAt,
-  barPositionToBeat,
-  barPositionToPulse,
-  barStartBeat,
-  beatToBarPosition,
-  beatsPerBar,
-  beatsPerBarAt,
-  createNoteEventIndex,
-  formatBarPosition,
-  formatTimeSignature,
-  isCompound,
-  isStrongBeat,
-  meterAt,
-  metricWeight,
-  parseTimeSignature,
-  pulseBeats,
-  pulsesPerBar,
-  resolveMeters,
-  toMeterData,
-  tryParseTimeSignature,
-  tuplet
-} from "./chunk-ELCTZUJJ.js";
-import "./chunk-HFPS7JFD.js";
+  createNoteEventIndex
+} from "./chunk-PUKJP2Z5.js";
+import "./chunk-K6OZXIR6.js";
 import {
   SATB_RANGES,
   TRANSPOSING_INSTRUMENTS,
-  availableTensions,
-  avoidNotes,
   checkPartWriting,
   checkSpecies,
-  chordScaleReport,
-  chordScales,
   figuredBassOf,
   figuredBassRealization,
   instrumentTransposition,
   nextVoicing,
   realizeFiguredBass,
-  scaleMatchesChord,
-  scalesForChanges,
   spellVoicing,
   toSoundingPitch,
   toWrittenPitch,
@@ -232,10 +209,16 @@ import {
   voiceChordStyled,
   voiceLeadingCost,
   voiceProgression
-} from "./chunk-H3VORETI.js";
+} from "./chunk-M5RYMAFI.js";
 import {
-  roleOf
-} from "./chunk-KNJEKLKV.js";
+  availableTensions,
+  avoidNotes,
+  chordScaleReport,
+  chordScales,
+  roleOf,
+  scaleMatchesChord,
+  scalesForChanges
+} from "./chunk-NB25P3EH.js";
 import {
   ALTERED_MASK,
   BLUES_MASK,
@@ -272,6 +255,8 @@ import {
   TODI_MASK,
   WHOLE_TONE_MASK,
   WORLD_SCALES,
+  assertKeyVariant,
+  assertModeMask,
   chordFromDegree,
   chordFromSpan,
   chordFromSpec,
@@ -305,6 +290,7 @@ import {
   isForbiddenMelodicLeap,
   isLeadingToneResolution,
   isScaleTone,
+  isSignatureKey,
   keyFromFifths,
   keyRelationBetween,
   keySignatureFifths,
@@ -322,10 +308,15 @@ import {
   relatedKeysOf,
   relativeKeyOf,
   requireScaleMask,
+  resolveKey,
   resolveScaleName,
   scaleByName,
+  scaleLadderPitch,
+  scaleLadderPosition,
+  scaleOf,
   scaleSystemOf,
   scaleTonesInDegreeOrder,
+  shiftByScaleDegrees,
   spanFromChord,
   spellChord,
   spellChordFromRoot,
@@ -341,9 +332,12 @@ import {
   transposeChord,
   transposeChordSymbol,
   tryParseChordSymbol,
+  tryResolveKeyName,
+  variantOfMask,
   voiceIndependence
-} from "./chunk-INHVXP6Z.js";
+} from "./chunk-RFIBF2RR.js";
 import {
+  ARTICULATIONS,
   BudgetExceededError,
   ConsonanceClass,
   DEFAULT_GENERATION_BUDGET,
@@ -362,17 +356,30 @@ import {
   assertPositiveInt,
   assertRange,
   assertTimeSignature,
+  barIndexAt,
+  barPositionToBeat,
+  barPositionToPulse,
+  barStartBeat,
+  beatToBarPosition,
+  beatsPerBar,
+  beatsPerBarAt,
   clampToMidi,
   classifyInterval,
   detectNoteNameSystem,
   diatonicLetterOf,
   dropSilentNotes,
+  formatBarPosition,
   formatKeyName,
   formatNote,
+  formatTimeSignature,
   intervalSemitones,
+  isCompound,
   isConsonantInterval,
   isLibcantusError,
   isPerfectInterval,
+  isStrongBeat,
+  meterAt,
+  metricWeight,
   midiToNote,
   naturalPitchClassOf,
   noteToMidi,
@@ -380,17 +387,24 @@ import {
   parseInterval,
   parseKeyName,
   parseNote,
+  parseTimeSignature,
   pitchClassOf,
+  pulseBeats,
+  pulsesPerBar,
+  resolveMeters,
   soundingNotesOnly,
   spelledInterval,
+  toMeterData,
   toNoteData,
   toSpelledInterval,
   transposeByInterval,
   transposeNote,
   tryParseInterval,
   tryParseKeyName,
-  tryParseNote
-} from "./chunk-VTI6FOLB.js";
+  tryParseNote,
+  tryParseTimeSignature,
+  tuplet
+} from "./chunk-AGOVW7U6.js";
 export {
   ALGORITHM_VERSION,
   ALTERED_MASK,
@@ -483,15 +497,19 @@ export {
   WORLD_SCALES,
   analyzeArrangement,
   analyzeChord,
+  analyzePolyphony,
   analyzeVoice,
   applyGrooveTemplate,
+  assertChordTimeline,
   assertDegree,
   assertFiniteNumber,
   assertFiniteSemitones,
   assertGenerationBudget,
   assertInteger,
+  assertKeyVariant,
   assertMeterMap,
   assertMidiPitch,
+  assertModeMask,
   assertNoteEvent,
   assertNoteEvents,
   assertOneOf,
@@ -629,6 +647,7 @@ export {
   isMinorKey,
   isPerfectInterval,
   isScaleTone,
+  isSignatureKey,
   isStrongBeat,
   justDeviationCents,
   keyFromFifths,
@@ -690,6 +709,7 @@ export {
   requireScaleMask,
   resolveAlgorithmVersion,
   resolveContext,
+  resolveKey,
   resolveMeters,
   resolveScaleName,
   rhythmDensity,
@@ -697,7 +717,10 @@ export {
   roleOf,
   romanToChord,
   scaleByName,
+  scaleLadderPitch,
+  scaleLadderPosition,
   scaleMatchesChord,
+  scaleOf,
   scaleSystemOf,
   scaleTonesInDegreeOrder,
   scalesForChanges,
@@ -706,6 +729,7 @@ export {
   secondsToBeats,
   sectionsFromNotes,
   selectVocabulary,
+  shiftByScaleDegrees,
   soundingNotesOnly,
   spanFromChord,
   spellAugmentedSixth,
@@ -734,11 +758,13 @@ export {
   thin,
   ticksToBeats,
   toChordData,
+  toInstrumentProfile,
   toKeyScale,
   toMeterData,
   toNoteData,
   toSoundingPitch,
   toSpelledInterval,
+  toStringedProfile,
   toVoiceNotes,
   toWrittenPitch,
   transformMotif,
@@ -751,7 +777,9 @@ export {
   tryParseKeyName,
   tryParseNote,
   tryParseTimeSignature,
+  tryResolveKeyName,
   tuplet,
+  variantOfMask,
   vocabularyOfKind,
   voiceChord,
   voiceChordStyled,

package/dist/{masks-DYbE485J.d.cts → masks-Cc7-MzzY.d.ts}

@@ -1,3 +1,5 @@
+import { k as KeyVariant } from './coerce-DP0vYu-x.js';
+
 /**
  * Build a 12-bit mode mask from a list of semitone offsets above the root.
  *
@@ -103,6 +105,28 @@ declare const OCTATONIC_WHOLE_HALF_MASK: number;
  * @category Scales
  */
 declare const CHROMATIC_MASK = 4095;
+/**
+ * Require a twelve-bit mode mask, and return it.
+ *
+ * A mask is read with bit operations, and those coerce: a `null` reads as the
+ * empty mask, an object as zero. Every answer taken from a mask is a musical
+ * claim — which form a key stands in, whether its signature is its own, which
+ * system it belongs to — so a value that is not a mask has to be refused rather
+ * than answered, and it is refused in one place so the answers cannot disagree
+ * about what a mask is.
+ *
+ * @param modeMask12 The value to check.
+ * @param name What the value is, for the error message.
+ * @returns The mask.
+ * @throws If it is not an integer in [1, {@link CHROMATIC_MASK}].
+ * @example
+ * ```ts
+ * import { assertModeMask, MAJOR_MASK } from '@libraz/libcantus';
+ * assertModeMask(MAJOR_MASK); // 2741
+ * ```
+ * @category Scales
+ */
+declare function assertModeMask(modeMask12: number, name?: string): number;
 /**
  * Lydian dominant (melodic minor's fourth mode): offsets {0,2,4,6,7,9,10}.
  *
@@ -168,7 +192,7 @@ declare const MIYAKO_BUSHI_MASK: number;
  *
  * Two ritsu tetrachords a fourth apart: the middle note sits a whole tone above
  * the lower nuclear tone. The result is the same five pitch classes as the
- * major pentatonic a fourth below, which is why the mask alone cannot say which
+ * major pentatonic a fourth above, which is why the mask alone cannot say which
  * tradition is meant.
  *
  * @category Scales
@@ -441,5 +465,28 @@ declare function namedScaleMask(name: ScaleNameInput): number | undefined;
  * @category Scales
  */
 declare function requireScaleMask(name: ScaleNameInput, label?: string): number;
+/**
+ * The form a mask stands in, when it stands in one.
+ *
+ * A bare scale still names its form — a major mask is a major key whoever built
+ * it — so the form is read from the mask rather than defaulted away. Only a
+ * mask matching none of the four is modal.
+ */
+declare function variantOfMask(modeMask12: number): KeyVariant;
+/**
+ * Refuse a scale form the key's own mask does not hold.
+ *
+ * A key whose variant says `'harmonic'` over a major mask prints as a harmonic
+ * minor while comparing equal to plain C major, so a project file that carried
+ * the two apart is refused where the mismatch is still an argument. Kept beside
+ * the type it validates: the pairing of form and mask is written once, and
+ * every construction path reads that one.
+ *
+ * @param variant The form claimed for the key.
+ * @param modeMask12 The mask the key actually holds.
+ * @throws If the form is not one a key may stand in, or the mask does not hold it.
+ * @category Scales
+ */
+declare function assertKeyVariant(variant: KeyVariant, modeMask12: number): void;
 
-export { ALTERED_MASK as A, BLUES_MASK as B, CHROMATIC_MASK as C, DORIAN_MASK as D, HARMONIC_MINOR_MASK as H, LOCRIAN_MASK as L, MAJOR_MASK as M, NAMED_SCALES as N, OCTATONIC_HALF_WHOLE_MASK as O, PHRYGIAN_DOMINANT_MASK as P, RITSU_MASK as R, SCALE_ALIASES as S, TODI_MASK as T, WHOLE_TONE_MASK as W, DOUBLE_HARMONIC_MASK as a, LOCRIAN_NATURAL2_MASK as b, LYDIAN_DOMINANT_MASK as c, LYDIAN_MASK as d, MAJOR_PENTATONIC_MASK as e, MARWA_MASK as f, MELODIC_MINOR_MASK as g, MINOR_PENTATONIC_MASK as h, MIXOLYDIAN_B13_MASK as i, MIXOLYDIAN_MASK as j, MIYAKO_BUSHI_MASK as k, NATURAL_MINOR_MASK as l, OCTATONIC_WHOLE_HALF_MASK as m, PHRYGIAN_MASK as n, PURVI_MASK as o, RYUKYU_MASK as p, type ScaleAliasName as q, type ScaleName as r, type ScaleNameInput as s, WORLD_SCALES as t, type WorldScaleName as u, maskFromOffsets as v, namedScaleMask as w, requireScaleMask as x, resolveScaleName as y };
+export { ALTERED_MASK as A, BLUES_MASK as B, CHROMATIC_MASK as C, DORIAN_MASK as D, resolveScaleName as E, variantOfMask as F, HARMONIC_MINOR_MASK as H, LOCRIAN_MASK as L, MAJOR_MASK as M, NAMED_SCALES as N, OCTATONIC_HALF_WHOLE_MASK as O, PHRYGIAN_DOMINANT_MASK as P, RITSU_MASK as R, SCALE_ALIASES as S, TODI_MASK as T, WHOLE_TONE_MASK as W, DOUBLE_HARMONIC_MASK as a, LOCRIAN_NATURAL2_MASK as b, LYDIAN_DOMINANT_MASK as c, LYDIAN_MASK as d, MAJOR_PENTATONIC_MASK as e, MARWA_MASK as f, MELODIC_MINOR_MASK as g, MINOR_PENTATONIC_MASK as h, MIXOLYDIAN_B13_MASK as i, MIXOLYDIAN_MASK as j, MIYAKO_BUSHI_MASK as k, NATURAL_MINOR_MASK as l, OCTATONIC_WHOLE_HALF_MASK as m, PHRYGIAN_MASK as n, PURVI_MASK as o, RYUKYU_MASK as p, type ScaleAliasName as q, type ScaleName as r, type ScaleNameInput as s, WORLD_SCALES as t, type WorldScaleName as u, assertKeyVariant as v, assertModeMask as w, maskFromOffsets as x, namedScaleMask as y, requireScaleMask as z };

package/dist/{masks-DYbE485J.d.ts → masks-pADfTOiD.d.cts}

@@ -1,3 +1,5 @@
+import { k as KeyVariant } from './coerce-DRERzdve.cjs';
+
 /**
  * Build a 12-bit mode mask from a list of semitone offsets above the root.
  *
@@ -103,6 +105,28 @@ declare const OCTATONIC_WHOLE_HALF_MASK: number;
  * @category Scales
  */
 declare const CHROMATIC_MASK = 4095;
+/**
+ * Require a twelve-bit mode mask, and return it.
+ *
+ * A mask is read with bit operations, and those coerce: a `null` reads as the
+ * empty mask, an object as zero. Every answer taken from a mask is a musical
+ * claim — which form a key stands in, whether its signature is its own, which
+ * system it belongs to — so a value that is not a mask has to be refused rather
+ * than answered, and it is refused in one place so the answers cannot disagree
+ * about what a mask is.
+ *
+ * @param modeMask12 The value to check.
+ * @param name What the value is, for the error message.
+ * @returns The mask.
+ * @throws If it is not an integer in [1, {@link CHROMATIC_MASK}].
+ * @example
+ * ```ts
+ * import { assertModeMask, MAJOR_MASK } from '@libraz/libcantus';
+ * assertModeMask(MAJOR_MASK); // 2741
+ * ```
+ * @category Scales
+ */
+declare function assertModeMask(modeMask12: number, name?: string): number;
 /**
  * Lydian dominant (melodic minor's fourth mode): offsets {0,2,4,6,7,9,10}.
  *
@@ -168,7 +192,7 @@ declare const MIYAKO_BUSHI_MASK: number;
  *
  * Two ritsu tetrachords a fourth apart: the middle note sits a whole tone above
  * the lower nuclear tone. The result is the same five pitch classes as the
- * major pentatonic a fourth below, which is why the mask alone cannot say which
+ * major pentatonic a fourth above, which is why the mask alone cannot say which
  * tradition is meant.
  *
  * @category Scales
@@ -441,5 +465,28 @@ declare function namedScaleMask(name: ScaleNameInput): number | undefined;
  * @category Scales
  */
 declare function requireScaleMask(name: ScaleNameInput, label?: string): number;
+/**
+ * The form a mask stands in, when it stands in one.
+ *
+ * A bare scale still names its form — a major mask is a major key whoever built
+ * it — so the form is read from the mask rather than defaulted away. Only a
+ * mask matching none of the four is modal.
+ */
+declare function variantOfMask(modeMask12: number): KeyVariant;
+/**
+ * Refuse a scale form the key's own mask does not hold.
+ *
+ * A key whose variant says `'harmonic'` over a major mask prints as a harmonic
+ * minor while comparing equal to plain C major, so a project file that carried
+ * the two apart is refused where the mismatch is still an argument. Kept beside
+ * the type it validates: the pairing of form and mask is written once, and
+ * every construction path reads that one.
+ *
+ * @param variant The form claimed for the key.
+ * @param modeMask12 The mask the key actually holds.
+ * @throws If the form is not one a key may stand in, or the mask does not hold it.
+ * @category Scales
+ */
+declare function assertKeyVariant(variant: KeyVariant, modeMask12: number): void;
 
-export { ALTERED_MASK as A, BLUES_MASK as B, CHROMATIC_MASK as C, DORIAN_MASK as D, HARMONIC_MINOR_MASK as H, LOCRIAN_MASK as L, MAJOR_MASK as M, NAMED_SCALES as N, OCTATONIC_HALF_WHOLE_MASK as O, PHRYGIAN_DOMINANT_MASK as P, RITSU_MASK as R, SCALE_ALIASES as S, TODI_MASK as T, WHOLE_TONE_MASK as W, DOUBLE_HARMONIC_MASK as a, LOCRIAN_NATURAL2_MASK as b, LYDIAN_DOMINANT_MASK as c, LYDIAN_MASK as d, MAJOR_PENTATONIC_MASK as e, MARWA_MASK as f, MELODIC_MINOR_MASK as g, MINOR_PENTATONIC_MASK as h, MIXOLYDIAN_B13_MASK as i, MIXOLYDIAN_MASK as j, MIYAKO_BUSHI_MASK as k, NATURAL_MINOR_MASK as l, OCTATONIC_WHOLE_HALF_MASK as m, PHRYGIAN_MASK as n, PURVI_MASK as o, RYUKYU_MASK as p, type ScaleAliasName as q, type ScaleName as r, type ScaleNameInput as s, WORLD_SCALES as t, type WorldScaleName as u, maskFromOffsets as v, namedScaleMask as w, requireScaleMask as x, resolveScaleName as y };
+export { ALTERED_MASK as A, BLUES_MASK as B, CHROMATIC_MASK as C, DORIAN_MASK as D, resolveScaleName as E, variantOfMask as F, HARMONIC_MINOR_MASK as H, LOCRIAN_MASK as L, MAJOR_MASK as M, NAMED_SCALES as N, OCTATONIC_HALF_WHOLE_MASK as O, PHRYGIAN_DOMINANT_MASK as P, RITSU_MASK as R, SCALE_ALIASES as S, TODI_MASK as T, WHOLE_TONE_MASK as W, DOUBLE_HARMONIC_MASK as a, LOCRIAN_NATURAL2_MASK as b, LYDIAN_DOMINANT_MASK as c, LYDIAN_MASK as d, MAJOR_PENTATONIC_MASK as e, MARWA_MASK as f, MELODIC_MINOR_MASK as g, MINOR_PENTATONIC_MASK as h, MIXOLYDIAN_B13_MASK as i, MIXOLYDIAN_MASK as j, MIYAKO_BUSHI_MASK as k, NATURAL_MINOR_MASK as l, OCTATONIC_WHOLE_HALF_MASK as m, PHRYGIAN_MASK as n, PURVI_MASK as o, RYUKYU_MASK as p, type ScaleAliasName as q, type ScaleName as r, type ScaleNameInput as s, WORLD_SCALES as t, type WorldScaleName as u, assertKeyVariant as v, assertModeMask as w, maskFromOffsets as x, namedScaleMask as y, requireScaleMask as z };

package/dist/model/index.cjs

@@ -16,23 +16,23 @@
 
 
 
-var _chunk6XH6QZYQcjs = require('../chunk-6XH6QZYQ.cjs');
-require('../chunk-B6XNKWZV.cjs');
-require('../chunk-NLEU4QSE.cjs');
-require('../chunk-AFM2ULJH.cjs');
-require('../chunk-OE6WK2Y2.cjs');
-require('../chunk-E3F4AHAH.cjs');
-require('../chunk-K4ZJUGF4.cjs');
-require('../chunk-WWURE4XT.cjs');
-require('../chunk-6XPTBE7Y.cjs');
+var _chunkDSMJRXCZcjs = require('../chunk-DSMJRXCZ.cjs');
+require('../chunk-HPVSH7SF.cjs');
+require('../chunk-NM7UAMC3.cjs');
+require('../chunk-J7FHVZII.cjs');
+require('../chunk-SGLEQVJH.cjs');
+require('../chunk-CGBADIO5.cjs');
+require('../chunk-35NBV2FT.cjs');
+require('../chunk-76ZBTRG2.cjs');
+require('../chunk-PM4XJE2Y.cjs');
 
 
-var _chunkUADYAYATcjs = require('../chunk-UADYAYAT.cjs');
-require('../chunk-Q2WGKJNN.cjs');
+var _chunk3R3QVKY5cjs = require('../chunk-3R3QVKY5.cjs');
 
 
 
 
+var _chunkS5BKZZGMcjs = require('../chunk-S5BKZZGM.cjs');
 
 
 
@@ -48,5 +48,12 @@ require('../chunk-Q2WGKJNN.cjs');
 
 
 
-exports.Arrangement = _chunk6XH6QZYQcjs.Arrangement; exports.Chord = _chunk6XH6QZYQcjs.Chord; exports.Composer = _chunk6XH6QZYQcjs.Composer; exports.Duration = _chunk6XH6QZYQcjs.Duration; exports.Instrument = _chunk6XH6QZYQcjs.Instrument; exports.Interval = _chunk6XH6QZYQcjs.Interval; exports.Key = _chunk6XH6QZYQcjs.Key; exports.Meter = _chunk6XH6QZYQcjs.Meter; exports.Motif = _chunk6XH6QZYQcjs.Motif; exports.Note = _chunk6XH6QZYQcjs.Note; exports.NoteSafety = _chunkUADYAYATcjs.NoteSafety; exports.Progression = _chunk6XH6QZYQcjs.Progression; exports.Rhythm = _chunk6XH6QZYQcjs.Rhythm; exports.Score = _chunk6XH6QZYQcjs.Score; exports.Tempo = _chunk6XH6QZYQcjs.Tempo; exports.Timeline = _chunk6XH6QZYQcjs.Timeline; exports.Tuning = _chunk6XH6QZYQcjs.Tuning; exports.Voicing = _chunk6XH6QZYQcjs.Voicing;
+
+
+
+
+
+
+
+exports.Arrangement = _chunkDSMJRXCZcjs.Arrangement; exports.BudgetExceededError = _chunkS5BKZZGMcjs.BudgetExceededError; exports.Chord = _chunkDSMJRXCZcjs.Chord; exports.Composer = _chunkDSMJRXCZcjs.Composer; exports.Duration = _chunkDSMJRXCZcjs.Duration; exports.Instrument = _chunkDSMJRXCZcjs.Instrument; exports.Interval = _chunkDSMJRXCZcjs.Interval; exports.InvalidInputError = _chunkS5BKZZGMcjs.InvalidInputError; exports.Key = _chunkDSMJRXCZcjs.Key; exports.Meter = _chunkDSMJRXCZcjs.Meter; exports.Motif = _chunkDSMJRXCZcjs.Motif; exports.NoSolutionError = _chunkS5BKZZGMcjs.NoSolutionError; exports.Note = _chunkDSMJRXCZcjs.Note; exports.NoteSafety = _chunk3R3QVKY5cjs.NoteSafety; exports.Progression = _chunkDSMJRXCZcjs.Progression; exports.Rhythm = _chunkDSMJRXCZcjs.Rhythm; exports.Score = _chunkDSMJRXCZcjs.Score; exports.Tempo = _chunkDSMJRXCZcjs.Tempo; exports.Timeline = _chunkDSMJRXCZcjs.Timeline; exports.Tuning = _chunkDSMJRXCZcjs.Tuning; exports.Voicing = _chunkDSMJRXCZcjs.Voicing;
 //# sourceMappingURL=index.cjs.map

package/dist/model/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["/home/runner/work/libcantus/libcantus/dist/model/index.cjs"],"names":[],"mappings":"AAAA;AACE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACF,yDAA8B;AAC9B,iCAA8B;AAC9B,iCAA8B;AAC9B,iCAA8B;AAC9B,iCAA8B;AAC9B,iCAA8B;AAC9B,iCAA8B;AAC9B,iCAA8B;AAC9B,iCAA8B;AAC9B;AACE;AACF,yDAA8B;AAC9B,iCAA8B;AAC9B;AACE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACF,uyBAAC","file":"/home/runner/work/libcantus/libcantus/dist/model/index.cjs"}
+{"version":3,"sources":["/home/runner/work/libcantus/libcantus/dist/model/index.cjs"],"names":[],"mappings":"AAAA;AACE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACF,yDAA8B;AAC9B,iCAA8B;AAC9B,iCAA8B;AAC9B,iCAA8B;AAC9B,iCAA8B;AAC9B,iCAA8B;AAC9B,iCAA8B;AAC9B,iCAA8B;AAC9B,iCAA8B;AAC9B;AACE;AACF,yDAA8B;AAC9B;AACE;AACA;AACA;AACF,yDAA8B;AAC9B;AACE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACF,0+BAAC","file":"/home/runner/work/libcantus/libcantus/dist/model/index.cjs"}