@promptbook/javascript 0.112.0-34 → 0.112.0-36

package/umd/src/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.d.ts

@@ -1,8 +1,10 @@
 /**
+ * Extracts multiplicated occurrence.
  *
  * @param message
  * @returns
  * @throws {PipelineExecutionError}
+ *
  * @private still in development [🏳]
  */
 export declare function extractMultiplicatedOccurrence(message: string): string;

package/umd/src/execution/translation/automatic-translate/translateMessages.d.ts

@@ -1,10 +1,10 @@
 import type { AutomaticTranslator } from './automatic-translators/AutomaticTranslator';
 import type { TranslatorOptions } from './automatic-translators/TranslatorOptions';
 /**
- * @private still in development [🏳]
+ * Still in development [🏳].
+ *
+ * @private
  */
 export declare function translateMessages({ automaticTranslator, from, to, }: {
     automaticTranslator: AutomaticTranslator;
 } & TranslatorOptions): Promise<void>;
-/** Note: [🟢] Code for Node translation helper [translateMessages](src/execution/translation/automatic-translate/translateMessages.ts) should never be published into packages that could be imported into browser environment */
-/** TODO: [😶] Unite folder listing */

package/umd/src/execution/utils/$provideExecutionToolsForNode.d.ts

@@ -2,11 +2,9 @@ import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOpti
 import type { ExecutionTools } from '../ExecutionTools';
 /**
  * Note: There is unfortunately no equivalent for this function in the browser environment
- *       because it is not possible automatically detect configured LLM providers
- *       you need to provide them manually BUT you can help by utilities like `$provideScrapersForBrowser`
+ * because it is not possible automatically detect configured LLM providers
+ * you need to provide them manually BUT you can help by utilities like `$provideScrapersForBrowser`
  *
  * @public exported from `@promptbook/node`
  */
 export declare function $provideExecutionToolsForNode(options?: PrepareAndScrapeOptions): Promise<ExecutionTools>;
-/** Note: [🟢] Code for Node execution helper [$provideExecutionToolsForNode](src/execution/utils/$provideExecutionToolsForNode.ts) should never be published into packages that could be imported into browser environment */
-/** TODO: [🏓] Unite `xxxForServer` and `xxxForNode` naming */

package/umd/src/execution/utils/checkExpectations.d.ts

@@ -8,6 +8,7 @@ import type { Expectations } from '../../pipeline/PipelineJson/Expectations';
  *
  * @throws {ExpectError} if the expectations are not met
  * @returns {void} Nothing
+ *
  * @private internal function of `createPipelineExecutor`
  */
 export declare function checkExpectations(expectations: Expectations, value: string): void;
@@ -19,11 +20,7 @@ export declare function checkExpectations(expectations: Expectations, value: str
  * - `isPassingExpectations` which returns a boolean
  *
  * @returns {boolean} True if the expectations are met
+ *
  * @public exported from `@promptbook/core`
  */
 export declare function isPassingExpectations(expectations: Expectations, value: string): boolean;
-/**
- * TODO: [💝] Unite object for expecting amount and format
- * TODO: [🧠][🤠] This should be part of `TextFormatParser`
- * Note: [💝] and [🤠] are interconnected together
- */

package/umd/src/execution/utils/forEachAsync.d.ts

@@ -1,4 +1,7 @@
 import type { Promisable } from 'type-fest';
+/**
+ * Options for for each async.
+ */
 type ForEachAsyncOptions = {
     /**
      * Maximum number of tasks running in parallel
@@ -13,8 +16,9 @@ type ForEachAsyncOptions = {
  * @param array - Array to iterate over
  * @param options - Options for the function
  * @param callbackfunction - Function to call for each item
- * @public exported from `@promptbook/utils`
  * @deprecated [🪂] Use queues instead
+ *
+ * @public exported from `@promptbook/utils`
  */
 export declare function forEachAsync<TItem>(array: ReadonlyArray<TItem>, options: ForEachAsyncOptions, callbackfunction: (value: TItem, index: number, array: ReadonlyArray<TItem>) => Promisable<void>): Promise<void>;
 export {};

package/umd/src/execution/utils/usage-constants.d.ts

@@ -22,6 +22,3 @@ export declare const ZERO_USAGE: any;
  * @public exported from `@promptbook/core`
  */
 export declare const UNCERTAIN_USAGE: any;
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/umd/src/execution/utils/usageToHuman.d.ts

@@ -17,11 +17,3 @@ type PartialUsage = Partial<Usage> & {
  */
 export declare function usageToHuman(usage: PartialUsage): string_markdown;
 export {};
-/**
- * TODO: [🍓][🧞‍♂️] Use "$1" not "1 USD"
- * TODO: [🍓][🧞‍♂️] Use markdown formatting like "Cost approximately **$1**"
- * TODO: [🍓][🧞‍♂️] Report in minutes, seconds, days NOT 0.1 hours
- * TODO: [🧠] Maybe make from `uncertainNumberToHuman` separate exported utility
- * TODO: [🧠] Maybe use "~" instead of "approximately"
- * TODO: [🏛] Maybe make some markdown builder
- */

package/umd/src/execution/utils/validatePromptResult.d.ts

@@ -50,6 +50,7 @@ export type ValidatePromptResultResult = {
  *
  * @param options - The validation options including result string, expectations, and format
  * @returns Validation result with processed string and validity status
+ *
  * @private internal function of `createPipelineExecutor` and `cacheLlmTools`
  */
 export declare function validatePromptResult(options: ValidatePromptResultOptions): ValidatePromptResultResult;

package/umd/src/file-security-checkers/virustotal/VirusTotalFileSecurityChecker.d.ts

@@ -5,6 +5,7 @@ import type { FileSecurityCheckResult } from '../FileSecurityCheckResult';
  * File security checker that uses VirusTotal API.
  *
  * @see https://developers.virustotal.com/reference/overview
+ *
  * @public exported from `@promptbook/core`
  */
 export declare class VirusTotalFileSecurityChecker implements FileSecurityChecker {

package/umd/src/formats/_common/FormatParser.d.ts

@@ -6,11 +6,12 @@ import type { FormatSubvalueParser } from './FormatSubvalueParser';
 /**
  * A format definition is a set of functions that define how to validate, heal and convert response from LLM.
  *
- * @remarks
  * - "settings" are runtime options that affect parsing (e.g., delimiter for CSV).
  * - "schema" is a structural definition or contract for the data (e.g., expected fields in JSON).
  *
+ * @remarks
  * @see https://github.com/webgptorg/promptbook/discussions/36
+ *
  * @private still in development [🏢]
  */
 export type FormatParser<TValue extends TPartialValue, TPartialValue extends string, TSettings extends empty_object, TSchema extends empty_object> = {
@@ -62,11 +63,3 @@ export type FormatParser<TValue extends TPartialValue, TPartialValue extends str
      */
     readonly subvalueParsers: ReadonlyArray<FormatSubvalueParser<TValue, TSettings>>;
 };
-/**
- * TODO: [♏] Add some prepare hook to modify prompt according to the format
- * TODO: [🍓]`name` and `aliases` should be UPPERCASE only and interpreted as case-insensitive (via normalization)
- * TODO: [🍓][👨‍⚖️] Compute TPartialValue dynamically - PartialString<TValue>
- * TODO: [🍓][🧠] Should execution tools be available to heal, canBeValid and isValid?
- * TODO: [🍓][🧠] llm Provider Bindings
- * TODO: [🍓][🔼] Export via some package
- */

package/umd/src/formats/_common/FormatSubvalueParser.d.ts

@@ -61,6 +61,3 @@ export type FormatSubvalueParserMapValuesOptions<TValue extends string, TSetting
      */
     onProgress(partialResultString: TValue): Promisable<void>;
 };
-/**
- * Note: [👩🏾‍🤝‍🧑🏽]
- */

package/umd/src/formats/csv/CsvFormatParser.d.ts

@@ -4,14 +4,8 @@ import type { CsvSettings } from './CsvSettings';
 /**
  * Definition for CSV spreadsheet
  *
+ * TODO: [🏢] Export from package `@promptbook/csv`
+ *
  * @public exported from `@promptbook/core`
- *                          <- TODO: [🏢] Export from package `@promptbook/csv`
  */
 export declare const CsvFormatParser: FormatParser<string, string, CsvSettings, TODO_any>;
-/**
- * TODO: [🍓] In `CsvFormatParser` implement simple `isValid`
- * TODO: [🍓] In `CsvFormatParser` implement partial `canBeValid`
- * TODO: [🍓] In `CsvFormatParser` implement `heal
- * TODO: [🍓] In `CsvFormatParser` implement `subvalueParsers`
- * TODO: [🏢] Allow to expect something inside CSV objects and other formats
- */

package/umd/src/formats/index.d.ts

@@ -4,6 +4,3 @@
  * @private internal index of `...` <- TODO [🏢]
  */
 export declare const FORMAT_DEFINITIONS: readonly [import("./_common/FormatParser").FormatParser<string, string, any, any>, import("./_common/FormatParser").FormatParser<string, string, any, any>, import("./_common/FormatParser").FormatParser<string, string, any, any>, import("./_common/FormatParser").FormatParser<string, string, import("./csv/CsvSettings").CsvSettings, any>];
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/umd/src/formats/json/JsonFormatParser.d.ts

@@ -6,14 +6,3 @@ import type { FormatParser } from '../_common/FormatParser';
  * @private still in development [🏢]
  */
 export declare const JsonFormatParser: FormatParser<string, string, TODO_any, TODO_any>;
-/**
- * TODO: [🧠] Maybe proper instance of object
- * TODO: [0] Make string_serialized_json
- * TODO: [1] Make type for JSON Settings and Schema
- * TODO: [🧠] What to use for validating JSONs - JSON Schema, ZoD, typescript types/interfaces,...?
- * TODO: [🍓] In `JsonFormatParser` implement simple `isValid`
- * TODO: [🍓] In `JsonFormatParser` implement partial `canBeValid`
- * TODO: [🍓] In `JsonFormatParser` implement `heal
- * TODO: [🍓] In `JsonFormatParser` implement `subvalueParsers`
- * TODO: [🏢] Allow to expect something inside JSON objects and other formats
- */

package/umd/src/formats/text/TextFormatParser.d.ts

@@ -8,12 +8,3 @@ import type { FormatParser } from '../_common/FormatParser';
  * @public exported from `@promptbook/core`
  */
 export declare const TextFormatParser: FormatParser<string, string, TODO_any, TODO_any>;
-/**
- * TODO: [1] Make type for XML Text and Schema
- * TODO: [🧠][🤠] Here should be all words, characters, lines, paragraphs, pages available as subvalues
- * TODO: [🍓] In `TextFormatParser` implement simple `isValid`
- * TODO: [🍓] In `TextFormatParser` implement partial `canBeValid`
- * TODO: [🍓] In `TextFormatParser` implement `heal
- * TODO: [🍓] In `TextFormatParser` implement `subvalueParsers`
- * TODO: [🏢] Allow to expect something inside each item of list and other formats
- */

package/umd/src/formats/xml/XmlFormatParser.d.ts

@@ -6,14 +6,3 @@ import type { FormatParser } from '../_common/FormatParser';
  * @private still in development [🏢]
  */
 export declare const XmlFormatParser: FormatParser<string, string, TODO_any, TODO_any>;
-/**
- * TODO: [🧠] Maybe proper instance of object
- * TODO: [0] Make string_serialized_xml
- * TODO: [1] Make type for XML Settings and Schema
- * TODO: [🧠] What to use for validating XMLs - XSD,...
- * TODO: [🍓] In `XmlFormatParser` implement simple `isValid`
- * TODO: [🍓] In `XmlFormatParser` implement partial `canBeValid`
- * TODO: [🍓] In `XmlFormatParser` implement `heal
- * TODO: [🍓] In `XmlFormatParser` implement `subvalueParsers`
- * TODO: [🏢] Allow to expect something inside XML and other formats
- */

package/umd/src/formfactors/_common/AbstractFormfactorDefinition.d.ts

@@ -9,6 +9,7 @@ import type { string_SCREAMING_CASE } from '../../utils/normalization/normalizeT
  * implemented by specific form factors.
  *
  * Note: [🚉] This is fully serializable as JSON
+ *
  * @see https://github.com/webgptorg/promptbook/discussions/172
  */
 export type AbstractFormfactorDefinition = {
@@ -44,6 +45,3 @@ export type AbstractFormfactorDefinition = {
      */
     readonly pipelineInterface: PipelineInterface;
 };
-/**
- * TODO: [🧠][🤓] How to pass optional parameters - for example summary in FORMFACTOR Translator
- */

package/umd/src/formfactors/_common/FormfactorDefinition.d.ts

@@ -5,6 +5,7 @@ import { FORMFACTOR_DEFINITIONS } from '../index';
  * to represent how a particular interface handles inputs, outputs, and behaviors.
  *
  * Note: [🚉] This is fully serializable as JSON
+ *
  * @see https://github.com/webgptorg/promptbook/discussions/172
  */
 export type FormfactorDefinition = (typeof FORMFACTOR_DEFINITIONS)[number];

package/umd/src/formfactors/index.d.ts

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

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

@@ -14,8 +14,3 @@ export type SyncHighLevelAbstraction = {
      */
     $applyToPipelineJson($pipelineJson: $PipelineJson): $side_effect;
 };
-/**
- * TODO: [♓️] Add order here
- * TODO: [🧠][🍱] Maybe make some common abstraction between `HighLevelAbstraction` and `CommandParser`
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/umd/src/high-level-abstractions/index.d.ts

@@ -48,7 +48,3 @@ export declare const HIGH_LEVEL_ABSTRACTIONS: readonly [{
         readonly formfactorName?: "CHATBOT" | "COMPLETION" | "GENERATOR" | "GENERIC" | "IMAGE_GENERATOR" | "EXPERIMENTAL_MATCHER" | "SHEETS" | "TRANSLATOR" | undefined;
     }>): void;
 }];
-/**
- * TODO: Test that all sync high-level abstractions are before async high-level abstractions
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

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

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

package/umd/src/llm-providers/_common/register/$llmToolsMetadataRegister.d.ts

@@ -4,10 +4,9 @@ import type { LlmToolsMetadata } from './LlmToolsMetadata';
  * Register for LLM tools metadata.
  *
  * Note: `$` is used to indicate that this interacts with the global scope
+ *
  * @singleton Only one instance of each register is created per build, but there can be more instances across different builds or environments.
+ *
  * @public exported from `@promptbook/core`
  */
 export declare const $llmToolsMetadataRegister: $Register<LlmToolsMetadata>;
-/**
- * TODO: [®] DRY Register logic
- */

package/umd/src/llm-providers/_common/register/$llmToolsRegister.d.ts

@@ -4,10 +4,9 @@ import { $Register } from '../../../utils/misc/$Register';
  * Register for LLM tools.
  *
  * Note: `$` is used to indicate that this interacts with the global scope
+ *
  * @singleton Only one instance of each register is created per build, but there can be more instances across different builds or environments.
+ *
  * @public exported from `@promptbook/core`
  */
 export declare const $llmToolsRegister: $Register<LlmExecutionToolsConstructor>;
-/**
- * TODO: [®] DRY Register logic
- */

package/umd/src/llm-providers/_common/register/$provideEnvFilename.d.ts

@@ -7,4 +7,3 @@ import type { string_filename } from '../../../types/typeAliases';
  * @private within the repository - for CLI utils
  */
 export declare function $provideEnvFilename(): Promise<string_filename | null>;
-/** Note: [🟢] Code for Node environment helper [$provideEnvFilename](src/llm-providers/_common/register/$provideEnvFilename.ts) should never be published into packages that could be imported into browser environment */

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

@@ -11,7 +11,7 @@ import type { LlmToolsConfiguration } from './LlmToolsConfiguration';
  *
  * @see Environment variables documentation or .env file for required variables.
  * @returns A promise that resolves to the LLM tools configuration, or null if configuration is incomplete or missing.
+ *
  * @public exported from `@promptbook/node`
  */
 export declare function $provideLlmToolsConfigurationFromEnv(): Promise<LlmToolsConfiguration>;
-/** Note: [🟢] Code for Node environment helper [$provideLlmToolsConfigurationFromEnv](src/llm-providers/_common/register/$provideLlmToolsConfigurationFromEnv.ts) should never be published into packages that could be imported into browser environment */

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

@@ -1,6 +1,9 @@
 import '../../../_packages/cli.index';
 import type { LlmExecutionToolsWithTotalUsage } from '../utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
 import type { CreateLlmToolsFromConfigurationOptions } from './createLlmToolsFromConfiguration';
+/**
+ * Options for get Llm tools for testing and scripts and playground.
+ */
 type GetLlmToolsForTestingAndScriptsAndPlaygroundOptions = CreateLlmToolsFromConfigurationOptions & {
     /**
      * Flag indicating whether the cache should be reloaded or reused
@@ -19,9 +22,3 @@ type GetLlmToolsForTestingAndScriptsAndPlaygroundOptions = CreateLlmToolsFromCon
  */
 export declare function $provideLlmToolsForTestingAndScriptsAndPlayground(options?: GetLlmToolsForTestingAndScriptsAndPlaygroundOptions): Promise<LlmExecutionToolsWithTotalUsage>;
 export {};
-/**
- * Note: [⚪] This should never be in any released package
- * TODO: [👷‍♂️] Write a comprehensive manual about the construction of LLM tools
- * TODO: This should be maybe not under `_common` but under `utils-internal` / `utils/internal`
- * TODO: [®] DRY Register logi
- */

package/umd/src/llm-providers/_common/register/$provideLlmToolsForWizardOrCli.d.ts

@@ -4,6 +4,9 @@ import type { string_app_id, string_url } from '../../../types/typeAliases';
 import type { chococake } from '../../../utils/organization/really_any';
 import type { CacheLlmToolsOptions } from '../utils/cache/CacheLlmToolsOptions';
 import type { LlmExecutionToolsWithTotalUsage } from '../utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
+/**
+ * Options for provide Llm tools for wizard or Cli.
+ */
 type ProvideLlmToolsForWizardOrCliOptions = {
     /**
      * If true, user will be always prompted for login
@@ -49,10 +52,3 @@ type ProvideLlmToolsForWizardOrCliOptions = {
  */
 export declare function $provideLlmToolsForWizardOrCli(options?: ProvideLlmToolsForWizardOrCliOptions): Promise<LlmExecutionToolsWithTotalUsage>;
 export {};
-/** Note: [🟢] Code for Node environment helper [$provideLlmToolsForWizardOrCli](src/llm-providers/_common/register/$provideLlmToolsForWizardOrCli.ts) should never be published into packages that could be imported into browser environment */
-/**
- * TODO: [👷‍♂️] Write a comprehensive manual about the construction of LLM tools
- * TODO: [🥃] Allow `ptbk make` without llm tools
- * TODO: This should be maybe not under `_common` but under `utils-internal` / `utils/internal`
- * TODO: [®] DRY Register logic
- */

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

@@ -18,22 +18,7 @@ import type { CreateLlmToolsFromConfigurationOptions } from './createLlmToolsFro
  *
  * @param options Configuration options for the LLM tools
  * @returns A unified interface containing all detected and configured LLM tools
+ *
  * @public exported from `@promptbook/node`
  */
 export declare function $provideLlmToolsFromEnv(options?: CreateLlmToolsFromConfigurationOptions): Promise<MultipleLlmExecutionTools>;
-/** Note: [🟢] Code for Node environment helper [$provideLlmToolsFromEnv](src/llm-providers/_common/register/$provideLlmToolsFromEnv.ts) should never be published into packages that could be imported into browser environment */
-/**
- * TODO: The architecture for LLM tools configuration consists of three key functions:
- * 1. `$provideLlmToolsFromEnv` - High-level function that detects available providers from env vars and returns ready-to-use LLM tools
- * 2. `$provideLlmToolsConfigurationFromEnv` - Middle layer that extracts configuration objects from environment variables
- * 3. `createLlmToolsFromConfiguration` - Low-level function that instantiates LLM tools from explicit configuration
- * This layered approach allows flexibility in how tools are configured:
- * - Use $provideLlmToolsFromEnv for automatic detection and setup in Node.js environments
- * - Use $provideLlmToolsConfigurationFromEnv to extract config objects for modification before instantiation
- * - Use createLlmToolsFromConfiguration for explicit control over tool configurations
- * TODO: [🧠][🍛] Which name is better `$provideLlmToolsFromEnv` or `$provideLlmToolsFromEnvironment`?
- * TODO: [🧠] Is there some meaningfull way how to test this util
- * TODO: [🥃] Allow `ptbk make` without llm tools
- * TODO: This should be maybe not under `_common` but under `utils`
- * TODO: [®] DRY Register logic
- */

package/umd/src/llm-providers/_common/register/$registeredLlmToolsMessage.d.ts

@@ -16,7 +16,3 @@ export declare function $setUsedEnvFilename(filepath: string_filename): $side_ef
  * @private internal function of `createLlmToolsFromConfiguration` and `$provideLlmToolsFromEnv`
  */
 export declare function $registeredLlmToolsMessage(): string_markdown;
-/**
- * TODO: [®] DRY Register logic
- * TODO: [🧠][⚛] Maybe pass env as argument
- */

package/umd/src/llm-providers/_common/register/LlmToolsConfiguration.d.ts

@@ -23,8 +23,3 @@ export type LlmToolsConfiguration = ReadonlyArray<Registered & {
      */
     readonly options: LlmToolsOptions;
 }>;
-/**
- * TODO: [🧠][🌰] `title` is redundant BUT maybe allow each provider pass it's own title for tracking purposes
- * TODO: Maybe instead of `LlmToolsConfiguration[number]` make `LlmToolsConfigurationItem`
- * TODO: [®] DRY Register logic
- */

package/umd/src/llm-providers/_common/register/LlmToolsMetadata.d.ts

@@ -49,9 +49,3 @@ export type LlmToolsMetadata = Registered & {
      */
     createConfigurationFromEnv(env: Record<string_name, string>): LlmToolsConfiguration[number] | null;
 };
-/**
- * TODO: [🕛] Extend this
- * TODO: Add configuration schema and maybe some documentation link
- * TODO: Maybe constrain LlmToolsConfiguration[number] by generic to ensure that `createConfigurationFromEnv` and `getBoilerplateConfiguration` always create same `packageName` and `className`
- * TODO: [®] DRY Register logic
- */

package/umd/src/llm-providers/_common/register/LlmToolsOptions.d.ts

@@ -4,7 +4,6 @@ import type { TODO_object } from '../../../utils/organization/TODO_object';
  *
  * This type is used to pass provider-specific options to LLM execution tools.
  *
- *
  * The Promptbook LLM tools architecture involves several related types:
  * - `LlmToolsMetadata`: Contains static metadata about the tool, such as name, version, and capabilities
  * - `LlmToolsConfiguration`: Runtime configuration from environment variables or settings
@@ -12,6 +11,3 @@ import type { TODO_object } from '../../../utils/organization/TODO_object';
  * - `Registered`: The record of a registered tool in the global registry
  */
 export type LlmToolsOptions = TODO_object;
-/**
- * TODO: [®] DRY Register logic
- */

package/umd/src/llm-providers/_common/register/createLlmToolsFromConfiguration.d.ts

@@ -37,6 +37,7 @@ export type CreateLlmToolsFromConfigurationOptions = {
  * @param configuration Array of LLM tool configurations to instantiate
  * @param options Additional options for configuring the LLM tools
  * @returns A unified interface combining all successfully instantiated LLM tools
+ *
  * @public exported from `@promptbook/core`
  */
 export declare function createLlmToolsFromConfiguration(configuration: LlmToolsConfiguration, options?: CreateLlmToolsFromConfigurationOptions): MultipleLlmExecutionTools;

package/umd/src/llm-providers/_common/utils/assertUniqueModels.d.ts

@@ -7,6 +7,3 @@ import { AvailableModel } from '../../../execution/AvailableModel';
  * @private internal utility of unit tests
  */
 export declare function assertUniqueModels(models: ReadonlyArray<AvailableModel>): void;
-/**
- * Note: [⚪] This should never be in any released package
- */

package/umd/src/llm-providers/_common/utils/cache/CacheItem.d.ts

@@ -28,6 +28,3 @@ export type CacheItem = {
      */
     promptResult: PromptResult;
 };
-/**
- * TODO: [🧠] Should be this exported alongsite `cacheLlmTools` through `@promptbook/utils` OR through `@promptbook/types`
- */

package/umd/src/llm-providers/_common/utils/cache/cacheLlmTools.d.ts

@@ -8,6 +8,7 @@ import type { CacheLlmToolsOptions } from './CacheLlmToolsOptions';
  *
  * @param llmTools LLM tools to be intercepted with usage counting, it can contain extra methods like `totalUsage`
  * @returns Full proxy of LLM tools with same functionality with added caching
+ *
  * @public exported from `@promptbook/core`
  */
 export declare function cacheLlmTools<TLlmTools extends LlmExecutionTools>(llmTools: TLlmTools, options?: Partial<CacheLlmToolsOptions>): TLlmTools;

package/umd/src/llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage.d.ts

@@ -16,7 +16,3 @@ export type LlmExecutionToolsWithTotalUsage = LlmExecutionTools & {
      */
     spending(): Observable<Usage>;
 };
-/**
- * TODO: [👷‍♂️] Write a comprehensive manual about the construction of LLM tools
- * Note: [🥫] Not using getter `get totalUsage` but `getTotalUsage` to allow this object to be proxied
- */

package/umd/src/llm-providers/_common/utils/count-total-usage/countUsage.d.ts

@@ -9,6 +9,7 @@ import type { LlmExecutionToolsWithTotalUsage } from './LlmExecutionToolsWithTot
  *
  * @param llmTools - The LLM tools to be intercepted and tracked
  * @returns Full proxy of the tools with added usage tracking capabilities
+ *
  * @public exported from `@promptbook/core`
  */
 export declare function countUsage<TLlmTools extends LlmExecutionTools>(llmTools: TLlmTools): TLlmTools & LlmExecutionToolsWithTotalUsage;

package/umd/src/llm-providers/_common/utils/count-total-usage/limitTotalUsage.d.ts

@@ -27,10 +27,3 @@ type LimitTotalUsageOptions = {
  */
 export declare function limitTotalUsage(llmTools: LlmExecutionTools, options?: Partial<LimitTotalUsageOptions>): LlmExecutionToolsWithTotalUsage;
 export {};
-/**
- * TODO: Maybe internally use `countTotalUsage`
- * TODO: [🧠][💸] Maybe make some common abstraction `interceptLlmTools` and use here (or use javascript Proxy?)
- * TODO: [🧠] Is there some meaningfull way how to test this util
- * TODO: [🧠][🌯] Maybe a way how to hide ability to `get totalUsage`
- * TODO: [👷‍♂️] Write a comprehensive manual about the construction of LLM tools
- */

package/umd/src/llm-providers/_common/utils/removeUnsupportedModelRequirements.d.ts

@@ -4,6 +4,7 @@ import type { ModelRequirements } from '../../../types/ModelRequirements';
  *
  * @param errorMessage The error message from OpenAI API
  * @returns The parameter name that is unsupported, or null if not an unsupported parameter error
+ *
  * @private utility of LLM Tools
  */
 export declare function parseUnsupportedParameterError(errorMessage: string): string | null;
@@ -13,13 +14,16 @@ export declare function parseUnsupportedParameterError(errorMessage: string): st
  * @param modelRequirements Original model requirements
  * @param unsupportedParameter The parameter to remove
  * @returns New model requirements without the unsupported parameter
+ *
  * @private utility of LLM Tools
  */
 export declare function removeUnsupportedModelRequirement(modelRequirements: ModelRequirements, unsupportedParameter: string): ModelRequirements;
 /**
  * Checks if an error is an "Unsupported value" error from OpenAI
+ *
  * @param error The error to check
  * @returns true if this is an unsupported parameter error
+ *
  * @private utility of LLM Tools
  */
 export declare function isUnsupportedParameterError(error: Error): boolean;

package/umd/src/llm-providers/_multiple/MultipleLlmExecutionTools.d.ts

@@ -8,6 +8,7 @@ import type { string_markdown, string_markdown_text, string_title } from '../../
  * Multiple LLM Execution Tools is a proxy server that uses multiple execution tools internally and exposes the executor interface externally.
  *
  * Note: Internal utility of `joinLlmExecutionTools` but exposed type
+ *
  * @public exported from `@promptbook/core`
  */
 export declare class MultipleLlmExecutionTools implements LlmExecutionTools {

package/umd/src/llm-providers/_multiple/getSingleLlmExecutionTools.d.ts

@@ -6,7 +6,3 @@ import { MultipleLlmExecutionTools } from './MultipleLlmExecutionTools';
  * @public exported from `@promptbook/core`
  */
 export declare function getSingleLlmExecutionTools(oneOrMoreLlmExecutionTools: undefined | LlmExecutionTools | ReadonlyArray<LlmExecutionTools>): LlmExecutionTools | MultipleLlmExecutionTools;
-/**
- * TODO: [🙆] `getSingleLlmExecutionTools` vs `joinLlmExecutionTools` - explain difference or pick one
- * TODO: [👷‍♂️] Write a comprehensive manual about how to construct and use LLM execution tools in Promptbook
- */

package/umd/src/llm-providers/_multiple/joinLlmExecutionTools.d.ts

@@ -8,20 +8,16 @@ import { MultipleLlmExecutionTools } from './MultipleLlmExecutionTools';
  * `MultipleLlmExecutionTools` object. It provides failover and aggregation logic:
  *
  * 1.  **Failover**: When a model call is made, it tries providers in the order they were provided.
- *     If the first provider doesn't support the requested model or fails, it tries the next one.
+ * If the first provider doesn't support the requested model or fails, it tries the next one.
  * 2.  **Aggregation**: `listModels` returns a combined list of all models available from all providers.
  * 3.  **Empty case**: If no tools are provided, it logs a warning (as Promptbook requires LLMs to function).
  *
+ * Tip: You don't have to use this function directly, just pass an array of LlmExecutionTools to the `ExecutionTools`.
+ *
  * @param title - A descriptive title for this collection of joined tools
  * @param llmExecutionTools - An array of execution tools to be joined
  * @returns A single unified execution tool wrapper
  *
- * Tip: You don't have to use this function directly, just pass an array of LlmExecutionTools to the `ExecutionTools`.
- *
  * @public exported from `@promptbook/core`
  */
 export declare function joinLlmExecutionTools(title: string_title & string_markdown_text, ...llmExecutionTools: ReadonlyArray<LlmExecutionTools>): MultipleLlmExecutionTools;
-/**
- * TODO: [🙆] `getSingleLlmExecutionTools` vs `joinLlmExecutionTools` - explain difference or pick one
- * TODO: [👷‍♂️] Write a comprehensive manual about how to construct and use LLM execution tools in Promptbook
- */

package/umd/src/llm-providers/_multiple/playground/playground.d.ts

@@ -1,3 +1,2 @@
 #!/usr/bin/env ts-node
 export {};
-/** Note: [⚫] Code for playground [_multiple playground](src/llm-providers/_multiple/playground/playground.ts) should never be published in any package */

package/umd/src/llm-providers/agent/Agent.d.ts

@@ -94,6 +94,3 @@ export declare class Agent extends AgentLlmExecutionTools implements LlmExecutio
      */
     callChatModelStream(prompt: Prompt, onProgress: (chunk: ChatPromptResult) => void, options?: CallChatModelStreamOptions): Promise<ChatPromptResult>;
 }
-/**
- * TODO: [🧠][😰]Agent is not working with the parameters, should it be?
- */

package/umd/src/llm-providers/agent/AgentLlmExecutionTools.d.ts

@@ -85,7 +85,3 @@ export declare class AgentLlmExecutionTools implements LlmExecutionTools {
      */
     callChatModelStream(prompt: Prompt, onProgress: (chunk: ChatPromptResult) => void, options?: CallChatModelStreamOptions): Promise<ChatPromptResult>;
 }
-/**
- * TODO: [🍚] Implement Destroyable pattern to free resources
- * TODO: [🧠] Adding parameter substitution support (here or should be responsibility of the underlying LLM Tools)
- */

package/umd/src/llm-providers/agent/RemoteAgent.d.ts

@@ -58,7 +58,3 @@ export declare class RemoteAgent extends Agent {
     }>) | undefined;
     callChatModelStream(prompt: Prompt, onProgress: (chunk: ChatPromptResult) => void, options?: CallChatModelStreamOptions): Promise<ChatPromptResult>;
 }
-/**
- * TODO: [🧠][😰]Agent is not working with the parameters, should it be?
- * TODO: !!! Agent on remote server
- */

package/umd/src/llm-providers/agent/playground/playground.d.ts

@@ -1,8 +1,2 @@
 #!/usr/bin/env ts-node
 export {};
-/** Note: [⚫] Code for playground [agent playground](src/llm-providers/agent/playground/playground.ts) should never be published in any package */
-/**
- * TODO: [🧠] Add more complex agent scenarios
- * TODO: [🧠] Add parameter substitution demo
- * TODO: [🧠] Add multi-turn conversation demo
- */