@wise/dynamic-flow-client 2.8.14 → 2.8.15

package/build/types/common/messages/persist-async.messages.d.ts

@@ -0,0 +1,8 @@
+declare const _default: {
+    genericError: {
+        id: string;
+        defaultMessage: string;
+        description: string;
+    };
+};
+export default _default;

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

@@ -1,9 +1,11 @@
 import type { InputComponent, RepeatableSummary, UpdateComponent } from '../types';
 import type { IsInvalidCheck } from '../features/validation/value-checks';
+import type { PerformPersistAsync } from '../features/persistAsync/getPerformPersistAsync';
 export type BooleanInputComponent = InputComponent<boolean> & {
     type: 'boolean';
 };
 export declare const createBooleanInputComponent: (booleanInputProps: Pick<BooleanInputComponent, "analyticsId" | "description" | "disabled" | "help" | "title" | "control" | "id" | "errors" | "required" | "value" | "uid"> & {
     checks: IsInvalidCheck<boolean | null>[];
+    performPersistAsync: PerformPersistAsync | undefined;
     summariser: (value: boolean | null) => RepeatableSummary;
 }, updateComponent: UpdateComponent) => BooleanInputComponent;

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

@@ -1,3 +1,4 @@
+import type { PerformPersistAsync } from '../features/persistAsync/getPerformPersistAsync';
 import type { IsInvalidCheck } from '../features/validation/value-checks';
 import type { InputComponent, RepeatableSummary, UpdateComponent } from '../types';
 export type DateInputComponent = InputComponent<string> & {
@@ -7,5 +8,6 @@ export type DateInputComponent = InputComponent<string> & {
 };
 export declare const createDateInputComponent: (textInputProps: Pick<DateInputComponent, "analyticsId" | "description" | "disabled" | "title" | "placeholder" | "control" | "id" | "errors" | "required" | "value" | "autoComplete" | "minimumDate" | "maximumDate" | "uid"> & {
     checks: IsInvalidCheck<string | null>[];
+    performPersistAsync: PerformPersistAsync | undefined;
     summariser: (value: string | null) => RepeatableSummary;
 }, updateComponent: UpdateComponent) => DateInputComponent;

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

@@ -1,9 +1,11 @@
 import type { InputComponent, RepeatableSummary, UpdateComponent } from '../types';
 import type { IsInvalidCheck } from '../features/validation/value-checks';
+import type { PerformPersistAsync } from '../features/persistAsync/getPerformPersistAsync';
 export type IntegerInputComponent = InputComponent<number> & {
     type: 'integer';
 };
 export declare const createIntegerInputComponent: (integerInputProps: Pick<IntegerInputComponent, "analyticsId" | "description" | "disabled" | "help" | "title" | "placeholder" | "control" | "id" | "errors" | "required" | "value" | "autoComplete" | "uid"> & {
     checks: IsInvalidCheck<number | null>[];
+    performPersistAsync: PerformPersistAsync | undefined;
     summariser: (value: number | null) => RepeatableSummary;
 }, updateComponent: UpdateComponent) => IntegerInputComponent;

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

@@ -1,9 +1,11 @@
 import type { InputComponent, RepeatableSummary, UpdateComponent } from '../types';
 import type { IsInvalidCheck } from '../features/validation/value-checks';
+import type { PerformPersistAsync } from '../features/persistAsync/getPerformPersistAsync';
 export type NumberInputComponent = InputComponent<number> & {
     type: 'number';
 };
 export declare const createNumberInputComponent: (numberInputProps: Pick<NumberInputComponent, "analyticsId" | "description" | "disabled" | "help" | "title" | "placeholder" | "control" | "id" | "errors" | "required" | "value" | "autoComplete" | "uid"> & {
     checks: IsInvalidCheck<number | null>[];
+    performPersistAsync: PerformPersistAsync | undefined;
     summariser: (value: number | null) => RepeatableSummary;
 }, updateComponent: UpdateComponent) => NumberInputComponent;

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

@@ -2,6 +2,7 @@ import type { Icon, Image, Model } from '@wise/dynamic-flow-types/build/next';
 import type { InputComponent, RepeatableSummary, StepComponent, UpdateComponent } from '../types';
 import type { IsInvalidCheck } from '../features/validation/value-checks';
 import type { AnalyticsEventDispatcher } from '../features/events';
+import type { PerformPersistAsync } from '../features/persistAsync/getPerformPersistAsync';
 export type SelectInputComponent = Omit<InputComponent<Model>, 'onChange'> & {
     type: 'select';
     selectedIndex: number | null;
@@ -25,6 +26,7 @@ export declare const createSelectInputComponent: (selectProps: Pick<SelectInputC
         component: StepComponent;
     })[];
     checks: IsInvalidCheck<Model>[];
+    performPersistAsync: PerformPersistAsync | undefined;
     summariser: (value: Model | null) => RepeatableSummary;
     trackEvent: AnalyticsEventDispatcher;
 }, updateComponent: UpdateComponent) => SelectInputComponent;

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

@@ -1,10 +1,12 @@
 import type { IsInvalidCheck } from '../features/validation/value-checks';
 import type { InputComponent, RepeatableSummary, UpdateComponent } from '../types';
+import type { PerformPersistAsync } from '../features/persistAsync/getPerformPersistAsync';
 export type TextInputComponent = InputComponent<string> & {
     type: 'text';
     displayFormat?: string;
 };
 export declare const createTextInputComponent: (textInputProps: Pick<TextInputComponent, "analyticsId" | "description" | "disabled" | "help" | "title" | "placeholder" | "control" | "displayFormat" | "id" | "errors" | "required" | "value" | "autoComplete" | "uid"> & {
     checks: IsInvalidCheck<string | null>[];
+    performPersistAsync: PerformPersistAsync | undefined;
     summariser: (value: string | null) => RepeatableSummary;
 }, updateComponent: UpdateComponent) => TextInputComponent;

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

@@ -1,10 +1,12 @@
 import type { IsInvalidCheck } from '../features/validation/value-checks';
 import type { InputComponent, RepeatableSummary, UpdateComponent } from '../types';
+import type { PerformPersistAsync } from '../features/persistAsync/getPerformPersistAsync';
 export type UploadInputComponent = InputComponent<string> & {
     type: 'upload';
     accepts?: string[];
 };
 export declare const createUploadInputComponent: (uploadInputProps: Pick<UploadInputComponent, "analyticsId" | "description" | "disabled" | "title" | "placeholder" | "control" | "id" | "errors" | "required" | "value" | "accepts" | "autoComplete" | "uid"> & {
     checks: IsInvalidCheck<string | null>[];
+    performPersistAsync: PerformPersistAsync | undefined;
     summariser: (value: string | null) => RepeatableSummary;
 }, updateComponent: UpdateComponent) => UploadInputComponent;

package/build/types/revamp/domain/components/repeatableComponent/RepeatableComponent.d.ts

@@ -16,7 +16,7 @@ export type RepeatableComponent = BaseComponent<Model[]> & {
     summaryDefaults: RepeatableSummary;
     title?: string;
     getChildren: () => StepComponent[];
-    getValue: () => Model[] | null;
+    getLocalValue: () => Model[] | null;
     onAdd: () => void;
     onEdit: (itemIndex: number) => void;
     onRemove: () => void;

package/build/types/revamp/domain/features/persistAsync/getComponentPersistAsync.d.ts

@@ -0,0 +1,15 @@
+import type { getInputUpdateFunction } from '../../components/utils/component-utils';
+import type { PerformPersistAsync } from './getPerformPersistAsync';
+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 { SelectInputComponent } from '../../components/SelectInputComponent';
+import type { TextInputComponent } from '../../components/TextInputComponent';
+import type { UploadInputComponent } from '../../components/UploadInputComponent';
+type Persistable = BooleanInputComponent | DateInputComponent | IntegerInputComponent | NumberInputComponent | SelectInputComponent | TextInputComponent | UploadInputComponent;
+/**
+ * Creates an onPersistAsync handler for a component.
+ */
+export declare const getComponentPersistAsync: <C extends Persistable>(update: (updateFn: (component: C) => void) => void, performPersistAsync: PerformPersistAsync) => (component: C) => void;
+export {};

package/build/types/revamp/domain/features/persistAsync/getPerformPersistAsync.d.ts

@@ -0,0 +1,22 @@
+import type { JsonElement, Model } from '@wise/dynamic-flow-types/build/next';
+import type { PersistAsyncConfig } from '../../mappers/types';
+import type { HttpClient } from '../../../dynamic-flow-types';
+import type { AnalyticsEventDispatcher } from '../events';
+export type PerformPersistAsync = (props: PersistAsyncProps) => Promise<JsonElement>;
+type PersistAsyncModel = Model | Blob;
+type PersistAsyncProps = {
+    value: PersistAsyncModel;
+    signal: AbortSignal;
+};
+/**
+ * Takes an httpClient and schema persist async config and returns a function that can
+ * execute a persist async request.
+ */
+export declare const getPerformPersistAsync: ({ schemaId, httpClient, trackEvent, persistAsyncConfig, genericErrorMessage, }: {
+    schemaId?: string | undefined;
+    httpClient: HttpClient;
+    trackEvent: AnalyticsEventDispatcher;
+    persistAsyncConfig: PersistAsyncConfig;
+    genericErrorMessage: string;
+}) => PerformPersistAsync;
+export {};

package/build/types/revamp/domain/features/persistAsync/persist-async-utils.d.ts

@@ -0,0 +1,2 @@
+import type { PersistedState } from '../../types';
+export declare const getInitialPersistedState: <M extends import("@wise/dynamic-flow-types/build/next").JsonElement>() => PersistedState<M>;

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

@@ -10,4 +10,5 @@ export declare const mockErrorMessageFunctions: {
     maxItems: jest.Mock<any, any, any>;
     pattern: jest.Mock<any, any, any>;
     required: jest.Mock<any, any, any>;
+    persistAsyncError: jest.Mock<any, any, any>;
 };

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

@@ -0,0 +1,7 @@
+import type { StepComponent } from '../../types';
+import type { IsInvalidCheck } from './value-checks';
+export declare const validateComponents: (components: StepComponent[]) => boolean;
+/**
+ * Returns a function that takes a model and returns an array of validation errors
+ */
+export declare const getModelValidator: <M extends import("@wise/dynamic-flow-types/build/next").JsonElement>(checks: IsInvalidCheck<M>[]) => (currentValue: M) => string[];

package/build/types/revamp/domain/mappers/schema/tests/test-utils.d.ts

@@ -18,6 +18,7 @@ export declare const getMockSchemaMapperProps: <S extends Schema>(schemaMapperPr
     model: import("@wise/dynamic-flow-types/build/next").JsonElement;
     required: boolean;
     validationErrors: import("@wise/dynamic-flow-types/build/next").JsonElement;
+    persistAsyncConfig?: import("../../types").PersistAsyncConfig | undefined;
 };
 export declare const mockUpdateFunction: <C extends StepComponent>(draftComponent: C) => jest.Mock<any, any, any>;
 export declare const getUpdateFunctionMock: <C extends StepComponent>(getComponent: () => C) => jest.Mock<void, [uid: string, update: (component: StepComponent) => void], any>;

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

@@ -1,6 +1,6 @@
 import type { Step as DFStep, Model, Schema, ValidationError } from '@wise/dynamic-flow-types/build/next';
 import type { OnAction, UpdateComponent } from '../../types';
-import type { GetErrorMessageFunctions } from '../types';
+import type { GetErrorMessageFunctions, PersistAsyncConfig } from '../types';
 import type { AnalyticsEventDispatcher, LoggingEventDispatcher } from '../../features/events';
 import type { HttpClient } from '../../../dynamic-flow-types';
 export type MapperProps = {
@@ -17,4 +17,5 @@ export type SchemaMapperProps = {
     model: Model;
     required?: boolean;
     validationErrors?: ValidationError;
+    persistAsyncConfig?: PersistAsyncConfig;
 };

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

@@ -1,6 +1,18 @@
-import type { SchemaMapperProps } from '../types';
-export declare const mapCommonSchemaProps: ({ schema, required, validationErrors }: SchemaMapperProps) => {
+import type { MapperProps, SchemaMapperProps } from '../types';
+export declare const mapCommonSchemaProps: (schemaMapperProps: SchemaMapperProps, mapperProps: MapperProps) => {
+    placeholder?: string | undefined;
+    help?: string | undefined;
+    uid: string;
+    id: string;
+    analyticsId: string;
+    control: string | undefined;
+    description: string | undefined;
+    disabled: boolean;
+    errors: string[];
+    keywords: string[] | undefined;
     required: boolean;
+    title: string | undefined;
+    performPersistAsync: import("../../../features/persistAsync/getPerformPersistAsync").PerformPersistAsync | undefined;
     summariser: (model: import("@wise/dynamic-flow-types/build/next").JsonElement) => {
         title?: undefined;
         description?: undefined;
@@ -12,15 +24,4 @@ export declare const mapCommonSchemaProps: ({ schema, required, validationErrors
         icon: import("@wise/dynamic-flow-types/build/next").Icon | undefined;
         image: import("@wise/dynamic-flow-types/build/next").Image | undefined;
     };
-    title: string | undefined;
-    placeholder?: string | undefined;
-    keywords: string[] | undefined;
-    help?: string | undefined;
-    uid: string;
-    id: string;
-    analyticsId: string;
-    control: string | undefined;
-    description: string | undefined;
-    disabled: boolean;
-    errors: string[];
 };

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

@@ -1,3 +1,4 @@
+import type { PersistAsync } from '@wise/dynamic-flow-types/build/next/feature/PersistAsync';
 export type GetErrorMessageFunctions = (validationMessages?: ValidationMessages) => ErrorMessageFunctions;
 export type ValidationMessages = Record<string, string | undefined>;
 export type ErrorMessageFunctions = {
@@ -11,4 +12,6 @@ export type ErrorMessageFunctions = {
     minItems: (minItems: number) => string;
     pattern: () => string;
     required: () => string;
+    persistAsyncError: () => string;
 };
+export type PersistAsyncConfig = Pick<PersistAsync, 'idProperty' | 'method' | 'param' | 'url'>;

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

@@ -12,13 +12,13 @@ import type { DecisionComponent } from './components/DecisionComponent';
 import type { FormComponent } from './components/FormComponent';
 import type { DividerComponent } from './components/DividerComponent';
 import type { HeadingComponent } from './components/HeadingComponent';
-import type { ImageComponent } from './components/ImageComponent';
-import type { InstructionsComponent } from './components/InstructionsComponent';
 import type { IntegerInputComponent } from './components/IntegerInputComponent';
+import type { NumberInputComponent } from './components/NumberInputComponent';
+import type { ImageComponent } from './components/ImageComponent';
 import type { LoadingIndicatorComponent } from './components/LoadingIndicatorComponent';
 import type { MarkdownComponent } from './components/MarkdownComponent';
+import type { InstructionsComponent } from './components/InstructionsComponent';
 import type { ModalComponent } from './components/ModalComponent';
-import type { NumberInputComponent } from './components/NumberInputComponent';
 import type { ObjectComponent } from './components/ObjectComponent';
 import type { ParagraphComponent } from './components/ParagraphComponent';
 import type { RepeatableComponent } from './components/repeatableComponent/RepeatableComponent';
@@ -32,7 +32,8 @@ export type BaseComponent<M extends Model> = {
     type: string;
     uid: string;
     analyticsId?: string;
-    getValue: () => M | null;
+    getSubmittableValue: () => M | null;
+    getLocalValue: () => M | null;
     getSummary: () => RepeatableSummary;
     validate: () => boolean;
 };
@@ -52,10 +53,11 @@ export type InputComponent<M extends Model> = BaseComponent<M> & {
     required: boolean;
     title?: string;
     value: M | null;
+    persistedState: PersistedState<M>;
     onChange: (value: M | null) => void;
     onBlur: () => void;
     onFocus: () => void;
-    getValue: () => M | null;
+    getLocalValue: () => M | null;
 };
 export type UpdateComponent = (id: string, update: (component: StepComponent) => void) => void;
 export type OnAction = (action: Action) => void;
@@ -68,3 +70,9 @@ export type RepeatableSummary = {
     icon?: Icon;
     image?: Image;
 };
+export type PersistedState<M extends Model> = {
+    abortController: AbortController;
+    lastSubmitted: M | null;
+    submission: Promise<void>;
+    value: M | null;
+};

package/build/types/revamp/utils/{getSubmittableData.d.ts → component-utils.d.ts}

@@ -1,3 +1,4 @@
 import type { Model } from '@wise/dynamic-flow-types/build/next';
 import type { StepComponent } from '../domain/types';
 export declare const getSubmittableData: (components: StepComponent[]) => Model;
+export declare const getLocalValues: (components: StepComponent[]) => Model;

package/build/types/revamp/utils/type-utils.d.ts

@@ -1,7 +1,11 @@
-import type { AllOfSchema, ArraySchema, ArraySchemaList, BooleanSchema, ConstSchema, IntegerSchema, Model, NumberSchema, ObjectSchema, OneOfSchema, Schema, StringSchema } from '@wise/dynamic-flow-types/build/next';
+import type { AllOfSchema, ArraySchema, ArraySchemaList, ArraySchemaTuple, BooleanSchema, ConstSchema, IntegerSchema, Model, NumberSchema, ObjectSchema, OneOfSchema, Schema, StringSchema } from '@wise/dynamic-flow-types/build/next';
 import type { StepComponent } from '../domain/types';
 import type { ColumnsComponent } from '../domain/components/ColumnsComponent';
 import type { RepeatableComponent } from '../domain/components/repeatableComponent/RepeatableComponent';
+import type { PersistAsync } from '@wise/dynamic-flow-types/build/next/feature/PersistAsync';
+type SchemaWithPersistAsync = (ArraySchemaList | ArraySchemaTuple | BooleanSchema | IntegerSchema | NumberSchema | StringSchema) & {
+    persistAsync: PersistAsync;
+};
 export declare const hasChildren: (component: StepComponent) => component is StepComponent & {
     getChildren: () => StepComponent[];
 };
@@ -19,6 +23,8 @@ export declare const isOneOfSchema: (schema: Schema) => schema is OneOfSchema;
 export declare const isArraySchema: (schema: Schema) => schema is ArraySchema;
 export declare const isArrayListSchema: (schema: Schema) => schema is ArraySchemaList;
 export declare const isStringSchema: (schema: Schema) => schema is StringSchema;
+export declare const isSchemaWithPersistAsync: (schema: Schema) => schema is SchemaWithPersistAsync;
 export declare const isHiddenSchema: (schema: Schema) => schema is Schema & {
     hidden: true;
 };
+export {};

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

@@ -1,4 +1,4 @@
-import type { ActionResponseBody, Step } from '@wise/dynamic-flow-types';
+import type { Step } from '@wise/dynamic-flow-types';
 type HttpClient = typeof fetch;
 /**
  * Returns a mock http client you can use in your DynamicFlow.
@@ -11,7 +11,7 @@ type HttpClient = typeof fetch;
  * })
  */
 export declare const getMockHttpClient: (handlers: Record<string, HttpClient | undefined>) => HttpClient;
-export declare const respondWith: (step: Step | ActionResponseBody | Record<string, unknown>, init?: ResponseInit) => Promise<Response>;
+export declare const respondWith: (data: unknown, init?: ResponseInit) => Promise<Response>;
 export declare const respondWithEtag: (step: Step) => Promise<Response>;
 export declare const respondWithEmptyOk: () => Promise<Response>;
 export declare const respondWithEmptyAndEtag: (step: Step) => Promise<Response>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wise/dynamic-flow-client",
-  "version": "2.8.14",
+  "version": "2.8.15",
   "description": "Dynamic Flow web client",
   "license": "Apache-2.0",
   "main": "./build/main.min.js",

package/build/types/legacy/jsonSchemaForm/persistAsyncSchema/PersistAsyncSchema.messages.d.ts

@@ -1,8 +0,0 @@
-declare namespace _default {
-    namespace genericError {
-        const id: string;
-        const defaultMessage: string;
-        const description: string;
-    }
-}
-export default _default;

package/build/types/revamp/domain/features/validation/getModelValidationErrors.d.ts

@@ -1,5 +0,0 @@
-import type { IsInvalidCheck } from './value-checks';
-export declare const getModelValidationErrors: <M extends import("@wise/dynamic-flow-types/build/next").JsonElement>({ checks, model, }: {
-    checks: IsInvalidCheck<M>[];
-    model: M;
-}) => string[];

package/build/types/revamp/domain/features/validation/validateComponents.d.ts

@@ -1,2 +0,0 @@
-import type { StepComponent } from '../../types';
-export declare const validateComponents: (components: StepComponent[]) => boolean;

package/build/types/revamp/domain/validation/validation-functions.d.ts

@@ -1,7 +0,0 @@
-import type { StepComponent } from '../types';
-import type { IsInvalidCheck } from '../features/validation/value-checks';
-export declare const validateComponents: (components: StepComponent[]) => boolean;
-export declare const getModelValidationErrors: <M extends import("@wise/dynamic-flow-types/build/next").JsonElement>({ checks, model, }: {
-    checks: IsInvalidCheck<M>[];
-    model: M;
-}) => string[];