@promptbook/remote-server 0.101.0-2 → 0.101.0-3

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

@@ -31,7 +31,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.101.0-2';
+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/book-components/Chat/Chat/ChatProps.d.ts

@@ -119,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/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-1`).
+ * It follows semantic versioning (e.g., `0.101.0-2`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/remote-server",
-    "version": "0.101.0-2",
+    "version": "0.101.0-3",
     "description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
     "private": false,
     "sideEffects": false,
@@ -95,7 +95,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/remote-server.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.101.0-2"
+        "@promptbook/core": "0.101.0-3"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -47,7 +47,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.101.0-2';
+    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