import {z} from 'zod' export type CreateApiV3FreeToolsSeoAuditArgs = {body: {url: string}}; export type CreateApiV3FreeToolsSeoAuditOptions = {baseUrl?: string | undefined, bearerAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const createApiV3FreeToolsSeoAuditResponse = z.object({overallScore: z.number().optional(), totalTests: z.number().optional(), passedTests: z.number().optional(), categoryScores: z.record(z.string(), z.unknown()).optional(), url: z.string().optional(), timestamp: z.string().optional(), auditSummary: z.record(z.string(), z.unknown()).optional(), categories: z.object({commonSeoIssues: z.object({name: z.string().optional(), score: z.number().optional(), passed: z.number().optional(), failed: z.number().optional(), warnings: z.number().optional(), issues: z.array(z.object({title: z.string().optional(), description: z.string().optional(), statusText: z.string().optional(), note: z.string().optional(), impact: z.string().optional(), severity: z.string().optional(), status: z.string().optional(), recommendation: z.string().optional(), howToFix: z.string().optional(), bestPractices: z.array(z.string()).optional(), text: z.string().optional(), length: z.number().optional(), moreDetails: z.record(z.string(), z.unknown()).optional()}).and(z.record(z.string(), z.unknown()))).optional()}).and(z.record(z.string(), z.unknown())).optional(), serverSecurity: z.object({name: z.string().optional(), score: z.number().optional(), passed: z.number().optional(), failed: z.number().optional(), warnings: z.number().optional(), issues: z.array(z.object({title: z.string().optional(), description: z.string().optional(), statusText: z.string().optional(), note: z.string().optional(), impact: z.string().optional(), severity: z.string().optional(), status: z.string().optional(), recommendation: z.string().optional(), howToFix: z.string().optional(), bestPractices: z.array(z.string()).optional(), text: z.string().optional(), length: z.number().optional(), moreDetails: z.record(z.string(), z.unknown()).optional()}).and(z.record(z.string(), z.unknown()))).optional()}).and(z.record(z.string(), z.unknown())).optional(), mobileUsability: z.object({name: z.string().optional(), score: z.number().optional(), passed: z.number().optional(), failed: z.number().optional(), warnings: z.number().optional(), issues: z.array(z.object({title: z.string().optional(), description: z.string().optional(), statusText: z.string().optional(), note: z.string().optional(), impact: z.string().optional(), severity: z.string().optional(), status: z.string().optional(), recommendation: z.string().optional(), howToFix: z.string().optional(), bestPractices: z.array(z.string()).optional(), text: z.string().optional(), length: z.number().optional(), moreDetails: z.record(z.string(), z.unknown()).optional()}).and(z.record(z.string(), z.unknown()))).optional()}).and(z.record(z.string(), z.unknown())).optional(), advancedSeo: z.object({name: z.string().optional(), score: z.number().optional(), passed: z.number().optional(), failed: z.number().optional(), warnings: z.number().optional(), issues: z.array(z.object({title: z.string().optional(), description: z.string().optional(), statusText: z.string().optional(), note: z.string().optional(), impact: z.string().optional(), severity: z.string().optional(), status: z.string().optional(), recommendation: z.string().optional(), howToFix: z.string().optional(), bestPractices: z.array(z.string()).optional(), text: z.string().optional(), length: z.number().optional(), moreDetails: z.record(z.string(), z.unknown()).optional()}).and(z.record(z.string(), z.unknown()))).optional()}).and(z.record(z.string(), z.unknown())).optional()}).and(z.record(z.string(), z.unknown())).optional()}).and(z.record(z.string(), z.unknown())); 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 }; /** * Audit Website URL for SEO * * POST /v3/free-tools/seo-audit * * Also accepts auth: apiKey */ export const createApiV3FreeToolsSeoAudit = async (args: CreateApiV3FreeToolsSeoAuditArgs, options?: CreateApiV3FreeToolsSeoAuditOptions) => { const {baseUrl = "https://api.snowseo.com", fetch: fetchFn = fetch, bearerAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") if (bearerAuth !== undefined) headers.set('authorization', `Bearer ${bearerAuth}`) const url = `${baseUrl.replace(/\/+$/, '')}/v3/free-tools/seo-audit${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "POST", headers, body: JSON.stringify(args.body)}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(createApiV3FreeToolsSeoAuditResponse, await res.json()) };