@soulcraft/brainy 0.14.0 → 0.15.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -6,7 +6,7 @@
6
6
  [![Node.js](https://img.shields.io/badge/node-%3E%3D24.4.0-brightgreen.svg)](https://nodejs.org/)
7
7
  [![TypeScript](https://img.shields.io/badge/TypeScript-5.4.5-blue.svg)](https://www.typescriptlang.org/)
8
8
  [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)
9
- [![npm](https://img.shields.io/badge/npm-v0.14.0-blue.svg)](https://www.npmjs.com/package/@soulcraft/brainy)
9
+ [![npm](https://img.shields.io/badge/npm-v0.15.0-blue.svg)](https://www.npmjs.com/package/@soulcraft/brainy)
10
10
 
11
11
  [//]: # ([![Cartographer](https://img.shields.io/badge/Cartographer-Official%20Standard-brightgreen)](https://github.com/sodal-project/cartographer))
12
12
 
@@ -146,6 +146,7 @@ Brainy combines four key technologies to create its adaptive intelligence:
146
146
  - Serverless: In-memory storage with optional cloud persistence
147
147
  - Fallback: In-memory storage
148
148
  - Automatically migrates between storage types as needed
149
+ - Uses a simplified, consolidated storage structure for all noun types
149
150
 
150
151
  ## 🚀 The Brainy Pipeline
151
152
 
@@ -906,6 +907,71 @@ The simplified augmentation system provides:
906
907
  4. **Dynamic Loading** - Load augmentations at runtime when needed
907
908
  5. **Static & Streaming Data** - Handle both static and streaming data with the same API
908
909
 
910
+ #### WebSocket Augmentation Types
911
+
912
+ Brainy exports several WebSocket augmentation types that can be used by augmentation creators to add WebSocket capabilities to their augmentations:
913
+
914
+ ```typescript
915
+ import {
916
+ // Base WebSocket support interface
917
+ IWebSocketSupport,
918
+
919
+ // Combined WebSocket augmentation types
920
+ IWebSocketSenseAugmentation,
921
+ IWebSocketConduitAugmentation,
922
+ IWebSocketCognitionAugmentation,
923
+ IWebSocketMemoryAugmentation,
924
+ IWebSocketPerceptionAugmentation,
925
+ IWebSocketDialogAugmentation,
926
+ IWebSocketActivationAugmentation,
927
+
928
+ // Function to add WebSocket support to any augmentation
929
+ addWebSocketSupport
930
+ } from '@soulcraft/brainy'
931
+
932
+ // Example: Creating a typed WebSocket-enabled sense augmentation
933
+ const mySenseAug = createSenseAugmentation({
934
+ name: 'my-sense',
935
+ processRawData: async (data, dataType) => {
936
+ // Implementation
937
+ return {
938
+ success: true,
939
+ data: { nouns: [], verbs: [] }
940
+ }
941
+ }
942
+ }) as IWebSocketSenseAugmentation
943
+
944
+ // Add WebSocket support
945
+ addWebSocketSupport(mySenseAug, {
946
+ connectWebSocket: async (url) => {
947
+ // WebSocket implementation
948
+ return {
949
+ connectionId: 'ws-1',
950
+ url,
951
+ status: 'connected'
952
+ }
953
+ },
954
+ sendWebSocketMessage: async (connectionId, data) => {
955
+ // Send message implementation
956
+ },
957
+ onWebSocketMessage: async (connectionId, callback) => {
958
+ // Register callback implementation
959
+ },
960
+ offWebSocketMessage: async (connectionId, callback) => {
961
+ // Remove callback implementation
962
+ },
963
+ closeWebSocket: async (connectionId, code, reason) => {
964
+ // Close connection implementation
965
+ }
966
+ })
967
+
968
+ // Now mySenseAug has both sense augmentation methods and WebSocket methods
969
+ await mySenseAug.processRawData('data', 'text')
970
+ await mySenseAug.connectWebSocket('wss://example.com')
971
+ ```
972
+
973
+ These WebSocket augmentation types combine the base augmentation interfaces with the `IWebSocketSupport` interface, providing type safety and autocompletion for augmentations with WebSocket capabilities.
974
+
909
975
  ### Model Control Protocol (MCP)
910
976
 
911
977
  Brainy includes a Model Control Protocol (MCP) implementation that allows external models to access Brainy data and use
@@ -1 +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"}
1
+ {"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"}