import {z} from 'zod' export type RepositoryID = string; export type RepositorySet = Array; export type IndexedGroups = Array>; export type DeveloperID = string; export type CommitPushers = Array; export type JIRAStatusCategory = 'To Do' | 'In Progress' | 'Done' | 'No Category'; export type ForSetCodeChecks = {repositories: RepositorySet, repogroups?: IndexedGroups | undefined, pushers?: CommitPushers | undefined, pusher_groups?: Array | undefined, labels_include?: Array | undefined, labels_exclude?: Array | undefined, jira?: ({epics?: Array | undefined, labels_include?: Array | undefined, labels_exclude?: Array | undefined, issue_types?: Array | undefined, priorities?: Array | undefined, projects?: Array | undefined, status_categories?: Array | undefined, unmapped?: boolean | undefined}) | undefined, lines?: Array | undefined}; export type CodeCheckMetricID = 'chk-suites-count' | 'chk-suites-in-prs-count' | 'chk-successful-suites-count' | 'chk-failed-suites-count' | 'chk-cancelled-suites-count' | 'chk-success-ratio' | 'chk-suite-time' | 'chk-robust-suite-time' | 'chk-suites-per-pr' | 'chk-suite-time-per-pr' | 'chk-prs-with-checks-count' | 'chk-flaky-commit-checks-count' | 'chk-prs-merged-with-failed-checks-count' | 'chk-prs-merged-with-failed-checks-ratio' | 'chk-concurrency-max' | 'chk-concurrency' | 'chk-elapsed-time-per-concurrency' | 'chk-suite-occupancy' | 'chk-suite-critical-occupancy' | 'chk-suite-imbalance'; export type TimeZone = number; export type Granularity = string; export type Granularities = Array; export type Quantiles = Array; export type CodeCheckMetricsRequest = {for: Array, metrics: Array, date_from: string, date_to: string, timezone?: TimeZone | undefined, granularities: Granularities, quantiles?: Quantiles | undefined, account: number, split_by_check_runs?: boolean | undefined}; export type CreateApiMetricsCodeChecksArgs = {body: CodeCheckMetricsRequest}; export type CreateApiMetricsCodeChecksOptions = {baseUrl: string, bearerAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const repositoryID = z.string(); export const repositorySet = z.array(repositoryID); export const indexedGroups = z.array(z.array(z.number().int().gte(0))); export const developerID = z.string(); export const commitPushers = z.array(developerID); export const jIRAStatusCategory = z.enum(["To Do", "In Progress", "Done", "No Category"]); export const forSetCodeChecks = z.object({repositories: repositorySet, repogroups: indexedGroups.optional(), pushers: commitPushers.optional(), pusher_groups: z.array(commitPushers).optional(), labels_include: z.array(z.string()).optional(), labels_exclude: z.array(z.string()).optional(), jira: z.object({epics: z.array(z.string()).optional(), labels_include: z.array(z.string()).optional(), labels_exclude: z.array(z.string()).optional(), issue_types: z.array(z.string()).optional(), priorities: z.array(z.string()).optional(), projects: z.array(z.string()).optional(), status_categories: z.array(jIRAStatusCategory).optional(), unmapped: z.boolean().optional()}).optional(), lines: z.array(z.number().int().gte(0)).optional()}); export const granularity = z.string(); export const timeDuration = z.string(); export const calculatedLinearMetricValues = z.object({date: z.string(), values: z.array(z.union([z.number(), timeDuration, z.object({})])), confidence_mins: z.array(z.union([z.number().nullable(), timeDuration])).optional(), confidence_maxs: z.array(z.union([z.number().nullable(), timeDuration])).optional(), confidence_scores: z.array(z.number().int().nullable()).optional()}); export const calculatedCodeCheckMetricsItem = z.object({for: forSetCodeChecks, granularity: granularity.optional(), check_runs: z.number().int().optional(), suites_ratio: z.number().gte(0).lte(1).optional(), values: z.array(calculatedLinearMetricValues)}); export const codeCheckMetricID = z.enum(["chk-suites-count", "chk-suites-in-prs-count", "chk-successful-suites-count", "chk-failed-suites-count", "chk-cancelled-suites-count", "chk-success-ratio", "chk-suite-time", "chk-robust-suite-time", "chk-suites-per-pr", "chk-suite-time-per-pr", "chk-prs-with-checks-count", "chk-flaky-commit-checks-count", "chk-prs-merged-with-failed-checks-count", "chk-prs-merged-with-failed-checks-ratio", "chk-concurrency-max", "chk-concurrency", "chk-elapsed-time-per-concurrency", "chk-suite-occupancy", "chk-suite-critical-occupancy", "chk-suite-imbalance"]); export const timeZone = z.number().int().gte(-720).lte(780); export const granularities = z.array(granularity); export const quantiles = z.array(z.number().gte(0).lte(1)); export const calculatedCodeCheckMetrics = z.object({calculated: z.array(calculatedCodeCheckMetricsItem), metrics: z.array(codeCheckMetricID), date_from: z.string(), date_to: z.string(), timezone: timeZone.optional(), granularities: granularities, quantiles: quantiles.optional(), split_by_check_runs: z.boolean().optional()}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Calculate metrics on continuous integration runs, such as GitHub Actions, Jenkins, Circle, etc. * * POST /metrics/code_checks * * Also accepts auth: apiKeyAuth */ export const createApiMetricsCodeChecks = async (args: CreateApiMetricsCodeChecksArgs, options: CreateApiMetricsCodeChecksOptions) => { const {baseUrl, fetch: fetchFn = fetch, bearerAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") if (bearerAuth !== undefined) headers.set('authorization', `Bearer ${bearerAuth}`) const url = `${baseUrl.replace(/\/+$/, '')}/metrics/code_checks${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "POST", headers, body: JSON.stringify(args.body)}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(calculatedCodeCheckMetrics, await res.json()) };