@promptbook/documents 0.86.31 → 0.88.0-10

package/esm/typings/src/_packages/node.index.d.ts

@@ -6,6 +6,7 @@ import { $provideLlmToolsConfigurationFromEnv } from '../llm-providers/_common/r
 import { $provideLlmToolsFromEnv } from '../llm-providers/_common/register/$provideLlmToolsFromEnv';
 import { $provideFilesystemForNode } from '../scrapers/_common/register/$provideFilesystemForNode';
 import { $provideScrapersForNode } from '../scrapers/_common/register/$provideScrapersForNode';
+import { $provideScriptingForNode } from '../scrapers/_common/register/$provideScriptingForNode';
 import { FileCacheStorage } from '../storage/file-cache-storage/FileCacheStorage';
 import { $execCommand } from '../utils/execCommand/$execCommand';
 import { $execCommands } from '../utils/execCommand/$execCommands';
@@ -17,6 +18,7 @@ export { $provideLlmToolsConfigurationFromEnv };
 export { $provideLlmToolsFromEnv };
 export { $provideFilesystemForNode };
 export { $provideScrapersForNode };
+export { $provideScriptingForNode };
 export { FileCacheStorage };
 export { $execCommand };
 export { $execCommands };

package/esm/typings/src/_packages/types.index.d.ts

@@ -40,6 +40,7 @@ import type { ExecutionReportString } from '../execution/execution-report/Execut
 import type { ExecutionReportStringOptions } from '../execution/execution-report/ExecutionReportStringOptions';
 import type { ExecutionTask } from '../execution/ExecutionTask';
 import type { PreparationTask } from '../execution/ExecutionTask';
+import type { task_status } from '../execution/ExecutionTask';
 import type { AbstractTask } from '../execution/ExecutionTask';
 import type { Task } from '../execution/ExecutionTask';
 import type { ExecutionTools } from '../execution/ExecutionTools';
@@ -322,6 +323,7 @@ export type { ExecutionReportString };
 export type { ExecutionReportStringOptions };
 export type { ExecutionTask };
 export type { PreparationTask };
+export type { task_status };
 export type { AbstractTask };
 export type { Task };
 export type { ExecutionTools };

package/esm/typings/src/_packages/utils.index.d.ts

@@ -62,6 +62,7 @@ import { clonePipeline } from '../utils/serialization/clonePipeline';
 import { deepClone } from '../utils/serialization/deepClone';
 import { exportJson } from '../utils/serialization/exportJson';
 import { isSerializableAsJson } from '../utils/serialization/isSerializableAsJson';
+import { jsonStringsToJsons } from '../utils/serialization/jsonStringsToJsons';
 import { difference } from '../utils/sets/difference';
 import { intersection } from '../utils/sets/intersection';
 import { union } from '../utils/sets/union';
@@ -143,6 +144,7 @@ export { clonePipeline };
 export { deepClone };
 export { exportJson };
 export { isSerializableAsJson };
+export { jsonStringsToJsons };
 export { difference };
 export { intersection };
 export { union };

package/esm/typings/src/cli/cli-commands/common/handleActionErrors.d.ts

@@ -0,0 +1,11 @@
+import type { Command as Program } from 'commander';
+type actionCallbackFunction = Parameters<Program['action']>[0];
+/**
+ * Wraps action to handle error console logging and exit process with error code
+ *
+ * @param action Action to be wrapped in error handling
+ * @returns Wrapped action
+ * @private internal helper function for CLI commands
+ */
+export declare function handleActionErrors(action: actionCallbackFunction): actionCallbackFunction;
+export {};

package/esm/typings/src/execution/ExecutionTask.d.ts

@@ -40,6 +40,10 @@ export type PreparationTask = AbstractTask<PipelineExecutorResult> & {
     readonly taskType: 'PREPARATION';
     readonly taskId: `prep-${task_id}`;
 };
+/**
+ * Status of a task
+ */
+export type task_status = 'RUNNING' | 'FINISHED' | 'ERROR';
 /**
  * Base interface for all task types
  */
@@ -52,6 +56,18 @@ export type AbstractTask<TTaskResult extends AbstractTaskResult> = {
      * Unique identifier for the task
      */
     readonly taskId: task_id;
+    /**
+     * Status of the task
+     */
+    readonly status: task_status;
+    /**
+     * Date when the task was created
+     */
+    readonly createdAt: Date;
+    /**
+     * Date when the task was last updated
+     */
+    readonly updatedAt: Date;
     /**
      * Gets a promise that resolves with the task result
      */
@@ -66,6 +82,14 @@ export type AbstractTask<TTaskResult extends AbstractTaskResult> = {
      * Gets just the current value which is mutated during the task processing
      */
     currentValue: PartialDeep<TTaskResult>;
+    /**
+     * List of errors that occurred during the task processing
+     */
+    readonly errors: Array<Error>;
+    /**
+     * List of warnings that occurred during the task processing
+     */
+    readonly warnings: Array<Error>;
 };
 export type Task = ExecutionTask | PreparationTask;
 export {};

package/esm/typings/src/scrapers/_common/register/$provideScriptingForNode.d.ts

@@ -0,0 +1,11 @@
+import type { ScriptExecutionTools } from '../../../execution/ScriptExecutionTools';
+import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
+/**
+ * Provides script execution tools
+ *
+ * @public exported from `@promptbook/node`
+ */
+export declare function $provideScriptingForNode(options?: PrepareAndScrapeOptions): Promise<ReadonlyArray<ScriptExecutionTools>>;
+/**
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

package/esm/typings/src/scripting/javascript/JavascriptEvalExecutionTools.d.ts

@@ -6,7 +6,7 @@ import type { JavascriptExecutionToolsOptions } from './JavascriptExecutionTools
  * Warning: It is used for testing and mocking
  *          **NOT intended to use in the production** due to its unsafe nature, use `JavascriptExecutionTools` instead.
  *
- * @public exported from `@promptbook/execute-javascript`
+ * @public exported from `@promptbook/javascript`
  */
 export declare class JavascriptEvalExecutionTools implements ScriptExecutionTools {
     protected readonly options: JavascriptExecutionToolsOptions;

package/esm/typings/src/scripting/javascript/JavascriptExecutionTools.d.ts

@@ -3,6 +3,6 @@ import { JavascriptEvalExecutionTools } from './JavascriptEvalExecutionTools';
  * Placeholder for better implementation of JavascriptExecutionTools - some propper sandboxing
  *
  * @alias JavascriptExecutionTools
- * @public exported from `@promptbook/execute-javascript`
+ * @public exported from `@promptbook/javascript`
  */
 export declare const JavascriptExecutionTools: typeof JavascriptEvalExecutionTools;

package/esm/typings/src/scripting/javascript/postprocessing-functions.d.ts

@@ -20,7 +20,7 @@ import { unwrapResult } from '../../utils/unwrapResult';
 /**
  * @@@
  *
- * @public exported from `@promptbook/execute-javascript`
+ * @public exported from `@promptbook/javascript`
  */
 export declare const POSTPROCESSING_FUNCTIONS: {
     spaceTrim: typeof spaceTrim;

package/esm/typings/src/scripting/javascript/utils/extractVariablesFromJavascript.d.ts

@@ -6,7 +6,7 @@ import type { string_javascript_name } from '../../../types/typeAliases';
  * @param script from which to extract the variables
  * @returns the list of variable names
  * @throws {ParseError} if the script is invalid
- * @public exported from `@promptbook/execute-javascript`
+ * @public exported from `@promptbook/javascript`
  */
 export declare function extractVariablesFromJavascript(script: string_javascript): Set<string_javascript_name>;
 /**

package/esm/typings/src/utils/serialization/jsonStringsToJsons.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Recursively converts JSON strings to JSON objects
+
+ * @public exported from `@promptbook/utils`
+ */
+export declare function jsonStringsToJsons<T>(object: T): T;
+/**
+ * TODO: Type the return type correctly
+ */

package/esm/typings/src/utils/serialization/jsonStringsToJsons.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/documents",
-    "version": "0.86.31",
+    "version": "0.88.0-10",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "private": false,
     "sideEffects": false,
@@ -47,7 +47,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/documents.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.86.31"
+        "@promptbook/core": "0.88.0-10"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -26,7 +26,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.86.31';
+    const PROMPTBOOK_ENGINE_VERSION = '0.88.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
@@ -2236,6 +2236,36 @@
      * TODO: Maybe use nanoid instead https://github.com/ai/nanoid
      */
 
+    /**
+     * 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
+     */
+
     /**
      * This error indicates problems parsing the format value
      *
@@ -2462,21 +2492,43 @@
     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 rxjs.BehaviorSubject({});
+        let status = 'RUNNING';
+        const createdAt = new Date();
+        let updatedAt = createdAt;
+        const errors = [];
+        const warnings = [];
+        let currentValue = {};
+        const partialResultSubject = new rxjs.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);
                 }
             }
@@ -2493,12 +2545,33 @@
         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]
             },
         };
     }
@@ -3799,7 +3872,7 @@
      * @param script from which to extract the variables
      * @returns the list of variable names
      * @throws {ParseError} if the script is invalid
-     * @public exported from `@promptbook/execute-javascript`
+     * @public exported from `@promptbook/javascript`
      */
     function extractVariablesFromJavascript(script) {
         const variables = new Set();
@@ -4863,7 +4936,7 @@
                         Last result:
                         ${block($ongoingTaskResult.$resultString === null
                     ? 'null'
-                    : $ongoingTaskResult.$resultString
+                    : spaceTrim.spaceTrim($ongoingTaskResult.$resultString)
                         .split('\n')
                         .map((line) => `> ${line}`)
                         .join('\n'))}