@wise/dynamic-flow-client 5.8.1 → 5.9.0

package/build/stories/spec/step/Controls.story.js

@@ -0,0 +1,109 @@
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { FlowNavigation } from '@transferwise/components';
+import { ThemeProvider } from '@wise/components-theming';
+import { action } from 'storybook/actions';
+import { respondWith } from '../../../test-utils';
+import DynamicFlowWise from '../../../test-utils/DynamicFlowWise';
+export default {
+    component: DynamicFlowWise,
+    title: 'Spec/Step/Controls',
+    parameters: {
+        layout: 'fullscreen',
+    },
+};
+export function Splash() {
+    return render('splash');
+}
+export function SplashCelebration() {
+    return render('splash-celebration');
+}
+export function SplashInteractive() {
+    return (_jsx(ThemeProvider, { theme: "personal", className: "animate-theme", children: _jsxs("div", { style: {
+                width: '100%',
+                height: '100vh',
+            }, children: [_jsx(FlowNavigation, { steps: [], onClose: () => { } }), _jsx("div", { style: {
+                        maxWidth: '546px',
+                        margin: 'auto',
+                        paddingTop: '48px',
+                    }, children: _jsx(DynamicFlowWise, { flowId: "splash", httpClient: async (input) => {
+                            if (input === '/continue') {
+                                return respondWith(step('splash-celebration'));
+                            }
+                            return respondWith({
+                                id: 'next',
+                                title: 'This is the step after the splash',
+                                description: 'The theme should be reset to personal',
+                                layout: [],
+                                schemas: [],
+                            });
+                        }, initialStep: {
+                            title: 'Click the button to continue',
+                            id: 'step',
+                            layout: [
+                                {
+                                    type: 'button',
+                                    title: 'Continue',
+                                    behavior: {
+                                        type: 'action',
+                                        action: {
+                                            url: '/continue',
+                                        },
+                                    },
+                                },
+                            ],
+                            schemas: [],
+                        }, onCompletion: action('onCompletion'), onEvent: action('onEvent'), onError: (error) => {
+                            action('onError');
+                            console.error(error);
+                        }, onLog: action('onLog') }) })] }) }));
+}
+SplashInteractive.parameters = {
+    chromatic: { disableSnapshot: true },
+};
+const render = (control) => {
+    return (_jsx("div", { style: {
+            width: '60%',
+            margin: 'auto',
+        }, children: _jsx(DynamicFlowWise, { flowId: "splash", httpClient: fetch, initialStep: step(control), onCompletion: action('onCompletion'), onEvent: action('onEvent'), onError: (error) => {
+                action('onError');
+                console.error(error);
+            }, onLog: action('onLog') }) }));
+};
+const step = (control) => ({
+    id: 'splash',
+    title: '',
+    layout: [
+        {
+            type: 'image',
+            content: {
+                accessibilityDescription: 'plane',
+                uri: 'urn:wise:illustrations:plane',
+            },
+        },
+        {
+            type: 'heading',
+            control: 'display',
+            text: 'Almost there',
+            align: 'center',
+            margin: 'lg',
+        },
+        {
+            type: 'markdown',
+            content: "Your money should arrive **by Wednesday**. We'll keep you posted.",
+            align: 'center',
+            margin: 'lg',
+        },
+        {
+            type: 'button',
+            title: 'Track your transfer',
+            behavior: {
+                type: 'action',
+                action: {
+                    url: '/submit',
+                },
+            },
+        },
+    ],
+    schemas: [],
+    control,
+});

package/build/stories/spec/step/DFModal.story.js

@@ -0,0 +1,58 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { Layout } from '@transferwise/navigation-ui';
+import { action } from 'storybook/actions';
+import { DynamicFlowWiseModal } from '../../../test-utils/DynamicFlowWiseModal';
+export default {
+    component: DynamicFlowWiseModal,
+    title: 'Spec/Step/DFModal',
+    parameters: {
+        layout: 'fullscreen',
+    },
+};
+const httpClient = async (input, init) => {
+    action('httpClient')(input, init);
+    const url = typeof input === 'string' ? input : '';
+    const match = /\/submit\/(\d+)/.exec(url);
+    if (!match) {
+        return new Response('Not Found', { status: 404 });
+    }
+    const index = match[1];
+    action('httpClient response index')(index);
+    return new Response(JSON.stringify(getStep(index)));
+};
+export function DFModalExample() {
+    return (_jsx(Layout, { children: _jsx(DynamicFlowWiseModal, { flowId: "df-modal-story", initialStep: getStep('1'), features: {
+                nativeBack: true,
+                hideStepTitle: false,
+            }, httpClient: httpClient, onCompletion: action('onCompletion'), onAnalytics: action('onAnalytics'), onCancellation: action('onCancellation'), onEvent: action('onEvent'), onError: (error) => {
+                action('onError');
+                console.error(error);
+            }, onLog: action('onLog') }) }));
+}
+const getStep = (index) => {
+    return {
+        id: 'step',
+        title: `Step title ${index}`,
+        description: 'This is a description of the step.',
+        schemas: [],
+        layout: [
+            {
+                type: 'markdown',
+                content: 'The title is now missing from the layout, and only visible in the modal header. This is because we are using the hideStepTitle to hide it.',
+                align: 'left',
+                margin: 'xl',
+            },
+            {
+                type: 'button',
+                title: 'Continue',
+                behavior: {
+                    type: 'action',
+                    action: {
+                        url: `/submit/${Number(index) + 1}`,
+                    },
+                },
+            },
+        ],
+        tags: ['root-screen'],
+    };
+};

package/build/stories/spec/step/Footer.story.js

@@ -0,0 +1,70 @@
+import DynamicFlowWise from '../../../test-utils/DynamicFlowWise';
+import { renderWithStepAndOverrides } from '../../utils/render-utils';
+export default {
+    component: DynamicFlowWise,
+    title: 'Spec/Step/Footer',
+    parameters: {
+        chromatic: { disableSnapshot: false },
+    },
+    globals: { viewport: { value: 'iphone6' } },
+};
+export const Basic = {
+    render: () => renderWithStepAndOverrides(getFooterStep(), { features: { pinnedButtons: true } }),
+};
+const getFooterStep = () => ({
+    id: 'step-footer',
+    title: 'Step Footer Demo',
+    description: 'This step demonstrates the step footer.',
+    layout: [
+        {
+            type: 'paragraph',
+            text: 'Pinned buttons like the one below are not pinned here because a footer layout is provided.',
+        },
+        {
+            type: 'button',
+            title: 'The pinOrder prop is ignored',
+            control: 'secondary',
+            pinOrder: 1,
+            behavior: {
+                type: 'copy',
+                content: 'Banana.',
+            },
+        },
+        {
+            type: 'paragraph',
+            text: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.',
+        },
+        {
+            type: 'image',
+            content: {
+                uri: 'urn:wise:illustrations:confetti',
+            },
+        },
+        {
+            type: 'paragraph',
+            text: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.',
+        },
+    ],
+    schemas: [
+        {
+            $id: '#footer-schema',
+            type: 'boolean',
+            title: 'I accept the terms and conditions without having scrolled all the way down, thanks to the new footer layout.',
+        },
+    ],
+    footer: [
+        {
+            type: 'form',
+            schemaId: '#footer-schema',
+        },
+        {
+            type: 'button',
+            title: 'Submit',
+            control: 'primary',
+            behavior: {
+                type: 'action',
+                action: { url: '/submit' },
+            },
+        },
+    ],
+});

package/build/stories/spec/step/Navigation.story.js

@@ -0,0 +1,20 @@
+import DynamicFlowWise from '../../../test-utils/DynamicFlowWise';
+import { getBasicStep } from '../../utils/getBasicStep';
+import { renderWithStep } from '../../utils/render-utils';
+export default {
+    component: DynamicFlowWise,
+    title: 'Spec/Step/Navigation',
+    parameters: {
+        chromatic: { disableSnapshot: true },
+    },
+};
+export function NavigationWithBackButton() {
+    return renderWithStep(Object.assign(Object.assign({}, getBasicStep()), { navigation: {
+            back: {
+                title: 'Go back',
+                action: {
+                    url: '/back',
+                },
+            },
+        } }));
+}

package/build/stories/spec/step/Tags.story.js

@@ -0,0 +1,39 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import DynamicFlowWise from '../../../test-utils/DynamicFlowWise';
+import { Layout } from '@transferwise/navigation-ui';
+import { renderWithStep } from '../../utils/render-utils';
+export default {
+    component: DynamicFlowWise,
+    title: 'Spec/Step/Tags',
+    parameters: {
+        layout: 'fullscreen',
+    },
+};
+export function RootScreen() {
+    return _jsx(Layout, { children: renderWithStep(step) });
+}
+const step = {
+    id: 'step',
+    title: 'Step title',
+    description: 'This is a description of the step, which is left-aligned',
+    schemas: [],
+    layout: [
+        {
+            type: 'markdown',
+            content: "Your money should arrive **by Wednesday**. We'll keep you posted.",
+            align: 'left',
+            margin: 'xl',
+        },
+        {
+            type: 'button',
+            title: 'Continue',
+            behavior: {
+                type: 'action',
+                action: {
+                    url: '/submit',
+                },
+            },
+        },
+    ],
+    tags: ['root-screen'],
+};

package/build/stories/spec/step/ToolBar.story.js

@@ -0,0 +1,60 @@
+import { renderWithStep } from '../../utils/render-utils';
+import { getBasicStep } from '../../utils/getBasicStep';
+import DynamicFlowWise from '../../../test-utils/DynamicFlowWise';
+export default {
+    component: DynamicFlowWise,
+    title: 'Spec/Step/Toolbar',
+    parameters: {
+        chromatic: { disableSnapshot: true },
+    },
+};
+export function ToolbarStep() {
+    return renderWithStep(Object.assign(Object.assign({}, getBasicStep()), { toolbar: getToolbar() }));
+}
+export function ToolbarStepWithBack() {
+    return renderWithStep(Object.assign(Object.assign({}, getBasicStep()), { navigation: {
+            back: {
+                title: 'Go back',
+                action: {
+                    url: '/back',
+                },
+            },
+        }, toolbar: getToolbar() }));
+}
+const getToolbar = () => ({
+    items: [
+        {
+            type: 'toolbar-button',
+            title: 'Settings',
+            control: 'primary',
+            media: {
+                type: 'avatar',
+                content: [{ type: 'uri', uri: 'urn:wise:icons:cog' }],
+            },
+            behavior: { type: 'action', action: { url: '/settings', skipValidation: true } },
+            accessibilityDescription: 'Open settings for this step',
+        },
+        {
+            type: 'toolbar-button',
+            title: 'Settings',
+            control: 'secondary',
+            media: {
+                type: 'avatar',
+                content: [{ type: 'uri', uri: 'urn:wise:icons:cog' }],
+            },
+            behavior: { type: 'action', action: { url: '/settings', skipValidation: true } },
+            accessibilityDescription: 'Open settings for this step',
+        },
+        {
+            type: 'toolbar-button',
+            title: 'Settings',
+            control: 'secondary-neutral',
+            media: {
+                type: 'avatar',
+                content: [{ type: 'uri', uri: 'urn:wise:icons:cog' }],
+            },
+            behavior: { type: 'action', action: { url: '/settings', skipValidation: true } },
+            accessibilityDescription: 'Open settings for this step',
+        },
+    ],
+});

package/build/stories/spec/step/features/ErrorHandling.story.js

@@ -0,0 +1,92 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { action } from 'storybook/actions';
+import DynamicFlowWise from '../../../../test-utils/DynamicFlowWise';
+import { fixtureHttpClient } from '../../../utils/fixtureHttpClient';
+import { getMockHttpClient, respondWith } from '../../../../test-utils';
+export default {
+    component: DynamicFlowWise,
+    title: 'Spec/Step/Features/Error Handling',
+    parameters: {
+        chromatic: { disableSnapshot: true },
+    },
+};
+export function ErrorOnSubmission() {
+    const step = getBasicStep();
+    return renderWithStep(step, getHttpClient());
+}
+export function StepWithErrors() {
+    const step = getGlobalErrorStep();
+    return renderWithStep(step);
+}
+const getHttpClient = () => getMockHttpClient({
+    '/submit': async () => respondWith({
+        error: 'Server-side Global Error',
+        validation: {
+            name: "I don't like your name",
+            age: 'You are too young',
+            date: 'You are too old',
+            money: 'You are too poor',
+        },
+    }, { status: 422 }),
+});
+const renderWithStep = (step, httpClient = fixtureHttpClient) => (_jsx(DynamicFlowWise, { flowId: "new-df-flow-id", httpClient: httpClient, initialStep: step, onCompletion: action('onCompletion'), onEvent: action('onEvent'), onLog: action('onLog'), onError: (error) => {
+        action('onError');
+        console.error(error);
+    } }));
+const getBasicStep = () => ({
+    id: 'new-df-initial-step',
+    title: 'Error Handling in Dynamic Flow',
+    schemas: [
+        {
+            $id: '#personal-details',
+            type: 'object',
+            title: 'Personal details object',
+            description: 'Personal details schema description',
+            displayOrder: ['name', 'date', 'age', 'money'],
+            properties: {
+                name: {
+                    title: 'Full name',
+                    type: 'string',
+                },
+                date: {
+                    title: 'Date',
+                    type: 'string',
+                    format: 'date',
+                    control: 'date-lookup',
+                },
+                age: {
+                    title: 'Age',
+                    type: 'integer',
+                },
+                money: {
+                    title: 'How much money would you like?',
+                    type: 'number',
+                },
+            },
+        },
+    ],
+    layout: [
+        {
+            type: 'form',
+            schemaId: '#personal-details',
+        },
+        {
+            type: 'button',
+            title: 'Submit',
+            control: 'primary',
+            action: {
+                url: '/submit',
+                method: 'POST',
+            },
+        },
+    ],
+});
+const getGlobalErrorStep = () => (Object.assign(Object.assign({}, getBasicStep()), { errors: {
+        error: 'This is a global error',
+        validation: {
+            name: "I don't like your name",
+            age: 'You are too young',
+            date: 'You are too old',
+            money: 'You are too poor',
+        },
+    } }));

package/build/stories/spec/step/features/External.story.js

@@ -0,0 +1,44 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { action } from 'storybook/actions';
+import DynamicFlowWise from '../../../../test-utils/DynamicFlowWise';
+export default {
+    component: DynamicFlowWise,
+    title: 'Spec/Step/Features',
+    parameters: {
+        chromatic: { disableSnapshot: true },
+    },
+};
+export function External() {
+    return renderWithStep(initialStep);
+}
+const renderWithStep = (step) => (_jsx(DynamicFlowWise, { flowId: "new-df-flow-id", httpClient: async (input, init) => {
+        action('httpClient')(input, init === null || init === void 0 ? void 0 : init.body);
+        return fetch(input, init);
+    }, initialStep: step, onCompletion: action('onCompletion'), onEvent: action('onEvent'), onLog: action('onLog'), onError: (error) => {
+        action('onError');
+        console.error(error);
+    } }));
+const initialStep = {
+    id: 'step-id',
+    title: 'Step Title',
+    external: { url: 'https://www.google.com' },
+    schemas: [],
+    layout: [
+        {
+            type: 'paragraph',
+            align: 'center',
+            text: 'Your bank is opening in another window.',
+        },
+        {
+            type: 'paragraph',
+            align: 'center',
+            text: 'Please, follow their instructions. Keep this window open.',
+        },
+        { type: 'loading-indicator', margin: 'xl' },
+        {
+            type: 'info',
+            align: 'center',
+            markdown: `If it didn't work, you can [reopen](http://google.com/) the tab`,
+        },
+    ],
+};

package/build/stories/spec/step/features/Polling.story.js

@@ -0,0 +1,108 @@
+import { action } from 'storybook/actions';
+import { getMockHttpClient, respondWith } from '../../../../test-utils';
+import DynamicFlowWise from '../../../../test-utils/DynamicFlowWise';
+import { renderWithStep } from '../../../utils/render-utils';
+export default {
+    component: DynamicFlowWise,
+    title: 'Spec/Step/Features/Polling',
+    parameters: {
+        chromatic: { disableSnapshot: true },
+    },
+    argTypes: {},
+};
+export function PollingSuccess() {
+    let attempts = 0;
+    const httpClient = getMockHttpClient({
+        '/polling/1234': async () => {
+            action('attempts!')(attempts);
+            if (attempts <= 2) {
+                attempts += 1;
+                return respondWith({}, { status: 200 });
+            }
+            action('attempts!')(attempts, 'going to respond with step');
+            return respondWith({
+                id: 'hello',
+                title: 'Direct Success',
+                description: 'Direct success after polling. Response is a step.',
+                layout: [],
+                schemas: [],
+            }, { status: 200, headers: { 'X-Df-Response-Type': 'step' } });
+        },
+    });
+    return renderWithStep(step, httpClient);
+}
+export function PollingActionResponse() {
+    let attempts = 0;
+    const httpClient = getMockHttpClient({
+        '/polling/1234': async () => {
+            if (attempts <= 2) {
+                attempts += 1;
+                return respondWith({}, { status: 200 });
+            }
+            return respondWith({ action: { id: 'polling-action-response', url: '/success' } }, { status: 200 });
+        },
+        '/success': async () => respondWith({
+            id: 'hello',
+            title: 'Success after polling',
+            description: 'ActionResponse submitted to /success which returned this step.',
+            layout: [],
+            schemas: [],
+        }),
+    });
+    return renderWithStep(step, httpClient);
+}
+export function PollingFails() {
+    let attempts = 0;
+    const httpClient = getMockHttpClient({
+        '/polling/1234': async () => {
+            if (attempts <= 5) {
+                attempts += 1;
+                return respondWith({}, { status: 200 });
+            }
+            return respondWith({ action: { url: '/success' } }, { status: 200 });
+        },
+        '/success': async () => respondWith({
+            id: 'hello',
+            title: 'success',
+            layout: [],
+            schemas: [],
+        }),
+    });
+    return renderWithStep(step, httpClient);
+}
+const step = {
+    id: 'Features/Polling',
+    title: 'Polling Feature',
+    polling: {
+        url: '/polling/1234',
+        delay: 2,
+        maxAttempts: 5,
+        onError: {
+            action: { url: '/failure', data: { error: 'Polling failed' } },
+        },
+    },
+    layout: [
+        {
+            type: 'paragraph',
+            align: 'center',
+            text: 'We are waiting for something to happen.',
+        },
+        { type: 'loading-indicator', margin: 'xl' },
+        {
+            type: 'button',
+            title: 'Back',
+            action: {
+                type: 'link',
+                url: '/back',
+            },
+        },
+    ],
+    schemas: [
+        {
+            $id: '#unreferenced-schema',
+            const: {
+                unreferencedKey: 'unreferenced value',
+            },
+        },
+    ],
+};