@wise/dynamic-flow-types 2.31.0 → 2.32.0

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

@@ -1,8 +1,9 @@
+import type { ListLayoutCallToAction } from './ListLayoutCallToAction';
 import type { ListLayoutItem } from './ListLayoutItem';
 import type { Size } from '../misc/Size';
 /**
-* A list of items with statuses.
-* @deprecated Please use 'StatusListLayout' instead
+* A list of read-only fields displaying information with optional images or icons for the user.
+* @experimental This feature may be changed in the future without notice.
 */
 export type ListLayout = {
     /**
@@ -10,14 +11,18 @@ export type ListLayout = {
     */
     type: 'list';
     /**
-    * Array of items.
-    */
-    items: ListLayoutItem[];
-    /**
     * The user-facing title.
     */
     title?: string;
     /**
+    * A titled call to action which can be performed by the user.
+    */
+    callToAction?: ListLayoutCallToAction;
+    /**
+    * Array of items.
+    */
+    items: ListLayoutItem[];
+    /**
     * 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/ListLayoutCallToAction.d.ts

@@ -0,0 +1,18 @@
+import type { Behavior } from '../feature/Behavior';
+/**
+* The call to action configuration used by [com.wise.dynamicflow.layout.ListLayout]. For example, it could be used to provide an edit action.
+*/
+export type ListLayoutCallToAction = {
+    /**
+    * 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/layout/ListLayoutItem.d.ts

@@ -1,24 +1,42 @@
-import type { Icon } from '../misc/Icon';
 import type { ListLayoutStatus } from './ListLayoutStatus';
+import type { Icon } from '../misc/Icon';
+import type { Image } from '../misc/Image';
 /**
 * A single entry in a [ListLayout].
-* @deprecated Please use 'StatusListLayout' instead
 */
 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
+    */
+    status?: ListLayoutStatus;
+    /**
+    * An icon to represent the item.
+    */
+    icon?: Icon;
+    /**
+    * An image to represent the option.
+    */
+    image?: Image;
     /**
     * A user-facing title.
     */
     title: string;
     /**
-    * A user-facing description.
+    * A user-facing subtitle.
     */
-    description?: string;
+    subtitle?: string;
     /**
-    * An icon to represent the item.
+    * A user-facing value.
     */
-    icon: Icon;
+    value?: string;
     /**
-    * The status of the item, if it has one.
+    * A user-facing subvalue.
     */
-    status?: ListLayoutStatus;
+    subvalue?: string;
 };

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

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

package/build/renderers/DecisionRendererProps.d.ts

@@ -11,6 +11,7 @@ export type DecisionRendererProps = {
 export type DecisionOption = {
     description?: string;
     disabled?: boolean;
+    href?: string;
     icon?: Icon;
     image?: Image;
     title: string;

package/build/renderers/Image.d.ts

@@ -1 +1,22 @@
-export type { Image } from '../next';
+/**
+* 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;
+    /**
+    * 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/renderers/ListRendererProps.d.ts

@@ -0,0 +1,33 @@
+import { Icon } from "./Icon";
+import { Image } from "./Image";
+import { Margin } from "./constants";
+export type ListRendererProps = {
+    type: 'list';
+    callToAction?: ListCallToAction;
+    control?: string;
+    items: ListItem[];
+    margin: Margin;
+    title?: string;
+};
+export type ListItem = {
+    icon?: Icon;
+    image?: Image;
+    title?: string;
+    subtitle?: string;
+    value?: string;
+    subvalue?: string;
+};
+export type ListCallToAction = ListCallToActionLink | ListCallToActionAction;
+export type ListCallToActionLink = {
+    type: 'link';
+    accessibilityDescription?: string;
+    href: string;
+    title: string;
+    onClick: () => void;
+};
+export type ListCallToActionAction = {
+    type: 'action';
+    accessibilityDescription?: string;
+    title: string;
+    onClick: () => void;
+};

package/build/renderers/RendererProps.d.ts

@@ -14,6 +14,7 @@ import { HiddenRendererProps } from './HiddenRendererProps';
 import { ImageRendererProps } from './ImageRendererProps';
 import { InstructionsRendererProps } from './InstructionsRendererProps';
 import { IntegerInputRendererProps } from './IntegerInputRendererProps';
+import { ListRendererProps } from './ListRendererProps';
 import { LoadingIndicatorRendererProps } from './LoadingIndicatorRendererProps';
 import { MarkdownRendererProps } from './MarkdownRendererProps';
 import { ModalRendererProps } from './ModalRendererProps';
@@ -29,10 +30,10 @@ import { StatusListRendererProps } from './StatusListRendererProps';
 import { StepRendererProps } from './StepRendererProps';
 import { TextInputRendererProps } from './TextInputRendererProps';
 import { UploadInputRendererProps } from './UploadInputRendererProps';
-export type RendererProps = AlertRendererProps | BooleanInputRendererProps | BoxRendererProps | ButtonRendererProps | ColumnsRendererProps | CoreContainerRendererProps | DateInputRendererProps | DecisionRendererProps | DividerRendererProps | FormRendererProps | FormSectionRendererProps | HeadingRendererProps | HiddenRendererProps | ImageRendererProps | InstructionsRendererProps | IntegerInputRendererProps | LoadingIndicatorRendererProps | MarkdownRendererProps | ModalRendererProps | MultiSelectInputRendererProps | MultiUploadInputRendererProps | NumberInputRendererProps | ParagraphRendererProps | RepeatableRendererProps | ReviewRendererProps | SearchRendererProps | SelectInputRendererProps | StatusListRendererProps | StepRendererProps | TextInputRendererProps | UploadInputRendererProps;
+export type RendererProps = AlertRendererProps | BooleanInputRendererProps | BoxRendererProps | ButtonRendererProps | ColumnsRendererProps | CoreContainerRendererProps | DateInputRendererProps | DecisionRendererProps | DividerRendererProps | FormRendererProps | FormSectionRendererProps | HeadingRendererProps | HiddenRendererProps | ImageRendererProps | InstructionsRendererProps | IntegerInputRendererProps | ListRendererProps | LoadingIndicatorRendererProps | MarkdownRendererProps | ModalRendererProps | MultiSelectInputRendererProps | MultiUploadInputRendererProps | NumberInputRendererProps | ParagraphRendererProps | RepeatableRendererProps | ReviewRendererProps | SearchRendererProps | SelectInputRendererProps | StatusListRendererProps | StepRendererProps | TextInputRendererProps | UploadInputRendererProps;
 export type Renderer<P extends RendererProps> = {
     canRenderType: P['type'];
     canRender?: (props: P) => boolean;
     render: (props: P) => JSX.Element;
 };
-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<LoadingIndicatorRendererProps> | Renderer<MarkdownRendererProps> | Renderer<ImageRendererProps> | Renderer<ModalRendererProps> | Renderer<ParagraphRendererProps> | Renderer<ReviewRendererProps> | Renderer<SearchRendererProps> | Renderer<StatusListRendererProps> | Renderer<FormSectionRendererProps> | Renderer<BooleanInputRendererProps> | Renderer<ButtonRendererProps> | Renderer<DateInputRendererProps> | Renderer<HiddenRendererProps> | Renderer<IntegerInputRendererProps> | Renderer<NumberInputRendererProps> | Renderer<RepeatableRendererProps> | 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<FormRendererProps> | Renderer<HeadingRendererProps> | Renderer<InstructionsRendererProps> | Renderer<ListRendererProps> | Renderer<LoadingIndicatorRendererProps> | Renderer<MarkdownRendererProps> | Renderer<ImageRendererProps> | Renderer<ModalRendererProps> | Renderer<ParagraphRendererProps> | Renderer<ReviewRendererProps> | Renderer<SearchRendererProps> | Renderer<StatusListRendererProps> | Renderer<FormSectionRendererProps> | Renderer<BooleanInputRendererProps> | Renderer<ButtonRendererProps> | Renderer<DateInputRendererProps> | Renderer<HiddenRendererProps> | Renderer<IntegerInputRendererProps> | Renderer<NumberInputRendererProps> | Renderer<RepeatableRendererProps> | Renderer<SelectInputRendererProps> | Renderer<MultiSelectInputRendererProps> | Renderer<TextInputRendererProps> | Renderer<UploadInputRendererProps> | Renderer<MultiUploadInputRendererProps>)[];

package/build/renderers/SearchRendererProps.d.ts

@@ -1,4 +1,4 @@
-import type { SearchResult as SearchResultSpec } from '../next';
+import type { ImageLayout, SearchResult as SearchResultSpec } from '../next';
 import { Margin } from './constants';
 export type SearchRendererProps = {
     type: 'search';
@@ -27,7 +27,10 @@ export type ResultsSearchState = {
     type: 'results';
     results: SearchResult[];
 };
-export type SearchResult = Pick<SearchResultSpec, 'description' | 'icon' | 'image' | 'title' | 'type'> & {
+export type SearchResult = Pick<SearchResultSpec, 'description' | 'icon' | 'title' | 'type'> & {
     id?: string;
+    image?: ImageLayout & {
+        uri?: string;
+    };
     onClick: () => void;
 };

package/build/renderers/index.d.ts

@@ -14,6 +14,7 @@ export type { HiddenRendererProps } from './HiddenRendererProps';
 export type { ImageRendererProps } from './ImageRendererProps';
 export type { InstructionsRendererProps, InstructionItem } from './InstructionsRendererProps';
 export type { IntegerInputRendererProps } from './IntegerInputRendererProps';
+export type { ListRendererProps } from './ListRendererProps';
 export type { LoadingIndicatorRendererProps } from './LoadingIndicatorRendererProps';
 export type { MarkdownRendererProps } from './MarkdownRendererProps';
 export type { ModalRendererProps } from './ModalRendererProps';

package/build/spec/LayoutComponent.d.ts

@@ -93,6 +93,21 @@ export type HeadingLayout = {
 };
 export type ImageLayout = {
     type: 'image';
+    content?: {
+        accessibilityDescription?: string;
+        /**
+         * @deprecated Please use accessibilityDescription
+         */
+        text?: string;
+        /**
+         * @deprecated Please use uri
+         */
+        url?: string;
+        uri?: string;
+    };
+    /**
+     * @deprecated Please use content.uri
+     */
     url: string;
     /**
      * @deprecated Please use accessibilityDescription
@@ -101,7 +116,7 @@ export type ImageLayout = {
     size?: Size;
     margin?: Margin;
     /**
-     * @experimental accessibilityDescription is experimental and subject to change
+     * @deprecated Please use content.accessibilityDescription
      */
     accessibilityDescription?: string;
 };