@wise/dynamic-flow-client 0.1.1 → 0.1.3

package/build/step/features/polling/useStepPolling.js

@@ -0,0 +1,44 @@
+import { useCallback, useMemo } from 'react';
+import { useFetcher } from '../../../common/contexts/fetcherContext';
+import { usePolling } from '../../../common/hooks/usePolling';
+export function useStepPolling(polling, onAction) {
+    var fetcher = useFetcher();
+    var asyncFn = useMemo(function () {
+        if (polling) {
+            return function () {
+                return fetcher(polling.url).then(function (response) {
+                    if (response.ok) {
+                        return response
+                            .json()
+                            .then(function (pollingResponse) { return pollingResponse; })["catch"](function (error) { return null; });
+                    }
+                    else {
+                        throw new Error('failed');
+                    }
+                });
+            };
+        }
+        else {
+            return undefined;
+        }
+    }, [polling, fetcher]);
+    var onPollingResponse = useCallback(function (pollingResponse) {
+        if (pollingResponse === null || pollingResponse === void 0 ? void 0 : pollingResponse.action) {
+            onAction(pollingResponse.action);
+            return false; // stop polling
+        }
+        return true; // continue polling
+    }, [onAction]);
+    usePolling({
+        asyncFn: asyncFn,
+        interval: 1000 * ((polling === null || polling === void 0 ? void 0 : polling.interval) || 0),
+        maxAttempts: (polling === null || polling === void 0 ? void 0 : polling.maxAttempts) || 0,
+        maxConsecutiveFails: 1,
+        onPollingResponse: onPollingResponse,
+        onFailure: useCallback(function () {
+            if (polling) {
+                onAction(polling.onError.action);
+            }
+        }, [onAction, polling])
+    });
+}

package/build/step/index.d.ts

@@ -0,0 +1,3 @@
+export { default as LayoutStep } from './layoutStep';
+export { default as CameraStep } from './cameraStep';
+export { default as ExternalConfirmationStep } from './externalConfirmationStep';

package/build/step/index.js

@@ -0,0 +1,3 @@
+export { default as LayoutStep } from './layoutStep';
+export { default as CameraStep } from './cameraStep';
+export { default as ExternalConfirmationStep } from './externalConfirmationStep';

package/build/step/layoutStep/LayoutStep.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="react" />
+import { FormErrors, Step } from '../../dynamic-flow-types';
+import { CommonLayoutProps } from '../../layout/DynamicLayout';
+import { StepLayoutOptions } from './layoutService/convertStepToLayout';
+export type LayoutStepProps = Omit<CommonLayoutProps, 'errors' | 'onPersistAsync'> & {
+    stepSpecification: Step;
+    stepLayoutOptions: StepLayoutOptions;
+    formErrors: FormErrors;
+};
+declare const LayoutStep: (props: LayoutStepProps) => JSX.Element;
+export default LayoutStep;

package/build/step/layoutStep/LayoutStep.js

@@ -0,0 +1,34 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { isEmpty } from '@transferwise/neptune-validation';
+import { useDynamicFlow } from '../../common/contexts/dynamicFlowContext/dynamicFlowContext';
+import { useTracking } from '../../common/tracking';
+import DynamicLayout from '../../layout';
+import { useStepPolling } from '../features';
+import { convertStepToLayout, inlineReferences } from './layoutService';
+var getComponents = function (step, options) {
+    var _a;
+    if (!step || isEmpty(step) || (!step.layout && !step.type)) {
+        return [];
+    }
+    var layout = convertStepToLayout(step, options);
+    return inlineReferences({
+        layout: layout,
+        schemas: step.schemas || [],
+        actions: step.actions || [],
+        model: (_a = step.model) !== null && _a !== void 0 ? _a : null
+    });
+};
+var LayoutStep = function (props) {
+    var stepSpecification = props.stepSpecification, stepLayoutOptions = props.stepLayoutOptions, submitted = props.submitted, model = props.model, formErrors = props.formErrors, onModelChange = props.onModelChange;
+    var components = getComponents(stepSpecification, stepLayoutOptions);
+    var _a = useDynamicFlow(), loading = _a.loading, registerPersistAsyncPromise = _a.registerPersistAsyncPromise;
+    var trackEvent = useTracking();
+    var onAction = !loading
+        ? props.onAction
+        : function () {
+            trackEvent('Dynamic Flow - onAction supressed', { reason: 'LayoutStep - loading state' });
+        };
+    useStepPolling(stepSpecification.polling, onAction);
+    return (_jsx(DynamicLayout, { components: components, submitted: submitted, model: model, errors: formErrors, onAction: onAction, onModelChange: onModelChange, onPersistAsync: registerPersistAsyncPromise }));
+};
+export default LayoutStep;

package/build/step/layoutStep/index.d.ts

@@ -0,0 +1 @@
+export { default } from './LayoutStep';

package/build/step/layoutStep/index.js

@@ -0,0 +1 @@
+export { default } from './LayoutStep';

package/build/step/layoutStep/layoutService/convertStepToLayout.d.ts

@@ -0,0 +1,8 @@
+import { Step, ButtonLayout, Action, LayoutComponent } from '../../../dynamic-flow-types';
+export type StepLayoutOptions = {
+    displayStepTitle: boolean;
+};
+export declare function convertStepToLayout(step: Step, { displayStepTitle }?: {
+    displayStepTitle?: boolean | undefined;
+}): LayoutComponent[];
+export declare function convertStepActionToDynamicAction(action: Action): ButtonLayout;

package/build/step/layoutStep/layoutService/convertStepToLayout.js

@@ -0,0 +1,217 @@
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+export function convertStepToLayout(step, _a) {
+    var _b = _a === void 0 ? {} : _a, _c = _b.displayStepTitle, displayStepTitle = _c === void 0 ? true : _c;
+    if (!step || !step.type) {
+        throw new Error('Missing step type');
+    }
+    // This condition is meant as a temporary hack until mobile platforms will be refactored to fully support the layout property
+    if (step.layout) {
+        return addMissingTitleAndDescriptionToStep(step, displayStepTitle);
+    }
+    switch (step.type) {
+        case 'final':
+            return convertFinalStepToDynamicLayout(step);
+        case 'decision':
+            return convertDecisionStepToDynamicLayout(step);
+        case 'form':
+            return convertFormStepToDynamicLayout(step);
+        case 'external':
+            return convertExternalStepToDynamicLayout(step);
+        default:
+            throw new Error('invalid step type');
+    }
+}
+function convertCommonComponents(step) {
+    var layout = [];
+    if (step.title) {
+        layout.push(convertStepTitleToDynamicHeading(step.title));
+    }
+    if (step.image) {
+        var image = convertStepImageToDynamicImage(step.image);
+        layout.push(image);
+    }
+    if (step.description) {
+        layout.push(convertStepDescriptionToDynamicParagraph(step.description));
+    }
+    return layout;
+}
+function convertExternalStepToDynamicLayout(step) {
+    return __spreadArray(__spreadArray([], convertCommonComponents(step), true), [convertStepToExternalComponent(step)], false);
+}
+function convertStepToExternalComponent(step) {
+    return {
+        type: 'external',
+        requestUrl: step.requestUrl,
+        polling: step.polling,
+        responseHandlers: step.responseHandlers,
+        retryTitle: step.retryTitle
+    };
+}
+function convertFormStepToDynamicLayout(step) {
+    var layout = convertCommonComponents(step);
+    if (step.reviewFields) {
+        layout.push(convertStepReviewToDynamicReview(step.reviewFields));
+    }
+    if (step.schemas) {
+        layout.push.apply(layout, getSchemaLayout(step));
+    }
+    if (step.actions) {
+        var actions = step.actions.map(convertStepActionToDynamicAction);
+        layout.push(dynamicBox(actions, 'md'));
+    }
+    return layout;
+}
+function convertFinalStepToDynamicLayout(step) {
+    var layout = [];
+    if (step.details) {
+        if (step.details.image) {
+            var image = convertFinalStepImageToDynamicImage(step.details.image);
+            layout.push(image);
+        }
+        if (step.details.title) {
+            layout.push(convertStepTitleToDynamicHeading(step.details.title));
+        }
+        if (step.details.description) {
+            layout.push(convertStepDescriptionToDynamicParagraph(step.details.description));
+        }
+    }
+    if (step.actions) {
+        var actions = step.actions.map(function (action) {
+            return convertStepActionToDynamicAction(__assign(__assign({}, action), { type: action.type || 'primary' }));
+        });
+        layout.push(dynamicBox(actions, 'md'));
+    }
+    return layout;
+}
+function convertDecisionStepToDynamicLayout(step) {
+    var layout = convertCommonComponents(step);
+    if (step.options) {
+        layout.push(convertStepDecisionToDynamicDecision(step.options));
+    }
+    return layout;
+}
+function dynamicBox(components, size) {
+    return {
+        type: 'box',
+        width: size || 'md',
+        components: components
+    };
+}
+function convertStepTitleToDynamicHeading(title) {
+    return {
+        type: 'heading',
+        text: title,
+        size: 'lg',
+        margin: 'lg',
+        align: 'center'
+    };
+}
+function convertStepDescriptionToDynamicParagraph(description) {
+    return {
+        type: 'paragraph',
+        text: description,
+        align: 'center'
+    };
+}
+function convertStepSchemaToDynamicForm(schema) {
+    return { type: 'form', schema: schema };
+}
+function convertStepDecisionToDynamicDecision(options) {
+    return {
+        type: 'decision',
+        options: options.map(convertStepDecisionOption)
+    };
+}
+function convertStepDecisionOption(option) {
+    return {
+        title: option.title,
+        description: option.description,
+        action: {
+            title: option.title,
+            method: 'GET',
+            url: option.url,
+            disabled: option.disabled
+        }
+    };
+}
+function convertStepImageToDynamicImage(image) {
+    return {
+        type: 'image',
+        url: image.url,
+        text: image.text,
+        margin: image.margin || 'lg',
+        size: image.size || 'md'
+    };
+}
+function convertFinalStepImageToDynamicImage(image) {
+    return typeof image === 'string'
+        ? {
+            type: 'image',
+            url: image,
+            text: undefined,
+            margin: 'lg',
+            size: 'md'
+        }
+        : convertStepImageToDynamicImage(image);
+}
+export function convertStepActionToDynamicAction(action) {
+    var newAction = __assign(__assign({}, action), { title: action.title });
+    return {
+        type: 'button',
+        action: newAction
+    };
+}
+function convertStepReviewToDynamicReview(reviewFields) {
+    return {
+        type: 'review',
+        title: reviewFields.title,
+        fields: reviewFields.fields.map(convertReviewFieldToDefinition)
+    };
+}
+function convertReviewFieldToDefinition(reviewField) {
+    return {
+        label: reviewField.title,
+        value: reviewField.value
+    };
+}
+function getSchemaLayout(step) {
+    var layout = [];
+    if (step.schemas && step.schemas[0]) {
+        var schema = step.schemas[0];
+        var dynamicForm = convertStepSchemaToDynamicForm(schema);
+        if (isWideForm()) {
+            layout.push(dynamicForm);
+        }
+        else {
+            layout.push(dynamicBox([dynamicForm], 'md'));
+        }
+    }
+    return layout;
+}
+function isWideForm() {
+    // For the time being we won't support automatically widening forms
+    // Unlike it V2, there is no way to easily iterate and identify narrow fields
+    return false;
+}
+function addMissingTitleAndDescriptionToStep(step, displayStepTitle) {
+    return __spreadArray(__spreadArray(__spreadArray([], (displayStepTitle && step.title ? [convertStepTitleToDynamicHeading(step.title)] : []), true), (step.description ? [convertStepDescriptionToDynamicParagraph(step.description)] : []), true), (step.layout || []), true);
+}

package/build/step/layoutStep/layoutService/index.d.ts

@@ -0,0 +1,2 @@
+export { convertStepToLayout } from './convertStepToLayout';
+export { inlineReferences } from './inlineReferences';

package/build/step/layoutStep/layoutService/index.js

@@ -0,0 +1,2 @@
+export { convertStepToLayout } from './convertStepToLayout';
+export { inlineReferences } from './inlineReferences';

package/build/step/layoutStep/layoutService/inlineReferences.d.ts

@@ -0,0 +1,7 @@
+import { Action, LayoutComponent, Model, Schema } from '../../../dynamic-flow-types';
+export declare function inlineReferences({ layout, schemas, actions, model, }: {
+    layout: LayoutComponent[];
+    schemas: Schema[];
+    actions: Action[];
+    model: Model;
+}): LayoutComponent[];

package/build/step/layoutStep/layoutService/inlineReferences.js

@@ -0,0 +1,91 @@
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+import { convertStepActionToDynamicAction } from './convertStepToLayout';
+export function inlineReferences(_a) {
+    var layout = _a.layout, schemas = _a.schemas, actions = _a.actions, model = _a.model;
+    if (!layout) {
+        return [];
+    }
+    if (!schemas) {
+        return layout;
+    }
+    return layout.map(function (component) {
+        if (component.type === 'form') {
+            return inlineFormSchema({ formComponent: component, schemas: schemas });
+        }
+        if (component.type === 'decision') {
+            return inlineDecisionActions({ decisionComponent: component, actions: actions });
+        }
+        if (component.type === 'button') {
+            return inlineAction({ actionComponent: component, actions: actions });
+        }
+        if (component.type === 'box') {
+            return inlineBoxReferences({ boxComponent: component, schemas: schemas, actions: actions, model: model });
+        }
+        if (component.type === 'columns') {
+            return inlineColumnsReferences({ columnsComponent: component, schemas: schemas, actions: actions, model: model });
+        }
+        return component;
+    });
+}
+function inlineFormSchema(_a) {
+    var formComponent = _a.formComponent, schemas = _a.schemas;
+    if (isReference(formComponent.schema) && formComponent.schema.$ref) {
+        return __assign(__assign({}, formComponent), { schema: getSchemaById(schemas, formComponent.schema.$ref) });
+    }
+    return __assign({}, formComponent);
+}
+function inlineDecisionActions(_a) {
+    var _b;
+    var decisionComponent = _a.decisionComponent, actions = _a.actions;
+    var newOptions = (_b = decisionComponent === null || decisionComponent === void 0 ? void 0 : decisionComponent.options) === null || _b === void 0 ? void 0 : _b.map(function (option) {
+        return option.action && isReference(option.action)
+            ? __assign(__assign({}, option), { action: getActionById(actions, option.action.$ref) }) : option;
+    });
+    return __assign(__assign({}, decisionComponent), { options: newOptions });
+}
+function inlineAction(_a) {
+    var _b;
+    var actionComponent = _a.actionComponent, actions = _a.actions;
+    if (actionComponent.action &&
+        isReference(actionComponent.action) &&
+        ((_b = actionComponent.action) === null || _b === void 0 ? void 0 : _b.$ref)) {
+        var newAction = getActionById(actions, actionComponent.action.$ref);
+        return convertStepActionToDynamicAction(newAction);
+    }
+    return actionComponent;
+}
+function inlineBoxReferences(_a) {
+    var boxComponent = _a.boxComponent, schemas = _a.schemas, actions = _a.actions, model = _a.model;
+    return __assign(__assign({}, boxComponent), { components: inlineReferences({ layout: boxComponent.components, schemas: schemas, actions: actions, model: model }) });
+}
+function inlineColumnsReferences(_a) {
+    var columnsComponent = _a.columnsComponent, schemas = _a.schemas, actions = _a.actions, model = _a.model;
+    return __assign(__assign({}, columnsComponent), { left: inlineReferences({ layout: columnsComponent.left, schemas: schemas, actions: actions, model: model }), right: inlineReferences({ layout: columnsComponent.right, schemas: schemas, actions: actions, model: model }) });
+}
+function getSchemaById(schemas, id) {
+    var schema = schemas.find(function (schema) { return schema.$id === id; });
+    if (!schema) {
+        throw new Error("Fatal Error. Schema not found. $id ".concat(id));
+    }
+    return schema;
+}
+function getActionById(actions, id) {
+    var action = actions.find(function (action) { return action.$id === id; });
+    if (!action) {
+        throw new Error("Fatal Error. Action not found. $id ".concat(id));
+    }
+    return action;
+}
+function isReference(block) {
+    return Object.prototype.hasOwnProperty.call(block, '$ref');
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wise/dynamic-flow-client",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Wise Dynamic Flow web client",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",