@scorelabs/core 1.0.1

package/dist/models/types.d.ts

@@ -0,0 +1,202 @@
+/**
+ * Shared types and enums for ScoreLabs
+ */
+export declare enum StemDirection {
+    Up = "up",
+    Down = "down"
+}
+export declare enum Clef {
+    Treble = "treble",
+    Bass = "bass",
+    Alto = "alto",
+    Tenor = "tenor",
+    Percussion = "percussion",
+    Tab = "tab"
+}
+export declare enum Duration {
+    Whole = "whole",
+    Half = "half",
+    Quarter = "quarter",
+    Eighth = "eighth",
+    Sixteenth = "sixteenth",
+    ThirtySecond = "thirty-second",
+    SixtyFourth = "sixty-fourth",
+    OneHundredTwentyEighth = "one-hundred-twenty-eighth",
+    TwoHundredFiftySixth = "two-hundred-fifty-sixth"
+}
+export declare enum Accidental {
+    Sharp = "sharp",
+    Flat = "flat",
+    Natural = "natural",
+    DoubleSharp = "double-sharp",
+    DoubleFlat = "double-flat"
+}
+export declare enum Articulation {
+    Staccato = "staccato",
+    Accent = "accent",
+    Tenuto = "tenuto",
+    Marcato = "marcato",
+    Fermata = "fermata",
+    Staccatissimo = "staccatissimo"
+}
+export declare enum Bowing {
+    DownBow = "down-bow",
+    UpBow = "up-bow"
+}
+export declare enum NoteheadShape {
+    Normal = "normal",
+    Cross = "cross",// X shape (percussion, spoken)
+    Diamond = "diamond",// Harmonics
+    Slash = "slash",// Rhythmic notation
+    Triangle = "triangle",// Percussion
+    Square = "square"
+}
+export declare enum Dynamic {
+    PPP = "ppp",
+    PP = "pp",
+    P = "p",
+    MP = "mp",
+    MF = "mf",
+    F = "f",
+    FF = "ff",
+    FFF = "fff",
+    SFZ = "sfz",
+    FP = "fp"
+}
+export declare enum Genre {
+    Blues = "Blues",
+    Children = "Children",
+    Christian = "Christian",
+    Christmas = "Christmas",
+    Classical = "Classical",
+    ContestFestival = "Contest/Festival",
+    Country = "Country",
+    Educational = "Educational",
+    FilmTV = "Film/TV",
+    Folk = "Folk",
+    Games = "Games",
+    Gospel = "Gospel",
+    Holiday = "Holiday",
+    Jazz = "Jazz",
+    Latin = "Latin",
+    Musicals = "Musicals",
+    Pop = "Pop",
+    RBHipHop = "R&B/Hip-Hop",
+    Rock = "Rock",
+    Standards = "Standards",
+    Traditional = "Traditional",
+    Wedding = "Wedding",
+    World = "World",
+    Worship = "Worship",
+    Unknown = "unknown"
+}
+export interface TimeSignature {
+    beats: number;
+    beatType: number;
+    symbol?: 'common' | 'cut' | 'normal';
+}
+export interface KeySignature {
+    fifths: number;
+}
+export interface Tempo {
+    bpm: number;
+    duration: Duration;
+    isDotted: boolean;
+    text?: string;
+}
+export interface Slur {
+    placement: 'start' | 'stop';
+    direction?: 'up' | 'down';
+}
+export interface Tuplet {
+    actual: number;
+    normal: number;
+    type: 'start' | 'stop' | 'middle';
+}
+export declare enum HairpinType {
+    Crescendo = "crescendo",
+    Decrescendo = "decrescendo"
+}
+export interface Hairpin {
+    type: HairpinType;
+    placement: 'start' | 'stop';
+}
+export interface Repeat {
+    type: 'start' | 'end';
+    times?: number;
+}
+export interface Volta {
+    type: 'start' | 'stop' | 'both';
+    number: number;
+}
+export declare enum BarlineStyle {
+    Regular = "regular",
+    Double = "light-light",// Double barline (often used for key changes)
+    Final = "light-heavy",
+    Dotted = "dotted",
+    Dashed = "dashed",
+    Heavy = "heavy",
+    None = "none"
+}
+export declare enum GlissandoType {
+    Wavy = "wavy",
+    Straight = "straight"
+}
+export interface Glissando {
+    type: GlissandoType;
+    placement: 'start' | 'stop';
+}
+export declare enum Arpeggio {
+    Normal = "normal",
+    Up = "up",
+    Down = "down"
+}
+export declare enum OttavaType {
+    OttavaAlta = "8va",
+    OttavaBassa = "8vb",
+    QuindicesimaAlta = "15ma",
+    QuindicesimaBassa = "15mb"
+}
+export interface Ottava {
+    type: OttavaType;
+    placement: 'start' | 'stop';
+}
+export interface Pedal {
+    type: 'sustain' | 'una-corda';
+    placement: 'start' | 'stop';
+}
+export declare enum Ornament {
+    Trill = "trill",
+    Mordent = "mordent",
+    InvertedMordent = "inverted-mordent",
+    Turn = "turn",
+    InvertedTurn = "inverted-turn"
+}
+export declare const DURATION_VALUES: Record<Duration, number>;
+/**
+ * Decomposes a duration value (quarter = 1) into a list of duration/dot pairs.
+ */
+export declare function decomposeDuration(value: number): {
+    duration: Duration;
+    isDotted: boolean;
+    val: number;
+}[];
+export interface FretboardDot {
+    string: number;
+    fret: number;
+    label?: string;
+}
+export interface FretboardBarre {
+    fret: number;
+    startString: number;
+    endString: number;
+}
+export interface FretboardDiagram {
+    strings: number;
+    frets: number;
+    startingFret?: number;
+    dots: FretboardDot[];
+    barres?: FretboardBarre[];
+    openStrings?: number[];
+    mutedStrings?: number[];
+}

package/dist/models/types.js

@@ -0,0 +1,205 @@
+/**
+ * Shared types and enums for ScoreLabs
+ */
+// Stem direction
+export var StemDirection;
+(function (StemDirection) {
+    StemDirection["Up"] = "up";
+    StemDirection["Down"] = "down";
+})(StemDirection || (StemDirection = {}));
+// Clef types supported
+export var Clef;
+(function (Clef) {
+    Clef["Treble"] = "treble";
+    Clef["Bass"] = "bass";
+    Clef["Alto"] = "alto";
+    Clef["Tenor"] = "tenor";
+    Clef["Percussion"] = "percussion";
+    Clef["Tab"] = "tab";
+})(Clef || (Clef = {}));
+// Note duration types
+export var Duration;
+(function (Duration) {
+    Duration["Whole"] = "whole";
+    Duration["Half"] = "half";
+    Duration["Quarter"] = "quarter";
+    Duration["Eighth"] = "eighth";
+    Duration["Sixteenth"] = "sixteenth";
+    Duration["ThirtySecond"] = "thirty-second";
+    Duration["SixtyFourth"] = "sixty-fourth";
+    Duration["OneHundredTwentyEighth"] = "one-hundred-twenty-eighth";
+    Duration["TwoHundredFiftySixth"] = "two-hundred-fifty-sixth";
+})(Duration || (Duration = {}));
+// Accidental types
+export var Accidental;
+(function (Accidental) {
+    Accidental["Sharp"] = "sharp";
+    Accidental["Flat"] = "flat";
+    Accidental["Natural"] = "natural";
+    Accidental["DoubleSharp"] = "double-sharp";
+    Accidental["DoubleFlat"] = "double-flat";
+})(Accidental || (Accidental = {}));
+// Articulation types
+export var Articulation;
+(function (Articulation) {
+    Articulation["Staccato"] = "staccato";
+    Articulation["Accent"] = "accent";
+    Articulation["Tenuto"] = "tenuto";
+    Articulation["Marcato"] = "marcato";
+    Articulation["Fermata"] = "fermata";
+    Articulation["Staccatissimo"] = "staccatissimo";
+})(Articulation || (Articulation = {}));
+// Bowing markings
+export var Bowing;
+(function (Bowing) {
+    Bowing["DownBow"] = "down-bow";
+    Bowing["UpBow"] = "up-bow";
+})(Bowing || (Bowing = {}));
+// Notehead shapes
+export var NoteheadShape;
+(function (NoteheadShape) {
+    NoteheadShape["Normal"] = "normal";
+    NoteheadShape["Cross"] = "cross";
+    NoteheadShape["Diamond"] = "diamond";
+    NoteheadShape["Slash"] = "slash";
+    NoteheadShape["Triangle"] = "triangle";
+    NoteheadShape["Square"] = "square";
+})(NoteheadShape || (NoteheadShape = {}));
+// Dynamic markings
+export var Dynamic;
+(function (Dynamic) {
+    Dynamic["PPP"] = "ppp";
+    Dynamic["PP"] = "pp";
+    Dynamic["P"] = "p";
+    Dynamic["MP"] = "mp";
+    Dynamic["MF"] = "mf";
+    Dynamic["F"] = "f";
+    Dynamic["FF"] = "ff";
+    Dynamic["FFF"] = "fff";
+    Dynamic["SFZ"] = "sfz";
+    Dynamic["FP"] = "fp";
+})(Dynamic || (Dynamic = {}));
+// Genre types
+export var Genre;
+(function (Genre) {
+    Genre["Blues"] = "Blues";
+    Genre["Children"] = "Children";
+    Genre["Christian"] = "Christian";
+    Genre["Christmas"] = "Christmas";
+    Genre["Classical"] = "Classical";
+    Genre["ContestFestival"] = "Contest/Festival";
+    Genre["Country"] = "Country";
+    Genre["Educational"] = "Educational";
+    Genre["FilmTV"] = "Film/TV";
+    Genre["Folk"] = "Folk";
+    Genre["Games"] = "Games";
+    Genre["Gospel"] = "Gospel";
+    Genre["Holiday"] = "Holiday";
+    Genre["Jazz"] = "Jazz";
+    Genre["Latin"] = "Latin";
+    Genre["Musicals"] = "Musicals";
+    Genre["Pop"] = "Pop";
+    Genre["RBHipHop"] = "R&B/Hip-Hop";
+    Genre["Rock"] = "Rock";
+    Genre["Standards"] = "Standards";
+    Genre["Traditional"] = "Traditional";
+    Genre["Wedding"] = "Wedding";
+    Genre["World"] = "World";
+    Genre["Worship"] = "Worship";
+    Genre["Unknown"] = "unknown";
+})(Genre || (Genre = {}));
+// Hairpin (Crescendo/Decrescendo)
+export var HairpinType;
+(function (HairpinType) {
+    HairpinType["Crescendo"] = "crescendo";
+    HairpinType["Decrescendo"] = "decrescendo";
+})(HairpinType || (HairpinType = {}));
+// Barline styles
+export var BarlineStyle;
+(function (BarlineStyle) {
+    BarlineStyle["Regular"] = "regular";
+    BarlineStyle["Double"] = "light-light";
+    BarlineStyle["Final"] = "light-heavy";
+    BarlineStyle["Dotted"] = "dotted";
+    BarlineStyle["Dashed"] = "dashed";
+    BarlineStyle["Heavy"] = "heavy";
+    BarlineStyle["None"] = "none";
+})(BarlineStyle || (BarlineStyle = {}));
+// Glissando
+export var GlissandoType;
+(function (GlissandoType) {
+    GlissandoType["Wavy"] = "wavy";
+    GlissandoType["Straight"] = "straight";
+})(GlissandoType || (GlissandoType = {}));
+// Arpeggio (rolled chords)
+export var Arpeggio;
+(function (Arpeggio) {
+    Arpeggio["Normal"] = "normal";
+    Arpeggio["Up"] = "up";
+    Arpeggio["Down"] = "down";
+})(Arpeggio || (Arpeggio = {}));
+// Ottava (8va, 8vb, etc.)
+export var OttavaType;
+(function (OttavaType) {
+    OttavaType["OttavaAlta"] = "8va";
+    OttavaType["OttavaBassa"] = "8vb";
+    OttavaType["QuindicesimaAlta"] = "15ma";
+    OttavaType["QuindicesimaBassa"] = "15mb";
+})(OttavaType || (OttavaType = {}));
+// Ornaments
+export var Ornament;
+(function (Ornament) {
+    Ornament["Trill"] = "trill";
+    Ornament["Mordent"] = "mordent";
+    Ornament["InvertedMordent"] = "inverted-mordent";
+    Ornament["Turn"] = "turn";
+    Ornament["InvertedTurn"] = "inverted-turn";
+})(Ornament || (Ornament = {}));
+// Duration values in terms of quarter note = 1
+export const DURATION_VALUES = {
+    [Duration.Whole]: 4,
+    [Duration.Half]: 2,
+    [Duration.Quarter]: 1,
+    [Duration.Eighth]: 0.5,
+    [Duration.Sixteenth]: 0.25,
+    [Duration.ThirtySecond]: 0.125,
+    [Duration.SixtyFourth]: 0.0625,
+    [Duration.OneHundredTwentyEighth]: 0.03125,
+    [Duration.TwoHundredFiftySixth]: 0.015625,
+};
+/**
+ * Decomposes a duration value (quarter = 1) into a list of duration/dot pairs.
+ */
+export function decomposeDuration(value) {
+    const result = [];
+    let remaining = value;
+    const options = [
+        { val: 4, dur: Duration.Whole, dot: false },
+        { val: 3, dur: Duration.Half, dot: true },
+        { val: 2, dur: Duration.Half, dot: false },
+        { val: 1.5, dur: Duration.Quarter, dot: true },
+        { val: 1, dur: Duration.Quarter, dot: false },
+        { val: 0.75, dur: Duration.Eighth, dot: true },
+        { val: 0.5, dur: Duration.Eighth, dot: false },
+        { val: 0.375, dur: Duration.Sixteenth, dot: true },
+        { val: 0.25, dur: Duration.Sixteenth, dot: false },
+        { val: 0.1875, dur: Duration.ThirtySecond, dot: true },
+        { val: 0.125, dur: Duration.ThirtySecond, dot: false },
+        { val: 0.09375, dur: Duration.SixtyFourth, dot: true },
+        { val: 0.0625, dur: Duration.SixtyFourth, dot: false },
+    ];
+    // Protect against infinite loop with max iterations
+    let loops = 0;
+    while (remaining > 0.001 && loops < 100) {
+        const match = options.find((o) => o.val <= remaining + 0.001);
+        if (match) {
+            result.push({ duration: match.dur, isDotted: match.dot, val: match.val });
+            remaining -= match.val;
+        }
+        else {
+            break;
+        }
+        loops++;
+    }
+    return result;
+}

package/package.json

@@ -0,0 +1,34 @@
+{
+    "name": "@scorelabs/core",
+    "version": "1.0.1",
+    "description": "Core logic and models for ScoreLabs music notation",
+    "type": "module",
+    "files": [
+        "dist"
+    ],
+    "main": "./dist/index.js",
+    "module": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "exports": {
+        ".": {
+            "import": "./dist/index.js",
+            "types": "./dist/index.d.ts"
+        }
+    },
+    "scripts": {
+        "build": "tsc",
+        "preversion": "npm run build",
+        "postversion": "git push && git push --tags",
+        "release:patch": "npm version patch && npm publish --access public",
+        "release:minor": "npm version minor && npm publish --access public",
+        "release:major": "npm version major && npm publish --access public",
+        "release": "npm run release:patch"
+    },
+    "dependencies": {
+        "jszip": "^3.10.1"
+    },
+    "devDependencies": {
+        "@types/jszip": "^3.4.0",
+        "typescript": "^5.3.3"
+    }
+}