mirror of
https://github.com/Ark0N/Codeman.git
synced 2026-11-16 19:29:33 +01:00
72 lines
3.5 KiB
TypeScript
72 lines
3.5 KiB
TypeScript
/**
|
|
* @fileoverview Session port — capabilities for session lifecycle management.
|
|
* Route modules that manage sessions depend on this port.
|
|
*/
|
|
|
|
import type { Session } from '../../session.js';
|
|
import type { SessionState } from '../../types.js';
|
|
import type { TabLayout } from '../../tab-layout.js';
|
|
import type { SessionPlacementHint } from '../../tab-layout-service.js';
|
|
|
|
export interface SessionPort {
|
|
readonly sessions: ReadonlyMap<string, Session>;
|
|
/**
|
|
* The last-response reader (the body of `GET /api/sessions/:id/last-response`), filled in when the
|
|
* session routes register, so other server code reads the same per-CLI transcript the viewer does.
|
|
*/
|
|
lastResponseFor?: (session: Session, context?: string) => Promise<{ text: string; timestamp?: string }>;
|
|
/**
|
|
* Register a created session with the owner's tab layout. `placement.tabGroupId`
|
|
* puts it at the end of that group in the same layout write (ignored when the
|
|
* group is not in the owner's layout); without one (and without a parent that
|
|
* places it), `placement.caseName`'s default session group does the same.
|
|
* Resolves to the committed layout.
|
|
*/
|
|
addSession(session: Session, placement?: SessionPlacementHint): Promise<TabLayout>;
|
|
cleanupSession(sessionId: string, killMux?: boolean, reason?: string): Promise<void>;
|
|
/**
|
|
* Delete a session's stored edit history once its record is gone. `cleanupSession` does it
|
|
* itself; this is for removing a record without a live session (DELETE route).
|
|
*/
|
|
forgetEditHistory(sessionId: string): void;
|
|
setupSessionListeners(session: Session): Promise<void>;
|
|
persistSessionState(session: Session): void;
|
|
persistSessionStateNow(session: Session): void;
|
|
/**
|
|
* Re-apply the persisted state a freshly CONSTRUCTED session does not carry.
|
|
*
|
|
* A `Session` built from a record holds only what its constructor takes, so
|
|
* persisting it would otherwise REPLACE the fuller record with the reduced one.
|
|
* Two phases: `before-spawn` shapes the pane (the custom-model environment and
|
|
* the nice priority) and must precede `startInteractive()`; `after-spawn` is
|
|
* the session's own history (the pin, token and cost totals, auto-compact,
|
|
* auto-clear, auto-resume, colour, image watcher, flicker filter) and must NOT
|
|
* land on a session whose pane failed to start.
|
|
*/
|
|
reapplyPersistedSessionState(
|
|
session: Session,
|
|
saved: SessionState,
|
|
phase: 'before-spawn' | 'after-spawn',
|
|
options?: {
|
|
/**
|
|
* Re-arm a PENDING auto-resume schedule from the record's `autoResumeAt`.
|
|
* Default true, which is what a Codeman restart wants: the limit footer
|
|
* will not reprint on its own, so dropping the stamp there strands the
|
|
* pause. A reboot restore passes false: the stamp predates the reboot,
|
|
* the pane is new, and re-arming means every restored session types
|
|
* `continue` into itself about a minute after one click. Auto-resume
|
|
* stays ENABLED either way, so it re-arms on fresh evidence.
|
|
*/
|
|
rearmAutoResumeSchedule?: boolean;
|
|
}
|
|
): Promise<void>;
|
|
/**
|
|
* Undo a session that was registered but never got a working pane: the map
|
|
* entry, its tab-layout slot, and any pane the launch created before throwing.
|
|
* Unlike {@link cleanupSession} it leaves the persisted record, the lifetime
|
|
* token totals, the Ralph state and the workspace's own files untouched.
|
|
*/
|
|
discardPartiallyBuiltSession(sessionId: string): Promise<void>;
|
|
getSessionStateWithRespawn(session: Session): unknown;
|
|
}
|