@pepperhorn/chordl-core 0.3.0

package/dist/types.d.ts

@@ -0,0 +1,123 @@
+export type Format = "compact" | "exact";
+/** Tailwind-inspired text size scale for annotations. */
+export type TextSize = "base" | "lg" | "xl" | "2xl";
+/** Note name display mode. */
+export type NoteNameMode = "pitch-class" | "midi" | "degree" | "pitch-class+degree";
+export type WhiteNote = "C" | "D" | "E" | "F" | "G" | "A" | "B";
+export type NoteName = string;
+export interface ColorTheme {
+    name: string;
+    whiteKey: (note: string, highlighted: boolean) => string;
+    blackKey: (note: string, highlighted: boolean) => string;
+}
+export interface ParsedChordRequest {
+    chordName: string;
+    inversion?: number;
+    /** When true, show all inversions side by side (root, 1st, 2nd, etc.) */
+    allInversions?: boolean;
+    startingNote?: string;
+    startingDegree?: number;
+    bassNote?: string;
+    bassDegree?: number;
+    spanFrom?: string;
+    spanTo?: string;
+    format?: Format;
+    styleHint?: string;
+    padding?: number;
+    /** Octave shift for the chord: -1 = "down an octave", +1 = "up an octave" */
+    chordOctaveShift?: number;
+    /** Octave shift for the bass note: +1 = "up an octave", -1 = "down an octave" */
+    bassOctaveShift?: number;
+    /** Show note names below highlighted keys. */
+    showNoteNames?: boolean;
+    /** Text size for note name labels. */
+    noteNameSize?: TextSize;
+    /** Note name display mode: pitch-class (default) or midi (with octave numbers). */
+    noteNameMode?: NoteNameMode;
+    /** Fingering values (aligned with chord notes). Numbers 1–5 plus extra symbols (0, -, x). Invalid entries become "?". */
+    fingering?: (number | string)[];
+    /** Auto-compute fingering when true (no explicit numbers given). */
+    autoFingering?: boolean;
+    /** Custom fingering labels (free-form strings like "A0", "G3"). */
+    customFingering?: string[];
+    /** Text size for fingering numbers. */
+    fingeringSize?: TextSize;
+    /** When true, input is a scale (not a chord). */
+    isScale?: boolean;
+    /** Full scale name for Tonal lookup, e.g. "D major", "C blues". */
+    scaleName?: string;
+    /** Melodic minor direction. */
+    scaleDirection?: "ascending" | "descending";
+    /** Number of octaves for scale display. */
+    scaleOctaves?: number;
+    /** Number of octaves for arpeggio (chord repeated across octaves). */
+    chordOctaves?: number;
+    /** Show chord/scale name as a heading above the keyboard. */
+    showHeading?: boolean;
+    /** Color theme name: "boomwhacker", "crf", "rainbow". */
+    colorTheme?: string;
+    /** Display scale (0–1+ range, e.g. 0.8 = 80%). */
+    scale?: number;
+}
+export interface KeyDescriptor {
+    note: string;
+    /** Relative octave (0-based, increments each time C is crossed) */
+    octave: number;
+    isBlack: boolean;
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+export interface HandBracket {
+    label: string;
+    /** Indices into the keys array for this hand's notes */
+    keyIndices: number[];
+}
+export type DisplayMode = "keyboard" | "staff" | "both";
+export interface DisplayDefaults {
+    display?: DisplayMode;
+    format?: Format;
+    theme?: ColorTheme | string;
+    highlightColor?: string;
+    padding?: number;
+    scale?: number;
+    glyphs?: "bravura" | "petaluma";
+    showNoteNames?: boolean;
+    noteNameSize?: TextSize;
+    noteNameMode?: NoteNameMode;
+    showFingering?: boolean;
+    fingeringSize?: TextSize;
+}
+export interface ChordData {
+    /** NL string — source of truth for chord resolution. */
+    chord: string;
+    /** Display override for the chord symbol heading. */
+    chordHeading?: string;
+    /** Text below fingering, inside the chord's bounding box. */
+    annotationText?: string;
+    /** Per-chord display mode override. */
+    display?: DisplayMode;
+    format?: Format;
+    theme?: ColorTheme | string;
+    highlightColor?: string;
+    padding?: number;
+}
+export interface SectionData {
+    /** Section letter ID (auto-assigned "A","B",... if omitted). */
+    id?: string;
+    heading?: string;
+    subheading?: string;
+    textAbove?: string;
+    textBelow?: string;
+    defaults?: DisplayDefaults;
+    chords: ChordData[];
+}
+export interface ChordSheetData {
+    /** Schema version. */
+    v: string;
+    heading?: string;
+    subheading?: string;
+    defaults?: DisplayDefaults;
+    sections: SectionData[];
+}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@pepperhorn/chordl-core",
+  "version": "0.3.0",
+  "description": "Pure TypeScript chord parsing, resolving, layout, and export engine",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "tonal": "^6.3.0",
+    "@pepperhorn/chordl-voicings": "0.3.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.7.0",
+    "vitest": "^4.1.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "MIT",
+  "scripts": {
+    "build": "tsc",
+    "lint": "tsc --noEmit",
+    "test": "vitest",
+    "test:run": "vitest run"
+  }
+}