@herdctl/web 0.0.1 → 0.1.0

package/dist/server/ws/types.d.ts

@@ -0,0 +1,215 @@
+/**
+ * WebSocket protocol types for @herdctl/web
+ *
+ * Defines the message types exchanged between the WebSocket server and clients.
+ * The server broadcasts FleetManager events to connected clients, and clients
+ * can subscribe to specific agents for high-volume output events.
+ */
+import type { FleetStatus, AgentStartedPayload, AgentStoppedPayload, JobCreatedPayload, JobOutputPayload, JobCompletedPayload, JobFailedPayload, JobCancelledPayload, ScheduleTriggeredPayload } from "@herdctl/core";
+/**
+ * Subscribe to an agent's output events
+ *
+ * The server will only forward `job:output` events for the specified agent
+ * to this client. This is used for the live output streaming feature to avoid
+ * overwhelming clients with output from agents they're not viewing.
+ */
+export interface SubscribeMessage {
+    type: "subscribe";
+    payload: {
+        /** Name of the agent to subscribe to */
+        agentName: string;
+    };
+}
+/**
+ * Unsubscribe from an agent's output events
+ *
+ * Stop receiving `job:output` events for the specified agent.
+ */
+export interface UnsubscribeMessage {
+    type: "unsubscribe";
+    payload: {
+        /** Name of the agent to unsubscribe from */
+        agentName: string;
+    };
+}
+/**
+ * Ping message for keepalive
+ *
+ * The client sends this periodically to keep the connection alive.
+ * The server responds with a `pong` message.
+ */
+export interface PingMessage {
+    type: "ping";
+}
+/**
+ * Chat send message
+ *
+ * Client sends this to send a message to an agent in a chat session.
+ * The response streams back via `chat:response` messages.
+ */
+export interface ChatSendMessage {
+    type: "chat:send";
+    payload: {
+        /** Name of the agent to chat with */
+        agentName: string;
+        /** Session ID for the chat conversation */
+        sessionId: string;
+        /** User message content */
+        message: string;
+    };
+}
+/**
+ * Union type of all messages that clients can send to the server
+ */
+export type ClientMessage = SubscribeMessage | UnsubscribeMessage | PingMessage | ChatSendMessage;
+/**
+ * Full fleet status snapshot
+ *
+ * Sent to a client immediately upon connection, and can be requested
+ * by the client at any time to resync state.
+ */
+export interface FleetStatusMessage {
+    type: "fleet:status";
+    payload: FleetStatus;
+}
+/**
+ * Agent started or stopped event
+ *
+ * Broadcasts when an agent's lifecycle state changes.
+ */
+export interface AgentUpdatedMessage {
+    type: "agent:updated";
+    payload: AgentStartedPayload | AgentStoppedPayload;
+}
+/**
+ * Job created event
+ *
+ * Broadcast to all clients when a new job is created.
+ */
+export interface JobCreatedMessage {
+    type: "job:created";
+    payload: JobCreatedPayload;
+}
+/**
+ * Job output event
+ *
+ * Sent only to clients that have subscribed to the relevant agent.
+ * This is the high-volume event used for live output streaming.
+ */
+export interface JobOutputMessage {
+    type: "job:output";
+    payload: JobOutputPayload;
+}
+/**
+ * Job completed event
+ *
+ * Broadcast to all clients when a job completes successfully.
+ */
+export interface JobCompletedMessage {
+    type: "job:completed";
+    payload: JobCompletedPayload;
+}
+/**
+ * Job failed event
+ *
+ * Broadcast to all clients when a job fails.
+ */
+export interface JobFailedMessage {
+    type: "job:failed";
+    payload: JobFailedPayload;
+}
+/**
+ * Job cancelled event
+ *
+ * Broadcast to all clients when a job is cancelled.
+ */
+export interface JobCancelledMessage {
+    type: "job:cancelled";
+    payload: JobCancelledPayload;
+}
+/**
+ * Schedule triggered event
+ *
+ * Broadcast to all clients when a schedule triggers an agent run.
+ */
+export interface ScheduleTriggeredMessage {
+    type: "schedule:triggered";
+    payload: ScheduleTriggeredPayload;
+}
+/**
+ * Pong response to ping keepalive
+ */
+export interface PongMessage {
+    type: "pong";
+}
+/**
+ * Chat response chunk
+ *
+ * Server sends this as streaming response chunks during chat.
+ */
+export interface ChatResponseMessage {
+    type: "chat:response";
+    payload: {
+        /** Name of the agent */
+        agentName: string;
+        /** Session ID for the chat conversation */
+        sessionId: string;
+        /** Job ID for tracking the execution */
+        jobId: string;
+        /** Response chunk content */
+        chunk: string;
+    };
+}
+/**
+ * Chat complete message
+ *
+ * Server sends this when chat response is complete.
+ */
+export interface ChatCompleteMessage {
+    type: "chat:complete";
+    payload: {
+        /** Name of the agent */
+        agentName: string;
+        /** Session ID for the chat conversation */
+        sessionId: string;
+        /** Job ID for tracking the execution */
+        jobId: string;
+    };
+}
+/**
+ * Chat error message
+ *
+ * Server sends this when a chat error occurs.
+ */
+export interface ChatErrorMessage {
+    type: "chat:error";
+    payload: {
+        /** Name of the agent */
+        agentName: string;
+        /** Session ID for the chat conversation */
+        sessionId: string;
+        /** Error message */
+        error: string;
+    };
+}
+/**
+ * Union type of all messages that the server can send to clients
+ */
+export type ServerMessage = FleetStatusMessage | AgentUpdatedMessage | JobCreatedMessage | JobOutputMessage | JobCompletedMessage | JobFailedMessage | JobCancelledMessage | ScheduleTriggeredMessage | PongMessage | ChatResponseMessage | ChatCompleteMessage | ChatErrorMessage;
+/**
+ * Check if a message is a valid ClientMessage
+ */
+export declare function isClientMessage(data: unknown): data is ClientMessage;
+/**
+ * Check if a message is a valid ChatSendMessage
+ */
+export declare function isChatSendMessage(data: unknown): data is ChatSendMessage;
+/**
+ * Type guard to check if a payload is AgentStartedPayload
+ */
+export declare function isAgentStartedPayload(payload: AgentStartedPayload | AgentStoppedPayload): payload is AgentStartedPayload;
+/**
+ * Type guard to check if a payload is AgentStoppedPayload
+ */
+export declare function isAgentStoppedPayload(payload: AgentStartedPayload | AgentStoppedPayload): payload is AgentStoppedPayload;
+//# sourceMappingURL=types.d.ts.map

package/dist/server/ws/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/server/ws/types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EACV,WAAW,EACX,mBAAmB,EACnB,mBAAmB,EACnB,iBAAiB,EACjB,gBAAgB,EAChB,mBAAmB,EACnB,gBAAgB,EAChB,mBAAmB,EACnB,wBAAwB,EACzB,MAAM,eAAe,CAAC;AAMvB;;;;;;GAMG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,WAAW,CAAC;IAClB,OAAO,EAAE;QACP,wCAAwC;QACxC,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,aAAa,CAAC;IACpB,OAAO,EAAE;QACP,4CAA4C;QAC5C,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;CACH;AAED;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,WAAW,CAAC;IAClB,OAAO,EAAE;QACP,qCAAqC;QACrC,SAAS,EAAE,MAAM,CAAC;QAClB,2CAA2C;QAC3C,SAAS,EAAE,MAAM,CAAC;QAClB,2BAA2B;QAC3B,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,gBAAgB,GAAG,kBAAkB,GAAG,WAAW,GAAG,eAAe,CAAC;AAMlG;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,cAAc,CAAC;IACrB,OAAO,EAAE,WAAW,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,eAAe,CAAC;IACtB,OAAO,EAAE,mBAAmB,GAAG,mBAAmB,CAAC;CACpD;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,aAAa,CAAC;IACpB,OAAO,EAAE,iBAAiB,CAAC;CAC5B;AAED;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,YAAY,CAAC;IACnB,OAAO,EAAE,gBAAgB,CAAC;CAC3B;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,eAAe,CAAC;IACtB,OAAO,EAAE,mBAAmB,CAAC;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,YAAY,CAAC;IACnB,OAAO,EAAE,gBAAgB,CAAC;CAC3B;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,eAAe,CAAC;IACtB,OAAO,EAAE,mBAAmB,CAAC;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,oBAAoB,CAAC;IAC3B,OAAO,EAAE,wBAAwB,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,eAAe,CAAC;IACtB,OAAO,EAAE;QACP,wBAAwB;QACxB,SAAS,EAAE,MAAM,CAAC;QAClB,2CAA2C;QAC3C,SAAS,EAAE,MAAM,CAAC;QAClB,wCAAwC;QACxC,KAAK,EAAE,MAAM,CAAC;QACd,6BAA6B;QAC7B,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,eAAe,CAAC;IACtB,OAAO,EAAE;QACP,wBAAwB;QACxB,SAAS,EAAE,MAAM,CAAC;QAClB,2CAA2C;QAC3C,SAAS,EAAE,MAAM,CAAC;QAClB,wCAAwC;QACxC,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,YAAY,CAAC;IACnB,OAAO,EAAE;QACP,wBAAwB;QACxB,SAAS,EAAE,MAAM,CAAC;QAClB,2CAA2C;QAC3C,SAAS,EAAE,MAAM,CAAC;QAClB,oBAAoB;QACpB,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GACrB,kBAAkB,GAClB,mBAAmB,GACnB,iBAAiB,GACjB,gBAAgB,GAChB,mBAAmB,GACnB,gBAAgB,GAChB,mBAAmB,GACnB,wBAAwB,GACxB,WAAW,GACX,mBAAmB,GACnB,mBAAmB,GACnB,gBAAgB,CAAC;AAMrB;;GAEG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI,aAAa,CA0BpE;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI,eAAe,CAqBxE;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CACnC,OAAO,EAAE,mBAAmB,GAAG,mBAAmB,GACjD,OAAO,IAAI,mBAAmB,CAEhC;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CACnC,OAAO,EAAE,mBAAmB,GAAG,mBAAmB,GACjD,OAAO,IAAI,mBAAmB,CAEhC"}

package/dist/server/ws/types.js

@@ -0,0 +1,67 @@
+/**
+ * WebSocket protocol types for @herdctl/web
+ *
+ * Defines the message types exchanged between the WebSocket server and clients.
+ * The server broadcasts FleetManager events to connected clients, and clients
+ * can subscribe to specific agents for high-volume output events.
+ */
+// =============================================================================
+// Type Guards
+// =============================================================================
+/**
+ * Check if a message is a valid ClientMessage
+ */
+export function isClientMessage(data) {
+    if (typeof data !== "object" || data === null) {
+        return false;
+    }
+    const msg = data;
+    if (typeof msg.type !== "string") {
+        return false;
+    }
+    switch (msg.type) {
+        case "subscribe":
+        case "unsubscribe":
+            return (typeof msg.payload === "object" &&
+                msg.payload !== null &&
+                typeof msg.payload.agentName === "string");
+        case "ping":
+            return true;
+        case "chat:send":
+            return isChatSendMessage(msg);
+        default:
+            return false;
+    }
+}
+/**
+ * Check if a message is a valid ChatSendMessage
+ */
+export function isChatSendMessage(data) {
+    if (typeof data !== "object" || data === null) {
+        return false;
+    }
+    const msg = data;
+    if (msg.type !== "chat:send") {
+        return false;
+    }
+    const payload = msg.payload;
+    if (typeof payload !== "object" || payload === null) {
+        return false;
+    }
+    return (typeof payload.agentName === "string" &&
+        typeof payload.sessionId === "string" &&
+        typeof payload.message === "string");
+}
+/**
+ * Type guard to check if a payload is AgentStartedPayload
+ */
+export function isAgentStartedPayload(payload) {
+    return "agent" in payload;
+}
+/**
+ * Type guard to check if a payload is AgentStoppedPayload
+ */
+export function isAgentStoppedPayload(payload) {
+    return "agentName" in payload && !("agent" in payload);
+}
+//# sourceMappingURL=types.js.map

package/dist/server/ws/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/server/ws/types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAkPH,gFAAgF;AAChF,cAAc;AACd,gFAAgF;AAEhF;;GAEG;AACH,MAAM,UAAU,eAAe,CAAC,IAAa;IAC3C,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QAC9C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,GAAG,GAAG,IAA+B,CAAC;IAE5C,IAAI,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QACjC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC;QACjB,KAAK,WAAW,CAAC;QACjB,KAAK,aAAa;YAChB,OAAO,CACL,OAAO,GAAG,CAAC,OAAO,KAAK,QAAQ;gBAC/B,GAAG,CAAC,OAAO,KAAK,IAAI;gBACpB,OAAQ,GAAG,CAAC,OAAmC,CAAC,SAAS,KAAK,QAAQ,CACvE,CAAC;QACJ,KAAK,MAAM;YACT,OAAO,IAAI,CAAC;QACd,KAAK,WAAW;YACd,OAAO,iBAAiB,CAAC,GAAG,CAAC,CAAC;QAChC;YACE,OAAO,KAAK,CAAC;IACjB,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,iBAAiB,CAAC,IAAa;IAC7C,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QAC9C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,GAAG,GAAG,IAA+B,CAAC;IAE5C,IAAI,GAAG,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;QAC7B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,OAAO,GAAG,GAAG,CAAC,OAAqD,CAAC;IAC1E,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;QACpD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,CACL,OAAO,OAAO,CAAC,SAAS,KAAK,QAAQ;QACrC,OAAO,OAAO,CAAC,SAAS,KAAK,QAAQ;QACrC,OAAO,OAAO,CAAC,OAAO,KAAK,QAAQ,CACpC,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,qBAAqB,CACnC,OAAkD;IAElD,OAAO,OAAO,IAAI,OAAO,CAAC;AAC5B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,qBAAqB,CACnC,OAAkD;IAElD,OAAO,WAAW,IAAI,OAAO,IAAI,CAAC,CAAC,OAAO,IAAI,OAAO,CAAC,CAAC;AACzD,CAAC"}

package/package.json

@@ -1 +1,77 @@
-{"name":"@herdctl/web","version":"0.0.1","description":"Web dashboard for herdctl fleet management","license":"MIT","publishConfig":{"access":"public"}}
+{
+  "name": "@herdctl/web",
+  "version": "0.1.0",
+  "description": "Web dashboard for herdctl fleet management",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/server/index.js",
+  "types": "./dist/server/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@dicebear/bottts": "^9.3.1",
+    "@dicebear/core": "^9.3.1",
+    "@fastify/cors": "^10.0.3",
+    "@fastify/static": "^8.2.0",
+    "@fastify/websocket": "^11.0.3",
+    "fastify": "^5.2.2",
+    "lucide-react": "^0.475.0",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "react-markdown": "^10.1.0",
+    "react-resizable-panels": "^2.1.7",
+    "react-router": "^7.2.0",
+    "remark-gfm": "^4.0.1",
+    "zustand": "^5.0.3",
+    "@herdctl/chat": "0.2.2",
+    "@herdctl/core": "5.2.0"
+  },
+  "devDependencies": {
+    "@tailwindcss/vite": "^4.1.18",
+    "@testing-library/jest-dom": "^6.6.3",
+    "@testing-library/react": "^16.2.0",
+    "@types/react": "^19.0.10",
+    "@types/react-dom": "^19.0.4",
+    "@types/ws": "^8.5.10",
+    "@vitejs/plugin-react": "^4.3.4",
+    "@vitest/coverage-v8": "^4.0.17",
+    "concurrently": "^9.1.2",
+    "jsdom": "^26.0.0",
+    "tailwindcss": "^4.0.9",
+    "typescript": "^5",
+    "vite": "^6.2.0",
+    "vitest": "^4.0.17"
+  },
+  "homepage": "https://herdctl.dev",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/edspencer/herdctl"
+  },
+  "keywords": [
+    "claude",
+    "agent",
+    "fleet",
+    "orchestration",
+    "dashboard",
+    "web",
+    "anthropic"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "scripts": {
+    "build": "npm run build:client && npm run build:server",
+    "build:client": "vite build",
+    "build:server": "tsc -p tsconfig.json",
+    "dev": "concurrently \"npm run dev:client\" \"npm run dev:server\"",
+    "dev:client": "vite",
+    "dev:server": "tsc -p tsconfig.json --watch",
+    "typecheck": "tsc --noEmit -p tsconfig.json",
+    "test": "vitest run --coverage --passWithNoTests"
+  }
+}