@promptbook/openai 0.59.0-20 → 0.59.0-23

package/README.md

@@ -35,12 +35,12 @@ npm i @promptbook/openai
 
 ```typescript
 import { createPromptbookExecutor, assertsExecutionSuccessful } from '@promptbook/core';
-import { createPromptbookLibraryFromDirectory } from '@promptbook/node';
+import { createLibraryFromDirectory } from '@promptbook/node';
 import { JavascriptExecutionTools } from '@promptbook/execute-javascript';
 import { OpenAiExecutionTools } from '@promptbook/openai';
 
 // ▶ Create whole Promptbook library
-const library = await createPromptbookLibraryFromDirectory('./promptbook-library');
+const library = await createLibraryFromDirectory('./promptbook-library');
 
 // ▶ Get one Promptbook
 const promptbook = await library.getPromptbookByUrl(`https://promptbook.studio/my-library/write-article.ptbk.md`);
@@ -77,12 +77,12 @@ You can use multiple LLM providers in one Promptbook execution. The best model w
 
 ```typescript
 import { createPromptbookExecutor, assertsExecutionSuccessful } from '@promptbook/core';
-import { createPromptbookLibraryFromDirectory } from '@promptbook/node';
+import { createLibraryFromDirectory } from '@promptbook/node';
 import { JavascriptExecutionTools } from '@promptbook/execute-javascript';
 import { OpenAiExecutionTools } from '@promptbook/openai';
 
 // ▶ Create whole Promptbook library
-const library = await createPromptbookLibraryFromDirectory('./promptbook-library');
+const library = await createLibraryFromDirectory('./promptbook-library');
 
 // ▶ Get one Promptbook
 const promptbook = await library.getPromptbookByUrl(`https://promptbook.studio/my-library/write-article.ptbk.md`);

package/esm/index.es.js

@@ -1035,7 +1035,7 @@ var OpenAiExecutionTools = /** @class */ (function () {
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.59.0-22';
+var PROMPTBOOK_VERSION = '0.59.0-21';
 
 export { OPENAI_MODELS, OpenAiExecutionTools, PROMPTBOOK_VERSION };
 //# sourceMappingURL=index.es.js.map

package/esm/typings/src/_packages/cli.index.d.ts

@@ -1,10 +1,10 @@
-import { prettifyPromptbookStringCli } from '../conversion/prettify/prettifyPromptbookStringCli';
+import { promptbookCli } from '../cli/promptbookCli';
 import { PROMPTBOOK_VERSION } from '../version';
 export { PROMPTBOOK_VERSION };
 /**
  * Hidden utilities which should not be used by external consumers.
  */
 declare const __: {
-    prettifyPromptbookStringCli: typeof prettifyPromptbookStringCli;
+    promptbookCli: typeof promptbookCli;
 };
 export { __ };

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

@@ -20,11 +20,11 @@ import { CallbackInterfaceTools } from '../knowledge/dialogs/callback/CallbackIn
 import type { CallbackInterfaceToolsOptions } from '../knowledge/dialogs/callback/CallbackInterfaceToolsOptions';
 import { SimplePromptInterfaceTools } from '../knowledge/dialogs/simple-prompt/SimplePromptInterfaceTools';
 import { prepareKnowledgeFromMarkdown } from '../knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown';
-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 { SimplePromptbookLibrary } from '../library/SimplePromptbookLibrary';
+import { createLibraryFromJson } from '../library/constructors/createLibraryFromJson';
+import { createLibraryFromPromise } from '../library/constructors/createLibraryFromPromise';
+import { createLibraryFromUrl } from '../library/constructors/createLibraryFromUrl';
+import { createSublibrary } from '../library/constructors/createSublibrary';
+import { libraryToJson } from '../library/libraryToJson';
 import { MultipleLlmExecutionTools } from '../llm-providers/multiple/MultipleLlmExecutionTools';
 import { executionReportJsonToString } from '../types/execution-report/executionReportJsonToString';
 import type { ExecutionReportStringOptions } from '../types/execution-report/ExecutionReportStringOptions';
@@ -34,7 +34,7 @@ import { PROMPTBOOK_VERSION } from '../version';
 export { PROMPTBOOK_VERSION };
 export { ExecutionTypes };
 export { addUsage, assertsExecutionSuccessful, checkExpectations, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, isPassingExpectations, prepareKnowledgeFromMarkdown, prettifyPromptbookString, usageToWorktime, };
-export { createPromptbookLibraryFromPromise, createPromptbookLibraryFromSources, createPromptbookLibraryFromUrl, createPromptbookSublibrary, SimplePromptbookLibrary, };
+export { createLibraryFromJson, createLibraryFromPromise, createLibraryFromUrl, createSublibrary, libraryToJson };
 export { SimplePromptInterfaceTools };
 export { promptbookJsonToString, promptbookStringToJson, validatePromptbookJson };
 export { createPromptbookExecutor, MultipleLlmExecutionTools };

package/esm/typings/src/_packages/node.index.d.ts

@@ -1,4 +1,4 @@
-import { createPromptbookLibraryFromDirectory } from '../library/constructors/createPromptbookLibraryFromDirectory';
+import { createLibraryFromDirectory } from '../library/constructors/createLibraryFromDirectory';
 import { PROMPTBOOK_VERSION } from '../version';
 export { PROMPTBOOK_VERSION };
-export { createPromptbookLibraryFromDirectory };
+export { createLibraryFromDirectory };

package/esm/typings/src/_packages/types.index.d.ts

@@ -6,6 +6,7 @@ import type { PromptbookExecutor } from '../execution/PromptbookExecutor';
 import type { ScriptExecutionTools, ScriptExecutionToolsExecuteOptions } from '../execution/ScriptExecutionTools';
 import type { UserInterfaceTools, UserInterfaceToolsPromptDialogOptions } from '../execution/UserInterfaceTools';
 import type { PromptbookLibrary } from '../library/PromptbookLibrary';
+import type { SimplePromptbookLibrary } from '../library/SimplePromptbookLibrary';
 import type { ExecutionType } from '../types/ExecutionTypes';
 import type { ModelRequirements, ModelVariant } from '../types/ModelRequirements';
 import type { Parameters } from '../types/Parameters';
@@ -26,7 +27,7 @@ import type { FromtoItems } from '../utils/FromtoItems';
 import { PROMPTBOOK_VERSION } from '../version';
 export { PROMPTBOOK_VERSION };
 export { EXPECTATION_UNITS };
-export type { AvailableModel, client_id, CommonExecutionToolsOptions, ExecutionReportJson, ExecutionTools, ExecutionType, ExpectationAmount, Expectations, ExpectationUnit, FromtoItems, KnowledgeJson, LlmExecutionTools, LlmTemplateJson, MaterialKnowledgePieceJson, ModelRequirements, ModelVariant, Parameters, Prompt, PromptbookExecutor, PromptbookJson, PromptbookLibrary, PromptbookString, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptDialogJson, PromptResult, PromptResultUsage, PromptResultUsageCounts, PromptTemplateJson, PromptTemplateParameterJson, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptJson, ScriptLanguage, SimpleTemplateJson, string_char, string_char_emoji, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, string_file_absolute_path, string_file_extension, string_file_path, string_file_relative_path, string_filename, string_folder_absolute_path, string_folder_path, string_folder_relative_path, string_host, string_hostname, string_href, string_html, string_javascript, string_javascript_name, string_license, string_markdown, string_markdown_text, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_person_fullname, string_prompt, string_promptbook_url, string_promptbook_url_with_hashtemplate, string_script, string_sha256, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_uri, string_uri_part, string_url, string_url_image, string_version, TaskProgress, UncertainNumber, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, };
+export type { AvailableModel, client_id, CommonExecutionToolsOptions, ExecutionReportJson, ExecutionTools, ExecutionType, ExpectationAmount, Expectations, ExpectationUnit, FromtoItems, KnowledgeJson, LlmExecutionTools, LlmTemplateJson, MaterialKnowledgePieceJson, ModelRequirements, ModelVariant, Parameters, Prompt, PromptbookExecutor, PromptbookJson, PromptbookLibrary, PromptbookString, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptDialogJson, PromptResult, PromptResultUsage, PromptResultUsageCounts, PromptTemplateJson, PromptTemplateParameterJson, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptJson, ScriptLanguage, SimplePromptbookLibrary, SimpleTemplateJson, string_char, string_char_emoji, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, string_file_absolute_path, string_file_extension, string_file_path, string_file_relative_path, string_filename, string_folder_absolute_path, string_folder_path, string_folder_relative_path, string_host, string_hostname, string_href, string_html, string_javascript, string_javascript_name, string_license, string_markdown, string_markdown_text, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_person_fullname, string_prompt, string_promptbook_url, string_promptbook_url_with_hashtemplate, string_script, string_sha256, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_uri, string_uri_part, string_url, string_url_image, string_version, TaskProgress, UncertainNumber, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, };
 /**
  * TODO: Delete type aliases (from ../types/typeAliases) that are not exported here
  */

package/esm/typings/src/cli/actions/hello.d.ts

@@ -0,0 +1,7 @@
+import type { Command } from 'commander';
+/**
+ * Initializes testing `hello` command for Promptbook CLI utilities
+ *
+ * @private part of `promptbookCli`
+ */
+export declare function initializeHello(program: Command): void;

package/esm/typings/src/cli/actions/make.d.ts

@@ -0,0 +1,7 @@
+import type { Command } from 'commander';
+/**
+ * Initializes `make` command for Promptbook CLI utilities
+ *
+ * @private part of `promptbookCli`
+ */
+export declare function initializeMake(program: Command): void;

package/esm/typings/src/cli/actions/prettify.d.ts

@@ -0,0 +1,7 @@
+import type { Command } from 'commander';
+/**
+ * Initializes `prettify` command for Promptbook CLI utilities
+ *
+ * @private part of `promptbookCli`
+ */
+export declare function initializePrettify(program: Command): void;

package/esm/typings/src/{conversion/prettify/prettifyPromptbookStringCli.d.ts → cli/promptbookCli.d.ts}

@@ -1,7 +1,7 @@
 /**
- * Runs CLI script for prettifying promptbooks
+ * Runs CLI utilities of Promptbook package
  */
-export declare function prettifyPromptbookStringCli(): Promise<void>;
+export declare function promptbookCli(): Promise<void>;
 /**
  * TODO: [🥠] Do not export to utils directly, its just for CLI script
  * TODO: [🕌] When more functionalities, rename

package/esm/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.d.ts

@@ -1,7 +1,21 @@
 import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
 import type { KnowledgeJson } from '../../../types/PromptbookJson/KnowledgeJson';
 import type { string_markdown } from '../../../types/typeAliases';
-export declare function prepareKnowledgeFromMarkdown(options: {
+type PrepareKnowledgeFromMarkdownOptions = {
+    /**
+     * The source of the knowledge in markdown format
+     */
     content: string_markdown;
+    /**
+     * The LLM tools to use for the conversion and extraction of knowledge
+     */
     llmTools: LlmExecutionTools;
-}): Promise<KnowledgeJson>;
+    /**
+     * If true, the preaparation of knowledge logs additional information
+     *
+     * @default false
+     */
+    isVerbose?: boolean;
+};
+export declare function prepareKnowledgeFromMarkdown(options: PrepareKnowledgeFromMarkdownOptions): Promise<KnowledgeJson>;
+export {};

package/esm/typings/src/library/SimplePromptbookLibrary.d.ts

@@ -6,6 +6,7 @@ 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.
  *
+ * @private use `createLibraryFromJson` instead
  * @see https://github.com/webgptorg/promptbook#promptbook-library
  */
 export declare class SimplePromptbookLibrary implements PromptbookLibrary {
@@ -15,8 +16,9 @@ export declare class SimplePromptbookLibrary implements PromptbookLibrary {
      *
      * @param promptbooks !!!
      *
+     * @private Use instead `createLibraryFromJson`
      * Note: During the construction logic of all promptbooks are validated
-     * Note: It is not recommended to use this constructor directly, use `createPromptbookLibraryFromSources` *(or other variant)* instead
+     * Note: It is not recommended to use this constructor directly, use `createLibraryFromJson` *(or other variant)* instead
      */
     constructor(...promptbooks: Array<PromptbookJson>);
     /**

package/{umd/typings/src/library/constructors/createPromptbookLibraryFromDirectory.d.ts → esm/typings/src/library/constructors/createLibraryFromDirectory.d.ts}

@@ -1,7 +1,7 @@
 import type { string_folder_path } from '../../types/typeAliases';
 import type { PromptbookLibrary } from '../PromptbookLibrary';
 /**
- * Options for `createPromptbookLibraryFromDirectory` function
+ * Options for `createLibraryFromDirectory` function
  */
 type CreatePromptbookLibraryFromDirectoryOptions = {
     /**
@@ -39,7 +39,7 @@ type CreatePromptbookLibraryFromDirectoryOptions = {
  * @param options - Misc options for the library
  * @returns PromptbookLibrary
  */
-export declare function createPromptbookLibraryFromDirectory(path: string_folder_path, options?: CreatePromptbookLibraryFromDirectoryOptions): Promise<PromptbookLibrary>;
+export declare function createLibraryFromDirectory(path: string_folder_path, options?: CreatePromptbookLibraryFromDirectoryOptions): Promise<PromptbookLibrary>;
 export {};
 /**
  * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks

package/esm/typings/src/library/constructors/createLibraryFromJson.d.ts

@@ -0,0 +1,12 @@
+import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
+import { SimplePromptbookLibrary } from '../SimplePromptbookLibrary';
+/**
+ * Creates PromptbookLibrary from array of PromptbookJson or PromptbookString
+ *
+ * Note: Functions `libraryToJson` and `createLibraryFromJson` are complementary
+ * Note: During the construction syntax and logic of all sources are validated
+ *
+ * @param promptbookSources
+ * @returns PromptbookLibrary
+ */
+export declare function createLibraryFromJson(...promptbooks: Array<PromptbookJson>): Promise<SimplePromptbookLibrary>;

package/{umd/typings/src/library/constructors/createPromptbookLibraryFromPromise.d.ts → esm/typings/src/library/constructors/createLibraryFromPromise.d.ts}

@@ -1,5 +1,4 @@
 import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
-import type { PromptbookString } from '../../types/PromptbookString';
 import type { PromptbookLibrary } from '../PromptbookLibrary';
 /**
  * Constructs Promptbook from async sources
@@ -8,19 +7,16 @@ import type { PromptbookLibrary } from '../PromptbookLibrary';
  * - Factory function that returns Promise of array of PromptbookJson or PromptbookString
  *
  * Note: This is useful as internal tool for other constructor functions like
- *       `createPromptbookLibraryFromUrl` or `createPromptbookLibraryFromDirectory`
+ *       `createLibraryFromUrl` or `createLibraryFromDirectory`
  *       Consider using those functions instead of this one
  *
  * 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`
+ * Note: Consider using  `createLibraryFromDirectory` or `createLibraryFromUrl`
  *
  * @param promptbookSourcesPromiseOrFactory
  * @returns PromptbookLibrary
  * @deprecated Do not use, it will became internal tool for other constructor functions
  */
-export declare function createPromptbookLibraryFromPromise(promptbookSourcesPromiseOrFactory: Promise<Array<PromptbookJson | PromptbookString>> | (() => Promise<Array<PromptbookJson | PromptbookString>>)): PromptbookLibrary;
-/**
- * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
- */ 
+export declare function createLibraryFromPromise(promptbookSourcesPromiseOrFactory: Promise<Array<PromptbookJson>> | (() => Promise<Array<PromptbookJson>>)): PromptbookLibrary;

package/{umd/typings/src/library/constructors/createPromptbookLibraryFromUrl.d.ts → esm/typings/src/library/constructors/createLibraryFromUrl.d.ts}

@@ -1,7 +1,7 @@
 import type { string_url } from '../../types/typeAliases';
 import type { PromptbookLibrary } from '../PromptbookLibrary';
 /**
- * Options for `createPromptbookLibraryFromDirectory` function
+ * Options for `createLibraryFromDirectory` function
  */
 type CreatePromptbookLibraryFromUrlyOptions = {
     /**
@@ -22,7 +22,7 @@ type CreatePromptbookLibraryFromUrlyOptions = {
 
  * @returns PromptbookLibrary
  */
-export declare function createPromptbookLibraryFromUrl(url: string_url | URL, options: CreatePromptbookLibraryFromUrlyOptions): Promise<PromptbookLibrary>;
+export declare function createLibraryFromUrl(url: string_url | URL, options: CreatePromptbookLibraryFromUrlyOptions): Promise<PromptbookLibrary>;
 export {};
 /**
  * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks

package/esm/typings/src/library/constructors/{createPromptbookSublibrary.d.ts → createSublibrary.d.ts}

@@ -9,4 +9,4 @@ import type { PromptbookLibrary } from '../PromptbookLibrary';
  * @param promptbookSources
  * @returns PromptbookLibrary
  */
-export declare function createPromptbookSublibrary(library: PromptbookLibrary, predicate: (url: string_promptbook_url) => boolean): PromptbookLibrary;
+export declare function createSublibrary(library: PromptbookLibrary, predicate: (url: string_promptbook_url) => boolean): PromptbookLibrary;

package/esm/typings/src/library/libraryToJson.d.ts

@@ -0,0 +1,8 @@
+import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
+import type { PromptbookLibrary } from './PromptbookLibrary';
+/**
+ * Converts PromptbookLibrary to serialized JSON
+ *
+ * Note: Functions `libraryToJson` and `createLibraryFromJson` are complementary
+ */
+export declare function libraryToJson(library: PromptbookLibrary): Promise<Array<PromptbookJson>>;

package/esm/typings/src/llm-providers/remote/startRemoteServer.d.ts

@@ -10,7 +10,7 @@ import type { RemoteServerOptions } from './interfaces/RemoteServerOptions';
  */
 export declare function startRemoteServer(options: RemoteServerOptions): IDestroyable;
 /**
- * TODO: [⚖] Expose the library to be able to connect to same library via createPromptbookLibraryFromUrl
+ * TODO: [⚖] Expose the library to be able to connect to same library via createLibraryFromUrl
  * TODO: Handle progress - support streaming
  * TODO: [🤹‍♂️] Do not hang up immediately but wait until client closes OR timeout
  * TODO: [🤹‍♂️] Timeout on chat to free up resources

package/package.json

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

package/umd/index.umd.js

@@ -1043,7 +1043,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.59.0-22';
+    var PROMPTBOOK_VERSION = '0.59.0-21';
 
     exports.OPENAI_MODELS = OPENAI_MODELS;
     exports.OpenAiExecutionTools = OpenAiExecutionTools;

package/umd/typings/src/_packages/cli.index.d.ts

@@ -1,10 +1,10 @@
-import { prettifyPromptbookStringCli } from '../conversion/prettify/prettifyPromptbookStringCli';
+import { promptbookCli } from '../cli/promptbookCli';
 import { PROMPTBOOK_VERSION } from '../version';
 export { PROMPTBOOK_VERSION };
 /**
  * Hidden utilities which should not be used by external consumers.
  */
 declare const __: {
-    prettifyPromptbookStringCli: typeof prettifyPromptbookStringCli;
+    promptbookCli: typeof promptbookCli;
 };
 export { __ };

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

@@ -20,11 +20,11 @@ import { CallbackInterfaceTools } from '../knowledge/dialogs/callback/CallbackIn
 import type { CallbackInterfaceToolsOptions } from '../knowledge/dialogs/callback/CallbackInterfaceToolsOptions';
 import { SimplePromptInterfaceTools } from '../knowledge/dialogs/simple-prompt/SimplePromptInterfaceTools';
 import { prepareKnowledgeFromMarkdown } from '../knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown';
-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 { SimplePromptbookLibrary } from '../library/SimplePromptbookLibrary';
+import { createLibraryFromJson } from '../library/constructors/createLibraryFromJson';
+import { createLibraryFromPromise } from '../library/constructors/createLibraryFromPromise';
+import { createLibraryFromUrl } from '../library/constructors/createLibraryFromUrl';
+import { createSublibrary } from '../library/constructors/createSublibrary';
+import { libraryToJson } from '../library/libraryToJson';
 import { MultipleLlmExecutionTools } from '../llm-providers/multiple/MultipleLlmExecutionTools';
 import { executionReportJsonToString } from '../types/execution-report/executionReportJsonToString';
 import type { ExecutionReportStringOptions } from '../types/execution-report/ExecutionReportStringOptions';
@@ -34,7 +34,7 @@ import { PROMPTBOOK_VERSION } from '../version';
 export { PROMPTBOOK_VERSION };
 export { ExecutionTypes };
 export { addUsage, assertsExecutionSuccessful, checkExpectations, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, isPassingExpectations, prepareKnowledgeFromMarkdown, prettifyPromptbookString, usageToWorktime, };
-export { createPromptbookLibraryFromPromise, createPromptbookLibraryFromSources, createPromptbookLibraryFromUrl, createPromptbookSublibrary, SimplePromptbookLibrary, };
+export { createLibraryFromJson, createLibraryFromPromise, createLibraryFromUrl, createSublibrary, libraryToJson };
 export { SimplePromptInterfaceTools };
 export { promptbookJsonToString, promptbookStringToJson, validatePromptbookJson };
 export { createPromptbookExecutor, MultipleLlmExecutionTools };

package/umd/typings/src/_packages/node.index.d.ts

@@ -1,4 +1,4 @@
-import { createPromptbookLibraryFromDirectory } from '../library/constructors/createPromptbookLibraryFromDirectory';
+import { createLibraryFromDirectory } from '../library/constructors/createLibraryFromDirectory';
 import { PROMPTBOOK_VERSION } from '../version';
 export { PROMPTBOOK_VERSION };
-export { createPromptbookLibraryFromDirectory };
+export { createLibraryFromDirectory };

package/umd/typings/src/_packages/types.index.d.ts

@@ -6,6 +6,7 @@ import type { PromptbookExecutor } from '../execution/PromptbookExecutor';
 import type { ScriptExecutionTools, ScriptExecutionToolsExecuteOptions } from '../execution/ScriptExecutionTools';
 import type { UserInterfaceTools, UserInterfaceToolsPromptDialogOptions } from '../execution/UserInterfaceTools';
 import type { PromptbookLibrary } from '../library/PromptbookLibrary';
+import type { SimplePromptbookLibrary } from '../library/SimplePromptbookLibrary';
 import type { ExecutionType } from '../types/ExecutionTypes';
 import type { ModelRequirements, ModelVariant } from '../types/ModelRequirements';
 import type { Parameters } from '../types/Parameters';
@@ -26,7 +27,7 @@ import type { FromtoItems } from '../utils/FromtoItems';
 import { PROMPTBOOK_VERSION } from '../version';
 export { PROMPTBOOK_VERSION };
 export { EXPECTATION_UNITS };
-export type { AvailableModel, client_id, CommonExecutionToolsOptions, ExecutionReportJson, ExecutionTools, ExecutionType, ExpectationAmount, Expectations, ExpectationUnit, FromtoItems, KnowledgeJson, LlmExecutionTools, LlmTemplateJson, MaterialKnowledgePieceJson, ModelRequirements, ModelVariant, Parameters, Prompt, PromptbookExecutor, PromptbookJson, PromptbookLibrary, PromptbookString, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptDialogJson, PromptResult, PromptResultUsage, PromptResultUsageCounts, PromptTemplateJson, PromptTemplateParameterJson, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptJson, ScriptLanguage, SimpleTemplateJson, string_char, string_char_emoji, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, string_file_absolute_path, string_file_extension, string_file_path, string_file_relative_path, string_filename, string_folder_absolute_path, string_folder_path, string_folder_relative_path, string_host, string_hostname, string_href, string_html, string_javascript, string_javascript_name, string_license, string_markdown, string_markdown_text, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_person_fullname, string_prompt, string_promptbook_url, string_promptbook_url_with_hashtemplate, string_script, string_sha256, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_uri, string_uri_part, string_url, string_url_image, string_version, TaskProgress, UncertainNumber, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, };
+export type { AvailableModel, client_id, CommonExecutionToolsOptions, ExecutionReportJson, ExecutionTools, ExecutionType, ExpectationAmount, Expectations, ExpectationUnit, FromtoItems, KnowledgeJson, LlmExecutionTools, LlmTemplateJson, MaterialKnowledgePieceJson, ModelRequirements, ModelVariant, Parameters, Prompt, PromptbookExecutor, PromptbookJson, PromptbookLibrary, PromptbookString, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptDialogJson, PromptResult, PromptResultUsage, PromptResultUsageCounts, PromptTemplateJson, PromptTemplateParameterJson, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptJson, ScriptLanguage, SimplePromptbookLibrary, SimpleTemplateJson, string_char, string_char_emoji, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, string_file_absolute_path, string_file_extension, string_file_path, string_file_relative_path, string_filename, string_folder_absolute_path, string_folder_path, string_folder_relative_path, string_host, string_hostname, string_href, string_html, string_javascript, string_javascript_name, string_license, string_markdown, string_markdown_text, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_person_fullname, string_prompt, string_promptbook_url, string_promptbook_url_with_hashtemplate, string_script, string_sha256, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_uri, string_uri_part, string_url, string_url_image, string_version, TaskProgress, UncertainNumber, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, };
 /**
  * TODO: Delete type aliases (from ../types/typeAliases) that are not exported here
  */

package/umd/typings/src/cli/actions/hello.d.ts

@@ -0,0 +1,7 @@
+import type { Command } from 'commander';
+/**
+ * Initializes testing `hello` command for Promptbook CLI utilities
+ *
+ * @private part of `promptbookCli`
+ */
+export declare function initializeHello(program: Command): void;

package/umd/typings/src/cli/actions/make.d.ts

@@ -0,0 +1,7 @@
+import type { Command } from 'commander';
+/**
+ * Initializes `make` command for Promptbook CLI utilities
+ *
+ * @private part of `promptbookCli`
+ */
+export declare function initializeMake(program: Command): void;

package/umd/typings/src/cli/actions/prettify.d.ts

@@ -0,0 +1,7 @@
+import type { Command } from 'commander';
+/**
+ * Initializes `prettify` command for Promptbook CLI utilities
+ *
+ * @private part of `promptbookCli`
+ */
+export declare function initializePrettify(program: Command): void;

package/umd/typings/src/{conversion/prettify/prettifyPromptbookStringCli.d.ts → cli/promptbookCli.d.ts}

@@ -1,7 +1,7 @@
 /**
- * Runs CLI script for prettifying promptbooks
+ * Runs CLI utilities of Promptbook package
  */
-export declare function prettifyPromptbookStringCli(): Promise<void>;
+export declare function promptbookCli(): Promise<void>;
 /**
  * TODO: [🥠] Do not export to utils directly, its just for CLI script
  * TODO: [🕌] When more functionalities, rename

package/umd/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.d.ts

@@ -1,7 +1,21 @@
 import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
 import type { KnowledgeJson } from '../../../types/PromptbookJson/KnowledgeJson';
 import type { string_markdown } from '../../../types/typeAliases';
-export declare function prepareKnowledgeFromMarkdown(options: {
+type PrepareKnowledgeFromMarkdownOptions = {
+    /**
+     * The source of the knowledge in markdown format
+     */
     content: string_markdown;
+    /**
+     * The LLM tools to use for the conversion and extraction of knowledge
+     */
     llmTools: LlmExecutionTools;
-}): Promise<KnowledgeJson>;
+    /**
+     * If true, the preaparation of knowledge logs additional information
+     *
+     * @default false
+     */
+    isVerbose?: boolean;
+};
+export declare function prepareKnowledgeFromMarkdown(options: PrepareKnowledgeFromMarkdownOptions): Promise<KnowledgeJson>;
+export {};

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

@@ -6,6 +6,7 @@ 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.
  *
+ * @private use `createLibraryFromJson` instead
  * @see https://github.com/webgptorg/promptbook#promptbook-library
  */
 export declare class SimplePromptbookLibrary implements PromptbookLibrary {
@@ -15,8 +16,9 @@ export declare class SimplePromptbookLibrary implements PromptbookLibrary {
      *
      * @param promptbooks !!!
      *
+     * @private Use instead `createLibraryFromJson`
      * Note: During the construction logic of all promptbooks are validated
-     * Note: It is not recommended to use this constructor directly, use `createPromptbookLibraryFromSources` *(or other variant)* instead
+     * Note: It is not recommended to use this constructor directly, use `createLibraryFromJson` *(or other variant)* instead
      */
     constructor(...promptbooks: Array<PromptbookJson>);
     /**

package/{esm/typings/src/library/constructors/createPromptbookLibraryFromDirectory.d.ts → umd/typings/src/library/constructors/createLibraryFromDirectory.d.ts}

@@ -1,7 +1,7 @@
 import type { string_folder_path } from '../../types/typeAliases';
 import type { PromptbookLibrary } from '../PromptbookLibrary';
 /**
- * Options for `createPromptbookLibraryFromDirectory` function
+ * Options for `createLibraryFromDirectory` function
  */
 type CreatePromptbookLibraryFromDirectoryOptions = {
     /**
@@ -39,7 +39,7 @@ type CreatePromptbookLibraryFromDirectoryOptions = {
  * @param options - Misc options for the library
  * @returns PromptbookLibrary
  */
-export declare function createPromptbookLibraryFromDirectory(path: string_folder_path, options?: CreatePromptbookLibraryFromDirectoryOptions): Promise<PromptbookLibrary>;
+export declare function createLibraryFromDirectory(path: string_folder_path, options?: CreatePromptbookLibraryFromDirectoryOptions): Promise<PromptbookLibrary>;
 export {};
 /**
  * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks

package/umd/typings/src/library/constructors/createLibraryFromJson.d.ts

@@ -0,0 +1,12 @@
+import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
+import { SimplePromptbookLibrary } from '../SimplePromptbookLibrary';
+/**
+ * Creates PromptbookLibrary from array of PromptbookJson or PromptbookString
+ *
+ * Note: Functions `libraryToJson` and `createLibraryFromJson` are complementary
+ * Note: During the construction syntax and logic of all sources are validated
+ *
+ * @param promptbookSources
+ * @returns PromptbookLibrary
+ */
+export declare function createLibraryFromJson(...promptbooks: Array<PromptbookJson>): Promise<SimplePromptbookLibrary>;

package/{esm/typings/src/library/constructors/createPromptbookLibraryFromPromise.d.ts → umd/typings/src/library/constructors/createLibraryFromPromise.d.ts}

@@ -1,5 +1,4 @@
 import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
-import type { PromptbookString } from '../../types/PromptbookString';
 import type { PromptbookLibrary } from '../PromptbookLibrary';
 /**
  * Constructs Promptbook from async sources
@@ -8,19 +7,16 @@ import type { PromptbookLibrary } from '../PromptbookLibrary';
  * - Factory function that returns Promise of array of PromptbookJson or PromptbookString
  *
  * Note: This is useful as internal tool for other constructor functions like
- *       `createPromptbookLibraryFromUrl` or `createPromptbookLibraryFromDirectory`
+ *       `createLibraryFromUrl` or `createLibraryFromDirectory`
  *       Consider using those functions instead of this one
  *
  * 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`
+ * Note: Consider using  `createLibraryFromDirectory` or `createLibraryFromUrl`
  *
  * @param promptbookSourcesPromiseOrFactory
  * @returns PromptbookLibrary
  * @deprecated Do not use, it will became internal tool for other constructor functions
  */
-export declare function createPromptbookLibraryFromPromise(promptbookSourcesPromiseOrFactory: Promise<Array<PromptbookJson | PromptbookString>> | (() => Promise<Array<PromptbookJson | PromptbookString>>)): PromptbookLibrary;
-/**
- * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
- */ 
+export declare function createLibraryFromPromise(promptbookSourcesPromiseOrFactory: Promise<Array<PromptbookJson>> | (() => Promise<Array<PromptbookJson>>)): PromptbookLibrary;

package/umd/typings/src/library/constructors/createLibraryFromPromise.test.d.ts

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

package/{esm/typings/src/library/constructors/createPromptbookLibraryFromUrl.d.ts → umd/typings/src/library/constructors/createLibraryFromUrl.d.ts}

@@ -1,7 +1,7 @@
 import type { string_url } from '../../types/typeAliases';
 import type { PromptbookLibrary } from '../PromptbookLibrary';
 /**
- * Options for `createPromptbookLibraryFromDirectory` function
+ * Options for `createLibraryFromDirectory` function
  */
 type CreatePromptbookLibraryFromUrlyOptions = {
     /**
@@ -22,7 +22,7 @@ type CreatePromptbookLibraryFromUrlyOptions = {
 
  * @returns PromptbookLibrary
  */
-export declare function createPromptbookLibraryFromUrl(url: string_url | URL, options: CreatePromptbookLibraryFromUrlyOptions): Promise<PromptbookLibrary>;
+export declare function createLibraryFromUrl(url: string_url | URL, options: CreatePromptbookLibraryFromUrlyOptions): Promise<PromptbookLibrary>;
 export {};
 /**
  * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks

package/umd/typings/src/library/constructors/{createPromptbookSublibrary.d.ts → createSublibrary.d.ts}

@@ -9,4 +9,4 @@ import type { PromptbookLibrary } from '../PromptbookLibrary';
  * @param promptbookSources
  * @returns PromptbookLibrary
  */
-export declare function createPromptbookSublibrary(library: PromptbookLibrary, predicate: (url: string_promptbook_url) => boolean): PromptbookLibrary;
+export declare function createSublibrary(library: PromptbookLibrary, predicate: (url: string_promptbook_url) => boolean): PromptbookLibrary;

package/umd/typings/src/library/libraryToJson.d.ts

@@ -0,0 +1,8 @@
+import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
+import type { PromptbookLibrary } from './PromptbookLibrary';
+/**
+ * Converts PromptbookLibrary to serialized JSON
+ *
+ * Note: Functions `libraryToJson` and `createLibraryFromJson` are complementary
+ */
+export declare function libraryToJson(library: PromptbookLibrary): Promise<Array<PromptbookJson>>;

package/umd/typings/src/library/libraryToJson.test.d.ts

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

package/umd/typings/src/llm-providers/remote/startRemoteServer.d.ts

@@ -10,7 +10,7 @@ import type { RemoteServerOptions } from './interfaces/RemoteServerOptions';
  */
 export declare function startRemoteServer(options: RemoteServerOptions): IDestroyable;
 /**
- * TODO: [⚖] Expose the library to be able to connect to same library via createPromptbookLibraryFromUrl
+ * TODO: [⚖] Expose the library to be able to connect to same library via createLibraryFromUrl
  * TODO: Handle progress - support streaming
  * TODO: [🤹‍♂️] Do not hang up immediately but wait until client closes OR timeout
  * TODO: [🤹‍♂️] Timeout on chat to free up resources

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

@@ -1,16 +0,0 @@
-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
- *
- * Note: You can combine `PromptbookString` (`.ptbk.md`) with `PromptbookJson` BUT it is not recommended
- * Note: During the construction syntax and logic of all sources are validated
- *
- * @param promptbookSources
- * @returns PromptbookLibrary
- */
-export declare function createPromptbookLibraryFromSources(...promptbookSources: Array<PromptbookJson | PromptbookString>): Promise<SimplePromptbookLibrary>;
-/**
- * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
- */ 

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

@@ -1,16 +0,0 @@
-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
- *
- * Note: You can combine `PromptbookString` (`.ptbk.md`) with `PromptbookJson` BUT it is not recommended
- * Note: During the construction syntax and logic of all sources are validated
- *
- * @param promptbookSources
- * @returns PromptbookLibrary
- */
-export declare function createPromptbookLibraryFromSources(...promptbookSources: Array<PromptbookJson | PromptbookString>): Promise<SimplePromptbookLibrary>;
-/**
- * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
- */