@webitel/ui-datalist 1.1.67 → 1.1.68

package/package.json

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

package/src/modules/headers/__tests__/createTableHeadersStore.spec.ts

@@ -1,5 +1,5 @@
 import { beforeEach, describe, expect, it } from 'vitest';
-import { createApp } from 'vue';
+import { createApp, ref } from 'vue';
 import { createMemoryHistory, createRouter, type Router } from 'vue-router';
 
 import type { DatalistTableHeader } from '../../types/tableStore.types';
@@ -141,6 +141,149 @@ describe('tableHeadersStoreBody', () => {
 		});
 	});
 
+	describe('access', () => {
+		const createGatedStore = (gated: DatalistTableHeader[]) =>
+			tableHeadersStoreBody({
+				rawHeaders: [
+					...rawHeaders.map((header) => ({
+						...header,
+					})),
+					...gated,
+				],
+				id,
+			});
+
+		it('drops a denied header from headers, shownHeaders and fields', () => {
+			const store = createGatedStore([
+				{
+					field: 'agent',
+					show: true,
+					sort: null,
+					access: () => false,
+				} as DatalistTableHeader,
+			]);
+
+			expect(store.headers.value.map(({ field }) => field)).not.toContain(
+				'agent',
+			);
+			expect(store.shownHeaders.value.map(({ field }) => field)).not.toContain(
+				'agent',
+			);
+			expect(store.fields.value).not.toContain('agent');
+		});
+
+		it('keeps a granted header and leaves ungated headers untouched', () => {
+			const store = createGatedStore([
+				{
+					field: 'agent',
+					show: true,
+					sort: null,
+					access: () => true,
+				} as DatalistTableHeader,
+			]);
+
+			expect(store.fields.value).toEqual([
+				'name',
+				'subject',
+				'agent',
+			]);
+		});
+
+		it('unwraps a ref returned by the access gate', () => {
+			const store = createGatedStore([
+				{
+					field: 'agent',
+					show: true,
+					sort: null,
+					access: () => ref(false),
+				} as DatalistTableHeader,
+			]);
+
+			expect(store.fields.value).toEqual([
+				'name',
+				'subject',
+			]);
+		});
+
+		it('does not resurrect a denied header from the persisted fields', async () => {
+			await router.push({
+				name: 'cases',
+				query: {
+					fields: 'agent,createdAt',
+				},
+			});
+
+			const store = createGatedStore([
+				{
+					field: 'agent',
+					show: true,
+					sort: null,
+					access: () => false,
+				} as DatalistTableHeader,
+			]);
+			await runWithRouter(() => store.setupPersistence());
+
+			expect(store.fields.value).toEqual([
+				'createdAt',
+			]);
+			expect(store.headers.value.map(({ field }) => field)).not.toContain(
+				'agent',
+			);
+		});
+
+		it('does not resurrect a denied header on reset', () => {
+			const store = createGatedStore([
+				{
+					field: 'agent',
+					show: true,
+					sort: null,
+					access: () => false,
+				} as DatalistTableHeader,
+			]);
+
+			store.$reset();
+
+			expect(store.headers.value.map(({ field }) => field)).not.toContain(
+				'agent',
+			);
+		});
+
+		it('keeps a field alive while another allowed header still claims it', async () => {
+			await router.push({
+				name: 'cases',
+				query: {
+					fields: 'member',
+				},
+			});
+
+			/* `member` and `memberId` share one API field — only one is gated */
+			const store = createGatedStore([
+				{
+					value: 'member',
+					field: 'member',
+					show: true,
+					sort: null,
+				} as DatalistTableHeader,
+				{
+					value: 'memberId',
+					field: 'member',
+					show: false,
+					sort: null,
+					access: () => false,
+				} as DatalistTableHeader,
+			]);
+			await runWithRouter(() => store.setupPersistence());
+
+			expect(store.headers.value.map(({ value }) => value)).toContain('member');
+			expect(store.headers.value.map(({ value }) => value)).not.toContain(
+				'memberId',
+			);
+			expect(store.fields.value).toEqual([
+				'member',
+			]);
+		});
+	});
+
 	describe('syncPersistence', () => {
 		it('publishes a customized column set', async () => {
 			const store = await setUpStore();

package/src/modules/headers/createTableHeadersStore.ts

@@ -1,7 +1,7 @@
 import type { WtTableSortOrder } from '@webitel/ui-sdk/components/wt-table/types/WtTable';
 import { sortToQueryAdapter } from '@webitel/ui-sdk/scripts';
 import { SortSymbols } from '@webitel/ui-sdk/scripts/sortQueryAdapters';
-import { computed, nextTick, ref } from 'vue';
+import { computed, nextTick, ref, unref } from 'vue';
 
 import { createDatalistStore } from '../_shared/createDatalistStore';
 import {
@@ -24,7 +24,21 @@ export const tableHeadersStoreBody = ({
 	rawHeaders,
 	id,
 }: TableHeadersStoreBodyParams) => {
-	const headers = ref<DatalistTableHeader[]>(rawHeaders);
+	const isAllowed = (header: DatalistTableHeader) =>
+		!header.access || !!unref(header.access());
+
+	const allowedHeaders = rawHeaders.filter(isAllowed);
+
+	/* headers may share a `field`, so it stays allowed while any of them is */
+	const allowedFields = new Set(allowedHeaders.map((header) => header.field));
+	const deniedFields = new Set(
+		rawHeaders
+			.filter((header) => !isAllowed(header))
+			.map((header) => header.field)
+			.filter((field) => !allowedFields.has(field)),
+	);
+
+	const headers = ref<DatalistTableHeader[]>(allowedHeaders);
 	const isReorderingColumn = ref(false);
 
 	const shownHeaders = computed(() => {
@@ -64,7 +78,7 @@ export const tableHeadersStoreBody = ({
 	});
 
 	const $reset = () => {
-		headers.value = rawHeaders;
+		headers.value = allowedHeaders;
 	};
 
 	const updateShownHeaders = (value: DatalistTableHeader[]) => {
@@ -112,7 +126,10 @@ export const tableHeadersStoreBody = ({
 		});
 	};
 
-	const updateFields = (fields: string[]) => {
+	const updateFields = (persistedFields: string[]) => {
+		/* persisted state predates the gate, and unknown fields are revived below */
+		const fields = persistedFields.filter((field) => !deniedFields.has(field));
+
 		const fieldsSet = new Set(fields);
 		const mainFieldNames = new Set(headers.value.map((header) => header.field));
 

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

@@ -13,6 +13,13 @@ import type { DatalistStoreProviderType } from './StoreProvider';
 export type DatalistTableHeader = WtTableHeader & {
 	field: string;
 	shouldBeInitialized?: boolean;
+	/**
+	 * Access gate supplied by the consuming app, evaluated once when the headers
+	 * store is created. Returning `false` drops the column completely: absent
+	 * from the column picker, never rendered, never requested, and not
+	 * restorable from persisted state. Omitted means allowed.
+	 */
+	access?: () => boolean | Ref<boolean>;
 };
 
 export type TrackSelectedRowBy<T> = (row: T) => T;