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

package/build/revamp/domain/features/search/getPerformSearchFunction.js

@@ -0,0 +1,104 @@
+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 { isArray, isObject } from '../../../utils/type-validators';
+export var getPerformSearchFunction = function (httpClient, defaultConfig) {
+    return function (_a) {
+        var _b = _a.config, config = _b === void 0 ? defaultConfig : _b, query = _a.query, signal = _a.signal;
+        return __awaiter(void 0, void 0, void 0, function () {
+            var method, param, url, headers, request, response;
+            var _c;
+            return __generator(this, function (_d) {
+                switch (_d.label) {
+                    case 0:
+                        if (!query) {
+                            return [2 /*return*/, []];
+                        }
+                        method = config.method, param = config.param, url = config.url;
+                        headers = { 'Content-Type': 'application/json' };
+                        request = method === 'GET'
+                            ? httpClient(addQueryParameter(url, param, query), {
+                                method: method,
+                                headers: headers,
+                                signal: signal,
+                            })
+                            : httpClient(url, {
+                                method: method,
+                                headers: headers,
+                                signal: signal,
+                                body: JSON.stringify((_c = {}, _c[param] = query, _c)),
+                            });
+                        return [4 /*yield*/, request];
+                    case 1:
+                        response = _d.sent();
+                        return [2 /*return*/, parseResponse(response)];
+                }
+            });
+        });
+    };
+};
+var parseResponse = function (response) { return __awaiter(void 0, void 0, void 0, function () {
+    var body;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                if (!response.ok) return [3 /*break*/, 2];
+                return [4 /*yield*/, response.json().catch(function () { return null; })];
+            case 1:
+                body = _a.sent();
+                if (isValidResponseBody(body)) {
+                    if (body.results.length === 0) {
+                        return [2 /*return*/, []];
+                    }
+                    return [2 /*return*/, body.results];
+                }
+                _a.label = 2;
+            case 2: throw Error('error response');
+        }
+    });
+}); };
+var addQueryParameter = function (url, key, value) {
+    var _a = url.split('?'), urlBase = _a[0], urlQuery = _a[1];
+    var urlQueryParams = new URLSearchParams(urlQuery);
+    urlQueryParams.set(key, value);
+    return "".concat(urlBase, "?").concat(urlQueryParams.toString());
+};
+var isValidResponseBody = function (body) {
+    return isObject(body) &&
+        'results' in body &&
+        isArray(body.results) &&
+        body.results.every(function (result) { return isObject(result) && 'title' in result && 'type' in result && 'value' in result; });
+};

package/build/revamp/domain/features/search/getPerformSearchFunction.spec.js

@@ -0,0 +1,260 @@
+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 { getPerformSearchFunction } from './getPerformSearchFunction';
+describe('getSearchFunction returns a function which', function () {
+    describe('when no config is provided', function () {
+        describe('when the default method is GET', function () {
+            var defaultConfig = {
+                url: '/testing',
+                method: 'GET',
+                param: 'query',
+            };
+            it('should use the default config', function () { return __awaiter(void 0, void 0, void 0, function () {
+                var httpClient, searchFn, abortController;
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0:
+                            httpClient = jest.fn(function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+                                return [2 /*return*/, Promise.resolve(new Response(JSON.stringify({ results: [] })))];
+                            }); }); });
+                            searchFn = getPerformSearchFunction(httpClient, defaultConfig);
+                            abortController = new AbortController();
+                            return [4 /*yield*/, searchFn({
+                                    query: 'query',
+                                    signal: abortController.signal,
+                                })];
+                        case 1:
+                            _a.sent();
+                            expect(httpClient).toHaveBeenCalledWith("/testing?".concat(defaultConfig.param, "=query"), expect.objectContaining({}));
+                            return [2 /*return*/];
+                    }
+                });
+            }); });
+        });
+        describe('when the default method is POST', function () {
+            var defaultConfig = {
+                url: '/testing',
+                method: 'POST',
+                param: 'query',
+            };
+            it('should use the default config', function () { return __awaiter(void 0, void 0, void 0, function () {
+                var httpClient, searchFn, abortController;
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0:
+                            httpClient = jest.fn(function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+                                return [2 /*return*/, Promise.resolve(new Response(JSON.stringify({ results: [] })))];
+                            }); }); });
+                            searchFn = getPerformSearchFunction(httpClient, defaultConfig);
+                            abortController = new AbortController();
+                            return [4 /*yield*/, searchFn({
+                                    query: 'query',
+                                    signal: abortController.signal,
+                                })];
+                        case 1:
+                            _a.sent();
+                            expect(httpClient).toHaveBeenCalledWith('/testing', expect.objectContaining({ method: 'POST', body: JSON.stringify({ query: 'query' }) }));
+                            return [2 /*return*/];
+                    }
+                });
+            }); });
+        });
+    });
+    describe('when another config is provided', function () {
+        it('ignores the default config', function () { return __awaiter(void 0, void 0, void 0, function () {
+            var defaultConfig, httpClient, searchFn, abortController;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        defaultConfig = {
+                            url: '/old-testing',
+                            method: 'GET',
+                            param: 'query',
+                        };
+                        httpClient = jest.fn(function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+                            return [2 /*return*/, Promise.resolve(new Response(JSON.stringify({ results: [] })))];
+                        }); }); });
+                        searchFn = getPerformSearchFunction(httpClient, defaultConfig);
+                        abortController = new AbortController();
+                        return [4 /*yield*/, searchFn({
+                                query: 'query',
+                                config: { method: 'POST', param: 'term', url: '/new-testing' },
+                                signal: abortController.signal,
+                            })];
+                    case 1:
+                        _a.sent();
+                        expect(httpClient).toHaveBeenCalledWith('/new-testing', expect.objectContaining({ method: 'POST', body: JSON.stringify({ term: 'query' }) }));
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+    });
+    describe('when a response is valid', function () {
+        describe('and the results are empty', function () {
+            it('returns an empty array', function () { return __awaiter(void 0, void 0, void 0, function () {
+                var defaultConfig, httpClient, searchFn, abortController, result;
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0:
+                            defaultConfig = {
+                                url: '/testing',
+                                method: 'GET',
+                                param: 'query',
+                            };
+                            httpClient = jest.fn(function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+                                return [2 /*return*/, Promise.resolve(new Response(JSON.stringify({ results: [] })))];
+                            }); }); });
+                            searchFn = getPerformSearchFunction(httpClient, defaultConfig);
+                            abortController = new AbortController();
+                            return [4 /*yield*/, searchFn({
+                                    query: 'query',
+                                    signal: abortController.signal,
+                                })];
+                        case 1:
+                            result = _a.sent();
+                            expect(result).toHaveLength(0);
+                            return [2 /*return*/];
+                    }
+                });
+            }); });
+        });
+        describe('and the results is not empty', function () {
+            it('returns the results', function () { return __awaiter(void 0, void 0, void 0, function () {
+                var defaultConfig, httpClient, searchFn, abortController, result;
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0:
+                            defaultConfig = {
+                                url: '/testing',
+                                method: 'GET',
+                                param: 'query',
+                            };
+                            httpClient = jest.fn(function () { return __awaiter(void 0, void 0, void 0, function () {
+                                return __generator(this, function (_a) {
+                                    return [2 /*return*/, Promise.resolve(new Response(JSON.stringify({
+                                            results: [
+                                                { type: 'action', title: '', value: {} },
+                                                {
+                                                    type: 'search',
+                                                    title: '',
+                                                    value: { query: 'query', url: '/testing', method: 'GET', param: 'query' },
+                                                },
+                                            ],
+                                        })))];
+                                });
+                            }); });
+                            searchFn = getPerformSearchFunction(httpClient, defaultConfig);
+                            abortController = new AbortController();
+                            return [4 /*yield*/, searchFn({
+                                    query: 'query',
+                                    signal: abortController.signal,
+                                })];
+                        case 1:
+                            result = _a.sent();
+                            expect(result).toStrictEqual(expect.arrayContaining([
+                                expect.objectContaining({
+                                    type: 'action',
+                                    title: '',
+                                    value: {},
+                                }),
+                                expect.objectContaining({
+                                    type: 'search',
+                                    title: '',
+                                    value: { query: 'query', url: '/testing', method: 'GET', param: 'query' },
+                                }),
+                            ]));
+                            return [2 /*return*/];
+                    }
+                });
+            }); });
+        });
+    });
+    describe('when a response has an invalid body', function () {
+        it('throws', function () { return __awaiter(void 0, void 0, void 0, function () {
+            var defaultConfig, httpClient, searchFn, abortController;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        defaultConfig = {
+                            url: '/testing',
+                            method: 'GET',
+                            param: 'query',
+                        };
+                        httpClient = jest.fn(function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+                            return [2 /*return*/, Promise.resolve(new Response('invalid body'))];
+                        }); }); });
+                        searchFn = getPerformSearchFunction(httpClient, defaultConfig);
+                        abortController = new AbortController();
+                        return [4 /*yield*/, expect(searchFn({
+                                query: 'query',
+                                signal: abortController.signal,
+                            })).rejects.toThrow()];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+    });
+    describe('when a response is non-2xx', function () {
+        it('throws', function () { return __awaiter(void 0, void 0, void 0, function () {
+            var defaultConfig, httpClient, searchFn, abortController;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        defaultConfig = {
+                            url: '/testing',
+                            method: 'GET',
+                            param: 'query',
+                        };
+                        httpClient = jest.fn(function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+                            return [2 /*return*/, Promise.resolve(new Response(JSON.stringify({ results: [] }), { status: 400 }))];
+                        }); }); });
+                        searchFn = getPerformSearchFunction(httpClient, defaultConfig);
+                        abortController = new AbortController();
+                        return [4 /*yield*/, expect(searchFn({
+                                query: 'query',
+                                signal: abortController.signal,
+                            })).rejects.toThrow()];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+    });
+});

package/build/revamp/domain/features/summary/summary-utils.js

@@ -0,0 +1,39 @@
+import { isString } from '../../../utils/type-validators';
+/** A summariser that accepts a schema and returns a function that can form a summary based on a value. */
+export var getSummariser = function (schema) {
+    return function (value) {
+        var summary = schema.summary, icon = schema.icon, image = schema.image;
+        var stringValueOrNull = isString(value) ? value : null;
+        return summaryIfProvides(summary, { value: stringValueOrNull, icon: icon, image: image });
+    };
+};
+export var getConstSummary = function (schema, model) {
+    var summary = schema.summary, icon = schema.icon, image = schema.image;
+    var value = isString(model) ? model : null;
+    return summaryIfProvides(summary, { value: value, icon: icon, image: image });
+};
+export var summariseFromChildren = function (components) {
+    return components.reduce(function (acc, component) { return mergeSummaries(acc, component.getSummary()); }, {});
+};
+// If there are duplicate props, the first takes precedence
+export var mergeSummaries = function (summaryA, summaryB) {
+    var _a, _b, _c, _d;
+    return ({
+        title: (_a = summaryA.title) !== null && _a !== void 0 ? _a : summaryB.title,
+        description: (_b = summaryA.description) !== null && _b !== void 0 ? _b : summaryB.description,
+        icon: (_c = summaryA.icon) !== null && _c !== void 0 ? _c : summaryB.icon,
+        image: (_d = summaryA.image) !== null && _d !== void 0 ? _d : summaryB.image,
+    });
+};
+var summaryIfProvides = function (summary, _a) {
+    var value = _a.value, icon = _a.icon, image = _a.image;
+    if (!summary) {
+        return {};
+    }
+    return {
+        title: (summary.providesTitle && value) || undefined,
+        description: (summary.providesDescription && value) || undefined,
+        icon: (summary.providesIcon && icon) || undefined,
+        image: (summary.providesImage && image) || undefined,
+    };
+};

package/build/revamp/domain/features/summary/summary-utils.spec.js

@@ -0,0 +1,110 @@
+import { getSummariser, getConstSummary, summariseFromChildren, mergeSummaries, } from './summary-utils';
+import { createMockTextInputComponent } from '../../../test-utils/component-utils';
+describe('summary-utils', function () {
+    describe('getSummariser', function () {
+        it('returns a function that constructs a summary based on the schema and value', function () {
+            var stringSchema = {
+                title: 'title',
+                type: 'string',
+                summary: {
+                    providesTitle: true,
+                    providesIcon: true,
+                },
+                icon: {
+                    name: 'email',
+                },
+            };
+            var summariser = getSummariser(stringSchema);
+            var summary = summariser('test value');
+            expect(summary).toEqual({
+                title: 'test value',
+                icon: {
+                    name: 'email',
+                },
+            });
+        });
+    });
+    describe('getConstSummary', function () {
+        it('returns a function that constructs a summary based on the schema', function () {
+            var schema = {
+                type: 'string',
+                const: 'const value',
+                summary: {
+                    providesTitle: true,
+                    providesIcon: true,
+                },
+                icon: {
+                    name: 'email',
+                },
+            };
+            var summary = getConstSummary(schema, 'const value');
+            expect(summary).toEqual({
+                title: 'const value',
+                icon: {
+                    name: 'email',
+                },
+            });
+        });
+        it('prefers ignores non-string values', function () {
+            var schema = {
+                type: 'array',
+                const: [],
+                summary: {
+                    providesTitle: true,
+                    providesIcon: true,
+                },
+                icon: {
+                    name: 'email',
+                },
+            };
+            var summary = getConstSummary(schema, []);
+            expect(summary).toEqual({
+                icon: {
+                    name: 'email',
+                },
+            });
+        });
+    });
+    describe('summariseFromChildren', function () {
+        it('should merge summaries from an array of components', function () {
+            var components = [
+                createMockTextInputComponent({
+                    summariser: function () { return ({
+                        title: 'title one',
+                    }); },
+                }),
+                createMockTextInputComponent({
+                    summariser: function () { return ({
+                        title: 'title two',
+                        description: 'description',
+                    }); },
+                }),
+            ];
+            expect(summariseFromChildren(components)).toEqual({
+                title: 'title one',
+                description: 'description',
+            });
+        });
+    });
+    describe('mergeSummaries', function () {
+        it('should merge two summaries, prefering earlier props if there are duplicates', function () {
+            var summaryOne = {
+                title: 'title one',
+                description: 'description',
+            };
+            var summaryTwo = {
+                title: 'title two',
+                icon: {
+                    name: 'email',
+                },
+            };
+            expect(mergeSummaries(summaryOne, summaryTwo)).toEqual({
+                title: 'title one',
+                description: 'description',
+                icon: {
+                    name: 'email',
+                },
+            });
+        });
+    });
+});

package/build/revamp/domain/features/utils/http-utils.js

@@ -0,0 +1,34 @@
+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);
+};
+export function constructPayload(_a) {
+    var _b;
+    var value = _a.value, signal = _a.signal, requestConfig = _a.requestConfig;
+    var isFile = value instanceof File;
+    var method = requestConfig.method, param = requestConfig.param;
+    var body = isFile ? wrapInFormData(param, value) : JSON.stringify((_b = {}, _b[param] = value, _b));
+    var headers = __assign({}, (!isFile && { 'Content-Type': 'application/json' }));
+    return {
+        method: method,
+        headers: headers,
+        body: body,
+        signal: signal,
+    };
+}
+var wrapInFormData = function (key, file) {
+    var formData = new FormData();
+    formData.append(key, file);
+    return formData;
+};
+export var abortAndResetController = function (abortController) {
+    abortController.abort();
+    return new AbortController();
+};

package/build/revamp/domain/features/utils/response-utils.js

@@ -0,0 +1,9 @@
+import { isErrorResponseBody } from '../../../flow/response-utils';
+import { isObject } from '../../../utils/type-validators';
+export var getAnalyticsFromErrorResponse = function (json) {
+    if (!isErrorResponseBody(json)) {
+        return undefined;
+    }
+    var analytics = json.analytics;
+    return isObject(analytics) ? analytics : undefined;
+};

package/build/revamp/domain/features/validation/spec-utils.js

@@ -0,0 +1,16 @@
+export var mockErrorMessageFunctions = {
+    minimum: jest.fn().mockReturnValue('minimum'),
+    maximum: jest.fn().mockReturnValue('maximum'),
+    minimumDate: jest.fn().mockReturnValue('minimumDate'),
+    maximumDate: jest.fn().mockReturnValue('maximumDate'),
+    minLength: jest.fn().mockReturnValue('minLength'),
+    maxLength: jest.fn().mockReturnValue('maxLength'),
+    minFiles: jest.fn().mockReturnValue('minFiles'),
+    maxFiles: jest.fn().mockReturnValue('maxFiles'),
+    minItems: jest.fn().mockReturnValue('minItems'),
+    maxItems: jest.fn().mockReturnValue('maxItems'),
+    pattern: jest.fn().mockReturnValue('pattern'),
+    required: jest.fn().mockReturnValue('required'),
+    genericError: jest.fn().mockReturnValue('genericError'),
+    genericErrorWithRetry: jest.fn().mockReturnValue('genericErrorWithRetry'),
+};

package/build/revamp/domain/features/validation/validation-functions.js

@@ -0,0 +1,12 @@
+import { isString } from '../../../utils/type-validators';
+export var validateComponents = function (components) {
+    return components.reduce(function (acc, component) { return component.validate() && acc; }, true);
+};
+/**
+ * Returns a function that takes a local value and returns an array of validation errors
+ */
+export var getLocalValueValidator = function (checks) {
+    return function (currentValue) {
+        return checks.map(function (check) { return check(currentValue); }).filter(isString);
+    };
+};