@promptbook/cli 0.112.0-99 → 0.113.0-0

package/apps/agents-server/src/utils/shibboleth/createShibbolethAuthenticationLogPayload.ts

@@ -1,173 +0,0 @@
-/**
- * Minimal read-only header accessor shared by middleware, route handlers, and server utilities.
- *
- * @private Internal helper of the Shibboleth authentication diagnostics.
- */
-export type ReadonlyHeadersLike = Pick<Headers, 'get'>;
-
-/**
- * One resolved Shibboleth-related attribute included in the diagnostic payload.
- *
- * @private Internal helper of the Shibboleth authentication diagnostics.
- */
-export type ShibbolethAuthenticationLogAttribute = {
-    readonly fieldName: string;
-    readonly headerName: string;
-    readonly fingerprint: string;
-    readonly valueLength: number;
-};
-
-/**
- * Structured, privacy-preserving diagnostic payload for one Shibboleth-related request event.
- *
- * @private Internal helper of the Agents Server authentication diagnostics.
- */
-export type ShibbolethAuthenticationLogPayload = {
-    readonly event: string;
-    readonly pathname?: string;
-    readonly method?: string;
-    readonly hasSessionCookie?: boolean;
-    readonly isSecureSessionCookie?: boolean;
-    readonly headerNames: ReadonlyArray<string>;
-    readonly attributeFields: ReadonlyArray<string>;
-    readonly attributes: ReadonlyArray<ShibbolethAuthenticationLogAttribute>;
-};
-
-/**
- * Context describing where the Shibboleth diagnostic event happened.
- *
- * @private Internal helper of the Shibboleth authentication diagnostics.
- */
-export type CreateShibbolethAuthenticationLogPayloadOptions = {
-    readonly event: string;
-    readonly pathname?: string;
-    readonly method?: string;
-    readonly hasSessionCookie?: boolean;
-    readonly isSecureSessionCookie?: boolean;
-};
-
-type ShibbolethHeaderDefinition = {
-    readonly fieldName: string;
-    readonly headerNames: ReadonlyArray<string>;
-};
-
-const SHIBBOLETH_HEADER_DEFINITIONS: ReadonlyArray<ShibbolethHeaderDefinition> = [
-    { fieldName: 'sessionId', headerNames: ['shib-session-id', 'x-shib-session-id'] },
-    { fieldName: 'sessionIndex', headerNames: ['shib-session-index', 'x-shib-session-index'] },
-    { fieldName: 'sessionExpires', headerNames: ['shib-session-expires', 'x-shib-session-expires'] },
-    { fieldName: 'applicationId', headerNames: ['shib-application-id', 'x-shib-application-id'] },
-    { fieldName: 'remoteUser', headerNames: ['remote-user', 'x-remote-user'] },
-    { fieldName: 'displayName', headerNames: ['displayname', 'x-displayname'] },
-    { fieldName: 'mail', headerNames: ['mail', 'x-mail'] },
-    { fieldName: 'unstructuredName', headerNames: ['unstructuredname', 'x-unstructuredname'] },
-    {
-        fieldName: 'eduPersonPrincipalName',
-        headerNames: ['edupersonprincipalname', 'eppn', 'x-edupersonprincipalname', 'x-eppn'],
-    },
-    { fieldName: 'persistentId', headerNames: ['persistent-id', 'x-persistent-id'] },
-    { fieldName: 'nameId', headerNames: ['name-id', 'x-name-id'] },
-];
-
-/**
- * Builds a privacy-preserving Shibboleth diagnostic payload from incoming request headers.
- *
- * Only the presence of relevant headers plus short fingerprints of their values are logged,
- * never the raw personally identifiable header contents.
- *
- * @param headers - Request headers or another read-only header accessor.
- * @param options - Event metadata describing where the diagnostic event originated.
- * @returns Structured log payload, or `null` when the request does not look Shibboleth-related.
- *
- * @private Internal helper of the Agents Server authentication diagnostics.
- */
-export function createShibbolethAuthenticationLogPayload(
-    headers: ReadonlyHeadersLike,
-    options: CreateShibbolethAuthenticationLogPayloadOptions,
-): ShibbolethAuthenticationLogPayload | null {
-    const attributes = SHIBBOLETH_HEADER_DEFINITIONS.map((definition) => resolveShibbolethHeader(headers, definition)).filter(
-        (attribute): attribute is ShibbolethAuthenticationLogAttribute => attribute !== null,
-    );
-
-    if (attributes.length === 0) {
-        return null;
-    }
-
-    return {
-        event: options.event,
-        pathname: options.pathname,
-        method: options.method,
-        hasSessionCookie: options.hasSessionCookie,
-        isSecureSessionCookie: options.isSecureSessionCookie,
-        headerNames: attributes.map(({ headerName }) => headerName),
-        attributeFields: attributes.map(({ fieldName }) => fieldName),
-        attributes,
-    };
-}
-
-/**
- * Resolves one Shibboleth attribute from any of its expected header aliases.
- *
- * @param headers - Request header accessor.
- * @param definition - Logical Shibboleth field with supported header aliases.
- * @returns Sanitized attribute snapshot or `null` when absent.
- */
-function resolveShibbolethHeader(
-    headers: ReadonlyHeadersLike,
-    definition: ShibbolethHeaderDefinition,
-): ShibbolethAuthenticationLogAttribute | null {
-    for (const headerName of definition.headerNames) {
-        const rawValue = headers.get(headerName);
-        const value = normalizeHeaderValue(rawValue);
-
-        if (!value) {
-            continue;
-        }
-
-        return {
-            fieldName: definition.fieldName,
-            headerName,
-            fingerprint: createHeaderValueFingerprint(value),
-            valueLength: value.length,
-        };
-    }
-
-    return null;
-}
-
-/**
- * Normalizes one header value before diagnostic processing.
- *
- * @param value - Raw header value.
- * @returns Trimmed non-empty value or `null`.
- */
-function normalizeHeaderValue(value: string | null): string | null {
-    const normalizedValue = value?.trim() || '';
-    return normalizedValue === '' ? null : normalizedValue;
-}
-
-/**
- * Creates a short stable fingerprint so logs can correlate the same identity/session
- * without storing the raw Shibboleth attribute value.
- *
- * @param value - Raw Shibboleth header value.
- * @returns Short deterministic fingerprint.
- */
-function createHeaderValueFingerprint(value: string): string {
-    let hashPrimary = 0xdeadbeef ^ value.length;
-    let hashSecondary = 0x41c6ce57 ^ value.length;
-
-    for (const character of value) {
-        const codePoint = character.codePointAt(0) || 0;
-        hashPrimary = Math.imul(hashPrimary ^ codePoint, 2654435761);
-        hashSecondary = Math.imul(hashSecondary ^ codePoint, 1597334677);
-    }
-
-    hashPrimary =
-        Math.imul(hashPrimary ^ (hashPrimary >>> 16), 2246822507) ^ Math.imul(hashSecondary ^ (hashSecondary >>> 13), 3266489909);
-    hashSecondary =
-        Math.imul(hashSecondary ^ (hashSecondary >>> 16), 2246822507) ^
-        Math.imul(hashPrimary ^ (hashPrimary >>> 13), 3266489909);
-
-    const combinedHash = 4294967296 * (2097151 & hashSecondary) + (hashPrimary >>> 0);
-    return combinedHash.toString(16).padStart(14, '0').slice(0, 12);
-}

package/apps/agents-server/src/utils/shibboleth/writeShibbolethAuthenticationLog.ts

@@ -1,27 +0,0 @@
-import {
-    createShibbolethAuthenticationLogPayload,
-    type CreateShibbolethAuthenticationLogPayloadOptions,
-    type ReadonlyHeadersLike,
-} from './createShibbolethAuthenticationLogPayload';
-
-/**
- * Writes one sanitized Shibboleth diagnostic event to the application logs when
- * the current request carries Shibboleth-related headers.
- *
- * @param headers - Request headers or another read-only header accessor.
- * @param options - Event metadata describing where the diagnostic event originated.
- *
- * @private Internal helper of the Agents Server authentication diagnostics.
- */
-export function writeShibbolethAuthenticationLog(
-    headers: ReadonlyHeadersLike,
-    options: CreateShibbolethAuthenticationLogPayloadOptions,
-): void {
-    const payload = createShibbolethAuthenticationLogPayload(headers, options);
-
-    if (!payload) {
-        return;
-    }
-
-    console.info(`[auth][shibboleth] ${JSON.stringify(payload)}`);
-}

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`