@wise/dynamic-flow-types 3.0.0-experimental-af37aae → 3.0.0-experimental-9cbdd3f

package/build/renderers/LoadingIndicatorRendererProps.d.ts

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

package/build/renderers/MarkdownRendererProps.d.ts

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

package/build/renderers/ModalRendererProps.d.ts

@@ -1,15 +1,12 @@
 import { ReactNode } from 'react';
 import { Margin } from './constants';
 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: {
         children: ReactNode;
-        childrenProps: RendererProps[];
+        childrenProps: readonly RendererProps[];
         title?: string;
     };
     margin: Margin;

package/build/renderers/MultiSelectInputRendererProps.d.ts

@@ -1,17 +1,12 @@
 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;
     description?: string;
-    /** @experimental */
     maxItems?: number;
-    /** @experimental */
     minItems?: number;
-    selectedIndices: number[];
-    options: SelectInputRendererOption[];
+    selectedIndices: readonly number[];
+    options: readonly SelectInputRendererOption[];
     onSelect: (indices: number[]) => void;
 };

package/build/renderers/MultiUploadInputRendererProps.d.ts

@@ -1,26 +1,22 @@
 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?: JsonElement;
     maxSize?: number;
     minItems?: number;
     maxItems?: number;
-    accepts?: string[];
+    accepts?: readonly string[];
     source?: UploadSource;
     uploadLabel?: string;
-    value: FileWithId[];
+    value: readonly FileWithId[];
     onInsertFile: (index: number, file: File) => Promise<string>;
     onRemoveFile: (index: number) => Promise<void>;
 };
 type FileWithId = {
     id: string;
     file: File;
-    /** @experimental */
     validationState?: ValidationResult;
 };
 export {};

package/build/renderers/NumberInputRendererProps.d.ts

@@ -1,13 +1,8 @@
 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;
-    /** @experimental */
     maximum?: number;
-    /** @experimental */
     minimum?: number;
     onChange: (value: number | null) => void;
 };

package/build/renderers/ParagraphRendererProps.d.ts

@@ -1,7 +1,6 @@
 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 = BaseRendererProps & {

package/build/renderers/RendererProps.d.ts

@@ -30,9 +30,6 @@ import { StatusListRendererProps } from './StatusListRendererProps';
 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'];

package/build/renderers/RepeatableRendererProps.d.ts

@@ -3,26 +3,20 @@ import { Icon } from './Icon';
 import { Image } from './Image';
 import { ValidationResult } from './BaseInputRendererProps';
 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;
-    childrenProps: RendererProps[];
+    childrenProps: readonly RendererProps[];
     editableItem: ReactNode;
     editableItemProps: RendererProps | null;
     editItemTitle: string;
-    /** @experimental */
     validationState: ValidationResult | undefined;
     items: RepeatableItemRendererProps[];
     title: string;
-    /** @experimental */
     maxItems?: number;
-    /** @experimental */
     minItems?: number;
     icon?: Icon;
     image?: Image;

package/build/renderers/ReviewRendererProps.d.ts

@@ -1,12 +1,9 @@
 import { Margin } from './constants';
 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[];
+    fields: readonly ReviewField[];
     margin: Margin;
     title?: string;
     callToAction?: ReviewCallToAction;

package/build/renderers/SearchRendererProps.d.ts

@@ -1,9 +1,7 @@
-import type { ImageLayout, SearchResult as SearchResultSpec } from '../next';
+import type { SearchResult as SearchResultSpec } from '../next';
 import { Margin } from './constants';
+import { Image } from './Image';
 import { BaseRendererProps } from './RendererProps';
-/**
- * @experimental Expect RendererProps to change as we align them across platform
- */
 export type SearchRendererProps = BaseRendererProps & {
     type: 'search';
     control?: string;
@@ -29,12 +27,10 @@ export type ErrorSearchState = {
 };
 export type ResultsSearchState = {
     type: 'results';
-    results: SearchResult[];
+    results: readonly SearchResult[];
 };
 export type SearchResult = Pick<SearchResultSpec, 'description' | 'icon' | 'title' | 'type'> & {
     id?: string;
-    image?: ImageLayout & {
-        uri?: string;
-    };
+    image?: Image;
     onClick: () => void;
 };

package/build/renderers/SectionRendererProps.d.ts

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

package/build/renderers/SelectInputRendererProps.d.ts

@@ -3,15 +3,12 @@ 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[];
+    options: readonly SelectInputRendererOption[];
     selectedIndex: number | null;
     onSelect: (index: number | null) => void;
 };
@@ -20,6 +17,6 @@ export type SelectInputRendererOption = {
     disabled: boolean;
     icon?: Icon;
     image?: Image;
-    keywords: string[];
+    keywords: readonly string[];
     title: string;
 };

package/build/renderers/StatusListRendererProps.d.ts

@@ -1,13 +1,10 @@
 import { Icon } from './Icon';
 import { BaseRendererProps } from './RendererProps';
 import { Margin } from './constants';
-/**
- * @experimental Expect RendererProps to change as we align them across platform
- */
 export type StatusListRendererProps = BaseRendererProps & {
     type: 'status-list';
     control?: string;
-    items: StatusListItem[];
+    items: readonly StatusListItem[];
     margin: Margin;
     title?: string;
 };

package/build/renderers/StepRendererProps.d.ts

@@ -1,9 +1,11 @@
+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';
 /**
- * @experimental Expect RendererProps to change as we align them across platform
+ * @experimental Likely to change as we align across platform. Consider this before
+ * implementing a cusotm Step Renderer.
  */
 export type StepRendererProps = BaseRendererProps & {
     type: 'step';
@@ -22,6 +24,16 @@ export type StepRendererProps = BaseRendererProps & {
      */
     loadingState: LoadingState;
     title?: string;
+    /**
+     * @experimental Please do not use this property. It is only here to support a legacy camera step.
+     * @deprecated Please use childrenProps instead.
+     */
+    step?: Step;
+    /**
+     * @experimental Please do not use this function. Calling onAction from a step renderer completely bypasses the core logic and may result in unexpected behavior. It is only here to support a legacy camera step.
+     * @deprecated Please use childrenProps instead.
+     */
+    onAction?: (action: Action) => void | Promise<void>;
     children: ReactNode;
-    childrenProps: RendererProps[];
+    childrenProps: readonly RendererProps[];
 };

package/build/renderers/TextInputRendererProps.d.ts

@@ -1,7 +1,6 @@
 import { BaseInputRendererProps } from './BaseInputRendererProps';
 import { Autocapitalization } from './constants';
 /**
- * @experimental Expect RendererProps to change as we align them across platform
  * Known values for "control" are: 'password' | 'textarea' | 'email' | 'numeric' | 'phone-number'.
  */
 export type TextInputRendererProps = BaseInputRendererProps & {
@@ -10,9 +9,7 @@ export type TextInputRendererProps = BaseInputRendererProps & {
     autoCapitalize?: Autocapitalization;
     displayFormat?: string;
     value: string | null;
-    /** @experimental */
     maxLength?: number;
-    /** @experimental */
     minLength?: number;
     onChange: (value: string | null) => void;
 };

package/build/renderers/UploadInputRendererProps.d.ts

@@ -1,14 +1,11 @@
 import { JsonElement } from '../next';
 import { UploadSource } from '../next/feature/UploadSource';
 import { BaseInputRendererProps } from './BaseInputRendererProps';
-/**
- * @experimental Expect RendererProps to change as we align them across platform
- */
 export type UploadInputRendererProps = BaseInputRendererProps & {
     type: 'input-upload';
     cameraConfig?: JsonElement;
     maxSize?: number;
-    accepts?: string[];
+    accepts?: readonly string[];
     source?: UploadSource;
     value: File | null;
     onUpload: (file: File | null) => Promise<void>;