@ai-sdk/harness-acp 1.0.24 → 1.0.28

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { HarnessV1RequestTransformation, HarnessV1PermissionMode, HarnessV1PortEndpoint, HarnessV1 } from '@ai-sdk/harness';
+import { HarnessV1RequestTransformation, HarnessV1CredentialForwarding, HarnessV1PermissionMode, HarnessV1PortEndpoint, HarnessV1 } from '@ai-sdk/harness';
 import { ToolSet } from '@ai-sdk/provider-utils';
 
 type ACPMetadata = Record<string, unknown>;
@@ -126,6 +126,8 @@ type ACPNpmLockedSource = {
     readonly type: 'npm-locked';
     readonly packageJson: string;
     readonly pnpmLockYaml: string;
+    /** Optional pnpm workspace configuration required by the locked install. */
+    readonly pnpmWorkspaceYaml?: string;
 };
 type ACPInstallCommandSource = {
     readonly type: 'install-command';
@@ -143,8 +145,9 @@ type ACPProviderAuthentication = {
         readonly env: Readonly<Record<string, ACPProfileValue>>;
     };
 };
-type ACPCredentialBrokering = ({ env, }: {
+type ACPCredentialBrokering = ({ env, sandboxEnv, }: {
     env: Readonly<Record<string, string>>;
+    sandboxEnv?: Readonly<Record<string, string>>;
 }) => ReadonlyArray<HarnessV1RequestTransformation>;
 type ACPPermissionModeTarget = {
     readonly type: 'session-mode';
@@ -184,6 +187,12 @@ type ACPV1Settings = {
     readonly forwardEnv?: ReadonlyArray<string>;
     readonly credentialEnv?: ReadonlyArray<string>;
     readonly credentialBrokering?: ACPCredentialBrokering;
+    /**
+     * Customizes each credential value before it is forwarded into a sandbox
+     * process. This does not restrict which credentials the harness adapter can
+     * discover, read, or otherwise access in the host process.
+     */
+    readonly credentialForwarding?: HarnessV1CredentialForwarding;
     /**
      * Runtime environment values that are safe to persist in bootstrap and
      * lifecycle compatibility identity.
@@ -244,6 +253,12 @@ type ACPHarnessSettings<TBuiltinTools extends ToolSet = {}> = {
     readonly forwardEnv?: ACPV1Settings['forwardEnv'];
     readonly credentialEnv?: ACPV1Settings['credentialEnv'];
     readonly credentialBrokering?: ACPV1Settings['credentialBrokering'];
+    /**
+     * Customizes each credential value before it is forwarded into a sandbox
+     * process. This does not restrict which credentials the harness adapter can
+     * discover, read, or otherwise access in the host process.
+     */
+    readonly credentialForwarding?: ACPV1Settings['credentialForwarding'];
     readonly env?: ACPV1Settings['env'];
     readonly authentication?: ACPV1Settings['authentication'];
     readonly providerAuthentication?: ACPV1Settings['providerAuthentication'];

package/dist/index.js

@@ -10,14 +10,15 @@ import {
 } from "@ai-sdk/harness";
 import { HarnessBridgeCapabilityUnsupportedError } from "@ai-sdk/harness/bridge";
 import {
+  applyCredentialForwarding,
   createBridgeErrorHandler,
   createBridgeStartupError,
+  createSandboxCredentialEnvironment,
   classifyDiskLog,
   drainBridgeProcessStream,
   forwardBridgeProcessStream,
   getRestrictedSandboxSession,
   markBridgeStarting,
-  maskSandboxCredentials,
   resolveSandboxDefaultWorkingDirectory,
   resolveSandboxHomeDir,
   SandboxChannel,
@@ -201,6 +202,9 @@ function validateACPV1Implementation(implementation) {
     if (source.pnpmLockYaml.length === 0) {
       throw new Error("ACP source.pnpmLockYaml must not be empty.");
     }
+    if (source.pnpmWorkspaceYaml?.length === 0) {
+      throw new Error("ACP source.pnpmWorkspaceYaml must not be empty.");
+    }
   } else if (source.type === "npm-simple") {
     validateNpmSimpleSource({ source });
   } else if (source.command.trim().length === 0) {
@@ -264,6 +268,12 @@ function getImplementationLockfile({
   const { source } = implementation;
   return source.type === "npm-locked" ? source.pnpmLockYaml : void 0;
 }
+function getImplementationWorkspaceFile({
+  implementation
+}) {
+  const { source } = implementation;
+  return source.type === "npm-locked" ? source.pnpmWorkspaceYaml : void 0;
+}
 function createImplementationDescriptor({
   implementation
 }) {
@@ -290,7 +300,8 @@ function createImplementationIdentity({
   const sourceIdentity = source.type === "npm-locked" ? {
     type: source.type,
     packageJson: source.packageJson,
-    pnpmLockYaml: source.pnpmLockYaml
+    pnpmLockYaml: source.pnpmLockYaml,
+    pnpmWorkspaceYaml: source.pnpmWorkspaceYaml
   } : source.type === "npm-simple" ? {
     type: source.type,
     packageName: source.packageName,
@@ -462,6 +473,9 @@ function createACPBootstrap({
       const implementationLock = getImplementationLockfile({
         implementation
       });
+      const implementationWorkspace = getImplementationWorkspaceFile({
+        implementation
+      });
       const implementationInstallScript = getImplementationInstallScript({
         implementation
       });
@@ -498,6 +512,12 @@ function createACPBootstrap({
               content: implementationLock
             }
           ],
+          ...implementationWorkspace == null ? [] : [
+            {
+              path: `${bootstrapDir}/implementation/pnpm-workspace.yaml`,
+              content: implementationWorkspace
+            }
+          ],
           ...implementationInstallScript == null ? [] : [
             {
               path: `${bootstrapDir}/implementation/install.sh`,
@@ -658,6 +678,8 @@ function unsupportedPromptContent({
 var builtinToolSchema = z2.object({
   toolName: z2.string(),
   nativeName: z2.string().optional(),
+  title: z2.string().optional(),
+  toolUseKind: z2.enum(["readonly", "edit", "bash"]).optional(),
   inputSchema: z2.json().optional()
 });
 var jsonValueSchema = z2.json();
@@ -1296,6 +1318,21 @@ function createACPV1({
         sandboxSession,
         abortSignal: startOptions.abortSignal
       });
+      const continueFrom = startOptions.continueFrom ?? startOptions.resumeFrom?.continueFrom;
+      const lifecycleState = continueFrom ?? startOptions.resumeFrom;
+      const isContinue = continueFrom != null;
+      const isResume = lifecycleState != null;
+      const lifecycleData = lifecycleState != null ? lifecycleState.data : void 0;
+      if (lifecycleData != null && lifecycleState != null) {
+        validateACPLifecycleCompatibility({
+          harnessId: settings.harnessId,
+          lifecycleHarnessId: lifecycleState.harnessId,
+          implementationIdentity,
+          authenticationProfile,
+          lifecycleData,
+          sandboxId
+        });
+      }
       const implementationEnvironment = resolveImplementationEnvironment({
         implementation,
         env
@@ -1303,48 +1340,69 @@ function createACPV1({
       let sandboxImplementationEnvironment = implementationEnvironment;
       let sandboxProviderAuthenticationEnvironment = resolvedProviderAuthentication.env;
       let sandboxProviderEnvironment;
+      const credentialEnvironmentVariables = [
+        .../* @__PURE__ */ new Set([
+          ...settings.credentialEnv ?? [],
+          "AI_GATEWAY_API_KEY",
+          "VERCEL_OIDC_TOKEN"
+        ])
+      ];
+      const credentialForwardingEnvironmentVariables = [
+        .../* @__PURE__ */ new Set([
+          ...credentialEnvironmentVariables,
+          ...resolveACPProviderCredentialEnvironmentVariables({
+            providerAuthentication: resolvedProviderAuthentication.providerAuthentication
+          })
+        ])
+      ];
+      let sandboxCredentialEnvironment;
       if (settings.credentialBrokering != null && "addRequestTransformations" in sandboxSession && sandboxSession.addRequestTransformations != null) {
         const providerEnvironment = resolveProviderEnvironment({
           resolvedProviderAuthentication,
           clientApp
         });
-        const credentialEnvironmentVariables = [
-          .../* @__PURE__ */ new Set([
-            ...settings.credentialEnv ?? [],
-            "AI_GATEWAY_API_KEY",
-            "VERCEL_OIDC_TOKEN"
-          ])
-        ];
+        const brokeringEnvironment = {
+          ...implementationEnvironment,
+          ...providerEnvironment
+        };
+        sandboxCredentialEnvironment = lifecycleData?.sandboxCredentialEnvironment ?? await createSandboxCredentialEnvironment({
+          environment: brokeringEnvironment,
+          credentialEnvironmentVariables: credentialForwardingEnvironmentVariables,
+          credentialForwarding: settings.credentialForwarding
+        });
+        sandboxImplementationEnvironment = {
+          ...brokeringEnvironment,
+          ...sandboxCredentialEnvironment
+        };
         const requestTransformations = settings.credentialBrokering({
-          env: {
-            ...implementationEnvironment,
-            ...providerEnvironment
-          }
+          env: brokeringEnvironment,
+          sandboxEnv: sandboxImplementationEnvironment
         });
         if (requestTransformations.length > 0) {
           await sandboxSession.addRequestTransformations(
             requestTransformations
           );
         }
-        sandboxImplementationEnvironment = maskSandboxCredentials({
-          environment: implementationEnvironment,
-          credentialEnvironmentVariables
-        });
-        sandboxProviderEnvironment = maskSandboxCredentials({
-          environment: resolveProviderEnvironment({
-            resolvedProviderAuthentication,
-            clientApp,
-            gatewayApiKey: "AI_GATEWAY_API_KEY"
-          }),
-          credentialEnvironmentVariables
+        sandboxProviderEnvironment = resolvedProviderAuthentication.providerAuthentication?.type === "ai-gateway" ? {} : void 0;
+      } else if (settings.credentialBrokering != null) {
+        warnCredentialBrokeringUnavailable();
+      }
+      if (settings.credentialForwarding != null && sandboxProviderEnvironment == null && resolvedProviderAuthentication.providerAuthentication?.type === "ai-gateway") {
+        sandboxProviderEnvironment = resolveProviderEnvironment({
+          resolvedProviderAuthentication,
+          clientApp
         });
+      }
+      if (sandboxProviderEnvironment != null) {
+        sandboxImplementationEnvironment = {
+          ...sandboxImplementationEnvironment,
+          ...sandboxProviderEnvironment
+        };
         sandboxProviderAuthenticationEnvironment = Object.fromEntries(
           Object.entries(resolvedProviderAuthentication.env).filter(
             ([key]) => key !== "AI_SDK_ACP_GATEWAY_API_KEY" && key !== "AI_SDK_ACP_GATEWAY_BASE_URL"
           )
         );
-      } else if (settings.credentialBrokering != null) {
-        warnCredentialBrokeringUnavailable();
       }
       const resolvedBridgeDir = posix.resolve(
         defaultWorkingDirectory,
@@ -1363,21 +1421,6 @@ function createACPV1({
         sessionId: startOptions.sessionId
       });
       const bridgeStateDir = `${privateSessionDir}/bridge`;
-      const continueFrom = startOptions.continueFrom ?? startOptions.resumeFrom?.continueFrom;
-      const lifecycleState = continueFrom ?? startOptions.resumeFrom;
-      const isContinue = continueFrom != null;
-      const isResume = lifecycleState != null;
-      const lifecycleData = lifecycleState != null ? lifecycleState.data : void 0;
-      if (lifecycleData != null && lifecycleState != null) {
-        validateACPLifecycleCompatibility({
-          harnessId: settings.harnessId,
-          lifecycleHarnessId: lifecycleState.harnessId,
-          implementationIdentity,
-          authenticationProfile,
-          lifecycleData,
-          sandboxId
-        });
-      }
       const skills = startOptions.skills ?? [];
       const skillsFingerprint = createACPSkillsFingerprint({ skills });
       const shouldMaterializeSkills = shouldMaterializeACPSkills({
@@ -1475,6 +1518,7 @@ function createACPV1({
               turnStartConfig: lifecycleData.turnStartConfig,
               recoveryStatus: lifecycleData.recovery,
               restoration: lifecycleData.restoration,
+              sandboxCredentialEnvironment,
               replayOnly: false,
               lossyRerun: false
             });
@@ -1552,6 +1596,11 @@ function createACPV1({
           };
         }
       }
+      const forwardedImplementationEnvironment = sandboxCredentialEnvironment == null ? await applyCredentialForwarding({
+        environment: sandboxImplementationEnvironment,
+        credentialEnvironmentVariables: credentialForwardingEnvironmentVariables,
+        credentialForwarding: settings.credentialForwarding
+      }) : sandboxImplementationEnvironment;
       const port = resolveBridgePort({
         sandboxSession,
         override: portOverride,
@@ -1571,11 +1620,11 @@ function createACPV1({
       const proc = await toolSafeSandboxSession.spawn({
         command: `node ${shellQuote(`${resolvedBridgeDir}/bridge.mjs`)} --workdir ${shellQuote(workDir)} --bridge-state-dir ${shellQuote(bridgeStateDir)} --implementation-dir ${shellQuote(resolvedImplementationDir)} --bridge-type ${shellQuote(settings.harnessId)}`,
         env: {
-          ...sandboxImplementationEnvironment,
+          ...forwardedImplementationEnvironment,
           ...createACPBridgeEnvironment({
             authentication: settings.authentication,
             providerAuthentication: resolvedProviderAuthentication.providerAuthentication,
-            providerEnvironment: sandboxProviderEnvironment,
+            providerEnvironment: sandboxProviderEnvironment == null ? void 0 : {},
             sessionMeta: settings.session?.meta
           }),
           ...sandboxProviderAuthenticationEnvironment,
@@ -1710,6 +1759,7 @@ function createACPV1({
           reason: respawnStrategy.reason
         } : void 0,
         restoration: coldRestoration == null ? lifecycleData?.restoration : { method: coldRestoration },
+        sandboxCredentialEnvironment,
         replayOnly: respawnStrategy?.mode === "disk-replay",
         lossyRerun: respawnStrategy?.mode === "lossy-rerun"
       });
@@ -1718,8 +1768,7 @@ function createACPV1({
 }
 function resolveProviderEnvironment({
   resolvedProviderAuthentication,
-  clientApp,
-  gatewayApiKey
+  clientApp
 }) {
   if (resolvedProviderAuthentication.providerAuthentication?.type !== "ai-gateway") {
     return {};
@@ -1727,7 +1776,7 @@ function resolveProviderEnvironment({
   return resolveACPLaunchEnvironment({
     providerAuthentication: resolvedProviderAuthentication.providerAuthentication,
     gateway: {
-      apiKey: gatewayApiKey ?? requireResolvedEnvironmentValue({
+      apiKey: requireResolvedEnvironmentValue({
         environment: resolvedProviderAuthentication.env,
         name: "AI_SDK_ACP_GATEWAY_API_KEY"
       }),
@@ -1740,6 +1789,26 @@ function resolveProviderEnvironment({
     }
   });
 }
+function resolveACPProviderCredentialEnvironmentVariables({
+  providerAuthentication
+}) {
+  if (providerAuthentication?.type !== "ai-gateway") return [];
+  return Object.entries(providerAuthentication.env).filter(([, value]) => containsACPProviderCredential({ value })).map(([name]) => name);
+}
+function containsACPProviderCredential({
+  value
+}) {
+  if (Array.isArray(value)) {
+    return value.some((item) => containsACPProviderCredential({ value: item }));
+  }
+  if (value == null || typeof value !== "object") return false;
+  if ("$source" in value) {
+    return value.$source === "gateway-api-key" || value.$source === "gateway-authorization";
+  }
+  return Object.values(value).some(
+    (item) => containsACPProviderCredential({ value: item })
+  );
+}
 function requireResolvedEnvironmentValue({
   environment,
   name
@@ -1926,6 +1995,7 @@ function createSession({
   turnStartConfig: turnStartConfigAtStart,
   recoveryStatus,
   restoration,
+  sandboxCredentialEnvironment,
   replayOnly,
   lossyRerun
 }) {
@@ -2161,6 +2231,7 @@ function createSession({
   }) => ({
     implementationIdentity,
     authenticationProfile,
+    ...sandboxCredentialEnvironment == null ? {} : { sandboxCredentialEnvironment },
     ...latestACPSessionId == null ? {} : { acpSessionId: latestACPSessionId },
     ...bridge == null ? {} : { bridge },
     ...latestTurnStartConfig == null ? {} : {
@@ -2418,6 +2489,8 @@ function serializeBuiltinTools({
 }) {
   return Object.entries(builtinTools).map(([toolName, tool]) => {
     const nativeName = tool != null && typeof tool === "object" && "nativeName" in tool && typeof tool.nativeName === "string" ? tool.nativeName : void 0;
+    const title = tool != null && typeof tool === "object" && "title" in tool && typeof tool.title === "string" ? tool.title : void 0;
+    const toolUseKind = tool != null && typeof tool === "object" && "toolUseKind" in tool && (tool.toolUseKind === "readonly" || tool.toolUseKind === "edit" || tool.toolUseKind === "bash") ? tool.toolUseKind : void 0;
     let inputSchema;
     if (tool != null && typeof tool === "object" && "inputSchema" in tool && tool.inputSchema != null) {
       try {
@@ -2430,6 +2503,8 @@ function serializeBuiltinTools({
     return {
       toolName,
       ...nativeName == null ? {} : { nativeName },
+      ...title == null ? {} : { title },
+      ...toolUseKind == null ? {} : { toolUseKind },
       ...inputSchema == null ? {} : { inputSchema }
     };
   });
@@ -2536,7 +2611,7 @@ function deserializeBridgeError({
 }
 
 // src/version.ts
-var VERSION = true ? "1.0.24" : "0.0.0-test";
+var VERSION = true ? "1.0.28" : "0.0.0-test";
 
 // src/acp-harness.ts
 var ACP_CLIENT_APP = {
@@ -2562,6 +2637,7 @@ var acpResumeStateSchema = z4.object({
     providerMode: z4.enum(["auto", "direct", "ai-gateway"]).optional(),
     gatewayCredentialSource: z4.enum(["AI_GATEWAY_API_KEY", "VERCEL_OIDC_TOKEN"]).nullable().optional()
   }).optional(),
+  sandboxCredentialEnvironment: z4.record(z4.string(), z4.string()).optional(),
   acpSessionId: z4.string().optional(),
   bridge: acpBridgeCoordsSchema.optional(),
   coldSession: acpColdSessionStateSchema.optional(),