@wise/dynamic-flow-client 5.5.0 → 5.6.0

package/build/types/controller/FlowController.d.ts

@@ -0,0 +1,19 @@
+import { BackConfig } from '../domain/components/RootDomainComponent';
+import { GetErrorMessageFunctions } from '../domain/mappers/types';
+import { FeatureFlags } from '../domain/mappers/utils/FeatureFlags';
+import { OnValueChange, ScrollToTop } from '../domain/types';
+import { DynamicFlowCoreProps } from '../types';
+export type FlowControllerProps = Omit<DynamicFlowCoreProps, 'renderers' | 'features'> & {
+    backConfig: BackConfig;
+    features: FeatureFlags;
+    getErrorMessageFunctions: GetErrorMessageFunctions;
+    onChange: () => void;
+    onValueChange: OnValueChange;
+    scrollToTop: ScrollToTop;
+    onLink: (url: string) => boolean;
+};
+export declare const createFlowController: (props: FlowControllerProps) => {
+    rootComponent: import("../domain/components/RootDomainComponent").RootDomainComponent;
+    start: () => void;
+    cancel: () => void;
+};

package/build/types/controller/getRequestAbortController.d.ts

@@ -0,0 +1,4 @@
+export declare const getRequestAbortController: () => {
+    abortAndGetNewSignal(): AbortSignal;
+    abort(): void;
+};

package/build/types/{flow → controller}/getResponseType.d.ts

@@ -1,11 +1,12 @@
+import { JsonElement } from '@wise/dynamic-flow-types/spec';
 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.
- * This function is async because, for legacy reasons, we still need to parse the response body as JSON
+ * This function takes a response body parameter because, for legacy reasons, we still need to consider the body
  * to determine the response type, in cases where the response headers are not set.
  * Ideally it should just be a matter of checking the "X-Df-Response-Type" response header.
  */
-export declare const getResponseType: (response: Response) => Promise<ResponseType>;
-export declare const getResponseTypeFromHeader: (response: Response) => ResponseType | undefined;
+export declare const getResponseType: (headers: Headers, body: JsonElement) => ResponseType;
+export declare const getResponseTypeFromHeader: (headers: Headers) => ResponseType | undefined;
 export {};

package/build/types/controller/getStepCounter.d.ts

@@ -0,0 +1,9 @@
+/**
+ * To ensure there are no uid collisions between consecutive steps, we use a
+ * counter that is appended to the step id. This means that even steps with the
+ * same structure and ids will not have the same component uids.
+ */
+export declare const getStepCounter: () => {
+    increment(): void;
+    readonly current: number;
+};

package/build/types/{flow → controller}/response-utils.d.ts

@@ -1,5 +1,4 @@
 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;

package/build/types/domain/mappers/utils/layout-utils.d.ts

@@ -1,2 +1,7 @@
 import type { Layout } from '@wise/dynamic-flow-types/spec';
-export declare const removeMarginFromLayout: (component: Layout) => Layout;
+/**
+ * Normalizes the margin of the last layout component in the container by removing its margin if it is not explicitly set.
+ * @param container The array of layout components.
+ * @returns The array of layout components with the last component's margin normalized if needed.
+ */
+export declare const normaliseMarginInLastComponent: (container: Layout[]) => Layout[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wise/dynamic-flow-client",
-  "version": "5.5.0",
+  "version": "5.6.0",
   "description": "Dynamic Flow web client",
   "license": "Apache-2.0",
   "main": "./build/main.js",
@@ -72,8 +72,8 @@
     "typescript": "5.9.3",
     "vitest": "4.0.18",
     "vitest-fetch-mock": "0.4.5",
-    "@wise/dynamic-flow-fixtures": "0.0.1",
-    "@wise/dynamic-flow-renderers": "0.0.0"
+    "@wise/dynamic-flow-renderers": "0.0.0",
+    "@wise/dynamic-flow-fixtures": "0.0.1"
   },
   "peerDependencies": {
     "@transferwise/components": "^46.104.0",
@@ -86,7 +86,7 @@
     "react-intl": "^6 || ^7"
   },
   "dependencies": {
-    "@wise/dynamic-flow-types": "4.6.0"
+    "@wise/dynamic-flow-types": "4.7.0"
   },
   "scripts": {
     "dev": "EXCLUDE_VISUAL_TESTS=true pnpm storybook dev -p 3003",

package/build/types/useDynamicFlowController.d.ts

@@ -1,19 +0,0 @@
-import { BackConfig, RootDomainComponent } from './domain/components/RootDomainComponent';
-import { GetErrorMessageFunctions } from './domain/mappers/types';
-import { FeatureFlags } from './domain/mappers/utils/FeatureFlags';
-import type { OnValueChange, ScrollToTop } from './domain/types';
-import type { DynamicFlowCoreProps } from './types';
-type UseDynamicFlowCoreProps = Omit<DynamicFlowCoreProps, 'renderers' | 'features'> & {
-    backConfig: BackConfig;
-    features: FeatureFlags;
-    getErrorMessageFunctions: GetErrorMessageFunctions;
-    onChange: () => void;
-    onValueChange: OnValueChange;
-    scrollToTop: ScrollToTop;
-    onLink: (url: string) => boolean;
-};
-export declare function useDynamicFlowController(props: UseDynamicFlowCoreProps): {
-    rootComponent: RootDomainComponent;
-    cancel: () => void;
-};
-export {};