@promptbook/markdown-utils 0.101.0-1 → 0.101.0-3

package/README.md

@@ -48,7 +48,93 @@ npm i ptbk
 npm install @promptbook/markdown-utils
 ```
 
-Utility functions used for processing markdown. Its part of the larger [`@promptbook/utils`](https://www.npmjs.com/package/@promptbook/utils) ecosystem.
+Comprehensive markdown processing utilities for the Promptbook ecosystem, providing tools for parsing, manipulating, and extracting content from markdown documents.
+
+## 🎯 Purpose and Motivation
+
+This package provides specialized markdown processing capabilities that are essential for working with promptbooks and LLM-generated content. It handles markdown parsing, content extraction, text humanization, and various markdown transformations that are commonly needed when processing AI-generated text and promptbook documentation.
+
+## 🔧 High-Level Functionality
+
+The package offers comprehensive markdown processing capabilities:
+
+-   **Content Extraction**: Extract code blocks, lists, and sections from markdown
+-   **Text Processing**: Parse and manipulate markdown sections and content
+-   **AI Text Humanization**: Transform AI-generated text to be more human-readable
+-   **Markdown Manipulation**: Add, remove, and modify markdown formatting
+-   **Table and Chart Creation**: Generate markdown tables and charts
+-   **Scraping Integration**: Markdown-specific content scraping capabilities
+
+## ✨ Key Features
+
+-   📝 **Content Extraction** - Extract blocks, lists, and sections from markdown documents
+-   🎨 **Text Humanization** - Transform AI text with proper quotes, ellipsis, and formatting
+-   🔧 **Markdown Manipulation** - Add, remove, and modify markdown formatting
+-   📊 **Table Generation** - Create formatted markdown tables and charts
+-   🧹 **Content Cleaning** - Remove comments, links, and unwanted formatting
+-   📖 **Section Parsing** - Parse and split markdown into structured sections
+-   🔍 **Block Processing** - Extract and process code blocks and content blocks
+-   🤖 **AI Integration** - Specialized tools for processing LLM-generated markdown
+
+## 📦 Exported Entities
+
+### Version Information
+
+-   `BOOK_LANGUAGE_VERSION` - Current book language version
+-   `PROMPTBOOK_ENGINE_VERSION` - Current engine version
+
+### Content Extraction
+
+-   `extractBlock` - Extract specific blocks from content
+-   `extractJsonBlock` - Extract JSON blocks from content
+-   `extractAllBlocksFromMarkdown` - Extract all code blocks from markdown
+-   `extractAllListItemsFromMarkdown` - Extract all list items from markdown
+-   `extractOneBlockFromMarkdown` - Extract single code block from markdown
+
+### Markdown Scraping
+
+-   `createMarkdownScraper` - Create markdown content scraper
+-   `MarkdownScraper` - Markdown scraper class
+-   `_MarkdownScraperRegistration` - Markdown scraper registration
+
+### Type Definitions
+
+-   `string_markdown` - Markdown string type (type)
+-   `string_markdown_section` - Markdown section string type (type)
+-   `string_markdown_section_content` - Markdown section content type (type)
+-   `string_markdown_text` - Markdown text string type (type)
+-   `string_markdown_codeblock_language` - Markdown code block language type (type)
+-   `MarkdownSection` - Markdown section structure (type)
+
+### Content Generation
+
+-   `addAutoGeneratedSection` - Add auto-generated sections to markdown
+-   `createMarkdownChart` - Create markdown charts and diagrams
+-   `createMarkdownTable` - Create formatted markdown tables
+
+### Text Processing
+
+-   `escapeMarkdownBlock` - Escape markdown block content
+-   `flattenMarkdown` - Flatten markdown structure
+-   `parseMarkdownSection` - Parse markdown into sections
+-   `splitMarkdownIntoSections` - Split markdown into structured sections
+
+### AI Text Humanization
+
+-   `humanizeAiText` - Comprehensive AI text humanization
+-   `humanizeAiTextEllipsis` - Fix ellipsis formatting in AI text
+-   `humanizeAiTextEmdashed` - Fix em-dash formatting in AI text
+-   `humanizeAiTextQuotes` - Fix quote formatting in AI text
+-   `humanizeAiTextWhitespace` - Fix whitespace in AI text
+-   `promptbookifyAiText` - Transform AI text for promptbook format
+
+### Content Cleaning
+
+-   `removeMarkdownComments` - Remove comments from markdown
+-   `removeMarkdownFormatting` - Remove markdown formatting
+-   `removeMarkdownLinks` - Remove links from markdown
+
+> 💡 This package provides markdown processing utilities for promptbook applications. For the core functionality, see [@promptbook/core](#-packages) or install all packages with `npm i ptbk`
 
 
 ---

package/esm/index.es.js

@@ -23,7 +23,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.101.0-1';
+const PROMPTBOOK_ENGINE_VERSION = '0.101.0-3';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name

package/esm/typings/src/_packages/components.index.d.ts

@@ -18,6 +18,10 @@ import type { ChatMessage } from '../book-components/Chat/types/ChatMessage';
 import type { ChatParticipant } from '../book-components/Chat/types/ChatParticipant';
 import { renderMarkdown } from '../book-components/Chat/utils/renderMarkdown';
 import { isMarkdownContent } from '../book-components/Chat/utils/renderMarkdown';
+import { ArrowIcon } from '../book-components/icons/ArrowIcon';
+import { ResetIcon } from '../book-components/icons/ResetIcon';
+import { SendIcon } from '../book-components/icons/SendIcon';
+import { TemplateIcon } from '../book-components/icons/TemplateIcon';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export type { AvatarChipProps };
 export { AvatarChip };
@@ -38,3 +42,7 @@ export type { ChatMessage };
 export type { ChatParticipant };
 export { renderMarkdown };
 export { isMarkdownContent };
+export { ArrowIcon };
+export { ResetIcon };
+export { SendIcon };
+export { TemplateIcon };

package/esm/typings/src/book-components/Chat/Chat/Chat.d.ts

@@ -1,9 +1,4 @@
 import type { ChatProps } from './ChatProps';
-/**
- * @deprecated use `isComplete` instead
- * @private util of `<Chat />`
- */
-export declare const LOADING_INTERACTIVE_IMAGE = "Loading...";
 /**
  * Renders a chat with messages and input for new messages
  *

package/esm/typings/src/book-components/Chat/Chat/ChatProps.d.ts

@@ -23,10 +23,16 @@ export type ChatProps = {
      * Called when user sends a message
      *
      * Note: You must handle the message yourself and add it to the `messages` array
+     *
+     * - When set, the send textarea and button will be shown
+     * - When undefined, the chat has no input and is read-only showing only the messages
      */
-    onMessage(messageContent: string): Promisable<void>;
+    onMessage?(messageContent: string): Promisable<void>;
     /**
-     * Optional callback, when set, button for resetting chat will be shown
+     * Optional callback
+     *
+     * - When set, button for resetting chat will be shown
+     * - When undefined, no reset button will be shown
      */
     onReset?(): Promisable<void>;
     /**
@@ -113,4 +119,24 @@ export type ChatProps = {
      * Keys should match ChatMessage.from values (e.g., 'USER', 'AGENT_{id}', etc.)
      */
     readonly participants?: ReadonlyArray<ChatParticipant>;
+    /**
+     * Optional callback for handling user feedback on messages
+     * When provided, star rating buttons (1-5 stars) will be displayed next to each message
+     *
+     * @param feedback - Object containing the feedback data
+     * @param feedback.message - The message being rated
+     * @param feedback.rating - Star rating from 1 to 5
+     * @param feedback.textRating - Optional text feedback/note from user
+     * @param feedback.chatThread - Complete chat thread as string
+     * @param feedback.expectedAnswer - Optional expected answer provided by user
+     * @param feedback.url - Current page URL where feedback was given
+     */
+    onFeedback?(feedback: {
+        message: ChatMessage;
+        rating: number;
+        textRating: string;
+        chatThread: string;
+        expectedAnswer: string | null;
+        url: string;
+    }): Promisable<void>;
 };

package/esm/typings/src/book-components/Chat/Chat/constants.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @deprecated use `isComplete` instead
+ * @private util of `<Chat />`
+ */
+export declare const LOADING_INTERACTIVE_IMAGE = "Loading...";
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/book-components/icons/ArrowIcon.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Shows simple arrow icon pointing up or down
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare const ArrowIcon: ({ direction, size }: {
+    direction: string;
+    size: number;
+}) => import("react/jsx-runtime").JSX.Element;

package/esm/typings/src/book-components/icons/ResetIcon.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Shows simple reset icon
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare const ResetIcon: () => import("react/jsx-runtime").JSX.Element;

package/esm/typings/src/book-components/icons/SendIcon.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Shows simple send icon
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare const SendIcon: ({ size }: {
+    size: number;
+}) => import("react/jsx-runtime").JSX.Element;

package/esm/typings/src/book-components/icons/TemplateIcon.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Shows simple template icon
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare const TemplateIcon: ({ size }: {
+    size: number;
+}) => import("react/jsx-runtime").JSX.Element;

package/esm/typings/src/version.d.ts

@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
 export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
 /**
  * Represents the version string of the Promptbook engine.
- * It follows semantic versioning (e.g., `0.101.0-0`).
+ * It follows semantic versioning (e.g., `0.101.0-2`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/markdown-utils",
-    "version": "0.101.0-1",
+    "version": "0.101.0-3",
     "description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
     "private": false,
     "sideEffects": false,

package/umd/index.umd.js

@@ -24,7 +24,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.101.0-1';
+    const PROMPTBOOK_ENGINE_VERSION = '0.101.0-3';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name