@wise/dynamic-flow-types 3.1.4 → 3.3.0

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

@@ -2,6 +2,8 @@ import type { Action } from '../feature/Action';
 import type { Icon } from '../misc/Icon';
 import type { Image } from '../misc/Image';
 import type { Behavior } from '../feature/Behavior';
+import type { SupportingValues } from '../misc/SupportingValues';
+import type { InlineAlert } from '../misc/InlineAlert';
 /**
 * An option is a single entry in the decision that the user can choose.
 */
@@ -40,4 +42,20 @@ export type DecisionLayoutOption = {
     * @experimental This feature may be changed in the future without notice.
     */
     tag?: string;
+    /**
+    * Additional information to be displayed to the user.
+    * @experimental This feature may be changed in the future without notice.
+    */
+    additionalText?: string;
+    /**
+    * An object containing two strings representing two user-facing values.
+    * One being clearly more important than the other.
+    * @experimental This feature may be changed in the future without notice.
+    */
+    supportingValues?: SupportingValues;
+    /**
+    * An alert that will be displayed inline with the item.
+    * @experimental This feature may be changed in the future without notice.
+    */
+    inlineAlert?: InlineAlert;
 };

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

@@ -1,15 +1,13 @@
 import type { ListLayoutStatus } from './ListLayoutStatus';
 import type { Icon } from '../misc/Icon';
 import type { Image } from '../misc/Image';
+import type { AdditionalInfo } from '../misc/AdditionalInfo';
+import type { SupportingValues } from '../misc/SupportingValues';
+import type { InlineAlert } from '../misc/InlineAlert';
 /**
 * A single entry in a [ListLayout].
 */
 export type ListLayoutItem = {
-    /**
-    * A user-facing description.
-    * @deprecated Please use 'StatusListLayout' instead
-    */
-    description?: string;
     /**
     * The status of the item, if it has one.
     * @deprecated Please use 'StatusListLayout' instead
@@ -29,14 +27,17 @@ export type ListLayoutItem = {
     title?: string;
     /**
     * A user-facing subtitle.
+    * @deprecated Please use 'description' instead
     */
     subtitle?: string;
     /**
     * A user-facing value.
+    * @deprecated Please use 'supportingValues' instead
     */
     value?: string;
     /**
     * A user-facing subvalue.
+    * @deprecated Please use 'supportingValues' instead
     */
     subvalue?: string;
     /**
@@ -44,4 +45,24 @@ export type ListLayoutItem = {
     * @experimental This feature may be changed in the future without notice.
     */
     tag?: string;
+    /**
+    * Additional information to be displayed to the user, with optional interactivity.
+    * @experimental This feature may be changed in the future without notice.
+    */
+    additionalInfo?: AdditionalInfo;
+    /**
+    * An object containing two strings representing two user-facing values.
+    * One being clearly more important than the other.
+    * @experimental This feature may be changed in the future without notice.
+    */
+    supportingValues?: SupportingValues;
+    /**
+    * An alert that will be displayed inline with the item.
+    * @experimental This feature may be changed in the future without notice.
+    */
+    inlineAlert?: InlineAlert;
+    /**
+    * A user-facing description.
+    */
+    description?: string;
 };

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

@@ -1,4 +1,9 @@
 import type { Help } from '../feature/Help';
+import type { Icon } from '../misc/Icon';
+import type { Image } from '../misc/Image';
+import type { AdditionalInfo } from '../misc/AdditionalInfo';
+import type { InlineAlert } from '../misc/InlineAlert';
+import type { ReviewLayoutCallToAction } from './ReviewLayoutCallToAction';
 /**
 * A single field in a [ReviewLayout]
 */
@@ -27,4 +32,29 @@ export type ReviewLayoutField = {
     * @experimental This feature may be changed in the future without notice.
     */
     tag?: string;
+    /**
+    * An icon to represent the item.
+    * @experimental This feature may be changed in the future without notice.
+    */
+    icon?: Icon;
+    /**
+    * An image to represent the option.
+    * @experimental This feature may be changed in the future without notice.
+    */
+    image?: Image;
+    /**
+    * Additional information to be displayed to the user, with optional interactivity.
+    * @experimental This feature may be changed in the future without notice.
+    */
+    additionalInfo?: AdditionalInfo;
+    /**
+    * An alert that will be displayed inline with the item.
+    * @experimental This feature may be changed in the future without notice.
+    */
+    inlineAlert?: InlineAlert;
+    /**
+    * A titled [com.wise.dynamicflow.feature.Behavior], associated with a specific field, and which can be performed by the user
+    * @experimental This feature may be changed in the future without notice.
+    */
+    callToAction?: ReviewLayoutCallToAction;
 };

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

@@ -0,0 +1,18 @@
+import type { Behavior } from '../feature/Behavior';
+/**
+* Additional information to be displayed to the user, with optional interactivity.
+*/
+export type AdditionalInfo = {
+    /**
+    * Additional information to be displayed to the user.
+    */
+    text: string;
+    /**
+    * An optional behavior to be triggered when interacting with the text.
+    */
+    behavior?: Behavior;
+    /**
+    * A description of the behavior to be used by screen readers.
+    */
+    accessibilityDescription?: string;
+};

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

@@ -0,0 +1,14 @@
+import type { Context } from './Context';
+/**
+* An alert that will be displayed inline with the item that contains it.
+*/
+export type InlineAlert = {
+    /**
+    * The content of the alert as string.
+    */
+    content: string;
+    /**
+    * The semantics of the alert. Defaults to `neutral`.
+    */
+    context?: Context;
+};

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

@@ -0,0 +1,14 @@
+/**
+* An object containing two strings representing two user-facing values.
+* One being clearly more important than the other.
+*/
+export type SupportingValues = {
+    /**
+    * The more important value of the two.
+    */
+    value?: string;
+    /**
+    * The less important value of the two.
+    */
+    subvalue?: string;
+};

package/build/next/responses/modal/ModalResponseBody.d.ts

@@ -0,0 +1,18 @@
+import type { Layout } from '../../layout/Layout';
+/**
+* Represents a Modal response body.
+* A response is determined to be a Modal when the status code is in the 200-299 range,
+* and the `X-DF-Response-Type: modal` header is provided.
+* When this response is received, the client opens the provided modal as if it was included as
+* a ModalBehavior on the Step being presented.
+*/
+export type ModalResponseBody = {
+    /**
+    * A user-facing title for the modal content block
+    */
+    title?: string;
+    /**
+    * The layout components to appear inside the modal when presented
+    */
+    content: Layout[];
+};

package/build/renderers/AlertRendererProps.d.ts

@@ -6,17 +6,15 @@ export type AlertRendererProps = BaseRendererProps & {
     context: Context;
     margin: Margin;
     markdown: string;
-    callToAction?: AlertCallToAction | AlertCallToActionLink;
-};
-export type AlertCallToActionLink = {
-    type: 'link';
-    title: string;
-    accessibilityDescription?: string;
-    href: string;
+    callToAction?: AlertCallToAction;
 };
 export type AlertCallToAction = {
-    type: 'action';
     title: string;
     accessibilityDescription?: string;
+} & ({
+    type: 'link';
+    href: string;
+} | {
+    type: 'action' | 'dismiss' | 'modal';
     onClick: () => void;
-};
+});

package/build/renderers/DecisionRendererProps.d.ts

@@ -1,7 +1,7 @@
 import { Icon } from './Icon';
 import { Image } from './Image';
 import { BaseRendererProps } from './RendererProps';
-import { Margin } from './constants';
+import { InlineAlert, Margin, SupportingValues } from './constants';
 export type DecisionRendererProps = BaseRendererProps & {
     type: 'decision';
     control?: string;
@@ -17,5 +17,11 @@ export type DecisionOption = {
     image?: Image;
     title: string;
     tag?: string;
+    /** @experimental This feature may be changed in the future without notice. */
+    additionalText?: string;
+    /** @experimental This feature may be changed in the future without notice. */
+    supportingValues?: SupportingValues;
+    /** @experimental This feature may be changed in the future without notice. */
+    inlineAlert?: InlineAlert;
     onClick: () => void;
 };

package/build/renderers/ExternalConfirmationRendererProps.d.ts

@@ -0,0 +1,9 @@
+import { BaseRendererProps } from './RendererProps';
+export type ExternalConfirmationRendererProps = BaseRendererProps & {
+    type: 'external-confirmation';
+    url: string;
+    status: 'initial' | 'success' | 'failure' | 'dismissed';
+    onSuccess: () => void;
+    onFailure: () => void;
+    onCancel: () => void;
+};

package/build/renderers/ListRendererProps.d.ts

@@ -1,7 +1,8 @@
+import { SupportingValues } from '../next';
 import { Icon } from './Icon';
 import { Image } from './Image';
 import { BaseRendererProps } from './RendererProps';
-import { Margin } from './constants';
+import { AdditionalInfo, InlineAlert, Margin } from './constants';
 export type ListRendererProps = BaseRendererProps & {
     type: 'list';
     callToAction?: ListCallToAction;
@@ -14,22 +15,28 @@ export type ListItem = {
     icon?: Icon;
     image?: Image;
     title?: string;
+    /** @deprecated Use `description` instead. */
     subtitle?: string;
+    description?: string;
+    /** @deprecated Use `supportedValues` instead. */
     value?: string;
+    /** @deprecated Use `supportedValues` instead. */
     subvalue?: string;
     tag?: string;
+    /** @experimental This feature may be changed in the future without notice. */
+    supportingValues?: SupportingValues;
+    /** @experimental This feature may be changed in the future without notice. */
+    additionalInfo?: AdditionalInfo;
+    /** @experimental This feature may be changed in the future without notice. */
+    inlineAlert?: InlineAlert;
 };
-export type ListCallToAction = ListCallToActionLink | ListCallToActionAction;
-export type ListCallToActionLink = {
-    type: 'link';
-    title: string;
+export type ListCallToAction = {
     accessibilityDescription?: string;
-    href: string;
-    onClick: () => void;
-};
-export type ListCallToActionAction = {
-    type: 'action';
     title: string;
-    accessibilityDescription?: string;
     onClick: () => void;
-};
+} & ({
+    type: 'action' | 'modal' | 'dismiss';
+} | {
+    type: 'link';
+    href: string;
+});

package/build/renderers/ModalContentRendererProps.d.ts

@@ -0,0 +1,10 @@
+import { ReactNode } from 'react';
+import { BaseRendererProps, RendererProps } from './RendererProps';
+export type ModalContentRendererProps = BaseRendererProps & {
+    type: 'modal-content';
+    children: ReactNode;
+    childrenProps: RendererProps[];
+    open: boolean;
+    title?: string;
+    onClose: () => void;
+};

package/build/renderers/RendererProps.d.ts

@@ -7,6 +7,7 @@ import { CoreContainerRendererProps } from './CoreContainerRendererProps';
 import { DateInputRendererProps } from './DateInputRendererProps';
 import { DecisionRendererProps } from './DecisionRendererProps';
 import { DividerRendererProps } from './DividerRendererProps';
+import { ExternalConfirmationRendererProps } from './ExternalConfirmationRendererProps';
 import { FormRendererProps } from './FormRendererProps';
 import { HeadingRendererProps } from './HeadingRendererProps';
 import { HiddenRendererProps } from './HiddenRendererProps';
@@ -16,6 +17,7 @@ import { IntegerInputRendererProps } from './IntegerInputRendererProps';
 import { ListRendererProps } from './ListRendererProps';
 import { LoadingIndicatorRendererProps } from './LoadingIndicatorRendererProps';
 import { MarkdownRendererProps } from './MarkdownRendererProps';
+import { ModalContentRendererProps } from './ModalContentRendererProps';
 import { ModalRendererProps } from './ModalRendererProps';
 import { MultiSelectInputRendererProps } from './MultiSelectInputRendererProps';
 import { MultiUploadInputRendererProps } from './MultiUploadInputRendererProps';
@@ -31,7 +33,7 @@ import { StatusListRendererProps } from './StatusListRendererProps';
 import { AnalyticsEventDispatcher, LoadingState, StepRendererProps } from './StepRendererProps';
 import { TextInputRendererProps } from './TextInputRendererProps';
 import { UploadInputRendererProps } from './UploadInputRendererProps';
-export type RendererProps = AlertRendererProps | CheckboxInputRendererProps | BoxRendererProps | ButtonRendererProps | ColumnsRendererProps | CoreContainerRendererProps | DateInputRendererProps | DecisionRendererProps | DividerRendererProps | FormRendererProps | HeadingRendererProps | HiddenRendererProps | ImageRendererProps | InstructionsRendererProps | IntegerInputRendererProps | ListRendererProps | LoadingIndicatorRendererProps | MarkdownRendererProps | ModalRendererProps | MultiSelectInputRendererProps | MultiUploadInputRendererProps | NumberInputRendererProps | ParagraphRendererProps | RepeatableRendererProps | ReviewRendererProps | RootRendererProps | SearchRendererProps | SectionRendererProps | SelectInputRendererProps | StatusListRendererProps | StepRendererProps | TextInputRendererProps | UploadInputRendererProps;
+export type RendererProps = AlertRendererProps | CheckboxInputRendererProps | BoxRendererProps | ButtonRendererProps | ColumnsRendererProps | CoreContainerRendererProps | DateInputRendererProps | DecisionRendererProps | DividerRendererProps | ExternalConfirmationRendererProps | FormRendererProps | HeadingRendererProps | HiddenRendererProps | ImageRendererProps | InstructionsRendererProps | IntegerInputRendererProps | ListRendererProps | LoadingIndicatorRendererProps | MarkdownRendererProps | ModalRendererProps | ModalContentRendererProps | MultiSelectInputRendererProps | MultiUploadInputRendererProps | NumberInputRendererProps | ParagraphRendererProps | RepeatableRendererProps | ReviewRendererProps | RootRendererProps | SearchRendererProps | SectionRendererProps | SelectInputRendererProps | StatusListRendererProps | StepRendererProps | TextInputRendererProps | UploadInputRendererProps;
 export type Renderer<P extends RendererProps> = {
     canRenderType: P['type'];
     canRender?: (props: P) => boolean;
@@ -41,7 +43,7 @@ export type RendererContext = {
     render: RenderFunction;
 };
 export type RenderFunction = (props: RendererProps | null) => JSX.Element | null;
-export type Renderers = readonly (Renderer<StepRendererProps> | Renderer<CoreContainerRendererProps> | Renderer<AlertRendererProps> | Renderer<BoxRendererProps> | Renderer<ColumnsRendererProps> | Renderer<DecisionRendererProps> | Renderer<DividerRendererProps> | Renderer<FormRendererProps> | Renderer<HeadingRendererProps> | Renderer<InstructionsRendererProps> | Renderer<ListRendererProps> | Renderer<LoadingIndicatorRendererProps> | Renderer<MarkdownRendererProps> | Renderer<ImageRendererProps> | Renderer<ModalRendererProps> | Renderer<ParagraphRendererProps> | Renderer<ReviewRendererProps> | Renderer<SearchRendererProps> | Renderer<StatusListRendererProps> | Renderer<CheckboxInputRendererProps> | Renderer<ButtonRendererProps> | Renderer<DateInputRendererProps> | Renderer<HiddenRendererProps> | Renderer<IntegerInputRendererProps> | Renderer<NumberInputRendererProps> | Renderer<RepeatableRendererProps> | Renderer<RootRendererProps> | Renderer<SectionRendererProps> | Renderer<SelectInputRendererProps> | Renderer<MultiSelectInputRendererProps> | Renderer<TextInputRendererProps> | Renderer<UploadInputRendererProps> | Renderer<MultiUploadInputRendererProps>)[];
+export type Renderers = readonly (Renderer<StepRendererProps> | Renderer<CoreContainerRendererProps> | Renderer<AlertRendererProps> | Renderer<BoxRendererProps> | Renderer<ColumnsRendererProps> | Renderer<DecisionRendererProps> | Renderer<DividerRendererProps> | Renderer<ExternalConfirmationRendererProps> | Renderer<FormRendererProps> | Renderer<HeadingRendererProps> | Renderer<InstructionsRendererProps> | Renderer<ListRendererProps> | Renderer<LoadingIndicatorRendererProps> | Renderer<MarkdownRendererProps> | Renderer<ImageRendererProps> | Renderer<ModalRendererProps> | Renderer<ModalContentRendererProps> | Renderer<ParagraphRendererProps> | Renderer<ReviewRendererProps> | Renderer<SearchRendererProps> | Renderer<StatusListRendererProps> | Renderer<CheckboxInputRendererProps> | Renderer<ButtonRendererProps> | Renderer<DateInputRendererProps> | Renderer<HiddenRendererProps> | Renderer<IntegerInputRendererProps> | Renderer<NumberInputRendererProps> | Renderer<RepeatableRendererProps> | Renderer<RootRendererProps> | Renderer<SectionRendererProps> | Renderer<SelectInputRendererProps> | Renderer<MultiSelectInputRendererProps> | Renderer<TextInputRendererProps> | Renderer<UploadInputRendererProps> | Renderer<MultiUploadInputRendererProps>)[];
 export type BaseRendererProps = {
     uid: string;
     render: RenderFunction;

package/build/renderers/ReviewRendererProps.d.ts

@@ -1,4 +1,6 @@
-import { Margin } from './constants';
+import { AdditionalInfo, InlineAlert, Margin } from './constants';
+import { Icon } from './Icon';
+import { Image } from './Image';
 import { BaseRendererProps } from './RendererProps';
 export type ReviewRendererProps = BaseRendererProps & {
     type: 'review';
@@ -14,6 +16,16 @@ export type ReviewField = {
     value: string;
     rawValue?: string;
     tag?: string;
+    /** @experimental This feature may be changed in the future without notice. */
+    additionalInfo?: AdditionalInfo;
+    /** @experimental This feature may be changed in the future without notice. */
+    inlineAlert?: InlineAlert;
+    /** @experimental This feature may be changed in the future without notice. */
+    callToAction?: ReviewCallToAction;
+    /** @experimental This feature may be changed in the future without notice. */
+    icon?: Icon;
+    /** @experimental This feature may be changed in the future without notice. */
+    image?: Image;
 };
 export type ReviewCallToAction = {
     accessibilityDescription?: string;

package/build/renderers/RootRendererProps.d.ts

@@ -1,6 +1,6 @@
 import { ReactNode } from 'react';
-import { RendererProps } from './RendererProps';
-export type RootRendererProps = {
+import { BaseRendererProps, RendererProps } from './RendererProps';
+export type RootRendererProps = BaseRendererProps & {
     type: 'root';
     uid: string;
     children: ReactNode;

package/build/renderers/constants.d.ts

@@ -2,3 +2,16 @@ export type Align = 'start' | 'center' | 'end';
 export type Autocapitalization = 'none' | 'sentences' | 'words' | 'characters';
 export type Context = 'positive' | 'negative' | 'warning' | 'neutral';
 export type { Margin, Size } from '../next';
+export type AdditionalInfo = {
+    text: string;
+    accessibilityDescription?: string;
+    onClick?: () => void;
+};
+export type InlineAlert = {
+    content: string;
+    context?: Context;
+};
+export type SupportingValues = {
+    value?: string;
+    subvalue?: string;
+};

package/build/renderers/index.d.ts

@@ -1,38 +1,40 @@
-export type { AlertRendererProps, AlertCallToAction, AlertCallToActionLink, } from './AlertRendererProps';
-export type { CheckboxInputRendererProps } from './CheckboxInputRendererProps';
+export type { AlertCallToAction, AlertRendererProps } from './AlertRendererProps';
 export type { BoxRendererProps } from './BoxRendererProps';
 export type { ButtonRendererProps } from './ButtonRendererProps';
+export type { CheckboxInputRendererProps } from './CheckboxInputRendererProps';
 export type { ColumnsRendererProps } from './ColumnsRendererProps';
 export type { CoreContainerRendererProps } from './CoreContainerRendererProps';
 export type { DateInputRendererProps } from './DateInputRendererProps';
-export type { DecisionRendererProps, DecisionOption } from './DecisionRendererProps';
+export type { DecisionOption, DecisionRendererProps } from './DecisionRendererProps';
 export type { DividerRendererProps } from './DividerRendererProps';
+export type { ExternalConfirmationRendererProps } from './ExternalConfirmationRendererProps';
 export type { FormRendererProps } from './FormRendererProps';
-export type { SectionRendererProps } from './SectionRendererProps';
 export type { HeadingRendererProps } from './HeadingRendererProps';
 export type { HiddenRendererProps } from './HiddenRendererProps';
 export type { ImageRendererProps } from './ImageRendererProps';
-export type { InstructionsRendererProps, InstructionItem } from './InstructionsRendererProps';
+export type { InstructionItem, InstructionsRendererProps } from './InstructionsRendererProps';
 export type { IntegerInputRendererProps } from './IntegerInputRendererProps';
 export type { ListRendererProps } from './ListRendererProps';
 export type { LoadingIndicatorRendererProps } from './LoadingIndicatorRendererProps';
 export type { MarkdownRendererProps } from './MarkdownRendererProps';
+export type { ModalContentRendererProps } from './ModalContentRendererProps';
 export type { ModalRendererProps } from './ModalRendererProps';
 export type { MultiSelectInputRendererProps } from './MultiSelectInputRendererProps';
 export type { MultiUploadInputRendererProps } from './MultiUploadInputRendererProps';
 export type { NumberInputRendererProps } from './NumberInputRendererProps';
 export type { ParagraphRendererProps } from './ParagraphRendererProps';
-export type { RepeatableRendererProps, RepeatableItemRendererProps, } from './RepeatableRendererProps';
-export type { ReviewRendererProps, ReviewField, ReviewCallToAction } from './ReviewRendererProps';
+export type { RepeatableItemRendererProps, RepeatableRendererProps } from './RepeatableRendererProps';
+export type { ReviewCallToAction, ReviewField, ReviewRendererProps } from './ReviewRendererProps';
 export type { RootRendererProps } from './RootRendererProps';
-export type { SearchRendererProps, SearchResult, SearchState, ErrorSearchState, PendingSearchState, NoResultsSearchState, ResultsSearchState, } from './SearchRendererProps';
-export type { SelectInputRendererProps, SelectInputRendererOption, } from './SelectInputRendererProps';
-export type { StatusListRendererProps, StatusListItem, StatusListItemCallToAction, StatusListItemStatus, } from './StatusListRendererProps';
-export type { StepRendererProps, AnalyticsEventDispatcher, LoadingState, } from './StepRendererProps';
+export type { ErrorSearchState, NoResultsSearchState, PendingSearchState, ResultsSearchState, SearchRendererProps, SearchResult, SearchState } from './SearchRendererProps';
+export type { SectionRendererProps } from './SectionRendererProps';
+export type { SelectInputRendererOption, SelectInputRendererProps } from './SelectInputRendererProps';
+export type { StatusListItem, StatusListItemCallToAction, StatusListItemStatus, StatusListRendererProps } from './StatusListRendererProps';
+export type { AnalyticsEventDispatcher, LoadingState, StepRendererProps } from './StepRendererProps';
 export type { TextInputRendererProps } from './TextInputRendererProps';
 export type { UploadInputRendererProps } from './UploadInputRendererProps';
 export type { ValidationResult } from './BaseInputRendererProps';
 export type { Align, Context, Margin, Size } from './constants';
 export type { Icon } from './Icon';
 export type { Image } from './Image';
-export type { RenderFunction, RendererProps, Renderers, Renderer } from './RendererProps';
+export type { Renderer, RendererProps, Renderers, RenderFunction } from './RendererProps';