@promptbook/types 0.114.0-0 → 0.114.0-10
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.
- package/README.md +20 -27
- package/esm/src/_packages/components.index.d.ts +4 -0
- package/esm/src/_packages/types.index.d.ts +4 -0
- package/esm/src/avatars/renderAvatarVisualTerminalText.d.ts +80 -0
- package/esm/src/avatars/types/AvatarVisualDefinition.d.ts +54 -0
- package/esm/src/book-2.0/agent-source/AgentBasicInformation.d.ts +3 -3
- package/esm/src/book-2.0/book-language-documentation/BookLanguageManualDictionary.d.ts +1 -15
- package/esm/src/book-2.0/book-language-documentation/getBookLanguageManualCommitmentGroups.d.ts +1 -1
- package/esm/src/book-2.0/book-language-documentation/renderCommitmentCatalogSection.d.ts +0 -4
- package/esm/src/book-3.0/AgentTeamConversationWorkspace.d.ts +85 -0
- package/esm/src/book-components/Chat/Chat/ChatProps.d.ts +3 -2
- package/esm/src/book-components/Chat/utils/$provideServerDomWindow.d.ts +11 -0
- package/esm/src/book-components/Chat/utils/renderMarkdown.d.ts +72 -0
- package/esm/src/cli/cli-commands/agents-server/buildAgentsServer/createAgentsServerRuntimeEnvironment.d.ts +7 -0
- package/esm/src/cli/cli-commands/coder/agentCodingFile.d.ts +2 -3
- package/esm/src/cli/cli-commands/coder/boilerplateCount.d.ts +52 -0
- package/esm/src/cli/cli-commands/coder/generate-boilerplates.d.ts +4 -3
- package/esm/src/cli/cli-commands/coder/ping.d.ts +10 -0
- package/esm/src/cli/cli-commands/coder/verify.d.ts +1 -1
- package/esm/src/cli/cli-commands/coder.d.ts +1 -0
- package/esm/src/cli/cli-commands/common/coderGitSyncCliOptions.d.ts +34 -0
- package/esm/src/cli/cli-commands/common/{harness/$askForHarnessInstallationApproval.d.ts → npm/$askForNpmPackageInstallationApproval.d.ts} +2 -2
- package/{umd/src/cli/cli-commands/common/harness/$resolveLatestHarnessVersion.d.ts → esm/src/cli/cli-commands/common/npm/$resolveLatestNpmPackageVersion.d.ts} +2 -3
- package/esm/src/cli/cli-commands/common/npm/buildNpmPackageInstallCommand.d.ts +12 -0
- package/esm/src/cli/cli-commands/common/npm/extractNpmPackageVersionFromOutput.d.ts +12 -0
- package/esm/src/cli/cli-commands/common/npm/isNpmPackageVersionOutdated.d.ts +12 -0
- package/esm/src/cli/cli-commands/common/promptbook-cli/$checkPromptbookCliInstallations.d.ts +9 -0
- package/esm/src/cli/cli-commands/common/promptbook-cli/$ensurePromptbookCliInstallations.d.ts +14 -0
- package/esm/src/cli/cli-commands/common/promptbook-cli/$resolvePromptbookCliInstallations.d.ts +12 -0
- package/esm/src/cli/cli-commands/common/promptbook-cli/$updatePromptbookCliInstallation.d.ts +10 -0
- package/esm/src/cli/cli-commands/common/promptbook-cli/PromptbookCliInstallation.d.ts +66 -0
- package/esm/src/cli/cli-commands/common/promptbook-cli/PromptbookCliInstallationStatus.d.ts +26 -0
- package/esm/src/cli/cli-commands/common/promptbook-cli/buildPromptbookCliInstallCommand.d.ts +7 -0
- package/esm/src/cli/cli-commands/common/promptbook-cli/formatPromptbookCliInstallationWarning.d.ts +7 -0
- package/esm/src/cli/common/loadPromptsModule.d.ts +16 -0
- package/esm/src/commitments/{COMPONENT/COMPONENT.d.ts → META_FULLNAME/META_FULLNAME.d.ts} +8 -5
- package/esm/src/commitments/META_ID/META_ID.d.ts +32 -0
- package/esm/src/commitments/index.d.ts +4 -12
- package/esm/src/llm-providers/agent/Agent.d.ts +1 -1
- package/esm/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +1 -1
- package/esm/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +1 -1
- package/esm/src/llm-providers/openai/OpenAiAgentKitExecutionTools.d.ts +1 -1
- package/esm/src/llm-providers/openai/OpenAiAgentKitExecutionToolsToolBuilder.d.ts +2 -2
- package/esm/src/llm-providers/openai/OpenAiAssistantExecutionToolsStreamRunner.d.ts +1 -1
- package/esm/src/llm-providers/openai/OpenAiAssistantExecutionToolsToolRunner.d.ts +1 -1
- package/esm/src/llm-providers/openai/OpenAiCompatibleNonChatPromptCaller.d.ts +1 -1
- package/esm/src/llm-providers/openai/OpenAiCompatibleRequestManager.d.ts +1 -1
- package/esm/src/llm-providers/openai/utils/callOpenAiCompatibleChatModel.d.ts +1 -1
- package/esm/src/llm-providers/openai/utils/loadOpenAiAgentsModule.d.ts +203 -0
- package/esm/src/llm-providers/openai/utils/uploadFilesToOpenAi.d.ts +1 -1
- package/esm/src/{commitments/USE_BROWSER → scrapers/_common/utils}/fetchUrlContent.d.ts +2 -3
- package/esm/src/utils/agent-message-runtime/resolveAgentMessageRuntimeActivity.d.ts +3 -3
- package/esm/src/utils/agents/terminalAgentAvatarVisual.d.ts +5 -2
- package/esm/src/utils/ascii-art/convertImageDataToAsciiArt.d.ts +6 -0
- package/esm/src/utils/ascii-art/createAnsiColorCode.d.ts +46 -0
- package/esm/src/utils/misc/createLazyModuleLoader.d.ts +14 -0
- package/esm/src/utils/misc/debounce.d.ts +4 -2
- package/esm/src/version.d.ts +1 -1
- package/package.json +2 -2
- package/umd/src/_packages/components.index.d.ts +4 -0
- package/umd/src/_packages/types.index.d.ts +4 -0
- package/umd/src/avatars/renderAvatarVisualTerminalText.d.ts +80 -0
- package/umd/src/avatars/types/AvatarVisualDefinition.d.ts +54 -0
- package/umd/src/book-2.0/agent-source/AgentBasicInformation.d.ts +3 -3
- package/umd/src/book-2.0/book-language-documentation/BookLanguageManualDictionary.d.ts +1 -15
- package/umd/src/book-2.0/book-language-documentation/getBookLanguageManualCommitmentGroups.d.ts +1 -1
- package/umd/src/book-2.0/book-language-documentation/renderCommitmentCatalogSection.d.ts +0 -4
- package/umd/src/book-3.0/AgentTeamConversationWorkspace.d.ts +85 -0
- package/umd/src/book-components/Chat/Chat/ChatProps.d.ts +3 -2
- package/umd/src/book-components/Chat/utils/$provideServerDomWindow.d.ts +11 -0
- package/umd/src/book-components/Chat/utils/renderMarkdown.d.ts +72 -0
- package/umd/src/cli/cli-commands/agents-server/buildAgentsServer/createAgentsServerRuntimeEnvironment.d.ts +7 -0
- package/umd/src/cli/cli-commands/coder/agentCodingFile.d.ts +2 -3
- package/umd/src/cli/cli-commands/coder/boilerplateCount.d.ts +52 -0
- package/umd/src/cli/cli-commands/coder/generate-boilerplates.d.ts +4 -3
- package/umd/src/cli/cli-commands/coder/ping.d.ts +10 -0
- package/umd/src/cli/cli-commands/coder/verify.d.ts +1 -1
- package/umd/src/cli/cli-commands/coder.d.ts +1 -0
- package/umd/src/cli/cli-commands/common/coderGitSyncCliOptions.d.ts +34 -0
- package/umd/src/cli/cli-commands/common/{harness/$askForHarnessInstallationApproval.d.ts → npm/$askForNpmPackageInstallationApproval.d.ts} +2 -2
- package/{esm/src/cli/cli-commands/common/harness/$resolveLatestHarnessVersion.d.ts → umd/src/cli/cli-commands/common/npm/$resolveLatestNpmPackageVersion.d.ts} +2 -3
- package/umd/src/cli/cli-commands/common/npm/buildNpmPackageInstallCommand.d.ts +12 -0
- package/umd/src/cli/cli-commands/common/npm/extractNpmPackageVersionFromOutput.d.ts +12 -0
- package/umd/src/cli/cli-commands/common/npm/isNpmPackageVersionOutdated.d.ts +12 -0
- package/umd/src/cli/cli-commands/common/promptbook-cli/$checkPromptbookCliInstallations.d.ts +9 -0
- package/umd/src/cli/cli-commands/common/promptbook-cli/$ensurePromptbookCliInstallations.d.ts +14 -0
- package/umd/src/cli/cli-commands/common/promptbook-cli/$resolvePromptbookCliInstallations.d.ts +12 -0
- package/umd/src/cli/cli-commands/common/promptbook-cli/$updatePromptbookCliInstallation.d.ts +10 -0
- package/umd/src/cli/cli-commands/common/promptbook-cli/$updatePromptbookCliInstallation.test.d.ts +1 -0
- package/umd/src/cli/cli-commands/common/promptbook-cli/PromptbookCliInstallation.d.ts +66 -0
- package/umd/src/cli/cli-commands/common/promptbook-cli/PromptbookCliInstallationStatus.d.ts +26 -0
- package/umd/src/cli/cli-commands/common/promptbook-cli/buildPromptbookCliInstallCommand.d.ts +7 -0
- package/umd/src/cli/cli-commands/common/promptbook-cli/formatPromptbookCliInstallationWarning.d.ts +7 -0
- package/umd/src/cli/common/loadPromptsModule.d.ts +16 -0
- package/umd/src/commitments/{COMPONENT/COMPONENT.d.ts → META_FULLNAME/META_FULLNAME.d.ts} +8 -5
- package/umd/src/commitments/META_ID/META_ID.d.ts +32 -0
- package/umd/src/commitments/index.d.ts +4 -12
- package/umd/src/llm-providers/agent/Agent.d.ts +1 -1
- package/umd/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +1 -1
- package/umd/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +1 -1
- package/umd/src/llm-providers/openai/OpenAiAgentKitExecutionTools.d.ts +1 -1
- package/umd/src/llm-providers/openai/OpenAiAgentKitExecutionToolsToolBuilder.d.ts +2 -2
- package/umd/src/llm-providers/openai/OpenAiAssistantExecutionToolsStreamRunner.d.ts +1 -1
- package/umd/src/llm-providers/openai/OpenAiAssistantExecutionToolsToolRunner.d.ts +1 -1
- package/umd/src/llm-providers/openai/OpenAiCompatibleNonChatPromptCaller.d.ts +1 -1
- package/umd/src/llm-providers/openai/OpenAiCompatibleRequestManager.d.ts +1 -1
- package/umd/src/llm-providers/openai/utils/callOpenAiCompatibleChatModel.d.ts +1 -1
- package/umd/src/llm-providers/openai/utils/loadOpenAiAgentsModule.d.ts +203 -0
- package/umd/src/llm-providers/openai/utils/uploadFilesToOpenAi.d.ts +1 -1
- package/umd/src/{commitments/USE_BROWSER → scrapers/_common/utils}/fetchUrlContent.d.ts +2 -3
- package/umd/src/utils/agent-message-runtime/resolveAgentMessageRuntimeActivity.d.ts +3 -3
- package/umd/src/utils/agents/terminalAgentAvatarVisual.d.ts +5 -2
- package/umd/src/utils/ascii-art/convertImageDataToAsciiArt.d.ts +6 -0
- package/umd/src/utils/ascii-art/createAnsiColorCode.d.ts +46 -0
- package/umd/src/utils/misc/createLazyModuleLoader.d.ts +14 -0
- package/umd/src/utils/misc/debounce.d.ts +4 -2
- package/umd/src/utils/misc/debounce.test.d.ts +1 -0
- package/umd/src/version.d.ts +1 -1
- package/esm/src/cli/cli-commands/common/harness/extractHarnessVersionFromOutput.d.ts +0 -11
- package/esm/src/cli/cli-commands/common/harness/isHarnessVersionOutdated.d.ts +0 -9
- package/esm/src/commitments/MEMORY/MEMORY.d.ts +0 -48
- package/esm/src/commitments/MEMORY/MemoryToolNames.d.ts +0 -11
- package/esm/src/commitments/MEMORY/MemoryToolRuntimeAdapter.d.ts +0 -149
- package/esm/src/commitments/MEMORY/createMemorySystemMessage.d.ts +0 -6
- package/esm/src/commitments/MEMORY/createMemoryToolFunctions.d.ts +0 -8
- package/esm/src/commitments/MEMORY/createMemoryTools.d.ts +0 -14
- package/esm/src/commitments/MEMORY/getMemoryCommitmentDocumentation.d.ts +0 -6
- package/esm/src/commitments/MEMORY/getMemoryToolRuntimeAdapterOrDisabledResult.d.ts +0 -17
- package/esm/src/commitments/MEMORY/getMemoryToolTitles.d.ts +0 -7
- package/esm/src/commitments/MEMORY/parseMemoryToolArgs.d.ts +0 -61
- package/esm/src/commitments/MEMORY/resolveMemoryRuntimeContext.d.ts +0 -8
- package/esm/src/commitments/MEMORY/setMemoryToolRuntimeAdapter.d.ts +0 -13
- package/esm/src/commitments/META/META.d.ts +0 -65
- package/esm/src/commitments/USE/aggregateUseCommitmentSystemMessages.d.ts +0 -32
- package/esm/src/commitments/USE_BROWSER/USE_BROWSER.d.ts +0 -58
- package/esm/src/commitments/USE_BROWSER/fetchUrlContentViaBrowser.d.ts +0 -13
- package/esm/src/commitments/USE_BROWSER/resolveRunBrowserToolForNode.d.ts +0 -10
- package/esm/src/commitments/USE_DEEPSEARCH/USE_DEEPSEARCH.d.ts +0 -47
- package/esm/src/commitments/USE_EMAIL/USE_EMAIL.d.ts +0 -38
- package/esm/src/commitments/USE_EMAIL/parseUseEmailCommitmentContent.d.ts +0 -21
- package/esm/src/commitments/USE_EMAIL/resolveSendEmailToolForNode.d.ts +0 -11
- package/esm/src/commitments/USE_EMAIL/sendEmailViaBrowser.d.ts +0 -13
- package/esm/src/commitments/USE_SEARCH_ENGINE/USE_SEARCH_ENGINE.d.ts +0 -46
- package/esm/src/commitments/USE_SPAWN/USE_SPAWN.d.ts +0 -38
- package/esm/src/commitments/USE_SPAWN/resolveSpawnAgentToolForNode.d.ts +0 -9
- package/esm/src/commitments/USE_SPAWN/spawnAgentViaBrowser.d.ts +0 -12
- package/esm/src/commitments/USE_TIME/USE_TIME.d.ts +0 -43
- package/esm/src/commitments/USE_TIMEOUT/TimeoutToolNames.d.ts +0 -11
- package/esm/src/commitments/USE_TIMEOUT/TimeoutToolRuntimeAdapter.d.ts +0 -212
- package/esm/src/commitments/USE_TIMEOUT/USE_TIMEOUT.d.ts +0 -38
- package/esm/src/commitments/USE_TIMEOUT/createTimeoutSystemMessage.d.ts +0 -6
- package/esm/src/commitments/USE_TIMEOUT/createTimeoutToolFunctions.d.ts +0 -8
- package/esm/src/commitments/USE_TIMEOUT/createTimeoutTools.d.ts +0 -7
- package/esm/src/commitments/USE_TIMEOUT/getTimeoutToolRuntimeAdapterOrDisabledResult.d.ts +0 -17
- package/esm/src/commitments/USE_TIMEOUT/parseTimeoutToolArgs.d.ts +0 -78
- package/esm/src/commitments/USE_TIMEOUT/resolveTimeoutRuntimeContext.d.ts +0 -8
- package/esm/src/commitments/USE_TIMEOUT/setTimeoutToolRuntimeAdapter.d.ts +0 -13
- package/esm/src/commitments/WALLET/WALLET.d.ts +0 -21
- package/esm/src/commitments/WALLET/WalletToolNames.d.ts +0 -12
- package/esm/src/commitments/WALLET/WalletToolRuntimeAdapter.d.ts +0 -163
- package/esm/src/commitments/WALLET/createWalletSystemMessage.d.ts +0 -6
- package/esm/src/commitments/WALLET/createWalletToolFunctions.d.ts +0 -8
- package/esm/src/commitments/WALLET/createWalletTools.d.ts +0 -7
- package/esm/src/commitments/WALLET/getWalletCommitmentDocumentation.d.ts +0 -6
- package/esm/src/commitments/WALLET/getWalletToolRuntimeAdapterOrDisabledResult.d.ts +0 -16
- package/esm/src/commitments/WALLET/getWalletToolTitles.d.ts +0 -7
- package/esm/src/commitments/WALLET/parseWalletToolArgs.d.ts +0 -51
- package/esm/src/commitments/WALLET/resolveWalletRuntimeContext.d.ts +0 -8
- package/esm/src/commitments/WALLET/setWalletToolRuntimeAdapter.d.ts +0 -13
- package/esm/src/commitments/_common/createSerpSearchToolFunction.d.ts +0 -12
- package/umd/src/cli/cli-commands/common/harness/extractHarnessVersionFromOutput.d.ts +0 -11
- package/umd/src/cli/cli-commands/common/harness/isHarnessVersionOutdated.d.ts +0 -9
- package/umd/src/commitments/MEMORY/MEMORY.d.ts +0 -48
- package/umd/src/commitments/MEMORY/MemoryToolNames.d.ts +0 -11
- package/umd/src/commitments/MEMORY/MemoryToolRuntimeAdapter.d.ts +0 -149
- package/umd/src/commitments/MEMORY/createMemorySystemMessage.d.ts +0 -6
- package/umd/src/commitments/MEMORY/createMemoryToolFunctions.d.ts +0 -8
- package/umd/src/commitments/MEMORY/createMemoryTools.d.ts +0 -14
- package/umd/src/commitments/MEMORY/getMemoryCommitmentDocumentation.d.ts +0 -6
- package/umd/src/commitments/MEMORY/getMemoryToolRuntimeAdapterOrDisabledResult.d.ts +0 -17
- package/umd/src/commitments/MEMORY/getMemoryToolTitles.d.ts +0 -7
- package/umd/src/commitments/MEMORY/parseMemoryToolArgs.d.ts +0 -61
- package/umd/src/commitments/MEMORY/resolveMemoryRuntimeContext.d.ts +0 -8
- package/umd/src/commitments/MEMORY/setMemoryToolRuntimeAdapter.d.ts +0 -13
- package/umd/src/commitments/META/META.d.ts +0 -65
- package/umd/src/commitments/USE/aggregateUseCommitmentSystemMessages.d.ts +0 -32
- package/umd/src/commitments/USE_BROWSER/USE_BROWSER.d.ts +0 -58
- package/umd/src/commitments/USE_BROWSER/fetchUrlContentViaBrowser.d.ts +0 -13
- package/umd/src/commitments/USE_BROWSER/resolveRunBrowserToolForNode.d.ts +0 -10
- package/umd/src/commitments/USE_DEEPSEARCH/USE_DEEPSEARCH.d.ts +0 -47
- package/umd/src/commitments/USE_EMAIL/USE_EMAIL.d.ts +0 -38
- package/umd/src/commitments/USE_EMAIL/parseUseEmailCommitmentContent.d.ts +0 -21
- package/umd/src/commitments/USE_EMAIL/resolveSendEmailToolForNode.d.ts +0 -11
- package/umd/src/commitments/USE_EMAIL/sendEmailViaBrowser.d.ts +0 -13
- package/umd/src/commitments/USE_SEARCH_ENGINE/USE_SEARCH_ENGINE.d.ts +0 -46
- package/umd/src/commitments/USE_SPAWN/USE_SPAWN.d.ts +0 -38
- package/umd/src/commitments/USE_SPAWN/resolveSpawnAgentToolForNode.d.ts +0 -9
- package/umd/src/commitments/USE_SPAWN/spawnAgentViaBrowser.d.ts +0 -12
- package/umd/src/commitments/USE_TIME/USE_TIME.d.ts +0 -43
- package/umd/src/commitments/USE_TIMEOUT/TimeoutToolNames.d.ts +0 -11
- package/umd/src/commitments/USE_TIMEOUT/TimeoutToolRuntimeAdapter.d.ts +0 -212
- package/umd/src/commitments/USE_TIMEOUT/USE_TIMEOUT.d.ts +0 -38
- package/umd/src/commitments/USE_TIMEOUT/createTimeoutSystemMessage.d.ts +0 -6
- package/umd/src/commitments/USE_TIMEOUT/createTimeoutToolFunctions.d.ts +0 -8
- package/umd/src/commitments/USE_TIMEOUT/createTimeoutTools.d.ts +0 -7
- package/umd/src/commitments/USE_TIMEOUT/getTimeoutToolRuntimeAdapterOrDisabledResult.d.ts +0 -17
- package/umd/src/commitments/USE_TIMEOUT/parseTimeoutToolArgs.d.ts +0 -78
- package/umd/src/commitments/USE_TIMEOUT/resolveTimeoutRuntimeContext.d.ts +0 -8
- package/umd/src/commitments/USE_TIMEOUT/setTimeoutToolRuntimeAdapter.d.ts +0 -13
- package/umd/src/commitments/WALLET/WALLET.d.ts +0 -21
- package/umd/src/commitments/WALLET/WalletToolNames.d.ts +0 -12
- package/umd/src/commitments/WALLET/WalletToolRuntimeAdapter.d.ts +0 -163
- package/umd/src/commitments/WALLET/createWalletSystemMessage.d.ts +0 -6
- package/umd/src/commitments/WALLET/createWalletToolFunctions.d.ts +0 -8
- package/umd/src/commitments/WALLET/createWalletTools.d.ts +0 -7
- package/umd/src/commitments/WALLET/getWalletCommitmentDocumentation.d.ts +0 -6
- package/umd/src/commitments/WALLET/getWalletToolRuntimeAdapterOrDisabledResult.d.ts +0 -16
- package/umd/src/commitments/WALLET/getWalletToolTitles.d.ts +0 -7
- package/umd/src/commitments/WALLET/parseWalletToolArgs.d.ts +0 -51
- package/umd/src/commitments/WALLET/resolveWalletRuntimeContext.d.ts +0 -8
- package/umd/src/commitments/WALLET/setWalletToolRuntimeAdapter.d.ts +0 -13
- package/umd/src/commitments/_common/createSerpSearchToolFunction.d.ts +0 -12
- /package/esm/src/{book-2.0/agent-source/createAgentModelRequirements.useCommitmentAggregation.test.d.ts → avatars/renderAvatarVisualTerminalText.test.d.ts} +0 -0
- /package/esm/src/{cli/cli-commands/common/harness/extractHarnessVersionFromOutput.test.d.ts → book-2.0/agent-source/createAgentModelRequirements.commitmentAggregation.test.d.ts} +0 -0
- /package/esm/src/cli/cli-commands/{common/harness/isHarnessVersionOutdated.test.d.ts → coder/boilerplateCount.test.d.ts} +0 -0
- /package/esm/src/{commitments/MEMORY/MEMORY.test.d.ts → cli/cli-commands/coder/generate-boilerplates.test.d.ts} +0 -0
- /package/esm/src/{commitments/USE_BROWSER/USE_BROWSER.test.d.ts → cli/cli-commands/coder/ping.test.d.ts} +0 -0
- /package/esm/src/{commitments/USE_BROWSER/resolveRunBrowserToolForNode.test.d.ts → cli/cli-commands/common/coderGitSyncCliOptions.test.d.ts} +0 -0
- /package/esm/src/{commitments/USE_DEEPSEARCH/USE_DEEPSEARCH.test.d.ts → cli/cli-commands/common/npm/$resolveLatestNpmPackageVersion.test.d.ts} +0 -0
- /package/esm/src/{commitments/USE_EMAIL/USE_EMAIL.test.d.ts → cli/cli-commands/common/npm/buildNpmPackageInstallCommand.test.d.ts} +0 -0
- /package/esm/src/{commitments/USE_EMAIL/parseUseEmailCommitmentContent.test.d.ts → cli/cli-commands/common/npm/extractNpmPackageVersionFromOutput.test.d.ts} +0 -0
- /package/esm/src/{commitments/USE_SEARCH_ENGINE/USE_SEARCH_ENGINE.test.d.ts → cli/cli-commands/common/npm/isNpmPackageVersionOutdated.test.d.ts} +0 -0
- /package/esm/src/{commitments/USE_SPAWN/USE_SPAWN.test.d.ts → cli/cli-commands/common/promptbook-cli/$checkPromptbookCliInstallations.test.d.ts} +0 -0
- /package/esm/src/{commitments/USE_TIME/USE_TIME.test.d.ts → cli/cli-commands/common/promptbook-cli/$ensurePromptbookCliInstallations.test.d.ts} +0 -0
- /package/esm/src/{commitments/USE_TIMEOUT/USE_TIMEOUT.test.d.ts → cli/cli-commands/common/promptbook-cli/$resolvePromptbookCliInstallations.test.d.ts} +0 -0
- /package/esm/src/{commitments/WALLET/WALLET.test.d.ts → cli/cli-commands/common/promptbook-cli/$updatePromptbookCliInstallation.test.d.ts} +0 -0
- /package/esm/src/commitments/{META → META_DESCRIPTION}/META_DESCRIPTION.d.ts +0 -0
- /package/{umd/src/book-2.0/agent-source/createAgentModelRequirements.useCommitmentAggregation.test.d.ts → esm/src/utils/misc/debounce.test.d.ts} +0 -0
- /package/umd/src/{cli/cli-commands/common/harness/extractHarnessVersionFromOutput.test.d.ts → avatars/renderAvatarVisualTerminalText.test.d.ts} +0 -0
- /package/umd/src/{cli/cli-commands/common/harness/isHarnessVersionOutdated.test.d.ts → book-2.0/agent-source/createAgentModelRequirements.commitmentAggregation.test.d.ts} +0 -0
- /package/umd/src/{commitments/MEMORY/MEMORY.test.d.ts → cli/cli-commands/coder/boilerplateCount.test.d.ts} +0 -0
- /package/umd/src/{commitments/USE_BROWSER/USE_BROWSER.test.d.ts → cli/cli-commands/coder/generate-boilerplates.test.d.ts} +0 -0
- /package/umd/src/{commitments/USE_BROWSER/resolveRunBrowserToolForNode.test.d.ts → cli/cli-commands/coder/ping.test.d.ts} +0 -0
- /package/umd/src/{commitments/USE_DEEPSEARCH/USE_DEEPSEARCH.test.d.ts → cli/cli-commands/common/coderGitSyncCliOptions.test.d.ts} +0 -0
- /package/umd/src/{commitments/USE_EMAIL/USE_EMAIL.test.d.ts → cli/cli-commands/common/npm/$resolveLatestNpmPackageVersion.test.d.ts} +0 -0
- /package/umd/src/{commitments/USE_EMAIL/parseUseEmailCommitmentContent.test.d.ts → cli/cli-commands/common/npm/buildNpmPackageInstallCommand.test.d.ts} +0 -0
- /package/umd/src/{commitments/USE_SEARCH_ENGINE/USE_SEARCH_ENGINE.test.d.ts → cli/cli-commands/common/npm/extractNpmPackageVersionFromOutput.test.d.ts} +0 -0
- /package/umd/src/{commitments/USE_SPAWN/USE_SPAWN.test.d.ts → cli/cli-commands/common/npm/isNpmPackageVersionOutdated.test.d.ts} +0 -0
- /package/umd/src/{commitments/USE_TIME/USE_TIME.test.d.ts → cli/cli-commands/common/promptbook-cli/$checkPromptbookCliInstallations.test.d.ts} +0 -0
- /package/umd/src/{commitments/USE_TIMEOUT/USE_TIMEOUT.test.d.ts → cli/cli-commands/common/promptbook-cli/$ensurePromptbookCliInstallations.test.d.ts} +0 -0
- /package/umd/src/{commitments/WALLET/WALLET.test.d.ts → cli/cli-commands/common/promptbook-cli/$resolvePromptbookCliInstallations.test.d.ts} +0 -0
- /package/umd/src/commitments/{META → META_DESCRIPTION}/META_DESCRIPTION.d.ts +0 -0
package/README.md
CHANGED
|
@@ -340,8 +340,6 @@ Respond to incoming legal inquiries via email and keep the company website updat
|
|
|
340
340
|
**KNOWLEDGE** https://company.com/company-policies.pdf<br/>
|
|
341
341
|
**KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
|
|
342
342
|
<br/>
|
|
343
|
-
USE EMAIL<br/>
|
|
344
|
-
USE BROWSER<br/>
|
|
345
343
|
<br/>
|
|
346
344
|
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/>
|
|
347
345
|
|
|
@@ -430,7 +428,7 @@ GOAL Keep the company website updated with the latest legal policies and complia
|
|
|
430
428
|
|
|
431
429
|
#### `Use` commitments
|
|
432
430
|
|
|
433
|
-
Use commitments grant the agent real capabilities - tools it can use to interact with the outside world. `USE
|
|
431
|
+
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.
|
|
434
432
|
|
|
435
433
|
These are what turn a chatbot into a persistent agent that actually does work.
|
|
436
434
|
|
|
@@ -447,9 +445,6 @@ GOAL Keep the company website updated with the latest legal policies and complia
|
|
|
447
445
|
**RULE** Never provide legal advice about criminal law.<br/>
|
|
448
446
|
**KNOWLEDGE** https://company.com/company-policies.pdf<br/>
|
|
449
447
|
**KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
|
|
450
|
-
USE EMAIL<br/>
|
|
451
|
-
USE BROWSER<br/>
|
|
452
|
-
USE SEARCH ENGINE<br/>
|
|
453
448
|
|
|
454
449
|
</td></tr></table>
|
|
455
450
|
|
|
@@ -470,9 +465,6 @@ GOAL Keep the company website updated with the latest legal policies and complia
|
|
|
470
465
|
**RULE** Never provide legal advice about criminal law.<br/>
|
|
471
466
|
**KNOWLEDGE** https://company.com/company-policies.pdf<br/>
|
|
472
467
|
**KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
|
|
473
|
-
USE EMAIL<br/>
|
|
474
|
-
USE BROWSER<br/>
|
|
475
|
-
USE SEARCH ENGINE<br/>
|
|
476
468
|
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/>
|
|
477
469
|
|
|
478
470
|
</td></tr></table>
|
|
@@ -659,7 +651,7 @@ Or you can install them separately:
|
|
|
659
651
|
|
|
660
652
|
Promptbook Coder is **not another standalone coding model**. It is an orchestration layer over coding agents such as **GitHub Copilot**, **OpenAI Codex**, **Claude Code**, **Opencode**, **Cline**, and **Gemini CLI**. The difference is that Promptbook Coder adds a repeatable repository workflow on top of them:
|
|
661
653
|
|
|
662
|
-
- prompt files with explicit statuses like `[ ]`, `[x]`, and `[-]`
|
|
654
|
+
- prompt files with explicit statuses like `[ ]`, `[^]`, `[x]`, and `[-]`
|
|
663
655
|
- automatic selection of the next runnable task, including priority support
|
|
664
656
|
- optional shared repo context loaded from a file such as `AGENTS.md`
|
|
665
657
|
- automatic `git add`, commit, and push after each successful prompt
|
|
@@ -674,11 +666,11 @@ In short: tools like Claude Code, Codex, or GitHub Copilot are the **engines**;
|
|
|
674
666
|
1. `ptbk coder init` prepares the project for the coder workflow, seeds project-owned generic templates in `prompts/templates/`, creates a starter `AGENTS.md` context file, adds helper `npm run coder:*` scripts, ensures `.gitignore` ignores `/.promptbook`, and configures VS Code prompt screenshots in `prompts/screenshots/`.
|
|
675
667
|
2. `ptbk coder generate-boilerplates` creates prompt files in `prompts/`.
|
|
676
668
|
3. You replace placeholder `@@@` sections with real coding tasks.
|
|
677
|
-
4. `ptbk coder run` sends the next ready `[ ]` prompt to the selected coding agent.
|
|
669
|
+
4. `ptbk coder run` sends the next ready `[ ]` prompt to the selected coding agent and immediately marks it as in progress `[^]`, naming the harness, the model and the step which is running.
|
|
678
670
|
5. Promptbook Coder marks the prompt as done `[x]`, records runner metadata, then stages, commits, and pushes the resulting changes.
|
|
679
671
|
6. `ptbk coder verify` reviews completed prompts, archives finished files to `prompts/done/`, and appends a repair prompt when more work is needed.
|
|
680
672
|
|
|
681
|
-
Prompts marked with `[-]` are not ready yet, prompts containing `@@@` are treated as not fully written, and prompts with more `!` markers have higher priority.
|
|
673
|
+
Prompts marked with `[-]` are not ready yet, prompts containing `@@@` are treated as not fully written, and prompts with more `!` markers have higher priority. A prompt left as `[^]` was interrupted in the middle of its implementation — the in-progress status is never reverted, so a killed or crashed coder always leaves that signal behind.
|
|
682
674
|
|
|
683
675
|
#### Features
|
|
684
676
|
|
|
@@ -750,26 +742,27 @@ ptbk coder verify
|
|
|
750
742
|
| ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | ------ | ---- | ----- | ------------------------------------------------------------------------ |
|
|
751
743
|
| `ptbk coder init` | Creates `prompts/`, `prompts/done/`, the project-generic template files materialized in `prompts/templates/` (currently `common.md`), and a starter `AGENTS.md`; ensures `.env` contains `CODING_AGENT_GIT_NAME`, `CODING_AGENT_GIT_EMAIL`, and `CODING_AGENT_GIT_SIGNING_KEY`; adds helper coder scripts to `package.json`; ensures `.gitignore` contains `/.promptbook`; and configures `.vscode/settings.json` to save pasted prompt images into `prompts/screenshots/`. |
|
|
752
744
|
| `ptbk coder generate-boilerplates` | Creates new prompt markdown files with fresh emoji tags so you can quickly fill in coding tasks; `--template` accepts either a built-in alias or a markdown file path relative to the project root. |
|
|
753
|
-
| `ptbk coder run` | Picks the next ready prompt, appends optional context, runs it through the selected coding agent, can optionally verify each attempt with a shell test command and feed failing output back for retries, then marks success or failure, commits the result, and pushes only when `--auto-push` is enabled.
|
|
745
|
+
| `ptbk coder run` | Picks the next ready prompt, can run tests before coding to stop or repair pre-existing failures, appends optional context, runs it through the selected coding agent, can optionally verify each attempt with a shell test command and feed failing output back for retries, then marks success or failure, commits the result, and pushes only when `--auto-push` is enabled. |
|
|
754
746
|
| `ptbk coder find-refactor-candidates` | Scans the repository for oversized or overpacked files and writes prompt files for likely refactors; `--level <xlow | low | medium | high | xhigh | extreme>` ranges from a very benevolent scan to a very aggressive sweep. |
|
|
755
747
|
| `ptbk coder verify` | Walks through completed prompts, archives truly finished work, and adds follow-up repair prompts for unfinished results. |
|
|
756
748
|
|
|
757
749
|
#### Most useful `ptbk coder run` flags
|
|
758
750
|
|
|
759
|
-
| Flag | Purpose
|
|
760
|
-
| -------------------------- |
|
|
761
|
-
| `--harness <name>` | Selects the coding harness.
|
|
762
|
-
| `--model <model>` | Chooses the runner model; required for `openai-codex` and `gemini`, optional for `github-copilot`.
|
|
763
|
-
| `--context <text-or-file>` | Appends extra instructions inline or from a file like `AGENTS.md`.
|
|
764
|
-
| `--test <command>` | Runs a verification command after each prompt attempt and feeds failing output back for retries.
|
|
765
|
-
| `--
|
|
766
|
-
| `--
|
|
767
|
-
| `--
|
|
768
|
-
| `--
|
|
769
|
-
| `--
|
|
770
|
-
| `--
|
|
771
|
-
| `--
|
|
772
|
-
| `--auto-
|
|
751
|
+
| Flag | Purpose |
|
|
752
|
+
| -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
753
|
+
| `--harness <name>` | Selects the coding harness. |
|
|
754
|
+
| `--model <model>` | Chooses the runner model; required for `openai-codex` and `gemini`, optional for `github-copilot`. |
|
|
755
|
+
| `--context <text-or-file>` | Appends extra instructions inline or from a file like `AGENTS.md`. |
|
|
756
|
+
| `--test <command>` | Runs a verification command after each prompt attempt and feeds failing output back for retries. |
|
|
757
|
+
| `--test-before <mode>` | Runs tests before coding: `no` (default), `yes-and-fail` (stop with results), or `yes-and-fix` (create one repair prompt first); defaults to `npm test` when enabled without `--test`. |
|
|
758
|
+
| `--thinking-level <level>` | Sets reasoning effort for supported runners. |
|
|
759
|
+
| `--no-auto` | Waits for user confirmation before each prompt instead of running automatically through the queue. |
|
|
760
|
+
| `--ignore-git-changes` | Disables the clean-working-tree guard. |
|
|
761
|
+
| `--priority <n>` | Runs only prompts at or above the given priority. |
|
|
762
|
+
| `--dry-run` | Prints which prompts are ready instead of executing them. |
|
|
763
|
+
| `--allow-credits` | Lets OpenAI Codex spend credits when required. |
|
|
764
|
+
| `--auto-push` | Pushes each successful coding-agent commit to the configured remote. |
|
|
765
|
+
| `--auto-migrate` | Runs testing-server database migrations after each successful prompt. |
|
|
773
766
|
|
|
774
767
|
#### Typical usage pattern
|
|
775
768
|
|
|
@@ -70,8 +70,10 @@ import type { CitationLabelResolver } from '../book-components/Chat/types/Citati
|
|
|
70
70
|
import type { MessageButton } from '../book-components/Chat/utils/parseMessageButtons';
|
|
71
71
|
import { parseMessageButtons } from '../book-components/Chat/utils/parseMessageButtons';
|
|
72
72
|
import type { MarkdownInlineReference } from '../book-components/Chat/utils/renderMarkdown';
|
|
73
|
+
import type { MarkdownInlineReferenceIcon } from '../book-components/Chat/utils/renderMarkdown';
|
|
73
74
|
import type { MarkdownInlineReferenceMenuStatus } from '../book-components/Chat/utils/renderMarkdown';
|
|
74
75
|
import type { MarkdownInlineReferenceMenuOption } from '../book-components/Chat/utils/renderMarkdown';
|
|
76
|
+
import type { MarkdownInlineReferenceMenuAction } from '../book-components/Chat/utils/renderMarkdown';
|
|
75
77
|
import type { MarkdownInlineReferenceMenu } from '../book-components/Chat/utils/renderMarkdown';
|
|
76
78
|
import { ArrowIcon } from '../book-components/icons/ArrowIcon';
|
|
77
79
|
import { MicIcon } from '../book-components/icons/MicIcon';
|
|
@@ -159,8 +161,10 @@ export type { CitationLabelResolver };
|
|
|
159
161
|
export type { MessageButton };
|
|
160
162
|
export { parseMessageButtons };
|
|
161
163
|
export type { MarkdownInlineReference };
|
|
164
|
+
export type { MarkdownInlineReferenceIcon };
|
|
162
165
|
export type { MarkdownInlineReferenceMenuStatus };
|
|
163
166
|
export type { MarkdownInlineReferenceMenuOption };
|
|
167
|
+
export type { MarkdownInlineReferenceMenuAction };
|
|
164
168
|
export type { MarkdownInlineReferenceMenu };
|
|
165
169
|
export { ArrowIcon };
|
|
166
170
|
export { MicIcon };
|
|
@@ -62,8 +62,10 @@ import type { CitationLabelResolver } from '../book-components/Chat/types/Citati
|
|
|
62
62
|
import type { ParsedCitation } from '../book-components/Chat/utils/parseCitationsFromContent';
|
|
63
63
|
import type { MessageButton } from '../book-components/Chat/utils/parseMessageButtons';
|
|
64
64
|
import type { MarkdownInlineReference } from '../book-components/Chat/utils/renderMarkdown';
|
|
65
|
+
import type { MarkdownInlineReferenceIcon } from '../book-components/Chat/utils/renderMarkdown';
|
|
65
66
|
import type { MarkdownInlineReferenceMenuStatus } from '../book-components/Chat/utils/renderMarkdown';
|
|
66
67
|
import type { MarkdownInlineReferenceMenuOption } from '../book-components/Chat/utils/renderMarkdown';
|
|
68
|
+
import type { MarkdownInlineReferenceMenuAction } from '../book-components/Chat/utils/renderMarkdown';
|
|
67
69
|
import type { MarkdownInlineReferenceMenu } from '../book-components/Chat/utils/renderMarkdown';
|
|
68
70
|
import type { TeamToolResult } from '../book-components/Chat/utils/toolCallParsing/TeamToolResult';
|
|
69
71
|
import type { QrCodeOptions } from '../book-components/Qr/useQrCode';
|
|
@@ -511,8 +513,10 @@ export type { CitationLabelResolver };
|
|
|
511
513
|
export type { ParsedCitation };
|
|
512
514
|
export type { MessageButton };
|
|
513
515
|
export type { MarkdownInlineReference };
|
|
516
|
+
export type { MarkdownInlineReferenceIcon };
|
|
514
517
|
export type { MarkdownInlineReferenceMenuStatus };
|
|
515
518
|
export type { MarkdownInlineReferenceMenuOption };
|
|
519
|
+
export type { MarkdownInlineReferenceMenuAction };
|
|
516
520
|
export type { MarkdownInlineReferenceMenu };
|
|
517
521
|
export type { TeamToolResult };
|
|
518
522
|
export type { QrCodeOptions };
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
import type { AsciiArtColorDepth } from '../utils/ascii-art/convertImageDataToAsciiArt';
|
|
2
|
+
import type { ResolvedAvatarRenderDefinition } from './renderAvatarVisual';
|
|
3
|
+
import type { AvatarDefinition } from './types/AvatarDefinition';
|
|
4
|
+
import type { AvatarSurfaceStyle, AvatarVisualId, AvatarVisualTerminalTextGrid } from './types/AvatarVisualDefinition';
|
|
5
|
+
/**
|
|
6
|
+
* Options shared by the terminal-text avatar renderers.
|
|
7
|
+
*
|
|
8
|
+
* @private within the repository
|
|
9
|
+
*/
|
|
10
|
+
export type RenderAvatarVisualTerminalTextOptions = {
|
|
11
|
+
/**
|
|
12
|
+
* Stable visual identity of the rendered agent avatar.
|
|
13
|
+
*/
|
|
14
|
+
readonly avatarDefinition: AvatarDefinition;
|
|
15
|
+
/**
|
|
16
|
+
* Built-in avatar visual to render, the same one used on the website.
|
|
17
|
+
*/
|
|
18
|
+
readonly visualId: AvatarVisualId;
|
|
19
|
+
/**
|
|
20
|
+
* Surface used to derive the avatar palette.
|
|
21
|
+
*
|
|
22
|
+
* @default 'framed'
|
|
23
|
+
*/
|
|
24
|
+
readonly surface?: AvatarSurfaceStyle;
|
|
25
|
+
/**
|
|
26
|
+
* Output width in terminal character cells.
|
|
27
|
+
*/
|
|
28
|
+
readonly columns: number;
|
|
29
|
+
/**
|
|
30
|
+
* Output height in terminal character cells.
|
|
31
|
+
*/
|
|
32
|
+
readonly rows: number;
|
|
33
|
+
/**
|
|
34
|
+
* Animation timestamp for animated visuals.
|
|
35
|
+
*/
|
|
36
|
+
readonly timeMs: number;
|
|
37
|
+
/**
|
|
38
|
+
* Optional stable render data reused across frames.
|
|
39
|
+
*/
|
|
40
|
+
readonly resolvedAvatarRenderDefinition?: ResolvedAvatarRenderDefinition;
|
|
41
|
+
};
|
|
42
|
+
/**
|
|
43
|
+
* Options for `renderAvatarVisualTerminalTextLines`.
|
|
44
|
+
*
|
|
45
|
+
* @private within the repository
|
|
46
|
+
*/
|
|
47
|
+
export type RenderAvatarVisualTerminalTextLinesOptions = RenderAvatarVisualTerminalTextOptions & {
|
|
48
|
+
/**
|
|
49
|
+
* Color depth of the emitted ANSI escape codes.
|
|
50
|
+
*
|
|
51
|
+
* @default 'TRUE_COLOR'
|
|
52
|
+
*/
|
|
53
|
+
readonly colorDepth?: AsciiArtColorDepth;
|
|
54
|
+
};
|
|
55
|
+
/**
|
|
56
|
+
* Renders one frame of a character-based avatar visual straight into terminal character cells.
|
|
57
|
+
*
|
|
58
|
+
* Visuals which are themselves made of characters, for example `AsciiOctopus`, lose their identity
|
|
59
|
+
* when they are rasterized onto a canvas and converted back into half-block ASCII art - every glyph
|
|
60
|
+
* is averaged away into a colored blob. Such visuals expose `renderTerminalText`, which paints the
|
|
61
|
+
* terminal grid directly and is used instead of the raster pipeline.
|
|
62
|
+
*
|
|
63
|
+
* The square avatar is centered inside the requested grid the same way `renderAvatarVisualAsciiArt`
|
|
64
|
+
* centers the avatar canvas inside a wider terminal frame.
|
|
65
|
+
*
|
|
66
|
+
* @param options Avatar identity, visual selection, and output grid size.
|
|
67
|
+
* @returns Grid of `rows` rows of `columns` cells, or `null` when the visual has no terminal renderer.
|
|
68
|
+
*
|
|
69
|
+
* @private within the repository
|
|
70
|
+
*/
|
|
71
|
+
export declare function renderAvatarVisualTerminalTextGrid(options: RenderAvatarVisualTerminalTextOptions): AvatarVisualTerminalTextGrid | null;
|
|
72
|
+
/**
|
|
73
|
+
* Renders one frame of a character-based avatar visual into ANSI-colored terminal lines.
|
|
74
|
+
*
|
|
75
|
+
* @param options Avatar identity, visual selection, output grid size, and ANSI color depth.
|
|
76
|
+
* @returns One ANSI-colored string per output row, or `null` when the visual has no terminal renderer.
|
|
77
|
+
*
|
|
78
|
+
* @private within the repository
|
|
79
|
+
*/
|
|
80
|
+
export declare function renderAvatarVisualTerminalTextLines(options: RenderAvatarVisualTerminalTextLinesOptions): ReadonlyArray<string> | null;
|
|
@@ -72,6 +72,52 @@ export type AvatarVisualRenderContext = {
|
|
|
72
72
|
* @private shared contract for the avatar rendering system
|
|
73
73
|
*/
|
|
74
74
|
export type AvatarVisual = (context: AvatarVisualRenderContext) => void;
|
|
75
|
+
/**
|
|
76
|
+
* One painted character cell of a terminal-text avatar frame.
|
|
77
|
+
*
|
|
78
|
+
* @private shared contract for the avatar rendering system
|
|
79
|
+
*/
|
|
80
|
+
export type AvatarVisualTerminalTextCell = {
|
|
81
|
+
/**
|
|
82
|
+
* Single character painted in the cell.
|
|
83
|
+
*/
|
|
84
|
+
readonly character: string;
|
|
85
|
+
/**
|
|
86
|
+
* Color of the character as a CSS color string, optionally with an alpha channel.
|
|
87
|
+
*/
|
|
88
|
+
readonly color: string_color;
|
|
89
|
+
};
|
|
90
|
+
/**
|
|
91
|
+
* One rendered terminal-text avatar frame as a grid of character cells.
|
|
92
|
+
*
|
|
93
|
+
* Rows are ordered top to bottom, cells left to right, and `null` leaves the terminal background visible.
|
|
94
|
+
*
|
|
95
|
+
* @private shared contract for the avatar rendering system
|
|
96
|
+
*/
|
|
97
|
+
export type AvatarVisualTerminalTextGrid = ReadonlyArray<ReadonlyArray<AvatarVisualTerminalTextCell | null>>;
|
|
98
|
+
/**
|
|
99
|
+
* Rendering context forwarded to a terminal-text avatar visual.
|
|
100
|
+
*
|
|
101
|
+
* Unlike `AvatarVisualRenderContext` this carries no canvas, because the visual paints
|
|
102
|
+
* character cells of a fixed terminal grid instead of pixels.
|
|
103
|
+
*
|
|
104
|
+
* @private shared contract for the avatar rendering system
|
|
105
|
+
*/
|
|
106
|
+
export type AvatarVisualTerminalTextRenderContext = {
|
|
107
|
+
readonly columns: number;
|
|
108
|
+
readonly rows: number;
|
|
109
|
+
readonly timeMs: number;
|
|
110
|
+
readonly avatarDefinition: AvatarDefinition;
|
|
111
|
+
readonly palette: AvatarPalette;
|
|
112
|
+
readonly createRandom: (salt: string) => () => number;
|
|
113
|
+
readonly interaction: AvatarInteractionState;
|
|
114
|
+
};
|
|
115
|
+
/**
|
|
116
|
+
* Signature of one terminal-text avatar visual renderer.
|
|
117
|
+
*
|
|
118
|
+
* @private shared contract for the avatar rendering system
|
|
119
|
+
*/
|
|
120
|
+
export type AvatarVisualTerminalText = (context: AvatarVisualTerminalTextRenderContext) => AvatarVisualTerminalTextGrid;
|
|
75
121
|
/**
|
|
76
122
|
* Metadata and renderer for one built-in avatar visual.
|
|
77
123
|
*
|
|
@@ -84,6 +130,14 @@ export type AvatarVisualDefinition = {
|
|
|
84
130
|
readonly isAnimated: boolean;
|
|
85
131
|
readonly supportsPointerTracking?: boolean;
|
|
86
132
|
readonly render: AvatarVisual;
|
|
133
|
+
/**
|
|
134
|
+
* Optional native terminal renderer of visuals which are themselves made of characters.
|
|
135
|
+
*
|
|
136
|
+
* Character-based visuals lose their identity when they are rasterized onto a canvas and
|
|
137
|
+
* converted back into half-block ASCII art, so they paint the terminal character grid directly.
|
|
138
|
+
* Visuals without this renderer are rasterized through `renderAvatarVisualAsciiArt` instead.
|
|
139
|
+
*/
|
|
140
|
+
readonly renderTerminalText?: AvatarVisualTerminalText;
|
|
87
141
|
};
|
|
88
142
|
/**
|
|
89
143
|
* Props of the shared `<Avatar/>` component.
|
|
@@ -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
|
|
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: '
|
|
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
|
|
125
|
+
* This is parsed from commitments like USE CALENDAR, USE PROJECT, KNOWLEDGE, etc.
|
|
126
126
|
*/
|
|
127
127
|
capabilities: Array<AgentCapability>;
|
|
128
128
|
/**
|
|
@@ -86,9 +86,7 @@ export type BookLanguageManualDictionary = {
|
|
|
86
86
|
readonly metadataLabels: {
|
|
87
87
|
readonly bookLanguageVersion: string;
|
|
88
88
|
readonly generatedAt: string;
|
|
89
|
-
readonly
|
|
90
|
-
readonly implementedCommitments: string;
|
|
91
|
-
readonly placeholderCommitments: string;
|
|
89
|
+
readonly commitmentCount: string;
|
|
92
90
|
};
|
|
93
91
|
/**
|
|
94
92
|
* Heading of the table of contents.
|
|
@@ -128,7 +126,6 @@ export type BookLanguageManualDictionary = {
|
|
|
128
126
|
readonly primitivesSections: {
|
|
129
127
|
readonly coreSyntax: BookLanguageManualChapter;
|
|
130
128
|
readonly references: BookLanguageManualChapter;
|
|
131
|
-
readonly keywordsTitle: string;
|
|
132
129
|
};
|
|
133
130
|
/**
|
|
134
131
|
* Suffixes distinguishing a server-specific catalog from the portable one.
|
|
@@ -141,18 +138,7 @@ export type BookLanguageManualDictionary = {
|
|
|
141
138
|
* Labels used in every commitment catalog entry.
|
|
142
139
|
*/
|
|
143
140
|
readonly commitmentLabels: {
|
|
144
|
-
readonly status: string;
|
|
145
141
|
readonly aliases: string;
|
|
146
|
-
readonly semantics: string;
|
|
147
|
-
readonly typeSchema: string;
|
|
148
|
-
readonly blockSchema: string;
|
|
149
|
-
readonly lowLevelNotice: string;
|
|
150
|
-
readonly usage: string;
|
|
151
|
-
readonly usageOccurrence: string;
|
|
152
|
-
readonly usageOccurrences: string;
|
|
153
|
-
readonly statusImplemented: string;
|
|
154
|
-
readonly statusPlaceholder: string;
|
|
155
|
-
readonly noAliases: string;
|
|
156
142
|
};
|
|
157
143
|
/**
|
|
158
144
|
* Labels used by end-to-end example sections.
|
package/esm/src/book-2.0/book-language-documentation/getBookLanguageManualCommitmentGroups.d.ts
CHANGED
|
@@ -16,7 +16,7 @@ export type BookLanguageManualCommitmentGroups = {
|
|
|
16
16
|
*/
|
|
17
17
|
readonly documented: ReadonlyArray<BookLanguageManualCommitmentGroup>;
|
|
18
18
|
/**
|
|
19
|
-
* Low-level
|
|
19
|
+
* Low-level commitments documented in their own closing chapter.
|
|
20
20
|
*/
|
|
21
21
|
readonly lowLevel: ReadonlyArray<BookLanguageManualCommitmentGroup>;
|
|
22
22
|
};
|
|
@@ -10,10 +10,6 @@ export type RenderCommitmentCatalogSectionOptions = {
|
|
|
10
10
|
* Grouped commitment definition with aliases.
|
|
11
11
|
*/
|
|
12
12
|
readonly groupedCommitment: BookLanguageManualCommitmentGroup;
|
|
13
|
-
/**
|
|
14
|
-
* Number of uses across the selected server agents.
|
|
15
|
-
*/
|
|
16
|
-
readonly usageCount: number;
|
|
17
13
|
/**
|
|
18
14
|
* Translated labels of the manual.
|
|
19
15
|
*/
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Relative directory for an active TEAM conversation workspace.
|
|
3
|
+
*
|
|
4
|
+
* @private internal convention shared by the Agents Server and agent-folder runner
|
|
5
|
+
*/
|
|
6
|
+
export declare const AGENT_TEAM_CONVERSATIONS_DIRECTORY_PATH: string;
|
|
7
|
+
/**
|
|
8
|
+
* Relative directory where completed TEAM conversation transcripts are retained.
|
|
9
|
+
*
|
|
10
|
+
* @private internal convention shared by the Agents Server and agent-folder runner
|
|
11
|
+
*/
|
|
12
|
+
export declare const AGENT_FINISHED_TEAM_CONVERSATIONS_DIRECTORY_PATH: string;
|
|
13
|
+
/**
|
|
14
|
+
* Name of the JSON manifest that describes one TEAM conversation workspace.
|
|
15
|
+
*
|
|
16
|
+
* @private internal convention shared by the Agents Server and agent-folder runner
|
|
17
|
+
*/
|
|
18
|
+
export declare const AGENT_TEAM_CONVERSATION_MANIFEST_FILE_NAME = "team.json";
|
|
19
|
+
/**
|
|
20
|
+
* Name of the read-only teammate-source directory inside one TEAM workspace.
|
|
21
|
+
*
|
|
22
|
+
* @private internal convention shared by the Agents Server and agent-folder runner
|
|
23
|
+
*/
|
|
24
|
+
export declare const AGENT_TEAMMATE_SOURCES_DIRECTORY_NAME = "teammates";
|
|
25
|
+
/**
|
|
26
|
+
* One primary agent represented in a TEAM workspace manifest.
|
|
27
|
+
*
|
|
28
|
+
* @private internal convention shared by the Agents Server and agent-folder runner
|
|
29
|
+
*/
|
|
30
|
+
export type AgentTeamConversationPrimaryAgent = {
|
|
31
|
+
readonly permanentId: string;
|
|
32
|
+
readonly agentName: string;
|
|
33
|
+
};
|
|
34
|
+
/**
|
|
35
|
+
* One local teammate made available to the coding harness for a single user turn.
|
|
36
|
+
*
|
|
37
|
+
* @private internal convention shared by the Agents Server and agent-folder runner
|
|
38
|
+
*/
|
|
39
|
+
export type AgentTeamConversationTeammate = {
|
|
40
|
+
readonly permanentId: string;
|
|
41
|
+
readonly agentName: string;
|
|
42
|
+
readonly url: string;
|
|
43
|
+
readonly instructions: string;
|
|
44
|
+
readonly sourceFileName: string;
|
|
45
|
+
};
|
|
46
|
+
/**
|
|
47
|
+
* Persisted roster snapshot for the optional TEAM workspace of one queued message.
|
|
48
|
+
*
|
|
49
|
+
* @private internal convention shared by the Agents Server and agent-folder runner
|
|
50
|
+
*/
|
|
51
|
+
export type AgentTeamConversationWorkspaceManifest = {
|
|
52
|
+
readonly version: 1;
|
|
53
|
+
readonly primaryAgent: AgentTeamConversationPrimaryAgent;
|
|
54
|
+
readonly teammates: ReadonlyArray<AgentTeamConversationTeammate>;
|
|
55
|
+
};
|
|
56
|
+
/**
|
|
57
|
+
* Creates the stable directory name that belongs to one queued `.book` message.
|
|
58
|
+
*
|
|
59
|
+
* @private internal convention shared by the Agents Server and agent-folder runner
|
|
60
|
+
*/
|
|
61
|
+
export declare function createAgentTeamConversationWorkspaceDirectoryName(messageFileName: string): string;
|
|
62
|
+
/**
|
|
63
|
+
* Creates the relative active workspace path for one queued message.
|
|
64
|
+
*
|
|
65
|
+
* @private internal convention shared by the Agents Server and agent-folder runner
|
|
66
|
+
*/
|
|
67
|
+
export declare function createAgentTeamConversationWorkspacePath(messageFileName: string): string;
|
|
68
|
+
/**
|
|
69
|
+
* Creates the relative completed-workspace path for one queued message.
|
|
70
|
+
*
|
|
71
|
+
* @private internal convention shared by the Agents Server and agent-folder runner
|
|
72
|
+
*/
|
|
73
|
+
export declare function createFinishedAgentTeamConversationWorkspacePath(messageFileName: string): string;
|
|
74
|
+
/**
|
|
75
|
+
* Creates the source-snapshot file name for one teammate.
|
|
76
|
+
*
|
|
77
|
+
* @private internal convention shared by the Agents Server and agent-folder runner
|
|
78
|
+
*/
|
|
79
|
+
export declare function createAgentTeamTeammateSourceFileName(teammatePermanentId: string): string;
|
|
80
|
+
/**
|
|
81
|
+
* Checks whether unknown JSON has the minimum shape required for a TEAM workspace manifest.
|
|
82
|
+
*
|
|
83
|
+
* @private internal convention shared by the Agents Server and agent-folder runner
|
|
84
|
+
*/
|
|
85
|
+
export declare function isAgentTeamConversationWorkspaceManifest(value: unknown): value is AgentTeamConversationWorkspaceManifest;
|
|
@@ -591,8 +591,9 @@ export type ChatProps = {
|
|
|
591
591
|
progress?: number;
|
|
592
592
|
}>;
|
|
593
593
|
/**
|
|
594
|
-
*
|
|
595
|
-
*
|
|
594
|
+
* Optional content displayed in the chat header above the message list.
|
|
595
|
+
*
|
|
596
|
+
* If not provided, the header row is not rendered.
|
|
596
597
|
*/
|
|
597
598
|
readonly children?: ReactNode;
|
|
598
599
|
/**
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type { WindowLike as DomWindowLike } from 'dompurify';
|
|
2
|
+
/**
|
|
3
|
+
* Provides a DOM `window` for runtimes which do not have one, for example Node.js during server-side rendering
|
|
4
|
+
*
|
|
5
|
+
* Note: `$` is used to indicate that this function is not a pure function - it creates and caches one shared DOM window
|
|
6
|
+
*
|
|
7
|
+
* @returns DOM window which can back a DOM-dependent library like `DOMPurify`
|
|
8
|
+
* @throws {EnvironmentMismatchError} When the current runtime can not create a DOM window
|
|
9
|
+
* @private utility of `renderMarkdown`
|
|
10
|
+
*/
|
|
11
|
+
export declare function $provideServerDomWindow(): DomWindowLike;
|
|
@@ -1,4 +1,22 @@
|
|
|
1
1
|
import type { string_html, string_markdown } from '../../../types/string_markdown';
|
|
2
|
+
/**
|
|
3
|
+
* Attribute marking a client action generated for an inline-reference menu.
|
|
4
|
+
*
|
|
5
|
+
* @private utility shared with `MarkdownContent`
|
|
6
|
+
*/
|
|
7
|
+
export declare const MARKDOWN_INLINE_REFERENCE_MENU_ACTION_ATTRIBUTE = "data-promptbook-inline-reference-menu-action";
|
|
8
|
+
/**
|
|
9
|
+
* Attribute identifying the inline reference which owns a client menu action.
|
|
10
|
+
*
|
|
11
|
+
* @private utility shared with `MarkdownContent`
|
|
12
|
+
*/
|
|
13
|
+
export declare const MARKDOWN_INLINE_REFERENCE_MENU_ACTION_REFERENCE_ATTRIBUTE = "data-promptbook-inline-reference-menu-action-reference";
|
|
14
|
+
/**
|
|
15
|
+
* Attribute marking a favicon rendered inside an inline-reference chip.
|
|
16
|
+
*
|
|
17
|
+
* @private utility shared with `MarkdownContent`
|
|
18
|
+
*/
|
|
19
|
+
export declare const MARKDOWN_INLINE_REFERENCE_ICON_ATTRIBUTE = "data-promptbook-inline-reference-icon";
|
|
2
20
|
/**
|
|
3
21
|
* Options for markdown rendering.
|
|
4
22
|
*/
|
|
@@ -17,6 +35,13 @@ export type MarkdownInlineReference = {
|
|
|
17
35
|
* Raw reference text between `[[` and `]]`.
|
|
18
36
|
*/
|
|
19
37
|
readonly reference: string;
|
|
38
|
+
/**
|
|
39
|
+
* Optional text aliases which should render as this reference when an agent mentions them in markdown.
|
|
40
|
+
*
|
|
41
|
+
* They are also accepted inside a `[[reference]]` token. This lets application code use a stable
|
|
42
|
+
* technical reference while recognizing a human-facing name in older messages.
|
|
43
|
+
*/
|
|
44
|
+
readonly sourceTextAliases?: ReadonlyArray<string>;
|
|
20
45
|
/**
|
|
21
46
|
* Human-readable label rendered inside the link chip.
|
|
22
47
|
*/
|
|
@@ -25,15 +50,43 @@ export type MarkdownInlineReference = {
|
|
|
25
50
|
* Link target for the rendered reference.
|
|
26
51
|
*/
|
|
27
52
|
readonly href: string;
|
|
53
|
+
/**
|
|
54
|
+
* Optional URL prefixes which also identify this reference in the authored markdown.
|
|
55
|
+
*
|
|
56
|
+
* A markdown link or a bare URL pointing to one of these prefixes is rendered as the same chip
|
|
57
|
+
* as the `[[reference]]` token. Both absolute URLs (for example `https://project.example.com`)
|
|
58
|
+
* and application paths (for example `/agents/agent/projects/website`) are supported; a path
|
|
59
|
+
* prefix matches on any host so that both relative and absolute links are recognized.
|
|
60
|
+
*/
|
|
61
|
+
readonly sourceHrefPrefixes?: ReadonlyArray<string>;
|
|
28
62
|
/**
|
|
29
63
|
* Optional hover title for the rendered reference.
|
|
30
64
|
*/
|
|
31
65
|
readonly title?: string;
|
|
66
|
+
/**
|
|
67
|
+
* Optional favicon and text fallback rendered before the reference label.
|
|
68
|
+
*/
|
|
69
|
+
readonly icon?: MarkdownInlineReferenceIcon;
|
|
32
70
|
/**
|
|
33
71
|
* Optional expandable menu shown when the reference chip is clicked.
|
|
34
72
|
*/
|
|
35
73
|
readonly menu?: MarkdownInlineReferenceMenu;
|
|
36
74
|
};
|
|
75
|
+
/**
|
|
76
|
+
* Visual identity rendered inside one markdown inline-reference chip.
|
|
77
|
+
*
|
|
78
|
+
* @public exported from `@promptbook/components`
|
|
79
|
+
*/
|
|
80
|
+
export type MarkdownInlineReferenceIcon = {
|
|
81
|
+
/**
|
|
82
|
+
* Optional image URL. The fallback remains visible when the image is unavailable.
|
|
83
|
+
*/
|
|
84
|
+
readonly src?: string | null;
|
|
85
|
+
/**
|
|
86
|
+
* Short text rendered when the image is missing or broken.
|
|
87
|
+
*/
|
|
88
|
+
readonly fallbackText: string;
|
|
89
|
+
};
|
|
37
90
|
/**
|
|
38
91
|
* Status displayed alongside an expandable markdown inline reference.
|
|
39
92
|
*
|
|
@@ -67,6 +120,25 @@ export type MarkdownInlineReferenceMenuOption = {
|
|
|
67
120
|
* Optional hover text for the option.
|
|
68
121
|
*/
|
|
69
122
|
readonly title?: string;
|
|
123
|
+
/**
|
|
124
|
+
* Optional client action rendered as a button instead of a link.
|
|
125
|
+
*/
|
|
126
|
+
readonly action?: MarkdownInlineReferenceMenuAction;
|
|
127
|
+
};
|
|
128
|
+
/**
|
|
129
|
+
* Client-side action exposed by an expandable markdown inline-reference menu.
|
|
130
|
+
*
|
|
131
|
+
* @public exported from `@promptbook/components`
|
|
132
|
+
*/
|
|
133
|
+
export type MarkdownInlineReferenceMenuAction = {
|
|
134
|
+
/**
|
|
135
|
+
* Stable identifier unique within the owning reference menu.
|
|
136
|
+
*/
|
|
137
|
+
readonly id: string;
|
|
138
|
+
/**
|
|
139
|
+
* Callback invoked when the menu button is selected.
|
|
140
|
+
*/
|
|
141
|
+
readonly onSelect: () => void | Promise<void>;
|
|
70
142
|
};
|
|
71
143
|
/**
|
|
72
144
|
* Expandable menu configuration for a markdown inline reference.
|
|
@@ -18,6 +18,12 @@ export declare const PTBK_AGENTS_SERVER_BUILD_WORKER_COUNT_ENV = "PTBK_AGENTS_SE
|
|
|
18
18
|
* @private internal constant of `buildAgentsServer`
|
|
19
19
|
*/
|
|
20
20
|
export declare const PTBK_AGENTS_SERVER_IGNORE_NEXT_VALIDATION_ENV = "PTBK_AGENTS_SERVER_IGNORE_NEXT_VALIDATION";
|
|
21
|
+
/**
|
|
22
|
+
* Environment variable that disables throwaway webpack filesystem caches for CLI-owned production builds.
|
|
23
|
+
*
|
|
24
|
+
* @private internal constant of `buildAgentsServer`
|
|
25
|
+
*/
|
|
26
|
+
export declare const PTBK_AGENTS_SERVER_DISABLE_WEBPACK_FILESYSTEM_CACHE_ENV = "PTBK_AGENTS_SERVER_DISABLE_WEBPACK_FILESYSTEM_CACHE";
|
|
21
27
|
/**
|
|
22
28
|
* Adds dependency-resolution environment required by the materialized Agents Server runtime.
|
|
23
29
|
*
|
|
@@ -25,4 +31,5 @@ export declare const PTBK_AGENTS_SERVER_IGNORE_NEXT_VALIDATION_ENV = "PTBK_AGENT
|
|
|
25
31
|
*/
|
|
26
32
|
export declare function createAgentsServerRuntimeEnvironment(environment: NodeJS.ProcessEnv, nodeModulesPath: string, options?: {
|
|
27
33
|
readonly isNextValidationIgnored?: boolean;
|
|
34
|
+
readonly isWebpackFilesystemCacheDisabled?: boolean;
|
|
28
35
|
}): NodeJS.ProcessEnv;
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { string_markdown } from '../../../types/typeAliases';
|
|
1
2
|
/**
|
|
2
3
|
* Relative path to the Promptbook Coder quick-reference file initialized in project roots.
|
|
3
4
|
*
|
|
@@ -9,6 +10,4 @@ export declare const AGENT_CODING_FILE_PATH = "AGENT_CODING.md";
|
|
|
9
10
|
*
|
|
10
11
|
* @private internal utility of `ptbk coder`
|
|
11
12
|
*/
|
|
12
|
-
export declare function getDefaultCoderAgentCodingFileContent(
|
|
13
|
-
readonly packageJsonScripts: Readonly<Record<string, string>>;
|
|
14
|
-
}): string;
|
|
13
|
+
export declare function getDefaultCoderAgentCodingFileContent(): string_markdown;
|