@pstdio/ui 0.15.0 → 0.16.0

package/dist/components/terminal/terminal-contract.d.ts

@@ -0,0 +1,22 @@
+export interface TerminalSessionRequest {
+    /** Command + args to run; defaults to the user's login shell when omitted. */
+    command?: string[];
+    /** Working directory; falls back to the extension's workspace root. */
+    cwd?: string;
+    /** Extra env vars merged over the inherited environment. */
+    env?: Record<string, string>;
+    /** Initial column count; the renderer can resize later. */
+    cols: number;
+    /** Initial row count; the renderer can resize later. */
+    rows: number;
+}
+export type TerminalHostEvent = {
+    sessionId: string;
+    kind: "data";
+    chunk: Uint8Array;
+} | {
+    sessionId: string;
+    kind: "exit";
+    code: number | null;
+    signal: string | null;
+};

package/dist/components/terminal/terminal-theme.d.ts

@@ -0,0 +1,12 @@
+import { ITheme } from '@xterm/xterm';
+/**
+ * xterm theme presets aligned with the workbench `bg.inverted` / `fg.inverted`
+ * pairings so the terminal blends with the surrounding chrome without the
+ * consuming extension touching xterm directly. Consumers can still pass any
+ * `ITheme` they like via the `theme` prop.
+ */
+export type TerminalThemeName = "light" | "dark";
+export declare const lightTerminalTheme: ITheme;
+export declare const darkTerminalTheme: ITheme;
+export declare const terminalThemes: Record<TerminalThemeName, ITheme>;
+export declare const resolveTerminalTheme: (theme: TerminalThemeName | ITheme | undefined) => ITheme;

package/dist/components/terminal/terminal.d.ts

@@ -0,0 +1,45 @@
+import { ITheme, Terminal as Xterm } from '@xterm/xterm';
+import { TerminalSink } from './bind-session';
+import { TerminalThemeName } from './terminal-theme';
+import { TerminalBridge, TerminalSessionAdapter, TerminalSessionRequest } from './types';
+export declare const createInitialTerminalSessionRequest: (request?: Partial<TerminalSessionRequest>) => TerminalSessionRequest;
+export declare const resizeSessionToTerminalGeometry: (terminal: Pick<Xterm, "cols" | "rows">, session: Pick<TerminalSessionAdapter, "resize">) => void;
+export declare const bindTerminalSession: (terminal: Pick<Xterm, "cols" | "rows">, sink: TerminalSink, session: TerminalSessionAdapter, options: Pick<TerminalProps, "onSessionOpen" | "onSessionExit">) => () => void;
+export interface TerminalSessionCallbackRefs {
+    onSessionOpen: React.RefObject<TerminalProps["onSessionOpen"]>;
+    onSessionExit: React.RefObject<TerminalProps["onSessionExit"]>;
+}
+export declare const bindTerminalSessionWithCallbackRefs: (terminal: Pick<Xterm, "cols" | "rows">, sink: TerminalSink, session: TerminalSessionAdapter, callbackRefs: TerminalSessionCallbackRefs) => () => void;
+export interface TerminalProps {
+    /** Bridge adapter the component opens its session through. */
+    bridge: TerminalBridge;
+    /**
+     * Optional initial session request overrides. `cols`/`rows` default to
+     * 80x24; container resizes are forwarded after the session opens.
+     */
+    request?: Partial<TerminalSessionRequest>;
+    /** Theme preset name or full xterm theme. */
+    theme?: TerminalThemeName | ITheme;
+    /** Monospace font family. */
+    fontFamily?: string;
+    fontSize?: number;
+    /** Whether to kill the session when the component unmounts. Defaults to true. */
+    killOnUnmount?: boolean;
+    /** Forwarded to the container element. */
+    className?: string;
+    style?: React.CSSProperties;
+    /** Called once the session is open; useful for imperative refs. */
+    onSessionOpen?: (sessionId: string) => void;
+    /** Called once the session exits. */
+    onSessionExit?: (exit: {
+        code: number | null;
+        signal: string | null;
+    }) => void;
+}
+/**
+ * High-level terminal component. Mounts xterm.js inside a `<div>` and binds it
+ * to the session opened from `bridge.openSession(...)`. Resize is driven by
+ * `ResizeObserver` so the terminal fills its container and the host PTY
+ * geometry stays in sync.
+ */
+export declare const Terminal: (props: TerminalProps) => import("react/jsx-runtime").JSX.Element;

package/dist/components/terminal/types.d.ts

@@ -0,0 +1,35 @@
+import { TerminalHostEvent, TerminalSessionRequest } from './terminal-contract';
+export type { TerminalSessionRequest } from './terminal-contract';
+/**
+ * Renderer-side projection of a single terminal session over the
+ * `terminal.session` bridge.
+ *
+ * The host-side `TerminalSessionHandle` exposes a single-consumer async
+ * iterable; that contract is impractical inside React, so the renderer side
+ * uses observable subscriptions instead. Implementations (real bridge,
+ * scripted stub, etc.) are responsible for translating their own transport
+ * into these callbacks.
+ */
+export interface TerminalSessionAdapter {
+    readonly id: string;
+    write(data: string | Uint8Array): void;
+    resize(cols: number, rows: number): void;
+    kill(signal?: string): Promise<void> | void;
+    onData(handler: (chunk: Uint8Array) => void): () => void;
+    onExit(handler: (exit: TerminalSessionExit) => void): () => void;
+    onError(handler: (error: TerminalSessionError) => void): () => void;
+}
+export type TerminalSessionExit = Omit<Extract<TerminalHostEvent, {
+    kind: "exit";
+}>, "kind" | "sessionId">;
+export interface TerminalSessionError {
+    message: string;
+}
+/**
+ * Renderer-side projection of the `terminal.session` capability. A bridge
+ * adapter typically wraps the webview transport, but stubs that drive
+ * scripted output (storybook, tests) implement the same shape.
+ */
+export interface TerminalBridge {
+    openSession(request: TerminalSessionRequest): Promise<TerminalSessionAdapter>;
+}

package/dist/components/terminal/use-terminal-session.d.ts

@@ -0,0 +1,21 @@
+import { TerminalBridge, TerminalSessionAdapter, TerminalSessionError, TerminalSessionExit, TerminalSessionRequest } from './types';
+export type TerminalSessionStatus = "idle" | "opening" | "open" | "exited" | "error";
+export interface UseTerminalSessionResult {
+    session: TerminalSessionAdapter | null;
+    status: TerminalSessionStatus;
+    exit: TerminalSessionExit | null;
+    error: TerminalSessionError | null;
+}
+export interface UseTerminalSessionOptions {
+    bridge: TerminalBridge | null;
+    request: TerminalSessionRequest;
+    /** Set to false to keep the session alive when the hook unmounts. */
+    killOnUnmount?: boolean;
+}
+export declare const createTerminalSessionRequestKey: (request: TerminalSessionRequest) => string;
+/**
+ * Opens a terminal session via the provided bridge and surfaces its lifecycle
+ * for the renderer. The session is killed on unmount unless explicitly opted
+ * out; switching bridges or request contents triggers a fresh open.
+ */
+export declare const useTerminalSession: ({ bridge, request, killOnUnmount }: UseTerminalSessionOptions) => UseTerminalSessionResult;

package/dist/components/tree-list/tree-list-order-filter.d.ts

@@ -1,3 +1,2 @@
-import { TreeListNode, TreeListSection } from './tree-list.types';
+import { TreeListSection } from './tree-list.types';
 export declare const applyTreeListOrder: (sections: TreeListSection[], sectionOrder: string[], nodeOrderBySection: Record<string, string[]>) => TreeListSection[];
-export declare const reorderNodesById: (nodes: TreeListNode[], order: string[]) => TreeListNode[];

package/dist/components/tree-list/tree-list-visibility-filter.d.ts

@@ -1,5 +1,5 @@
 import { ReactNode } from 'react';
-import { ResourceContextAction } from '../resource-context-menu';
+import { ResourceContextAction } from '../overlays/resource-context-menu';
 import { TreeListNode, TreeListSection } from './tree-list.types';
 import { VisibilityOverride } from './tree-list-visibility.store';
 export declare const resolveVisibility: (override: VisibilityOverride | undefined, hiddenByDefault: boolean | undefined) => VisibilityOverride;

package/dist/components/tree-list/tree-list.d.ts

@@ -1,6 +1,6 @@
 import { StackProps } from '@chakra-ui/react';
 import { MouseEvent as ReactMouseEvent, RefObject } from 'react';
-import { ResourceContextAction } from '../resource-context-menu';
+import { ResourceContextAction } from '../overlays/resource-context-menu';
 import { TreeListLinkComponent, TreeListNavigateEvent, TreeListSection } from './tree-list.types';
 export { buildVirtualRows } from './tree-list-model';
 type TreeListRowVariant = "compact" | "tree";