@promptbook/remote-server 0.81.0-8 → 0.82.0-0

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

@@ -60,21 +60,6 @@ import type { AzureOpenAiExecutionToolsOptions } from '../llm-providers/azure-op
 import type { GoogleExecutionToolsOptions } from '../llm-providers/google/GoogleExecutionToolsOptions';
 import type { OpenAiAssistantExecutionToolsOptions } from '../llm-providers/openai/OpenAiAssistantExecutionToolsOptions';
 import type { OpenAiExecutionToolsOptions } from '../llm-providers/openai/OpenAiExecutionToolsOptions';
-import type { PromptbookServer_Error } from '../llm-providers/remote/interfaces/PromptbookServer_Error';
-import type { PromptbookServer_ListModels_Request } from '../llm-providers/remote/interfaces/PromptbookServer_ListModels_Request';
-import type { PromptbookServer_ListModels_CollectionRequest } from '../llm-providers/remote/interfaces/PromptbookServer_ListModels_Request';
-import type { PromptbookServer_ListModels_AnonymousRequest } from '../llm-providers/remote/interfaces/PromptbookServer_ListModels_Request';
-import type { PromptbookServer_ListModels_Response } from '../llm-providers/remote/interfaces/PromptbookServer_ListModels_Response';
-import type { PromptbookServer_Prompt_Progress } from '../llm-providers/remote/interfaces/PromptbookServer_Prompt_Progress';
-import type { PromptbookServer_Prompt_Request } from '../llm-providers/remote/interfaces/PromptbookServer_Prompt_Request';
-import type { PromptbookServer_Prompt_CollectionRequest } from '../llm-providers/remote/interfaces/PromptbookServer_Prompt_Request';
-import type { PromptbookServer_Prompt_AnonymousRequest } from '../llm-providers/remote/interfaces/PromptbookServer_Prompt_Request';
-import type { PromptbookServer_Prompt_Response } from '../llm-providers/remote/interfaces/PromptbookServer_Prompt_Response';
-import type { RemoteLlmExecutionToolsOptions } from '../llm-providers/remote/interfaces/RemoteLlmExecutionToolsOptions';
-import type { RemoteServerOptions } from '../llm-providers/remote/interfaces/RemoteServerOptions';
-import type { AnonymousRemoteServerOptions } from '../llm-providers/remote/interfaces/RemoteServerOptions';
-import type { CollectionRemoteServerOptions } from '../llm-providers/remote/interfaces/RemoteServerOptions';
-import type { CollectionRemoteServerClientOptions } from '../llm-providers/remote/interfaces/RemoteServerOptions';
 import type { VercelExecutionToolsOptions } from '../llm-providers/vercel/VercelExecutionToolsOptions';
 import type { VercelProvider } from '../llm-providers/vercel/VercelProvider';
 import type { IsPipelineImplementingInterfaceOptions } from '../pipeline/PipelineInterface/isPipelineImplementingInterface';
@@ -102,6 +87,21 @@ import type { SimpleTaskJson } from '../pipeline/PipelineJson/SimpleTaskJson';
 import type { TaskJson } from '../pipeline/PipelineJson/TaskJson';
 import type { PipelineString } from '../pipeline/PipelineString';
 import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
+import type { PromptbookServer_Error } from '../remote-server/interfaces/PromptbookServer_Error';
+import type { PromptbookServer_ListModels_Request } from '../remote-server/interfaces/PromptbookServer_ListModels_Request';
+import type { PromptbookServer_ListModels_CollectionRequest } from '../remote-server/interfaces/PromptbookServer_ListModels_Request';
+import type { PromptbookServer_ListModels_AnonymousRequest } from '../remote-server/interfaces/PromptbookServer_ListModels_Request';
+import type { PromptbookServer_ListModels_Response } from '../remote-server/interfaces/PromptbookServer_ListModels_Response';
+import type { PromptbookServer_Prompt_Progress } from '../remote-server/interfaces/PromptbookServer_Prompt_Progress';
+import type { PromptbookServer_Prompt_Request } from '../remote-server/interfaces/PromptbookServer_Prompt_Request';
+import type { PromptbookServer_Prompt_CollectionRequest } from '../remote-server/interfaces/PromptbookServer_Prompt_Request';
+import type { PromptbookServer_Prompt_AnonymousRequest } from '../remote-server/interfaces/PromptbookServer_Prompt_Request';
+import type { PromptbookServer_Prompt_Response } from '../remote-server/interfaces/PromptbookServer_Prompt_Response';
+import type { RemoteLlmExecutionToolsOptions } from '../remote-server/interfaces/RemoteLlmExecutionToolsOptions';
+import type { RemoteServerOptions } from '../remote-server/interfaces/RemoteServerOptions';
+import type { AnonymousRemoteServerOptions } from '../remote-server/interfaces/RemoteServerOptions';
+import type { ApplicationRemoteServerOptions } from '../remote-server/interfaces/RemoteServerOptions';
+import type { ApplicationRemoteServerClientOptions } from '../remote-server/interfaces/RemoteServerOptions';
 import type { Converter } from '../scrapers/_common/Converter';
 import type { ScraperAndConverterMetadata } from '../scrapers/_common/register/ScraperAndConverterMetadata';
 import type { ScraperConstructor } from '../scrapers/_common/register/ScraperConstructor';
@@ -143,6 +143,7 @@ import type { string_name } from '../types/typeAliases';
 import type { string_parameter_name } from '../types/typeAliases';
 import type { string_parameter_value } from '../types/typeAliases';
 import type { Parameters } from '../types/typeAliases';
+import type { InputParameters } from '../types/typeAliases';
 import type { string_reserved_parameter_name } from '../types/typeAliases';
 import type { ReservedParameters } from '../types/typeAliases';
 import type { string_title } from '../types/typeAliases';
@@ -171,6 +172,7 @@ import type { string_css_value } from '../types/typeAliases';
 import type { string_css_selector } from '../types/typeAliases';
 import type { string_url } from '../types/typeAliases';
 import type { string_base_url } from '../types/typeAliases';
+import type { string_pipeline_root_url } from '../types/typeAliases';
 import type { string_pipeline_url } from '../types/typeAliases';
 import type { string_pipeline_url_with_task_hash } from '../types/typeAliases';
 import type { string_data_url } from '../types/typeAliases';
@@ -324,21 +326,6 @@ export type { AzureOpenAiExecutionToolsOptions };
 export type { GoogleExecutionToolsOptions };
 export type { OpenAiAssistantExecutionToolsOptions };
 export type { OpenAiExecutionToolsOptions };
-export type { PromptbookServer_Error };
-export type { PromptbookServer_ListModels_Request };
-export type { PromptbookServer_ListModels_CollectionRequest };
-export type { PromptbookServer_ListModels_AnonymousRequest };
-export type { PromptbookServer_ListModels_Response };
-export type { PromptbookServer_Prompt_Progress };
-export type { PromptbookServer_Prompt_Request };
-export type { PromptbookServer_Prompt_CollectionRequest };
-export type { PromptbookServer_Prompt_AnonymousRequest };
-export type { PromptbookServer_Prompt_Response };
-export type { RemoteLlmExecutionToolsOptions };
-export type { RemoteServerOptions };
-export type { AnonymousRemoteServerOptions };
-export type { CollectionRemoteServerOptions };
-export type { CollectionRemoteServerClientOptions };
 export type { VercelExecutionToolsOptions };
 export type { VercelProvider };
 export type { IsPipelineImplementingInterfaceOptions };
@@ -366,6 +353,21 @@ export type { SimpleTaskJson };
 export type { TaskJson };
 export type { PipelineString };
 export type { PrepareAndScrapeOptions };
+export type { PromptbookServer_Error };
+export type { PromptbookServer_ListModels_Request };
+export type { PromptbookServer_ListModels_CollectionRequest };
+export type { PromptbookServer_ListModels_AnonymousRequest };
+export type { PromptbookServer_ListModels_Response };
+export type { PromptbookServer_Prompt_Progress };
+export type { PromptbookServer_Prompt_Request };
+export type { PromptbookServer_Prompt_CollectionRequest };
+export type { PromptbookServer_Prompt_AnonymousRequest };
+export type { PromptbookServer_Prompt_Response };
+export type { RemoteLlmExecutionToolsOptions };
+export type { RemoteServerOptions };
+export type { AnonymousRemoteServerOptions };
+export type { ApplicationRemoteServerOptions };
+export type { ApplicationRemoteServerClientOptions };
 export type { Converter };
 export type { ScraperAndConverterMetadata };
 export type { ScraperConstructor };
@@ -407,6 +409,7 @@ export type { string_name };
 export type { string_parameter_name };
 export type { string_parameter_value };
 export type { Parameters };
+export type { InputParameters };
 export type { string_reserved_parameter_name };
 export type { ReservedParameters };
 export type { string_title };
@@ -435,6 +438,7 @@ export type { string_css_value };
 export type { string_css_selector };
 export type { string_url };
 export type { string_base_url };
+export type { string_pipeline_root_url };
 export type { string_pipeline_url };
 export type { string_pipeline_url_with_task_hash };
 export type { string_data_url };

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

@@ -68,6 +68,7 @@ import { trimCodeBlock } from '../utils/trimCodeBlock';
 import { trimEndOfCodeBlock } from '../utils/trimEndOfCodeBlock';
 import { unwrapResult } from '../utils/unwrapResult';
 import { isValidEmail } from '../utils/validators/email/isValidEmail';
+import { isRootPath } from '../utils/validators/filePath/isRootPath';
 import { isValidFilePath } from '../utils/validators/filePath/isValidFilePath';
 import { isValidJavascriptName } from '../utils/validators/javascriptName/isValidJavascriptName';
 import { isValidPromptbookVersion } from '../utils/validators/semanticVersion/isValidPromptbookVersion';
@@ -147,6 +148,7 @@ export { trimCodeBlock };
 export { trimEndOfCodeBlock };
 export { unwrapResult };
 export { isValidEmail };
+export { isRootPath };
 export { isValidFilePath };
 export { isValidJavascriptName };
 export { isValidPromptbookVersion };

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

@@ -0,0 +1,44 @@
+import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
+import { _AnthropicClaudeMetadataRegistration } from '../llm-providers/anthropic-claude/register-configuration';
+import { _AnthropicClaudeRegistration } from '../llm-providers/anthropic-claude/register-constructor';
+import { _AzureOpenAiMetadataRegistration } from '../llm-providers/azure-openai/register-configuration';
+import { _AzureOpenAiRegistration } from '../llm-providers/azure-openai/register-constructor';
+import { _GoogleMetadataRegistration } from '../llm-providers/google/register-configuration';
+import { _GoogleRegistration } from '../llm-providers/google/register-constructor';
+import { _OpenAiMetadataRegistration } from '../llm-providers/openai/register-configuration';
+import { _OpenAiAssistantMetadataRegistration } from '../llm-providers/openai/register-configuration';
+import { _OpenAiRegistration } from '../llm-providers/openai/register-constructor';
+import { _OpenAiAssistantRegistration } from '../llm-providers/openai/register-constructor';
+import { _LegacyDocumentScraperRegistration } from '../scrapers/document-legacy/register-constructor';
+import { _LegacyDocumentScraperMetadataRegistration } from '../scrapers/document-legacy/register-metadata';
+import { _DocumentScraperRegistration } from '../scrapers/document/register-constructor';
+import { _DocumentScraperMetadataRegistration } from '../scrapers/document/register-metadata';
+import { _MarkdownScraperRegistration } from '../scrapers/markdown/register-constructor';
+import { _MarkdownScraperMetadataRegistration } from '../scrapers/markdown/register-metadata';
+import { _PdfScraperRegistration } from '../scrapers/pdf/register-constructor';
+import { _PdfScraperMetadataRegistration } from '../scrapers/pdf/register-metadata';
+import { _WebsiteScraperRegistration } from '../scrapers/website/register-constructor';
+import { _WebsiteScraperMetadataRegistration } from '../scrapers/website/register-metadata';
+import { wizzard } from '../wizzard/wizzard';
+export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
+export { _AnthropicClaudeMetadataRegistration };
+export { _AnthropicClaudeRegistration };
+export { _AzureOpenAiMetadataRegistration };
+export { _AzureOpenAiRegistration };
+export { _GoogleMetadataRegistration };
+export { _GoogleRegistration };
+export { _OpenAiMetadataRegistration };
+export { _OpenAiAssistantMetadataRegistration };
+export { _OpenAiRegistration };
+export { _OpenAiAssistantRegistration };
+export { _LegacyDocumentScraperRegistration };
+export { _LegacyDocumentScraperMetadataRegistration };
+export { _DocumentScraperRegistration };
+export { _DocumentScraperMetadataRegistration };
+export { _MarkdownScraperRegistration };
+export { _MarkdownScraperMetadataRegistration };
+export { _PdfScraperRegistration };
+export { _PdfScraperMetadataRegistration };
+export { _WebsiteScraperRegistration };
+export { _WebsiteScraperMetadataRegistration };
+export { wizzard };

package/esm/typings/src/cli/cli-commands/make.d.ts

@@ -6,7 +6,7 @@ import type { Command as Program } from 'commander';
  */
 export declare function initializeMakeCommand(program: Program): void;
 /**
- * TODO: [🥃][main] !!! Allow `ptbk make` without configuring any llm tools
+ * TODO: [🥃][main] !!3 Allow `ptbk make` without configuring any llm tools
  * TODO: [0] DRY Javascript and typescript - Maybe make ONLY typescript and for javascript just remove types
  * Note: [💞] Ignore a discrepancy between file name and entity name
  * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`

package/esm/typings/src/cli/cli-commands/run.d.ts

@@ -6,9 +6,9 @@ import type { Command as Program } from 'commander';
  */
 export declare function initializeRunCommand(program: Program): void;
 /**
- * TODO: !!!!! Catch and wrap all errors from CLI
+ * TODO: !!5 Catch and wrap all errors from CLI
  * TODO: [🧠] Pass `maxExecutionAttempts`, `csvSettings`
- * TODO: [🥃][main] !!! Allow `ptbk run` without configuring any llm tools
+ * TODO: [🥃][main] !!3 Allow `ptbk run` without configuring any llm tools
  * Note: [💞] Ignore a discrepancy between file name and entity name
  * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
  * TODO: [🖇] What about symlinks? Maybe flag --follow-symlinks

package/esm/typings/src/collection/constructors/createCollectionFromDirectory.d.ts

@@ -1,6 +1,7 @@
 import type { ExecutionTools } from '../../execution/ExecutionTools';
 import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
 import type { string_dirname } from '../../types/typeAliases';
+import type { string_pipeline_root_url } from '../../types/typeAliases';
 import type { PipelineCollection } from '../PipelineCollection';
 /**
  * Options for `createCollectionFromDirectory` function
@@ -21,6 +22,16 @@ type CreatePipelineCollectionFromDirectoryOptions = Omit<PrepareAndScrapeOptions
      * @default false
      */
     isVerbose?: boolean;
+    /**
+     * This will be used as a root URL for all pipelines in the collection
+     *
+     * It has 2 purposes:
+     * 1) Every pipeline in the collection is checked if it is a child of `rootUrl`
+     * 2) If the pipeline does not have a URL, it is created from the `rootUrl` and path to the pipeline
+     *
+     * @default false
+     */
+    rootUrl?: string_pipeline_root_url;
     /**
      * If true, directory will be scanned only when needed not during the construction
      *

package/esm/typings/src/collection/constructors/createCollectionFromUrl.d.ts

@@ -25,5 +25,5 @@ type CreatePipelineCollectionFromUrlyOptions = {
 export declare function createCollectionFromUrl(url: string_url | URL, options: CreatePipelineCollectionFromUrlyOptions): Promise<PipelineCollection>;
 export {};
 /**
- * TODO: [main] !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
+ * TODO: [main] !!4 [🧠] Library precompilation and do not mix markdown and json promptbooks
  */

package/esm/typings/src/commands/index.d.ts

@@ -6,4 +6,4 @@
 export declare const COMMANDS: readonly [import("./_common/types/CommandParser").PipelineTaskCommandParser<import("./SECTION/SectionCommand").SectionCommand>, import("./_common/types/CommandParser").PipelineTaskCommandParser<import("./EXPECT/ExpectCommand").ExpectCommand>, import("./_common/types/CommandParser").PipelineTaskCommandParser<import("./FORMAT/FormatCommand").FormatCommand>, import("./_common/types/CommandParser").PipelineTaskCommandParser<import("./JOKER/JokerCommand").JokerCommand>, import("./_common/types/CommandParser").PipelineBothCommandParser<import("./MODEL/ModelCommand").ModelCommand>, import("./_common/types/CommandParser").PipelineBothCommandParser<import("./PARAMETER/ParameterCommand").ParameterCommand>, import("./_common/types/CommandParser").PipelineTaskCommandParser<import("./POSTPROCESS/PostprocessCommand").PostprocessCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./BOOK_VERSION/BookVersionCommand").BookVersionCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./FORMFACTOR/FormfactorCommand").FormfactorCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./URL/UrlCommand").UrlCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./KNOWLEDGE/KnowledgeCommand").KnowledgeCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./X_ACTION/ActionCommand").ActionCommand>, import("./_common/types/CommandParser").PipelineHeadCommandParser<import("./X_INSTRUMENT/InstrumentCommand").InstrumentCommand>, import("./_common/types/CommandParser").PipelineBothCommandParser<import("./PERSONA/PersonaCommand").PersonaCommand>, import("./_common/types/CommandParser").PipelineTaskCommandParser<import("./FOREACH/ForeachCommand").ForeachCommand>, import("./_common/types/CommandParser").PipelineBothCommandParser<import("./_BOILERPLATE/BoilerplateCommand").BoilerplateCommand>];
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name
- */ 
+ */

package/esm/typings/src/config.d.ts

@@ -58,7 +58,7 @@ export declare const LOGO_DARK_SRC: string_url_image;
  *
  * @public exported from `@promptbook/core`
  */
-export declare const DEFAULT_TITLE = "Untitled";
+export declare const DEFAULT_BOOK_TITLE = "\u2728 Untitled Book";
 /**
  * Warning message for the generated sections and files files
  *
@@ -141,14 +141,14 @@ export declare const DEFAULT_MAX_PARALLEL_COUNT = 5;
 export declare const DEFAULT_MAX_EXECUTION_ATTEMPTS = 3;
 /**
  * @@@
- * TODO: [🐝][main] !!! Use
+ * TODO: [🐝][main] !!3 Use
  *
  * @public exported from `@promptbook/core`
  */
 export declare const DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH = 3;
 /**
  * @@@
- * TODO: [🐝][main] !!! Use
+ * TODO: [🐝][main] !!3 Use
  *
  * @public exported from `@promptbook/core`
  */

package/esm/typings/src/conversion/compilePipeline.d.ts

@@ -5,10 +5,7 @@ import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions
 /**
  * Compile pipeline from string (markdown) format to JSON format
  *
- * Note: There are 3 similar functions:
- * - `compilePipeline` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
- * - `precompilePipeline` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
- * - `preparePipeline` - just one step in the compilation process
+ * @see https://github.com/webgptorg/promptbook/discussions/196
  *
  * Note: This function does not validate logic of the pipeline only the parsing
  * Note: This function acts as compilation process

package/esm/typings/src/conversion/compilePipelineOnRemoteServer.d.ts

@@ -0,0 +1,18 @@
+import type { RemoteServerOptions } from '../remote-server/interfaces/RemoteServerOptions';
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
+import type { PipelineString } from '../pipeline/PipelineString';
+/**
+ * Compile pipeline from string (markdown) format to JSON format
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/196
+ *
+ * Note: This function does not validate logic of the pipeline only the parsing
+ * Note: This function acts as compilation process
+ *
+ * @param pipelineString {Promptbook} in string markdown format (.book.md)
+ * @param options - Options for remote server compilation
+ * @returns {Promptbook} compiled in JSON format (.book.json)
+ * @throws {ParseError} if the promptbook string is not valid
+ * @public exported from `@promptbook/remote-client`
+ */
+export declare function compilePipelineOnRemoteServer<TCustomOptions = undefined>(pipelineString: PipelineString, options: RemoteServerOptions<TCustomOptions>): Promise<PipelineJson>;

package/esm/typings/src/conversion/{precompilePipeline.d.ts → parsePipeline.d.ts}

@@ -5,7 +5,7 @@ import type { PipelineString } from '../pipeline/PipelineString';
  *
  * Note: There are 3 similar functions:
  * - `compilePipeline` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
- * - `precompilePipeline` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
+ * - `parsePipeline` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
  * - `preparePipeline` - just one step in the compilation process
  *
  * Note: This function does not validate logic of the pipeline only the parsing
@@ -16,10 +16,10 @@ import type { PipelineString } from '../pipeline/PipelineString';
  * @throws {ParseError} if the promptbook string is not valid
  * @public exported from `@promptbook/core`
  */
-export declare function precompilePipeline(pipelineString: PipelineString): PipelineJson;
+export declare function parsePipeline(pipelineString: PipelineString): PipelineJson;
 /**
  * TODO: [🧠] Maybe more things here can be refactored as high-level abstractions
- * TODO: [main] !!!! Warn if used only sync version
+ * TODO: [main] !!4 Warn if used only sync version
  * TODO: [🚞] Report here line/column of error
  * TODO: Use spaceTrim more effectively
  * TODO: [🧠] Parameter flags - isInput, isOutput, isInternal

package/esm/typings/src/conversion/prettify/renderPipelineMermaidOptions.d.ts

@@ -22,9 +22,9 @@ export type renderPipelineMermaidOptions = {
  */
 export declare function renderPromptbookMermaid(pipelineJson: PipelineJson, options?: renderPipelineMermaidOptions): string;
 /**
- * TODO: [🧠] !! FOREACH in mermaid graph
- * TODO: [🧠] !! Knowledge in mermaid graph
- * TODO: [🧠] !! Personas in mermaid graph
+ * TODO: [🧠] FOREACH in mermaid graph
+ * TODO: [🧠] Knowledge in mermaid graph
+ * TODO: [🧠] Personas in mermaid graph
  * TODO: Maybe use some Mermaid package instead of string templating
  * TODO: [🕌] When more than 2 functionalities, split into separate functions
  */

package/esm/typings/src/conversion/validation/validatePipeline.d.ts

@@ -18,9 +18,9 @@ export declare function validatePipeline(pipeline: PipelineJson): PipelineJson;
 /**
  * @private internal function for `validatePipeline`
  */
-export declare function validatePipelineCore(pipeline: PipelineJson): void;
+export declare function validatePipeline_InnerFunction(pipeline: PipelineJson): void;
 /**
- * TODO: !! [🧞‍♀️] Do not allow joker + foreach
+ * TODO: [🧞‍♀️] Do not allow joker + foreach
  * TODO: [🧠] Work with promptbookVersion
  * TODO: Use here some json-schema, Zod or something similar and change it to:
  *     > /**
@@ -32,11 +32,11 @@ export declare function validatePipelineCore(pipeline: PipelineJson): void;
  *     >  ex port function validatePipeline(promptbook: really_unknown): asserts promptbook is PipelineJson {
  */
 /**
- * TODO: [🧳][main] !!!! Validate that all examples match expectations
- * TODO: [🧳][🐝][main] !!!! Validate that knowledge is valid (non-void)
- * TODO: [🧳][main] !!!! Validate that persona can be used only with CHAT variant
- * TODO: [🧳][main] !!!! Validate that parameter with reserved name not used RESERVED_PARAMETER_NAMES
- * TODO: [🧳][main] !!!! Validate that reserved parameter is not used as joker
+ * TODO: [🧳][main] !!4 Validate that all examples match expectations
+ * TODO: [🧳][🐝][main] !!4 Validate that knowledge is valid (non-void)
+ * TODO: [🧳][main] !!4 Validate that persona can be used only with CHAT variant
+ * TODO: [🧳][main] !!4 Validate that parameter with reserved name not used RESERVED_PARAMETER_NAMES
+ * TODO: [🧳][main] !!4 Validate that reserved parameter is not used as joker
  * TODO: [🧠] Validation not only logic itself but imports around - files and websites and rerefenced pipelines exists
  * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
  */

package/esm/typings/src/errors/utils/getErrorReportUrl.d.ts

@@ -1,6 +1,6 @@
 /**
  * Make error report URL for the given error
  *
- * @private !!!!!!
+ * @private private within the repository
  */
 export declare function getErrorReportUrl(error: Error): URL;

package/esm/typings/src/execution/PipelineExecutor.d.ts

@@ -1,6 +1,6 @@
 import type { Promisable } from 'type-fest';
 import type { TaskProgress } from '../types/TaskProgress';
-import type { Parameters } from '../types/typeAliases';
+import type { InputParameters } from '../types/typeAliases';
 import type { PipelineExecutorResult } from './PipelineExecutorResult';
 /**
  * Executor is a simple async function that takes INPUT  PARAMETERs and returns result parameters _(along with all intermediate parameters and INPUT  PARAMETERs = it extends input object)_.
@@ -11,7 +11,7 @@ import type { PipelineExecutorResult } from './PipelineExecutorResult';
  * @see https://github.com/webgptorg/promptbook#executor
  */
 export type PipelineExecutor = {
-    (inputParameters: Parameters, onProgress?: (taskProgress: TaskProgress) => Promisable<void>): Promise<PipelineExecutorResult>;
+    (inputParameters: InputParameters, onProgress?: (taskProgress: TaskProgress) => Promisable<void>): Promise<PipelineExecutorResult>;
 };
 /**
  * TODO: [🐚] Change onProgress to object that represents the running execution, can be subscribed via RxJS to and also awaited

package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts

@@ -1,7 +1,7 @@
 import type { Promisable, ReadonlyDeep } from 'type-fest';
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { TaskProgress } from '../../types/TaskProgress';
-import type { Parameters } from '../../types/typeAliases';
+import type { InputParameters } from '../../types/typeAliases';
 import type { PipelineExecutorResult } from '../PipelineExecutorResult';
 import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
 /**
@@ -13,7 +13,7 @@ type ExecutePipelineOptions = Required<CreatePipelineExecutorOptions> & {
     /**
      * @@@
      */
-    readonly inputParameters: Readonly<Parameters>;
+    readonly inputParameters: Readonly<InputParameters>;
     /**
      * @@@
      */

package/esm/typings/src/formfactors/generator/GeneratorFormfactorDefinition.d.ts

@@ -5,15 +5,20 @@
  */
 export declare const GeneratorFormfactorDefinition: {
     readonly name: "GENERATOR";
-    readonly description: "@@@";
+    readonly description: "Generates any kind (in HTML with possible scripts and css format) of content from input message";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/184";
     readonly pipelineInterface: {
         readonly inputParameters: readonly [{
-            readonly name: "nonce";
-            readonly description: "Just to prevent GENERATOR to be set as implicit formfactor";
+            readonly name: "inputMessage";
+            readonly description: "Input message to be image made from";
             readonly isInput: true;
             readonly isOutput: false;
         }];
-        readonly outputParameters: readonly [];
+        readonly outputParameters: readonly [{
+            readonly name: "result";
+            readonly description: "Result in HTML to be shown to user";
+            readonly isInput: false;
+            readonly isOutput: true;
+        }];
     };
 };

package/esm/typings/src/formfactors/image-generator/ImageGeneratorFormfactorDefinition.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Image generator is form of app that generates image from input message
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const ImageGeneratorFormfactorDefinition: {
+    readonly name: "IMAGE_GENERATOR";
+    readonly description: "Generates prompt for image generation from input message";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/184";
+    readonly pipelineInterface: {
+        readonly inputParameters: readonly [{
+            readonly name: "inputMessage";
+            readonly description: "Input message to be image made from";
+            readonly isInput: true;
+            readonly isOutput: false;
+        }];
+        readonly outputParameters: readonly [{
+            readonly name: "prompt";
+            readonly description: "Prompt to be used for image generation";
+            readonly isInput: false;
+            readonly isOutput: true;
+        }];
+    };
+};

package/esm/typings/src/formfactors/index.d.ts

@@ -19,11 +19,7 @@ export declare const FORMFACTOR_DEFINITIONS: readonly [{
     readonly pipelineInterface: {
         readonly inputParameters: readonly [{
             readonly name: "previousTitle";
-            readonly description: "Previous title of the conversation"; /**
-             * All available formfactor definitions
-             *
-             * @public exported from `@promptbook/core`
-             */
+            readonly description: "Previous title of the conversation";
             readonly isInput: true;
             readonly isOutput: false;
         }, {
@@ -40,6 +36,9 @@ export declare const FORMFACTOR_DEFINITIONS: readonly [{
         readonly outputParameters: readonly [{
             readonly name: "title";
             readonly description: "Title of the conversation";
+            /**
+             * Note: [💞] Ignore a discrepancy between file name and entity name
+             */
             readonly isInput: false;
             readonly isOutput: true;
         }, {
@@ -106,16 +105,39 @@ export declare const FORMFACTOR_DEFINITIONS: readonly [{
     };
 }, {
     readonly name: "GENERATOR";
-    readonly description: "@@@";
+    readonly description: "Generates any kind (in HTML with possible scripts and css format) of content from input message";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/184";
     readonly pipelineInterface: {
         readonly inputParameters: readonly [{
-            readonly name: "nonce";
-            readonly description: "Just to prevent GENERATOR to be set as implicit formfactor";
+            readonly name: "inputMessage";
+            readonly description: "Input message to be image made from";
             readonly isInput: true;
             readonly isOutput: false;
         }];
-        readonly outputParameters: readonly [];
+        readonly outputParameters: readonly [{
+            readonly name: "result";
+            readonly description: "Result in HTML to be shown to user";
+            readonly isInput: false;
+            readonly isOutput: true;
+        }];
+    };
+}, {
+    readonly name: "IMAGE_GENERATOR";
+    readonly description: "Generates prompt for image generation from input message";
+    readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/184";
+    readonly pipelineInterface: {
+        readonly inputParameters: readonly [{
+            readonly name: "inputMessage";
+            readonly description: "Input message to be image made from";
+            readonly isInput: true;
+            readonly isOutput: false;
+        }];
+        readonly outputParameters: readonly [{
+            readonly name: "prompt";
+            readonly description: "Prompt to be used for image generation";
+            readonly isInput: false;
+            readonly isOutput: true;
+        }];
     };
 }];
 /**

package/esm/typings/src/high-level-abstractions/_common/HighLevelAbstraction.d.ts

@@ -1,6 +1,6 @@
 import type { $PipelineJson } from '../../commands/_common/types/CommandParser';
 /**
- * Used in `precompilePipeline`
+ * Used in `parsePipeline`
  *
  * @private
  */

package/esm/typings/src/high-level-abstractions/index.d.ts

@@ -1,7 +1,7 @@
 /**
  * All high-level abstractions
  *
- * @private internal index of `precompilePipeline` (= used for sync) and `preparePipeline` (= used for async)
+ * @private internal index of `parsePipeline` (= used for sync) and `preparePipeline` (= used for async)
  */
 export declare const HIGH_LEVEL_ABSTRACTIONS: readonly [{
     type: "SYNC";
@@ -23,7 +23,7 @@ export declare const HIGH_LEVEL_ABSTRACTIONS: readonly [{
             path: string | null;
             content: import("../pipeline/PipelineString").PipelineString;
         }[];
-        readonly formfactorName?: "CHATBOT" | "GENERATOR" | "GENERIC" | "EXPERIMENTAL_MATCHER" | "SHEETS" | "TRANSLATOR" | undefined;
+        readonly formfactorName?: "CHATBOT" | "GENERATOR" | "GENERIC" | "IMAGE_GENERATOR" | "EXPERIMENTAL_MATCHER" | "SHEETS" | "TRANSLATOR" | undefined;
     }>): void;
 }, {
     type: "SYNC";
@@ -45,7 +45,7 @@ export declare const HIGH_LEVEL_ABSTRACTIONS: readonly [{
             path: string | null;
             content: import("../pipeline/PipelineString").PipelineString;
         }[];
-        readonly formfactorName?: "CHATBOT" | "GENERATOR" | "GENERIC" | "EXPERIMENTAL_MATCHER" | "SHEETS" | "TRANSLATOR" | undefined;
+        readonly formfactorName?: "CHATBOT" | "GENERATOR" | "GENERIC" | "IMAGE_GENERATOR" | "EXPERIMENTAL_MATCHER" | "SHEETS" | "TRANSLATOR" | undefined;
     }>): void;
 }];
 /**

package/esm/typings/src/high-level-abstractions/quick-chatbot/QuickChatbotHla.d.ts

@@ -8,3 +8,6 @@ export declare const QuickChatbotHla: {
     type: "SYNC";
     $applyToPipelineJson($pipelineJson: $PipelineJson): void;
 };
+/**
+ * TODO: [🧠][📛] Should this be here?
+ */

package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsConfigurationFromEnv.d.ts

@@ -12,7 +12,7 @@ import type { LlmToolsConfiguration } from './LlmToolsConfiguration';
  * @returns @@@
  * @public exported from `@promptbook/node`
  */
-export declare function $provideLlmToolsConfigurationFromEnv(): LlmToolsConfiguration;
+export declare function $provideLlmToolsConfigurationFromEnv(): Promise<LlmToolsConfiguration>;
 /**
  * TODO: [🧠][🪁] Maybe do allow to do auto-install if package not registered and not found
  * TODO: Add Azure OpenAI

package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForTestingAndScriptsAndPlayground.d.ts

@@ -14,7 +14,7 @@ type GetLlmToolsForTestingAndScriptsAndPlaygroundOptions = CreateLlmToolsFromCon
  *
  * @private within the repository - JUST FOR TESTS, SCRIPTS AND PLAYGROUND
  */
-export declare function $provideLlmToolsForTestingAndScriptsAndPlayground(options?: GetLlmToolsForTestingAndScriptsAndPlaygroundOptions): LlmExecutionToolsWithTotalUsage;
+export declare function $provideLlmToolsForTestingAndScriptsAndPlayground(options?: GetLlmToolsForTestingAndScriptsAndPlaygroundOptions): Promise<LlmExecutionToolsWithTotalUsage>;
 export {};
 /**
  * Note: [⚪] This should never be in any released package

package/esm/typings/src/llm-providers/_common/register/{$provideLlmToolsForCli.d.ts → $provideLlmToolsForWizzardOrCli.d.ts}

@@ -5,9 +5,9 @@ import type { LlmExecutionToolsWithTotalUsage } from '../utils/count-total-usage
  *
  * @private within the repository - for CLI utils
  */
-export declare function $provideLlmToolsForCli(options?: Pick<CacheLlmToolsOptions, 'isCacheReloaded'>): LlmExecutionToolsWithTotalUsage;
+export declare function $provideLlmToolsForWizzardOrCli(options?: Pick<CacheLlmToolsOptions, 'isCacheReloaded'>): Promise<LlmExecutionToolsWithTotalUsage>;
 /**
- * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
  * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
  * TODO: [🥃] Allow `ptbk make` without llm tools
  * TODO: This should be maybe not under `_common` but under `utils-internal` / `utils/internal`

package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsFromEnv.d.ts

@@ -15,7 +15,7 @@ import type { CreateLlmToolsFromConfigurationOptions } from './createLlmToolsFro
  * @returns @@@
  * @public exported from `@promptbook/node`
  */
-export declare function $provideLlmToolsFromEnv(options?: CreateLlmToolsFromConfigurationOptions): MultipleLlmExecutionTools;
+export declare function $provideLlmToolsFromEnv(options?: CreateLlmToolsFromConfigurationOptions): Promise<MultipleLlmExecutionTools>;
 /**
  * TODO: @@@ write `$provideLlmToolsFromEnv` vs `$provideLlmToolsConfigurationFromEnv` vs `createLlmToolsFromConfiguration`
  * TODO: [🧠][🍛] Which name is better `$provideLlmToolsFromEnv` or `$provideLlmToolsFromEnvironment`?