freewind-ts-utils 0.18.2

package/react/hooks/useInputEvent/_internal/ink-input/parse-keypress.d.ts

@@ -0,0 +1,33 @@
+export const nonAlphanumericKeys: string[];
+export default parseKeypress;
+declare function parseKeypress(s?: string): {
+    eventType: string;
+    sequence: any;
+    raw: any;
+    isKittyProtocol: boolean;
+    isPrintable: boolean;
+    ctrl: boolean;
+    shift: boolean;
+    meta: boolean;
+    super: boolean;
+    hyper: boolean;
+    capsLock: boolean;
+    numLock: boolean;
+    name: any;
+} | {
+    name: string;
+    ctrl: boolean;
+    meta: boolean;
+    shift: boolean;
+    sequence: string;
+    raw: string;
+} | {
+    name: string;
+    ctrl: boolean;
+    meta: boolean;
+    shift: boolean;
+    sequence: string;
+    raw: string;
+    isKittyProtocol: boolean;
+    isPrintable: boolean;
+};

package/react/hooks/useInputEvent/_internal/ink-input/parse-keypress.js

@@ -0,0 +1,319 @@
+import { kittyModifiers as e } from "./kitty-keyboard.js";
+//#region src/react/hooks/useInputEvent/_internal/ink-input/parse-keypress.js
+var t = new TextDecoder(), n = /^(?:\x1b)([a-zA-Z0-9])$/, r = /^(?:\x1b+)(O|N|\[|\[\[)(?:(\d+)(?:;(\d+))?([~^$])|(?:1;)?(\d+)?([a-zA-Z]))/, i = {
+	OP: "f1",
+	OQ: "f2",
+	OR: "f3",
+	OS: "f4",
+	"[P": "f1",
+	"[Q": "f2",
+	"[R": "f3",
+	"[S": "f4",
+	"[11~": "f1",
+	"[12~": "f2",
+	"[13~": "f3",
+	"[14~": "f4",
+	"[[A": "f1",
+	"[[B": "f2",
+	"[[C": "f3",
+	"[[D": "f4",
+	"[[E": "f5",
+	"[15~": "f5",
+	"[17~": "f6",
+	"[18~": "f7",
+	"[19~": "f8",
+	"[20~": "f9",
+	"[21~": "f10",
+	"[23~": "f11",
+	"[24~": "f12",
+	"[A": "up",
+	"[B": "down",
+	"[C": "right",
+	"[D": "left",
+	"[E": "clear",
+	"[F": "end",
+	"[H": "home",
+	OA: "up",
+	OB: "down",
+	OC: "right",
+	OD: "left",
+	OE: "clear",
+	OF: "end",
+	OH: "home",
+	"[1~": "home",
+	"[2~": "insert",
+	"[3~": "delete",
+	"[4~": "end",
+	"[5~": "pageup",
+	"[6~": "pagedown",
+	"[[5~": "pageup",
+	"[[6~": "pagedown",
+	"[7~": "home",
+	"[8~": "end",
+	"[a": "up",
+	"[b": "down",
+	"[c": "right",
+	"[d": "left",
+	"[e": "clear",
+	"[2$": "insert",
+	"[3$": "delete",
+	"[5$": "pageup",
+	"[6$": "pagedown",
+	"[7$": "home",
+	"[8$": "end",
+	Oa: "up",
+	Ob: "down",
+	Oc: "right",
+	Od: "left",
+	Oe: "clear",
+	"[2^": "insert",
+	"[3^": "delete",
+	"[5^": "pageup",
+	"[6^": "pagedown",
+	"[7^": "home",
+	"[8^": "end",
+	"[Z": "tab"
+}, a = [...Object.values(i), "backspace"], o = (e) => [
+	"[a",
+	"[b",
+	"[c",
+	"[d",
+	"[e",
+	"[2$",
+	"[3$",
+	"[5$",
+	"[6$",
+	"[7$",
+	"[8$",
+	"[Z"
+].includes(e), s = (e) => [
+	"Oa",
+	"Ob",
+	"Oc",
+	"Od",
+	"Oe",
+	"[2^",
+	"[3^",
+	"[5^",
+	"[6^",
+	"[7^",
+	"[8^"
+].includes(e), c = /^\x1b\[(\d+)(?:;(\d+)(?::(\d+))?(?:;([\d:]+))?)?u$/, l = /^\x1b\[(\d+);(\d+):(\d+)([A-Za-z~])$/, u = {
+	A: "up",
+	B: "down",
+	C: "right",
+	D: "left",
+	E: "clear",
+	F: "end",
+	H: "home",
+	P: "f1",
+	Q: "f2",
+	R: "f3",
+	S: "f4"
+}, d = {
+	2: "insert",
+	3: "delete",
+	5: "pageup",
+	6: "pagedown",
+	7: "home",
+	8: "end",
+	11: "f1",
+	12: "f2",
+	13: "f3",
+	14: "f4",
+	15: "f5",
+	17: "f6",
+	18: "f7",
+	19: "f8",
+	20: "f9",
+	21: "f10",
+	23: "f11",
+	24: "f12"
+}, f = {
+	27: "escape",
+	9: "tab",
+	127: "backspace",
+	8: "backspace",
+	57358: "capslock",
+	57359: "scrolllock",
+	57360: "numlock",
+	57361: "printscreen",
+	57362: "pause",
+	57363: "menu",
+	57376: "f13",
+	57377: "f14",
+	57378: "f15",
+	57379: "f16",
+	57380: "f17",
+	57381: "f18",
+	57382: "f19",
+	57383: "f20",
+	57384: "f21",
+	57385: "f22",
+	57386: "f23",
+	57387: "f24",
+	57388: "f25",
+	57389: "f26",
+	57390: "f27",
+	57391: "f28",
+	57392: "f29",
+	57393: "f30",
+	57394: "f31",
+	57395: "f32",
+	57396: "f33",
+	57397: "f34",
+	57398: "f35",
+	57399: "kp0",
+	57400: "kp1",
+	57401: "kp2",
+	57402: "kp3",
+	57403: "kp4",
+	57404: "kp5",
+	57405: "kp6",
+	57406: "kp7",
+	57407: "kp8",
+	57408: "kp9",
+	57409: "kpdecimal",
+	57410: "kpdivide",
+	57411: "kpmultiply",
+	57412: "kpsubtract",
+	57413: "kpadd",
+	57414: "kpenter",
+	57415: "kpequal",
+	57416: "kpseparator",
+	57417: "kpleft",
+	57418: "kpright",
+	57419: "kpup",
+	57420: "kpdown",
+	57421: "kppageup",
+	57422: "kppagedown",
+	57423: "kphome",
+	57424: "kpend",
+	57425: "kpinsert",
+	57426: "kpdelete",
+	57427: "kpbegin",
+	57428: "mediaplay",
+	57429: "mediapause",
+	57430: "mediaplaypause",
+	57431: "mediareverse",
+	57432: "mediastop",
+	57433: "mediafastforward",
+	57434: "mediarewind",
+	57435: "mediatracknext",
+	57436: "mediatrackprevious",
+	57437: "mediarecord",
+	57438: "lowervolume",
+	57439: "raisevolume",
+	57440: "mutevolume",
+	57441: "leftshift",
+	57442: "leftcontrol",
+	57443: "leftalt",
+	57444: "leftsuper",
+	57445: "lefthyper",
+	57446: "leftmeta",
+	57447: "rightshift",
+	57448: "rightcontrol",
+	57449: "rightalt",
+	57450: "rightsuper",
+	57451: "righthyper",
+	57452: "rightmeta",
+	57453: "isoLevel3Shift",
+	57454: "isoLevel5Shift"
+}, p = (e) => e >= 0 && e <= 1114111 && !(e >= 55296 && e <= 57343), m = (e) => p(e) ? String.fromCodePoint(e) : "?";
+function h(e) {
+	return e === 3 ? "release" : e === 2 ? "repeat" : "press";
+}
+function g(t) {
+	return {
+		ctrl: !!(t & e.ctrl),
+		shift: !!(t & e.shift),
+		meta: !!(t & (e.meta | e.alt)),
+		super: !!(t & e.super),
+		hyper: !!(t & e.hyper),
+		capsLock: !!(t & e.capsLock),
+		numLock: !!(t & e.numLock)
+	};
+}
+var _ = (e) => {
+	let t = c.exec(e);
+	if (!t) return null;
+	let n = parseInt(t[1], 10), r = t[2] ? Math.max(0, parseInt(t[2], 10) - 1) : 0, i = t[3] ? parseInt(t[3], 10) : 1, a = t[4];
+	if (!p(n)) return null;
+	let o;
+	a && (o = a.split(":").map((e) => m(parseInt(e, 10))).join(""));
+	let s, l;
+	return n === 32 ? (s = "space", l = !0) : n === 13 ? (s = "return", l = !0) : f[n] ? (s = f[n], l = !1) : n >= 1 && n <= 26 ? (s = String.fromCodePoint(n + 96), l = !1) : (s = m(n).toLowerCase(), l = !0), l && !o && (o = m(n)), {
+		name: s,
+		...g(r),
+		eventType: h(i),
+		sequence: e,
+		raw: e,
+		isKittyProtocol: !0,
+		isPrintable: l,
+		text: o
+	};
+}, v = (e) => {
+	let t = l.exec(e);
+	if (!t) return null;
+	let n = parseInt(t[1], 10), r = Math.max(0, parseInt(t[2], 10) - 1), i = parseInt(t[3], 10), a = t[4], o = a === "~" ? d[n] : u[a];
+	return o ? {
+		name: o,
+		...g(r),
+		eventType: h(i),
+		sequence: e,
+		raw: e,
+		isKittyProtocol: !0,
+		isPrintable: !1
+	} : null;
+}, y = (e = "") => {
+	let a;
+	e instanceof Uint8Array ? e[0] > 127 && e[1] === void 0 ? (e[0] -= 128, e = "\x1B" + t.decode(e)) : e = t.decode(e) : e !== void 0 && typeof e != "string" ? e = String(e) : e ||= "";
+	let l = _(e);
+	if (l) return l;
+	let u = v(e);
+	if (u) return u;
+	if (c.test(e)) return {
+		name: "",
+		ctrl: !1,
+		meta: !1,
+		shift: !1,
+		sequence: e,
+		raw: e,
+		isKittyProtocol: !0,
+		isPrintable: !1
+	};
+	let d = {
+		name: "",
+		ctrl: !1,
+		meta: !1,
+		shift: !1,
+		sequence: e,
+		raw: e
+	};
+	if (d.sequence = d.sequence || e || d.name, e === "\r" || e === "\x1B\r") d.raw = void 0, d.name = "return", d.meta = e.length === 2;
+	else if (e === "\n") d.name = "enter";
+	else if (e === "	") d.name = "tab";
+	else if (e === "\b" || e === "\x1B\b") d.name = "backspace", d.meta = e.charAt(0) === "\x1B";
+	else if (e === "" || e === "\x1B") d.name = "backspace", d.meta = e.charAt(0) === "\x1B";
+	else if (e === "\x1B" || e === "\x1B\x1B") d.name = "escape", d.meta = e.length === 2;
+	else if (e === " " || e === "\x1B ") d.name = "space", d.meta = e.length === 2;
+	else if (e.length === 1 && e <= "") d.name = String.fromCharCode(e.charCodeAt(0) + 97 - 1), d.ctrl = !0;
+	else if (e.length === 1 && e >= "0" && e <= "9") d.name = "number";
+	else if (e.length === 1 && e >= "a" && e <= "z") d.name = e;
+	else if (e.length === 1 && e >= "A" && e <= "Z") d.name = e.toLowerCase(), d.shift = !0;
+	else if (a = n.exec(e)) d.name = a[1].toLowerCase(), d.meta = !0, d.shift = /^[A-Z]$/.test(a[1]);
+	else if (a = r.exec(e)) {
+		let t = [...e];
+		t[0] === "\x1B" && t[1] === "\x1B" && (d.meta = !0);
+		let n = [
+			a[1],
+			a[2],
+			a[4],
+			a[6]
+		].filter(Boolean).join(""), r = (a[3] || a[5] || 1) - 1;
+		d.ctrl = !!(r & 4), d.meta = d.meta || !!(r & 10), d.shift = !!(r & 1), d.code = n, d.name = i[n] ?? "", d.shift = o(n) || d.shift, d.ctrl = s(n) || d.ctrl;
+	}
+	return d;
+};
+//#endregion
+export { y as default, a as nonAlphanumericKeys };

package/react/hooks/useInputEvent/formatInputEvent.d.ts

@@ -0,0 +1,2 @@
+import { InputEvent } from './inputEventTypes.js';
+export declare const formatInputEvent: (event: InputEvent) => string;

package/react/hooks/useInputEvent/formatInputEvent.js

@@ -0,0 +1,25 @@
+//#region src/react/hooks/useInputEvent/formatInputEvent.ts
+var e = (e) => {
+	if (e.type === "text") return `text "${e.text}"`;
+	if (e.type === "paste") return `paste ${e.text.length} chars`;
+	if (e.type === "key") {
+		let t = [
+			e.modifiers.ctrl ? "ctrl" : "",
+			e.modifiers.shift ? "shift" : "",
+			e.modifiers.meta ? "meta" : "",
+			e.modifiers.super ? "super" : ""
+		].filter(Boolean).join("+"), n = t ? `${t}+` : "", r = e.text ? ` text=${JSON.stringify(e.text)}` : "";
+		return `key ${n}${e.name} (${e.action})${r}`;
+	}
+	if (e.type === "mouse") {
+		let t = [
+			e.modifiers.ctrl ? "ctrl" : "",
+			e.modifiers.shift ? "shift" : "",
+			e.modifiers.meta ? "meta" : ""
+		].filter(Boolean).join("+");
+		return `mouse ${t ? `${t}+` : ""}${e.button} ${e.action} @ ${e.column},${e.row}`;
+	}
+	return e.type === "focus" ? e.focused ? "focus in" : "focus out" : `unknown ${JSON.stringify(e.raw)}`;
+};
+//#endregion
+export { e as formatInputEvent };

package/react/hooks/useInputEvent/index.d.ts

@@ -0,0 +1,4 @@
+export { useInputEvent } from './useInputEvent.js';
+export type { InputEvent, UseInputEventOptions } from './inputEventTypes.js';
+export { formatInputEvent } from './formatInputEvent.js';
+export { parserItemToInputEvent } from './parseInputEvent.js';

package/react/hooks/useInputEvent/index.js

@@ -0,0 +1,4 @@
+import { formatInputEvent as e } from "./formatInputEvent.js";
+import { parserItemToInputEvent as t } from "./parseInputEvent.js";
+import { useInputEvent as n } from "./useInputEvent.js";
+export { e as formatInputEvent, t as parserItemToInputEvent, n as useInputEvent };

package/react/hooks/useInputEvent/inputEventTypes.d.ts

@@ -0,0 +1,51 @@
+export type InputEventModifiers = {
+    ctrl: boolean;
+    shift: boolean;
+    meta: boolean;
+    super: boolean;
+    hyper: boolean;
+    capsLock: boolean;
+    numLock: boolean;
+};
+export type KeyAction = "press" | "repeat" | "release";
+export type MouseButton = "left" | "middle" | "right" | "wheel-up" | "wheel-down" | "wheel-left" | "wheel-right" | "move";
+export type TextInputEvent = {
+    type: "text";
+    text: string;
+};
+export type KeyInputEvent = {
+    type: "key";
+    name: string;
+    text: string;
+    modifiers: InputEventModifiers;
+    action: KeyAction;
+    raw: string;
+};
+export type PasteInputEvent = {
+    type: "paste";
+    text: string;
+};
+export type MouseInputEvent = {
+    type: "mouse";
+    button: MouseButton;
+    column: number;
+    row: number;
+    action: "press" | "release" | "move";
+    modifiers: Pick<InputEventModifiers, "ctrl" | "shift" | "meta">;
+    raw: string;
+};
+export type FocusInputEvent = {
+    type: "focus";
+    focused: boolean;
+    raw: string;
+};
+export type UnknownInputEvent = {
+    type: "unknown";
+    raw: string;
+};
+export type InputEvent = TextInputEvent | KeyInputEvent | PasteInputEvent | MouseInputEvent | FocusInputEvent | UnknownInputEvent;
+export type UseInputEventOptions = {
+    isActive?: boolean;
+    enableMouse?: boolean;
+    enableFocus?: boolean;
+};

package/react/hooks/useInputEvent/parseInputEvent.d.ts

@@ -0,0 +1,4 @@
+import { InputEvent } from './inputEventTypes.js';
+export declare const parserItemToInputEvent: (item: string | {
+    paste: string;
+}) => InputEvent | undefined;

package/react/hooks/useInputEvent/parseInputEvent.js

@@ -0,0 +1,100 @@
+import e, { nonAlphanumericKeys as t } from "./_internal/ink-input/parse-keypress.js";
+import "./_internal/ink-input/index.js";
+//#region src/react/hooks/useInputEvent/parseInputEvent.ts
+var n = "\x1B[I", r = "\x1B[O", i = /^\u001B\[<(\d+);(\d+);(\d+)([mM])$/, a = [/^\u001B\[\?\d+u$/, /^\u001B\[>\d+;(?:\d+;)?\d+c$/], o = (e) => a.some((t) => t.test(e)), s = (e) => {
+	if (e.isKittyProtocol) return e.isPrintable ? e.text ?? e.name : e.ctrl && e.name.length === 1 ? e.name : "";
+	if (e.ctrl) return e.name ?? "";
+	let n = e.sequence;
+	return t.includes(e.name) && (n = ""), n.startsWith("\x1B") && (n = n.slice(1)), n;
+}, c = (e, t) => {
+	if (e === 35) return {
+		button: "move",
+		action: "move"
+	};
+	if (e === 64) return {
+		button: "wheel-up",
+		action: "press"
+	};
+	if (e === 65) return {
+		button: "wheel-down",
+		action: "press"
+	};
+	if (e === 66) return {
+		button: "wheel-left",
+		action: "press"
+	};
+	if (e === 67) return {
+		button: "wheel-right",
+		action: "press"
+	};
+	let n = e & 3, r = [
+		"left",
+		"middle",
+		"right"
+	];
+	return e >= 32 && e <= 34 ? {
+		button: r[n] ?? "left",
+		action: "move"
+	} : {
+		button: r[n] ?? "left",
+		action: t
+	};
+}, l = (e) => {
+	let t = i.exec(e);
+	if (!t) return;
+	let n = Number(t[1]), r = Number(t[2]), a = Number(t[3]), { button: o, action: s } = c(n, t[4] === "M" ? "press" : "release");
+	return {
+		type: "mouse",
+		button: o,
+		column: r,
+		row: a,
+		action: s,
+		modifiers: {
+			shift: !!(n & 4),
+			meta: !!(n & 8),
+			ctrl: !!(n & 16)
+		},
+		raw: e
+	};
+}, u = (e) => {
+	if (e === n) return {
+		type: "focus",
+		focused: !0,
+		raw: e
+	};
+	if (e === r) return {
+		type: "focus",
+		focused: !1,
+		raw: e
+	};
+}, d = (t) => {
+	if (t.length > 1 && !t.startsWith("\x1B")) return {
+		type: "text",
+		text: t
+	};
+	let n = e(t), r = n.eventType ?? "press";
+	return !n.name && n.isKittyProtocol || !n.name && t.startsWith("\x1B") ? {
+		type: "unknown",
+		raw: t
+	} : {
+		type: "key",
+		name: n.name || "unknown",
+		text: s(n),
+		modifiers: {
+			ctrl: n.ctrl,
+			shift: n.shift,
+			meta: n.meta,
+			super: n.super ?? !1,
+			hyper: n.hyper ?? !1,
+			capsLock: n.capsLock ?? !1,
+			numLock: n.numLock ?? !1
+		},
+		action: r,
+		raw: t
+	};
+}, f = (e) => typeof e == "string" ? o(e) ? void 0 : l(e) || u(e) || d(e) : {
+	type: "paste",
+	text: e.paste
+};
+//#endregion
+export { f as parserItemToInputEvent };

package/react/hooks/useInputEvent/useInputEvent.d.ts

@@ -0,0 +1,7 @@
+import { InputEvent, UseInputEventOptions } from './inputEventTypes.js';
+type UseInputEventHandler = (event: InputEvent) => void;
+type UseInputEventResult = {
+    lastEvent: InputEvent | undefined;
+};
+export declare function useInputEvent(handler: UseInputEventHandler, options?: UseInputEventOptions): UseInputEventResult;
+export {};

package/react/hooks/useInputEvent/useInputEvent.js

@@ -0,0 +1,57 @@
+import { createInputParser as e } from "./_internal/ink-input/input-parser.js";
+import "./_internal/ink-input/index.js";
+import { parserItemToInputEvent as t } from "./parseInputEvent.js";
+import { useEffect as n, useRef as r, useState as i } from "react";
+import { useStdin as a, useStdout as o } from "ink";
+//#region src/react/hooks/useInputEvent/useInputEvent.ts
+var s = 20, c = "\x1B[?1000h\x1B[?1002h\x1B[?1006h", l = "\x1B[?1000l\x1B[?1002l\x1B[?1006l", u = "\x1B[?1004h", d = "\x1B[?1004l", f = "\x1B[?2004h", p = "\x1B[?2004l";
+function m(m, h = {}) {
+	let { isActive: g = !0, enableMouse: _ = !0, enableFocus: v = !0 } = h, { stdin: y, setRawMode: b, isRawModeSupported: x } = a(), { stdout: S } = o(), [C, w] = i(void 0), T = r(m);
+	return T.current = m, n(() => {
+		if (g) return _ && S.write(c), v && S.write(u), S.write(f), () => {
+			_ && S.write(l), v && S.write(d), S.write(p);
+		};
+	}, [
+		S,
+		g,
+		_,
+		v
+	]), n(() => {
+		if (!(!g || !x)) return b(!0), y.setEncoding("utf8"), () => {
+			b(!1);
+		};
+	}, [
+		g,
+		x,
+		b,
+		y
+	]), n(() => {
+		if (!g || !x) return;
+		let n = e(), r, i = (e) => {
+			let n = t(e);
+			n && (w(n), T.current(n));
+		}, a = () => {
+			r !== void 0 && (clearTimeout(r), r = void 0);
+		}, o = () => {
+			a(), r = setTimeout(() => {
+				r = void 0;
+				let e = n.flushPendingEscape();
+				e && i(e);
+			}, s);
+		}, c = (e) => {
+			a();
+			let t = Buffer.isBuffer(e) ? e.toString("utf8") : e;
+			for (let e of n.push(t)) i(e);
+			n.hasPendingEscape() && o();
+		};
+		return y.on("data", c), () => {
+			a(), y.off("data", c), n.reset();
+		};
+	}, [
+		y,
+		g,
+		x
+	]), { lastEvent: C };
+}
+//#endregion
+export { m as useInputEvent };

package/react/hooks/useOverlayStack/_internal/overlayStackId.d.ts

@@ -0,0 +1,2 @@
+export declare const nextOverlayStackId: () => string;
+export declare const resetOverlayStackIdsForTest: () => void;

package/react/hooks/useOverlayStack/_internal/overlayStackId.js

@@ -0,0 +1,6 @@
+//#region src/react/hooks/useOverlayStack/_internal/overlayStackId.ts
+var e = 0, t = () => `overlay-${++e}`, n = () => {
+	e = 0;
+};
+//#endregion
+export { t as nextOverlayStackId, n as resetOverlayStackIdsForTest };

package/react/hooks/useOverlayStack/createOverlayStackItem.d.ts

@@ -0,0 +1,2 @@
+import { OverlayStackItem } from './overlayStackTypes.js';
+export declare const createOverlayStackItem: <TData = undefined>(label: string, depth: number, data?: TData) => OverlayStackItem<TData>;

package/react/hooks/useOverlayStack/createOverlayStackItem.js

@@ -0,0 +1,10 @@
+import { nextOverlayStackId as e } from "./_internal/overlayStackId.js";
+//#region src/react/hooks/useOverlayStack/createOverlayStackItem.ts
+var t = (t, n, r) => ({
+	id: e(),
+	label: t,
+	depth: n,
+	data: r
+});
+//#endregion
+export { t as createOverlayStackItem };

package/react/hooks/useOverlayStack/index.d.ts

@@ -0,0 +1,3 @@
+export { useOverlayStack } from './useOverlayStack.js';
+export { createOverlayStackItem } from './createOverlayStackItem.js';
+export type { OverlayStackItem, UseOverlayStackResult } from './overlayStackTypes.js';

package/react/hooks/useOverlayStack/index.js

@@ -0,0 +1,3 @@
+import { createOverlayStackItem as e } from "./createOverlayStackItem.js";
+import { useOverlayStack as t } from "./useOverlayStack.js";
+export { e as createOverlayStackItem, t as useOverlayStack };

package/react/hooks/useOverlayStack/overlayStackTypes.d.ts

@@ -0,0 +1,13 @@
+export type OverlayStackItem<TData = undefined> = {
+    id: string;
+    label: string;
+    depth: number;
+    data: TData;
+};
+export type UseOverlayStackResult<TData = undefined> = {
+    stack: OverlayStackItem<TData>[];
+    top: OverlayStackItem<TData> | undefined;
+    push: (label: string, data?: TData) => void;
+    pop: () => void;
+    update: (id: string, patch: Partial<Pick<OverlayStackItem<TData>, "label" | "data">>) => void;
+};

package/react/hooks/useOverlayStack/useOverlayStack.d.ts

@@ -0,0 +1,2 @@
+import { UseOverlayStackResult } from './overlayStackTypes.js';
+export declare const useOverlayStack: <TData = undefined>() => UseOverlayStackResult<TData>;