@wise/dynamic-flow-types 3.0.0-experimental-8a78888 → 3.0.0-experimental-ffcedb9

package/build/next/index.d.ts

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

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

@@ -29,4 +29,9 @@ export type DecisionLayoutOption = {
     * An image to represent the option.
     */
     image?: ImageLayout;
+    /**
+    * An optional identifier to be used in custom renderers.
+    * @experimental This feature may be changed in the future without notice.
+    */
+    tag?: string;
 };

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

@@ -11,4 +11,9 @@ export type InstructionsLayoutItem = {
     * The semantics of the instruction.
     */
     context: Context;
+    /**
+    * An optional identifier to be used in custom renderers.
+    * @experimental This feature may be changed in the future without notice.
+    */
+    tag?: string;
 };

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

@@ -26,7 +26,7 @@ export type ListLayoutItem = {
     /**
     * A user-facing title.
     */
-    title: string;
+    title?: string;
     /**
     * A user-facing subtitle.
     */
@@ -39,4 +39,9 @@ export type ListLayoutItem = {
     * A user-facing subvalue.
     */
     subvalue?: string;
+    /**
+    * An optional identifier to be used in custom renderers.
+    * @experimental This feature may be changed in the future without notice.
+    */
+    tag?: string;
 };

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

@@ -22,4 +22,9 @@ export type ReviewLayoutField = {
     * Provide additional help information to the user.
     */
     help?: Help;
+    /**
+    * An optional identifier to be used in custom renderers.
+    * @experimental This feature may be changed in the future without notice.
+    */
+    tag?: string;
 };

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

@@ -26,4 +26,9 @@ export type StatusListLayoutItem = {
     * @experimental This feature may be changed in the future without notice.
     */
     callToAction?: ItemCallToAction;
+    /**
+    * An optional identifier to be used in custom renderers.
+    * @experimental This feature may be changed in the future without notice.
+    */
+    tag?: string;
 };

package/build/next/schema/StringSchema.d.ts

@@ -82,6 +82,11 @@ export type StringSchema = {
     */
     autocapitalization?: AutocapitalizationType;
     /**
+    * Whether the device should automatically correct the user's input. It defaults to false.
+    * @experimental This feature may be changed in the future without notice.
+    */
+    autocorrect?: boolean;
+    /**
     * A unique id which can be used to refer to the schema.
     */
     $id?: string;

package/build/next/step/Step.d.ts

@@ -90,4 +90,8 @@ export type Step = {
     * The URL to use to fetch an updated step when the value of a schema marked refreshStepOnChange is updated.
     */
     refreshUrl?: string;
+    /**
+    * Specify a particular control to instruct how the step should be rendered. If the control is unknown, it will be ignored.
+    */
+    control?: string;
 };

package/build/renderers/AlertRendererProps.d.ts

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

package/build/renderers/BaseInputRendererProps.d.ts

@@ -1,14 +1,11 @@
 import { Icon } from './Icon';
 import { Image } from './Image';
-export interface BaseInputRendererProps {
+import { BaseRendererProps } from './RendererProps';
+export interface BaseInputRendererProps extends BaseRendererProps {
     id: string;
     control?: string;
     description?: string;
     disabled: boolean;
-    /**
-     * @deprecated please use the `validationState` property instead
-     */
-    error?: string;
     help?: string;
     placeholder?: string;
     required: boolean;

package/build/renderers/BoxRendererProps.d.ts

@@ -1,10 +1,14 @@
 import { ReactNode } from 'react';
 import { Margin, Size } from './constants';
-export type BoxRendererProps = {
+import { BaseRendererProps, RendererProps } from './RendererProps';
+/**
+ * @experimental Expect RendererProps to change as we align them across platform
+ */
+export type BoxRendererProps = BaseRendererProps & {
     type: 'box';
     control?: string;
-    border: boolean;
     children: ReactNode;
+    childrenProps: RendererProps[];
     margin: Margin;
     width: Size;
 };

package/build/renderers/ButtonRendererProps.d.ts

@@ -1,8 +1,10 @@
 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 = {
+export type ButtonRendererProps = BaseRendererProps & {
     type: 'button';
     control?: string;
     context: Context;

package/build/renderers/CheckboxInputRendererProps.d.ts

@@ -1,4 +1,7 @@
 import { BaseInputRendererProps } from './BaseInputRendererProps';
+/**
+ * @experimental Expect RendererProps to change as we align them across platform
+ */
 export interface CheckboxInputRendererProps extends BaseInputRendererProps {
     type: 'input-checkbox';
     value: boolean;

package/build/renderers/ColumnsRendererProps.d.ts

@@ -1,11 +1,17 @@
 import { ReactNode } from 'react';
 import { Margin } from './constants';
+import { BaseRendererProps, RendererProps } from './RendererProps';
 export type Bias = 'none' | 'start' | 'end';
-export type ColumnsRendererProps = {
+/**
+ * @experimental Expect RendererProps to change as we align them across platform
+ */
+export type ColumnsRendererProps = BaseRendererProps & {
     type: 'columns';
     control?: string;
     bias: Bias;
     margin: Margin;
     startChildren: ReactNode;
+    startChildrenProps: RendererProps[];
     endChildren: ReactNode;
+    endChildrenProps: RendererProps[];
 };

package/build/renderers/CoreContainerRendererProps.d.ts

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

package/build/renderers/DateInputRendererProps.d.ts

@@ -1,4 +1,7 @@
 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

@@ -1,7 +1,11 @@
 import { Icon } from './Icon';
 import { Image } from './Image';
+import { BaseRendererProps } from './RendererProps';
 import { Margin } from './constants';
-export type DecisionRendererProps = {
+/**
+ * @experimental Expect RendererProps to change as we align them across platform
+ */
+export type DecisionRendererProps = BaseRendererProps & {
     type: 'decision';
     control?: string;
     options: DecisionOption[];
@@ -10,10 +14,11 @@ export type DecisionRendererProps = {
 };
 export type DecisionOption = {
     description?: string;
-    disabled?: boolean;
+    disabled: boolean;
     href?: string;
     icon?: Icon;
     image?: Image;
     title: string;
+    tag?: string;
     onClick: () => void;
 };

package/build/renderers/DividerRendererProps.d.ts

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

package/build/renderers/FormRendererProps.d.ts

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

package/build/renderers/HeadingRendererProps.d.ts

@@ -1,8 +1,10 @@
 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 = {
+export type HeadingRendererProps = BaseRendererProps & {
     type: 'heading';
     control?: string;
     align: Align;

package/build/renderers/HiddenRendererProps.d.ts

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

package/build/renderers/Image.d.ts

@@ -1,6 +1,7 @@
 /**
-* Images fetched from URLs.
-*/
+ * @experimental Expect RendererProps to change as we align them across platform
+ * Images fetched from URLs.
+ */
 export type Image = {
     /**
     * @deprecated Please use 'accessibilityDescription' instead

package/build/renderers/ImageRendererProps.d.ts

@@ -1,5 +1,9 @@
 import { Margin, Size } from './constants';
-export type ImageRendererProps = {
+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;
@@ -7,7 +11,7 @@ export type ImageRendererProps = {
     margin: Margin;
     /**
      * The `uri` property, if present should take precedence.
-    */
+     */
     url: string;
     uri?: string;
 };

package/build/renderers/InstructionsRendererProps.d.ts

@@ -1,5 +1,9 @@
 import { Context, Margin } from './constants';
-export type InstructionsRendererProps = {
+import { BaseRendererProps } from './RendererProps';
+/**
+ * @experimental Expect RendererProps to change as we align them across platform
+ */
+export type InstructionsRendererProps = BaseRendererProps & {
     type: 'instructions';
     control?: string;
     items: InstructionItem[];
@@ -9,4 +13,5 @@ export type InstructionsRendererProps = {
 export type InstructionItem = {
     context: Context;
     text: string;
+    tag?: string;
 };

package/build/renderers/IntegerInputRendererProps.d.ts

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

package/build/renderers/ListRendererProps.d.ts

@@ -1,7 +1,11 @@
 import { Icon } from "./Icon";
 import { Image } from "./Image";
+import { BaseRendererProps } from "./RendererProps";
 import { Margin } from "./constants";
-export type ListRendererProps = {
+/**
+ * @experimental Expect RendererProps to change as we align them across platform
+ */
+export type ListRendererProps = BaseRendererProps & {
     type: 'list';
     callToAction?: ListCallToAction;
     control?: string;
@@ -16,6 +20,7 @@ export type ListItem = {
     subtitle?: string;
     value?: string;
     subvalue?: string;
+    tag?: string;
 };
 export type ListCallToAction = ListCallToActionLink | ListCallToActionAction;
 export type ListCallToActionLink = {

package/build/renderers/LoadingIndicatorRendererProps.d.ts

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

package/build/renderers/MarkdownRendererProps.d.ts

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

package/build/renderers/ModalRendererProps.d.ts

@@ -1,10 +1,15 @@
 import { ReactNode } from 'react';
 import { Margin } from './constants';
-export type ModalRendererProps = {
+import { BaseRendererProps, RendererProps } from './RendererProps';
+/**
+ * @experimental Expect RendererProps to change as we align them across platform
+ */
+export type ModalRendererProps = BaseRendererProps & {
     type: 'modal';
     control?: string;
     content: {
-        components: ReactNode;
+        children: ReactNode;
+        childrenProps: RendererProps[];
         title?: string;
     };
     margin: Margin;

package/build/renderers/MultiSelectInputRendererProps.d.ts

@@ -1,9 +1,11 @@
 import { BaseInputRendererProps } from './BaseInputRendererProps';
 import { SelectInputRendererOption } from './SelectInputRendererProps';
+/**
+ * @experimental Expect RendererProps to change as we align them across platform
+ */
 export type MultiSelectInputRendererProps = Omit<BaseInputRendererProps, 'required'> & {
     type: 'input-multi-select';
     autoComplete: string;
-    label?: string;
     description?: string;
     /** @experimental */
     maxItems?: number;

package/build/renderers/MultiUploadInputRendererProps.d.ts

@@ -1,12 +1,17 @@
-import { JsonObject } from '../next';
+import { JsonElement } from '../next';
+import { UploadSource } from '../next/feature/UploadSource';
 import { BaseInputRendererProps, ValidationResult } from './BaseInputRendererProps';
+/**
+ * @experimental Expect RendererProps to change as we align them across platform
+ */
 export type MultiUploadInputRendererProps = BaseInputRendererProps & {
     type: 'input-upload-multi';
-    cameraConfig?: JsonObject;
+    cameraConfig?: JsonElement;
     maxSize?: number;
     minItems?: number;
     maxItems?: number;
     accepts?: string[];
+    source?: UploadSource;
     uploadLabel?: string;
     value: FileWithId[];
     onInsertFile: (index: number, file: File) => Promise<string>;

package/build/renderers/NumberInputRendererProps.d.ts

@@ -1,4 +1,7 @@
 import { BaseInputRendererProps } from './BaseInputRendererProps';
+/**
+ * @experimental Expect RendererProps to change as we align them across platform
+ */
 export type NumberInputRendererProps = BaseInputRendererProps & {
     type: 'input-number';
     value: number | null;

package/build/renderers/ParagraphRendererProps.d.ts

@@ -1,8 +1,10 @@
 import { Align, Margin } from './constants';
+import { BaseRendererProps } from './RendererProps';
 /**
+ * @experimental Expect RendererProps to change as we align them across platform
  * Known values for "control" are: 'copyable'.
  */
-export type ParagraphRendererProps = {
+export type ParagraphRendererProps = BaseRendererProps & {
     type: 'paragraph';
     control?: string;
     align: Align;

package/build/renderers/RendererProps.d.ts

@@ -27,13 +27,27 @@ import { ReviewRendererProps } from './ReviewRendererProps';
 import { SearchRendererProps } from './SearchRendererProps';
 import { SelectInputRendererProps } from './SelectInputRendererProps';
 import { StatusListRendererProps } from './StatusListRendererProps';
-import { StepRendererProps } from './StepRendererProps';
+import { AnalyticsEventDispatcher, LoadingState, StepRendererProps } from './StepRendererProps';
 import { TextInputRendererProps } from './TextInputRendererProps';
 import { UploadInputRendererProps } from './UploadInputRendererProps';
+/**
+ * @experimental Expect RendererProps to change as we align them across platform
+ */
 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 Renderer<P extends RendererProps> = {
     canRenderType: P['type'];
     canRender?: (props: P) => boolean;
-    render: (props: P) => JSX.Element;
+    render: (props: P) => JSX.Element | null;
 };
+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 BaseRendererProps = {
+    uid: string;
+    render: RenderFunction;
+    httpClient: typeof fetch;
+    trackEvent: AnalyticsEventDispatcher;
+    stepLoadingState: LoadingState;
+};

package/build/renderers/RepeatableRendererProps.d.ts

@@ -2,18 +2,20 @@ import { ReactNode } from 'react';
 import { Icon } from './Icon';
 import { Image } from './Image';
 import { ValidationResult } from './BaseInputRendererProps';
-export type RepeatableRendererProps = {
+import { BaseRendererProps, RendererProps } from './RendererProps';
+/**
+ * @experimental Expect RendererProps to change as we align them across platform
+ */
+export type RepeatableRendererProps = BaseRendererProps & {
     type: 'repeatable';
     control?: string;
     addItemTitle: string;
     description?: string;
-    children: ReactNode[];
+    children: ReactNode;
+    childrenProps: RendererProps[];
     editableItem: ReactNode;
+    editableItemProps: RendererProps | null;
     editItemTitle: string;
-    /**
-     * @deprecated please use the `validationState` property instead
-     */
-    error?: string;
     /** @experimental */
     validationState: ValidationResult | undefined;
     items: RepeatableItemRendererProps[];

package/build/renderers/ReviewRendererProps.d.ts

@@ -1,5 +1,9 @@
 import { Margin } from './constants';
-export type ReviewRendererProps = {
+import { BaseRendererProps } from './RendererProps';
+/**
+ * @experimental Expect RendererProps to change as we align them across platform
+ */
+export type ReviewRendererProps = BaseRendererProps & {
     type: 'review';
     control?: string;
     fields: ReviewField[];
@@ -12,6 +16,7 @@ export type ReviewField = {
     label: string;
     value: string;
     rawValue?: string;
+    tag?: string;
 };
 export type ReviewCallToAction = {
     accessibilityDescription?: string;

package/build/renderers/SearchRendererProps.d.ts

@@ -1,6 +1,10 @@
 import type { ImageLayout, SearchResult as SearchResultSpec } from '../next';
 import { Margin } from './constants';
-export type SearchRendererProps = {
+import { BaseRendererProps } from './RendererProps';
+/**
+ * @experimental Expect RendererProps to change as we align them across platform
+ */
+export type SearchRendererProps = BaseRendererProps & {
     type: 'search';
     control?: string;
     id: string;

package/build/renderers/SectionRendererProps.d.ts

@@ -1,13 +1,18 @@
 import { ReactNode } from 'react';
 import { Icon } from './Icon';
 import { Image } from './Image';
-export type SectionRendererProps = {
+import { BaseRendererProps, RendererProps } from './RendererProps';
+/**
+ * @experimental Expect RendererProps to change as we align them across platform
+ */
+export type SectionRendererProps = BaseRendererProps & {
     type: 'section';
     control?: string;
     title?: string;
     description?: string;
     help?: string;
     children: ReactNode;
+    childrenProps: RendererProps[];
     icon?: Icon;
     image?: Image;
 };

package/build/renderers/SelectInputRendererProps.d.ts

@@ -2,10 +2,15 @@ import { ReactNode } from 'react';
 import { BaseInputRendererProps } from './BaseInputRendererProps';
 import { Icon } from './Icon';
 import { Image } from './Image';
+import { RendererProps } from './RendererProps';
+/**
+ * @experimental Expect RendererProps to change as we align them across platform
+ */
 export type SelectInputRendererProps = BaseInputRendererProps & {
     type: 'input-select';
     autoComplete: string;
     children: ReactNode;
+    childrenProps: RendererProps | null;
     options: SelectInputRendererOption[];
     selectedIndex: number | null;
     onSelect: (index: number | null) => void;
@@ -15,6 +20,6 @@ export type SelectInputRendererOption = {
     disabled: boolean;
     icon?: Icon;
     image?: Image;
-    keywords?: string[];
+    keywords: string[];
     title: string;
 };

package/build/renderers/StatusListRendererProps.d.ts

@@ -1,6 +1,10 @@
 import { Icon } from './Icon';
+import { BaseRendererProps } from './RendererProps';
 import { Margin } from './constants';
-export type StatusListRendererProps = {
+/**
+ * @experimental Expect RendererProps to change as we align them across platform
+ */
+export type StatusListRendererProps = BaseRendererProps & {
     type: 'status-list';
     control?: string;
     items: StatusListItem[];
@@ -13,6 +17,7 @@ export type StatusListItem = {
     status?: 'done' | 'not-done' | 'pending';
     title: string;
     callToAction?: StatusListItemCallToAction;
+    tag?: string;
 };
 export type StatusListItemCallToAction = {
     accessibilityDescription?: string;