@wise/dynamic-flow-client 5.2.0 → 5.4.0

package/build/types/domain/components/FormattedValueComponent.d.ts

@@ -0,0 +1,16 @@
+import { JsonElement } from '@wise/dynamic-flow-types/spec';
+import { SchemaOnChange } from '../features/schema-on-change/getSchemaOnChange';
+import type { BaseSchemaComponent, InlineAlert, LocalValue, RepeatableSummary, UpdateComponent } from '../types';
+export type FormattedValueComponent = BaseSchemaComponent<JsonElement> & {
+    type: 'formatted-value';
+    kind: 'input';
+    format: string;
+    alert?: InlineAlert;
+    errors: string[] | undefined;
+    value: JsonElement;
+    onChange: (newValue: JsonElement) => void;
+};
+export declare const createFormattedValueComponent: (props: Pick<FormattedValueComponent, "uid" | "schemaId" | "analyticsId" | "alert" | "control" | "description" | "errors" | "format" | "help" | "hidden" | "media" | "title" | "tags" | "value"> & {
+    summariser: (value: LocalValue | null) => RepeatableSummary;
+    schemaOnChange: SchemaOnChange | undefined;
+}, updateComponent: UpdateComponent) => FormattedValueComponent;

package/build/types/domain/components/RootDomainComponent.d.ts

@@ -3,13 +3,19 @@ import { AnalyticsEventDispatcher } from '../features/events';
 import { BaseComponent, DomainComponent, LoadingState, LocalValue, SchemaComponent, ScrollToTop, UpdateComponent } from '../types';
 import { ModalComponent } from './ModalComponent';
 import { StepDomainComponent } from './step/StepDomainComponent';
+import { SubflowDomainComponent } from './SubflowDomainComponent';
+import { RequestCache } from '../prefetching/request-cache';
 export type RootDomainComponent = BaseComponent & {
     type: 'root';
     kind: 'step';
     stepComponent: StepDomainComponent | null;
     stepStack: StepDomainComponent[];
-    isNativeBackEnabled: boolean;
-    isFlowCancellable: boolean;
+    subflow: SubflowDomainComponent | null;
+    backConfig: {
+        isNativeBackEnabled: boolean;
+        isFlowCancellable: boolean;
+    };
+    requestCache: RequestCache;
     canPerformBack: () => boolean;
     dismissAllModals: () => void;
     dismissModal: () => void;
@@ -33,8 +39,10 @@ export type RootDomainComponent = BaseComponent & {
     clearStack: () => void;
     navigateBack: () => void;
     getRefreshUrl: () => string | null;
+    addSubflow: (subflow: SubflowDomainComponent) => void;
+    closeSubflow: () => void;
 };
 export declare const createRootDomainComponent: (updateComponent: UpdateComponent, scrollToTop: ScrollToTop, backConfig: {
     isNativeBackEnabled: boolean;
     isFlowCancellable: boolean;
-}) => RootDomainComponent;
+}, requestCache: RequestCache) => RootDomainComponent;

package/build/types/domain/components/SelectInputComponent.d.ts

@@ -1,9 +1,8 @@
 import type { Model } from '@wise/dynamic-flow-types/spec';
 import type { AnalyticsEventDispatcher } from '../features/events';
 import type { SchemaOnChange } from '../features/schema-on-change/getSchemaOnChange';
-import type { InlineAlert, SupportingValues } from '../types';
+import type { InlineAlert, SupportingValues, BaseInputComponent, LocalValue, Media, OnValueChange, RepeatableSummary, SchemaComponent, UpdateComponent } from '../types';
 import type { IsInvalidCheck } from '../features/validation/value-checks';
-import type { BaseInputComponent, LocalValue, Media, OnValueChange, RepeatableSummary, SchemaComponent, UpdateComponent } from '../types';
 export type SelectInputComponent = BaseInputComponent<LocalValue | null> & {
     type: 'select';
     kind: 'input';

package/build/types/domain/components/SubflowDomainComponent.d.ts

@@ -0,0 +1,16 @@
+import { JsonElement, Request } from '@wise/dynamic-flow-types/spec';
+import { BaseComponent, UpdateComponent, Presentation } from '../types';
+import { AnalyticsEventDispatcher } from '../features/events';
+import { RequestCache } from '../prefetching/request-cache';
+export type SubflowDomainComponent = BaseComponent & {
+    kind: 'layout';
+    type: 'subflow';
+    presentation: Presentation;
+    initialRequest: Request;
+    requestCache: RequestCache;
+    onCancellation: () => void;
+    onCompletion: (result: JsonElement) => void;
+    onEvent: AnalyticsEventDispatcher<string>;
+    onError: (error: unknown, status?: number) => void;
+};
+export declare const createSubflowDomainComponent: (subflowProps: Pick<SubflowDomainComponent, "initialRequest" | "presentation" | "requestCache" | "onCompletion" | "onCancellation" | "onError" | "onEvent">, updateComponent: UpdateComponent) => SubflowDomainComponent;

package/build/types/domain/components/step/StepDomainComponent.d.ts

@@ -1,7 +1,7 @@
 import type { BaseComponent, DomainComponent, LayoutComponent, LoadingState, LocalValue, OnBehavior, SchemaComponent, UpdateComponent } from '../../types';
 import type { NavigationStackBehavior, Step } from '@wise/dynamic-flow-types/spec';
 import { Model } from '@wise/dynamic-flow-types/spec';
-import { SubmissionRequestCache } from '../../prefetching/request-cache';
+import { RequestCache } from '../../prefetching/request-cache';
 import type { AnalyticsEventDispatcher } from '../../features/events';
 import type { StepPolling } from '../../features/polling/getStepPolling';
 import { StepRefreshAfter } from '../../features/refreshAfter/getStepRefreshAfter';
@@ -27,7 +27,7 @@ export type StepDomainComponent = BaseComponent & {
     title?: string;
     modals: ModalComponent[];
     tags?: string[];
-    submissionRequestsCache: SubmissionRequestCache;
+    requestCache: RequestCache;
     dismissModal: () => void;
     dismissAllModals: () => void;
     showModal: (modal: ModalComponent) => void;
@@ -47,7 +47,7 @@ export type BackNavigation = {
     title?: string;
     onClick: () => void;
 };
-export declare const createStepComponent: (stepProps: Pick<StepDomainComponent, "uid" | "back" | "toolbar" | "layoutComponents" | "schemaComponents" | "footerComponents" | "control" | "description" | "error" | "externalConfirmation" | "loadingState" | "stackBehavior" | "etag" | "step" | "title" | "tags" | "submissionRequestsCache" | "trackEvent" | "onBehavior"> & {
+export declare const createStepComponent: (stepProps: Pick<StepDomainComponent, "uid" | "back" | "toolbar" | "layoutComponents" | "schemaComponents" | "footerComponents" | "control" | "description" | "error" | "externalConfirmation" | "loadingState" | "stackBehavior" | "etag" | "step" | "title" | "tags" | "requestCache" | "trackEvent" | "onBehavior"> & {
     stepPolling?: StepPolling;
     stepRefreshAfter?: StepRefreshAfter;
     updateComponent: UpdateComponent;

package/build/types/domain/features/eventNames.d.ts

@@ -0,0 +1 @@
+export declare const eventNames: readonly ["Initiated", "Succeeded", "Failed", "Cancelled", "Step Shown", "Action Triggered", "Action Succeeded", "Action Aborted", "Action Failed", "Refresh Triggered", "Refresh Succeeded", "Refresh Aborted", "Refresh Failed", "OneOf Selected", "OneOf Option Selected", "PersistAsync Triggered", "PersistAsync Succeeded", "PersistAsync Failed", "Polling Failed", "ValidationAsync Triggered", "ValidationAsync Succeeded", "ValidationAsync Failed"];

package/build/types/domain/features/events.d.ts

@@ -1,6 +1,7 @@
+import { eventNames } from './eventNames';
 export type AnalyticsEventHandler = (eventName: string, properties?: Record<string, unknown>) => void;
 export type AnalyticsEventDispatcher<E extends string = EventName> = (eventName: E, properties?: Record<string, unknown>) => void;
-export type EventName = 'Initiated' | 'Succeeded' | 'Failed' | 'Cancelled' | 'Step Shown' | 'Action Triggered' | 'Action Succeeded' | 'Action Aborted' | 'Action Failed' | 'Refresh Triggered' | 'Refresh Succeeded' | 'Refresh Aborted' | 'Refresh Failed' | 'OneOf Selected' | 'PersistAsync Triggered' | 'PersistAsync Succeeded' | 'PersistAsync Failed' | 'Polling Failed' | 'ValidationAsync Triggered' | 'ValidationAsync Succeeded' | 'ValidationAsync Failed' | 'Value Changed';
+export type EventName = (typeof eventNames)[number];
 export type LogLevel = 'info' | 'warning' | 'error';
 export type LoggingEventHandler = (level: LogLevel, message: string, extra: Record<string, unknown>) => void;
 export type LoggingEventDispatcher = (level: LogLevel, message: string, extra?: Record<string, unknown>) => void;

package/build/types/domain/mappers/mapStepToComponent.d.ts

@@ -1,4 +1,5 @@
 import type { AnalyticsEventDispatcher } from '../features/events';
+import { RequestCache } from '../prefetching/request-cache';
 import type { LoadingState, OnPoll } from '../types';
 import type { MapperProps } from './schema/types';
 import { FeatureFlags } from './utils/FeatureFlags';
@@ -8,6 +9,7 @@ export type StepMapperProps = Omit<MapperProps, 'trackEvent' | 'registerSubmissi
     loadingState: LoadingState;
     trackEvent: AnalyticsEventDispatcher<string>;
     features: FeatureFlags;
+    flowRequestCache: RequestCache;
     onPoll: OnPoll;
 };
 export declare const mapStepToComponent: ({ uid: rootUid, loadingState, features, trackEvent, onPoll, onBehavior, ...restProps }: StepMapperProps) => import("../components/step/StepDomainComponent").StepDomainComponent;

package/build/types/domain/mappers/schema/objectSchemaToComponent/objectSchemaToFormattedValueComponent.d.ts

@@ -0,0 +1,7 @@
+import type { ObjectSchema } from '@wise/dynamic-flow-types/spec';
+import type { MapperProps, SchemaMapperProps } from '../types';
+export declare const objectSchemaToFormattedValueComponent: (schemaMapperProps: SchemaMapperProps & {
+    schema: ObjectSchema & {
+        format: string;
+    };
+}, mapperProps: MapperProps) => import("../../../components/FormattedValueComponent").FormattedValueComponent;

package/build/types/domain/mappers/schema/oneOfSchemaToComponent/oneOfSchemaToComponent.d.ts

@@ -471,6 +471,31 @@ export declare const oneOfSchemaToComponent: (schemaMapperProps: SchemaMapperPro
     onUpload: (value: File | null) => Promise<void>;
 } & {
     kind: "input";
+}) | (import("../../../types").BaseComponent & {
+    schemaId?: string;
+    isSchemaReferencedInStep?: boolean;
+    control?: string;
+    description?: string;
+    help?: string;
+    hidden: boolean;
+    media?: import("../../../types").Media;
+    title?: string;
+    tags?: string[];
+    getLocalValue: () => import("@wise/dynamic-flow-types/spec").JsonElement;
+    getSubmittableValueSync: () => import("@wise/dynamic-flow-types/spec").Model;
+    getSummary: () => import("../../../types").RepeatableSummary;
+    getSubmittableValue: () => Promise<import("@wise/dynamic-flow-types/spec").Model>;
+    validate: () => boolean;
+} & {
+    type: "formatted-value";
+    kind: "input";
+    format: string;
+    alert?: import("../../../types").InlineAlert;
+    errors: string[] | undefined;
+    value: import("@wise/dynamic-flow-types/spec").JsonElement;
+    onChange: (newValue: import("@wise/dynamic-flow-types/spec").JsonElement) => void;
+} & {
+    kind: "input";
 }) | (import("../../../types").BaseComponent & {
     schemaId?: string;
     isSchemaReferencedInStep?: boolean;

package/build/types/domain/mappers/schema/persistAsyncSchemaToComponent.d.ts

@@ -484,6 +484,31 @@ export declare const persistAsyncSchemaToComponent: (schemaMapperProps: SchemaMa
     onUpload: (value: File | null) => Promise<void>;
 } & {
     kind: "input";
+}) | (import("../../types").BaseComponent & {
+    schemaId?: string;
+    isSchemaReferencedInStep?: boolean;
+    control?: string;
+    description?: string;
+    help?: string;
+    hidden: boolean;
+    media?: import("../../types").Media;
+    title?: string;
+    tags?: string[];
+    getLocalValue: () => import("@wise/dynamic-flow-types/spec").JsonElement;
+    getSubmittableValueSync: () => import("@wise/dynamic-flow-types/spec").Model;
+    getSummary: () => import("../../types").RepeatableSummary;
+    getSubmittableValue: () => Promise<import("@wise/dynamic-flow-types/spec").Model>;
+    validate: () => boolean;
+} & {
+    type: "formatted-value";
+    kind: "input";
+    format: string;
+    alert?: import("../../types").InlineAlert;
+    errors: string[] | undefined;
+    value: import("@wise/dynamic-flow-types/spec").JsonElement;
+    onChange: (newValue: import("@wise/dynamic-flow-types/spec").JsonElement) => void;
+} & {
+    kind: "input";
 }) | (import("../../types").BaseComponent & {
     schemaId?: string;
     isSchemaReferencedInStep?: boolean;

package/build/types/domain/prefetching/request-cache.d.ts

@@ -1,9 +1,9 @@
 import { HttpClient } from '../../types';
-export type SubmissionRequestCache = {
-    has: (...requestParams: Parameters<HttpClient>) => boolean;
-    get: (...requestParams: Parameters<HttpClient>) => Promise<Response | null> | undefined;
-    delete: (...requestParams: Parameters<HttpClient>) => boolean;
-    set: (...[input, init, response]: [...Parameters<HttpClient>, Promise<Response | null>]) => void;
-    clear: () => void;
+export type RequestCache = {
+    get: (requestParams: Parameters<HttpClient>) => Promise<Response | null> | undefined;
+    set: (requestParams: Parameters<HttpClient>, responsePromise: Promise<Response | null>) => void;
 };
-export declare const makeRequestCache: () => SubmissionRequestCache;
+export type RequestCacheEntries = readonly [Parameters<HttpClient>, Promise<Response | null>][];
+export declare const makeRequestCacheWithParent: (parent: RequestCache | undefined) => RequestCache;
+export declare const makeRequestCache: (initialValues?: RequestCacheEntries) => RequestCache;
+export declare const normaliseRequestCache: (cache: RequestCache | RequestCacheEntries | undefined) => RequestCache;

package/build/types/domain/types.d.ts

@@ -1,4 +1,4 @@
-import type { Action, ActionBehavior, CopyBehavior, DismissBehavior, Icon, JsonElement, LinkBehavior, Margin, ModalBehavior, Model } from '@wise/dynamic-flow-types/spec';
+import type { Action, ActionBehavior, CopyBehavior, DismissBehavior, Icon, JsonElement, LaunchConfig, LinkBehavior, Margin, ModalBehavior, Model } from '@wise/dynamic-flow-types/spec';
 import type { AlertComponent } from './components/AlertComponent';
 import type { AllOfComponent } from './components/AllOfComponent';
 import type { BooleanInputComponent } from './components/BooleanInputComponent';
@@ -10,6 +10,7 @@ import type { ContainerComponent } from './components/ContainerComponent';
 import type { DateInputComponent } from './components/DateInputComponent';
 import type { DecisionComponent } from './components/DecisionComponent';
 import type { DividerComponent } from './components/DividerComponent';
+import type { FormattedValueComponent } from './components/FormattedValueComponent';
 import type { FormComponent } from './components/FormComponent';
 import type { HeadingComponent } from './components/HeadingComponent';
 import type { ImageComponent } from './components/ImageComponent';
@@ -41,7 +42,8 @@ import type { TabsComponent } from './components/TabsComponent';
 import type { TextInputComponent } from './components/TextInputComponent';
 import type { TupleComponent } from './components/TupleComponent';
 import type { UploadInputComponent } from './components/UploadInputComponent';
-export type DomainComponent = RootDomainComponent | StepDomainComponent | PersistAsyncComponent | AllOfComponent | BooleanInputComponent | ConstComponent | DateInputComponent | IntegerInputComponent | MultiSelectComponent | MultiUploadInputComponent | NumberInputComponent | ObjectComponent | RepeatableComponent | SelectInputComponent | TextInputComponent | TupleComponent | UploadInputComponent | AlertComponent | BoxComponent | ButtonComponent | ColumnsComponent | ContainerComponent | DecisionComponent | DividerComponent | ExternalConfirmationComponent | FormComponent | HeadingComponent | ImageComponent | InstructionsComponent | ListComponent | LoadingIndicatorComponent | MarkdownComponent | ModalLayoutComponent | ModalComponent | MoneyInputComponent | ParagraphComponent | ProgressComponent | ReviewComponent | SearchComponent | SectionComponent | StatusListComponent | TabsComponent;
+import type { SubflowDomainComponent } from './components/SubflowDomainComponent';
+export type DomainComponent = RootDomainComponent | StepDomainComponent | PersistAsyncComponent | AllOfComponent | BooleanInputComponent | ConstComponent | DateInputComponent | IntegerInputComponent | MultiSelectComponent | MultiUploadInputComponent | NumberInputComponent | ObjectComponent | RepeatableComponent | SelectInputComponent | TextInputComponent | TupleComponent | UploadInputComponent | AlertComponent | BoxComponent | ButtonComponent | ColumnsComponent | ContainerComponent | DecisionComponent | DividerComponent | ExternalConfirmationComponent | FormattedValueComponent | FormComponent | HeadingComponent | ImageComponent | InstructionsComponent | ListComponent | LoadingIndicatorComponent | MarkdownComponent | ModalLayoutComponent | ModalComponent | MoneyInputComponent | ParagraphComponent | ProgressComponent | ReviewComponent | SearchComponent | SectionComponent | StatusListComponent | SubflowDomainComponent | TabsComponent;
 export type SchemaComponent = DomainComponent & {
     kind: 'input';
 };
@@ -66,9 +68,14 @@ export type CallToAction = {
     href: string;
     onClick: () => void;
 };
-export type Behavior = (ActionBehavior | CopyBehavior | DismissBehavior | LinkBehavior | ModalBehavior | NonMergingActionBehaviour | NullBehavior | RefreshBehavior | BackBehaviour) & {
+export type Behavior = (ActionBehavior | CopyBehavior | DismissBehavior | LinkBehavior | ModalBehavior | NonMergingActionBehaviour | NullBehavior | RefreshBehavior | BackBehaviour | SubflowBehavior) & {
     analytics?: Record<string, unknown>;
 };
+export type Presentation = {
+    type: 'modal';
+} | {
+    type: 'push';
+};
 type NonMergingActionBehaviour = Omit<ActionBehavior, 'type'> & {
     type: 'non-merging-action';
 };
@@ -83,6 +90,14 @@ type RefreshBehavior = {
     type: 'refresh';
     url?: string;
 };
+export type SubflowBehavior = {
+    type: 'subflow';
+    referrerId: string;
+    launchConfig: LaunchConfig;
+    resultKey?: string;
+    onCompletion?: Behavior;
+    onError?: Behavior;
+};
 export type BaseComponent = {
     kind: 'step' | 'input' | 'layout';
     type: string;

package/build/types/flow/executeRequest.d.ts

@@ -0,0 +1,39 @@
+import { ErrorResponseBody, Model, Request, Step } from '@wise/dynamic-flow-types/spec';
+import { AnalyticsEventDispatcher, LoggingEventDispatcher } from '../domain/features/events';
+import { RequestCache } from '../domain/prefetching/request-cache';
+import { Behavior } from '../domain/types';
+export type Command = {
+    type: 'complete';
+    result: Model;
+} | {
+    type: 'replace-step';
+    step: Step;
+    etag: string | null;
+} | {
+    type: 'error';
+    body?: {
+        analytics?: ErrorResponseBody['analytics'];
+        errors?: Step['errors'];
+    };
+    httpError?: {
+        message?: string;
+        statusCode?: number;
+    };
+} | {
+    type: 'refresh';
+    body: {
+        refreshUrl: string;
+        errors?: Step['errors'];
+    };
+} | {
+    type: 'behavior';
+    behavior: Behavior;
+};
+export declare const executeRequest: (props: {
+    exit?: boolean;
+    request: Request;
+    requestCache: RequestCache;
+    httpClient: typeof fetch;
+    trackEvent: AnalyticsEventDispatcher<string>;
+    logEvent: LoggingEventDispatcher;
+}) => Promise<Command>;

package/build/types/flow/executeSubmission.d.ts

@@ -1,42 +1,15 @@
-import type { Action, ErrorResponseBody, Model, Step } from '@wise/dynamic-flow-types/spec';
+import type { Action, Model, Request } from '@wise/dynamic-flow-types/spec';
 import type { AnalyticsEventDispatcher, LoggingEventDispatcher } from '../domain/features/events';
-import { SubmissionRequestCache } from '../domain/prefetching/request-cache';
-import type { Behavior } from '../domain/types';
+import { RequestCache } from '../domain/prefetching/request-cache';
 import { HttpClient } from '../types';
-type Command = {
-    type: 'complete';
-    result: Model;
-} | {
-    type: 'replace-step';
-    step: Step;
-    etag: string | null;
-} | {
-    type: 'error';
-    body?: {
-        analytics?: ErrorResponseBody['analytics'];
-        errors?: Step['errors'];
-    };
-    httpError?: {
-        message?: string;
-        statusCode?: number;
-    };
-} | {
-    type: 'refresh';
-    body: {
-        refreshUrl: string;
-        errors?: Step['errors'];
-    };
-} | {
-    type: 'behavior';
-    behavior: Behavior;
-};
+import { Command } from './executeRequest';
 export declare const executeSubmission: (props: {
     action: Action;
     model: Model;
     isInitial: boolean;
-    requestCache: SubmissionRequestCache | undefined;
+    requestCache: RequestCache;
     httpClient: HttpClient;
-    trackEvent: AnalyticsEventDispatcher;
+    trackEvent: AnalyticsEventDispatcher<string>;
     logEvent: LoggingEventDispatcher;
 }) => Promise<Command>;
-export {};
+export declare const createRequestFromAction: (action: Action, model: Model) => Request;

package/build/types/flow/getResponseType.d.ts

@@ -1,4 +1,4 @@
-declare const responseTypes: readonly ["step", "action", "exit", "modal"];
+declare const responseTypes: readonly ["step", "action", "exit", "modal", "subflow"];
 export type ResponseType = (typeof responseTypes)[number];
 /**
  * Returns either 'step', 'action', or 'exit' based on the response headers and body.

package/build/types/flow/getSafeHttpClient.d.ts

@@ -0,0 +1 @@
+export declare const getSafeHttpClient: (httpClient: typeof fetch) => (input: Parameters<typeof fetch>[0], init?: Parameters<typeof fetch>[1]) => Promise<Response | null>;

package/build/types/flow/handleErrorResponse.d.ts

@@ -0,0 +1,3 @@
+import { AnalyticsEventDispatcher } from '../domain/features/events';
+import { Command } from './executeRequest';
+export declare const handleErrorResponse: (response: Response, actionId: string | undefined, trackEvent: AnalyticsEventDispatcher) => Promise<Command>;

package/build/types/flow/response-utils.d.ts

@@ -1,10 +1,11 @@
-import type { ActionResponseBody, ErrorResponseBody, JsonElement, ModalBehavior, Step } from '@wise/dynamic-flow-types/spec';
+import type { ActionResponseBody, ErrorResponseBody, JsonElement, ModalBehavior, Step, SubflowResponseBody } from '@wise/dynamic-flow-types/spec';
 export declare const assertResponseIsValid: (response: unknown) => void;
 export declare const parseResponseBodyAsJsonElement: (response: Response) => Promise<JsonElement>;
 export declare const parseResponseBodyAsText: (response: Response) => Promise<string | null>;
 export declare function isActionResponseBody(body: unknown): body is ActionResponseBody;
 export declare function assertActionResponseBody(body: unknown): asserts body is ActionResponseBody;
 export declare function assertModalResponseBody(body: unknown): asserts body is Omit<ModalBehavior, 'type'>;
+export declare function assertSubflowResponseBody(body: unknown): asserts body is SubflowResponseBody;
 export declare function isErrorResponseBody(body: unknown): body is ErrorResponseBody;
 export declare function assertErrorResponseBody(body: unknown): asserts body is ErrorResponseBody;
 export declare function assertStepResponseBody(body: unknown): asserts body is Step;

package/build/types/getSubflowCallbacks.d.ts

@@ -0,0 +1,14 @@
+import { OnBehavior, SubflowBehavior } from './domain/types';
+import { AnalyticsEventDispatcher } from './domain/features/events';
+import { SubflowDomainComponent } from './domain/components/SubflowDomainComponent';
+type Props = {
+    behavior: SubflowBehavior;
+    onBehavior: OnBehavior;
+    close: () => void;
+    onError: (error: unknown, analytics?: Record<string, unknown>, status?: number) => void;
+    onEvent: AnalyticsEventDispatcher<string>;
+    restart: () => void;
+};
+type SubflowCallbacks = Pick<SubflowDomainComponent, 'onCompletion' | 'onError' | 'onEvent' | 'onCancellation'>;
+export declare const getSubflowCallbacks: ({ behavior, close, restart, onBehavior, onError, onEvent, }: Props) => SubflowCallbacks;
+export {};

package/build/types/index.d.ts

@@ -1,6 +1,10 @@
 export { makeHttpClient } from './common/makeHttpClient';
 export { default as translations } from './i18n';
-export type { DynamicFlowCoreProps as DynamicFlowProps, DynamicFormController } from './types';
-export { DynamicFlowCore as DynamicFlow } from './DynamicFlowCore';
-export { DynamicFormCore as DynamicForm } from './DynamicFormCore';
+export type { DynamicFlowCoreProps as DynamicFlowProps } from './types';
 export { findRendererPropsByType } from './renderers/utils';
+export { useDynamicFlow } from './useDynamicFlow';
+export { useDynamicFlowModal } from './useDynamicFlowModal';
+export { DynamicFlowCore as DynamicFlow } from './DynamicFlowCore';
+export { makeRequestCache } from './domain/prefetching/request-cache';
+export type { EventName } from './domain/features/events';
+export { eventNames } from './domain/features/eventNames';

package/build/types/renderers/mappers/formattedValueComponentToProps.d.ts

@@ -0,0 +1,4 @@
+import type { FormattedValueRendererProps } from '@wise/dynamic-flow-types/renderers';
+import type { FormattedValueComponent } from '../../domain/components/FormattedValueComponent';
+import type { RendererMapperProps } from './componentToRendererProps';
+export declare const formattedValueComponentToProps: (component: FormattedValueComponent, rendererMapperProps: RendererMapperProps) => FormattedValueRendererProps;

package/build/types/renderers/mappers/subflowComponentToRendererProps.d.ts

@@ -0,0 +1,4 @@
+import { SubflowRendererProps } from '@wise/dynamic-flow-types/renderers';
+import { SubflowDomainComponent } from '../../domain/components/SubflowDomainComponent';
+import { RendererMapperProps } from './componentToRendererProps';
+export declare const subflowComponentToRendererProps: (component: SubflowDomainComponent, rendererMapperProps: RendererMapperProps) => SubflowRendererProps;

package/build/types/test-utils/DynamicFlowWiseModal.d.ts

@@ -0,0 +1,12 @@
+import { DynamicFlowCoreProps } from '../types';
+type MakeOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+export type DynamicFlowWiseProps = MakeOptional<DynamicFlowCoreProps, 'renderers' | 'onLink'> & {
+    onAnalytics?: DynamicFlowWiseProps['onEvent'];
+};
+/**
+ * This component is only used in tests.
+ */
+export declare function DynamicFlowWiseModal(props: DynamicFlowWiseProps & {
+    open?: boolean;
+}): import("react/jsx-runtime").JSX.Element;
+export {};

package/build/types/test-utils/getMergedTestRenderers.d.ts

@@ -0,0 +1,2 @@
+import { DynamicFlowWiseProps } from './DynamicFlowWise';
+export declare const getMergedTestRenderers: (props: DynamicFlowWiseProps) => (import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").CoreContainerRendererProps> | import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").RootRendererProps> | import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").StepRendererProps> | import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").AlertRendererProps> | import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").BoxRendererProps> | import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").ColumnsRendererProps> | import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").DecisionRendererProps> | import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").DividerRendererProps> | import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").ExternalConfirmationRendererProps> | import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").FormattedValueRendererProps> | import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").FormRendererProps> | import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").HeadingRendererProps> | import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").InstructionsRendererProps> | import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").ListRendererProps> | import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").LoadingIndicatorRendererProps> | import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").MarkdownRendererProps> | import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").ImageRendererProps> | import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").ModalLayoutRendererProps> | import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").ModalRendererProps> | import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").ParagraphRendererProps> | import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").ProgressRendererProps> | import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").ReviewRendererProps> | import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").SearchRendererProps> | import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").StatusListRendererProps> | import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").CheckboxInputRendererProps> | import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").ButtonRendererProps> | import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").DateInputRendererProps> | import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").HiddenRendererProps> | import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").IntegerInputRendererProps> | import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").MoneyInputRendererProps> | import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").NumberInputRendererProps> | import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").RepeatableRendererProps> | import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").FormSectionRendererProps> | import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").SelectInputRendererProps> | import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").SectionRendererProps> | import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").SubflowRendererProps> | import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").MultiSelectInputRendererProps> | import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").TabsRendererProps> | import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").TextInputRendererProps> | import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").UploadInputRendererProps> | import("@wise/dynamic-flow-types/renderers").Renderer<import("@wise/dynamic-flow-types/renderers").MultiUploadInputRendererProps>)[];

package/build/types/types.d.ts

@@ -1,6 +1,7 @@
 import type { Renderers } from '@wise/dynamic-flow-types/renderers';
-import type { JsonElement, Model, Step } from '@wise/dynamic-flow-types/spec';
+import type { Model, Step } from '@wise/dynamic-flow-types/spec';
 import type { AnalyticsEventHandler, LoggingEventHandler } from './domain/features/events';
+import { RequestCache, RequestCacheEntries } from './domain/prefetching/request-cache';
 export type DynamicFlowCoreProps = {
     flowId: string;
     initialAction?: InitialAction;
@@ -8,6 +9,7 @@ export type DynamicFlowCoreProps = {
     httpClient: HttpClient;
     renderers: Renderers;
     features?: Record<string, unknown>;
+    requestCache?: RequestCache | RequestCacheEntries;
     onCancellation?: () => void;
     onCompletion: (result: Model) => void;
     onCopy?: (copiedString: string | null) => void;
@@ -16,16 +18,6 @@ export type DynamicFlowCoreProps = {
     onLog?: LoggingEventHandler;
     onLink: (url: string) => boolean;
 };
-export type DynamicFormController = {
-    /**
-     * Returns the current value of the form, even if it doesn't pass validation.
-     */
-    getValue: () => Promise<JsonElement>;
-    /**
-     * triggers validation in every UI component and returns whether or not the current value is valid.
-     */
-    validate: () => boolean;
-};
 export type InitialAction = {
     id?: string;
     url: string;

package/build/types/useDynamicFlow.d.ts

@@ -0,0 +1,12 @@
+import type { DynamicFlowCoreProps } from './types';
+/**
+ * @experimental This hook may be changed or removed in the future without notice.
+ */
+export declare function useDynamicFlow(props: DynamicFlowCoreProps): {
+    controller: {
+        getSubmittableValue: () => Promise<import("@wise/dynamic-flow-types/spec").JsonElement>;
+        validate: () => boolean;
+        cancel: () => void;
+    };
+    view: import("react/jsx-runtime").JSX.Element;
+};

package/build/types/{useDynamicFlowCore.d.ts → useDynamicFlowController.d.ts}

@@ -5,10 +5,11 @@ import type { DynamicFlowCoreProps } from './types';
 type UseDynamicFlowCoreProps = Omit<DynamicFlowCoreProps, 'renderers' | 'features'> & {
     features: FeatureFlags;
     onValueChange?: OnValueChange;
-    scrollToTop?: ScrollToTop;
+    scrollToTop: ScrollToTop;
     onLink: (url: string) => boolean;
 };
-export declare function useDynamicFlowCore(props: UseDynamicFlowCoreProps): {
+export declare function useDynamicFlowController(props: UseDynamicFlowCoreProps): {
     rootComponent: RootDomainComponent;
+    cancel: () => void;
 };
 export {};

package/build/types/useDynamicFlowModal.d.ts

@@ -0,0 +1,16 @@
+import { JsonElement } from '@wise/dynamic-flow-types/spec';
+import { DynamicFlowProps } from '.';
+export declare const useDynamicFlowModal: (props: DynamicFlowProps) => {
+    modal: {
+        body: import("react/jsx-runtime").JSX.Element;
+        open: boolean;
+        onClose: () => void;
+        onUnmount: () => void;
+    };
+    controller: {
+        getSubmittableValue: () => Promise<JsonElement>;
+        validate: () => boolean;
+        cancel: () => void;
+    };
+    view: import("react/jsx-runtime").JSX.Element;
+};

package/build/types/utils/{scrollToTop.d.ts → getScrollToTop.d.ts}

@@ -1,2 +1,2 @@
-import { ScrollToTop } from '../domain/types';
+import type { ScrollToTop } from '../domain/types';
 export declare const getScrollToTop: (normalisedFlowId: string, className: string) => ScrollToTop;