@promptbook/cli 0.89.0-7 → 0.89.0-9

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-7';
+const PROMPTBOOK_ENGINE_VERSION = '0.89.0-9';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -919,97 +919,6 @@ function $sideEffect(...sideEffectSubjects) {
     keepUnused(...sideEffectSubjects);
 }
 
-/**
- * Checks if value is valid email
- *
- * @public exported from `@promptbook/utils`
- */
-function isValidEmail(email) {
-    if (typeof email !== 'string') {
-        return false;
-    }
-    if (email.split('\n').length > 1) {
-        return false;
-    }
-    return /^.+@.+\..+$/.test(email);
-}
-
-/**
- * Tests if given string is valid URL.
- *
- * Note: Dataurl are considered perfectly valid.
- * Note: There are two simmilar functions:
- * - `isValidUrl` which tests any URL
- * - `isValidPipelineUrl` *(this one)* which tests just promptbook URL
- *
- * @public exported from `@promptbook/utils`
- */
-function isValidUrl(url) {
-    if (typeof url !== 'string') {
-        return false;
-    }
-    try {
-        if (url.startsWith('blob:')) {
-            url = url.replace(/^blob:/, '');
-        }
-        const urlObject = new URL(url /* because fail is handled */);
-        if (!['http:', 'https:', 'data:'].includes(urlObject.protocol)) {
-            return false;
-        }
-        return true;
-    }
-    catch (error) {
-        return false;
-    }
-}
-
-/**
- * Stores data in memory (HEAP)
- *
- * @public exported from `@promptbook/core`
- */
-class MemoryStorage {
-    constructor() {
-        this.storage = {};
-    }
-    /**
-     * Returns the number of key/value pairs currently present in the list associated with the object.
-     */
-    get length() {
-        return Object.keys(this.storage).length;
-    }
-    /**
-     * Empties the list associated with the object of all key/value pairs, if there are any.
-     */
-    clear() {
-        this.storage = {};
-    }
-    /**
-     * Returns the current value associated with the given key, or null if the given key does not exist in the list associated with the object.
-     */
-    getItem(key) {
-        return this.storage[key] || null;
-    }
-    /**
-     * Returns the name of the nth key in the list, or null if n is greater than or equal to the number of key/value pairs in the object.
-     */
-    key(index) {
-        return Object.keys(this.storage)[index] || null;
-    }
-    /**
-     * Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.
-     */
-    setItem(key, value) {
-        this.storage[key] = value;
-    }
-    /**
-     * 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.
-     */
-    removeItem(key) {
-        delete this.storage[key];
-    }
-}
-
 /**
  * Just marks a place of place where should be something implemented
  * No side effects.
@@ -1504,6 +1413,35 @@ function isValidFilePath(filename) {
  * TODO: [🍏] Implement for MacOs
  */
 
+/**
+ * Tests if given string is valid URL.
+ *
+ * Note: Dataurl are considered perfectly valid.
+ * Note: There are two simmilar functions:
+ * - `isValidUrl` which tests any URL
+ * - `isValidPipelineUrl` *(this one)* which tests just promptbook URL
+ *
+ * @public exported from `@promptbook/utils`
+ */
+function isValidUrl(url) {
+    if (typeof url !== 'string') {
+        return false;
+    }
+    try {
+        if (url.startsWith('blob:')) {
+            url = url.replace(/^blob:/, '');
+        }
+        const urlObject = new URL(url /* because fail is handled */);
+        if (!['http:', 'https:', 'data:'].includes(urlObject.protocol)) {
+            return false;
+        }
+        return true;
+    }
+    catch (error) {
+        return false;
+    }
+}
+
 const defaultDiacriticsRemovalMap = [
     {
         base: 'A',
@@ -1915,6 +1853,53 @@ class FileCacheStorage {
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
  */
 
+/**
+ * Stores data in memory (HEAP)
+ *
+ * @public exported from `@promptbook/core`
+ */
+class MemoryStorage {
+    constructor() {
+        this.storage = {};
+    }
+    /**
+     * Returns the number of key/value pairs currently present in the list associated with the object.
+     */
+    get length() {
+        return Object.keys(this.storage).length;
+    }
+    /**
+     * Empties the list associated with the object of all key/value pairs, if there are any.
+     */
+    clear() {
+        this.storage = {};
+    }
+    /**
+     * Returns the current value associated with the given key, or null if the given key does not exist in the list associated with the object.
+     */
+    getItem(key) {
+        return this.storage[key] || null;
+    }
+    /**
+     * Returns the name of the nth key in the list, or null if n is greater than or equal to the number of key/value pairs in the object.
+     */
+    key(index) {
+        return Object.keys(this.storage)[index] || null;
+    }
+    /**
+     * Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.
+     */
+    setItem(key, value) {
+        this.storage[key] = value;
+    }
+    /**
+     * 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.
+     */
+    removeItem(key) {
+        delete this.storage[key];
+    }
+}
+
 /**
  * This error indicates problems parsing the format value
  *
@@ -2120,6 +2105,19 @@ class PipelineUrlError 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
  *
@@ -2158,6 +2156,7 @@ const COMMON_JAVASCRIPT_ERRORS = {
     URIError,
     AggregateError,
     AuthenticationError,
+    PromptbookFetchError,
     /*
   Note: Not widely supported
   > InternalError,
@@ -2656,21 +2655,15 @@ function isRootPath(value) {
  */
 
 /**
- * @@@
+ * Provides the path to the `.env` file
  *
- * @@@ .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`
+ * @private within the repository - for CLI utils
  */
-async function $provideLlmToolsConfigurationFromEnv() {
+async function $provideEnvFilepath() {
     if (!$isRunningInNode()) {
-        throw new EnvironmentMismatchError('Function `$provideLlmToolsFromEnv` works only in Node.js environment');
+        throw new EnvironmentMismatchError('Function `$provideEnvFilepath` works only in Node.js environment');
     }
     const envFilePatterns = [
         '.env',
@@ -2690,8 +2683,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)) {
@@ -2700,6 +2692,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 $provideEnvFilepath();
+    if (envFilepath !== null) {
+        dotenv.config({ path: envFilepath });
+    }
     const llmToolsConfiguration = $llmToolsMetadataRegister
         .list()
         .map((metadata) => metadata.createConfigurationFromEnv(process.env))
@@ -2707,15 +2727,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 */
+ */
 
 /**
  * Multiple LLM Execution Tools is a proxy server that uses multiple execution tools internally and exposes the executor interface externally.
@@ -2965,6 +2978,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`
@@ -3009,6 +3023,8 @@ async function $provideLlmToolsFromEnv(options = {}) {
 /**
  * Returns LLM tools for CLI
  *
+ * Note: `$` is used to indicate that this function is not a pure function - it uses filesystem to access .env file and also writes this .env file
+ *
  * @private within the repository - for CLI utils
  */
 async function $provideLlmToolsForWizzardOrCli(options) {
@@ -3020,6 +3036,8 @@ async function $provideLlmToolsForWizzardOrCli(options) {
     let llmExecutionTools;
     if (strategy === 'REMOTE_SERVER') {
         const { remoteServerUrl = DEFAULT_REMOTE_SERVER_URL, loginPrompt } = options;
+        // TODO: !!!
+        // const envFilepath = await $provideEnvFilepath();
         const storage = new MemoryStorage(); // <- TODO: !!!!!! Save to `.promptbook` folder
         const key = `${remoteServerUrl}-identification`;
         let identification = await storage.getItem(key);
@@ -3056,6 +3074,54 @@ async function $provideLlmToolsForWizzardOrCli(options) {
  * TODO: [®] DRY Register logic
  */
 
+/**
+ * The built-in `fetch' function with a lightweight error handling wrapper as default fetch function used in Promptbook scrapers
+ *
+ * @public exported from `@promptbook/core`
+ */
+const promptbookFetch = async (urlOrRequest, init) => {
+    try {
+        return await fetch(urlOrRequest, init);
+    }
+    catch (error) {
+        if (!(error instanceof Error)) {
+            throw error;
+        }
+        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:
+                    ${block(error.message)}
+
+                `));
+    }
+};
+/**
+ * TODO: [🧠] Maybe rename because it is not used only for scrapers but also in `$getCompiledBook`
+ */
+
+/**
+ * Checks if value is valid email
+ *
+ * @public exported from `@promptbook/utils`
+ */
+function isValidEmail(email) {
+    if (typeof email !== 'string') {
+        return false;
+    }
+    if (email.split('\n').length > 1) {
+        return false;
+    }
+    return /^.+@.+\..+$/.test(email);
+}
+
 /**
  * @private utility of CLI
  */
@@ -3109,7 +3175,9 @@ function $provideLlmToolsForCli(options) {
                     },
                 ]);
                 const loginUrl = `${remoteServerUrl}/login`;
-                const response = await fetch(loginUrl, {
+                console.log('!!!', { loginUrl });
+                // TODO: [🧠] Should we use normal `fetch` or `scraperFetch`
+                const response = await promptbookFetch(loginUrl, {
                     method: 'POST',
                     headers: {
                         'Content-Type': 'application/json',
@@ -3127,12 +3195,31 @@ function $provideLlmToolsForCli(options) {
                     // type: response.type,
                     // text: await response.text(),
                 });
-                const body = (await response.json());
-                if ('error' in body) {
-                    console.log(colors.red(body.error.message));
+                const { isSuccess, message, error, identification } = (await response.json());
+                console.log('!!!', {
+                    isSuccess,
+                    message,
+                    error,
+                    identification,
+                });
+                if (message) {
+                    if (isSuccess) {
+                        console.log(colors.green(message));
+                    }
+                    else {
+                        console.log(colors.red(message));
+                    }
+                }
+                if (!isSuccess) {
+                    // Note: Login failed
                     process.exit(1);
                 }
-                return body.identification;
+                if (!identification) {
+                    // Note: Do not get identification here, but server signalizes the success so exiting but with code 0
+                    //       This can mean for example that user needs to verify email
+                    process.exit(0);
+                }
+                return identification;
             },
         });
     }
@@ -6794,32 +6881,6 @@ function mimeTypeToExtension(value) {
     return extension(value) || null;
 }
 
-/**
- * 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
- */
-const scraperFetch = async (url, init) => {
-    try {
-        return await fetch(url, init);
-    }
-    catch (error) {
-        if (!(error instanceof Error)) {
-            throw error;
-        }
-        throw new KnowledgeScrapeError(spaceTrim((block) => `
-                    Can not fetch "${url}"
-
-                    Fetch error:
-                    ${block(error.message)}
-
-                `));
-    }
-};
-/**
- * TODO: [🧠] Maybe rename because it is not used only for scrapers but also in `$getCompiledBook`
- */
-
 /**
  * @@@
  *
@@ -6828,7 +6889,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, 
@@ -12717,7 +12778,7 @@ function $initializeRunCommand(program) {
         const tools = {
             llm,
             fs,
-            fetch: scraperFetch,
+            fetch: promptbookFetch,
             scrapers: await $provideScrapersForNode({ fs, llm, executables }, prepareAndScrapeOptions),
             script: [new JavascriptExecutionTools(cliOptions)],
         };
@@ -13086,8 +13147,19 @@ function startRemoteServer(options) {
             const username = request.body.username;
             const password = request.body.password;
             const appId = request.body.appId;
-            const identification = await login({ username, password, appId });
-            response.status(201).send({ identification });
+            const { isSuccess, error, message, identification } = await login({
+                username,
+                password,
+                appId,
+                rawRequest: request,
+                rawResponse: response,
+            });
+            response.status(201).send({
+                isSuccess,
+                message,
+                error: error ? serializeError(error) : undefined,
+                identification,
+            });
             return;
         }
         catch (error) {
@@ -13095,7 +13167,11 @@ function startRemoteServer(options) {
                 throw error;
             }
             if (error instanceof AuthenticationError) {
-                response.status(401).send({ error: serializeError(error) });
+                response.status(401).send({
+                    isSuccess: false,
+                    message: error.message,
+                    error: serializeError(error),
+                });
             }
             console.warn(`Login function thrown different error than AuthenticationError`, {
                 error,