import {z} from 'zod' export type GetApiVendorArgs = {id?: number | undefined, hostname?: string | undefined, generate_ad_hoc_report?: boolean | undefined, start_monitoring?: boolean | undefined, labels?: Array | undefined, tier?: number | undefined, wait_for_scan?: boolean | undefined}; export type GetApiVendorOptions = {baseUrl?: string | undefined, APIKeyInHeader?: string | undefined, fetch?: typeof fetch | undefined}; export const categoryScores = z.object({attackSurface: z.number().int().optional(), brandProtection: z.number().int().optional(), brandReputation: z.number().int().optional(), dataLeakage: z.number().int().optional(), dns: z.number().int().optional(), emailSecurity: z.number().int().optional(), encryption: z.number().int().optional(), ipDomainReputation: z.number().int().optional(), networkSecurity: z.number().int().optional(), operationalRisk: z.number().int().optional(), phishing: z.number().int().optional(), questionnaires: z.number().int().optional(), vulnerabilityManagement: z.number().int().optional(), websiteSecurity: z.number().int().optional()}); export const riskCounts = z.object({critical: z.number().int().optional(), high: z.number().int().optional(), low: z.number().int().optional(), medium: z.number().int().optional()}); export const categoryRiskCounts = z.object({attack_surface: riskCounts.optional(), brand_protection: riskCounts.optional(), brand_reputation: riskCounts.optional(), data_leakage: riskCounts.optional(), dns: riskCounts.optional(), email_security: riskCounts.optional(), encryption: riskCounts.optional(), ip_domain_reputation: riskCounts.optional(), network_security: riskCounts.optional(), operational_risk: riskCounts.optional(), phishing: riskCounts.optional(), questionnaires: riskCounts.optional(), vulnerability_management: riskCounts.optional(), website_security: riskCounts.optional()}); export const scoreByEpoch = z.object({attack_surface: z.number().int().optional(), brand_protection: z.number().int().optional(), brand_reputation: z.number().int().optional(), data_leakage: z.number().int().optional(), dns: z.number().int().optional(), email_security: z.number().int().optional(), encryption: z.number().int().optional(), epoch: z.enum(["now", "1 month ago", "3 months ago", "1 year ago"]).optional(), ip_domain_reputation: z.number().int().optional(), network_security: z.number().int().optional(), operational_risk: z.number().int().optional(), overall: z.number().int().optional(), phishing: z.number().int().optional(), questionnaires: z.number().int().optional(), vulnerability_management: z.number().int().optional(), website_security: z.number().int().optional(), when: z.string().optional()}); export const vendorMetadata = z.object({annual_revenue: z.number().int().optional(), employee_count: z.number().int().optional(), legal_name: z.string().optional(), location_city: z.string().optional(), location_country: z.string().optional(), location_postcode: z.string().optional(), market_cap: z.number().int().optional()}); export const vendor = z.object({assessment_status: z.string().optional(), attributes: z.record(z.string(), z.string()).optional(), automatedScore: z.number().int().optional(), categoryScores: categoryScores.optional(), category_risk_counts: categoryRiskCounts.optional(), domain_count_active: z.number().int().optional(), domain_count_inactive: z.number().int().optional(), domain_count_total: z.number().int().optional(), first_monitored: z.string().optional(), id: z.number().int().optional(), industry_average_score: z.number().int().optional(), industry_group: z.string().optional(), industry_sector: z.string().optional(), labels: z.array(z.string()).optional(), last_assessed: z.string().optional(), lifecycle_stage: z.string().optional(), name: z.string().optional(), note: z.string().optional(), overallScore: z.number().int().optional(), overall_risk_counts: riskCounts.optional(), portfolios: z.array(z.string()).optional(), primary_hostname: z.string().optional(), questionnaireScore: z.number().int().optional(), reassessment_date: z.string().optional(), score: z.number().int().optional(), scores_by_epoch: z.array(scoreByEpoch).optional(), tier: z.number().int().optional(), vendor_metadata: vendorMetadata.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 }; /** * Get vendor details * * GET /vendor */ export const getApiVendor = async (args: GetApiVendorArgs, options?: GetApiVendorOptions) => { 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.id != null) query.append("id", String(args.id)) if (args.hostname != null) query.append("hostname", String(args.hostname)) if (args.generate_ad_hoc_report != null) query.append("generate_ad_hoc_report", String(args.generate_ad_hoc_report)) if (args.start_monitoring != null) query.append("start_monitoring", String(args.start_monitoring)) for (const item of args.labels ?? []) query.append("labels", String(item)) if (args.tier != null) query.append("tier", String(args.tier)) if (args.wait_for_scan != null) query.append("wait_for_scan", String(args.wait_for_scan)) if (APIKeyInHeader !== undefined) headers.set("Authorization", APIKeyInHeader) const url = `${baseUrl.replace(/\/+$/, '')}/vendor${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(vendor, await res.json()) };