@wise/dynamic-flow-types 4.18.0 → 4.19.0

package/build/zod/schemas.ts

@@ -17,10 +17,15 @@ import {
   type SearchInitialState,
   type SectionLayoutCallToAction,
   type UpsellLayout,
+  type CollectionLayoutCallToAction,
   type SectionLayout,
+  type CollectionLayout,
+  type CollectionLayoutState,
   type ModalLayout,
   type StatusListLayoutItem,
   type StatusListLayoutItemCallToAction,
+  type CollectionLayoutSection,
+  type CollectionLayoutItem,
   type AlertLayout,
   type ListLayout,
   type StatusListLayout,
@@ -236,6 +241,12 @@ export const helpSchema = z.object({
   markdown: z.string(),
 });
 
+export const collectionLayoutSearchSchema = z.object({
+  param: z.string(),
+  title: z.string().optional(),
+  hint: z.string().optional(),
+});
+
 export const mediaSchema = z.union([mediaAvatarSchema, mediaImageSchema]);
 
 export const statusListLayoutStatusSchema = z.union([
@@ -263,6 +274,13 @@ export const instructionsLayoutItemSchema = z.object({
   tags: z.array(z.string()).optional(),
 });
 
+export const collectionLayoutSelectFilterOptionSchema = z.object({
+  value: z.string(),
+  title: z.string(),
+  accessibilityDescription: z.string().optional(),
+  selected: z.boolean().optional(),
+});
+
 export const listLayoutStatusSchema = z.union([
   z.literal('warning'),
   z.literal('neutral'),
@@ -344,6 +362,13 @@ export const columnsLayoutBiasSchema = z.union([
   z.literal('right'),
 ]);
 
+export const collectionLayoutSelectFilterSchema = z.object({
+  type: z.literal('select'),
+  param: z.string(),
+  options: z.array(collectionLayoutSelectFilterOptionSchema),
+  multiSelect: z.boolean().optional(),
+});
+
 export const instructionsLayoutSchema = z.object({
   type: z.literal('instructions'),
   title: z.string().optional(),
@@ -578,6 +603,8 @@ export const containerBehaviorSchema = z.object({
   analytics: z.record(z.string()).optional(),
 });
 
+export const collectionLayoutFilterSchema = collectionLayoutSelectFilterSchema;
+
 export const suggestionsSchema = z.object({
   values: z.array(suggestionsValueSchema),
 });
@@ -685,6 +712,7 @@ export const layoutSchema: z.ZodSchema<Layout> = z.lazy(() =>
     alertLayoutSchema,
     boxLayoutSchema,
     buttonLayoutSchema,
+    collectionLayoutSchema,
     columnsLayoutSchema,
     decisionLayoutSchema,
     dividerLayoutSchema,
@@ -820,6 +848,15 @@ export const upsellLayoutSchema: z.ZodSchema<UpsellLayout> = z.lazy(() =>
   }),
 );
 
+export const collectionLayoutCallToActionSchema: z.ZodSchema<CollectionLayoutCallToAction> = z.lazy(
+  () =>
+    z.object({
+      title: z.string(),
+      accessibilityDescription: z.string().optional(),
+      behavior: behaviorSchema,
+    }),
+);
+
 export const sectionLayoutSchema: z.ZodSchema<SectionLayout> = z.lazy(() =>
   z.object({
     type: z.literal('section'),
@@ -830,6 +867,30 @@ export const sectionLayoutSchema: z.ZodSchema<SectionLayout> = z.lazy(() =>
     margin: sizeSchema.optional(),
     analyticsId: z.string().optional(),
     tags: z.array(z.string()).optional(),
+    shortTitle: z.string().optional(),
+  }),
+);
+
+export const collectionLayoutSchema: z.ZodSchema<CollectionLayout> = z.lazy(() =>
+  z.object({
+    type: z.literal('collection'),
+    baseRequest: requestSchema,
+    initialState: collectionLayoutStateSchema,
+    search: collectionLayoutSearchSchema.optional(),
+    control: z.string().optional(),
+    margin: sizeSchema.optional(),
+    analyticsId: z.string().optional(),
+    tags: z.array(z.string()).optional(),
+  }),
+);
+
+export const collectionLayoutStateSchema: z.ZodSchema<CollectionLayoutState> = z.lazy(() =>
+  z.object({
+    sections: z.array(collectionLayoutSectionSchema),
+    nextCursor: z.string().optional(),
+    filters: z.array(collectionLayoutFilterSchema).optional(),
+    beforeSections: z.array(layoutSchema).optional(),
+    afterSections: z.array(layoutSchema).optional(),
   }),
 );
 
@@ -868,6 +929,32 @@ export const statusListLayoutItemCallToActionSchema: z.ZodSchema<StatusListLayou
     }),
   );
 
+export const collectionLayoutSectionSchema: z.ZodSchema<CollectionLayoutSection> = z.lazy(() =>
+  z.object({
+    id: z.string(),
+    items: z.array(collectionLayoutItemSchema),
+    title: z.string().optional(),
+    callToAction: collectionLayoutCallToActionSchema.optional(),
+  }),
+);
+
+export const collectionLayoutItemSchema: z.ZodSchema<CollectionLayoutItem> = z.lazy(() =>
+  z.object({
+    entityId: z.string(),
+    title: z.string(),
+    description: z.string().optional(),
+    disabled: z.boolean().optional(),
+    primaryBehavior: behaviorSchema.optional(),
+    callToAction: collectionLayoutCallToActionSchema.optional(),
+    additionalInfo: additionalInfoSchema.optional(),
+    supportingValues: supportingValuesSchema.optional(),
+    inlineAlert: inlineAlertSchema.optional(),
+    media: mediaSchema.optional(),
+    analyticsId: z.string().optional(),
+    tags: z.array(z.string()).optional(),
+  }),
+);
+
 export const alertLayoutSchema: z.ZodSchema<AlertLayout> = z.lazy(() =>
   z.object({
     type: z.literal('alert'),
@@ -878,6 +965,10 @@ export const alertLayoutSchema: z.ZodSchema<AlertLayout> = z.lazy(() =>
     callToAction: alertLayoutCallToActionSchema.optional(),
     analyticsId: z.string().optional(),
     tags: z.array(z.string()).optional(),
+    title: z.string().optional(),
+    media: mediaSchema.optional(),
+    onDismiss: requestSchema.optional(),
+    secondaryCallToAction: alertLayoutCallToActionSchema.optional(),
   }),
 );
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wise/dynamic-flow-types",
-  "version": "4.18.0",
+  "version": "4.19.0",
   "description": "Dynamic Flow TypeScript Types",
   "license": "Apache-2.0",
   "repository": {