@collabhut/plugin-sdk 0.1.0

package/dist/types/vocal-preset.d.ts

@@ -0,0 +1,149 @@
+/**
+ * Vocal preset plugin type.
+ *
+ * Unlike audio/MIDI effect plugins, a vocal preset does **not** create Web
+ * Audio nodes.  Instead it exports a static `VocalPreset` data object that
+ * the DAW's built-in vocal processing chain reads and applies.
+ *
+ * This means:
+ * - No sandbox risks from custom DSP code
+ * - Zero latency — processed natively by CollabDAW's vocal engine
+ * - Works with the Live Vocals module (`src/lib/live-vocals/`)
+ *
+ * @example
+ * ```ts
+ * import type { VocalPresetModule } from "@collabhut/plugin-sdk"
+ *
+ * const module: VocalPresetModule = {
+ *     manifest: {
+ *         id: "com.myorg.deep-trap-vocals",
+ *         name: "Deep Trap Vocals",
+ *         version: "1.0.0",
+ *         type: "vocal-preset",
+ *         description: "Hard-hitting trap vocal chain with heavy pitch correction",
+ *         author: { name: "My Org" },
+ *         pricing: "free",
+ *         minApiVersion: "0.1.0",
+ *     },
+ *     preset: {
+ *         inputGain: 0,
+ *         outputGain: -3,
+ *         eq: {
+ *             enabled: true,
+ *             bands: [
+ *                 { frequency: 80,   gain: -6,  q: 0.7, type: "highpass" },
+ *                 { frequency: 200,  gain: -3,  q: 1.2, type: "peaking"  },
+ *                 { frequency: 3000, gain: 4,   q: 1.5, type: "peaking"  },
+ *                 { frequency: 8000, gain: 5,   q: 0.8, type: "highshelf"},
+ *                 { frequency: 16000,gain: -2,  q: 0.7, type: "highshelf"},
+ *             ],
+ *         },
+ *         compressor: { enabled: true, threshold: -24, knee: 6, ratio: 6, attack: 0.003, release: 0.15, makeUpGain: 4 },
+ *         pitchCorrection: { enabled: true, scale: "chromatic", strength: 0.9, speed: 0.05 },
+ *         chorus:  { enabled: false, rate: 0.5, depth: 0.3, delay: 0.02, mix: 0.3 },
+ *         reverb:  { enabled: true,  roomSize: 0.2, damping: 0.8, preDelay: 0.01, mix: 0.15 },
+ *         delay:   { enabled: false, time: 0.25, feedback: 0.3, filter: 4000, mix: 0.2 },
+ *         deEsser: { enabled: true,  frequency: 7500, threshold: -30, range: 12 },
+ *         saturation: { enabled: true,  drive: 0.2, mix: 0.4 },
+ *     },
+ * }
+ *
+ * export default module
+ * ```
+ */
+/** EQ band filter type */
+export type EqBandType = "peaking" | "lowshelf" | "highshelf" | "lowpass" | "highpass" | "notch";
+/** A single parametric EQ band */
+export interface EqBand {
+    readonly frequency: number;
+    readonly gain: number;
+    readonly q: number;
+    readonly type: EqBandType;
+}
+/** 5-band parametric EQ settings */
+export interface VocalEqSettings {
+    readonly enabled: boolean;
+    readonly bands: readonly [EqBand, EqBand, EqBand, EqBand, EqBand];
+}
+/** Dynamic compressor settings */
+export interface VocalCompressorSettings {
+    readonly enabled: boolean;
+    readonly threshold: number;
+    readonly knee: number;
+    readonly ratio: number;
+    readonly attack: number;
+    readonly release: number;
+    readonly makeUpGain: number;
+}
+/** De-esser settings */
+export interface VocalDeEsserSettings {
+    readonly enabled: boolean;
+    readonly frequency: number;
+    readonly threshold: number;
+    readonly range: number;
+}
+/** Saturation / harmonic exciter */
+export interface VocalSaturationSettings {
+    readonly enabled: boolean;
+    readonly drive: number;
+    readonly mix: number;
+}
+/** Pitch correction settings */
+export interface VocalPitchCorrectionSettings {
+    readonly enabled: boolean;
+    /**
+     * Scale to snap to.
+     * Use a note array for custom scales: `["C", "D", "E", "G", "A"]`
+     */
+    readonly scale: "chromatic" | "major" | "minor" | "pentatonic" | readonly string[];
+    /** 0 = subtle, 1 = T-Pain hard-tune */
+    readonly strength: number;
+    /** Correction speed in seconds (lower = faster) */
+    readonly speed: number;
+}
+/** Chorus effect settings */
+export interface VocalChorusSettings {
+    readonly enabled: boolean;
+    readonly rate: number;
+    readonly depth: number;
+    readonly delay: number;
+    readonly mix: number;
+}
+/** Convolution / algorithmic reverb settings */
+export interface VocalReverbSettings {
+    readonly enabled: boolean;
+    readonly roomSize: number;
+    readonly damping: number;
+    readonly preDelay: number;
+    readonly mix: number;
+}
+/** Stereo delay settings */
+export interface VocalDelaySettings {
+    readonly enabled: boolean;
+    readonly time: number;
+    readonly feedback: number;
+    readonly filter: number;
+    readonly mix: number;
+}
+/** Complete vocal signal chain preset */
+export interface VocalPreset {
+    readonly inputGain: number;
+    readonly outputGain: number;
+    readonly eq: VocalEqSettings;
+    readonly compressor: VocalCompressorSettings;
+    readonly deEsser: VocalDeEsserSettings;
+    readonly saturation: VocalSaturationSettings;
+    readonly pitchCorrection: VocalPitchCorrectionSettings;
+    readonly chorus: VocalChorusSettings;
+    readonly reverb: VocalReverbSettings;
+    readonly delay: VocalDelaySettings;
+}
+import type { PluginManifest } from "./manifest";
+/** Full vocal-preset module shape */
+export interface VocalPresetModule {
+    readonly manifest: PluginManifest & {
+        readonly type: "vocal-preset";
+    };
+    readonly preset: VocalPreset;
+}
+//# sourceMappingURL=vocal-preset.d.ts.map

package/dist/types/vocal-preset.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vocal-preset.d.ts","sourceRoot":"","sources":["../../src/types/vocal-preset.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG;AAEH,0BAA0B;AAC1B,MAAM,MAAM,UAAU,GAChB,SAAS,GACT,UAAU,GACV,WAAW,GACX,SAAS,GACT,UAAU,GACV,OAAO,CAAA;AAEb,kCAAkC;AAClC,MAAM,WAAW,MAAM;IACnB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAA;CAC5B;AAED,oCAAoC;AACpC,MAAM,WAAW,eAAe;IAC5B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IACzB,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAA;CACpE;AAED,kCAAkC;AAClC,MAAM,WAAW,uBAAuB;IACpC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IACzB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;CAC9B;AAED,wBAAwB;AACxB,MAAM,WAAW,oBAAoB;IACjC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IACzB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CACzB;AAED,oCAAoC;AACpC,MAAM,WAAW,uBAAuB;IACpC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IACzB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;CACvB;AAED,gCAAgC;AAChC,MAAM,WAAW,4BAA4B;IACzC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IACzB;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,GAAG,OAAO,GAAG,YAAY,GAAG,SAAS,MAAM,EAAE,CAAA;IAClF,uCAAuC;IACvC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,mDAAmD;IACnD,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CACzB;AAED,6BAA6B;AAC7B,MAAM,WAAW,mBAAmB;IAChC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;CACvB;AAED,gDAAgD;AAChD,MAAM,WAAW,mBAAmB;IAChC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IACzB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;CACvB;AAED,4BAA4B;AAC5B,MAAM,WAAW,kBAAkB;IAC/B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;CACvB;AAED,yCAAyC;AACzC,MAAM,WAAW,WAAW;IACxB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B,QAAQ,CAAC,EAAE,EAAE,eAAe,CAAA;IAC5B,QAAQ,CAAC,UAAU,EAAE,uBAAuB,CAAA;IAC5C,QAAQ,CAAC,OAAO,EAAE,oBAAoB,CAAA;IACtC,QAAQ,CAAC,UAAU,EAAE,uBAAuB,CAAA;IAC5C,QAAQ,CAAC,eAAe,EAAE,4BAA4B,CAAA;IACtD,QAAQ,CAAC,MAAM,EAAE,mBAAmB,CAAA;IACpC,QAAQ,CAAC,MAAM,EAAE,mBAAmB,CAAA;IACpC,QAAQ,CAAC,KAAK,EAAE,kBAAkB,CAAA;CACrC;AAED,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAEhD,qCAAqC;AACrC,MAAM,WAAW,iBAAiB;IAC9B,QAAQ,CAAC,QAAQ,EAAE,cAAc,GAAG;QAAE,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAA;KAAE,CAAA;IACrE,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAA;CAC/B"}

package/dist/types/vocal-preset.js

@@ -0,0 +1,54 @@
+/**
+ * Vocal preset plugin type.
+ *
+ * Unlike audio/MIDI effect plugins, a vocal preset does **not** create Web
+ * Audio nodes.  Instead it exports a static `VocalPreset` data object that
+ * the DAW's built-in vocal processing chain reads and applies.
+ *
+ * This means:
+ * - No sandbox risks from custom DSP code
+ * - Zero latency — processed natively by CollabDAW's vocal engine
+ * - Works with the Live Vocals module (`src/lib/live-vocals/`)
+ *
+ * @example
+ * ```ts
+ * import type { VocalPresetModule } from "@collabhut/plugin-sdk"
+ *
+ * const module: VocalPresetModule = {
+ *     manifest: {
+ *         id: "com.myorg.deep-trap-vocals",
+ *         name: "Deep Trap Vocals",
+ *         version: "1.0.0",
+ *         type: "vocal-preset",
+ *         description: "Hard-hitting trap vocal chain with heavy pitch correction",
+ *         author: { name: "My Org" },
+ *         pricing: "free",
+ *         minApiVersion: "0.1.0",
+ *     },
+ *     preset: {
+ *         inputGain: 0,
+ *         outputGain: -3,
+ *         eq: {
+ *             enabled: true,
+ *             bands: [
+ *                 { frequency: 80,   gain: -6,  q: 0.7, type: "highpass" },
+ *                 { frequency: 200,  gain: -3,  q: 1.2, type: "peaking"  },
+ *                 { frequency: 3000, gain: 4,   q: 1.5, type: "peaking"  },
+ *                 { frequency: 8000, gain: 5,   q: 0.8, type: "highshelf"},
+ *                 { frequency: 16000,gain: -2,  q: 0.7, type: "highshelf"},
+ *             ],
+ *         },
+ *         compressor: { enabled: true, threshold: -24, knee: 6, ratio: 6, attack: 0.003, release: 0.15, makeUpGain: 4 },
+ *         pitchCorrection: { enabled: true, scale: "chromatic", strength: 0.9, speed: 0.05 },
+ *         chorus:  { enabled: false, rate: 0.5, depth: 0.3, delay: 0.02, mix: 0.3 },
+ *         reverb:  { enabled: true,  roomSize: 0.2, damping: 0.8, preDelay: 0.01, mix: 0.15 },
+ *         delay:   { enabled: false, time: 0.25, feedback: 0.3, filter: 4000, mix: 0.2 },
+ *         deEsser: { enabled: true,  frequency: 7500, threshold: -30, range: 12 },
+ *         saturation: { enabled: true,  drive: 0.2, mix: 0.4 },
+ *     },
+ * }
+ *
+ * export default module
+ * ```
+ */
+export {};

package/package.json

@@ -0,0 +1,50 @@
+{
+    "name": "@collabhut/plugin-sdk",
+    "version": "0.1.0",
+    "description": "Type-safe SDK for building, publishing, and licensing CollabDAW plugins on CollabHut Marketplace",
+    "license": "MIT",
+    "type": "module",
+    "publishConfig": {
+        "access": "public",
+        "registry": "https://registry.npmjs.org/"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/rootlodge/collabdaw",
+        "directory": "packages/collabhut/plugin-sdk"
+    },
+    "keywords": [
+        "collabdaw",
+        "collabhut",
+        "plugin",
+        "audio",
+        "daw",
+        "web-audio",
+        "typescript",
+        "music",
+        "sdk"
+    ],
+    "main": "./dist/index.js",
+    "module": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "exports": {
+        ".": {
+            "import": "./dist/index.js",
+            "types": "./dist/index.d.ts"
+        }
+    },
+    "files": [
+        "dist/**/*",
+        "README.md",
+        "LICENSE"
+    ],
+    "scripts": {
+        "build": "tsc",
+        "typecheck": "tsc --noEmit",
+        "prepublishOnly": "npm run build"
+    },
+    "devDependencies": {
+        "@collabdaw/typescript-config": "*",
+        "typescript": "^5.9.3"
+    }
+}