UI kit reference

zidane-ui/session/testing

import { … } from 'zidane-ui/session/testing'ui/src/session/testing/index.ts

Functions#

`createFixturePlansBackend`Function#

Creates a FixturePlansBackend.

TypeScript

function createFixturePlansBackend(seed?: FixturePlansSeed): FixturePlansBackend

Parameters

Parameters
Name	Type	Default	Description
seed?	`FixturePlansSeed`	`{}`	The plans and task lists it starts with.

Returns

FixturePlansBackend

ui/src/session/headless/fixture-plans.ts:89

`createFixtureScheduleBackend`Function#

Creates a FixtureScheduleBackend.

TypeScript

function createFixtureScheduleBackend(
  options?: FixtureScheduleOptions,
): FixtureScheduleBackend

Parameters

Parameters
Name	Type	Default	Description
options?	`FixtureScheduleOptions`	`{}`	The starting schedules, fires, setting and clock.

Returns

FixtureScheduleBackend

ui/src/session/headless/fixture-schedules.ts:65

`createFixtureSessionHost`Function#

Creates a FixtureSessionHost over the fixture's data.

TypeScript

function createFixtureSessionHost(fixture?: SessionFixture): FixtureSessionHost

Parameters

Parameters
Name	Type	Default	Description
fixture?	`SessionFixture`	`{}`	The data per session.

Returns

FixtureSessionHost

ui/src/session/headless/fixture-host.ts:118

`demoUsageSummary`Function#

A usage summary over range, ending on today: a few months of steady use across three models.

TypeScript

function demoUsageSummary(range: UsageRange, today?: Date): UsageSummary

Parameters

Parameters
Name	Type	Description
range	`UsageRange`	The range it covers.
today?	`Date`	The last day.

Returns

UsageSummary

ui/src/session/testing/demo.ts:54

`planOf`Function#

A session-scope plan over a task list, for fixtures and tests.

TypeScript

function planOf(items: readonly TodoItem[], plan?: Partial<Plan>): Plan

Parameters

Parameters
Name	Type	Default	Description
items	`readonly TodoItem[]`		The steps, as todo items.
plan?	`Partial<Plan>`	`{}`	Fields over the defaults (an applying adhoc plan `plan-1`, untitled).

Returns

Plan

ui/src/session/headless/fixture-plans.ts:58

`plansSnapshotOf`Function#

The snapshot of a session's plans, as the host broadcasts it (every run live: nothing reads as interrupted).

TypeScript

function plansSnapshotOf(plans: readonly PlanView[]): PlansSnapshot

Parameters

Parameters
Name	Type	Description
plans	`readonly PlanView[]`	The plans, oldest first.

Returns

PlansSnapshot

ui/src/session/headless/fixture-plans.ts:48

`tallyTodos`Function#

Counts todo items by status.

TypeScript

function tallyTodos(items: readonly { status: TodoStatus }[]): TodoTallyCounts

Parameters

Parameters
Name	Type	Description
items	`readonly { status: TodoStatus }[]`	The todo list.

Returns

TodoTallyCounts

ui/src/session/headless/fixture-plans.ts:78

Constants#

`DEMO_ARTIFACT_KIND_LABELS`Constant#

The artifact kinds' labels in the demo, as the backend's kind registry words them.

TypeScript

const DEMO_ARTIFACT_KIND_LABELS: Readonly<Record<string, string>>

ui/src/session/testing/demo.ts:25

`DEMO_GITHUB_USAGE`Constant#

GitHub's API limits in the demo.

TypeScript

const DEMO_GITHUB_USAGE: readonly ProviderUsageSnapshot[]

ui/src/session/testing/demo.ts:157

`DEMO_PROVIDER_USAGE`Constant#

Subscription windows: one provider with two accounts' worth of windows, one with credits.

TypeScript

const DEMO_PROVIDER_USAGE: readonly ProviderUsageSnapshot[]

ui/src/session/testing/demo.ts:109

`DEMO_SESSION_FIXTURE`Constant#

A session (demo) with todos mid-task, two queued messages, three artifacts, running work and turns, plus usage.

TypeScript

const DEMO_SESSION_FIXTURE: SessionFixture

ui/src/session/testing/demo.ts:177

`DEMO_TURNS`Constant#

The demo's stored turns: a prompt and the answer.

TypeScript

const DEMO_TURNS: readonly SessionTurn[]

ui/src/session/testing/demo.ts:33

`SCHEDULES_OFF_MESSAGE`Constant#

The message zidane's backend answers while the setting is off.

TypeScript

const SCHEDULES_OFF_MESSAGE: 'Reminders are off. Turn them on in Settings > Sessions > Reminders.'

ui/src/session/headless/fixture-schedules.ts:58

Interfaces#

`FixturePlansBackend`Interface#

A plans backend in memory.

TypeScript

interface FixturePlansBackend

Properties

FixturePlansBackend properties
Name	Type	Description
control	`(sessionId: string, planId: string, action: PlanControlAction) => PlansSnapshot`	A stop or drop (`plans.control`). Throws the gate's reason.
edit	`(sessionId: string, planId: string, op: PlanEditOp) => PlansSnapshot`	A user edit (`plans.edit`). Throws the gate's reason.
endRun	`(sessionId: string, outcome?: 'error' \| 'completed' \| 'aborted') => void`	The session's run ended: the plan it applied stops.
setPlans	`(sessionId: string, plans: readonly PlanView[]) => void`	Replaces a session's plans.
snapshot	`(sessionId: string) => PlansSnapshot \| null`	A session's snapshot, `null` for a session it does not hold.
subscribe	`(listener: (sessionId: string) => void) => () => void`	Calls `listener` with a session's id after each change. Returns the unsubscribe.
writeTodos	`(sessionId: string, items: readonly TodoItem[]) => void`	The agent's `todowrite`: updates the applying plan, starts one, or resumes a stopped one with the same step ids.

ui/src/session/headless/fixture-plans.ts:24

`FixturePlansSeed`Interface#

What a fixture plans backend starts with, per session id.

TypeScript

interface FixturePlansSeed

Properties

FixturePlansSeed properties
Name	Type	Description
plans?	`Readonly<Record<string, readonly PlanView[]>>`	Each session's plans, oldest first (`possiblyInterrupted` shows an applying plan with no live run).
todos?	`Readonly<Record<string, readonly TodoItem[]>>`	Each session's task list as the agent wrote it (`todowrite`), applied over `plans`: an applying plan.

ui/src/session/headless/fixture-plans.ts:16

`FixtureQueuedEntry`Interface#

A queued entry the fixture holds, with its attachments' bytes.

TypeScript

interface FixtureQueuedEntry

Properties

FixtureQueuedEntry properties
Name	Type	Description
attachments?	`PromptAttachment[]`	Its attachments, with their bytes.
id	`string`	The entry's id.
text	`string`	The message text.

ui/src/session/headless/fixture-host.ts:40

`FixtureScheduleBackend`Interface#

A scripted reminders backend.

TypeScript

interface FixtureScheduleBackend

Properties

FixtureScheduleBackend properties
Name	Type	Description
create	`(input: unknown) => Schedule`	`schedules.create`, as the person (`createdBy: user`).
fires	`(id: string, limit?: number) => ScheduleFire[]`	`schedules.fires`: newest first.
list	`(filter?: { sessionId?: string }) => Schedule[]`	`schedules.list`: every schedule, or those whose prompt goes to `sessionId`.
remove	`(id: string) => boolean`	`schedules.delete`: `false` when it was gone.
replace	`(list: readonly Schedule[]) => void`	Replaces the stored schedules from outside (the agent set one, one fired).
runNow	`(id: string) => ScheduleFire`	`schedules.runNow`: records a fire now; the next time does not move.
setEnabled	`(enabled: boolean) => void`	Turns the setting on or off.
status	`() => SchedulesStatus`	`schedules.status`.
subscribe	`(onChange: (scheduleId?: string) => void) => () => void`	Hears every change (`schedules:changed`). Returns the unsubscribe.
update	`(id: string, patch: unknown) => Schedule`	`schedules.update`.

ui/src/session/headless/fixture-schedules.ts:22

`FixtureScheduleOptions`Interface#

What createFixtureScheduleBackend starts with.

TypeScript

interface FixtureScheduleOptions

Properties

FixtureScheduleOptions properties
Name	Type	Default	Description
enabled?	`boolean`	`true`	`Settings.schedules`.
fires?	`Readonly<Record<string, readonly ScheduleFire[]>>`		Each schedule's fires, newest first.
now?	`() => number`	`Date.now`	The clock.
schedules?	`readonly Schedule[]`		The stored schedules, oldest first.

ui/src/session/headless/fixture-schedules.ts:46

`FixtureSessionControl`Interface#

Changes a fixture's data from outside and announces it, as the agent or another window would.

TypeScript

interface FixtureSessionControl

Properties

FixtureSessionControl properties
Name	Type	Description
endRun	`(sessionId: string, outcome?: 'error' \| 'completed' \| 'aborted') => void`	The session's run ended: the plan it applied stops.
recordArtifact	`(sessionId: string, row: SessionArtifactRow) => void`	Records an artifact (newest first).
setPlans	`(sessionId: string, plans: readonly PlanView[]) => void`	Replaces a session's plans.
setQueue	`(sessionId: string, entries: readonly FixtureQueuedEntry[]) => void`	Replaces a session's queue.
setSchedules	`(list: readonly Schedule[]) => void`	Replaces the stored reminders (the agent set one, one fired) and announces the change.
setSchedulesEnabled	`(enabled: boolean) => void`	Turns the Reminders setting on or off and announces it.
setSecrets	`(sessionId: string, entries: readonly SecretEntry[]) => void`	Replaces a session's saved secrets (the agent saved one, another window revoked one).
setWork	`(sessionId: string, items: readonly RunningWorkItem[]) => void`	Replaces a session's running work.
writeTodos	`(sessionId: string, items: readonly TodoItem[]) => void`	The agent's `todowrite`: updates the applying plan, starts one, or resumes a stopped one with the same step ids.

ui/src/session/headless/fixture-host.ts:86

`FixtureSessionHost`Interface#

The fixture host: a full SessionHost plus its control.

TypeScript

interface FixtureSessionHost extends SessionHost

Properties

FixtureSessionHost properties
Name	Type	Description
artifacts?from `SessionHost`	`SessionArtifacts`	The recorded artifacts. Absent: no Artifacts panel.
control	`FixtureSessionControl`	Changes the data from outside.
details?from `SessionHost`	`SessionDetailsActions`	The details dialog's actions. Absent: the dialog shows facts only.
plans?from `SessionHost`	`SessionPlans`	The plans. Absent: no Todos panel.
queue?from `SessionHost`	`SessionQueue`	The type-ahead queues. Absent: no queue.
runningWork?from `SessionHost`	`SessionRunningWork`	The cancellable work. Absent: no running work dialog.
schedules?from `SessionHost`	`SessionSchedules`	Reminders (zidane's schedules). Absent: no Reminders panel, no badge.
secrets?from `SessionHost`	`SessionSecrets`	The saved secrets of a session's project. Absent: no Secrets panel.
side?from `SessionHost`	`SessionSideChats`	`/side` chats about a session. Absent: no side chat.
turns?from `SessionHost`	`SessionTurns`	The stored turns. Absent: no turn details dialog.
usage?from `SessionHost`	`SessionUsage`	Usage. Absent: no usage card, no usage panel.

ui/src/session/headless/fixture-host.ts:108

`SessionFixture`Interface#

What a fixture session host starts with, per session id.

TypeScript

interface SessionFixture

Properties

SessionFixture properties
Name	Type	Default	Description
artifacts?	`Readonly<Record<string, readonly SessionArtifactRow[]>>`		The artifacts per session, newest first.
githubUsage?	`readonly ProviderUsageSnapshot[]`		GitHub's API limits. Absent: no `usage.github`.
kindLabel?	`(kind: string) => string`		An artifact kind's group label. Default: the raw kind.
plans?	`Readonly<Record<string, readonly PlanView[]>>`		The plans per session, oldest first (`possiblyInterrupted` shows an applying plan with no live run).
providerUsage?	`readonly ProviderUsageSnapshot[]`		The providers' subscription snapshots. Absent: no `usage.providers`.
queue?	`Readonly<Record<string, readonly FixtureQueuedEntry[]>>`		The queued messages per session.
scheduleFires?	`Readonly<Record<string, readonly ScheduleFire[]>>`		Each reminder's fires, newest first, by schedule id.
schedules?	`readonly Schedule[]`		The stored reminders (zidane's schedules), oldest first. Absent: no `schedules`.
schedulesEnabled?	`boolean`	`true`	`Settings.schedules`.
secrets?	`Readonly<Record<string, readonly SecretEntry[]>>`		The saved secrets per session (as the session's project holds them). Absent: no `secrets`.
secretsSaveError?	`string`		`secrets.save` rejects with this message (a plain-text remote link refusing values).
sides?	`Readonly<Record<string, string>>`		Each session's side chat id, by the parent's id. Absent: no `side`.
todos?	`Readonly<Record<string, readonly TodoItem[]>>`		The task list per session as the agent wrote it (`todowrite`), over `plans`: an applying plan.
turns?	`Readonly<Record<string, readonly SessionTurn[]>>`		The stored turns per session.
usage?	`Partial<Record<UsageRange, UsageSummary>>`		The usage summary per range. Absent: no `usage.summary`.
work?	`Readonly<Record<string, readonly RunningWorkItem[]>>`		The running work per session.

ui/src/session/headless/fixture-host.ts:50

Functions#

createFixturePlansBackendFunction#

Parameters

Returns

createFixtureScheduleBackendFunction#

Parameters

Returns

createFixtureSessionHostFunction#

Parameters

Returns

demoUsageSummaryFunction#

Parameters

Returns

planOfFunction#

Parameters

Returns

plansSnapshotOfFunction#

Parameters

Returns

tallyTodosFunction#

Parameters

Returns

Constants#

DEMO_ARTIFACT_KIND_LABELSConstant#

DEMO_GITHUB_USAGEConstant#

DEMO_PROVIDER_USAGEConstant#

DEMO_SESSION_FIXTUREConstant#

DEMO_TURNSConstant#

SCHEDULES_OFF_MESSAGEConstant#

Interfaces#

FixturePlansBackendInterface#

Properties

FixturePlansSeedInterface#

Properties

FixtureQueuedEntryInterface#

Properties

FixtureScheduleBackendInterface#

Properties

FixtureScheduleOptionsInterface#

Properties

FixtureSessionControlInterface#

Properties

FixtureSessionHostInterface#

Properties

SessionFixtureInterface#

Properties

`createFixturePlansBackend`Function#

`createFixtureScheduleBackend`Function#

`createFixtureSessionHost`Function#

`demoUsageSummary`Function#

`planOf`Function#

`plansSnapshotOf`Function#

`tallyTodos`Function#

`DEMO_ARTIFACT_KIND_LABELS`Constant#

`DEMO_GITHUB_USAGE`Constant#

`DEMO_PROVIDER_USAGE`Constant#

`DEMO_SESSION_FIXTURE`Constant#

`DEMO_TURNS`Constant#

`SCHEDULES_OFF_MESSAGE`Constant#

`FixturePlansBackend`Interface#

`FixturePlansSeed`Interface#

`FixtureQueuedEntry`Interface#

`FixtureScheduleBackend`Interface#

`FixtureScheduleOptions`Interface#

`FixtureSessionControl`Interface#

`FixtureSessionHost`Interface#

`SessionFixture`Interface#