import {z} from 'zod' export type GetApiSastScansArgs = {last?: number | undefined, scanStatus?: ('Scanning' | 'Finished' | 'Canceled' | 'Failed') | undefined, projectId?: number | undefined}; export type GetApiSastScansOptions = {baseUrl?: string | undefined, Bearer?: string | undefined, fetch?: typeof fetch | undefined}; export const cxSuperTypesAPIDtosLinkDtoBase = z.object({rel: z.string().optional(), uri: z.string().optional()}); export const cxSastScanExecutionPresentationDtosProjectDto = z.object({id: z.number().int().optional(), name: z.string().optional(), link: cxSuperTypesAPIDtosLinkDtoBase.optional()}); export const cxSastScanExecutionPresentationDtosScanStatusDetailsDto = z.object({stage: z.string().optional(), step: z.string().optional()}); export const cxSastScanExecutionPresentationDtosScanStatusDto = z.object({id: z.number().int().optional(), name: z.string().optional(), details: cxSastScanExecutionPresentationDtosScanStatusDetailsDto.optional()}); export const cxSastScanExecutionPresentationDtosDateAndTimeDto = z.object({startedOn: z.string().optional(), finishedOn: z.string().optional(), engineStartedOn: z.string().optional(), engineFinishedOn: z.string().optional()}); export const cxSastScanExecutionPresentationDtosResultsStatisticsLink = z.object({link: cxSuperTypesAPIDtosLinkDtoBase.optional()}); export const cxSastScanExecutionDomainEntitiesQueryLanguageState = z.object({languageID: z.number().int().optional(), languageName: z.string().optional(), languageHash: z.string().optional(), stateCreationDate: z.string().optional()}); export const cxSastScanExecutionPresentationDtosScanStateDto = z.object({path: z.string().optional(), sourceId: z.string().optional(), filesCount: z.number().int().optional(), linesOfCode: z.number().int().optional(), failedLinesOfCode: z.number().int().optional(), cxVersion: z.string().optional(), languageStateCollection: z.array(cxSastScanExecutionDomainEntitiesQueryLanguageState).optional()}); export const cxSastScanExecutionPresentationDtosEngineServerDto = z.object({id: z.number().int().optional(), name: z.string().optional(), link: cxSuperTypesAPIDtosLinkDtoBase.optional()}); export const cxSastScanExecutionDomainEntitiesPartialScanDTO = z.object({abortedMessage: z.string().optional(), abortedStatus: z.enum(["None", "Queries", "Stages", "QueriesExceededResultThreshold"]).optional()}); export const cxSastScanExecutionPresentationDtosSastScansDtoV12 = z.object({id: z.number().int().optional(), project: cxSastScanExecutionPresentationDtosProjectDto.optional(), status: cxSastScanExecutionPresentationDtosScanStatusDto.optional(), scanType: z.enum(["Unknown", "AllScans", "Regular", "Subset", "Partial", "Running"]).optional(), comment: z.string().optional(), dateAndTime: cxSastScanExecutionPresentationDtosDateAndTimeDto.optional(), resultsStatistics: cxSastScanExecutionPresentationDtosResultsStatisticsLink.optional(), scanState: cxSastScanExecutionPresentationDtosScanStateDto.optional(), owner: z.string().optional(), origin: z.string().optional(), originURL: z.string().optional(), initiatorName: z.string().optional(), owningTeamId: z.number().int().optional(), isPublic: z.boolean().optional(), isLocked: z.boolean().optional(), isIncremental: z.boolean().optional(), scanRisk: z.number().int().optional(), scanRiskSeverity: z.number().int().optional(), engineServer: cxSastScanExecutionPresentationDtosEngineServerDto.optional(), finishedScanStatus: z.enum(["None", "Completed", "Partial"]).optional(), partialScanReasons: z.array(cxSastScanExecutionDomainEntitiesPartialScanDTO).optional(), customFields: z.record(z.string(), z.string()).optional()}); export const getApiSastScansResponse = z.array(cxSastScanExecutionPresentationDtosSastScansDtoV12); 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 }; /** * Gets a collection of scans By Project * * GET /sast/scans */ export const getApiSastScans = async (args: GetApiSastScansArgs, options?: GetApiSastScansOptions) => { const {baseUrl = "https://desktop-rmvpboc/cxrestapi/help", fetch: fetchFn = fetch, Bearer} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json;v=5.0") if (args.last != null) query.append("last", String(args.last)) if (args.scanStatus != null) query.append("scanStatus", String(args.scanStatus)) if (args.projectId != null) query.append("projectId", String(args.projectId)) if (Bearer !== undefined) headers.set('authorization', `Bearer ${Bearer}`) const url = `${baseUrl.replace(/\/+$/, '')}/sast/scans${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(getApiSastScansResponse, await res.json()) };