@wise/dynamic-flow-client 5.25.1 → 5.25.2

package/build/domain/components/step/StepDomainComponent.js

@@ -0,0 +1,150 @@
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+import { getLocalValues, getSubmittableData, getSubmittableDataSync, } from '../../../utils/component-utils';
+import { getStepDelays } from '../../features/delay/getStepDelays';
+import { getInputUpdateFunction } from '../utils/component-utils';
+export const createStepComponent = (props) => {
+    const { uid, stepPolling, stepRefreshAfter, stepPrefetch, features, logEvent, onComponentUpdate, onLoad } = props, rest = __rest(props, ["uid", "stepPolling", "stepRefreshAfter", "stepPrefetch", "features", "logEvent", "onComponentUpdate", "onLoad"]);
+    const update = getInputUpdateFunction(onComponentUpdate);
+    const resetDelayState = () => {
+        if (component.loadingState === 'delay-pending') {
+            update(component, (draft) => {
+                draft.loadingState = 'idle';
+            });
+        }
+    };
+    const stepDelays = getStepDelays(resetDelayState);
+    const component = Object.assign(Object.assign({ uid }, rest), { type: 'step', kind: 'step', state: 'initial', modals: [], requestCache: stepPrefetch.requestCache, subflow: null, dismissModal() {
+            var _a;
+            (_a = component.modals.at(-1)) === null || _a === void 0 ? void 0 : _a.close();
+        },
+        dismissAllModals() {
+            update(component, (draft) => {
+                draft.modals = draft.modals.map((m) => (Object.assign(Object.assign({}, m), { open: false })));
+            });
+        },
+        showModal(modal) {
+            if (component.state === 'started') {
+                modal.start();
+            }
+            update(component, (draft) => {
+                draft.modals = [...draft.modals, modal];
+            });
+        },
+        getChildren() {
+            return component.externalConfirmation
+                ? [...component.layoutComponents, component.externalConfirmation]
+                : component.layoutComponents;
+        },
+        getModals() {
+            return component.modals;
+        },
+        async getSubmittableValue() {
+            return getSubmittableData(component.schemaComponents);
+        },
+        getSubmittableValueSync() {
+            return getSubmittableDataSync(component.schemaComponents);
+        },
+        getLocalValue() {
+            return getLocalValues(component.schemaComponents);
+        },
+        validate() {
+            const isStrict = features.isEnabled('validateUnreferencedSchemas');
+            return component.schemaComponents
+                .map((inputComponent) => validateInputComponent(component, inputComponent, isStrict, logEvent))
+                .every(Boolean);
+        },
+        setLoadingState(loadingState) {
+            update(component, (draft) => {
+                draft.loadingState = loadingState;
+            });
+        },
+        startDelay(delay) {
+            component.setLoadingState('delay-pending');
+            return stepDelays.start(delay);
+        },
+        addSubflow(subflow) {
+            if (component.state === 'started') {
+                subflow.start();
+            }
+            update(component, (draft) => {
+                draft.subflow = subflow;
+            });
+        },
+        closeSubflow() {
+            if (!component.subflow) {
+                return;
+            }
+            component.subflow.stop();
+            update(component, (draft) => {
+                draft.subflow = null;
+            });
+        },
+        start() {
+            if (component.state === 'initial') {
+                onLoad === null || onLoad === void 0 ? void 0 : onLoad();
+            }
+            update(component, (draft) => {
+                draft.state = 'started';
+            });
+            stepPolling === null || stepPolling === void 0 ? void 0 : stepPolling.start();
+            stepRefreshAfter === null || stepRefreshAfter === void 0 ? void 0 : stepRefreshAfter.start();
+            stepPrefetch.start(component.getSubmittableValueSync());
+            getAllSubcomponents(component).forEach((child) => child.start());
+        },
+        stop() {
+            stepPolling === null || stepPolling === void 0 ? void 0 : stepPolling.stop();
+            stepRefreshAfter === null || stepRefreshAfter === void 0 ? void 0 : stepRefreshAfter.stop();
+            stepDelays.stop();
+            stepPrefetch.stop();
+            getAllSubcomponents(component).forEach((child) => child.stop());
+            update(component, (draft) => {
+                draft.state = 'stopped';
+                draft.modals = [];
+            });
+        },
+        setExternalConfirmation(external) {
+            update(component, (draft) => {
+                draft.externalConfirmation = external;
+            });
+        } });
+    return component;
+};
+/*
+ * `getChildren` returns the components that the step has a direct responsibility
+ * to render, but don't have special treatment (like footer content or modals).
+ *
+ * getAllSubcomponents returns *everything* the Step owns for things like
+ * lifecycle methods which are not associated with the view layer
+ */
+const getAllSubcomponents = (component) => [
+    ...component.layoutComponents,
+    ...component.schemaComponents,
+    ...component.footerComponents,
+    ...(component.externalConfirmation ? [component.externalConfirmation] : []),
+    ...component.modals,
+    ...(component.subflow ? [component.subflow] : []),
+];
+const validateInputComponent = (component, inputComponent, isStrict, logEvent) => {
+    var _a;
+    const isSchemaReferenced = component.referencedSchemaIds.includes((_a = inputComponent.schemaId) !== null && _a !== void 0 ? _a : '');
+    const isValid = inputComponent.validate();
+    if (!isSchemaReferenced && !isValid) {
+        logEvent(isStrict ? 'error' : 'warning', isStrict
+            ? 'Unreferenced schema does not pass validation. This blocks submission. You must fix your step.'
+            : 'Unreferenced schema does not pass validation. This blocks submission on iOS and Android, and soon it will on web. You should fix your step.', {
+            unreferencedSchemaId: inputComponent.schemaId,
+            componentUid: component.uid,
+        });
+    }
+    return isSchemaReferenced || isStrict ? isValid : true;
+};

package/build/domain/components/step/ToolbarComponent.js

@@ -0,0 +1 @@
+export {};

package/build/domain/components/utils/component-utils.js

@@ -0,0 +1,12 @@
+/**
+ * Helper function to update a component.
+ *
+ * @param onComponentUpdate the function that will notify the view layer that something has changed in the domain layer
+ * @returns a function that can be used to update components without the linter shouting at us.
+ */
+export const getInputUpdateFunction = (onComponentUpdate) => {
+    return (component, updateFn) => {
+        updateFn(component);
+        onComponentUpdate();
+    };
+};

package/build/domain/components/utils/debounce.js

@@ -0,0 +1,34 @@
+export const debounce = (callback, waitMs) => {
+    let timeoutId = null;
+    let lastArgs = null;
+    const clearTimer = () => {
+        if (timeoutId !== null) {
+            clearTimeout(timeoutId);
+            timeoutId = null;
+        }
+        lastArgs = null;
+    };
+    const debouncedFn = (...args) => {
+        lastArgs = args;
+        if (timeoutId !== null) {
+            clearTimeout(timeoutId);
+        }
+        timeoutId = setTimeout(() => {
+            callback(...lastArgs);
+            timeoutId = null;
+            lastArgs = null;
+        }, waitMs);
+    };
+    debouncedFn.cancel = () => {
+        if (timeoutId !== null) {
+            clearTimer();
+        }
+    };
+    debouncedFn.flush = () => {
+        if (timeoutId !== null) {
+            callback(...lastArgs);
+            clearTimer();
+        }
+    };
+    return debouncedFn;
+};

package/build/domain/components/utils/debounce.test.js

@@ -0,0 +1,67 @@
+import { vi } from 'vitest';
+import { debounce } from './debounce';
+describe('debounce', () => {
+    it('will delay function execution until the wait period has passed', () => {
+        const fn = vi.fn();
+        const debouncedFn = debounce(fn, 5);
+        debouncedFn();
+        expect(fn).toHaveBeenCalledTimes(0);
+        vi.advanceTimersByTime(5);
+        expect(fn).toHaveBeenCalledTimes(1);
+    });
+    it('will call function with provided arguments', () => {
+        const fn = vi.fn();
+        const debouncedFn = debounce(fn, 5);
+        debouncedFn('a', 'b', 'c');
+        vi.advanceTimersByTime(5);
+        expect(fn).toHaveBeenCalledTimes(1);
+        expect(fn).toHaveBeenCalledWith('a', 'b', 'c');
+    });
+    it('will reset the wait period and ignore previous executions if called within the wait period', () => {
+        const fn = vi.fn();
+        const debouncedFn = debounce(fn, 5);
+        debouncedFn(1, 2, 3);
+        vi.advanceTimersByTime(4);
+        debouncedFn('a', 'b', 'c');
+        vi.advanceTimersByTime(5);
+        expect(fn).toHaveBeenCalledTimes(1);
+        expect(fn).toHaveBeenCalledWith('a', 'b', 'c');
+    });
+    it('will call the same function twice if invoked after the wait period', () => {
+        const fn = vi.fn();
+        const debouncedFn = debounce(fn, 5);
+        debouncedFn();
+        vi.advanceTimersByTime(5);
+        debouncedFn();
+        vi.advanceTimersByTime(5);
+        expect(fn).toHaveBeenCalledTimes(2);
+    });
+    describe('flush', () => {
+        it('will call the callback immediately', () => {
+            const fn = vi.fn();
+            const debouncedFn = debounce(fn, 5);
+            debouncedFn();
+            debouncedFn.flush();
+            expect(fn).toHaveBeenCalledTimes(1);
+        });
+        it('uses the last passed args', () => {
+            const fn = vi.fn();
+            const debouncedFn = debounce(fn, 5);
+            debouncedFn(1, 2, 3);
+            debouncedFn('a', 'b', 'c');
+            debouncedFn.flush();
+            expect(fn).toHaveBeenCalledTimes(1);
+            expect(fn).toHaveBeenCalledWith('a', 'b', 'c');
+        });
+    });
+    describe('cancel', () => {
+        it('cancels any waiting callback', () => {
+            const fn = vi.fn();
+            const debouncedFn = debounce(fn, 5);
+            debouncedFn();
+            debouncedFn.cancel();
+            vi.advanceTimersByTime(5);
+            expect(fn).toHaveBeenCalledTimes(0);
+        });
+    });
+});

package/build/domain/components/utils/file-utils.js

@@ -0,0 +1,21 @@
+export const toBase64 = async (file) => new Promise((resolve, reject) => {
+    const reader = new FileReader();
+    reader.addEventListener('load', () => resolve(reader.result));
+    reader.addEventListener('error', reject);
+    reader.readAsDataURL(file);
+});
+export const base64dataUrltoFile = (dataurl, filename) => {
+    if (!isBase64DataUrl(dataurl)) {
+        return null;
+    }
+    const [, base64data] = dataurl.split(',');
+    return new File([base64ToBytes(base64data)], filename, { type: getMimeType(dataurl) });
+};
+const isBase64DataUrl = (dataurl) => dataurl.startsWith('data:') && dataurl.includes('base64') && dataurl.includes(',');
+const getMimeType = (base64dataUrl) => base64dataUrl.substring('data:'.length).split(';')[0];
+const base64ToBytes = (base64) => {
+    const charCodes = atob(base64)
+        .split('')
+        .map((m) => m.charCodeAt(0));
+    return Uint8Array.from(charCodes);
+};

package/build/domain/components/utils/file-utils.test.js

@@ -0,0 +1,27 @@
+/* eslint-disable @typescript-eslint/no-non-null-assertion */
+import { base64dataUrltoFile, toBase64 } from './file-utils';
+describe('toBase64', () => {
+    describe('given a valid file', () => {
+        it('should return a base64 string', async () => {
+            const file = new File(['hello'], 'test.txt', { type: 'text/plain' });
+            await expect(toBase64(file)).resolves.toBe('data:text/plain;base64,aGVsbG8=');
+        });
+    });
+});
+describe('dataURLtoFile', () => {
+    describe('given a valid data URL', () => {
+        const dataurl = 'data:text/plain;base64,aGVsbG8=';
+        it('should return a file that can be encoded back to the given string', async () => {
+            const file = base64dataUrltoFile(dataurl, 'test.txt');
+            expect(file).toBeInstanceOf(File);
+            expect(file.type).toBe('text/plain');
+            expect(file.name).toBe('test.txt');
+            await expect(toBase64(file)).resolves.toBe(dataurl);
+        });
+    });
+    describe('given an invalid data URL', () => {
+        it('should return null', () => {
+            expect(base64dataUrltoFile('invalid', 'test.txt')).toBeNull();
+        });
+    });
+});

package/build/domain/components/utils/getRandomId.js

@@ -0,0 +1 @@
+export const getRandomId = () => Math.random().toString(36).substring(2);

package/build/domain/components/utils/isExactLocalValueMatch.js

@@ -0,0 +1,14 @@
+import { isArrayLocalValue, isObjectLocalValue } from '../../../utils/type-utils';
+export const isExactLocalValueMatch = (valueA, valueB) => {
+    if (isArrayLocalValue(valueA) && isArrayLocalValue(valueB)) {
+        return (valueA.length === valueB.length &&
+            valueA.every((value, index) => isExactLocalValueMatch(value, valueB[index])));
+    }
+    if (isObjectLocalValue(valueA) && isObjectLocalValue(valueB)) {
+        const keysA = Object.keys(valueA);
+        const keysB = Object.keys(valueB);
+        return (keysA.length === keysB.length &&
+            keysA.every((key) => isExactLocalValueMatch(valueA[key], valueB[key])));
+    }
+    return valueA === valueB;
+};

package/build/domain/components/utils/isOrWasValid.js

@@ -0,0 +1,5 @@
+export const isOrWasValid = (getErrors, previous, current) => {
+    const wasValid = getErrors(previous).length === 0 && previous !== null;
+    const isValid = getErrors(current).length === 0;
+    return wasValid || isValid;
+};

package/build/domain/components/utils/isPartialModelMatch.js

@@ -0,0 +1,18 @@
+import { isArrayModel, isObjectModel } from '../../../utils/type-utils';
+import { isNullish } from '../../../utils/type-validators';
+export const isPartialModelMatch = (localModel, incomingModel) => {
+    if (isArrayModel(localModel) && isArrayModel(incomingModel)) {
+        return (localModel.length === incomingModel.length &&
+            localModel.every((value, index) => isPartialModelMatch(value, incomingModel[index])));
+    }
+    if (isObjectModel(localModel) && isObjectModel(incomingModel)) {
+        if (Object.keys(localModel).length === 0 && Object.keys(incomingModel).length === 0) {
+            return true;
+        }
+        const nonNullishKeysInBoth = nonNullishKeys(localModel).filter((key) => nonNullishKeys(incomingModel).includes(key));
+        return (nonNullishKeysInBoth.length > 0 &&
+            nonNullishKeysInBoth.every((key) => isPartialModelMatch(localModel[key], incomingModel[key])));
+    }
+    return localModel === incomingModel;
+};
+const nonNullishKeys = (model) => Object.keys(model).filter((key) => !isNullish(model[key]));

package/build/domain/components/utils/isPartialModelMatch.test.js

@@ -0,0 +1,74 @@
+import { isPartialModelMatch } from './isPartialModelMatch';
+describe('isPartialModelMatch', () => {
+    describe('when both models are arrays', () => {
+        it('will return true if both models are empty', () => {
+            expect(isPartialModelMatch([], [])).toBe(true);
+        });
+        it('will return false if the models have different lengths', () => {
+            expect(isPartialModelMatch([1], [1, 2])).toBe(false);
+            expect(isPartialModelMatch([1, 2], [1])).toBe(false);
+        });
+        it('will return false if any of the items in the array do not partially match', () => {
+            expect(isPartialModelMatch([1], [2])).toBe(false);
+            expect(isPartialModelMatch([[1]], [[2]])).toBe(false);
+            expect(isPartialModelMatch([{ prop: 'value' }], [{ prop: 'different value' }])).toBe(false);
+        });
+        it('will return true if all items in the arrays partially match', () => {
+            expect(isPartialModelMatch([1], [1])).toBe(true);
+        });
+    });
+    describe('when both models are objects', () => {
+        it('wil return true if both localModel and incomingModel are empty', () => {
+            expect(isPartialModelMatch({}, {})).toBe(true);
+        });
+        it('will return false if localModel is empty', () => {
+            expect(isPartialModelMatch({}, { prop: 1 })).toBe(false);
+        });
+        it('will return false if incomingModel is empty', () => {
+            expect(isPartialModelMatch({ prop: 1 }, {})).toBe(false);
+        });
+        it('will return false if the models have matching keys with different values', () => {
+            expect(isPartialModelMatch({ key: 1 }, { key: 2 })).toBe(false);
+            expect(isPartialModelMatch({ key: 2 }, { key: 1 })).toBe(false);
+        });
+        it('will return true if matching keys have the same value', () => {
+            expect(isPartialModelMatch({ key: 1 }, { key: 1 })).toBe(true);
+        });
+        it('will ignore the value of non-matching keys', () => {
+            expect(isPartialModelMatch({ matchingKey: 1 }, { matchingKey: 1, otherKey: 2 })).toBe(true);
+            expect(isPartialModelMatch({ otherKey: 2, matchingKey: 1 }, { matchingKey: 1 })).toBe(true);
+        });
+        it('will ignore the value of nullish keys', () => {
+            expect(isPartialModelMatch({ matchingKey: 1, otherKey: 2 }, { matchingKey: 1, otherKey: null })).toBe(true);
+            expect(isPartialModelMatch({ otherKey: null, matchingKey: 1 }, { matchingKey: 1, otherKey: 2 })).toBe(true);
+            expect(isPartialModelMatch({ matchingKey: 1, otherKey: null }, { matchingKey: 1 })).toBe(true);
+            expect(isPartialModelMatch({ matchingKey: 1 }, { matchingKey: 1, otherKey: null })).toBe(true);
+        });
+        it('looks for matches recursively', () => {
+            expect(isPartialModelMatch({ matchingKey: [{ matchingKey: 2 }] }, { matchingKey: [{ matchingKey: 2 }] })).toBe(true);
+            expect(isPartialModelMatch({ matchingKey: [{ matchingKey: 2 }] }, { matchingKey: [{ matchingKey: 3 }] })).toBe(false);
+        });
+    });
+    describe('when both models are matching primitives', () => {
+        it('will return true if the models are equal', () => {
+            expect(isPartialModelMatch(1, 1)).toBe(true);
+            expect(isPartialModelMatch('value', 'value')).toBe(true);
+            expect(isPartialModelMatch(true, true)).toBe(true);
+        });
+        it('will return false if the models are not equal', () => {
+            expect(isPartialModelMatch(1, 2)).toBe(false);
+            expect(isPartialModelMatch('value', 'different value')).toBe(false);
+            expect(isPartialModelMatch(true, false)).toBe(false);
+        });
+    });
+    describe('when models are of different types', () => {
+        it('will always return false', () => {
+            expect(isPartialModelMatch(null, 1)).toBe(false);
+            expect(isPartialModelMatch(1, null)).toBe(false);
+            expect(isPartialModelMatch({}, [])).toBe(false);
+            expect(isPartialModelMatch([], {})).toBe(false);
+            expect(isPartialModelMatch(1, {})).toBe(false);
+            expect(isPartialModelMatch({}, 1)).toBe(false);
+        });
+    });
+});

package/build/domain/features/collection/getPerformCollectionQuery.js

@@ -0,0 +1,80 @@
+import { isArray } from '../../../utils/type-validators';
+export const getPerformCollectionQuery = (httpClient, baseRequest, mapState) => {
+    let latestSuccessfulRequestHash = null;
+    let latestSuccessfulResults = null;
+    return async (props) => {
+        const requestHash = hashRequest(props);
+        if (requestHash !== latestSuccessfulRequestHash) {
+            const response = await performRequest(baseRequest, props, httpClient);
+            const results = await parseResponse(response);
+            // eslint-disable-next-line require-atomic-updates
+            latestSuccessfulRequestHash = requestHash;
+            const mappedState = mapState(results);
+            latestSuccessfulResults = mappedState;
+            return mappedState;
+        }
+        return latestSuccessfulResults;
+    };
+};
+const performRequest = (request, queryProps, httpClient) => {
+    const { url, method, body, headers } = request;
+    if (method === 'GET') {
+        return httpClient(buildQueryURL(url, queryProps), {
+            method,
+            headers: Object.assign(Object.assign({}, headers), { 'Content-Type': 'application/json' }),
+            signal: queryProps.signal,
+        });
+    }
+    return httpClient(url, {
+        method,
+        headers: Object.assign(Object.assign({}, headers), { 'Content-Type': 'application/json' }),
+        signal: queryProps.signal,
+        body: JSON.stringify(Object.assign(Object.assign({}, (body && typeof body === 'object' && !isArray(body) ? body : {})), buildRequestBody(queryProps))),
+    });
+};
+const buildQueryURL = (url, { searchParam, query, cursor, filters = [] }) => {
+    const [baseUrl, queryParams] = splitUrlAndParams(url);
+    const params = new URLSearchParams(queryParams);
+    if (searchParam && query) {
+        params.append(searchParam, query);
+    }
+    if (cursor) {
+        params.append('cursor', cursor);
+    }
+    getFilterValues(filters).forEach(([key, value]) => {
+        if (typeof value === 'string') {
+            params.append(key, value);
+        }
+        else {
+            value.forEach((v) => params.append(key, v));
+        }
+    });
+    return `${baseUrl}?${params.toString()}`;
+};
+const splitUrlAndParams = (url) => {
+    const [baseUrl, ...rest] = url.split('?');
+    return [baseUrl, rest.join('')];
+};
+const buildRequestBody = ({ searchParam, query, cursor, filters = [], }) => (Object.assign(Object.assign(Object.assign({}, (searchParam && query ? { [searchParam]: query } : {})), Object.fromEntries(getFilterValues(filters))), { cursor }));
+const getFilterValues = (filters) => {
+    return filters
+        .map((filter) => {
+        const { multiSelect, param } = filter;
+        const values = filter.options
+            .filter((option) => option.selected)
+            .map((option) => option.value);
+        if (values.length === 0) {
+            return undefined;
+        }
+        return [param, multiSelect ? values : values[0]];
+    })
+        .filter((value) => value !== undefined);
+};
+const parseResponse = async (response) => {
+    if (response.ok) {
+        const body = (await response.json().catch(() => null));
+        return body;
+    }
+    throw Error('error response');
+};
+const hashRequest = ({ query, cursor, filters, }) => JSON.stringify({ query, cursor, filters: getFilterValues(filters !== null && filters !== void 0 ? filters : []) });