@wise/dynamic-flow-types 3.1.0 → 3.1.2

package/build/renderers/DateInputRendererProps.d.ts

@@ -1,9 +1,11 @@
 import { BaseInputRendererProps } from './BaseInputRendererProps';
+import { Suggestions } from './Suggestions';
 export type DateInputRendererProps = BaseInputRendererProps & {
     type: 'input-date';
     autoComplete: string;
     maximumDate?: string;
     minimumDate?: string;
+    suggestions?: Suggestions;
     value: string | null;
     onChange: (value: string | null) => void;
 };

package/build/renderers/ImageRendererProps.d.ts

@@ -1,9 +1,10 @@
-import { Margin, Size } from './constants';
+import { Align, Margin, Size } from './constants';
 import { BaseRendererProps } from './RendererProps';
 export type ImageRendererProps = BaseRendererProps & {
     type: 'image';
     control?: string;
     accessibilityDescription?: string;
+    align: Align;
     size: Size;
     margin: Margin;
     uri: string;

package/build/renderers/RendererProps.d.ts

@@ -1,14 +1,13 @@
 import { AlertRendererProps } from './AlertRendererProps';
-import { CheckboxInputRendererProps } from './CheckboxInputRendererProps';
 import { BoxRendererProps } from './BoxRendererProps';
 import { ButtonRendererProps } from './ButtonRendererProps';
+import { CheckboxInputRendererProps } from './CheckboxInputRendererProps';
 import { ColumnsRendererProps } from './ColumnsRendererProps';
 import { CoreContainerRendererProps } from './CoreContainerRendererProps';
 import { DateInputRendererProps } from './DateInputRendererProps';
 import { DecisionRendererProps } from './DecisionRendererProps';
 import { DividerRendererProps } from './DividerRendererProps';
 import { FormRendererProps } from './FormRendererProps';
-import { SectionRendererProps } from './SectionRendererProps';
 import { HeadingRendererProps } from './HeadingRendererProps';
 import { HiddenRendererProps } from './HiddenRendererProps';
 import { ImageRendererProps } from './ImageRendererProps';
@@ -24,13 +23,15 @@ import { NumberInputRendererProps } from './NumberInputRendererProps';
 import { ParagraphRendererProps } from './ParagraphRendererProps';
 import { RepeatableRendererProps } from './RepeatableRendererProps';
 import { ReviewRendererProps } from './ReviewRendererProps';
+import { RootRendererProps } from './RootRendererProps';
 import { SearchRendererProps } from './SearchRendererProps';
+import { SectionRendererProps } from './SectionRendererProps';
 import { SelectInputRendererProps } from './SelectInputRendererProps';
 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 | SearchRendererProps | SectionRendererProps | SelectInputRendererProps | StatusListRendererProps | StepRendererProps | TextInputRendererProps | 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 Renderer<P extends RendererProps> = {
     canRenderType: P['type'];
     canRender?: (props: P) => boolean;
@@ -40,7 +41,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<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<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 BaseRendererProps = {
     uid: string;
     render: RenderFunction;

package/build/renderers/RootRendererProps.d.ts

@@ -0,0 +1,8 @@
+import { ReactNode } from 'react';
+import { RendererProps } from './RendererProps';
+export type RootRendererProps = {
+    type: 'root';
+    uid: string;
+    children: ReactNode;
+    childrenProps: RendererProps[];
+};

package/build/renderers/StepRendererProps.d.ts

@@ -2,13 +2,17 @@ import type { Action, Step } from '../next';
 import type { ReactNode } from 'react';
 import { BaseRendererProps, RendererProps } from './RendererProps';
 export type AnalyticsEventDispatcher = (eventName: string, properties?: Record<string, unknown>) => void;
-export type LoadingState = 'idle' | 'submitting' | 'refreshing';
+export type LoadingState = 'idle' | 'initial' | 'submitting' | 'refreshing';
 /**
  * @experimental Likely to change as we align across platform. Consider this before
  * implementing a cusotm Step Renderer.
  */
 export type StepRendererProps = BaseRendererProps & {
     type: 'step';
+    /**
+     * The step id from the spec Step object.
+     */
+    id: string;
     control?: string;
     back?: {
         title?: string;

package/build/renderers/Suggestions.d.ts

@@ -0,0 +1,13 @@
+import { JsonElement } from '../next';
+import { Icon } from './Icon';
+import { Image } from './Image';
+export type Suggestions = {
+    values: SuggestionValue[];
+};
+export type SuggestionValue = {
+    label: string;
+    value?: JsonElement;
+    icon?: Icon;
+    image?: Image;
+    tag?: string;
+};

package/build/renderers/TextInputRendererProps.d.ts

@@ -1,5 +1,6 @@
 import { BaseInputRendererProps } from './BaseInputRendererProps';
 import { Autocapitalization } from './constants';
+import { Suggestions } from './Suggestions';
 /**
  * Known values for "control" are: 'password' | 'textarea' | 'email' | 'numeric' | 'phone-number'.
  */
@@ -11,5 +12,6 @@ export type TextInputRendererProps = BaseInputRendererProps & {
     value: string | null;
     maxLength?: number;
     minLength?: number;
+    suggestions?: Suggestions;
     onChange: (value: string | null) => void;
 };

package/build/renderers/index.d.ts

@@ -24,6 +24,7 @@ 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 { 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';