import {z} from 'zod' export type CreateApiReportsQueueArgs = {report_type: 'BoardSummaryPDF' | 'BoardSummaryPPTX' | 'BreachSightSummaryPDF' | 'BreachSightDetailedPDF' | 'VendorRiskExecutiveSummaryPDF' | 'VendorSummaryPDF' | 'VendorDetailedPDF' | 'VendorRiskAssessmentPDF' | 'CustomPDF' | 'VendorRiskProfileXLSX' | 'VendorVulnsOverviewXLSX' | 'VendorDomainListPDF' | 'QuestionnaireDetailsPDF' | 'QuestionnaireDetailsXLSX', custom_report_uuid?: string | undefined, email_addresses?: Array | undefined, post_webhook_url?: string | undefined, asset_portfolio_names?: Array | undefined, vendor_portfolio_names?: Array | undefined, vendor_id?: number | undefined, vendor_primary_hostname?: string | undefined, filter_by_vendor_hostnames?: string | undefined, filename_prefix?: string | undefined, wait_for_data?: boolean | undefined, questionnaire_id?: number | undefined, include_messages?: boolean | undefined, include_private_messages?: boolean | undefined}; export type CreateApiReportsQueueOptions = {baseUrl?: string | undefined, APIKeyInHeader?: string | undefined, fetch?: typeof fetch | undefined}; export const queueReportResponsePayloadBody = z.object({queued_report_id: z.string().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 }; /** * Queue a report export * * POST /reports/queue */ export const createApiReportsQueue = async (args: CreateApiReportsQueueArgs, options?: CreateApiReportsQueueOptions) => { const {baseUrl = "https://cyber-risk.upguard.com/api/public", fetch: fetchFn = fetch, APIKeyInHeader} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.report_type != null) query.append("report_type", String(args.report_type)) if (args.custom_report_uuid != null) query.append("custom_report_uuid", String(args.custom_report_uuid)) for (const item of args.email_addresses ?? []) query.append("email_addresses", String(item)) if (args.post_webhook_url != null) query.append("post_webhook_url", String(args.post_webhook_url)) for (const item of args.asset_portfolio_names ?? []) query.append("asset_portfolio_names", String(item)) for (const item of args.vendor_portfolio_names ?? []) query.append("vendor_portfolio_names", String(item)) if (args.vendor_id != null) query.append("vendor_id", String(args.vendor_id)) if (args.vendor_primary_hostname != null) query.append("vendor_primary_hostname", String(args.vendor_primary_hostname)) if (args.filter_by_vendor_hostnames != null) query.append("filter_by_vendor_hostnames", String(args.filter_by_vendor_hostnames)) if (args.filename_prefix != null) query.append("filename_prefix", String(args.filename_prefix)) if (args.wait_for_data != null) query.append("wait_for_data", String(args.wait_for_data)) if (args.questionnaire_id != null) query.append("questionnaire_id", String(args.questionnaire_id)) if (args.include_messages != null) query.append("include_messages", String(args.include_messages)) if (args.include_private_messages != null) query.append("include_private_messages", String(args.include_private_messages)) if (APIKeyInHeader !== undefined) headers.set("Authorization", APIKeyInHeader) const url = `${baseUrl.replace(/\/+$/, '')}/reports/queue${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "POST", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(queueReportResponsePayloadBody, await res.json()) };