@promptbook/cli 0.62.1 → 0.63.0-0

package/esm/index.es.js

@@ -13,6 +13,14 @@ import Anthropic from '@anthropic-ai/sdk';
 import OpenAI from 'openai';
 import glob from 'glob-promise';
 
+/**
+ * The version of the Promptbook library
+ *
+ * @public exported from all packages
+ */
+var PROMPTBOOK_VERSION = '0.62.0';
+// TODO: !!!! List here all the versions and annotate + put into script
+
 /*! *****************************************************************************
 Copyright (c) Microsoft Corporation.
 
@@ -134,25 +142,22 @@ function __spreadArray(to, from, pack) {
 
 /**
  * Detects if the code is running in a browser environment in main thread (Not in a web worker)
+ *
+ * @public exported from `@promptbook/utils`
  */
 new Function("\n    try {\n        return this === window;\n    } catch (e) {\n        return false;\n    }\n");
 /**
  * Detects if the code is running in a Node.js environment
+ *
+ * @public exported from `@promptbook/utils`
  */
 var isRunningInNode = new Function("\n    try {\n        return this === global;\n    } catch (e) {\n        return false;\n    }\n");
 /**
  * Detects if the code is running in a web worker
+ *
+ * @public exported from `@promptbook/utils`
  */
 new Function("\n    try {\n        if (typeof WorkerGlobalScope !== 'undefined' && self instanceof WorkerGlobalScope) {\n            return true;\n        } else {\n            return false;\n        }\n    } catch (e) {\n        return false;\n    }\n");
-/**
- * TODO: [🔼] !!! Export via `@promptbook/utils`
- */
-
-/**
- * The version of the Promptbook library
- */
-var PROMPTBOOK_VERSION = '0.62.0';
-// TODO: !!!! List here all the versions and annotate + put into script
 
 /**
  * Initializes testing `hello` command for Promptbook CLI utilities
@@ -191,6 +196,8 @@ function initializeHelloCommand(program) {
  * 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 () {
@@ -245,6 +252,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
  */
@@ -252,32 +260,43 @@ function deepFreezeWithSameType(objectValue) {
     return deepFreeze(objectValue);
 }
 /**
- * TODO: [🔼] Export from `@promptbook/utils`
  * TODO: [🧠] Is there a way how to meaningfully test this utility
  */
 
 /**
  * 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;
 /**
  * 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";
 /**
@@ -286,6 +305,8 @@ var PIPELINE_COLLECTION_BASE_FILENAME = "index";
 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',
@@ -299,10 +320,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;
 /*
@@ -310,7 +335,7 @@ TODO: !!! Just testing false-negative detection of [🟡][🟢][🔵][⚪] leak
 */
 // [🟡][🟢][🔵][⚪]
 /**
- * TODO: [🔼] Export all to core
+ * TODO: !!!!!! Check that all @private contains some normalized explanation
  */
 
 /**
@@ -350,6 +375,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);
@@ -360,6 +386,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;
@@ -559,6 +586,8 @@ function promptTemplateParameterJsonToString(promptTemplateParameterJson) {
 
 /**
  * @@@
+ *
+ * @public exported from `@promptbook/utils`
  */
 function deepClone(objectValue) {
     return JSON.parse(JSON.stringify(objectValue));
@@ -575,14 +604,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 },
@@ -609,6 +637,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 = [];
@@ -681,6 +711,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 () {
@@ -753,6 +784,8 @@ var PipelineCollection = [{title:"Prepare Knowledge from Markdown",pipelineUrl:"
 
 /**
  * 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);
@@ -767,6 +800,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);
@@ -781,6 +816,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);
@@ -799,6 +836,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') {
@@ -819,6 +858,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)) {
@@ -837,6 +878,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' ||
@@ -871,6 +914,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') {
@@ -886,6 +930,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') {
@@ -912,6 +958,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)) {
@@ -949,6 +997,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
@@ -1178,6 +1227,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);
@@ -1192,6 +1243,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);
@@ -1209,6 +1262,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;
@@ -1233,6 +1287,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;
@@ -1249,7 +1305,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
@@ -1351,6 +1406,7 @@ var SimplePipelineCollection = /** @class */ (function () {
  *
  * @param promptbookSources
  * @returns PipelineCollection
+ * @public exported from `@promptbook/core`
  */
 function createCollectionFromJson() {
     var promptbooks = [];
@@ -1576,6 +1632,8 @@ var defaultDiacriticsRemovalMap = [
  * > "ě" => "e"
  * > "Ă" => "A"
  * > ...
+ *
+ * @public exported from `@promptbook/utils`
  */
 var DIACRITIC_VARIANTS_LETTERS = {};
 // tslint:disable-next-line: prefer-for-of
@@ -1603,7 +1661,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"*/
@@ -1611,7 +1673,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);
@@ -1671,6 +1745,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
@@ -1682,7 +1757,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://')) {
@@ -1701,6 +1781,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);
@@ -1718,6 +1800,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;
@@ -1748,6 +1831,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();
@@ -1796,6 +1880,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;
@@ -1869,6 +1954,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 {
@@ -2095,6 +2182,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 = [];
@@ -2134,6 +2223,8 @@ function joinLlmExecutionTools() {
 
 /**
  * Determine if the pipeline is fully prepared
+ *
+ * @public exported from `@promptbook/core`
  */
 function isPipelinePrepared(pipeline) {
     // Note: Ignoring `pipeline.preparations` @@@
@@ -2154,7 +2245,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
@@ -2200,6 +2290,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);
@@ -2219,6 +2311,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;
@@ -2294,6 +2387,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;
@@ -2327,6 +2421,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;
@@ -2365,6 +2460,8 @@ function union() {
 
 /**
  * Counts number of characters in the text
+ *
+ * @public exported from `@promptbook/utils`
  */
 function countCharacters(text) {
     // Remove null characters
@@ -2378,6 +2475,8 @@ function countCharacters(text) {
 
 /**
  * Counts number of lines in the text
+ *
+ * @public exported from `@promptbook/utils`
  */
 function countLines(text) {
     if (text === '') {
@@ -2388,6 +2487,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
@@ -2398,6 +2499,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;
@@ -2405,12 +2508,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;
@@ -2418,6 +2525,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');
@@ -2427,6 +2536,8 @@ function countWords(text) {
 
 /**
  * Index of all counter functions
+ *
+ * @public exported from `@promptbook/utils`
  */
 var CountUtils = {
     CHARACTERS: countCharacters,
@@ -2446,6 +2557,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;
@@ -2478,6 +2590,7 @@ function checkExpectations(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;
@@ -3266,6 +3379,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 () {
@@ -3401,6 +3516,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 () {
@@ -3415,7 +3531,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();
@@ -3453,7 +3569,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,_]]
@@ -3467,6 +3582,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;
@@ -3534,7 +3650,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`
@@ -3546,6 +3661,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 () {
@@ -3600,7 +3716,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
@@ -3608,6 +3723,8 @@ function preparePersona(personaDescription, options) {
 
 /**
  * @@@
+ *
+ * @public exported from `@promptbook/core`
  */
 function prepareTemplates(pipeline, options) {
     return __awaiter(this, void 0, void 0, function () {
@@ -3649,7 +3766,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
@@ -3662,6 +3778,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 () {
@@ -3738,7 +3855,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
@@ -3749,6 +3865,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') {
@@ -3931,6 +4048,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
@@ -3942,6 +4060,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;
@@ -4007,6 +4134,7 @@ function normalizeTo_SCREAMING_CASE(text) {
  * 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',
@@ -4126,7 +4254,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;
@@ -4182,6 +4310,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`
  */
 
 /**
@@ -4493,6 +4622,13 @@ var parameterCommandParser = {
     },
 };
 
+/**
+ * @@@
+ *
+ * @param javascriptName @@@
+ * @returns @@@
+ * @public exported from `@promptbook/utils`
+ */
 function isValidJavascriptName(javascriptName) {
     if (typeof javascriptName !== 'string') {
         return false;
@@ -4965,6 +5101,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);
@@ -4991,7 +5129,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;
@@ -5031,7 +5170,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;
@@ -5108,6 +5247,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);
@@ -5122,6 +5262,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;
@@ -5146,6 +5288,8 @@ function parseMarkdownSection(value) {
 
 /**
  * Splits the markdown into sections by headings
+ *
+ * @public exported from `@promptbook/markdown-utils`
  */
 function splitMarkdownIntoSections(markdown) {
     var e_1, _a;
@@ -5207,6 +5351,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
@@ -5218,6 +5363,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;
@@ -5253,6 +5400,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
@@ -5264,6 +5412,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, ''));
@@ -5277,12 +5426,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;
@@ -5675,13 +5825,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 }; }
@@ -5709,6 +5860,8 @@ function pipelineStringToJson(pipelineString, options) {
 
 /**
  * This error indicates that the pipeline collection cannot be propperly loaded
+ *
+ * @public exported from `@promptbook/core`
  */
 var CollectionError = /** @class */ (function (_super) {
     __extends(CollectionError, _super);
@@ -5739,6 +5892,7 @@ var CollectionError = /** @class */ (function (_super) {
  * @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;
@@ -5815,6 +5969,7 @@ function createCollectionFromPromise(promptbookSourcesPromiseOrFactory) {
  * @param path - path to the directory with pipelines
  * @param options - Misc options for the collection
  * @returns PipelineCollection
+ * @public exported from `@promptbook/node`
  */
 function createCollectionFromDirectory(path, options) {
     return __awaiter(this, void 0, void 0, function () {
@@ -6062,6 +6217,8 @@ function listAllFiles(path, isRecursive) {
  *
  * 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);
@@ -6085,6 +6242,8 @@ function stringifyPipelineJson(pipeline) {
  * 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) +
@@ -6099,6 +6258,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:';
@@ -6122,6 +6283,8 @@ function usageToHuman(usage) {
 
 /**
  * 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);
@@ -6145,6 +6308,8 @@ function nameToSubfolderPath(name) {
 
 /**
  * @@@
+ *
+ * @public exported from `@promptbook/node`
  */
 var FilesStorage = /** @class */ (function () {
     function FilesStorage(options) {
@@ -6234,7 +6399,6 @@ var FilesStorage = /** @class */ (function () {
     return FilesStorage;
 }());
 /**
- * TODO: [🔼] !!! Export via `@promptbook/node`
  * TODO: [🌗] Maybe some checkers, not all valid JSONs are desired and valid values
  * Note: [🟢] This code should never be published outside of `@promptbook/node`
  */
@@ -6365,6 +6529,8 @@ var ANTHROPIC_CLAUDE_MODELS = [
 
 /**
  * Execution Tools for calling Anthropic Claude API.
+ *
+ * @public exported from `@promptbook/anthropic-claude`
  */
 var AnthropicClaudeExecutionTools = /** @class */ (function () {
     /**
@@ -6590,6 +6756,7 @@ var AnthropicClaudeExecutionTools = /** @class */ (function () {
  *
  * @see https://platform.openai.com/docs/models/
  * @see https://openai.com/api/pricing/
+ * @public exported from `@promptbook/openai`
  */
 var OPENAI_MODELS = [
     /*/
@@ -6970,6 +7137,8 @@ resultContent, rawResponse) {
 
 /**
  * Execution Tools for calling OpenAI API.
+ *
+ * @public exported from `@promptbook/openai`
  */
 var OpenAiExecutionTools = /** @class */ (function () {
     /**
@@ -7281,6 +7450,7 @@ var OpenAiExecutionTools = /** @class */ (function () {
  * - `process.env.ANTHROPIC_CLAUDE_API_KEY`
  *
  * @returns @@@
+ * @public exported from `@promptbook/node`
  */
 function createLlmToolsFromEnv(options) {
     if (options === void 0) { options = {}; }
@@ -7314,7 +7484,6 @@ function createLlmToolsFromEnv(options) {
 }
 /**
  * TODO: [🍜] Use `createLlmToolsFromConfiguration`
- * TODO: [🔼] !!! Export via `@promptbook/node`
  * TODO: @@@ write discussion about this - wizzard
  * TODO: Add Azure
  * TODO: [🧠] Which name is better `createLlmToolsFromEnv` or `createLlmToolsFromEnvironment`?
@@ -7326,6 +7495,8 @@ function createLlmToolsFromEnv(options) {
 
 /**
  * Stores
+ *
+ * @public exported from `@promptbook/core`
  */
 var MemoryStorage = /** @class */ (function () {
     function MemoryStorage() {
@@ -7373,14 +7544,12 @@ var MemoryStorage = /** @class */ (function () {
     };
     return MemoryStorage;
 }());
-/**
- * TODO: [🔼] !!! Export via `@promptbook/core`
- */
 
 /**
  * Simple wrapper `new Date().toISOString()`
  *
  * @returns string_date branded type
+ * @public exported from `@promptbook/utils`
  */
 function $currentDate() {
     return new Date().toISOString();
@@ -7393,6 +7562,7 @@ function $currentDate() {
  *
  * @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;
@@ -7489,7 +7659,6 @@ function cacheLlmTools(llmTools, options) {
     return proxyTools;
 }
 /**
- * TODO: [🔼] !!! Export via `@promptbook/core`
  * 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
@@ -7690,7 +7859,7 @@ function initializeMakeCommand(program) {
 /**
  * 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;
@@ -7710,7 +7879,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; }
@@ -7769,6 +7951,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;
@@ -7825,6 +8009,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 () {
@@ -7978,14 +8164,18 @@ function promptbookCli() {
  * Note: [🟡] This code should never be published outside of `@promptbook/cli`
  */
 
-// @promptbook/cli
 /**
  * Hidden utilities which should not be used by external consumers.
+ *
+ * @public exported from `@promptbook/cli`
  */
 var __CLI = {
     // Note: [🥠]
     __initialize: promptbookCli,
 };
+/**
+ * Note: [🟡] This code should never be published outside of `@promptbook/cli`
+ */
 
 export { PROMPTBOOK_VERSION, __CLI };
 //# sourceMappingURL=index.es.js.map