@promptbook/core 0.62.1 → 0.63.0-1

package/esm/index.es.js

@@ -1,8 +1,16 @@
 import spaceTrim, { spaceTrim as spaceTrim$1 } from 'spacetrim';
 import { format } from 'prettier';
 import parserHtml from 'prettier/parser-html';
+import hexEncoder from 'crypto-js/enc-hex';
+import sha256 from 'crypto-js/sha256';
 import moment from 'moment';
 
+/**
+ * The version of the Promptbook library
+ */
+var PROMPTBOOK_VERSION = '0.63.0-0';
+// TODO: !!!! List here all the versions and annotate + put into script
+
 /*! *****************************************************************************
 Copyright (c) Microsoft Corporation.
 
@@ -126,6 +134,8 @@ function __spreadArray(to, from, pack) {
  * Converts PipelineCollection to serialized JSON
  *
  * Note: Functions `collectionToJson` and `createCollectionFromJson` are complementary
+ *
+ * @public exported from `@promptbook/core`
  */
 function collectionToJson(collection) {
     return __awaiter(this, void 0, void 0, function () {
@@ -184,6 +194,7 @@ function prettifyMarkdown(content) {
 /**
  * Makes first letter of a string uppercase
  *
+ * @public exported from `@promptbook/utils`
  */
 function capitalize(word) {
     return word.substring(0, 1).toUpperCase() + word.substring(1);
@@ -194,6 +205,7 @@ function capitalize(word) {
  *
  * @param pipelineJson Promptbook in JSON format (.ptbk.json)
  * @returns Promptbook in string format (.ptbk.md)
+ * @public exported from `@promptbook/core`
  */
 function pipelineJsonToString(pipelineJson) {
     var e_1, _a, e_2, _b, e_3, _c, e_4, _d, e_5, _e, e_6, _f;
@@ -424,6 +436,7 @@ function deepFreeze(objectValue) {
  * @@@
  *
  * @returns The same object as the input, but deeply frozen
+ * @public exported from `@promptbook/utils`
  *
  * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
  */
@@ -431,7 +444,6 @@ function deepFreezeWithSameType(objectValue) {
     return deepFreeze(objectValue);
 }
 /**
- * TODO: [🔼] Export from `@promptbook/utils`
  * TODO: [🧠] Is there a way how to meaningfully test this utility
  */
 
@@ -457,22 +469,62 @@ function just(value) {
 
 /**
  * The maximum number of iterations for a loops
+ *
+ * @private within the repository - too low-level in comparison to other `MAX_...`
  */
 var LOOP_LIMIT = 1000;
 /**
  * The maximum number of (LLM) tasks running in parallel
+ *
+ * @public exported from `@promptbook/core`
  */
 var MAX_PARALLEL_COUNT = 5;
 /**
  * The maximum number of attempts to execute LLM task before giving up
+ *
+ * @public exported from `@promptbook/core`
  */
 var MAX_EXECUTION_ATTEMPTS = 3;
+/**
+ * The maximum length of the (generated) filename
+ *
+ * @public exported from `@promptbook/core`
+ */
+var MAX_FILENAME_LENGTH = 30;
+/**
+ * @@@
+ * TODO: [🐝] !!! Use
+ *
+ * @public exported from `@promptbook/core`
+ */
+var MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH = 3;
+/**
+ * @@@
+ * TODO: [🐝] !!! Use
+ *
+ * @public exported from `@promptbook/core`
+ */
+var MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL = 200;
+/**
+ * Where to store the cache of executions for promptbook CLI
+ *
+ * @public exported from `@promptbook/core`
+ */
+var EXECUTIONS_CACHE_DIRNAME = '/.promptbook/executions-cache';
+/**
+ * The name of the builded pipeline collection made by CLI `ptbk make` and for lookup in `createCollectionFromDirectory`
+ *
+ * @public exported from `@promptbook/core`
+ */
+var PIPELINE_COLLECTION_BASE_FILENAME = "index";
 /**
  * Nonce which is used for replacing things in strings
  */
 var REPLACING_NONCE = 'u$k42k%!V2zo34w7Fu#@QUHYPW';
 /**
  * The names of the parameters that are reserved for special purposes
+ *
+ * @public exported from `@promptbook/core`
  */
 var RESERVED_PARAMETER_NAMES = deepFreeze([
     'content',
@@ -486,10 +538,14 @@ var RESERVED_PARAMETER_NAMES = deepFreeze([
 ]);
 /**
  * @@@
+ *
+ * @private within the repository
  */
 var RESERVED_PARAMETER_MISSING_VALUE = 'MISSING-' + REPLACING_NONCE;
 /**
  * @@@
+ *
+ * @private within the repository
  */
 var RESERVED_PARAMETER_RESTRICTED = 'RESTRICTED-' + REPLACING_NONCE;
 /*
@@ -497,11 +553,13 @@ TODO: !!! Just testing false-negative detection of [🟡][🟢][🔵][⚪] leak
 */
 // [🟡][🟢][🔵][⚪]
 /**
- * TODO: [🔼] Export all to core
+ * TODO: !!!!!! Check that all @private contains some normalized explanation
  */
 
 /**
  * This error indicates that the promptbook in a markdown format cannot be parsed into a valid promptbook object
+ *
+ * @public exported from `@promptbook/core`
  */
 var ParsingError = /** @class */ (function (_super) {
     __extends(ParsingError, _super);
@@ -516,6 +574,8 @@ var ParsingError = /** @class */ (function (_super) {
 
 /**
  * This error indicates that the promptbook object has valid syntax but contains logical errors (like circular dependencies)
+ *
+ * @public exported from `@promptbook/core`
  */
 var PipelineLogicError = /** @class */ (function (_super) {
     __extends(PipelineLogicError, _super);
@@ -530,6 +590,8 @@ var PipelineLogicError = /** @class */ (function (_super) {
 
 /**
  * This error type indicates that the error should not happen and its last check before crashing with some other error
+ *
+ * @public exported from `@promptbook/core`
  */
 var UnexpectedError = /** @class */ (function (_super) {
     __extends(UnexpectedError, _super);
@@ -548,6 +610,8 @@ var UnexpectedError = /** @class */ (function (_super) {
  * Note: There are two simmilar functions:
  * - `isValidSemanticVersion` which tests any semantic version
  * - `isValidPromptbookVersion` *(this one)* which tests just Promptbook versions
+ *
+ * @public exported from `@promptbook/utils`
  */
 function isValidSemanticVersion(version) {
     if (typeof version !== 'string') {
@@ -568,6 +632,8 @@ function isValidSemanticVersion(version) {
  * Note: There are two simmilar functions:
  * - `isValidSemanticVersion` which tests any semantic version
  * - `isValidPromptbookVersion` *(this one)* which tests just Promptbook versions
+ *
+ * @public exported from `@promptbook/utils`
  */
 function isValidPromptbookVersion(version) {
     if (!isValidSemanticVersion(version)) {
@@ -586,6 +652,8 @@ function isValidPromptbookVersion(version) {
  * Note: There are two simmilar functions:
  * - `isUrlOnPrivateNetwork` which tests full URL
  * - `isHostnameOnPrivateNetwork` *(this one)* which tests just hostname
+ *
+ * @public exported from `@promptbook/utils`
  */
 function isHostnameOnPrivateNetwork(hostname) {
     if (hostname === 'example.com' ||
@@ -620,6 +688,7 @@ function isHostnameOnPrivateNetwork(hostname) {
  *
  * @param {string} ipAddress - The IP address to check.
  * @returns {boolean} Returns true if the IP address is reserved for private networks or localhost, otherwise false.
+ * @public exported from `@promptbook/utils`
  */
 function isUrlOnPrivateNetwork(url) {
     if (typeof url === 'string') {
@@ -635,6 +704,8 @@ function isUrlOnPrivateNetwork(url) {
  * 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') {
@@ -661,6 +732,8 @@ function isValidUrl(url) {
  * Note: There are two simmilar functions:
  * - `isValidUrl` which tests any URL
  * - `isValidPipelineUrl` *(this one)* which tests just pipeline URL
+ *
+ * @public exported from `@promptbook/utils`
  */
 function isValidPipelineUrl(url) {
     if (!isValidUrl(url)) {
@@ -698,6 +771,7 @@ function isValidPipelineUrl(url) {
  * @param pipeline valid or invalid PipelineJson
  * @returns the same pipeline if it is logically valid
  * @throws {PipelineLogicError} on logical error in the pipeline
+ * @public exported from `@promptbook/core`
  */
 function validatePipeline(pipeline) {
     // TODO: [🧠] Maybe test if promptbook is a promise and make specific error case for that
@@ -927,6 +1001,8 @@ function validatePipeline(pipeline) {
 
 /**
  * This error indicates that promptbook not found in the collection
+ *
+ * @public exported from `@promptbook/core`
  */
 var NotFoundError = /** @class */ (function (_super) {
     __extends(NotFoundError, _super);
@@ -941,6 +1017,8 @@ var NotFoundError = /** @class */ (function (_super) {
 
 /**
  * This error indicates errors in referencing promptbooks between each other
+ *
+ * @public exported from `@promptbook/core`
  */
 var ReferenceError$1 = /** @class */ (function (_super) {
     __extends(ReferenceError, _super);
@@ -958,6 +1036,7 @@ var ReferenceError$1 = /** @class */ (function (_super) {
  *
  * @param template the template with parameters in {curly} braces
  * @returns the list of parameter names
+ * @public exported from `@promptbook/utils`
  */
 function extractParameterNames(template) {
     var e_1, _a;
@@ -982,6 +1061,8 @@ function extractParameterNames(template) {
 
 /**
  * Unprepare just strips the preparation data of the pipeline
+ *
+ * @public exported from `@promptbook/core`
  */
 function unpreparePipeline(pipeline) {
     var personas = pipeline.personas, knowledgeSources = pipeline.knowledgeSources, promptTemplates = pipeline.promptTemplates;
@@ -998,7 +1079,6 @@ function unpreparePipeline(pipeline) {
     return __assign(__assign({}, pipeline), { promptTemplates: promptTemplates, knowledgeSources: knowledgeSources, knowledgePieces: [], personas: personas, preparations: [] });
 }
 /**
- * TODO: [🔼] !!! Export via `@promptbook/core`
  * TODO: [🧿] Maybe do same process with same granularity and subfinctions as `preparePipeline`
  * TODO: Write tests for `preparePipeline`
  * TODO: [🍙] Make some standart order of json properties
@@ -1100,6 +1180,7 @@ var SimplePipelineCollection = /** @class */ (function () {
  *
  * @param promptbookSources
  * @returns PipelineCollection
+ * @public exported from `@promptbook/core`
  */
 function createCollectionFromJson() {
     var promptbooks = [];
@@ -1127,6 +1208,7 @@ function createCollectionFromJson() {
  * @param promptbookSourcesPromiseOrFactory
  * @returns PipelineCollection
  * @deprecated Do not use, it will became internal tool for other constructor functions
+ * @public exported from `@promptbook/core`
  */
 function createCollectionFromPromise(promptbookSourcesPromiseOrFactory) {
     var collection = null;
@@ -1197,8 +1279,8 @@ function createCollectionFromPromise(promptbookSourcesPromiseOrFactory) {
 
 /**
  * Constructs Promptbook from remote Promptbase URL
-
  * @returns PipelineCollection
+ * @public exported from `@promptbook/core`
  */
 function createCollectionFromUrl(url, options) {
     return __awaiter(this, void 0, void 0, function () {
@@ -1238,6 +1320,7 @@ function createCollectionFromUrl(url, options) {
  *
  * @param promptbookSources
  * @returns PipelineCollection
+ * @public exported from `@promptbook/core`
  */
 function createSubcollection(collection, predicate) {
     function listPipelines() {
@@ -1313,6 +1396,7 @@ function createSubcollection(collection, predicate) {
  * Block type describes the way how the block is blockd
  *
  * @see https://github.com/webgptorg/promptbook#block-type
+ * @public exported from `@promptbook/core`
  */
 var BlockTypes = [
     'PROMPT_TEMPLATE',
@@ -1328,6 +1412,8 @@ var BlockTypes = [
 
 /**
  * @@@
+ *
+ * @public exported from `@promptbook/utils`
  */
 function deepClone(objectValue) {
     return JSON.parse(JSON.stringify(objectValue));
@@ -1344,14 +1430,13 @@ function deepClone(objectValue) {
     */
 }
 /**
- * TODO: [🔼] Export from `@promptbook/utils`
  * TODO: [🧠] Is there a way how to meaningfully test this utility
  */
 
 /**
  * @@@
  *
- * TODO: [🔼] Export with addUsage
+ * @public exported from `@promptbook/core`
  */
 var ZERO_USAGE = deepFreeze({
     price: { value: 0 },
@@ -1378,6 +1463,8 @@ var ZERO_USAGE = deepFreeze({
  * Function `addUsage` will add multiple usages into one
  *
  * Note: If you provide 0 values, it returns ZERO_USAGE
+ *
+ * @public exported from `@promptbook/core`
  */
 function addUsage() {
     var usageItems = [];
@@ -1450,6 +1537,7 @@ function addUsage() {
  * @param array - Array to iterate over
  * @param options - Options for the function
  * @param callbackfunction - Function to call for each item
+ * @public exported from `@promptbook/utils`
  */
 function forEachAsync(array, options, callbackfunction) {
     return __awaiter(this, void 0, void 0, function () {
@@ -1518,7 +1606,7 @@ function forEachAsync(array, options, callbackfunction) {
     });
 }
 
-var PipelineCollection = [{title:"Prepare Knowledge from Markdown",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.ptbk.md",promptbookVersion:"0.62.0",parameters:[{name:"knowledgeContent",description:"Markdown document content",isInput:true,isOutput:false},{name:"knowledgePieces",description:"The knowledge JSON object",isInput:false,isOutput:true}],promptTemplates:[{blockType:"PROMPT_TEMPLATE",name:"knowledge",title:"Knowledge",modelRequirements:{modelVariant:"CHAT",modelName:"claude-3-opus-20240229"},content:"You are experienced data researcher, extract the important knowledge from the document.\n\n# Rules\n\n-   Make pieces of information concise, clear, and easy to understand\n-   One piece of information should be approximately 1 paragraph\n-   Divide the paragraphs by markdown horizontal lines ---\n-   Omit irrelevant information\n-   Group redundant information\n-   Write just extracted information, nothing else\n\n# The document\n\nTake information from this document:\n\n> {knowledgeContent}",dependentParameterNames:["knowledgeContent"],resultingParameterName:"knowledgePieces"}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[{id:1,promptbookVersion:"0.62.0",usage:{price:{value:0},input:{tokensCount:{value:0},charactersCount:{value:0},wordsCount:{value:0},sentencesCount:{value:0},linesCount:{value:0},paragraphsCount:{value:0},pagesCount:{value:0}},output:{tokensCount:{value:0},charactersCount:{value:0},wordsCount:{value:0},sentencesCount:{value:0},linesCount:{value:0},paragraphsCount:{value:0},pagesCount:{value:0}}}}],sourceFile:"./promptbook-collection/prepare-knowledge-from-markdown.ptbk.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-keywords.ptbk.md",promptbookVersion:"0.62.0",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"keywords",description:"Keywords separated by comma",isInput:false,isOutput:true}],promptTemplates:[{blockType:"PROMPT_TEMPLATE",name:"knowledge",title:"Knowledge",modelRequirements:{modelVariant:"CHAT",modelName:"claude-3-opus-20240229"},content:"You are experienced data researcher, detect the important keywords in the document.\n\n# Rules\n\n-   Write just keywords separated by comma\n\n# The document\n\nTake information from this document:\n\n> {knowledgePieceContent}",dependentParameterNames:["knowledgePieceContent"],resultingParameterName:"keywords"}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[{id:1,promptbookVersion:"0.62.0",usage:{price:{value:0},input:{tokensCount:{value:0},charactersCount:{value:0},wordsCount:{value:0},sentencesCount:{value:0},linesCount:{value:0},paragraphsCount:{value:0},pagesCount:{value:0}},output:{tokensCount:{value:0},charactersCount:{value:0},wordsCount:{value:0},sentencesCount:{value:0},linesCount:{value:0},paragraphsCount:{value:0},pagesCount:{value:0}}}}],sourceFile:"./promptbook-collection/prepare-knowledge-keywords.ptbk.md"},{title:"Prepare Title",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-title.ptbk.md",promptbookVersion:"0.62.0",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"title",description:"The title of the document",isInput:false,isOutput:true}],promptTemplates:[{blockType:"PROMPT_TEMPLATE",name:"knowledge",title:"Knowledge",modelRequirements:{modelVariant:"CHAT",modelName:"claude-3-opus-20240229"},content:"You are experienced content creator, write best title for the document.\n\n# Rules\n\n-   Write just title, nothing else\n-   Title should be concise and clear\n-   Write maximum 5 words for the title\n\n# The document\n\n> {knowledgePieceContent}",expectations:{words:{min:1,max:8}},dependentParameterNames:["knowledgePieceContent"],resultingParameterName:"title"}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[{id:1,promptbookVersion:"0.62.0",usage:{price:{value:0},input:{tokensCount:{value:0},charactersCount:{value:0},wordsCount:{value:0},sentencesCount:{value:0},linesCount:{value:0},paragraphsCount:{value:0},pagesCount:{value:0}},output:{tokensCount:{value:0},charactersCount:{value:0},wordsCount:{value:0},sentencesCount:{value:0},linesCount:{value:0},paragraphsCount:{value:0},pagesCount:{value:0}}}}],sourceFile:"./promptbook-collection/prepare-knowledge-title.ptbk.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-persona.ptbk.md",promptbookVersion:"0.62.0",parameters:[{name:"availableModelNames",description:"List of available model names separated by comma (,)",isInput:true,isOutput:false},{name:"personaDescription",description:"Description of the persona",isInput:true,isOutput:false},{name:"modelRequirements",description:"Specific requirements for the model",isInput:false,isOutput:true}],promptTemplates:[{blockType:"PROMPT_TEMPLATE",name:"make-model-requirements",title:"Make modelRequirements",modelRequirements:{modelVariant:"CHAT",modelName:"gpt-4-turbo"},content:"You are experienced AI engineer, you need to create virtual assistant.\nWrite\n\n## Sample\n\n```json\n{\n\"modelName\": \"gpt-4o\",\n\"systemMessage\": \"You are experienced AI engineer and helpfull assistant.\",\n\"temperature\": 0.7\n}\n```\n\n## Instructions\n\n### Option `modelName`\n\nPick from the following models:\n\n-   {availableModelNames}\n\n### Option `systemMessage`\n\nThe system message is used to communicate instructions or provide context to the model at the beginning of a conversation. It is displayed in a different format compared to user messages, helping the model understand its role in the conversation. The system message typically guides the model's behavior, sets the tone, or specifies desired output from the model. By utilizing the system message effectively, users can steer the model towards generating more accurate and relevant responses.\n\nFor example:\n\n> You are an experienced AI engineer and helpful assistant.\n\n> You are a friendly and knowledgeable chatbot.\n\n### Option `temperature`\n\nThe sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.\n\nYou can pick a value between 0 and 2. For example:\n\n-   `0.1`: Low temperature, extremely conservative and deterministic\n-   `0.5`: Medium temperature, balanced between conservative and creative\n-   `1.0`: High temperature, creative and bit random\n-   `1.5`: Very high temperature, extremely creative and often chaotic and unpredictable\n-   `2.0`: Maximum temperature, completely random and unpredictable, for some extreme creative use cases\n\n# The assistant\n\nTake this description of the persona:\n\n> {personaDescription}",expectFormat:"JSON",dependentParameterNames:["availableModelNames","personaDescription"],resultingParameterName:"modelRequirements"}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[{id:1,promptbookVersion:"0.62.0",usage:{price:{value:0},input:{tokensCount:{value:0},charactersCount:{value:0},wordsCount:{value:0},sentencesCount:{value:0},linesCount:{value:0},paragraphsCount:{value:0},pagesCount:{value:0}},output:{tokensCount:{value:0},charactersCount:{value:0},wordsCount:{value:0},sentencesCount:{value:0},linesCount:{value:0},paragraphsCount:{value:0},pagesCount:{value:0}}}}],sourceFile:"./promptbook-collection/prepare-persona.ptbk.md"}];
+var PipelineCollection = [{title:"Prepare Knowledge from Markdown",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.ptbk.md",promptbookVersion:"0.63.0-0",parameters:[{name:"knowledgeContent",description:"Markdown document content",isInput:true,isOutput:false},{name:"knowledgePieces",description:"The knowledge JSON object",isInput:false,isOutput:true}],promptTemplates:[{blockType:"PROMPT_TEMPLATE",name:"knowledge",title:"Knowledge",modelRequirements:{modelVariant:"CHAT",modelName:"claude-3-opus-20240229"},content:"You are experienced data researcher, extract the important knowledge from the document.\n\n# Rules\n\n-   Make pieces of information concise, clear, and easy to understand\n-   One piece of information should be approximately 1 paragraph\n-   Divide the paragraphs by markdown horizontal lines ---\n-   Omit irrelevant information\n-   Group redundant information\n-   Write just extracted information, nothing else\n\n# The document\n\nTake information from this document:\n\n> {knowledgeContent}",dependentParameterNames:["knowledgeContent"],resultingParameterName:"knowledgePieces"}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[{id:1,promptbookVersion:"0.63.0-0",usage:{price:{value:0},input:{tokensCount:{value:0},charactersCount:{value:0},wordsCount:{value:0},sentencesCount:{value:0},linesCount:{value:0},paragraphsCount:{value:0},pagesCount:{value:0}},output:{tokensCount:{value:0},charactersCount:{value:0},wordsCount:{value:0},sentencesCount:{value:0},linesCount:{value:0},paragraphsCount:{value:0},pagesCount:{value:0}}}}],sourceFile:"./promptbook-collection/prepare-knowledge-from-markdown.ptbk.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-keywords.ptbk.md",promptbookVersion:"0.63.0-0",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"keywords",description:"Keywords separated by comma",isInput:false,isOutput:true}],promptTemplates:[{blockType:"PROMPT_TEMPLATE",name:"knowledge",title:"Knowledge",modelRequirements:{modelVariant:"CHAT",modelName:"claude-3-opus-20240229"},content:"You are experienced data researcher, detect the important keywords in the document.\n\n# Rules\n\n-   Write just keywords separated by comma\n\n# The document\n\nTake information from this document:\n\n> {knowledgePieceContent}",dependentParameterNames:["knowledgePieceContent"],resultingParameterName:"keywords"}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[{id:1,promptbookVersion:"0.63.0-0",usage:{price:{value:0},input:{tokensCount:{value:0},charactersCount:{value:0},wordsCount:{value:0},sentencesCount:{value:0},linesCount:{value:0},paragraphsCount:{value:0},pagesCount:{value:0}},output:{tokensCount:{value:0},charactersCount:{value:0},wordsCount:{value:0},sentencesCount:{value:0},linesCount:{value:0},paragraphsCount:{value:0},pagesCount:{value:0}}}}],sourceFile:"./promptbook-collection/prepare-knowledge-keywords.ptbk.md"},{title:"Prepare Title",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-title.ptbk.md",promptbookVersion:"0.63.0-0",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"title",description:"The title of the document",isInput:false,isOutput:true}],promptTemplates:[{blockType:"PROMPT_TEMPLATE",name:"knowledge",title:"Knowledge",modelRequirements:{modelVariant:"CHAT",modelName:"claude-3-opus-20240229"},content:"You are experienced content creator, write best title for the document.\n\n# Rules\n\n-   Write just title, nothing else\n-   Title should be concise and clear\n-   Write maximum 5 words for the title\n\n# The document\n\n> {knowledgePieceContent}",expectations:{words:{min:1,max:8}},dependentParameterNames:["knowledgePieceContent"],resultingParameterName:"title"}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[{id:1,promptbookVersion:"0.63.0-0",usage:{price:{value:0},input:{tokensCount:{value:0},charactersCount:{value:0},wordsCount:{value:0},sentencesCount:{value:0},linesCount:{value:0},paragraphsCount:{value:0},pagesCount:{value:0}},output:{tokensCount:{value:0},charactersCount:{value:0},wordsCount:{value:0},sentencesCount:{value:0},linesCount:{value:0},paragraphsCount:{value:0},pagesCount:{value:0}}}}],sourceFile:"./promptbook-collection/prepare-knowledge-title.ptbk.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-persona.ptbk.md",promptbookVersion:"0.63.0-0",parameters:[{name:"availableModelNames",description:"List of available model names separated by comma (,)",isInput:true,isOutput:false},{name:"personaDescription",description:"Description of the persona",isInput:true,isOutput:false},{name:"modelRequirements",description:"Specific requirements for the model",isInput:false,isOutput:true}],promptTemplates:[{blockType:"PROMPT_TEMPLATE",name:"make-model-requirements",title:"Make modelRequirements",modelRequirements:{modelVariant:"CHAT",modelName:"gpt-4-turbo"},content:"You are experienced AI engineer, you need to create virtual assistant.\nWrite\n\n## Sample\n\n```json\n{\n\"modelName\": \"gpt-4o\",\n\"systemMessage\": \"You are experienced AI engineer and helpfull assistant.\",\n\"temperature\": 0.7\n}\n```\n\n## Instructions\n\n### Option `modelName`\n\nPick from the following models:\n\n-   {availableModelNames}\n\n### Option `systemMessage`\n\nThe system message is used to communicate instructions or provide context to the model at the beginning of a conversation. It is displayed in a different format compared to user messages, helping the model understand its role in the conversation. The system message typically guides the model's behavior, sets the tone, or specifies desired output from the model. By utilizing the system message effectively, users can steer the model towards generating more accurate and relevant responses.\n\nFor example:\n\n> You are an experienced AI engineer and helpful assistant.\n\n> You are a friendly and knowledgeable chatbot.\n\n### Option `temperature`\n\nThe sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.\n\nYou can pick a value between 0 and 2. For example:\n\n-   `0.1`: Low temperature, extremely conservative and deterministic\n-   `0.5`: Medium temperature, balanced between conservative and creative\n-   `1.0`: High temperature, creative and bit random\n-   `1.5`: Very high temperature, extremely creative and often chaotic and unpredictable\n-   `2.0`: Maximum temperature, completely random and unpredictable, for some extreme creative use cases\n\n# The assistant\n\nTake this description of the persona:\n\n> {personaDescription}",expectFormat:"JSON",dependentParameterNames:["availableModelNames","personaDescription"],resultingParameterName:"modelRequirements"}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[{id:1,promptbookVersion:"0.63.0-0",usage:{price:{value:0},input:{tokensCount:{value:0},charactersCount:{value:0},wordsCount:{value:0},sentencesCount:{value:0},linesCount:{value:0},paragraphsCount:{value:0},pagesCount:{value:0}},output:{tokensCount:{value:0},charactersCount:{value:0},wordsCount:{value:0},sentencesCount:{value:0},linesCount:{value:0},paragraphsCount:{value:0},pagesCount:{value:0}}}}],sourceFile:"./promptbook-collection/prepare-persona.ptbk.md"}];
 
 var defaultDiacriticsRemovalMap = [
     {
@@ -1736,6 +1824,8 @@ var defaultDiacriticsRemovalMap = [
  * > "ě" => "e"
  * > "Ă" => "A"
  * > ...
+ *
+ * @public exported from `@promptbook/utils`
  */
 var DIACRITIC_VARIANTS_LETTERS = {};
 // tslint:disable-next-line: prefer-for-of
@@ -1763,7 +1853,11 @@ for (var i = 0; i < defaultDiacriticsRemovalMap.length; i++) {
 */
 
 /**
+ * @@@
  *
+ * @param input @@@
+ * @returns @@@
+ * @public exported from `@promptbook/utils`
  */
 function removeDiacritics(input) {
     /*eslint no-control-regex: "off"*/
@@ -1771,7 +1865,19 @@ function removeDiacritics(input) {
         return DIACRITIC_VARIANTS_LETTERS[a] || a;
     });
 }
+/**
+ * TODO: [Ж] Variant for cyrillic (and in general non-latin) letters
+ */
 
+/**
+ * @@@
+ *
+ * @param text @@@
+ * @returns @@@
+ * @example 'hello-world'
+ * @example 'i-love-promptbook'
+ * @public exported from `@promptbook/utils`
+ */
 function normalizeToKebabCase(text) {
     var e_1, _a;
     text = removeDiacritics(text);
@@ -1831,6 +1937,7 @@ function normalizeToKebabCase(text) {
  *
  * @param text with emojis
  * @returns text without emojis
+ * @public exported from `@promptbook/utils`
  */
 function removeEmojis(text) {
     // Replace emojis (and also ZWJ sequence) with hyphens
@@ -1842,7 +1949,12 @@ function removeEmojis(text) {
 }
 
 /**
- * Function normalizes title to name which can be used as identifier
+ * @@@
+ *
+ * @param value @@@
+ * @returns @@@
+ * @example @@@
+ * @public exported from `@promptbook/utils`
  */
 function titleToName(value) {
     if (value.startsWith('http://') || value.startsWith('https://')) {
@@ -1861,6 +1973,8 @@ function titleToName(value) {
 
 /**
  * This error indicates errors during the execution of the pipeline
+ *
+ * @public exported from `@promptbook/core`
  */
 var PipelineExecutionError = /** @class */ (function (_super) {
     __extends(PipelineExecutionError, _super);
@@ -1878,6 +1992,7 @@ var PipelineExecutionError = /** @class */ (function (_super) {
  *
  * @param executionResult - The partial result of the promptnook execution
  * @throws {PipelineExecutionError} If the execution is not successful or if multiple errors occurred
+ * @public exported from `@promptbook/core`
  */
 function assertsExecutionSuccessful(executionResult) {
     var isSuccessful = executionResult.isSuccessful, errors = executionResult.errors;
@@ -1908,6 +2023,7 @@ function assertsExecutionSuccessful(executionResult) {
  * @param script from which to extract the variables
  * @returns the list of variable names
  * @throws {ParsingError} if the script is invalid
+ * @public exported from `@promptbook/utils`
  */
 function extractVariables(script) {
     var variables = new Set();
@@ -1956,6 +2072,7 @@ function extractVariables(script) {
  * @param promptTemplate the template with used parameters
  * @returns the set of parameter names
  * @throws {ParsingError} if the script is invalid
+ * @public exported from `@promptbook/utils`
  */
 function extractParameterNamesFromPromptTemplate(promptTemplate) {
     var e_1, _a, e_2, _b, e_3, _c;
@@ -2029,6 +2146,8 @@ var ExpectError = /** @class */ (function (_super) {
 
 /**
  * Function isValidJsonString will tell you if the string is valid JSON or not
+ *
+ * @public exported from `@promptbook/utils`
  */
 function isValidJsonString(value /* <- [👨‍⚖️] */) {
     try {
@@ -2255,6 +2374,8 @@ var MultipleLlmExecutionTools = /** @class */ (function () {
  *
  *
  * Tip: You don't have to use this function directly, just pass an array of LlmExecutionTools to the `ExecutionTools`
+ *
+ * @public exported from `@promptbook/core`
  */
 function joinLlmExecutionTools() {
     var llmExecutionTools = [];
@@ -2294,6 +2415,8 @@ function joinLlmExecutionTools() {
 
 /**
  * Determine if the pipeline is fully prepared
+ *
+ * @public exported from `@promptbook/core`
  */
 function isPipelinePrepared(pipeline) {
     // Note: Ignoring `pipeline.preparations` @@@
@@ -2314,7 +2437,6 @@ function isPipelinePrepared(pipeline) {
 }
 /**
  * TODO: [🐠] Maybe base this on `makeValidator`
- * TODO: [🔼] Export via core or utils
  * TODO: [🧊] Pipeline can be partially prepared, this should return true ONLY if fully prepared
  * TODO: [🧿] Maybe do same process with same granularity and subfinctions as `preparePipeline`
  *     - [🏍] ? Is context in each template
@@ -2360,6 +2482,8 @@ function TODO_USE() {
 
 /**
  * This error type indicates that some limit was reached
+ *
+ * @public exported from `@promptbook/core`
  */
 var LimitReachedError = /** @class */ (function (_super) {
     __extends(LimitReachedError, _super);
@@ -2379,6 +2503,7 @@ var LimitReachedError = /** @class */ (function (_super) {
  * @param parameters the object with parameters
  * @returns the template with replaced parameters
  * @throws {PipelineExecutionError} if parameter is not defined, not closed, or not opened
+ * @public exported from `@promptbook/utils`
  */
 function replaceParameters(template, parameters) {
     var e_1, _a;
@@ -2454,6 +2579,7 @@ function replaceParameters(template, parameters) {
  * Create difference set of two sets.
  *
  * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
+ * @public exported from `@promptbook/utils`
  */
 function difference(a, b, isEqual) {
     var e_1, _a;
@@ -2487,6 +2613,7 @@ function difference(a, b, isEqual) {
  * Creates a new set with all elements that are present in either set
  *
  * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
+ * @public exported from `@promptbook/utils`
  */
 function union() {
     var e_1, _a, e_2, _b;
@@ -2523,14 +2650,10 @@ function union() {
     return union;
 }
 
-/**
- * The version of the Promptbook library
- */
-var PROMPTBOOK_VERSION = '0.62.0';
-// TODO: !!!! List here all the versions and annotate + put into script
-
 /**
  * Counts number of characters in the text
+ *
+ * @public exported from `@promptbook/utils`
  */
 function countCharacters(text) {
     // Remove null characters
@@ -2544,6 +2667,8 @@ function countCharacters(text) {
 
 /**
  * Counts number of lines in the text
+ *
+ * @public exported from `@promptbook/utils`
  */
 function countLines(text) {
     if (text === '') {
@@ -2554,6 +2679,8 @@ function countLines(text) {
 
 /**
  * Counts number of pages in the text
+ *
+ * @public exported from `@promptbook/utils`
  */
 function countPages(text) {
     var sentencesPerPage = 5; // Assuming each page has 5 sentences
@@ -2564,6 +2691,8 @@ function countPages(text) {
 
 /**
  * Counts number of paragraphs in the text
+ *
+ * @public exported from `@promptbook/utils`
  */
 function countParagraphs(text) {
     return text.split(/\n\s*\n/).filter(function (paragraph) { return paragraph.trim() !== ''; }).length;
@@ -2571,12 +2700,16 @@ function countParagraphs(text) {
 
 /**
  * Split text into sentences
+ *
+ * @public exported from `@promptbook/utils`
  */
 function splitIntoSentences(text) {
     return text.split(/[.!?]+/).filter(function (sentence) { return sentence.trim() !== ''; });
 }
 /**
  * Counts number of sentences in the text
+ *
+ * @public exported from `@promptbook/utils`
  */
 function countSentences(text) {
     return splitIntoSentences(text).length;
@@ -2584,6 +2717,8 @@ function countSentences(text) {
 
 /**
  * Counts number of words in the text
+ *
+ * @public exported from `@promptbook/utils`
  */
 function countWords(text) {
     text = text.replace(/[\p{Extended_Pictographic}]/gu, 'a');
@@ -2593,6 +2728,8 @@ function countWords(text) {
 
 /**
  * Index of all counter functions
+ *
+ * @public exported from `@promptbook/utils`
  */
 var CountUtils = {
     CHARACTERS: countCharacters,
@@ -2612,6 +2749,7 @@ var CountUtils = {
  *
  * @throws {ExpectError} if the expectations are not met
  * @returns {void} Nothing
+ * @public exported from `@promptbook/core`
  */
 function checkExpectations(expectations, value) {
     var e_1, _a;
@@ -2643,6 +2781,7 @@ function checkExpectations(expectations, value) {
  * - `isPassingExpectations` which returns a boolean
  *
  * @returns {boolean} True if the expectations are met
+ * @public exported from `@promptbook/core`
  */
 function isPassingExpectations(expectations, value) {
     try {
@@ -2665,6 +2804,7 @@ function isPassingExpectations(expectations, value) {
  *
  * @returns The executor function
  * @throws {PipelineLogicError} on logical error in the pipeline
+ * @public exported from `@promptbook/core`
  */
 function createPipelineExecutor(options) {
     var _this = this;
@@ -3453,6 +3593,8 @@ function createPipelineExecutor(options) {
 
 /**
  * @@@
+ *
+ * @public exported from `@promptbook/core`
  */
 function prepareKnowledgeFromMarkdown(knowledgeContent /* <- TODO: [🖖] (?maybe not) Always the file */, options) {
     return __awaiter(this, void 0, void 0, function () {
@@ -3588,6 +3730,7 @@ function prepareKnowledgeFromMarkdown(knowledgeContent /* <- TODO: [🖖] (?mayb
  * Prepares the knowle
  *
  * @see https://github.com/webgptorg/promptbook/discussions/41
+ * @public exported from `@promptbook/core`
  */
 function prepareKnowledgePieces(knowledgeSources, options) {
     return __awaiter(this, void 0, void 0, function () {
@@ -3602,7 +3745,7 @@ function prepareKnowledgePieces(knowledgeSources, options) {
                             var partialPieces, pieces;
                             return __generator(this, function (_a) {
                                 switch (_a.label) {
-                                    case 0: return [4 /*yield*/, prepareKnowledgeFromMarkdown(knowledgeSource.source, // <- TODO: [🐝] !!! Unhardcode markdown, detect which type it is
+                                    case 0: return [4 /*yield*/, prepareKnowledgeFromMarkdown(knowledgeSource.source, // <- TODO: [🐝] !!! Unhardcode markdown, detect which type it is - BE AWARE of big package size
                                         options)];
                                     case 1:
                                         partialPieces = _a.sent();
@@ -3640,7 +3783,6 @@ TODO: [🧊] This is how it can look in future
 > ):
 */
 /**
- * TODO: [🐝][🔼] !!! Export via `@promptbook/core`
  * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time
  *       Put `knowledgePieces` into `PrepareKnowledgeOptions`
  * TODO: [🪂] More than max things can run in parallel by acident [1,[2a,2b,_],[3a,3b,_]]
@@ -3654,6 +3796,7 @@ TODO: [🧊] This is how it can look in future
  *
  * @param llmTools LLM tools to be intercepted with usage counting
  * @returns LLM tools with same functionality with added total cost counting
+ * @public exported from `@promptbook/core`
  */
 function countTotalUsage(llmTools) {
     var _this = this;
@@ -3721,7 +3864,6 @@ function countTotalUsage(llmTools) {
     return proxyTools;
 }
 /**
- * TODO: [🔼] !!! Export via `@promptbookcore/`
  * TODO: [🧠][💸] Maybe make some common abstraction `interceptLlmTools` and use here (or use javascript Proxy?)
  * TODO: [🧠] Is there some meaningfull way how to test this util
  * TODO: [🧠][🌯] Maybe a way how to hide ability to `get totalUsage`
@@ -3733,6 +3875,7 @@ function countTotalUsage(llmTools) {
  * Prepares the persona for the pipeline
  *
  * @see https://github.com/webgptorg/promptbook/discussions/22
+ * @public exported from `@promptbook/core`
  */
 function preparePersona(personaDescription, options) {
     return __awaiter(this, void 0, void 0, function () {
@@ -3787,7 +3930,6 @@ function preparePersona(personaDescription, options) {
     });
 }
 /**
- * TODO: [🔼] !!! Export via `@promptbook/core`
  * TODO: [🏢] !! Check validity of `modelName` in pipeline
  * TODO: [🏢] !! Check validity of `systemMessage` in pipeline
  * TODO: [🏢] !! Check validity of `temperature` in pipeline
@@ -3795,6 +3937,8 @@ function preparePersona(personaDescription, options) {
 
 /**
  * @@@
+ *
+ * @public exported from `@promptbook/core`
  */
 function prepareTemplates(pipeline, options) {
     return __awaiter(this, void 0, void 0, function () {
@@ -3836,7 +3980,6 @@ function prepareTemplates(pipeline, options) {
  * TODO: [🧠] Add context to each template (if missing)
  * TODO: [🧠] What is better name `prepareTemplate` or `prepareTemplateAndParameters`
  * TODO: [♨] !!! Prepare index the samples and maybe templates
- * TODO: [🔼] !!! Export via `@promptbook/core`
  * TODO: Write tests for `preparePipeline`
  * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
  * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time
@@ -3849,6 +3992,7 @@ function prepareTemplates(pipeline, options) {
  *
  * Note: This function does not validate logic of the pipeline
  * Note: This function acts as part of compilation process
+ * @public exported from `@promptbook/core`
  */
 function preparePipeline(pipeline, options) {
     return __awaiter(this, void 0, void 0, function () {
@@ -3925,7 +4069,6 @@ function preparePipeline(pipeline, options) {
     });
 }
 /**
- * TODO: [🔼] !!! Export via `@promptbook/core`
  * TODO: Write tests for `preparePipeline`
  * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
  * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time
@@ -3936,6 +4079,7 @@ function preparePipeline(pipeline, options) {
  * Tests if given string is valid URL.
  *
  * Note: This does not check if the file exists only if the path is valid
+ * @public exported from `@promptbook/utils`
  */
 function isValidFilePath(filePath) {
     if (typeof filePath !== 'string') {
@@ -4118,6 +4262,7 @@ var personaCommandParser = {
  *
  * @param {string} str - The string to remove Markdown tags from.
  * @returns {string} The input string with all Markdown tags removed.
+ * @public exported from `@promptbook/markdown-utils`
  */
 function removeMarkdownFormatting(str) {
     // Remove bold formatting
@@ -4129,6 +4274,15 @@ function removeMarkdownFormatting(str) {
     return str;
 }
 
+/**
+ * @@@
+ *
+ * @param text @@@
+ * @returns @@@
+ * @example 'HELLO_WORLD'
+ * @example 'I_LOVE_PROMPTBOOK'
+ * @public exported from `@promptbook/utils`
+ */
 function normalizeTo_SCREAMING_CASE(text) {
     var e_1, _a;
     var charType;
@@ -4296,7 +4450,7 @@ var EXPECTATION_UNITS = ['CHARACTERS', 'WORDS', 'SENTENCES', 'LINES', 'PARAGRAPH
  * @returns parsed number
  * @throws {ParsingError} if the value is not a number
  *
- * @private within the parseCommand
+ * @public exported from `@promptbook/utils`
  */
 function parseNumber(value) {
     var originalValue = value;
@@ -4352,6 +4506,7 @@ function parseNumber(value) {
 }
 /**
  * TODO: Maybe use sth. like safe-eval in fraction/calculation case @see https://www.npmjs.com/package/safe-eval
+ * TODO: [🧠][🌻] Maybe export through `@promptbook/markdown-utils` not `@promptbook/utils`
  */
 
 /**
@@ -4663,6 +4818,13 @@ var parameterCommandParser = {
     },
 };
 
+/**
+ * @@@
+ *
+ * @param javascriptName @@@
+ * @returns @@@
+ * @public exported from `@promptbook/utils`
+ */
 function isValidJavascriptName(javascriptName) {
     if (typeof javascriptName !== 'string') {
         return false;
@@ -5135,6 +5297,8 @@ function parseCommandVariant(input) {
 
 /**
  * This error type indicates that some part of the code is not implemented yet
+ *
+ * @public exported from `@promptbook/core`
  */
 var NotYetImplementedError = /** @class */ (function (_super) {
     __extends(NotYetImplementedError, _super);
@@ -5161,7 +5325,8 @@ var SUPPORTED_SCRIPT_LANGUAGES = ['javascript', 'typescript', 'python'];
  * Note: It can not work with html syntax and comments
  *
  * @param markdown any valid markdown
- * @returns
+ * @returns @@@
+ * @public exported from `@promptbook/markdown-utils`
  */
 function extractAllListItemsFromMarkdown(markdown) {
     var e_1, _a;
@@ -5201,7 +5366,7 @@ function extractAllListItemsFromMarkdown(markdown) {
  *
  * @param markdown any valid markdown
  * @returns code blocks with language and content
- *
+ * @public exported from `@promptbook/markdown-utils`
  */
 function extractAllBlocksFromMarkdown(markdown) {
     var e_1, _a;
@@ -5278,6 +5443,7 @@ function extractAllBlocksFromMarkdown(markdown) {
  *
  * @param markdown any valid markdown
  * @returns code block with language and content
+ * @public exported from `@promptbook/markdown-utils`
  */
 function extractOneBlockFromMarkdown(markdown) {
     var codeBlocks = extractAllBlocksFromMarkdown(markdown);
@@ -5292,6 +5458,8 @@ function extractOneBlockFromMarkdown(markdown) {
 
 /**
  * Parses markdown section to title its level and content
+ *
+ * @public exported from `@promptbook/markdown-utils`
  */
 function parseMarkdownSection(value) {
     var _a, _b;
@@ -5316,6 +5484,8 @@ function parseMarkdownSection(value) {
 
 /**
  * Splits the markdown into sections by headings
+ *
+ * @public exported from `@promptbook/markdown-utils`
  */
 function splitMarkdownIntoSections(markdown) {
     var e_1, _a;
@@ -5377,6 +5547,7 @@ function splitMarkdownIntoSections(markdown) {
     return sections;
 }
 /**
+ * TODO: [🏛] This can be part of markdown builder
  * Note: [🕞] In past (commit 42086e1603cbed506482997c00a8ee979af0a247) there was much more
  *       sophisticated implementation of this function through parsing markdown into JSON structure
  *       and flattening the actual structure
@@ -5388,6 +5559,8 @@ function splitMarkdownIntoSections(markdown) {
  *
  * - It always have h1 - if there is no h1 in the markdown, it will be added "# Untitled"
  * - All other headings are normalized to h2
+ *
+ * @public exported from `@promptbook/markdown-utils`
  */
 function flattenMarkdown(markdown) {
     var e_1, _a;
@@ -5423,6 +5596,7 @@ function flattenMarkdown(markdown) {
     return spaceTrim(flattenedMarkdown);
 }
 /**
+ * TODO: [🏛] This can be part of markdown builder
  * Note: [🕞] In past (commit 42086e1603cbed506482997c00a8ee979af0a247) there was much more
  *       sophisticated implementation of this function through parsing markdown into JSON structure
  *       and flattening the actual structure
@@ -5434,6 +5608,7 @@ function flattenMarkdown(markdown) {
  *
  * @param {string} content - The string to remove comments from.
  * @returns {string} The input string with all comments removed.
+ * @public exported from `@promptbook/markdown-utils`
  */
 function removeContentComments(content) {
     return spaceTrim$1(content.replace(/<!--(.*?)-->/gs, ''));
@@ -5447,12 +5622,13 @@ function removeContentComments(content) {
  * - `pipelineStringToJsonSync` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
  * - `preparePipeline` - just one step in the compilation process
  *
+ * Note: This function does not validate logic of the pipeline only the syntax
+ * Note: This function acts as compilation process
+ *
  * @param pipelineString {Promptbook} in string markdown format (.ptbk.md)
  * @returns {Promptbook} compiled in JSON format (.ptbk.json)
  * @throws {ParsingError} if the promptbook string is not valid
- *
- * Note: This function does not validate logic of the pipeline only the syntax
- * Note: This function acts as compilation process
+ * @public exported from `@promptbook/core`
  */
 function pipelineStringToJsonSync(pipelineString) {
     var e_1, _a, e_2, _b;
@@ -5845,13 +6021,14 @@ function pipelineStringToJsonSync(pipelineString) {
  * - `pipelineStringToJsonSync` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
  * - `preparePipeline` - just one step in the compilation process
  *
+ * Note: This function does not validate logic of the pipeline only the syntax
+ * Note: This function acts as compilation process
+ *
  * @param pipelineString {Promptbook} in string markdown format (.ptbk.md)
  * @param options - Options and tools for the compilation
  * @returns {Promptbook} compiled in JSON format (.ptbk.json)
  * @throws {ParsingError} if the promptbook string is not valid
- *
- * Note: This function does not validate logic of the pipeline only the syntax
- * Note: This function acts as compilation process
+ * @public exported from `@promptbook/core`
  */
 function pipelineStringToJson(pipelineString, options) {
     if (options === void 0) { options = { llmTools: null }; }
@@ -5880,7 +6057,7 @@ function pipelineStringToJson(pipelineString, options) {
 /**
  * Add or modify an auto-generated section in a markdown file
  *
- * @private within the repository
+ * @public exported from `@promptbook/markdown-utils`
  */
 function addAutoGeneratedSection(content, options) {
     var sectionName = options.sectionName, sectionContent = options.sectionContent;
@@ -5900,7 +6077,20 @@ function addAutoGeneratedSection(content, options) {
     var _a = __read(placeForSection, 1), heading = _a[0];
     return content.replace(heading, "<!--".concat(sectionName, "-->\n").concat(warningLine, "\n").concat(sectionContent, "\n<!--/").concat(sectionName, "-->\n\n").concat(heading));
 }
+/**
+ * TODO: [🏛] This can be part of markdown builder
+ */
 
+/**
+ * @@@
+ *
+ * @param text @@@
+ * @param _isFirstLetterCapital @@@
+ * @returns @@@
+ * @example 'helloWorld'
+ * @example 'iLovePromptbook'
+ * @public exported from `@promptbook/utils`
+ */
 function normalizeTo_camelCase(text, _isFirstLetterCapital) {
     var e_1, _a;
     if (_isFirstLetterCapital === void 0) { _isFirstLetterCapital = false; }
@@ -5959,6 +6149,8 @@ function normalizeTo_camelCase(text, _isFirstLetterCapital) {
  * Creates a Mermaid graph based on the promptbook
  *
  * Note: The result is not wrapped in a Markdown code block
+ *
+ * @public exported from `@promptbook/utils`
  */
 function renderPromptbookMermaid(pipelineJson, options) {
     var _a = (options || {}).linkPromptTemplate, linkPromptTemplate = _a === void 0 ? function () { return null; } : _a;
@@ -6015,6 +6207,8 @@ function renderPromptbookMermaid(pipelineJson, options) {
 
 /**
  * Prettyfies Promptbook string and adds Mermaid graph
+ *
+ * @public exported from `@promptbook/core`
  */
 function prettifyPipelineString(pipelineString, options) {
     return __awaiter(this, void 0, void 0, function () {
@@ -6057,6 +6251,8 @@ function prettifyPipelineString(pipelineString, options) {
  *
  * Note: [0] It can be used for more JSON types like whole collection of pipelines, single knowledge piece, etc.
  * Note: In contrast to JSON.stringify, this function ensures that **embedding index** is on single line
+ *
+ * @public exported from `@promptbook/core`
  */
 function stringifyPipelineJson(pipeline) {
     var pipelineJsonStringified = JSON.stringify(pipeline, null, 4);
@@ -6076,6 +6272,8 @@ function stringifyPipelineJson(pipeline) {
 
 /**
  * This error indicates that the pipeline collection cannot be propperly loaded
+ *
+ * @public exported from `@promptbook/core`
  */
 var CollectionError = /** @class */ (function (_super) {
     __extends(CollectionError, _super);
@@ -6088,8 +6286,26 @@ var CollectionError = /** @class */ (function (_super) {
     return CollectionError;
 }(Error));
 
+/**
+ * This error type indicates that you try to use a feature that is not available in the current environment
+ *
+ * @public exported from `@promptbook/core`
+ */
+var EnvironmentMismatchError = /** @class */ (function (_super) {
+    __extends(EnvironmentMismatchError, _super);
+    function EnvironmentMismatchError(message) {
+        var _this = _super.call(this, message) || this;
+        _this.name = 'EnvironmentMismatchError';
+        Object.setPrototypeOf(_this, EnvironmentMismatchError.prototype);
+        return _this;
+    }
+    return EnvironmentMismatchError;
+}(Error));
+
 /**
  * This error type indicates that the version of the pipeline is not matching the expected version
+ *
+ * @public exported from `@promptbook/core`
  */
 var VersionMismatchError = /** @class */ (function (_super) {
     __extends(VersionMismatchError, _super);
@@ -6104,6 +6320,8 @@ var VersionMismatchError = /** @class */ (function (_super) {
 
 /**
  * Pretty print an embedding vector for logging
+ *
+ * @public exported from `@promptbook/core`
  */
 function embeddingVectorToString(embeddingVector) {
     var vectorLength = Math.pow(embeddingVector.reduce(function (acc, val) { return acc + Math.pow(val, 2); }, 0), 0.5);
@@ -6116,6 +6334,8 @@ function embeddingVectorToString(embeddingVector) {
  * Note: This is an estimate based of theese sources:
  * - https://jecas.cz/doba-cteni
  * - https://www.originalnitonery.cz/blog/psani-vsemi-deseti-se-muzete-naucit-i-sami-doma
+ *
+ * @public exported from `@promptbook/core`
  */
 function usageToWorktime(usage) {
     var value = usage.input.wordsCount.value / (200 /* words per minute */ * 60) +
@@ -6130,6 +6350,8 @@ function usageToWorktime(usage) {
 
 /**
  * Function `usageToHuman` will take usage and convert it to human readable report
+ *
+ * @public exported from `@promptbook/core`
  */
 function usageToHuman(usage) {
     var report = 'Usage:';
@@ -6154,6 +6376,8 @@ function usageToHuman(usage) {
 /**
  * Delagates the user interaction to a async callback function
  * You need to provide your own implementation of this callback function and its bind to UI.
+ *
+ * @public exported from `@promptbook/core`
  */
 var CallbackInterfaceTools = /** @class */ (function () {
     function CallbackInterfaceTools(options) {
@@ -6186,6 +6410,8 @@ var CallbackInterfaceTools = /** @class */ (function () {
  *
  * Warning: It is used for testing and mocking
  *          **NOT intended to use in the production** due to its synchronous nature.
+ *
+ * @public exported from `@promptbook/core`
  */
 var SimplePromptInterfaceTools = /** @class */ (function () {
     function SimplePromptInterfaceTools(options) {
@@ -6217,12 +6443,260 @@ var SimplePromptInterfaceTools = /** @class */ (function () {
  */
 
 /**
- * Default options for generating an execution report string
+ * Stores
+ *
+ * @public exported from `@promptbook/core`
  */
-var ExecutionReportStringOptionsDefaults = {
-    taxRate: 0,
-    chartsWidth: 36,
-};
+var MemoryStorage = /** @class */ (function () {
+    function MemoryStorage() {
+        this.storage = {};
+    }
+    Object.defineProperty(MemoryStorage.prototype, "length", {
+        /**
+         * Returns the number of key/value pairs currently present in the list associated with the object.
+         */
+        get: function () {
+            return Object.keys(this.storage).length;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * Empties the list associated with the object of all key/value pairs, if there are any.
+     */
+    MemoryStorage.prototype.clear = function () {
+        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.
+     */
+    MemoryStorage.prototype.getItem = function (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.
+     */
+    MemoryStorage.prototype.key = function (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.
+     */
+    MemoryStorage.prototype.setItem = function (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.
+     */
+    MemoryStorage.prototype.removeItem = function (key) {
+        delete this.storage[key];
+    };
+    return MemoryStorage;
+}());
+
+/**
+ * Simple wrapper `new Date().toISOString()`
+ *
+ * @returns string_date branded type
+ * @public exported from `@promptbook/utils`
+ */
+function $currentDate() {
+    return new Date().toISOString();
+}
+
+/**
+ * Intercepts LLM tools and counts total usage of the tools
+ *
+ * Note: It can take extended `LlmExecutionTools` and cache the
+ *
+ * @param llmTools LLM tools to be intercepted with usage counting, it can contain extra methods like `totalUsage`
+ * @returns LLM tools with same functionality with added total cost counting
+ * @public exported from `@promptbook/core`
+ */
+function cacheLlmTools(llmTools, options) {
+    var _this = this;
+    if (options === void 0) { options = {}; }
+    var _a = options.storage, storage = _a === void 0 ? new MemoryStorage() : _a, _b = options.isReloaded, isReloaded = _b === void 0 ? false : _b;
+    var proxyTools = __assign(__assign({}, llmTools), { 
+        // <- Note: [🥫]
+        get title() {
+            // TODO: [🧠] Maybe put here some suffix
+            return llmTools.title;
+        },
+        get description() {
+            // TODO: [🧠] Maybe put here some suffix
+            return llmTools.description;
+        }, listModels: function () {
+            // TODO: [🧠] Should be model listing also cached?
+            return /* not await */ llmTools.listModels();
+        } });
+    var callCommonModel = function (prompt) { return __awaiter(_this, void 0, void 0, function () {
+        var key, cacheItem, _a, promptResult, _b;
+        return __generator(this, function (_c) {
+            switch (_c.label) {
+                case 0:
+                    key = titleToName(prompt.title.substring(0, MAX_FILENAME_LENGTH - 10) +
+                        '-' +
+                        sha256(hexEncoder.parse(JSON.stringify(prompt.parameters))).toString( /* hex */));
+                    if (!!isReloaded) return [3 /*break*/, 2];
+                    return [4 /*yield*/, storage.getItem(key)];
+                case 1:
+                    _a = _c.sent();
+                    return [3 /*break*/, 3];
+                case 2:
+                    _a = null;
+                    _c.label = 3;
+                case 3:
+                    cacheItem = _a;
+                    if (cacheItem) {
+                        return [2 /*return*/, cacheItem.promptResult];
+                    }
+                    _b = prompt.modelRequirements.modelVariant;
+                    switch (_b) {
+                        case 'CHAT': return [3 /*break*/, 4];
+                        case 'COMPLETION': return [3 /*break*/, 6];
+                        case 'EMBEDDING': return [3 /*break*/, 8];
+                    }
+                    return [3 /*break*/, 10];
+                case 4: return [4 /*yield*/, llmTools.callChatModel(prompt)];
+                case 5:
+                    promptResult = _c.sent();
+                    return [3 /*break*/, 11];
+                case 6: return [4 /*yield*/, llmTools.callCompletionModel(prompt)];
+                case 7:
+                    promptResult = _c.sent();
+                    return [3 /*break*/, 11];
+                case 8: return [4 /*yield*/, llmTools.callEmbeddingModel(prompt)];
+                case 9:
+                    promptResult = _c.sent();
+                    return [3 /*break*/, 11];
+                case 10: throw new PipelineExecutionError("Unknown model variant \"".concat(prompt.modelRequirements.modelVariant, "\""));
+                case 11: return [4 /*yield*/, storage.setItem(key, {
+                        date: $currentDate(),
+                        promptbookVersion: PROMPTBOOK_VERSION,
+                        prompt: prompt,
+                        promptResult: promptResult,
+                    })];
+                case 12:
+                    _c.sent();
+                    return [2 /*return*/, promptResult];
+            }
+        });
+    }); };
+    if (llmTools.callChatModel !== undefined) {
+        proxyTools.callChatModel = function (prompt) { return __awaiter(_this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, /* not await */ callCommonModel(prompt)];
+            });
+        }); };
+    }
+    if (llmTools.callCompletionModel !== undefined) {
+        proxyTools.callCompletionModel = function (prompt) { return __awaiter(_this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, /* not await */ callCommonModel(prompt)];
+            });
+        }); };
+    }
+    if (llmTools.callEmbeddingModel !== undefined) {
+        proxyTools.callEmbeddingModel = function (prompt) { return __awaiter(_this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, /* not await */ callCommonModel(prompt)];
+            });
+        }); };
+    }
+    // <- Note: [🤖]
+    return proxyTools;
+}
+/**
+ * TODO: [🧠][💸] Maybe make some common abstraction `interceptLlmTools` and use here (or use javascript Proxy?)
+ * TODO: [🧠] Is there some meaningfull way how to test this util
+ * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
+ *            @@@ write discussion about this and storages
+ *            @@@ write how to combine multiple interceptors
+ */
+
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+function limitTotalUsage(llmTools, options) {
+    var _this = this;
+    if (options === void 0) { options = {}; }
+    var _a = options.maxTotalUsage, maxTotalUsage = _a === void 0 ? ZERO_USAGE : _a, _b = options.storage, storage = _b === void 0 ? new MemoryStorage() : _b;
+    TODO_USE(storage);
+    var proxyTools = countTotalUsage(llmTools);
+    if (maxTotalUsage.price.value !== 0) {
+        throw new NotYetImplementedError('`limitTotalUsage` is not yet implemented for non-zero price');
+        // TODO: "Cannot call `callChatModel` because the total cost limit is reached"
+    }
+    if (proxyTools.callChatModel !== undefined) {
+        proxyTools.callChatModel = function (prompt) { return __awaiter(_this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                TODO_USE(prompt);
+                throw new LimitReachedError('Cannot call `callChatModel` because you are not allowed to spend any cost');
+            });
+        }); };
+    }
+    if (proxyTools.callCompletionModel !== undefined) {
+        proxyTools.callCompletionModel = function (prompt) { return __awaiter(_this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                TODO_USE(prompt);
+                throw new LimitReachedError('Cannot call `callCompletionModel` because you are not allowed to spend any cost');
+            });
+        }); };
+    }
+    if (proxyTools.callEmbeddingModel !== undefined) {
+        proxyTools.callEmbeddingModel = function (prompt) { return __awaiter(_this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                TODO_USE(prompt);
+                throw new LimitReachedError('Cannot call `callEmbeddingModel` because you are not allowed to spend any cost');
+            });
+        }); };
+    }
+    // <- Note: [🤖]
+    return proxyTools;
+}
+/**
+ * TODO: Maybe internally use `countTotalUsage`
+ * TODO: [🧠][💸] Maybe make some common abstraction `interceptLlmTools` and use here (or use javascript Proxy?)
+ * TODO: [🧠] Is there some meaningfull way how to test this util
+ * TODO: [🧠][🌯] Maybe a way how to hide ability to `get totalUsage`
+ * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
+ */
+
+/**
+ * This class behaves like LocalStorage but separates keys by prefix
+ *
+ * @public exported from `@promptbook/core`
+ */
+var PrefixStorage = /** @class */ (function () {
+    function PrefixStorage(baseStorage, keyPrefix, separator) {
+        if (separator === void 0) { separator = '_'; }
+        this.baseStorage = baseStorage;
+        this.keyPrefix = keyPrefix;
+        this.separator = separator;
+    }
+    /**
+     * 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.
+     */
+    PrefixStorage.prototype.getItem = function (key) {
+        return this.baseStorage.getItem(this.keyPrefix + this.separator + key);
+    };
+    /**
+     * Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.
+     */
+    PrefixStorage.prototype.setItem = function (key, value) {
+        return this.baseStorage.setItem(this.keyPrefix + this.separator + 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.
+     */
+    PrefixStorage.prototype.removeItem = function (key) {
+        this.baseStorage.removeItem(this.keyPrefix + this.separator + key);
+    };
+    return PrefixStorage;
+}());
 
 /**
  * Format either small or big number
@@ -6247,7 +6721,7 @@ function formatNumber(value) {
 /**
  * Create a markdown table from a 2D array of strings
  *
- * @private within the repository
+ * @public exported from `@promptbook/markdown-utils`
  */
 function createMarkdownTable(table) {
     var columnWidths = table.reduce(function (widths, row) {
@@ -6271,11 +6745,14 @@ function createMarkdownTable(table) {
     });
     return __spreadArray([header, separator], __read(rows), false).join('\n');
 }
+/**
+ * TODO: [🏛] This can be part of markdown builder
+ */
 
 /**
  * Function createMarkdownChart will draw a chart in markdown from ⬛+🟦 tiles
  *
- * @private within the repository
+ * @public exported from `@promptbook/markdown-utils`
  */
 function createMarkdownChart(options) {
     var e_1, _a;
@@ -6311,10 +6788,25 @@ function createMarkdownChart(options) {
 /**
  * Function escapeMarkdownBlock will escape markdown block if needed
  * It is useful when you want have block in block
+ *
+ * @public exported from `@promptbook/markdown-utils`
  */
 function escapeMarkdownBlock(value) {
     return value.replace(/```/g, '\\`\\`\\`');
 }
+/**
+ * TODO: [🏛] This can be part of markdown builder
+ */
+
+/**
+ * Default options for generating an execution report string
+ *
+ * @public exported from `@promptbook/core`
+ */
+var ExecutionReportStringOptionsDefaults = {
+    taxRate: 0,
+    chartsWidth: 36,
+};
 
 /**
  * The thresholds for the relative time in the `moment` NPM package.
@@ -6360,6 +6852,8 @@ function countWorkingDuration(items) {
 
 /**
  * Converts execution report from JSON to string format
+ *
+ * @public exported from `@promptbook/core`
  */
 function executionReportJsonToString(executionReportJson, options) {
     var e_1, _a;
@@ -6529,5 +7023,5 @@ function executionReportJsonToString(executionReportJson, options) {
  * TODO: [🧠] Allow to filter out some parts of the report by options
  */
 
-export { BlockTypes, CallbackInterfaceTools, CollectionError, ExecutionReportStringOptionsDefaults, ExpectError, NotFoundError, PROMPTBOOK_VERSION, ParsingError, PipelineExecutionError, PipelineLogicError, RESERVED_PARAMETER_NAMES, ReferenceError$1 as ReferenceError, SimplePromptInterfaceTools, UnexpectedError, VersionMismatchError, addUsage, assertsExecutionSuccessful, checkExpectations, collectionToJson, createCollectionFromJson, createCollectionFromPromise, createCollectionFromUrl, createPipelineExecutor, createSubcollection, embeddingVectorToString, executionReportJsonToString, isPassingExpectations, joinLlmExecutionTools, pipelineJsonToString, pipelineStringToJson, pipelineStringToJsonSync, prepareKnowledgeFromMarkdown, preparePipeline, prettifyPipelineString, stringifyPipelineJson, unpreparePipeline, usageToHuman, usageToWorktime, validatePipeline };
+export { BlockTypes, CallbackInterfaceTools, CollectionError, EXECUTIONS_CACHE_DIRNAME, EnvironmentMismatchError, ExecutionReportStringOptionsDefaults, LimitReachedError, MAX_EXECUTION_ATTEMPTS, MAX_FILENAME_LENGTH, MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH, MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL, MAX_PARALLEL_COUNT, MemoryStorage, NotFoundError, NotYetImplementedError, PIPELINE_COLLECTION_BASE_FILENAME, PROMPTBOOK_VERSION, ParsingError, PipelineExecutionError, PipelineLogicError, PrefixStorage, RESERVED_PARAMETER_NAMES, ReferenceError$1 as ReferenceError, SimplePromptInterfaceTools, UnexpectedError, VersionMismatchError, ZERO_USAGE, addUsage, assertsExecutionSuccessful, cacheLlmTools, checkExpectations, collectionToJson, countTotalUsage, createCollectionFromJson, createCollectionFromPromise, createCollectionFromUrl, createPipelineExecutor, createSubcollection, embeddingVectorToString, executionReportJsonToString, isPassingExpectations, isPipelinePrepared, joinLlmExecutionTools, limitTotalUsage, pipelineJsonToString, pipelineStringToJson, pipelineStringToJsonSync, prepareKnowledgeFromMarkdown, prepareKnowledgePieces, preparePersona, preparePipeline, prepareTemplates, prettifyPipelineString, stringifyPipelineJson, unpreparePipeline, usageToHuman, usageToWorktime, validatePipeline };
 //# sourceMappingURL=index.es.js.map