@open-audio-stack/core 0.0.4 → 0.0.6

package/README.md

@@ -1,6 +1,7 @@
 # open-audio-stack-core
 
 ![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)
 
 Common methods package shared across Open Audio Stack compatible registries, command-line tools, apps and websites for handling installing DAW VST plugin dependencies.
 

package/build/Config.d.ts

@@ -12,7 +12,7 @@ import { ProjectType } from './types/ProjectType.js';
 import { SystemType } from './types/SystemType.js';
 export declare class Config {
     config: ConfigInterface;
-    constructor(config: ConfigInterface);
+    constructor(config?: ConfigInterface);
     get(): ConfigInterface;
     architecture(type: Architecture): import("./types/Architecture.js").ArchitectureOption;
     architectures(): import("./types/Architecture.js").ArchitectureOption[];

package/build/Config.js

@@ -12,7 +12,7 @@ import { systemTypes } from './types/SystemType.js';
 export class Config {
     config;
     constructor(config) {
-        this.config = config;
+        this.config = Object.assign({}, config);
     }
     get() {
         return this.config;

package/build/Registry.d.ts

@@ -1,8 +1,11 @@
 import { PackageInterface, PackageValidationError, PackageVersions, PackageVersionType } from './types/Package.js';
-import { RegistryInterface } from './types/Registry.js';
+import { RegistryInterface, RegistryPackages } from './types/Registry.js';
+import { PluginType } from './types/PluginType.js';
+import { PresetType } from './types/PresetType.js';
+import { ProjectType } from './types/ProjectType.js';
 export declare class Registry {
     registry: RegistryInterface;
-    constructor(registry: RegistryInterface);
+    constructor(registry?: RegistryInterface);
     packageAdd(slug: string): {
         slug: string;
         version: string;
@@ -10,7 +13,9 @@ export declare class Registry {
     };
     packageVersionAdd(slug: string, version: string, pkgVersion: PackageVersionType): void;
     package(slug: string): PackageInterface;
-    packages(): import("./types/Registry.js").RegistryPackages;
+    packages(): RegistryPackages;
+    packagesFilter(type: typeof PluginType | typeof PresetType | typeof ProjectType): RegistryPackages;
+    packageLatest(slug: string, version?: string): PackageVersionType;
     packageVersionLatest(versions: PackageVersions): string;
     get(): RegistryInterface;
     name(): string;

package/build/Registry.js

@@ -3,7 +3,7 @@ import { PackageValidation, } from './types/Package.js';
 export class Registry {
     registry;
     constructor(registry) {
-        this.registry = registry;
+        this.registry = Object.assign({}, registry);
     }
     packageAdd(slug) {
         return (this.registry.packages[slug] = {
@@ -26,6 +26,19 @@ export class Registry {
     packages() {
         return this.registry.packages;
     }
+    packagesFilter(type) {
+        const registryFiltered = {};
+        Object.keys(this.registry.packages).forEach((slug) => {
+            if (Object.values(type).includes(this.packageLatest(slug).type))
+                registryFiltered[slug] = this.registry.packages[slug];
+        });
+        return registryFiltered;
+    }
+    packageLatest(slug, version) {
+        const pkg = this.package(slug);
+        const pkgVersion = this.packageVersionLatest(pkg.versions);
+        return pkg.versions[version || pkgVersion];
+    }
     packageVersionLatest(versions) {
         let latest = '0.0.0';
         Object.keys(versions).forEach((version) => {
@@ -62,11 +75,13 @@ export class Registry {
     }
     packageVersionValidate(pkgVersion) {
         const fields = [
+            { name: 'audio', type: 'string' },
             { name: 'author', type: 'string' },
             { name: 'changes', type: 'string' },
             { name: 'date', type: 'string' },
             { name: 'description', type: 'string' },
             { name: 'files', type: 'object' },
+            { name: 'image', type: 'string' },
             { name: 'license', type: 'string' },
             { name: 'name', type: 'string' },
             { name: 'tags', type: 'object' },
@@ -76,7 +91,7 @@ export class Registry {
         const errors = [];
         fields.forEach((field) => {
             const versionField = pkgVersion[field.name];
-            if (!versionField) {
+            if (versionField === undefined) {
                 errors.push({
                     field: field.name,
                     error: PackageValidation.MISSING_FIELD,

package/build/helpers/file.d.ts

@@ -0,0 +1,30 @@
+import { PackageInterface } from '../types/Package.js';
+export declare function dirApp(): string;
+export declare function dirCreate(dir: string): string | false;
+export declare function dirDelete(dir: string): false | void;
+export declare function dirEmpty(dir: string): boolean;
+export declare function dirExists(dir: string): boolean;
+export declare function dirIs(dir: string): boolean;
+export declare function dirMove(dir: string, dirNew: string): void | boolean;
+export declare function dirOpen(dir: string): Buffer;
+export declare function dirPackage(pkg: PackageInterface): string;
+export declare function dirPlugins(): string;
+export declare function dirPresets(): string;
+export declare function dirProjects(): string;
+export declare function dirRead(dir: string, options?: any): string[];
+export declare function dirRename(dir: string, dirNew: string): void | boolean;
+export declare function fileCreate(filePath: string, data: string | Buffer): void;
+export declare function fileDate(filePath: string): Date;
+export declare function fileDelete(filePath: string): boolean | void;
+export declare function fileExec(filePath: string): void;
+export declare function fileExists(filePath: string): boolean;
+export declare function fileJsonCreate(filePath: string, data: object): void;
+export declare function fileMove(filePath: string, newPath: string): void | boolean;
+export declare function fileOpen(filePath: string): Buffer;
+export declare function fileRead(filePath: string): Buffer;
+export declare function fileReadJson(filePath: string): any;
+export declare function fileReadString(filePath: string): string;
+export declare function fileReadYaml(filePath: string): unknown;
+export declare function fileSize(filePath: string): number;
+export declare function zipCreate(filesPath: string, zipPath: string): void;
+export declare function zipExtract(content: any, dirPath: string): void;

package/build/helpers/file.js

@@ -0,0 +1,198 @@
+import AdmZip from 'adm-zip';
+import { execSync } from 'child_process';
+import { chmodSync, existsSync, mkdirSync, readdirSync, readFileSync, rmSync, statSync, unlinkSync, writeFileSync, } from 'fs';
+import { globSync } from 'glob';
+import { moveSync } from 'fs-extra/esm';
+import os from 'os';
+import path from 'path';
+import yaml from 'js-yaml';
+export function dirApp() {
+    if (process.platform === 'win32')
+        return process.env.APPDATA || os.homedir();
+    else if (process.platform === 'darwin')
+        return path.join(os.homedir(), 'Library', 'Preferences');
+    return path.join(os.homedir(), '.local', 'share');
+}
+export function dirCreate(dir) {
+    if (!dirExists(dir)) {
+        console.log('+', dir);
+        mkdirSync(dir, { recursive: true });
+        return dir;
+    }
+    return false;
+}
+export function dirDelete(dir) {
+    if (dirExists(dir)) {
+        console.log('-', dir);
+        return rmSync(dir, { recursive: true });
+    }
+    return false;
+}
+export function dirEmpty(dir) {
+    const files = readdirSync(dir);
+    return files.length === 0 || (files.length === 1 && files[0] === '.DS_Store');
+}
+export function dirExists(dir) {
+    return existsSync(dir);
+}
+export function dirIs(dir) {
+    return statSync(dir).isDirectory();
+}
+export function dirMove(dir, dirNew) {
+    if (dirExists(dir)) {
+        console.log('-', dir);
+        console.log('+', dirNew);
+        return moveSync(dir, dirNew, { overwrite: true });
+    }
+    return false;
+}
+export function dirOpen(dir) {
+    let command = '';
+    if (process.env.CI)
+        return new Buffer('');
+    if (process.platform === 'win32')
+        command = 'start ""';
+    else if (process.platform === 'darwin')
+        command = 'open';
+    else
+        command = 'xdg-open';
+    console.log('⎋', `${command} "${dir}"`);
+    return execSync(`${command} "${dir}"`);
+}
+export function dirPackage(pkg) {
+    const parts = pkg.slug.split('/');
+    parts.push(pkg.version);
+    return path.join(...parts);
+}
+export function dirPlugins() {
+    if (process.platform === 'win32')
+        return path.join('Program Files', 'Common Files');
+    else if (process.platform === 'darwin')
+        return path.join(os.homedir(), 'Library', 'Audio', 'Plug-ins');
+    return path.join('usr', 'local', 'lib');
+}
+export function dirPresets() {
+    if (process.platform === 'win32')
+        return path.join(os.homedir(), 'Documents', 'VST3 Presets');
+    else if (process.platform === 'darwin')
+        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 (process.platform === 'win32')
+        return path.join(os.homedir(), 'Documents', 'Audio');
+    else if (process.platform === 'darwin')
+        return path.join(os.homedir(), 'Documents', 'Audio');
+    return path.join(os.homedir(), 'Documents', 'Audio');
+}
+export function dirRead(dir, options) {
+    console.log('⌕', dir);
+    // Glob now expects forward slashes on Windows
+    // Convert backslashes from path.join() to forwardslashes
+    if (process.platform === 'win32') {
+        dir = dir.replace(/\\/g, '/');
+    }
+    return globSync(dir, options);
+}
+export function dirRename(dir, dirNew) {
+    if (dirExists(dir)) {
+        return moveSync(dir, dirNew, { overwrite: true });
+    }
+    return false;
+}
+export function fileCreate(filePath, data) {
+    console.log('+', filePath);
+    return writeFileSync(filePath, data);
+}
+export function fileDate(filePath) {
+    return statSync(filePath).mtime;
+}
+export function fileDelete(filePath) {
+    if (fileExists(filePath)) {
+        console.log('-', filePath);
+        return unlinkSync(filePath);
+    }
+    return false;
+}
+export function fileExec(filePath) {
+    return chmodSync(filePath, '755');
+}
+export function fileExists(filePath) {
+    return existsSync(filePath);
+}
+export function fileJsonCreate(filePath, data) {
+    return fileCreate(filePath, JSON.stringify(data, null, 2));
+}
+export function fileMove(filePath, newPath) {
+    if (fileExists(filePath)) {
+        console.log('-', filePath);
+        console.log('+', newPath);
+        return moveSync(filePath, newPath, { overwrite: true });
+    }
+    return false;
+}
+export function fileOpen(filePath) {
+    let command = '';
+    if (process.env.CI)
+        return new Buffer('');
+    if (process.platform === 'win32')
+        command = 'open';
+    else if (process.platform === 'darwin')
+        command = 'start ""';
+    else
+        command = 'xdg-open';
+    console.log('⎋', `${command} "${filePath}"`);
+    return execSync(`${command} "${filePath}"`);
+}
+export function fileRead(filePath) {
+    console.log('⎋', filePath);
+    return readFileSync(filePath);
+}
+export function fileReadJson(filePath) {
+    if (fileExists(filePath)) {
+        console.log('⎋', filePath);
+        return JSON.parse(readFileSync(filePath).toString());
+    }
+    return false;
+}
+export function fileReadString(filePath) {
+    console.log('⎋', filePath);
+    return readFileSync(filePath).toString();
+}
+export function fileReadYaml(filePath) {
+    const file = fileReadString(filePath);
+    return yaml.load(file);
+}
+export function fileSize(filePath) {
+    return statSync(filePath).size;
+}
+export function zipCreate(filesPath, zipPath) {
+    if (fileExists(zipPath)) {
+        unlinkSync(zipPath);
+    }
+    const zip = new AdmZip();
+    const pathList = dirRead(filesPath);
+    pathList.forEach(pathItem => {
+        console.log('⎋', pathItem);
+        try {
+            if (dirIs(pathItem)) {
+                zip.addLocalFolder(pathItem, path.basename(pathItem));
+            }
+            else {
+                zip.addLocalFile(pathItem);
+            }
+        }
+        catch (error) {
+            console.log(error);
+        }
+    });
+    console.log('+', zipPath);
+    return zip.writeZip(zipPath);
+}
+export function zipExtract(content, dirPath) {
+    console.log('⎋', dirPath);
+    const zip = new AdmZip(content);
+    return zip.extractAllTo(dirPath);
+}

package/build/helpers/utils.d.ts

@@ -0,0 +1,5 @@
+export declare function pathGetExt(path: string, sep?: string): string;
+export declare function pathGetDirectory(path: string, sep?: string): string;
+export declare function pathGetFilename(path: string, sep?: string): string;
+export declare function pathGetSlug(path: string, sep?: string): string;
+export declare function pathGetVersion(path: string, sep?: string): string;

package/build/helpers/utils.js

@@ -0,0 +1,17 @@
+export function pathGetExt(path, sep = '.') {
+    return path.substring(path.lastIndexOf(sep) + 1);
+}
+export function pathGetDirectory(path, sep = '/') {
+    return path.substring(0, path.lastIndexOf(sep));
+}
+export function pathGetFilename(path, sep = '/') {
+    return path.substring(path.lastIndexOf(sep) + 1);
+}
+export function pathGetSlug(path, sep = '/') {
+    const parts = path.split(sep);
+    return parts[0] + '/' + parts[1];
+}
+export function pathGetVersion(path, sep = '/') {
+    const parts = path.split(sep);
+    return parts[parts.length - 2];
+}

package/build/index-browser.d.ts

@@ -1,5 +1,6 @@
 export * from './Config.js';
 export * from './Registry.js';
+export * from './helpers/utils.js';
 export * from './types/Architecture.js';
 export * from './types/Config.js';
 export * from './types/File.js';

package/build/index-browser.js

@@ -4,8 +4,10 @@
 // Comment out any files which are not browser compatible.
 // Classes
 export * from './Config.js';
-// export * from './FileSystem.js';
 export * from './Registry.js';
+// Helpers
+// export * from './helpers/file.js';
+export * from './helpers/utils.js';
 // Types
 export * from './types/Architecture.js';
 export * from './types/Config.js';

package/build/index.d.ts

@@ -1,6 +1,7 @@
 export * from './Config.js';
-export * from './FileSystem.js';
 export * from './Registry.js';
+export * from './helpers/file.js';
+export * from './helpers/utils.js';
 export * from './types/Architecture.js';
 export * from './types/Config.js';
 export * from './types/File.js';

package/build/index.js

@@ -4,8 +4,10 @@
 // Comment out any files which are not NodeJS compatible.
 // Classes
 export * from './Config.js';
-export * from './FileSystem.js';
 export * from './Registry.js';
+// Helpers
+export * from './helpers/file.js';
+export * from './helpers/utils.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.0.4",
+  "version": "0.0.6",
   "description": "Open-source audio plugin management software",
   "type": "module",
   "main": "./build/index.js",

package/build/FileSystem.d.ts

@@ -1,33 +0,0 @@
-import { PackageInterface } from '../src/types/Package.js';
-export declare class FileSystem {
-    constructor();
-    dirApp(): string;
-    dirCreate(dir: string): string | false;
-    dirDelete(dir: string): false | void;
-    dirEmpty(dir: string): boolean;
-    dirExists(dir: string): boolean;
-    dirIs(dir: string): boolean;
-    dirMove(dir: string, dirNew: string): void | boolean;
-    dirOpen(dir: string): Buffer;
-    dirPackage(pkg: PackageInterface): string;
-    dirPlugins(): string;
-    dirPresets(): string;
-    dirProjects(): string;
-    dirRead(dir: string, options?: any): string[];
-    dirRename(dir: string, dirNew: string): void | boolean;
-    fileCreate(filePath: string, data: string | Buffer): void;
-    fileDate(filePath: string): Date;
-    fileDelete(filePath: string): boolean | void;
-    fileExec(filePath: string): void;
-    fileExists(filePath: string): boolean;
-    fileJsonCreate(filePath: string, data: object): void;
-    fileMove(filePath: string, newPath: string): void | boolean;
-    fileOpen(filePath: string): Buffer;
-    fileRead(filePath: string): Buffer;
-    fileReadJson(filePath: string): any;
-    fileReadString(filePath: string): string;
-    fileReadYaml(filePath: string): unknown;
-    fileSize(filePath: string): number;
-    zipCreate(filesPath: string, zipPath: string): void;
-    zipExtract(content: any, dirPath: string): void;
-}

package/build/FileSystem.js

@@ -1,201 +0,0 @@
-import AdmZip from 'adm-zip';
-import { execSync } from 'child_process';
-import { chmodSync, existsSync, mkdirSync, readdirSync, readFileSync, rmSync, statSync, unlinkSync, writeFileSync, } from 'fs';
-import { globSync } from 'glob';
-import { moveSync } from 'fs-extra/esm';
-import os from 'os';
-import path from 'path';
-import yaml from 'js-yaml';
-export class FileSystem {
-    constructor() { }
-    dirApp() {
-        if (process.platform === 'win32')
-            return process.env.APPDATA || os.homedir();
-        else if (process.platform === 'darwin')
-            return path.join(os.homedir(), 'Library', 'Preferences');
-        return path.join(os.homedir(), '.local', 'share');
-    }
-    dirCreate(dir) {
-        if (!this.dirExists(dir)) {
-            console.log('+', dir);
-            mkdirSync(dir, { recursive: true });
-            return dir;
-        }
-        return false;
-    }
-    dirDelete(dir) {
-        if (this.dirExists(dir)) {
-            console.log('-', dir);
-            return rmSync(dir, { recursive: true });
-        }
-        return false;
-    }
-    dirEmpty(dir) {
-        const files = readdirSync(dir);
-        return files.length === 0 || (files.length === 1 && files[0] === '.DS_Store');
-    }
-    dirExists(dir) {
-        return existsSync(dir);
-    }
-    dirIs(dir) {
-        return statSync(dir).isDirectory();
-    }
-    dirMove(dir, dirNew) {
-        if (this.dirExists(dir)) {
-            console.log('-', dir);
-            console.log('+', dirNew);
-            return moveSync(dir, dirNew, { overwrite: true });
-        }
-        return false;
-    }
-    dirOpen(dir) {
-        let command = '';
-        if (process.env.CI)
-            return new Buffer('');
-        if (process.platform === 'win32')
-            command = 'open';
-        else if (process.platform === 'darwin')
-            command = 'start ""';
-        else
-            command = 'xdg-open';
-        console.log('⎋', `${command} "${dir}"`);
-        return execSync(`${command} "${dir}"`);
-    }
-    dirPackage(pkg) {
-        const parts = pkg.slug.split('/');
-        parts.push(pkg.version);
-        return path.join(...parts);
-    }
-    dirPlugins() {
-        if (process.platform === 'win32')
-            return path.join('Program Files', 'Common Files');
-        else if (process.platform === 'darwin')
-            return path.join(os.homedir(), 'Library', 'Audio', 'Plug-ins');
-        return path.join('usr', 'local', 'lib');
-    }
-    dirPresets() {
-        if (process.platform === 'win32')
-            return path.join(os.homedir(), 'Documents', 'VST3 Presets');
-        else if (process.platform === 'darwin')
-            return path.join(os.homedir(), 'Library', 'Audio', 'Presets');
-        return path.join(os.homedir(), '.vst3', 'presets');
-    }
-    dirProjects() {
-        // Windows throws permissions errors if you scan hidden folders
-        // Therefore set to a more specific path than Documents
-        if (process.platform === 'win32')
-            return path.join(os.homedir(), 'Documents', 'Audio');
-        else if (process.platform === 'darwin')
-            return path.join(os.homedir(), 'Documents', 'Audio');
-        return path.join(os.homedir(), 'Documents', 'Audio');
-    }
-    dirRead(dir, options) {
-        console.log('⌕', dir);
-        // Glob now expects forward slashes on Windows
-        // Convert backslashes from path.join() to forwardslashes
-        if (process.platform === 'win32') {
-            dir = dir.replace(/\\/g, '/');
-        }
-        return globSync(dir, options);
-    }
-    dirRename(dir, dirNew) {
-        if (this.dirExists(dir)) {
-            return moveSync(dir, dirNew, { overwrite: true });
-        }
-        return false;
-    }
-    fileCreate(filePath, data) {
-        console.log('+', filePath);
-        return writeFileSync(filePath, data);
-    }
-    fileDate(filePath) {
-        return statSync(filePath).mtime;
-    }
-    fileDelete(filePath) {
-        if (this.fileExists(filePath)) {
-            console.log('-', filePath);
-            return unlinkSync(filePath);
-        }
-        return false;
-    }
-    fileExec(filePath) {
-        return chmodSync(filePath, '755');
-    }
-    fileExists(filePath) {
-        return existsSync(filePath);
-    }
-    fileJsonCreate(filePath, data) {
-        return this.fileCreate(filePath, JSON.stringify(data, null, 2));
-    }
-    fileMove(filePath, newPath) {
-        if (this.fileExists(filePath)) {
-            console.log('-', filePath);
-            console.log('+', newPath);
-            return moveSync(filePath, newPath, { overwrite: true });
-        }
-        return false;
-    }
-    fileOpen(filePath) {
-        let command = '';
-        if (process.env.CI)
-            return new Buffer('');
-        if (process.platform === 'win32')
-            command = 'open';
-        else if (process.platform === 'darwin')
-            command = 'start ""';
-        else
-            command = 'xdg-open';
-        console.log('⎋', `${command} "${filePath}"`);
-        return execSync(`${command} "${filePath}"`);
-    }
-    fileRead(filePath) {
-        console.log('⎋', filePath);
-        return readFileSync(filePath);
-    }
-    fileReadJson(filePath) {
-        if (this.fileExists(filePath)) {
-            console.log('⎋', filePath);
-            return JSON.parse(readFileSync(filePath).toString());
-        }
-        return false;
-    }
-    fileReadString(filePath) {
-        console.log('⎋', filePath);
-        return readFileSync(filePath).toString();
-    }
-    fileReadYaml(filePath) {
-        const file = this.fileReadString(filePath);
-        return yaml.load(file);
-    }
-    fileSize(filePath) {
-        return statSync(filePath).size;
-    }
-    zipCreate(filesPath, zipPath) {
-        if (this.fileExists(zipPath)) {
-            unlinkSync(zipPath);
-        }
-        const zip = new AdmZip();
-        const pathList = this.dirRead(filesPath);
-        pathList.forEach(pathItem => {
-            console.log('⎋', pathItem);
-            try {
-                if (this.dirIs(pathItem)) {
-                    zip.addLocalFolder(pathItem, path.basename(pathItem));
-                }
-                else {
-                    zip.addLocalFile(pathItem);
-                }
-            }
-            catch (error) {
-                console.log(error);
-            }
-        });
-        console.log('+', zipPath);
-        return zip.writeZip(zipPath);
-    }
-    zipExtract(content, dirPath) {
-        console.log('⎋', dirPath);
-        const zip = new AdmZip(content);
-        return zip.extractAllTo(dirPath);
-    }
-}