@open-audio-stack/core 0.1.5 → 0.1.7

package/README.md

@@ -5,7 +5,7 @@
 </h1>
 <p>Audio registry specification and API with searchable list of packages</p>
   <p>
-    <a href="https://github.com/open-audio-stack/open-audio-stack-core/wiki/Open-Audio-Stack-%E2%80%90-Registry-%E2%80%90-Specification-1.0.0">Registry Specification</a>
+    <a href="https://github.com/open-audio-stack/open-audio-stack-core/wiki/Open-Audio-Stack-%E2%80%90-Manager-%E2%80%90-Specification-1.0.0">Manager Specification</a>
     ⦁︎
     <a href="https://open-audio-stack.github.io/open-audio-stack-registry">Registry API</a>
     ⦁︎
@@ -17,7 +17,7 @@
 ![Release](https://github.com/open-audio-stack/open-audio-stack-core/workflows/Release/badge.svg)
 <a href="https://discord.com/invite/9D94f98PxP" target="_blank"><img src="https://img.shields.io/badge/chat-on%20discord-7289DA.svg" alt="Join the chat at Discord"></a>
 
-![Open Audio Stack - Registry - Specification 1.0.0](https://raw.githubusercontent.com/open-audio-stack/open-audio-stack-registry/refs/heads/main/src/assets/open-audio-stack-diagram.svg)
+![Open Audio Stack - Manager - Specification 1.0.0](https://raw.githubusercontent.com/open-audio-stack/open-audio-stack-registry/refs/heads/main/src/assets/open-audio-stack-diagram-manager.svg)
 
 </div>
 

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

@@ -200,9 +200,9 @@ export function fileOpen(filePath) {
     if (process.env.CI)
         return Buffer.from('');
     if (getSystem() === SystemType.Win)
-        command = 'open';
-    else if (getSystem() === SystemType.Mac)
         command = 'start ""';
+    else if (getSystem() === SystemType.Mac)
+        command = 'open';
     else
         command = 'xdg-open';
     console.log('⎋', `${command} "${filePath}"`);

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() {
@@ -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/index-browser.d.ts

@@ -1,6 +1,6 @@
 export * from './classes/Config.js';
-export * from './classes/Package.js';
 export * from './classes/Manager.js';
+export * from './classes/Package.js';
 export * from './classes/Registry.js';
 export * from './helpers/api.js';
 export * from './helpers/config.js';

package/build/index-browser.js

@@ -5,10 +5,11 @@
 // Classes
 export * from './classes/Config.js';
 // export * from './classes/ConfigLocal.js';
-export * from './classes/Package.js';
 export * from './classes/Manager.js';
 // export * from './classes/ManagerLocal.js';
+export * from './classes/Package.js';
 export * from './classes/Registry.js';
+// export * from './classes/RegistryLocal.js';
 // Helpers
 // export * from './helpers/admin.js'; // Admin is an independent script which should not be imported here.
 export * from './helpers/api.js';

package/build/index.d.ts

@@ -1,9 +1,10 @@
 export * from './classes/Config.js';
 export * from './classes/ConfigLocal.js';
-export * from './classes/Package.js';
 export * from './classes/Manager.js';
 export * from './classes/ManagerLocal.js';
+export * from './classes/Package.js';
 export * from './classes/Registry.js';
+export * from './classes/RegistryLocal.js';
 export * from './helpers/api.js';
 export * from './helpers/config.js';
 export * from './helpers/configLocal.js';

package/build/index.js

@@ -5,10 +5,11 @@
 // Classes
 export * from './classes/Config.js';
 export * from './classes/ConfigLocal.js';
-export * from './classes/Package.js';
 export * from './classes/Manager.js';
 export * from './classes/ManagerLocal.js';
+export * from './classes/Package.js';
 export * from './classes/Registry.js';
+export * from './classes/RegistryLocal.js';
 // Helpers
 // export * from './helpers/admin.js'; // Admin is an independent script which should not be imported here.
 export * from './helpers/api.js';

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/package.json

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