@soulcraft/brainy 0.9.13 → 0.9.15

package/README.demo.md

@@ -4,8 +4,8 @@ The Brainy interactive demo showcases the library's features in a web browser. F
 
 ## Prerequisites
 
-- Make sure you have Node.js installed (version 23.11.0 or higher)
-- Ensure the project is built (`npm run build:all`)
+- Make sure you have Node.js installed (version 24.0.0 or higher)
+- Ensure the project is built (run both `npm run build` and `npm run build:browser`)
 
 ## Running the Demo
 
@@ -51,7 +51,13 @@ The Brainy library uses a two-step build process:
 You can run both steps together with:
 
 ```bash
-npm run build:all
+npm run build && npm run build:browser
+```
+
+Or simply use the demo script which does this for you:
+
+```bash
+npm run demo
 ```
 
 The browser bundle is created from `src/unified.ts`, which provides environment detection and adapts to browser,

package/README.md

@@ -6,7 +6,7 @@
 [![Node.js](https://img.shields.io/badge/node-%3E%3D24.0.0-brightgreen.svg)](https://nodejs.org/)
 [![TypeScript](https://img.shields.io/badge/TypeScript-5.1.6-blue.svg)](https://www.typescriptlang.org/)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)
-[![npm](https://img.shields.io/badge/npm-v0.9.13-blue.svg)](https://www.npmjs.com/package/@soulcraft/brainy)
+[![npm](https://img.shields.io/badge/npm-v0.9.15-blue.svg)](https://www.npmjs.com/package/@soulcraft/brainy)
 
 [//]: # ([![Cartographer](https://img.shields.io/badge/Cartographer-Official%20Standard-brightgreen)](https://github.com/sodal-project/cartographer))
 
@@ -300,8 +300,8 @@ Brainy uses a modern build system that optimizes for both Node.js and browser en
 5. **Build Scripts**
     - `npm run build`: Builds the Node.js version
     - `npm run build:browser`: Builds the browser-optimized version
-    - `npm run build:all`: Builds both versions
-    - `npm run demo`: Builds all versions and starts a demo server
+    - `npm run build:cli`: Builds the CLI version
+    - `npm run demo`: Builds both Node.js and browser versions and starts a demo server
     - GitHub Actions workflow: Automatically deploys the demo directory to GitHub Pages when pushing to the main branch
 
 ### Running the Pipeline

package/dist/utils/distance-js.d.ts

@@ -0,0 +1,38 @@
+/**
+ * JavaScript implementations of distance functions for vector similarity calculations
+ * Used as fallbacks when WebAssembly is not available
+ */
+import { DistanceFunction, Vector } from '../coreTypes.js';
+/**
+ * Calculates the Euclidean distance between two vectors
+ * Lower values indicate higher similarity
+ */
+export declare const euclideanDistance: DistanceFunction;
+/**
+ * Calculates the cosine distance between two vectors
+ * Lower values indicate higher similarity
+ * Range: 0 (identical) to 2 (opposite)
+ */
+export declare const cosineDistance: DistanceFunction;
+/**
+ * Calculates the Manhattan (L1) distance between two vectors
+ * Lower values indicate higher similarity
+ */
+export declare const manhattanDistance: DistanceFunction;
+/**
+ * Calculates the dot product similarity between two vectors
+ * Higher values indicate higher similarity
+ * Converted to a distance metric (lower is better)
+ */
+export declare const dotProductDistance: DistanceFunction;
+/**
+ * Batch distance calculation
+ * Calculates distances between a query vector and multiple vectors
+ *
+ * @param queryVector The query vector to compare against all vectors
+ * @param vectors Array of vectors to compare against
+ * @param distanceFunction The distance function to use
+ * @returns Promise resolving to array of distances
+ */
+export declare function calculateDistancesBatch(queryVector: Vector, vectors: Vector[], distanceFunction?: DistanceFunction): Promise<number[]>;
+//# sourceMappingURL=distance-js.d.ts.map

package/dist/utils/distance-wasm.d.ts

@@ -0,0 +1,36 @@
+/**
+ * WebAssembly implementation of distance functions for vector similarity calculations
+ * High-performance implementation with GPU acceleration when available
+ */
+import { DistanceFunction, Vector } from '../coreTypes.js';
+/**
+ * Load the WebAssembly module
+ * @returns Promise that resolves when the module is loaded
+ */
+export declare function loadWasmModule(): Promise<void>;
+/**
+ * Calculates the Euclidean distance between two vectors
+ * Uses WebAssembly implementation when available, falls back to JavaScript
+ */
+export declare const euclideanDistance: DistanceFunction;
+/**
+ * Calculates the cosine distance between two vectors
+ * Uses WebAssembly implementation when available, falls back to JavaScript
+ */
+export declare const cosineDistance: DistanceFunction;
+/**
+ * Calculates the Manhattan distance between two vectors
+ * Uses WebAssembly implementation when available, falls back to JavaScript
+ */
+export declare const manhattanDistance: DistanceFunction;
+/**
+ * Calculates the dot product distance between two vectors
+ * Uses WebAssembly implementation when available, falls back to JavaScript
+ */
+export declare const dotProductDistance: DistanceFunction;
+/**
+ * Batch distance calculation
+ * Uses WebAssembly implementation when available, falls back to JavaScript
+ */
+export declare function calculateDistancesBatch(queryVector: Vector, vectors: Vector[], distanceFunction?: DistanceFunction): Promise<number[]>;
+//# sourceMappingURL=distance-wasm.d.ts.map

package/dist/utils/version.d.ts

@@ -2,5 +2,5 @@
  * This file is auto-generated during the build process.
  * Do not modify this file directly.
  */
-export declare const VERSION = "0.9.13";
+export declare const VERSION = "0.9.15";
 //# sourceMappingURL=version.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@soulcraft/brainy",
-  "version": "0.9.13",
+  "version": "0.9.15",
   "description": "A vector graph database using HNSW indexing with Origin Private File System storage",
   "main": "dist/unified.js",
   "module": "dist/unified.js",
@@ -31,9 +31,10 @@
     "prebuild": "node scripts/generate-version.js",
     "build": "BUILD_TYPE=unified rollup -c rollup.config.js",
     "build:browser": "BUILD_TYPE=browser rollup -c rollup.config.js",
+    "build:cli": "BUILD_TYPE=cli rollup -c rollup.config.js",
     "start": "node dist/unified.js",
     "demo": "npm run build && npm run build:browser && npx http-server -o /index.html",
-    "cli": "node ./cli-wrapper.js",
+    "cli": "npm run build:cli && node ./cli-wrapper.js",
     "version": "node scripts/generate-version.js",
     "version:patch": "npm version patch",
     "version:minor": "npm version minor",