@promptbook/javascript 0.112.0-34 → 0.112.0-36

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

@@ -5,21 +5,16 @@ import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions
 /**
  * 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
  *
+ * @see https://github.com/webgptorg/promptbook/discussions/196
  * @param pipelineString {Promptbook} in string markdown format (.book.md)
  * @param tools - Tools for the preparation and scraping - if not provided together with `llm`, the preparation will be skipped
  * @param options - Options and tools for the compilation
  * @returns {Promptbook} compiled in JSON format (.bookc)
  * @throws {ParseError} if the promptbook string is not valid
+ *
  * @public exported from `@promptbook/core`
  */
 export declare function compilePipeline(pipelineString: PipelineString, tools?: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options?: PrepareAndScrapeOptions): Promise<PipelineJson>;
-/**
- * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
- * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
- * TODO: [🧠] Should be in generated JSON file GENERATOR_WARNING
- */

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

@@ -4,18 +4,15 @@ import type { RemoteClientOptions } from '../remote-server/types/RemoteClientOpt
 /**
  * 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
  *
+ * @see https://github.com/webgptorg/promptbook/discussions/196
  * @param pipelineString {Promptbook} in string markdown format (.book.md)
  * @param options - Configuration of the remote server
  * @returns {Promptbook} compiled in JSON format (.bookc)
  * @throws {ParseError} if the promptbook string is not valid
+ *
  * @public exported from `@promptbook/remote-client`
  */
 export declare function compilePipelineOnRemoteServer<TCustomOptions = undefined>(pipelineString: PipelineString, options: RemoteClientOptions<TCustomOptions>): Promise<PipelineJson>;
-/**
- * TODO: [🐚] Do not return `Promise<PipelineJson>` But `PreparationTask`
- */

package/esm/src/conversion/parsePipeline.d.ts

@@ -14,17 +14,7 @@ import type { PipelineString } from '../pipeline/PipelineString';
  * @param pipelineString {Promptbook} in string markdown format (.book.md)
  * @returns {Promptbook} compiled in JSON format (.bookc)
  * @throws {ParseError} if the promptbook string is not valid
+ *
  * @public exported from `@promptbook/core`
  */
 export declare function parsePipeline(pipelineString: PipelineString): PipelineJson;
-/**
- * TODO: [🧠] Maybe more things here can be refactored as high-level abstractions
- * 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
- * TODO: [🥞] Not optimal parsing because `splitMarkdownIntoSections` is executed twice with same string, once through `flattenMarkdown` and second directly here
- * TODO: [♈] Probably move expectations from tasks to parameters
- * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
- * TODO: [🍙] Make some standard order of json properties
- */

package/esm/src/conversion/pipelineJsonToString.d.ts

@@ -6,13 +6,7 @@ import type { PipelineString } from '../pipeline/PipelineString';
  * @deprecated TODO: [🥍][🧠] Backup original files in `PipelineJson` same as in Promptbook.studio
  * @param pipelineJson Promptbook in JSON format (.bookc)
  * @returns Promptbook in string format (.book.md)
+ *
  * @public exported from `@promptbook/core`
  */
 export declare function pipelineJsonToString(pipelineJson: PipelineJson): PipelineString;
-/**
- * TODO: [🛋] Implement new features and commands into `pipelineJsonToString` + `taskParameterJsonToString` , use `stringifyCommand`
- * TODO: [🧠] Is there a way to auto-detect missing features in pipelineJsonToString
- * TODO: [🏛] Maybe make some markdown builder
- * TODO: [🏛] Escape all
- * TODO: [🧠] Should be in generated .book.md file GENERATOR_WARNING
- */

package/esm/src/conversion/prettify/prettifyPipelineString.d.ts

@@ -6,7 +6,3 @@ import type { PrettifyOptions } from './PrettifyOptions';
  * @public exported from `@promptbook/core`
  */
 export declare function prettifyPipelineString(pipelineString: PipelineString, options: PrettifyOptions): Promise<PipelineString>;
-/**
- * TODO: Maybe use some Mermaid package instead of string templating
- * TODO: [🕌] When more than 2 functionalities, split into separate functions
- */

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

@@ -21,10 +21,3 @@ export type renderPipelineMermaidOptions = {
  * @public exported from `@promptbook/utils`
  */
 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: Maybe use some Mermaid package instead of string templating
- * TODO: [🕌] When more than 2 functionalities, split into separate functions
- */

package/esm/src/conversion/utils/extractParameterNamesFromTask.d.ts

@@ -7,9 +7,7 @@ import type { string_parameter_name } from '../../types/typeAliases';
  * @param task the task with used parameters
  * @returns the set of parameter names
  * @throws {ParseError} if the script is invalid
+ *
  * @public exported from `@promptbook/core` <- Note: [👖] This utility is so tightly interconnected with the Promptbook that it is not exported as util but in core
  */
 export declare function extractParameterNamesFromTask(task: ReadonlyDeep<Pick<TaskJson, 'title' | 'description' | 'taskType' | 'content' | 'preparedContent' | 'jokerParameterNames' | 'foreach'>>): Set<string_parameter_name>;
-/**
- * TODO: [🔣] If script require contentLanguage
- */

package/esm/src/conversion/validation/_importPipeline.d.ts

@@ -7,9 +7,15 @@ import type { PipelineString } from '../../pipeline/PipelineString';
  * Note: Using sync version is 💩 in the production code, but it's ok here in tests
  *
  * @param path - The path to the file relative to examples/pipelines directory
+ *
  * @private internal function of tests
  */
 export declare function importPipelineWithoutPreparation(path: `${string}.book`): Promise<PipelineString>;
+/**
+ * Imports pipeline without preparation.
+ *
+ * @private internal utility of `_importPipeline`
+ */
 export declare function importPipelineWithoutPreparation(path: `${string}.bookc`): Promise<PipelineJson>;
 /**
  * Import the pipeline.bookc file as parsed JSON
@@ -17,5 +23,3 @@ export declare function importPipelineWithoutPreparation(path: `${string}.bookc`
  * @private internal function of tests
  */
 export declare function importPipelineJson(path: `${string}.bookc`): Promise<PipelineJson>;
-/** Note: [⚫] Code for private pipeline import shim [_importPipeline](src/conversion/validation/_importPipeline.ts) should never be published in any package */
-/** Note: [💞] Ignore a discrepancy between file name and entity name */

package/esm/src/conversion/validation/pipelineStringToJson-parseErrors.test.d.ts

@@ -1,4 +1 @@
 export {};
-/**
- * TODO: [🚏] DRY
- */

package/esm/src/conversion/validation/validatePipeline-logicErrors.test.d.ts

@@ -1,4 +1 @@
 export {};
-/**
- * TODO: [🚏] DRY
- */

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

@@ -14,10 +14,13 @@ import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
  * @param pipeline valid or invalid PipelineJson
  * @returns the same pipeline if it is logically valid
  * @throws {PipelineLogicError} on logical error in the pipeline
+ *
  * @public exported from `@promptbook/core`
  */
 export declare function validatePipeline(pipeline: PipelineJson): PipelineJson;
 /**
+ * Validates pipeline inner function.
+ *
  * @private internal function for `validatePipeline`
  */
 export declare function validatePipeline_InnerFunction(pipeline: PipelineJson): void;
@@ -33,12 +36,3 @@ export declare function validatePipeline_InnerFunction(pipeline: PipelineJson):
  *     >  * -   ...
  *     >  ex port function validatePipeline(promptbook: really_unknown): asserts promptbook is PipelineJson {
  */
-/**
- * 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/src/conversion/validation/validatePipeline.test.d.ts

@@ -1,4 +1 @@
 export {};
-/**
- * TODO: [🚏] DRY
- */

package/esm/src/dialogs/simple-prompt/SimplePromptInterfaceTools.d.ts

@@ -5,7 +5,7 @@ import type { UserInterfaceToolsPromptDialogOptions } from '../../execution/User
  * Wrapper around `window.prompt` synchronous function that interacts with the user via browser prompt
  *
  * Warning: It is used for testing and mocking
- *          **NOT intended to use in the production** due to its synchronous nature.
+ * **NOT intended to use in the production** due to its synchronous nature.
  *
  * @public exported from `@promptbook/browser`
  */
@@ -17,4 +17,3 @@ export declare class SimplePromptInterfaceTools implements UserInterfaceTools {
      */
     promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
 }
-/** Note: [🔵] Code for browser dialog helper [SimplePromptInterfaceTools](src/dialogs/simple-prompt/SimplePromptInterfaceTools.ts) should never be published outside of `@promptbook/browser` */

package/esm/src/errors/0-BoilerplateError.d.ts

@@ -7,6 +7,3 @@ export declare class BoilerplateError extends Error {
     readonly name = "BoilerplateError";
     constructor(message: string);
 }
-/**
- * TODO: @@ Do not forget to add the error into `0-index.ts` ERRORS
- */

package/esm/src/errors/0-index.d.ts

@@ -98,6 +98,3 @@ export declare const ALL_ERRORS: {
     readonly DatabaseError: typeof DatabaseError;
     readonly ConflictError: typeof ConflictError;
 };
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/esm/src/errors/DatabaseError.d.ts

@@ -7,6 +7,3 @@ export declare class DatabaseError extends Error {
     readonly name = "DatabaseError";
     constructor(message: string);
 }
-/**
- * TODO: [🐱‍🚀] Explain that NotFoundError ([🐱‍🚀] and other specific errors) has priority over DatabaseError in some contexts
- */

package/esm/src/errors/ExpectError.d.ts

@@ -1,10 +1,11 @@
 /**
  * This error occurs when some expectation is not met in the execution of the pipeline
  *
- * @public exported from `@promptbook/core`
  * Note: Do not throw this error, its reserved for `checkExpectations` and `createPipelineExecutor` and public ONLY to be serializable through remote server
  * Note: Always thrown in `checkExpectations` and catched in `createPipelineExecutor` and rethrown as `PipelineExecutionError`
  * Note: This is a kindof subtype of PipelineExecutionError
+ *
+ * @public exported from `@promptbook/core`
  */
 export declare class ExpectError extends Error {
     readonly name = "ExpectError";

package/esm/src/errors/ParseError.d.ts

@@ -7,6 +7,3 @@ export declare class ParseError extends Error {
     readonly name = "ParseError";
     constructor(message: string);
 }
-/**
- * TODO: Maybe split `ParseError` and `ApplyError`
- */

package/esm/src/errors/PipelineExecutionError.d.ts

@@ -9,6 +9,3 @@ export declare class PipelineExecutionError extends Error {
     readonly id?: task_id;
     constructor(message: string);
 }
-/**
- * TODO: [🧠][🌂] Add id to all errors
- */

package/esm/src/executables/$provideExecutablesForNode.d.ts

@@ -6,8 +6,3 @@ import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions
  * @public exported from `@promptbook/node`
  */
 export declare function $provideExecutablesForNode(options?: PrepareAndScrapeOptions): Promise<Executables>;
-/** Note: [🟢] Code for Node executable locator [$provideExecutablesForNode](src/executables/$provideExecutablesForNode.ts) should never be published into packages that could be imported into browser environment */
-/**
- * TODO: [🧠] Allow to override the executables without need to call `locatePandoc` / `locateLibreoffice` in case of provided
- * TODO: [🏓] Unite `xxxForServer` and `xxxForNode` naming
- */

package/esm/src/executables/apps/locateLibreoffice.d.ts

@@ -6,5 +6,3 @@ import type { string_executable_path } from '../../types/typeAliases';
  * @private within the repository
  */
 export declare function locateLibreoffice(): Promise<string_executable_path | null>;
-/** Note: [🟢] Code for Node executable locator [locateLibreoffice](src/executables/apps/locateLibreoffice.ts) should never be published into packages that could be imported into browser environment */
-/** TODO: [🧠][♿] Maybe export through `@promptbook/node` OR `@promptbook/legacy-documents` */

package/esm/src/executables/apps/locatePandoc.d.ts

@@ -6,5 +6,3 @@ import type { string_executable_path } from '../../types/typeAliases';
  * @private within the repository
  */
 export declare function locatePandoc(): Promise<string_executable_path | null>;
-/** Note: [🟢] Code for Node executable locator [locatePandoc](src/executables/apps/locatePandoc.ts) should never be published into packages that could be imported into browser environment */
-/** TODO: [🧠][♿] Maybe export through `@promptbook/node` OR `@promptbook/documents` */

package/esm/src/executables/browsers/locateBrowser.d.ts

@@ -1,7 +1,6 @@
 import type { string_executable_path } from '../../types/typeAliases';
 /**
  * @@@
- *
  * @param browser It can be "default", "chrome", "firefox", "safari", "ie", "msie", "edge" or "msedge" or executable path to the browser
  * @returns executable path to browser
  *

package/esm/src/executables/browsers/locateDefaultSystemBrowser.d.ts

@@ -1,7 +1,6 @@
 import type { string_executable_path } from '../../types/typeAliases';
 /**
  * @@@
- *
  * @param browser It can be "default", "chrome", "firefox", "safari", "ie", "msie", "edge" or "msedge" or executable path to the browser
  * @returns executable path to browser
  *

package/esm/src/executables/locateApp.d.ts

@@ -27,5 +27,3 @@ export type LocateAppOptions = {
  * @private within the repository
  */
 export declare function locateApp(options: RequireAtLeastOne<LocateAppOptions, 'linuxWhich' | 'windowsSuffix' | 'macOsName'>): Promise<string_executable_path | null>;
-/** Note: [🟢] Code for Node executable locator [locateApp](src/executables/locateApp.ts) should never be published into packages that could be imported into browser environment */
-/** TODO: [🧠][♿] Maybe export through `@promptbook/node` */

package/esm/src/executables/platforms/locateAppOnLinux.d.ts

@@ -7,5 +7,3 @@ import type { LocateAppOptions } from '../locateApp';
  * @private within the repository
  */
 export declare function locateAppOnLinux({ linuxWhich, }: Pick<Required<LocateAppOptions>, 'linuxWhich'>): Promise<string_executable_path | null>;
-/** Note: [🟢] Code for Node executable locator [locateAppOnLinux](src/executables/platforms/locateAppOnLinux.ts) should never be published into packages that could be imported into browser environment */
-/** TODO: [🧠][♿] Maybe export through `@promptbook/node` */

package/esm/src/executables/platforms/locateAppOnMacOs.d.ts

@@ -7,5 +7,3 @@ import type { LocateAppOptions } from '../locateApp';
  * @private within the repository
  */
 export declare function locateAppOnMacOs({ macOsName, }: Pick<Required<LocateAppOptions>, 'macOsName'>): Promise<string_executable_path | null>;
-/** Note: [🟢] Code for Node executable locator [locateAppOnMacOs](src/executables/platforms/locateAppOnMacOs.ts) should never be published into packages that could be imported into browser environment */
-/** TODO: [🧠][♿] Maybe export through `@promptbook/node` */

package/esm/src/executables/platforms/locateAppOnWindows.d.ts

@@ -7,5 +7,3 @@ import type { LocateAppOptions } from '../locateApp';
  * @private within the repository
  */
 export declare function locateAppOnWindows({ appName, windowsSuffix, }: Pick<Required<LocateAppOptions>, 'appName' | 'windowsSuffix'>): Promise<string_executable_path | null>;
-/** Note: [🟢] Code for Node executable locator [locateAppOnWindows](src/executables/platforms/locateAppOnWindows.ts) should never be published into packages that could be imported into browser environment */
-/** TODO: [🧠][♿] Maybe export through `@promptbook/node` */

package/esm/src/execution/AbstractTaskResult.d.ts

@@ -19,7 +19,3 @@ export type AbstractTaskResult = {
      */
     readonly warnings: ReadonlyDeep<ReadonlyArray<ErrorJson>>;
 };
-/**
- * TODO: [🧠] Should this file be in /execution or /types folder?
- * TODO: [🧠] Maybe constrain `ErrorJson` -> `ErrorJson & { name: 'PipelineExecutionError' | 'Error' }`
- */

package/esm/src/execution/AvailableModel.d.ts

@@ -46,7 +46,3 @@ export type AvailableModel = {
      */
     readonly isDeprecated?: boolean;
 };
-/**
- * TODO: [🕛] Extend this from sth like `AgentBasicInformation` / `ModelBasicInformation`
- * TODO: [🧠] Maybe rename to something else - like `ModelInformation` or `ModelMetadata`
- */

package/esm/src/execution/CommonToolsOptions.d.ts

@@ -21,8 +21,3 @@ export type CommonToolsOptions = {
      */
     readonly maxRequestsPerMinute?: number;
 };
-/**
- * TODO: [🧠][🤺] Maybe allow overriding of `userId` for each prompt
- * TODO: [🈁] Maybe add here `isDeterministic`
- * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
- */

package/esm/src/execution/ExecutionTask.d.ts

@@ -50,6 +50,7 @@ export type ExecutionTask = AbstractTask<PipelineExecutorResult> & {
 };
 /**
  * Represents a task that prepares a pipeline
+ *
  * @deprecated TODO: [🐚] Currently unused - use
  */
 export type PreparationTask = AbstractTask<PipelineExecutorResult> & {
@@ -146,9 +147,8 @@ export type AbstractTask<TTaskResult extends AbstractTaskResult> = {
      */
     readonly ptbkNonce?: chococake;
 };
-export type Task = ExecutionTask | PreparationTask;
-export {};
 /**
- * TODO: Maybe allow to terminate the task and add getter `isFinished` or `status`
- * TODO: [🐚] Split into more files and make `PrepareTask` & `RemoteTask` + split the function
+ * Type describing task.
  */
+export type Task = ExecutionTask | PreparationTask;
+export {};

package/esm/src/execution/FilesystemTools.d.ts

@@ -4,6 +4,3 @@ import type fs from 'fs/promises';
  * Container for all the tools needed to manipulate with filesystem
  */
 export type FilesystemTools = Pick<typeof fs, 'access' | 'constants' | 'readFile' | 'writeFile' | 'stat' | 'readdir' | 'mkdir' | 'watch'>;
-/**
- * TODO: Implement destroyable pattern to free resources
- */

package/esm/src/execution/LlmExecutionTools.d.ts

@@ -30,6 +30,9 @@ export type CallChatModelStreamOptions = {
      */
     readonly signal?: AbortSignal;
 };
+/**
+ * Type describing Llm execution tools.
+ */
 export type LlmExecutionTools = {
     /**
      * Title of the model provider
@@ -93,12 +96,3 @@ export type LlmExecutionTools = {
      */
     callEmbeddingModel?(prompt: Prompt): Promise<EmbeddingPromptResult>;
 };
-/**
- * TODO: [🕛] Extend this from sth class -  like `AgentBasicInformation` / `ModelBasicInformation``
- * TODO: [🍚] Implement destroyable pattern to free resources
- * TODO: [🏳] Add `callTranslationModel`
- * TODO: [🧠] Emulation of one type of model with another one - emuate chat with completion; emulate translation with chat
- * TODO: [🍓][♐] Some heuristic to pick the best model in listed models
- * TODO: [🧠] Should or should not there be a word "GPT" in both callCompletionModel and callChatModel
- * TODO: [🧠][🪐] Should be common things like types, utils in folder containing A,B,C,.. or else outside this listing folder?
- */

package/esm/src/execution/LlmExecutionToolsConstructor.d.ts

@@ -6,6 +6,3 @@ import type { LlmExecutionTools } from './LlmExecutionTools';
  * Combines registration metadata with a factory function for creating LLM tool instances.
  */
 export type LlmExecutionToolsConstructor = Registered & ((options: TODO_any) => LlmExecutionTools);
-/**
- * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
- */

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

@@ -11,6 +11,3 @@ import type { ExecutionTask } from './ExecutionTask';
 export type PipelineExecutor = {
     (inputParameters: InputParameters): ExecutionTask;
 };
-/**
- * TODO: [🧠] Should this file be in /execution or /types folder?
- */

package/esm/src/execution/PipelineExecutorResult.d.ts

@@ -34,6 +34,3 @@ export type PipelineExecutorResult = AbstractTaskResult & {
      */
     readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
 };
-/**
- * TODO: [🧠] Should this file be in /execution or /types folder?
- */

package/esm/src/execution/PromptResult.d.ts

@@ -18,7 +18,7 @@ export type PromptResult = CompletionPromptResult | ChatPromptResult | ImageProm
  */
 export type CompletionPromptResult = CommonPromptResult;
 /**
- *Chat prompt result
+ * Chat prompt result
  *
  * Note: [🚉] This is fully serializable as JSON
  */
@@ -101,11 +101,3 @@ export type CommonPromptResult = {
      */
     readonly rawResponse: TODO_object;
 };
-/**
- * TODO: [🧠] Maybe timing more accurate then seconds?
- * TODO: [🧠] Should here be link to the prompt?
- * TODO: [🧠] Maybe type `rawResponse` properly - not onject but OpenAI.result.whatever
- * TODO: [🧠] Maybe remove redundant raw.choices.text
- * TODO: Log raw even if prompt failed - log the raw error
- * TODO: [🏳] Add `TranslationPromptResult`
- */

package/esm/src/execution/PromptbookFetch.test-type.d.ts

@@ -1,5 +1 @@
 export {};
-/**
- * Note: [⚪] This should never be in any released package
- * TODO: Is this a good pattern to do type testing?
- */

package/esm/src/execution/ScriptExecutionTools.d.ts

@@ -33,7 +33,3 @@ export type ScriptExecutionToolsExecuteOptions = {
      */
     readonly script: string_script;
 };
-/**
- * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
- * TODO: [🧠][🪐] Should be common things like types, utils in folder containing A,B,C,.. or else outside this listing folder?
- */

package/esm/src/execution/Usage.d.ts

@@ -32,6 +32,3 @@ export type Usage = {
  * Note: [🚉] This is fully serializable as JSON
  */
 export type UsageCounts = Record<`${KebabCase<'TOKENS' | ExpectationUnit>}Count`, UncertainNumber>;
-/**
- * TODO: [🍙] Make some standard order of json properties
- */

package/esm/src/execution/UserInterfaceTools.d.ts

@@ -14,6 +14,9 @@ export type UserInterfaceTools = {
      */
     promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
 };
+/**
+ * Options for user interface tools prompt dialog.
+ */
 export type UserInterfaceToolsPromptDialogOptions = {
     /**
      * Prompt title

package/esm/src/execution/assertsTaskSuccessful.d.ts

@@ -6,9 +6,7 @@ import type { PipelineExecutorResult } from './PipelineExecutorResult';
  *
  * @param executionResult - The partial result of the Promptbook execution
  * @throws {PipelineExecutionError} If the execution is not successful or if multiple errors occurred
+ *
  * @private internal helper function of `asPromise` method of `ExecutionTask`
  */
 export declare function assertsTaskSuccessful(executionResult: Pick<PipelineExecutorResult, 'isSuccessful' | 'errors' | 'warnings'>): void;
-/**
- * TODO: [🧠] Can this return type be better typed than void
- */

package/esm/src/execution/createPipelineExecutor/00-createPipelineExecutor.d.ts

@@ -5,6 +5,7 @@ import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorO
  *
  * @returns The executor function
  * @throws {PipelineLogicError} on logical error in the pipeline
+ *
  * @public exported from `@promptbook/core`
  */
 export declare function createPipelineExecutor(options: CreatePipelineExecutorOptions): PipelineExecutor;

package/esm/src/execution/createPipelineExecutor/20-executeTask.d.ts

@@ -51,6 +51,3 @@ type executeSingleTaskOptions = Required<CreatePipelineExecutorOptions> & {
  */
 export declare function executeTask(options: executeSingleTaskOptions): Promise<Readonly<Parameters>>;
 export {};
-/**
- * TODO: [🤹‍♂️]
- */

package/esm/src/execution/createPipelineExecutor/40-executeAttempts.d.ts

@@ -71,9 +71,7 @@ export type ExecuteAttemptsOptions = Required<Omit<CreatePipelineExecutorOptions
  *
  * @param options - The options for execution, including task, parameters, pipeline, and configuration.
  * @returns The result string of the executed task.
+ *
  * @private internal utility of `createPipelineExecutor`
  */
 export declare function executeAttempts(options: ExecuteAttemptsOptions): Promise<TODO_string>;
-/**
- * TODO: Break into smaller functions
- */

package/esm/src/execution/createPipelineExecutor/getContextForTask.d.ts

@@ -9,6 +9,7 @@ import type { string_parameter_value } from '../../types/typeAliases';
  *
  * @param task - The task for which the context is being generated. This should be a deeply immutable TaskJson object.
  * @returns The context as a string, formatted as markdown and parameter value.
+ *
  * @private internal utility of `createPipelineExecutor`
  */
 export declare function getContextForTask(task: ReadonlyDeep<TaskJson>): Promise<string_parameter_value & string_markdown>;

package/esm/src/execution/createPipelineExecutor/getKnowledgeForTask.d.ts

@@ -34,7 +34,3 @@ type GetKnowledgeForTaskOptions = {
  */
 export declare function getKnowledgeForTask(options: GetKnowledgeForTaskOptions): Promise<string_parameter_value & string_markdown>;
 export {};
-/**
- * TODO: [♨] Implement Better - use keyword search
- * TODO: [♨] Examples of values
- */

package/esm/src/execution/createPipelineExecutor/knowledgePiecesToString.d.ts

@@ -1,6 +1,5 @@
 import type { KnowledgePiecePreparedJson } from '../../pipeline/PipelineJson/KnowledgePieceJson';
 /**
- *
  * @param knowledgePieces
  * @returns
  *

package/esm/src/execution/execution-report/ExecutionReportJson.d.ts

@@ -11,6 +11,7 @@ import type { ExecutionPromptReportJson } from './ExecutionPromptReportJson';
  * -   _(this)_ **JSON** format
  *
  * Note: [🚉] This is fully serializable as JSON
+ *
  * @see https://github.com/webgptorg/promptbook#execution-report
  */
 export type ExecutionReportJson = {

package/esm/src/execution/execution-report/ExecutionReportString.d.ts

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

package/esm/src/execution/execution-report/executionReportJsonToString.d.ts

@@ -8,8 +8,3 @@ import type { ExecutionReportStringOptions } from './ExecutionReportStringOption
  * @public exported from `@promptbook/core`
  */
 export declare function executionReportJsonToString(executionReportJson: ReadonlyDeep<ExecutionReportJson>, options?: Partial<ExecutionReportStringOptions>): ExecutionReportString;
-/**
- * TODO: Add mermaid chart for every report
- * TODO: [🧠] Allow to filter out some parts of the report by options
- * TODO: [🧠] Should be in generated file GENERATOR_WARNING
- */

package/esm/src/execution/translation/automatic-translate/automatic-translators/AutomaticTranslator.d.ts

@@ -1,6 +1,8 @@
 import type { Promisable } from 'type-fest';
 /**
- * @private still in development [🏳]
+ * Still in development [🏳].
+ *
+ * @private
  */
 export type AutomaticTranslator = {
     translate(message: string): Promisable<string>;

package/esm/src/execution/translation/automatic-translate/automatic-translators/FakeAutomaticTranslator.d.ts

@@ -1,6 +1,8 @@
 import type { AutomaticTranslator } from './AutomaticTranslator';
 /**
- * @private still in development [🏳]
+ * Still in development [🏳].
+ *
+ * @private
  */
 export declare class FakeAutomaticTranslator implements AutomaticTranslator {
     constructor();

package/esm/src/execution/translation/automatic-translate/automatic-translators/TranslatorOptions.d.ts

@@ -1,5 +1,7 @@
 /**
- * @private still in development [🏳]
+ * Still in development [🏳].
+ *
+ * @private
  */
 export type TranslatorOptions = {
     readonly from?: string;