@promptbook/legacy-documents 0.89.0-1 → 0.89.0-13

package/umd/index.umd.js

@@ -26,7 +26,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.89.0-1';
+    const PROMPTBOOK_ENGINE_VERSION = '0.89.0-13';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -121,6 +121,7 @@
         infinity: '(infinity; ∞)',
         negativeInfinity: '(negative infinity; -∞)',
         unserializable: '(unserializable value)',
+        circular: '(circular JSON)',
     };
     /**
      * Small number limit
@@ -160,6 +161,7 @@
      */
     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
      *
@@ -211,7 +213,7 @@
     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
      */
 
     /**
@@ -430,6 +432,7 @@
                     }
                     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');
                     }
                 });
@@ -455,6 +458,7 @@
                     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) => {
@@ -466,6 +470,7 @@
                         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.spaceTrim(output.join('\n')));
                         }
@@ -487,6 +492,7 @@
                     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.spaceTrim(output.join('\n')));
                     }
@@ -1063,6 +1069,56 @@
      * TODO: Maybe split `ParseError` and `ApplyError`
      */
 
+    /**
+     * This error type indicates that somewhere in the code non-Error object was thrown and it was wrapped into the `WrappedError`
+     *
+     * @public exported from `@promptbook/core`
+     */
+    class WrappedError extends Error {
+        constructor(whatWasThrown) {
+            const tag = `[🤮]`;
+            console.error(tag, whatWasThrown);
+            super(spaceTrim.spaceTrim((block) => `
+                    ${ /* Fixing tests !!!  block(valueToString(whatWasThrown)) */block(`non-Error object was thrown`)}
+
+                    Note: Look for ${tag} in the console for more details
+                    !!! Note: \`WrappedError\` indicates that somewhere in the code non-Error object was thrown and it was wrapped
+
+                    Please report issue on ${ADMIN_EMAIL}
+
+                `));
+            this.name = 'WrappedError';
+            Object.setPrototypeOf(this, WrappedError.prototype);
+        }
+    }
+
+    /**
+     * !!!@@@
+     *
+     * @param whatWasThrown !!!@@@
+     * @returns !!!@@@
+     *
+     * @private within the repository
+     */
+    function assertsError(whatWasThrown) {
+        // Case 1: !!!@@@
+        if (whatWasThrown instanceof WrappedError) {
+            const wrappedError = whatWasThrown;
+            throw wrappedError;
+        }
+        // Case 2: !!!@@@
+        if (whatWasThrown instanceof UnexpectedError) {
+            const unexpectedError = whatWasThrown;
+            throw unexpectedError;
+        }
+        // Case 3: !!!@@@
+        if (whatWasThrown instanceof Error) {
+            return;
+        }
+        // Case 4: !!!@@@
+        throw new WrappedError(whatWasThrown);
+    }
+
     /**
      * Function isValidJsonString will tell you if the string is valid JSON or not
      *
@@ -1074,9 +1130,7 @@
             return true;
         }
         catch (error) {
-            if (!(error instanceof Error)) {
-                throw error;
-            }
+            assertsError(error);
             if (error.message.includes('Unexpected token')) {
                 return false;
             }
@@ -1429,9 +1483,7 @@
                     JSON.stringify(value); // <- TODO: [0]
                 }
                 catch (error) {
-                    if (!(error instanceof Error)) {
-                        throw error;
-                    }
+                    assertsError(error);
                     throw new UnexpectedError(spaceTrim__default["default"]((block) => `
                             \`${name}\` is not serializable
 
@@ -2302,6 +2354,19 @@
         }
     }
 
+    /**
+     * 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
      *
@@ -2367,6 +2432,19 @@
         }
     }
 
+    /**
+     * 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
      *
@@ -2387,7 +2465,10 @@
         PipelineExecutionError,
         PipelineLogicError,
         PipelineUrlError,
+        AuthenticationError,
+        PromptbookFetchError,
         UnexpectedError,
+        WrappedError,
         // TODO: [🪑]> VersionMismatchError,
     };
     /**
@@ -2465,6 +2546,7 @@
         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;
@@ -2536,6 +2618,7 @@
                     partialResultSubject.next(executionResult);
                 }
                 catch (error) {
+                    assertsError(error);
                     status = 'ERROR';
                     errors.push(error);
                     partialResultSubject.error(error);
@@ -2602,6 +2685,10 @@
 
                     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)}
 
                 `));
@@ -2643,30 +2730,42 @@
         await Promise.all(tasks);
     }
 
+    /**
+     * 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,
         },
     });
     /**
@@ -2675,24 +2774,24 @@
      * @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,
         },
     });
     /**
@@ -2911,14 +3010,15 @@
                     }
                 }
                 catch (error) {
-                    if (!(error instanceof Error) || error instanceof UnexpectedError) {
+                    assertsError(error);
+                    if (error instanceof UnexpectedError) {
                         throw error;
                     }
                     errors.push({ llmExecutionTools, error });
                 }
             }
             if (errors.length === 1) {
-                throw errors[0];
+                throw errors[0].error;
             }
             else if (errors.length > 1) {
                 throw new PipelineExecutionError(
@@ -2980,6 +3080,7 @@
         `);
             // 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() {
@@ -3355,17 +3456,22 @@
     /**
      * 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;
+            assertsError(error);
+            let url;
+            if (typeof urlOrRequest === 'string') {
+                url = urlOrRequest;
             }
-            throw new KnowledgeScrapeError(spaceTrim__default["default"]((block) => `
+            else if (urlOrRequest instanceof Request) {
+                url = urlOrRequest.url;
+            }
+            throw new PromptbookFetchError(spaceTrim__default["default"]((block) => `
                     Can not fetch "${url}"
 
                     Fetch error:
@@ -3386,7 +3492,7 @@
     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, 
@@ -3527,63 +3633,71 @@
         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__default["default"]((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__default["default"]((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__default["default"]((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__default["default"]((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) {
+                assertsError(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;
@@ -3872,13 +3986,19 @@
                 return value.toISOString();
             }
             else {
-                return JSON.stringify(value);
+                try {
+                    return JSON.stringify(value);
+                }
+                catch (error) {
+                    if (error instanceof TypeError && error.message.includes('circular structure')) {
+                        return VALUE_STRINGS.circular;
+                    }
+                    throw error;
+                }
             }
         }
         catch (error) {
-            if (!(error instanceof Error)) {
-                throw error;
-            }
+            assertsError(error);
             console.error(error);
             return VALUE_STRINGS.unserializable;
         }
@@ -3935,9 +4055,7 @@
                 }
         }
         catch (error) {
-            if (!(error instanceof Error)) {
-                throw error;
-            }
+            assertsError(error);
             throw new ParseError(spaceTrim.spaceTrim((block) => `
                     Can not extract variables from the script
                     ${block(error.stack || error.message)}
@@ -4001,7 +4119,7 @@
                 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
                 }
             }
         }
@@ -4802,9 +4920,7 @@
                                     break scripts;
                                 }
                                 catch (error) {
-                                    if (!(error instanceof Error)) {
-                                        throw error;
-                                    }
+                                    assertsError(error);
                                     if (error instanceof UnexpectedError) {
                                         throw error;
                                     }
@@ -4874,9 +4990,7 @@
                                 break scripts;
                             }
                             catch (error) {
-                                if (!(error instanceof Error)) {
-                                    throw error;
-                                }
+                                assertsError(error);
                                 if (error instanceof UnexpectedError) {
                                     throw error;
                                 }
@@ -5497,9 +5611,7 @@
             await Promise.all(resolving);
         }
         catch (error /* <- Note: [3] */) {
-            if (!(error instanceof Error)) {
-                throw error;
-            }
+            assertsError(error);
             // Note: No need to rethrow UnexpectedError
             // if (error instanceof UnexpectedError) {
             // Note: Count usage, [🧠] Maybe put to separate function executionReportJsonToUsage + DRY [🤹‍♂️]
@@ -5597,6 +5709,7 @@
 
                     @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) => {