@promptbook/cli 0.89.0-15 → 0.89.0-16

package/esm/index.es.js

@@ -46,7 +46,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.89.0-15';
+const PROMPTBOOK_ENGINE_VERSION = '0.89.0-16';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -106,6 +106,7 @@ const ADMIN_GITHUB_NAME = 'hejny';
  * @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
  *
@@ -136,6 +137,12 @@ const DEFAULT_MAX_FILE_SIZE = 100 * 1024 * 1024; // 100MB
  * @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
@@ -216,7 +223,7 @@ const DEFAULT_MAX_EXECUTION_ATTEMPTS = 10; // <- TODO: [🤹‍♂️]
  */
 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
  *
@@ -272,11 +279,20 @@ const MOMENT_ARG_THRESHOLDS = {
     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: [🧜‍♂️]
 /**
  * @@@
@@ -487,44 +503,42 @@ class WrappedError extends Error {
     constructor(whatWasThrown) {
         const tag = `[🤮]`;
         console.error(tag, whatWasThrown);
-        super(spaceTrim$1((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$1(`
+                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);
 }
 
@@ -968,6 +982,40 @@ function $sideEffect(...sideEffectSubjects) {
     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.
@@ -1093,7 +1141,7 @@ async function $provideEnvFilename() {
  */
 
 /**
- * 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`
  *
@@ -1151,15 +1199,19 @@ class $EnvStorage {
     async setItem(key, value) {
         const envFilename = await this.$provideOrCreateEnvFile();
         const envContent = await 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((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
-        writeFile(envFilename, newEnvContent, 'utf-8');
+        await 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.
@@ -1168,6 +1220,9 @@ class $EnvStorage {
         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
@@ -2216,7 +2271,7 @@ class PipelineExecutionError extends Error {
     }
 }
 /**
- * TODO: !!!!!! Add id to all errors
+ * TODO: [🧠][🌂] Add id to all errors
  */
 
 /**
@@ -3158,19 +3213,27 @@ async function $provideLlmToolsForWizzardOrCli(options) {
         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,
@@ -3250,8 +3313,8 @@ function isValidEmail(email) {
 /**
  * @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)) {
@@ -3265,7 +3328,11 @@ function $provideLlmToolsForCli(options) {
         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)) {
@@ -3273,7 +3340,8 @@ function $provideLlmToolsForCli(options) {
             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,
@@ -3283,6 +3351,10 @@ function $provideLlmToolsForCli(options) {
                     console.log(colors.red(`You can not login to remote server in non-interactive mode`));
                     process.exit(1);
                 }
+                console.info(colors.cyan(spaceTrim(`
+                          You will be logged in to ${remoteServerUrl}
+                          If you don't have an account, it will be created automatically.
+                      `)));
                 const { username, password } = await prompts([
                     {
                         type: 'text',
@@ -3300,7 +3372,6 @@ function $provideLlmToolsForCli(options) {
                     },
                 ]);
                 const loginUrl = `${remoteServerUrl}/login`;
-                console.log('!!!', { loginUrl });
                 // TODO: [🧠] Should we use normal `fetch` or `scraperFetch`
                 const response = await promptbookFetch(loginUrl, {
                     method: 'POST',
@@ -3313,20 +3384,7 @@ function $provideLlmToolsForCli(options) {
                         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.green(message));
@@ -3347,6 +3405,7 @@ function $provideLlmToolsForCli(options) {
                 return identification;
             },
         });
+        return { strategy, llm };
     }
     else {
         throw new UnexpectedError(`\`$provideLlmToolsForCli\` wrong strategy "${strategy}"`);
@@ -3368,11 +3427,12 @@ function $initializeListModelsCommand(program) {
     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.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);
     }));
@@ -3900,6 +3960,7 @@ function $initializeListScrapersCommand(program) {
         `));
     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((block) => `
@@ -3935,42 +3996,20 @@ function $initializeLoginCommand(program) {
     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.
-                    `)));
-        // !!!!!!!!! Remove from here and use $provideLlmToolsForCli
-        const { email, password } = await prompts([
-            {
-                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 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`
@@ -4930,8 +4969,8 @@ function createTask(options) {
                 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);
@@ -11928,7 +11967,7 @@ function $initializeMakeCommand(program) {
             isCacheReloaded,
         }; /* <- TODO: ` satisfies PrepareAndScrapeOptions` */
         const fs = $provideFilesystemForNode(prepareAndScrapeOptions);
-        const llm = await $provideLlmToolsForCli({
+        const { llm } = await $provideLlmToolsForCli({
             cliOptions,
             ...prepareAndScrapeOptions,
         });
@@ -12799,7 +12838,6 @@ function $initializeRunCommand(program) {
     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.red(`""${pipelineSource}" is not a valid command or book. See 'ptbk --help'.`));
@@ -12825,7 +12863,7 @@ function $initializeRunCommand(program) {
         const fs = $provideFilesystemForNode(prepareAndScrapeOptions);
         let llm;
         try {
-            llm = await $provideLlmToolsForCli({ cliOptions, ...prepareAndScrapeOptions });
+            llm = (await $provideLlmToolsForCli({ cliOptions, ...prepareAndScrapeOptions })).llm;
         }
         catch (error) {
             assertsError(error);
@@ -13717,7 +13755,7 @@ function $initializeStartServerCommand(program) {
             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,
@@ -13749,6 +13787,7 @@ function $initializeStartServerCommand(program) {
                 TODO_USE({ appId, userId });
                 return llm;
             },
+            // <- TODO: [🧠][0] Maybe pass here strategy
         });
         keepUnused(server);
         // Note: Already logged by `startRemoteServer`
@@ -13790,7 +13829,7 @@ function $initializeTestCommand(program) {
                 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,