@wise/dynamic-flow-client 3.5.2 → 3.6.0

package/build/types/legacy/layout/search/useSearch.d.ts

@@ -1,4 +1,14 @@
 import type { SearchConfig, SearchResult } from '@wise/dynamic-flow-types';
+export type SearchState = {
+    status: 'idle';
+} | {
+    status: 'loading';
+} | {
+    status: 'success';
+    results: SearchResult[];
+} | {
+    status: 'error';
+};
 export declare const useSearch: (defaultSearchConfig: SearchConfig) => {
     status: "success" | "loading" | "error" | "idle";
     results: SearchResult[];

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

@@ -1,13 +1,14 @@
 import { type ReactWrapper } from 'enzyme';
 import type { ReactNode } from 'react';
 import type { EventHandler, LogEventHandler } from '../dynamic-flow-types';
+import type { ProviderProps } from '@transferwise/components';
 declare const getMockFetchPromise: (status: number, jsonFn: () => void, delay: number, signal?: AbortSignal | null) => Promise<Response>;
 declare const wait: (t: number) => Promise<unknown>;
-declare function mountWithProviders(component: ReactNode, locale?: string, messages?: Record<string, unknown>, baseUrl?: string, onEvent?: EventHandler, onLog?: LogEventHandler): ReactWrapper;
+declare function mountWithProviders(component: ReactNode, locale?: string, messages?: ProviderProps['i18n']['messages'], baseUrl?: string, onEvent?: EventHandler, onLog?: LogEventHandler): ReactWrapper;
 declare function mountWithOptions({ component, locale, messages, baseUrl, onEvent, onLog, }: {
     component: ReactNode;
     locale?: string;
-    messages?: Record<string, unknown>;
+    messages?: ProviderProps['i18n']['messages'];
     baseUrl?: string;
     onEvent?: EventHandler;
     onLog?: LogEventHandler;

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

@@ -1,15 +1,19 @@
 import type { BaseComponent, DomainComponent, LoadingState, LocalValue, UpdateComponent } from '../types';
-import type { External } from '@wise/dynamic-flow-types/build/next/feature/External';
+import type { Step } from '@wise/dynamic-flow-types/build/next';
+import type { AnalyticsEventDispatcher } from '../features/events';
+import type { StepPolling } from '../features/polling/getStepPolling';
 export type StepDomainComponent = BaseComponent & {
     type: 'step';
     components: DomainComponent[];
-    external?: External;
+    external?: Step['external'];
     loadingState: LoadingState;
     setLoadingState: (loadingState: LoadingState) => void;
     getChildren: () => DomainComponent[];
     getLocalValue: () => LocalValue;
+    stop: () => void;
+    trackEvent: AnalyticsEventDispatcher<string>;
 };
-export declare const createStepComponent: (stepProps: Pick<StepDomainComponent, "external" | "components" | "loadingState" | "uid"> & {
+export declare const createStepComponent: (stepProps: Pick<StepDomainComponent, "external" | "components" | "loadingState" | "uid" | "trackEvent"> & {
+    stepPolling?: StepPolling | undefined;
     updateComponent: UpdateComponent;
 }) => StepDomainComponent;
-export declare const createEmptyStepComponent: (updateComponent: UpdateComponent) => StepDomainComponent;

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

@@ -1,6 +1,6 @@
 export type AnalyticsEventHandler = (eventName: string, properties?: Record<string, unknown>) => void;
-export type AnalyticsEventDispatcher = (eventName: EventName, properties?: Record<string, unknown>) => void;
-export type EventName = 'Initiated' | 'Succeeded' | 'Failed' | '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' | 'ValidationAsync Triggered' | 'ValidationAsync Succeeded' | 'ValidationAsync Failed' | 'Search Started' | 'Search Result Selected';
+export type AnalyticsEventDispatcher<E extends string = EventName> = (eventName: E, properties?: Record<string, unknown>) => void;
+export type EventName = 'Initiated' | 'Succeeded' | 'Failed' | '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' | 'ValidationAsync Triggered' | 'ValidationAsync Succeeded' | 'ValidationAsync Failed';
 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/revamp/domain/features/polling/getStepPolling.d.ts

@@ -0,0 +1,12 @@
+import type { Polling } from '@wise/dynamic-flow-types/build/next';
+import type { HttpClient } from '../../../types';
+import type { OnAction } from '../../types';
+export type StepPollingProps = {
+    httpClient: HttpClient;
+    pollingConfig: Polling;
+    onAction: OnAction;
+};
+export type StepPolling = {
+    stop: () => void;
+};
+export declare const getStepPolling: ({ httpClient, pollingConfig, onAction, }: StepPollingProps) => StepPolling;

package/build/types/revamp/domain/mappers/layout/buttonLayoutToComponent.d.ts

@@ -1,3 +1,3 @@
 import type { ButtonLayout } from '@wise/dynamic-flow-types/build/next';
 import type { MapperProps } from '../schema/types';
-export declare const buttonLayoutToComponent: (uid: string, { action, context, control, disabled, margin, pinOrder, size, title }: ButtonLayout, { onAction, step }: MapperProps) => import("../../components/ButtonComponent").ButtonComponent;
+export declare const buttonLayoutToComponent: (uid: string, button: ButtonLayout, { onAction, step }: MapperProps) => import("../../components/ButtonComponent").ButtonComponent;

package/build/types/revamp/domain/mappers/layout/decisionLayoutToComponent.d.ts

@@ -1,3 +1,3 @@
 import type { DecisionLayout } from '@wise/dynamic-flow-types/build/next';
 import type { MapperProps } from '../schema/types';
-export declare const decisionLayoutToComponent: (uid: string, { control, margin, options }: DecisionLayout, { onAction }: MapperProps) => import("../../components/DecisionComponent").DecisionComponent;
+export declare const decisionLayoutToComponent: (uid: string, { control, margin, options }: DecisionLayout, { onAction, step }: MapperProps) => import("../../components/DecisionComponent").DecisionComponent;

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

@@ -1,8 +1,9 @@
+import type { AnalyticsEventDispatcher } from '../features/events';
 import type { LoadingState } from '../types';
 import type { MapperProps } from './schema/types';
-type MapStepToComponentProps = MapperProps & {
+export type StepMapperProps = Omit<MapperProps, 'trackEvent'> & {
     displayStepTitle: boolean;
     loadingState: LoadingState;
+    trackEvent: AnalyticsEventDispatcher<string>;
 };
-export declare const mapStepToComponent: ({ loadingState, displayStepTitle, ...mapperProps }: MapStepToComponentProps) => import("../components/StepDomainComponent").StepDomainComponent;
-export {};
+export declare const mapStepToComponent: ({ loadingState, displayStepTitle, trackEvent, ...restProps }: StepMapperProps) => import("../components/StepDomainComponent").StepDomainComponent;

package/build/types/revamp/domain/mappers/utils/inlineAction.d.ts

@@ -0,0 +1,2 @@
+import type { Action } from '@wise/dynamic-flow-types/build/next';
+export declare const inlineAction: (action: Action, stepActions?: Action[]) => Action;

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

@@ -1,6 +1,7 @@
 import type { ActionResponseBody, ErrorResponseBody, JsonElement, Step } from '@wise/dynamic-flow-types/build/next';
 export declare const assertResponseIsValid: (response: unknown) => void;
 export declare const parseResponseBodyAsJsonElement: (response: Response) => Promise<JsonElement>;
+export declare function isActionResponseBody(body: unknown): body is ActionResponseBody;
 export declare function assertActionResponseBody(body: unknown): asserts body is ActionResponseBody;
 export declare function isErrorResponseBody(body: unknown): body is ErrorResponseBody;
 export declare function assertErrorResponseBody(body: unknown): asserts body is ErrorResponseBody;

package/build/types/revamp/renderers/step/StepRendererContext.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="react" />
+import type { AnalyticsEventDispatcher } from '../../domain/features/events';
+import type { LoadingState } from '../types';
+export declare const StepRendererContextProvider: import("react").Provider<{
+    loadingState: LoadingState;
+    trackEvent: AnalyticsEventDispatcher<string>;
+}>;
+export declare const useLoadingContext: () => {
+    loadingState: LoadingState;
+    isLoading: boolean;
+};
+export declare const useTrackEvent: () => AnalyticsEventDispatcher<string>;

package/build/types/revamp/renderers/stepComponentToProps.d.ts

@@ -1,4 +1,4 @@
 import type { ReactNode } from 'react';
 import type { StepDomainComponent } from '../domain/components/StepDomainComponent';
 import type { StepRendererProps } from './types';
-export declare const stepComponentToProps: ({ external, loadingState }: StepDomainComponent, children: ReactNode) => StepRendererProps;
+export declare const stepComponentToProps: ({ external, loadingState, trackEvent }: StepDomainComponent, children: ReactNode) => StepRendererProps;

package/build/types/revamp/renderers/types.d.ts

@@ -1,8 +1,9 @@
-import type { Margin as DFMargin, Size as DFSize, SearchResult as SearchResultSpec, Icon as DFIcon } from '@wise/dynamic-flow-types/build/next';
+import type { Icon as DFIcon, Margin as DFMargin, Size as DFSize, SearchResult as SearchResultSpec } from '@wise/dynamic-flow-types/build/next';
 import type { ReactNode } from 'react';
 import type { DecisionOption as DomainDecisionOption } from '../domain/components/DecisionComponent';
 import type { InstructionItem as DomainInstructionItem } from '../domain/components/InstructionsComponent';
 import type { ReviewCallToAction as DomainReviewCallToAction, ReviewField as DomainReviewField } from '../domain/components/ReviewComponent';
+import type { AnalyticsEventDispatcher } from '../domain/features/events';
 import type { CoreContainerRendererProps } from './CoreContainerRenderer';
 export type Align = 'start' | 'center' | 'end';
 export type Bias = 'none' | 'start' | 'end';
@@ -28,6 +29,7 @@ export type StepRendererProps = {
         url: string;
     };
     loadingState: LoadingState;
+    trackEvent: AnalyticsEventDispatcher<string>;
     children: ReactNode;
 };
 export type AlertRendererProps = {
@@ -170,7 +172,8 @@ export type ResultsSearchState = {
     type: 'results';
     results: SearchResult[];
 };
-export type SearchResult = Pick<SearchResultSpec, 'description' | 'icon' | 'image' | 'title'> & {
+export type SearchResult = Pick<SearchResultSpec, 'description' | 'icon' | 'image' | 'title' | 'type'> & {
+    id?: string;
     onClick: () => void;
 };
 export type StatusListRendererProps = {

package/build/types/revamp/wise/renderers/SearchRenderer/BlockSearchRendererComponent.d.ts

@@ -0,0 +1,7 @@
+import type { ResultsSearchState, SearchRendererProps } from '../../../renderers/types';
+declare function BlockSearchRendererComponent({ id, isLoading, margin, onChange, query, state, title, }: SearchRendererProps): JSX.Element;
+export declare function SearchResults({ state, }: {
+    state: ResultsSearchState;
+    onChange: (query: string) => void;
+}): JSX.Element;
+export default BlockSearchRendererComponent;

package/build/types/revamp/wise/renderers/SearchRenderer/ErrorResult.d.ts

@@ -0,0 +1,4 @@
+import type { ErrorSearchState } from '../../../renderers/types';
+export declare function ErrorResult({ state }: {
+    state: ErrorSearchState;
+}): JSX.Element;

package/build/types/revamp/wise/renderers/SearchRenderer/InlineSearchRendererComponent.d.ts

@@ -0,0 +1,3 @@
+import type { SearchRendererProps } from '../../../renderers/types';
+declare function InlineSearchRenderer({ id, isLoading, margin, onChange, state, title, }: SearchRendererProps): JSX.Element;
+export default InlineSearchRenderer;

package/build/types/revamp/wise/renderers/SearchRenderer/SearchRenderer.d.ts

@@ -0,0 +1,3 @@
+import type { Renderer, SearchRendererProps } from '../../../renderers/types';
+declare const SearchRenderer: Renderer<SearchRendererProps>;
+export default SearchRenderer;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wise/dynamic-flow-client",
-  "version": "3.5.2",
+  "version": "3.6.0",
   "description": "Dynamic Flow web client",
   "license": "Apache-2.0",
   "main": "./build/main.min.js",
@@ -40,7 +40,7 @@
     "@testing-library/react": "14.3.0",
     "@testing-library/react-hooks": "8.0.1",
     "@testing-library/user-event": "14.5.2",
-    "@transferwise/components": "46.25.0",
+    "@transferwise/components": "46.26.2",
     "@transferwise/formatting": "^2.13.0",
     "@transferwise/icons": "3.13.0",
     "@transferwise/neptune-css": "14.9.6",
@@ -92,7 +92,7 @@
     "classnames": "2.5.1",
     "react-webcam": "^7.2.0",
     "screenfull": "^5.2.0",
-    "@wise/dynamic-flow-types": "2.12.1"
+    "@wise/dynamic-flow-types": "2.13.0"
   },
   "scripts": {
     "dev": "storybook dev -p 3003",

package/build/types/revamp/renderers/LoadingContext.d.ts

@@ -1,9 +0,0 @@
-/// <reference types="react" />
-import type { LoadingState } from './types';
-export declare const LoadingContextProvider: import("react").Provider<{
-    loadingState: LoadingState;
-}>;
-export declare const useLoadingContext: () => {
-    loadingState: LoadingState;
-    isLoading: boolean;
-};

package/build/types/revamp/wise/renderers/SearchRenderer.d.ts

@@ -1,15 +0,0 @@
-import type { ErrorSearchState, Renderer, ResultsSearchState, SearchRendererProps } from '../../renderers/types';
-declare const SearchRenderer: Renderer<SearchRendererProps>;
-export declare function SearchInput({ id, query, onChange, }: {
-    id: string;
-    query: string;
-    onChange: (query: string) => void;
-}): JSX.Element;
-export declare function ErrorResult({ state }: {
-    state: ErrorSearchState;
-}): JSX.Element;
-export declare function SearchResults({ state, }: {
-    state: ResultsSearchState;
-    onChange: (query: string) => void;
-}): JSX.Element;
-export default SearchRenderer;