@promptbook/remote-client 0.81.0-9 → 0.81.0

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/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`?

package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts

@@ -16,7 +16,7 @@ export declare const ANTHROPIC_CLAUDE_MODELS: ReadonlyArray<AvailableModel & {
 }>;
 /**
  * Note: [🤖] Add models of new variant
- * TODO: [🧠][main] !!! Add embedding models OR Anthropic has only chat+completion models?
+ * TODO: [🧠][main] !!3 Add embedding models OR Anthropic has only chat+completion models?
  * TODO: [🧠] Some mechanism to propagate unsureness
  * TODO: [🧠][👮‍♀️] Put here more info like description, isVision, trainingDateCutoff, languages, strengths (	Top-level performance, intelligence, fluency, and understanding), contextWindow,...
  * TODO: [🎰] Some mechanism to auto-update available models

package/esm/typings/src/llm-providers/anthropic-claude/createAnthropicClaudeExecutionTools.d.ts

@@ -11,8 +11,8 @@ export declare const createAnthropicClaudeExecutionTools: ((options: AnthropicCl
     className: string;
 };
 /**
- * TODO: [🧠][main] !!!! Make anonymous this with all LLM providers
- * TODO: [🧠][🧱][main] !!!! Maybe change all `new AnthropicClaudeExecutionTools` -> `createAnthropicClaudeExecutionTools` in manual
+ * TODO: [🧠][main] !!4 Make anonymous this with all LLM providers
+ * TODO: [🧠][🧱][main] !!4 Maybe change all `new AnthropicClaudeExecutionTools` -> `createAnthropicClaudeExecutionTools` in manual
  * TODO: [🧠] Maybe auto-detect usage in browser and determine default value of `isProxied`
  * TODO: [🦺] Is there some way how to put `packageName` and `className` on top and function definition on bottom?
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"

package/esm/typings/src/llm-providers/anthropic-claude/playground/playground.d.ts

@@ -1,7 +1,7 @@
 #!/usr/bin/env ts-node
 export {};
 /**
- * TODO: [main] !!! Playground with WebGPT / Promptbook.studio anonymous server
- * TODO: [main] !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
+ * TODO: [main] !!3 Playground with WebGPT / Promptbook.studio anonymous server
+ * TODO: [main] !!3 Test here that `systemMessage`, `temperature` and `seed` are working correctly
  * Note: [⚫] Code in this file should never be published in any package
  */

package/esm/typings/src/llm-providers/anthropic-claude/register-configuration.d.ts

@@ -5,6 +5,7 @@ import type { Registration } from '../../utils/$Register';
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
  *
  * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/wizzard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _AnthropicClaudeMetadataRegistration: Registration;

package/esm/typings/src/llm-providers/anthropic-claude/register-constructor.d.ts

@@ -5,7 +5,9 @@ import type { Registration } from '../../utils/$Register';
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
  *
  * @public exported from `@promptbook/anthropic-claude`
+ * @public exported from `@promptbook/wizzard`
  * @public exported from `@promptbook/cli`
+ *
  */
 export declare const _AnthropicClaudeRegistration: Registration;
 /**

package/esm/typings/src/llm-providers/azure-openai/register-configuration.d.ts

@@ -5,6 +5,7 @@ import type { Registration } from '../../utils/$Register';
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
  *
  * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/wizzard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _AzureOpenAiMetadataRegistration: Registration;

package/esm/typings/src/llm-providers/azure-openai/register-constructor.d.ts

@@ -5,6 +5,7 @@ import type { Registration } from '../../utils/$Register';
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
  *
  * @public exported from `@promptbook/azure-openai`
+ * @public exported from `@promptbook/wizzard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _AzureOpenAiRegistration: Registration;

package/esm/typings/src/llm-providers/google/register-configuration.d.ts

@@ -5,6 +5,7 @@ import type { Registration } from '../../utils/$Register';
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
  *
  * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/wizzard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _GoogleMetadataRegistration: Registration;

package/esm/typings/src/llm-providers/google/register-constructor.d.ts

@@ -5,6 +5,7 @@ import type { Registration } from '../../utils/$Register';
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
  *
  * @public exported from `@promptbook/google`
+ * @public exported from `@promptbook/wizzard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _GoogleRegistration: Registration;

package/esm/typings/src/llm-providers/openai/playground/playground.d.ts

@@ -1,6 +1,6 @@
 #!/usr/bin/env ts-node
 export {};
 /**
- * TODO: [main] !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
+ * TODO: [main] !!3 Test here that `systemMessage`, `temperature` and `seed` are working correctly
  * Note: [⚫] Code in this file should never be published in any package
  */

package/esm/typings/src/llm-providers/openai/register-configuration.d.ts

@@ -5,6 +5,7 @@ import type { Registration } from '../../utils/$Register';
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
  *
  * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/wizzard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _OpenAiMetadataRegistration: Registration;
@@ -14,6 +15,7 @@ export declare const _OpenAiMetadataRegistration: Registration;
  * Note: [🏐] Configurations registrations are done in @@@ BUT constructor @@@
  *
  * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/wizzard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _OpenAiAssistantMetadataRegistration: Registration;

package/esm/typings/src/llm-providers/openai/register-constructor.d.ts

@@ -5,6 +5,7 @@ import type { Registration } from '../../utils/$Register';
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
  *
  * @public exported from `@promptbook/openai`
+ * @public exported from `@promptbook/wizzard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _OpenAiRegistration: Registration;
@@ -14,6 +15,7 @@ export declare const _OpenAiRegistration: Registration;
  * Note: [🏐] Configurations registrations are done in @@@ BUT constructor @@@
  *
  * @public exported from `@promptbook/openai`
+ * @public exported from `@promptbook/wizzard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _OpenAiAssistantRegistration: Registration;

package/esm/typings/src/llm-providers/vercel/playground/playground.d.ts

@@ -1,6 +1,6 @@
 #!/usr/bin/env ts-node
 export {};
 /**
- * TODO: [main] !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
+ * TODO: [main] !!3 Test here that `systemMessage`, `temperature` and `seed` are working correctly
  * Note: [⚫] Code in this file should never be published in any package
  */

package/esm/typings/src/other/templates/getBookTemplates.d.ts

@@ -0,0 +1,22 @@
+import type { string_formfactor_name } from '../../formfactors/_common/string_formfactor_name';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+/**
+ * @@@
+ *
+ * @singleton
+ * @private internal cache of `getBookTemplate`
+ */
+export declare let pipelines: Array<PipelineJson> | null;
+/**
+ * Get template for new book
+ *
+ * @param formfactorName - optional filter for FORMFACTOR - get only pipelines for this formfactor
+ * @returns list of pipelines
+ * @public exported from `@promptbook/templates`
+ */
+export declare function getBookTemplates(formfactorName?: string_formfactor_name): ReadonlyArray<PipelineJson>;
+/**
+ * TODO: Unit test
+ * TODO: [🧠] Which is the best place for this function
+ * TODO: !!6 For GENERIC template ensure at least one pipeline is present for typescript in `getBookTemplates`
+ */

package/esm/typings/src/personas/preparePersona.d.ts

@@ -10,8 +10,8 @@ import type { string_persona_description } from '../types/typeAliases';
  */
 export declare function preparePersona(personaDescription: string_persona_description, tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions): Promise<PersonaPreparedJson['modelRequirements']>;
 /**
- * TODO: [🔃][main] !! If the persona was prepared with different version or different set of models, prepare it once again
- * TODO: [🏢] !! Check validity of `modelName` in pipeline
- * TODO: [🏢] !! Check validity of `systemMessage` in pipeline
- * TODO: [🏢] !! Check validity of `temperature` in pipeline
+ * TODO: [🔃][main] If the persona was prepared with different version or different set of models, prepare it once again
+ * TODO: [🏢] Check validity of `modelName` in pipeline
+ * TODO: [🏢] Check validity of `systemMessage` in pipeline
+ * TODO: [🏢] Check validity of `temperature` in pipeline
  */

package/esm/typings/src/pipeline/PipelineString.d.ts

@@ -7,6 +7,3 @@
 export type PipelineString = string & {
     readonly _type: 'Promptbook';
 };
-/**
- * TODO: [💩] Better validation (validatePipelineString) or remove branded type and make it just string
- */

package/esm/typings/src/pipeline/book-notation.d.ts

@@ -0,0 +1,14 @@
+import type { PipelineString } from './PipelineString';
+/**
+ * Tag function for notating a pipeline with a book\`...\ notation as template literal
+ *
+ * @param strings @@@
+ * @param values @@@
+ * @returns the pipeline string
+ * @public exported from `@promptbook/core`
+ */
+export declare function book(strings: TemplateStringsArray, ...values: Array<string>): PipelineString;
+/**
+ * TODO: [🧠][🈴] Where is the best location for this file
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/pipeline/isValidPipelineString.d.ts

@@ -0,0 +1,13 @@
+import type { PipelineString } from './PipelineString';
+/**
+ * Function `isValidPipelineString` will validate the if the string is a valid pipeline string
+ * It does not check if the string is fully logically correct, but if it is a string that can be a pipeline string or the string looks completely different.
+ *
+ * @param {string} pipelineString the candidate for a pipeline string
+ * @returns {boolean} if the string is a valid pipeline string
+ * @public exported from `@promptbook/core`
+ */
+export declare function isValidPipelineString(pipelineString: string): pipelineString is PipelineString;
+/**
+ * TODO: [🧠][🈴] Where is the best location for this file
+ */

package/esm/typings/src/pipeline/isValidPipelineString.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🧠][🈴] Where is the best location for this file
+ */

package/esm/typings/src/pipeline/validatePipelineString.d.ts

@@ -0,0 +1,14 @@
+import type { PipelineString } from './PipelineString';
+/**
+ * Function `validatePipelineString` will validate the if the string is a valid pipeline string
+ * It does not check if the string is fully logically correct, but if it is a string that can be a pipeline string or the string looks completely different.
+ *
+ * @param {string} pipelineString the candidate for a pipeline string
+ * @returns {PipelineString} the same string as input, but validated as valid
+ * @throws {ParseError} if the string is not a valid pipeline string
+ * @public exported from `@promptbook/core`
+ */
+export declare function validatePipelineString(pipelineString: string): PipelineString;
+/**
+ * TODO: [🧠][🈴] Where is the best location for this file
+ */

package/esm/typings/src/prepare/isPipelinePrepared.d.ts

@@ -2,11 +2,13 @@ import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
 /**
  * Determine if the pipeline is fully prepared
  *
+ * @see https://github.com/webgptorg/promptbook/discussions/196
+ *
  * @public exported from `@promptbook/core`
  */
 export declare function isPipelinePrepared(pipeline: PipelineJson): boolean;
 /**
- * TODO: [🔃][main] !! If the pipeline was prepared with different version or different set of models, prepare it once again
+ * TODO: [🔃][main] If the pipeline was prepared with different version or different set of models, prepare it once again
  * TODO: [🐠] Maybe base this on `makeValidator`
  * TODO: [🧊] Pipeline can be partially prepared, this should return true ONLY if fully prepared
  * TODO: [🧿] Maybe do same process with same granularity and subfinctions as `preparePipeline`

package/esm/typings/src/prepare/preparePipeline.d.ts

@@ -4,6 +4,8 @@ import type { PrepareAndScrapeOptions } from './PrepareAndScrapeOptions';
 /**
  * Prepare 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
  * Note: This function acts as part of compilation process
  * Note: When the pipeline is already prepared, it returns the same pipeline

package/esm/typings/src/prepare/prepareTasks.d.ts

@@ -25,7 +25,7 @@ export {};
  * TODO: [😂] Adding knowledge should be convert to async high-level abstractions, simmilar thing with expectations to sync high-level abstractions
  * TODO: [🧠] Add context to each task (if missing)
  * TODO: [🧠] What is better name `prepareTask` or `prepareTaskAndParameters`
- * TODO: [♨][main] !!! Prepare index the examples and maybe tasks
+ * TODO: [♨][main] !!3 Prepare index the examples and maybe tasks
  * TODO: Write tests for `preparePipeline`
  * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
  * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time

package/esm/typings/src/scrapers/_common/Converter.d.ts

@@ -4,6 +4,7 @@ import type { ScraperIntermediateSource } from './ScraperIntermediateSource';
 /**
  * @@@
  *
+ * Note: [🌏] Converters are not usable in browser because they produce a files
  */
 export type Converter = {
     /**

package/esm/typings/src/scrapers/_common/Scraper.d.ts

@@ -7,7 +7,6 @@ import type { string_url } from '../../types/typeAliases';
 import type { ScraperAndConverterMetadata } from './register/ScraperAndConverterMetadata';
 /**
  * @@@
- *
  */
 export type Scraper = {
     /**
@@ -53,6 +52,7 @@ export type ScraperSourceHandler = {
     asText(): Promisable<string>;
 };
 /**
+ * TODO: [🧠] Maybe split `ScraperSourceHandler` into `ScraperWebsiteSourceHandler` + `ScraperFileSourceHandler`
  * TODO: [🥽] Add ` asBlob(): Promisable<Blob>;` or asFile
  * TODO: [🐝] @@@ Annotate all
  * TODO: [🔼] Export via types

package/esm/typings/src/scrapers/_common/ScraperIntermediateSource.d.ts

@@ -9,3 +9,6 @@ export type ScraperIntermediateSource = IDestroyable & {
      */
     readonly filename: string_absolute_filename;
 };
+/**
+ * Note: [🌏] Converters can be used only in node because they uses `ScraperIntermediateSource` which  uses file system
+ */

package/esm/typings/src/scrapers/_common/register/ScraperAndConverterMetadata.d.ts

@@ -28,6 +28,8 @@ export type ScraperAndConverterMetadata = Registered & {
     readonly mimeTypes: ReadonlyArray<string_mime_type>;
     /**
      * @@@
+     *
+     * Note: [🌏] Only `MarkdownScraper` makes sense to be available in the browser, for scraping non-markdown sources in the browser use a remote server
      */
     readonly isAvilableInBrowser: boolean;
     /**

package/esm/typings/src/scrapers/_common/utils/scraperFetch.d.ts

@@ -5,3 +5,6 @@ import type { PromptbookFetch } from '../../../execution/PromptbookFetch';
  * @private as default `fetch` function used in Promptbook scrapers
  */
 export declare const scraperFetch: PromptbookFetch;
+/**
+ * TODO: [🧠] Maybe rename because it is not used only for scrapers but also in `$getCompiledBook`
+ */

package/esm/typings/src/scrapers/document/register-constructor.d.ts

@@ -5,6 +5,7 @@ import type { Registration } from '../../utils/$Register';
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
  *
  * @public exported from `@promptbook/documents`
+ * @public exported from `@promptbook/wizzard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _DocumentScraperRegistration: Registration;

package/esm/typings/src/scrapers/document/register-metadata.d.ts

@@ -19,6 +19,7 @@ export declare const documentScraperMetadata: import("type-fest/source/readonly-
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
  *
  * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/wizzard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _DocumentScraperMetadataRegistration: Registration;

package/esm/typings/src/scrapers/document-legacy/register-constructor.d.ts

@@ -5,6 +5,7 @@ import type { Registration } from '../../utils/$Register';
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
  *
  * @public exported from `@promptbook/legacy-documents`
+ * @public exported from `@promptbook/wizzard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _LegacyDocumentScraperRegistration: Registration;

package/esm/typings/src/scrapers/document-legacy/register-metadata.d.ts

@@ -19,6 +19,7 @@ export declare const legacyDocumentScraperMetadata: import("type-fest/source/rea
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
  *
  * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/wizzard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _LegacyDocumentScraperMetadataRegistration: Registration;