@wise/dynamic-flow-types 4.19.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,
@@ -63,6 +66,7 @@ import {
   type SubflowBehavior,
   type ToolbarItem,
   type ToolbarButton,
+  type DelayBehavior,
   type ModalBehavior,
 } from '../spec';
 
@@ -144,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'),
@@ -237,6 +238,14 @@ 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(),
 });
@@ -247,7 +256,16 @@ export const collectionLayoutSearchSchema = z.object({
   hint: z.string().optional(),
 });
 
-export const mediaSchema = z.union([mediaAvatarSchema, mediaImageSchema]);
+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'),
@@ -281,12 +299,23 @@ export const collectionLayoutSelectFilterOptionSchema = z.object({
   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(),
@@ -299,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(),
@@ -399,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(),
@@ -546,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,
@@ -603,6 +619,8 @@ export const containerBehaviorSchema = z.object({
   analytics: z.record(z.string()).optional(),
 });
 
+export const updatableLayoutTriggerSchema = updatableLayoutOnEventTriggerSchema;
+
 export const collectionLayoutFilterSchema = collectionLayoutSelectFilterSchema;
 
 export const suggestionsSchema = z.object({
@@ -672,7 +690,9 @@ export const behaviorSchema: z.ZodSchema<Behavior> = z.lazy(() =>
     actionBehaviorSchema,
     containerBehaviorSchema,
     copyBehaviorSchema,
+    delayBehaviorSchema,
     dismissBehaviorSchema,
+    dispatchEventBehaviorSchema,
     downloadBehaviorSchema,
     linkBehaviorSchema,
     modalBehaviorSchema,
@@ -681,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(),
@@ -733,6 +780,7 @@ export const layoutSchema: z.ZodSchema<Layout> = z.lazy(() =>
     sectionLayoutSchema,
     statusListLayoutSchema,
     tabsLayoutSchema,
+    updatableLayoutSchema,
     upsellLayoutSchema,
   ]),
 );
@@ -1625,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.19.0",
+  "version": "4.20.0",
   "description": "Dynamic Flow TypeScript Types",
   "license": "Apache-2.0",
   "repository": {