@promptbook/markdown-utils 0.112.0-54 → 0.112.0-57

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (177) hide show
  1. package/esm/index.es.js +3 -3
  2. package/esm/src/_packages/cli.index.d.ts +10 -0
  3. package/esm/src/_packages/core.index.d.ts +12 -0
  4. package/esm/src/_packages/types.index.d.ts +8 -0
  5. package/esm/src/_packages/wizard.index.d.ts +10 -0
  6. package/esm/src/avatars/index.d.ts +1 -1
  7. package/esm/src/avatars/types/AvatarVisualDefinition.d.ts +1 -1
  8. package/esm/src/avatars/visuals/avatarVisualRegistry.d.ts +12 -0
  9. package/esm/src/avatars/visuals/orbAvatarVisual.d.ts +48 -0
  10. package/esm/src/avatars/visuals/orbAvatarVisual.test.d.ts +1 -0
  11. package/esm/src/book-2.0/agent-source/AgentBasicInformation.d.ts +2 -0
  12. package/esm/src/book-2.0/agent-source/createAgentModelRequirementsWithCommitments/ParsedAgentSourceWithCommitments.d.ts +7 -0
  13. package/esm/src/book-2.0/agent-source/createAgentModelRequirementsWithCommitments/applyCommitmentsToAgentModelRequirements.d.ts +14 -0
  14. package/esm/src/book-2.0/agent-source/createAgentModelRequirementsWithCommitments/augmentAgentModelRequirementsFromSource.d.ts +14 -0
  15. package/esm/src/book-2.0/agent-source/createAgentModelRequirementsWithCommitments/filterCommitmentsForAgentModelRequirements.d.ts +10 -0
  16. package/esm/src/book-2.0/agent-source/createAgentModelRequirementsWithCommitments/materializeInlineKnowledgeSources.d.ts +12 -0
  17. package/esm/src/book-2.0/agent-source/parseAgentSource/ParseAgentSourceState.d.ts +10 -0
  18. package/esm/src/book-2.0/agent-source/parseAgentSource/ParsedAgentProfile.d.ts +7 -0
  19. package/esm/src/book-2.0/agent-source/parseAgentSource/applyMetaCommitment.d.ts +8 -0
  20. package/esm/src/book-2.0/agent-source/parseAgentSource/consumeConversationSampleCommitment.d.ts +8 -0
  21. package/esm/src/book-2.0/agent-source/parseAgentSource/createCapabilitiesFromCommitment.d.ts +9 -0
  22. package/esm/src/book-2.0/agent-source/parseAgentSource/ensureMetaFullname.d.ts +7 -0
  23. package/esm/src/book-2.0/agent-source/parseAgentSource/extractAgentProfileText.d.ts +8 -0
  24. package/esm/src/book-2.0/agent-source/parseAgentSource/extractInitialMessage.d.ts +7 -0
  25. package/esm/src/book-2.0/agent-source/parseAgentSource/extractParsedAgentProfile.d.ts +8 -0
  26. package/esm/src/book-2.0/agent-source/parseAgentSourceWithCommitments.use.test.d.ts +1 -0
  27. package/esm/src/book-components/BookEditor/createDeprecatedCommitmentDiagnostics.d.ts +9 -8
  28. package/esm/src/commitments/ACTION/ACTION.d.ts +8 -2
  29. package/esm/src/commitments/ACTION/ACTION.test.d.ts +1 -0
  30. package/esm/src/commitments/DELETE/DELETE.d.ts +7 -3
  31. package/esm/src/commitments/DELETE/DELETE.test.d.ts +1 -0
  32. package/esm/src/commitments/FORMAT/FORMAT.d.ts +10 -4
  33. package/esm/src/commitments/FORMAT/FORMAT.test.d.ts +1 -0
  34. package/esm/src/commitments/GOAL/GOAL.d.ts +4 -0
  35. package/esm/src/commitments/KNOWLEDGE/KNOWLEDGE.d.ts +4 -0
  36. package/esm/src/commitments/META/META.d.ts +2 -0
  37. package/esm/src/commitments/META_AVATAR/META_AVATAR.d.ts +26 -0
  38. package/esm/src/commitments/MODEL/MODEL.d.ts +4 -0
  39. package/esm/src/commitments/MODEL/MODEL.test.d.ts +1 -0
  40. package/esm/src/commitments/RULE/RULE.d.ts +4 -0
  41. package/esm/src/commitments/TEAM/TEAM.d.ts +4 -0
  42. package/esm/src/commitments/TEMPLATE/TEMPLATE.d.ts +10 -4
  43. package/esm/src/commitments/_base/BaseCommitmentDefinition.d.ts +12 -0
  44. package/esm/src/commitments/_base/CommitmentDefinition.d.ts +21 -1
  45. package/esm/src/commitments/_common/getAllCommitmentDefinitions.test.d.ts +1 -0
  46. package/esm/src/commitments/_common/getCommitmentNoticeMetadata.d.ts +51 -0
  47. package/esm/src/commitments/_common/getCommitmentNoticeMetadata.test.d.ts +1 -0
  48. package/esm/src/commitments/_common/getGroupedCommitmentDefinitions.openClosed.test.d.ts +1 -0
  49. package/esm/src/commitments/_common/getGroupedCommitmentDefinitions.order.test.d.ts +1 -0
  50. package/esm/src/commitments/_common/getGroupedCommitmentDefinitions.use.test.d.ts +1 -0
  51. package/esm/src/commitments/_common/sortCommitmentDefinitions.d.ts +31 -0
  52. package/esm/src/commitments/_common/teamInternalAgentAccess.d.ts +51 -0
  53. package/esm/src/commitments/_common/toolRuntimeContext.d.ts +4 -0
  54. package/esm/src/commitments/index.d.ts +2 -2
  55. package/esm/src/commitments/index.test.d.ts +1 -0
  56. package/esm/src/llm-providers/agent/Agent.d.ts +2 -0
  57. package/esm/src/llm-providers/agent/RemoteAgent.d.ts +1 -0
  58. package/esm/src/llm-providers/agent/RemoteAgentOptions.d.ts +4 -0
  59. package/esm/src/playground/playground.d.ts +1 -0
  60. package/esm/src/transpilers/_common/BookTranspilerOptions.d.ts +20 -0
  61. package/esm/src/transpilers/_common/TranspiledTeamExport.d.ts +80 -0
  62. package/esm/src/transpilers/_common/createTranspiledTeamRuntimeSection.d.ts +55 -0
  63. package/esm/src/transpilers/_common/createZodSchemaSource.d.ts +40 -0
  64. package/esm/src/transpilers/_common/formatUsedToolFunctions.d.ts +18 -0
  65. package/esm/src/transpilers/_common/formatUsedToolFunctions.test.d.ts +1 -0
  66. package/esm/src/transpilers/_common/prepareSdkTranspilerContext.d.ts +48 -0
  67. package/esm/src/transpilers/_common/resolveClaudeModelName.d.ts +12 -0
  68. package/esm/src/transpilers/_common/transpiledTeamTranspilers.test.d.ts +1 -0
  69. package/esm/src/transpilers/agent-os/AgentOsTranspiler.d.ts +16 -0
  70. package/esm/src/transpilers/agent-os/AgentOsTranspiler.test.d.ts +1 -0
  71. package/esm/src/transpilers/agent-os/register.d.ts +12 -0
  72. package/esm/src/transpilers/anthropic-claude-managed/AnthropicClaudeManagedTranspiler.d.ts +16 -0
  73. package/esm/src/transpilers/anthropic-claude-managed/AnthropicClaudeManagedTranspiler.test.d.ts +1 -0
  74. package/esm/src/transpilers/anthropic-claude-managed/register.d.ts +12 -0
  75. package/esm/src/transpilers/anthropic-claude-sdk/AnthropicClaudeSdkTranspiler.d.ts +16 -0
  76. package/esm/src/transpilers/anthropic-claude-sdk/AnthropicClaudeSdkTranspiler.test.d.ts +1 -0
  77. package/esm/src/transpilers/anthropic-claude-sdk/register.d.ts +12 -0
  78. package/esm/src/transpilers/e2b/E2BTranspiler.d.ts +16 -0
  79. package/esm/src/transpilers/e2b/E2BTranspiler.test.d.ts +1 -0
  80. package/esm/src/transpilers/e2b/register.d.ts +12 -0
  81. package/esm/src/transpilers/openai-agents/OpenAiAgentsTranspiler.d.ts +16 -0
  82. package/esm/src/transpilers/openai-agents/OpenAiAgentsTranspiler.test.d.ts +1 -0
  83. package/esm/src/transpilers/openai-agents/register.d.ts +12 -0
  84. package/esm/src/types/LlmToolDefinition.d.ts +17 -7
  85. package/esm/src/utils/agents/resolveAgentAvatarImageUrl.d.ts +15 -0
  86. package/esm/src/utils/markdown/humanizeAiTextEmdashed.d.ts +1 -1
  87. package/esm/src/version.d.ts +1 -1
  88. package/package.json +1 -1
  89. package/umd/index.umd.js +3 -3
  90. package/umd/src/_packages/cli.index.d.ts +10 -0
  91. package/umd/src/_packages/core.index.d.ts +12 -0
  92. package/umd/src/_packages/types.index.d.ts +8 -0
  93. package/umd/src/_packages/wizard.index.d.ts +10 -0
  94. package/umd/src/avatars/index.d.ts +1 -1
  95. package/umd/src/avatars/types/AvatarVisualDefinition.d.ts +1 -1
  96. package/umd/src/avatars/visuals/avatarVisualRegistry.d.ts +12 -0
  97. package/umd/src/avatars/visuals/orbAvatarVisual.d.ts +48 -0
  98. package/umd/src/avatars/visuals/orbAvatarVisual.test.d.ts +1 -0
  99. package/umd/src/book-2.0/agent-source/AgentBasicInformation.d.ts +2 -0
  100. package/umd/src/book-2.0/agent-source/createAgentModelRequirementsWithCommitments/ParsedAgentSourceWithCommitments.d.ts +7 -0
  101. package/umd/src/book-2.0/agent-source/createAgentModelRequirementsWithCommitments/applyCommitmentsToAgentModelRequirements.d.ts +14 -0
  102. package/umd/src/book-2.0/agent-source/createAgentModelRequirementsWithCommitments/augmentAgentModelRequirementsFromSource.d.ts +14 -0
  103. package/umd/src/book-2.0/agent-source/createAgentModelRequirementsWithCommitments/filterCommitmentsForAgentModelRequirements.d.ts +10 -0
  104. package/umd/src/book-2.0/agent-source/createAgentModelRequirementsWithCommitments/materializeInlineKnowledgeSources.d.ts +12 -0
  105. package/umd/src/book-2.0/agent-source/parseAgentSource/ParseAgentSourceState.d.ts +10 -0
  106. package/umd/src/book-2.0/agent-source/parseAgentSource/ParsedAgentProfile.d.ts +7 -0
  107. package/umd/src/book-2.0/agent-source/parseAgentSource/applyMetaCommitment.d.ts +8 -0
  108. package/umd/src/book-2.0/agent-source/parseAgentSource/consumeConversationSampleCommitment.d.ts +8 -0
  109. package/umd/src/book-2.0/agent-source/parseAgentSource/createCapabilitiesFromCommitment.d.ts +9 -0
  110. package/umd/src/book-2.0/agent-source/parseAgentSource/ensureMetaFullname.d.ts +7 -0
  111. package/umd/src/book-2.0/agent-source/parseAgentSource/extractAgentProfileText.d.ts +8 -0
  112. package/umd/src/book-2.0/agent-source/parseAgentSource/extractInitialMessage.d.ts +7 -0
  113. package/umd/src/book-2.0/agent-source/parseAgentSource/extractParsedAgentProfile.d.ts +8 -0
  114. package/umd/src/book-2.0/agent-source/parseAgentSourceWithCommitments.use.test.d.ts +1 -0
  115. package/umd/src/book-components/BookEditor/createDeprecatedCommitmentDiagnostics.d.ts +9 -8
  116. package/umd/src/commitments/ACTION/ACTION.d.ts +8 -2
  117. package/umd/src/commitments/ACTION/ACTION.test.d.ts +1 -0
  118. package/umd/src/commitments/DELETE/DELETE.d.ts +7 -3
  119. package/umd/src/commitments/DELETE/DELETE.test.d.ts +1 -0
  120. package/umd/src/commitments/FORMAT/FORMAT.d.ts +10 -4
  121. package/umd/src/commitments/FORMAT/FORMAT.test.d.ts +1 -0
  122. package/umd/src/commitments/GOAL/GOAL.d.ts +4 -0
  123. package/umd/src/commitments/KNOWLEDGE/KNOWLEDGE.d.ts +4 -0
  124. package/umd/src/commitments/META/META.d.ts +2 -0
  125. package/umd/src/commitments/META_AVATAR/META_AVATAR.d.ts +26 -0
  126. package/umd/src/commitments/MODEL/MODEL.d.ts +4 -0
  127. package/umd/src/commitments/MODEL/MODEL.test.d.ts +1 -0
  128. package/umd/src/commitments/RULE/RULE.d.ts +4 -0
  129. package/umd/src/commitments/TEAM/TEAM.d.ts +4 -0
  130. package/umd/src/commitments/TEMPLATE/TEMPLATE.d.ts +10 -4
  131. package/umd/src/commitments/_base/BaseCommitmentDefinition.d.ts +12 -0
  132. package/umd/src/commitments/_base/CommitmentDefinition.d.ts +21 -1
  133. package/umd/src/commitments/_common/getAllCommitmentDefinitions.test.d.ts +1 -0
  134. package/umd/src/commitments/_common/getCommitmentNoticeMetadata.d.ts +51 -0
  135. package/umd/src/commitments/_common/getCommitmentNoticeMetadata.test.d.ts +1 -0
  136. package/umd/src/commitments/_common/getGroupedCommitmentDefinitions.openClosed.test.d.ts +1 -0
  137. package/umd/src/commitments/_common/getGroupedCommitmentDefinitions.order.test.d.ts +1 -0
  138. package/umd/src/commitments/_common/getGroupedCommitmentDefinitions.use.test.d.ts +1 -0
  139. package/umd/src/commitments/_common/sortCommitmentDefinitions.d.ts +31 -0
  140. package/umd/src/commitments/_common/teamInternalAgentAccess.d.ts +51 -0
  141. package/umd/src/commitments/_common/toolRuntimeContext.d.ts +4 -0
  142. package/umd/src/commitments/index.d.ts +2 -2
  143. package/umd/src/commitments/index.test.d.ts +1 -0
  144. package/umd/src/llm-providers/agent/Agent.d.ts +2 -0
  145. package/umd/src/llm-providers/agent/RemoteAgent.d.ts +1 -0
  146. package/umd/src/llm-providers/agent/RemoteAgentOptions.d.ts +4 -0
  147. package/umd/src/playground/playground.d.ts +1 -0
  148. package/umd/src/transpilers/_common/BookTranspilerOptions.d.ts +20 -0
  149. package/umd/src/transpilers/_common/TranspiledTeamExport.d.ts +80 -0
  150. package/umd/src/transpilers/_common/createTranspiledTeamRuntimeSection.d.ts +55 -0
  151. package/umd/src/transpilers/_common/createZodSchemaSource.d.ts +40 -0
  152. package/umd/src/transpilers/_common/formatUsedToolFunctions.d.ts +18 -0
  153. package/umd/src/transpilers/_common/formatUsedToolFunctions.test.d.ts +1 -0
  154. package/umd/src/transpilers/_common/prepareSdkTranspilerContext.d.ts +48 -0
  155. package/umd/src/transpilers/_common/resolveClaudeModelName.d.ts +12 -0
  156. package/umd/src/transpilers/_common/transpiledTeamTranspilers.test.d.ts +1 -0
  157. package/umd/src/transpilers/agent-os/AgentOsTranspiler.d.ts +16 -0
  158. package/umd/src/transpilers/agent-os/AgentOsTranspiler.test.d.ts +1 -0
  159. package/umd/src/transpilers/agent-os/register.d.ts +12 -0
  160. package/umd/src/transpilers/anthropic-claude-managed/AnthropicClaudeManagedTranspiler.d.ts +16 -0
  161. package/umd/src/transpilers/anthropic-claude-managed/AnthropicClaudeManagedTranspiler.test.d.ts +1 -0
  162. package/umd/src/transpilers/anthropic-claude-managed/register.d.ts +12 -0
  163. package/umd/src/transpilers/anthropic-claude-sdk/AnthropicClaudeSdkTranspiler.d.ts +16 -0
  164. package/umd/src/transpilers/anthropic-claude-sdk/AnthropicClaudeSdkTranspiler.test.d.ts +1 -0
  165. package/umd/src/transpilers/anthropic-claude-sdk/register.d.ts +12 -0
  166. package/umd/src/transpilers/e2b/E2BTranspiler.d.ts +16 -0
  167. package/umd/src/transpilers/e2b/E2BTranspiler.test.d.ts +1 -0
  168. package/umd/src/transpilers/e2b/register.d.ts +12 -0
  169. package/umd/src/transpilers/openai-agents/OpenAiAgentsTranspiler.d.ts +16 -0
  170. package/umd/src/transpilers/openai-agents/OpenAiAgentsTranspiler.test.d.ts +1 -0
  171. package/umd/src/transpilers/openai-agents/register.d.ts +12 -0
  172. package/umd/src/types/LlmToolDefinition.d.ts +17 -7
  173. package/umd/src/utils/agents/resolveAgentAvatarImageUrl.d.ts +15 -0
  174. package/umd/src/utils/markdown/humanizeAiTextEmdashed.d.ts +1 -1
  175. package/umd/src/version.d.ts +1 -1
  176. package/esm/src/commitments/USE/USE.d.ts +0 -51
  177. package/umd/src/commitments/USE/USE.d.ts +0 -51
@@ -0,0 +1,8 @@
1
+ import type { ParsedCommitment } from '../../../commitments/_base/ParsedCommitment';
2
+ /**
3
+ * Resolves the public agent profile text from the last GOAL/GOALS commitment,
4
+ * falling back to the deprecated PERSONA/PERSONAE commitments when no goal exists.
5
+ *
6
+ * @private internal utility of `parseAgentSource`
7
+ */
8
+ export declare function extractAgentProfileText(commitments: ReadonlyArray<ParsedCommitment>): string | null;
@@ -0,0 +1,7 @@
1
+ import type { ParsedCommitment } from '../../../commitments/_base/ParsedCommitment';
2
+ /**
3
+ * Resolves the last INITIAL MESSAGE commitment, which is the public initial-message value.
4
+ *
5
+ * @private internal utility of `parseAgentSource`
6
+ */
7
+ export declare function extractInitialMessage(commitments: ReadonlyArray<ParsedCommitment>): string | null;
@@ -0,0 +1,8 @@
1
+ import type { ParsedCommitment } from '../../../commitments/_base/ParsedCommitment';
2
+ import type { ParsedAgentProfile } from './ParsedAgentProfile';
3
+ /**
4
+ * Collects capability, sample, meta, link, and knowledge-source data from commitments.
5
+ *
6
+ * @private internal utility of `parseAgentSource`
7
+ */
8
+ export declare function extractParsedAgentProfile(commitments: ReadonlyArray<ParsedCommitment>): ParsedAgentProfile;
@@ -1,10 +1,10 @@
1
1
  import type { string_book } from '../../book-2.0/agent-source/string_book';
2
2
  /**
3
- * Monaco diagnostic shape used by deprecated-commitment warnings.
3
+ * Monaco diagnostic shape used by deprecated, unfinished, and low-level commitment warnings.
4
4
  *
5
5
  * @private internal type of `BookEditorMonaco`
6
6
  */
7
- type DeprecatedCommitmentDiagnostic = {
7
+ type CommitmentNoticeDiagnostic = {
8
8
  readonly startLineNumber: number;
9
9
  readonly startColumn: number;
10
10
  readonly endLineNumber: number;
@@ -14,16 +14,17 @@ type DeprecatedCommitmentDiagnostic = {
14
14
  readonly severity: 'warning';
15
15
  };
16
16
  /**
17
- * Creates Book editor diagnostics for deprecated commitment keywords.
17
+ * Creates Book editor diagnostics for deprecated, unfinished, and low-level commitment keywords.
18
18
  *
19
- * The deprecation metadata is UI-only. This helper surfaces it in Monaco so
20
- * legacy commitments remain functional while still guiding authors toward
21
- * preferred replacements.
19
+ * The notice metadata is UI-only. This helper surfaces it in Monaco so legacy,
20
+ * unfinished, and low-level commitments remain functional while still guiding
21
+ * authors toward preferred replacements or cautioning them about low-level
22
+ * usage.
22
23
  *
23
24
  * @param agentSource - Current editor content.
24
- * @returns Warning markers for deprecated commitment keywords.
25
+ * @returns Warning markers for deprecated, unfinished, and low-level commitment keywords.
25
26
  *
26
27
  * @private internal utility of `BookEditorMonaco`
27
28
  */
28
- export declare function createDeprecatedCommitmentDiagnostics(agentSource?: string_book): ReadonlyArray<DeprecatedCommitmentDiagnostic>;
29
+ export declare function createDeprecatedCommitmentDiagnostics(agentSource?: string_book): ReadonlyArray<CommitmentNoticeDiagnostic>;
29
30
  export {};
@@ -3,8 +3,8 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
3
3
  /**
4
4
  * ACTION commitment definition
5
5
  *
6
- * The ACTION commitment defines specific actions or capabilities that the agent can perform.
7
- * This helps define what the agent is capable of doing and how it should approach tasks.
6
+ * Deprecated legacy commitment for broad capability notes.
7
+ * New books should prefer the appropriate `USE*` commitment instead.
8
8
  *
9
9
  * Example usage in agent source:
10
10
  *
@@ -21,6 +21,12 @@ export declare class ActionCommitmentDefinition extends BaseCommitmentDefinition
21
21
  * Short one-line description of ACTION.
22
22
  */
23
23
  get description(): string;
24
+ /**
25
+ * Optional UI/docs-only deprecation metadata.
26
+ */
27
+ get deprecation(): {
28
+ readonly message: "Use a concrete `USE*` commitment instead.";
29
+ };
24
30
  /**
25
31
  * Icon for this commitment.
26
32
  */
@@ -0,0 +1 @@
1
+ export {};
@@ -3,9 +3,9 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
3
3
  /**
4
4
  * DELETE commitment definition
5
5
  *
6
- * The DELETE commitment (and its aliases CANCEL, DISCARD, REMOVE) is used to
7
- * remove or disregard certain information or context. This can be useful for
8
- * overriding previous commitments or removing unwanted behaviors.
6
+ * The DELETE commitment (and its aliases CANCEL, DISCARD, REMOVE) is a low-level
7
+ * unfinished commitment used to remove or disregard certain information or context.
8
+ * It is intentionally surfaced with caution because it is not ready for broad use yet.
9
9
  *
10
10
  * Example usage in agent source:
11
11
  *
@@ -24,6 +24,10 @@ export declare class DeleteCommitmentDefinition extends BaseCommitmentDefinition
24
24
  * Short one-line description of DELETE/CANCEL/DISCARD/REMOVE.
25
25
  */
26
26
  get description(): string;
27
+ /**
28
+ * Marks DELETE as unfinished and not ready to use.
29
+ */
30
+ get isUnfinished(): boolean;
27
31
  /**
28
32
  * Icon for this commitment.
29
33
  */
@@ -0,0 +1 @@
1
+ export {};
@@ -3,11 +3,10 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
3
3
  /**
4
4
  * FORMAT commitment definition
5
5
  *
6
- * The FORMAT commitment defines the specific output structure and formatting
7
- * that the agent should use in its responses. This includes data formats,
8
- * response templates, and structural requirements.
6
+ * Deprecated legacy commitment for output formatting and response structure.
7
+ * New books should prefer `WRITING SAMPLE` and `WRITING RULES`.
9
8
  *
10
- * Example usage in agent source:
9
+ * Legacy example usage in agent source:
11
10
  *
12
11
  * ```book
13
12
  * FORMAT Always respond in JSON format with 'status' and 'data' fields
@@ -22,6 +21,13 @@ export declare class FormatCommitmentDefinition extends BaseCommitmentDefinition
22
21
  * Short one-line description of FORMAT.
23
22
  */
24
23
  get description(): string;
24
+ /**
25
+ * Optional UI/docs-only deprecation metadata.
26
+ */
27
+ get deprecation(): {
28
+ readonly message: "Use `WRITING SAMPLE` and `WRITING RULES` instead.";
29
+ readonly replacedBy: readonly ["WRITING SAMPLE", "WRITING RULES"];
30
+ };
25
31
  /**
26
32
  * Icon for this commitment.
27
33
  */
@@ -0,0 +1 @@
1
+ export {};
@@ -22,6 +22,10 @@ export declare class GoalCommitmentDefinition extends BaseCommitmentDefinition<'
22
22
  * Short one-line description of GOAL.
23
23
  */
24
24
  get description(): string;
25
+ /**
26
+ * Marks GOAL as one of the priority commitments surfaced first in catalogues.
27
+ */
28
+ get isImportant(): boolean;
25
29
  /**
26
30
  * Icon for this commitment.
27
31
  */
@@ -24,6 +24,10 @@ export declare class KnowledgeCommitmentDefinition extends BaseCommitmentDefinit
24
24
  * Short one-line description of KNOWLEDGE.
25
25
  */
26
26
  get description(): string;
27
+ /**
28
+ * Marks KNOWLEDGE as one of the priority commitments surfaced first in catalogues.
29
+ */
30
+ get isImportant(): boolean;
27
31
  /**
28
32
  * Icon for this commitment.
29
33
  */
@@ -4,6 +4,7 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
4
4
  * META commitment definition
5
5
  *
6
6
  * The META commitment handles all meta-information about the agent such as:
7
+ * - META AVATAR: Sets the agent's built-in default avatar visual
7
8
  * - META IMAGE: Sets the agent's avatar/profile image URL
8
9
  * - META LINK: Provides profile/source links for the person the agent models
9
10
  * - META DOMAIN: Sets the canonical custom domain/host of the agent
@@ -18,6 +19,7 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
18
19
  * Example usage in agent source:
19
20
  *
20
21
  * ```book
22
+ * META AVATAR pixel-art
21
23
  * META IMAGE https://example.com/avatar.jpg
22
24
  * META LINK https://twitter.com/username
23
25
  * META DOMAIN my-agent.com
@@ -0,0 +1,26 @@
1
+ import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
2
+ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
3
+ /**
4
+ * META AVATAR commitment definition
5
+ *
6
+ * The `META AVATAR` commitment sets the built-in default avatar visual used when
7
+ * the agent does not provide an explicit `META IMAGE`.
8
+ *
9
+ * @private [🪔] Maybe export the commitments through some package
10
+ */
11
+ export declare class MetaAvatarCommitmentDefinition extends BaseCommitmentDefinition<'META AVATAR'> {
12
+ constructor();
13
+ /**
14
+ * Short one-line description of META AVATAR.
15
+ */
16
+ get description(): string;
17
+ /**
18
+ * Icon for this commitment.
19
+ */
20
+ get icon(): string;
21
+ /**
22
+ * Markdown documentation for META AVATAR commitment.
23
+ */
24
+ get documentation(): string;
25
+ applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
26
+ }
@@ -31,6 +31,10 @@ export declare class ModelCommitmentDefinition extends BaseCommitmentDefinition<
31
31
  * Short one-line description of MODEL.
32
32
  */
33
33
  get description(): string;
34
+ /**
35
+ * Marks MODEL as a low-level commitment surfaced with caution.
36
+ */
37
+ get isLowLevel(): boolean;
34
38
  /**
35
39
  * Icon for this commitment.
36
40
  */
@@ -0,0 +1 @@
1
+ export {};
@@ -21,6 +21,10 @@ export declare class RuleCommitmentDefinition extends BaseCommitmentDefinition<'
21
21
  * Short one-line description of RULE/RULES.
22
22
  */
23
23
  get description(): string;
24
+ /**
25
+ * Marks RULE as one of the priority commitments surfaced first in catalogues.
26
+ */
27
+ get isImportant(): boolean;
24
28
  /**
25
29
  * Icon for this commitment.
26
30
  */
@@ -22,6 +22,10 @@ export declare class TeamCommitmentDefinition extends BaseCommitmentDefinition<'
22
22
  * Short one-line description of TEAM.
23
23
  */
24
24
  get description(): string;
25
+ /**
26
+ * Marks TEAM as one of the priority commitments surfaced first in catalogues.
27
+ */
28
+ get isImportant(): boolean;
25
29
  /**
26
30
  * Icon for this commitment.
27
31
  */
@@ -3,11 +3,10 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
3
3
  /**
4
4
  * TEMPLATE commitment definition
5
5
  *
6
- * The TEMPLATE commitment enforces a specific response structure or template
7
- * that the agent must follow when generating responses. This helps ensure
8
- * consistent message formatting across all agent interactions.
6
+ * Deprecated legacy commitment for response templates and output structure.
7
+ * New books should prefer `WRITING SAMPLE` and `WRITING RULES`.
9
8
  *
10
- * Example usage in agent source:
9
+ * Legacy example usage in agent source:
11
10
  *
12
11
  * ```book
13
12
  * TEMPLATE Always structure your response with: 1) Summary, 2) Details, 3) Next steps
@@ -25,6 +24,13 @@ export declare class TemplateCommitmentDefinition extends BaseCommitmentDefiniti
25
24
  * Short one-line description of TEMPLATE.
26
25
  */
27
26
  get description(): string;
27
+ /**
28
+ * Optional UI/docs-only deprecation metadata.
29
+ */
30
+ get deprecation(): {
31
+ readonly message: "Use `WRITING SAMPLE` and `WRITING RULES` instead.";
32
+ readonly replacedBy: readonly ["WRITING SAMPLE", "WRITING RULES"];
33
+ };
28
34
  /**
29
35
  * Icon for this commitment.
30
36
  */
@@ -28,6 +28,18 @@ export declare abstract class BaseCommitmentDefinition<TBookCommitment extends s
28
28
  * It should be a single emoji.
29
29
  */
30
30
  abstract get icon(): string;
31
+ /**
32
+ * Whether this commitment should be prioritized in menus, documentation, and intellisense.
33
+ */
34
+ get isImportant(): boolean;
35
+ /**
36
+ * Whether this commitment is unfinished and not ready to use.
37
+ */
38
+ get isUnfinished(): boolean;
39
+ /**
40
+ * Whether this commitment is low-level and should be surfaced with caution.
41
+ */
42
+ get isLowLevel(): boolean;
31
43
  /**
32
44
  * Human-readable markdown documentation for this commitment, available at runtime.
33
45
  * Must be implemented by each concrete commitment.
@@ -17,11 +17,13 @@ type CommitmentDeprecation = {
17
17
  readonly replacedBy?: ReadonlyArray<string>;
18
18
  };
19
19
  /**
20
- * Definition of a commitment that can be applied to agent model requirements
20
+ * Definition of a commitment that can be applied to agent model requirements.
21
21
  *
22
22
  * Each commitment is self-contained and manages its own logic for:
23
23
  * - Creating regex patterns for parsing
24
24
  * - Applying its effects to agent model requirements
25
+ *
26
+ * @public exported from `@promptbook/core`
25
27
  */
26
28
  export type CommitmentDefinition = {
27
29
  /**
@@ -38,6 +40,24 @@ export type CommitmentDefinition = {
38
40
  * It should be a single emoji.
39
41
  */
40
42
  readonly icon: string;
43
+ /**
44
+ * Whether this commitment should be prioritized in menus, documentation, and intellisense.
45
+ */
46
+ readonly isImportant: boolean;
47
+ /**
48
+ * Whether this commitment is unfinished and not ready to use.
49
+ *
50
+ * Unfinished commitments are surfaced with low-level caution in the UI,
51
+ * documentation, and editor diagnostics.
52
+ */
53
+ readonly isUnfinished: boolean;
54
+ /**
55
+ * Whether this commitment is low-level and should be surfaced with caution.
56
+ *
57
+ * Low-level commitments are fully implemented, but they are intended for
58
+ * advanced use and are not used by most users.
59
+ */
60
+ readonly isLowLevel: boolean;
41
61
  /**
42
62
  * Human-readable markdown documentation for this commitment.
43
63
  * Should explain what the commitment does and include example usage.
@@ -0,0 +1,51 @@
1
+ import type { CommitmentDefinition } from '../_base/CommitmentDefinition';
2
+ /**
3
+ * Type of commitment notice surfaced in docs and editor UI.
4
+ *
5
+ * @private internal type of commitment catalog presentation
6
+ */
7
+ export type CommitmentNoticeMetadata = {
8
+ /**
9
+ * Machine-readable notice kind.
10
+ */
11
+ readonly kind: 'deprecated' | 'unfinished' | 'lowLevel';
12
+ /**
13
+ * Short badge label shown in documentation and menus.
14
+ */
15
+ readonly badgeLabel: string;
16
+ /**
17
+ * Longer label used in documentation bodies and editor details.
18
+ */
19
+ readonly detailLabel: string;
20
+ /**
21
+ * Human-readable notice message shown in editor and documentation callouts.
22
+ */
23
+ readonly message: string;
24
+ };
25
+ /**
26
+ * Formats preferred replacement guidance for deprecated commitments.
27
+ *
28
+ * @param replacedBy - Preferred replacement commitment keywords.
29
+ * @returns Optional replacement guidance sentence with leading space.
30
+ *
31
+ * @private internal utility of commitment catalog notices
32
+ */
33
+ export declare function formatCommitmentReplacementText(replacedBy?: ReadonlyArray<string>): string;
34
+ /**
35
+ * Returns true when one commitment notice should be rendered with low-visibility styling.
36
+ *
37
+ * @param notice - Commitment notice metadata or null.
38
+ * @returns True for unfinished and low-level notices.
39
+ *
40
+ * @private internal utility of commitment catalog notices
41
+ */
42
+ export declare function isLowVisibilityCommitmentNotice(notice: CommitmentNoticeMetadata | null): boolean;
43
+ /**
44
+ * Resolves the notice metadata for deprecated, unfinished, or low-level commitments.
45
+ *
46
+ * @param definition - Commitment definition to inspect.
47
+ * @returns Notice metadata when the commitment should be surfaced with caution.
48
+ *
49
+ * @private internal utility of commitment catalog notices
50
+ */
51
+ export declare function getCommitmentNoticeMetadata(definition: Pick<CommitmentDefinition, 'deprecation'> & Partial<Pick<CommitmentDefinition, 'isUnfinished' | 'isLowLevel'>>): CommitmentNoticeMetadata | null;
@@ -0,0 +1,31 @@
1
+ import type { CommitmentDefinition } from '../_base/CommitmentDefinition';
2
+ /**
3
+ * Sorting options for commitment definitions.
4
+ *
5
+ * @private internal helper of commitment catalog sorting
6
+ */
7
+ type CommitmentDefinitionSortOptions = {
8
+ /**
9
+ * When enabled, deprecated commitments are moved behind all non-deprecated commitments.
10
+ */
11
+ readonly isDeprecatedLast?: boolean;
12
+ /**
13
+ * When enabled, unfinished commitments are moved behind all other commitments.
14
+ */
15
+ readonly isUnfinishedLast?: boolean;
16
+ /**
17
+ * When enabled, low-level commitments are moved behind all other commitments.
18
+ */
19
+ readonly isLowLevelLast?: boolean;
20
+ };
21
+ /**
22
+ * Sorts commitment definitions so the important ones stay at the top.
23
+ *
24
+ * @param commitmentDefinitions - Definitions to sort.
25
+ * @param options - Sorting options.
26
+ * @returns Sorted commitment definitions.
27
+ *
28
+ * @private internal helper of commitment catalog sorting
29
+ */
30
+ export declare function sortCommitmentDefinitions<TCommitmentDefinition extends CommitmentDefinition>(commitmentDefinitions: ReadonlyArray<TCommitmentDefinition>, options?: CommitmentDefinitionSortOptions): ReadonlyArray<TCommitmentDefinition>;
31
+ export {};
@@ -0,0 +1,51 @@
1
+ /**
2
+ * Header used for same-server TEAM calls that may access private teammate agents.
3
+ *
4
+ * @private internal Agents Server access wiring
5
+ */
6
+ export declare const TEAM_INTERNAL_AGENT_ACCESS_HEADER = "x-promptbook-team-agent-access-token";
7
+ /**
8
+ * Options for creating same-server TEAM access headers.
9
+ *
10
+ * @private internal Agents Server access wiring
11
+ */
12
+ export type TeamInternalAgentAccessHeadersOptions = {
13
+ /**
14
+ * URL of the teammate agent that is about to be contacted.
15
+ */
16
+ readonly agentUrl: string;
17
+ /**
18
+ * Origin of the current Agents Server.
19
+ */
20
+ readonly localServerUrl?: string;
21
+ /**
22
+ * Resolved internal access token carried by the runtime context.
23
+ */
24
+ readonly accessToken?: string | null;
25
+ };
26
+ /**
27
+ * Resolves the internal token used by same-server TEAM calls.
28
+ *
29
+ * @returns Hashed token, or `null` when the server does not have a private secret.
30
+ *
31
+ * @private internal Agents Server access wiring
32
+ */
33
+ export declare function resolveTeamInternalAgentAccessToken(): string | null;
34
+ /**
35
+ * Creates request headers for same-server TEAM calls.
36
+ *
37
+ * @param options - Target agent URL, local server URL, and resolved access token.
38
+ * @returns Header map when the target is same-origin; otherwise an empty map.
39
+ *
40
+ * @private internal Agents Server access wiring
41
+ */
42
+ export declare function createTeamInternalAgentAccessHeaders(options: TeamInternalAgentAccessHeadersOptions): Record<string, string>;
43
+ /**
44
+ * Checks whether an incoming header carries the current same-server TEAM access token.
45
+ *
46
+ * @param value - Raw request header value.
47
+ * @returns `true` only when the server has a private token and the value matches it.
48
+ *
49
+ * @private internal Agents Server access wiring
50
+ */
51
+ export declare function isTeamInternalAgentAccessToken(value: string | null | undefined): boolean;
@@ -94,6 +94,10 @@ export type ToolRuntimeContext = {
94
94
  scopes?: string[];
95
95
  }>;
96
96
  };
97
+ agentsServer?: {
98
+ localServerUrl?: string;
99
+ teamInternalAccessToken?: string;
100
+ };
97
101
  spawn?: {
98
102
  depth?: number;
99
103
  parentRunId?: string;
@@ -17,6 +17,7 @@ import { MessageCommitmentDefinition } from './MESSAGE/MESSAGE';
17
17
  import { UserMessageCommitmentDefinition } from './MESSAGE/UserMessageCommitmentDefinition';
18
18
  import { MessageSuffixCommitmentDefinition } from './MESSAGE_SUFFIX/MESSAGE_SUFFIX';
19
19
  import { MetaCommitmentDefinition } from './META/META';
20
+ import { MetaAvatarCommitmentDefinition } from './META_AVATAR/META_AVATAR';
20
21
  import { MetaColorCommitmentDefinition } from './META_COLOR/META_COLOR';
21
22
  import { MetaDomainCommitmentDefinition } from './META_DOMAIN/META_DOMAIN';
22
23
  import { MetaDisclaimerCommitmentDefinition } from './META_DISCLAIMER/META_DISCLAIMER';
@@ -35,7 +36,6 @@ import { ScenarioCommitmentDefinition } from './SCENARIO/SCENARIO';
35
36
  import { StyleCommitmentDefinition } from './STYLE/STYLE';
36
37
  import { TeamCommitmentDefinition } from './TEAM/TEAM';
37
38
  import { TemplateCommitmentDefinition } from './TEMPLATE/TEMPLATE';
38
- import { UseCommitmentDefinition } from './USE/USE';
39
39
  import { UseBrowserCommitmentDefinition } from './USE_BROWSER/USE_BROWSER';
40
40
  import { UseCalendarCommitmentDefinition } from './USE_CALENDAR/USE_CALENDAR';
41
41
  import { UseDeepSearchCommitmentDefinition } from './USE_DEEPSEARCH/USE_DEEPSEARCH';
@@ -60,4 +60,4 @@ import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplemented
60
60
  *
61
61
  * @private Use functions to access commitments instead of this array directly
62
62
  */
63
- 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, UseDeepSearchCommitmentDefinition, 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">];
63
+ 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, MetaAvatarCommitmentDefinition, 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, UseDeepSearchCommitmentDefinition, UseSearchEngineCommitmentDefinition, UseSpawnCommitmentDefinition, UseTimeoutCommitmentDefinition, UseTimeCommitmentDefinition, UseUserLocationCommitmentDefinition, UseCalendarCommitmentDefinition, UseEmailCommitmentDefinition, UsePopupCommitmentDefinition, UseImageGeneratorCommitmentDefinition, UseMcpCommitmentDefinition, UsePrivacyCommitmentDefinition, UseProjectCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
@@ -0,0 +1 @@
1
+ export {};
@@ -5,6 +5,7 @@ import type { CallChatModelStreamOptions, LlmExecutionTools } from '../../execut
5
5
  import type { ChatPromptResult } from '../../execution/PromptResult';
6
6
  import type { Prompt } from '../../types/Prompt';
7
7
  import type { string_agent_hash, string_agent_name, string_agent_url, string_color, string_fonts, string_url_image } from '../../types/typeAliases';
8
+ import type { AvatarVisualId } from '../../avatars/types/AvatarVisualDefinition';
8
9
  import { AgentLlmExecutionTools } from './AgentLlmExecutionTools';
9
10
  import type { AgentOptions } from './AgentOptions';
10
11
  /**
@@ -69,6 +70,7 @@ export declare class Agent extends AgentLlmExecutionTools implements LlmExecutio
69
70
  meta: {
70
71
  fullname?: string;
71
72
  image?: string_url_image;
73
+ avatar?: AvatarVisualId;
72
74
  link?: string;
73
75
  font?: string_fonts;
74
76
  color?: string_color;
@@ -24,6 +24,7 @@ export declare class RemoteAgent extends Agent {
24
24
  * The source of the agent
25
25
  */
26
26
  private agentUrl;
27
+ private requestHeaders;
27
28
  private _remoteAgentName;
28
29
  private _remoteAgentHash;
29
30
  toolTitles: Record<string, string>;
@@ -8,4 +8,8 @@ export type RemoteAgentOptions = Omit<CommonToolsOptions, 'teacherAgent'> & {
8
8
  * Url of the remote agent
9
9
  */
10
10
  agentUrl: string_agent_url;
11
+ /**
12
+ * Additional HTTP headers sent to the remote agent profile, chat, and voice endpoints.
13
+ */
14
+ requestHeaders?: Record<string, string>;
11
15
  };
@@ -1,2 +1,3 @@
1
1
  #!/usr/bin/env ts-node
2
2
  export {};
3
+ /** Note: [⚫] Code for archived playground [_playground-boilerplate.ts](src/playground/backup/_playground-boilerplate.ts.txt) should never be published in any package */
@@ -1,4 +1,8 @@
1
+ import type { AgentReferenceResolver } from '../../book-2.0/agent-source/AgentReferenceResolver';
2
+ import type { TeammateProfileResolver } from '../../book-2.0/agent-source/TeammateProfileResolver';
1
3
  import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
4
+ import type { InlineKnowledgeSourceUploader } from '../../utils/knowledge/inlineKnowledgeSource';
5
+ import type { TranspiledTeamExport } from './TranspiledTeamExport';
2
6
  /**
3
7
  * Options for the BookTranspiler.
4
8
  */
@@ -15,4 +19,20 @@ export type BookTranspilerOptions = Omit<CommonToolsOptions, 'maxRequestsPerMinu
15
19
  * @default true
16
20
  */
17
21
  readonly shouldIncludeComments?: boolean;
22
+ /**
23
+ * Resolver that transforms compact agent references into concrete URLs before transpilation.
24
+ */
25
+ readonly agentReferenceResolver?: AgentReferenceResolver;
26
+ /**
27
+ * Optional hook used to upload inline knowledge files before finalizing transpiled model requirements.
28
+ */
29
+ readonly inlineKnowledgeSourceUploader?: InlineKnowledgeSourceUploader;
30
+ /**
31
+ * Optional resolver that provides actual agent names and descriptions for teammate URLs.
32
+ */
33
+ readonly teammateProfileResolver?: TeammateProfileResolver;
34
+ /**
35
+ * Built-in TEAM hierarchy resolved by Agents Server for self-contained transpiled exports.
36
+ */
37
+ readonly transpiledTeam?: TranspiledTeamExport;
18
38
  };