@ai-sdk/harness-acp 0.0.0 → 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,98 @@
+import { HarnessV1PermissionMode, HarnessV1 } from '@ai-sdk/harness';
+import { ToolSet } from '@ai-sdk/provider-utils';
+
+type ACPSerializablePrimitive = string | number | boolean | null;
+type ACPSerializableValue = ACPSerializablePrimitive | ReadonlyArray<ACPSerializableValue> | {
+    readonly [key: string]: ACPSerializableValue;
+};
+type ACPValueSource = {
+    readonly $source: 'gateway-api-key' | 'gateway-base-url' | 'gateway-authorization' | 'client-app' | 'client-app-name' | 'client-app-version';
+    readonly prefix?: string;
+    readonly suffix?: string;
+    readonly ensureSuffix?: string;
+};
+type ACPProfileValue = ACPSerializablePrimitive | ACPValueSource | ReadonlyArray<ACPProfileValue> | {
+    readonly [key: string]: ACPProfileValue;
+};
+type ACPNpmLaunchSettings = {
+    readonly type: 'npm';
+    readonly executable: string;
+    readonly args?: ReadonlyArray<string>;
+    readonly forwardEnv?: ReadonlyArray<string>;
+    /**
+     * Runtime environment values that are safe to persist in bootstrap and
+     * lifecycle compatibility identity.
+     */
+    readonly env?: Readonly<Record<string, string>>;
+};
+type ACPSimpleNpmImplementation = ACPNpmLaunchSettings & {
+    readonly mode: 'simple';
+    readonly packageName: string;
+    readonly version: string;
+};
+type ACPLockedNpmImplementation = ACPNpmLaunchSettings & {
+    readonly mode: 'locked';
+    readonly packageJson: string;
+    readonly pnpmLockYaml: string;
+};
+type ACPNpmImplementation = ACPSimpleNpmImplementation | ACPLockedNpmImplementation;
+type ACPAuthentication = {
+    readonly methodId: string;
+    readonly meta?: Readonly<Record<string, ACPSerializableValue>>;
+    readonly clientCapabilities?: Readonly<Record<string, ACPSerializableValue>>;
+};
+type ACPProviderAuthenticationMode = 'auto' | 'direct' | 'ai-gateway';
+type ACPProviderAuthentication = {
+    readonly gateway: {
+        readonly env: Readonly<Record<string, ACPProfileValue>>;
+    };
+};
+type ACPPermissionModeTarget = {
+    readonly type: 'session-mode';
+    readonly modeId: string;
+} | {
+    readonly type: 'session-config-option';
+    readonly configId: string;
+    readonly value: string | boolean;
+};
+type ACPPermissionModeMapping = Readonly<Record<HarnessV1PermissionMode, ACPPermissionModeTarget | null>>;
+type ACPV1Settings = {
+    readonly version?: 'v1';
+    readonly harnessId: string;
+    readonly auth?: ACPProviderAuthenticationMode;
+    readonly implementation: ACPNpmImplementation;
+    readonly authentication?: ACPAuthentication;
+    readonly providerAuthentication?: ACPProviderAuthentication;
+    readonly modelId?: string;
+    readonly permissionModeMapping?: ACPPermissionModeMapping;
+    readonly session?: {
+        readonly meta?: Readonly<Record<string, ACPSerializableValue>>;
+    };
+};
+
+type ACPAuthOptions = ACPProviderAuthenticationMode;
+type ACPClientApp = {
+    readonly name: string;
+    readonly version: string;
+};
+
+type ACPHarnessSettings<TBuiltinTools extends ToolSet = {}> = {
+    readonly builtinTools?: TBuiltinTools;
+    readonly port?: number;
+    readonly startupTimeoutMs?: number;
+    readonly clientApp?: ACPClientApp;
+    readonly version?: ACPV1Settings['version'];
+    readonly harnessId: ACPV1Settings['harnessId'];
+    readonly auth?: ACPV1Settings['auth'];
+    readonly implementation: ACPV1Settings['implementation'];
+    readonly authentication?: ACPV1Settings['authentication'];
+    readonly providerAuthentication?: ACPV1Settings['providerAuthentication'];
+    readonly modelId?: ACPV1Settings['modelId'];
+    readonly permissionModeMapping?: ACPV1Settings['permissionModeMapping'];
+    readonly session?: ACPV1Settings['session'];
+};
+declare function createACP<TBuiltinTools extends ToolSet = {}>(settings: ACPHarnessSettings<TBuiltinTools>): HarnessV1<TBuiltinTools>;
+
+declare const VERSION: string;
+
+export { type ACPAuthOptions, type ACPAuthentication, type ACPClientApp, type ACPHarnessSettings, type ACPLockedNpmImplementation, type ACPNpmImplementation, type ACPPermissionModeMapping, type ACPPermissionModeTarget, type ACPProfileValue, type ACPProviderAuthentication, type ACPProviderAuthenticationMode, type ACPSerializablePrimitive, type ACPSerializableValue, type ACPSimpleNpmImplementation, type ACPV1Settings, type ACPValueSource, VERSION, createACP };