@promptbook/documents 0.88.0-9 → 0.89.0-1

package/esm/typings/src/playground/playground.d.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env ts-node
+export {};
+/**
+ * Note: [⚫] Code in this file should never be published in any package
+ */

package/esm/typings/src/remote-server/socket-types/_subtypes/PromptbookServer_Identification.d.ts

@@ -37,7 +37,8 @@ export type PromptbookServer_AnonymousIdentification = {
     /**
      * Identifier of the end user
      *
-     * Note: this is passed to the certain model providers to identify misuse
+     * Note: This can be either some id or email or any other identifier
+     * Note: In anonymous mode, this is passed to the certain model providers to identify misuse
      * Note: In anonymous mode, there is no need to identify yourself, nor does it change the actual configuration of LLM Tools (unlike in application mode)
      */
     readonly userId?: string_user_id;

package/esm/typings/src/remote-server/types/RemoteServerOptions.d.ts

@@ -58,15 +58,27 @@ export type ApplicationRemoteServerOptions<TCustomOptions> = {
 };
 export type ApplicationRemoteServerClientOptions<TCustomOptions> = {
     /**
-     * @@@
+     * Identifier of the application
+     *
+     * Note: This is usefull when you use Promptbook remote server for multiple apps/frontends, if its used just for single app, use here just "app" or "your-app-name"
+     * Note: This can be some id or some semantic name like "email-agent"
      */
     readonly appId: string_app_id | null;
     /**
-     * @@@
+     * Identifier of the end user
+     *
+     * Note: This can be either some id or email or any other identifier
+     * Note: This is also passed to the certain model providers to identify misuse
      */
     readonly userId?: string_user_id;
     /**
-     * @@@
+     * Token of the user to verify its identity
+     *
+     * Note: This is passed for example to `createLlmExecutionTools`
+     */
+    readonly userToken?: string_user_id;
+    /**
+     * Additional arbitrary options to identify the client or to pass custom metadata
      */
     readonly customOptions?: TCustomOptions;
 };

package/esm/typings/src/types/typeAliases.d.ts

@@ -433,13 +433,13 @@ export type string_uuid = string & {
  *
  * @@@
  */
-export type string_app_id = id;
+export type string_app_id = id | 'app';
 /**
  * End user identifier
  *
  * @@@
  */
-export type string_user_id = id;
+export type string_user_id = id | string_email;
 /**
  * Semantic helper
  *

package/esm/typings/src/utils/expectation-counters/countCharacters.d.ts

@@ -5,3 +5,6 @@ import type { ExpectationAmount } from '../../pipeline/PipelineJson/Expectations
  * @public exported from `@promptbook/utils`
  */
 export declare function countCharacters(text: string): ExpectationAmount;
+/**
+ * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+ */ 

package/esm/typings/src/utils/expectation-counters/countLines.d.ts

@@ -7,3 +7,6 @@ import type { ExpectationAmount } from '../../pipeline/PipelineJson/Expectations
  * @public exported from `@promptbook/utils`
  */
 export declare function countLines(text: string): ExpectationAmount;
+/**
+ * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+ */ 

package/esm/typings/src/utils/expectation-counters/countPages.d.ts

@@ -7,3 +7,6 @@ import type { ExpectationAmount } from '../../pipeline/PipelineJson/Expectations
  * @public exported from `@promptbook/utils`
  */
 export declare function countPages(text: string): ExpectationAmount;
+/**
+ * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+ */ 

package/esm/typings/src/utils/expectation-counters/countParagraphs.d.ts

@@ -5,3 +5,6 @@ import type { ExpectationAmount } from '../../pipeline/PipelineJson/Expectations
  * @public exported from `@promptbook/utils`
  */
 export declare function countParagraphs(text: string): ExpectationAmount;
+/**
+ * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+ */ 

package/esm/typings/src/utils/expectation-counters/countSentences.d.ts

@@ -11,3 +11,6 @@ export declare function splitIntoSentences(text: string): ReadonlyArray<string>;
  * @public exported from `@promptbook/utils`
  */
 export declare function countSentences(text: string): ExpectationAmount;
+/**
+ * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+ */

package/esm/typings/src/utils/expectation-counters/countWords.d.ts

@@ -5,3 +5,6 @@ import type { ExpectationAmount } from '../../pipeline/PipelineJson/Expectations
  * @public exported from `@promptbook/utils`
  */
 export declare function countWords(text: string): ExpectationAmount;
+/**
+ * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+ */ 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/documents",
-    "version": "0.88.0-9",
+    "version": "0.89.0-1",
     "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.88.0-9"
+        "@promptbook/core": "0.89.0-1"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -1,8 +1,8 @@
 (function (global, factory) {
-    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('fs/promises'), require('spacetrim'), require('child_process'), require('colors'), require('waitasecond'), require('crypto-js'), require('crypto-js/enc-hex'), require('path'), require('prettier'), require('prettier/parser-html'), require('rxjs'), require('crypto'), require('crypto-js/sha256'), require('mime-types'), require('papaparse')) :
-    typeof define === 'function' && define.amd ? define(['exports', 'fs/promises', 'spacetrim', 'child_process', 'colors', 'waitasecond', 'crypto-js', 'crypto-js/enc-hex', 'path', 'prettier', 'prettier/parser-html', 'rxjs', 'crypto', 'crypto-js/sha256', 'mime-types', 'papaparse'], factory) :
-    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-documents"] = {}, global.promises, global.spaceTrim, global.child_process, global.colors, global.waitasecond, global.cryptoJs, global.hexEncoder, global.path, global.prettier, global.parserHtml, global.rxjs, global.crypto, global.sha256, global.mimeTypes, global.papaparse));
-})(this, (function (exports, promises, spaceTrim, child_process, colors, waitasecond, cryptoJs, hexEncoder, path, prettier, parserHtml, rxjs, crypto, sha256, mimeTypes, papaparse) { 'use strict';
+    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('fs/promises'), require('spacetrim'), require('child_process'), require('colors'), require('waitasecond'), require('crypto-js'), require('crypto-js/enc-hex'), require('path'), require('prettier'), require('prettier/parser-html'), require('crypto'), require('rxjs'), require('crypto-js/sha256'), require('mime-types'), require('papaparse')) :
+    typeof define === 'function' && define.amd ? define(['exports', 'fs/promises', 'spacetrim', 'child_process', 'colors', 'waitasecond', 'crypto-js', 'crypto-js/enc-hex', 'path', 'prettier', 'prettier/parser-html', 'crypto', 'rxjs', 'crypto-js/sha256', 'mime-types', 'papaparse'], factory) :
+    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-documents"] = {}, global.promises, global.spaceTrim, global.child_process, global.colors, global.waitasecond, global.cryptoJs, global.hexEncoder, global.path, global.prettier, global.parserHtml, global.crypto, global.rxjs, global.sha256, global.mimeTypes, global.papaparse));
+})(this, (function (exports, promises, spaceTrim, child_process, colors, waitasecond, cryptoJs, hexEncoder, path, prettier, parserHtml, crypto, rxjs, sha256, mimeTypes, papaparse) { 'use strict';
 
     function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -26,7 +26,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.88.0-9';
+    const PROMPTBOOK_ENGINE_VERSION = '0.89.0-1';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -158,7 +158,7 @@
      *
      * @public exported from `@promptbook/core`
      */
-    const DEFAULT_MAX_EXECUTION_ATTEMPTS = 3; // <- TODO: [🤹‍♂️]
+    const DEFAULT_MAX_EXECUTION_ATTEMPTS = 10; // <- TODO: [🤹‍♂️]
     // <- TODO: [🕝] Make also `BOOKS_DIRNAME_ALTERNATIVES`
     /**
      * Where to store the temporary downloads
@@ -2171,6 +2171,21 @@
         return new SimplePipelineCollection(...promptbooks);
     }
 
+    /**
+     * Generates random token
+     *
+     * Note: This function is cryptographically secure (it uses crypto.randomBytes internally)
+     *
+     * @private internal helper function
+     * @returns secure random token
+     */
+    function $randomToken(randomness) {
+        return crypto.randomBytes(randomness).toString('hex');
+    }
+    /**
+     * TODO: Maybe use nanoid instead https://github.com/ai/nanoid
+     */
+
     /**
      * This error indicates errors during the execution of the pipeline
      *
@@ -2178,11 +2193,17 @@
      */
     class PipelineExecutionError extends Error {
         constructor(message) {
+            // Added id parameter
             super(message);
             this.name = 'PipelineExecutionError';
+            // TODO: [🐙] DRY - Maybe $randomId
+            this.id = `error-${$randomToken(8 /* <- TODO: To global config + Use Base58 to avoid simmilar char conflicts   */)}`;
             Object.setPrototypeOf(this, PipelineExecutionError.prototype);
         }
     }
+    /**
+     * TODO: !!!!!! Add id to all errors
+     */
 
     /**
      * Determine if the pipeline is fully prepared
@@ -2221,21 +2242,6 @@
      *     - [♨] Are tasks prepared
      */
 
-    /**
-     * Generates random token
-     *
-     * Note: This function is cryptographically secure (it uses crypto.randomBytes internally)
-     *
-     * @private internal helper function
-     * @returns secure random token
-     */
-    function $randomToken(randomness) {
-        return crypto.randomBytes(randomness).toString('hex');
-    }
-    /**
-     * TODO: Maybe use nanoid instead https://github.com/ai/nanoid
-     */
-
     /**
      * Recursively converts JSON strings to JSON objects
 
@@ -2426,7 +2432,7 @@
      * @public exported from `@promptbook/utils`
      */
     function deserializeError(error) {
-        const { name, stack } = error;
+        const { name, stack, id } = error; // Added id
         let { message } = error;
         let ErrorClass = ALL_ERRORS[error.name];
         if (ErrorClass === undefined) {
@@ -2441,7 +2447,9 @@
                 ${block(stack || '')}
             `);
         }
-        return new ErrorClass(message);
+        const deserializedError = new ErrorClass(message);
+        deserializedError.id = id; // Assign id to the error object
+        return deserializedError;
     }
 
     /**
@@ -2491,6 +2499,7 @@
      */
     function createTask(options) {
         const { taskType, taskProcessCallback } = options;
+        // TODO: [🐙] DRY
         const taskId = `${taskType.toLowerCase().substring(0, 4)}-${$randomToken(8 /* <- TODO: To global config + Use Base58 to avoid simmilar char conflicts   */)}`;
         let status = 'RUNNING';
         const createdAt = new Date();
@@ -2523,7 +2532,7 @@
                     assertsTaskSuccessful(executionResult);
                     status = 'FINISHED';
                     currentValue = jsonStringsToJsons(executionResult);
-                    // <- TODO: Convert JSON values in string to JSON objects
+                    // <- TODO: [🧠] Is this a good idea to convert JSON strins to JSONs?
                     partialResultSubject.next(executionResult);
                 }
                 catch (error) {
@@ -2587,19 +2596,21 @@
      */
     function serializeError(error) {
         const { name, message, stack } = error;
+        const { id } = error;
         if (!Object.keys(ALL_ERRORS).includes(name)) {
             console.error(spaceTrim__default["default"]((block) => `
-          
+
                     Cannot serialize error with name "${name}"
 
                     ${block(stack || message)}
-                
+
                 `));
         }
         return {
             name: name,
             message,
             stack,
+            id, // Include id in the serialized object
         };
     }
 
@@ -2742,8 +2753,9 @@
      * @returns LLM tools with same functionality with added total cost counting
      * @public exported from `@promptbook/core`
      */
-    function countTotalUsage(llmTools) {
+    function countUsage(llmTools) {
         let totalUsage = ZERO_USAGE;
+        const spending = new rxjs.Subject();
         const proxyTools = {
             get title() {
                 // TODO: [🧠] Maybe put here some suffix
@@ -2753,12 +2765,15 @@
                 // TODO: [🧠] Maybe put here some suffix
                 return llmTools.description;
             },
-            async checkConfiguration() {
+            checkConfiguration() {
                 return /* not await */ llmTools.checkConfiguration();
             },
             listModels() {
                 return /* not await */ llmTools.listModels();
             },
+            spending() {
+                return spending.asObservable();
+            },
             getTotalUsage() {
                 // <- Note: [🥫] Not using getter `get totalUsage` but `getTotalUsage` to allow this object to be proxied
                 return totalUsage;
@@ -2769,6 +2784,7 @@
                 // console.info('[🚕] callChatModel through countTotalUsage');
                 const promptResult = await llmTools.callChatModel(prompt);
                 totalUsage = addUsage(totalUsage, promptResult.usage);
+                spending.next(promptResult.usage);
                 return promptResult;
             };
         }
@@ -2777,6 +2793,7 @@
                 // console.info('[🚕] callCompletionModel through countTotalUsage');
                 const promptResult = await llmTools.callCompletionModel(prompt);
                 totalUsage = addUsage(totalUsage, promptResult.usage);
+                spending.next(promptResult.usage);
                 return promptResult;
             };
         }
@@ -2785,6 +2802,7 @@
                 // console.info('[🚕] callEmbeddingModel through countTotalUsage');
                 const promptResult = await llmTools.callEmbeddingModel(prompt);
                 totalUsage = addUsage(totalUsage, promptResult.usage);
+                spending.next(promptResult.usage);
                 return promptResult;
             };
         }
@@ -3671,7 +3689,7 @@
         // TODO: [🚐] Make arrayable LLMs -> single LLM DRY
         const _llms = arrayableToArray(tools.llm);
         const llmTools = _llms.length === 1 ? _llms[0] : joinLlmExecutionTools(..._llms);
-        const llmToolsWithUsage = countTotalUsage(llmTools);
+        const llmToolsWithUsage = countUsage(llmTools);
         //    <- TODO: [🌯]
         /*
         TODO: [🧠][🪑][🔃] Should this be done or not
@@ -4501,6 +4519,9 @@
         text = text.replace(/\p{Extended_Pictographic}(\u{200D}\p{Extended_Pictographic})*/gu, '-');
         return text.length;
     }
+    /**
+     * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+     */
 
     /**
      * Number of characters per standard line with 11pt Arial font size.
@@ -4532,6 +4553,9 @@
         const lines = text.split('\n');
         return lines.reduce((count, line) => count + Math.ceil(line.length / CHARACTERS_PER_STANDARD_LINE), 0);
     }
+    /**
+     * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+     */
 
     /**
      * Counts number of pages in the text
@@ -4543,6 +4567,9 @@
     function countPages(text) {
         return Math.ceil(countLines(text) / LINES_PER_STANDARD_PAGE);
     }
+    /**
+     * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+     */
 
     /**
      * Counts number of paragraphs in the text
@@ -4552,6 +4579,9 @@
     function countParagraphs(text) {
         return text.split(/\n\s*\n/).filter((paragraph) => paragraph.trim() !== '').length;
     }
+    /**
+     * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+     */
 
     /**
      * Split text into sentences
@@ -4569,6 +4599,9 @@
     function countSentences(text) {
         return splitIntoSentences(text).length;
     }
+    /**
+     * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+     */
 
     /**
      * Counts number of words in the text
@@ -4582,6 +4615,9 @@
         text = text.replace(/([a-z])([A-Z])/g, '$1 $2');
         return text.split(/[^a-zа-я0-9]+/i).filter((word) => word.length > 0).length;
     }
+    /**
+     * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+     */
 
     /**
      * Index of all counter functions