@promptbook/vercel 0.89.0-9 → 0.92.0-10

package/esm/typings/src/config.d.ts

@@ -3,7 +3,7 @@ import type { IntermediateFilesStrategy } from './types/IntermediateFilesStrateg
 import type { string_app_id } from './types/typeAliases';
 import type { string_email } from './types/typeAliases';
 import type { string_name } from './types/typeAliases';
-import type { string_url_image } from './types/typeAliases';
+import type { string_promptbook_server_url } from './types/typeAliases';
 /**
  * Warning message for the generated sections and files files
  *
@@ -38,22 +38,6 @@ export declare const ADMIN_GITHUB_NAME: string_name;
  * @public exported from `@promptbook/core`
  */
 export declare const CLAIM = "It's time for a paradigm shift. The future of software in plain English, French or Latin";
-/**
- * Logo for the light theme
- *
- * TODO: [🗽] Unite branding and make single place for it
- *
- * @public exported from `@promptbook/core`
- */
-export declare const LOGO_LIGHT_SRC: string_url_image;
-/**
- * Logo for the dark theme
- *
- * TODO: [🗽] Unite branding and make single place for it
- *
- * @public exported from `@promptbook/core`
- */
-export declare const LOGO_DARK_SRC: string_url_image;
 /**
  * When the title is not provided, the default title is used
  *
@@ -90,6 +74,12 @@ export declare const DEFAULT_MAX_FILE_SIZE: number;
  * @private within the repository
  */
 export declare const GENERATOR_WARNING_BY_PROMPTBOOK_CLI = "\u26A0\uFE0F 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
+ */
+export declare const GENERATOR_WARNING_IN_ENV = "Note: Added by Promptbook";
 /**
  * The maximum number of iterations for a loops
  *
@@ -115,6 +105,7 @@ export declare const VALUE_STRINGS: {
     readonly infinity: "(infinity; ∞)";
     readonly negativeInfinity: "(negative infinity; -∞)";
     readonly unserializable: "(unserializable value)";
+    readonly circular: "(circular JSON)";
 };
 /**
  * Small number limit
@@ -237,11 +228,11 @@ export declare const MOMENT_ARG_THRESHOLDS: {
     readonly ss: 3;
 };
 /**
- * @@@
+ * Default remote server URL for the Promptbook
  *
  * @public exported from `@promptbook/core`
  */
-export declare const DEFAULT_REMOTE_SERVER_URL = "https://api.pavolhejny.com/promptbook";
+export declare const DEFAULT_REMOTE_SERVER_URL: string_promptbook_server_url;
 /**
  * @@@
  *

package/esm/typings/src/conversion/archive/loadArchive.d.ts

@@ -1,6 +1,6 @@
+import type { FilesystemTools } from '../../execution/FilesystemTools';
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { string_filename } from '../../types/typeAliases';
-import type { FilesystemTools } from '../../execution/FilesystemTools';
 /**
  * Loads the books from the archive file with `.bookc` extension
  *
@@ -10,7 +10,7 @@ import type { FilesystemTools } from '../../execution/FilesystemTools';
  *
  * @private utility of Prompbook
  */
-export declare function loadArchive(filePath: string_filename, fs: FilesystemTools): Promise<Array<PipelineJson>>;
+export declare function loadArchive(filePath: string_filename, fs: FilesystemTools): Promise<ReadonlyArray<PipelineJson>>;
 /**
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
  */

package/esm/typings/src/errors/0-index.d.ts

@@ -15,6 +15,7 @@ import { PipelineLogicError } from './PipelineLogicError';
 import { PipelineUrlError } from './PipelineUrlError';
 import { PromptbookFetchError } from './PromptbookFetchError';
 import { UnexpectedError } from './UnexpectedError';
+import { WrappedError } from './WrappedError';
 /**
  * Index of all custom errors
  *
@@ -35,7 +36,10 @@ export declare const PROMPTBOOK_ERRORS: {
     readonly PipelineExecutionError: typeof PipelineExecutionError;
     readonly PipelineLogicError: typeof PipelineLogicError;
     readonly PipelineUrlError: typeof PipelineUrlError;
+    readonly AuthenticationError: typeof AuthenticationError;
+    readonly PromptbookFetchError: typeof PromptbookFetchError;
     readonly UnexpectedError: typeof UnexpectedError;
+    readonly WrappedError: typeof WrappedError;
 };
 /**
  * Index of all javascript errors
@@ -51,8 +55,6 @@ export declare const COMMON_JAVASCRIPT_ERRORS: {
     readonly TypeError: TypeErrorConstructor;
     readonly URIError: URIErrorConstructor;
     readonly AggregateError: AggregateErrorConstructor;
-    readonly AuthenticationError: typeof AuthenticationError;
-    readonly PromptbookFetchError: typeof PromptbookFetchError;
 };
 /**
  * Index of all errors
@@ -68,8 +70,6 @@ export declare const ALL_ERRORS: {
     readonly TypeError: TypeErrorConstructor;
     readonly URIError: URIErrorConstructor;
     readonly AggregateError: AggregateErrorConstructor;
-    readonly AuthenticationError: typeof AuthenticationError;
-    readonly PromptbookFetchError: typeof PromptbookFetchError;
     readonly AbstractFormatError: typeof AbstractFormatError;
     readonly CsvFormatError: typeof CsvFormatError;
     readonly CollectionError: typeof CollectionError;
@@ -84,7 +84,10 @@ export declare const ALL_ERRORS: {
     readonly PipelineExecutionError: typeof PipelineExecutionError;
     readonly PipelineLogicError: typeof PipelineLogicError;
     readonly PipelineUrlError: typeof PipelineUrlError;
+    readonly AuthenticationError: typeof AuthenticationError;
+    readonly PromptbookFetchError: typeof PromptbookFetchError;
     readonly UnexpectedError: typeof UnexpectedError;
+    readonly WrappedError: typeof WrappedError;
 };
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name

package/esm/typings/src/errors/PipelineExecutionError.d.ts

@@ -10,5 +10,5 @@ export declare class PipelineExecutionError extends Error {
     constructor(message: string);
 }
 /**
- * TODO: !!!!!! Add id to all errors
+ * TODO: [🧠][🌂] Add id to all errors
  */

package/esm/typings/src/errors/WrappedError.d.ts

@@ -0,0 +1,10 @@
+import type { really_any } from '../utils/organization/really_any';
+/**
+ * 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`
+ */
+export declare class WrappedError extends Error {
+    readonly name = "WrappedError";
+    constructor(whatWasThrown: really_any);
+}

package/esm/typings/src/errors/assertsError.d.ts

@@ -0,0 +1,11 @@
+import type { really_unknown } from '../utils/organization/really_unknown';
+/**
+ * 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
+ */
+export declare function assertsError(whatWasThrown: really_unknown): asserts whatWasThrown is Error;

package/esm/typings/src/execution/CommonToolsOptions.d.ts

@@ -16,6 +16,10 @@ export type CommonToolsOptions = {
      * If true, the internal executions will be logged
      */
     readonly isVerbose?: boolean;
+    /**
+    * Maximum number of requests per minute
+    */
+    readonly maxRequestsPerMinute?: number;
 };
 /**
  * TODO: [🧠][🤺] Maybe allow overriding of `userId` for each prompt

package/esm/typings/src/execution/PromptbookFetch.d.ts

@@ -7,6 +7,6 @@ import type { string_url } from '../types/typeAliases';
  *
  * It is used in theese places:
  * - Fetching knowledge sources
- * - Callbacks from remote server ([👩🏾‍🤝‍🧑🏾] Not yet implemented)
+ * - Callbacks from remote server
  */
 export type PromptbookFetch = (url: string_url, init?: RequestInit) => Promise<Response>;

package/esm/typings/src/execution/createPipelineExecutor/getKnowledgeForTask.d.ts

@@ -3,12 +3,17 @@ import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
 import type { string_markdown } from '../../types/typeAliases';
 import type { string_parameter_value } from '../../types/typeAliases';
+import type { ExecutionTools } from '../ExecutionTools';
 /**
  * @@@
  *
  * @private internal type of `getKnowledgeFoTask`
  */
 type GetKnowledgeForTaskOptions = {
+    /**
+     * The execution tools to be used during the execution of the pipeline
+     */
+    readonly tools: ExecutionTools;
     /**
      * @@@
      */
@@ -21,7 +26,14 @@ type GetKnowledgeForTaskOptions = {
 /**
  * @@@
  *
+ * Here is the place where RAG (retrieval-augmented generation) happens
+ *
  * @private internal utility of `createPipelineExecutor`
  */
 export declare function getKnowledgeForTask(options: GetKnowledgeForTaskOptions): Promise<string_parameter_value & string_markdown>;
 export {};
+/**
+ * TODO: !!!! Verify if this is working
+ * TODO: [♨] Implement Better - use keyword search
+ * TODO: [♨] Examples of values
+ */

package/esm/typings/src/execution/createPipelineExecutor/getReservedParametersForTask.d.ts

@@ -2,12 +2,17 @@ import type { ReadonlyDeep } from 'type-fest';
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
 import type { ReservedParameters } from '../../types/typeAliases';
+import type { ExecutionTools } from '../ExecutionTools';
 /**
  * @@@
  *
  * @private internal type of `getReservedParametersForTask`
  */
 type GetReservedParametersForTaskOptions = {
+    /**
+     * The execution tools to be used during the execution of the pipeline
+     */
+    readonly tools: ExecutionTools;
     /**
      * @@@
      */

package/esm/typings/src/formats/csv/utils/csvParse.d.ts

@@ -0,0 +1,12 @@
+import type { ParseResult } from 'papaparse';
+import type { TODO_any } from '../../../utils/organization/TODO_any';
+import type { Parameters } from '../../../types/typeAliases';
+import type { CsvSettings } from '../CsvSettings';
+/**
+ * Converts a CSV string into an object
+ *
+ * Note: This is wrapper around `papaparse.parse()` with better autohealing
+ *
+ * @private - for now until `@promptbook/csv` is released
+ */
+export declare function csvParse(value: string, settings?: CsvSettings, schema?: TODO_any): ParseResult<Parameters>;

package/esm/typings/src/formats/csv/utils/isValidCsvString.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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`
+ */
+export declare function isValidCsvString(value: string): boolean;

package/esm/typings/src/formats/csv/utils/isValidCsvString.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/src/formats/json/utils/isValidJsonString.d.ts

@@ -1,6 +1,9 @@
 /**
  * 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`
  */
 export declare function isValidJsonString(value: string): boolean;

package/esm/typings/src/formats/json/utils/jsonParse.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Converts a JavaScript Object Notation (JSON) string into an object.
+ *
+ * Note: This is wrapper around `JSON.parse()` with better error and type handling
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function jsonParse<T>(value: string): T;
+/**
+ * TODO: !!!! Use in Promptbook.studio
+ */

package/esm/typings/src/formats/xml/utils/isValidXmlString.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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`
+ */
+export declare function isValidXmlString(value: string): boolean;

package/esm/typings/src/formats/xml/utils/isValidXmlString.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/src/llm-providers/_common/filterModels.d.ts

@@ -0,0 +1,15 @@
+import type { AvailableModel } from '../../execution/AvailableModel';
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+/**
+ * Creates a wrapper around LlmExecutionTools that only exposes models matching the filter function
+ *
+ * @param llmTools The original LLM execution tools to wrap
+ * @param modelFilter Function that determines whether a model should be included
+ * @returns A new LlmExecutionTools instance with filtered models
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function filterModels<TLlmTools extends LlmExecutionTools>(llmTools: TLlmTools, modelFilter: (model: AvailableModel) => boolean): TLlmTools;
+/**
+ * TODO: !!! [models] Test that this is working
+ */

package/esm/typings/src/llm-providers/_common/register/{$provideEnvFilepath.d.ts → $provideEnvFilename.d.ts}

@@ -2,11 +2,11 @@ import type { string_filename } from '../../../types/typeAliases';
 /**
  * Provides the path to the `.env` file
  *
- * Note: `$` is used to indicate that this function is not a pure function - it uses filesystem to access .env file
+ * Note: `$` is used to indicate that this function is not a pure function - it uses filesystem to access `.env` file
  *
  * @private within the repository - for CLI utils
  */
-export declare function $provideEnvFilepath(): Promise<string_filename | null>;
+export declare function $provideEnvFilename(): Promise<string_filename | null>;
 /**
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
  */

package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsConfigurationFromEnv.d.ts

@@ -3,7 +3,7 @@ import type { LlmToolsConfiguration } from './LlmToolsConfiguration';
  * @@@
  *
  * @@@ .env
- * Note: `$` is used to indicate that this function is not a pure function - it uses filesystem to access .env file
+ * 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`

package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForTestingAndScriptsAndPlayground.d.ts

@@ -12,7 +12,7 @@ type GetLlmToolsForTestingAndScriptsAndPlaygroundOptions = CreateLlmToolsFromCon
 /**
  * Returns LLM tools for testing purposes
  *
- * Note: `$` is used to indicate that this function is not a pure function - it uses filesystem to access .env file
+ * Note: `$` is used to indicate that this function is not a pure function - it uses filesystem to access `.env` file
  *
  * @private within the repository - JUST FOR TESTS, SCRIPTS AND PLAYGROUND
  */

package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForWizzardOrCli.d.ts

@@ -5,7 +5,14 @@ import type { string_url } from '../../../types/typeAliases';
 import type { really_any } from '../../../utils/organization/really_any';
 import type { CacheLlmToolsOptions } from '../utils/cache/CacheLlmToolsOptions';
 import type { LlmExecutionToolsWithTotalUsage } from '../utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
-type ProvideLlmToolsForWizzardOrCliOptions = Pick<CacheLlmToolsOptions, 'isCacheReloaded'> & ({
+type ProvideLlmToolsForWizzardOrCliOptions = {
+    /**
+     * If true, user will be always prompted for login
+     *
+     * Note: This is used in `ptbk login` command
+     */
+    isLoginloaded?: true;
+} & Pick<CacheLlmToolsOptions, 'isCacheReloaded'> & ({
     /**
      * Use local keys and execute LLMs directly
      */
@@ -29,13 +36,15 @@ type ProvideLlmToolsForWizzardOrCliOptions = Pick<CacheLlmToolsOptions, 'isCache
     readonly appId: string_app_id;
     /**
      *
+     *
+     * Note: When login prompt fails, `process.exit(1)` is called
      */
     loginPrompt(): Promisable<Identification<really_any>>;
 });
 /**
  * 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
+ * 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
  */

package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsFromEnv.d.ts

@@ -6,7 +6,7 @@ import type { CreateLlmToolsFromConfigurationOptions } from './createLlmToolsFro
  * 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
+ * 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`

package/esm/typings/src/llm-providers/_common/register/LlmToolsMetadata.d.ts

@@ -3,6 +3,41 @@ import type { string_title } from '../../../types/typeAliases';
 import type { Registered } from '../../../utils/$Register';
 import type { string_SCREAMING_CASE } from '../../../utils/normalization/normalizeTo_SCREAMING_CASE';
 import type { LlmToolsConfiguration } from './LlmToolsConfiguration';
+/**
+ * How is the model provider trusted?
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const MODEL_TRUST_LEVEL: {
+    readonly FULL: "Model is running on the local machine, training data and model weights are known, data are ethically sourced";
+    readonly OPEN: "Model is open source, training data and model weights are known";
+    readonly PARTIALLY_OPEN: "Model is open source, but training data and model weights are not (fully) known";
+    readonly CLOSED_LOCAL: "Model can be run locally, but it is not open source";
+    readonly CLOSED_FREE: "Model is behind API gateway but free to use";
+    readonly CLOSED_BUSINESS: "Model is behind API gateway and paid but has good SLA, TOS, privacy policy and in general is a good to use in business applications";
+    readonly CLOSED: "Model is behind API gateway and paid";
+    readonly UNTRUSTED: "Model has questions about the training data and ethics, but it is not known if it is a problem or not";
+    readonly VURNABLE: "Model has some known serious vulnerabilities, leaks, ethical problems, etc.";
+};
+/**
+ * How is the model provider important?
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const MODEL_ORDER: {
+    /**
+     * Top-tier models, e.g. OpenAI, Anthropic,...
+     */
+    readonly TOP_TIER: 333;
+    /**
+     * Mid-tier models, e.g. Llama, Mistral, etc.
+     */
+    readonly NORMAL: 100;
+    /**
+     * Low-tier models, e.g. Phi, Tiny, etc.
+     */
+    readonly LOW_TIER: 0;
+};
 /**
  * @@@
  *
@@ -13,6 +48,14 @@ export type LlmToolsMetadata = Registered & {
      * @@@
      */
     readonly title: string_title;
+    /**
+     * How is the model is trusted?
+     */
+    readonly trustLevel: keyof typeof MODEL_TRUST_LEVEL;
+    /**
+     * How is the model provider important and should be sorted in the list of available providers?
+     */
+    readonly order: typeof MODEL_ORDER[keyof typeof MODEL_ORDER] | number;
     /**
      * List of environment variables that can be used to configure the provider
      *

package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts

@@ -19,6 +19,10 @@ export declare class AzureOpenAiExecutionTools implements LlmExecutionTools {
      * OpenAI Azure API client.
      */
     private client;
+    /**
+     * Rate limiter instance
+     */
+    private limiter;
     /**
      * Creates OpenAI Execution Tools.
      *

package/esm/typings/src/llm-providers/deepseek/deepseek-models.d.ts

@@ -0,0 +1,23 @@
+import type { AvailableModel } from '../../execution/AvailableModel';
+import type { number_usd } from '../../types/typeAliases';
+/**
+ * List of available Deepseek models with descriptions
+ *
+ * Note: Done at 2025-04-22
+ *
+ * @see https://www.deepseek.com/models
+ * @public exported from `@promptbook/deepseek`
+ */
+export declare const DEEPSEEK_MODELS: ReadonlyArray<AvailableModel & {
+    modelDescription?: string;
+    pricing?: {
+        readonly prompt: number_usd;
+        readonly output: number_usd;
+    };
+}>;
+/**
+ * TODO: [🧠] Add information about context window sizes, capabilities, and relative performance characteristics
+ * TODO: [🎰] Some mechanism to auto-update available models
+ * TODO: [🧠] Verify pricing information is current with Deepseek's official documentation
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/llm-providers/google/google-models.d.ts

@@ -0,0 +1,23 @@
+import type { AvailableModel } from '../../execution/AvailableModel';
+import type { number_usd } from '../../types/typeAliases';
+/**
+ * List of available Google models with descriptions
+ *
+ * Note: Done at 2025-04-22
+ *
+ * @see https://ai.google.dev/models/gemini
+ * @public exported from `@promptbook/google`
+ */
+export declare const GOOGLE_MODELS: ReadonlyArray<AvailableModel & {
+    modelDescription?: string;
+    pricing?: {
+        readonly prompt: number_usd;
+        readonly output: number_usd;
+    };
+}>;
+/**
+ * TODO: [🧠] Add information about context window sizes, capabilities, and relative performance characteristics
+ * TODO: [🎰] Some mechanism to auto-update available models
+ * TODO: [🧠] Verify pricing information is current with Google's official documentation
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts

@@ -20,6 +20,10 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
      * OpenAI API client.
      */
     private client;
+    /**
+     * Rate limiter instance
+     */
+    private limiter;
     /**
      * Creates OpenAI Execution Tools.
      *

package/esm/typings/src/personas/preparePersona.d.ts

@@ -8,7 +8,7 @@ import type { string_persona_description } from '../types/typeAliases';
  * @see https://github.com/webgptorg/promptbook/discussions/22
  * @public exported from `@promptbook/core`
  */
-export declare function preparePersona(personaDescription: string_persona_description, tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions): Promise<PersonaPreparedJson['modelRequirements']>;
+export declare function preparePersona(personaDescription: string_persona_description, tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions): Promise<Pick<PersonaPreparedJson, 'modelsRequirements'>>;
 /**
  * TODO: [🔃][main] If the persona was prepared with different version or different set of models, prepare it once again
  * TODO: [🏢] Check validity of `modelName` in pipeline

package/esm/typings/src/pipeline/PipelineJson/PersonaJson.d.ts

@@ -30,11 +30,13 @@ export type PersonaJson = {
  */
 export type PersonaPreparedJson = PersonaJson & {
     /**
-     * Model requirements for the persona
+     * Models requirements for the persona
+     *
+     * Sorted by relevance, best-fitting models is first
      *
      * Note: The model must be CHAT variant to be usable through persona
      */
-    readonly modelRequirements: ChatModelRequirements;
+    readonly modelsRequirements: Array<ChatModelRequirements>;
     /**
      * List of preparation ids that were used to prepare this persona
      */