From b605145e0b51536703c53641b8ef8aa0ff477b9f Mon Sep 17 00:00:00 2001
From: Moritz Vetter <16950410+Isokaeder@users.noreply.github.com>
Date: Thu, 25 Jul 2024 22:01:50 +0200
Subject: [PATCH] refactor(KtTable): make type for store specific data more
 explicit

---
 .../kotti-table/components/TableHeader.vue    | 23 ++++----
 .../kotti-table/components/TableHeaderCell.ts |  4 +-
 .../kotti-table/components/TableRowCell.ts    |  5 +-
 .../kotti-ui/source/kotti-table/constants.ts  | 17 ++++--
 .../source/kotti-table/logic/column.ts        | 31 ++++++-----
 .../source/kotti-table/logic/order.ts         |  2 +-
 .../source/kotti-table/logic/types.ts         | 27 +++++++---
 packages/kotti-ui/source/kotti-table/types.ts | 53 ++++++++-----------
 8 files changed, 95 insertions(+), 67 deletions(-)

diff --git a/packages/kotti-ui/source/kotti-table/components/TableHeader.vue b/packages/kotti-ui/source/kotti-table/components/TableHeader.vue
index 9e11220bcd..c64a8da139 100644
--- a/packages/kotti-ui/source/kotti-table/components/TableHeader.vue
+++ b/packages/kotti-ui/source/kotti-table/components/TableHeader.vue
@@ -49,6 +49,7 @@
 <script lang="ts">
 import { KT_TABLE, KT_STORE } from '../constants'
 import { KottiTable } from '../types'
+import type { Store } from '../logic/types'
 import { computed, defineComponent, inject, ref } from 'vue'
 
 import { TableHeaderCell } from './TableHeaderCell'
@@ -67,8 +68,10 @@ export default defineComponent({
 				'TableRowCell: Component was used without providing the right contexts',
 			)
 
-		const dropTargetColumn = ref<KottiTable.Column.PropsInternal | null>(null)
-		const draggedColumn = ref<KottiTable.Column.PropsInternal | null>(null)
+		const dropTargetColumn =
+			ref<Store.StateComponents.ColumnRepresentation | null>(null)
+		const draggedColumn =
+			ref<Store.StateComponents.ColumnRepresentation | null>(null)
 
 		const useColumnDragToOrder = computed(() => tableState.useColumnDragToOrder)
 		const isDraggedOver = (column: unknown) =>
@@ -84,20 +87,20 @@ export default defineComponent({
 			handleDragEnd: () => {
 				dropTargetColumn.value = null
 			},
-			handleDragEnter: (column: KottiTable.Column.PropsInternal) => {
+			handleDragEnter: (column: Store.StateComponents.ColumnRepresentation) => {
 				dropTargetColumn.value = column
 			},
-			handleDragStart: (column: KottiTable.Column.PropsInternal) => {
+			handleDragStart: (column: Store.StateComponents.ColumnRepresentation) => {
 				draggedColumn.value = column
 			},
-			handleDrop: (column: KottiTable.Column.PropsInternal) => {
+			handleDrop: (column: Store.StateComponents.ColumnRepresentation) => {
 				if (draggedColumn.value) {
 					tableStore.commit('orderBefore', draggedColumn.value, column)
 					draggedColumn.value = null
 				}
 				dropTargetColumn.value = null
 			},
-			getThClasses: (column: KottiTable.Column.PropsInternal) => [
+			getThClasses: (column: Store.StateComponents.ColumnRepresentation) => [
 				{
 					'drag-over': isDraggedOver(column),
 					clickable: canSort(column),
@@ -108,7 +111,7 @@ export default defineComponent({
 				tableState.thClasses,
 				column.thClass,
 			],
-			getThStyle: (column: KottiTable.Column.PropsInternal) => ({
+			getThStyle: (column: Store.StateComponents.ColumnRepresentation) => ({
 				// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
 				textAlign: column.align ?? KottiTable.Column.Align.LEFT,
 				// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
@@ -117,7 +120,7 @@ export default defineComponent({
 			handleSelectAll: () => {
 				tableStore.commit('toggleAllSelection')
 			},
-			handleThClick: (column: KottiTable.Column.PropsInternal) => {
+			handleThClick: (column: Store.StateComponents.ColumnRepresentation) => {
 				if (!useQuickSortControl.value) return
 				if (!canSort(column)) return
 
@@ -129,9 +132,9 @@ export default defineComponent({
 			isExpandable: computed(() => tableState.isExpandable),
 			isSelectable: computed(() => tableState.isSelectable),
 			isSorted,
-			isSortedByAsc: (column: KottiTable.Column.PropsInternal) =>
+			isSortedByAsc: (column: Store.StateComponents.ColumnRepresentation) =>
 				tableStore.get('isSortedByAsc', column),
-			isSortedByDsc: (column: KottiTable.Column.PropsInternal) =>
+			isSortedByDsc: (column: Store.StateComponents.ColumnRepresentation) =>
 				tableStore.get('isSortedByDsc', column),
 			tableColumns: computed(() => tableStore.state.columns),
 			tableHeaderClass: computed(() => [
diff --git a/packages/kotti-ui/source/kotti-table/components/TableHeaderCell.ts b/packages/kotti-ui/source/kotti-table/components/TableHeaderCell.ts
index 5cc3f6ebf8..a0d4a7f199 100644
--- a/packages/kotti-ui/source/kotti-table/components/TableHeaderCell.ts
+++ b/packages/kotti-ui/source/kotti-table/components/TableHeaderCell.ts
@@ -1,6 +1,6 @@
 import { defineComponent, h } from 'vue'
 import type { PropType } from 'vue'
-import type { KottiTable } from '../types'
+import type { Store } from '../logic/types'
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
 export const TableHeaderCell = defineComponent({
@@ -8,7 +8,7 @@ export const TableHeaderCell = defineComponent({
 	props: {
 		column: {
 			required: true,
-			type: Object as PropType<KottiTable.Column.PropsInternal>,
+			type: Object as PropType<Store.StateComponents.ColumnRepresentation>,
 		},
 		columnIndex: {
 			required: true,
diff --git a/packages/kotti-ui/source/kotti-table/components/TableRowCell.ts b/packages/kotti-ui/source/kotti-table/components/TableRowCell.ts
index 3daf4ddc2a..e1804cd1cb 100644
--- a/packages/kotti-ui/source/kotti-table/components/TableRowCell.ts
+++ b/packages/kotti-ui/source/kotti-table/components/TableRowCell.ts
@@ -4,6 +4,7 @@ import { computed, defineComponent, h, inject } from 'vue'
 
 import { KT_TABLE, KT_STORE } from '../constants'
 import { type KottiTable } from '../types'
+import type { Store } from '../logic/types'
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
 export const TableRowCell = defineComponent({
@@ -11,7 +12,7 @@ export const TableRowCell = defineComponent({
 	props: {
 		column: {
 			required: true,
-			type: Object as PropType<KottiTable.Column.PropsInternal>,
+			type: Object as PropType<Store.StateComponents.ColumnRepresentation>,
 		},
 		columnIndex: {
 			required: true,
@@ -61,7 +62,7 @@ export const TableRowCell = defineComponent({
 			$event: MouseEvent,
 			data: {
 				value: unknown
-				column: KottiTable.Column.PropsInternal
+				column: Store.StateComponents.ColumnRepresentation
 				columnIndex: number
 				row: KottiTable.Row.Props
 				rowIndex: number
diff --git a/packages/kotti-ui/source/kotti-table/constants.ts b/packages/kotti-ui/source/kotti-table/constants.ts
index 854c540cc6..91f819a88e 100644
--- a/packages/kotti-ui/source/kotti-table/constants.ts
+++ b/packages/kotti-ui/source/kotti-table/constants.ts
@@ -1,11 +1,12 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 /* eslint-disable @typescript-eslint/explicit-module-boundary-types */
 import type { CreateElement, InjectionKey, VNodeChildren } from 'vue'
+import type { Vue as VueType } from 'vue/types/vue'
 
 import type { KottiTable } from './types'
 import type { TypedEmit } from '../types/typed-emit'
 import type { TableStore } from './logic/store'
-import type { Vue as VueType } from 'vue/types/vue'
+import type { Store } from './logic/types'
 
 export const IS_ASC = /ascending|^1/
 export const IS_DSC = /descending|^-1/
@@ -15,7 +16,7 @@ interface KottiTableContext {
 		activateRow: [unknown, number]
 		cellClick: [
 			{
-				column: KottiTable.Column.PropsInternal
+				column: Store.StateComponents.ColumnRepresentation
 				columnIndex: number
 				row: KottiTable.Row.Props
 				rowIndex: number
@@ -87,8 +88,16 @@ export const COLUMN_TYPE = Symbol('kt-table-column')
 
 export const DEFAULT_DISABLE_ROW = (): boolean => false
 
-export const PUBLIC_SORT_PROPS = ['prop', 'sortBy', 'sortOrder'] as const
-export const PUBLIC_COLUMN_PROPS = ['prop', 'order', 'hidden'] as const
+export const PUBLIC_SORT_PROPS = [
+	'prop',
+	'sortBy',
+	'sortOrder',
+] satisfies (keyof Store.StateComponents.ColumnRepresentation)[]
+export const PUBLIC_COLUMN_PROPS = [
+	'prop',
+	'order',
+	'hidden',
+] satisfies (keyof Store.StateComponents.ColumnRepresentation)[]
 
 export const DEFAULT_RENDER_CELL = function defaultRenderCell(
 	_h: CreateElement,
diff --git a/packages/kotti-ui/source/kotti-table/logic/column.ts b/packages/kotti-ui/source/kotti-table/logic/column.ts
index c3a856d75f..3bc7010b2d 100644
--- a/packages/kotti-ui/source/kotti-table/logic/column.ts
+++ b/packages/kotti-ui/source/kotti-table/logic/column.ts
@@ -13,26 +13,33 @@ import { resolveColumnsOrder, getOrderedColumns } from './order'
 import { setSortedColumn } from './sort'
 import type { Store } from './types'
 
-export function getColumnRealIndex(state: any, column: any) {
-	return state._columnsArray.findIndex(({ id }: any) => id == column.id)
+export function getColumnRealIndex(
+	state: Store.State,
+	column: Store.StateComponents.ColumnRepresentation,
+) {
+	return state._columnsArray.findIndex(({ id }) => id == column.id)
 }
 
-export function getColumnIndex(state: any, column: any) {
-	return state._columns[column.prop].index
+export function getColumnIndex(state: Store.State, columnProp: string): number {
+	const columnInStore = state._columns[columnProp]
+
+	if (!columnInStore?.index)
+		throw new Error(`Could not find column ${columnProp} in KtTable Store`)
+
+	return columnInStore.index
 }
 
 export function setColumnsArray(
-	state: any,
-	prop: any,
-	shapeKeys: any,
-	columns: any,
-	mergeStrategy = Object.assign,
+	state: Store.State,
+	prop: keyof Store.State,
+	shapeKeys: (keyof Store.StateComponents.ColumnRepresentation)[],
+	columns: Store.StateComponents.ColumnRepresentation[],
 ) {
 	state[prop] = columns.map((column: any) => {
 		// eslint-disable-next-line no-param-reassign
 		column = pick(column, shapeKeys)
 		const oldColumn = state._columns[column.prop] ?? {}
-		return mergeStrategy(oldColumn, column)
+		return Object.assign(oldColumn, column)
 	})
 }
 
@@ -73,7 +80,7 @@ export const mutations: Store.MutationComponents.Column = {
 		const { state } = store
 		const deleted = state._destroyedColumns[column.prop]
 
-		const newColumn: KottiTable.Column.PropsInternal = (() => {
+		const newColumn: Store.StateComponents.ColumnRepresentation = (() => {
 			const oldColumn = state._columns[column.prop]
 
 			if (!oldColumn) {
@@ -103,7 +110,7 @@ export const mutations: Store.MutationComponents.Column = {
 				},
 				// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
 				(value) => value !== undefined,
-			) as KottiTable.Column.PropsInternal
+			) as Store.StateComponents.ColumnRepresentation
 		})()
 		Vue.set(state._columns, newColumn.prop, newColumn)
 
diff --git a/packages/kotti-ui/source/kotti-table/logic/order.ts b/packages/kotti-ui/source/kotti-table/logic/order.ts
index 03fbe9ee25..ba03144979 100644
--- a/packages/kotti-ui/source/kotti-table/logic/order.ts
+++ b/packages/kotti-ui/source/kotti-table/logic/order.ts
@@ -57,7 +57,7 @@ export const mutations: Store.MutationComponents.Order = {
 	orderBefore(store, fromColumn, toColumn) {
 		const { state } = store
 		if (fromColumn.id === toColumn.id) return
-		const fromIndex = getColumnIndex(state, fromColumn)
+		const fromIndex = getColumnIndex(state, fromColumn.prop)
 		state._columnsArray.splice(fromIndex, 1)
 
 		const toIndex = getColumnRealIndex(state, toColumn)
diff --git a/packages/kotti-ui/source/kotti-table/logic/types.ts b/packages/kotti-ui/source/kotti-table/logic/types.ts
index f7f5152505..5036bc795e 100644
--- a/packages/kotti-ui/source/kotti-table/logic/types.ts
+++ b/packages/kotti-ui/source/kotti-table/logic/types.ts
@@ -1,16 +1,28 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
-
 import type { Kotti } from '../../types'
 import type { KottiTable } from '../types'
 import type { TableStore } from './store'
 
 export module Store {
 	export module StateComponents {
+		export type ColumnRepresentation = Omit<
+			KottiTable.Column.Props,
+			'align' | 'renderCell' | 'renderHeader' | 'width'
+		> & {
+			_deleted: boolean
+			align: KottiTable.Column.Align
+			id: string
+			isPropDefined: boolean
+			renderCell: KottiTable.Column.RenderCell
+			renderHeader: KottiTable.Column.RenderHeader
+			width: string
+		}
+
 		export type Column = {
-			_columns: Record<string, KottiTable.Column.PropsInternal>
-			_columnsArray: KottiTable.Column.PropsInternal[]
+			_columns: Record<string, ColumnRepresentation>
+			_columnsArray: ColumnRepresentation[]
 			_destroyedColumns: Record<string, number>
-			columns: KottiTable.Column.PropsInternal[]
+			columns: ColumnRepresentation[]
 			refreshColumnArray: boolean
 		}
 
@@ -84,7 +96,10 @@ export module Store {
 			insertColumn(
 				this: TableStore,
 				store: TableStore,
-				payload: { column: KottiTable.Column.PropsInternal; index?: number },
+				payload: {
+					column: Store.StateComponents.ColumnRepresentation
+					index?: number
+				},
 			): void
 			removeColumn(this: TableStore, store: TableStore, column: any): void
 			setColumns(this: TableStore, store: TableStore, columns: any): void
@@ -175,7 +190,7 @@ export module Store {
 				this: TableStore,
 				store: TableStore,
 				options: {
-					column: KottiTable.Column.PropsInternal
+					column: Store.StateComponents.ColumnRepresentation
 					order?: any
 				},
 			): void
diff --git a/packages/kotti-ui/source/kotti-table/types.ts b/packages/kotti-ui/source/kotti-table/types.ts
index 250f5a3a8c..7e764c68bc 100644
--- a/packages/kotti-ui/source/kotti-table/types.ts
+++ b/packages/kotti-ui/source/kotti-table/types.ts
@@ -1,4 +1,5 @@
 import type { CreateElement, VNode, VNodeChildren } from 'vue'
+import type { Store } from './logic/types'
 
 export module KottiTable {
 	export module Column {
@@ -27,8 +28,10 @@ export module KottiTable {
 			| -1
 			| 0
 
+		export type SortMethod = <T>(a: T, b: T) => number
+
 		export interface Context {
-			column: Column.PropsInternal
+			column: Store.StateComponents.ColumnRepresentation
 			columnIndex: number
 			row: Row.Props
 			rowIndex: number
@@ -56,6 +59,21 @@ export module KottiTable {
 			sortOrder: SortOrder
 		}
 
+		export type Formatter = (
+			value: Context['value'],
+			row: Context['row'],
+			column: Context['column'],
+			columnIndex: Context['columnIndex'],
+			rowIndex: Context['rowIndex'],
+		) => unknown
+
+		export type RenderCell = (h: CreateElement, data: Context) => VNodeChildren
+
+		export type RenderHeader = (
+			h: CreateElement,
+			data: Pick<Context, 'column' | 'columnIndex' | 'value'>,
+		) => VNodeChildren
+
 		export type Props = {
 			index?: number // Unused
 			label?: string
@@ -75,7 +93,7 @@ export module KottiTable {
 			hidden?: boolean
 
 			sortBy?: SortBy
-			sortMethod?: ((a: unknown, b: unknown) => number) | null
+			sortMethod?: SortMethod
 			sortOrder?: SortOrder
 			sortOrders?: SortOrders[]
 			// whether this column is sortable, string means sortOrder is remote
@@ -83,34 +101,9 @@ export module KottiTable {
 
 			default?: string
 			disableRowClick?: boolean
-			formatter?: (
-				value: Context['value'],
-				row: Context['row'],
-				column: Context['column'],
-				columnIndex: Context['columnIndex'],
-				rowIndex: Context['rowIndex'],
-			) => unknown
-			renderCell?: (h: CreateElement, data: Context) => VNode
-			renderHeader?: (
-				h: CreateElement,
-				data: Pick<Context, 'column' | 'columnIndex' | 'value'>,
-			) => VNode
-		}
-
-		export type PropsInternal = Omit<
-			Props,
-			'align' | 'renderCell' | 'renderHeader' | 'width'
-		> & {
-			_deleted: boolean
-			align: Align
-			id: string
-			isPropDefined: boolean
-			renderCell: (h: CreateElement, data: Context) => VNodeChildren
-			renderHeader: (
-				h: CreateElement,
-				data: Pick<Context, 'column' | 'columnIndex' | 'value'>,
-			) => VNodeChildren
-			width: string
+			formatter?: Formatter
+			renderCell?: RenderCell
+			renderHeader?: RenderHeader
 		}
 
 		export module Slots {