/** * Copyright 2025 Vybestack LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ import { type IContent } from '../services/history/IContent.js'; import { type SessionRecordingServiceConfig, type SessionEventType } from './types.js'; /** * Core service for recording session events to a JSONL file. * * @plan PLAN-20260211-SESSIONRECORDING.P05 * @requirement REQ-REC-003, REQ-REC-004, REQ-REC-005, REQ-REC-006, REQ-REC-007, REQ-REC-008 * @pseudocode session-recording-service.md lines 40-185 */ export declare class SessionRecordingService { /** @pseudocode session-recording-service.md lines 40-51 */ private queue; private seq; private filePath; private materialized; private active; private draining; private drainPromise; private readonly sessionId; private readonly chatsDir; private preContentBuffer; private chatsDirWatcher; /** * @plan PLAN-20260211-SESSIONRECORDING.P05 * @requirement REQ-REC-003 * @pseudocode session-recording-service.md lines 53-67 */ constructor(config: SessionRecordingServiceConfig); /** * Buffer an event before file materialization (before first content event). * * @plan PLAN-20260211-SESSIONRECORDING.P05 * @requirement REQ-REC-004 * @pseudocode session-recording-service.md lines 69-79 */ private bufferPreContent; /** * Enqueue an event for writing to the JSONL file. * Synchronous and non-blocking — actual I/O happens in the background. * * @plan PLAN-20260211-SESSIONRECORDING.P05 * @requirement REQ-REC-003, REQ-REC-004 * @pseudocode session-recording-service.md lines 81-110 */ enqueue(type: SessionEventType, payload: unknown): void; /** * Construct the filename and ensure the chats directory exists. * * @plan PLAN-20260211-SESSIONRECORDING.P05 * @requirement REQ-REC-004 * @pseudocode session-recording-service.md lines 112-118 */ private materialize; /** * Schedule a background drain of the queue. * * @plan PLAN-20260211-SESSIONRECORDING.P05 * @requirement REQ-REC-003 * @pseudocode session-recording-service.md lines 120-124 */ private scheduleDrain; /** * Drain the queue by writing all queued events to disk via appendFile. * * @plan PLAN-20260211-SESSIONRECORDING.P05 * @requirement REQ-REC-005, REQ-REC-006 * @pseudocode session-recording-service.md lines 126-146 */ private drain; /** * Flush all queued events to disk. * Returns a Promise that resolves when all pending writes are complete. * * @plan PLAN-20260211-SESSIONRECORDING.P05 * @requirement REQ-REC-005 * @pseudocode session-recording-service.md lines 148-160 */ flush(): Promise; /** * Whether recording is active (not disabled by ENOSPC or disposal). * * @plan PLAN-20260211-SESSIONRECORDING.P05 * @requirement REQ-REC-007 * @pseudocode session-recording-service.md line 162-164 */ isActive(): boolean; /** * Path to the JSONL file, or null if not yet materialized. * * @plan PLAN-20260211-SESSIONRECORDING.P05 * @requirement REQ-REC-004 * @pseudocode session-recording-service.md lines 166-168 */ getFilePath(): string | null; /** * The session identifier for this recording. * * @plan PLAN-20260211-SESSIONRECORDING.P05 * @requirement REQ-REC-003 * @pseudocode session-recording-service.md lines 170-172 */ getSessionId(): string; /** * Initialize for resuming an existing session file. * Sets the file path and sequence counter so new events append correctly. * * @plan PLAN-20260211-SESSIONRECORDING.P05 * @requirement REQ-REC-008 * @pseudocode session-recording-service.md lines 174-179 */ initializeForResume(filePath: string, lastSeq: number): void; /** * Dispose of the service: flush any remaining events, then stop recording. * * @plan PLAN-20260211-SESSIONRECORDING.P05 * @requirement REQ-REC-003 * @pseudocode session-recording-service.md lines 181-185 */ dispose(): Promise; /** * Diagnose which directory level is missing when ENOENT occurs. */ private diagnoseMissingPath; /** * Watch the chatsDir for rename/deletion events. * When the directory is removed mid-session, this fires and logs the * exact timestamp so it can be correlated with the shell command log. */ private startChatsDirWatcher; /** * Record a content event (user message, AI response, or tool interaction). * * @plan PLAN-20260211-SESSIONRECORDING.P05 * @requirement REQ-REC-002 * @pseudocode session-recording-service.md lines 190-192 */ recordContent(content: IContent): void; /** * Record a compression event — history was compressed into a summary. * * @plan PLAN-20260211-SESSIONRECORDING.P05 * @requirement REQ-REC-002 * @pseudocode session-recording-service.md lines 194-196 */ recordCompressed(summary: IContent, itemsCompressed: number): void; /** * Record a rewind event — last N items removed from history. * * @plan PLAN-20260211-SESSIONRECORDING.P05 * @requirement REQ-REC-002 * @pseudocode session-recording-service.md lines 198-200 */ recordRewind(itemsRemoved: number): void; /** * Record a provider/model switch event. * * @plan PLAN-20260211-SESSIONRECORDING.P05 * @requirement REQ-REC-002 * @pseudocode session-recording-service.md lines 202-204 */ recordProviderSwitch(provider: string, model: string): void; /** * Record an operational session event (info, warning, or error). * * @plan PLAN-20260211-SESSIONRECORDING.P05 * @requirement REQ-REC-002 * @pseudocode session-recording-service.md lines 206-208 */ recordSessionEvent(severity: 'info' | 'warning' | 'error', message: string): void; /** * Record a workspace directories change event. * * @plan PLAN-20260211-SESSIONRECORDING.P05 * @requirement REQ-REC-002 * @pseudocode session-recording-service.md lines 210-212 */ recordDirectoriesChanged(directories: string[]): void; }