@promptbook/openai 0.52.0-3 → 0.52.0-30

package/README.md

@@ -30,9 +30,111 @@ npm i ptbk
 npm i @promptbook/openai
 ```
 
-Wrapper around [OpenAI's SDK](https://www.npmjs.com/package/openai) to make it easier to use inside Promptbooks.
+`@promptbook/openai` integrates [OpenAI's API](https://openai.com/) with [Promptbook](https://github.com/webgptorg/promptbook). It allows to execute Promptbooks with OpenAI GPT models.
 
+## 🧡 Usage
 
+```typescript
+import {
+    createPromptbookExecutor,
+    createPromptbookLibraryFromDirectory,
+    assertsExecutionSuccessful,
+} from '@promptbook/core';
+import { JavascriptExecutionTools } from '@promptbook/execute-javascript';
+import { OpenAiExecutionTools } from '@promptbook/openai';
+
+// ▶ Create whole Promptbook library
+const library = await createPromptbookLibraryFromDirectory('./promptbook-library');
+
+// ▶ Get one Promptbook
+const promptbook = await library.getPromptbookByUrl(`https://promptbook.studio/my-library/write-article.ptbk.md`);
+
+// ▶ Prepare tools
+const tools = {
+    llm: new OpenAiExecutionTools({
+        apiKey: process.env.OPENAI_API_KEY,
+    }),
+    script: [new JavascriptExecutionTools()],
+};
+
+// ▶ Create executor - the function that will execute the Promptbook
+const promptbookExecutor = createPromptbookExecutor({ promptbook, tools });
+
+// ▶ Prepare input parameters
+const inputParameters = { word: 'cat' };
+
+// 🚀▶ Execute the Promptbook
+const result = await promptbookExecutor(inputParameters);
+
+// ▶ Fail if the execution was not successful
+assertsExecutionSuccessful(result);
+
+// ▶ Handle the result
+const { isSuccessful, errors, outputParameters, executionReport } = result;
+console.info(outputParameters);
+```
+
+## 💕 Usage of multiple LLM providers
+
+You can use multiple LLM providers in one Promptbook execution. The best model will be chosen automatically according to the prompt and the model's capabilities.
+
+```typescript
+import {
+    createPromptbookExecutor,
+    createPromptbookLibraryFromDirectory,
+    assertsExecutionSuccessful,
+} from '@promptbook/core';
+import { JavascriptExecutionTools } from '@promptbook/execute-javascript';
+import { OpenAiExecutionTools } from '@promptbook/openai';
+
+// ▶ Create whole Promptbook library
+const library = await createPromptbookLibraryFromDirectory('./promptbook-library');
+
+// ▶ Get one Promptbook
+const promptbook = await library.getPromptbookByUrl(`https://promptbook.studio/my-library/write-article.ptbk.md`);
+
+// ▶ Prepare tools
+const tools = new MultipleLlmExecutionTools(
+    // Note: You can use multiple LLM providers in one Promptbook execution. The best model will be chosen automatically according to the prompt and the model's capabilities.
+    new OpenAiExecutionTools({
+        isVerbose: true,
+        apiKey: process.env.OPENAI_API_KEY,
+    }),
+    new AnthropicClaudeExecutionTools({
+        isVerbose: true,
+        apiKey: process.env.ANTHROPIC_CLAUDE_API_KEY,
+    }),
+    new AzureOpenAiExecutionTools({
+        isVerbose: true,
+        resourceName: process.env.AZUREOPENAI_RESOURCE_NAME,
+        deploymentName: process.env.AZUREOPENAI_DEPLOYMENT_NAME,
+        apiKey: process.env.AZUREOPENAI_API_KEY,
+    }),
+);
+
+// ▶ Create executor - the function that will execute the Promptbook
+const promptbookExecutor = createPromptbookExecutor({ promptbook, tools });
+
+// ▶ Prepare input parameters
+const inputParameters = { word: 'cat' };
+
+// 🚀▶ Execute the Promptbook
+const result = await promptbookExecutor(inputParameters);
+
+// ▶ Fail if the execution was not successful
+assertsExecutionSuccessful(result);
+
+// ▶ Handle the result
+const { isSuccessful, errors, outputParameters, executionReport } = result;
+console.info(outputParameters);
+```
+
+## 💙 Integration with other models
+
+See the other models available in the Promptbook package:
+
+-   [Azure OpenAI](https://www.npmjs.com/package/@promptbook/azure-openai)
+-   [Anthropic Claude](https://www.npmjs.com/package/@promptbook/anthropic-claude)
 
 
 
@@ -96,7 +198,7 @@ File `write-website-content.ptbk.md`:
 >
 > Instructions for creating web page content.
 >
-> -   PROMPTBOOK URL https://promptbook.webgpt.com/en/write-website-content.ptbk.md@v0.1.0
+> -   PROMPTBOOK URL https://promptbook.webgpt.com/en/write-website-content.ptbk.md
 > -   PROMPTBOOK VERSION 0.0.1
 > -   INPUT  PARAM `{rawTitle}` Automatically suggested a site name or empty text
 > -   INPUT  PARAM `{rawAssigment}` Automatically generated site entry from image recognition
@@ -555,8 +657,6 @@ _Note: LLMs work with tokens, not characters, but in Promptbooks we want to use
 ```markdown
 # ✨ Sample: Expectations
 
--   PROMPTBOOK URL https://promptbook.example.com/samples/postprocessing-2.ptbk.md@v1
--   PROMPTBOOK VERSION 1.0.0
 -   INPUT  PARAMETER {yourName} Name of the hero
 
 ## 💬 Question

package/esm/index.es.js

@@ -675,7 +675,7 @@ var OpenAiExecutionTools = /** @class */ (function () {
     return OpenAiExecutionTools;
 }());
 /**
- * TODO: [🍓][♐] Allow to list compatible models with each variant
+ * TODO: [🧠][🧙‍♂️] Maybe there can be some wizzard for thoose who want to use just OpenAI
  * TODO: Maybe Create some common util for gptChat and gptComplete
  * TODO: Maybe make custom OpenaiError
  */

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

@@ -1,20 +1,29 @@
-import { promptbookStringToJson } from '../conversion/promptbookStringToJson';
+import { prettifyPromptbookString } from '../conversion/prettify/prettifyPromptbookString';
 import { promptbookJsonToString } from '../conversion/promptbookJsonToString';
+import { promptbookStringToJson } from '../conversion/promptbookStringToJson';
 import { validatePromptbookJson } from '../conversion/validation/validatePromptbookJson';
+import { assertsExecutionSuccessful } from '../execution/assertsExecutionSuccessful';
 import { createPromptbookExecutor } from '../execution/createPromptbookExecutor';
+import { MultipleLlmExecutionTools } from '../execution/plugins/llm-execution-tools/multiple/MultipleLlmExecutionTools';
 import { CallbackInterfaceTools } from '../execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceTools';
 import { CallbackInterfaceToolsOptions } from '../execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceToolsOptions';
 import { SimplePromptInterfaceTools } from '../execution/plugins/user-interface-execution-tools/simple-prompt/SimplePromptInterfaceTools';
-import { SimplePromptbookLibrary } from '../library/SimplePromptbookLibrary';
-import { createPromptbookLibraryFromPromise } from '../library/constructors/createPromptbookLibraryFromPromise';
+import { checkExpectations, isPassingExpectations } from '../execution/utils/checkExpectations';
+import { createPromptbookLibraryFromDirectory } from '../library/constructors/createPromptbookLibraryFromDirectory';
 import { createPromptbookLibraryFromSources } from '../library/constructors/createPromptbookLibraryFromSources';
+import { createPromptbookLibraryFromUrl } from '../library/constructors/createPromptbookLibraryFromUrl';
 import { createPromptbookSublibrary } from '../library/constructors/createPromptbookSublibrary';
+import { justTestFsImport } from '../library/constructors/justTestFsImport';
+import { SimplePromptbookLibrary } from '../library/SimplePromptbookLibrary';
+import { executionReportJsonToString } from '../types/execution-report/executionReportJsonToString';
+import { ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults } from '../types/execution-report/ExecutionReportStringOptions';
 import { ExecutionTypes } from '../types/ExecutionTypes';
 import { PROMPTBOOK_VERSION } from '../version';
-import { MultipleLlmExecutionTools } from '../execution/plugins/llm-execution-tools/multiple/MultipleLlmExecutionTools';
+export { justTestFsImport };
 export { ExecutionTypes, PROMPTBOOK_VERSION };
-export { createPromptbookLibraryFromPromise, createPromptbookLibraryFromSources, createPromptbookSublibrary, SimplePromptbookLibrary, };
+export { assertsExecutionSuccessful, checkExpectations, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, isPassingExpectations, prettifyPromptbookString, };
+export { createPromptbookLibraryFromDirectory, createPromptbookLibraryFromSources, createPromptbookLibraryFromUrl, createPromptbookSublibrary, SimplePromptbookLibrary, };
 export { SimplePromptInterfaceTools };
-export { promptbookStringToJson, promptbookJsonToString, validatePromptbookJson };
+export { promptbookJsonToString, promptbookStringToJson, validatePromptbookJson };
 export { createPromptbookExecutor, MultipleLlmExecutionTools };
 export { CallbackInterfaceTools, CallbackInterfaceToolsOptions };

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

@@ -1,16 +1,12 @@
 import { spaceTrim } from 'spacetrim';
-import { prettifyPromptbookString } from '../conversion/prettify/prettifyPromptbookString';
 import { renderPromptbookMermaid } from '../conversion/prettify/renderPromptbookMermaid';
 import { extractParametersFromPromptTemplate } from '../conversion/utils/extractParametersFromPromptTemplate';
 import { extractVariables } from '../conversion/utils/extractVariables';
 import { parseNumber } from '../conversion/utils/parseNumber';
 import { renameParameter } from '../conversion/utils/renameParameter';
 import { titleToName } from '../conversion/utils/titleToName';
-import { assertsExecutionSuccessful } from '../execution/assertsExecutionSuccessful';
-import { checkExpectations, isPassingExpectations } from '../execution/utils/checkExpectations';
+import { forEachAsync } from '../execution/utils/forEachAsync';
 import { replaceParameters } from '../execution/utils/replaceParameters';
-import { executionReportJsonToString } from '../types/execution-report/executionReportJsonToString';
-import { ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults } from '../types/execution-report/ExecutionReportStringOptions';
 import { CountUtils } from '../utils/expectation-counters';
 import { countCharacters } from '../utils/expectation-counters/countCharacters';
 import { countLines } from '../utils/expectation-counters/countLines';
@@ -51,10 +47,11 @@ import { union } from '../utils/sets/union';
 import { trimCodeBlock } from '../utils/trimCodeBlock';
 import { trimEndOfCodeBlock } from '../utils/trimEndOfCodeBlock';
 import { unwrapResult } from '../utils/unwrapResult';
-export { assertsExecutionSuccessful, checkExpectations, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, extractAllBlocksFromMarkdown, // <- [🌻]
+export { forEachAsync };
+export { extractAllBlocksFromMarkdown, // <- [🌻]
 extractAllListItemsFromMarkdown, extractBlock, // <- [🌻]
-extractOneBlockFromMarkdown, extractParameters, extractVariables, isPassingExpectations, isValidJsonString, parseNumber, // <- [🌻]
-prettifyPromptbookString, removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, replaceParameters, spaceTrim, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
+extractOneBlockFromMarkdown, extractParameters, extractVariables, isValidJsonString, parseNumber, // <- [🌻]
+removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, replaceParameters, spaceTrim, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
 export { countCharacters, countLines, countPages, countParagraphs, countSentences, CountUtils, countWords };
 export { splitIntoSentences };
 export declare const normalizeTo: {

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

@@ -9,6 +9,9 @@ import type { UserInterfaceTools } from './UserInterfaceTools';
 export type ExecutionTools = {
     /**
      * Tools for executing prompts to large language models like GPT-4
+     *
+     * Tip: Combine multiple LLM execution tools with `MultipleLlmExecutionTools`
+     * @see https://github.com/webgptorg/promptbook/?tab=readme-ov-file#llm-execution-tools
      */
     llm: LlmExecutionTools;
     /**
@@ -16,15 +19,14 @@ export type ExecutionTools = {
      *
      * Note: You can pass multiple ScriptExecutionTools, they will be tried one by one until one of them supports the script
      *       If none of them supports the script, an error is thrown
+     * @see https://github.com/webgptorg/promptbook/?tab=readme-ov-file#script-execution-tools
      */
     script: Array<ScriptExecutionTools>;
     /**
      * Tools for interacting with the user
      *
      * Note: When undefined, the user interface is disabled and promptbook which requires user interaction will fail
+     * @see https://github.com/webgptorg/promptbook/?tab=readme-ov-file#user-interface-tools
      */
     userInterface?: UserInterfaceTools;
 };
-/**
- * TODO: [🍓] !!!! Allow to have more LlmExecutionTools
- */

package/esm/typings/execution/plugins/llm-execution-tools/anthropic-claude/AnthropicClaudeExecutionTools.d.ts

@@ -36,7 +36,6 @@ export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools
 }
 /**
  * TODO: [🧠] Maybe handle errors via transformAnthropicError (like transformAzureError)
- * TODO: [🍓][♐] Allow to list compatible models with each variant
  * TODO: Maybe Create some common util for gptChat and gptComplete
  * TODO: Maybe make custom OpenaiError
  */

package/esm/typings/execution/plugins/llm-execution-tools/azure-openai/AzureOpenAiExecutionTools.d.ts

@@ -35,7 +35,6 @@ export declare class AzureOpenAiExecutionTools implements LlmExecutionTools {
     listModels(): Promise<Array<AvailableModel>>;
 }
 /**
- * TODO: [🍓][♐] Allow to list compatible models with each variant
  * TODO: Maybe Create some common util for gptChat and gptComplete
  * TODO: Maybe make custom AzureOpenaiError
  */

package/esm/typings/execution/plugins/llm-execution-tools/langtail/LangtailExecutionTools.d.ts

@@ -5,6 +5,3 @@ import { OpenAiExecutionTools } from '../openai/OpenAiExecutionTools';
  */
 export declare class LangtailExecutionTools extends OpenAiExecutionTools implements LlmExecutionTools {
 }
-/**
- * TODO: [🍓][♐] Allow to list the available prompts in Langtail
- */

package/esm/typings/execution/plugins/llm-execution-tools/openai/OpenAiExecutionTools.d.ts

@@ -39,7 +39,7 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
     listModels(): Array<AvailableModel>;
 }
 /**
- * TODO: [🍓][♐] Allow to list compatible models with each variant
+ * TODO: [🧠][🧙‍♂️] Maybe there can be some wizzard for thoose who want to use just OpenAI
  * TODO: Maybe Create some common util for gptChat and gptComplete
  * TODO: Maybe make custom OpenaiError
  */

package/esm/typings/execution/plugins/llm-execution-tools/remote/RemoteLlmExecutionTools.d.ts

@@ -35,6 +35,6 @@ export declare class RemoteLlmExecutionTools implements LlmExecutionTools {
     listModels(): Promise<Array<AvailableModel>>;
 }
 /**
- * TODO: [🍓][♐] Allow to list compatible models with each variant
+ * TODO: [🍓] Allow to list compatible models with each variant
  * TODO: [🤹‍♂️] RemoteLlmExecutionTools should extend Destroyable and implement IDestroyable
  */

package/esm/typings/execution/plugins/script-execution-tools/javascript/JavascriptEvalExecutionTools.d.ts

@@ -8,7 +8,7 @@ import { JavascriptExecutionToolsOptions } from './JavascriptExecutionToolsOptio
  */
 export declare class JavascriptEvalExecutionTools implements ScriptExecutionTools {
     private readonly options;
-    constructor(options: JavascriptExecutionToolsOptions);
+    constructor(options?: JavascriptExecutionToolsOptions);
     /**
      * Executes a JavaScript
      */

package/esm/typings/execution/plugins/script-execution-tools/javascript/JavascriptExecutionTools.d.ts

@@ -1,20 +1,7 @@
-import { ScriptExecutionTools, ScriptExecutionToolsExecuteOptions } from '../../../ScriptExecutionTools';
-import { JavascriptExecutionToolsOptions } from './JavascriptExecutionToolsOptions';
+import { JavascriptEvalExecutionTools } from './JavascriptEvalExecutionTools';
 /**
- * ScriptExecutionTools for JavaScript implemented via vm2
+ * Placeholder for better implementation of JavascriptExecutionTools - some propper sandboxing
  *
- * Warning: This is not implemented yet
- */
-export declare class JavascriptExecutionTools implements ScriptExecutionTools {
-    private readonly options;
-    constructor(options: JavascriptExecutionToolsOptions);
-    /**
-     * Executes a JavaScript
-     */
-    execute(options: ScriptExecutionToolsExecuteOptions): Promise<string>;
-}
-/**
- * TODO: !! Pass isVerbose to constructor and use it
- * TODO: !! Probbably make some common util createStatementToEvaluate
- * TODO: !! Implement via vm2
+ * @alias JavascriptExecutionTools
  */
+export declare const JavascriptExecutionTools: typeof JavascriptEvalExecutionTools;

package/esm/typings/execution/utils/forEachAsync.d.ts

@@ -0,0 +1,18 @@
+import type { Promisable } from 'type-fest';
+type ForEachAsyncOptions = {
+    /**
+     * Maximum number of tasks running in parallel
+     *
+     * @default Infinity
+     */
+    inParallelCount?: number;
+};
+/**
+ * Async version of Array.forEach
+ *
+ * @param array - Array to iterate over
+ * @param options - Options for the function
+ * @param callbackfunction - Function to call for each item
+ */
+export declare function forEachAsync<TItem>(array: Array<TItem>, options: ForEachAsyncOptions, callbackfunction: (value: TItem, index: number, array: Array<TItem>) => Promisable<void>): Promise<void>;
+export {};

package/esm/typings/library/constructors/createPromptbookLibraryFromDirectory.d.ts

@@ -1,14 +1,46 @@
+import { string_folder_path } from '../../types/typeAliases';
 import { PromptbookLibrary } from '../PromptbookLibrary';
+/**
+ * Options for `createPromptbookLibraryFromDirectory` function
+ */
+type CreatePromptbookLibraryFromDirectoryOptions = {
+    /**
+     * If true, the directory is searched recursively for promptbooks
+     *
+     * @default true
+     */
+    isRecursive?: boolean;
+    /**
+     * If true, the library creation outputs information about each file it reads
+     *
+     * @default false
+     */
+    isVerbose?: boolean;
+    /**
+     * If true, directory will be scanned only when needed not during the construction
+     *
+     * @default false
+     */
+    isLazyLoaded?: boolean;
+};
 /**
  * Constructs Promptbook from given directory
  *
  * Note: Works only in Node.js environment because it reads the file system
- * Note: The function does NOT return promise it returns the library directly which dynamically loads promptbooks when needed
- *       SO during the construction syntax and logic sources IS NOT validated
  *
+ * @param path - path to the directory with promptbooks
+ * @param options - Misc options for the library
  * @returns PromptbookLibrary
  */
-export declare function createPromptbookLibraryFromDirectory(): PromptbookLibrary;
+export declare function createPromptbookLibraryFromDirectory(path: string_folder_path, options?: CreatePromptbookLibraryFromDirectoryOptions): Promise<PromptbookLibrary>;
+export {};
 /***
- * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
+ * TODO: [🧠] Maybe do not do hacks like [1] and just create package @promptbook/node
+ *       [🍓][🚯] maybe make `@promptbook/library` package
+ * TODO: Fix the dynamic import issue in Webpack (! Not working !)
+ *     > ./node_modules/@promptbook/core/esm/index.es.js
+ *     > Critical dependency: the request of a dependency is an expression
+ *
+ * Note: [1] Using require(just('fs/promises')) to allow
+ *     the `@promptbook/core` work for both Node.js and browser environments
  */

package/esm/typings/library/constructors/createPromptbookLibraryFromDirectory.test.d.ts

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

package/esm/typings/library/constructors/createPromptbookLibraryFromPromise.d.ts

@@ -14,11 +14,11 @@ import { PromptbookLibrary } from '../PromptbookLibrary';
  * Note: The function does NOT return promise it returns the library directly which waits for the sources to be resolved
  *       when error occurs in given promise or factory function, it is thrown during `listPromptbooks` or `getPromptbookByUrl` call
  *
+ * Note: Consider using  `createPromptbookLibraryFromDirectory` or `createPromptbookLibraryFromUrl`
  *
  * @param promptbookSourcesPromiseOrFactory
  * @returns PromptbookLibrary
- *
- * @deprecated Consider using `createPromptbookLibraryFromUrl` or `createPromptbookLibraryFromDirectory`
+ * @private Just internal tool for other constructor functions
  */
 export declare function createPromptbookLibraryFromPromise(promptbookSourcesPromiseOrFactory: Promise<Array<PromptbookJson | PromptbookString>> | (() => Promise<Array<PromptbookJson | PromptbookString>>)): PromptbookLibrary;
 /***

package/esm/typings/library/constructors/createPromptbookLibraryFromPromise.test.d.ts

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

package/esm/typings/library/constructors/createPromptbookLibraryFromSources.test.d.ts

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

package/esm/typings/library/constructors/createPromptbookLibraryFromUrl.d.ts

@@ -1,13 +1,29 @@
+import { string_url } from '../../types/typeAliases';
 import { PromptbookLibrary } from '../PromptbookLibrary';
+/**
+ * Options for `createPromptbookLibraryFromDirectory` function
+ */
+type CreatePromptbookLibraryFromUrlyOptions = {
+    /**
+     * If true, the library creation outputs information about each file it reads
+     *
+     * @default false
+     */
+    isVerbose?: boolean;
+    /**
+     * If true, directory will be scanned only when needed not during the construction
+     *
+     * @default false
+     */
+    isLazyLoaded?: boolean;
+};
 /**
  * Constructs Promptbook from remote Promptbase URL
- *
- * Note: The function does NOT return promise it returns the library directly which dynamically loads promptbooks when needed
- *       SO during the construction syntax and logic sources IS NOT validated
- *
+
  * @returns PromptbookLibrary
  */
-export declare function createPromptbookLibraryFromUrl(): PromptbookLibrary;
+export declare function createPromptbookLibraryFromUrl(url: string_url | URL, options: CreatePromptbookLibraryFromUrlyOptions): Promise<PromptbookLibrary>;
+export {};
 /***
  * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
  */

package/esm/typings/library/constructors/justTestFsImport.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Just testing imports and compatibility
+ */
+export declare function justTestFsImport(): Promise<void>;
+/**
+ * TODO: !!! Remove this file
+ */ 

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

@@ -39,7 +39,7 @@ export type Prompt = {
     /**
      * Unique identifier of the promptbook with specific template name as hash
      *
-     * @example https://promptbook.webgpt.com/cs/write-website-content.ptbk.md@v2.4.15#keywords
+     * @example https://promptbook.webgpt.com/cs/write-website-content.ptbk.md#keywords
      */
     readonly promptbookUrl: string_promptbook_url_with_hashtemplate;
     /**

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

@@ -179,13 +179,13 @@ export type string_url = string;
 /**
  * Semantic helper
  *
- * For example `"https://promptbook.webgpt.com/cs/write-website-content.ptbk.md@v2.4.15"`
+ * For example `"https://promptbook.webgpt.com/cs/write-website-content.ptbk.md"`
  */
 export type string_promptbook_url = string;
 /**
  * Semantic helper
  *
- * For example `"https://promptbook.webgpt.com/cs/write-website-content.ptbk.md@v2.4.15#keywords"`
+ * For example `"https://promptbook.webgpt.com/cs/write-website-content.ptbk.md#keywords"`
  */
 export type string_promptbook_url_with_hashtemplate = string;
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.52.0-3",
+    "version": "0.52.0-30",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -48,7 +48,7 @@
         }
     ],
     "peerDependencies": {
-        "@promptbook/core": "0.52.0-3"
+        "@promptbook/core": "0.52.0-30"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",

package/umd/index.umd.js

@@ -683,7 +683,7 @@
         return OpenAiExecutionTools;
     }());
     /**
-     * TODO: [🍓][♐] Allow to list compatible models with each variant
+     * TODO: [🧠][🧙‍♂️] Maybe there can be some wizzard for thoose who want to use just OpenAI
      * TODO: Maybe Create some common util for gptChat and gptComplete
      * TODO: Maybe make custom OpenaiError
      */

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

@@ -1,20 +1,29 @@
-import { promptbookStringToJson } from '../conversion/promptbookStringToJson';
+import { prettifyPromptbookString } from '../conversion/prettify/prettifyPromptbookString';
 import { promptbookJsonToString } from '../conversion/promptbookJsonToString';
+import { promptbookStringToJson } from '../conversion/promptbookStringToJson';
 import { validatePromptbookJson } from '../conversion/validation/validatePromptbookJson';
+import { assertsExecutionSuccessful } from '../execution/assertsExecutionSuccessful';
 import { createPromptbookExecutor } from '../execution/createPromptbookExecutor';
+import { MultipleLlmExecutionTools } from '../execution/plugins/llm-execution-tools/multiple/MultipleLlmExecutionTools';
 import { CallbackInterfaceTools } from '../execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceTools';
 import { CallbackInterfaceToolsOptions } from '../execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceToolsOptions';
 import { SimplePromptInterfaceTools } from '../execution/plugins/user-interface-execution-tools/simple-prompt/SimplePromptInterfaceTools';
-import { SimplePromptbookLibrary } from '../library/SimplePromptbookLibrary';
-import { createPromptbookLibraryFromPromise } from '../library/constructors/createPromptbookLibraryFromPromise';
+import { checkExpectations, isPassingExpectations } from '../execution/utils/checkExpectations';
+import { createPromptbookLibraryFromDirectory } from '../library/constructors/createPromptbookLibraryFromDirectory';
 import { createPromptbookLibraryFromSources } from '../library/constructors/createPromptbookLibraryFromSources';
+import { createPromptbookLibraryFromUrl } from '../library/constructors/createPromptbookLibraryFromUrl';
 import { createPromptbookSublibrary } from '../library/constructors/createPromptbookSublibrary';
+import { justTestFsImport } from '../library/constructors/justTestFsImport';
+import { SimplePromptbookLibrary } from '../library/SimplePromptbookLibrary';
+import { executionReportJsonToString } from '../types/execution-report/executionReportJsonToString';
+import { ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults } from '../types/execution-report/ExecutionReportStringOptions';
 import { ExecutionTypes } from '../types/ExecutionTypes';
 import { PROMPTBOOK_VERSION } from '../version';
-import { MultipleLlmExecutionTools } from '../execution/plugins/llm-execution-tools/multiple/MultipleLlmExecutionTools';
+export { justTestFsImport };
 export { ExecutionTypes, PROMPTBOOK_VERSION };
-export { createPromptbookLibraryFromPromise, createPromptbookLibraryFromSources, createPromptbookSublibrary, SimplePromptbookLibrary, };
+export { assertsExecutionSuccessful, checkExpectations, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, isPassingExpectations, prettifyPromptbookString, };
+export { createPromptbookLibraryFromDirectory, createPromptbookLibraryFromSources, createPromptbookLibraryFromUrl, createPromptbookSublibrary, SimplePromptbookLibrary, };
 export { SimplePromptInterfaceTools };
-export { promptbookStringToJson, promptbookJsonToString, validatePromptbookJson };
+export { promptbookJsonToString, promptbookStringToJson, validatePromptbookJson };
 export { createPromptbookExecutor, MultipleLlmExecutionTools };
 export { CallbackInterfaceTools, CallbackInterfaceToolsOptions };

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

@@ -1,16 +1,12 @@
 import { spaceTrim } from 'spacetrim';
-import { prettifyPromptbookString } from '../conversion/prettify/prettifyPromptbookString';
 import { renderPromptbookMermaid } from '../conversion/prettify/renderPromptbookMermaid';
 import { extractParametersFromPromptTemplate } from '../conversion/utils/extractParametersFromPromptTemplate';
 import { extractVariables } from '../conversion/utils/extractVariables';
 import { parseNumber } from '../conversion/utils/parseNumber';
 import { renameParameter } from '../conversion/utils/renameParameter';
 import { titleToName } from '../conversion/utils/titleToName';
-import { assertsExecutionSuccessful } from '../execution/assertsExecutionSuccessful';
-import { checkExpectations, isPassingExpectations } from '../execution/utils/checkExpectations';
+import { forEachAsync } from '../execution/utils/forEachAsync';
 import { replaceParameters } from '../execution/utils/replaceParameters';
-import { executionReportJsonToString } from '../types/execution-report/executionReportJsonToString';
-import { ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults } from '../types/execution-report/ExecutionReportStringOptions';
 import { CountUtils } from '../utils/expectation-counters';
 import { countCharacters } from '../utils/expectation-counters/countCharacters';
 import { countLines } from '../utils/expectation-counters/countLines';
@@ -51,10 +47,11 @@ import { union } from '../utils/sets/union';
 import { trimCodeBlock } from '../utils/trimCodeBlock';
 import { trimEndOfCodeBlock } from '../utils/trimEndOfCodeBlock';
 import { unwrapResult } from '../utils/unwrapResult';
-export { assertsExecutionSuccessful, checkExpectations, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, extractAllBlocksFromMarkdown, // <- [🌻]
+export { forEachAsync };
+export { extractAllBlocksFromMarkdown, // <- [🌻]
 extractAllListItemsFromMarkdown, extractBlock, // <- [🌻]
-extractOneBlockFromMarkdown, extractParameters, extractVariables, isPassingExpectations, isValidJsonString, parseNumber, // <- [🌻]
-prettifyPromptbookString, removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, replaceParameters, spaceTrim, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
+extractOneBlockFromMarkdown, extractParameters, extractVariables, isValidJsonString, parseNumber, // <- [🌻]
+removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, replaceParameters, spaceTrim, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
 export { countCharacters, countLines, countPages, countParagraphs, countSentences, CountUtils, countWords };
 export { splitIntoSentences };
 export declare const normalizeTo: {

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

@@ -9,6 +9,9 @@ import type { UserInterfaceTools } from './UserInterfaceTools';
 export type ExecutionTools = {
     /**
      * Tools for executing prompts to large language models like GPT-4
+     *
+     * Tip: Combine multiple LLM execution tools with `MultipleLlmExecutionTools`
+     * @see https://github.com/webgptorg/promptbook/?tab=readme-ov-file#llm-execution-tools
      */
     llm: LlmExecutionTools;
     /**
@@ -16,15 +19,14 @@ export type ExecutionTools = {
      *
      * Note: You can pass multiple ScriptExecutionTools, they will be tried one by one until one of them supports the script
      *       If none of them supports the script, an error is thrown
+     * @see https://github.com/webgptorg/promptbook/?tab=readme-ov-file#script-execution-tools
      */
     script: Array<ScriptExecutionTools>;
     /**
      * Tools for interacting with the user
      *
      * Note: When undefined, the user interface is disabled and promptbook which requires user interaction will fail
+     * @see https://github.com/webgptorg/promptbook/?tab=readme-ov-file#user-interface-tools
      */
     userInterface?: UserInterfaceTools;
 };
-/**
- * TODO: [🍓] !!!! Allow to have more LlmExecutionTools
- */

package/umd/typings/execution/plugins/llm-execution-tools/anthropic-claude/AnthropicClaudeExecutionTools.d.ts

@@ -36,7 +36,6 @@ export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools
 }
 /**
  * TODO: [🧠] Maybe handle errors via transformAnthropicError (like transformAzureError)
- * TODO: [🍓][♐] Allow to list compatible models with each variant
  * TODO: Maybe Create some common util for gptChat and gptComplete
  * TODO: Maybe make custom OpenaiError
  */

package/umd/typings/execution/plugins/llm-execution-tools/azure-openai/AzureOpenAiExecutionTools.d.ts

@@ -35,7 +35,6 @@ export declare class AzureOpenAiExecutionTools implements LlmExecutionTools {
     listModels(): Promise<Array<AvailableModel>>;
 }
 /**
- * TODO: [🍓][♐] Allow to list compatible models with each variant
  * TODO: Maybe Create some common util for gptChat and gptComplete
  * TODO: Maybe make custom AzureOpenaiError
  */

package/umd/typings/execution/plugins/llm-execution-tools/langtail/LangtailExecutionTools.d.ts

@@ -5,6 +5,3 @@ import { OpenAiExecutionTools } from '../openai/OpenAiExecutionTools';
  */
 export declare class LangtailExecutionTools extends OpenAiExecutionTools implements LlmExecutionTools {
 }
-/**
- * TODO: [🍓][♐] Allow to list the available prompts in Langtail
- */

package/umd/typings/execution/plugins/llm-execution-tools/openai/OpenAiExecutionTools.d.ts

@@ -39,7 +39,7 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
     listModels(): Array<AvailableModel>;
 }
 /**
- * TODO: [🍓][♐] Allow to list compatible models with each variant
+ * TODO: [🧠][🧙‍♂️] Maybe there can be some wizzard for thoose who want to use just OpenAI
  * TODO: Maybe Create some common util for gptChat and gptComplete
  * TODO: Maybe make custom OpenaiError
  */

package/umd/typings/execution/plugins/llm-execution-tools/remote/RemoteLlmExecutionTools.d.ts

@@ -35,6 +35,6 @@ export declare class RemoteLlmExecutionTools implements LlmExecutionTools {
     listModels(): Promise<Array<AvailableModel>>;
 }
 /**
- * TODO: [🍓][♐] Allow to list compatible models with each variant
+ * TODO: [🍓] Allow to list compatible models with each variant
  * TODO: [🤹‍♂️] RemoteLlmExecutionTools should extend Destroyable and implement IDestroyable
  */

package/umd/typings/execution/plugins/script-execution-tools/javascript/JavascriptEvalExecutionTools.d.ts

@@ -8,7 +8,7 @@ import { JavascriptExecutionToolsOptions } from './JavascriptExecutionToolsOptio
  */
 export declare class JavascriptEvalExecutionTools implements ScriptExecutionTools {
     private readonly options;
-    constructor(options: JavascriptExecutionToolsOptions);
+    constructor(options?: JavascriptExecutionToolsOptions);
     /**
      * Executes a JavaScript
      */

package/umd/typings/execution/plugins/script-execution-tools/javascript/JavascriptExecutionTools.d.ts

@@ -1,20 +1,7 @@
-import { ScriptExecutionTools, ScriptExecutionToolsExecuteOptions } from '../../../ScriptExecutionTools';
-import { JavascriptExecutionToolsOptions } from './JavascriptExecutionToolsOptions';
+import { JavascriptEvalExecutionTools } from './JavascriptEvalExecutionTools';
 /**
- * ScriptExecutionTools for JavaScript implemented via vm2
+ * Placeholder for better implementation of JavascriptExecutionTools - some propper sandboxing
  *
- * Warning: This is not implemented yet
- */
-export declare class JavascriptExecutionTools implements ScriptExecutionTools {
-    private readonly options;
-    constructor(options: JavascriptExecutionToolsOptions);
-    /**
-     * Executes a JavaScript
-     */
-    execute(options: ScriptExecutionToolsExecuteOptions): Promise<string>;
-}
-/**
- * TODO: !! Pass isVerbose to constructor and use it
- * TODO: !! Probbably make some common util createStatementToEvaluate
- * TODO: !! Implement via vm2
+ * @alias JavascriptExecutionTools
  */
+export declare const JavascriptExecutionTools: typeof JavascriptEvalExecutionTools;

package/umd/typings/execution/utils/forEachAsync.d.ts

@@ -0,0 +1,18 @@
+import type { Promisable } from 'type-fest';
+type ForEachAsyncOptions = {
+    /**
+     * Maximum number of tasks running in parallel
+     *
+     * @default Infinity
+     */
+    inParallelCount?: number;
+};
+/**
+ * Async version of Array.forEach
+ *
+ * @param array - Array to iterate over
+ * @param options - Options for the function
+ * @param callbackfunction - Function to call for each item
+ */
+export declare function forEachAsync<TItem>(array: Array<TItem>, options: ForEachAsyncOptions, callbackfunction: (value: TItem, index: number, array: Array<TItem>) => Promisable<void>): Promise<void>;
+export {};

package/umd/typings/library/constructors/createPromptbookLibraryFromDirectory.d.ts

@@ -1,14 +1,46 @@
+import { string_folder_path } from '../../types/typeAliases';
 import { PromptbookLibrary } from '../PromptbookLibrary';
+/**
+ * Options for `createPromptbookLibraryFromDirectory` function
+ */
+type CreatePromptbookLibraryFromDirectoryOptions = {
+    /**
+     * If true, the directory is searched recursively for promptbooks
+     *
+     * @default true
+     */
+    isRecursive?: boolean;
+    /**
+     * If true, the library creation outputs information about each file it reads
+     *
+     * @default false
+     */
+    isVerbose?: boolean;
+    /**
+     * If true, directory will be scanned only when needed not during the construction
+     *
+     * @default false
+     */
+    isLazyLoaded?: boolean;
+};
 /**
  * Constructs Promptbook from given directory
  *
  * Note: Works only in Node.js environment because it reads the file system
- * Note: The function does NOT return promise it returns the library directly which dynamically loads promptbooks when needed
- *       SO during the construction syntax and logic sources IS NOT validated
  *
+ * @param path - path to the directory with promptbooks
+ * @param options - Misc options for the library
  * @returns PromptbookLibrary
  */
-export declare function createPromptbookLibraryFromDirectory(): PromptbookLibrary;
+export declare function createPromptbookLibraryFromDirectory(path: string_folder_path, options?: CreatePromptbookLibraryFromDirectoryOptions): Promise<PromptbookLibrary>;
+export {};
 /***
- * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
+ * TODO: [🧠] Maybe do not do hacks like [1] and just create package @promptbook/node
+ *       [🍓][🚯] maybe make `@promptbook/library` package
+ * TODO: Fix the dynamic import issue in Webpack (! Not working !)
+ *     > ./node_modules/@promptbook/core/esm/index.es.js
+ *     > Critical dependency: the request of a dependency is an expression
+ *
+ * Note: [1] Using require(just('fs/promises')) to allow
+ *     the `@promptbook/core` work for both Node.js and browser environments
  */

package/umd/typings/library/constructors/createPromptbookLibraryFromDirectory.test.d.ts

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

package/umd/typings/library/constructors/createPromptbookLibraryFromPromise.d.ts

@@ -14,11 +14,11 @@ import { PromptbookLibrary } from '../PromptbookLibrary';
  * Note: The function does NOT return promise it returns the library directly which waits for the sources to be resolved
  *       when error occurs in given promise or factory function, it is thrown during `listPromptbooks` or `getPromptbookByUrl` call
  *
+ * Note: Consider using  `createPromptbookLibraryFromDirectory` or `createPromptbookLibraryFromUrl`
  *
  * @param promptbookSourcesPromiseOrFactory
  * @returns PromptbookLibrary
- *
- * @deprecated Consider using `createPromptbookLibraryFromUrl` or `createPromptbookLibraryFromDirectory`
+ * @private Just internal tool for other constructor functions
  */
 export declare function createPromptbookLibraryFromPromise(promptbookSourcesPromiseOrFactory: Promise<Array<PromptbookJson | PromptbookString>> | (() => Promise<Array<PromptbookJson | PromptbookString>>)): PromptbookLibrary;
 /***

package/umd/typings/library/constructors/createPromptbookLibraryFromPromise.test.d.ts

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

package/umd/typings/library/constructors/createPromptbookLibraryFromSources.test.d.ts

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

package/umd/typings/library/constructors/createPromptbookLibraryFromUrl.d.ts

@@ -1,13 +1,29 @@
+import { string_url } from '../../types/typeAliases';
 import { PromptbookLibrary } from '../PromptbookLibrary';
+/**
+ * Options for `createPromptbookLibraryFromDirectory` function
+ */
+type CreatePromptbookLibraryFromUrlyOptions = {
+    /**
+     * If true, the library creation outputs information about each file it reads
+     *
+     * @default false
+     */
+    isVerbose?: boolean;
+    /**
+     * If true, directory will be scanned only when needed not during the construction
+     *
+     * @default false
+     */
+    isLazyLoaded?: boolean;
+};
 /**
  * Constructs Promptbook from remote Promptbase URL
- *
- * Note: The function does NOT return promise it returns the library directly which dynamically loads promptbooks when needed
- *       SO during the construction syntax and logic sources IS NOT validated
- *
+
  * @returns PromptbookLibrary
  */
-export declare function createPromptbookLibraryFromUrl(): PromptbookLibrary;
+export declare function createPromptbookLibraryFromUrl(url: string_url | URL, options: CreatePromptbookLibraryFromUrlyOptions): Promise<PromptbookLibrary>;
+export {};
 /***
  * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
  */

package/umd/typings/library/constructors/justTestFsImport.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Just testing imports and compatibility
+ */
+export declare function justTestFsImport(): Promise<void>;
+/**
+ * TODO: !!! Remove this file
+ */ 

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

@@ -39,7 +39,7 @@ export type Prompt = {
     /**
      * Unique identifier of the promptbook with specific template name as hash
      *
-     * @example https://promptbook.webgpt.com/cs/write-website-content.ptbk.md@v2.4.15#keywords
+     * @example https://promptbook.webgpt.com/cs/write-website-content.ptbk.md#keywords
      */
     readonly promptbookUrl: string_promptbook_url_with_hashtemplate;
     /**

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

@@ -179,13 +179,13 @@ export type string_url = string;
 /**
  * Semantic helper
  *
- * For example `"https://promptbook.webgpt.com/cs/write-website-content.ptbk.md@v2.4.15"`
+ * For example `"https://promptbook.webgpt.com/cs/write-website-content.ptbk.md"`
  */
 export type string_promptbook_url = string;
 /**
  * Semantic helper
  *
- * For example `"https://promptbook.webgpt.com/cs/write-website-content.ptbk.md@v2.4.15#keywords"`
+ * For example `"https://promptbook.webgpt.com/cs/write-website-content.ptbk.md#keywords"`
  */
 export type string_promptbook_url_with_hashtemplate = string;
 /**

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

@@ -1,5 +0,0 @@
-import { Wizzard } from '../wizzard/Wizzard';
-export { Wizzard };
-/**
- * TODO: [🧙‍♂️]
- */ 

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

@@ -1,4 +0,0 @@
-export declare const Wizzard: any;
-/**
- * TODO: [🧙‍♂️]
- */ 

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

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

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

@@ -1,5 +0,0 @@
-import { Wizzard } from '../wizzard/Wizzard';
-export { Wizzard };
-/**
- * TODO: [🧙‍♂️]
- */ 

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

@@ -1,4 +0,0 @@
-export declare const Wizzard: any;
-/**
- * TODO: [🧙‍♂️]
- */ 

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

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