@promptbook/documents 0.112.0-31 → 0.112.0-34

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 (351) hide show
  1. package/esm/index.es.js +4 -6
  2. package/esm/index.es.js.map +1 -1
  3. package/esm/src/_packages/components.index.d.ts +6 -0
  4. package/esm/src/_packages/types.index.d.ts +55 -49
  5. package/esm/src/book-2.0/agent-source/AgentReferenceResolver.d.ts +11 -0
  6. package/esm/src/book-2.0/agent-source/CreateAgentModelRequirementsOptions.d.ts +8 -0
  7. package/esm/src/book-2.0/agent-source/TeammateProfileResolver.d.ts +33 -0
  8. package/esm/src/book-2.0/agent-source/createTeamToolName.d.ts +7 -7
  9. package/esm/src/book-components/Chat/Chat/ChatActionsBar.d.ts +5 -0
  10. package/esm/src/book-components/Chat/Chat/ChatInputAreaDictationPanel.d.ts +42 -0
  11. package/esm/src/book-components/Chat/Chat/ChatMessageItem.d.ts +18 -15
  12. package/esm/src/book-components/Chat/Chat/ChatMessageItem.test.d.ts +1 -1
  13. package/esm/src/book-components/Chat/Chat/ChatMessageList.d.ts +14 -0
  14. package/esm/src/book-components/Chat/Chat/ChatMessageRichContent.d.ts +32 -0
  15. package/esm/src/book-components/Chat/Chat/ChatMessageToolCallChips.d.ts +22 -0
  16. package/esm/src/book-components/Chat/Chat/ChatProps.d.ts +290 -0
  17. package/esm/src/book-components/Chat/Chat/ChatToolCallModal.d.ts +16 -0
  18. package/esm/src/book-components/Chat/Chat/StreamingFeaturePlaceholder.d.ts +33 -0
  19. package/esm/src/book-components/Chat/Chat/createChatMessageToolCallRenderModel.d.ts +76 -0
  20. package/esm/src/book-components/Chat/Chat/createProgressCardChecklistMarkdown.d.ts +16 -0
  21. package/esm/src/book-components/Chat/Chat/renderAdvancedToolCallDetails.d.ts +4 -0
  22. package/esm/src/book-components/Chat/Chat/renderEmailToolCallDetails.d.ts +26 -0
  23. package/esm/src/book-components/Chat/Chat/renderMemoryToolCallDetails.d.ts +31 -0
  24. package/esm/src/book-components/Chat/Chat/renderPopupToolCallDetails.d.ts +32 -0
  25. package/esm/src/book-components/Chat/Chat/renderRunBrowserToolCallDetails.d.ts +31 -0
  26. package/esm/src/book-components/Chat/Chat/renderSearchToolCallDetails.d.ts +31 -0
  27. package/esm/src/book-components/Chat/Chat/renderSelfLearningToolCallDetails.d.ts +38 -0
  28. package/esm/src/book-components/Chat/Chat/renderTimeToolCallDetails.d.ts +38 -0
  29. package/esm/src/book-components/Chat/Chat/renderTimeoutToolCallDetails.d.ts +46 -0
  30. package/esm/src/book-components/Chat/Chat/renderToolCallClockPanel.d.ts +33 -0
  31. package/esm/src/book-components/Chat/Chat/renderToolCallDetails.d.ts +10 -1
  32. package/esm/src/book-components/Chat/Chat/renderToolCallProgressPlaceholder.d.ts +29 -0
  33. package/esm/src/book-components/Chat/Chat/renderWalletCredentialToolCallDetails.d.ts +26 -0
  34. package/esm/src/book-components/Chat/Chat/resolveToolCallProgressMessage.d.ts +9 -0
  35. package/esm/src/book-components/Chat/Chat/useChatInputAreaAttachments.d.ts +32 -0
  36. package/esm/src/book-components/Chat/Chat/useChatInputAreaDictation.d.ts +76 -0
  37. package/esm/src/book-components/Chat/Chat/useChatMessageAvatarTooltip.d.ts +31 -0
  38. package/esm/src/book-components/Chat/Chat/useChatMessageSpeechPlayback.d.ts +29 -0
  39. package/esm/src/book-components/Chat/MarkdownContent/MarkdownContent.d.ts +2 -1
  40. package/esm/src/book-components/Chat/MarkdownContent/MarkdownContent.test.d.ts +2 -0
  41. package/esm/src/book-components/Chat/hooks/useChatCompleteNotification.d.ts +18 -0
  42. package/esm/src/book-components/Chat/hooks/useChatCompleteNotification.test.d.ts +2 -0
  43. package/esm/src/book-components/Chat/types/ChatMessage.d.ts +77 -1
  44. package/esm/src/book-components/Chat/utils/formatToolCallDateTime.d.ts +37 -0
  45. package/esm/src/book-components/Chat/utils/formatToolCallLocalTime.d.ts +11 -0
  46. package/esm/src/book-components/Chat/utils/formatToolCallTranslationTemplate.d.ts +10 -0
  47. package/esm/src/book-components/Chat/utils/getChatMessageTimingDisplay.d.ts +5 -1
  48. package/esm/src/book-components/Chat/utils/getToolCallChipletInfo.d.ts +26 -1
  49. package/esm/src/book-components/Chat/utils/timeoutToolCallPresentation.d.ts +26 -3
  50. package/esm/src/cli/$runPromptbookCli.d.ts +1 -3
  51. package/esm/src/cli/cli-commands/_boilerplate.d.ts +2 -4
  52. package/esm/src/cli/cli-commands/about.d.ts +1 -1
  53. package/esm/src/cli/cli-commands/coder/find-fresh-emoji-tags.d.ts +2 -4
  54. package/esm/src/cli/cli-commands/coder/find-refactor-candidates.d.ts +2 -4
  55. package/esm/src/cli/cli-commands/coder/generate-boilerplates.d.ts +2 -4
  56. package/esm/src/cli/cli-commands/coder/init.d.ts +2 -4
  57. package/esm/src/cli/cli-commands/coder/run.d.ts +2 -4
  58. package/esm/src/cli/cli-commands/coder/verify.d.ts +2 -4
  59. package/esm/src/cli/cli-commands/coder.d.ts +2 -4
  60. package/esm/src/cli/cli-commands/hello.d.ts +1 -1
  61. package/esm/src/cli/cli-commands/list-models.d.ts +2 -4
  62. package/esm/src/cli/cli-commands/list-scrapers.d.ts +2 -4
  63. package/esm/src/cli/cli-commands/login.d.ts +1 -1
  64. package/esm/src/cli/cli-commands/make.d.ts +1 -1
  65. package/esm/src/cli/cli-commands/prettify.d.ts +1 -1
  66. package/esm/src/cli/cli-commands/run.d.ts +1 -1
  67. package/esm/src/cli/cli-commands/runInteractiveChatbot.d.ts +1 -1
  68. package/esm/src/cli/cli-commands/start-agents-server.d.ts +2 -4
  69. package/esm/src/cli/cli-commands/start-pipelines-server.d.ts +1 -1
  70. package/esm/src/cli/cli-commands/test-command.d.ts +1 -1
  71. package/esm/src/cli/main.d.ts +2 -4
  72. package/esm/src/cli/promptbookCli.d.ts +1 -1
  73. package/esm/src/commitments/USE_BROWSER/fetchUrlContent.d.ts +1 -3
  74. package/esm/src/conversion/archive/loadArchive.d.ts +1 -3
  75. package/esm/src/conversion/archive/saveArchive.d.ts +1 -1
  76. package/esm/src/conversion/validation/_importPipeline.d.ts +2 -4
  77. package/esm/src/dialogs/simple-prompt/SimplePromptInterfaceTools.d.ts +1 -3
  78. package/esm/src/executables/$provideExecutablesForNode.d.ts +1 -1
  79. package/esm/src/executables/apps/locateLibreoffice.d.ts +2 -4
  80. package/esm/src/executables/apps/locatePandoc.d.ts +2 -4
  81. package/esm/src/executables/locateApp.d.ts +2 -4
  82. package/esm/src/executables/platforms/locateAppOnLinux.d.ts +2 -4
  83. package/esm/src/executables/platforms/locateAppOnMacOs.d.ts +2 -4
  84. package/esm/src/executables/platforms/locateAppOnWindows.d.ts +2 -4
  85. package/esm/src/execution/translation/automatic-translate/translateMessages.d.ts +2 -4
  86. package/esm/src/execution/utils/$provideExecutionToolsForNode.d.ts +2 -4
  87. package/esm/src/llm-providers/_common/register/$provideEnvFilename.d.ts +1 -3
  88. package/esm/src/llm-providers/_common/register/$provideLlmToolsConfigurationFromEnv.d.ts +1 -3
  89. package/esm/src/llm-providers/_common/register/$provideLlmToolsForWizardOrCli.d.ts +1 -1
  90. package/esm/src/llm-providers/_common/register/$provideLlmToolsFromEnv.d.ts +1 -3
  91. package/esm/src/llm-providers/_multiple/playground/playground.d.ts +1 -3
  92. package/esm/src/llm-providers/agent/playground/playground.d.ts +1 -1
  93. package/esm/src/llm-providers/anthropic-claude/playground/playground.d.ts +1 -1
  94. package/esm/src/llm-providers/azure-openai/playground/playground.d.ts +2 -4
  95. package/esm/src/llm-providers/ollama/playground/playground.d.ts +2 -4
  96. package/esm/src/llm-providers/openai/playground/playground.d.ts +2 -4
  97. package/esm/src/llm-providers/remote/playground/playground.d.ts +1 -3
  98. package/esm/src/llm-providers/vercel/playground/playground.d.ts +2 -4
  99. package/esm/src/playground/permanent/_boilerplate.d.ts +1 -3
  100. package/esm/src/playground/permanent/agent-with-browser-playground.d.ts +1 -3
  101. package/esm/src/playground/permanent/error-handling-playground.d.ts +1 -3
  102. package/esm/src/playground/playground.d.ts +2 -4
  103. package/esm/src/remote-server/startAgentServer.d.ts +1 -3
  104. package/esm/src/remote-server/startRemoteServer.d.ts +1 -2
  105. package/esm/src/scrapers/_boilerplate/BoilerplateScraper.d.ts +4 -6
  106. package/esm/src/scrapers/_boilerplate/playground/boilerplate-scraper-playground.d.ts +1 -3
  107. package/esm/src/scrapers/_common/register/$provideFilesystemForNode.d.ts +2 -4
  108. package/esm/src/scrapers/_common/register/$provideScrapersForNode.d.ts +2 -4
  109. package/esm/src/scrapers/_common/register/$provideScriptingForNode.d.ts +2 -4
  110. package/esm/src/scrapers/_common/utils/getScraperIntermediateSource.d.ts +1 -1
  111. package/esm/src/scrapers/document/DocumentScraper.d.ts +1 -1
  112. package/esm/src/scrapers/document/playground/document-scraper-playground.d.ts +1 -3
  113. package/esm/src/scrapers/document-legacy/LegacyDocumentScraper.d.ts +1 -1
  114. package/esm/src/scrapers/document-legacy/playground/legacy-document-scraper-playground.d.ts +1 -3
  115. package/esm/src/scrapers/markdown/playground/markdown-scraper-playground.d.ts +1 -3
  116. package/esm/src/scrapers/markitdown/MarkitdownScraper.d.ts +1 -1
  117. package/esm/src/scrapers/markitdown/playground/markitdown-scraper-playground.d.ts +1 -3
  118. package/esm/src/scrapers/pdf/PdfScraper.d.ts +1 -1
  119. package/esm/src/scrapers/pdf/playground/pdf-scraper-playground.d.ts +1 -3
  120. package/esm/src/scrapers/website/WebsiteScraper.d.ts +1 -1
  121. package/esm/src/scrapers/website/playground/website-scraper-playground.d.ts +1 -3
  122. package/esm/src/speech-recognition/BrowserSpeechRecognition.d.ts +2 -4
  123. package/esm/src/storage/file-cache-storage/FileCacheStorage.d.ts +2 -4
  124. package/esm/src/storage/local-storage/getIndexedDbStorage.d.ts +1 -3
  125. package/esm/src/storage/local-storage/getLocalStorage.d.ts +1 -3
  126. package/esm/src/storage/local-storage/getSessionStorage.d.ts +1 -3
  127. package/esm/src/transpilers/openai-sdk/playground/playground.d.ts +1 -3
  128. package/esm/src/types/InputParameters_private.d.ts +11 -0
  129. package/esm/src/types/Parameters_private.d.ts +16 -0
  130. package/esm/src/types/ReservedParameters_private.d.ts +10 -0
  131. package/esm/src/types/number_bytes.d.ts +21 -0
  132. package/esm/src/types/number_id.d.ts +13 -0
  133. package/esm/src/types/number_likeness.d.ts +8 -0
  134. package/esm/src/types/number_milliseconds.d.ts +33 -0
  135. package/esm/src/types/number_percent.d.ts +18 -0
  136. package/esm/src/types/number_positive.d.ts +16 -0
  137. package/esm/src/types/number_usd.d.ts +6 -106
  138. package/esm/src/types/string_agent_hash_private.d.ts +9 -0
  139. package/esm/src/types/string_agent_name_in_book_private.d.ts +8 -0
  140. package/esm/src/types/string_agent_name_private.d.ts +9 -0
  141. package/esm/src/types/string_agent_permanent_id_private.d.ts +10 -0
  142. package/esm/src/types/string_base64_private.d.ts +17 -0
  143. package/esm/src/types/string_business_category_name_private.d.ts +6 -0
  144. package/esm/src/types/string_char_private.d.ts +8 -0
  145. package/esm/src/types/string_chat_prompt_private.d.ts +9 -0
  146. package/esm/src/types/string_completion_prompt_private.d.ts +9 -0
  147. package/esm/src/types/string_email_private.d.ts +16 -0
  148. package/esm/src/types/string_host_private.d.ts +55 -0
  149. package/esm/src/types/string_mime_type_private.d.ts +17 -0
  150. package/esm/src/types/string_model_description_private.d.ts +8 -0
  151. package/esm/src/types/string_model_name_private.d.ts +8 -0
  152. package/esm/src/types/string_name_private.d.ts +9 -0
  153. package/esm/src/types/string_page_private.d.ts +9 -0
  154. package/esm/src/types/string_parameter_name.d.ts +74 -31
  155. package/esm/src/types/string_parameter_value_private.d.ts +9 -0
  156. package/esm/src/types/string_persona_description_private.d.ts +8 -0
  157. package/esm/src/types/string_prompt_image_private.d.ts +8 -0
  158. package/esm/src/types/string_prompt_private.d.ts +8 -0
  159. package/esm/src/types/string_reserved_parameter_name_private.d.ts +11 -0
  160. package/esm/src/types/string_system_message_private.d.ts +9 -0
  161. package/esm/src/types/string_template_private.d.ts +8 -0
  162. package/esm/src/types/string_text_prompt_private.d.ts +9 -0
  163. package/esm/src/types/string_title_private.d.ts +9 -0
  164. package/esm/src/types/string_url.d.ts +50 -46
  165. package/esm/src/types/string_url_private.d.ts +88 -0
  166. package/esm/src/types/typeAliases.d.ts +7 -1
  167. package/esm/src/utils/execCommand/$execCommand.d.ts +1 -3
  168. package/esm/src/utils/execCommand/$execCommands.d.ts +1 -3
  169. package/esm/src/utils/files/$induceBookDownload.d.ts +1 -3
  170. package/esm/src/utils/files/$induceFileDownload.d.ts +1 -3
  171. package/esm/src/utils/files/ObjectUrl.d.ts +1 -3
  172. package/esm/src/utils/toolCalls/mergeToolCalls.d.ts +1 -1
  173. package/esm/src/version.d.ts +1 -1
  174. package/esm/src/wizard/$getCompiledBook.d.ts +2 -4
  175. package/esm/src/wizard/wizard.d.ts +2 -4
  176. package/package.json +2 -2
  177. package/umd/index.umd.js +4 -6
  178. package/umd/index.umd.js.map +1 -1
  179. package/umd/src/_packages/components.index.d.ts +6 -0
  180. package/umd/src/_packages/types.index.d.ts +55 -49
  181. package/umd/src/book-2.0/agent-source/AgentReferenceResolver.d.ts +11 -0
  182. package/umd/src/book-2.0/agent-source/CreateAgentModelRequirementsOptions.d.ts +8 -0
  183. package/umd/src/book-2.0/agent-source/TeammateProfileResolver.d.ts +33 -0
  184. package/umd/src/book-2.0/agent-source/createTeamToolName.d.ts +7 -7
  185. package/umd/src/book-components/Chat/Chat/ChatActionsBar.d.ts +5 -0
  186. package/umd/src/book-components/Chat/Chat/ChatInputAreaDictationPanel.d.ts +42 -0
  187. package/umd/src/book-components/Chat/Chat/ChatMessageItem.d.ts +18 -15
  188. package/umd/src/book-components/Chat/Chat/ChatMessageItem.test.d.ts +1 -1
  189. package/umd/src/book-components/Chat/Chat/ChatMessageList.d.ts +14 -0
  190. package/umd/src/book-components/Chat/Chat/ChatMessageRichContent.d.ts +32 -0
  191. package/umd/src/book-components/Chat/Chat/ChatMessageToolCallChips.d.ts +22 -0
  192. package/umd/src/book-components/Chat/Chat/ChatProps.d.ts +290 -0
  193. package/umd/src/book-components/Chat/Chat/ChatToolCallModal.d.ts +16 -0
  194. package/umd/src/book-components/Chat/Chat/StreamingFeaturePlaceholder.d.ts +33 -0
  195. package/umd/src/book-components/Chat/Chat/createChatMessageToolCallRenderModel.d.ts +76 -0
  196. package/umd/src/book-components/Chat/Chat/createProgressCardChecklistMarkdown.d.ts +16 -0
  197. package/umd/src/book-components/Chat/Chat/renderAdvancedToolCallDetails.d.ts +4 -0
  198. package/umd/src/book-components/Chat/Chat/renderEmailToolCallDetails.d.ts +26 -0
  199. package/umd/src/book-components/Chat/Chat/renderMemoryToolCallDetails.d.ts +31 -0
  200. package/umd/src/book-components/Chat/Chat/renderPopupToolCallDetails.d.ts +32 -0
  201. package/umd/src/book-components/Chat/Chat/renderRunBrowserToolCallDetails.d.ts +31 -0
  202. package/umd/src/book-components/Chat/Chat/renderSearchToolCallDetails.d.ts +31 -0
  203. package/umd/src/book-components/Chat/Chat/renderSelfLearningToolCallDetails.d.ts +38 -0
  204. package/umd/src/book-components/Chat/Chat/renderTimeToolCallDetails.d.ts +38 -0
  205. package/umd/src/book-components/Chat/Chat/renderTimeoutToolCallDetails.d.ts +46 -0
  206. package/umd/src/book-components/Chat/Chat/renderToolCallClockPanel.d.ts +33 -0
  207. package/umd/src/book-components/Chat/Chat/renderToolCallDetails.d.ts +10 -1
  208. package/umd/src/book-components/Chat/Chat/renderToolCallProgressPlaceholder.d.ts +29 -0
  209. package/umd/src/book-components/Chat/Chat/renderWalletCredentialToolCallDetails.d.ts +26 -0
  210. package/umd/src/book-components/Chat/Chat/resolveToolCallProgressMessage.d.ts +9 -0
  211. package/umd/src/book-components/Chat/Chat/useChatInputAreaAttachments.d.ts +32 -0
  212. package/umd/src/book-components/Chat/Chat/useChatInputAreaDictation.d.ts +76 -0
  213. package/umd/src/book-components/Chat/Chat/useChatMessageAvatarTooltip.d.ts +31 -0
  214. package/umd/src/book-components/Chat/Chat/useChatMessageSpeechPlayback.d.ts +29 -0
  215. package/umd/src/book-components/Chat/MarkdownContent/MarkdownContent.d.ts +2 -1
  216. package/umd/src/book-components/Chat/MarkdownContent/MarkdownContent.test.d.ts +2 -0
  217. package/umd/src/book-components/Chat/hooks/useChatCompleteNotification.d.ts +18 -0
  218. package/umd/src/book-components/Chat/hooks/useChatCompleteNotification.test.d.ts +2 -0
  219. package/umd/src/book-components/Chat/types/ChatMessage.d.ts +77 -1
  220. package/umd/src/book-components/Chat/utils/formatToolCallDateTime.d.ts +37 -0
  221. package/umd/src/book-components/Chat/utils/formatToolCallLocalTime.d.ts +11 -0
  222. package/umd/src/book-components/Chat/utils/formatToolCallTranslationTemplate.d.ts +10 -0
  223. package/umd/src/book-components/Chat/utils/getChatMessageTimingDisplay.d.ts +5 -1
  224. package/umd/src/book-components/Chat/utils/getToolCallChipletInfo.d.ts +26 -1
  225. package/umd/src/book-components/Chat/utils/timeoutToolCallPresentation.d.ts +26 -3
  226. package/umd/src/cli/$runPromptbookCli.d.ts +1 -3
  227. package/umd/src/cli/cli-commands/_boilerplate.d.ts +2 -4
  228. package/umd/src/cli/cli-commands/about.d.ts +1 -1
  229. package/umd/src/cli/cli-commands/coder/find-fresh-emoji-tags.d.ts +2 -4
  230. package/umd/src/cli/cli-commands/coder/find-refactor-candidates.d.ts +2 -4
  231. package/umd/src/cli/cli-commands/coder/generate-boilerplates.d.ts +2 -4
  232. package/umd/src/cli/cli-commands/coder/init.d.ts +2 -4
  233. package/umd/src/cli/cli-commands/coder/run.d.ts +2 -4
  234. package/umd/src/cli/cli-commands/coder/verify.d.ts +2 -4
  235. package/umd/src/cli/cli-commands/coder.d.ts +2 -4
  236. package/umd/src/cli/cli-commands/hello.d.ts +1 -1
  237. package/umd/src/cli/cli-commands/list-models.d.ts +2 -4
  238. package/umd/src/cli/cli-commands/list-scrapers.d.ts +2 -4
  239. package/umd/src/cli/cli-commands/login.d.ts +1 -1
  240. package/umd/src/cli/cli-commands/make.d.ts +1 -1
  241. package/umd/src/cli/cli-commands/prettify.d.ts +1 -1
  242. package/umd/src/cli/cli-commands/run.d.ts +1 -1
  243. package/umd/src/cli/cli-commands/runInteractiveChatbot.d.ts +1 -1
  244. package/umd/src/cli/cli-commands/start-agents-server.d.ts +2 -4
  245. package/umd/src/cli/cli-commands/start-pipelines-server.d.ts +1 -1
  246. package/umd/src/cli/cli-commands/test-command.d.ts +1 -1
  247. package/umd/src/cli/main.d.ts +2 -4
  248. package/umd/src/cli/promptbookCli.d.ts +1 -1
  249. package/umd/src/commitments/USE_BROWSER/fetchUrlContent.d.ts +1 -3
  250. package/umd/src/conversion/archive/loadArchive.d.ts +1 -3
  251. package/umd/src/conversion/archive/saveArchive.d.ts +1 -1
  252. package/umd/src/conversion/validation/_importPipeline.d.ts +2 -4
  253. package/umd/src/dialogs/simple-prompt/SimplePromptInterfaceTools.d.ts +1 -3
  254. package/umd/src/executables/$provideExecutablesForNode.d.ts +1 -1
  255. package/umd/src/executables/apps/locateLibreoffice.d.ts +2 -4
  256. package/umd/src/executables/apps/locatePandoc.d.ts +2 -4
  257. package/umd/src/executables/locateApp.d.ts +2 -4
  258. package/umd/src/executables/platforms/locateAppOnLinux.d.ts +2 -4
  259. package/umd/src/executables/platforms/locateAppOnMacOs.d.ts +2 -4
  260. package/umd/src/executables/platforms/locateAppOnWindows.d.ts +2 -4
  261. package/umd/src/execution/translation/automatic-translate/translateMessages.d.ts +2 -4
  262. package/umd/src/execution/utils/$provideExecutionToolsForNode.d.ts +2 -4
  263. package/umd/src/llm-providers/_common/register/$provideEnvFilename.d.ts +1 -3
  264. package/umd/src/llm-providers/_common/register/$provideLlmToolsConfigurationFromEnv.d.ts +1 -3
  265. package/umd/src/llm-providers/_common/register/$provideLlmToolsForWizardOrCli.d.ts +1 -1
  266. package/umd/src/llm-providers/_common/register/$provideLlmToolsFromEnv.d.ts +1 -3
  267. package/umd/src/llm-providers/_multiple/playground/playground.d.ts +1 -3
  268. package/umd/src/llm-providers/agent/playground/playground.d.ts +1 -1
  269. package/umd/src/llm-providers/anthropic-claude/playground/playground.d.ts +1 -1
  270. package/umd/src/llm-providers/azure-openai/playground/playground.d.ts +2 -4
  271. package/umd/src/llm-providers/ollama/playground/playground.d.ts +2 -4
  272. package/umd/src/llm-providers/openai/playground/playground.d.ts +2 -4
  273. package/umd/src/llm-providers/remote/playground/playground.d.ts +1 -3
  274. package/umd/src/llm-providers/vercel/playground/playground.d.ts +2 -4
  275. package/umd/src/playground/permanent/_boilerplate.d.ts +1 -3
  276. package/umd/src/playground/permanent/agent-with-browser-playground.d.ts +1 -3
  277. package/umd/src/playground/permanent/error-handling-playground.d.ts +1 -3
  278. package/umd/src/playground/playground.d.ts +2 -4
  279. package/umd/src/remote-server/startAgentServer.d.ts +1 -3
  280. package/umd/src/remote-server/startRemoteServer.d.ts +1 -2
  281. package/umd/src/scrapers/_boilerplate/BoilerplateScraper.d.ts +4 -6
  282. package/umd/src/scrapers/_boilerplate/playground/boilerplate-scraper-playground.d.ts +1 -3
  283. package/umd/src/scrapers/_common/register/$provideFilesystemForNode.d.ts +2 -4
  284. package/umd/src/scrapers/_common/register/$provideScrapersForNode.d.ts +2 -4
  285. package/umd/src/scrapers/_common/register/$provideScriptingForNode.d.ts +2 -4
  286. package/umd/src/scrapers/_common/utils/getScraperIntermediateSource.d.ts +1 -1
  287. package/umd/src/scrapers/document/DocumentScraper.d.ts +1 -1
  288. package/umd/src/scrapers/document/playground/document-scraper-playground.d.ts +1 -3
  289. package/umd/src/scrapers/document-legacy/LegacyDocumentScraper.d.ts +1 -1
  290. package/umd/src/scrapers/document-legacy/playground/legacy-document-scraper-playground.d.ts +1 -3
  291. package/umd/src/scrapers/markdown/playground/markdown-scraper-playground.d.ts +1 -3
  292. package/umd/src/scrapers/markitdown/MarkitdownScraper.d.ts +1 -1
  293. package/umd/src/scrapers/markitdown/playground/markitdown-scraper-playground.d.ts +1 -3
  294. package/umd/src/scrapers/pdf/PdfScraper.d.ts +1 -1
  295. package/umd/src/scrapers/pdf/playground/pdf-scraper-playground.d.ts +1 -3
  296. package/umd/src/scrapers/website/WebsiteScraper.d.ts +1 -1
  297. package/umd/src/scrapers/website/playground/website-scraper-playground.d.ts +1 -3
  298. package/umd/src/speech-recognition/BrowserSpeechRecognition.d.ts +2 -4
  299. package/umd/src/storage/file-cache-storage/FileCacheStorage.d.ts +2 -4
  300. package/umd/src/storage/local-storage/getIndexedDbStorage.d.ts +1 -3
  301. package/umd/src/storage/local-storage/getLocalStorage.d.ts +1 -3
  302. package/umd/src/storage/local-storage/getSessionStorage.d.ts +1 -3
  303. package/umd/src/transpilers/openai-sdk/playground/playground.d.ts +1 -3
  304. package/umd/src/types/InputParameters_private.d.ts +11 -0
  305. package/umd/src/types/Parameters_private.d.ts +16 -0
  306. package/umd/src/types/ReservedParameters_private.d.ts +10 -0
  307. package/umd/src/types/number_bytes.d.ts +21 -0
  308. package/umd/src/types/number_id.d.ts +13 -0
  309. package/umd/src/types/number_likeness.d.ts +8 -0
  310. package/umd/src/types/number_milliseconds.d.ts +33 -0
  311. package/umd/src/types/number_percent.d.ts +18 -0
  312. package/umd/src/types/number_positive.d.ts +16 -0
  313. package/umd/src/types/number_usd.d.ts +6 -106
  314. package/umd/src/types/string_agent_hash_private.d.ts +9 -0
  315. package/umd/src/types/string_agent_name_in_book_private.d.ts +8 -0
  316. package/umd/src/types/string_agent_name_private.d.ts +9 -0
  317. package/umd/src/types/string_agent_permanent_id_private.d.ts +10 -0
  318. package/umd/src/types/string_base64_private.d.ts +17 -0
  319. package/umd/src/types/string_business_category_name_private.d.ts +6 -0
  320. package/umd/src/types/string_char_private.d.ts +8 -0
  321. package/umd/src/types/string_chat_prompt_private.d.ts +9 -0
  322. package/umd/src/types/string_completion_prompt_private.d.ts +9 -0
  323. package/umd/src/types/string_email_private.d.ts +16 -0
  324. package/umd/src/types/string_host_private.d.ts +55 -0
  325. package/umd/src/types/string_mime_type_private.d.ts +17 -0
  326. package/umd/src/types/string_model_description_private.d.ts +8 -0
  327. package/umd/src/types/string_model_name_private.d.ts +8 -0
  328. package/umd/src/types/string_name_private.d.ts +9 -0
  329. package/umd/src/types/string_page_private.d.ts +9 -0
  330. package/umd/src/types/string_parameter_name.d.ts +74 -31
  331. package/umd/src/types/string_parameter_value_private.d.ts +9 -0
  332. package/umd/src/types/string_persona_description_private.d.ts +8 -0
  333. package/umd/src/types/string_prompt_image_private.d.ts +8 -0
  334. package/umd/src/types/string_prompt_private.d.ts +8 -0
  335. package/umd/src/types/string_reserved_parameter_name_private.d.ts +11 -0
  336. package/umd/src/types/string_system_message_private.d.ts +9 -0
  337. package/umd/src/types/string_template_private.d.ts +8 -0
  338. package/umd/src/types/string_text_prompt_private.d.ts +9 -0
  339. package/umd/src/types/string_title_private.d.ts +9 -0
  340. package/umd/src/types/string_url.d.ts +50 -46
  341. package/umd/src/types/string_url_private.d.ts +88 -0
  342. package/umd/src/types/typeAliases.d.ts +7 -1
  343. package/umd/src/utils/execCommand/$execCommand.d.ts +1 -3
  344. package/umd/src/utils/execCommand/$execCommands.d.ts +1 -3
  345. package/umd/src/utils/files/$induceBookDownload.d.ts +1 -3
  346. package/umd/src/utils/files/$induceFileDownload.d.ts +1 -3
  347. package/umd/src/utils/files/ObjectUrl.d.ts +1 -3
  348. package/umd/src/utils/toolCalls/mergeToolCalls.d.ts +1 -1
  349. package/umd/src/version.d.ts +1 -1
  350. package/umd/src/wizard/$getCompiledBook.d.ts +2 -4
  351. package/umd/src/wizard/wizard.d.ts +2 -4
@@ -1,146 +1,150 @@
1
+ import type { string_base64_private, string_data_url_private } from './string_base64_private';
2
+ import type { string_domain_private, string_host_private, string_hostname_private, string_ip_address_private, string_origin_private, string_protocol_private, string_tdl_private } from './string_host_private';
3
+ import type { string_email_private, string_emails_private } from './string_email_private';
4
+ import type { string_mime_type_private, string_mime_type_with_wildcard_private } from './string_mime_type_private';
5
+ import type { string_agent_url_private, string_base_url_private, string_href_private, string_pipeline_root_url_private, string_pipeline_url_private, string_pipeline_url_with_task_hash_private, string_promptbook_server_url_private, string_uri_part_private, string_uri_private, string_url_image_private, string_url_private } from './string_url_private';
1
6
  /**
2
7
  * Semantic helper
3
8
  *
4
9
  * For example `"text/plain"` or `"application/collboard"`
5
10
  */
6
- export type string_mime_type = string;
11
+ export type string_mime_type = string_mime_type_private;
7
12
  /**
8
13
  * Semantic helper
9
14
  *
10
15
  * For example `"text/*"` or `"image/*"`
11
16
  *
12
- *
13
17
  * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#unique_file_type_specifiers
14
18
  */
15
- export type string_mime_type_with_wildcard = string;
19
+ export type string_mime_type_with_wildcard = string_mime_type_with_wildcard_private;
16
20
  /**
17
21
  * Semantic helper
18
22
  *
19
- * For example `"towns.cz"`
23
+ * For example `"SGVsbG8sIFdvcmxkIQ=="`
20
24
  */
21
- export type string_domain = string;
25
+ export type string_base64 = string_base64_private;
22
26
  /**
23
27
  * Semantic helper
24
28
  *
25
- * For example `"https://*.pavolhejny.com/*"`
29
+ * For example `"data:text/plain;base64,SGVsbG8sIFdvcmxkIQ=="`
26
30
  */
27
- export type string_origin = string;
31
+ export type string_data_url = string_data_url_private;
28
32
  /**
29
33
  * Semantic helper
30
34
  *
31
- * For example `"com"`
35
+ * For example `"towns.cz"`
32
36
  */
33
- export type string_tdl = string;
37
+ export type string_domain = string_domain_private;
34
38
  /**
35
39
  * Semantic helper
36
40
  *
37
- * For example `"https://collboard.com/9SeSQTupmQHwuSrLi"`
41
+ * For example `"https://*.pavolhejny.com/*"`
38
42
  */
39
- export type string_url = string;
43
+ export type string_origin = string_origin_private;
40
44
  /**
41
45
  * Semantic helper
42
46
  *
43
- * For example `"https://s1.ptbk.io/promptbook"`
47
+ * For example `"com"`
44
48
  */
45
- export type string_promptbook_server_url = string;
49
+ export type string_tdl = string_tdl_private;
46
50
  /**
47
51
  * Semantic helper
48
52
  *
49
- * For example `"https://collboard.com"`
53
+ * For example `"localhost"` or `"collboard.com"`
50
54
  */
51
- export type string_base_url = string;
55
+ export type string_hostname = string_hostname_private;
52
56
  /**
53
57
  * Semantic helper
54
58
  *
55
- * For example `"https://promptbook.studio/webgpt/"`
59
+ * For example `"localhost:9977"` or `"collboard.com"`
56
60
  */
57
- export type string_pipeline_root_url = string;
61
+ export type string_host = string_host_private;
58
62
  /**
59
63
  * Semantic helper
60
- *
61
- * For example `"https://s6.ptbk.io/agents/agent-007"`
62
64
  */
63
- export type string_agent_url = string;
65
+ export type string_protocol = string_protocol_private;
64
66
  /**
65
67
  * Semantic helper
66
68
  *
67
- * For example `"https://promptbook.studio/webgpt/write-website-content-cs.book"`
69
+ * For example `"192.168.1.1"` (IPv4)
70
+ * For example `"2001:0db8:85a3:0000:0000:8a2e:0370:7334"` (IPv6)
68
71
  */
69
- export type string_pipeline_url = string;
72
+ export type string_ip_address = string_ip_address_private;
70
73
  /**
71
74
  * Semantic helper
72
75
  *
73
- * For example `"https://promptbook.studio/webgpt/write-website-content-cs.book#keywords"`
76
+ * For example `"https://collboard.com/9SeSQTupmQHwuSrLi"`
74
77
  */
75
- export type string_pipeline_url_with_task_hash = string;
78
+ export type string_url = string_url_private;
76
79
  /**
77
80
  * Semantic helper
78
81
  *
79
- * For example `"SGVsbG8sIFdvcmxkIQ=="`
82
+ * For example `"https://s1.ptbk.io/promptbook"`
80
83
  */
81
- export type string_base64 = string;
84
+ export type string_promptbook_server_url = string_promptbook_server_url_private;
82
85
  /**
83
86
  * Semantic helper
84
87
  *
85
- * For example `"data:text/plain;base64,SGVsbG8sIFdvcmxkIQ=="`
88
+ * For example `"https://collboard.com"`
86
89
  */
87
- export type string_data_url = `data:${string_mime_type};base64,${string_base64}`;
90
+ export type string_base_url = string_base_url_private;
88
91
  /**
89
92
  * Semantic helper
90
93
  *
91
- * For example `"https://collboard.com/9SeSQTupmQHwuSrLi"` OR `/9SeSQTupmQHwuSrLi`
94
+ * For example `"https://promptbook.studio/webgpt/"`
92
95
  */
93
- export type string_href = string;
96
+ export type string_pipeline_root_url = string_pipeline_root_url_private;
94
97
  /**
95
98
  * Semantic helper
96
99
  *
97
- * For example `"https://collboard.com/9SeSQTupmQHwuSrLi.png?width=1200&height=630"`
100
+ * For example `"https://s6.ptbk.io/agents/agent-007"`
98
101
  */
99
- export type string_url_image = string;
102
+ export type string_agent_url = string_agent_url_private;
100
103
  /**
101
104
  * Semantic helper
102
105
  *
103
- * For example `"/9SeSQTupmQHwuSrLi"`
106
+ * For example `"https://promptbook.studio/webgpt/write-website-content-cs.book"`
104
107
  */
105
- export type string_uri = string;
108
+ export type string_pipeline_url = string_pipeline_url_private;
106
109
  /**
107
110
  * Semantic helper
108
111
  *
109
- * For example `"9SeSQTupmQHwuSrLi"`
112
+ * For example `"https://promptbook.studio/webgpt/write-website-content-cs.book#keywords"`
110
113
  */
111
- export type string_uri_part = string;
114
+ export type string_pipeline_url_with_task_hash = string_pipeline_url_with_task_hash_private;
112
115
  /**
113
116
  * Semantic helper
114
117
  *
115
- * For example `"localhost"` or `"collboard.com"`
118
+ * For example `"https://collboard.com/9SeSQTupmQHwuSrLi"` OR `/9SeSQTupmQHwuSrLi`
116
119
  */
117
- export type string_hostname = string;
120
+ export type string_href = string_href_private;
118
121
  /**
119
122
  * Semantic helper
120
123
  *
121
- * For example `"localhost:9977"` or `"collboard.com"`
124
+ * For example `"https://collboard.com/9SeSQTupmQHwuSrLi.png?width=1200&height=630"`
122
125
  */
123
- export type string_host = string;
126
+ export type string_url_image = string_url_image_private;
124
127
  /**
125
128
  * Semantic helper
129
+ *
130
+ * For example `"/9SeSQTupmQHwuSrLi"`
126
131
  */
127
- export type string_protocol = 'http:' | 'https:';
132
+ export type string_uri = string_uri_private;
128
133
  /**
129
134
  * Semantic helper
130
135
  *
131
- * For example `"192.168.1.1"` (IPv4)
132
- * For example `"2001:0db8:85a3:0000:0000:8a2e:0370:7334"` (IPv6)
136
+ * For example `"9SeSQTupmQHwuSrLi"`
133
137
  */
134
- export type string_ip_address = string;
138
+ export type string_uri_part = string_uri_part_private;
135
139
  /**
136
140
  * Semantic helper
137
141
  *
138
142
  * For example `"pavol@hejny.org"`
139
143
  */
140
- export type string_email = string;
144
+ export type string_email = string_email_private;
141
145
  /**
142
146
  * Semantic helper
143
147
  *
144
148
  * For example `"pavol@hejny.org, jirka@webgpt.cz"`
145
149
  */
146
- export type string_emails = string;
150
+ export type string_emails = string_emails_private;
@@ -0,0 +1,88 @@
1
+ /**
2
+ * Semantic helper
3
+ *
4
+ * For example `"https://collboard.com/9SeSQTupmQHwuSrLi"`
5
+ *
6
+ * @private internal utility of `string_url.ts`
7
+ */
8
+ export type string_url_private = string;
9
+ /**
10
+ * Semantic helper
11
+ *
12
+ * For example `"https://s1.ptbk.io/promptbook"`
13
+ *
14
+ * @private internal utility of `string_url.ts`
15
+ */
16
+ export type string_promptbook_server_url_private = string_url_private;
17
+ /**
18
+ * Semantic helper
19
+ *
20
+ * For example `"https://collboard.com"`
21
+ *
22
+ * @private internal utility of `string_url.ts`
23
+ */
24
+ export type string_base_url_private = string_url_private;
25
+ /**
26
+ * Semantic helper
27
+ *
28
+ * For example `"https://promptbook.studio/webgpt/"`
29
+ *
30
+ * @private internal utility of `string_url.ts`
31
+ */
32
+ export type string_pipeline_root_url_private = string_url_private;
33
+ /**
34
+ * Semantic helper
35
+ *
36
+ * For example `"https://s6.ptbk.io/agents/agent-007"`
37
+ *
38
+ * @private internal utility of `string_url.ts`
39
+ */
40
+ export type string_agent_url_private = string_url_private;
41
+ /**
42
+ * Semantic helper
43
+ *
44
+ * For example `"https://promptbook.studio/webgpt/write-website-content-cs.book"`
45
+ *
46
+ * @private internal utility of `string_url.ts`
47
+ */
48
+ export type string_pipeline_url_private = string_url_private;
49
+ /**
50
+ * Semantic helper
51
+ *
52
+ * For example `"https://promptbook.studio/webgpt/write-website-content-cs.book#keywords"`
53
+ *
54
+ * @private internal utility of `string_url.ts`
55
+ */
56
+ export type string_pipeline_url_with_task_hash_private = string_pipeline_url_private;
57
+ /**
58
+ * Semantic helper
59
+ *
60
+ * For example `"https://collboard.com/9SeSQTupmQHwuSrLi"` OR `/9SeSQTupmQHwuSrLi`
61
+ *
62
+ * @private internal utility of `string_url.ts`
63
+ */
64
+ export type string_href_private = string;
65
+ /**
66
+ * Semantic helper
67
+ *
68
+ * For example `"https://collboard.com/9SeSQTupmQHwuSrLi.png?width=1200&height=630"`
69
+ *
70
+ * @private internal utility of `string_url.ts`
71
+ */
72
+ export type string_url_image_private = string_url_private;
73
+ /**
74
+ * Semantic helper
75
+ *
76
+ * For example `"/9SeSQTupmQHwuSrLi"`
77
+ *
78
+ * @private internal utility of `string_url.ts`
79
+ */
80
+ export type string_uri_private = string;
81
+ /**
82
+ * Semantic helper
83
+ *
84
+ * For example `"9SeSQTupmQHwuSrLi"`
85
+ *
86
+ * @private internal utility of `string_url.ts`
87
+ */
88
+ export type string_uri_part_private = string;
@@ -6,7 +6,13 @@ export type { string_base64, string_base_url, string_data_url, string_domain, st
6
6
  export type { string_knowledge_source_content, string_knowledge_source_link } from './string_knowledge_source_content';
7
7
  export type { string_attribute, string_attribute_value_scope, string_color, string_javascript_name, string_legal_entity, string_license, string_person_firstname, string_person_fullname, string_person_lastname, string_person_profile, string_postprocessing_function_name, string_translate_language, string_translate_name, string_translate_name_not_normalized, } from './string_person_fullname';
8
8
  export type { id, string_app_id, string_date_iso8601, string_language, string_license_token, string_password, string_pgp_key, string_promptbook_token, string_ssh_key, string_token, string_user_id, task_id, } from './string_token';
9
- export type { number_bytes, number_days, number_gigabytes, number_hours, number_id, number_integer, number_kilobytes, number_likeness, number_linecol_number, number_megabytes, number_milliseconds, number_minutes, number_model_temperature, number_months, number_negative, number_percent, number_port, number_positive, number_seconds, number_seed, number_terabytes, number_tokens, number_usd, number_weeks, number_years, } from './number_usd';
9
+ export type { number_id, number_linecol_number, number_tokens, } from './number_id';
10
+ export type { number_integer, number_negative, number_port, number_positive } from './number_positive';
11
+ export type { number_model_temperature, number_percent, number_seed } from './number_percent';
12
+ export type { number_likeness } from './number_likeness';
13
+ export type { number_weeks, number_days, number_hours, number_milliseconds, number_minutes, number_months, number_seconds, number_years, } from './number_milliseconds';
14
+ export type { number_bytes, number_gigabytes, number_kilobytes, number_megabytes, number_terabytes } from './number_bytes';
15
+ export type { number_usd } from './number_usd';
10
16
  /**
11
17
  * TODO: [main] !!3 Change "For example" to @example
12
18
  * TODO: Change to branded types
@@ -12,6 +12,4 @@ import type { ExecCommandOptions } from './ExecCommandOptions';
12
12
  * @public exported from `@promptbook/node`
13
13
  */
14
14
  export declare function $execCommand(options: ExecCommandOptions): Promise<$side_effect & string>;
15
- /**
16
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
17
- */
15
+ /** Note: [🟢] Code for Node command-execution helper [$execCommand](src/utils/execCommand/$execCommand.ts) should never be published into packages that could be imported into browser environment */
@@ -14,6 +14,4 @@ export declare function $execCommands({ commands, cwd, crashOnError, }: $side_ef
14
14
  readonly cwd: string;
15
15
  readonly crashOnError?: boolean;
16
16
  }): Promise<void>;
17
- /**
18
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
19
- */
17
+ /** Note: [🟢] Code for Node command-execution helper [$execCommands](src/utils/execCommand/$execCommands.ts) should never be published into packages that could be imported into browser environment */
@@ -8,6 +8,4 @@ import type { $side_effect } from '../organization/$side_effect';
8
8
  * @public exported from `@promptbook/browser`
9
9
  */
10
10
  export declare function $induceBookDownload(book: string_book): Promise<$side_effect>;
11
- /**
12
- * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
13
- */
11
+ /** Note: [🔵] Code for browser file helper [$induceBookDownload](src/utils/files/$induceBookDownload.ts) should never be published outside of `@promptbook/browser` */
@@ -8,6 +8,4 @@ import type { $side_effect } from '../organization/$side_effect';
8
8
  * @public exported from `@promptbook/browser`
9
9
  */
10
10
  export declare function $induceFileDownload(fileOrBlobOrUrl: File | Blob | URL | string_url): Promise<$side_effect>;
11
- /**
12
- * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
13
- */
11
+ /** Note: [🔵] Code for browser file helper [$induceFileDownload](src/utils/files/$induceFileDownload.ts) should never be published outside of `@promptbook/browser` */
@@ -41,6 +41,4 @@ export declare class ObjectUrl extends Registration implements IDestroyable {
41
41
  */
42
42
  get url(): URL;
43
43
  }
44
- /**
45
- * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
46
- */
44
+ /** Note: [🔵] Code for browser file helper [ObjectUrl](src/utils/files/ObjectUrl.ts) should never be published outside of `@promptbook/browser` */
@@ -1,4 +1,4 @@
1
- import type { ToolCall } from '../../types/ToolCall';
1
+ import { type ToolCall } from '../../types/ToolCall';
2
2
  /**
3
3
  * Merges streamed tool-call snapshots by stable identity while preserving incremental logs,
4
4
  * warnings, and partial results.
@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
15
15
  export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
16
16
  /**
17
17
  * Represents the version string of the Promptbook engine.
18
- * It follows semantic versioning (e.g., `0.112.0-30`).
18
+ * It follows semantic versioning (e.g., `0.112.0-33`).
19
19
  *
20
20
  * @generated
21
21
  */
@@ -9,7 +9,5 @@ import type { string_filename, string_pipeline_url } from '../types/typeAliases'
9
9
  * @private usable through `ptbk run` and `@promptbook/wizard`
10
10
  */
11
11
  export declare function $getCompiledBook(tools: Required<Pick<ExecutionTools, 'fs' | 'fetch'>>, pipelineSource: string_filename | string_pipeline_url | PipelineString, options?: PrepareAndScrapeOptions): Promise<PipelineJson>;
12
- /**
13
- * TODO: Write unit test
14
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
15
- */
12
+ /** Note: [🟢] Code for Node wizard helper [$getCompiledBook](src/wizard/$getCompiledBook.ts) should never be published into packages that could be imported into browser environment */
13
+ /** TODO: Write unit test */
@@ -69,7 +69,5 @@ declare class Wizard {
69
69
  */
70
70
  export declare const wizard: Wizard;
71
71
  export {};
72
- /**
73
- * TODO: [🧠] Maybe some way how to handle the progress and streaming?
74
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
75
- */
72
+ /** Note: [🟢] Code for Node wizard helper [wizard](src/wizard/wizard.ts) should never be published into packages that could be imported into browser environment */
73
+ /** TODO: [🧠] Maybe some way how to handle the progress and streaming? */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/documents",
3
- "version": "0.112.0-31",
3
+ "version": "0.112.0-34",
4
4
  "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
5
5
  "private": false,
6
6
  "sideEffects": false,
@@ -98,7 +98,7 @@
98
98
  "module": "./esm/index.es.js",
99
99
  "typings": "./esm/typings/src/_packages/documents.index.d.ts",
100
100
  "peerDependencies": {
101
- "@promptbook/core": "0.112.0-31"
101
+ "@promptbook/core": "0.112.0-34"
102
102
  },
103
103
  "dependencies": {
104
104
  "colors": "1.4.0",
package/umd/index.umd.js CHANGED
@@ -24,7 +24,7 @@
24
24
  * @generated
25
25
  * @see https://github.com/webgptorg/promptbook
26
26
  */
27
- const PROMPTBOOK_ENGINE_VERSION = '0.112.0-31';
27
+ const PROMPTBOOK_ENGINE_VERSION = '0.112.0-34';
28
28
  /**
29
29
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
30
30
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -1465,9 +1465,7 @@
1465
1465
  }
1466
1466
  });
1467
1467
  }
1468
- /**
1469
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
1470
- */
1468
+ /** Note: [🟢] Code for Node command-execution helper [$execCommand](src/utils/execCommand/$execCommand.ts) should never be published into packages that could be imported into browser environment */
1471
1469
 
1472
1470
  /**
1473
1471
  * Get the file extension from a file name
@@ -2023,12 +2021,12 @@
2023
2021
  };
2024
2022
  return fileHandler;
2025
2023
  }
2024
+ /** Note: [🟢] Code for Node scraper helper [getScraperIntermediateSource](src/scrapers/_common/utils/getScraperIntermediateSource.ts) should never be published into packages that could be imported into browser environment */
2026
2025
  /**
2027
2026
  * Note: Not using `FileCacheStorage` for two reasons:
2028
2027
  * 1) Need to store more than serialized JSONs
2029
2028
  * 2) Need to switch between a `rootDirname` and `cacheDirname` <- TODO: [😡]
2030
2029
  * TODO: [🐱‍🐉][🧠] Make some smart crop
2031
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
2032
2030
  */
2033
2031
 
2034
2032
  var PipelineCollection = [{title:"Prepare Knowledge from Markdown",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.book",formfactorName:"GENERIC",parameters:[{name:"knowledgeContent",description:"Markdown document content",isInput:true,isOutput:false},{name:"knowledgePieces",description:"The knowledge JSON object",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"knowledge",title:"Knowledge",content:"You are experienced data researcher, extract the important knowledge from the document.\n\n# Rules\n\n- Make pieces of information concise, clear, and easy to understand\n- One piece of information should be approximately 1 paragraph\n- Divide the paragraphs by markdown horizontal lines ---\n- Omit irrelevant information\n- Group redundant information\n- Write just extracted information, nothing else\n\n# The document\n\nTake information from this document:\n\n> {knowledgeContent}",resultingParameterName:"knowledgePieces",dependentParameterNames:["knowledgeContent"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sources:[{type:"BOOK",path:null,content:"# Prepare Knowledge from Markdown\n\n- PIPELINE URL `https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.book`\n- INPUT PARAMETER `{knowledgeContent}` Markdown document content\n- OUTPUT PARAMETER `{knowledgePieces}` The knowledge JSON object\n\n## Knowledge\n\n<!-- TODO: [🍆] -FORMAT JSON -->\n\n```markdown\nYou are experienced data researcher, extract the important knowledge from the document.\n\n# Rules\n\n- Make pieces of information concise, clear, and easy to understand\n- One piece of information should be approximately 1 paragraph\n- Divide the paragraphs by markdown horizontal lines ---\n- Omit irrelevant information\n- Group redundant information\n- Write just extracted information, nothing else\n\n# The document\n\nTake information from this document:\n\n> {knowledgeContent}\n```\n\n`-> {knowledgePieces}`\n"}],sourceFile:"./books/prepare-knowledge-from-markdown.book"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-keywords.book",formfactorName:"GENERIC",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"keywords",description:"Keywords separated by comma",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"knowledge",title:"Knowledge",content:"You are experienced data researcher, detect the important keywords in the document.\n\n# Rules\n\n- Write just keywords separated by comma\n\n# The document\n\nTake information from this document:\n\n> {knowledgePieceContent}",resultingParameterName:"keywords",dependentParameterNames:["knowledgePieceContent"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sources:[{type:"BOOK",path:null,content:"# Prepare Keywords\n\n- PIPELINE URL `https://promptbook.studio/promptbook/prepare-knowledge-keywords.book`\n- INPUT PARAMETER `{knowledgePieceContent}` The content\n- OUTPUT PARAMETER `{keywords}` Keywords separated by comma\n\n## Knowledge\n\n<!-- TODO: [🍆] -FORMAT JSON -->\n\n```markdown\nYou are experienced data researcher, detect the important keywords in the document.\n\n# Rules\n\n- Write just keywords separated by comma\n\n# The document\n\nTake information from this document:\n\n> {knowledgePieceContent}\n```\n\n`-> {keywords}`\n"}],sourceFile:"./books/prepare-knowledge-keywords.book"},{title:"Prepare Knowledge-piece Title",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-title.book",formfactorName:"GENERIC",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"title",description:"The title of the document",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"knowledge",title:"Knowledge",content:"You are experienced content creator, write best title for the document.\n\n# Rules\n\n- Write just title, nothing else\n- Write maximum 5 words for the title\n\n# The document\n\n> {knowledgePieceContent}",resultingParameterName:"title",expectations:{words:{min:1,max:8}},dependentParameterNames:["knowledgePieceContent"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sources:[{type:"BOOK",path:null,content:"# Prepare Knowledge-piece Title\n\n- PIPELINE URL `https://promptbook.studio/promptbook/prepare-knowledge-title.book`\n- INPUT PARAMETER `{knowledgePieceContent}` The content\n- OUTPUT PARAMETER `{title}` The title of the document\n\n## Knowledge\n\n- EXPECT MIN 1 WORD\n- EXPECT MAX 8 WORDS\n\n```markdown\nYou are experienced content creator, write best title for the document.\n\n# Rules\n\n- Write just title, nothing else\n- Write maximum 5 words for the title\n\n# The document\n\n> {knowledgePieceContent}\n```\n\n`-> {title}`\n"}],sourceFile:"./books/prepare-knowledge-title.book"},{title:"Prepare Persona",pipelineUrl:"https://promptbook.studio/promptbook/prepare-persona.book",formfactorName:"GENERIC",parameters:[{name:"availableModels",description:"List of available model names together with their descriptions as JSON",isInput:true,isOutput:false},{name:"personaDescription",description:"Description of the persona",isInput:true,isOutput:false},{name:"modelsRequirements",description:"Specific requirements for the model",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"make-model-requirements",title:"Make modelRequirements",content:"You are an experienced AI engineer, you need to find the best models for virtual assistants:\n\n## Example\n\n```json\n[\n {\n \"modelName\": \"gpt-4o\",\n \"systemMessage\": \"You are experienced AI engineer and helpful assistant.\",\n \"temperature\": 0.7\n },\n {\n \"modelName\": \"claude-3-5-sonnet\",\n \"systemMessage\": \"You are a friendly and knowledgeable chatbot.\",\n \"temperature\": 0.5\n }\n]\n```\n\n## Instructions\n\n- Your output format is JSON array\n- Sort best-fitting models first\n- Omit any models that are not suitable\n- Write just the JSON, no other text should be present\n- Array contain items with following keys:\n - `modelName`: The name of the model to use\n - `systemMessage`: The system message to provide context to the model\n - `temperature`: The sampling temperature to use\n\n### Key `modelName`\n\nHere are the available models:\n\n```json\n{availableModels}\n```\n\n### Key `systemMessage`\n\nThe system message is used to communicate instructions or provide context to the model at the beginning of a conversation. It is displayed in a different format compared to user messages, helping the model understand its role in the conversation. The system message typically guides the model's behavior, sets the tone, or specifies desired output from the model. By utilizing the system message effectively, users can steer the model towards generating more accurate and relevant responses.\n\nFor example:\n\n> You are an experienced AI engineer and helpful assistant.\n\n> You are a friendly and knowledgeable chatbot.\n\n### Key `temperature`\n\nThe sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.\n\nYou can pick a value between 0 and 2. For example:\n\n- `0.1`: Low temperature, extremely conservative and deterministic\n- `0.5`: Medium temperature, balanced between conservative and creative\n- `1.0`: High temperature, creative and bit random\n- `1.5`: Very high temperature, extremely creative and often chaotic and unpredictable\n- `2.0`: Maximum temperature, completely random and unpredictable, for some extreme creative use cases\n\n# The assistant\n\nTake this description of the persona:\n\n> {personaDescription}",resultingParameterName:"modelsRequirements",format:"JSON",dependentParameterNames:["availableModels","personaDescription"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sources:[{type:"BOOK",path:null,content:"# Prepare Persona\n\n- PIPELINE URL `https://promptbook.studio/promptbook/prepare-persona.book`\n- INPUT PARAMETER `{availableModels}` List of available model names together with their descriptions as JSON\n- INPUT PARAMETER `{personaDescription}` Description of the persona\n- OUTPUT PARAMETER `{modelsRequirements}` Specific requirements for the model\n\n## Make modelRequirements\n\n- FORMAT JSON\n\n```markdown\nYou are an experienced AI engineer, you need to find the best models for virtual assistants:\n\n## Example\n\n\\`\\`\\`json\n[\n {\n \"modelName\": \"gpt-4o\",\n \"systemMessage\": \"You are experienced AI engineer and helpful assistant.\",\n \"temperature\": 0.7\n },\n {\n \"modelName\": \"claude-3-5-sonnet\",\n \"systemMessage\": \"You are a friendly and knowledgeable chatbot.\",\n \"temperature\": 0.5\n }\n]\n\\`\\`\\`\n\n## Instructions\n\n- Your output format is JSON array\n- Sort best-fitting models first\n- Omit any models that are not suitable\n- Write just the JSON, no other text should be present\n- Array contain items with following keys:\n - `modelName`: The name of the model to use\n - `systemMessage`: The system message to provide context to the model\n - `temperature`: The sampling temperature to use\n\n### Key `modelName`\n\nHere are the available models:\n\n\\`\\`\\`json\n{availableModels}\n\\`\\`\\`\n\n### Key `systemMessage`\n\nThe system message is used to communicate instructions or provide context to the model at the beginning of a conversation. It is displayed in a different format compared to user messages, helping the model understand its role in the conversation. The system message typically guides the model's behavior, sets the tone, or specifies desired output from the model. By utilizing the system message effectively, users can steer the model towards generating more accurate and relevant responses.\n\nFor example:\n\n> You are an experienced AI engineer and helpful assistant.\n\n> You are a friendly and knowledgeable chatbot.\n\n### Key `temperature`\n\nThe sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.\n\nYou can pick a value between 0 and 2. For example:\n\n- `0.1`: Low temperature, extremely conservative and deterministic\n- `0.5`: Medium temperature, balanced between conservative and creative\n- `1.0`: High temperature, creative and bit random\n- `1.5`: Very high temperature, extremely creative and often chaotic and unpredictable\n- `2.0`: Maximum temperature, completely random and unpredictable, for some extreme creative use cases\n\n# The assistant\n\nTake this description of the persona:\n\n> {personaDescription}\n```\n\n`-> {modelsRequirements}`\n"}],sourceFile:"./books/prepare-persona.book"},{title:"Prepare Title",pipelineUrl:"https://promptbook.studio/promptbook/prepare-title.book",formfactorName:"GENERIC",parameters:[{name:"book",description:"The book to prepare the title for",isInput:true,isOutput:false},{name:"title",description:"Best title for the book",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"make-title",title:"Make title",content:"Make best title for given text which describes the workflow:\n\n## Rules\n\n- Write just title, nothing else\n- Title should be concise and clear - Write maximum ideally 2 words, maximum 5 words\n- Title starts with emoticon\n- Title should not mention the input and output of the workflow but the main purpose of the workflow\n _For example, not \"✍ Convert Knowledge-piece to title\" but \"✍ Title\"_\n\n## The workflow\n\n> {book}",resultingParameterName:"title",expectations:{words:{min:1,max:8},lines:{min:1,max:1}},dependentParameterNames:["book"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sources:[{type:"BOOK",path:null,content:"# Prepare Title\n\n- PIPELINE URL `https://promptbook.studio/promptbook/prepare-title.book`\n- INPUT PARAMETER `{book}` The book to prepare the title for\n- OUTPUT PARAMETER `{title}` Best title for the book\n\n## Make title\n\n- EXPECT MIN 1 Word\n- EXPECT MAX 8 Words\n- EXPECT EXACTLY 1 Line\n\n```markdown\nMake best title for given text which describes the workflow:\n\n## Rules\n\n- Write just title, nothing else\n- Title should be concise and clear - Write maximum ideally 2 words, maximum 5 words\n- Title starts with emoticon\n- Title should not mention the input and output of the workflow but the main purpose of the workflow\n _For example, not \"✍ Convert Knowledge-piece to title\" but \"✍ Title\"_\n\n## The workflow\n\n> {book}\n```\n\n`-> {title}`\n"}],sourceFile:"./books/prepare-title.book"}];
@@ -7821,11 +7819,11 @@
7821
7819
  return knowledge;
7822
7820
  }
7823
7821
  }
7822
+ /** Note: [🟢] Code for Node scraper implementation [DocumentScraper](src/scrapers/document/DocumentScraper.ts) should never be published into packages that could be imported into browser environment */
7824
7823
  /**
7825
7824
  * TODO: [👣] Converted documents can act as cached items - there is no need to run conversion each time
7826
7825
  * TODO: [🪂] Do it in parallel 11:11
7827
7826
  * Note: No need to aggregate usage here, it is done by intercepting the llmTools
7828
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
7829
7827
  */
7830
7828
 
7831
7829
  /**