@promptbook/node 0.100.4-0 → 0.101.0-1

package/README.md

@@ -48,9 +48,57 @@ npm i ptbk
 npm install @promptbook/node
 ```
 
-Core of the library for Node.js runtime, it contains the main logic for promptbooks which uses filesystem.
+The Node.js package provides Node.js-specific functionality for Promptbook, including filesystem operations, command execution, and automatic provider configuration. It serves as the bridge between Promptbook's core functionality and Node.js runtime capabilities.
 
+## 🎯 Purpose and Motivation
 
+This package extends Promptbook's core functionality with Node.js-specific features that are essential for server-side and desktop applications. It provides filesystem access, command execution, automatic LLM provider detection, and other Node.js runtime capabilities that enable full-featured Promptbook applications.
+
+## 🔧 High-Level Functionality
+
+The package provides Node.js-specific integrations and utilities:
+- **Filesystem Operations**: Read promptbooks from directories and manage file-based collections
+- **Automatic Provider Setup**: Detect and configure LLM providers from environment variables
+- **Command Execution**: Execute system commands and scripts
+- **Knowledge Scraping**: Node.js-specific scrapers for various content sources
+- **File-based Storage**: Persistent storage using the filesystem
+- **Environment Integration**: Seamless integration with Node.js environment and tooling
+
+## ✨ Key Features
+
+- 📁 **Directory-based Collections** - Load promptbook collections from filesystem directories
+- 🔧 **Auto-configuration** - Automatically detect and configure LLM providers from environment
+- 💾 **File Storage** - Persistent caching and storage using the filesystem
+- 🛠️ **Command Execution** - Execute system commands and scripts from promptbooks
+- 🌐 **Knowledge Scraping** - Scrape content from files, websites, and other sources
+- 🔌 **Provider Detection** - Automatically discover available LLM providers
+- 📊 **Executable Management** - Manage and execute external tools and scripts
+- 🚀 **Performance Optimization** - File-based caching for improved performance
+
+## 📦 Exported Entities
+
+### Version Information
+- `BOOK_LANGUAGE_VERSION` - Current book language version
+- `PROMPTBOOK_ENGINE_VERSION` - Current engine version
+
+### Collection Management
+- `createCollectionFromDirectory` - Create promptbook collection from filesystem directory
+
+### Provider Configuration
+- `$provideExecutablesForNode` - Provide executable tools for Node.js environment
+- `$provideExecutionToolsForNode` - Auto-configure all execution tools from environment
+- `$provideLlmToolsConfigurationFromEnv` - Create LLM tools configuration from environment variables
+- `$provideLlmToolsFromEnv` - Create LLM tools from environment variables
+- `$provideFilesystemForNode` - Provide filesystem access for Node.js
+- `$provideScrapersForNode` - Provide knowledge scrapers for Node.js environment
+- `$provideScriptingForNode` - Provide scripting capabilities for Node.js
+
+### Storage
+- `FileCacheStorage` - File-based cache storage implementation
+
+### Command Execution
+- `$execCommand` - Execute single system command
+- `$execCommands` - Execute multiple system commands
 
 > 💡 This package does not make sense on its own, look at [all promptbook packages](#-packages) or just install all by `npm i ptbk`
 

package/esm/index.es.js

@@ -3,9 +3,6 @@ import { stat, access, constants, readFile, writeFile, readdir, mkdir, unlink }
 import { basename, join, dirname, isAbsolute, relative } from 'path';
 import spaceTrim, { spaceTrim as spaceTrim$1 } from 'spacetrim';
 import JSZip from 'jszip';
-import parserHtml from 'prettier/parser-html';
-import parserMarkdown from 'prettier/parser-markdown';
-import { format } from 'prettier/standalone';
 import { randomBytes } from 'crypto';
 import { Subject } from 'rxjs';
 import { forTime } from 'waitasecond';
@@ -31,7 +28,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
@@ -595,6 +592,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.
@@ -789,6 +787,7 @@ function isValidPromptbookVersion(version) {
 /**
  * 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
@@ -1299,8 +1298,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
@@ -1328,6 +1337,8 @@ function prettifyMarkdown(content) {
 /**
  * Makes first letter of a string uppercase
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @public exported from `@promptbook/utils`
  */
 function capitalize(word) {
@@ -3065,7 +3076,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
  */
 
@@ -3497,6 +3508,7 @@ function countCharacters(text) {
 }
 /**
  * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+ * TODO: [🧠][✌️] Make some Promptbook-native token system
  */
 
 /**
@@ -3531,6 +3543,7 @@ function countLines(text) {
 }
 /**
  * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+ * TODO: [🧠][✌️] Make some Promptbook-native token system
  */
 
 /**
@@ -3545,6 +3558,7 @@ function countPages(text) {
 }
 /**
  * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+ * TODO: [🧠][✌️] Make some Promptbook-native token system
  */
 
 /**
@@ -3557,6 +3571,7 @@ function countParagraphs(text) {
 }
 /**
  * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+ * TODO: [🧠][✌️] Make some Promptbook-native token system
  */
 
 /**
@@ -3577,6 +3592,7 @@ function countSentences(text) {
 }
 /**
  * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+ * TODO: [🧠][✌️] Make some Promptbook-native token system
  */
 
 const defaultDiacriticsRemovalMap = [
@@ -3826,6 +3842,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`
@@ -3854,6 +3872,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
  */
 
 /**
@@ -5353,6 +5373,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'
@@ -5408,6 +5430,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'
@@ -5718,6 +5742,8 @@ function mimeTypeToExtension(value) {
 /**
  * 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`
@@ -6807,6 +6833,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
  *
@@ -7069,6 +7096,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:
@@ -10691,7 +10719,9 @@ new Function(`
  */
 
 /**
- * Makes first letter of a string uppercase
+ * Makes first letter of a string lowercase
+ *
+ * Note: [🔂] This function is idempotent.
  *
  * @public exported from `@promptbook/utils`
  */
@@ -10761,6 +10791,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) {
@@ -10804,6 +10836,7 @@ function isSerializableAsJson(value) {
 /**
  * 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.
  *