@promptbook/cli 0.103.0-10 → 0.103.0-100

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 (452) hide show
  1. package/README.md +59 -35
  2. package/apps/agents-server/README.md +3 -0
  3. package/apps/agents-server/TODO.txt +7 -0
  4. package/apps/agents-server/config.ts +128 -0
  5. package/apps/agents-server/next.config.ts +45 -0
  6. package/apps/agents-server/package-lock.json +1163 -0
  7. package/apps/agents-server/package.json +18 -0
  8. package/apps/agents-server/postcss.config.mjs +8 -0
  9. package/apps/agents-server/public/.gitkeep +0 -0
  10. package/apps/agents-server/public/favicon.ico +0 -0
  11. package/apps/agents-server/public/fonts/OpenMoji-black-glyf.woff2 +0 -0
  12. package/apps/agents-server/public/fonts/download-font.js +22 -0
  13. package/apps/agents-server/public/logo-blue-white-256.png +0 -0
  14. package/apps/agents-server/public/sw.js +16 -0
  15. package/apps/agents-server/src/app/AddAgentButton.tsx +41 -0
  16. package/apps/agents-server/src/app/[agentName]/[...rest]/page.tsx +11 -0
  17. package/apps/agents-server/src/app/[agentName]/page.tsx +1 -0
  18. package/apps/agents-server/src/app/actions.ts +51 -0
  19. package/apps/agents-server/src/app/admin/api-tokens/ApiTokensClient.tsx +186 -0
  20. package/apps/agents-server/src/app/admin/api-tokens/page.tsx +13 -0
  21. package/apps/agents-server/src/app/admin/chat-feedback/ChatFeedbackClient.tsx +614 -0
  22. package/apps/agents-server/src/app/admin/chat-feedback/page.tsx +22 -0
  23. package/apps/agents-server/src/app/admin/chat-history/ChatHistoryClient.tsx +634 -0
  24. package/apps/agents-server/src/app/admin/chat-history/page.tsx +21 -0
  25. package/apps/agents-server/src/app/admin/metadata/MetadataClient.tsx +477 -0
  26. package/apps/agents-server/src/app/admin/metadata/page.tsx +13 -0
  27. package/apps/agents-server/src/app/admin/models/page.tsx +22 -0
  28. package/apps/agents-server/src/app/admin/users/[userId]/UserDetailClient.tsx +131 -0
  29. package/apps/agents-server/src/app/admin/users/[userId]/page.tsx +21 -0
  30. package/apps/agents-server/src/app/admin/users/page.tsx +18 -0
  31. package/apps/agents-server/src/app/agents/[agentName]/AgentChatWrapper.tsx +78 -0
  32. package/apps/agents-server/src/app/agents/[agentName]/AgentOptionsMenu.tsx +216 -0
  33. package/apps/agents-server/src/app/agents/[agentName]/AgentProfileChat.tsx +78 -0
  34. package/apps/agents-server/src/app/agents/[agentName]/AgentProfileView.tsx +233 -0
  35. package/apps/agents-server/src/app/agents/[agentName]/AgentQrCode.tsx +55 -0
  36. package/apps/agents-server/src/app/agents/[agentName]/AgentUrlCopy.tsx +40 -0
  37. package/apps/agents-server/src/app/agents/[agentName]/ClearAgentChatFeedbackButton.tsx +63 -0
  38. package/apps/agents-server/src/app/agents/[agentName]/ClearAgentChatHistoryButton.tsx +63 -0
  39. package/apps/agents-server/src/app/agents/[agentName]/CloneAgentButton.tsx +41 -0
  40. package/apps/agents-server/src/app/agents/[agentName]/CopyField.tsx +44 -0
  41. package/apps/agents-server/src/app/agents/[agentName]/InstallPwaButton.tsx +74 -0
  42. package/apps/agents-server/src/app/agents/[agentName]/QrCodeModal.tsx +90 -0
  43. package/apps/agents-server/src/app/agents/[agentName]/ServiceWorkerRegister.tsx +24 -0
  44. package/apps/agents-server/src/app/agents/[agentName]/TODO.txt +1 -0
  45. package/apps/agents-server/src/app/agents/[agentName]/_utils.ts +19 -0
  46. package/apps/agents-server/src/app/agents/[agentName]/agentLinks.tsx +80 -0
  47. package/apps/agents-server/src/app/agents/[agentName]/api/agents/route.ts +67 -0
  48. package/apps/agents-server/src/app/agents/[agentName]/api/book/route.ts +88 -0
  49. package/apps/agents-server/src/app/agents/[agentName]/api/book/test.http +37 -0
  50. package/apps/agents-server/src/app/agents/[agentName]/api/chat/route.ts +174 -0
  51. package/apps/agents-server/src/app/agents/[agentName]/api/feedback/route.ts +54 -0
  52. package/apps/agents-server/src/app/agents/[agentName]/api/mcp/route.ts +203 -0
  53. package/apps/agents-server/src/app/agents/[agentName]/api/modelRequirements/TODO.txt +1 -0
  54. package/apps/agents-server/src/app/agents/[agentName]/api/modelRequirements/route.ts +55 -0
  55. package/apps/agents-server/src/app/agents/[agentName]/api/modelRequirements/systemMessage/route.ts +47 -0
  56. package/apps/agents-server/src/app/agents/[agentName]/api/openai/chat/completions/route.ts +10 -0
  57. package/apps/agents-server/src/app/agents/[agentName]/api/openai/models/route.ts +93 -0
  58. package/apps/agents-server/src/app/agents/[agentName]/api/openai/v1/chat/completions/route.ts +10 -0
  59. package/apps/agents-server/src/app/agents/[agentName]/api/openai/v1/models/route.ts +93 -0
  60. package/apps/agents-server/src/app/agents/[agentName]/api/openrouter/chat/completions/route.ts +10 -0
  61. package/apps/agents-server/src/app/agents/[agentName]/api/profile/route.ts +76 -0
  62. package/apps/agents-server/src/app/agents/[agentName]/api/voice/route.ts +181 -0
  63. package/apps/agents-server/src/app/agents/[agentName]/book/BookEditorWrapper.tsx +139 -0
  64. package/apps/agents-server/src/app/agents/[agentName]/book/page.tsx +35 -0
  65. package/apps/agents-server/src/app/agents/[agentName]/book+chat/AgentBookAndChat.tsx +75 -0
  66. package/apps/agents-server/src/app/agents/[agentName]/book+chat/AgentBookAndChatComponent.tsx.todo +160 -0
  67. package/apps/agents-server/src/app/agents/[agentName]/book+chat/page.tsx +32 -0
  68. package/apps/agents-server/src/app/agents/[agentName]/book+chat/page.tsx.todo +21 -0
  69. package/apps/agents-server/src/app/agents/[agentName]/chat/AgentChatWrapper.tsx +68 -0
  70. package/apps/agents-server/src/app/agents/[agentName]/chat/page.tsx +33 -0
  71. package/apps/agents-server/src/app/agents/[agentName]/generateAgentMetadata.ts +42 -0
  72. package/apps/agents-server/src/app/agents/[agentName]/history/RestoreVersionButton.tsx +46 -0
  73. package/apps/agents-server/src/app/agents/[agentName]/history/actions.ts +12 -0
  74. package/apps/agents-server/src/app/agents/[agentName]/history/page.tsx +62 -0
  75. package/apps/agents-server/src/app/agents/[agentName]/images/icon-256.png/route.tsx +80 -0
  76. package/apps/agents-server/src/app/agents/[agentName]/images/screenshot-fullhd.png/route.tsx +92 -0
  77. package/apps/agents-server/src/app/agents/[agentName]/images/screenshot-phone.png/route.tsx +92 -0
  78. package/apps/agents-server/src/app/agents/[agentName]/integration/SdkCodeTabs.tsx +31 -0
  79. package/apps/agents-server/src/app/agents/[agentName]/integration/page.tsx +302 -0
  80. package/apps/agents-server/src/app/agents/[agentName]/links/page.tsx +182 -0
  81. package/apps/agents-server/src/app/agents/[agentName]/opengraph-image.tsx +102 -0
  82. package/apps/agents-server/src/app/agents/[agentName]/page.tsx +159 -0
  83. package/apps/agents-server/src/app/agents/[agentName]/website-integration/page.tsx +61 -0
  84. package/apps/agents-server/src/app/agents/page.tsx +11 -0
  85. package/apps/agents-server/src/app/api/agents/[agentName]/clone/route.ts +47 -0
  86. package/apps/agents-server/src/app/api/agents/[agentName]/route.ts +19 -0
  87. package/apps/agents-server/src/app/api/agents/route.ts +43 -0
  88. package/apps/agents-server/src/app/api/api-tokens/route.ts +76 -0
  89. package/apps/agents-server/src/app/api/auth/change-password/route.ts +75 -0
  90. package/apps/agents-server/src/app/api/auth/login/route.ts +27 -0
  91. package/apps/agents-server/src/app/api/auth/logout/route.ts +7 -0
  92. package/apps/agents-server/src/app/api/chat/route.ts +32 -0
  93. package/apps/agents-server/src/app/api/chat-feedback/[id]/route.ts +38 -0
  94. package/apps/agents-server/src/app/api/chat-feedback/export/route.ts +55 -0
  95. package/apps/agents-server/src/app/api/chat-feedback/route.ts +157 -0
  96. package/apps/agents-server/src/app/api/chat-history/[id]/route.ts +37 -0
  97. package/apps/agents-server/src/app/api/chat-history/export/route.ts +55 -0
  98. package/apps/agents-server/src/app/api/chat-history/route.ts +147 -0
  99. package/apps/agents-server/src/app/api/chat-streaming/route.ts +48 -0
  100. package/apps/agents-server/src/app/api/embed.js/route.ts +93 -0
  101. package/apps/agents-server/src/app/api/federated-agents/route.ts +17 -0
  102. package/apps/agents-server/src/app/api/long-running-task/route.ts +7 -0
  103. package/apps/agents-server/src/app/api/long-streaming/route.ts +20 -0
  104. package/apps/agents-server/src/app/api/metadata/route.ts +116 -0
  105. package/apps/agents-server/src/app/api/openai/v1/chat/completions/route.ts +6 -0
  106. package/apps/agents-server/src/app/api/openai/v1/models/route.ts +65 -0
  107. package/apps/agents-server/src/app/api/upload/route.ts +83 -0
  108. package/apps/agents-server/src/app/api/users/[username]/route.ts +75 -0
  109. package/apps/agents-server/src/app/api/users/route.ts +71 -0
  110. package/apps/agents-server/src/app/docs/[docId]/page.tsx +43 -0
  111. package/apps/agents-server/src/app/docs/page.tsx +59 -0
  112. package/apps/agents-server/src/app/embed/page.tsx +24 -0
  113. package/apps/agents-server/src/app/globals.css +276 -0
  114. package/apps/agents-server/src/app/layout.tsx +124 -0
  115. package/apps/agents-server/src/app/manifest.ts +109 -0
  116. package/apps/agents-server/src/app/not-found.tsx +5 -0
  117. package/apps/agents-server/src/app/page.tsx +96 -0
  118. package/apps/agents-server/src/app/recycle-bin/RestoreAgentButton.tsx +40 -0
  119. package/apps/agents-server/src/app/recycle-bin/actions.ts +27 -0
  120. package/apps/agents-server/src/app/recycle-bin/page.tsx +58 -0
  121. package/apps/agents-server/src/app/restricted/page.tsx +33 -0
  122. package/apps/agents-server/src/app/test/og-image/README.md +1 -0
  123. package/apps/agents-server/src/app/test/og-image/opengraph-image.tsx +37 -0
  124. package/apps/agents-server/src/app/test/og-image/page.tsx +22 -0
  125. package/apps/agents-server/src/components/Auth/AuthControls.tsx +123 -0
  126. package/apps/agents-server/src/components/ChangePasswordDialog/ChangePasswordDialog.tsx +41 -0
  127. package/apps/agents-server/src/components/ChangePasswordForm/ChangePasswordForm.tsx +159 -0
  128. package/apps/agents-server/src/components/DocumentationContent/DocumentationContent.tsx +87 -0
  129. package/apps/agents-server/src/components/ErrorPage/ErrorPage.tsx +33 -0
  130. package/apps/agents-server/src/components/Footer/Footer.tsx +175 -0
  131. package/apps/agents-server/src/components/ForbiddenPage/ForbiddenPage.tsx +15 -0
  132. package/apps/agents-server/src/components/Header/Header.tsx +593 -0
  133. package/apps/agents-server/src/components/Homepage/AgentCard.tsx +60 -0
  134. package/apps/agents-server/src/components/Homepage/AgentsList.tsx +58 -0
  135. package/apps/agents-server/src/components/Homepage/Card.tsx +18 -0
  136. package/apps/agents-server/src/components/Homepage/ExternalAgentsSection.tsx +21 -0
  137. package/apps/agents-server/src/components/Homepage/ExternalAgentsSectionClient.tsx +183 -0
  138. package/apps/agents-server/src/components/Homepage/ModelCard.tsx +29 -0
  139. package/apps/agents-server/src/components/Homepage/ModelsSection.tsx +75 -0
  140. package/apps/agents-server/src/components/Homepage/Section.tsx +17 -0
  141. package/apps/agents-server/src/components/Homepage/TechInfoCard.tsx +20 -0
  142. package/apps/agents-server/src/components/LayoutWrapper/LayoutWrapper.tsx +53 -0
  143. package/apps/agents-server/src/components/LoginDialog/LoginDialog.tsx +41 -0
  144. package/apps/agents-server/src/components/LoginForm/LoginForm.tsx +109 -0
  145. package/apps/agents-server/src/components/NotFoundPage/NotFoundPage.tsx +17 -0
  146. package/apps/agents-server/src/components/OpenMojiIcon/OpenMojiIcon.tsx +20 -0
  147. package/apps/agents-server/src/components/Portal/Portal.tsx +38 -0
  148. package/apps/agents-server/src/components/PrintButton/PrintButton.tsx +18 -0
  149. package/apps/agents-server/src/components/PrintHeader/PrintHeader.tsx +18 -0
  150. package/apps/agents-server/src/components/UsersList/UsersList.tsx +141 -0
  151. package/apps/agents-server/src/components/UsersList/useUsersAdmin.ts +139 -0
  152. package/apps/agents-server/src/components/VercelDeploymentCard/VercelDeploymentCard.tsx +55 -0
  153. package/apps/agents-server/src/database/$getTableName.ts +18 -0
  154. package/apps/agents-server/src/database/$provideSupabase.ts +29 -0
  155. package/apps/agents-server/src/database/$provideSupabaseForBrowser.ts +41 -0
  156. package/apps/agents-server/src/database/$provideSupabaseForServer.ts +48 -0
  157. package/apps/agents-server/src/database/$provideSupabaseForWorker.ts +43 -0
  158. package/apps/agents-server/src/database/getMetadata.ts +31 -0
  159. package/apps/agents-server/src/database/metadataDefaults.ts +69 -0
  160. package/apps/agents-server/src/database/migrate.ts +131 -0
  161. package/apps/agents-server/src/database/migrations/2025-11-0001-initial-schema.sql +163 -0
  162. package/apps/agents-server/src/database/migrations/2025-11-0002-metadata-table.sql +16 -0
  163. package/apps/agents-server/src/database/migrations/2025-12-0010-llm-cache.sql +12 -0
  164. package/apps/agents-server/src/database/migrations/2025-12-0060-api-tokens.sql +13 -0
  165. package/apps/agents-server/src/database/migrations/2025-12-0070-chat-history-source.sql +2 -0
  166. package/apps/agents-server/src/database/schema.ts +308 -0
  167. package/apps/agents-server/src/deamons/longRunningTask.ts +37 -0
  168. package/apps/agents-server/src/middleware.ts +301 -0
  169. package/apps/agents-server/src/tools/$provideAgentCollectionForServer.ts +54 -0
  170. package/apps/agents-server/src/tools/$provideCdnForServer.ts +24 -0
  171. package/apps/agents-server/src/tools/$provideExecutionToolsForServer.ts +117 -0
  172. package/apps/agents-server/src/tools/$provideOpenAiAssistantExecutionToolsForServer.ts +35 -0
  173. package/apps/agents-server/src/tools/$provideServer.ts +39 -0
  174. package/apps/agents-server/src/utils/auth.ts +33 -0
  175. package/apps/agents-server/src/utils/authenticateUser.ts +42 -0
  176. package/apps/agents-server/src/utils/cache/SupabaseCacheStorage.ts +55 -0
  177. package/apps/agents-server/src/utils/cdn/classes/VercelBlobStorage.ts +63 -0
  178. package/apps/agents-server/src/utils/cdn/interfaces/IFilesStorage.ts +32 -0
  179. package/apps/agents-server/src/utils/cdn/interfaces/IStorage.ts +14 -0
  180. package/apps/agents-server/src/utils/cdn/utils/getUserFileCdnKey.ts +28 -0
  181. package/apps/agents-server/src/utils/cdn/utils/nameToSubfolderPath.ts +9 -0
  182. package/apps/agents-server/src/utils/cdn/utils/nextRequestToNodeRequest.ts +27 -0
  183. package/apps/agents-server/src/utils/chatFeedbackAdmin.ts +96 -0
  184. package/apps/agents-server/src/utils/chatHistoryAdmin.ts +96 -0
  185. package/apps/agents-server/src/utils/convertToCsv.ts +31 -0
  186. package/apps/agents-server/src/utils/getCurrentUser.ts +32 -0
  187. package/apps/agents-server/src/utils/getEffectiveFederatedServers.ts +22 -0
  188. package/apps/agents-server/src/utils/getFederatedAgents.ts +89 -0
  189. package/apps/agents-server/src/utils/getFederatedServersFromMetadata.ts +10 -0
  190. package/apps/agents-server/src/utils/getVisibleCommitmentDefinitions.ts +12 -0
  191. package/apps/agents-server/src/utils/handleChatCompletion.ts +355 -0
  192. package/apps/agents-server/src/utils/isIpAllowed.ts +101 -0
  193. package/apps/agents-server/src/utils/isUserAdmin.ts +31 -0
  194. package/apps/agents-server/src/utils/resolveInheritedAgentSource.ts +100 -0
  195. package/apps/agents-server/src/utils/session.ts +50 -0
  196. package/apps/agents-server/src/utils/validateApiKey.ts +128 -0
  197. package/apps/agents-server/src/utils/validators/validateMimeType.ts +24 -0
  198. package/apps/agents-server/tailwind.config.ts +26 -0
  199. package/apps/agents-server/tsconfig.json +29 -0
  200. package/apps/agents-server/vercel.json +7 -0
  201. package/esm/index.es.js +5114 -383
  202. package/esm/index.es.js.map +1 -1
  203. package/esm/typings/books/index.d.ts +0 -81
  204. package/esm/typings/servers.d.ts +9 -7
  205. package/esm/typings/src/_packages/browser.index.d.ts +6 -0
  206. package/esm/typings/src/_packages/cli.index.d.ts +4 -0
  207. package/esm/typings/src/_packages/components.index.d.ts +20 -8
  208. package/esm/typings/src/_packages/core.index.d.ts +58 -18
  209. package/esm/typings/src/_packages/node.index.d.ts +2 -2
  210. package/esm/typings/src/_packages/remote-server.index.d.ts +2 -0
  211. package/esm/typings/src/_packages/types.index.d.ts +58 -8
  212. package/esm/typings/src/_packages/utils.index.d.ts +6 -0
  213. package/esm/typings/src/_packages/wizard.index.d.ts +4 -0
  214. package/esm/typings/src/book-2.0/agent-source/AgentBasicInformation.d.ts +19 -5
  215. package/esm/typings/src/book-2.0/agent-source/AgentModelRequirements.d.ts +17 -1
  216. package/esm/typings/src/book-2.0/agent-source/AgentSourceParseResult.d.ts +3 -2
  217. package/esm/typings/src/book-2.0/agent-source/computeAgentHash.d.ts +8 -0
  218. package/esm/typings/src/book-2.0/agent-source/createCommitmentRegex.d.ts +3 -3
  219. package/esm/typings/src/book-2.0/agent-source/createDefaultAgentName.d.ts +8 -0
  220. package/esm/typings/src/book-2.0/agent-source/normalizeAgentName.d.ts +9 -0
  221. package/esm/typings/src/book-2.0/agent-source/padBook.d.ts +18 -0
  222. package/esm/typings/src/book-2.0/agent-source/parseAgentSourceWithCommitments.d.ts +1 -1
  223. package/esm/typings/src/book-2.0/agent-source/string_book.d.ts +3 -0
  224. package/esm/typings/src/book-components/AvatarProfile/AvatarProfile/AvatarProfile.d.ts +6 -1
  225. package/esm/typings/src/book-components/BookEditor/BookEditor.d.ts +77 -7
  226. package/esm/typings/src/book-components/BookEditor/BookEditorActionbar.d.ts +14 -0
  227. package/esm/typings/src/book-components/Chat/AgentChat/AgentChat.d.ts +14 -0
  228. package/esm/typings/src/book-components/Chat/AgentChat/AgentChatProps.d.ts +13 -0
  229. package/esm/typings/src/book-components/Chat/Chat/ChatProps.d.ts +10 -0
  230. package/esm/typings/src/book-components/Chat/LlmChat/LlmChatProps.d.ts +5 -0
  231. package/esm/typings/src/book-components/Chat/MarkdownContent/MarkdownContent.d.ts +15 -0
  232. package/esm/typings/src/book-components/Chat/MockedChat/MockedChat.d.ts +5 -0
  233. package/esm/typings/src/book-components/Chat/save/_common/ChatSaveFormatDefinition.d.ts +1 -1
  234. package/esm/typings/src/book-components/Chat/save/html/htmlSaveFormatDefinition.d.ts +1 -0
  235. package/esm/typings/src/book-components/Chat/save/pdf/pdfSaveFormatDefinition.d.ts +4 -0
  236. package/esm/typings/src/book-components/Chat/types/ChatParticipant.d.ts +1 -1
  237. package/esm/typings/src/book-components/PromptbookAgent/PromptbookAgent.d.ts +29 -0
  238. package/esm/typings/src/book-components/Qr/BrandedQrCode.d.ts +18 -0
  239. package/esm/typings/src/book-components/Qr/GenericQrCode.d.ts +10 -0
  240. package/esm/typings/src/book-components/Qr/PromptbookQrCode.d.ts +18 -0
  241. package/esm/typings/src/book-components/Qr/useQrCode.d.ts +15 -0
  242. package/esm/typings/src/book-components/_common/Dropdown/Dropdown.d.ts +15 -0
  243. package/esm/typings/src/book-components/_common/HamburgerMenu/HamburgerMenu.d.ts +12 -0
  244. package/esm/typings/src/book-components/_common/Modal/Modal.d.ts +2 -2
  245. package/esm/typings/src/book-components/_common/Tooltip/Tooltip.d.ts +47 -0
  246. package/esm/typings/src/book-components/icons/AboutIcon.d.ts +9 -0
  247. package/esm/typings/src/book-components/icons/CloseIcon.d.ts +4 -8
  248. package/esm/typings/src/book-components/icons/DownloadIcon.d.ts +9 -0
  249. package/esm/typings/src/book-components/icons/ExitFullscreenIcon.d.ts +7 -0
  250. package/esm/typings/src/book-components/icons/FullscreenIcon.d.ts +7 -0
  251. package/esm/typings/src/book-components/icons/MenuIcon.d.ts +12 -0
  252. package/esm/typings/src/book-components/icons/MicIcon.d.ts +8 -0
  253. package/esm/typings/src/cli/cli-commands/_boilerplate.d.ts +2 -1
  254. package/esm/typings/src/cli/cli-commands/about.d.ts +3 -1
  255. package/esm/typings/src/cli/cli-commands/hello.d.ts +2 -1
  256. package/esm/typings/src/cli/cli-commands/list-models.d.ts +2 -1
  257. package/esm/typings/src/cli/cli-commands/list-scrapers.d.ts +2 -1
  258. package/esm/typings/src/cli/cli-commands/login.d.ts +2 -1
  259. package/esm/typings/src/cli/cli-commands/make.d.ts +2 -1
  260. package/esm/typings/src/cli/cli-commands/prettify.d.ts +2 -1
  261. package/esm/typings/src/cli/cli-commands/run.d.ts +2 -1
  262. package/esm/typings/src/cli/cli-commands/{start-server.d.ts → start-agents-server.d.ts} +3 -2
  263. package/esm/typings/src/cli/cli-commands/start-pipelines-server.d.ts +15 -0
  264. package/esm/typings/src/cli/cli-commands/test-command.d.ts +2 -1
  265. package/esm/typings/src/cli/common/$addGlobalOptionsToCommand.d.ts +2 -1
  266. package/esm/typings/src/collection/agent-collection/AgentCollection.d.ts +12 -0
  267. package/esm/typings/src/collection/agent-collection/constructors/agent-collection-in-supabase/AgentCollectionInSupabase.d.ts +75 -0
  268. package/esm/typings/src/collection/agent-collection/constructors/agent-collection-in-supabase/AgentCollectionInSupabaseOptions.d.ts +10 -0
  269. package/esm/typings/src/collection/agent-collection/constructors/agent-collection-in-supabase/AgentsDatabaseSchema.d.ts +154 -0
  270. package/esm/typings/src/collection/{PipelineCollection.d.ts → pipeline-collection/PipelineCollection.d.ts} +7 -3
  271. package/esm/typings/src/collection/{SimplePipelineCollection.d.ts → pipeline-collection/SimplePipelineCollection.d.ts} +5 -5
  272. package/esm/typings/src/collection/{constructors/createCollectionFromDirectory.d.ts → pipeline-collection/constructors/createPipelineCollectionFromDirectory.d.ts} +8 -11
  273. package/esm/typings/src/collection/pipeline-collection/constructors/createPipelineCollectionFromJson.d.ts +13 -0
  274. package/esm/typings/src/collection/{constructors/createCollectionFromPromise.d.ts → pipeline-collection/constructors/createPipelineCollectionFromPromise.d.ts} +6 -5
  275. package/esm/typings/src/collection/pipeline-collection/constructors/createPipelineCollectionFromPromise.test.d.ts +1 -0
  276. package/esm/typings/src/collection/{constructors/createCollectionFromUrl.d.ts → pipeline-collection/constructors/createPipelineCollectionFromUrl.d.ts} +3 -3
  277. package/esm/typings/src/collection/{constructors/createSubcollection.d.ts → pipeline-collection/constructors/createPipelineSubcollection.d.ts} +3 -3
  278. package/esm/typings/src/collection/pipeline-collection/pipelineCollectionToJson.d.ts +13 -0
  279. package/esm/typings/src/commands/_common/types/CommandParser.d.ts +4 -5
  280. package/esm/typings/src/{book-2.0/commitments → commitments}/ACTION/ACTION.d.ts +5 -1
  281. package/esm/typings/src/commitments/CLOSED/CLOSED.d.ts +35 -0
  282. package/esm/typings/src/commitments/COMPONENT/COMPONENT.d.ts +28 -0
  283. package/esm/typings/src/{book-2.0/commitments → commitments}/DELETE/DELETE.d.ts +5 -1
  284. package/esm/typings/src/{book-2.0/commitments → commitments}/FORMAT/FORMAT.d.ts +5 -1
  285. package/esm/typings/src/commitments/FROM/FROM.d.ts +34 -0
  286. package/esm/typings/src/{book-2.0/commitments → commitments}/GOAL/GOAL.d.ts +5 -1
  287. package/esm/typings/src/{book-2.0/commitments → commitments}/KNOWLEDGE/KNOWLEDGE.d.ts +5 -5
  288. package/esm/typings/src/commitments/LANGUAGE/LANGUAGE.d.ts +35 -0
  289. package/esm/typings/src/{book-2.0/commitments → commitments}/MEMORY/MEMORY.d.ts +5 -1
  290. package/esm/typings/src/commitments/MESSAGE/AgentMessageCommitmentDefinition.d.ts +32 -0
  291. package/esm/typings/src/commitments/MESSAGE/InitialMessageCommitmentDefinition.d.ts +32 -0
  292. package/esm/typings/src/{book-2.0/commitments → commitments}/MESSAGE/MESSAGE.d.ts +5 -1
  293. package/esm/typings/src/commitments/MESSAGE/UserMessageCommitmentDefinition.d.ts +32 -0
  294. package/esm/typings/src/{book-2.0/commitments → commitments}/META/META.d.ts +5 -1
  295. package/esm/typings/src/commitments/META_COLOR/META_COLOR.d.ts +48 -0
  296. package/esm/typings/src/commitments/META_FONT/META_FONT.d.ts +42 -0
  297. package/esm/typings/src/{book-2.0/commitments → commitments}/META_IMAGE/META_IMAGE.d.ts +5 -1
  298. package/esm/typings/src/{book-2.0/commitments → commitments}/META_LINK/META_LINK.d.ts +5 -1
  299. package/esm/typings/src/{book-2.0/commitments → commitments}/MODEL/MODEL.d.ts +5 -1
  300. package/esm/typings/src/{book-2.0/commitments → commitments}/NOTE/NOTE.d.ts +5 -1
  301. package/esm/typings/src/commitments/OPEN/OPEN.d.ts +35 -0
  302. package/esm/typings/src/{book-2.0/commitments → commitments}/PERSONA/PERSONA.d.ts +5 -1
  303. package/esm/typings/src/{book-2.0/commitments → commitments}/RULE/RULE.d.ts +5 -1
  304. package/esm/typings/src/{book-2.0/commitments → commitments}/SAMPLE/SAMPLE.d.ts +5 -1
  305. package/esm/typings/src/{book-2.0/commitments → commitments}/SCENARIO/SCENARIO.d.ts +5 -1
  306. package/esm/typings/src/{book-2.0/commitments → commitments}/STYLE/STYLE.d.ts +5 -1
  307. package/esm/typings/src/commitments/USE/USE.d.ts +53 -0
  308. package/esm/typings/src/commitments/USE_BROWSER/USE_BROWSER.d.ts +38 -0
  309. package/esm/typings/src/commitments/USE_BROWSER/USE_BROWSER.test.d.ts +1 -0
  310. package/esm/typings/src/commitments/USE_MCP/USE_MCP.d.ts +37 -0
  311. package/esm/typings/src/commitments/USE_SEARCH_ENGINE/USE_SEARCH_ENGINE.d.ts +38 -0
  312. package/esm/typings/src/{book-2.0/commitments → commitments}/_base/BaseCommitmentDefinition.d.ts +8 -2
  313. package/esm/typings/src/{book-2.0/commitments → commitments}/_base/CommitmentDefinition.d.ts +6 -1
  314. package/esm/typings/src/{book-2.0/commitments → commitments}/_base/NotYetImplementedCommitmentDefinition.d.ts +5 -1
  315. package/esm/typings/src/{book-2.0/commitments → commitments}/_base/createEmptyAgentModelRequirements.d.ts +1 -1
  316. package/esm/typings/src/commitments/index.d.ts +93 -0
  317. package/esm/typings/src/config.d.ts +24 -3
  318. package/esm/typings/src/conversion/validation/validatePipeline.d.ts +2 -0
  319. package/esm/typings/src/errors/0-index.d.ts +6 -0
  320. package/esm/typings/src/errors/DatabaseError.d.ts +12 -0
  321. package/esm/typings/src/errors/NotAllowed.d.ts +9 -0
  322. package/esm/typings/src/errors/WrappedError.d.ts +2 -2
  323. package/esm/typings/src/execution/AvailableModel.d.ts +1 -0
  324. package/esm/typings/src/execution/Executables.d.ts +3 -0
  325. package/esm/typings/src/execution/ExecutionTask.d.ts +12 -3
  326. package/esm/typings/src/execution/ExecutionTools.d.ts +5 -0
  327. package/esm/typings/src/execution/FilesystemTools.d.ts +1 -1
  328. package/esm/typings/src/execution/LlmExecutionTools.d.ts +21 -1
  329. package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts +5 -0
  330. package/esm/typings/src/execution/createPipelineExecutor/20-executeTask.d.ts +5 -0
  331. package/esm/typings/src/execution/createPipelineExecutor/30-executeFormatSubvalues.d.ts +5 -0
  332. package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +5 -0
  333. package/esm/typings/src/execution/utils/usage-constants.d.ts +4 -124
  334. package/esm/typings/src/execution/utils/validatePromptResult.d.ts +2 -0
  335. package/esm/typings/src/high-level-abstractions/_common/HighLevelAbstraction.d.ts +2 -1
  336. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForWizardOrCli.d.ts +2 -2
  337. package/esm/typings/src/llm-providers/_common/register/$registeredLlmToolsMessage.d.ts +2 -1
  338. package/esm/typings/src/llm-providers/_common/register/LlmToolsMetadata.d.ts +1 -1
  339. package/esm/typings/src/llm-providers/_common/utils/assertUniqueModels.d.ts +12 -0
  340. package/esm/typings/src/llm-providers/_multiple/getSingleLlmExecutionTools.d.ts +1 -0
  341. package/esm/typings/src/llm-providers/_multiple/joinLlmExecutionTools.d.ts +1 -0
  342. package/esm/typings/src/llm-providers/agent/Agent.d.ts +70 -0
  343. package/esm/typings/src/llm-providers/agent/AgentLlmExecutionTools.d.ts +26 -4
  344. package/esm/typings/src/llm-providers/agent/AgentOptions.d.ts +19 -0
  345. package/esm/typings/src/llm-providers/agent/CreateAgentLlmExecutionToolsOptions.d.ts +17 -0
  346. package/esm/typings/src/llm-providers/agent/RemoteAgent.d.ts +50 -0
  347. package/esm/typings/src/llm-providers/agent/RemoteAgentOptions.d.ts +11 -0
  348. package/esm/typings/src/llm-providers/agent/createAgentLlmExecutionTools.d.ts +1 -19
  349. package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +1 -1
  350. package/esm/typings/src/llm-providers/google/google-models.d.ts +1 -1
  351. package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionTools.d.ts +60 -2
  352. package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionToolsOptions.d.ts +7 -1
  353. package/esm/typings/src/llm-providers/openai/openai-models.d.ts +1 -1
  354. package/esm/typings/src/llm-providers/openai/openai-models.test.d.ts +4 -0
  355. package/esm/typings/src/other/templates/getTemplatesPipelineCollection.d.ts +1 -1
  356. package/esm/typings/src/pipeline/validatePipelineString.d.ts +2 -0
  357. package/esm/typings/src/playground/permanent/_boilerplate.d.ts +5 -0
  358. package/esm/typings/src/playground/permanent/agent-with-browser-playground.d.ts +5 -0
  359. package/esm/typings/src/prepare/PrepareAndScrapeOptions.d.ts +1 -0
  360. package/esm/typings/src/remote-server/startAgentServer.d.ts +26 -0
  361. package/esm/typings/src/remote-server/startRemoteServer.d.ts +4 -1
  362. package/esm/typings/src/remote-server/types/RemoteServerOptions.d.ts +3 -8
  363. package/esm/typings/src/scrapers/_boilerplate/createBoilerplateScraper.d.ts +1 -12
  364. package/esm/typings/src/scrapers/_boilerplate/register-metadata.d.ts +1 -9
  365. package/esm/typings/src/scrapers/document/createDocumentScraper.d.ts +1 -12
  366. package/esm/typings/src/scrapers/document/register-metadata.d.ts +1 -9
  367. package/esm/typings/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts +1 -12
  368. package/esm/typings/src/scrapers/document-legacy/register-metadata.d.ts +1 -9
  369. package/esm/typings/src/scrapers/markdown/createMarkdownScraper.d.ts +1 -12
  370. package/esm/typings/src/scrapers/markdown/register-metadata.d.ts +1 -9
  371. package/esm/typings/src/scrapers/markitdown/createMarkitdownScraper.d.ts +1 -12
  372. package/esm/typings/src/scrapers/markitdown/register-metadata.d.ts +1 -9
  373. package/esm/typings/src/scrapers/pdf/createPdfScraper.d.ts +1 -12
  374. package/esm/typings/src/scrapers/pdf/register-metadata.d.ts +1 -9
  375. package/esm/typings/src/scrapers/website/createWebsiteScraper.d.ts +1 -12
  376. package/esm/typings/src/scrapers/website/register-metadata.d.ts +1 -9
  377. package/esm/typings/src/storage/_common/PromptbookStorage.d.ts +1 -0
  378. package/esm/typings/src/storage/env-storage/$EnvStorage.d.ts +2 -1
  379. package/esm/typings/src/transpilers/_common/BookTranspiler.d.ts +33 -0
  380. package/esm/typings/src/transpilers/_common/BookTranspilerOptions.d.ts +18 -0
  381. package/esm/typings/src/transpilers/_common/register/$bookTranspilersRegister.d.ts +15 -0
  382. package/esm/typings/src/transpilers/formatted-book-in-markdown/FormattedBookInMarkdownTranspiler.d.ts +16 -0
  383. package/esm/typings/src/transpilers/formatted-book-in-markdown/register.d.ts +15 -0
  384. package/esm/typings/src/transpilers/openai-sdk/OpenAiSdkTranspiler.d.ts +16 -0
  385. package/esm/typings/src/transpilers/openai-sdk/OpenAiSdkTranspiler.test.d.ts +1 -0
  386. package/esm/typings/src/transpilers/openai-sdk/playground/playground.d.ts +5 -0
  387. package/esm/typings/src/transpilers/openai-sdk/register.d.ts +15 -0
  388. package/esm/typings/src/types/LlmCall.d.ts +20 -0
  389. package/esm/typings/src/types/Updatable.d.ts +19 -0
  390. package/esm/typings/src/types/typeAliases.d.ts +32 -2
  391. package/esm/typings/src/utils/color/$randomColor.d.ts +1 -0
  392. package/esm/typings/src/utils/color/Color.d.ts +15 -0
  393. package/esm/typings/src/utils/color/Color.test.d.ts +1 -0
  394. package/esm/typings/src/utils/color/css-colors.d.ts +1 -0
  395. package/esm/typings/src/utils/color/internal-utils/checkChannelValue.d.ts +0 -3
  396. package/esm/typings/src/utils/color/operators/darken.d.ts +1 -1
  397. package/esm/typings/src/utils/color/operators/grayscale.d.ts +1 -1
  398. package/esm/typings/src/utils/color/operators/lighten.d.ts +1 -1
  399. package/esm/typings/src/utils/color/operators/mixWithColor.d.ts +1 -1
  400. package/esm/typings/src/utils/color/operators/saturate.d.ts +1 -1
  401. package/esm/typings/src/utils/environment/$detectRuntimeEnvironment.d.ts +16 -0
  402. package/esm/typings/src/utils/environment/$getGlobalScope.d.ts +2 -2
  403. package/esm/typings/src/utils/execCommand/$execCommand.d.ts +2 -1
  404. package/esm/typings/src/utils/execCommand/$execCommands.d.ts +2 -1
  405. package/esm/typings/src/utils/files/$induceBookDownload.d.ts +13 -0
  406. package/esm/typings/src/utils/files/$induceFileDownload.d.ts +13 -0
  407. package/esm/typings/src/utils/files/ObjectUrl.d.ts +46 -0
  408. package/esm/typings/src/utils/files/listAllFiles.d.ts +2 -3
  409. package/esm/typings/src/utils/misc/aboutPromptbookInformation.d.ts +27 -0
  410. package/esm/typings/src/utils/misc/computeHash.d.ts +11 -0
  411. package/esm/typings/src/utils/misc/computeHash.test.d.ts +1 -0
  412. package/esm/typings/src/utils/misc/xAboutPromptbookInformation.d.ts +13 -0
  413. package/esm/typings/src/utils/normalization/normalize-to-kebab-case.d.ts +2 -0
  414. package/esm/typings/src/utils/normalization/normalizeMessageText.d.ts +9 -0
  415. package/esm/typings/src/utils/normalization/normalizeMessageText.test.d.ts +1 -0
  416. package/esm/typings/src/utils/normalization/normalizeTo_PascalCase.d.ts +3 -0
  417. package/esm/typings/src/utils/normalization/normalizeTo_camelCase.d.ts +2 -0
  418. package/esm/typings/src/utils/normalization/titleToName.d.ts +2 -0
  419. package/esm/typings/src/utils/organization/$sideEffect.d.ts +2 -2
  420. package/esm/typings/src/utils/organization/$side_effect.d.ts +7 -0
  421. package/esm/typings/src/utils/organization/TODO_USE.d.ts +2 -2
  422. package/esm/typings/src/utils/organization/keepUnused.d.ts +2 -2
  423. package/esm/typings/src/utils/organization/preserve.d.ts +3 -3
  424. package/esm/typings/src/utils/organization/really_any.d.ts +7 -0
  425. package/esm/typings/src/utils/random/$generateBookBoilerplate.d.ts +25 -0
  426. package/esm/typings/src/utils/random/$randomAgentPersona.d.ts +9 -0
  427. package/esm/typings/src/utils/random/$randomFullnameWithColor.d.ts +13 -0
  428. package/esm/typings/src/utils/random/$randomItem.d.ts +9 -0
  429. package/esm/typings/src/utils/random/$randomSeed.d.ts +3 -0
  430. package/esm/typings/src/utils/random/$randomToken.d.ts +2 -0
  431. package/esm/typings/src/utils/serialization/$deepFreeze.d.ts +2 -1
  432. package/esm/typings/src/utils/serialization/asSerializable.d.ts +2 -2
  433. package/esm/typings/src/utils/serialization/serializeToPromptbookJavascript.d.ts +2 -2
  434. package/esm/typings/src/utils/validators/parameterName/validateParameterName.d.ts +2 -0
  435. package/esm/typings/src/version.d.ts +1 -1
  436. package/esm/typings/src/wizard/$getCompiledBook.d.ts +1 -2
  437. package/package.json +15 -15
  438. package/umd/index.umd.js +5089 -356
  439. package/umd/index.umd.js.map +1 -1
  440. package/esm/typings/src/book-2.0/commitments/index.d.ts +0 -60
  441. package/esm/typings/src/book-components/BookEditor/config.d.ts +0 -11
  442. package/esm/typings/src/book-components/Chat/utils/renderMarkdown.d.ts +0 -21
  443. package/esm/typings/src/collection/collectionToJson.d.ts +0 -13
  444. package/esm/typings/src/collection/constructors/createCollectionFromJson.d.ts +0 -13
  445. /package/esm/typings/src/{book-components/Chat/utils/renderMarkdown.test.d.ts → book-2.0/agent-source/computeAgentHash.test.d.ts} +0 -0
  446. /package/esm/typings/src/{collection/constructors/createCollectionFromDirectory.test.d.ts → book-2.0/agent-source/normalizeAgentName.test.d.ts} +0 -0
  447. /package/esm/typings/src/{collection/constructors/createCollectionFromJson.test.d.ts → book-components/Chat/AgentChat/AgentChat.test.d.ts} +0 -0
  448. /package/esm/typings/src/collection/{constructors/createCollectionFromPromise.test.d.ts → pipeline-collection/constructors/createPipelineCollectionFromDirectory.test.d.ts} +0 -0
  449. /package/esm/typings/src/{commands/_common/parseCommand.test.d.ts → collection/pipeline-collection/constructors/createPipelineCollectionFromJson.test.d.ts} +0 -0
  450. /package/esm/typings/src/collection/{collectionToJson.test.d.ts → pipeline-collection/pipelineCollectionToJson.test.d.ts} +0 -0
  451. /package/esm/typings/src/{book-2.0/commitments → commitments}/_base/BookCommitment.d.ts +0 -0
  452. /package/esm/typings/src/{book-2.0/commitments → commitments}/_base/ParsedCommitment.d.ts +0 -0
@@ -0,0 +1,38 @@
1
+ import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
2
+ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
3
+ /**
4
+ * USE SEARCH ENGINE commitment definition
5
+ *
6
+ * The `USE SEARCH ENGINE` commitment indicates that the agent should utilize a search engine tool
7
+ * to access and retrieve up-to-date information from the internet when necessary.
8
+ *
9
+ * The content following `USE SEARCH ENGINE` is ignored (similar to NOTE).
10
+ *
11
+ * Example usage in agent source:
12
+ *
13
+ * ```book
14
+ * USE SEARCH ENGINE
15
+ * USE SEARCH ENGINE This will be ignored
16
+ * ```
17
+ *
18
+ * @private [🪔] Maybe export the commitments through some package
19
+ */
20
+ export declare class UseSearchEngineCommitmentDefinition extends BaseCommitmentDefinition<'USE SEARCH ENGINE'> {
21
+ constructor();
22
+ /**
23
+ * Short one-line description of USE SEARCH ENGINE.
24
+ */
25
+ get description(): string;
26
+ /**
27
+ * Icon for this commitment.
28
+ */
29
+ get icon(): string;
30
+ /**
31
+ * Markdown documentation for USE SEARCH ENGINE commitment.
32
+ */
33
+ get documentation(): string;
34
+ applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
35
+ }
36
+ /**
37
+ * Note: [💞] Ignore a discrepancy between file name and entity name
38
+ */
@@ -1,4 +1,4 @@
1
- import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
1
+ import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
2
2
  import type { CommitmentDefinition } from './CommitmentDefinition';
3
3
  /**
4
4
  * Base implementation of CommitmentDefinition that provides common functionality
@@ -8,12 +8,18 @@ import type { CommitmentDefinition } from './CommitmentDefinition';
8
8
  */
9
9
  export declare abstract class BaseCommitmentDefinition<TBookCommitment extends string> implements CommitmentDefinition {
10
10
  readonly type: TBookCommitment;
11
- constructor(type: TBookCommitment);
11
+ readonly aliases: string[];
12
+ constructor(type: TBookCommitment, aliases?: string[]);
12
13
  /**
13
14
  * Short one-line markdown description; concise, may use inline **markdown**.
14
15
  * Must be implemented by each concrete commitment.
15
16
  */
16
17
  abstract get description(): string;
18
+ /**
19
+ * Icon for this commitment.
20
+ * It should be a single emoji.
21
+ */
22
+ abstract get icon(): string;
17
23
  /**
18
24
  * Human-readable markdown documentation for this commitment, available at runtime.
19
25
  * Must be implemented by each concrete commitment.
@@ -1,4 +1,4 @@
1
- import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
1
+ import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
2
2
  /**
3
3
  * Definition of a commitment that can be applied to agent model requirements
4
4
  *
@@ -16,6 +16,11 @@ export type CommitmentDefinition = {
16
16
  * Keep it concise; may use inline markdown like **bold** or *italic*.
17
17
  */
18
18
  readonly description: string;
19
+ /**
20
+ * Icon for this commitment.
21
+ * It should be a single emoji.
22
+ */
23
+ readonly icon: string;
19
24
  /**
20
25
  * Human-readable markdown documentation for this commitment.
21
26
  * Should explain what the commitment does and include example usage.
@@ -1,4 +1,4 @@
1
- import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
1
+ import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
2
2
  import { BaseCommitmentDefinition } from './BaseCommitmentDefinition';
3
3
  /**
4
4
  * Placeholder commitment definition for commitments that are not yet implemented
@@ -14,6 +14,10 @@ export declare class NotYetImplementedCommitmentDefinition<TBookCommitment exten
14
14
  * Short one-line description of a placeholder commitment.
15
15
  */
16
16
  get description(): string;
17
+ /**
18
+ * Icon for this commitment.
19
+ */
20
+ get icon(): string;
17
21
  /**
18
22
  * Markdown documentation available at runtime.
19
23
  */
@@ -1,4 +1,4 @@
1
- import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
1
+ import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
2
2
  /**
3
3
  * Creates an empty/basic agent model requirements object
4
4
  * This serves as the starting point for the reduce-like pattern
@@ -0,0 +1,93 @@
1
+ import type { BookCommitment } from './_base/BookCommitment';
2
+ import type { CommitmentDefinition } from './_base/CommitmentDefinition';
3
+ import { ActionCommitmentDefinition } from './ACTION/ACTION';
4
+ import { ClosedCommitmentDefinition } from './CLOSED/CLOSED';
5
+ import { ComponentCommitmentDefinition } from './COMPONENT/COMPONENT';
6
+ import { DeleteCommitmentDefinition } from './DELETE/DELETE';
7
+ import { FormatCommitmentDefinition } from './FORMAT/FORMAT';
8
+ import { FromCommitmentDefinition } from './FROM/FROM';
9
+ import { GoalCommitmentDefinition } from './GOAL/GOAL';
10
+ import { KnowledgeCommitmentDefinition } from './KNOWLEDGE/KNOWLEDGE';
11
+ import { LanguageCommitmentDefinition } from './LANGUAGE/LANGUAGE';
12
+ import { MemoryCommitmentDefinition } from './MEMORY/MEMORY';
13
+ import { AgentMessageCommitmentDefinition } from './MESSAGE/AgentMessageCommitmentDefinition';
14
+ import { InitialMessageCommitmentDefinition } from './MESSAGE/InitialMessageCommitmentDefinition';
15
+ import { MessageCommitmentDefinition } from './MESSAGE/MESSAGE';
16
+ import { UserMessageCommitmentDefinition } from './MESSAGE/UserMessageCommitmentDefinition';
17
+ import { MetaCommitmentDefinition } from './META/META';
18
+ import { MetaColorCommitmentDefinition } from './META_COLOR/META_COLOR';
19
+ import { MetaFontCommitmentDefinition } from './META_FONT/META_FONT';
20
+ import { MetaImageCommitmentDefinition } from './META_IMAGE/META_IMAGE';
21
+ import { MetaLinkCommitmentDefinition } from './META_LINK/META_LINK';
22
+ import { ModelCommitmentDefinition } from './MODEL/MODEL';
23
+ import { NoteCommitmentDefinition } from './NOTE/NOTE';
24
+ import { OpenCommitmentDefinition } from './OPEN/OPEN';
25
+ import { PersonaCommitmentDefinition } from './PERSONA/PERSONA';
26
+ import { RuleCommitmentDefinition } from './RULE/RULE';
27
+ import { SampleCommitmentDefinition } from './SAMPLE/SAMPLE';
28
+ import { ScenarioCommitmentDefinition } from './SCENARIO/SCENARIO';
29
+ import { StyleCommitmentDefinition } from './STYLE/STYLE';
30
+ import { UseCommitmentDefinition } from './USE/USE';
31
+ import { UseBrowserCommitmentDefinition } from './USE_BROWSER/USE_BROWSER';
32
+ import { UseMcpCommitmentDefinition } from './USE_MCP/USE_MCP';
33
+ import { UseSearchEngineCommitmentDefinition } from './USE_SEARCH_ENGINE/USE_SEARCH_ENGINE';
34
+ import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplementedCommitmentDefinition';
35
+ /**
36
+ * Registry of all available commitment definitions
37
+ * This array contains instances of all commitment definitions
38
+ * This is the single source of truth for all commitments in the system
39
+ *
40
+ * @private Use functions to access commitments instead of this array directly
41
+ */
42
+ export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, MemoryCommitmentDefinition, MemoryCommitmentDefinition, StyleCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, LanguageCommitmentDefinition, LanguageCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, FromCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, ComponentCommitmentDefinition, MetaImageCommitmentDefinition, MetaColorCommitmentDefinition, MetaFontCommitmentDefinition, MetaLinkCommitmentDefinition, MetaCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, InitialMessageCommitmentDefinition, UserMessageCommitmentDefinition, AgentMessageCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, OpenCommitmentDefinition, ClosedCommitmentDefinition, UseBrowserCommitmentDefinition, UseSearchEngineCommitmentDefinition, UseMcpCommitmentDefinition, UseCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
43
+ /**
44
+ * Gets a commitment definition by its type
45
+ * @param type The commitment type to look up
46
+ * @returns The commitment definition or null if not found
47
+ *
48
+ * @public exported from `@promptbook/core`
49
+ */
50
+ export declare function getCommitmentDefinition(type: BookCommitment): CommitmentDefinition | null;
51
+ /**
52
+ * Gets all available commitment definitions
53
+ * @returns Array of all commitment definitions
54
+ *
55
+ * @public exported from `@promptbook/core`
56
+ */
57
+ export declare function getAllCommitmentDefinitions(): ReadonlyArray<CommitmentDefinition>;
58
+ /**
59
+ * Gets all available commitment types
60
+ * @returns Array of all commitment types
61
+ *
62
+ * @public exported from `@promptbook/core`
63
+ */
64
+ export declare function getAllCommitmentTypes(): ReadonlyArray<BookCommitment>;
65
+ /**
66
+ * Checks if a commitment type is supported
67
+ * @param type The commitment type to check
68
+ * @returns True if the commitment type is supported
69
+ *
70
+ * @public exported from `@promptbook/core`
71
+ */
72
+ export declare function isCommitmentSupported(type: BookCommitment): boolean;
73
+ /**
74
+ * Grouped commitment definition
75
+ *
76
+ * @public exported from `@promptbook/core`
77
+ */
78
+ export type GroupedCommitmentDefinition = {
79
+ primary: CommitmentDefinition;
80
+ aliases: string[];
81
+ };
82
+ /**
83
+ * Gets all commitment definitions grouped by their aliases
84
+ *
85
+ * @returns Array of grouped commitment definitions
86
+ *
87
+ * @public exported from `@promptbook/core`
88
+ */
89
+ export declare function getGroupedCommitmentDefinitions(): ReadonlyArray<GroupedCommitmentDefinition>;
90
+ /**
91
+ * TODO: [🧠] Maybe create through standardized $register
92
+ * Note: [💞] Ignore a discrepancy between file name and entity name
93
+ */
@@ -1,7 +1,7 @@
1
- import { Color } from './_packages/color.index';
2
1
  import type { CsvSettings } from './formats/csv/CsvSettings';
3
2
  import type { IntermediateFilesStrategy } from './types/IntermediateFilesStrategy';
4
3
  import type { string_app_id, string_email, string_name, string_promptbook_server_url } from './types/typeAliases';
4
+ import { Color } from './utils/color/Color';
5
5
  /**
6
6
  * Warning message for the generated sections and files files
7
7
  *
@@ -45,7 +45,21 @@ export declare const CLAIM = "Turn your company's scattered knowledge into AI re
45
45
  */
46
46
  export declare const PROMPTBOOK_COLOR: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
47
47
  /**
48
- * Dark color of the Promptbook
48
+ * Colors for syntax highlighting in the `<BookEditor/>`
49
+ *
50
+ * TODO: [🗽] Unite branding and make single place for it
51
+ *
52
+ * @public exported from `@promptbook/core`
53
+ */
54
+ export declare const PROMPTBOOK_SYNTAX_COLORS: {
55
+ readonly TITLE: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
56
+ readonly LINE: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
57
+ readonly SEPARATOR: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
58
+ readonly COMMITMENT: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
59
+ readonly PARAMETER: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
60
+ };
61
+ /**
62
+ * Chat color of the Promptbook (in chat)
49
63
  *
50
64
  * TODO: [🗽] Unite branding and make single place for it
51
65
  *
@@ -220,6 +234,13 @@ export declare const DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL = 200;
220
234
  * @public exported from `@promptbook/core`
221
235
  */
222
236
  export declare const DEFAULT_BOOKS_DIRNAME = "./books";
237
+ /**
238
+ * Where to store your agents (also book files)
239
+ * This is kind of a "src" for your books
240
+ *
241
+ * @public exported from `@promptbook/core`
242
+ */
243
+ export declare const DEFAULT_AGENTS_DIRNAME = "./agents";
223
244
  /**
224
245
  * Where to store the temporary downloads
225
246
  *
@@ -257,7 +278,7 @@ export declare const CLI_APP_ID: string_app_id;
257
278
  */
258
279
  export declare const PLAYGROUND_APP_ID: string_app_id;
259
280
  /**
260
- * The name of the builded pipeline collection made by CLI `ptbk make` and for lookup in `createCollectionFromDirectory`
281
+ * The name of the builded pipeline collection made by CLI `ptbk make` and for lookup in `createPipelineCollectionFromDirectory`
261
282
  *
262
283
  * @public exported from `@promptbook/core`
263
284
  */
@@ -9,6 +9,8 @@ import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
9
9
  * - if it is valid json
10
10
  * - if it is meaningful
11
11
  *
12
+ * Note: [🔂] This function is idempotent.
13
+ *
12
14
  * @param pipeline valid or invalid PipelineJson
13
15
  * @returns the same pipeline if it is logically valid
14
16
  * @throws {PipelineLogicError} on logical error in the pipeline
@@ -2,11 +2,13 @@ import { CsvFormatError } from '../formats/csv/CsvFormatError';
2
2
  import { AbstractFormatError } from './AbstractFormatError';
3
3
  import { AuthenticationError } from './AuthenticationError';
4
4
  import { CollectionError } from './CollectionError';
5
+ import { DatabaseError } from './DatabaseError';
5
6
  import { EnvironmentMismatchError } from './EnvironmentMismatchError';
6
7
  import { ExpectError } from './ExpectError';
7
8
  import { KnowledgeScrapeError } from './KnowledgeScrapeError';
8
9
  import { LimitReachedError } from './LimitReachedError';
9
10
  import { MissingToolsError } from './MissingToolsError';
11
+ import { NotAllowed } from './NotAllowed';
10
12
  import { NotFoundError } from './NotFoundError';
11
13
  import { NotYetImplementedError } from './NotYetImplementedError';
12
14
  import { ParseError } from './ParseError';
@@ -40,6 +42,8 @@ export declare const PROMPTBOOK_ERRORS: {
40
42
  readonly PromptbookFetchError: typeof PromptbookFetchError;
41
43
  readonly UnexpectedError: typeof UnexpectedError;
42
44
  readonly WrappedError: typeof WrappedError;
45
+ readonly NotAllowed: typeof NotAllowed;
46
+ readonly DatabaseError: typeof DatabaseError;
43
47
  };
44
48
  /**
45
49
  * Index of all javascript errors
@@ -88,6 +92,8 @@ export declare const ALL_ERRORS: {
88
92
  readonly PromptbookFetchError: typeof PromptbookFetchError;
89
93
  readonly UnexpectedError: typeof UnexpectedError;
90
94
  readonly WrappedError: typeof WrappedError;
95
+ readonly NotAllowed: typeof NotAllowed;
96
+ readonly DatabaseError: typeof DatabaseError;
91
97
  };
92
98
  /**
93
99
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -0,0 +1,12 @@
1
+ /**
2
+ * This error indicates error from the database
3
+ *
4
+ * @public exported from `@promptbook/core`
5
+ */
6
+ export declare class DatabaseError extends Error {
7
+ readonly name = "DatabaseError";
8
+ constructor(message: string);
9
+ }
10
+ /**
11
+ * TODO: [🐱‍🚀] Explain that NotFoundError ([🐱‍🚀] and other specific errors) has priority over DatabaseError in some contexts
12
+ */
@@ -0,0 +1,9 @@
1
+ /**
2
+ * This error indicates that promptbook operation is not allowed
3
+ *
4
+ * @public exported from `@promptbook/core`
5
+ */
6
+ export declare class NotAllowed extends Error {
7
+ readonly name = "NotAllowed";
8
+ constructor(message: string);
9
+ }
@@ -1,4 +1,4 @@
1
- import type { really_any } from '../utils/organization/really_any';
1
+ import type { chococake } from '../utils/organization/really_any';
2
2
  /**
3
3
  * This error type indicates that somewhere in the code non-Error object was thrown and it was wrapped into the `WrappedError`
4
4
  *
@@ -6,5 +6,5 @@ import type { really_any } from '../utils/organization/really_any';
6
6
  */
7
7
  export declare class WrappedError extends Error {
8
8
  readonly name = "WrappedError";
9
- constructor(whatWasThrown: really_any);
9
+ constructor(whatWasThrown: chococake);
10
10
  }
@@ -46,5 +46,6 @@ export type AvailableModel = {
46
46
  readonly isDeprecated?: boolean;
47
47
  };
48
48
  /**
49
+ * TODO: [🕛] Extend this from sth like `AgentBasicInformation` / `ModelBasicInformation`
49
50
  * TODO: [🧠] Maybe rename to something else - like `ModelInformation` or `ModelMetadata`
50
51
  */
@@ -16,3 +16,6 @@ export type Executables = {
16
16
  */
17
17
  libreOfficePath?: string_executable_path;
18
18
  };
19
+ /**
20
+ * <- TODO: Add !!! `browserPath` to `Executables`
21
+ */
@@ -1,8 +1,9 @@
1
1
  import type { Observable } from 'rxjs';
2
2
  import { PartialDeep } from 'type-fest';
3
- import type { number_percent } from '../types/typeAliases';
4
- import type { task_id } from '../types/typeAliases';
3
+ import type { LlmCall } from '../types/LlmCall';
4
+ import type { number_percent, task_id } from '../types/typeAliases';
5
5
  import type { string_SCREAMING_CASE } from '../utils/normalization/normalizeTo_SCREAMING_CASE';
6
+ import type { chococake } from '../utils/organization/really_any';
6
7
  import type { string_promptbook_version } from '../version';
7
8
  import type { AbstractTaskResult } from './AbstractTaskResult';
8
9
  import type { PipelineExecutorResult } from './PipelineExecutorResult';
@@ -32,7 +33,7 @@ type CreateTaskOptions<TTaskResult extends AbstractTaskResult> = {
32
33
  }) => void, updateTldr: (tldrInfo: {
33
34
  readonly percent: number_percent;
34
35
  readonly message: string;
35
- }) => void): Promise<TTaskResult>;
36
+ }) => void, logLlmCall: (llmCall: LlmCall) => void): Promise<TTaskResult>;
36
37
  };
37
38
  /**
38
39
  * Helper to create a new task
@@ -136,6 +137,14 @@ export type AbstractTask<TTaskResult extends AbstractTaskResult> = {
136
137
  * List of warnings that occurred during the task processing
137
138
  */
138
139
  readonly warnings: Array<Error>;
140
+ /**
141
+ * List of LLM calls that occurred during the task processing
142
+ */
143
+ readonly llmCalls: Array<LlmCall>;
144
+ /**
145
+ * Optional nonce to correlate logs with version of the Promptbook engine
146
+ */
147
+ readonly ptbkNonce?: chococake;
139
148
  };
140
149
  export type Task = ExecutionTask | PreparationTask;
141
150
  export {};
@@ -67,3 +67,8 @@ export type ExecutionTools = {
67
67
  */
68
68
  readonly userInterface?: UserInterfaceTools;
69
69
  };
70
+ /**
71
+ * <- TODO: Add !!! `promptbookAgent` to `ExecutionTools`
72
+ * <- TODO: Add !!! `mcps` to `ExecutionTools`
73
+ * <- TODO: Add !!! `prepareCache` to `ExecutionTools`
74
+ */
@@ -3,7 +3,7 @@ import type fs from 'fs/promises';
3
3
  /**
4
4
  * Container for all the tools needed to manipulate with filesystem
5
5
  */
6
- export type FilesystemTools = Pick<typeof fs, 'access' | 'constants' | 'readFile' | 'writeFile' | 'stat' | 'readdir' | 'mkdir'>;
6
+ export type FilesystemTools = Pick<typeof fs, 'access' | 'constants' | 'readFile' | 'writeFile' | 'stat' | 'readdir' | 'mkdir' | 'watch'>;
7
7
  /**
8
8
  * TODO: Implement destroyable pattern to free resources
9
9
  */
@@ -9,6 +9,13 @@ import type { ChatPromptResult, CompletionPromptResult, EmbeddingPromptResult }
9
9
  * On its interface it exposes common methods for prompt execution.
10
10
  * Inside (in constructor) it calls OpenAI, Azure, GPU, proxy, cache, logging,...
11
11
  *
12
+ * Note: [🦖] There are several different things in Promptbook:
13
+ * - `Agent` - which represents an AI Agent with its source, memories, actions, etc. Agent is a higher-level abstraction which is internally using:
14
+ * - `LlmExecutionTools` - which wraps one or more LLM models and provides an interface to execute them
15
+ * - `AgentLlmExecutionTools` - which is a specific implementation of `LlmExecutionTools` that wraps another LlmExecutionTools and applies agent-specific system prompts and requirements
16
+ * - `OpenAiAssistantExecutionTools` - which is a specific implementation of `LlmExecutionTools` for OpenAI models with assistant capabilities, recommended for usage in `Agent` or `AgentLlmExecutionTools`
17
+ * - `RemoteAgent` - which is an `Agent` that connects to a Promptbook Agents Server
18
+ *
12
19
  * @see https://github.com/webgptorg/promptbook#llm-execution-tools
13
20
  */
14
21
  export type LlmExecutionTools = {
@@ -46,6 +53,19 @@ export type LlmExecutionTools = {
46
53
  * Calls a chat model
47
54
  */
48
55
  callChatModel?(prompt: Prompt): Promise<ChatPromptResult>;
56
+ /**
57
+ * Calls a chat model with streaming
58
+ */
59
+ callChatModelStream?(prompt: Prompt, onProgress: (chunk: ChatPromptResult) => void): Promise<ChatPromptResult>;
60
+ /**
61
+ * Calls a voice chat model
62
+ */
63
+ callVoiceChatModel?(audio: Blob, prompt: Prompt): Promise<{
64
+ text: string;
65
+ audio: Blob;
66
+ userMessage?: string;
67
+ agentMessage?: string;
68
+ }>;
49
69
  /**
50
70
  * Calls a completion model
51
71
  */
@@ -56,7 +76,7 @@ export type LlmExecutionTools = {
56
76
  callEmbeddingModel?(prompt: Prompt): Promise<EmbeddingPromptResult>;
57
77
  };
58
78
  /**
59
- * TODO: [🕛] Extend this from sth class
79
+ * TODO: [🕛] Extend this from sth class - like `AgentBasicInformation` / `ModelBasicInformation``
60
80
  * TODO: [🍚] Implement destroyable pattern to free resources
61
81
  * TODO: [🏳] Add `callTranslationModel`
62
82
  * TODO: [🧠] Emulation of one type of model with another one - emuate chat with completion; emulate translation with chat
@@ -2,6 +2,7 @@ import type { PartialDeep, Promisable, ReadonlyDeep } from 'type-fest';
2
2
  import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
3
3
  import type { InputParameters } from '../../types/typeAliases';
4
4
  import type { PipelineExecutorResult } from '../PipelineExecutorResult';
5
+ import type { LlmCall } from '../../types/LlmCall';
5
6
  import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
6
7
  /**
7
8
  * Options for executing an entire pipeline, including input parameters, pipeline context, and progress callbacks.
@@ -17,6 +18,10 @@ type ExecutePipelineOptions = Required<CreatePipelineExecutorOptions> & {
17
18
  * Optional callback invoked with partial results as the pipeline execution progresses.
18
19
  */
19
20
  onProgress?(newOngoingResult: PartialDeep<PipelineExecutorResult>): Promisable<void>;
21
+ /**
22
+ * Optional callback invoked with each LLM call.
23
+ */
24
+ logLlmCall?(llmCall: LlmCall): Promisable<void>;
20
25
  /**
21
26
  * The pipeline definition to execute.
22
27
  */
@@ -2,6 +2,7 @@ import type { PartialDeep, Promisable, ReadonlyDeep, WritableDeep } from 'type-f
2
2
  import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
3
3
  import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
4
4
  import type { Parameters } from '../../types/typeAliases';
5
+ import type { LlmCall } from '../../types/LlmCall';
5
6
  import type { ExecutionReportJson } from '../execution-report/ExecutionReportJson';
6
7
  import type { PipelineExecutorResult } from '../PipelineExecutorResult';
7
8
  import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
@@ -27,6 +28,10 @@ type executeSingleTaskOptions = Required<CreatePipelineExecutorOptions> & {
27
28
  * Callback invoked with partial results as the execution progresses.
28
29
  */
29
30
  onProgress(newOngoingResult: PartialDeep<PipelineExecutorResult>): Promisable<void>;
31
+ /**
32
+ * Optional callback invoked with each LLM call.
33
+ */
34
+ logLlmCall?(llmCall: LlmCall): Promisable<void>;
30
35
  /**
31
36
  * Mutable execution report object for tracking execution details.
32
37
  */
@@ -1,5 +1,6 @@
1
1
  import type { PartialDeep, Promisable } from 'type-fest';
2
2
  import type { TODO_any } from '../../utils/organization/TODO_any';
3
+ import type { LlmCall } from '../../types/LlmCall';
3
4
  import type { PipelineExecutorResult } from '../PipelineExecutorResult';
4
5
  import type { ExecuteAttemptsOptions } from './40-executeAttempts';
5
6
  /**
@@ -13,6 +14,10 @@ type ExecuteFormatCellsOptions = ExecuteAttemptsOptions & {
13
14
  * Callback invoked with partial results as the execution progresses.
14
15
  */
15
16
  onProgress(newOngoingResult: PartialDeep<PipelineExecutorResult>): Promisable<void>;
17
+ /**
18
+ * Optional callback invoked with each LLM call.
19
+ */
20
+ logLlmCall?(llmCall: LlmCall): Promisable<void>;
16
21
  };
17
22
  /**
18
23
  * Executes a pipeline task that requires mapping or iterating over subvalues of a parameter (such as rows in a CSV).
@@ -1,6 +1,7 @@
1
1
  import type { PartialDeep, Promisable, ReadonlyDeep, WritableDeep } from 'type-fest';
2
2
  import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
3
3
  import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
4
+ import type { LlmCall } from '../../types/LlmCall';
4
5
  import type { Parameters, string_parameter_name } from '../../types/typeAliases';
5
6
  import type { TODO_string } from '../../utils/organization/TODO_string';
6
7
  import type { ExecutionReportJson } from '../execution-report/ExecutionReportJson';
@@ -50,6 +51,10 @@ export type ExecuteAttemptsOptions = Required<Omit<CreatePipelineExecutorOptions
50
51
  * Callback invoked with partial results as the execution progresses.
51
52
  */
52
53
  onProgress(newOngoingResult: PartialDeep<PipelineExecutorResult>): Promisable<void>;
54
+ /**
55
+ * Optional callback invoked with each LLM call.
56
+ */
57
+ logLlmCall?(llmCall: LlmCall): Promisable<void>;
53
58
  /**
54
59
  * The execution report object, which is updated during execution.
55
60
  */