variant-analysis.ts

import { Repository } from './repository';

export interface VariantAnalysisSubmissionRequest {
  action_repo_ref: string,
  language: VariantAnalysisQueryLanguage,
  query_pack: string,
  repositories?: string[],
  repository_lists?: string[],
  repository_owners?: string[]
}

export type VariantAnalysisQueryLanguage =
  | 'csharp'
  | 'cpp'
  | 'go'
  | 'java'
  | 'javascript'
  | 'python'
  | 'ruby';

export interface VariantAnalysis {
  id: number,
  controller_repo: Repository,
  actor_id: number,
  query_language: VariantAnalysisQueryLanguage,
  query_pack_url: string,
  status: VariantAnalysisStatus,
  actions_workflow_run_id?: number,
  failure_reason?: VariantAnalysisFailureReason,
  scanned_repositories?: VariantAnalysisScannedRepository[],
  skipped_repositories?: VariantAnalysisSkippedRepositories
}

export type VariantAnalysisStatus =
  | 'in_progress'
  | 'completed';

export type VariantAnalysisFailureReason =
  | 'no_repos_queried'
  | 'internal_error';

export type VariantAnalysisRepoStatus =
  | 'pending'
  | 'in_progress'
  | 'succeeded'
  | 'failed'
  | 'canceled'
  | 'timed_out';

export interface VariantAnalysisScannedRepository {
  repository: Repository,
  analysis_status: VariantAnalysisRepoStatus,
  result_count?: number,
  artifact_size_in_bytes?: number,
  failure_message?: string
}

export interface VariantAnalysisSkippedRepositoryGroup {
  repository_count: number,
  repositories: Repository[]
}

export interface VariantAnalysisNotFoundRepositoryGroup {
  repository_count: number,
  repository_full_names: string[]
}
export interface VariantAnalysisRepoTask {
  repository: Repository,
  analysis_status: VariantAnalysisRepoStatus,
  artifact_size_in_bytes?: number,
  result_count?: number,
  failure_message?: string,
  database_commit_sha?: string,
  source_location_prefix?: string,
  artifact_url?: string
}

export interface VariantAnalysisSkippedRepositories {
  access_mismatch_repos?: VariantAnalysisSkippedRepositoryGroup,
  not_found_repo_nwos?: VariantAnalysisNotFoundRepositoryGroup,
  no_codeql_db_repos?: VariantAnalysisSkippedRepositoryGroup,
  over_limit_repos?: VariantAnalysisSkippedRepositoryGroup
}