@promptbook/cli 0.89.0-1 → 0.89.0-2

package/esm/index.es.js

@@ -44,7 +44,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-2';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -1679,30 +1679,42 @@ function cacheLlmTools(llmTools, options = {}) {
  *            @@@ write how to combine multiple interceptors
  */
 
+/**
+ * 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,
     },
 });
 /**
@@ -1711,24 +1723,24 @@ const ZERO_USAGE = $deepFreeze({
  * @public exported from `@promptbook/core`
  */
 const UNCERTAIN_USAGE = $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,
     },
 });
 /**
@@ -2411,6 +2423,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() {
@@ -2704,6 +2717,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');
                 }
             });
@@ -2729,6 +2743,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) => {
@@ -2740,6 +2755,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')));
                     }
@@ -2761,6 +2777,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')));
                 }
@@ -4314,6 +4331,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;
@@ -4655,7 +4673,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
             }
         }
     }
@@ -6270,6 +6288,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) => {
@@ -6612,63 +6631,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;
@@ -8493,7 +8522,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(`
@@ -8525,6 +8555,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(`
@@ -8804,15 +8835,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);
 }
 
@@ -11443,6 +11474,7 @@ function $initializeMakeCommand(program) {
                 : join(path, `${DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME}.${extension}`);
             if (!output.endsWith(`.${extension}`)) {
                 console.warn(colors.yellow(`Warning: Extension of output file should be "${extension}"`));
+                // <- TODO: [🏮] Some standard way how to transform errors into warnings and how to handle non-critical fails during the tasks
             }
             await mkdir(dirname(filename), { recursive: true });
             if (typeof content === 'string') {
@@ -11543,6 +11575,7 @@ function $initializeMakeCommand(program) {
         }
         if (formats.length > 0) {
             console.warn(colors.yellow(`Format ${formats.join(' and ')} is not supported`));
+            // <- TODO: [🏮] Some standard way how to transform errors into warnings and how to handle non-critical fails during the tasks
         }
         console.info(colors.green(`Collection builded successfully`));
         if (isVerbose) {
@@ -11589,7 +11622,8 @@ function addAutoGeneratedSection(content, options) {
                 `));
     }
     console.warn(`No place where to put the section <!--${sectionName}-->, using the end of the file`);
-    // <- 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
+    // <- TODO: [🏮] Some better way how to get warnings from pipeline parsing / logic
     return spaceTrim$1((block) => `
             ${block(content)}
 
@@ -12639,6 +12673,7 @@ function startRemoteServer(options) {
                     https://github.com/webgptorg/promptbook
                 `));
     });
+    // TODO: !!!!!! Add login route
     app.get(`${rootPath}/books`, async (request, response) => {
         if (collection === null) {
             response.status(500).send('No collection available');
@@ -12972,6 +13007,7 @@ function $initializeStartServerCommand(program) {
         const url = !rawUrl ? null : new URL(rawUrl);
         if (url !== null && url.port !== port.toString()) {
             console.warn(colors.yellow(`Port in --url is different from --port which the server will listen on, this is ok only if you proxy from one port to another, for exaple via nginx or docker`));
+            // <- TODO: [🏮] Some standard way how to transform errors into warnings and how to handle non-critical fails during the tasks
         }
         let rootUrl = undefined;
         if (url !== null) {
@@ -13117,6 +13153,58 @@ function $initializeTestCommand(program) {
  * Note: This is named "test-command.ts" to avoid name collision with jest unit test files
  */
 
+/**
+ * Initializes `login` command for Promptbook CLI utilities
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it registers a command in the CLI
+ *
+ * @private internal function of `promptbookCli`
+ */
+function $initializeLoginCommand(program) {
+    const loginCommand = program.command('login');
+    loginCommand.description(spaceTrim(`
+            Login to the remote Promptbook server
+        `));
+    loginCommand.action(handleActionErrors(async () => {
+        // @@@
+        console.error(colors.green(spaceTrim(`
+                        You will be logged in to https://promptbook.studio server.
+                        If you don't have an account, it will be created automatically.
+                    `)));
+        const { email, password } = await prompts([
+            {
+                type: 'text',
+                name: 'email',
+                message: 'Enter your email:',
+                validate: (value) => (isValidEmail(value) ? true : 'Valid email is required'),
+            },
+            {
+                type: 'password',
+                name: 'password',
+                message: 'Enter your password:',
+                validate: (value) => value.length /* <- TODO: [🧠] Better password validation */ > 0 ? true : 'Password is required',
+            },
+        ]);
+        TODO_USE(email, password);
+        await forTime(1000);
+        console.error(colors.green(spaceTrim(`
+                        Your account ${email} was successfully created.
+
+                        Please verify your email:
+                        https://brj.app/api/v1/customer/register-account?apiKey=PRODdh003eNKaec7PoO1AzU244tsL4WO
+
+                        After verification, you will receive 500 000 credits for free 🎉
+                    `)));
+        return process.exit(0);
+    }));
+}
+/**
+ * TODO: Pass remote server URL (and path)
+ * TODO: Implement non-interactive login
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
+ */
+
 /**
  * Runs CLI utilities of Promptbook package
  *
@@ -13143,6 +13231,7 @@ async function promptbookCli() {
     program.description(CLAIM);
     $initializeAboutCommand(program);
     $initializeRunCommand(program);
+    $initializeLoginCommand(program);
     $initializeHelloCommand(program);
     $initializeMakeCommand(program);
     $initializePrettifyCommand(program);
@@ -13463,7 +13552,7 @@ const ANTHROPIC_CLAUDE_MODELS = exportJson({
  * Helper of usage compute
  *
  * @param content the content of prompt or response
- * @returns part of PromptResultUsageCounts
+ * @returns part of UsageCounts
  *
  * @private internal utility of LlmExecutionTools
  */
@@ -13487,7 +13576,7 @@ function computeUsageCounts(content) {
  */
 function uncertainNumber(value) {
     if (value === null || value === undefined || Number.isNaN(value)) {
-        return { value: 0, isUncertain: true };
+        return UNCERTAIN_ZERO_VALUE;
     }
     return { value };
 }
@@ -13724,7 +13813,7 @@ class AnthropicClaudeExecutionTools {
         const resultContent = rawResponse.choices[0].text;
         // eslint-disable-next-line prefer-const
         complete = $getCurrentDate();
-        const usage = { price: 'UNKNOWN', inputTokens: 0, outputTokens: 0 /* <- TODO: [🐞] Compute usage * / } satisfies PromptResultUsage;
+        const usage = { price: 'UNKNOWN', inputTokens: 0, outputTokens: 0 /* <- TODO: [🐞] Compute usage * / } satisfies Usage;
 
 
 
@@ -14820,11 +14909,17 @@ function createExecutionToolsFromVercelProvider(options) {
                 throw new PipelineExecutionError('No response message');
             }
             const complete = $getCurrentDate();
-            /*
-            TODO: [🕘] Usage count
-            const usage = computeOpenAiUsage(content || '', resultContent || '', rawResponse);
-            */
-            const usage = UNCERTAIN_USAGE;
+            const usage = {
+                price: UNCERTAIN_ZERO_VALUE,
+                input: {
+                    tokensCount: uncertainNumber(rawResponse.usage.promptTokens),
+                    ...computeUsageCounts(rawPromptContent),
+                },
+                output: {
+                    tokensCount: uncertainNumber(rawResponse.usage.completionTokens),
+                    ...computeUsageCounts(rawResponse.text),
+                },
+            };
             return exportJson({
                 name: 'promptResult',
                 message: `Result of \`createExecutionToolsFromVercelProvider.callChatModel\``,
@@ -15177,15 +15272,18 @@ class OpenAiExecutionTools {
         }
         return this.client;
     }
+    /*
+    Note: Commenting this out to avoid circular dependency
     /**
      * Create (sub)tools for calling OpenAI API Assistants
      *
      * @param assistantId Which assistant to use
      * @returns Tools for calling OpenAI API Assistants with same token
-     */
-    createAssistantSubtools(assistantId) {
+     * /
+    public createAssistantSubtools(assistantId: string_token): OpenAiAssistantExecutionTools {
         return new OpenAiAssistantExecutionTools({ ...this.options, assistantId });
     }
+    */
     /**
      * Check the `options` passed to `constructor`
      */