@open-audio-stack/core 0.1.20 → 0.1.22

package/build/classes/Base.d.ts

@@ -1,10 +1,10 @@
 import { PackageValidationRec } from '../types/Package.js';
 import { ZodIssue } from 'zod';
 export declare class Base {
-    debug: boolean;
+    get debug(): boolean;
     log(...args: any): void;
-    logEnable(): boolean;
-    logDisable(): boolean;
+    logEnable(): void;
+    logDisable(): void;
     logErrors(errors: ZodIssue[]): void;
     logRecommendations(recs: PackageValidationRec[]): void;
     logReport(info: string, errors?: ZodIssue[], recs?: PackageValidationRec[]): void;

package/build/classes/Base.js

@@ -1,46 +1,24 @@
-import chalk from 'chalk';
-import { logEnable, logDisable } from '../helpers/utils.js';
+import { Logger } from './Logger.js';
 export class Base {
-    debug = false;
+    get debug() {
+        return Logger.debug;
+    }
     log(...args) {
-        if (this.debug)
-            console.log(...args);
+        Logger.log(...args);
     }
     logEnable() {
-        logEnable();
-        return (this.debug = true);
+        Logger.logEnable();
     }
     logDisable() {
-        logDisable();
-        return (this.debug = false);
+        Logger.logDisable();
     }
     logErrors(errors) {
-        errors.forEach(error => {
-            // @ts-expect-error need to filter by code.
-            if (error.received) {
-                this.log(chalk.red(
-                // @ts-expect-error need to filter by code.
-                `- ${error.path} (${error.message}) received '${error.received}' expected '${error.expected}'`));
-            }
-            else {
-                this.log(chalk.red(`- ${error.path} (${error.message})`));
-            }
-        });
+        Logger.logErrors(errors);
     }
     logRecommendations(recs) {
-        recs.forEach(rec => {
-            this.log(chalk.yellow(`- ${rec.field} ${rec.rec}`));
-        });
+        Logger.logRecommendations(recs);
     }
     logReport(info, errors, recs) {
-        if (errors && errors.length > 0) {
-            this.log(chalk.red(`X ${info}`));
-            this.logErrors(errors);
-        }
-        else {
-            this.log(chalk.green(`✓ ${info}`));
-        }
-        if (recs)
-            this.logRecommendations(recs);
+        Logger.logReport(info, errors, recs);
     }
 }

package/build/classes/Logger.d.ts

@@ -0,0 +1,11 @@
+import { PackageValidationRec } from '../types/Package.js';
+import { ZodIssue } from 'zod';
+export declare class Logger {
+    static debug: boolean;
+    static log(...args: any): void;
+    static logEnable(): boolean;
+    static logDisable(): boolean;
+    static logErrors(errors: ZodIssue[]): void;
+    static logRecommendations(recs: PackageValidationRec[]): void;
+    static logReport(info: string, errors?: ZodIssue[], recs?: PackageValidationRec[]): void;
+}

package/build/classes/Logger.js

@@ -0,0 +1,46 @@
+import chalk from 'chalk';
+import { logEnable, logDisable } from '../helpers/utils.js';
+export class Logger {
+    static debug = false;
+    static log(...args) {
+        if (this.debug)
+            console.log(...args);
+    }
+    static logEnable() {
+        logEnable();
+        return (this.debug = true);
+    }
+    static logDisable() {
+        logDisable();
+        return (this.debug = false);
+    }
+    static logErrors(errors) {
+        errors.forEach(error => {
+            // @ts-expect-error need to filter by code.
+            if (error.received) {
+                this.log(chalk.red(
+                // @ts-expect-error need to filter by code.
+                `- ${error.path} (${error.message}) received '${error.received}' expected '${error.expected}'`));
+            }
+            else {
+                this.log(chalk.red(`- ${error.path} (${error.message})`));
+            }
+        });
+    }
+    static logRecommendations(recs) {
+        recs.forEach(rec => {
+            this.log(chalk.yellow(`- ${rec.field} ${rec.rec}`));
+        });
+    }
+    static logReport(info, errors, recs) {
+        if (errors && errors.length > 0) {
+            this.log(chalk.red(`X ${info}`));
+            this.logErrors(errors);
+        }
+        else {
+            this.log(chalk.green(`✓ ${info}`));
+        }
+        if (recs)
+            this.logRecommendations(recs);
+    }
+}

package/build/classes/ManagerLocal.js

@@ -1,7 +1,7 @@
 import path from 'path';
 import { Package } from './Package.js';
 import { Manager } from './Manager.js';
-import { archiveExtract, dirCreate, dirDelete, dirEmpty, dirRead, fileCreate, fileCreateJson, fileCreateYaml, fileExists, fileHash, fileInstall, fileOpen, fileReadJson, fileReadYaml, filesMove, isAdmin, runCliAsAdmin, } from '../helpers/file.js';
+import { archiveExtract, dirCreate, dirDelete, dirEmpty, dirMove, dirRead, fileCreate, fileCreateJson, fileCreateYaml, fileExists, fileHash, fileInstall, fileOpen, fileReadJson, fileReadYaml, filesMove, isAdmin, runCliAsAdmin, } from '../helpers/file.js';
 import { isValidVersion, pathGetSlug, pathGetVersion, toSlug } from '../helpers/utils.js';
 import { commandExists, getArchitecture, getSystem, isTests } from '../helpers/utilsLocal.js';
 import { apiBuffer } from '../helpers/api.js';
@@ -14,7 +14,7 @@ import { presetFormatDir } from '../types/PresetFormat.js';
 import { projectFormatDir } from '../types/ProjectFormat.js';
 import { FileFormat } from '../types/FileFormat.js';
 import { licenses } from '../types/License.js';
-import { pluginTypes } from '../types/PluginType.js';
+import { PluginType, pluginTypes } from '../types/PluginType.js';
 import { presetTypes } from '../types/PresetType.js';
 import { projectTypes } from '../types/ProjectType.js';
 import { SystemType } from '../types/SystemType.js';
@@ -114,7 +114,11 @@ export class ManagerLocal extends Manager {
     scan(ext = 'json', installable = true) {
         const filePaths = dirRead(`${this.typeDir}/**/index.${ext}`);
         filePaths.forEach((filePath) => {
-            const subPath = filePath.replace(`${this.typeDir}/`, '');
+            let subPath = filePath.replace(`${this.typeDir}/`, '');
+            // TODO improve this code.
+            const parts = subPath.split('/');
+            parts.shift();
+            subPath = parts.join('/');
             const pkgJson = ext === 'yaml' ? fileReadYaml(filePath) : fileReadJson(filePath);
             if (installable)
                 pkgJson.installed = true;
@@ -151,6 +155,7 @@ export class ManagerLocal extends Manager {
         return true;
     }
     async install(slug, version) {
+        this.log('install', slug, version);
         // Get package information from registry.
         const pkg = this.getPackage(slug);
         if (!pkg)
@@ -159,13 +164,17 @@ export class ManagerLocal extends Manager {
         const pkgVersion = pkg?.getVersion(versionNum);
         if (!pkgVersion)
             return this.log(`Package ${slug} version ${versionNum} not found in registry`);
-        if (pkgVersion.installed)
+        if (pkgVersion.installed) {
+            this.log(`Package ${slug} version ${versionNum} already installed`);
             return pkgVersion;
+        }
         // Elevate permissions if not running as admin.
         if (!isAdmin() && !isTests()) {
-            let command = `--operation install --type ${this.type} --slug ${slug}`;
+            let command = `--appDir "${this.config.get('appDir')}" --operation "install" --type "${this.type}" --id "${slug}"`;
             if (version)
-                command += ` --ver ${version}`;
+                command += ` --ver "${version}"`;
+            if (this.debug)
+                command += ` --log`;
             await runCliAsAdmin(command);
             return this.getPackage(slug)?.getVersion(versionNum);
         }
@@ -214,12 +223,21 @@ export class ManagerLocal extends Manager {
                 if (this.type === RegistryType.Projects)
                     formatDir = projectFormatDir;
                 archiveExtract(filePath, dirSource);
-                const filesMoved = filesMove(dirSource, this.typeDir, dirSub, formatDir);
-                // Output json metadata into every directory a file was added to.
-                filesMoved.forEach((fileMoved) => {
-                    const fileJson = path.join(path.dirname(fileMoved), 'index.json');
-                    fileCreateJson(fileJson, pkgVersion);
-                });
+                // Move entire directory, maintaining the same folder structure.
+                if (pkgVersion.type === PluginType.Sampler) {
+                    const dirTarget = path.join(this.typeDir, PluginType.Sampler, dirSub);
+                    dirCreate(dirTarget);
+                    dirMove(dirSource, dirTarget);
+                    fileCreateJson(path.join(dirTarget, 'index.json'), pkgVersion);
+                }
+                else {
+                    // Move only supported file extensions into their respective installation directories.
+                    const filesMoved = filesMove(dirSource, this.typeDir, dirSub, formatDir);
+                    filesMoved.forEach((fileMoved) => {
+                        const fileJson = path.join(path.dirname(fileMoved), 'index.json');
+                        fileCreateJson(fileJson, pkgVersion);
+                    });
+                }
             }
         }
         pkgVersion.installed = true;
@@ -229,6 +247,7 @@ export class ManagerLocal extends Manager {
         // Get dependency package information from registry.
         const manager = new ManagerLocal(type, this.config.config);
         await manager.sync();
+        manager.scan();
         const pkg = manager.getPackage(slug);
         if (!pkg)
             return this.log(`Package ${slug} not found in registry`);
@@ -256,6 +275,7 @@ export class ManagerLocal extends Manager {
         const pkgFile = packageLoadFile(filePath);
         const manager = new ManagerLocal(type, this.config.config);
         await manager.sync();
+        manager.scan();
         for (const slug in pkgFile[type]) {
             await manager.install(slug, pkgFile[type][slug]);
         }
@@ -282,9 +302,11 @@ export class ManagerLocal extends Manager {
             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}`;
+            let command = `--appDir "${this.config.get('appDir')}" --operation "install" --type "${this.type}" --id "${slug}"`;
             if (version)
-                command += ` --ver ${version}`;
+                command += ` --ver "${version}"`;
+            if (this.debug)
+                command += ` --log`;
             await runCliAsAdmin(command);
             return this.getPackage(slug)?.getVersion(versionNum);
         }
@@ -318,6 +340,7 @@ export class ManagerLocal extends Manager {
         // Uninstall dependency.
         const manager = new ManagerLocal(type, this.config.config);
         await manager.sync();
+        manager.scan();
         await manager.uninstall(slug, version || pkgFile[type][slug]);
         // Remove dependency from local package file and save.
         if (!pkgFile[type])
@@ -332,6 +355,7 @@ export class ManagerLocal extends Manager {
         const pkgFile = packageLoadFile(filePath);
         const manager = new ManagerLocal(type, this.config.config);
         await manager.sync();
+        manager.scan();
         for (const slug in pkgFile[type]) {
             await manager.uninstall(slug, pkgFile[type][slug]);
         }

package/build/classes/Package.js

@@ -17,8 +17,8 @@ export class Package extends Base {
         this.version = this.latestVersion();
     }
     addVersion(num, version) {
-        if (this.versions.has(num))
-            return;
+        // For now allow package versions to be overwritten.
+        // if (this.versions.has(num)) return this.log(`Package ${version.name} version ${num} already exists`);
         const errors = packageErrors(version);
         const recs = packageRecommendations(version);
         const report = {
@@ -27,10 +27,8 @@ export class Package extends Base {
         };
         if (Object.keys(report).length > 0)
             this.reports.set(num, report);
-        if (errors.length > 0) {
-            this.log(errors);
-            return;
-        }
+        if (errors.length > 0)
+            return this.log(`Package ${version.name} version ${num} errors`, errors);
         this.versions.set(num, version);
         this.version = this.latestVersion();
     }

package/build/helpers/admin.d.ts

@@ -1,9 +1,11 @@
 import { RegistryType } from '../types/Registry.js';
 export interface Arguments {
+    appDir: string;
     operation: string;
     type: RegistryType;
     id: string;
-    ver: string;
+    version?: string;
+    log?: boolean;
 }
 export declare function adminArguments(): Arguments;
 export declare function adminInit(): Promise<void>;

package/build/helpers/admin.js

@@ -1,29 +1,52 @@
 // Run when Electron needs elevated privileges
 // npm run build && node ./build/helpers/admin.js --operation install --type plugins --id surge-synthesizer/surge
 // npm run build && node ./build/helpers/admin.js --operation uninstall --type plugins --id surge-synthesizer/surge
+import { RegistryType } from '../types/Registry.js';
 import { ManagerLocal } from '../classes/ManagerLocal.js';
 import { dirApp } from './file.js';
-import { log } from './utils.js';
 export function adminArguments() {
-    return {
-        operation: process.argv[3],
-        type: process.argv[5],
-        id: process.argv[7],
-        ver: process.argv[9],
+    const args = {
+        appDir: dirApp(),
+        operation: 'install',
+        type: RegistryType.Plugins,
+        id: 'surge-synthesizer/surge',
     };
+    for (let i = 0; i < process.argv.length; i++) {
+        const arg = process.argv[i];
+        if (arg === '--appDir') {
+            args.appDir = process.argv[i + 1];
+        }
+        else if (arg === '--operation') {
+            args.operation = process.argv[i + 1];
+        }
+        else if (arg === '--type') {
+            args.type = process.argv[i + 1];
+        }
+        else if (arg === '--id') {
+            args.id = process.argv[i + 1];
+        }
+        else if (arg === '--ver') {
+            args.version = process.argv[i + 1];
+        }
+        else if (arg === '--log') {
+            args.log = true;
+        }
+    }
+    return args;
 }
 export async function adminInit() {
-    const argv = adminArguments();
-    const manager = new ManagerLocal(argv.type, { appDir: dirApp() });
+    const args = adminArguments();
+    const manager = new ManagerLocal(args.type, { appDir: args.appDir });
+    if (args.log)
+        manager.logEnable();
+    manager.log('adminInit', args);
     await manager.sync();
-    if (argv.operation === 'install') {
-        await manager.install(argv.id, argv.ver);
-    }
-    else if (argv.operation === 'uninstall') {
-        await manager.uninstall(argv.id, argv.ver);
+    manager.scan();
+    if (args.operation === 'install') {
+        await manager.install(args.id, args.version);
     }
-    else {
-        log('Missing --operation argument');
+    else if (args.operation === 'uninstall') {
+        await manager.uninstall(args.id, args.version);
     }
 }
 adminInit();

package/build/helpers/file.js

@@ -312,6 +312,7 @@ export function runCliAsAdmin(args) {
         const filename = fileURLToPath(import.meta.url).replace('src/', 'build/');
         const dirPathClean = dirname(filename).replace('app.asar', 'app.asar.unpacked');
         const script = path.join(dirPathClean, 'admin.js');
+        log(`node "${script}" ${args}`);
         sudoPrompt.exec(`node "${script}" ${args}`, { name: 'Open Audio Stack' }, (error, stdout, stderr) => {
             if (stdout) {
                 log('runCliAsAdmin', stdout);

package/package.json

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