@wise/dynamic-flow-client 3.11.3 → 3.11.4-experiment-node20-aa45bc2

package/build/revamp/tests/legacy/BackButton.spec.js

@@ -0,0 +1,189 @@
+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 DynamicFlowWise from '../../DynamicFlowWise';
+import { renderWithProviders, respondWith } from '../../../test-utils';
+var getStepWithBack = function (navigation) { return ({
+    id: 'back-button-step',
+    title: 'Basic step',
+    navigation: navigation,
+    schemas: [
+        {
+            $id: 'schema',
+            type: 'object',
+            displayOrder: ['name'],
+            required: ['name'],
+            properties: {
+                name: {
+                    title: 'Full name',
+                    type: 'string',
+                },
+            },
+        },
+    ],
+    layout: [
+        {
+            type: 'form',
+            schemaId: 'schema',
+        },
+    ],
+}); };
+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(DynamicFlowWise, { 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(DynamicFlowWise, { 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 __awaiter(void 0, void 0, void 0, function () {
+                        return __generator(this, function (_a) {
+                            return [2 /*return*/, respondWith({
+                                    // once again bad steps in old tests!!
+                                    id: 'next-step',
+                                    title: 'Next step',
+                                    schemas: [],
+                                    layout: [],
+                                })];
+                        });
+                    }); });
+                    renderWithProviders(_jsx(DynamicFlowWise, { 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 __awaiter(void 0, void 0, void 0, function () {
+                return __generator(this, function (_a) {
+                    return [2 /*return*/, respondWith({
+                            // added
+                            id: 'next-step',
+                            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(DynamicFlowWise, { 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(DynamicFlowWise, { 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*/];
+                }
+            });
+        }); });
+    });
+});

package/build/revamp/tests/legacy/HiddenSchemas.spec.js

@@ -0,0 +1,312 @@
+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, respondWith } from '../../../test-utils';
+import DynamicFlowWise from '../../DynamicFlowWise';
+import { createEmptyStep } from '../../test-utils/step-utils';
+// This file is a copy of the E2E test in legacy. It should remain as unchanged
+// as possible, to ensure the new client functionality matches the old one.
+var emptyStep = createEmptyStep();
+var initialStep = function (schema) { return ({
+    id: 'hidden-schema-test-step-id',
+    title: 'Hidden Schema Step Title',
+    layout: [
+        { type: 'form', schemaId: '#schema' },
+        {
+            type: 'button',
+            title: 'Submit',
+            action: { url: '/submit', method: 'POST' },
+        },
+    ],
+    schemas: [
+        __assign(__assign({}, schema), { $id: '#schema' }),
+    ],
+}); };
+var user = userEvent.setup();
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+var mockHttpClient = jest.fn(function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+    return [2 /*return*/, Promise.resolve(respondWith(emptyStep))];
+}); }); });
+var getProps = function (schema, overrides) {
+    if (overrides === void 0) { overrides = {}; }
+    return (__assign({ flowId: 'allof-schema-test-flow-id', initialStep: initialStep(schema), httpClient: mockHttpClient, onCompletion: jest.fn(), onError: jest.fn(), onEvent: jest.fn(), onLog: jest.fn() }, overrides));
+};
+beforeEach(function () { return mockHttpClient.mockClear(); });
+describe('Given an object schema which is marked as hidden', function () {
+    var schema = {
+        type: 'object',
+        title: 'Hidden Object Schema Title',
+        hidden: true,
+        displayOrder: ['name', 'location'],
+        properties: {
+            name: { type: 'string', title: 'Name' },
+            location: { type: 'string', title: 'Location' },
+        },
+    };
+    it('does not render UI components for the hidden schema', function () { return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            renderWithProviders(_jsx(DynamicFlowWise, __assign({}, getProps(schema))));
+            expect(screen.queryByLabelText('Hidden Object Schema Title')).not.toBeInTheDocument();
+            expect(screen.queryByLabelText('Name')).not.toBeInTheDocument();
+            expect(screen.queryByLabelText('Location')).not.toBeInTheDocument();
+            return [2 /*return*/];
+        });
+    }); });
+});
+describe('Given a hidden object schema whose children have default values', function () {
+    it('submits the default values', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var schema, requestBody;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    schema = {
+                        type: 'object',
+                        title: 'Hidden Object Schema Title',
+                        hidden: true,
+                        displayOrder: ['name', 'location'],
+                        properties: {
+                            name: { type: 'string', title: 'Name', default: 'Bob' },
+                            location: { type: 'string', title: 'Location', default: 'Earth' },
+                        },
+                    };
+                    renderWithProviders(_jsx(DynamicFlowWise, __assign({}, getProps(schema))));
+                    return [4 /*yield*/, user.click(screen.getByText('Submit'))];
+                case 1:
+                    _a.sent();
+                    return [4 /*yield*/, waitFor(function () { return expect(mockHttpClient).toHaveBeenCalledWith('/submit', expect.anything()); })];
+                case 2:
+                    _a.sent();
+                    requestBody = JSON.parse(mockHttpClient.mock.lastCall[1].body);
+                    expect(requestBody).toEqual({ name: 'Bob', location: 'Earth' });
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+});
+describe('Given an object schema with one of its properties marked as hidden', function () {
+    var schema = {
+        type: 'object',
+        displayOrder: ['name', 'location'],
+        required: ['location'],
+        properties: {
+            name: { type: 'string', title: 'Name' },
+            location: { type: 'string', title: 'Location', hidden: true },
+        },
+    };
+    it('only renders the schemas that are not hidden', function () {
+        renderWithProviders(_jsx(DynamicFlowWise, __assign({}, getProps(schema))));
+        expect(screen.getByText('Name')).toBeInTheDocument();
+        expect(screen.queryByText('Location')).not.toBeInTheDocument();
+    });
+    it('allows submitting even if the required hidden schema is doesnt have a valid model', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var props;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    props = getProps(schema);
+                    renderWithProviders(_jsx(DynamicFlowWise, __assign({}, props)));
+                    return [4 /*yield*/, user.click(screen.getByText('Submit'))];
+                case 1:
+                    _a.sent();
+                    return [4 /*yield*/, waitFor(function () {
+                            return expect(props.httpClient).toHaveBeenCalledWith('/submit', expect.anything());
+                        })];
+                case 2:
+                    _a.sent();
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('only submits the valid model parts', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var step, props, requestBody;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    step = __assign(__assign({}, initialStep(schema)), { model: { name: 'Bob', location: 123 } });
+                    props = getProps(schema, { initialStep: step });
+                    renderWithProviders(_jsx(DynamicFlowWise, __assign({}, props)));
+                    return [4 /*yield*/, user.click(screen.getByText('Submit'))];
+                case 1:
+                    _a.sent();
+                    return [4 /*yield*/, waitFor(function () {
+                            return expect(props.httpClient).toHaveBeenCalledWith('/submit', expect.anything());
+                        })];
+                case 2:
+                    _a.sent();
+                    requestBody = JSON.parse(mockHttpClient.mock.lastCall[1].body);
+                    expect(requestBody).not.toHaveProperty('location');
+                    expect(requestBody).toEqual({ name: 'Bob' });
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+});
+describe('Given an object schema with one of its properties being a const and hidden', function () {
+    var schema = {
+        type: 'object',
+        displayOrder: ['name', 'profileId'],
+        required: ['profileId'],
+        properties: {
+            name: { type: 'string', title: 'Name' },
+            profileId: { const: '12345678', hidden: true },
+        },
+    };
+    it('allows submitting because the hidden const provides its own value', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var props;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    props = getProps(schema);
+                    renderWithProviders(_jsx(DynamicFlowWise, __assign({}, props)));
+                    return [4 /*yield*/, user.click(screen.getByText('Submit'))];
+                case 1:
+                    _a.sent();
+                    return [4 /*yield*/, waitFor(function () {
+                            return expect(props.httpClient).toHaveBeenCalledWith('/submit', expect.anything());
+                        })];
+                case 2:
+                    _a.sent();
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+});
+describe('Given a oneOf schema with hidden const options', function () {
+    var schema = {
+        type: 'object',
+        displayOrder: ['currency'],
+        required: ['currency'],
+        properties: {
+            currency: {
+                title: 'Currency',
+                oneOf: [
+                    { const: 'EUR', title: 'EUR', hidden: true },
+                    { const: 'GBP', title: 'GBP', hidden: true },
+                    { const: 'USD', title: 'USD', hidden: true },
+                ],
+                control: 'radio',
+            },
+        },
+    };
+    it('renders all options, including the hidden ones', function () {
+        renderWithProviders(_jsx(DynamicFlowWise, __assign({}, getProps(schema))));
+        // We cannot hide hidden options because of backwards compatibility
+        // some flows may have hidden options by accident
+        expect(screen.getByLabelText('EUR')).toBeInTheDocument();
+        expect(screen.getByLabelText('GBP')).toBeInTheDocument();
+        expect(screen.getByLabelText('USD')).toBeInTheDocument();
+    });
+});
+describe('Given a oneOf schema with hidden non-const options', function () {
+    var schema = {
+        type: 'object',
+        displayOrder: ['recipientType'],
+        required: ['recipientType'],
+        properties: {
+            recipientType: {
+                title: 'Recipient Type',
+                oneOf: [
+                    {
+                        type: 'object',
+                        title: 'Person',
+                        displayOrder: ['name', 'something'],
+                        required: ['name', 'something'],
+                        properties: {
+                            name: { type: 'string', title: 'Name' },
+                            something: { type: 'string', title: 'Something', hidden: true },
+                        },
+                    },
+                    {
+                        type: 'object',
+                        title: 'Company',
+                        displayOrder: ['companyName', 'something'],
+                        required: ['companyName', 'something'],
+                        properties: {
+                            companyName: { type: 'string', title: 'Company Name' },
+                            something: { type: 'string', title: 'Something', hidden: true },
+                        },
+                    },
+                ],
+                control: 'tab',
+            },
+        },
+    };
+    it('renders all options, including the hidden ones', function () {
+        renderWithProviders(_jsx(DynamicFlowWise, __assign({}, getProps(schema))));
+        // We cannot hide hidden options because of backwards compatibility
+        // some flows may have hidden options by accident
+        expect(screen.getByLabelText('Person')).toBeInTheDocument();
+        expect(screen.getByLabelText('Company')).toBeInTheDocument();
+        expect(screen.getByLabelText('Name')).toBeInTheDocument();
+        expect(screen.queryByLabelText('Something')).not.toBeInTheDocument();
+    });
+    it('allows submission even if hidden properties inside the oneOf schema are not valid', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var props;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    props = getProps(schema);
+                    renderWithProviders(_jsx(DynamicFlowWise, __assign({}, props)));
+                    return [4 /*yield*/, user.type(screen.getByLabelText('Name'), 'John Doe')];
+                case 1:
+                    _a.sent();
+                    return [4 /*yield*/, user.click(screen.getByText('Submit'))];
+                case 2:
+                    _a.sent();
+                    return [4 /*yield*/, waitFor(function () {
+                            return expect(props.httpClient).toHaveBeenCalledWith('/submit', expect.anything());
+                        })];
+                case 3:
+                    _a.sent();
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+});