@opencode/protocol 0.0.0-dev-19653 → 0.0.0-dev-19656

package/dist/groups/session.js

@@ -9,7 +9,7 @@ import { AbsolutePath, DateTimeUtcFromMillis, NonNegativeInt, PositiveInt, Relat
 import { Event } from "@opencode/schema/event";
 import { Context, Effect, Encoding, Result, Schema, SchemaGetter, Struct } from "effect";
 import { HttpApiEndpoint, HttpApiGroup, HttpApiMiddleware, HttpApiSchema, OpenApi } from "effect/unstable/httpapi";
-import { ConflictError, CommandExecutionError, CommandNotFoundError, InvalidCursorError, InvalidRequestError, MessageNotFoundError, ServiceUnavailableError, SessionBusyError, SessionNotFoundError, SkillNotFoundError, UnknownError, } from "../errors.js";
+import { ConflictError, CommandExecutionError, CommandNotFoundError, FormAlreadySettledError, FormInvalidAnswerError, FormNotFoundError, InvalidCursorError, InvalidRequestError, MessageNotFoundError, ServiceUnavailableError, SessionBusyError, SessionNotFoundError, SkillNotFoundError, UnknownError, } from "../errors.js";
 import { Agent } from "@opencode/schema/agent";
 import { Skill } from "@opencode/schema/skill";
 import { Model } from "@opencode/schema/model";
@@ -18,6 +18,7 @@ import { Location } from "@opencode/schema/location";
 import { SessionEvent } from "@opencode/schema/session-event";
 import { EventLog } from "@opencode/schema/event-log";
 import { FileDiff } from "@opencode/schema/file-diff";
+import { Form } from "@opencode/schema/form";
 import { PublicSessionMessage } from "./message.js";
 const ParentIDFilter = Schema.Union([
     Session.ID,
@@ -98,6 +99,12 @@ const PublicInboxInfo = Schema.Union([
     SessionInbox.Compaction,
     PublicMove,
 ]).annotate({ identifier: "Session.Inbox.Info" });
+const FormCreatePayload = Schema.Struct({
+    id: Form.ID.pipe(Schema.optional),
+    title: Form.Info.fields.title,
+    metadata: Form.Info.fields.metadata,
+    fields: Form.Info.fields.fields,
+}).annotate({ identifier: "Form.CreatePayload" });
 const BooleanFromString = Schema.Literals(["true", "false"]).pipe(Schema.decodeTo(Schema.Boolean, {
     decode: SchemaGetter.transform((value) => value === "true"),
     encode: SchemaGetter.transform((value) => (value ? "true" : "false")),
@@ -112,7 +119,7 @@ export const SessionsQuery = Schema.Struct({
     subpath: RelativePath.pipe(Schema.optional),
     cursor: SessionsQueryCursor.pipe(Schema.optional),
 }).annotate({ identifier: "SessionsQuery" });
-export const makeSessionGroup = (sessionLocationMiddleware) => HttpApiGroup.make("server.session")
+export const makeSessionGroup = (sessionLocationMiddleware, formLocationMiddleware) => HttpApiGroup.make("server.session")
     .add(HttpApiEndpoint.get("session.list", "/api/session", {
     query: SessionsQuery,
     success: Schema.Struct({
@@ -440,29 +447,21 @@ export const makeSessionGroup = (sessionLocationMiddleware) => HttpApiGroup.make
     .add(HttpApiEndpoint.delete("session.inbox.cancel", "/api/session/:sessionID/inbox/:inboxID", {
     params: { sessionID: Session.ID, inboxID: SessionMessage.ID },
     success: HttpApiSchema.NoContent,
-    error: [ConflictError, SessionNotFoundError],
+    error: SessionNotFoundError,
 }).annotateMerge(OpenApi.annotations({
     identifier: "session.inbox.cancel",
     summary: "Cancel inbox input",
-    description: "Cancel an inbox item that has not yet been delivered.",
-})))
-    .add(HttpApiEndpoint.post("session.inbox.steer", "/api/session/:sessionID/inbox/:inboxID/steer", {
-    params: { sessionID: Session.ID, inboxID: SessionMessage.ID },
-    success: HttpApiSchema.NoContent,
-    error: [ConflictError, SessionNotFoundError],
-}).annotateMerge(OpenApi.annotations({
-    identifier: "session.inbox.steer",
-    summary: "Steer queued item",
-    description: "Change a queued inbox item to steer delivery and wake session execution.",
+    description: "Cancel an inbox item that has not yet been delivered. Unavailable items are a no-op.",
 })))
-    .add(HttpApiEndpoint.post("session.inbox.queue", "/api/session/:sessionID/inbox/:inboxID/queue", {
+    .add(HttpApiEndpoint.patch("session.inbox.update", "/api/session/:sessionID/inbox/:inboxID", {
     params: { sessionID: Session.ID, inboxID: SessionMessage.ID },
+    payload: Schema.Struct({ delivery: SessionInbox.Delivery }),
     success: HttpApiSchema.NoContent,
     error: [ConflictError, SessionNotFoundError],
 }).annotateMerge(OpenApi.annotations({
-    identifier: "session.inbox.queue",
-    summary: "Queue steered item",
-    description: "Change a steered inbox item to queued delivery.",
+    identifier: "session.inbox.update",
+    summary: "Update inbox item",
+    description: "Change a pending inbox item's delivery mode. Steering wakes session execution.",
 })))
     .add(HttpApiEndpoint.get("session.instructions.entry.list", "/api/experimental/session/:sessionID/instructions/entries", {
     params: { sessionID: Session.ID },
@@ -563,13 +562,70 @@ export const makeSessionGroup = (sessionLocationMiddleware) => HttpApiGroup.make
     summary: "Get session message",
     description: "Retrieve one projected message owned by the Session.",
 })))
-    .add(HttpApiEndpoint.put("session.environment", "/api/experimental/session/:sessionID/environment", {
+    .add(HttpApiEndpoint.get("session.form.list", "/api/session/:sessionID/form", {
+    params: { sessionID: Schema.String },
+    success: Schema.Struct({ data: Schema.Array(Form.Info) }),
+    error: SessionNotFoundError,
+})
+    .middleware(formLocationMiddleware)
+    .annotateMerge(OpenApi.annotations({
+    identifier: "session.form.list",
+    summary: "List session forms",
+    description: "Retrieve pending forms for a session.",
+})))
+    .add(HttpApiEndpoint.post("session.form.create", "/api/session/:sessionID/form", {
+    params: { sessionID: Schema.String },
+    payload: FormCreatePayload,
+    success: Schema.Struct({ data: Form.Info }),
+    error: [SessionNotFoundError, ConflictError, InvalidRequestError],
+})
+    .middleware(formLocationMiddleware)
+    .annotateMerge(OpenApi.annotations({
+    identifier: "session.form.create",
+    summary: "Create session form",
+    description: "Create a form for a session.",
+})))
+    .add(HttpApiEndpoint.get("session.form.get", "/api/session/:sessionID/form/:formID", {
+    params: { sessionID: Schema.String, formID: Form.ID },
+    success: Schema.Struct({ data: Form.Detail }),
+    error: [SessionNotFoundError, FormNotFoundError],
+})
+    .middleware(formLocationMiddleware)
+    .annotateMerge(OpenApi.annotations({
+    identifier: "session.form.get",
+    summary: "Get session form",
+    description: "Retrieve a form and its current state for a session.",
+})))
+    .add(HttpApiEndpoint.post("session.form.reply", "/api/session/:sessionID/form/:formID/reply", {
+    params: { sessionID: Schema.String, formID: Form.ID },
+    payload: Form.Reply,
+    success: HttpApiSchema.NoContent,
+    error: [SessionNotFoundError, FormAlreadySettledError, FormInvalidAnswerError, FormNotFoundError],
+})
+    .middleware(formLocationMiddleware)
+    .annotateMerge(OpenApi.annotations({
+    identifier: "session.form.reply",
+    summary: "Reply to form",
+    description: "Submit an answer to a pending form.",
+})))
+    .add(HttpApiEndpoint.delete("session.form.cancel", "/api/session/:sessionID/form/:formID", {
+    params: { sessionID: Schema.String, formID: Form.ID },
+    success: HttpApiSchema.NoContent,
+    error: [SessionNotFoundError, FormAlreadySettledError, FormNotFoundError],
+})
+    .middleware(formLocationMiddleware)
+    .annotateMerge(OpenApi.annotations({
+    identifier: "session.form.cancel",
+    summary: "Cancel form",
+    description: "Cancel a pending form.",
+})))
+    .add(HttpApiEndpoint.put("session.environment", "/api/session/:sessionID/environment", {
     params: { sessionID: Session.ID },
     payload: Schema.Struct({ variables: Schema.Record(Schema.String, Schema.String) }),
     success: HttpApiSchema.NoContent,
     error: SessionNotFoundError,
 }).annotateMerge(OpenApi.annotations({
-    identifier: "experimental.session.environment",
+    identifier: "session.environment",
     summary: "Set session environment",
     description: "Replace the process environment used by local shell commands for this session.",
 })))

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package.json",
   "name": "@opencode/protocol",
-  "version": "0.0.0-dev-19653",
+  "version": "0.0.0-dev-19656",
   "type": "module",
   "license": "MIT",
   "repository": {
@@ -32,7 +32,7 @@
     "typecheck": "tsgo --noEmit"
   },
   "dependencies": {
-    "@opencode/schema": "0.0.0-dev-19653",
+    "@opencode/schema": "0.0.0-dev-19656",
     "effect": "4.0.0-rc.112"
   },
   "devDependencies": {