@open-audio-stack/core 0.0.17 → 0.0.18

package/build/helpers/package.d.ts

@@ -1,3 +1,5 @@
+import { PluginFile, PresetFile, ProjectFile } from '../index-browser.js';
 import { PackageValidationError, PackageValidationRec, PackageVersionType } from '../types/Package.js';
 export declare function packageRecommendations(pkgVersion: PackageVersionType): PackageValidationRec[];
+export declare function packageRecommendationsUrl(obj: PackageVersionType | PluginFile | PresetFile | ProjectFile, recs: PackageValidationRec[], field: string): void;
 export declare function packageValidate(pkgVersion: PackageVersionType): PackageValidationError[];

package/build/helpers/package.js

@@ -3,27 +3,17 @@ 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',
-        });
-    }
+    packageRecommendationsUrl(pkgVersion, recs, 'audio');
+    packageRecommendationsUrl(pkgVersion, recs, 'image');
+    packageRecommendationsUrl(pkgVersion, recs, 'url');
     // Image/audio previews
-    if (pkgVersion.image && pkgVersion.image.includes('png')) {
+    if (pkgVersion.image && pkgVersion.image.endsWith('png')) {
         recs.push({
             field: 'image',
             rec: 'should use the jpg format',
         });
     }
-    if (pkgVersion.audio && pkgVersion.audio.includes('wav')) {
+    if (pkgVersion.audio && pkgVersion.audio.endsWith('wav')) {
         recs.push({
             field: 'audio',
             rec: 'should use the flac format',
@@ -39,6 +29,7 @@ export function packageRecommendations(pkgVersion) {
         file.systems.forEach(system => {
             supportedSystems[system.type] = true;
         });
+        packageRecommendationsUrl(file, recs, 'url');
     });
     if (!supportedArchitectures.arm64)
         recs.push({ field: 'architectures', rec: 'should support arm64' });
@@ -63,6 +54,24 @@ export function packageRecommendations(pkgVersion) {
     }
     return recs;
 }
+export function packageRecommendationsUrl(obj, recs, field) {
+    // @ts-expect-error indexing a field with multiple package types.
+    const val = obj[field];
+    if (typeof val !== 'string')
+        return;
+    if (!val.startsWith('https://')) {
+        recs.push({
+            field,
+            rec: 'should use https url',
+        });
+    }
+    if (!val.includes('github.com') && !val.includes('github.io')) {
+        recs.push({
+            field,
+            rec: 'should point to GitHub',
+        });
+    }
+}
 export function packageValidate(pkgVersion) {
     const fields = [
         { name: 'audio', type: 'string' },

package/package.json

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