@ai-sdk/harness-acp 0.0.0 → 1.0.1

package/dist/index.d.ts

@@ -0,0 +1,104 @@
+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 ACPNpmSimpleSource = {
+    readonly type: 'npm-simple';
+    readonly packageName: string;
+    /**
+     * Exact version to install. When omitted, the package's `latest` dist-tag is
+     * installed and no version takes part in the implementation identity, so a
+     * new upstream release does not invalidate existing lifecycle state.
+     */
+    readonly packageVersion?: string;
+};
+type ACPNpmLockedSource = {
+    readonly type: 'npm-locked';
+    readonly packageJson: string;
+    readonly pnpmLockYaml: string;
+};
+type ACPSource = ACPNpmSimpleSource | ACPNpmLockedSource;
+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 source: ACPSource;
+    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>>;
+    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 source: ACPV1Settings['source'];
+    readonly executable: ACPV1Settings['executable'];
+    readonly args?: ACPV1Settings['args'];
+    readonly forwardEnv?: ACPV1Settings['forwardEnv'];
+    readonly env?: ACPV1Settings['env'];
+    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 ACPNpmLockedSource, type ACPNpmSimpleSource, type ACPPermissionModeMapping, type ACPPermissionModeTarget, type ACPProfileValue, type ACPProviderAuthentication, type ACPProviderAuthenticationMode, type ACPSerializablePrimitive, type ACPSerializableValue, type ACPSource, type ACPV1Settings, type ACPValueSource, VERSION, createACP };