@ai-sdk/harness-acp 1.0.10 → 1.0.11

package/dist/index.d.ts

@@ -164,6 +164,10 @@ type ACPInstructionMapping = {
     readonly variable: string;
     readonly path: ReadonlyArray<string>;
 };
+type ACPOutputSchemaMapping = {
+    readonly type: 'session-prompt-meta';
+    readonly path: ReadonlyArray<string>;
+};
 type ACPV1Settings = {
     readonly version?: 'v1';
     readonly harnessId: string;
@@ -189,6 +193,11 @@ type ACPV1Settings = {
      * prompt. When omitted, instructions are prepended to the first user prompt.
      */
     readonly instructionMapping?: ACPInstructionMapping;
+    /**
+     * Maps structured output JSON Schema to an implementation-specific path
+     * below the ACP session prompt's `_meta` field.
+     */
+    readonly outputSchemaMapping?: ACPOutputSchemaMapping;
     readonly permissionModeMapping?: ACPPermissionModeMapping;
     readonly session?: {
         readonly meta?: Readonly<Record<string, ACPSerializableValue>>;
@@ -231,6 +240,7 @@ type ACPHarnessSettings<TBuiltinTools extends ToolSet = {}> = {
     readonly providerAuthentication?: ACPV1Settings['providerAuthentication'];
     readonly modelId?: ACPV1Settings['modelId'];
     readonly instructionMapping?: ACPV1Settings['instructionMapping'];
+    readonly outputSchemaMapping?: ACPV1Settings['outputSchemaMapping'];
     readonly permissionModeMapping?: ACPV1Settings['permissionModeMapping'];
     readonly session?: ACPV1Settings['session'];
     readonly mintBridgeToken?: ACPV1Settings['mintBridgeToken'];
@@ -239,4 +249,4 @@ declare function createACP<TBuiltinTools extends ToolSet = {}>(settings: ACPHarn
 
 declare const VERSION: string;
 
-export { type ACPAnnotations, type ACPAudioContent, type ACPAuthOptions, type ACPAuthentication, type ACPBlobResourceContents, type ACPClientApp, type ACPContentBlock, type ACPCredentialBrokering, type ACPEmbeddedResource, type ACPHarnessSettings, type ACPImageContent, type ACPInstructionMapping, type ACPMetadata, type ACPNpmLockedSource, type ACPNpmSimpleSource, type ACPPermissionModeMapping, type ACPPermissionModeTarget, type ACPProfileValue, type ACPProviderAuthentication, type ACPProviderAuthenticationMode, type ACPResourceLink, type ACPRole, type ACPSerializablePrimitive, type ACPSerializableValue, type ACPSource, type ACPTextContent, type ACPTextResourceContents, type ACPToolCall, type ACPToolCallContent, type ACPToolCallLocation, type ACPToolCallStatus, type ACPToolKind, type ACPV1Settings, type ACPValueSource, VERSION, createACP };
+export { type ACPAnnotations, type ACPAudioContent, type ACPAuthOptions, type ACPAuthentication, type ACPBlobResourceContents, type ACPClientApp, type ACPContentBlock, type ACPCredentialBrokering, type ACPEmbeddedResource, type ACPHarnessSettings, type ACPImageContent, type ACPInstructionMapping, type ACPMetadata, type ACPNpmLockedSource, type ACPNpmSimpleSource, type ACPOutputSchemaMapping, type ACPPermissionModeMapping, type ACPPermissionModeTarget, type ACPProfileValue, type ACPProviderAuthentication, type ACPProviderAuthenticationMode, type ACPResourceLink, type ACPRole, type ACPSerializablePrimitive, type ACPSerializableValue, type ACPSource, type ACPTextContent, type ACPTextResourceContents, type ACPToolCall, type ACPToolCallContent, type ACPToolCallLocation, type ACPToolCallStatus, type ACPToolKind, type ACPV1Settings, type ACPValueSource, VERSION, createACP };

package/dist/index.js

@@ -650,6 +650,10 @@ var instructionMappingSchema = z2.discriminatedUnion("type", [
     path: instructionMappingPathSchema
   })
 ]);
+var outputSchemaMappingSchema = z2.object({
+  type: z2.literal("session-prompt-meta"),
+  path: z2.array(z2.string().min(1)).min(1)
+});
 var acpTurnStartConfigSchema = z2.object({
   version: z2.literal(1),
   configurationFingerprint: z2.string(),
@@ -658,7 +662,9 @@ var acpTurnStartConfigSchema = z2.object({
   builtinTools: z2.array(builtinToolSchema).default([]),
   permissionMode: harnessV1BridgeStartBaseSchema.shape.permissionMode.unwrap(),
   permissionModeMapping: permissionModeMappingSchema.optional(),
-  debug: harnessV1BridgeStartBaseSchema.shape.debug.optional()
+  debug: harnessV1BridgeStartBaseSchema.shape.debug.optional(),
+  responseFormat: harnessV1BridgeStartBaseSchema.shape.responseFormat.optional(),
+  outputSchemaMapping: outputSchemaMappingSchema.optional()
 });
 var acpColdSessionStateSchema = acpTurnStartConfigSchema.omit({ prompt: true, debug: true }).extend({
   modelId: z2.string().optional()
@@ -686,6 +692,7 @@ var startMessageSchema = harnessV1BridgeStartBaseSchema.extend({
   prompt: z2.array(acpTextContentBlockSchema),
   instructions: z2.string().optional(),
   instructionMapping: instructionMappingSchema.optional(),
+  outputSchemaMapping: outputSchemaMappingSchema.optional(),
   mcpServers: z2.record(z2.string(), z2.unknown()).optional(),
   tools: z2.array(acpSerializableToolSpecSchema).optional(),
   builtinTools: z2.array(builtinToolSchema).readonly().default([]),
@@ -868,7 +875,9 @@ function createACPTurnStartConfig({
   debug,
   authenticationProfile,
   sessionMeta,
-  instructionMapping
+  instructionMapping,
+  responseFormat,
+  outputSchemaMapping
 }) {
   return {
     version: 1,
@@ -877,6 +886,7 @@ function createACPTurnStartConfig({
         authenticationProfile,
         sessionMeta: sessionMeta ?? null,
         ...instructionMapping == null ? {} : { instructionMapping },
+        ...outputSchemaMapping == null ? {} : { outputSchemaMapping },
         builtinTools,
         permissionModeMapping: permissionModeMapping ?? null,
         mcpServers: mcpServers ?? null
@@ -886,6 +896,13 @@ function createACPTurnStartConfig({
     tools: tools.map((tool) => acpSerializableToolSpecSchema.parse(tool)),
     builtinTools: [...builtinTools],
     permissionMode,
+    ...responseFormat == null ? {} : { responseFormat },
+    ...outputSchemaMapping == null ? {} : {
+      outputSchemaMapping: {
+        type: outputSchemaMapping.type,
+        path: [...outputSchemaMapping.path]
+      }
+    },
     ...permissionModeMapping == null ? {} : { permissionModeMapping },
     ...debug == null ? {} : { debug }
   };
@@ -900,6 +917,8 @@ function createACPColdSessionState({
     tools: turnStartConfig.tools,
     builtinTools: turnStartConfig.builtinTools,
     permissionMode: turnStartConfig.permissionMode,
+    ...turnStartConfig.responseFormat == null ? {} : { responseFormat: turnStartConfig.responseFormat },
+    ...turnStartConfig.outputSchemaMapping == null ? {} : { outputSchemaMapping: turnStartConfig.outputSchemaMapping },
     ...turnStartConfig.permissionModeMapping == null ? {} : { permissionModeMapping: turnStartConfig.permissionModeMapping },
     ...modelId == null ? {} : { modelId }
   };
@@ -1367,6 +1386,7 @@ function createACPV1({
               modelId: settings.modelId,
               sessionMeta: settings.session?.meta,
               instructionMapping: settings.instructionMapping,
+              outputSchemaMapping: settings.outputSchemaMapping,
               debug: startOptions.observability?.debug,
               implementationIdentity,
               authenticationProfile,
@@ -1424,6 +1444,7 @@ function createACPV1({
                   authenticationProfile,
                   sessionMeta: settings.session?.meta,
                   instructionMapping: settings.instructionMapping,
+                  outputSchemaMapping: settings.outputSchemaMapping,
                   builtinTools: builtinToolCatalog,
                   permissionModeMapping,
                   mcpServers: settings.mcpServers
@@ -1454,6 +1475,7 @@ function createACPV1({
             authenticationProfile,
             sessionMeta: settings.session?.meta,
             instructionMapping: settings.instructionMapping,
+            outputSchemaMapping: settings.outputSchemaMapping,
             builtinTools: builtinToolCatalog,
             permissionModeMapping,
             mcpServers: settings.mcpServers,
@@ -1594,6 +1616,7 @@ function createACPV1({
         modelId: settings.modelId,
         sessionMeta: settings.session?.meta,
         instructionMapping: settings.instructionMapping,
+        outputSchemaMapping: settings.outputSchemaMapping,
         debug: startOptions.observability?.debug,
         implementationIdentity,
         authenticationProfile,
@@ -1778,6 +1801,7 @@ function createSession({
   modelId,
   sessionMeta,
   instructionMapping,
+  outputSchemaMapping,
   debug,
   implementationIdentity,
   authenticationProfile,
@@ -2054,6 +2078,20 @@ function createSession({
     isResume,
     ...modelId == null ? {} : { modelId },
     doPromptTurn: async (options) => {
+      if (options.responseFormat?.type === "json") {
+        if (options.responseFormat.schema == null) {
+          throw unsupported({
+            harnessId,
+            message: `${harnessId} requires a JSON schema for structured output.`
+          });
+        }
+        if (outputSchemaMapping == null) {
+          throw unsupported({
+            harnessId,
+            message: `${harnessId} does not support structured output through ACP.`
+          });
+        }
+      }
       if (replayOnly) {
         throw new Error(
           `${harnessId} recovered this turn through disk replay only and has no restored ACP process for a subsequent prompt.`
@@ -2076,7 +2114,9 @@ function createSession({
         debug,
         authenticationProfile,
         sessionMeta,
-        instructionMapping
+        instructionMapping,
+        responseFormat: options.responseFormat,
+        outputSchemaMapping
       });
       const control = wireTurn({
         emit: options.emit,
@@ -2103,6 +2143,8 @@ function createSession({
             builtinTools,
             permissionMode,
             permissionModeMapping,
+            ...options.responseFormat == null ? {} : { responseFormat: options.responseFormat },
+            ...turnStartConfig.outputSchemaMapping == null ? {} : { outputSchemaMapping: turnStartConfig.outputSchemaMapping },
             ...mcpServers == null ? {} : { mcpServers },
             tools: options.tools == null ? void 0 : turnStartConfig.tools,
             turnStartConfig
@@ -2114,6 +2156,20 @@ function createSession({
       return control;
     },
     doContinueTurn: async (options) => {
+      if (options.responseFormat?.type === "json") {
+        if (options.responseFormat.schema == null) {
+          throw unsupported({
+            harnessId,
+            message: `${harnessId} requires a JSON schema for structured output.`
+          });
+        }
+        if (outputSchemaMapping == null) {
+          throw unsupported({
+            harnessId,
+            message: `${harnessId} does not support structured output through ACP.`
+          });
+        }
+      }
       if (!turnInFlight) {
         throw new Error(`${harnessId} has no in-flight ACP turn to continue.`);
       }
@@ -2141,6 +2197,8 @@ function createSession({
             builtinTools: turnStartConfig.builtinTools,
             permissionMode: turnStartConfig.permissionMode,
             permissionModeMapping: turnStartConfig.permissionModeMapping,
+            ...turnStartConfig.responseFormat == null ? {} : { responseFormat: turnStartConfig.responseFormat },
+            ...turnStartConfig.outputSchemaMapping == null ? {} : { outputSchemaMapping: turnStartConfig.outputSchemaMapping },
             ...instructionMapping == null ? {} : {
               instructionMapping,
               ...options.instructions == null ? {} : { instructions: options.instructions }
@@ -2278,6 +2336,7 @@ function validateACPTurnStartConfig({
   authenticationProfile,
   sessionMeta,
   instructionMapping,
+  outputSchemaMapping,
   builtinTools,
   permissionModeMapping,
   mcpServers
@@ -2292,7 +2351,9 @@ function validateACPTurnStartConfig({
     debug: turnStartConfig.debug,
     authenticationProfile,
     sessionMeta,
-    instructionMapping
+    instructionMapping,
+    responseFormat: turnStartConfig.responseFormat,
+    outputSchemaMapping
   });
   if (current.configurationFingerprint !== turnStartConfig.configurationFingerprint) {
     throw new Error(
@@ -2307,6 +2368,7 @@ function validateACPColdSessionConfiguration({
   authenticationProfile,
   sessionMeta,
   instructionMapping,
+  outputSchemaMapping,
   builtinTools,
   permissionModeMapping,
   mcpServers,
@@ -2322,7 +2384,9 @@ function validateACPColdSessionConfiguration({
     debug,
     authenticationProfile,
     sessionMeta,
-    instructionMapping
+    instructionMapping,
+    responseFormat: coldSession.responseFormat,
+    outputSchemaMapping
   });
   if (current.configurationFingerprint !== coldSession.configurationFingerprint || coldSession.permissionMode !== permissionMode || coldSession.modelId !== modelId) {
     throw new Error(
@@ -2369,7 +2433,7 @@ function deserializeBridgeError({
 }
 
 // src/version.ts
-var VERSION = true ? "1.0.10" : "0.0.0-test";
+var VERSION = true ? "1.0.11" : "0.0.0-test";
 
 // src/acp-harness.ts
 var ACP_CLIENT_APP = {