import {z} from 'zod' export type GetApiProductsArgs = {page?: number | undefined, per_page?: number | undefined, search?: string | undefined, category?: string | undefined, tag?: string | undefined, type?: ('simple' | 'grouped' | 'external' | 'variable') | undefined, featured?: boolean | undefined, on_sale?: boolean | undefined, min_price?: string | undefined, max_price?: string | undefined, stock_status?: ('instock' | 'outofstock' | 'onbackorder') | undefined, orderby?: ('date' | 'id' | 'include' | 'title' | 'slug' | 'price' | 'popularity' | 'rating' | 'menu_order' | 'alphabetical' | 'reverse_alpha' | 'relevance' | 'rand' | 'by_stock' | 'review_count' | 'on_sale_first' | 'featured_first' | 'price_asc' | 'price_desc' | 'sales') | undefined, order?: ('ASC' | 'DESC') | undefined, slug?: string | undefined, after?: string | undefined, before?: string | undefined, sku?: string | undefined, hide_free?: boolean | undefined, category_operator?: ('in' | 'not_in' | 'and') | undefined, tag_operator?: ('in' | 'not_in' | 'and') | undefined, brand?: string | undefined, brand_operator?: ('in' | 'not_in' | 'and') | undefined, show_reviews?: boolean | undefined, return_variations?: boolean | undefined, attribute_relation?: ('in' | 'and') | undefined, catalog_visibility?: ('any' | 'visible' | 'catalog' | 'search' | 'hidden') | undefined, rating?: (Array<1 | 2 | 3 | 4 | 5>) | undefined, offset?: number | undefined, include?: Array | undefined, exclude?: Array | undefined, parent?: Array | undefined, parent_exclude?: Array | undefined}; export type GetApiProductsOptions = {baseUrl?: string | undefined, fetch?: typeof fetch | undefined}; export const currency = z.object({currency_code: z.string().optional(), currency_symbol: z.string().optional(), currency_symbol_pos: z.string().optional(), currency_minor_unit: z.number().int().optional(), currency_decimal_separator: z.string().optional(), currency_thousand_separator: z.string().optional(), currency_prefix: z.string().optional(), currency_suffix: z.string().optional()}); export const productImage = z.object({id: z.number().int().optional(), src: z.record(z.string(), z.string()).optional(), name: z.string().optional(), alt: z.string().optional(), position: z.number().int().optional(), featured: z.boolean().optional()}); export const productCategory = z.object({id: z.number().int().optional(), name: z.string().optional(), slug: z.string().optional(), rest_url: z.string().optional()}); export const productTag = z.object({id: z.number().int().optional(), name: z.string().optional(), slug: z.string().optional(), rest_url: z.string().optional()}); export const productAttribute = z.object({id: z.number().int().optional(), name: z.string().optional(), position: z.number().int().optional(), visible: z.boolean().optional(), variation: z.boolean().optional(), options: z.array(z.string()).optional()}); export const productDefaultAttribute = z.object({id: z.number().int().optional(), name: z.string().optional(), option: z.string().optional()}); export const productVariation = z.object({id: z.number().int().optional(), parent_id: z.number().int().optional(), name: z.string().optional(), slug: z.string().optional(), permalink: z.string().optional(), sku: z.string().optional(), description: z.string().optional(), dates: z.object({created: z.string().optional(), created_gmt: z.string().optional(), modified: z.string().optional(), modified_gmt: z.string().optional()}).optional(), featured: z.boolean().optional(), prices: z.object({price: z.string().optional(), regular_price: z.string().optional(), sale_price: z.string().optional(), price_range: z.object({}).nullable().optional(), on_sale: z.boolean().optional(), date_on_sale: z.object({from: z.string().nullable().optional(), from_gmt: z.string().nullable().optional(), to: z.string().nullable().optional(), to_gmt: z.string().nullable().optional()}).optional(), currency: currency.optional()}).optional(), hidden_conditions: z.object({virtual: z.boolean().optional(), downloadable: z.boolean().optional(), manage_stock: z.boolean().optional(), sold_individually: z.boolean().optional(), shipping_required: z.boolean().optional()}).optional(), images: z.array(productImage).optional(), categories: z.array(productCategory).optional(), tags: z.array(productTag).optional(), attributes: z.array(productAttribute).optional(), stock: z.object({is_in_stock: z.boolean().optional(), stock_quantity: z.number().int().nullable().optional(), stock_status: z.enum(["instock", "outofstock", "onbackorder"]).optional(), backorders: z.enum(["no", "notify", "yes"]).optional(), backorders_allowed: z.boolean().optional(), backordered: z.boolean().optional(), low_stock_amount: z.number().int().nullable().optional()}).optional(), weight: z.object({value: z.string().nullable().optional(), unit: z.string().optional()}).optional(), dimensions: z.object({length: z.string().nullable().optional(), width: z.string().nullable().optional(), height: z.string().nullable().optional(), unit: z.string().optional()}).optional(), total_sales: z.number().int().optional(), add_to_cart: z.object({text: z.string().optional(), description: z.string().optional(), is_purchasable: z.boolean().optional(), purchase_quantity: z.object({min_purchase: z.number().int().optional(), max_purchase: z.number().int().optional()}).optional(), rest_url: z.string().optional()}).optional(), meta_data: z.array(z.object({key: z.string().optional(), value: z.string().optional()})).optional()}); export const productReview = z.object({id: z.number().int().optional(), date_created: z.string().optional(), date_created_gmt: z.string().optional(), product_id: z.number().int().optional(), status: z.string().optional(), reviewer: z.string().optional(), reviewer_email: z.string().optional(), review: z.string().optional(), rating: z.number().int().optional(), verified: z.boolean().optional()}); export const connectedProduct = z.object({id: z.number().int().optional(), name: z.string().optional(), permalink: z.string().optional(), price: z.string().optional(), add_to_cart: z.object({text: z.string().optional(), description: z.string().optional(), rest_url: z.string().optional()}).optional(), rest_url: z.string().optional()}); export const product = z.object({id: z.number().int().optional(), parent_id: z.number().int().optional(), name: z.string().optional(), type: z.enum(["simple", "grouped", "external", "variable"]).optional(), slug: z.string().optional(), permalink: z.string().optional(), sku: z.string().optional(), description: z.string().optional(), short_description: z.string().optional(), dates: z.object({created: z.string().optional(), created_gmt: z.string().optional(), modified: z.string().optional(), modified_gmt: z.string().optional()}).optional(), featured: z.boolean().optional(), prices: z.object({price: z.string().optional(), regular_price: z.string().optional(), sale_price: z.string().optional(), price_range: z.object({}).nullable().optional(), on_sale: z.boolean().optional(), date_on_sale: z.object({from: z.string().nullable().optional(), from_gmt: z.string().nullable().optional(), to: z.string().nullable().optional(), to_gmt: z.string().nullable().optional()}).optional(), currency: currency.optional()}).optional(), hidden_conditions: z.object({virtual: z.boolean().optional(), downloadable: z.boolean().optional(), manage_stock: z.boolean().optional(), sold_individually: z.boolean().optional(), reviews_allowed: z.boolean().optional(), shipping_required: z.boolean().optional()}).optional(), average_rating: z.string().optional(), review_count: z.number().int().optional(), rating_count: z.number().int().optional(), rated_out_of: z.string().optional(), images: z.array(productImage).optional(), categories: z.array(productCategory).optional(), tags: z.array(productTag).optional(), attributes: z.array(productAttribute).optional(), default_attributes: z.array(productDefaultAttribute).optional(), variations: z.array(productVariation).optional(), grouped_products: z.array(z.number().int()).optional(), stock: z.object({is_in_stock: z.boolean().optional(), stock_quantity: z.number().int().nullable().optional(), stock_status: z.enum(["instock", "outofstock", "onbackorder"]).optional(), backorders: z.enum(["no", "notify", "yes"]).optional(), backorders_allowed: z.boolean().optional(), backordered: z.boolean().optional(), low_stock_amount: z.number().int().nullable().optional()}).optional(), weight: z.object({value: z.string().nullable().optional(), unit: z.string().optional()}).optional(), dimensions: z.object({length: z.string().nullable().optional(), width: z.string().nullable().optional(), height: z.string().nullable().optional(), unit: z.string().optional()}).optional(), reviews: z.array(productReview).optional(), related: z.array(connectedProduct).optional(), upsells: z.array(connectedProduct).optional(), cross_sells: z.array(connectedProduct).optional(), total_sales: z.number().int().optional(), external_url: z.string().optional(), button_text: z.string().optional(), add_to_cart: z.object({text: z.string().optional(), description: z.string().optional(), has_options: z.boolean().optional(), is_purchasable: z.boolean().optional(), purchase_quantity: z.object({min_purchase: z.number().int().optional(), max_purchase: z.number().int().optional()}).optional(), rest_url: z.string().optional()}).optional(), meta_data: z.array(z.object({key: z.string().optional(), value: z.string().optional()})).optional()}); export const productsResponse = z.object({products: z.array(product).optional(), page: z.number().int().optional(), total_pages: z.number().int().optional(), total_products: z.number().int().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 products * * GET /products */ export const getApiProducts = async (args: GetApiProductsArgs, options?: GetApiProductsOptions) => { const {baseUrl = "https://example-store.com", fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.page != null) query.append("page", String(args.page)) if (args.per_page != null) query.append("per_page", String(args.per_page)) if (args.search != null) query.append("search", String(args.search)) if (args.category != null) query.append("category", String(args.category)) if (args.tag != null) query.append("tag", String(args.tag)) if (args.type != null) query.append("type", String(args.type)) if (args.featured != null) query.append("featured", String(args.featured)) if (args.on_sale != null) query.append("on_sale", String(args.on_sale)) if (args.min_price != null) query.append("min_price", String(args.min_price)) if (args.max_price != null) query.append("max_price", String(args.max_price)) if (args.stock_status != null) query.append("stock_status", String(args.stock_status)) if (args.orderby != null) query.append("orderby", String(args.orderby)) if (args.order != null) query.append("order", String(args.order)) if (args.slug != null) query.append("slug", String(args.slug)) if (args.after != null) query.append("after", String(args.after)) if (args.before != null) query.append("before", String(args.before)) if (args.sku != null) query.append("sku", String(args.sku)) if (args.hide_free != null) query.append("hide_free", String(args.hide_free)) if (args.category_operator != null) query.append("category_operator", String(args.category_operator)) if (args.tag_operator != null) query.append("tag_operator", String(args.tag_operator)) if (args.brand != null) query.append("brand", String(args.brand)) if (args.brand_operator != null) query.append("brand_operator", String(args.brand_operator)) if (args.show_reviews != null) query.append("show_reviews", String(args.show_reviews)) if (args.return_variations != null) query.append("return_variations", String(args.return_variations)) if (args.attribute_relation != null) query.append("attribute_relation", String(args.attribute_relation)) if (args.catalog_visibility != null) query.append("catalog_visibility", String(args.catalog_visibility)) for (const item of args.rating ?? []) query.append("rating", String(item)) if (args.offset != null) query.append("offset", String(args.offset)) for (const item of args.include ?? []) query.append("include", String(item)) for (const item of args.exclude ?? []) query.append("exclude", String(item)) for (const item of args.parent ?? []) query.append("parent", String(item)) for (const item of args.parent_exclude ?? []) query.append("parent_exclude", String(item)) const url = `${baseUrl.replace(/\/+$/, '')}/products${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(productsResponse, await res.json()) };