inspector/core/react/useClientSettingsDraft.ts
Cliff Hall 373f346e5f
Some checks failed
Run install, format, lint, build, and test on every push / build (push) Has been cancelled
Run install, format, lint, build, and test on every push / publish (push) Has been cancelled
Run install, format, lint, build, and test on every push / publish-github-container-registry (push) Has been cancelled
chore: close quality-gate coverage gaps (#1689) (#1766)
Closes #1689. Typecheck cli/tui src, add a core/ format+lint gate, and gate core/json + core/client coverage. See PR #1766 for the full review history.
2026-07-24 17:20:12 -04:00

103 lines
2.9 KiB
TypeScript

/**
* Draft state for the install-level client settings modal (client.json).
*
* Same controlled-modal pattern as {@link useSettingsDraft}: local draft,
* debounced persist, synchronous `flush` on close. Keyed on modal
* open/close (`opened`) rather than a server id because client config is
* install-level, not per-server.
*/
import { useCallback, useEffect, useRef, useState } from "react";
export interface UseClientSettingsDraftOptions<T> {
opened: boolean;
resolveInitial: () => T;
onPersist: (value: T) => Promise<void>;
onError: (err: unknown) => void;
debounceMs?: number;
}
export interface UseClientSettingsDraftResult<T> {
draft: T | null;
onChange: (next: T | ((prev: T) => T)) => void;
flush: () => void;
}
export function useClientSettingsDraft<T>({
opened,
resolveInitial,
onPersist,
onError,
debounceMs = 300,
}: UseClientSettingsDraftOptions<T>): UseClientSettingsDraftResult<T> {
const [draft, setDraft] = useState<T | null>(null);
const timerRef = useRef<ReturnType<typeof setTimeout> | undefined>(undefined);
const latestValuesRef = useRef<T | null>(null);
const resolveInitialRef = useRef(resolveInitial);
const onPersistRef = useRef(onPersist);
const onErrorRef = useRef(onError);
const openedRef = useRef(opened);
resolveInitialRef.current = resolveInitial;
onPersistRef.current = onPersist;
onErrorRef.current = onError;
openedRef.current = opened;
useEffect(() => {
if (!opened) {
setDraft(null);
latestValuesRef.current = null;
return;
}
const initial = resolveInitialRef.current();
setDraft(initial);
latestValuesRef.current = initial;
}, [opened]);
useEffect(() => {
return () => {
if (timerRef.current) {
clearTimeout(timerRef.current);
timerRef.current = undefined;
}
};
}, []);
const persist = useCallback((value: T) => {
onPersistRef.current(value).catch((err) => {
onErrorRef.current(err);
});
}, []);
const onChange = useCallback(
(next: T | ((prev: T) => T)) => {
if (!opened) return;
const prev = latestValuesRef.current;
if (prev === null) return;
const resolved =
typeof next === "function" ? (next as (prev: T) => T)(prev) : next;
latestValuesRef.current = resolved;
setDraft(resolved);
if (timerRef.current) clearTimeout(timerRef.current);
timerRef.current = setTimeout(() => {
timerRef.current = undefined;
const value = latestValuesRef.current;
if (value !== null) {
persist(value);
}
}, debounceMs);
},
[opened, debounceMs, persist],
);
const flush = useCallback(() => {
if (!timerRef.current) return;
clearTimeout(timerRef.current);
timerRef.current = undefined;
const value = latestValuesRef.current;
if (openedRef.current && value !== null) {
persist(value);
}
}, [persist]);
return { draft, onChange, flush };
}