@coveo/thermidor-schema 1.0.0-beta.26 → 1.0.0-beta.27

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -350,40 +350,13 @@ export declare const ProductSummaryStateSchema: z.ZodObject<{
350
350
  export type ProductSummaryState = z.infer<typeof ProductSummaryStateSchema>;
351
351
  export declare const ProductResearchCardActionsSchema: z.ZodObject<{}, z.core.$strict>;
352
352
  export type ProductResearchCardActions = z.infer<typeof ProductResearchCardActionsSchema>;
353
- export declare const ProductResearchCardStateSchema: z.ZodObject<{
354
- bullets: z.ZodArray<z.ZodString>;
355
- product: z.ZodObject<{
356
- additionalFields: z.ZodRecord<z.ZodString, z.ZodUnknown>;
357
- badgePlacements: z.ZodOptional<z.ZodArray<z.ZodObject<{
358
- badges: z.ZodArray<z.ZodObject<{
359
- backgroundColor: z.ZodOptional<z.ZodString>;
360
- iconUrl: z.ZodOptional<z.ZodString>;
361
- text: z.ZodString;
362
- textColor: z.ZodOptional<z.ZodString>;
363
- }, z.core.$strict>>;
364
- placementId: z.ZodString;
365
- }, z.core.$strict>>>;
366
- children: z.ZodOptional<z.ZodArray<z.ZodObject</*elided*/ any, z.core.$strict>>>;
367
- clickUri: z.ZodOptional<z.ZodString>;
368
- ec_brand: z.ZodOptional<z.ZodString>;
369
- ec_category: z.ZodOptional<z.ZodArray<z.ZodString>>;
370
- ec_color: z.ZodOptional<z.ZodString>;
371
- ec_description: z.ZodOptional<z.ZodString>;
372
- ec_images: z.ZodOptional<z.ZodArray<z.ZodString>>;
373
- ec_in_stock: z.ZodOptional<z.ZodBoolean>;
374
- ec_item_group_id: z.ZodOptional<z.ZodString>;
375
- ec_item_group_name: z.ZodOptional<z.ZodString>;
376
- ec_name: z.ZodString;
377
- ec_price: z.ZodOptional<z.ZodNumber>;
378
- ec_promo_price: z.ZodOptional<z.ZodNumber>;
379
- ec_rating: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodNull]>>;
380
- ec_shortdesc: z.ZodOptional<z.ZodString>;
381
- ec_thumbnails: z.ZodOptional<z.ZodArray<z.ZodString>>;
382
- permanentid: z.ZodString;
383
- }, z.core.$strict>;
384
- summary: z.ZodString;
353
+ export declare const ProductResearchRelatedDocumentSchema: z.ZodObject<{
354
+ clickUri: z.ZodOptional<z.ZodString>;
355
+ filetype: z.ZodOptional<z.ZodString>;
356
+ size: z.ZodOptional<z.ZodNumber>;
357
+ title: z.ZodString;
385
358
  }, z.core.$strict>;
386
- export type ProductResearchCardState = z.infer<typeof ProductResearchCardStateSchema>;
359
+ export type ProductResearchRelatedDocument = z.infer<typeof ProductResearchRelatedDocumentSchema>;
387
360
  export declare const SelectPagePayloadSchema: z.ZodObject<{
388
361
  page: z.ZodNumber;
389
362
  }, z.core.$strict>;
@@ -884,45 +857,46 @@ export declare const ProductSummarySchema: z.ZodObject<{
884
857
  }, z.core.$strict>>;
885
858
  }, z.core.$loose>;
886
859
  export type ProductSummary = z.infer<typeof ProductSummarySchema>;
887
- export declare const ProductResearchCardSchema: z.ZodObject<{
888
- actions: z.ZodOptional<z.ZodObject<{}, z.core.$strict>>;
889
- component: z.ZodLiteral<"ProductResearchCard">;
890
- id: z.ZodString;
891
- state: z.ZodOptional<z.ZodObject<{
892
- bullets: z.ZodArray<z.ZodString>;
893
- product: z.ZodObject<{
894
- additionalFields: z.ZodRecord<z.ZodString, z.ZodUnknown>;
895
- badgePlacements: z.ZodOptional<z.ZodArray<z.ZodObject<{
896
- badges: z.ZodArray<z.ZodObject<{
897
- backgroundColor: z.ZodOptional<z.ZodString>;
898
- iconUrl: z.ZodOptional<z.ZodString>;
899
- text: z.ZodString;
900
- textColor: z.ZodOptional<z.ZodString>;
901
- }, z.core.$strict>>;
902
- placementId: z.ZodString;
903
- }, z.core.$strict>>>;
904
- children: z.ZodOptional<z.ZodArray<z.ZodObject</*elided*/ any, z.core.$strict>>>;
905
- clickUri: z.ZodOptional<z.ZodString>;
906
- ec_brand: z.ZodOptional<z.ZodString>;
907
- ec_category: z.ZodOptional<z.ZodArray<z.ZodString>>;
908
- ec_color: z.ZodOptional<z.ZodString>;
909
- ec_description: z.ZodOptional<z.ZodString>;
910
- ec_images: z.ZodOptional<z.ZodArray<z.ZodString>>;
911
- ec_in_stock: z.ZodOptional<z.ZodBoolean>;
912
- ec_item_group_id: z.ZodOptional<z.ZodString>;
913
- ec_item_group_name: z.ZodOptional<z.ZodString>;
914
- ec_name: z.ZodString;
915
- ec_price: z.ZodOptional<z.ZodNumber>;
916
- ec_promo_price: z.ZodOptional<z.ZodNumber>;
917
- ec_rating: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodNull]>>;
918
- ec_shortdesc: z.ZodOptional<z.ZodString>;
919
- ec_thumbnails: z.ZodOptional<z.ZodArray<z.ZodString>>;
920
- permanentid: z.ZodString;
921
- }, z.core.$strict>;
922
- summary: z.ZodString;
923
- }, z.core.$strict>>;
924
- }, z.core.$loose>;
925
- export type ProductResearchCard = z.infer<typeof ProductResearchCardSchema>;
860
+ export declare const ProductResearchCardStateSchema: z.ZodObject<{
861
+ bullets: z.ZodArray<z.ZodString>;
862
+ product: z.ZodObject<{
863
+ additionalFields: z.ZodRecord<z.ZodString, z.ZodUnknown>;
864
+ badgePlacements: z.ZodOptional<z.ZodArray<z.ZodObject<{
865
+ badges: z.ZodArray<z.ZodObject<{
866
+ backgroundColor: z.ZodOptional<z.ZodString>;
867
+ iconUrl: z.ZodOptional<z.ZodString>;
868
+ text: z.ZodString;
869
+ textColor: z.ZodOptional<z.ZodString>;
870
+ }, z.core.$strict>>;
871
+ placementId: z.ZodString;
872
+ }, z.core.$strict>>>;
873
+ children: z.ZodOptional<z.ZodArray<z.ZodObject</*elided*/ any, z.core.$strict>>>;
874
+ clickUri: z.ZodOptional<z.ZodString>;
875
+ ec_brand: z.ZodOptional<z.ZodString>;
876
+ ec_category: z.ZodOptional<z.ZodArray<z.ZodString>>;
877
+ ec_color: z.ZodOptional<z.ZodString>;
878
+ ec_description: z.ZodOptional<z.ZodString>;
879
+ ec_images: z.ZodOptional<z.ZodArray<z.ZodString>>;
880
+ ec_in_stock: z.ZodOptional<z.ZodBoolean>;
881
+ ec_item_group_id: z.ZodOptional<z.ZodString>;
882
+ ec_item_group_name: z.ZodOptional<z.ZodString>;
883
+ ec_name: z.ZodString;
884
+ ec_price: z.ZodOptional<z.ZodNumber>;
885
+ ec_promo_price: z.ZodOptional<z.ZodNumber>;
886
+ ec_rating: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodNull]>>;
887
+ ec_shortdesc: z.ZodOptional<z.ZodString>;
888
+ ec_thumbnails: z.ZodOptional<z.ZodArray<z.ZodString>>;
889
+ permanentid: z.ZodString;
890
+ }, z.core.$strict>;
891
+ relatedDocuments: z.ZodOptional<z.ZodArray<z.ZodObject<{
892
+ clickUri: z.ZodOptional<z.ZodString>;
893
+ filetype: z.ZodOptional<z.ZodString>;
894
+ size: z.ZodOptional<z.ZodNumber>;
895
+ title: z.ZodString;
896
+ }, z.core.$strict>>>;
897
+ summary: z.ZodString;
898
+ }, z.core.$strict>;
899
+ export type ProductResearchCardState = z.infer<typeof ProductResearchCardStateSchema>;
926
900
  export declare const SelectPageSchema: z.ZodObject<{
927
901
  payload: z.ZodObject<{
928
902
  page: z.ZodNumber;
@@ -1313,6 +1287,51 @@ export declare const ProductListActionsSchema: z.ZodObject<{
1313
1287
  }, z.core.$strict>;
1314
1288
  }, z.core.$strict>;
1315
1289
  export type ProductListActions = z.infer<typeof ProductListActionsSchema>;
1290
+ export declare const ProductResearchCardSchema: z.ZodObject<{
1291
+ actions: z.ZodOptional<z.ZodObject<{}, z.core.$strict>>;
1292
+ component: z.ZodLiteral<"ProductResearchCard">;
1293
+ id: z.ZodString;
1294
+ state: z.ZodOptional<z.ZodObject<{
1295
+ bullets: z.ZodArray<z.ZodString>;
1296
+ product: z.ZodObject<{
1297
+ additionalFields: z.ZodRecord<z.ZodString, z.ZodUnknown>;
1298
+ badgePlacements: z.ZodOptional<z.ZodArray<z.ZodObject<{
1299
+ badges: z.ZodArray<z.ZodObject<{
1300
+ backgroundColor: z.ZodOptional<z.ZodString>;
1301
+ iconUrl: z.ZodOptional<z.ZodString>;
1302
+ text: z.ZodString;
1303
+ textColor: z.ZodOptional<z.ZodString>;
1304
+ }, z.core.$strict>>;
1305
+ placementId: z.ZodString;
1306
+ }, z.core.$strict>>>;
1307
+ children: z.ZodOptional<z.ZodArray<z.ZodObject</*elided*/ any, z.core.$strict>>>;
1308
+ clickUri: z.ZodOptional<z.ZodString>;
1309
+ ec_brand: z.ZodOptional<z.ZodString>;
1310
+ ec_category: z.ZodOptional<z.ZodArray<z.ZodString>>;
1311
+ ec_color: z.ZodOptional<z.ZodString>;
1312
+ ec_description: z.ZodOptional<z.ZodString>;
1313
+ ec_images: z.ZodOptional<z.ZodArray<z.ZodString>>;
1314
+ ec_in_stock: z.ZodOptional<z.ZodBoolean>;
1315
+ ec_item_group_id: z.ZodOptional<z.ZodString>;
1316
+ ec_item_group_name: z.ZodOptional<z.ZodString>;
1317
+ ec_name: z.ZodString;
1318
+ ec_price: z.ZodOptional<z.ZodNumber>;
1319
+ ec_promo_price: z.ZodOptional<z.ZodNumber>;
1320
+ ec_rating: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodNull]>>;
1321
+ ec_shortdesc: z.ZodOptional<z.ZodString>;
1322
+ ec_thumbnails: z.ZodOptional<z.ZodArray<z.ZodString>>;
1323
+ permanentid: z.ZodString;
1324
+ }, z.core.$strict>;
1325
+ relatedDocuments: z.ZodOptional<z.ZodArray<z.ZodObject<{
1326
+ clickUri: z.ZodOptional<z.ZodString>;
1327
+ filetype: z.ZodOptional<z.ZodString>;
1328
+ size: z.ZodOptional<z.ZodNumber>;
1329
+ title: z.ZodString;
1330
+ }, z.core.$strict>>>;
1331
+ summary: z.ZodString;
1332
+ }, z.core.$strict>>;
1333
+ }, z.core.$loose>;
1334
+ export type ProductResearchCard = z.infer<typeof ProductResearchCardSchema>;
1316
1335
  export declare const PaginationActionsSchema: z.ZodObject<{
1317
1336
  selectPage: z.ZodObject<{
1318
1337
  payload: z.ZodObject<{
@@ -2607,6 +2626,12 @@ export declare const ComponentContractsSchema: z.ZodDiscriminatedUnion<[z.ZodObj
2607
2626
  ec_thumbnails: z.ZodOptional<z.ZodArray<z.ZodString>>;
2608
2627
  permanentid: z.ZodString;
2609
2628
  }, z.core.$strict>;
2629
+ relatedDocuments: z.ZodOptional<z.ZodArray<z.ZodObject<{
2630
+ clickUri: z.ZodOptional<z.ZodString>;
2631
+ filetype: z.ZodOptional<z.ZodString>;
2632
+ size: z.ZodOptional<z.ZodNumber>;
2633
+ title: z.ZodString;
2634
+ }, z.core.$strict>>>;
2610
2635
  summary: z.ZodString;
2611
2636
  }, z.core.$strict>>;
2612
2637
  }, z.core.$loose>, z.ZodObject<{
@@ -3989,6 +4014,26 @@ export declare const ProductResearchCardPropsSchema: z.ZodObject<{
3989
4014
  void: "void";
3990
4015
  }>>;
3991
4016
  }, z.core.$strip>]>;
4017
+ relatedDocuments: z.ZodOptional<z.ZodUnion<readonly [z.ZodOptional<z.ZodArray<z.ZodObject<{
4018
+ clickUri: z.ZodOptional<z.ZodString>;
4019
+ filetype: z.ZodOptional<z.ZodString>;
4020
+ size: z.ZodOptional<z.ZodNumber>;
4021
+ title: z.ZodString;
4022
+ }, z.core.$strict>>>, z.ZodObject<{
4023
+ path: z.ZodString;
4024
+ }, z.core.$strict>, z.ZodObject<{
4025
+ call: z.ZodString;
4026
+ args: z.ZodRecord<z.ZodString, z.ZodAny>;
4027
+ returnType: z.ZodDefault<z.ZodEnum<{
4028
+ any: "any";
4029
+ array: "array";
4030
+ boolean: "boolean";
4031
+ number: "number";
4032
+ object: "object";
4033
+ string: "string";
4034
+ void: "void";
4035
+ }>>;
4036
+ }, z.core.$strip>]>>;
3992
4037
  }, z.core.$strip>;
3993
4038
  export declare const ProductSummaryPropsSchema: z.ZodObject<{
3994
4039
  categoryLabel: z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
@@ -192,10 +192,11 @@ export const ProductSummaryStateSchema = z.strictObject({
192
192
  product: z.union([ProductSchema, z.null()]),
193
193
  });
194
194
  export const ProductResearchCardActionsSchema = z.strictObject({});
195
- export const ProductResearchCardStateSchema = z.strictObject({
196
- bullets: z.array(z.string().min(1)).min(1),
197
- product: ProductSchema,
198
- summary: z.string().min(1),
195
+ export const ProductResearchRelatedDocumentSchema = z.strictObject({
196
+ clickUri: z.string().optional(),
197
+ filetype: z.string().optional(),
198
+ size: z.number().int().min(0).optional(),
199
+ title: z.string(),
199
200
  });
200
201
  export const SelectPagePayloadSchema = z.strictObject({
201
202
  page: z.number().int().min(0),
@@ -431,11 +432,11 @@ export const ProductSummarySchema = z.looseObject({
431
432
  id: z.string().min(1).regex(new RegExp('^[a-z][a-z0-9-]*$')),
432
433
  state: ProductSummaryStateSchema.optional(),
433
434
  });
434
- export const ProductResearchCardSchema = z.looseObject({
435
- actions: ProductResearchCardActionsSchema.optional(),
436
- component: z.literal('ProductResearchCard'),
437
- id: z.string().min(1).regex(new RegExp('^[a-z][a-z0-9-]*$')),
438
- state: ProductResearchCardStateSchema.optional(),
435
+ export const ProductResearchCardStateSchema = z.strictObject({
436
+ bullets: z.array(z.string().min(1)).min(1),
437
+ product: ProductSchema,
438
+ relatedDocuments: z.array(ProductResearchRelatedDocumentSchema).optional(),
439
+ summary: z.string().min(1),
439
440
  });
440
441
  export const SelectPageSchema = z.strictObject({
441
442
  payload: SelectPagePayloadSchema,
@@ -586,6 +587,12 @@ export const ProductListActionsSchema = z.strictObject({
586
587
  productClick: ProductClickSchema,
587
588
  selectProducts: SelectProductsSchema,
588
589
  });
590
+ export const ProductResearchCardSchema = z.looseObject({
591
+ actions: ProductResearchCardActionsSchema.optional(),
592
+ component: z.literal('ProductResearchCard'),
593
+ id: z.string().min(1).regex(new RegExp('^[a-z][a-z0-9-]*$')),
594
+ state: ProductResearchCardStateSchema.optional(),
595
+ });
589
596
  export const PaginationActionsSchema = z.strictObject({
590
597
  selectPage: SelectPageSchema,
591
598
  setPageSize: PurpleSetPageSizeSchema,
@@ -946,6 +953,13 @@ export const ProductResearchCardPropsSchema = z.object({
946
953
  ]),
947
954
  summary: DynamicStringSchema,
948
955
  bullets: DynamicStringListSchema,
956
+ relatedDocuments: z
957
+ .union([
958
+ ProductResearchCardStateSchema.shape['relatedDocuments'],
959
+ DataBindingSchema,
960
+ FunctionCallSchema,
961
+ ])
962
+ .optional(),
949
963
  });
950
964
  export const ProductSummaryPropsSchema = z.object({
951
965
  categoryLabel: DynamicStringSchema,