@wise/dynamic-flow-types 4.17.2 → 4.18.0-experimental-2dcb025

package/build/zod/schemas.ts

@@ -19,7 +19,11 @@ import {
   type ListLayout,
   type ListLayoutCallToAction,
   type ListLayoutItem,
+  type CollectionLayoutCallToAction,
+  type CollectionLayout,
+  type CollectionLayoutState,
   type DecisionLayoutOption,
+  type CollectionLayoutSection,
   type ModalLayout,
   type ModalLayoutContent,
   type SectionLayout,
@@ -41,6 +45,7 @@ import {
   type AdditionalInfo,
   type TabsLayoutTab,
   type SearchInitialState,
+  type CollectionLayoutItem,
   type AlertLayoutCallToAction,
   type ModalResponseBody,
   type SearchInitialLayoutConfig,
@@ -267,6 +272,12 @@ export const instructionsLayoutItemSchema = z.object({
   tags: z.array(z.string()).optional(),
 });
 
+export const collectionLayoutSearchSchema = z.object({
+  param: z.string(),
+  title: z.string().optional(),
+  hint: z.string().optional(),
+});
+
 export const supportingValuesSchema = z.object({
   value: z.string().optional(),
   subvalue: z.string().optional(),
@@ -381,6 +392,13 @@ export const progressLayoutSchema = z.object({
   tags: z.array(z.string()).optional(),
 });
 
+export const selectFilterOptionSchema = z.object({
+  value: z.string(),
+  title: z.string(),
+  accessibilityDescription: z.string().optional(),
+  selected: z.boolean().optional(),
+});
+
 export const formLayoutSchemaReferenceSchema = z.object({
   $ref: z.string(),
 });
@@ -574,6 +592,13 @@ export const suggestionsValueSchema = z.object({
   tags: z.array(z.string()).optional(),
 });
 
+export const collectionLayoutSelectFilterSchema = z.object({
+  type: z.literal('select'),
+  param: z.string(),
+  options: z.array(selectFilterOptionSchema),
+  multiSelect: z.boolean().optional(),
+});
+
 export const mediaLayoutSchema = z.object({
   type: z.literal('media'),
   media: mediaSchema,
@@ -618,6 +643,8 @@ export const suggestionsSchema = z.object({
   values: z.array(suggestionsValueSchema),
 });
 
+export const collectionLayoutFilterSchema = collectionLayoutSelectFilterSchema;
+
 export const searchResultsResponseBodySchema = z.object({
   type: z.literal('results'),
   results: z.array(searchResultSchema),
@@ -743,6 +770,7 @@ export const layoutSchema: z.ZodSchema<Layout> = z.lazy(() =>
     alertLayoutSchema,
     boxLayoutSchema,
     buttonLayoutSchema,
+    collectionLayoutSchema,
     columnsLayoutSchema,
     decisionLayoutSchema,
     dividerLayoutSchema,
@@ -856,6 +884,39 @@ export const listLayoutItemSchema: z.ZodSchema<ListLayoutItem> = z.lazy(() =>
   }),
 );
 
+export const collectionLayoutCallToActionSchema: z.ZodSchema<CollectionLayoutCallToAction> = z.lazy(
+  () =>
+    z.object({
+      title: z.string(),
+      accessibilityDescription: z.string().optional(),
+      behavior: behaviorSchema,
+    }),
+);
+
+export const collectionLayoutSchema: z.ZodSchema<CollectionLayout> = z.lazy(() =>
+  z.object({
+    type: z.literal('collection'),
+    url: z.string(),
+    method: httpMethodSchema,
+    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(),
+  }),
+);
+
 export const decisionLayoutOptionSchema: z.ZodSchema<DecisionLayoutOption> = z.lazy(() =>
   z.object({
     action: actionSchema.optional(),
@@ -876,6 +937,15 @@ export const decisionLayoutOptionSchema: z.ZodSchema<DecisionLayoutOption> = z.l
   }),
 );
 
+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 modalLayoutSchema: z.ZodSchema<ModalLayout> = z.lazy(() =>
   z.object({
     type: z.literal('modal'),
@@ -1118,6 +1188,22 @@ export const searchInitialStateSchema: z.ZodSchema<SearchInitialState> = z.lazy(
   z.union([searchInitialLayoutConfigSchema, searchInitialResultsConfigSchema]),
 );
 
+export const collectionLayoutItemSchema: z.ZodSchema<CollectionLayoutItem> = z.lazy(() =>
+  z.object({
+    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 alertLayoutCallToActionSchema: z.ZodSchema<AlertLayoutCallToAction> = z.lazy(() =>
   z.object({
     title: z.string(),

package/package.json

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