npm - @promptbook/node - Versions diffs - 0.63.0-0 → 0.63.0-10 - Mend

@promptbook/node 0.63.0-0 → 0.63.0-10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (493) hide show

package/README.md CHANGED Viewed

@@ -1,3 +1,5 @@
+<!-- ⚠️ WARNING: This code has been generated so that any manual changes will be overwritten -->
 # ![Promptbook logo - cube with letters P and B](./other/design/logo-h1.png) Promptbook
 Supercharge your use of large language models
@@ -314,11 +316,11 @@ Or you can install them separately:
 > ⭐ Marked packages are worth to try first
 -   ⭐ **[ptbk](https://www.npmjs.com/package/ptbk)** - Bundle of all packages, when you want to install everything and you don't care about the size
 -   **[promptbook](https://www.npmjs.com/package/promptbook)** - Same as `ptbk`
 -   **[@promptbook/core](https://www.npmjs.com/package/@promptbook/core)** - Core of the library, it contains the main logic for promptbooks
--   **[@promptbook/node](https://www.npmjs.com/package/@promptbook/node)** - Core of the library for Node.js
+-   **[@promptbook/node](https://www.npmjs.com/package/@promptbook/node)** - Core of the library for Node.js environment
+-   **[@promptbook/browser](https://www.npmjs.com/package/@promptbook/browser)** - Core of the library for browser environment
 -   ⭐ **[@promptbook/utils](https://www.npmjs.com/package/@promptbook/utils)** - Utility functions used in the library but also useful for individual use in preprocessing and postprocessing LLM inputs and outputs
 -   **[@promptbook/markdown-utils](https://www.npmjs.com/package/@promptbook/markdown-utils)** - Utility functions used for processing markdown
 -   _(Not finished)_ **[@promptbook/wizzard](https://www.npmjs.com/package/@promptbook/wizzard)** - Wizard for creating+running promptbooks in single line

package/esm/index.es.js CHANGED Viewed

@@ -1,21 +1,21 @@
 import colors from 'colors';
-import { access, constants, readFile, readdir, stat, writeFile, mkdir, unlink } from 'fs/promises';
-import { join, dirname } from 'path';
+import { stat, access, constants, readdir, readFile, writeFile, mkdir, unlink } from 'fs/promises';
+import { join as join$1, dirname } from 'path';
 import spaceTrim, { spaceTrim as spaceTrim$1 } from 'spacetrim';
 import { format } from 'prettier';
 import parserHtml from 'prettier/parser-html';
+import { join } from 'path/posix';
 import * as dotenv from 'dotenv';
 import Anthropic from '@anthropic-ai/sdk';
 import OpenAI from 'openai';
 import hexEncoder from 'crypto-js/enc-hex';
 import sha256 from 'crypto-js/sha256';
+// ⚠️ WARNING: This code has been generated so that any manual changes will be overwritten
 /**
  * The version of the Promptbook library
- *
- * @public exported from all packages
  */
-var PROMPTBOOK_VERSION = '0.62.0';
+var PROMPTBOOK_VERSION = '0.63.0-9';
 // TODO: !!!! List here all the versions and annotate + put into script
 /*! *****************************************************************************
@@ -140,9 +140,10 @@ function __spreadArray(to, from, pack) {
 /**
  * @@@
  *
- * @returns The same object as the input, but deeply frozen
- *
  * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
+ *
+ * @returns The same object as the input, but deeply frozen
+ * @public exported from `@promptbook/utils`
  */
 function deepFreeze(objectValue) {
     var e_1, _a;
@@ -169,10 +170,10 @@ 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
+ *
+ * @returns The same object as the input, but deeply frozen
+ * @private this is in comparison to `deepFreeze` a more specific utility and maybe not very good practice to use without specific reason and considerations
  */
 function deepFreezeWithSameType(objectValue) {
     return deepFreeze(objectValue);
@@ -181,10 +182,11 @@ function deepFreezeWithSameType(objectValue) {
  * TODO: [🧠] Is there a way how to meaningfully test this utility
  */
+// <- TODO: [🧠] Better system for generator warnings - not always "code" and "by `@promptbook/cli`"
 /**
  * The maximum number of iterations for a loops
  *
- * @private within the repository - too low-level in comparison to other `MAX_...`
+ * @private within the repository - too low-level in comparison with other `MAX_...`
  */
 var LOOP_LIMIT = 1000;
 /**
@@ -213,6 +215,8 @@ var MAX_FILENAME_LENGTH = 30;
 var PIPELINE_COLLECTION_BASE_FILENAME = "index";
 /**
  * Nonce which is used for replacing things in strings
+ *
+ * @private within the repository
  */
 var REPLACING_NONCE = 'u$k42k%!V2zo34w7Fu#@QUHYPW';
 /**
@@ -242,13 +246,6 @@ var RESERVED_PARAMETER_MISSING_VALUE = 'MISSING-' + REPLACING_NONCE;
  * @private within the repository
  */
 var RESERVED_PARAMETER_RESTRICTED = 'RESTRICTED-' + REPLACING_NONCE;
-/*
-TODO: !!! Just testing false-negative detection of [🟡][🟢][🔵][⚪] leak
-*/
-// [🟡][🟢][🔵][⚪]
-/**
- * TODO: !!!!!! Check that all @private contains some normalized explanation
- */
 /**
  * Prettify the html code
@@ -368,7 +365,7 @@ function pipelineJsonToString(pipelineJson) {
             var contentLanguage = 'text';
             if (blockType === 'PROMPT_TEMPLATE') {
                 var modelRequirements = promptTemplate.modelRequirements;
-                var modelName = modelRequirements.modelName, modelVariant = modelRequirements.modelVariant;
+                var _l = modelRequirements || {}, modelName = _l.modelName, modelVariant = _l.modelVariant;
                 commands_1.push("EXECUTE PROMPT TEMPLATE");
                 if (modelVariant) {
                     commands_1.push("MODEL VARIANT ".concat(capitalize(modelVariant)));
@@ -426,8 +423,8 @@ function pipelineJsonToString(pipelineJson) {
             } /* not else */
             if (expectations) {
                 try {
-                    for (var _l = (e_6 = void 0, __values(Object.entries(expectations))), _m = _l.next(); !_m.done; _m = _l.next()) {
-                        var _o = __read(_m.value, 2), unit = _o[0], _p = _o[1], min = _p.min, max = _p.max;
+                    for (var _m = (e_6 = void 0, __values(Object.entries(expectations))), _o = _m.next(); !_o.done; _o = _m.next()) {
+                        var _p = __read(_o.value, 2), unit = _p[0], _q = _p[1], min = _q.min, max = _q.max;
                         if (min === max) {
                             commands_1.push("EXPECT EXACTLY ".concat(min, " ").concat(capitalize(unit + (min > 1 ? 's' : ''))));
                         }
@@ -444,7 +441,7 @@ function pipelineJsonToString(pipelineJson) {
                 catch (e_6_1) { e_6 = { error: e_6_1 }; }
                 finally {
                     try {
-                        if (_m && !_m.done && (_f = _l.return)) _f.call(_l);
+                        if (_o && !_o.done && (_f = _m.return)) _f.call(_m);
                     }
                     finally { if (e_6) throw e_6.error; }
                 }
@@ -479,7 +476,7 @@ function pipelineJsonToString(pipelineJson) {
     return pipelineString;
 }
 /**
- * @private internal util of pipelineJsonToString
+ * @private internal utility of `pipelineJsonToString`
  */
 function promptTemplateParameterJsonToString(promptTemplateParameterJson) {
     var name = promptTemplateParameterJson.name, description = promptTemplateParameterJson.description;
@@ -494,6 +491,7 @@ function promptTemplateParameterJsonToString(promptTemplateParameterJson) {
  * TODO: [🧠] Is there a way to auto-detect missing features in pipelineJsonToString
  * TODO: [🏛] Maybe make some markdown builder
  * TODO: [🏛] Escape all
+ * TODO: [🧠] Should be in generated .ptbk.md file GENERATOR_WARNING
  */
 /**
@@ -692,7 +690,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-9",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-9",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-9",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-9",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-9",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-9",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-9",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-9",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"}];
 /**
  * This error indicates that the promptbook in a markdown format cannot be parsed into a valid promptbook object
@@ -990,9 +988,6 @@ function validatePipeline(pipeline) {
             throw new PipelineLogicError(spaceTrim$1(function (block) { return "\n                        Parameter name {".concat(template.resultingParameterName, "} is reserved, please use different name\n\n                        ").concat(block(pipelineIdentification), "\n                    "); }));
         }
         definedParameters.add(template.resultingParameterName);
-        if (template.blockType === 'PROMPT_TEMPLATE' && template.modelRequirements.modelVariant === undefined) {
-            throw new PipelineLogicError(spaceTrim$1(function (block) { return "\n\n                        You must specify MODEL VARIANT in the prompt template \"".concat(template.title, "\"\n\n                        For example:\n                        - MODEL VARIANT Chat\n                        - MODEL NAME `gpt-4-1106-preview`").concat(/* <- TODO: Dynamic listing of command examples */ '', "\n\n                        ").concat(block(pipelineIdentification), "\n                    "); }));
-        }
         if (template.jokerParameterNames && template.jokerParameterNames.length > 0) {
             if (!template.expectFormat &&
                 !template.expectations /* <- TODO: Require at least 1 -> min <- expectation to use jokers */) {
@@ -1226,7 +1221,7 @@ function unpreparePipeline(pipeline) {
  * Library of pipelines that groups together pipelines for an application.
  * This implementation is a very thin wrapper around the Array / Map of pipelines.
  *
- * @private use `createCollectionFromJson` instead
+ * @private internal function of `createCollectionFromJson`, use `createCollectionFromJson` instead
  * @see https://github.com/webgptorg/pipeline#pipeline-collection
  */
 var SimplePipelineCollection = /** @class */ (function () {
@@ -1235,7 +1230,6 @@ var SimplePipelineCollection = /** @class */ (function () {
      *
      * @param pipelines @@@
      *
-     * @private Use instead `createCollectionFromJson`
      * Note: During the construction logic of all pipelines are validated
      * Note: It is not recommended to use this constructor directly, use `createCollectionFromJson` *(or other variant)* instead
      */
@@ -1850,7 +1844,8 @@ function extractParameterNamesFromPromptTemplate(promptTemplate) {
 /**
  * This error occurs when some expectation is not met in the execution of the pipeline
  *
- * @private Always catched and rethrown as `PipelineExecutionError`
+ * @private error of `checkExpectations` and `createPipelineExecutor`
+ * Note: Always thrown in `checkExpectations` and catched in `createPipelineExecutor` and rethrown as `PipelineExecutionError`
  * Note: This is a kindof subtype of PipelineExecutionError
  */
 var ExpectError = /** @class */ (function (_super) {
@@ -1888,7 +1883,7 @@ function isValidJsonString(value /* <- [👨‍⚖️] */) {
 /**
  * Multiple LLM Execution Tools is a proxy server that uses multiple execution tools internally and exposes the executor interface externally.
  *
- * @private Internal utility of `joinLlmExecutionTools`
+ * @private internal utility of `joinLlmExecutionTools`
  */
 var MultipleLlmExecutionTools = /** @class */ (function () {
     /**
@@ -2171,7 +2166,7 @@ function isPipelinePrepared(pipeline) {
  * 2) Undefined returns empty array
  * 3) Array returns itself
  *
- * @private Internal utility
+ * @private internal utility
  */
 function arrayableToArray(input) {
     if (input === undefined) {
@@ -2469,7 +2464,7 @@ var CountUtils = {
  *
  * @throws {ExpectError} if the expectations are not met
  * @returns {void} Nothing
- * @public exported from `@promptbook/core`
+ * @private internal function of `createPipelineExecutor`
  */
 function checkExpectations(expectations, value) {
     var e_1, _a;
@@ -4150,7 +4145,9 @@ var blockCommandParser = {
 /**
  * Units of text measurement
+ *
  * @see https://github.com/webgptorg/promptbook/discussions/30
+ * @public exported from `@promptbook/core`
  */
 var EXPECTATION_UNITS = ['CHARACTERS', 'WORDS', 'SENTENCES', 'LINES', 'PARAGRAPHS', 'PAGES'];
 /**
@@ -4390,7 +4387,7 @@ var jokerCommandParser = {
 /**
  * @@@
  *
- * @private for `ModelVariant` and `modelCommandParser`
+ * @public exported from `@promptbook/core`
  */
 var MODEL_VARIANTS = ['COMPLETION', 'CHAT', 'EMBEDDING' /* <- TODO [🏳] */ /* <- [🤖] */];
@@ -4855,11 +4852,12 @@ var boilerplateCommandParser = {
 };
 /**
  * TODO: [💐] Implement BOILERPLATE command into `pipelineStringToJsonSync` function
- * Note: [⚪] This should never be in any released package
  */
 /**
  * All available command parsers
+ *
+ * @private internal index of `parseCommand`
  */
 var COMMANDS = [
     blockCommandParser,
@@ -5029,6 +5027,8 @@ var NotYetImplementedError = /** @class */ (function (_super) {
 /**
  * Supported script languages
+ *
+ * @private internal base for `ScriptLanguage`
  */
 var SUPPORTED_SCRIPT_LANGUAGES = ['javascript', 'typescript', 'python'];
@@ -5169,7 +5169,7 @@ function extractOneBlockFromMarkdown(markdown) {
     return codeBlocks[0];
 }
 /***
- * TODO: [🍓][🌻] Decide of this is internal util, external util OR validator/postprocessor
+ * TODO: [🍓][🌻] Decide of this is internal utility, external util OR validator/postprocessor
  */
 /**
@@ -5768,6 +5768,7 @@ function pipelineStringToJson(pipelineString, options) {
 /**
  * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
  * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
+ * TODO: [🧠] Should be in generated JSON file GENERATOR_WARNING
  */
 /**
@@ -5786,6 +5787,145 @@ var CollectionError = /** @class */ (function (_super) {
     return CollectionError;
 }(Error));
+/**
+ * Checks if the file exists
+ *
+ * @private within the repository
+ */
+function isFileExisting(filePath) {
+    return __awaiter(this, void 0, void 0, function () {
+        var isReadAccessAllowed, isFile;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, access(filePath, constants.R_OK)
+                        .then(function () { return true; })
+                        .catch(function () { return false; })];
+                case 1:
+                    isReadAccessAllowed = _a.sent();
+                    if (!isReadAccessAllowed) {
+                        return [2 /*return*/, false];
+                    }
+                    return [4 /*yield*/, stat(filePath)
+                            .then(function (fileStat) { return fileStat.isFile(); })
+                            .catch(function () { return false; })];
+                case 2:
+                    isFile = _a.sent();
+                    return [2 /*return*/, isFile];
+            }
+        });
+    });
+}
+/**
+ * Note: [🟢] This code should never be published outside of `@promptbook/node` and `@promptbook/cli` and `@promptbook/cli`
+ * TODO: [🐠] This can be a validator - with variants that return true/false and variants that throw errors with meaningless messages
+ * TODO: [🖇] What about symlinks?
+ */
+/**
+ * Checks if the directory exists
+ *
+ * @private within the repository
+ */
+function isDirectoryExisting(directoryPath) {
+    return __awaiter(this, void 0, void 0, function () {
+        var isReadAccessAllowed, isDirectory;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, access(directoryPath, constants.R_OK)
+                        .then(function () { return true; })
+                        .catch(function () { return false; })];
+                case 1:
+                    isReadAccessAllowed = _a.sent();
+                    if (!isReadAccessAllowed) {
+                        return [2 /*return*/, false];
+                    }
+                    return [4 /*yield*/, stat(directoryPath)
+                            .then(function (fileStat) { return fileStat.isDirectory(); })
+                            .catch(function () { return false; })];
+                case 2:
+                    isDirectory = _a.sent();
+                    return [2 /*return*/, isDirectory];
+            }
+        });
+    });
+}
+/**
+ * Note: [🟢] This code should never be published outside of `@promptbook/node` and `@promptbook/cli` and `@promptbook/cli`
+ * TODO: [🐠] This can be a validator - with variants that return true/false and variants that throw errors with meaningless messages
+ * TODO: [🧠][📂] "directory" vs "folder"
+ * TODO: [🖇] What about symlinks?
+ */
+/**
+ * Reads all files in the directory
+ *
+ * @param path
+ * @param isRecursive
+ * @returns List of all files in the directory
+ * @private internal function of `createCollectionFromDirectory`
+ */
+function listAllFiles(path, isRecursive) {
+    return __awaiter(this, void 0, void 0, function () {
+        var dirents, fileNames, _a, _b, dirent, subPath, _c, _d, _e, _f, e_1_1;
+        var e_1, _g;
+        return __generator(this, function (_h) {
+            switch (_h.label) {
+                case 0: return [4 /*yield*/, isDirectoryExisting(path)];
+                case 1:
+                    if (!(_h.sent())) {
+                        throw new Error("Directory \"".concat(path, "\" does not exist or is not readable"));
+                        //           <- TODO: Use some custom error class
+                    }
+                    return [4 /*yield*/, readdir(path, {
+                            withFileTypes: true /* Note: This is not working: recursive: isRecursive */,
+                        })];
+                case 2:
+                    dirents = _h.sent();
+                    fileNames = dirents.filter(function (dirent) { return dirent.isFile(); }).map(function (_a) {
+                        var name = _a.name;
+                        return join(path, name);
+                    });
+                    if (!isRecursive) return [3 /*break*/, 10];
+                    _h.label = 3;
+                case 3:
+                    _h.trys.push([3, 8, 9, 10]);
+                    _a = __values(dirents.filter(function (dirent) { return dirent.isDirectory(); })), _b = _a.next();
+                    _h.label = 4;
+                case 4:
+                    if (!!_b.done) return [3 /*break*/, 7];
+                    dirent = _b.value;
+                    subPath = join(path, dirent.name);
+                    _d = (_c = fileNames.push).apply;
+                    _e = [fileNames];
+                    _f = [[]];
+                    return [4 /*yield*/, listAllFiles(subPath, isRecursive)];
+                case 5:
+                    _d.apply(_c, _e.concat([__spreadArray.apply(void 0, _f.concat([__read.apply(void 0, [(_h.sent())]), false]))]));
+                    _h.label = 6;
+                case 6:
+                    _b = _a.next();
+                    return [3 /*break*/, 4];
+                case 7: return [3 /*break*/, 10];
+                case 8:
+                    e_1_1 = _h.sent();
+                    e_1 = { error: e_1_1 };
+                    return [3 /*break*/, 10];
+                case 9:
+                    try {
+                        if (_b && !_b.done && (_g = _a.return)) _g.call(_a);
+                    }
+                    finally { if (e_1) throw e_1.error; }
+                    return [7 /*endfinally*/];
+                case 10: return [2 /*return*/, fileNames];
+            }
+        });
+    });
+}
+/**
+ * Note: [🟢] This code should never be published outside of `@promptbook/node` and `@promptbook/cli` and `@promptbook/cli`
+ * TODO: [🖇] What about symlinks?
+ */
 /**
  * Detects if the code is running in a browser environment in main thread (Not in a web worker)
  *
@@ -5904,7 +6044,7 @@ function createCollectionFromPromise(promptbookSourcesPromiseOrFactory) {
  */
 function createCollectionFromDirectory(path, options) {
     return __awaiter(this, void 0, void 0, function () {
-        var makedLibraryFilePath, makedLibraryFileExists, _a, _b, isRecursive, _c, isVerbose, _d, isLazyLoaded, _e, isCrashedOnError, collection;
+        var makedLibraryFilePath, _a, _b, isRecursive, _c, isVerbose, _d, isLazyLoaded, _e, isCrashedOnError, collection;
         var _this = this;
         return __generator(this, function (_f) {
             switch (_f.label) {
@@ -5912,13 +6052,10 @@ function createCollectionFromDirectory(path, options) {
                     if (!isRunningInNode()) {
                         throw new Error('Function `createCollectionFromDirectory` can only be run in Node.js environment because it reads the file system.');
                     }
-                    makedLibraryFilePath = join(path, "".concat(PIPELINE_COLLECTION_BASE_FILENAME, ".json"));
-                    return [4 /*yield*/, access(makedLibraryFilePath, constants.R_OK)
-                            .then(function () { return true; })
-                            .catch(function () { return false; })];
+                    makedLibraryFilePath = join$1(path, "".concat(PIPELINE_COLLECTION_BASE_FILENAME, ".json"));
+                    return [4 /*yield*/, isFileExisting(makedLibraryFilePath)];
                 case 1:
-                    makedLibraryFileExists = _f.sent();
-                    if (!makedLibraryFileExists) {
+                    if (!(_f.sent())) {
                         console.info(colors.yellow("Tip: Prebuild your pipeline collection (file with supposed prebuild ".concat(makedLibraryFilePath, " not found) with CLI util \"ptbk make\" to speed up the collection creation.")));
                     }
                     else {
@@ -6081,66 +6218,8 @@ function createCollectionFromDirectory(path, options) {
     });
 }
 /**
- * Reads all files in the directory
- *
- * @param path
- * @param isRecursive
- * @returns List of all files in the directory
- * @private internal function for `createCollectionFromDirectory`
- */
-function listAllFiles(path, isRecursive) {
-    return __awaiter(this, void 0, void 0, function () {
-        var dirents, fileNames, _a, _b, dirent, subPath, _c, _d, _e, _f, e_2_1;
-        var e_2, _g;
-        return __generator(this, function (_h) {
-            switch (_h.label) {
-                case 0: return [4 /*yield*/, readdir(path, {
-                        withFileTypes: true /* Note: This is not working: recursive: isRecursive */,
-                    })];
-                case 1:
-                    dirents = _h.sent();
-                    fileNames = dirents.filter(function (dirent) { return dirent.isFile(); }).map(function (_a) {
-                        var name = _a.name;
-                        return join(path, name);
-                    });
-                    if (!isRecursive) return [3 /*break*/, 9];
-                    _h.label = 2;
-                case 2:
-                    _h.trys.push([2, 7, 8, 9]);
-                    _a = __values(dirents.filter(function (dirent) { return dirent.isDirectory(); })), _b = _a.next();
-                    _h.label = 3;
-                case 3:
-                    if (!!_b.done) return [3 /*break*/, 6];
-                    dirent = _b.value;
-                    subPath = join(path, dirent.name);
-                    _d = (_c = fileNames.push).apply;
-                    _e = [fileNames];
-                    _f = [[]];
-                    return [4 /*yield*/, listAllFiles(subPath, isRecursive)];
-                case 4:
-                    _d.apply(_c, _e.concat([__spreadArray.apply(void 0, _f.concat([__read.apply(void 0, [(_h.sent())]), false]))]));
-                    _h.label = 5;
-                case 5:
-                    _b = _a.next();
-                    return [3 /*break*/, 3];
-                case 6: return [3 /*break*/, 9];
-                case 7:
-                    e_2_1 = _h.sent();
-                    e_2 = { error: e_2_1 };
-                    return [3 /*break*/, 9];
-                case 8:
-                    try {
-                        if (_b && !_b.done && (_g = _a.return)) _g.call(_a);
-                    }
-                    finally { if (e_2) throw e_2.error; }
-                    return [7 /*endfinally*/];
-                case 9: return [2 /*return*/, fileNames];
-            }
-        });
-    });
-}
-/**
- * Note: [🟢] This code should never be published outside of `@pipeline/node`
+ * Note: [🟢] This code should never be published outside of `@promptbook/node` and `@promptbook/cli` and `@promptbook/cli`
+ * TODO: [🖇] What about symlinks? Maybe option isSymlinksFollowed
  */
 /**
@@ -6165,7 +6244,7 @@ var EnvironmentMismatchError = /** @class */ (function (_super) {
  * @param content the content of prompt or response
  * @returns part of PromptResultUsageCounts
  *
- * @private internal util of LlmExecutionTools
+ * @private internal utility of LlmExecutionTools
  */
 function computeUsageCounts(content) {
     return {
@@ -6195,7 +6274,7 @@ function uncertainNumber(value) {
 /**
  * Get current date in ISO 8601 format
  *
- * @private This is internal util of the promptbook
+ * @private internal utility
  */
 function getCurrentIsoDate() {
     return new Date().toISOString();
@@ -6217,6 +6296,7 @@ function computeUsage(value) {
  * Note: Done at 2024-05-25
  *
  * @see https://docs.anthropic.com/en/docs/models-overview
+ * @public exported from `@promptbook/anthropic-claude`
  */
 var ANTHROPIC_CLAUDE_MODELS = [
     {
@@ -6863,7 +6943,7 @@ var OPENAI_MODELS = [
  * @param resultContent The content of the result (for embedding prompts or failed prompts pass empty string)
  * @param rawResponse The raw response from OpenAI API
  * @throws {PipelineExecutionError} If the usage is not defined in the response from OpenAI
- * @private internal util of `OpenAiExecutionTools`
+ * @private internal utility of `OpenAiExecutionTools`
  */
 function computeOpenaiUsage(promptContent, // <- Note: Intentionally using [] to access type properties to bring jsdoc from Prompt/PromptResult to consumer
 resultContent, rawResponse) {
@@ -7245,7 +7325,7 @@ function createLlmToolsFromEnv(options) {
  * TODO: [🧠] Which name is better `createLlmToolsFromEnv` or `createLlmToolsFromEnvironment`?
  * TODO: [🧠] Is there some meaningfull way how to test this util
  * TODO: [🧠] Maybe pass env as argument
- * Note: [🟢] This code should never be published outside of `@promptbook/node`
+ * Note: [🟢] This code should never be published outside of `@promptbook/node` and `@promptbook/cli` and `@promptbook/cli`
  * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
  */
@@ -7300,24 +7380,21 @@ var FilesStorage = /** @class */ (function () {
     FilesStorage.prototype.getFilenameForKey = function (key) {
         var name = titleToName(key);
         var hash = sha256(hexEncoder.parse(name)).toString( /* hex */);
-        return join.apply(void 0, __spreadArray(__spreadArray([this.options.cacheFolderPath], __read(nameToSubfolderPath(hash /* <- TODO: [🎎] Maybe add some SHA256 prefix */)), false), ["".concat(name.substring(0, MAX_FILENAME_LENGTH), ".json")], false));
+        return join$1.apply(void 0, __spreadArray(__spreadArray([this.options.cacheFolderPath], __read(nameToSubfolderPath(hash /* <- TODO: [🎎] Maybe add some SHA256 prefix */)), false), ["".concat(name.substring(0, MAX_FILENAME_LENGTH), ".json")], false));
     };
     /**
      * @@@ 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.
      */
     FilesStorage.prototype.getItem = function (key) {
         return __awaiter(this, void 0, void 0, function () {
-            var filename, isFileExisting, fileContent, value;
+            var filename, fileContent, value;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
                         filename = this.getFilenameForKey(key);
-                        return [4 /*yield*/, stat(filename)
-                                .then(function (fileStat) { return fileStat.isFile(); })
-                                .catch(function () { return false; })];
+                        return [4 /*yield*/, isFileExisting(filename)];
                     case 1:
-                        isFileExisting = _a.sent();
-                        if (!isFileExisting) {
+                        if (!(_a.sent())) {
                             return [2 /*return*/, null];
                         }
                         return [4 /*yield*/, readFile(filename, 'utf-8')];
@@ -7376,7 +7453,7 @@ var FilesStorage = /** @class */ (function () {
 }());
 /**
  * TODO: [🌗] Maybe some checkers, not all valid JSONs are desired and valid values
- * Note: [🟢] This code should never be published outside of `@promptbook/node`
+ * Note: [🟢] This code should never be published outside of `@promptbook/node` and `@promptbook/cli` and `@promptbook/cli`
  */
 export { FilesStorage, PROMPTBOOK_VERSION, createCollectionFromDirectory, createLlmToolsFromEnv };