Skip to content

Latest commit

 

History

History

server

README.md

@diffexai/diffex-server

Experimental. This package is under active development and may change or be removed without notice. Its APIs and behavior are not yet stable.

Server package for Diffex.

Session server core

The package exports the DiffexServer session server.

import type { DiffexServerService } from "@diffexai/diffex-server";
import { createUnixServer } from "@diffexai/diffex-server/unix";

const service: DiffexServerService = {
  async listSessions() {
    return storage.listSessions();
  },
  async listModels() {
    return modelRegistry.listModels();
  },
  async createSession(options) {
    return storage.createAndOpen(options);
  },
  async openSession(sessionId) {
    return storage.open(sessionId);
  },
};

const server = createUnixServer(service, {
  path: "/tmp/diffex/server.sock",
});
await server.start();

DiffexServer composes transport listeners through the DiffexServerListener interface. Each listener must complete any transport-specific authentication and authorization before passing a connection to DiffexServer. For example, a WebSocket listener can validate credentials during the HTTP upgrade, while the Unix listener relies on socket filesystem permissions. The Unix submodule exports the createUnixListener() building block and createUnixServer() preset, keeping the common case concise without coupling the primary server to Unix sockets. The listener uses length-prefixed CBOR messages from @diffexai/diffex-protocol.

This package does not provide a standalone CLI or coding-agent service. Applications supply the DiffexServerService implementation.

DiffexServerService.listSessions() returns protocol SessionMetadata, not acquired runtime state. Services should map the durable fields their storage supports and may omit updatedAt, parentSessionId, sessionName, and cwd. DiffexServer refreshes available metadata from live snapshots without requiring stored sessions to fabricate phase, model, thinking-level, attachment, or lock values.

Transport testing

Custom transports can use @diffexai/diffex-server/testing for deterministic protocol conformance tests. It exports createTestServer(), TestServerService, ProtocolTestClient, and the transport-neutral WireChannel contract. connectUnixTestClient() is provided for Unix transport tests.

diffex-ai protocol bridge

@diffexai/diffex-ai domain objects and @diffexai/diffex-protocol wire DTOs remain independent. This package owns their boundary and exports toProtocolModelMetadata(), toProtocolAssistantMessage(), toProtocolUserMessage(), and toProtocolToolResultMessage().

The adapters reject invalid tool inputs, identifiers, timestamps, and mismatched tool results; toProtocolToolResultMessage() requires the original ToolCall so it can verify the association and convert its arguments itself. Diagnostic details are explicitly sanitized. Closed diffex-ai unions are mapped exhaustively, and compile-time field manifests enumerate current diffex-ai properties so additions require an explicit review. The protocol mirrors diffex-ai vocabulary such as toolCall and toolUse where the semantics are identical. Protocol schemas enforce consistent lifecycle states, and tests encode adapter output through the runtime schemas so incompatible changes fail in the bridging package.

WebSocket listener

Hosted runtimes can compose an authenticated WebSocket listener from the explicit @diffexai/diffex-server/websocket subpath. The authorization callback runs before the protocol connection is accepted and must validate the cloud-issued, session-scoped credential. Text messages are rejected, compression is disabled, and inbound and outbound byte limits are enforced independently from protocol frame validation.