@soulcraft/brainy 0.11.0 → 0.13.0

package/README.demo.md

@@ -35,7 +35,7 @@ npx http-server
 If you see the error "Could not load Brainy library. Please ensure the project is built and served over HTTP", check the
 following:
 
-1. Make sure you've built the project with `npm run build:all`
+1. Make sure you've built the project with `npm run build && npm run build:browser`
 2. Ensure you're accessing the demo through HTTP (not by opening the file directly)
 3. Check your browser's console for additional error messages
 

package/README.md

@@ -6,7 +6,7 @@
 [![Node.js](https://img.shields.io/badge/node-%3E%3D24.4.0-brightgreen.svg)](https://nodejs.org/)
 [![TypeScript](https://img.shields.io/badge/TypeScript-5.4.5-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.11.0-blue.svg)](https://www.npmjs.com/package/@soulcraft/brainy)
+[![npm](https://img.shields.io/badge/npm-v0.13.0-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))
 
@@ -62,12 +62,7 @@ GitHub Pages that showcases Brainy's main features.
 npm install @soulcraft/brainy
 ```
 
-TensorFlow.js packages are included as required dependencies and will be automatically installed. If you encounter
-dependency conflicts, you may need to use the `--legacy-peer-deps` flag:
-
-```bash
-npm install @soulcraft/brainy --legacy-peer-deps
-```
+TensorFlow.js packages are included as bundled dependencies and will be automatically installed without any additional configuration.
 
 ## 🏁 Quick Start
 
@@ -110,14 +105,9 @@ import { BrainyData } from '@soulcraft/brainy'
 
 // Minified version for production
 import { BrainyData } from '@soulcraft/brainy/min'
-
-// CLI functionality (only imported when needed)
-import '@soulcraft/brainy/cli'
 ```
 
-> **Note**: The CLI functionality (4MB) is not included in the standard import, reducing the bundle size for browser and
-> Node.js applications. The CLI is only built and loaded when explicitly imported or when using the command-line
-> interface.
+> **Note**: The CLI functionality is available as a separate package `@soulcraft/brainy-cli` to reduce the bundle size of the main package. Install it globally with `npm install -g @soulcraft/brainy-cli` to use the command-line interface.
 
 ### Browser Usage
 
@@ -417,18 +407,13 @@ brainy visualize --root <id> --depth 3
 
 ### Using the CLI in Your Code
 
-If you need to use the CLI functionality in your code, you can import it explicitly:
-
-```typescript
-// Import the CLI functionality
-import '@soulcraft/brainy/cli'
+The CLI functionality is available as a separate package `@soulcraft/brainy-cli`. If you need CLI functionality in your application, install the CLI package:
 
-// Now you can use the CLI programmatically
-// ...
+```bash
+npm install @soulcraft/brainy-cli
 ```
 
-This will only build and load the CLI when you explicitly import it, keeping your bundle size small when you don't need
-the CLI.
+Then you can use the CLI commands programmatically or through the command line interface.
 
 ### Available Commands
 
@@ -933,8 +918,7 @@ the augmentation pipeline as tools:
 Environment compatibility:
 
 - **BrainyMCPAdapter** and **MCPAugmentationToolset** can run in any environment (browser, Node.js, server)
-- **BrainyMCPService** core functionality works in any environment, but server functionality (WebSocket/REST) is in the
-  cloud-wrapper project
+- **BrainyMCPService** core functionality works in any environment
 
 For detailed documentation and usage examples, see the [MCP documentation](src/mcp/README.md).
 
@@ -984,46 +968,6 @@ Works in all modern browsers:
 
 For browsers without OPFS support, falls back to in-memory storage.
 
-## Cloud Deployment
-
-Brainy can be deployed as a standalone web service on various cloud platforms using the included cloud wrapper:
-
-- **AWS Lambda and API Gateway**: Deploy as a serverless function with API Gateway
-- **Google Cloud Run**: Deploy as a containerized service
-- **Cloudflare Workers**: Deploy as a serverless function on the edge
-
-The cloud wrapper provides both RESTful and WebSocket APIs for all Brainy operations, enabling both request-response and
-real-time communication patterns. It supports multiple storage backends and can be configured via environment variables.
-
-Key features of the cloud wrapper:
-
-- RESTful API for standard CRUD operations
-- WebSocket API for real-time updates and subscriptions
-- Model Control Protocol (MCP) service for external model access
-- Support for multiple storage backends (Memory, FileSystem, S3)
-- Configurable via environment variables
-- Deployment scripts for AWS, Google Cloud, and Cloudflare
-
-### Deploying to the Cloud
-
-You can deploy the cloud wrapper to various cloud platforms using the following npm scripts from the root directory:
-
-```bash
-# Deploy to AWS Lambda and API Gateway
-npm run deploy:cloud:aws
-
-# Deploy to Google Cloud Run
-npm run deploy:cloud:gcp
-
-# Deploy to Cloudflare Workers
-npm run deploy:cloud:cloudflare
-
-# Show available deployment options
-npm run deploy:cloud
-```
-
-Before deploying, make sure to configure the appropriate environment variables in the `cloud-wrapper/.env` file. See
-the [Cloud Wrapper README](cloud-wrapper/README.md) for detailed configuration instructions and API documentation.
 
 ## Related Projects
 

package/dist/brainyData.d.ts

@@ -8,6 +8,10 @@ import { NounType, VerbType } from './types/graphTypes.js';
 import { WebSocketConnection } from './types/augmentations.js';
 import { BrainyDataInterface } from './types/brainyDataInterface.js';
 export interface BrainyDataConfig {
+    /**
+     * Vector dimensions (required if not using an embedding function that auto-detects dimensions)
+     */
+    dimensions?: number;
     /**
      * HNSW index configuration
      */
@@ -85,6 +89,17 @@ export interface BrainyDataConfig {
          */
         autoConnect?: boolean;
     };
+    /**
+     * Logging configuration
+     */
+    logging?: {
+        /**
+         * Whether to enable verbose logging
+         * When false, suppresses non-essential log messages like model loading progress
+         * Default: true
+         */
+        verbose?: boolean;
+    };
 }
 export declare class BrainyData<T = any> implements BrainyDataInterface<T> {
     private index;
@@ -97,9 +112,23 @@ export declare class BrainyData<T = any> implements BrainyDataInterface<T> {
     private readOnly;
     private storageConfig;
     private useOptimizedIndex;
+    private _dimensions;
+    private loggingConfig;
     private remoteServerConfig;
     private serverSearchConduit;
     private serverConnection;
+    /**
+     * Get the vector dimensions
+     */
+    get dimensions(): number;
+    /**
+     * Get the maximum connections parameter from HNSW configuration
+     */
+    get maxConnections(): number;
+    /**
+     * Get the efConstruction parameter from HNSW configuration
+     */
+    get efConstruction(): number;
     /**
      * Create a new vector database
      */
@@ -134,6 +163,18 @@ export declare class BrainyData<T = any> implements BrainyDataInterface<T> {
         addToRemote?: boolean;
         id?: string;
     }): Promise<string>;
+    /**
+     * Add a text item to the database with automatic embedding
+     * This is a convenience method for adding text data with metadata
+     * @param text Text data to add
+     * @param metadata Metadata to associate with the text
+     * @param options Additional options
+     * @returns The ID of the added item
+     */
+    addItem(text: string, metadata?: T, options?: {
+        addToRemote?: boolean;
+        id?: string;
+    }): Promise<string>;
     /**
      * Add data to both local and remote Brainy instances
      * @param vectorOrData Vector or data to add

package/dist/patched-platform-node.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Custom patched implementation of TensorFlow.js PlatformNode class
+ * This resolves the TextEncoder/TextDecoder constructor issues
+ */
+export declare class PatchedPlatformNode {
+    util: {
+        TextEncoder: typeof TextEncoder;
+        TextDecoder: typeof TextDecoder;
+        isFloat32Array: (arr: any) => boolean;
+        isTypedArray: (arr: any) => boolean;
+    };
+    textEncoder: TextEncoder;
+    textDecoder: TextDecoder;
+    constructor();
+    isFloat32Array(arr: any): boolean;
+    isTypedArray(arr: any): boolean;
+}

package/dist/setup.d.ts

@@ -1 +1,17 @@
+/**
+ * CRITICAL: This file is imported for its side effects to patch the environment
+ * for TensorFlow.js before any other library code runs.
+ *
+ * It ensures that by the time TensorFlow.js is imported by any other
+ * module, the necessary compatibility fixes for the current Node.js
+ * environment are already in place.
+ *
+ * This file MUST be imported as the first import in unified.ts to prevent
+ * race conditions with TensorFlow.js initialization. Failure to do so will
+ * result in errors like "TextEncoder is not a constructor" when the package
+ * is used in Node.js environments.
+ *
+ * The package.json file marks this file as having side effects to prevent
+ * tree-shaking by bundlers, ensuring the patch is always applied.
+ */
 export {};

package/dist/storage/fileSystemStorage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fileSystemStorage.d.ts","sourceRoot":"","sources":["../../src/storage/fileSystemStorage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AA4DrE;;GAEG;AACH,qBAAa,iBAAkB,YAAW,cAAc;IACtD,OAAO,CAAC,OAAO,CAAQ;IACvB,OAAO,CAAC,QAAQ,CAAQ;IACxB,OAAO,CAAC,QAAQ,CAAQ;IACxB,OAAO,CAAC,WAAW,CAAQ;IAC3B,OAAO,CAAC,SAAS,CAAQ;IACzB,OAAO,CAAC,QAAQ,CAAQ;IACxB,OAAO,CAAC,QAAQ,CAAQ;IACxB,OAAO,CAAC,QAAQ,CAAQ;IACxB,OAAO,CAAC,UAAU,CAAQ;IAC1B,OAAO,CAAC,UAAU,CAAQ;IAC1B,OAAO,CAAC,UAAU,CAAQ;IAC1B,OAAO,CAAC,aAAa,CAAQ;gBAEjB,aAAa,CAAC,EAAE,MAAM;IAelC;;OAEG;IACU,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;YAoDpB,qBAAqB;IAWnC,OAAO,CAAC,WAAW;IA6BN,QAAQ,CACnB,IAAI,EAAE,QAAQ,GAAG;QAAE,QAAQ,CAAC,EAAE;YAAE,IAAI,CAAC,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,GAChD,OAAO,CAAC,IAAI,CAAC;IAQH,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAyB7C,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBrC,WAAW,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;IA+B/C;;;;OAIG;IACU,kBAAkB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IA8CzD,QAAQ,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAMrD;;;;OAIG;IACU,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC;IAc9C,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAMrE;;;;OAIG;IACU,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAMrE;;;;OAIG;IACU,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAMlD,WAAW,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;IAoBnC,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAalD;;;;OAIG;IACU,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IAMnE;;;;OAIG;IACU,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,GAAG,IAAI,CAAC;IAc5C,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAOtB,gBAAgB,IAAI,OAAO,CAAC;QACvC,IAAI,EAAE,MAAM,CAAA;QACZ,IAAI,EAAE,MAAM,CAAA;QACZ,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;QACpB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;KAC9B,CAAC;CAyCH"}
+{"version":3,"file":"fileSystemStorage.d.ts","sourceRoot":"","sources":["../../src/storage/fileSystemStorage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AA4DrE;;GAEG;AACH,qBAAa,iBAAkB,YAAW,cAAc;IACtD,OAAO,CAAC,OAAO,CAAQ;IACvB,OAAO,CAAC,QAAQ,CAAQ;IACxB,OAAO,CAAC,QAAQ,CAAQ;IACxB,OAAO,CAAC,WAAW,CAAQ;IAC3B,OAAO,CAAC,SAAS,CAAQ;IACzB,OAAO,CAAC,QAAQ,CAAQ;IACxB,OAAO,CAAC,QAAQ,CAAQ;IACxB,OAAO,CAAC,QAAQ,CAAQ;IACxB,OAAO,CAAC,UAAU,CAAQ;IAC1B,OAAO,CAAC,UAAU,CAAQ;IAC1B,OAAO,CAAC,UAAU,CAAQ;IAC1B,OAAO,CAAC,aAAa,CAAQ;gBAEjB,aAAa,CAAC,EAAE,MAAM;IAelC;;OAEG;IACU,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;YA2DpB,qBAAqB;IAWnC,OAAO,CAAC,WAAW;IA6BN,QAAQ,CACnB,IAAI,EAAE,QAAQ,GAAG;QAAE,QAAQ,CAAC,EAAE;YAAE,IAAI,CAAC,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,GAChD,OAAO,CAAC,IAAI,CAAC;IAQH,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAyB7C,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBrC,WAAW,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;IA+B/C;;;;OAIG;IACU,kBAAkB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IA8CzD,QAAQ,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAMrD;;;;OAIG;IACU,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC;IAc9C,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAMrE;;;;OAIG;IACU,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAMrE;;;;OAIG;IACU,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAMlD,WAAW,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;IAoBnC,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAalD;;;;OAIG;IACU,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IAOnE;;;;OAIG;IACU,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,GAAG,IAAI,CAAC;IAc5C,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IA4DtB,gBAAgB,IAAI,OAAO,CAAC;QACvC,IAAI,EAAE,MAAM,CAAA;QACZ,IAAI,EAAE,MAAM,CAAA;QACZ,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;QACpB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;KAC9B,CAAC;CAyCH"}

package/dist/unified.d.ts

@@ -3,9 +3,11 @@
  * This file exports everything from index.ts
  * Environment detection is handled here and made available to all components
  */
+import './setup.js';
 export declare const environment: {
-    isBrowser: boolean;
-    isNode: string | false;
-    isServerless: boolean;
+    readonly isBrowser: boolean;
+    readonly isNode: boolean;
+    readonly isServerless: boolean;
 };
 export * from './index.js';
+export { applyTensorFlowPatch } from './utils/textEncoding.js';