import {z} from 'zod' export type PageSize = number; export type PageCursor = string; export type GetApiAuditsAuditIdControlsArgs = {auditId: string, pageSize?: PageSize | undefined, pageCursor?: PageCursor | undefined, externalIdMatchesAny?: Array | undefined}; export type GetApiAuditsAuditIdControlsOptions = {baseUrl?: string | undefined, bearerAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const controlSource = z.enum(["Vanta", "Custom"]); export const owner = z.object({id: z.string(), displayName: z.string(), emailAddress: z.string()}); export const customField = z.object({label: z.string(), value: z.union([z.string(), z.array(z.string())])}); export const sectionPrinciple = z.object({id: z.string(), name: z.string()}); export const section = z.object({name: z.string(), framework: z.string(), principle: sectionPrinciple.nullable()}); export const auditControlAssessmentState = z.enum(["IN_PLACE", "NOT_IN_PLACE", "PARTIAL", "NOT_ASSESSED", "CONFORMING", "MINOR_NON_CONFORMITY", "MAJOR_NON_CONFORMITY", "SATISFIED", "NOT_SATISFIED", "OTHER_THAN_SATISFIED", "TRUE", "FALSE"]); export const auditControlAssessment = z.object({assessmentState: auditControlAssessmentState, justification: z.string().nullable()}); export const auditorControl = z.object({id: z.string(), externalId: z.string().nullable(), name: z.string(), description: z.string(), source: controlSource, domains: z.array(z.string()), owner: owner.nullable(), role: z.string().nullable().optional(), customFields: z.array(customField), creationDate: z.string().nullable(), modificationDate: z.string().nullable(), framework: z.string(), sections: z.array(section), assessments: z.array(auditControlAssessment)}); export const pageInfo = z.object({endCursor: z.string().nullable(), hasNextPage: z.boolean(), hasPreviousPage: z.boolean(), startCursor: z.string().nullable()}); export const paginatedResponseAuditorControl = z.object({results: z.object({data: z.array(auditorControl), pageInfo: pageInfo})}); 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 }; /** * List audit controls * * GET /audits/{auditId}/controls */ export const getApiAuditsAuditIdControls = async (args: GetApiAuditsAuditIdControlsArgs, options?: GetApiAuditsAuditIdControlsOptions) => { 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 (args.pageSize != null) query.append("pageSize", String(args.pageSize)) if (args.pageCursor != null) query.append("pageCursor", String(args.pageCursor)) for (const item of args.externalIdMatchesAny ?? []) query.append("externalIdMatchesAny", String(item)) if (bearerAuth !== undefined) headers.set('authorization', `Bearer ${bearerAuth}`) const url = `${baseUrl.replace(/\/+$/, '')}/audits/${encodeURIComponent(String(args.auditId))}/controls${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(paginatedResponseAuditorControl, await res.json()) };