import {z} from 'zod' export type GetApiApiV2SecuritycontrolsArgs = {page_number?: number | undefined, page_size?: (10 | 20 | 30) | undefined}; export type GetApiApiV2SecuritycontrolsOptions = {baseUrl?: string | undefined, OAuthv2?: string | undefined, fetch?: typeof fetch | undefined}; export const findingReference = z.string(); export const securityControl = z.object({Id: z.string(), Name: z.string().optional(), Category: z.string().optional(), Title: z.string().optional(), Severity: z.enum(["Info", "Low", "Medium", "High", "Critical"]).optional(), Description: z.string().optional(), Mitigation: z.string().optional(), CwssScore: z.number().gte(0).lte(10).optional(), References: z.array(findingReference).optional(), Mitre: z.array(z.string()).optional(), Fips199: z.object({Confidentiality: z.enum(["Low (1)", "Moderate (2)", "High (3)", "None (0)"]).optional(), Integrity: z.enum(["Low (1)", "Moderate (2)", "High (3)", "None (0)"]).optional(), Availability: z.enum(["Low (1)", "Moderate (2)", "High (3)", "None (0)"]).optional()}).optional(), Fisma: z.object({Area: z.string().optional(), MinMaturityModel: z.string().optional()}).optional(), Nist80053: z.object({Control: z.string().optional(), "Control Family": z.string().optional(), Priority: z.string().optional(), "Baseline Allocation": z.string().optional()}).optional()}); export const getApiApiV2SecuritycontrolsResponse = z.array(securityControl); 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 the list of security controls. * * GET /api/v2/securitycontrols */ export const getApiApiV2Securitycontrols = async (args: GetApiApiV2SecuritycontrolsArgs, options?: GetApiApiV2SecuritycontrolsOptions) => { const {baseUrl = "https://app.blackkitetech.com", fetch: fetchFn = fetch, OAuthv2} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.page_number != null) query.append("page_number", String(args.page_number)) if (args.page_size != null) query.append("page_size", String(args.page_size)) if (OAuthv2 !== undefined) headers.set('authorization', `Bearer ${OAuthv2}`) const url = `${baseUrl.replace(/\/+$/, '')}/api/v2/securitycontrols${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(getApiApiV2SecuritycontrolsResponse, await res.json()) };