@open-audio-stack/core 0.1.0 → 0.1.2

package/README.md

@@ -1,7 +1,27 @@
-# open-audio-stack-core
+<div align="center">
+<h1>
+  <img src="https://raw.githubusercontent.com/open-audio-stack/open-audio-stack-registry/refs/heads/main/src/assets/open-audio-stack-logo.svg" alt="Open Audio Stack Logo"><br />
+  Open Audio Stack
+</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://open-audio-stack.github.io/open-audio-stack-registry">Registry API</a>
+    ⦁︎
+    <a href="https://github.com/orgs/open-audio-stack/projects">Roadmap</a>
+  </p>
+<p>
 
 ![Test](https://github.com/open-audio-stack/open-audio-stack-core/workflows/Test/badge.svg)
 ![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)
+
+</div>
+
+# open-audio-stack-core
 
 Common package shared across Open Audio Stack compatible registries, command-line tools, apps and websites for handling installing DAW VST plugin dependencies.
 
@@ -12,9 +32,10 @@ High-level classes enable use without writing business-logic:
 - Config - Set and get common configuration types, formats, values, paths and urls.
 - ConfigLocal - All the Config functionality including ability to load and save configuration to a json file.
 - Manager - Search, filter and get packages from a registry.
-- ManagerLocal - Install/uninstall packages locally and scan directories for existing packages.
+- ManagerLocal - Scan directories for existing packages locally and install/uninstall packages.
 - Package - Create a new package to add to a registry.
 - Registry - Create an audio package registry with packages and files.
+- RegistryLocal - Scan directories for existing packages locally.
 
 Low-level methods/utilities for more custom/advanced implementations:
 
@@ -37,6 +58,18 @@ Import the package using:
 
 Then use the available methods as normal.
 
+## Badges
+
+If your project utilizes the Open Stack Audio specification or API, we encourage linking back to this project using a badge:
+
+```
+<a href="https://github.com/open-audio-stack" target="_blank"><img src="https://raw.githubusercontent.com/open-audio-stack/open-audio-stack-registry/refs/heads/main/src/assets/powered-by-open-audio-stack.svg" alt="Powered by Open Audio Stack"></a>
+```
+
+Example:
+
+<a href="https://github.com/open-audio-stack" target="_blank"><img src="https://raw.githubusercontent.com/open-audio-stack/open-audio-stack-registry/refs/heads/main/src/assets/powered-by-open-audio-stack.svg" alt="Powered by Open Audio Stack"></a>
+
 ## Developer information
 
 Open Audio Stack Core was built using:

package/build/classes/Manager.d.ts

@@ -9,7 +9,7 @@ export declare class Manager {
     type: RegistryType;
     constructor(type: RegistryType, config?: ConfigInterface);
     addPackage(pkg: Package): void;
-    filter(query: string | number | object, field: keyof PackageVersion): Package[];
+    filter(method: (pkgVersion: PackageVersion, pkg: Package) => boolean): Package[];
     getPackage(slug: string): Package | undefined;
     listPackages(): Package[];
     removePackage(slug: string): void;

package/build/classes/Manager.js

@@ -21,13 +21,11 @@ export class Manager {
             this.packages.set(pkg.slug, pkg);
         }
     }
-    filter(query, field) {
+    filter(method) {
         const results = [];
         for (const [, pkg] of this.packages) {
             const pkgVersion = pkg.getVersionLatest();
-            if (!pkgVersion)
-                continue;
-            if (pkgVersion[field] === query) {
+            if (pkgVersion && method(pkgVersion, pkg)) {
                 results.push(pkg);
             }
         }

package/build/classes/ManagerLocal.d.ts

@@ -5,7 +5,7 @@ import { ConfigInterface } from '../types/Config.js';
 export declare class ManagerLocal extends Manager {
     protected typeDir: string;
     constructor(type: RegistryType, config: ConfigInterface);
-    scan(): void;
+    scan(ext?: string): void;
     install(slug: string, version?: string): Promise<void | PackageVersion>;
     uninstall(slug: string, version?: string): Promise<void | PackageVersion>;
 }

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';
@@ -19,8 +20,8 @@ export class ManagerLocal extends Manager {
         this.config = new ConfigLocal(configPath, config);
         this.typeDir = this.config.get(`${type}Dir`);
     }
-    scan() {
-        const filePaths = dirRead(`${this.typeDir}/**/index.json`);
+    scan(ext = 'json') {
+        const filePaths = dirRead(`${this.typeDir}/**/index.${ext}`);
         filePaths.forEach((filePath) => {
             const subPath = filePath.replace(`${this.typeDir}/`, '');
             const pkgJson = fileReadJson(filePath);
@@ -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/classes/Registry.d.ts

@@ -4,7 +4,7 @@ export declare class Registry {
     name: string;
     url: string;
     version: string;
-    private managers;
+    protected managers: Record<string, Manager>;
     constructor(name: string, url: string, version: string);
     addManager(manager: Manager): void;
     getManager(type: RegistryType): Manager;

package/build/classes/RegistryLocal.d.ts

@@ -0,0 +1,7 @@
+import { ManagerLocal } from './ManagerLocal.js';
+import { Registry } from './Registry.js';
+export declare class RegistryLocal extends Registry {
+    protected managers: Record<string, ManagerLocal>;
+    constructor(name: string, url: string, version: string);
+    scan(ext?: string): void;
+}

package/build/classes/RegistryLocal.js

@@ -0,0 +1,13 @@
+import { Registry } from './Registry.js';
+export class RegistryLocal extends Registry {
+    managers;
+    constructor(name, url, version) {
+        super(name, url, version);
+        this.managers = {};
+    }
+    scan(ext = 'json') {
+        for (const [, manager] of Object.entries(this.managers)) {
+            manager.scan(ext);
+        }
+    }
+}

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

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