@promptbook/cli 0.100.4-0 → 0.101.0-1

package/README.md

@@ -51,7 +51,31 @@ npm install --save-dev @promptbook/cli
 npm install --global @promptbook/cli
 ```
 
-CLI utils for Promptbook. After install you can use `promptbook` command in terminal:
+CLI utilities for Promptbook that provide command-line tools for building, prettifying, and managing promptbook collections. After installation, you can use the `ptbk` command in your terminal.
+
+## 🎯 Purpose and Motivation
+
+The CLI package provides essential command-line tools for Promptbook development workflows. It enables developers to build optimized promptbook libraries, prettify promptbook files, and manage collections efficiently from the command line, making it easier to integrate Promptbook into development and deployment pipelines.
+
+## 🔧 High-Level Functionality
+
+The package provides command-line tools for:
+- **Library Building**: Pre-compile promptbook collections into optimized formats
+- **Code Generation**: Generate TypeScript, JavaScript, or JSON libraries
+- **Prettification**: Format and enhance promptbook files with diagrams
+- **Validation**: Check promptbooks for errors during build time
+- **Knowledge Building**: Build RAG (Retrieval-Augmented Generation) knowledge bases
+- **Provider Registration**: Include all LLM providers and scrapers for CLI operations
+
+## ✨ Key Features
+
+- 🏗️ **Pre-compilation** - Build optimized promptbook libraries at build time
+- 📝 **Code Generation** - Generate TypeScript, JavaScript, or JSON outputs
+- 🎨 **Auto-prettification** - Format promptbooks and add Mermaid diagrams
+- ✅ **Build-time Validation** - Catch errors early in the development process
+- 🧠 **Knowledge Building** - Automatically build RAG knowledge bases
+- 🔧 **All Providers Included** - Complete set of LLM providers and scrapers
+- 🚀 **Performance Optimization** - Pre-built libraries for faster runtime execution
 
 ## Make your Promptbook Library
 
@@ -104,6 +128,49 @@ npx ptbk prettify 'promptbook/**/*.book'
 
 This will prettify all promptbooks in `promptbook` directory and adds Mermaid graphs to them.
 
+## 📦 Exported Entities
+
+### Version Information
+- `BOOK_LANGUAGE_VERSION` - Current book language version
+- `PROMPTBOOK_ENGINE_VERSION` - Current engine version
+
+### CLI Core
+- `_CLI` - Main CLI application implementation
+
+### LLM Provider Registrations
+- `_AnthropicClaudeMetadataRegistration` - Anthropic Claude metadata registration
+- `_AnthropicClaudeRegistration` - Anthropic Claude provider registration
+- `_AzureOpenAiMetadataRegistration` - Azure OpenAI metadata registration
+- `_AzureOpenAiRegistration` - Azure OpenAI provider registration
+- `_DeepseekMetadataRegistration` - Deepseek metadata registration
+- `_DeepseekRegistration` - Deepseek provider registration
+- `_GoogleMetadataRegistration` - Google metadata registration
+- `_GoogleRegistration` - Google provider registration
+- `_OllamaMetadataRegistration` - Ollama metadata registration
+- `_OllamaRegistration` - Ollama provider registration
+- `_OpenAiMetadataRegistration` - OpenAI metadata registration
+- `_OpenAiAssistantMetadataRegistration` - OpenAI Assistant metadata registration
+- `_OpenAiCompatibleMetadataRegistration` - OpenAI Compatible metadata registration
+- `_OpenAiRegistration` - OpenAI provider registration
+- `_OpenAiAssistantRegistration` - OpenAI Assistant provider registration
+- `_OpenAiCompatibleRegistration` - OpenAI Compatible provider registration
+
+### Scraper Registrations
+- `_BoilerplateScraperRegistration` - Boilerplate scraper registration
+- `_BoilerplateScraperMetadataRegistration` - Boilerplate scraper metadata registration
+- `_LegacyDocumentScraperRegistration` - Legacy document scraper registration
+- `_LegacyDocumentScraperMetadataRegistration` - Legacy document scraper metadata registration
+- `_DocumentScraperRegistration` - Document scraper registration
+- `_DocumentScraperMetadataRegistration` - Document scraper metadata registration
+- `_MarkdownScraperRegistration` - Markdown scraper registration
+- `_MarkdownScraperMetadataRegistration` - Markdown scraper metadata registration
+- `_MarkitdownScraperRegistration` - Markitdown scraper registration
+- `_MarkitdownScraperMetadataRegistration` - Markitdown scraper metadata registration
+- `_PdfScraperRegistration` - PDF scraper registration
+- `_PdfScraperMetadataRegistration` - PDF scraper metadata registration
+- `_WebsiteScraperRegistration` - Website scraper registration
+- `_WebsiteScraperMetadataRegistration` - Website scraper metadata registration
+
 
 ---
 

package/esm/index.es.js

@@ -13,9 +13,6 @@ import { io } from 'socket.io-client';
 import { Subject } from 'rxjs';
 import { spawn } from 'child_process';
 import JSZip from 'jszip';
-import parserHtml from 'prettier/parser-html';
-import parserMarkdown from 'prettier/parser-markdown';
-import { format } from 'prettier/standalone';
 import { parse, unparse } from 'papaparse';
 import { SHA256 } from 'crypto-js';
 import { lookup, extension } from 'mime-types';
@@ -48,7 +45,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.100.4-0';
+const PROMPTBOOK_ENGINE_VERSION = '0.101.0-1';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -739,6 +736,8 @@ function $getGlobalScope() {
 /**
  * Normalizes a text string to SCREAMING_CASE (all uppercase with underscores).
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @param text The text string to be converted to SCREAMING_CASE format.
  * @returns The normalized text in SCREAMING_CASE format.
  * @example 'HELLO_WORLD'
@@ -794,6 +793,8 @@ function normalizeTo_SCREAMING_CASE(text) {
 /**
  * Normalizes a text string to snake_case format.
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @param text The text string to be converted to snake_case format.
  * @returns The normalized text in snake_case format.
  * @example 'hello_world'
@@ -1506,6 +1507,7 @@ function checkSerializableAsJson(options) {
 /**
  * Creates a deep clone of the given object
  *
+ * Note: [🔂] This function is idempotent.
  * Note: This method only works for objects that are fully serializable to JSON and do not contain functions, Dates, or special types.
  *
  * @param objectValue The object to clone.
@@ -1722,6 +1724,8 @@ function stringifyPipelineJson(pipeline) {
 /**
  * Removes emojis from a string and fix whitespaces
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @param text with emojis
  * @returns text without emojis
  * @public exported from `@promptbook/utils`
@@ -1794,6 +1798,7 @@ function isValidFilePath(filename) {
 /**
  * Tests if given string is valid URL.
  *
+ * Note: [🔂] This function is idempotent.
  * Note: Dataurl are considered perfectly valid.
  * Note: There are two similar functions:
  * - `isValidUrl` which tests any URL
@@ -2067,6 +2072,8 @@ for (let i = 0; i < defaultDiacriticsRemovalMap.length; i++) {
 /**
  * Removes diacritic marks (accents) from characters in a string.
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @param input The string containing diacritics to be normalized.
  * @returns The string with diacritics removed or normalized.
  * @public exported from `@promptbook/utils`
@@ -2630,7 +2637,7 @@ const LLM_PROVIDER_PROFILES = {
 };
 /**
  * TODO: Refactor this - each profile must be alongside the provider definition
- * TODO: [🕛] Unite `AvatarProfileProps`, `ChatParticipant`, `LlmExecutionTools` +  `LlmToolsMetadata`
+ * TODO: [🕛] Unite `AgentBasicInformation`, `ChatParticipant`, `LlmExecutionTools` +  `LlmToolsMetadata`
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */
 
@@ -2896,6 +2903,8 @@ function isValidJsonString(value /* <- [👨‍⚖️] */) {
 /**
  * Makes first letter of a string uppercase
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @public exported from `@promptbook/utils`
  */
 function capitalize(word) {
@@ -3020,6 +3029,7 @@ function countCharacters(text) {
 }
 /**
  * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+ * TODO: [🧠][✌️] Make some Promptbook-native token system
  */
 
 /**
@@ -3054,6 +3064,7 @@ function countLines(text) {
 }
 /**
  * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+ * TODO: [🧠][✌️] Make some Promptbook-native token system
  */
 
 /**
@@ -3068,6 +3079,7 @@ function countPages(text) {
 }
 /**
  * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+ * TODO: [🧠][✌️] Make some Promptbook-native token system
  */
 
 /**
@@ -3080,6 +3092,7 @@ function countParagraphs(text) {
 }
 /**
  * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+ * TODO: [🧠][✌️] Make some Promptbook-native token system
  */
 
 /**
@@ -3100,6 +3113,7 @@ function countSentences(text) {
 }
 /**
  * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+ * TODO: [🧠][✌️] Make some Promptbook-native token system
  */
 
 /**
@@ -3116,6 +3130,8 @@ function countWords(text) {
 }
 /**
  * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+ * TODO: [🧠][✌️] Make some Promptbook-native token system
+ * TODO: [✌️] `countWords` should be just `splitWords(...).length`, and all other counters should use this pattern as well
  */
 
 /**
@@ -5216,8 +5232,18 @@ function validatePipelineString(pipelineString) {
  * @private withing the package because of HUGE size of prettier dependency
  */
 function prettifyMarkdown(content) {
+    // In browser/Next.js environments, just return the original content
+    // since prettier parsers are not available and would cause bundling issues
+    if (typeof window !== 'undefined') {
+        return content;
+    }
     try {
-        return format(content, {
+        // Use dynamic require to avoid static imports that cause bundling issues
+        // This will only work in Node.js environments
+        const prettierStandalone = eval('require')('prettier/standalone');
+        const parserMarkdown = eval('require')('prettier/parser-markdown');
+        const parserHtml = eval('require')('prettier/parser-html');
+        return prettierStandalone.format(content, {
             parser: 'markdown',
             plugins: [parserMarkdown, parserHtml],
             // TODO: DRY - make some import or auto-copy of .prettierrc
@@ -8925,6 +8951,7 @@ const EXPECTATION_UNITS = ['CHARACTERS', 'WORDS', 'SENTENCES', 'LINES', 'PARAGRA
 /**
  * Function parseNumber will parse number from string
  *
+ * Note: [🔂] This function is idempotent.
  * Unlike Number.parseInt, Number.parseFloat it will never ever result in NaN
  * Note: it also works only with decimal numbers
  *
@@ -9187,6 +9214,7 @@ function normalizeTo_camelCase(text, _isFirstLetterCapital = false) {
 /**
  * Removes quotes from a string
  *
+ * Note: [🔂] This function is idempotent.
  * Tip: This is very useful for post-processing of the result of the LLM model
  * Note: This function removes only the same quotes from the beginning and the end of the string
  * Note: There are two similar functions:
@@ -12039,7 +12067,9 @@ function renderPromptbookMermaid(pipelineJson, options) {
  */
 
 /**
- * Makes first letter of a string uppercase
+ * Makes first letter of a string lowercase
+ *
+ * Note: [🔂] This function is idempotent.
  *
  * @public exported from `@promptbook/utils`
  */
@@ -12109,6 +12139,8 @@ function normalizeTo_PascalCase(text) {
 /**
  * Take every whitespace (space, new line, tab) and replace it with a single space
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @public exported from `@promptbook/utils`
  */
 function normalizeWhitespaces(sentence) {
@@ -12129,6 +12161,7 @@ function suffixUrl(value, suffix) {
 /**
  * Function trimCodeBlock will trim starting and ending code block from the string if it is present.
  *
+ * Note: [🔂] This function is idempotent.
  * Note: This is useful for post-processing of the result of the chat LLM model
  *       when the model wraps the result in the (markdown) code block.
  *
@@ -13366,6 +13399,8 @@ function createMarkdownChart(options) {
  * Function escapeMarkdownBlock will escape markdown block if needed
  * It is useful when you want have block in block
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @public exported from `@promptbook/markdown-utils`
  */
 function escapeMarkdownBlock(value) {