@wise/dynamic-flow-types 3.13.0 → 3.14.1

package/build/main.js

@@ -95,6 +95,12 @@ var avatarTextContentSchema = import_zod.z.object({
   text: import_zod.z.string(),
   badgeUri: import_zod.z.string().optional()
 });
+var avatarContentSchema = import_zod.z.union([avatarTextContentSchema, avatarUriContentSchema]);
+var mediaAvatarSchema = import_zod.z.object({
+  type: import_zod.z.literal("avatar"),
+  content: import_zod.z.array(avatarContentSchema),
+  accessibilityDescription: import_zod.z.string().optional()
+});
 var autocompleteTokenSchema = import_zod.z.union([
   import_zod.z.literal("on"),
   import_zod.z.literal("name"),
@@ -254,6 +260,14 @@ var headingLayoutSchema = import_zod.z.object({
   margin: sizeSchema.optional(),
   analyticsId: import_zod.z.string().optional()
 });
+var instructionsLayoutSchema = import_zod.z.object({
+  type: import_zod.z.literal("instructions"),
+  title: import_zod.z.string().optional(),
+  items: import_zod.z.array(instructionsLayoutItemSchema),
+  control: import_zod.z.string().optional(),
+  margin: sizeSchema.optional(),
+  analyticsId: import_zod.z.string().optional()
+});
 var markdownLayoutSchema = import_zod.z.object({
   type: import_zod.z.literal("markdown"),
   content: import_zod.z.string(),
@@ -262,17 +276,39 @@ var markdownLayoutSchema = import_zod.z.object({
   margin: sizeSchema.optional(),
   analyticsId: import_zod.z.string().optional()
 });
+var progressLayoutSchema = import_zod.z.object({
+  type: import_zod.z.literal("progress"),
+  title: import_zod.z.string().optional(),
+  description: import_zod.z.string().optional(),
+  progress: import_zod.z.number(),
+  progressText: import_zod.z.string(),
+  context: contextSchema.optional(),
+  help: helpSchema.optional(),
+  control: import_zod.z.string().optional(),
+  margin: sizeSchema.optional(),
+  analyticsId: import_zod.z.string().optional()
+});
 var columnsLayoutBiasSchema = import_zod.z.union([
   import_zod.z.literal("none"),
   import_zod.z.literal("left"),
   import_zod.z.literal("right")
 ]);
+var mediaSchema = import_zod.z.union([mediaAvatarSchema, mediaImageSchema]);
 var searchSearchRequestSchema = import_zod.z.object({
   url: import_zod.z.string(),
   method: httpMethodSchema,
   param: import_zod.z.string(),
   query: import_zod.z.string()
 });
+var searchResultSearchSchema = import_zod.z.object({
+  type: import_zod.z.literal("search"),
+  title: import_zod.z.string(),
+  description: import_zod.z.string().optional(),
+  icon: iconSchema.optional(),
+  image: imageSchema.optional(),
+  value: searchSearchRequestSchema,
+  media: mediaSchema.optional()
+});
 var jsonElementSchema = import_zod.z.lazy(
   () => import_zod.z.union([
     import_zod.z.string(),
@@ -297,6 +333,18 @@ var stringSchemaFormatSchema = import_zod.z.union([
   import_zod.z.literal("phone-number"),
   import_zod.z.literal("base64url")
 ]);
+var summarySummariserSchema = import_zod.z.object({
+  defaultTitle: import_zod.z.string().optional(),
+  defaultDescription: import_zod.z.string().optional(),
+  defaultIcon: iconSchema.optional(),
+  defaultImage: imageSchema.optional(),
+  providesTitle: import_zod.z.boolean().optional(),
+  providesDescription: import_zod.z.boolean().optional(),
+  providesIcon: import_zod.z.boolean().optional(),
+  providesImage: import_zod.z.boolean().optional(),
+  defaultMedia: mediaSchema.optional(),
+  providesMedia: import_zod.z.boolean().optional()
+});
 var validateAsyncSchema = import_zod.z.object({
   param: import_zod.z.string(),
   method: httpMethodSchema,
@@ -310,6 +358,15 @@ var summaryProviderSchema = import_zod.z.object({
   providesMedia: import_zod.z.boolean().optional()
 });
 var uploadSourceSchema = import_zod.z.union([import_zod.z.literal("camera"), import_zod.z.literal("file")]);
+var suggestionsValueSchema = import_zod.z.object({
+  label: import_zod.z.string(),
+  value: jsonElementSchema,
+  icon: iconSchema.optional(),
+  image: imageSchema.optional(),
+  tag: import_zod.z.string().optional(),
+  media: mediaSchema.optional(),
+  analyticsId: import_zod.z.string().optional()
+});
 var dismissBehaviorSchema = import_zod.z.object({
   type: import_zod.z.literal("dismiss")
 });
@@ -330,17 +387,6 @@ var actionTypeSchema = import_zod.z.union([
   import_zod.z.literal("positive"),
   import_zod.z.literal("negative")
 ]);
-var linkBehaviorSchema = import_zod.z.object({
-  type: import_zod.z.literal("link"),
-  url: import_zod.z.string()
-});
-var refreshBehaviorSchema = import_zod.z.object({
-  type: import_zod.z.literal("refresh")
-});
-var linkSchema = import_zod.z.object({
-  url: import_zod.z.string()
-});
-var avatarContentSchema = import_zod.z.union([avatarTextContentSchema, avatarUriContentSchema]);
 var actionSchema = import_zod.z.object({
   title: import_zod.z.string().optional(),
   type: actionTypeSchema.optional(),
@@ -356,40 +402,21 @@ var actionSchema = import_zod.z.object({
   timeout: import_zod.z.number().optional(),
   skipValidation: import_zod.z.boolean().optional()
 });
-var instructionsLayoutSchema = import_zod.z.object({
-  type: import_zod.z.literal("instructions"),
-  title: import_zod.z.string().optional(),
-  items: import_zod.z.array(instructionsLayoutItemSchema),
-  control: import_zod.z.string().optional(),
-  margin: sizeSchema.optional(),
-  analyticsId: import_zod.z.string().optional()
-});
-var progressLayoutSchema = import_zod.z.object({
-  type: import_zod.z.literal("progress"),
-  title: import_zod.z.string().optional(),
-  description: import_zod.z.string().optional(),
-  progress: import_zod.z.number(),
-  progressText: import_zod.z.string(),
-  context: contextSchema.optional(),
-  help: helpSchema.optional(),
-  control: import_zod.z.string().optional(),
-  margin: sizeSchema.optional(),
-  analyticsId: import_zod.z.string().optional()
-});
-var actionResponseBodySchema = import_zod.z.object({
-  action: actionSchema
+var summarySchema = import_zod.z.union([summaryProviderSchema, summarySummariserSchema]);
+var linkBehaviorSchema = import_zod.z.object({
+  type: import_zod.z.literal("link"),
+  url: import_zod.z.string()
 });
-var errorResponseBodySchema = import_zod.z.object({
-  refreshFormUrl: import_zod.z.string().optional(),
-  analytics: import_zod.z.record(import_zod.z.string()).optional(),
-  error: import_zod.z.string().optional(),
-  validation: jsonElementSchema.optional(),
-  refreshUrl: import_zod.z.string().optional()
+var refreshBehaviorSchema = import_zod.z.object({
+  type: import_zod.z.literal("refresh")
 });
 var navigationBackBehaviorSchema = import_zod.z.object({
   title: import_zod.z.string().optional(),
   action: actionSchema
 });
+var linkSchema = import_zod.z.object({
+  url: import_zod.z.string()
+});
 var actionBehaviorSchema = import_zod.z.object({
   type: import_zod.z.literal("action"),
   action: actionSchema
@@ -398,20 +425,8 @@ var containerBehaviorSchema = import_zod.z.object({
   action: actionSchema.optional(),
   link: linkSchema.optional()
 });
-var mediaAvatarSchema = import_zod.z.object({
-  type: import_zod.z.literal("avatar"),
-  content: import_zod.z.array(avatarContentSchema),
-  accessibilityDescription: import_zod.z.string().optional()
-});
-var mediaSchema = import_zod.z.union([mediaAvatarSchema, mediaImageSchema]);
-var searchResultSearchSchema = import_zod.z.object({
-  type: import_zod.z.literal("search"),
-  title: import_zod.z.string(),
-  description: import_zod.z.string().optional(),
-  icon: iconSchema.optional(),
-  image: imageSchema.optional(),
-  value: searchSearchRequestSchema,
-  media: mediaSchema.optional()
+var suggestionsSchema = import_zod.z.object({
+  values: import_zod.z.array(suggestionsValueSchema)
 });
 var searchResultActionSchema = import_zod.z.object({
   type: import_zod.z.literal("action"),
@@ -422,37 +437,22 @@ var searchResultActionSchema = import_zod.z.object({
   value: actionSchema,
   media: mediaSchema.optional()
 });
+var actionResponseBodySchema = import_zod.z.object({
+  action: actionSchema
+});
+var errorResponseBodySchema = import_zod.z.object({
+  refreshFormUrl: import_zod.z.string().optional(),
+  analytics: import_zod.z.record(import_zod.z.string()).optional(),
+  error: import_zod.z.string().optional(),
+  validation: jsonElementSchema.optional(),
+  refreshUrl: import_zod.z.string().optional()
+});
 var navigationSchema = import_zod.z.object({
   backButton: navigationBackBehaviorSchema.optional(),
   back: navigationBackBehaviorSchema.optional(),
   stackBehavior: navigationStackBehaviorSchema.optional()
 });
-var summarySummariserSchema = import_zod.z.object({
-  defaultTitle: import_zod.z.string().optional(),
-  defaultDescription: import_zod.z.string().optional(),
-  defaultIcon: iconSchema.optional(),
-  defaultImage: imageSchema.optional(),
-  providesTitle: import_zod.z.boolean().optional(),
-  providesDescription: import_zod.z.boolean().optional(),
-  providesIcon: import_zod.z.boolean().optional(),
-  providesImage: import_zod.z.boolean().optional(),
-  defaultMedia: mediaSchema.optional(),
-  providesMedia: import_zod.z.boolean().optional()
-});
-var suggestionsValueSchema = import_zod.z.object({
-  label: import_zod.z.string(),
-  value: jsonElementSchema,
-  icon: iconSchema.optional(),
-  image: imageSchema.optional(),
-  tag: import_zod.z.string().optional(),
-  media: mediaSchema.optional(),
-  analyticsId: import_zod.z.string().optional()
-});
-var summarySchema = import_zod.z.union([summaryProviderSchema, summarySummariserSchema]);
 var searchResultSchema = import_zod.z.union([searchResultActionSchema, searchResultSearchSchema]);
-var suggestionsSchema = import_zod.z.object({
-  values: import_zod.z.array(suggestionsValueSchema)
-});
 var searchResponseBodySchema = import_zod.z.object({
   results: import_zod.z.array(searchResultSchema)
 });

package/build/main.mjs

@@ -67,6 +67,12 @@ var avatarTextContentSchema = z.object({
   text: z.string(),
   badgeUri: z.string().optional()
 });
+var avatarContentSchema = z.union([avatarTextContentSchema, avatarUriContentSchema]);
+var mediaAvatarSchema = z.object({
+  type: z.literal("avatar"),
+  content: z.array(avatarContentSchema),
+  accessibilityDescription: z.string().optional()
+});
 var autocompleteTokenSchema = z.union([
   z.literal("on"),
   z.literal("name"),
@@ -226,6 +232,14 @@ var headingLayoutSchema = z.object({
   margin: sizeSchema.optional(),
   analyticsId: z.string().optional()
 });
+var instructionsLayoutSchema = z.object({
+  type: z.literal("instructions"),
+  title: z.string().optional(),
+  items: z.array(instructionsLayoutItemSchema),
+  control: z.string().optional(),
+  margin: sizeSchema.optional(),
+  analyticsId: z.string().optional()
+});
 var markdownLayoutSchema = z.object({
   type: z.literal("markdown"),
   content: z.string(),
@@ -234,17 +248,39 @@ var markdownLayoutSchema = z.object({
   margin: sizeSchema.optional(),
   analyticsId: z.string().optional()
 });
+var progressLayoutSchema = z.object({
+  type: z.literal("progress"),
+  title: z.string().optional(),
+  description: z.string().optional(),
+  progress: z.number(),
+  progressText: z.string(),
+  context: contextSchema.optional(),
+  help: helpSchema.optional(),
+  control: z.string().optional(),
+  margin: sizeSchema.optional(),
+  analyticsId: z.string().optional()
+});
 var columnsLayoutBiasSchema = z.union([
   z.literal("none"),
   z.literal("left"),
   z.literal("right")
 ]);
+var mediaSchema = z.union([mediaAvatarSchema, mediaImageSchema]);
 var searchSearchRequestSchema = z.object({
   url: z.string(),
   method: httpMethodSchema,
   param: z.string(),
   query: z.string()
 });
+var searchResultSearchSchema = z.object({
+  type: z.literal("search"),
+  title: z.string(),
+  description: z.string().optional(),
+  icon: iconSchema.optional(),
+  image: imageSchema.optional(),
+  value: searchSearchRequestSchema,
+  media: mediaSchema.optional()
+});
 var jsonElementSchema = z.lazy(
   () => z.union([
     z.string(),
@@ -269,6 +305,18 @@ var stringSchemaFormatSchema = z.union([
   z.literal("phone-number"),
   z.literal("base64url")
 ]);
+var summarySummariserSchema = z.object({
+  defaultTitle: z.string().optional(),
+  defaultDescription: z.string().optional(),
+  defaultIcon: iconSchema.optional(),
+  defaultImage: imageSchema.optional(),
+  providesTitle: z.boolean().optional(),
+  providesDescription: z.boolean().optional(),
+  providesIcon: z.boolean().optional(),
+  providesImage: z.boolean().optional(),
+  defaultMedia: mediaSchema.optional(),
+  providesMedia: z.boolean().optional()
+});
 var validateAsyncSchema = z.object({
   param: z.string(),
   method: httpMethodSchema,
@@ -282,6 +330,15 @@ var summaryProviderSchema = z.object({
   providesMedia: z.boolean().optional()
 });
 var uploadSourceSchema = z.union([z.literal("camera"), z.literal("file")]);
+var suggestionsValueSchema = z.object({
+  label: z.string(),
+  value: jsonElementSchema,
+  icon: iconSchema.optional(),
+  image: imageSchema.optional(),
+  tag: z.string().optional(),
+  media: mediaSchema.optional(),
+  analyticsId: z.string().optional()
+});
 var dismissBehaviorSchema = z.object({
   type: z.literal("dismiss")
 });
@@ -302,17 +359,6 @@ var actionTypeSchema = z.union([
   z.literal("positive"),
   z.literal("negative")
 ]);
-var linkBehaviorSchema = z.object({
-  type: z.literal("link"),
-  url: z.string()
-});
-var refreshBehaviorSchema = z.object({
-  type: z.literal("refresh")
-});
-var linkSchema = z.object({
-  url: z.string()
-});
-var avatarContentSchema = z.union([avatarTextContentSchema, avatarUriContentSchema]);
 var actionSchema = z.object({
   title: z.string().optional(),
   type: actionTypeSchema.optional(),
@@ -328,40 +374,21 @@ var actionSchema = z.object({
   timeout: z.number().optional(),
   skipValidation: z.boolean().optional()
 });
-var instructionsLayoutSchema = z.object({
-  type: z.literal("instructions"),
-  title: z.string().optional(),
-  items: z.array(instructionsLayoutItemSchema),
-  control: z.string().optional(),
-  margin: sizeSchema.optional(),
-  analyticsId: z.string().optional()
-});
-var progressLayoutSchema = z.object({
-  type: z.literal("progress"),
-  title: z.string().optional(),
-  description: z.string().optional(),
-  progress: z.number(),
-  progressText: z.string(),
-  context: contextSchema.optional(),
-  help: helpSchema.optional(),
-  control: z.string().optional(),
-  margin: sizeSchema.optional(),
-  analyticsId: z.string().optional()
-});
-var actionResponseBodySchema = z.object({
-  action: actionSchema
+var summarySchema = z.union([summaryProviderSchema, summarySummariserSchema]);
+var linkBehaviorSchema = z.object({
+  type: z.literal("link"),
+  url: z.string()
 });
-var errorResponseBodySchema = z.object({
-  refreshFormUrl: z.string().optional(),
-  analytics: z.record(z.string()).optional(),
-  error: z.string().optional(),
-  validation: jsonElementSchema.optional(),
-  refreshUrl: z.string().optional()
+var refreshBehaviorSchema = z.object({
+  type: z.literal("refresh")
 });
 var navigationBackBehaviorSchema = z.object({
   title: z.string().optional(),
   action: actionSchema
 });
+var linkSchema = z.object({
+  url: z.string()
+});
 var actionBehaviorSchema = z.object({
   type: z.literal("action"),
   action: actionSchema
@@ -370,20 +397,8 @@ var containerBehaviorSchema = z.object({
   action: actionSchema.optional(),
   link: linkSchema.optional()
 });
-var mediaAvatarSchema = z.object({
-  type: z.literal("avatar"),
-  content: z.array(avatarContentSchema),
-  accessibilityDescription: z.string().optional()
-});
-var mediaSchema = z.union([mediaAvatarSchema, mediaImageSchema]);
-var searchResultSearchSchema = z.object({
-  type: z.literal("search"),
-  title: z.string(),
-  description: z.string().optional(),
-  icon: iconSchema.optional(),
-  image: imageSchema.optional(),
-  value: searchSearchRequestSchema,
-  media: mediaSchema.optional()
+var suggestionsSchema = z.object({
+  values: z.array(suggestionsValueSchema)
 });
 var searchResultActionSchema = z.object({
   type: z.literal("action"),
@@ -394,37 +409,22 @@ var searchResultActionSchema = z.object({
   value: actionSchema,
   media: mediaSchema.optional()
 });
+var actionResponseBodySchema = z.object({
+  action: actionSchema
+});
+var errorResponseBodySchema = z.object({
+  refreshFormUrl: z.string().optional(),
+  analytics: z.record(z.string()).optional(),
+  error: z.string().optional(),
+  validation: jsonElementSchema.optional(),
+  refreshUrl: z.string().optional()
+});
 var navigationSchema = z.object({
   backButton: navigationBackBehaviorSchema.optional(),
   back: navigationBackBehaviorSchema.optional(),
   stackBehavior: navigationStackBehaviorSchema.optional()
 });
-var summarySummariserSchema = z.object({
-  defaultTitle: z.string().optional(),
-  defaultDescription: z.string().optional(),
-  defaultIcon: iconSchema.optional(),
-  defaultImage: imageSchema.optional(),
-  providesTitle: z.boolean().optional(),
-  providesDescription: z.boolean().optional(),
-  providesIcon: z.boolean().optional(),
-  providesImage: z.boolean().optional(),
-  defaultMedia: mediaSchema.optional(),
-  providesMedia: z.boolean().optional()
-});
-var suggestionsValueSchema = z.object({
-  label: z.string(),
-  value: jsonElementSchema,
-  icon: iconSchema.optional(),
-  image: imageSchema.optional(),
-  tag: z.string().optional(),
-  media: mediaSchema.optional(),
-  analyticsId: z.string().optional()
-});
-var summarySchema = z.union([summaryProviderSchema, summarySummariserSchema]);
 var searchResultSchema = z.union([searchResultActionSchema, searchResultSearchSchema]);
-var suggestionsSchema = z.object({
-  values: z.array(suggestionsValueSchema)
-});
 var searchResponseBodySchema = z.object({
   results: z.array(searchResultSchema)
 });

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

@@ -1,9 +1,9 @@
-import type { AlertLayout } from '../layout/AlertLayout';
 import type { JsonElement } from '../JsonElement';
 import type { Icon } from '../misc/Icon';
 import type { Image } from '../misc/Image';
 import type { SummaryProvider } from '../feature/SummaryProvider';
 import type { Media } from '../misc/media/Media';
+import type { AlertLayout } from '../layout/AlertLayout';
 /**
 * Represents a constant value in the submission.
 */
@@ -14,13 +14,6 @@ export type ConstSchema = {
     */
     hidden?: boolean;
     /**
-    * Configure an alert which will be displayed above the UI for this schema. This can be used to provide warnings or
-    * additional information to the user, but shouldn't be used for validation. For client-side validation please see
-    * the validation available on each schema type, or see [com.wise.dynamicflow.feature.ValidateAsync] and
-    * [com.wise.dynamicflow.feature.Action] for server-side validation.
-    */
-    alert?: AlertLayout;
-    /**
     * An identifier which can be used to request the client use a particular UI control to represent this schema.
     */
     control?: string;
@@ -75,4 +68,11 @@ export type ConstSchema = {
     * A media object which the client can use to represent this entity.
     */
     media?: Media;
+    /**
+    * Configure an alert which will be displayed above the UI for this schema. This can be used to provide warnings or
+    * additional information to the user, but shouldn't be used for validation. For client-side validation please see
+    * the validation available on each schema type, or see [com.wise.dynamicflow.feature.ValidateAsync] and
+    * [com.wise.dynamicflow.feature.Action] for server-side validation.
+    */
+    alert?: AlertLayout;
 };

package/build/renderers/StepRendererProps.d.ts

@@ -25,6 +25,8 @@ export type StepRendererProps = BaseRendererProps & {
         url: string;
     };
     toolbar?: Toolbar;
+    footer: ReactNode;
+    footerProps: RendererProps[];
     /**
      * @deprecated Please use the stepLoadingState instead.
      */