@harness-gw/sdk 0.5.0 → 0.5.1

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

@@ -44,7 +44,7 @@ export declare class HgwRemoteClient {
             id: string;
             name: string;
         };
-        status: "unavailable" | "ready" | "degraded";
+        status: "degraded" | "ready" | "unavailable";
         capabilities: {
             agentCatalog: {
                 status: "available";
@@ -174,8 +174,8 @@ export declare class HgwRemoteClient {
             filename?: string | undefined;
         } | {
             type: "file";
-            mimeType: string;
             filename?: string | undefined;
+            mimeType: string;
         })[];
     }>;
     readArtifact(sessionId: string, artifactId: string, signal?: AbortSignal): Promise<Blob>;
@@ -202,11 +202,27 @@ export declare class HgwRemoteClient {
         toolInput?: Record<string, unknown> | undefined;
         toolResult?: {
             [x: string]: unknown;
+            _meta?: {
+                [x: string]: unknown;
+                "io.modelcontextprotocol/serverInfo"?: {
+                    version: string;
+                    websiteUrl?: string | undefined;
+                    description?: string | undefined;
+                    icons?: {
+                        src: string;
+                        mimeType?: string | undefined;
+                        sizes?: string[] | undefined;
+                        theme?: "dark" | "light" | undefined;
+                    }[] | undefined;
+                    name: string;
+                    title?: string | undefined;
+                } | undefined;
+            } | undefined;
             content: ({
                 type: "text";
                 text: string;
                 annotations?: {
-                    audience?: ("user" | "assistant")[] | undefined;
+                    audience?: ("assistant" | "user")[] | undefined;
                     priority?: number | undefined;
                     lastModified?: string | undefined;
                 } | undefined;
@@ -216,7 +232,7 @@ export declare class HgwRemoteClient {
                 data: string;
                 mimeType: string;
                 annotations?: {
-                    audience?: ("user" | "assistant")[] | undefined;
+                    audience?: ("assistant" | "user")[] | undefined;
                     priority?: number | undefined;
                     lastModified?: string | undefined;
                 } | undefined;
@@ -226,20 +242,18 @@ export declare class HgwRemoteClient {
                 data: string;
                 mimeType: string;
                 annotations?: {
-                    audience?: ("user" | "assistant")[] | undefined;
+                    audience?: ("assistant" | "user")[] | undefined;
                     priority?: number | undefined;
                     lastModified?: string | undefined;
                 } | undefined;
                 _meta?: Record<string, unknown> | undefined;
             } | {
                 uri: string;
-                name: string;
-                type: "resource_link";
                 description?: string | undefined;
                 mimeType?: string | undefined;
                 size?: number | undefined;
                 annotations?: {
-                    audience?: ("user" | "assistant")[] | undefined;
+                    audience?: ("assistant" | "user")[] | undefined;
                     priority?: number | undefined;
                     lastModified?: string | undefined;
                 } | undefined;
@@ -250,45 +264,31 @@ export declare class HgwRemoteClient {
                     src: string;
                     mimeType?: string | undefined;
                     sizes?: string[] | undefined;
-                    theme?: "light" | "dark" | undefined;
+                    theme?: "dark" | "light" | undefined;
                 }[] | undefined;
+                name: string;
                 title?: string | undefined;
+                type: "resource_link";
             } | {
                 type: "resource";
                 resource: {
                     uri: string;
-                    text: string;
                     mimeType?: string | undefined;
                     _meta?: Record<string, unknown> | undefined;
+                    text: string;
                 } | {
                     uri: string;
-                    blob: string;
                     mimeType?: string | undefined;
                     _meta?: Record<string, unknown> | undefined;
+                    blob: string;
                 };
                 annotations?: {
-                    audience?: ("user" | "assistant")[] | undefined;
+                    audience?: ("assistant" | "user")[] | undefined;
                     priority?: number | undefined;
                     lastModified?: string | undefined;
                 } | undefined;
                 _meta?: Record<string, unknown> | undefined;
             })[];
-            _meta?: {
-                [x: string]: unknown;
-                "io.modelcontextprotocol/serverInfo"?: {
-                    version: string;
-                    name: string;
-                    websiteUrl?: string | undefined;
-                    description?: string | undefined;
-                    icons?: {
-                        src: string;
-                        mimeType?: string | undefined;
-                        sizes?: string[] | undefined;
-                        theme?: "light" | "dark" | undefined;
-                    }[] | undefined;
-                    title?: string | undefined;
-                } | undefined;
-            } | undefined;
             structuredContent?: unknown;
             isError?: boolean | undefined;
         } | undefined;
@@ -305,11 +305,27 @@ export declare class HgwRemoteClient {
     /** A tool call the App view makes, answered by the proxy's MCP server. */
     callMcpAppTool(sessionId: string, toolCallId: string, request: McpAppToolCallRequest): Promise<{
         [x: string]: unknown;
+        _meta?: {
+            [x: string]: unknown;
+            "io.modelcontextprotocol/serverInfo"?: {
+                version: string;
+                websiteUrl?: string | undefined;
+                description?: string | undefined;
+                icons?: {
+                    src: string;
+                    mimeType?: string | undefined;
+                    sizes?: string[] | undefined;
+                    theme?: "dark" | "light" | undefined;
+                }[] | undefined;
+                name: string;
+                title?: string | undefined;
+            } | undefined;
+        } | undefined;
         content: ({
             type: "text";
             text: string;
             annotations?: {
-                audience?: ("user" | "assistant")[] | undefined;
+                audience?: ("assistant" | "user")[] | undefined;
                 priority?: number | undefined;
                 lastModified?: string | undefined;
             } | undefined;
@@ -319,7 +335,7 @@ export declare class HgwRemoteClient {
             data: string;
             mimeType: string;
             annotations?: {
-                audience?: ("user" | "assistant")[] | undefined;
+                audience?: ("assistant" | "user")[] | undefined;
                 priority?: number | undefined;
                 lastModified?: string | undefined;
             } | undefined;
@@ -329,20 +345,18 @@ export declare class HgwRemoteClient {
             data: string;
             mimeType: string;
             annotations?: {
-                audience?: ("user" | "assistant")[] | undefined;
+                audience?: ("assistant" | "user")[] | undefined;
                 priority?: number | undefined;
                 lastModified?: string | undefined;
             } | undefined;
             _meta?: Record<string, unknown> | undefined;
         } | {
             uri: string;
-            name: string;
-            type: "resource_link";
             description?: string | undefined;
             mimeType?: string | undefined;
             size?: number | undefined;
             annotations?: {
-                audience?: ("user" | "assistant")[] | undefined;
+                audience?: ("assistant" | "user")[] | undefined;
                 priority?: number | undefined;
                 lastModified?: string | undefined;
             } | undefined;
@@ -353,78 +367,64 @@ export declare class HgwRemoteClient {
                 src: string;
                 mimeType?: string | undefined;
                 sizes?: string[] | undefined;
-                theme?: "light" | "dark" | undefined;
+                theme?: "dark" | "light" | undefined;
             }[] | undefined;
+            name: string;
             title?: string | undefined;
+            type: "resource_link";
         } | {
             type: "resource";
             resource: {
                 uri: string;
-                text: string;
                 mimeType?: string | undefined;
                 _meta?: Record<string, unknown> | undefined;
+                text: string;
             } | {
                 uri: string;
-                blob: string;
                 mimeType?: string | undefined;
                 _meta?: Record<string, unknown> | undefined;
+                blob: string;
             };
             annotations?: {
-                audience?: ("user" | "assistant")[] | undefined;
+                audience?: ("assistant" | "user")[] | undefined;
                 priority?: number | undefined;
                 lastModified?: string | undefined;
             } | undefined;
             _meta?: Record<string, unknown> | undefined;
         })[];
+        structuredContent?: unknown;
+        isError?: boolean | undefined;
+    }>;
+    /** A resource read the App view makes, answered by the proxy's MCP server. */
+    readMcpAppResource(sessionId: string, subject: McpAppSubject, request: McpAppResourceReadRequest): Promise<{
+        [x: string]: unknown;
         _meta?: {
             [x: string]: unknown;
             "io.modelcontextprotocol/serverInfo"?: {
                 version: string;
-                name: string;
                 websiteUrl?: string | undefined;
                 description?: string | undefined;
                 icons?: {
                     src: string;
                     mimeType?: string | undefined;
                     sizes?: string[] | undefined;
-                    theme?: "light" | "dark" | undefined;
+                    theme?: "dark" | "light" | undefined;
                 }[] | undefined;
+                name: string;
                 title?: string | undefined;
             } | undefined;
         } | undefined;
-        structuredContent?: unknown;
-        isError?: boolean | undefined;
-    }>;
-    /** A resource read the App view makes, answered by the proxy's MCP server. */
-    readMcpAppResource(sessionId: string, subject: McpAppSubject, request: McpAppResourceReadRequest): Promise<{
-        [x: string]: unknown;
         contents: ({
             uri: string;
-            text: string;
             mimeType?: string | undefined;
             _meta?: Record<string, unknown> | undefined;
+            text: string;
         } | {
             uri: string;
-            blob: string;
             mimeType?: string | undefined;
             _meta?: Record<string, unknown> | undefined;
+            blob: string;
         })[];
-        _meta?: {
-            [x: string]: unknown;
-            "io.modelcontextprotocol/serverInfo"?: {
-                version: string;
-                name: string;
-                websiteUrl?: string | undefined;
-                description?: string | undefined;
-                icons?: {
-                    src: string;
-                    mimeType?: string | undefined;
-                    sizes?: string[] | undefined;
-                    theme?: "light" | "dark" | undefined;
-                }[] | undefined;
-                title?: string | undefined;
-            } | undefined;
-        } | undefined;
     }>;
     transcribe(sessionId: string, audio: Blob, signal?: AbortSignal): Promise<string>;
     transcribeForAgent(agentId: string, audio: Blob, signal?: AbortSignal): Promise<string>;

package/dist/client/log.d.ts

@@ -20,11 +20,11 @@ type Json = Record<string, unknown>;
  * the message itself without its credentials.
  */
 export declare function frameFields(direction: "in" | "out", message: unknown): {
-    frame: Json;
-    sessionId?: string | undefined;
-    method?: string | undefined;
+    direction: "in" | "out";
     requestId?: {} | null | undefined;
-    direction: "out" | "in";
+    method?: string | undefined;
+    sessionId?: string | undefined;
+    frame: Json;
 };
 /** `stream` with one `acp.frame` debug line per message, each way. */
 export declare function loggedStream(stream: WireStream, logger: Logger): WireStream;

package/dist/protocol/acp.d.ts

@@ -118,8 +118,8 @@ export declare const HgwClientCapabilitiesMetaSchema: z.ZodObject<{
 export declare const HgwInitializeMetaSchema: z.ZodObject<{
     version: z.ZodLiteral<1>;
     role: z.ZodEnum<{
-        operator: "operator";
         guest: "guest";
+        operator: "operator";
     }>;
     extensions: z.ZodObject<{
         steer: z.ZodBoolean;
@@ -177,11 +177,11 @@ export declare const HgwSessionSearchResponseSchema: z.ZodObject<{
 export declare const HgwSessionInfoMetaSchema: z.ZodObject<{
     agentId: z.ZodString;
     status: z.ZodEnum<{
-        unknown: "unknown";
+        failed: "failed";
         idle: "idle";
         running: "running";
+        unknown: "unknown";
         "waiting-for-input": "waiting-for-input";
-        failed: "failed";
     }>;
     archived: z.ZodBoolean;
     createdAt: z.ZodOptional<z.ZodISODateTime>;
@@ -189,11 +189,11 @@ export declare const HgwSessionInfoMetaSchema: z.ZodObject<{
     pinned: z.ZodOptional<z.ZodBoolean>;
     platform: z.ZodOptional<z.ZodEnum<{
         buzz: "buzz";
-        whatsapp: "whatsapp";
+        discord: "discord";
+        email: "email";
         slack: "slack";
         telegram: "telegram";
-        email: "email";
-        discord: "discord";
+        whatsapp: "whatsapp";
     }>>;
 }, z.core.$strip>;
 export type HgwSessionInfoMeta = z.infer<typeof HgwSessionInfoMetaSchema>;
@@ -292,8 +292,8 @@ export declare const HgwSteerRequestSchema: z.ZodObject<{
 }, z.core.$strict>;
 export declare const HgwSteerResponseSchema: z.ZodObject<{
     status: z.ZodEnum<{
-        steered: "steered";
         queued: "queued";
+        steered: "steered";
     }>;
 }, z.core.$strict>;
 /**
@@ -319,27 +319,27 @@ export declare const HgwAgentsListResponseSchema: z.ZodObject<{
             description: z.ZodOptional<z.ZodString>;
             status: z.ZodOptional<z.ZodEnum<{
                 active: "active";
-                unknown: "unknown";
+                attention: "attention";
                 idle: "idle";
                 running: "running";
-                attention: "attention";
+                unknown: "unknown";
             }>>;
             activity: z.ZodOptional<z.ZodEnum<{
                 active: "active";
-                unknown: "unknown";
                 idle: "idle";
+                unknown: "unknown";
             }>>;
             visibility: z.ZodOptional<z.ZodEnum<{
-                visible: "visible";
                 hidden: "hidden";
+                visible: "visible";
             }>>;
             role: z.ZodOptional<z.ZodLiteral<"creator">>;
             avatar: z.ZodOptional<z.ZodString>;
             muted: z.ZodOptional<z.ZodLiteral<true>>;
         }, z.core.$strict>;
         visibility: z.ZodEnum<{
-            visible: "visible";
             hidden: "hidden";
+            visible: "visible";
         }>;
         selectable: z.ZodBoolean;
         editable: z.ZodBoolean;
@@ -351,8 +351,8 @@ export declare const HgwAgentsListResponseSchema: z.ZodObject<{
 /** `_hgw/agents/update` params: at least one of visibility, avatar, and muted. */
 export declare const HgwAgentUpdateRequestSchema: z.ZodObject<{
     visibility: z.ZodOptional<z.ZodEnum<{
-        visible: "visible";
         hidden: "hidden";
+        visible: "visible";
     }>>;
     avatar: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     muted: z.ZodOptional<z.ZodBoolean>;
@@ -370,27 +370,27 @@ export declare const HgwAgentUpdateResponseSchema: z.ZodObject<{
             description: z.ZodOptional<z.ZodString>;
             status: z.ZodOptional<z.ZodEnum<{
                 active: "active";
-                unknown: "unknown";
+                attention: "attention";
                 idle: "idle";
                 running: "running";
-                attention: "attention";
+                unknown: "unknown";
             }>>;
             activity: z.ZodOptional<z.ZodEnum<{
                 active: "active";
-                unknown: "unknown";
                 idle: "idle";
+                unknown: "unknown";
             }>>;
             visibility: z.ZodOptional<z.ZodEnum<{
-                visible: "visible";
                 hidden: "hidden";
+                visible: "visible";
             }>>;
             role: z.ZodOptional<z.ZodLiteral<"creator">>;
             avatar: z.ZodOptional<z.ZodString>;
             muted: z.ZodOptional<z.ZodLiteral<true>>;
         }, z.core.$strict>;
         visibility: z.ZodEnum<{
-            visible: "visible";
             hidden: "hidden";
+            visible: "visible";
         }>;
         selectable: z.ZodBoolean;
         editable: z.ZodBoolean;
@@ -427,8 +427,8 @@ export declare const HgwMessageMetaSchema: z.ZodObject<{
     opensTurn: z.ZodLiteral<true>;
     notice: z.ZodOptional<z.ZodObject<{
         severity: z.ZodEnum<{
-            info: "info";
             error: "error";
+            info: "info";
             warning: "warning";
         }>;
         title: z.ZodString;
@@ -454,10 +454,10 @@ export declare const HgwSubagentSchema: z.ZodObject<{
     model: z.ZodOptional<z.ZodString>;
     depth: z.ZodOptional<z.ZodNumber>;
     status: z.ZodOptional<z.ZodEnum<{
-        running: "running";
-        failed: "failed";
         cancelled: "cancelled";
         completed: "completed";
+        failed: "failed";
+        running: "running";
     }>>;
     tokens: z.ZodOptional<z.ZodNumber>;
     filesRead: z.ZodOptional<z.ZodArray<z.ZodString>>;
@@ -469,6 +469,8 @@ export declare const HgwSubagentSchema: z.ZodObject<{
 export type HgwSubagent = z.infer<typeof HgwSubagentSchema>;
 /** `state_update._meta.hgw` */
 export declare const HgwStateMetaSchema: z.ZodObject<{
+    sequence: z.ZodNumber;
+    turnId: z.ZodString;
     at: z.ZodOptional<z.ZodISODateTime>;
     execution: z.ZodOptional<z.ZodLiteral<"stopping">>;
     code: z.ZodOptional<z.ZodString>;
@@ -479,18 +481,20 @@ export declare const HgwStateMetaSchema: z.ZodObject<{
         amount: z.ZodNumber;
         currency: z.ZodString;
     }, z.core.$strip>>;
-    sequence: z.ZodNumber;
-    turnId: z.ZodString;
 }, z.core.$strip>;
 /** `agent_message_chunk` / `agent_thought_chunk` `_meta.hgw` */
 export declare const HgwChunkMetaSchema: z.ZodObject<{
-    subagentId: z.ZodOptional<z.ZodString>;
-    parentToolCallId: z.ZodOptional<z.ZodString>;
     sequence: z.ZodNumber;
     turnId: z.ZodString;
+    subagentId: z.ZodOptional<z.ZodString>;
+    parentToolCallId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 /** `tool_call_update` / `tool_call_content_chunk` `_meta.hgw` */
 export declare const HgwToolCallMetaSchema: z.ZodObject<{
+    sequence: z.ZodNumber;
+    turnId: z.ZodString;
+    subagentId: z.ZodOptional<z.ZodString>;
+    parentToolCallId: z.ZodOptional<z.ZodString>;
     messageId: z.ZodString;
     argsTextDelta: z.ZodOptional<z.ZodString>;
     argsText: z.ZodOptional<z.ZodString>;
@@ -503,10 +507,10 @@ export declare const HgwToolCallMetaSchema: z.ZodObject<{
         model: z.ZodOptional<z.ZodString>;
         depth: z.ZodOptional<z.ZodNumber>;
         status: z.ZodOptional<z.ZodEnum<{
-            running: "running";
-            failed: "failed";
             cancelled: "cancelled";
             completed: "completed";
+            failed: "failed";
+            running: "running";
         }>>;
         tokens: z.ZodOptional<z.ZodNumber>;
         filesRead: z.ZodOptional<z.ZodArray<z.ZodString>>;
@@ -516,10 +520,6 @@ export declare const HgwToolCallMetaSchema: z.ZodObject<{
         summary: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>>;
     app: z.ZodOptional<z.ZodObject<{}, z.core.$strict>>;
-    subagentId: z.ZodOptional<z.ZodString>;
-    parentToolCallId: z.ZodOptional<z.ZodString>;
-    sequence: z.ZodNumber;
-    turnId: z.ZodString;
 }, z.core.$strip>;
 /** `plan_update._meta.hgw`: the lossless Session Todos. */
 export declare const HgwPlanMetaSchema: z.ZodObject<{
@@ -530,9 +530,9 @@ export declare const HgwPlanMetaSchema: z.ZodObject<{
         label: z.ZodString;
         status: z.ZodEnum<{
             active: "active";
+            completed: "completed";
             failed: "failed";
             pending: "pending";
-            completed: "completed";
         }>;
     }, z.core.$strict>>;
 }, z.core.$strip>;
@@ -545,9 +545,9 @@ export declare const HgwPlanMetaSchema: z.ZodObject<{
  */
 export declare const HgwUsageMetaSchema: z.ZodObject<{
     source: z.ZodEnum<{
+        "local-estimate": "local-estimate";
         "provider-usage": "provider-usage";
         "provider-usage-plus-estimate": "provider-usage-plus-estimate";
-        "local-estimate": "local-estimate";
     }>;
     estimated: z.ZodOptional<z.ZodLiteral<true>>;
     breakdown: z.ZodOptional<z.ZodObject<{
@@ -647,9 +647,9 @@ export declare const HgwAvailableCommandsMetaSchema: z.ZodObject<{
                 scope: z.ZodLiteral<"turn">;
                 answerModes: z.ZodTuple<[z.ZodLiteral<"single">, z.ZodLiteral<"multiple">, z.ZodLiteral<"free-text">], null>;
                 cancellation: z.ZodEnum<{
+                    "native-cancel": "native-cancel";
                     "native-empty-answer": "native-empty-answer";
                     "native-reject": "native-reject";
-                    "native-cancel": "native-cancel";
                 }>;
                 maxQuestions: z.ZodNumber;
                 maxChoicesPerQuestion: z.ZodNumber;
@@ -774,8 +774,8 @@ export declare const HgwArtifactDescriptorSchema: z.ZodObject<{
     source: z.ZodDiscriminatedUnion<[z.ZodObject<{
         type: z.ZodLiteral<"inline">;
         encoding: z.ZodEnum<{
-            utf8: "utf8";
             base64: "base64";
+            utf8: "utf8";
         }>;
         data: z.ZodString;
     }, z.core.$strict>, z.ZodObject<{
@@ -820,42 +820,42 @@ export declare const HGW_REQUEST_TEXT_MAX = 200;
  * session list, and those items are marked `replayed`.
  */
 export declare const HgwActivityNotificationSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    agentId: z.ZodString;
+    sessionId: z.ZodString;
+    occurredAt: z.ZodISODateTime;
+    replayed: z.ZodOptional<z.ZodLiteral<true>>;
     type: z.ZodEnum<{
-        "turn-started": "turn-started";
-        "turn-finished": "turn-finished";
         "turn-failed": "turn-failed";
+        "turn-finished": "turn-finished";
+        "turn-started": "turn-started";
     }>;
     turnId: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
     agentId: z.ZodString;
     sessionId: z.ZodString;
     occurredAt: z.ZodISODateTime;
     replayed: z.ZodOptional<z.ZodLiteral<true>>;
-}, z.core.$strip>, z.ZodObject<{
     type: z.ZodLiteral<"attention-requested">;
     requestId: z.ZodString;
     attentionKind: z.ZodEnum<{
-        question: "question";
         permission: "permission";
+        question: "question";
     }>;
     requestText: z.ZodOptional<z.ZodString>;
     requestMore: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>, z.ZodObject<{
     agentId: z.ZodString;
     sessionId: z.ZodString;
     occurredAt: z.ZodISODateTime;
     replayed: z.ZodOptional<z.ZodLiteral<true>>;
-}, z.core.$strip>, z.ZodObject<{
     type: z.ZodLiteral<"attention-resolved">;
     requestId: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
     agentId: z.ZodString;
     sessionId: z.ZodString;
     occurredAt: z.ZodISODateTime;
     replayed: z.ZodOptional<z.ZodLiteral<true>>;
-}, z.core.$strip>, z.ZodObject<{
     type: z.ZodLiteral<"unread-changed">;
     unread: z.ZodBoolean;
-    agentId: z.ZodString;
-    sessionId: z.ZodString;
-    occurredAt: z.ZodISODateTime;
-    replayed: z.ZodOptional<z.ZodLiteral<true>>;
 }, z.core.$strip>], "type">;
 export type HgwActivityNotification = z.infer<typeof HgwActivityNotificationSchema>;