Skip to content

v2.0.0

Choose a tag to compare

View all tags
@noahbaculi noahbaculi released this 06 Jun 05:34
· 47 commits to main since this release
v2.0.0
6b3fb9e

2.0.0 -- 2026-06-05

Breaking changes

  • wasm_create_guitar_compositions(input) replaced by generateArrangements(input) (JS) / generate_arrangements(input) (Rust).
  • JS export get_tuning_names() renamed to getTuningNames() and now returns the typed TuningName[] union instead of string[]. The Rust crate-root re-export keeps the name get_tuning_names; its return type is now Vec<TuningName>.
  • Output shape: Composition[] replaced by a single ArrangementSet handle. Access pattern: for (let i = 0; i < set.len; i++) set.render(i, width, padding, playback).
  • Input field pitches renamed to input.
  • Input field renames flow to the JS side as numArrangements, tuningName, guitarNumFrets, guitarCapo, maxFretSpanFilter.
  • Render parameters (width, padding, playback) moved from input bundle to ArrangementSet.render(...).
  • normalized_input sentinels ("REST", "MEASURE_BREAK") replaced by tagged variants ({ kind: "rest" }, { kind: "measureBreak" }).
  • Errors are typed: throws TabError with kind discriminator. Parse carries errors[].line and errors[].text for inline editor highlights.
  • TuningName wire serialization switched from PascalCase ("OpenG") to camelCase ("openG"). Input parsing remains case-insensitive.
  • Renamed CompositionInput to TabInput to align with the domain glossary; the old name was a 1.x holdover.
  • create_arrangements takes NumArrangements instead of u8 for num_arrangements; construct via NumArrangements::try_new(n)?. Direct Rust callers no longer validate the range themselves.
  • memoized_original_create_arrangements and memoized_original_parse_lines moved from the crate root to the __bench_internals namespace. The namespace is #[doc(hidden)], not part of the stable 2.x API, and may be removed without a major version bump.
  • Arrangement::lines is now a getter returning &[Line<BeatVec<PitchFingering>>] instead of a pub field. Direct Rust consumers call arrangement.lines() instead of &arrangement.lines. difficulty and max_fret_span were already getters.
  • parse_tuning, create_string_tuning_offset, and STD_6_STRING_TUNING_OPEN_PITCHES are no longer re-exported from the crate root. They were leaked from a 1.x composition pattern that generate_arrangements and the tuning_name field on TabInput make redundant; non-preset tunings continue to flow through create_string_tuning(&[Pitch]) plus Guitar::new. The two helpers remain reachable from criterion benches via __bench_internals and may be removed without a major version bump.
  • wrapper_create_arrangements is renamed to generate_arrangements. The Rust function and the JS function (generateArrangements) now share a single implementation and parallel names; the #[wasm_bindgen] wrapper is gone. Direct Rust callers update their imports.
  • TabError flattened: the umbrella Guitar { message }, Arrangement { message }, and InvalidInput { field, message } variants are removed. Each failure mode now has its own variant with structured payload. See MIGRATION.md for the full mapping and ADR-0007 for the rationale.
  • TabError::NoArrangementsFound (payloadless) reports the case where every input pitch reaches the guitar but no valid arrangement exists. Reachable from inputs like duplicate pitches in a single beat (e.g. "E2E2"), which the no_duplicate_strings constraint filters to zero candidate fingerings. JS callers handling an exhaustive switch (err.kind) must add a "noArrangementsFound" arm.
  • UnplayablePitch is now a public type carried by TabError::UnplayablePitches. Replaces the prose error string with structured { value, line } records.
  • StringNumber::new, Guitar::new, and create_string_tuning return Result<_, TabError> instead of anyhow::Result. Direct Rust callers must update error handling.
  • Pitch::plus_offset returns Option<Pitch> instead of anyhow::Result<Pitch>. Callers replace ? with .ok_or_else(...).
  • Guitar::new validates that capo <= num_frets before computing playable_frets. The previous code underflowed; the new behavior is TabError::CapoExceedsFrets.
  • tuningName: "" no longer means standard tuning. Pass "standard" (case-insensitive) explicitly.
  • Guitar::MAX_NUM_FRETS and Guitar::MAX_CAPO are now pub const on Guitar, alongside the existing NumArrangements::MAX. (Additive.)
  • StringNumber::MAX is now pub const on StringNumber. (Additive.)
  • TabInput is now #[non_exhaustive]. Construct it with TabInput::new(input, tuningName, guitarNumFrets, guitarCapo, numArrangements) and set the optional filter via .with_max_fret_span_filter(n). JS callers are unaffected; the deserialized wire shape is unchanged. See ADR-0008.
  • Crate edition upgraded to 2024; minimum supported Rust version is now 1.86, declared via rust-version in Cargo.toml.

Added

  • TabInput.maxFretSpanFilter: Option<u8> filters arrangements by maximum non-zero fret span. Emitted as maxFretSpanFilter?: number in the TypeScript surface, so TS-strict callers may omit the key.
  • PitchFingering::string_number(), ::fret(), and ::pitch() getters give Rust callers structured read access to the fingerings returned by Arrangement::lines(), replacing the previous Debug-only path. The fields stay pub(crate); the getters are the stable surface.
  • UnplayablePitch is re-exported from the crate root, so direct Rust callers can name the type in signatures. It was previously reachable only as a TabError::UnplayablePitches field value.
  • TabError::RenderWidthTooSmall { width, min } is returned by ArrangementSet::render when width is below the minimum needed to lay out one beat at the given padding (min_render_width(padding)). A too-small width previously underflowed the renderer's column math (debug panic, release allocation blow-up) or stalled its wrap loop. JS callers with an exhaustive switch (err.kind) may add a "renderWidthTooSmall" arm; the existing default arm already covers it.
  • Input longer than 65,535 lines returns TabError::InputTooManyLines { max } (where max is the inclusive line limit) rather than overflowing the internal u16 beat index. JS callers with an exhaustive switch (err.kind) may add an "inputTooManyLines" arm; the existing default arm already covers it. A real transcription is far below this bound, so this only rejects pathological input.
  • TuningName now derives Clone, Copy, PartialEq, Eq, Hash and NormalizedBeat derives PartialEq, Eq, so Rust callers can compare the values returned by get_tuning_names() and ArrangementSet::normalized_input() with == rather than matches!.

Internal

  • Adopted tsify-next for typed TypeScript bindings. serde-wasm-bindgen is now a transitive dependency only; no consumer-visible change beyond cargo tree ordering.
  • Parser returns structured Vec<ParseError> internally; the wire format reuses the same struct via crate::error::ParseError.
  • Released CONTEXT.md (domain glossary) and the architecture decision records in docs/adr/ (ADR-0001 through ADR-0008), beginning with the opaque-handle pattern in ADR-0001.
  • TabError now derives PartialEq, Eq and carries #[non_exhaustive] so future structured-error variants land non-breakingly.
  • Dropped the unused serde "rc" feature.
Assets 2
Loading