import {z} from 'zod' export type GetApiSearchCpeArgs = {part?: string | undefined, vendor?: string | undefined, product?: string | undefined, version?: string | undefined, isVulnerable?: string | undefined}; export type GetApiSearchCpeOptions = {baseUrl: string, Bearer?: string | undefined, fetch?: typeof fetch | undefined}; export const paginateMatch = z.object({field: z.string().optional(), value: z.string().optional()}); export const paginateParam = z.object({filtering: z.string().optional(), format: z.string().optional(), name: z.string().optional()}); export const paginatePagination = z.object({cursor: z.string().optional(), first_item: z.number().int().optional(), index: z.string().optional(), last_item: z.number().int().optional(), limit: z.number().int().optional(), matches: z.array(paginateMatch).optional(), max_pages: z.number().int().optional(), next_cursor: z.string().optional(), opensearch_query: z.object({}).optional(), order: z.string().optional(), page: z.number().int().optional(), pages: z.array(z.string()).optional(), parameters: z.array(paginateParam).optional(), show_pages: z.boolean().optional(), show_query: z.boolean().optional(), sort: z.string().optional(), timestamp: z.string().optional(), total_documents: z.number().int().optional(), total_pages: z.number().int().optional(), truncated: z.boolean().optional(), warnings: z.array(z.string()).optional()}); export const apiCPE = z.object({edition: z.string().optional(), language: z.string().optional(), other: z.string().optional(), part: z.string().optional(), product: z.string().optional(), sw_edition: z.string().optional(), target_hw: z.string().optional(), target_sw: z.string().optional(), update: z.string().optional(), vendor: z.string().optional(), version: z.string().optional()}); export const searchResponseDataOut = z.object({cpe: z.string().optional(), cpe_struct: apiCPE.optional(), cves: z.array(z.string()).optional()}); export const renderResponseWithMetadataSearchResponsesPaginatePagination = z.object({_benchmark: z.number().optional(), _meta: paginatePagination.optional(), data: z.array(searchResponseDataOut).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 }; /** * Return CPEs and associated CPEs by searching CPE fields * * GET /search/cpe */ export const getApiSearchCpe = async (args: GetApiSearchCpeArgs, options: GetApiSearchCpeOptions) => { const {baseUrl, fetch: fetchFn = fetch, Bearer} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.part != null) query.append("part", String(args.part)) if (args.vendor != null) query.append("vendor", String(args.vendor)) if (args.product != null) query.append("product", String(args.product)) if (args.version != null) query.append("version", String(args.version)) if (args.isVulnerable != null) query.append("isVulnerable", String(args.isVulnerable)) if (Bearer !== undefined) headers.set("Authorization", Bearer) const url = `${baseUrl.replace(/\/+$/, '')}/search/cpe${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(renderResponseWithMetadataSearchResponsesPaginatePagination, await res.json()) };