@open-audio-stack/core 0.1.17 → 0.1.18

package/build/classes/Base.js

@@ -1,4 +1,5 @@
 import chalk from 'chalk';
+import { logEnable, logDisable } from '../helpers/utils.js';
 export class Base {
     debug = false;
     log(...args) {
@@ -6,9 +7,11 @@ export class Base {
             console.log(...args);
     }
     logEnable() {
+        logEnable();
         return (this.debug = true);
     }
     logDisable() {
+        logDisable();
         return (this.debug = false);
     }
     logErrors(errors) {

package/build/classes/ManagerLocal.js

@@ -154,11 +154,11 @@ export class ManagerLocal extends Manager {
         // Get package information from registry.
         const pkg = this.getPackage(slug);
         if (!pkg)
-            return console.error(`Package ${slug} not found in registry`);
+            return this.log(`Package ${slug} not found in registry`);
         const versionNum = version || pkg.latestVersion();
         const pkgVersion = pkg?.getVersion(versionNum);
         if (!pkgVersion)
-            return console.error(`Package ${slug} version ${versionNum} not found in registry`);
+            return this.log(`Package ${slug} version ${versionNum} not found in registry`);
         if (pkgVersion.installed)
             return pkgVersion;
         // Elevate permissions if not running as admin.
@@ -184,7 +184,7 @@ export class ManagerLocal extends Manager {
         // Filter for compatible files and download.
         const files = packageCompatibleFiles(pkgVersion, [getArchitecture()], [getSystem()], excludedFormats);
         if (!files.length)
-            return console.error(`Error: No compatible files found for ${slug}`);
+            return this.log(`Error: No compatible files found for ${slug}`);
         for (const key in files) {
             // Download file to temporary directory if not already downloaded.
             const file = files[key];
@@ -196,7 +196,7 @@ export class ManagerLocal extends Manager {
             // Check file hash matches expected hash.
             const hash = await fileHash(filePath);
             if (hash !== file.sha256)
-                return console.error(`Error: ${filePath} hash mismatch`);
+                return this.log(`Error: ${filePath} hash mismatch`);
             // If installer, run the installer headless (without the user interface).
             if (file.type === FileType.Installer) {
                 if (isTests())
@@ -231,15 +231,15 @@ export class ManagerLocal extends Manager {
         await manager.sync();
         const pkg = manager.getPackage(slug);
         if (!pkg)
-            return console.error(`Package ${slug} not found in registry`);
+            return this.log(`Package ${slug} not found in registry`);
         const versionNum = version || pkg.latestVersion();
         const pkgVersion = pkg?.getVersion(versionNum);
         if (!pkgVersion)
-            return console.error(`Package ${slug} version ${versionNum} not found in registry`);
+            return this.log(`Package ${slug} version ${versionNum} not found in registry`);
         // Get local package file.
         const pkgFile = packageLoadFile(filePath);
         if (pkgFile[type] && pkgFile[type][slug] && pkgFile[type][slug] === versionNum) {
-            return console.error(`Package ${slug} version ${versionNum} is already a dependency`);
+            return this.log(`Package ${slug} version ${versionNum} is already a dependency`);
         }
         // Install dependency.
         await manager.install(slug, version);
@@ -273,13 +273,13 @@ export class ManagerLocal extends Manager {
         // Get package information from registry.
         const pkg = this.getPackage(slug);
         if (!pkg)
-            return console.error(`Package ${slug} not found in registry`);
+            return this.log(`Package ${slug} not found in registry`);
         const versionNum = version || pkg.latestVersion();
         const pkgVersion = pkg?.getVersion(versionNum);
         if (!pkgVersion)
-            return console.error(`Package ${slug} version ${versionNum} not found in registry`);
+            return this.log(`Package ${slug} version ${versionNum} not found in registry`);
         if (!pkgVersion.installed)
-            return console.error(`Package ${slug} version ${versionNum} not installed`);
+            return this.log(`Package ${slug} version ${versionNum} not installed`);
         // Elevate permissions if not running as admin.
         if (!isAdmin() && !isTests()) {
             let command = `--operation uninstall --type ${this.type} --slug ${slug}`;
@@ -312,9 +312,9 @@ export class ManagerLocal extends Manager {
         // Get local package file.
         const pkgFile = packageLoadFile(filePath);
         if (!pkgFile[type])
-            return console.error(`Package ${type} is missing`);
+            return this.log(`Package ${type} is missing`);
         if (!pkgFile[type][slug])
-            return console.error(`Package ${type} ${slug} is not a dependency`);
+            return this.log(`Package ${type} ${slug} is not a dependency`);
         // Uninstall dependency.
         const manager = new ManagerLocal(type, this.config.config);
         await manager.sync();

package/build/classes/Package.js

@@ -10,7 +10,7 @@ export class Package extends Base {
     constructor(slug, versions) {
         super();
         if (!isValidSlug(slug))
-            console.error('Invalid package slug', slug);
+            this.log('Invalid package slug', slug);
         this.reports = new Map();
         this.slug = slug;
         this.versions = versions ? new Map(Object.entries(versions)) : new Map();
@@ -28,7 +28,7 @@ export class Package extends Base {
         if (Object.keys(report).length > 0)
             this.reports.set(num, report);
         if (errors.length > 0) {
-            console.error(errors);
+            this.log(errors);
             return;
         }
         this.versions.set(num, version);

package/build/helpers/admin.js

@@ -3,6 +3,7 @@
 // npm run build && node ./build/helpers/admin.js --operation uninstall --type plugins --id surge-synthesizer/surge
 import { ManagerLocal } from '../classes/ManagerLocal.js';
 import { dirApp } from './file.js';
+import { log } from './utils.js';
 export function adminArguments() {
     return {
         operation: process.argv[3],
@@ -22,7 +23,7 @@ export async function adminInit() {
         await manager.uninstall(argv.id, argv.ver);
     }
     else {
-        console.error('Missing --operation argument');
+        log('Missing --operation argument');
     }
 }
 adminInit();

package/build/helpers/api.js

@@ -1,12 +1,13 @@
+import { log } from './utils.js';
 export async function apiBuffer(url) {
-    console.log('⤓', url);
+    log('⤓', url);
     return fetch(url).then((res) => res.arrayBuffer());
 }
 export async function apiJson(url) {
-    console.log('⤓', url);
+    log('⤓', url);
     return fetch(url).then((res) => res.json());
 }
 export async function apiText(url) {
-    console.log('⤓', url);
+    log('⤓', url);
     return fetch(url).then((res) => res.text());
 }

package/build/helpers/file.js

@@ -15,8 +15,9 @@ import { SystemType } from '../types/SystemType.js';
 import { fileURLToPath } from 'url';
 import sudoPrompt from '@vscode/sudo-prompt';
 import { getSystem } from './utilsLocal.js';
+import { log } from './utils.js';
 export async function archiveExtract(filePath, dirPath) {
-    console.log('⎋', dirPath);
+    log('⎋', dirPath);
     const ext = path.extname(filePath).trim().toLowerCase();
     if (ext === '.zip') {
         const zip = new AdmZip(filePath);
@@ -47,7 +48,7 @@ export function dirContains(parentDir, childDir) {
 }
 export function dirCreate(dir) {
     if (!dirExists(dir)) {
-        console.log('+', dir);
+        log('+', dir);
         mkdirSync(dir, { recursive: true });
         return dir;
     }
@@ -55,7 +56,7 @@ export function dirCreate(dir) {
 }
 export function dirDelete(dir) {
     if (dirExists(dir)) {
-        console.log('-', dir);
+        log('-', dir);
         return rmSync(dir, { recursive: true });
     }
     return false;
@@ -72,8 +73,8 @@ export function dirIs(dir) {
 }
 export function dirMove(dir, dirNew) {
     if (dirExists(dir)) {
-        console.log('-', dir);
-        console.log('+', dirNew);
+        log('-', dir);
+        log('+', dirNew);
         return moveSync(dir, dirNew, { overwrite: true });
     }
     return false;
@@ -88,7 +89,7 @@ export function dirOpen(dir) {
         command = 'open';
     else
         command = 'xdg-open';
-    console.log('⎋', `${command} "${dir}"`);
+    log('⎋', `${command} "${dir}"`);
     return execSync(`${command} "${dir}"`);
 }
 export function dirPackage(pkg) {
@@ -120,7 +121,7 @@ export function dirProjects() {
     return path.join(os.homedir(), 'Documents', 'Audio');
 }
 export function dirRead(dir, options) {
-    console.log('⌕', dir);
+    log('⌕', dir);
     // Glob now expects forward slashes on Windows
     // Convert backslashes from path.join() to forwardslashes
     if (getSystem() === SystemType.Win) {
@@ -135,7 +136,7 @@ export function dirRename(dir, dirNew) {
     return false;
 }
 export function fileCreate(filePath, data) {
-    console.log('+', filePath);
+    log('+', filePath);
     return writeFileSync(filePath, data);
 }
 export function fileCreateJson(filePath, data) {
@@ -149,7 +150,7 @@ export function fileDate(filePath) {
 }
 export function fileDelete(filePath) {
     if (fileExists(filePath)) {
-        console.log('-', filePath);
+        log('-', filePath);
         return unlinkSync(filePath);
     }
     return false;
@@ -161,7 +162,7 @@ export function fileExists(filePath) {
     return existsSync(filePath);
 }
 export async function fileHash(filePath, algorithm = 'sha256') {
-    console.log('⎋', filePath);
+    log('⎋', filePath);
     const input = createReadStream(filePath);
     const hash = createHash(algorithm);
     await stream.pipeline(input, hash);
@@ -194,13 +195,13 @@ export function fileInstall(filePath) {
         default:
             throw new Error(`Unsupported file format: ${ext}`);
     }
-    console.log('⎋', command);
+    log('⎋', command);
     return execSync(command, { stdio: 'inherit' });
 }
 export function fileMove(filePath, newPath) {
     if (fileExists(filePath)) {
-        console.log('-', filePath);
-        console.log('+', newPath);
+        log('-', filePath);
+        log('+', newPath);
         return moveSync(filePath, newPath, { overwrite: true });
     }
     return false;
@@ -217,10 +218,10 @@ export function filesMove(dirSource, dirTarget, dirSub, formatDir) {
         const fileExtTarget = formatDir[fileExt];
         // If this is not a supported file format, then ignore.
         if (fileExtTarget === undefined)
-            return console.error(`${fileSource} - ${fileExt} not mapped to a installation folder, skipping.`);
+            return log(`${fileSource} - ${fileExt} not mapped to a installation folder, skipping.`);
         const fileTarget = path.join(dirTarget, fileExtTarget, dirSub, path.basename(fileSource));
         if (fileExists(fileTarget))
-            return console.error(`${fileSource} - ${fileTarget} already exists, skipping.`);
+            return log(`${fileSource} - ${fileTarget} already exists, skipping.`);
         dirCreate(path.dirname(fileTarget));
         fileMove(fileSource, fileTarget);
         filesMoved.push(fileTarget);
@@ -237,22 +238,22 @@ export function fileOpen(filePath) {
         command = 'open';
     else
         command = 'xdg-open';
-    console.log('⎋', `${command} "${filePath}"`);
+    log('⎋', `${command} "${filePath}"`);
     return execSync(`${command} "${filePath}"`);
 }
 export function fileRead(filePath) {
-    console.log('⎋', filePath);
+    log('⎋', filePath);
     return readFileSync(filePath, 'utf8');
 }
 export function fileReadJson(filePath) {
     if (fileExists(filePath)) {
-        console.log('⎋', filePath);
+        log('⎋', filePath);
         return JSON.parse(readFileSync(filePath, 'utf8').toString());
     }
     return false;
 }
 export function fileReadString(filePath) {
-    console.log('⎋', filePath);
+    log('⎋', filePath);
     return readFileSync(filePath, 'utf8').toString();
 }
 export function fileReadYaml(filePath) {
@@ -313,10 +314,10 @@ export function runCliAsAdmin(args) {
         const script = path.join(dirPathClean, 'admin.js');
         sudoPrompt.exec(`node "${script}" ${args}`, { name: 'Open Audio Stack' }, (error, stdout, stderr) => {
             if (stdout) {
-                console.log('runCliAsAdmin', stdout);
+                log('runCliAsAdmin', stdout);
             }
             if (stderr) {
-                console.log('runCliAsAdmin', stderr);
+                log('runCliAsAdmin', stderr);
             }
             if (error) {
                 reject(error);
@@ -334,7 +335,7 @@ export function zipCreate(filesPath, zipPath) {
     const zip = new AdmZip();
     const pathList = dirRead(filesPath);
     pathList.forEach(pathItem => {
-        console.log('⎋', pathItem);
+        log('⎋', pathItem);
         try {
             if (dirIs(pathItem)) {
                 zip.addLocalFolder(pathItem, path.basename(pathItem));
@@ -344,9 +345,9 @@ export function zipCreate(filesPath, zipPath) {
             }
         }
         catch (error) {
-            console.error(error);
+            log(error);
         }
     });
-    console.log('+', zipPath);
+    log('+', zipPath);
     return zip.writeZip(zipPath);
 }

package/build/helpers/package.d.ts

@@ -87,7 +87,6 @@ export declare const PackageTypeObj: {
     Effect: PluginType.Effect;
     Generator: PluginType.Generator;
     Instrument: PluginType.Instrument;
-    Preset: PluginType.Preset;
     Sampler: PluginType.Sampler;
     Tool: PluginType.Tool;
 };
@@ -160,7 +159,6 @@ export declare const PackageVersionValidator: z.ZodObject<{
         Effect: PluginType.Effect;
         Generator: PluginType.Generator;
         Instrument: PluginType.Instrument;
-        Preset: PluginType.Preset;
         Sampler: PluginType.Sampler;
         Tool: PluginType.Tool;
     }>;

package/build/helpers/packageLocal.js

@@ -1,18 +1,18 @@
 import path from 'path';
 import { fileCreateJson, fileReadJson } from './file.js';
 import { Package } from '../classes/Package.js';
-import { pathGetSlug, pathGetVersion } from './utils.js';
+import { log, pathGetSlug, pathGetVersion } from './utils.js';
 export function packageLoadFile(filePath) {
     // Read the file path and parse as json.
     if (!filePath)
         filePath = path.join('.', 'index.json');
     const pkgFile = fileReadJson(filePath);
     if (!pkgFile)
-        console.error(filePath, `not a valid json file`);
+        log(filePath, `not a valid json file`);
     // Validate package json file structure, fields and values.
     const pkg = new Package(pathGetSlug(filePath));
     pkg.addVersion(pathGetVersion(filePath), pkgFile);
-    console.log(JSON.stringify(pkg.getReport()));
+    log(JSON.stringify(pkg.getReport()));
     return pkgFile;
 }
 export function packageSaveFile(pkgFile, filePath) {

package/build/helpers/utils.d.ts

@@ -1,4 +1,7 @@
 export declare function inputGetParts(input: string): string[];
+export declare function log(...args: any): void;
+export declare function logEnable(): boolean;
+export declare function logDisable(): boolean;
 export declare function pathGetDirectory(path: string, sep?: string): string;
 export declare function pathGetExt(path: string, sep?: string): string;
 export declare function pathGetFilename(path: string, sep?: string): string;

package/build/helpers/utils.js

@@ -1,9 +1,20 @@
 import * as semver from 'semver';
 import slugify from 'slugify';
+let DEBUG = false;
 const URLSAFE_REGEX = /[^\w\s$*_+~.()'"!\-:@/]+/g;
 export function inputGetParts(input) {
     return input.split('@');
 }
+export function log(...args) {
+    if (DEBUG)
+        console.log(...args);
+}
+export function logEnable() {
+    return (DEBUG = true);
+}
+export function logDisable() {
+    return (DEBUG = false);
+}
 export function pathGetDirectory(path, sep = '/') {
     return path.substring(0, path.lastIndexOf(sep));
 }

package/build/types/PluginType.d.ts

@@ -2,7 +2,6 @@ export declare enum PluginType {
     Effect = "effect",
     Generator = "generator",
     Instrument = "instrument",
-    Preset = "preset",
     Sampler = "sampler",
     Tool = "tool"
 }

package/build/types/PluginType.js

@@ -3,7 +3,6 @@ export var PluginType;
     PluginType["Effect"] = "effect";
     PluginType["Generator"] = "generator";
     PluginType["Instrument"] = "instrument";
-    PluginType["Preset"] = "preset";
     PluginType["Sampler"] = "sampler";
     PluginType["Tool"] = "tool";
 })(PluginType || (PluginType = {}));
@@ -23,11 +22,6 @@ export const pluginTypes = [
         value: PluginType.Instrument,
         name: 'Instrument',
     },
-    {
-        description: 'Preset containing predefined settings for an instrument or effect.',
-        value: PluginType.Preset,
-        name: 'Preset',
-    },
     {
         description: 'Sample playback based on audio or midi input.',
         value: PluginType.Sampler,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-audio-stack/core",
-  "version": "0.1.17",
+  "version": "0.1.18",
   "description": "Open-source audio plugin management software",
   "type": "module",
   "main": "./build/index.js",
@@ -44,14 +44,14 @@
     "@types/js-yaml": "^4.0.9",
     "@types/node": "^22.7.8",
     "@types/semver": "^7.5.8",
-    "@vitest/coverage-v8": "^2.1.3",
+    "@vitest/coverage-v8": "^3.0.5",
     "eslint": "^9.12.0",
     "globals": "^15.2.0",
     "prettier": "^3.2.5",
-    "tsx": "^4.10.1",
+    "tsx": "^4.19.2",
     "typescript": "^5.6.3",
     "typescript-eslint": "^8.9.0",
-    "vitest": "^2.1.3"
+    "vitest": "^3.0.5"
   },
   "dependencies": {
     "@vscode/sudo-prompt": "^9.3.1",