@promptbook/types 0.8.0

package/esm/typings/utils/unwrapResult.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Removes quotes and optional introduce text from a string
+ *
+ * Tip: This is very usefull for post-processing of the result of the LLM model
+ * Note: This function trims the text and removes whole introduce sentence if it is present
+ * Note: There are two simmilar functions:
+ * - `removeQuotes` which removes only bounding quotes
+ * - `unwrapResult` which removes whole introduce sentence
+ *
+ * @param text optionally quoted text
+ * @returns text without quotes
+ */
+export declare function unwrapResult(text: string): string;

package/esm/typings/utils/unwrapResult.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/wizzard/Wizzard.d.ts

@@ -0,0 +1 @@
+export declare const Wizzard: any;

package/esm/typings/wizzard/sample.d.ts

@@ -0,0 +1,5 @@
+export {};
+/**
+url, sources nebo folder
+ * TODO: [🧠] OpenAi apiKey vs token
+ */

package/package.json

@@ -0,0 +1,43 @@
+{
+    "name": "@promptbook/types",
+    "version": "0.8.0",
+    "description": "Library to supercharge your use of large language models",
+    "private": false,
+    "sideEffects": false,
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/webgptorg/promptbook"
+    },
+    "contributors": [
+        "Pavol Hejný <me@pavolhejny.com> (https://www.pavolhejny.com/)"
+    ],
+    "keywords": [
+        "autogpt",
+        "openai",
+        "gpt-3",
+        "gpt-4",
+        "chatgpt",
+        "ai",
+        "machine-learning",
+        "natural-language-processing",
+        "nlp",
+        "prompt",
+        "template",
+        "pipeline",
+        "automation",
+        "text-generation",
+        "language-model"
+    ],
+    "license": "SEE LICENSE IN LICENSE",
+    "bugs": {
+        "url": "https://github.com/webgptorg/promptbook/issues"
+    },
+    "homepage": "https://www.npmjs.com/package/@promptbook/core",
+    "dependencies": {},
+    "peerDependencies": {
+        "@promptbook/core": "0.8.0"
+    },
+    "main": "./umd/index.umd.js",
+    "module": "./esm/index.es.js",
+    "typings": "./esm/typings/_packages/types.index.d.ts"
+}

package/umd/index.umd.js

@@ -0,0 +1,9 @@
+(function (factory) {
+	typeof define === 'function' && define.amd ? define(factory) :
+	factory();
+})((function () { 'use strict';
+
+
+
+}));
+//# sourceMappingURL=index.umd.js.map

package/umd/index.umd.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.umd.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;"}

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

@@ -0,0 +1,17 @@
+import { PromptTemplatePipeline } from '../classes/PromptTemplatePipeline';
+import { PromptTemplatePipelineLibrary } from '../classes/PromptTemplatePipelineLibrary';
+import { PTP_VERSION } from '../config';
+import { promptTemplatePipelineStringToJson } from '../conversion/promptTemplatePipelineStringToJson';
+import { validatePromptTemplatePipelineJson } from '../conversion/validatePromptTemplatePipelineJson';
+import { createPtpExecutor } from '../execution/createPtpExecutor';
+import { MockedEchoNaturalExecutionTools } from '../execution/plugins/natural-execution-tools/mocked/MockedEchoNaturalExecutionTools';
+import { CallbackInterfaceTools } from '../execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceTools';
+import { CallbackInterfaceToolsOptions } from '../execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceToolsOptions';
+import { SimplePromptInterfaceTools } from '../execution/plugins/user-interface-execution-tools/simple-prompt/SimplePromptInterfaceTools';
+import { ExecutionTypes } from '../types/ExecutionTypes';
+export { ExecutionTypes, PTP_VERSION, PromptTemplatePipeline, PromptTemplatePipelineLibrary };
+export { SimplePromptInterfaceTools };
+export { promptTemplatePipelineStringToJson, validatePromptTemplatePipelineJson };
+export { MockedEchoNaturalExecutionTools };
+export { createPtpExecutor };
+export { CallbackInterfaceTools, CallbackInterfaceToolsOptions };

package/umd/typings/_packages/execute-javascript.index.d.ts

@@ -0,0 +1,3 @@
+import { JavascriptEvalExecutionTools } from '../execution/plugins/script-execution-tools/javascript/JavascriptEvalExecutionTools';
+import { JavascriptExecutionTools } from '../execution/plugins/script-execution-tools/javascript/JavascriptExecutionTools';
+export { JavascriptEvalExecutionTools, JavascriptExecutionTools };

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

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

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

@@ -0,0 +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 };

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

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

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

@@ -0,0 +1,20 @@
+import { CommonExecutionToolsOptions } from '../execution/CommonExecutionToolsOptions';
+import { ExecutionTools } from '../execution/ExecutionTools';
+import { NaturalExecutionTools } from '../execution/NaturalExecutionTools';
+import { PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptResult } from '../execution/PromptResult';
+import { PtpExecutor } from '../execution/PtpExecutor';
+import { ScriptExecutionTools, ScriptExecutionToolsExecuteOptions } from '../execution/ScriptExecutionTools';
+import { UserInterfaceTools, UserInterfaceToolsPromptDialogOptions } from '../execution/UserInterfaceTools';
+import { ExecutionType } from '../types/ExecutionTypes';
+import { ModelRequirements, ModelVariant } from '../types/ModelRequirements';
+import { Parameters } from '../types/Parameters';
+import { Prompt } from '../types/Prompt';
+import { PromptTemplateJson } from '../types/PromptTemplatePipelineJson/PromptTemplateJson';
+import { PromptTemplateParameterJson } from '../types/PromptTemplatePipelineJson/PromptTemplateParameterJson';
+import { PromptTemplatePipelineJson } from '../types/PromptTemplatePipelineJson/PromptTemplatePipelineJson';
+import { PromptTemplatePipelineString } from '../types/PromptTemplatePipelineString';
+import { ScriptLanguage } from '../types/ScriptLanguage';
+import { DoneTaskProgress, PendingTaskProgress, TaskProgress } from '../types/TaskProgress';
+import { string_char_emoji } from '../types/typeAliasEmoji';
+import { ILicense, IPersonProfile, IRepository, number_bytes, number_days, number_gigabytes, number_hours, number_integer, number_kilobytes, number_likeness, number_megabytes, number_miliseconds, number_minutes, number_months, number_negative, number_percent, number_positive, number_seconds, number_terabytes, number_weeks, number_years, string_attribute, string_attribute_value_scope, string_business_category_name, string_char, string_chat_prompt, string_color, string_completion_prompt, string_css, string_css_class, string_css_cursor, string_css_property, string_css_selector, string_css_value, 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_image_prompt, string_javascript, string_javascript_name, string_license, string_license_token, string_markdown, string_markdown_text, string_midjourney_prompt, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_page, string_password, string_person_fullname, string_person_profile, string_pgp_key, string_prompt, string_protocol, string_ptp_url, string_ptp_url_with_hashtemplate, string_script, string_sha256, string_ssh_key, string_svg, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_translate_name, string_translate_name_not_normalized, string_uri, string_uri_part, string_uriid, string_url, string_url_image, string_version, string_version_dependency, string_wallpaper_id, string_xml, uuid, uuid_first_segment } from '../types/typeAliases';
+export { CommonExecutionToolsOptions, DoneTaskProgress, ExecutionTools, ExecutionType, ILicense, IPersonProfile, IRepository, ModelRequirements, ModelVariant, NaturalExecutionTools, Parameters, PendingTaskProgress, Prompt, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptResult, PromptTemplateJson, PromptTemplateParameterJson, PromptTemplatePipelineJson, PromptTemplatePipelineString, PtpExecutor, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptLanguage, TaskProgress, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, number_bytes, number_days, number_gigabytes, number_hours, number_integer, number_kilobytes, number_likeness, number_megabytes, number_miliseconds, number_minutes, number_months, number_negative, number_percent, number_positive, number_seconds, number_terabytes, number_weeks, number_years, string_attribute, string_attribute_value_scope, string_business_category_name, string_char, string_char_emoji, string_chat_prompt, string_color, string_completion_prompt, string_css, string_css_class, string_css_cursor, string_css_property, string_css_selector, string_css_value, 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_image_prompt, string_javascript, string_javascript_name, string_license, string_license_token, string_markdown, string_markdown_text, string_midjourney_prompt, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_page, string_password, string_person_fullname, string_person_profile, string_pgp_key, string_prompt, string_protocol, string_ptp_url, string_ptp_url_with_hashtemplate, string_script, string_sha256, string_ssh_key, string_svg, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_translate_name, string_translate_name_not_normalized, string_uri, string_uri_part, string_uriid, string_url, string_url_image, string_version, string_version_dependency, string_wallpaper_id, string_xml, uuid, uuid_first_segment, };

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

@@ -0,0 +1,6 @@
+import { removeContentComments } from '../utils/markdown/removeContentComments';
+import { removeMarkdownFormatting } from '../utils/markdown/removeMarkdownFormatting';
+import { removeEmojis } from '../utils/removeEmojis';
+import { removeQuotes } from '../utils/removeQuotes';
+import { unwrapResult } from '../utils/unwrapResult';
+export { removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, unwrapResult };

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

@@ -0,0 +1,2 @@
+import { Wizzard } from '../wizzard/Wizzard';
+export { Wizzard };

package/umd/typings/classes/PromptTemplatePipeline.d.ts

@@ -0,0 +1,68 @@
+import { string_name } from '.././types/typeAliases';
+import { PromptTemplateJson } from '../types/PromptTemplatePipelineJson/PromptTemplateJson';
+import { PromptTemplateParameterJson } from '../types/PromptTemplatePipelineJson/PromptTemplateParameterJson';
+import { PromptTemplatePipelineJson } from '../types/PromptTemplatePipelineJson/PromptTemplatePipelineJson';
+import { PromptTemplatePipelineString } from '../types/PromptTemplatePipelineString';
+/**
+ * Prompt template pipeline is the **core concept of this library**.
+ * It represents a series of prompt templates chained together to form a pipeline / one big prompt template with input and result parameters.
+ *
+ * It can have 3 formats:
+ * -   **.ptp.md file** in custom markdown format described above
+ * -   **JSON** format, parsed from the .ptp.md file
+ * -   _(this)_ **Object** which is created from JSON format and bound with tools around (but not the execution logic)
+ *
+ * @see https://github.com/webgptorg/promptbook#prompt-template-pipeline
+ */
+export declare class PromptTemplatePipeline {
+    readonly ptpUrl: URL | null;
+    readonly parameters: Record<string_name, PromptTemplateParameterJson>;
+    readonly promptTemplates: Array<PromptTemplateJson>;
+    /**
+     * Constructs PromptTemplatePipeline from any source
+     *
+     * Note: During the construction syntax and logic of source is validated
+     *
+     * @param source content of .ptp.md or .ptp.json file
+     * @returns PromptTemplatePipeline
+     */
+    static fromSource(ptpSource: PromptTemplatePipelineString | PromptTemplatePipelineJson): PromptTemplatePipeline;
+    /**
+     * Constructs PromptTemplatePipeline from markdown source
+     *
+     * Note: During the construction syntax and logic of source is validated
+     *
+     * @param ptpString content of .ptp.md file
+     * @returns PromptTemplatePipeline
+     */
+    static fromString(ptpString: PromptTemplatePipelineString): PromptTemplatePipeline;
+    /**
+     * Constructs PromptTemplatePipeline from JSON source
+     *
+     * Note: During the construction the source is logic validated
+     *
+     * @param ptpjson content of .ptp.json file parsed into JSON
+     * @returns PromptTemplatePipeline
+     */
+    static fromJson(ptpjson: PromptTemplatePipelineJson): PromptTemplatePipeline;
+    private constructor();
+    /**
+     * Returns the first prompt template in the pipeline
+     */
+    get entryPromptTemplate(): PromptTemplateJson;
+    /**
+     * Gets the parameter that is the result of given prompt template
+     */
+    getResultingParameter(promptTemplateName: string_name): PromptTemplateParameterJson;
+    /**
+     * Gets the following prompt template in the pipeline or null if there is no following prompt template and this is the last one
+     */
+    getFollowingPromptTemplate(promptTemplateName: string_name): PromptTemplateJson | null;
+}
+/**
+ * TODO: !! [👐][🧠] Split of PromptTemplatePipeline,PromptTemplatePipelineLibrary between interface and class
+ * TODO: !! [👐] Make parameters and promptTemplates private WHEN split between interface and class
+ * TODO: !! Add generic type for entry and result parameters
+ * TODO: Can be Array elegantly typed such as it must have at least one element?
+ * TODO: [🧠] Each PromptTemplatePipeline should have its unique hash to be able to compare them and execute on server ONLY the desired ones
+ */

package/umd/typings/classes/PromptTemplatePipelineLibrary.d.ts

@@ -0,0 +1,55 @@
+import { string_name } from '.././types/typeAliases';
+import { ExecutionTools } from '../execution/ExecutionTools';
+import { PtpExecutor } from '../execution/PtpExecutor';
+import { Prompt } from '../types/Prompt';
+import { PromptTemplatePipelineJson } from '../types/PromptTemplatePipelineJson/PromptTemplatePipelineJson';
+import { PromptTemplatePipelineString } from '../types/PromptTemplatePipelineString';
+import { PromptTemplatePipeline } from './PromptTemplatePipeline';
+/**
+ * Library of prompt template pipelines that groups together prompt template pipelines for an application. This is a very thin wrapper around the Array / Set of prompt template pipelines.
+ *
+ * Prompt Template Pipeline library is a useful helper in execution, it can be shared between execution and consumer parts of the app and make common knowledge about prompt template pipelines.
+ *
+ * It allows to create executor functions from prompt template pipelines in the library.
+ *
+ * @see https://github.com/webgptorg/promptbook#prompt-template-pipeline-library
+ */
+export declare class PromptTemplatePipelineLibrary {
+    readonly promptTemplatePipelines: Record<string_name, PromptTemplatePipeline>;
+    /**
+     * Constructs PromptTemplatePipeline from any sources
+     *
+     * Note: During the construction syntax and logic of all sources are validated
+     * Note: You can combine .ptp.md and .ptp.json files BUT it is not recommended
+     *
+     * @param ptpSources contents of .ptp.md or .ptp.json files
+     * @returns PromptTemplatePipelineLibrary
+     */
+    static fromSources(ptpSources: Record<string_name, PromptTemplatePipelineJson | PromptTemplatePipelineString>): PromptTemplatePipelineLibrary;
+    private constructor();
+    /**
+     * Gets prompt template pipeline by name
+     */
+    getPtp(name: string_name): PromptTemplatePipeline;
+    /**
+     * Checks whether prompt is in the library
+     */
+    isPromptInLibrary(prompt: Prompt): boolean;
+    /**
+     * Gets executor function for given prompt template pipeline
+     */
+    createExecutor(name: string_name, tools: ExecutionTools): PtpExecutor;
+}
+/**
+ * TODO: !! [👐][🧠] Split of PromptTemplatePipeline,PromptTemplatePipelineLibrary between interface and class
+ * TODO: !! [👐] Make promptTemplatePipelines private WHEN split between interface and class
+ * TODO: [🧠] Maybe isPromptInLibrary should be separate utility function
+ * TODO: [🧠] Maybe createExecutor should be separate utility function
+ * TODO: Static method fromDirectory
+ * TODO: [🤜] Add generic type for entry and result parameters
+ * TODO: [🧠] Is it better to ptpLibrary.executePtp('writeXyz',{...}) OR ptpLibrary.createExecutor('writeXyz')({...}) OR createExecutor(ptpLibrary.getPtp('writeXyz'))
+ * TODO: [🧠] Formarly (before commit 62229afce7668a5b85077cc18becf798b583bf8d) there were two classes PromptTemplatePipelineLibrary+PtpLibraryExecutor (maybe it was better?)
+ * TODO: [🧠] Is it better to pass tools into getExecutor or into constructor
+ *             Maybe it is not a good idea to cache executors when they are can be created with different tools
+ * TODO: [👧] Strongly type the executors to avoid need of remove nullables whtn noUncheckedIndexedAccess in tsconfig.json
+ */

package/umd/typings/config.d.ts

@@ -0,0 +1,10 @@
+import { ModelRequirements } from './types/ModelRequirements';
+import { string_version } from './types/typeAliases';
+/**
+ * The version of the PTP
+ */
+export declare const PTP_VERSION: string_version;
+/**
+ * Default model requirements for the pipeline
+ */
+export declare const DEFAULT_MODEL_REQUIREMENTS: ModelRequirements;

package/umd/typings/conversion/_importPtp.d.ts

@@ -0,0 +1,12 @@
+import { PromptTemplatePipelineJson } from '../types/PromptTemplatePipelineJson/PromptTemplatePipelineJson';
+import { PromptTemplatePipelineString } from '../types/PromptTemplatePipelineString';
+/**
+ * Import the text file
+ *
+ * Note: Using here custom import to work in jest tests
+ * Note: Using sync version is 💩 in the production code, but it's ok here in tests
+ *
+ * @private
+ */
+export declare function importPtp(path: `${string}.ptp.md`): PromptTemplatePipelineString;
+export declare function importPtp(path: `${string}.ptp.json`): PromptTemplatePipelineJson;

package/umd/typings/conversion/parseCommand.d.ts

@@ -0,0 +1,6 @@
+import { string_markdown_text } from '.././types/typeAliases';
+import { Command } from '../types/Command';
+/**
+ * Parses one line of ul/ol to command
+ */
+export declare function parseCommand(listItem: string_markdown_text): Command;

package/umd/typings/conversion/parseCommand.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/typings/conversion/promptTemplatePipelineStringToJson.d.ts

@@ -0,0 +1,12 @@
+import { PromptTemplatePipelineJson } from '../types/PromptTemplatePipelineJson/PromptTemplatePipelineJson';
+import { PromptTemplatePipelineString } from '../types/PromptTemplatePipelineString';
+/**
+ * Parse prompt template pipeline from string format to JSON format
+ *
+ * Note: This function does not validate logic of the pipeline only the syntax
+ */
+export declare function promptTemplatePipelineStringToJson(promptTemplatePipelineString: PromptTemplatePipelineString): PromptTemplatePipelineJson;
+/**
+ * TODO: Report here line/column of error
+ * TODO: Use spaceTrim more effectively
+ */

package/umd/typings/conversion/promptTemplatePipelineStringToJson.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/typings/conversion/validatePromptTemplatePipelineJson.d.ts

@@ -0,0 +1,26 @@
+import { PromptTemplatePipelineJson } from '../types/PromptTemplatePipelineJson/PromptTemplatePipelineJson';
+/**
+ * Validates PromptTemplatePipelineJson if it is logically valid.
+ *
+ * It checks:
+ * -   if it has correct parameters dependency
+ *
+ * It does NOT check:
+ * -   if it is valid json
+ * -   if it is meaningful
+ *
+ * @param ptp valid or invalid PromptTemplatePipelineJson
+ * @throws {Error} if invalid
+ */
+export declare function validatePromptTemplatePipelineJson(ptp: PromptTemplatePipelineJson): void;
+/**
+ * TODO: [🧠] Work with ptpVersion
+ * TODO: Use here some json-schema, Zod or something similar and change it to:
+ *     > /**
+ *     >  * Validates PromptTemplatePipelineJson if it is logically valid.
+ *     >  *
+ *     >  * It checks:
+ *     >  * -   it has a valid structure
+ *     >  * -   ...
+ *     >  ex port function validatePromptTemplatePipelineJson(ptp: unknown): asserts ptp is PromptTemplatePipelineJson {
+ */

package/umd/typings/conversion/validatePromptTemplatePipelineJson.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,6 @@
+export interface CommonExecutionToolsOptions {
+    /**
+     * If true, the internal executions will be logged
+     */
+    readonly isVerbose?: boolean;
+}

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

@@ -0,0 +1,25 @@
+import { NaturalExecutionTools } from './NaturalExecutionTools';
+import { ScriptExecutionTools } from './ScriptExecutionTools';
+import { UserInterfaceTools } from './UserInterfaceTools';
+/**
+ * All the tools needed to execute prompts (template pipelines).
+ *
+ * @see https://github.com/webgptorg/promptbook#execution-tools
+ */
+export interface ExecutionTools {
+    /**
+     * Tools for executing prompts to large language models like GPT-4
+     */
+    natural: NaturalExecutionTools;
+    /**
+     * Tools for executing scripts
+     *
+     * Note: You can pass multiple ScriptExecutionTools, they will be tried one by one until one of them supports the script
+     *       If none of them supports the script, an error is thrown
+     */
+    script: Array<ScriptExecutionTools>;
+    /**
+     * Tools for interacting with the user
+     */
+    userInterface: UserInterfaceTools;
+}

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

@@ -0,0 +1,22 @@
+import { Prompt } from '../types/Prompt';
+import { PromptChatResult, PromptCompletionResult } from './PromptResult';
+/**
+ * Vontainer 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.
+ * Inside (in constructor) it calls OpenAI, Azure, GPU, proxy, cache, logging,...
+ *
+ * @see https://github.com/webgptorg/promptbook#natural-execution-tools
+ */
+export interface NaturalExecutionTools {
+    /**
+     * Use a chat model
+     */
+    gptChat(prompt: Prompt): Promise<PromptChatResult>;
+    /**
+     * Use a completion model
+     */
+    gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
+}
+/**
+ * TODO: [🧠] Should or should not there be a word "GPT" in both gptComplete and gptChat
+ */

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

@@ -0,0 +1,38 @@
+import { string_model_name } from '.././types/typeAliases';
+/**
+ * Prompt result is the simplest concept of execution.
+ * It is the result of executing one prompt _(NOT a template)_.
+ *
+ * @see https://github.com/webgptorg/promptbook#prompt-result
+ */
+export type PromptResult = PromptCompletionResult | PromptChatResult;
+/**
+ * Prompt completion result
+ * It contains only the following text NOT the whole completion
+ */
+export type PromptCompletionResult = PromptCommonResult;
+/**
+ * Prompt chat result
+ */
+export interface PromptChatResult extends PromptCommonResult {
+}
+export interface PromptCommonResult {
+    /**
+     * Exact text response from the model
+     */
+    readonly content: string;
+    /**
+     * Name of the model used to generate the response
+     */
+    readonly model: string_model_name;
+    /**
+     * Raw response from the model
+     */
+    readonly rawResponse: object;
+}
+/**
+ * TODO: [🧠] Should here be link to the prompt?
+ * 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
+ */

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

@@ -0,0 +1,19 @@
+import { Promisable } from 'type-fest';
+import { string_name } from '.././types/typeAliases';
+import { TaskProgress } from '../types/TaskProgress';
+/**
+ * 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)_.
+ * Executor is made by combining execution tools and prompt template pipeline library.
+ *
+ * It can be done in two ways:
+ * -   From `PromptTemplatePipelineLibrary.getExecutor` method
+ * -   `createPtpExecutor` utility function
+ *
+ * @see https://github.com/webgptorg/promptbook#executor
+ */
+export interface PtpExecutor {
+    (inputParameters: Record<string_name, string>, onProgress: (taskProgress: TaskProgress) => Promisable<void>): Promise<Record<string_name, string>>;
+}
+/**
+ * TODO: [🧠] Should this file be in /execution or /types folder?
+ */

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

@@ -0,0 +1,34 @@
+import { string_name, string_script } from '.././types/typeAliases';
+import { ScriptLanguage } from '../types/ScriptLanguage';
+/**
+ * Represents all the tools needed to execute scripts
+ *
+ * @see https://github.com/webgptorg/promptbook#script-execution-tools
+ */
+export interface ScriptExecutionTools {
+    execute(options: ScriptExecutionToolsExecuteOptions): Promise<string>;
+}
+/**
+ * Input for the script execution
+ */
+export interface ScriptExecutionToolsExecuteOptions {
+    /**
+     * Language of the script
+     */
+    scriptLanguage: ScriptLanguage;
+    /**
+     * Parameters for the script
+     * Theese parameters are passed to the script as variables
+     * For example: { "name": "John" } => const name = "John";
+     */
+    parameters: Record<string_name, string>;
+    /**
+     * The content of the script to execute
+     * - It can be a single statement
+     * - It can be multiple statements separated by semicolon and return
+     * - It can be a function (but you need to call it)
+     * - It can be IIFE (immediately invoked function expression)
+     * - It can use the parameters as variables and functions from global scope
+     */
+    script: string_script;
+}

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

@@ -0,0 +1,30 @@
+/**
+ * Represents all the tools needed to interact with the user.
+ *
+ * @see https://github.com/webgptorg/promptbook#user-interface-tools
+ */
+export interface UserInterfaceTools {
+    /**
+     * Asks the user to answer a free-text (multiline) question
+     *
+     * @param options the question to ask
+     * @returns the answer from the user
+     */
+    promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
+}
+export interface UserInterfaceToolsPromptDialogOptions {
+    /**
+     * Prompt message
+     *
+     * Note: This is not a prompt to language model but a prompt to the user
+     */
+    prompt: string;
+    /**
+     * Default value for the input/textarea
+     */
+    defaultValue: string | null;
+    /**
+     * Placeholder for the input/textarea
+     */
+    placeholder?: string;
+}

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

@@ -0,0 +1,18 @@
+import { PromptTemplatePipeline } from '../classes/PromptTemplatePipeline';
+import { ExecutionTools } from './ExecutionTools';
+import { PtpExecutor } from './PtpExecutor';
+interface CreatePtpExecutorOptions {
+    readonly ptp: PromptTemplatePipeline;
+    readonly tools: ExecutionTools;
+}
+/**
+ * Creates executor function from prompt template pipeline and execution tools.
+ *
+ * Note: Consider using getExecutor method of the library instead of using this function
+ */
+export declare function createPtpExecutor(options: CreatePtpExecutorOptions): PtpExecutor;
+export {};
+/**
+ * TODO: [👧] Strongly type the executors to avoid need of remove nullables whtn noUncheckedIndexedAccess in tsconfig.json
+ * Note: CreatePtpExecutorOptions are just connected to PtpExecutor so do not extract to types folder
+ */

package/umd/typings/execution/plugins/natural-execution-tools/mocked/MockedEchoNaturalExecutionTools.d.ts

@@ -0,0 +1,22 @@
+import { Prompt } from '../../../../types/Prompt';
+import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
+import { NaturalExecutionTools } from '../../../NaturalExecutionTools';
+import { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
+/**
+ * Mocked execution Tools for just echoing the requests for testing purposes.
+ */
+export declare class MockedEchoNaturalExecutionTools implements NaturalExecutionTools {
+    private readonly options;
+    constructor(options: CommonExecutionToolsOptions);
+    /**
+     * Mocks chat model
+     */
+    gptChat(prompt: Prompt): Promise<PromptChatResult>;
+    /**
+     * Mocks completion model
+     */
+    gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
+}
+/**
+ * TODO: Allow in spaceTrim: nesting with > ${block(prompt.request)}
+ */

package/umd/typings/execution/plugins/natural-execution-tools/mocked/mocked-chat.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🧠] What should be name of this test "MockedEchoExecutionTools.test.ts" or "createPtpExecutor.test.ts"
+ */

package/umd/typings/execution/plugins/natural-execution-tools/mocked/mocked-completion.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🧠] What should be name of this test "MockedEchoExecutionTools.test.ts" or "createPtpExecutor.test.ts"
+ */