@open-audio-stack/core 0.0.12 → 0.0.14

package/build/Registry.d.ts

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

package/build/Registry.js

@@ -1,6 +1,4 @@
 import * as semver from 'semver';
-import { PackageValidation, } from './types/Package.js';
-import { License } from './types/License.js';
 export class Registry {
     registry;
     constructor(registry) {
@@ -74,104 +72,4 @@ export class Registry {
             this.packageRemove(slug);
         }
     }
-    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' },
-            { name: 'type', type: 'string' },
-            { name: 'url', type: 'string' },
-        ];
-        const errors = [];
-        fields.forEach((field) => {
-            const versionField = pkgVersion[field.name];
-            if (versionField === undefined) {
-                errors.push({
-                    field: field.name,
-                    error: PackageValidation.MISSING_FIELD,
-                    valueExpected: field.type,
-                    valueReceived: 'undefined',
-                });
-            }
-            else if (typeof versionField !== field.type) {
-                errors.push({
-                    field: field.name,
-                    error: PackageValidation.INVALID_TYPE,
-                    valueExpected: field.type,
-                    valueReceived: typeof versionField,
-                });
-            }
-        });
-        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/package.d.ts

@@ -0,0 +1,3 @@
+import { PackageValidationError, PackageValidationRec, PackageVersionType } from '../types/Package.js';
+export declare function packageRecommendations(pkgVersion: PackageVersionType): PackageValidationRec[];
+export declare function packageValidate(pkgVersion: PackageVersionType): PackageValidationError[];

package/build/helpers/package.js

@@ -0,0 +1,102 @@
+import { License } from '../types/License.js';
+import { PackageValidation, } from '../types/Package.js';
+// TODO refactor all this using a proper validation library.
+export function packageRecommendations(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;
+}
+export function packageValidate(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' },
+        { name: 'type', type: 'string' },
+        { name: 'url', type: 'string' },
+    ];
+    const errors = [];
+    fields.forEach((field) => {
+        const versionField = pkgVersion[field.name];
+        if (versionField === undefined) {
+            errors.push({
+                field: field.name,
+                error: PackageValidation.MISSING_FIELD,
+                valueExpected: field.type,
+                valueReceived: 'undefined',
+            });
+        }
+        else if (typeof versionField !== field.type) {
+            errors.push({
+                field: field.name,
+                error: PackageValidation.INVALID_TYPE,
+                valueExpected: field.type,
+                valueReceived: typeof versionField,
+            });
+        }
+    });
+    return errors;
+}

package/build/helpers/utils.js

@@ -1,6 +1,6 @@
 import chalk from 'chalk';
 export function logReport(info, errors, recs) {
-    if (errors) {
+    if (errors && errors.length > 0) {
         console.log(chalk.red(`X ${info}`));
         logErrors(errors);
     }

package/build/index-browser.d.ts

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

package/build/index-browser.js

@@ -8,6 +8,7 @@ export * from './Registry.js';
 // Helpers
 export * from './helpers/api.js';
 // export * from './helpers/file.js';
+export * from './helpers/package.js';
 export * from './helpers/utils.js';
 // Types
 export * from './types/Architecture.js';

package/build/index.d.ts

@@ -2,6 +2,7 @@ export * from './Config.js';
 export * from './Registry.js';
 export * from './helpers/api.js';
 export * from './helpers/file.js';
+export * from './helpers/package.js';
 export * from './helpers/utils.js';
 export * from './types/Architecture.js';
 export * from './types/Config.js';

package/build/index.js

@@ -8,6 +8,7 @@ export * from './Registry.js';
 // Helpers
 export * from './helpers/api.js';
 export * from './helpers/file.js';
+export * from './helpers/package.js';
 export * from './helpers/utils.js';
 // Types
 export * from './types/Architecture.js';

package/package.json

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