@promptbook/utils 0.40.0-0 → 0.40.0-10

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

@@ -1,14 +1,18 @@
 import { promptbookStringToJson } from '../conversion/promptbookStringToJson';
-import { validatePromptbookJson } from '../conversion/validatePromptbookJson';
+import { validatePromptbookJson } from '../conversion/test/validatePromptbookJson';
 import { createPromptbookExecutor } from '../execution/createPromptbookExecutor';
 import { MockedEchoNaturalExecutionTools } from '../execution/plugins/natural-execution-tools/mocked/MockedEchoNaturalExecutionTools';
 import { CallbackInterfaceTools } from '../execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceTools';
 import { CallbackInterfaceToolsOptions } from '../execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceToolsOptions';
 import { SimplePromptInterfaceTools } from '../execution/plugins/user-interface-execution-tools/simple-prompt/SimplePromptInterfaceTools';
 import { SimplePromptbookLibrary } from '../library/SimplePromptbookLibrary';
+import { createPromptbookLibraryFromPromise } from '../library/constructors/createPromptbookLibraryFromPromise';
+import { createPromptbookLibraryFromSources } from '../library/constructors/createPromptbookLibraryFromSources';
+import { createPromptbookSublibrary } from '../library/constructors/createPromptbookSublibrary';
 import { ExecutionTypes } from '../types/ExecutionTypes';
 import { PROMPTBOOK_VERSION } from '../version';
-export { ExecutionTypes, PROMPTBOOK_VERSION, SimplePromptbookLibrary };
+export { ExecutionTypes, PROMPTBOOK_VERSION };
+export { SimplePromptbookLibrary, createPromptbookLibraryFromPromise, createPromptbookLibraryFromSources, createPromptbookSublibrary, };
 export { SimplePromptInterfaceTools };
 export { promptbookStringToJson, validatePromptbookJson };
 export { MockedEchoNaturalExecutionTools };

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

@@ -1,5 +1,3 @@
-import { ExpectError } from '../errors/ExpectError';
-import { NotFoundError } from '../errors/NotFoundError';
 import type { CommonExecutionToolsOptions } from '../execution/CommonExecutionToolsOptions';
 import type { ExecutionTools } from '../execution/ExecutionTools';
 import type { NaturalExecutionTools } from '../execution/NaturalExecutionTools';
@@ -23,8 +21,7 @@ import type { string_char_emoji } from '../types/typeAliasEmoji';
 import type { client_id, string_char, 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 } from '../types/typeAliases';
 import { FromtoItems } from '../utils/FromtoItems';
 export { CommonExecutionToolsOptions, EXPECTATION_UNITS, ExecutionReportJson, ExecutionTools, ExecutionType, ExpectationAmount, ExpectationUnit, FromtoItems, ModelRequirements, ModelVariant, NaturalExecutionTools, Parameters, Prompt, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptResult, PromptTemplateJson, PromptTemplateParameterJson, PromptbookExecutor, PromptbookJson, PromptbookLibrary, PromptbookString, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptLanguage, TaskProgress, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, client_id, 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, };
-export { ExpectError, NotFoundError };
 /**
- * TODO: [🧠] Is this the best package to export custom errors from?
+ * TODO: [🧠][🆔] Is this the best package to export custom errors from?
  * TODO: Delete type aliases (from ../types/typeAliases) that are not exported here
  */

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

@@ -1,3 +1,4 @@
+import { parseNumber } from '../conversion/utils/parseNumber';
 import { assertsExecutionSuccessful } from '../execution/assertsExecutionSuccessful';
 import { ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults } from '../types/execution-report/ExecutionReportStringOptions';
 import { executionReportJsonToString } from '../types/execution-report/executionReportJsonToString';
@@ -14,13 +15,15 @@ import { extractAllListItemsFromMarkdown } from '../utils/markdown/extractAllLis
 import { extractOneBlockFromMarkdown } from '../utils/markdown/extractOneBlockFromMarkdown';
 import { removeContentComments } from '../utils/markdown/removeContentComments';
 import { removeMarkdownFormatting } from '../utils/markdown/removeMarkdownFormatting';
-import { parseNumber } from '../utils/parseNumber';
 import { removeEmojis } from '../utils/removeEmojis';
 import { removeQuotes } from '../utils/removeQuotes';
 import { trimCodeBlock } from '../utils/trimCodeBlock';
 import { trimEndOfCodeBlock } from '../utils/trimEndOfCodeBlock';
 import { unwrapResult } from '../utils/unwrapResult';
-export { CountUtils, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, assertsExecutionSuccessful, countCharacters, countLines, countPages, countParagraphs, countSentences, countWords, executionReportJsonToString, extractAllBlocksFromMarkdown, extractAllListItemsFromMarkdown, extractOneBlockFromMarkdown, isValidJsonString, parseNumber, removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
+export { CountUtils, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, assertsExecutionSuccessful, countCharacters, countLines, countPages, countParagraphs, countSentences, countWords, executionReportJsonToString, extractAllBlocksFromMarkdown, // <- [🌻]
+extractAllListItemsFromMarkdown, // <- [🌻]
+extractOneBlockFromMarkdown, // <- [🌻]
+isValidJsonString, parseNumber, removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
 /**
  * TODO: [🧠] Maybe create some indipendent package like `markdown-tools` from both here exported and @private utilities
  */

package/umd/typings/config.d.ts

@@ -0,0 +1,4 @@
+/**
+ * The maximum number of iterations for a loops
+ */
+export declare const LOOP_LIMIT = 1000;

package/umd/typings/conversion/{_importPromptbook.d.ts → test/_importPromptbook.d.ts}

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

package/{esm/typings/conversion → umd/typings/conversion/test}/validatePromptbookJson.d.ts

@@ -1,4 +1,4 @@
-import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
+import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
 /**
  * Validates PromptbookJson if it is logically valid.
  *

package/{esm/typings → umd/typings/conversion}/utils/extractVariables.d.ts

@@ -1,10 +1,10 @@
-import { string_javascript, string_javascript_name } from '../types/typeAliases';
+import { string_javascript, 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
  *
  * @param script from which to extract the variables
  * @returns the list of variable names
  *
- * @private within the library
+ * @private within the promptbookStringToJson
  */
 export declare function extractVariables(script: string_javascript): Array<string_javascript_name>;

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

@@ -0,0 +1,8 @@
+import type { Command } from '../../types/Command';
+import type { string_markdown_text } from '../../types/typeAliases';
+/**
+ * Parses one line of ul/ol to command
+ *
+ * @private within the promptbookStringToJson
+ */
+export declare function parseCommand(listItem: string_markdown_text): Command;

package/{esm/typings → umd/typings/conversion}/utils/parseNumber.d.ts

@@ -3,6 +3,8 @@
  *
  * Unlike Number.parseInt, Number.parseFloat it will never ever result in NaN
  * Note: it also works only with decimal numbers
+ *
+ * @private within the parseCommand
  */
 export declare function parseNumber(value: string | number): number;
 /**

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

@@ -1,5 +1,7 @@
 /**
  * This error occurs when some expectation is not met in the execution of the pipeline
+ *
+ * Note: This is a kindof subtype of PromptbookExecutionError
  */
 export declare class ExpectError extends Error {
     readonly name = "ExpectError";

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

@@ -1,5 +1,5 @@
 /**
- * This error !!!
+ * This error indicates that the requested resource (for example promptbook in the library ) was not found
  */
 export declare class NotFoundError extends Error {
     readonly name = "NotFoundError";

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

@@ -0,0 +1,7 @@
+/**
+ * This error indicates errors during the execution of the promptbook
+ */
+export declare class PromptbookExecutionError extends Error {
+    readonly name = "PromptbookExecutionError";
+    constructor(message: string);
+}

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

@@ -0,0 +1,7 @@
+/**
+ * This error indicates that the promptbook object has valid syntax but contains logical errors (like circular dependencies)
+ */
+export declare class PromptbookLogicError extends Error {
+    readonly name = "PromptbookLogicError";
+    constructor(message: string);
+}

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

@@ -0,0 +1,7 @@
+/**
+ * This error indicates errors in referencing promptbooks between each other
+ */
+export declare class PromptbookReferenceError extends Error {
+    readonly name = "PromptbookReferenceError";
+    constructor(message: string);
+}

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

@@ -0,0 +1,7 @@
+/**
+ * This error indicates that the promptbook in a markdown format cannot be parsed into a valid promptbook object
+ */
+export declare class PromptbookSyntaxError extends Error {
+    readonly name = "PromptbookSyntaxError";
+    constructor(message: string);
+}

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

@@ -0,0 +1,7 @@
+/**
+ * This error type indicates that the error should not happen and its last check before crashing with some other error
+ */
+export declare class UnexpectedError extends Error {
+    readonly name = "UnexpectedError";
+    constructor(message: string);
+}

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

@@ -6,7 +6,7 @@ import { number_integer, number_positive } from '../types/typeAliases';
  */
 export type UserInterfaceTools = {
     /**
-     * Asks the user to answer a free-text (multiline) question
+     * Asks the user to answer a free-text (multi-line) question
      *
      * @param options the question to ask
      * @returns the answer from the user

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

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

package/{esm/typings → umd/typings/execution}/utils/replaceParameters.d.ts

@@ -1,5 +1,5 @@
-import { string_template } from '.././types/typeAliases';
-import { Parameters } from '../types/Parameters';
+import { Parameters } from '../../types/Parameters';
+import { string_template } from '../../types/typeAliases';
 /**
  * Replaces parameters in template with values from parameters object
  *
@@ -7,6 +7,6 @@ import { Parameters } from '../types/Parameters';
  * @param parameters the object with parameters
  * @returns the template with replaced parameters
  *
- * @private within the library
+ * @private within the createPromptbookExecutor
  */
 export declare function replaceParameters(template: string_template, parameters: Parameters): string;

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

@@ -21,5 +21,5 @@ export type PromptbookLibrary = {
     /**
      * Checks whether given prompt was defined in any promptbook in the library
      */
-    isResponsibleForPrompt(prompt: Prompt): boolean;
+    isResponsibleForPrompt(prompt: Prompt): Promisable<boolean>;
 };

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

@@ -1,29 +1,23 @@
-import { CreatePromptbookExecutorSettings } from '../execution/createPromptbookExecutor';
 import type { Prompt } from '../types/Prompt';
 import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
-import type { PromptbookString } from '../types/PromptbookString';
 import type { string_promptbook_url } from '../types/typeAliases';
 import { PromptbookLibrary } from './PromptbookLibrary';
 /**
  * Library of promptbooks that groups together promptbooks for an application.
- * This implementation is a very thin wrapper around the Array / Set of promptbooks.
+ * This implementation is a very thin wrapper around the Array / Map of promptbooks.
  *
  * @see https://github.com/webgptorg/promptbook#promptbook-library
  */
 export declare class SimplePromptbookLibrary implements PromptbookLibrary {
-    private readonly options;
-    /**
-     * Constructs Promptbook from any sources
+    private library;
+    /**!!!
      *
-     * Note: During the construction syntax and logic of all sources are validated
-     * Note: You can combine .ptbk.md and .ptbk.json files BUT it is not recommended
+     * @param promptbooks !!!
      *
-     * @param promptbookSources contents of .ptbk.md or .ptbk.json files
-     * @param settings settings for creating executor functions
-     * @returns PromptbookLibrary
+     * 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
      */
-    static fromSources(promptbookSources: Record<string_promptbook_url, PromptbookJson | PromptbookString>, settings?: Partial<CreatePromptbookExecutorSettings>): SimplePromptbookLibrary;
-    private constructor();
+    constructor(...promptbooks: Array<PromptbookJson>);
     /**
      * Gets all promptbooks in the library
      */

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

@@ -0,0 +1,7 @@
+import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
+import { PromptbookString } from '../../types/PromptbookString';
+import { PromptbookLibrary } from '../PromptbookLibrary';
+export declare function createPromptbookLibraryFromPromise(promptbookSourcesPromiseOrFactory: Promise<Array<PromptbookJson | PromptbookString>> | (() => Promise<Array<PromptbookJson | PromptbookString>>)): PromptbookLibrary;
+/***
+ * TODO: !!! Annotate all + all to README and samples
+ */

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

@@ -0,0 +1,16 @@
+import { PromptbookJson, PromptbookString } from '../../_packages/types.index';
+import { SimplePromptbookLibrary } from '../SimplePromptbookLibrary';
+export declare function createPromptbookLibraryFromSources(...promptbookSources: Array<PromptbookJson | PromptbookString>): SimplePromptbookLibrary;
+/**
+ * Constructs Promptbook from any sources
+ *
+ * Note: During the construction syntax and logic of all sources are validated
+ * Note: You can combine .ptbk.md and .ptbk.json files BUT it is not recommended
+ *
+ * @param promptbookSources contents of .ptbk.md or .ptbk.json files
+ * @param settings settings for creating executor functions
+ * @returns PromptbookLibrary
+ */
+/***
+ * TODO: !!! Annotate all + all to README and samples
+ */

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

@@ -0,0 +1,6 @@
+import type { string_promptbook_url } from '../../types/typeAliases';
+import { PromptbookLibrary } from '../PromptbookLibrary';
+export declare function createPromptbookSublibrary(library: PromptbookLibrary, predicate: (url: string_promptbook_url) => boolean): PromptbookLibrary;
+/***
+ * TODO: !!! Annotate all + all to README and samples
+ */

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

@@ -12,3 +12,6 @@ export declare function extractOneBlockFromMarkdown(markdown: string_markdown):
     language: string | null;
     content: string;
 };
+/***
+ * TODO: [🌻] !!! Decide of this is internal util, external util OR validator/postprocessor
+ */

package/esm/typings/conversion/parseCommand.d.ts

@@ -1,6 +0,0 @@
-import type { string_markdown_text } from '.././types/typeAliases';
-import type { Command } from '../types/Command';
-/**
- * Parses one line of ul/ol to command
- */
-export declare function parseCommand(listItem: string_markdown_text): Command;

package/umd/typings/conversion/parseCommand.d.ts

@@ -1,6 +0,0 @@
-import type { string_markdown_text } from '.././types/typeAliases';
-import type { Command } from '../types/Command';
-/**
- * Parses one line of ul/ol to command
- */
-export declare function parseCommand(listItem: string_markdown_text): Command;