@harness-gw/sdk 0.7.0 → 0.8.0

package/README.md

@@ -63,7 +63,7 @@ You need a running harness. Hermes is the primary one; see
    docker run --rm \
      -v "$PWD/config.yaml:/run/harness-gw/config.yaml:ro" \
      -v "$PWD/hermes-token:/run/secrets/hermes-token:ro" \
-     ghcr.io/almogbaku/harness-gw:0.7.0 \
+     ghcr.io/almogbaku/harness-gw:0.8.0 \
      config check --config /run/harness-gw/config.yaml
    ```
 
@@ -73,7 +73,7 @@ You need a running harness. Hermes is the primary one; see
    docker run --rm -p 127.0.0.1:4100:4100 \
      -v "$PWD/config.yaml:/run/harness-gw/config.yaml:ro" \
      -v "$PWD/hermes-token:/run/secrets/hermes-token:ro" \
-     ghcr.io/almogbaku/harness-gw:0.7.0 \
+     ghcr.io/almogbaku/harness-gw:0.8.0 \
      serve --config /run/harness-gw/config.yaml
    ```
 

package/dist/client/acp-approvals.d.ts

@@ -21,7 +21,7 @@ export type AcpApprovalOption = {
 };
 export type AcpApproval = {
     readonly id: string;
-    /** The tool call the request guards, when the proxy knows it. */
+    /** The tool call the request guards, when the gateway knows it. */
     readonly toolCallId?: string;
     /** The operation asked for, which is the request's title. */
     readonly action: string;

package/dist/client/acp-workspace-client-sessions.d.ts

@@ -43,8 +43,11 @@ export declare function createAcpSessionStore({ connection, now, onTurnFinished,
     answer(sessionIds: readonly string[]): void;
     /** The provider's title, as a list page or a subscribed Session reports it. */
     setTitle: (sessionId: string, title: string) => Map<string, string>;
-    /** The proxy's read state, or the operator's own optimistic ack. */
-    setUnread: (sessionId: string, unread: boolean) => void;
+    /**
+     * The gateway's read state, or the operator's own optimistic write;
+     * `undefined` restores a refused one.
+     */
+    setUnread: (sessionId: string, unread: boolean | undefined) => void;
     /** The operator's own optimistic pin; `undefined` restores a refused one. */
     setPinned: (sessionId: string, pinned: boolean | undefined) => void;
     setStatus: (sessionId: string, status: SessionStatus) => void;

package/dist/client/acp-workspace-client.d.ts

@@ -109,6 +109,8 @@ export declare function createAcpWorkspaceClient({ connection, rest, agentIdFor,
     markSessionRead(sessionId: string): Promise<void>;
     /** The row leads the write, so a refused pin has to be taken back. */
     setSessionPinned(sessionId: string, pinned: boolean): Promise<void>;
+    /** As a pin does, the row leads the write and a refusal takes it back. */
+    markSessionUnread(sessionId: string): Promise<void>;
     /**
      * The runtime's own report, read once. A failed read is not an answer, so
      * it is not remembered.

package/dist/client/connection.d.ts

@@ -48,7 +48,7 @@ export type AcpConnectionOptions = {
     url?: never;
     socketConstructor?: never;
 });
-/** Whether the proxy refused an invitation it cannot redeem. */
+/** Whether the gateway refused an invitation it cannot redeem. */
 export declare function isAuthenticationRequired(error: unknown): boolean;
 /** One of the gateway's ACP listener paths as a WebSocket URL from `base`. */
 export declare function acpSocketUrl(path: string, base: string): string;

package/dist/client/hgw-client.d.ts

@@ -6,7 +6,7 @@ import type { StagedAttachment } from "./workspace.js";
 export type HgwWorkspaceCapabilities = z.infer<typeof SessionWorkspaceCapabilitiesResponseSchema>;
 export type HgwModelChoices = z.infer<typeof SessionModelsResponseSchema>;
 export type HgwContext = z.infer<typeof SessionContextResponseSchema>;
-export type HgwClientFailure = "connection-interrupted" | "provider-unavailable" | "proxy-failure"
+export type HgwClientFailure = "connection-interrupted" | "provider-unavailable" | "gateway-failure"
 /** The provider no longer holds the bytes a published receipt points at. */
  | "artifact-missing";
 /** What an MCP App view is opened for: a tool call, or a published Artifact. */
@@ -18,10 +18,10 @@ export type McpAppSubject = {
 export declare class HgwClientError extends Error {
     readonly kind: HgwClientFailure;
     readonly code?: string | undefined;
-    /** The proxy's HTTP status, when it answered. */
+    /** The gateway's HTTP status, when it answered. */
     readonly status?: number | undefined;
     constructor(kind: HgwClientFailure, message?: string, code?: string | undefined, 
-    /** The proxy's HTTP status, when it answered. */
+    /** The gateway's HTTP status, when it answered. */
     status?: number | undefined);
 }
 /** The `fetch` the client sends every request with. */
@@ -302,7 +302,7 @@ export declare class HgwRemoteClient {
         addresses: Record<string, string>;
         expiresAt?: string | undefined;
     }>;
-    /** A tool call the App view makes, answered by the proxy's MCP server. */
+    /** A tool call the App view makes, answered by the gateway's MCP server. */
     callMcpAppTool(sessionId: string, toolCallId: string, request: McpAppToolCallRequest): Promise<{
         [x: string]: unknown;
         _meta?: {
@@ -395,7 +395,7 @@ export declare class HgwRemoteClient {
         structuredContent?: unknown;
         isError?: boolean | undefined;
     }>;
-    /** A resource read the App view makes, answered by the proxy's MCP server. */
+    /** A resource read the App view makes, answered by the gateway's MCP server. */
     readMcpAppResource(sessionId: string, subject: McpAppSubject, request: McpAppResourceReadRequest): Promise<{
         [x: string]: unknown;
         _meta?: {

package/dist/client/hgw-notification.d.ts

@@ -1,4 +1,4 @@
 import type { z } from "zod";
 import type { AcpConnection } from "./types.js";
-/** Runs `handler` for every notification of `method` the proxy sends. */
+/** Runs `handler` for every notification of `method` the gateway sends. */
 export declare function subscribeHgwNotification<Value>(connection: Pick<AcpConnection, "subscribeNotification">, method: string, schema: Pick<z.ZodType<Value>, "safeParse">, handler: (value: Value) => void): () => void;

package/dist/client/index.js

@@ -2191,12 +2191,23 @@ function createAcpWorkspaceClient({
         throw reason;
       }
     },
+    async markSessionUnread(sessionId) {
+      const [previous] = store.rowsFor([sessionId]);
+      store.setUnread(sessionId, true);
+      try {
+        await connection.updateSession({ sessionId, unread: true });
+      } catch (reason) {
+        store.setUnread(sessionId, previous?.unread);
+        throw reason;
+      }
+    },
     sessionActionCapabilities() {
       sessionActions ??= rest.runtimeInfo().then(({ capabilities }) => ({
         rename: offers(capabilities.sessionTitle),
         archive: offers(capabilities.sessionArchival),
         delete: offers(capabilities.sessionDeletion),
-        pin: offers(capabilities.sessionPin)
+        pin: offers(capabilities.sessionPin),
+        unread: offers(capabilities.sessionReadState)
       })).catch((reason) => {
         sessionActions = undefined;
         throw reason;
@@ -2470,7 +2481,7 @@ class HgwClientError extends Error {
   kind;
   code;
   status;
-  constructor(kind, message = "AOS proxy request failed", code, status) {
+  constructor(kind, message = "Gateway request failed", code, status) {
     super(message);
     this.kind = kind;
     this.code = code;
@@ -2504,7 +2515,7 @@ class HgwRemoteClient {
     this.#authorization = options.authorization;
     this.#origin = options.origin;
   }
-  async#read(path, schema, init, notFound = "proxy-failure") {
+  async#read(path, schema, init, notFound = "gateway-failure") {
     let response;
     try {
       const headers = new Headers(init?.headers);
@@ -2521,17 +2532,17 @@ class HgwRemoteClient {
     }
     if (!response.ok) {
       const error = await normalizedError(response);
-      throw new HgwClientError(response.status === 503 ? "provider-unavailable" : response.status === 404 ? notFound : "proxy-failure", error?.description, error?.code, response.status);
+      throw new HgwClientError(response.status === 503 ? "provider-unavailable" : response.status === 404 ? notFound : "gateway-failure", error?.description, error?.code, response.status);
     }
     let payload;
     try {
       payload = await response.json();
     } catch {
-      throw new HgwClientError("proxy-failure", "Invalid AOS proxy response");
+      throw new HgwClientError("gateway-failure", "Invalid gateway response");
     }
     const parsed = schema.safeParse(payload);
     if (!parsed.success)
-      throw new HgwClientError("proxy-failure", "Invalid AOS proxy response");
+      throw new HgwClientError("gateway-failure", "Invalid gateway response");
     return parsed.data;
   }
   runtimeInfo(signal) {
@@ -2546,7 +2557,7 @@ class HgwRemoteClient {
   async deletePushSubscription(endpoint) {
     const request = PushUnregistrationSchema2.safeParse({ endpoint });
     if (!request.success || !endpoint.trim())
-      throw new HgwClientError("proxy-failure", "Invalid push subscription");
+      throw new HgwClientError("gateway-failure", "Invalid push subscription");
     await this.#write("/push/subscriptions", "DELETE", request.data);
   }
   adoptSessionOwnership(sessionId, agentId) {
@@ -2567,7 +2578,7 @@ class HgwRemoteClient {
       })
     });
     if (!request.success)
-      throw new HgwClientError("proxy-failure", "Invalid attachment staging request");
+      throw new HgwClientError("gateway-failure", "Invalid attachment staging request");
     return this.#read(this.#sessionPath(sessionId, "/attachments/stage"), SessionAttachmentStageResponseSchema2, {
       method: "POST",
       headers: { "content-type": "application/json" },
@@ -2576,11 +2587,11 @@ class HgwRemoteClient {
   }
   async readArtifact(sessionId, artifactId, signal) {
     if (!artifactId.trim() || artifactId.length > 512)
-      throw new HgwClientError("proxy-failure", "Invalid artifact reference");
+      throw new HgwClientError("gateway-failure", "Invalid artifact reference");
     return this.#readBlob(this.#sessionPath(sessionId, `/artifacts/${encodeURIComponent(artifactId)}`), { signal }, "artifact-missing");
   }
   async openMcpApp(sessionId, subject, signal) {
-    const view = await this.#read(this.#mcpAppPath(sessionId, subject), McpAppViewSchema2, { signal }, "artifactId" in subject ? "artifact-missing" : "proxy-failure");
+    const view = await this.#read(this.#mcpAppPath(sessionId, subject), McpAppViewSchema2, { signal }, "artifactId" in subject ? "artifact-missing" : "gateway-failure");
     return view.files ? { ...view, files: this.#absoluteFiles(view.files) } : view;
   }
   async renewMcpAppFiles(sessionId, subject) {
@@ -2607,13 +2618,13 @@ class HgwRemoteClient {
   }
   async transcribeForAgent(agentId, audio, signal) {
     if (!audio.size || !audio.type)
-      throw new HgwClientError("proxy-failure", "Invalid audio recording");
+      throw new HgwClientError("gateway-failure", "Invalid audio recording");
     const request = SessionTranscriptionRequestSchema2.safeParse({
       dataUrl: await dataUrl(audio),
       mimeType: audio.type
     });
     if (!request.success)
-      throw new HgwClientError("proxy-failure", "Invalid audio recording");
+      throw new HgwClientError("gateway-failure", "Invalid audio recording");
     const path = `/agents/${encodeURIComponent(agentId)}/audio/transcribe`;
     const response = await this.#read(path, SessionTranscriptionResponseSchema2, {
       method: "POST",
@@ -2629,7 +2640,7 @@ class HgwRemoteClient {
   async speakForAgent(agentId, text, signal) {
     const request = SessionSpeechRequestSchema2.safeParse({ text });
     if (!request.success)
-      throw new HgwClientError("proxy-failure", "Invalid speech input");
+      throw new HgwClientError("gateway-failure", "Invalid speech input");
     const path = `/agents/${encodeURIComponent(agentId)}/audio/speak`;
     return this.#readBlob(path, {
       method: "POST",
@@ -2655,18 +2666,18 @@ class HgwRemoteClient {
     }
     if (!response.ok) {
       const error = await normalizedError(response);
-      throw new HgwClientError(response.status === 503 ? "provider-unavailable" : "proxy-failure", error?.description, error?.code, response.status);
+      throw new HgwClientError(response.status === 503 ? "provider-unavailable" : "gateway-failure", error?.description, error?.code, response.status);
     }
   }
   #mcpAppPath(sessionId, subject, suffix = "") {
     const [collection, id] = "toolCallId" in subject ? ["tool-calls", subject.toolCallId] : ["artifacts", subject.artifactId];
     if (!id.trim() || id.length > 512)
-      throw new HgwClientError("proxy-failure", "Invalid MCP App reference");
+      throw new HgwClientError("gateway-failure", "Invalid MCP App reference");
     return this.#sessionPath(sessionId, `/${collection}/${encodeURIComponent(id)}/app${suffix}`);
   }
   async#postMcpApp(sessionId, subject, suffix, request, schema) {
     if (!request.success)
-      throw new HgwClientError("proxy-failure", "Invalid MCP App request");
+      throw new HgwClientError("gateway-failure", "Invalid MCP App request");
     return this.#read(this.#mcpAppPath(sessionId, subject, suffix), schema, {
       method: "POST",
       headers: { "content-type": "application/json" },
@@ -2677,7 +2688,7 @@ class HgwRemoteClient {
     const agentId = this.#owner(sessionId);
     return `/agents/${encodeURIComponent(agentId)}/sessions/${encodeURIComponent(sessionId)}${suffix}`;
   }
-  async#readBlob(path, init, notFound = "proxy-failure") {
+  async#readBlob(path, init, notFound = "gateway-failure") {
     let response;
     try {
       const headers = new Headers(init?.headers);
@@ -2694,15 +2705,15 @@ class HgwRemoteClient {
     }
     if (!response.ok) {
       const error = await normalizedError(response);
-      throw new HgwClientError(response.status === 503 ? "provider-unavailable" : response.status === 404 ? notFound : "proxy-failure", error?.description, error?.code, response.status);
+      throw new HgwClientError(response.status === 503 ? "provider-unavailable" : response.status === 404 ? notFound : "gateway-failure", error?.description, error?.code, response.status);
     }
     const contentType = response.headers.get("content-type");
     if (!contentType || /[\r\n]/u.test(contentType))
-      throw new HgwClientError("proxy-failure", "Invalid AOS proxy response");
+      throw new HgwClientError("gateway-failure", "Invalid gateway response");
     try {
       return await response.blob();
     } catch {
-      throw new HgwClientError("proxy-failure", "Invalid AOS proxy response");
+      throw new HgwClientError("gateway-failure", "Invalid gateway response");
     }
   }
   #owner(sessionId) {

package/dist/client/limits.d.ts

@@ -33,7 +33,7 @@ export declare const STABLE_AFTER_MS = 60000;
  * neither a close nor a resume.
  */
 export declare const PART_GRACE_MS = 2000;
-/** The window a reopen waits in after the proxy closes at capacity. */
+/** The window a reopen waits in after the gateway closes at capacity. */
 export declare const CAPACITY_BACKOFF: {
     minMs: number;
     maxMs: number;

package/dist/client/types.d.ts

@@ -17,7 +17,7 @@ export type AcpPendingRequest = {
     sessionId: string;
     request: RequestPermissionRequest;
     respond(response: RequestPermissionResponse): void;
-    /** Aborts when the proxy withdraws the request, which needs no answer. */
+    /** Aborts when the gateway withdraws the request, which needs no answer. */
     signal: AbortSignal;
 } | {
     kind: "elicitation";

package/dist/client/workspace.d.ts

@@ -82,6 +82,7 @@ export type SessionActionCapabilities = {
     archive: boolean;
     delete: boolean;
     pin: boolean;
+    unread: boolean;
 };
 export type TodoStatus = "pending" | "active" | "completed" | "failed";
 export type TodoItem = {

package/dist/protocol/mcp-apps.d.ts

@@ -199,7 +199,7 @@ export declare const McpAppResourceReadRequestSchema: z.ZodObject<{
 }, z.core.$strict>;
 export type McpAppResourceReadRequest = z.infer<typeof McpAppResourceReadRequestSchema>;
 /**
- * The MCP App sandbox proxy: a static page, served beside the workspace on
+ * The MCP App sandbox gateway: a static page, served beside the workspace on
  * every listener, that holds only the relay creating the App's own frame. It
  * is a real document rather than `srcdoc` so it carries this policy instead of
  * inheriting the embedding page's, which on the guest surface forbids inline

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@harness-gw/sdk",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "A gateway that puts Hermes, OpenClaw, and OpenCode behind one ACP WebSocket, and the browser client and protocol SDK for it.",
   "license": "Apache-2.0",
   "type": "module",