@promptbook/core 0.46.0 → 0.47.0

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/core",
-    "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": {
-        "spacetrim": "0.11.20"
+        "spacetrim": "0.11.23"
     },
+    "funding": [
+        {
+            "type": "individual",
+            "url": "https://buymeacoffee.com/hejny"
+        },
+        {
+            "type": "github",
+            "url": "https://github.com/webgptorg/promptbook/blob/main/README.md#%EF%B8%8F-contributing"
+        }
+    ],
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/_packages/core.index.d.ts"

package/umd/index.umd.js

@@ -123,6 +123,16 @@
         return to.concat(ar || Array.prototype.slice.call(from));
     }
 
+    /**
+     * Removes HTML or Markdown comments from a string.
+     *
+     * @param {string} content - The string to remove comments from.
+     * @returns {string} The input string with all comments removed.
+     */
+    function removeContentComments(content) {
+        return spacetrim.spaceTrim(content.replace(/<!--(.*?)-->/gs, ''));
+    }
+
     /**
      * This error type indicates that the error should not happen and its last check before crashing with some other error
      */
@@ -137,16 +147,6 @@
         return UnexpectedError;
     }(Error));
 
-    /**
-     * Removes HTML or Markdown comments from a string.
-     *
-     * @param {string} content - The string to remove comments from.
-     * @returns {string} The input string with all comments removed.
-     */
-    function removeContentComments(content) {
-        return spacetrim.spaceTrim(content.replace(/<!--(.*?)-->/gs, ''));
-    }
-
     /**
      * This error indicates that the promptbook in a markdown format cannot be parsed into a valid promptbook object
      */
@@ -1136,7 +1136,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.46.0-4';
+    var PROMPTBOOK_VERSION = '0.47.0-0';
 
     /**
      * Parses the given script and returns the list of all used variables that are not defined in the script
@@ -2081,13 +2081,13 @@
                                                     return [7 /*endfinally*/];
                                                 case 10:
                                                     if (errors.length === 0) {
-                                                        throw new PromptbookExecutionError('Postprocessing in NaturalExecutionTools failed because no ScriptExecutionTools were provided');
+                                                        throw new PromptbookExecutionError('Postprocessing in LlmExecutionTools failed because no ScriptExecutionTools were provided');
                                                     }
                                                     else if (errors.length === 1) {
                                                         throw errors[0];
                                                     }
                                                     else {
-                                                        throw new PromptbookExecutionError(spacetrim.spaceTrim(function (block) { return "\n                                                        Postprocessing in NaturalExecutionTools failed ".concat(errors.length, "x\n\n                                                        ").concat(block(errors.map(function (error) { return '- ' + error.message; }).join('\n\n')), "\n                                                      "); }));
+                                                        throw new PromptbookExecutionError(spacetrim.spaceTrim(function (block) { return "\n                                                        Postprocessing in LlmExecutionTools failed ".concat(errors.length, "x\n\n                                                        ").concat(block(errors.map(function (error) { return '- ' + error.message; }).join('\n\n')), "\n                                                      "); }));
                                                     }
                                             }
                                         });
@@ -2099,14 +2099,14 @@
                                     case 'COMPLETION': return [3 /*break*/, 9];
                                 }
                                 return [3 /*break*/, 11];
-                            case 7: return [4 /*yield*/, tools.natural.gptChat(prompt)];
+                            case 7: return [4 /*yield*/, tools.llm.gptChat(prompt)];
                             case 8:
                                 chatThread = _o.sent();
                                 // TODO: [🍬] Destroy chatThread
                                 result = chatThread;
                                 resultString = chatThread.content;
                                 return [3 /*break*/, 12];
-                            case 9: return [4 /*yield*/, tools.natural.gptComplete(prompt)];
+                            case 9: return [4 /*yield*/, tools.llm.gptComplete(prompt)];
                             case 10:
                                 completionResult = _o.sent();
                                 result = completionResult;
@@ -2293,7 +2293,7 @@
                                     currentTemplate.executionType === 'PROMPT_TEMPLATE' &&
                                     prompt
                                 //    <- Note:  [2] When some expected parameter is not defined, error will occur in replaceParameters
-                                //              In that case we don’t want to make a report about it because it’s not a natural execution error
+                                //              In that case we don’t want to make a report about it because it’s not a llm execution error
                                 ) {
                                     // TODO: [🧠] Maybe put other executionTypes into report
                                     executionReport.promptExecutions.push({
@@ -2311,7 +2311,7 @@
                                 return [7 /*endfinally*/];
                             case 47:
                                 if (expectError !== null && attempt === maxAttempts - 1) {
-                                    throw new PromptbookExecutionError(spacetrim.spaceTrim(function (block) { return "\n                              Natural execution failed ".concat(maxExecutionAttempts, "x\n\n                              ---\n                              Last error ").concat((expectError === null || expectError === void 0 ? void 0 : expectError.name) || '', ":\n                              ").concat(block((expectError === null || expectError === void 0 ? void 0 : expectError.message) || ''), "\n\n                              Last result:\n                              ").concat(resultString, "\n                              ---\n                          "); }));
+                                    throw new PromptbookExecutionError(spacetrim.spaceTrim(function (block) { return "\n                              LLM execution failed ".concat(maxExecutionAttempts, "x\n\n                              ---\n                              Last error ").concat((expectError === null || expectError === void 0 ? void 0 : expectError.name) || '', ":\n                              ").concat(block((expectError === null || expectError === void 0 ? void 0 : expectError.message) || ''), "\n\n                              Last result:\n                              ").concat(resultString, "\n                              ---\n                          "); }));
                                 }
                                 _o.label = 48;
                             case 48: