import {z} from 'zod' export type GetApiV1SimulationsArgs = {limit?: number | undefined, offset?: number | undefined, status?: Array | undefined, simulation_name?: string | undefined, agent_name?: string | undefined, agent_id?: number | undefined, template_name?: string | undefined, template_id?: number | undefined, prevention_result_lte?: number | undefined, prevention_result_gte?: number | undefined, detection_result_lte?: number | undefined, detection_result_gte?: number | undefined}; export type GetApiV1SimulationsOptions = {baseUrl?: string | undefined, AccessToken?: string | undefined, fetch?: typeof fetch | undefined}; export const pagination = z.object({limit: z.number().int().optional(), offset: z.number().int().optional(), total_count: z.number().int().optional()}); export const agentSummary = z.object({id: z.number().int().optional(), name: z.string().optional(), status: z.string().optional(), type: z.string().optional(), version: z.string().optional()}); export const enrichment = z.object({id: z.number().int().optional(), product_name: z.string().optional()}); export const detection = z.object({integrations: z.array(enrichment).optional()}); export const threatCounts = z.object({completed_threat_count: z.number().int().optional(), total_threat_count: z.number().int().optional()}); export const statusDetails = z.object({detection: threatCounts.optional(), prevention: threatCounts.optional()}); export const simulationSummary = z.object({agent: agentSummary.optional(), completion_ratio: z.number().int().optional(), detection_analysis: detection.optional(), fail_reason_message: z.string().optional(), has_detection_analysis: z.boolean().optional(), has_last_run_detection_analysis: z.boolean().optional(), is_practice: z.boolean().optional(), last_detection_security_score: z.number().int().optional(), last_prevention_security_score: z.number().int().optional(), simulation_id: z.number().int().optional(), simulation_name: z.string().optional(), status: z.string().optional(), status_details: statusDetails.optional(), template_id: z.number().int().optional(), template_name: z.string().optional(), updated_at: z.number().int().optional()}); export const getApiV1SimulationsResponse = z.object({pages: pagination.optional(), simulations: z.array(simulationSummary).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 }; /** * # Simulation List * * GET /v1/simulations */ export const getApiV1Simulations = async (args: GetApiV1SimulationsArgs, options?: GetApiV1SimulationsOptions) => { const {baseUrl = "https://api.picussecurity.com", fetch: fetchFn = fetch, AccessToken} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.limit != null) query.append("limit", String(args.limit)) if (args.offset != null) query.append("offset", String(args.offset)) for (const item of args.status ?? []) query.append("status", String(item)) if (args.simulation_name != null) query.append("simulation_name", String(args.simulation_name)) if (args.agent_name != null) query.append("agent_name", String(args.agent_name)) if (args.agent_id != null) query.append("agent_id", String(args.agent_id)) if (args.template_name != null) query.append("template_name", String(args.template_name)) if (args.template_id != null) query.append("template_id", String(args.template_id)) if (args.prevention_result_lte != null) query.append("prevention_result_lte", String(args.prevention_result_lte)) if (args.prevention_result_gte != null) query.append("prevention_result_gte", String(args.prevention_result_gte)) if (args.detection_result_lte != null) query.append("detection_result_lte", String(args.detection_result_lte)) if (args.detection_result_gte != null) query.append("detection_result_gte", String(args.detection_result_gte)) if (AccessToken !== undefined) headers.set("Authorization", AccessToken) const url = `${baseUrl.replace(/\/+$/, '')}/v1/simulations${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(getApiV1SimulationsResponse, await res.json()) };