@open-audio-stack/core 0.0.9 → 0.0.11

package/build/Registry.js

@@ -1,6 +1,6 @@
 import * as semver from 'semver';
 import { PackageValidation, } from './types/Package.js';
-import { License } from './index-browser.js';
+import { License } from './types/License.js';
 export class Registry {
     registry;
     constructor(registry) {

package/build/helpers/file.d.ts

@@ -1,4 +1,7 @@
 import { PackageInterface } from '../types/Package.js';
+import { PluginFile } from '../types/Plugin.js';
+import { PresetFile } from '../types/Preset.js';
+import { ProjectFile } from '../types/Project.js';
 export declare function dirApp(): string;
 export declare function dirCreate(dir: string): string | false;
 export declare function dirDelete(dir: string): false | void;
@@ -22,10 +25,11 @@ export declare function fileJsonCreate(filePath: string, data: object): void;
 export declare function fileHash(filePath: string, algorithm?: string): string;
 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 fileRead(filePath: string): string;
 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 fileValidateMetadata(filePath: string, fileMetadata: PluginFile | PresetFile | ProjectFile): void;
 export declare function zipCreate(filesPath: string, zipPath: string): void;
 export declare function zipExtract(content: any, dirPath: string): void;

package/build/helpers/file.js

@@ -7,6 +7,7 @@ import { moveSync } from 'fs-extra/esm';
 import os from 'os';
 import path from 'path';
 import yaml from 'js-yaml';
+import { PackageValidation } from '../types/Package.js';
 export function dirApp() {
     if (process.platform === 'win32')
         return process.env.APPDATA || os.homedir();
@@ -128,7 +129,8 @@ export function fileJsonCreate(filePath, data) {
 }
 export function fileHash(filePath, algorithm = 'sha256') {
     const fileData = fileReadString(filePath);
-    return createHash(algorithm).update(fileData, 'utf8').digest('hex');
+    const fileNormalized = fileData.replace(/\r\n/g, '\n');
+    return createHash(algorithm).update(fileNormalized, 'utf8').digest('hex');
 }
 export function fileMove(filePath, newPath) {
     if (fileExists(filePath)) {
@@ -153,18 +155,18 @@ export function fileOpen(filePath) {
 }
 export function fileRead(filePath) {
     console.log('⎋', filePath);
-    return readFileSync(filePath);
+    return readFileSync(filePath, 'utf8');
 }
 export function fileReadJson(filePath) {
     if (fileExists(filePath)) {
         console.log('⎋', filePath);
-        return JSON.parse(readFileSync(filePath).toString());
+        return JSON.parse(readFileSync(filePath, 'utf8').toString());
     }
     return false;
 }
 export function fileReadString(filePath) {
     console.log('⎋', filePath);
-    return readFileSync(filePath).toString();
+    return readFileSync(filePath, 'utf8').toString();
 }
 export function fileReadYaml(filePath) {
     const file = fileReadString(filePath);
@@ -173,6 +175,25 @@ export function fileReadYaml(filePath) {
 export function fileSize(filePath) {
     return statSync(filePath).size;
 }
+export function fileValidateMetadata(filePath, fileMetadata) {
+    const errors = [];
+    if (fileMetadata.hash !== fileHash(filePath)) {
+        errors.push({
+            field: 'hash',
+            error: PackageValidation.INVALID_VALUE,
+            valueExpected: fileHash(filePath),
+            valueReceived: fileMetadata.hash,
+        });
+    }
+    if (fileMetadata.size !== fileSize(filePath)) {
+        errors.push({
+            field: 'size',
+            error: PackageValidation.INVALID_VALUE,
+            valueExpected: String(fileSize(filePath)),
+            valueReceived: String(fileMetadata.size),
+        });
+    }
+}
 export function zipCreate(filesPath, zipPath) {
     if (fileExists(zipPath)) {
         unlinkSync(zipPath);

package/build/helpers/utils.d.ts

@@ -1,3 +1,7 @@
+import { PackageValidationError, PackageValidationRec } from '../types/Package.js';
+export declare function logReport(info: string, errors?: PackageValidationError[], recs?: PackageValidationRec[]): void;
+export declare function logErrors(errors: PackageValidationError[]): void;
+export declare function logRecommendations(recs: PackageValidationRec[]): void;
 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;

package/build/helpers/utils.js

@@ -1,3 +1,25 @@
+import chalk from 'chalk';
+export function logReport(info, errors, recs) {
+    if (errors) {
+        console.log(chalk.red(`X ${info}`));
+        logErrors(errors);
+    }
+    else {
+        console.log(chalk.green(`✓ ${info}`));
+    }
+    if (recs)
+        logRecommendations(recs);
+}
+export function logErrors(errors) {
+    errors.forEach(error => {
+        console.log(chalk.red(`- ${error.field} (${error.error}) received '${error.valueReceived}' expected '${error.valueExpected}'`));
+    });
+}
+export function logRecommendations(recs) {
+    recs.forEach(rec => {
+        console.log(chalk.yellow(`- ${rec.field} ${rec.rec}`));
+    });
+}
 export function pathGetExt(path, sep = '.') {
     return path.substring(path.lastIndexOf(sep) + 1);
 }

package/build/types/Package.d.ts

@@ -35,8 +35,8 @@ export interface PackageValidationField {
 export interface PackageValidationError {
     field: string;
     error: PackageValidation;
-    valueExpected: string;
-    valueReceived: string;
+    valueExpected: boolean | number | string;
+    valueReceived: boolean | number | string;
 }
 export interface PackageValidationRec {
     field: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-audio-stack/core",
-  "version": "0.0.9",
+  "version": "0.0.11",
   "description": "Open-source audio plugin management software",
   "type": "module",
   "main": "./build/index.js",
@@ -52,6 +52,7 @@
   },
   "dependencies": {
     "adm-zip": "^0.5.16",
+    "chalk": "^5.3.0",
     "fs-extra": "^11.2.0",
     "glob": "^11.0.0",
     "js-yaml": "^4.1.0",