@promptbook/openai 0.114.0-3 → 0.114.0-4

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 (150) hide show
  1. package/README.md +1 -9
  2. package/esm/index.es.js +3 -3
  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/commitments/{COMPONENT/COMPONENT.d.ts → META_FULLNAME/META_FULLNAME.d.ts} +8 -5
  7. package/esm/src/commitments/META_ID/META_ID.d.ts +32 -0
  8. package/esm/src/commitments/index.d.ts +4 -12
  9. package/esm/src/llm-providers/agent/Agent.d.ts +1 -1
  10. package/esm/src/llm-providers/openai/OpenAiAgentKitExecutionToolsToolBuilder.d.ts +1 -1
  11. package/esm/src/{commitments/USE_BROWSER → scrapers/_common/utils}/fetchUrlContent.d.ts +2 -3
  12. package/esm/src/version.d.ts +1 -1
  13. package/package.json +2 -2
  14. package/umd/index.umd.js +3 -3
  15. package/umd/src/book-2.0/agent-source/AgentBasicInformation.d.ts +3 -3
  16. package/umd/src/cli/cli-commands/coder/boilerplateCount.d.ts +52 -0
  17. package/umd/src/cli/cli-commands/coder/generate-boilerplates.d.ts +3 -2
  18. package/umd/src/commitments/{COMPONENT/COMPONENT.d.ts → META_FULLNAME/META_FULLNAME.d.ts} +8 -5
  19. package/umd/src/commitments/META_ID/META_ID.d.ts +32 -0
  20. package/umd/src/commitments/index.d.ts +4 -12
  21. package/umd/src/llm-providers/agent/Agent.d.ts +1 -1
  22. package/umd/src/llm-providers/openai/OpenAiAgentKitExecutionToolsToolBuilder.d.ts +1 -1
  23. package/umd/src/{commitments/USE_BROWSER → scrapers/_common/utils}/fetchUrlContent.d.ts +2 -3
  24. package/umd/src/version.d.ts +1 -1
  25. package/esm/src/commitments/MEMORY/MEMORY.d.ts +0 -48
  26. package/esm/src/commitments/MEMORY/MemoryToolNames.d.ts +0 -11
  27. package/esm/src/commitments/MEMORY/MemoryToolRuntimeAdapter.d.ts +0 -149
  28. package/esm/src/commitments/MEMORY/createMemorySystemMessage.d.ts +0 -6
  29. package/esm/src/commitments/MEMORY/createMemoryToolFunctions.d.ts +0 -8
  30. package/esm/src/commitments/MEMORY/createMemoryTools.d.ts +0 -14
  31. package/esm/src/commitments/MEMORY/getMemoryCommitmentDocumentation.d.ts +0 -6
  32. package/esm/src/commitments/MEMORY/getMemoryToolRuntimeAdapterOrDisabledResult.d.ts +0 -17
  33. package/esm/src/commitments/MEMORY/getMemoryToolTitles.d.ts +0 -7
  34. package/esm/src/commitments/MEMORY/parseMemoryToolArgs.d.ts +0 -61
  35. package/esm/src/commitments/MEMORY/resolveMemoryRuntimeContext.d.ts +0 -8
  36. package/esm/src/commitments/MEMORY/setMemoryToolRuntimeAdapter.d.ts +0 -13
  37. package/esm/src/commitments/META/META.d.ts +0 -65
  38. package/esm/src/commitments/USE/aggregateUseCommitmentSystemMessages.d.ts +0 -32
  39. package/esm/src/commitments/USE_BROWSER/USE_BROWSER.d.ts +0 -58
  40. package/esm/src/commitments/USE_BROWSER/fetchUrlContentViaBrowser.d.ts +0 -13
  41. package/esm/src/commitments/USE_BROWSER/resolveRunBrowserToolForNode.d.ts +0 -10
  42. package/esm/src/commitments/USE_DEEPSEARCH/USE_DEEPSEARCH.d.ts +0 -47
  43. package/esm/src/commitments/USE_EMAIL/USE_EMAIL.d.ts +0 -38
  44. package/esm/src/commitments/USE_EMAIL/parseUseEmailCommitmentContent.d.ts +0 -21
  45. package/esm/src/commitments/USE_EMAIL/parseUseEmailCommitmentContent.test.d.ts +0 -1
  46. package/esm/src/commitments/USE_EMAIL/resolveSendEmailToolForNode.d.ts +0 -11
  47. package/esm/src/commitments/USE_EMAIL/sendEmailViaBrowser.d.ts +0 -13
  48. package/esm/src/commitments/USE_SEARCH_ENGINE/USE_SEARCH_ENGINE.d.ts +0 -46
  49. package/esm/src/commitments/USE_SEARCH_ENGINE/USE_SEARCH_ENGINE.test.d.ts +0 -1
  50. package/esm/src/commitments/USE_SPAWN/USE_SPAWN.d.ts +0 -38
  51. package/esm/src/commitments/USE_SPAWN/USE_SPAWN.test.d.ts +0 -1
  52. package/esm/src/commitments/USE_SPAWN/resolveSpawnAgentToolForNode.d.ts +0 -9
  53. package/esm/src/commitments/USE_SPAWN/spawnAgentViaBrowser.d.ts +0 -12
  54. package/esm/src/commitments/USE_TIME/USE_TIME.d.ts +0 -43
  55. package/esm/src/commitments/USE_TIME/USE_TIME.test.d.ts +0 -1
  56. package/esm/src/commitments/USE_TIMEOUT/TimeoutToolNames.d.ts +0 -11
  57. package/esm/src/commitments/USE_TIMEOUT/TimeoutToolRuntimeAdapter.d.ts +0 -212
  58. package/esm/src/commitments/USE_TIMEOUT/USE_TIMEOUT.d.ts +0 -38
  59. package/esm/src/commitments/USE_TIMEOUT/USE_TIMEOUT.test.d.ts +0 -1
  60. package/esm/src/commitments/USE_TIMEOUT/createTimeoutSystemMessage.d.ts +0 -6
  61. package/esm/src/commitments/USE_TIMEOUT/createTimeoutToolFunctions.d.ts +0 -8
  62. package/esm/src/commitments/USE_TIMEOUT/createTimeoutTools.d.ts +0 -7
  63. package/esm/src/commitments/USE_TIMEOUT/getTimeoutToolRuntimeAdapterOrDisabledResult.d.ts +0 -17
  64. package/esm/src/commitments/USE_TIMEOUT/parseTimeoutToolArgs.d.ts +0 -78
  65. package/esm/src/commitments/USE_TIMEOUT/resolveTimeoutRuntimeContext.d.ts +0 -8
  66. package/esm/src/commitments/USE_TIMEOUT/setTimeoutToolRuntimeAdapter.d.ts +0 -13
  67. package/esm/src/commitments/WALLET/WALLET.d.ts +0 -21
  68. package/esm/src/commitments/WALLET/WALLET.test.d.ts +0 -1
  69. package/esm/src/commitments/WALLET/WalletToolNames.d.ts +0 -12
  70. package/esm/src/commitments/WALLET/WalletToolRuntimeAdapter.d.ts +0 -163
  71. package/esm/src/commitments/WALLET/createWalletSystemMessage.d.ts +0 -6
  72. package/esm/src/commitments/WALLET/createWalletToolFunctions.d.ts +0 -8
  73. package/esm/src/commitments/WALLET/createWalletTools.d.ts +0 -7
  74. package/esm/src/commitments/WALLET/getWalletCommitmentDocumentation.d.ts +0 -6
  75. package/esm/src/commitments/WALLET/getWalletToolRuntimeAdapterOrDisabledResult.d.ts +0 -16
  76. package/esm/src/commitments/WALLET/getWalletToolTitles.d.ts +0 -7
  77. package/esm/src/commitments/WALLET/parseWalletToolArgs.d.ts +0 -51
  78. package/esm/src/commitments/WALLET/resolveWalletRuntimeContext.d.ts +0 -8
  79. package/esm/src/commitments/WALLET/setWalletToolRuntimeAdapter.d.ts +0 -13
  80. package/esm/src/commitments/_common/createSerpSearchToolFunction.d.ts +0 -12
  81. package/umd/src/book-2.0/agent-source/createAgentModelRequirements.useCommitmentAggregation.test.d.ts +0 -1
  82. package/umd/src/commitments/MEMORY/MEMORY.d.ts +0 -48
  83. package/umd/src/commitments/MEMORY/MEMORY.test.d.ts +0 -1
  84. package/umd/src/commitments/MEMORY/MemoryToolNames.d.ts +0 -11
  85. package/umd/src/commitments/MEMORY/MemoryToolRuntimeAdapter.d.ts +0 -149
  86. package/umd/src/commitments/MEMORY/createMemorySystemMessage.d.ts +0 -6
  87. package/umd/src/commitments/MEMORY/createMemoryToolFunctions.d.ts +0 -8
  88. package/umd/src/commitments/MEMORY/createMemoryTools.d.ts +0 -14
  89. package/umd/src/commitments/MEMORY/getMemoryCommitmentDocumentation.d.ts +0 -6
  90. package/umd/src/commitments/MEMORY/getMemoryToolRuntimeAdapterOrDisabledResult.d.ts +0 -17
  91. package/umd/src/commitments/MEMORY/getMemoryToolTitles.d.ts +0 -7
  92. package/umd/src/commitments/MEMORY/parseMemoryToolArgs.d.ts +0 -61
  93. package/umd/src/commitments/MEMORY/resolveMemoryRuntimeContext.d.ts +0 -8
  94. package/umd/src/commitments/MEMORY/setMemoryToolRuntimeAdapter.d.ts +0 -13
  95. package/umd/src/commitments/META/META.d.ts +0 -65
  96. package/umd/src/commitments/USE/aggregateUseCommitmentSystemMessages.d.ts +0 -32
  97. package/umd/src/commitments/USE_BROWSER/USE_BROWSER.d.ts +0 -58
  98. package/umd/src/commitments/USE_BROWSER/USE_BROWSER.test.d.ts +0 -1
  99. package/umd/src/commitments/USE_BROWSER/fetchUrlContentViaBrowser.d.ts +0 -13
  100. package/umd/src/commitments/USE_BROWSER/resolveRunBrowserToolForNode.d.ts +0 -10
  101. package/umd/src/commitments/USE_BROWSER/resolveRunBrowserToolForNode.test.d.ts +0 -1
  102. package/umd/src/commitments/USE_DEEPSEARCH/USE_DEEPSEARCH.d.ts +0 -47
  103. package/umd/src/commitments/USE_DEEPSEARCH/USE_DEEPSEARCH.test.d.ts +0 -1
  104. package/umd/src/commitments/USE_EMAIL/USE_EMAIL.d.ts +0 -38
  105. package/umd/src/commitments/USE_EMAIL/USE_EMAIL.test.d.ts +0 -1
  106. package/umd/src/commitments/USE_EMAIL/parseUseEmailCommitmentContent.d.ts +0 -21
  107. package/umd/src/commitments/USE_EMAIL/parseUseEmailCommitmentContent.test.d.ts +0 -1
  108. package/umd/src/commitments/USE_EMAIL/resolveSendEmailToolForNode.d.ts +0 -11
  109. package/umd/src/commitments/USE_EMAIL/sendEmailViaBrowser.d.ts +0 -13
  110. package/umd/src/commitments/USE_SEARCH_ENGINE/USE_SEARCH_ENGINE.d.ts +0 -46
  111. package/umd/src/commitments/USE_SEARCH_ENGINE/USE_SEARCH_ENGINE.test.d.ts +0 -1
  112. package/umd/src/commitments/USE_SPAWN/USE_SPAWN.d.ts +0 -38
  113. package/umd/src/commitments/USE_SPAWN/USE_SPAWN.test.d.ts +0 -1
  114. package/umd/src/commitments/USE_SPAWN/resolveSpawnAgentToolForNode.d.ts +0 -9
  115. package/umd/src/commitments/USE_SPAWN/spawnAgentViaBrowser.d.ts +0 -12
  116. package/umd/src/commitments/USE_TIME/USE_TIME.d.ts +0 -43
  117. package/umd/src/commitments/USE_TIME/USE_TIME.test.d.ts +0 -1
  118. package/umd/src/commitments/USE_TIMEOUT/TimeoutToolNames.d.ts +0 -11
  119. package/umd/src/commitments/USE_TIMEOUT/TimeoutToolRuntimeAdapter.d.ts +0 -212
  120. package/umd/src/commitments/USE_TIMEOUT/USE_TIMEOUT.d.ts +0 -38
  121. package/umd/src/commitments/USE_TIMEOUT/USE_TIMEOUT.test.d.ts +0 -1
  122. package/umd/src/commitments/USE_TIMEOUT/createTimeoutSystemMessage.d.ts +0 -6
  123. package/umd/src/commitments/USE_TIMEOUT/createTimeoutToolFunctions.d.ts +0 -8
  124. package/umd/src/commitments/USE_TIMEOUT/createTimeoutTools.d.ts +0 -7
  125. package/umd/src/commitments/USE_TIMEOUT/getTimeoutToolRuntimeAdapterOrDisabledResult.d.ts +0 -17
  126. package/umd/src/commitments/USE_TIMEOUT/parseTimeoutToolArgs.d.ts +0 -78
  127. package/umd/src/commitments/USE_TIMEOUT/resolveTimeoutRuntimeContext.d.ts +0 -8
  128. package/umd/src/commitments/USE_TIMEOUT/setTimeoutToolRuntimeAdapter.d.ts +0 -13
  129. package/umd/src/commitments/WALLET/WALLET.d.ts +0 -21
  130. package/umd/src/commitments/WALLET/WALLET.test.d.ts +0 -1
  131. package/umd/src/commitments/WALLET/WalletToolNames.d.ts +0 -12
  132. package/umd/src/commitments/WALLET/WalletToolRuntimeAdapter.d.ts +0 -163
  133. package/umd/src/commitments/WALLET/createWalletSystemMessage.d.ts +0 -6
  134. package/umd/src/commitments/WALLET/createWalletToolFunctions.d.ts +0 -8
  135. package/umd/src/commitments/WALLET/createWalletTools.d.ts +0 -7
  136. package/umd/src/commitments/WALLET/getWalletCommitmentDocumentation.d.ts +0 -6
  137. package/umd/src/commitments/WALLET/getWalletToolRuntimeAdapterOrDisabledResult.d.ts +0 -16
  138. package/umd/src/commitments/WALLET/getWalletToolTitles.d.ts +0 -7
  139. package/umd/src/commitments/WALLET/parseWalletToolArgs.d.ts +0 -51
  140. package/umd/src/commitments/WALLET/resolveWalletRuntimeContext.d.ts +0 -8
  141. package/umd/src/commitments/WALLET/setWalletToolRuntimeAdapter.d.ts +0 -13
  142. package/umd/src/commitments/_common/createSerpSearchToolFunction.d.ts +0 -12
  143. /package/esm/src/book-2.0/agent-source/{createAgentModelRequirements.useCommitmentAggregation.test.d.ts → createAgentModelRequirements.commitmentAggregation.test.d.ts} +0 -0
  144. /package/esm/src/{commitments/MEMORY/MEMORY.test.d.ts → cli/cli-commands/coder/boilerplateCount.test.d.ts} +0 -0
  145. /package/esm/src/{commitments/USE_BROWSER/USE_BROWSER.test.d.ts → cli/cli-commands/coder/generate-boilerplates.test.d.ts} +0 -0
  146. /package/esm/src/commitments/{META → META_DESCRIPTION}/META_DESCRIPTION.d.ts +0 -0
  147. /package/{esm/src/commitments/USE_BROWSER/resolveRunBrowserToolForNode.test.d.ts → umd/src/book-2.0/agent-source/createAgentModelRequirements.commitmentAggregation.test.d.ts} +0 -0
  148. /package/{esm/src/commitments/USE_DEEPSEARCH/USE_DEEPSEARCH.test.d.ts → umd/src/cli/cli-commands/coder/boilerplateCount.test.d.ts} +0 -0
  149. /package/{esm/src/commitments/USE_EMAIL/USE_EMAIL.test.d.ts → umd/src/cli/cli-commands/coder/generate-boilerplates.test.d.ts} +0 -0
  150. /package/umd/src/commitments/{META → META_DESCRIPTION}/META_DESCRIPTION.d.ts +0 -0
package/README.md CHANGED
@@ -410,8 +410,6 @@ Respond to incoming legal inquiries via email and keep the company website updat
410
410
  **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
411
411
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
412
412
  <br/>
413
- USE EMAIL<br/>
414
- USE BROWSER<br/>
415
413
  <br/>
416
414
  TEAM You are part of the legal team of Paul Smith & Associés, you discuss with {Emily White}, the head of the compliance department. {George Brown} is expert in corporate law and {Sophia Black} is expert in labor law.<br/>
417
415
 
@@ -500,7 +498,7 @@ GOAL Keep the company website updated with the latest legal policies and complia
500
498
 
501
499
  #### `Use` commitments
502
500
 
503
- Use commitments grant the agent real capabilities - tools it can use to interact with the outside world. `USE EMAIL` lets the agent send emails, `USE BROWSER` lets it access and read web content, `USE SEARCH ENGINE` lets it search the web, and many more.
501
+ Use commitments grant the agent real capabilities - tools it can use to interact with the outside world. `USE CALENDAR` lets the agent work with a calendar, `USE PROJECT` gives it access to a code repository, `USE MCP` connects any external Model Context Protocol server, and many more.
504
502
 
505
503
  These are what turn a chatbot into a persistent agent that actually does work.
506
504
 
@@ -517,9 +515,6 @@ GOAL Keep the company website updated with the latest legal policies and complia
517
515
  **RULE** Never provide legal advice about criminal law.<br/>
518
516
  **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
519
517
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
520
- USE EMAIL<br/>
521
- USE BROWSER<br/>
522
- USE SEARCH ENGINE<br/>
523
518
 
524
519
  </td></tr></table>
525
520
 
@@ -540,9 +535,6 @@ GOAL Keep the company website updated with the latest legal policies and complia
540
535
  **RULE** Never provide legal advice about criminal law.<br/>
541
536
  **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
542
537
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
543
- USE EMAIL<br/>
544
- USE BROWSER<br/>
545
- USE SEARCH ENGINE<br/>
546
538
  TEAM You are part of the legal team of Paul Smith & Associés, you discuss with {Emily White}, the head of the compliance department. {George Brown} is expert in corporate law and {Sophia Black} is expert in labor law.<br/>
547
539
 
548
540
  </td></tr></table>
package/esm/index.es.js CHANGED
@@ -17,7 +17,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
17
17
  * @generated
18
18
  * @see https://github.com/webgptorg/promptbook
19
19
  */
20
- const PROMPTBOOK_ENGINE_VERSION = '0.114.0-3';
20
+ const PROMPTBOOK_ENGINE_VERSION = '0.114.0-4';
21
21
  /**
22
22
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
23
23
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -8181,7 +8181,7 @@ const loadOpenAiAgentsModule = createLazyModuleLoader(() => import('@openai/agen
8181
8181
  */
8182
8182
  const DEFAULT_DEEP_SEARCH_MODEL_NAME = 'o4-mini-deep-research';
8183
8183
  /**
8184
- * Tool name used by the Book commitment-backed DeepSearch capability.
8184
+ * Tool name used by the DeepSearch capability.
8185
8185
  */
8186
8186
  const DEEP_SEARCH_TOOL_NAME = 'deep_search';
8187
8187
  /**
@@ -8451,7 +8451,7 @@ class OpenAiAgentKitExecutionToolsToolBuilder {
8451
8451
  };
8452
8452
  }
8453
8453
  /**
8454
- * Creates the native Agent SDK tool used for `USE DEEPSEARCH`.
8454
+ * Creates the native Agent SDK tool used for the DeepSearch capability.
8455
8455
  */
8456
8456
  async createDeepSearchAgentKitTool(toolDefinition) {
8457
8457
  const { Agent: AgentFromKit, webSearchTool } = await loadOpenAiAgentsModule();
@@ -31,13 +31,13 @@ export type BookParameter = {
31
31
  };
32
32
  /**
33
33
  * Capability of the agent
34
- * This is parsed from commitments like USE BROWSER, USE SEARCH ENGINE, KNOWLEDGE, etc.
34
+ * This is parsed from commitments like USE CALENDAR, USE PROJECT, KNOWLEDGE, etc.
35
35
  */
36
36
  export type AgentCapability = {
37
37
  /**
38
38
  * The type of the capability
39
39
  */
40
- type: 'browser' | 'search-engine' | 'knowledge' | 'timeout' | 'time' | 'user-location' | 'inheritance' | 'import' | 'image-generator' | 'team' | 'email' | 'popup' | 'privacy' | 'project' | 'calendar' | 'wallet';
40
+ type: 'knowledge' | 'user-location' | 'inheritance' | 'import' | 'image-generator' | 'team' | 'popup' | 'privacy' | 'project' | 'calendar';
41
41
  /**
42
42
  * The label to display for this capability
43
43
  */
@@ -122,7 +122,7 @@ export type AgentBasicInformation = {
122
122
  parameters: Array<BookParameter>;
123
123
  /**
124
124
  * Capabilities of the agent
125
- * This is parsed from commitments like USE BROWSER, USE SEARCH ENGINE, KNOWLEDGE, etc.
125
+ * This is parsed from commitments like USE CALENDAR, USE PROJECT, KNOWLEDGE, etc.
126
126
  */
127
127
  capabilities: Array<AgentCapability>;
128
128
  /**
@@ -0,0 +1,52 @@
1
+ /**
2
+ * How many prompt boilerplate files are generated and how many prompts each of them contains.
3
+ *
4
+ * @private internal utility of `ptbk coder`
5
+ */
6
+ export type BoilerplateCount = {
7
+ /**
8
+ * Number of generated prompt boilerplate files.
9
+ */
10
+ readonly filesCount: number;
11
+ /**
12
+ * Number of prompts written into each generated file.
13
+ *
14
+ * Note: More than one prompt per file is an advanced option - each prompt is one separate
15
+ * coding task separated by `---` and tagged with its own fresh emoji tag.
16
+ */
17
+ readonly promptsPerFileCount: number;
18
+ };
19
+ /**
20
+ * Number of prompt boilerplate files and prompts per file used when `--count` is not provided.
21
+ *
22
+ * @private internal utility of `ptbk coder`
23
+ */
24
+ export declare const DEFAULT_BOILERPLATE_COUNT: BoilerplateCount;
25
+ /**
26
+ * Formats one boilerplate count back into the `N*M` notation of the `--count` option.
27
+ *
28
+ * @private internal utility of `ptbk coder`
29
+ */
30
+ export declare function formatBoilerplateCount({ filesCount, promptsPerFileCount }: BoilerplateCount): string;
31
+ /**
32
+ * Default value of the `--count` option rendered in the `N*M` notation, for example `5*1`.
33
+ *
34
+ * @private internal utility of `ptbk coder`
35
+ */
36
+ export declare const DEFAULT_BOILERPLATE_COUNT_OPTION_VALUE: string;
37
+ /**
38
+ * Description of the `--count` option shared by all commands which generate prompt boilerplates.
39
+ *
40
+ * @private internal utility of `ptbk coder`
41
+ */
42
+ export declare const BOILERPLATE_COUNT_OPTION_DESCRIPTION: string;
43
+ /**
44
+ * Parses the `--count` option value into the number of files and the number of prompts in each of them.
45
+ *
46
+ * Both notations are supported:
47
+ * - `N` and `N*1` => N files with one prompt each
48
+ * - `N*M` => N files with M prompts each
49
+ *
50
+ * @private internal utility of `ptbk coder`
51
+ */
52
+ export declare function parseBoilerplateCount(countOption: string): BoilerplateCount;
@@ -1,5 +1,6 @@
1
1
  import type { Command as Program } from 'commander';
2
2
  import type { $side_effect } from '../../../utils/organization/$side_effect';
3
+ import type { BoilerplateCount } from './boilerplateCount';
3
4
  /**
4
5
  * Initializes `coder generate-boilerplates` command for Promptbook CLI utilities
5
6
  *
@@ -13,8 +14,8 @@ export declare function $initializeCoderGenerateBoilerplatesCommand(program: Pro
13
14
  *
14
15
  * @private internal function of `generatePromptBoilerplate` command
15
16
  */
16
- export declare function generatePromptBoilerplate({ projectPath, filesCount, templateOption, }: {
17
+ export declare function generatePromptBoilerplate({ projectPath, boilerplateCount, templateOption, }: {
17
18
  readonly projectPath: string;
18
- readonly filesCount: number;
19
+ readonly boilerplateCount: BoilerplateCount;
19
20
  readonly templateOption?: string;
20
21
  }): Promise<void>;
@@ -1,16 +1,19 @@
1
1
  import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
2
2
  import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
3
3
  /**
4
- * COMPONENT commitment definition
4
+ * META FULLNAME commitment definition
5
5
  *
6
- * The COMPONENT commitment defines a UI component that the agent can render in the chat.
6
+ * The `META FULLNAME` commitment sets the full display name of the agent, which can differ
7
+ * from the agent name on the first line of the agent source, for example when the agent
8
+ * should be presented with academic titles.
9
+ * This commitment is metadata-only and does not modify model requirements.
7
10
  *
8
11
  * @private [🪔] Maybe export the commitments through some package
9
12
  */
10
- export declare class ComponentCommitmentDefinition extends BaseCommitmentDefinition<'COMPONENT'> {
13
+ export declare class MetaFullnameCommitmentDefinition extends BaseCommitmentDefinition<'META FULLNAME'> {
11
14
  constructor();
12
15
  /**
13
- * Short one-line description of COMPONENT.
16
+ * Short one-line description of META FULLNAME.
14
17
  */
15
18
  get description(): string;
16
19
  /**
@@ -18,7 +21,7 @@ export declare class ComponentCommitmentDefinition extends BaseCommitmentDefinit
18
21
  */
19
22
  get icon(): string;
20
23
  /**
21
- * Markdown documentation for COMPONENT commitment.
24
+ * Markdown documentation for META FULLNAME commitment.
22
25
  */
23
26
  get documentation(): string;
24
27
  applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
@@ -0,0 +1,32 @@
1
+ import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
2
+ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
3
+ /**
4
+ * META ID commitment definition
5
+ *
6
+ * The `META ID` commitment carries the permanent id of the agent when an agent source is moved
7
+ * between systems. It is a low-level commitment which is normally written and stripped by the
8
+ * persistence layer instead of being written by hand.
9
+ * This commitment is metadata-only and does not modify model requirements.
10
+ *
11
+ * @private [🪔] Maybe export the commitments through some package
12
+ */
13
+ export declare class MetaIdCommitmentDefinition extends BaseCommitmentDefinition<'META ID'> {
14
+ constructor();
15
+ /**
16
+ * Short one-line description of META ID.
17
+ */
18
+ get description(): string;
19
+ /**
20
+ * Icon for this commitment.
21
+ */
22
+ get icon(): string;
23
+ /**
24
+ * `META ID` is written by the persistence layer, not by agent authors.
25
+ */
26
+ get isLowLevel(): boolean;
27
+ /**
28
+ * Markdown documentation for META ID commitment.
29
+ */
30
+ get documentation(): string;
31
+ applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
32
+ }
@@ -1,6 +1,5 @@
1
1
  import { ActionCommitmentDefinition } from './ACTION/ACTION';
2
2
  import { ClosedCommitmentDefinition } from './CLOSED/CLOSED';
3
- import { ComponentCommitmentDefinition } from './COMPONENT/COMPONENT';
4
3
  import { DeleteCommitmentDefinition } from './DELETE/DELETE';
5
4
  import { DictionaryCommitmentDefinition } from './DICTIONARY/DICTIONARY';
6
5
  import { FormatCommitmentDefinition } from './FORMAT/FORMAT';
@@ -9,19 +8,20 @@ import { GoalCommitmentDefinition } from './GOAL/GOAL';
9
8
  import { ImportCommitmentDefinition } from './IMPORT/IMPORT';
10
9
  import { KnowledgeCommitmentDefinition } from './KNOWLEDGE/KNOWLEDGE';
11
10
  import { LanguageCommitmentDefinition } from './LANGUAGE/LANGUAGE';
12
- import { MemoryCommitmentDefinition } from './MEMORY/MEMORY';
13
11
  import { AgentMessageCommitmentDefinition } from './MESSAGE/AgentMessageCommitmentDefinition';
14
12
  import { InitialMessageCommitmentDefinition } from './MESSAGE/InitialMessageCommitmentDefinition';
15
13
  import { InternalMessageCommitmentDefinition } from './MESSAGE/InternalMessageCommitmentDefinition';
16
14
  import { MessageCommitmentDefinition } from './MESSAGE/MESSAGE';
17
15
  import { UserMessageCommitmentDefinition } from './MESSAGE/UserMessageCommitmentDefinition';
18
16
  import { MessageSuffixCommitmentDefinition } from './MESSAGE_SUFFIX/MESSAGE_SUFFIX';
19
- import { MetaCommitmentDefinition } from './META/META';
20
17
  import { MetaAvatarCommitmentDefinition } from './META_AVATAR/META_AVATAR';
21
18
  import { MetaColorCommitmentDefinition } from './META_COLOR/META_COLOR';
19
+ import { MetaDescriptionCommitmentDefinition } from './META_DESCRIPTION/META_DESCRIPTION';
22
20
  import { MetaDomainCommitmentDefinition } from './META_DOMAIN/META_DOMAIN';
23
21
  import { MetaDisclaimerCommitmentDefinition } from './META_DISCLAIMER/META_DISCLAIMER';
24
22
  import { MetaFontCommitmentDefinition } from './META_FONT/META_FONT';
23
+ import { MetaFullnameCommitmentDefinition } from './META_FULLNAME/META_FULLNAME';
24
+ import { MetaIdCommitmentDefinition } from './META_ID/META_ID';
25
25
  import { MetaImageCommitmentDefinition } from './META_IMAGE/META_IMAGE';
26
26
  import { MetaInputPlaceholderCommitmentDefinition } from './META_INPUT_PLACEHOLDER/META_INPUT_PLACEHOLDER';
27
27
  import { MetaLinkCommitmentDefinition } from './META_LINK/META_LINK';
@@ -38,21 +38,13 @@ import { ScenarioCommitmentDefinition } from './SCENARIO/SCENARIO';
38
38
  import { StyleCommitmentDefinition } from './STYLE/STYLE';
39
39
  import { TeamCommitmentDefinition } from './TEAM/TEAM';
40
40
  import { TemplateCommitmentDefinition } from './TEMPLATE/TEMPLATE';
41
- import { UseBrowserCommitmentDefinition } from './USE_BROWSER/USE_BROWSER';
42
41
  import { UseCalendarCommitmentDefinition } from './USE_CALENDAR/USE_CALENDAR';
43
- import { UseDeepSearchCommitmentDefinition } from './USE_DEEPSEARCH/USE_DEEPSEARCH';
44
- import { UseEmailCommitmentDefinition } from './USE_EMAIL/USE_EMAIL';
45
42
  import { UseImageGeneratorCommitmentDefinition } from './USE_IMAGE_GENERATOR/USE_IMAGE_GENERATOR';
46
43
  import { UseMcpCommitmentDefinition } from './USE_MCP/USE_MCP';
47
44
  import { UsePopupCommitmentDefinition } from './USE_POPUP/USE_POPUP';
48
45
  import { UsePrivacyCommitmentDefinition } from './USE_PRIVACY/USE_PRIVACY';
49
46
  import { UseProjectCommitmentDefinition } from './USE_PROJECT/USE_PROJECT';
50
- import { UseSearchEngineCommitmentDefinition } from './USE_SEARCH_ENGINE/USE_SEARCH_ENGINE';
51
- import { UseSpawnCommitmentDefinition } from './USE_SPAWN/USE_SPAWN';
52
- import { UseTimeoutCommitmentDefinition } from './USE_TIMEOUT/USE_TIMEOUT';
53
- import { UseTimeCommitmentDefinition } from './USE_TIME/USE_TIME';
54
47
  import { UseUserLocationCommitmentDefinition } from './USE_USER_LOCATION/USE_USER_LOCATION';
55
- import { WalletCommitmentDefinition } from './WALLET/WALLET';
56
48
  import { WritingRulesCommitmentDefinition } from './WRITING_RULES/WRITING_RULES';
57
49
  import { WritingSampleCommitmentDefinition } from './WRITING_SAMPLE/WRITING_SAMPLE';
58
50
  import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplementedCommitmentDefinition';
@@ -63,4 +55,4 @@ import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplemented
63
55
  *
64
56
  * @private Use functions to access commitments instead of this array directly
65
57
  */
66
- 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, MetaAvatarCommitmentDefinition, MetaImageCommitmentDefinition, MetaColorCommitmentDefinition, MetaFontCommitmentDefinition, MetaLinkCommitmentDefinition, MetaDomainCommitmentDefinition, MetaDisclaimerCommitmentDefinition, MetaInputPlaceholderCommitmentDefinition, MetaThinkingMessageCommitmentDefinition, MetaVisibilityCommitmentDefinition, MetaCommitmentDefinition, MetaVoiceCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, InitialMessageCommitmentDefinition, UserMessageCommitmentDefinition, InternalMessageCommitmentDefinition, AgentMessageCommitmentDefinition, MessageSuffixCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, WalletCommitmentDefinition, WalletCommitmentDefinition, 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">];
58
+ export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, StyleCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, LanguageCommitmentDefinition, LanguageCommitmentDefinition, WritingSampleCommitmentDefinition, WritingRulesCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, TemplateCommitmentDefinition, TemplateCommitmentDefinition, FromCommitmentDefinition, ImportCommitmentDefinition, ImportCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, MetaAvatarCommitmentDefinition, MetaAvatarCommitmentDefinition, MetaImageCommitmentDefinition, MetaColorCommitmentDefinition, MetaFontCommitmentDefinition, MetaLinkCommitmentDefinition, MetaDomainCommitmentDefinition, MetaDescriptionCommitmentDefinition, MetaDisclaimerCommitmentDefinition, MetaFullnameCommitmentDefinition, MetaIdCommitmentDefinition, MetaInputPlaceholderCommitmentDefinition, MetaThinkingMessageCommitmentDefinition, MetaVisibilityCommitmentDefinition, 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, UseUserLocationCommitmentDefinition, UseCalendarCommitmentDefinition, UsePopupCommitmentDefinition, UseImageGeneratorCommitmentDefinition, UseMcpCommitmentDefinition, UsePrivacyCommitmentDefinition, UseProjectCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
@@ -45,7 +45,7 @@ export declare class Agent extends AgentLlmExecutionTools implements LlmExecutio
45
45
  links: Array<string_agent_url>;
46
46
  /**
47
47
  * Capabilities of the agent
48
- * This is parsed from commitments like USE BROWSER, USE SEARCH ENGINE, KNOWLEDGE, etc.
48
+ * This is parsed from commitments like USE CALENDAR, USE PROJECT, KNOWLEDGE, etc.
49
49
  */
50
50
  capabilities: Array<AgentCapability>;
51
51
  /**
@@ -73,7 +73,7 @@ export declare class OpenAiAgentKitExecutionToolsToolBuilder {
73
73
  */
74
74
  private normalizeAgentKitToolParameters;
75
75
  /**
76
- * Creates the native Agent SDK tool used for `USE DEEPSEARCH`.
76
+ * Creates the native Agent SDK tool used for the DeepSearch capability.
77
77
  */
78
78
  private createDeepSearchAgentKitTool;
79
79
  /**
@@ -8,12 +8,11 @@
8
8
  * 4. Returns the scraped markdown content
9
9
  *
10
10
  * WARNING: This function should NOT be used directly in browser environments.
11
- * For browser environments, use fetchUrlContentViaBrowser which proxies through
12
- * the Agents Server API endpoint at /api/scrape
11
+ * For browser environments, proxy the request through the Agents Server API endpoint at /api/scrape
13
12
  *
14
13
  * @param url The URL to fetch and scrape
15
14
  * @returns Markdown content from the URL
16
15
  *
17
- * @private internal utility for USE BROWSER commitment
16
+ * @private internal scraping utility
18
17
  */
19
18
  export declare function fetchUrlContent(url: string): Promise<string>;
@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
15
15
  export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
16
16
  /**
17
17
  * Represents the version string of the Promptbook engine.
18
- * It follows semantic versioning (e.g., `0.114.0-2`).
18
+ * It follows semantic versioning (e.g., `0.114.0-3`).
19
19
  *
20
20
  * @generated
21
21
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/openai",
3
- "version": "0.114.0-3",
3
+ "version": "0.114.0-4",
4
4
  "description": "Promptbook: Create persistent AI agents that turn your company's scattered knowledge into action",
5
5
  "private": false,
6
6
  "sideEffects": false,
@@ -106,7 +106,7 @@
106
106
  "types": "./esm/src/_packages/openai.index.d.ts",
107
107
  "typings": "./esm/src/_packages/openai.index.d.ts",
108
108
  "peerDependencies": {
109
- "@promptbook/core": "0.114.0-3"
109
+ "@promptbook/core": "0.114.0-4"
110
110
  },
111
111
  "dependencies": {
112
112
  "@openai/agents": "0.4.15",
package/umd/index.umd.js CHANGED
@@ -24,7 +24,7 @@
24
24
  * @generated
25
25
  * @see https://github.com/webgptorg/promptbook
26
26
  */
27
- const PROMPTBOOK_ENGINE_VERSION = '0.114.0-3';
27
+ const PROMPTBOOK_ENGINE_VERSION = '0.114.0-4';
28
28
  /**
29
29
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
30
30
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -8188,7 +8188,7 @@
8188
8188
  */
8189
8189
  const DEFAULT_DEEP_SEARCH_MODEL_NAME = 'o4-mini-deep-research';
8190
8190
  /**
8191
- * Tool name used by the Book commitment-backed DeepSearch capability.
8191
+ * Tool name used by the DeepSearch capability.
8192
8192
  */
8193
8193
  const DEEP_SEARCH_TOOL_NAME = 'deep_search';
8194
8194
  /**
@@ -8458,7 +8458,7 @@
8458
8458
  };
8459
8459
  }
8460
8460
  /**
8461
- * Creates the native Agent SDK tool used for `USE DEEPSEARCH`.
8461
+ * Creates the native Agent SDK tool used for the DeepSearch capability.
8462
8462
  */
8463
8463
  async createDeepSearchAgentKitTool(toolDefinition) {
8464
8464
  const { Agent: AgentFromKit, webSearchTool } = await loadOpenAiAgentsModule();
@@ -31,13 +31,13 @@ export type BookParameter = {
31
31
  };
32
32
  /**
33
33
  * Capability of the agent
34
- * This is parsed from commitments like USE BROWSER, USE SEARCH ENGINE, KNOWLEDGE, etc.
34
+ * This is parsed from commitments like USE CALENDAR, USE PROJECT, KNOWLEDGE, etc.
35
35
  */
36
36
  export type AgentCapability = {
37
37
  /**
38
38
  * The type of the capability
39
39
  */
40
- type: 'browser' | 'search-engine' | 'knowledge' | 'timeout' | 'time' | 'user-location' | 'inheritance' | 'import' | 'image-generator' | 'team' | 'email' | 'popup' | 'privacy' | 'project' | 'calendar' | 'wallet';
40
+ type: 'knowledge' | 'user-location' | 'inheritance' | 'import' | 'image-generator' | 'team' | 'popup' | 'privacy' | 'project' | 'calendar';
41
41
  /**
42
42
  * The label to display for this capability
43
43
  */
@@ -122,7 +122,7 @@ export type AgentBasicInformation = {
122
122
  parameters: Array<BookParameter>;
123
123
  /**
124
124
  * Capabilities of the agent
125
- * This is parsed from commitments like USE BROWSER, USE SEARCH ENGINE, KNOWLEDGE, etc.
125
+ * This is parsed from commitments like USE CALENDAR, USE PROJECT, KNOWLEDGE, etc.
126
126
  */
127
127
  capabilities: Array<AgentCapability>;
128
128
  /**
@@ -0,0 +1,52 @@
1
+ /**
2
+ * How many prompt boilerplate files are generated and how many prompts each of them contains.
3
+ *
4
+ * @private internal utility of `ptbk coder`
5
+ */
6
+ export type BoilerplateCount = {
7
+ /**
8
+ * Number of generated prompt boilerplate files.
9
+ */
10
+ readonly filesCount: number;
11
+ /**
12
+ * Number of prompts written into each generated file.
13
+ *
14
+ * Note: More than one prompt per file is an advanced option - each prompt is one separate
15
+ * coding task separated by `---` and tagged with its own fresh emoji tag.
16
+ */
17
+ readonly promptsPerFileCount: number;
18
+ };
19
+ /**
20
+ * Number of prompt boilerplate files and prompts per file used when `--count` is not provided.
21
+ *
22
+ * @private internal utility of `ptbk coder`
23
+ */
24
+ export declare const DEFAULT_BOILERPLATE_COUNT: BoilerplateCount;
25
+ /**
26
+ * Formats one boilerplate count back into the `N*M` notation of the `--count` option.
27
+ *
28
+ * @private internal utility of `ptbk coder`
29
+ */
30
+ export declare function formatBoilerplateCount({ filesCount, promptsPerFileCount }: BoilerplateCount): string;
31
+ /**
32
+ * Default value of the `--count` option rendered in the `N*M` notation, for example `5*1`.
33
+ *
34
+ * @private internal utility of `ptbk coder`
35
+ */
36
+ export declare const DEFAULT_BOILERPLATE_COUNT_OPTION_VALUE: string;
37
+ /**
38
+ * Description of the `--count` option shared by all commands which generate prompt boilerplates.
39
+ *
40
+ * @private internal utility of `ptbk coder`
41
+ */
42
+ export declare const BOILERPLATE_COUNT_OPTION_DESCRIPTION: string;
43
+ /**
44
+ * Parses the `--count` option value into the number of files and the number of prompts in each of them.
45
+ *
46
+ * Both notations are supported:
47
+ * - `N` and `N*1` => N files with one prompt each
48
+ * - `N*M` => N files with M prompts each
49
+ *
50
+ * @private internal utility of `ptbk coder`
51
+ */
52
+ export declare function parseBoilerplateCount(countOption: string): BoilerplateCount;
@@ -1,5 +1,6 @@
1
1
  import type { Command as Program } from 'commander';
2
2
  import type { $side_effect } from '../../../utils/organization/$side_effect';
3
+ import type { BoilerplateCount } from './boilerplateCount';
3
4
  /**
4
5
  * Initializes `coder generate-boilerplates` command for Promptbook CLI utilities
5
6
  *
@@ -13,8 +14,8 @@ export declare function $initializeCoderGenerateBoilerplatesCommand(program: Pro
13
14
  *
14
15
  * @private internal function of `generatePromptBoilerplate` command
15
16
  */
16
- export declare function generatePromptBoilerplate({ projectPath, filesCount, templateOption, }: {
17
+ export declare function generatePromptBoilerplate({ projectPath, boilerplateCount, templateOption, }: {
17
18
  readonly projectPath: string;
18
- readonly filesCount: number;
19
+ readonly boilerplateCount: BoilerplateCount;
19
20
  readonly templateOption?: string;
20
21
  }): Promise<void>;
@@ -1,16 +1,19 @@
1
1
  import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
2
2
  import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
3
3
  /**
4
- * COMPONENT commitment definition
4
+ * META FULLNAME commitment definition
5
5
  *
6
- * The COMPONENT commitment defines a UI component that the agent can render in the chat.
6
+ * The `META FULLNAME` commitment sets the full display name of the agent, which can differ
7
+ * from the agent name on the first line of the agent source, for example when the agent
8
+ * should be presented with academic titles.
9
+ * This commitment is metadata-only and does not modify model requirements.
7
10
  *
8
11
  * @private [🪔] Maybe export the commitments through some package
9
12
  */
10
- export declare class ComponentCommitmentDefinition extends BaseCommitmentDefinition<'COMPONENT'> {
13
+ export declare class MetaFullnameCommitmentDefinition extends BaseCommitmentDefinition<'META FULLNAME'> {
11
14
  constructor();
12
15
  /**
13
- * Short one-line description of COMPONENT.
16
+ * Short one-line description of META FULLNAME.
14
17
  */
15
18
  get description(): string;
16
19
  /**
@@ -18,7 +21,7 @@ export declare class ComponentCommitmentDefinition extends BaseCommitmentDefinit
18
21
  */
19
22
  get icon(): string;
20
23
  /**
21
- * Markdown documentation for COMPONENT commitment.
24
+ * Markdown documentation for META FULLNAME commitment.
22
25
  */
23
26
  get documentation(): string;
24
27
  applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
@@ -0,0 +1,32 @@
1
+ import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
2
+ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
3
+ /**
4
+ * META ID commitment definition
5
+ *
6
+ * The `META ID` commitment carries the permanent id of the agent when an agent source is moved
7
+ * between systems. It is a low-level commitment which is normally written and stripped by the
8
+ * persistence layer instead of being written by hand.
9
+ * This commitment is metadata-only and does not modify model requirements.
10
+ *
11
+ * @private [🪔] Maybe export the commitments through some package
12
+ */
13
+ export declare class MetaIdCommitmentDefinition extends BaseCommitmentDefinition<'META ID'> {
14
+ constructor();
15
+ /**
16
+ * Short one-line description of META ID.
17
+ */
18
+ get description(): string;
19
+ /**
20
+ * Icon for this commitment.
21
+ */
22
+ get icon(): string;
23
+ /**
24
+ * `META ID` is written by the persistence layer, not by agent authors.
25
+ */
26
+ get isLowLevel(): boolean;
27
+ /**
28
+ * Markdown documentation for META ID commitment.
29
+ */
30
+ get documentation(): string;
31
+ applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
32
+ }
@@ -1,6 +1,5 @@
1
1
  import { ActionCommitmentDefinition } from './ACTION/ACTION';
2
2
  import { ClosedCommitmentDefinition } from './CLOSED/CLOSED';
3
- import { ComponentCommitmentDefinition } from './COMPONENT/COMPONENT';
4
3
  import { DeleteCommitmentDefinition } from './DELETE/DELETE';
5
4
  import { DictionaryCommitmentDefinition } from './DICTIONARY/DICTIONARY';
6
5
  import { FormatCommitmentDefinition } from './FORMAT/FORMAT';
@@ -9,19 +8,20 @@ import { GoalCommitmentDefinition } from './GOAL/GOAL';
9
8
  import { ImportCommitmentDefinition } from './IMPORT/IMPORT';
10
9
  import { KnowledgeCommitmentDefinition } from './KNOWLEDGE/KNOWLEDGE';
11
10
  import { LanguageCommitmentDefinition } from './LANGUAGE/LANGUAGE';
12
- import { MemoryCommitmentDefinition } from './MEMORY/MEMORY';
13
11
  import { AgentMessageCommitmentDefinition } from './MESSAGE/AgentMessageCommitmentDefinition';
14
12
  import { InitialMessageCommitmentDefinition } from './MESSAGE/InitialMessageCommitmentDefinition';
15
13
  import { InternalMessageCommitmentDefinition } from './MESSAGE/InternalMessageCommitmentDefinition';
16
14
  import { MessageCommitmentDefinition } from './MESSAGE/MESSAGE';
17
15
  import { UserMessageCommitmentDefinition } from './MESSAGE/UserMessageCommitmentDefinition';
18
16
  import { MessageSuffixCommitmentDefinition } from './MESSAGE_SUFFIX/MESSAGE_SUFFIX';
19
- import { MetaCommitmentDefinition } from './META/META';
20
17
  import { MetaAvatarCommitmentDefinition } from './META_AVATAR/META_AVATAR';
21
18
  import { MetaColorCommitmentDefinition } from './META_COLOR/META_COLOR';
19
+ import { MetaDescriptionCommitmentDefinition } from './META_DESCRIPTION/META_DESCRIPTION';
22
20
  import { MetaDomainCommitmentDefinition } from './META_DOMAIN/META_DOMAIN';
23
21
  import { MetaDisclaimerCommitmentDefinition } from './META_DISCLAIMER/META_DISCLAIMER';
24
22
  import { MetaFontCommitmentDefinition } from './META_FONT/META_FONT';
23
+ import { MetaFullnameCommitmentDefinition } from './META_FULLNAME/META_FULLNAME';
24
+ import { MetaIdCommitmentDefinition } from './META_ID/META_ID';
25
25
  import { MetaImageCommitmentDefinition } from './META_IMAGE/META_IMAGE';
26
26
  import { MetaInputPlaceholderCommitmentDefinition } from './META_INPUT_PLACEHOLDER/META_INPUT_PLACEHOLDER';
27
27
  import { MetaLinkCommitmentDefinition } from './META_LINK/META_LINK';
@@ -38,21 +38,13 @@ import { ScenarioCommitmentDefinition } from './SCENARIO/SCENARIO';
38
38
  import { StyleCommitmentDefinition } from './STYLE/STYLE';
39
39
  import { TeamCommitmentDefinition } from './TEAM/TEAM';
40
40
  import { TemplateCommitmentDefinition } from './TEMPLATE/TEMPLATE';
41
- import { UseBrowserCommitmentDefinition } from './USE_BROWSER/USE_BROWSER';
42
41
  import { UseCalendarCommitmentDefinition } from './USE_CALENDAR/USE_CALENDAR';
43
- import { UseDeepSearchCommitmentDefinition } from './USE_DEEPSEARCH/USE_DEEPSEARCH';
44
- import { UseEmailCommitmentDefinition } from './USE_EMAIL/USE_EMAIL';
45
42
  import { UseImageGeneratorCommitmentDefinition } from './USE_IMAGE_GENERATOR/USE_IMAGE_GENERATOR';
46
43
  import { UseMcpCommitmentDefinition } from './USE_MCP/USE_MCP';
47
44
  import { UsePopupCommitmentDefinition } from './USE_POPUP/USE_POPUP';
48
45
  import { UsePrivacyCommitmentDefinition } from './USE_PRIVACY/USE_PRIVACY';
49
46
  import { UseProjectCommitmentDefinition } from './USE_PROJECT/USE_PROJECT';
50
- import { UseSearchEngineCommitmentDefinition } from './USE_SEARCH_ENGINE/USE_SEARCH_ENGINE';
51
- import { UseSpawnCommitmentDefinition } from './USE_SPAWN/USE_SPAWN';
52
- import { UseTimeoutCommitmentDefinition } from './USE_TIMEOUT/USE_TIMEOUT';
53
- import { UseTimeCommitmentDefinition } from './USE_TIME/USE_TIME';
54
47
  import { UseUserLocationCommitmentDefinition } from './USE_USER_LOCATION/USE_USER_LOCATION';
55
- import { WalletCommitmentDefinition } from './WALLET/WALLET';
56
48
  import { WritingRulesCommitmentDefinition } from './WRITING_RULES/WRITING_RULES';
57
49
  import { WritingSampleCommitmentDefinition } from './WRITING_SAMPLE/WRITING_SAMPLE';
58
50
  import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplementedCommitmentDefinition';
@@ -63,4 +55,4 @@ import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplemented
63
55
  *
64
56
  * @private Use functions to access commitments instead of this array directly
65
57
  */
66
- 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, MetaAvatarCommitmentDefinition, MetaImageCommitmentDefinition, MetaColorCommitmentDefinition, MetaFontCommitmentDefinition, MetaLinkCommitmentDefinition, MetaDomainCommitmentDefinition, MetaDisclaimerCommitmentDefinition, MetaInputPlaceholderCommitmentDefinition, MetaThinkingMessageCommitmentDefinition, MetaVisibilityCommitmentDefinition, MetaCommitmentDefinition, MetaVoiceCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, InitialMessageCommitmentDefinition, UserMessageCommitmentDefinition, InternalMessageCommitmentDefinition, AgentMessageCommitmentDefinition, MessageSuffixCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, WalletCommitmentDefinition, WalletCommitmentDefinition, 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">];
58
+ export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, StyleCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, LanguageCommitmentDefinition, LanguageCommitmentDefinition, WritingSampleCommitmentDefinition, WritingRulesCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, TemplateCommitmentDefinition, TemplateCommitmentDefinition, FromCommitmentDefinition, ImportCommitmentDefinition, ImportCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, MetaAvatarCommitmentDefinition, MetaAvatarCommitmentDefinition, MetaImageCommitmentDefinition, MetaColorCommitmentDefinition, MetaFontCommitmentDefinition, MetaLinkCommitmentDefinition, MetaDomainCommitmentDefinition, MetaDescriptionCommitmentDefinition, MetaDisclaimerCommitmentDefinition, MetaFullnameCommitmentDefinition, MetaIdCommitmentDefinition, MetaInputPlaceholderCommitmentDefinition, MetaThinkingMessageCommitmentDefinition, MetaVisibilityCommitmentDefinition, 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, UseUserLocationCommitmentDefinition, UseCalendarCommitmentDefinition, UsePopupCommitmentDefinition, UseImageGeneratorCommitmentDefinition, UseMcpCommitmentDefinition, UsePrivacyCommitmentDefinition, UseProjectCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
@@ -45,7 +45,7 @@ export declare class Agent extends AgentLlmExecutionTools implements LlmExecutio
45
45
  links: Array<string_agent_url>;
46
46
  /**
47
47
  * Capabilities of the agent
48
- * This is parsed from commitments like USE BROWSER, USE SEARCH ENGINE, KNOWLEDGE, etc.
48
+ * This is parsed from commitments like USE CALENDAR, USE PROJECT, KNOWLEDGE, etc.
49
49
  */
50
50
  capabilities: Array<AgentCapability>;
51
51
  /**