@open-audio-stack/core 0.1.0 → 0.1.1

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

@@ -19,8 +19,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);

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

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