@asstio-dev/storefront 0.3.0 → 0.6.0

package/README.md

@@ -75,6 +75,60 @@ for (const file of product?.files ?? []) console.log(file.filename, fileUrl(site
 // A variant with hasOwnImages: false inherits: variant.hasOwnImages ? variant.images : product.images
 ```
 
+`videoSources` returns `[]` for anything that is not a video, while `mediaUrl`/`pictureSources`/`fileUrl`/`posterUrl`
+throw `MediaUrlError` when the descriptor cannot produce that URL — branch on `kind` before calling.
+
+### Product content
+
+`description` is **already sanitized** on the server: render `description.html` as-is — do not sanitize, escape or
+re-parse it — and use `description.text` wherever you need plain text (a meta description, a snippet, an
+`aria-label`). `shortDescription` is plain text. `brand.facet` is set when the brand shares a facet's source, so it
+can link straight to a filtered listing; when it is `null`, render `brand.label` as plain text and never guess a
+filter.
+
+`attributes[]` arrives ordered and labelled for display. Branch on `type` (`text` | `html` | `number` | `bool` |
+`list`): a list fills `values`, everything else fills `value`, and `html` fills `html` too — sanitized exactly like
+`description.html`.
+
+```ts
+if (product.description) render(product.description.html); // as-is: sanitized server-side
+for (const a of product.attributes) {
+  if (a.type === "html") render(a.html!);          // sanitized like description.html
+  else if (a.values) render(a.values.join(", "));  // type: "list"
+  else render(a.value!);                           // text | number | bool
+}
+```
+
+`facetKey` and `valueKeys` turn an attribute's values into filter links — `filter[facetKey]=valueKeys[i]`, aligned
+index-for-index with `values` (or carrying the single `value`'s key). `valueKeys` is absent entirely when any one
+value has no key of its own: a list is either fully linkable or not linkable at all.
+
+`related[]` holds groups of cards already resolved for this market, and `bundle.components[]` the cards a bundle is
+made of; both leave out anything that no longer exists or is not sold here.
+
+### Search-as-you-type and search-in-facet
+
+`/v1/search/suggest` answers three short lists for what the shopper has typed so far: up to 5 product cards
+(matched on the product name), 5 categories (each with the `path` to show above it) and 10 values from the facets
+whose panel is searchable. `q` is required and 1–100 characters — blank, missing or longer is a 400
+(`INVALID_QUERY`), not a truncation the way a listing's `q` is.
+
+`/v1/products/facets/{key}` is the search box inside one facet panel: the facet's values with the counts they have
+in the same `filter[…]` context the listing is showing, so a count is what selecting that value would leave. Send
+the panel's own filters with it, and omit `q` for the values as they are.
+
+```ts
+const { data: suggestions } = await storefront.GET("/v1/search/suggest", { params: { query: { q: typed } } });
+const { data: brands } = await storefront.GET("/v1/products/facets/{key}", {
+  params: { path: { key: "varumarke" }, query: { q: typed, filter: filterQuery({ kon: ["dam"] }) } },
+});
+```
+
+The endpoint reads the facet's **1000 most common values** and matches `q` against those — label contains,
+case-insensitively, or key prefix — returning at most 50. A facet with more distinct values than that is searched
+over its top 1000; no regular expression ever reaches the search index. `key` has to be a `list` or `swatch` facet:
+an unknown key is `FACET_NOT_FOUND` (404), and a range or toggle facet is `FACET_NOT_SEARCHABLE` (400).
+
 ## Headers
 
 Every call the client makes carries these; you never set them by hand.
@@ -115,7 +169,8 @@ Every operation documents `400`, `401`, `403`, `404`, `429` and `503`; the entit
 Codes you will meet: `SITE_KEY_MISSING`, `SITE_KEY_INVALID`, `SITE_INACTIVE`, `SECRET_KEY_FROM_BROWSER`,
 `SITE_REGISTRY_WARMING`, `MARKET_UNKNOWN`, `RATE_LIMITED` (with `retryAfterSeconds`, plus a `Retry-After`
 header), `PRODUCT_NOT_FOUND`, `COLLECTION_NOT_FOUND`, `INVALID_PAGE`, `INVALID_SINCE`, `INVALID_TYPE`,
-`INDEX_UNAVAILABLE` (retry — a preview index is being rebuilt), `NOT_FOUND`.
+`INDEX_UNAVAILABLE` (retry — a preview index is being rebuilt), `NOT_FOUND`, `INVALID_QUERY`,
+`FACET_NOT_FOUND`, `FACET_NOT_SEARCHABLE`.
 
 `SITE_REGISTRY_WARMING` and `INDEX_UNAVAILABLE` are retries, not bugs in your call.
 
@@ -135,11 +190,21 @@ goes blank because of a bad query string:
 
 `q`, `page`, `pageSize`, `sort` and `filter` are all in the contract, so they are typed and autocompleted.
 `filter` is a `deepObject`: `{ brand: "dior,chanel" }` goes out as `filter[brand]=dior,chanel`, which is the
-form the API reads. `filterQuery()` is a thin helper that joins multi-select values and drops `undefined` ones.
+form the API reads. In a list, swatch or hierarchy filter `,` separates values, `\,` is a comma inside a value and
+`\\` a backslash — value keys are raw values, and an option such as `14,2` is the key `14,2`. Never join or split a
+filter parameter yourself: `encodeFilterValues(values)` builds one and `decodeFilterValues(param)` reads one (for
+the selected state of a URL you parse), for every facet alike. `filterQuery()` uses `encodeFilterValues` for
+multi-select arrays, passes a single string (a range `100-500`, a toggle `true`) as given and drops `undefined` ones.
+A range is `min-max`: either bound may be left out and either may be negative — `-10--2`, `-10-2`, `-10-` (at least
+−10), `--2` (at most −2) — and a leading dash with nothing before it keeps its meaning, `-500` is "at most 500". A
+range whose lower bound is above its upper bound is ignored with a warning.
 
 `/v1/sitemap` takes `type` (`product` | `collection`), `since` (ISO-8601, inclusive), `page` and `pageSize`
 (max 1000, default 500).
 
+`/v1/search/suggest` takes `q` only, and `/v1/products/facets/{key}` takes `q` plus the same `filter` object as a
+listing — both are described under [Search-as-you-type and search-in-facet](#search-as-you-type-and-search-in-facet).
+
 ## Caching
 
 Read responses carry an `ETag` and `Vary: X-Site-Key, X-Market, Accept-Language` — the answer depends on

package/dist/filters.d.ts

@@ -0,0 +1,12 @@
+/**
+ * The list grammar of a `filter[<key>]` parameter (list, swatch and hierarchy facets): `,` separates values, `\,` is a
+ * comma inside a value and `\\` a backslash. A value key is the raw value — an option such as "14,2" is the key "14,2" —
+ * so a frontend never joins or splits a filter parameter by hand: it builds and toggles filter URLs with these two, for
+ * every facet alike. Range (`min-max`) and toggle (`true`) parameters are single strings and need neither.
+ */
+export declare function encodeFilterValues(values: readonly string[]): string;
+/**
+ * The values a `filter[<key>]` parameter selects, read the way the API reads it: `\,` and `\\` unescaped, a backslash
+ * before anything else (or at the end) kept as it is, values trimmed, empty ones and repeats dropped.
+ */
+export declare function decodeFilterValues(param: string): string[];

package/dist/filters.js

@@ -0,0 +1,39 @@
+/**
+ * The list grammar of a `filter[<key>]` parameter (list, swatch and hierarchy facets): `,` separates values, `\,` is a
+ * comma inside a value and `\\` a backslash. A value key is the raw value — an option such as "14,2" is the key "14,2" —
+ * so a frontend never joins or splits a filter parameter by hand: it builds and toggles filter URLs with these two, for
+ * every facet alike. Range (`min-max`) and toggle (`true`) parameters are single strings and need neither.
+ */
+export function encodeFilterValues(values) {
+    return values.map((v) => v.replace(/\\/g, "\\\\").replace(/,/g, "\\,")).join(",");
+}
+/**
+ * The values a `filter[<key>]` parameter selects, read the way the API reads it: `\,` and `\\` unescaped, a backslash
+ * before anything else (or at the end) kept as it is, values trimmed, empty ones and repeats dropped.
+ */
+export function decodeFilterValues(param) {
+    const values = [];
+    let current = "";
+    const push = () => {
+        const value = current.trim();
+        current = "";
+        if (value.length > 0 && !values.includes(value))
+            values.push(value);
+    };
+    for (let i = 0; i < param.length; i++) {
+        const c = param[i];
+        const next = param[i + 1];
+        if (c === "\\" && (next === "," || next === "\\")) {
+            current += next;
+            i++;
+        }
+        else if (c === ",") {
+            push();
+        }
+        else {
+            current += c;
+        }
+    }
+    push();
+    return values;
+}

package/dist/index.d.ts

@@ -38,10 +38,12 @@ export declare function createStorefrontClient(opts: StorefrontClientOptions): C
 /** The `filter` query parameter of a listing call: one facet key to one value, as the generated types spell it. */
 export type FilterSelection = NonNullable<NonNullable<paths["/v1/products"]["get"]["parameters"]["query"]>["filter"]>;
 /**
- * Collapse a facet selection into the typed `filter` object: several values for one facet are comma-separated,
- * and `undefined` facets drop out — so an unchecked checkbox needs no special case at the call site.
+ * Collapse a facet selection into the typed `filter` object: several values for one facet are encoded with
+ * `encodeFilterValues` (so a value containing a comma or a backslash survives), a single string is sent as given (a
+ * range "100-500", a toggle "true"), and `undefined` facets drop out — an unchecked checkbox needs no special case.
  * `{ brand: ["dior", "chanel"], price: "100-500", size: undefined }` → `{ brand: "dior,chanel", price: "100-500" }`.
  * The client sends it as `filter[brand]=dior,chanel` (deepObject), which is what the API reads.
  */
 export declare function filterQuery(selection: Record<string, string | string[] | undefined>): FilterSelection;
+export { decodeFilterValues, encodeFilterValues } from "./filters.js";
 export { fileUrl, mediaHash, mediaUrl, MediaUrlError, pickWidth, pictureSources, posterUrl, srcSet, videoSources, type MediaConfig, type MediaDescriptor, type PictureSources, type VideoSource, } from "./media.js";

package/dist/index.js

@@ -1,4 +1,5 @@
 import createClient from "openapi-fetch";
+import { encodeFilterValues } from "./filters.js";
 /** Thin typed client: every call carries X-Site-Key / X-Market / Accept-Language. Works in browsers and on the server. */
 export function createStorefrontClient(opts) {
     const client = createClient({ baseUrl: opts.baseUrl.replace(/\/$/, ""), fetch: opts.fetch });
@@ -18,8 +19,9 @@ export function createStorefrontClient(opts) {
     return client;
 }
 /**
- * Collapse a facet selection into the typed `filter` object: several values for one facet are comma-separated,
- * and `undefined` facets drop out — so an unchecked checkbox needs no special case at the call site.
+ * Collapse a facet selection into the typed `filter` object: several values for one facet are encoded with
+ * `encodeFilterValues` (so a value containing a comma or a backslash survives), a single string is sent as given (a
+ * range "100-500", a toggle "true"), and `undefined` facets drop out — an unchecked checkbox needs no special case.
  * `{ brand: ["dior", "chanel"], price: "100-500", size: undefined }` → `{ brand: "dior,chanel", price: "100-500" }`.
  * The client sends it as `filter[brand]=dior,chanel` (deepObject), which is what the API reads.
  */
@@ -28,8 +30,9 @@ export function filterQuery(selection) {
     for (const [key, value] of Object.entries(selection)) {
         if (value === undefined)
             continue;
-        out[key] = Array.isArray(value) ? value.join(",") : value;
+        out[key] = Array.isArray(value) ? encodeFilterValues(value) : value;
     }
     return out;
 }
+export { decodeFilterValues, encodeFilterValues } from "./filters.js";
 export { fileUrl, mediaHash, mediaUrl, MediaUrlError, pickWidth, pictureSources, posterUrl, srcSet, videoSources, } from "./media.js";

package/dist/schema.d.ts

@@ -153,6 +153,23 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/products/facets/{key}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Search within a facet: values whose label matches q, counted in this request's filter[...] context (spelled as on /products). Free text and collections are not applied. */
+        get: operations["SearchFacetValues"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/products/{slugOrId}": {
         parameters: {
             query?: never;
@@ -187,6 +204,23 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/search/suggest": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Search-as-you-type: products by name prefix, categories and facet values whose label starts with q. Market, assortment and language as /products. */
+        get: operations["Suggest"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/site": {
         parameters: {
             query?: never;
@@ -235,6 +269,27 @@ export interface components {
             label: string;
             value: string;
         };
+        AttributeDto: {
+            facetKey: null | string;
+            html: null | string;
+            key: string;
+            label: string;
+            type: string;
+            value: null | string;
+            valueKeys: string[] | null;
+            values: string[] | null;
+        };
+        BrandDto: {
+            facet: null | components["schemas"]["FacetLinkDto"];
+            label: string;
+        };
+        BundleComponentDto: {
+            product: components["schemas"]["ProductCardDto"];
+            quantity: string;
+        };
+        BundleDto: {
+            components: components["schemas"]["BundleComponentDto"][];
+        };
         CartDto: {
             currency: string;
             grandTotalInc: string;
@@ -251,10 +306,22 @@ export interface components {
             id: string;
             image: null | components["schemas"]["MediaDescriptorDto"];
             price: components["schemas"]["PriceDto"];
-            productId: string;
+            product: components["schemas"]["CartLineProductDto"];
             /** Format: int32 */
             quantity: number | string;
             sku: string;
+            variant: components["schemas"]["CartLineVariantDto"];
+        };
+        CartLineProductDto: {
+            id: string;
+            name: string;
+            slug: string;
+        };
+        CartLineVariantDto: {
+            id: string;
+            selectedOptions: {
+                [key: string]: string;
+            };
         };
         CategoryNodeDto: {
             children: components["schemas"]["CategoryNodeDto"][];
@@ -298,7 +365,13 @@ export interface components {
             slug: string;
             url: string;
         };
+        DescriptionDto: {
+            html: string;
+            text: string;
+        };
         FacetDto: {
+            collapsed: boolean;
+            help: null | string;
             key: string;
             label: string;
             match: string;
@@ -308,16 +381,25 @@ export interface components {
             type: string;
             values: components["schemas"]["FacetValueDto"][];
         };
+        FacetLinkDto: {
+            key: string;
+            valueKey: string;
+        };
         FacetValueDto: {
             children: components["schemas"]["FacetValueDto"][] | null;
             /** Format: int64 */
             count: number | string;
+            help: null | string;
             key: string;
             label: string;
             pinned: boolean;
             selected: boolean;
             swatch: null | components["schemas"]["SwatchDto"];
         };
+        FacetValuesResponse: {
+            facet: string;
+            values: components["schemas"]["FacetValueDto"][];
+        };
         ListingResponse: {
             appliedFilters: components["schemas"]["AppliedFilterDto"][];
             facets: components["schemas"]["FacetDto"][];
@@ -414,6 +496,7 @@ export interface components {
             vatRate: string;
         };
         ProductCardDto: {
+            brand: null | components["schemas"]["BrandDto"];
             collections: string[];
             id: string;
             image: null | components["schemas"]["MediaDescriptorDto"];
@@ -421,6 +504,7 @@ export interface components {
             name: string;
             price: null | components["schemas"]["PriceDto"];
             priceVaries: boolean;
+            shortDescription: null | string;
             sku: string;
             slug: string;
             /** Format: date-time */
@@ -431,8 +515,12 @@ export interface components {
             alternateUrls: {
                 [key: string]: string;
             };
+            attributes: components["schemas"]["AttributeDto"][];
+            brand: null | components["schemas"]["BrandDto"];
+            bundle: null | components["schemas"]["BundleDto"];
             categories: components["schemas"]["CategoryRefDto"][];
             collections: components["schemas"]["CollectionRefDto"][];
+            description: null | components["schemas"]["DescriptionDto"];
             files: components["schemas"]["MediaDescriptorDto"][];
             id: string;
             image: null | components["schemas"]["MediaDescriptorDto"];
@@ -441,7 +529,9 @@ export interface components {
             name: string;
             options: components["schemas"]["OptionDto"][];
             redirectTo: null | string;
+            related: components["schemas"]["RelatedGroupDto"][];
             seo: components["schemas"]["SeoDto"];
+            shortDescription: null | string;
             sku: string;
             slug: string;
             /** Format: date-time */
@@ -457,12 +547,18 @@ export interface components {
             min: string;
             mode: string;
             selected: null | components["schemas"]["RangeSelectionDto"];
+            step: null | string;
             unit: null | string;
         };
         RangeSelectionDto: {
             max: null | string;
             min: null | string;
         };
+        RelatedGroupDto: {
+            key: string;
+            label: string;
+            products: components["schemas"]["ProductCardDto"][];
+        };
         SeoDto: {
             description: null | string;
             title: string;
@@ -532,6 +628,22 @@ export interface components {
             /** @description Link to this code's documentation. */
             type?: string;
         };
+        SuggestCategoryDto: {
+            id: string;
+            name: string;
+            path: string[];
+        };
+        SuggestFacetValueDto: {
+            facet: string;
+            key: string;
+            label: string;
+        };
+        SuggestResponse: {
+            categories: components["schemas"]["SuggestCategoryDto"][];
+            facetValues: components["schemas"]["SuggestFacetValueDto"][];
+            products: components["schemas"]["ProductCardDto"][];
+            query: string;
+        };
         SwatchDto: {
             color: null | string;
             image: null | components["schemas"]["MediaDescriptorDto"];
@@ -1630,6 +1742,96 @@ export interface operations {
             };
         };
     };
+    SearchFacetValues: {
+        parameters: {
+            query?: {
+                /** @description Narrows to the values whose label contains q (case-insensitively) or whose key starts with it. Omit for the facet's values as they are. Matched against the 1000 most common values of the facet, in this API — at most 50 are returned. Present but blank is a 400 (INVALID_QUERY). */
+                q?: string;
+                /** @description The filter context the values are counted in, sent as filter[key]=value exactly as on /products: a count is what selecting that value would leave. This facet's own selection does not narrow it (the counts are disjunctive), and a key this site has no facet for is dropped silently. */
+                filter?: {
+                    [key: string]: string;
+                };
+            };
+            header: {
+                /** @description Publishable, preview or secret site key. Required on every request; secret keys are server-side only. */
+                "X-Site-Key": string;
+                /** @description Market code (e.g. "se"). Omit for the site's default market. */
+                "X-Market"?: string;
+                /** @description BCP-47 language tag. Omit to use the market's language. */
+                "Accept-Language"?: string;
+            };
+            path: {
+                key: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["FacetValuesResponse"];
+                };
+            };
+            /** @description problem+json. MARKET_UNKNOWN (no such market on this site), INVALID_PAGE, or INVALID_QUERY (q present but blank, or longer than 100 characters), or FACET_NOT_SEARCHABLE (the facet exists but has no list of values to search in: a range, a toggle or a tree). */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["StorefrontProblem"];
+                };
+            };
+            /** @description problem+json. SITE_KEY_MISSING or SITE_KEY_INVALID. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["StorefrontProblem"];
+                };
+            };
+            /** @description problem+json. SECRET_KEY_FROM_BROWSER: a secret key was sent from a browser. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["StorefrontProblem"];
+                };
+            };
+            /** @description problem+json. FACET_NOT_FOUND, or SITE_INACTIVE when the site itself is not live. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["StorefrontProblem"];
+                };
+            };
+            /** @description problem+json. RATE_LIMITED; retryAfterSeconds and the Retry-After header say how long to wait. */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["StorefrontProblem"];
+                };
+            };
+            /** @description problem+json. SITE_REGISTRY_WARMING or INDEX_UNAVAILABLE — retry, the request was not wrong. */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["StorefrontProblem"];
+                };
+            };
+        };
+    };
     GetProduct: {
         parameters: {
             query?: never;
@@ -1805,6 +2007,90 @@ export interface operations {
             };
         };
     };
+    Suggest: {
+        parameters: {
+            query: {
+                /** @description What the shopper has typed so far, 1–100 characters. Blank, missing or longer is a 400 (INVALID_QUERY) — unlike a listing's q, which is truncated. */
+                q: string;
+            };
+            header: {
+                /** @description Publishable, preview or secret site key. Required on every request; secret keys are server-side only. */
+                "X-Site-Key": string;
+                /** @description Market code (e.g. "se"). Omit for the site's default market. */
+                "X-Market"?: string;
+                /** @description BCP-47 language tag. Omit to use the market's language. */
+                "Accept-Language"?: string;
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SuggestResponse"];
+                };
+            };
+            /** @description problem+json. MARKET_UNKNOWN (no such market on this site), INVALID_PAGE, or INVALID_QUERY (q missing, blank or longer than 100 characters). */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["StorefrontProblem"];
+                };
+            };
+            /** @description problem+json. SITE_KEY_MISSING or SITE_KEY_INVALID. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["StorefrontProblem"];
+                };
+            };
+            /** @description problem+json. SECRET_KEY_FROM_BROWSER: a secret key was sent from a browser. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["StorefrontProblem"];
+                };
+            };
+            /** @description problem+json. SITE_INACTIVE, or NOT_FOUND for an unrouted path. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["StorefrontProblem"];
+                };
+            };
+            /** @description problem+json. RATE_LIMITED; retryAfterSeconds and the Retry-After header say how long to wait. */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["StorefrontProblem"];
+                };
+            };
+            /** @description problem+json. SITE_REGISTRY_WARMING or INDEX_UNAVAILABLE — retry, the request was not wrong. */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["StorefrontProblem"];
+                };
+            };
+        };
+    };
     GetSite: {
         parameters: {
             query?: never;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@asstio-dev/storefront",
-  "version": "0.3.0",
+  "version": "0.6.0",
   "description": "Typed client for the Asstio Storefront API (generated from OpenAPI).",
   "repository": {
     "type": "git",
@@ -20,7 +20,7 @@
     "build": "npm run generate && tsc -p tsconfig.json && node -e \"require('node:fs').copyFileSync('src/schema.d.ts','dist/schema.d.ts')\" && npm run typecheck-examples && npm run smoke",
     "test": "vitest run",
     "check": "npm run generate && npm run typecheck-examples && npm test && git diff --exit-code -- src/schema.d.ts && test -z \"$(git status --porcelain -- src/schema.d.ts)\"",
-    "smoke": "node --input-type=module -e \"import(\\\"./dist/index.js\\\").then(m => { for (const f of [\\\"createStorefrontClient\\\", \\\"filterQuery\\\", \\\"pictureSources\\\", \\\"mediaUrl\\\"]) if (typeof m[f] !== \\\"function\\\") throw new Error(\\\"missing export \\\" + f) })\""
+    "smoke": "node --input-type=module -e \"import(\\\"./dist/index.js\\\").then(m => { for (const f of [\\\"createStorefrontClient\\\", \\\"filterQuery\\\", \\\"encodeFilterValues\\\", \\\"decodeFilterValues\\\", \\\"pictureSources\\\", \\\"mediaUrl\\\"]) if (typeof m[f] !== \\\"function\\\") throw new Error(\\\"missing export \\\" + f) })\""
   },
   "dependencies": {
     "openapi-fetch": "0.17.0"

package/src/schema.d.ts

@@ -153,6 +153,23 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/products/facets/{key}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Search within a facet: values whose label matches q, counted in this request's filter[...] context (spelled as on /products). Free text and collections are not applied. */
+        get: operations["SearchFacetValues"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/products/{slugOrId}": {
         parameters: {
             query?: never;
@@ -187,6 +204,23 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/search/suggest": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Search-as-you-type: products by name prefix, categories and facet values whose label starts with q. Market, assortment and language as /products. */
+        get: operations["Suggest"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/site": {
         parameters: {
             query?: never;
@@ -235,6 +269,27 @@ export interface components {
             label: string;
             value: string;
         };
+        AttributeDto: {
+            facetKey: null | string;
+            html: null | string;
+            key: string;
+            label: string;
+            type: string;
+            value: null | string;
+            valueKeys: string[] | null;
+            values: string[] | null;
+        };
+        BrandDto: {
+            facet: null | components["schemas"]["FacetLinkDto"];
+            label: string;
+        };
+        BundleComponentDto: {
+            product: components["schemas"]["ProductCardDto"];
+            quantity: string;
+        };
+        BundleDto: {
+            components: components["schemas"]["BundleComponentDto"][];
+        };
         CartDto: {
             currency: string;
             grandTotalInc: string;
@@ -251,10 +306,22 @@ export interface components {
             id: string;
             image: null | components["schemas"]["MediaDescriptorDto"];
             price: components["schemas"]["PriceDto"];
-            productId: string;
+            product: components["schemas"]["CartLineProductDto"];
             /** Format: int32 */
             quantity: number | string;
             sku: string;
+            variant: components["schemas"]["CartLineVariantDto"];
+        };
+        CartLineProductDto: {
+            id: string;
+            name: string;
+            slug: string;
+        };
+        CartLineVariantDto: {
+            id: string;
+            selectedOptions: {
+                [key: string]: string;
+            };
         };
         CategoryNodeDto: {
             children: components["schemas"]["CategoryNodeDto"][];
@@ -298,7 +365,13 @@ export interface components {
             slug: string;
             url: string;
         };
+        DescriptionDto: {
+            html: string;
+            text: string;
+        };
         FacetDto: {
+            collapsed: boolean;
+            help: null | string;
             key: string;
             label: string;
             match: string;
@@ -308,16 +381,25 @@ export interface components {
             type: string;
             values: components["schemas"]["FacetValueDto"][];
         };
+        FacetLinkDto: {
+            key: string;
+            valueKey: string;
+        };
         FacetValueDto: {
             children: components["schemas"]["FacetValueDto"][] | null;
             /** Format: int64 */
             count: number | string;
+            help: null | string;
             key: string;
             label: string;
             pinned: boolean;
             selected: boolean;
             swatch: null | components["schemas"]["SwatchDto"];
         };
+        FacetValuesResponse: {
+            facet: string;
+            values: components["schemas"]["FacetValueDto"][];
+        };
         ListingResponse: {
             appliedFilters: components["schemas"]["AppliedFilterDto"][];
             facets: components["schemas"]["FacetDto"][];
@@ -414,6 +496,7 @@ export interface components {
             vatRate: string;
         };
         ProductCardDto: {
+            brand: null | components["schemas"]["BrandDto"];
             collections: string[];
             id: string;
             image: null | components["schemas"]["MediaDescriptorDto"];
@@ -421,6 +504,7 @@ export interface components {
             name: string;
             price: null | components["schemas"]["PriceDto"];
             priceVaries: boolean;
+            shortDescription: null | string;
             sku: string;
             slug: string;
             /** Format: date-time */
@@ -431,8 +515,12 @@ export interface components {
             alternateUrls: {
                 [key: string]: string;
             };
+            attributes: components["schemas"]["AttributeDto"][];
+            brand: null | components["schemas"]["BrandDto"];
+            bundle: null | components["schemas"]["BundleDto"];
             categories: components["schemas"]["CategoryRefDto"][];
             collections: components["schemas"]["CollectionRefDto"][];
+            description: null | components["schemas"]["DescriptionDto"];
             files: components["schemas"]["MediaDescriptorDto"][];
             id: string;
             image: null | components["schemas"]["MediaDescriptorDto"];
@@ -441,7 +529,9 @@ export interface components {
             name: string;
             options: components["schemas"]["OptionDto"][];
             redirectTo: null | string;
+            related: components["schemas"]["RelatedGroupDto"][];
             seo: components["schemas"]["SeoDto"];
+            shortDescription: null | string;
             sku: string;
             slug: string;
             /** Format: date-time */
@@ -457,12 +547,18 @@ export interface components {
             min: string;
             mode: string;
             selected: null | components["schemas"]["RangeSelectionDto"];
+            step: null | string;
             unit: null | string;
         };
         RangeSelectionDto: {
             max: null | string;
             min: null | string;
         };
+        RelatedGroupDto: {
+            key: string;
+            label: string;
+            products: components["schemas"]["ProductCardDto"][];
+        };
         SeoDto: {
             description: null | string;
             title: string;
@@ -532,6 +628,22 @@ export interface components {
             /** @description Link to this code's documentation. */
             type?: string;
         };
+        SuggestCategoryDto: {
+            id: string;
+            name: string;
+            path: string[];
+        };
+        SuggestFacetValueDto: {
+            facet: string;
+            key: string;
+            label: string;
+        };
+        SuggestResponse: {
+            categories: components["schemas"]["SuggestCategoryDto"][];
+            facetValues: components["schemas"]["SuggestFacetValueDto"][];
+            products: components["schemas"]["ProductCardDto"][];
+            query: string;
+        };
         SwatchDto: {
             color: null | string;
             image: null | components["schemas"]["MediaDescriptorDto"];
@@ -1630,6 +1742,96 @@ export interface operations {
             };
         };
     };
+    SearchFacetValues: {
+        parameters: {
+            query?: {
+                /** @description Narrows to the values whose label contains q (case-insensitively) or whose key starts with it. Omit for the facet's values as they are. Matched against the 1000 most common values of the facet, in this API — at most 50 are returned. Present but blank is a 400 (INVALID_QUERY). */
+                q?: string;
+                /** @description The filter context the values are counted in, sent as filter[key]=value exactly as on /products: a count is what selecting that value would leave. This facet's own selection does not narrow it (the counts are disjunctive), and a key this site has no facet for is dropped silently. */
+                filter?: {
+                    [key: string]: string;
+                };
+            };
+            header: {
+                /** @description Publishable, preview or secret site key. Required on every request; secret keys are server-side only. */
+                "X-Site-Key": string;
+                /** @description Market code (e.g. "se"). Omit for the site's default market. */
+                "X-Market"?: string;
+                /** @description BCP-47 language tag. Omit to use the market's language. */
+                "Accept-Language"?: string;
+            };
+            path: {
+                key: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["FacetValuesResponse"];
+                };
+            };
+            /** @description problem+json. MARKET_UNKNOWN (no such market on this site), INVALID_PAGE, or INVALID_QUERY (q present but blank, or longer than 100 characters), or FACET_NOT_SEARCHABLE (the facet exists but has no list of values to search in: a range, a toggle or a tree). */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["StorefrontProblem"];
+                };
+            };
+            /** @description problem+json. SITE_KEY_MISSING or SITE_KEY_INVALID. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["StorefrontProblem"];
+                };
+            };
+            /** @description problem+json. SECRET_KEY_FROM_BROWSER: a secret key was sent from a browser. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["StorefrontProblem"];
+                };
+            };
+            /** @description problem+json. FACET_NOT_FOUND, or SITE_INACTIVE when the site itself is not live. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["StorefrontProblem"];
+                };
+            };
+            /** @description problem+json. RATE_LIMITED; retryAfterSeconds and the Retry-After header say how long to wait. */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["StorefrontProblem"];
+                };
+            };
+            /** @description problem+json. SITE_REGISTRY_WARMING or INDEX_UNAVAILABLE — retry, the request was not wrong. */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["StorefrontProblem"];
+                };
+            };
+        };
+    };
     GetProduct: {
         parameters: {
             query?: never;
@@ -1805,6 +2007,90 @@ export interface operations {
             };
         };
     };
+    Suggest: {
+        parameters: {
+            query: {
+                /** @description What the shopper has typed so far, 1–100 characters. Blank, missing or longer is a 400 (INVALID_QUERY) — unlike a listing's q, which is truncated. */
+                q: string;
+            };
+            header: {
+                /** @description Publishable, preview or secret site key. Required on every request; secret keys are server-side only. */
+                "X-Site-Key": string;
+                /** @description Market code (e.g. "se"). Omit for the site's default market. */
+                "X-Market"?: string;
+                /** @description BCP-47 language tag. Omit to use the market's language. */
+                "Accept-Language"?: string;
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SuggestResponse"];
+                };
+            };
+            /** @description problem+json. MARKET_UNKNOWN (no such market on this site), INVALID_PAGE, or INVALID_QUERY (q missing, blank or longer than 100 characters). */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["StorefrontProblem"];
+                };
+            };
+            /** @description problem+json. SITE_KEY_MISSING or SITE_KEY_INVALID. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["StorefrontProblem"];
+                };
+            };
+            /** @description problem+json. SECRET_KEY_FROM_BROWSER: a secret key was sent from a browser. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["StorefrontProblem"];
+                };
+            };
+            /** @description problem+json. SITE_INACTIVE, or NOT_FOUND for an unrouted path. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["StorefrontProblem"];
+                };
+            };
+            /** @description problem+json. RATE_LIMITED; retryAfterSeconds and the Retry-After header say how long to wait. */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["StorefrontProblem"];
+                };
+            };
+            /** @description problem+json. SITE_REGISTRY_WARMING or INDEX_UNAVAILABLE — retry, the request was not wrong. */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["StorefrontProblem"];
+                };
+            };
+        };
+    };
     GetSite: {
         parameters: {
             query?: never;