@neta-art/cohub-protocol 1.0.0

package/dist/websocket.d.ts

@@ -0,0 +1,299 @@
+import { z } from "zod";
+import type { ContentBlock, MessageRecord } from "./session-ingestion.js";
+export declare const contentBlockSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"text">;
+    text: z.ZodString;
+    _meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"thinking">;
+    thinking: z.ZodString;
+    signature: z.ZodOptional<z.ZodString>;
+    _meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"image">;
+    source: z.ZodUnion<readonly [z.ZodObject<{
+        type: z.ZodLiteral<"url">;
+        url: z.ZodString;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"base64">;
+        media_type: z.ZodString;
+        data: z.ZodString;
+    }, z.core.$strip>]>;
+    _meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"tool_use">;
+    id: z.ZodString;
+    name: z.ZodString;
+    input: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    _meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"tool_result">;
+    tool_use_id: z.ZodString;
+    content: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodUnknown>]>;
+    is_error: z.ZodOptional<z.ZodBoolean>;
+    _meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"system_note">;
+    note_type: z.ZodEnum<{
+        session_created: "session_created";
+        forked: "forked";
+        compacted: "compacted";
+        info: "info";
+    }>;
+    text: z.ZodString;
+    _meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.core.$strip>], "type">;
+export declare const wsClientEventSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"auth">;
+    requestId: z.ZodOptional<z.ZodString>;
+    payload: z.ZodObject<{
+        token: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"session.message.create">;
+    requestId: z.ZodOptional<z.ZodString>;
+    payload: z.ZodObject<{
+        spaceId: z.ZodString;
+        sessionId: z.ZodString;
+        clientMessageId: z.ZodOptional<z.ZodString>;
+        content: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+            type: z.ZodLiteral<"text">;
+            text: z.ZodString;
+            _meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        }, z.core.$strip>, z.ZodObject<{
+            type: z.ZodLiteral<"thinking">;
+            thinking: z.ZodString;
+            signature: z.ZodOptional<z.ZodString>;
+            _meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        }, z.core.$strip>, z.ZodObject<{
+            type: z.ZodLiteral<"image">;
+            source: z.ZodUnion<readonly [z.ZodObject<{
+                type: z.ZodLiteral<"url">;
+                url: z.ZodString;
+            }, z.core.$strip>, z.ZodObject<{
+                type: z.ZodLiteral<"base64">;
+                media_type: z.ZodString;
+                data: z.ZodString;
+            }, z.core.$strip>]>;
+            _meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        }, z.core.$strip>, z.ZodObject<{
+            type: z.ZodLiteral<"tool_use">;
+            id: z.ZodString;
+            name: z.ZodString;
+            input: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+            _meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        }, z.core.$strip>, z.ZodObject<{
+            type: z.ZodLiteral<"tool_result">;
+            tool_use_id: z.ZodString;
+            content: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodUnknown>]>;
+            is_error: z.ZodOptional<z.ZodBoolean>;
+            _meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        }, z.core.$strip>, z.ZodObject<{
+            type: z.ZodLiteral<"system_note">;
+            note_type: z.ZodEnum<{
+                session_created: "session_created";
+                forked: "forked";
+                compacted: "compacted";
+                info: "info";
+            }>;
+            text: z.ZodString;
+            _meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        }, z.core.$strip>], "type">>;
+        model: z.ZodOptional<z.ZodString>;
+        provider: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"ping">;
+    requestId: z.ZodOptional<z.ZodString>;
+    payload: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"ack">;
+    requestId: z.ZodOptional<z.ZodString>;
+    payload: z.ZodOptional<z.ZodObject<{
+        eventId: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>], "type">;
+export declare const realtimeEnvelopeSchema: z.ZodObject<{
+    id: z.ZodString;
+    timestamp: z.ZodNumber;
+    domain: z.ZodEnum<{
+        system: "system";
+        session: "session";
+        space: "space";
+    }>;
+    type: z.ZodString;
+    requestId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    spaceId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    sessionId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    payload: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+}, z.core.$strip>;
+export type { ContentBlock };
+export type WsClientEvent = {
+    type: "auth";
+    requestId?: string;
+    payload: {
+        token: string;
+    };
+} | {
+    type: "session.message.create";
+    requestId?: string;
+    payload: {
+        spaceId: string;
+        sessionId: string;
+        clientMessageId?: string;
+        content: ContentBlock[];
+        model?: string;
+        provider?: string;
+    };
+} | {
+    type: "ping";
+    requestId?: string;
+    payload?: Record<string, unknown>;
+} | {
+    type: "ack";
+    requestId?: string;
+    payload?: {
+        eventId?: string;
+    };
+};
+export type RealtimeEnvelope = z.output<typeof realtimeEnvelopeSchema>;
+export type RealtimeEnvelopeBase = RealtimeEnvelope;
+export type RealtimeDomain = RealtimeEnvelopeBase["domain"];
+export type SystemReadyEvent = {
+    id: string;
+    timestamp: number;
+    domain: "system";
+    type: "system.ready";
+    requestId?: string | null;
+    spaceId?: string | null;
+    sessionId?: string | null;
+    payload: {
+        connectionId: string;
+    };
+};
+export type SystemAuthOkEvent = {
+    id: string;
+    timestamp: number;
+    domain: "system";
+    type: "system.auth.ok";
+    requestId?: string | null;
+    spaceId?: string | null;
+    sessionId?: string | null;
+    payload: {
+        connectionId: string;
+        user: Record<string, unknown>;
+    };
+};
+export type SystemRequestErrorEvent = {
+    id: string;
+    timestamp: number;
+    domain: "system";
+    type: "system.request.error";
+    requestId?: string | null;
+    spaceId?: string | null;
+    sessionId?: string | null;
+    payload: {
+        code: string;
+        message: string;
+    };
+};
+export type SystemPongEvent = {
+    id: string;
+    timestamp: number;
+    domain: "system";
+    type: "system.pong";
+    requestId?: string | null;
+    spaceId?: string | null;
+    sessionId?: string | null;
+    payload: Record<string, never>;
+};
+export type SystemAckOkEvent = {
+    id: string;
+    timestamp: number;
+    domain: "system";
+    type: "system.ack.ok";
+    requestId?: string | null;
+    spaceId?: string | null;
+    sessionId?: string | null;
+    payload: Record<string, never>;
+};
+export type SessionRequestAcceptedEvent = {
+    id: string;
+    timestamp: number;
+    domain: "session";
+    type: "session.request.accepted";
+    requestId?: string | null;
+    spaceId: string;
+    sessionId: string;
+    payload: {
+        clientMessageId?: string | null;
+    };
+};
+export type SessionRequestErrorEvent = {
+    id: string;
+    timestamp: number;
+    domain: "session";
+    type: "session.request.error";
+    requestId?: string | null;
+    spaceId?: string | null;
+    sessionId?: string | null;
+    payload: {
+        code: string;
+        message: string;
+        clientMessageId?: string | null;
+    };
+};
+export type SessionTurnProgressEvent = {
+    id: string;
+    timestamp: number;
+    domain: "session";
+    type: "session.turn.progress";
+    requestId?: string | null;
+    spaceId: string;
+    sessionId: string;
+    payload: {
+        anchorUserMessageId: string | null;
+        content: ContentBlock[];
+    };
+};
+export type SessionTurnFinalEvent = {
+    id: string;
+    timestamp: number;
+    domain: "session";
+    type: "session.turn.final";
+    requestId?: string | null;
+    spaceId: string;
+    sessionId: string;
+    payload: {
+        sessionMessageId: string | null;
+        anchorUserMessageId: string | null;
+        content: ContentBlock[];
+    };
+};
+export type SessionTurnErrorEvent = {
+    id: string;
+    timestamp: number;
+    domain: "session";
+    type: "session.turn.error";
+    requestId?: string | null;
+    spaceId: string;
+    sessionId: string;
+    payload: {
+        anchorUserMessageId: string | null;
+        error: string;
+    };
+};
+export type SessionMessagePersistedEvent = {
+    id: string;
+    timestamp: number;
+    domain: "session";
+    type: "session.message.persisted";
+    requestId?: string | null;
+    spaceId: string;
+    sessionId: string;
+    payload: {
+        message: MessageRecord;
+    };
+};
+export type RealtimeServerEvent = SystemReadyEvent | SystemAuthOkEvent | SystemRequestErrorEvent | SystemPongEvent | SystemAckOkEvent | SessionRequestAcceptedEvent | SessionRequestErrorEvent | SessionTurnProgressEvent | SessionTurnFinalEvent | SessionTurnErrorEvent | SessionMessagePersistedEvent;
+export type WsServerEnvelope = RealtimeEnvelope;

package/dist/websocket.js

@@ -0,0 +1,85 @@
+import { z } from "zod";
+const contentBlockMetaSchema = z.record(z.string(), z.unknown());
+// ── Schemas ──
+export const contentBlockSchema = z.discriminatedUnion("type", [
+    z.object({
+        type: z.literal("text"),
+        text: z.string(),
+        _meta: contentBlockMetaSchema.optional(),
+    }),
+    z.object({
+        type: z.literal("thinking"),
+        thinking: z.string(),
+        signature: z.string().optional(),
+        _meta: contentBlockMetaSchema.optional(),
+    }),
+    z.object({
+        type: z.literal("image"),
+        source: z.union([
+            z.object({ type: z.literal("url"), url: z.string().url() }),
+            z.object({ type: z.literal("base64"), media_type: z.string(), data: z.string() }),
+        ]),
+        _meta: contentBlockMetaSchema.optional(),
+    }),
+    z.object({
+        type: z.literal("tool_use"),
+        id: z.string(),
+        name: z.string(),
+        input: z.record(z.string(), z.unknown()),
+        _meta: contentBlockMetaSchema.optional(),
+    }),
+    z.object({
+        type: z.literal("tool_result"),
+        tool_use_id: z.string(),
+        content: z.union([z.string(), z.array(z.unknown())]),
+        is_error: z.boolean().optional(),
+        _meta: contentBlockMetaSchema.optional(),
+    }),
+    z.object({
+        type: z.literal("system_note"),
+        note_type: z.enum(["session_created", "forked", "compacted", "info"]),
+        text: z.string(),
+        _meta: contentBlockMetaSchema.optional(),
+    }),
+]);
+export const wsClientEventSchema = z.discriminatedUnion("type", [
+    z.object({
+        type: z.literal("auth"),
+        requestId: z.string().optional(),
+        payload: z.object({ token: z.string().min(1) }),
+    }),
+    z.object({
+        type: z.literal("session.message.create"),
+        requestId: z.string().optional(),
+        payload: z.object({
+            spaceId: z.string().uuid(),
+            sessionId: z.string().uuid(),
+            clientMessageId: z.string().optional(),
+            content: z.array(contentBlockSchema).min(1),
+            model: z.string().optional(),
+            provider: z.string().optional(),
+        }),
+    }),
+    z.object({
+        type: z.literal("ping"),
+        requestId: z.string().optional(),
+        payload: z.record(z.string(), z.unknown()).optional(),
+    }),
+    z.object({
+        type: z.literal("ack"),
+        requestId: z.string().optional(),
+        payload: z.object({
+            eventId: z.string().optional(),
+        }).optional(),
+    }),
+]);
+export const realtimeEnvelopeSchema = z.object({
+    id: z.string(),
+    timestamp: z.number(),
+    domain: z.enum(["system", "session", "space"]),
+    type: z.string(),
+    requestId: z.string().nullable().optional(),
+    spaceId: z.string().nullable().optional(),
+    sessionId: z.string().nullable().optional(),
+    payload: z.record(z.string(), z.unknown()),
+});

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "@neta-art/cohub-protocol",
+  "version": "1.0.0",
+  "description": "Shared protocol definitions for the Cohub agent collaboration platform.",
+  "license": "UNLICENSED",
+  "private": false,
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/neta-art/cohub.git",
+    "directory": "packages/protocol"
+  },
+  "homepage": "https://github.com/neta-art/cohub",
+  "keywords": [
+    "cohub",
+    "protocol",
+    "agent",
+    "spaces",
+    "checkpoints",
+    "collaboration",
+    "realtime",
+    "sdk"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./core": {
+      "types": "./dist/core/index.d.ts",
+      "default": "./dist/core/index.js"
+    },
+    "./model": {
+      "types": "./dist/model/session.d.ts",
+      "default": "./dist/model/session.js"
+    },
+    "./realtime": {
+      "types": "./dist/realtime/index.d.ts",
+      "default": "./dist/realtime/index.js"
+    },
+    "./gateway": {
+      "types": "./dist/gateway/index.d.ts",
+      "default": "./dist/gateway/index.js"
+    },
+    "./task": {
+      "types": "./dist/task/index.d.ts",
+      "default": "./dist/task/index.js"
+    },
+    "./fs": {
+      "types": "./dist/fs/index.d.ts",
+      "default": "./dist/fs/index.js"
+    }
+  },
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "devDependencies": {
+    "@typescript/native-preview": "7.0.0-dev.20260421.1",
+    "typescript": "^6.0.3"
+  },
+  "dependencies": {
+    "zod": "^4.3.6"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "typecheck": "tsgo --noEmit"
+  }
+}