@wise/dynamic-flow-client 2.9.1 → 2.9.2

package/build/types/legacy/common/utils/schema-utils.d.ts

@@ -22,4 +22,4 @@ export declare function isFileUploadSchema(schema: {
     format?: string;
 }): schema is FileUploadSchema;
 export declare const isMultipleFileUploadSchema: (schema: Schema) => schema is MultipleFileUploadSchema;
-export declare const getSchemaType: (schema: Schema) => "array" | "object" | "allOf" | "persistAsync" | "oneOf" | "readOnly" | "validationAsync" | "promotedOneOf" | "basic" | null;
+export declare const getSchemaType: (schema: Schema) => "allOf" | "persistAsync" | "array" | "object" | "oneOf" | "readOnly" | "validationAsync" | "promotedOneOf" | "basic" | null;

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

@@ -1,10 +1,10 @@
-import { SearchResult } from '@wise/dynamic-flow-types';
+import type { SearchResult } from '@wise/dynamic-flow-types';
 export type SearchResultsProps = {
     results: SearchResult[];
     emptyMessage: string;
     onSelect: (result: SearchResult) => void;
 };
-export declare const SearchResults: ({ results, emptyMessage, onSelect }: SearchResultsProps) => JSX.Element;
-export declare const ErrorResult: ({ onRetrySearch }: {
+export declare function SearchResults({ results, emptyMessage, onSelect }: SearchResultsProps): JSX.Element;
+export declare function ErrorResult({ onRetrySearch }: {
     onRetrySearch: () => void;
-}) => JSX.Element;
+}): JSX.Element;

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

@@ -1,6 +1,6 @@
 import type { SearchConfig, SearchResult } from '@wise/dynamic-flow-types';
 export declare const useSearch: (defaultSearchConfig: SearchConfig) => {
-    status: "error" | "success" | "loading" | "idle";
+    status: "success" | "loading" | "error" | "idle";
     results: SearchResult[];
     search: (query: string, { url, method, param }?: SearchConfig) => Promise<void>;
 };

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

@@ -6,10 +6,11 @@ export type AllOfComponent = BaseComponent<Model> & {
     control?: string;
     description?: string;
     help?: string;
+    hidden: boolean;
     title?: string;
     getChildren: () => StepComponent[];
 };
-export declare const createAllOfComponent: (allOfProps: Pick<AllOfComponent, "control" | "title" | "description" | "help" | "components"> & {
+export declare const createAllOfComponent: (allOfProps: Pick<AllOfComponent, "description" | "help" | "hidden" | "title" | "control" | "components"> & {
     uid: string;
     analyticsId?: string | undefined;
     summariser: (value: Model | null) => RepeatableSummary;

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

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

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

@@ -0,0 +1,9 @@
+import type { Model } from '@wise/dynamic-flow-types/build/next';
+import type { BaseComponent, RepeatableSummary } from '../types';
+export type ConstComponent = BaseComponent<Model> & {
+    type: 'const';
+};
+export declare const createConstComponent: (hiddenProps: Pick<ConstComponent, "analyticsId" | "uid"> & {
+    value: Model;
+    summary: RepeatableSummary;
+}) => ConstComponent;

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

@@ -6,7 +6,7 @@ export type DateInputComponent = InputComponent<string> & {
     minimumDate?: string;
     maximumDate?: string;
 };
-export declare const createDateInputComponent: (textInputProps: Pick<DateInputComponent, "value" | "control" | "title" | "description" | "id" | "disabled" | "analyticsId" | "placeholder" | "required" | "errors" | "autoComplete" | "minimumDate" | "maximumDate" | "uid"> & {
+export declare const createDateInputComponent: (textInputProps: Pick<DateInputComponent, "analyticsId" | "description" | "disabled" | "help" | "hidden" | "title" | "placeholder" | "control" | "id" | "errors" | "required" | "value" | "autoComplete" | "minimumDate" | "maximumDate" | "uid"> & {
     checks: IsInvalidCheck<string | null>[];
     performPersistAsync: PerformPersistAsync | undefined;
     summariser: (value: string | null) => RepeatableSummary;

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

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

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

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

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

@@ -6,10 +6,11 @@ export type ObjectComponent = BaseComponent<Record<string, Model>> & {
     control?: string;
     description?: string;
     help?: string;
+    hidden: boolean;
     title?: string;
     getChildren: () => StepComponent[];
 };
-export declare const createObjectComponent: (objectProps: Pick<ObjectComponent, "control" | "title" | "description" | "help" | "componentMap"> & {
+export declare const createObjectComponent: (objectProps: Pick<ObjectComponent, "description" | "help" | "hidden" | "title" | "control" | "componentMap"> & {
     uid: string;
     analyticsId?: string | undefined;
     displayOrder: string[];

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

@@ -20,7 +20,7 @@ export type SelectInputOption = {
     keywords?: string[];
     disabled: boolean;
 };
-export declare const createSelectInputComponent: (selectProps: Pick<SelectInputComponent, "control" | "title" | "description" | "id" | "disabled" | "help" | "analyticsId" | "placeholder" | "required" | "errors" | "autoComplete" | "uid"> & {
+export declare const createSelectInputComponent: (selectProps: Pick<SelectInputComponent, "analyticsId" | "description" | "disabled" | "help" | "hidden" | "title" | "placeholder" | "control" | "id" | "errors" | "required" | "autoComplete" | "uid"> & {
     initialValue: Model;
     options: (SelectInputOption & {
         component: StepComponent;

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

@@ -5,7 +5,7 @@ export type TextInputComponent = InputComponent<string> & {
     type: 'text';
     displayFormat?: string;
 };
-export declare const createTextInputComponent: (textInputProps: Pick<TextInputComponent, "value" | "control" | "title" | "description" | "id" | "disabled" | "help" | "analyticsId" | "placeholder" | "required" | "displayFormat" | "errors" | "autoComplete" | "uid"> & {
+export declare const createTextInputComponent: (textInputProps: Pick<TextInputComponent, "analyticsId" | "description" | "disabled" | "help" | "hidden" | "title" | "placeholder" | "control" | "displayFormat" | "id" | "errors" | "required" | "value" | "autoComplete" | "uid"> & {
     checks: IsInvalidCheck<string | null>[];
     performPersistAsync: PerformPersistAsync | undefined;
     summariser: (value: string | null) => RepeatableSummary;

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

@@ -5,7 +5,7 @@ export type UploadInputComponent = InputComponent<string> & {
     type: 'upload';
     accepts?: string[];
 };
-export declare const createUploadInputComponent: (uploadInputProps: Pick<UploadInputComponent, "value" | "control" | "title" | "description" | "id" | "disabled" | "accepts" | "analyticsId" | "placeholder" | "required" | "errors" | "autoComplete" | "uid"> & {
+export declare const createUploadInputComponent: (uploadInputProps: Pick<UploadInputComponent, "analyticsId" | "description" | "disabled" | "help" | "hidden" | "title" | "placeholder" | "control" | "id" | "errors" | "required" | "value" | "accepts" | "autoComplete" | "uid"> & {
     checks: IsInvalidCheck<string | null>[];
     performPersistAsync: PerformPersistAsync | undefined;
     summariser: (value: string | null) => RepeatableSummary;

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

@@ -22,7 +22,7 @@ export type RepeatableComponent = BaseComponent<Model[]> & {
     onRemove: () => void;
     onSave: () => boolean;
 };
-export declare const createRepeatableComponent: (repeatableProps: Pick<RepeatableComponent, "control" | "title" | "description" | "id" | "components" | "addItemTitle" | "editItemTitle" | "errors" | "uid"> & {
+export declare const createRepeatableComponent: (repeatableProps: Pick<RepeatableComponent, "description" | "title" | "control" | "id" | "errors" | "components" | "addItemTitle" | "editItemTitle" | "uid"> & {
     analyticsId?: string | undefined;
     checks: IsInvalidCheck<Model[] | null>[];
     summary?: SummarySummariser | undefined;

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

@@ -11,5 +11,5 @@ type Persistable = BooleanInputComponent | DateInputComponent | IntegerInputComp
 /**
  * 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 declare const getComponentPersistAsync: <C extends Persistable>(update: (updateFn: (component: C) => void) => void, performPersistAsync: PerformPersistAsync) => (component: C) => Promise<import("@wise/dynamic-flow-types/build/next").JsonElement>;
 export {};

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

@@ -1,7 +1,7 @@
 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';
+import type { AnalyticsEventDispatcher, LoggingEventDispatcher } from '../events';
 export type PerformPersistAsync = (props: PersistAsyncProps) => Promise<JsonElement>;
 type PersistAsyncModel = Model | Blob;
 type PersistAsyncProps = {
@@ -12,11 +12,12 @@ type PersistAsyncProps = {
  * 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;
+export declare const getPerformPersistAsync: ({ genericErrorMessage, httpClient, persistAsyncConfig, schemaId, logEvent, trackEvent, }: {
+    genericErrorMessage: string;
     httpClient: HttpClient;
-    trackEvent: AnalyticsEventDispatcher;
     persistAsyncConfig: PersistAsyncConfig;
-    genericErrorMessage: string;
+    schemaId?: string | undefined;
+    logEvent: LoggingEventDispatcher;
+    trackEvent: AnalyticsEventDispatcher;
 }) => PerformPersistAsync;
 export {};

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

@@ -2,4 +2,4 @@ import type { SchemaMapperProps } from './types';
 import type { ConstSchema } from '@wise/dynamic-flow-types/build/next';
 export declare const constSchemaToComponent: (schemaMapperProps: SchemaMapperProps & {
     schema: ConstSchema;
-}) => import("../../components/HiddenComponent").HiddenComponent;
+}) => import("../../components/ConstComponent").ConstComponent;

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

@@ -9,6 +9,7 @@ export declare const mapCommonSchemaProps: (schemaMapperProps: SchemaMapperProps
     description: string | undefined;
     disabled: boolean;
     errors: string[];
+    hidden: boolean;
     keywords: string[] | undefined;
     required: boolean;
     title: string | undefined;

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

@@ -1,5 +1,5 @@
 import type { Action, Icon, Image, Margin, Model } from '@wise/dynamic-flow-types/build/next';
-import type { HiddenComponent } from './components/HiddenComponent';
+import type { ConstComponent } from './components/ConstComponent';
 import type { AlertComponent } from './components/AlertComponent';
 import type { AllOfComponent } from './components/AllOfComponent';
 import type { BooleanInputComponent } from './components/BooleanInputComponent';
@@ -28,12 +28,12 @@ import type { SelectInputComponent } from './components/SelectInputComponent';
 import type { StatusListComponent } from './components/StatusListComponent';
 import type { TextInputComponent } from './components/TextInputComponent';
 import type { UploadInputComponent } from './components/UploadInputComponent';
-export type StepComponent = AlertComponent | AllOfComponent | BooleanInputComponent | BoxComponent | ButtonComponent | ColumnsComponent | ContainerComponent | DateInputComponent | DecisionComponent | DividerComponent | FormComponent | HeadingComponent | HiddenComponent | ImageComponent | InstructionsComponent | IntegerInputComponent | LoadingIndicatorComponent | MarkdownComponent | ModalComponent | NumberInputComponent | ObjectComponent | ParagraphComponent | RepeatableComponent | ReviewComponent | SearchComponent | SelectInputComponent | StatusListComponent | TextInputComponent | UploadInputComponent;
+export type StepComponent = AlertComponent | AllOfComponent | BooleanInputComponent | BoxComponent | ButtonComponent | ColumnsComponent | ConstComponent | ContainerComponent | DateInputComponent | DecisionComponent | DividerComponent | FormComponent | HeadingComponent | ImageComponent | InstructionsComponent | IntegerInputComponent | LoadingIndicatorComponent | MarkdownComponent | ModalComponent | NumberInputComponent | ObjectComponent | ParagraphComponent | RepeatableComponent | ReviewComponent | SearchComponent | SelectInputComponent | StatusListComponent | TextInputComponent | UploadInputComponent;
 export type BaseComponent<M extends Model> = {
     type: string;
     uid: string;
     analyticsId?: string;
-    getSubmittableValue: () => M | null;
+    getSubmittableValue: () => Promise<Model>;
     getLocalValue: () => M | null;
     getSummary: () => RepeatableSummary;
     validate: () => boolean;
@@ -55,13 +55,14 @@ export type InputComponent<M extends Model> = BaseComponent<M> & {
     title?: string;
     value: M | null;
     persistedState: PersistedState<M>;
+    hidden: boolean;
     onChange: (value: M | null) => void;
     onBlur: () => void;
     onFocus: () => void;
     getLocalValue: () => M | null;
 };
 export type UpdateComponent = (id: string, update: (component: StepComponent) => void) => void;
-export type OnAction = (action: Action) => void;
+export type OnAction = (action: Action) => Promise<void>;
 export type Align = 'start' | 'center' | 'end';
 export type Bias = 'none' | 'start' | 'end';
 export type Context = 'positive' | 'negative' | 'warning' | 'neutral';
@@ -74,6 +75,5 @@ export type RepeatableSummary = {
 export type PersistedState<M extends Model> = {
     abortController: AbortController;
     lastSubmitted: M | null;
-    submission: Promise<void>;
-    value: M | null;
+    submission: Promise<Model>;
 };

package/build/types/revamp/step/submission/getPerformAction.d.ts

@@ -0,0 +1,12 @@
+import type { Action, JsonElement, Model } from '@wise/dynamic-flow-types/build/next';
+import type { HttpClient } from '../../dynamic-flow-types';
+import type { AnalyticsEventDispatcher } from '../../domain/features/events';
+export declare const getPerformAction: ({ httpClient, errorMessage, trackEvent, locale, }: {
+    httpClient: HttpClient;
+    errorMessage: string;
+    trackEvent: AnalyticsEventDispatcher;
+    locale: string;
+}) => ({ action, model }: {
+    action: Action;
+    model: Model;
+}) => Promise<JsonElement>;

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

@@ -1,4 +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 getSubmittableData: (components: StepComponent[]) => Promise<Model>;
 export declare const getLocalValues: (components: StepComponent[]) => Model;

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

@@ -10,6 +10,9 @@ export declare const hasChildren: (component: StepComponent) => component is Ste
     getChildren: () => StepComponent[];
 };
 export declare const isColumnsComponent: (component: StepComponent) => component is ColumnsComponent;
+export declare const isHiddenComponent: (component: StepComponent) => component is StepComponent & {
+    hidden: true;
+};
 export declare const isRepeatableComponent: (component: StepComponent) => component is RepeatableComponent;
 export declare const isObjectModel: (model: Model) => model is Record<string, import("@wise/dynamic-flow-types/build/next").JsonElement>;
 export declare const isArrayModel: (model: Model) => model is import("@wise/dynamic-flow-types/build/next").JsonElement[];
@@ -24,7 +27,4 @@ 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

@@ -12,6 +12,7 @@ type HttpClient = typeof fetch;
  */
 export declare const getMockHttpClient: (handlers: Record<string, HttpClient | undefined>) => HttpClient;
 export declare const respondWith: (data: unknown, init?: ResponseInit) => Promise<Response>;
+export declare const respondWithDelay: (data: unknown, delayMs: number, 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.9.1",
+  "version": "2.9.2",
   "description": "Dynamic Flow web client",
   "license": "Apache-2.0",
   "main": "./build/main.min.js",
@@ -92,7 +92,7 @@
     "classnames": "2.5.1",
     "react-webcam": "^7.2.0",
     "screenfull": "^5.2.0",
-    "@wise/dynamic-flow-types": "2.6.3"
+    "@wise/dynamic-flow-types": "2.6.4"
   },
   "scripts": {
     "dev": "storybook dev -p 3003",

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

@@ -1,9 +0,0 @@
-import type { Model } from '@wise/dynamic-flow-types/build/next';
-import type { BaseComponent, RepeatableSummary } from '../types';
-export type HiddenComponent = BaseComponent<Model> & {
-    type: 'hidden';
-};
-export declare const createHiddenComponent: (hiddenProps: Pick<HiddenComponent, "analyticsId" | "uid"> & {
-    value: Model;
-    summary: RepeatableSummary;
-}) => HiddenComponent;

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

@@ -1,7 +0,0 @@
-import { Schema } from '@wise/dynamic-flow-types/build/next';
-import { SchemaMapperProps } from './types';
-export declare const hiddenSchemaToComponent: (schemaMapperProps: SchemaMapperProps & {
-    schema: Schema & {
-        hidden: true;
-    };
-}) => import("../../components/HiddenComponent").HiddenComponent;