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

package/build/legacy/step/layoutStep/utils/inline-reference-utils.js

@@ -0,0 +1,105 @@
+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 './layout-utils';
+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 __assign(__assign({}, component), { components: inlineReferences({ layout: component.components, schemas: schemas, actions: actions, model: model }) });
+        }
+        if (component.type === 'modal') {
+            return __assign(__assign({}, component), { components: inlineReferences({
+                    layout: component.content.components,
+                    schemas: schemas,
+                    actions: actions,
+                    model: model,
+                }) });
+        }
+        if (component.type === 'columns') {
+            return __assign(__assign({}, component), { left: inlineReferences({ layout: component.left, schemas: schemas, actions: actions, model: model }), right: inlineReferences({ layout: component.right, schemas: schemas, actions: actions, model: model }) });
+        }
+        return component;
+    });
+}
+function inlineFormSchema(_a) {
+    var formComponent = _a.formComponent, schemas = _a.schemas;
+    if (formComponent.schemaId) {
+        return {
+            type: 'form',
+            margin: formComponent.margin,
+            schema: getSchemaById(schemas, formComponent.schemaId),
+        };
+    }
+    if (formComponent.schema && isReference(formComponent.schema) && formComponent.schema.$ref) {
+        return {
+            type: 'form',
+            margin: formComponent.margin,
+            schema: getSchemaById(schemas, formComponent.schema.$ref),
+        };
+    }
+    if (formComponent.schema && !isReference(formComponent.schema)) {
+        return __assign({}, formComponent);
+    }
+    throw new Error('Invalid form layout component. Missing "schema" or "schemaId" properties.');
+}
+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 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.hasOwnProperty.call(block, '$ref');
+}

package/build/legacy/step/layoutStep/utils/inline-reference-utils.spec.js

@@ -0,0 +1,296 @@
+import { inlineReferences } from '.';
+describe('inlineReferences tests', function () {
+    var schemas = [
+        {
+            $id: '#myDetails',
+            type: 'object',
+            properties: {
+                name: { type: 'string' },
+            },
+        },
+        {
+            $id: '#myAddress',
+            type: 'object',
+            properties: {
+                address: { type: 'string' },
+            },
+        },
+    ];
+    var actions = [
+        {
+            $id: '#submitMyDetails',
+            title: 'Continue',
+            url: '/v3',
+            type: 'primary',
+            method: 'POST',
+            disabled: false,
+        },
+        {
+            $id: '#submitMyAddress',
+            title: 'Continue',
+            url: '/v3',
+            type: 'primary',
+            method: 'POST',
+            disabled: false,
+        },
+    ];
+    describe('when there are schemas and layout', function () {
+        describe('using schemaId property', function () {
+            it('inlines schema of top level form components', function () {
+                var simpleLayout = [
+                    {
+                        type: 'form',
+                        schemaId: '#myDetails',
+                    },
+                    {
+                        type: 'form',
+                        schemaId: '#myAddress',
+                    },
+                    {
+                        type: 'action',
+                        $ref: '#submitMyDetails',
+                    },
+                    {
+                        type: 'action',
+                        $ref: '#submitMyAddress',
+                    },
+                ];
+                var expected = [
+                    {
+                        type: 'form',
+                        margin: undefined,
+                        schema: {
+                            $id: '#myDetails',
+                            type: 'object',
+                            properties: {
+                                name: { type: 'string' },
+                            },
+                        },
+                    },
+                    {
+                        type: 'form',
+                        margin: undefined,
+                        schema: {
+                            $id: '#myAddress',
+                            type: 'object',
+                            properties: {
+                                address: { type: 'string' },
+                            },
+                        },
+                    },
+                    {
+                        $ref: '#submitMyDetails',
+                        type: 'action',
+                    },
+                    {
+                        $ref: '#submitMyAddress',
+                        type: 'action',
+                    },
+                ];
+                expect(inlineReferences({ layout: simpleLayout, schemas: schemas, actions: actions })).toStrictEqual(expected);
+            });
+        });
+        describe('using schema.$ref', function () {
+            it('inlines schema of top level form components', function () {
+                var simpleLayout = [
+                    {
+                        type: 'form',
+                        schema: {
+                            $ref: '#myDetails',
+                        },
+                    },
+                    {
+                        type: 'form',
+                        schema: {
+                            $ref: '#myAddress',
+                        },
+                    },
+                    {
+                        type: 'action',
+                        $ref: '#submitMyDetails',
+                    },
+                    {
+                        type: 'action',
+                        $ref: '#submitMyAddress',
+                    },
+                ];
+                var expected = [
+                    {
+                        type: 'form',
+                        margin: undefined,
+                        schema: {
+                            $id: '#myDetails',
+                            type: 'object',
+                            properties: {
+                                name: { type: 'string' },
+                            },
+                        },
+                    },
+                    {
+                        type: 'form',
+                        margin: undefined,
+                        schema: {
+                            $id: '#myAddress',
+                            type: 'object',
+                            properties: {
+                                address: { type: 'string' },
+                            },
+                        },
+                    },
+                    {
+                        $ref: '#submitMyDetails',
+                        type: 'action',
+                    },
+                    {
+                        $ref: '#submitMyAddress',
+                        type: 'action',
+                    },
+                ];
+                expect(inlineReferences({ layout: simpleLayout, schemas: schemas, actions: actions })).toStrictEqual(expected);
+            });
+        });
+        describe('when a form component is missing both schemaId and schema properties', function () {
+            it('throws an error', function () {
+                var formComponentMissingSchema = { type: 'form' };
+                expect(function () {
+                    inlineReferences({ layout: [formComponentMissingSchema], schemas: schemas, actions: actions });
+                }).toThrow(expect.anything());
+            });
+        });
+        it('inlines schemas inside boxes', function () {
+            var boxLayout = [
+                {
+                    type: 'box',
+                    components: [
+                        {
+                            type: 'form',
+                            schema: {
+                                $ref: '#myAddress',
+                            },
+                        },
+                        {
+                            type: 'action',
+                            $ref: '#submitMyAddress',
+                        },
+                    ],
+                },
+            ];
+            var expected = [
+                {
+                    type: 'box',
+                    components: [
+                        {
+                            type: 'form',
+                            margin: undefined,
+                            schema: {
+                                $id: '#myAddress',
+                                type: 'object',
+                                properties: {
+                                    address: { type: 'string' },
+                                },
+                            },
+                        },
+                        {
+                            $ref: '#submitMyAddress',
+                            type: 'action',
+                        },
+                    ],
+                },
+            ];
+            expect(inlineReferences({ layout: boxLayout, schemas: schemas, actions: actions })).toStrictEqual(expected);
+        });
+        it('inlines schemas inside columns', function () {
+            var columnLayout = [
+                {
+                    type: 'columns',
+                    left: [
+                        {
+                            type: 'form',
+                            schema: {
+                                $ref: '#myDetails',
+                            },
+                        },
+                        {
+                            type: 'action',
+                            $ref: '#submitMyDetails',
+                        },
+                    ],
+                    right: [
+                        {
+                            type: 'form',
+                            schema: {
+                                $ref: '#myAddress',
+                            },
+                        },
+                        {
+                            type: 'action',
+                            $ref: '#submitMyAddress',
+                        },
+                    ],
+                },
+            ];
+            var expected = [
+                {
+                    type: 'columns',
+                    left: [
+                        {
+                            type: 'form',
+                            margin: undefined,
+                            schema: {
+                                $id: '#myDetails',
+                                type: 'object',
+                                properties: {
+                                    name: { type: 'string' },
+                                },
+                            },
+                        },
+                        {
+                            $ref: '#submitMyDetails',
+                            type: 'action',
+                        },
+                    ],
+                    right: [
+                        {
+                            type: 'form',
+                            margin: undefined,
+                            schema: {
+                                $id: '#myAddress',
+                                type: 'object',
+                                properties: {
+                                    address: { type: 'string' },
+                                },
+                            },
+                        },
+                        {
+                            $ref: '#submitMyAddress',
+                            type: 'action',
+                        },
+                    ],
+                },
+            ];
+            expect(inlineReferences({ layout: columnLayout, schemas: schemas, actions: actions })).toStrictEqual(expected);
+        });
+    });
+    describe('when there are no schemas', function () {
+        var layout = [
+            {
+                type: 'heading',
+                text: 'Title',
+            },
+            {
+                type: 'paragraph',
+                text: 'Lorem Ipsum',
+            },
+        ];
+        it('should return the original layout', function () {
+            expect(inlineReferences({ layout: layout })).toStrictEqual(layout);
+            expect(inlineReferences({ layout: layout, schemas: [] })).toStrictEqual(layout);
+        });
+    });
+    describe('when there is no layout', function () {
+        it('should return an empty layout', function () {
+            expect(inlineReferences({})).toStrictEqual([]);
+            expect(inlineReferences({ schemas: [] })).toStrictEqual([]);
+        });
+    });
+});

package/build/legacy/step/layoutStep/utils/layout-utils.js

@@ -0,0 +1,212 @@
+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;
+    // 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 'external':
+            return convertExternalStepToDynamicLayout(step);
+        default:
+            return convertFormStepToDynamicLayout(step);
+    }
+}
+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);
+}