@promptbook/types 0.112.0-34 → 0.112.0-36

package/esm/src/book-components/icons/CameraIcon.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Props for camera icon.
+ */
 type CameraIconProps = {
     size?: number;
     color?: string;
@@ -9,6 +12,7 @@ type CameraIconProps = {
  * or selection.
  *
  * @param props - SVG properties augmented with an optional `size`
+ *
  * @private internal subcomponent used by various components
  */
 export declare function CameraIcon({ size, color }: CameraIconProps): import("react/jsx-runtime").JSX.Element;

package/esm/src/book-components/icons/DownloadIcon.d.ts

@@ -6,6 +6,7 @@ import { SVGProps } from 'react';
  * of files or assets.
  *
  * @param props - SVG properties augmented with an optional `size`
+ *
  * @private internal subcomponent used by various components
  */
 export declare function DownloadIcon(props: SVGProps<SVGSVGElement> & {

package/esm/src/book-components/icons/EmailIcon.d.ts

@@ -9,6 +9,7 @@ type EmailIconProps = {
  * Renders an email/envelope icon.
  *
  * @param props - SVG properties augmented with an optional `size`
+ *
  * @private internal subcomponent used by various components
  */
 export declare function EmailIcon({ size, color }: EmailIconProps): import("react/jsx-runtime").JSX.Element;

package/esm/src/book-components/icons/MenuIcon.d.ts

@@ -6,11 +6,9 @@ import { SVGProps } from 'react';
  * navigation menus or dropdowns.
  *
  * @param props - SVG properties augmented with an optional `size`
+ *
  * @private internal subcomponent used by various components
  */
 export declare function MenuIcon(props: SVGProps<SVGSVGElement> & {
     size?: number;
 }): import("react/jsx-runtime").JSX.Element;
-/**
- * TODO: !!! Mark all components to not be used outside of browser
- */

package/esm/src/book-components/icons/SaveIcon.d.ts

@@ -6,6 +6,7 @@ import React from 'react';
  * configurations, or agent sources.
  *
  * @param props - SVG properties augmented with an optional `size`
+ *
  * @private internal subcomponent used by various components
  */
 export declare function SaveIcon({ size, color, ...props }: {

package/esm/src/book-components/icons/SendIcon.d.ts

@@ -6,6 +6,3 @@
 export declare const SendIcon: ({ size }: {
     size: number;
 }) => import("react/jsx-runtime").JSX.Element;
-/**
- * TODO: !!!! Search ACRY for "currentColor", it probably does not work and make no sense to have it in project
- */

package/esm/src/book-components/icons/TeacherIcon.d.ts

@@ -9,6 +9,7 @@ type TeacherIconProps = {
  * Renders a teacher/graduation cap icon.
  *
  * @param props - SVG properties augmented with an optional `size`
+ *
  * @private internal subcomponent used by various components
  */
 export declare function TeacherIcon({ size, color }: TeacherIconProps): import("react/jsx-runtime").JSX.Element;

package/esm/src/cli/$runPromptbookCli.d.ts

@@ -4,4 +4,3 @@
  * @private internal utility of Promptbook CLI bootstrap
  */
 export declare function $runPromptbookCli(): Promise<void>;
-/** Note: [🟡] Code for CLI bootstrap [$runPromptbookCli](src/cli/$runPromptbookCli.ts) should never be published outside of `@promptbook/cli` */

package/esm/src/cli/cli-commands/_boilerplate.d.ts

@@ -8,5 +8,3 @@ import type { $side_effect } from '../../utils/organization/$side_effect';
  * @private internal function of `promptbookCli`
  */
 export declare function $initializeBoilerplateCommand(program: Program): $side_effect;
-/** Note: [🟡] Code for CLI command [_boilerplate](src/cli/cli-commands/_boilerplate.ts) should never be published outside of `@promptbook/cli` */
-/** Note: [💞] Ignore a discrepancy between file name and entity name */

package/esm/src/cli/cli-commands/about.d.ts

@@ -8,9 +8,3 @@ import type { $side_effect } from '../../utils/organization/$side_effect';
  * @private internal function of `promptbookCli`
  */
 export declare function $initializeAboutCommand(program: Program): $side_effect;
-/** Note: [🟡] Code for CLI command [about](src/cli/cli-commands/about.ts) should never be published outside of `@promptbook/cli` */
-/**
- * TODO: [🕋] Use here `aboutPromptbookInformation`
- * TODO: [🗽] Unite branding and make single place for it
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/esm/src/cli/cli-commands/coder/ThinkingLevel.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Supported thinking-level CLI values for coding-agent runners with configurable reasoning effort.
+ *
+ * @private internal shared utility of `ptbk coder run`
+ */
+export declare const THINKING_LEVEL_VALUES: readonly ["low", "medium", "high", "xhigh"];
+/**
+ * Supported reasoning effort values for coding-agent runners with configurable thinking levels.
+ *
+ * @private internal shared utility of `ptbk coder run`
+ */
+export type ThinkingLevel = (typeof THINKING_LEVEL_VALUES)[number];
+/**
+ * Parses and validates an optional thinking-level option value.
+ *
+ * @private internal shared utility of `ptbk coder run`
+ */
+export declare function parseThinkingLevel(thinkingLevelValue: string | undefined): ThinkingLevel | undefined;

package/esm/src/cli/cli-commands/coder/boilerplateTemplates.d.ts

@@ -0,0 +1,127 @@
+/**
+ * Relative path to the root prompts directory used by Promptbook coder utilities.
+ *
+ * @private internal utility of `ptbk coder`
+ */
+export declare const PROMPTS_DIRECTORY_PATH = "prompts";
+/**
+ * Relative path to the archive directory used by `coder verify`.
+ *
+ * @private internal utility of `ptbk coder`
+ */
+export declare const PROMPTS_DONE_DIRECTORY_PATH: string;
+/**
+ * Relative path to the project-owned boilerplate templates directory.
+ *
+ * @private internal utility of `ptbk coder`
+ */
+export declare const PROMPTS_TEMPLATES_DIRECTORY_PATH: string;
+/**
+ * Initialization statuses used when creating or updating coder configuration artifacts.
+ *
+ * @private internal utility of `ptbk coder`
+ */
+export type InitializationStatus = 'created' | 'updated' | 'unchanged';
+/**
+ * Identifiers of built-in coder boilerplate templates.
+ *
+ * @private internal utility of `ptbk coder`
+ */
+export type BuiltInCoderPromptTemplate = 'common' | 'agents-server';
+/**
+ * One built-in coder boilerplate template definition.
+ *
+ * @private internal utility of `ptbk coder`
+ */
+export type CoderPromptTemplateDefinition = {
+    /**
+     * Stable built-in identifier that can also be used as a CLI shorthand.
+     */
+    readonly id: BuiltInCoderPromptTemplate;
+    /**
+     * Project-relative path where `ptbk coder init` materializes the template file.
+     */
+    readonly relativeFilePath: string;
+    /**
+     * Prefix inserted into generated prompt file slugs.
+     */
+    readonly slugPrefix: string | null;
+    /**
+     * Markdown content of the template.
+     */
+    readonly content: string;
+};
+/**
+ * Result of ensuring one default coder template file exists inside a project.
+ *
+ * @private internal utility of `ptbk coder`
+ */
+export type EnsuredCoderPromptTemplateFile = {
+    /**
+     * Stable built-in identifier of the template.
+     */
+    readonly id: BuiltInCoderPromptTemplate;
+    /**
+     * Project-relative path of the materialized template file.
+     */
+    readonly relativeFilePath: string;
+    /**
+     * Status describing whether the file had to be created.
+     */
+    readonly status: InitializationStatus;
+};
+/**
+ * Fully resolved boilerplate template used by `coder generate-boilerplates`.
+ *
+ * @private internal utility of `ptbk coder`
+ */
+export type ResolvedCoderPromptTemplate = {
+    /**
+     * Identifier or relative file path that was resolved.
+     */
+    readonly identifier: string;
+    /**
+     * Project-relative path when the template corresponds to a project file.
+     */
+    readonly relativeFilePath?: string;
+    /**
+     * Markdown content of the resolved template.
+     */
+    readonly content: string;
+    /**
+     * Prefix inserted into generated prompt file slugs.
+     */
+    readonly slugPrefix: string | null;
+};
+/**
+ * Lists the built-in coder boilerplate templates.
+ *
+ * @private internal utility of `ptbk coder`
+ */
+export declare function getDefaultCoderPromptTemplateDefinitions(): ReadonlyArray<CoderPromptTemplateDefinition>;
+/**
+ * Resolves one built-in coder boilerplate template definition by its stable identifier.
+ *
+ * @private internal utility of `ptbk coder`
+ */
+export declare function getDefaultCoderPromptTemplateDefinition(template: BuiltInCoderPromptTemplate): CoderPromptTemplateDefinition;
+/**
+ * Ensures the default project-owned coder template files exist without overwriting user customizations.
+ *
+ * @private internal utility of `ptbk coder`
+ */
+export declare function ensureDefaultCoderPromptTemplateFiles(projectPath: string): Promise<ReadonlyArray<EnsuredCoderPromptTemplateFile>>;
+/**
+ * Resolves the template requested by `coder generate-boilerplates`.
+ *
+ * Supports three modes:
+ * - omitted option => built-in `common`
+ * - built-in alias => one of the shared default templates
+ * - relative path => markdown template file resolved from the project root
+ *
+ * @private internal utility of `ptbk coder`
+ */
+export declare function resolveCoderPromptTemplate({ projectPath, templateOption, }: {
+    readonly projectPath: string;
+    readonly templateOption?: string;
+}): Promise<ResolvedCoderPromptTemplate>;

package/esm/src/cli/cli-commands/coder/boilerplateTemplates.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/src/cli/cli-commands/coder/find-fresh-emoji-tags.d.ts

@@ -8,5 +8,3 @@ import type { $side_effect } from '../../../utils/organization/$side_effect';
  * @private internal function of `promptbookCli`
  */
 export declare function $initializeCoderFindFreshEmojiTagCommand(program: Program): $side_effect;
-/** Note: [🟡] Code for CLI command [find-fresh-emoji-tags](src/cli/cli-commands/coder/find-fresh-emoji-tags.ts) should never be published outside of `@promptbook/cli` */
-/** Note: [💞] Ignore a discrepancy between file name and entity name */

package/esm/src/cli/cli-commands/coder/find-refactor-candidates.d.ts

@@ -8,5 +8,3 @@ import type { $side_effect } from '../../../utils/organization/$side_effect';
  * @private internal function of `promptbookCli`
  */
 export declare function $initializeCoderFindRefactorCandidatesCommand(program: Program): $side_effect;
-/** Note: [🟡] Code for CLI command [find-refactor-candidates](src/cli/cli-commands/coder/find-refactor-candidates.ts) should never be published outside of `@promptbook/cli` */
-/** Note: [💞] Ignore a discrepancy between file name and entity name */

package/esm/src/cli/cli-commands/coder/generate-boilerplates.d.ts

@@ -8,5 +8,13 @@ import type { $side_effect } from '../../../utils/organization/$side_effect';
  * @private internal function of `promptbookCli`
  */
 export declare function $initializeCoderGenerateBoilerplatesCommand(program: Program): $side_effect;
-/** Note: [🟡] Code for CLI command [generate-boilerplates](src/cli/cli-commands/coder/generate-boilerplates.ts) should never be published outside of `@promptbook/cli` */
-/** Note: [💞] Ignore a discrepancy between file name and entity name */
+/**
+ * Generates boilerplate prompt files with unique emoji tags.
+ *
+ * @private internal function of `generatePromptBoilerplate` command
+ */
+export declare function generatePromptBoilerplate({ projectPath, filesCount, templateOption, }: {
+    readonly projectPath: string;
+    readonly filesCount: number;
+    readonly templateOption?: string;
+}): Promise<void>;

package/esm/src/cli/cli-commands/coder/init.d.ts

@@ -1,5 +1,24 @@
 import type { Command as Program } from 'commander';
 import type { $side_effect } from '../../../utils/organization/$side_effect';
+import { type EnsuredCoderPromptTemplateFile, type InitializationStatus } from './boilerplateTemplates';
+/**
+ * Generic JSON object used for standalone coder configuration files.
+ */
+type JsonObject = Record<string, unknown>;
+/**
+ * Result summary returned after coder configuration initialization.
+ */
+type CoderInitializationSummary = {
+    readonly promptsDirectoryStatus: InitializationStatus;
+    readonly promptsDoneDirectoryStatus: InitializationStatus;
+    readonly promptsTemplatesDirectoryStatus: InitializationStatus;
+    readonly promptTemplateFileStatuses: ReadonlyArray<EnsuredCoderPromptTemplateFile>;
+    readonly envFileStatus: InitializationStatus;
+    readonly gitignoreFileStatus: InitializationStatus;
+    readonly packageJsonFileStatus: InitializationStatus;
+    readonly vscodeSettingsFileStatus: InitializationStatus;
+    readonly initializedEnvVariableNames: ReadonlyArray<string>;
+};
 /**
  * Initializes `coder init` command for Promptbook CLI utilities.
  *
@@ -8,5 +27,22 @@ import type { $side_effect } from '../../../utils/organization/$side_effect';
  * @private internal function of `promptbookCli`
  */
 export declare function $initializeCoderInitCommand(program: Program): $side_effect;
-/** Note: [🟡] Code for CLI command [init](src/cli/cli-commands/coder/init.ts) should never be published outside of `@promptbook/cli` */
-/** Note: [💞] Ignore a discrepancy between file name and entity name */
+/**
+ * Lists the default npm scripts initialized by `ptbk coder init`.
+ *
+ * @private internal utility of `coder init` command
+ */
+export declare function getDefaultCoderPackageJsonScripts(): Readonly<Record<string, string>>;
+/**
+ * Lists the default VS Code settings initialized by `ptbk coder init`.
+ *
+ * @private internal utility of `coder init` command
+ */
+export declare function getDefaultCoderVscodeSettings(): Readonly<JsonObject>;
+/**
+ * Creates or updates all coder configuration artifacts required in the current project.
+ *
+ * @private internal utility of `coder init` command
+ */
+export declare function initializeCoderProjectConfiguration(projectPath: string): Promise<CoderInitializationSummary>;
+export {};

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

@@ -1,4 +1,4 @@
-import type { Command as Program } from 'commander';
+import { Command as Program } from 'commander';
 import type { $side_effect } from '../../../utils/organization/$side_effect';
 /**
  * Initializes `coder run` command for Promptbook CLI utilities
@@ -8,5 +8,3 @@ import type { $side_effect } from '../../../utils/organization/$side_effect';
  * @private internal function of `promptbookCli`
  */
 export declare function $initializeCoderRunCommand(program: Program): $side_effect;
-/** Note: [🟡] Code for CLI command [run](src/cli/cli-commands/coder/run.ts) should never be published outside of `@promptbook/cli` */
-/** Note: [💞] Ignore a discrepancy between file name and entity name */

package/esm/src/cli/cli-commands/coder/run.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/src/cli/cli-commands/coder/verify.d.ts

@@ -8,5 +8,3 @@ import type { $side_effect } from '../../../utils/organization/$side_effect';
  * @private internal function of `promptbookCli`
  */
 export declare function $initializeCoderVerifyCommand(program: Program): $side_effect;
-/** Note: [🟡] Code for CLI command [verify](src/cli/cli-commands/coder/verify.ts) should never be published outside of `@promptbook/cli` */
-/** Note: [💞] Ignore a discrepancy between file name and entity name */

package/esm/src/cli/cli-commands/coder.d.ts

@@ -16,5 +16,3 @@ import type { $side_effect } from '../../utils/organization/$side_effect';
  * @private internal function of `promptbookCli`
  */
 export declare function $initializeCoderCommand(program: Program): $side_effect;
-/** Note: [🟡] Code for CLI command [coder](src/cli/cli-commands/coder.ts) should never be published outside of `@promptbook/cli` */
-/** Note: [💞] Ignore a discrepancy between file name and entity name */

package/esm/src/cli/cli-commands/common/handleActionErrors.d.ts

@@ -1,10 +1,14 @@
 import type { Command as Program } from 'commander';
+/**
+ * Type describing action callback function.
+ */
 type actionCallbackFunction = Parameters<Program['action']>[0];
 /**
  * Wraps action to handle error console logging and exit process with error code
  *
  * @param action Action to be wrapped in error handling
  * @returns Wrapped action
+ *
  * @private internal helper function for CLI commands
  */
 export declare function handleActionErrors(action: actionCallbackFunction): actionCallbackFunction;

package/esm/src/cli/cli-commands/hello.d.ts

@@ -8,8 +8,3 @@ import type { $side_effect } from '../../utils/organization/$side_effect';
  * @private internal function of `promptbookCli`
  */
 export declare function $initializeHelloCommand(program: Program): $side_effect;
-/** Note: [🟡] Code for CLI command [hello](src/cli/cli-commands/hello.ts) should never be published outside of `@promptbook/cli` */
-/**
- * TODO: [🧠][🐣] Make here some easter egg with generated hello greeting via LLM models
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/esm/src/cli/cli-commands/list-models.d.ts

@@ -8,5 +8,3 @@ import type { $side_effect } from '../../utils/organization/$side_effect';
  * @private internal function of `promptbookCli`
  */
 export declare function $initializeListModelsCommand(program: Program): $side_effect;
-/** Note: [🟡] Code for CLI command [list-models](src/cli/cli-commands/list-models.ts) should never be published outside of `@promptbook/cli` */
-/** Note: [💞] Ignore a discrepancy between file name and entity name */

package/esm/src/cli/cli-commands/list-scrapers.d.ts

@@ -8,5 +8,3 @@ import type { $side_effect } from '../../utils/organization/$side_effect';
  * @private internal function of `promptbookCli`
  */
 export declare function $initializeListScrapersCommand(program: Program): $side_effect;
-/** Note: [🟡] Code for CLI command [list-scrapers](src/cli/cli-commands/list-scrapers.ts) should never be published outside of `@promptbook/cli` */
-/** Note: [💞] Ignore a discrepancy between file name and entity name */

package/esm/src/cli/cli-commands/login.d.ts

@@ -8,8 +8,3 @@ import type { $side_effect } from '../../utils/organization/$side_effect';
  * @private internal function of `promptbookCli`
  */
 export declare function $initializeLoginCommand(program: Program): $side_effect;
-/** Note: [🟡] Code for CLI command [login](src/cli/cli-commands/login.ts) should never be published outside of `@promptbook/cli` */
-/**
- * TODO: Implement non-interactive login
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/esm/src/cli/cli-commands/prettify.d.ts

@@ -8,9 +8,3 @@ import type { $side_effect } from '../../utils/organization/$side_effect';
  * @private internal function of `promptbookCli`
  */
 export declare function $initializePrettifyCommand(program: Program): $side_effect;
-/** Note: [🟡] Code for CLI command [prettify](src/cli/cli-commands/prettify.ts) should never be published outside of `@promptbook/cli` */
-/**
- * TODO: [😶] Unite folder listing
- * Note: [💞] Ignore a discrepancy between file name and entity name
- * TODO: [🖇] What about symlinks? Maybe flag --follow-symlinks
- */

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

@@ -8,11 +8,3 @@ import type { $side_effect } from '../../utils/organization/$side_effect';
  * @private internal function of `promptbookCli`
  */
 export declare function $initializeRunCommand(program: Program): $side_effect;
-/** Note: [🟡] Code for CLI command [run](src/cli/cli-commands/run.ts) should never be published outside of `@promptbook/cli` */
-/**
- * TODO: !!5 Catch and wrap all errors from CLI
- * TODO: [🧠] Pass `maxExecutionAttempts`, `csvSettings`
- * TODO: [🥃][main] !!3 Allow `ptbk run` without configuring any llm tools
- * Note: [💞] Ignore a discrepancy between file name and entity name
- * TODO: [🖇] What about symlinks? Maybe flag --follow-symlinks
- */

package/esm/src/cli/cli-commands/runInteractiveChatbot.d.ts

@@ -21,12 +21,8 @@ type RunInteractiveChatbotOptions = {
  * Run the interactive chatbot in CLI
  *
  * @returns Never-ending promise or process exit
+ *
  * @private internal function of `promptbookCli` and `initializeRunCommand`
  */
 export declare function runInteractiveChatbot(options: RunInteractiveChatbotOptions): Promise<void | never>;
 export {};
-/** Note: [🟡] Code for CLI command [runInteractiveChatbot](src/cli/cli-commands/runInteractiveChatbot.ts) should never be published outside of `@promptbook/cli` */
-/**
- * TODO: Saving reports from the chatbot conversation
- * TODO: [⛲️] This is the right place to start implementing INK
- */

package/esm/src/cli/cli-commands/start-agents-server.d.ts

@@ -8,5 +8,3 @@ import type { $side_effect } from '../../utils/organization/$side_effect';
  * @private internal function of `promptbookCli`
  */
 export declare function $initializeStartAgentsServerCommand(program: Program): $side_effect;
-/** Note: [🟡] Code for CLI command [start-agents-server](src/cli/cli-commands/start-agents-server.ts) should never be published outside of `@promptbook/cli` */
-/** Note: [💞] Ignore a discrepancy between file name and entity name */

package/esm/src/cli/cli-commands/start-pipelines-server.d.ts

@@ -8,8 +8,3 @@ import type { $side_effect } from '../../utils/organization/$side_effect';
  * @private internal function of `promptbookCli`
  */
 export declare function $initializeStartPipelinesServerCommand(program: Program): $side_effect;
-/** Note: [🟡] Code for CLI command [start-pipelines-server](src/cli/cli-commands/start-pipelines-server.ts) should never be published outside of `@promptbook/cli` */
-/**
- * TODO: [🕋] Use here `aboutPromptbookInformation`
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/esm/src/cli/cli-commands/test-command.d.ts

@@ -8,10 +8,3 @@ import type { $side_effect } from '../../utils/organization/$side_effect';
  * @private internal function of `promptbookCli`
  */
 export declare function $initializeTestCommand(program: Program): $side_effect;
-/** Note: [🟡] Code for CLI command [test-command](src/cli/cli-commands/test-command.ts) should never be published outside of `@promptbook/cli` */
-/**
- * TODO: [😶] Unite folder listing
- * Note: [💞] Ignore a discrepancy between file name and entity name
- * TODO: [🖇] What about symlinks? Maybe flag --follow-symlinks
- * Note: This is named "test-command.ts" to avoid name collision with jest unit test files
- */

package/esm/src/cli/common/$provideLlmToolsForCli.d.ts

@@ -1,6 +1,9 @@
 import type { CacheLlmToolsOptions } from '../../llm-providers/_common/utils/cache/CacheLlmToolsOptions';
 import type { LlmExecutionToolsWithTotalUsage } from '../../llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
 import type { string_promptbook_server_url } from '../../types/typeAliases';
+/**
+ * Options for provide Llm tools for Cli.
+ */
 type ProvideLlmToolsForCliOptions = Pick<CacheLlmToolsOptions, 'isCacheReloaded'> & {
     /**
      * If true, user will be always prompted for login
@@ -19,6 +22,8 @@ type ProvideLlmToolsForCliOptions = Pick<CacheLlmToolsOptions, 'isCacheReloaded'
     };
 };
 /**
+ * Handles provide Llm tools for Cli.
+ *
  * @private utility of CLI
  */
 export declare function $provideLlmToolsForCli(options: ProvideLlmToolsForCliOptions): Promise<{

package/esm/src/cli/main.d.ts

@@ -10,5 +10,3 @@ import { $runPromptbookCli } from './$runPromptbookCli';
 export declare const _CLI: {
     _initialize_promptbookCli: typeof $runPromptbookCli;
 };
-/** Note: [🟡] Code for CLI entrypoint [main](src/cli/main.ts) should never be published outside of `@promptbook/cli` */
-/** Note: [💞] Ignore a discrepancy between file name and entity name */

package/esm/src/cli/promptbookCli.d.ts

@@ -4,10 +4,3 @@
  * @private within the `@promptbook/cli`
  */
 export declare function promptbookCli(): Promise<void>;
-/** Note: [🟡] Code for CLI program [promptbookCli](src/cli/promptbookCli.ts) should never be published outside of `@promptbook/cli` */
-/**
- * TODO: [🧠] Maybe `run` command the default, instead of `ptbk run ./foo.book` -> `ptbk ./foo.book`
- * TODO: [🥠] Do not export, its just for CLI script
- * TODO: [🕌] When more functionalities, rename
- * Note: 11:11
- */

package/esm/src/collection/agent-collection/AgentCollection.d.ts

@@ -7,6 +7,3 @@ import type { AgentCollectionInSupabase } from './constructors/agent-collection-
  * - `PipelineCollection` - which groups together *(deprecated)* pipelines
  */
 export type AgentCollection = AgentCollectionInSupabase;
-/**
- * TODO: [🧠][🚙] `AgentXxx` vs `AgentsXxx` naming convention
- */

package/esm/src/collection/agent-collection/constructors/agent-collection-in-supabase/AgentCollectionInSupabase.d.ts

@@ -56,8 +56,9 @@ type AgentHistorySnapshot = AgentHistoryMetadata & {
  *
  * Note: This object can work both from Node.js and browser environment depending on the Supabase client provided.
  *
+ * TODO: [🐱‍🚀] Move to `@promptbook/supabase` package
+ *
  * @public exported from `@promptbook/core`
- * <- TODO: [🐱‍🚀] Move to `@promptbook/supabase` package
  */
 export declare class AgentCollectionInSupabase {
     private readonly supabaseClient;
@@ -141,8 +142,3 @@ export declare class AgentCollectionInSupabase {
     private listAgentHistoryInternal;
 }
 export {};
-/**
- * TODO: [🐱‍🚀] Implement it here correctly and update JSDoc comments here, and on interface + other implementations
- * TODO: Write unit test
- * TODO: [🧠][🚙] `AgentXxx` vs `AgentsXxx` naming convention
- */

package/esm/src/collection/agent-collection/constructors/agent-collection-in-supabase/AgentCollectionInSupabaseOptions.d.ts

@@ -1,5 +1,8 @@
 import type { CommonToolsOptions } from '../../../../execution/CommonToolsOptions';
 import type { PrepareAndScrapeOptions } from '../../../../prepare/PrepareAndScrapeOptions';
+/**
+ * Options for agent collection in supabase.
+ */
 export type AgentCollectionInSupabaseOptions = PrepareAndScrapeOptions & CommonToolsOptions & {
     /**
      * The Supabase tables prefix to use

package/esm/src/collection/pipeline-collection/SimplePipelineCollection.d.ts

@@ -6,8 +6,9 @@ import type { PipelineCollection } from './PipelineCollection';
  * Library of pipelines that groups together pipelines for an application.
  * This implementation is a very thin wrapper around the Array / Map of pipelines.
  *
- * @private internal function of `createPipelineCollectionFromJson`, use `createPipelineCollectionFromJson` instead
  * @see https://github.com/webgptorg/pipeline#pipeline-collection
+ *
+ * @private internal function of `createPipelineCollectionFromJson`, use `createPipelineCollectionFromJson` instead
  */
 export declare class SimplePipelineCollection implements PipelineCollection {
     private collection;

package/esm/src/collection/pipeline-collection/constructors/createPipelineCollectionFromDirectory.d.ts

@@ -6,7 +6,7 @@ import type { PipelineCollection } from '../PipelineCollection';
  * Options for `createPipelineCollectionFromDirectory` function
  *
  * Note: `rootDirname` is not needed because it is the folder in which `.book` or `.book` file is located
- *       This is not same as `path` which is the first argument of `createPipelineCollectionFromDirectory` - it can be a subfolder
+ * This is not same as `path` which is the first argument of `createPipelineCollectionFromDirectory` - it can be a subfolder
  */
 type CreatePipelineCollectionFromDirectoryOptions = Omit<PrepareAndScrapeOptions, 'rootDirname'> & {
     /**
@@ -52,11 +52,8 @@ type CreatePipelineCollectionFromDirectoryOptions = Omit<PrepareAndScrapeOptions
  * @param tools - Execution tools to be used for pipeline preparation if needed - If not provided, `$provideExecutionToolsForNode` will be used
  * @param options - Options for the collection creation
  * @returns PipelineCollection
+ *
  * @public exported from `@promptbook/node`
  */
 export declare function createPipelineCollectionFromDirectory(rootPath: string_dirname, tools?: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options?: CreatePipelineCollectionFromDirectoryOptions): Promise<PipelineCollection>;
 export {};
-/**
- * TODO: [🖇] What about symlinks? Maybe option `isSymlinksFollowed`
- * TODO: Maybe move from `@promptbook/node` to `@promptbook/core` as we removes direct dependency on `fs`
- */

package/esm/src/collection/pipeline-collection/constructors/createPipelineCollectionFromJson.d.ts

@@ -8,6 +8,7 @@ import type { PipelineCollection } from '../PipelineCollection';
  *
  * @param promptbookSources
  * @returns PipelineCollection
+ *
  * @public exported from `@promptbook/core`
  */
 export declare function createPipelineCollectionFromJson(...promptbooks: ReadonlyArray<PipelineJson>): PipelineCollection;

package/esm/src/collection/pipeline-collection/constructors/createPipelineCollectionFromPromise.d.ts

@@ -8,17 +8,18 @@ import type { PipelineCollection } from '../PipelineCollection';
  * - Factory function that returns Promise of array of PipelineJson or PipelineString
  *
  * Note: This is useful as internal tool for other constructor functions like
- *       `createPipelineCollectionFromUrl` or `createPipelineCollectionFromDirectory`
- *       Consider using those functions instead of this one
+ * `createPipelineCollectionFromUrl` or `createPipelineCollectionFromDirectory`
+ * Consider using those functions instead of this one
  *
  * Note: The function does NOT return promise it returns the collection directly which waits for the sources to be resolved
- *       when error occurs in given promise or factory function, it is thrown during `listPipelines` or `getPipelineByUrl` call
+ * when error occurs in given promise or factory function, it is thrown during `listPipelines` or `getPipelineByUrl` call
  *
  * Note: Consider using  `createPipelineCollectionFromDirectory` or `createPipelineCollectionFromUrl`
  *
  * @param promptbookSourcesPromiseOrFactory
  * @returns PipelineCollection
  * @deprecated Do not use, it will became internal tool for other constructor functions
+ *
  * @public exported from `@promptbook/core`
  */
 export declare function createPipelineCollectionFromPromise(promptbookSourcesPromiseOrFactory: Promise<ReadonlyArray<PipelineJson>> | (() => Promise<ReadonlyArray<PipelineJson>>)): PipelineCollection;