@promptbook/types 0.112.0-34 → 0.112.0-36

package/README.md

@@ -634,6 +634,121 @@ Or you can install them separately:
 
 
 
+### 🤖 Promptbook Coder
+
+`ptbk coder` is Promptbook's workflow layer for AI-assisted software changes. Instead of opening one chat and manually copy-pasting tasks, you keep a queue of coding prompts in `prompts/*.md`, let a coding agent execute the next ready task, and then verify the result before archiving the prompt.
+
+Promptbook Coder is **not another standalone coding model**. It is an orchestration layer over coding agents such as **GitHub Copilot**, **OpenAI Codex**, **Claude Code**, **Opencode**, **Cline**, and **Gemini CLI**. The difference is that Promptbook Coder adds a repeatable repository workflow on top of them:
+
+-   prompt files with explicit statuses like `[ ]`, `[x]`, and `[-]`
+-   automatic selection of the next runnable task, including priority support
+-   optional shared repo context loaded from a file such as `AGENTS.md`
+-   automatic `git add`, commit, and push after each successful prompt
+-   dedicated coding-agent Git identity and optional GPG signing
+-   verification and repair flow for work that is done, partial, or broken
+-   helper commands for generating boilerplates and finding refactor prompts
+
+In short: tools like Claude Code, Codex, or GitHub Copilot are the **engines**; Promptbook Coder is the **workflow** that keeps coding work structured, reviewable, and repeatable across many prompts.
+
+#### How the workflow works
+
+1. `ptbk coder init` prepares the project for the coder workflow, seeds project-owned templates in `prompts/templates/`, adds helper `npm run coder:*` scripts, ensures `.gitignore` ignores `/.tmp`, and configures VS Code prompt screenshots in `prompts/screenshots/`.
+2. `ptbk coder generate-boilerplates` creates prompt files in `prompts/`.
+3. You replace placeholder `@@@` sections with real coding tasks.
+4. `ptbk coder run` sends the next ready `[ ]` prompt to the selected coding agent.
+5. Promptbook Coder marks the prompt as done `[x]`, records runner metadata, then stages, commits, and pushes the resulting changes.
+6. `ptbk coder verify` reviews completed prompts, archives finished files to `prompts/done/`, and appends a repair prompt when more work is needed.
+
+Prompts marked with `[-]` are not ready yet, prompts containing `@@@` are treated as not fully written, and prompts with more `!` markers have higher priority.
+
+#### Features
+
+-   **Multi-runner execution:** `openai-codex`, `github-copilot`, `cline`, `claude-code`, `opencode`, `gemini`
+-   **Context injection:** `--context AGENTS.md` or inline extra instructions
+-   **Reasoning control:** `--thinking-level low|medium|high|xhigh` for supported runners
+-   **Interactive or unattended runs:** default wait mode, or `--no-wait` for batch execution
+-   **Git safety:** clean working tree check by default, optional `--ignore-git-changes`
+-   **Prompt triage:** `--priority` to process only more important tasks first
+-   **Failure logging:** failed runs write a neighboring `.error.log`
+-   **Line-ending normalization:** changed files are normalized back to LF by default
+
+#### Local usage in this repository
+
+When working on Promptbook itself, the repository usually runs the CLI straight from source:
+
+```bash
+npx ts-node ./src/cli/test/ptbk.ts coder init
+
+npx ts-node ./src/cli/test/ptbk.ts coder generate-boilerplates --template prompts/templates/common.md
+
+npx ts-node ./src/cli/test/ptbk.ts coder generate-boilerplates --template prompts/templates/agents-server.md
+
+npx ts-node ./src/cli/test/ptbk.ts coder run --agent github-copilot --model gpt-5.4 --thinking-level xhigh --context AGENTS.md
+
+npx ts-node ./src/cli/test/ptbk.ts coder run --agent github-copilot --model gpt-5.4 --thinking-level xhigh --context AGENTS.md --ignore-git-changes --no-wait
+
+npx ts-node ./src/cli/test/ptbk.ts coder find-refactor-candidates
+
+npx ts-node ./src/cli/test/ptbk.ts coder verify
+```
+
+#### Using `ptbk coder` in an external project
+
+If you want to use the workflow in another repository, install the package and invoke the `ptbk` binary. After local installation, `npx ptbk ...` is the most portable form; plain `ptbk ...` also works when your environment exposes the local binary on `PATH`.
+
+```bash
+npm install ptbk
+
+ptbk coder init
+
+npx ptbk coder generate-boilerplates
+
+npx ptbk coder generate-boilerplates --template prompts/templates/agents-server.md
+
+npx ptbk coder run --agent github-copilot --model gpt-5.4 --thinking-level xhigh --context AGENTS.md
+
+npx ptbk coder run --agent github-copilot --model gpt-5.4 --thinking-level xhigh --context AGENTS.md --ignore-git-changes --no-wait
+
+npx ptbk coder find-refactor-candidates
+
+npx ptbk coder verify
+```
+
+`ptbk coder init` also bootstraps `package.json` scripts for the four main coder commands, adds the coder temp ignore to `.gitignore`, and configures `.vscode/settings.json` so pasted images from `prompts/*.md` land in `prompts/screenshots/`.
+
+#### What each command does
+
+| Command | What it does |
+| --- | --- |
+| `ptbk coder init` | Creates `prompts/`, `prompts/done/`, `prompts/templates/common.md`, `prompts/templates/agents-server.md`, ensures `.env` contains `CODING_AGENT_GIT_NAME`, `CODING_AGENT_GIT_EMAIL`, and `CODING_AGENT_GIT_SIGNING_KEY`, adds helper coder scripts to `package.json`, ensures `.gitignore` contains `/.tmp`, and configures `.vscode/settings.json` to save pasted prompt images into `prompts/screenshots/`. |
+| `ptbk coder generate-boilerplates` | Creates new prompt markdown files with fresh emoji tags so you can quickly fill in coding tasks; `--template` accepts either a built-in alias or a markdown file path relative to the project root. |
+| `ptbk coder run` | Picks the next ready prompt, appends optional context, runs it through the selected coding agent, marks success or failure, then commits and pushes the result. |
+| `ptbk coder find-refactor-candidates` | Scans the repository for oversized or overpacked files and writes prompt files for likely refactors. |
+| `ptbk coder verify` | Walks through completed prompts, archives truly finished work, and adds follow-up repair prompts for unfinished results. |
+
+#### Most useful `ptbk coder run` flags
+
+| Flag | Purpose |
+| --- | --- |
+| `--agent <name>` | Selects the coding backend. |
+| `--model <model>` | Chooses the runner model; required for `openai-codex` and `gemini`, optional for `github-copilot`. |
+| `--context <text-or-file>` | Appends extra instructions inline or from a file like `AGENTS.md`. |
+| `--thinking-level <level>` | Sets reasoning effort for supported runners. |
+| `--no-wait` | Skips interactive pauses between prompts for unattended execution. |
+| `--ignore-git-changes` | Disables the clean-working-tree guard. |
+| `--priority <n>` | Runs only prompts at or above the given priority. |
+| `--dry-run` | Prints which prompts are ready instead of executing them. |
+| `--allow-credits` | Lets OpenAI Codex spend credits when required. |
+| `--auto-migrate` | Runs testing-server database migrations after each successful prompt. |
+
+#### Typical usage pattern
+
+1. Initialize once with `ptbk coder init`.
+2. Customize `prompts/templates/*.md` if needed, then create or write prompt files in `prompts/`.
+3. Put repository-specific instructions in `AGENTS.md`, then pass `--context AGENTS.md`.
+4. Run one prompt at a time interactively, or use `--no-wait` for unattended batches.
+5. Finish with `ptbk coder verify` so resolved prompts are archived and broken ones get explicit repair follow-ups.
+
 
 
 

package/esm/src/_packages/types.index.d.ts

@@ -258,6 +258,9 @@ import type { number_negative } from '../types/number_positive';
 import type { number_integer } from '../types/number_positive';
 import type { number_port } from '../types/number_positive';
 import type { number_usd } from '../types/number_usd';
+import type { Parameters } from '../types/Parameters';
+import type { InputParameters } from '../types/Parameters';
+import type { ReservedParameters } from '../types/Parameters';
 import type { Prompt } from '../types/Prompt';
 import type { CompletionPrompt } from '../types/Prompt';
 import type { ChatPrompt } from '../types/Prompt';
@@ -270,6 +273,11 @@ import type { SpeechRecognition } from '../types/SpeechRecognition';
 import type { SpeechRecognitionStartOptions } from '../types/SpeechRecognition';
 import type { SpeechRecognitionState } from '../types/SpeechRecognition';
 import type { SpeechRecognitionEvent } from '../types/SpeechRecognition';
+import type { string_agent_name } from '../types/string_agent_name';
+import type { string_agent_name_in_book } from '../types/string_agent_name';
+import type { string_agent_hash } from '../types/string_agent_name';
+import type { string_agent_permanent_id } from '../types/string_agent_name';
+import type { string_business_category_name } from '../types/string_business_category_name';
 import type { string_absolute_filename } from '../types/string_filename';
 import type { string_relative_filename } from '../types/string_filename';
 import type { string_filename } from '../types/string_filename';
@@ -298,31 +306,13 @@ import type { string_css_property } from '../types/string_markdown';
 import type { string_fonts } from '../types/string_markdown';
 import type { string_css_value } from '../types/string_markdown';
 import type { string_css_selector } from '../types/string_markdown';
-import type { string_business_category_name } from '../types/string_parameter_name';
-import type { string_model_name } from '../types/string_parameter_name';
-import type { string_prompt } from '../types/string_parameter_name';
-import type { string_prompt_image } from '../types/string_parameter_name';
-import type { string_template } from '../types/string_parameter_name';
-import type { string_text_prompt } from '../types/string_parameter_name';
-import type { string_chat_prompt } from '../types/string_parameter_name';
-import type { string_system_message } from '../types/string_parameter_name';
-import type { string_completion_prompt } from '../types/string_parameter_name';
-import type { string_page } from '../types/string_parameter_name';
-import type { string_char } from '../types/string_parameter_name';
-import type { string_name } from '../types/string_parameter_name';
-import type { string_parameter_name } from '../types/string_parameter_name';
-import type { string_parameter_value } from '../types/string_parameter_name';
-import type { Parameters } from '../types/string_parameter_name';
-import type { InputParameters } from '../types/string_parameter_name';
-import type { string_reserved_parameter_name } from '../types/string_parameter_name';
-import type { ReservedParameters } from '../types/string_parameter_name';
-import type { string_title } from '../types/string_parameter_name';
-import type { string_agent_name } from '../types/string_parameter_name';
-import type { string_agent_name_in_book } from '../types/string_parameter_name';
-import type { string_agent_hash } from '../types/string_parameter_name';
-import type { string_agent_permanent_id } from '../types/string_parameter_name';
-import type { string_persona_description } from '../types/string_parameter_name';
-import type { string_model_description } from '../types/string_parameter_name';
+import type { string_model_name } from '../types/string_model_name';
+import type { string_name } from '../types/string_name';
+import type { string_parameter_name } from '../types/string_name';
+import type { string_parameter_value } from '../types/string_name';
+import type { string_reserved_parameter_name } from '../types/string_name';
+import type { string_page } from '../types/string_page';
+import type { string_char } from '../types/string_page';
 import type { string_person_fullname } from '../types/string_person_fullname';
 import type { string_person_firstname } from '../types/string_person_fullname';
 import type { string_person_lastname } from '../types/string_person_fullname';
@@ -337,12 +327,22 @@ import type { string_translate_name_not_normalized } from '../types/string_perso
 import type { string_translate_language } from '../types/string_person_fullname';
 import type { string_javascript_name } from '../types/string_person_fullname';
 import type { string_postprocessing_function_name } from '../types/string_person_fullname';
+import type { string_persona_description } from '../types/string_persona_description';
+import type { string_model_description } from '../types/string_persona_description';
+import type { string_prompt } from '../types/string_prompt';
+import type { string_prompt_image } from '../types/string_prompt';
+import type { string_template } from '../types/string_prompt';
+import type { string_text_prompt } from '../types/string_prompt';
+import type { string_chat_prompt } from '../types/string_prompt';
+import type { string_system_message } from '../types/string_prompt';
+import type { string_completion_prompt } from '../types/string_prompt';
 import type { string_uuid } from '../types/string_sha256';
 import type { string_sha256 } from '../types/string_sha256';
 import type { string_base_58 } from '../types/string_sha256';
 import type { string_semantic_version } from '../types/string_sha256';
 import type { string_version_dependency } from '../types/string_sha256';
 import type { string_file_extension } from '../types/string_sha256';
+import type { string_title } from '../types/string_title';
 import type { id } from '../types/string_token';
 import type { task_id } from '../types/string_token';
 import type { string_token } from '../types/string_token';
@@ -686,6 +686,9 @@ export type { number_negative };
 export type { number_integer };
 export type { number_port };
 export type { number_usd };
+export type { Parameters };
+export type { InputParameters };
+export type { ReservedParameters };
 export type { Prompt };
 export type { CompletionPrompt };
 export type { ChatPrompt };
@@ -698,6 +701,11 @@ export type { SpeechRecognition };
 export type { SpeechRecognitionStartOptions };
 export type { SpeechRecognitionState };
 export type { SpeechRecognitionEvent };
+export type { string_agent_name };
+export type { string_agent_name_in_book };
+export type { string_agent_hash };
+export type { string_agent_permanent_id };
+export type { string_business_category_name };
 export type { string_absolute_filename };
 export type { string_relative_filename };
 export type { string_filename };
@@ -726,31 +734,13 @@ export type { string_css_property };
 export type { string_fonts };
 export type { string_css_value };
 export type { string_css_selector };
-export type { string_business_category_name };
 export type { string_model_name };
-export type { string_prompt };
-export type { string_prompt_image };
-export type { string_template };
-export type { string_text_prompt };
-export type { string_chat_prompt };
-export type { string_system_message };
-export type { string_completion_prompt };
-export type { string_page };
-export type { string_char };
 export type { string_name };
 export type { string_parameter_name };
 export type { string_parameter_value };
-export type { Parameters };
-export type { InputParameters };
 export type { string_reserved_parameter_name };
-export type { ReservedParameters };
-export type { string_title };
-export type { string_agent_name };
-export type { string_agent_name_in_book };
-export type { string_agent_hash };
-export type { string_agent_permanent_id };
-export type { string_persona_description };
-export type { string_model_description };
+export type { string_page };
+export type { string_char };
 export type { string_person_fullname };
 export type { string_person_firstname };
 export type { string_person_lastname };
@@ -765,12 +755,22 @@ export type { string_translate_name_not_normalized };
 export type { string_translate_language };
 export type { string_javascript_name };
 export type { string_postprocessing_function_name };
+export type { string_persona_description };
+export type { string_model_description };
+export type { string_prompt };
+export type { string_prompt_image };
+export type { string_template };
+export type { string_text_prompt };
+export type { string_chat_prompt };
+export type { string_system_message };
+export type { string_completion_prompt };
 export type { string_uuid };
 export type { string_sha256 };
 export type { string_base_58 };
 export type { string_semantic_version };
 export type { string_version_dependency };
 export type { string_file_extension };
+export type { string_title };
 export type { id };
 export type { task_id };
 export type { string_token };

package/esm/src/book-2.0/agent-source/AgentBasicInformation.d.ts

@@ -46,6 +46,9 @@ export type AgentCapability = {
      */
     agentUrl?: string_agent_url;
 };
+/**
+ * Information about agent basic.
+ */
 export type AgentBasicInformation = {
     /**
      * Name of the agent
@@ -123,7 +126,3 @@ export type AgentBasicInformation = {
         filename: string;
     }>;
 };
-/**
- * TODO: [🐱‍🚀] Make all properties of `AgentBasicInformation` readonly
- * TODO: [🕛] Unite `AgentBasicInformation`, `ChatParticipant`, `LlmExecutionTools` +  `LlmToolsMetadata`
- */

package/esm/src/book-2.0/agent-source/AgentModelRequirements.d.ts

@@ -75,7 +75,3 @@ export type AgentModelRequirements = {
      */
     readonly _metadata?: Record<string, chococake>;
 };
-/**
- * TODO: [🐤] DRY `AgentModelRequirements` and `ModelRequirements`
- * TODO: [🧠] `isClosed` and `parentAgentUrl` doesn't truly belong to `AgentModelRequirements` nor agent profile but it is in the `AgentModelRequirements` because of some legacy - maybe figure out better place
- */

package/esm/src/book-2.0/agent-source/createAgentModelRequirements.d.ts

@@ -16,6 +16,7 @@ import type { string_book } from './string_book';
  * @param availableModels - Models that could fulfill the agent.
  * @param llmTools - Execution tools used when selecting a best model.
  * @param options - Optional hooks such as the agent reference resolver.
+ *
  * @public exported from `@promptbook/core`
  */
 export declare function createAgentModelRequirements(agentSource: string_book, modelName?: string_model_name, availableModels?: readonly AvailableModel[], llmTools?: LlmExecutionTools, options?: CreateAgentModelRequirementsOptions): Promise<AgentModelRequirements>;
@@ -30,21 +31,27 @@ export declare function createAgentModelRequirements(agentSource: string_book, m
 export declare function extractMcpServers(agentSource: string_book): string[];
 /**
  * Creates a system message for an agent based on its source
+ *
  * @deprecated Use createAgentModelRequirements instead
+ *
  * @private
  */
 export declare function createAgentSystemMessage(agentSource: string_book): Promise<string_system_message>;
 /**
  * Extracts the agent name from the first non-empty line of the agent source.
+ *
  * @deprecated Use parseAgentSource instead
+ *
  * @private
  */
 export declare function extractAgentName(agentSource: string_book): string_agent_name;
 /**
  * Extracts the profile image URL from agent source or returns default avatar fallback
+ *
  * @param agentSource The agent source string that may contain META IMAGE line
  * @returns Profile image URL (from source or default avatar fallback)
  * @deprecated Use parseAgentSource instead
+ *
  * @private
  */
 export declare function extractAgentProfileImage(agentSource: string_book): string_url_image | null;

package/esm/src/book-2.0/agent-source/createTeamToolName.d.ts

@@ -7,6 +7,7 @@
  * @param _teammateUrl - Canonical teammate URL (kept for API compatibility, not used).
  * @param teammateLabel - Human-readable teammate label used as the basis for the name.
  * @returns TEAM tool name derived from the label.
+ *
  * @private internal utility of TEAM commitments and chat UI mapping
  */
 export declare function createTeamToolName(_teammateUrl: string, teammateLabel?: string): string;

package/esm/src/book-2.0/agent-source/extractOpenTeacherInstructions.d.ts

@@ -7,6 +7,7 @@ import type { string_book } from './string_book';
  *
  * @param agentSource - The raw agent book source
  * @returns The trimmed instructions or `null` when no instructive `OPEN` commitment exists.
+ *
  * @private Internal helper shared between self-learning and related features.
  */
 export declare function extractOpenTeacherInstructions(agentSource: string_book): string | null;

package/esm/src/book-2.0/agent-source/padBook.d.ts

@@ -1,6 +1,6 @@
 import type { string_book } from './string_book';
 /**
- *  Number of padding lines to add at the end of the book content
+ * Number of padding lines to add at the end of the book content
  *
  * @public exported from `@promptbook/core`
  */
@@ -13,6 +13,3 @@ export declare const PADDING_LINES = 11;
  * @public exported from `@promptbook/core`
  */
 export declare function padBook(content: string_book): string_book;
-/**
- * TODO: [🧠] Maybe export
- */

package/esm/src/book-2.0/agent-source/parseAgentSource.d.ts

@@ -10,6 +10,3 @@ import type { string_book } from './string_book';
  * @public exported from `@promptbook/core`
  */
 export declare function parseAgentSource(agentSource: string_book): AgentBasicInformation;
-/**
- * TODO: [🕛] Unite `AgentBasicInformation`, `ChatParticipant`, `LlmExecutionTools` +  `LlmToolsMetadata`
- */

package/esm/src/book-2.0/agent-source/parseAgentSourcePrelude.d.ts

@@ -32,6 +32,7 @@ type AgentSourcePrelude = {
  *
  * @param agentSource - Raw agent source.
  * @returns Parsed prelude with shared line metadata.
+ *
  * @private internal utility of book agent-source parsing
  */
 export declare function parseAgentSourcePrelude(agentSource: string_book): AgentSourcePrelude;

package/esm/src/book-2.0/agent-source/parseParameters.d.ts

@@ -8,6 +8,7 @@ import type { BookParameter } from './AgentBasicInformation';
  *
  * @param text - Text to extract parameters from
  * @returns Array of parsed parameters with unified representation
+ *
  * @public exported from `@promptbook/core`
  */
 export declare function parseParameters(text: string): BookParameter[];

package/esm/src/book-2.0/agent-source/parseTeamCommitment.d.ts

@@ -23,6 +23,3 @@ export type ParseTeamCommitmentOptions = {
  * @private
  */
 export declare function parseTeamCommitmentContent(content: string, options?: ParseTeamCommitmentOptions): TeamTeammate[];
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/esm/src/book-2.0/agent-source/pseudoAgentReferences.d.ts

@@ -37,6 +37,7 @@ export declare const VOID_PSEUDO_AGENT_ALIAS_KEYS: readonly ["void", "null", "no
  *
  * @param rawReference - Raw reference token or payload.
  * @returns Pseudo-agent kind or `null` when the reference is not pseudo.
+ *
  * @private internal utility of pseudo-agent resolution
  */
 export declare function resolvePseudoAgentKindFromReference(rawReference: string): PseudoAgentKind | null;
@@ -45,6 +46,7 @@ export declare function resolvePseudoAgentKindFromReference(rawReference: string
  *
  * @param agentUrl - URL to inspect.
  * @returns Pseudo-agent kind or `null` when the URL is not pseudo.
+ *
  * @private internal utility of pseudo-agent resolution
  */
 export declare function resolvePseudoAgentKindFromUrl(agentUrl: string): PseudoAgentKind | null;
@@ -53,6 +55,7 @@ export declare function resolvePseudoAgentKindFromUrl(agentUrl: string): PseudoA
  *
  * @param agentUrl - URL to inspect.
  * @returns True when the URL identifies a pseudo-agent.
+ *
  * @private internal utility of pseudo-agent resolution
  */
 export declare function isPseudoAgentUrl(agentUrl: string): boolean;
@@ -61,6 +64,7 @@ export declare function isPseudoAgentUrl(agentUrl: string): boolean;
  *
  * @param pseudoAgentKind - Pseudo-agent kind.
  * @returns Canonical pseudo-agent URL.
+ *
  * @private internal utility of pseudo-agent resolution
  */
 export declare function createPseudoAgentUrl(pseudoAgentKind: PseudoAgentKind): string;
@@ -72,6 +76,7 @@ export declare function createPseudoAgentUrl(pseudoAgentKind: PseudoAgentKind):
  *
  * @param teamCommitmentContent - TEAM commitment content after reference resolution.
  * @returns Deterministic English full name representing pseudo-user in that TEAM context.
+ *
  * @private internal utility of TEAM commitment rendering
  */
 export declare function createPseudoUserTeammateLabel(teamCommitmentContent: string): string;
@@ -83,6 +88,7 @@ export declare function createPseudoUserTeammateLabel(teamCommitmentContent: str
  *
  * @param rawReference - Raw reference content.
  * @returns True when the reference maps to void.
+ *
  * @private internal utility of pseudo-agent resolution
  */
 export declare function isVoidPseudoAgentReference(rawReference: string): boolean;
@@ -91,6 +97,7 @@ export declare function isVoidPseudoAgentReference(rawReference: string): boolea
  *
  * @param rawReference - Raw reference content.
  * @returns True when the reference maps to user.
+ *
  * @private internal utility of pseudo-agent resolution
  */
 export declare function isUserPseudoAgentReference(rawReference: string): boolean;
@@ -102,9 +109,7 @@ export declare function isUserPseudoAgentReference(rawReference: string): boolea
  * @param pseudoAgentKind - Pseudo-agent kind to validate.
  * @param commitmentType - Commitment where it is used.
  * @returns True when the pseudo-agent is allowed in the commitment.
+ *
  * @private internal utility of pseudo-agent resolution
  */
 export declare function isPseudoAgentAllowedInCommitment(pseudoAgentKind: PseudoAgentKind, commitmentType: BookCommitment): boolean;
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/esm/src/book-2.0/agent-source/string_book.d.ts

@@ -24,6 +24,7 @@ export declare function validateBook(source: string): string_book;
  * Default book
  *
  * @deprecated Use `$generateBookBoilerplate` instead
+ *
  * @public exported from `@promptbook/core`
  */
 export declare const DEFAULT_BOOK: string_book;

package/esm/src/book-2.0/utils/generatePlaceholderAgentProfileImageUrl.d.ts

@@ -8,6 +8,3 @@ import type { string_agent_name, string_agent_permanent_id, string_url, string_u
  * @public exported from `@promptbook/core`
  */
 export declare function generatePlaceholderAgentProfileImageUrl(agentIdOrName: string_agent_permanent_id | string_agent_name, agentsServerUrl: URL | string_url): string_url_image;
-/**
- * TODO: [🤹] Figure out best placeholder image generator https://i.pravatar.cc/1000?u=568
- */

package/esm/src/book-components/AvatarProfile/AvatarChip/AvatarChip.d.ts

@@ -33,6 +33,3 @@ export type AvatarChipProps = {
  * @public exported from `@promptbook/components`
  */
 export declare function AvatarChip(props: AvatarChipProps): import("react/jsx-runtime").JSX.Element;
-/**
- * TODO: [☁️] Export component prop types only to `@promptbook/components` (not `@promptbook/types`)
- */

package/esm/src/book-components/AvatarProfile/AvatarProfile/AvatarProfile.d.ts

@@ -31,6 +31,3 @@ export type AvatarProfileProps = {
  * @public exported from `@promptbook/components`
  */
 export declare function AvatarProfile(props: AvatarProfileProps): import("react/jsx-runtime").JSX.Element;
-/**
- * TODO: [☁️] Export component prop types only to `@promptbook/components` (not `@promptbook/types`)
- */

package/esm/src/book-components/AvatarProfile/AvatarProfile/AvatarProfileTooltip.d.ts

@@ -1,5 +1,8 @@
 /// <reference types="react" />
 import type { string_book } from '../../../book-2.0/agent-source/string_book';
+/**
+ * Props for avatar profile tooltip.
+ */
 type AvatarProfileTooltipProps = {
     agentSource: string_book;
     position: {
@@ -8,6 +11,7 @@ type AvatarProfileTooltipProps = {
     };
 };
 /**
+ * Constant for avatar profile tooltip.
  *
  * @private internal subcomponent of `<Chat>` component
  */

package/esm/src/book-components/BookEditor/BookEditor.d.ts

@@ -219,6 +219,3 @@ export type BookEditorProps = {
  */
 export declare function BookEditor(props: BookEditorProps): import("react/jsx-runtime").JSX.Element;
 export {};
-/**
- * TODO: [☁️] Export component prop types only to `@promptbook/components` (not `@promptbook/types`)
- */

package/esm/src/book-components/BookEditor/BookEditorActionbar.d.ts

@@ -1,4 +1,7 @@
 import { HoistedMenuItem } from '../_common/MenuHoisting/MenuHoistingContext';
+/**
+ * Props for book editor actionbar.
+ */
 type BookEditorActionbarProps = {
     value: string | undefined;
     isDownloadButtonShown?: boolean;
@@ -13,6 +16,7 @@ type BookEditorActionbarProps = {
     hoistedMenuItems?: ReadonlyArray<HoistedMenuItem>;
 };
 /**
+ * Handles book editor actionbar.
  *
  * @private Internal component used by `BookEditor`
  */

package/esm/src/book-components/BookEditor/BookEditorMonaco.d.ts

@@ -1,5 +1,7 @@
 import type { BookEditorProps } from './BookEditor';
 /**
+ * Handles book editor monaco.
+ *
  * @private Internal component used by `BookEditor`
  */
 export declare function BookEditorMonaco(props: BookEditorProps): import("react/jsx-runtime").JSX.Element;

package/esm/src/book-components/BookEditor/BookEditorMonacoUploadPanel.d.ts

@@ -1,4 +1,7 @@
 import type { UploadItem, UploadStats } from './useBookEditorMonacoUploads';
+/**
+ * Props for book editor monaco upload panel.
+ */
 type BookEditorMonacoUploadPanelProps = {
     readonly activeUploadItems: UploadItem[];
     readonly uploadStats: UploadStats;

package/esm/src/book-components/BookEditor/createDeprecatedCommitmentDiagnostics.d.ts

@@ -22,6 +22,7 @@ type DeprecatedCommitmentDiagnostic = {
  *
  * @param agentSource - Current editor content.
  * @returns Warning markers for deprecated commitment keywords.
+ *
  * @private internal utility of `BookEditorMonaco`
  */
 export declare function createDeprecatedCommitmentDiagnostics(agentSource?: string_book): ReadonlyArray<DeprecatedCommitmentDiagnostic>;

package/esm/src/book-components/BookEditor/useBookEditorMonacoDecorations.d.ts

@@ -1,5 +1,11 @@
 import type { editor } from 'monaco-editor';
+/**
+ * Type describing monaco editor.
+ */
 type MonacoEditor = typeof import('monaco-editor');
+/**
+ * Props for use book editor monaco decorations.
+ */
 type UseBookEditorMonacoDecorationsProps = {
     readonly editor: editor.IStandaloneCodeEditor | null;
     readonly monaco: MonacoEditor | null;

package/esm/src/book-components/BookEditor/useBookEditorMonacoDiagnostics.d.ts

@@ -1,5 +1,11 @@
 import type { editor } from 'monaco-editor';
+/**
+ * Type describing monaco editor.
+ */
 type MonacoEditor = typeof import('monaco-editor');
+/**
+ * Type describing book editor monaco diagnostic.
+ */
 type BookEditorMonacoDiagnostic = {
     readonly startLineNumber: number;
     readonly startColumn: number;
@@ -9,6 +15,9 @@ type BookEditorMonacoDiagnostic = {
     readonly source?: string;
     readonly severity?: 'error' | 'warning' | 'info' | 'hint';
 };
+/**
+ * Props for use book editor monaco diagnostics.
+ */
 type UseBookEditorMonacoDiagnosticsProps = {
     readonly monaco: MonacoEditor | null;
     readonly editor: editor.IStandaloneCodeEditor | null;

package/esm/src/book-components/BookEditor/useBookEditorMonacoLanguage.d.ts

@@ -1,5 +1,11 @@
 import type { editor } from 'monaco-editor';
+/**
+ * Type describing monaco editor.
+ */
 type MonacoEditor = typeof import('monaco-editor');
+/**
+ * Props for use book editor monaco language.
+ */
 type UseBookEditorMonacoLanguageProps = {
     readonly monaco: MonacoEditor | null;
 };
@@ -26,6 +32,7 @@ type EnsureBookEditorMonacoLanguageForEditorProps = {
  * Book editor tree is restored from App Router cache without a full remount.
  *
  * @param props - Monaco runtime and mounted editor instance.
+ *
  * @private function of BookEditorMonaco
  */
 export declare function ensureBookEditorMonacoLanguageForEditor(props: EnsureBookEditorMonacoLanguageForEditorProps): void;

package/esm/src/book-components/BookEditor/useBookEditorMonacoStyles.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Props for use book editor monaco styles.
+ */
 type UseBookEditorMonacoStylesProps = {
     readonly instanceClass: string;
     readonly scaledLineHeight: number;