@wise/dynamic-flow-types 2.17.0 → 2.18.1

package/build/main.mjs

@@ -3936,13 +3936,6 @@ var loadingIndicatorLayoutSchema = z.object({
   control: z.string().optional(),
   margin: sizeSchema.optional()
 });
-var alertLayoutSchema = z.object({
-  type: z.literal("alert"),
-  markdown: z.string(),
-  context: contextSchema.optional(),
-  control: z.string().optional(),
-  margin: sizeSchema.optional()
-});
 var paragraphLayoutSchema = z.object({
   type: z.literal("paragraph"),
   text: z.string(),
@@ -4097,6 +4090,9 @@ var actionTypeSchema = z.union([
   z.literal("negative")
 ]);
 var summarySchema = z.union([summaryProviderSchema, summarySummariserSchema]);
+var linkSchema = z.object({
+  url: z.string()
+});
 var actionSchema = z.object({
   title: z.string().optional(),
   type: actionTypeSchema.optional(),
@@ -4155,6 +4151,10 @@ var reviewLayoutFieldSchema = z.object({
   value: z.string(),
   help: helpSchema.optional()
 });
+var behaviorSchema = z.object({
+  action: actionSchema.optional(),
+  link: linkSchema.optional()
+});
 var searchResultSearchSchema = z.object({
   type: z.literal("search"),
   title: z.string(),
@@ -4185,44 +4185,6 @@ var linkHandlerSchema = z.object({
   regexPattern: z.string(),
   action: actionSchema
 });
-var blobSchemaSchema = z.object({
-  type: z.literal("blob"),
-  promoted: z.boolean().optional(),
-  $id: 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: 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()
-});
-var constSchemaSchema = z.object({
-  hidden: z.boolean().optional(),
-  alert: alertLayoutSchema.optional(),
-  control: z.string().optional(),
-  promoted: z.boolean().optional(),
-  $id: z.string().optional(),
-  const: jsonElementSchema,
-  title: z.string().optional(),
-  description: z.string().optional(),
-  icon: iconSchema.optional(),
-  image: imageSchema.optional(),
-  keywords: z.array(z.string()).optional(),
-  summary: summaryProviderSchema.optional(),
-  analyticsId: z.string().optional(),
-  disabled: z.boolean().optional()
-});
 var pollingOnErrorSchema = z.object({
   action: actionSchema
 });
@@ -4234,6 +4196,11 @@ var reviewLayoutCallToActionSchema = z.object({
   title: z.string(),
   action: actionSchema
 });
+var alertLayoutCallToActionSchema = z.object({
+  title: z.string(),
+  accessibilityDescription: z.string().optional(),
+  behavior: behaviorSchema
+});
 var listLayoutSchema = z.object({
   type: z.literal("list"),
   items: z.array(listLayoutItemSchema),
@@ -4277,9 +4244,55 @@ var navigationSchema = z.object({
   back: navigationBackBehaviourSchema.optional(),
   stackBehavior: navigationStackBehaviorSchema.optional()
 });
+var alertLayoutSchema = z.object({
+  type: z.literal("alert"),
+  markdown: z.string(),
+  context: contextSchema.optional(),
+  control: z.string().optional(),
+  margin: sizeSchema.optional(),
+  callToAction: alertLayoutCallToActionSchema.optional()
+});
 var searchResponseBodySchema = z.object({
   results: z.array(searchResultSchema)
 });
+var blobSchemaSchema = z.object({
+  type: z.literal("blob"),
+  promoted: z.boolean().optional(),
+  $id: 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: 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()
+});
+var constSchemaSchema = z.object({
+  hidden: z.boolean().optional(),
+  alert: alertLayoutSchema.optional(),
+  control: z.string().optional(),
+  promoted: z.boolean().optional(),
+  $id: z.string().optional(),
+  const: jsonElementSchema,
+  title: z.string().optional(),
+  description: z.string().optional(),
+  icon: iconSchema.optional(),
+  image: imageSchema.optional(),
+  keywords: z.array(z.string()).optional(),
+  summary: summaryProviderSchema.optional(),
+  analyticsId: z.string().optional(),
+  disabled: z.boolean().optional()
+});
 var layoutSchema = z.lazy(
   () => z.union([
     alertLayoutSchema,

package/build/next/feature/Action.d.ts

@@ -6,7 +6,7 @@ import type { JsonElement } from '../JsonElement';
 * An action typically defines its URL and HTTP method to submit step data, and can optionally indicate that on success
 * this action will end the flow.
 * An endpoint can respond to a submitting action with an error status code and the standard error response format in order to display errors to the user.
-* ### Behaviour
+* ### Behavior
 * #### Non-Exiting Actions
 * If an action does not specify the `exit` property as true, it is expected that the action will submit the step payload.
 * For example, the following action is a non-exiting action.

package/build/next/feature/Behavior.d.ts

@@ -0,0 +1,17 @@
+import type { Action } from './Action';
+import type { Link } from './Link';
+/**
+* Describes the result of performing some interaction. Can be used to execute an [com.wise.dynamicflow.feature.Action]
+* or open a [com.wise.dynamicflow.feature.Link].
+* If both `action` and `link` are provided, `action` will take precedence.
+*/
+export type Behavior = {
+    /**
+    * An [com.wise.dynamicflow.feature.Action] to perform.
+    */
+    action?: Action;
+    /**
+    * A [com.wise.dynamicflow.feature.Link] to open.
+    */
+    link?: Link;
+};

package/build/next/feature/External.d.ts

@@ -1,5 +1,5 @@
 /**
-* External specifies a URL to be opened automatically when a step loads. Url-opening behaviour depends on the platform.
+* External specifies a URL to be opened automatically when a step loads. Url-opening behavior depends on the platform.
 * General guidance is as follows:
 * Web:
 * - Open a URL in a new browser tab.

package/build/next/feature/Link.d.ts

@@ -0,0 +1,9 @@
+/**
+* A link configuration used to connect with an external application or page.
+*/
+export type Link = {
+    /**
+    * An url to be used when opening the link.
+    */
+    url: string;
+};

package/build/next/feature/NavigationStackBehavior.d.ts

@@ -1,5 +1,5 @@
 /**
-* Describes the behaviour of the navigation stack when the step is presented.
+* Describes the behavior of the navigation stack when the step is presented.
 * @experimental This feature may be changed in the future without notice.
 */
 export type NavigationStackBehavior = 'default' | 'remove-previous' | 'remove-all' | 'replace-current';

package/build/next/index.d.ts

@@ -14,6 +14,7 @@ export type { Icon } from './misc/Icon';
 export type { Image } from './misc/Image';
 export type { Layout } from './layout/Layout';
 export type { AlertLayout } from './layout/AlertLayout';
+export type { AlertLayoutCallToAction } from './layout/AlertLayoutCallToAction';
 export type { BoxLayout } from './layout/BoxLayout';
 export type { ButtonLayout } from './layout/ButtonLayout';
 export type { ColumnsLayout } from './layout/ColumnsLayout';

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

@@ -1,5 +1,6 @@
 import type { Context } from '../misc/Context';
 import type { Size } from '../misc/Size';
+import type { AlertLayoutCallToAction } from './AlertLayoutCallToAction';
 /**
 * Show an attention-grabbing message.
 * Alerts can be used to communicate important messages to the user, drawing more attention than a standard paragraph or info layout.
@@ -26,4 +27,9 @@ export type AlertLayout = {
     * The vertical margin to apply above this component. Defaults to `md`.
     */
     margin?: Size;
+    /**
+    * A titled call to action which can be performed by the user.
+    * @experimental This feature may be changed in the future without notice.
+    */
+    callToAction?: AlertLayoutCallToAction;
 };

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

@@ -0,0 +1,18 @@
+import type { Behavior } from '../feature/Behavior';
+/**
+* The call to action configuration to be used by the Alert.
+*/
+export type AlertLayoutCallToAction = {
+    /**
+    * A user-facing title.
+    */
+    title: string;
+    /**
+    * A description of the call to action to be used by screen readers.
+    */
+    accessibilityDescription?: string;
+    /**
+    * Behavior that should be performed when user interacts with call to action.
+    */
+    behavior: Behavior;
+};

package/build/next/step/Step.d.ts

@@ -10,7 +10,7 @@ import type { Navigation } from '../feature/Navigation';
 /**
 * A step represents a single screen in a flow. It is made up of schemas, which represent data to be collected from the
 * user, layouts which describe how the screen looks, and a number of advanced features to provide more complex
-* behaviours.
+* behaviors.
 * ### Step Response
 * A response is determined to be a Step when the status code is in the 200-299 range, the `exit` property in the triggering action was not set to `true`, and the `X-DF-Response-Type: step` header is provided.
 */
@@ -40,10 +40,6 @@ export type Step = {
     */
     title: string;
     /**
-    * A user-facing subtitle.
-    */
-    description?: string;
-    /**
     * An array of schemas describing the data for the user to input. Each root schemas which should be displayed to the
     * user must be referenced by a [com.wise.dynamicflow.layout.FormLayout] in the `layout` property. If a schema is
     * not referenced by a [com.wise.dynamicflow.layout.FormLayout], it won't be displayed, but it will still be submitted.
@@ -56,6 +52,10 @@ export type Step = {
     */
     layout: Layout[];
     /**
+    * A user-facing subtitle.
+    */
+    description?: string;
+    /**
     * The data to use when initialising the step. It must follow the structure the schemas array describes, and any
     * data which doesn't correspond to the schema is ignored.
     */
@@ -65,7 +65,7 @@ export type Step = {
     */
     external?: External;
     /**
-    * Used to configure a polling behaviour, allowing the flow to progress automatically.
+    * Used to configure a polling behavior, allowing the flow to progress automatically.
     */
     polling?: Polling;
     /**
@@ -82,7 +82,7 @@ export type Step = {
     */
     errors?: StepError;
     /**
-    * Used to configure navigational behaviour of the step, for example to provide an
+    * Used to configure navigational behavior of the step, for example to provide an
     * [com.wise.dynamicflow.feature.Action] to perform when navigating back.
     */
     navigation?: Navigation;

package/build/renderers/index.d.ts

@@ -28,6 +28,18 @@ export type ReviewCallToAction = {
     title: string;
     onClick: () => void;
 };
+export type AlertCallToActionLink = {
+    type: 'link';
+    accessibilityDescription?: string;
+    href: string;
+    title: string;
+};
+export type AlertCallToAction = {
+    type: 'action';
+    accessibilityDescription?: string;
+    title: string;
+    onClick: () => void;
+};
 export type ReviewField = {
     help?: string;
     label: string;
@@ -71,6 +83,7 @@ export type AlertRendererProps = {
     context: Context;
     margin: Margin;
     markdown: string;
+    callToAction?: AlertCallToAction | AlertCallToActionLink;
 };
 export type BoxRendererProps = {
     type: 'box';

package/build/spec/LayoutComponent.d.ts

@@ -2,11 +2,17 @@ import type { Action } from './Action';
 import type { ExternalStepPollingConfiguration, ExternalStepPollingResponseHandler } from './Polling';
 import type { Schema } from './Schema';
 import type { SearchConfig } from './Search';
-import type { Margin, Size, Icon, Image, Align, Orientation, Reference, Alert, Help } from './core';
+import type { Margin, Size, Icon, Image, Align, Orientation, Reference, Alert, Help, Behavior } from './core';
 export type LayoutComponent = AlertLayout | BoxLayout | ButtonLayout | ColumnsLayout | DecisionLayout | DividerLayout | ExternalLayout | FormLayout | HeadingLayout | ImageLayout | InfoLayout | InstructionsLayout | ListLayout | LoadingIndicatorLayout | MarkdownLayout | ModalLayout | ParagraphLayout | ReviewLayout | StatusListLayout | SearchLayout;
-export type AlertLayout = {
+export type AlertLayoutCallToAction = {
+    title: string;
+    accessibilityDescription?: string;
+    behavior: Behavior;
+};
+export type AlertLayout = Alert & {
     type: 'alert';
-} & Alert;
+    callToAction?: AlertLayoutCallToAction;
+};
 export type BoxLayout = {
     type: 'box';
     components: LayoutComponent[];

package/build/spec/core.d.ts

@@ -1,3 +1,4 @@
+import { Action } from './Action';
 export type Image = {
     type?: 'image';
     url: string;
@@ -31,3 +32,10 @@ export type Alert = {
 export type Help = {
     markdown: string;
 };
+export type Behavior = {
+    action?: Action;
+    link?: Link;
+};
+export type Link = {
+    url: string;
+};