@wise/dynamic-flow-types 3.17.0 → 3.19.0

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

@@ -13,6 +13,8 @@ import type { Help } from '../feature/Help';
 import type { Suggestions } from '../feature/Suggestions';
 import type { Behavior } from '../feature/Behavior';
 import type { Media } from '../misc/media/Media';
+import type { SupportingValues } from '../misc/SupportingValues';
+import type { InlineAlert } from '../misc/InlineAlert';
 /**
 * Represents a string value in the submission.
 * This could be used for standard text input, or a format can be provided
@@ -232,4 +234,17 @@ export type StringSchema = {
     * An optional list of identifiers used to configure renderers.
     */
     tags?: string[];
+    /**
+    * Additional information to be displayed to the user.
+    */
+    additionalText?: string;
+    /**
+    * An object containing two strings representing two user-facing values.
+    * One being clearly more important than the other.
+    */
+    supportingValues?: SupportingValues;
+    /**
+    * An alert that will be displayed inline with the item.
+    */
+    inlineAlert?: InlineAlert;
 };

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

@@ -88,7 +88,7 @@ export type Step = {
     */
     navigation?: Navigation;
     /**
-    * The URL to use to fetch an updated step when the value of a schema marked refreshStepOnChange is updated.
+    * The URL to use to fetch an updated step when a [com.wise.dynamicflow.feature.RefreshBehavior] is triggered, or when the value of a schema marked 'refreshStepOnChange' is updated.
     */
     refreshUrl?: string;
     /**

package/build/renderers/CheckboxInputRendererProps.d.ts

@@ -1,6 +1,10 @@
+import { InlineAlert, SupportingValues } from './constants';
 import { BaseInputRendererProps } from './BaseInputRendererProps';
 export type CheckboxInputRendererProps = BaseInputRendererProps & {
     type: 'input-checkbox';
+    additionalText?: string;
+    inlineAlert?: InlineAlert;
+    supportingValues?: SupportingValues;
     value: boolean;
     onChange: (value: boolean) => void;
 };

package/build/renderers/DecisionRendererProps.d.ts

@@ -23,11 +23,8 @@ export type DecisionOption = {
     tag?: string;
     tags?: string[];
     title: 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/FormSectionRendererProps.d.ts

@@ -1,8 +1,8 @@
-import { ReactNode } from 'react';
-import { Icon } from './Icon';
-import { Image } from './Image';
-import { BaseRendererProps, RendererProps } from './RendererProps';
-import { Media } from './Media';
+import type { ReactNode } from 'react';
+import type { Icon } from './Icon';
+import type { Image } from './Image';
+import type { BaseRendererProps, RendererProps } from './RendererProps';
+import type { Media } from './Media';
 export type FormSectionRendererProps = BaseRendererProps & {
     type: 'form-section';
     control?: string;

package/build/renderers/MarkdownRendererProps.d.ts

@@ -1,4 +1,4 @@
-import { Align, Margin } from './constants';
+import { Align, Margin, Size } from './constants';
 import { BaseRendererProps } from './RendererProps';
 export type MarkdownRendererProps = BaseRendererProps & {
     type: 'markdown';
@@ -6,4 +6,5 @@ export type MarkdownRendererProps = BaseRendererProps & {
     align: Align;
     margin: Margin;
     content: string;
+    size: Size;
 };

package/build/renderers/MoneyInputRendererProps.d.ts

@@ -0,0 +1,29 @@
+import { Media, ValidationResult } from '.';
+import { JsonElement } from '../next';
+import type { BaseRendererProps } from './RendererProps';
+export type MoneyInputRendererProps = BaseRendererProps & {
+    type: 'money-input';
+    control?: string;
+    title?: string;
+    description?: string;
+    help?: string;
+    amountValue: string | null;
+    selectedCurrencyIndex: number | null;
+    onAmountChange: (value: string) => void;
+    onCurrencyChange: (index: number | null) => void;
+    currencies: CurrencyOption[];
+    validationState?: ValidationResult;
+    placeholder?: string;
+    disabled: boolean;
+    tags?: string[];
+};
+type CurrencyOption = {
+    analyticsId?: string;
+    currencyCode: JsonElement;
+    title?: string;
+    description?: string;
+    keywords?: string[];
+    media?: Media;
+    tags?: string[];
+};
+export {};

package/build/renderers/ParagraphRendererProps.d.ts

@@ -1,4 +1,4 @@
-import { Align, Margin } from './constants';
+import { Align, Margin, Size } from './constants';
 import { BaseRendererProps } from './RendererProps';
 /**
  * Known values for "control" are: 'copyable'.
@@ -9,4 +9,5 @@ export type ParagraphRendererProps = BaseRendererProps & {
     align: Align;
     margin: Margin;
     text: string;
+    size: Size;
 };

package/build/renderers/RendererProps.d.ts

@@ -20,6 +20,7 @@ import type { LoadingIndicatorRendererProps } from './LoadingIndicatorRendererPr
 import type { MarkdownRendererProps } from './MarkdownRendererProps';
 import type { ModalLayoutRendererProps } from './ModalLayoutRendererProps';
 import type { ModalRendererProps } from './ModalRendererProps';
+import type { MoneyInputRendererProps } from './MoneyInputRendererProps';
 import type { MultiSelectInputRendererProps } from './MultiSelectInputRendererProps';
 import type { MultiUploadInputRendererProps } from './MultiUploadInputRendererProps';
 import type { NumberInputRendererProps } from './NumberInputRendererProps';
@@ -36,7 +37,7 @@ import type { AnalyticsEventDispatcher, LoadingState, StepRendererProps } from '
 import { TabsRendererProps } from './TabsRendererProps';
 import type { TextInputRendererProps } from './TextInputRendererProps';
 import type { UploadInputRendererProps } from './UploadInputRendererProps';
-export type RendererProps = AlertRendererProps | CheckboxInputRendererProps | BoxRendererProps | ButtonRendererProps | ColumnsRendererProps | CoreContainerRendererProps | DateInputRendererProps | DecisionRendererProps | DividerRendererProps | ExternalConfirmationRendererProps | FormRendererProps | HeadingRendererProps | HiddenRendererProps | ImageRendererProps | InstructionsRendererProps | IntegerInputRendererProps | ListRendererProps | LoadingIndicatorRendererProps | MarkdownRendererProps | ModalLayoutRendererProps | ModalRendererProps | MultiSelectInputRendererProps | MultiUploadInputRendererProps | NumberInputRendererProps | ParagraphRendererProps | ProgressRendererProps | RepeatableRendererProps | ReviewRendererProps | RootRendererProps | SearchRendererProps | FormSectionRendererProps | SelectInputRendererProps | SectionRendererProps | StatusListRendererProps | StepRendererProps | TabsRendererProps | TextInputRendererProps | UploadInputRendererProps;
+export type RendererProps = AlertRendererProps | CheckboxInputRendererProps | BoxRendererProps | ButtonRendererProps | ColumnsRendererProps | CoreContainerRendererProps | DateInputRendererProps | DecisionRendererProps | DividerRendererProps | ExternalConfirmationRendererProps | FormRendererProps | HeadingRendererProps | HiddenRendererProps | ImageRendererProps | InstructionsRendererProps | IntegerInputRendererProps | ListRendererProps | LoadingIndicatorRendererProps | MarkdownRendererProps | ModalLayoutRendererProps | ModalRendererProps | MoneyInputRendererProps | MultiSelectInputRendererProps | MultiUploadInputRendererProps | NumberInputRendererProps | ParagraphRendererProps | ProgressRendererProps | RepeatableRendererProps | ReviewRendererProps | RootRendererProps | SearchRendererProps | FormSectionRendererProps | SelectInputRendererProps | SectionRendererProps | StatusListRendererProps | StepRendererProps | TabsRendererProps | TextInputRendererProps | UploadInputRendererProps;
 export type Renderer<P extends RendererProps> = {
     canRenderType: P['type'];
     canRender?: (props: P) => boolean;
@@ -46,7 +47,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<ExternalConfirmationRendererProps> | Renderer<FormRendererProps> | Renderer<HeadingRendererProps> | Renderer<InstructionsRendererProps> | Renderer<ListRendererProps> | Renderer<LoadingIndicatorRendererProps> | Renderer<MarkdownRendererProps> | Renderer<ImageRendererProps> | Renderer<ModalLayoutRendererProps> | Renderer<ModalRendererProps> | Renderer<ParagraphRendererProps> | Renderer<ProgressRendererProps> | Renderer<ReviewRendererProps> | Renderer<SearchRendererProps> | Renderer<StatusListRendererProps> | Renderer<CheckboxInputRendererProps> | Renderer<ButtonRendererProps> | Renderer<DateInputRendererProps> | Renderer<HiddenRendererProps> | Renderer<IntegerInputRendererProps> | Renderer<NumberInputRendererProps> | Renderer<RepeatableRendererProps> | Renderer<RootRendererProps> | Renderer<FormSectionRendererProps> | Renderer<SelectInputRendererProps> | Renderer<SectionRendererProps> | Renderer<MultiSelectInputRendererProps> | Renderer<TabsRendererProps> | 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<ModalLayoutRendererProps> | Renderer<ModalRendererProps> | Renderer<ParagraphRendererProps> | Renderer<ProgressRendererProps> | Renderer<ReviewRendererProps> | Renderer<SearchRendererProps> | Renderer<StatusListRendererProps> | Renderer<CheckboxInputRendererProps> | Renderer<ButtonRendererProps> | Renderer<DateInputRendererProps> | Renderer<HiddenRendererProps> | Renderer<IntegerInputRendererProps> | Renderer<MoneyInputRendererProps> | Renderer<NumberInputRendererProps> | Renderer<RepeatableRendererProps> | Renderer<RootRendererProps> | Renderer<FormSectionRendererProps> | Renderer<SelectInputRendererProps> | Renderer<SectionRendererProps> | Renderer<MultiSelectInputRendererProps> | Renderer<TabsRendererProps> | Renderer<TextInputRendererProps> | Renderer<UploadInputRendererProps> | Renderer<MultiUploadInputRendererProps>)[];
 export type BaseRendererProps = {
     uid: string;
     analyticsId?: string;

package/build/renderers/SelectInputRendererProps.d.ts

@@ -4,6 +4,7 @@ import { Icon } from './Icon';
 import { Image } from './Image';
 import { RendererProps } from './RendererProps';
 import { Media } from '.';
+import { InlineAlert, SupportingValues } from './constants';
 export type SelectInputRendererProps = BaseInputRendererProps & {
     type: 'input-select';
     autoComplete: string;
@@ -14,12 +15,16 @@ export type SelectInputRendererProps = BaseInputRendererProps & {
     onSelect: (index: number | null) => void;
 };
 export type SelectInputRendererOption = {
+    additionalText?: string;
+    analyticsId?: string;
     description?: string;
     disabled: boolean;
     icon?: Icon;
     image?: Image;
-    media?: Media;
+    inlineAlert?: InlineAlert;
     keywords: string[];
-    title: string;
+    media?: Media;
+    supportingValues?: SupportingValues;
     tags?: string[];
+    title: string;
 };

package/build/renderers/index.d.ts

@@ -21,6 +21,7 @@ export type { LoadingIndicatorRendererProps } from './LoadingIndicatorRendererPr
 export type { MarkdownRendererProps } from './MarkdownRendererProps';
 export type { ModalLayoutRendererProps } from './ModalLayoutRendererProps';
 export type { ModalRendererProps } from './ModalRendererProps';
+export type { MoneyInputRendererProps } from './MoneyInputRendererProps';
 export type { MultiSelectInputRendererProps } from './MultiSelectInputRendererProps';
 export type { MultiUploadInputRendererProps } from './MultiUploadInputRendererProps';
 export type { NumberInputRendererProps } from './NumberInputRendererProps';

package/build/zod/schemas.d.ts

@@ -216,11 +216,13 @@ export declare const paragraphLayoutSchema: z.ZodObject<{
     margin: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"xs">, z.ZodLiteral<"sm">, z.ZodLiteral<"md">, z.ZodLiteral<"lg">, z.ZodLiteral<"xl">]>>;
     analyticsId: z.ZodOptional<z.ZodString>;
     tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    size: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"xs">, z.ZodLiteral<"sm">, z.ZodLiteral<"md">, z.ZodLiteral<"lg">, z.ZodLiteral<"xl">]>>;
 }, "strip", z.ZodTypeAny, {
     type: "paragraph";
     text: string;
     analyticsId?: string | undefined;
     control?: string | undefined;
+    size?: "xs" | "sm" | "md" | "lg" | "xl" | undefined;
     margin?: "xs" | "sm" | "md" | "lg" | "xl" | undefined;
     tags?: string[] | undefined;
     align?: "left" | "right" | "center" | undefined;
@@ -229,6 +231,7 @@ export declare const paragraphLayoutSchema: z.ZodObject<{
     text: string;
     analyticsId?: string | undefined;
     control?: string | undefined;
+    size?: "xs" | "sm" | "md" | "lg" | "xl" | undefined;
     margin?: "xs" | "sm" | "md" | "lg" | "xl" | undefined;
     tags?: string[] | undefined;
     align?: "left" | "right" | "center" | undefined;
@@ -541,11 +544,13 @@ export declare const markdownLayoutSchema: z.ZodObject<{
     margin: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"xs">, z.ZodLiteral<"sm">, z.ZodLiteral<"md">, z.ZodLiteral<"lg">, z.ZodLiteral<"xl">]>>;
     analyticsId: z.ZodOptional<z.ZodString>;
     tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    size: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"xs">, z.ZodLiteral<"sm">, z.ZodLiteral<"md">, z.ZodLiteral<"lg">, z.ZodLiteral<"xl">]>>;
 }, "strip", z.ZodTypeAny, {
     type: "markdown";
     content: string;
     analyticsId?: string | undefined;
     control?: string | undefined;
+    size?: "xs" | "sm" | "md" | "lg" | "xl" | undefined;
     margin?: "xs" | "sm" | "md" | "lg" | "xl" | undefined;
     tags?: string[] | undefined;
     align?: "left" | "right" | "center" | undefined;
@@ -554,6 +559,7 @@ export declare const markdownLayoutSchema: z.ZodObject<{
     content: string;
     analyticsId?: string | undefined;
     control?: string | undefined;
+    size?: "xs" | "sm" | "md" | "lg" | "xl" | undefined;
     margin?: "xs" | "sm" | "md" | "lg" | "xl" | undefined;
     tags?: string[] | undefined;
     align?: "left" | "right" | "center" | undefined;