models.ts

import type { Format, PersistConfig, UploadConfig } from '@code-pushup/models';
import type { SourceFileIssue } from './issues.js';
import type { MonorepoTool } from './monorepo/index.js';

/**
 * Customization options for {@link runInCI}
 * @see https://github.com/code-pushup/cli/tree/main/packages/ci#options
 */
export type Options = {
  monorepo?: boolean | MonorepoTool;
  parallel?: boolean | number;
  projects?: string[] | null;
  task?: string;
  nxProjectsFilter?: string | string[];
  bin?: string;
  config?: string | null;
  directory?: string;
  detectNewIssues?: boolean;
  skipComment?: boolean;
  configPatterns?: ConfigPatterns | null;
  searchCommits?: boolean | number;
};

/**
 * {@link Options} with filled-in defaults.
 */
export type Settings = Required<Options>;

/**
 * Branches/tags for {@link runInCI}
 */
export type GitRefs = {
  head: string | GitBranch;
  base?: string | GitBranch;
};

/**
 * API client for {@link runInCI} - adapter for CI provider
 * @see https://github.com/code-pushup/cli/tree/main/packages/ci#provider-api-client
 */
export type ProviderAPIClient = {
  maxCommentChars: number;
  downloadReportArtifact?: (project?: string) => Promise<string | null>;
  listComments: () => Promise<Comment[]>;
  updateComment: (id: number, body: string) => Promise<Comment>;
  createComment: (body: string) => Promise<Comment>;
};

/**
 * PR/MR comment from {@link ProviderAPIClient}
 */
export type Comment = {
  id: number;
  body: string;
  url: string;
};

/**
 * Git ref (e.g. 'main') and commit sha (e.g. '9d7568265bd5b17d1bb51a6eb6407e0d387058d2')
 */
export type GitBranch = {
  ref: string;
  sha: string;
};

/**
 * Code PushUp config patterns which hold for every project in monorepo.
 * Providing this information upfront makes CI runs faster (skips print-config).
 */
export type ConfigPatterns = {
  persist: Required<PersistConfig>;
  upload?: UploadConfig;
};

/**
 * Resolved return value of {@link runInCI}
 */
export type RunResult = StandaloneRunResult | MonorepoRunResult;

/**
 * Resolved return value of {@link runInCI} in standalone mode
 */
export type StandaloneRunResult = Omit<ProjectRunResult, 'name'> & {
  mode: 'standalone';
  commentId?: number;
};

/**
 * Resolved return value of {@link runInCI} in monorepo mode
 */
export type MonorepoRunResult = {
  mode: 'monorepo';
  projects: ProjectRunResult[];
  commentId?: number;
  files?: {
    comparison: Pick<OutputFiles, 'md'>;
  };
};

/**
 * Result of {@link runInCI} for a single project
 */
export type ProjectRunResult = {
  name: string;
  files: {
    current: OutputFiles;
    previous?: OutputFiles | Pick<OutputFiles, 'json'>;
    comparison?: OutputFiles;
  };
  newIssues?: SourceFileIssue[];
};

/**
 * Paths to output files from {@link runInCI}, for uploading as job artifact
 */
export type OutputFiles = Record<Format, string>;