@promptbook/openai 0.40.0-1 → 0.40.0-10

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

@@ -6,9 +6,13 @@ import { CallbackInterfaceTools } from '../execution/plugins/user-interface-exec
 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/esm/typings/_packages/types.index.d.ts

@@ -1,8 +1,3 @@
-import { ExpectError } from '../errors/ExpectError';
-import { NotFoundError } from '../errors/NotFoundError';
-import { PromptbookExecutionError } from '../errors/PromptbookExecutionError';
-import { PromptbookLogicError } from '../errors/PromptbookLogicError';
-import { PromptbookSyntaxError } from '../errors/PromptbookSyntaxError';
 import type { CommonExecutionToolsOptions } from '../execution/CommonExecutionToolsOptions';
 import type { ExecutionTools } from '../execution/ExecutionTools';
 import type { NaturalExecutionTools } from '../execution/NaturalExecutionTools';
@@ -26,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, PromptbookExecutionError, PromptbookLogicError, PromptbookSyntaxError };
 /**
- * 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/esm/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/esm/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/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/esm/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/esm/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/esm/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/esm/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/package.json

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

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

@@ -6,9 +6,13 @@ import { CallbackInterfaceTools } from '../execution/plugins/user-interface-exec
 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,8 +1,3 @@
-import { ExpectError } from '../errors/ExpectError';
-import { NotFoundError } from '../errors/NotFoundError';
-import { PromptbookExecutionError } from '../errors/PromptbookExecutionError';
-import { PromptbookLogicError } from '../errors/PromptbookLogicError';
-import { PromptbookSyntaxError } from '../errors/PromptbookSyntaxError';
 import type { CommonExecutionToolsOptions } from '../execution/CommonExecutionToolsOptions';
 import type { ExecutionTools } from '../execution/ExecutionTools';
 import type { NaturalExecutionTools } from '../execution/NaturalExecutionTools';
@@ -26,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, PromptbookExecutionError, PromptbookLogicError, PromptbookSyntaxError };
 /**
- * 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/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/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/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
+ */