@camox/api-contract 0.58.1 → 0.59.0

package/dist/threads.d.ts

@@ -34,6 +34,19 @@ export declare const BRIEF_ENTRY = "camox.brief";
  * it at the end of the conversation; editors never see it, since the draft's card says so.
  */
 export declare const DRAFT_ENDED_ENTRY = "camox.draft-ended";
+/**
+ * The kind of the transcript entry recording a member's push to the draft's code from their own
+ * checkout (ADR 0026), with a `pushDataSchema` as data. The model reads it as context, never
+ * answering it, and editors see who pushed, their commits, and whether they built.
+ */
+export declare const PUSH_ENTRY = "camox.push";
+/** How a pushed head's build ended: built, built with type errors, or built but not previewed. */
+export declare const pushOutcomeSchema: z.ZodEnum<{
+  built: "built";
+  typeErrors: "typeErrors";
+  notPreviewed: "notPreviewed";
+}>;
+export type PushOutcome = z.infer<typeof pushOutcomeSchema>;
 /**
  * The agent's tool on Live handing a request off to a draft it starts (ADR 0025). A run whose
  * call of it went through ends on the draft's card.
@@ -80,6 +93,21 @@ 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;
+/** 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<{
+    id: z.ZodString;
+    name: z.ZodString;
+    image: z.ZodNullable<z.ZodString>;
+  }, z.core.$strip>;
+  subjects: z.ZodArray<z.ZodString>;
+  outcome: z.ZodEnum<{
+    built: "built";
+    typeErrors: "typeErrors";
+    notPreviewed: "notPreviewed";
+  }>;
+}, z.core.$strip>;
+export type PushData = z.infer<typeof pushDataSchema>;
 /**
  * What an editor's message entry records: who sent it, the operation id it was sent with, and for
  * a message sent on Live as the agent handed the request off, the draft it went to with it.
@@ -233,7 +261,19 @@ export type ThreadMessage = {
   id: string;
   from: "draft";
   ended?: DraftOutcome;
-} & StartedDraftCard);
+} & StartedDraftCard) |
+/**
+ * A member's push to the draft's code from their own checkout: who pushed, their commits'
+ * subjects, oldest first, and how the pushed head built. It's no turn: the agent doesn't
+ * answer it.
+ */
+{
+  id: string;
+  from: "push";
+  sender: ThreadSender;
+  subjects: string[];
+  outcome: PushOutcome;
+};
 /** Everything the studio shows for a thread. */
 export type ThreadView = {
   messages: readonly ThreadMessage[];
@@ -305,6 +345,10 @@ type ThreadStep = {
   type: "build";
   status: BuildStatus;
 } |
+/** A member's push, between turns. */
+({
+  type: "push";
+} & PushData) |
 /**
  * The end of the turn sent the agent back to work, after its answer: the answer wasn't the
  * turn's last, and what the agent was told is never shown.
@@ -368,8 +412,7 @@ export type ThreadServerMessage =
 };
 /**
  * The code a thread closes its sockets with once it ended with its draft, and for good: it's
- * deleted, so reconnecting reaches nothing. A development draft, which stays open, gets a new
- * thread the next time the studio connects.
+ * deleted, so reconnecting reaches nothing.
  */
 export declare const THREAD_ENDED_CLOSE_CODE = 4000;
 /** The text of a message's content: its text parts, joined. */

package/dist/threads.js

@@ -33,6 +33,18 @@ const BRIEF_ENTRY = "camox.brief";
 */
 const DRAFT_ENDED_ENTRY = "camox.draft-ended";
 /**
+* The kind of the transcript entry recording a member's push to the draft's code from their own
+* checkout (ADR 0026), with a `pushDataSchema` as data. The model reads it as context, never
+* answering it, and editors see who pushed, their commits, and whether they built.
+*/
+const PUSH_ENTRY = "camox.push";
+/** How a pushed head's build ended: built, built with type errors, or built but not previewed. */
+const pushOutcomeSchema = z.enum([
+	"built",
+	"typeErrors",
+	"notPreviewed"
+]);
+/**
 * The agent's tool on Live handing a request off to a draft it starts (ADR 0025). A run whose
 * call of it went through ends on the draft's card.
 */
@@ -53,6 +65,12 @@ const threadSenderSchema = z.object({
 });
 /** Whether `data` names a sender. */
 const isSender = (data) => threadSenderSchema.safeParse(data).success;
+/** What a push's entry records: who pushed, their commits' subjects, oldest first, and the build. */
+const pushDataSchema = z.object({
+	pusher: threadSenderSchema,
+	subjects: z.array(z.string()),
+	outcome: pushOutcomeSchema
+});
 /**
 * What an editor's message entry records: who sent it, the operation id it was sent with, and for
 * a message sent on Live as the agent handed the request off, the draft it went to with it.
@@ -134,8 +152,7 @@ const threadClientMessageSchema = z.discriminatedUnion("type", [
 ]);
 /**
 * The code a thread closes its sockets with once it ended with its draft, and for good: it's
-* deleted, so reconnecting reaches nothing. A development draft, which stays open, gets a new
-* thread the next time the studio connects.
+* deleted, so reconnecting reaches nothing.
 */
 const THREAD_ENDED_CLOSE_CODE = 4e3;
 /** The text of a message's content: its text parts, joined. */
@@ -184,6 +201,14 @@ function threadStepOf(entry) {
 		};
 	}
 	if (entry.kind === "camox.draft-ended") return void 0;
+	if (entry.kind === "camox.push") {
+		const push = pushDataSchema.safeParse(entry.data).data;
+		return push && {
+			id,
+			type: "push",
+			...push
+		};
+	}
 	const message = entry.model?.find((candidate) => candidate.role !== "system");
 	if (!message) return void 0;
 	if (message.role === "user") {
@@ -338,6 +363,15 @@ function threadViewOf({ steps, running, toolCalls = [], callingTools = false, dr
 		case "build":
 			status = step.status;
 			break;
+		case "push":
+			messages.push({
+				id: step.id,
+				from: "push",
+				sender: step.pusher,
+				subjects: step.subjects,
+				outcome: step.outcome
+			});
+			break;
 		case "tools":
 			unfinished = false;
 			break;
@@ -418,4 +452,4 @@ function reduceThreadFrame(state, frame) {
 }
 
 //#endregion
-export { BRIEF_ENTRY, BUILD_STATUS_ENTRY, DRAFT_ENDED_ENTRY, EDITOR_MESSAGE_ENTRY, EMPTY_THREAD_STATE, EMPTY_THREAD_VIEW, RECONCILE_ENTRY, RUN_STOPPED_ENTRY, START_DRAFT_TOOL, THREAD_ENDED_CLOSE_CODE, buildStatusDataSchema, buildStatusSchema, editorMessageDataSchema, isSender, reconcileDataSchema, reduceThreadEvents, reduceThreadFrame, reduceThreadState, startedDraftCardSchema, startedDraftSchema, textOf, threadClientMessageSchema, threadSenderSchema, threadViewOf, touchKindSchema, touchSchema, touchedBatchSchema };
+export { BRIEF_ENTRY, BUILD_STATUS_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, editorMessageDataSchema, 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.58.1",
+  "version": "0.59.0",
   "license": "MIT",
   "files": [
     "src",

package/src/drafts.ts

@@ -31,25 +31,10 @@ export const PUBLISHING_DRAFT_VAR = "CAMOX_PUBLISHING_DRAFT";
  */
 export const DRAFT_CREATE_HEADER = "x-camox-draft-create";
 
-/**
- * The `x-camox-draft` value naming the caller's own development draft in the project a request
- * acts on (ADR 0006, ADR 0011). Dev mode and the CLI always send it.
- */
-export const DEVELOPMENT_DRAFT = "development";
-
-/**
- * oRPC error code for a request naming the development draft before dev mode created it: the
- * first dev-mode sync after login does, so the site has to run locally once first.
- */
-export const NO_DEVELOPMENT_DRAFT_ERROR = "NO_DEVELOPMENT_DRAFT";
-
 /** URL search param carrying the current draft's id in the studio and the rendered site. */
 export const DRAFT_SEARCH_PARAM = "camox-draft";
 
-/** A regular draft is a named set of edits; a development draft backs a dev server. */
-export type DraftKind = "regular" | "development";
-
-/** How a regular draft ended. */
+/** How a draft ended. */
 export type DraftOutcome = "published" | "deleted";
 
 /** Who ended a draft, how and when, from its ended-drafts record (ADR 0009, ADR 0011). */
@@ -140,7 +125,7 @@ export const LIVE_READ_ONLY_ERROR = "LIVE_READ_ONLY";
 // for one on Live. Every procedure is listed, so a new one fails the type check until it's
 // classified and can't be forgotten. Procedures that only fill a generated value (ADR 0012),
 // like `generateSummary`, write no content. A synced block's shared content is written through
-// `blocks` and `repeatableItems`. Releases and dev-mode sync aren't listed.
+// `blocks` and `repeatableItems`. Releases aren't listed.
 const BLOCK_WRITES: Record<keyof Router["blocks"], boolean> = {
   get: false,
   getPageMarkdown: false,
@@ -223,7 +208,7 @@ const LOCALE_WRITES: Record<keyof Router["locales"], boolean> = {
   addBack: true,
 };
 
-// `definitions` is absent: its sync is a release or a dev sync, never a studio content write.
+// `definitions` is absent: its sync is a release, never a studio content write.
 const CONTENT_WRITES: Partial<Record<keyof Router, Record<string, boolean>>> = {
   blocks: BLOCK_WRITES,
   locales: LOCALE_WRITES,

package/src/projects.ts

@@ -42,8 +42,12 @@ export const projectSlugSchema = /* @__PURE__ */ z
     "Use lowercase letters, digits and hyphens, without a hyphen at either end",
   );
 
-/** The address a project's website is served at: its Project Slug's `camox.site` subdomain. */
-export const projectWebsiteUrl = (slug: string) => `https://${slug}.camox.site`;
+/**
+ * The address a project's website is served at: its Custom Domain when it has one, else its
+ * Project Slug's `camox.site` subdomain, which then redirects to it (ADR 0028).
+ */
+export const projectWebsiteUrl = (project: { slug: string; customDomain: string | null }) =>
+  `https://${project.customDomain ?? `${project.slug}.camox.site`}`;
 
 /** Why a slug can't be given to a new project. */
 export type UnavailableSlugReason = "invalid" | "reserved" | "taken";

package/src/threads.ts

@@ -45,6 +45,17 @@ export const BRIEF_ENTRY = "camox.brief";
  */
 export const DRAFT_ENDED_ENTRY = "camox.draft-ended";
 
+/**
+ * The kind of the transcript entry recording a member's push to the draft's code from their own
+ * checkout (ADR 0026), with a `pushDataSchema` as data. The model reads it as context, never
+ * answering it, and editors see who pushed, their commits, and whether they built.
+ */
+export const PUSH_ENTRY = "camox.push";
+
+/** How a pushed head's build ended: built, built with type errors, or built but not previewed. */
+export const pushOutcomeSchema = z.enum(["built", "typeErrors", "notPreviewed"]);
+export type PushOutcome = z.infer<typeof pushOutcomeSchema>;
+
 /**
  * The agent's tool on Live handing a request off to a draft it starts (ADR 0025). A run whose
  * call of it went through ends on the draft's card.
@@ -85,6 +96,14 @@ export type ThreadSender = z.infer<typeof threadSenderSchema>;
 export const isSender = (data: unknown): data is ThreadSender =>
   threadSenderSchema.safeParse(data).success;
 
+/** What a push's entry records: who pushed, their commits' subjects, oldest first, and the build. */
+export const pushDataSchema = z.object({
+  pusher: threadSenderSchema,
+  subjects: z.array(z.string()),
+  outcome: pushOutcomeSchema,
+});
+export type PushData = z.infer<typeof pushDataSchema>;
+
 /**
  * What an editor's message entry records: who sent it, the operation id it was sent with, and for
  * a message sent on Live as the agent handed the request off, the draft it went to with it.
@@ -166,7 +185,13 @@ export type ThreadMessage =
    * the draft's card, with its current name, which opens it. Once the draft ended, it has its
    * last name and how it ended, and opens nothing. The turn is finished.
    */
-  | ({ id: string; from: "draft"; ended?: DraftOutcome } & StartedDraftCard);
+  | ({ id: string; from: "draft"; ended?: DraftOutcome } & StartedDraftCard)
+  /**
+   * A member's push to the draft's code from their own checkout: who pushed, their commits'
+   * subjects, oldest first, and how the pushed head built. It's no turn: the agent doesn't
+   * answer it.
+   */
+  | { id: string; from: "push"; sender: ThreadSender; subjects: string[]; outcome: PushOutcome };
 
 /** Everything the studio shows for a thread. */
 export type ThreadView = {
@@ -226,6 +251,8 @@ type ThreadStep = { id: string } & (
   | ({ type: "draft" } & StartedDraftCard)
   /** Where the build of the turn's code stands, as the turn ends. */
   | { type: "build"; status: BuildStatus }
+  /** A member's push, between turns. */
+  | ({ type: "push" } & PushData)
   /**
    * The end of the turn sent the agent back to work, after its answer: the answer wasn't the
    * turn's last, and what the agent was told is never shown.
@@ -275,8 +302,7 @@ export type ThreadServerMessage =
 
 /**
  * The code a thread closes its sockets with once it ended with its draft, and for good: it's
- * deleted, so reconnecting reaches nothing. A development draft, which stays open, gets a new
- * thread the next time the studio connects.
+ * deleted, so reconnecting reaches nothing.
  */
 export const THREAD_ENDED_CLOSE_CODE = 4000;
 
@@ -315,6 +341,10 @@ function threadStepOf(entry: EntryRecord): ThreadStep | undefined {
   }
   // Only the model reads it: as a user message, it would otherwise read as Pi continuing a run.
   if (entry.kind === DRAFT_ENDED_ENTRY) return undefined;
+  if (entry.kind === PUSH_ENTRY) {
+    const push = pushDataSchema.safeParse(entry.data).data;
+    return push && { id, type: "push", ...push };
+  }
   const message = entry.model?.find((candidate) => candidate.role !== "system");
   if (!message) return undefined;
   if (message.role === "user") {
@@ -462,6 +492,16 @@ export function threadViewOf({
       case "build":
         status = step.status;
         break;
+      case "push":
+        // Pushes land between turns: one doesn't end a turn, nor start one.
+        messages.push({
+          id: step.id,
+          from: "push",
+          sender: step.pusher,
+          subjects: step.subjects,
+          outcome: step.outcome,
+        });
+        break;
       case "tools":
         unfinished = false;
         break;