@promptbook/javascript 0.112.0-32 → 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 (303) hide show
  1. package/esm/index.es.js +1 -1
  2. package/esm/src/_packages/types.index.d.ts +49 -49
  3. package/esm/src/book-components/Chat/Chat/ChatInputAreaDictationPanel.d.ts +42 -0
  4. package/esm/src/book-components/Chat/Chat/ChatMessageItem.d.ts +1 -14
  5. package/esm/src/book-components/Chat/Chat/ChatMessageRichContent.d.ts +32 -0
  6. package/esm/src/book-components/Chat/Chat/ChatMessageToolCallChips.d.ts +22 -0
  7. package/esm/src/book-components/Chat/Chat/StreamingFeaturePlaceholder.d.ts +33 -0
  8. package/esm/src/book-components/Chat/Chat/createChatMessageToolCallRenderModel.d.ts +76 -0
  9. package/esm/src/book-components/Chat/Chat/createProgressCardChecklistMarkdown.d.ts +16 -0
  10. package/esm/src/book-components/Chat/Chat/renderEmailToolCallDetails.d.ts +26 -0
  11. package/esm/src/book-components/Chat/Chat/renderMemoryToolCallDetails.d.ts +31 -0
  12. package/esm/src/book-components/Chat/Chat/renderPopupToolCallDetails.d.ts +32 -0
  13. package/esm/src/book-components/Chat/Chat/renderRunBrowserToolCallDetails.d.ts +31 -0
  14. package/esm/src/book-components/Chat/Chat/renderSearchToolCallDetails.d.ts +31 -0
  15. package/esm/src/book-components/Chat/Chat/renderSelfLearningToolCallDetails.d.ts +38 -0
  16. package/esm/src/book-components/Chat/Chat/renderTimeToolCallDetails.d.ts +38 -0
  17. package/esm/src/book-components/Chat/Chat/renderTimeoutToolCallDetails.d.ts +46 -0
  18. package/esm/src/book-components/Chat/Chat/renderToolCallClockPanel.d.ts +33 -0
  19. package/esm/src/book-components/Chat/Chat/renderToolCallDetails.d.ts +2 -2
  20. package/esm/src/book-components/Chat/Chat/renderToolCallProgressPlaceholder.d.ts +29 -0
  21. package/esm/src/book-components/Chat/Chat/renderWalletCredentialToolCallDetails.d.ts +26 -0
  22. package/esm/src/book-components/Chat/Chat/resolveToolCallProgressMessage.d.ts +9 -0
  23. package/esm/src/book-components/Chat/Chat/useChatInputAreaAttachments.d.ts +32 -0
  24. package/esm/src/book-components/Chat/Chat/useChatInputAreaDictation.d.ts +76 -0
  25. package/esm/src/book-components/Chat/Chat/useChatMessageAvatarTooltip.d.ts +31 -0
  26. package/esm/src/book-components/Chat/Chat/useChatMessageSpeechPlayback.d.ts +29 -0
  27. package/esm/src/cli/$runPromptbookCli.d.ts +1 -3
  28. package/esm/src/cli/cli-commands/_boilerplate.d.ts +2 -4
  29. package/esm/src/cli/cli-commands/about.d.ts +1 -1
  30. package/esm/src/cli/cli-commands/coder/find-fresh-emoji-tags.d.ts +2 -4
  31. package/esm/src/cli/cli-commands/coder/find-refactor-candidates.d.ts +2 -4
  32. package/esm/src/cli/cli-commands/coder/generate-boilerplates.d.ts +2 -4
  33. package/esm/src/cli/cli-commands/coder/init.d.ts +2 -4
  34. package/esm/src/cli/cli-commands/coder/run.d.ts +2 -4
  35. package/esm/src/cli/cli-commands/coder/verify.d.ts +2 -4
  36. package/esm/src/cli/cli-commands/coder.d.ts +2 -4
  37. package/esm/src/cli/cli-commands/hello.d.ts +1 -1
  38. package/esm/src/cli/cli-commands/list-models.d.ts +2 -4
  39. package/esm/src/cli/cli-commands/list-scrapers.d.ts +2 -4
  40. package/esm/src/cli/cli-commands/login.d.ts +1 -1
  41. package/esm/src/cli/cli-commands/make.d.ts +1 -1
  42. package/esm/src/cli/cli-commands/prettify.d.ts +1 -1
  43. package/esm/src/cli/cli-commands/run.d.ts +1 -1
  44. package/esm/src/cli/cli-commands/runInteractiveChatbot.d.ts +1 -1
  45. package/esm/src/cli/cli-commands/start-agents-server.d.ts +2 -4
  46. package/esm/src/cli/cli-commands/start-pipelines-server.d.ts +1 -1
  47. package/esm/src/cli/cli-commands/test-command.d.ts +1 -1
  48. package/esm/src/cli/main.d.ts +2 -4
  49. package/esm/src/cli/promptbookCli.d.ts +1 -1
  50. package/esm/src/commitments/USE_BROWSER/fetchUrlContent.d.ts +1 -3
  51. package/esm/src/conversion/archive/loadArchive.d.ts +1 -3
  52. package/esm/src/conversion/archive/saveArchive.d.ts +1 -1
  53. package/esm/src/conversion/validation/_importPipeline.d.ts +2 -4
  54. package/esm/src/dialogs/simple-prompt/SimplePromptInterfaceTools.d.ts +1 -3
  55. package/esm/src/executables/$provideExecutablesForNode.d.ts +1 -1
  56. package/esm/src/executables/apps/locateLibreoffice.d.ts +2 -4
  57. package/esm/src/executables/apps/locatePandoc.d.ts +2 -4
  58. package/esm/src/executables/locateApp.d.ts +2 -4
  59. package/esm/src/executables/platforms/locateAppOnLinux.d.ts +2 -4
  60. package/esm/src/executables/platforms/locateAppOnMacOs.d.ts +2 -4
  61. package/esm/src/executables/platforms/locateAppOnWindows.d.ts +2 -4
  62. package/esm/src/execution/translation/automatic-translate/translateMessages.d.ts +2 -4
  63. package/esm/src/execution/utils/$provideExecutionToolsForNode.d.ts +2 -4
  64. package/esm/src/llm-providers/_common/register/$provideEnvFilename.d.ts +1 -3
  65. package/esm/src/llm-providers/_common/register/$provideLlmToolsConfigurationFromEnv.d.ts +1 -3
  66. package/esm/src/llm-providers/_common/register/$provideLlmToolsForWizardOrCli.d.ts +1 -1
  67. package/esm/src/llm-providers/_common/register/$provideLlmToolsFromEnv.d.ts +1 -3
  68. package/esm/src/llm-providers/_multiple/playground/playground.d.ts +1 -3
  69. package/esm/src/llm-providers/agent/playground/playground.d.ts +1 -1
  70. package/esm/src/llm-providers/anthropic-claude/playground/playground.d.ts +1 -1
  71. package/esm/src/llm-providers/azure-openai/playground/playground.d.ts +2 -4
  72. package/esm/src/llm-providers/ollama/playground/playground.d.ts +2 -4
  73. package/esm/src/llm-providers/openai/playground/playground.d.ts +2 -4
  74. package/esm/src/llm-providers/remote/playground/playground.d.ts +1 -3
  75. package/esm/src/llm-providers/vercel/playground/playground.d.ts +2 -4
  76. package/esm/src/playground/permanent/_boilerplate.d.ts +1 -3
  77. package/esm/src/playground/permanent/agent-with-browser-playground.d.ts +1 -3
  78. package/esm/src/playground/permanent/error-handling-playground.d.ts +1 -3
  79. package/esm/src/playground/playground.d.ts +2 -4
  80. package/esm/src/remote-server/startAgentServer.d.ts +1 -3
  81. package/esm/src/remote-server/startRemoteServer.d.ts +1 -2
  82. package/esm/src/scrapers/_boilerplate/BoilerplateScraper.d.ts +4 -6
  83. package/esm/src/scrapers/_boilerplate/playground/boilerplate-scraper-playground.d.ts +1 -3
  84. package/esm/src/scrapers/_common/register/$provideFilesystemForNode.d.ts +2 -4
  85. package/esm/src/scrapers/_common/register/$provideScrapersForNode.d.ts +2 -4
  86. package/esm/src/scrapers/_common/register/$provideScriptingForNode.d.ts +2 -4
  87. package/esm/src/scrapers/_common/utils/getScraperIntermediateSource.d.ts +1 -1
  88. package/esm/src/scrapers/document/DocumentScraper.d.ts +1 -1
  89. package/esm/src/scrapers/document/playground/document-scraper-playground.d.ts +1 -3
  90. package/esm/src/scrapers/document-legacy/LegacyDocumentScraper.d.ts +1 -1
  91. package/esm/src/scrapers/document-legacy/playground/legacy-document-scraper-playground.d.ts +1 -3
  92. package/esm/src/scrapers/markdown/playground/markdown-scraper-playground.d.ts +1 -3
  93. package/esm/src/scrapers/markitdown/MarkitdownScraper.d.ts +1 -1
  94. package/esm/src/scrapers/markitdown/playground/markitdown-scraper-playground.d.ts +1 -3
  95. package/esm/src/scrapers/pdf/PdfScraper.d.ts +1 -1
  96. package/esm/src/scrapers/pdf/playground/pdf-scraper-playground.d.ts +1 -3
  97. package/esm/src/scrapers/website/WebsiteScraper.d.ts +1 -1
  98. package/esm/src/scrapers/website/playground/website-scraper-playground.d.ts +1 -3
  99. package/esm/src/speech-recognition/BrowserSpeechRecognition.d.ts +2 -4
  100. package/esm/src/storage/file-cache-storage/FileCacheStorage.d.ts +2 -4
  101. package/esm/src/storage/local-storage/getIndexedDbStorage.d.ts +1 -3
  102. package/esm/src/storage/local-storage/getLocalStorage.d.ts +1 -3
  103. package/esm/src/storage/local-storage/getSessionStorage.d.ts +1 -3
  104. package/esm/src/transpilers/openai-sdk/playground/playground.d.ts +1 -3
  105. package/esm/src/types/InputParameters_private.d.ts +11 -0
  106. package/esm/src/types/Parameters_private.d.ts +16 -0
  107. package/esm/src/types/ReservedParameters_private.d.ts +10 -0
  108. package/esm/src/types/number_bytes.d.ts +21 -0
  109. package/esm/src/types/number_id.d.ts +13 -0
  110. package/esm/src/types/number_likeness.d.ts +8 -0
  111. package/esm/src/types/number_milliseconds.d.ts +33 -0
  112. package/esm/src/types/number_percent.d.ts +18 -0
  113. package/esm/src/types/number_positive.d.ts +16 -0
  114. package/esm/src/types/number_usd.d.ts +6 -106
  115. package/esm/src/types/string_agent_hash_private.d.ts +9 -0
  116. package/esm/src/types/string_agent_name_in_book_private.d.ts +8 -0
  117. package/esm/src/types/string_agent_name_private.d.ts +9 -0
  118. package/esm/src/types/string_agent_permanent_id_private.d.ts +10 -0
  119. package/esm/src/types/string_base64_private.d.ts +17 -0
  120. package/esm/src/types/string_business_category_name_private.d.ts +6 -0
  121. package/esm/src/types/string_char_private.d.ts +8 -0
  122. package/esm/src/types/string_chat_prompt_private.d.ts +9 -0
  123. package/esm/src/types/string_completion_prompt_private.d.ts +9 -0
  124. package/esm/src/types/string_email_private.d.ts +16 -0
  125. package/esm/src/types/string_host_private.d.ts +55 -0
  126. package/esm/src/types/string_mime_type_private.d.ts +17 -0
  127. package/esm/src/types/string_model_description_private.d.ts +8 -0
  128. package/esm/src/types/string_model_name_private.d.ts +8 -0
  129. package/esm/src/types/string_name_private.d.ts +9 -0
  130. package/esm/src/types/string_page_private.d.ts +9 -0
  131. package/esm/src/types/string_parameter_name.d.ts +74 -31
  132. package/esm/src/types/string_parameter_value_private.d.ts +9 -0
  133. package/esm/src/types/string_persona_description_private.d.ts +8 -0
  134. package/esm/src/types/string_prompt_image_private.d.ts +8 -0
  135. package/esm/src/types/string_prompt_private.d.ts +8 -0
  136. package/esm/src/types/string_reserved_parameter_name_private.d.ts +11 -0
  137. package/esm/src/types/string_system_message_private.d.ts +9 -0
  138. package/esm/src/types/string_template_private.d.ts +8 -0
  139. package/esm/src/types/string_text_prompt_private.d.ts +9 -0
  140. package/esm/src/types/string_title_private.d.ts +9 -0
  141. package/esm/src/types/string_url.d.ts +50 -46
  142. package/esm/src/types/string_url_private.d.ts +88 -0
  143. package/esm/src/types/typeAliases.d.ts +7 -1
  144. package/esm/src/utils/execCommand/$execCommand.d.ts +1 -3
  145. package/esm/src/utils/execCommand/$execCommands.d.ts +1 -3
  146. package/esm/src/utils/files/$induceBookDownload.d.ts +1 -3
  147. package/esm/src/utils/files/$induceFileDownload.d.ts +1 -3
  148. package/esm/src/utils/files/ObjectUrl.d.ts +1 -3
  149. package/esm/src/version.d.ts +1 -1
  150. package/esm/src/wizard/$getCompiledBook.d.ts +2 -4
  151. package/esm/src/wizard/wizard.d.ts +2 -4
  152. package/package.json +2 -2
  153. package/umd/index.umd.js +1 -1
  154. package/umd/src/_packages/types.index.d.ts +49 -49
  155. package/umd/src/book-components/Chat/Chat/ChatInputAreaDictationPanel.d.ts +42 -0
  156. package/umd/src/book-components/Chat/Chat/ChatMessageItem.d.ts +1 -14
  157. package/umd/src/book-components/Chat/Chat/ChatMessageRichContent.d.ts +32 -0
  158. package/umd/src/book-components/Chat/Chat/ChatMessageToolCallChips.d.ts +22 -0
  159. package/umd/src/book-components/Chat/Chat/StreamingFeaturePlaceholder.d.ts +33 -0
  160. package/umd/src/book-components/Chat/Chat/createChatMessageToolCallRenderModel.d.ts +76 -0
  161. package/umd/src/book-components/Chat/Chat/createProgressCardChecklistMarkdown.d.ts +16 -0
  162. package/umd/src/book-components/Chat/Chat/renderEmailToolCallDetails.d.ts +26 -0
  163. package/umd/src/book-components/Chat/Chat/renderMemoryToolCallDetails.d.ts +31 -0
  164. package/umd/src/book-components/Chat/Chat/renderPopupToolCallDetails.d.ts +32 -0
  165. package/umd/src/book-components/Chat/Chat/renderRunBrowserToolCallDetails.d.ts +31 -0
  166. package/umd/src/book-components/Chat/Chat/renderSearchToolCallDetails.d.ts +31 -0
  167. package/umd/src/book-components/Chat/Chat/renderSelfLearningToolCallDetails.d.ts +38 -0
  168. package/umd/src/book-components/Chat/Chat/renderTimeToolCallDetails.d.ts +38 -0
  169. package/umd/src/book-components/Chat/Chat/renderTimeoutToolCallDetails.d.ts +46 -0
  170. package/umd/src/book-components/Chat/Chat/renderToolCallClockPanel.d.ts +33 -0
  171. package/umd/src/book-components/Chat/Chat/renderToolCallDetails.d.ts +2 -2
  172. package/umd/src/book-components/Chat/Chat/renderToolCallProgressPlaceholder.d.ts +29 -0
  173. package/umd/src/book-components/Chat/Chat/renderWalletCredentialToolCallDetails.d.ts +26 -0
  174. package/umd/src/book-components/Chat/Chat/resolveToolCallProgressMessage.d.ts +9 -0
  175. package/umd/src/book-components/Chat/Chat/useChatInputAreaAttachments.d.ts +32 -0
  176. package/umd/src/book-components/Chat/Chat/useChatInputAreaDictation.d.ts +76 -0
  177. package/umd/src/book-components/Chat/Chat/useChatMessageAvatarTooltip.d.ts +31 -0
  178. package/umd/src/book-components/Chat/Chat/useChatMessageSpeechPlayback.d.ts +29 -0
  179. package/umd/src/cli/$runPromptbookCli.d.ts +1 -3
  180. package/umd/src/cli/cli-commands/_boilerplate.d.ts +2 -4
  181. package/umd/src/cli/cli-commands/about.d.ts +1 -1
  182. package/umd/src/cli/cli-commands/coder/find-fresh-emoji-tags.d.ts +2 -4
  183. package/umd/src/cli/cli-commands/coder/find-refactor-candidates.d.ts +2 -4
  184. package/umd/src/cli/cli-commands/coder/generate-boilerplates.d.ts +2 -4
  185. package/umd/src/cli/cli-commands/coder/init.d.ts +2 -4
  186. package/umd/src/cli/cli-commands/coder/run.d.ts +2 -4
  187. package/umd/src/cli/cli-commands/coder/verify.d.ts +2 -4
  188. package/umd/src/cli/cli-commands/coder.d.ts +2 -4
  189. package/umd/src/cli/cli-commands/hello.d.ts +1 -1
  190. package/umd/src/cli/cli-commands/list-models.d.ts +2 -4
  191. package/umd/src/cli/cli-commands/list-scrapers.d.ts +2 -4
  192. package/umd/src/cli/cli-commands/login.d.ts +1 -1
  193. package/umd/src/cli/cli-commands/make.d.ts +1 -1
  194. package/umd/src/cli/cli-commands/prettify.d.ts +1 -1
  195. package/umd/src/cli/cli-commands/run.d.ts +1 -1
  196. package/umd/src/cli/cli-commands/runInteractiveChatbot.d.ts +1 -1
  197. package/umd/src/cli/cli-commands/start-agents-server.d.ts +2 -4
  198. package/umd/src/cli/cli-commands/start-pipelines-server.d.ts +1 -1
  199. package/umd/src/cli/cli-commands/test-command.d.ts +1 -1
  200. package/umd/src/cli/main.d.ts +2 -4
  201. package/umd/src/cli/promptbookCli.d.ts +1 -1
  202. package/umd/src/commitments/USE_BROWSER/fetchUrlContent.d.ts +1 -3
  203. package/umd/src/conversion/archive/loadArchive.d.ts +1 -3
  204. package/umd/src/conversion/archive/saveArchive.d.ts +1 -1
  205. package/umd/src/conversion/validation/_importPipeline.d.ts +2 -4
  206. package/umd/src/dialogs/simple-prompt/SimplePromptInterfaceTools.d.ts +1 -3
  207. package/umd/src/executables/$provideExecutablesForNode.d.ts +1 -1
  208. package/umd/src/executables/apps/locateLibreoffice.d.ts +2 -4
  209. package/umd/src/executables/apps/locatePandoc.d.ts +2 -4
  210. package/umd/src/executables/locateApp.d.ts +2 -4
  211. package/umd/src/executables/platforms/locateAppOnLinux.d.ts +2 -4
  212. package/umd/src/executables/platforms/locateAppOnMacOs.d.ts +2 -4
  213. package/umd/src/executables/platforms/locateAppOnWindows.d.ts +2 -4
  214. package/umd/src/execution/translation/automatic-translate/translateMessages.d.ts +2 -4
  215. package/umd/src/execution/utils/$provideExecutionToolsForNode.d.ts +2 -4
  216. package/umd/src/llm-providers/_common/register/$provideEnvFilename.d.ts +1 -3
  217. package/umd/src/llm-providers/_common/register/$provideLlmToolsConfigurationFromEnv.d.ts +1 -3
  218. package/umd/src/llm-providers/_common/register/$provideLlmToolsForWizardOrCli.d.ts +1 -1
  219. package/umd/src/llm-providers/_common/register/$provideLlmToolsFromEnv.d.ts +1 -3
  220. package/umd/src/llm-providers/_multiple/playground/playground.d.ts +1 -3
  221. package/umd/src/llm-providers/agent/playground/playground.d.ts +1 -1
  222. package/umd/src/llm-providers/anthropic-claude/playground/playground.d.ts +1 -1
  223. package/umd/src/llm-providers/azure-openai/playground/playground.d.ts +2 -4
  224. package/umd/src/llm-providers/ollama/playground/playground.d.ts +2 -4
  225. package/umd/src/llm-providers/openai/playground/playground.d.ts +2 -4
  226. package/umd/src/llm-providers/remote/playground/playground.d.ts +1 -3
  227. package/umd/src/llm-providers/vercel/playground/playground.d.ts +2 -4
  228. package/umd/src/playground/permanent/_boilerplate.d.ts +1 -3
  229. package/umd/src/playground/permanent/agent-with-browser-playground.d.ts +1 -3
  230. package/umd/src/playground/permanent/error-handling-playground.d.ts +1 -3
  231. package/umd/src/playground/playground.d.ts +2 -4
  232. package/umd/src/remote-server/startAgentServer.d.ts +1 -3
  233. package/umd/src/remote-server/startRemoteServer.d.ts +1 -2
  234. package/umd/src/scrapers/_boilerplate/BoilerplateScraper.d.ts +4 -6
  235. package/umd/src/scrapers/_boilerplate/playground/boilerplate-scraper-playground.d.ts +1 -3
  236. package/umd/src/scrapers/_common/register/$provideFilesystemForNode.d.ts +2 -4
  237. package/umd/src/scrapers/_common/register/$provideScrapersForNode.d.ts +2 -4
  238. package/umd/src/scrapers/_common/register/$provideScriptingForNode.d.ts +2 -4
  239. package/umd/src/scrapers/_common/utils/getScraperIntermediateSource.d.ts +1 -1
  240. package/umd/src/scrapers/document/DocumentScraper.d.ts +1 -1
  241. package/umd/src/scrapers/document/playground/document-scraper-playground.d.ts +1 -3
  242. package/umd/src/scrapers/document-legacy/LegacyDocumentScraper.d.ts +1 -1
  243. package/umd/src/scrapers/document-legacy/playground/legacy-document-scraper-playground.d.ts +1 -3
  244. package/umd/src/scrapers/markdown/playground/markdown-scraper-playground.d.ts +1 -3
  245. package/umd/src/scrapers/markitdown/MarkitdownScraper.d.ts +1 -1
  246. package/umd/src/scrapers/markitdown/playground/markitdown-scraper-playground.d.ts +1 -3
  247. package/umd/src/scrapers/pdf/PdfScraper.d.ts +1 -1
  248. package/umd/src/scrapers/pdf/playground/pdf-scraper-playground.d.ts +1 -3
  249. package/umd/src/scrapers/website/WebsiteScraper.d.ts +1 -1
  250. package/umd/src/scrapers/website/playground/website-scraper-playground.d.ts +1 -3
  251. package/umd/src/speech-recognition/BrowserSpeechRecognition.d.ts +2 -4
  252. package/umd/src/storage/file-cache-storage/FileCacheStorage.d.ts +2 -4
  253. package/umd/src/storage/local-storage/getIndexedDbStorage.d.ts +1 -3
  254. package/umd/src/storage/local-storage/getLocalStorage.d.ts +1 -3
  255. package/umd/src/storage/local-storage/getSessionStorage.d.ts +1 -3
  256. package/umd/src/transpilers/openai-sdk/playground/playground.d.ts +1 -3
  257. package/umd/src/types/InputParameters_private.d.ts +11 -0
  258. package/umd/src/types/Parameters_private.d.ts +16 -0
  259. package/umd/src/types/ReservedParameters_private.d.ts +10 -0
  260. package/umd/src/types/number_bytes.d.ts +21 -0
  261. package/umd/src/types/number_id.d.ts +13 -0
  262. package/umd/src/types/number_likeness.d.ts +8 -0
  263. package/umd/src/types/number_milliseconds.d.ts +33 -0
  264. package/umd/src/types/number_percent.d.ts +18 -0
  265. package/umd/src/types/number_positive.d.ts +16 -0
  266. package/umd/src/types/number_usd.d.ts +6 -106
  267. package/umd/src/types/string_agent_hash_private.d.ts +9 -0
  268. package/umd/src/types/string_agent_name_in_book_private.d.ts +8 -0
  269. package/umd/src/types/string_agent_name_private.d.ts +9 -0
  270. package/umd/src/types/string_agent_permanent_id_private.d.ts +10 -0
  271. package/umd/src/types/string_base64_private.d.ts +17 -0
  272. package/umd/src/types/string_business_category_name_private.d.ts +6 -0
  273. package/umd/src/types/string_char_private.d.ts +8 -0
  274. package/umd/src/types/string_chat_prompt_private.d.ts +9 -0
  275. package/umd/src/types/string_completion_prompt_private.d.ts +9 -0
  276. package/umd/src/types/string_email_private.d.ts +16 -0
  277. package/umd/src/types/string_host_private.d.ts +55 -0
  278. package/umd/src/types/string_mime_type_private.d.ts +17 -0
  279. package/umd/src/types/string_model_description_private.d.ts +8 -0
  280. package/umd/src/types/string_model_name_private.d.ts +8 -0
  281. package/umd/src/types/string_name_private.d.ts +9 -0
  282. package/umd/src/types/string_page_private.d.ts +9 -0
  283. package/umd/src/types/string_parameter_name.d.ts +74 -31
  284. package/umd/src/types/string_parameter_value_private.d.ts +9 -0
  285. package/umd/src/types/string_persona_description_private.d.ts +8 -0
  286. package/umd/src/types/string_prompt_image_private.d.ts +8 -0
  287. package/umd/src/types/string_prompt_private.d.ts +8 -0
  288. package/umd/src/types/string_reserved_parameter_name_private.d.ts +11 -0
  289. package/umd/src/types/string_system_message_private.d.ts +9 -0
  290. package/umd/src/types/string_template_private.d.ts +8 -0
  291. package/umd/src/types/string_text_prompt_private.d.ts +9 -0
  292. package/umd/src/types/string_title_private.d.ts +9 -0
  293. package/umd/src/types/string_url.d.ts +50 -46
  294. package/umd/src/types/string_url_private.d.ts +88 -0
  295. package/umd/src/types/typeAliases.d.ts +7 -1
  296. package/umd/src/utils/execCommand/$execCommand.d.ts +1 -3
  297. package/umd/src/utils/execCommand/$execCommands.d.ts +1 -3
  298. package/umd/src/utils/files/$induceBookDownload.d.ts +1 -3
  299. package/umd/src/utils/files/$induceFileDownload.d.ts +1 -3
  300. package/umd/src/utils/files/ObjectUrl.d.ts +1 -3
  301. package/umd/src/version.d.ts +1 -1
  302. package/umd/src/wizard/$getCompiledBook.d.ts +2 -4
  303. package/umd/src/wizard/wizard.d.ts +2 -4
@@ -11,8 +11,8 @@ import type { string_filename } from '../../types/typeAliases';
11
11
  * @private utility of Promptbook
12
12
  */
13
13
  export declare function saveArchive(filePath: string_filename, collectionJson: ReadonlyArray<PipelineJson>, fs: FilesystemTools): Promise<void>;
14
+ /** Note: [🟢] Code for Node archive helper [saveArchive](src/conversion/archive/saveArchive.ts) should never be published into packages that could be imported into browser environment */
14
15
  /**
15
16
  * TODO: Add metadata to zip
16
17
  * TODO: Compression level and other zip options from config
17
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
18
18
  */
@@ -17,7 +17,5 @@ export declare function importPipelineWithoutPreparation(path: `${string}.bookc`
17
17
  * @private internal function of tests
18
18
  */
19
19
  export declare function importPipelineJson(path: `${string}.bookc`): Promise<PipelineJson>;
20
- /**
21
- * Note: [💞] Ignore a discrepancy between file name and entity name
22
- * Note: [⚫] Code in this file should never be published in any package
23
- */
20
+ /** Note: [⚫] Code for private pipeline import shim [_importPipeline](src/conversion/validation/_importPipeline.ts) should never be published in any package */
21
+ /** Note: [💞] Ignore a discrepancy between file name and entity name */
@@ -17,6 +17,4 @@ export declare class SimplePromptInterfaceTools implements UserInterfaceTools {
17
17
  */
18
18
  promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
19
19
  }
20
- /**
21
- * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
22
- */
20
+ /** Note: [🔵] Code for browser dialog helper [SimplePromptInterfaceTools](src/dialogs/simple-prompt/SimplePromptInterfaceTools.ts) should never be published outside of `@promptbook/browser` */
@@ -6,8 +6,8 @@ import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions
6
6
  * @public exported from `@promptbook/node`
7
7
  */
8
8
  export declare function $provideExecutablesForNode(options?: PrepareAndScrapeOptions): Promise<Executables>;
9
+ /** Note: [🟢] Code for Node executable locator [$provideExecutablesForNode](src/executables/$provideExecutablesForNode.ts) should never be published into packages that could be imported into browser environment */
9
10
  /**
10
11
  * TODO: [🧠] Allow to override the executables without need to call `locatePandoc` / `locateLibreoffice` in case of provided
11
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
12
12
  * TODO: [🏓] Unite `xxxForServer` and `xxxForNode` naming
13
13
  */
@@ -6,7 +6,5 @@ import type { string_executable_path } from '../../types/typeAliases';
6
6
  * @private within the repository
7
7
  */
8
8
  export declare function locateLibreoffice(): Promise<string_executable_path | null>;
9
- /**
10
- * TODO: [🧠][♿] Maybe export through `@promptbook/node` OR `@promptbook/legacy-documents`
11
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
12
- */
9
+ /** Note: [🟢] Code for Node executable locator [locateLibreoffice](src/executables/apps/locateLibreoffice.ts) should never be published into packages that could be imported into browser environment */
10
+ /** TODO: [🧠][♿] Maybe export through `@promptbook/node` OR `@promptbook/legacy-documents` */
@@ -6,7 +6,5 @@ import type { string_executable_path } from '../../types/typeAliases';
6
6
  * @private within the repository
7
7
  */
8
8
  export declare function locatePandoc(): Promise<string_executable_path | null>;
9
- /**
10
- * TODO: [🧠][♿] Maybe export through `@promptbook/node` OR `@promptbook/documents`
11
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
12
- */
9
+ /** Note: [🟢] Code for Node executable locator [locatePandoc](src/executables/apps/locatePandoc.ts) should never be published into packages that could be imported into browser environment */
10
+ /** TODO: [🧠][♿] Maybe export through `@promptbook/node` OR `@promptbook/documents` */
@@ -27,7 +27,5 @@ export type LocateAppOptions = {
27
27
  * @private within the repository
28
28
  */
29
29
  export declare function locateApp(options: RequireAtLeastOne<LocateAppOptions, 'linuxWhich' | 'windowsSuffix' | 'macOsName'>): Promise<string_executable_path | null>;
30
- /**
31
- * TODO: [🧠][♿] Maybe export through `@promptbook/node`
32
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
33
- */
30
+ /** Note: [🟢] Code for Node executable locator [locateApp](src/executables/locateApp.ts) should never be published into packages that could be imported into browser environment */
31
+ /** TODO: [🧠][♿] Maybe export through `@promptbook/node` */
@@ -7,7 +7,5 @@ import type { LocateAppOptions } from '../locateApp';
7
7
  * @private within the repository
8
8
  */
9
9
  export declare function locateAppOnLinux({ linuxWhich, }: Pick<Required<LocateAppOptions>, 'linuxWhich'>): Promise<string_executable_path | null>;
10
- /**
11
- * TODO: [🧠][♿] Maybe export through `@promptbook/node`
12
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
13
- */
10
+ /** Note: [🟢] Code for Node executable locator [locateAppOnLinux](src/executables/platforms/locateAppOnLinux.ts) should never be published into packages that could be imported into browser environment */
11
+ /** TODO: [🧠][♿] Maybe export through `@promptbook/node` */
@@ -7,7 +7,5 @@ import type { LocateAppOptions } from '../locateApp';
7
7
  * @private within the repository
8
8
  */
9
9
  export declare function locateAppOnMacOs({ macOsName, }: Pick<Required<LocateAppOptions>, 'macOsName'>): Promise<string_executable_path | null>;
10
- /**
11
- * TODO: [🧠][♿] Maybe export through `@promptbook/node`
12
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
13
- */
10
+ /** Note: [🟢] Code for Node executable locator [locateAppOnMacOs](src/executables/platforms/locateAppOnMacOs.ts) should never be published into packages that could be imported into browser environment */
11
+ /** TODO: [🧠][♿] Maybe export through `@promptbook/node` */
@@ -7,7 +7,5 @@ import type { LocateAppOptions } from '../locateApp';
7
7
  * @private within the repository
8
8
  */
9
9
  export declare function locateAppOnWindows({ appName, windowsSuffix, }: Pick<Required<LocateAppOptions>, 'appName' | 'windowsSuffix'>): Promise<string_executable_path | null>;
10
- /**
11
- * TODO: [🧠][♿] Maybe export through `@promptbook/node`
12
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
13
- */
10
+ /** Note: [🟢] Code for Node executable locator [locateAppOnWindows](src/executables/platforms/locateAppOnWindows.ts) should never be published into packages that could be imported into browser environment */
11
+ /** TODO: [🧠][♿] Maybe export through `@promptbook/node` */
@@ -6,7 +6,5 @@ import type { TranslatorOptions } from './automatic-translators/TranslatorOption
6
6
  export declare function translateMessages({ automaticTranslator, from, to, }: {
7
7
  automaticTranslator: AutomaticTranslator;
8
8
  } & TranslatorOptions): Promise<void>;
9
- /**
10
- * TODO: [😶] Unite folder listing
11
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
12
- */
9
+ /** Note: [🟢] Code for Node translation helper [translateMessages](src/execution/translation/automatic-translate/translateMessages.ts) should never be published into packages that could be imported into browser environment */
10
+ /** TODO: [😶] Unite folder listing */
@@ -8,7 +8,5 @@ import type { ExecutionTools } from '../ExecutionTools';
8
8
  * @public exported from `@promptbook/node`
9
9
  */
10
10
  export declare function $provideExecutionToolsForNode(options?: PrepareAndScrapeOptions): Promise<ExecutionTools>;
11
- /**
12
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
13
- * TODO: [🏓] Unite `xxxForServer` and `xxxForNode` naming
14
- */
11
+ /** Note: [🟢] Code for Node execution helper [$provideExecutionToolsForNode](src/execution/utils/$provideExecutionToolsForNode.ts) should never be published into packages that could be imported into browser environment */
12
+ /** TODO: [🏓] Unite `xxxForServer` and `xxxForNode` naming */
@@ -7,6 +7,4 @@ import type { string_filename } from '../../../types/typeAliases';
7
7
  * @private within the repository - for CLI utils
8
8
  */
9
9
  export declare function $provideEnvFilename(): Promise<string_filename | null>;
10
- /**
11
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
12
- */
10
+ /** Note: [🟢] Code for Node environment helper [$provideEnvFilename](src/llm-providers/_common/register/$provideEnvFilename.ts) should never be published into packages that could be imported into browser environment */
@@ -14,6 +14,4 @@ import type { LlmToolsConfiguration } from './LlmToolsConfiguration';
14
14
  * @public exported from `@promptbook/node`
15
15
  */
16
16
  export declare function $provideLlmToolsConfigurationFromEnv(): Promise<LlmToolsConfiguration>;
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 environment helper [$provideLlmToolsConfigurationFromEnv](src/llm-providers/_common/register/$provideLlmToolsConfigurationFromEnv.ts) should never be published into packages that could be imported into browser environment */
@@ -49,8 +49,8 @@ type ProvideLlmToolsForWizardOrCliOptions = {
49
49
  */
50
50
  export declare function $provideLlmToolsForWizardOrCli(options?: ProvideLlmToolsForWizardOrCliOptions): Promise<LlmExecutionToolsWithTotalUsage>;
51
51
  export {};
52
+ /** Note: [🟢] Code for Node environment helper [$provideLlmToolsForWizardOrCli](src/llm-providers/_common/register/$provideLlmToolsForWizardOrCli.ts) should never be published into packages that could be imported into browser environment */
52
53
  /**
53
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
54
54
  * TODO: [👷‍♂️] Write a comprehensive manual about the construction of LLM tools
55
55
  * TODO: [🥃] Allow `ptbk make` without llm tools
56
56
  * TODO: This should be maybe not under `_common` but under `utils-internal` / `utils/internal`
@@ -21,20 +21,18 @@ import type { CreateLlmToolsFromConfigurationOptions } from './createLlmToolsFro
21
21
  * @public exported from `@promptbook/node`
22
22
  */
23
23
  export declare function $provideLlmToolsFromEnv(options?: CreateLlmToolsFromConfigurationOptions): Promise<MultipleLlmExecutionTools>;
24
+ /** Note: [🟢] Code for Node environment helper [$provideLlmToolsFromEnv](src/llm-providers/_common/register/$provideLlmToolsFromEnv.ts) should never be published into packages that could be imported into browser environment */
24
25
  /**
25
26
  * TODO: The architecture for LLM tools configuration consists of three key functions:
26
27
  * 1. `$provideLlmToolsFromEnv` - High-level function that detects available providers from env vars and returns ready-to-use LLM tools
27
28
  * 2. `$provideLlmToolsConfigurationFromEnv` - Middle layer that extracts configuration objects from environment variables
28
29
  * 3. `createLlmToolsFromConfiguration` - Low-level function that instantiates LLM tools from explicit configuration
29
- *
30
30
  * This layered approach allows flexibility in how tools are configured:
31
31
  * - Use $provideLlmToolsFromEnv for automatic detection and setup in Node.js environments
32
32
  * - Use $provideLlmToolsConfigurationFromEnv to extract config objects for modification before instantiation
33
33
  * - Use createLlmToolsFromConfiguration for explicit control over tool configurations
34
- *
35
34
  * TODO: [🧠][🍛] Which name is better `$provideLlmToolsFromEnv` or `$provideLlmToolsFromEnvironment`?
36
35
  * TODO: [🧠] Is there some meaningfull way how to test this util
37
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
38
36
  * TODO: [🥃] Allow `ptbk make` without llm tools
39
37
  * TODO: This should be maybe not under `_common` but under `utils`
40
38
  * TODO: [®] DRY Register logic
@@ -1,5 +1,3 @@
1
1
  #!/usr/bin/env ts-node
2
2
  export {};
3
- /**
4
- * Note: [⚫] Code in this file should never be published in any package
5
- */
3
+ /** Note: [⚫] Code for playground [_multiple playground](src/llm-providers/_multiple/playground/playground.ts) should never be published in any package */
@@ -1,8 +1,8 @@
1
1
  #!/usr/bin/env ts-node
2
2
  export {};
3
+ /** Note: [⚫] Code for playground [agent playground](src/llm-providers/agent/playground/playground.ts) should never be published in any package */
3
4
  /**
4
5
  * TODO: [🧠] Add more complex agent scenarios
5
6
  * TODO: [🧠] Add parameter substitution demo
6
7
  * TODO: [🧠] Add multi-turn conversation demo
7
- * Note: [⚫] Code in this file should never be published in any package
8
8
  */
@@ -1,7 +1,7 @@
1
1
  #!/usr/bin/env ts-node
2
2
  export {};
3
+ /** Note: [⚫] Code for playground [anthropic-claude playground](src/llm-providers/anthropic-claude/playground/playground.ts) should never be published in any package */
3
4
  /**
4
5
  * TODO: [main] !!3 Playground with WebGPT / Promptbook.studio anonymous server
5
6
  * TODO: [main] !!3 Test here that `systemMessage`, `temperature` and `seed` are working correctly
6
- * Note: [⚫] Code in this file should never be published in any package
7
7
  */
@@ -1,6 +1,4 @@
1
1
  #!/usr/bin/env ts-node
2
2
  export {};
3
- /**
4
- * TODO: Test here that `systemMessage`, `temperature` and `seed` are working correctly
5
- * Note: [⚫] Code in this file should never be published in any package
6
- */
3
+ /** Note: [⚫] Code for playground [azure-openai playground](src/llm-providers/azure-openai/playground/playground.ts) should never be published in any package */
4
+ /** TODO: Test here that `systemMessage`, `temperature` and `seed` are working correctly */
@@ -1,6 +1,4 @@
1
1
  #!/usr/bin/env ts-node
2
2
  export {};
3
- /**
4
- * TODO: [main] !!3 Test here that `systemMessage`, `temperature` and `seed` are working correctly
5
- * Note: [⚫] Code in this file should never be published in any package
6
- */
3
+ /** Note: [⚫] Code for playground [ollama playground](src/llm-providers/ollama/playground/playground.ts) should never be published in any package */
4
+ /** TODO: [main] !!3 Test here that `systemMessage`, `temperature` and `seed` are working correctly */
@@ -1,6 +1,4 @@
1
1
  #!/usr/bin/env ts-node
2
2
  export {};
3
- /**
4
- * TODO: [main] !!3 Test here that `systemMessage`, `temperature` and `seed` are working correctly
5
- * Note: [⚫] Code in this file should never be published in any package
6
- */
3
+ /** Note: [⚫] Code for playground [openai playground](src/llm-providers/openai/playground/playground.ts) should never be published in any package */
4
+ /** TODO: [main] !!3 Test here that `systemMessage`, `temperature` and `seed` are working correctly */
@@ -1,5 +1,3 @@
1
1
  #!/usr/bin/env ts-node
2
2
  import '../../openai/register-constructor';
3
- /**
4
- * Note: [⚫] Code in this file should never be published in any package
5
- */
3
+ /** Note: [⚫] Code for playground [remote playground](src/llm-providers/remote/playground/playground.ts) should never be published in any package */
@@ -1,6 +1,4 @@
1
1
  #!/usr/bin/env ts-node
2
2
  export {};
3
- /**
4
- * TODO: [main] !!3 Test here that `systemMessage`, `temperature` and `seed` are working correctly
5
- * Note: [⚫] Code in this file should never be published in any package
6
- */
3
+ /** Note: [⚫] Code for playground [vercel playground](src/llm-providers/vercel/playground/playground.ts) should never be published in any package */
4
+ /** TODO: [main] !!3 Test here that `systemMessage`, `temperature` and `seed` are working correctly */
@@ -1,5 +1,3 @@
1
1
  #!/usr/bin/env ts-node
2
2
  export {};
3
- /**
4
- * Note: [⚫] Code in this file should never be published in any package
5
- */
3
+ /** Note: [⚫] Code for permanent playground [_boilerplate](src/playground/permanent/_boilerplate.ts) should never be published in any package */
@@ -1,5 +1,3 @@
1
1
  #!/usr/bin/env ts-node
2
2
  export {};
3
- /**
4
- * Note: [⚫] Code in this file should never be published in any package
5
- */
3
+ /** Note: [⚫] Code for permanent playground [agent-with-browser-playground](src/playground/permanent/agent-with-browser-playground.ts) should never be published in any package */
@@ -1,5 +1,3 @@
1
1
  #!/usr/bin/env ts-node
2
2
  export {};
3
- /**
4
- * Note: [⚫] Code in this file should never be published in any package
5
- */
3
+ /** Note: [⚫] Code for permanent playground [error-handling-playground](src/playground/permanent/error-handling-playground.ts) should never be published in any package */
@@ -1,6 +1,4 @@
1
1
  #!/usr/bin/env ts-node
2
2
  export {};
3
- /**
4
- * TODO: !!!!!!! Extract to `other` and append DigitalOcean instructions
5
- * Note: [⚫] Code in this file should never be published in any package
6
- */
3
+ /** Note: [⚫] Code for playground [main playground](src/playground/playground.ts) should never be published in any package */
4
+ /** TODO: !!!!!!! Extract to `other` and append DigitalOcean instructions */
@@ -21,6 +21,4 @@ type AgentsServerOptions = {
21
21
  */
22
22
  export declare function startAgentServer(options: AgentsServerOptions): Promise<TODO_any>;
23
23
  export {};
24
- /**
25
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
26
- */
24
+ /** Note: [🟢] Code for Node server bootstrap [startAgentServer](src/remote-server/startAgentServer.ts) should never be published into packages that could be imported into browser environment */
@@ -10,8 +10,8 @@ import type { RemoteServerOptions } from './types/RemoteServerOptions';
10
10
  * @public exported from `@promptbook/remote-server`
11
11
  */
12
12
  export declare function startRemoteServer<TCustomOptions = undefined>(options: RemoteServerOptions<TCustomOptions>): RemoteServer;
13
+ /** Note: [🟢] Code for Node server bootstrap [startRemoteServer](src/remote-server/startRemoteServer.ts) should never be published into packages that could be imported into browser environment */
13
14
  /**
14
-
15
15
  * TODO: [🕋] Use here `aboutPromptbookInformation`
16
16
  * TODO: [🌡] Add CORS and security - probably via `helmet`
17
17
  * TODO: Split this file into multiple functions - handler for each request
@@ -24,5 +24,4 @@ export declare function startRemoteServer<TCustomOptions = undefined>(options: R
24
24
  * TODO: [🃏] Pass here some security token to prevent malitious usage and/or DDoS
25
25
  * TODO: [0] Set unavailable models as undefined in `RemoteLlmExecutionTools` NOT throw error here
26
26
  * TODO: Allow to constrain anonymous mode for specific models / providers
27
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
28
27
  */
@@ -34,9 +34,7 @@ export declare class BoilerplateScraper implements Converter, Scraper {
34
34
  */
35
35
  scrape(source: ScraperSourceHandler): Promise<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
36
36
  }
37
- /**
38
- * TODO: [👣] Converted documents can act as cached items - there is no need to run conversion each time
39
- * TODO: [🪂] Do it in parallel
40
- * Note: No need to aggregate usage here, it is done by intercepting the llmTools
41
- * @@ Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
42
- */
37
+ /** TODO: [👣] Converted documents can act as cached items - there is no need to run conversion each time */
38
+ /** TODO: [🪂] Do it in parallel */
39
+ /** Note: No need to aggregate usage here, it is done by intercepting the llmTools */
40
+ /** Note: [🟢] Code for Node scraper boilerplate [BoilerplateScraper](src/scrapers/_boilerplate/BoilerplateScraper.ts) should never be published into packages that could be imported into browser environment */
@@ -1,5 +1,3 @@
1
1
  #!/usr/bin/env ts-node
2
2
  export {};
3
- /**
4
- * Note: [⚫] Code in this file should never be published in any package
5
- */
3
+ /** Note: [⚫] Code for playground [boilerplate-scraper-playground](src/scrapers/_boilerplate/playground/boilerplate-scraper-playground.ts) should never be published in any package */
@@ -7,7 +7,5 @@ import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeO
7
7
  * @public exported from `@promptbook/node`
8
8
  */
9
9
  export declare function $provideFilesystemForNode(options?: Pick<PrepareAndScrapeOptions, 'isVerbose'>): FilesystemTools;
10
- /**
11
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
12
- * TODO: [🏓] Unite `xxxForServer` and `xxxForNode` naming
13
- */
10
+ /** Note: [🟢] Code for Node scraper registration helper [$provideFilesystemForNode](src/scrapers/_common/register/$provideFilesystemForNode.ts) should never be published into packages that could be imported into browser environment */
11
+ /** TODO: [🏓] Unite `xxxForServer` and `xxxForNode` naming */
@@ -8,7 +8,5 @@ import type { Scraper } from '../Scraper';
8
8
  * @public exported from `@promptbook/node`
9
9
  */
10
10
  export declare function $provideScrapersForNode(tools: Pick<ExecutionTools, 'fs' | 'llm' | 'executables'>, options?: PrepareAndScrapeOptions): Promise<ReadonlyArray<Scraper>>;
11
- /**
12
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
13
- * TODO: [🏓] Unite `xxxForServer` and `xxxForNode` naming
14
- */
11
+ /** Note: [🟢] Code for Node scraper registration helper [$provideScrapersForNode](src/scrapers/_common/register/$provideScrapersForNode.ts) should never be published into packages that could be imported into browser environment */
12
+ /** TODO: [🏓] Unite `xxxForServer` and `xxxForNode` naming */
@@ -6,7 +6,5 @@ import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeO
6
6
  * @public exported from `@promptbook/node`
7
7
  */
8
8
  export declare function $provideScriptingForNode(options?: PrepareAndScrapeOptions): Promise<ReadonlyArray<ScriptExecutionTools>>;
9
- /**
10
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
11
- * TODO: [🏓] Unite `xxxForServer` and `xxxForNode` naming
12
- */
9
+ /** Note: [🟢] Code for Node scraper registration helper [$provideScriptingForNode](src/scrapers/_common/register/$provideScriptingForNode.ts) should never be published into packages that could be imported into browser environment */
10
+ /** TODO: [🏓] Unite `xxxForServer` and `xxxForNode` naming */
@@ -26,10 +26,10 @@ type GetScraperIntermediateSourceHandler = Required<Pick<PrepareAndScrapeOptions
26
26
  */
27
27
  export declare function getScraperIntermediateSource(source: GetScraperIntermediateSourceSource, options: GetScraperIntermediateSourceHandler): Promise<ScraperIntermediateSource>;
28
28
  export {};
29
+ /** 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 */
29
30
  /**
30
31
  * Note: Not using `FileCacheStorage` for two reasons:
31
32
  * 1) Need to store more than serialized JSONs
32
33
  * 2) Need to switch between a `rootDirname` and `cacheDirname` <- TODO: [😡]
33
34
  * TODO: [🐱‍🐉][🧠] Make some smart crop
34
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
35
35
  */
@@ -34,9 +34,9 @@ export declare class DocumentScraper implements Converter, Scraper {
34
34
  */
35
35
  scrape(source: ScraperSourceHandler): Promise<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
36
36
  }
37
+ /** 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 */
37
38
  /**
38
39
  * TODO: [👣] Converted documents can act as cached items - there is no need to run conversion each time
39
40
  * TODO: [🪂] Do it in parallel 11:11
40
41
  * Note: No need to aggregate usage here, it is done by intercepting the llmTools
41
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
42
42
  */
@@ -1,5 +1,3 @@
1
1
  #!/usr/bin/env ts-node
2
2
  export {};
3
- /**
4
- * Note: [⚫] Code in this file should never be published in any package
5
- */
3
+ /** Note: [⚫] Code for playground [document-scraper-playground](src/scrapers/document/playground/document-scraper-playground.ts) should never be published in any package */
@@ -34,9 +34,9 @@ export declare class LegacyDocumentScraper implements Converter, Scraper {
34
34
  */
35
35
  scrape(source: ScraperSourceHandler): Promise<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
36
36
  }
37
+ /** Note: [🟢] Code for Node scraper implementation [LegacyDocumentScraper](src/scrapers/document-legacy/LegacyDocumentScraper.ts) should never be published into packages that could be imported into browser environment */
37
38
  /**
38
39
  * TODO: [👣] Converted documents can act as cached items - there is no need to run conversion each time
39
40
  * TODO: [🪂] Do it in parallel 11:11
40
41
  * Note: No need to aggregate usage here, it is done by intercepting the llmTools
41
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
42
42
  */
@@ -1,5 +1,3 @@
1
1
  #!/usr/bin/env ts-node
2
2
  export {};
3
- /**
4
- * Note: [⚫] Code in this file should never be published in any package
5
- */
3
+ /** Note: [⚫] Code for playground [legacy-document-scraper-playground](src/scrapers/document-legacy/playground/legacy-document-scraper-playground.ts) should never be published in any package */
@@ -1,5 +1,3 @@
1
1
  #!/usr/bin/env ts-node
2
2
  export {};
3
- /**
4
- * Note: [⚫] Code in this file should never be published in any package
5
- */
3
+ /** Note: [⚫] Code for playground [markdown-scraper-playground](src/scrapers/markdown/playground/markdown-scraper-playground.ts) should never be published in any package */
@@ -41,10 +41,10 @@ export declare class MarkitdownScraper implements Converter, Scraper {
41
41
  */
42
42
  scrape(source: ScraperSourceHandler): Promise<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
43
43
  }
44
+ /** Note: [🟢] Code for Node scraper implementation [MarkitdownScraper](src/scrapers/markitdown/MarkitdownScraper.ts) should never be published into packages that could be imported into browser environment */
44
45
  /**
45
46
  * TODO: [🧠][🌜] Export only from `@promptbook/markitdown` or `@promptbook/pdf` NOT both
46
47
  * TODO: [👣] Converted documents can act as cached items - there is no need to run conversion each time
47
48
  * TODO: [🪂] Do it in parallel
48
49
  * Note: No need to aggregate usage here, it is done by intercepting the llmTools
49
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
50
50
  */
@@ -1,5 +1,3 @@
1
1
  #!/usr/bin/env ts-node
2
2
  export {};
3
- /**
4
- * Note: [⚫] Code in this file should never be published in any package
5
- */
3
+ /** Note: [⚫] Code for playground [markitdown-scraper-playground](src/scrapers/markitdown/playground/markitdown-scraper-playground.ts) should never be published in any package */
@@ -33,9 +33,9 @@ export declare class PdfScraper implements Converter, Scraper {
33
33
  */
34
34
  scrape(source: ScraperSourceHandler): Promise<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
35
35
  }
36
+ /** Note: [🟢] Code for Node scraper implementation [PdfScraper](src/scrapers/pdf/PdfScraper.ts) should never be published into packages that could be imported into browser environment */
36
37
  /**
37
38
  * TODO: [👣] Converted pdf documents can act as cached items - there is no need to run conversion each time
38
39
  * TODO: [🪂] Do it in parallel 11:11
39
40
  * Note: No need to aggregate usage here, it is done by intercepting the llmTools
40
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
41
41
  */
@@ -1,5 +1,3 @@
1
1
  #!/usr/bin/env ts-node
2
2
  export {};
3
- /**
4
- * Note: [⚫] Code in this file should never be published in any package
5
- */
3
+ /** Note: [⚫] Code for playground [pdf-scraper-playground](src/scrapers/pdf/playground/pdf-scraper-playground.ts) should never be published in any package */
@@ -42,9 +42,9 @@ export declare class WebsiteScraper implements Converter, Scraper {
42
42
  */
43
43
  scrape(source: ScraperSourceHandler): Promise<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
44
44
  }
45
+ /** Note: [🟢] Code for Node scraper implementation [WebsiteScraper](src/scrapers/website/WebsiteScraper.ts) should never be published into packages that could be imported into browser environment */
45
46
  /**
46
47
  * TODO: [👣] Scraped website in .md can act as cache item - there is no need to run conversion each time
47
48
  * TODO: [🪂] Do it in parallel 11:11
48
49
  * Note: No need to aggregate usage here, it is done by intercepting the llmTools
49
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
50
50
  */
@@ -1,5 +1,3 @@
1
1
  #!/usr/bin/env ts-node
2
2
  export {};
3
- /**
4
- * Note: [⚫] Code in this file should never be published in any package
5
- */
3
+ /** Note: [⚫] Code for playground [website-scraper-playground](src/scrapers/website/playground/website-scraper-playground.ts) should never be published in any package */
@@ -15,7 +15,5 @@ export declare class BrowserSpeechRecognition implements SpeechRecognition {
15
15
  subscribe(callback: (event: SpeechRecognitionEvent) => void): () => void;
16
16
  private emit;
17
17
  }
18
- /**
19
- * TODO: !!!! Search ACRY for `window` and put -> [🔵]
20
- * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
21
- */
18
+ /** Note: [🔵] Code for browser speech-recognition adapter [BrowserSpeechRecognition](src/speech-recognition/BrowserSpeechRecognition.ts) should never be published outside of `@promptbook/browser` */
19
+ /** TODO: !!!! Search ACRY for `window` and put -> [🔵] */
@@ -34,7 +34,5 @@ export declare class FileCacheStorage<TItem> implements PromptbookStorage<TItem>
34
34
  */
35
35
  removeItem(key: string): Promise<void>;
36
36
  }
37
- /**
38
- * TODO: [🌗] Maybe some checkers, not all valid JSONs are desired and valid values
39
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
40
- */
37
+ /** Note: [🟢] Code for Node file-cache storage [FileCacheStorage](src/storage/file-cache-storage/FileCacheStorage.ts) should never be published into packages that could be imported into browser environment */
38
+ /** TODO: [🌗] Maybe some checkers, not all valid JSONs are desired and valid values */
@@ -6,6 +6,4 @@ import type { IndexedDbStorageOptions } from './utils/IndexedDbStorageOptions';
6
6
  * @public exported from `@promptbook/browser`
7
7
  */
8
8
  export declare function getIndexedDbStorage<TItem>(options: IndexedDbStorageOptions): PromptbookStorage<TItem>;
9
- /**
10
- * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
11
- */
9
+ /** Note: [🔵] Code for browser storage helper [getIndexedDbStorage](src/storage/local-storage/getIndexedDbStorage.ts) should never be published outside of `@promptbook/browser` */
@@ -5,6 +5,4 @@ import type { PromptbookStorage } from '../_common/PromptbookStorage';
5
5
  * @public exported from `@promptbook/browser`
6
6
  */
7
7
  export declare function getLocalStorage<TItem>(): PromptbookStorage<TItem>;
8
- /**
9
- * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
10
- */
8
+ /** Note: [🔵] Code for browser storage helper [getLocalStorage](src/storage/local-storage/getLocalStorage.ts) should never be published outside of `@promptbook/browser` */
@@ -5,6 +5,4 @@ import type { PromptbookStorage } from '../_common/PromptbookStorage';
5
5
  * @public exported from `@promptbook/browser`
6
6
  */
7
7
  export declare function getSessionStorage<TItem>(): PromptbookStorage<TItem>;
8
- /**
9
- * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
10
- */
8
+ /** Note: [🔵] Code for browser storage helper [getSessionStorage](src/storage/local-storage/getSessionStorage.ts) should never be published outside of `@promptbook/browser` */
@@ -1,5 +1,3 @@
1
1
  #!/usr/bin/env ts-node
2
2
  export {};
3
- /**
4
- * Note: [⚫] Code in this file should never be published in any package
5
- */
3
+ /** Note: [⚫] Code for playground [openai-sdk playground](src/transpilers/openai-sdk/playground/playground.ts) should never be published in any package */
@@ -0,0 +1,11 @@
1
+ import type { really_unknown } from '../utils/organization/really_unknown';
2
+ import type { ReservedParameters_private } from './ReservedParameters_private';
3
+ import type { string_parameter_name } from './string_parameter_name';
4
+ /**
5
+ * Parameters to pass to execution of the pipeline
6
+ *
7
+ * Note: [🚉] This should be fully serializable as JSON
8
+ * @see https://ptbk.io/parameters
9
+ * @private internal utility of `string_parameter_name.ts`
10
+ */
11
+ export type InputParameters_private = Exclude<Record<string_parameter_name, really_unknown>, ReservedParameters_private>;