@controleonline/ui-default 1.0.264 → 1.0.266

package/src/react/utils/tableVisibleColumnsPreferences.js

@@ -1,192 +1,233 @@
-export const TABLE_VISIBLE_COLUMNS_PREFERENCES_KEY = 'tableVisibleColumns';
-export const TABLE_VIEW_MODE_PREFERENCES_KEY = 'tableViewModes';
-export const TABLE_SORT_PREFERENCES_KEY = 'tableSorts';
-export const TABLE_SORT_FIELD_PREFERENCES_KEY = 'tableSortFields';
-export const TABLE_SORT_DIRECTION_PREFERENCES_KEY = 'tableSortDirections';
-export const DEFAULT_TABLE_PREFERENCES_STORAGE_KEY = 'DefaultTablePreferences';
-
-const isPlainObject = value =>
-  !!value && typeof value === 'object' && !Array.isArray(value);
-
-const getColumnKey = column => column?.key || column?.name || '';
-
-const readStoredPreferences = () => {
-  try {
-    const rawValue = globalThis?.localStorage?.getItem?.(
-      DEFAULT_TABLE_PREFERENCES_STORAGE_KEY,
-    );
-
-    if (!rawValue) {
-      return {};
-    }
-
-    const parsedValue = JSON.parse(rawValue);
-    return isPlainObject(parsedValue) ? parsedValue : {};
-  } catch {
-    return {};
-  }
-};
-
-const writeStoredPreferences = preferences => {
-  try {
-    globalThis?.localStorage?.setItem?.(
-      DEFAULT_TABLE_PREFERENCES_STORAGE_KEY,
-      JSON.stringify(preferences),
-    );
-  } catch {
-    // localStorage can be unavailable in some runtimes
-  }
-};
-
-export const buildDefaultVisibleColumns = columns =>
-  (Array.isArray(columns) ? columns : []).reduce((accumulator, column) => {
-    const key = getColumnKey(column);
-    if (key) {
-      accumulator[key] = column?.visible !== false;
-    }
-    return accumulator;
-  }, {});
-
-export const sanitizeVisibleColumnsPreference = ({
-  columns = [],
-  visibleColumns = null,
-}) => {
-  const defaultVisibleColumns = buildDefaultVisibleColumns(columns);
-
-  if (!isPlainObject(visibleColumns)) {
-    return defaultVisibleColumns;
-  }
-
-  return Object.keys(defaultVisibleColumns).reduce((accumulator, key) => {
-    accumulator[key] =
-      typeof visibleColumns[key] === 'boolean'
-        ? visibleColumns[key]
-        : defaultVisibleColumns[key];
-    return accumulator;
-  }, {});
-};
-
-export const resolveStoredVisibleColumnsPreference = preferenceKey => {
-  if (!preferenceKey) {
-    return null;
-  }
-
-  const storedPreferences = readStoredPreferences();
-  const tableVisibleColumns = storedPreferences[TABLE_VISIBLE_COLUMNS_PREFERENCES_KEY];
-
-  if (!isPlainObject(tableVisibleColumns)) {
-    return null;
-  }
-
-  const pagePreference = tableVisibleColumns[preferenceKey];
-  return isPlainObject(pagePreference) ? pagePreference : null;
-};
-
-export const persistVisibleColumnsPreference = (
-  preferenceKey = '',
-  visibleColumns = {},
-) => {
-  if (!preferenceKey || !isPlainObject(visibleColumns)) {
-    return;
-  }
-
-  const storedPreferences = readStoredPreferences();
-  const tableVisibleColumns = isPlainObject(
-    storedPreferences[TABLE_VISIBLE_COLUMNS_PREFERENCES_KEY],
-  )
-    ? storedPreferences[TABLE_VISIBLE_COLUMNS_PREFERENCES_KEY]
-    : {};
-
-  writeStoredPreferences({
-    ...storedPreferences,
-    [TABLE_VISIBLE_COLUMNS_PREFERENCES_KEY]: {
-      ...tableVisibleColumns,
-      [preferenceKey]: visibleColumns,
-    },
-  });
-};
-
-export const resolveStoredTableViewModePreference = (
-  preferenceKey = '',
-  fallbackViewMode = 'table',
-) => {
-  if (!preferenceKey) {
-    return fallbackViewMode;
-  }
-
-  const storedPreferences = readStoredPreferences();
-  const tableViewModes = storedPreferences[TABLE_VIEW_MODE_PREFERENCES_KEY];
-
-  if (!isPlainObject(tableViewModes)) {
-    return fallbackViewMode;
-  }
-
-  const resolvedViewMode = tableViewModes[preferenceKey];
-  return resolvedViewMode === 'cards' || resolvedViewMode === 'table'
-    ? resolvedViewMode
-    : fallbackViewMode;
-};
-
-export const persistTableViewModePreference = (
+export const TABLE_VISIBLE_COLUMNS_PREFERENCES_KEY = 'visibleColumns';
+export const TABLE_VIEW_MODE_PREFERENCES_KEY = 'viewMode';
+export const TABLE_SORT_PREFERENCES_KEY = 'sort';
+export const TABLE_FILTER_PREFERENCES_KEY = 'filters';
+export const DEFAULT_TABLE_PREFERENCES_STORAGE_KEY = 'default-table';
+
+const isPlainObject = value =>
+  !!value && typeof value === 'object' && !Array.isArray(value);
+
+const getColumnKey = column => column?.key || column?.name || '';
+
+const normalizePreferenceSegment = value =>
+  String(value || '')
+    .trim()
+    .replace(/^\/+|\/+$/g, '')
+    .replace(/[/?#]+/g, '-')
+    .replace(/\s+/g, '-')
+    .replace(/-+/g, '-');
+
+export const resolveDefaultTablePreferenceScope = ({
   preferenceKey = '',
-  viewMode = 'table',
-) => {
-  if (!preferenceKey || (viewMode !== 'cards' && viewMode !== 'table')) {
-    return;
-  }
-
-  const storedPreferences = readStoredPreferences();
-  const tableViewModes = isPlainObject(
-    storedPreferences[TABLE_VIEW_MODE_PREFERENCES_KEY],
-  )
-    ? storedPreferences[TABLE_VIEW_MODE_PREFERENCES_KEY]
-    : {};
-
-  writeStoredPreferences({
-    ...storedPreferences,
-    [TABLE_VIEW_MODE_PREFERENCES_KEY]: {
-      ...tableViewModes,
-      [preferenceKey]: viewMode,
-    },
-  });
+  route = null,
+  storeName = '',
+} = {}) => {
+  const routeName =
+    normalizePreferenceSegment(preferenceKey) ||
+    normalizePreferenceSegment(globalThis?.location?.pathname) ||
+    normalizePreferenceSegment(route?.name) ||
+    normalizePreferenceSegment(route?.key) ||
+    'unknown-route';
+
+  /*
+   * @agents DefaultTable preferences are saved as [store][route].
+   * The same store can back different screens, so filters, sort, view mode,
+   * and column visibility must never be keyed only by store or only by route.
+   */
+  return {
+    routeKey: routeName,
+    storeKey: normalizePreferenceSegment(storeName) || 'unknown-store',
+  };
 };
 
-export const resolveStoredTableSortPreference = (preferenceKey = '') => {
-  if (!preferenceKey) {
+const normalizePreferenceScope = scope => {
+  if (!isPlainObject(scope)) {
     return null;
   }
 
+  const storeKey = normalizePreferenceSegment(scope.storeKey);
+  const routeKey = normalizePreferenceSegment(scope.routeKey);
+
+  return storeKey && routeKey ? {storeKey, routeKey} : null;
+};
+
+const readStoredPreferences = () => {
+  try {
+    const rawValue = globalThis?.localStorage?.getItem?.(
+      DEFAULT_TABLE_PREFERENCES_STORAGE_KEY,
+    );
+
+    if (!rawValue) {
+      return {};
+    }
+
+    const parsedValue = JSON.parse(rawValue);
+    return isPlainObject(parsedValue) ? parsedValue : {};
+  } catch {
+    return {};
+  }
+};
+
+const writeStoredPreferences = preferences => {
+  try {
+    globalThis?.localStorage?.setItem?.(
+      DEFAULT_TABLE_PREFERENCES_STORAGE_KEY,
+      JSON.stringify(preferences),
+    );
+  } catch {
+    // localStorage can be unavailable in some runtimes.
+  }
+};
+
+const readScopedPreference = scope => {
+  const resolvedScope = normalizePreferenceScope(scope);
+  if (!resolvedScope) {
+    return {};
+  }
+
   const storedPreferences = readStoredPreferences();
-  const tableSortFields =
-    storedPreferences[TABLE_SORT_FIELD_PREFERENCES_KEY];
-  const tableSortDirections =
-    storedPreferences[TABLE_SORT_DIRECTION_PREFERENCES_KEY];
-
-  const resolvedField = isPlainObject(tableSortFields)
-    ? tableSortFields[preferenceKey]
-    : '';
-  const resolvedDirection = isPlainObject(tableSortDirections)
-    ? tableSortDirections[preferenceKey]
-    : '';
+  const storePreferences = storedPreferences[resolvedScope.storeKey];
+  const routePreferences = isPlainObject(storePreferences)
+    ? storePreferences[resolvedScope.routeKey]
+    : null;
 
-  if (
-    typeof resolvedField === 'string' &&
-    resolvedField.trim() &&
-    (resolvedDirection === 'asc' || resolvedDirection === 'desc')
-  ) {
-    return {
-      direction: resolvedDirection,
-      field: resolvedField.trim(),
-    };
+  return isPlainObject(routePreferences) ? routePreferences : {};
+};
+
+const writeScopedPreference = (scope, nextValues = {}) => {
+  const resolvedScope = normalizePreferenceScope(scope);
+  if (!resolvedScope || !isPlainObject(nextValues)) {
+    return;
   }
 
-  const tableSorts = storedPreferences[TABLE_SORT_PREFERENCES_KEY];
+  const storedPreferences = readStoredPreferences();
+  const storePreferences = isPlainObject(storedPreferences[resolvedScope.storeKey])
+    ? storedPreferences[resolvedScope.storeKey]
+    : {};
+  const routePreferences = isPlainObject(storePreferences[resolvedScope.routeKey])
+    ? storePreferences[resolvedScope.routeKey]
+    : {};
 
-  if (!isPlainObject(tableSorts)) {
-    return null;
+  writeStoredPreferences({
+    ...storedPreferences,
+    [resolvedScope.storeKey]: {
+      ...storePreferences,
+      [resolvedScope.routeKey]: {
+        ...routePreferences,
+        ...nextValues,
+      },
+    },
+  });
+};
+
+export const buildDefaultVisibleColumns = columns =>
+  (Array.isArray(columns) ? columns : []).reduce((accumulator, column) => {
+    const key = getColumnKey(column);
+    if (key) {
+      accumulator[key] = column?.visible !== false;
+    }
+    return accumulator;
+  }, {});
+
+export const sanitizeVisibleColumnsPreference = ({
+  columns = [],
+  visibleColumns = null,
+}) => {
+  const defaultVisibleColumns = buildDefaultVisibleColumns(columns);
+
+  if (!isPlainObject(visibleColumns)) {
+    return defaultVisibleColumns;
+  }
+
+  return Object.keys(defaultVisibleColumns).reduce((accumulator, key) => {
+    accumulator[key] =
+      typeof visibleColumns[key] === 'boolean'
+        ? visibleColumns[key]
+        : defaultVisibleColumns[key];
+    return accumulator;
+  }, {});
+};
+
+export const sanitizeTableFiltersPreference = ({
+  columns = [],
+  filters = null,
+}) => {
+  if (!isPlainObject(filters)) {
+    return {};
   }
 
-  const resolvedSort = tableSorts[preferenceKey];
+  const columnFields = new Set(
+    (Array.isArray(columns) ? columns : [])
+      .map(getColumnKey)
+      .filter(Boolean),
+  );
+  const blockedFields = new Set(
+    (Array.isArray(columns) ? columns : [])
+      .filter(column => column?.filter === false || column?.filters === false)
+      .map(getColumnKey)
+      .filter(Boolean),
+  );
+  const allowedSpecialFields = new Set(['search']);
+
+  return Object.keys(filters).reduce((accumulator, key) => {
+    if (
+      allowedSpecialFields.has(key) ||
+      (columnFields.has(key) && !blockedFields.has(key))
+    ) {
+      accumulator[key] = filters[key];
+    }
+
+    return accumulator;
+  }, {});
+};
+
+export const resolveStoredVisibleColumnsPreference = scope => {
+  const visibleColumns =
+    readScopedPreference(scope)[TABLE_VISIBLE_COLUMNS_PREFERENCES_KEY];
+
+  return isPlainObject(visibleColumns) ? visibleColumns : null;
+};
+
+export const persistVisibleColumnsPreference = (
+  scope = null,
+  visibleColumns = {},
+) => {
+  if (!isPlainObject(visibleColumns)) {
+    return;
+  }
+
+  writeScopedPreference(scope, {
+    [TABLE_VISIBLE_COLUMNS_PREFERENCES_KEY]: visibleColumns,
+  });
+};
+
+export const resolveStoredTableViewModePreference = (
+  scope = null,
+  fallbackViewMode = 'table',
+) => {
+  const resolvedViewMode =
+    readScopedPreference(scope)[TABLE_VIEW_MODE_PREFERENCES_KEY];
+
+  return resolvedViewMode === 'cards' || resolvedViewMode === 'table'
+    ? resolvedViewMode
+    : fallbackViewMode;
+};
+
+export const persistTableViewModePreference = (
+  scope = null,
+  viewMode = 'table',
+) => {
+  if (viewMode !== 'cards' && viewMode !== 'table') {
+    return;
+  }
+
+  writeScopedPreference(scope, {
+    [TABLE_VIEW_MODE_PREFERENCES_KEY]: viewMode,
+  });
+};
+
+export const resolveStoredTableSortPreference = (scope = null) => {
+  const resolvedSort = readScopedPreference(scope)[TABLE_SORT_PREFERENCES_KEY];
 
   if (!isPlainObject(resolvedSort)) {
     return null;
@@ -212,11 +253,10 @@ export const resolveStoredTableSortPreference = (preferenceKey = '') => {
 };
 
 export const persistTableSortPreference = (
-  preferenceKey = '',
+  scope = null,
   sort = null,
 ) => {
   if (
-    !preferenceKey ||
     !isPlainObject(sort) ||
     (sort.direction !== 'asc' && sort.direction !== 'desc') ||
     typeof sort.field !== 'string' ||
@@ -225,40 +265,28 @@ export const persistTableSortPreference = (
     return;
   }
 
-  const storedPreferences = readStoredPreferences();
-  const tableSortFields = isPlainObject(
-    storedPreferences[TABLE_SORT_FIELD_PREFERENCES_KEY],
-  )
-    ? storedPreferences[TABLE_SORT_FIELD_PREFERENCES_KEY]
-    : {};
-  const tableSortDirections = isPlainObject(
-    storedPreferences[TABLE_SORT_DIRECTION_PREFERENCES_KEY],
-  )
-    ? storedPreferences[TABLE_SORT_DIRECTION_PREFERENCES_KEY]
-    : {};
-  const legacyTableSorts = isPlainObject(
-    storedPreferences[TABLE_SORT_PREFERENCES_KEY],
-  )
-    ? storedPreferences[TABLE_SORT_PREFERENCES_KEY]
-    : {};
-
-  writeStoredPreferences({
-    ...storedPreferences,
-    [TABLE_SORT_FIELD_PREFERENCES_KEY]: {
-      ...tableSortFields,
-      [preferenceKey]: sort.field.trim(),
-    },
-    [TABLE_SORT_DIRECTION_PREFERENCES_KEY]: {
-      ...tableSortDirections,
-      [preferenceKey]: sort.direction,
-    },
+  writeScopedPreference(scope, {
     [TABLE_SORT_PREFERENCES_KEY]: {
-      ...legacyTableSorts,
-      [preferenceKey]: {
-        direction: sort.direction,
-        field: sort.field.trim(),
-      },
+      direction: sort.direction,
+      field: sort.field.trim(),
     },
   });
 };
-
+
+export const resolveStoredTableFiltersPreference = (scope = null) => {
+  const resolvedFilters = readScopedPreference(scope)[TABLE_FILTER_PREFERENCES_KEY];
+  return isPlainObject(resolvedFilters) ? resolvedFilters : null;
+};
+
+export const persistTableFiltersPreference = (
+  scope = null,
+  filters = {},
+) => {
+  if (!isPlainObject(filters)) {
+    return;
+  }
+
+  writeScopedPreference(scope, {
+    [TABLE_FILTER_PREFERENCES_KEY]: filters,
+  });
+};

package/src/store/default/actions.js

@@ -54,6 +54,30 @@ const resolveCollectionTotalItems = (response, items) =>
 const normalizeCollectionItemId = item =>
   normalizeText(item?.['@id'] || item?.id || '').replace(/\D+/g, '')
 
+const normalizeSavedItemPatch = (data, patch) => {
+  if (!isPlainObject(patch)) {
+    return {}
+  }
+
+  return Object.entries(patch).reduce((normalizedPatch, [key, value]) => {
+    const incomingValue = data?.[key]
+    normalizedPatch[key] = isPlainObject(incomingValue) ? incomingValue : value
+
+    return normalizedPatch
+  }, {})
+}
+
+const mergeSavedItem = ({currentItem, data, storeMeta}) => {
+  const incomingItem = isPlainObject(data) ? {...data} : {}
+  delete incomingItem['@context']
+
+  return {
+    ...(isPlainObject(currentItem) ? currentItem : {}),
+    ...incomingItem,
+    ...normalizeSavedItemPatch(incomingItem, storeMeta.savedItemPatch),
+  }
+}
+
 const appendCollectionItems = (currentItems, nextItems) => {
   const mergedItems = Array.isArray(currentItems) ? [...currentItems] : []
   const incomingItems = Array.isArray(nextItems) ? nextItems : []
@@ -148,6 +172,7 @@ export const getOfflineItems = ({commit, getters}, params = {}) => {
   commit(types.SET_ISLOADING, true);
   commit(types.SET_ERROR, null);
   commit(types.SET_SUMMARY, {});
+  commit(types.SET_DEBUG, {});
 
   db = new localDB(getters);
 
@@ -189,6 +214,7 @@ export const getOnlineItems = ({commit, getters}, params = {}) => {
     if (getters.items != null) commit(types.SET_ITEMS, []);
     commit(types.SET_TOTALITEMS, 0);
     commit(types.SET_SUMMARY, {});
+    commit(types.SET_DEBUG, {});
   }
   return api
     .fetch(getters.resourceEndpoint, {params: queryParams})
@@ -207,6 +233,7 @@ export const getOnlineItems = ({commit, getters}, params = {}) => {
       commit(types.SET_ITEMS, nextItems);
       commit(types.SET_TOTALITEMS, resolveCollectionTotalItems(data, nextItems));
       commit(types.SET_SUMMARY, data['summary'] || data?.['hydra:summary'] || {});
+      commit(types.SET_DEBUG, data?.debug || {});
       commit(types.SET_LAST_COMPLETED_REQUEST, {
         completedAt: Date.now(),
         requestKey,
@@ -290,18 +317,25 @@ export const save = ({commit, getters}, params) => {
     .fetch(getters.resourceEndpoint + (id ? '/' + id : ''), options)
     .then(data => {
       commit(types.SET_ERROR, null);
-      delete data['@context'];
       let items = getters.items ? [...getters.items] : [];
-      if (id) {
-        const index = items.findIndex(i => {
-          return i['@id'].replace(/\D/g, '') === id;
-        });
-        if (index >= 0) items[index] = data;
-        else items.push(data);
-      } else items.push(data);
-      commit(types.SET_ITEMS, items);
-      return data;
-    })
+      if (id) {
+        const index = items.findIndex(i => {
+          return normalizeCollectionItemId(i) === id;
+        });
+        const nextItem = mergeSavedItem({
+          currentItem: index >= 0 ? items[index] : null,
+          data,
+          storeMeta,
+        });
+
+        if (index >= 0) items[index] = nextItem;
+        else items.push(nextItem);
+      } else {
+        items.push(mergeSavedItem({currentItem: null, data, storeMeta}));
+      }
+      commit(types.SET_ITEMS, items);
+      return data;
+    })
     .catch(e => {
       commitStoreError(commit, e, storeMeta)
       throw e;
@@ -385,8 +419,12 @@ export const setSummary = ({commit, getters}, summary) => {
 export const setColumns = ({commit, getters}, columns) => {
   commit(types.SET_COLUMNS, columns);
 };
-
-export const setResourceEndpoint = (
+
+export const setConfigs = ({commit, getters}, configs) => {
+  commit(types.SET_CONFIGS, configs);
+};
+
+export const setResourceEndpoint = (
   {commit, getters},
   resourceEndpoint = null,
 ) => {

package/src/store/default/getters.js

@@ -1,12 +1,14 @@
 export const error = state => state.error;
-export const isLoading = state => state.isLoading;
-export const isSaving = state => state.isSaving;
-export const totalItems = state => state.totalItems;
-export const summary = state => state.summary;
-export const items = state => state.items;
-export const item = state => state.item;
-export const columns = state => state.columns;
-export const filters = state => state.filters;
+export const isLoading = state => state.isLoading;
+export const isSaving = state => state.isSaving;
+export const totalItems = state => state.totalItems;
+export const summary = state => state.summary;
+export const debug = state => state.debug || {};
+export const items = state => state.items;
+export const item = state => state.item;
+export const columns = state => state.columns;
+export const configs = state => state.configs || {};
+export const filters = state => state.filters;
 export const resourceEndpoint = state => state.resourceEndpoint;
 export const selected = state => state.selected;
 export const visibleColumns = state => state.visibleColumns;

package/src/store/default/mutation_types.js

@@ -3,10 +3,12 @@ export const SET_ISLOADING = 'SET_ISLOADING';
 export const SET_ISSAVING = 'SET_ISSAVING';
 export const SET_TOTALITEMS = 'SET_TOTALITEMS';
 export const SET_SUMMARY = 'SET_SUMMARY';
+export const SET_DEBUG = 'SET_DEBUG';
 export const SET_ITEMS = 'SET_ITEMS';
 export const SET_ITEM = 'SET_ITEM';
-export const SET_COLUMNS = 'SET_COLUMNS';
-export const SET_FILTERS = 'SET_FILTERS';
+export const SET_COLUMNS = 'SET_COLUMNS';
+export const SET_CONFIGS = 'SET_CONFIGS';
+export const SET_FILTERS = 'SET_FILTERS';
 export const SET_RESOURCE_ENDPOINT = 'SET_RESOURCE_ENDPOINT';
 export const SET_SELECTED = 'SET_SELECTED';
 export const SET_VISIBLECOLUMNS = 'SET_VISIBLECOLUMNS';

package/src/store/default/mutations.js

@@ -37,6 +37,11 @@ export default {
     return 'summary';
   },
 
+  [types.SET_DEBUG](state, debug) {
+    state.debug = debug || {};
+    return 'debug';
+  },
+
   [types.SET_ITEMS](state, items) {
     state.items = items;
     return 'items';
@@ -74,7 +79,11 @@ export default {
     state.columns = columns;
     return 'columns';
   },
-  [types.SET_OFFLINE](state, offline) {
+  [types.SET_CONFIGS](state, configs) {
+    state.configs = configs || {};
+    return 'configs';
+  },
+  [types.SET_OFFLINE](state, offline) {
     state.offline = offline;
     return 'offline';
   },