Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 11x 11x 1x 1x 1x 9x 9x 7x 7x 2x 9x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 15x 15x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 20x 20x | import * as v from 'valibot';
/**
* Minimal shape every Wix product must satisfy for the supplier to consume it.
* Only the fields actually read while building a product are required — the
* Wix response carries many more, but they are optional from our perspective.
* `media` and `additionalInfo` (read for image/SDS/chemical properties) are
* validated only as arrays — like `productItems`/`options`, their per-item
* shape is guarded at the point of use so a stray entry can't reject the whole
* response — and stay optional since a product may legitimately carry none.
*/
const wixProductSchema = v.object({
id: v.string(),
name: v.string(),
description: v.string(),
sku: v.string(),
urlPart: v.string(),
price: v.number(),
formattedPrice: v.string(),
productItems: v.array(v.unknown()),
options: v.array(v.unknown()),
media: v.optional(v.array(v.unknown())),
additionalInfo: v.optional(v.array(v.unknown())),
});
const validSearchResponseSchema = v.object({
data: v.object({
catalog: v.object({
category: v.object({
productsWithMetaData: v.object({
totalCount: v.number(),
list: v.array(wixProductSchema),
}),
}),
}),
}),
});
/**
* Type guard to validate if a response matches the Wix QueryResponse structure.
* Performs deep validation of the response object including the nested catalog structure,
* products metadata, and ensures all products in the list are valid Wix products.
*
* @category Typeguards
* @param response - Response object to validate
* @returns Type predicate indicating if response is a valid QueryResponse
* @example
* ```typescript
* // Valid search response
* const validResponse = {
* data: {
* catalog: {
* category: {
* productsWithMetaData: {
* totalCount: 1,
* list: [
* {
* price: 29.99,
* formattedPrice: "$29.99",
* name: "Sodium Chloride",
* urlPart: "sodium-chloride",
* productItems: [],
* options: []
* }
* ]
* }
* }
* }
* }
* };
*
* if (isValidSearchResponse(validResponse)) {
* console.log("Valid search response");
* const firstProduct = validResponse.data.catalog.category.productsWithMetaData.list[0];
* console.log("First product:", firstProduct.name);
* }
* ```
* @source
*/
export function isValidSearchResponse(response: unknown): response is QueryResponse {
return v.safeParse(validSearchResponseSchema, response).success;
}
/**
* Type guard to validate if an object is a valid Wix ProductObject.
* Checks for the presence and correct types of all required product properties
* including price, name, URL, and validates all product items and options.
*
* @category Typeguards
* @param product - Object to validate as ProductObject
* @returns Type predicate indicating if product is a valid ProductObject
* @example
* ```typescript
* // Valid product object
* const validProduct = {
* id: "prod_123",
* name: "Sodium Chloride",
* description: "ACS reagent grade",
* sku: "NACL-500",
* urlPart: "sodium-chloride",
* price: 29.99,
* formattedPrice: "$29.99",
* productItems: [
* {
* id: "item_123",
* formattedPrice: "$29.99",
* price: 29.99,
* optionsSelections: [1]
* }
* ],
* options: [
* {
* selections: [
* { id: "opt_1", value: "500g", description: "500g Bottle", key: "size", inStock: true }
* ]
* }
* ]
* };
*
* if (isWixProduct(validProduct)) {
* console.log("Valid product:", validProduct.name);
* console.log("Price:", validProduct.formattedPrice);
* }
* ```
* @source
*/
export function isWixProduct(product: unknown): product is ProductObject {
const parsed = v.safeParse(wixProductSchema, product);
if (!parsed.success) {
return false;
}
const p = parsed.output;
if (!p.productItems.every((item) => isProductItem(item))) {
return false;
}
if (p.options.length > 0) {
const firstOption = p.options[0] as { selections?: unknown[] };
if (!firstOption?.selections?.every((s) => isProductSelection(s))) {
return false;
}
}
return true;
}
const productItemSchema = v.object({
id: v.string(),
formattedPrice: v.string(),
price: v.number(),
optionsSelections: v.pipe(v.array(v.number()), v.minLength(1)),
});
/**
* Type guard to validate if an object is a valid Wix ProductItem.
* Checks for the presence and correct types of all required item properties
* including ID, price, and ensures optionsSelections is a non-empty array.
*
* @category Typeguards
* @param item - Object to validate as ProductItem
* @returns Type predicate indicating if item is a valid ProductItem
* @example
* ```typescript
* // Valid product item
* const validItem = {
* id: "item_123",
* formattedPrice: "$29.99",
* price: 29.99,
* optionsSelections: [1]
* };
*
* if (isProductItem(validItem)) {
* console.log("Valid product item:", validItem.id);
* console.log("Price:", validItem.formattedPrice);
* }
* ```
* @source
*/
export function isProductItem(item: unknown): item is ProductItem {
return v.safeParse(productItemSchema, item).success;
}
const productSelectionSchema = v.object({
id: v.union([v.string(), v.number()]),
value: v.string(),
description: v.string(),
key: v.string(),
inStock: v.union([v.boolean(), v.null_()]),
});
/**
* Type guard to validate if an object is a valid Wix ProductSelection.
* Checks for the presence and correct types of all required selection properties
* including ID (which can be string or number), value, description, key, and inStock.
*
* @category Typeguards
* @param selection - Object to validate as ProductSelection
* @returns Type predicate indicating if selection is a valid ProductSelection
* @example
* ```typescript
* // Valid product selection (string ID)
* const validSelection = {
* id: "opt_1",
* value: "500g",
* description: "500g Bottle",
* key: "size",
* inStock: true
* };
*
* if (isProductSelection(validSelection)) {
* console.log("Valid selection:", validSelection.value);
* console.log("In stock:", validSelection.inStock);
* }
* ```
* @source
*/
export function isProductSelection(selection: unknown): selection is ProductSelection {
return v.safeParse(productSelectionSchema, selection).success;
}
|