@open-audio-stack/core 0.0.5 → 0.0.7

package/README.md

@@ -1,5 +1,6 @@
 # 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,11 +1,11 @@
-import { PackageInterface, PackageValidationError, PackageVersions, PackageVersionType } from './types/Package.js';
+import { PackageInterface, PackageValidationError, PackageValidationRec, PackageVersions, PackageVersionType } from './types/Package.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;
@@ -24,4 +24,5 @@ export declare class Registry {
     packageRemove(slug: string): void;
     packageVersionRemove(slug: string, version: string): void;
     packageVersionValidate(pkgVersion: PackageVersionType): PackageValidationError[];
+    packageVersionRecommendations(pkgVersion: PackageVersionType): PackageValidationRec[];
 }

package/build/Registry.js

@@ -1,9 +1,10 @@
 import * as semver from 'semver';
 import { PackageValidation, } from './types/Package.js';
+import { License } from './index-browser.js';
 export class Registry {
     registry;
     constructor(registry) {
-        this.registry = registry;
+        this.registry = Object.assign({}, registry);
     }
     packageAdd(slug) {
         return (this.registry.packages[slug] = {
@@ -91,7 +92,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,
@@ -110,4 +111,67 @@ export class Registry {
         });
         return errors;
     }
+    // TODO refactor all this using a proper validation library.
+    packageVersionRecommendations(pkgVersion) {
+        const recs = [];
+        // Urls
+        if (!pkgVersion.url.startsWith('https://')) {
+            recs.push({
+                field: 'url',
+                rec: 'should use https url',
+            });
+        }
+        if (!pkgVersion.url.includes('github.com') && !pkgVersion.url.includes('github.io')) {
+            recs.push({
+                field: 'url',
+                rec: 'should point to GitHub',
+            });
+        }
+        // Image/audio previews
+        if (pkgVersion.image && pkgVersion.image.includes('png')) {
+            recs.push({
+                field: 'image',
+                rec: 'should use the jpg format',
+            });
+        }
+        if (pkgVersion.audio && pkgVersion.audio.includes('wav')) {
+            recs.push({
+                field: 'audio',
+                rec: 'should use the flac format',
+            });
+        }
+        // Architectures/systems
+        const supportedArchitectures = {};
+        const supportedSystems = {};
+        pkgVersion.files.forEach(file => {
+            file.architectures.forEach(architecture => {
+                supportedArchitectures[architecture] = true;
+            });
+            file.systems.forEach(system => {
+                supportedSystems[system.type] = true;
+            });
+        });
+        if (!supportedArchitectures.arm64)
+            recs.push({ field: 'architectures', rec: 'should support Arm64' });
+        if (!supportedArchitectures.bit64)
+            recs.push({ field: 'architectures', rec: 'should support Bit64' });
+        if (!supportedSystems.linux)
+            recs.push({ field: 'systems', rec: 'should support Linux' });
+        if (!supportedSystems.mac)
+            recs.push({ field: 'systems', rec: 'should support Mac' });
+        if (!supportedSystems.win)
+            recs.push({ field: 'systems', rec: 'should support Windows' });
+        // Tags
+        const pluginTags = pkgVersion.tags.map(tag => tag.toLowerCase());
+        if (pluginTags.length < 2)
+            recs.push({ field: 'tags', rec: 'should have more items' });
+        // Licence
+        if (!Object.values(License).includes(pkgVersion.license)) {
+            recs.push({ field: 'license', rec: 'should be from the supported list' });
+        }
+        else if (pkgVersion.license === License.Other) {
+            recs.push({ field: 'license', rec: 'should be more specific' });
+        }
+        return recs;
+    }
 }

package/build/helpers/file.js

@@ -51,9 +51,9 @@ export function dirOpen(dir) {
     if (process.env.CI)
         return new Buffer('');
     if (process.platform === 'win32')
-        command = 'open';
-    else if (process.platform === 'darwin')
         command = 'start ""';
+    else if (process.platform === 'darwin')
+        command = 'open';
     else
         command = 'xdg-open';
     console.log('⎋', `${command} "${dir}"`);

package/build/types/Package.d.ts

@@ -38,3 +38,7 @@ export interface PackageValidationError {
     valueExpected: string;
     valueReceived: string;
 }
+export interface PackageValidationRec {
+    field: string;
+    rec: string;
+}

package/package.json

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