@alexkroman1/aai-ui 0.16.0 → 0.18.0

package/dist/components/tool-config-context.d.ts

@@ -1,19 +1,37 @@
+import { type Context } from "react";
 /**
- * Display configuration for a tool call in the UI.
+ * Display configuration for a tool call in the UI, keyed by tool name: the
+ * icon and label each tool declared with `tool({ ui })`, as the agent serves
+ * them in its `GET /client-config` body. `mountClient()` installs the served
+ * map as it is — a page has no map of its own to merge over it, so the tool's
+ * declaration is the one place a tool's icon lives.
  *
+ * Not on the package barrel: nothing an author writes names it (the value a
+ * page reads comes from the agent), so it is the context's value type only.
+ *
+ * @sealed
  * @public
  */
 export type ToolDisplayConfig = Record<string, {
-    icon?: string;
-    label?: string;
+    icon?: string | undefined;
+    label?: string | undefined;
 }>;
+/**
+ * The value the context holds before the lookup lands (and forever, when the
+ * lookup fails): one frozen object, so the provider's value is stable across
+ * renders rather than a fresh `{}` per commit.
+ *
+ * @internal
+ */
+export declare const EMPTY_TOOL_DISPLAY: ToolDisplayConfig;
 /**
  * Context for tool display configuration. Installed by `mountClient()` from
- * `ClientConfig.tools`; the built-in components read it via `useToolConfig`.
+ * the agent's `GET /client-config` `tools`; the built-in components read it
+ * via `useToolConfig`.
  *
  * @internal
  */
-export declare const ToolConfigContext: import("react").Context<ToolDisplayConfig>;
+export declare const ToolConfigContext: Context<ToolDisplayConfig>;
 /**
  * Read tool display configuration from the nearest `ToolConfigContext.Provider`.
  *

package/dist/components/url-chips.d.ts

@@ -1,3 +1,4 @@
+import type { JSX } from "react";
 /**
  * The session's shareable UI URL — the page this UI is served from, what
  * you'd send someone to talk to the agent.
@@ -6,7 +7,7 @@
  */
 export declare function UiUrlChip({ className }: {
     className?: string | undefined;
-}): import("react").JSX.Element;
+}): JSX.Element;
 /**
  * The session's programmatic WebSocket endpoint — the URL a script or backend
  * can connect to directly instead of using this UI.
@@ -15,7 +16,7 @@ export declare function UiUrlChip({ className }: {
  */
 export declare function ApiUrlChip({ className }: {
     className?: string | undefined;
-}): import("react").JSX.Element;
+}): JSX.Element;
 /**
  * The UI and API URLs side by side. They answer the same question — "how do I
  * reach this agent?" — so they belong together and each needs its label to be
@@ -26,4 +27,4 @@ export declare function ApiUrlChip({ className }: {
  */
 export declare function SessionUrlChips({ className }: {
     className?: string | undefined;
-}): import("react").JSX.Element;
+}): JSX.Element;

package/dist/components/workflow-fields.d.ts

@@ -1,6 +1,39 @@
 import type { WorkflowSummary } from "@alexkroman1/aai/workflow-api";
+import { type JSX } from "react";
+import type { WorkflowAppLike, WorkflowNameOf } from "../workflow-def-types.ts";
+import { type WorkflowFieldRender } from "../workflow-field-kind.ts";
 /**
- * Render one field per scalar property of a workflow's input schema.
+ * Props for {@link WorkflowFields}.
+ *
+ * @typeParam App - The agent, when the page names it
+ *   (`<WorkflowFields<typeof agentDef> workflow="digest" />`): `workflow` is
+ *   then a name the agent declares, checked. Left to its default, any string:
+ *   `WorkflowNameOf<WorkflowAppLike>` is `string`. The default is the
+ *   constraint rather than the hooks' `never` because this is ONE signature —
+ *   a form has no def form to fall to, so there is no second overload for a
+ *   `never` to hand the call on to.
+ *
+ * @input
+ * @public
+ */
+export type WorkflowFieldsProps<App extends WorkflowAppLike = WorkflowAppLike> = {
+    /**
+     * The workflow whose input schema to render. A NAME is looked up here (one
+     * `GET workflows`); a {@link WorkflowSummary} the page already holds fetches
+     * nothing. `undefined` renders nothing, so a page may pass a selection
+     * straight through before one is made.
+     */
+    workflow?: WorkflowSummary | WorkflowNameOf<App> | undefined;
+    /**
+     * The control to draw for a property, by name, where the schema alone does
+     * not say — `{ mustCover: "lines", source: "namedText" }`. Beats the schema
+     * for that property, never a declared upload. See `WorkflowFieldKind`.
+     */
+    render?: Readonly<Record<string, WorkflowFieldRender>> | undefined;
+};
+/**
+ * Render one field per property of a workflow's input schema that has an
+ * honest control — every scalar, an array of strings, a `{ name, text }` object.
  *
  * Pass the workflow's NAME and the schema is fetched here; pass a
  * {@link WorkflowSummary} you already hold and nothing is fetched. The name form
@@ -31,16 +64,8 @@ import type { WorkflowSummary } from "@alexkroman1/aai/workflow-api";
  * }
  * ```
  *
- * @param props - Field-set props.
+ * @param props - See {@link WorkflowFieldsProps}.
  *
  * @public
  */
-export declare function WorkflowFields({ workflow, }: {
-    /**
-     * The workflow whose input schema to render. A NAME is looked up here (one
-     * `GET workflows`); a {@link WorkflowSummary} the page already holds fetches
-     * nothing. `undefined` renders nothing, so a page may pass a selection
-     * straight through before one is made.
-     */
-    workflow?: WorkflowSummary | string | undefined;
-}): import("react").JSX.Element | null;
+export declare function WorkflowFields<App extends WorkflowAppLike = WorkflowAppLike>({ workflow, render, }: WorkflowFieldsProps<App>): JSX.Element | null;

package/dist/components/workflow-pending-note.d.ts

@@ -1,20 +1,27 @@
 import type { ReactNode } from "react";
 import type { WorkflowRun } from "../workflow-client.ts";
+import type { UploadStatus, WorkflowSubmissionScope } from "../workflow-submission.ts";
 /**
  * Props for {@link WorkflowPendingNote}.
  *
+ * @input
  * @public
  */
 export type WorkflowPendingNoteProps = {
     /**
      * The submission the page is rendering — `useWorkflowSubmit`'s or
-     * `useWorkflowStream`'s result, or any object carrying these three fields.
-     * Nothing renders while `pending` is false.
+     * `useWorkflowStream`'s result, or any object carrying the three required
+     * fields. Nothing renders while `pending` is false. `scope` and `upload`,
+     * when present, choose two more sentences — see below.
      */
     submission: {
         readonly pending: boolean;
         readonly startedHere: boolean;
         readonly run: WorkflowRun | undefined;
+        /** Who finds the run again — `WorkflowSubmission.scope`; the `scope` prop overrides it. */
+        readonly scope?: WorkflowSubmissionScope | undefined;
+        /** The bytes in flight — `WorkflowSubmission.upload`; a PAUSED one gets its own line. */
+        readonly upload?: UploadStatus | undefined;
     };
     /**
      * What the run produces, as the noun the sentences name: `"draft"`,
@@ -22,13 +29,16 @@ export type WorkflowPendingNoteProps = {
      */
     subject?: string | undefined;
     /**
-     * Where the key that finds the run again lives. `"tab"` (the default) is
-     * `useWorkflowSubmit`'s own `sessionStorage` key; `"browser"` is a page that
-     * passed `useRunKey({ storage: "local" })`, whose runs any tab on this browser
-     * can find — so the sentence says "this browser" and stops promising that
-     * closing the tab loses anything.
+     * Where the key that finds the run again lives, overriding what the
+     * submission reports. `"tab"` is `useWorkflowSubmit`'s own `sessionStorage`
+     * key; `"browser"` is a page that passed `useRunKey({ storage: "local" })`,
+     * whose runs any tab on this browser can find — so the sentence says "this
+     * browser" and stops promising that closing the tab loses anything;
+     * `"none"` is a run nothing will find again (`recover: false`,
+     * `useWorkflowStream`), which the sentence has to say instead. Default: the
+     * submission's own `scope`, else `"tab"`.
      */
-    scope?: "tab" | "browser" | undefined;
+    scope?: WorkflowSubmissionScope | undefined;
     /**
      * ADDED to the note's own `text-sm opacity-70` rather than replacing it.
      * There is no `tailwind-merge` in this package, so a class that CONFLICTS with
@@ -37,7 +47,7 @@ export type WorkflowPendingNoteProps = {
     className?: string | undefined;
 };
 /**
- * The one sentence a page says while a run is in flight — three situations,
+ * The one sentence a page says while a run is in flight — five situations,
  * one line each — as a muted line under the form, and nothing otherwise.
  *
  * Six template pages had each written the function under this, byte-identical
@@ -60,9 +70,18 @@ export type WorkflowPendingNoteProps = {
  *
  * `startedHere`, `run` and `pending` are what {@link WorkflowSubmission}
  * reports, which is why the prop is the submission itself rather than three
- * booleans a page would re-derive. A page with a FOURTH situation — a run that a
- * reload does not recover but ENDS, as `transcription-workflow`'s streaming
- * flow has — writes its own sentence, and that template is the one doing so.
+ * booleans a page would re-derive. The two situations past those three read
+ * two more of its fields, and used to be the one page that wrote its own note:
+ *
+ * - **A run nothing will find again** (`scope: "none"` — `useWorkflowStream`,
+ *   whose run reads the recording as this page sends it and gives up on one
+ *   that stops arriving, or `recover: false`): "keep this tab open", because
+ *   a reload does not orphan that run, it ENDS it. A page telling a reader they
+ *   can close the tab would be wrong in exactly that mode.
+ * - **A PAUSED upload** is that same fact arriving through a button, which is
+ *   why it is tested first and why its two sentences differ: with no run yet
+ *   a pause costs nothing, and in the streaming mode the run is already
+ *   watching an upload it will give up on.
  *
  * @example
  * ```tsx

package/dist/components/workflow-run-error.d.ts

@@ -3,6 +3,7 @@ import type { WorkflowRun } from "../workflow-client.ts";
 /**
  * Props for {@link WorkflowRunError}.
  *
+ * @input
  * @public
  */
 export type WorkflowRunErrorProps = {

package/dist/components/workflow-run-panel.d.ts

@@ -7,6 +7,7 @@ import { type WorkflowApi, type WorkflowRun } from "../workflow-client.ts";
  * @typeParam O - The run's output type; `run.output` narrows to it in the
  * completed slot.
  *
+ * @input
  * @public
  */
 export type WorkflowRunPanelProps<O> = {