@soulcraft/brainy 1.5.0 → 2.0.0

package/dist/augmentations/conduitAugmentations.d.ts

@@ -1,172 +1,70 @@
-import { AugmentationType, IConduitAugmentation, IWebSocketSupport, AugmentationResponse, WebSocketConnection } from '../types/augmentations.js';
 /**
- * Base class for conduit augmentations that provide data synchronization between Brainy instances
+ * Conduit Augmentations - Data Synchronization Bridges
+ *
+ * These augmentations connect and synchronize data between multiple Brainy instances.
+ * Now using the unified BrainyAugmentation interface.
  */
-declare abstract class BaseConduitAugmentation implements IConduitAugmentation {
-    readonly name: string;
-    readonly description: string;
-    enabled: boolean;
-    protected isInitialized: boolean;
-    protected connections: Map<string, any>;
-    constructor(name: string);
-    initialize(): Promise<void>;
-    shutDown(): Promise<void>;
-    getStatus(): Promise<'active' | 'inactive' | 'error'>;
-    abstract establishConnection(targetSystemId: string, config: Record<string, unknown>): Promise<AugmentationResponse<WebSocketConnection>>;
-    abstract readData(query: Record<string, unknown>, options?: Record<string, unknown>): Promise<AugmentationResponse<unknown>>;
-    abstract writeData(data: Record<string, unknown>, options?: Record<string, unknown>): Promise<AugmentationResponse<unknown>>;
-    abstract monitorStream(streamId: string, callback: (data: unknown) => void): Promise<void>;
-    protected ensureInitialized(): Promise<void>;
+import { BaseAugmentation } from './brainyAugmentation.js';
+export interface WebSocketConnection {
+    connectionId: string;
+    url: string;
+    readyState: number;
+    socket?: any;
 }
 /**
- * WebSocket conduit augmentation for syncing Brainy instances using WebSockets
- *
- * This conduit is for syncing between browsers and servers, or between servers.
- * WebSockets cannot be used for direct browser-to-browser communication without a server in the middle.
+ * Base class for conduit augmentations that sync between Brainy instances
+ * Converted to use the unified BrainyAugmentation interface
  */
-export declare class WebSocketConduitAugmentation extends BaseConduitAugmentation implements IWebSocketSupport {
-    readonly description = "Conduit augmentation that syncs Brainy instances using WebSockets";
-    private webSocketConnections;
-    private messageCallbacks;
-    constructor(name?: string);
-    getType(): AugmentationType;
-    /**
-     * Establishes a connection to another Brainy instance
-     * @param targetSystemId The URL or identifier of the target system
-     * @param config Configuration options for the connection
-     */
-    establishConnection(targetSystemId: string, config: Record<string, unknown>): Promise<AugmentationResponse<WebSocketConnection>>;
-    /**
-     * Reads data from a connected Brainy instance
-     * @param query Query parameters for reading data
-     * @param options Additional options
-     */
-    readData(query: Record<string, unknown>, options?: Record<string, unknown>): Promise<AugmentationResponse<unknown>>;
-    /**
-     * Writes data to a connected Brainy instance
-     * @param data The data to write
-     * @param options Additional options
-     */
-    writeData(data: Record<string, unknown>, options?: Record<string, unknown>): Promise<AugmentationResponse<unknown>>;
-    /**
-     * Monitors a data stream from a connected Brainy instance
-     * @param streamId The ID of the stream to monitor (usually a connection ID)
-     * @param callback Function to call when new data is received
-     */
-    monitorStream(streamId: string, callback: (data: unknown) => void): Promise<void>;
-    /**
-     * Establishes a WebSocket connection
-     * @param url The WebSocket server URL to connect to
-     * @param protocols Optional subprotocols
-     */
-    connectWebSocket(url: string, protocols?: string | string[]): Promise<WebSocketConnection>;
-    /**
-     * Sends data through an established WebSocket connection
-     * @param connectionId The identifier of the established connection
-     * @param data The data to send (will be serialized if not a string)
-     */
-    sendWebSocketMessage(connectionId: string, data: unknown): Promise<void>;
-    /**
-     * Registers a callback for incoming WebSocket messages
-     * @param connectionId The identifier of the established connection
-     * @param callback The function to call when a message is received
-     */
-    onWebSocketMessage(connectionId: string, callback: (data: unknown) => void): Promise<void>;
-    /**
-     * Removes a callback for incoming WebSocket messages
-     * @param connectionId The identifier of the established connection
-     * @param callback The function to remove from the callbacks
-     */
-    offWebSocketMessage(connectionId: string, callback: (data: unknown) => void): Promise<void>;
-    /**
-     * Closes an established WebSocket connection
-     * @param connectionId The identifier of the established connection
-     * @param code Optional close code
-     * @param reason Optional close reason
-     */
-    closeWebSocket(connectionId: string, code?: number, reason?: string): Promise<void>;
+declare abstract class BaseConduitAugmentation extends BaseAugmentation {
+    readonly timing: "after";
+    readonly operations: ("addNoun" | "delete" | "addVerb")[];
+    readonly priority = 20;
+    protected connections: Map<string, any>;
+    protected onShutdown(): Promise<void>;
+    abstract establishConnection(targetSystemId: string, config?: Record<string, unknown>): Promise<WebSocketConnection | null>;
 }
 /**
- * WebRTC conduit augmentation for syncing Brainy instances using WebRTC
- *
- * This conduit is for direct peer-to-peer syncing between browsers.
- * It is the recommended approach for browser-to-browser communication.
+ * WebSocket Conduit Augmentation
+ * Syncs data between Brainy instances using WebSockets
  */
-export declare class WebRTCConduitAugmentation extends BaseConduitAugmentation implements IWebSocketSupport {
-    readonly description = "Conduit augmentation that syncs Brainy instances using WebRTC";
-    private peerConnections;
-    private dataChannels;
+export declare class WebSocketConduitAugmentation extends BaseConduitAugmentation {
+    readonly name = "websocket-conduit";
     private webSocketConnections;
     private messageCallbacks;
-    private signalServer;
-    constructor(name?: string);
-    getType(): AugmentationType;
-    initialize(): Promise<void>;
-    /**
-     * Establishes a connection to another Brainy instance using WebRTC
-     * @param targetSystemId The peer ID or signal server URL
-     * @param config Configuration options for the connection
-     */
-    establishConnection(targetSystemId: string, config: Record<string, unknown>): Promise<AugmentationResponse<WebSocketConnection>>;
-    /**
-     * Handles an incoming WebRTC offer
-     * @param peerId The ID of the peer sending the offer
-     * @param offer The SDP offer
-     * @param config Configuration options
-     */
-    private handleOffer;
-    /**
-     * Reads data from a connected Brainy instance
-     * @param query Query parameters for reading data
-     * @param options Additional options
-     */
-    readData(query: Record<string, unknown>, options?: Record<string, unknown>): Promise<AugmentationResponse<unknown>>;
-    /**
-     * Writes data to a connected Brainy instance
-     * @param data The data to write
-     * @param options Additional options
-     */
-    writeData(data: Record<string, unknown>, options?: Record<string, unknown>): Promise<AugmentationResponse<unknown>>;
-    /**
-     * Monitors a data stream from a connected Brainy instance
-     * @param streamId The ID of the stream to monitor (usually a connection ID)
-     * @param callback Function to call when new data is received
-     */
-    monitorStream(streamId: string, callback: (data: unknown) => void): Promise<void>;
-    /**
-     * Establishes a WebSocket connection (used for signaling in WebRTC)
-     * @param url The WebSocket server URL to connect to
-     * @param protocols Optional subprotocols
-     */
-    connectWebSocket(url: string, protocols?: string | string[]): Promise<WebSocketConnection>;
-    /**
-     * Sends data through an established WebSocket or WebRTC connection
-     * @param connectionId The identifier of the established connection
-     * @param data The data to send (will be serialized if not a string)
-     */
-    sendWebSocketMessage(connectionId: string, data: unknown): Promise<void>;
+    execute<T = any>(operation: string, params: any, next: () => Promise<T>): Promise<T>;
+    private shouldSync;
+    private syncOperation;
+    establishConnection(url: string, config?: Record<string, unknown>): Promise<WebSocketConnection | null>;
+    private handleMessage;
+    private applySyncOperation;
     /**
-     * Registers a callback for incoming WebSocket or WebRTC messages
-     * @param connectionId The identifier of the established connection
-     * @param callback The function to call when a message is received
+     * Subscribe to messages from a specific connection
      */
-    onWebSocketMessage(connectionId: string, callback: (data: unknown) => void): Promise<void>;
+    onMessage(connectionId: string, callback: (data: any) => void): void;
     /**
-     * Removes a callback for incoming WebSocket or WebRTC messages
-     * @param connectionId The identifier of the established connection
-     * @param callback The function to remove from the callbacks
+     * Send a message to a specific connection
      */
-    offWebSocketMessage(connectionId: string, callback: (data: unknown) => void): Promise<void>;
-    /**
-     * Closes an established WebSocket or WebRTC connection
-     * @param connectionId The identifier of the established connection
-     * @param code Optional close code
-     * @param reason Optional close reason
-     */
-    closeWebSocket(connectionId: string, code?: number, reason?: string): Promise<void>;
+    sendMessage(connectionId: string, data: any): boolean;
 }
-/**
- * Factory function to create the appropriate conduit augmentation based on the type
- */
-export declare function createConduitAugmentation(type: 'websocket' | 'webrtc', name?: string, options?: Record<string, unknown>): Promise<IConduitAugmentation & IWebSocketSupport>;
 export {};
+/**
+ * Example usage:
+ *
+ * // Server instance
+ * const serverBrain = new BrainyData()
+ * serverBrain.augmentations.register(new APIServerAugmentation())
+ * await serverBrain.init()
+ *
+ * // Client instance
+ * const clientBrain = new BrainyData()
+ * const conduit = new WebSocketConduitAugmentation()
+ * clientBrain.augmentations.register(conduit)
+ * await clientBrain.init()
+ *
+ * // Connect client to server
+ * await conduit.establishConnection('ws://localhost:3000/ws')
+ *
+ * // Now operations sync automatically!
+ * await clientBrain.addNoun('synced data', { source: 'client' })
+ * // This will automatically sync to the server
+ */