@wise/dynamic-flow-types 3.2.0 → 3.3.1

package/build/renderers/ReviewRendererProps.d.ts

@@ -1,4 +1,6 @@
-import { Margin } from './constants';
+import { AdditionalInfo, InlineAlert, Margin } from './constants';
+import { Icon } from './Icon';
+import { Image } from './Image';
 import { BaseRendererProps } from './RendererProps';
 export type ReviewRendererProps = BaseRendererProps & {
     type: 'review';
@@ -14,6 +16,16 @@ export type ReviewField = {
     value: string;
     rawValue?: string;
     tag?: string;
+    /** @experimental This feature may be changed in the future without notice. */
+    additionalInfo?: AdditionalInfo;
+    /** @experimental This feature may be changed in the future without notice. */
+    inlineAlert?: InlineAlert;
+    /** @experimental This feature may be changed in the future without notice. */
+    callToAction?: ReviewCallToAction;
+    /** @experimental This feature may be changed in the future without notice. */
+    icon?: Icon;
+    /** @experimental This feature may be changed in the future without notice. */
+    image?: Image;
 };
 export type ReviewCallToAction = {
     accessibilityDescription?: string;

package/build/renderers/RootRendererProps.d.ts

@@ -1,6 +1,6 @@
 import { ReactNode } from 'react';
-import { RendererProps } from './RendererProps';
-export type RootRendererProps = {
+import { BaseRendererProps, RendererProps } from './RendererProps';
+export type RootRendererProps = BaseRendererProps & {
     type: 'root';
     uid: string;
     children: ReactNode;

package/build/renderers/constants.d.ts

@@ -2,3 +2,16 @@ export type Align = 'start' | 'center' | 'end';
 export type Autocapitalization = 'none' | 'sentences' | 'words' | 'characters';
 export type Context = 'positive' | 'negative' | 'warning' | 'neutral';
 export type { Margin, Size } from '../next';
+export type AdditionalInfo = {
+    text: string;
+    accessibilityDescription?: string;
+    onClick?: () => void;
+};
+export type InlineAlert = {
+    content: string;
+    context?: Context;
+};
+export type SupportingValues = {
+    value?: string;
+    subvalue?: string;
+};

package/build/renderers/index.d.ts

@@ -1,18 +1,18 @@
-export type { AlertRendererProps, AlertCallToAction } from './AlertRendererProps';
-export type { CheckboxInputRendererProps } from './CheckboxInputRendererProps';
+export type { AlertCallToAction, AlertRendererProps } from './AlertRendererProps';
 export type { BoxRendererProps } from './BoxRendererProps';
 export type { ButtonRendererProps } from './ButtonRendererProps';
+export type { CheckboxInputRendererProps } from './CheckboxInputRendererProps';
 export type { ColumnsRendererProps } from './ColumnsRendererProps';
 export type { CoreContainerRendererProps } from './CoreContainerRendererProps';
 export type { DateInputRendererProps } from './DateInputRendererProps';
-export type { DecisionRendererProps, DecisionOption } from './DecisionRendererProps';
+export type { DecisionOption, DecisionRendererProps } from './DecisionRendererProps';
 export type { DividerRendererProps } from './DividerRendererProps';
+export type { ExternalConfirmationRendererProps } from './ExternalConfirmationRendererProps';
 export type { FormRendererProps } from './FormRendererProps';
-export type { SectionRendererProps } from './SectionRendererProps';
 export type { HeadingRendererProps } from './HeadingRendererProps';
 export type { HiddenRendererProps } from './HiddenRendererProps';
 export type { ImageRendererProps } from './ImageRendererProps';
-export type { InstructionsRendererProps, InstructionItem } from './InstructionsRendererProps';
+export type { InstructionItem, InstructionsRendererProps } from './InstructionsRendererProps';
 export type { IntegerInputRendererProps } from './IntegerInputRendererProps';
 export type { ListRendererProps } from './ListRendererProps';
 export type { LoadingIndicatorRendererProps } from './LoadingIndicatorRendererProps';
@@ -23,17 +23,18 @@ export type { MultiSelectInputRendererProps } from './MultiSelectInputRendererPr
 export type { MultiUploadInputRendererProps } from './MultiUploadInputRendererProps';
 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 { RepeatableItemRendererProps, RepeatableRendererProps } from './RepeatableRendererProps';
+export type { ReviewCallToAction, ReviewField, ReviewRendererProps } 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';
-export type { StepRendererProps, AnalyticsEventDispatcher, LoadingState, } from './StepRendererProps';
+export type { ErrorSearchState, NoResultsSearchState, PendingSearchState, ResultsSearchState, SearchRendererProps, SearchResult, SearchState } from './SearchRendererProps';
+export type { FormSectionRendererProps } from './FormSectionRendererProps';
+export type { SelectInputRendererOption, SelectInputRendererProps } from './SelectInputRendererProps';
+export type { StatusListItem, StatusListItemCallToAction, StatusListItemStatus, StatusListRendererProps } from './StatusListRendererProps';
+export type { AnalyticsEventDispatcher, LoadingState, StepRendererProps } from './StepRendererProps';
 export type { TextInputRendererProps } from './TextInputRendererProps';
 export type { UploadInputRendererProps } from './UploadInputRendererProps';
 export type { ValidationResult } from './BaseInputRendererProps';
 export type { Align, Context, Margin, Size } from './constants';
 export type { Icon } from './Icon';
 export type { Image } from './Image';
-export type { RenderFunction, RendererProps, Renderers, Renderer } from './RendererProps';
+export type { Renderer, RendererProps, Renderers, RenderFunction } from './RendererProps';

package/build/zod/schemas.d.ts

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import type { JsonElement, ReviewLayoutCallToAction, Behavior, AlertLayout, AlertLayoutCallToAction, ListLayout, ListLayoutCallToAction, DecisionLayout, DecisionLayoutOption, StatusListLayout, StatusListLayoutItem, ItemCallToAction, Layout, BoxLayout, ButtonLayout, ColumnsLayout, ModalLayout, ReviewLayout, ModalLayoutContent, ModalResponseBody, Step, Schema, Polling, LinkHandler, AllOfSchema, ArraySchema, BlobSchema, BooleanSchema, ConstSchema, IntegerSchema, NumberSchema, ObjectSchema, OneOfSchema, StringSchema, ArraySchemaList, PersistAsync, ArraySchemaTuple, PollingOnError, ModalBehavior } from '../next';
+import type { JsonElement, AdditionalInfo, Behavior, ReviewLayoutCallToAction, AlertLayout, AlertLayoutCallToAction, ListLayout, ListLayoutCallToAction, ListLayoutItem, DecisionLayout, DecisionLayoutOption, StatusListLayout, StatusListLayoutItem, ItemCallToAction, Layout, BoxLayout, ButtonLayout, ColumnsLayout, ModalLayout, ReviewLayout, ReviewLayoutField, ModalLayoutContent, ModalResponseBody, Step, Schema, Polling, LinkHandler, AllOfSchema, ArraySchema, BlobSchema, BooleanSchema, ConstSchema, IntegerSchema, NumberSchema, ObjectSchema, OneOfSchema, StringSchema, ArraySchemaList, PersistAsync, ArraySchemaTuple, PollingOnError, ModalBehavior } from '../next';
 export declare const imageSchema: z.ZodObject<{
     text: z.ZodOptional<z.ZodString>;
     url: z.ZodOptional<z.ZodString>;
@@ -24,7 +24,27 @@ export declare const iconNamedSchema: z.ZodObject<{
 }, {
     name: string;
 }>;
+export declare const supportingValuesSchema: z.ZodObject<{
+    value: z.ZodOptional<z.ZodString>;
+    subvalue: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    value?: string | undefined;
+    subvalue?: string | undefined;
+}, {
+    value?: string | undefined;
+    subvalue?: string | undefined;
+}>;
 export declare const contextSchema: z.ZodUnion<[z.ZodLiteral<"positive">, z.ZodLiteral<"neutral">, z.ZodLiteral<"warning">, z.ZodLiteral<"negative">, z.ZodLiteral<"success">, z.ZodLiteral<"failure">, z.ZodLiteral<"info">, z.ZodLiteral<"primary">]>;
+export declare const inlineAlertSchema: z.ZodObject<{
+    content: z.ZodString;
+    context: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"positive">, z.ZodLiteral<"neutral">, z.ZodLiteral<"warning">, z.ZodLiteral<"negative">, z.ZodLiteral<"success">, z.ZodLiteral<"failure">, z.ZodLiteral<"info">, z.ZodLiteral<"primary">]>>;
+}, "strip", z.ZodTypeAny, {
+    content: string;
+    context?: "neutral" | "warning" | "positive" | "negative" | "success" | "failure" | "info" | "primary" | undefined;
+}, {
+    content: string;
+    context?: "neutral" | "warning" | "positive" | "negative" | "success" | "failure" | "info" | "primary" | undefined;
+}>;
 export declare const iconTextSchema: z.ZodObject<{
     text: z.ZodString;
 }, "strip", z.ZodTypeAny, {
@@ -136,30 +156,30 @@ export declare const imageLayoutSchema: z.ZodObject<{
     control?: string | undefined;
     text?: string | undefined;
     accessibilityDescription?: string | undefined;
-    size?: "xs" | "sm" | "md" | "lg" | "xl" | undefined;
-    margin?: "xs" | "sm" | "md" | "lg" | "xl" | undefined;
-    align?: "left" | "right" | "center" | undefined;
     content?: {
         url?: string | undefined;
         text?: string | undefined;
         uri?: string | undefined;
         accessibilityDescription?: string | undefined;
     } | undefined;
+    size?: "xs" | "sm" | "md" | "lg" | "xl" | undefined;
+    margin?: "xs" | "sm" | "md" | "lg" | "xl" | undefined;
+    align?: "left" | "right" | "center" | undefined;
 }, {
     type: "image";
     url?: string | undefined;
     control?: string | undefined;
     text?: string | undefined;
     accessibilityDescription?: string | undefined;
-    size?: "xs" | "sm" | "md" | "lg" | "xl" | undefined;
-    margin?: "xs" | "sm" | "md" | "lg" | "xl" | undefined;
-    align?: "left" | "right" | "center" | undefined;
     content?: {
         url?: string | undefined;
         text?: string | undefined;
         uri?: string | undefined;
         accessibilityDescription?: string | undefined;
     } | undefined;
+    size?: "xs" | "sm" | "md" | "lg" | "xl" | undefined;
+    margin?: "xs" | "sm" | "md" | "lg" | "xl" | undefined;
+    align?: "left" | "right" | "center" | undefined;
 }>;
 export declare const statusListLayoutStatusSchema: z.ZodUnion<[z.ZodLiteral<"not-done">, z.ZodLiteral<"pending">, z.ZodLiteral<"done">]>;
 export declare const instructionsLayoutItemSchema: z.ZodObject<{
@@ -666,82 +686,6 @@ export declare const actionSchema: z.ZodObject<{
     data?: JsonElement | undefined;
     skipValidation?: boolean | undefined;
 }>;
-export declare const listLayoutItemSchema: z.ZodObject<{
-    description: z.ZodOptional<z.ZodString>;
-    status: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"warning">, z.ZodLiteral<"neutral">, z.ZodLiteral<"positive">]>>;
-    icon: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
-        name: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        name: string;
-    }, {
-        name: string;
-    }>, z.ZodObject<{
-        text: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        text: string;
-    }, {
-        text: string;
-    }>]>>;
-    image: z.ZodOptional<z.ZodObject<{
-        text: z.ZodOptional<z.ZodString>;
-        url: z.ZodOptional<z.ZodString>;
-        uri: z.ZodOptional<z.ZodString>;
-        accessibilityDescription: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        url?: string | undefined;
-        text?: string | undefined;
-        uri?: string | undefined;
-        accessibilityDescription?: string | undefined;
-    }, {
-        url?: string | undefined;
-        text?: string | undefined;
-        uri?: string | undefined;
-        accessibilityDescription?: string | undefined;
-    }>>;
-    title: z.ZodOptional<z.ZodString>;
-    subtitle: z.ZodOptional<z.ZodString>;
-    value: z.ZodOptional<z.ZodString>;
-    subvalue: z.ZodOptional<z.ZodString>;
-    tag: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    image?: {
-        url?: string | undefined;
-        text?: string | undefined;
-        uri?: string | undefined;
-        accessibilityDescription?: string | undefined;
-    } | undefined;
-    description?: string | undefined;
-    icon?: {
-        name: string;
-    } | {
-        text: string;
-    } | undefined;
-    title?: string | undefined;
-    value?: string | undefined;
-    status?: "neutral" | "warning" | "positive" | undefined;
-    tag?: string | undefined;
-    subtitle?: string | undefined;
-    subvalue?: string | undefined;
-}, {
-    image?: {
-        url?: string | undefined;
-        text?: string | undefined;
-        uri?: string | undefined;
-        accessibilityDescription?: string | undefined;
-    } | undefined;
-    description?: string | undefined;
-    icon?: {
-        name: string;
-    } | {
-        text: string;
-    } | undefined;
-    title?: string | undefined;
-    value?: string | undefined;
-    status?: "neutral" | "warning" | "positive" | undefined;
-    tag?: string | undefined;
-    subtitle?: string | undefined;
-    subvalue?: string | undefined;
-}>;
 export declare const instructionsLayoutSchema: z.ZodObject<{
     type: z.ZodLiteral<"instructions">;
     title: z.ZodOptional<z.ZodString>;
@@ -781,35 +725,6 @@ export declare const instructionsLayoutSchema: z.ZodObject<{
     control?: string | undefined;
     margin?: "xs" | "sm" | "md" | "lg" | "xl" | undefined;
 }>;
-export declare const reviewLayoutFieldSchema: z.ZodObject<{
-    label: z.ZodString;
-    value: z.ZodString;
-    rawValue: z.ZodOptional<z.ZodString>;
-    help: z.ZodOptional<z.ZodObject<{
-        markdown: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        markdown: string;
-    }, {
-        markdown: string;
-    }>>;
-    tag: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    value: string;
-    label: string;
-    help?: {
-        markdown: string;
-    } | undefined;
-    tag?: string | undefined;
-    rawValue?: string | undefined;
-}, {
-    value: string;
-    label: string;
-    help?: {
-        markdown: string;
-    } | undefined;
-    tag?: string | undefined;
-    rawValue?: string | undefined;
-}>;
 export declare const searchResultSearchSchema: z.ZodObject<{
     type: z.ZodLiteral<"search">;
     title: z.ZodString;
@@ -2288,12 +2203,14 @@ export declare const searchResponseBodySchema: z.ZodObject<{
         } | undefined;
     })[];
 }>;
-export declare const reviewLayoutCallToActionSchema: z.ZodSchema<ReviewLayoutCallToAction>;
+export declare const additionalInfoSchema: z.ZodSchema<AdditionalInfo>;
 export declare const behaviorSchema: z.ZodSchema<Behavior>;
+export declare const reviewLayoutCallToActionSchema: z.ZodSchema<ReviewLayoutCallToAction>;
 export declare const alertLayoutSchema: z.ZodSchema<AlertLayout>;
 export declare const alertLayoutCallToActionSchema: z.ZodSchema<AlertLayoutCallToAction>;
 export declare const listLayoutSchema: z.ZodSchema<ListLayout>;
 export declare const listLayoutCallToActionSchema: z.ZodSchema<ListLayoutCallToAction>;
+export declare const listLayoutItemSchema: z.ZodSchema<ListLayoutItem>;
 export declare const decisionLayoutSchema: z.ZodSchema<DecisionLayout>;
 export declare const decisionLayoutOptionSchema: z.ZodSchema<DecisionLayoutOption>;
 export declare const statusListLayoutSchema: z.ZodSchema<StatusListLayout>;
@@ -2305,6 +2222,7 @@ export declare const buttonLayoutSchema: z.ZodSchema<ButtonLayout>;
 export declare const columnsLayoutSchema: z.ZodSchema<ColumnsLayout>;
 export declare const modalLayoutSchema: z.ZodSchema<ModalLayout>;
 export declare const reviewLayoutSchema: z.ZodSchema<ReviewLayout>;
+export declare const reviewLayoutFieldSchema: z.ZodSchema<ReviewLayoutField>;
 export declare const modalLayoutContentSchema: z.ZodSchema<ModalLayoutContent>;
 export declare const modalResponseBodySchema: z.ZodSchema<ModalResponseBody>;
 export declare const stepSchema: z.ZodSchema<Step>;