@openscout/protocol 0.2.16 → 0.2.17

package/src/relay-agent-card.ts

@@ -0,0 +1,76 @@
+import type { AgentEndpoint, AgentHarness } from "./actors.js";
+import type { MetadataMap, ScoutId } from "./common.js";
+
+export interface RelayReturnAddress {
+  actorId: ScoutId;
+  handle: string;
+  displayName?: string;
+  selector?: string;
+  defaultSelector?: string;
+  conversationId?: ScoutId;
+  replyToMessageId?: ScoutId;
+  nodeId?: ScoutId;
+  projectRoot?: string;
+  sessionId?: string;
+  metadata?: MetadataMap;
+}
+
+export interface RelayAgentCard {
+  id: ScoutId;
+  agentId: ScoutId;
+  definitionId: ScoutId;
+  displayName: string;
+  handle: string;
+  selector?: string;
+  defaultSelector?: string;
+  projectName?: string;
+  projectRoot: string;
+  currentDirectory: string;
+  harness: AgentHarness;
+  transport: AgentEndpoint["transport"];
+  sessionId?: string;
+  branch?: string;
+  createdAt: number;
+  createdById?: ScoutId;
+  brokerRegistered: boolean;
+  inboxConversationId?: ScoutId;
+  returnAddress: RelayReturnAddress;
+  metadata?: MetadataMap;
+}
+
+export function buildRelayReturnAddress(input: RelayReturnAddress): RelayReturnAddress {
+  const next: RelayReturnAddress = {
+    actorId: input.actorId,
+    handle: input.handle.trim(),
+  };
+
+  if (input.displayName?.trim()) {
+    next.displayName = input.displayName.trim();
+  }
+  if (input.selector?.trim()) {
+    next.selector = input.selector.trim();
+  }
+  if (input.defaultSelector?.trim()) {
+    next.defaultSelector = input.defaultSelector.trim();
+  }
+  if (input.conversationId?.trim()) {
+    next.conversationId = input.conversationId.trim();
+  }
+  if (input.replyToMessageId?.trim()) {
+    next.replyToMessageId = input.replyToMessageId.trim();
+  }
+  if (input.nodeId?.trim()) {
+    next.nodeId = input.nodeId.trim();
+  }
+  if (input.projectRoot?.trim()) {
+    next.projectRoot = input.projectRoot.trim();
+  }
+  if (input.sessionId?.trim()) {
+    next.sessionId = input.sessionId.trim();
+  }
+  if (input.metadata && Object.keys(input.metadata).length > 0) {
+    next.metadata = input.metadata;
+  }
+
+  return next;
+}

package/src/transports.ts

@@ -0,0 +1,92 @@
+import type { DeliveryTransport, MetadataMap, ScoutId } from "./common.js";
+import type { AgentDefinition, AgentEndpoint, ActorIdentity } from "./actors.js";
+import type { ConversationBinding, ConversationDefinition } from "./conversations.js";
+import type { InvocationRequest } from "./invocations.js";
+import type { NodeDefinition } from "./mesh.js";
+import type { MessageRecord } from "./messages.js";
+import type { CollaborationEvent, CollaborationRecord } from "./collaboration.js";
+
+export interface SubscriptionRequest {
+  actorId: ScoutId;
+  conversationIds?: ScoutId[];
+  flightIds?: ScoutId[];
+  eventKinds?: string[];
+}
+
+export interface PostMessageCommand {
+  kind: "conversation.post";
+  message: MessageRecord;
+}
+
+export interface InvokeAgentCommand {
+  kind: "agent.invoke";
+  invocation: InvocationRequest;
+}
+
+export interface EnsureAwakeCommand {
+  kind: "agent.ensure_awake";
+  agentId: ScoutId;
+  requesterId: ScoutId;
+  reason: string;
+  metadata?: MetadataMap;
+}
+
+export interface SubscribeCommand {
+  kind: "stream.subscribe";
+  subscription: SubscriptionRequest;
+  transport: Extract<DeliveryTransport, "local_socket" | "websocket">;
+}
+
+export interface NodeUpsertCommand {
+  kind: "node.upsert";
+  node: NodeDefinition;
+}
+
+export interface ActorUpsertCommand {
+  kind: "actor.upsert";
+  actor: ActorIdentity;
+}
+
+export interface AgentUpsertCommand {
+  kind: "agent.upsert";
+  agent: AgentDefinition;
+}
+
+export interface AgentEndpointUpsertCommand {
+  kind: "agent.endpoint.upsert";
+  endpoint: AgentEndpoint;
+}
+
+export interface ConversationUpsertCommand {
+  kind: "conversation.upsert";
+  conversation: ConversationDefinition;
+}
+
+export interface BindingUpsertCommand {
+  kind: "binding.upsert";
+  binding: ConversationBinding;
+}
+
+export interface CollaborationUpsertCommand {
+  kind: "collaboration.upsert";
+  record: CollaborationRecord;
+}
+
+export interface CollaborationEventAppendCommand {
+  kind: "collaboration.event.append";
+  event: CollaborationEvent;
+}
+
+export type ControlCommand =
+  | NodeUpsertCommand
+  | ActorUpsertCommand
+  | AgentUpsertCommand
+  | AgentEndpointUpsertCommand
+  | ConversationUpsertCommand
+  | BindingUpsertCommand
+  | CollaborationUpsertCommand
+  | CollaborationEventAppendCommand
+  | PostMessageCommand
+  | InvokeAgentCommand
+  | EnsureAwakeCommand
+  | SubscribeCommand;