@open-audio-stack/core 0.1.29 → 0.1.31

package/build/classes/ManagerLocal.js

@@ -81,6 +81,11 @@ export class ManagerLocal extends Manager {
                 message: 'Website url',
                 default: `https://github.com/${pkgAnswers.org}/${pkgAnswers.package}`,
             },
+            {
+                name: 'donate',
+                type: 'input',
+                message: 'Donation url',
+            },
             {
                 name: 'audio',
                 type: 'input',
@@ -114,13 +119,7 @@ export class ManagerLocal extends Manager {
     scan(ext = 'json', installable = true) {
         const filePaths = dirRead(path.join(this.typeDir, '**', `index.${ext}`));
         filePaths.forEach((filePath) => {
-            let subPath = filePath.replace(`${this.typeDir}${path.sep}`, '');
-            // TODO improve this code.
-            if (this.type === RegistryType.Plugins || this.type === RegistryType.Presets) {
-                const parts = subPath.split(path.sep);
-                parts.shift();
-                subPath = parts.join(path.sep);
-            }
+            const subPath = filePath.replace(`${this.typeDir}${path.sep}`, '');
             const pkgJson = ext === 'yaml' ? fileReadYaml(filePath) : fileReadJson(filePath);
             if (installable)
                 pkgJson.installed = true;

package/build/helpers/package.d.ts

@@ -96,6 +96,7 @@ export declare const PackageVersionValidator: z.ZodObject<{
     changes: z.ZodString;
     date: z.ZodString;
     description: z.ZodString;
+    donate: z.ZodOptional<z.ZodString>;
     files: z.ZodArray<z.ZodObject<{
         architectures: z.ZodArray<z.ZodNativeEnum<typeof Architecture>, "many">;
         sha256: z.ZodString;
@@ -169,6 +170,7 @@ export declare const PackageVersionValidator: z.ZodObject<{
     author: string;
     changes: string;
     description: string;
+    type: PluginType | PresetType | ProjectType;
     files: {
         type: FileType;
         architectures: Architecture[];
@@ -181,18 +183,19 @@ export declare const PackageVersionValidator: z.ZodObject<{
         }[];
         url: string;
     }[];
-    type: PluginType | PresetType | ProjectType;
     url: string;
     image: string;
     license: License;
     name: string;
     tags: string[];
+    donate?: string | undefined;
 }, {
     date: string;
     audio: string;
     author: string;
     changes: string;
     description: string;
+    type: PluginType | PresetType | ProjectType;
     files: {
         type: FileType;
         architectures: Architecture[];
@@ -205,12 +208,12 @@ export declare const PackageVersionValidator: z.ZodObject<{
         }[];
         url: string;
     }[];
-    type: PluginType | PresetType | ProjectType;
     url: string;
     image: string;
     license: License;
     name: string;
     tags: string[];
+    donate?: string | undefined;
 }>;
 export declare function packageRecommendations(pkgVersion: PackageVersion): PackageValidationRec[];
-export declare function packageRecommendationsUrl(obj: PackageVersion | PluginFile | PresetFile | ProjectFile, recs: PackageValidationRec[], field: string): void;
+export declare function packageRecommendationsUrl(obj: PackageVersion | PluginFile | PresetFile | ProjectFile, recs: PackageValidationRec[], field: string, domain?: string): void;

package/build/helpers/package.js

@@ -61,6 +61,7 @@ export const PackageVersionValidator = z.object({
     changes: z.string().min(0).max(256),
     date: z.string().datetime(),
     description: z.string().min(0).max(256),
+    donate: z.optional(z.string().min(0).max(256).startsWith('https://')),
     files: z.array(PackageFileValidator),
     image: z.string().min(0).max(256).startsWith('https://'),
     license: z.nativeEnum(License),
@@ -72,9 +73,10 @@ export const PackageVersionValidator = z.object({
 // TODO refactor all this using a proper validation library.
 export function packageRecommendations(pkgVersion) {
     const recs = [];
-    packageRecommendationsUrl(pkgVersion, recs, 'audio');
-    packageRecommendationsUrl(pkgVersion, recs, 'image');
-    packageRecommendationsUrl(pkgVersion, recs, 'url');
+    packageRecommendationsUrl(pkgVersion, recs, 'audio', 'github');
+    packageRecommendationsUrl(pkgVersion, recs, 'image', 'github');
+    packageRecommendationsUrl(pkgVersion, recs, 'url', 'github');
+    packageRecommendationsUrl(pkgVersion, recs, 'donate');
     // Image/audio previews
     if (pkgVersion.image && pkgVersion.image.endsWith('png')) {
         recs.push({
@@ -102,7 +104,7 @@ export function packageRecommendations(pkgVersion) {
             });
             const ext = pathGetExt(file.url);
             supportedFileFormats[ext] = true;
-            packageRecommendationsUrl(file, recs, 'url');
+            packageRecommendationsUrl(file, recs, 'url', 'github');
             // Formats which do not support headless installation.
             if (ext === FileFormat.AppImage)
                 recs.push({ field: 'url', rec: 'requires manual installation steps, consider .deb and .rpm instead' });
@@ -170,7 +172,7 @@ export function packageRecommendations(pkgVersion) {
     }
     return recs;
 }
-export function packageRecommendationsUrl(obj, recs, field) {
+export function packageRecommendationsUrl(obj, recs, field, domain) {
     // @ts-expect-error indexing a field with multiple package types.
     const val = obj[field];
     if (typeof val !== 'string')
@@ -181,7 +183,7 @@ export function packageRecommendationsUrl(obj, recs, field) {
             rec: 'should use https url',
         });
     }
-    if (!val.includes('github.com') && !val.includes('github.io')) {
+    if (domain && !val.includes(`${domain}.com`) && !val.includes(`${domain}.io`)) {
         recs.push({
             field,
             rec: 'should point to GitHub',

package/build/helpers/utils.js

@@ -26,11 +26,13 @@ export function pathGetFilename(path, sep = '/') {
 }
 export function pathGetSlug(path, sep = '/') {
     const parts = path.split(sep);
-    return parts[0] + '/' + parts[1];
+    const index = parts.findIndex(part => semver.valid(part));
+    return parts[index - 2] + '/' + parts[index - 1];
 }
 export function pathGetVersion(path, sep = '/') {
     const parts = path.split(sep);
-    return parts[parts.length - 2];
+    const index = parts.findIndex(part => semver.valid(part));
+    return parts[index];
 }
 export function toSlug(val) {
     // @ts-expect-error slugify library issue with ESM modules

package/build/types/Package.d.ts

@@ -17,6 +17,7 @@ export interface PackageBase {
     changes: string;
     date: string;
     description: string;
+    donate?: string;
     image: string;
     installed?: boolean;
     license: License;

package/package.json

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