@open-audio-stack/core 0.1.4 → 0.1.6

package/build/classes/ManagerLocal.js

@@ -3,7 +3,7 @@ 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 { pathGetSlug, pathGetVersion } from '../helpers/utils.js';
-import { getArchitecture, getSystem, isTests } from '../helpers/utilsLocal.js';
+import { commandExists, 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';
@@ -12,6 +12,7 @@ import { ConfigLocal } from './ConfigLocal.js';
 import { packageCompatibleFiles } from '../helpers/package.js';
 import { presetFormatDir } from '../types/PresetFormat.js';
 import { projectFormatDir } from '../types/ProjectFormat.js';
+import { FileFormat, SystemType } from '../index-browser.js';
 export class ManagerLocal extends Manager {
     typeDir;
     constructor(type, config) {
@@ -53,8 +54,17 @@ export class ManagerLocal extends Manager {
         // Create temporary directory to store downloaded files.
         const dirDownloads = path.join(this.config.get('appDir'), 'downloads', this.type, slug, versionNum);
         dirCreate(dirDownloads);
+        // Not all Linux distributions support all file formats.
+        const excludedFormats = [];
+        const system = getSystem();
+        if (system === SystemType.Linux) {
+            if (!(await commandExists('dpkg')))
+                excludedFormats.push(FileFormat.DebianPackage);
+            if (!(await commandExists('rpm')))
+                excludedFormats.push(FileFormat.RedHatPackage);
+        }
         // Filter for compatible files and download.
-        const files = packageCompatibleFiles(pkgVersion, [getArchitecture()], [getSystem()]);
+        const files = packageCompatibleFiles(pkgVersion, [getArchitecture()], [getSystem()], excludedFormats);
         if (!files.length)
             return console.error(`Error: No compatible files found for ${slug}`);
         for (const key in files) {

package/build/helpers/file.js

@@ -37,9 +37,9 @@ export async function archiveExtract(filePath, dirPath) {
     }
 }
 export function dirApp(dirName = 'open-audio-stack') {
-    if (getSystem() === SystemType.Windows)
+    if (getSystem() === SystemType.Win)
         return process.env.APPDATA || path.join(os.homedir(), dirName);
-    else if (getSystem() === SystemType.Macintosh)
+    else if (getSystem() === SystemType.Mac)
         return path.join(os.homedir(), 'Library', 'Preferences', dirName);
     return path.join(os.homedir(), '.local', 'share', dirName);
 }
@@ -83,9 +83,9 @@ export function dirOpen(dir) {
     let command = '';
     if (process.env.CI)
         return Buffer.from('');
-    if (getSystem() === SystemType.Windows)
+    if (getSystem() === SystemType.Win)
         command = 'start ""';
-    else if (getSystem() === SystemType.Macintosh)
+    else if (getSystem() === SystemType.Mac)
         command = 'open';
     else
         command = 'xdg-open';
@@ -98,25 +98,25 @@ export function dirPackage(pkg) {
     return path.join(...parts);
 }
 export function dirPlugins() {
-    if (getSystem() === SystemType.Windows)
+    if (getSystem() === SystemType.Win)
         return path.join('Program Files', 'Common Files');
-    else if (getSystem() === SystemType.Macintosh)
+    else if (getSystem() === SystemType.Mac)
         return path.join(os.homedir(), 'Library', 'Audio', 'Plug-ins');
     return path.join('usr', 'local', 'lib');
 }
 export function dirPresets() {
-    if (getSystem() === SystemType.Windows)
+    if (getSystem() === SystemType.Win)
         return path.join(os.homedir(), 'Documents', 'VST3 Presets');
-    else if (getSystem() === SystemType.Macintosh)
+    else if (getSystem() === SystemType.Mac)
         return path.join(os.homedir(), 'Library', 'Audio', 'Presets');
     return path.join(os.homedir(), '.vst3', 'presets');
 }
 export function dirProjects() {
     // Windows throws permissions errors if you scan hidden folders
     // Therefore set to a more specific path than Documents
-    if (getSystem() === SystemType.Windows)
+    if (getSystem() === SystemType.Win)
         return path.join(os.homedir(), 'Documents', 'Audio');
-    else if (getSystem() === SystemType.Macintosh)
+    else if (getSystem() === SystemType.Mac)
         return path.join(os.homedir(), 'Documents', 'Audio');
     return path.join(os.homedir(), 'Documents', 'Audio');
 }
@@ -124,7 +124,7 @@ export function dirRead(dir, options) {
     console.log('⌕', dir);
     // Glob now expects forward slashes on Windows
     // Convert backslashes from path.join() to forwardslashes
-    if (getSystem() === SystemType.Windows) {
+    if (getSystem() === SystemType.Win) {
         dir = dir.replace(/\\/g, '/');
     }
     return globSync(dir, options);
@@ -199,10 +199,10 @@ export function fileOpen(filePath) {
     let command = '';
     if (process.env.CI)
         return Buffer.from('');
-    if (getSystem() === SystemType.Windows)
-        command = 'open';
-    else if (getSystem() === SystemType.Macintosh)
+    if (getSystem() === SystemType.Win)
         command = 'start ""';
+    else if (getSystem() === SystemType.Mac)
+        command = 'open';
     else
         command = 'xdg-open';
     console.log('⎋', `${command} "${filePath}"`);
@@ -268,10 +268,10 @@ export async function fileValidateMetadata(filePath, fileMetadata) {
     return errors;
 }
 export function getPlatform() {
-    if (getSystem() === SystemType.Windows)
-        return SystemType.Windows;
-    else if (getSystem() === SystemType.Macintosh)
-        return SystemType.Macintosh;
+    if (getSystem() === SystemType.Win)
+        return SystemType.Win;
+    else if (getSystem() === SystemType.Mac)
+        return SystemType.Mac;
     return SystemType.Linux;
 }
 export function runCliAsAdmin(args) {

package/build/helpers/package.d.ts

@@ -10,8 +10,9 @@ import { PresetType } from '../types/PresetType.js';
 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, arch: Architecture[], sys: SystemType[]): (PluginFile | PresetFile | ProjectFile)[];
+import { PackageFileMap, PackageInterface, PackageValidationRec, PackageVersion } from '../types/Package.js';
+export declare function packageCompatibleFiles(pkg: PackageVersion, arch: Architecture[], sys: SystemType[], excludedFormats?: FileFormat[]): (PluginFile | PresetFile | ProjectFile)[];
+export declare function packageFileMap(pkgVersion: PackageVersion): PackageFileMap;
 export declare function packageVersionLatest(pkg: PackageInterface): string;
 export declare const PackageSystemValidator: z.ZodObject<{
     max: z.ZodOptional<z.ZodNumber>;

package/build/helpers/package.js

@@ -8,7 +8,7 @@ import { PluginType } from '../types/PluginType.js';
 import { PresetType } from '../types/PresetType.js';
 import { ProjectType } from '../types/ProjectType.js';
 import { SystemType } from '../types/SystemType.js';
-export function packageCompatibleFiles(pkg, arch, sys) {
+export function packageCompatibleFiles(pkg, arch, sys, excludedFormats) {
     return pkg.files.filter((file) => {
         const archMatches = file.architectures.filter(architecture => {
             return arch.includes(architecture);
@@ -16,9 +16,21 @@ export function packageCompatibleFiles(pkg, arch, sys) {
         const sysMatches = file.systems.filter(system => {
             return sys.includes(system.type);
         });
-        return archMatches.length && sysMatches.length;
+        const formatAllowed = excludedFormats && excludedFormats.includes(file.format) ? false : true;
+        return archMatches.length && sysMatches.length && formatAllowed;
     });
 }
+export function packageFileMap(pkgVersion) {
+    return pkgVersion.files.reduce((result, file) => {
+        file.systems.forEach(system => {
+            if (!result[system.type]) {
+                result[system.type] = [];
+            }
+            result[system.type].push(file);
+        });
+        return result;
+    }, {});
+}
 export function packageVersionLatest(pkg) {
     return Array.from(Object.keys(pkg.versions)).sort(semver.rcompare)[0] || '0.0.0';
 }
@@ -85,6 +97,24 @@ export function packageRecommendations(pkgVersion) {
         });
         supportedFileFormats[file.format] = true;
         packageRecommendationsUrl(file, recs, 'url');
+        // Formats which do not support headless installation.
+        if (file.format === FileFormat.AppImage)
+            recs.push({ field: 'format', rec: 'requires manual installation steps, consider .deb and .rpm instead' });
+        if (file.format === FileFormat.AppleDiskImage)
+            recs.push({ field: 'format', rec: 'requires mounting step, consider .pkg instead' });
+        if (!file.url.includes(file.format))
+            recs.push({ field: 'format', rec: 'should match url field' });
+        // Validate format is a supported installer format
+        const installerFormats = [
+            FileFormat.AppleDiskImage,
+            FileFormat.ApplePackage,
+            FileFormat.DebianPackage,
+            FileFormat.ExecutableInstaller,
+            FileFormat.RedHatPackage,
+            FileFormat.WindowsInstaller,
+        ];
+        if (file.type === FileType.Installer && !installerFormats.includes(file.format))
+            recs.push({ field: 'type', rec: 'should match format field' });
     });
     // Architectures
     if (!supportedArchitectures.arm64)
@@ -98,17 +128,6 @@ export function packageRecommendations(pkgVersion) {
         recs.push({ field: 'systems', rec: 'should support Mac' });
     if (!supportedSystems.win)
         recs.push({ field: 'systems', rec: 'should support Windows' });
-    // Formats
-    if (supportedFileFormats.deb)
-        recs.push({
-            field: 'format',
-            rec: 'should support all Linux distributions, consider using AppImage or Tarball instead',
-        });
-    if (supportedFileFormats.rpm)
-        recs.push({
-            field: 'format',
-            rec: 'should support all Linux distributions, consider using AppImage or Tarball instead',
-        });
     // Tags
     const pluginTags = pkgVersion.tags.map(tag => tag.trim().toLowerCase());
     if (pluginTags.length < 2)

package/build/helpers/utilsLocal.d.ts

@@ -3,3 +3,4 @@ import { Architecture } from '../types/Architecture.js';
 export declare function getArchitecture(): Architecture;
 export declare function getSystem(): SystemType;
 export declare function isTests(): boolean;
+export declare function commandExists(cmd: string): Promise<boolean>;

package/build/helpers/utilsLocal.js

@@ -1,3 +1,4 @@
+import { exec } from 'child_process';
 import { SystemType } from '../types/SystemType.js';
 import { Architecture } from '../types/Architecture.js';
 export function getArchitecture() {
@@ -11,9 +12,9 @@ export function getArchitecture() {
 }
 export function getSystem() {
     if (process.platform === 'win32')
-        return SystemType.Windows;
+        return SystemType.Win;
     else if (process.platform === 'darwin')
-        return SystemType.Macintosh;
+        return SystemType.Mac;
     return SystemType.Linux;
 }
 export function isTests() {
@@ -21,3 +22,10 @@ export function isTests() {
     const vitest = process.env.VITEST_WORKER_ID !== undefined;
     return jest || vitest;
 }
+export function commandExists(cmd) {
+    return new Promise(resolve => {
+        exec(`command -v ${cmd}`, (error, stdout) => {
+            resolve(Boolean(stdout.trim()) && !error);
+        });
+    });
+}

package/build/types/FileFormat.d.ts

@@ -1,14 +1,14 @@
 export declare enum FileFormat {
-    AppImage = "appimage",
-    AppleDiskImage = "dmg",
-    ApplePackage = "pkg",
-    DebianPackage = "deb",
-    ExecutableInstaller = "exe",
-    RedHatPackage = "rpm",
-    Tarball = "tar.gz",
-    TarballLegacy = "tgz",
-    WindowsInstaller = "msi",
-    Zip = "zip",
+    AppImage = "appimage",// No headless automatic installation, avoid using
+    AppleDiskImage = "dmg",// Has to be mounted to access installer inside
+    ApplePackage = "pkg",// Installer
+    DebianPackage = "deb",// Installer
+    ExecutableInstaller = "exe",// Installer
+    RedHatPackage = "rpm",// Installer
+    Tarball = "tar.gz",// Archive
+    TarballLegacy = "tgz",// Archive
+    WindowsInstaller = "msi",// Installer
+    Zip = "zip",// Archive
     Zip7 = "7z"
 }
 export interface FileFormatOption {

package/build/types/FileFormat.js

@@ -1,3 +1,6 @@
+// File formats have different advantages for users
+// but some do not support headless automated installation
+// which is required for a fully automated package manager.
 export var FileFormat;
 (function (FileFormat) {
     FileFormat["AppImage"] = "appimage";

package/build/types/Package.d.ts

@@ -1,6 +1,6 @@
-import { PluginInterface } from './Plugin.js';
-import { PresetInterface } from './Preset.js';
-import { ProjectInterface } from './Project.js';
+import { PluginFile, PluginFileMap, PluginInterface } from './Plugin.js';
+import { PresetFile, PresetFileMap, PresetInterface } from './Preset.js';
+import { ProjectFile, ProjectFileMap, ProjectInterface } from './Project.js';
 import { License } from './License.js';
 export interface PackageInterface {
     slug: string;
@@ -24,6 +24,8 @@ export interface PackageBase {
     url: string;
 }
 export type PackageVersion = PluginInterface | PresetInterface | ProjectInterface;
+export type PackageFile = PluginFile | PresetFile | ProjectFile;
+export type PackageFileMap = PluginFileMap | PresetFileMap | ProjectFileMap;
 export interface PackageValidationField {
     name: string;
     type: string;

package/build/types/Plugin.d.ts

@@ -9,3 +9,6 @@ export interface PluginInterface extends PackageBase {
 export interface PluginFile extends FileInterface {
     contains: PluginFormat[];
 }
+export interface PluginFileMap {
+    [key: string]: PluginFile[];
+}

package/build/types/Preset.d.ts

@@ -10,6 +10,9 @@ export interface PresetInterface extends PackageBase {
 export interface PresetFile extends FileInterface {
     contains: PresetFormat[];
 }
+export interface PresetFileMap {
+    [key: string]: PresetFile[];
+}
 export interface PresetPlugins {
     [slug: string]: string;
 }

package/build/types/Project.d.ts

@@ -10,6 +10,9 @@ export interface ProjectInterface extends PackageBase {
 export interface ProjectFile extends FileInterface {
     contains: ProjectFormat[];
 }
+export interface ProjectFileMap {
+    [key: string]: ProjectFile[];
+}
 export interface ProjectPlugins {
     [slug: string]: string;
 }

package/build/types/SystemType.d.ts

@@ -1,7 +1,7 @@
 export declare enum SystemType {
-    Macintosh = "mac",
+    Mac = "mac",
     Linux = "linux",
-    Windows = "win"
+    Win = "win"
 }
 export interface SystemTypeOption {
     description: string;

package/build/types/SystemType.js

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

package/package.json

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