@promptbook/remote-server 0.88.0-1 → 0.88.0-11

package/README.md

@@ -116,6 +116,14 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
   </tbody>
 </table>
 
+Hello world examples:
+
+-   [Hello world](https://github.com/webgptorg/hello-world)
+-   [Hello world in Node.js](https://github.com/webgptorg/hello-world-node-js)
+-   [Hello world in Next.js](https://github.com/webgptorg/hello-world-next-js)
+
+
+
 We also have a community of developers and users of **Promptbook**:
 
 -   [Discord community](https://discord.gg/x3QWNaa89N)
@@ -282,16 +290,9 @@ Or you can install them separately:
 
 ## 📚 Dictionary
 
-
-
-
-
-
-### 📚 Dictionary
-
 The following glossary is used to clarify certain concepts:
 
-#### General LLM / AI terms
+### General LLM / AI terms
 
 -   **Prompt drift** is a phenomenon where the AI model starts to generate outputs that are not aligned with the original prompt. This can happen due to the model's training data, the prompt's wording, or the model's architecture.
 -   **Pipeline, workflow or chain** is a sequence of tasks that are executed in a specific order. In the context of AI, a pipeline can refer to a sequence of AI models that are used to process data.
@@ -304,11 +305,11 @@ The following glossary is used to clarify certain concepts:
 
 
 
-_Note: Thos section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
+_Note: This section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
 
 
 
-#### 💯 Core concepts
+### 💯 Core concepts
 
 -   [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)
 -   [📯 Pipeline](https://github.com/webgptorg/promptbook/discussions/64)
@@ -321,7 +322,7 @@ _Note: Thos section is not complete dictionary, more list of general AI / LLM te
 -   [🔣 Words not tokens](https://github.com/webgptorg/promptbook/discussions/29)
 -   [☯ Separation of concerns](https://github.com/webgptorg/promptbook/discussions/32)
 
-##### Advanced concepts
+#### Advanced concepts
 
 -   [📚 Knowledge (Retrieval-augmented generation)](https://github.com/webgptorg/promptbook/discussions/41)
 -   [🌏 Remote server](https://github.com/webgptorg/promptbook/discussions/89)
@@ -338,17 +339,9 @@ _Note: Thos section is not complete dictionary, more list of general AI / LLM te
 
 
 
-### Terms specific to Promptbook TypeScript implementation
-
--   Anonymous mode
--   Application mode
-
+## 🚂 Promptbook Engine
 
-
-## 🔌 Usage in Typescript / Javascript
-
--   [Simple usage](./examples/usage/simple-script)
--   [Usage with client and remote server](./examples/usage/remote)
+![Schema of Promptbook Engine](./documents/promptbook-engine.svg)
 
 ## ➕➖ When to use Promptbook?
 
@@ -414,13 +407,13 @@ See [TODO.md](./TODO.md)
 <div style="display: flex; align-items: center; gap: 20px;">
 
   <a href="https://promptbook.studio/">
-    <img src="./design/promptbook-studio-logo.png" alt="Partner 3" height="100">
+    <img src="./design/promptbook-studio-logo.png" alt="Partner 3" height="70">
   </a>
 
   <a href="https://technologickainkubace.org/en/about-technology-incubation/about-the-project/">
-    <img src="./other/partners/CI-Technology-Incubation.png" alt="Technology Incubation" height="100">
+    <img src="./other/partners/CI-Technology-Incubation.png" alt="Technology Incubation" height="70">
   </a>
-
+  
 </div>
 
 ## 🖋️ Contributing

package/esm/index.es.js

@@ -7,7 +7,7 @@ import { forTime } from 'waitasecond';
 import { spawn } from 'child_process';
 import { stat, access, constants, readFile, writeFile, readdir, mkdir } from 'fs/promises';
 import { join, basename, dirname } from 'path';
-import { BehaviorSubject } from 'rxjs';
+import { Subject } from 'rxjs';
 import { randomBytes } from 'crypto';
 import { format } from 'prettier';
 import parserHtml from 'prettier/parser-html';
@@ -31,7 +31,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.88.0-1';
+const PROMPTBOOK_ENGINE_VERSION = '0.88.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
@@ -1721,6 +1721,57 @@ function $randomToken(randomness) {
  * TODO: Maybe use nanoid instead https://github.com/ai/nanoid
  */
 
+/**
+ * Function isValidJsonString will tell you if the string is valid JSON or not
+ *
+ * @public exported from `@promptbook/utils`
+ */
+function isValidJsonString(value /* <- [👨‍⚖️] */) {
+    try {
+        JSON.parse(value);
+        return true;
+    }
+    catch (error) {
+        if (!(error instanceof Error)) {
+            throw error;
+        }
+        if (error.message.includes('Unexpected token')) {
+            return false;
+        }
+        return false;
+    }
+}
+
+/**
+ * Recursively converts JSON strings to JSON objects
+
+ * @public exported from `@promptbook/utils`
+ */
+function jsonStringsToJsons(object) {
+    if (object === null) {
+        return object;
+    }
+    if (Array.isArray(object)) {
+        return object.map(jsonStringsToJsons);
+    }
+    if (typeof object !== 'object') {
+        return object;
+    }
+    const newObject = { ...object };
+    for (const [key, value] of Object.entries(object)) {
+        if (typeof value === 'string' && isValidJsonString(value)) {
+            newObject[key] = JSON.parse(value);
+        }
+        else {
+            newObject[key] = jsonStringsToJsons(value);
+        }
+    }
+    return newObject;
+}
+/**
+ * TODO: Type the return type correctly
+ */
+
 /**
  * Deserializes the error object
  *
@@ -1793,21 +1844,43 @@ function assertsTaskSuccessful(executionResult) {
 function createTask(options) {
     const { taskType, taskProcessCallback } = options;
     const taskId = `${taskType.toLowerCase().substring(0, 4)}-${$randomToken(8 /* <- TODO: To global config + Use Base58 to avoid simmilar char conflicts   */)}`;
-    const partialResultSubject = new BehaviorSubject({});
+    let status = 'RUNNING';
+    const createdAt = new Date();
+    let updatedAt = createdAt;
+    const errors = [];
+    const warnings = [];
+    let currentValue = {};
+    const partialResultSubject = new Subject();
+    // <- Note: Not using `BehaviorSubject` because on error we can't access the last value
     const finalResultPromise = /* not await */ taskProcessCallback((newOngoingResult) => {
+        Object.assign(currentValue, newOngoingResult);
+        // <- TODO: assign deep
         partialResultSubject.next(newOngoingResult);
     });
     finalResultPromise
         .catch((error) => {
+        errors.push(error);
         partialResultSubject.error(error);
     })
-        .then((value) => {
-        if (value) {
+        .then((executionResult) => {
+        if (executionResult) {
             try {
-                assertsTaskSuccessful(value);
-                partialResultSubject.next(value);
+                updatedAt = new Date();
+                errors.push(...executionResult.errors);
+                warnings.push(...executionResult.warnings);
+                // <- TODO: !!! Only unique errors and warnings should be added (or filtered)
+                // TODO: [🧠] !!! errors, warning, isSuccessful  are redundant both in `ExecutionTask` and `ExecutionTask.currentValue`
+                //            Also maybe move `ExecutionTask.currentValue.usage` -> `ExecutionTask.usage`
+                //            And delete `ExecutionTask.currentValue.preparedPipeline`
+                assertsTaskSuccessful(executionResult);
+                status = 'FINISHED';
+                currentValue = jsonStringsToJsons(executionResult);
+                // <- TODO: [🧠] Is this a good idea to convert JSON strins to JSONs?
+                partialResultSubject.next(executionResult);
             }
             catch (error) {
+                status = 'ERROR';
+                errors.push(error);
                 partialResultSubject.error(error);
             }
         }
@@ -1824,12 +1897,33 @@ function createTask(options) {
     return {
         taskType,
         taskId,
+        get status() {
+            return status;
+            // <- Note: [1] Theese must be getters to allow changing the value in the future
+        },
+        get createdAt() {
+            return createdAt;
+            // <- Note: [1]
+        },
+        get updatedAt() {
+            return updatedAt;
+            // <- Note: [1]
+        },
         asPromise,
         asObservable() {
             return partialResultSubject.asObservable();
         },
+        get errors() {
+            return errors;
+            // <- Note: [1]
+        },
+        get warnings() {
+            return warnings;
+            // <- Note: [1]
+        },
         get currentValue() {
-            return partialResultSubject.value;
+            return currentValue;
+            // <- Note: [1]
         },
     };
 }
@@ -1904,27 +1998,6 @@ function isValidFilePath(filename) {
  * TODO: [🍏] Implement for MacOs
  */
 
-/**
- * Function isValidJsonString will tell you if the string is valid JSON or not
- *
- * @public exported from `@promptbook/utils`
- */
-function isValidJsonString(value /* <- [👨‍⚖️] */) {
-    try {
-        JSON.parse(value);
-        return true;
-    }
-    catch (error) {
-        if (!(error instanceof Error)) {
-            throw error;
-        }
-        if (error.message.includes('Unexpected token')) {
-            return false;
-        }
-        return false;
-    }
-}
-
 /**
  * Function `validatePipelineString` will validate the if the string is a valid pipeline string
  * It does not check if the string is fully logically correct, but if it is a string that can be a pipeline string or the string looks completely different.
@@ -5053,7 +5126,7 @@ async function executeAttempts(options) {
                         Last result:
                         ${block($ongoingTaskResult.$resultString === null
                     ? 'null'
-                    : $ongoingTaskResult.$resultString
+                    : spaceTrim($ongoingTaskResult.$resultString)
                         .split('\n')
                         .map((line) => `> ${line}`)
                         .join('\n'))}
@@ -6740,8 +6813,35 @@ function startRemoteServer(options) {
                 .send({ error: serializeError(error) });
         }
     });
+    function exportExecutionTask(executionTask, isFull) {
+        // <- TODO: [🧠] This should be maybe method of `ExecutionTask` itself
+        const { taskType, taskId, status, errors, warnings, createdAt, updatedAt, currentValue } = executionTask;
+        if (isFull) {
+            return {
+                nonce: '✨',
+                taskId,
+                taskType,
+                status,
+                errors: errors.map(serializeError),
+                warnings: warnings.map(serializeError),
+                createdAt,
+                updatedAt,
+                currentValue,
+            };
+        }
+        else {
+            return {
+                nonce: '✨',
+                taskId,
+                taskType,
+                status,
+                createdAt,
+                updatedAt,
+            };
+        }
+    }
     app.get(`${rootPath}/executions`, async (request, response) => {
-        response.send(runningExecutionTasks);
+        response.send(runningExecutionTasks.map((runningExecutionTask) => exportExecutionTask(runningExecutionTask, false)));
     });
     app.get(`${rootPath}/executions/last`, async (request, response) => {
         // TODO: [🤬] Filter only for user
@@ -6749,20 +6849,20 @@ function startRemoteServer(options) {
             response.status(404).send('No execution tasks found');
             return;
         }
-        const lastExecution = runningExecutionTasks[runningExecutionTasks.length - 1];
-        response.send(lastExecution);
+        const lastExecutionTask = runningExecutionTasks[runningExecutionTasks.length - 1];
+        response.send(exportExecutionTask(lastExecutionTask, true));
     });
     app.get(`${rootPath}/executions/:taskId`, async (request, response) => {
         const { taskId } = request.params;
         // TODO: [🤬] Filter only for user
-        const execution = runningExecutionTasks.find((executionTask) => executionTask.taskId === taskId);
-        if (execution === undefined) {
+        const executionTask = runningExecutionTasks.find((executionTask) => executionTask.taskId === taskId);
+        if (executionTask === undefined) {
             response
                 .status(404)
                 .send(`Execution "${taskId}" not found`);
             return;
         }
-        response.send(execution.currentValue);
+        response.send(exportExecutionTask(executionTask, true));
     });
     app.post(`${rootPath}/executions/new`, async (request, response) => {
         try {