@soulcraft/brainy 0.9.5

package/dist/utils/distance.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Distance functions for vector similarity calculations
+ * Optimized for Node.js 23.11+ using enhanced array methods
+ */
+import { DistanceFunction } from '../coreTypes.js';
+/**
+ * Calculates the Euclidean distance between two vectors
+ * Lower values indicate higher similarity
+ * Optimized using array methods for Node.js 23.11+
+ */
+export declare const euclideanDistance: DistanceFunction;
+/**
+ * Calculates the cosine distance between two vectors
+ * Lower values indicate higher similarity
+ * Range: 0 (identical) to 2 (opposite)
+ * Optimized using array methods for Node.js 23.11+
+ */
+export declare const cosineDistance: DistanceFunction;
+/**
+ * Calculates the Manhattan (L1) distance between two vectors
+ * Lower values indicate higher similarity
+ * Optimized using array methods for Node.js 23.11+
+ */
+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)
+ * Optimized using array methods for Node.js 23.11+
+ */
+export declare const dotProductDistance: DistanceFunction;
+//# sourceMappingURL=distance.d.ts.map

package/dist/utils/embedding.d.ts

@@ -0,0 +1,55 @@
+/**
+ * Embedding functions for converting data to vectors
+ */
+import { EmbeddingFunction, EmbeddingModel, Vector } from '../coreTypes.js';
+/**
+ * TensorFlow Universal Sentence Encoder embedding model
+ * This model provides high-quality text embeddings using TensorFlow.js
+ * The required TensorFlow.js dependencies are automatically installed with this package
+ */
+export declare class UniversalSentenceEncoder implements EmbeddingModel {
+    private model;
+    private initialized;
+    private tf;
+    private use;
+    /**
+     * Initialize the embedding model
+     */
+    init(): Promise<void>;
+    /**
+     * Embed text into a vector using Universal Sentence Encoder
+     * @param data Text to embed
+     */
+    embed(data: string | string[]): Promise<Vector>;
+    /**
+     * Dispose of the model resources
+     */
+    dispose(): Promise<void>;
+}
+/**
+ * Create an embedding function from an embedding model
+ * @param model Embedding model to use
+ */
+export declare function createEmbeddingFunction(model: EmbeddingModel): EmbeddingFunction;
+/**
+ * Creates a TensorFlow-based Universal Sentence Encoder embedding function
+ * This is the required embedding function for all text embeddings
+ */
+export declare function createTensorFlowEmbeddingFunction(): EmbeddingFunction;
+/**
+ * Creates a TensorFlow-based Universal Sentence Encoder embedding function that runs in a separate thread
+ * This provides better performance for CPU-intensive embedding operations
+ * @param options Configuration options
+ * @returns An embedding function that runs in a separate thread
+ */
+export declare function createThreadedEmbeddingFunction(options?: {
+    fallbackToMain?: boolean;
+}): EmbeddingFunction;
+/**
+ * Default embedding function
+ * Uses UniversalSentenceEncoder for all text embeddings
+ * TensorFlow.js is required for this to work
+ * Uses threading when available for better performance
+ */
+export declare const defaultEmbeddingFunction: EmbeddingFunction;
+//# sourceMappingURL=embedding.d.ts.map

package/dist/utils/environment.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Utility functions for environment detection
+ */
+/**
+ * Check if code is running in a browser environment
+ */
+export declare function isBrowser(): boolean;
+/**
+ * Check if code is running in a Node.js environment
+ */
+export declare function isNode(): boolean;
+/**
+ * Check if code is running in a Web Worker environment
+ */
+export declare function isWebWorker(): boolean;
+/**
+ * Check if Web Workers are available in the current environment
+ */
+export declare function areWebWorkersAvailable(): boolean;
+/**
+ * Check if Worker Threads are available in the current environment (Node.js)
+ */
+export declare function areWorkerThreadsAvailable(): boolean;
+/**
+ * Determine if threading is available in the current environment
+ */
+export declare function isThreadingAvailable(): boolean;
+//# sourceMappingURL=environment.d.ts.map

package/dist/utils/index.d.ts

@@ -0,0 +1,3 @@
+export * from './distance.js';
+export * from './embedding.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/utils/version.d.ts

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

package/dist/utils/workerUtils.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Utility functions for working with Web Workers and Worker Threads
+ */
+/**
+ * Execute a function in a Web Worker (browser environment)
+ *
+ * @param fn The function to execute
+ * @param args The arguments to pass to the function
+ * @returns A promise that resolves with the result of the function
+ */
+export declare function executeInWebWorker<T>(fn: Function, ...args: any[]): Promise<T>;
+/**
+ * Execute a function in a Worker Thread (Node.js environment)
+ *
+ * @param fn The function to execute
+ * @param args The arguments to pass to the function
+ * @returns A promise that resolves with the result of the function
+ */
+export declare function executeInWorkerThread<T>(fn: Function, ...args: any[]): Promise<T>;
+/**
+ * Execute a function in a separate thread based on the environment
+ *
+ * @param fn The function to execute
+ * @param args The arguments to pass to the function
+ * @returns A promise that resolves with the result of the function
+ */
+export declare function executeInThread<T>(fn: Function, ...args: any[]): Promise<T>;
+//# sourceMappingURL=workerUtils.d.ts.map

package/package.json

@@ -0,0 +1,156 @@
+{
+  "name": "@soulcraft/brainy",
+  "version": "0.9.5",
+  "description": "A vector graph database using HNSW indexing with Origin Private File System storage",
+  "main": "dist/unified.js",
+  "module": "dist/unified.js",
+  "types": "dist/unified.d.ts",
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": "./dist/unified.js",
+      "types": "./dist/unified.d.ts"
+    },
+    "./min": {
+      "import": "./dist/unified.min.js"
+    },
+    "./types/graphTypes": {
+      "import": "./dist/types/graphTypes.js",
+      "types": "./dist/types/graphTypes.d.ts"
+    },
+    "./types/augmentations": {
+      "import": "./dist/types/augmentations.js",
+      "types": "./dist/types/augmentations.d.ts"
+    }
+  },
+  "engines": {
+    "node": ">=23.11.0"
+  },
+  "scripts": {
+    "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",
+    "start": "node dist/unified.js",
+    "demo": "npm run build && npm run build:browser && npx http-server -o /index.html",
+    "cli": "node ./cli-wrapper.js",
+    "version:patch": "npm version patch",
+    "version:minor": "npm version minor",
+    "version:major": "npm version major",
+    "deploy": "npm run build && npm publish",
+    "deploy:cloud:aws": "cd cloud-wrapper && npm run build && npm run deploy:aws",
+    "deploy:cloud:gcp": "cd cloud-wrapper && npm run build && npm run deploy:gcp",
+    "deploy:cloud:cloudflare": "cd cloud-wrapper && npm run build && npm run deploy:cloudflare",
+    "deploy:cloud": "echo 'Please use one of the following commands to deploy to a specific cloud provider:' && echo '  npm run deploy:cloud:aws' && echo '  npm run deploy:cloud:gcp' && echo '  npm run deploy:cloud:cloudflare'",
+    "postinstall": "echo 'Note: If you encounter dependency conflicts with TensorFlow.js packages, please use: npm install --legacy-peer-deps'"
+  },
+  "bin": {
+    "brainy": "cli-wrapper.js"
+  },
+  "keywords": [
+    "vector-database",
+    "hnsw",
+    "opfs",
+    "origin-private-file-system",
+    "embeddings",
+    "graph-database",
+    "streaming-data"
+  ],
+  "author": "David Snelling (david@soulcraft.com)",
+  "license": "MIT",
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "homepage": "https://github.com/soulcraft-research/brainy",
+  "bugs": {
+    "url": "https://github.com/soulcraft-research/brainy/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/soulcraft-research/brainy.git"
+  },
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts",
+    "dist/types/",
+    "LICENSE",
+    "README.md",
+    "cli-wrapper.js",
+    "brainy.png"
+  ],
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^25.0.7",
+    "@rollup/plugin-json": "^6.1.0",
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@rollup/plugin-replace": "^5.0.5",
+    "@rollup/plugin-typescript": "^11.1.6",
+    "@types/jest": "^29.5.3",
+    "@types/node": "^20.4.5",
+    "@types/omelette": "^0.4.5",
+    "@types/uuid": "^10.0.0",
+    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@typescript-eslint/parser": "^6.0.0",
+    "eslint": "^8.45.0",
+    "jest": "^29.6.2",
+    "rollup": "^4.12.0",
+    "rollup-plugin-terser": "^7.0.2",
+    "ts-jest": "^29.1.1",
+    "tslib": "^2.8.1",
+    "typescript": "^5.1.6"
+  },
+  "dependencies": {
+    "@aws-sdk/client-s3": "^3.427.0",
+    "@tensorflow-models/universal-sentence-encoder": "^1.3.3",
+    "@tensorflow/tfjs": "^4.22.0",
+    "@tensorflow/tfjs-backend-cpu": "^4.22.0",
+    "@tensorflow/tfjs-converter": "^4.22.0",
+    "@tensorflow/tfjs-core": "^4.22.0",
+    "@tensorflow/tfjs-layers": "^4.22.0",
+    "buffer": "^6.0.3",
+    "commander": "^14.0.0",
+    "omelette": "^0.4.17",
+    "uuid": "^9.0.0"
+  },
+  "prettier": {
+    "arrowParens": "always",
+    "bracketSameLine": true,
+    "bracketSpacing": true,
+    "htmlWhitespaceSensitivity": "css",
+    "printWidth": 80,
+    "proseWrap": "preserve",
+    "semi": false,
+    "singleQuote": true,
+    "tabWidth": 2,
+    "trailingComma": "none",
+    "useTabs": false
+  },
+  "eslintConfig": {
+    "root": true,
+    "extends": [
+      "eslint:recommended",
+      "plugin:@typescript-eslint/recommended"
+    ],
+    "parser": "@typescript-eslint/parser",
+    "plugins": [
+      "@typescript-eslint"
+    ],
+    "rules": {
+      "@typescript-eslint/no-explicit-any": "off",
+      "no-unused-vars": "off",
+      "@typescript-eslint/no-unused-vars": [
+        "warn",
+        {
+          "args": "after-used",
+          "argsIgnorePattern": "^_"
+        }
+      ],
+      "semi": "off",
+      "@typescript-eslint/semi": [
+        "error",
+        "never"
+      ],
+      "no-extra-semi": "off"
+    }
+  }
+}