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

package/README.md

@@ -58,8 +58,6 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
 
 During the computer revolution, we have seen [multiple generations of computer languages](https://github.com/webgptorg/promptbook/discussions/180), from the physical rewiring of the vacuum tubes through low-level machine code to the high-level languages like Python or JavaScript. And now, we're on the edge of the **next revolution**!
 
-
-
 It's a revolution of writing software in **plain human language** that is understandable and executable by both humans and machines – and it's going to change everything!
 
 The incredible growth in power of microprocessors and the Moore's Law have been the driving force behind the ever-more powerful languages, and it's been an amazing journey! Similarly, the large language models (like GPT or Claude) are the next big thing in language technology, and they're set to transform the way we interact with computers.
@@ -122,21 +120,16 @@ We also have a community of developers and users of **Promptbook**:
 -   [Landing page `ptbk.io`](https://ptbk.io)
 -   [Github discussions](https://github.com/webgptorg/promptbook/discussions)
 -   [LinkedIn `Promptbook`](https://linkedin.com/company/promptbook)
--   [Facebook `Promptbook`](https://www.facebook.com/61560776453536) 
+-   [Facebook `Promptbook`](https://www.facebook.com/61560776453536)
 
 And **Promptbook.studio** branded socials:
 
-
-
 -   [Instagram `@promptbook.studio`](https://www.instagram.com/promptbook.studio/)
 
 And **Promptujeme** sub-brand:
 
 _/Subbrand for Czech clients/_
 
-
-
-
 -   [Promptujeme.cz](https://www.promptujeme.cz/)
 -   [Facebook `Promptujeme`](https://www.facebook.com/promptujeme/)
 
@@ -154,8 +147,6 @@ _/Sub-brand for images and graphics generated via Promptbook prompting/_
 
 ## 💙 The Book language
 
-
-
 Following is the documentation and blueprint of the [Book language](https://github.com/webgptorg/book).
 
 Book is a language that can be used to write AI applications, agents, workflows, automations, knowledgebases, translators, sheet processors, email automations and more. It allows you to harness the power of AI models in human-like terms, without the need to know the specifics and technicalities of the models.
@@ -205,8 +196,6 @@ Personas can have access to different knowledge, tools and actions. They can als
 
 -   [PERSONA](https://github.com/webgptorg/promptbook/blob/main/documents/commands/PERSONA.md)
 
-
-
 ### **How:** Knowledge, Instruments and Actions
 
 The resources used by the personas are used to do the work.
@@ -282,11 +271,6 @@ Or you can install them separately:
 
 ## 📚 Dictionary
 
-
-
-
-
-
 ### 📚 Dictionary
 
 The following glossary is used to clarify certain concepts:
@@ -302,12 +286,8 @@ The following glossary is used to clarify certain concepts:
 -   **Retrieval-augmented generation** is a machine learning paradigm where a model generates text by retrieving relevant information from a large database of text. This approach combines the benefits of generative models and retrieval models.
 -   **Longtail** refers to non-common or rare events, items, or entities that are not well-represented in the training data of machine learning models. Longtail items are often challenging for models to predict accurately.
 
-
-
 _Note: Thos section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
 
-
-
 #### 💯 Core concepts
 
 -   [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)
@@ -336,8 +316,6 @@ _Note: Thos section is not complete dictionary, more list of general AI / LLM te
 -   [👮 Agent adversary expectations](https://github.com/webgptorg/promptbook/discussions/39)
 -   [view more](https://github.com/webgptorg/promptbook/discussions/categories/concepts)
 
-
-
 ### Terms specific to Promptbook TypeScript implementation
 
 -   Anonymous mode
@@ -345,10 +323,9 @@ _Note: Thos section is not complete dictionary, more list of general AI / LLM te
 
 
 
-## 🔌 Usage in Typescript / Javascript
+## 🚂 Promptbook Engine
 
--   [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?
 

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-9';
 /**
  * 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: Convert JSON values in string to JSON objects
+                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 {