@promptbook/remote-server 0.101.0-0 → 0.101.0-10

package/README.md

@@ -49,6 +49,51 @@ npm install @promptbook/remote-server
 ```
 
 
+Remote server implementation for Promptbook, enabling distributed execution of promptbook pipelines across network boundaries with REST API and WebSocket support.
+
+## 🎯 Purpose and Motivation
+
+This package provides a remote server that allows promptbook pipelines to be executed over the network. It enables distributed architectures where promptbook execution can be centralized on powerful servers while clients can access the functionality remotely, making it ideal for scaling promptbook applications and providing API access to promptbook collections.
+
+## 🔧 High-Level Functionality
+
+The package provides remote server capabilities:
+- **HTTP REST API**: RESTful endpoints for pipeline execution and management
+- **WebSocket Support**: Real-time communication for streaming execution results
+- **Authentication**: Support for both anonymous and application-based authentication
+- **Pipeline Management**: Remote access to promptbook collections and pipelines
+- **Execution Orchestration**: Distributed execution of promptbook pipelines
+- **OpenAI Compatibility**: OpenAI-compatible API endpoints for seamless integration
+
+## ✨ Key Features
+
+- 🌐 **Remote Execution** - Execute promptbook pipelines over HTTP/WebSocket
+- 🔐 **Authentication Modes** - Support for anonymous and application-based access
+- 📡 **Real-time Communication** - WebSocket support for streaming results
+- 🔌 **OpenAI Compatible** - Use promptbooks as OpenAI-compatible models
+- 🚀 **Scalable Architecture** - Distribute promptbook execution across servers
+- 📊 **Pipeline Management** - Remote access to collections and individual pipelines
+- 🛡️ **Security** - Configurable authentication and access control
+- ⚡ **High Performance** - Optimized for concurrent pipeline execution
+
+## 📦 Exported Entities
+
+### Version Information
+- `BOOK_LANGUAGE_VERSION` - Current book language version
+- `PROMPTBOOK_ENGINE_VERSION` - Current engine version
+
+### Server Management
+- `startRemoteServer` - Start the remote promptbook server
+
+### Configuration Types
+- `RemoteServerOptions` - Configuration options for remote server (type)
+
+### Authentication Types
+- `Identification` - Base identification interface (type)
+- `ApplicationModeIdentification` - Application mode identification (type)
+- `AnonymousModeIdentification` - Anonymous mode identification (type)
+
+> 💡 This package provides remote server functionality for promptbook applications. For the core functionality, see [@promptbook/core](#-packages) or install all packages with `npm i ptbk`
 
 
 ---

package/esm/index.es.js

@@ -11,9 +11,6 @@ import { spawn } from 'child_process';
 import { stat, access, constants, readFile, writeFile, readdir, mkdir } from 'fs/promises';
 import { join, basename, dirname, isAbsolute } from 'path';
 import { Subject } from 'rxjs';
-import parserHtml from 'prettier/parser-html';
-import parserMarkdown from 'prettier/parser-markdown';
-import { format } from 'prettier/standalone';
 import hexEncoder from 'crypto-js/enc-hex';
 import sha256 from 'crypto-js/sha256';
 import { SHA256 } from 'crypto-js';
@@ -34,7 +31,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.101.0-0';
+const PROMPTBOOK_ENGINE_VERSION = '0.101.0-10';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -1299,6 +1296,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.
@@ -1464,6 +1462,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
@@ -2372,8 +2371,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
@@ -2401,6 +2410,8 @@ function prettifyMarkdown(content) {
 /**
  * Makes first letter of a string uppercase
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @public exported from `@promptbook/utils`
  */
 function capitalize(word) {
@@ -3241,6 +3252,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'
@@ -3296,6 +3309,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'
@@ -3713,6 +3728,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`
@@ -3867,6 +3884,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`
@@ -7025,7 +7044,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`
  */
@@ -7095,6 +7116,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) {
@@ -7104,6 +7127,7 @@ function normalizeWhitespaces(sentence) {
 /**
  * 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:
@@ -7127,6 +7151,7 @@ function removeQuotes(text) {
 /**
  * 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.
  *