@promptbook/javascript 0.112.0-34 → 0.112.0-35

package/umd/src/commitments/META_VOICE/META_VOICE.d.ts

@@ -34,6 +34,3 @@ export declare class MetaVoiceCommitmentDefinition extends BaseCommitmentDefinit
      */
     extractVoiceId(content: string): string | null;
 }
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/umd/src/commitments/MODEL/MODEL.d.ts

@@ -53,6 +53,3 @@ export declare class ModelCommitmentDefinition extends BaseCommitmentDefinition<
      */
     private parseLegacyFormat;
 }
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/umd/src/commitments/OPEN/OPEN.d.ts

@@ -30,6 +30,3 @@ export declare class OpenCommitmentDefinition extends BaseCommitmentDefinition<'
     get documentation(): string;
     applyToAgentModelRequirements(requirements: AgentModelRequirements, _content: string): AgentModelRequirements;
 }
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/umd/src/commitments/PERSONA/PERSONA.d.ts

@@ -39,6 +39,3 @@ export declare class PersonaCommitmentDefinition extends BaseCommitmentDefinitio
     get documentation(): string;
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
 }
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/umd/src/commitments/RULE/RULE.d.ts

@@ -31,6 +31,3 @@ export declare class RuleCommitmentDefinition extends BaseCommitmentDefinition<'
     get documentation(): string;
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
 }
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/umd/src/commitments/SAMPLE/SAMPLE.d.ts

@@ -31,6 +31,3 @@ export declare class SampleCommitmentDefinition extends BaseCommitmentDefinition
     get documentation(): string;
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
 }
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/umd/src/commitments/SCENARIO/SCENARIO.d.ts

@@ -33,6 +33,3 @@ export declare class ScenarioCommitmentDefinition extends BaseCommitmentDefiniti
     get documentation(): string;
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
 }
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/umd/src/commitments/TEAM/TEAM.d.ts

@@ -40,6 +40,3 @@ export declare class TeamCommitmentDefinition extends BaseCommitmentDefinition<'
      */
     getToolFunctions(): Record<string_javascript_name, ToolFunction>;
 }
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/umd/src/commitments/TEMPLATE/TEMPLATE.d.ts

@@ -39,6 +39,3 @@ export declare class TemplateCommitmentDefinition extends BaseCommitmentDefiniti
     get requiresContent(): boolean;
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
 }
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/umd/src/commitments/USE/USE.d.ts

@@ -48,6 +48,3 @@ export declare class UseCommitmentDefinition extends BaseCommitmentDefinition<`U
      */
     isKnownUseType(useType: string): boolean;
 }
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/umd/src/commitments/USE/aggregateUseCommitmentSystemMessages.d.ts

@@ -13,6 +13,7 @@ type AggregatedUseCommitmentType = 'USE BROWSER' | 'USE SEARCH ENGINE' | 'USE TI
  * @param requirements - Current model requirements.
  * @param type - Aggregated `USE` commitment type being applied.
  * @returns Requirements with the placeholder inserted when it was not already present.
+ *
  * @private internal utility of `USE` commitments
  */
 export declare function appendAggregatedUseCommitmentPlaceholder(requirements: AgentModelRequirements, type: AggregatedUseCommitmentType): AgentModelRequirements;
@@ -24,6 +25,7 @@ export declare function appendAggregatedUseCommitmentPlaceholder(requirements: A
  * @param requirements - Model requirements produced by commitment-by-commitment application.
  * @param commitments - Filtered commitments in their original source order.
  * @returns Requirements with aggregated `USE` system-message sections.
+ *
  * @private internal utility of `createAgentModelRequirementsWithCommitments`
  */
 export declare function aggregateUseCommitmentSystemMessages(requirements: AgentModelRequirements, commitments: ReadonlyArray<ParsedCommitment>): AgentModelRequirements;

package/umd/src/commitments/USE_BROWSER/USE_BROWSER.d.ts

@@ -56,6 +56,3 @@ export declare class UseBrowserCommitmentDefinition extends BaseCommitmentDefini
      */
     getToolFunctions(): Record<string_javascript_name, ToolFunction>;
 }
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/umd/src/commitments/USE_BROWSER/fetchUrlContent.d.ts

@@ -7,14 +7,13 @@
  * 3. Uses the appropriate scraper to convert to markdown
  * 4. Returns the scraped markdown content
  *
+ * WARNING: This function should NOT be used directly in browser environments.
+ * For browser environments, use fetchUrlContentViaBrowser which proxies through
+ * the Agents Server API endpoint at /api/scrape
+ *
  * @param url The URL to fetch and scrape
  * @returns Markdown content from the URL
  *
  * @private internal utility for USE BROWSER commitment
- *
- * WARNING: This function should NOT be used directly in browser environments.
- * For browser environments, use fetchUrlContentViaBrowser which proxies through
- * the Agents Server API endpoint at /api/scrape
  */
 export declare function fetchUrlContent(url: string): Promise<string>;
-/** Note: [🟢] Code for Node browser-fetch helper [fetchUrlContent](src/commitments/USE_BROWSER/fetchUrlContent.ts) should never be published into packages that could be imported into browser environment */

package/umd/src/commitments/USE_CALENDAR/USE_CALENDAR.d.ts

@@ -37,6 +37,3 @@ export declare class UseCalendarCommitmentDefinition extends BaseCommitmentDefin
      */
     getToolFunctions(): Record<string_javascript_name, ToolFunction>;
 }
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/umd/src/commitments/USE_CALENDAR/calendarReference.d.ts

@@ -63,6 +63,3 @@ export declare function extractUseCalendarReferencesFromCommitments(commitments:
  * @private internal utility of USE CALENDAR commitment
  */
 export declare function parseGoogleCalendarIdFromUrl(url: URL): string | null;
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/umd/src/commitments/USE_EMAIL/USE_EMAIL.d.ts

@@ -36,6 +36,3 @@ export declare class UseEmailCommitmentDefinition extends BaseCommitmentDefiniti
      */
     getToolFunctions(): Record<string_javascript_name, ToolFunction>;
 }
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/umd/src/commitments/USE_IMAGE_GENERATOR/USE_IMAGE_GENERATOR.d.ts

@@ -32,6 +32,3 @@ export declare class UseImageGeneratorCommitmentDefinition extends BaseCommitmen
     get documentation(): string;
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
 }
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/umd/src/commitments/USE_MCP/USE_MCP.d.ts

@@ -32,6 +32,3 @@ export declare class UseMcpCommitmentDefinition extends BaseCommitmentDefinition
     get documentation(): string;
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
 }
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/umd/src/commitments/USE_POPUP/USE_POPUP.d.ts

@@ -44,6 +44,3 @@ export declare class UsePopupCommitmentDefinition extends BaseCommitmentDefiniti
      */
     getToolFunctions(): Record<string_javascript_name, ToolFunction>;
 }
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/umd/src/commitments/USE_PRIVACY/USE_PRIVACY.d.ts

@@ -34,6 +34,3 @@ export declare class UsePrivacyCommitmentDefinition extends BaseCommitmentDefini
      */
     getToolFunctions(): Record<string_javascript_name, ToolFunction>;
 }
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/umd/src/commitments/USE_PROJECT/USE_PROJECT.d.ts

@@ -37,6 +37,3 @@ export declare class UseProjectCommitmentDefinition extends BaseCommitmentDefini
      */
     getToolFunctions(): Record<string_javascript_name, ToolFunction>;
 }
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/umd/src/commitments/USE_PROJECT/projectReference.d.ts

@@ -47,6 +47,3 @@ export declare function extractUseProjectRepositoryUrlsFromCommitments(commitmen
     type: string;
     content: string;
 }>): string[];
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/umd/src/commitments/USE_SEARCH_ENGINE/USE_SEARCH_ENGINE.d.ts

@@ -44,6 +44,3 @@ export declare class UseSearchEngineCommitmentDefinition extends BaseCommitmentD
      */
     getToolFunctions(): Record<string_javascript_name, ToolFunction>;
 }
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/umd/src/commitments/USE_SPAWN/USE_SPAWN.d.ts

@@ -36,6 +36,3 @@ export declare class UseSpawnCommitmentDefinition extends BaseCommitmentDefiniti
      */
     getToolFunctions(): Record<string_javascript_name, ToolFunction>;
 }
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/umd/src/commitments/USE_TIME/USE_TIME.d.ts

@@ -41,6 +41,3 @@ export declare class UseTimeCommitmentDefinition extends BaseCommitmentDefinitio
      */
     getToolFunctions(): Record<string_javascript_name, ToolFunction>;
 }
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/umd/src/commitments/USE_TIMEOUT/USE_TIMEOUT.d.ts

@@ -36,6 +36,3 @@ export declare class UseTimeoutCommitmentDefinition extends BaseCommitmentDefini
      */
     getToolFunctions(): Record<string_javascript_name, ToolFunction>;
 }
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/umd/src/commitments/USE_USER_LOCATION/USE_USER_LOCATION.d.ts

@@ -34,6 +34,3 @@ export declare class UseUserLocationCommitmentDefinition extends BaseCommitmentD
      */
     getToolFunctions(): Record<string_javascript_name, ToolFunction>;
 }
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/umd/src/commitments/WALLET/WALLET.d.ts

@@ -19,6 +19,3 @@ export declare class WalletCommitmentDefinition extends BaseCommitmentDefinition
     getToolTitles(): Record<string_javascript_name, string>;
     getToolFunctions(): Record<string_javascript_name, ToolFunction>;
 }
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/umd/src/commitments/WRITING_RULES/WRITING_RULES.d.ts

@@ -24,6 +24,3 @@ export declare class WritingRulesCommitmentDefinition extends BaseCommitmentDefi
     get documentation(): string;
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
 }
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/umd/src/commitments/WRITING_SAMPLE/WRITING_SAMPLE.d.ts

@@ -24,6 +24,3 @@ export declare class WritingSampleCommitmentDefinition extends BaseCommitmentDef
     get documentation(): string;
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
 }
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/umd/src/commitments/_base/createEmptyAgentModelRequirements.d.ts

@@ -14,6 +14,3 @@ export declare function createEmptyAgentModelRequirements(): AgentModelRequireme
  * @public exported from `@promptbook/core`
  */
 export declare function createBasicAgentModelRequirements(agentName: string | null): AgentModelRequirements;
-/**
- * TODO: [🐤] Deduplicate `AgentModelRequirements` and `ModelRequirements` model requirements
- */

package/umd/src/commitments/_common/commitmentToolFunctions.d.ts

@@ -10,6 +10,7 @@ export type CommitmentToolFunctions = Record<string_javascript_name, ToolFunctio
  * Collects tool functions from all commitment definitions.
  *
  * @returns Map of tool function implementations.
+ *
  * @private internal helper for commitment tool registry
  */
 export declare function collectCommitmentToolFunctions(): CommitmentToolFunctions;
@@ -18,9 +19,7 @@ export declare function collectCommitmentToolFunctions(): CommitmentToolFunction
  *
  * @param getFunctions - Provider of current tool functions.
  * @returns Proxy exposing tool functions as properties.
+ *
  * @private internal helper for commitment tool registry
  */
 export declare function createToolFunctionsProxy(getFunctions: () => CommitmentToolFunctions): CommitmentToolFunctions;
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/umd/src/commitments/_common/createWritingCommitmentSections.d.ts

@@ -3,6 +3,7 @@
  *
  * @param content - Explicit 1:1 sample text.
  * @returns Writing-sample guidance ready for one system-message section.
+ *
  * @private internal utility of writing commitments
  */
 export declare function createWritingSampleSection(content: string): string;
@@ -11,9 +12,7 @@ export declare function createWritingSampleSection(content: string): string;
  *
  * @param content - Writing-only instructions.
  * @returns Writing-rules guidance ready for one system-message section.
+ *
  * @private internal utility of writing commitments
  */
 export declare function createWritingRulesSection(content: string): string;
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/umd/src/commitments/_common/getAllCommitmentDefinitions.d.ts

@@ -1,6 +1,7 @@
 import type { CommitmentDefinition } from '../_base/CommitmentDefinition';
 /**
  * Gets all available commitment definitions
+ *
  * @returns Array of all commitment definitions
  *
  * @public exported from `@promptbook/core`

package/umd/src/commitments/_common/getAllCommitmentTypes.d.ts

@@ -1,6 +1,7 @@
 import type { BookCommitment } from '../_base/BookCommitment';
 /**
  * Gets all available commitment types
+ *
  * @returns Array of all commitment types
  *
  * @public exported from `@promptbook/core`

package/umd/src/commitments/_common/getAllCommitmentsToolFunctionsForNode.d.ts

@@ -7,7 +7,3 @@ import { type CommitmentToolFunctions } from './commitmentToolFunctions';
  * @public exported from `@promptbook/node`
  */
 export declare function getAllCommitmentsToolFunctionsForNode(): CommitmentToolFunctions;
-/**
- * Note: [??] Code in this file should never be never released in packages that could be imported into browser environment
- * TODO: [??] Unite `xxxForServer` and `xxxForNode` naming
- */

package/umd/src/commitments/_common/getCommitmentDefinition.d.ts

@@ -2,6 +2,7 @@ import type { BookCommitment } from '../_base/BookCommitment';
 import type { CommitmentDefinition } from '../_base/CommitmentDefinition';
 /**
  * Gets a commitment definition by its type
+ *
  * @param type The commitment type to look up
  * @returns The commitment definition or null if not found
  *

package/umd/src/commitments/_common/isCommitmentSupported.d.ts

@@ -1,6 +1,7 @@
 import type { BookCommitment } from '../_base/BookCommitment';
 /**
  * Checks if a commitment type is supported
+ *
  * @param type The commitment type to check
  * @returns True if the commitment type is supported
  *

package/umd/src/commitments/_common/toolExecutionEnvelope.d.ts

@@ -17,6 +17,3 @@ export declare function parseToolExecutionEnvelope(rawValue: unknown): {
     assistantMessage: string;
     toolResult: TODO_any;
 } | null;
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/umd/src/commitments/_common/toolRuntimeContext.d.ts

@@ -144,6 +144,7 @@ export declare function serializeToolRuntimeContext(context: ToolRuntimeContext)
  *
  * @param listener - Listener notified about tool progress.
  * @returns Hidden token used to route progress updates.
+ *
  * @private internal runtime wiring for commitment tools
  */
 export declare function registerToolCallProgressListener(listener: ToolCallProgressListener): string;
@@ -151,6 +152,7 @@ export declare function registerToolCallProgressListener(listener: ToolCallProgr
  * Unregisters one in-memory progress listener.
  *
  * @param token - Token previously created by `registerToolCallProgressListener`.
+ *
  * @private internal runtime wiring for commitment tools
  */
 export declare function unregisterToolCallProgressListener(token: string): void;
@@ -160,10 +162,8 @@ export declare function unregisterToolCallProgressListener(token: string): void;
  * @param args - Raw tool arguments including hidden runtime keys.
  * @param update - Incremental progress update.
  * @returns `true` when a listener was found and notified.
+ *
  * @private internal runtime wiring for commitment tools
  */
 export declare function emitToolCallProgressFromToolArgs(args: Record<string, TODO_any>, update: ToolCallProgressUpdate): boolean;
 export {};
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

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

@@ -60,7 +60,3 @@ import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplemented
  * @private Use functions to access commitments instead of this array directly
  */
 export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, MemoryCommitmentDefinition, MemoryCommitmentDefinition, StyleCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, LanguageCommitmentDefinition, LanguageCommitmentDefinition, WritingSampleCommitmentDefinition, WritingRulesCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, TemplateCommitmentDefinition, TemplateCommitmentDefinition, FromCommitmentDefinition, ImportCommitmentDefinition, ImportCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, ComponentCommitmentDefinition, MetaImageCommitmentDefinition, MetaColorCommitmentDefinition, MetaFontCommitmentDefinition, MetaLinkCommitmentDefinition, MetaDomainCommitmentDefinition, MetaDisclaimerCommitmentDefinition, MetaInputPlaceholderCommitmentDefinition, MetaCommitmentDefinition, MetaVoiceCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, InitialMessageCommitmentDefinition, UserMessageCommitmentDefinition, InternalMessageCommitmentDefinition, AgentMessageCommitmentDefinition, MessageSuffixCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DictionaryCommitmentDefinition, OpenCommitmentDefinition, ClosedCommitmentDefinition, TeamCommitmentDefinition, UseBrowserCommitmentDefinition, UseSearchEngineCommitmentDefinition, UseSpawnCommitmentDefinition, UseTimeoutCommitmentDefinition, UseTimeCommitmentDefinition, UseUserLocationCommitmentDefinition, UseCalendarCommitmentDefinition, UseEmailCommitmentDefinition, UsePopupCommitmentDefinition, UseImageGeneratorCommitmentDefinition, UseMcpCommitmentDefinition, UsePrivacyCommitmentDefinition, UseProjectCommitmentDefinition, UseCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
-/**
- * TODO: [🧠] Maybe create through standardized $register
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/umd/src/config.test.d.ts

@@ -1,4 +1 @@
 export {};
-/**
- * TODO: [🧠] Maybe more elegant how to prevent accidental costs
- */

package/umd/src/constants/streaming.d.ts

@@ -15,6 +15,3 @@ export declare const CHAT_STREAM_KEEP_ALIVE_TOKEN = "STREAM_KEEP_ALIVE";
  * @private internal streaming helper for Promptbook chat connections
  */
 export declare const CHAT_STREAM_KEEP_ALIVE_INTERVAL_MS = 25000;
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/umd/src/constants.d.ts

@@ -206,6 +206,3 @@ export declare const HTTP_STATUS_CODES: {
     readonly GATEWAY_TIMEOUT: 504;
     readonly TOO_MANY_REQUESTS: 429;
 };
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/umd/src/conversion/archive/loadArchive.d.ts

@@ -11,4 +11,3 @@ import type { string_filename } from '../../types/typeAliases';
  * @private utility of Promptbook
  */
 export declare function loadArchive(filePath: string_filename, fs: FilesystemTools): Promise<ReadonlyArray<PipelineJson>>;
-/** Note: [🟢] Code for Node archive helper [loadArchive](src/conversion/archive/loadArchive.ts) should never be published into packages that could be imported into browser environment */

package/umd/src/conversion/archive/saveArchive.d.ts

@@ -11,8 +11,3 @@ import type { string_filename } from '../../types/typeAliases';
  * @private utility of Promptbook
  */
 export declare function saveArchive(filePath: string_filename, collectionJson: ReadonlyArray<PipelineJson>, fs: FilesystemTools): Promise<void>;
-/** Note: [🟢] Code for Node archive helper [saveArchive](src/conversion/archive/saveArchive.ts) should never be published into packages that could be imported into browser environment */
-/**
- * TODO: Add metadata to zip
- * TODO: Compression level and other zip options from config
- */

package/umd/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/umd/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/umd/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/umd/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/umd/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/umd/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/umd/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/umd/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/umd/src/conversion/validation/pipelineStringToJson-parseErrors.test.d.ts

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

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

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

package/umd/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
- */