@promptbook/javascript 0.114.0-3 → 0.114.0-5

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 (152) hide show
  1. package/README.md +4 -12
  2. package/esm/index.es.js +1 -1
  3. package/esm/src/book-2.0/agent-source/AgentBasicInformation.d.ts +3 -3
  4. package/esm/src/cli/cli-commands/coder/boilerplateCount.d.ts +52 -0
  5. package/esm/src/cli/cli-commands/coder/generate-boilerplates.d.ts +3 -2
  6. package/esm/src/cli/cli-commands/coder/verify.d.ts +1 -1
  7. package/esm/src/commitments/{COMPONENT/COMPONENT.d.ts → META_FULLNAME/META_FULLNAME.d.ts} +8 -5
  8. package/esm/src/commitments/META_ID/META_ID.d.ts +32 -0
  9. package/esm/src/commitments/index.d.ts +4 -12
  10. package/esm/src/llm-providers/agent/Agent.d.ts +1 -1
  11. package/esm/src/llm-providers/openai/OpenAiAgentKitExecutionToolsToolBuilder.d.ts +1 -1
  12. package/esm/src/{commitments/USE_BROWSER → scrapers/_common/utils}/fetchUrlContent.d.ts +2 -3
  13. package/esm/src/version.d.ts +1 -1
  14. package/package.json +2 -2
  15. package/umd/index.umd.js +1 -1
  16. package/umd/src/book-2.0/agent-source/AgentBasicInformation.d.ts +3 -3
  17. package/umd/src/cli/cli-commands/coder/boilerplateCount.d.ts +52 -0
  18. package/umd/src/cli/cli-commands/coder/generate-boilerplates.d.ts +3 -2
  19. package/umd/src/cli/cli-commands/coder/verify.d.ts +1 -1
  20. package/umd/src/commitments/{COMPONENT/COMPONENT.d.ts → META_FULLNAME/META_FULLNAME.d.ts} +8 -5
  21. package/umd/src/commitments/META_ID/META_ID.d.ts +32 -0
  22. package/umd/src/commitments/index.d.ts +4 -12
  23. package/umd/src/llm-providers/agent/Agent.d.ts +1 -1
  24. package/umd/src/llm-providers/openai/OpenAiAgentKitExecutionToolsToolBuilder.d.ts +1 -1
  25. package/umd/src/{commitments/USE_BROWSER → scrapers/_common/utils}/fetchUrlContent.d.ts +2 -3
  26. package/umd/src/version.d.ts +1 -1
  27. package/esm/src/commitments/MEMORY/MEMORY.d.ts +0 -48
  28. package/esm/src/commitments/MEMORY/MemoryToolNames.d.ts +0 -11
  29. package/esm/src/commitments/MEMORY/MemoryToolRuntimeAdapter.d.ts +0 -149
  30. package/esm/src/commitments/MEMORY/createMemorySystemMessage.d.ts +0 -6
  31. package/esm/src/commitments/MEMORY/createMemoryToolFunctions.d.ts +0 -8
  32. package/esm/src/commitments/MEMORY/createMemoryTools.d.ts +0 -14
  33. package/esm/src/commitments/MEMORY/getMemoryCommitmentDocumentation.d.ts +0 -6
  34. package/esm/src/commitments/MEMORY/getMemoryToolRuntimeAdapterOrDisabledResult.d.ts +0 -17
  35. package/esm/src/commitments/MEMORY/getMemoryToolTitles.d.ts +0 -7
  36. package/esm/src/commitments/MEMORY/parseMemoryToolArgs.d.ts +0 -61
  37. package/esm/src/commitments/MEMORY/resolveMemoryRuntimeContext.d.ts +0 -8
  38. package/esm/src/commitments/MEMORY/setMemoryToolRuntimeAdapter.d.ts +0 -13
  39. package/esm/src/commitments/META/META.d.ts +0 -65
  40. package/esm/src/commitments/USE/aggregateUseCommitmentSystemMessages.d.ts +0 -32
  41. package/esm/src/commitments/USE_BROWSER/USE_BROWSER.d.ts +0 -58
  42. package/esm/src/commitments/USE_BROWSER/fetchUrlContentViaBrowser.d.ts +0 -13
  43. package/esm/src/commitments/USE_BROWSER/resolveRunBrowserToolForNode.d.ts +0 -10
  44. package/esm/src/commitments/USE_DEEPSEARCH/USE_DEEPSEARCH.d.ts +0 -47
  45. package/esm/src/commitments/USE_EMAIL/USE_EMAIL.d.ts +0 -38
  46. package/esm/src/commitments/USE_EMAIL/parseUseEmailCommitmentContent.d.ts +0 -21
  47. package/esm/src/commitments/USE_EMAIL/parseUseEmailCommitmentContent.test.d.ts +0 -1
  48. package/esm/src/commitments/USE_EMAIL/resolveSendEmailToolForNode.d.ts +0 -11
  49. package/esm/src/commitments/USE_EMAIL/sendEmailViaBrowser.d.ts +0 -13
  50. package/esm/src/commitments/USE_SEARCH_ENGINE/USE_SEARCH_ENGINE.d.ts +0 -46
  51. package/esm/src/commitments/USE_SEARCH_ENGINE/USE_SEARCH_ENGINE.test.d.ts +0 -1
  52. package/esm/src/commitments/USE_SPAWN/USE_SPAWN.d.ts +0 -38
  53. package/esm/src/commitments/USE_SPAWN/USE_SPAWN.test.d.ts +0 -1
  54. package/esm/src/commitments/USE_SPAWN/resolveSpawnAgentToolForNode.d.ts +0 -9
  55. package/esm/src/commitments/USE_SPAWN/spawnAgentViaBrowser.d.ts +0 -12
  56. package/esm/src/commitments/USE_TIME/USE_TIME.d.ts +0 -43
  57. package/esm/src/commitments/USE_TIME/USE_TIME.test.d.ts +0 -1
  58. package/esm/src/commitments/USE_TIMEOUT/TimeoutToolNames.d.ts +0 -11
  59. package/esm/src/commitments/USE_TIMEOUT/TimeoutToolRuntimeAdapter.d.ts +0 -212
  60. package/esm/src/commitments/USE_TIMEOUT/USE_TIMEOUT.d.ts +0 -38
  61. package/esm/src/commitments/USE_TIMEOUT/USE_TIMEOUT.test.d.ts +0 -1
  62. package/esm/src/commitments/USE_TIMEOUT/createTimeoutSystemMessage.d.ts +0 -6
  63. package/esm/src/commitments/USE_TIMEOUT/createTimeoutToolFunctions.d.ts +0 -8
  64. package/esm/src/commitments/USE_TIMEOUT/createTimeoutTools.d.ts +0 -7
  65. package/esm/src/commitments/USE_TIMEOUT/getTimeoutToolRuntimeAdapterOrDisabledResult.d.ts +0 -17
  66. package/esm/src/commitments/USE_TIMEOUT/parseTimeoutToolArgs.d.ts +0 -78
  67. package/esm/src/commitments/USE_TIMEOUT/resolveTimeoutRuntimeContext.d.ts +0 -8
  68. package/esm/src/commitments/USE_TIMEOUT/setTimeoutToolRuntimeAdapter.d.ts +0 -13
  69. package/esm/src/commitments/WALLET/WALLET.d.ts +0 -21
  70. package/esm/src/commitments/WALLET/WALLET.test.d.ts +0 -1
  71. package/esm/src/commitments/WALLET/WalletToolNames.d.ts +0 -12
  72. package/esm/src/commitments/WALLET/WalletToolRuntimeAdapter.d.ts +0 -163
  73. package/esm/src/commitments/WALLET/createWalletSystemMessage.d.ts +0 -6
  74. package/esm/src/commitments/WALLET/createWalletToolFunctions.d.ts +0 -8
  75. package/esm/src/commitments/WALLET/createWalletTools.d.ts +0 -7
  76. package/esm/src/commitments/WALLET/getWalletCommitmentDocumentation.d.ts +0 -6
  77. package/esm/src/commitments/WALLET/getWalletToolRuntimeAdapterOrDisabledResult.d.ts +0 -16
  78. package/esm/src/commitments/WALLET/getWalletToolTitles.d.ts +0 -7
  79. package/esm/src/commitments/WALLET/parseWalletToolArgs.d.ts +0 -51
  80. package/esm/src/commitments/WALLET/resolveWalletRuntimeContext.d.ts +0 -8
  81. package/esm/src/commitments/WALLET/setWalletToolRuntimeAdapter.d.ts +0 -13
  82. package/esm/src/commitments/_common/createSerpSearchToolFunction.d.ts +0 -12
  83. package/umd/src/book-2.0/agent-source/createAgentModelRequirements.useCommitmentAggregation.test.d.ts +0 -1
  84. package/umd/src/commitments/MEMORY/MEMORY.d.ts +0 -48
  85. package/umd/src/commitments/MEMORY/MEMORY.test.d.ts +0 -1
  86. package/umd/src/commitments/MEMORY/MemoryToolNames.d.ts +0 -11
  87. package/umd/src/commitments/MEMORY/MemoryToolRuntimeAdapter.d.ts +0 -149
  88. package/umd/src/commitments/MEMORY/createMemorySystemMessage.d.ts +0 -6
  89. package/umd/src/commitments/MEMORY/createMemoryToolFunctions.d.ts +0 -8
  90. package/umd/src/commitments/MEMORY/createMemoryTools.d.ts +0 -14
  91. package/umd/src/commitments/MEMORY/getMemoryCommitmentDocumentation.d.ts +0 -6
  92. package/umd/src/commitments/MEMORY/getMemoryToolRuntimeAdapterOrDisabledResult.d.ts +0 -17
  93. package/umd/src/commitments/MEMORY/getMemoryToolTitles.d.ts +0 -7
  94. package/umd/src/commitments/MEMORY/parseMemoryToolArgs.d.ts +0 -61
  95. package/umd/src/commitments/MEMORY/resolveMemoryRuntimeContext.d.ts +0 -8
  96. package/umd/src/commitments/MEMORY/setMemoryToolRuntimeAdapter.d.ts +0 -13
  97. package/umd/src/commitments/META/META.d.ts +0 -65
  98. package/umd/src/commitments/USE/aggregateUseCommitmentSystemMessages.d.ts +0 -32
  99. package/umd/src/commitments/USE_BROWSER/USE_BROWSER.d.ts +0 -58
  100. package/umd/src/commitments/USE_BROWSER/USE_BROWSER.test.d.ts +0 -1
  101. package/umd/src/commitments/USE_BROWSER/fetchUrlContentViaBrowser.d.ts +0 -13
  102. package/umd/src/commitments/USE_BROWSER/resolveRunBrowserToolForNode.d.ts +0 -10
  103. package/umd/src/commitments/USE_BROWSER/resolveRunBrowserToolForNode.test.d.ts +0 -1
  104. package/umd/src/commitments/USE_DEEPSEARCH/USE_DEEPSEARCH.d.ts +0 -47
  105. package/umd/src/commitments/USE_DEEPSEARCH/USE_DEEPSEARCH.test.d.ts +0 -1
  106. package/umd/src/commitments/USE_EMAIL/USE_EMAIL.d.ts +0 -38
  107. package/umd/src/commitments/USE_EMAIL/USE_EMAIL.test.d.ts +0 -1
  108. package/umd/src/commitments/USE_EMAIL/parseUseEmailCommitmentContent.d.ts +0 -21
  109. package/umd/src/commitments/USE_EMAIL/parseUseEmailCommitmentContent.test.d.ts +0 -1
  110. package/umd/src/commitments/USE_EMAIL/resolveSendEmailToolForNode.d.ts +0 -11
  111. package/umd/src/commitments/USE_EMAIL/sendEmailViaBrowser.d.ts +0 -13
  112. package/umd/src/commitments/USE_SEARCH_ENGINE/USE_SEARCH_ENGINE.d.ts +0 -46
  113. package/umd/src/commitments/USE_SEARCH_ENGINE/USE_SEARCH_ENGINE.test.d.ts +0 -1
  114. package/umd/src/commitments/USE_SPAWN/USE_SPAWN.d.ts +0 -38
  115. package/umd/src/commitments/USE_SPAWN/USE_SPAWN.test.d.ts +0 -1
  116. package/umd/src/commitments/USE_SPAWN/resolveSpawnAgentToolForNode.d.ts +0 -9
  117. package/umd/src/commitments/USE_SPAWN/spawnAgentViaBrowser.d.ts +0 -12
  118. package/umd/src/commitments/USE_TIME/USE_TIME.d.ts +0 -43
  119. package/umd/src/commitments/USE_TIME/USE_TIME.test.d.ts +0 -1
  120. package/umd/src/commitments/USE_TIMEOUT/TimeoutToolNames.d.ts +0 -11
  121. package/umd/src/commitments/USE_TIMEOUT/TimeoutToolRuntimeAdapter.d.ts +0 -212
  122. package/umd/src/commitments/USE_TIMEOUT/USE_TIMEOUT.d.ts +0 -38
  123. package/umd/src/commitments/USE_TIMEOUT/USE_TIMEOUT.test.d.ts +0 -1
  124. package/umd/src/commitments/USE_TIMEOUT/createTimeoutSystemMessage.d.ts +0 -6
  125. package/umd/src/commitments/USE_TIMEOUT/createTimeoutToolFunctions.d.ts +0 -8
  126. package/umd/src/commitments/USE_TIMEOUT/createTimeoutTools.d.ts +0 -7
  127. package/umd/src/commitments/USE_TIMEOUT/getTimeoutToolRuntimeAdapterOrDisabledResult.d.ts +0 -17
  128. package/umd/src/commitments/USE_TIMEOUT/parseTimeoutToolArgs.d.ts +0 -78
  129. package/umd/src/commitments/USE_TIMEOUT/resolveTimeoutRuntimeContext.d.ts +0 -8
  130. package/umd/src/commitments/USE_TIMEOUT/setTimeoutToolRuntimeAdapter.d.ts +0 -13
  131. package/umd/src/commitments/WALLET/WALLET.d.ts +0 -21
  132. package/umd/src/commitments/WALLET/WALLET.test.d.ts +0 -1
  133. package/umd/src/commitments/WALLET/WalletToolNames.d.ts +0 -12
  134. package/umd/src/commitments/WALLET/WalletToolRuntimeAdapter.d.ts +0 -163
  135. package/umd/src/commitments/WALLET/createWalletSystemMessage.d.ts +0 -6
  136. package/umd/src/commitments/WALLET/createWalletToolFunctions.d.ts +0 -8
  137. package/umd/src/commitments/WALLET/createWalletTools.d.ts +0 -7
  138. package/umd/src/commitments/WALLET/getWalletCommitmentDocumentation.d.ts +0 -6
  139. package/umd/src/commitments/WALLET/getWalletToolRuntimeAdapterOrDisabledResult.d.ts +0 -16
  140. package/umd/src/commitments/WALLET/getWalletToolTitles.d.ts +0 -7
  141. package/umd/src/commitments/WALLET/parseWalletToolArgs.d.ts +0 -51
  142. package/umd/src/commitments/WALLET/resolveWalletRuntimeContext.d.ts +0 -8
  143. package/umd/src/commitments/WALLET/setWalletToolRuntimeAdapter.d.ts +0 -13
  144. package/umd/src/commitments/_common/createSerpSearchToolFunction.d.ts +0 -12
  145. /package/esm/src/book-2.0/agent-source/{createAgentModelRequirements.useCommitmentAggregation.test.d.ts → createAgentModelRequirements.commitmentAggregation.test.d.ts} +0 -0
  146. /package/esm/src/{commitments/MEMORY/MEMORY.test.d.ts → cli/cli-commands/coder/boilerplateCount.test.d.ts} +0 -0
  147. /package/esm/src/{commitments/USE_BROWSER/USE_BROWSER.test.d.ts → cli/cli-commands/coder/generate-boilerplates.test.d.ts} +0 -0
  148. /package/esm/src/commitments/{META → META_DESCRIPTION}/META_DESCRIPTION.d.ts +0 -0
  149. /package/{esm/src/commitments/USE_BROWSER/resolveRunBrowserToolForNode.test.d.ts → umd/src/book-2.0/agent-source/createAgentModelRequirements.commitmentAggregation.test.d.ts} +0 -0
  150. /package/{esm/src/commitments/USE_DEEPSEARCH/USE_DEEPSEARCH.test.d.ts → umd/src/cli/cli-commands/coder/boilerplateCount.test.d.ts} +0 -0
  151. /package/{esm/src/commitments/USE_EMAIL/USE_EMAIL.test.d.ts → umd/src/cli/cli-commands/coder/generate-boilerplates.test.d.ts} +0 -0
  152. /package/umd/src/commitments/{META → META_DESCRIPTION}/META_DESCRIPTION.d.ts +0 -0
@@ -1,38 +0,0 @@
1
- import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
2
- import type { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
3
- import type { string_javascript_name } from '../../types/string_person_fullname';
4
- import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
5
- /**
6
- * USE EMAIL commitment definition.
7
- *
8
- * The `USE EMAIL` commitment enables outbound email sending through the `send_email` tool.
9
- *
10
- * @private [🪔] Maybe export the commitments through some package
11
- */
12
- export declare class UseEmailCommitmentDefinition extends BaseCommitmentDefinition<'USE EMAIL'> {
13
- constructor();
14
- get requiresContent(): boolean;
15
- /**
16
- * Short one-line description of USE EMAIL.
17
- */
18
- get description(): string;
19
- /**
20
- * Icon for this commitment.
21
- */
22
- get icon(): string;
23
- /**
24
- * Markdown documentation for USE EMAIL commitment.
25
- */
26
- get documentation(): string;
27
- applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
28
- /**
29
- * Gets human-readable titles for tool functions provided by this commitment.
30
- */
31
- getToolTitles(): Record<string_javascript_name, string>;
32
- /**
33
- * Gets the browser-safe `send_email` implementation.
34
- *
35
- * Node.js runtime overrides this via `getAllCommitmentsToolFunctionsForNode`.
36
- */
37
- getToolFunctions(): Record<string_javascript_name, ToolFunction>;
38
- }
@@ -1,21 +0,0 @@
1
- /**
2
- * Parsed payload of one `USE EMAIL` commitment.
3
- *
4
- * @private internal USE EMAIL type
5
- */
6
- export type ParsedUseEmailCommitmentContent = {
7
- senderEmail: string | null;
8
- senderEmailRaw: string | null;
9
- instructions: string;
10
- };
11
- /**
12
- * Parses `USE EMAIL` commitment content into optional sender email + additional instructions.
13
- *
14
- * Examples:
15
- * - `agent@example.com`
16
- * - `agent@example.com Keep emails concise`
17
- * - `Keep emails concise`
18
- *
19
- * @private internal utility of USE EMAIL commitment
20
- */
21
- export declare function parseUseEmailCommitmentContent(content: string): ParsedUseEmailCommitmentContent;
@@ -1,11 +0,0 @@
1
- import type { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
2
- /**
3
- * Resolves the server-side implementation of the send_email tool for Node.js environments.
4
- *
5
- * This uses a lazy require so the core package can still load even if the Agents Server
6
- * module is unavailable. When the server tool cannot be resolved, a fallback implementation
7
- * throws a helpful error message.
8
- *
9
- * @private internal utility for USE EMAIL commitment
10
- */
11
- export declare function resolveSendEmailToolForNode(): ToolFunction;
@@ -1,13 +0,0 @@
1
- /**
2
- * Client-side safe wrapper for sending emails.
3
- *
4
- * This function proxies requests to the Agents Server API endpoint for email queuing,
5
- * making it safe to use in browser environments.
6
- *
7
- * @param args Email payload forwarded to the server-side `send_email` tool
8
- * @param agentsServerUrl The base URL of the agents server (defaults to current origin)
9
- * @returns Result string from the server-side send_email tool
10
- *
11
- * @private internal utility for USE EMAIL commitment
12
- */
13
- export declare function sendEmailViaBrowser(args: Record<string, unknown>, agentsServerUrl?: string): Promise<string>;
@@ -1,46 +0,0 @@
1
- import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
2
- import type { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
3
- import type { string_javascript_name } from '../../types/string_person_fullname';
4
- import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
5
- /**
6
- * USE SEARCH ENGINE commitment definition
7
- *
8
- * The `USE SEARCH ENGINE` commitment indicates that the agent should utilize a search engine tool
9
- * to access and retrieve up-to-date information from the internet when necessary.
10
- *
11
- * The content following `USE SEARCH ENGINE` is an arbitrary text that the agent should know (e.g. search scope or instructions).
12
- *
13
- * Example usage in agent source:
14
- *
15
- * ```book
16
- * USE SEARCH ENGINE
17
- * USE SEARCH ENGINE Hledej informace o Přemyslovcích
18
- * ```
19
- *
20
- * @private [🪔] Maybe export the commitments through some package
21
- */
22
- export declare class UseSearchEngineCommitmentDefinition extends BaseCommitmentDefinition<'USE SEARCH ENGINE'> {
23
- constructor();
24
- get requiresContent(): boolean;
25
- /**
26
- * Short one-line description of USE SEARCH ENGINE.
27
- */
28
- get description(): string;
29
- /**
30
- * Icon for this commitment.
31
- */
32
- get icon(): string;
33
- /**
34
- * Markdown documentation for USE SEARCH ENGINE commitment.
35
- */
36
- get documentation(): string;
37
- applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
38
- /**
39
- * Gets human-readable titles for tool functions provided by this commitment.
40
- */
41
- getToolTitles(): Record<string_javascript_name, string>;
42
- /**
43
- * Gets the `web_search` tool function implementation.
44
- */
45
- getToolFunctions(): Record<string_javascript_name, ToolFunction>;
46
- }
@@ -1,38 +0,0 @@
1
- import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
2
- import type { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
3
- import type { string_javascript_name } from '../../types/string_person_fullname';
4
- import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
5
- /**
6
- * USE SPAWN commitment definition.
7
- *
8
- * The `USE SPAWN` commitment enables creating new persistent child agents through one tool call.
9
- *
10
- * @private [🪔] Maybe export the commitments through some package
11
- */
12
- export declare class UseSpawnCommitmentDefinition extends BaseCommitmentDefinition<'USE SPAWN'> {
13
- constructor();
14
- get requiresContent(): boolean;
15
- /**
16
- * Short one-line description of USE SPAWN.
17
- */
18
- get description(): string;
19
- /**
20
- * Icon for this commitment.
21
- */
22
- get icon(): string;
23
- /**
24
- * Markdown documentation for USE SPAWN commitment.
25
- */
26
- get documentation(): string;
27
- applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
28
- /**
29
- * Gets human-readable titles for tool functions provided by this commitment.
30
- */
31
- getToolTitles(): Record<string_javascript_name, string>;
32
- /**
33
- * Gets browser-safe `spawn_agent` implementation.
34
- *
35
- * Node.js runtime overrides this through `getAllCommitmentsToolFunctionsForNode`.
36
- */
37
- getToolFunctions(): Record<string_javascript_name, ToolFunction>;
38
- }
@@ -1 +0,0 @@
1
- export {};
@@ -1,9 +0,0 @@
1
- import type { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
2
- /**
3
- * Resolves the server-side `spawn_agent` tool for Node.js runtimes.
4
- *
5
- * Uses lazy require so core package can load outside Agents Server.
6
- *
7
- * @private internal utility for USE SPAWN commitment
8
- */
9
- export declare function resolveSpawnAgentToolForNode(): ToolFunction;
@@ -1,12 +0,0 @@
1
- /**
2
- * Browser-safe wrapper for spawning one persisted Agents Server agent.
3
- *
4
- * This function proxies requests to the Agents Server `/api/spawn-agent` endpoint.
5
- *
6
- * @param args Tool payload forwarded to server-side `spawn_agent` tool.
7
- * @param agentsServerUrl Optional explicit agents server base URL.
8
- * @returns JSON string with structured spawn result.
9
- *
10
- * @private internal utility for USE SPAWN commitment
11
- */
12
- export declare function spawnAgentViaBrowser(args: Record<string, unknown>, agentsServerUrl?: string): Promise<string>;
@@ -1,43 +0,0 @@
1
- import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
2
- import type { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
3
- import type { string_javascript_name } from '../../types/string_person_fullname';
4
- import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
5
- /**
6
- * USE TIME commitment definition
7
- *
8
- * The `USE TIME` commitment indicates that the agent should be able to determine the current date and time.
9
- *
10
- * Example usage in agent source:
11
- *
12
- * ```book
13
- * USE TIME
14
- * USE TIME Prefer the user's local timezone.
15
- * ```
16
- *
17
- * @private [🪔] Maybe export the commitments through some package
18
- */
19
- export declare class UseTimeCommitmentDefinition extends BaseCommitmentDefinition<'USE TIME'> {
20
- constructor();
21
- get requiresContent(): boolean;
22
- /**
23
- * Short one-line description of USE TIME.
24
- */
25
- get description(): string;
26
- /**
27
- * Icon for this commitment.
28
- */
29
- get icon(): string;
30
- /**
31
- * Markdown documentation for USE TIME commitment.
32
- */
33
- get documentation(): string;
34
- applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
35
- /**
36
- * Gets human-readable titles for tool functions provided by this commitment.
37
- */
38
- getToolTitles(): Record<string_javascript_name, string>;
39
- /**
40
- * Gets the `get_current_time` tool function implementation.
41
- */
42
- getToolFunctions(): Record<string_javascript_name, ToolFunction>;
43
- }
@@ -1 +0,0 @@
1
- export {};
@@ -1,11 +0,0 @@
1
- /**
2
- * Tool names provided by the `USE TIMEOUT` commitment.
3
- *
4
- * @private internal USE TIMEOUT constant
5
- */
6
- export declare const TimeoutToolNames: {
7
- readonly set: string;
8
- readonly cancel: string;
9
- readonly list: string;
10
- readonly update: string;
11
- };
@@ -1,212 +0,0 @@
1
- import type { TODO_any } from '../../utils/organization/TODO_any';
2
- /**
3
- * Tool arguments for scheduling one timeout.
4
- *
5
- * @private type of UseTimeoutCommitmentDefinition
6
- */
7
- export type SetTimeoutToolArgs = {
8
- milliseconds?: number;
9
- message?: string;
10
- [key: string]: TODO_any;
11
- };
12
- /**
13
- * Tool arguments for cancelling one timeout.
14
- *
15
- * @private type of UseTimeoutCommitmentDefinition
16
- */
17
- export type CancelTimeoutToolArgs = {
18
- timeoutId?: string;
19
- allActive?: boolean;
20
- [key: string]: TODO_any;
21
- };
22
- /**
23
- * Tool arguments for updating one timeout or pausing/resuming all active queued timeouts.
24
- *
25
- * @private type of UseTimeoutCommitmentDefinition
26
- */
27
- export type UpdateTimeoutToolArgs = {
28
- timeoutId?: string;
29
- allActive?: boolean;
30
- dueAt?: string;
31
- extendByMs?: number;
32
- recurrenceIntervalMs?: number | null;
33
- message?: string | null;
34
- parameters?: Record<string, unknown>;
35
- paused?: boolean;
36
- [key: string]: TODO_any;
37
- };
38
- /**
39
- * Tool arguments for listing scoped timeouts.
40
- *
41
- * @private type of UseTimeoutCommitmentDefinition
42
- */
43
- export type ListTimeoutsToolArgs = {
44
- includeFinished?: boolean;
45
- limit?: number;
46
- [key: string]: TODO_any;
47
- };
48
- /**
49
- * Runtime context available to `USE TIMEOUT` tools.
50
- *
51
- * @private type of UseTimeoutCommitmentDefinition
52
- */
53
- export type TimeoutToolRuntimeContext = {
54
- readonly enabled: boolean;
55
- readonly chatId?: string;
56
- readonly userId?: number;
57
- readonly agentId?: string;
58
- readonly agentName?: string;
59
- readonly promptParameters: Record<string, string>;
60
- };
61
- /**
62
- * Lifecycle status exposed by `list_timeouts`.
63
- *
64
- * @private type of UseTimeoutCommitmentDefinition
65
- */
66
- export type TimeoutToolListItemStatus = 'QUEUED' | 'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELLED';
67
- /**
68
- * One timeout row exposed by `list_timeouts`.
69
- *
70
- * @private type of UseTimeoutCommitmentDefinition
71
- */
72
- export type TimeoutToolListItem = {
73
- timeoutId: string;
74
- chatId: string;
75
- status: TimeoutToolListItemStatus;
76
- dueAt: string;
77
- paused: boolean;
78
- message?: string | null;
79
- recurrenceIntervalMs?: number | null;
80
- };
81
- /**
82
- * Result payload returned by `set_timeout`.
83
- *
84
- * @private type of UseTimeoutCommitmentDefinition
85
- */
86
- export type SetTimeoutToolResult = {
87
- action: 'set';
88
- status: 'set' | 'disabled' | 'error';
89
- timeoutId?: string;
90
- dueAt?: string;
91
- message?: string;
92
- };
93
- /**
94
- * Result payload returned by `cancel_timeout`.
95
- *
96
- * @private type of UseTimeoutCommitmentDefinition
97
- */
98
- export type CancelTimeoutToolResult = {
99
- action: 'cancel';
100
- status: 'cancelled' | 'cancelled_all' | 'not_found' | 'disabled' | 'error';
101
- timeoutId?: string;
102
- dueAt?: string;
103
- cancelledCount?: number;
104
- cancelledTimeoutIds?: Array<string>;
105
- hasMore?: boolean;
106
- message?: string;
107
- };
108
- /**
109
- * Result payload returned by `update_timeout`.
110
- *
111
- * @private type of UseTimeoutCommitmentDefinition
112
- */
113
- export type UpdateTimeoutToolResult = {
114
- action: 'update';
115
- status: 'updated' | 'updated_all' | 'not_found' | 'conflict' | 'disabled' | 'error';
116
- timeoutId?: string;
117
- dueAt?: string;
118
- paused?: boolean;
119
- recurrenceIntervalMs?: number | null;
120
- updatedCount?: number;
121
- matchedCount?: number;
122
- updatedTimeoutIds?: Array<string>;
123
- hasMore?: boolean;
124
- message?: string;
125
- };
126
- /**
127
- * Result payload returned by `list_timeouts`.
128
- *
129
- * @private type of UseTimeoutCommitmentDefinition
130
- */
131
- export type ListTimeoutsToolResult = {
132
- action: 'list';
133
- status: 'listed' | 'disabled' | 'error';
134
- items?: Array<TimeoutToolListItem>;
135
- total?: number;
136
- message?: string;
137
- };
138
- /**
139
- * Union of all `USE TIMEOUT` tool actions.
140
- *
141
- * @private type of UseTimeoutCommitmentDefinition
142
- */
143
- export type TimeoutToolAction = SetTimeoutToolResult['action'] | CancelTimeoutToolResult['action'] | ListTimeoutsToolResult['action'] | UpdateTimeoutToolResult['action'];
144
- /**
145
- * Union of all `USE TIMEOUT` tool results.
146
- *
147
- * @private type of UseTimeoutCommitmentDefinition
148
- */
149
- export type TimeoutToolResult = SetTimeoutToolResult | CancelTimeoutToolResult | ListTimeoutsToolResult | UpdateTimeoutToolResult;
150
- /**
151
- * Runtime adapter used by `USE TIMEOUT` tools.
152
- *
153
- * @private type of UseTimeoutCommitmentDefinition
154
- */
155
- export type TimeoutToolRuntimeAdapter = {
156
- scheduleTimeout(args: {
157
- milliseconds: number;
158
- message?: string;
159
- }, runtimeContext: TimeoutToolRuntimeContext): Promise<{
160
- timeoutId: string;
161
- dueAt: string;
162
- }>;
163
- cancelTimeout(args: {
164
- timeoutId: string;
165
- } | {
166
- allActive: true;
167
- }, runtimeContext: TimeoutToolRuntimeContext): Promise<{
168
- status: 'cancelled' | 'cancelled_all' | 'not_found';
169
- timeoutId?: string;
170
- dueAt?: string;
171
- cancelledCount?: number;
172
- cancelledTimeoutIds?: Array<string>;
173
- hasMore?: boolean;
174
- }>;
175
- listTimeouts(args: {
176
- includeFinished: boolean;
177
- limit: number;
178
- }, runtimeContext: TimeoutToolRuntimeContext): Promise<{
179
- items: Array<TimeoutToolListItem>;
180
- total: number;
181
- }>;
182
- updateTimeout(args: {
183
- timeoutId: string;
184
- patch: {
185
- dueAt?: string;
186
- extendByMs?: number;
187
- recurrenceIntervalMs?: number | null;
188
- message?: string | null;
189
- parameters?: Record<string, unknown>;
190
- paused?: boolean;
191
- };
192
- } | {
193
- allActive: true;
194
- paused: boolean;
195
- }, runtimeContext: TimeoutToolRuntimeContext): Promise<{
196
- status: 'updated';
197
- timeout: TimeoutToolListItem;
198
- } | {
199
- status: 'not_found';
200
- timeoutId: string;
201
- } | {
202
- status: 'conflict';
203
- timeoutId: string;
204
- reason: 'finished' | 'running';
205
- } | {
206
- status: 'updated_all';
207
- updatedCount: number;
208
- matchedCount: number;
209
- updatedTimeoutIds: Array<string>;
210
- hasMore?: boolean;
211
- }>;
212
- };
@@ -1,38 +0,0 @@
1
- import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
2
- import type { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
3
- import type { string_javascript_name } from '../../types/string_person_fullname';
4
- import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
5
- export { setTimeoutToolRuntimeAdapter } from './setTimeoutToolRuntimeAdapter';
6
- export type { CancelTimeoutToolResult, ListTimeoutsToolResult, SetTimeoutToolResult, TimeoutToolListItem, TimeoutToolRuntimeAdapter, TimeoutToolRuntimeContext, UpdateTimeoutToolResult, } from './TimeoutToolRuntimeAdapter';
7
- /**
8
- * `USE TIMEOUT` commitment definition.
9
- *
10
- * The `USE TIMEOUT` commitment enables timeout wake-ups and scoped timeout management.
11
- *
12
- * @private [🪔] Maybe export the commitments through some package
13
- */
14
- export declare class UseTimeoutCommitmentDefinition extends BaseCommitmentDefinition<'USE TIMEOUT'> {
15
- constructor();
16
- get requiresContent(): boolean;
17
- /**
18
- * Short one-line description of `USE TIMEOUT`.
19
- */
20
- get description(): string;
21
- /**
22
- * Icon for this commitment.
23
- */
24
- get icon(): string;
25
- /**
26
- * Markdown documentation for `USE TIMEOUT`.
27
- */
28
- get documentation(): string;
29
- applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
30
- /**
31
- * Gets human-readable titles for tool functions provided by this commitment.
32
- */
33
- getToolTitles(): Record<string_javascript_name, string>;
34
- /**
35
- * Gets `USE TIMEOUT` tool function implementations.
36
- */
37
- getToolFunctions(): Record<string_javascript_name, ToolFunction>;
38
- }
@@ -1 +0,0 @@
1
- export {};
@@ -1,6 +0,0 @@
1
- /**
2
- * Creates system-message instructions for `USE TIMEOUT`.
3
- *
4
- * @private internal utility of USE TIMEOUT
5
- */
6
- export declare function createTimeoutSystemMessage(extraInstructions: string): string;
@@ -1,8 +0,0 @@
1
- import type { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
2
- import type { string_javascript_name } from '../../types/string_person_fullname';
3
- /**
4
- * Gets `USE TIMEOUT` tool function implementations.
5
- *
6
- * @private internal utility of USE TIMEOUT
7
- */
8
- export declare function createTimeoutToolFunctions(): Record<string_javascript_name, ToolFunction>;
@@ -1,7 +0,0 @@
1
- import type { LlmToolDefinition } from '../../types/LlmToolDefinition';
2
- /**
3
- * Adds `USE TIMEOUT` tool definitions while preserving already registered tools.
4
- *
5
- * @private internal utility of USE TIMEOUT
6
- */
7
- export declare function createTimeoutTools(existingTools?: ReadonlyArray<LlmToolDefinition>): Array<LlmToolDefinition>;
@@ -1,17 +0,0 @@
1
- import type { TimeoutToolAction, TimeoutToolResult, TimeoutToolRuntimeAdapter, TimeoutToolRuntimeContext } from './TimeoutToolRuntimeAdapter';
2
- /**
3
- * Return type of timeout adapter resolution helper.
4
- *
5
- * @private type of UseTimeoutCommitmentDefinition
6
- */
7
- type TimeoutToolRuntimeAdapterResolution = {
8
- adapter: TimeoutToolRuntimeAdapter | null;
9
- disabledResult: TimeoutToolResult | null;
10
- };
11
- /**
12
- * Resolves the runtime adapter for timeout tools or returns disabled payload when unavailable.
13
- *
14
- * @private internal utility of USE TIMEOUT
15
- */
16
- export declare function getTimeoutToolRuntimeAdapterOrDisabledResult(action: TimeoutToolAction, runtimeContext: TimeoutToolRuntimeContext): TimeoutToolRuntimeAdapterResolution;
17
- export {};
@@ -1,78 +0,0 @@
1
- import type { CancelTimeoutToolArgs, ListTimeoutsToolArgs, SetTimeoutToolArgs, UpdateTimeoutToolArgs } from './TimeoutToolRuntimeAdapter';
2
- /**
3
- * Parsed arguments for `set_timeout`.
4
- *
5
- * @private type of UseTimeoutCommitmentDefinition
6
- */
7
- type ParsedSetTimeoutToolArgs = {
8
- milliseconds: number;
9
- message?: string;
10
- };
11
- /**
12
- * Parsed arguments for `cancel_timeout`.
13
- *
14
- * @private type of UseTimeoutCommitmentDefinition
15
- */
16
- type ParsedCancelTimeoutToolArgs = {
17
- timeoutId: string;
18
- } | {
19
- allActive: true;
20
- };
21
- /**
22
- * Parsed arguments for `list_timeouts`.
23
- *
24
- * @private type of UseTimeoutCommitmentDefinition
25
- */
26
- type ParsedListTimeoutsToolArgs = {
27
- includeFinished: boolean;
28
- limit: number;
29
- };
30
- /**
31
- * Parsed patch payload for `update_timeout` single-timeout updates.
32
- *
33
- * @private type of UseTimeoutCommitmentDefinition
34
- */
35
- type ParsedUpdateTimeoutToolPatch = {
36
- dueAt?: string;
37
- extendByMs?: number;
38
- recurrenceIntervalMs?: number | null;
39
- message?: string | null;
40
- parameters?: Record<string, unknown>;
41
- paused?: boolean;
42
- };
43
- /**
44
- * Parsed arguments for `update_timeout`.
45
- *
46
- * @private type of UseTimeoutCommitmentDefinition
47
- */
48
- type ParsedUpdateTimeoutToolArgs = {
49
- timeoutId: string;
50
- patch: ParsedUpdateTimeoutToolPatch;
51
- } | {
52
- allActive: true;
53
- paused: boolean;
54
- };
55
- /**
56
- * Parses and validates `USE TIMEOUT` tool arguments.
57
- *
58
- * @private internal utility of USE TIMEOUT
59
- */
60
- export declare const parseTimeoutToolArgs: {
61
- /**
62
- * Parses `set_timeout` input.
63
- */
64
- set(args: SetTimeoutToolArgs): ParsedSetTimeoutToolArgs;
65
- /**
66
- * Parses `cancel_timeout` input.
67
- */
68
- cancel(args: CancelTimeoutToolArgs): ParsedCancelTimeoutToolArgs;
69
- /**
70
- * Parses `list_timeouts` input.
71
- */
72
- list(args: ListTimeoutsToolArgs): ParsedListTimeoutsToolArgs;
73
- /**
74
- * Parses `update_timeout` input.
75
- */
76
- update(args: UpdateTimeoutToolArgs): ParsedUpdateTimeoutToolArgs;
77
- };
78
- export {};
@@ -1,8 +0,0 @@
1
- import type { TODO_any } from '../../utils/organization/TODO_any';
2
- import type { TimeoutToolRuntimeContext } from './TimeoutToolRuntimeAdapter';
3
- /**
4
- * Resolves timeout runtime context from hidden tool arguments.
5
- *
6
- * @private internal utility of USE TIMEOUT
7
- */
8
- export declare function resolveTimeoutRuntimeContext(args: Record<string, TODO_any>): TimeoutToolRuntimeContext;
@@ -1,13 +0,0 @@
1
- import type { TimeoutToolRuntimeAdapter } from './TimeoutToolRuntimeAdapter';
2
- /**
3
- * Sets runtime adapter used by `USE TIMEOUT` tools.
4
- *
5
- * @private internal utility of USE TIMEOUT
6
- */
7
- export declare function setTimeoutToolRuntimeAdapter(adapter: TimeoutToolRuntimeAdapter | null): void;
8
- /**
9
- * Gets runtime adapter used by `USE TIMEOUT` tools.
10
- *
11
- * @private internal utility of USE TIMEOUT
12
- */
13
- export declare function getTimeoutToolRuntimeAdapter(): TimeoutToolRuntimeAdapter | null;