import {z} from 'zod' export type GetApiAdvisoryArgs = {name?: string | undefined, cve_id?: string | undefined, vendor?: string | undefined, product?: string | undefined, platform?: string | undefined, version?: string | undefined, cpe?: string | undefined, package_name?: string | undefined, purl?: string | undefined, reference_url?: string | undefined, reference_tag?: string | undefined, description_lang?: string | undefined, updatedAfter?: string | undefined, updatedBefore?: string | undefined, page?: number | undefined, limit?: number | undefined, start_cursor?: string | undefined, cursor?: string | undefined}; export type GetApiAdvisoryOptions = {baseUrl: string, Bearer?: string | undefined, fetch?: typeof fetch | undefined}; export const searchV4AdvisoryMeta = z.object({cursor: z.string().optional(), filtered: z.number().int().optional(), limit: z.number().int().optional(), next_cursor: z.string().optional(), page: z.number().int().optional(), pages: z.number().int().optional(), total: z.number().int().optional()}); export const advisoryProgramRoutine = z.object({name: z.string().optional()}); export const advisoryVersionChange = z.object({at: z.string().optional(), status: z.string().optional()}); export const advisoryMVersion = z.object({changes: z.array(advisoryVersionChange).optional(), lessThan: z.string().optional(), lessThanOrEqual: z.string().optional(), status: z.string().optional(), version: z.string().optional(), versionType: z.string().optional()}); export const advisoryMAffected = z.object({collectionURL: z.string().optional(), cpes: z.array(z.string()).optional(), defaultStatus: z.string().optional(), modules: z.array(z.string()).optional(), packageName: z.string().optional(), packageURL: z.string().optional(), platforms: z.array(z.string()).optional(), product: z.string().optional(), programFiles: z.array(z.string()).optional(), programRoutines: z.array(advisoryProgramRoutine).optional(), repo: z.string().optional(), vendor: z.string().optional(), versions: z.array(advisoryMVersion).optional()}); export const advisoryMDescriptions = z.object({lang: z.string().optional(), value: z.string().optional()}); export const advisoryMCPEMatch = z.object({criteria: z.string().optional(), matchCriteriaId: z.string().optional(), versionEndExcluding: z.string().optional(), versionEndIncluding: z.string().optional(), versionStartExcluding: z.string().optional(), versionStartIncluding: z.string().optional(), vulnerable: z.boolean().optional()}); export const advisoryMNodes = z.object({cpeMatch: z.array(advisoryMCPEMatch).optional(), negate: z.boolean().optional(), operator: z.string().optional()}); export const advisoryMCPEApplicability = z.object({negate: z.boolean().optional(), nodes: z.array(advisoryMNodes).optional(), operator: z.string().optional()}); export const advisoryCustomCPE = z.object({mcpeapplicability: advisoryMCPEApplicability.optional(), stringValue: z.string().optional()}); export const advisoryCredit = z.object({lang: z.string().optional(), type: z.string().optional(), user: z.string().optional(), value: z.string().optional()}); export const advisoryImpact = z.object({capecId: z.string().optional(), descriptions: z.array(advisoryMDescriptions).optional()}); export const advisoryMCvssV20 = z.object({accessVector: z.string().optional(), attackComplexity: z.string().optional(), authentication: z.string().optional(), availabilityImpact: z.string().optional(), baseScore: z.number().optional(), confidentialityImpact: z.string().optional(), integrityImpact: z.string().optional(), vectorString: z.string().optional(), version: z.string().optional()}); export const advisoryMCvssV30 = z.object({attackComplexity: z.string().optional(), attackVector: z.string().optional(), availabilityImpact: z.string().optional(), baseScore: z.number().optional(), baseSeverity: z.string().optional(), confidentialityImpact: z.string().optional(), integrityImpact: z.string().optional(), privilegesRequired: z.string().optional(), scope: z.string().optional(), userInteraction: z.string().optional(), vectorString: z.string().optional(), version: z.string().optional()}); export const advisoryMCvssV31 = z.object({attackComplexity: z.string().optional(), attackVector: z.string().optional(), availabilityImpact: z.string().optional(), baseScore: z.number().optional(), baseSeverity: z.string().optional(), confidentialityImpact: z.string().optional(), integrityImpact: z.string().optional(), privilegesRequired: z.string().optional(), scope: z.string().optional(), userInteraction: z.string().optional(), vectorString: z.string().optional(), version: z.string().optional()}); export const advisoryMCvssV40 = z.object({attackComplexity: z.string().optional(), attackRequirements: z.string().optional(), attackVector: z.string().optional(), automatable: z.string().optional(), baseScore: z.number().optional(), baseSeverity: z.string().optional(), privilegesRequired: z.string().optional(), providerUrgency: z.string().optional(), recovery: z.string().optional(), safety: z.string().optional(), subAvailabilityImpact: z.string().optional(), subConfidentialityImpact: z.string().optional(), subIntegrityImpact: z.string().optional(), userInteraction: z.string().optional(), valueDensity: z.string().optional(), vectorString: z.string().optional(), version: z.string().optional(), vulnAvailabilityImpact: z.string().optional(), vulnConfidentialityImpact: z.string().optional(), vulnIntegrityImpact: z.string().optional(), vulnerabilityResponseEffort: z.string().optional()}); export const advisoryMetricsOther = z.object({content: z.object({}).optional(), type: z.string().optional()}); export const advisoryMetricScenario = z.object({lang: z.string().optional(), value: z.string().optional()}); export const advisoryMetric = z.object({cvssV2_0: advisoryMCvssV20.optional(), cvssV3_0: advisoryMCvssV30.optional(), cvssV3_1: advisoryMCvssV31.optional(), cvssV4_0: advisoryMCvssV40.optional(), format: z.string().optional(), other: advisoryMetricsOther.optional(), scenarios: z.array(advisoryMetricScenario).optional()}); export const advisoryMReference = z.object({name: z.string().optional(), tags: z.array(z.string()).optional(), url: z.string().optional()}); export const advisoryPTMDescriptions = z.object({cweId: z.string().optional(), description: z.string().optional(), lang: z.string().optional(), references: z.array(advisoryMReference).optional(), type: z.string().optional()}); export const advisoryMProblemTypes = z.object({descriptions: z.array(advisoryPTMDescriptions).optional()}); export const advisoryMProviderMetadata = z.object({dateUpdated: z.string().optional(), orgId: z.string().optional(), shortName: z.string().optional()}); export const advisoryTaxonomyRelation = z.object({relationshipName: z.string().optional(), relationshipValue: z.string().optional(), taxonomyId: z.string().optional()}); export const advisoryTaxonomyMapping = z.object({taxonomyName: z.string().optional(), taxonomyRelations: z.array(advisoryTaxonomyRelation).optional(), taxonomyVersion: z.string().optional()}); export const advisoryTimeline = z.object({lang: z.string().optional(), time: z.string().optional(), value: z.string().optional()}); export const advisoryADPContainer = z.object({affected: z.array(advisoryMAffected).optional(), configurations: z.array(advisoryMDescriptions).optional(), cpeApplicability: z.array(advisoryCustomCPE).optional(), credits: z.array(advisoryCredit).optional(), datePublic: z.string().optional(), descriptions: z.array(advisoryMDescriptions).optional(), exploits: z.array(advisoryMDescriptions).optional(), impacts: z.array(advisoryImpact).optional(), metrics: z.array(advisoryMetric).optional(), problemTypes: z.array(advisoryMProblemTypes).optional(), providerMetadata: advisoryMProviderMetadata.optional(), references: z.array(advisoryMReference).optional(), solutions: z.array(advisoryMDescriptions).optional(), source: z.object({}).optional(), tags: z.array(z.string()).optional(), taxonomyMappings: z.array(advisoryTaxonomyMapping).optional(), timeline: z.array(advisoryTimeline).optional(), title: z.string().optional(), workarounds: z.array(advisoryMDescriptions).optional()}); export const advisoryMCna = z.object({affected: z.array(advisoryMAffected).optional(), configurations: z.array(advisoryMDescriptions).optional(), cpeApplicability: z.array(advisoryCustomCPE).optional(), credits: z.array(advisoryCredit).optional(), dateAssigned: z.string().optional(), datePublic: z.string().optional(), descriptions: z.array(advisoryMDescriptions).optional(), exploits: z.array(advisoryMDescriptions).optional(), impacts: z.array(advisoryImpact).optional(), metrics: z.array(advisoryMetric).optional(), problemTypes: z.array(advisoryMProblemTypes).optional(), providerMetadata: advisoryMProviderMetadata.optional(), references: z.array(advisoryMReference).optional(), rejectedReasons: z.array(advisoryMDescriptions).optional(), replacedBy: z.array(z.string()).optional(), solutions: z.array(advisoryMDescriptions).optional(), source: z.object({}).optional(), tags: z.array(z.string()).optional(), taxonomyMappings: z.array(advisoryTaxonomyMapping).optional(), timeline: z.array(advisoryTimeline).optional(), title: z.string().optional(), workarounds: z.array(advisoryMDescriptions).optional()}); export const advisoryMContainers = z.object({adp: z.array(advisoryADPContainer).optional(), cna: advisoryMCna.optional()}); export const advisoryMCveMetadata = z.object({assignerOrgId: z.string().optional(), assignerShortName: z.string().optional(), cveId: z.string().optional(), datePublished: z.string().optional(), dateRejected: z.string().optional(), dateReserved: z.string().optional(), dateUpdated: z.string().optional(), requesterUserId: z.string().optional(), serial: z.number().int().optional(), state: z.string().optional()}); export const advisoryMitreCVEListV5Ref = z.object({containers: advisoryMContainers.optional(), cveMetadata: advisoryMCveMetadata.optional(), dataType: z.string().optional(), dataVersion: z.string().optional()}); export const searchV4AdvisoryReturnValue = z.object({_meta: searchV4AdvisoryMeta.optional(), data: z.array(advisoryMitreCVEListV5Ref).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 }; /** * Query advisories * * GET /advisory */ export const getApiAdvisory = async (args: GetApiAdvisoryArgs, options: GetApiAdvisoryOptions) => { const {baseUrl, fetch: fetchFn = fetch, Bearer} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.name != null) query.append("name", String(args.name)) if (args.cve_id != null) query.append("cve_id", String(args.cve_id)) if (args.vendor != null) query.append("vendor", String(args.vendor)) if (args.product != null) query.append("product", String(args.product)) if (args.platform != null) query.append("platform", String(args.platform)) if (args.version != null) query.append("version", String(args.version)) if (args.cpe != null) query.append("cpe", String(args.cpe)) if (args.package_name != null) query.append("package_name", String(args.package_name)) if (args.purl != null) query.append("purl", String(args.purl)) if (args.reference_url != null) query.append("reference_url", String(args.reference_url)) if (args.reference_tag != null) query.append("reference_tag", String(args.reference_tag)) if (args.description_lang != null) query.append("description_lang", String(args.description_lang)) if (args.updatedAfter != null) query.append("updatedAfter", String(args.updatedAfter)) if (args.updatedBefore != null) query.append("updatedBefore", String(args.updatedBefore)) if (args.page != null) query.append("page", String(args.page)) if (args.limit != null) query.append("limit", String(args.limit)) if (args.start_cursor != null) query.append("start_cursor", String(args.start_cursor)) if (args.cursor != null) query.append("cursor", String(args.cursor)) if (Bearer !== undefined) headers.set("Authorization", Bearer) const url = `${baseUrl.replace(/\/+$/, '')}/advisory${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(searchV4AdvisoryReturnValue, await res.json()) };