@promptbook/cli 0.46.0 → 0.47.0

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/cli",
-    "version": "0.46.0",
+    "version": "0.47.0",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -38,11 +38,21 @@
         "commander": "12.0.0",
         "glob-promise": "6.0.5",
         "prettier": "2.8.1",
-        "spacetrim": "0.11.20",
-        "waitasecond": "1.11.33"
+        "spacetrim": "0.11.23",
+        "waitasecond": "1.11.67"
     },
+    "funding": [
+        {
+            "type": "individual",
+            "url": "https://buymeacoffee.com/hejny"
+        },
+        {
+            "type": "github",
+            "url": "https://github.com/webgptorg/promptbook/blob/main/README.md#%EF%B8%8F-contributing"
+        }
+    ],
     "peerDependencies": {
-        "@promptbook/core": "0.46.0"
+        "@promptbook/core": "0.47.0"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",

package/umd/index.umd.js

@@ -146,7 +146,67 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.46.0-4';
+    var PROMPTBOOK_VERSION = '0.47.0-0';
+
+    /**
+     * This error type indicates that the error should not happen and its last check before crashing with some other error
+     */
+    var UnexpectedError = /** @class */ (function (_super) {
+        __extends(UnexpectedError, _super);
+        function UnexpectedError(message) {
+            var _this = _super.call(this, spacetrim.spaceTrim(function (block) { return "\n                    ".concat(block(message), "\n\n                    Note: This error should not happen.\n                    It's probbably a bug in the promptbook library\n\n                    Please report issue:\n                    https://github.com/webgptorg/promptbook/issues\n\n                    Or contact us on me@pavolhejny.com\n\n                "); })) || this;
+            _this.name = 'UnexpectedError';
+            Object.setPrototypeOf(_this, UnexpectedError.prototype);
+            return _this;
+        }
+        return UnexpectedError;
+    }(Error));
+
+    /**
+     * Creates a Mermaid graph based on the promptbook
+     *
+     * Note: The result is not wrapped in a Markdown code block
+     */
+    function renderPromptbookMermaid(promptbookJson) {
+        var parameterNameToTemplateName = function (parameterName) {
+            var parameter = promptbookJson.parameters.find(function (parameter) { return parameter.name === parameterName; });
+            if (!parameter) {
+                throw new UnexpectedError("Could not find {".concat(parameterName, "}"));
+            }
+            if (parameter.isInput) {
+                return 'input';
+            }
+            var template = promptbookJson.promptTemplates.find(function (template) { return template.resultingParameterName === parameterName; });
+            if (!template) {
+                throw new Error("Could not find template for {".concat(parameterName, "}"));
+            }
+            return 'template' + normalizeTo_PascalCase(template.title);
+        };
+        var promptbookMermaid = spacetrim.spaceTrim(function (block) { return "\n\n            %% \uD83D\uDD2E Tip: Open this on GitHub or in the VSCode website to see the Mermaid graph visually\n\n            flowchart LR\n              subgraph \"".concat(promptbookJson.title, "\"\n\n                  direction TB\n\n                  input((Input)):::input\n                  ").concat(block(promptbookJson.promptTemplates
+            .flatMap(function (_a) {
+            var title = _a.title, dependentParameterNames = _a.dependentParameterNames, resultingParameterName = _a.resultingParameterName;
+            return __spreadArray([
+                "".concat(parameterNameToTemplateName(resultingParameterName), "(\"").concat(title, "\")")
+            ], __read(dependentParameterNames.map(function (dependentParameterName) {
+                return "".concat(parameterNameToTemplateName(dependentParameterName), "--\"{").concat(dependentParameterName, "}\"-->").concat(parameterNameToTemplateName(resultingParameterName));
+            })), false);
+        })
+            .join('\n')), "\n\n                  ").concat(block(promptbookJson.parameters
+            .filter(function (_a) {
+            var isOutput = _a.isOutput;
+            return isOutput;
+        })
+            .map(function (_a) {
+            var name = _a.name;
+            return "".concat(parameterNameToTemplateName(name), "--\"{").concat(name, "}\"-->output");
+        })
+            .join('\n')), "\n                  output((Output)):::output\n\n                  classDef input color: grey;\n                  classDef output color: grey;\n\n              end;\n\n        "); });
+        return promptbookMermaid;
+    }
+    /**
+     * TODO: Maybe use some Mermaid library instead of string templating
+     * TODO: [🕌] When more than 2 functionalities, split into separate functions
+     */
 
     /**
      * This error indicates that the promptbook in a markdown format cannot be parsed into a valid promptbook object
@@ -524,20 +584,6 @@
         return TemplateError;
     })(Error));
 
-    /**
-     * This error type indicates that the error should not happen and its last check before crashing with some other error
-     */
-    var UnexpectedError = /** @class */ (function (_super) {
-        __extends(UnexpectedError, _super);
-        function UnexpectedError(message) {
-            var _this = _super.call(this, spacetrim.spaceTrim(function (block) { return "\n                    ".concat(block(message), "\n\n                    Note: This error should not happen.\n                    It's probbably a bug in the promptbook library\n\n                    Please report issue:\n                    https://github.com/webgptorg/promptbook/issues\n\n                    Or contact us on me@pavolhejny.com\n\n                "); })) || this;
-            _this.name = 'UnexpectedError';
-            Object.setPrototypeOf(_this, UnexpectedError.prototype);
-            return _this;
-        }
-        return UnexpectedError;
-    }(Error));
-
     /**
      * Prettify the html code
      *
@@ -1606,45 +1652,13 @@
     }
 
     /**
-     * !!!
+     * Prettyfies Promptbook string and adds Mermaid graph
      */
     function prettifyPromptbookString(promptbookString, options) {
         var isGraphAdded = options.isGraphAdded, isPrettifyed = options.isPrettifyed;
         if (isGraphAdded) {
-            var promptbookJson_1 = promptbookStringToJson(promptbookString);
-            var parameterNameToTemplateName_1 = function (parameterName) {
-                var parameter = promptbookJson_1.parameters.find(function (parameter) { return parameter.name === parameterName; });
-                if (!parameter) {
-                    throw new UnexpectedError("Could not find {".concat(parameterName, "}"));
-                }
-                if (parameter.isInput) {
-                    return 'input';
-                }
-                var template = promptbookJson_1.promptTemplates.find(function (template) { return template.resultingParameterName === parameterName; });
-                if (!template) {
-                    throw new Error("Could not find template for {".concat(parameterName, "}"));
-                }
-                return 'template' + normalizeTo_PascalCase(template.title);
-            };
-            var promptbookMermaid_1 = spacetrim.spaceTrim(function (block) { return "\n\n                %% \uD83D\uDD2E Tip: Open this on GitHub or in the VSCode website to see the Mermaid graph visually\n\n                flowchart LR\n                  subgraph \"".concat(promptbookJson_1.title, "\"\n\n                      direction TB\n\n                      input((Input)):::input\n                      ").concat(block(promptbookJson_1.promptTemplates
-                .flatMap(function (_a) {
-                var title = _a.title, dependentParameterNames = _a.dependentParameterNames, resultingParameterName = _a.resultingParameterName;
-                return __spreadArray([
-                    "".concat(parameterNameToTemplateName_1(resultingParameterName), "(\"").concat(title, "\")")
-                ], __read(dependentParameterNames.map(function (dependentParameterName) {
-                    return "".concat(parameterNameToTemplateName_1(dependentParameterName), "--\"{").concat(dependentParameterName, "}\"-->").concat(parameterNameToTemplateName_1(resultingParameterName));
-                })), false);
-            })
-                .join('\n')), "\n\n                      ").concat(block(promptbookJson_1.parameters
-                .filter(function (_a) {
-                var isOutput = _a.isOutput;
-                return isOutput;
-            })
-                .map(function (_a) {
-                var name = _a.name;
-                return "".concat(parameterNameToTemplateName_1(name), "--\"{").concat(name, "}\"-->output");
-            })
-                .join('\n')), "\n                      output((Output)):::output\n\n                      classDef input color: grey;\n                      classDef output color: grey;\n\n                  end;\n\n\n\n        "); });
+            var promptbookJson = promptbookStringToJson(promptbookString);
+            var promptbookMermaid_1 = renderPromptbookMermaid(promptbookJson);
             var promptbookMermaidBlock = spacetrim.spaceTrim(function (block) { return "\n            ```mermaid\n            ".concat(block(promptbookMermaid_1), "\n            ```\n        "); });
             promptbookString = addAutoGeneratedSection(promptbookString, {
                 sectionName: 'Graph',