pne-ui 4.0.45 → 4.0.47

package/esm/component/search-ui/filters/state/actions.js

@@ -1,5 +1,5 @@
 import { exhaustiveCheck, } from '../../../..';
-import { CriterionTypeEnum, ExactCriterionSearchLabelEnum, LinkedEntityTypeEnum, MultichoiceFilterTypeEnum, ThreeDCriterionEnum, } from '../types';
+import { CUSTOMER_LEVEL_DEPENDENCIES, CriterionTypeEnum, ExactCriterionSearchLabelEnum, LinkedEntityTypeEnum, MultichoiceFilterTypeEnum, ThreeDCriterionEnum, } from '../types';
 import { getCriteriaWithAvailabilityRules, isCriterionAvailable, } from '../criterionAvailability';
 import { getSearchUIFiltersInitialState, getSearchUIInitialGrouping, getSearchUIInitialProjectCurrency, getSearchUIInitialSearchCriteria, searchUICountriesInitialAllableCollection, searchUIInitialAllableCollection, searchUIInitialDateFrom, searchUIInitialDateTo, } from './initial';
 // import {raiseUIError} from '../../../../../error';
@@ -10,6 +10,7 @@ import isoWeek from 'dayjs/plugin/isoWeek';
 import cloneDeep from 'lodash/cloneDeep';
 import isEqual from 'lodash/isEqual';
 import { applyDateOnlyTimeZone, createDateOnlySearchDate, createDateOnlySearchEndExclusiveDate, resolveDateOnlyTimeZone, SEARCH_UI_NON_EXACT_DEFAULT_TIME_ZONE, } from '../dateRangeTimeZone';
+import { getConcreteCustomerLevelMerchantId } from '../customerLevelDependencies';
 dayjs.extend(utc);
 dayjs.extend(timezone);
 dayjs.extend(isoWeek);
@@ -28,6 +29,7 @@ const criterionToLinkedEntityMap = {
 const getLinkedEntityTypeByCriterion = (criterion) => {
     return criterionToLinkedEntityMap[criterion] ?? null;
 };
+const isConfiguredCriterion = (draft, criterion) => draft.possibleCriteria.includes(criterion) || draft.predefinedCriteria.includes(criterion);
 const getInitialMultigetCriterion = (entityType) => ({
     entityType: entityType,
     filterType: MultichoiceFilterTypeEnum.NONE,
@@ -78,58 +80,141 @@ const sanitizeMultigetCriteria = (incoming, activeCriteria) => {
     });
     return Array.from(uniqueByEntity.values());
 };
+const isRetainedSnapshotCompatible = (snapshot, state) => {
+    return isEqual(snapshot.possibleCriteria, state.possibleCriteria)
+        && isEqual(snapshot.predefinedCriteria, state.predefinedCriteria)
+        && isEqual(snapshot.exactSearchLabels, state.exactSearchLabels)
+        && snapshot.manualSearch === !!state.config?.manualSearch;
+};
+const addCriterionReducer = (draft, criterion, configuredOnly = false) => {
+    if (configuredOnly && !isConfiguredCriterion(draft, criterion)) {
+        return;
+    }
+    if (draft.criteria.includes(criterion)) {
+        const entityType = getLinkedEntityTypeByCriterion(criterion);
+        if (entityType !== null
+            && !draft.multigetCriteria.some(multigetCriterion => multigetCriterion.entityType === entityType)) {
+            draft.multigetCriteria.push(getInitialMultigetCriterion(entityType));
+        }
+        return;
+    }
+    draft.criteria.push(criterion);
+    addInitialMultigetCriterionReducer(draft, criterion);
+};
+const ensureCustomerLevelDependenciesReducer = (draft) => {
+    if (!draft.criteria.includes(CriterionTypeEnum.CUSTOMER_LEVEL)) {
+        return;
+    }
+    CUSTOMER_LEVEL_DEPENDENCIES.forEach(dependency => addCriterionReducer(draft, dependency, true));
+};
+const applyConditionsReducer = (draft, conditions) => {
+    const { criteria: incomingCriteria, multigetCriteria: incomingMultigetCriteria, ...rest } = conditions;
+    const prevCriteria = draft.criteria.slice();
+    Object.assign(draft, rest);
+    if (incomingCriteria !== undefined) {
+        const allowedCriteria = new Set([
+            ...draft.predefinedCriteria,
+            ...draft.possibleCriteria,
+        ]);
+        const sanitizedIncoming = Array.from(new Set(incomingCriteria.filter(criterion => allowedCriteria.has(criterion))));
+        const mergedCriteria = Array.from(new Set([
+            ...draft.predefinedCriteria,
+            ...sanitizedIncoming,
+        ]));
+        const removedCriteria = prevCriteria.filter(criterion => !mergedCriteria.includes(criterion));
+        removedCriteria.forEach(criterion => {
+            clearCriterionReducer(draft, criterion);
+        });
+        const addedCriteria = mergedCriteria.filter(criterion => !prevCriteria.includes(criterion));
+        if (incomingMultigetCriteria === undefined) {
+            addedCriteria.forEach(criterion => {
+                addInitialMultigetCriterionReducer(draft, criterion);
+            });
+        }
+        draft.criteria = mergedCriteria;
+    }
+    if (incomingMultigetCriteria !== undefined) {
+        const sanitizedMultigetCriteria = sanitizeMultigetCriteria(incomingMultigetCriteria, draft.criteria);
+        const missingEntityTypes = draft.criteria
+            .map(getLinkedEntityTypeByCriterion)
+            .filter((entityType) => entityType !== null)
+            .filter(entityType => !sanitizedMultigetCriteria.some(item => item.entityType === entityType));
+        missingEntityTypes.forEach(entityType => {
+            sanitizedMultigetCriteria.push(getInitialMultigetCriterion(entityType));
+        });
+        draft.multigetCriteria = sanitizedMultigetCriteria;
+    }
+    ensureCustomerLevelDependenciesReducer(draft);
+};
+const restoreAppliedSearchCriteria = (snapshot, retainedDraftSearchCriteria, currentSearchCriteria) => {
+    if (!snapshot.hasUnappliedFilters || !snapshot.appliedSearchCriteria) {
+        return currentSearchCriteria;
+    }
+    const retainedDraftWithoutDates = {
+        ...retainedDraftSearchCriteria,
+        dateFrom: currentSearchCriteria.dateFrom,
+        dateTo: currentSearchCriteria.dateTo,
+    };
+    if (!isEqual(retainedDraftWithoutDates, currentSearchCriteria)) {
+        return currentSearchCriteria;
+    }
+    return {
+        ...cloneDeep(snapshot.appliedSearchCriteria),
+        dateFrom: isEqual(snapshot.appliedSearchCriteria.dateFrom, retainedDraftSearchCriteria.dateFrom)
+            ? currentSearchCriteria.dateFrom
+            : snapshot.appliedSearchCriteria.dateFrom,
+        dateTo: isEqual(snapshot.appliedSearchCriteria.dateTo, retainedDraftSearchCriteria.dateTo)
+            ? currentSearchCriteria.dateTo
+            : snapshot.appliedSearchCriteria.dateTo,
+    };
+};
 export const getSearchUIFiltersActions = (set, get) => ({
-    setInitialState: (state) => {
+    setInitialState: (state, retainedSnapshot) => {
         set((draft) => {
-            return {
+            const initialState = {
                 ...draft,
                 ...getSearchUIFiltersInitialState(),
                 ...getSearchUIInitialSearchCriteria(state.defaults),
                 ...state,
             };
+            Object.assign(draft, initialState);
+            ensureCustomerLevelDependenciesReducer(draft);
+            if (retainedSnapshot && isRetainedSnapshotCompatible(retainedSnapshot, initialState)) {
+                applyConditionsReducer(draft, retainedSnapshot.searchConditions);
+                draft.activeTemplateName = retainedSnapshot.activeTemplateName;
+                draft.restoredFromRetention = true;
+            }
+            draft.initialized = true;
         });
-        postUpdate(set, get);
+        const retainedDraftSearchCriteria = get().restoredFromRetention
+            ? extractSearchCriteriaFromState(get())
+            : null;
+        syncCriterionAvailability(set, get);
+        normalizeRetainedDateRange(set, get);
+        ensureTransactionSessionStatusesPrefetched(set, get);
+        if (get().restoredFromRetention && retainedSnapshot && retainedDraftSearchCriteria) {
+            const currentSearchCriteria = extractSearchCriteriaFromState(get());
+            const appliedSearchCriteria = get().config?.manualSearch
+                ? restoreAppliedSearchCriteria(retainedSnapshot, retainedDraftSearchCriteria, currentSearchCriteria)
+                : currentSearchCriteria;
+            get().onFiltersUpdate(appliedSearchCriteria);
+            set((draft) => {
+                draft.prevSearchCriteria = currentSearchCriteria;
+                draft.appliedSearchCriteria = appliedSearchCriteria;
+                draft.hasUnappliedFilters = !!draft.config?.manualSearch
+                    && !isEqual(currentSearchCriteria, appliedSearchCriteria);
+            });
+            return;
+        }
+        checkIfFiltersChanged(set, get);
     },
     updateConditions: (conditions, options) => {
         set((draft) => {
-            const { criteria: incomingCriteria, multigetCriteria: incomingMultigetCriteria, ...rest } = conditions;
-            const prevCriteria = draft.criteria.slice();
-            Object.assign(draft, rest);
-            if (incomingCriteria !== undefined) {
-                const allowedCriteria = new Set([
-                    ...draft.predefinedCriteria,
-                    ...draft.possibleCriteria,
-                ]);
-                const sanitizedIncoming = Array.from(new Set(incomingCriteria.filter(criterion => allowedCriteria.has(criterion))));
-                const mergedCriteria = Array.from(new Set([
-                    ...draft.predefinedCriteria,
-                    ...sanitizedIncoming,
-                ]));
-                const removedCriteria = prevCriteria.filter(criterion => !mergedCriteria.includes(criterion));
-                removedCriteria.forEach(criterion => {
-                    clearCriterionReducer(draft, criterion);
-                });
-                const addedCriteria = mergedCriteria.filter(criterion => !prevCriteria.includes(criterion));
-                if (incomingMultigetCriteria === undefined) {
-                    addedCriteria.forEach(criterion => {
-                        addInitialMultigetCriterionReducer(draft, criterion);
-                    });
-                }
-                draft.criteria = mergedCriteria;
-            }
-            if (incomingMultigetCriteria !== undefined) {
-                const sanitizedMultigetCriteria = sanitizeMultigetCriteria(incomingMultigetCriteria, draft.criteria);
-                const missingEntityTypes = draft.criteria
-                    .map(getLinkedEntityTypeByCriterion)
-                    .filter((entityType) => entityType !== null)
-                    .filter(entityType => !sanitizedMultigetCriteria.some(item => item.entityType === entityType));
-                missingEntityTypes.forEach(entityType => {
-                    sanitizedMultigetCriteria.push(getInitialMultigetCriterion(entityType));
-                });
-                draft.multigetCriteria = sanitizedMultigetCriteria;
-            }
+            applyConditionsReducer(draft, conditions);
             if (options?.resetTemplate) {
                 draft.template = null;
+                draft.activeTemplateName = null;
+                draft.skipLastTemplateAutoApply = true;
             }
         });
         postUpdate(set, get, options);
@@ -146,6 +231,8 @@ export const getSearchUIFiltersActions = (set, get) => ({
         set(draft => {
             Object.assign(draft, conditions);
             draft.template = template;
+            draft.activeTemplateName = template?.name ?? null;
+            ensureCustomerLevelDependenciesReducer(draft);
         });
         syncCriterionAvailability(set, get);
         const currentSearchCriteria = extractSearchCriteriaFromState(get());
@@ -154,19 +241,23 @@ export const getSearchUIFiltersActions = (set, get) => ({
         }
         set(draft => {
             draft.prevSearchCriteria = currentSearchCriteria;
+            if (!hasUnappliedFilters) {
+                draft.appliedSearchCriteria = currentSearchCriteria;
+            }
             draft.hasUnappliedFilters = hasUnappliedFilters;
         });
     },
     clearCriteria: () => {
         localStorage.removeItem(LAST_TEMPLATE_NAME + get().settingsContextName);
         set((draft) => {
-            return {
-                ...draft,
+            Object.assign(draft, {
                 ...getSearchUIInitialSearchCriteria(draft.defaults),
                 exactSearchLabel: draft.exactSearchLabels[0],
                 template: null,
+                activeTemplateName: null,
                 criteria: draft.predefinedCriteria,
-            };
+            });
+            ensureCustomerLevelDependenciesReducer(draft);
         });
         postUpdate(set, get);
     },
@@ -179,8 +270,10 @@ export const getSearchUIFiltersActions = (set, get) => ({
     },
     addCriterion: (criterionType) => {
         set((draft) => {
-            draft.criteria.push(criterionType);
-            addInitialMultigetCriterionReducer(draft, criterionType);
+            if (criterionType === CriterionTypeEnum.CUSTOMER_LEVEL) {
+                CUSTOMER_LEVEL_DEPENDENCIES.forEach(dependency => addCriterionReducer(draft, dependency, true));
+            }
+            addCriterionReducer(draft, criterionType);
         });
         get().setJustAddedCriterion(criterionType);
         postUpdate(set, get);
@@ -205,6 +298,7 @@ export const getSearchUIFiltersActions = (set, get) => ({
             set((draft) => {
                 draft.templates.push(template);
                 draft.template = template;
+                draft.activeTemplateName = template.name;
             });
         })
             // .catch(raiseUIError)
@@ -222,6 +316,7 @@ export const getSearchUIFiltersActions = (set, get) => ({
                 const index = draft.templates.findIndex(t => t.name === templateName);
                 draft.templates[index].searchConditions = template.searchConditions;
                 draft.template = template;
+                draft.activeTemplateName = template.name;
             });
         })
             // .catch(raiseUIError)
@@ -243,7 +338,9 @@ export const getSearchUIFiltersActions = (set, get) => ({
                 if (draft.template?.name === template.name) {
                     Object.assign(draft, getSearchUIInitialSearchCriteria(draft.defaults));
                     draft.template = null;
+                    draft.activeTemplateName = null;
                     draft.criteria = draft.predefinedCriteria;
+                    ensureCustomerLevelDependenciesReducer(draft);
                 }
             });
             postUpdate(set, get);
@@ -261,22 +358,37 @@ export const getSearchUIFiltersActions = (set, get) => ({
         }
         localStorage.setItem(LAST_TEMPLATE_NAME + get().settingsContextName, template.name);
         set((draft) => {
-            return {
-                ...draft,
-                template: template,
-                ...conditions,
-            };
+            Object.assign(draft, defaults);
+            draft.template = template;
+            draft.activeTemplateName = template.name;
+            applyConditionsReducer(draft, conditions);
         });
         postUpdate(set, get, options);
     },
     loadTemplates: () => {
-        get().defaults.getSearchTemplates(get().settingsContextName)
+        const settingsContextName = get().settingsContextName;
+        const defaults = get().defaults;
+        defaults.getSearchTemplates(settingsContextName)
             .then(templates => {
+            if (get().settingsContextName !== settingsContextName) {
+                return;
+            }
             const normalizedTemplates = templates.map(normalizeSearchUITemplate);
             set((draft) => {
                 draft.templates = normalizedTemplates;
             });
-            const lastTemplateName = localStorage.getItem(LAST_TEMPLATE_NAME + get().settingsContextName);
+            if (get().restoredFromRetention) {
+                const activeTemplate = normalizedTemplates.find(t => t.name === get().activeTemplateName) ?? null;
+                set((draft) => {
+                    draft.template = activeTemplate;
+                    draft.activeTemplateName = activeTemplate?.name ?? null;
+                });
+                return;
+            }
+            if (get().skipLastTemplateAutoApply) {
+                return;
+            }
+            const lastTemplateName = localStorage.getItem(LAST_TEMPLATE_NAME + settingsContextName);
             const lastTemplate = normalizedTemplates.find(t => t.name === lastTemplateName);
             if (lastTemplate) {
                 get().setTemplate(lastTemplate, { forceSearch: true });
@@ -292,8 +404,15 @@ export const getSearchUIFiltersActions = (set, get) => ({
     },
     setMultigetCriterion: (criterion) => {
         set((draft) => {
+            const previousMerchantId = criterion.entityType === LinkedEntityTypeEnum.MERCHANT
+                ? getConcreteCustomerLevelMerchantId(draft.multigetCriteria)
+                : null;
             const index = draft.multigetCriteria.findIndex(c => c.entityType === criterion.entityType);
             draft.multigetCriteria[index] = criterion;
+            if (criterion.entityType === LinkedEntityTypeEnum.MERCHANT
+                && previousMerchantId !== getConcreteCustomerLevelMerchantId(draft.multigetCriteria)) {
+                draft.customerLevel = null;
+            }
         });
         postUpdate(set, get);
     },
@@ -340,8 +459,19 @@ export const getSearchUIFiltersActions = (set, get) => ({
         });
         postUpdate(set, get);
     },
+    setCustomerLevelCriterion: customerLevel => {
+        set((draft) => {
+            draft.customerLevel = getConcreteCustomerLevelMerchantId(draft.multigetCriteria) === null
+                ? null
+                : customerLevel;
+        });
+        postUpdate(set, get);
+    },
     setCurrenciesCriterion: (currencies) => {
         set((draft) => {
+            if (!isEqual(draft.currencies, currencies)) {
+                draft.customerLevel = null;
+            }
             draft.currencies = currencies;
         });
         postUpdate(set, get);
@@ -486,6 +616,7 @@ export const getSearchUIFiltersActions = (set, get) => ({
         const currentSearchCriteria = extractSearchCriteriaFromState(get());
         get().onFiltersUpdate(currentSearchCriteria);
         set((draft) => {
+            draft.appliedSearchCriteria = currentSearchCriteria;
             draft.hasUnappliedFilters = false;
         });
     },
@@ -519,6 +650,7 @@ const addInitialMultigetCriterionReducer = (draft, criterionType) => {
         case CriterionTypeEnum.RESELLER:
             draft.multigetCriteria.push(getInitialMultigetCriterion(LinkedEntityTypeEnum.RESELLER));
             break;
+        case CriterionTypeEnum.CUSTOMER_LEVEL:
         case CriterionTypeEnum.CURRENCY:
         case CriterionTypeEnum.EXACT:
         case CriterionTypeEnum.ORDERS_SEARCH:
@@ -562,8 +694,12 @@ const clearCriterionReducer = (draft, criterionType) => {
             draft.ordersSearchLabel = 'merchant_invoice_id';
             draft.ordersSearchValue = '';
             break;
+        case CriterionTypeEnum.CUSTOMER_LEVEL:
+            draft.customerLevel = null;
+            break;
         case CriterionTypeEnum.CURRENCY:
             draft.currencies = searchUIInitialAllableCollection;
+            draft.customerLevel = null;
             break;
         case CriterionTypeEnum.COUNTRIES:
             draft.countries = searchUICountriesInitialAllableCollection;
@@ -595,6 +731,7 @@ const clearCriterionReducer = (draft, criterionType) => {
             break;
         case CriterionTypeEnum.MERCHANT:
             removeMultigetCriterionReducer(draft, LinkedEntityTypeEnum.MERCHANT);
+            draft.customerLevel = null;
             break;
         case CriterionTypeEnum.RESELLER:
             removeMultigetCriterionReducer(draft, LinkedEntityTypeEnum.RESELLER);
@@ -840,6 +977,17 @@ const postUpdate = (set, get, options) => {
     ensureTransactionSessionStatusesPrefetched(set, get);
     checkIfFiltersChanged(set, get, options);
 };
+const normalizeRetainedDateRange = (set, get) => {
+    const state = get();
+    if (!state.restoredFromRetention || state.dateRangeSpec.dateRangeSpecType === 'EXACTLY') {
+        return;
+    }
+    const timeSelectionEnabled = isDateRangeTimeSelectionEnabled(state.criteria, state.config);
+    const normalizedDateRange = calculateNonExactDates(state.dateRangeSpec, getNonExactDateRangeTimeZone(state.config, timeSelectionEnabled));
+    set(draft => {
+        draft.dateRangeSpec = normalizedDateRange;
+    });
+};
 const syncCriterionAvailability = (set, get) => {
     const criteriaWithRules = getCriteriaWithAvailabilityRules(get().config);
     if (!criteriaWithRules.length) {
@@ -895,6 +1043,7 @@ const checkIfFiltersChanged = (set, get, options) => {
             get().onFiltersUpdate(currentSearchCriteria);
             set((draft) => {
                 draft.prevSearchCriteria = currentSearchCriteria;
+                draft.appliedSearchCriteria = currentSearchCriteria;
                 draft.hasUnappliedFilters = false;
             });
         }
@@ -903,12 +1052,19 @@ const checkIfFiltersChanged = (set, get, options) => {
 const extractSearchCriteriaFromState = (state) => {
     const timeSelectionEnabled = isDateRangeTimeSelectionEnabled(state.criteria, state.config);
     const dateOnlyTimeZone = getConfiguredDateOnlyTimeZone(state.config);
+    const customerLevelDependenciesSatisfied = state.criteria.includes(CriterionTypeEnum.CUSTOMER_LEVEL)
+        && state.criteria.includes(CriterionTypeEnum.MERCHANT)
+        && state.criteria.includes(CriterionTypeEnum.CURRENCY)
+        && getConcreteCustomerLevelMerchantId(state.multigetCriteria) !== null;
     return {
         initialized: true,
         exactSearchLabel: extractExactSearchLabel(state.exactSearchLabel),
         exactSearchValue: state.exactSearchValue,
         ordersSearchLabel: state.ordersSearchLabel,
         ordersSearchValue: state.ordersSearchValue,
+        customerLevelId: customerLevelDependenciesSatisfied
+            ? state.customerLevel?.id ?? null
+            : null,
         status: extractStatus(state.status),
         threeD: extract3D(state.threeD),
         currencies: extractEntitiesIds(state.currencies),
@@ -942,6 +1098,7 @@ const getTemplate = (templateName, store) => ({
         exactSearchValue: store.exactSearchValue,
         ordersSearchLabel: store.ordersSearchLabel,
         ordersSearchValue: store.ordersSearchValue,
+        customerLevel: store.customerLevel,
         status: store.status,
         currencies: store.currencies,
         countries: store.countries,
@@ -1040,6 +1197,7 @@ export const OrdersSearchLabelsConfig = {
     'customer_billing_country': { type: 'country', maxLength: 128 },
     'customer_dna_id': { type: 'integer', maxLength: 10 },
     'customer_id': { type: 'integer', maxLength: 10 },
+    'merchant_customer_identifier': { type: 'string', maxLength: 128 },
     'batch_id': { type: 'integer', maxLength: 10 },
     'source_bank_name': { type: 'string', maxLength: 128 },
     'source_country': { type: 'country', maxLength: 128 },