@open-audio-stack/core 0.0.1

package/build/types/PluginFormat.d.ts

@@ -0,0 +1,20 @@
+export declare enum PluginFormat {
+    AudioUnits = "component",
+    AvidAudioExtension = "aax",
+    CleverAudioPlugin = "clap",
+    RealTimeAudioSuite = "rta",
+    LADSPAVersion2 = "lv2",
+    SoundFont2 = "sf2",
+    SFZ = "sfz",
+    TimeDivisionMultiplexing = "tdm",
+    VSTLinux = "so",
+    VSTMac = "vst",
+    VSTWin = "dll",
+    VST3 = "vst3"
+}
+export interface PluginFormatOption {
+    description: string;
+    value: PluginFormat;
+    name: string;
+}
+export declare const pluginFormats: PluginFormatOption[];

package/build/types/PluginFormat.js

@@ -0,0 +1,77 @@
+export var PluginFormat;
+(function (PluginFormat) {
+    PluginFormat["AudioUnits"] = "component";
+    PluginFormat["AvidAudioExtension"] = "aax";
+    PluginFormat["CleverAudioPlugin"] = "clap";
+    PluginFormat["RealTimeAudioSuite"] = "rta";
+    PluginFormat["LADSPAVersion2"] = "lv2";
+    PluginFormat["SoundFont2"] = "sf2";
+    PluginFormat["SFZ"] = "sfz";
+    PluginFormat["TimeDivisionMultiplexing"] = "tdm";
+    PluginFormat["VSTLinux"] = "so";
+    PluginFormat["VSTMac"] = "vst";
+    PluginFormat["VSTWin"] = "dll";
+    PluginFormat["VST3"] = "vst3";
+})(PluginFormat || (PluginFormat = {}));
+export const pluginFormats = [
+    {
+        description: "Apple's proprietary plugin format for macOS and iOS.",
+        value: PluginFormat.AudioUnits,
+        name: 'Audio Units',
+    },
+    {
+        description: "Avid's plugin format for Pro Tools, offering deep integration.",
+        value: PluginFormat.AvidAudioExtension,
+        name: 'Avid Audio Extension',
+    },
+    {
+        description: 'Modern open-source plugin format designed for performance and flexibility.',
+        value: PluginFormat.CleverAudioPlugin,
+        name: 'Clever Audio Plugin',
+    },
+    {
+        description: "Real-time plugin format used in Avid's Pro Tools.",
+        value: PluginFormat.RealTimeAudioSuite,
+        name: 'Real-Time AudioSuite',
+    },
+    {
+        description: 'Linux-friendly plugin format primarily used in open-source environments.',
+        value: PluginFormat.LADSPAVersion2,
+        name: 'LADSPA Version 2',
+    },
+    {
+        description: 'Widely used format for sound samples in musical instruments.',
+        value: PluginFormat.SoundFont2,
+        name: 'SoundFont 2',
+    },
+    {
+        description: 'An open standard for defining instrument patches and sound samples.',
+        value: PluginFormat.SFZ,
+        name: 'SFZ',
+    },
+    {
+        description: 'Legacy plugin format used in early Pro Tools systems.',
+        value: PluginFormat.TimeDivisionMultiplexing,
+        name: 'Time-Division-Multiplexing',
+    },
+    {
+        description: 'Linux version of the VST plugin format for audio effects and instruments.',
+        value: PluginFormat.VSTLinux,
+        name: 'Virtual Studio Technology (Linux)',
+    },
+    {
+        description: 'Mac version of the VST plugin format used in DAWs like Logic and Ableton.',
+        value: PluginFormat.VSTMac,
+        name: 'Virtual Studio Technology (Mac)',
+    },
+    {
+        description: 'Windows version of the VST plugin format for digital audio workstations.',
+        value: PluginFormat.VSTWin,
+        name: 'Virtual Studio Technology (Win)',
+    },
+    {
+        description: 'Third-generation VST format, offering better performance and features.',
+        value: PluginFormat.VST3,
+        name: 'Virtual Studio Technology 3',
+    },
+];

package/build/types/PluginType.d.ts

@@ -0,0 +1,13 @@
+export declare enum PluginType {
+    Effect = "effect",
+    Generator = "generator",
+    Instrument = "instrument",
+    Preset = "preset",
+    Tool = "tool"
+}
+export interface PluginTypeOption {
+    description: string;
+    value: PluginType;
+    name: string;
+}
+export declare const pluginTypes: PluginTypeOption[];

package/build/types/PluginType.js

@@ -0,0 +1,35 @@
+export var PluginType;
+(function (PluginType) {
+    PluginType["Effect"] = "effect";
+    PluginType["Generator"] = "generator";
+    PluginType["Instrument"] = "instrument";
+    PluginType["Preset"] = "preset";
+    PluginType["Tool"] = "tool";
+})(PluginType || (PluginType = {}));
+export const pluginTypes = [
+    {
+        description: 'Digital signal processing based on an existing audio signal.',
+        value: PluginType.Effect,
+        name: 'Effect',
+    },
+    {
+        description: 'Generates midi patterns or samples which can be fed into other instruments/effects.',
+        value: PluginType.Generator,
+        name: 'Generator',
+    },
+    {
+        description: 'Sound synthesis or sample playback based on audio or midi input.',
+        value: PluginType.Instrument,
+        name: 'Instrument',
+    },
+    {
+        description: 'Preset containing predefined settings for an instrument or effect.',
+        value: PluginType.Preset,
+        name: 'Preset',
+    },
+    {
+        description: 'Helper tool which provides automations and other useful functions for music.',
+        value: PluginType.Tool,
+        name: 'Tool',
+    },
+];

package/build/types/Preset.d.ts

@@ -0,0 +1,15 @@
+import { FileInterface } from './File.js';
+import { PackageVersion } from './Package.js';
+import { PresetFormat } from './PresetFormat.js';
+import { PresetType } from './PresetType.js';
+export interface PresetInterface extends PackageVersion {
+    files: PresetFile[];
+    plugins: PresetPlugins;
+    type: PresetType;
+}
+export interface PresetFile extends FileInterface {
+    formats: PresetFormat[];
+}
+export interface PresetPlugins {
+    [slug: string]: string;
+}

package/build/types/Preset.js

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

package/build/types/PresetFormat.d.ts

@@ -0,0 +1,13 @@
+export declare enum PresetFormat {
+    AU = "aupreset",
+    NativeInstruments = "nksf",
+    VST = "fxp",
+    VSTLegacy = "fxb",
+    VST3 = "vstpreset"
+}
+export interface PresetFormatOption {
+    description: string;
+    value: PresetFormat;
+    name: string;
+}
+export declare const presetFormats: PresetFormatOption[];

package/build/types/PresetFormat.js

@@ -0,0 +1,35 @@
+export var PresetFormat;
+(function (PresetFormat) {
+    PresetFormat["AU"] = "aupreset";
+    PresetFormat["NativeInstruments"] = "nksf";
+    PresetFormat["VST"] = "fxp";
+    PresetFormat["VSTLegacy"] = "fxb";
+    PresetFormat["VST3"] = "vstpreset";
+})(PresetFormat || (PresetFormat = {}));
+export const presetFormats = [
+    {
+        description: "Apple's proprietary plugin format for macOS and iOS.",
+        value: PresetFormat.AU,
+        name: 'Audio Unit preset',
+    },
+    {
+        description: 'Used by Native Instruments for their software instruments and effects.',
+        value: PresetFormat.NativeInstruments,
+        name: 'Native Instruments preset',
+    },
+    {
+        description: 'Standard preset format for VST plugins, allowing users to save and load settings.',
+        value: PresetFormat.VST,
+        name: 'VST preset',
+    },
+    {
+        description: 'Legacy preset format for older versions of VSTs.',
+        value: PresetFormat.VSTLegacy,
+        name: 'VST Legacy preset',
+    },
+    {
+        description: 'Preset format for VST3 plugins including new features.',
+        value: PresetFormat.VST3,
+        name: 'VST3 preset',
+    },
+];

package/build/types/PresetType.d.ts

@@ -0,0 +1,9 @@
+export declare enum PresetType {
+    Sound = "sound"
+}
+export interface PresetTypeOption {
+    description: string;
+    value: PresetType;
+    name: string;
+}
+export declare const presetTypes: PresetTypeOption[];

package/build/types/PresetType.js

@@ -0,0 +1,12 @@
+export var PresetType;
+(function (PresetType) {
+    PresetType["Sound"] = "sound";
+})(PresetType || (PresetType = {}));
+// TODO define preset types.
+export const presetTypes = [
+    {
+        description: 'Preset for sounds',
+        value: PresetType.Sound,
+        name: 'Sound',
+    },
+];

package/build/types/Project.d.ts

@@ -0,0 +1,15 @@
+import { FileInterface } from './File.js';
+import { PackageVersion } from './Package.js';
+import { ProjectFormat } from './ProjectFormat.js';
+import { ProjectType } from './ProjectType.js';
+export interface ProjectInterface extends PackageVersion {
+    files: ProjectFile[];
+    plugins: ProjectPlugins;
+    type: ProjectType;
+}
+export interface ProjectFile extends FileInterface {
+    formats: ProjectFormat[];
+}
+export interface ProjectPlugins {
+    [slug: string]: string;
+}

package/build/types/Project.js

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

package/build/types/ProjectFormat.d.ts

@@ -0,0 +1,17 @@
+export declare enum ProjectFormat {
+    AbletonLive = "als",
+    Bitwig = "bwproject",
+    Cubase = "cpr",
+    DAWproject = "dawproject",
+    FLStudio = "flp",
+    Logic = "logic",
+    ProTools = "ptx",
+    Reaper = "rpp",
+    Sonar = "cwp"
+}
+export interface ProjectFormatOption {
+    description: string;
+    value: ProjectFormat;
+    name: string;
+}
+export declare const projectFormats: ProjectFormatOption[];

package/build/types/ProjectFormat.js

@@ -0,0 +1,59 @@
+export var ProjectFormat;
+(function (ProjectFormat) {
+    ProjectFormat["AbletonLive"] = "als";
+    ProjectFormat["Bitwig"] = "bwproject";
+    ProjectFormat["Cubase"] = "cpr";
+    ProjectFormat["DAWproject"] = "dawproject";
+    ProjectFormat["FLStudio"] = "flp";
+    ProjectFormat["Logic"] = "logic";
+    ProjectFormat["ProTools"] = "ptx";
+    ProjectFormat["Reaper"] = "rpp";
+    ProjectFormat["Sonar"] = "cwp";
+})(ProjectFormat || (ProjectFormat = {}));
+export const projectFormats = [
+    {
+        description: 'Used to store all information about a Live set.',
+        value: ProjectFormat.AbletonLive,
+        name: 'Ableton Live Set',
+    },
+    {
+        description: 'Containing all Bitwig project-related information.',
+        value: ProjectFormat.Bitwig,
+        name: 'Bitwig Project',
+    },
+    {
+        description: 'Used to save Steinberg Cubase arrangements and settings.',
+        value: ProjectFormat.Cubase,
+        name: 'Cubase Project',
+    },
+    {
+        description: 'Open standard for storing various audio project settings.',
+        value: ProjectFormat.DAWproject,
+        name: 'Generic DAW Project',
+    },
+    {
+        description: 'Used for saving FL Studio compositions and arrangements.',
+        value: ProjectFormat.FLStudio,
+        name: 'FL Studio Project',
+    },
+    {
+        description: "Containing all Apple's Logic Pro audio, MIDI, and arrangement data.",
+        value: ProjectFormat.Logic,
+        name: 'Logic Pro Project',
+    },
+    {
+        description: 'Used for Avid Pro Tools audio recording and production.',
+        value: ProjectFormat.ProTools,
+        name: 'Pro Tools Project',
+    },
+    {
+        description: 'Containing Reaper tracks, arrangements, and settings.',
+        value: ProjectFormat.Reaper,
+        name: 'Reaper Project',
+    },
+    {
+        description: 'Used for Cakewalk Sonar music production and audio editing.',
+        value: ProjectFormat.Sonar,
+        name: 'Sonar Project',
+    },
+];

package/build/types/ProjectType.d.ts

@@ -0,0 +1,15 @@
+export declare enum ProjectType {
+    Audiobook = "audiobook",
+    DJSet = "dj",
+    Performance = "performance",
+    Podcast = "podcast",
+    Remix = "remix",
+    Song = "song",
+    Score = "score"
+}
+export interface ProjectTypeOption {
+    description: string;
+    value: ProjectType;
+    name: string;
+}
+export declare const projectTypes: ProjectTypeOption[];

package/build/types/ProjectType.js

@@ -0,0 +1,47 @@
+export var ProjectType;
+(function (ProjectType) {
+    ProjectType["Audiobook"] = "audiobook";
+    ProjectType["DJSet"] = "dj";
+    ProjectType["Performance"] = "performance";
+    ProjectType["Podcast"] = "podcast";
+    ProjectType["Remix"] = "remix";
+    ProjectType["Song"] = "song";
+    ProjectType["Score"] = "score";
+})(ProjectType || (ProjectType = {}));
+export const projectTypes = [
+    {
+        description: 'Spoken audio for books or literature.',
+        value: ProjectType.Audiobook,
+        name: 'Audiobook',
+    },
+    {
+        description: 'Live DJ performances, often including mixes of various tracks.',
+        value: ProjectType.DJSet,
+        name: 'DJ Set',
+    },
+    {
+        description: 'Solo or ensemble musical performance, showcasing artistic expression.',
+        value: ProjectType.Performance,
+        name: 'Performance',
+    },
+    {
+        description: 'Discussions, interviews, or other content for audio broadcast.',
+        value: ProjectType.Podcast,
+        name: 'Podcast',
+    },
+    {
+        description: 'Reworking or improving an existing song or track to create a new version.',
+        value: ProjectType.Remix,
+        name: 'Remix',
+    },
+    {
+        description: 'Composing, recording, and producing original songs with multiple instruments and vocals.',
+        value: ProjectType.Song,
+        name: 'Song',
+    },
+    {
+        description: 'Composing and producing music for film, TV, video games, or other visual media.',
+        value: ProjectType.Score,
+        name: 'Score',
+    },
+];

package/build/types/Registry.d.ts

@@ -0,0 +1,10 @@
+import { PackageInterface } from './Package.js';
+export interface RegistryInterface {
+    name: string;
+    packages: RegistryPackages;
+    url: string;
+    version: string;
+}
+export interface RegistryPackages {
+    [slug: string]: PackageInterface;
+}

package/build/types/Registry.js

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

package/build/types/System.d.ts

@@ -0,0 +1,6 @@
+import { SystemType } from './SystemType.js';
+export interface System {
+    max?: number;
+    min?: number;
+    type: SystemType;
+}

package/build/types/System.js

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

package/build/types/SystemType.d.ts

@@ -0,0 +1,11 @@
+export declare enum SystemType {
+    Macintosh = "mac",
+    Linux = "linux",
+    Windows = "win"
+}
+export interface SystemTypeOption {
+    description: string;
+    value: SystemType;
+    name: string;
+}
+export declare const systemTypes: SystemTypeOption[];

package/build/types/SystemType.js

@@ -0,0 +1,23 @@
+export var SystemType;
+(function (SystemType) {
+    SystemType["Macintosh"] = "mac";
+    SystemType["Linux"] = "linux";
+    SystemType["Windows"] = "win";
+})(SystemType || (SystemType = {}));
+export const systemTypes = [
+    {
+        description: 'Open-source operating system. One of the most widely used for IT computers and servers.',
+        value: SystemType.Linux,
+        name: 'Linux',
+    },
+    {
+        description: 'Operating system designed and sold by Apple, and is known for its ease of use.',
+        value: SystemType.Macintosh,
+        name: 'Macintosh',
+    },
+    {
+        description: 'Most popular home operating system, preloaded on most new personal computers.',
+        value: SystemType.Windows,
+        name: 'Windows',
+    },
+];

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@open-audio-stack/core",
+  "version": "0.0.1",
+  "description": "Open-source audio plugin management software",
+  "type": "module",
+  "main": "./build/index.js",
+  "exports": {
+    "node": "./build/index.js",
+    "default": "./build/index-browser.js"
+  },
+  "types": "./build/index.d.ts",
+  "files": [
+    "build"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "dev": "tsx ./src/index.ts",
+    "format": "prettier . --write",
+    "lint": "eslint .",
+    "start": "node build/index.js",
+    "test": "vitest run --config vitest.config.ts",
+    "test:watch": "vitest ./tests"
+  },
+  "author": "kmturley",
+  "license": "cc0-1.0",
+  "keywords": [
+    "open",
+    "audio",
+    "stack",
+    "plugin",
+    "package",
+    "manager"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.12.0",
+    "@types/adm-zip": "^0.5.5",
+    "@types/fs-extra": "^11.0.4",
+    "@types/js-yaml": "^4.0.9",
+    "@types/node": "^22.7.8",
+    "@types/semver": "^7.5.8",
+    "@vitest/coverage-v8": "^2.1.3",
+    "eslint": "^9.12.0",
+    "globals": "^15.2.0",
+    "prettier": "^3.2.5",
+    "tsx": "^4.10.1",
+    "typescript": "^5.6.3",
+    "typescript-eslint": "^8.9.0",
+    "vitest": "^2.1.3"
+  },
+  "dependencies": {
+    "adm-zip": "^0.5.16",
+    "fs-extra": "^11.2.0",
+    "glob": "^11.0.0",
+    "js-yaml": "^4.1.0",
+    "semver": "^7.6.3"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/open-audio-stack/open-audio-stack-core.git"
+  }
+}