@sonic-commerce/storefront-types 0.36.1 → 0.38.0

package/README.md

@@ -116,6 +116,21 @@ const { data } = await api.GET("/carts/{id}", { params: { path: { id } } });
 const cart = data?.data as Cart | undefined;   // shipping_total present
 ```
 
+### Product descriptions
+
+`description` is a plain-text summary (max 500 characters). `body`, on the
+product detail response only, is the detailed description as structured JSON —
+see "Product descriptions" in the integrator's guide for the node types. Render
+it as elements and text, never through `innerHTML`.
+
+### Stock by location
+
+`GET /locations` lists the store's active locations (address, coordinates,
+opening hours, pickup/delivery). On product detail each variant has
+`locations: [{ location_id, quantity }]`, the stock at each one. `quantity` on
+the variant is the store-wide total. See "Stock and locations" in the
+integrator's guide.
+
 ## Versioning
 
 The package version tracks the API version: each version describes the `/v1`

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 // Generated by scripts/build.mjs from app/openapi/public-api.json — do not edit.
-// Spec version 0.36.1, 59 named schemas.
+// Spec version 0.38.0, 60 named schemas.
 
 export type { paths, components, operations } from "./schema";
 import type { components } from "./schema";
@@ -25,6 +25,7 @@ export type CustomerAddress = components["schemas"]["CustomerAddress"];
 export type Error = components["schemas"]["Error"];
 export type ImageSizes = components["schemas"]["ImageSizes"];
 export type LineItem = components["schemas"]["LineItem"];
+export type Location = components["schemas"]["Location"];
 export type LoginBody = components["schemas"]["LoginBody"];
 export type Order = components["schemas"]["Order"];
 export type OrderItem = components["schemas"]["OrderItem"];

package/dist/schema.d.ts

@@ -1573,6 +1573,66 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/locations": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List the store's locations
+         * @description Active locations, the default (oldest) first — where a shopper can pick up or find stock. Product detail variants list stock per location by these ids.
+         */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Success */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            data: components["schemas"]["Location"][];
+                            meta: components["schemas"]["PaginationMeta"];
+                        };
+                    };
+                };
+                /** @description Invalid request — unknown parameter or bad value. */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+                /** @description Rate limit exceeded. */
+                429: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/tax-rate": {
         parameters: {
             query?: never;
@@ -3666,6 +3726,9 @@ export interface components {
             thumbnail_sizes?: components["schemas"]["ImageSizes"] | null;
             created_at?: string;
             updated_at?: string;
+            body?: {
+                [key: string]: unknown;
+            }[] | null;
             variants?: components["schemas"]["ProductVariant"][];
             options?: components["schemas"]["ProductOption"][];
             categories?: components["schemas"]["ProductCategory"][];
@@ -3687,6 +3750,10 @@ export interface components {
                 option_title: string;
             }[];
             prices: components["schemas"]["VariantPrice"][];
+            locations?: {
+                location_id: string;
+                quantity: number;
+            }[];
         };
         VariantPrice: {
             currency_code: string;
@@ -3847,6 +3914,26 @@ export interface components {
             code: string | null;
             rate: number;
         };
+        Location: {
+            id: string;
+            name: string;
+            address_line1: string | null;
+            address_line2: string | null;
+            city: string | null;
+            state: string | null;
+            postal_code: string | null;
+            country_code: string | null;
+            phone: string | null;
+            email: string | null;
+            latitude: number | null;
+            longitude: number | null;
+            timezone: string;
+            opening_hours: {
+                [key: string]: unknown;
+            } | null;
+            pickup_enabled: boolean;
+            delivery_enabled: boolean;
+        };
         TaxSummary: {
             region_id: string | null;
             label: string | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sonic-commerce/storefront-types",
-  "version": "0.36.1",
+  "version": "0.38.0",
   "description": "TypeScript types for the Sonic Commerce storefront API (/v1).",
   "keywords": ["sonic-commerce", "openapi", "types", "storefront"],
   "license": "UNLICENSED",