@wise/dynamic-flow-client 3.0.0 → 3.0.2

package/build/types/legacy/jsonSchemaForm/arrayTypeSchema/arrayListSchema/repeatableSchema/RepeatableSchema.d.ts

@@ -3,6 +3,7 @@ import type { GenericSchemaProps } from '../../../genericSchema/GenericSchema';
 type RepeatableSchemaProps = Omit<GenericSchemaProps, 'model' | 'onPersistAsync'> & {
     schema: ListArraySchema;
     model: ArrayModel | null;
+    required?: boolean;
 };
-declare function RepeatableSchema({ schema, model, errors, submitted, onChange }: RepeatableSchemaProps): JSX.Element;
+declare function RepeatableSchema({ schema, model, errors, submitted, required, onChange, }: RepeatableSchemaProps): JSX.Element;
 export default RepeatableSchema;

package/build/types/legacy/jsonSchemaForm/controlFeedback/ControlFeedback.d.ts

@@ -13,6 +13,8 @@ type ValidationMessages = {
     maximum?: string;
     minLength?: string;
     maxLength?: string;
+    minItems?: string;
+    maxItems?: string;
     pattern?: string;
     required?: string;
 };

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

@@ -1,15 +1,16 @@
-import type { InputComponent, PersistedState, RepeatableSummary, UpdateComponent } from '../types';
-import type { IsInvalidCheck } from '../features/validation/value-checks';
+import type { InputComponent, PersistedState, RepeatableSummary, UpdateComponent, ValidationState } from '../types';
 import type { PerformPersistAsync } from '../features/persistAsync/getPerformPersistAsync';
 import type { PerformRefresh } from '../features/refresh/getPerformRefresh';
+import type { PerformValidationAsync } from '../features/validationAsync/getPerformValidationAsync';
 export type BooleanInputComponent = InputComponent<boolean> & {
     type: 'boolean';
     persistedState: PersistedState;
+    validationState: ValidationState;
     onChange: (value: boolean) => void;
 };
-export declare const createBooleanInputComponent: (booleanInputProps: Pick<BooleanInputComponent, "analyticsId" | "description" | "disabled" | "help" | "hidden" | "title" | "control" | "id" | "errors" | "required" | "value" | "uid" | "persistedState"> & {
-    checks: IsInvalidCheck<boolean>[];
+export declare const createBooleanInputComponent: (booleanInputProps: Pick<BooleanInputComponent, "analyticsId" | "description" | "disabled" | "help" | "hidden" | "title" | "control" | "id" | "errors" | "required" | "value" | "uid" | "persistedState" | "validationState"> & {
     performPersistAsync: PerformPersistAsync | undefined;
-    performRefresh?: PerformRefresh | undefined;
+    performRefresh: PerformRefresh | undefined;
+    performValidationAsync: PerformValidationAsync | undefined;
     summariser: (value: boolean) => RepeatableSummary;
 }, updateComponent: UpdateComponent) => BooleanInputComponent;

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

@@ -1,17 +1,20 @@
 import type { PerformPersistAsync } from '../features/persistAsync/getPerformPersistAsync';
 import type { IsInvalidCheck } from '../features/validation/value-checks';
-import type { InputComponent, PersistedState, RepeatableSummary, UpdateComponent } from '../types';
+import type { InputComponent, PersistedState, RepeatableSummary, UpdateComponent, ValidationState } from '../types';
 import type { PerformRefresh } from '../features/refresh/getPerformRefresh';
+import type { PerformValidationAsync } from '../features/validationAsync/getPerformValidationAsync';
 export type DateInputComponent = InputComponent<string | null> & {
     type: 'date';
     minimumDate?: string;
     maximumDate?: string;
     persistedState: PersistedState;
+    validationState: ValidationState;
     onChange: (value: string | null) => void;
 };
-export declare const createDateInputComponent: (textInputProps: Pick<DateInputComponent, "analyticsId" | "description" | "disabled" | "help" | "hidden" | "title" | "placeholder" | "control" | "id" | "errors" | "required" | "value" | "autoComplete" | "minimumDate" | "maximumDate" | "uid" | "persistedState"> & {
+export declare const createDateInputComponent: (textInputProps: Pick<DateInputComponent, "analyticsId" | "description" | "disabled" | "help" | "hidden" | "title" | "placeholder" | "control" | "id" | "errors" | "required" | "value" | "autoComplete" | "minimumDate" | "maximumDate" | "uid" | "persistedState" | "validationState"> & {
     checks: IsInvalidCheck<string | null>[];
     performPersistAsync: PerformPersistAsync | undefined;
-    performRefresh?: PerformRefresh | undefined;
+    performRefresh: PerformRefresh | undefined;
+    performValidationAsync: PerformValidationAsync | undefined;
     summariser: (value: string | null) => RepeatableSummary;
 }, updateComponent: UpdateComponent) => DateInputComponent;

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

@@ -1,15 +1,18 @@
-import type { InputComponent, PersistedState, RepeatableSummary, UpdateComponent } from '../types';
+import type { InputComponent, PersistedState, RepeatableSummary, UpdateComponent, ValidationState } from '../types';
 import type { IsInvalidCheck } from '../features/validation/value-checks';
 import type { PerformPersistAsync } from '../features/persistAsync/getPerformPersistAsync';
 import type { PerformRefresh } from '../features/refresh/getPerformRefresh';
+import type { PerformValidationAsync } from '../features/validationAsync/getPerformValidationAsync';
 export type IntegerInputComponent = InputComponent<number | null> & {
     type: 'integer';
     persistedState: PersistedState;
+    validationState: ValidationState;
     onChange: (value: number | null) => void;
 };
-export declare const createIntegerInputComponent: (integerInputProps: Pick<IntegerInputComponent, "analyticsId" | "description" | "disabled" | "help" | "hidden" | "title" | "placeholder" | "control" | "id" | "errors" | "required" | "value" | "autoComplete" | "uid" | "persistedState"> & {
+export declare const createIntegerInputComponent: (integerInputProps: Pick<IntegerInputComponent, "analyticsId" | "description" | "disabled" | "help" | "hidden" | "title" | "placeholder" | "control" | "id" | "errors" | "required" | "value" | "autoComplete" | "uid" | "persistedState" | "validationState"> & {
     checks: IsInvalidCheck<number | null>[];
     performPersistAsync: PerformPersistAsync | undefined;
-    performRefresh?: PerformRefresh | undefined;
+    performRefresh: PerformRefresh | undefined;
+    performValidationAsync: PerformValidationAsync | undefined;
     summariser: (value: number | null) => RepeatableSummary;
 }, updateComponent: UpdateComponent) => IntegerInputComponent;

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

@@ -1,15 +1,18 @@
-import type { InputComponent, PersistedState, RepeatableSummary, UpdateComponent } from '../types';
+import type { InputComponent, PersistedState, RepeatableSummary, UpdateComponent, ValidationState } from '../types';
 import type { IsInvalidCheck } from '../features/validation/value-checks';
 import type { PerformPersistAsync } from '../features/persistAsync/getPerformPersistAsync';
 import type { PerformRefresh } from '../features/refresh/getPerformRefresh';
+import type { PerformValidationAsync } from '../features/validationAsync/getPerformValidationAsync';
 export type NumberInputComponent = InputComponent<number | null> & {
     type: 'number';
     persistedState: PersistedState;
+    validationState: ValidationState;
     onChange: (value: number | null) => void;
 };
-export declare const createNumberInputComponent: (numberInputProps: Pick<NumberInputComponent, "analyticsId" | "description" | "disabled" | "help" | "hidden" | "title" | "placeholder" | "control" | "id" | "errors" | "required" | "value" | "autoComplete" | "uid" | "persistedState"> & {
+export declare const createNumberInputComponent: (numberInputProps: Pick<NumberInputComponent, "analyticsId" | "description" | "disabled" | "help" | "hidden" | "title" | "placeholder" | "control" | "id" | "errors" | "required" | "value" | "autoComplete" | "uid" | "persistedState" | "validationState"> & {
     checks: IsInvalidCheck<number | null>[];
     performPersistAsync: PerformPersistAsync | undefined;
-    performRefresh?: PerformRefresh | undefined;
+    performRefresh: PerformRefresh | undefined;
+    performValidationAsync: PerformValidationAsync | undefined;
     summariser: (value: number | null) => RepeatableSummary;
 }, updateComponent: UpdateComponent) => NumberInputComponent;

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

@@ -1,16 +1,19 @@
 import type { IsInvalidCheck } from '../features/validation/value-checks';
-import type { InputComponent, PersistedState, RepeatableSummary, UpdateComponent } from '../types';
+import type { InputComponent, PersistedState, RepeatableSummary, UpdateComponent, ValidationState } from '../types';
 import type { PerformPersistAsync } from '../features/persistAsync/getPerformPersistAsync';
 import type { PerformRefresh } from '../features/refresh/getPerformRefresh';
+import type { PerformValidationAsync } from '../features/validationAsync/getPerformValidationAsync';
 export type TextInputComponent = InputComponent<string | null> & {
     type: 'text';
     displayFormat?: string;
     persistedState: PersistedState;
+    validationState: ValidationState;
     onChange: (value: string | null) => void;
 };
-export declare const createTextInputComponent: (textInputProps: Pick<TextInputComponent, "analyticsId" | "description" | "disabled" | "help" | "hidden" | "title" | "placeholder" | "control" | "displayFormat" | "id" | "errors" | "required" | "value" | "autoComplete" | "uid" | "persistedState"> & {
+export declare const createTextInputComponent: (textInputProps: Pick<TextInputComponent, "analyticsId" | "description" | "disabled" | "help" | "hidden" | "title" | "placeholder" | "control" | "displayFormat" | "id" | "errors" | "required" | "value" | "autoComplete" | "uid" | "persistedState" | "validationState"> & {
     checks: IsInvalidCheck<string | null>[];
     performPersistAsync: PerformPersistAsync | undefined;
-    performRefresh?: PerformRefresh | undefined;
+    performValidationAsync: PerformValidationAsync | undefined;
+    performRefresh: PerformRefresh | undefined;
     summariser: (value: string | null) => RepeatableSummary;
 }, updateComponent: UpdateComponent) => TextInputComponent;

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

@@ -1,9 +1,10 @@
 import type { Step } from '@wise/dynamic-flow-types/build/next';
 export type AnalyticsEventHandler = (eventName: string, properties?: Record<string, unknown>) => void;
 export type AnalyticsEventDispatcher = (eventName: EventName, properties?: Record<string, unknown>) => void;
-export declare const getAnalyticsEventDispatcher: ({ flowId, step, onEvent, }: {
+export declare const getAnalyticsEventDispatcher: ({ flowId, stepId, analytics, onEvent, }: {
     flowId: string;
-    step?: Step | null | undefined;
+    stepId?: string | undefined;
+    analytics?: Step['analytics'];
     onEvent?: AnalyticsEventHandler | undefined;
 }) => AnalyticsEventDispatcher;
 export type EventName = 'Flow Started' | 'Flow Succeeded' | 'Flow 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';

package/build/types/revamp/domain/features/utils/http-utils.d.ts

@@ -0,0 +1,18 @@
+import type { LocalValue } from '../../types';
+import type { HttpMethod } from '@wise/dynamic-flow-types';
+export declare function constructPayload({ value, signal, requestConfig, }: {
+    value: LocalValue;
+    signal: AbortSignal;
+    requestConfig: {
+        method: HttpMethod;
+        param: string;
+    };
+}): {
+    method: HttpMethod;
+    headers: {
+        'Content-Type'?: string | undefined;
+    };
+    body: string | FormData;
+    signal: AbortSignal;
+};
+export declare const abortAndResetController: (abortController: AbortController) => AbortController;

package/build/types/revamp/domain/features/validation/spec-utils.d.ts

@@ -1,16 +1,2 @@
-/// <reference types="jest" />
-export declare const mockErrorMessageFunctions: {
-    minimum: jest.Mock<any, any, any>;
-    maximum: jest.Mock<any, any, any>;
-    minimumDate: jest.Mock<any, any, any>;
-    maximumDate: jest.Mock<any, any, any>;
-    minLength: jest.Mock<any, any, any>;
-    maxLength: jest.Mock<any, any, any>;
-    minFiles: jest.Mock<any, any, any>;
-    maxFiles: jest.Mock<any, any, any>;
-    minItems: jest.Mock<any, any, any>;
-    maxItems: jest.Mock<any, any, any>;
-    pattern: jest.Mock<any, any, any>;
-    required: jest.Mock<any, any, any>;
-    persistAsyncError: jest.Mock<any, any, any>;
-};
+import type { ErrorMessageFunctions } from '../../mappers/types';
+export declare const mockErrorMessageFunctions: ErrorMessageFunctions;

package/build/types/revamp/domain/features/validationAsync/getComponentValidationAsync.d.ts

@@ -0,0 +1,14 @@
+import type { getInputUpdateFunction } from '../../components/utils/component-utils';
+import type { PerformValidationAsync } from './getPerformValidationAsync';
+import type { BooleanInputComponent } from '../../components/BooleanInputComponent';
+import type { DateInputComponent } from '../../components/DateInputComponent';
+import type { IntegerInputComponent } from '../../components/IntegerInputComponent';
+import type { NumberInputComponent } from '../../components/NumberInputComponent';
+import type { TextInputComponent } from '../../components/TextInputComponent';
+import type { LocalValue, ValidationState } from '../../types';
+type Validatable = BooleanInputComponent | DateInputComponent | IntegerInputComponent | NumberInputComponent | TextInputComponent;
+/**
+ * Creates an onValidateAsync handler for a component.
+ */
+export declare const getComponentValidationAsync: (update: ReturnType<typeof getInputUpdateFunction<Validatable>>, performValidationAsync: PerformValidationAsync) => (validationState: ValidationState, currentValue: LocalValue) => Promise<string | null | undefined>;
+export {};

package/build/types/revamp/domain/features/validationAsync/getInitialValidationState.d.ts

@@ -0,0 +1,2 @@
+import type { ValidationState } from '../../types';
+export declare const getInitialValidationState: () => ValidationState;

package/build/types/revamp/domain/features/validationAsync/getPerformValidationAsync.d.ts

@@ -0,0 +1,20 @@
+import type { ValidateAsync } from '@wise/dynamic-flow-types/build/next/feature/ValidateAsync';
+import type { HttpClient } from '../../../types';
+import type { AnalyticsEventDispatcher } from '../events';
+import type { LocalValue } from '../../types';
+export type PerformValidationAsync = (props: ValidationAsyncProps) => Promise<string | null>;
+type ValidationAsyncProps = {
+    value: LocalValue;
+    signal: AbortSignal;
+};
+/**
+ * Takes an httpClient and schema validation async config and returns a function that can
+ * execute a validation async request.
+ */
+export declare const getPerformValidationAsync: ({ httpClient, validationAsyncConfig, schemaId, trackEvent, }: {
+    httpClient: HttpClient;
+    validationAsyncConfig: ValidateAsync;
+    schemaId?: string | undefined;
+    trackEvent: AnalyticsEventDispatcher;
+}) => PerformValidationAsync;
+export {};

package/build/types/revamp/domain/mappers/schema/utils/getValidationAsyncInitialState.d.ts

@@ -0,0 +1,5 @@
+import type { MapperProps, SchemaMapperProps } from '../types';
+export declare const getValidationAsyncInitialState: (schemaMapperProps: SchemaMapperProps, mapperProps: MapperProps) => {
+    performValidationAsync: import("../../../features/validationAsync/getPerformValidationAsync").PerformValidationAsync | undefined;
+    validationState: import("../../../types").ValidationState;
+};

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

@@ -14,6 +14,7 @@ export type ErrorMessageFunctions = {
     minItems: (minItems: number) => string;
     pattern: () => string;
     required: () => string;
-    persistAsyncError: () => string;
+    genericError: () => string;
+    genericErrorWithRetry: () => string;
 };
 export type PersistAsyncConfig = Pick<PersistAsync, 'idProperty' | 'method' | 'param' | 'url'>;

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

@@ -86,3 +86,11 @@ export type PersistedState = {
     lastSubmitted: LocalValue;
     submission: Promise<JsonElement | null>;
 };
+export type ValidationState = {
+    abortController: AbortController;
+    lastSubmitted: LocalValue;
+    messages: {
+        success?: string;
+        error?: string;
+    };
+};

package/build/types/revamp/flow/executeRefresh.d.ts

@@ -1,4 +1,4 @@
-import type { Model, Step } from '@wise/dynamic-flow-types/build/next';
+import type { Model, Step, ErrorResponseBody } from '@wise/dynamic-flow-types/build/next';
 import type { AnalyticsEventDispatcher } from '../domain/features/events';
 type Command = {
     type: 'refresh-step';
@@ -6,12 +6,15 @@ type Command = {
     etag: string | null;
 } | {
     type: 'noop';
+} | {
+    type: 'error';
+    body: ErrorResponseBody;
 };
 export declare const executeRefresh: (props: {
     abortSignal: AbortSignal;
     url: string;
     model: Model;
-    schemaId: string | undefined;
+    schemaId?: string | undefined;
     etag: string | null;
     httpClient: typeof fetch;
     trackEvent: AnalyticsEventDispatcher;

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

@@ -1,4 +1,4 @@
-import type { Action, Model, Step, ErrorResponseBody } from '@wise/dynamic-flow-types/build/next';
+import type { Action, ErrorResponseBody, Model, Step } from '@wise/dynamic-flow-types/build/next';
 import type { AnalyticsEventDispatcher } from '../domain/features/events';
 type Command = {
     type: 'complete';
@@ -8,8 +8,17 @@ type Command = {
     step: Step;
     etag: string | null;
 } | {
-    type: 'errors';
-    errors: ErrorResponseBody;
+    type: 'error';
+    body: {
+        analytics?: ErrorResponseBody['analytics'];
+        errors?: Step['errors'];
+    };
+} | {
+    type: 'refresh';
+    body: {
+        refreshUrl: string;
+        errors?: Step['errors'];
+    };
 };
 export declare const executeSubmission: (props: {
     action: Action;

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

@@ -2,5 +2,6 @@ import type { ActionResponseBody, ErrorResponseBody, JsonElement, Step } from '@
 export declare const assertResponseIsValid: (response: unknown) => void;
 export declare const parseResponseBodyAsJsonElement: (response: Response) => Promise<JsonElement>;
 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;
 export declare function assertStepResponseBody(body: unknown): asserts body is Step;

package/build/types/revamp/step/Step.d.ts

@@ -1,16 +1,18 @@
 import type { Action, Step as DFStep, Model } from '@wise/dynamic-flow-types/build/next';
 import type { LocalValue, StepComponent } from '../domain/types';
 import type { AnalyticsEventDispatcher, LoggingEventDispatcher } from '../domain/features/events';
+import type { GetErrorMessageFunctions } from '../domain/mappers/types';
 import type { HttpClient } from '../types';
 type StepProps = {
     localValue: LocalValue;
     step: DFStep;
     displayStepTitle?: boolean;
+    getErrorMessageFunctions: GetErrorMessageFunctions;
     render: (component: StepComponent) => JSX.Element;
     httpClient: HttpClient;
     trackEvent: AnalyticsEventDispatcher;
     logEvent: LoggingEventDispatcher;
-    triggerSubmission: (action: Action, model: Model) => Promise<void>;
+    triggerSubmission: (action: Action, model: Model, localValue: LocalValue) => Promise<void>;
     triggerRefresh: (props: {
         refreshUrl: string;
         model: Model;
@@ -18,5 +20,5 @@ type StepProps = {
         schemaId: string | undefined;
     }) => Promise<void>;
 };
-declare function Step({ localValue, step, displayStepTitle, render, httpClient, trackEvent, logEvent, triggerSubmission, triggerRefresh, }: StepProps): JSX.Element;
+declare function Step({ localValue: initialLocalValue, step, displayStepTitle, getErrorMessageFunctions, render, httpClient, trackEvent, logEvent, triggerSubmission, triggerRefresh, }: StepProps): JSX.Element;
 export default Step;

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

@@ -16,5 +16,5 @@ export declare const respondWithDelay: (data: unknown, delayMs: number, init?: R
 export declare const respondWithEtag: (step: Step) => Promise<Response>;
 export declare const respondWithEmptyOk: () => Promise<Response>;
 export declare const respondWithEmptyAndEtag: (step: Step) => Promise<Response>;
-export declare const abortableDelay: (delayMs: number, signal: AbortSignal | null | undefined) => Promise<unknown>;
+export declare const abortableDelay: (delayMs: number, signal: AbortSignal | null | undefined) => Promise<void>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wise/dynamic-flow-client",
-  "version": "3.0.0",
+  "version": "3.0.2",
   "description": "Dynamic Flow web client",
   "license": "Apache-2.0",
   "main": "./build/main.min.js",
@@ -91,7 +91,7 @@
     "classnames": "2.5.1",
     "react-webcam": "^7.2.0",
     "screenfull": "^5.2.0",
-    "@wise/dynamic-flow-types": "2.6.7"
+    "@wise/dynamic-flow-types": "2.7.0"
   },
   "scripts": {
     "dev": "storybook dev -p 3003",