@asstio-dev/storefront 0.18.0 → 0.20.0

package/dist/schema.d.ts

@@ -183,6 +183,22 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/checkout/{attemptId}/shipping": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations["GetCheckoutShipping"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/collections": {
         parameters: {
             query?: never;
@@ -233,6 +249,23 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/events": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Search exposures, clicks and add-to-carts for measurement (spec 2026-10-13 §9.2). Send only with the shopper's consent. Each event is validated on its own: a bad one is listed in rejected and the others are kept; an eventId the site already has is a duplicate and changes nothing. */
+        post: operations["TrackSearchEvents"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/orders/{orderId}": {
         parameters: {
             query?: never;
@@ -406,6 +439,8 @@ export interface components {
         AppliedFilterDto: {
             facet: string;
             label: string;
+            /** @default filter */
+            source: string;
             value: string;
         };
         AttributeDto: {
@@ -593,6 +628,32 @@ export interface components {
             kind: string;
             url: null | string;
         };
+        CheckoutShippingPointDto: {
+            city: null | string;
+            name: string;
+            postalCode: null | string;
+            street: null | string;
+        };
+        CheckoutShippingViewDto: {
+            /** Format: int32 */
+            cartVersion: number | null | string;
+            currency: null | string;
+            deliveryType: null | string;
+            goodsInc: null | string;
+            name: null | string;
+            option: null | string;
+            otherInc: null | string;
+            point: null | components["schemas"]["CheckoutShippingPointDto"];
+            /** Format: date-time */
+            readAt: null | string;
+            reason: null | string;
+            /** Format: int32 */
+            retryAfterSeconds: number | null | string;
+            shippingInc: null | string;
+            state: string;
+            totalInc: null | string;
+            totalSource: null | string;
+        };
         CheckoutStatusDto: {
             attemptId: string;
             order: null | components["schemas"]["CheckoutOrderRefDto"];
@@ -710,6 +771,7 @@ export interface components {
             pageSize: number | string;
             queryCorrection: null | string;
             redirect: null | string;
+            search?: null | components["schemas"]["SearchInfoDto"];
             sort: components["schemas"]["SortDto"];
             /** Format: int64 */
             total: number | string;
@@ -978,6 +1040,60 @@ export interface components {
             importer: null | components["schemas"]["PartyDto"];
             manufacturer: null | components["schemas"]["PartyDto"];
         };
+        SearchEventDto: {
+            eventId: null | string;
+            exposureId?: null | string;
+            /** Format: date-time */
+            occurredAt: null | string;
+            /** Format: int32 */
+            page?: number | null;
+            /** Format: int32 */
+            position?: number | null;
+            productId?: null | string;
+            productIds?: string[] | null;
+            /** Format: int32 */
+            quantity?: number | null;
+            query?: null | string;
+            resultId?: null | string;
+            sessionId?: null | string;
+            type: null | string;
+            variantId?: null | string;
+        };
+        SearchEventRejection: {
+            code: string;
+            /** Format: int32 */
+            index: number | string;
+            member: null | string;
+        };
+        SearchEventsRequest: {
+            events: components["schemas"]["SearchEventDto"][] | null;
+        };
+        SearchEventsResponse: {
+            /** Format: int32 */
+            accepted: number | string;
+            /** Format: int32 */
+            duplicates: number | string;
+            rejected: components["schemas"]["SearchEventRejection"][];
+            /** Format: int32 */
+            stored: number | string;
+        };
+        SearchInfoDto: {
+            codeMatch: boolean;
+            intents: components["schemas"]["SearchIntentDto"][];
+            rescue: null | components["schemas"]["SearchRescueDto"];
+            resultId: string;
+            tier: string;
+        };
+        SearchIntentDto: {
+            facet: string;
+            queryWithout: string;
+            values: string[];
+        };
+        SearchRescueDto: {
+            collectionId: string;
+            name: string;
+            slug: string;
+        };
         SellabilityDto: {
             mode: components["schemas"]["SiteSellabilityMode"];
         };
@@ -2401,6 +2517,91 @@ export interface operations {
             };
         };
     };
+    GetCheckoutShipping: {
+        parameters: {
+            query?: never;
+            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;
+                /** @description The cart's bearer token. The checkout works on this cart. */
+                "X-Cart-Token": string;
+            };
+            path: {
+                attemptId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CheckoutShippingViewDto"];
+                };
+            };
+            /** @description problem+json. NOT_FOUND (X-Cart-Token missing). */
+            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. CHECKOUT_NOT_FOUND: no such attempt for this site and cart; or SITE_INACTIVE. */
+            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"];
+                };
+            };
+        };
+    };
     GetCollections: {
         parameters: {
             query?: never;
@@ -2485,7 +2686,7 @@ export interface operations {
     GetCollection: {
         parameters: {
             query?: {
-                /** @description Free-text search. Omit to browse rather than search. */
+                /** @description Free-text search. Omit to browse rather than search; a q of separators only (such as !!!) browses too. A search answers with search (how it was answered), and may set queryCorrection and redirect. */
                 q?: string;
                 /** @description 1-based page. page × pageSize must not exceed 10000 (default pageSize 24, max 100). */
                 page?: number;
@@ -2497,6 +2698,8 @@ export interface operations {
                 filter?: {
                     [key: string]: string;
                 };
+                /** @description Where a search came from, for measurement only: typed, suggestion, recent or other. It never changes the answer. Anything else is ignored with an ORIGIN_UNKNOWN warning. */
+                origin?: "other" | "recent" | "suggestion" | "typed";
             };
             header: {
                 /** @description Publishable, preview or secret site key. Required on every request; secret keys are server-side only. */
@@ -2661,6 +2864,91 @@ export interface operations {
             };
         };
     };
+    TrackSearchEvents: {
+        parameters: {
+            query?: never;
+            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: {
+            content: {
+                "application/json": components["schemas"]["SearchEventsRequest"];
+            };
+        };
+        responses: {
+            /** @description Accepted */
+            202: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SearchEventsResponse"];
+                };
+            };
+            /** @description problem+json. EVENTS_INVALID (not JSON, not { "events": [ … ] }, no event or more than 50, or a body over 64 KB; nothing is stored), or MARKET_UNKNOWN. One bad event is not a 400: it is listed in the 202's rejected. */
+            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"];
+                };
+            };
+        };
+    };
     GetOrder: {
         parameters: {
             query?: never;
@@ -2751,7 +3039,7 @@ export interface operations {
     ListProducts: {
         parameters: {
             query?: {
-                /** @description Free-text search. Omit to browse rather than search. */
+                /** @description Free-text search. Omit to browse rather than search; a q of separators only (such as !!!) browses too. A search answers with search (how it was answered), and may set queryCorrection and redirect. */
                 q?: string;
                 /** @description 1-based page. page × pageSize must not exceed 10000 (default pageSize 24, max 100). */
                 page?: number;
@@ -2763,6 +3051,8 @@ export interface operations {
                 filter?: {
                     [key: string]: string;
                 };
+                /** @description Where a search came from, for measurement only: typed, suggestion, recent or other. It never changes the answer. Anything else is ignored with an ORIGIN_UNKNOWN warning. */
+                origin?: "other" | "recent" | "suggestion" | "typed";
                 /** @description Narrow to a collection by slug path or id. An unknown one is answered with a COLLECTION_UNKNOWN warning, not a 404. */
                 collection?: string;
             };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@asstio-dev/storefront",
-  "version": "0.18.0",
+  "version": "0.20.0",
   "description": "Typed client for the Asstio Storefront API (generated from OpenAPI).",
   "repository": {
     "type": "git",
@@ -21,7 +21,7 @@
     "test": "vitest run",
     "test:browser": "playwright test -c browser/playwright.config.ts",
     "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\\\", \\\"encodeFilterValues\\\", \\\"decodeFilterValues\\\", \\\"pictureSources\\\", \\\"mediaUrl\\\", \\\"formatImage\\\", \\\"styleToCss\\\", \\\"startCheckout\\\", \\\"syncCheckout\\\", \\\"completeCheckout\\\", \\\"getCheckoutStatus\\\", \\\"getOrder\\\", \\\"awaitCompletion\\\", \\\"mountCheckout\\\", \\\"productJsonLd\\\", \\\"gtinJsonLd\\\", \\\"breadcrumbJsonLd\\\", \\\"productHead\\\", \\\"collectionHead\\\", \\\"brandHead\\\", \\\"toNextMetadata\\\", \\\"jsonLdScript\\\", \\\"SeoError\\\", \\\"productFacts\\\", \\\"toGa4Item\\\", \\\"toGa4Ecommerce\\\", \\\"AnalyticsError\\\"]) 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\\\", \\\"formatImage\\\", \\\"styleToCss\\\", \\\"startCheckout\\\", \\\"syncCheckout\\\", \\\"completeCheckout\\\", \\\"getCheckoutStatus\\\", \\\"liveShippingFor\\\", \\\"getOrder\\\", \\\"awaitCompletion\\\", \\\"mountCheckout\\\", \\\"productJsonLd\\\", \\\"gtinJsonLd\\\", \\\"breadcrumbJsonLd\\\", \\\"productHead\\\", \\\"collectionHead\\\", \\\"brandHead\\\", \\\"toNextMetadata\\\", \\\"jsonLdScript\\\", \\\"SeoError\\\", \\\"productFacts\\\", \\\"toGa4Item\\\", \\\"toGa4Ecommerce\\\", \\\"AnalyticsError\\\", \\\"trackSearchEvents\\\"]) if (typeof m[f] !== \\\"function\\\") throw new Error(\\\"missing export \\\" + f) })\""
   },
   "dependencies": {
     "openapi-fetch": "0.17.0"