@tooee/overlays 0.1.0

package/README.md

@@ -0,0 +1,5 @@
+# @tooee/overlays
+
+Overlay stack management for Tooee.
+
+Part of the [Tooee](https://github.com/gingerhendrix/tooee) monorepo. See the main repo for documentation.

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { OverlayContext, OverlayControllerContext, OverlayStateContext, useOverlay, useOverlayState, useCurrentOverlay, useHasOverlay, } from "./overlay-context.jsx";
+export type { OverlayContextValue, OverlayId, OverlayCloseReason, OverlayOpenOptions, OverlayRenderArgs, OverlayRenderer, OverlayHandle, OverlayController, OverlayState, } from "./overlay-context.jsx";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,wBAAwB,EACxB,mBAAmB,EACnB,UAAU,EACV,eAAe,EACf,iBAAiB,EACjB,aAAa,GACd,MAAM,uBAAuB,CAAA;AAC9B,YAAY,EACV,mBAAmB,EACnB,SAAS,EACT,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,eAAe,EACf,aAAa,EACb,iBAAiB,EACjB,YAAY,GACb,MAAM,uBAAuB,CAAA"}

package/dist/index.js

@@ -0,0 +1,2 @@
+export { OverlayContext, OverlayControllerContext, OverlayStateContext, useOverlay, useOverlayState, useCurrentOverlay, useHasOverlay, } from "./overlay-context.jsx";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,wBAAwB,EACxB,mBAAmB,EACnB,UAAU,EACV,eAAe,EACf,iBAAiB,EACjB,aAAa,GACd,MAAM,uBAAuB,CAAA"}

package/dist/overlay-context.d.ts

@@ -0,0 +1,54 @@
+import type { ReactNode } from "react";
+export type OverlayId = string;
+export type OverlayCloseReason = "close" | "escape" | "replaced" | "unmounted";
+export interface OverlayOpenOptions {
+    /** Mode to set while overlay is active (default: "insert"). null = don't change mode. */
+    mode?: string | null;
+    /** Restore previous mode on close (default: true) */
+    restoreMode?: boolean;
+    /** Allow Escape to close this overlay (default: true) */
+    dismissOnEscape?: boolean;
+    /** Lifecycle callback */
+    onClose?: (reason: OverlayCloseReason) => void;
+}
+export interface OverlayRenderArgs<TPayload> {
+    id: OverlayId;
+    payload: TPayload;
+    isTop: boolean;
+    close: (reason?: OverlayCloseReason) => void;
+    update: (next: TPayload | ((prev: TPayload) => TPayload)) => void;
+}
+export type OverlayRenderer<TPayload> = (args: OverlayRenderArgs<TPayload>) => ReactNode;
+export interface OverlayHandle<TPayload> {
+    id: OverlayId;
+    close: (reason?: OverlayCloseReason) => void;
+    update: (next: TPayload | ((prev: TPayload) => TPayload)) => void;
+}
+export interface OverlayController {
+    open<TPayload>(id: OverlayId, render: OverlayRenderer<TPayload>, payload: TPayload, options?: OverlayOpenOptions): OverlayHandle<TPayload>;
+    update<TPayload>(id: OverlayId, next: TPayload | ((prev: TPayload) => TPayload)): void;
+    show(id: OverlayId, content: ReactNode, options?: OverlayOpenOptions): void;
+    hide(id: OverlayId): void;
+    closeTop(reason?: OverlayCloseReason): void;
+    isOpen(id: OverlayId): boolean;
+    topId: OverlayId | null;
+}
+export interface OverlayState {
+    current: ReactNode | null;
+    hasOverlay: boolean;
+    stack: OverlayId[];
+}
+export interface OverlayContextValue {
+    show: (id: string, content: ReactNode, options?: OverlayOpenOptions) => void;
+    hide: (id: string) => void;
+    current: ReactNode | null;
+    hasOverlay: boolean;
+}
+export declare const OverlayControllerContext: import("react").Context<OverlayController>;
+export declare const OverlayStateContext: import("react").Context<OverlayState>;
+export declare const OverlayContext: import("react").Context<OverlayContextValue>;
+export declare function useOverlay(): OverlayController;
+export declare function useOverlayState(): OverlayState;
+export declare function useHasOverlay(): boolean;
+export declare function useCurrentOverlay(): ReactNode | null;
+//# sourceMappingURL=overlay-context.d.ts.map

package/dist/overlay-context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"overlay-context.d.ts","sourceRoot":"","sources":["../src/overlay-context.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAItC,MAAM,MAAM,SAAS,GAAG,MAAM,CAAA;AAE9B,MAAM,MAAM,kBAAkB,GAAG,OAAO,GAAG,QAAQ,GAAG,UAAU,GAAG,WAAW,CAAA;AAE9E,MAAM,WAAW,kBAAkB;IACjC,yFAAyF;IACzF,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,qDAAqD;IACrD,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,yDAAyD;IACzD,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,yBAAyB;IACzB,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,kBAAkB,KAAK,IAAI,CAAA;CAC/C;AAED,MAAM,WAAW,iBAAiB,CAAC,QAAQ;IACzC,EAAE,EAAE,SAAS,CAAA;IACb,OAAO,EAAE,QAAQ,CAAA;IACjB,KAAK,EAAE,OAAO,CAAA;IACd,KAAK,EAAE,CAAC,MAAM,CAAC,EAAE,kBAAkB,KAAK,IAAI,CAAA;IAC5C,MAAM,EAAE,CAAC,IAAI,EAAE,QAAQ,GAAG,CAAC,CAAC,IAAI,EAAE,QAAQ,KAAK,QAAQ,CAAC,KAAK,IAAI,CAAA;CAClE;AAED,MAAM,MAAM,eAAe,CAAC,QAAQ,IAAI,CAAC,IAAI,EAAE,iBAAiB,CAAC,QAAQ,CAAC,KAAK,SAAS,CAAA;AAExF,MAAM,WAAW,aAAa,CAAC,QAAQ;IACrC,EAAE,EAAE,SAAS,CAAA;IACb,KAAK,EAAE,CAAC,MAAM,CAAC,EAAE,kBAAkB,KAAK,IAAI,CAAA;IAC5C,MAAM,EAAE,CAAC,IAAI,EAAE,QAAQ,GAAG,CAAC,CAAC,IAAI,EAAE,QAAQ,KAAK,QAAQ,CAAC,KAAK,IAAI,CAAA;CAClE;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,CAAC,QAAQ,EACX,EAAE,EAAE,SAAS,EACb,MAAM,EAAE,eAAe,CAAC,QAAQ,CAAC,EACjC,OAAO,EAAE,QAAQ,EACjB,OAAO,CAAC,EAAE,kBAAkB,GAC3B,aAAa,CAAC,QAAQ,CAAC,CAAA;IAC1B,MAAM,CAAC,QAAQ,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,GAAG,CAAC,CAAC,IAAI,EAAE,QAAQ,KAAK,QAAQ,CAAC,GAAG,IAAI,CAAA;IACtF,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAA;IAC3E,IAAI,CAAC,EAAE,EAAE,SAAS,GAAG,IAAI,CAAA;IACzB,QAAQ,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAA;IAC3C,MAAM,CAAC,EAAE,EAAE,SAAS,GAAG,OAAO,CAAA;IAC9B,KAAK,EAAE,SAAS,GAAG,IAAI,CAAA;CACxB;AAED,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,SAAS,GAAG,IAAI,CAAA;IACzB,UAAU,EAAE,OAAO,CAAA;IACnB,KAAK,EAAE,SAAS,EAAE,CAAA;CACnB;AAGD,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,kBAAkB,KAAK,IAAI,CAAA;IAC5E,IAAI,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAA;IAC1B,OAAO,EAAE,SAAS,GAAG,IAAI,CAAA;IACzB,UAAU,EAAE,OAAO,CAAA;CACpB;AAoBD,eAAO,MAAM,wBAAwB,4CAAsD,CAAA;AAC3F,eAAO,MAAM,mBAAmB,uCAA4C,CAAA;AAG5E,eAAO,MAAM,cAAc,8CAKzB,CAAA;AAIF,wBAAgB,UAAU,IAAI,iBAAiB,CAE9C;AAED,wBAAgB,eAAe,IAAI,YAAY,CAE9C;AAED,wBAAgB,aAAa,IAAI,OAAO,CAEvC;AAED,wBAAgB,iBAAiB,IAAI,SAAS,GAAG,IAAI,CAEpD"}

package/dist/overlay-context.js

@@ -0,0 +1,39 @@
+import { createContext, useContext } from "react";
+// Contexts
+const defaultController = {
+    open: (id) => ({ id, close: () => { }, update: () => { } }),
+    update: () => { },
+    show: () => { },
+    hide: () => { },
+    closeTop: () => { },
+    isOpen: () => false,
+    topId: null,
+};
+const defaultState = {
+    current: null,
+    hasOverlay: false,
+    stack: [],
+};
+export const OverlayControllerContext = createContext(defaultController);
+export const OverlayStateContext = createContext(defaultState);
+// Back-compat: OverlayContext that combines both (for existing provider consumers)
+export const OverlayContext = createContext({
+    show: () => { },
+    hide: () => { },
+    current: null,
+    hasOverlay: false,
+});
+// Hooks
+export function useOverlay() {
+    return useContext(OverlayControllerContext);
+}
+export function useOverlayState() {
+    return useContext(OverlayStateContext);
+}
+export function useHasOverlay() {
+    return useContext(OverlayStateContext).hasOverlay;
+}
+export function useCurrentOverlay() {
+    return useContext(OverlayStateContext).current;
+}
+//# sourceMappingURL=overlay-context.js.map

package/dist/overlay-context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"overlay-context.js","sourceRoot":"","sources":["../src/overlay-context.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,OAAO,CAAA;AAiEjD,WAAW;AAEX,MAAM,iBAAiB,GAAsB;IAC3C,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,GAAE,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,GAAE,CAAC,EAAE,CAAC;IACzD,MAAM,EAAE,GAAG,EAAE,GAAE,CAAC;IAChB,IAAI,EAAE,GAAG,EAAE,GAAE,CAAC;IACd,IAAI,EAAE,GAAG,EAAE,GAAE,CAAC;IACd,QAAQ,EAAE,GAAG,EAAE,GAAE,CAAC;IAClB,MAAM,EAAE,GAAG,EAAE,CAAC,KAAK;IACnB,KAAK,EAAE,IAAI;CACZ,CAAA;AAED,MAAM,YAAY,GAAiB;IACjC,OAAO,EAAE,IAAI;IACb,UAAU,EAAE,KAAK;IACjB,KAAK,EAAE,EAAE;CACV,CAAA;AAED,MAAM,CAAC,MAAM,wBAAwB,GAAG,aAAa,CAAoB,iBAAiB,CAAC,CAAA;AAC3F,MAAM,CAAC,MAAM,mBAAmB,GAAG,aAAa,CAAe,YAAY,CAAC,CAAA;AAE5E,mFAAmF;AACnF,MAAM,CAAC,MAAM,cAAc,GAAG,aAAa,CAAsB;IAC/D,IAAI,EAAE,GAAG,EAAE,GAAE,CAAC;IACd,IAAI,EAAE,GAAG,EAAE,GAAE,CAAC;IACd,OAAO,EAAE,IAAI;IACb,UAAU,EAAE,KAAK;CAClB,CAAC,CAAA;AAEF,QAAQ;AAER,MAAM,UAAU,UAAU;IACxB,OAAO,UAAU,CAAC,wBAAwB,CAAC,CAAA;AAC7C,CAAC;AAED,MAAM,UAAU,eAAe;IAC7B,OAAO,UAAU,CAAC,mBAAmB,CAAC,CAAA;AACxC,CAAC;AAED,MAAM,UAAU,aAAa;IAC3B,OAAO,UAAU,CAAC,mBAAmB,CAAC,CAAC,UAAU,CAAA;AACnD,CAAC;AAED,MAAM,UAAU,iBAAiB;IAC/B,OAAO,UAAU,CAAC,mBAAmB,CAAC,CAAC,OAAO,CAAA;AAChD,CAAC"}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@tooee/overlays",
+  "version": "0.1.0",
+  "description": "Overlay stack management for Tooee",
+  "license": "MIT",
+  "author": "Gareth Andrew",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/gingerhendrix/tooee.git",
+    "directory": "packages/overlays"
+  },
+  "homepage": "https://github.com/gingerhendrix/tooee",
+  "bugs": "https://github.com/gingerhendrix/tooee/issues",
+  "keywords": ["tui", "terminal", "cli", "opentui"],
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "@tooee/source": "./src/index.ts",
+        "default": "./dist/index.js"
+      }
+    }
+  },
+  "files": ["dist", "src"],
+  "scripts": {
+    "typecheck": "tsc --noEmit"
+  },
+  "devDependencies": {
+    "@types/bun": "^1.3.5",
+    "@types/react": "^19.1.10",
+    "typescript": "^5.8.3"
+  },
+  "peerDependencies": {
+    "react": "^18.0.0 || ^19.0.0"
+  }
+}

package/src/index.ts

@@ -0,0 +1,20 @@
+export {
+  OverlayContext,
+  OverlayControllerContext,
+  OverlayStateContext,
+  useOverlay,
+  useOverlayState,
+  useCurrentOverlay,
+  useHasOverlay,
+} from "./overlay-context.jsx"
+export type {
+  OverlayContextValue,
+  OverlayId,
+  OverlayCloseReason,
+  OverlayOpenOptions,
+  OverlayRenderArgs,
+  OverlayRenderer,
+  OverlayHandle,
+  OverlayController,
+  OverlayState,
+} from "./overlay-context.jsx"

package/src/overlay-context.tsx

@@ -0,0 +1,111 @@
+import { createContext, useContext } from "react"
+import type { ReactNode } from "react"
+
+// Types
+
+export type OverlayId = string
+
+export type OverlayCloseReason = "close" | "escape" | "replaced" | "unmounted"
+
+export interface OverlayOpenOptions {
+  /** Mode to set while overlay is active (default: "insert"). null = don't change mode. */
+  mode?: string | null
+  /** Restore previous mode on close (default: true) */
+  restoreMode?: boolean
+  /** Allow Escape to close this overlay (default: true) */
+  dismissOnEscape?: boolean
+  /** Lifecycle callback */
+  onClose?: (reason: OverlayCloseReason) => void
+}
+
+export interface OverlayRenderArgs<TPayload> {
+  id: OverlayId
+  payload: TPayload
+  isTop: boolean
+  close: (reason?: OverlayCloseReason) => void
+  update: (next: TPayload | ((prev: TPayload) => TPayload)) => void
+}
+
+export type OverlayRenderer<TPayload> = (args: OverlayRenderArgs<TPayload>) => ReactNode
+
+export interface OverlayHandle<TPayload> {
+  id: OverlayId
+  close: (reason?: OverlayCloseReason) => void
+  update: (next: TPayload | ((prev: TPayload) => TPayload)) => void
+}
+
+export interface OverlayController {
+  open<TPayload>(
+    id: OverlayId,
+    render: OverlayRenderer<TPayload>,
+    payload: TPayload,
+    options?: OverlayOpenOptions,
+  ): OverlayHandle<TPayload>
+  update<TPayload>(id: OverlayId, next: TPayload | ((prev: TPayload) => TPayload)): void
+  show(id: OverlayId, content: ReactNode, options?: OverlayOpenOptions): void
+  hide(id: OverlayId): void
+  closeTop(reason?: OverlayCloseReason): void
+  isOpen(id: OverlayId): boolean
+  topId: OverlayId | null
+}
+
+export interface OverlayState {
+  current: ReactNode | null
+  hasOverlay: boolean
+  stack: OverlayId[]
+}
+
+// Back-compat type (still exported for existing consumers)
+export interface OverlayContextValue {
+  show: (id: string, content: ReactNode, options?: OverlayOpenOptions) => void
+  hide: (id: string) => void
+  current: ReactNode | null
+  hasOverlay: boolean
+}
+
+// Contexts
+
+const defaultController: OverlayController = {
+  open: (id) => ({ id, close: () => {}, update: () => {} }),
+  update: () => {},
+  show: () => {},
+  hide: () => {},
+  closeTop: () => {},
+  isOpen: () => false,
+  topId: null,
+}
+
+const defaultState: OverlayState = {
+  current: null,
+  hasOverlay: false,
+  stack: [],
+}
+
+export const OverlayControllerContext = createContext<OverlayController>(defaultController)
+export const OverlayStateContext = createContext<OverlayState>(defaultState)
+
+// Back-compat: OverlayContext that combines both (for existing provider consumers)
+export const OverlayContext = createContext<OverlayContextValue>({
+  show: () => {},
+  hide: () => {},
+  current: null,
+  hasOverlay: false,
+})
+
+// Hooks
+
+export function useOverlay(): OverlayController {
+  return useContext(OverlayControllerContext)
+}
+
+export function useOverlayState(): OverlayState {
+  return useContext(OverlayStateContext)
+}
+
+export function useHasOverlay(): boolean {
+  return useContext(OverlayStateContext).hasOverlay
+}
+
+export function useCurrentOverlay(): ReactNode | null {
+  return useContext(OverlayStateContext).current
+}