@neta-art/cohub-protocol 1.2.0 → 1.2.2

package/dist/gateway/index.d.ts

@@ -48,20 +48,42 @@ export interface GatewayInboundEvent {
     meta?: Record<string, unknown> | null;
 }
 export interface GatewaySessionOutputBase {
-    type: "session.turn.progress" | "session.turn.final" | "session.turn.error" | "session.message.persisted";
+    type: "session.turn.patch" | "session.turn.error" | "session.message.persisted";
     spaceId: string;
     sessionId: string;
 }
-export interface GatewaySessionTurnProgressOutput extends GatewaySessionOutputBase {
-    type: "session.turn.progress";
+export type GatewaySessionPatchOperation = {
+    o: "append";
+    p: string;
+    v: unknown;
+} | {
+    o: "replace";
+    p: string;
+    v: unknown;
+} | {
+    o: "add";
+    p: string;
+    v: unknown;
+} | {
+    o: "merge";
+    p: string;
+    v: Record<string, unknown>;
+} | {
+    o: "remove";
+    p: string;
+} | {
+    v: unknown;
+    o?: undefined;
+    p?: undefined;
+};
+export interface GatewaySessionTurnPatchOutput extends GatewaySessionOutputBase {
+    type: "session.turn.patch";
+    turnId: string | null;
+    messageId: string | null;
     anchorUserMessageId: string | null;
-    content: ContentBlock[];
-}
-export interface GatewaySessionTurnFinalOutput extends GatewaySessionOutputBase {
-    type: "session.turn.final";
-    sessionMessageId: string | null;
-    anchorUserMessageId: string | null;
-    content: ContentBlock[];
+    seq: number;
+    baseSeq: number;
+    ops: GatewaySessionPatchOperation[];
 }
 export interface GatewaySessionTurnErrorOutput extends GatewaySessionOutputBase {
     type: "session.turn.error";
@@ -72,7 +94,7 @@ export interface GatewaySessionMessagePersistedOutput extends GatewaySessionOutp
     type: "session.message.persisted";
     message: MessageRecord;
 }
-export type GatewaySessionOutput = GatewaySessionTurnProgressOutput | GatewaySessionTurnFinalOutput | GatewaySessionTurnErrorOutput | GatewaySessionMessagePersistedOutput;
+export type GatewaySessionOutput = GatewaySessionTurnPatchOutput | GatewaySessionTurnErrorOutput | GatewaySessionMessagePersistedOutput;
 export interface GatewayOutboundCommand {
     commandId: string;
     timestamp: number;

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 export * from "./core/content.js";
 export * from "./core/usage.js";
 export * from "./model/session.js";
+export * from "./model/turn.js";
 export * from "./realtime/stream.js";
 export * from "./realtime/websocket.js";
 export * from "./gateway/index.js";

package/dist/index.js

@@ -1,6 +1,7 @@
 export * from "./core/content.js";
 export * from "./core/usage.js";
 export * from "./model/session.js";
+export * from "./model/turn.js";
 export * from "./realtime/stream.js";
 export * from "./realtime/websocket.js";
 export * from "./gateway/index.js";

package/dist/model/session.d.ts

@@ -1,5 +1,6 @@
 import type { ContentBlock } from "../core/content.js";
 import type { Usage } from "../core/usage.js";
+export type { MessageToolCallsFile, SessionTurnIntent, SessionTurnIntermediateIndex, SessionTurnIntermediateSummary, SessionTurnRecord, SessionTurnStatus, SessionTurnSummary, StoredIntermediateMessage, StoredIntermediateMessageToolCallSummary, StoredToolCall, TurnIntermediateMessagesFile, } from "./turn.js";
 export type SessionPromptInput = {
     spaceId: string;
     sessionId: string;
@@ -9,9 +10,10 @@ export type SessionPromptInput = {
     };
     meta?: {
         source?: string;
-        intent?: "auto" | "continue" | "new_session" | "fork";
+        intent?: "auto" | "continue" | "new_session" | "fork" | "steer" | "followup";
         model?: string;
         provider?: string;
+        turnId?: string;
     } | null;
 };
 export type RegisterSessionInput = {

package/dist/model/turn.d.ts

@@ -0,0 +1,95 @@
+import type { ContentBlock } from "../core/content.js";
+import type { Usage } from "../core/usage.js";
+export type SessionTurnStatus = "running" | "completed" | "failed" | "interrupted";
+export type SessionTurnIntent = "steer" | "followup";
+export type SessionTurnSummary = {
+    text?: string | null;
+    finishReason?: "completed" | "failed" | "interrupted";
+    interruptedByTurnId?: string | null;
+};
+export type SessionTurnIntermediateIndex = {
+    version: 1;
+    messagesObjectKey: string | null;
+    messagesSizeBytes?: number | null;
+    toolCallsBaseObjectKey?: string | null;
+};
+export type SessionTurnIntermediateSummary = {
+    messageCount: number;
+    toolCallCount: number;
+    usage?: Usage | null;
+    lastMessageText?: string | null;
+    hasError?: boolean;
+};
+export type StoredIntermediateMessageToolCallSummary = {
+    id: string;
+    name: string;
+    status: "running" | "done" | "failed";
+    input: Record<string, unknown>;
+};
+export type StoredIntermediateMessage = {
+    id: string;
+    sessionId: string;
+    role: "user" | "assistant" | "system";
+    content: ContentBlock[];
+    text: string | null;
+    provider: string | null;
+    model: string | null;
+    stopReason: string | null;
+    errorMessage: string | null;
+    usage: Usage | null;
+    toolCalls: StoredIntermediateMessageToolCallSummary[];
+    toolCallsObjectKey: string | null;
+    meta: Record<string, unknown> | null;
+    createdAt: string;
+};
+export type StoredToolCall = {
+    id: string;
+    name: string;
+    input: Record<string, unknown>;
+    result: {
+        content: string | ContentBlock[] | null;
+        isError: boolean;
+    } | null;
+    meta: Record<string, unknown> | null;
+};
+export type MessageToolCallsFile = {
+    version: 1;
+    spaceId: string;
+    sessionId: string;
+    turnId: string;
+    messageId: string;
+    toolCalls: StoredToolCall[];
+};
+export type TurnIntermediateMessagesFile = {
+    version: 1;
+    spaceId: string;
+    sessionId: string;
+    turnId: string;
+    summary: SessionTurnIntermediateSummary;
+    messages: StoredIntermediateMessage[];
+};
+export type SessionTurnRecord = {
+    id: string;
+    sessionId: string;
+    userUuid: string | null;
+    sequence: number;
+    status: SessionTurnStatus;
+    intent: SessionTurnIntent;
+    userContent: ContentBlock[];
+    userText: string | null;
+    assistantContent: ContentBlock[] | null;
+    assistantText: string | null;
+    provider: string | null;
+    model: string | null;
+    stopReason: string | null;
+    errorMessage: string | null;
+    usage: Usage | null;
+    summary: SessionTurnSummary | null;
+    intermediateIndex: SessionTurnIntermediateIndex | null;
+    intermediateSummary: SessionTurnIntermediateSummary | null;
+    meta: Record<string, unknown> | null;
+    startedAt: string | null;
+    completedAt: string | null;
+    createdAt: string;
+    updatedAt: string;
+};

package/dist/model/turn.js

@@ -0,0 +1 @@
+export {};

package/dist/realtime/stream.d.ts

@@ -3,7 +3,11 @@ export type SessionStreamEvent = {
     type: "stream_update";
     spaceId: string;
     sessionId: string;
+    turnId?: string | null;
+    seq: number;
+    baseSeq: number;
     content: ContentBlock[];
+    snapshotContent?: ContentBlock[];
     sourceMessageId: string | null;
     timestamp: number;
     turnEnd?: boolean;

package/dist/realtime/websocket.d.ts

@@ -2,6 +2,7 @@ import { z } from "zod";
 import type { ContentBlock } from "../core/content.js";
 import type { MessageRecord } from "../model/session.js";
 import type { SpaceFsChangedPayload } from "../fs/index.js";
+export declare const WS_COMPACT_STREAM_CAPABILITY = "session.compact_stream.v1";
 export declare const contentBlockSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
     type: z.ZodLiteral<"text">;
     text: z.ZodString;
@@ -50,6 +51,7 @@ export declare const wsClientEventSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
     requestId: z.ZodOptional<z.ZodString>;
     payload: z.ZodObject<{
         token: z.ZodString;
+        capabilities: z.ZodOptional<z.ZodArray<z.ZodString>>;
     }, z.core.$strip>;
 }, z.core.$strip>, z.ZodObject<{
     type: z.ZodLiteral<"session.message.create">;
@@ -143,11 +145,33 @@ export declare const channelEnvelopeSchema: z.ZodObject<{
     sessionId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     payload: z.ZodRecord<z.ZodString, z.ZodUnknown>;
 }, z.core.$strip>;
+export declare const realtimeCompactFrameSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    t: z.ZodLiteral<"d">;
+    sid: z.ZodString;
+    s: z.ZodNumber;
+    b: z.ZodNumber;
+    v: z.ZodUnknown;
+}, z.core.$strip>, z.ZodObject<{
+    t: z.ZodLiteral<"p">;
+    sid: z.ZodString;
+    s: z.ZodNumber;
+    b: z.ZodNumber;
+    o: z.ZodEnum<{
+        append: "append";
+        replace: "replace";
+        add: "add";
+        merge: "merge";
+        remove: "remove";
+    }>;
+    p: z.ZodString;
+    v: z.ZodOptional<z.ZodUnknown>;
+}, z.core.$strip>], "t">;
 export type WsClientEvent = {
     type: "auth";
     requestId?: string;
     payload: {
         token: string;
+        capabilities?: string[];
     };
 } | {
     type: "session.message.create";
@@ -173,6 +197,7 @@ export type WsClientEvent = {
 };
 export type RealtimeEnvelope = z.output<typeof realtimeEnvelopeSchema>;
 export type ChannelEnvelope = RealtimeEnvelope;
+export type RealtimeCompactFrame = z.output<typeof realtimeCompactFrameSchema>;
 export type RealtimeEnvelopeBase = RealtimeEnvelope;
 export type RealtimeDomain = RealtimeEnvelopeBase["domain"];
 export type SystemReadyEvent = {
@@ -272,18 +297,45 @@ export type SessionTurnProgressEvent = {
         content: ContentBlock[];
     };
 };
-export type SessionTurnFinalEvent = {
+export type RealtimePatchOperation = {
+    o: "append";
+    p: string;
+    v: unknown;
+} | {
+    o: "replace";
+    p: string;
+    v: unknown;
+} | {
+    o: "add";
+    p: string;
+    v: unknown;
+} | {
+    o: "merge";
+    p: string;
+    v: Record<string, unknown>;
+} | {
+    o: "remove";
+    p: string;
+} | {
+    v: unknown;
+    o?: undefined;
+    p?: undefined;
+};
+export type SessionTurnPatchEvent = {
     id: string;
     timestamp: number;
     domain: "session";
-    type: "session.turn.final";
+    type: "session.turn.patch";
     requestId?: string | null;
     spaceId: string;
     sessionId: string;
     payload: {
-        sessionMessageId: string | null;
+        turnId: string | null;
+        messageId: string | null;
         anchorUserMessageId: string | null;
-        content: ContentBlock[];
+        seq: number;
+        baseSeq: number;
+        ops: RealtimePatchOperation[];
     };
 };
 export type SessionTurnErrorEvent = {
@@ -299,6 +351,7 @@ export type SessionTurnErrorEvent = {
         error: string;
     };
 };
+export type RealtimeMessageRecord = Pick<MessageRecord, "id" | "sessionId" | "role" | "content" | "text" | "sequence" | "provider" | "model" | "stopReason" | "errorMessage" | "usage" | "meta" | "createdAt">;
 export type SessionMessagePersistedEvent = {
     id: string;
     timestamp: number;
@@ -308,7 +361,7 @@ export type SessionMessagePersistedEvent = {
     spaceId: string;
     sessionId: string;
     payload: {
-        message: MessageRecord;
+        message: RealtimeMessageRecord;
     };
 };
 export type SpaceFsChangedEvent = {
@@ -321,6 +374,6 @@ export type SpaceFsChangedEvent = {
     sessionId?: string | null;
     payload: SpaceFsChangedPayload;
 };
-export type RealtimeServerEvent = SystemReadyEvent | SystemAuthOkEvent | SystemRequestErrorEvent | SystemPongEvent | SystemAckOkEvent | SessionRequestAcceptedEvent | SessionRequestErrorEvent | SessionTurnProgressEvent | SessionTurnFinalEvent | SessionTurnErrorEvent | SessionMessagePersistedEvent | SpaceFsChangedEvent;
+export type RealtimeServerEvent = SystemReadyEvent | SystemAuthOkEvent | SystemRequestErrorEvent | SystemPongEvent | SystemAckOkEvent | SessionRequestAcceptedEvent | SessionRequestErrorEvent | SessionTurnProgressEvent | SessionTurnPatchEvent | SessionTurnErrorEvent | SessionMessagePersistedEvent | SpaceFsChangedEvent;
 export type WsServerEnvelope = RealtimeEnvelope;
 export type ChannelServerEnvelope = ChannelEnvelope;

package/dist/realtime/websocket.js

@@ -1,5 +1,6 @@
 import { z } from "zod";
 const contentBlockMetaSchema = z.record(z.string(), z.unknown());
+export const WS_COMPACT_STREAM_CAPABILITY = "session.compact_stream.v1";
 export const contentBlockSchema = z.discriminatedUnion("type", [
     z.object({
         type: z.literal("text"),
@@ -45,7 +46,10 @@ export const wsClientEventSchema = z.discriminatedUnion("type", [
     z.object({
         type: z.literal("auth"),
         requestId: z.string().optional(),
-        payload: z.object({ token: z.string().min(1) }),
+        payload: z.object({
+            token: z.string().min(1),
+            capabilities: z.array(z.string().min(1)).optional(),
+        }),
     }),
     z.object({
         type: z.literal("session.message.create"),
@@ -83,3 +87,21 @@ export const realtimeEnvelopeSchema = z.object({
     payload: z.record(z.string(), z.unknown()),
 });
 export const channelEnvelopeSchema = realtimeEnvelopeSchema;
+export const realtimeCompactFrameSchema = z.discriminatedUnion("t", [
+    z.object({
+        t: z.literal("d"),
+        sid: z.string().min(1),
+        s: z.number().int().nonnegative(),
+        b: z.number().int().nonnegative(),
+        v: z.unknown(),
+    }),
+    z.object({
+        t: z.literal("p"),
+        sid: z.string().min(1),
+        s: z.number().int().nonnegative(),
+        b: z.number().int().nonnegative(),
+        o: z.enum(["append", "replace", "add", "merge", "remove"]),
+        p: z.string().min(1),
+        v: z.unknown().optional(),
+    }),
+]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neta-art/cohub-protocol",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "description": "Shared protocol definitions for the Cohub agent collaboration platform.",
   "license": "UNLICENSED",
   "private": false,