@promptbook/types 0.61.0-10 → 0.61.0-11

package/esm/index.es.js

@@ -10,7 +10,7 @@ var EXPECTATION_UNITS = ['CHARACTERS', 'WORDS', 'SENTENCES', 'LINES', 'PARAGRAPH
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.61.0-9';
+var PROMPTBOOK_VERSION = '0.61.0-10';
 // TODO: !!!! List here all the versions and annotate + put into script
 
 export { EXPECTATION_UNITS, PROMPTBOOK_VERSION };

package/esm/index.es.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.es.js","sources":["../../../../src/types/PipelineJson/Expectations.ts","../../../../src/version.ts"],"sourcesContent":[null,null],"names":[],"mappings":"AAeA;;;;IAIa,iBAAiB,GAAG,CAAC,YAAY,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,YAAY,EAAE,OAAO,EAAW;AAc/G;;;;AC/BA;;;IAGa,kBAAkB,GAA8B,WAAW;AAGxE;;;;"}
+{"version":3,"file":"index.es.js","sources":["../../../../src/types/PipelineJson/Expectations.ts","../../../../src/version.ts"],"sourcesContent":[null,null],"names":[],"mappings":"AAeA;;;;IAIa,iBAAiB,GAAG,CAAC,YAAY,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,YAAY,EAAE,OAAO,EAAW;AAc/G;;;;AC/BA;;;IAGa,kBAAkB,GAA8B,YAAY;AAGzE;;;;"}

package/esm/typings/promptbook-collection/index.d.ts

@@ -26,7 +26,6 @@ declare const _default: ({
     personas: never[];
     preparations: {
         id: number;
-        date: string;
         promptbookVersion: string;
         modelUsage: {
             price: {
@@ -115,7 +114,89 @@ declare const _default: ({
     personas: never[];
     preparations: {
         id: number;
-        date: string;
+        promptbookVersion: string;
+        modelUsage: {
+            price: {
+                value: number;
+            };
+            input: {
+                tokensCount: {
+                    value: number;
+                };
+                charactersCount: {
+                    value: number;
+                };
+                wordsCount: {
+                    value: number;
+                };
+                sentencesCount: {
+                    value: number;
+                };
+                linesCount: {
+                    value: number;
+                };
+                paragraphsCount: {
+                    value: number;
+                };
+                pagesCount: {
+                    value: number;
+                };
+            };
+            output: {
+                tokensCount: {
+                    value: number;
+                };
+                charactersCount: {
+                    value: number;
+                };
+                wordsCount: {
+                    value: number;
+                };
+                sentencesCount: {
+                    value: number;
+                };
+                linesCount: {
+                    value: number;
+                };
+                paragraphsCount: {
+                    value: number;
+                };
+                pagesCount: {
+                    value: number;
+                };
+            };
+        };
+    }[];
+    sourceFile: string;
+} | {
+    title: string;
+    pipelineUrl: string;
+    promptbookVersion: string;
+    parameters: {
+        name: string;
+        description: string;
+        isInput: boolean;
+        isOutput: boolean;
+    }[];
+    promptTemplates: {
+        name: string;
+        title: string;
+        dependentParameterNames: string[];
+        blockType: string;
+        expectFormat: string;
+        personaName: null;
+        modelRequirements: {
+            modelVariant: string;
+            modelName: string;
+        };
+        content: string;
+        resultingParameterName: string;
+    }[];
+    knowledgeSources: never[];
+    knowledgePieces: never[];
+    personas: never[];
+    preparations: {
+        id: number;
         promptbookVersion: string;
         modelUsage: {
             price: {

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

@@ -17,7 +17,7 @@ import { PipelineExecutionError } from '../errors/PipelineExecutionError';
 import { PipelineLogicError } from '../errors/PipelineLogicError';
 import { ReferenceError } from '../errors/ReferenceError';
 import { UnexpectedError } from '../errors/UnexpectedError';
-import { VersionMismatch } from '../errors/VersionMismatch';
+import { VersionMismatchError } from '../errors/VersionMismatchError';
 import { ExpectError } from '../errors/_ExpectError';
 import { assertsExecutionSuccessful } from '../execution/assertsExecutionSuccessful';
 import { createPipelineExecutor } from '../execution/createPipelineExecutor';
@@ -45,4 +45,4 @@ export { pipelineJsonToString, pipelineStringToJson, pipelineStringToJsonSync, v
 export { preparePipeline, unpreparePipeline };
 export { createPipelineExecutor, joinLlmExecutionTools };
 export { CallbackInterfaceTools, CallbackInterfaceToolsOptions };
-export { CollectionError, ExpectError, NotFoundError, ParsingError, PipelineExecutionError, PipelineLogicError, ReferenceError, UnexpectedError, VersionMismatch, };
+export { CollectionError, ExpectError, NotFoundError, ParsingError, PipelineExecutionError, PipelineLogicError, ReferenceError, UnexpectedError, VersionMismatchError, };

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

@@ -29,12 +29,12 @@ import type { ScriptLanguage } from '../types/ScriptLanguage';
 import type { TaskProgress } from '../types/TaskProgress';
 import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
 import type { string_char_emoji } from '../types/typeAliasEmoji';
-import type { client_id, string_char, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, string_emails, string_file_absolute_path, string_file_extension, string_file_path, string_file_relative_path, string_filename, string_folder_absolute_path, string_folder_path, string_folder_relative_path, string_host, string_hostname, string_href, string_html, string_javascript, string_javascript_name, string_license, string_markdown, string_markdown_text, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_person_fullname, string_pipeline_url, string_pipeline_url_with_hashtemplate, string_prompt, string_script, string_semantic_version, string_sha256, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_uri, string_uri_part, string_url, string_url_image, string_uuid } from '../types/typeAliases';
+import type { client_id, number_model_temperature, number_seed, string_char, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, string_emails, string_file_absolute_path, string_file_extension, string_file_path, string_file_relative_path, string_filename, string_folder_absolute_path, string_folder_path, string_folder_relative_path, string_host, string_hostname, string_href, string_html, string_javascript, string_javascript_name, string_license, string_markdown, string_markdown_text, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_parameter_name, string_parameter_value, string_person_fullname, string_pipeline_url, string_pipeline_url_with_hashtemplate, string_prompt, string_script, string_semantic_version, string_sha256, string_system_message, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_uri, string_uri_part, string_url, string_url_image, string_uuid } from '../types/typeAliases';
 import type { FromtoItems } from '../utils/FromtoItems';
 import { PROMPTBOOK_VERSION, string_promptbook_version } from '../version';
 export { PROMPTBOOK_VERSION };
 export { EXPECTATION_UNITS };
-export type { AvailableModel, BlockType, CommonExecutionToolsOptions, EmbeddingVector, ExecutionReportJson, ExecutionTools, ExpectationAmount, ExpectationUnit, Expectations, FromtoItems, KnowledgePiecePreparedJson, KnowledgeSourceJson, KnowledgeSourcePreparedJson, LlmExecutionTools, LlmTemplateJson, ModelRequirements, ModelVariant, Parameters, PersonaJson, PersonaPreparedJson, PipelineCollection, PipelineExecutor, PipelineJson, PipelineString, PreparationJson, Prompt, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptDialogJson, PromptEmbeddingResult, PromptResult, PromptResultUsage, PromptResultUsageCounts, PromptTemplateJson, PromptTemplateParameterJson, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptJson, ScriptLanguage, SimpleTemplateJson, TaskProgress, UncertainNumber, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, client_id, string_char, string_char_emoji, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, string_emails, string_file_absolute_path, string_file_extension, string_file_path, string_file_relative_path, string_filename, string_folder_absolute_path, string_folder_path, string_folder_relative_path, string_host, string_hostname, string_href, string_html, string_javascript, string_javascript_name, string_license, string_markdown, string_markdown_text, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_person_fullname, string_pipeline_url, string_pipeline_url_with_hashtemplate, string_prompt, string_promptbook_version, string_script, string_semantic_version, string_sha256, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_uri, string_uri_part, string_url, string_url_image, string_uuid, };
+export type { AvailableModel, BlockType, CommonExecutionToolsOptions, EmbeddingVector, ExecutionReportJson, ExecutionTools, ExpectationAmount, ExpectationUnit, Expectations, FromtoItems, KnowledgePiecePreparedJson, KnowledgeSourceJson, KnowledgeSourcePreparedJson, LlmExecutionTools, LlmTemplateJson, ModelRequirements, ModelVariant, Parameters, PersonaJson, PersonaPreparedJson, PipelineCollection, PipelineExecutor, PipelineJson, PipelineString, PreparationJson, Prompt, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptDialogJson, PromptEmbeddingResult, PromptResult, PromptResultUsage, PromptResultUsageCounts, PromptTemplateJson, PromptTemplateParameterJson, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptJson, ScriptLanguage, SimpleTemplateJson, TaskProgress, UncertainNumber, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, client_id, number_model_temperature, number_seed, string_char, string_char_emoji, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, string_emails, string_file_absolute_path, string_file_extension, string_file_path, string_file_relative_path, string_filename, string_folder_absolute_path, string_folder_path, string_folder_relative_path, string_host, string_hostname, string_href, string_html, string_javascript, string_javascript_name, string_license, string_markdown, string_markdown_text, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_parameter_name, string_parameter_value, string_person_fullname, string_pipeline_url, string_pipeline_url_with_hashtemplate, string_prompt, string_promptbook_version, string_script, string_semantic_version, string_sha256, string_system_message, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_uri, string_uri_part, string_url, string_url_image, string_uuid, };
 /**
  * TODO: Delete type aliases (from ../types/typeAliases) that are not exported here
  */

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

@@ -7,6 +7,7 @@ import { titleToName } from '../conversion/utils/titleToName';
 import { forEachAsync } from '../execution/utils/forEachAsync';
 import { replaceParameters } from '../execution/utils/replaceParameters';
 import { isValidJsonString } from '../formats/json/utils/isValidJsonString';
+import { $currentDate } from '../utils/currentDate';
 import { countCharacters } from '../utils/expectation-counters/countCharacters';
 import { countLines } from '../utils/expectation-counters/countLines';
 import { countPages } from '../utils/expectation-counters/countPages';
@@ -34,6 +35,7 @@ import { removeDiacritics } from '../utils/normalization/removeDiacritics';
 import { searchKeywords } from '../utils/normalization/searchKeywords';
 import { parseNumber } from '../utils/parseNumber';
 import { extractBlock } from '../utils/postprocessing/extractBlock';
+import { $randomSeed } from '../utils/random/randomSeed';
 import { removeEmojis } from '../utils/removeEmojis';
 import { removeQuotes } from '../utils/removeQuotes';
 import { difference } from '../utils/sets/difference';
@@ -53,7 +55,7 @@ import { isValidUrl } from '../utils/validators/url/isValidUrl';
 import { isValidUuid } from '../utils/validators/uuid/isValidUuid';
 import { PROMPTBOOK_VERSION } from '../version';
 export { forEachAsync, PROMPTBOOK_VERSION };
-export { extractBlock, // <- [🌻] + maybe export through `@promptbook/markdown-utils`
+export { $currentDate, $randomSeed, extractBlock, // <- [🌻] + maybe export through `@promptbook/markdown-utils`
 extractParameters, extractVariables, isHostnameOnPrivateNetwork, isUrlOnPrivateNetwork, isValidFilePath, isValidJavascriptName, isValidJsonString, isValidPipelineUrl, isValidPromptbookVersion, isValidSemanticVersion, isValidUrl, isValidUuid, parseNumber, // <- [🌻]
 removeEmojis, removeQuotes, replaceParameters, spaceTrim, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
 export { countCharacters, countLines, countPages, countParagraphs, countSentences, CountUtils, countWords };

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

@@ -1,3 +1,5 @@
+import type { WritableDeep } from 'type-fest';
+import type { PipelineJson } from '../../../types/PipelineJson/PipelineJson';
 import type { string_markdown_text } from '../../../types/typeAliases';
 import type { string_name } from '../../../types/typeAliases';
 import type { string_SCREAMING_CASE } from '../../../utils/normalization/normalizeTo_SCREAMING_CASE';
@@ -16,6 +18,7 @@ export type CommandParser<TCommand extends {
      * @throws {ParsingError} if the parsing fails
      */
     parse(input: CommandParserInput): TCommand;
+    applyToPipelineJson?(pipelineJson: WritableDeep<PipelineJson>, personaCommand: TCommand): void;
 };
 export type CommandParserInput = {
     readonly usagePlace: CommandUsagePlace;

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

@@ -10,6 +10,10 @@ export declare const CHARACTER_LOOP_LIMIT = 100000;
  * The maximum number of (LLM) tasks running in parallel
  */
 export declare const MAX_PARALLEL_COUNT = 5;
+/**
+ * The maximum length of the (generated) filename
+ */
+export declare const MAX_FILENAME_LENGTH = 30;
 /**
  * The name of the builded pipeline collection made by CLI `ptbk make` and for lookup in `createCollectionFromDirectory`
  */

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

@@ -31,4 +31,5 @@ export type PipelineStringToJsonOptions = {
 export declare function pipelineStringToJson(pipelineString: PipelineString, options?: PipelineStringToJsonOptions): Promise<PipelineJson>;
 /**
  * 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
  */

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

@@ -22,4 +22,6 @@ export declare function pipelineStringToJsonSync(pipelineString: PipelineString)
  * TODO: Use spaceTrim more effectively
  * TODO: [🧠] Parameter flags - isInput, isOutput, isInternal
  * TODO: [🥞] Not optimal parsing because `splitMarkdownIntoSections` is executed twice with same string, once through `flattenMarkdown` and second directly here
+ * TODO: [♈] Probbably move expectations from templates to parameters
+ * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
  */

package/esm/typings/src/conversion/validation/validatePipeline.d.ts

@@ -25,3 +25,7 @@ export declare function validatePipeline(pipeline: PipelineJson): PipelineJson;
  *     >  * -   ...
  *     >  ex port function validatePipeline(promptbook: unknown): asserts promptbook is PipelineJson {
  */
+/**
+ * TODO: [🧠] !!!!! Validate new things
+ * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
+ */ 

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

@@ -0,0 +1,7 @@
+/**
+ * This error type indicates that you try to use a feature that is not available in the current environment
+ */
+export declare class EnvironmentMismatchError extends Error {
+    readonly name = "EnvironmentMismatchError";
+    constructor(message: string);
+}

package/{umd/typings/src/errors/VersionMismatch.d.ts → esm/typings/src/errors/VersionMismatchError.d.ts}

@@ -2,7 +2,7 @@ import type { string_semantic_version } from '../types/typeAliases';
 /**
  * This error type indicates that the version of the pipeline is not matching the expected version
  */
-export declare class VersionMismatch extends Error {
+export declare class VersionMismatchError extends Error {
     readonly name = "UnexpectedError";
     constructor(message: string, expectedVersion: string_semantic_version);
 }

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

@@ -63,8 +63,10 @@ export type AvailableModel = {
     readonly modelVariant: ModelVariant;
 };
 /**
- * TODO: !!!! Translation model
+ * TODO: [🏳] Add `callTranslationModel`
+ * TODO: Maybe reorder `listModels` and put it befor `callChatModel`, `callCompletionModel`, `callEmbeddingModel`
  * TODO: [🧠] Emulation of one type of model with another one - emuate chat with completion; emulate translation with chat
  * TODO: [🍓][♐] Some heuristic to pick the best model in listed models
  * TODO: [🧠] Should or should not there be a word "GPT" in both callCompletionModel and callChatModel
+ * TODO: [🧠][🪐] Should be common things like types, utils in folder containing A,B,C,.. or else outside this listing folder?
  */

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

@@ -1,7 +1,8 @@
 import type { Promisable } from 'type-fest';
 import type { TaskProgress } from '../types/TaskProgress';
 import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
-import type { string_name } from '../types/typeAliases';
+import type { string_parameter_name } from '../types/typeAliases';
+import type { string_parameter_value } from '../types/typeAliases';
 import type { PromptResultUsage } from './PromptResult';
 /**
  * Executor is a simple async function that takes INPUT  PARAMETERs and returns result parameters _(along with all intermediate parameters and INPUT  PARAMETERs = it extends input object)_.
@@ -12,7 +13,7 @@ import type { PromptResultUsage } from './PromptResult';
  * @see https://github.com/webgptorg/promptbook#executor
  */
 export type PipelineExecutor = {
-    (inputParameters: Record<string_name, string>, onProgress?: (taskProgress: TaskProgress) => Promisable<void>): Promise<{
+    (inputParameters: Record<string_parameter_name, string_parameter_value>, onProgress?: (taskProgress: TaskProgress) => Promisable<void>): Promise<{
         /**
          * Whether the execution was successful, details are aviable in `executionReport`
          */
@@ -34,7 +35,7 @@ export type PipelineExecutor = {
          *
          * Note: If the execution was not successful, there are only some of the result parameters
          */
-        readonly outputParameters: Record<string_name, string>;
+        readonly outputParameters: Record<string_parameter_name, string_parameter_value>;
     }>;
 };
 /**

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

@@ -15,15 +15,21 @@ export type PromptResult = PromptCompletionResult | PromptChatResult | PromptEmb
 /**
  * Prompt completion result
  * It contains only the following text NOT the whole completion
+ *
+ * Note: This is fully serializable as JSON
  */
 export type PromptCompletionResult = PromptCommonResult;
 /**
  * Prompt chat result
+ *
+ * Note: This is fully serializable as JSON
  */
 export type PromptChatResult = PromptCommonResult & {};
 /**
  * Prompt embedding result
  * It contains only the following text NOT the whole completion
+ *
+ * Note: This is fully serializable as JSON
  */
 export type PromptEmbeddingResult = Omit<PromptCommonResult, 'content'> & {
     /**
@@ -31,6 +37,11 @@ export type PromptEmbeddingResult = Omit<PromptCommonResult, 'content'> & {
      */
     content: EmbeddingVector;
 };
+/**
+ * Common properties for all prompt results
+ *
+ * Note: This is fully serializable as JSON
+ */
 export type PromptCommonResult = {
     /**
      * Exact text response from the model
@@ -111,4 +122,5 @@ export type UncertainNumber = {
  * TODO: [🧠] Maybe type raw properly - not onject but OpenAI.result.whatever
  * TODO: [🧠] Maybe remove redundant raw.choices.text
  * TODO: Log raw even if prompt failed - log the raw error
+ * TODO: [🏳] Add `PromptTranslationResult`
  */

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

@@ -1,5 +1,6 @@
 import type { ScriptLanguage } from '../types/ScriptLanguage';
-import type { string_name } from '../types/typeAliases';
+import type { string_parameter_name } from '../types/typeAliases';
+import type { string_parameter_value } from '../types/typeAliases';
 import type { string_script } from '../types/typeAliases';
 /**
  * Represents all the tools needed to EXECUTE SCRIPTs
@@ -22,7 +23,7 @@ export type ScriptExecutionToolsExecuteOptions = {
      * Theese parameters are passed to the script as variables
      * For example: { "name": "John" } => const name = "John";
      */
-    readonly parameters: Record<string_name, string>;
+    readonly parameters: Record<string_parameter_name, string_parameter_value>;
     /**
      * The content of the script to execute
      * - It can be a single statement
@@ -35,4 +36,5 @@ export type ScriptExecutionToolsExecuteOptions = {
 };
 /**
  * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
+ * TODO: [🧠][🪐] Should be common things like types, utils in folder containing A,B,C,.. or else outside this listing folder?
  */

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

@@ -36,8 +36,10 @@ export declare function createPipelineExecutor(options: CreatePipelineExecutorOp
 export {};
 /**
  * TODO: [🪂] Pass maxParallelCount here
+ * TODO: [♈] Probbably move expectations from templates to parameters
  * TODO: [🧠] When not meet expectations in PROMPT_DIALOG, make some way to tell the user
  * TODO: [👧] Strongly type the executors to avoid need of remove nullables whtn noUncheckedIndexedAccess in tsconfig.json
  * Note: CreatePipelineExecutorOptions are just connected to PipelineExecutor so do not extract to types folder
  * TODO: [🧠][3] transparent = (report intermediate parameters) / opaque execution = (report only output parameters) progress reporting mode
+ * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
  */

package/esm/typings/src/knowledge/prepare-knowledge/_common/utils/getLlmToolsForTestingAndScriptsAndPlayground.d.ts

@@ -0,0 +1,10 @@
+import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
+/**
+ * Returns LLM tools for testing purposes
+ *
+ * @private within the package - JUST FOR TESTS, SCRIPTS AND PLAYGROUND
+ */
+export declare function getLlmToolsForTestingAndScriptsAndPlayground(): LlmExecutionTools;
+/**
+ * Note: [⚪]
+ */ 

package/esm/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.test.d.ts

@@ -1 +1,4 @@
 export {};
+/**
+ * TODO: [📓] Maybe test all file in samples (not just 10-simple.md)
+ */

package/esm/typings/src/llm-providers/anthropic-claude/playground/playground.d.ts

@@ -1,2 +1,5 @@
 #!/usr/bin/env ts-node
 export {};
+/**
+ * TODO: !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
+ */

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

@@ -1,2 +1,5 @@
 #!/usr/bin/env ts-node
 export {};
+/**
+ * TODO: Test here that `systemMessage`, `temperature` and `seed` are working correctly
+ */

package/esm/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts

@@ -29,6 +29,6 @@ export declare class MockedEchoLlmExecutionTools implements LlmExecutionTools {
     listModels(): Array<AvailableModel>;
 }
 /**
- * TODO: [🕵️‍♀️] Maybe just remove
+ * TODO: !!! Use here `seed`
  * TODO: Allow in spaceTrim: nesting with > ${block(prompt.request)}, same as replace params
  */

package/esm/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts

@@ -34,5 +34,5 @@ export declare class MockedFackedLlmExecutionTools implements LlmExecutionTools
     listModels(): Array<AvailableModel>;
 }
 /**
- * TODO: [🕵️‍♀️] Maybe just remove
+ * TODO: !!! Use here `seed`
  */

package/esm/typings/src/llm-providers/multiple/MultipleLlmExecutionTools.d.ts

@@ -41,10 +41,12 @@ export declare class MultipleLlmExecutionTools implements LlmExecutionTools {
     private callModelCommon;
     /**
      * List all available models that can be used
-     * This liost is a combination of all available models from all execution tools
+     * This lists is a combination of all available models from all execution tools
      */
     listModels(): Promise<Array<AvailableModel>>;
 }
 /**
  * TODO: [🧠][🎛] Aggregating multiple models - have result not only from one first aviable model BUT all of them
+ * TODO: [🏖] If no llmTools have for example not defined `callCompletionModel` this will still return object with defined `callCompletionModel` which just throws `PipelineExecutionError`, make it undefined instead
+ *       Look how `countTotalUsage` (and `cacheLlmTools`) implements it
  */

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

@@ -24,4 +24,5 @@ export declare const OPENAI_MODELS: Array<AvailableModel & {
  * @see /other/playground/playground.ts
  * TODO: [🍓] Make better
  * TODO: Change model titles to human eg: "gpt-4-turbo-2024-04-09" -> "GPT-4 Turbo (2024-04-09)"
+ * TODO: [🚸] Not all models are compatible with JSON mode, add this information here and use it
  */

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

@@ -1,2 +1,5 @@
 #!/usr/bin/env ts-node
 export {};
+/**
+ * TODO: !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
+ */

package/esm/typings/src/llm-providers/utils/cache/CacheItem.d.ts

@@ -0,0 +1,29 @@
+import type { PromptResult } from '../../../execution/PromptResult';
+import type { Prompt } from '../../../types/Prompt';
+import type { string_date_iso8601 } from '../../../types/typeAliases';
+import type { string_promptbook_version } from '../../../version';
+/**
+ * @@@
+ */
+export type CacheItem = {
+    /**
+     * @@@
+     */
+    date: string_date_iso8601;
+    /**
+     * @@@
+     */
+    promptbookVersion: string_promptbook_version;
+    /**
+     * @@@
+     */
+    prompt: Prompt;
+    /**
+     * @@@
+     */
+    promptResult: PromptResult;
+};
+/**
+ * TODO: [🧠] Should be this exported alongsite `cacheLlmTools` through `@promptbook/utils` OR through `@promptbook/types`
+ * TODO: [🛫] `prompt` is NOT fully serializable as JSON, it contains functions which are not serializable, fix it
+ */

package/esm/typings/src/llm-providers/utils/cache/CacheLlmToolsOptions.d.ts

@@ -0,0 +1,10 @@
+import type { PromptbookStorage } from '../../../storage/_common/PromptbookStorage';
+import type { CacheItem } from './CacheItem';
+export type CacheLlmToolsOptions = {
+    /**
+     * Total cost of the execution
+     *
+     * @default MemoryStorage
+     */
+    storage: PromptbookStorage<CacheItem>;
+};

package/esm/typings/src/llm-providers/utils/cache/cacheLlmTools.d.ts

@@ -0,0 +1,17 @@
+import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
+import type { CacheLlmToolsOptions } from './CacheLlmToolsOptions';
+/**
+ * Intercepts LLM tools and counts total usage of the tools
+ *
+ * @param llmTools LLM tools to be intercepted with usage counting
+ * @returns LLM tools with same functionality with added total cost counting
+ */
+export declare function cacheLlmTools(llmTools: LlmExecutionTools, options?: Partial<CacheLlmToolsOptions>): LlmExecutionTools;
+/**
+ * TODO: !!!!! Export this util
+ * TODO: !!!!! Use this for tests in promptbook project itself
+ * TODO: !!!! write discussion about this and storages
+ *            write how to combine multiple interceptors
+ * 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
+ */

package/esm/typings/src/llm-providers/utils/count-total-cost/LlmExecutionToolsWithTotalCost.d.ts

@@ -0,0 +1,11 @@
+import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
+import type { PromptResultUsage } from '../../../execution/PromptResult';
+/**
+ * LLM tools with option to get total cost of the execution
+ */
+export type LlmExecutionToolsWithTotalCost = LlmExecutionTools & {
+    /**
+     * Total cost of the execution
+     */
+    totalUsage: PromptResultUsage;
+};

package/esm/typings/src/llm-providers/utils/count-total-cost/countTotalCost.d.ts

@@ -0,0 +1,14 @@
+import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
+import type { LlmExecutionToolsWithTotalCost } from './LlmExecutionToolsWithTotalCost';
+/**
+ * Intercepts LLM tools and counts total usage of the tools
+ *
+ * @param llmTools LLM tools to be intercepted with usage counting
+ * @returns LLM tools with same functionality with added total cost counting
+ */
+export declare function countTotalUsage(llmTools: LlmExecutionTools): LlmExecutionToolsWithTotalCost;
+/**
+ * TODO: !!!!! Export this utils
+ * 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
+ */

package/esm/typings/src/llm-providers/utils/createLlmToolsFromEnv.d.ts

@@ -0,0 +1,21 @@
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+/**
+ * @@@
+ *
+ * Note: This function is not cached, every call creates new instance of LlmExecutionTools
+ *
+ * It looks for environment variables:
+ * - `process.env.OPENAI_API_KEY`
+ * - `process.env.ANTHROPIC_CLAUDE_API_KEY`
+ *
+ * @returns @@@
+ */
+export declare function createLlmToolsFromEnv(): LlmExecutionTools;
+/**
+ * TODO: !!!!! Export this util
+ * TODO: !!!! write discussion about this - wizzard
+ * TODO: Add Azure
+ * 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
+ */

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

@@ -8,6 +8,3 @@ import type { string_persona_description } from '../types/typeAliases';
  * @private within the package
  */
 export declare function preparePersona(personaDescription: string_persona_description, options: PrepareOptions): Promise<PersonaPreparedJson['modelRequirements']>;
-/**
- * TODO: [🪂] Do it in parallel
- */

package/esm/typings/src/prepare/preparePipeline.d.ts

@@ -11,5 +11,6 @@ export declare function preparePipeline(pipeline: PipelineJson, options: Prepare
  * 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
- * TODO: [💸] Make utilities `interceptLlmTools` and `costLlmTools` to compute cost and DO put this counting logic in `prepareKnowledge` or `preparePersona`
+ * TODO: !!!!! Use here countTotalUsage
+ * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
  */

package/esm/typings/src/storage/_common/PromptbookStorage.d.ts

@@ -0,0 +1,24 @@
+import { Promisable } from 'type-fest';
+/**
+ * Storage of objects with asynchronous API
+ *
+ * Note: Naming `PromptbookStorage` not `Storage` to avoid name collision with global `Storage` interface.
+ * Note: This is simmilar to Web Storage API interface but everything is asynchronous and can store JSON objects.
+ */
+export type PromptbookStorage<TItem> = {
+    /**
+     * 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
+     */
+    getItem(key: string): Promisable<TItem | null>;
+    /**
+     * Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously
+     */
+    setItem(key: string, value: TItem): Promisable<void>;
+    /**
+     * 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
+     */
+    removeItem(key: string): Promisable<void>;
+};
+/**
+ * TODO: [🧠][🛫] Constrain `TItem` to JSON-serializable objects only
+ */

package/esm/typings/src/storage/_common/PromptbookStorage.test-type.d.ts

@@ -0,0 +1,5 @@
+export {};
+/**
+ * TODO: !!!!! Check that this files is not exported into build
+ * TODO: Is this a good pattern to do type testing?
+ */

package/esm/typings/src/storage/files-storage/FilesStorage.d.ts

@@ -0,0 +1,28 @@
+import type { PromptbookStorage } from '../_common/PromptbookStorage';
+import type { FilesStorageOptions } from './FilesStorageOptions';
+/**
+ * @@@
+ */
+export declare class FilesStorage<TItem> implements PromptbookStorage<TItem> {
+    private readonly options;
+    constructor(options: FilesStorageOptions);
+    /**
+     * @@@
+     */
+    private getFilenameForKey;
+    /**
+     * @@@ 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.
+     */
+    getItem(key: string): Promise<TItem | null>;
+    /**
+     * @@@ Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.
+     */
+    setItem(key: string, value: TItem): Promise<void>;
+    /**
+     * @@@ 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.
+     */
+    removeItem(key: string): Promise<void>;
+}
+/**
+ * TODO: [🌗] Maybe some checkers, not all valid JSONs are desired and valid values
+ */