@promptbook/javascript 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 (349) hide show
  1. package/esm/index.es.js +1 -1
  2. package/esm/src/_packages/components.index.d.ts +6 -0
  3. package/esm/src/_packages/types.index.d.ts +55 -49
  4. package/esm/src/book-2.0/agent-source/AgentReferenceResolver.d.ts +11 -0
  5. package/esm/src/book-2.0/agent-source/CreateAgentModelRequirementsOptions.d.ts +8 -0
  6. package/esm/src/book-2.0/agent-source/TeammateProfileResolver.d.ts +33 -0
  7. package/esm/src/book-2.0/agent-source/createTeamToolName.d.ts +7 -7
  8. package/esm/src/book-components/Chat/Chat/ChatActionsBar.d.ts +5 -0
  9. package/esm/src/book-components/Chat/Chat/ChatInputAreaDictationPanel.d.ts +42 -0
  10. package/esm/src/book-components/Chat/Chat/ChatMessageItem.d.ts +18 -15
  11. package/esm/src/book-components/Chat/Chat/ChatMessageItem.test.d.ts +1 -1
  12. package/esm/src/book-components/Chat/Chat/ChatMessageList.d.ts +14 -0
  13. package/esm/src/book-components/Chat/Chat/ChatMessageRichContent.d.ts +32 -0
  14. package/esm/src/book-components/Chat/Chat/ChatMessageToolCallChips.d.ts +22 -0
  15. package/esm/src/book-components/Chat/Chat/ChatProps.d.ts +290 -0
  16. package/esm/src/book-components/Chat/Chat/ChatToolCallModal.d.ts +16 -0
  17. package/esm/src/book-components/Chat/Chat/StreamingFeaturePlaceholder.d.ts +33 -0
  18. package/esm/src/book-components/Chat/Chat/createChatMessageToolCallRenderModel.d.ts +76 -0
  19. package/esm/src/book-components/Chat/Chat/createProgressCardChecklistMarkdown.d.ts +16 -0
  20. package/esm/src/book-components/Chat/Chat/renderAdvancedToolCallDetails.d.ts +4 -0
  21. package/esm/src/book-components/Chat/Chat/renderEmailToolCallDetails.d.ts +26 -0
  22. package/esm/src/book-components/Chat/Chat/renderMemoryToolCallDetails.d.ts +31 -0
  23. package/esm/src/book-components/Chat/Chat/renderPopupToolCallDetails.d.ts +32 -0
  24. package/esm/src/book-components/Chat/Chat/renderRunBrowserToolCallDetails.d.ts +31 -0
  25. package/esm/src/book-components/Chat/Chat/renderSearchToolCallDetails.d.ts +31 -0
  26. package/esm/src/book-components/Chat/Chat/renderSelfLearningToolCallDetails.d.ts +38 -0
  27. package/esm/src/book-components/Chat/Chat/renderTimeToolCallDetails.d.ts +38 -0
  28. package/esm/src/book-components/Chat/Chat/renderTimeoutToolCallDetails.d.ts +46 -0
  29. package/esm/src/book-components/Chat/Chat/renderToolCallClockPanel.d.ts +33 -0
  30. package/esm/src/book-components/Chat/Chat/renderToolCallDetails.d.ts +10 -1
  31. package/esm/src/book-components/Chat/Chat/renderToolCallProgressPlaceholder.d.ts +29 -0
  32. package/esm/src/book-components/Chat/Chat/renderWalletCredentialToolCallDetails.d.ts +26 -0
  33. package/esm/src/book-components/Chat/Chat/resolveToolCallProgressMessage.d.ts +9 -0
  34. package/esm/src/book-components/Chat/Chat/useChatInputAreaAttachments.d.ts +32 -0
  35. package/esm/src/book-components/Chat/Chat/useChatInputAreaDictation.d.ts +76 -0
  36. package/esm/src/book-components/Chat/Chat/useChatMessageAvatarTooltip.d.ts +31 -0
  37. package/esm/src/book-components/Chat/Chat/useChatMessageSpeechPlayback.d.ts +29 -0
  38. package/esm/src/book-components/Chat/MarkdownContent/MarkdownContent.d.ts +2 -1
  39. package/esm/src/book-components/Chat/MarkdownContent/MarkdownContent.test.d.ts +2 -0
  40. package/esm/src/book-components/Chat/hooks/useChatCompleteNotification.d.ts +18 -0
  41. package/esm/src/book-components/Chat/hooks/useChatCompleteNotification.test.d.ts +2 -0
  42. package/esm/src/book-components/Chat/types/ChatMessage.d.ts +77 -1
  43. package/esm/src/book-components/Chat/utils/formatToolCallDateTime.d.ts +37 -0
  44. package/esm/src/book-components/Chat/utils/formatToolCallLocalTime.d.ts +11 -0
  45. package/esm/src/book-components/Chat/utils/formatToolCallTranslationTemplate.d.ts +10 -0
  46. package/esm/src/book-components/Chat/utils/getChatMessageTimingDisplay.d.ts +5 -1
  47. package/esm/src/book-components/Chat/utils/getToolCallChipletInfo.d.ts +26 -1
  48. package/esm/src/book-components/Chat/utils/timeoutToolCallPresentation.d.ts +26 -3
  49. package/esm/src/cli/$runPromptbookCli.d.ts +1 -3
  50. package/esm/src/cli/cli-commands/_boilerplate.d.ts +2 -4
  51. package/esm/src/cli/cli-commands/about.d.ts +1 -1
  52. package/esm/src/cli/cli-commands/coder/find-fresh-emoji-tags.d.ts +2 -4
  53. package/esm/src/cli/cli-commands/coder/find-refactor-candidates.d.ts +2 -4
  54. package/esm/src/cli/cli-commands/coder/generate-boilerplates.d.ts +2 -4
  55. package/esm/src/cli/cli-commands/coder/init.d.ts +2 -4
  56. package/esm/src/cli/cli-commands/coder/run.d.ts +2 -4
  57. package/esm/src/cli/cli-commands/coder/verify.d.ts +2 -4
  58. package/esm/src/cli/cli-commands/coder.d.ts +2 -4
  59. package/esm/src/cli/cli-commands/hello.d.ts +1 -1
  60. package/esm/src/cli/cli-commands/list-models.d.ts +2 -4
  61. package/esm/src/cli/cli-commands/list-scrapers.d.ts +2 -4
  62. package/esm/src/cli/cli-commands/login.d.ts +1 -1
  63. package/esm/src/cli/cli-commands/make.d.ts +1 -1
  64. package/esm/src/cli/cli-commands/prettify.d.ts +1 -1
  65. package/esm/src/cli/cli-commands/run.d.ts +1 -1
  66. package/esm/src/cli/cli-commands/runInteractiveChatbot.d.ts +1 -1
  67. package/esm/src/cli/cli-commands/start-agents-server.d.ts +2 -4
  68. package/esm/src/cli/cli-commands/start-pipelines-server.d.ts +1 -1
  69. package/esm/src/cli/cli-commands/test-command.d.ts +1 -1
  70. package/esm/src/cli/main.d.ts +2 -4
  71. package/esm/src/cli/promptbookCli.d.ts +1 -1
  72. package/esm/src/commitments/USE_BROWSER/fetchUrlContent.d.ts +1 -3
  73. package/esm/src/conversion/archive/loadArchive.d.ts +1 -3
  74. package/esm/src/conversion/archive/saveArchive.d.ts +1 -1
  75. package/esm/src/conversion/validation/_importPipeline.d.ts +2 -4
  76. package/esm/src/dialogs/simple-prompt/SimplePromptInterfaceTools.d.ts +1 -3
  77. package/esm/src/executables/$provideExecutablesForNode.d.ts +1 -1
  78. package/esm/src/executables/apps/locateLibreoffice.d.ts +2 -4
  79. package/esm/src/executables/apps/locatePandoc.d.ts +2 -4
  80. package/esm/src/executables/locateApp.d.ts +2 -4
  81. package/esm/src/executables/platforms/locateAppOnLinux.d.ts +2 -4
  82. package/esm/src/executables/platforms/locateAppOnMacOs.d.ts +2 -4
  83. package/esm/src/executables/platforms/locateAppOnWindows.d.ts +2 -4
  84. package/esm/src/execution/translation/automatic-translate/translateMessages.d.ts +2 -4
  85. package/esm/src/execution/utils/$provideExecutionToolsForNode.d.ts +2 -4
  86. package/esm/src/llm-providers/_common/register/$provideEnvFilename.d.ts +1 -3
  87. package/esm/src/llm-providers/_common/register/$provideLlmToolsConfigurationFromEnv.d.ts +1 -3
  88. package/esm/src/llm-providers/_common/register/$provideLlmToolsForWizardOrCli.d.ts +1 -1
  89. package/esm/src/llm-providers/_common/register/$provideLlmToolsFromEnv.d.ts +1 -3
  90. package/esm/src/llm-providers/_multiple/playground/playground.d.ts +1 -3
  91. package/esm/src/llm-providers/agent/playground/playground.d.ts +1 -1
  92. package/esm/src/llm-providers/anthropic-claude/playground/playground.d.ts +1 -1
  93. package/esm/src/llm-providers/azure-openai/playground/playground.d.ts +2 -4
  94. package/esm/src/llm-providers/ollama/playground/playground.d.ts +2 -4
  95. package/esm/src/llm-providers/openai/playground/playground.d.ts +2 -4
  96. package/esm/src/llm-providers/remote/playground/playground.d.ts +1 -3
  97. package/esm/src/llm-providers/vercel/playground/playground.d.ts +2 -4
  98. package/esm/src/playground/permanent/_boilerplate.d.ts +1 -3
  99. package/esm/src/playground/permanent/agent-with-browser-playground.d.ts +1 -3
  100. package/esm/src/playground/permanent/error-handling-playground.d.ts +1 -3
  101. package/esm/src/playground/playground.d.ts +2 -4
  102. package/esm/src/remote-server/startAgentServer.d.ts +1 -3
  103. package/esm/src/remote-server/startRemoteServer.d.ts +1 -2
  104. package/esm/src/scrapers/_boilerplate/BoilerplateScraper.d.ts +4 -6
  105. package/esm/src/scrapers/_boilerplate/playground/boilerplate-scraper-playground.d.ts +1 -3
  106. package/esm/src/scrapers/_common/register/$provideFilesystemForNode.d.ts +2 -4
  107. package/esm/src/scrapers/_common/register/$provideScrapersForNode.d.ts +2 -4
  108. package/esm/src/scrapers/_common/register/$provideScriptingForNode.d.ts +2 -4
  109. package/esm/src/scrapers/_common/utils/getScraperIntermediateSource.d.ts +1 -1
  110. package/esm/src/scrapers/document/DocumentScraper.d.ts +1 -1
  111. package/esm/src/scrapers/document/playground/document-scraper-playground.d.ts +1 -3
  112. package/esm/src/scrapers/document-legacy/LegacyDocumentScraper.d.ts +1 -1
  113. package/esm/src/scrapers/document-legacy/playground/legacy-document-scraper-playground.d.ts +1 -3
  114. package/esm/src/scrapers/markdown/playground/markdown-scraper-playground.d.ts +1 -3
  115. package/esm/src/scrapers/markitdown/MarkitdownScraper.d.ts +1 -1
  116. package/esm/src/scrapers/markitdown/playground/markitdown-scraper-playground.d.ts +1 -3
  117. package/esm/src/scrapers/pdf/PdfScraper.d.ts +1 -1
  118. package/esm/src/scrapers/pdf/playground/pdf-scraper-playground.d.ts +1 -3
  119. package/esm/src/scrapers/website/WebsiteScraper.d.ts +1 -1
  120. package/esm/src/scrapers/website/playground/website-scraper-playground.d.ts +1 -3
  121. package/esm/src/speech-recognition/BrowserSpeechRecognition.d.ts +2 -4
  122. package/esm/src/storage/file-cache-storage/FileCacheStorage.d.ts +2 -4
  123. package/esm/src/storage/local-storage/getIndexedDbStorage.d.ts +1 -3
  124. package/esm/src/storage/local-storage/getLocalStorage.d.ts +1 -3
  125. package/esm/src/storage/local-storage/getSessionStorage.d.ts +1 -3
  126. package/esm/src/transpilers/openai-sdk/playground/playground.d.ts +1 -3
  127. package/esm/src/types/InputParameters_private.d.ts +11 -0
  128. package/esm/src/types/Parameters_private.d.ts +16 -0
  129. package/esm/src/types/ReservedParameters_private.d.ts +10 -0
  130. package/esm/src/types/number_bytes.d.ts +21 -0
  131. package/esm/src/types/number_id.d.ts +13 -0
  132. package/esm/src/types/number_likeness.d.ts +8 -0
  133. package/esm/src/types/number_milliseconds.d.ts +33 -0
  134. package/esm/src/types/number_percent.d.ts +18 -0
  135. package/esm/src/types/number_positive.d.ts +16 -0
  136. package/esm/src/types/number_usd.d.ts +6 -106
  137. package/esm/src/types/string_agent_hash_private.d.ts +9 -0
  138. package/esm/src/types/string_agent_name_in_book_private.d.ts +8 -0
  139. package/esm/src/types/string_agent_name_private.d.ts +9 -0
  140. package/esm/src/types/string_agent_permanent_id_private.d.ts +10 -0
  141. package/esm/src/types/string_base64_private.d.ts +17 -0
  142. package/esm/src/types/string_business_category_name_private.d.ts +6 -0
  143. package/esm/src/types/string_char_private.d.ts +8 -0
  144. package/esm/src/types/string_chat_prompt_private.d.ts +9 -0
  145. package/esm/src/types/string_completion_prompt_private.d.ts +9 -0
  146. package/esm/src/types/string_email_private.d.ts +16 -0
  147. package/esm/src/types/string_host_private.d.ts +55 -0
  148. package/esm/src/types/string_mime_type_private.d.ts +17 -0
  149. package/esm/src/types/string_model_description_private.d.ts +8 -0
  150. package/esm/src/types/string_model_name_private.d.ts +8 -0
  151. package/esm/src/types/string_name_private.d.ts +9 -0
  152. package/esm/src/types/string_page_private.d.ts +9 -0
  153. package/esm/src/types/string_parameter_name.d.ts +74 -31
  154. package/esm/src/types/string_parameter_value_private.d.ts +9 -0
  155. package/esm/src/types/string_persona_description_private.d.ts +8 -0
  156. package/esm/src/types/string_prompt_image_private.d.ts +8 -0
  157. package/esm/src/types/string_prompt_private.d.ts +8 -0
  158. package/esm/src/types/string_reserved_parameter_name_private.d.ts +11 -0
  159. package/esm/src/types/string_system_message_private.d.ts +9 -0
  160. package/esm/src/types/string_template_private.d.ts +8 -0
  161. package/esm/src/types/string_text_prompt_private.d.ts +9 -0
  162. package/esm/src/types/string_title_private.d.ts +9 -0
  163. package/esm/src/types/string_url.d.ts +50 -46
  164. package/esm/src/types/string_url_private.d.ts +88 -0
  165. package/esm/src/types/typeAliases.d.ts +7 -1
  166. package/esm/src/utils/execCommand/$execCommand.d.ts +1 -3
  167. package/esm/src/utils/execCommand/$execCommands.d.ts +1 -3
  168. package/esm/src/utils/files/$induceBookDownload.d.ts +1 -3
  169. package/esm/src/utils/files/$induceFileDownload.d.ts +1 -3
  170. package/esm/src/utils/files/ObjectUrl.d.ts +1 -3
  171. package/esm/src/utils/toolCalls/mergeToolCalls.d.ts +1 -1
  172. package/esm/src/version.d.ts +1 -1
  173. package/esm/src/wizard/$getCompiledBook.d.ts +2 -4
  174. package/esm/src/wizard/wizard.d.ts +2 -4
  175. package/package.json +2 -2
  176. package/umd/index.umd.js +1 -1
  177. package/umd/src/_packages/components.index.d.ts +6 -0
  178. package/umd/src/_packages/types.index.d.ts +55 -49
  179. package/umd/src/book-2.0/agent-source/AgentReferenceResolver.d.ts +11 -0
  180. package/umd/src/book-2.0/agent-source/CreateAgentModelRequirementsOptions.d.ts +8 -0
  181. package/umd/src/book-2.0/agent-source/TeammateProfileResolver.d.ts +33 -0
  182. package/umd/src/book-2.0/agent-source/createTeamToolName.d.ts +7 -7
  183. package/umd/src/book-components/Chat/Chat/ChatActionsBar.d.ts +5 -0
  184. package/umd/src/book-components/Chat/Chat/ChatInputAreaDictationPanel.d.ts +42 -0
  185. package/umd/src/book-components/Chat/Chat/ChatMessageItem.d.ts +18 -15
  186. package/umd/src/book-components/Chat/Chat/ChatMessageItem.test.d.ts +1 -1
  187. package/umd/src/book-components/Chat/Chat/ChatMessageList.d.ts +14 -0
  188. package/umd/src/book-components/Chat/Chat/ChatMessageRichContent.d.ts +32 -0
  189. package/umd/src/book-components/Chat/Chat/ChatMessageToolCallChips.d.ts +22 -0
  190. package/umd/src/book-components/Chat/Chat/ChatProps.d.ts +290 -0
  191. package/umd/src/book-components/Chat/Chat/ChatToolCallModal.d.ts +16 -0
  192. package/umd/src/book-components/Chat/Chat/StreamingFeaturePlaceholder.d.ts +33 -0
  193. package/umd/src/book-components/Chat/Chat/createChatMessageToolCallRenderModel.d.ts +76 -0
  194. package/umd/src/book-components/Chat/Chat/createProgressCardChecklistMarkdown.d.ts +16 -0
  195. package/umd/src/book-components/Chat/Chat/renderAdvancedToolCallDetails.d.ts +4 -0
  196. package/umd/src/book-components/Chat/Chat/renderEmailToolCallDetails.d.ts +26 -0
  197. package/umd/src/book-components/Chat/Chat/renderMemoryToolCallDetails.d.ts +31 -0
  198. package/umd/src/book-components/Chat/Chat/renderPopupToolCallDetails.d.ts +32 -0
  199. package/umd/src/book-components/Chat/Chat/renderRunBrowserToolCallDetails.d.ts +31 -0
  200. package/umd/src/book-components/Chat/Chat/renderSearchToolCallDetails.d.ts +31 -0
  201. package/umd/src/book-components/Chat/Chat/renderSelfLearningToolCallDetails.d.ts +38 -0
  202. package/umd/src/book-components/Chat/Chat/renderTimeToolCallDetails.d.ts +38 -0
  203. package/umd/src/book-components/Chat/Chat/renderTimeoutToolCallDetails.d.ts +46 -0
  204. package/umd/src/book-components/Chat/Chat/renderToolCallClockPanel.d.ts +33 -0
  205. package/umd/src/book-components/Chat/Chat/renderToolCallDetails.d.ts +10 -1
  206. package/umd/src/book-components/Chat/Chat/renderToolCallProgressPlaceholder.d.ts +29 -0
  207. package/umd/src/book-components/Chat/Chat/renderWalletCredentialToolCallDetails.d.ts +26 -0
  208. package/umd/src/book-components/Chat/Chat/resolveToolCallProgressMessage.d.ts +9 -0
  209. package/umd/src/book-components/Chat/Chat/useChatInputAreaAttachments.d.ts +32 -0
  210. package/umd/src/book-components/Chat/Chat/useChatInputAreaDictation.d.ts +76 -0
  211. package/umd/src/book-components/Chat/Chat/useChatMessageAvatarTooltip.d.ts +31 -0
  212. package/umd/src/book-components/Chat/Chat/useChatMessageSpeechPlayback.d.ts +29 -0
  213. package/umd/src/book-components/Chat/MarkdownContent/MarkdownContent.d.ts +2 -1
  214. package/umd/src/book-components/Chat/MarkdownContent/MarkdownContent.test.d.ts +2 -0
  215. package/umd/src/book-components/Chat/hooks/useChatCompleteNotification.d.ts +18 -0
  216. package/umd/src/book-components/Chat/hooks/useChatCompleteNotification.test.d.ts +2 -0
  217. package/umd/src/book-components/Chat/types/ChatMessage.d.ts +77 -1
  218. package/umd/src/book-components/Chat/utils/formatToolCallDateTime.d.ts +37 -0
  219. package/umd/src/book-components/Chat/utils/formatToolCallLocalTime.d.ts +11 -0
  220. package/umd/src/book-components/Chat/utils/formatToolCallTranslationTemplate.d.ts +10 -0
  221. package/umd/src/book-components/Chat/utils/getChatMessageTimingDisplay.d.ts +5 -1
  222. package/umd/src/book-components/Chat/utils/getToolCallChipletInfo.d.ts +26 -1
  223. package/umd/src/book-components/Chat/utils/timeoutToolCallPresentation.d.ts +26 -3
  224. package/umd/src/cli/$runPromptbookCli.d.ts +1 -3
  225. package/umd/src/cli/cli-commands/_boilerplate.d.ts +2 -4
  226. package/umd/src/cli/cli-commands/about.d.ts +1 -1
  227. package/umd/src/cli/cli-commands/coder/find-fresh-emoji-tags.d.ts +2 -4
  228. package/umd/src/cli/cli-commands/coder/find-refactor-candidates.d.ts +2 -4
  229. package/umd/src/cli/cli-commands/coder/generate-boilerplates.d.ts +2 -4
  230. package/umd/src/cli/cli-commands/coder/init.d.ts +2 -4
  231. package/umd/src/cli/cli-commands/coder/run.d.ts +2 -4
  232. package/umd/src/cli/cli-commands/coder/verify.d.ts +2 -4
  233. package/umd/src/cli/cli-commands/coder.d.ts +2 -4
  234. package/umd/src/cli/cli-commands/hello.d.ts +1 -1
  235. package/umd/src/cli/cli-commands/list-models.d.ts +2 -4
  236. package/umd/src/cli/cli-commands/list-scrapers.d.ts +2 -4
  237. package/umd/src/cli/cli-commands/login.d.ts +1 -1
  238. package/umd/src/cli/cli-commands/make.d.ts +1 -1
  239. package/umd/src/cli/cli-commands/prettify.d.ts +1 -1
  240. package/umd/src/cli/cli-commands/run.d.ts +1 -1
  241. package/umd/src/cli/cli-commands/runInteractiveChatbot.d.ts +1 -1
  242. package/umd/src/cli/cli-commands/start-agents-server.d.ts +2 -4
  243. package/umd/src/cli/cli-commands/start-pipelines-server.d.ts +1 -1
  244. package/umd/src/cli/cli-commands/test-command.d.ts +1 -1
  245. package/umd/src/cli/main.d.ts +2 -4
  246. package/umd/src/cli/promptbookCli.d.ts +1 -1
  247. package/umd/src/commitments/USE_BROWSER/fetchUrlContent.d.ts +1 -3
  248. package/umd/src/conversion/archive/loadArchive.d.ts +1 -3
  249. package/umd/src/conversion/archive/saveArchive.d.ts +1 -1
  250. package/umd/src/conversion/validation/_importPipeline.d.ts +2 -4
  251. package/umd/src/dialogs/simple-prompt/SimplePromptInterfaceTools.d.ts +1 -3
  252. package/umd/src/executables/$provideExecutablesForNode.d.ts +1 -1
  253. package/umd/src/executables/apps/locateLibreoffice.d.ts +2 -4
  254. package/umd/src/executables/apps/locatePandoc.d.ts +2 -4
  255. package/umd/src/executables/locateApp.d.ts +2 -4
  256. package/umd/src/executables/platforms/locateAppOnLinux.d.ts +2 -4
  257. package/umd/src/executables/platforms/locateAppOnMacOs.d.ts +2 -4
  258. package/umd/src/executables/platforms/locateAppOnWindows.d.ts +2 -4
  259. package/umd/src/execution/translation/automatic-translate/translateMessages.d.ts +2 -4
  260. package/umd/src/execution/utils/$provideExecutionToolsForNode.d.ts +2 -4
  261. package/umd/src/llm-providers/_common/register/$provideEnvFilename.d.ts +1 -3
  262. package/umd/src/llm-providers/_common/register/$provideLlmToolsConfigurationFromEnv.d.ts +1 -3
  263. package/umd/src/llm-providers/_common/register/$provideLlmToolsForWizardOrCli.d.ts +1 -1
  264. package/umd/src/llm-providers/_common/register/$provideLlmToolsFromEnv.d.ts +1 -3
  265. package/umd/src/llm-providers/_multiple/playground/playground.d.ts +1 -3
  266. package/umd/src/llm-providers/agent/playground/playground.d.ts +1 -1
  267. package/umd/src/llm-providers/anthropic-claude/playground/playground.d.ts +1 -1
  268. package/umd/src/llm-providers/azure-openai/playground/playground.d.ts +2 -4
  269. package/umd/src/llm-providers/ollama/playground/playground.d.ts +2 -4
  270. package/umd/src/llm-providers/openai/playground/playground.d.ts +2 -4
  271. package/umd/src/llm-providers/remote/playground/playground.d.ts +1 -3
  272. package/umd/src/llm-providers/vercel/playground/playground.d.ts +2 -4
  273. package/umd/src/playground/permanent/_boilerplate.d.ts +1 -3
  274. package/umd/src/playground/permanent/agent-with-browser-playground.d.ts +1 -3
  275. package/umd/src/playground/permanent/error-handling-playground.d.ts +1 -3
  276. package/umd/src/playground/playground.d.ts +2 -4
  277. package/umd/src/remote-server/startAgentServer.d.ts +1 -3
  278. package/umd/src/remote-server/startRemoteServer.d.ts +1 -2
  279. package/umd/src/scrapers/_boilerplate/BoilerplateScraper.d.ts +4 -6
  280. package/umd/src/scrapers/_boilerplate/playground/boilerplate-scraper-playground.d.ts +1 -3
  281. package/umd/src/scrapers/_common/register/$provideFilesystemForNode.d.ts +2 -4
  282. package/umd/src/scrapers/_common/register/$provideScrapersForNode.d.ts +2 -4
  283. package/umd/src/scrapers/_common/register/$provideScriptingForNode.d.ts +2 -4
  284. package/umd/src/scrapers/_common/utils/getScraperIntermediateSource.d.ts +1 -1
  285. package/umd/src/scrapers/document/DocumentScraper.d.ts +1 -1
  286. package/umd/src/scrapers/document/playground/document-scraper-playground.d.ts +1 -3
  287. package/umd/src/scrapers/document-legacy/LegacyDocumentScraper.d.ts +1 -1
  288. package/umd/src/scrapers/document-legacy/playground/legacy-document-scraper-playground.d.ts +1 -3
  289. package/umd/src/scrapers/markdown/playground/markdown-scraper-playground.d.ts +1 -3
  290. package/umd/src/scrapers/markitdown/MarkitdownScraper.d.ts +1 -1
  291. package/umd/src/scrapers/markitdown/playground/markitdown-scraper-playground.d.ts +1 -3
  292. package/umd/src/scrapers/pdf/PdfScraper.d.ts +1 -1
  293. package/umd/src/scrapers/pdf/playground/pdf-scraper-playground.d.ts +1 -3
  294. package/umd/src/scrapers/website/WebsiteScraper.d.ts +1 -1
  295. package/umd/src/scrapers/website/playground/website-scraper-playground.d.ts +1 -3
  296. package/umd/src/speech-recognition/BrowserSpeechRecognition.d.ts +2 -4
  297. package/umd/src/storage/file-cache-storage/FileCacheStorage.d.ts +2 -4
  298. package/umd/src/storage/local-storage/getIndexedDbStorage.d.ts +1 -3
  299. package/umd/src/storage/local-storage/getLocalStorage.d.ts +1 -3
  300. package/umd/src/storage/local-storage/getSessionStorage.d.ts +1 -3
  301. package/umd/src/transpilers/openai-sdk/playground/playground.d.ts +1 -3
  302. package/umd/src/types/InputParameters_private.d.ts +11 -0
  303. package/umd/src/types/Parameters_private.d.ts +16 -0
  304. package/umd/src/types/ReservedParameters_private.d.ts +10 -0
  305. package/umd/src/types/number_bytes.d.ts +21 -0
  306. package/umd/src/types/number_id.d.ts +13 -0
  307. package/umd/src/types/number_likeness.d.ts +8 -0
  308. package/umd/src/types/number_milliseconds.d.ts +33 -0
  309. package/umd/src/types/number_percent.d.ts +18 -0
  310. package/umd/src/types/number_positive.d.ts +16 -0
  311. package/umd/src/types/number_usd.d.ts +6 -106
  312. package/umd/src/types/string_agent_hash_private.d.ts +9 -0
  313. package/umd/src/types/string_agent_name_in_book_private.d.ts +8 -0
  314. package/umd/src/types/string_agent_name_private.d.ts +9 -0
  315. package/umd/src/types/string_agent_permanent_id_private.d.ts +10 -0
  316. package/umd/src/types/string_base64_private.d.ts +17 -0
  317. package/umd/src/types/string_business_category_name_private.d.ts +6 -0
  318. package/umd/src/types/string_char_private.d.ts +8 -0
  319. package/umd/src/types/string_chat_prompt_private.d.ts +9 -0
  320. package/umd/src/types/string_completion_prompt_private.d.ts +9 -0
  321. package/umd/src/types/string_email_private.d.ts +16 -0
  322. package/umd/src/types/string_host_private.d.ts +55 -0
  323. package/umd/src/types/string_mime_type_private.d.ts +17 -0
  324. package/umd/src/types/string_model_description_private.d.ts +8 -0
  325. package/umd/src/types/string_model_name_private.d.ts +8 -0
  326. package/umd/src/types/string_name_private.d.ts +9 -0
  327. package/umd/src/types/string_page_private.d.ts +9 -0
  328. package/umd/src/types/string_parameter_name.d.ts +74 -31
  329. package/umd/src/types/string_parameter_value_private.d.ts +9 -0
  330. package/umd/src/types/string_persona_description_private.d.ts +8 -0
  331. package/umd/src/types/string_prompt_image_private.d.ts +8 -0
  332. package/umd/src/types/string_prompt_private.d.ts +8 -0
  333. package/umd/src/types/string_reserved_parameter_name_private.d.ts +11 -0
  334. package/umd/src/types/string_system_message_private.d.ts +9 -0
  335. package/umd/src/types/string_template_private.d.ts +8 -0
  336. package/umd/src/types/string_text_prompt_private.d.ts +9 -0
  337. package/umd/src/types/string_title_private.d.ts +9 -0
  338. package/umd/src/types/string_url.d.ts +50 -46
  339. package/umd/src/types/string_url_private.d.ts +88 -0
  340. package/umd/src/types/typeAliases.d.ts +7 -1
  341. package/umd/src/utils/execCommand/$execCommand.d.ts +1 -3
  342. package/umd/src/utils/execCommand/$execCommands.d.ts +1 -3
  343. package/umd/src/utils/files/$induceBookDownload.d.ts +1 -3
  344. package/umd/src/utils/files/$induceFileDownload.d.ts +1 -3
  345. package/umd/src/utils/files/ObjectUrl.d.ts +1 -3
  346. package/umd/src/utils/toolCalls/mergeToolCalls.d.ts +1 -1
  347. package/umd/src/version.d.ts +1 -1
  348. package/umd/src/wizard/$getCompiledBook.d.ts +2 -4
  349. package/umd/src/wizard/wizard.d.ts +2 -4
@@ -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>;
@@ -0,0 +1,16 @@
1
+ import type { ReservedParameters_private } from './ReservedParameters_private';
2
+ import type { string_parameter_name } from './string_parameter_name';
3
+ import type { string_parameter_value_private } from './string_parameter_value_private';
4
+ /**
5
+ * Parameters of the pipeline
6
+ *
7
+ * There are three types of parameters:
8
+ * - **INPUT PARAMETERs** are required to execute the pipeline.
9
+ * - **Intermediate parameters** are used internally in the pipeline.
10
+ * - **OUTPUT PARAMETERs** are not used internally in the pipeline, but are returned as the result of the pipeline execution.
11
+ *
12
+ * Note: [🚉] This is fully serializable as JSON
13
+ * @see https://ptbk.io/parameters
14
+ * @private internal utility of `string_parameter_name.ts`
15
+ */
16
+ export type Parameters_private = Exclude<Record<string_parameter_name, string_parameter_value_private>, ReservedParameters_private>;
@@ -0,0 +1,10 @@
1
+ import type { string_reserved_parameter_name_private } from './string_reserved_parameter_name_private';
2
+ import type { string_parameter_value_private } from './string_parameter_value_private';
3
+ /**
4
+ * Represents a mapping of reserved parameter names to their values.
5
+ * Reserved parameters are used internally by the pipeline and should not be set by users.
6
+ *
7
+ * Note: [🚉] This is fully serializable as JSON
8
+ * @private internal utility of `string_parameter_name.ts`
9
+ */
10
+ export type ReservedParameters_private = Record<string_reserved_parameter_name_private, string_parameter_value_private>;
@@ -0,0 +1,21 @@
1
+ import type { number_integer, number_positive } from './number_positive';
2
+ /**
3
+ * Byte count helper.
4
+ */
5
+ export type number_bytes = number_integer & number_positive;
6
+ /**
7
+ * Kilobyte count helper.
8
+ */
9
+ export type number_kilobytes = number_positive;
10
+ /**
11
+ * Megabyte count helper.
12
+ */
13
+ export type number_megabytes = number_positive;
14
+ /**
15
+ * Gigabyte count helper.
16
+ */
17
+ export type number_gigabytes = number_positive;
18
+ /**
19
+ * Terabyte count helper.
20
+ */
21
+ export type number_terabytes = number_positive;
@@ -0,0 +1,13 @@
1
+ import type { number_integer, number_positive } from './number_positive';
2
+ /**
3
+ * Semantic helper for incremental IDs
4
+ */
5
+ export type number_id = number_integer & (number_positive | 0);
6
+ /**
7
+ * Semantic helper for number of rows and columns
8
+ */
9
+ export type number_linecol_number = number_integer & number_positive;
10
+ /**
11
+ * Semantic helper for number of tokens
12
+ */
13
+ export type number_tokens = number_integer & (number_positive | 0);
@@ -0,0 +1,8 @@
1
+ /**
2
+ * Likeness of the wallpaper
3
+ *
4
+ * - 👍 is equivalent to 1
5
+ * - 👎 is equivalent to -1
6
+ * - ❤ is equivalent to more than 1
7
+ */
8
+ export type number_likeness = number;
@@ -0,0 +1,33 @@
1
+ import type { number_integer } from './number_positive';
2
+ /**
3
+ * Milliseconds helper.
4
+ */
5
+ export type number_milliseconds = number_integer;
6
+ /**
7
+ * Seconds helper.
8
+ */
9
+ export type number_seconds = number;
10
+ /**
11
+ * Minutes helper.
12
+ */
13
+ export type number_minutes = number;
14
+ /**
15
+ * Hours helper.
16
+ */
17
+ export type number_hours = number;
18
+ /**
19
+ * Days helper.
20
+ */
21
+ export type number_days = number;
22
+ /**
23
+ * Weeks helper.
24
+ */
25
+ export type number_weeks = number;
26
+ /**
27
+ * Months helper.
28
+ */
29
+ export type number_months = number;
30
+ /**
31
+ * Years helper.
32
+ */
33
+ export type number_years = number;
@@ -0,0 +1,18 @@
1
+ /**
2
+ * Semantic helper;
3
+ * Percentage from 0 to 1 (100%) (and below and above)
4
+ */
5
+ export type number_percent = number;
6
+ /**
7
+ * Semantic helper;
8
+ * Model temperature
9
+ */
10
+ export type number_model_temperature = number_percent;
11
+ /**
12
+ * Semantic helper;
13
+ * Seed for random generator
14
+ *
15
+ * Percentage from 0 to 1 (100%)
16
+ * TODO: Is seed (in OpenAI) number from 0 to 1?
17
+ */
18
+ export type number_seed = number_percent;
@@ -0,0 +1,16 @@
1
+ /**
2
+ * Positive number helper.
3
+ */
4
+ export type number_positive = number;
5
+ /**
6
+ * Negative number helper.
7
+ */
8
+ export type number_negative = number;
9
+ /**
10
+ * Integer number helper.
11
+ */
12
+ export type number_integer = number;
13
+ /**
14
+ * TCP/UDP port helper.
15
+ */
16
+ export type number_port = number_positive & number_integer;
@@ -2,109 +2,9 @@
2
2
  * Semantic helper for US Dollars
3
3
  */
4
4
  export type number_usd = number;
5
- /**
6
- * Semantic helper for incremental IDs
7
- */
8
- export type number_id = number_integer & (number_positive | 0);
9
- /**
10
- * Semantic helper for number of rows and columns
11
- */
12
- export type number_linecol_number = number_integer & number_positive;
13
- /**
14
- * Semantic helper for number of tokens
15
- */
16
- export type number_tokens = number_integer & (number_positive | 0);
17
- /**
18
- * Positive number helper.
19
- */
20
- export type number_positive = number;
21
- /**
22
- * Negative number helper.
23
- */
24
- export type number_negative = number;
25
- /**
26
- * Integer number helper.
27
- */
28
- export type number_integer = number;
29
- /**
30
- * TCP/UDP port helper.
31
- */
32
- export type number_port = number_positive & number_integer;
33
- /**
34
- * Semantic helper;
35
- * Percentage from 0 to 1 (100%) (and below and above)
36
- */
37
- export type number_percent = number;
38
- /**
39
- * Semantic helper;
40
- * Model temperature
41
- */
42
- export type number_model_temperature = number_percent;
43
- /**
44
- * Semantic helper;
45
- * Seed for random generator
46
- *
47
- * Percentage from 0 to 1 (100%)
48
- * TODO: Is seed (in OpenAI) number from 0 to 1?
49
- */
50
- export type number_seed = number_percent;
51
- /**
52
- * Likeness of the wallpaper
53
- *
54
- * - 👍 is equivalent to 1
55
- * - 👎 is equivalent to -1
56
- * - ❤ is equivalent to more than 1
57
- */
58
- export type number_likeness = number;
59
- /**
60
- * Milliseconds helper.
61
- */
62
- export type number_milliseconds = number_integer;
63
- /**
64
- * Seconds helper.
65
- */
66
- export type number_seconds = number;
67
- /**
68
- * Minutes helper.
69
- */
70
- export type number_minutes = number;
71
- /**
72
- * Hours helper.
73
- */
74
- export type number_hours = number;
75
- /**
76
- * Days helper.
77
- */
78
- export type number_days = number;
79
- /**
80
- * Weeks helper.
81
- */
82
- export type number_weeks = number;
83
- /**
84
- * Months helper.
85
- */
86
- export type number_months = number;
87
- /**
88
- * Years helper.
89
- */
90
- export type number_years = number;
91
- /**
92
- * Byte count helper.
93
- */
94
- export type number_bytes = number_integer & number_positive;
95
- /**
96
- * Kilobyte count helper.
97
- */
98
- export type number_kilobytes = number_positive;
99
- /**
100
- * Megabyte count helper.
101
- */
102
- export type number_megabytes = number_positive;
103
- /**
104
- * Gigabyte count helper.
105
- */
106
- export type number_gigabytes = number_positive;
107
- /**
108
- * Terabyte count helper.
109
- */
110
- export type number_terabytes = number_positive;
5
+ export type { number_bytes, number_gigabytes, number_kilobytes, number_megabytes, number_terabytes } from './number_bytes';
6
+ export type { number_id, number_linecol_number, number_tokens } from './number_id';
7
+ export type { number_likeness } from './number_likeness';
8
+ export type { number_days, number_hours, number_milliseconds, number_minutes, number_months, number_seconds, number_weeks, number_years, } from './number_milliseconds';
9
+ export type { number_model_temperature, number_percent, number_seed } from './number_percent';
10
+ export type { number_integer, number_negative, number_port, number_positive } from './number_positive';
@@ -0,0 +1,9 @@
1
+ import type { string_sha256 } from './string_sha256';
2
+ /**
3
+ * Semantic helper
4
+ *
5
+ * For example `"b126926439c5fcb83609888a11283723c1ef137c0ad599a77a1be81812bd221d"`
6
+ *
7
+ * @private internal utility of `string_parameter_name.ts`
8
+ */
9
+ export type string_agent_hash_private = string_sha256;
@@ -0,0 +1,8 @@
1
+ /**
2
+ * Semantic helper
3
+ *
4
+ * For example `"My AI Assistant"`
5
+ *
6
+ * @private internal utility of `string_parameter_name.ts`
7
+ */
8
+ export type string_agent_name_in_book_private = string;
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Semantic helper
3
+ *
4
+ * For example `"My AI Assistant"`
5
+ *
6
+ * TODO: !!!! Brand the type
7
+ * @private internal utility of `string_parameter_name.ts`
8
+ */
9
+ export type string_agent_name_private = string;
@@ -0,0 +1,10 @@
1
+ import type { string_base_58 } from './string_sha256';
2
+ /**
3
+ * Semantic helper
4
+ *
5
+ * For example `"3mJr7AoUXx2Wqd"`
6
+ *
7
+ * TODO: !!!! Brand the type
8
+ * @private internal utility of `string_parameter_name.ts`
9
+ */
10
+ export type string_agent_permanent_id_private = string_base_58;