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

package/dist/generated/schemas.js

@@ -0,0 +1,539 @@
+// This file is generated from the canonical JSON Schema documents.
+// Do not edit it directly; run `mise run generate` from the repository root.
+import * as z from 'zod/v4';
+// The kind of action: "followup" triggers a conversational follow-up, "search" triggers a
+// standalone search.
+//
+// The kind of action selected: "followup" or "search".
+export const TypeSchema = z.enum(['followup', 'search']);
+// The selection state of a facet value, shared across all commerce facet components.
+//
+// The selection state of this facet value.
+export const FacetValueStateSchema = z.enum(['excluded', 'idle', 'selected']);
+// The selection state of a facet value that supports selection but not exclusion (e.g.
+// numeric and date facets). Constrained to 'idle' or 'selected'.
+//
+// The selection state of this facet value (idle or selected; exclusion is not supported).
+export const SelectableFacetValueStateSchema = z.enum(['idle', 'selected']);
+export const ProductSchema = z.strictObject({
+    additionalFields: z.record(z.string(), z.unknown()),
+    get children() {
+        return z.array(ProductSchema).optional();
+    },
+    clickUri: z.url().optional(),
+    ec_brand: z.string().optional(),
+    ec_category: z.array(z.string()).optional(),
+    ec_color: z.string().optional(),
+    ec_description: z.string().optional(),
+    ec_images: z.array(z.url()).optional(),
+    ec_in_stock: z.boolean().optional(),
+    ec_item_group_id: z.string().optional(),
+    ec_item_group_name: z.string().optional(),
+    ec_name: z.string(),
+    ec_price: z.number().optional(),
+    ec_promo_price: z.number().optional(),
+    ec_rating: z.union([z.number().min(0).max(5), z.null()]).optional(),
+    ec_shortdesc: z.string().optional(),
+    ec_thumbnails: z.array(z.url()).optional(),
+    permanentid: z.string(),
+});
+export const ProductCarouselActionsSchema = z.strictObject({});
+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']),
+});
+export const ActionItemSchema = z.strictObject({
+    text: z.string(),
+    type: z.enum(['followup', 'search']),
+});
+export const BundleDisplayActionsSchema = z.strictObject({});
+export const BundleSlotSchema = z.strictObject({
+    categoryLabel: z.string(),
+    surfaceRef: z.string(),
+});
+export const ComparisonTableActionsSchema = z.strictObject({});
+export const ComparisonAttributeSchema = z.strictObject({
+    key: z.string(),
+    label: z.string(),
+});
+export const ComparisonProductSchema = z.strictObject({
+    imageUrl: z.url().optional(),
+    name: z.string(),
+    price: z.number().optional(),
+    productId: z.string(),
+    rating: z.number().min(0).max(5).optional(),
+    values: z.record(z.string(), z.string()),
+});
+export const ProductListActionsSchema = z.strictObject({});
+export const ProductListStateSchema = z.strictObject({
+    products: z.array(ProductSchema),
+});
+export const SelectPagePayloadSchema = z.strictObject({
+    page: z.number().int().min(0),
+});
+export const SetPageSizePayloadSchema = z.strictObject({
+    pageSize: z.number().int().min(1),
+});
+export const PaginationStateSchema = z.strictObject({
+    page: z.number().int().min(0),
+    pageSize: z.number().int().min(1),
+    totalEntries: z.number().int().min(0),
+    totalPages: z.number().int().min(0),
+});
+export const SelectSortPayloadSchema = z.strictObject({
+    fields: z.array(z.unknown()),
+    sortCriteria: z.string(),
+});
+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(),
+});
+export const SearchPayloadSchema = z.strictObject({
+    query: z.string().min(0).max(1024),
+});
+export const RegularFacetToggleExcludePayloadSchema = z.strictObject({
+    value: z.string().min(1).max(1024),
+});
+export const RegularFacetToggleSelectPayloadSchema = z.strictObject({
+    value: z.string().min(1).max(1024),
+});
+export const RegularFacetToggleSingleExcludePayloadSchema = z.strictObject({
+    value: z.string().min(1).max(1024),
+});
+export const RegularFacetToggleSingleSelectPayloadSchema = z.strictObject({
+    value: z.string().min(1).max(1024),
+});
+export const RegularFacetSearchResultSchema = z.strictObject({
+    numberOfResults: z.number().int().min(0).max(999999999),
+    value: z.string().min(1).max(1024),
+});
+export const RegularFacetValueSchema = z.strictObject({
+    numberOfResults: z.number().int().min(0).max(999999999),
+    state: z.enum(['idle', 'selected', 'excluded']),
+    value: z.string().min(1).max(1024),
+});
+export const NumericFacetApplyCustomRangePayloadSchema = z.strictObject({
+    end: z.number(),
+    start: z.number(),
+});
+export const NumericFacetToggleSelectPayloadSchema = z.strictObject({
+    end: z.number(),
+    start: z.number(),
+});
+export const NumericFacetToggleSingleSelectPayloadSchema = z.strictObject({
+    end: z.number(),
+    start: z.number(),
+});
+export const NumericFacetCustomRangeSchema = z.strictObject({
+    end: z.number(),
+    numberOfResults: z.number().int().min(0),
+    start: z.number(),
+});
+export const NumericFacetDomainSchema = z.strictObject({
+    max: z.number().optional(),
+    min: z.number().optional(),
+});
+export const NumericFacetValueSchema = z.strictObject({
+    end: z.number(),
+    numberOfResults: z.number().int().min(0),
+    start: z.number(),
+    state: z.enum(['idle', 'selected']),
+});
+export const DateFacetApplyCustomRangePayloadSchema = z.strictObject({
+    end: z.string(),
+    start: z.string(),
+});
+export const DateFacetToggleSelectPayloadSchema = z.strictObject({
+    end: z.string(),
+    start: z.string(),
+});
+export const DateFacetToggleSingleSelectPayloadSchema = z.strictObject({
+    end: z.string(),
+    start: z.string(),
+});
+export const DateFacetCustomRangeSchema = z.strictObject({
+    end: z.string(),
+    numberOfResults: z.number().int().min(0),
+    start: z.string(),
+});
+export const DateFacetValueSchema = z.strictObject({
+    end: z.string(),
+    numberOfResults: z.number().int().min(0),
+    start: z.string(),
+    state: z.enum(['idle', 'selected']),
+});
+export const CategoryFacetSearchPayloadSchema = z.strictObject({
+    query: z.string().max(256),
+});
+export const CategoryFacetSelectPathPayloadSchema = z.strictObject({
+    path: z.array(z.string()),
+});
+export const CategoryFacetValueSchema = z.strictObject({
+    numberOfResults: z.number().int().min(0),
+    path: z.array(z.string()),
+    value: z.string(),
+});
+export const CategoryFacetValuesSchema = z.strictObject({
+    ancestry: z.array(CategoryFacetValueSchema),
+    children: z.array(CategoryFacetValueSchema),
+    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 ProductCarouselSchema = z.strictObject({
+    actions: ProductCarouselActionsSchema,
+    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,
+});
+export const NextActionsStateSchema = z.strictObject({
+    actions: z.array(ActionItemSchema),
+});
+export const BundleTierSchema = z.strictObject({
+    description: z.string(),
+    label: z.string(),
+    slots: z.array(BundleSlotSchema),
+});
+export const ComparisonTableStateSchema = z.strictObject({
+    attributes: z.array(ComparisonAttributeSchema),
+    products: z.array(ComparisonProductSchema),
+});
+export const ProductListSchema = z.strictObject({
+    actions: ProductListActionsSchema,
+    componentType: z.literal('product-list'),
+    state: ProductListStateSchema,
+});
+export const SelectPageSchema = z.strictObject({
+    payload: SelectPagePayloadSchema,
+});
+export const SetPageSizeSchema = z.strictObject({
+    payload: SetPageSizePayloadSchema,
+});
+export const SelectSortSchema = z.strictObject({
+    payload: SelectSortPayloadSchema,
+});
+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,
+});
+export const RegularFacetToggleExcludeSchema = z.strictObject({
+    payload: RegularFacetToggleExcludePayloadSchema,
+});
+export const RegularFacetToggleSelectSchema = z.strictObject({
+    payload: RegularFacetToggleSelectPayloadSchema,
+});
+export const RegularFacetToggleSingleExcludeSchema = z.strictObject({
+    payload: RegularFacetToggleSingleExcludePayloadSchema,
+});
+export const RegularFacetToggleSingleSelectSchema = z.strictObject({
+    payload: RegularFacetToggleSingleSelectPayloadSchema,
+});
+export const RegularFacetSearchSchema = z.strictObject({
+    canShowMoreResults: z.boolean(),
+    query: z.string().min(0).max(1024),
+    results: z.array(RegularFacetSearchResultSchema).max(1000),
+});
+export const NumericFacetApplyCustomRangeSchema = z.strictObject({
+    payload: NumericFacetApplyCustomRangePayloadSchema,
+});
+export const NumericFacetToggleSelectSchema = z.strictObject({
+    payload: NumericFacetToggleSelectPayloadSchema,
+});
+export const NumericFacetToggleSingleSelectSchema = z.strictObject({
+    payload: NumericFacetToggleSingleSelectPayloadSchema,
+});
+export const NumericFacetStateSchema = z.strictObject({
+    canShowLessValues: z.boolean(),
+    canShowMoreValues: z.boolean(),
+    customRange: z.union([NumericFacetCustomRangeSchema, z.null()]),
+    displayName: z.string(),
+    domain: NumericFacetDomainSchema.optional(),
+    field: z.string(),
+    hasActiveValues: z.boolean(),
+    values: z.array(NumericFacetValueSchema).max(500),
+});
+export const DateFacetApplyCustomRangeSchema = z.strictObject({
+    payload: DateFacetApplyCustomRangePayloadSchema,
+});
+export const DateFacetToggleSelectSchema = z.strictObject({
+    payload: DateFacetToggleSelectPayloadSchema,
+});
+export const DateFacetToggleSingleSelectSchema = z.strictObject({
+    payload: DateFacetToggleSingleSelectPayloadSchema,
+});
+export const DateFacetStateSchema = z.strictObject({
+    canShowLessValues: z.boolean(),
+    canShowMoreValues: z.boolean(),
+    customRange: z.union([DateFacetCustomRangeSchema, z.null()]),
+    displayName: z.string(),
+    field: z.string(),
+    hasActiveValues: z.boolean(),
+    values: z.array(DateFacetValueSchema),
+});
+export const CategoryFacetSearchSchema = z.strictObject({
+    payload: CategoryFacetSearchPayloadSchema,
+});
+export const CategoryFacetSelectPathSchema = z.strictObject({
+    payload: CategoryFacetSelectPathPayloadSchema,
+});
+export const FacetSearchClassSchema = z.strictObject({
+    canShowMoreResults: z.boolean(),
+    query: z.string().max(256),
+    results: z.array(CategoryFacetValueSchema),
+});
+export const FacetManagerSchema = z.strictObject({
+    actions: FacetManagerActionsSchema,
+    componentType: z.literal('facet-manager'),
+    state: FacetManagerStateSchema,
+});
+export const SetItemsSchema = z.strictObject({
+    payload: SetItemsPayloadSchema,
+});
+export const NextActionsBarActionsSchema = z.strictObject({
+    selectAction: SelectActionSchema,
+});
+export const BundleDisplayStateSchema = z.strictObject({
+    tiers: z.array(BundleTierSchema),
+});
+export const ComparisonTableSchema = z.strictObject({
+    actions: ComparisonTableActionsSchema,
+    componentType: z.literal('comparison-table'),
+    state: ComparisonTableStateSchema,
+});
+export const PaginationActionsSchema = z.strictObject({
+    selectPage: SelectPageSchema,
+    setPageSize: SetPageSizeSchema,
+});
+export const SortActionsSchema = z.strictObject({
+    selectSort: SelectSortSchema,
+});
+export const SearchBoxActionsSchema = z.strictObject({
+    submitQuery: SubmitQuerySchema,
+});
+export const RegularFacetActionsSchema = z.strictObject({
+    clearAllActiveValues: ActionSchema,
+    clearSearch: ActionSchema,
+    search: SearchSchema,
+    showLessValues: ActionSchema,
+    showMoreSearchResults: ActionSchema,
+    showMoreValues: ActionSchema,
+    toggleExclude: RegularFacetToggleExcludeSchema,
+    toggleSelect: RegularFacetToggleSelectSchema,
+    toggleSingleExclude: RegularFacetToggleSingleExcludeSchema,
+    toggleSingleSelect: RegularFacetToggleSingleSelectSchema,
+});
+export const RegularFacetStateSchema = z.strictObject({
+    canShowLessValues: z.boolean(),
+    canShowMoreValues: z.boolean(),
+    displayName: z.string().min(1).max(255),
+    facetSearch: RegularFacetSearchSchema,
+    field: z.string().min(1).max(255),
+    hasActiveValues: z.boolean(),
+    values: z.array(RegularFacetValueSchema).max(1000),
+});
+export const NumericFacetActionsSchema = z.strictObject({
+    applyCustomRange: NumericFacetApplyCustomRangeSchema,
+    clearAllActiveValues: ActionSchema,
+    showLessValues: ActionSchema,
+    showMoreValues: ActionSchema,
+    toggleSelect: NumericFacetToggleSelectSchema,
+    toggleSingleSelect: NumericFacetToggleSingleSelectSchema,
+});
+export const DateFacetActionsSchema = z.strictObject({
+    applyCustomRange: DateFacetApplyCustomRangeSchema,
+    clearAllActiveValues: ActionSchema,
+    showLessValues: ActionSchema,
+    showMoreValues: ActionSchema,
+    toggleSelect: DateFacetToggleSelectSchema,
+    toggleSingleSelect: DateFacetToggleSingleSelectSchema,
+});
+export const CategoryFacetActionsSchema = z.strictObject({
+    clearSearch: ActionSchema,
+    clearSelectedPath: ActionSchema,
+    search: CategoryFacetSearchSchema,
+    selectPath: CategoryFacetSelectPathSchema,
+    showLessValues: ActionSchema,
+    showMoreSearchResults: ActionSchema,
+    showMoreValues: ActionSchema,
+});
+export const CategoryFacetStateSchema = z.strictObject({
+    canShowLessValues: z.boolean(),
+    canShowMoreValues: z.boolean(),
+    displayName: z.string(),
+    facetSearch: FacetSearchClassSchema,
+    field: z.string(),
+    values: CategoryFacetValuesSchema,
+});
+export const CartActionsSchema = z.strictObject({
+    setItems: SetItemsSchema,
+    updateItemQuantity: UpdateItemQuantitySchema,
+});
+export const NextActionsBarSchema = z.strictObject({
+    actions: NextActionsBarActionsSchema,
+    componentType: z.literal('next-actions-bar'),
+    state: NextActionsStateSchema,
+});
+export const BundleDisplaySchema = z.strictObject({
+    actions: BundleDisplayActionsSchema,
+    componentType: z.literal('bundle-display'),
+    state: BundleDisplayStateSchema,
+});
+export const PaginationSchema = z.strictObject({
+    actions: PaginationActionsSchema,
+    componentType: z.literal('pagination'),
+    state: PaginationStateSchema,
+});
+export const SortSchema = z.strictObject({
+    actions: SortActionsSchema,
+    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,
+    componentType: z.literal('regular-facet'),
+    state: RegularFacetStateSchema,
+});
+export const NumericFacetSchema = z.strictObject({
+    actions: NumericFacetActionsSchema,
+    componentType: z.literal('numeric-facet'),
+    state: NumericFacetStateSchema,
+});
+export const DateFacetSchema = z.strictObject({
+    actions: DateFacetActionsSchema,
+    componentType: z.literal('date-facet'),
+    state: DateFacetStateSchema,
+});
+export const CategoryFacetSchema = z.strictObject({
+    actions: CategoryFacetActionsSchema,
+    componentType: z.literal('category-facet'),
+    state: CategoryFacetStateSchema,
+});
+export const CartSchema = z.strictObject({
+    actions: CartActionsSchema,
+    componentType: z.literal('cart'),
+    state: CartStateSchema,
+});
+export const ComponentContractsSchema = z.discriminatedUnion('componentType', [
+    ProductCarouselSchema,
+    CartSchema,
+    NextActionsBarSchema,
+    BundleDisplaySchema,
+    ComparisonTableSchema,
+    ProductListSchema,
+    PaginationSchema,
+    SortSchema,
+    SearchBoxSchema,
+    RegularFacetSchema,
+    NumericFacetSchema,
+    DateFacetSchema,
+    CategoryFacetSchema,
+    FacetManagerSchema,
+]);
+/**
+ * Component props schemas.
+ * These props are injected by the A2-UI surface layer (backend) and passed to catalog
+ * renderers automatically. Consumers should NOT hardcode these values; they arrive via
+ * the createSurface message's components[].props.
+ */
+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 ComparisonTablePropsSchema = z.object({
+    componentId: z.string(),
+    componentType: z.literal('comparison-table'),
+});
+export const DateFacetPropsSchema = z.object({
+    componentId: z.string(),
+    componentType: z.literal('date-facet'),
+});
+export const FacetManagerPropsSchema = z.object({
+    componentId: z.string(),
+    componentType: z.literal('facet-manager'),
+});
+export const NextActionsBarPropsSchema = z.object({
+    componentId: z.string(),
+    componentType: z.literal('next-actions-bar'),
+});
+export const NumericFacetPropsSchema = z.object({
+    componentId: z.string(),
+    componentType: z.literal('numeric-facet'),
+});
+export const PaginationPropsSchema = z.object({
+    componentId: z.string(),
+    componentType: z.literal('pagination'),
+});
+export const ProductCarouselPropsSchema = z.object({
+    componentId: z.string(),
+    componentType: z.literal('product-carousel'),
+});
+export const ProductListPropsSchema = z.object({
+    componentId: z.string(),
+    componentType: z.literal('product-list'),
+});
+export const RegularFacetPropsSchema = z.object({
+    componentId: z.string(),
+    componentType: z.literal('regular-facet'),
+});
+export const SearchBoxPropsSchema = z.object({
+    componentId: z.string(),
+    componentType: z.literal('search-box'),
+});
+export const SortPropsSchema = z.object({
+    componentId: z.string(),
+    componentType: z.literal('sort'),
+});

package/dist/index.d.ts

@@ -0,0 +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';

package/dist/index.js

@@ -0,0 +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';

package/package.json

@@ -1,12 +1,50 @@
 {
   "name": "@coveo/thermidor-schema",
-  "version": "0.0.0",
-  "description": "",
-  "license": "ISC",
-  "author": "Coveo",
-  "type": "commonjs",
-  "main": "index.js",
+  "version": "1.0.0-beta.2",
+  "description": "Zod and TypeScript projections of the Thermidor JSON Schema contract.",
+  "license": "Apache-2.0",
+  "type": "module",
+  "sideEffects": false,
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/coveo-platform/thermidor-schema.git",
+    "directory": "packages/typescript"
+  },
+  "bugs": {
+    "url": "https://github.com/coveo-platform/thermidor-schema/issues"
+  },
+  "homepage": "https://github.com/coveo-platform/thermidor-schema#readme",
+  "types": "./dist/index.d.ts",
+  "engines": {
+    "node": ">=22.14.0"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./schema/*": "./schema/*"
+  },
+  "files": [
+    "dist",
+    "schema",
+    "README.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "zod": "^4.4.3"
+  },
+  "devDependencies": {
+    "typescript": "7.0.2",
+    "vitest": "4.1.11",
+    "zod": "4.4.3"
+  },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "build": "node scripts/clean-build.mjs && tsc --project tsconfig.json",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit --project tsconfig.json"
   }
-}
+}

package/schema/base/action.schema.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schema.thermidor.coveo.com/base/action.schema.json",
+  "title": "Action",
+  "description": "An Action is the only mechanism through which the frontend can trigger a state change on a Controller. Actions are emitted by the frontend and processed by the backend. The action name is the key in the Controller's actions map and payload carries the runtime parameters.",
+  "type": "object",
+  "required": ["payload"],
+  "properties": {
+    "payload": true
+  },
+  "additionalProperties": false
+}

package/schema/base/catalog.schema.json

@@ -0,0 +1,37 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schema.thermidor.coveo.com/base/catalog.schema.json",
+  "title": "Catalog",
+  "description": "A Catalog is the top-level registry of all available UI Components. It is the entry point of the Thermidor contract: both the backend (producer) and the frontend (consumer) reference the same Catalog to know what components exist and how they are structured. For the initial implementation, a Catalog corresponds to an A2-UI catalog.",
+  "type": "object",
+  "required": ["catalogId", "version", "components"],
+  "properties": {
+    "catalogId": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9-]*$",
+      "description": "Stable kebab-case identifier for this catalog (e.g. 'a2ui-commerce-v1'). Used by both producer and consumer to identify which contract version they are implementing."
+    },
+    "version": {
+      "type": "string",
+      "pattern": "^\\d+\\.\\d+\\.\\d+$",
+      "description": "Semantic version of this catalog definition (e.g. '0.1.0'). Versioning strategy is deferred to a future ADR."
+    },
+    "description": {
+      "type": "string",
+      "description": "Human-readable description of what this catalog covers."
+    },
+    "components": {
+      "type": "array",
+      "minItems": 1,
+      "description": "The complete set of Components registered in this catalog. Order is not significant.",
+      "items": {
+        "$ref": "https://schema.thermidor.coveo.com/base/component.schema.json"
+      }
+    },
+    "$schema": {
+      "type": "string",
+      "description": "Optional JSON Schema meta-annotation. Included here so that catalog documents may carry a '$schema' pointer to this schema for tooling support (IDE validation, etc.) without failing additionalProperties checks."
+    }
+  },
+  "additionalProperties": false
+}