efba9fab0a
scripts/gen-website-api.ts renders website/zh-CN/api/{cordis,harness}/* and the
api-sidebar.json fragment the VitePress config imports, so pages and navigation
can never drift from the code: signatures, @param/@returns prose, dispatch
modes, and GitHub source links are extracted, never transcribed, and the
generator hard-errors on any rendered member missing docs. verify-website-api
(doc-sync + run-gates) is the freshness gate.
Replaces the hand-written zh api pages (7 pages covering 7 of 15 services,
with phantom APIs: Context.current/Context.events, agent/post-step, tool/call,
compact/*, llm/pre-request none of which exist) with generated English
references: 5 cordis pages, 15 per-service pages, and a 35-event catalog
grouped by scope. The hand-written hub api/index.md stays and now indexes the
full surface; zh for these pages arrives with the unified translation flow.
111 lines
5.5 KiB
Markdown
111 lines
5.5 KiB
Markdown
<!-- Generated by scripts/gen-website-api.ts — do not edit by hand. Run `pnpm run gen-website-api` to regenerate. -->
|
|
|
|
# ctx.sessions
|
|
|
|
`SessionStore` — provided by `@deepseek-ai/dsh-session`.
|
|
|
|
In-memory session store (`ctx.sessions`).
|
|
Persistence is intentionally not implemented here — persistence plugins subscribe to `session/event` and flush on `session/flush` / dispose.
|
|
|
|
[Source](https://github.com/deepseek-harness/deepseek-harness/blob/master/packages/core/session/src/index.ts#L405)
|
|
|
|
### ctx.sessions.create(id?, options?)
|
|
|
|
```ts website-api
|
|
create(id?: SessionId, options?: CreateSessionOptions): Session
|
|
```
|
|
|
|
Create a session owned by the calling fiber: disposing that fiber stops event notification and removes the session from the store. `options.seed` populates the session with a copy of those events (replay/fork); `options.meta` attaches creation metadata (validated absolute `cwd`, `parentSession` lineage) as the immutable SessionHeader (the store fills `version`/`id`/`createdAt`).
|
|
For an agent whose session must be torn down IN ORDER with its loop (so the loop's final flush is captured before `onAppend` detaches), do NOT use this — fold the session lifecycle into the agent's own effect via prepare + enter + announce (see `dsh-agent-loop`'s `startOwned`).
|
|
|
|
- `id` — the session id; omitted, the store mints `session-<n>`.
|
|
- `options` — seed events and/or creation metadata for the header.
|
|
|
|
**Returns** the live session, already entered and announced.
|
|
|
|
[Source](https://github.com/deepseek-harness/deepseek-harness/blob/master/packages/core/session/src/index.ts#L433)
|
|
|
|
### ctx.sessions.prepare(id?, options?)
|
|
|
|
```ts website-api
|
|
prepare(id?: SessionId, options?: CreateSessionOptions): Session
|
|
```
|
|
|
|
Build a session WITHOUT entering it into the store — validate the id/cwd and construct the Session (with its immutable SessionHeader). Pairs with enter + announce: a caller that owns a composite `ctx.effect` (the agent factory) folds the session lifecycle into that ONE effect so a fiber unload tears the session + agent down as a single ORDERED chain rather than as racing sibling effects — which would detach `onAppend` before the loop's closing `session/flush`, dropping the closing events.
|
|
|
|
- `id` — the session id; omitted, the store mints `session-<n>`.
|
|
- `options` — seed events and/or creation metadata for the header.
|
|
|
|
**Returns** the constructed session, NOT yet in the store.
|
|
|
|
[Source](https://github.com/deepseek-harness/deepseek-harness/blob/master/packages/core/session/src/index.ts#L461)
|
|
|
|
### ctx.sessions.enter(session)
|
|
|
|
```ts website-api
|
|
enter(session: Session): () => void
|
|
```
|
|
|
|
Enter a prepared session into the store: wire `onAppend` → `session/event` and add it to the store. Returns the DETACH disposer (`onAppend = undefined` + store removal). Does NOT emit `session/created` — the caller yields this disposer inside its effect and THEN calls announce, so a throwing `session/created` listener rolls the attach back instead of leaking it.
|
|
Re-checks the id for a duplicate: `prepare` and `enter` are public cross-package primitives and a caller may interleave arbitrary work (or another create) between them, so a stale prepared session must NOT overwrite a live store entry of the same id — its detach disposer would later delete the REAL session. The create convenience and the agent factory call the two back-to-back so they never trip this, but the public seam cannot assume that.
|
|
|
|
- `session` — a {@link prepare}d session not yet in the store.
|
|
|
|
**Returns** the detach disposer (`onAppend = undefined` + store removal).
|
|
|
|
[Source](https://github.com/deepseek-harness/deepseek-harness/blob/master/packages/core/session/src/index.ts#L499)
|
|
|
|
### ctx.sessions.announce(session)
|
|
|
|
```ts website-api
|
|
announce(session: Session): void
|
|
```
|
|
|
|
Emit `session/created` for an entered session. Separate from enter so the caller can yield the detach disposer first (rollback safety — see enter).
|
|
|
|
- `session` — the entered session to announce to listeners.
|
|
|
|
[Source](https://github.com/deepseek-harness/deepseek-harness/blob/master/packages/core/session/src/index.ts#L513)
|
|
|
|
### ctx.sessions.get(id)
|
|
|
|
```ts website-api
|
|
get(id: SessionId): Session | undefined
|
|
```
|
|
|
|
Look up a live session.
|
|
|
|
- `id` — the session id to look up.
|
|
|
|
**Returns** the session, or undefined when no live session has that id.
|
|
|
|
[Source](https://github.com/deepseek-harness/deepseek-harness/blob/master/packages/core/session/src/index.ts#L522)
|
|
|
|
### ctx.sessions.list()
|
|
|
|
```ts website-api
|
|
list(): Session[]
|
|
```
|
|
|
|
All live sessions, in creation order.
|
|
|
|
**Returns** a fresh array; mutating it does not affect the store.
|
|
|
|
[Source](https://github.com/deepseek-harness/deepseek-harness/blob/master/packages/core/session/src/index.ts#L530)
|
|
|
|
### ctx.sessions.fork(source, boundary?, childSessionId?)
|
|
|
|
```ts website-api
|
|
fork(source: SessionForkSource, boundary?: number, childSessionId?: SessionId): Session
|
|
```
|
|
|
|
Create a live child session from a turn-enclosed prefix of a live source. `boundary` is an inclusive source event seq; omitted means the source's current last event. A non-empty selected slice must end at `turn/end`.
|
|
|
|
- `source` — Live source session object or id.
|
|
- `boundary` — Inclusive source event seq to fork through; omitted means the source's current last event, and omitted on an empty source forks an empty child.
|
|
- `childSessionId` — Optional child session id; omitted delegates to `SessionStore`'s id policy.
|
|
|
|
**Returns** The created live child session.
|
|
|
|
[Source](https://github.com/deepseek-harness/deepseek-harness/blob/master/packages/core/session/src/index.ts#L547)
|