@promptbook/remote-client 0.88.0 → 0.89.0-11

package/README.md

@@ -23,6 +23,10 @@
 
 
 
+<blockquote style="color: #ff8811">
+    <b>⚠ Warning:</b> This is a pre-release version of the library. It is not yet ready for production use. Please look at <a href="https://www.npmjs.com/package/@promptbook/core?activeTab=versions">latest stable release</a>.
+</blockquote>
+
 ## 📦 Package `@promptbook/remote-client`
 
 - Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
@@ -196,7 +200,7 @@ Each part of the book defines one of 3 circles:
 
 ### **What:** Workflows, Tasks and Parameters
 
-What work needs to be done. Each book defines a workflow, which is one or more tasks. Each workflow has a fixed input and output. For example, you have a book that generates an article from a topic. Once it generates an article about AI, once about marketing, once about cooking. The workflow (= your AI program) is the same, only the input and output change.
+What work needs to be done. Each book defines a [workflow *(scenario or pipeline)*](https://github.com/webgptorg/promptbook/discussions/88), which is one or more tasks. Each workflow has a fixed input and output. For example, you have a book that generates an article from a topic. Once it generates an article about AI, once about marketing, once about cooking. The workflow (= your AI program) is the same, only the input and output change.
 
 **Related commands:**
 
@@ -306,6 +310,8 @@ The following glossary is used to clarify certain concepts:
 
 
 
+
+
 _Note: This section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
 
 

package/esm/index.es.js

@@ -20,7 +20,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.88.0';
+const PROMPTBOOK_ENGINE_VERSION = '0.89.0-11';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -56,6 +56,19 @@ class CsvFormatError extends AbstractFormatError {
     }
 }
 
+/**
+ * AuthenticationError is thrown from login function which is dependency of remote server
+ *
+ * @public exported from `@promptbook/core`
+ */
+class AuthenticationError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'AuthenticationError';
+        Object.setPrototypeOf(this, AuthenticationError.prototype);
+    }
+}
+
 /**
  * This error indicates that the pipeline collection cannot be propperly loaded
  *
@@ -254,6 +267,19 @@ class PipelineUrlError extends Error {
     }
 }
 
+/**
+ * Error thrown when a fetch request fails
+ *
+ * @public exported from `@promptbook/core`
+ */
+class PromptbookFetchError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'PromptbookFetchError';
+        Object.setPrototypeOf(this, PromptbookFetchError.prototype);
+    }
+}
+
 /**
  * Returns the same value that is passed as argument.
  * No side effects.
@@ -346,7 +372,7 @@ Object.freeze({
 });
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name
- * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
+ * TODO: [🧠][🧜‍♂️] Maybe join remoteServerUrl and path into single value
  */
 
 /**
@@ -454,6 +480,8 @@ const COMMON_JAVASCRIPT_ERRORS = {
     TypeError,
     URIError,
     AggregateError,
+    AuthenticationError,
+    PromptbookFetchError,
     /*
   Note: Not widely supported
   > InternalError,
@@ -510,22 +538,26 @@ function deserializeError(error) {
  * @private internal utility function
  */
 async function createRemoteClient(options) {
-    const { remoteUrl, path } = options;
+    const { remoteServerUrl } = options;
+    let path = new URL(remoteServerUrl).pathname;
+    if (path.endsWith('/')) {
+        path = path.slice(0, -1);
+    }
+    path = `${path}/socket.io`;
     return new Promise((resolve, reject) => {
-        const socket = io(remoteUrl, {
+        const socket = io(remoteServerUrl, {
             retries: CONNECTION_RETRIES_LIMIT,
             timeout: CONNECTION_TIMEOUT_MS,
             path,
-            // path: `${this.remoteUrl.pathname}/socket.io`,
             transports: [/*'websocket', <- TODO: [🌬] Make websocket transport work */ 'polling'],
         });
-        // console.log('Connecting to', this.options.remoteUrl.href, { socket });
+        // console.log('Connecting to', this.options.remoteServerUrl.href, { socket });
         socket.on('connect', () => {
             resolve(socket);
         });
         // TODO: [💩] Better timeout handling
         setTimeout(() => {
-            reject(new Error(`Timeout while connecting to ${remoteUrl}`));
+            reject(new Error(`Timeout while connecting to ${remoteServerUrl}`));
         }, CONNECTION_TIMEOUT_MS);
     });
 }
@@ -3212,7 +3244,8 @@ const modelCommandParser = {
         if ($pipelineJson.defaultModelRequirements[command.key] !== undefined) {
             if ($pipelineJson.defaultModelRequirements[command.key] === command.value) {
                 console.warn(`Multiple commands \`MODEL ${command.key} ${command.value}\` in the pipeline head`);
-                // <- TODO: [🚎][💩] Some better way how to get warnings from pipeline parsing / logic
+                // <- TODO: [🏮] Some better way how to get warnings from pipeline parsing / logic
+                // <- TODO: [🏮] Some standard way how to transform errors into warnings and how to handle non-critical fails during the tasks
             }
             else {
                 throw new ParseError(spaceTrim$1(`
@@ -3244,6 +3277,7 @@ const modelCommandParser = {
                     modelVariant: 'VARIANT',
                     maxTokens: '???',
                 }[command.key]} ${command.value}\` in the task "${$taskJson.title || $taskJson.name}"`);
+                // <- TODO: [🏮] Some standard way how to transform errors into warnings and how to handle non-critical fails during the tasks
             }
             else {
                 throw new ParseError(spaceTrim$1(`
@@ -3523,15 +3557,15 @@ function $applyToTaskJson(command, $taskJson, $pipelineJson) {
     }
     console.warn(spaceTrim$1(`
 
-         Persona "${personaName}" is defined multiple times with different description:
+            Persona "${personaName}" is defined multiple times with different description:
 
-         First definition:
-         ${persona.description}
+            First definition:
+            ${persona.description}
 
-         Second definition:
-         ${personaDescription}
+            Second definition:
+            ${personaDescription}
 
-     `));
+        `));
     persona.description += spaceTrim$1('\n\n' + personaDescription);
 }
 
@@ -4895,7 +4929,7 @@ function extractParameterNamesFromTask(task) {
             if (parameterNames.has(subparameterName)) {
                 parameterNames.delete(subparameterName);
                 parameterNames.add(foreach.parameterName);
-                // <- TODO: [🚎] Warn/logic error when `subparameterName` not used
+                // <- TODO: [🏮] Warn/logic error when `subparameterName` not used
             }
         }
     }