@wise/dynamic-flow-client 1.0.2 → 1.2.0

package/build/types/common/utils/step-utils.d.ts

@@ -1,7 +1,3 @@
 import { Schema, Step } from '../../types';
-export declare const stepType: {
-    LAYOUT: string;
-    CAMERA: string;
-};
+export declare const isCameraStep: (step: Step) => boolean;
 export declare const filterHiddenSchemas: (schemas: Schema[]) => Schema[];
-export declare const getStepType: (step: Step) => string;

package/build/types/dynamicFlow/utils/responseParsers/response-parsers.d.ts

@@ -13,5 +13,5 @@ type ParsedBody = {
 };
 export declare const parseFetchResponse: (response: Response) => Promise<ParsedBody>;
 export declare const parseErrorResponse: (response: Response) => Promise<ErrorResponseBody>;
-export declare const parseExitResponse: (response: Response) => Promise<Parameters<DynamicFlowProps['onCompletion']>[0]>;
+export declare const getJsonObjectOrNull: (response: Response) => Promise<Parameters<DynamicFlowProps['onCompletion']>[0]>;
 export {};

package/build/types/dynamicFlow/utils/useDebouncedRefresh/useDebouncedRefresh.d.ts

@@ -1,5 +1,5 @@
-import { Action, Schema } from '../../../types';
+import { Schema } from '../../../types';
 import { ETag } from '../../DynamicFlowTypes';
-type FetchRefresh = (action: Action, data: unknown, etag: ETag | undefined) => Promise<void | null>;
-export declare function useDebouncedRefresh(fetchRefresh: FetchRefresh): (action: Action, data: unknown, etag: ETag | undefined, schema: Schema) => void;
+type FetchRefresh = (url: string, data: unknown, etag: ETag | undefined) => Promise<void | null>;
+export declare function useDebouncedRefresh(fetchRefresh: FetchRefresh): (url: string, data: unknown, etag: ETag | undefined, schema: Schema) => void;
 export {};

package/build/types/dynamicFlow/utils/useLoader.d.ts

@@ -2,7 +2,7 @@
 import { DynamicFlowProps } from '../DynamicFlowTypes';
 type LoadingState = 'idle' | 'initial' | 'refresh' | 'submission';
 export declare function useLoader(loaderConfig: DynamicFlowProps['loaderConfig'], initialState: LoadingState): {
-    loadingState: "initial" | "idle" | "refresh" | "submission";
+    isLoading: boolean;
     setLoadingState: import("react").Dispatch<import("react").SetStateAction<"initial" | "idle" | "refresh" | "submission">>;
     loader: JSX.Element | null;
 };

package/build/types/fixtures/components/decision-flags.d.ts

@@ -0,0 +1,3 @@
+import { FormStep } from '../../types';
+declare const step: FormStep;
+export default step;

package/build/types/fixtures/components/decision-icons.d.ts

@@ -0,0 +1,3 @@
+import { FormStep } from '../../types';
+declare const step: FormStep;
+export default step;

package/build/types/fixtures/components/index.d.ts

@@ -4,6 +4,8 @@ export { default as button } from './button';
 export { default as columns } from './columns';
 export { default as copyable } from './copyable';
 export { default as decision } from './decision';
+export { default as decisionFlags } from './decision-flags';
+export { default as decisionIcons } from './decision-icons';
 export { default as heading } from './heading';
 export { default as image } from './image';
 export { default as info } from './info';

package/build/types/fixtures/index.d.ts

@@ -10,6 +10,8 @@ export declare const fixtures: {
         numberAndInteger: import("../types").FormStep;
         oneOf: import("../types").FormStep;
         stringFormats: import("../types").FormStep;
+        boolean: import("../types").FormStep;
+        allOf: import("../types").FormStep;
         actionResponse: import("../types").FormStep;
         external: import("../types").FormStep;
         persistAsync: import("../types").FormStep;
@@ -26,6 +28,8 @@ export declare const fixtures: {
         columns: import("../types").FormStep;
         copyable: import("../types").FormStep;
         decision: import("../types").FormStep;
+        decisionFlags: import("../types").FormStep;
+        decisionIcons: import("../types").FormStep;
         heading: import("../types").FormStep;
         image: import("../types").FormStep;
         info: import("../types").FormStep;

package/build/types/fixtures/schemas/all-of.d.ts

@@ -0,0 +1,3 @@
+import { FormStep } from '../../types';
+declare const step: FormStep;
+export default step;

package/build/types/fixtures/schemas/boolean.d.ts

@@ -0,0 +1,3 @@
+import { FormStep } from '../../types';
+declare const step: FormStep;
+export default step;

package/build/types/fixtures/schemas/index.d.ts

@@ -2,3 +2,5 @@ export { default as simpleForm } from './basic-form';
 export { default as numberAndInteger } from './number-and-integer';
 export { default as oneOf } from './one-of';
 export { default as stringFormats } from './string-formats';
+export { default as boolean } from './boolean';
+export { default as allOf } from './all-of';

package/build/types/jsonSchemaForm/schemaFormControl/utils/mapping-utils.d.ts

@@ -1,13 +1,13 @@
 import { Icon, Image, Schema } from '../../../types';
-export declare const mapConstSchemaToOption: (schema: Schema, controlType?: string) => RadioOption | SelectOption;
-export type RadioOption = {
+declare const mapConstSchemaToOption: <ControlType extends string>(schema: Schema, controlType?: ControlType | undefined) => ControlType extends "select" ? SelectOption : RadioOption;
+type RadioOption = {
     disabled?: boolean | undefined;
     avatar?: JSX.Element | undefined;
     currency?: string | undefined;
     label: string;
     value: string;
 };
-export type SelectOption = {
+type SelectOption = {
     searchStrings?: string[];
     disabled?: boolean | undefined;
     icon?: JSX.Element | undefined;
@@ -15,20 +15,16 @@ export type SelectOption = {
     label: string;
     value: string;
 };
-export declare const mapImage: (image?: Image) => {
-    icon: JSX.Element;
-} | null;
-export declare const mapIcon: (icon?: Icon) => {
-    icon: JSX.Element;
-} | null;
-export declare const mapIconToAvatar: (icon?: Icon) => {
-    avatar: JSX.Element;
-} | null;
-export declare const mapAvatar: (image?: Image) => {
+declare const getAvatarPropertyForRadioOption: ({ image, icon }: {
+    image?: Image | undefined;
+    icon?: Icon | undefined;
+}) => {
     avatar: JSX.Element;
 } | null;
-export declare const mapSchemaToUploadOptions: ({ accepts }: {
+declare const mapSchemaToUploadOptions: ({ accepts }: {
     accepts?: string[] | undefined;
 }) => {
     usAccept?: string | undefined;
 };
+export { mapConstSchemaToOption, getAvatarPropertyForRadioOption, mapSchemaToUploadOptions };
+export type { RadioOption, SelectOption };

package/build/types/layout/button/utils.d.ts

@@ -0,0 +1,5 @@
+import { ButtonLayout } from '../../types';
+import { Size } from '../../types';
+export declare const getButtonPriority: (component: ButtonLayout) => "primary" | "secondary" | "tertiary";
+export declare const getButtonType: (component: ButtonLayout) => "positive" | "negative" | "accent";
+export declare const getButtonSize: (size: Size | undefined) => "sm" | "md" | "lg";

package/build/types/layout/icon/DynamicIcon.d.ts

@@ -1,6 +1,6 @@
-type Props = {
+export type Props = {
     type: string;
 };
-declare const DynamicIcon: ({ type }: Props) => JSX.Element;
+declare const DynamicIcon: ({ type }: Props) => JSX.Element | null;
 export declare function isValidIconName(name: string): boolean;
 export default DynamicIcon;

package/build/types/layout/icon/FlagIcon.d.ts

@@ -0,0 +1,7 @@
+type Props = {
+    name: string;
+};
+export declare const isFlagIcon: (name: string) => boolean;
+export declare const FlagIcon: ({ name }: Props) => JSX.Element | null;
+export declare const availableCurrencyFlags: string[];
+export {};

package/build/types/layout/icon/NamedIcon.d.ts

@@ -0,0 +1,6 @@
+type Props = {
+    name: string;
+};
+export declare const isNamedIcon: (name: string) => boolean;
+export declare const NamedIcon: ({ name }: Props) => JSX.Element | null;
+export {};

package/build/types/layout/index.d.ts

@@ -8,7 +8,7 @@ export { default as DynamicExternal } from './external/DynamicExternal';
 export { default as DynamicForm } from './form/DynamicForm';
 export { default as DynamicHeading } from './heading/DynamicHeading';
 export { default as DynamicIcon } from './icon/DynamicIcon';
-export { default as DynamicInfo } from './info/DynamicInfo';
+export { DynamicInfo, DynamicMarkdown } from './markdown/DynamicMarkdown';
 export { default as DynamicImage } from './image/DynamicImage';
 export { default as DynamicLayout } from './DynamicLayout';
 export { default as DynamicList } from './list/DynamicList';

package/build/types/layout/markdown/DynamicMarkdown.d.ts

@@ -0,0 +1,10 @@
+import { InfoLayout, MarkdownLayout } from '../../types';
+type DynamicMarkdownProps = {
+    component: MarkdownLayout;
+};
+export declare const DynamicMarkdown: ({ component }: DynamicMarkdownProps) => JSX.Element;
+type DynamicInfoProps = {
+    component: InfoLayout;
+};
+export declare const DynamicInfo: ({ component }: DynamicInfoProps) => JSX.Element;
+export {};

package/build/types/types/specification/LayoutComponent.d.ts

@@ -2,7 +2,7 @@ import { ExternalStepPollingConfiguration } from '../../common/hooks';
 import { Action } from './Action';
 import { Schema } from './Schema';
 import { Margin, Size, Icon, Image, Align, Orientation, Reference, Alert } from './core';
-export type LayoutComponent = AlertLayout | BoxLayout | ButtonLayout | ColumnsLayout | DecisionLayout | DividerLayout | ExternalLayout | FormLayout | HeadingLayout | ImageLayout | InfoLayout | ListLayout | LoadingIndicatorLayout | ParagraphLayout | ReviewLayout;
+export type LayoutComponent = AlertLayout | BoxLayout | ButtonLayout | ColumnsLayout | DecisionLayout | DividerLayout | ExternalLayout | FormLayout | HeadingLayout | ImageLayout | InfoLayout | ListLayout | LoadingIndicatorLayout | MarkdownLayout | ParagraphLayout | ReviewLayout;
 export type AlertLayout = {
     type: 'alert';
 } & Alert;
@@ -16,6 +16,10 @@ export type BoxLayout = {
 export type ButtonLayout = {
     type: 'button';
     action: Action | Reference;
+    title?: string;
+    control?: 'primary' | 'secondary' | 'tertiary';
+    context?: 'neutral' | 'positive' | 'negative';
+    disabled?: boolean;
     margin?: Margin;
     /**
      * @deprecated Only supported on web client
@@ -104,6 +108,12 @@ export type LoadingIndicatorLayout = {
     margin?: Margin;
     size?: Size;
 };
+export type MarkdownLayout = {
+    type: 'markdown';
+    content: string;
+    margin?: Margin;
+    align?: Align;
+};
 export type ParagraphLayout = {
     type: 'paragraph';
     text: string;

package/build/types/types/specification/Step.d.ts

@@ -4,11 +4,15 @@ import { LayoutComponent } from './LayoutComponent';
 import { ObjectModel } from './Model';
 import { PollingConfiguration } from './Polling';
 import { Schema } from './Schema';
-import { Image, HttpMethod } from './core';
-export type Step = FormStep | DecisionStep | ExternalStep | WebStep | FinalStep;
+import { Image } from './core';
+export type Step = FormStep | DecisionStep | ExternalStep | FinalStep;
 type BaseStep = {
+    id?: string;
+    /**
+     * @deprecated Please use id instead
+     */
     key?: string;
-    type: string;
+    type?: string;
     title?: string;
     description?: string;
     analytics?: Record<string, unknown>;
@@ -27,10 +31,9 @@ type BaseStep = {
     };
 };
 export type FormStep = BaseStep & {
-    type: 'form';
+    type?: 'form';
     title: string;
     layout: LayoutComponent[];
-    actions: Action[];
     schemas: Schema[];
     errors?: unknown;
 };
@@ -59,26 +62,6 @@ export type ExternalStep = BaseStep & {
     retryTitle?: string;
     title: string;
 };
-/**
- * @deprecated Please use the external feature set instead
- */
-type WebStep = BaseStep & {
-    type: 'web';
-    hideBackButton?: boolean;
-    initialRequest: {
-        body?: string;
-        headers?: Record<string, string>;
-        method: HttpMethod;
-        url: string;
-    };
-    interceptablePatterns: {
-        action?: Action;
-        regexPattern: string;
-        threshold?: number;
-        type: 'submit' | 'cancel' | 'redirect' | 'abort-load' | 'log';
-    }[];
-    javaScriptMessageHandler?: unknown;
-};
 /**
  * @deprecated Please use DecisionLayout instead
  */
@@ -118,7 +101,7 @@ export type LegacyReviewFields = {
     }>;
 };
 export type LegacyFormStep = Step & {
-    type: 'form';
+    type?: 'form';
     reviewFields?: LegacyReviewFields;
     schemas?: Schema[];
     actions?: Action[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wise/dynamic-flow-client",
-  "version": "1.0.2",
+  "version": "1.2.0",
   "description": "Dynamic Flow web client",
   "license": "Apache-2.0",
   "main": "./build/main.min.js",
@@ -102,10 +102,11 @@
     "build:messages-source": "formatjs extract 'src/**/*.messages.{js,ts}' --out-file src/i18n/en.json --format simple && prettier --find-config-path --write src/i18n/*.json",
     "build:compiled-messages": "mkdir -p build/i18n && cp src/i18n/*.json build/i18n",
     "test": "npm-run-all test:once test:tz",
-    "test:once": "jest --config jest.config.js --env=jsdom",
+    "test:once": "jest --config jest.config.js --env=jsdom -w 2",
     "test:coverage": "jest --config jest.config.js --env=jsdom --coverage",
     "test:tz": "TZ=US/Pacific jest ./src/jsonSchemaForm/basicTypeSchema/BasicTypeSchema.errors.spec.js ./src/formControl/FormControl.spec.js",
     "test:watch": "pnpm test:once --watch",
+    "types": "pnpm tsc",
     "lint": "npm-run-all lint:ts lint:css",
     "lint:ts": "eslint 'src/**/*.{js,jsx,ts,tsx}' --quiet",
     "lint:css": "stylelint './src/**/*.css'",

package/build/types/jsonSchemaForm/schemaFormControl/utils/currency-utils.d.ts

@@ -1,3 +0,0 @@
-export declare function getCurrencyFlag(iconName?: string): {
-    currency: string;
-} | null;

package/build/types/layout/info/DynamicInfo.d.ts

@@ -1,6 +0,0 @@
-import { InfoLayout } from '../../types';
-type Props = {
-    component: InfoLayout;
-};
-declare const DynamicInfo: ({ component }: Props) => JSX.Element;
-export default DynamicInfo;