@opencode-ai/protocol 0.0.0-next-14722 → 0.0.0-next-14730

package/dist/groups/form.js

@@ -0,0 +1,110 @@
+import { Form } from "@opencode-ai/schema/form";
+import { Location } from "@opencode-ai/schema/location";
+import { Context, Schema } from "effect";
+import { HttpApiEndpoint, HttpApiGroup, HttpApiMiddleware, HttpApiSchema, OpenApi } from "effect/unstable/httpapi";
+import { ConflictError, FormAlreadySettledError, FormInvalidAnswerError, FormNotFoundError, InvalidRequestError } from "../errors.js";
+import { LocationQuery, locationQueryOpenApi } from "./location.js";
+const CreatePayload = Schema.Struct({
+    id: Form.ID.pipe(Schema.optional),
+    title: Form.FormInfo.fields.title,
+    metadata: Form.FormInfo.fields.metadata,
+    mode: Schema.Literals(["form", "url"]),
+    fields: Form.FormInfo.fields.fields.pipe(Schema.optional),
+    url: Form.UrlInfo.fields.url.pipe(Schema.optional),
+}).annotate({ identifier: "Form.CreatePayload" });
+// Form routes intentionally look session-scoped, but use a form-specific middleware instead of
+// SessionLocationMiddleware. The middleware treats real session IDs normally and has an
+// undocumented `global` sentinel branch for MCP elicitation forms that are still Location-scoped
+// but not session-owned. This is temporary and should disappear once elicitations are attributable.
+export const makeFormGroup = (locationMiddleware, formLocationMiddleware) => HttpApiGroup.make("server.form")
+    .add(HttpApiEndpoint.get("form.request.list", "/api/form/request", {
+    query: LocationQuery,
+    success: Location.response(Schema.Array(Form.Info)),
+})
+    .annotateMerge(locationQueryOpenApi)
+    .annotateMerge(OpenApi.annotations({
+    identifier: "v2.form.request.list",
+    summary: "List pending form requests",
+    description: "Retrieve pending forms for a location.",
+})))
+    .middleware(locationMiddleware)
+    .add(HttpApiEndpoint.get("session.form.list", "/api/session/:sessionID/form", {
+    params: { sessionID: Schema.String },
+    query: LocationQuery,
+    success: Location.response(Schema.Array(Form.Info)),
+})
+    .annotateMerge(locationQueryOpenApi)
+    .annotateMerge(OpenApi.annotations({
+    identifier: "v2.session.form.list",
+    summary: "List session forms",
+    description: "Retrieve pending forms for a session.",
+}))
+    .middleware(formLocationMiddleware))
+    .add(HttpApiEndpoint.post("session.form.create", "/api/session/:sessionID/form", {
+    params: { sessionID: Schema.String },
+    query: LocationQuery,
+    payload: CreatePayload,
+    success: Location.response(Form.Info),
+    error: [ConflictError, InvalidRequestError],
+})
+    .annotateMerge(locationQueryOpenApi)
+    .annotateMerge(OpenApi.annotations({
+    identifier: "v2.session.form.create",
+    summary: "Create session form",
+    description: "Create a form for a session.",
+}))
+    .middleware(formLocationMiddleware))
+    .add(HttpApiEndpoint.get("session.form.get", "/api/session/:sessionID/form/:formID", {
+    params: { sessionID: Schema.String, formID: Form.ID },
+    query: LocationQuery,
+    success: Location.response(Form.Info),
+    error: FormNotFoundError,
+})
+    .annotateMerge(locationQueryOpenApi)
+    .annotateMerge(OpenApi.annotations({
+    identifier: "v2.session.form.get",
+    summary: "Get session form",
+    description: "Retrieve a form for a session.",
+}))
+    .middleware(formLocationMiddleware))
+    .add(HttpApiEndpoint.get("session.form.state", "/api/session/:sessionID/form/:formID/state", {
+    params: { sessionID: Schema.String, formID: Form.ID },
+    query: LocationQuery,
+    success: Location.response(Form.State),
+    error: FormNotFoundError,
+})
+    .annotateMerge(locationQueryOpenApi)
+    .annotateMerge(OpenApi.annotations({
+    identifier: "v2.session.form.state",
+    summary: "Get form state",
+    description: "Retrieve the current state for a form.",
+}))
+    .middleware(formLocationMiddleware))
+    .add(HttpApiEndpoint.post("session.form.reply", "/api/session/:sessionID/form/:formID/reply", {
+    params: { sessionID: Schema.String, formID: Form.ID },
+    query: LocationQuery,
+    payload: Form.Reply,
+    success: HttpApiSchema.NoContent,
+    error: [FormAlreadySettledError, FormInvalidAnswerError, FormNotFoundError],
+})
+    .annotateMerge(locationQueryOpenApi)
+    .annotateMerge(OpenApi.annotations({
+    identifier: "v2.session.form.reply",
+    summary: "Reply to form",
+    description: "Submit an answer to a pending form.",
+}))
+    .middleware(formLocationMiddleware))
+    .add(HttpApiEndpoint.post("session.form.cancel", "/api/session/:sessionID/form/:formID/cancel", {
+    params: { sessionID: Schema.String, formID: Form.ID },
+    query: LocationQuery,
+    success: HttpApiSchema.NoContent,
+    error: [FormAlreadySettledError, FormNotFoundError],
+})
+    .annotateMerge(locationQueryOpenApi)
+    .annotateMerge(OpenApi.annotations({
+    identifier: "v2.session.form.cancel",
+    summary: "Cancel form",
+    description: "Cancel a pending form.",
+}))
+    .middleware(formLocationMiddleware))
+    .annotateMerge(OpenApi.annotations({ title: "forms", description: "Session form routes." }));

package/dist/groups/message.d.ts

@@ -402,6 +402,7 @@ export declare const MessageGroup: HttpApiGroup.HttpApiGroup<"server.message", H
         readonly summary: Schema.String;
         readonly recent: Schema.String;
     }>]>>;
+    readonly watermark: Schema.decodeTo<Schema.optional<Schema.toType<Schema.brand<Schema.Int, "Event.Seq">>>, Schema.optionalKey<Schema.brand<Schema.Int, "Event.Seq">>, never, never>;
     readonly cursor: Schema.Struct<{
         readonly previous: Schema.optional<Schema.String>;
         readonly next: Schema.optional<Schema.String>;

package/dist/groups/message.js

@@ -1,5 +1,7 @@
 import { Session } from "@opencode-ai/schema/session";
 import { SessionMessage } from "@opencode-ai/schema/session-message";
+import { optional } from "@opencode-ai/schema/schema";
+import { Event } from "@opencode-ai/schema/event";
 import { Schema } from "effect";
 import { HttpApiEndpoint, HttpApiGroup, OpenApi } from "effect/unstable/httpapi";
 import { InvalidCursorError, SessionNotFoundError, UnknownError } from "../errors.js";
@@ -20,6 +22,9 @@ export const MessageGroup = HttpApiGroup.make("server.message")
     query: SessionMessagesQuery,
     success: Schema.Struct({
         data: Schema.Array(SessionMessage.Message),
+        watermark: optional(Event.Seq).annotate({
+            description: "Durable log seq this snapshot was computed at, read before the snapshot. Attach a live log read after the watermark to compose fetch and stream gap-free; events between the watermark and the snapshot read may be redelivered by the tail and are safe to re-apply. Absent when the session has no durable events.",
+        }),
         cursor: Schema.Struct({
             previous: Schema.String.pipe(Schema.optional),
             next: Schema.String.pipe(Schema.optional),