import {z} from 'zod' export type GetApiUgcArgs = {store: string, sku?: string | undefined, tags?: string | undefined, categories?: string | undefined, include_videos?: boolean | undefined, per_page?: number | undefined}; export type GetApiUgcOptions = {baseUrl?: string | undefined, fetch?: typeof fetch | undefined}; export const timelineReviewAttribute = z.object({attribute_id: z.string().optional(), type: z.string().optional(), label: z.string().optional(), options: z.array(z.unknown()).optional(), value: z.string().optional()}); export const ugcTaggedProduct = z.object({sku: z.string().optional(), top: z.number().int().optional(), left: z.number().int().optional(), product: z.object({sku: z.string().optional(), name: z.string().optional(), description: z.string().optional(), link: z.string().optional(), image_url: z.string().optional(), price: z.string().optional(), rating: z.string().optional(), review_count: z.string().optional()}).optional()}); export const timelineReviewReply = z.object({comments: z.string().optional(), date_created: z.string().optional(), author: z.object({name: z.string().optional(), avatar: z.string().optional()}).optional()}); export const ugcItem = z.object({type: z.string().optional(), type_label: z.string().optional(), source: z.string().optional(), rating: z.number().int().optional(), comments: z.string().optional(), author: z.string().optional(), date_created: z.string().optional(), order_id: z.string().optional(), sku: z.string().optional(), helpful_count: z.string().optional(), is_video: z.number().int().optional(), image_raw: z.string().optional(), image_sm: z.string().optional(), image_md: z.string().optional(), image_lg: z.string().optional(), attributes: z.array(timelineReviewAttribute).optional(), tagged_products: z.array(ugcTaggedProduct).optional(), replies: z.array(timelineReviewReply).optional()}); export const ugcResponse = z.object({ugc: z.array(ugcItem).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 }; /** * Retrieve User Generated Content * * GET /ugc */ export const getApiUgc = async (args: GetApiUgcArgs, options?: GetApiUgcOptions) => { const {baseUrl = "https://api.reviews.io", fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.store != null) query.append("store", String(args.store)) if (args.sku != null) query.append("sku", String(args.sku)) if (args.tags != null) query.append("tags", String(args.tags)) if (args.categories != null) query.append("categories", String(args.categories)) if (args.include_videos != null) query.append("include_videos", String(args.include_videos)) if (args.per_page != null) query.append("per_page", String(args.per_page)) const url = `${baseUrl.replace(/\/+$/, '')}/ugc${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(ugcResponse, await res.json()) };