@sonic-commerce/storefront-types 0.23.4 → 0.25.0

package/README.md

@@ -1,6 +1,6 @@
 # @sonic-commerce/storefront-types
 
-TypeScript types for the Sonic Commerce storefront API (`/api/v1`).
+TypeScript types for the Sonic Commerce storefront API (`/v1`).
 
 Types only — no runtime code, nothing to import at run time, nothing added to
 your bundle. Generated from the API's OpenAPI document, which is itself
@@ -29,7 +29,7 @@ import type { paths, Product } from "@sonic-commerce/storefront-types";
 
 // Server-side only — the Store ID is not meant for a browser bundle.
 const api = createClient<paths>({
-  baseUrl: "https://api.example.com/api/v1",
+  baseUrl: "https://api.example.com/v1",
   headers: {
     "x-store-id": process.env.SONIC_STORE_ID!,
     "x-publishable-key": process.env.PUBLISHABLE_KEY!,
@@ -61,7 +61,7 @@ await api.POST("/carts", {
 
 A missing or unknown Store ID or publishable key is answered `404 Not found`.
 
-A store with its own **custom domain** can use `https://<that domain>/api/v1`
+A store with its own **custom domain** can use `https://<that domain>/v1`
 instead; there the hostname names the store and `x-store-id` / `x-shopper-ip`
 are not needed. Per-store subdomains are not served.
 
@@ -93,7 +93,7 @@ const cart = data?.data as Cart | undefined;   // shipping_total present
 
 ## Versioning
 
-The package version tracks the API version: `0.23.0` describes the `/api/v1`
+The package version tracks the API version: `0.23.0` describes the `/v1`
 surface as of release 0.23.0.
 
 While the API is pre-1.0, **breaking changes ship in a minor bump** (0.23 →
@@ -109,4 +109,4 @@ reaches 1.0.
 ## Other languages
 
 The OpenAPI 3.1 document these types are generated from is served live at
-`GET /api/v1/openapi.json`. Any generator that reads OpenAPI can target it.
+`GET /v1/openapi.json`. Any generator that reads OpenAPI can target it.

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.23.4, 54 named schemas.
+// Spec version 0.25.0, 54 named schemas.
 
 export type { paths, components, operations } from "./schema";
 import type { components } from "./schema";

package/dist/schema.d.ts

@@ -505,7 +505,7 @@ export interface paths {
         };
         /**
          * List categories
-         * @description Active, non-internal categories only. `parent_id=null` returns roots.
+         * @description Active, non-internal categories only. `parent_id=null` returns roots. Sorted by `rank` then `name` by default; `rank` is per parent, so filter by `parent_id` to get one level in the merchant's order.
          */
         get: {
             parameters: {
@@ -672,7 +672,7 @@ export interface paths {
         };
         /**
          * Get the category tree
-         * @description The full nested menu in one request. Unpaginated; nesting is capped at 8 levels.
+         * @description The full nested menu in one request. Unpaginated; nesting is capped at 8 levels. Every `children` array is already in the merchant's order (`rank`, then `name`).
          */
         get: {
             parameters: {
@@ -3612,6 +3612,7 @@ export interface components {
             name?: string;
             handle?: string;
             description?: string | null;
+            /** @description Merchant-set position among categories with the same parent, starting at 0. Each parent numbers its own children, so compare `rank` only between siblings. */
             rank?: number;
             parent_id?: string | null;
             thumbnail?: string | null;
@@ -3628,6 +3629,7 @@ export interface components {
             id: string;
             name: string;
             handle: string;
+            /** @description Merchant-set position among categories with the same parent, starting at 0. Each parent numbers its own children, so compare `rank` only between siblings. */
             rank: number;
             thumbnail: string | null;
             children: components["schemas"]["CategoryTreeNode"][];

package/package.json

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