@promptbook/cli 0.113.0-1 → 0.113.0-11

package/apps/agents-server/src/utils/pagePreview/livePagePreviewSessions.ts

@@ -1,365 +0,0 @@
-import type { Page } from 'playwright';
-import { spaceTrim } from 'spacetrim';
-import {
-    LIVE_PAGE_PREVIEW_VIEWPORT_HEIGHT,
-    LIVE_PAGE_PREVIEW_VIEWPORT_WIDTH,
-} from '../../../../../src/book-components/Chat/utils/livePagePreviewConstants';
-import { KnowledgeScrapeError } from '../../../../../src/errors/KnowledgeScrapeError';
-import { $provideBrowserForServer } from '../../tools/$provideBrowserForServer';
-
-/**
- * Pattern for live-preview session identifiers created by the browser client.
- */
-const LIVE_PAGE_PREVIEW_SESSION_ID_PATTERN = /^[a-zA-Z0-9_-]{1,128}$/;
-
-/**
- * Navigation timeout for opening a live knowledge preview page.
- */
-const LIVE_PAGE_PREVIEW_NAVIGATION_TIMEOUT_MS = 30_000;
-
-/**
- * Playwright action timeout for live-preview interactions.
- */
-const LIVE_PAGE_PREVIEW_ACTION_TIMEOUT_MS = 5_000;
-
-/**
- * Idle session lifetime before a stale live-preview page is closed.
- */
-const LIVE_PAGE_PREVIEW_SESSION_IDLE_TIMEOUT_MS = 60_000;
-
-/**
- * Multipart response boundary used by the live-preview image stream.
- */
-const LIVE_PAGE_PREVIEW_STREAM_BOUNDARY = 'page-preview-frame';
-
-/**
- * Delay between live-preview browser frames.
- */
-const LIVE_PAGE_PREVIEW_FRAME_INTERVAL_MS = 500;
-
-/**
- * JPEG quality for live-preview browser frames.
- */
-const LIVE_PAGE_PREVIEW_JPEG_QUALITY = 65;
-
-/**
- * Browser page stored for a live knowledge preview session.
- */
-type LivePagePreviewSession = {
-    readonly page: Page;
-    readonly url: string;
-    lastAccessedAt: number;
-};
-
-/**
- * Pointer interaction sent from the live preview image to the browser page.
- */
-type LivePagePreviewClickInteraction = {
-    readonly type: 'click';
-    readonly x: number;
-    readonly y: number;
-};
-
-/**
- * Wheel interaction sent from the live preview image to the browser page.
- */
-type LivePagePreviewWheelInteraction = {
-    readonly type: 'wheel';
-    readonly deltaX: number;
-    readonly deltaY: number;
-};
-
-/**
- * Keyboard interaction sent from the live preview image to the browser page.
- */
-type LivePagePreviewKeyDownInteraction = {
-    readonly type: 'keyDown';
-    readonly key: string;
-};
-
-/**
- * Supported interaction payload for a live knowledge preview session.
- */
-export type LivePagePreviewInteraction =
-    | LivePagePreviewClickInteraction
-    | LivePagePreviewWheelInteraction
-    | LivePagePreviewKeyDownInteraction;
-
-/**
- * Active browser pages for live knowledge previews.
- */
-const LIVE_PAGE_PREVIEW_SESSIONS = new Map<string, LivePagePreviewSession>();
-
-/**
- * Content type for the live-preview multipart image stream.
- */
-export const LIVE_PAGE_PREVIEW_STREAM_CONTENT_TYPE = `multipart/x-mixed-replace; boundary=${LIVE_PAGE_PREVIEW_STREAM_BOUNDARY}`;
-
-/**
- * Checks whether a live-preview session identifier is safe to use as a map key.
- *
- * @param sessionId - Candidate session identifier.
- * @returns True when the value is a valid live-preview session id.
- */
-export function isLivePagePreviewSessionId(sessionId: string): boolean {
-    return LIVE_PAGE_PREVIEW_SESSION_ID_PATTERN.test(sessionId);
-}
-
-/**
- * Opens or reuses the browser page for one live knowledge preview.
- *
- * @param options - Session, target URL, and request cancellation signal.
- * @returns Playwright page backing the live preview.
- */
-export async function getOrCreateLivePagePreviewSession(options: {
-    readonly sessionId: string;
-    readonly url: string;
-    readonly signal: AbortSignal;
-}): Promise<Page> {
-    pruneExpiredLivePagePreviewSessions();
-
-    const existingSession = LIVE_PAGE_PREVIEW_SESSIONS.get(options.sessionId);
-    if (existingSession && existingSession.url === options.url && !existingSession.page.isClosed()) {
-        existingSession.lastAccessedAt = Date.now();
-        return existingSession.page;
-    }
-
-    if (existingSession) {
-        await closeLivePagePreviewSession(options.sessionId);
-    }
-
-    const browserContext = await $provideBrowserForServer({
-        signal: options.signal,
-        sessionId: options.sessionId,
-    });
-    const page = await browserContext.newPage();
-
-    try {
-        page.setDefaultNavigationTimeout(LIVE_PAGE_PREVIEW_NAVIGATION_TIMEOUT_MS);
-        page.setDefaultTimeout(LIVE_PAGE_PREVIEW_ACTION_TIMEOUT_MS);
-        await page.setViewportSize({
-            width: LIVE_PAGE_PREVIEW_VIEWPORT_WIDTH,
-            height: LIVE_PAGE_PREVIEW_VIEWPORT_HEIGHT,
-        });
-        await page.goto(options.url, {
-            waitUntil: 'domcontentloaded',
-            timeout: LIVE_PAGE_PREVIEW_NAVIGATION_TIMEOUT_MS,
-        });
-    } catch {
-        await closeLivePagePreviewPage(page);
-        throw new KnowledgeScrapeError(
-            spaceTrim(`
-                Failed to open live knowledge preview for \`${options.url}\`.
-
-                The browser session could not navigate to the requested source.
-            `),
-        );
-    }
-
-    LIVE_PAGE_PREVIEW_SESSIONS.set(options.sessionId, {
-        page,
-        url: options.url,
-        lastAccessedAt: Date.now(),
-    });
-
-    return page;
-}
-
-/**
- * Closes one live knowledge preview session if it exists.
- *
- * @param sessionId - Live-preview session identifier.
- */
-export async function closeLivePagePreviewSession(sessionId: string): Promise<void> {
-    const existingSession = LIVE_PAGE_PREVIEW_SESSIONS.get(sessionId);
-    if (!existingSession) {
-        return;
-    }
-
-    LIVE_PAGE_PREVIEW_SESSIONS.delete(sessionId);
-    await closeLivePagePreviewPage(existingSession.page);
-}
-
-/**
- * Creates an MJPEG stream from an active live-preview browser page.
- *
- * @param options - Session identifier, browser page, and request cancellation signal.
- * @returns Readable stream that emits JPEG browser frames until the client disconnects.
- */
-export function createLivePagePreviewStream(options: {
-    readonly sessionId: string;
-    readonly page: Page;
-    readonly signal: AbortSignal;
-}): ReadableStream<Uint8Array> {
-    const encoder = new TextEncoder();
-    let isStreamClosed = false;
-    let isSessionClosed = false;
-
-    const closeSessionOnce = async (): Promise<void> => {
-        if (isSessionClosed) {
-            return;
-        }
-
-        isSessionClosed = true;
-        await closeLivePagePreviewSession(options.sessionId);
-    };
-
-    return new ReadableStream<Uint8Array>({
-        async start(controller) {
-            const handleAbort = (): void => {
-                isStreamClosed = true;
-                void closeSessionOnce();
-            };
-
-            options.signal.addEventListener('abort', handleAbort, { once: true });
-
-            try {
-                while (!isStreamClosed && !options.signal.aborted && !options.page.isClosed()) {
-                    const buffer = await options.page.screenshot({
-                        type: 'jpeg',
-                        quality: LIVE_PAGE_PREVIEW_JPEG_QUALITY,
-                    });
-
-                    if (isStreamClosed || options.signal.aborted || options.page.isClosed()) {
-                        break;
-                    }
-
-                    const header = [
-                        '',
-                        `--${LIVE_PAGE_PREVIEW_STREAM_BOUNDARY}`,
-                        'Content-Type: image/jpeg',
-                        `Content-Length: ${buffer.length}`,
-                        '',
-                        '',
-                    ].join('\r\n');
-
-                    controller.enqueue(encoder.encode(header));
-                    controller.enqueue(buffer);
-
-                    await waitForLivePagePreviewFrame(options.signal);
-                }
-            } catch (error) {
-                if (!isStreamClosed && !options.signal.aborted) {
-                    console.error('Error streaming live page preview:', error);
-                }
-            } finally {
-                isStreamClosed = true;
-                options.signal.removeEventListener('abort', handleAbort);
-                await closeSessionOnce();
-
-                try {
-                    controller.close();
-                } catch {
-                    // The client can disconnect before the server closes the stream.
-                }
-            }
-        },
-        async cancel() {
-            isStreamClosed = true;
-            await closeSessionOnce();
-        },
-    });
-}
-
-/**
- * Applies one browser interaction to an active live preview session.
- *
- * @param options - Session identifier and normalized interaction.
- * @returns True when the interaction was applied to an active session.
- */
-export async function applyLivePagePreviewInteraction(options: {
-    readonly sessionId: string;
-    readonly interaction: LivePagePreviewInteraction;
-}): Promise<boolean> {
-    const session = LIVE_PAGE_PREVIEW_SESSIONS.get(options.sessionId);
-    if (!session || session.page.isClosed()) {
-        LIVE_PAGE_PREVIEW_SESSIONS.delete(options.sessionId);
-        return false;
-    }
-
-    session.lastAccessedAt = Date.now();
-
-    switch (options.interaction.type) {
-        case 'click':
-            await session.page.mouse.click(
-                clampLivePagePreviewCoordinate(options.interaction.x, LIVE_PAGE_PREVIEW_VIEWPORT_WIDTH),
-                clampLivePagePreviewCoordinate(options.interaction.y, LIVE_PAGE_PREVIEW_VIEWPORT_HEIGHT),
-            );
-            return true;
-
-        case 'wheel':
-            await session.page.mouse.wheel(options.interaction.deltaX, options.interaction.deltaY);
-            return true;
-
-        case 'keyDown':
-            await session.page.keyboard.press(options.interaction.key);
-            return true;
-    }
-}
-
-/**
- * Removes stale live-preview sessions left behind by disconnected clients.
- */
-function pruneExpiredLivePagePreviewSessions(): void {
-    const now = Date.now();
-    for (const [sessionId, session] of LIVE_PAGE_PREVIEW_SESSIONS) {
-        const isExpired = now - session.lastAccessedAt > LIVE_PAGE_PREVIEW_SESSION_IDLE_TIMEOUT_MS;
-        if (isExpired || session.page.isClosed()) {
-            LIVE_PAGE_PREVIEW_SESSIONS.delete(sessionId);
-            void closeLivePagePreviewPage(session.page);
-        }
-    }
-}
-
-/**
- * Waits between streamed browser frames, resolving early when the request is aborted.
- *
- * @param signal - Request cancellation signal.
- */
-async function waitForLivePagePreviewFrame(signal: AbortSignal): Promise<void> {
-    if (signal.aborted) {
-        return;
-    }
-
-    await new Promise<void>((resolve) => {
-        const timeout = setTimeout(() => {
-            signal.removeEventListener('abort', handleAbort);
-            resolve();
-        }, LIVE_PAGE_PREVIEW_FRAME_INTERVAL_MS);
-
-        function handleAbort(): void {
-            clearTimeout(timeout);
-            resolve();
-        }
-
-        signal.addEventListener('abort', handleAbort, { once: true });
-    });
-}
-
-/**
- * Closes a Playwright page while ignoring cleanup errors.
- *
- * @param page - Browser page to close.
- */
-async function closeLivePagePreviewPage(page: Page): Promise<void> {
-    if (page.isClosed()) {
-        return;
-    }
-
-    await page.close().catch(() => undefined);
-}
-
-/**
- * Clamps a pointer coordinate to the configured live-preview viewport.
- *
- * @param value - Raw coordinate from the web UI.
- * @param maximum - Maximum coordinate value for one axis.
- * @returns Coordinate safe to pass into Playwright.
- */
-function clampLivePagePreviewCoordinate(value: number, maximum: number): number {
-    if (!Number.isFinite(value)) {
-        return 0;
-    }
-
-    return Math.min(Math.max(value, 0), maximum);
-}

package/apps/agents-server/src/utils/pagePreview/resolvePagePreviewRequestUrl.ts

@@ -1,74 +0,0 @@
-import type { NextRequest } from 'next/server';
-import { NextResponse } from 'next/server';
-import { assertsError } from '../../../../../src/errors/assertsError';
-import { assertSafeUrl } from '../assertSafeUrl';
-import { getCurrentUser } from '../getCurrentUser';
-
-/**
- * Query parameter used by page-preview API endpoints.
- */
-const PAGE_PREVIEW_URL_QUERY_PARAMETER = 'url';
-
-/**
- * Successful page-preview request URL resolution.
- */
-type PagePreviewRequestUrlSuccess = {
-    readonly url: string;
-    readonly errorResponse: null;
-};
-
-/**
- * Failed page-preview request URL resolution.
- */
-type PagePreviewRequestUrlFailure = {
-    readonly url: null;
-    readonly errorResponse: NextResponse;
-};
-
-/**
- * Result of authenticating and validating a page-preview request URL.
- */
-export type PagePreviewRequestUrlResolution = PagePreviewRequestUrlSuccess | PagePreviewRequestUrlFailure;
-
-/**
- * Authenticates a page-preview request and validates its target URL against SSRF-sensitive destinations.
- *
- * @param request - Incoming Next.js request.
- * @returns Valid target URL or a ready-made error response.
- */
-export async function resolvePagePreviewRequestUrl(request: NextRequest): Promise<PagePreviewRequestUrlResolution> {
-    const currentUser = await getCurrentUser();
-    if (!currentUser) {
-        return {
-            url: null,
-            errorResponse: NextResponse.json({ error: 'Unauthorized' }, { status: 401 }),
-        };
-    }
-
-    const url = request.nextUrl.searchParams.get(PAGE_PREVIEW_URL_QUERY_PARAMETER);
-
-    if (!url) {
-        return {
-            url: null,
-            errorResponse: NextResponse.json(
-                { error: `Missing required query parameter: ${PAGE_PREVIEW_URL_QUERY_PARAMETER}` },
-                { status: 400 },
-            ),
-        };
-    }
-
-    try {
-        assertSafeUrl(url);
-    } catch (error) {
-        assertsError(error);
-        return {
-            url: null,
-            errorResponse: NextResponse.json({ error: error.message }, { status: 400 }),
-        };
-    }
-
-    return {
-        url,
-        errorResponse: null,
-    };
-}

package/apps/agents-server/src/utils/userChat/createUserChatRunnerProgressCard.ts

@@ -1,57 +0,0 @@
-import type { ChatMessage } from '@promptbook-local/types';
-import { spaceTrim } from '../../../../../src/_packages/utils.index';
-
-/**
- * Runner types that can own durable chat work outside the browser request.
- */
-export type UserChatRunnerKind = 'local' | 'external';
-
-/**
- * Runner progress phases visible before a final answer is available.
- */
-export type UserChatRunnerProgressPhase = 'queued_for_runner';
-
-/**
- * User-facing labels for durable chat runners.
- */
-const USER_CHAT_RUNNER_LABELS: Record<UserChatRunnerKind, string> = {
-    local: 'local agent runner',
-    external: 'external agent runner',
-};
-
-/**
- * Creates a progress card for the observable state of an out-of-process chat runner.
- *
- * @param options - Runner kind and current progress phase.
- * @returns Progress card with one concise real runner state.
- */
-export function createUserChatRunnerProgressCard(options: {
-    readonly runnerKind: UserChatRunnerKind;
-    readonly phase: UserChatRunnerProgressPhase;
-}): NonNullable<ChatMessage['progressCard']> {
-    return {
-        now: createUserChatRunnerProgressNowText(options),
-        items: [],
-        updatedAt: new Date().toISOString() as NonNullable<ChatMessage['progressCard']>['updatedAt'],
-        isVisible: true,
-    };
-}
-
-/**
- * Creates the current runner-state text shown in the progress card.
- *
- * @private internal helper of `createUserChatRunnerProgressCard`
- */
-function createUserChatRunnerProgressNowText(options: {
-    readonly runnerKind: UserChatRunnerKind;
-    readonly phase: UserChatRunnerProgressPhase;
-}): string {
-    const runnerLabel = USER_CHAT_RUNNER_LABELS[options.runnerKind];
-
-    switch (options.phase) {
-        case 'queued_for_runner':
-            return spaceTrim(`
-                The ${runnerLabel} has the request and is working on the answer.
-            `);
-    }
-}

package/esm/scripts/run-codex-prompts/common/resolveAgentSystemMessage.d.ts

@@ -1,6 +0,0 @@
-/**
- * Reads an optional agent `.book` file and compiles its system message for injection into coder prompts.
- *
- * Returns `undefined` when no agent path is provided.
- */
-export declare function resolveAgentSystemMessage(agentPath: string | undefined, currentWorkingDirectory: string): Promise<string | undefined>;

package/esm/src/book-components/Chat/utils/livePagePreviewConstants.d.ts

@@ -1,12 +0,0 @@
-/**
- * Width of the browser viewport used for live knowledge previews.
- *
- * @private shared constant of Agents Server knowledge previews
- */
-export declare const LIVE_PAGE_PREVIEW_VIEWPORT_WIDTH = 1280;
-/**
- * Height of the browser viewport used for live knowledge previews.
- *
- * @private shared constant of Agents Server knowledge previews
- */
-export declare const LIVE_PAGE_PREVIEW_VIEWPORT_HEIGHT = 800;

package/src/book-components/Chat/utils/livePagePreviewConstants.ts

@@ -1,17 +0,0 @@
-/* eslint-disable no-magic-numbers */
-
-// Note: [💞] Ignore a discrepancy between file name and exported helper names
-
-/**
- * Width of the browser viewport used for live knowledge previews.
- *
- * @private shared constant of Agents Server knowledge previews
- */
-export const LIVE_PAGE_PREVIEW_VIEWPORT_WIDTH = 1280;
-
-/**
- * Height of the browser viewport used for live knowledge previews.
- *
- * @private shared constant of Agents Server knowledge previews
- */
-export const LIVE_PAGE_PREVIEW_VIEWPORT_HEIGHT = 800;

package/umd/scripts/run-codex-prompts/common/resolveAgentSystemMessage.d.ts

@@ -1,6 +0,0 @@
-/**
- * Reads an optional agent `.book` file and compiles its system message for injection into coder prompts.
- *
- * Returns `undefined` when no agent path is provided.
- */
-export declare function resolveAgentSystemMessage(agentPath: string | undefined, currentWorkingDirectory: string): Promise<string | undefined>;

package/umd/src/book-components/Chat/utils/livePagePreviewConstants.d.ts

@@ -1,12 +0,0 @@
-/**
- * Width of the browser viewport used for live knowledge previews.
- *
- * @private shared constant of Agents Server knowledge previews
- */
-export declare const LIVE_PAGE_PREVIEW_VIEWPORT_WIDTH = 1280;
-/**
- * Height of the browser viewport used for live knowledge previews.
- *
- * @private shared constant of Agents Server knowledge previews
- */
-export declare const LIVE_PAGE_PREVIEW_VIEWPORT_HEIGHT = 800;