@promptbook/types 0.52.0-9 → 0.53.0

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

@@ -1,5 +1,5 @@
-import { string_folder_path } from '../../types/typeAliases';
-import { PromptbookLibrary } from '../PromptbookLibrary';
+import type { string_folder_path } from '../../types/typeAliases';
+import type { PromptbookLibrary } from '../PromptbookLibrary';
 /**
  * Options for `createPromptbookLibraryFromDirectory` function
  */
@@ -10,20 +10,44 @@ type CreatePromptbookLibraryFromDirectoryOptions = {
      * @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;
+    /**
+     * If true, whole library creation crashes on error in any promptbook
+     * If true and isLazyLoaded is true, the error is thrown on first access to the promptbook
+     *
+     * @default true
+     */
+    isCrashOnError?: 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(path: string_folder_path, options?: CreatePromptbookLibraryFromDirectoryOptions): 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

@@ -1,6 +1,6 @@
 import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
-import { PromptbookString } from '../../types/PromptbookString';
-import { PromptbookLibrary } from '../PromptbookLibrary';
+import type { PromptbookString } from '../../types/PromptbookString';
+import type { PromptbookLibrary } from '../PromptbookLibrary';
 /**
  * Constructs Promptbook from async sources
  * It can be one of the following:
@@ -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.d.ts

@@ -1,4 +1,5 @@
-import { PromptbookJson, PromptbookString } from '../../_packages/types.index';
+import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
+import type { PromptbookString } from '../../types/PromptbookString';
 import { SimplePromptbookLibrary } from '../SimplePromptbookLibrary';
 /**
  * Creates PromptbookLibrary from array of PromptbookJson or PromptbookString

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

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

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

@@ -1,13 +1,30 @@
-import { PromptbookLibrary } from '../PromptbookLibrary';
+import type { string_url } from '../../types/typeAliases';
+import type { 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: [⚖] Compatible with remote server
  * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
  */

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

@@ -1,5 +1,5 @@
 import type { string_promptbook_url } from '../../types/typeAliases';
-import { PromptbookLibrary } from '../PromptbookLibrary';
+import type { PromptbookLibrary } from '../PromptbookLibrary';
 /**
  * Creates PromptbookLibrary as a subset of another PromptbookLibrary
  *

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/Command.d.ts

@@ -1,7 +1,10 @@
-import type { string_markdown_text, string_name, string_version } from '.././types/typeAliases';
+import type { string_markdown_text } from './typeAliases';
+import type { string_name } from './typeAliases';
+import type { string_version } from './typeAliases';
 import type { ExecutionType } from './ExecutionTypes';
 import type { ModelRequirements } from './ModelRequirements';
-import type { ExpectationAmount, ExpectationUnit } from './PromptbookJson/PromptTemplateJson';
+import type { ExpectationAmount } from './PromptbookJson/PromptTemplateJson';
+import type { ExpectationUnit } from './PromptbookJson/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.

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

@@ -1,4 +1,7 @@
-import type { string_name, string_prompt, string_promptbook_url_with_hashtemplate, string_title } from '.././types/typeAliases';
+import type { string_name } from './typeAliases';
+import type { string_prompt } from './typeAliases';
+import type { string_promptbook_url_with_hashtemplate } from './typeAliases';
+import type { string_title } from './typeAliases';
 import type { PostprocessingFunction } from '../execution/plugins/script-execution-tools/javascript/JavascriptExecutionToolsOptions';
 import type { ModelRequirements } from './ModelRequirements';
 import type { Expectations } from './PromptbookJson/PromptTemplateJson';
@@ -39,7 +42,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/PromptbookJson/PromptTemplateJson.d.ts

@@ -2,7 +2,14 @@ import type { ExpectFormatCommand } from '../Command';
 import type { ExecutionType } from '../ExecutionTypes';
 import type { ModelRequirements } from '../ModelRequirements';
 import type { ScriptLanguage } from '../ScriptLanguage';
-import type { number_integer, number_positive_or_zero, string_javascript, string_javascript_name, string_markdown, string_name, string_prompt, string_template } from '../typeAliases';
+import type { number_integer } from '../typeAliases';
+import type { number_positive_or_zero } from '../typeAliases';
+import type { string_javascript } from '../typeAliases';
+import type { string_javascript_name } from '../typeAliases';
+import type { string_markdown } from '../typeAliases';
+import type { string_name } from '../typeAliases';
+import type { string_prompt } from '../typeAliases';
+import type { string_template } from '../typeAliases';
 /**
  * Describes one prompt template in the promptbook
  */

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

@@ -1,4 +1,5 @@
-import type { string_promptbook_url, string_version } from '../typeAliases';
+import type { string_promptbook_url } from '../typeAliases';
+import type { string_version } from '../typeAliases';
 import type { PromptTemplateJson } from './PromptTemplateJson';
 import type { PromptTemplateParameterJson } from './PromptTemplateParameterJson';
 /**

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

@@ -1,5 +1,6 @@
 import type { ExecutionType } from './ExecutionTypes';
-import type { string_markdown_text, string_name } from './typeAliases';
+import type { string_markdown_text } from './typeAliases';
+import type { string_name } from './typeAliases';
 /**
  * TaskProgress represents the progress of a Promptbook execution.
  */

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

@@ -1,6 +1,7 @@
 import type { PromptResult } from '../../execution/PromptResult';
 import type { Prompt } from '../Prompt';
-import type { string_promptbook_url, string_version } from '../typeAliases';
+import type { string_promptbook_url } from '../typeAliases';
+import type { 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.

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

@@ -1,4 +1,4 @@
-import { FromtoItems } from '../../utils/FromtoItems';
+import type { FromtoItems } from '../../utils/FromtoItems';
 /**
  * Count the duration of working time
  *

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/esm/typings/utils/emojis.d.ts

@@ -1,4 +1,4 @@
-import { string_char_emoji } from '../types/typeAliasEmoji';
+import type { string_char_emoji } from '../types/typeAliasEmoji';
 /**
  * All possible emoji chars like "🍆", "🍡", "🍤"...
  * Note: this will be needed to update annually - now updated at 2022-01-19

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

@@ -1,4 +1,5 @@
-import type { ExpectationAmount, ExpectationUnit } from '../../types/PromptbookJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PromptbookJson/PromptTemplateJson';
+import type { ExpectationUnit } from '../../types/PromptbookJson/PromptTemplateJson';
 /**
  * Index of all counter functions
  */

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

@@ -1,4 +1,5 @@
-import { string_name, string_template } from '../types/typeAliases';
+import type { string_name } from '../types/typeAliases';
+import type { string_template } from '../types/typeAliases';
 /**
  * Parses the template and returns the list of all parameter names
  *

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

@@ -1,4 +1,5 @@
-import type { string_markdown, string_name } from '../../types/typeAliases';
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_name } from '../../types/typeAliases';
 /**
  * Add or modify an auto-generated section in a markdown file
  *

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

@@ -1,5 +1,5 @@
-import { string_markdown } from '../../types/typeAliases';
-import { FromtoItems } from '../FromtoItems';
+import type { string_markdown } from '../../types/typeAliases';
+import type { FromtoItems } from '../FromtoItems';
 /**
  * Options for creating a markdown chart
  */

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

@@ -1,4 +1,5 @@
-import { string_markdown, string_markdown_text } from '../../types/typeAliases';
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_markdown_text } from '../../types/typeAliases';
 /**
  * Create a markdown table from a 2D array of strings
  *

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

@@ -1,4 +1,4 @@
-import { string_markdown_text } from '../../types/typeAliases';
+import type { string_markdown_text } from '../../types/typeAliases';
 /**
  * Function escapeMarkdownBlock will escape markdown block if needed
  * It is useful when you want have block in block

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

@@ -1,4 +1,5 @@
-import { string_markdown, string_markdown_text } from '../.././types/typeAliases';
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_markdown_text } from '../../types/typeAliases';
 /**
  * Utility function to extract all list items from markdown
  *

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

@@ -1,5 +1,5 @@
-import { string_markdown } from '../.././types/typeAliases';
-import { CodeBlock } from './extractAllBlocksFromMarkdown';
+import type { string_markdown } from '../../types/typeAliases';
+import type { CodeBlock } from './extractAllBlocksFromMarkdown';
 /**
  * Extracts exactly ONE code block from markdown.
  *

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

@@ -1,4 +1,5 @@
-import { string_html, string_markdown } from '../../types/typeAliases';
+import type { string_html } from '../../types/typeAliases';
+import type { string_markdown } from '../../types/typeAliases';
 /**
  * Removes HTML or Markdown comments from a string.
  *

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

@@ -1,4 +1,4 @@
-import { string_markdown_text } from '../../types/typeAliases';
+import type { string_markdown_text } from '../../types/typeAliases';
 /**
  * Removes Markdown formatting tags from a string.
  *

package/esm/typings/utils/markdown-json/countMarkdownStructureDeepness.d.ts

@@ -1,4 +1,4 @@
-import { MarkdownStructure } from './MarkdownStructure';
+import type { MarkdownStructure } from './MarkdownStructure';
 /**
  * Computes the deepness of the markdown structure.
  *

package/esm/typings/utils/markdown-json/markdownToMarkdownStructure.d.ts

@@ -1,4 +1,4 @@
-import { MarkdownStructure } from './MarkdownStructure';
+import type { MarkdownStructure } from './MarkdownStructure';
 /**
  * Parse a markdown string into a MarkdownStructure object.
  *

package/esm/typings/utils/normalization/isValidKeyword.d.ts

@@ -1,4 +1,4 @@
-import { string_keyword } from './IKeywords';
+import type { string_keyword } from './IKeywords';
 /**
  * Tests if keyword is valid
  *

package/esm/typings/utils/normalization/parseKeywords.d.ts

@@ -1,4 +1,4 @@
-import { IKeywords } from './IKeywords';
+import type { IKeywords } from './IKeywords';
 /**
  * Parses keywords from any object and recursively walks through
  *

package/esm/typings/utils/normalization/parseKeywordsFromString.d.ts

@@ -1,4 +1,4 @@
-import { IKeywords } from './IKeywords';
+import type { IKeywords } from './IKeywords';
 /**
  * Parses keywords from a string
  *

package/esm/typings/utils/normalization/searchKeywords.d.ts

@@ -1,4 +1,4 @@
-import { IKeywords } from './IKeywords';
+import type { IKeywords } from './IKeywords';
 /**
  *
  */

package/esm/typings/utils/postprocessing/extractBlock.d.ts

@@ -1,4 +1,4 @@
-import { string_markdown } from '../../types/typeAliases';
+import type { string_markdown } from '../../types/typeAliases';
 /**
  * Extracts code block from markdown.
  *

package/package.json

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

package/umd/index.umd.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.umd.js","sources":["../../../src/types/PromptbookJson/PromptTemplateJson.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;IA4CA;;;QAGa,iBAAiB,GAAG,CAAC,YAAY,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,YAAY,EAAE,OAAO,EAAW;IAmH/G;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.umd.js","sources":["../../../src/types/PromptbookJson/PromptTemplateJson.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;IA0CA;;;QAGa,iBAAiB,GAAG,CAAC,YAAY,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,YAAY,EAAE,OAAO,EAAW;IAmH/G;;;;;;;;;;;;;;"}

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

@@ -10,17 +10,19 @@ import { CallbackInterfaceToolsOptions } from '../execution/plugins/user-interfa
 import { SimplePromptInterfaceTools } from '../execution/plugins/user-interface-execution-tools/simple-prompt/SimplePromptInterfaceTools';
 import { checkExpectations, isPassingExpectations } from '../execution/utils/checkExpectations';
 import { createPromptbookLibraryFromDirectory } from '../library/constructors/createPromptbookLibraryFromDirectory';
-import { createPromptbookLibraryFromPromise } from '../library/constructors/createPromptbookLibraryFromPromise';
 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';
+export { justTestFsImport };
 export { ExecutionTypes, PROMPTBOOK_VERSION };
 export { assertsExecutionSuccessful, checkExpectations, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, isPassingExpectations, prettifyPromptbookString, };
-export { createPromptbookLibraryFromDirectory, createPromptbookLibraryFromPromise, createPromptbookLibraryFromSources, createPromptbookSublibrary, SimplePromptbookLibrary, };
+export { createPromptbookLibraryFromDirectory, createPromptbookLibraryFromSources, createPromptbookLibraryFromUrl, createPromptbookSublibrary, SimplePromptbookLibrary, };
 export { SimplePromptInterfaceTools };
 export { promptbookJsonToString, promptbookStringToJson, validatePromptbookJson };
 export { createPromptbookExecutor, MultipleLlmExecutionTools };

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

@@ -5,6 +5,7 @@ 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 { forEachAsync } from '../execution/utils/forEachAsync';
 import { replaceParameters } from '../execution/utils/replaceParameters';
 import { CountUtils } from '../utils/expectation-counters';
 import { countCharacters } from '../utils/expectation-counters/countCharacters';
@@ -46,6 +47,7 @@ import { union } from '../utils/sets/union';
 import { trimCodeBlock } from '../utils/trimCodeBlock';
 import { trimEndOfCodeBlock } from '../utils/trimEndOfCodeBlock';
 import { unwrapResult } from '../utils/unwrapResult';
+export { forEachAsync };
 export { extractAllBlocksFromMarkdown, // <- [🌻]
 extractAllListItemsFromMarkdown, extractBlock, // <- [🌻]
 extractOneBlockFromMarkdown, extractParameters, extractVariables, isValidJsonString, parseNumber, // <- [🌻]

package/umd/typings/conversion/prettify/prettifyPromptbookString.d.ts

@@ -1,4 +1,4 @@
-import { PromptbookString } from '../../types/PromptbookString';
+import type { PromptbookString } from '../../types/PromptbookString';
 import type { PrettifyOptions } from './PrettifyOptions';
 /**
  * Prettyfies Promptbook string and adds Mermaid graph

package/umd/typings/conversion/prettify/renderPromptbookMermaid.d.ts

@@ -1,4 +1,5 @@
-import type { PromptbookJson, PromptTemplateJson } from '../../_packages/types.index';
+import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
+import type { PromptTemplateJson } from '../../types/PromptbookJson/PromptTemplateJson';
 import type { string_href } from '../../types/typeAliases';
 /**
  * Addtional options for rendering Mermaid graph

package/umd/typings/conversion/utils/extractParametersFromPromptTemplate.d.ts

@@ -1,5 +1,5 @@
-import { PromptTemplateJson } from '../../types/PromptbookJson/PromptTemplateJson';
-import { string_name } from '../../types/typeAliases';
+import type { PromptTemplateJson } from '../../types/PromptbookJson/PromptTemplateJson';
+import type { string_name } from '../../types/typeAliases';
 /**
  * Parses the prompt template and returns the set of all used parameters
  *
@@ -10,4 +10,4 @@ import { string_name } from '../../types/typeAliases';
 export declare function extractParametersFromPromptTemplate(promptTemplate: Pick<PromptTemplateJson, 'title' | 'description' | 'executionType' | 'content'>): Set<string_name>;
 /**
  * TODO: [🔣] If script require contentLanguage
- */ 
+ */

package/umd/typings/conversion/utils/extractVariables.d.ts

@@ -1,4 +1,5 @@
-import { string_javascript, string_javascript_name } from '../../types/typeAliases';
+import type { string_javascript } from '../../types/typeAliases';
+import type { string_javascript_name } from '../../types/typeAliases';
 /**
  * Parses the given script and returns the list of all used variables that are not defined in the script
  *

package/umd/typings/conversion/validation/_importPromptbook.d.ts

@@ -1,5 +1,5 @@
-import { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
-import { PromptbookString } from '../../types/PromptbookString';
+import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
+import type { PromptbookString } from '../../types/PromptbookString';
 /**
  * Import the text file
  *

package/umd/typings/errors/PromptbookLibraryError.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This error indicates that the promptbook library cannot be propperly loaded
+ */
+export declare class PromptbookLibraryError extends Error {
+    readonly name = "PromptbookLibraryError";
+    constructor(message: string);
+}

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/LlmExecutionTools.d.ts

@@ -1,8 +1,10 @@
 import type { Promisable } from 'type-fest';
 import type { ModelVariant } from '../types/ModelRequirements';
 import type { Prompt } from '../types/Prompt';
-import type { string_model_name, string_title } from '../types/typeAliases';
-import type { PromptChatResult, PromptCompletionResult } from './PromptResult';
+import type { string_model_name } from '../types/typeAliases';
+import type { string_title } from '../types/typeAliases';
+import type { PromptChatResult } from './PromptResult';
+import type { PromptCompletionResult } from './PromptResult';
 /**
  * Container for all the tools needed to execute prompts to large language models like GPT-4
  * On its interface it exposes common methods for prompt execution.

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

@@ -1,4 +1,8 @@
-import type { number_positive_or_zero, number_tokens, number_usd, string_date_iso8601, string_model_name } from '.././types/typeAliases';
+import type { number_positive_or_zero } from '../types/typeAliases';
+import type { number_tokens } from '../types/typeAliases';
+import type { number_usd } from '../types/typeAliases';
+import type { string_date_iso8601 } 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/ScriptExecutionTools.d.ts

@@ -1,4 +1,5 @@
-import type { string_name, string_script } from '.././types/typeAliases';
+import type { string_name } from '../types/typeAliases';
+import type { string_script } from '../types/typeAliases';
 import type { ScriptLanguage } from '../types/ScriptLanguage';
 /**
  * Represents all the tools needed to EXECUTE SCRIPTs

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

@@ -1,4 +1,5 @@
-import type { number_integer, number_positive } from '../types/typeAliases';
+import type { number_integer } from '../types/typeAliases';
+import type { number_positive } from '../types/typeAliases';
 /**
  * Represents all the tools needed to interact with the user.
  *

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

@@ -1,6 +1,6 @@
-import { PromptbookJson } from '../_packages/types.index';
-import { ExecutionTools } from './ExecutionTools';
-import { PromptbookExecutor } from './PromptbookExecutor';
+import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
+import type { ExecutionTools } from './ExecutionTools';
+import type { PromptbookExecutor } from './PromptbookExecutor';
 type CreatePromptbookExecutorSettings = {
     /**
      * When executor does not satisfy expectations it will be retried this amount of times