types.ts

import type { LanguageModelUsage as _LanguageModelUsage, ModelMessage, JSONValue } from 'ai';

export type CodeReviewProvider =
  | 'openai'
  | 'openai-chat' // uses OpenAI chat API
  | 'deepseek'
  | 'xai'
  | 'anthropic'
  | 'google';

export type CodeReviewOptions = {
  /**
   * AI service provider (options: "openai", "deepseek", "xai", "anthropic", "google").
   * @default 'openai'
   */
  provider?: CodeReviewProvider;

  /**
   * Base URL for the AI service API.
   * @default undefined
   */
  baseUrl?: string;

  /**
   * API key for the AI service.
   */
  apiKey: string;

  /**
   * AI model to use for review.
   */
  model: string;

  /**
   * Head ref to compare with.
   * @default 'HEAD'
   */
  headRef?: string;

  /**
   * Base ref to compare against.
   * @default 'HEAD^'
   */
  baseRef?: string;

  /**
   * Files and directories to include in review.
   * @default
   * ['.']
   */
  include?: string[];

  /**
   * Files and directories to exclude from review.
   * @default
   * ['package-lock.json', 'pnpm-lock.yaml', 'yarn.lock']
   */
  exclude?: string[];

  /**
   * Path to a file to save review result.
   * @default undefined
   */
  outputFile?: string;

  /**
   * Path to a custom prompt file, or a builtin prompt (options: `en`, `zh-cn`).
   * @default 'en'
   */
  promptFile?: string;

  /**
   * Path to a custom system prompt file.
   * @default undefined
   */
  systemPromptFile?: string;

  /**
   * Whether to disable tools.
   * @default false
   */
  disableTools?: boolean;

  /**
   * Maximum number of AI model calls.
   * @default 32
   */
  maxSteps?: number;

  /**
   * Temperature for the AI model.
   * @default undefined
   */
  temperature?: number;

  /**
   * Top P for the AI model.
   * @default undefined
   */
  topP?: number;

  /**
   * Top K for the AI model.
   * @default undefined
   */
  topK?: number;

  /**
   * Whether to print review result to stdout.
   * @default false
   */
  print?: boolean;

  /**
   * Whether to enable approval check.
   * @experimental
   */
  approvalCheck?:
    | boolean
    | {
        prompt?: string;
        promptFile?: string;
      };
};

export type CodeReviewCliOptions = Omit<
  CodeReviewOptions,
  'include' | 'exclude' | 'approvalCheck'
> & {
  include?: string;
  exclude?: string;
  /**
   * @experimental
   */
  approvalCheck?: boolean;
  /**
   * @experimental
   */
  approvalCheckPrompt?: string;
  /**
   * @experimental
   */
  approvalCheckPromptFile?: string;
};

export type LanguageModelCallUsage = _LanguageModelUsage & {
  uncachedInputTokens?: number;
};

export type LanguageModelCallStats = {
  startedAt: number;
  firstTokenReceivedAt: number;
  finishedAt: number;
  timeToFirstToken: number;
  timeToFinish: number;
  tokensPerSecond?: number;
};

export type LanguageModelCallResult = {
  text: string;
  reasoning: string[];
  messages: ModelMessage[];
  stats: LanguageModelCallStats;
  usage: LanguageModelCallUsage;
};

export type CodeReviewResult = {
  reviewReport: LanguageModelCallResult & {
    diffsCmd: string;
    diffs: string;
  };
  /**
   * The result of approval check.
   * @experimental
   */
  approvalCheck?: {
    approvalCheckComment: LanguageModelCallResult;
    approvalCheckStatus: LanguageModelCallResult & {
      approved: boolean;
    };
  };
};

export type ProviderOptions = Record<string, Record<string, JSONValue>>;