@promptbook/documents 0.89.0-8 → 0.89.0

package/esm/typings/src/remote-server/types/RemoteServerOptions.d.ts

@@ -3,13 +3,15 @@ import type { Promisable } from 'type-fest';
 import type { PipelineCollection } from '../../collection/PipelineCollection';
 import { AuthenticationError } from '../../errors/AuthenticationError';
 import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+import type { ExecutionTools } from '../../execution/ExecutionTools';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { string_app_id } from '../../types/typeAliases';
 import type { string_email } from '../../types/typeAliases';
 import type { string_password } from '../../types/typeAliases';
-import type { string_uri } from '../../types/typeAliases';
+import type { string_token } from '../../types/typeAliases';
 import type { string_user_id } from '../../types/typeAliases';
-import type { PromptbookServer_Identification } from '../socket-types/_subtypes/PromptbookServer_Identification';
+import type { ApplicationModeIdentification } from '../socket-types/_subtypes/Identification';
+import type { Identification } from '../socket-types/_subtypes/Identification';
 /**
  * @@@
  *
@@ -29,14 +31,18 @@ export type RemoteServerOptions<TCustomOptions> = CommonToolsOptions & {
      */
     readonly port: number;
     /**
-     * Root path of the server
+     * Creates execution tools the client
      *
-     * Note: This is useful when you reverse proxy the server without changing the path
+     * This is relevant also in anonymous mode in oposition to `createLlmExecutionTools`
      *
-     * @default '/'
-     * @example '/api/promptbook/'
+     * Note: You can provide only some tools and leave the rest to the default ones also llm tools are created by `createLlmExecutionTools`
+     * Note: This is useful when you want to provide some custom restrictions for example:
+     * - Limit access to certain websites for some users
+     * - Bind user-interface tools to email agent
+     * - Allow / block script execution
+     * - And many more
      */
-    readonly rootPath?: string_uri;
+    createExecutionTools?(options: Identification<TCustomOptions>): Promisable<Partial<Omit<ExecutionTools, 'llm'>>>;
 } & ((AnonymousRemoteServerOptions & {
     readonly isApplicationModeAllowed?: false;
 }) | ({
@@ -70,36 +76,11 @@ export type ApplicationRemoteServerOptions<TCustomOptions> = {
      * Note: In most cases DO NOT THROW `AuthenticationError` but return `isSuccess: false` with message
      * @throws `AuthenticationError`  if the user is not allowed to login for example because of invalid credentials
      */
-    login(credentials: {
-        /**
-         * Identifier of the application you are using
-         *
-         * Note: This is usefull when you use Promptbook remote server for multiple apps/frontends, if its used just for single app, use here just "app" or "your-app-name"
-         */
-        readonly appId: string_app_id | null;
-        /**
-         * Username (for example email) of the user
-         */
-        readonly username: string_email | string;
-        /**
-         * Password of the user
-         */
-        readonly password: string_password;
-        /**
-         * Request object from express if you want to access some request data for example headers, IP address, etc.
-         */
-        readonly rawRequest: Request;
-        /**
-         * Response object from express if you want to add some custom headers.
-         *
-         * Note: It is not recommended to use this object to send body of the response because it can confuse the client
-         */
-        readonly rawResponse: Response;
-    }): Promise<ApplicationRemoteServerOptionsLoginResponse<TCustomOptions>>;
+    login(loginRequest: LoginRequest): Promise<LoginResponse<TCustomOptions>>;
     /**
      * Creates llm execution tools for each client
      */
-    createLlmExecutionTools(options: ApplicationRemoteServerClientOptions<TCustomOptions>): Promisable<LlmExecutionTools>;
+    createLlmExecutionTools(options: ApplicationModeIdentification<TCustomOptions>): Promisable<LlmExecutionTools>;
 };
 export type ApplicationRemoteServerClientOptions<TCustomOptions> = {
     /**
@@ -121,23 +102,61 @@ export type ApplicationRemoteServerClientOptions<TCustomOptions> = {
      *
      * Note: This is passed for example to `createLlmExecutionTools`
      */
-    readonly userToken?: string_user_id;
+    readonly userToken?: string_token;
     /**
      * Additional arbitrary options to identify the client or to pass custom metadata
      */
     readonly customOptions?: TCustomOptions;
 };
-export type ApplicationRemoteServerOptionsLoginResponse<TCustomOptions> = {
+/**
+ * Login request for the application mode
+ */
+export type LoginRequest = {
+    /**
+     * Identifier of the application you are using
+     *
+     * Note: This is usefull when you use Promptbook remote server for multiple apps/frontends, if its used just for single app, use here just "app" or "your-app-name"
+     */
+    readonly appId: string_app_id | null;
+    /**
+     * Username (for example email) of the user
+     */
+    readonly username: string_email | string;
+    /**
+     * Password of the user
+     */
+    readonly password: string_password;
+    /**
+     * Request object from express if you want to access some request data for example headers, IP address, etc.
+     */
+    readonly rawRequest: Request;
+    /**
+     * Response object from express if you want to add some custom headers.
+     *
+     * Note: It is not recommended to use this object to send body of the response because it can confuse the client
+     */
+    readonly rawResponse: Response;
+};
+/**
+ * Login response for the application mode
+ */
+export type LoginResponse<TCustomOptions> = {
     /**
      * Was the login successful
      */
     readonly isSuccess: boolean;
     /**
-     *
+     * Message to display to the user, this message is always displayed
      */
     readonly message?: string;
+    /**
+     * Optional error if the login was not successful
+     */
     readonly error?: AuthenticationError;
-    readonly identification?: PromptbookServer_Identification<TCustomOptions>;
+    /**
+     * Identification of the user to be used in the future requests
+     */
+    readonly identification?: Identification<TCustomOptions>;
 };
 /**
  * TODO: Constrain anonymous mode for specific models / providers

package/esm/typings/src/scrapers/_common/utils/{scraperFetch.d.ts → promptbookFetch.d.ts}

@@ -2,9 +2,9 @@ import type { PromptbookFetch } from '../../../execution/PromptbookFetch';
 /**
  * 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`
  */
-export declare const scraperFetch: PromptbookFetch;
+export declare const promptbookFetch: PromptbookFetch;
 /**
  * TODO: [🧠] Maybe rename because it is not used only for scrapers but also in `$getCompiledBook`
  */

package/esm/typings/src/storage/env-storage/$EnvStorage.d.ts

@@ -0,0 +1,40 @@
+import type { PromptbookStorage } from '../_common/PromptbookStorage';
+/**
+ * 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`
+ *
+ * @private within the repository - for CLI utils
+ */
+export declare class $EnvStorage<TItem> implements PromptbookStorage<TItem> {
+    private envFilename;
+    private $provideOrCreateEnvFile;
+    private transformKey;
+    /**
+     * Returns the number of key/value pairs currently present in the list associated with the object.
+     */
+    get length(): number;
+    /**
+     * Empties the list associated with the object of all key/value pairs, if there are any.
+     */
+    clear(): void;
+    /**
+     * 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: string): Promise<TItem | 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: number): string | 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: string, value: TItem): Promise<void>;
+    /**
+     * 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: string): void;
+}
+/**
+ * TODO: Write file more securely - ensure that there can be no accidental overwriting of existing variables and other content
+ */

package/esm/typings/src/types/typeAliases.d.ts

@@ -325,6 +325,12 @@ export type string_css_selector = string;
  * For example `"https://collboard.com/9SeSQTupmQHwuSrLi"`
  */
 export type string_url = string;
+/**
+ * Semantic helper
+ *
+ * For example `"https://s1.ptbk.io/promptbook"`
+ */
+export type string_promptbook_server_url = string;
 /**
  * Semantic helper
  *
@@ -408,6 +414,13 @@ export type string_host = string;
  * Semantic helper
  */
 export type string_protocol = 'http:' | 'https:';
+/**
+ * Semantic helper
+ *
+ * For example `"192.168.1.1"` (IPv4)
+ * For example `"2001:0db8:85a3:0000:0000:8a2e:0370:7334"` (IPv6)
+ */
+export type string_ip_address = string;
 /**
  * Semantic helper
  *
@@ -521,6 +534,13 @@ export type string_person_profile = string;
  * For example `"MIT"`
  */
 export type string_license = string;
+/**
+ * Semantic helper
+ *
+ * For example `"Pavol Hejný <pavol@ptbk.io> (https://www.pavolhejny.com/)"`
+ * For example `"AI Web, LLC <legal@ptbk.io> (https://www.ptbk.io/)"`
+ */
+export type string_legal_entity = string | string_person_profile | string_title;
 /**
  * Semantic helper for attributes
  *
@@ -570,6 +590,12 @@ export type string_postprocessing_function_name = string;
 export type id = string | number;
 export type task_id = string;
 export type string_token = string;
+/**
+ * Semantic helper
+ *
+ * Made by `identificationToPromptbookToken` exported from `@promptbook/core`
+ */
+export type string_promptbook_token = string_token;
 export type string_license_token = string_token;
 export type string_password = string;
 export type string_ssh_key = string;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/documents",
-    "version": "0.89.0-8",
+    "version": "0.89.0",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "private": false,
     "sideEffects": false,
@@ -43,19 +43,23 @@
         "url": "https://github.com/webgptorg/promptbook/issues"
     },
     "homepage": "https://ptbk.io/",
+    "engines": {
+        "node": ">=16.0.0",
+        "npm": ">=8.0.0"
+    },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/documents.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.89.0-8"
+        "@promptbook/core": "0.89.0"
     },
     "dependencies": {
         "colors": "1.4.0",
-        "crypto": "^1.0.1",
+        "crypto": "1.0.1",
         "crypto-js": "4.2.0",
         "papaparse": "5.4.1",
         "prettier": "2.8.1",
-        "rxjs": "^7.8.1",
+        "rxjs": "7.8.1",
         "spacetrim": "0.11.59",
         "waitasecond": "1.11.83"
     }

package/umd/index.umd.js

@@ -26,7 +26,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.89.0-8';
+    const PROMPTBOOK_ENGINE_VERSION = '0.89.0';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -89,6 +89,7 @@
      * @public exported from `@promptbook/core`
      */
     const ADMIN_GITHUB_NAME = 'hejny';
+    //            <- TODO: [🐊] Pick the best claim
     /**
      * When the title is not provided, the default title is used
      *
@@ -121,6 +122,7 @@
         infinity: '(infinity; ∞)',
         negativeInfinity: '(negative infinity; -∞)',
         unserializable: '(unserializable value)',
+        circular: '(circular JSON)',
     };
     /**
      * Small number limit
@@ -160,7 +162,7 @@
      */
     const DEFAULT_MAX_EXECUTION_ATTEMPTS = 10; // <- TODO: [🤹‍♂️]
     // <- 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
      *
@@ -1068,9 +1070,60 @@
      * 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(`
+                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 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: Handle error which was rethrown as `WrappedError`
+        if (whatWasThrown instanceof WrappedError) {
+            const wrappedError = whatWasThrown;
+            throw wrappedError;
+        }
+        // Case 2: Handle unexpected errors
+        if (whatWasThrown instanceof UnexpectedError) {
+            const unexpectedError = whatWasThrown;
+            throw unexpectedError;
+        }
+        // Case 3: Handle standard errors - keep them up to consumer
+        if (whatWasThrown instanceof Error) {
+            return;
+        }
+        // Case 4: Handle non-standard errors - wrap them into `WrappedError` and throw
+        throw new WrappedError(whatWasThrown);
+    }
+
     /**
      * Function isValidJsonString will tell you if the string is valid JSON or not
      *
+     * @param value The string to check
+     * @returns True if the string is a valid JSON string, false otherwise
+     *
      * @public exported from `@promptbook/utils`
      */
     function isValidJsonString(value /* <- [👨‍⚖️] */) {
@@ -1079,9 +1132,7 @@
             return true;
         }
         catch (error) {
-            if (!(error instanceof Error)) {
-                throw error;
-            }
+            assertsError(error);
             if (error.message.includes('Unexpected token')) {
                 return false;
             }
@@ -1434,9 +1485,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
 
@@ -2207,7 +2256,7 @@
         }
     }
     /**
-     * TODO: !!!!!! Add id to all errors
+     * TODO: [🧠][🌂] Add id to all errors
      */
 
     /**
@@ -2385,6 +2434,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
      *
@@ -2405,7 +2467,10 @@
         PipelineExecutionError,
         PipelineLogicError,
         PipelineUrlError,
+        AuthenticationError,
+        PromptbookFetchError,
         UnexpectedError,
+        WrappedError,
         // TODO: [🪑]> VersionMismatchError,
     };
     /**
@@ -2422,7 +2487,6 @@
         TypeError,
         URIError,
         AggregateError,
-        AuthenticationError,
         /*
       Note: Not widely supported
       > InternalError,
@@ -2545,8 +2609,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);
@@ -2556,6 +2620,7 @@
                     partialResultSubject.next(executionResult);
                 }
                 catch (error) {
+                    assertsError(error);
                     status = 'ERROR';
                     errors.push(error);
                     partialResultSubject.error(error);
@@ -2947,14 +3012,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(
@@ -3392,17 +3458,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;
+            }
+            else if (urlOrRequest instanceof Request) {
+                url = urlOrRequest.url;
             }
-            throw new KnowledgeScrapeError(spaceTrim__default["default"]((block) => `
+            throw new PromptbookFetchError(spaceTrim__default["default"]((block) => `
                     Can not fetch "${url}"
 
                     Fetch error:
@@ -3423,7 +3494,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, 
@@ -3625,9 +3696,7 @@
                 knowledgePreparedUnflatten[index] = pieces;
             }
             catch (error) {
-                if (!(error instanceof Error)) {
-                    throw 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
             }
@@ -3919,13 +3988,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;
         }
@@ -3982,9 +4057,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)}
@@ -4103,6 +4176,28 @@
         // encoding: 'utf-8',
     });
 
+    /**
+     * Function to check if a string is valid CSV
+     *
+     * @param value The string to check
+     * @returns True if the string is a valid CSV string, false otherwise
+     *
+     * @public exported from `@promptbook/utils`
+     */
+    function isValidCsvString(value) {
+        try {
+            // A simple check for CSV format: at least one comma and no invalid characters
+            if (value.includes(',') && /^[\w\s,"']+$/.test(value)) {
+                return true;
+            }
+            return false;
+        }
+        catch (error) {
+            assertsError(error);
+            return false;
+        }
+    }
+
     /**
      * Definition for CSV spreadsheet
      *
@@ -4113,7 +4208,7 @@
         formatName: 'CSV',
         aliases: ['SPREADSHEET', 'TABLE'],
         isValid(value, settings, schema) {
-            return true;
+            return isValidCsvString(value);
         },
         canBeValid(partialValue, settings, schema) {
             return true;
@@ -4267,6 +4362,30 @@
      * TODO: [🏢] Allow to expect something inside each item of list and other formats
      */
 
+    /**
+     * Function to check if a string is valid XML
+     *
+     * @param value
+     * @returns True if the string is a valid XML string, false otherwise
+     *
+     * @public exported from `@promptbook/utils`
+     */
+    function isValidXmlString(value) {
+        try {
+            const parser = new DOMParser();
+            const parsedDocument = parser.parseFromString(value, 'application/xml');
+            const parserError = parsedDocument.getElementsByTagName('parsererror');
+            if (parserError.length > 0) {
+                return false;
+            }
+            return true;
+        }
+        catch (error) {
+            assertsError(error);
+            return false;
+        }
+    }
+
     /**
      * Definition for XML format
      *
@@ -4276,7 +4395,7 @@
         formatName: 'XML',
         mimeType: 'application/xml',
         isValid(value, settings, schema) {
-            return true;
+            return isValidXmlString(value);
         },
         canBeValid(partialValue, settings, schema) {
             return true;
@@ -4849,9 +4968,7 @@
                                     break scripts;
                                 }
                                 catch (error) {
-                                    if (!(error instanceof Error)) {
-                                        throw error;
-                                    }
+                                    assertsError(error);
                                     if (error instanceof UnexpectedError) {
                                         throw error;
                                     }
@@ -4921,9 +5038,7 @@
                                 break scripts;
                             }
                             catch (error) {
-                                if (!(error instanceof Error)) {
-                                    throw error;
-                                }
+                                assertsError(error);
                                 if (error instanceof UnexpectedError) {
                                     throw error;
                                 }
@@ -5544,9 +5659,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 [🤹‍♂️]