@controleonline/ui-default 1.0.264 → 1.0.266

package/src/tests/react/store/defaultActions.test.js

@@ -19,6 +19,7 @@ const {
   splitStoreActionPayload,
   buildStoreErrorCommitOptions,
   get,
+  save,
 } = require('../../../store/default/actions')
 
 describe('default store action controls', () => {
@@ -109,4 +110,62 @@ describe('default store action controls', () => {
     })
     expect(commit).toHaveBeenCalledWith(types.SET_ISLOADING, false)
   })
+
+  it('merges saved list object patches into the visible collection without sending them to the API', async () => {
+    api.fetch.mockResolvedValue({
+      '@id': '/invoices/332',
+      id: 332,
+      status: '/statuses/33',
+    })
+
+    const commit = jest.fn()
+    const getters = {
+      resourceEndpoint: 'invoices',
+      items: [
+        {
+          '@id': '/invoices/332',
+          id: 332,
+          status: {
+            id: 1,
+            status: 'Aberto',
+          },
+        },
+      ],
+    }
+
+    await save(
+      {commit, getters},
+      {
+        id: '332',
+        status: '/statuses/33',
+        [STORE_ACTION_META_KEY]: {
+          savedItemPatch: {
+            status: {
+              id: 33,
+              status: 'Pago',
+              context: 'invoice',
+            },
+          },
+        },
+      },
+    )
+
+    expect(api.fetch).toHaveBeenCalledWith('invoices/332', {
+      method: 'PUT',
+      body: {
+        status: '/statuses/33',
+      },
+    })
+    expect(commit).toHaveBeenCalledWith(types.SET_ITEMS, [
+      {
+        '@id': '/invoices/332',
+        id: 332,
+        status: {
+          id: 33,
+          status: 'Pago',
+          context: 'invoice',
+        },
+      },
+    ])
+  })
 })

package/src/tests/react/utils/tableVisibleColumnsPreferences.test.js

@@ -1,223 +1,302 @@
 const {
   DEFAULT_TABLE_PREFERENCES_STORAGE_KEY,
-  TABLE_SORT_DIRECTION_PREFERENCES_KEY,
-  TABLE_SORT_FIELD_PREFERENCES_KEY,
+  TABLE_FILTER_PREFERENCES_KEY,
   TABLE_SORT_PREFERENCES_KEY,
   TABLE_VISIBLE_COLUMNS_PREFERENCES_KEY,
   TABLE_VIEW_MODE_PREFERENCES_KEY,
   buildDefaultVisibleColumns,
+  persistTableFiltersPreference,
   persistTableSortPreference,
   persistTableViewModePreference,
   persistVisibleColumnsPreference,
+  resolveDefaultTablePreferenceScope,
+  resolveStoredTableFiltersPreference,
   resolveStoredTableSortPreference,
   resolveStoredTableViewModePreference,
   resolveStoredVisibleColumnsPreference,
+  sanitizeTableFiltersPreference,
   sanitizeVisibleColumnsPreference,
 } = require('../../../react/utils/tableVisibleColumnsPreferences');
-
-const { beforeEach, describe, expect, it } = global;
-
-const createLocalStorageMock = () => {
-  let storage = {};
-
-  return {
-    clear: () => {
-      storage = {};
-    },
-    getItem: key => (key in storage ? storage[key] : null),
-    removeItem: key => {
-      delete storage[key];
-    },
-    setItem: (key, value) => {
-      storage[key] = String(value);
-    },
-  };
-};
-
-describe('tableVisibleColumnsPreferences', () => {
-  const columns = [
-    { name: 'id' },
-    { name: 'status' },
-    { name: 'price', visible: false },
-  ];
-
-  beforeEach(() => {
-    global.localStorage = createLocalStorageMock();
-  });
-
-  it('builds the default visibility map from store columns', () => {
-    expect(buildDefaultVisibleColumns(columns)).toEqual({
-      id: true,
-      status: true,
-      price: false,
-    });
-  });
-
-  it('sanitizes stored preferences against the current columns', () => {
-    expect(
-      sanitizeVisibleColumnsPreference({
-        columns,
-        visibleColumns: {
-          id: false,
-          unknown: true,
-        },
-      }),
-    ).toEqual({
-      id: false,
-      status: true,
-      price: false,
-    });
-  });
-
-  it('reads and writes visible columns preferences under the per-page bucket', () => {
-    global.localStorage.setItem(
-      DEFAULT_TABLE_PREFERENCES_STORAGE_KEY,
-      JSON.stringify({
-        theme: 'light',
-        [TABLE_VISIBLE_COLUMNS_PREFERENCES_KEY]: {
-          'financialEntries:receivables': {
-            id: false,
-          },
-        },
-      }),
-    );
-
-    expect(
-      resolveStoredVisibleColumnsPreference('financialEntries:receivables'),
-    ).toEqual({
-      id: false,
-    });
-
-    persistVisibleColumnsPreference('financialEntries:payables', {
-      id: true,
-      status: false,
-    });
-
-    expect(
-      JSON.parse(
-        global.localStorage.getItem(DEFAULT_TABLE_PREFERENCES_STORAGE_KEY),
-      ),
-    ).toEqual({
-      theme: 'light',
-      [TABLE_VISIBLE_COLUMNS_PREFERENCES_KEY]: {
-        'financialEntries:receivables': {
-          id: false,
-        },
-        'financialEntries:payables': {
-          id: true,
-          status: false,
-        },
-      },
-    });
-  });
-
-  it('reads and writes the preferred table view mode by page', () => {
-    global.localStorage.setItem(
-      DEFAULT_TABLE_PREFERENCES_STORAGE_KEY,
-      JSON.stringify({
-        [TABLE_VIEW_MODE_PREFERENCES_KEY]: {
-          'financialEntries:payables': 'cards',
-        },
-      }),
-    );
-
-    expect(
-      resolveStoredTableViewModePreference(
-        'financialEntries:payables',
-        'table',
-      ),
-    ).toBe('cards');
-
-    expect(
-      resolveStoredTableViewModePreference(
-        'financialEntries:receivables',
-        'table',
-      ),
-    ).toBe('table');
-
-    persistTableViewModePreference('financialEntries:receivables', 'table');
-
-    expect(
-      JSON.parse(
-        global.localStorage.getItem(DEFAULT_TABLE_PREFERENCES_STORAGE_KEY),
-      ),
-    ).toEqual({
-      [TABLE_VIEW_MODE_PREFERENCES_KEY]: {
-        'financialEntries:payables': 'cards',
-        'financialEntries:receivables': 'table',
-      },
+
+const { beforeEach, describe, expect, it } = global;
+
+const createLocalStorageMock = () => {
+  let storage = {};
+
+  return {
+    clear: () => {
+      storage = {};
+    },
+    getItem: key => (key in storage ? storage[key] : null),
+    removeItem: key => {
+      delete storage[key];
+    },
+    setItem: (key, value) => {
+      storage[key] = String(value);
+    },
+  };
+};
+
+describe('tableVisibleColumnsPreferences', () => {
+  const columns = [
+    { name: 'id' },
+    { name: 'status' },
+    { name: 'price', visible: false },
+  ];
+  const scope = {
+    storeKey: 'financialEntries',
+    routeKey: 'receivables',
+  };
+
+  beforeEach(() => {
+    global.localStorage = createLocalStorageMock();
+  });
+
+  it('builds the default visibility map from store columns', () => {
+    expect(buildDefaultVisibleColumns(columns)).toEqual({
+      id: true,
+      status: true,
+      price: false,
+    });
+  });
+
+  it('sanitizes stored preferences against the current columns', () => {
+    expect(
+      sanitizeVisibleColumnsPreference({
+        columns,
+        visibleColumns: {
+          id: false,
+          unknown: true,
+        },
+      }),
+    ).toEqual({
+      id: false,
+      status: true,
+      price: false,
+    });
+  });
+
+  it('builds the route and store preference scope', () => {
+    global.location = {pathname: '/order-history-page'};
+
+    expect(
+      resolveDefaultTablePreferenceScope({
+        route: {name: 'IgnoredRoute'},
+        storeName: 'orders',
+      }),
+    ).toEqual({
+      routeKey: 'order-history-page',
+      storeKey: 'orders',
+    });
+
+    delete global.location;
+  });
+
+  it('uses an explicit preference key before the route pathname', () => {
+    global.location = {pathname: '/product-showcases-page'};
+
+    expect(
+      resolveDefaultTablePreferenceScope({
+        preferenceKey: 'product_showcase_items',
+        route: {name: 'ProductShowcasesPage'},
+        storeName: 'product_showcase_items',
+      }),
+    ).toEqual({
+      routeKey: 'product_showcase_items',
+      storeKey: 'product_showcase_items',
+    });
+
+    delete global.location;
+  });
+
+  it('sanitizes stored filters against filterable columns and search key', () => {
+    expect(
+      sanitizeTableFiltersPreference({
+        columns: [
+          {name: 'status'},
+          {name: 'internal', filter: false},
+        ],
+        filters: {
+          internal: 'hidden',
+          search: 'pedido',
+          status: 'paid',
+          unknown: 'ignored',
+        },
+      }),
+    ).toEqual({
+      search: 'pedido',
+      status: 'paid',
     });
   });
 
-  it('reads and writes the preferred sort by page', () => {
+  it('reads and writes visible columns under default-table[store][route]', () => {
     global.localStorage.setItem(
       DEFAULT_TABLE_PREFERENCES_STORAGE_KEY,
       JSON.stringify({
-        [TABLE_SORT_FIELD_PREFERENCES_KEY]: {
-          'financialEntries:payables': 'price',
-        },
-        [TABLE_SORT_DIRECTION_PREFERENCES_KEY]: {
-          'financialEntries:payables': 'asc',
+        theme: 'light',
+        financialEntries: {
+          receivables: {
+            [TABLE_VISIBLE_COLUMNS_PREFERENCES_KEY]: {
+              id: false,
+            },
+          },
         },
       }),
     );
 
+    expect(resolveStoredVisibleColumnsPreference(scope)).toEqual({
+      id: false,
+    });
+
+    persistVisibleColumnsPreference({
+      storeKey: 'financialEntries',
+      routeKey: 'payables',
+    }, {
+      id: true,
+      status: false,
+    });
+
     expect(
-      resolveStoredTableSortPreference('financialEntries:payables'),
+      JSON.parse(
+        global.localStorage.getItem(DEFAULT_TABLE_PREFERENCES_STORAGE_KEY),
+      ),
     ).toEqual({
-      direction: 'asc',
-      field: 'price',
+      theme: 'light',
+      financialEntries: {
+        receivables: {
+          [TABLE_VISIBLE_COLUMNS_PREFERENCES_KEY]: {
+            id: false,
+          },
+        },
+        payables: {
+          [TABLE_VISIBLE_COLUMNS_PREFERENCES_KEY]: {
+            id: true,
+            status: false,
+          },
+        },
+      },
     });
+  });
+
+  it('reads and writes view mode under default-table[store][route]', () => {
+    global.localStorage.setItem(
+      DEFAULT_TABLE_PREFERENCES_STORAGE_KEY,
+      JSON.stringify({
+        financialEntries: {
+          payables: {
+            [TABLE_VIEW_MODE_PREFERENCES_KEY]: 'cards',
+          },
+        },
+      }),
+    );
 
     expect(
-      resolveStoredTableSortPreference('financialEntries:receivables'),
-    ).toBeNull();
+      resolveStoredTableViewModePreference(
+        {storeKey: 'financialEntries', routeKey: 'payables'},
+        'table',
+      ),
+    ).toBe('cards');
 
-    persistTableSortPreference('financialEntries:receivables', {
-      direction: 'desc',
-      field: 'dueDate',
-    });
+    expect(
+      resolveStoredTableViewModePreference(scope, 'table'),
+    ).toBe('table');
+
+    persistTableViewModePreference(scope, 'table');
 
     expect(
       JSON.parse(
         global.localStorage.getItem(DEFAULT_TABLE_PREFERENCES_STORAGE_KEY),
       ),
     ).toEqual({
-      [TABLE_SORT_FIELD_PREFERENCES_KEY]: {
-        'financialEntries:payables': 'price',
-        'financialEntries:receivables': 'dueDate',
-      },
-      [TABLE_SORT_DIRECTION_PREFERENCES_KEY]: {
-        'financialEntries:payables': 'asc',
-        'financialEntries:receivables': 'desc',
-      },
-      [TABLE_SORT_PREFERENCES_KEY]: {
-        'financialEntries:receivables': {
-          direction: 'desc',
-          field: 'dueDate',
+      financialEntries: {
+        payables: {
+          [TABLE_VIEW_MODE_PREFERENCES_KEY]: 'cards',
+        },
+        receivables: {
+          [TABLE_VIEW_MODE_PREFERENCES_KEY]: 'table',
         },
       },
     });
   });
 
-  it('keeps reading the legacy combined sort format when needed', () => {
+  it('reads and writes sort under default-table[store][route]', () => {
     global.localStorage.setItem(
       DEFAULT_TABLE_PREFERENCES_STORAGE_KEY,
       JSON.stringify({
-        [TABLE_SORT_PREFERENCES_KEY]: {
-          'financialEntries:ownTransfers': {
-            direction: 'asc',
-            field: 'createdAt',
+        financialEntries: {
+          payables: {
+            [TABLE_SORT_PREFERENCES_KEY]: {
+              direction: 'asc',
+              field: 'price',
+            },
           },
         },
       }),
     );
 
     expect(
-      resolveStoredTableSortPreference('financialEntries:ownTransfers'),
+      resolveStoredTableSortPreference({
+        storeKey: 'financialEntries',
+        routeKey: 'payables',
+      }),
     ).toEqual({
       direction: 'asc',
-      field: 'createdAt',
+      field: 'price',
+    });
+
+    expect(resolveStoredTableSortPreference(scope)).toBeNull();
+
+    persistTableSortPreference(scope, {
+      direction: 'desc',
+      field: 'dueDate',
+    });
+
+    expect(
+      JSON.parse(
+        global.localStorage.getItem(DEFAULT_TABLE_PREFERENCES_STORAGE_KEY),
+      ),
+    ).toEqual({
+      financialEntries: {
+        payables: {
+          [TABLE_SORT_PREFERENCES_KEY]: {
+            direction: 'asc',
+            field: 'price',
+          },
+        },
+        receivables: {
+          [TABLE_SORT_PREFERENCES_KEY]: {
+            direction: 'desc',
+            field: 'dueDate',
+          },
+        },
+      },
+    });
+  });
+
+  it('reads and writes filters under default-table[store][route]', () => {
+    persistTableFiltersPreference(scope, {
+      search: '72813',
+      status: 'paid',
+    });
+
+    expect(resolveStoredTableFiltersPreference(scope)).toEqual({
+      search: '72813',
+      status: 'paid',
+    });
+
+    expect(
+      JSON.parse(
+        global.localStorage.getItem(DEFAULT_TABLE_PREFERENCES_STORAGE_KEY),
+      ),
+    ).toEqual({
+      financialEntries: {
+        receivables: {
+          [TABLE_FILTER_PREFERENCES_KEY]: {
+            search: '72813',
+            status: 'paid',
+          },
+        },
+      },
     });
   });
 });