@camox/api-contract 0.62.0 → 0.63.0

package/dist/threads.d.ts

@@ -10,6 +10,14 @@ import { Message } from "@earendil-works/pi-ai";
  * studio as they sent it (`editorTextOf`).
  */
 export declare const EDITOR_MESSAGE_ENTRY = "camox.editor-message";
+/**
+ * The kind of the transcript entry recording a Connected Agent's message (ADR 0030), with its
+ * member and client as data (`connectedAgentMessageDataSchema`). The model reads it as a user
+ * message, as it does an editor's: its first text part is what the Connected Agent wrote, and a
+ * second one, which only the model reads, says who sent it. Studios show it as the member's AI,
+ * never as the member.
+ */
+export declare const CONNECTED_AGENT_MESSAGE_ENTRY = "camox.connected-agent-message";
 /** The kind of the transcript entry recording that an editor stopped a run, with them as data. */
 export declare const RUN_STOPPED_ENTRY = "camox.run-stopped";
 /**
@@ -103,6 +111,32 @@ export declare const threadSenderSchema: z.ZodObject<{
 export type ThreadSender = z.infer<typeof threadSenderSchema>;
 /** Whether `data` names a sender. */
 export declare const isSender: (data: unknown) => data is ThreadSender;
+/**
+ * The app a Connected Agent runs in, by the name it gave: verified when it comes from a Client ID
+ * Metadata Document, self-asserted otherwise.
+ */
+export declare const connectedAgentClientSchema: z.ZodObject<{
+  name: z.ZodString;
+  verified: z.ZodBoolean;
+}, z.core.$strip>;
+export type ConnectedAgentClient = z.infer<typeof connectedAgentClientSchema>;
+/**
+ * What a Connected Agent's message entry records: the member it acts as, its client, and the
+ * operation id it was sent with.
+ */
+export declare const connectedAgentMessageDataSchema: z.ZodObject<{
+  member: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    image: z.ZodNullable<z.ZodString>;
+  }, z.core.$strip>;
+  client: z.ZodObject<{
+    name: z.ZodString;
+    verified: z.ZodBoolean;
+  }, z.core.$strip>;
+  operationId: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type ConnectedAgentMessageData = z.infer<typeof connectedAgentMessageDataSchema>;
 /** What a push's entry records: who pushed, their commits' subjects, oldest first, and the build. */
 export declare const pushDataSchema: z.ZodObject<{
   pusher: z.ZodObject<{
@@ -236,6 +270,17 @@ export type ThreadMessage = {
   sender: ThreadSender;
   text: string;
 } |
+/**
+ * A member's Connected Agent's message: the member's own AI, in its client, writing as itself.
+ * Never shown as the member's own words.
+ */
+{
+  id: string;
+  from: "connectedAgent";
+  member: ThreadSender;
+  client: ConnectedAgentClient;
+  text: string;
+} |
 /** Camox's own message, starting a turn it began itself: why it did. */
 {
   id: string;
@@ -337,6 +382,11 @@ type ThreadStep = {
   text: string;
   /** The draft the message went to, as the agent on Live handed the request off. */
   handedOffTo?: string;
+} | {
+  type: "connectedAgent";
+  member: ThreadSender;
+  client: ConnectedAgentClient;
+  text: string;
 } |
 /** Camox starting a turn of its own, saying why. */
 {

package/dist/threads.js

@@ -8,6 +8,14 @@ import { z } from "zod";
 * studio as they sent it (`editorTextOf`).
 */
 const EDITOR_MESSAGE_ENTRY = "camox.editor-message";
+/**
+* The kind of the transcript entry recording a Connected Agent's message (ADR 0030), with its
+* member and client as data (`connectedAgentMessageDataSchema`). The model reads it as a user
+* message, as it does an editor's: its first text part is what the Connected Agent wrote, and a
+* second one, which only the model reads, says who sent it. Studios show it as the member's AI,
+* never as the member.
+*/
+const CONNECTED_AGENT_MESSAGE_ENTRY = "camox.connected-agent-message";
 /** The kind of the transcript entry recording that an editor stopped a run, with them as data. */
 const RUN_STOPPED_ENTRY = "camox.run-stopped";
 /**
@@ -97,6 +105,23 @@ const threadSenderSchema = z.object({
 });
 /** Whether `data` names a sender. */
 const isSender = (data) => threadSenderSchema.safeParse(data).success;
+/**
+* The app a Connected Agent runs in, by the name it gave: verified when it comes from a Client ID
+* Metadata Document, self-asserted otherwise.
+*/
+const connectedAgentClientSchema = z.object({
+	name: z.string(),
+	verified: z.boolean()
+});
+/**
+* What a Connected Agent's message entry records: the member it acts as, its client, and the
+* operation id it was sent with.
+*/
+const connectedAgentMessageDataSchema = z.object({
+	member: threadSenderSchema,
+	client: connectedAgentClientSchema,
+	operationId: z.string().optional()
+});
 /** What a push's entry records: who pushed, their commits' subjects, oldest first, and the build. */
 const pushDataSchema = z.object({
 	pusher: threadSenderSchema,
@@ -291,6 +316,19 @@ function threadStepOf(entry) {
 				...handedOffTo && { handedOffTo }
 			};
 		}
+		if (entry.kind === "camox.connected-agent-message") {
+			const data = connectedAgentMessageDataSchema.safeParse(entry.data).data;
+			return data && {
+				id,
+				type: "connectedAgent",
+				member: senderOf(data.member),
+				client: {
+					name: data.client.name,
+					verified: data.client.verified
+				},
+				text: editorTextOf(message.content)
+			};
+		}
 		if (entry.kind === "camox.brief") return {
 			id,
 			type: "camox",
@@ -374,6 +412,17 @@ function threadViewOf({ steps, running, toolCalls = [], callingTools = false, ch
 			waiting = step.id;
 			break;
 		}
+		case "connectedAgent":
+			if (unfinished) fail();
+			messages.push({
+				id: step.id,
+				from: "connectedAgent",
+				member: step.member,
+				client: step.client,
+				text: step.text
+			});
+			waiting = step.id;
+			break;
 		case "camox":
 			if (unfinished) fail();
 			messages.push({
@@ -566,4 +615,4 @@ function reduceThreadFrame(state, frame) {
 }
 
 //#endregion
-export { BRIEF_ENTRY, BUILD_STATUS_ENTRY, BUILD_TOOL, CHANGING_TOOLS, DRAFT_ENDED_ENTRY, EDITOR_MESSAGE_ENTRY, EMPTY_THREAD_STATE, EMPTY_THREAD_VIEW, PUSH_ENTRY, RECONCILE_ENTRY, RUN_STOPPED_ENTRY, START_DRAFT_TOOL, THREAD_ENDED_CLOSE_CODE, buildStatusDataSchema, buildStatusSchema, editorMessageDataSchema, editorSelectionSchema, editorTextOf, editorWhereSchema, isSender, pushDataSchema, pushOutcomeSchema, reconcileDataSchema, reduceThreadEvents, reduceThreadFrame, reduceThreadState, startedDraftCardSchema, startedDraftSchema, textOf, threadClientMessageSchema, threadSenderSchema, threadViewOf, touchKindSchema, touchSchema, touchedBatchSchema };
+export { BRIEF_ENTRY, BUILD_STATUS_ENTRY, BUILD_TOOL, CHANGING_TOOLS, CONNECTED_AGENT_MESSAGE_ENTRY, DRAFT_ENDED_ENTRY, EDITOR_MESSAGE_ENTRY, EMPTY_THREAD_STATE, EMPTY_THREAD_VIEW, PUSH_ENTRY, RECONCILE_ENTRY, RUN_STOPPED_ENTRY, START_DRAFT_TOOL, THREAD_ENDED_CLOSE_CODE, buildStatusDataSchema, buildStatusSchema, connectedAgentClientSchema, connectedAgentMessageDataSchema, editorMessageDataSchema, editorSelectionSchema, editorTextOf, editorWhereSchema, isSender, pushDataSchema, pushOutcomeSchema, reconcileDataSchema, reduceThreadEvents, reduceThreadFrame, reduceThreadState, startedDraftCardSchema, startedDraftSchema, textOf, threadClientMessageSchema, threadSenderSchema, threadViewOf, touchKindSchema, touchSchema, touchedBatchSchema };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@camox/api-contract",
-  "version": "0.62.0",
+  "version": "0.63.0",
   "license": "MIT",
   "files": [
     "src",

package/src/locales.ts

@@ -15,6 +15,13 @@ export function localePrefix(locale: LocaleView): string {
   return locale.isDefault ? "" : `/${locale.tag.toLowerCase()}`;
 }
 
+/** A locale-relative path under its locale's prefix, keeping its search and hash: `/` is `/de`. */
+export function localizedPath(path: string, locale: LocaleView): string {
+  const prefix = localePrefix(locale);
+  if (!prefix) return path;
+  return path === "/" || /^\/[?#]/.test(path) ? `${prefix}${path.slice(1)}` : `${prefix}${path}`;
+}
+
 /**
  * The locale a runtime path names, and the path after its prefix, without search or hash. A first
  * segment that isn't a non-default locale's prefix leaves the path the default locale's. A

package/src/threads.ts

@@ -16,6 +16,15 @@ import type { DraftOutcome } from "./drafts.ts";
  */
 export const EDITOR_MESSAGE_ENTRY = "camox.editor-message";
 
+/**
+ * The kind of the transcript entry recording a Connected Agent's message (ADR 0030), with its
+ * member and client as data (`connectedAgentMessageDataSchema`). The model reads it as a user
+ * message, as it does an editor's: its first text part is what the Connected Agent wrote, and a
+ * second one, which only the model reads, says who sent it. Studios show it as the member's AI,
+ * never as the member.
+ */
+export const CONNECTED_AGENT_MESSAGE_ENTRY = "camox.connected-agent-message";
+
 /** The kind of the transcript entry recording that an editor stopped a run, with them as data. */
 export const RUN_STOPPED_ENTRY = "camox.run-stopped";
 
@@ -132,6 +141,24 @@ export type ThreadSender = z.infer<typeof threadSenderSchema>;
 export const isSender = (data: unknown): data is ThreadSender =>
   threadSenderSchema.safeParse(data).success;
 
+/**
+ * The app a Connected Agent runs in, by the name it gave: verified when it comes from a Client ID
+ * Metadata Document, self-asserted otherwise.
+ */
+export const connectedAgentClientSchema = z.object({ name: z.string(), verified: z.boolean() });
+export type ConnectedAgentClient = z.infer<typeof connectedAgentClientSchema>;
+
+/**
+ * What a Connected Agent's message entry records: the member it acts as, its client, and the
+ * operation id it was sent with.
+ */
+export const connectedAgentMessageDataSchema = z.object({
+  member: threadSenderSchema,
+  client: connectedAgentClientSchema,
+  operationId: z.string().optional(),
+});
+export type ConnectedAgentMessageData = z.infer<typeof connectedAgentMessageDataSchema>;
+
 /** What a push's entry records: who pushed, their commits' subjects, oldest first, and the build. */
 export const pushDataSchema = z.object({
   pusher: threadSenderSchema,
@@ -205,6 +232,17 @@ export type TouchedBatch = z.infer<typeof touchedBatchSchema>;
 /** A message the studio shows in a thread. */
 export type ThreadMessage =
   | { id: string; from: "editor"; sender: ThreadSender; text: string }
+  /**
+   * A member's Connected Agent's message: the member's own AI, in its client, writing as itself.
+   * Never shown as the member's own words.
+   */
+  | {
+      id: string;
+      from: "connectedAgent";
+      member: ThreadSender;
+      client: ConnectedAgentClient;
+      text: string;
+    }
   /** Camox's own message, starting a turn it began itself: why it did. */
   | { id: string; from: "camox"; text: string }
   /** The agent's final message of a turn, in Markdown. */
@@ -290,6 +328,7 @@ type ThreadStep = { id: string } & (
       /** The draft the message went to, as the agent on Live handed the request off. */
       handedOffTo?: string;
     }
+  | { type: "connectedAgent"; member: ThreadSender; client: ConnectedAgentClient; text: string }
   /** Camox starting a turn of its own, saying why. */
   | { type: "camox"; text: string }
   | { type: "answer"; text: string }
@@ -461,6 +500,18 @@ function threadStepOf(entry: EntryRecord): ThreadStep | undefined {
         }
       );
     }
+    if (entry.kind === CONNECTED_AGENT_MESSAGE_ENTRY) {
+      const data = connectedAgentMessageDataSchema.safeParse(entry.data).data;
+      return (
+        data && {
+          id,
+          type: "connectedAgent",
+          member: senderOf(data.member)!,
+          client: { name: data.client.name, verified: data.client.verified },
+          text: editorTextOf(message.content),
+        }
+      );
+    }
     if (entry.kind === BRIEF_ENTRY) return { id, type: "camox", text: textOf(message.content) };
     if (entry.kind === RECONCILE_ENTRY) {
       const reconcile = reconcileDataSchema.safeParse(entry.data).data;
@@ -547,6 +598,18 @@ export function threadViewOf({
         waiting = step.id;
         break;
       }
+      case "connectedAgent":
+        // Like an editor's message: it starts a turn, or steers the one going.
+        if (unfinished) fail();
+        messages.push({
+          id: step.id,
+          from: "connectedAgent",
+          member: step.member,
+          client: step.client,
+          text: step.text,
+        });
+        waiting = step.id;
+        break;
       case "camox":
         if (unfinished) fail();
         messages.push({ id: step.id, from: "camox", text: step.text });