@wise/dynamic-flow-types 3.0.0-experimental-dde19b5 → 3.0.0

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

@@ -0,0 +1,14 @@
+import type { Action } from './Action';
+/**
+* Performs an [com.wise.dynamicflow.feature.Action] when the behavior is triggered.
+*/
+export type ActionBehavior = {
+    /**
+    * It must be `action`.
+    */
+    type: 'action';
+    /**
+    * The action to perform
+    */
+    action: Action;
+};

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

@@ -1,17 +1,7 @@
-import type { Action } from './Action';
-import type { Link } from './Link';
+import type { ActionBehavior } from './ActionBehavior';
+import type { ContainerBehavior } from './ContainerBehavior';
+import type { LinkBehavior } from './LinkBehavior';
 /**
-* 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.
+* Describes the result of performing some interaction.
 */
-export type Behavior = {
-    /**
-    * An [com.wise.dynamicflow.feature.Action] to perform.
-    */
-    action?: Action;
-    /**
-    * A [com.wise.dynamicflow.feature.Link] to open.
-    */
-    link?: Link;
-};
+export type Behavior = ActionBehavior | ContainerBehavior | LinkBehavior;

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

@@ -0,0 +1,9 @@
+import type { Action } from './Action';
+import type { Link } from './Link';
+/**
+* @deprecated Please use the type specific to your Behavior
+*/
+export type ContainerBehavior = {
+    action?: Action;
+    link?: Link;
+};

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

@@ -0,0 +1,13 @@
+/**
+* Opens a link when the behavior is triggered.
+*/
+export type LinkBehavior = {
+    /**
+    * It must be `link`.
+    */
+    type: 'link';
+    /**
+    * The URL of the link to open
+    */
+    url: string;
+};

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

@@ -1,4 +1,4 @@
-import type { Action } from './Action';
+import type { Behavior } from './Behavior';
 /**
 * A pattern which is matched against any incoming universal links, with an action to trigger when the pattern is matched.
 * Link handling is typically used alongside [External].
@@ -16,21 +16,25 @@ import type { Action } from './Action';
 * ```kt
 * Step.build {
 *     layout { }
-*     linkHandlers = listOf(
-*         LinkHandler(
-*             regexPattern = """https:\/\/wise.com\/success-callback.""",
-*             action = Action.build {
-*                 url = "/handle-success-callback"
-*                 data = encodeToJsonElement(mapOf("some-additional-data" to true))
+*     linkHandlers {
+*         LinkHandler {
+*             regexPattern = """https:\/\/wise.com\/success-callback."""
+*             behavior = ActionBehavior.build {
+*                 action {
+*                      url = "/handle-success-callback"
+*                      data = encodeToJsonElement(mapOf("some-additional-data" to true))
+*                 }
 *             }
-*         ),
-*         LinkHandler(
-*             regexPattern = """https:\/\/wise\.com\/failure-callback.*""",
-*             action = Action.build {
-*                 url = "/handle-failure-callback"
-*             }
-*         )
-*     )
+*         }
+*         LinkHandler {
+*             regexPattern = """https:\/\/wise\.com\/failure-callback.*"""
+*             behavior = ActionBehavior.build {
+*                  action {
+*                      url = "/handle-failure-callback"
+*                  }
+*               }
+*          }
+*     }
 * }
 * ```
 * If the user is on this step and then opens a universal or deep link, it'll be matched against the patterns
@@ -53,7 +57,7 @@ export type LinkHandler = {
     */
     regexPattern: string;
     /**
-    * An action to be triggered when the regex pattern is matched.
+    * Behavior to be triggered when the regex pattern is matched.
     */
-    action: Action;
+    behavior?: Behavior;
 };

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

@@ -33,15 +33,14 @@ import type { PollingOnError } from './PollingOnError';
 */
 export type Polling = {
     /**
-    * The URL to open.
-    */
-    url: string;
-    /**
-    * The time interval between requests, in seconds.
     * @deprecated Please use `delay` instead.
     */
     interval?: number;
     /**
+    * The URL to open.
+    */
+    url: string;
+    /**
     * The time in seconds between receiving a response and executing the next request.
     */
     delay?: number;

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

@@ -1,7 +1,13 @@
 import type { Action } from './Action';
+import type { Behavior } from './Behavior';
 export type PollingOnError = {
     /**
     * The [com.wise.dynamicflow.feature.Action] to be triggered when polling fails.
+    * @deprecated Please use `behavior` with an action instead.
     */
-    action: Action;
+    action?: Action;
+    /**
+    * The [com.wise.dynamicflow.feature.Behavior] to be triggered when polling fails.
+    */
+    behavior?: Behavior;
 };

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

@@ -1,5 +1,5 @@
 import type { Icon } from '../misc/Icon';
-import type { ImageLayout } from '../layout/ImageLayout';
+import type { Image } from '../misc/Image';
 /**
 * A schema which summarises its child schemas.
 * Default values can be specified for the summary if values are not provided by its child schemas.
@@ -20,7 +20,7 @@ export type SummarySummariser = {
     /**
     * An image to be used for the summary if an image is not provided by a child schema.
     */
-    defaultImage?: ImageLayout;
+    defaultImage?: Image;
     /**
     * If true, the value of this schema can be used as a summary title.
     */

package/build/next/index.d.ts

@@ -6,6 +6,7 @@ export type { PersistAsync } from './feature/PersistAsync';
 export type { Polling } from './feature/Polling';
 export type { PollingOnError } from './feature/PollingOnError';
 export type { ValidateAsync } from './feature/ValidateAsync';
+export type { Behavior } from './feature/Behavior';
 export type { Align } from './misc/Align';
 export type { AutocapitalizationType } from './misc/AutocapitalizationType';
 export type { Context } from './misc/Context';

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

@@ -1,8 +1,9 @@
-import type { Size } from '../misc/Size';
 import type { Action } from '../feature/Action';
+import type { Size } from '../misc/Size';
+import type { Behavior } from '../feature/Behavior';
 import type { Context } from '../misc/Context';
 /**
-* A component which performs an [com.wise.dynamicflow.feature.Action] when pressed.
+* A component which performs a [com.wise.dynamicflow.feature.Behavior] when pressed.
 * You can affect the button appearance using the "control" and "context" properties.
 */
 export type ButtonLayout = {
@@ -11,6 +12,11 @@ export type ButtonLayout = {
     */
     type: 'button';
     /**
+    * The action to perform when the button is pressed.
+    * @deprecated Please use `behavior` with an action instead.
+    */
+    action?: Action;
+    /**
     * @deprecated This is a web only feature that will be removed in a later release
     */
     size?: Size;
@@ -19,9 +25,9 @@ export type ButtonLayout = {
     */
     title?: string;
     /**
-    * The action to perform when the button is pressed.
+    * Behavior to be performed when the button is pressed.
     */
-    action: Action;
+    behavior?: Behavior;
     /**
     * The semantics of the button. Defaults to `neutral`.
     */

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

@@ -1,14 +1,16 @@
 import type { Action } from '../feature/Action';
 import type { Icon } from '../misc/Icon';
-import type { ImageLayout } from './ImageLayout';
+import type { Image } from '../misc/Image';
+import type { Behavior } from '../feature/Behavior';
 /**
 * An option is a single entry in the decision that the user can choose.
 */
 export type DecisionLayoutOption = {
     /**
     * The action to perform when selected.
+    * @deprecated Please use 'behavior' instead
     */
-    action: Action;
+    action?: Action;
     /**
     * A user-facing title.
     */
@@ -28,7 +30,11 @@ export type DecisionLayoutOption = {
     /**
     * An image to represent the option.
     */
-    image?: ImageLayout;
+    image?: Image;
+    /**
+    * Behavior to be performed when the button is pressed.
+    */
+    behavior?: Behavior;
     /**
     * An optional identifier to be used in custom renderers.
     * @experimental This feature may be changed in the future without notice.

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

@@ -1,6 +1,8 @@
+import type { Image } from '../misc/Image';
 import type { Size } from '../misc/Size';
 /**
-* Images fetched from URLs.
+* An Image, specified by URI. Accepted schemes are `http`, `https` and `urn`.
+* Relative URL or paths, are also supported.
 */
 export type ImageLayout = {
     /**
@@ -12,9 +14,17 @@ export type ImageLayout = {
     */
     text?: string;
     /**
-    * The URL to use to fetch the image.
+    * @deprecated Please use 'content' instead
     */
-    url: string;
+    url?: string;
+    /**
+    * @deprecated Please use 'content' instead
+    */
+    accessibilityDescription?: string;
+    /**
+    * The image to display.
+    */
+    content?: Image;
     /**
     * The horizontal size of the image. Defaults to `md`.
     * The image is scaled down to fit the provided size while preserving the aspect
@@ -23,10 +33,6 @@ export type ImageLayout = {
     */
     size?: Size;
     /**
-    * A description of the content of the image to be used by screen readers.
-    */
-    accessibilityDescription?: string;
-    /**
     * Specify a particular control to use to represent the layout. If the control is unknown, it will be ignored.
     */
     control?: string;

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

@@ -1,14 +1,24 @@
 import type { Action } from '../feature/Action';
+import type { Behavior } from '../feature/Behavior';
 /**
 * Adds an [com.wise.dynamicflow.feature.Action] to the review layout. For example, it could be used to provide an edit action.
 */
 export type ReviewLayoutCallToAction = {
+    /**
+    * The [com.wise.dynamicflow.feature.Action] which should be performed.
+    * @deprecated Please use `behavior` with an action instead.
+    */
+    action?: Action;
     /**
     * A user-facing title.
     */
     title: string;
     /**
-    * The [com.wise.dynamicflow.feature.Action] which should be performed.
+    * A description of the call to action to be used by screen readers.
+    */
+    accessibilityDescription?: string;
+    /**
+    * The [com.wise.dynamicflow.feature.Behavior] that should be performed when user interacts with call to action.
     */
-    action: Action;
+    behavior?: Behavior;
 };

package/build/next/misc/Image.d.ts

@@ -1,5 +1,6 @@
 /**
-* Images fetched from URLs.
+* An Image, specified by URI. Accepted schemes are `http`, `https` and `urn`.
+* Relative URL or paths, are also supported.
 */
 export type Image = {
     /**
@@ -8,11 +9,15 @@ export type Image = {
     text?: string;
     /**
     * The URL to use to fetch the image.
+    * @deprecated Please use 'uri' instead
     */
-    url: string;
+    url?: string;
+    /**
+    * The URI to use to fetch the image.
+    */
+    uri?: string;
     /**
     * A description of the content of the image to be used by screen readers.
-    * @experimental This feature may be changed in the future without notice.
     */
     accessibilityDescription?: string;
 };

package/build/next/responses/search/SearchResultAction.d.ts

@@ -1,5 +1,5 @@
 import type { Icon } from '../../misc/Icon';
-import type { ImageLayout } from '../../layout/ImageLayout';
+import type { Image } from '../../misc/Image';
 import type { Action } from '../../feature/Action';
 /**
 * A search result which contains an [com.wise.dynamicflow.feature.Action] to perform when the result is selected.
@@ -24,7 +24,7 @@ export type SearchResultAction = {
     /**
     * An image representing the result.
     */
-    image?: ImageLayout;
+    image?: Image;
     /**
     * The action to perform when the option is selected.
     */

package/build/next/responses/search/SearchResultSearch.d.ts

@@ -1,5 +1,5 @@
 import type { Icon } from '../../misc/Icon';
-import type { ImageLayout } from '../../layout/ImageLayout';
+import type { Image } from '../../misc/Image';
 import type { SearchSearchRequest } from './SearchSearchRequest';
 /**
 * A search result which contains another search to be performed when selected. Can be used to provide groups of
@@ -25,7 +25,7 @@ export type SearchResultSearch = {
     /**
     * An image representing the result.
     */
-    image?: ImageLayout;
+    image?: Image;
     /**
     * A search configuration to used when the option is selected.
     */

package/build/renderers/AlertRendererProps.d.ts

@@ -1,8 +1,5 @@
 import { Context, Margin } from './constants';
 import { BaseRendererProps } from './RendererProps';
-/**
- * @experimental Expect RendererProps to change as we align them across platform
- */
 export type AlertRendererProps = BaseRendererProps & {
     type: 'alert';
     control?: string;

package/build/renderers/BaseInputRendererProps.d.ts

@@ -1,7 +1,7 @@
 import { Icon } from './Icon';
 import { Image } from './Image';
 import { BaseRendererProps } from './RendererProps';
-export interface BaseInputRendererProps extends BaseRendererProps {
+export type BaseInputRendererProps = BaseRendererProps & {
     id: string;
     control?: string;
     description?: string;
@@ -9,14 +9,13 @@ export interface BaseInputRendererProps extends BaseRendererProps {
     help?: string;
     placeholder?: string;
     required: boolean;
-    /** @experimental */
     validationState: ValidationResult | undefined;
     icon?: Icon;
     image?: Image;
     title?: string;
     onBlur: () => void;
     onFocus: () => void;
-}
+};
 export type ValidationResult = {
     status: 'valid';
     message?: string;

package/build/renderers/BoxRendererProps.d.ts

@@ -1,9 +1,6 @@
 import { ReactNode } from 'react';
 import { Margin, Size } from './constants';
 import { BaseRendererProps, RendererProps } from './RendererProps';
-/**
- * @experimental Expect RendererProps to change as we align them across platform
- */
 export type BoxRendererProps = BaseRendererProps & {
     type: 'box';
     control?: string;

package/build/renderers/ButtonRendererProps.d.ts

@@ -1,7 +1,6 @@
 import { Context, Margin, Size } from './constants';
 import { BaseRendererProps } from './RendererProps';
 /**
- * @experimental Expect RendererProps to change as we align them across platform
  * Known values for "control" are: 'primary' | 'secondary' | 'tertiary'.
  */
 export type ButtonRendererProps = BaseRendererProps & {

package/build/renderers/CheckboxInputRendererProps.d.ts

@@ -1,9 +1,6 @@
 import { BaseInputRendererProps } from './BaseInputRendererProps';
-/**
- * @experimental Expect RendererProps to change as we align them across platform
- */
-export interface CheckboxInputRendererProps extends BaseInputRendererProps {
+export type CheckboxInputRendererProps = BaseInputRendererProps & {
     type: 'input-checkbox';
     value: boolean;
     onChange: (value: boolean) => void;
-}
+};

package/build/renderers/ColumnsRendererProps.d.ts

@@ -2,9 +2,6 @@ import { ReactNode } from 'react';
 import { Margin } from './constants';
 import { BaseRendererProps, RendererProps } from './RendererProps';
 export type Bias = 'none' | 'start' | 'end';
-/**
- * @experimental Expect RendererProps to change as we align them across platform
- */
 export type ColumnsRendererProps = BaseRendererProps & {
     type: 'columns';
     control?: string;

package/build/renderers/CoreContainerRendererProps.d.ts

@@ -1,10 +1,7 @@
 import type { ReactNode } from 'react';
 import { BaseRendererProps, RendererProps } from './RendererProps';
-/**
- * @experimental Expect RendererProps to change as we align them across platform
- */
-export interface CoreContainerRendererProps extends BaseRendererProps {
+export type CoreContainerRendererProps = BaseRendererProps & {
     type: 'container';
     children: ReactNode;
     childrenProps: RendererProps[];
-}
+};

package/build/renderers/DateInputRendererProps.d.ts

@@ -1,7 +1,4 @@
 import { BaseInputRendererProps } from './BaseInputRendererProps';
-/**
- * @experimental Expect RendererProps to change as we align them across platform
- */
 export type DateInputRendererProps = BaseInputRendererProps & {
     type: 'input-date';
     autoComplete: string;

package/build/renderers/DecisionRendererProps.d.ts

@@ -2,9 +2,6 @@ import { Icon } from './Icon';
 import { Image } from './Image';
 import { BaseRendererProps } from './RendererProps';
 import { Margin } from './constants';
-/**
- * @experimental Expect RendererProps to change as we align them across platform
- */
 export type DecisionRendererProps = BaseRendererProps & {
     type: 'decision';
     control?: string;

package/build/renderers/DividerRendererProps.d.ts

@@ -1,8 +1,5 @@
 import { Margin } from './constants';
 import { BaseRendererProps } from './RendererProps';
-/**
- * @experimental Expect RendererProps to change as we align them across platform
- */
 export type DividerRendererProps = BaseRendererProps & {
     type: 'divider';
     control?: string;

package/build/renderers/FormRendererProps.d.ts

@@ -1,9 +1,6 @@
 import { ReactNode } from 'react';
 import { Margin } from './constants';
 import { BaseRendererProps, RendererProps } from './RendererProps';
-/**
- * @experimental Expect RendererProps to change as we align them across platform
- */
 export type FormRendererProps = BaseRendererProps & {
     type: 'form';
     control?: string;

package/build/renderers/HeadingRendererProps.d.ts

@@ -1,7 +1,6 @@
 import { Align, Margin, Size } from './constants';
 import { BaseRendererProps } from './RendererProps';
 /**
- * @experimental Expect RendererProps to change as we align them across platform
  * Known values for "control" are: 'display'.
  */
 export type HeadingRendererProps = BaseRendererProps & {

package/build/renderers/HiddenRendererProps.d.ts

@@ -1,6 +1,3 @@
-/**
- * @experimental Expect RendererProps to change as we align them across platform
- */
 export type HiddenRendererProps = {
     uid: string;
     type: 'hidden';

package/build/renderers/Image.d.ts

@@ -1,23 +1,13 @@
 /**
- * @experimental Expect RendererProps to change as we align them across platform
  * Images fetched from URLs.
  */
 export type Image = {
-    /**
-    * @deprecated Please use 'accessibilityDescription' instead
-    */
-    text?: string;
-    /**
-    * The URL to use to fetch the image.
-    */
-    url: string;
     /**
      * The URI to use to fetch the image.
      */
-    uri?: string;
+    uri: string;
     /**
-    * A description of the content of the image to be used by screen readers.
-    * @experimental This feature may be changed in the future without notice.
-    */
+     * A description of the content of the image to be used by screen readers.
+     */
     accessibilityDescription?: string;
 };

package/build/renderers/ImageRendererProps.d.ts

@@ -1,17 +1,10 @@
 import { Margin, Size } from './constants';
 import { BaseRendererProps } from './RendererProps';
-/**
- * @experimental Expect RendererProps to change as we align them across platform
- */
 export type ImageRendererProps = BaseRendererProps & {
     type: 'image';
     control?: string;
     accessibilityDescription?: string;
     size: Size;
     margin: Margin;
-    /**
-     * The `uri` property, if present should take precedence.
-     */
-    url: string;
-    uri?: string;
+    uri: string;
 };

package/build/renderers/InstructionsRendererProps.d.ts

@@ -1,8 +1,5 @@
 import { Context, Margin } from './constants';
 import { BaseRendererProps } from './RendererProps';
-/**
- * @experimental Expect RendererProps to change as we align them across platform
- */
 export type InstructionsRendererProps = BaseRendererProps & {
     type: 'instructions';
     control?: string;

package/build/renderers/IntegerInputRendererProps.d.ts

@@ -1,14 +1,9 @@
 import { BaseInputRendererProps } from './BaseInputRendererProps';
-/**
- * @experimental Expect RendererProps to change as we align them across platform
- */
 export type IntegerInputRendererProps = BaseInputRendererProps & {
     type: 'input-integer';
     autoComplete: string;
     value: number | null;
-    /** @experimental */
     maximum?: number;
-    /** @experimental */
     minimum?: number;
     onChange: (value: number | null) => void;
 };

package/build/renderers/ListRendererProps.d.ts

@@ -1,10 +1,7 @@
-import { Icon } from "./Icon";
-import { Image } from "./Image";
-import { BaseRendererProps } from "./RendererProps";
-import { Margin } from "./constants";
-/**
- * @experimental Expect RendererProps to change as we align them across platform
- */
+import { Icon } from './Icon';
+import { Image } from './Image';
+import { BaseRendererProps } from './RendererProps';
+import { Margin } from './constants';
 export type ListRendererProps = BaseRendererProps & {
     type: 'list';
     callToAction?: ListCallToAction;

package/build/renderers/LoadingIndicatorRendererProps.d.ts

@@ -1,8 +1,5 @@
 import { Margin, Size } from './constants';
 import { BaseRendererProps } from './RendererProps';
-/**
- * @experimental Expect RendererProps to change as we align them across platform
- */
 export type LoadingIndicatorRendererProps = BaseRendererProps & {
     type: 'loading-indicator';
     control?: string;

package/build/renderers/MarkdownRendererProps.d.ts

@@ -1,8 +1,5 @@
 import { Align, Margin } from './constants';
 import { BaseRendererProps } from './RendererProps';
-/**
- * @experimental Expect RendererProps to change as we align them across platform
- */
 export type MarkdownRendererProps = BaseRendererProps & {
     type: 'markdown';
     control?: string;

package/build/renderers/ModalRendererProps.d.ts

@@ -1,9 +1,6 @@
 import { ReactNode } from 'react';
 import { Margin } from './constants';
 import { BaseRendererProps, RendererProps } from './RendererProps';
-/**
- * @experimental Expect RendererProps to change as we align them across platform
- */
 export type ModalRendererProps = BaseRendererProps & {
     type: 'modal';
     control?: string;