@promptbook/remote-client 0.61.0-10 → 0.61.0-12

package/umd/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/umd/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/umd/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/umd/typings/src/cli/cli-commands/hello.d.ts

@@ -5,3 +5,6 @@ import type { Command as Program } from 'commander';
  * @private part of `promptbookCli`
  */
 export declare function initializeHelloCommand(program: Program): void;
+/**
+ * Note: [🟡] This code should never be published outside of `@promptbook/cli`
+ */ 

package/umd/typings/src/cli/cli-commands/make.d.ts

@@ -5,3 +5,6 @@ import type { Command as Program } from 'commander';
  * @private part of `promptbookCli`
  */
 export declare function initializeMakeCommand(program: Program): void;
+/**
+ * Note: [🟡] This code should never be published outside of `@promptbook/cli`
+ */

package/umd/typings/src/cli/cli-commands/prettify.d.ts

@@ -5,3 +5,6 @@ import type { Command as Program } from 'commander';
  * @private part of `promptbookCli`
  */
 export declare function initializePrettifyCommand(program: Program): void;
+/**
+ * Note: [🟡] This code should never be published outside of `@promptbook/cli`
+ */

package/umd/typings/src/cli/promptbookCli.d.ts

@@ -6,4 +6,5 @@ export declare function promptbookCli(): Promise<void>;
  * TODO: [🥠] Do not export to utils directly, its just for CLI script
  * TODO: [🕌] When more functionalities, rename
  * Note: 11:11
+ * Note: [🟡] This code should never be published outside of `@promptbook/cli`
  */

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

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

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

@@ -14,7 +14,7 @@ export declare class SimplePipelineCollection implements PipelineCollection {
     /**
      * Constructs a pipeline collection from promptbooks
      *
-     * @param promptbooks !!!
+     * @param promptbooks @@@
      *
      * @private Use instead `createCollectionFromJson`
      * Note: During the construction logic of all promptbooks are validated

package/umd/typings/src/collection/constructors/createCollectionFromDirectory.d.ts

@@ -44,4 +44,5 @@ export declare function createCollectionFromDirectory(path: string_folder_path,
 export {};
 /**
  * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
+ * Note: [🟢] This code should never be published outside of `@promptbook/node`
  */

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

@@ -9,4 +9,5 @@ import type { BoilerplateCommand } from './BoilerplateCommand';
 export declare const boilerplateCommandParser: CommandParser<BoilerplateCommand>;
 /**
  * TODO: [💐] Implement BOILERPLATE command into `pipelineStringToJsonSync` function
+ * Note: [⚪] This should never be in any released package
  */

package/umd/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;
@@ -25,7 +28,7 @@ export type CommandParserInput = {
     readonly args: Array<string_name & string_SCREAMING_CASE>;
 };
 /**
- * TODO: !!!! Annotate
+ * TODO: @@@ Annotate all
  * TODO: [🧠] Maybe put flag if it is for whole `.ptbk.md` file of just one section
  * TODO: [🍧] CommandParser should have applyToPipelineJson method
  *       which will apply parsed command to the pipeline JSON

package/umd/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/umd/typings/src/conversion/pipelineJsonToString.d.ts

@@ -8,7 +8,7 @@ import type { PipelineString } from '../types/PipelineString';
  */
 export declare function pipelineJsonToString(pipelineJson: PipelineJson): PipelineString;
 /**
- * TODO: !!!!! Implement new features and commands into `promptTemplateParameterJsonToString`
+ * TODO: !!!! Implement new features and commands into `promptTemplateParameterJsonToString`
  * TODO: [🧠] Is there a way to auto-detect missing features in pipelineJsonToString
  * TODO: Escape all
  */

package/umd/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/umd/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/umd/typings/src/conversion/validation/validatePipeline.d.ts

@@ -25,3 +25,9 @@ export declare function validatePipeline(pipeline: PipelineJson): PipelineJson;
  *     >  * -   ...
  *     >  ex port function validatePipeline(promptbook: unknown): asserts promptbook is PipelineJson {
  */
+/**
+ * TODO: [🧠][🐣] !!!! Validate that all samples match expectations
+ * TODO: [🧠][🐣] !!!! Validate that knowledge is valid (non-void)
+ * TODO: [🧠] !!! Validationg not only logic itself but imports around - files and websites and rerefenced pipelines exists
+ * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
+ */

package/umd/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/{esm/typings/src/errors/VersionMismatch.d.ts → umd/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/umd/typings/src/execution/CommonExecutionToolsOptions.d.ts

@@ -5,5 +5,6 @@ export type CommonExecutionToolsOptions = {
     readonly isVerbose?: boolean;
 };
 /**
+ * TODO: [🈁] Maybe add here `isDeterministic`
  * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
  */

package/umd/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/umd/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/umd/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/umd/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/umd/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/umd/typings/src/formats/csv/ListFormatDefinition.d.ts

@@ -8,4 +8,5 @@ export declare const CsvFormatDefinition: FormatDefinition<string, string, objec
  * TODO: [🍓] In `CsvFormatDefinition` implement partial `canBeValid`
  * TODO: [🍓] In `CsvFormatDefinition` implement `heal
  * TODO: [🍓] In `CsvFormatDefinition` implement `extractValues`
+ * TODO: [🏢] Allow to expect something inside CSV objects and other formats
  */

package/umd/typings/src/formats/json/JsonFormatDefinition.d.ts

@@ -12,4 +12,5 @@ export declare const JsonFormatDefinition: FormatDefinition<string, string, obje
  * TODO: [🍓] In `JsonFormatDefinition` implement partial `canBeValid`
  * TODO: [🍓] In `JsonFormatDefinition` implement `heal
  * TODO: [🍓] In `JsonFormatDefinition` implement `extractValues`
+ * TODO: [🏢] Allow to expect something inside JSON objects and other formats
  */

package/umd/typings/src/formats/list/ListFormatDefinition.d.ts

@@ -10,4 +10,5 @@ export declare const ListFormatDefinition: FormatDefinition<string, string, obje
  * TODO: [🍓] In `ListFormatDefinition` implement partial `canBeValid`
  * TODO: [🍓] In `ListFormatDefinition` implement `heal
  * TODO: [🍓] In `ListFormatDefinition` implement `extractValues`
+ * TODO: [🏢] Allow to expect something inside each item of list and other formats
  */

package/umd/typings/src/formats/xml/XmlFormatDefinition.d.ts

@@ -12,4 +12,5 @@ export declare const XmlFormatDefinition: FormatDefinition<string, string, objec
  * TODO: [🍓] In `XmlFormatDefinition` implement partial `canBeValid`
  * TODO: [🍓] In `XmlFormatDefinition` implement `heal
  * TODO: [🍓] In `XmlFormatDefinition` implement `extractValues`
+ * TODO: [🏢] Allow to expect something inside XML and other formats
  */

package/umd/typings/src/knowledge/dialogs/simple-prompt/SimplePromptInterfaceTools.d.ts

@@ -15,3 +15,6 @@ export declare class SimplePromptInterfaceTools implements UserInterfaceTools {
      */
     promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
 }
+/**
+ * Note: [🔵] This code should never be published outside of `@promptbook/browser`
+ */ 

package/umd/typings/src/knowledge/prepare-knowledge/_common/prepareKnowledgePieces.d.ts

@@ -5,10 +5,10 @@ import type { KnowledgeSourceJson } from '../../../types/PipelineJson/KnowledgeS
  * Prepares the knowle
  *
  * @see https://github.com/webgptorg/promptbook/discussions/41
- * @private within the package
  */
 export declare function prepareKnowledgePieces(knowledgeSources: Array<KnowledgeSourceJson>, options: PrepareOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'preparationIds'>>>;
 /**
+ * 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,_]]

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

@@ -6,6 +6,7 @@ import type { string_markdown } from '../../../types/typeAliases';
  */
 export declare function prepareKnowledgeFromMarkdown(content: string_markdown, options: PrepareOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>>>;
 /**
+ * TODO: [🔼] !!! Export via `@promptbook/markdown`
  * TODO: [🪂] Do it in parallel 11:11
  * Note: No need to aggregate usage here, it is done by intercepting the llmTools
  */

package/umd/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/umd/typings/src/knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.d.ts

@@ -6,6 +6,7 @@ import type { string_base64 } from '../../../types/typeAliases';
  */
 export declare function prepareKnowledgeFromPdf(content: string_base64, options: PrepareOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>>>;
 /**
+ * TODO: [🔼] !!! Export via `@promptbook/pdf`
  * TODO: [🧺] In future, content can be alse File or Blob BUT for now for wider compatibility its only base64
  *       @see https://stackoverflow.com/questions/14653349/node-js-cant-create-blobs
  * TODO: [🪂] Do it in parallel

package/umd/typings/src/llm-providers/_common/createLlmToolsFromEnv.d.ts

@@ -0,0 +1,22 @@
+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 via `@promptbook/node`
+ * 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
+ * Note: [🟢] This code should never be published outside of `@promptbook/node`
+ */

package/umd/typings/src/llm-providers/_common/getLlmToolsForCli.d.ts

@@ -0,0 +1,10 @@
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+/**
+ * Returns LLM tools for CLI
+ *
+ * @private within the repository - for CLI utils
+ */
+export declare function getLlmToolsForCli(): LlmExecutionTools;
+/**
+ * Note: [🟡] This code should never be published outside of `@promptbook/cli`
+ */

package/umd/typings/src/llm-providers/_common/getLlmToolsForTestingAndScriptsAndPlayground.d.ts

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

package/umd/typings/src/llm-providers/_common/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/umd/typings/src/llm-providers/_common/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/umd/typings/src/llm-providers/_common/utils/cache/cacheLlmTools.d.ts

@@ -0,0 +1,16 @@
+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 via `@promptbook/core`
+ * 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/umd/typings/src/llm-providers/_common/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/umd/typings/src/llm-providers/_common/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 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
+ */

package/umd/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts

@@ -45,4 +45,5 @@ export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools
  * TODO: [🧠] Maybe handle errors via transformAnthropicError (like transformAzureError)
  * TODO: Maybe Create some common util for callChatModel and callCompletionModel
  * TODO: Maybe make custom OpenaiError
+ * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
  */

package/umd/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts

@@ -15,7 +15,7 @@ export declare const ANTHROPIC_CLAUDE_MODELS: Array<AvailableModel & {
 }>;
 /**
  * Note: [🤖] Add models of new variant
- * TODO: !!!! Add embedding models OR Anthropic has only chat+completion models?
+ * TODO: [🧠] !!! Add embedding models OR Anthropic has only chat+completion models?
  * TODO: [🧠] Some mechanism to propagate unsureness
  * TODO: [🧠][👮‍♀️] Put here more info like description, isVision, trainingDateCutoff, languages, strengths (	Top-level performance, intelligence, fluency, and understanding), contextWindow,...
  * TODO: [🕚] Make this list dynamic - dynamically can be listed modelNames but not modelVariant, legacy status, context length and pricing

package/umd/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/umd/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts

@@ -44,4 +44,5 @@ export declare class AzureOpenAiExecutionTools implements LlmExecutionTools {
 /**
  * TODO: Maybe Create some common util for callChatModel and callCompletionModel
  * TODO: Maybe make custom AzureOpenaiError
+ * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
  */

package/umd/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/umd/typings/src/llm-providers/langtail/LangtailExecutionTools.d.ts

@@ -10,3 +10,6 @@ export declare class LangtailExecutionTools extends OpenAiExecutionTools impleme
     get title(): string_title & string_markdown_text;
     get description(): string_markdown;
 }
+/**
+ * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
+ */ 

package/umd/typings/src/llm-providers/langtail/LangtailExecutionToolsOptions.d.ts

@@ -7,5 +7,5 @@ import type { OpenAiExecutionToolsOptions } from '../openai/OpenAiExecutionTools
  */
 export type LangtailExecutionToolsOptions = OpenAiExecutionToolsOptions;
 /**
- * TODO: !!! Use or remove
+ * TODO: !! Use or remove
  */