@bexis2/bexis2-core-ui 0.3.11 → 0.3.13

package/dist/models/Enums.d.ts

@@ -31,3 +31,21 @@ export declare enum notificationType {
     error = 2,
     surface = 3
 }
+export declare enum FilterOptionsEnum {
+    'e' = "e",
+    'ne' = "ne",
+    'gt' = "gt",
+    'lt' = "lt",
+    'gte' = "gte",
+    'lte' = "lte",
+    'c' = "c",
+    'nc' = "nc",
+    'sw' = "sw",
+    'ew' = "ew",
+    'o' = "o",
+    'sf' = "sf",
+    'a' = "a",
+    'u' = "u",
+    'b' = "b",
+    'no' = "no"
+}

package/dist/models/Enums.js

@@ -39,3 +39,23 @@ export var notificationType;
     notificationType[notificationType["error"] = 2] = "error";
     notificationType[notificationType["surface"] = 3] = "surface";
 })(notificationType || (notificationType = {}));
+// Server-side table fitler types
+export var FilterOptionsEnum;
+(function (FilterOptionsEnum) {
+    FilterOptionsEnum["e"] = "e";
+    FilterOptionsEnum["ne"] = "ne";
+    FilterOptionsEnum["gt"] = "gt";
+    FilterOptionsEnum["lt"] = "lt";
+    FilterOptionsEnum["gte"] = "gte";
+    FilterOptionsEnum["lte"] = "lte";
+    FilterOptionsEnum["c"] = "c";
+    FilterOptionsEnum["nc"] = "nc";
+    FilterOptionsEnum["sw"] = "sw";
+    FilterOptionsEnum["ew"] = "ew";
+    FilterOptionsEnum["o"] = "o";
+    FilterOptionsEnum["sf"] = "sf";
+    FilterOptionsEnum["a"] = "a";
+    FilterOptionsEnum["u"] = "u";
+    FilterOptionsEnum["b"] = "b";
+    FilterOptionsEnum["no"] = "no"; // Not on (date)
+})(FilterOptionsEnum || (FilterOptionsEnum = {}));

package/dist/models/Models.d.ts

@@ -1,7 +1,7 @@
 import type { SvelteComponent } from 'svelte';
 import type { ColumnFilterFn } from 'svelte-headless-table/lib/plugins';
 import type { Writable } from 'svelte/store';
-import type { decimalCharacterType, notificationType, orientationType, textMarkerType, textSeperatorType } from './Enums';
+import type { FilterOptionsEnum, decimalCharacterType, notificationType, orientationType, textMarkerType, textSeperatorType } from './Enums';
 export interface linkType {
     label: string;
     url: string;
@@ -83,7 +83,7 @@ export interface Columns {
 export interface TableConfig<T> {
     id: string;
     data: Writable<T[]>;
-    resizable?: 'rows' | 'columns' | 'both';
+    resizable?: 'none' | 'rows' | 'columns' | 'both';
     toggle?: boolean;
     fitToScreen?: boolean;
     height?: null | number;
@@ -93,6 +93,12 @@ export interface TableConfig<T> {
     pageSizes?: number[];
     defaultPageSize?: number;
     optionsComponent?: typeof SvelteComponent;
+    serverSide?: boolean;
+    URL?: string;
+    token?: string;
+    sendModel?: Send;
+    entityId?: number;
+    versionId?: number;
 }
 export interface keyValuePairType {
     id: number;
@@ -123,3 +129,38 @@ export interface notificationStoreType {
     message: string;
     btnStyle: string;
 }
+export type ServerColumn = {
+    column: string;
+    exclude?: boolean;
+    instructions?: {
+        missingValues?: {
+            [key: string | number]: string;
+        };
+        displayPattern?: string;
+    };
+};
+export type OrderBy = {
+    column: string;
+    direction: 'asc' | 'desc';
+};
+export type Filter = {
+    column: string;
+    filterBy: FilterOptionsEnum;
+    value: string | number | Date | boolean;
+};
+export declare class Send {
+    id: number;
+    limit: number;
+    offset: number;
+    version?: number;
+    filter: Filter[];
+    order: OrderBy[];
+    constructor();
+}
+export declare class Receive {
+    count: number;
+    data: any[];
+    send: Send;
+    columns?: ServerColumn[];
+    constructor();
+}

package/dist/models/Models.js

@@ -1 +1,28 @@
-export {};
+export class Send {
+    id;
+    limit;
+    offset;
+    version;
+    filter;
+    order;
+    constructor() {
+        this.id = 0;
+        this.limit = 10;
+        this.offset = 0;
+        this.version = 0;
+        this.filter = [];
+        this.order = [];
+    }
+}
+export class Receive {
+    count;
+    data;
+    send;
+    columns;
+    constructor() {
+        this.count = 0;
+        this.data = [];
+        this.send = new Send();
+        this.columns = [];
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bexis2/bexis2-core-ui",
-  "version": "0.3.11",
+  "version": "0.3.13",
   "private": false,
   "scripts": {
     "dev": "vite dev",
@@ -79,7 +79,7 @@
     "svelte": "^3.54.0",
     "svelte-codemirror-editor": "^1.1.0",
     "svelte-fa": "^3.0.4",
-    "svelte-file-dropzone": "^2.0.1",
+    "svelte-file-dropzone": "^2.0.4",
     "svelte-headless-table": "^0.17.3",
     "svelte-select": "5.8.3",
     "vest": "^4.6.11"

package/src/lib/components/Table/TableContent.svelte

@@ -1,5 +1,9 @@
 <script lang="ts">
 	import { createEventDispatcher } from 'svelte';
+	import { readable, writable } from 'svelte/store';
+
+	import Fa from 'svelte-fa';
+	import { faXmark } from '@fortawesome/free-solid-svg-icons';
 	import { createTable, Subscribe, Render, createRender } from 'svelte-headless-table';
 	import {
 		addSortBy,
@@ -11,13 +15,26 @@
 	} from 'svelte-headless-table/plugins';
 	import { computePosition, autoUpdate, offset, shift, flip, arrow } from '@floating-ui/dom';
 	import { SlideToggle, storePopup } from '@skeletonlabs/skeleton';
+	import type { PaginationConfig } from 'svelte-headless-table/lib/plugins/addPagination';
 
 	storePopup.set({ computePosition, autoUpdate, offset, shift, flip, arrow });
 
 	import TableFilter from './TableFilter.svelte';
+	import TableFilterServer from './TableFilterServer.svelte';
 	import TablePagination from './TablePagination.svelte';
+	import TablePaginationServer from './TablePaginationServer.svelte';
 	import { columnFilter, searchFilter } from './filter';
+	import {
+		cellStyle,
+		exportAsCsv,
+		fixedWidth,
+		normalizeFilters,
+		resetResize,
+		convertServerColumns
+	} from './shared';
+	import { Receive, Send } from '$lib/models/Models';
 	import type { TableConfig } from '$lib/models/Models';
+	import type { FilterOptionsEnum } from '$models/Enums';
 
 	export let config: TableConfig<any>;
 
@@ -34,9 +51,21 @@
 		toggle = false, // Whether to display the fitToScreen toggle
 		pageSizes = [5, 10, 15, 20], // Page sizes to display in the pagination component
 		fitToScreen = true, // Whether to fit the table to the screen,
-		exportable = false // Whether to display the export button and enable export functionality
+		exportable = false, // Whether to display the export button and enable export functionality
+		serverSide = false, // Whether the table is client or server-side
+		URL = '', // URL to fetch data from
+		token = '', // Bearer token to authenticate the request
+		sendModel = new Send(), // Model to send requests
+		entityId = 0, // Entity ID to send with the request
+		versionId = 0 // Version ID to send with the request
 	} = config;
 
+	let searchValue = '';
+
+	const filters = writable<{
+		[key: string]: { [key in FilterOptionsEnum]?: number | string | Date };
+	}>({});
+
 	// Creatign a type to access keys of the objects in the data store
 	type AccessorType = keyof (typeof $data)[number];
 
@@ -44,14 +73,29 @@
 	const dispatch = createEventDispatcher();
 	const actionDispatcher = (obj) => dispatch('action', obj);
 
+	const serverItems = serverSide ? writable<Number>(0) : undefined;
+	const serverItemCount = serverSide
+		? readable<Number>(0, (set) => {
+				serverItems!.subscribe((val) => set(val));
+		  })
+		: undefined;
+
 	// Initializing the table
 	const table = createTable(data, {
 		colFilter: addColumnFilters(),
 		tableFilter: addTableFilter({
-			fn: searchFilter
+			fn: searchFilter,
+			serverSide
+		}),
+		sort: addSortBy({
+			disableMultiSort: true,
+			serverSide
 		}),
-		sort: addSortBy({ disableMultiSort: true }),
-		page: addPagination({ initialPageSize: defaultPageSize }),
+		page: addPagination({
+			initialPageSize: defaultPageSize,
+			serverSide,
+			serverItemCount
+		} as PaginationConfig),
 		expand: addExpandedRows(),
 		export: addDataExport({ format: 'csv' })
 	});
@@ -66,8 +110,14 @@
 			}
 		});
 	});
+
+	Object.keys(allCols).forEach((key) => {
+		$filters = { ...$filters, [key]: {} };
+	});
+
 	// Creating an array of all the keys
 	const accessors: AccessorType[] = Object.keys(allCols) as AccessorType[];
+
 	// Configuring every table column with the provided options
 	const tableColumns = [
 		...accessors
@@ -111,7 +161,6 @@
 							// Sorting config
 							sort: {
 								disable: disableSorting,
-								invert: true,
 								getSortValue: (row) => {
 									// If provided, use the custom sorting function toSortableValueFn(), or just use the value
 									return toSortableValueFn ? toSortableValueFn(row) : row;
@@ -128,14 +177,25 @@
 												: columnFilter({ filterValue, value: val });
 										},
 										render: ({ filterValue, values, id }) => {
-											// If provided, use the custom filter component, or use the default TableFilter component
-											return createRender(colFilterComponent ?? TableFilter, {
-												filterValue,
-												id,
-												tableId,
-												values,
-												toFilterableValueFn
-											});
+											filterValue.set($filters[key]);
+											return serverSide
+												? createRender(TableFilterServer, {
+														id,
+														tableId,
+														values,
+														updateTable,
+														pageIndex,
+														toFilterableValueFn,
+														filters
+												  })
+												: createRender(colFilterComponent ?? TableFilter, {
+														filterValue,
+														id,
+														tableId,
+														values,
+														toFilterableValueFn,
+														filters
+												  });
 										}
 								  }
 								: undefined,
@@ -149,7 +209,6 @@
 						}
 					});
 				} else {
-					// Default configuration for unconfigured columns
 					return table.column({
 						header: key,
 						accessor: accessor,
@@ -159,19 +218,28 @@
 						},
 						plugins: {
 							// Sorting enabled by default
-							sort: {
-								invert: true
-							},
+							sort: {},
 							// Filtering enabled by default
 							colFilter: {
 								fn: columnFilter,
-								render: ({ filterValue, values, id }) =>
-									createRender(TableFilter, {
-										filterValue,
-										id,
-										tableId,
-										values
-									})
+								render: ({ filterValue, values, id }) => {
+									return serverSide
+										? createRender(TableFilterServer, {
+												id,
+												tableId,
+												values,
+												updateTable,
+												pageIndex,
+												filters
+										  })
+										: createRender(TableFilter, {
+												filterValue,
+												id,
+												tableId,
+												values,
+												filters
+										  });
+								}
 							}
 						}
 					});
@@ -209,96 +277,90 @@
 	const { filterValue } = pluginStates.tableFilter;
 	// CSV content to be exported. If unexportable, then null
 	const { exportedData } = pluginStates.export;
+	// Page configuration
+	const { pageIndex, pageSize } = pluginStates.page;
 
-	// Function to determine minWidth for a column to simplify the logic in the HTML
-	const minWidth = (id: string) => {
-		if (columns && id in columns) {
-			return columns[id].minWidth ?? 0;
-		}
-		return 0;
-	};
-	// Function to determine fixedWidth for a column to simplify the logic in the HTML
-	const fixedWidth = (id: string) => {
-		if (columns && id in columns) {
-			return columns[id].fixedWidth ?? 0;
+	// TODO: Add loading animation for server-side fetch requests
+	const updateTable = async () => {
+		sendModel.limit = $pageSize;
+		sendModel.offset = $pageSize * $pageIndex;
+		sendModel.version = versionId;
+		sendModel.id = entityId;
+		sendModel.filter = normalizeFilters($filters);
+
+		const fetchData = await fetch(URL, {
+			headers: {
+				'Content-Type': 'application/json',
+				Authorization: `Bearer ${token}`
+			},
+			method: 'POST',
+			body: JSON.stringify(sendModel)
+		});
+
+		const response: Receive = await fetchData.json();
+
+		// Format server columns to the client columns
+		if (response.columns !== undefined) {
+			columns = convertServerColumns(response.columns);
 		}
-		return 0;
-	};
-	// Function to create custom styles for the columns to simplify the logic in the HTML
-	const cellStyle = (id: string) => {
-		const minW = minWidth(id);
-		const fixedW = fixedWidth(id);
-		const styles: string[] = [];
-
-		// If minWidth is provided, add to styles
-		minW && styles.push(`min-width: ${minW}px`);
-		// If fixedWidth is provided, add to styles
-		fixedW && styles.push(`width: ${fixedW}px`);
-		// Create and return styles separated by ';'
-		return styles.join(';');
+
+		// Update data store
+		$data = response.data;
+		$serverItems = response.count;
+
+		return response;
 	};
 
-	// Resetting the resized columns and/or rows
-	const resetResize = () => {
-		// Run only if resizable is not none
-		if (resizable === 'columns' || resizable === 'both') {
-			$headerRows.forEach((row) => {
-				row.cells.forEach((cell) => {
-					const minW = minWidth(cell.id);
-					const fixedW = fixedWidth(cell.id);
-					// If a fixedWidth is provided for a column, then reset the width to that value
-					fixedW &&
-						document
-							.getElementById(`th-${tableId}-${cell.id}`)
-							?.style.setProperty('width', `${fixedW}px`);
-					// If a minWidth is provided for a column, then reset the width to that value
-					minW &&
-						document
-							.getElementById(`th-${tableId}-${cell.id}`)
-							?.style.setProperty('min-width', `${minW}px`);
-					// If neither minWidth nor fixedWidth provided for a column, then reset the width to auto
-					!minW &&
-						!fixedW &&
-						document.getElementById(`th-${tableId}-${cell.id}`)?.style.setProperty('width', 'auto');
-				});
-			});
+	const sortServer = (order: 'asc' | 'desc' | undefined, id: string) => {
+		// Set parameter for sorting
+		if (order === undefined) {
+			sendModel.order = [];
+		} else {
+			sendModel.order = [{ column: id, direction: order }];
 		}
 
-		if (resizable === 'rows' || resizable === 'both') {
-			$pageRows.forEach((row) => {
-				row.cells.forEach((cell) => {
-					// Reset all row heights to auto
-					document
-						.getElementById(`${tableId}-${cell.id}-${row.id}`)
-						?.style.setProperty('height', 'auto');
-				});
-			});
-		}
-	};
+		// Reset pagination
+		$pageIndex = 0;
 
-	const exportAsCsv = () => {
-		// Creating a hidden anchor element to download the CSV file
-		const anchor = document.createElement('a');
-		anchor.style.display = 'none';
-		anchor.href = `data:text/csv;charset=utf-8,${encodeURIComponent($exportedData)}`;
-		anchor.download = `${tableId}.csv`;
-		document.body.appendChild(anchor);
-		anchor.click();
-		document.body.removeChild(anchor);
+		updateTable();
 	};
+
+	$: sortKeys = pluginStates.sort.sortKeys;
+	$: serverSide && updateTable();
+	$: serverSide && sortServer($sortKeys[0]?.order, $sortKeys[0]?.id);
 </script>
 
 <div class="grid gap-2 overflow-auto" class:w-fit={!fitToScreen} class:w-full={fitToScreen}>
 	<div class="table-container">
 		<!-- Enable the search filter if table is not empty -->
 		{#if $data.length > 0}
-			<input
-				class="input p-2 border border-primary-500"
-				type="text"
-				bind:value={$filterValue}
-				placeholder="Search rows..."
-				id="{tableId}-search"
-			/>
+			{#if !serverSide}
+				<div class="flex gap-2">
+					<div class="relative w-full flex items-center">
+						<input
+							class="input p-2 border border-primary-500"
+							type="text"
+							bind:value={searchValue}
+							placeholder="Search rows..."
+							id="{tableId}-search"
+						/><button
+							type="reset"
+							class="absolute right-3 items-center"
+							on:click|preventDefault={() => {
+								searchValue = '';
+								$filterValue = '';
+							}}><Fa icon={faXmark} /></button
+						>
+					</div>
+					<button
+						type="button"
+						class="btn variant-filled-primary"
+						on:click|preventDefault={() => {
+							$filterValue = searchValue;
+						}}>Search</button
+					>
+				</div>
+			{/if}
 			<div class="flex justify-between items-center py-2 w-full">
 				<div>
 					<!-- Enable the fitToScreen toggle if toggle === true -->
@@ -319,14 +381,17 @@
 						<button
 							type="button"
 							class="btn btn-sm variant-filled-primary rounded-full order-last"
-							on:click|preventDefault={resetResize}>Reset sizing</button
+							on:click|preventDefault={() =>
+								resetResize($headerRows, $pageRows, tableId, columns, resizable)}
+							>Reset sizing</button
 						>
 					{/if}
 					{#if exportable}
 						<button
 							type="button"
 							class="btn btn-sm variant-filled-primary rounded-full order-last"
-							on:click|preventDefault={exportAsCsv}>Export as CSV</button
+							on:click|preventDefault={() => exportAsCsv(tableId, $exportedData)}
+							>Export as CSV</button
 						>
 					{/if}
 				</div>
@@ -349,46 +414,45 @@
 								rowProps={headerRow.props()}
 								let:rowProps
 							>
-								<tr {...rowAttrs} class="bg-primary-300 dark:bg-primary-500 items-stretch">
+								<tr {...rowAttrs} class="bg-primary-300 dark:bg-primary-500">
 									{#each headerRow.cells as cell (cell.id)}
 										<Subscribe attrs={cell.attrs()} props={cell.props()} let:props let:attrs>
-											<th
-												scope="col"
-												class="!p-2 overflow-auto"
-												class:resize-x={(resizable === 'columns' || resizable === 'both') &&
-													!fixedWidth(cell.id)}
-												{...attrs}
-												id="th-{tableId}-{cell.id}"
-												style={cellStyle(cell.id)}
-											>
-												<div class="flex justify-between items-center">
-													<div class="flex gap-1 whitespace-pre-wrap">
-														<!-- Adding sorting config and styling -->
-														<span
-															class:underline={props.sort.order}
-															class:normal-case={cell.id !== cell.label}
-															class:cursor-pointer={!props.sort.disabled}
-															on:click={props.sort.toggle}
-															on:keydown={props.sort.toggle}
-														>
-															{cell.render()}
-														</span>
-														<div class="w-2">
-															{#if props.sort.order === 'asc'}
-																▾
-															{:else if props.sort.order === 'desc'}
-																▴
-															{/if}
-														</div>
-													</div>
-													<!-- Adding column filter config -->
-													{#if cell.isData()}
-														{#if props.colFilter?.render}
-															<div class="">
-																<Render of={props.colFilter.render} />
+											<th scope="col" class="!p-2" {...attrs} style={cellStyle(cell.id, columns)}>
+												<div
+													class="overflow-auto"
+													class:resize-x={(resizable === 'columns' || resizable === 'both') &&
+														!fixedWidth(cell.id, columns)}
+													id="th-{tableId}-{cell.id}"
+												>
+													<div class="flex justify-between items-center">
+														<div class="flex gap-1 whitespace-pre-wrap">
+															<!-- Adding sorting config and styling -->
+															<span
+																class:underline={props.sort.order}
+																class:normal-case={cell.id !== cell.label}
+																class:cursor-pointer={!props.sort.disabled}
+																on:click={props.sort.toggle}
+																on:keydown={props.sort.toggle}
+															>
+																{cell.render()}
+															</span>
+															<div class="w-2">
+																{#if props.sort.order === 'asc'}
+																	▴
+																{:else if props.sort.order === 'desc'}
+																	▾
+																{/if}
 															</div>
+														</div>
+														<!-- Adding column filter config -->
+														{#if cell.isData()}
+															{#if props.colFilter?.render}
+																<div class="">
+																	<Render of={props.colFilter.render} />
+																</div>
+															{/if}
 														{/if}
-													{/if}
+													</div>
 												</div>
 											</th>
 										</Subscribe>
@@ -409,20 +473,21 @@
 								<tr {...rowAttrs} id="{tableId}-row-{row.id}" class="">
 									{#each row.cells as cell, index (cell?.id)}
 										<Subscribe attrs={cell.attrs()} let:attrs>
-											<td
-												{...attrs}
-												class="!p-2 overflow-auto {index === 0 &&
-												(resizable === 'rows' || resizable === 'both')
-													? 'resize-y'
-													: ''}"
-												id="{tableId}-{cell.id}-{row.id}"
-											>
-												<!-- Adding config for initial rowHeight, if provided -->
+											<td {...attrs} class="!p-2">
 												<div
-													class="flex items-center"
-													style="height: {rowHeight ? `${rowHeight}px` : 'auto'};"
+													class=" overflow-auto h-max {index === 0 &&
+													(resizable === 'rows' || resizable === 'both')
+														? 'resize-y'
+														: ''}"
+													id="{tableId}-{cell.id}-{row.id}"
 												>
-													<div class="grow h-full"><Render of={cell.render()} /></div>
+													<!-- Adding config for initial rowHeight, if provided -->
+													<div
+														class="flex items-center overflow-auto"
+														style="height: {rowHeight ? `${rowHeight}px` : 'auto'};"
+													>
+														<div class="grow h-full"><Render of={cell.render()} /></div>
+													</div>
 												</div>
 											</td>
 										</Subscribe>
@@ -437,6 +502,17 @@
 	</div>
 	{#if $data.length > 0}
 		<!-- Adding pagination, if table is not empty -->
-		<TablePagination pageConfig={pluginStates.page} {pageSizes} id={tableId} />
+		{#if serverSide}
+			<TablePaginationServer
+				{pageIndex}
+				{pageSize}
+				{serverItemCount}
+				{updateTable}
+				{pageSizes}
+				id={tableId}
+			/>
+		{:else}
+			<TablePagination pageConfig={pluginStates.page} {pageSizes} id={tableId} />
+		{/if}
 	{/if}
 </div>