instruments-chords 0.0.2

package/LICENCE

@@ -0,0 +1,21 @@
+Licencia MIT
+
+Copyright © 2026 Angel Rangel, poner en repositorio de github
+
+Por la presente, se concede permiso gratuito a cualquier persona que obtenga una
+copia de este software y los archivos de documentación asociados (el "Software")
+para utilizarlo sin restricciones, incluyendo, entre otros, los derechos de uso,
+copia, modificación, fusión, publicación, distribución, sublicencia y/o venta de
+copias del Software, y para permitir que las personas a quienes se les
+proporciona el Software lo hagan, sujeto a las siguientes condiciones:
+
+El aviso de derechos de autor anterior y este aviso de permiso se incluirán en
+todas las copias o partes sustanciales del Software.
+
+EL SOFTWARE SE PROPORCIONA "TAL CUAL", SIN GARANTÍA DE NINGÚN TIPO, EXPRESA O
+IMPLÍCITA, INCLUYENDO, ENTRE OTRAS, LAS GARANTÍAS DE COMERCIABILIDAD, IDONEIDAD
+PARA UN PROPÓSITO PARTICULAR Y NO INFRACCIÓN. EN NINGÚN CASO LOS AUTORES O
+TITULARES DE LOS DERECHOS DE AUTOR SERÁN RESPONSABLES DE NINGUNA RECLAMACIÓN,
+DAÑOS U OTRA RESPONSABILIDAD, YA SEA EN UNA ACCIÓN CONTRACTUAL, EXTRACONTRACTUAL
+O DE OTRO TIPO, QUE SURJA DE, O EN CONEXIÓN CON EL SOFTWARE O EL USO U OTRAS
+OPERACIONES EN EL SOFTWARE.

package/README.md

@@ -0,0 +1,114 @@
+# 🎸 instruments-chords
+
+Base de datos de acordes de guitarra para desarrolladores, con generación
+automática de diagramas SVG.
+
+Pensada para ser **framework agnostic**, escrita en **TypeScript**, sin
+dependencias externas y fácil de integrar en cualquier proyecto web o backend.
+
+---
+
+## ✨ Características
+
+- 🎼 Acordes estructurados por tónica y tipo
+- 🎨 Generación automática de diagramas SVG
+- 🧠 Tipos fuertes en TypeScript
+- 🚫 Sin dependencias externas
+- ⚛️ Compatible con React, Vue, Astro, Svelte, Node.js
+
+---
+
+## 📦 Instalación
+
+```bash
+npm install instruments-chords
+```
+
+---
+
+## Uso básico
+
+### Obtener un acorde
+
+```typescript
+import { getChord } from 'instruments-chords'
+
+const dMajor = getChord('D')
+const dMinor = getChord('D', 'minor')
+
+console.log(dMajor)
+```
+
+### Salida
+
+```typescript
+{
+  "6": "x",
+  "5": "x",
+  "4": 0,
+  "3": 2,
+  "2": 3,
+  "1": 2
+}
+```
+
+---
+
+## Generar diagrama SVG
+
+```typescript
+import { getChordSvg } from 'instruments-chords'
+
+const svg = getChordSvg('D')
+
+// En el navegador
+document.body.innerHTML = svg!
+```
+
+---
+
+## Estructura de los acordes
+
+```typescript
+{
+  "6": "x", // cuerda muteada
+  "5": "x",
+  "4": 0,   // cuerda al aire
+  "3": 2,   // traste 2
+  "2": 3,
+  "1": 2
+}
+```
+
+---
+
+## Tipos disponibles
+
+```typescript
+type StringNumber = '1' | '2' | '3' | '4' | '5' | '6'
+type Fret = number | 'x'
+
+type ChordShape = Record<StringNumber, Fret>
+
+type ChordQuality =
+  | 'major'
+  | 'minor'
+  | '7'
+  | 'maj7'
+  | 'm7'
+  | 'sus2'
+  | 'sus4'
+  | 'aug'
+  | 'dim'
+```
+
+---
+
+## Ejemplos
+
+```typescript
+getChord('D') // D mayor
+getChord('D', 'minor') // D menor
+getChord('D', '7') // D7
+getChord('D', 'sus4') // Dsus4
+```

package/dist/chords/chords.d.ts

@@ -0,0 +1,2 @@
+import type { ChordsDictionary } from '../types';
+export declare const chords: ChordsDictionary;

package/dist/chords/chords.js

@@ -0,0 +1,38 @@
+export const chords = {
+    D: {
+        major: {
+            6: 'x',
+            5: 'x',
+            4: 0,
+            3: 2,
+            2: 3,
+            1: 2
+        },
+        minor: {
+            6: 'x',
+            5: 'x',
+            4: 0,
+            3: 2,
+            2: 3,
+            1: 1
+        },
+        7: {
+            6: 'x',
+            5: 'x',
+            4: 0,
+            3: 2,
+            2: 3,
+            1: 1
+        }
+    },
+    C: {
+        major: {
+            6: 'x',
+            5: 3,
+            4: 2,
+            3: 0,
+            2: 1,
+            1: 0
+        }
+    }
+};

package/dist/chords/index.d.ts

@@ -0,0 +1 @@
+export * from './chords';

package/dist/chords/index.js

@@ -0,0 +1 @@
+export * from './chords';

package/dist/getChord.d.ts

@@ -0,0 +1,2 @@
+import type { ChordQuality, ChordShape } from './types';
+export declare function getChord(root: string, quality?: ChordQuality): ChordShape | null;

package/dist/getChord.js

@@ -0,0 +1,4 @@
+import { chords } from './chords/index';
+export function getChord(root, quality = 'major') {
+    return chords[root]?.[quality] ?? null;
+}

package/dist/getChordSvg.d.ts

@@ -0,0 +1 @@
+export declare function getChordSvg(root: string, quality?: any): string | null;

package/dist/getChordSvg.js

@@ -0,0 +1,22 @@
+import { getChord } from './getChord';
+import { renderBase } from './svg/base';
+import { SVG_HEIGTH, SVG_WIDTH } from './svg/constants';
+import { renderMarkers } from './svg/markers';
+export function getChordSvg(root, quality) {
+    const chord = getChord(root, quality);
+    if (chord === null)
+        return null;
+    const base = renderBase();
+    const markers = renderMarkers(chord);
+    return `
+  <svg
+    width="${SVG_WIDTH}
+    heigth="${SVG_HEIGTH}
+    viewBox="0 0 ${SVG_WIDTH} ${SVG_HEIGTH}"
+    xmlns="http"://www.w3.org/2000/svg"
+  >
+    ${base}
+    ${markers}
+  </svg>
+  `.trim();
+}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { getChord } from './getChord';
+export { getChordSvg } from './getChordSvg';
+export { chords } from './chords/index';
+export * from './types';

package/dist/index.js

@@ -0,0 +1,4 @@
+export { getChord } from './getChord';
+export { getChordSvg } from './getChordSvg';
+export { chords } from './chords/index';
+export * from './types';

package/dist/svg/base.d.ts

@@ -0,0 +1 @@
+export declare function renderBase(): string;

package/dist/svg/base.js

@@ -0,0 +1,15 @@
+import { FRET_COUNT, FRET_SPACING, START_X, START_Y, STRING_COUNT, STRING_SPACING } from './constants';
+export function renderBase() {
+    let svg = '';
+    // cuerdas
+    for (let i = 0; i <= STRING_COUNT; i++) {
+        const x = START_X + i * STRING_SPACING;
+        svg += `<line x1="${x}" y1="${START_Y}" x2="${x}" y2="${START_Y + FRET_SPACING * FRET_COUNT}" stroke="black"/>`;
+    }
+    // trastes
+    for (let i = 0; i <= FRET_COUNT; i++) {
+        const y = START_Y + i * FRET_SPACING;
+        svg += `<line x1="${START_X}" y1="${y}" x2="${START_X + STRING_SPACING * (STRING_COUNT - 1)}" y2="${y}" stroke="black"/>`;
+    }
+    return svg;
+}

package/dist/svg/constants.d.ts

@@ -0,0 +1,8 @@
+export declare const SVG_WIDTH = 120;
+export declare const SVG_HEIGTH = 160;
+export declare const STRING_COUNT = 6;
+export declare const FRET_COUNT = 5;
+export declare const STRING_SPACING = 20;
+export declare const FRET_SPACING = 25;
+export declare const START_X = 20;
+export declare const START_Y = 30;

package/dist/svg/constants.js

@@ -0,0 +1,8 @@
+export const SVG_WIDTH = 120;
+export const SVG_HEIGTH = 160;
+export const STRING_COUNT = 6;
+export const FRET_COUNT = 5;
+export const STRING_SPACING = 20;
+export const FRET_SPACING = 25;
+export const START_X = 20;
+export const START_Y = 30;

package/dist/svg/markers.d.ts

@@ -0,0 +1,2 @@
+import type { ChordShape } from '../types';
+export declare function renderMarkers(chord: ChordShape): string;

package/dist/svg/markers.js

@@ -0,0 +1,19 @@
+import { getFretY, getStringX } from './utils';
+export function renderMarkers(chord) {
+    let svg = '';
+    for (const [string, fret] of Object.entries(chord)) {
+        const s = Number(string);
+        const x = getStringX(s);
+        if (fret === 'x') {
+            svg += `<text x1="${x}" y="20" text-anchor="middle">x</text>`;
+        }
+        else if (fret === 0) {
+            svg += `<cicle cx="${x}" cy="20" r="5" fill="none" stroke="black" />`;
+        }
+        else {
+            const y = getFretY(fret);
+            svg += `<cicle cx="${x}" cy="${y}" r="6" fill="black" />`;
+        }
+    }
+    return svg;
+}

package/dist/svg/utils.d.ts

@@ -0,0 +1,2 @@
+export declare function getStringX(stringNumber: number): number;
+export declare function getFretY(fret: number): number;

package/dist/svg/utils.js

@@ -0,0 +1,7 @@
+import { FRET_SPACING, START_X, START_Y, STRING_SPACING } from './constants';
+export function getStringX(stringNumber) {
+    return START_X + (6 - stringNumber) * STRING_SPACING;
+}
+export function getFretY(fret) {
+    return START_Y + fret * FRET_SPACING - FRET_SPACING / 2;
+}

package/dist/types.d.ts

@@ -0,0 +1,5 @@
+export type StringNumber = '1' | '2' | '3' | '4' | '5' | '6';
+export type Fret = number | 'x';
+export type ChordShape = Record<StringNumber, Fret>;
+export type ChordQuality = 'major' | 'minor' | '5' | '7' | 'maj7' | 'm7' | 'sus4' | 'add9' | 'sus2' | '7sus4' | '7#9' | '9' | 'aug' | 'dim';
+export type ChordsDictionary = Record<string, Partial<Record<ChordQuality, ChordShape>>>;

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "instruments-chords",
+  "version": "0.0.2",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "description": "Guitar chords database for developers",
+  "license": "MIT",
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest"
+  },
+  "keywords": [
+    "guitar",
+    "chords",
+    "music"
+  ],
+  "author": "Angel Rangel",
+  "devDependencies": {
+    "typescript": "^5",
+    "prettier": "^3.7.4",
+    "ts-standard": "^12.0.2",
+    "vitest": "^4.0.16"
+  },
+  "eslintConfig": {
+    "extends": "./node_modules/ts-config/eslintrc.json"
+  }
+}