@wise/dynamic-flow-types 4.18.0 → 4.20.0

package/build/zod/schemas.ts

@@ -4,6 +4,9 @@ import {
   type JsonElement,
   type AdditionalInfo,
   type Behavior,
+  type UpdatableLayout,
+  type UpdatableLayoutState,
+  type UpdatableLayoutErrorHandler,
   type ReviewLayoutCallToAction,
   type AlertLayoutCallToAction,
   type ModalLayoutContent,
@@ -17,10 +20,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,
@@ -58,6 +66,7 @@ import {
   type SubflowBehavior,
   type ToolbarItem,
   type ToolbarButton,
+  type DelayBehavior,
   type ModalBehavior,
 } from '../spec';
 
@@ -139,10 +148,7 @@ export const supportingValuesSchema = z.object({
   subvalue: z.string().optional(),
 });
 
-export const inlineAlertSchema = z.object({
-  content: z.string(),
-  context: contextSchema.optional(),
-});
+export const mediaSchema = z.union([mediaAvatarSchema, mediaImageSchema]);
 
 export const autocompleteTokenSchema = z.union([
   z.literal('on'),
@@ -232,11 +238,34 @@ export const imageSchema = z.object({
   accessibilityDescription: z.string().optional(),
 });
 
+export const requestSchema = z.object({
+  url: z.string(),
+  method: httpMethodSchema,
+  body: jsonElementSchema.optional(),
+  prefetch: z.boolean().optional(),
+  headers: z.record(z.string()).optional(),
+});
+
 export const helpSchema = z.object({
   markdown: z.string(),
 });
 
-export const mediaSchema = z.union([mediaAvatarSchema, mediaImageSchema]);
+export const collectionLayoutSearchSchema = z.object({
+  param: z.string(),
+  title: z.string().optional(),
+  hint: z.string().optional(),
+});
+
+export const mediaLayoutSchema = z.object({
+  type: z.literal('media'),
+  media: mediaSchema,
+  align: alignSchema.optional(),
+  size: sizeSchema.optional(),
+  analyticsId: z.string().optional(),
+  control: z.string().optional(),
+  margin: sizeSchema.optional(),
+  tags: z.array(z.string()).optional(),
+});
 
 export const statusListLayoutStatusSchema = z.union([
   z.literal('not-done'),
@@ -263,12 +292,30 @@ 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 updatableLayoutOnEventTriggerSchema = z.object({
+  type: z.literal('on-event'),
+  eventName: z.string(),
+});
+
 export const listLayoutStatusSchema = z.union([
   z.literal('warning'),
   z.literal('neutral'),
   z.literal('positive'),
 ]);
 
+export const inlineAlertSchema = z.object({
+  content: z.string(),
+  context: contextSchema.optional(),
+  media: mediaSchema.optional(),
+});
+
 export const dividerLayoutSchema = z.object({
   type: z.literal('divider'),
   control: z.string().optional(),
@@ -281,14 +328,6 @@ export const formLayoutSchemaReferenceSchema = z.object({
   $ref: z.string(),
 });
 
-export const requestSchema = z.object({
-  url: z.string(),
-  method: httpMethodSchema,
-  body: jsonElementSchema.optional(),
-  prefetch: z.boolean().optional(),
-  headers: z.record(z.string()).optional(),
-});
-
 export const headingLayoutSchema = z.object({
   type: z.literal('heading'),
   text: z.string(),
@@ -344,6 +383,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(),
@@ -374,17 +420,6 @@ export const infoLayoutSchema = z.object({
   analyticsId: z.string().optional(),
 });
 
-export const mediaLayoutSchema = z.object({
-  type: z.literal('media'),
-  media: mediaSchema,
-  align: alignSchema.optional(),
-  size: sizeSchema.optional(),
-  analyticsId: z.string().optional(),
-  control: z.string().optional(),
-  margin: sizeSchema.optional(),
-  tags: z.array(z.string()).optional(),
-});
-
 export const progressLayoutSchema = z.object({
   type: z.literal('progress'),
   title: z.string().optional(),
@@ -521,6 +556,12 @@ export const dismissBehaviorSchema = z.object({
   analytics: z.record(z.string()).optional(),
 });
 
+export const dispatchEventBehaviorSchema = z.object({
+  type: z.literal('dispatch-event'),
+  eventName: z.string(),
+  analytics: z.record(z.string()).optional(),
+});
+
 export const downloadBehaviorSchema = z.object({
   type: z.literal('download'),
   request: requestSchema,
@@ -578,6 +619,10 @@ export const containerBehaviorSchema = z.object({
   analytics: z.record(z.string()).optional(),
 });
 
+export const updatableLayoutTriggerSchema = updatableLayoutOnEventTriggerSchema;
+
+export const collectionLayoutFilterSchema = collectionLayoutSelectFilterSchema;
+
 export const suggestionsSchema = z.object({
   values: z.array(suggestionsValueSchema),
 });
@@ -645,7 +690,9 @@ export const behaviorSchema: z.ZodSchema<Behavior> = z.lazy(() =>
     actionBehaviorSchema,
     containerBehaviorSchema,
     copyBehaviorSchema,
+    delayBehaviorSchema,
     dismissBehaviorSchema,
+    dispatchEventBehaviorSchema,
     downloadBehaviorSchema,
     linkBehaviorSchema,
     modalBehaviorSchema,
@@ -654,6 +701,33 @@ export const behaviorSchema: z.ZodSchema<Behavior> = z.lazy(() =>
   ]),
 );
 
+export const updatableLayoutSchema: z.ZodSchema<UpdatableLayout> = z.lazy(() =>
+  z.object({
+    type: z.literal('updatable'),
+    baseRequest: requestSchema,
+    trigger: updatableLayoutTriggerSchema,
+    initialState: updatableLayoutStateSchema.optional(),
+    onError: updatableLayoutErrorHandlerSchema.optional(),
+    control: z.string().optional(),
+    margin: sizeSchema.optional(),
+    analyticsId: z.string().optional(),
+    tags: z.array(z.string()).optional(),
+  }),
+);
+
+export const updatableLayoutStateSchema: z.ZodSchema<UpdatableLayoutState> = z.lazy(() =>
+  z.object({
+    components: z.array(layoutSchema).optional(),
+  }),
+);
+
+export const updatableLayoutErrorHandlerSchema: z.ZodSchema<UpdatableLayoutErrorHandler> = z.lazy(
+  () =>
+    z.object({
+      fallbackLayout: z.array(layoutSchema).optional(),
+    }),
+);
+
 export const reviewLayoutCallToActionSchema: z.ZodSchema<ReviewLayoutCallToAction> = z.lazy(() =>
   z.object({
     action: actionSchema.optional(),
@@ -685,6 +759,7 @@ export const layoutSchema: z.ZodSchema<Layout> = z.lazy(() =>
     alertLayoutSchema,
     boxLayoutSchema,
     buttonLayoutSchema,
+    collectionLayoutSchema,
     columnsLayoutSchema,
     decisionLayoutSchema,
     dividerLayoutSchema,
@@ -705,6 +780,7 @@ export const layoutSchema: z.ZodSchema<Layout> = z.lazy(() =>
     sectionLayoutSchema,
     statusListLayoutSchema,
     tabsLayoutSchema,
+    updatableLayoutSchema,
     upsellLayoutSchema,
   ]),
 );
@@ -820,6 +896,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 +915,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 +977,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 +1013,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(),
   }),
 );
 
@@ -1534,6 +1673,15 @@ export const toolbarButtonSchema: z.ZodSchema<ToolbarButton> = z.lazy(() =>
   }),
 );
 
+export const delayBehaviorSchema: z.ZodSchema<DelayBehavior> = z.lazy(() =>
+  z.object({
+    type: z.literal('delay'),
+    duration: z.number(),
+    behavior: behaviorSchema,
+    analytics: z.record(z.string()).optional(),
+  }),
+);
+
 export const modalBehaviorSchema: z.ZodSchema<ModalBehavior> = z.lazy(() =>
   z.object({
     type: z.literal('modal'),

package/package.json

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