WebSocket

import { createSurf } from '@surfjs/core'
import http from 'node:http'
 
const surf = await createSurf({
  name: 'Realtime App',
  commands: { /* ... */ },
  events: {
    'order.updated': {
      description: 'Fired when an order status changes',
      data: { orderId: { type: 'string' }, status: { type: 'string' } },
    },
  },
})
 
const server = http.createServer(/* express app or raw handler */)
 
// Attach WebSocket — requires the 'ws' package
surf.wsHandler(server)
 
server.listen(3000)
 
// Emit events from anywhere in your code
surf.emit('order.updated', { orderId: 'ORD-789', status: 'shipped' })

// Client → Server: execute a command
{ "type": "execute", "id": "req-1", "command": "search", "params": { "query": "laptop" } }
 
// Server → Client: command result
{ "type": "result", "id": "req-1", "ok": true, "result": { ... } }
 
// Client → Server: authenticate
{ "type": "auth", "token": "Bearer sk-..." }
 
// Client → Server: manage session
{ "type": "session", "action": "start" }
{ "type": "session", "action": "end", "sessionId": "sess_abc" }
 
// Server → Client: event
{ "type": "event", "event": "order.updated", "data": { ... } }