@open-audio-stack/core 0.1.1 → 0.1.3

package/build/classes/Config.d.ts

@@ -10,6 +10,7 @@ import { PresetType } from '../types/PresetType.js';
 import { ProjectFormat } from '../types/ProjectFormat.js';
 import { ProjectType } from '../types/ProjectType.js';
 import { SystemType } from '../types/SystemType.js';
+import { PluginCategoryEffect, PluginCategoryInstrument } from '../types/PluginCategory.js';
 export declare class Config {
     config: ConfigInterface;
     constructor(config?: ConfigInterface);
@@ -24,6 +25,10 @@ export declare class Config {
     fileTypes(): import("../types/FileType.js").FileTypeOption[];
     license(type: License): import("../types/License.js").LicenseOption;
     licenses(): import("../types/License.js").LicenseOption[];
+    pluginCategoryEffect(effect: PluginCategoryEffect): import("../types/PluginCategory.js").PluginCategoryOption;
+    pluginCategoryEffects(): import("../types/PluginCategory.js").PluginCategoryOption[];
+    pluginCategoryInstrument(instrument: PluginCategoryInstrument): import("../types/PluginCategory.js").PluginCategoryOption;
+    pluginCategoryInstruments(): import("../types/PluginCategory.js").PluginCategoryOption[];
     pluginFormat(format: PluginFormat): import("../types/PluginFormat.js").PluginFormatOption;
     pluginFormats(): import("../types/PluginFormat.js").PluginFormatOption[];
     pluginType(type: PluginType): import("../types/PluginType.js").PluginTypeOption;

package/build/classes/Config.js

@@ -10,6 +10,7 @@ import { presetTypes } from '../types/PresetType.js';
 import { projectFormats } from '../types/ProjectFormat.js';
 import { projectTypes } from '../types/ProjectType.js';
 import { systemTypes } from '../types/SystemType.js';
+import { pluginCategoryEffects, pluginCategoryInstruments, } from '../types/PluginCategory.js';
 export class Config {
     config;
     constructor(config) {
@@ -52,6 +53,18 @@ export class Config {
         return licenses;
     }
     // Plugin formats and types.
+    pluginCategoryEffect(effect) {
+        return pluginCategoryEffects.filter(pluginCategoryEffect => effect === pluginCategoryEffect.value)[0];
+    }
+    pluginCategoryEffects() {
+        return pluginCategoryEffects;
+    }
+    pluginCategoryInstrument(instrument) {
+        return pluginCategoryInstruments.filter(pluginCategoryInstrument => instrument === pluginCategoryInstrument.value)[0];
+    }
+    pluginCategoryInstruments() {
+        return pluginCategoryInstruments;
+    }
     pluginFormat(format) {
         return pluginFormats.filter(pluginFormat => format === pluginFormat.value)[0];
     }

package/build/classes/ManagerLocal.js

@@ -2,7 +2,8 @@ import path from 'path';
 import { Package } from './Package.js';
 import { Manager } from './Manager.js';
 import { archiveExtract, dirCreate, dirDelete, dirEmpty, dirRead, fileCreate, fileCreateJson, fileExists, fileHash, fileOpen, fileReadJson, filesMove, isAdmin, runCliAsAdmin, } from '../helpers/file.js';
-import { isTests, pathGetSlug, pathGetVersion } from '../helpers/utils.js';
+import { pathGetSlug, pathGetVersion } from '../helpers/utils.js';
+import { getArchitecture, getSystem, isTests } from '../helpers/utilsLocal.js';
 import { apiBuffer } from '../helpers/api.js';
 import { FileType } from '../types/FileType.js';
 import { RegistryType } from '../types/Registry.js';
@@ -53,7 +54,7 @@ export class ManagerLocal extends Manager {
         const dirDownloads = path.join(this.config.get('appDir'), 'downloads', this.type, slug, versionNum);
         dirCreate(dirDownloads);
         // Filter for compatible files and download.
-        const files = packageCompatibleFiles(pkgVersion);
+        const files = packageCompatibleFiles(pkgVersion, [getArchitecture()], [getSystem()]);
         if (!files.length)
             return console.error(`Error: No compatible files found for ${slug}`);
         for (const key in files) {

package/build/helpers/file.js

@@ -14,7 +14,8 @@ import { ZodIssueCode } from 'zod';
 import { SystemType } from '../types/SystemType.js';
 import { fileURLToPath } from 'url';
 import sudoPrompt from '@vscode/sudo-prompt';
-import { getSystem, log } from './utils.js';
+import { log } from './utils.js';
+import { getSystem } from './utilsLocal.js';
 export async function archiveExtract(filePath, dirPath) {
     console.log('⎋', dirPath);
     const ext = path.extname(filePath).trim().toLowerCase();

package/build/helpers/package.d.ts

@@ -11,7 +11,7 @@ import { ProjectFile } from '../types/Project.js';
 import { ProjectType } from '../types/ProjectType.js';
 import { SystemType } from '../types/SystemType.js';
 import { PackageInterface, PackageValidationRec, PackageVersion } from '../types/Package.js';
-export declare function packageCompatibleFiles(pkg: PackageVersion): (PluginFile | PresetFile | ProjectFile)[];
+export declare function packageCompatibleFiles(pkg: PackageVersion, arch: Architecture[], sys: SystemType[]): (PluginFile | PresetFile | ProjectFile)[];
 export declare function packageVersionLatest(pkg: PackageInterface): string;
 export declare const PackageSystemValidator: z.ZodObject<{
     max: z.ZodOptional<z.ZodNumber>;
@@ -170,8 +170,8 @@ export declare const PackageVersionValidator: z.ZodObject<{
     }>;
     url: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    date: string;
     type: PluginType | PresetType | ProjectType;
+    date: string;
     url: string;
     audio: string;
     author: string;
@@ -195,8 +195,8 @@ export declare const PackageVersionValidator: z.ZodObject<{
     name: string;
     tags: string[];
 }, {
-    date: string;
     type: PluginType | PresetType | ProjectType;
+    date: string;
     url: string;
     audio: string;
     author: string;

package/build/helpers/package.js

@@ -8,14 +8,13 @@ import { PluginType } from '../types/PluginType.js';
 import { PresetType } from '../types/PresetType.js';
 import { ProjectType } from '../types/ProjectType.js';
 import { SystemType } from '../types/SystemType.js';
-import { getArchitecture, getSystem } from './utils.js';
-export function packageCompatibleFiles(pkg) {
+export function packageCompatibleFiles(pkg, arch, sys) {
     return pkg.files.filter((file) => {
         const archMatches = file.architectures.filter(architecture => {
-            return architecture === getArchitecture();
+            return arch.includes(architecture);
         });
         const sysMatches = file.systems.filter(system => {
-            return system.type === getSystem();
+            return sys.includes(system.type);
         });
         return archMatches.length && sysMatches.length;
     });

package/build/helpers/utils.d.ts

@@ -1,11 +1,6 @@
 import { PackageValidationRec } from '../types/Package.js';
 import { ZodIssue } from 'zod';
-import { SystemType } from '../types/SystemType.js';
-import { Architecture } from '../types/Architecture.js';
-export declare function getArchitecture(): Architecture;
-export declare function getSystem(): SystemType;
 export declare function inputGetParts(input: string): string[];
-export declare function isTests(): boolean;
 export declare function log(...args: any): boolean;
 export declare function logEnable(): boolean;
 export declare function logDisable(): boolean;

package/build/helpers/utils.js

@@ -1,31 +1,8 @@
 import chalk from 'chalk';
-import { SystemType } from '../types/SystemType.js';
-import { Architecture } from '../types/Architecture.js';
 let LOGGING_ENABLED = false;
-export function getArchitecture() {
-    if (process.arch === 'arm')
-        return Architecture.Arm32;
-    if (process.arch === 'arm64')
-        return Architecture.Arm64;
-    if (process.arch === 'ia32')
-        return Architecture.X32;
-    return Architecture.X64;
-}
-export function getSystem() {
-    if (process.platform === 'win32')
-        return SystemType.Windows;
-    else if (process.platform === 'darwin')
-        return SystemType.Macintosh;
-    return SystemType.Linux;
-}
 export function inputGetParts(input) {
     return input.split('@');
 }
-export function isTests() {
-    const jest = process.env.JEST_WORKER_ID !== undefined;
-    const vitest = process.env.VITEST_WORKER_ID !== undefined;
-    return jest || vitest;
-}
 export function log(...args) {
     if (LOGGING_ENABLED) {
         console.log(...args);

package/build/helpers/utilsLocal.d.ts

@@ -0,0 +1,5 @@
+import { SystemType } from '../types/SystemType.js';
+import { Architecture } from '../types/Architecture.js';
+export declare function getArchitecture(): Architecture;
+export declare function getSystem(): SystemType;
+export declare function isTests(): boolean;

package/build/helpers/utilsLocal.js

@@ -0,0 +1,23 @@
+import { SystemType } from '../types/SystemType.js';
+import { Architecture } from '../types/Architecture.js';
+export function getArchitecture() {
+    if (process.arch === 'arm')
+        return Architecture.Arm32;
+    if (process.arch === 'arm64')
+        return Architecture.Arm64;
+    if (process.arch === 'ia32')
+        return Architecture.X32;
+    return Architecture.X64;
+}
+export function getSystem() {
+    if (process.platform === 'win32')
+        return SystemType.Windows;
+    else if (process.platform === 'darwin')
+        return SystemType.Macintosh;
+    return SystemType.Linux;
+}
+export function isTests() {
+    const jest = process.env.JEST_WORKER_ID !== undefined;
+    const vitest = process.env.VITEST_WORKER_ID !== undefined;
+    return jest || vitest;
+}

package/build/index-browser.js

@@ -18,6 +18,7 @@ export * from './helpers/config.js';
 export * from './helpers/package.js';
 export * from './helpers/registry.js';
 export * from './helpers/utils.js';
+// export * from './helpers/utilsLocal.js';
 // Types
 export * from './types/Architecture.js';
 export * from './types/Config.js';

package/build/index.d.ts

@@ -11,6 +11,7 @@ export * from './helpers/file.js';
 export * from './helpers/package.js';
 export * from './helpers/registry.js';
 export * from './helpers/utils.js';
+export * from './helpers/utilsLocal.js';
 export * from './types/Architecture.js';
 export * from './types/Config.js';
 export * from './types/File.js';

package/build/index.js

@@ -18,6 +18,7 @@ export * from './helpers/file.js';
 export * from './helpers/package.js';
 export * from './helpers/registry.js';
 export * from './helpers/utils.js';
+export * from './helpers/utilsLocal.js';
 // Types
 export * from './types/Architecture.js';
 export * from './types/Config.js';

package/build/types/PluginCategory.d.ts

@@ -0,0 +1,24 @@
+export declare enum PluginCategoryEffect {
+    Chorus = "chorus",
+    Compression = "compression",
+    Eq = "eq",
+    Filter = "filter",
+    Reverb = "reverb"
+}
+export declare enum PluginCategoryInstrument {
+    Drums = "drums",
+    Guitar = "guitar",
+    Keys = "keys",
+    Orchestral = "orchestral",
+    Samplers = "samplers",
+    Synths = "synths",
+    Vocals = "vocals"
+}
+export interface PluginCategoryOption {
+    description: string;
+    value: PluginCategoryEffect | PluginCategoryInstrument;
+    name: string;
+    tags: string[];
+}
+export declare const pluginCategoryEffects: PluginCategoryOption[];
+export declare const pluginCategoryInstruments: PluginCategoryOption[];

package/build/types/PluginCategory.js

@@ -0,0 +1,94 @@
+export var PluginCategoryEffect;
+(function (PluginCategoryEffect) {
+    PluginCategoryEffect["Chorus"] = "chorus";
+    PluginCategoryEffect["Compression"] = "compression";
+    PluginCategoryEffect["Eq"] = "eq";
+    PluginCategoryEffect["Filter"] = "filter";
+    PluginCategoryEffect["Reverb"] = "reverb";
+})(PluginCategoryEffect || (PluginCategoryEffect = {}));
+export var PluginCategoryInstrument;
+(function (PluginCategoryInstrument) {
+    PluginCategoryInstrument["Drums"] = "drums";
+    PluginCategoryInstrument["Guitar"] = "guitar";
+    PluginCategoryInstrument["Keys"] = "keys";
+    PluginCategoryInstrument["Orchestral"] = "orchestral";
+    PluginCategoryInstrument["Samplers"] = "samplers";
+    PluginCategoryInstrument["Synths"] = "synths";
+    PluginCategoryInstrument["Vocals"] = "vocals";
+})(PluginCategoryInstrument || (PluginCategoryInstrument = {}));
+export const pluginCategoryEffects = [
+    {
+        description: 'Spatial movement and modulation.',
+        value: PluginCategoryEffect.Chorus,
+        name: 'Chorus/Phaser',
+        tags: ['Chorus', 'Phaser'],
+    },
+    {
+        description: 'Shape dynamics, grit and amplification.',
+        value: PluginCategoryEffect.Compression,
+        name: 'Compression/Distortion',
+        tags: ['Compression', 'Distortion', 'Amplifier', 'Amp'],
+    },
+    {
+        description: 'Balance frequencies and position sounds in the stereo field.',
+        value: PluginCategoryEffect.Eq,
+        name: 'EQ/Pan',
+        tags: ['EQ', 'Equalizer', 'Pan'],
+    },
+    {
+        description: 'Adjust tone and sculpt frequencies.',
+        value: PluginCategoryEffect.Filter,
+        name: 'Filter',
+        tags: ['Filter'],
+    },
+    {
+        description: 'Create depth with echoes, ambience, and space.',
+        value: PluginCategoryEffect.Reverb,
+        name: 'Reverb/Delay',
+        tags: ['Reverb', 'Delay'],
+    },
+];
+export const pluginCategoryInstruments = [
+    {
+        description: '',
+        value: PluginCategoryInstrument.Drums,
+        name: 'Drums',
+        tags: ['Drums', 'Percussion'],
+    },
+    {
+        description: '',
+        value: PluginCategoryInstrument.Guitar,
+        name: 'Guitar',
+        tags: ['Guitar', 'String'],
+    },
+    {
+        description: '',
+        value: PluginCategoryInstrument.Keys,
+        name: 'Keys',
+        tags: ['Keys', 'Piano'],
+    },
+    {
+        description: '',
+        value: PluginCategoryInstrument.Orchestral,
+        name: 'Orchestral',
+        tags: ['Orchestral', 'Orchestra', 'Strings', 'Woodwind', 'Brass'],
+    },
+    {
+        description: '',
+        value: PluginCategoryInstrument.Samplers,
+        name: 'Samplers',
+        tags: ['Samplers', 'Sampler', 'Sample'],
+    },
+    {
+        description: '',
+        value: PluginCategoryInstrument.Synths,
+        name: 'Synths',
+        tags: ['Synths', 'Synth', 'Synthesizer'],
+    },
+    {
+        description: '',
+        value: PluginCategoryInstrument.Vocals,
+        name: 'Vocals',
+        tags: ['Vocals'],
+    },
+];

package/build/types/ProjectFormat.js

@@ -31,61 +31,61 @@ export const projectFormats = [
     {
         description: 'Used to store all information about a Live set.',
         value: ProjectFormat.AbletonLive,
-        name: 'Ableton Live Project',
+        name: 'Ableton Live',
     },
     {
         description: 'Containing all Bitwig project-related information.',
         value: ProjectFormat.Bitwig,
-        name: 'Bitwig Project',
+        name: 'Bitwig',
     },
     {
         description: 'Used to save Steinberg Cubase arrangements and settings.',
         value: ProjectFormat.Cubase,
-        name: 'Cubase Project',
+        name: 'Cubase',
     },
     {
         description: 'Open standard for storing various audio project settings.',
         value: ProjectFormat.DAWproject,
-        name: 'DAWproject Project',
+        name: 'DAWproject',
     },
     {
         description: 'Used for saving FL Studio compositions and arrangements.',
         value: ProjectFormat.FLStudio,
-        name: 'FL Studio Project',
+        name: 'FL Studio',
     },
     {
         description: 'A package containing audio files and Garageband timeline and settings.',
         value: ProjectFormat.Garageband,
-        name: 'Garageband Project',
+        name: 'Garageband',
     },
     {
         description: 'Music project for open-source, cross-platform software.',
         value: ProjectFormat.Lmms,
-        name: 'LMMS Project',
+        name: 'LMMS',
     },
     {
         description: "Containing all Apple's Logic Pro audio, MIDI, and arrangement data.",
         value: ProjectFormat.Logic,
-        name: 'Logic Pro Project',
+        name: 'Logic Pro',
     },
     {
         description: 'Compressed Musescore project along with metadata and image preview.',
         value: ProjectFormat.Musescore,
-        name: 'Musescore Project',
+        name: 'Musescore',
     },
     {
         description: 'Used for Avid Pro Tools audio recording and production.',
         value: ProjectFormat.ProTools,
-        name: 'Pro Tools Project',
+        name: 'Pro Tools',
     },
     {
         description: 'Containing Reaper tracks, arrangements, and settings.',
         value: ProjectFormat.Reaper,
-        name: 'Reaper Project',
+        name: 'Reaper',
     },
     {
         description: 'Used for Cakewalk Sonar music production and audio editing.',
         value: ProjectFormat.Sonar,
-        name: 'Sonar Project',
+        name: 'Sonar',
     },
 ];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-audio-stack/core",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Open-source audio plugin management software",
   "type": "module",
   "main": "./build/index.js",