import {z} from 'zod' export type GetApiTestsTestIdArgs = {testId: string}; export type GetApiTestsTestIdOptions = {baseUrl?: string | undefined, bearerAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const documentAndTestCategory = z.enum(["Accounts access", "Account security", "Account setup", "Computers", "Custom", "Data storage", "Employees", "Infrastructure", "IT", "Logging", "Monitoring alerts", "People", "Policies", "Risk analysis", "Software development", "CSPM alert management", "Vendors", "Vulnerability management"]); export const testStatus = z.enum(["OK", "DEACTIVATED", "NEEDS_ATTENTION", "IN_PROGRESS", "INVALID", "NOT_APPLICABLE"]); export const deactivatedStatusInfo = z.object({isDeactivated: z.boolean(), deactivatedReason: z.string().nullable(), lastUpdatedDate: z.string().nullable()}); export const testRemediationStatus = z.enum(["DISABLED", "DUE_SOON", "INVALID", "IN_PROGRESS", "NA", "NEEDS_WORK", "OVERDUE", "PASS"]); export const remediationStatusInfo = z.object({status: testRemediationStatus, soonestRemediateByDate: z.string().nullable(), itemCount: z.number()}); export const owner = z.object({id: z.string(), displayName: z.string(), emailAddress: z.string()}); export const test = z.object({id: z.string(), name: z.string(), lastTestRunDate: z.string(), latestFlipDate: z.string().nullable(), description: z.string(), failureDescription: z.string(), remediationDescription: z.string(), version: z.object({minor: z.number(), major: z.number()}), category: documentAndTestCategory, integrations: z.array(z.string()), status: testStatus, deactivatedStatusInfo: deactivatedStatusInfo, remediationStatusInfo: remediationStatusInfo, owner: owner.nullable()}); 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 }; /** * Get test by ID * * GET /tests/{testId} */ export const getApiTestsTestId = async (args: GetApiTestsTestIdArgs, options?: GetApiTestsTestIdOptions) => { const {baseUrl = "https://api.vanta.com", fetch: fetchFn = fetch, bearerAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (bearerAuth !== undefined) headers.set('authorization', `Bearer ${bearerAuth}`) const url = `${baseUrl.replace(/\/+$/, '')}/tests/${encodeURIComponent(String(args.testId))}${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(test, await res.json()) };