@promptbook/node 0.89.0-1 → 0.89.0-11

package/README.md

@@ -204,7 +204,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:**
 
@@ -314,6 +314,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

@@ -30,7 +30,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.89.0-1';
+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
@@ -159,6 +159,7 @@ const DEFAULT_MAX_PARALLEL_COUNT = 5; // <- TODO: [🤹‍♂️]
  */
 const DEFAULT_MAX_EXECUTION_ATTEMPTS = 10; // <- TODO: [🤹‍♂️]
 // <- TODO: [🕝] Make also `BOOKS_DIRNAME_ALTERNATIVES`
+// TODO: !!!!!! Just .promptbook dir, hardocode others
 /**
  * Where to store the temporary downloads
  *
@@ -175,6 +176,15 @@ const DEFAULT_DOWNLOAD_CACHE_DIRNAME = './.promptbook/download-cache';
  * @public exported from `@promptbook/core`
  */
 const DEFAULT_SCRAPE_CACHE_DIRNAME = './.promptbook/scrape-cache';
+/*
+TODO: [🌃]
+/**
+ * Id of application for the wizzard when using remote server
+ *
+ * @public exported from `@promptbook/core`
+ * /
+ex-port const WIZZARD_APP_ID: string_app_id = 'wizzard';
+*/
 /**
  * The name of the builded pipeline collection made by CLI `ptbk make` and for lookup in `createCollectionFromDirectory`
  *
@@ -216,7 +226,7 @@ const IS_PIPELINE_LOGIC_VALIDATED = just(
 true);
 /**
  * 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
  */
 
 /**
@@ -1684,6 +1694,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
  *
@@ -1775,6 +1798,19 @@ class NotYetImplementedError 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);
+    }
+}
+
 /**
  * Index of all custom errors
  *
@@ -1812,6 +1848,8 @@ const COMMON_JAVASCRIPT_ERRORS = {
     TypeError,
     URIError,
     AggregateError,
+    AuthenticationError,
+    PromptbookFetchError,
     /*
   Note: Not widely supported
   > InternalError,
@@ -1873,6 +1911,7 @@ function assertsTaskSuccessful(executionResult) {
     const { isSuccessful, errors, warnings } = executionResult;
     for (const warning of warnings) {
         console.warn(warning.message);
+        // <- TODO: [🏮] Some standard way how to transform errors into warnings and how to handle non-critical fails during the tasks
     }
     if (isSuccessful === true) {
         return;
@@ -2010,6 +2049,10 @@ function serializeError(error) {
 
                     Cannot serialize error with name "${name}"
 
+                    Authors of Promptbook probably forgot to add this error into the list of errors:
+                    https://github.com/webgptorg/promptbook/blob/main/src/errors/0-index.ts
+
+
                     ${block(stack || message)}
 
                 `));
@@ -2097,30 +2140,42 @@ function valueToString(value) {
     }
 }
 
+/**
+ * Represents the uncertain value
+ *
+ * @public exported from `@promptbook/core`
+ */
+const ZERO_VALUE = $deepFreeze({ value: 0 });
+/**
+ * Represents the uncertain value
+ *
+ * @public exported from `@promptbook/core`
+ */
+const UNCERTAIN_ZERO_VALUE = $deepFreeze({ value: 0, isUncertain: true });
 /**
  * Represents the usage with no resources consumed
  *
  * @public exported from `@promptbook/core`
  */
 const ZERO_USAGE = $deepFreeze({
-    price: { value: 0 },
+    price: ZERO_VALUE,
     input: {
-        tokensCount: { value: 0 },
-        charactersCount: { value: 0 },
-        wordsCount: { value: 0 },
-        sentencesCount: { value: 0 },
-        linesCount: { value: 0 },
-        paragraphsCount: { value: 0 },
-        pagesCount: { value: 0 },
+        tokensCount: ZERO_VALUE,
+        charactersCount: ZERO_VALUE,
+        wordsCount: ZERO_VALUE,
+        sentencesCount: ZERO_VALUE,
+        linesCount: ZERO_VALUE,
+        paragraphsCount: ZERO_VALUE,
+        pagesCount: ZERO_VALUE,
     },
     output: {
-        tokensCount: { value: 0 },
-        charactersCount: { value: 0 },
-        wordsCount: { value: 0 },
-        sentencesCount: { value: 0 },
-        linesCount: { value: 0 },
-        paragraphsCount: { value: 0 },
-        pagesCount: { value: 0 },
+        tokensCount: ZERO_VALUE,
+        charactersCount: ZERO_VALUE,
+        wordsCount: ZERO_VALUE,
+        sentencesCount: ZERO_VALUE,
+        linesCount: ZERO_VALUE,
+        paragraphsCount: ZERO_VALUE,
+        pagesCount: ZERO_VALUE,
     },
 });
 /**
@@ -2129,24 +2184,24 @@ const ZERO_USAGE = $deepFreeze({
  * @public exported from `@promptbook/core`
  */
 $deepFreeze({
-    price: { value: 0, isUncertain: true },
+    price: UNCERTAIN_ZERO_VALUE,
     input: {
-        tokensCount: { value: 0, isUncertain: true },
-        charactersCount: { value: 0, isUncertain: true },
-        wordsCount: { value: 0, isUncertain: true },
-        sentencesCount: { value: 0, isUncertain: true },
-        linesCount: { value: 0, isUncertain: true },
-        paragraphsCount: { value: 0, isUncertain: true },
-        pagesCount: { value: 0, isUncertain: true },
+        tokensCount: UNCERTAIN_ZERO_VALUE,
+        charactersCount: UNCERTAIN_ZERO_VALUE,
+        wordsCount: UNCERTAIN_ZERO_VALUE,
+        sentencesCount: UNCERTAIN_ZERO_VALUE,
+        linesCount: UNCERTAIN_ZERO_VALUE,
+        paragraphsCount: UNCERTAIN_ZERO_VALUE,
+        pagesCount: UNCERTAIN_ZERO_VALUE,
     },
     output: {
-        tokensCount: { value: 0, isUncertain: true },
-        charactersCount: { value: 0, isUncertain: true },
-        wordsCount: { value: 0, isUncertain: true },
-        sentencesCount: { value: 0, isUncertain: true },
-        linesCount: { value: 0, isUncertain: true },
-        paragraphsCount: { value: 0, isUncertain: true },
-        pagesCount: { value: 0, isUncertain: true },
+        tokensCount: UNCERTAIN_ZERO_VALUE,
+        charactersCount: UNCERTAIN_ZERO_VALUE,
+        wordsCount: UNCERTAIN_ZERO_VALUE,
+        sentencesCount: UNCERTAIN_ZERO_VALUE,
+        linesCount: UNCERTAIN_ZERO_VALUE,
+        paragraphsCount: UNCERTAIN_ZERO_VALUE,
+        pagesCount: UNCERTAIN_ZERO_VALUE,
     },
 });
 /**
@@ -2317,7 +2372,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
             }
         }
     }
@@ -2811,6 +2866,7 @@ function joinLlmExecutionTools(...llmExecutionTools) {
         `);
         // TODO: [🟥] Detect browser / node and make it colorfull
         console.warn(warningMessage);
+        // <- TODO: [🏮] Some standard way how to transform errors into warnings and how to handle non-critical fails during the tasks
         /*
         return {
             async listModels() {
@@ -4400,6 +4456,7 @@ function createPipelineExecutor(options) {
 
                     @see more at https://ptbk.io/prepare-pipeline
                 `));
+        // <- TODO: [🏮] Some standard way how to transform errors into warnings and how to handle non-critical fails during the tasks
     }
     let runCount = 0;
     const pipelineExecutorWithCallback = async (inputParameters, onProgress) => {
@@ -5004,17 +5061,24 @@ function titleToName(value) {
 /**
  * The built-in `fetch' function with a lightweight error handling wrapper as default fetch function used in Promptbook scrapers
  *
- * @private as default `fetch` function used in Promptbook scrapers
+ * @public exported from `@promptbook/core`
  */
-const scraperFetch = async (url, init) => {
+const promptbookFetch = async (urlOrRequest, init) => {
     try {
-        return await fetch(url, init);
+        return await fetch(urlOrRequest, init);
     }
     catch (error) {
         if (!(error instanceof Error)) {
             throw error;
         }
-        throw new KnowledgeScrapeError(spaceTrim((block) => `
+        let url;
+        if (typeof urlOrRequest === 'string') {
+            url = urlOrRequest;
+        }
+        else if (urlOrRequest instanceof Request) {
+            url = urlOrRequest.url;
+        }
+        throw new PromptbookFetchError(spaceTrim((block) => `
                     Can not fetch "${url}"
 
                     Fetch error:
@@ -5035,7 +5099,7 @@ const scraperFetch = async (url, init) => {
 async function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
     // console.log('!! makeKnowledgeSourceHandler', knowledgeSource);
     var _a;
-    const { fetch = scraperFetch } = tools;
+    const { fetch = promptbookFetch } = tools;
     const { knowledgeSourceContent } = knowledgeSource;
     let { name } = knowledgeSource;
     const { rootDirname = null, 
@@ -5176,63 +5240,73 @@ async function prepareKnowledgePieces(knowledgeSources, tools, options) {
     const { maxParallelCount = DEFAULT_MAX_PARALLEL_COUNT, rootDirname, isVerbose = DEFAULT_IS_VERBOSE } = options;
     const knowledgePreparedUnflatten = new Array(knowledgeSources.length);
     await forEachAsync(knowledgeSources, { maxParallelCount }, async (knowledgeSource, index) => {
-        let partialPieces = null;
-        const sourceHandler = await makeKnowledgeSourceHandler(knowledgeSource, tools, { rootDirname, isVerbose });
-        const scrapers = arrayableToArray(tools.scrapers);
-        for (const scraper of scrapers) {
-            if (!scraper.metadata.mimeTypes.includes(sourceHandler.mimeType)
-            // <- TODO: [🦔] Implement mime-type wildcards
-            ) {
-                continue;
-            }
-            const partialPiecesUnchecked = await scraper.scrape(sourceHandler);
-            if (partialPiecesUnchecked !== null) {
-                partialPieces = [...partialPiecesUnchecked];
-                // <- TODO: [🪓] Here should be no need for spreading new array, just `partialPieces = partialPiecesUnchecked`
-                break;
-            }
-            console.warn(spaceTrim((block) => `
-                        Cannot scrape knowledge from source despite the scraper \`${scraper.metadata.className}\` supports the mime type "${sourceHandler.mimeType}".
+        try {
+            let partialPieces = null;
+            const sourceHandler = await makeKnowledgeSourceHandler(knowledgeSource, tools, { rootDirname, isVerbose });
+            const scrapers = arrayableToArray(tools.scrapers);
+            for (const scraper of scrapers) {
+                if (!scraper.metadata.mimeTypes.includes(sourceHandler.mimeType)
+                // <- TODO: [🦔] Implement mime-type wildcards
+                ) {
+                    continue;
+                }
+                const partialPiecesUnchecked = await scraper.scrape(sourceHandler);
+                if (partialPiecesUnchecked !== null) {
+                    partialPieces = [...partialPiecesUnchecked];
+                    // <- TODO: [🪓] Here should be no need for spreading new array, just `partialPieces = partialPiecesUnchecked`
+                    break;
+                }
+                console.warn(spaceTrim((block) => `
+                            Cannot scrape knowledge from source despite the scraper \`${scraper.metadata.className}\` supports the mime type "${sourceHandler.mimeType}".
 
-                        The source:
-                        ${block(knowledgeSource.knowledgeSourceContent
-                .split('\n')
-                .map((line) => `> ${line}`)
-                .join('\n'))}
+                            The source:
+                            ${block(knowledgeSource.knowledgeSourceContent
+                    .split('\n')
+                    .map((line) => `> ${line}`)
+                    .join('\n'))}
 
-                        ${block($registeredScrapersMessage(scrapers))}
+                            ${block($registeredScrapersMessage(scrapers))}
 
 
-                    `));
-        }
-        if (partialPieces === null) {
-            throw new KnowledgeScrapeError(spaceTrim((block) => `
-                        Cannot scrape knowledge
+                        `));
+                // <- TODO: [🏮] Some standard way how to transform errors into warnings and how to handle non-critical fails during the tasks
+            }
+            if (partialPieces === null) {
+                throw new KnowledgeScrapeError(spaceTrim((block) => `
+                            Cannot scrape knowledge
 
-                        The source:
-                        > ${block(knowledgeSource.knowledgeSourceContent
-                .split('\n')
-                .map((line) => `> ${line}`)
-                .join('\n'))}
+                            The source:
+                            > ${block(knowledgeSource.knowledgeSourceContent
+                    .split('\n')
+                    .map((line) => `> ${line}`)
+                    .join('\n'))}
 
-                        No scraper found for the mime type "${sourceHandler.mimeType}"
+                            No scraper found for the mime type "${sourceHandler.mimeType}"
 
-                        ${block($registeredScrapersMessage(scrapers))}
+                            ${block($registeredScrapersMessage(scrapers))}
 
 
-                    `));
+                        `));
+            }
+            const pieces = partialPieces.map((partialPiece) => ({
+                ...partialPiece,
+                sources: [
+                    {
+                        name: knowledgeSource.name,
+                        // line, column <- TODO: [☀]
+                        // <- TODO: [❎]
+                    },
+                ],
+            }));
+            knowledgePreparedUnflatten[index] = pieces;
+        }
+        catch (error) {
+            if (!(error instanceof Error)) {
+                throw error;
+            }
+            console.warn(error);
+            // <- TODO: [🏮] Some standard way how to transform errors into warnings and how to handle non-critical fails during the tasks
         }
-        const pieces = partialPieces.map((partialPiece) => ({
-            ...partialPiece,
-            sources: [
-                {
-                    name: knowledgeSource.name,
-                    // line, column <- TODO: [☀]
-                    // <- TODO: [❎]
-                },
-            ],
-        }));
-        knowledgePreparedUnflatten[index] = pieces;
     });
     const knowledgePrepared = knowledgePreparedUnflatten.flat();
     return knowledgePrepared;
@@ -7057,7 +7131,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(`
@@ -7089,6 +7164,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(`
@@ -7368,15 +7444,15 @@ function $applyToTaskJson(command, $taskJson, $pipelineJson) {
     }
     console.warn(spaceTrim(`
 
-         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('\n\n' + personaDescription);
 }
 
@@ -9012,6 +9088,7 @@ function $execCommand(options) {
                 }
                 else {
                     console.warn(`Command "${humanReadableCommand}" exceeded time limit of ${timeout}ms but continues running`);
+                    // <- TODO: [🏮] Some standard way how to transform errors into warnings and how to handle non-critical fails during the tasks
                     resolve('Command exceeded time limit');
                 }
             });
@@ -9037,6 +9114,7 @@ function $execCommand(options) {
                 output.push(stderr.toString());
                 if (isVerbose && stderr.toString().trim()) {
                     console.warn(stderr.toString());
+                    // <- TODO: [🏮] Some standard way how to transform errors into warnings and how to handle non-critical fails during the tasks
                 }
             });
             const finishWithCode = (code) => {
@@ -9048,6 +9126,7 @@ function $execCommand(options) {
                     else {
                         if (isVerbose) {
                             console.warn(`Command "${humanReadableCommand}" exited with code ${code}`);
+                            // <- TODO: [🏮] Some standard way how to transform errors into warnings and how to handle non-critical fails during the tasks
                         }
                         resolve(spaceTrim$1(output.join('\n')));
                     }
@@ -9069,6 +9148,7 @@ function $execCommand(options) {
                 else {
                     if (isVerbose) {
                         console.warn(error);
+                        // <- TODO: [🏮] Some standard way how to transform errors into warnings and how to handle non-critical fails during the tasks
                     }
                     resolve(spaceTrim$1(output.join('\n')));
                 }
@@ -9499,21 +9579,15 @@ function $registeredLlmToolsMessage() {
  */
 
 /**
- * @@@
- *
- * @@@ .env
+ * Provides the path to the `.env` file
  *
- * It looks for environment variables:
- * - `process.env.OPENAI_API_KEY`
- * - `process.env.ANTHROPIC_CLAUDE_API_KEY`
- * - ...
+ * Note: `$` is used to indicate that this function is not a pure function - it uses filesystem to access `.env` file
  *
- * @returns @@@
- * @public exported from `@promptbook/node`
+ * @private within the repository - for CLI utils
  */
-async function $provideLlmToolsConfigurationFromEnv() {
+async function $provideEnvFilename() {
     if (!$isRunningInNode()) {
-        throw new EnvironmentMismatchError('Function `$provideLlmToolsFromEnv` works only in Node.js environment');
+        throw new EnvironmentMismatchError('Function `$provideEnvFilename` works only in Node.js environment');
     }
     const envFilePatterns = [
         '.env',
@@ -9533,8 +9607,7 @@ async function $provideLlmToolsConfigurationFromEnv() {
             const envFilename = join(rootDirname, pattern);
             if (await isFileExisting(envFilename, $provideFilesystemForNode())) {
                 $setUsedEnvFilename(envFilename);
-                dotenv.config({ path: envFilename });
-                break up_to_root;
+                return envFilename;
             }
         }
         if (isRootPath(rootDirname)) {
@@ -9543,6 +9616,34 @@ async function $provideLlmToolsConfigurationFromEnv() {
         // Note: If the directory does not exist, try the parent directory
         rootDirname = join(rootDirname, '..');
     }
+    return null;
+}
+/**
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */
+
+/**
+ * @@@
+ *
+ * @@@ .env
+ * Note: `$` is used to indicate that this function is not a pure function - it uses filesystem to access `.env` file
+ *
+ * It looks for environment variables:
+ * - `process.env.OPENAI_API_KEY`
+ * - `process.env.ANTHROPIC_CLAUDE_API_KEY`
+ * - ...
+ *
+ * @returns @@@
+ * @public exported from `@promptbook/node`
+ */
+async function $provideLlmToolsConfigurationFromEnv() {
+    if (!$isRunningInNode()) {
+        throw new EnvironmentMismatchError('Function `$provideLlmToolsFromEnv` works only in Node.js environment');
+    }
+    const envFilepath = await $provideEnvFilename();
+    if (envFilepath !== null) {
+        dotenv.config({ path: envFilepath });
+    }
     const llmToolsConfiguration = $llmToolsMetadataRegister
         .list()
         .map((metadata) => metadata.createConfigurationFromEnv(process.env))
@@ -9550,15 +9651,8 @@ async function $provideLlmToolsConfigurationFromEnv() {
     return llmToolsConfiguration;
 }
 /**
- * TODO: [🧠][🪁] Maybe do allow to do auto-install if package not registered and not found
- * TODO: Add Azure OpenAI
- * TODO: [🧠][🍛]
- * TODO: [🧠] Is there some meaningfull way how to test this util
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
- * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
- * TODO: This should be maybe not under `_common` but under `utils`
- * TODO: [🧠][⚛] Maybe pass env as argument
- * TODO: [®] DRY Register logic */
+ */
 
 /**
  * @@@
@@ -9617,6 +9711,7 @@ function createLlmToolsFromConfiguration(configuration, options = {}) {
  * Note: This function is not cached, every call creates new instance of `MultipleLlmExecutionTools`
  *
  * @@@ .env
+ * Note: `$` is used to indicate that this function is not a pure function - it uses filesystem to access `.env` file
  *
  * It looks for environment variables:
  * - `process.env.OPENAI_API_KEY`