@lavalogic/scoria 0.35.0 → 0.37.0

package/dist/Components/Table/Body/Rows/Columns/TableQuerySelect.svelte

@@ -1,341 +1,264 @@
-<svelte:options runes />
-
-<script
-	lang="ts"
-	generics="T extends object,"
->
-	import QuerySelect from '../../../../QuerySelect.svelte';
-	import type { QueryDef } from '../../../Types/Columns/Definitions/Accessors/QueryDef.svelte.js';
-	import { TableContext } from '../../../Types/Context/TableContext.svelte.js';
-	import { TableFocusDetails } from '../../../Types/Focus/TableFocusDetails.svelte.js';
-	import { devCatch, isValidityTuple, loadingText } from '../../../../../Helpers/Helpers.svelte.js';
-	import type { SelectOption } from '../../../../../Types/Internal/SelectOption.js';
-	import { Validity } from '../../../../../Types/Internal/Validity.js';
-	import { getContext, tick, untrack } from 'svelte';
-	import type { TableQuerySelectProps } from './TableQuerySelectProps.js';
-
-	const { cell }: TableQuerySelectProps<T, unknown> = $props();
-
-	const value = $derived((cell.getValue() ?? null) as unknown);
-
-	const visibleValue = $derived(
-		cell.column.columnDef.getDisplayValue(cell.row.original, cell.row.originalIndex)
-	);
-
-	let tdref = $state<HTMLTableCellElement | undefined>();
-
-	const columnDef: QueryDef<T> = $derived(cell.column.columnDef) as unknown as QueryDef<T>; // TODO stabilise and remove `as unknown`
-	// const optional = $derived(columnDef.optional ?? false);
-
-	let lastOptions: Array<SelectOption<unknown>> = $state([]);
-
-	const tableContext = getContext<TableContext<T, never>>(TableContext.identifier);
-
-	const editable = $derived(
-		cell.column.columnDef.isEditable(cell.row.original, cell.row.originalIndex)
-	);
-
-	let valueAsyncCounter = 0;
-	$effect(() => {
-		void value;
-		void lastOptions;
-
-		untrack(() => {
-			const localCounter = (valueAsyncCounter = valueAsyncCounter + 1);
-			(async () => {
-				try {
-					const awaitedValue = await value;
-					const label = (await visibleValue) ?? awaitedValue?.toString();
-
-					if (awaitedValue != null && valueAsyncCounter === localCounter) {
-						if (label == null) {
-							throw new Error('invalid label and value');
-						}
-						if (!lastOptions.some((it) => it.value == awaitedValue)) {
-							lastOptions.push({
-								label,
-								value: awaitedValue,
-							});
-						}
-					} else if (columnDef.debug) {
-						console.debug(
-							`${cell.column.columnDef.id}: `,
-							'skipping async option insertion because it is stale'
-						);
-					}
-				} catch (e) {
-					if (columnDef.debug) {
-						console.error(e);
-					}
-					if (valueAsyncCounter === localCounter) {
-						//nothing happens
-					} else if (columnDef.debug) {
-						console.debug(
-							`${cell.column.columnDef.id}: `,
-							'skipping caught async option insertion error because it is stale'
-						);
-					}
-				}
-			})().catch(devCatch);
-		});
-	});
-
-	const focusDetails: TableFocusDetails<T, never> = $derived(
-		new TableFocusDetails(cell, tableContext)
-	);
-
-	const wantsToBeEdited = $derived(
-		tableContext.focusStart?.column === focusDetails.coordinates.column &&
-			tableContext.focusEnd?.column === focusDetails.coordinates.column &&
-			tableContext.focusStart.row === focusDetails.coordinates.row &&
-			tableContext.focusEnd.row === focusDetails.coordinates.row &&
-			!tableContext.isMousingDown &&
-			tableContext.focusStartIsBeingEdited
-	);
-
-	let isBeingEdited = $state(false);
-
-	function handleIsEditable(isEditable: boolean): Promise<void> {
-		if (isEditable) {
-			return tick().then(() => {
-				isBeingEdited = true;
-			});
-		} else {
-			if (isBeingEdited) {
-				return tick()
-					.then(() => {
-						if (!tableContext.singleClickEditing) {
-							tableContext.focusStartIsBeingEdited = false;
-						}
-
-						isBeingEdited = false;
-					})
-					.catch(devCatch);
-			}
-		}
-		return Promise.resolve();
-	}
-
-	$effect(() => {
-		void editable;
-		if (wantsToBeEdited) {
-			if (editable instanceof Promise) {
-				editable
-					.then((isEditable) => {
-						return handleIsEditable(isEditable);
-					})
-
-					.catch(devCatch);
-			} else {
-				handleIsEditable(editable).catch(devCatch);
-			}
-		} else {
-			tick()
-				.then(() => {
-					isBeingEdited = false;
-					tableContext.focusStartIsBeingEdited = false;
-				})
-				.catch(devCatch);
-		}
-	});
-
-	let validity: Validity = $state(Validity.Valid);
-	$effect(() => {
-		const validityPromise = focusDetails.validity;
-
-		validityPromise
-			.then((v) => {
-				if (!v) {
-					validity = Validity.Neutral;
-				} else if (isValidityTuple(v)) {
-					validity = v.value;
-				} else {
-					validity = v;
-				}
-			})
-			.catch(devCatch);
-	});
-
-	const handleTDFocus = async () => {
-		if (
-			(await editable) &&
-			tableContext.focusStart?.column === focusDetails.coordinates.column &&
-			tableContext.focusStart.row === focusDetails.coordinates.row
-		) {
-			if (
-				tableContext.focusEnd?.column !== focusDetails.coordinates.column ||
-				tableContext.focusEnd.row !== focusDetails.coordinates.row
-			) {
-				tableContext.setFocusEnd(focusDetails.coordinates);
-			}
-
-			tableContext.isMousingDown = false;
-			tableContext.focusStartIsBeingEdited = true;
-			return true;
-		}
-
-		return false;
-	};
-
-	async function handleSingleClick(): Promise<boolean> {
-		return tableContext.singleClickEditing && (await handleTDFocus());
-	}
-	async function handleDoubleClick(): Promise<boolean> {
-		return !tableContext.singleClickEditing && (await handleTDFocus());
-	}
-
-	function tryHandleTDFocus() {
-		handleTDFocus().catch(devCatch);
-	}
-
-	function handleUnfocus(e: KeyboardEvent) {
-		if (e.key === 'Escape') {
-			e.preventDefault();
-			e.stopPropagation();
-
-			tableContext.focusStartIsBeingEdited = false;
-			tick()
-				.then(() => {
-					tdref?.focus();
-				})
-				.catch(devCatch);
-
-			return true;
-		}
-
-		if (e.key === 'Tab') {
-			e.preventDefault();
-			return true;
-		}
-
-		return false;
-	}
-
-	function keydownForce(e: KeyboardEvent) {
-		const shouldStop = handleUnfocus(e);
-		if (!shouldStop && !(e.key === 'ArrowUp' || e.key === 'ArrowDown')) {
-			tick()
-				.then(() => {
-					tdref?.dispatchEvent(
-						new KeyboardEvent('keydown', {
-							key: e.key,
-							altKey: e.getModifierState('Alt'),
-							metaKey: e.getModifierState('Meta'),
-							shiftKey: e.getModifierState('Shift'),
-							ctrlKey: e.getModifierState('Control'),
-							bubbles: true,
-						})
-					);
-				})
-				.catch(devCatch);
-		}
-	}
-
-	function addKeydownEvent(target: HTMLInputElement | undefined) {
-		target?.addEventListener('keydown', keydownForce);
-	}
-
-	let prevtdref: HTMLTableCellElement | undefined = undefined;
-	$effect(() => {
-		void tdref;
-		untrack(() => {
-			if (tdref && tdref != prevtdref) {
-				tdref.addEventListener('edit', tryHandleTDFocus);
-			} else {
-				prevtdref = tdref;
-			}
-		});
-	});
-</script>
-
-{#if isBeingEdited}
-	<!-- onkeydown={handleInputKeydown} -->
-	<!-- onkeydown={handleEsc} -->
-	<td
-		class="select-cell"
-		bind:this={tdref}
-	>
-		<!-- TODO: -->
-		{#await value then value}
-			<QuerySelect
-				focusOnLoad
-				name={cell.column.columnDef.id}
-				valueProp="value"
-				labelProp="label"
-				clearable={cell.column.columnDef.clearable}
-				valueAsObject={false}
-				{value}
-				query={(v: string) => columnDef.query(v, cell.row.original, cell.row.originalIndex)}
-				bind:options={lastOptions}
-				onfocus={addKeydownEvent}
-				onchange={(newValue: SelectOption<unknown> | null) => {
-					if (newValue?.value !== value) {
-						tableContext
-							.onEditCell(cell.row.original, focusDetails.coordinates, newValue?.value ?? null)
-							.catch(devCatch);
-					}
-
-					tableContext.focusStartIsBeingEdited = false;
-					tick()
-						.then(() => {
-							tdref?.focus();
-						})
-						.catch(devCatch);
-				}}
-			/>
-		{/await}
-	</td>
-{:else}
-	<!-- // onkeydown={handleTdKeydown} -->
-	<!-- svelte-ignore a11y_mouse_events_have_key_events -->
-	<td
-		style={focusDetails.outline}
-		bind:this={tdref}
-		tabIndex="0"
-		id={`${tableContext.tableName}-cell-${cell.row.visibleIndex}-${cell.column.id}`}
-		class="focusable editable"
-		class:multifocus={focusDetails.isMultiFocused}
-		class:multifocus-start={focusDetails.isMultiFocusStart}
-		class:info={validity == Validity.Info}
-		class:success={validity == Validity.Valid}
-		class:warning={validity == Validity.Warning}
-		class:error={validity == Validity.Invalid}
-		ondblclick={handleDoubleClick}
-		onmousedown={(e) => {
-			// start focus only on left click
-			if (e.button === 0) {
-				if (e.shiftKey) {
-					e.preventDefault();
-					tableContext.setFocusEnd(focusDetails.coordinates);
-				} else {
-					tableContext.startFocus(focusDetails.coordinates);
-				}
-			}
-		}}
-		onmouseover={() => {
-			if (tableContext.isMousingDown) {
-				tableContext.setFocusEnd(focusDetails.coordinates);
-			}
-		}}
-		onmouseup={() => {
-			handleSingleClick()
-				.then((wasHandled) => {
-					if (!wasHandled) {
-						tableContext.endFocus(focusDetails.coordinates);
-					}
-				})
-				.catch(devCatch);
-		}}
-	>
-		{#await visibleValue}
-			{loadingText}
-		{:then v}
-			{v}
-		{/await}
-	</td>
-{/if}
-
-<style>td {
+<svelte:options runes />
+
+<script
+	lang="ts"
+	generics="T extends object, RowIdType extends Primitive"
+>
+	import QuerySelect from '../../../../QuerySelect.svelte';
+	import type { QueryDef } from '../../../Types/Columns/Definitions/Accessors/QueryDef.svelte.js';
+	import { TableContext } from '../../../Types/Context/TableContext.svelte.js';
+	import { type Primitive } from '../../../Types/Context/TableInitOptions.js';
+	import { devCatch, loadingText } from '../../../../../Helpers/Helpers.svelte.js';
+	import type { SelectOption } from '../../../../../Types/Internal/SelectOption.js';
+	import { Validity } from '../../../../../Types/Internal/Validity.js';
+	import { getContext, tick, untrack } from 'svelte';
+	import { useAsyncEditable } from './_helpers/useAsyncEditable.svelte.js';
+	import type { TableQuerySelectProps } from './TableQuerySelectProps.js';
+
+	const { cell }: TableQuerySelectProps<T, unknown> = $props();
+
+	const value = $derived((cell.getValue() ?? null) as unknown);
+
+	const visibleValue = $derived(
+		cell.column.columnDef.getDisplayValue(cell.row.original, cell.row.originalIndex)
+	);
+
+	let tdref = $state<HTMLElement | undefined>();
+
+	/**
+	 * Narrow the column def to `QueryDef<T>`. The cast is required because
+	 * `TableCell.column.columnDef` is the loose `ColumnDef<T>`; `TableColumn`
+	 * dispatches this component only when the underlying def is in fact a
+	 * `QueryDef`, but the static type does not reflect that. Replacing this
+	 * with a discriminated cell-host props type is tracked under the
+	 * cross-cutting RowGenericThreading workorder.
+	 */
+	const columnDef: QueryDef<T> = $derived(cell.column.columnDef) as unknown as QueryDef<T>;
+
+	// `bind:options` below requires a `let` binding even though we never
+	// reassign the reference (Svelte uses the binding for two-way wiring).
+	// eslint-disable-next-line svelte/prefer-const
+	let lastOptions: Array<SelectOption<unknown>> = $state([]);
+
+	const tableContext = getContext<TableContext<T, RowIdType>>(TableContext.identifier);
+
+	let valueAsyncCounter = 0;
+	$effect(() => {
+		void value;
+		void lastOptions;
+
+		untrack(() => {
+			const localCounter = (valueAsyncCounter = valueAsyncCounter + 1);
+			(async () => {
+				try {
+					const awaitedValue = await value;
+					const label = (await visibleValue) ?? awaitedValue?.toString();
+
+					if (awaitedValue != null && valueAsyncCounter === localCounter) {
+						if (label == null) {
+							throw new Error('invalid label and value');
+						}
+						if (!lastOptions.some((it) => it.value == awaitedValue)) {
+							lastOptions.push({
+								label,
+								value: awaitedValue,
+							});
+						}
+					} else if (columnDef.debug) {
+						console.debug(
+							`${cell.column.columnDef.id}: `,
+							'skipping async option insertion because it is stale'
+						);
+					}
+				} catch (e) {
+					if (columnDef.debug) {
+						console.error(e);
+					}
+					if (valueAsyncCounter === localCounter) {
+						//nothing happens
+					} else if (columnDef.debug) {
+						console.debug(
+							`${cell.column.columnDef.id}: `,
+							'skipping caught async option insertion error because it is stale'
+						);
+					}
+				}
+			})().catch(devCatch);
+		});
+	});
+
+	const editable = useAsyncEditable<T, RowIdType>({
+		cell: () => cell,
+	});
+
+	function handleUnfocus(e: KeyboardEvent) {
+		if (e.key === 'Escape') {
+			e.preventDefault();
+			e.stopPropagation();
+			editable.leaveEditingViaKeyboard(tdref);
+			return true;
+		}
+
+		if (e.key === 'Tab') {
+			e.preventDefault();
+			return true;
+		}
+
+		return false;
+	}
+
+	function keydownForce(e: KeyboardEvent) {
+		const shouldStop = handleUnfocus(e);
+		if (!shouldStop && !(e.key === 'ArrowUp' || e.key === 'ArrowDown')) {
+			tick()
+				.then(() => {
+					tdref?.dispatchEvent(
+						new KeyboardEvent('keydown', {
+							key: e.key,
+							altKey: e.getModifierState('Alt'),
+							metaKey: e.getModifierState('Meta'),
+							shiftKey: e.getModifierState('Shift'),
+							ctrlKey: e.getModifierState('Control'),
+							bubbles: true,
+						})
+					);
+				})
+				.catch(devCatch);
+		}
+	}
+
+	/**
+	 * Tracks the inner QuerySelect input so the keydown re-dispatcher can be
+	 * removed cleanly on blur or remount; the prior implementation accumulated
+	 * one listener per focus event (P1 workorder finding). This wiring is
+	 * genuinely cell-specific (Select / QuerySelect only) and therefore lives
+	 * outside the shared `useAsyncEditable` helper.
+	 */
+	let activeKeydownTarget: HTMLInputElement | undefined;
+
+	function addKeydownEvent(target: HTMLInputElement | undefined) {
+		if (activeKeydownTarget && activeKeydownTarget !== target) {
+			activeKeydownTarget.removeEventListener('keydown', keydownForce);
+		}
+		if (target) {
+			target.addEventListener('keydown', keydownForce);
+			activeKeydownTarget = target;
+		}
+	}
+
+	function removeKeydownEvent() {
+		if (activeKeydownTarget) {
+			activeKeydownTarget.removeEventListener('keydown', keydownForce);
+			activeKeydownTarget = undefined;
+		}
+	}
+
+	/**
+	 * Effect wires the `edit` custom event with proper cleanup on tdref
+	 * remount or component unmount (replaces the previous `prevtdref` pattern
+	 * that accumulated listeners; P1 workorder finding). The listener wiring
+	 * lives in the shared `useAsyncEditable` helper.
+	 */
+	$effect(() => editable.attachEditListener(tdref));
+
+	// Ensure the keydown listener is dropped when the cell unmounts.
+	$effect(() => removeKeydownEvent);
+</script>
+
+{#if editable.isBeingEdited}
+	<div
+		class="select-cell"
+		bind:this={tdref}
+	>
+		{#await value then value}
+			<QuerySelect
+				focusOnLoad
+				name={cell.column.columnDef.id}
+				valueProp={'value' as never}
+				labelProp={'label' as never}
+				clearable={cell.column.columnDef.clearable}
+				valueAsObject={false}
+				value={value as never}
+				query={(v: string) => columnDef.query(v, cell.row.original, cell.row.originalIndex)}
+				bind:options={lastOptions as never}
+				onfocus={addKeydownEvent}
+				onchange={(newValue: unknown) => {
+					// Phase 7.6: `valueAsObject={false}` means QuerySelect
+					// hands us the primitive value directly; no more
+					// `.value` dig off an option object. The `as never`
+					// casts work around inference: see TableSelect for the
+					// same workaround.
+					if (newValue !== value) {
+						tableContext
+							.onEditCell(cell.row.original, editable.focusDetails.coordinates, newValue ?? null)
+							.catch(devCatch);
+					}
+
+					removeKeydownEvent();
+					tableContext.focusStartIsBeingEdited = false;
+					tick()
+						.then(() => {
+							tdref?.focus();
+						})
+						.catch(devCatch);
+				}}
+			/>
+		{/await}
+	</div>
+{:else}
+	<!-- svelte-ignore a11y_mouse_events_have_key_events -->
+	<!-- svelte-ignore a11y_no_static_element_interactions -->
+	<div
+		style={editable.focusDetails.outline}
+		bind:this={tdref}
+		tabIndex="0"
+		id={`${tableContext.tableName}-cell-${cell.row.visibleIndex}-${cell.column.id}`}
+		class="focusable editable"
+		class:multifocus={editable.focusDetails.isMultiFocused}
+		class:multifocus-start={editable.focusDetails.isMultiFocusStart}
+		class:info={editable.validity == Validity.Info}
+		class:success={editable.validity == Validity.Valid}
+		class:warning={editable.validity == Validity.Warning}
+		class:error={editable.validity == Validity.Invalid}
+		ondblclick={() => {
+			editable.handleDoubleClickFocus();
+		}}
+		onmousedown={(e) => {
+			// start focus only on left click
+			if (e.button === 0) {
+				if (e.shiftKey) {
+					e.preventDefault();
+					tableContext.setFocusEnd(editable.focusDetails.coordinates);
+				} else {
+					tableContext.startFocus(editable.focusDetails.coordinates);
+				}
+			}
+		}}
+		onmouseover={() => {
+			if (tableContext.isMousingDown) {
+				tableContext.setFocusEnd(editable.focusDetails.coordinates);
+			}
+		}}
+		onmouseup={() => {
+			const wasHandled = editable.handleSingleClickFocus();
+			if (!wasHandled) {
+				tableContext.endFocus(editable.focusDetails.coordinates);
+			}
+		}}
+	>
+		{#await visibleValue}
+			{loadingText}
+		{:then v}
+			{v}
+		{/await}
+	</div>
+{/if}
+
+<style>.focusable,
+.checkbox-cell,
+.input-cell,
+.select-cell,
+.datepicker-cell {
   transition: line-height 0.2s ease, height 0.2s ease;
   --input-border: none;
   --input-height: var(--height);
@@ -345,49 +268,63 @@
   position: relative;
   padding-left: 0.75rem;
   padding-right: 0.75rem;
-  border: solid 1px #cbd4da;
-  border-left: none;
+  border-right: solid 1px #cbd4da;
+  border-bottom: solid 1px #cbd4da;
+  box-sizing: border-box;
+  width: 100%;
+  height: var(--height);
 }
 
-td.multifocus {
+.focusable.multifocus,
+.checkbox-cell.multifocus,
+.input-cell.multifocus,
+.select-cell.multifocus {
   background-color: var(--multifocus-colour, #e6f8fd);
 }
-td.multifocus.multifocus-start {
+.focusable.multifocus.multifocus-start,
+.checkbox-cell.multifocus.multifocus-start,
+.input-cell.multifocus.multifocus-start,
+.select-cell.multifocus.multifocus-start {
   background-color: #ffffff;
 }
 
-td.focusable {
+.focusable {
   user-select: none;
   cursor: default;
   outline: none;
 }
-td.focusable.editable {
+.focusable.editable {
   cursor: pointer;
 }
 
-td.info {
+.focusable.info,
+.checkbox-cell.info,
+.input-cell.info,
+.select-cell.info {
   background-color: #1f81a0;
 }
-td.warning {
+.focusable.warning,
+.checkbox-cell.warning,
+.input-cell.warning,
+.select-cell.warning {
   background-color: #f8eab8;
 }
-td.error {
+.focusable.error,
+.checkbox-cell.error,
+.input-cell.error,
+.select-cell.error {
   background-color: #f9e9e9;
 }
 
-td.select-cell {
+.select-cell {
   padding: unset;
   box-sizing: border-box;
-  vertical-align: middle;
   text-align: center;
-}
-
-td {
   --sv-border: none;
 }
-td :global(.select-wrapper) {
+.select-cell :global(.select-wrapper) {
   --sv-min-height: 0px;
   --sv-general-padding: 0px;
   --sv-item-wrap-padding: 0px 0.75rem;
   --input-height: var(--height);
-}</style>
+}</style>