@promptbook/openai 0.52.0-9 → 0.53.0

package/umd/typings/execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceTools.d.ts

@@ -1,5 +1,6 @@
-import { UserInterfaceTools, UserInterfaceToolsPromptDialogOptions } from '../../../UserInterfaceTools';
-import { CallbackInterfaceToolsOptions } from './CallbackInterfaceToolsOptions';
+import type { UserInterfaceTools } from '../../../UserInterfaceTools';
+import type { UserInterfaceToolsPromptDialogOptions } from '../../../UserInterfaceTools';
+import type { CallbackInterfaceToolsOptions } from './CallbackInterfaceToolsOptions';
 /**
  * Delagates the user interaction to a async callback function
  * You need to provide your own implementation of this callback function and its bind to UI.

package/umd/typings/execution/plugins/user-interface-execution-tools/simple-prompt/SimplePromptInterfaceTools.d.ts

@@ -1,5 +1,6 @@
-import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
-import { UserInterfaceTools, UserInterfaceToolsPromptDialogOptions } from '../../../UserInterfaceTools';
+import type { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
+import type { UserInterfaceTools } from '../../../UserInterfaceTools';
+import type { UserInterfaceToolsPromptDialogOptions } from '../../../UserInterfaceTools';
 /**
  * Wrapper around `window.prompt` synchronous function that interacts with the user via browser prompt
  *

package/umd/typings/execution/translation/automatic-translate/automatic-translators/DebugAutomaticTranslator.d.ts

@@ -1,4 +1,4 @@
-import { AutomaticTranslator } from './AutomaticTranslator';
+import type { AutomaticTranslator } from './AutomaticTranslator';
 /**
  * This will wrap an automatic translator and log each translation into the console
  */

package/umd/typings/execution/translation/automatic-translate/automatic-translators/FakeAutomaticTranslator.d.ts

@@ -1,4 +1,4 @@
-import { AutomaticTranslator } from './AutomaticTranslator';
+import type { AutomaticTranslator } from './AutomaticTranslator';
 export declare class FakeAutomaticTranslator implements AutomaticTranslator {
     constructor();
     translate(message: string): string;

package/umd/typings/execution/translation/automatic-translate/automatic-translators/LindatAutomaticTranslator.d.ts

@@ -1,5 +1,5 @@
-import { AutomaticTranslator } from './AutomaticTranslator';
-import { TranslatorOptions } from './TranslatorOptions';
+import type { AutomaticTranslator } from './AutomaticTranslator';
+import type { TranslatorOptions } from './TranslatorOptions';
 interface LindatAutomaticTranslatorOptions extends TranslatorOptions {
     apiUrl: URL;
 }

package/umd/typings/execution/translation/automatic-translate/translateMessages.d.ts

@@ -1,5 +1,5 @@
-import { AutomaticTranslator } from './automatic-translators/AutomaticTranslator';
-import { TranslatorOptions } from './automatic-translators/TranslatorOptions';
+import type { AutomaticTranslator } from './automatic-translators/AutomaticTranslator';
+import type { TranslatorOptions } from './automatic-translators/TranslatorOptions';
 export declare function translateMessages({ automaticTranslator, from, to, }: {
     automaticTranslator: AutomaticTranslator;
 } & TranslatorOptions): Promise<void>;

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/execution/utils/replaceParameters.d.ts

@@ -1,5 +1,5 @@
-import { Parameters } from '../../types/Parameters';
-import { string_template } from '../../types/typeAliases';
+import type { Parameters } from '../../types/Parameters';
+import type { string_template } from '../../types/typeAliases';
 /**
  * Replaces parameters in template with values from parameters object
  *

package/umd/typings/library/SimplePromptbookLibrary.d.ts

@@ -1,7 +1,7 @@
 import type { Prompt } from '../types/Prompt';
 import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
 import type { string_promptbook_url } from '../types/typeAliases';
-import { PromptbookLibrary } from './PromptbookLibrary';
+import type { PromptbookLibrary } from './PromptbookLibrary';
 /**
  * Library of promptbooks that groups together promptbooks for an application.
  * This implementation is a very thin wrapper around the Array / Map of promptbooks.

package/umd/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/umd/typings/library/constructors/createPromptbookLibraryFromDirectory.test.d.ts

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

package/umd/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/umd/typings/library/constructors/createPromptbookLibraryFromPromise.test.d.ts

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

package/umd/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/umd/typings/library/constructors/createPromptbookLibraryFromSources.test.d.ts

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

package/umd/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/umd/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/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/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/umd/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/umd/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/umd/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/umd/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/umd/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/umd/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/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/umd/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/umd/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/umd/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/umd/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/umd/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/umd/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/umd/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/umd/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/umd/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/umd/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/umd/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/umd/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/umd/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/umd/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/umd/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/umd/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/umd/typings/utils/normalization/searchKeywords.d.ts

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

package/umd/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/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/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
- */