@promptbook/cli 0.89.0-15 → 0.89.0-17

package/umd/index.umd.js

@@ -56,7 +56,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.89.0-15';
+    const PROMPTBOOK_ENGINE_VERSION = '0.89.0-17';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -116,6 +116,7 @@
      * @public exported from `@promptbook/core`
      */
     const CLAIM = `It's time for a paradigm shift. The future of software in plain English, French or Latin`;
+    //            <- TODO: [🐊] Pick the best claim
     /**
      * When the title is not provided, the default title is used
      *
@@ -146,6 +147,12 @@
      * @private within the repository
      */
     const GENERATOR_WARNING_BY_PROMPTBOOK_CLI = `⚠️ WARNING: This code has been generated by \`@promptbook/cli\` so that any manual changes will be overwritten`;
+    /**
+     * Warning message for the automatically generated sections of `.env` files
+     *
+     * @private within the repository
+     */
+    const GENERATOR_WARNING_IN_ENV = `Note: Added by Promptbook`;
     // <- TODO: [🧠] Better system for generator warnings - not always "code" and "by `@promptbook/cli`"
     /**
      * The maximum number of iterations for a loops
@@ -226,7 +233,7 @@
      */
     const DEFAULT_BOOKS_DIRNAME = './books';
     // <- TODO: [🕝] Make also `BOOKS_DIRNAME_ALTERNATIVES`
-    // TODO: !!!!!! Just .promptbook dir, hardocode others
+    // TODO: Just `.promptbook` in config, hardcode subfolders like `download-cache` or `execution-cache`
     /**
      * Where to store the temporary downloads
      *
@@ -282,11 +289,20 @@
         ss: 3, // <- least number of seconds to be counted in seconds, minus 1. Must be set after setting the `s` unit or without setting the `s` unit.
     };
     /**
-     * @@@
+     * Available remote servers for the Promptbook
      *
      * @public exported from `@promptbook/core`
      */
-    const DEFAULT_REMOTE_SERVER_URL = 'https://api.pavolhejny.com/promptbook';
+    const REMOTE_SERVER_URLS = [
+        'https://s1.ptbk.io/promptbook',
+        'https://api.pavolhejny.com/promptbook',
+    ];
+    /**
+     * Default remote server URL for the Promptbook
+     *
+     * @public exported from `@promptbook/core`
+     */
+    const DEFAULT_REMOTE_SERVER_URL = REMOTE_SERVER_URLS[0];
     // <- TODO: [🧜‍♂️]
     /**
      * @@@
@@ -497,44 +513,42 @@
         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}
+            super(spaceTrim.spaceTrim(`
+                Non-Error object was thrown
 
-                `));
+                Note: Look for ${tag} in the console for more details
+                Please report issue on ${ADMIN_EMAIL}
+            `));
             this.name = 'WrappedError';
             Object.setPrototypeOf(this, WrappedError.prototype);
         }
     }
 
     /**
-     * !!!@@@
+     * Helper used in catch blocks to assert that the error is an instance of `Error`
      *
-     * @param whatWasThrown !!!@@@
-     * @returns !!!@@@
+     * @param whatWasThrown Any object that was thrown
+     * @returns Nothing if the error is an instance of `Error`
+     * @throws `WrappedError` or `UnexpectedError` if the error is not standard
      *
      * @private within the repository
      */
     function assertsError(whatWasThrown) {
-        // Case 1: !!!@@@
+        // Case 1: Handle error which was rethrown as `WrappedError`
         if (whatWasThrown instanceof WrappedError) {
             const wrappedError = whatWasThrown;
             throw wrappedError;
         }
-        // Case 2: !!!@@@
+        // Case 2: Handle unexpected errors
         if (whatWasThrown instanceof UnexpectedError) {
             const unexpectedError = whatWasThrown;
             throw unexpectedError;
         }
-        // Case 3: !!!@@@
+        // Case 3: Handle standard errors - keep them up to consumer
         if (whatWasThrown instanceof Error) {
             return;
         }
-        // Case 4: !!!@@@
+        // Case 4: Handle non-standard errors - wrap them into `WrappedError` and throw
         throw new WrappedError(whatWasThrown);
     }
 
@@ -978,6 +992,40 @@
         keepUnused(...sideEffectSubjects);
     }
 
+    /**
+     * Convert identification to Promptbook token
+     *
+     * @param identification
+     *
+     * @public exported from `@promptbook/core`
+     */
+    function identificationToPromptbookToken(identification) {
+        const { appId, userId, userToken } = identification;
+        const promptbookToken = `${appId}-${userId}-${userToken}`;
+        return promptbookToken;
+    }
+
+    /**
+     * Convert Promptbook token to identification
+     *
+     * @param promptbookToken
+     *
+     * @public exported from `@promptbook/core`
+     */
+    function promptbookTokenToIdentification(promptbookToken) {
+        const [appId, userId, userToken] = promptbookToken.split('-');
+        if (!appId || !userId || !userToken) {
+            throw new Error(`Invalid promptbook token: ${promptbookToken}`);
+        }
+        const identification = {
+            appId,
+            userId,
+            userToken,
+            isAnonymous: false,
+        };
+        return identification;
+    }
+
     /**
      * Just marks a place of place where should be something implemented
      * No side effects.
@@ -1103,7 +1151,7 @@
      */
 
     /**
-     * Stores data in .env variables (Remove !!! nonce 1)
+     * Stores data in .env variables
      *
      * Note: `$` is used to indicate that this function is not a pure function - it uses filesystem to access `.env` file and also writes to `process.env`
      *
@@ -1161,15 +1209,19 @@
         async setItem(key, value) {
             const envFilename = await this.$provideOrCreateEnvFile();
             const envContent = await promises.readFile(envFilename, 'utf-8');
+            const transformedKey = this.transformKey(key);
+            const updatedEnvContent = envContent
+                .split('\n')
+                .filter((line) => !line.startsWith(`# ${GENERATOR_WARNING_IN_ENV}`)) // Remove GENERATOR_WARNING_IN_ENV
+                .filter((line) => !line.startsWith(`${transformedKey}=`)) // Remove existing key if present
+                .join('\n');
             const newEnvContent = spaceTrim__default["default"]((block) => `
-                ${block(envContent)}
-
-                # Note: Added by Promptbook
-                ${this.transformKey(key)}=${JSON.stringify(value)}
+                ${block(updatedEnvContent)}
 
+                # ${GENERATOR_WARNING_IN_ENV}
+                ${transformedKey}=${JSON.stringify(value)}
             `);
-            // <- TODO: !!! Add note and use spacetrim
-            promises.writeFile(envFilename, newEnvContent, 'utf-8');
+            await promises.writeFile(envFilename, newEnvContent, 'utf-8');
         }
         /**
          * Removes the key/value pair with the given key from the list associated with the object, if a key/value pair with the given key exists.
@@ -1178,6 +1230,9 @@
             throw new NotYetImplementedError('Method `$EnvStorage.removeItem` not implemented.');
         }
     }
+    /**
+     * TODO: Write file more securely - ensure that there can be no accidental overwriting of existing variables and other content
+     */
 
     /**
      * Orders JSON object by keys
@@ -2226,7 +2281,7 @@
         }
     }
     /**
-     * TODO: !!!!!! Add id to all errors
+     * TODO: [🧠][🌂] Add id to all errors
      */
 
     /**
@@ -3168,19 +3223,27 @@
             throw new EnvironmentMismatchError('Function `$provideLlmToolsForWizzardOrCli` works only in Node.js environment');
         }
         options = options !== null && options !== void 0 ? options : { strategy: 'BRING_YOUR_OWN_KEYS' };
-        const { strategy, isCacheReloaded } = options;
+        const { isLoginloaded, strategy, isCacheReloaded } = options;
         let llmExecutionTools;
         if (strategy === 'REMOTE_SERVER') {
             const { remoteServerUrl = DEFAULT_REMOTE_SERVER_URL, loginPrompt } = options;
-            const storage = new $EnvStorage(); // <- TODO: !!!!!! Save to `.promptbook` folder
+            const storage = new $EnvStorage();
             let key = `PROMPTBOOK_TOKEN`;
             if (remoteServerUrl !== DEFAULT_REMOTE_SERVER_URL) {
                 key = `${key}_${remoteServerUrl.replace(/^https?:\/\//i, '')}`;
             }
-            let identification = await storage.getItem(key);
-            if (identification === null) {
+            let identification = null;
+            let promptbookToken = await storage.getItem(key);
+            if (promptbookToken === null || isLoginloaded) {
                 identification = await loginPrompt();
-                await storage.setItem(key, identification);
+                // Note: When login prompt fails, `process.exit(1)` is called so no need to check for null
+                if (identification.isAnonymous === false) {
+                    promptbookToken = identificationToPromptbookToken(identification);
+                    await storage.setItem(key, promptbookToken);
+                }
+            }
+            else {
+                identification = promptbookTokenToIdentification(promptbookToken);
             }
             llmExecutionTools = new RemoteLlmExecutionTools({
                 remoteServerUrl,
@@ -3260,8 +3323,8 @@
     /**
      * @private utility of CLI
      */
-    function $provideLlmToolsForCli(options) {
-        const { cliOptions: { 
+    async function $provideLlmToolsForCli(options) {
+        const { isLoginloaded, cliOptions: { 
         /* TODO: Use verbose: isVerbose, */ interactive: isInteractive, provider, remoteServerUrl: remoteServerUrlRaw, }, } = options;
         let strategy;
         if (/^b/i.test(provider)) {
@@ -3275,7 +3338,11 @@
             process.exit(1);
         }
         if (strategy === 'BRING_YOUR_OWN_KEYS') {
-            return /* not await */ $provideLlmToolsForWizzardOrCli({ strategy, ...options });
+            if (isLoginloaded) {
+                throw new UnexpectedError(`\`$provideLlmToolsForCli\` isLoginloaded is not supported for strategy "BRING_YOUR_OWN_KEYS"`);
+            }
+            const llm = await $provideLlmToolsForWizzardOrCli({ strategy, ...options });
+            return { strategy, llm };
         }
         else if (strategy === 'REMOTE_SERVER') {
             if (!isValidUrl(remoteServerUrlRaw)) {
@@ -3283,7 +3350,8 @@
                 process.exit(1);
             }
             const remoteServerUrl = remoteServerUrlRaw.endsWith('/') ? remoteServerUrlRaw.slice(0, -1) : remoteServerUrlRaw;
-            return /* not await */ $provideLlmToolsForWizzardOrCli({
+            const llm = await $provideLlmToolsForWizzardOrCli({
+                isLoginloaded,
                 strategy,
                 appId: CLI_APP_ID,
                 remoteServerUrl,
@@ -3293,6 +3361,10 @@
                         console.log(colors__default["default"].red(`You can not login to remote server in non-interactive mode`));
                         process.exit(1);
                     }
+                    console.info(colors__default["default"].cyan(spaceTrim__default["default"](`
+                          You will be logged in to ${remoteServerUrl}
+                          If you don't have an account, it will be created automatically.
+                      `)));
                     const { username, password } = await prompts__default["default"]([
                         {
                             type: 'text',
@@ -3310,7 +3382,6 @@
                         },
                     ]);
                     const loginUrl = `${remoteServerUrl}/login`;
-                    console.log('!!!', { loginUrl });
                     // TODO: [🧠] Should we use normal `fetch` or `scraperFetch`
                     const response = await promptbookFetch(loginUrl, {
                         method: 'POST',
@@ -3323,20 +3394,7 @@
                             password,
                         }),
                     });
-                    console.log('!!!', {
-                        loginUrl,
-                        username,
-                        password,
-                        // type: response.type,
-                        // text: await response.text(),
-                    });
                     const { isSuccess, message, error, identification } = (await response.json());
-                    console.log('!!!', {
-                        isSuccess,
-                        message,
-                        error,
-                        identification,
-                    });
                     if (message) {
                         if (isSuccess) {
                             console.log(colors__default["default"].green(message));
@@ -3357,6 +3415,7 @@
                     return identification;
                 },
             });
+            return { strategy, llm };
         }
         else {
             throw new UnexpectedError(`\`$provideLlmToolsForCli\` wrong strategy "${strategy}"`);
@@ -3378,11 +3437,12 @@
         listModelsCommand.alias('models');
         listModelsCommand.alias('llm');
         listModelsCommand.action(handleActionErrors(async (cliOptions) => {
-            console.log('!!!', cliOptions);
-            // TODO: !!!!!! Not relevant for remote server and also for `about` command
-            const llm = await $provideLlmToolsForCli({ cliOptions });
+            const { strategy, llm } = await $provideLlmToolsForCli({ cliOptions });
             $sideEffect(llm);
             // <- Note: Providing LLM tools will make a side effect of registering all available LLM tools to show the message
+            if (strategy !== 'BRING_YOUR_OWN_KEYS') {
+                console.warn(colors__default["default"].yellow(`You are using --strategy ${strategy} but models listed below are relevant for --strategy BRING_YOUR_OWN_KEYS`));
+            }
             console.info($registeredLlmToolsMessage());
             return process.exit(0);
         }));
@@ -3910,6 +3970,7 @@
         `));
         listModelsCommand.alias('scrapers');
         listModelsCommand.action(handleActionErrors(async () => {
+            // TODO: [🌞] Do not allow on REMOTE_SERVER strategy
             const scrapers = await $provideScrapersForNode({});
             const executables = await $provideExecutablesForNode();
             console.info(spaceTrim__default["default"]((block) => `
@@ -3945,42 +4006,20 @@
         loginCommand.description(spaceTrim__default["default"](`
             Login to the remote Promptbook server
         `));
-        loginCommand.action(handleActionErrors(async () => {
-            // @@@
-            console.error(colors__default["default"].green(spaceTrim__default["default"](`
-                        You will be logged in to https://promptbook.studio server.
-                        If you don't have an account, it will be created automatically.
-                    `)));
-            // !!!!!!!!! Remove from here and use $provideLlmToolsForCli
-            const { email, password } = await prompts__default["default"]([
-                {
-                    type: 'text',
-                    name: 'email',
-                    message: 'Enter your email:',
-                    validate: (value) => (isValidEmail(value) ? true : 'Valid email is required'),
+        loginCommand.action(handleActionErrors(async (cliOptions) => {
+            // Note: Not interested in return value of this function but the side effect of logging in
+            await $provideLlmToolsForCli({
+                isLoginloaded: true,
+                cliOptions: {
+                    ...cliOptions,
+                    strategy: 'REMOTE_SERVER', // <- Note: Overriding strategy to `REMOTE_SERVER`
+                    //                               TODO: Do not allow flag `--strategy` in `login` command at all
                 },
-                {
-                    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 waitasecond.forTime(1000);
-            console.error(colors__default["default"].green(spaceTrim__default["default"](`
-                        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`
@@ -4940,8 +4979,8 @@
                     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`
+                    // <- 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);
@@ -11938,7 +11977,7 @@
                 isCacheReloaded,
             }; /* <- TODO: ` satisfies PrepareAndScrapeOptions` */
             const fs = $provideFilesystemForNode(prepareAndScrapeOptions);
-            const llm = await $provideLlmToolsForCli({
+            const { llm } = await $provideLlmToolsForCli({
                 cliOptions,
                 ...prepareAndScrapeOptions,
             });
@@ -12809,7 +12848,6 @@
         runCommand.option('-j, --json <json>', `Pass all or some input parameters as JSON record, if used the output is also returned as JSON`);
         runCommand.option('-s, --save-report <path>', `Save report to file`);
         runCommand.action(handleActionErrors(async (pipelineSource, cliOptions) => {
-            console.log('!!!', cliOptions);
             const { reload: isCacheReloaded, interactive: isInteractive, formfactor: isFormfactorUsed, json, verbose: isVerbose, saveReport, } = cliOptions;
             if (pipelineSource.includes('-') && normalizeToKebabCase(pipelineSource) === pipelineSource) {
                 console.error(colors__default["default"].red(`""${pipelineSource}" is not a valid command or book. See 'ptbk --help'.`));
@@ -12835,7 +12873,7 @@
             const fs = $provideFilesystemForNode(prepareAndScrapeOptions);
             let llm;
             try {
-                llm = await $provideLlmToolsForCli({ cliOptions, ...prepareAndScrapeOptions });
+                llm = (await $provideLlmToolsForCli({ cliOptions, ...prepareAndScrapeOptions })).llm;
             }
             catch (error) {
                 assertsError(error);
@@ -13727,7 +13765,7 @@
                 isCacheReloaded,
             }; /* <- TODO: ` satisfies PrepareAndScrapeOptions` */
             const fs = $provideFilesystemForNode(prepareAndScrapeOptions);
-            const llm = await $provideLlmToolsForCli({ cliOptions, ...prepareAndScrapeOptions });
+            const { /* [0] strategy,*/ llm } = await $provideLlmToolsForCli({ cliOptions, ...prepareAndScrapeOptions });
             const executables = await $provideExecutablesForNode(prepareAndScrapeOptions);
             const tools = {
                 llm,
@@ -13759,6 +13797,7 @@
                     TODO_USE({ appId, userId });
                     return llm;
                 },
+                // <- TODO: [🧠][0] Maybe pass here strategy
             });
             keepUnused(server);
             // Note: Already logged by `startRemoteServer`
@@ -13800,7 +13839,7 @@
                     isCacheReloaded,
                 }; /* <- TODO: ` satisfies PrepareAndScrapeOptions` */
                 const fs = $provideFilesystemForNode(prepareAndScrapeOptions);
-                const llm = await $provideLlmToolsForCli({ cliOptions, ...prepareAndScrapeOptions });
+                const { llm } = await $provideLlmToolsForCli({ cliOptions, ...prepareAndScrapeOptions });
                 const executables = await $provideExecutablesForNode(prepareAndScrapeOptions);
                 tools = {
                     llm,