@promptbook/openai 0.23.2 → 0.24.0-1.0

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

@@ -9,7 +9,7 @@ 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 { EXPECTATION_UNITS, ExpectationAmount, ExpectationUnit, PromptTemplateJson } from '../types/PromptTemplatePipelineJson/PromptTemplateJson';
 import { PromptTemplateParameterJson } from '../types/PromptTemplatePipelineJson/PromptTemplateParameterJson';
 import { PromptTemplatePipelineJson } from '../types/PromptTemplatePipelineJson/PromptTemplatePipelineJson';
 import { PromptTemplatePipelineString } from '../types/PromptTemplatePipelineString';
@@ -17,7 +17,7 @@ import { ScriptLanguage } from '../types/ScriptLanguage';
 import { TaskProgress } from '../types/TaskProgress';
 import { string_char_emoji } from '../types/typeAliasEmoji';
 import { ILicense, IPersonProfile, IRepository, client_id, 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_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_javascript, string_javascript_name, string_license, string_license_token, string_markdown, string_markdown_text, 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_ptbk_url, string_ptbk_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_xml } from '../types/typeAliases';
-export { CommonExecutionToolsOptions, ExecutionTools, ExecutionType, ILicense, IPersonProfile, IRepository, ModelRequirements, ModelVariant, NaturalExecutionTools, Parameters, Prompt, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptResult, PromptTemplateJson, PromptTemplateParameterJson, PromptTemplatePipelineJson, PromptTemplatePipelineString, PtpExecutor, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptLanguage, TaskProgress, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, client_id, 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_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_javascript, string_javascript_name, string_license, string_license_token, string_markdown, string_markdown_text, 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_ptbk_url, string_ptbk_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_xml, };
+export { CommonExecutionToolsOptions, EXPECTATION_UNITS, ExecutionTools, ExecutionType, ExpectationAmount, ExpectationUnit, ILicense, IPersonProfile, IRepository, ModelRequirements, ModelVariant, NaturalExecutionTools, Parameters, Prompt, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptResult, PromptTemplateJson, PromptTemplateParameterJson, PromptTemplatePipelineJson, PromptTemplatePipelineString, PtpExecutor, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptLanguage, TaskProgress, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, client_id, 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_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_javascript, string_javascript_name, string_license, string_license_token, string_markdown, string_markdown_text, 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_ptbk_url, string_ptbk_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_xml, };
 /**
  * TODO: !!! Filter out all the types that are not used in the library
  */

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

@@ -1,13 +1,23 @@
+import { executionReportJsonToString } from '../types/execution-report/executionReportJsonToString';
 import { EMOJIS, EMOJIS_IN_CATEGORIES } from '../utils/emojis';
+import { CountUtils } from '../utils/expectation-counters';
+import { countCharacters } from '../utils/expectation-counters/countCharacters';
+import { countLines } from '../utils/expectation-counters/countLines';
+import { countPages } from '../utils/expectation-counters/countPages';
+import { countParagraphs } from '../utils/expectation-counters/countParagraphs';
+import { countSentences } from '../utils/expectation-counters/countSentences';
+import { countWords } from '../utils/expectation-counters/countWords';
 import { isValidJsonString } from '../utils/isValidJsonString';
 import { extractAllBlocksFromMarkdown } from '../utils/markdown/extractAllBlocksFromMarkdown';
 import { extractAllListItemsFromMarkdown } from '../utils/markdown/extractAllListItemsFromMarkdown';
 import { extractOneBlockFromMarkdown } from '../utils/markdown/extractOneBlockFromMarkdown';
 import { removeContentComments } from '../utils/markdown/removeContentComments';
 import { removeMarkdownFormatting } from '../utils/markdown/removeMarkdownFormatting';
+import { parseNumber } from '../utils/parseNumber';
 import { removeEmojis } from '../utils/removeEmojis';
 import { removeQuotes } from '../utils/removeQuotes';
 import { replaceParameters } from '../utils/replaceParameters';
+import { trimCodeBlock } from '../utils/trimCodeBlock';
 import { trimEndOfCodeBlock } from '../utils/trimEndOfCodeBlock';
 import { unwrapResult } from '../utils/unwrapResult';
-export { EMOJIS, EMOJIS_IN_CATEGORIES, extractAllBlocksFromMarkdown, extractAllListItemsFromMarkdown, extractOneBlockFromMarkdown, isValidJsonString, removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, replaceParameters, trimEndOfCodeBlock, unwrapResult, };
+export { CountUtils, EMOJIS, EMOJIS_IN_CATEGORIES, countCharacters, countLines, countPages, countParagraphs, countSentences, countWords, executionReportJsonToString, extractAllBlocksFromMarkdown, extractAllListItemsFromMarkdown, extractOneBlockFromMarkdown, isValidJsonString, parseNumber, removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, replaceParameters, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };

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

@@ -1,4 +1,4 @@
-import { string_name } from '.././types/typeAliases';
+import { string_name, string_version } from '.././types/typeAliases';
 import { PromptTemplateJson } from '../types/PromptTemplatePipelineJson/PromptTemplateJson';
 import { PromptTemplateParameterJson } from '../types/PromptTemplatePipelineJson/PromptTemplateParameterJson';
 import { PromptTemplatePipelineJson } from '../types/PromptTemplatePipelineJson/PromptTemplatePipelineJson';
@@ -16,6 +16,9 @@ import { PromptTemplatePipelineString } from '../types/PromptTemplatePipelineStr
  */
 export declare class PromptTemplatePipeline {
     readonly ptbkUrl: URL | null;
+    readonly title: string | null;
+    readonly ptbkVersion: string_version | null;
+    readonly description: string | null;
     readonly parameters: Record<string_name, PromptTemplateParameterJson>;
     readonly promptTemplates: Array<PromptTemplateJson>;
     /**

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

@@ -1,10 +1,15 @@
 import { string_name } from '.././types/typeAliases';
+import { CreatePtpExecutorSettings } from '../execution/createPtpExecutor';
 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';
+type PromptTemplatePipelineLibraryOptions = {
+    readonly library: Record<string_name, PromptTemplatePipeline>;
+    readonly settings: CreatePtpExecutorSettings;
+};
 /**
  * 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.
  *
@@ -15,7 +20,7 @@ import { PromptTemplatePipeline } from './PromptTemplatePipeline';
  * @see https://github.com/webgptorg/promptbook#prompt-template-pipeline-library
  */
 export declare class PromptTemplatePipelineLibrary {
-    readonly promptTemplatePipelines: Record<string_name, PromptTemplatePipeline>;
+    readonly options: PromptTemplatePipelineLibraryOptions;
     /**
      * Constructs PromptTemplatePipeline from any sources
      *
@@ -25,7 +30,7 @@ export declare class PromptTemplatePipelineLibrary {
      * @param ptbkSources contents of .ptbk.md or .ptbk.json files
      * @returns PromptTemplatePipelineLibrary
      */
-    static fromSources(ptbkSources: Record<string_name, PromptTemplatePipelineJson | PromptTemplatePipelineString>): PromptTemplatePipelineLibrary;
+    static fromSources(ptbkSources: Record<string_name, PromptTemplatePipelineJson | PromptTemplatePipelineString>, settings: CreatePtpExecutorSettings): PromptTemplatePipelineLibrary;
     private constructor();
     /**
      * Gets prompt template pipeline by name
@@ -40,6 +45,7 @@ export declare class PromptTemplatePipelineLibrary {
      */
     createExecutor(name: string_name, tools: ExecutionTools): PtpExecutor;
 }
+export {};
 /**
  * TODO: !!! This should be renamed to Promptbook
  * TODO: !! [👐][🧠] Split of PromptTemplatePipeline,PromptTemplatePipelineLibrary between interface and class

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

@@ -1,5 +1,5 @@
-import { string_markdown_text } from '.././types/typeAliases';
-import { Command } from '../types/Command';
+import type { string_markdown_text } from '.././types/typeAliases';
+import type { Command } from '../types/Command';
 /**
  * Parses one line of ul/ol to command
  */

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

@@ -1,4 +1,4 @@
-import { string_model_name } from '.././types/typeAliases';
+import type { 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)_.

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

@@ -1,6 +1,7 @@
-import { Promisable } from 'type-fest';
-import { string_name } from '.././types/typeAliases';
-import { TaskProgress } from '../types/TaskProgress';
+import type { Promisable } from 'type-fest';
+import type { string_name } from '.././types/typeAliases';
+import type { TaskProgress } from '../types/TaskProgress';
+import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
 /**
  * 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.
@@ -12,7 +13,26 @@ import { TaskProgress } from '../types/TaskProgress';
  * @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>>;
+    (inputParameters: Record<string_name, string>, onProgress: (taskProgress: TaskProgress) => Promisable<void>): Promise<{
+        /**
+         * Whether the execution was successful
+         */
+        isSuccessful: boolean;
+        /**
+         * Errors that occured during the execution
+         */
+        errors: Array<Error>;
+        /**
+         * The report of the execution
+         */
+        executionReport: ExecutionReportJson;
+        /**
+         * Result parameters of the execution
+         *
+         * Note: If the execution was not successful, there are only some of the result parameters
+         */
+        outputParameters: Record<string_name, string>;
+    }>;
 }
 /**
  * TODO: [🧠] Should this file be in /execution or /types folder?

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

@@ -1,9 +1,18 @@
 import { PromptTemplatePipeline } from '../classes/PromptTemplatePipeline';
 import { ExecutionTools } from './ExecutionTools';
 import { PtpExecutor } from './PtpExecutor';
+export interface CreatePtpExecutorSettings {
+    /**
+     * When executor does not satisfy expectations it will be retried this amount of times
+     *
+     * !!!!!!! Make default in version 24.1.0
+     */
+    readonly maxNaturalExecutionAttempts: number;
+}
 interface CreatePtpExecutorOptions {
     readonly ptp: PromptTemplatePipeline;
     readonly tools: ExecutionTools;
+    readonly settings: CreatePtpExecutorSettings;
 }
 /**
  * Creates executor function from prompt template pipeline and execution tools.

package/esm/typings/types/Command.d.ts

@@ -1,11 +1,12 @@
-import { string_markdown_text, string_name, string_version } from '.././types/typeAliases';
-import { ExecutionType } from './ExecutionTypes';
-import { ModelRequirements } from './ModelRequirements';
+import type { string_markdown_text, string_name, string_version } from '.././types/typeAliases';
+import type { ExecutionType } from './ExecutionTypes';
+import type { ModelRequirements } from './ModelRequirements';
+import type { ExpectationAmount, ExpectationUnit } from './PromptTemplatePipelineJson/PromptTemplateJson';
 /**
  * Command is one piece of the prompt template which adds some logic to the prompt template or the whole pipeline.
  * It is parsed from the markdown from ul/ol items - one command per one item.
  */
-export type Command = PtbkUrlCommand | PtbkVersionCommand | ExecuteCommand | ModelCommand | ParameterCommand | PostprocessCommand;
+export type Command = PtbkUrlCommand | PtbkVersionCommand | ExecuteCommand | ModelCommand | ParameterCommand | PostprocessCommand | ExpectCommand;
 /**
  * PtpVersion command tells which version is .ptp file using
  *
@@ -63,3 +64,15 @@ export interface PostprocessCommand {
     readonly type: 'POSTPROCESS';
     readonly functionName: string_name;
 }
+/**
+ * Expect command describes the desired output of the prompt template (after post-processing)
+ * It can set limits for the maximum/minimum length of the output, measured in characters, words, sentences, paragraphs,...
+ *
+ * Note: LLMs work with tokens, not characters, but in Promptbooks we want to use some human-recognisable and cross-model interoperable units.
+ */
+export interface ExpectCommand {
+    readonly type: 'EXPECT';
+    readonly sign: 'EXACTLY' | 'MINIMUM' | 'MAXIMUM';
+    readonly unit: ExpectationUnit;
+    readonly amount: ExpectationAmount;
+}

package/esm/typings/types/Prompt.d.ts

@@ -1,11 +1,17 @@
-import { string_name, string_prompt, string_ptbk_url_with_hashtemplate } from '.././types/typeAliases';
-import { ModelRequirements } from './ModelRequirements';
+import type { string_name, string_prompt, string_ptbk_url_with_hashtemplate, string_title } from '.././types/typeAliases';
+import type { ModelRequirements } from './ModelRequirements';
 /**
  * Prompt in a text along with model requirements, but without any execution or templating logic.
  *
  * @see https://github.com/webgptorg/promptbook#prompt
  */
 export interface Prompt {
+    /**
+     * The title of the prompt
+     *
+     * Note: This has no effect on the model, it is just for the reporting
+     */
+    readonly title: string_title;
     /**
      * The text of the prompt
      *

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

@@ -1,4 +1,4 @@
-import { string_javascript, string_markdown, string_name, string_prompt, string_template } from '../.././types/typeAliases';
+import { number_integer, number_positive_or_zero, string_javascript, string_markdown, string_name, string_prompt, string_template } from '../.././types/typeAliases';
 import { ExecutionType } from '../ExecutionTypes';
 import { ModelRequirements } from '../ModelRequirements';
 import { ScriptLanguage } from '../ScriptLanguage';
@@ -9,14 +9,33 @@ export type PromptTemplateJson = NaturalTemplateJson | SimpleTemplateJson | Scri
 /**
  * Template for prompt to LLM
  */
-interface NaturalTemplateJson extends PromptTemplateJsonCommon {
+export interface NaturalTemplateJson extends PromptTemplateJsonCommon {
     readonly executionType: 'PROMPT_TEMPLATE';
+    /**
+     * Expectations for the answer
+     */
+    readonly expectations: Partial<Record<Lowercase<ExpectationUnit>, {
+        min?: ExpectationAmount;
+        max?: ExpectationAmount;
+    }>>;
     /**
      * Requirements for the model
      * - This is required only for executionType PROMPT_TEMPLATE
      */
     readonly modelRequirements?: ModelRequirements;
 }
+/**
+ * Units of text measurement
+ */
+export declare const EXPECTATION_UNITS: readonly ["CHARACTERS", "WORDS", "SENTENCES", "PARAGRAPHS", "LINES", "PAGES"];
+/**
+ * Unit of text measurement
+ */
+export type ExpectationUnit = (typeof EXPECTATION_UNITS)[number];
+/**
+ * Amount of text measurement
+ */
+export type ExpectationAmount = number_integer & number_positive_or_zero;
 /**
  * Template for simple concatenation of strings
  */

package/esm/typings/types/execution-report/ExecutionReportJson.d.ts

@@ -0,0 +1,56 @@
+import type { PromptResult } from '../../execution/PromptResult';
+import type { Prompt } from '../Prompt';
+import type { string_ptbk_url, string_version } from '../typeAliases';
+/**
+ * ExecutionReport is result of executing one promptbook
+ * It is kind of a variant of the promptbook usefull for debugging, logging and transparency for users.
+ *
+ * It can have 2 formats:
+ * -   **.md file** created from the **JSON** format
+ * -   _(this)_ **JSON** format
+ *
+ * @see https://github.com/webgptorg/promptbook#execution-report
+ */
+export type ExecutionReportJson = {
+    /**
+     * Unique identifier of the ptp from ptp which was executed
+     */
+    readonly ptbkUrl?: string_ptbk_url;
+    /**
+     * Title of from ptp which was executed
+     */
+    readonly title?: string;
+    /**
+     * Version from ptp which was executed
+     */
+    readonly ptbkUsedVersion: string_version;
+    /**
+     * Version from ptp which was requested by promptbook
+     */
+    readonly ptbkRequestedVersion?: string_version;
+    /**
+     * Description of the ptp which was executed
+     */
+    readonly description?: string;
+    /**
+     * Sequence of prompt templates in order which were executed
+     */
+    readonly promptExecutions: Array<{
+        /**
+         * The prompt wich was executed
+         */
+        prompt: Omit<Prompt, 'ptbkUrl' | 'parameters'>;
+        /**
+         * Result of the prompt execution (if not failed during LLM execution)
+         */
+        result?: PromptResult;
+        /**
+         * The error which occured during LLM execution or during postprocessing or expectation checking
+         *
+         * Note: It makes sense to have both error and result defined, for example when the result not pass expectations
+         */
+        error?: {
+            message: string;
+        };
+    }>;
+};

package/esm/typings/types/execution-report/ExecutionReportString.d.ts

@@ -0,0 +1,16 @@
+/**
+ * ExecutionReport is result of executing one promptbook
+ * It is kind of a variant of the promptbook usefull for debugging, logging and transparency for users.
+ *
+ * It can have 2 formats:
+ * -   _(this)_ **.md file** created from the **JSON** format
+ * -   **JSON** format
+ *
+ * @see https://github.com/webgptorg/promptbook#execution-report
+ */
+export type ExecutionReportString = string & {
+    readonly _type: 'ExecutionReportString';
+};
+/**
+ * TODO: Better validation or remove branded type and make it just string
+ */

package/esm/typings/types/execution-report/executionReportJsonToString.d.ts

@@ -0,0 +1,6 @@
+import type { ExecutionReportJson } from './ExecutionReportJson';
+import type { ExecutionReportString } from './ExecutionReportString';
+/**
+ * Converts execution report from JSON to string format
+ */
+export declare function executionReportJsonToString(executionReportJson: ExecutionReportJson): ExecutionReportString;

package/esm/typings/types/typeAliases.d.ts

@@ -406,6 +406,8 @@ export type string_ssh_key = string;
 export type string_pgp_key = string;
 export type number_positive = number;
 export type number_negative = number;
+export type number_positive_or_zero = number;
+export type number_negative_or_zero = number;
 export type number_integer = number;
 /**
  * Semantic helper;
@@ -429,7 +431,7 @@ export type number_days = number;
 export type number_weeks = number;
 export type number_months = number;
 export type number_years = number;
-export type number_bytes = number_positive & number_integer;
+export type number_bytes = number_integer & number_positive;
 export type number_kilobytes = number_positive;
 export type number_megabytes = number_positive;
 export type number_gigabytes = number_positive;

package/esm/typings/utils/expectation-counters/countCharacters.d.ts

@@ -0,0 +1,5 @@
+import type { ExpectationAmount } from '../../types/PromptTemplatePipelineJson/PromptTemplateJson';
+/**
+ * Counts number of characters in the text
+ */
+export declare function countCharacters(text: string): ExpectationAmount;

package/esm/typings/utils/expectation-counters/countCharacters.test.d.ts

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

package/esm/typings/utils/expectation-counters/countLines.d.ts

@@ -0,0 +1,5 @@
+import type { ExpectationAmount } from '../../types/PromptTemplatePipelineJson/PromptTemplateJson';
+/**
+ * Counts number of lines in the text
+ */
+export declare function countLines(text: string): ExpectationAmount;

package/esm/typings/utils/expectation-counters/countLines.test.d.ts

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

package/esm/typings/utils/expectation-counters/countPages.d.ts

@@ -0,0 +1,5 @@
+import type { ExpectationAmount } from '../../types/PromptTemplatePipelineJson/PromptTemplateJson';
+/**
+ * Counts number of pages in the text
+ */
+export declare function countPages(text: string): ExpectationAmount;

package/esm/typings/utils/expectation-counters/countPages.test.d.ts

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

package/esm/typings/utils/expectation-counters/countParagraphs.d.ts

@@ -0,0 +1,5 @@
+import type { ExpectationAmount } from '../../types/PromptTemplatePipelineJson/PromptTemplateJson';
+/**
+ * Counts number of paragraphs in the text
+ */
+export declare function countParagraphs(text: string): ExpectationAmount;

package/esm/typings/utils/expectation-counters/countParagraphs.test.d.ts

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

package/esm/typings/utils/expectation-counters/countSentences.d.ts

@@ -0,0 +1,5 @@
+import type { ExpectationAmount } from '../../types/PromptTemplatePipelineJson/PromptTemplateJson';
+/**
+ * Counts number of sentences in the text
+ */
+export declare function countSentences(text: string): ExpectationAmount;

package/esm/typings/utils/expectation-counters/countSentences.test.d.ts

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

package/esm/typings/utils/expectation-counters/countWords.d.ts

@@ -0,0 +1,5 @@
+import type { ExpectationAmount } from '../../types/PromptTemplatePipelineJson/PromptTemplateJson';
+/**
+ * Counts number of words in the text
+ */
+export declare function countWords(text: string): ExpectationAmount;

package/esm/typings/utils/expectation-counters/countWords.test.d.ts

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

package/esm/typings/utils/expectation-counters/index.d.ts

@@ -0,0 +1,5 @@
+import type { ExpectationAmount, ExpectationUnit } from '../../types/PromptTemplatePipelineJson/PromptTemplateJson';
+/**
+ * Index of all counter functions
+ */
+export declare const CountUtils: Record<ExpectationUnit, (text: string) => ExpectationAmount>;

package/esm/typings/utils/markdown/prettifyMarkdown.d.ts

@@ -0,0 +1,8 @@
+import type { string_html } from '../../types/typeAliases';
+/**
+ * Prettify the html code
+ *
+ * @param html raw html code
+ * @returns formatted html code
+ */
+export declare function prettifyMarkdown(html: string_html): string_html;

package/esm/typings/utils/markdown/prettifyMarkdown.test.d.ts

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

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

@@ -0,0 +1,10 @@
+/**
+ * Function parseNumber will parse number from string
+ *
+ * Unlike Number.parseInt, Number.parseFloat it will never ever result in NaN
+ * Note: it also works only with decimal numbers
+ */
+export declare function parseNumber(value: string | number): number;
+/**
+ * TODO: Maybe use sth. like safe-eval in fraction/calculation case @see https://www.npmjs.com/package/safe-eval
+ */

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

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

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

@@ -0,0 +1,8 @@
+/**
+ * Function trimCodeBlock will trim starting and ending code block from the string if it is present.
+ *
+ * Note: This is usefull for post-processing of the result of the chat LLM model
+ *       when the model wraps the result in the (markdown) code block.
+ *
+ */
+export declare function trimCodeBlock(value: string): string;

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

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

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

@@ -1,6 +1,7 @@
 /**
  * Function trimEndOfCodeBlock will remove ending code block from the string if it is present.
  *
- * This is usefull for post-processing of the result of the completion LLM model if you want to start code block in the prompt but you don't want to end it in the result.
+ * Note: This is usefull for post-processing of the result of the completion LLM model
+ *       if you want to start code block in the prompt but you don't want to end it in the result.
  */
 export declare function trimEndOfCodeBlock(value: string): string;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.23.2",
+    "version": "0.24.0-1.0",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -37,7 +37,7 @@
         "openai": "4.2.0"
     },
     "peerDependencies": {
-        "@promptbook/core": "0.23.2"
+        "@promptbook/core": "0.24.0-1.0"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",

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

@@ -9,7 +9,7 @@ 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 { EXPECTATION_UNITS, ExpectationAmount, ExpectationUnit, PromptTemplateJson } from '../types/PromptTemplatePipelineJson/PromptTemplateJson';
 import { PromptTemplateParameterJson } from '../types/PromptTemplatePipelineJson/PromptTemplateParameterJson';
 import { PromptTemplatePipelineJson } from '../types/PromptTemplatePipelineJson/PromptTemplatePipelineJson';
 import { PromptTemplatePipelineString } from '../types/PromptTemplatePipelineString';
@@ -17,7 +17,7 @@ import { ScriptLanguage } from '../types/ScriptLanguage';
 import { TaskProgress } from '../types/TaskProgress';
 import { string_char_emoji } from '../types/typeAliasEmoji';
 import { ILicense, IPersonProfile, IRepository, client_id, 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_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_javascript, string_javascript_name, string_license, string_license_token, string_markdown, string_markdown_text, 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_ptbk_url, string_ptbk_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_xml } from '../types/typeAliases';
-export { CommonExecutionToolsOptions, ExecutionTools, ExecutionType, ILicense, IPersonProfile, IRepository, ModelRequirements, ModelVariant, NaturalExecutionTools, Parameters, Prompt, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptResult, PromptTemplateJson, PromptTemplateParameterJson, PromptTemplatePipelineJson, PromptTemplatePipelineString, PtpExecutor, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptLanguage, TaskProgress, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, client_id, 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_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_javascript, string_javascript_name, string_license, string_license_token, string_markdown, string_markdown_text, 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_ptbk_url, string_ptbk_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_xml, };
+export { CommonExecutionToolsOptions, EXPECTATION_UNITS, ExecutionTools, ExecutionType, ExpectationAmount, ExpectationUnit, ILicense, IPersonProfile, IRepository, ModelRequirements, ModelVariant, NaturalExecutionTools, Parameters, Prompt, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptResult, PromptTemplateJson, PromptTemplateParameterJson, PromptTemplatePipelineJson, PromptTemplatePipelineString, PtpExecutor, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptLanguage, TaskProgress, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, client_id, 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_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_javascript, string_javascript_name, string_license, string_license_token, string_markdown, string_markdown_text, 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_ptbk_url, string_ptbk_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_xml, };
 /**
  * TODO: !!! Filter out all the types that are not used in the library
  */

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

@@ -1,13 +1,23 @@
+import { executionReportJsonToString } from '../types/execution-report/executionReportJsonToString';
 import { EMOJIS, EMOJIS_IN_CATEGORIES } from '../utils/emojis';
+import { CountUtils } from '../utils/expectation-counters';
+import { countCharacters } from '../utils/expectation-counters/countCharacters';
+import { countLines } from '../utils/expectation-counters/countLines';
+import { countPages } from '../utils/expectation-counters/countPages';
+import { countParagraphs } from '../utils/expectation-counters/countParagraphs';
+import { countSentences } from '../utils/expectation-counters/countSentences';
+import { countWords } from '../utils/expectation-counters/countWords';
 import { isValidJsonString } from '../utils/isValidJsonString';
 import { extractAllBlocksFromMarkdown } from '../utils/markdown/extractAllBlocksFromMarkdown';
 import { extractAllListItemsFromMarkdown } from '../utils/markdown/extractAllListItemsFromMarkdown';
 import { extractOneBlockFromMarkdown } from '../utils/markdown/extractOneBlockFromMarkdown';
 import { removeContentComments } from '../utils/markdown/removeContentComments';
 import { removeMarkdownFormatting } from '../utils/markdown/removeMarkdownFormatting';
+import { parseNumber } from '../utils/parseNumber';
 import { removeEmojis } from '../utils/removeEmojis';
 import { removeQuotes } from '../utils/removeQuotes';
 import { replaceParameters } from '../utils/replaceParameters';
+import { trimCodeBlock } from '../utils/trimCodeBlock';
 import { trimEndOfCodeBlock } from '../utils/trimEndOfCodeBlock';
 import { unwrapResult } from '../utils/unwrapResult';
-export { EMOJIS, EMOJIS_IN_CATEGORIES, extractAllBlocksFromMarkdown, extractAllListItemsFromMarkdown, extractOneBlockFromMarkdown, isValidJsonString, removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, replaceParameters, trimEndOfCodeBlock, unwrapResult, };
+export { CountUtils, EMOJIS, EMOJIS_IN_CATEGORIES, countCharacters, countLines, countPages, countParagraphs, countSentences, countWords, executionReportJsonToString, extractAllBlocksFromMarkdown, extractAllListItemsFromMarkdown, extractOneBlockFromMarkdown, isValidJsonString, parseNumber, removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, replaceParameters, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };

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

@@ -1,4 +1,4 @@
-import { string_name } from '.././types/typeAliases';
+import { string_name, string_version } from '.././types/typeAliases';
 import { PromptTemplateJson } from '../types/PromptTemplatePipelineJson/PromptTemplateJson';
 import { PromptTemplateParameterJson } from '../types/PromptTemplatePipelineJson/PromptTemplateParameterJson';
 import { PromptTemplatePipelineJson } from '../types/PromptTemplatePipelineJson/PromptTemplatePipelineJson';
@@ -16,6 +16,9 @@ import { PromptTemplatePipelineString } from '../types/PromptTemplatePipelineStr
  */
 export declare class PromptTemplatePipeline {
     readonly ptbkUrl: URL | null;
+    readonly title: string | null;
+    readonly ptbkVersion: string_version | null;
+    readonly description: string | null;
     readonly parameters: Record<string_name, PromptTemplateParameterJson>;
     readonly promptTemplates: Array<PromptTemplateJson>;
     /**

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

@@ -1,10 +1,15 @@
 import { string_name } from '.././types/typeAliases';
+import { CreatePtpExecutorSettings } from '../execution/createPtpExecutor';
 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';
+type PromptTemplatePipelineLibraryOptions = {
+    readonly library: Record<string_name, PromptTemplatePipeline>;
+    readonly settings: CreatePtpExecutorSettings;
+};
 /**
  * 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.
  *
@@ -15,7 +20,7 @@ import { PromptTemplatePipeline } from './PromptTemplatePipeline';
  * @see https://github.com/webgptorg/promptbook#prompt-template-pipeline-library
  */
 export declare class PromptTemplatePipelineLibrary {
-    readonly promptTemplatePipelines: Record<string_name, PromptTemplatePipeline>;
+    readonly options: PromptTemplatePipelineLibraryOptions;
     /**
      * Constructs PromptTemplatePipeline from any sources
      *
@@ -25,7 +30,7 @@ export declare class PromptTemplatePipelineLibrary {
      * @param ptbkSources contents of .ptbk.md or .ptbk.json files
      * @returns PromptTemplatePipelineLibrary
      */
-    static fromSources(ptbkSources: Record<string_name, PromptTemplatePipelineJson | PromptTemplatePipelineString>): PromptTemplatePipelineLibrary;
+    static fromSources(ptbkSources: Record<string_name, PromptTemplatePipelineJson | PromptTemplatePipelineString>, settings: CreatePtpExecutorSettings): PromptTemplatePipelineLibrary;
     private constructor();
     /**
      * Gets prompt template pipeline by name
@@ -40,6 +45,7 @@ export declare class PromptTemplatePipelineLibrary {
      */
     createExecutor(name: string_name, tools: ExecutionTools): PtpExecutor;
 }
+export {};
 /**
  * TODO: !!! This should be renamed to Promptbook
  * TODO: !! [👐][🧠] Split of PromptTemplatePipeline,PromptTemplatePipelineLibrary between interface and class

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

@@ -1,5 +1,5 @@
-import { string_markdown_text } from '.././types/typeAliases';
-import { Command } from '../types/Command';
+import type { string_markdown_text } from '.././types/typeAliases';
+import type { Command } from '../types/Command';
 /**
  * Parses one line of ul/ol to command
  */

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

@@ -1,4 +1,4 @@
-import { string_model_name } from '.././types/typeAliases';
+import type { 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)_.

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

@@ -1,6 +1,7 @@
-import { Promisable } from 'type-fest';
-import { string_name } from '.././types/typeAliases';
-import { TaskProgress } from '../types/TaskProgress';
+import type { Promisable } from 'type-fest';
+import type { string_name } from '.././types/typeAliases';
+import type { TaskProgress } from '../types/TaskProgress';
+import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
 /**
  * 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.
@@ -12,7 +13,26 @@ import { TaskProgress } from '../types/TaskProgress';
  * @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>>;
+    (inputParameters: Record<string_name, string>, onProgress: (taskProgress: TaskProgress) => Promisable<void>): Promise<{
+        /**
+         * Whether the execution was successful
+         */
+        isSuccessful: boolean;
+        /**
+         * Errors that occured during the execution
+         */
+        errors: Array<Error>;
+        /**
+         * The report of the execution
+         */
+        executionReport: ExecutionReportJson;
+        /**
+         * Result parameters of the execution
+         *
+         * Note: If the execution was not successful, there are only some of the result parameters
+         */
+        outputParameters: Record<string_name, string>;
+    }>;
 }
 /**
  * TODO: [🧠] Should this file be in /execution or /types folder?

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

@@ -1,9 +1,18 @@
 import { PromptTemplatePipeline } from '../classes/PromptTemplatePipeline';
 import { ExecutionTools } from './ExecutionTools';
 import { PtpExecutor } from './PtpExecutor';
+export interface CreatePtpExecutorSettings {
+    /**
+     * When executor does not satisfy expectations it will be retried this amount of times
+     *
+     * !!!!!!! Make default in version 24.1.0
+     */
+    readonly maxNaturalExecutionAttempts: number;
+}
 interface CreatePtpExecutorOptions {
     readonly ptp: PromptTemplatePipeline;
     readonly tools: ExecutionTools;
+    readonly settings: CreatePtpExecutorSettings;
 }
 /**
  * Creates executor function from prompt template pipeline and execution tools.

package/umd/typings/types/Command.d.ts

@@ -1,11 +1,12 @@
-import { string_markdown_text, string_name, string_version } from '.././types/typeAliases';
-import { ExecutionType } from './ExecutionTypes';
-import { ModelRequirements } from './ModelRequirements';
+import type { string_markdown_text, string_name, string_version } from '.././types/typeAliases';
+import type { ExecutionType } from './ExecutionTypes';
+import type { ModelRequirements } from './ModelRequirements';
+import type { ExpectationAmount, ExpectationUnit } from './PromptTemplatePipelineJson/PromptTemplateJson';
 /**
  * Command is one piece of the prompt template which adds some logic to the prompt template or the whole pipeline.
  * It is parsed from the markdown from ul/ol items - one command per one item.
  */
-export type Command = PtbkUrlCommand | PtbkVersionCommand | ExecuteCommand | ModelCommand | ParameterCommand | PostprocessCommand;
+export type Command = PtbkUrlCommand | PtbkVersionCommand | ExecuteCommand | ModelCommand | ParameterCommand | PostprocessCommand | ExpectCommand;
 /**
  * PtpVersion command tells which version is .ptp file using
  *
@@ -63,3 +64,15 @@ export interface PostprocessCommand {
     readonly type: 'POSTPROCESS';
     readonly functionName: string_name;
 }
+/**
+ * Expect command describes the desired output of the prompt template (after post-processing)
+ * It can set limits for the maximum/minimum length of the output, measured in characters, words, sentences, paragraphs,...
+ *
+ * Note: LLMs work with tokens, not characters, but in Promptbooks we want to use some human-recognisable and cross-model interoperable units.
+ */
+export interface ExpectCommand {
+    readonly type: 'EXPECT';
+    readonly sign: 'EXACTLY' | 'MINIMUM' | 'MAXIMUM';
+    readonly unit: ExpectationUnit;
+    readonly amount: ExpectationAmount;
+}

package/umd/typings/types/Prompt.d.ts

@@ -1,11 +1,17 @@
-import { string_name, string_prompt, string_ptbk_url_with_hashtemplate } from '.././types/typeAliases';
-import { ModelRequirements } from './ModelRequirements';
+import type { string_name, string_prompt, string_ptbk_url_with_hashtemplate, string_title } from '.././types/typeAliases';
+import type { ModelRequirements } from './ModelRequirements';
 /**
  * Prompt in a text along with model requirements, but without any execution or templating logic.
  *
  * @see https://github.com/webgptorg/promptbook#prompt
  */
 export interface Prompt {
+    /**
+     * The title of the prompt
+     *
+     * Note: This has no effect on the model, it is just for the reporting
+     */
+    readonly title: string_title;
     /**
      * The text of the prompt
      *

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

@@ -1,4 +1,4 @@
-import { string_javascript, string_markdown, string_name, string_prompt, string_template } from '../.././types/typeAliases';
+import { number_integer, number_positive_or_zero, string_javascript, string_markdown, string_name, string_prompt, string_template } from '../.././types/typeAliases';
 import { ExecutionType } from '../ExecutionTypes';
 import { ModelRequirements } from '../ModelRequirements';
 import { ScriptLanguage } from '../ScriptLanguage';
@@ -9,14 +9,33 @@ export type PromptTemplateJson = NaturalTemplateJson | SimpleTemplateJson | Scri
 /**
  * Template for prompt to LLM
  */
-interface NaturalTemplateJson extends PromptTemplateJsonCommon {
+export interface NaturalTemplateJson extends PromptTemplateJsonCommon {
     readonly executionType: 'PROMPT_TEMPLATE';
+    /**
+     * Expectations for the answer
+     */
+    readonly expectations: Partial<Record<Lowercase<ExpectationUnit>, {
+        min?: ExpectationAmount;
+        max?: ExpectationAmount;
+    }>>;
     /**
      * Requirements for the model
      * - This is required only for executionType PROMPT_TEMPLATE
      */
     readonly modelRequirements?: ModelRequirements;
 }
+/**
+ * Units of text measurement
+ */
+export declare const EXPECTATION_UNITS: readonly ["CHARACTERS", "WORDS", "SENTENCES", "PARAGRAPHS", "LINES", "PAGES"];
+/**
+ * Unit of text measurement
+ */
+export type ExpectationUnit = (typeof EXPECTATION_UNITS)[number];
+/**
+ * Amount of text measurement
+ */
+export type ExpectationAmount = number_integer & number_positive_or_zero;
 /**
  * Template for simple concatenation of strings
  */

package/umd/typings/types/execution-report/ExecutionReportJson.d.ts

@@ -0,0 +1,56 @@
+import type { PromptResult } from '../../execution/PromptResult';
+import type { Prompt } from '../Prompt';
+import type { string_ptbk_url, string_version } from '../typeAliases';
+/**
+ * ExecutionReport is result of executing one promptbook
+ * It is kind of a variant of the promptbook usefull for debugging, logging and transparency for users.
+ *
+ * It can have 2 formats:
+ * -   **.md file** created from the **JSON** format
+ * -   _(this)_ **JSON** format
+ *
+ * @see https://github.com/webgptorg/promptbook#execution-report
+ */
+export type ExecutionReportJson = {
+    /**
+     * Unique identifier of the ptp from ptp which was executed
+     */
+    readonly ptbkUrl?: string_ptbk_url;
+    /**
+     * Title of from ptp which was executed
+     */
+    readonly title?: string;
+    /**
+     * Version from ptp which was executed
+     */
+    readonly ptbkUsedVersion: string_version;
+    /**
+     * Version from ptp which was requested by promptbook
+     */
+    readonly ptbkRequestedVersion?: string_version;
+    /**
+     * Description of the ptp which was executed
+     */
+    readonly description?: string;
+    /**
+     * Sequence of prompt templates in order which were executed
+     */
+    readonly promptExecutions: Array<{
+        /**
+         * The prompt wich was executed
+         */
+        prompt: Omit<Prompt, 'ptbkUrl' | 'parameters'>;
+        /**
+         * Result of the prompt execution (if not failed during LLM execution)
+         */
+        result?: PromptResult;
+        /**
+         * The error which occured during LLM execution or during postprocessing or expectation checking
+         *
+         * Note: It makes sense to have both error and result defined, for example when the result not pass expectations
+         */
+        error?: {
+            message: string;
+        };
+    }>;
+};

package/umd/typings/types/execution-report/ExecutionReportString.d.ts

@@ -0,0 +1,16 @@
+/**
+ * ExecutionReport is result of executing one promptbook
+ * It is kind of a variant of the promptbook usefull for debugging, logging and transparency for users.
+ *
+ * It can have 2 formats:
+ * -   _(this)_ **.md file** created from the **JSON** format
+ * -   **JSON** format
+ *
+ * @see https://github.com/webgptorg/promptbook#execution-report
+ */
+export type ExecutionReportString = string & {
+    readonly _type: 'ExecutionReportString';
+};
+/**
+ * TODO: Better validation or remove branded type and make it just string
+ */

package/umd/typings/types/execution-report/executionReportJsonToString.d.ts

@@ -0,0 +1,6 @@
+import type { ExecutionReportJson } from './ExecutionReportJson';
+import type { ExecutionReportString } from './ExecutionReportString';
+/**
+ * Converts execution report from JSON to string format
+ */
+export declare function executionReportJsonToString(executionReportJson: ExecutionReportJson): ExecutionReportString;

package/umd/typings/types/typeAliases.d.ts

@@ -406,6 +406,8 @@ export type string_ssh_key = string;
 export type string_pgp_key = string;
 export type number_positive = number;
 export type number_negative = number;
+export type number_positive_or_zero = number;
+export type number_negative_or_zero = number;
 export type number_integer = number;
 /**
  * Semantic helper;
@@ -429,7 +431,7 @@ export type number_days = number;
 export type number_weeks = number;
 export type number_months = number;
 export type number_years = number;
-export type number_bytes = number_positive & number_integer;
+export type number_bytes = number_integer & number_positive;
 export type number_kilobytes = number_positive;
 export type number_megabytes = number_positive;
 export type number_gigabytes = number_positive;

package/umd/typings/utils/expectation-counters/countCharacters.d.ts

@@ -0,0 +1,5 @@
+import type { ExpectationAmount } from '../../types/PromptTemplatePipelineJson/PromptTemplateJson';
+/**
+ * Counts number of characters in the text
+ */
+export declare function countCharacters(text: string): ExpectationAmount;

package/umd/typings/utils/expectation-counters/countCharacters.test.d.ts

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

package/umd/typings/utils/expectation-counters/countLines.d.ts

@@ -0,0 +1,5 @@
+import type { ExpectationAmount } from '../../types/PromptTemplatePipelineJson/PromptTemplateJson';
+/**
+ * Counts number of lines in the text
+ */
+export declare function countLines(text: string): ExpectationAmount;

package/umd/typings/utils/expectation-counters/countLines.test.d.ts

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

package/umd/typings/utils/expectation-counters/countPages.d.ts

@@ -0,0 +1,5 @@
+import type { ExpectationAmount } from '../../types/PromptTemplatePipelineJson/PromptTemplateJson';
+/**
+ * Counts number of pages in the text
+ */
+export declare function countPages(text: string): ExpectationAmount;

package/umd/typings/utils/expectation-counters/countPages.test.d.ts

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

package/umd/typings/utils/expectation-counters/countParagraphs.d.ts

@@ -0,0 +1,5 @@
+import type { ExpectationAmount } from '../../types/PromptTemplatePipelineJson/PromptTemplateJson';
+/**
+ * Counts number of paragraphs in the text
+ */
+export declare function countParagraphs(text: string): ExpectationAmount;

package/umd/typings/utils/expectation-counters/countParagraphs.test.d.ts

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

package/umd/typings/utils/expectation-counters/countSentences.d.ts

@@ -0,0 +1,5 @@
+import type { ExpectationAmount } from '../../types/PromptTemplatePipelineJson/PromptTemplateJson';
+/**
+ * Counts number of sentences in the text
+ */
+export declare function countSentences(text: string): ExpectationAmount;

package/umd/typings/utils/expectation-counters/countSentences.test.d.ts

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

package/umd/typings/utils/expectation-counters/countWords.d.ts

@@ -0,0 +1,5 @@
+import type { ExpectationAmount } from '../../types/PromptTemplatePipelineJson/PromptTemplateJson';
+/**
+ * Counts number of words in the text
+ */
+export declare function countWords(text: string): ExpectationAmount;

package/umd/typings/utils/expectation-counters/countWords.test.d.ts

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

package/umd/typings/utils/expectation-counters/index.d.ts

@@ -0,0 +1,5 @@
+import type { ExpectationAmount, ExpectationUnit } from '../../types/PromptTemplatePipelineJson/PromptTemplateJson';
+/**
+ * Index of all counter functions
+ */
+export declare const CountUtils: Record<ExpectationUnit, (text: string) => ExpectationAmount>;

package/umd/typings/utils/markdown/prettifyMarkdown.d.ts

@@ -0,0 +1,8 @@
+import type { string_html } from '../../types/typeAliases';
+/**
+ * Prettify the html code
+ *
+ * @param html raw html code
+ * @returns formatted html code
+ */
+export declare function prettifyMarkdown(html: string_html): string_html;

package/umd/typings/utils/markdown/prettifyMarkdown.test.d.ts

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

package/umd/typings/utils/parseNumber.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Function parseNumber will parse number from string
+ *
+ * Unlike Number.parseInt, Number.parseFloat it will never ever result in NaN
+ * Note: it also works only with decimal numbers
+ */
+export declare function parseNumber(value: string | number): number;
+/**
+ * TODO: Maybe use sth. like safe-eval in fraction/calculation case @see https://www.npmjs.com/package/safe-eval
+ */

package/umd/typings/utils/parseNumber.test.d.ts

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

package/umd/typings/utils/trimCodeBlock.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Function trimCodeBlock will trim starting and ending code block from the string if it is present.
+ *
+ * Note: This is usefull for post-processing of the result of the chat LLM model
+ *       when the model wraps the result in the (markdown) code block.
+ *
+ */
+export declare function trimCodeBlock(value: string): string;

package/umd/typings/utils/trimCodeBlock.test.d.ts

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

package/umd/typings/utils/trimEndOfCodeBlock.d.ts

@@ -1,6 +1,7 @@
 /**
  * Function trimEndOfCodeBlock will remove ending code block from the string if it is present.
  *
- * This is usefull for post-processing of the result of the completion LLM model if you want to start code block in the prompt but you don't want to end it in the result.
+ * Note: This is usefull for post-processing of the result of the completion LLM model
+ *       if you want to start code block in the prompt but you don't want to end it in the result.
  */
 export declare function trimEndOfCodeBlock(value: string): string;