@webitel/ui-datalist 26.8.23 → 26.8.25

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@webitel/ui-datalist",
-	"version": "26.8.23",
+	"version": "26.8.25",
 	"description": "Toolkit for building data lists in webitel ui system",
 	"scripts": {
 		"build:types": "vue-tsc -b tsconfig.build.json",

package/src/modules/table/__tests__/createTableStore.spec.ts

@@ -260,6 +260,65 @@ describe('tableStoreBody', () => {
 		});
 	});
 
+	/*
+	 An endpoint may answer with sibling data alongside `items` — e.g. per-page
+	 totals for a footer row — which has no home on the store otherwise;
+	 without this, a table needing it had to bolt a bespoke wrapper onto
+	 `createTableStore` just to surface one extra reactive field.
+	 */
+	describe('aggs', () => {
+		let useStore: ReturnType<typeof createTableStore>;
+
+		beforeEach(async () => {
+			getList.mockResolvedValue({
+				items: [],
+				next: false,
+				aggs: {
+					total: 3,
+				},
+			});
+
+			useStore = createTableStore('cases-aggs/datalist', {
+				apiModule: {
+					getList,
+				},
+				headers,
+				disablePersistence: true,
+			});
+
+			mountTab(useStore);
+			await flush();
+		});
+
+		it('picks up aggs from the getList response', () => {
+			const store = useStore();
+
+			expect(store.aggs).toEqual({
+				total: 3,
+			});
+		});
+
+		it('stays undefined when the response has none', async () => {
+			getList.mockResolvedValue({
+				items: [],
+				next: false,
+			});
+
+			const store = useStore();
+			await store.loadDataList();
+
+			expect(store.aggs).toBeUndefined();
+		});
+
+		it('drops on $reset', () => {
+			const store = useStore();
+
+			store.$reset();
+
+			expect(store.aggs).toBeUndefined();
+		});
+	});
+
 	describe('filters persistence of a nested list', () => {
 		it('keeps an added filter out of the route query, in sessionStorage instead', async () => {
 			const useStore = createTableStore('cases-nested-filters/datalist', {

package/src/modules/table/createTableStore.store.ts

@@ -126,6 +126,12 @@ export const tableStoreBody = <Entity extends Identifiable>(
 	const selected: Ref<Entity[]> = ref([]);
 	const error = ref<unknown>(null);
 	const isLoading = ref(false);
+	/**
+	 * Sibling data an endpoint answers alongside the paginated `items` — e.g.
+	 * per-page totals for a footer row. Not every `getList` response has one;
+	 * absent, it stays `undefined` and callers that do not need it can ignore it.
+	 */
+	const aggs = ref<unknown>(undefined);
 
 	const updateSelected = (value: Entity[]) => {
 		selected.value = value;
@@ -177,9 +183,14 @@ export const tableStoreBody = <Entity extends Identifiable>(
 		const params = getLoadDataParams();
 
 		try {
-			const { items, next } = await apiModule.getList(params);
+			const {
+				items,
+				next,
+				aggs: responseAggs,
+			} = await apiModule.getList(params);
 
 			dataList.value = items ?? [];
+			aggs.value = responseAggs;
 
 			/**
 			 * @author: @Oleksandr Palonnyi
@@ -221,9 +232,14 @@ export const tableStoreBody = <Entity extends Identifiable>(
 		const params = getLoadDataParams();
 
 		try {
-			const { items, next } = await apiModule.getList(params);
+			const {
+				items,
+				next,
+				aggs: responseAggs,
+			} = await apiModule.getList(params);
 
 			dataList.value.push(...(items ?? []));
+			aggs.value = responseAggs;
 			$patchPaginationStore({
 				next,
 			});
@@ -413,6 +429,7 @@ export const tableStoreBody = <Entity extends Identifiable>(
 		selected.value = [];
 		error.value = null;
 		isLoading.value = false;
+		aggs.value = undefined;
 		parentId.value = undefined;
 
 		paginationStore.$reset();
@@ -433,6 +450,7 @@ export const tableStoreBody = <Entity extends Identifiable>(
 		selected,
 		error,
 		isLoading,
+		aggs,
 
 		page,
 		size,

package/src/modules/types/tableStore.types.ts

@@ -68,12 +68,14 @@ export interface LoadDataListOptions {
 	withLoading?: boolean;
 }
 
-export interface TableStore<Entity> {
+export interface TableStore<Entity, Aggs = unknown> {
 	// tableStore
 	dataList: Ref<Entity[]>;
 	selected: Ref<Entity[]>;
 	error: Ref<Error | null>;
 	isLoading: Ref<boolean>;
+	/** Sibling data alongside `dataList` — e.g. per-page totals for a footer row. */
+	aggs: Ref<Aggs | undefined>;
 
 	// paginationStore
 	page: Ref<number>;