@coveo/thermidor-schema 1.0.0-beta.2 → 1.0.0-beta.3

package/dist/generated/schemas.js

@@ -42,18 +42,6 @@ export const ProductCarouselStateSchema = z.strictObject({
     heading: z.string(),
     products: z.array(ProductSchema),
 });
-export const CartItemSchema = z.strictObject({
-    name: z.string(),
-    price: z.number().min(0),
-    productId: z.string(),
-    quantity: z.number().int().min(1),
-});
-export const UpdateItemQuantityPayloadSchema = z.strictObject({
-    item: CartItemSchema,
-});
-export const CartStateSchema = z.strictObject({
-    items: z.array(CartItemSchema),
-});
 export const SelectActionPayloadSchema = z.strictObject({
     text: z.string(),
     type: z.enum(['followup', 'search']),
@@ -65,7 +53,7 @@ export const ActionItemSchema = z.strictObject({
 export const BundleDisplayActionsSchema = z.strictObject({});
 export const BundleSlotSchema = z.strictObject({
     categoryLabel: z.string(),
-    surfaceRef: z.string(),
+    childId: z.string(),
 });
 export const ComparisonTableActionsSchema = z.strictObject({});
 export const ComparisonAttributeSchema = z.strictObject({
@@ -78,16 +66,21 @@ export const ComparisonProductSchema = z.strictObject({
     price: z.number().optional(),
     productId: z.string(),
     rating: z.number().min(0).max(5).optional(),
-    values: z.record(z.string(), z.string()),
+    values: z.record(z.string(), z.string()).optional(),
 });
 export const ProductListActionsSchema = z.strictObject({});
 export const ProductListStateSchema = z.strictObject({
     products: z.array(ProductSchema),
 });
+export const ProductSummaryActionsSchema = z.strictObject({});
+export const ProductSummaryStateSchema = z.strictObject({
+    categoryLabel: z.string(),
+    product: z.union([ProductSchema, z.null()]),
+});
 export const SelectPagePayloadSchema = z.strictObject({
     page: z.number().int().min(0),
 });
-export const SetPageSizePayloadSchema = z.strictObject({
+export const PayloadSchema = z.strictObject({
     pageSize: z.number().int().min(1),
 });
 export const PaginationStateSchema = z.strictObject({
@@ -104,12 +97,6 @@ export const SortCriterionSchema = z.strictObject({
     fields: z.array(z.unknown()),
     sortCriteria: z.string(),
 });
-export const SubmitQueryPayloadSchema = z.strictObject({
-    query: z.string(),
-});
-export const SearchBoxStateSchema = z.strictObject({
-    query: z.string(),
-});
 export const ActionSchema = z.strictObject({
     payload: z.unknown(),
 });
@@ -204,20 +191,34 @@ export const CategoryFacetValuesSchema = z.strictObject({
     selected: z.union([CategoryFacetValueSchema, z.null()]),
 });
 export const FacetManagerActionsSchema = z.strictObject({});
-export const FacetManagerStateSchema = z.strictObject({
-    facetIds: z.array(z.string().regex(new RegExp('^[a-z][a-z0-9-]*$'))),
+export const FacetManagerStateSchema = z.strictObject({});
+export const CommerceSearchActionsSchema = z.strictObject({});
+export const CommerceSearchStateSchema = z.strictObject({});
+export const LayoutStackActionsSchema = z.strictObject({});
+export const LayoutStackStateSchema = z.strictObject({});
+export const QuerySummaryActionsSchema = z.strictObject({});
+export const QuerySummaryStateSchema = z.strictObject({
+    firstIndex: z.number().int().min(0),
+    lastIndex: z.number().int().min(0),
+    query: z.string(),
+    totalEntries: z.number().int().min(0),
+});
+export const SetPageSizePayloadSchema = z.strictObject({
+    pageSize: z.number().int().min(1),
+});
+export const PageSizeStateSchema = z.strictObject({
+    pageSize: z.number().int().min(1),
 });
 export const ProductCarouselSchema = z.strictObject({
     actions: ProductCarouselActionsSchema,
+    child: z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')).optional(),
+    children: z
+        .array(z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')))
+        .max(1000)
+        .optional(),
     componentType: z.literal('product-carousel'),
     state: ProductCarouselStateSchema,
 });
-export const SetItemsPayloadSchema = z.strictObject({
-    items: z.array(CartItemSchema),
-});
-export const UpdateItemQuantitySchema = z.strictObject({
-    payload: UpdateItemQuantityPayloadSchema,
-});
 export const SelectActionSchema = z.strictObject({
     payload: SelectActionPayloadSchema,
 });
@@ -231,18 +232,35 @@ export const BundleTierSchema = z.strictObject({
 });
 export const ComparisonTableStateSchema = z.strictObject({
     attributes: z.array(ComparisonAttributeSchema),
+    heading: z.string(),
     products: z.array(ComparisonProductSchema),
+    summary: z.string(),
 });
 export const ProductListSchema = z.strictObject({
     actions: ProductListActionsSchema,
+    child: z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')).optional(),
+    children: z
+        .array(z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')))
+        .max(1000)
+        .optional(),
     componentType: z.literal('product-list'),
     state: ProductListStateSchema,
 });
+export const ProductSummarySchema = z.strictObject({
+    actions: ProductSummaryActionsSchema,
+    child: z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')).optional(),
+    children: z
+        .array(z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')))
+        .max(1000)
+        .optional(),
+    componentType: z.literal('product-summary'),
+    state: ProductSummaryStateSchema,
+});
 export const SelectPageSchema = z.strictObject({
     payload: SelectPagePayloadSchema,
 });
-export const SetPageSizeSchema = z.strictObject({
-    payload: SetPageSizePayloadSchema,
+export const PurpleSetPageSizeSchema = z.strictObject({
+    payload: PayloadSchema,
 });
 export const SelectSortSchema = z.strictObject({
     payload: SelectSortPayloadSchema,
@@ -251,9 +269,6 @@ export const SortStateSchema = z.strictObject({
     appliedSort: SortCriterionSchema,
     availableSorts: z.array(SortCriterionSchema),
 });
-export const SubmitQuerySchema = z.strictObject({
-    payload: SubmitQueryPayloadSchema,
-});
 export const SearchSchema = z.strictObject({
     payload: SearchPayloadSchema,
 });
@@ -324,11 +339,46 @@ export const FacetSearchClassSchema = z.strictObject({
 });
 export const FacetManagerSchema = z.strictObject({
     actions: FacetManagerActionsSchema,
+    child: z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')).optional(),
+    children: z
+        .array(z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')))
+        .max(1000)
+        .optional(),
     componentType: z.literal('facet-manager'),
     state: FacetManagerStateSchema,
 });
-export const SetItemsSchema = z.strictObject({
-    payload: SetItemsPayloadSchema,
+export const CommerceSearchSchema = z.strictObject({
+    actions: CommerceSearchActionsSchema,
+    child: z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')).optional(),
+    children: z
+        .array(z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')))
+        .max(1000)
+        .optional(),
+    componentType: z.literal('commerce-search'),
+    state: CommerceSearchStateSchema,
+});
+export const LayoutStackSchema = z.strictObject({
+    actions: LayoutStackActionsSchema,
+    child: z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')).optional(),
+    children: z
+        .array(z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')))
+        .max(1000)
+        .optional(),
+    componentType: z.literal('layout-stack'),
+    state: LayoutStackStateSchema,
+});
+export const QuerySummarySchema = z.strictObject({
+    actions: QuerySummaryActionsSchema,
+    child: z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')).optional(),
+    children: z
+        .array(z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')))
+        .max(1000)
+        .optional(),
+    componentType: z.literal('query-summary'),
+    state: QuerySummaryStateSchema,
+});
+export const FluffySetPageSizeSchema = z.strictObject({
+    payload: SetPageSizePayloadSchema,
 });
 export const NextActionsBarActionsSchema = z.strictObject({
     selectAction: SelectActionSchema,
@@ -338,19 +388,21 @@ export const BundleDisplayStateSchema = z.strictObject({
 });
 export const ComparisonTableSchema = z.strictObject({
     actions: ComparisonTableActionsSchema,
+    child: z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')).optional(),
+    children: z
+        .array(z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')))
+        .max(1000)
+        .optional(),
     componentType: z.literal('comparison-table'),
     state: ComparisonTableStateSchema,
 });
 export const PaginationActionsSchema = z.strictObject({
     selectPage: SelectPageSchema,
-    setPageSize: SetPageSizeSchema,
+    setPageSize: PurpleSetPageSizeSchema,
 });
 export const SortActionsSchema = z.strictObject({
     selectSort: SelectSortSchema,
 });
-export const SearchBoxActionsSchema = z.strictObject({
-    submitQuery: SubmitQuerySchema,
-});
 export const RegularFacetActionsSchema = z.strictObject({
     clearAllActiveValues: ActionSchema,
     clearSearch: ActionSchema,
@@ -405,75 +457,117 @@ export const CategoryFacetStateSchema = z.strictObject({
     field: z.string(),
     values: CategoryFacetValuesSchema,
 });
-export const CartActionsSchema = z.strictObject({
-    setItems: SetItemsSchema,
-    updateItemQuantity: UpdateItemQuantitySchema,
+export const PageSizeActionsSchema = z.strictObject({
+    setPageSize: FluffySetPageSizeSchema,
 });
 export const NextActionsBarSchema = z.strictObject({
     actions: NextActionsBarActionsSchema,
+    child: z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')).optional(),
+    children: z
+        .array(z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')))
+        .max(1000)
+        .optional(),
     componentType: z.literal('next-actions-bar'),
     state: NextActionsStateSchema,
 });
 export const BundleDisplaySchema = z.strictObject({
     actions: BundleDisplayActionsSchema,
+    child: z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')).optional(),
+    children: z
+        .array(z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')))
+        .max(1000)
+        .optional(),
     componentType: z.literal('bundle-display'),
     state: BundleDisplayStateSchema,
 });
 export const PaginationSchema = z.strictObject({
     actions: PaginationActionsSchema,
+    child: z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')).optional(),
+    children: z
+        .array(z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')))
+        .max(1000)
+        .optional(),
     componentType: z.literal('pagination'),
     state: PaginationStateSchema,
 });
 export const SortSchema = z.strictObject({
     actions: SortActionsSchema,
+    child: z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')).optional(),
+    children: z
+        .array(z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')))
+        .max(1000)
+        .optional(),
     componentType: z.literal('sort'),
     state: SortStateSchema,
 });
-export const SearchBoxSchema = z.strictObject({
-    actions: SearchBoxActionsSchema,
-    componentType: z.literal('search-box'),
-    state: SearchBoxStateSchema,
-});
 export const RegularFacetSchema = z.strictObject({
     actions: RegularFacetActionsSchema,
+    child: z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')).optional(),
+    children: z
+        .array(z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')))
+        .max(1000)
+        .optional(),
     componentType: z.literal('regular-facet'),
     state: RegularFacetStateSchema,
 });
 export const NumericFacetSchema = z.strictObject({
     actions: NumericFacetActionsSchema,
+    child: z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')).optional(),
+    children: z
+        .array(z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')))
+        .max(1000)
+        .optional(),
     componentType: z.literal('numeric-facet'),
     state: NumericFacetStateSchema,
 });
 export const DateFacetSchema = z.strictObject({
     actions: DateFacetActionsSchema,
+    child: z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')).optional(),
+    children: z
+        .array(z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')))
+        .max(1000)
+        .optional(),
     componentType: z.literal('date-facet'),
     state: DateFacetStateSchema,
 });
 export const CategoryFacetSchema = z.strictObject({
     actions: CategoryFacetActionsSchema,
+    child: z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')).optional(),
+    children: z
+        .array(z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')))
+        .max(1000)
+        .optional(),
     componentType: z.literal('category-facet'),
     state: CategoryFacetStateSchema,
 });
-export const CartSchema = z.strictObject({
-    actions: CartActionsSchema,
-    componentType: z.literal('cart'),
-    state: CartStateSchema,
+export const PageSizeSchema = z.strictObject({
+    actions: PageSizeActionsSchema,
+    child: z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')).optional(),
+    children: z
+        .array(z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')))
+        .max(1000)
+        .optional(),
+    componentType: z.literal('page-size'),
+    state: PageSizeStateSchema,
 });
 export const ComponentContractsSchema = z.discriminatedUnion('componentType', [
     ProductCarouselSchema,
-    CartSchema,
     NextActionsBarSchema,
     BundleDisplaySchema,
     ComparisonTableSchema,
     ProductListSchema,
+    ProductSummarySchema,
     PaginationSchema,
     SortSchema,
-    SearchBoxSchema,
     RegularFacetSchema,
     NumericFacetSchema,
     DateFacetSchema,
     CategoryFacetSchema,
     FacetManagerSchema,
+    CommerceSearchSchema,
+    LayoutStackSchema,
+    QuerySummarySchema,
+    PageSizeSchema,
 ]);
 /**
  * Component props schemas.
@@ -485,14 +579,14 @@ export const BundleDisplayPropsSchema = z.object({
     componentId: z.string(),
     componentType: z.literal('bundle-display'),
 });
-export const CartPropsSchema = z.object({
-    componentId: z.string(),
-    componentType: z.literal('cart'),
-});
 export const CategoryFacetPropsSchema = z.object({
     componentId: z.string(),
     componentType: z.literal('category-facet'),
 });
+export const CommerceSearchPropsSchema = z.object({
+    componentId: z.string(),
+    componentType: z.literal('commerce-search'),
+});
 export const ComparisonTablePropsSchema = z.object({
     componentId: z.string(),
     componentType: z.literal('comparison-table'),
@@ -505,6 +599,10 @@ export const FacetManagerPropsSchema = z.object({
     componentId: z.string(),
     componentType: z.literal('facet-manager'),
 });
+export const LayoutStackPropsSchema = z.object({
+    componentId: z.string(),
+    componentType: z.literal('layout-stack'),
+});
 export const NextActionsBarPropsSchema = z.object({
     componentId: z.string(),
     componentType: z.literal('next-actions-bar'),
@@ -513,6 +611,10 @@ export const NumericFacetPropsSchema = z.object({
     componentId: z.string(),
     componentType: z.literal('numeric-facet'),
 });
+export const PageSizePropsSchema = z.object({
+    componentId: z.string(),
+    componentType: z.literal('page-size'),
+});
 export const PaginationPropsSchema = z.object({
     componentId: z.string(),
     componentType: z.literal('pagination'),
@@ -525,13 +627,17 @@ export const ProductListPropsSchema = z.object({
     componentId: z.string(),
     componentType: z.literal('product-list'),
 });
-export const RegularFacetPropsSchema = z.object({
+export const ProductSummaryPropsSchema = z.object({
     componentId: z.string(),
-    componentType: z.literal('regular-facet'),
+    componentType: z.literal('product-summary'),
 });
-export const SearchBoxPropsSchema = z.object({
+export const QuerySummaryPropsSchema = z.object({
     componentId: z.string(),
-    componentType: z.literal('search-box'),
+    componentType: z.literal('query-summary'),
+});
+export const RegularFacetPropsSchema = z.object({
+    componentId: z.string(),
+    componentType: z.literal('regular-facet'),
 });
 export const SortPropsSchema = z.object({
     componentId: z.string(),

package/dist/index.d.ts

@@ -1,3 +1,3 @@
 export declare const THERMIDOR_CATALOG_ID = "https://schema.thermidor.coveo.com/a2-ui/catalog.json";
-export { ActionItemSchema, BundleDisplaySchema, BundleDisplayStateSchema, BundleSlotSchema, BundleTierSchema, CartSchema, CartItemSchema, CartStateSchema, CategoryFacetSchema, CategoryFacetActionsSchema, CategoryFacetValueSchema, CategoryFacetSearchSchema, CategoryFacetSearchPayloadSchema, CategoryFacetSelectPathPayloadSchema, CategoryFacetStateSchema, CategoryFacetValuesSchema, ComparisonAttributeSchema, ComparisonProductSchema, ComparisonTableSchema, ComparisonTableStateSchema, ComponentContractsSchema, DateFacetSchema, DateFacetActionsSchema, DateFacetApplyCustomRangePayloadSchema, DateFacetCustomRangeSchema, DateFacetStateSchema, DateFacetToggleSelectPayloadSchema, DateFacetToggleSingleSelectPayloadSchema, DateFacetValueSchema, FacetManagerSchema, FacetManagerActionsSchema, FacetManagerStateSchema, FacetValueStateSchema, SelectableFacetValueStateSchema, NextActionsBarSchema, NextActionsStateSchema, NumericFacetSchema, NumericFacetActionsSchema, NumericFacetCustomRangeSchema, NumericFacetDomainSchema, NumericFacetApplyCustomRangePayloadSchema, NumericFacetStateSchema, NumericFacetToggleSelectPayloadSchema, NumericFacetToggleSingleSelectPayloadSchema, NumericFacetValueSchema, PaginationSchema, PaginationActionsSchema, PaginationStateSchema, ProductCarouselSchema, ProductCarouselStateSchema, ProductListSchema, ProductListActionsSchema, ProductListStateSchema, ProductSchema, RegularFacetSchema, RegularFacetActionsSchema, RegularFacetSearchSchema, RegularFacetSearchResultSchema, RegularFacetStateSchema, RegularFacetToggleExcludePayloadSchema, RegularFacetToggleSelectPayloadSchema, RegularFacetToggleSingleExcludePayloadSchema, RegularFacetToggleSingleSelectPayloadSchema, RegularFacetValueSchema, SearchBoxSchema, SearchBoxActionsSchema, SearchBoxStateSchema, SelectActionPayloadSchema, SelectPagePayloadSchema, SelectSortPayloadSchema, SetItemsPayloadSchema, SetPageSizePayloadSchema, SortSchema, SortActionsSchema, SortCriterionSchema, SortStateSchema, SubmitQueryPayloadSchema, UpdateItemQuantityPayloadSchema, BundleDisplayPropsSchema, CartPropsSchema, CategoryFacetPropsSchema, ComparisonTablePropsSchema, DateFacetPropsSchema, FacetManagerPropsSchema, NextActionsBarPropsSchema, NumericFacetPropsSchema, PaginationPropsSchema, ProductCarouselPropsSchema, ProductListPropsSchema, RegularFacetPropsSchema, SearchBoxPropsSchema, SortPropsSchema, } from './generated/schemas.js';
-export type { ActionItem, BundleDisplay, BundleDisplayState, BundleSlot, BundleTier, Cart, CartItem, CartState, CategoryFacet, CategoryFacetActions, CategoryFacetValue, CategoryFacetSearch, CategoryFacetSearchPayload, CategoryFacetSelectPathPayload, CategoryFacetState, CategoryFacetValues, ComparisonAttribute, ComparisonProduct, ComparisonTable, ComparisonTableState, ComponentContracts, DateFacet, DateFacetActions, DateFacetApplyCustomRangePayload, DateFacetCustomRange, DateFacetState, DateFacetToggleSelectPayload, DateFacetToggleSingleSelectPayload, DateFacetValue, FacetManager, FacetManagerActions, FacetManagerState, FacetValueState, SelectableFacetValueState, NextActionsBar, NextActionsState, NumericFacet, NumericFacetActions, NumericFacetCustomRange, NumericFacetDomain, NumericFacetApplyCustomRangePayload, NumericFacetState, NumericFacetToggleSelectPayload, NumericFacetToggleSingleSelectPayload, NumericFacetValue, Pagination, PaginationActions, PaginationState, Product, ProductCarousel, ProductCarouselState, ProductList, ProductListActions, ProductListState, RegularFacet, RegularFacetActions, RegularFacetSearch, RegularFacetSearchResult, RegularFacetState, RegularFacetToggleExcludePayload, RegularFacetToggleSelectPayload, RegularFacetToggleSingleExcludePayload, RegularFacetToggleSingleSelectPayload, RegularFacetValue, SearchBox, SearchBoxActions, SearchBoxState, SelectActionPayload, SelectPagePayload, SelectSortPayload, SetItemsPayload, SetPageSizePayload, Sort, SortActions, SortCriterion, SortState, SubmitQueryPayload, UpdateItemQuantityPayload, BundleDisplayProps, CartProps, CategoryFacetProps, ComparisonTableProps, DateFacetProps, FacetManagerProps, NextActionsBarProps, NumericFacetProps, PaginationProps, ProductCarouselProps, ProductListProps, RegularFacetProps, SearchBoxProps, SortProps, } from './generated/schemas.js';
+export { ActionItemSchema, BundleDisplaySchema, BundleDisplayStateSchema, BundleSlotSchema, BundleTierSchema, CategoryFacetSchema, CategoryFacetActionsSchema, CategoryFacetValueSchema, CategoryFacetSearchSchema, CategoryFacetSearchPayloadSchema, CategoryFacetSelectPathPayloadSchema, CategoryFacetStateSchema, CategoryFacetValuesSchema, CommerceSearchSchema, CommerceSearchStateSchema, ComparisonAttributeSchema, ComparisonProductSchema, ComparisonTableSchema, ComparisonTableStateSchema, ComponentContractsSchema, DateFacetSchema, DateFacetActionsSchema, DateFacetApplyCustomRangePayloadSchema, DateFacetCustomRangeSchema, DateFacetStateSchema, DateFacetToggleSelectPayloadSchema, DateFacetToggleSingleSelectPayloadSchema, DateFacetValueSchema, FacetManagerSchema, FacetManagerActionsSchema, FacetManagerStateSchema, FacetValueStateSchema, SelectableFacetValueStateSchema, LayoutStackSchema, LayoutStackStateSchema, NextActionsBarSchema, NextActionsStateSchema, NumericFacetSchema, NumericFacetActionsSchema, NumericFacetCustomRangeSchema, NumericFacetDomainSchema, NumericFacetApplyCustomRangePayloadSchema, NumericFacetStateSchema, NumericFacetToggleSelectPayloadSchema, NumericFacetToggleSingleSelectPayloadSchema, NumericFacetValueSchema, PageSizeSchema, PageSizeActionsSchema, PageSizeStateSchema, PaginationSchema, PaginationActionsSchema, PaginationStateSchema, ProductCarouselSchema, ProductCarouselStateSchema, ProductListSchema, ProductListActionsSchema, ProductListStateSchema, ProductSummarySchema, ProductSummaryActionsSchema, ProductSummaryStateSchema, QuerySummarySchema, QuerySummaryStateSchema, ProductSchema, RegularFacetSchema, RegularFacetActionsSchema, RegularFacetSearchSchema, RegularFacetSearchResultSchema, RegularFacetStateSchema, RegularFacetToggleExcludePayloadSchema, RegularFacetToggleSelectPayloadSchema, RegularFacetToggleSingleExcludePayloadSchema, RegularFacetToggleSingleSelectPayloadSchema, RegularFacetValueSchema, SelectActionPayloadSchema, SelectPagePayloadSchema, SelectSortPayloadSchema, SetPageSizePayloadSchema, SortSchema, SortActionsSchema, SortCriterionSchema, SortStateSchema, BundleDisplayPropsSchema, CategoryFacetPropsSchema, CommerceSearchPropsSchema, ComparisonTablePropsSchema, DateFacetPropsSchema, FacetManagerPropsSchema, LayoutStackPropsSchema, NextActionsBarPropsSchema, NumericFacetPropsSchema, PageSizePropsSchema, PaginationPropsSchema, ProductCarouselPropsSchema, ProductListPropsSchema, ProductSummaryPropsSchema, QuerySummaryPropsSchema, RegularFacetPropsSchema, SortPropsSchema, } from './generated/schemas.js';
+export type { ActionItem, BundleDisplay, BundleDisplayState, BundleSlot, BundleTier, CategoryFacet, CategoryFacetActions, CategoryFacetValue, CategoryFacetSearch, CategoryFacetSearchPayload, CategoryFacetSelectPathPayload, CategoryFacetState, CategoryFacetValues, CommerceSearch, CommerceSearchState, ComparisonAttribute, ComparisonProduct, ComparisonTable, ComparisonTableState, ComponentContracts, DateFacet, DateFacetActions, DateFacetApplyCustomRangePayload, DateFacetCustomRange, DateFacetState, DateFacetToggleSelectPayload, DateFacetToggleSingleSelectPayload, DateFacetValue, FacetManager, FacetManagerActions, FacetManagerState, FacetValueState, SelectableFacetValueState, LayoutStack, LayoutStackState, NextActionsBar, NextActionsState, NumericFacet, NumericFacetActions, NumericFacetCustomRange, NumericFacetDomain, NumericFacetApplyCustomRangePayload, NumericFacetState, NumericFacetToggleSelectPayload, NumericFacetToggleSingleSelectPayload, NumericFacetValue, PageSize, PageSizeActions, PageSizeState, Pagination, PaginationActions, PaginationState, Product, ProductCarousel, ProductCarouselState, ProductList, ProductListActions, ProductListState, ProductSummary, ProductSummaryActions, ProductSummaryState, QuerySummary, QuerySummaryState, RegularFacet, RegularFacetActions, RegularFacetSearch, RegularFacetSearchResult, RegularFacetState, RegularFacetToggleExcludePayload, RegularFacetToggleSelectPayload, RegularFacetToggleSingleExcludePayload, RegularFacetToggleSingleSelectPayload, RegularFacetValue, SelectActionPayload, SelectPagePayload, SelectSortPayload, SetPageSizePayload, Sort, SortActions, SortCriterion, SortState, BundleDisplayProps, CategoryFacetProps, CommerceSearchProps, ComparisonTableProps, DateFacetProps, FacetManagerProps, LayoutStackProps, NextActionsBarProps, NumericFacetProps, PageSizeProps, PaginationProps, ProductCarouselProps, ProductListProps, ProductSummaryProps, QuerySummaryProps, RegularFacetProps, SortProps, } from './generated/schemas.js';

package/dist/index.js

@@ -1,2 +1,2 @@
 export const THERMIDOR_CATALOG_ID = 'https://schema.thermidor.coveo.com/a2-ui/catalog.json';
-export { ActionItemSchema, BundleDisplaySchema, BundleDisplayStateSchema, BundleSlotSchema, BundleTierSchema, CartSchema, CartItemSchema, CartStateSchema, CategoryFacetSchema, CategoryFacetActionsSchema, CategoryFacetValueSchema, CategoryFacetSearchSchema, CategoryFacetSearchPayloadSchema, CategoryFacetSelectPathPayloadSchema, CategoryFacetStateSchema, CategoryFacetValuesSchema, ComparisonAttributeSchema, ComparisonProductSchema, ComparisonTableSchema, ComparisonTableStateSchema, ComponentContractsSchema, DateFacetSchema, DateFacetActionsSchema, DateFacetApplyCustomRangePayloadSchema, DateFacetCustomRangeSchema, DateFacetStateSchema, DateFacetToggleSelectPayloadSchema, DateFacetToggleSingleSelectPayloadSchema, DateFacetValueSchema, FacetManagerSchema, FacetManagerActionsSchema, FacetManagerStateSchema, FacetValueStateSchema, SelectableFacetValueStateSchema, NextActionsBarSchema, NextActionsStateSchema, NumericFacetSchema, NumericFacetActionsSchema, NumericFacetCustomRangeSchema, NumericFacetDomainSchema, NumericFacetApplyCustomRangePayloadSchema, NumericFacetStateSchema, NumericFacetToggleSelectPayloadSchema, NumericFacetToggleSingleSelectPayloadSchema, NumericFacetValueSchema, PaginationSchema, PaginationActionsSchema, PaginationStateSchema, ProductCarouselSchema, ProductCarouselStateSchema, ProductListSchema, ProductListActionsSchema, ProductListStateSchema, ProductSchema, RegularFacetSchema, RegularFacetActionsSchema, RegularFacetSearchSchema, RegularFacetSearchResultSchema, RegularFacetStateSchema, RegularFacetToggleExcludePayloadSchema, RegularFacetToggleSelectPayloadSchema, RegularFacetToggleSingleExcludePayloadSchema, RegularFacetToggleSingleSelectPayloadSchema, RegularFacetValueSchema, SearchBoxSchema, SearchBoxActionsSchema, SearchBoxStateSchema, SelectActionPayloadSchema, SelectPagePayloadSchema, SelectSortPayloadSchema, SetItemsPayloadSchema, SetPageSizePayloadSchema, SortSchema, SortActionsSchema, SortCriterionSchema, SortStateSchema, SubmitQueryPayloadSchema, UpdateItemQuantityPayloadSchema, BundleDisplayPropsSchema, CartPropsSchema, CategoryFacetPropsSchema, ComparisonTablePropsSchema, DateFacetPropsSchema, FacetManagerPropsSchema, NextActionsBarPropsSchema, NumericFacetPropsSchema, PaginationPropsSchema, ProductCarouselPropsSchema, ProductListPropsSchema, RegularFacetPropsSchema, SearchBoxPropsSchema, SortPropsSchema, } from './generated/schemas.js';
+export { ActionItemSchema, BundleDisplaySchema, BundleDisplayStateSchema, BundleSlotSchema, BundleTierSchema, CategoryFacetSchema, CategoryFacetActionsSchema, CategoryFacetValueSchema, CategoryFacetSearchSchema, CategoryFacetSearchPayloadSchema, CategoryFacetSelectPathPayloadSchema, CategoryFacetStateSchema, CategoryFacetValuesSchema, CommerceSearchSchema, CommerceSearchStateSchema, ComparisonAttributeSchema, ComparisonProductSchema, ComparisonTableSchema, ComparisonTableStateSchema, ComponentContractsSchema, DateFacetSchema, DateFacetActionsSchema, DateFacetApplyCustomRangePayloadSchema, DateFacetCustomRangeSchema, DateFacetStateSchema, DateFacetToggleSelectPayloadSchema, DateFacetToggleSingleSelectPayloadSchema, DateFacetValueSchema, FacetManagerSchema, FacetManagerActionsSchema, FacetManagerStateSchema, FacetValueStateSchema, SelectableFacetValueStateSchema, LayoutStackSchema, LayoutStackStateSchema, NextActionsBarSchema, NextActionsStateSchema, NumericFacetSchema, NumericFacetActionsSchema, NumericFacetCustomRangeSchema, NumericFacetDomainSchema, NumericFacetApplyCustomRangePayloadSchema, NumericFacetStateSchema, NumericFacetToggleSelectPayloadSchema, NumericFacetToggleSingleSelectPayloadSchema, NumericFacetValueSchema, PageSizeSchema, PageSizeActionsSchema, PageSizeStateSchema, PaginationSchema, PaginationActionsSchema, PaginationStateSchema, ProductCarouselSchema, ProductCarouselStateSchema, ProductListSchema, ProductListActionsSchema, ProductListStateSchema, ProductSummarySchema, ProductSummaryActionsSchema, ProductSummaryStateSchema, QuerySummarySchema, QuerySummaryStateSchema, ProductSchema, RegularFacetSchema, RegularFacetActionsSchema, RegularFacetSearchSchema, RegularFacetSearchResultSchema, RegularFacetStateSchema, RegularFacetToggleExcludePayloadSchema, RegularFacetToggleSelectPayloadSchema, RegularFacetToggleSingleExcludePayloadSchema, RegularFacetToggleSingleSelectPayloadSchema, RegularFacetValueSchema, SelectActionPayloadSchema, SelectPagePayloadSchema, SelectSortPayloadSchema, SetPageSizePayloadSchema, SortSchema, SortActionsSchema, SortCriterionSchema, SortStateSchema, BundleDisplayPropsSchema, CategoryFacetPropsSchema, CommerceSearchPropsSchema, ComparisonTablePropsSchema, DateFacetPropsSchema, FacetManagerPropsSchema, LayoutStackPropsSchema, NextActionsBarPropsSchema, NumericFacetPropsSchema, PageSizePropsSchema, PaginationPropsSchema, ProductCarouselPropsSchema, ProductListPropsSchema, ProductSummaryPropsSchema, QuerySummaryPropsSchema, RegularFacetPropsSchema, SortPropsSchema, } from './generated/schemas.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coveo/thermidor-schema",
-  "version": "1.0.0-beta.2",
+  "version": "1.0.0-beta.3",
   "description": "Zod and TypeScript projections of the Thermidor JSON Schema contract.",
   "license": "Apache-2.0",
   "type": "module",

package/schema/base/component.schema.json

@@ -23,7 +23,7 @@
       "type": "string",
       "pattern": "^[a-z][a-z0-9]*(-[a-z0-9]+)*$",
       "maxLength": 128,
-      "description": "Stable kebab-case type identifier (e.g. 'cart'). Used as discriminant for contract resolution."
+      "description": "Stable kebab-case type identifier (e.g. 'product-carousel'). Used as discriminant for contract resolution."
     },
     "state": {
       "type": "object",
@@ -35,6 +35,19 @@
       "additionalProperties": {
         "$ref": "https://schema.thermidor.coveo.com/base/action.schema.json"
       }
+    },
+    "children": {
+      "type": "array",
+      "items": {
+        "$ref": "https://schema.thermidor.coveo.com/definitions/child-ref.schema.json"
+      },
+      "maxItems": 1000,
+      "default": [],
+      "description": "Ordered list of child component ids referencing other components in the same flat map. Order is backend-owned and meaningful for container components; referential integrity and uniqueness are owned by the backend and not enforced at parse time."
+    },
+    "child": {
+      "$ref": "https://schema.thermidor.coveo.com/definitions/child-ref.schema.json",
+      "description": "A single child component id following the A2-UI single-child convention."
     }
   },
   "additionalProperties": false

package/schema/components/bundle-display.schema.json

@@ -20,6 +20,17 @@
       "type": "object",
       "properties": {},
       "additionalProperties": false
+    },
+    "children": {
+      "type": "array",
+      "items": {
+        "$ref": "https://schema.thermidor.coveo.com/definitions/child-ref.schema.json"
+      },
+      "maxItems": 1000,
+      "default": []
+    },
+    "child": {
+      "$ref": "https://schema.thermidor.coveo.com/definitions/child-ref.schema.json"
     }
   },
   "additionalProperties": false,
@@ -29,9 +40,7 @@
       "description": "The tiered product bundle layout. Owned exclusively by the backend; the frontend must not mutate this directly.",
       "$comment": "This schema validates the runtime state value the backend pushes to the frontend.",
       "type": "object",
-      "required": [
-        "tiers"
-      ],
+      "required": ["tiers"],
       "properties": {
         "tiers": {
           "type": "array",
@@ -44,4 +53,4 @@
       "additionalProperties": false
     }
   }
-}
+}

package/schema/components/category-facet.schema.json

@@ -51,6 +51,17 @@
         }
       },
       "additionalProperties": false
+    },
+    "children": {
+      "type": "array",
+      "items": {
+        "$ref": "https://schema.thermidor.coveo.com/definitions/child-ref.schema.json"
+      },
+      "maxItems": 1000,
+      "default": []
+    },
+    "child": {
+      "$ref": "https://schema.thermidor.coveo.com/definitions/child-ref.schema.json"
     }
   },
   "additionalProperties": false,
@@ -99,11 +110,7 @@
       "title": "CategoryFacetValues",
       "description": "Flat representation of the category hierarchy. When no category is selected, ancestry and selected are null and children contains the top-level categories.",
       "type": "object",
-      "required": [
-        "ancestry",
-        "selected",
-        "children"
-      ],
+      "required": ["ancestry", "selected", "children"],
       "properties": {
         "ancestry": {
           "type": "array",
@@ -137,11 +144,7 @@
       "title": "CategoryFacetSearch",
       "description": "The current category facet search state.",
       "type": "object",
-      "required": [
-        "query",
-        "canShowMoreResults",
-        "results"
-      ],
+      "required": ["query", "canShowMoreResults", "results"],
       "properties": {
         "query": {
           "type": "string",
@@ -173,9 +176,7 @@
       "properties": {
         "payload": {
           "type": "object",
-          "required": [
-            "path"
-          ],
+          "required": ["path"],
           "properties": {
             "path": {
               "type": "array",
@@ -209,9 +210,7 @@
       "properties": {
         "payload": {
           "type": "object",
-          "required": [
-            "query"
-          ],
+          "required": ["query"],
           "properties": {
             "query": {
               "type": "string",
@@ -263,11 +262,7 @@
       "title": "CategoryFacetValue",
       "description": "A single category value. Used throughout the category facet state (ancestry, selected value, children) and as facet search results.",
       "type": "object",
-      "required": [
-        "path",
-        "value",
-        "numberOfResults"
-      ],
+      "required": ["path", "value", "numberOfResults"],
       "properties": {
         "path": {
           "type": "array",
@@ -289,4 +284,4 @@
       "additionalProperties": false
     }
   }
-}
+}

package/schema/components/commerce-search.schema.json

@@ -0,0 +1,45 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schema.thermidor.coveo.com/components/commerce-search.schema.json",
+  "title": "CommerceSearch",
+  "description": "Surface-root component for a commerce search surface. Its componentType carries the surface intent; it owns the surface's top-level components via children.",
+  "allOf": [
+    {
+      "$ref": "https://schema.thermidor.coveo.com/base/component.schema.json"
+    }
+  ],
+  "properties": {
+    "componentType": {
+      "type": "string",
+      "const": "commerce-search"
+    },
+    "state": {
+      "$ref": "#/$defs/CommerceSearchState"
+    },
+    "actions": {
+      "type": "object",
+      "properties": {},
+      "additionalProperties": false
+    },
+    "children": {
+      "type": "array",
+      "items": {
+        "$ref": "https://schema.thermidor.coveo.com/definitions/child-ref.schema.json"
+      },
+      "maxItems": 1000,
+      "default": []
+    },
+    "child": {
+      "$ref": "https://schema.thermidor.coveo.com/definitions/child-ref.schema.json"
+    }
+  },
+  "additionalProperties": false,
+  "$defs": {
+    "CommerceSearchState": {
+      "title": "CommerceSearchState",
+      "description": "The commerce search surface state. Owned exclusively by the backend.",
+      "type": "object",
+      "additionalProperties": false
+    }
+  }
+}