@promptbook/cli 0.112.0-99 → 0.112.0

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`

package/src/book-2.0/agent-source/parseAgentSourceWithCommitments.test.ts.todo

@@ -1,265 +0,0 @@
-// TODO: Uncomment the test
-
-import { describe, expect, it } from '@jest/globals';
-import { spaceTrim } from 'spacetrim';
-import { validateBook } from '../../agent-source/string_book';
-import { parseAgentSourceWithCommitments } from './parseAgentSourceWithCommitments';
-
-describe('parseAgentSourceWithCommitments with multiline support', () => {
-    it('should parse single-line commitments correctly', () => {
-        const agentSource = validateBook(
-            spaceTrim(`
-            Test Agent
-            PERSONA Some persona description
-            KNOWLEDGE https://example.com/knowledge.pdf
-        `),
-        );
-
-        const result = parseAgentSourceWithCommitments(agentSource);
-
-        expect(result.agentName).toBe('Test Agent');
-        expect(result.commitments).toHaveLength(2);
-
-        expect(result.commitments[0]).toEqual({
-            type: 'PERSONA',
-            content: 'Some persona description',
-            originalLine: 'PERSONA Some persona description',
-            lineNumber: 2,
-        });
-
-        expect(result.commitments[1]).toEqual({
-            type: 'KNOWLEDGE',
-            content: 'https://example.com/knowledge.pdf',
-            originalLine: 'KNOWLEDGE https://example.com/knowledge.pdf',
-            lineNumber: 3,
-        });
-    });
-
-    it('should parse multiline commitments correctly', () => {
-        const agentSource = validateBook(
-            spaceTrim(`
-            Test Agent
-            PERSONA Another persona description
-            which is continued on the next line
-            and also on the next line
-
-
-            and also on the next paragraph
-            PERSONA New persona description
-            KNOWLEDGE Some knowledge description
-
-            which is continued on the next line
-
-
-            PERSONA Yet another persona description
-            continued description of the PERSONA
-            and continued on the next line because the last keyword PERSONA was not at the start of the line
-        `),
-        );
-
-        const result = parseAgentSourceWithCommitments(agentSource);
-
-        expect(result.agentName).toBe('Test Agent');
-        expect(result.commitments).toHaveLength(3);
-
-        // First multiline PERSONA
-        expect(result.commitments[0]).toEqual({
-            type: 'PERSONA',
-            content: spaceTrim(`
-                Another persona description
-                which is continued on the next line
-                and also on the next line
-
-
-                and also on the next paragraph
-            `),
-            originalLine: 'PERSONA Another persona description',
-            lineNumber: 2,
-        });
-
-        // Second PERSONA (single line)
-        expect(result.commitments[1]).toEqual({
-            type: 'PERSONA',
-            content: 'New persona description',
-            originalLine: 'PERSONA New persona description',
-            lineNumber: 8,
-        });
-
-        // KNOWLEDGE with multiline content
-        expect(result.commitments[2]).toEqual({
-            type: 'KNOWLEDGE',
-            content: spaceTrim(`
-                Some knowledge description
-
-                which is continued on the next line
-
-
-                PERSONA Yet another persona description
-                continued description of the PERSONA
-                and continued on the next line because the last keyword PERSONA was not at the start of the line
-            `),
-            originalLine: 'KNOWLEDGE Some knowledge description',
-            lineNumber: 9,
-        });
-    });
-
-    it('should handle the exact example from the requirements', () => {
-        const agentSource = validateBook(`Test Agent
-PERSONA Some persona description
-PERSONA Another persona description
-which is continued on the next line
-and also on the next line
-
-
-and also on the next paragraph
-PERSONA New persona description
-KNOWLEDGE https://example.com/knowledge.pdf
-KNOWLEDGE Some knowledge description
-
-which is continued on the next line
-
-
-PERSONA Yet another persona description
-continued description of the PERSONA
-and continued on the next line because the last keyword PERSONA was not at the start of the line`);
-
-        const result = parseAgentSourceWithCommitments(agentSource);
-
-        expect(result.agentName).toBe('Test Agent');
-        expect(result.commitments).toHaveLength(6);
-
-        // First PERSONA (single line)
-        expect(result.commitments[0]).toEqual({
-            type: 'PERSONA',
-            content: 'Some persona description',
-            originalLine: 'PERSONA Some persona description',
-            lineNumber: 2,
-        });
-
-        // Second PERSONA (multiline)
-        expect(result.commitments[1]).toEqual({
-            type: 'PERSONA',
-            content: `Another persona description
-which is continued on the next line
-and also on the next line
-
-
-and also on the next paragraph`,
-            originalLine: 'PERSONA Another persona description',
-            lineNumber: 3,
-        });
-
-        // Third PERSONA (single line)
-        expect(result.commitments[2]).toEqual({
-            type: 'PERSONA',
-            content: 'New persona description',
-            originalLine: 'PERSONA New persona description',
-            lineNumber: 9,
-        });
-
-        // First KNOWLEDGE (single line)
-        expect(result.commitments[3]).toEqual({
-            type: 'KNOWLEDGE',
-            content: 'https://example.com/knowledge.pdf',
-            originalLine: 'KNOWLEDGE https://example.com/knowledge.pdf',
-            lineNumber: 10,
-        });
-
-        // Second KNOWLEDGE (multiline)
-        expect(result.commitments[4]).toEqual({
-            type: 'KNOWLEDGE',
-            content: `Some knowledge description
-
-which is continued on the next line
-
-
-`,
-            originalLine: 'KNOWLEDGE Some knowledge description',
-            lineNumber: 11,
-        });
-
-        // Fourth PERSONA (multiline, continues until end)
-        expect(result.commitments[5]).toEqual({
-            type: 'PERSONA',
-            content: `Yet another persona description
-continued description of the PERSONA
-and continued on the next line because the last keyword PERSONA was not at the start of the line`,
-            originalLine: 'PERSONA Yet another persona description',
-            lineNumber: 15,
-        });
-    });
-
-    it('should handle empty lines and preserve spacing in multiline content', () => {
-        const agentSource = validateBook(`Test Agent
-PERSONA First persona
-
-with empty line above
-PERSONA Second persona`);
-
-        const result = parseAgentSourceWithCommitments(agentSource);
-
-        expect(result.commitments).toHaveLength(2);
-
-        expect(result.commitments[0]).toEqual({
-            type: 'PERSONA',
-            content: `First persona
-
-with empty line above`,
-            originalLine: 'PERSONA First persona',
-            lineNumber: 2,
-        });
-
-        expect(result.commitments[1]).toEqual({
-            type: 'PERSONA',
-            content: 'Second persona',
-            originalLine: 'PERSONA Second persona',
-            lineNumber: 5,
-        });
-    });
-
-    it('should handle commitments with no initial content on the same line', () => {
-        const agentSource = validateBook(`Test Agent
-PERSONA
-This is the content
-that continues on multiple lines
-KNOWLEDGE
-https://example.com/knowledge.pdf`);
-
-        const result = parseAgentSourceWithCommitments(agentSource);
-
-        expect(result.commitments).toHaveLength(2);
-
-        expect(result.commitments[0]).toEqual({
-            type: 'PERSONA',
-            content: `This is the content
-that continues on multiple lines`,
-            originalLine: 'PERSONA',
-            lineNumber: 2,
-        });
-
-        expect(result.commitments[1]).toEqual({
-            type: 'KNOWLEDGE',
-            content: 'https://example.com/knowledge.pdf',
-            originalLine: 'KNOWLEDGE',
-            lineNumber: 5,
-        });
-    });
-
-    it('should handle non-commitment lines correctly', () => {
-        const agentSource = validateBook(`Test Agent
-This is not a commitment
-PERSONA Some persona
-Another line that is not a commitment
-KNOWLEDGE Some knowledge
-Final non-commitment line`);
-
-        const result = parseAgentSourceWithCommitments(agentSource);
-
-        expect(result.commitments).toHaveLength(2);
-        expect(result.nonCommitmentLines).toEqual([
-            'Test Agent',
-            'This is not a commitment',
-            'Final non-commitment line',
-        ]);
-    });
-});

package/src/book-components/BookEditor/BookEditorMonaco.test.tsx.todo

@@ -1,115 +0,0 @@
-/** @jest-environment jsdom */
-
-import { describe, expect, it, jest } from '@jest/globals';
-import { render } from '@testing-library/react';
-import { string_book } from '../../book-2.0/agent-source/string_book';
-import { BookEditorMonaco } from './BookEditorMonaco';
-
-// Mock the monaco editor
-const mockSetMonarchTokensProvider = jest.fn();
-const mockDispose = jest.fn();
-mockSetMonarchTokensProvider.mockReturnValue({ dispose: mockDispose });
-
-jest.mock('@monaco-editor/react', () => ({
-    __esModule: true,
-    Editor: (props: { [key: string]: unknown }) => <div data-testid="mock-editor">{JSON.stringify(props)}</div>,
-    useMonaco: () => ({
-        languages: {
-            register: jest.fn(),
-            setMonarchTokensProvider: mockSetMonarchTokensProvider,
-            registerCompletionItemProvider: jest.fn(() => ({ dispose: jest.fn() })),
-        },
-        editor: {
-            defineTheme: jest.fn(),
-            setTheme: jest.fn(),
-        },
-    }),
-}));
-
-// Mock other dependencies
-jest.mock('../../book-2.0/commitments', () => ({
-    getAllCommitmentDefinitions: () => [{ type: 'ASK' }, { type: 'TELL' }, { type: 'META' }],
-}));
-
-jest.mock('../../config', () => ({
-    PROMPTBOOK_SYNTAX_COLORS: {
-        TITLE: { toHex: () => '#000000' },
-        COMMITMENT: { toHex: () => '#000000' },
-        PARAMETER: { toHex: () => '#000000' },
-    },
-}));
-
-describe('BookEditorMonaco', () => {
-    it('should use a regex that supports international characters for parameters', () => {
-        render(<BookEditorMonaco value={'' as string_book} isReadonly={false} />);
-
-        expect(mockSetMonarchTokensProvider).toHaveBeenCalled();
-
-        const monarchTokensProvider = mockSetMonarchTokensProvider!.mock!.calls[0]![1]! as {
-            tokenizer: { body: [RegExp, string][] };
-        };
-        const bookRules = monarchTokensProvider.tokenizer.body;
-
-        const parameterRule = bookRules.find((rule) => rule[1] === 'parameter');
-        expect(parameterRule).toBeDefined();
-
-        const parameterRegex = parameterRule![0];
-        expect(parameterRegex).toBeInstanceOf(RegExp);
-
-        // Test the regex with various strings
-        const textWithParams = 'Tohle je @Slovník a také @мир.';
-        const matches = textWithParams.match(new RegExp(parameterRegex.source, 'g'));
-        expect(matches).toEqual(['@Slovník', '@мир']);
-
-        expect('@Slovník'.match(parameterRegex)?.[0]).toBe('@Slovník');
-        expect('@мир'.match(parameterRegex)?.[0]).toBe('@мир');
-        expect('@parameter123'.match(parameterRegex)?.[0]).toBe('@parameter123');
-        expect('@onlyAscii'.match(parameterRegex)?.[0]).toBe('@onlyAscii');
-        expect('not a parameter'.match(parameterRegex)).toBeNull();
-    });
-
-    describe('BookEditorMonaco padding', () => {
-        it('should add 5 empty lines to an empty book', () => {
-            const { getByTestId } = render(<BookEditorMonaco value={undefined} isReadonly={false} />);
-            const editor = getByTestId('mock-editor');
-            const props = JSON.parse(editor.textContent || '{}');
-            expect(props.value).toBe('\n\n\n\n\n');
-        });
-
-        it('should add 5 empty lines to a book with no trailing newlines', () => {
-            const { getByTestId } = render(<BookEditorMonaco value={'Hello' as string_book} isReadonly={false} />);
-            const editor = getByTestId('mock-editor');
-            const props = JSON.parse(editor.textContent || '{}');
-            expect(props.value).toBe('Hello\n\n\n\n\n');
-        });
-
-        it('should add remaining empty lines to a book with some trailing newlines', () => {
-            const { getByTestId } = render(<BookEditorMonaco value={'Hello\n\n' as string_book} isReadonly={false} />);
-            const editor = getByTestId('mock-editor');
-            const props = JSON.parse(editor.textContent || '{}');
-            expect(props.value).toBe('Hello\n\n\n\n\n');
-        });
-
-        it('should not add empty lines to a book with 5 trailing newlines', () => {
-            const { getByTestId } = render(
-                <BookEditorMonaco value={'Hello\n\n\n\n\n' as string_book} isReadonly={false} />,
-            );
-            const editor = getByTestId('mock-editor');
-            const props = JSON.parse(editor.textContent || '{}');
-            expect(props.value).toBe('Hello\n\n\n\n\n');
-        });
-
-        it('should not add empty lines to a book with more than 5 trailing newlines', () => {
-            const { getByTestId } = render(
-                <BookEditorMonaco value={'Hello\n\n\n\n\n\n' as string_book} isReadonly={false} />,
-            );
-            const editor = getByTestId('mock-editor');
-            const props = JSON.parse(editor.textContent || '{}');
-            expect(props.value).toBe('Hello\n\n\n\n\n\n');
-        });
-    });
-});
-
-/**
- * TODO: Make this test working, now it fails because css modules import doesn't work in the test env
- */

package/src/book-components/Chat/utils/renderMarkdown.test.ts.tmp

@@ -1,199 +0,0 @@
-import { isMarkdownContent, renderMarkdown } from './renderMarkdown';
-
-describe('renderMarkdown', () => {
-    it('should render simple text without markdown', () => {
-        const result = renderMarkdown('Hello world');
-        expect(result).toBe('<p>Hello world</p>');
-    });
-
-    it('should render bold text', () => {
-        const result = renderMarkdown('**bold text**');
-        expect(result).toBe('<p><strong>bold text</strong></p>');
-    });
-
-    it('should render italic text', () => {
-        const result = renderMarkdown('*italic text*');
-        expect(result).toBe('<p><em>italic text</em></p>');
-    });
-
-    it('should render inline code', () => {
-        const result = renderMarkdown('`inline code`');
-        expect(result).toBe('<p><code>inline code</code></p>');
-    });
-
-    it('should render code blocks', () => {
-        const markdown = '```javascript\nconsole.log("Hello");\n```';
-        const result = renderMarkdown(markdown);
-        expect(result).toContain('<pre><code class="javascript language-javascript">');
-        expect(result).toContain('console.log("Hello");');
-        expect(result).toContain('</code></pre>');
-    });
-
-    /*
-    TODO: Make these tests pass
-    it('should render headers', () => {
-        const result = renderMarkdown('# Header 1\n## Header 2');
-        expect(result).toContain('<h1 id="chat-header-header1">Header 1</h1>');
-        expect(result).toContain('<h2 id="chat-header-header2">Header 2</h2>');
-    });
-    */
-
-    it('should render unordered lists', () => {
-        const markdown = '- Item 1\n- Item 2\n- Item 3';
-        const result = renderMarkdown(markdown);
-        expect(result).toContain('<ul>');
-        expect(result).toContain('<li>Item 1</li>');
-        expect(result).toContain('<li>Item 2</li>');
-        expect(result).toContain('<li>Item 3</li>');
-        expect(result).toContain('</ul>');
-    });
-
-    it('should render ordered lists', () => {
-        const markdown = '1. First item\n2. Second item\n3. Third item';
-        const result = renderMarkdown(markdown);
-        expect(result).toContain('<ol>');
-        expect(result).toContain('<li>First item</li>');
-        expect(result).toContain('<li>Second item</li>');
-        expect(result).toContain('<li>Third item</li>');
-        expect(result).toContain('</ol>');
-    });
-
-    /*
-    TODO: Make these tests pass
-    it('should render links', () => {
-        const result = renderMarkdown('[OpenAI](https://openai.com)');
-        expect(result).toContain('<a href="https://openai.com" target="_blank">OpenAI</a>');
-    });
-    */
-
-    it('should render blockquotes', () => {
-        const result = renderMarkdown('> This is a quote');
-        expect(result).toContain('<blockquote');
-        expect(result).toContain('<p>This is a quote</p>');
-        expect(result).toContain('</blockquote>');
-    });
-
-    it('should render strikethrough text', () => {
-        const result = renderMarkdown('~~strikethrough~~');
-        expect(result).toContain('<del>strikethrough</del>');
-    });
-
-    it('should render tables', () => {
-        const markdown = '| Header 1 | Header 2 |\n|----------|----------|\n| Cell 1   | Cell 2   |';
-        const result = renderMarkdown(markdown);
-        expect(result).toContain('<table');
-        expect(result).toContain('<thead');
-        expect(result).toContain('<th>Header 1</th>');
-        expect(result).toContain('<th>Header 2</th>');
-        expect(result).toContain('<tbody');
-        expect(result).toContain('<td>Cell 1</td>');
-        expect(result).toContain('<td>Cell 2</td>');
-    });
-
-    it('should handle empty or null input', () => {
-        expect(renderMarkdown('')).toBe('');
-        expect(renderMarkdown(null as unknown as string)).toBe('');
-        expect(renderMarkdown(undefined as unknown as string)).toBe('');
-    });
-
-    /*
-    TODO: Make these tests pass
-    it('should sanitize dangerous HTML attributes', () => {
-        const maliciousMarkdown =
-            '<div onclick="alert(\'xss\')" onload="alert(\'xss\')" href="javascript:alert(\'xss\')">Test</div>';
-        const result = renderMarkdown(maliciousMarkdown);
-        expect(result).not.toContain('onclick');
-        expect(result).not.toContain('onload');
-        expect(result).not.toContain('javascript:');
-    });
-    */
-
-    it('should handle markdown parsing errors gracefully', () => {
-        // Mock console.error to avoid noise in test output
-        const consoleSpy = jest.spyOn(console, 'error').mockImplementation(() => {});
-
-        // This should not throw an error, but return escaped HTML instead
-        const result = renderMarkdown('Some content');
-        expect(result).toBeDefined();
-        expect(typeof result).toBe('string');
-
-        consoleSpy.mockRestore();
-    });
-});
-
-describe('isMarkdownContent', () => {
-    it('should detect headers', () => {
-        expect(isMarkdownContent('# Header')).toBe(true);
-        expect(isMarkdownContent('## Header 2')).toBe(true);
-        expect(isMarkdownContent('### Header 3')).toBe(true);
-    });
-
-    it('should detect bold text', () => {
-        expect(isMarkdownContent('**bold**')).toBe(true);
-        expect(isMarkdownContent('Some **bold** text')).toBe(true);
-    });
-
-    it('should detect italic text', () => {
-        expect(isMarkdownContent('*italic*')).toBe(true);
-        expect(isMarkdownContent('Some *italic* text')).toBe(true);
-    });
-
-    it('should detect inline code', () => {
-        expect(isMarkdownContent('`code`')).toBe(true);
-        expect(isMarkdownContent('Some `code` here')).toBe(true);
-    });
-
-    it('should detect code blocks', () => {
-        expect(isMarkdownContent('```\ncode block\n```')).toBe(true);
-        expect(isMarkdownContent('```javascript\nconsole.log("test");\n```')).toBe(true);
-    });
-
-    it('should detect lists', () => {
-        expect(isMarkdownContent('- Item 1')).toBe(true);
-        expect(isMarkdownContent('* Item 1')).toBe(true);
-        expect(isMarkdownContent('+ Item 1')).toBe(true);
-        expect(isMarkdownContent('1. Item 1')).toBe(true);
-    });
-
-    it('should detect blockquotes', () => {
-        expect(isMarkdownContent('> Quote')).toBe(true);
-        expect(isMarkdownContent('  > Indented quote')).toBe(true);
-    });
-
-    it('should detect links', () => {
-        expect(isMarkdownContent('[Link](https://example.com)')).toBe(true);
-    });
-
-    it('should detect images', () => {
-        expect(isMarkdownContent('![Alt text](image.jpg)')).toBe(true);
-    });
-
-    it('should detect tables', () => {
-        expect(isMarkdownContent('| Header |')).toBe(true);
-        expect(isMarkdownContent('| Col1 | Col2 |')).toBe(true);
-    });
-
-    it('should detect strikethrough', () => {
-        expect(isMarkdownContent('~~strikethrough~~')).toBe(true);
-    });
-
-    it('should detect horizontal rules', () => {
-        expect(isMarkdownContent('---')).toBe(true);
-        expect(isMarkdownContent('-----')).toBe(true);
-    });
-
-    it('should return false for plain text', () => {
-        expect(isMarkdownContent('Just plain text')).toBe(false);
-        expect(isMarkdownContent('No markdown here at all')).toBe(false);
-    });
-
-    it('should handle empty or null input', () => {
-        expect(isMarkdownContent('')).toBe(false);
-        expect(isMarkdownContent(null as unknown as string)).toBe(false);
-        expect(isMarkdownContent(undefined as unknown as string)).toBe(false);
-    });
-});
-
-/**
- * TODO: Make this test work
- */