@wise/dynamic-flow-client 3.2.1 → 3.2.2-short-962e290

package/build/legacy/dynamicFlow/tests/AllOfSchema.spec.js

@@ -0,0 +1,196 @@
+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 __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+import { jsx as _jsx } from "react/jsx-runtime";
+import { screen, waitFor } from '@testing-library/react';
+import { userEvent } from '@testing-library/user-event';
+import { renderWithProviders } from '../../test-utils';
+import DynamicFlow from '../DynamicFlow';
+var stringObjectSchema = {
+    $id: 'objectSchema1',
+    type: 'object',
+    title: 'String Object',
+    displayOrder: ['name'],
+    properties: {
+        name: { title: 'Name String Schema', type: 'string', $id: 'name' }
+    }
+};
+var numberObjectSchema = {
+    $id: 'objectSchema2',
+    type: 'object',
+    title: 'Number Object',
+    displayOrder: ['age'],
+    properties: {
+        age: { type: 'number', $id: 'age' }
+    }
+};
+var initialStep = function (schema) {
+    if (schema === void 0) { schema = { allOf: [stringObjectSchema, numberObjectSchema] }; }
+    return ({
+        id: 'allof-schema-test-step-id',
+        title: 'AllOf Schema Step Title',
+        layout: [
+            { type: 'form', schemaId: '#schema' },
+            {
+                type: 'button',
+                title: 'Submit',
+                action: { url: '/submit', method: 'POST' }
+            },
+        ],
+        schemas: [
+            __assign(__assign({}, schema), { $id: '#schema' }),
+        ]
+    });
+};
+var mockHttpClient = jest.fn();
+var getProps = function (schema, overrides) {
+    if (schema === void 0) { schema = undefined; }
+    if (overrides === void 0) { overrides = {}; }
+    return (__assign({ flowId: 'allof-schema-test-flow-id', initialStep: initialStep(schema || { allOf: [stringObjectSchema, numberObjectSchema] }), httpClient: mockHttpClient, onCompletion: jest.fn(), onError: jest.fn(), onEvent: jest.fn(), onLog: jest.fn() }, overrides));
+};
+beforeEach(function () { return mockHttpClient.mockClear(); });
+describe('Given an allOf schema', function () {
+    it('should render the schema title in a label', function () {
+        renderWithProviders(_jsx(DynamicFlow, __assign({}, getProps({
+            title: 'My title',
+            allOf: [stringObjectSchema, numberObjectSchema]
+        }))));
+        var title = screen.getByRole('heading', { name: 'My title' });
+        expect(title).toBeInTheDocument();
+    });
+    it('should render the schema description', function () {
+        renderWithProviders(_jsx(DynamicFlow, __assign({}, getProps({
+            description: 'This is the schema description',
+            allOf: [stringObjectSchema, numberObjectSchema]
+        }))));
+        expect(screen.getByText('This is the schema description')).toBeInTheDocument();
+    });
+    it('should render one aria-group for each allOf', function () {
+        renderWithProviders(_jsx(DynamicFlow, __assign({}, getProps({
+            allOf: [stringObjectSchema, numberObjectSchema]
+        }))));
+        expect(screen.getAllByRole('group')).toHaveLength(2);
+    });
+    it('should fill in the relevant parts of the model', function () {
+        renderWithProviders(_jsx(DynamicFlow, __assign({}, getProps(undefined, {
+            initialStep: __assign(__assign({}, initialStep()), { model: {
+                    name: 'Colin Robinson',
+                    age: 999,
+                    city: 'New York'
+                } })
+        }))));
+        expect(screen.getByDisplayValue('Colin Robinson')).toBeInTheDocument();
+        expect(screen.getByDisplayValue('999')).toBeInTheDocument();
+        expect(screen.queryByDisplayValue('New York')).not.toBeInTheDocument();
+    });
+    it('should show validation error messages on the correct fields', function () {
+        renderWithProviders(_jsx(DynamicFlow, __assign({}, getProps(undefined, {
+            initialStep: __assign(__assign({}, initialStep()), { model: {
+                    name: 'Colin Robinson',
+                    age: 999,
+                    city: 'New York'
+                }, errors: {
+                    validation: {
+                        name: 'Vampire names are not accepted',
+                        age: 'That is too old',
+                        city: 'There are no vampires in New York'
+                    }
+                } })
+        }))));
+        expect(screen.getByText('Vampire names are not accepted')).toBeInTheDocument();
+        expect(screen.getByText('That is too old')).toBeInTheDocument();
+        expect(screen.queryByText('There are no vampires in New York')).not.toBeInTheDocument();
+    });
+    describe('when a child schemas value is updated', function () {
+        it('should update the model', function () { return __awaiter(void 0, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        renderWithProviders(_jsx(DynamicFlow, __assign({}, getProps())));
+                        return [4 /*yield*/, userEvent.type(screen.getByLabelText('Name String Schema'), 'Colin Robinson')];
+                    case 1:
+                        _a.sent();
+                        return [4 /*yield*/, userEvent.click(screen.getByRole('button', { name: 'Submit' }))];
+                    case 2:
+                        _a.sent();
+                        return [4 /*yield*/, waitFor(function () {
+                                return expect(mockHttpClient).toHaveBeenCalledWith('/submit', expect.objectContaining({ body: JSON.stringify({ name: 'Colin Robinson' }) }));
+                            })];
+                    case 3:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+        it('should combine the updated value with the values of the other schemas', function () { return __awaiter(void 0, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        renderWithProviders(_jsx(DynamicFlow, __assign({}, getProps(undefined, {
+                            initialStep: __assign(__assign({}, initialStep()), { model: {
+                                    name: 'Colin',
+                                    age: 999,
+                                    city: 'New York'
+                                } })
+                        }))));
+                        return [4 /*yield*/, userEvent.type(screen.getByLabelText('Name String Schema'), ' Robinson')];
+                    case 1:
+                        _a.sent();
+                        return [4 /*yield*/, userEvent.click(screen.getByRole('button', { name: 'Submit' }))];
+                    case 2:
+                        _a.sent();
+                        return [4 /*yield*/, waitFor(function () {
+                                return expect(mockHttpClient).toHaveBeenCalledWith('/submit', expect.objectContaining({ body: JSON.stringify({ age: 999, name: 'Colin Robinson' }) }));
+                            })];
+                    case 3:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+    });
+});

package/build/legacy/dynamicFlow/tests/AutocompleteHints.spec.js

@@ -0,0 +1,59 @@
+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 { jsx as _jsx } from "react/jsx-runtime";
+import { screen } from '@testing-library/react';
+import DynamicFlow from '..';
+import { renderWithProviders } from '../../test-utils';
+describe('AutocompleteHints', function () {
+    var initialStep = function (childSchema) { return ({
+        id: 'step-id',
+        title: 'Step Title',
+        layout: [
+            { type: 'form', schemaId: '#schema' },
+            {
+                type: 'button',
+                title: 'Submit',
+                action: { url: '/submit', method: 'POST' }
+            },
+        ],
+        schemas: [
+            {
+                $id: '#schema',
+                type: 'object',
+                displayOrder: ['child'],
+                properties: {
+                    child: childSchema
+                }
+            },
+        ]
+    }); };
+    var mockHttpClient = jest.fn();
+    beforeEach(function () { return mockHttpClient.mockClear(); });
+    var getProps = function (childSchema) { return ({
+        flowId: 'flow-id',
+        initialStep: initialStep(childSchema),
+        httpClient: mockHttpClient,
+        onCompletion: jest.fn(),
+        onError: jest.fn(),
+        onEvent: jest.fn(),
+        onLog: jest.fn()
+    }); };
+    it('should render autocomplete hint', function () {
+        var props = getProps({
+            title: 'Full name',
+            autocompleteHint: ['name', 'shipping'],
+            type: 'string'
+        });
+        renderWithProviders(_jsx(DynamicFlow, __assign({}, props)));
+        expect(screen.getByLabelText('Full name')).toHaveAttribute('autocomplete', 'name shipping');
+    });
+});

package/build/legacy/dynamicFlow/tests/DynamicFlow.BackButton.spec.js

@@ -0,0 +1,179 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+import { jsx as _jsx } from "react/jsx-runtime";
+import { screen } from '@testing-library/react';
+import { userEvent } from '@testing-library/user-event';
+import DynamicFlow from '../DynamicFlow';
+import { renderWithProviders } from '../../test-utils';
+import { respondWith } from '../../../test-utils';
+var getStepWithBack = function (navigation) { return ({
+    title: 'Basic step',
+    navigation: navigation,
+    schemas: [],
+    layout: [
+        {
+            type: 'form',
+            schema: {
+                $id: 'schema',
+                type: 'object',
+                displayOrder: ['name'],
+                required: ['name'],
+                properties: {
+                    name: {
+                        title: 'Full name',
+                        type: 'string'
+                    }
+                }
+            }
+        },
+    ]
+}); };
+describe('DynamicFlow / Back Button', function () {
+    var onCompletion = jest.fn();
+    var onError = jest.fn();
+    var httpClient = jest.fn();
+    beforeEach(function () {
+        jest.clearAllMocks();
+    });
+    describe('when the step contains a back navigation property', function () {
+        it('renders a back button', function () {
+            var backLabel = 'Back to payment methods';
+            var backAction = {
+                method: 'GET',
+                url: '/back'
+            };
+            renderWithProviders(_jsx(DynamicFlow, { flowId: "the-flow-id", httpClient: httpClient, initialStep: getStepWithBack({ back: { title: backLabel, action: backAction } }), onCompletion: onCompletion, onError: onError }));
+            expect(screen.getByRole('link', { name: backLabel })).toBeInTheDocument();
+        });
+    });
+    describe('when the step contains the deprecated backButton navigation property', function () {
+        it('renders a back button', function () {
+            var backLabel = 'Back to payment methods';
+            var backAction = {
+                method: 'GET',
+                url: '/back'
+            };
+            renderWithProviders(_jsx(DynamicFlow, { flowId: "the-flow-id", httpClient: httpClient, initialStep: getStepWithBack({ backButton: { title: backLabel, action: backAction } }), onCompletion: onCompletion, onError: onError }));
+            expect(screen.getByRole('link', { name: backLabel })).toBeInTheDocument();
+        });
+    });
+    it('performs (GET) action on back', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var backLabel, backAction, mockHttpClient, backButton;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    backLabel = 'Back to payment methods';
+                    backAction = {
+                        method: 'GET',
+                        url: '/back'
+                    };
+                    mockHttpClient = jest.fn();
+                    mockHttpClient.mockImplementationOnce(function () {
+                        return respondWith({
+                            title: 'Next step',
+                            schemas: [],
+                            layout: []
+                        });
+                    });
+                    renderWithProviders(_jsx(DynamicFlow, { flowId: "the-flow-id", httpClient: mockHttpClient, initialStep: getStepWithBack({ back: { title: backLabel, action: backAction } }), onCompletion: onCompletion, onError: onError }));
+                    backButton = screen.getByRole('link', { name: backLabel });
+                    return [4 /*yield*/, userEvent.click(backButton)];
+                case 1:
+                    _a.sent();
+                    expect(mockHttpClient).toHaveBeenCalledWith('/back', expect.objectContaining({ method: 'GET' }));
+                    return [4 /*yield*/, expect(screen.findByRole('heading', { name: 'Next step' })).resolves.toBeInTheDocument()];
+                case 2:
+                    _a.sent();
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    describe('when the backButton action specified the POST method', function () {
+        var backLabel = 'Back to payment methods';
+        var backAction = {
+            method: 'POST',
+            url: '/back'
+        };
+        var mockHttpClient = jest.fn();
+        beforeEach(function () {
+            mockHttpClient.mockImplementationOnce(function () {
+                return respondWith({
+                    title: 'Next step',
+                    schemas: [],
+                    layout: []
+                });
+            });
+        });
+        var initialStep = getStepWithBack({ back: { title: backLabel, action: backAction } });
+        it('performs (POST) action on back', function () { return __awaiter(void 0, void 0, void 0, function () {
+            var backButton;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        renderWithProviders(_jsx(DynamicFlow, { flowId: "the-flow-id", httpClient: mockHttpClient, initialStep: initialStep, onCompletion: onCompletion, onError: onError }));
+                        backButton = screen.getByRole('link', { name: backLabel });
+                        return [4 /*yield*/, userEvent.click(backButton)];
+                    case 1:
+                        _a.sent();
+                        expect(mockHttpClient).toHaveBeenCalledWith('/back', expect.objectContaining({ method: 'POST' }));
+                        return [4 /*yield*/, expect(screen.findByRole('heading', { name: 'Next step' })).resolves.toBeInTheDocument()];
+                    case 2:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+        it('does not display client-side validation errors', function () { return __awaiter(void 0, void 0, void 0, function () {
+            var backButton;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        renderWithProviders(_jsx(DynamicFlow, { flowId: "the-flow-id", httpClient: mockHttpClient, initialStep: initialStep, onCompletion: onCompletion, onError: onError }));
+                        backButton = screen.getByRole('link', { name: backLabel });
+                        return [4 /*yield*/, userEvent.click(backButton)];
+                    case 1:
+                        _a.sent();
+                        expect(screen.queryByText('Please fill out this field.')).not.toBeInTheDocument();
+                        return [4 /*yield*/, expect(screen.findByRole('heading', { name: 'Next step' })).resolves.toBeInTheDocument()];
+                    case 2:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+    });
+});