@promptbook/cli 0.112.0-104 → 0.112.0-105

package/apps/agents-server/src/utils/defaultAgents/defaultAgents.ts

@@ -1,168 +0,0 @@
-import { readdir, readFile } from 'fs/promises';
-import { join } from 'path';
-import type { AgentBasicInformation, AgentCollection, string_book } from '@promptbook-local/types';
-import { parseAgentSource } from '../../../../../src/book-2.0/agent-source/parseAgentSource';
-import { DEFAULT_AGENT_VISIBILITY } from '../agentVisibility';
-
-/**
- * Installation status for one default agent book.
- *
- * @private shared utility for Agents Server default-agent installation
- */
-export type DefaultAgentInstallStatus = 'installed' | 'skipped';
-
-/**
- * Result for one processed default agent book.
- *
- * @private shared utility for Agents Server default-agent installation
- */
-export type DefaultAgentInstallRecord = {
-    /**
-     * Source book filename.
-     */
-    readonly fileName: string;
-
-    /**
-     * Parsed canonical agent name.
-     */
-    readonly agentName: string;
-
-    /**
-     * Whether the agent was created or skipped because an active agent with the same name already exists.
-     */
-    readonly status: DefaultAgentInstallStatus;
-
-    /**
-     * Permanent id of the newly created agent, if created.
-     */
-    readonly permanentId?: string;
-};
-
-/**
- * Aggregate default-agent installation result.
- *
- * @private shared utility for Agents Server default-agent installation
- */
-export type DefaultAgentInstallResult = {
-    /**
-     * Number of newly created agents.
-     */
-    readonly installedCount: number;
-
-    /**
-     * Number of already-present agents skipped by name.
-     */
-    readonly skippedCount: number;
-
-    /**
-     * Per-book processing records.
-     */
-    readonly records: ReadonlyArray<DefaultAgentInstallRecord>;
-};
-
-/**
- * Options for installing default agents from a directory.
- *
- * @private shared utility for Agents Server default-agent installation
- */
-export type InstallDefaultAgentsFromDirectoryOptions = {
-    /**
-     * Agent collection used for persistence.
-     */
-    readonly collection: AgentCollection;
-
-    /**
-     * Directory containing the repository default `*.book` files.
-     */
-    readonly defaultAgentsDirectoryPath: string;
-
-    /**
-     * Optional logger for install-time progress.
-     */
-    readonly logger?: Pick<Console, 'info'>;
-};
-
-/**
- * Lists repository default book filenames in stable install order.
- *
- * @param defaultAgentsDirectoryPath - Directory containing default `*.book` files.
- * @returns Sorted book filenames.
- *
- * @private shared utility for Agents Server default-agent installation
- */
-export async function listDefaultAgentBookFileNames(defaultAgentsDirectoryPath: string): Promise<ReadonlyArray<string>> {
-    const directoryEntries = await readdir(defaultAgentsDirectoryPath, { withFileTypes: true });
-
-    return directoryEntries
-        .filter((entry) => entry.isFile() && entry.name.endsWith('.book'))
-        .map((entry) => entry.name)
-        .sort((left, right) => left.localeCompare(right));
-}
-
-/**
- * Creates default agents from repository `*.book` files, skipping already-active agents with matching names.
- *
- * @param options - Installation options.
- * @returns Aggregate installation result.
- *
- * @private shared utility for Agents Server default-agent installation
- */
-export async function installDefaultAgentsFromDirectory(
-    options: InstallDefaultAgentsFromDirectoryOptions,
-): Promise<DefaultAgentInstallResult> {
-    const fileNames = await listDefaultAgentBookFileNames(options.defaultAgentsDirectoryPath);
-    const existingAgentNames = new Set((await options.collection.listAgents()).map((agent) => agent.agentName));
-    const records: Array<DefaultAgentInstallRecord> = [];
-
-    for (const [index, fileName] of fileNames.entries()) {
-        const agentSource = (await readFile(join(options.defaultAgentsDirectoryPath, fileName), 'utf-8')) as string_book;
-        const parsedAgentProfile = parseAgentSource(agentSource);
-        const agentName = parsedAgentProfile.agentName;
-
-        if (existingAgentNames.has(agentName)) {
-            options.logger?.info(`[default-agents] Skipping existing agent "${agentName}" from ${fileName}.`);
-            records.push({
-                fileName,
-                agentName,
-                status: 'skipped',
-            });
-            continue;
-        }
-
-        const createdAgent = await options.collection.createAgent(agentSource, {
-            sortOrder: index + 1,
-            visibility: DEFAULT_AGENT_VISIBILITY,
-        });
-
-        existingAgentNames.add(createdAgent.agentName);
-        options.logger?.info(`[default-agents] Installed "${createdAgent.agentName}" from ${fileName}.`);
-        records.push(createInstalledDefaultAgentRecord(fileName, createdAgent));
-    }
-
-    return {
-        installedCount: records.filter((record) => record.status === 'installed').length,
-        skippedCount: records.filter((record) => record.status === 'skipped').length,
-        records,
-    };
-}
-
-/**
- * Creates a typed result record for a newly installed default agent.
- *
- * @param fileName - Source book filename.
- * @param createdAgent - Created agent profile returned by the collection.
- * @returns Installation record.
- *
- * @private utility of `installDefaultAgentsFromDirectory`
- */
-function createInstalledDefaultAgentRecord(
-    fileName: string,
-    createdAgent: AgentBasicInformation & Required<Pick<AgentBasicInformation, 'permanentId'>>,
-): DefaultAgentInstallRecord {
-    return {
-        fileName,
-        agentName: createdAgent.agentName,
-        status: 'installed',
-        permanentId: createdAgent.permanentId,
-    };
-}

package/apps/agents-server/src/utils/defaultAgents/installDefaultAgents.ts

@@ -1,139 +0,0 @@
-import * as dotenv from 'dotenv';
-import { createClient, type SupabaseClient } from '@supabase/supabase-js';
-import { AgentCollectionInSupabase } from '../../../../../src/collection/agent-collection/constructors/agent-collection-in-supabase/AgentCollectionInSupabase';
-import type { AgentCollection } from '../../../../../src/collection/agent-collection/AgentCollection';
-import { isAgentsServerSqliteMode } from '../../database/agentsServerDatabaseMode';
-import { $provideLocalSqliteSupabase } from '../../database/sqlite/$provideLocalSqliteSupabase';
-import { installDefaultAgentsFromDirectory } from './defaultAgents';
-
-/**
- * Environment variable pointing to the installed Agents Server `.env` file.
- *
- * @private install-time default-agent utility
- */
-const AGENTS_SERVER_ENV_FILE_ENV_NAME = 'PTBK_AGENTS_SERVER_ENV_FILE';
-
-/**
- * Environment variable pointing to the repository `agents/default` directory.
- *
- * @private install-time default-agent utility
- */
-const DEFAULT_AGENTS_DIRECTORY_ENV_NAME = 'PTBK_DEFAULT_AGENTS_DIR';
-
-/**
- * Environment variable containing the current server table prefix.
- *
- * @private install-time default-agent utility
- */
-const SUPABASE_TABLE_PREFIX_ENV_NAME = 'SUPABASE_TABLE_PREFIX';
-
-/**
- * Public Supabase URL environment variable.
- *
- * @private install-time default-agent utility
- */
-const NEXT_PUBLIC_SUPABASE_URL_ENV_NAME = 'NEXT_PUBLIC_SUPABASE_URL';
-
-/**
- * Supabase service role key environment variable.
- *
- * @private install-time default-agent utility
- */
-const SUPABASE_SERVICE_ROLE_KEY_ENV_NAME = 'SUPABASE_SERVICE_ROLE_KEY';
-
-/**
- * Public Supabase anon key environment variable used as a fallback when service role is unavailable.
- *
- * @private install-time default-agent utility
- */
-const NEXT_PUBLIC_SUPABASE_ANON_KEY_ENV_NAME = 'NEXT_PUBLIC_SUPABASE_ANON_KEY';
-
-/**
- * Loads the installed Agents Server environment for the detached installer script.
- *
- * @private install-time default-agent utility
- */
-function loadDefaultAgentInstallEnvironment(): void {
-    const explicitEnvFilePath = process.env[AGENTS_SERVER_ENV_FILE_ENV_NAME]?.trim();
-    if (explicitEnvFilePath) {
-        const explicitLoadResult = dotenv.config({ path: explicitEnvFilePath });
-        if (!explicitLoadResult.error) {
-            return;
-        }
-    }
-
-    dotenv.config();
-}
-
-/**
- * Creates the install-time agent collection using the same database backend as the server.
- *
- * @returns Agent collection bound to the configured table prefix.
- *
- * @private install-time default-agent utility
- */
-function createDefaultAgentInstallCollection(): AgentCollection {
-    return new AgentCollectionInSupabase(createDefaultAgentInstallSupabaseClient(), {
-        tablePrefix: process.env[SUPABASE_TABLE_PREFIX_ENV_NAME] || '',
-    });
-}
-
-/**
- * Creates the Supabase-shaped client used by the install-time agent collection.
- *
- * @returns Supabase or local SQLite client.
- *
- * @private install-time default-agent utility
- */
-function createDefaultAgentInstallSupabaseClient(): SupabaseClient {
-    if (isAgentsServerSqliteMode()) {
-        return $provideLocalSqliteSupabase();
-    }
-
-    const supabaseUrl = process.env[NEXT_PUBLIC_SUPABASE_URL_ENV_NAME];
-    const supabaseKey =
-        process.env[SUPABASE_SERVICE_ROLE_KEY_ENV_NAME] || process.env[NEXT_PUBLIC_SUPABASE_ANON_KEY_ENV_NAME];
-
-    if (!supabaseUrl || !supabaseKey) {
-        throw new Error(
-            `Missing \`${NEXT_PUBLIC_SUPABASE_URL_ENV_NAME}\` and \`${SUPABASE_SERVICE_ROLE_KEY_ENV_NAME}\` for Supabase default-agent installation.`,
-        );
-    }
-
-    return createClient(supabaseUrl, supabaseKey, {
-        auth: {
-            autoRefreshToken: false,
-            persistSession: false,
-        },
-    });
-}
-
-/**
- * Runs the default-agent install command.
- *
- * @private install-time default-agent utility
- */
-async function installDefaultAgents(): Promise<void> {
-    loadDefaultAgentInstallEnvironment();
-
-    const defaultAgentsDirectoryPath = process.env[DEFAULT_AGENTS_DIRECTORY_ENV_NAME]?.trim();
-    if (!defaultAgentsDirectoryPath) {
-        throw new Error(`Missing \`${DEFAULT_AGENTS_DIRECTORY_ENV_NAME}\` environment variable.`);
-    }
-
-    const result = await installDefaultAgentsFromDirectory({
-        collection: createDefaultAgentInstallCollection(),
-        defaultAgentsDirectoryPath,
-        logger: console,
-    });
-
-    console.info(
-        `[default-agents] Finished. Installed ${result.installedCount}, skipped ${result.skippedCount}.`,
-    );
-}
-
-installDefaultAgents().catch((error) => {
-    console.error('[default-agents] Failed to install default agents.');
-    console.error(error instanceof Error ? error.message : error);
-    process.exitCode = 1;
-});

package/apps/agents-server/tests/e2e/authentication-and-navigation.spec.ts.todo

@@ -1,178 +0,0 @@
-import { expect, test, type Page } from 'playwright/test';
-import { loginAsAdmin, logoutFromHeader } from './support/auth';
-import { openHeaderMenu } from './support/navigation';
-
-/**
- * Emulates a coarse-pointer touch environment while keeping desktop viewport width.
- *
- * @param page - Current Playwright page.
- */
-async function emulateTouchInput(page: Page) {
-    await page.addInitScript(() => {
-        const originalMatchMedia = window.matchMedia.bind(window);
-
-        Object.defineProperty(navigator, 'maxTouchPoints', {
-            configurable: true,
-            get: () => 5,
-        });
-
-        Object.defineProperty(window, 'ontouchstart', {
-            configurable: true,
-            value: null,
-        });
-
-        window.matchMedia = (query: string): MediaQueryList => {
-            if (query === '(hover: none) and (pointer: coarse)') {
-                return {
-                    matches: true,
-                    media: query,
-                    onchange: null,
-                    addListener: () => void 0,
-                    removeListener: () => void 0,
-                    addEventListener: () => void 0,
-                    removeEventListener: () => void 0,
-                    dispatchEvent: () => false,
-                } as MediaQueryList;
-            }
-
-            return originalMatchMedia(query);
-        };
-    });
-}
-
-/**
- * Creates a new agent through the homepage dialog and waits for its profile page.
- *
- * @param page - Current Playwright page.
- */
-async function createAgentViaHomepageDialog(page: Page): Promise<void> {
-    const addAgentCard = page.getByText('Add New Agent');
-    await expect(addAgentCard).toBeVisible();
-    await addAgentCard.click();
-
-    await expect(page.getByRole('heading', { name: 'Create New Agent' })).toBeVisible();
-    await page.getByRole('button', { name: 'Create Agent' }).click();
-    await expect(page).toHaveURL(/\/agents\/[^/?#]+$/);
-}
-
-/**
- * Opens the `System` menu and expands the `My Account` category.
- *
- * @param page - Current Playwright page.
- */
-async function openSystemMyAccountMenu(page: Page): Promise<void> {
-    await openHeaderMenu(page, 'System');
-    const myAccountButton = page.getByRole('button', { name: 'My Account' });
-    await expect(myAccountButton).toBeVisible();
-    await myAccountButton.hover();
-}
-
-/**
- * Clicks one link inside the `System > My Account` nested submenu.
- *
- * @param page - Current Playwright page.
- * @param linkName - Visible text of the destination link.
- */
-async function clickSystemMyAccountLink(page: Page, linkName: string): Promise<void> {
-    await openSystemMyAccountMenu(page);
-
-    const nestedMenuPortal = page.locator('[data-header-dropdown-portal="true"]');
-    await expect(nestedMenuPortal).toBeAttached();
-
-    const nestedLink = nestedMenuPortal.getByRole('link', { name: linkName });
-    await expect(nestedLink).toBeVisible();
-    await nestedLink.click();
-}
-
-/**
- * Core authentication and navigation integration flows for Agents Server.
- */
-test.describe('Agents Server authentication and navigation', () => {
-    test('shows forbidden state for protected System page when anonymous', async ({ page }) => {
-        await page.goto('/system/profile');
-        await expect(page.getByRole('heading', { name: '403 Forbidden' })).toBeVisible();
-        await expect(page.getByLabel('Username')).toBeVisible();
-    });
-
-    test('allows admin to sign in, navigate major menus, and sign out', async ({ page }) => {
-        await page.goto('/');
-        await expect(page.getByRole('link', { name: 'Promptbook Agents Server' })).toBeVisible();
-
-        await loginAsAdmin(page);
-        await expect(page.getByRole('button', { name: 'System' })).toBeVisible();
-
-        await openHeaderMenu(page, 'Documentation');
-        await page.getByRole('link', { name: 'Overview' }).click();
-        await expect(page).toHaveURL(/\/docs$/);
-        await expect(page.getByRole('heading', { name: 'Documentation' })).toBeVisible();
-
-        await page.goto('/docs/PERSONA');
-        await expect(page.getByRole('heading', { name: 'PERSONA', exact: true })).toBeVisible();
-
-        await clickSystemMyAccountLink(page, 'Profile');
-        await expect(page).toHaveURL(/\/system\/profile$/);
-        await expect(page.getByRole('heading', { name: 'Profile' })).toBeVisible();
-
-        await clickSystemMyAccountLink(page, 'User Memory');
-        await expect(page).toHaveURL(/\/system\/user-memory$/);
-        await expect(page.getByRole('heading', { name: 'User Memory' })).toBeVisible();
-
-        await logoutFromHeader(page);
-    });
-
-    test('keeps nested header submenu items tappable on touch devices', async ({ page }) => {
-        await emulateTouchInput(page);
-        await page.goto('/');
-
-        await loginAsAdmin(page);
-        await openHeaderMenu(page, 'Documentation');
-
-        const allSubmenuButton = page.getByRole('button', { name: /^All$/ });
-        await expect(allSubmenuButton).toBeVisible();
-        await allSubmenuButton.click();
-
-        const personaLink = page.getByRole('link', { name: /^PERSONA\b/ });
-        await expect(personaLink).toBeVisible();
-        await personaLink.click();
-
-        await expect(page).toHaveURL(/\/docs\/PERSONA$/);
-        await expect(page.getByRole('heading', { name: 'PERSONA', exact: true })).toBeVisible();
-    });
-
-    test('protects clone prompt against accidental close when the input is dirty', async ({ page }) => {
-        await page.goto('/');
-        await loginAsAdmin(page);
-        await createAgentViaHomepageDialog(page);
-
-        await page.getByRole('button', { name: 'More options' }).click();
-        await page.getByRole('button', { name: 'Clone agent' }).click();
-        const cloneHeading = page.getByRole('heading', { name: 'Clone agent' });
-        const cloneInput = page.getByLabel('Agent name');
-
-        await expect(cloneHeading).toBeVisible();
-        await cloneInput.fill('Clone name draft');
-
-        let dismissedDiscardDialog = false;
-        page.once('dialog', async (dialog) => {
-            dismissedDiscardDialog = true;
-            expect(dialog.type()).toBe('confirm');
-            await dialog.dismiss();
-        });
-
-        await page.mouse.click(8, 8);
-        await expect.poll(() => dismissedDiscardDialog).toBe(true);
-        await expect(cloneHeading).toBeVisible();
-        await expect(cloneInput).toHaveValue('Clone name draft');
-
-        let acceptedDiscardDialog = false;
-        page.once('dialog', async (dialog) => {
-            acceptedDiscardDialog = true;
-            expect(dialog.type()).toBe('confirm');
-            await dialog.accept();
-        });
-
-        await page.keyboard.press('Escape');
-        await expect.poll(() => acceptedDiscardDialog).toBe(true);
-        await expect(cloneHeading).toBeHidden();
-    });
-});

package/src/_packages/browser.index.ts

@@ -1,31 +0,0 @@
-// ⚠️ WARNING: This code has been generated so that any manual changes will be overwritten
-// `@promptbook/browser`
-
-import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
-import { getAllCommitmentsToolFunctionsForBrowser } from '../commitments/_common/getAllCommitmentsToolFunctionsForBrowser';
-import { SimplePromptInterfaceTools } from '../dialogs/simple-prompt/SimplePromptInterfaceTools';
-import { $provideScrapersForBrowser } from '../scrapers/_common/register/$provideScrapersForBrowser';
-import { BrowserSpeechRecognition } from '../speech-recognition/BrowserSpeechRecognition';
-import { getIndexedDbStorage } from '../storage/local-storage/getIndexedDbStorage';
-import { getLocalStorage } from '../storage/local-storage/getLocalStorage';
-import { getSessionStorage } from '../storage/local-storage/getSessionStorage';
-import { $induceBookDownload } from '../utils/files/$induceBookDownload';
-import { $induceFileDownload } from '../utils/files/$induceFileDownload';
-import { ObjectUrl } from '../utils/files/ObjectUrl';
-
-
-// Note: Exporting version from each package
-export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
-
-
-// Note: Entities of the `@promptbook/browser`
-export { getAllCommitmentsToolFunctionsForBrowser };
-export { SimplePromptInterfaceTools };
-export { $provideScrapersForBrowser };
-export { BrowserSpeechRecognition };
-export { getIndexedDbStorage };
-export { getLocalStorage };
-export { getSessionStorage };
-export { $induceBookDownload };
-export { $induceFileDownload };
-export { ObjectUrl };

package/src/_packages/browser.readme.md

@@ -1,43 +0,0 @@
-The browser package provides browser-specific functionality for Promptbook, including localStorage integration, IndexedDB storage, and browser-compatible scrapers. It enables Promptbook to run efficiently in web browser environments.
-
-## 🎯 Purpose and Motivation
-
-This package extends Promptbook's core functionality with browser-specific features that are essential for web applications. It provides browser storage APIs, user interface tools, and browser-compatible scrapers that enable full-featured Promptbook applications in web environments.
-
-## 🔧 High-Level Functionality
-
-The package provides browser-specific integrations and utilities:
-- **Browser Storage**: Integration with localStorage, sessionStorage, and IndexedDB
-- **User Interface Tools**: Simple prompt interface for browser interactions
-- **Browser Scrapers**: Browser-compatible content scrapers
-- **Web Compatibility**: Ensures Promptbook works seamlessly in browser environments
-- **Client-side Caching**: Efficient caching using browser storage APIs
-
-## ✨ Key Features
-
-- 💾 **Multiple Storage Options** - Support for localStorage, sessionStorage, and IndexedDB
-- 🌐 **Browser-native APIs** - Leverage browser-specific capabilities and storage
-- 🎨 **Simple UI Tools** - Basic interface tools for browser-based interactions
-- 📱 **Cross-browser Compatibility** - Works across modern web browsers
-- 🔒 **Client-side Security** - Secure storage and execution in browser sandbox
-- ⚡ **Performance Optimized** - Efficient storage and caching for web applications
-- 🛠️ **Web Scrapers** - Browser-compatible content scraping capabilities
-
-## 📦 Exported Entities
-
-### Version Information
-- `BOOK_LANGUAGE_VERSION` - Current book language version
-- `PROMPTBOOK_ENGINE_VERSION` - Current engine version
-
-### User Interface Tools
-- `SimplePromptInterfaceTools` - Simple prompt interface for browser interactions
-
-### Browser Scrapers
-- `$provideScrapersForBrowser` - Provide browser-compatible knowledge scrapers
-
-### Storage APIs
-- `getIndexedDbStorage` - Get IndexedDB storage implementation
-- `getLocalStorage` - Get localStorage storage implementation
-- `getSessionStorage` - Get sessionStorage storage implementation
-
-> 💡 This package does not make sense on its own, look at [all promptbook packages](#-packages) or just install all by `npm i ptbk`