@open-audio-stack/core 0.0.2 → 0.0.4

package/README.md

@@ -1,6 +1,30 @@
 # open-audio-stack-core
 
-Open-source audio plugin management software using:
+![Test](https://github.com/open-audio-stack/open-audio-stack-core/workflows/Test/badge.svg)
+
+Common methods package shared across Open Audio Stack compatible registries, command-line tools, apps and websites for handling installing DAW VST plugin dependencies.
+
+## Features
+
+- Config - Get types, formats, values, paths and urls.
+- FileSystem - Perform operations on directories and files.
+- Registry - Create an audio registry with packages and files.
+
+## Installation
+
+To install the common package, run the command:
+
+    npm install @open-audio-stack/core
+
+Import the package using:
+
+    import { Registry } from '@open-audio-stack/core';
+
+Then use the available methods as normal.
+
+## Developer information
+
+Open Audio Stack Core was built using:
 
 - NodeJS 20.x
 - TypeScript 5.x
@@ -8,13 +32,13 @@ Open-source audio plugin management software using:
 - prettier 3.x
 - vitest 1.x
 
-## Installation
+## Developer installation
 
-Install dependencies using:
+To install, build and run code locally, first install dependencies:
 
     npm install
 
-## Usage
+## Developer usage
 
 Run dev commands using:
 
@@ -23,11 +47,11 @@ Run dev commands using:
     npm run dev
     npm test
 
-Create a build using:
+Create a production build using:
 
     npm run build
 
-## Deployment
+## Developer deployment
 
 This package is versioned using git tags:
 

package/build/Config.d.ts

@@ -10,7 +10,7 @@ import { PresetType } from './types/PresetType.js';
 import { ProjectFormat } from './types/ProjectFormat.js';
 import { ProjectType } from './types/ProjectType.js';
 import { SystemType } from './types/SystemType.js';
-export default class Config {
+export declare class Config {
     config: ConfigInterface;
     constructor(config: ConfigInterface);
     get(): ConfigInterface;

package/build/Config.js

@@ -9,7 +9,7 @@ import { presetTypes } from './types/PresetType.js';
 import { projectFormats } from './types/ProjectFormat.js';
 import { projectTypes } from './types/ProjectType.js';
 import { systemTypes } from './types/SystemType.js';
-export default class Config {
+export class Config {
     config;
     constructor(config) {
         this.config = config;

package/build/FileSystem.d.ts

@@ -1,5 +1,5 @@
 import { PackageInterface } from '../src/types/Package.js';
-export default class FileSystem {
+export declare class FileSystem {
     constructor();
     dirApp(): string;
     dirCreate(dir: string): string | false;

package/build/FileSystem.js

@@ -6,7 +6,7 @@ import { moveSync } from 'fs-extra/esm';
 import os from 'os';
 import path from 'path';
 import yaml from 'js-yaml';
-export default class FileSystem {
+export class FileSystem {
     constructor() { }
     dirApp() {
         if (process.platform === 'win32')

package/build/Registry.d.ts

@@ -1,6 +1,6 @@
 import { PackageInterface, PackageValidationError, PackageVersions, PackageVersionType } from './types/Package.js';
 import { RegistryInterface } from './types/Registry.js';
-export default class Registry {
+export declare class Registry {
     registry: RegistryInterface;
     constructor(registry: RegistryInterface);
     packageAdd(slug: string): {

package/build/Registry.js

@@ -1,6 +1,6 @@
 import * as semver from 'semver';
 import { PackageValidation, } from './types/Package.js';
-export default class Registry {
+export class Registry {
     registry;
     constructor(registry) {
         this.registry = registry;

package/build/index-browser.js

@@ -4,6 +4,7 @@
 // Comment out any files which are not browser compatible.
 // Classes
 export * from './Config.js';
+// export * from './FileSystem.js';
 export * from './Registry.js';
 // Types
 export * from './types/Architecture.js';

package/build/types/Package.d.ts

@@ -11,10 +11,12 @@ export interface PackageVersions {
     [version: string]: PackageVersionType;
 }
 export interface PackageVersion {
+    audio: string;
     author: string;
     changes: string;
     date: string;
     description: string;
+    image: string;
     license: License;
     name: string;
     tags: string[];

package/build/types/Plugin.d.ts

@@ -7,5 +7,5 @@ export interface PluginInterface extends PackageVersion {
     type: PluginType;
 }
 export interface PluginFile extends FileInterface {
-    formats: PluginFormat[];
+    contains: PluginFormat[];
 }

package/build/types/PluginFormat.d.ts

@@ -3,6 +3,8 @@ export declare enum PluginFormat {
     AvidAudioExtension = "aax",
     CleverAudioPlugin = "clap",
     LADSPAVersion2 = "lv2",
+    LinuxStandalone = "elf",
+    MacStandalone = "app",
     RealTimeAudioSuite = "rta",
     SoundFont2 = "sf2",
     SFZ = "sfz",
@@ -10,7 +12,8 @@ export declare enum PluginFormat {
     VSTLinux = "so",
     VSTMac = "vst",
     VSTWin = "dll",
-    VST3 = "vst3"
+    VST3 = "vst3",
+    WinStandalone = "exe"
 }
 export interface PluginFormatOption {
     description: string;

package/build/types/PluginFormat.js

@@ -4,6 +4,8 @@ export var PluginFormat;
     PluginFormat["AvidAudioExtension"] = "aax";
     PluginFormat["CleverAudioPlugin"] = "clap";
     PluginFormat["LADSPAVersion2"] = "lv2";
+    PluginFormat["LinuxStandalone"] = "elf";
+    PluginFormat["MacStandalone"] = "app";
     PluginFormat["RealTimeAudioSuite"] = "rta";
     PluginFormat["SoundFont2"] = "sf2";
     PluginFormat["SFZ"] = "sfz";
@@ -12,6 +14,7 @@ export var PluginFormat;
     PluginFormat["VSTMac"] = "vst";
     PluginFormat["VSTWin"] = "dll";
     PluginFormat["VST3"] = "vst3";
+    PluginFormat["WinStandalone"] = "exe";
 })(PluginFormat || (PluginFormat = {}));
 export const pluginFormats = [
     {
@@ -39,6 +42,16 @@ export const pluginFormats = [
         value: PluginFormat.LADSPAVersion2,
         name: 'LADSPA Version 2',
     },
+    {
+        description: 'Linux standalone application.',
+        value: PluginFormat.LinuxStandalone,
+        name: 'Linux Standalone',
+    },
+    {
+        description: 'MacOS standalone application.',
+        value: PluginFormat.MacStandalone,
+        name: 'MacOS Standalone',
+    },
     {
         description: 'Widely used format for sound samples in musical instruments.',
         value: PluginFormat.SoundFont2,
@@ -74,4 +87,9 @@ export const pluginFormats = [
         value: PluginFormat.VST3,
         name: 'Virtual Studio Technology 3',
     },
+    {
+        description: 'Windows standalone application.',
+        value: PluginFormat.WinStandalone,
+        name: 'Windows Standalone',
+    },
 ];

package/build/types/Preset.d.ts

@@ -8,7 +8,7 @@ export interface PresetInterface extends PackageVersion {
     type: PresetType;
 }
 export interface PresetFile extends FileInterface {
-    formats: PresetFormat[];
+    contains: PresetFormat[];
 }
 export interface PresetPlugins {
     [slug: string]: string;

package/build/types/Project.d.ts

@@ -8,7 +8,7 @@ export interface ProjectInterface extends PackageVersion {
     type: ProjectType;
 }
 export interface ProjectFile extends FileInterface {
-    formats: ProjectFormat[];
+    contains: ProjectFormat[];
 }
 export interface ProjectPlugins {
     [slug: string]: string;

package/package.json

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