@wise/dynamic-flow-types 2.8.0 → 2.9.0

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

@@ -1,17 +1,50 @@
 import type { Size } from '../misc/Size';
 import type { Action } from '../feature/Action';
 import type { Context } from '../misc/Context';
+/**
+* A component which performs an [com.wise.dynamicflow.feature.Action] when pressed.
+* You can affect the button appearance using the "control" and "context" properties.
+*/
 export type ButtonLayout = {
+    /**
+    * It must be `button`.
+    */
     type: 'button';
+    /**
+    * @deprecated This is a web only feature that will be removed in a later release
+    */
+    size?: Size;
+    /**
+    * A user-facing title.
+    */
     title?: string;
+    /**
+    * The action to perform when the button is pressed.
+    */
     action: Action;
+    /**
+    * The semantics of the button. Defaults to `neutral`.
+    */
     context?: Context;
+    /**
+    * If `true`, user interaction is disabled. Defaults to `false`.
+    */
     disabled?: boolean;
+    /**
+    * pinOrder is an optional property that specifies that the button should be pinned
+    * at the bottom of the display. If multiple buttons use pinOrder, they will be ordered
+    * based on the pinOrder value in ascending order from top to bottom.
+    * Any positive or negative integer values are accepted.
+    */
     pinOrder?: number;
+    /**
+    * Specify a particular control to use to represent the layout.
+    * Typically, values are "primary", "secondary", or "tertiary".
+    * If the control is unknown, it will be ignored.
+    */
     control?: string;
-    margin?: Size;
     /**
-    * @deprecated This is a web only feature that will be removed in a later release
+    * The vertical margin to apply above this component. Defaults to `md`.
     */
-    size?: Size;
+    margin?: Size;
 };

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

@@ -1,11 +1,33 @@
 import type { Layout } from './Layout';
 import type { ColumnsLayoutBias } from './ColumnsLayoutBias';
 import type { Size } from '../misc/Size';
+/**
+* Allows content to be displayed in two columns.
+* If screen space is limited, the contents will be collapsed into a single column.
+*/
 export type ColumnsLayout = {
+    /**
+    * It must be `columns`.
+    */
     type: 'columns';
+    /**
+    * An array of layout components to display in the left column.
+    */
     left: Layout[];
+    /**
+    * An array of layout components to display in the right column.
+    */
     right: Layout[];
+    /**
+    * Indicates which column, if any, will be given more visual weight. Defaults to `none`.
+    */
     bias?: ColumnsLayoutBias;
+    /**
+    * Specify a particular control to use to represent the layout. If the control is unknown, it will be ignored.
+    */
     control?: string;
+    /**
+    * The vertical margin to apply above this component. Defaults to `md`.
+    */
     margin?: Size;
 };

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

@@ -1 +1,4 @@
+/**
+* Values for the bias property.
+*/
 export type ColumnsLayoutBias = 'none' | 'left' | 'right';

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

@@ -1,8 +1,23 @@
 import type { DecisionLayoutOption } from './DecisionLayoutOption';
 import type { Size } from '../misc/Size';
+/**
+* A set of options which each perform an [com.wise.dynamicflow.feature.Action].
+*/
 export type DecisionLayout = {
+    /**
+    * It must be `decision`.
+    */
     type: 'decision';
+    /**
+    * Array of options.
+    */
     options: DecisionLayoutOption[];
+    /**
+    * Specify a particular control to use to represent the layout. If the control is unknown, it will be ignored.
+    */
     control?: string;
+    /**
+    * The vertical margin to apply above this component. Defaults to `md`.
+    */
     margin?: Size;
 };

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

@@ -1,11 +1,32 @@
 import type { Action } from '../feature/Action';
 import type { Icon } from '../misc/Icon';
 import type { ImageLayout } from './ImageLayout';
+/**
+* An option is a single entry in the decision that the user can choose.
+*/
 export type DecisionLayoutOption = {
+    /**
+    * The action to perform when selected.
+    */
     action: Action;
+    /**
+    * A user-facing title.
+    */
     title: string;
+    /**
+    * A user-facing description.
+    */
     description?: string;
+    /**
+    * If `true`, user interaction is disabled. Defaults to `false`.
+    */
     disabled?: boolean;
+    /**
+    * An icon to represent the option.
+    */
     icon?: Icon;
+    /**
+    * An image to represent the option.
+    */
     image?: ImageLayout;
 };

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

@@ -1,9 +1,19 @@
 import type { Size } from '../misc/Size';
 /**
+* A deprecated divider, only supported on web
 * @deprecated Divider is deprecated and only supported on web. Please do not use.
 */
 export type DividerLayout = {
+    /**
+    * It must be 'divider'
+    */
     type: 'divider';
+    /**
+    * Specify a particular control to use to represent the layout. If the control is unknown, it will be ignored.
+    */
     control?: string;
+    /**
+    * The vertical margin to apply above this component. Defaults to `md`.
+    */
     margin?: Size;
 };

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

@@ -1,12 +1,30 @@
 import type { FormLayoutSchemaReference } from './FormLayoutSchemaReference';
 import type { Size } from '../misc/Size';
+/**
+* Embed a schema inside the layout's structure.
+* Form Layout is used to better control how layouts and schemas are displayed by allowing them to be interleaved.
+* Layouts can be displayed before or after a top-level schema, but not in-between child schemas.
+* Schemas in the layout structure will be combined with schemas in schemas as if there's an [com.wise.dynamicflow.schema.AllOfSchema] Schema surrounding them.
+*/
 export type FormLayout = {
+    /**
+    * It must be `form`.
+    */
     type: 'form';
-    schemaId: string;
-    control?: string;
-    margin?: Size;
     /**
     * @deprecated Please use 'schemaId' instead.
     */
     schema?: FormLayoutSchemaReference;
+    /**
+    * The schema that should be embedded in this place in the layout. It must be the ID of a schema at the top level of the `schemas` array.
+    */
+    schemaId: string;
+    /**
+    * Specify a particular control to use to represent the layout. If the control is unknown, it will be ignored.
+    */
+    control?: string;
+    /**
+    * The vertical margin to apply above this component. Defaults to `md`.
+    */
+    margin?: Size;
 };

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

@@ -1,6 +1,10 @@
 /**
+* Deprecated reference object.
 * @deprecated Please use 'schemaId' instead.
 */
 export type FormLayoutSchemaReference = {
+    /**
+    * A string reference.
+    */
     $ref: string;
 };

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

@@ -1,10 +1,31 @@
 import type { Size } from '../misc/Size';
 import type { Align } from '../misc/Align';
+/**
+* A heading which can be used to title or separate sections of a layout.
+*/
 export type HeadingLayout = {
+    /**
+    * It must be `heading`.
+    */
     type: 'heading';
+    /**
+    * The user-facing content of the heading.
+    */
     text: string;
+    /**
+    * The size of the content. Defaults to md.
+    */
     size?: Size;
+    /**
+    * The horizontal alignment of the text. Defaults to `left`.
+    */
     align?: Align;
+    /**
+    * Specify a particular control to use to represent the layout. If the control is unknown, it will be ignored.
+    */
     control?: string;
+    /**
+    * The vertical margin to apply above this component. Defaults to `md`.
+    */
     margin?: Size;
 };

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

@@ -1,16 +1,38 @@
 import type { Size } from '../misc/Size';
+/**
+* Images fetched from URLs.
+*/
 export type ImageLayout = {
+    /**
+    * It must be `image`.
+    */
     type: 'image';
-    url: string;
-    size?: Size;
-    control?: string;
-    margin?: Size;
     /**
     * @deprecated Please use 'accessibilityDescription' instead
     */
     text?: string;
     /**
+    * The URL to use to fetch the image.
+    */
+    url: string;
+    /**
+    * The horizontal size of the image. Defaults to `md`.
+    * The image is scaled down to fit the provided size while preserving the aspect
+    * ratio, and it is never stretched beyond its pixel size.
+    * If `xl` is used, the image will fill as much space as it can.
+    */
+    size?: Size;
+    /**
+    * 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;
+    /**
+    * Specify a particular control to use to represent the layout. If the control is unknown, it will be ignored.
+    */
+    control?: string;
+    /**
+    * The vertical margin to apply above this component. Defaults to `md`.
+    */
+    margin?: Size;
 };

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

@@ -1,12 +1,29 @@
 import type { Align } from '../misc/Align';
 import type { Size } from '../misc/Size';
 /**
+* A block of markdown content.
+* Info is a block of rich content defined using markdown. Please use 'MarkdownLayout' instead.
 * @deprecated Please use 'MarkdownLayout' instead
 */
 export type InfoLayout = {
+    /**
+    * It must be `info`.
+    */
     type: 'info';
+    /**
+    * The markdown-formatted string to use as the content.
+    */
     markdown: string;
+    /**
+    * The text alignment of the content. Default to `left`.
+    */
     align?: Align;
+    /**
+    * Specify a particular control to use to represent the layout. If the control is unknown, it will be ignored.
+    */
     control?: string;
+    /**
+    * The vertical margin to apply above this component. Defaults to `md`.
+    */
     margin?: Size;
 };

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

@@ -1,9 +1,27 @@
 import type { InstructionsLayoutItem } from './InstructionsLayoutItem';
 import type { Size } from '../misc/Size';
+/**
+* A list of fields used to inform the user of actions to do and not do.
+*/
 export type InstructionsLayout = {
+    /**
+    * It must be 'instructions'.
+    */
     type: 'instructions';
+    /**
+    * A user-facing title.
+    */
     title?: string;
+    /**
+    * An array of instructions.
+    */
     items: InstructionsLayoutItem[];
+    /**
+    * Specify a particular control to use to represent the layout. If the control is unknown, it will be ignored.
+    */
     control?: string;
+    /**
+    * The vertical margin to apply above this component. Defaults to `md`.
+    */
     margin?: Size;
 };

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

@@ -1,5 +1,14 @@
 import type { Context } from '../misc/Context';
+/**
+* A single instruction in an [InstructionsLayout]
+*/
 export type InstructionsLayoutItem = {
+    /**
+    * The user-facing text for the instruction.
+    */
     text: string;
+    /**
+    * The semantics of the instruction.
+    */
     context: Context;
 };

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

@@ -17,4 +17,7 @@ import type { ParagraphLayout } from './ParagraphLayout';
 import type { ReviewLayout } from './ReviewLayout';
 import type { SearchLayout } from './SearchLayout';
 import type { StatusListLayout } from './StatusListLayout';
+/**
+* Layouts allow you to display information to the user and customise how a step is structured.
+*/
 export type Layout = AlertLayout | BoxLayout | ButtonLayout | ColumnsLayout | DecisionLayout | DividerLayout | FormLayout | HeadingLayout | ImageLayout | InfoLayout | InstructionsLayout | ListLayout | LoadingIndicatorLayout | MarkdownLayout | ModalLayout | ParagraphLayout | ReviewLayout | SearchLayout | StatusListLayout;

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

@@ -1,12 +1,28 @@
 import type { ListLayoutItem } from './ListLayoutItem';
 import type { Size } from '../misc/Size';
 /**
+* A list of items with statuses.
 * @deprecated Please use 'StatusListLayout' instead
 */
 export type ListLayout = {
+    /**
+    * It must be `list`.
+    */
     type: 'list';
+    /**
+    * Array of items.
+    */
     items: ListLayoutItem[];
+    /**
+    * The user-facing title.
+    */
     title?: string;
+    /**
+    * Specify a particular control to use to represent the layout. If the control is unknown, it will be ignored.
+    */
     control?: string;
+    /**
+    * The vertical margin to apply above this component. Defaults to `md`.
+    */
     margin?: Size;
 };

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

@@ -1,11 +1,24 @@
 import type { Icon } from '../misc/Icon';
 import type { ListLayoutStatus } from './ListLayoutStatus';
 /**
+* A single entry in a [ListLayout].
 * @deprecated Please use 'StatusListLayout' instead
 */
 export type ListLayoutItem = {
+    /**
+    * A user-facing title.
+    */
     title: string;
+    /**
+    * A user-facing description.
+    */
     description?: string;
+    /**
+    * An icon to represent the item.
+    */
     icon: Icon;
+    /**
+    * The status of the item, if it has one.
+    */
     status?: ListLayoutStatus;
 };

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

@@ -1,4 +1,5 @@
 /**
+* Represents the state of an item in a [ListLayout].
 * @deprecated Please use 'StatusListLayout' instead
 */
 export type ListLayoutStatus = 'warning' | 'neutral' | 'positive';

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

@@ -1,7 +1,23 @@
 import type { Size } from '../misc/Size';
+/**
+* A symbol indicating an indeterminate loading or pending state, when the user should wait for something to happen.
+* Typically used in conjunction with [com.wise.dynamicflow.feature.LinkHandler] or [com.wise.dynamicflow.feature.Polling].
+*/
 export type LoadingIndicatorLayout = {
+    /**
+    * It must be 'loading-indicator'
+    */
     type: 'loading-indicator';
+    /**
+    * The size of the indicator. Defaults to `md`.
+    */
     size?: Size;
+    /**
+    * Specify a particular control to use to represent the layout. If the control is unknown, it will be ignored.
+    */
     control?: string;
+    /**
+    * The vertical margin to apply above this component. Defaults to `md`.
+    */
     margin?: Size;
 };

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

@@ -1,9 +1,34 @@
 import type { Align } from '../misc/Align';
 import type { Size } from '../misc/Size';
+/**
+* A block of markdown content.
+* Markdown is a block of rich content defined using markdown. If you just need plain text, consider using [ParagraphLayout] Layout.
+* The following subset of markdown features are supported:
+* - Heading
+* - List (both ordered and unordered)
+* - Emphasis
+* - Strong Emphasis
+* - Links
+*/
 export type MarkdownLayout = {
+    /**
+    * It must be `markdown`.
+    */
     type: 'markdown';
+    /**
+    * The markdown-formatted string to use as the content.
+    */
     content: string;
+    /**
+    * The text alignment of the content. Default to `left`.
+    */
     align?: Align;
+    /**
+    * Specify a particular control to use to represent the layout. If the control is unknown, it will be ignored.
+    */
     control?: string;
+    /**
+    * The vertical margin to apply above this component. Defaults to `md`.
+    */
     margin?: Size;
 };

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

@@ -2,12 +2,29 @@ import type { Size } from '../misc/Size';
 import type { ModalLayoutTrigger } from './ModalLayoutTrigger';
 import type { ModalLayoutContent } from './ModalLayoutContent';
 /**
+* A button that triggers a modal with the specified layout components.
+* **Note**: We do not support the use of forms inside a modal.
 * @experimental This feature may be changed in the future without notice.
 */
 export type ModalLayout = {
+    /**
+    * It must be `modal`.
+    */
     type: 'modal';
+    /**
+    * Specify a particular control to use to represent the layout. If the control is unknown, it will be ignored.
+    */
     control?: string;
+    /**
+    * The vertical margin to apply above this component. Defaults to `md`.
+    */
     margin?: Size;
+    /**
+    * Represents the trigger for the modal content
+    */
     trigger: ModalLayoutTrigger;
+    /**
+    * Represents the modal content itself
+    */
     content: ModalLayoutContent;
 };

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

@@ -1,4 +1,7 @@
 import type { Layout } from './Layout';
 export type ModalLayoutContent = {
+    /**
+    * The layout components to appear when triggered
+    */
     components: Layout[];
 };

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

@@ -1,3 +1,6 @@
 export type ModalLayoutTrigger = {
+    /**
+    * The visible title for the trigger
+    */
     title: string;
 };

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

@@ -1,9 +1,27 @@
 import type { Align } from '../misc/Align';
 import type { Size } from '../misc/Size';
+/**
+* A block of plain text. For richer formatting and layout options consider using [MarkdownLayout].
+*/
 export type ParagraphLayout = {
+    /**
+    * It must be `paragraph`.
+    */
     type: 'paragraph';
+    /**
+    * The user-facing string to use as the content.
+    */
     text: string;
+    /**
+    * The text alignment of the content. Default to `left`.
+    */
     align?: Align;
+    /**
+    * Specify a particular control to use to represent the layout. If the control is unknown, it will be ignored.
+    */
     control?: string;
+    /**
+    * The vertical margin to apply above this component. Defaults to `md`.
+    */
     margin?: Size;
 };

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

@@ -2,13 +2,14 @@ import type { Action } from '../feature/Action';
 import type { ReviewLayoutField } from './ReviewLayoutField';
 import type { ReviewLayoutCallToAction } from './ReviewLayoutCallToAction';
 import type { Size } from '../misc/Size';
+/**
+* A list of read-only fields used to show information to the user for review.
+*/
 export type ReviewLayout = {
+    /**
+    * It must be `review`.
+    */
     type: 'review';
-    fields: ReviewLayoutField[];
-    title?: string;
-    callToAction?: ReviewLayoutCallToAction;
-    control?: string;
-    margin?: Size;
     /**
     * @deprecated Please use 'control' instead
     */
@@ -17,4 +18,24 @@ export type ReviewLayout = {
     * @deprecated Please use 'callToAction' instead
     */
     action?: Action;
+    /**
+    * The fields to be reviewed.
+    */
+    fields: ReviewLayoutField[];
+    /**
+    * Title for the review block.
+    */
+    title?: string;
+    /**
+    * A titled [com.wise.dynamicflow.feature.Action] which can be performed by the user
+    */
+    callToAction?: ReviewLayoutCallToAction;
+    /**
+    * Specify a particular control to use to represent the layout. If the control is unknown, it will be ignored.
+    */
+    control?: string;
+    /**
+    * The vertical margin to apply above this component. Defaults to `md`.
+    */
+    margin?: Size;
 };

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

@@ -1,5 +1,14 @@
 import type { Action } from '../feature/Action';
+/**
+* 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 = {
+    /**
+    * A user-facing title.
+    */
     title: string;
+    /**
+    * The [com.wise.dynamicflow.feature.Action] which should be performed.
+    */
     action: Action;
 };

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

@@ -1,6 +1,18 @@
 import type { Help } from '../feature/Help';
+/**
+* A single field in a [ReviewLayout]
+*/
 export type ReviewLayoutField = {
+    /**
+    * The user-facing label.
+    */
     label: string;
+    /**
+    * The user-facing value.
+    */
     value: string;
+    /**
+    * Provide additional help information to the user.
+    */
     help?: Help;
 };