@coveo/thermidor-schema 1.0.0-beta.23 → 1.0.0-beta.24

package/dist/generated/schemas.d.ts

@@ -975,6 +975,7 @@ export declare const NextActionsBarActionsSchema: z.ZodObject<{
 }, z.core.$strict>;
 export type NextActionsBarActions = z.infer<typeof NextActionsBarActionsSchema>;
 export declare const BundleDisplayStateSchema: z.ZodObject<{
+    heading: z.ZodOptional<z.ZodString>;
     tiers: z.ZodArray<z.ZodObject<{
         description: z.ZodString;
         label: z.ZodString;
@@ -1371,6 +1372,7 @@ export declare const BundleDisplaySchema: z.ZodObject<{
     component: z.ZodLiteral<"BundleDisplay">;
     id: z.ZodString;
     state: z.ZodOptional<z.ZodObject<{
+        heading: z.ZodOptional<z.ZodString>;
         tiers: z.ZodArray<z.ZodObject<{
             description: z.ZodString;
             label: z.ZodString;
@@ -1993,6 +1995,7 @@ export declare const ComponentContractsSchema: z.ZodDiscriminatedUnion<[z.ZodObj
     component: z.ZodLiteral<"BundleDisplay">;
     id: z.ZodString;
     state: z.ZodOptional<z.ZodObject<{
+        heading: z.ZodOptional<z.ZodString>;
         tiers: z.ZodArray<z.ZodObject<{
             description: z.ZodString;
             label: z.ZodString;
@@ -2597,6 +2600,21 @@ export type DynamicAction = z.infer<typeof DynamicActionSchema>;
  * untouched. The resolved shape a renderer actually reads is the `XxxProps` type.
  */
 export declare const BundleDisplayPropsSchema: z.ZodObject<{
+    heading: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+        path: z.ZodString;
+    }, z.core.$strict>, z.ZodObject<{
+        call: z.ZodString;
+        args: z.ZodRecord<z.ZodString, z.ZodAny>;
+        returnType: z.ZodDefault<z.ZodEnum<{
+            any: "any";
+            array: "array";
+            boolean: "boolean";
+            number: "number";
+            object: "object";
+            string: "string";
+            void: "void";
+        }>>;
+    }, z.core.$strip>]>>;
     tiers: z.ZodUnion<readonly [z.ZodArray<z.ZodObject<{
         description: z.ZodString;
         label: z.ZodString;
@@ -3085,7 +3103,7 @@ export declare const NumericFacetPropsSchema: z.ZodObject<{
             void: "void";
         }>>;
     }, z.core.$strip>]>;
-    domain: z.ZodUnion<readonly [z.ZodOptional<z.ZodObject<{
+    domain: z.ZodOptional<z.ZodUnion<readonly [z.ZodOptional<z.ZodObject<{
         max: z.ZodOptional<z.ZodNumber>;
         min: z.ZodOptional<z.ZodNumber>;
     }, z.core.$strict>>, z.ZodObject<{
@@ -3102,7 +3120,7 @@ export declare const NumericFacetPropsSchema: z.ZodObject<{
             string: "string";
             void: "void";
         }>>;
-    }, z.core.$strip>]>;
+    }, z.core.$strip>]>>;
 }, z.core.$strip>;
 export declare const PageSizePropsSchema: z.ZodObject<{
     pageSize: z.ZodUnion<readonly [z.ZodNumber, z.ZodObject<{

package/dist/generated/schemas.js

@@ -469,6 +469,7 @@ export const NextActionsBarActionsSchema = z.strictObject({
     selectSearchOption: SelectSearchOptionSchema,
 });
 export const BundleDisplayStateSchema = z.strictObject({
+    heading: z.string().optional(),
     tiers: z.array(BundleTierSchema),
 });
 export const ComparisonTableSchema = z.looseObject({
@@ -711,6 +712,7 @@ export const DynamicActionSchema = z.object({
  * untouched. The resolved shape a renderer actually reads is the `XxxProps` type.
  */
 export const BundleDisplayPropsSchema = z.object({
+    heading: DynamicStringSchema.optional(),
     tiers: z.union([BundleDisplayStateSchema.shape['tiers'], DataBindingSchema, FunctionCallSchema]),
 });
 export const CartPropsSchema = z.object({});
@@ -787,7 +789,9 @@ export const NumericFacetPropsSchema = z.object({
     hasActiveValues: DynamicBooleanSchema,
     canShowMoreValues: DynamicBooleanSchema,
     canShowLessValues: DynamicBooleanSchema,
-    domain: z.union([NumericFacetStateSchema.shape['domain'], DataBindingSchema, FunctionCallSchema]),
+    domain: z
+        .union([NumericFacetStateSchema.shape['domain'], DataBindingSchema, FunctionCallSchema])
+        .optional(),
 });
 export const PageSizePropsSchema = z.object({
     pageSize: DynamicNumberSchema,

package/dist/generated/zod3/schemas.d.ts

@@ -3628,6 +3628,7 @@ export declare const NextActionsBarActionsSchema: z.ZodObject<{
 }>;
 export type NextActionsBarActions = z.infer<typeof NextActionsBarActionsSchema>;
 export declare const BundleDisplayStateSchema: z.ZodObject<{
+    heading: z.ZodOptional<z.ZodString>;
     tiers: z.ZodArray<z.ZodObject<{
         description: z.ZodString;
         label: z.ZodString;
@@ -3660,6 +3661,7 @@ export declare const BundleDisplayStateSchema: z.ZodObject<{
         total: number;
     }>, "many">;
 }, "strict", z.ZodTypeAny, {
+    heading?: string | undefined;
     tiers: {
         description: string;
         label: string;
@@ -3670,6 +3672,7 @@ export declare const BundleDisplayStateSchema: z.ZodObject<{
         total: number;
     }[];
 }, {
+    heading?: string | undefined;
     tiers: {
         description: string;
         label: string;
@@ -6091,6 +6094,7 @@ export declare const BundleDisplaySchema: z.ZodObject<{
     component: z.ZodLiteral<"BundleDisplay">;
     id: z.ZodString;
     state: z.ZodOptional<z.ZodObject<{
+        heading: z.ZodOptional<z.ZodString>;
         tiers: z.ZodArray<z.ZodObject<{
             description: z.ZodString;
             label: z.ZodString;
@@ -6123,6 +6127,7 @@ export declare const BundleDisplaySchema: z.ZodObject<{
             total: number;
         }>, "many">;
     }, "strict", z.ZodTypeAny, {
+        heading?: string | undefined;
         tiers: {
             description: string;
             label: string;
@@ -6133,6 +6138,7 @@ export declare const BundleDisplaySchema: z.ZodObject<{
             total: number;
         }[];
     }, {
+        heading?: string | undefined;
         tiers: {
             description: string;
             label: string;
@@ -6148,6 +6154,7 @@ export declare const BundleDisplaySchema: z.ZodObject<{
     component: z.ZodLiteral<"BundleDisplay">;
     id: z.ZodString;
     state: z.ZodOptional<z.ZodObject<{
+        heading: z.ZodOptional<z.ZodString>;
         tiers: z.ZodArray<z.ZodObject<{
             description: z.ZodString;
             label: z.ZodString;
@@ -6180,6 +6187,7 @@ export declare const BundleDisplaySchema: z.ZodObject<{
             total: number;
         }>, "many">;
     }, "strict", z.ZodTypeAny, {
+        heading?: string | undefined;
         tiers: {
             description: string;
             label: string;
@@ -6190,6 +6198,7 @@ export declare const BundleDisplaySchema: z.ZodObject<{
             total: number;
         }[];
     }, {
+        heading?: string | undefined;
         tiers: {
             description: string;
             label: string;
@@ -6205,6 +6214,7 @@ export declare const BundleDisplaySchema: z.ZodObject<{
     component: z.ZodLiteral<"BundleDisplay">;
     id: z.ZodString;
     state: z.ZodOptional<z.ZodObject<{
+        heading: z.ZodOptional<z.ZodString>;
         tiers: z.ZodArray<z.ZodObject<{
             description: z.ZodString;
             label: z.ZodString;
@@ -6237,6 +6247,7 @@ export declare const BundleDisplaySchema: z.ZodObject<{
             total: number;
         }>, "many">;
     }, "strict", z.ZodTypeAny, {
+        heading?: string | undefined;
         tiers: {
             description: string;
             label: string;
@@ -6247,6 +6258,7 @@ export declare const BundleDisplaySchema: z.ZodObject<{
             total: number;
         }[];
     }, {
+        heading?: string | undefined;
         tiers: {
             description: string;
             label: string;
@@ -13720,6 +13732,7 @@ export declare const ComponentContractsSchema: z.ZodDiscriminatedUnion<"componen
     component: z.ZodLiteral<"BundleDisplay">;
     id: z.ZodString;
     state: z.ZodOptional<z.ZodObject<{
+        heading: z.ZodOptional<z.ZodString>;
         tiers: z.ZodArray<z.ZodObject<{
             description: z.ZodString;
             label: z.ZodString;
@@ -13752,6 +13765,7 @@ export declare const ComponentContractsSchema: z.ZodDiscriminatedUnion<"componen
             total: number;
         }>, "many">;
     }, "strict", z.ZodTypeAny, {
+        heading?: string | undefined;
         tiers: {
             description: string;
             label: string;
@@ -13762,6 +13776,7 @@ export declare const ComponentContractsSchema: z.ZodDiscriminatedUnion<"componen
             total: number;
         }[];
     }, {
+        heading?: string | undefined;
         tiers: {
             description: string;
             label: string;
@@ -13777,6 +13792,7 @@ export declare const ComponentContractsSchema: z.ZodDiscriminatedUnion<"componen
     component: z.ZodLiteral<"BundleDisplay">;
     id: z.ZodString;
     state: z.ZodOptional<z.ZodObject<{
+        heading: z.ZodOptional<z.ZodString>;
         tiers: z.ZodArray<z.ZodObject<{
             description: z.ZodString;
             label: z.ZodString;
@@ -13809,6 +13825,7 @@ export declare const ComponentContractsSchema: z.ZodDiscriminatedUnion<"componen
             total: number;
         }>, "many">;
     }, "strict", z.ZodTypeAny, {
+        heading?: string | undefined;
         tiers: {
             description: string;
             label: string;
@@ -13819,6 +13836,7 @@ export declare const ComponentContractsSchema: z.ZodDiscriminatedUnion<"componen
             total: number;
         }[];
     }, {
+        heading?: string | undefined;
         tiers: {
             description: string;
             label: string;
@@ -13834,6 +13852,7 @@ export declare const ComponentContractsSchema: z.ZodDiscriminatedUnion<"componen
     component: z.ZodLiteral<"BundleDisplay">;
     id: z.ZodString;
     state: z.ZodOptional<z.ZodObject<{
+        heading: z.ZodOptional<z.ZodString>;
         tiers: z.ZodArray<z.ZodObject<{
             description: z.ZodString;
             label: z.ZodString;
@@ -13866,6 +13885,7 @@ export declare const ComponentContractsSchema: z.ZodDiscriminatedUnion<"componen
             total: number;
         }>, "many">;
     }, "strict", z.ZodTypeAny, {
+        heading?: string | undefined;
         tiers: {
             description: string;
             label: string;
@@ -13876,6 +13896,7 @@ export declare const ComponentContractsSchema: z.ZodDiscriminatedUnion<"componen
             total: number;
         }[];
     }, {
+        heading?: string | undefined;
         tiers: {
             description: string;
             label: string;
@@ -19952,6 +19973,25 @@ export type DynamicAction = z.infer<typeof DynamicActionSchema>;
  * untouched. The resolved shape a renderer actually reads is the `XxxProps` type.
  */
 export declare const BundleDisplayPropsSchema: z.ZodObject<{
+    heading: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodObject<{
+        path: z.ZodString;
+    }, "strict", z.ZodTypeAny, {
+        path: string;
+    }, {
+        path: string;
+    }>, z.ZodObject<{
+        call: z.ZodString;
+        args: z.ZodRecord<z.ZodString, z.ZodAny>;
+        returnType: z.ZodDefault<z.ZodEnum<["string", "number", "boolean", "array", "object", "any", "void"]>>;
+    }, "strip", z.ZodTypeAny, {
+        call: string;
+        args: Record<string, any>;
+        returnType: "any" | "array" | "boolean" | "number" | "object" | "string" | "void";
+    }, {
+        call: string;
+        args: Record<string, any>;
+        returnType?: "any" | "array" | "boolean" | "number" | "object" | "string" | "void" | undefined;
+    }>]>>;
     tiers: z.ZodUnion<[z.ZodArray<z.ZodObject<{
         description: z.ZodString;
         label: z.ZodString;
@@ -20002,6 +20042,13 @@ export declare const BundleDisplayPropsSchema: z.ZodObject<{
         returnType?: "any" | "array" | "boolean" | "number" | "object" | "string" | "void" | undefined;
     }>]>;
 }, "strip", z.ZodTypeAny, {
+    heading?: string | {
+        path: string;
+    } | {
+        call: string;
+        args: Record<string, any>;
+        returnType: "any" | "array" | "boolean" | "number" | "object" | "string" | "void";
+    } | undefined;
     tiers: {
         description: string;
         label: string;
@@ -20018,6 +20065,13 @@ export declare const BundleDisplayPropsSchema: z.ZodObject<{
         returnType: "any" | "array" | "boolean" | "number" | "object" | "string" | "void";
     };
 }, {
+    heading?: string | {
+        path: string;
+    } | {
+        call: string;
+        args: Record<string, any>;
+        returnType?: "any" | "array" | "boolean" | "number" | "object" | "string" | "void" | undefined;
+    } | undefined;
     tiers: {
         description: string;
         label: string;
@@ -21130,7 +21184,7 @@ export declare const NumericFacetPropsSchema: z.ZodObject<{
         args: Record<string, any>;
         returnType?: "any" | "array" | "boolean" | "number" | "object" | "string" | "void" | undefined;
     }>]>;
-    domain: z.ZodUnion<[z.ZodOptional<z.ZodObject<{
+    domain: z.ZodOptional<z.ZodUnion<[z.ZodOptional<z.ZodObject<{
         max: z.ZodOptional<z.ZodNumber>;
         min: z.ZodOptional<z.ZodNumber>;
     }, "strict", z.ZodTypeAny, {
@@ -21157,7 +21211,7 @@ export declare const NumericFacetPropsSchema: z.ZodObject<{
         call: string;
         args: Record<string, any>;
         returnType?: "any" | "array" | "boolean" | "number" | "object" | "string" | "void" | undefined;
-    }>]>;
+    }>]>>;
 }, "strip", z.ZodTypeAny, {
     field: string | {
         path: string;

package/dist/generated/zod3/schemas.js

@@ -471,6 +471,7 @@ export const NextActionsBarActionsSchema = z.strictObject({
     selectSearchOption: SelectSearchOptionSchema,
 });
 export const BundleDisplayStateSchema = z.strictObject({
+    heading: z.string().optional(),
     tiers: z.array(BundleTierSchema),
 });
 export const ComparisonTableSchema = z.looseObject({
@@ -713,6 +714,7 @@ export const DynamicActionSchema = z.object({
  * untouched. The resolved shape a renderer actually reads is the `XxxProps` type.
  */
 export const BundleDisplayPropsSchema = z.object({
+    heading: DynamicStringSchema.optional(),
     tiers: z.union([BundleDisplayStateSchema.shape['tiers'], DataBindingSchema, FunctionCallSchema]),
 });
 export const CartPropsSchema = z.object({});
@@ -789,7 +791,9 @@ export const NumericFacetPropsSchema = z.object({
     hasActiveValues: DynamicBooleanSchema,
     canShowMoreValues: DynamicBooleanSchema,
     canShowLessValues: DynamicBooleanSchema,
-    domain: z.union([NumericFacetStateSchema.shape['domain'], DataBindingSchema, FunctionCallSchema]),
+    domain: z
+        .union([NumericFacetStateSchema.shape['domain'], DataBindingSchema, FunctionCallSchema])
+        .optional(),
 });
 export const PageSizePropsSchema = z.object({
     pageSize: DynamicNumberSchema,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coveo/thermidor-schema",
-  "version": "1.0.0-beta.23",
+  "version": "1.0.0-beta.24",
   "description": "Zod and TypeScript projections of the Thermidor JSON Schema contract.",
   "homepage": "https://github.com/coveo-platform/thermidor-schema#readme",
   "bugs": {

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

@@ -16,6 +16,10 @@
       "type": "string",
       "const": "BundleDisplay"
     },
+    "heading": {
+      "$ref": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
+      "description": "The optional bundle heading, bound to /state/<id>/heading."
+    },
     "tiers": {
       "$ref": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
       "description": "The tiered bundle layout, bound to /state/<id>/tiers via a { \"path\": ... } Data_Binding."
@@ -38,6 +42,10 @@
       "type": "object",
       "required": ["tiers"],
       "properties": {
+        "heading": {
+          "type": "string",
+          "description": "Shopper-facing title displayed above the bundle tiers. Renderers omit the heading when it is absent."
+        },
         "tiers": {
           "type": "array",
           "description": "Ordered list of bundle tiers to render.",