@promptbook/markdown-utils 0.92.0-9 → 0.93.0

package/esm/typings/src/_packages/browser.index.d.ts

@@ -1,10 +1,12 @@
 import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
 import { SimplePromptInterfaceTools } from '../dialogs/simple-prompt/SimplePromptInterfaceTools';
 import { $provideScrapersForBrowser } from '../scrapers/_common/register/$provideScrapersForBrowser';
+import { getIndexedDbStorage } from '../storage/local-storage/getIndexedDbStorage';
 import { getLocalStorage } from '../storage/local-storage/getLocalStorage';
 import { getSessionStorage } from '../storage/local-storage/getSessionStorage';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export { SimplePromptInterfaceTools };
 export { $provideScrapersForBrowser };
+export { getIndexedDbStorage };
 export { getLocalStorage };
 export { getSessionStorage };

package/esm/typings/src/_packages/core.index.d.ts

@@ -13,6 +13,9 @@ import { DEFAULT_TASK_TITLE } from '../config';
 import { DEFAULT_PROMPT_TASK_TITLE } from '../config';
 import { DEFAULT_BOOK_OUTPUT_PARAMETER_NAME } from '../config';
 import { DEFAULT_MAX_FILE_SIZE } from '../config';
+import { BIG_DATASET_TRESHOLD } from '../config';
+import { FAILED_VALUE_PLACEHOLDER } from '../config';
+import { PENDING_VALUE_PLACEHOLDER } from '../config';
 import { MAX_FILENAME_LENGTH } from '../config';
 import { DEFAULT_INTERMEDIATE_FILES_STRATEGY } from '../config';
 import { DEFAULT_MAX_PARALLEL_COUNT } from '../config';
@@ -32,6 +35,9 @@ import { DEFAULT_IS_VERBOSE } from '../config';
 import { SET_IS_VERBOSE } from '../config';
 import { DEFAULT_IS_AUTO_INSTALLED } from '../config';
 import { DEFAULT_GET_PIPELINE_COLLECTION_FUNCTION_NAME } from '../config';
+import { DEFAULT_MAX_REQUESTS_PER_MINUTE } from '../config';
+import { MODEL_TRUST_LEVELS } from '../constants';
+import { MODEL_ORDERS } from '../constants';
 import { ORDER_OF_PIPELINE_JSON } from '../constants';
 import { RESERVED_PARAMETER_NAMES } from '../constants';
 import { compilePipeline } from '../conversion/compilePipeline';
@@ -62,6 +68,7 @@ import { PromptbookFetchError } from '../errors/PromptbookFetchError';
 import { UnexpectedError } from '../errors/UnexpectedError';
 import { WrappedError } from '../errors/WrappedError';
 import { createPipelineExecutor } from '../execution/createPipelineExecutor/00-createPipelineExecutor';
+import { computeCosineSimilarity } from '../execution/createPipelineExecutor/computeCosineSimilarity';
 import { embeddingVectorToString } from '../execution/embeddingVectorToString';
 import { executionReportJsonToString } from '../execution/execution-report/executionReportJsonToString';
 import type { ExecutionReportStringOptions } from '../execution/execution-report/ExecutionReportStringOptions';
@@ -74,12 +81,13 @@ import { ZERO_USAGE } from '../execution/utils/usage-constants';
 import { UNCERTAIN_USAGE } from '../execution/utils/usage-constants';
 import { usageToHuman } from '../execution/utils/usageToHuman';
 import { usageToWorktime } from '../execution/utils/usageToWorktime';
-import { CsvFormatDefinition } from '../formats/csv/CsvFormatDefinition';
 import { CsvFormatError } from '../formats/csv/CsvFormatError';
+import { CsvFormatParser } from '../formats/csv/CsvFormatParser';
 import { MANDATORY_CSV_SETTINGS } from '../formats/csv/CsvSettings';
-import { TextFormatDefinition } from '../formats/text/TextFormatDefinition';
+import { TextFormatParser } from '../formats/text/TextFormatParser';
 import { BoilerplateFormfactorDefinition } from '../formfactors/_boilerplate/BoilerplateFormfactorDefinition';
 import { ChatbotFormfactorDefinition } from '../formfactors/chatbot/ChatbotFormfactorDefinition';
+import { CompletionFormfactorDefinition } from '../formfactors/completion/CompletionFormfactorDefinition';
 import { GeneratorFormfactorDefinition } from '../formfactors/generator/GeneratorFormfactorDefinition';
 import { GenericFormfactorDefinition } from '../formfactors/generic/GenericFormfactorDefinition';
 import { ImageGeneratorFormfactorDefinition } from '../formfactors/image-generator/ImageGeneratorFormfactorDefinition';
@@ -91,19 +99,18 @@ import { filterModels } from '../llm-providers/_common/filterModels';
 import { $llmToolsMetadataRegister } from '../llm-providers/_common/register/$llmToolsMetadataRegister';
 import { $llmToolsRegister } from '../llm-providers/_common/register/$llmToolsRegister';
 import { createLlmToolsFromConfiguration } from '../llm-providers/_common/register/createLlmToolsFromConfiguration';
-import { MODEL_TRUST_LEVEL } from '../llm-providers/_common/register/LlmToolsMetadata';
-import { MODEL_ORDER } from '../llm-providers/_common/register/LlmToolsMetadata';
 import { cacheLlmTools } from '../llm-providers/_common/utils/cache/cacheLlmTools';
 import { countUsage } from '../llm-providers/_common/utils/count-total-usage/countUsage';
 import { limitTotalUsage } from '../llm-providers/_common/utils/count-total-usage/limitTotalUsage';
+import { joinLlmExecutionTools } from '../llm-providers/_multiple/joinLlmExecutionTools';
+import { MultipleLlmExecutionTools } from '../llm-providers/_multiple/MultipleLlmExecutionTools';
 import { _AnthropicClaudeMetadataRegistration } from '../llm-providers/anthropic-claude/register-configuration';
 import { _AzureOpenAiMetadataRegistration } from '../llm-providers/azure-openai/register-configuration';
 import { _DeepseekMetadataRegistration } from '../llm-providers/deepseek/register-configuration';
 import { _GoogleMetadataRegistration } from '../llm-providers/google/register-configuration';
-import { joinLlmExecutionTools } from '../llm-providers/multiple/joinLlmExecutionTools';
-import { MultipleLlmExecutionTools } from '../llm-providers/multiple/MultipleLlmExecutionTools';
 import { _OpenAiMetadataRegistration } from '../llm-providers/openai/register-configuration';
 import { _OpenAiAssistantMetadataRegistration } from '../llm-providers/openai/register-configuration';
+import { migratePipeline } from '../migrations/migratePipeline';
 import { preparePersona } from '../personas/preparePersona';
 import { book } from '../pipeline/book-notation';
 import { isValidPipelineString } from '../pipeline/isValidPipelineString';
@@ -115,7 +122,6 @@ import { EXPECTATION_UNITS } from '../pipeline/PipelineJson/Expectations';
 import { validatePipelineString } from '../pipeline/validatePipelineString';
 import { isPipelinePrepared } from '../prepare/isPipelinePrepared';
 import { preparePipeline } from '../prepare/preparePipeline';
-import { prepareTasks } from '../prepare/prepareTasks';
 import { unpreparePipeline } from '../prepare/unpreparePipeline';
 import { identificationToPromptbookToken } from '../remote-server/socket-types/_subtypes/identificationToPromptbookToken';
 import { promptbookTokenToIdentification } from '../remote-server/socket-types/_subtypes/promptbookTokenToIdentification';
@@ -154,6 +160,9 @@ export { DEFAULT_TASK_TITLE };
 export { DEFAULT_PROMPT_TASK_TITLE };
 export { DEFAULT_BOOK_OUTPUT_PARAMETER_NAME };
 export { DEFAULT_MAX_FILE_SIZE };
+export { BIG_DATASET_TRESHOLD };
+export { FAILED_VALUE_PLACEHOLDER };
+export { PENDING_VALUE_PLACEHOLDER };
 export { MAX_FILENAME_LENGTH };
 export { DEFAULT_INTERMEDIATE_FILES_STRATEGY };
 export { DEFAULT_MAX_PARALLEL_COUNT };
@@ -173,6 +182,9 @@ export { DEFAULT_IS_VERBOSE };
 export { SET_IS_VERBOSE };
 export { DEFAULT_IS_AUTO_INSTALLED };
 export { DEFAULT_GET_PIPELINE_COLLECTION_FUNCTION_NAME };
+export { DEFAULT_MAX_REQUESTS_PER_MINUTE };
+export { MODEL_TRUST_LEVELS };
+export { MODEL_ORDERS };
 export { ORDER_OF_PIPELINE_JSON };
 export { RESERVED_PARAMETER_NAMES };
 export { compilePipeline };
@@ -203,6 +215,7 @@ export { PromptbookFetchError };
 export { UnexpectedError };
 export { WrappedError };
 export { createPipelineExecutor };
+export { computeCosineSimilarity };
 export { embeddingVectorToString };
 export { executionReportJsonToString };
 export type { ExecutionReportStringOptions };
@@ -215,12 +228,13 @@ export { ZERO_USAGE };
 export { UNCERTAIN_USAGE };
 export { usageToHuman };
 export { usageToWorktime };
-export { CsvFormatDefinition };
 export { CsvFormatError };
+export { CsvFormatParser };
 export { MANDATORY_CSV_SETTINGS };
-export { TextFormatDefinition };
+export { TextFormatParser };
 export { BoilerplateFormfactorDefinition };
 export { ChatbotFormfactorDefinition };
+export { CompletionFormfactorDefinition };
 export { GeneratorFormfactorDefinition };
 export { GenericFormfactorDefinition };
 export { ImageGeneratorFormfactorDefinition };
@@ -232,19 +246,18 @@ export { filterModels };
 export { $llmToolsMetadataRegister };
 export { $llmToolsRegister };
 export { createLlmToolsFromConfiguration };
-export { MODEL_TRUST_LEVEL };
-export { MODEL_ORDER };
 export { cacheLlmTools };
 export { countUsage };
 export { limitTotalUsage };
+export { joinLlmExecutionTools };
+export { MultipleLlmExecutionTools };
 export { _AnthropicClaudeMetadataRegistration };
 export { _AzureOpenAiMetadataRegistration };
 export { _DeepseekMetadataRegistration };
 export { _GoogleMetadataRegistration };
-export { joinLlmExecutionTools };
-export { MultipleLlmExecutionTools };
 export { _OpenAiMetadataRegistration };
 export { _OpenAiAssistantMetadataRegistration };
+export { migratePipeline };
 export { preparePersona };
 export { book };
 export { isValidPipelineString };
@@ -256,7 +269,6 @@ export { EXPECTATION_UNITS };
 export { validatePipelineString };
 export { isPipelinePrepared };
 export { preparePipeline };
-export { prepareTasks };
 export { unpreparePipeline };
 export { identificationToPromptbookToken };
 export { promptbookTokenToIdentification };

package/esm/typings/src/_packages/types.index.d.ts

@@ -61,7 +61,8 @@ import type { Usage } from '../execution/Usage';
 import type { UsageCounts } from '../execution/Usage';
 import type { UserInterfaceTools } from '../execution/UserInterfaceTools';
 import type { UserInterfaceToolsPromptDialogOptions } from '../execution/UserInterfaceTools';
-import type { FormatSubvalueDefinition } from '../formats/_common/FormatSubvalueDefinition';
+import type { FormatSubvalueParser } from '../formats/_common/FormatSubvalueParser';
+import type { FormatSubvalueParserMapValuesOptions } from '../formats/_common/FormatSubvalueParser';
 import type { CsvSettings } from '../formats/csv/CsvSettings';
 import type { AbstractFormfactorDefinition } from '../formfactors/_common/AbstractFormfactorDefinition';
 import type { FormfactorDefinition } from '../formfactors/_common/FormfactorDefinition';
@@ -133,6 +134,7 @@ import type { JavascriptExecutionToolsOptions } from '../scripting/javascript/Ja
 import type { PostprocessingFunction } from '../scripting/javascript/JavascriptExecutionToolsOptions';
 import type { PromptbookStorage } from '../storage/_common/PromptbookStorage';
 import type { FileCacheStorageOptions } from '../storage/file-cache-storage/FileCacheStorageOptions';
+import type { IndexedDbStorageOptions } from '../storage/local-storage/utils/IndexedDbStorageOptions';
 import type { IntermediateFilesStrategy } from '../types/IntermediateFilesStrategy';
 import type { ModelRequirements } from '../types/ModelRequirements';
 import type { CompletionModelRequirements } from '../types/ModelRequirements';
@@ -357,7 +359,8 @@ export type { Usage };
 export type { UsageCounts };
 export type { UserInterfaceTools };
 export type { UserInterfaceToolsPromptDialogOptions };
-export type { FormatSubvalueDefinition };
+export type { FormatSubvalueParser };
+export type { FormatSubvalueParserMapValuesOptions };
 export type { CsvSettings };
 export type { AbstractFormfactorDefinition };
 export type { FormfactorDefinition };
@@ -429,6 +432,7 @@ export type { JavascriptExecutionToolsOptions };
 export type { PostprocessingFunction };
 export type { PromptbookStorage };
 export type { FileCacheStorageOptions };
+export type { IndexedDbStorageOptions };
 export type { IntermediateFilesStrategy };
 export type { ModelRequirements };
 export type { CompletionModelRequirements };

package/esm/typings/src/collection/PipelineCollection.d.ts

@@ -4,8 +4,6 @@ import type { Prompt } from '../types/Prompt';
 import type { string_pipeline_url } from '../types/typeAliases';
 /**
  * Collection that groups together pipelines, knowledge, personas, tools and actions
- *
- * @see @@@ https://github.com/webgptorg/pipeline#pipeline-collection
  */
 export type PipelineCollection = {
     /**

package/esm/typings/src/collection/SimplePipelineCollection.d.ts

@@ -14,7 +14,7 @@ export declare class SimplePipelineCollection implements PipelineCollection {
     /**
      * Constructs a pipeline collection from pipelines
      *
-     * @param pipelines @@@
+     * @param pipelines Array of pipeline JSON objects to include in the collection
      *
      * Note: During the construction logic of all pipelines are validated
      * Note: It is not recommended to use this constructor directly, use `createCollectionFromJson` *(or other variant)* instead

package/esm/typings/src/commands/FOREACH/ForeachJson.d.ts

@@ -1,27 +1,27 @@
 import type { string_parameter_name } from '../../types/typeAliases';
 import type { TODO_string } from '../../utils/organization/TODO_string';
 /**
- * @@@
+ * Information for the FOREACH command, describing how to iterate over a parameter's subvalues in a pipeline task.
  */
 export type ForeachJson = {
     /**
-     * @@@
+     * The name of the format to use for parsing the parameter (e.g., 'CSV').
      */
     readonly formatName: TODO_string;
     /**
-     * @@@
+     * The name of the subformat to use (e.g., CSV Rows).
      */
     readonly subformatName: TODO_string;
     /**
-     * @@@
+     * The name of the parameter to iterate over.
      */
     readonly parameterName: string_parameter_name;
     /**
-     * @@@
+     * The names of the subparameters (e.g., name of the CSV rows)
      */
     readonly inputSubparameterNames: Array<string_parameter_name>;
     /**
-     * @@@
+     * The name of the subparameters (e.g., name of the CSV rows)
      */
     readonly outputSubparameterName: string_parameter_name;
 };

package/esm/typings/src/commands/FOREACH/foreachCommandParser.d.ts

@@ -3,8 +3,6 @@ import type { ForeachCommand } from './ForeachCommand';
 /**
  * Parses the foreach command
  *
- * Note: @@@ This command is used as foreach for new commands - it should NOT be used in any `.book` file
- *
  * @see `documentationUrl` for more details
  * @public exported from `@promptbook/editable`
  */

package/esm/typings/src/commands/FORMFACTOR/formfactorCommandParser.d.ts

@@ -3,7 +3,7 @@ import type { FormfactorCommand } from './FormfactorCommand';
 /**
  * Parses the formfactor command
  *
- * Note: @@@ This command is used as formfactor for new commands - it should NOT be used in any `.book` file
+ * Note: This command is used as a formfactor for new commands and defines the app type format - it should NOT be used in any `.book` file
  *
  * @see `documentationUrl` for more details
  * @public exported from `@promptbook/editable`

package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts

@@ -3,7 +3,7 @@ import type { BoilerplateCommand } from './BoilerplateCommand';
 /**
  * Parses the boilerplate command
  *
- * Note: @@@ This command is used as boilerplate for new commands - it should NOT be used in any `.book` file
+ * Note: @@ This command is used as boilerplate for new commands - it should NOT be used in any `.book` file
  *
  * @see `documentationUrl` for more details
  * @private within the commands folder

package/esm/typings/src/commands/_common/types/CommandParser.d.ts

@@ -8,7 +8,8 @@ import type { string_SCREAMING_CASE } from '../../../utils/normalization/normali
 import type { ___and___ } from '../../../utils/organization/___and___';
 import type { CommandUsagePlace } from './CommandUsagePlaces';
 /**
- * @@@
+ * Base type for all command objects.
+ * Requires a `type` property which is a SCREAMING_CASE string.
  *
  * @private just abstract helper for command parsers
  */
@@ -16,47 +17,48 @@ export type CommandBase = {
     type: string_name & string_SCREAMING_CASE;
 };
 /**
- * @@@
+ * Represents a parser for a specific command used within a Promptbook pipeline.
+ * It can parse commands used in the pipeline head, tasks, or both.
  *
  * @public exported from `@promptbook/editable`
  */
 export type CommandParser<TCommand extends CommandBase> = PipelineHeadCommandParser<TCommand> | PipelineTaskCommandParser<TCommand> | PipelineBothCommandParser<TCommand>;
 /**
- * @@@
+ * Common properties shared by all command parsers.
  *
  * @private just abstract the common properties of the command parsers
  */
 export type CommonCommandParser<TCommand extends CommandBase> = {
     /**
-     * @@@
+     * The unique SCREAMING_CASE name of the command (e.g., 'MODEL', 'PARAMETER').
      */
     readonly name: string_name & string_SCREAMING_CASE;
     /**
-     * @@@
+     * Indicates if the command can be used in the pipeline's head section.
      */
     readonly isUsedInPipelineHead: boolean;
     /**
-     * @@@
+     * Indicates if the command can be used within a pipeline task.
      */
     readonly isUsedInPipelineTask: boolean;
     /**
-     * @@@
+     * Optional alternative names (aliases) for the command, also in SCREAMING_CASE.
      */
     readonly aliasNames?: ReadonlyArray<string_name & string_SCREAMING_CASE>;
     /**
-     * @@@
+     * Optional list of deprecated names for the command, used for backward compatibility.
      */
     readonly deprecatedNames?: ReadonlyArray<string_name & string_SCREAMING_CASE>;
     /**
-     * @@@
+     * A brief description of the command's purpose, supporting simple Markdown.
      */
     readonly description: string_markdown_text;
     /**
-     * @@@
+     * A URL pointing to the command's documentation.
      */
     readonly documentationUrl: string_promptbook_documentation_url;
     /**
-     * @@@
+     * Examples demonstrating the usage of the command in Markdown format.
      */
     readonly examples: ReadonlyArray<string_markdown_text>;
     /**
@@ -72,23 +74,23 @@ export type CommonCommandParser<TCommand extends CommandBase> = {
     stringify(command: TCommand): string_markdown_text;
 };
 /**
- * @@@
+ * Represents a command parser that can be used in both the pipeline head and tasks.
  *
  * @public exported from `@promptbook/editable`
  */
 export type PipelineBothCommandParser<TCommand extends CommandBase> = ___and___ & Omit<PipelineHeadCommandParser<TCommand>, 'isUsedInPipelineTask'> & Omit<PipelineTaskCommandParser<TCommand>, 'isUsedInPipelineHead'>;
 /**
- * @@@
+ * Represents a command parser specifically for the pipeline head section.
  *
  * @public exported from `@promptbook/editable`
  */
 export type PipelineHeadCommandParser<TCommand extends CommandBase> = CommonCommandParser<TCommand> & {
     /**
-     * @@@
+     * Always true for pipeline head commands.
      */
     readonly isUsedInPipelineHead: true;
     /**
-     * @@@
+     * Always false for pipeline head commands.
      */
     readonly isUsedInPipelineTask: false;
     /**
@@ -106,17 +108,17 @@ export type PipelineHeadCommandParser<TCommand extends CommandBase> = CommonComm
     takeFromPipelineJson(pipelineJson: PipelineJson): ReadonlyArray<TCommand>;
 };
 /**
- * @@@
+ * Represents a command parser specifically for pipeline tasks.
  *
  * @public exported from `@promptbook/editable`
  */
 export type PipelineTaskCommandParser<TCommand extends CommandBase> = CommonCommandParser<TCommand> & {
     /**
-     * @@@
+     * Always false for pipeline task commands.
      */
     readonly isUsedInPipelineHead: false;
     /**
-     * @@@
+     * Always true for pipeline task commands.
      */
     readonly isUsedInPipelineTask: true;
     /**
@@ -133,58 +135,64 @@ export type PipelineTaskCommandParser<TCommand extends CommandBase> = CommonComm
     takeFromTaskJson($taskJson: $TaskJson): ReadonlyArray<TCommand>;
 };
 /**
- * @@@
+ * Represents a mutable TaskJson object, used internally by command parsers during application.
  *
- * Note: `$` is used to indicate that purpose of this type is to mutate the given object
+ * Note: `$` prefix indicates the object is intended for mutation.
  *
  * @private internal helper for command parsers
  */
 export type $TaskJson = {
+    /**
+     * Flag indicating if the section type (e.g., `SIMPLE_TEMPLATE`) has been set for this task.
+     */
     isSectionTypeSet: boolean;
+    /**
+     * Flag indicating if this object represents a task (as opposed to other sections like parameters).
+     */
     isTask: boolean;
 } & Partial<WritableDeep<TaskJson>>;
 /**
- * @@@
+ * Represents a mutable PipelineJson object, used internally by command parsers during application.
  *
- *  Note: `$` is used to indicate that purpose of this type is to mutate the given object
+ * Note: `$` prefix indicates the object is intended for mutation.
  *
  * @private internal helper for command parsers
  */
 export type $PipelineJson = WritableDeep<SetOptional<PipelineJson, 'formfactorName'>>;
 /**
- * @@@
+ * Input object provided to the `parse` method of a CommandParser.
  */
 export type CommandParserInput = {
     /**
-     * @@@
+     * Specifies where the command is being used (pipeline head or task).
      *
      * @example 'PIPELINE_HEAD'
      * @example 'PIPELINE_TASK'
      */
     readonly usagePlace: CommandUsagePlace;
     /**
-     * @@@
+     * The raw, unprocessed line containing the command and its arguments.
      *
      * @example 'promptbook version 0.62.0'
      * @example 'FOREACH Text Line `{customers}` -> `{customer}`'
      */
     readonly raw: string_markdown_text;
     /**
-     * @@@
+     * The arguments part of the raw command line, after the command name.
      *
      * @example '0.62.0'
      * @example 'List Line `{customers}` -> `{customer}`'
      */
     readonly rawArgs: string_markdown_text;
     /**
-     * @@@
+     * The normalized, SCREAMING_CASE representation of the command and its core arguments.
      *
      * @example 'PROMPTBOOK_ENGINE_VERSION_0_62_0'
      * @example 'FOREACH_LIST_LINE_CUSTOMERS_CUSTOMER'
      */
     readonly normalized: string_name & string_SCREAMING_CASE;
     /**
-     * @@@
+     * An array of arguments extracted from the line where the command is used.
      *
      * @example [ '0.62.0' ]
      * @example [ 'List', 'Line', '{customers}', '', '{customer}' ]

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

@@ -68,6 +68,28 @@ export declare const DEFAULT_BOOK_OUTPUT_PARAMETER_NAME = "result";
  * @public exported from `@promptbook/core`
  */
 export declare const DEFAULT_MAX_FILE_SIZE: number;
+/**
+ * Threshold value that determines when a dataset is considered "big"
+ * and may require special handling or optimizations
+ *
+ * For example, when error occurs in one item of the big dataset, it will not fail the whole pipeline
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const BIG_DATASET_TRESHOLD = 50;
+/**
+ * Placeholder text used to represent a placeholder value of failed operation
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const FAILED_VALUE_PLACEHOLDER = "!?";
+/**
+ * Placeholder text used to represent operations or values that are still in progress
+ * or awaiting completion in UI displays and logging
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const PENDING_VALUE_PLACEHOLDER = "\u2026";
 /**
  * Warning message for the generated sections and files files
  *
@@ -156,15 +178,15 @@ export declare const DEFAULT_MAX_PARALLEL_COUNT = 5;
  */
 export declare const DEFAULT_MAX_EXECUTION_ATTEMPTS = 10;
 /**
- * @@@
- * TODO: [🐝][main] !!3 Use
+ * The maximum depth to which knowledge sources will be scraped when building a knowledge base.
+ * This prevents infinite recursion and limits resource usage.
  *
  * @public exported from `@promptbook/core`
  */
 export declare const DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH = 3;
 /**
- * @@@
- * TODO: [🐝][main] !!3 Use
+ * The maximum total number of knowledge sources that will be scraped in a single operation.
+ * This acts as a global limit to avoid excessive resource consumption.
  *
  * @public exported from `@promptbook/core`
  */
@@ -234,27 +256,27 @@ export declare const MOMENT_ARG_THRESHOLDS: {
  */
 export declare const DEFAULT_REMOTE_SERVER_URL: string_promptbook_server_url;
 /**
- * @@@
+ * Default settings for parsing and generating CSV files in Promptbook.
  *
  * @public exported from `@promptbook/core`
  */
 export declare const DEFAULT_CSV_SETTINGS: CsvSettings;
 /**
- * @@@
+ * Controls whether verbose logging is enabled by default throughout the application.
  *
  * @public exported from `@promptbook/core`
  */
 export declare let DEFAULT_IS_VERBOSE: boolean;
 /**
- * @@@
+ * Enables or disables verbose logging globally at runtime.
  *
- * Note: This is experimental feature
+ * Note: This is an experimental feature.
  *
  * @public exported from `@promptbook/core`
  */
 export declare function SET_IS_VERBOSE(isVerbose: boolean): void;
 /**
- * @@@
+ * Controls whether auto-installation of dependencies is enabled by default.
  *
  * @public exported from `@promptbook/core`
  */
@@ -266,13 +288,21 @@ export declare const DEFAULT_IS_AUTO_INSTALLED = false;
  */
 export declare const DEFAULT_GET_PIPELINE_COLLECTION_FUNCTION_NAME = "getPipelineCollection";
 /**
- * @@@
+ * Default rate limits (requests per minute)
+ *
+ * Note: Adjust based on the provider tier you are have
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_MAX_REQUESTS_PER_MINUTE = 60;
+/**
+ * Indicates whether pipeline logic validation is enabled. When true, the pipeline logic is checked for consistency.
  *
  * @private within the repository
  */
 export declare const IS_PIPELINE_LOGIC_VALIDATED: boolean;
 /**
- * @@@
+ * Indicates whether cost-prevention is enabled. When true, real API keys are prevented from being used in tests.
  *
  * @private within the repository
  */

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

@@ -1,5 +1,40 @@
 import type { PipelineJson } from './pipeline/PipelineJson/PipelineJson';
 import type { ExportJsonOptions } from './utils/serialization/exportJson';
+/**
+ * How is the model provider trusted?
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const MODEL_TRUST_LEVELS: {
+    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_ORDERS: {
+    /**
+     * 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;
+};
 /**
  * Order of keys in the pipeline JSON
  *
@@ -13,13 +48,19 @@ export declare const ORDER_OF_PIPELINE_JSON: ExportJsonOptions<PipelineJson>['or
  */
 export declare const REPLACING_NONCE = "ptbkauk42kV2dzao34faw7FudQUHYPtW";
 /**
- * @@@
+ * Nonce which is used as string which is not occurring in normal text
+ *
+ * @private within the repository
+ */
+export declare const SALT_NONCE = "ptbkghhewbvruets21t54et5";
+/**
+ * Placeholder value indicating a parameter is missing its value.
  *
  * @private within the repository
  */
 export declare const RESERVED_PARAMETER_MISSING_VALUE: string;
 /**
- * @@@
+ * Placeholder value indicating a parameter is restricted and cannot be used directly.
  *
  * @private within the repository
  */

package/esm/typings/src/conversion/parsePipeline.d.ts

@@ -4,7 +4,7 @@ import type { PipelineString } from '../pipeline/PipelineString';
  * Compile pipeline from string (markdown) format to JSON format synchronously
  *
  * Note: There are 3 similar functions:
- * - `compilePipeline` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
+ * - `compilePipeline` **(preferred)** - which properly compiles the promptbook and uses embedding for external knowledge
  * - `parsePipeline` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
  * - `preparePipeline` - just one step in the compilation process
  *
@@ -24,7 +24,7 @@ export declare function parsePipeline(pipelineString: PipelineString): PipelineJ
  * TODO: Use spaceTrim more effectively
  * TODO: [🧠] Parameter flags - isInput, isOutput, isInternal
  * TODO: [🥞] Not optimal parsing because `splitMarkdownIntoSections` is executed twice with same string, once through `flattenMarkdown` and second directly here
- * TODO: [♈] Probbably move expectations from tasks to parameters
+ * TODO: [♈] Probably move expectations from tasks to parameters
  * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
  * TODO: [🍙] Make some standard order of json properties
  */