@wise/dynamic-flow-types 2.30.0 → 2.31.0

package/build/main.js

@@ -35,13 +35,13 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
-var src_exports = {};
-__export(src_exports, {
+var index_exports = {};
+__export(index_exports, {
   validateActionResponse: () => validateActionResponse,
   validateErrorResponse: () => validateErrorResponse,
   validateStep: () => validateStep
 });
-module.exports = __toCommonJS(src_exports);
+module.exports = __toCommonJS(index_exports);
 
 // ../../node_modules/.pnpm/zod@3.24.1/node_modules/zod/lib/index.mjs
 var util;

package/build/next/layout/BoxLayout.d.ts

@@ -18,6 +18,7 @@ export type BoxLayout = {
     width?: Size;
     /**
     * If true, a border is displayed around the box. Defaults to false.
+    * @deprecated Please use `bordered` or 'bordered-web' in `control` instead.
     */
     border?: boolean;
     /**

package/build/next/schema/StringSchema.d.ts

@@ -114,10 +114,12 @@ export type StringSchema = {
     disabled?: boolean;
     /**
     * An icon which the client can use to represent this schema.
+    * Icons can be shown inside text input fields.
     */
     icon?: Icon;
     /**
     * An image which the client can use to represent this schema.
+    * Images can be shown inside text input fields.
     */
     image?: Image;
     /**

package/build/renderers/ImageRendererProps.d.ts

@@ -5,5 +5,9 @@ export type ImageRendererProps = {
     accessibilityDescription?: string;
     size: Size;
     margin: Margin;
+    /**
+     * The `uri` property, if present should take precedence.
+    */
     url: string;
+    uri?: string;
 };

package/build/zod/schemas.ts

@@ -5,21 +5,21 @@ import type {
   Step,
   Schema,
   Layout,
-  AllOfSchema,
+  ModalLayoutContent,
+  ModalLayout,
+  BoxLayout,
+  ColumnsLayout,
   ArraySchema,
-  BooleanSchema,
-  IntegerSchema,
-  NumberSchema,
-  ObjectSchema,
+  ArraySchemaList,
+  ArraySchemaTuple,
   OneOfSchema,
   StringSchema,
   PersistAsync,
-  ArraySchemaList,
-  ArraySchemaTuple,
-  ModalLayout,
-  ModalLayoutContent,
-  ColumnsLayout,
-  BoxLayout,
+  NumberSchema,
+  AllOfSchema,
+  ObjectSchema,
+  BooleanSchema,
+  IntegerSchema,
 } from '../next';
 
 export const jsonElementSchema: z.ZodSchema<JsonElement> = z.lazy(() =>
@@ -51,51 +51,33 @@ export const httpMethodSchema = z.union([
   z.literal('DELETE'),
 ]);
 
-export const errorResponseBodySchema = z.object({
-  refreshFormUrl: z.string().optional(),
-  analytics: z.record(z.string()).optional(),
-  error: z.string().optional(),
-  validation: jsonElementSchema.optional(),
-  refreshUrl: z.string().optional(),
+export const iconNamedSchema = z.object({
+  name: z.string(),
 });
 
-export const stringSchemaFormatSchema = z.union([
-  z.literal('date'),
-  z.literal('email'),
-  z.literal('numeric'),
-  z.literal('password'),
-  z.literal('phone-number'),
-  z.literal('base64url'),
+export const sizeSchema = z.union([
+  z.literal('xs'),
+  z.literal('sm'),
+  z.literal('md'),
+  z.literal('lg'),
+  z.literal('xl'),
 ]);
 
-export const autocapitalizationTypeSchema = z.union([
-  z.literal('none'),
-  z.literal('characters'),
-  z.literal('sentences'),
-  z.literal('words'),
+export const contextSchema = z.union([
+  z.literal('positive'),
+  z.literal('neutral'),
+  z.literal('warning'),
+  z.literal('negative'),
+  z.literal('success'),
+  z.literal('failure'),
+  z.literal('info'),
+  z.literal('primary'),
 ]);
 
-export const imageSchema = z.object({
-  text: z.string().optional(),
-  url: z.string(),
-  accessibilityDescription: z.string().optional(),
-});
-
-export const summaryProviderSchema = z.object({
-  providesTitle: z.boolean().optional(),
-  providesDescription: z.boolean().optional(),
-  providesIcon: z.boolean().optional(),
-  providesImage: z.boolean().optional(),
-});
-
-export const validateAsyncSchema = z.object({
-  param: z.string(),
-  method: httpMethodSchema,
-  url: z.string(),
+export const iconTextSchema = z.object({
+  text: z.string(),
 });
 
-export const uploadSourceSchema = z.union([z.literal('camera'), z.literal('file')]);
-
 export const autocompleteTokenSchema = z.union([
   z.literal('on'),
   z.literal('name'),
@@ -162,59 +144,29 @@ export const autocompleteTokenSchema = z.union([
   z.literal('pager'),
 ]);
 
-export const helpSchema = z.object({
-  markdown: z.string(),
-});
-
-export const iconNamedSchema = z.object({
-  name: z.string(),
-});
-
-export const iconTextSchema = z.object({
-  text: z.string(),
-});
+export const iconSchema = z.union([iconNamedSchema, iconTextSchema]);
 
-export const contextSchema = z.union([
-  z.literal('positive'),
-  z.literal('neutral'),
-  z.literal('warning'),
-  z.literal('negative'),
-  z.literal('success'),
-  z.literal('failure'),
-  z.literal('info'),
-  z.literal('primary'),
+export const autocapitalizationTypeSchema = z.union([
+  z.literal('none'),
+  z.literal('characters'),
+  z.literal('sentences'),
+  z.literal('words'),
 ]);
 
 export const alignSchema = z.union([z.literal('left'), z.literal('center'), z.literal('right')]);
 
-export const sizeSchema = z.union([
-  z.literal('xs'),
-  z.literal('sm'),
-  z.literal('md'),
-  z.literal('lg'),
-  z.literal('xl'),
-]);
-
-export const listLayoutStatusSchema = z.union([
-  z.literal('warning'),
-  z.literal('neutral'),
-  z.literal('positive'),
-]);
-
-export const modalLayoutTriggerSchema = z.object({
-  title: z.string(),
+export const imageSchema = z.object({
+  text: z.string().optional(),
+  url: z.string(),
+  accessibilityDescription: z.string().optional(),
 });
 
-export const columnsLayoutBiasSchema = z.union([
-  z.literal('none'),
-  z.literal('left'),
-  z.literal('right'),
-]);
-
-export const markdownLayoutSchema = z.object({
-  type: z.literal('markdown'),
-  content: z.string(),
-  align: alignSchema.optional(),
+export const imageLayoutSchema = z.object({
+  type: z.literal('image'),
+  text: z.string().optional(),
+  url: z.string(),
+  size: sizeSchema.optional(),
+  accessibilityDescription: z.string().optional(),
   control: z.string().optional(),
   margin: sizeSchema.optional(),
 });
@@ -225,38 +177,71 @@ export const statusListLayoutStatusSchema = z.union([
   z.literal('done'),
 ]);
 
-export const paragraphLayoutSchema = z.object({
-  type: z.literal('paragraph'),
+export const headingLayoutSchema = z.object({
+  type: z.literal('heading'),
   text: z.string(),
+  size: sizeSchema.optional(),
   align: alignSchema.optional(),
   control: z.string().optional(),
   margin: sizeSchema.optional(),
 });
 
-export const infoLayoutSchema = z.object({
-  type: z.literal('info'),
-  markdown: z.string(),
-  align: alignSchema.optional(),
+export const searchLayoutSchema = z.object({
+  type: z.literal('search'),
+  title: z.string(),
+  method: httpMethodSchema,
+  url: z.string(),
+  param: z.string(),
+  emptyMessage: z.string().optional(),
   control: z.string().optional(),
   margin: sizeSchema.optional(),
 });
 
-export const formLayoutSchemaReferenceSchema = z.object({
-  $ref: z.string(),
+export const modalLayoutTriggerSchema = z.object({
+  title: z.string(),
 });
 
-export const reviewLayoutFieldSchema = z.object({
-  label: z.string(),
-  value: z.string(),
-  rawValue: z.string().optional(),
-  help: helpSchema.optional(),
+export const helpSchema = z.object({
+  markdown: z.string(),
 });
 
+export const columnsLayoutBiasSchema = z.union([
+  z.literal('none'),
+  z.literal('left'),
+  z.literal('right'),
+]);
+
 export const instructionsLayoutItemSchema = z.object({
   text: z.string(),
   context: contextSchema,
 });
 
+export const formLayoutSchemaReferenceSchema = z.object({
+  $ref: z.string(),
+});
+
+export const listLayoutStatusSchema = z.union([
+  z.literal('warning'),
+  z.literal('neutral'),
+  z.literal('positive'),
+]);
+
+export const instructionsLayoutSchema = z.object({
+  type: z.literal('instructions'),
+  title: z.string().optional(),
+  items: z.array(instructionsLayoutItemSchema),
+  control: z.string().optional(),
+  margin: sizeSchema.optional(),
+});
+
+export const paragraphLayoutSchema = z.object({
+  type: z.literal('paragraph'),
+  text: z.string(),
+  align: alignSchema.optional(),
+  control: z.string().optional(),
+  margin: sizeSchema.optional(),
+});
+
 export const dividerLayoutSchema = z.object({
   type: z.literal('divider'),
   control: z.string().optional(),
@@ -271,23 +256,14 @@ export const formLayoutSchema = z.object({
   margin: sizeSchema.optional(),
 });
 
-export const headingLayoutSchema = z.object({
-  type: z.literal('heading'),
-  text: z.string(),
-  size: sizeSchema.optional(),
+export const infoLayoutSchema = z.object({
+  type: z.literal('info'),
+  markdown: z.string(),
   align: alignSchema.optional(),
   control: z.string().optional(),
   margin: sizeSchema.optional(),
 });
 
-export const instructionsLayoutSchema = z.object({
-  type: z.literal('instructions'),
-  title: z.string().optional(),
-  items: z.array(instructionsLayoutItemSchema),
-  control: z.string().optional(),
-  margin: sizeSchema.optional(),
-});
-
 export const loadingIndicatorLayoutSchema = z.object({
   type: z.literal('loading-indicator'),
   size: sizeSchema.optional(),
@@ -295,35 +271,93 @@ export const loadingIndicatorLayoutSchema = z.object({
   margin: sizeSchema.optional(),
 });
 
-export const searchLayoutSchema = z.object({
-  type: z.literal('search'),
-  title: z.string(),
-  method: httpMethodSchema,
-  url: z.string(),
-  param: z.string(),
-  emptyMessage: z.string().optional(),
+export const markdownLayoutSchema = z.object({
+  type: z.literal('markdown'),
+  content: z.string(),
+  align: alignSchema.optional(),
   control: z.string().optional(),
   margin: sizeSchema.optional(),
 });
 
-export const linkSchema = z.object({
-  url: z.string(),
+export const summaryProviderSchema = z.object({
+  providesTitle: z.boolean().optional(),
+  providesDescription: z.boolean().optional(),
+  providesIcon: z.boolean().optional(),
+  providesImage: z.boolean().optional(),
 });
 
-export const navigationStackBehaviorSchema = z.union([
-  z.literal('default'),
-  z.literal('remove-previous'),
-  z.literal('remove-all'),
-  z.literal('replace-current'),
+export const stringSchemaFormatSchema = z.union([
+  z.literal('date'),
+  z.literal('email'),
+  z.literal('numeric'),
+  z.literal('password'),
+  z.literal('phone-number'),
+  z.literal('base64url'),
 ]);
 
-export const actionTypeSchema = z.union([
-  z.literal('primary'),
-  z.literal('secondary'),
-  z.literal('link'),
-  z.literal('positive'),
-  z.literal('negative'),
-]);
+export const validateAsyncSchema = z.object({
+  param: z.string(),
+  method: httpMethodSchema,
+  url: z.string(),
+});
+
+export const uploadSourceSchema = z.union([z.literal('camera'), z.literal('file')]);
+
+export const summarySummariserSchema = z.object({
+  defaultTitle: z.string().optional(),
+  defaultDescription: z.string().optional(),
+  defaultIcon: iconSchema.optional(),
+  defaultImage: imageLayoutSchema.optional(),
+  providesTitle: z.boolean().optional(),
+  providesDescription: z.boolean().optional(),
+  providesIcon: z.boolean().optional(),
+  providesImage: z.boolean().optional(),
+});
+
+export const searchSearchRequestSchema = z.object({
+  url: z.string(),
+  method: httpMethodSchema,
+  param: z.string(),
+  query: z.string(),
+});
+
+export const searchResultSearchSchema = z.object({
+  type: z.literal('search'),
+  title: z.string(),
+  description: z.string().optional(),
+  icon: iconSchema.optional(),
+  image: imageLayoutSchema.optional(),
+  value: searchSearchRequestSchema,
+});
+
+export const errorResponseBodySchema = z.object({
+  refreshFormUrl: z.string().optional(),
+  analytics: z.record(z.string()).optional(),
+  error: z.string().optional(),
+  validation: jsonElementSchema.optional(),
+  refreshUrl: z.string().optional(),
+});
+
+export const actionTypeSchema = z.union([
+  z.literal('primary'),
+  z.literal('secondary'),
+  z.literal('link'),
+  z.literal('positive'),
+  z.literal('negative'),
+]);
+
+export const navigationStackBehaviorSchema = z.union([
+  z.literal('default'),
+  z.literal('remove-previous'),
+  z.literal('remove-all'),
+  z.literal('replace-current'),
+]);
+
+export const summarySchema = z.union([summaryProviderSchema, summarySummariserSchema]);
+
+export const linkSchema = z.object({
+  url: z.string(),
+});
 
 export const actionSchema = z.object({
   title: z.string().optional(),
@@ -346,49 +380,6 @@ export const linkHandlerSchema = z.object({
   action: actionSchema,
 });
 
-export const actionResponseBodySchema = z.object({
-  action: actionSchema,
-});
-
-export const searchSearchRequestSchema = z.object({
-  url: z.string(),
-  method: httpMethodSchema,
-  param: z.string(),
-  query: z.string(),
-});
-
-export const iconSchema = z.union([iconNamedSchema, iconTextSchema]);
-
-export const imageLayoutSchema = z.object({
-  type: z.literal('image'),
-  text: z.string().optional(),
-  url: z.string(),
-  size: sizeSchema.optional(),
-  accessibilityDescription: z.string().optional(),
-  control: z.string().optional(),
-  margin: sizeSchema.optional(),
-});
-
-export const searchResultActionSchema = z.object({
-  type: z.literal('action'),
-  title: z.string(),
-  description: z.string().optional(),
-  icon: iconSchema.optional(),
-  image: imageLayoutSchema.optional(),
-  value: actionSchema,
-});
-
-export const summarySummariserSchema = z.object({
-  defaultTitle: z.string().optional(),
-  defaultDescription: z.string().optional(),
-  defaultIcon: iconSchema.optional(),
-  defaultImage: imageLayoutSchema.optional(),
-  providesTitle: z.boolean().optional(),
-  providesDescription: z.boolean().optional(),
-  providesIcon: z.boolean().optional(),
-  providesImage: z.boolean().optional(),
-});
-
 export const listLayoutItemSchema = z.object({
   title: z.string(),
   description: z.string().optional(),
@@ -396,14 +387,6 @@ export const listLayoutItemSchema = z.object({
   status: listLayoutStatusSchema.optional(),
 });
 
-export const listLayoutSchema = z.object({
-  type: z.literal('list'),
-  items: z.array(listLayoutItemSchema),
-  title: z.string().optional(),
-  control: z.string().optional(),
-  margin: sizeSchema.optional(),
-});
-
 export const decisionLayoutOptionSchema = z.object({
   action: actionSchema,
   title: z.string(),
@@ -413,11 +396,31 @@ export const decisionLayoutOptionSchema = z.object({
   image: imageLayoutSchema.optional(),
 });
 
+export const behaviorSchema = z.object({
+  action: actionSchema.optional(),
+  link: linkSchema.optional(),
+});
+
+export const reviewLayoutFieldSchema = z.object({
+  label: z.string(),
+  value: z.string(),
+  rawValue: z.string().optional(),
+  help: helpSchema.optional(),
+});
+
 export const reviewLayoutCallToActionSchema = z.object({
   title: z.string(),
   action: actionSchema,
 });
 
+export const decisionLayoutSchema = z.object({
+  type: z.literal('decision'),
+  title: z.string().optional(),
+  options: z.array(decisionLayoutOptionSchema),
+  control: z.string().optional(),
+  margin: sizeSchema.optional(),
+});
+
 export const buttonLayoutSchema = z.object({
   type: z.literal('button'),
   size: sizeSchema.optional(),
@@ -430,15 +433,19 @@ export const buttonLayoutSchema = z.object({
   margin: sizeSchema.optional(),
 });
 
-export const behaviorSchema = z.object({
-  action: actionSchema.optional(),
-  link: linkSchema.optional(),
+export const searchResultActionSchema = z.object({
+  type: z.literal('action'),
+  title: z.string(),
+  description: z.string().optional(),
+  icon: iconSchema.optional(),
+  image: imageLayoutSchema.optional(),
+  value: actionSchema,
 });
 
-export const alertLayoutCallToActionSchema = z.object({
-  title: z.string(),
-  accessibilityDescription: z.string().optional(),
-  behavior: behaviorSchema,
+export const searchResultSchema = z.union([searchResultActionSchema, searchResultSearchSchema]);
+
+export const actionResponseBodySchema = z.object({
+  action: actionSchema,
 });
 
 export const pollingOnErrorSchema = z.object({
@@ -450,8 +457,6 @@ export const navigationBackBehaviorSchema = z.object({
   action: actionSchema,
 });
 
-export const summarySchema = z.union([summaryProviderSchema, summarySummariserSchema]);
-
 export const pollingSchema = z.object({
   url: z.string(),
   interval: z.number().optional(),
@@ -467,36 +472,24 @@ export const navigationSchema = z.object({
   stackBehavior: navigationStackBehaviorSchema.optional(),
 });
 
-export const searchResultSearchSchema = z.object({
-  type: z.literal('search'),
-  title: z.string(),
-  description: z.string().optional(),
-  icon: iconSchema.optional(),
-  image: imageLayoutSchema.optional(),
-  value: searchSearchRequestSchema,
-});
-
-export const alertLayoutSchema = z.object({
-  type: z.literal('alert'),
-  markdown: z.string(),
-  context: contextSchema.optional(),
+export const listLayoutSchema = z.object({
+  type: z.literal('list'),
+  items: z.array(listLayoutItemSchema),
+  title: z.string().optional(),
   control: z.string().optional(),
   margin: sizeSchema.optional(),
-  callToAction: alertLayoutCallToActionSchema.optional(),
 });
 
-export const itemCallToActionSchema = z.object({
+export const alertLayoutCallToActionSchema = z.object({
   title: z.string(),
   accessibilityDescription: z.string().optional(),
   behavior: behaviorSchema,
 });
 
-export const decisionLayoutSchema = z.object({
-  type: z.literal('decision'),
-  title: z.string().optional(),
-  options: z.array(decisionLayoutOptionSchema),
-  control: z.string().optional(),
-  margin: sizeSchema.optional(),
+export const itemCallToActionSchema = z.object({
+  title: z.string(),
+  accessibilityDescription: z.string().optional(),
+  behavior: behaviorSchema,
 });
 
 export const reviewLayoutSchema = z.object({
@@ -510,29 +503,25 @@ export const reviewLayoutSchema = z.object({
   margin: sizeSchema.optional(),
 });
 
-export const searchResultSchema = z.union([searchResultActionSchema, searchResultSearchSchema]);
+export const searchResponseBodySchema = z.object({
+  results: z.array(searchResultSchema),
+});
 
-export const blobSchemaSchema = z.object({
-  type: z.literal('blob'),
-  promoted: z.boolean().optional(),
-  $id: z.string().optional(),
-  title: z.string().optional(),
+export const statusListLayoutItemSchema = z.object({
+  title: z.string(),
   description: z.string().optional(),
+  icon: iconSchema,
+  status: statusListLayoutStatusSchema.optional(),
+  callToAction: itemCallToActionSchema.optional(),
+});
+
+export const alertLayoutSchema = z.object({
+  type: z.literal('alert'),
+  markdown: z.string(),
+  context: contextSchema.optional(),
   control: z.string().optional(),
-  hidden: z.boolean().optional(),
-  icon: iconSchema.optional(),
-  image: imageSchema.optional(),
-  keywords: z.array(z.string()).optional(),
-  summary: summaryProviderSchema.optional(),
-  analyticsId: z.string().optional(),
-  validationAsync: validateAsyncSchema.optional(),
-  validationMessages: z.record(z.string()).optional(),
-  alert: alertLayoutSchema.optional(),
-  cameraConfig: jsonElementSchema.optional(),
-  accepts: z.array(z.string()).optional(),
-  maxSize: z.number().optional(),
-  source: uploadSourceSchema.optional(),
-  disabled: z.boolean().optional(),
+  margin: sizeSchema.optional(),
+  callToAction: alertLayoutCallToActionSchema.optional(),
 });
 
 export const constSchemaSchema = z.object({
@@ -552,12 +541,27 @@ export const constSchemaSchema = z.object({
   disabled: z.boolean().optional(),
 });
 
-export const statusListLayoutItemSchema = z.object({
-  title: z.string(),
+export const blobSchemaSchema = z.object({
+  type: z.literal('blob'),
+  promoted: z.boolean().optional(),
+  $id: z.string().optional(),
+  title: z.string().optional(),
   description: z.string().optional(),
-  icon: iconSchema,
-  status: statusListLayoutStatusSchema.optional(),
-  callToAction: itemCallToActionSchema.optional(),
+  control: z.string().optional(),
+  hidden: z.boolean().optional(),
+  icon: iconSchema.optional(),
+  image: imageSchema.optional(),
+  keywords: z.array(z.string()).optional(),
+  summary: summaryProviderSchema.optional(),
+  analyticsId: z.string().optional(),
+  validationAsync: validateAsyncSchema.optional(),
+  validationMessages: z.record(z.string()).optional(),
+  alert: alertLayoutSchema.optional(),
+  cameraConfig: jsonElementSchema.optional(),
+  accepts: z.array(z.string()).optional(),
+  maxSize: z.number().optional(),
+  source: uploadSourceSchema.optional(),
+  disabled: z.boolean().optional(),
 });
 
 export const statusListLayoutSchema = z.object({
@@ -568,10 +572,6 @@ export const statusListLayoutSchema = z.object({
   margin: sizeSchema.optional(),
 });
 
-export const searchResponseBodySchema = z.object({
-  results: z.array(searchResultSchema),
-});
-
 export const stepSchema: z.ZodSchema<Step> = z.lazy(() =>
   z.object({
     key: z.string().optional(),
@@ -609,36 +609,84 @@ export const schemaSchema: z.ZodSchema<Schema> = z.lazy(() =>
   ]),
 );
 
-export const layoutSchema: z.ZodSchema<Layout> = z.lazy(() =>
-  z.union([
-    alertLayoutSchema,
-    boxLayoutSchema,
-    buttonLayoutSchema,
-    columnsLayoutSchema,
-    decisionLayoutSchema,
-    dividerLayoutSchema,
-    formLayoutSchema,
-    headingLayoutSchema,
-    imageLayoutSchema,
-    infoLayoutSchema,
-    instructionsLayoutSchema,
-    listLayoutSchema,
-    loadingIndicatorLayoutSchema,
-    markdownLayoutSchema,
-    modalLayoutSchema,
-    paragraphLayoutSchema,
-    reviewLayoutSchema,
-    searchLayoutSchema,
-    statusListLayoutSchema,
-  ]),
+export const layoutSchema: z.ZodSchema<Layout> = z.lazy(() =>
+  z.union([
+    alertLayoutSchema,
+    boxLayoutSchema,
+    buttonLayoutSchema,
+    columnsLayoutSchema,
+    decisionLayoutSchema,
+    dividerLayoutSchema,
+    formLayoutSchema,
+    headingLayoutSchema,
+    imageLayoutSchema,
+    infoLayoutSchema,
+    instructionsLayoutSchema,
+    listLayoutSchema,
+    loadingIndicatorLayoutSchema,
+    markdownLayoutSchema,
+    modalLayoutSchema,
+    paragraphLayoutSchema,
+    reviewLayoutSchema,
+    searchLayoutSchema,
+    statusListLayoutSchema,
+  ]),
+);
+
+export const modalLayoutContentSchema: z.ZodSchema<ModalLayoutContent> = z.lazy(() =>
+  z.object({
+    title: z.string().optional(),
+    components: z.array(layoutSchema),
+  }),
+);
+
+export const modalLayoutSchema: z.ZodSchema<ModalLayout> = z.lazy(() =>
+  z.object({
+    type: z.literal('modal'),
+    control: z.string().optional(),
+    margin: sizeSchema.optional(),
+    trigger: modalLayoutTriggerSchema,
+    content: modalLayoutContentSchema,
+  }),
+);
+
+export const boxLayoutSchema: z.ZodSchema<BoxLayout> = z.lazy(() =>
+  z.object({
+    type: z.literal('box'),
+    components: z.array(layoutSchema),
+    width: sizeSchema.optional(),
+    border: z.boolean().optional(),
+    control: z.string().optional(),
+    margin: sizeSchema.optional(),
+  }),
+);
+
+export const columnsLayoutSchema: z.ZodSchema<ColumnsLayout> = z.lazy(() =>
+  z.object({
+    type: z.literal('columns'),
+    left: z.array(layoutSchema),
+    right: z.array(layoutSchema),
+    bias: columnsLayoutBiasSchema.optional(),
+    control: z.string().optional(),
+    margin: sizeSchema.optional(),
+  }),
+);
+
+export const arraySchemaSchema: z.ZodSchema<ArraySchema> = z.lazy(() =>
+  z.union([arraySchemaListSchema, arraySchemaTupleSchema]),
 );
 
-export const allOfSchemaSchema: z.ZodSchema<AllOfSchema> = z.lazy(() =>
+export const arraySchemaListSchema: z.ZodSchema<ArraySchemaList> = z.lazy(() =>
   z.object({
-    disabled: z.boolean().optional(),
+    type: z.literal('array'),
     promoted: z.boolean().optional(),
-    allOf: z.array(schemaSchema),
     $id: z.string().optional(),
+    items: schemaSchema,
+    addItemTitle: z.string(),
+    editItemTitle: z.string(),
+    minItems: z.number().optional(),
+    maxItems: z.number().optional(),
+    placeholder: z.string().optional(),
     title: z.string().optional(),
     description: z.string().optional(),
     control: z.string().optional(),
@@ -646,61 +694,90 @@ export const allOfSchemaSchema: z.ZodSchema<AllOfSchema> = z.lazy(() =>
     icon: iconSchema.optional(),
     image: imageSchema.optional(),
     keywords: z.array(z.string()).optional(),
-    summary: summaryProviderSchema.optional(),
+    summary: summarySummariserSchema.optional(),
     analyticsId: z.string().optional(),
+    persistAsync: persistAsyncSchema.optional(),
+    validationAsync: validateAsyncSchema.optional(),
     alert: alertLayoutSchema.optional(),
+    validationMessages: z.record(z.string()).optional(),
+    disabled: z.boolean().optional(),
   }),
 );
 
-export const arraySchemaSchema: z.ZodSchema<ArraySchema> = z.lazy(() =>
-  z.union([arraySchemaListSchema, arraySchemaTupleSchema]),
+export const arraySchemaTupleSchema: z.ZodSchema<ArraySchemaTuple> = z.lazy(() =>
+  z.object({
+    type: z.literal('array'),
+    promoted: z.boolean().optional(),
+    $id: z.string().optional(),
+    items: z.array(schemaSchema),
+    title: z.string().optional(),
+    description: z.string().optional(),
+    control: z.string().optional(),
+    hidden: z.boolean().optional(),
+    icon: iconSchema.optional(),
+    image: imageSchema.optional(),
+    keywords: z.array(z.string()).optional(),
+    summary: summaryProviderSchema.optional(),
+    analyticsId: z.string().optional(),
+    persistAsync: persistAsyncSchema.optional(),
+    validationAsync: validateAsyncSchema.optional(),
+    alert: alertLayoutSchema.optional(),
+  }),
 );
 
-export const booleanSchemaSchema: z.ZodSchema<BooleanSchema> = z.lazy(() =>
+export const oneOfSchemaSchema: z.ZodSchema<OneOfSchema> = z.lazy(() =>
   z.object({
-    type: z.literal('boolean'),
     autofillProvider: z.string().optional(),
     promoted: z.boolean().optional(),
     refreshFormOnChange: z.boolean().optional(),
     refreshUrl: z.string().optional(),
     refreshFormUrl: z.string().optional(),
+    promotion: jsonElementSchema.optional(),
+    oneOf: z.array(schemaSchema),
+    placeholder: z.string().optional(),
     $id: z.string().optional(),
     title: z.string().optional(),
     description: z.string().optional(),
     control: z.string().optional(),
-    default: z.boolean().optional(),
+    default: jsonElementSchema.optional(),
     hidden: z.boolean().optional(),
-    disabled: z.boolean().optional(),
     icon: iconSchema.optional(),
     image: imageSchema.optional(),
     keywords: z.array(z.string()).optional(),
     summary: summaryProviderSchema.optional(),
     analyticsId: z.string().optional(),
-    persistAsync: persistAsyncSchema.optional(),
     refreshStepOnChange: z.boolean().optional(),
-    validationAsync: validateAsyncSchema.optional(),
     alert: alertLayoutSchema.optional(),
-    autofillKey: z.string().optional(),
     help: helpSchema.optional(),
+    autocompleteHint: z.array(autocompleteTokenSchema).optional(),
+    autofillKey: z.string().optional(),
+    validationMessages: z.record(z.string()).optional(),
+    disabled: z.boolean().optional(),
   }),
 );
 
-export const integerSchemaSchema: z.ZodSchema<IntegerSchema> = z.lazy(() =>
+export const stringSchemaSchema: z.ZodSchema<StringSchema> = z.lazy(() =>
   z.object({
-    type: z.literal('integer'),
+    type: z.literal('string'),
     autofillProvider: z.string().optional(),
     promoted: z.boolean().optional(),
     refreshFormOnChange: z.boolean().optional(),
     refreshUrl: z.string().optional(),
     refreshFormUrl: z.string().optional(),
+    format: stringSchemaFormatSchema.optional(),
+    displayFormat: z.string().optional(),
     placeholder: z.string().optional(),
-    minimum: z.number().optional(),
-    maximum: z.number().optional(),
+    minLength: z.number().optional(),
+    maxLength: z.number().optional(),
+    minimum: z.string().optional(),
+    maximum: z.string().optional(),
+    pattern: z.string().optional(),
+    autocapitalization: autocapitalizationTypeSchema.optional(),
     $id: z.string().optional(),
     title: z.string().optional(),
     description: z.string().optional(),
     control: z.string().optional(),
-    default: z.number().optional(),
+    default: z.string().optional(),
     hidden: z.boolean().optional(),
     disabled: z.boolean().optional(),
     icon: iconSchema.optional(),
@@ -713,12 +790,26 @@ export const integerSchemaSchema: z.ZodSchema<IntegerSchema> = z.lazy(() =>
     validationAsync: validateAsyncSchema.optional(),
     validationMessages: z.record(z.string()).optional(),
     alert: alertLayoutSchema.optional(),
+    cameraConfig: jsonElementSchema.optional(),
+    accepts: z.array(z.string()).optional(),
+    maxSize: z.number().optional(),
+    source: uploadSourceSchema.optional(),
     autocompleteHint: z.array(autocompleteTokenSchema).optional(),
     autofillKey: z.string().optional(),
     help: helpSchema.optional(),
   }),
 );
 
+export const persistAsyncSchema: z.ZodSchema<PersistAsync> = z.lazy(() =>
+  z.object({
+    param: z.string(),
+    idProperty: z.string(),
+    schema: schemaSchema,
+    url: z.string(),
+    method: httpMethodSchema,
+  }),
+);
+
 export const numberSchemaSchema: z.ZodSchema<NumberSchema> = z.lazy(() =>
   z.object({
     type: z.literal('number'),
@@ -753,15 +844,11 @@ export const numberSchemaSchema: z.ZodSchema<NumberSchema> = z.lazy(() =>
   }),
 );
 
-export const objectSchemaSchema: z.ZodSchema<ObjectSchema> = z.lazy(() =>
+export const allOfSchemaSchema: z.ZodSchema<AllOfSchema> = z.lazy(() =>
   z.object({
-    type: z.literal('object'),
     disabled: z.boolean().optional(),
     promoted: z.boolean().optional(),
-    help: helpSchema.optional(),
-    properties: z.record(schemaSchema),
-    displayOrder: z.array(z.string()),
-    required: z.array(z.string()).optional(),
+    allOf: z.array(schemaSchema),
     $id: z.string().optional(),
     title: z.string().optional(),
     description: z.string().optional(),
@@ -776,59 +863,42 @@ export const objectSchemaSchema: z.ZodSchema<ObjectSchema> = z.lazy(() =>
   }),
 );
 
-export const oneOfSchemaSchema: z.ZodSchema<OneOfSchema> = z.lazy(() =>
+export const objectSchemaSchema: z.ZodSchema<ObjectSchema> = z.lazy(() =>
   z.object({
-    autofillProvider: z.string().optional(),
+    type: z.literal('object'),
+    disabled: z.boolean().optional(),
     promoted: z.boolean().optional(),
-    refreshFormOnChange: z.boolean().optional(),
-    refreshUrl: z.string().optional(),
-    refreshFormUrl: z.string().optional(),
-    promotion: jsonElementSchema.optional(),
-    oneOf: z.array(schemaSchema),
-    placeholder: z.string().optional(),
+    help: helpSchema.optional(),
+    properties: z.record(schemaSchema),
+    displayOrder: z.array(z.string()),
+    required: z.array(z.string()).optional(),
     $id: z.string().optional(),
     title: z.string().optional(),
     description: z.string().optional(),
     control: z.string().optional(),
-    default: jsonElementSchema.optional(),
     hidden: z.boolean().optional(),
     icon: iconSchema.optional(),
     image: imageSchema.optional(),
     keywords: z.array(z.string()).optional(),
     summary: summaryProviderSchema.optional(),
     analyticsId: z.string().optional(),
-    refreshStepOnChange: z.boolean().optional(),
     alert: alertLayoutSchema.optional(),
-    help: helpSchema.optional(),
-    autocompleteHint: z.array(autocompleteTokenSchema).optional(),
-    autofillKey: z.string().optional(),
-    validationMessages: z.record(z.string()).optional(),
-    disabled: z.boolean().optional(),
   }),
 );
 
-export const stringSchemaSchema: z.ZodSchema<StringSchema> = z.lazy(() =>
+export const booleanSchemaSchema: z.ZodSchema<BooleanSchema> = z.lazy(() =>
   z.object({
-    type: z.literal('string'),
+    type: z.literal('boolean'),
     autofillProvider: z.string().optional(),
     promoted: z.boolean().optional(),
     refreshFormOnChange: z.boolean().optional(),
     refreshUrl: z.string().optional(),
     refreshFormUrl: z.string().optional(),
-    format: stringSchemaFormatSchema.optional(),
-    displayFormat: z.string().optional(),
-    placeholder: z.string().optional(),
-    minLength: z.number().optional(),
-    maxLength: z.number().optional(),
-    minimum: z.string().optional(),
-    maximum: z.string().optional(),
-    pattern: z.string().optional(),
-    autocapitalization: autocapitalizationTypeSchema.optional(),
     $id: z.string().optional(),
     title: z.string().optional(),
     description: z.string().optional(),
     control: z.string().optional(),
-    default: z.string().optional(),
+    default: z.boolean().optional(),
     hidden: z.boolean().optional(),
     disabled: z.boolean().optional(),
     icon: iconSchema.optional(),
@@ -839,112 +909,42 @@ export const stringSchemaSchema: z.ZodSchema<StringSchema> = z.lazy(() =>
     persistAsync: persistAsyncSchema.optional(),
     refreshStepOnChange: z.boolean().optional(),
     validationAsync: validateAsyncSchema.optional(),
-    validationMessages: z.record(z.string()).optional(),
     alert: alertLayoutSchema.optional(),
-    cameraConfig: jsonElementSchema.optional(),
-    accepts: z.array(z.string()).optional(),
-    maxSize: z.number().optional(),
-    source: uploadSourceSchema.optional(),
-    autocompleteHint: z.array(autocompleteTokenSchema).optional(),
     autofillKey: z.string().optional(),
     help: helpSchema.optional(),
   }),
 );
 
-export const persistAsyncSchema: z.ZodSchema<PersistAsync> = z.lazy(() =>
-  z.object({
-    param: z.string(),
-    idProperty: z.string(),
-    schema: schemaSchema,
-    url: z.string(),
-    method: httpMethodSchema,
-  }),
-);
-
-export const arraySchemaListSchema: z.ZodSchema<ArraySchemaList> = z.lazy(() =>
+export const integerSchemaSchema: z.ZodSchema<IntegerSchema> = z.lazy(() =>
   z.object({
-    type: z.literal('array'),
+    type: z.literal('integer'),
+    autofillProvider: z.string().optional(),
     promoted: z.boolean().optional(),
-    $id: z.string().optional(),
-    items: schemaSchema,
-    addItemTitle: z.string(),
-    editItemTitle: z.string(),
-    minItems: z.number().optional(),
-    maxItems: z.number().optional(),
+    refreshFormOnChange: z.boolean().optional(),
+    refreshUrl: z.string().optional(),
+    refreshFormUrl: z.string().optional(),
     placeholder: z.string().optional(),
-    title: z.string().optional(),
-    description: z.string().optional(),
-    control: z.string().optional(),
-    hidden: z.boolean().optional(),
-    icon: iconSchema.optional(),
-    image: imageSchema.optional(),
-    keywords: z.array(z.string()).optional(),
-    summary: summarySummariserSchema.optional(),
-    analyticsId: z.string().optional(),
-    persistAsync: persistAsyncSchema.optional(),
-    validationAsync: validateAsyncSchema.optional(),
-    alert: alertLayoutSchema.optional(),
-    validationMessages: z.record(z.string()).optional(),
-    disabled: z.boolean().optional(),
-  }),
-);
-
-export const arraySchemaTupleSchema: z.ZodSchema<ArraySchemaTuple> = z.lazy(() =>
-  z.object({
-    type: z.literal('array'),
-    promoted: z.boolean().optional(),
+    minimum: z.number().optional(),
+    maximum: z.number().optional(),
     $id: z.string().optional(),
-    items: z.array(schemaSchema),
     title: z.string().optional(),
     description: z.string().optional(),
     control: z.string().optional(),
+    default: z.number().optional(),
     hidden: z.boolean().optional(),
+    disabled: z.boolean().optional(),
     icon: iconSchema.optional(),
     image: imageSchema.optional(),
     keywords: z.array(z.string()).optional(),
     summary: summaryProviderSchema.optional(),
     analyticsId: z.string().optional(),
     persistAsync: persistAsyncSchema.optional(),
+    refreshStepOnChange: z.boolean().optional(),
     validationAsync: validateAsyncSchema.optional(),
+    validationMessages: z.record(z.string()).optional(),
     alert: alertLayoutSchema.optional(),
-  }),
-);
-
-export const modalLayoutSchema: z.ZodSchema<ModalLayout> = z.lazy(() =>
-  z.object({
-    type: z.literal('modal'),
-    control: z.string().optional(),
-    margin: sizeSchema.optional(),
-    trigger: modalLayoutTriggerSchema,
-    content: modalLayoutContentSchema,
-  }),
-);
-
-export const modalLayoutContentSchema: z.ZodSchema<ModalLayoutContent> = z.lazy(() =>
-  z.object({
-    title: z.string().optional(),
-    components: z.array(layoutSchema),
-  }),
-);
-
-export const columnsLayoutSchema: z.ZodSchema<ColumnsLayout> = z.lazy(() =>
-  z.object({
-    type: z.literal('columns'),
-    left: z.array(layoutSchema),
-    right: z.array(layoutSchema),
-    bias: columnsLayoutBiasSchema.optional(),
-    control: z.string().optional(),
-    margin: sizeSchema.optional(),
-  }),
-);
-
-export const boxLayoutSchema: z.ZodSchema<BoxLayout> = z.lazy(() =>
-  z.object({
-    type: z.literal('box'),
-    components: z.array(layoutSchema),
-    width: sizeSchema.optional(),
-    border: z.boolean().optional(),
-    control: z.string().optional(),
-    margin: sizeSchema.optional(),
+    autocompleteHint: z.array(autocompleteTokenSchema).optional(),
+    autofillKey: z.string().optional(),
+    help: helpSchema.optional(),
   }),
 );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wise/dynamic-flow-types",
-  "version": "2.30.0",
+  "version": "2.31.0",
   "description": "Dynamic Flow TypeScript Types",
   "license": "Apache-2.0",
   "repository": {
@@ -30,9 +30,9 @@
     "build"
   ],
   "devDependencies": {
-    "@formatjs/cli": "^6.3.15",
+    "@formatjs/cli": "^6.5.1",
     "@types/react": "18.3.18",
-    "esbuild": "0.24.0",
+    "esbuild": "0.24.2",
     "npm-run-all2": "7.0.2",
     "ts-to-zod": "3.6.1",
     "typescript": "5.7.3"