@signalcore/ui 0.1.0 → 1.0.0-beta.1

package/dist/windows/useUnread.d.ts

@@ -1,7 +0,0 @@
-import type { ChatMessage } from "../chat/types.js";
-/**
- * Whether the agent said something the person has not had the chance to see: its last words
- * arrived while the conversation was not what they were looking at. What was already there when
- * the history was read is not new, and neither is anything while they look at the conversation.
- */
-export declare function useUnread(messages: readonly ChatMessage[], loading: boolean, looking: boolean): boolean;

package/dist/windows/useUnread.js

@@ -1,21 +0,0 @@
-import { useState } from "react";
-/**
- * Whether the agent said something the person has not had the chance to see: its last words
- * arrived while the conversation was not what they were looking at. What was already there when
- * the history was read is not new, and neither is anything while they look at the conversation.
- */
-export function useUnread(messages, loading, looking) {
-    const last = messages.findLast((message) => message.role === "agent")?.id;
-    const [read, setRead] = useState();
-    const [settled, setSettled] = useState(!loading);
-    // Settled while drawing, so that the mark is never shown for words that were already there
-    // or that the person is looking at, not even for one frame.
-    if (!settled && !loading) {
-        setSettled(true);
-        setRead(last);
-    }
-    else if (settled && looking && read !== last) {
-        setRead(last);
-    }
-    return settled && read !== last;
-}

package/dist/windows/useWindows.d.ts

@@ -1,70 +0,0 @@
-import type { RunEvent } from "../stream/reduce.js";
-import type { SurfaceData } from "../surface/types.js";
-import { type DefaultWindowKind, type Viewer } from "./kinds.js";
-import { type AgentWindow } from "./reduce.js";
-export interface WindowsOptions {
-    /**
-     * Default windows to open besides the conversation, which every stage has. The first one
-     * listed takes the stage; without any, the conversation does.
-     */
-    initial?: readonly DefaultWindowKind[] | undefined;
-    /**
-     * Who is looking: the windows that are the owner's are never opened for an end user. Default:
-     * the provider's `viewer`. Read when the stage opens.
-     */
-    viewer?: Viewer | undefined;
-}
-/** What a host opens a default window with. */
-export interface OpenOptions {
-    title?: string | undefined;
-    /** What the window shows, in words, for a viewer where no component draws its kind. */
-    fallbackText?: string | undefined;
-    /** What the kind needs to be drawn: `sessionId` for a `browser`, `streamId` for a `live`. */
-    params?: Readonly<Record<string, string>> | undefined;
-}
-export interface Windows {
-    /** The open windows, in the order they were opened. The conversation is the first. */
-    windows: AgentWindow[];
-    /** The one on the stage. */
-    focused: AgentWindow | undefined;
-    focusedId: string;
-    /** The windows the person closed, the latest first, to offer to reopen them. */
-    closed: AgentWindow[];
-    /** Brings an open window to the stage. */
-    focus: (id: string) => void;
-    /** Closes a window; the conversation cannot be closed. It can be reopened from `closed`. */
-    close: (id: string) => void;
-    reopen: (id: string) => void;
-    /** Opens one of the app's own windows, or brings it forward if it is open. */
-    open: (kind: DefaultWindowKind, options?: OpenOptions) => void;
-    /**
-     * The agent showed these surfaces: the ones it placed as a window open one (or replace what
-     * their slot had) and take the stage. Safe to call again with the same surfaces: nothing is
-     * placed twice, and a window the person closed stays closed until a new surface is put in it.
-     */
-    place: (surfaces: readonly SurfaceData[]) => void;
-    /**
-     * The same for a conversation's past, read when it opens: the stage is rebuilt from what the
-     * agent placed (the last surface of each slot wins) without taking the person away from the
-     * conversation.
-     */
-    restore: (surfaces: readonly SurfaceData[]) => void;
-    /**
-     * A run's journal, from the start or with more of it: what the run placed (`ui.surface`) and
-     * the app's windows it opened (`ui.window`). The run's id says where the events came from, so
-     * hearing the same ones again changes nothing.
-     */
-    observe: (runId: string, events: readonly RunEvent[]) => void;
-}
-/**
- * The state of the stage (ADR 0011): which windows are open, which one is on the stage, which
- * the person closed. It is derived from facts, never from a resource of its own: what the agent
- * placed or opened (the surfaces of the conversation and of its history, the `ui.surface` and
- * `ui.window` events of its runs) and what the person does (focus, close, reopen). Nothing here
- * reads the API; `AgentSpace` feeds it from the conversation, and a host that lays windows out
- * itself feeds it what it already has (`useRunStream`'s events, a history it loaded).
- *
- * The reducer is `reduce` in `./reduce.ts`: pure, so the stage rebuilt from a history and the
- * stage that watched the same events live are the same stage.
- */
-export declare function useWindows(options?: WindowsOptions): Windows;

package/dist/windows/useWindows.js

@@ -1,60 +0,0 @@
-import { useCallback, useMemo, useReducer } from "react";
-import { useMessages, useSignalcore } from "../SignalcoreProvider.js";
-import { kindsFor } from "./kinds.js";
-import { begin, reduce } from "./reduce.js";
-/**
- * The state of the stage (ADR 0011): which windows are open, which one is on the stage, which
- * the person closed. It is derived from facts, never from a resource of its own: what the agent
- * placed or opened (the surfaces of the conversation and of its history, the `ui.surface` and
- * `ui.window` events of its runs) and what the person does (focus, close, reopen). Nothing here
- * reads the API; `AgentSpace` feeds it from the conversation, and a host that lays windows out
- * itself feeds it what it already has (`useRunStream`'s events, a history it loaded).
- *
- * The reducer is `reduce` in `./reduce.ts`: pure, so the stage rebuilt from a history and the
- * stage that watched the same events live are the same stage.
- */
-export function useWindows(options = {}) {
-    const scope = useSignalcore();
-    const copy = useMessages();
-    const viewer = options.viewer ?? scope.viewer;
-    const [state, dispatch] = useReducer(reduce, undefined, () => begin({
-        initial: options.initial ?? [],
-        allowed: kindsFor(viewer),
-        titleOf: copy.space.titleOf,
-        at: Date.now(),
-    }));
-    const focus = useCallback((id) => {
-        dispatch({ type: "focus", id });
-    }, []);
-    const close = useCallback((id) => {
-        dispatch({ type: "close", id });
-    }, []);
-    const reopen = useCallback((id) => {
-        dispatch({ type: "reopen", id, at: Date.now() });
-    }, []);
-    const open = useCallback((kind, opening = {}) => {
-        dispatch({ type: "open", kind, ...opening, at: Date.now() });
-    }, []);
-    const place = useCallback((surfaces) => {
-        dispatch({ type: "place", surfaces, quiet: false, at: Date.now() });
-    }, []);
-    const restore = useCallback((surfaces) => {
-        dispatch({ type: "place", surfaces, quiet: true, at: Date.now() });
-    }, []);
-    const observe = useCallback((runId, events) => {
-        dispatch({ type: "journal", runId, events, at: Date.now() });
-    }, []);
-    return useMemo(() => ({
-        windows: state.windows,
-        focused: state.windows.find((window) => window.id === state.focusedId),
-        focusedId: state.focusedId,
-        closed: state.closed,
-        focus,
-        close,
-        reopen,
-        open,
-        place,
-        restore,
-        observe,
-    }), [state, focus, close, reopen, open, place, restore, observe]);
-}