@pepperhorn/chordl-voicing 0.0.0-stage → 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 PepperHorn Music / Creative Ranges Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,155 @@
-# Temporary Holding Version
+# @pepperhorn/chordl-voicing
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+An open JSON format for chord voicings (fretted, keyboard, bowed), with TypeScript
+types, JSON Schemas, a canonical formatter, content hashes, a catalogue validator
+and a `chordl-voicing` command line tool.
+
+A **chord file** holds one chord and all of its voicings. A **voicing** records which
+notes sound, how they are realized on an instrument, who wrote it, and how it relates
+to other voicings (revisions, supersession, duplicates). Files are plain JSON, one per
+chord, designed to live in a git repository and be reviewed as diffs.
+
+## Schemas
+
+| Schema id | Describes |
+| --- | --- |
+| `chordl.chord/1` | A chord file: the chord (`id`, `symbol`, `root`, `quality`, `bass`, `aliases`) and its `voicings` |
+| `chordl.voicing/1` | One voicing: `notes`, a `realization`, `provenance`, `relations` and `hashes` |
+
+Both are JSON Schema draft 2020-12, shipped as `schema/chord.schema.json` and
+`schema/voicing.schema.json` (also importable as
+`@pepperhorn/chordl-voicing/schema/chord.schema.json`).
+
+Chord ids look like `C:maj7` or `C:7/E`: `<root>:<quality>[/<bass>]`. Pitches are
+ASCII scientific pitch (`Eb4`, never `E♭4`). Each note carries a jazz degree such as
+`I`, `bIII`, `#IV`.
+
+## Realizations
+
+The `realization` of a voicing has a `kind` of `fretted`, `keyboard` or `bowed`.
+
+Fretted. `strings` holds absolute frets (`null` is muted), in chordl-guitar string order:
+
+```json
+{
+  "kind": "fretted",
+  "instrument": "guitar",
+  "tuning": ["E2", "A2", "D3", "G3", "B3", "E4"],
+  "strings": [null, 3, 2, 0, 0, 0],
+  "fingers": [null, 3, 2, null, null, null],
+  "baseFret": 1,
+  "barres": [],
+  "capo": null
+}
+```
+
+Keyboard. Pitches per hand; `fingering` is optional:
+
+```json
+{ "kind": "keyboard", "hands": { "left": ["C3", "G3"], "right": ["E4", "B4"] } }
+```
+
+Bowed. One stop per sounding string:
+
+```json
+{
+  "kind": "bowed",
+  "instrument": "violin",
+  "tuning": ["G3", "D4", "A4", "E5"],
+  "stops": [{ "string": 2, "pitch": "C5", "finger": 2 }],
+  "position": 1
+}
+```
+
+## Library
+
+```ts
+import {
+  validateChordFileSchema, checkVoicing, formatChordFile, isCanonical, withHashes,
+} from "@pepperhorn/chordl-voicing";
+
+const result = validateChordFileSchema(json);
+if (!result.ok) console.error(result.errors); // [{ path, message }]
+else {
+  for (const voicing of result.value.voicings) {
+    const { hard, flags } = checkVoicing(voicing); // hard = must fix, flags = review
+  }
+  const text = formatChordFile(result.value);    // canonical JSON text
+}
+```
+
+Other exports: `parseChordId`, `formatChordId`, `chordIntervals`, `labelNotes`,
+`soundingMidi`, `notesMatchRealization`, `shapeHash`, `pitchHash`, `withHashes`,
+`chordFilePath`, `validateCatalogue` and the types (`ChordFile`, `Voicing`,
+`Realization`, ...).
+
+Hashes (`hashes.shape`, `hashes.pitch`) cover musical content only, so tier, status
+and provenance edits never change them. The exact file form and hash rules are in
+[docs/CANONICAL.md](./docs/CANONICAL.md).
+
+## CLI
+
+Run it inside a catalogue checkout (files live under `chords/`):
+
+```sh
+npx @pepperhorn/chordl-voicing <command>
+```
+
+### new
+
+Create a voicing and add it to the chord's file (creating the file if needed):
+
+```sh
+# Fretted: one character per string, or comma-separated; x = muted
+chordl-voicing new --chord C:maj7 --instrument guitar --frets x32000 --author gh:alice
+
+# Barre chords: --barre <fret>:<fromString>-<toString>, repeatable.
+# Strings are numbered from 0 (the first string in the tuning, thickest on guitar).
+# A barre counts as one finger, so a full F shape passes the four-finger check.
+chordl-voicing new --chord F:maj --instrument guitar --frets 133211 \
+  --barre 1:0-5 --author gh:alice
+
+# Keyboard: --notes "<left> | <right>", pitches space-separated.
+# Without a "|", every note goes to the right hand.
+chordl-voicing new --chord C:maj7 --instrument piano \
+  --notes "C3 G3 | E4 B4" --author gh:alice
+```
+
+`--author` is a prefixed id such as `gh:alice`. `--tier` is `community` (default) or
+`curated`. Note names and degrees are worked out from the chord, hashes are filled
+in, and the voicing is checked before it is written. Bowed voicings are written by
+hand.
+
+### format
+
+```sh
+chordl-voicing format            # rewrite every file under chords/ to canonical form
+chordl-voicing format --check    # print a diff and exit 1 if any file is not canonical
+chordl-voicing format chords/C/C__maj7.json
+```
+
+### validate
+
+```sh
+chordl-voicing validate [--base <dir>] [--licences <file>]
+```
+
+Checks schema, canonical form, hashes, notes against realization, and catalogue rules.
+With `--base`, also checks history against an earlier checkout (revisions must be
+appended, not edited). Exits 1 on any error.
+
+### bundle
+
+```sh
+chordl-voicing bundle --out dist --version v2026.10.1
+```
+
+Writes `manifest.json`, `catalogue.json` and `by-instrument/<instrument>.json`.
+`catalogue.json` holds every revision of every voicing, including retired ones;
+`by-instrument/<instrument>.json` and the manifest counts cover live voicings only.
+
+Exit codes: 0 success, 1 failure, 2 usage error.
+
+## Licence
+
+MIT

package/dist/canonical.d.ts

@@ -0,0 +1,22 @@
+import type { ChordFile } from "./types.js";
+export declare const KEY_ORDER: {
+    readonly file: readonly ["schema", "chord", "voicings"];
+    readonly chord: readonly ["id", "symbol", "root", "quality", "bass", "aliases"];
+    readonly voicing: readonly ["schema", "id", "rev", "previous", "chordId", "status", "tier", "licence", "notes", "realization", "level", "provenance", "relations", "externalIds", "hashes"];
+    readonly note: readonly ["pitch", "degree"];
+    readonly fretted: readonly ["kind", "instrument", "tuning", "strings", "fingers", "baseFret", "barres", "capo"];
+    readonly barre: readonly ["fret", "fromString", "toString"];
+    readonly keyboard: readonly ["kind", "hands", "fingering"];
+    readonly hands: readonly ["left", "right"];
+    readonly fingering: readonly ["left", "right"];
+    readonly bowed: readonly ["kind", "instrument", "tuning", "stops", "position"];
+    readonly stop: readonly ["string", "pitch", "finger"];
+    readonly provenance: readonly ["source", "authorId", "createdAt", "changeNote", "basedOn", "alternativeTo"];
+    readonly relations: readonly ["supersedes", "supersededBy", "duplicateOf"];
+    readonly hashes: readonly ["shape", "pitch"];
+};
+export declare function formatChordFile(file: ChordFile): string;
+export declare function isCanonical(text: string): {
+    ok: boolean;
+    expected: string;
+};

package/dist/canonical.js

@@ -0,0 +1,90 @@
+// Key order for every object in a chord file, defined once. Mirrors the property order in types.ts.
+export const KEY_ORDER = {
+    file: ["schema", "chord", "voicings"],
+    chord: ["id", "symbol", "root", "quality", "bass", "aliases"],
+    voicing: [
+        "schema", "id", "rev", "previous", "chordId", "status", "tier", "licence", "notes",
+        "realization", "level", "provenance", "relations", "externalIds", "hashes",
+    ],
+    note: ["pitch", "degree"],
+    fretted: ["kind", "instrument", "tuning", "strings", "fingers", "baseFret", "barres", "capo"],
+    barre: ["fret", "fromString", "toString"],
+    keyboard: ["kind", "hands", "fingering"],
+    hands: ["left", "right"],
+    fingering: ["left", "right"],
+    bowed: ["kind", "instrument", "tuning", "stops", "position"],
+    stop: ["string", "pitch", "finger"],
+    provenance: ["source", "authorId", "createdAt", "changeNote", "basedOn", "alternativeTo"],
+    relations: ["supersedes", "supersededBy", "duplicateOf"],
+    hashes: ["shape", "pitch"],
+};
+// Present keys in the given order; absent keys stay absent. Unknown keys are kept at the end
+// (in their original order) so the formatter never drops data; the schema rejects them.
+function order(o, keys, children = {}) {
+    if (o === null || typeof o !== "object" || Array.isArray(o))
+        return o;
+    const src = o;
+    // Null-prototype so a `__proto__` key from JSON.parse is plain data, and own-property checks
+    // so inherited names (`toString`, `constructor`) are never mistaken for keys.
+    const out = Object.create(null);
+    const has = (x, k) => Object.prototype.hasOwnProperty.call(x, k);
+    const emit = (k) => { out[k] = has(children, k) ? children[k](src[k]) : src[k]; };
+    for (const k of keys)
+        if (has(src, k) && src[k] !== undefined)
+            emit(k);
+    for (const k of Object.keys(src))
+        if (!has(out, k) && src[k] !== undefined)
+            emit(k);
+    return out;
+}
+const list = (f) => (v) => (Array.isArray(v) ? v.map(f) : v);
+const K = KEY_ORDER;
+function realization(v) {
+    const kind = v?.kind;
+    if (kind === "fretted")
+        return order(v, K.fretted, { barres: list((b) => order(b, K.barre)) });
+    if (kind === "keyboard") {
+        return order(v, K.keyboard, {
+            hands: (h) => order(h, K.hands),
+            fingering: (f) => order(f, K.fingering),
+        });
+    }
+    if (kind === "bowed")
+        return order(v, K.bowed, { stops: list((s) => order(s, K.stop)) });
+    return v;
+}
+const voicing = (v) => order(v, K.voicing, {
+    notes: list((n) => order(n, K.note)),
+    realization,
+    provenance: (p) => order(p, K.provenance),
+    relations: (r) => order(r, K.relations),
+    hashes: (h) => order(h, K.hashes),
+});
+const cmp = (a, b) => (a.id < b.id ? -1 : a.id > b.id ? 1 : a.rev - b.rev);
+export function formatChordFile(file) {
+    const sorted = Array.isArray(file.voicings) ? [...file.voicings].sort(cmp) : file.voicings;
+    const out = order({ ...file, voicings: sorted }, K.file, {
+        chord: (c) => order(c, K.chord),
+        voicings: list(voicing),
+    });
+    return JSON.stringify(out, null, 2) + "\n";
+}
+export function isCanonical(text) {
+    const normalised = text.replace(/^/, "").replace(/\r\n?/g, "\n");
+    let parsed;
+    try {
+        parsed = JSON.parse(normalised);
+    }
+    catch {
+        return { ok: false, expected: "" };
+    }
+    let expected;
+    try {
+        expected = formatChordFile(parsed);
+    }
+    catch {
+        return { ok: false, expected: "" };
+    }
+    return { ok: text === expected, expected };
+}
+//# sourceMappingURL=canonical.js.map

package/dist/canonical.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"canonical.js","sourceRoot":"","sources":["../src/canonical.ts"],"names":[],"mappings":"AAEA,oGAAoG;AACpG,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,IAAI,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,UAAU,CAAC;IACrC,KAAK,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,CAAC;IAC7D,OAAO,EAAE;QACP,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO;QAClF,aAAa,EAAE,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,aAAa,EAAE,QAAQ;KAC3E;IACD,IAAI,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC;IACzB,OAAO,EAAE,CAAC,MAAM,EAAE,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,CAAC;IAC7F,KAAK,EAAE,CAAC,MAAM,EAAE,YAAY,EAAE,UAAU,CAAC;IACzC,QAAQ,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,WAAW,CAAC;IACxC,KAAK,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC;IACxB,SAAS,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC;IAC5B,KAAK,EAAE,CAAC,MAAM,EAAE,YAAY,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,CAAC;IAC5D,IAAI,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC;IACnC,UAAU,EAAE,CAAC,QAAQ,EAAE,UAAU,EAAE,WAAW,EAAE,YAAY,EAAE,SAAS,EAAE,eAAe,CAAC;IACzF,SAAS,EAAE,CAAC,YAAY,EAAE,cAAc,EAAE,aAAa,CAAC;IACxD,MAAM,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC;AAIX,6FAA6F;AAC7F,wFAAwF;AACxF,SAAS,KAAK,CAAC,CAAU,EAAE,IAAuB,EAAE,WAAoD,EAAE;IACxG,IAAI,CAAC,KAAK,IAAI,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;QAAE,OAAO,CAAC,CAAC;IACtE,MAAM,GAAG,GAAG,CAAQ,CAAC;IACrB,6FAA6F;IAC7F,8EAA8E;IAC9E,MAAM,GAAG,GAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACrC,MAAM,GAAG,GAAG,CAAC,CAAS,EAAE,CAAS,EAAE,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACjF,MAAM,IAAI,GAAG,CAAC,CAAS,EAAE,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1F,KAAK,MAAM,CAAC,IAAI,IAAI;QAAE,IAAI,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK,SAAS;YAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IACvE,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;QAAE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK,SAAS;YAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IACpF,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,IAAI,GAAG,CAAC,CAA0B,EAAE,EAAE,CAAC,CAAC,CAAU,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC/F,MAAM,CAAC,GAAG,SAAS,CAAC;AAEpB,SAAS,WAAW,CAAC,CAAU;IAC7B,MAAM,IAAI,GAAI,CAAgB,EAAE,IAAI,CAAC;IACrC,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;IAC/F,IAAI,IAAI,KAAK,UAAU,EAAE,CAAC;QACxB,OAAO,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE;YAC1B,KAAK,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC;YAC/B,SAAS,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC;SACxC,CAAC,CAAC;IACL,CAAC;IACD,IAAI,IAAI,KAAK,OAAO;QAAE,OAAO,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC;IACzF,OAAO,CAAC,CAAC;AACX,CAAC;AAED,MAAM,OAAO,GAAG,CAAC,CAAU,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,OAAO,EAAE;IAClD,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;IACpC,WAAW;IACX,UAAU,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,UAAU,CAAC;IACzC,SAAS,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC;IACvC,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC;CAClC,CAAC,CAAC;AAEH,MAAM,GAAG,GAAG,CAAC,CAAU,EAAE,CAAU,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;AAE7F,MAAM,UAAU,eAAe,CAAC,IAAe;IAC7C,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;IAC3F,MAAM,GAAG,GAAG,KAAK,CAAC,EAAE,GAAG,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE;QACvD,KAAK,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC;QAC/B,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC;KACxB,CAAC,CAAC;IACH,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC;AAC7C,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,IAAY;IACtC,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IAClE,IAAI,MAAiB,CAAC;IACtB,IAAI,CAAC;QACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAc,CAAC;IAC/C,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;IACrC,CAAC;IACD,IAAI,QAAgB,CAAC;IACrB,IAAI,CAAC;QACH,QAAQ,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;IACrC,CAAC;IACD,OAAO,EAAE,EAAE,EAAE,IAAI,KAAK,QAAQ,EAAE,QAAQ,EAAE,CAAC;AAC7C,CAAC"}

package/dist/catalogue.d.ts

@@ -0,0 +1,14 @@
+export interface CatalogueIssue {
+    path: string;
+    code: string;
+    message: string;
+}
+export interface CatalogueReport {
+    ok: boolean;
+    errors: CatalogueIssue[];
+    warnings: CatalogueIssue[];
+}
+export declare function chordFilePath(chordId: string): string;
+export declare function validateCatalogue(head: Map<string, string>, base?: Map<string, string>, opts?: {
+    licences: string[];
+}): CatalogueReport;

package/dist/catalogue.js

@@ -0,0 +1,164 @@
+import { isCanonical } from "./canonical.js";
+import { checkVoicing } from "./checks.js";
+import { parseChordId } from "./chordId.js";
+import { withHashes } from "./hash.js";
+import { validateChordFileSchema } from "./schema.js";
+// chords/<root dir>/<encoded id>.json ; `#`->`s`, `/`->`_over_`, `:`->`__` (raw `#` breaks raw/CDN URLs).
+export function chordFilePath(chordId) {
+    const encode = (s) => s.replace(/#/g, "s").replace(/\//g, "_over_").replace(/:/g, "__");
+    const root = encode(chordId.split(":")[0]);
+    return `chords/${root}/${encode(chordId)}.json`;
+}
+const isChordPath = (p) => p.startsWith("chords/") && p.endsWith(".json");
+const stripBom = (s) => s.replace(/^/, "");
+// Key-sorted JSON, so history comparison ignores key order.
+function stable(v) {
+    const sort = (x) => {
+        if (Array.isArray(x))
+            return x.map(sort);
+        if (x && typeof x === "object") {
+            return Object.fromEntries(Object.keys(x).sort().map((k) => [k, sort(x[k])]));
+        }
+        return x;
+    };
+    return JSON.stringify(sort(v));
+}
+// Voicing entries of a file keyed `id@rev`; tolerant of files that do not pass the schema.
+function historyOf(files) {
+    const out = new Map();
+    for (const [path, text] of files) {
+        if (!isChordPath(path))
+            continue;
+        let data;
+        try {
+            data = JSON.parse(stripBom(text));
+        }
+        catch {
+            continue;
+        }
+        const voicings = data?.voicings;
+        if (!Array.isArray(voicings))
+            continue;
+        for (const v of voicings) {
+            if (v && typeof v === "object" && typeof v.id === "string")
+                out.set(`${v.id}@${v.rev}`, { path, json: stable(v) });
+        }
+    }
+    return out;
+}
+export function validateCatalogue(head, base, opts = { licences: ["CC0-1.0"] }) {
+    const errors = [];
+    const warnings = [];
+    const err = (path, code, message) => errors.push({ path, code, message });
+    const warn = (path, code, message) => warnings.push({ path, code, message });
+    const parsed = [];
+    for (const path of [...head.keys()].filter(isChordPath).sort()) {
+        const text = head.get(path);
+        let data;
+        try {
+            data = JSON.parse(stripBom(text));
+        }
+        catch (e) {
+            err(path, "schema", `Not valid JSON: ${e.message}`);
+            continue;
+        }
+        const res = validateChordFileSchema(data);
+        if (!res.ok) {
+            err(path, "schema", res.errors.map((e) => `${e.path || "/"}: ${e.message}`).join("; "));
+            continue;
+        }
+        parsed.push({ path, file: res.value });
+    }
+    const idFiles = new Map(); // voicing id -> first file
+    for (const { path, file } of parsed) {
+        if (!isCanonical(head.get(path)).ok)
+            err(path, "not-canonical", "File is not in canonical form; run the formatter");
+        const chordOk = parseChordId(file.chord.id) !== null;
+        if (!chordOk)
+            err(path, "chord-id", `Invalid chord id "${file.chord.id}"`);
+        else {
+            const p = parseChordId(file.chord.id);
+            if (file.chord.root !== p.root || file.chord.quality !== p.quality || file.chord.bass !== p.bass) {
+                err(path, "chord-id", `chord root/quality/bass (${file.chord.root}, ${file.chord.quality}, ${file.chord.bass}) disagree with id "${file.chord.id}"`);
+            }
+        }
+        if (chordOk && chordFilePath(file.chord.id) !== path)
+            err(path, "path-mismatch", `Expected path ${chordFilePath(file.chord.id)}`);
+        const revs = new Map();
+        for (const v of file.voicings) {
+            if (v.chordId !== file.chord.id)
+                err(path, "chord-id", `${v.id}@${v.rev}: chordId "${v.chordId}" differs from chord.id "${file.chord.id}"`);
+            if (!opts.licences.includes(v.licence))
+                err(path, "licence", `${v.id}@${v.rev}: licence "${v.licence}" is not allowed`);
+            try {
+                const h = withHashes(v).hashes;
+                if (h.shape !== v.hashes.shape || h.pitch !== v.hashes.pitch)
+                    err(path, "hash-mismatch", `${v.id}@${v.rev}: stored hashes do not match the content`);
+            }
+            catch (e) {
+                err(path, "hash-mismatch", `${v.id}@${v.rev}: cannot compute hashes: ${e.message}`);
+            }
+            const res = checkVoicing(v);
+            for (const f of res.hard)
+                err(path, `check:${f.code}`, `${v.id}@${v.rev}: ${f.message}`);
+            for (const f of res.flags)
+                warn(path, `check:${f.code}`, `${v.id}@${v.rev}: ${f.message}`);
+            revs.set(v.id, [...(revs.get(v.id) ?? []), v]);
+        }
+        for (const [id, list] of revs) {
+            const sorted = [...list].sort((a, b) => a.rev - b.rev);
+            const bad = sorted.some((v, i) => v.rev !== i + 1 || v.previous !== (i === 0 ? null : i));
+            if (bad)
+                err(path, "rev-chain", `${id}: revisions must be 1..n with previous = rev-1 (rev 1 previous null)`);
+            const first = idFiles.get(id);
+            if (first === undefined)
+                idFiles.set(id, path);
+            else if (first !== path)
+                err(path, "id-reused", `${id} is already used in ${first}`);
+        }
+    }
+    // Latest rev per id across files; only live ones are compared for duplicates.
+    const latest = new Map();
+    for (const { path, file } of parsed) {
+        for (const v of file.voicings) {
+            const cur = latest.get(v.id);
+            if (!cur || v.rev > cur.v.rev)
+                latest.set(v.id, { path, v });
+        }
+    }
+    const live = [...latest.values()].filter((e) => e.v.status === "live").sort((a, b) => (a.v.id < b.v.id ? -1 : 1));
+    const group = (key, report) => {
+        const seen = new Map();
+        for (const e of live) {
+            const k = key(e.v);
+            const first = seen.get(k);
+            if (first)
+                report(e, first);
+            else
+                seen.set(k, e);
+        }
+    };
+    group((v) => `${v.chordId}\u0000${v.hashes.shape}`, (e, f) => err(e.path, "duplicate-shape", `${e.v.id} has the same shape as ${f.v.id} for ${e.v.chordId}`));
+    group((v) => v.hashes.shape, (e, f) => {
+        if (e.v.chordId !== f.v.chordId)
+            warn(e.path, "same-shape-other-chord", `${e.v.id} (${e.v.chordId}) has the same shape as ${f.v.id} (${f.v.chordId})`);
+    });
+    group((v) => v.hashes.pitch, (e, f) => {
+        if (e.v.hashes.shape !== f.v.hashes.shape) {
+            warn(e.path, "same-pitch", `${e.v.id} sounds the same pitches as ${f.v.id}`);
+        }
+    });
+    if (base) {
+        const before = historyOf(base);
+        const after = historyOf(new Map([...head].filter(([p]) => isChordPath(p))));
+        for (const [key, b] of before) {
+            const h = after.get(key);
+            if (!h)
+                err(b.path, "removed-history", `${key} was removed`);
+            else if (h.json !== b.json)
+                err(h.path, "modified-history", `${key} was modified; history is append-only`);
+        }
+    }
+    return { ok: errors.length === 0, errors, warnings };
+}
+//# sourceMappingURL=catalogue.js.map

package/dist/catalogue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"catalogue.js","sourceRoot":"","sources":["../src/catalogue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;AAMtD,0GAA0G;AAC1G,MAAM,UAAU,aAAa,CAAC,OAAe;IAC3C,MAAM,MAAM,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAChG,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3C,OAAO,UAAU,IAAI,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC;AAClD,CAAC;AAED,MAAM,WAAW,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AAClF,MAAM,QAAQ,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;AAEpD,4DAA4D;AAC5D,SAAS,MAAM,CAAC,CAAU;IACxB,MAAM,IAAI,GAAG,CAAC,CAAU,EAAW,EAAE;QACnC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;YAAE,OAAO,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,CAAC,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;YAC/B,OAAO,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,CAAE,CAA6B,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5G,CAAC;QACD,OAAO,CAAC,CAAC;IACX,CAAC,CAAC;IACF,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;AACjC,CAAC;AAED,2FAA2F;AAC3F,SAAS,SAAS,CAAC,KAA0B;IAC3C,MAAM,GAAG,GAAG,IAAI,GAAG,EAA0C,CAAC;IAC9D,KAAK,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,KAAK,EAAE,CAAC;QACjC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;YAAE,SAAS;QACjC,IAAI,IAAa,CAAC;QAClB,IAAI,CAAC;YAAC,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;QAAC,CAAC;QAAC,MAAM,CAAC;YAAC,SAAS;QAAC,CAAC;QAC9D,MAAM,QAAQ,GAAI,IAA+B,EAAE,QAAQ,CAAC;QAC5D,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC;YAAE,SAAS;QACvC,KAAK,MAAM,CAAC,IAAI,QAAqB,EAAE,CAAC;YACtC,IAAI,CAAC,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,OAAO,CAAC,CAAC,EAAE,KAAK,QAAQ;gBAAE,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QACrH,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,UAAU,iBAAiB,CAC/B,IAAyB,EACzB,IAA0B,EAC1B,OAA+B,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE;IAExD,MAAM,MAAM,GAAqB,EAAE,CAAC;IACpC,MAAM,QAAQ,GAAqB,EAAE,CAAC;IACtC,MAAM,GAAG,GAAG,CAAC,IAAY,EAAE,IAAY,EAAE,OAAe,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;IAClG,MAAM,IAAI,GAAG,CAAC,IAAY,EAAE,IAAY,EAAE,OAAe,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;IAErG,MAAM,MAAM,GAAwC,EAAE,CAAC;IACvD,KAAK,MAAM,IAAI,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;QAC/D,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAE,CAAC;QAC7B,IAAI,IAAa,CAAC;QAClB,IAAI,CAAC;YACH,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;QACpC,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,GAAG,CAAC,IAAI,EAAE,QAAQ,EAAE,mBAAoB,CAAW,CAAC,OAAO,EAAE,CAAC,CAAC;YAC/D,SAAS;QACX,CAAC;QACD,MAAM,GAAG,GAAG,uBAAuB,CAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;YACZ,GAAG,CAAC,IAAI,EAAE,QAAQ,EAAE,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,IAAI,GAAG,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;YACxF,SAAS;QACX,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC;IACzC,CAAC;IAED,MAAM,OAAO,GAAG,IAAI,GAAG,EAAkB,CAAC,CAAC,2BAA2B;IACtE,KAAK,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,MAAM,EAAE,CAAC;QACpC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAE,CAAC,CAAC,EAAE;YAAE,GAAG,CAAC,IAAI,EAAE,eAAe,EAAE,kDAAkD,CAAC,CAAC;QACrH,MAAM,OAAO,GAAG,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,IAAI,CAAC;QACrD,IAAI,CAAC,OAAO;YAAE,GAAG,CAAC,IAAI,EAAE,UAAU,EAAE,qBAAqB,IAAI,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,CAAC;aACtE,CAAC;YACJ,MAAM,CAAC,GAAG,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAE,CAAC;YACvC,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,KAAK,CAAC,CAAC,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC;gBACjG,GAAG,CAAC,IAAI,EAAE,UAAU,EAAE,4BAA4B,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,KAAK,CAAC,OAAO,KAAK,IAAI,CAAC,KAAK,CAAC,IAAI,uBAAuB,IAAI,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,CAAC;YACvJ,CAAC;QACH,CAAC;QACD,IAAI,OAAO,IAAI,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,IAAI;YAAE,GAAG,CAAC,IAAI,EAAE,eAAe,EAAE,iBAAiB,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;QAElI,MAAM,IAAI,GAAG,IAAI,GAAG,EAAqB,CAAC;QAC1C,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC9B,IAAI,CAAC,CAAC,OAAO,KAAK,IAAI,CAAC,KAAK,CAAC,EAAE;gBAAE,GAAG,CAAC,IAAI,EAAE,UAAU,EAAE,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,GAAG,cAAc,CAAC,CAAC,OAAO,4BAA4B,IAAI,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,CAAC;YAC5I,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC;gBAAE,GAAG,CAAC,IAAI,EAAE,SAAS,EAAE,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,GAAG,cAAc,CAAC,CAAC,OAAO,kBAAkB,CAAC,CAAC;YACxH,IAAI,CAAC;gBACH,MAAM,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;gBAC/B,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,MAAM,CAAC,KAAK;oBAAE,GAAG,CAAC,IAAI,EAAE,eAAe,EAAE,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,GAAG,0CAA0C,CAAC,CAAC;YACvJ,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,GAAG,CAAC,IAAI,EAAE,eAAe,EAAE,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,GAAG,4BAA6B,CAAW,CAAC,OAAO,EAAE,CAAC,CAAC;YACjG,CAAC;YACD,MAAM,GAAG,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;YAC5B,KAAK,MAAM,CAAC,IAAI,GAAG,CAAC,IAAI;gBAAE,GAAG,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;YACzF,KAAK,MAAM,CAAC,IAAI,GAAG,CAAC,KAAK;gBAAE,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;YAC3F,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QACjD,CAAC;QACD,KAAK,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;YAC9B,MAAM,MAAM,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;YACvD,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,QAAQ,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC1F,IAAI,GAAG;gBAAE,GAAG,CAAC,IAAI,EAAE,WAAW,EAAE,GAAG,EAAE,sEAAsE,CAAC,CAAC;YAC7G,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAC9B,IAAI,KAAK,KAAK,SAAS;gBAAE,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;iBAC1C,IAAI,KAAK,KAAK,IAAI;gBAAE,GAAG,CAAC,IAAI,EAAE,WAAW,EAAE,GAAG,EAAE,uBAAuB,KAAK,EAAE,CAAC,CAAC;QACvF,CAAC;IACH,CAAC;IAED,8EAA8E;IAC9E,MAAM,MAAM,GAAG,IAAI,GAAG,EAAwC,CAAC;IAC/D,KAAK,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,MAAM,EAAE,CAAC;QACpC,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC9B,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YAC7B,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG;gBAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC;QAC/D,CAAC;IACH,CAAC;IACD,MAAM,IAAI,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAClH,MAAM,KAAK,GAAG,CAAC,GAA2B,EAAE,MAAsF,EAAE,EAAE;QACpI,MAAM,IAAI,GAAG,IAAI,GAAG,EAAwC,CAAC;QAC7D,KAAK,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC;YACrB,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACnB,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YAC1B,IAAI,KAAK;gBAAE,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;;gBACvB,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACtB,CAAC;IACH,CAAC,CAAC;IACF,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,OAAO,SAAS,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,iBAAiB,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,0BAA0B,CAAC,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;IAC9J,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QACpC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO;YAAE,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,wBAAwB,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,2BAA2B,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC;IACzJ,CAAC,CAAC,CAAC;IACH,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QACpC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;YAC1C,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,YAAY,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,+BAA+B,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAC/E,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,IAAI,IAAI,EAAE,CAAC;QACT,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;QAC/B,MAAM,KAAK,GAAG,SAAS,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5E,KAAK,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,IAAI,MAAM,EAAE,CAAC;YAC9B,MAAM,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACzB,IAAI,CAAC,CAAC;gBAAE,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,iBAAiB,EAAE,GAAG,GAAG,cAAc,CAAC,CAAC;iBACxD,IAAI,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI;gBAAE,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,kBAAkB,EAAE,GAAG,GAAG,uCAAuC,CAAC,CAAC;QAC7G,CAAC;IACH,CAAC;IAED,OAAO,EAAE,EAAE,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;AACvD,CAAC"}

package/dist/checks.d.ts

@@ -0,0 +1,8 @@
+import type { Finding } from "./realization.js";
+import type { Voicing } from "./types.js";
+export interface CheckResult {
+    hard: Finding[];
+    flags: Finding[];
+    facts: Finding[];
+}
+export declare function checkVoicing(v: Voicing): CheckResult;