svelte-kit-vice/src/uix/soma/components/editable/editable-provider.svelte.test.ts

// @vitest-environment jsdom

import { tick } from 'svelte';
import { afterEach, describe, expect, it, vi } from 'vitest';

import { createActiveDom } from '$adom';
import { state } from '$libs/reactive';
import type { Morfo } from '$uix/morfo';
import { Soma } from '$soma/core/soma.svelte';
import { createSomaRuntime, type SomaRuntimeSources } from '$soma/runtime.svelte';

import {
	EditableAreaProvider,
	EditableCancelTriggerProvider,
	EditableControlProvider,
	EditableEditTriggerProvider,
	EditableInputProvider,
	EditablePreviewProvider,
	EditableProvider,
	EditableSubmitTriggerProvider
} from './editable-provider.svelte';
import type { ActivationMode, SubmitMode } from './types';

function withEffectRoot<T>(fn: () => T): { result: T; cleanup: () => void } {
	let result!: T;
	const cleanup = $effect.root(() => {
		result = fn();
	});
	return { result, cleanup };
}

function installSomaHarness() {
	const dom = createActiveDom();
	const soma = {
		dom,
		langs: {
			ts: vi.fn((key: string) => {
				if (key.includes('save')) return 'Save';
				if (key.includes('cancel')) return 'Cancel';
				return 'Edit';
			})
		},
		runtime: (morfo: Morfo, sources: Omit<SomaRuntimeSources, 'dom' | 'eventEngine'>) =>
			createSomaRuntime(morfo, {
				dom,
				translate: (key) => key,
				...sources
			})
	} as unknown as Soma;

	vi.spyOn(Soma, 'require').mockReturnValue(soma);
	vi.spyOn(EditableProvider.ctx, 'set').mockImplementation((value) => value);

	return { dom };
}

function editableOpts(root = document.createElement('div')) {
	return {
		id: state('editable-root'),
		ref: state<HTMLElement | null>(root),
		value: state('Hello'),
		editing: state(false),
		placeholder: state('Untitled'),
		activationMode: state<ActivationMode>('click'),
		submitMode: state<SubmitMode>('enter'),
		selectOnFocus: state(true),
		autoResize: state(true),
		maxLength: state<number | undefined>(20),
		disabled: state(false),
		readonly: state(false),
		invalid: state(false),
		required: state(false),
		name: state(''),
		onValueCommit: state(vi.fn()),
		onValueRevert: state(vi.fn())
	};
}

function keyEvent(key: string, shiftKey = false) {
	return {
		key,
		shiftKey,
		preventDefault: vi.fn()
	};
}

function inputEvent(input: HTMLInputElement) {
	return {
		currentTarget: input
	};
}

describe('EditableProvider', () => {
	afterEach(() => {
		vi.restoreAllMocks();
		document.body.innerHTML = '';
	});

	it('starts editing, focuses the input and projects provider/area state attrs', async () => {
		const { dom } = installSomaHarness();
		let scheduledFrame: FrameRequestCallback | undefined;
		const requestFrame = vi.spyOn(dom, 'requestFrame').mockImplementation((callback) => {
			scheduledFrame = callback;
			return 42;
		});
		const focusSpy = vi.spyOn(dom, 'focus');
		const root = document.createElement('div');
		const areaEl = document.createElement('div');
		const inputEl = document.createElement('input');
		const selectSpy = vi.spyOn(inputEl, 'select');
		root.append(areaEl, inputEl);
		document.body.appendChild(root);
		const opts = editableOpts(root);

		const { result, cleanup } = withEffectRoot(() => {
			const provider = EditableProvider.create(opts);
			vi.spyOn(EditableProvider, 'require').mockReturnValue(provider);
			const area = EditableAreaProvider.create({
				id: state('editable-area'),
				ref: state<HTMLElement | null>(areaEl)
			});
			const input = EditableInputProvider.create({
				id: state('editable-input'),
				ref: state<HTMLInputElement | null>(inputEl)
			});
			provider.inputRef.current = inputEl;
			return { provider, area, input };
		});

		result.provider.startEdit();
		expect(opts.editing.current).toBe(true);
		expect(result.provider.draft).toBe('Hello');
		expect(requestFrame).toHaveBeenCalledOnce();
		scheduledFrame?.(performance.now());
		expect(focusSpy).toHaveBeenCalledWith(inputEl);
		expect(selectSpy).toHaveBeenCalledOnce();

		expect(result.input.props).toMatchObject({
			id: 'editable-input',
			hidden: undefined,
			value: 'Hello',
			placeholder: 'Untitled',
			maxlength: 20,
			style: {
				'field-sizing': 'content',
				'min-width': '2ch'
			}
		});

		await tick();
		expect(root.getAttribute('data-editing')).toBe('');
		expect(root.hasAttribute('data-empty')).toBe(false);
		expect(areaEl.getAttribute('data-editing')).toBe('');
		expect(areaEl.hasAttribute('data-disabled')).toBe(false);

		cleanup();
		dom.dispose();
	});

	it('handles preview activation, keyboard submit/cancel and blur control guards', () => {
		const { dom } = installSomaHarness();
		vi.spyOn(dom, 'requestFrame').mockReturnValue(1);
		const root = document.createElement('div');
		const previewEl = document.createElement('div');
		const inputEl = document.createElement('input');
		root.append(previewEl, inputEl);
		document.body.appendChild(root);
		const opts = editableOpts(root);

		const { result, cleanup } = withEffectRoot(() => {
			const provider = EditableProvider.create(opts);
			vi.spyOn(EditableProvider, 'require').mockReturnValue(provider);
			const preview = EditablePreviewProvider.create({
				id: state('editable-preview'),
				ref: state<HTMLElement | null>(previewEl)
			});
			const input = EditableInputProvider.create({
				id: state('editable-input'),
				ref: state<HTMLInputElement | null>(inputEl)
			});
			provider.inputRef.current = inputEl;
			return { provider, preview, input };
		});

		result.preview.onclick({ currentTarget: previewEl } as never);
		expect(opts.editing.current).toBe(true);
		expect(result.preview.props.hidden).toBe(true);

		inputEl.value = 'Draft';
		result.input.oninput(inputEvent(inputEl) as never);
		const enter = keyEvent('Enter');
		result.input.onkeydown(enter as never);
		expect(enter.preventDefault).toHaveBeenCalledOnce();
		expect(opts.value.current).toBe('Draft');
		expect(opts.editing.current).toBe(false);
		expect(opts.onValueCommit.current).toHaveBeenLastCalledWith('Draft');

		result.provider.startEdit();
		inputEl.value = 'Reverted';
		result.input.oninput(inputEvent(inputEl) as never);
		const escape = keyEvent('Escape');
		result.input.onkeydown(escape as never);
		expect(escape.preventDefault).toHaveBeenCalledOnce();
		expect(opts.value.current).toBe('Draft');
		expect(result.provider.draft).toBe('Draft');
		expect(opts.onValueRevert.current).toHaveBeenCalledOnce();

		opts.activationMode.current = 'dblclick';
		result.preview.onclick({ currentTarget: previewEl } as never);
		expect(opts.editing.current).toBe(false);
		result.preview.ondblclick({ currentTarget: previewEl } as never);
		expect(opts.editing.current).toBe(true);

		opts.submitMode.current = 'blur';
		inputEl.value = 'Held';
		result.input.oninput(inputEvent(inputEl) as never);
		const submitTrigger = document.createElement('button');
		submitTrigger.setAttribute('data-editable-submit-trigger', '');
		result.input.onblur({ relatedTarget: submitTrigger } as unknown as FocusEvent);
		expect(opts.editing.current).toBe(true);
		expect(opts.value.current).toBe('Draft');

		result.input.onblur({ relatedTarget: null } as unknown as FocusEvent);
		expect(opts.editing.current).toBe(false);
		expect(opts.value.current).toBe('Held');

		cleanup();
		dom.dispose();
	});

	it('exposes trigger labels and guards disabled or readonly edits', () => {
		const { dom } = installSomaHarness();
		vi.spyOn(dom, 'requestFrame').mockReturnValue(1);
		const root = document.createElement('div');
		const editEl = document.createElement('button');
		const controlEl = document.createElement('div');
		const submitEl = document.createElement('button');
		const cancelEl = document.createElement('button');
		root.append(controlEl, editEl, submitEl, cancelEl);
		document.body.appendChild(root);
		const opts = editableOpts(root);

		const { result, cleanup } = withEffectRoot(() => {
			const provider = EditableProvider.create(opts);
			vi.spyOn(EditableProvider, 'require').mockReturnValue(provider);
			const edit = EditableEditTriggerProvider.create({
				id: state('editable-edit'),
				ref: state<HTMLButtonElement | null>(editEl)
			});
			const control = EditableControlProvider.create({
				id: state('editable-control'),
				ref: state<HTMLElement | null>(controlEl)
			});
			const submit = EditableSubmitTriggerProvider.create({
				id: state('editable-submit'),
				ref: state<HTMLButtonElement | null>(submitEl)
			});
			const cancel = EditableCancelTriggerProvider.create({
				id: state('editable-cancel'),
				ref: state<HTMLButtonElement | null>(cancelEl)
			});
			return { provider, control, edit, submit, cancel };
		});

		expect(result.control.props).toMatchObject({
			id: 'editable-control'
		});
		expect(result.edit.props).toMatchObject({
			type: 'button',
			disabled: undefined,
			'aria-label': 'Edit'
		});
		expect(result.submit.props.disabled).toBe(true);
		expect(result.cancel.props.disabled).toBe(true);

		result.edit.onclick({ currentTarget: editEl } as never);
		expect(opts.editing.current).toBe(true);
		expect(result.edit.props.disabled).toBe(true);
		expect(result.edit.props['data-editing']).toBe('');
		expect(result.submit.props).toMatchObject({
			disabled: undefined,
			'aria-label': 'Save'
		});
		expect(result.cancel.props).toMatchObject({
			disabled: undefined,
			'aria-label': 'Cancel'
		});

		result.submit.onclick({ currentTarget: submitEl } as never);
		expect(opts.editing.current).toBe(false);
		expect(opts.onValueCommit.current).toHaveBeenLastCalledWith('Hello');

		opts.readonly.current = true;
		expect(result.edit.props.disabled).toBe(true);
		result.edit.onclick({ currentTarget: editEl } as never);
		expect(opts.editing.current).toBe(false);

		opts.readonly.current = false;
		opts.disabled.current = true;
		expect(result.cancel.props.disabled).toBe(true);
		result.provider.startEdit();
		expect(opts.editing.current).toBe(false);

		cleanup();
		dom.dispose();
	});
});