@sonic-commerce/storefront-types 0.24.0 → 0.25.0

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.24.0, 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,6 +1,6 @@
 {
   "name": "@sonic-commerce/storefront-types",
-  "version": "0.24.0",
+  "version": "0.25.0",
   "description": "TypeScript types for the Sonic Commerce storefront API (/v1).",
   "keywords": ["sonic-commerce", "openapi", "types", "storefront"],
   "license": "UNLICENSED",