@soulcraft/brainy 0.14.0 → 0.16.0

package/README.md

@@ -6,7 +6,6 @@
 [![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.14.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))
 
@@ -36,7 +35,7 @@ it gets - learning from your data to provide increasingly relevant results and c
 - **Adaptive Intelligence** - Automatically optimizes for your environment and usage patterns
 - **Persistent Storage** - Data persists across sessions and scales to any size
 - **TypeScript Support** - Fully typed API with generics
-- **CLI Tools** - Powerful command-line interface for data management
+- **CLI Tools & Web Service** - Command-line interface and REST API web service for data management
 - **Model Control Protocol (MCP)** - Allow external AI models to access Brainy data and use augmentation pipeline as
   tools
 
@@ -64,6 +63,22 @@ npm install @soulcraft/brainy
 
 TensorFlow.js packages are included as bundled dependencies and will be automatically installed without any additional configuration.
 
+### Additional Packages
+
+Brainy offers specialized packages for different use cases:
+
+#### CLI Package
+```bash
+npm install -g @soulcraft/brainy-cli
+```
+Command-line interface for data management, bulk operations, and database administration.
+
+#### Web Service Package
+```bash
+npm install @soulcraft/brainy-web-service
+```
+REST API web service wrapper that provides HTTP endpoints for search operations and database queries.
+
 ## 🏁 Quick Start
 
 Brainy uses a unified build that automatically adapts to your environment (Node.js, browser, or serverless):
@@ -146,6 +161,7 @@ Brainy combines four key technologies to create its adaptive intelligence:
     - Serverless: In-memory storage with optional cloud persistence
     - Fallback: In-memory storage
     - Automatically migrates between storage types as needed
+    - Uses a simplified, consolidated storage structure for all noun types
 
 ## 🚀 The Brainy Pipeline
 
@@ -906,6 +922,71 @@ The simplified augmentation system provides:
 4. **Dynamic Loading** - Load augmentations at runtime when needed
 5. **Static & Streaming Data** - Handle both static and streaming data with the same API
 
+#### WebSocket Augmentation Types
+
+Brainy exports several WebSocket augmentation types that can be used by augmentation creators to add WebSocket capabilities to their augmentations:
+
+```typescript
+import {
+  // Base WebSocket support interface
+  IWebSocketSupport,
+  
+  // Combined WebSocket augmentation types
+  IWebSocketSenseAugmentation,
+  IWebSocketConduitAugmentation,
+  IWebSocketCognitionAugmentation,
+  IWebSocketMemoryAugmentation,
+  IWebSocketPerceptionAugmentation,
+  IWebSocketDialogAugmentation,
+  IWebSocketActivationAugmentation,
+  
+  // Function to add WebSocket support to any augmentation
+  addWebSocketSupport
+} from '@soulcraft/brainy'
+
+// Example: Creating a typed WebSocket-enabled sense augmentation
+const mySenseAug = createSenseAugmentation({
+  name: 'my-sense',
+  processRawData: async (data, dataType) => {
+    // Implementation
+    return {
+      success: true,
+      data: { nouns: [], verbs: [] }
+    }
+  }
+}) as IWebSocketSenseAugmentation
+
+// Add WebSocket support
+addWebSocketSupport(mySenseAug, {
+  connectWebSocket: async (url) => {
+    // WebSocket implementation
+    return {
+      connectionId: 'ws-1',
+      url,
+      status: 'connected'
+    }
+  },
+  sendWebSocketMessage: async (connectionId, data) => {
+    // Send message implementation
+  },
+  onWebSocketMessage: async (connectionId, callback) => {
+    // Register callback implementation
+  },
+  offWebSocketMessage: async (connectionId, callback) => {
+    // Remove callback implementation
+  },
+  closeWebSocket: async (connectionId, code, reason) => {
+    // Close connection implementation
+  }
+})
+
+// Now mySenseAug has both sense augmentation methods and WebSocket methods
+await mySenseAug.processRawData('data', 'text')
+await mySenseAug.connectWebSocket('wss://example.com')
+```
+
+These WebSocket augmentation types combine the base augmentation interfaces with the `IWebSocketSupport` interface, providing type safety and autocompletion for augmentations with WebSocket capabilities.
+
 ### Model Control Protocol (MCP)
 
 Brainy includes a Model Control Protocol (MCP) implementation that allows external models to access Brainy data and use

package/dist/augmentations/memoryAugmentations.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"memoryAugmentations.d.ts","sourceRoot":"","sources":["../../src/augmentations/memoryAugmentations.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,mBAAmB,EACnB,oBAAoB,EACrB,MAAM,2BAA2B,CAAA;AAClC,OAAO,EAAE,cAAc,EAAU,MAAM,iBAAiB,CAAA;AAMxD;;GAEG;AACH,uBAAe,sBAAuB,YAAW,mBAAmB;IAClE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAA6B;IACzD,OAAO,EAAE,OAAO,CAAO;IACvB,SAAS,CAAC,OAAO,EAAE,cAAc,CAAA;IACjC,SAAS,CAAC,aAAa,UAAQ;gBAEnB,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc;IAK3C,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAc3B,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAIzB,SAAS,IAAI,OAAO,CAAC,QAAQ,GAAG,UAAU,GAAG,OAAO,CAAC;IAIrD,SAAS,CACb,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,OAAO,EACb,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAChC,OAAO,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAgBnC,YAAY,CAChB,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAChC,OAAO,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAmBnC,UAAU,CACd,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,OAAO,EACb,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAChC,OAAO,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAgBnC,UAAU,CACd,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAChC,OAAO,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAiBnC,YAAY,CAChB,OAAO,CAAC,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAChC,OAAO,CAAC,oBAAoB,CAAC,MAAM,EAAE,CAAC,CAAC;IAW1C;;;;;;OAMG;IACG,MAAM,CACV,KAAK,EAAE,OAAO,EACd,CAAC,GAAE,MAAW,EACd,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAChC,OAAO,CAAC,oBAAoB,CAAC,KAAK,CAAC;QACpC,EAAE,EAAE,MAAM,CAAC;QACX,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,OAAO,CAAC;KACf,CAAC,CAAC,CAAC;cAqEY,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC;CAKnD;AAED;;GAEG;AACH,qBAAa,yBAA0B,SAAQ,sBAAsB;IACnE,QAAQ,CAAC,WAAW,oDAAmD;IACvE,OAAO,UAAO;gBAEF,IAAI,EAAE,MAAM;IAIxB,OAAO,IAAI,gBAAgB;CAG5B;AAED;;GAEG;AACH,qBAAa,6BAA8B,SAAQ,sBAAsB;IACvE,QAAQ,CAAC,WAAW,6DAA4D;IAChF,OAAO,UAAO;gBAEF,IAAI,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM;IAIhD,OAAO,IAAI,gBAAgB;CAG5B;AAED;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,sBAAsB;IACjE,QAAQ,CAAC,WAAW,4EAA2E;IAC/F,OAAO,UAAO;gBAEF,IAAI,EAAE,MAAM;IAIxB,OAAO,IAAI,gBAAgB;CAG5B;AAED;;GAEG;AACH,wBAAsB,wBAAwB,CAC5C,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE;IACP,WAAW,CAAC,EAAE,QAAQ,GAAG,YAAY,GAAG,MAAM,CAAA;IAC9C,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,wBAAwB,CAAC,EAAE,OAAO,CAAA;CAC9B,GACL,OAAO,CAAC,mBAAmB,CAAC,CAuC9B"}
+{"version":3,"file":"memoryAugmentations.d.ts","sourceRoot":"","sources":["../../src/augmentations/memoryAugmentations.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,gBAAgB,EAChB,mBAAmB,EACnB,oBAAoB,EACvB,MAAM,2BAA2B,CAAA;AAClC,OAAO,EAAC,cAAc,EAAS,MAAM,iBAAiB,CAAA;AAItD;;GAEG;AACH,uBAAe,sBAAuB,YAAW,mBAAmB;IAChE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAA6B;IACzD,OAAO,EAAE,OAAO,CAAO;IACvB,SAAS,CAAC,OAAO,EAAE,cAAc,CAAA;IACjC,SAAS,CAAC,aAAa,UAAQ;gBAEnB,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc;IAK3C,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAc3B,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAIzB,SAAS,IAAI,OAAO,CAAC,QAAQ,GAAG,UAAU,GAAG,OAAO,CAAC;IAIrD,SAAS,CACX,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,OAAO,EACb,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAClC,OAAO,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAgBnC,YAAY,CACd,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAClC,OAAO,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAmBnC,UAAU,CACZ,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,OAAO,EACb,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAClC,OAAO,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAgBnC,UAAU,CACZ,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAClC,OAAO,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAiBnC,YAAY,CACd,OAAO,CAAC,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAClC,OAAO,CAAC,oBAAoB,CAAC,MAAM,EAAE,CAAC,CAAC;IAW1C;;;;;;OAMG;IACG,MAAM,CACR,KAAK,EAAE,OAAO,EACd,CAAC,GAAE,MAAW,EACd,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAClC,OAAO,CAAC,oBAAoB,CAAC,KAAK,CAAC;QAClC,EAAE,EAAE,MAAM,CAAC;QACX,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,OAAO,CAAC;KACjB,CAAC,CAAC,CAAC;cAqEY,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC;CAKrD;AAED;;GAEG;AACH,qBAAa,yBAA0B,SAAQ,sBAAsB;IACjE,QAAQ,CAAC,WAAW,oDAAmD;IACvE,OAAO,UAAO;gBAEF,IAAI,EAAE,MAAM;IAIxB,OAAO,IAAI,gBAAgB;CAG9B;AAED;;GAEG;AACH,qBAAa,6BAA8B,SAAQ,sBAAsB;IACrE,QAAQ,CAAC,WAAW,6DAA4D;IAChF,OAAO,UAAO;gBAEF,IAAI,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM;IAIhD,OAAO,IAAI,gBAAgB;CAG9B;AAED;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,sBAAsB;IAC/D,QAAQ,CAAC,WAAW,4EAA2E;IAC/F,OAAO,UAAO;gBAEF,IAAI,EAAE,MAAM;IAIxB,OAAO,IAAI,gBAAgB;CAG9B;AAED;;GAEG;AACH,wBAAsB,wBAAwB,CAC1C,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE;IACL,WAAW,CAAC,EAAE,QAAQ,GAAG,YAAY,GAAG,MAAM,CAAA;IAC9C,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,wBAAwB,CAAC,EAAE,OAAO,CAAA;CAChC,GACP,OAAO,CAAC,mBAAmB,CAAC,CAuC9B"}