@promptbook/types 0.46.0 → 0.47.0

package/README.md

@@ -5,9 +5,13 @@ Library to supercharge your use of large language models
 
 
 
-[![License of 📖 Prompt book](https://img.shields.io/github/license/webgptorg/promptbook.svg?style=flat)](https://github.com/webgptorg/promptbook/blob/main/LICENSE)
+
+[![NPM Version of ![Promptbook logo - cube with letters P and B](./other/design/logo-h1.png) Promptbook](https://badge.fury.io/js/promptbook.svg)](https://www.npmjs.com/package/promptbook)
+[![Quality of package ![Promptbook logo - cube with letters P and B](./other/design/logo-h1.png) Promptbook](https://packagequality.com/shield/promptbook.svg)](https://packagequality.com/#?package=promptbook)
 [![Known Vulnerabilities](https://snyk.io/test/github/webgptorg/promptbook/badge.svg)](https://snyk.io/test/github/webgptorg/promptbook)
 [![Issues](https://img.shields.io/github/issues/webgptorg/promptbook.svg?style=flat)](https://github.com/webgptorg/promptbook/issues)
+[![Socket](https://socket.dev/api/badge/npm/package/promptbook)](https://socket.dev/npm/package/promptbook)
+
 [![Socket Badge](https://socket.dev/api/badge/npm/package/@promptbook/types)](https://socket.dev/npm/package/@promptbook/types)
 
 
@@ -464,22 +468,24 @@ For example:
 
 ### Execution Tools
 
+
+
 `ExecutionTools` is an interface which contains all the tools needed to execute prompts.
 It contais 3 subtools:
 
--   `NaturalExecutionTools`
+-   `LlmExecutionTools`
 -   `ScriptExecutionTools`
 -   `UserInterfaceTools`
 
 Which are described below:
 
-#### Natural Execution Tools
+#### LLM Execution Tools
 
-`NaturalExecutionTools` is a container for all the tools needed to execute prompts to large language models like GPT-4.
+`LlmExecutionTools` is a container for all the tools needed to execute prompts to large language models like GPT-4.
 On its interface it exposes common methods for prompt execution.
 Internally it calls OpenAI, Azure, GPU, proxy, cache, logging,...
 
-`NaturalExecutionTools` an abstract interface that is implemented by concrete execution tools:
+`LlmExecutionTools` an abstract interface that is implemented by concrete execution tools:
 
 -   `OpenAiExecutionTools`
 -   _(Not implemented yet)_ `AnthropicClaudeExecutionTools`
@@ -487,9 +493,9 @@ Internally it calls OpenAI, Azure, GPU, proxy, cache, logging,...
 -   _(Not implemented yet)_ `BardExecutionTools`
 -   _(Not implemented yet)_ `LamaExecutionTools`
 -   _(Not implemented yet)_ `GpuExecutionTools`
--   And a special case are `RemoteNaturalExecutionTools` that connect to a remote server and run one of the above execution tools on that server.
--   The second special case is `MockedEchoNaturalExecutionTools` that is used for testing and mocking.
--   The third special case is `LogNaturalExecutionToolsWrapper` that is technically also an execution tools but it is more proxy wrapper around other execution tools that logs all calls to execution tools.
+-   And a special case are `RemoteLlmExecutionTools` that connect to a remote server and run one of the above execution tools on that server.
+-   The second special case is `MockedEchoLlmExecutionTools` that is used for testing and mocking.
+-   The third special case is `LogLlmExecutionToolsWrapper` that is technically also an execution tools but it is more proxy wrapper around other execution tools that logs all calls to execution tools.
 
 #### Script Execution Tools
 
@@ -686,6 +692,10 @@ See [CHANGELOG.md](./CHANGELOG.md)
 
 <p xmlns:cc="http://creativecommons.org/ns#" xmlns:dct="http://purl.org/dc/terms/"><a property="dct:title" rel="cc:attributionURL" href="https://github.com/webgptorg/promptbook">Promptbook</a> by <a rel="cc:attributionURL dct:creator" property="cc:attributionName" href="https://github.com/hejny/">Pavol Hejný</a> is licensed under <a href="https://creativecommons.org/licenses/by/4.0/?ref=chooser-v1" target="_blank" rel="license noopener noreferrer" style="display:inline-block;">CC BY 4.0</a></p>
 
+## 🎯 Todos
+
+See [TODO.md](./TODO.md)
+
 
 
 

package/esm/typings/_packages/langtail.index.d.ts

@@ -1,3 +1,3 @@
-import { LangtailExecutionTools } from '../execution/plugins/natural-execution-tools/langtail/LangtailExecutionTools';
-import { LangtailExecutionToolsOptions } from '../execution/plugins/natural-execution-tools/langtail/LangtailExecutionToolsOptions';
+import { LangtailExecutionTools } from '../execution/plugins/llm-execution-tools/langtail/LangtailExecutionTools';
+import { LangtailExecutionToolsOptions } from '../execution/plugins/llm-execution-tools/langtail/LangtailExecutionToolsOptions';
 export { LangtailExecutionTools, LangtailExecutionToolsOptions };

package/esm/typings/_packages/mock.index.d.ts

@@ -1,6 +1,6 @@
-import { MockedEchoNaturalExecutionTools } from '../execution/plugins/natural-execution-tools/mocked/MockedEchoNaturalExecutionTools';
-import { MockedFackedNaturalExecutionTools } from '../execution/plugins/natural-execution-tools/mocked/MockedFackedNaturalExecutionTools';
-export { MockedEchoNaturalExecutionTools, MockedFackedNaturalExecutionTools };
+import { MockedEchoLlmExecutionTools } from '../execution/plugins/llm-execution-tools/mocked/MockedEchoLlmExecutionTools';
+import { MockedFackedLlmExecutionTools } from '../execution/plugins/llm-execution-tools/mocked/MockedFackedLlmExecutionTools';
+export { MockedEchoLlmExecutionTools, MockedFackedLlmExecutionTools };
 /**
  * TODO: [🚏] FakeLLM
  */

package/esm/typings/_packages/openai.index.d.ts

@@ -1,3 +1,3 @@
-import { OpenAiExecutionTools } from '../execution/plugins/natural-execution-tools/openai/OpenAiExecutionTools';
-import { OpenAiExecutionToolsOptions } from '../execution/plugins/natural-execution-tools/openai/OpenAiExecutionToolsOptions';
+import { OpenAiExecutionTools } from '../execution/plugins/llm-execution-tools/openai/OpenAiExecutionTools';
+import { OpenAiExecutionToolsOptions } from '../execution/plugins/llm-execution-tools/openai/OpenAiExecutionToolsOptions';
 export { OpenAiExecutionTools, OpenAiExecutionToolsOptions };

package/esm/typings/_packages/remote-client.index.d.ts

@@ -1,4 +1,4 @@
-import { RemoteServerOptions } from '../execution/plugins/natural-execution-tools/remote/interfaces/RemoteServerOptions';
-import { RemoteNaturalExecutionTools } from '../execution/plugins/natural-execution-tools/remote/RemoteNaturalExecutionTools';
-import { RemoteNaturalExecutionToolsOptions } from '../execution/plugins/natural-execution-tools/remote/RemoteNaturalExecutionToolsOptions';
-export { RemoteNaturalExecutionTools, RemoteNaturalExecutionToolsOptions, RemoteServerOptions };
+import { RemoteServerOptions } from '../execution/plugins/llm-execution-tools/remote/interfaces/RemoteServerOptions';
+import { RemoteLlmExecutionTools } from '../execution/plugins/llm-execution-tools/remote/RemoteLlmExecutionTools';
+import { RemoteLlmExecutionToolsOptions } from '../execution/plugins/llm-execution-tools/remote/RemoteLlmExecutionToolsOptions';
+export { RemoteLlmExecutionTools, RemoteLlmExecutionToolsOptions, RemoteServerOptions };

package/esm/typings/_packages/remote-server.index.d.ts

@@ -1,3 +1,3 @@
-import { RemoteServerOptions } from '../execution/plugins/natural-execution-tools/remote/interfaces/RemoteServerOptions';
-import { startRemoteServer } from '../execution/plugins/natural-execution-tools/remote/startRemoteServer';
+import { RemoteServerOptions } from '../execution/plugins/llm-execution-tools/remote/interfaces/RemoteServerOptions';
+import { startRemoteServer } from '../execution/plugins/llm-execution-tools/remote/startRemoteServer';
 export { RemoteServerOptions, startRemoteServer };

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

@@ -1,6 +1,6 @@
 import type { CommonExecutionToolsOptions } from '../execution/CommonExecutionToolsOptions';
 import type { ExecutionTools } from '../execution/ExecutionTools';
-import type { NaturalExecutionTools } from '../execution/NaturalExecutionTools';
+import type { LlmExecutionTools } from '../execution/LlmExecutionTools';
 import type { PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptResult } from '../execution/PromptResult';
 import type { PromptbookExecutor } from '../execution/PromptbookExecutor';
 import type { ScriptExecutionTools, ScriptExecutionToolsExecuteOptions } from '../execution/ScriptExecutionTools';
@@ -20,7 +20,7 @@ import type { ExecutionReportJson } from '../types/execution-report/ExecutionRep
 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_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_prompt, string_promptbook_url, string_promptbook_url_with_hashtemplate, string_script, 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_version } from '../types/typeAliases';
 import { FromtoItems } from '../utils/FromtoItems';
-export { CommonExecutionToolsOptions, EXPECTATION_UNITS, ExecutionReportJson, ExecutionTools, ExecutionType, ExpectationAmount, ExpectationUnit, FromtoItems, ModelRequirements, ModelVariant, NaturalExecutionTools, Parameters, Prompt, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptResult, PromptTemplateJson, PromptTemplateParameterJson, PromptbookExecutor, PromptbookJson, PromptbookLibrary, PromptbookString, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptLanguage, TaskProgress, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, client_id, string_char, string_char_emoji, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, 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_prompt, string_promptbook_url, string_promptbook_url_with_hashtemplate, string_script, 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_version, };
+export { client_id, CommonExecutionToolsOptions, ExecutionReportJson, ExecutionTools, ExecutionType, EXPECTATION_UNITS, ExpectationAmount, ExpectationUnit, FromtoItems, LlmExecutionTools as LlmExecutionTools, ModelRequirements, ModelVariant, Parameters, Prompt, PromptbookExecutor, PromptbookJson, PromptbookLibrary, PromptbookString, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptResult, PromptTemplateJson, PromptTemplateParameterJson, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptLanguage, string_char, string_char_emoji, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, 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_prompt, string_promptbook_url, string_promptbook_url_with_hashtemplate, string_script, 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_version, TaskProgress, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, };
 /**
  * TODO: [🧠][🆔] Is this the best package to export custom errors from?
  * TODO: Delete type aliases (from ../types/typeAliases) that are not exported here

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

@@ -1,5 +1,6 @@
 import { spaceTrim } from 'spacetrim';
 import { prettifyPromptbookString } from '../conversion/prettify/prettifyPromptbookString';
+import { renderPromptbookMermaid } from '../conversion/prettify/renderPromptbookMermaid';
 import { parseNumber } from '../conversion/utils/parseNumber';
 import { assertsExecutionSuccessful } from '../execution/assertsExecutionSuccessful';
 import { checkExpectations, isPassingExpectations } from '../execution/utils/checkExpectations';
@@ -56,6 +57,7 @@ export declare const normalizeTo: {
     'kebab-case': typeof normalizeToKebabCase;
 };
 export { capitalize, decapitalize, DIACRITIC_VARIANTS_LETTERS, IKeywords, isValidKeyword, nameToUriPart, nameToUriParts, normalizeTo_camelCase, normalizeTo_PascalCase, normalizeTo_SCREAMING_CASE, normalizeTo_snake_case, normalizeToKebabCase, normalizeWhitespaces, parseKeywords, parseKeywordsFromString, removeDiacritics, searchKeywords, string_keyword, };
+export { renderPromptbookMermaid };
 /**
  * TODO: [🧠] Maybe create some indipendent package like `markdown-tools` from both here exported and @private utilities
  * Note: [🕙] It does not make sence to have simple lower / UPPER case normalization

package/esm/typings/conversion/prettify/PrettifyOptions.d.ts

@@ -1,7 +1,13 @@
+/**
+ * Options for `prettifyPromptbookString` function
+ */
 export type PrettifyOptions = {
+    /***
+     * If true, adds Mermaid graph to the Promptbook string
+     */
     isGraphAdded?: boolean;
+    /**
+     * If true, the string is prettifyed as markdown
+     */
     isPrettifyed?: boolean;
 };
-/**
- * TODO: !!! Annotate all
- */

package/esm/typings/conversion/prettify/prettifyPromptbookString.d.ts

@@ -1,7 +1,7 @@
 import { PromptbookString } from '../../types/PromptbookString';
 import type { PrettifyOptions } from './PrettifyOptions';
 /**
- * !!!
+ * Prettyfies Promptbook string and adds Mermaid graph
  */
 export declare function prettifyPromptbookString(promptbookString: PromptbookString, options: PrettifyOptions): PromptbookString;
 /**

package/esm/typings/conversion/prettify/renderPromptbookMermaid.d.ts

@@ -0,0 +1,11 @@
+import { PromptbookJson } from '../../_packages/types.index';
+/**
+ * Creates a Mermaid graph based on the promptbook
+ *
+ * Note: The result is not wrapped in a Markdown code block
+ */
+export declare function renderPromptbookMermaid(promptbookJson: PromptbookJson): string;
+/**
+ * TODO: Maybe use some Mermaid library instead of string templating
+ * TODO: [🕌] When more than 2 functionalities, split into separate functions
+ */

package/esm/typings/execution/ExecutionTools.d.ts

@@ -1,4 +1,4 @@
-import type { NaturalExecutionTools } from './NaturalExecutionTools';
+import type { LlmExecutionTools } from './LlmExecutionTools';
 import type { ScriptExecutionTools } from './ScriptExecutionTools';
 import type { UserInterfaceTools } from './UserInterfaceTools';
 /**
@@ -10,7 +10,7 @@ export type ExecutionTools = {
     /**
      * Tools for executing prompts to large language models like GPT-4
      */
-    natural: NaturalExecutionTools;
+    llm: LlmExecutionTools;
     /**
      * Tools for executing scripts
      *
@@ -23,3 +23,6 @@ export type ExecutionTools = {
      */
     userInterface: UserInterfaceTools;
 };
+/**
+ * TODO: !!!! Allow more
+ */

package/esm/typings/execution/{NaturalExecutionTools.d.ts → LlmExecutionTools.d.ts}

@@ -5,9 +5,9 @@ import type { PromptChatResult, PromptCompletionResult } from './PromptResult';
  * On its interface it exposes common methods for prompt execution.
  * Inside (in constructor) it calls OpenAI, Azure, GPU, proxy, cache, logging,...
  *
- * @see https://github.com/webgptorg/promptbook#natural-execution-tools
+ * @see https://github.com/webgptorg/promptbook#llm-execution-tools
  */
-export type NaturalExecutionTools = {
+export type LlmExecutionTools = {
     /**
      * Use a chat model
      */

package/{umd/typings/execution/plugins/natural-execution-tools → esm/typings/execution/plugins/llm-execution-tools}/langtail/LangtailExecutionTools.d.ts

@@ -1,9 +1,9 @@
-import type { NaturalExecutionTools } from '../../../NaturalExecutionTools';
+import type { LlmExecutionTools } from '../../../LlmExecutionTools';
 import { OpenAiExecutionTools } from '../openai/OpenAiExecutionTools';
 /**
  * Execution Tools for calling OpenAI API.
  */
-export declare class LangtailExecutionTools extends OpenAiExecutionTools implements NaturalExecutionTools {
+export declare class LangtailExecutionTools extends OpenAiExecutionTools implements LlmExecutionTools {
 }
 /**
  * TODO: !!! Make lib which exports this

package/{umd/typings/execution/plugins/natural-execution-tools/mocked/MockedEchoNaturalExecutionTools.d.ts → esm/typings/execution/plugins/llm-execution-tools/mocked/MockedEchoLlmExecutionTools.d.ts}

@@ -1,11 +1,11 @@
 import { Prompt } from '../../../../types/Prompt';
 import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
-import { NaturalExecutionTools } from '../../../NaturalExecutionTools';
+import { LlmExecutionTools } from '../../../LlmExecutionTools';
 import { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
 /**
  * Mocked execution Tools for just echoing the requests for testing purposes.
  */
-export declare class MockedEchoNaturalExecutionTools implements NaturalExecutionTools {
+export declare class MockedEchoLlmExecutionTools implements LlmExecutionTools {
     private readonly options;
     constructor(options: CommonExecutionToolsOptions);
     /**

package/{umd/typings/execution/plugins/natural-execution-tools/mocked/MockedFackedNaturalExecutionTools.d.ts → esm/typings/execution/plugins/llm-execution-tools/mocked/MockedFackedLlmExecutionTools.d.ts}

@@ -1,11 +1,11 @@
 import { Prompt } from '../../../../types/Prompt';
 import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
-import { NaturalExecutionTools } from '../../../NaturalExecutionTools';
+import { LlmExecutionTools } from '../../../LlmExecutionTools';
 import { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
 /**
  * Mocked execution Tools for just faking expected responses for testing purposes
  */
-export declare class MockedFackedNaturalExecutionTools implements NaturalExecutionTools {
+export declare class MockedFackedLlmExecutionTools implements LlmExecutionTools {
     private readonly options;
     constructor(options: CommonExecutionToolsOptions);
     /**

package/{umd/typings/execution/plugins/natural-execution-tools → esm/typings/execution/plugins/llm-execution-tools}/mocked/fakeTextToExpectations.d.ts

@@ -6,7 +6,7 @@ import { PostprocessingFunction } from '../../script-execution-tools/javascript/
  * Note: You can provide postprocessing functions to modify the text before checking the expectations
  *       The result will be the text BEFORE the postprocessing
  *
- * @private internal util for MockedFackedNaturalExecutionTools
+ * @private internal util for MockedFackedLlmExecutionTools
  */
 export declare function $fakeTextToExpectations(expectations: Expectations, postprocessing?: Array<PostprocessingFunction>): Promise<string>;
 /**

package/esm/typings/execution/plugins/{natural-execution-tools → llm-execution-tools}/openai/OpenAiExecutionTools.d.ts

@@ -1,11 +1,11 @@
 import type { Prompt } from '../../../../types/Prompt';
-import type { NaturalExecutionTools } from '../../../NaturalExecutionTools';
+import type { LlmExecutionTools } from '../../../LlmExecutionTools';
 import type { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
 import type { OpenAiExecutionToolsOptions } from './OpenAiExecutionToolsOptions';
 /**
  * Execution Tools for calling OpenAI API.
  */
-export declare class OpenAiExecutionTools implements NaturalExecutionTools {
+export declare class OpenAiExecutionTools implements LlmExecutionTools {
     private readonly options;
     /**
      * OpenAI API client.

package/esm/typings/execution/plugins/{natural-execution-tools/remote/RemoteNaturalExecutionTools.d.ts → llm-execution-tools/remote/RemoteLlmExecutionTools.d.ts}

@@ -1,7 +1,7 @@
 import { Prompt } from '../../../../types/Prompt';
-import { NaturalExecutionTools } from '../../../NaturalExecutionTools';
+import { LlmExecutionTools } from '../../../LlmExecutionTools';
 import { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
-import { RemoteNaturalExecutionToolsOptions } from './RemoteNaturalExecutionToolsOptions';
+import { RemoteLlmExecutionToolsOptions } from './RemoteLlmExecutionToolsOptions';
 /**
  * Remote server is a proxy server that uses its execution tools internally and exposes the executor interface externally.
  *
@@ -10,9 +10,9 @@ import { RemoteNaturalExecutionToolsOptions } from './RemoteNaturalExecutionTool
  *
  * @see https://github.com/webgptorg/promptbook#remote-server
  */
-export declare class RemoteNaturalExecutionTools implements NaturalExecutionTools {
+export declare class RemoteLlmExecutionTools implements LlmExecutionTools {
     private readonly options;
-    constructor(options: RemoteNaturalExecutionToolsOptions);
+    constructor(options: RemoteLlmExecutionToolsOptions);
     /**
      * Creates a connection to the remote proxy server.
      */
@@ -31,5 +31,5 @@ export declare class RemoteNaturalExecutionTools implements NaturalExecutionTool
     private gptCommon;
 }
 /**
- * TODO: [🤹‍♂️] RemoteNaturalExecutionTools should extend Destroyable and implement IDestroyable
+ * TODO: [🤹‍♂️] RemoteLlmExecutionTools should extend Destroyable and implement IDestroyable
  */

package/esm/typings/execution/plugins/{natural-execution-tools/remote/RemoteNaturalExecutionToolsOptions.d.ts → llm-execution-tools/remote/RemoteLlmExecutionToolsOptions.d.ts}

@@ -1,9 +1,9 @@
-import type { client_id, string_uri } from '../../../.././types/typeAliases';
+import type { client_id, string_uri } from '../../../../types/typeAliases';
 import type { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
 /**
- * Options for RemoteNaturalExecutionTools
+ * Options for RemoteLlmExecutionTools
  */
-export type RemoteNaturalExecutionToolsOptions = CommonExecutionToolsOptions & {
+export type RemoteLlmExecutionToolsOptions = CommonExecutionToolsOptions & {
     /**
      * URL of the remote PROMPTBOOK server
      * On this server will be connected to the socket.io server

package/{umd/typings/execution/plugins/natural-execution-tools → esm/typings/execution/plugins/llm-execution-tools}/remote/interfaces/RemoteServerOptions.d.ts

@@ -1,7 +1,7 @@
 import type { PromptbookLibrary } from '../../../../../library/PromptbookLibrary';
 import type { client_id, string_uri } from '../../../../../types/typeAliases';
 import type { CommonExecutionToolsOptions } from '../../../../CommonExecutionToolsOptions';
-import type { NaturalExecutionTools } from '../../../../NaturalExecutionTools';
+import type { LlmExecutionTools } from '../../../../LlmExecutionTools';
 export type RemoteServerOptions = CommonExecutionToolsOptions & {
     /**
      * Port on which the server will listen
@@ -21,7 +21,7 @@ export type RemoteServerOptions = CommonExecutionToolsOptions & {
      */
     readonly library: PromptbookLibrary;
     /**
-     * Creates natural execution tools for each client
+     * Creates llm execution tools for each client
      */
-    createNaturalExecutionTools(clientId: client_id): NaturalExecutionTools;
+    createLlmExecutionTools(clientId: client_id): LlmExecutionTools;
 };

package/esm/typings/types/PromptbookJson/PromptTemplateJson.d.ts

@@ -6,11 +6,11 @@ import type { number_integer, number_positive_or_zero, string_javascript, string
 /**
  * Describes one prompt template in the promptbook
  */
-export type PromptTemplateJson = NaturalTemplateJson | SimpleTemplateJson | ScriptTemplateJson | PromptDialogJson;
+export type PromptTemplateJson = LlmTemplateJson | SimpleTemplateJson | ScriptTemplateJson | PromptDialogJson;
 /**
  * Template for prompt to LLM
  */
-export type NaturalTemplateJson = PromptTemplateJsonCommon & {
+export type LlmTemplateJson = PromptTemplateJsonCommon & {
     readonly executionType: 'PROMPT_TEMPLATE';
     /**
      * Requirements for the model

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/types",
-    "version": "0.46.0",
+    "version": "0.47.0",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -34,8 +34,18 @@
     },
     "homepage": "https://www.npmjs.com/package/@promptbook/core",
     "dependencies": {},
+    "funding": [
+        {
+            "type": "individual",
+            "url": "https://buymeacoffee.com/hejny"
+        },
+        {
+            "type": "github",
+            "url": "https://github.com/webgptorg/promptbook/blob/main/README.md#%EF%B8%8F-contributing"
+        }
+    ],
     "peerDependencies": {
-        "@promptbook/core": "0.46.0"
+        "@promptbook/core": "0.47.0"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",

package/umd/typings/_packages/langtail.index.d.ts

@@ -1,3 +1,3 @@
-import { LangtailExecutionTools } from '../execution/plugins/natural-execution-tools/langtail/LangtailExecutionTools';
-import { LangtailExecutionToolsOptions } from '../execution/plugins/natural-execution-tools/langtail/LangtailExecutionToolsOptions';
+import { LangtailExecutionTools } from '../execution/plugins/llm-execution-tools/langtail/LangtailExecutionTools';
+import { LangtailExecutionToolsOptions } from '../execution/plugins/llm-execution-tools/langtail/LangtailExecutionToolsOptions';
 export { LangtailExecutionTools, LangtailExecutionToolsOptions };

package/umd/typings/_packages/mock.index.d.ts

@@ -1,6 +1,6 @@
-import { MockedEchoNaturalExecutionTools } from '../execution/plugins/natural-execution-tools/mocked/MockedEchoNaturalExecutionTools';
-import { MockedFackedNaturalExecutionTools } from '../execution/plugins/natural-execution-tools/mocked/MockedFackedNaturalExecutionTools';
-export { MockedEchoNaturalExecutionTools, MockedFackedNaturalExecutionTools };
+import { MockedEchoLlmExecutionTools } from '../execution/plugins/llm-execution-tools/mocked/MockedEchoLlmExecutionTools';
+import { MockedFackedLlmExecutionTools } from '../execution/plugins/llm-execution-tools/mocked/MockedFackedLlmExecutionTools';
+export { MockedEchoLlmExecutionTools, MockedFackedLlmExecutionTools };
 /**
  * TODO: [🚏] FakeLLM
  */

package/umd/typings/_packages/openai.index.d.ts

@@ -1,3 +1,3 @@
-import { OpenAiExecutionTools } from '../execution/plugins/natural-execution-tools/openai/OpenAiExecutionTools';
-import { OpenAiExecutionToolsOptions } from '../execution/plugins/natural-execution-tools/openai/OpenAiExecutionToolsOptions';
+import { OpenAiExecutionTools } from '../execution/plugins/llm-execution-tools/openai/OpenAiExecutionTools';
+import { OpenAiExecutionToolsOptions } from '../execution/plugins/llm-execution-tools/openai/OpenAiExecutionToolsOptions';
 export { OpenAiExecutionTools, OpenAiExecutionToolsOptions };

package/umd/typings/_packages/remote-client.index.d.ts

@@ -1,4 +1,4 @@
-import { RemoteServerOptions } from '../execution/plugins/natural-execution-tools/remote/interfaces/RemoteServerOptions';
-import { RemoteNaturalExecutionTools } from '../execution/plugins/natural-execution-tools/remote/RemoteNaturalExecutionTools';
-import { RemoteNaturalExecutionToolsOptions } from '../execution/plugins/natural-execution-tools/remote/RemoteNaturalExecutionToolsOptions';
-export { RemoteNaturalExecutionTools, RemoteNaturalExecutionToolsOptions, RemoteServerOptions };
+import { RemoteServerOptions } from '../execution/plugins/llm-execution-tools/remote/interfaces/RemoteServerOptions';
+import { RemoteLlmExecutionTools } from '../execution/plugins/llm-execution-tools/remote/RemoteLlmExecutionTools';
+import { RemoteLlmExecutionToolsOptions } from '../execution/plugins/llm-execution-tools/remote/RemoteLlmExecutionToolsOptions';
+export { RemoteLlmExecutionTools, RemoteLlmExecutionToolsOptions, RemoteServerOptions };

package/umd/typings/_packages/remote-server.index.d.ts

@@ -1,3 +1,3 @@
-import { RemoteServerOptions } from '../execution/plugins/natural-execution-tools/remote/interfaces/RemoteServerOptions';
-import { startRemoteServer } from '../execution/plugins/natural-execution-tools/remote/startRemoteServer';
+import { RemoteServerOptions } from '../execution/plugins/llm-execution-tools/remote/interfaces/RemoteServerOptions';
+import { startRemoteServer } from '../execution/plugins/llm-execution-tools/remote/startRemoteServer';
 export { RemoteServerOptions, startRemoteServer };

package/umd/typings/_packages/types.index.d.ts

@@ -1,6 +1,6 @@
 import type { CommonExecutionToolsOptions } from '../execution/CommonExecutionToolsOptions';
 import type { ExecutionTools } from '../execution/ExecutionTools';
-import type { NaturalExecutionTools } from '../execution/NaturalExecutionTools';
+import type { LlmExecutionTools } from '../execution/LlmExecutionTools';
 import type { PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptResult } from '../execution/PromptResult';
 import type { PromptbookExecutor } from '../execution/PromptbookExecutor';
 import type { ScriptExecutionTools, ScriptExecutionToolsExecuteOptions } from '../execution/ScriptExecutionTools';
@@ -20,7 +20,7 @@ import type { ExecutionReportJson } from '../types/execution-report/ExecutionRep
 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_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_prompt, string_promptbook_url, string_promptbook_url_with_hashtemplate, string_script, 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_version } from '../types/typeAliases';
 import { FromtoItems } from '../utils/FromtoItems';
-export { CommonExecutionToolsOptions, EXPECTATION_UNITS, ExecutionReportJson, ExecutionTools, ExecutionType, ExpectationAmount, ExpectationUnit, FromtoItems, ModelRequirements, ModelVariant, NaturalExecutionTools, Parameters, Prompt, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptResult, PromptTemplateJson, PromptTemplateParameterJson, PromptbookExecutor, PromptbookJson, PromptbookLibrary, PromptbookString, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptLanguage, TaskProgress, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, client_id, string_char, string_char_emoji, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, 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_prompt, string_promptbook_url, string_promptbook_url_with_hashtemplate, string_script, 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_version, };
+export { client_id, CommonExecutionToolsOptions, ExecutionReportJson, ExecutionTools, ExecutionType, EXPECTATION_UNITS, ExpectationAmount, ExpectationUnit, FromtoItems, LlmExecutionTools as LlmExecutionTools, ModelRequirements, ModelVariant, Parameters, Prompt, PromptbookExecutor, PromptbookJson, PromptbookLibrary, PromptbookString, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptResult, PromptTemplateJson, PromptTemplateParameterJson, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptLanguage, string_char, string_char_emoji, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, 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_prompt, string_promptbook_url, string_promptbook_url_with_hashtemplate, string_script, 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_version, TaskProgress, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, };
 /**
  * TODO: [🧠][🆔] Is this the best package to export custom errors from?
  * TODO: Delete type aliases (from ../types/typeAliases) that are not exported here

package/umd/typings/_packages/utils.index.d.ts

@@ -1,5 +1,6 @@
 import { spaceTrim } from 'spacetrim';
 import { prettifyPromptbookString } from '../conversion/prettify/prettifyPromptbookString';
+import { renderPromptbookMermaid } from '../conversion/prettify/renderPromptbookMermaid';
 import { parseNumber } from '../conversion/utils/parseNumber';
 import { assertsExecutionSuccessful } from '../execution/assertsExecutionSuccessful';
 import { checkExpectations, isPassingExpectations } from '../execution/utils/checkExpectations';
@@ -56,6 +57,7 @@ export declare const normalizeTo: {
     'kebab-case': typeof normalizeToKebabCase;
 };
 export { capitalize, decapitalize, DIACRITIC_VARIANTS_LETTERS, IKeywords, isValidKeyword, nameToUriPart, nameToUriParts, normalizeTo_camelCase, normalizeTo_PascalCase, normalizeTo_SCREAMING_CASE, normalizeTo_snake_case, normalizeToKebabCase, normalizeWhitespaces, parseKeywords, parseKeywordsFromString, removeDiacritics, searchKeywords, string_keyword, };
+export { renderPromptbookMermaid };
 /**
  * TODO: [🧠] Maybe create some indipendent package like `markdown-tools` from both here exported and @private utilities
  * Note: [🕙] It does not make sence to have simple lower / UPPER case normalization

package/umd/typings/conversion/prettify/PrettifyOptions.d.ts

@@ -1,7 +1,13 @@
+/**
+ * Options for `prettifyPromptbookString` function
+ */
 export type PrettifyOptions = {
+    /***
+     * If true, adds Mermaid graph to the Promptbook string
+     */
     isGraphAdded?: boolean;
+    /**
+     * If true, the string is prettifyed as markdown
+     */
     isPrettifyed?: boolean;
 };
-/**
- * TODO: !!! Annotate all
- */

package/umd/typings/conversion/prettify/prettifyPromptbookString.d.ts

@@ -1,7 +1,7 @@
 import { PromptbookString } from '../../types/PromptbookString';
 import type { PrettifyOptions } from './PrettifyOptions';
 /**
- * !!!
+ * Prettyfies Promptbook string and adds Mermaid graph
  */
 export declare function prettifyPromptbookString(promptbookString: PromptbookString, options: PrettifyOptions): PromptbookString;
 /**

package/umd/typings/conversion/prettify/renderPromptbookMermaid.d.ts

@@ -0,0 +1,11 @@
+import { PromptbookJson } from '../../_packages/types.index';
+/**
+ * Creates a Mermaid graph based on the promptbook
+ *
+ * Note: The result is not wrapped in a Markdown code block
+ */
+export declare function renderPromptbookMermaid(promptbookJson: PromptbookJson): string;
+/**
+ * TODO: Maybe use some Mermaid library instead of string templating
+ * TODO: [🕌] When more than 2 functionalities, split into separate functions
+ */

package/umd/typings/execution/ExecutionTools.d.ts

@@ -1,4 +1,4 @@
-import type { NaturalExecutionTools } from './NaturalExecutionTools';
+import type { LlmExecutionTools } from './LlmExecutionTools';
 import type { ScriptExecutionTools } from './ScriptExecutionTools';
 import type { UserInterfaceTools } from './UserInterfaceTools';
 /**
@@ -10,7 +10,7 @@ export type ExecutionTools = {
     /**
      * Tools for executing prompts to large language models like GPT-4
      */
-    natural: NaturalExecutionTools;
+    llm: LlmExecutionTools;
     /**
      * Tools for executing scripts
      *
@@ -23,3 +23,6 @@ export type ExecutionTools = {
      */
     userInterface: UserInterfaceTools;
 };
+/**
+ * TODO: !!!! Allow more
+ */

package/umd/typings/execution/{NaturalExecutionTools.d.ts → LlmExecutionTools.d.ts}

@@ -5,9 +5,9 @@ import type { PromptChatResult, PromptCompletionResult } from './PromptResult';
  * On its interface it exposes common methods for prompt execution.
  * Inside (in constructor) it calls OpenAI, Azure, GPU, proxy, cache, logging,...
  *
- * @see https://github.com/webgptorg/promptbook#natural-execution-tools
+ * @see https://github.com/webgptorg/promptbook#llm-execution-tools
  */
-export type NaturalExecutionTools = {
+export type LlmExecutionTools = {
     /**
      * Use a chat model
      */

package/{esm/typings/execution/plugins/natural-execution-tools → umd/typings/execution/plugins/llm-execution-tools}/langtail/LangtailExecutionTools.d.ts

@@ -1,9 +1,9 @@
-import type { NaturalExecutionTools } from '../../../NaturalExecutionTools';
+import type { LlmExecutionTools } from '../../../LlmExecutionTools';
 import { OpenAiExecutionTools } from '../openai/OpenAiExecutionTools';
 /**
  * Execution Tools for calling OpenAI API.
  */
-export declare class LangtailExecutionTools extends OpenAiExecutionTools implements NaturalExecutionTools {
+export declare class LangtailExecutionTools extends OpenAiExecutionTools implements LlmExecutionTools {
 }
 /**
  * TODO: !!! Make lib which exports this

package/{esm/typings/execution/plugins/natural-execution-tools/mocked/MockedEchoNaturalExecutionTools.d.ts → umd/typings/execution/plugins/llm-execution-tools/mocked/MockedEchoLlmExecutionTools.d.ts}

@@ -1,11 +1,11 @@
 import { Prompt } from '../../../../types/Prompt';
 import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
-import { NaturalExecutionTools } from '../../../NaturalExecutionTools';
+import { LlmExecutionTools } from '../../../LlmExecutionTools';
 import { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
 /**
  * Mocked execution Tools for just echoing the requests for testing purposes.
  */
-export declare class MockedEchoNaturalExecutionTools implements NaturalExecutionTools {
+export declare class MockedEchoLlmExecutionTools implements LlmExecutionTools {
     private readonly options;
     constructor(options: CommonExecutionToolsOptions);
     /**

package/{esm/typings/execution/plugins/natural-execution-tools/mocked/MockedFackedNaturalExecutionTools.d.ts → umd/typings/execution/plugins/llm-execution-tools/mocked/MockedFackedLlmExecutionTools.d.ts}

@@ -1,11 +1,11 @@
 import { Prompt } from '../../../../types/Prompt';
 import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
-import { NaturalExecutionTools } from '../../../NaturalExecutionTools';
+import { LlmExecutionTools } from '../../../LlmExecutionTools';
 import { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
 /**
  * Mocked execution Tools for just faking expected responses for testing purposes
  */
-export declare class MockedFackedNaturalExecutionTools implements NaturalExecutionTools {
+export declare class MockedFackedLlmExecutionTools implements LlmExecutionTools {
     private readonly options;
     constructor(options: CommonExecutionToolsOptions);
     /**

package/{esm/typings/execution/plugins/natural-execution-tools → umd/typings/execution/plugins/llm-execution-tools}/mocked/fakeTextToExpectations.d.ts

@@ -6,7 +6,7 @@ import { PostprocessingFunction } from '../../script-execution-tools/javascript/
  * Note: You can provide postprocessing functions to modify the text before checking the expectations
  *       The result will be the text BEFORE the postprocessing
  *
- * @private internal util for MockedFackedNaturalExecutionTools
+ * @private internal util for MockedFackedLlmExecutionTools
  */
 export declare function $fakeTextToExpectations(expectations: Expectations, postprocessing?: Array<PostprocessingFunction>): Promise<string>;
 /**

package/umd/typings/execution/plugins/{natural-execution-tools → llm-execution-tools}/openai/OpenAiExecutionTools.d.ts

@@ -1,11 +1,11 @@
 import type { Prompt } from '../../../../types/Prompt';
-import type { NaturalExecutionTools } from '../../../NaturalExecutionTools';
+import type { LlmExecutionTools } from '../../../LlmExecutionTools';
 import type { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
 import type { OpenAiExecutionToolsOptions } from './OpenAiExecutionToolsOptions';
 /**
  * Execution Tools for calling OpenAI API.
  */
-export declare class OpenAiExecutionTools implements NaturalExecutionTools {
+export declare class OpenAiExecutionTools implements LlmExecutionTools {
     private readonly options;
     /**
      * OpenAI API client.

package/umd/typings/execution/plugins/{natural-execution-tools/remote/RemoteNaturalExecutionTools.d.ts → llm-execution-tools/remote/RemoteLlmExecutionTools.d.ts}

@@ -1,7 +1,7 @@
 import { Prompt } from '../../../../types/Prompt';
-import { NaturalExecutionTools } from '../../../NaturalExecutionTools';
+import { LlmExecutionTools } from '../../../LlmExecutionTools';
 import { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
-import { RemoteNaturalExecutionToolsOptions } from './RemoteNaturalExecutionToolsOptions';
+import { RemoteLlmExecutionToolsOptions } from './RemoteLlmExecutionToolsOptions';
 /**
  * Remote server is a proxy server that uses its execution tools internally and exposes the executor interface externally.
  *
@@ -10,9 +10,9 @@ import { RemoteNaturalExecutionToolsOptions } from './RemoteNaturalExecutionTool
  *
  * @see https://github.com/webgptorg/promptbook#remote-server
  */
-export declare class RemoteNaturalExecutionTools implements NaturalExecutionTools {
+export declare class RemoteLlmExecutionTools implements LlmExecutionTools {
     private readonly options;
-    constructor(options: RemoteNaturalExecutionToolsOptions);
+    constructor(options: RemoteLlmExecutionToolsOptions);
     /**
      * Creates a connection to the remote proxy server.
      */
@@ -31,5 +31,5 @@ export declare class RemoteNaturalExecutionTools implements NaturalExecutionTool
     private gptCommon;
 }
 /**
- * TODO: [🤹‍♂️] RemoteNaturalExecutionTools should extend Destroyable and implement IDestroyable
+ * TODO: [🤹‍♂️] RemoteLlmExecutionTools should extend Destroyable and implement IDestroyable
  */

package/umd/typings/execution/plugins/{natural-execution-tools/remote/RemoteNaturalExecutionToolsOptions.d.ts → llm-execution-tools/remote/RemoteLlmExecutionToolsOptions.d.ts}

@@ -1,9 +1,9 @@
-import type { client_id, string_uri } from '../../../.././types/typeAliases';
+import type { client_id, string_uri } from '../../../../types/typeAliases';
 import type { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
 /**
- * Options for RemoteNaturalExecutionTools
+ * Options for RemoteLlmExecutionTools
  */
-export type RemoteNaturalExecutionToolsOptions = CommonExecutionToolsOptions & {
+export type RemoteLlmExecutionToolsOptions = CommonExecutionToolsOptions & {
     /**
      * URL of the remote PROMPTBOOK server
      * On this server will be connected to the socket.io server

package/{esm/typings/execution/plugins/natural-execution-tools → umd/typings/execution/plugins/llm-execution-tools}/remote/interfaces/RemoteServerOptions.d.ts

@@ -1,7 +1,7 @@
 import type { PromptbookLibrary } from '../../../../../library/PromptbookLibrary';
 import type { client_id, string_uri } from '../../../../../types/typeAliases';
 import type { CommonExecutionToolsOptions } from '../../../../CommonExecutionToolsOptions';
-import type { NaturalExecutionTools } from '../../../../NaturalExecutionTools';
+import type { LlmExecutionTools } from '../../../../LlmExecutionTools';
 export type RemoteServerOptions = CommonExecutionToolsOptions & {
     /**
      * Port on which the server will listen
@@ -21,7 +21,7 @@ export type RemoteServerOptions = CommonExecutionToolsOptions & {
      */
     readonly library: PromptbookLibrary;
     /**
-     * Creates natural execution tools for each client
+     * Creates llm execution tools for each client
      */
-    createNaturalExecutionTools(clientId: client_id): NaturalExecutionTools;
+    createLlmExecutionTools(clientId: client_id): LlmExecutionTools;
 };

package/umd/typings/types/PromptbookJson/PromptTemplateJson.d.ts

@@ -6,11 +6,11 @@ import type { number_integer, number_positive_or_zero, string_javascript, string
 /**
  * Describes one prompt template in the promptbook
  */
-export type PromptTemplateJson = NaturalTemplateJson | SimpleTemplateJson | ScriptTemplateJson | PromptDialogJson;
+export type PromptTemplateJson = LlmTemplateJson | SimpleTemplateJson | ScriptTemplateJson | PromptDialogJson;
 /**
  * Template for prompt to LLM
  */
-export type NaturalTemplateJson = PromptTemplateJsonCommon & {
+export type LlmTemplateJson = PromptTemplateJsonCommon & {
     readonly executionType: 'PROMPT_TEMPLATE';
     /**
      * Requirements for the model