openclaw/src/secrets/runtime-web-tools-selection.types.ts

/** Typed credential ownership and unavailable-provider results for runtime web tools. */
import type { SecretRef, SecretRefSource } from "../config/types.secrets.js";
import type { SecretDegradationReason } from "./runtime-degraded-state.js";
import type { SecretResolverWarningCode } from "./runtime-shared.js";
import type { RuntimeWebDiagnosticCode } from "./runtime-web-tools.types.js";

export type RuntimeWebWarningCode = Extract<RuntimeWebDiagnosticCode, SecretResolverWarningCode>;

export type RuntimeWebResolveSecretInputParams = {
  providerId: string;
  value: unknown;
  path: string;
  envVars: string[];
  contractDigest: string;
};

export type SecretResolutionResult<TSource extends string> = {
  value?: string;
  source: TSource;
  secretRefConfigured: boolean;
  secretRef?: SecretRef;
  secretRefKey?: string;
  unresolvedRefReason?: SecretDegradationReason;
  fallbackEnvVar?: string;
};

export type RuntimeWebSecretOwner = {
  providerId: string;
  path: string;
  ref: SecretRef;
  refKey: string;
  contractDigest: string;
  resolvedValue?: string;
  reason?: SecretDegradationReason;
  providerFailure?: { source: SecretRefSource; provider: string };
  restoreResolvedValue?: (value: string) => void;
};

export type RuntimeWebUnavailableProvider = RuntimeWebSecretOwner & {
  reason: SecretDegradationReason;
};

export type RuntimeWebProviderSelectionResult = {
  secretOwners: RuntimeWebSecretOwner[];
  unavailableProviders: RuntimeWebUnavailableProvider[];
};

/** Carries typed web-provider ownership through strict reload failures. */
export class RuntimeWebProviderUnavailableError extends Error {
  readonly unavailableProviders: RuntimeWebUnavailableProvider[];

  constructor(
    code: RuntimeWebWarningCode,
    reason: SecretDegradationReason,
    unavailableProviders: RuntimeWebUnavailableProvider[],
  ) {
    super(`[${code}] ${reason}`);
    this.name = "RuntimeWebProviderUnavailableError";
    this.unavailableProviders = unavailableProviders;
  }
}