@promptbook/browser 0.112.0-32 → 0.112.0-35

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 (1518) hide show
  1. package/README.md +18 -0
  2. package/esm/index.es.js +607 -600
  3. package/esm/index.es.js.map +1 -1
  4. package/esm/src/_packages/types.index.d.ts +94 -94
  5. package/esm/src/book-2.0/agent-source/AgentBasicInformation.d.ts +3 -4
  6. package/esm/src/book-2.0/agent-source/AgentModelRequirements.d.ts +0 -4
  7. package/esm/src/book-2.0/agent-source/createAgentModelRequirements.d.ts +7 -0
  8. package/esm/src/book-2.0/agent-source/createTeamToolName.d.ts +1 -0
  9. package/esm/src/book-2.0/agent-source/extractOpenTeacherInstructions.d.ts +1 -0
  10. package/esm/src/book-2.0/agent-source/padBook.d.ts +1 -4
  11. package/esm/src/book-2.0/agent-source/parseAgentSource.d.ts +0 -3
  12. package/esm/src/book-2.0/agent-source/parseAgentSourcePrelude.d.ts +1 -0
  13. package/esm/src/book-2.0/agent-source/parseParameters.d.ts +1 -0
  14. package/esm/src/book-2.0/agent-source/parseTeamCommitment.d.ts +0 -3
  15. package/esm/src/book-2.0/agent-source/pseudoAgentReferences.d.ts +8 -3
  16. package/esm/src/book-2.0/agent-source/string_book.d.ts +1 -0
  17. package/esm/src/book-2.0/utils/generatePlaceholderAgentProfileImageUrl.d.ts +0 -3
  18. package/esm/src/book-components/AvatarProfile/AvatarChip/AvatarChip.d.ts +0 -3
  19. package/esm/src/book-components/AvatarProfile/AvatarProfile/AvatarProfile.d.ts +0 -3
  20. package/esm/src/book-components/AvatarProfile/AvatarProfile/AvatarProfileTooltip.d.ts +4 -0
  21. package/esm/src/book-components/BookEditor/BookEditor.d.ts +0 -3
  22. package/esm/src/book-components/BookEditor/BookEditorActionbar.d.ts +4 -0
  23. package/esm/src/book-components/BookEditor/BookEditorMonaco.d.ts +2 -0
  24. package/esm/src/book-components/BookEditor/BookEditorMonacoUploadPanel.d.ts +3 -0
  25. package/esm/src/book-components/BookEditor/createDeprecatedCommitmentDiagnostics.d.ts +1 -0
  26. package/esm/src/book-components/BookEditor/useBookEditorMonacoDecorations.d.ts +6 -0
  27. package/esm/src/book-components/BookEditor/useBookEditorMonacoDiagnostics.d.ts +9 -0
  28. package/esm/src/book-components/BookEditor/useBookEditorMonacoLanguage.d.ts +7 -0
  29. package/esm/src/book-components/BookEditor/useBookEditorMonacoStyles.d.ts +3 -0
  30. package/esm/src/book-components/BookEditor/useBookEditorMonacoUploads.d.ts +24 -0
  31. package/esm/src/book-components/Chat/AgentChat/AgentChat.d.ts +0 -3
  32. package/esm/src/book-components/Chat/AgentChip/AgentChip.d.ts +6 -5
  33. package/esm/src/book-components/Chat/Chat/ChatInputAreaDictationPanel.d.ts +38 -0
  34. package/esm/src/book-components/Chat/Chat/ChatMessageItem.d.ts +1 -14
  35. package/esm/src/book-components/Chat/Chat/ChatMessageRichContent.d.ts +32 -0
  36. package/esm/src/book-components/Chat/Chat/ChatMessageToolCallChips.d.ts +22 -0
  37. package/esm/src/book-components/Chat/Chat/ChatProps.d.ts +2 -3
  38. package/esm/src/book-components/Chat/Chat/ChatSelfLearningSummary.d.ts +0 -3
  39. package/esm/src/book-components/Chat/Chat/ChatToolCallModalComponents.d.ts +0 -3
  40. package/esm/src/book-components/Chat/Chat/StreamingFeaturePlaceholder.d.ts +34 -0
  41. package/esm/src/book-components/Chat/Chat/TeamToolCallModalContent.d.ts +1 -0
  42. package/esm/src/book-components/Chat/Chat/chatCssClassNames.d.ts +1 -0
  43. package/esm/src/book-components/Chat/Chat/constants.d.ts +4 -3
  44. package/esm/src/book-components/Chat/Chat/createChatMessageToolCallRenderModel.d.ts +76 -0
  45. package/esm/src/book-components/Chat/Chat/createProgressCardChecklistMarkdown.d.ts +16 -0
  46. package/esm/src/book-components/Chat/Chat/insertDictationChunk.d.ts +16 -0
  47. package/esm/src/book-components/Chat/Chat/learnDictationDictionary.d.ts +7 -0
  48. package/esm/src/book-components/Chat/Chat/refineFinalDictationChunk.d.ts +36 -0
  49. package/esm/src/book-components/Chat/Chat/renderAdvancedToolCallDetails.d.ts +3 -0
  50. package/esm/src/book-components/Chat/Chat/renderEmailToolCallDetails.d.ts +27 -0
  51. package/esm/src/book-components/Chat/Chat/renderMemoryToolCallDetails.d.ts +32 -0
  52. package/esm/src/book-components/Chat/Chat/renderPopupToolCallDetails.d.ts +33 -0
  53. package/esm/src/book-components/Chat/Chat/renderRunBrowserToolCallDetails.d.ts +32 -0
  54. package/esm/src/book-components/Chat/Chat/renderSearchToolCallDetails.d.ts +32 -0
  55. package/esm/src/book-components/Chat/Chat/renderSelfLearningToolCallDetails.d.ts +39 -0
  56. package/esm/src/book-components/Chat/Chat/renderTimeToolCallDetails.d.ts +39 -0
  57. package/esm/src/book-components/Chat/Chat/renderTimeoutToolCallDetails.d.ts +47 -0
  58. package/esm/src/book-components/Chat/Chat/renderToolCallClockPanel.d.ts +34 -0
  59. package/esm/src/book-components/Chat/Chat/renderToolCallDetails.d.ts +3 -2
  60. package/esm/src/book-components/Chat/Chat/renderToolCallProgressPlaceholder.d.ts +30 -0
  61. package/esm/src/book-components/Chat/Chat/renderWalletCredentialToolCallDetails.d.ts +27 -0
  62. package/esm/src/book-components/Chat/Chat/resolveSpeechRecognitionUiDescriptor.d.ts +30 -0
  63. package/esm/src/book-components/Chat/Chat/resolveToolCallProgressMessage.d.ts +10 -0
  64. package/esm/src/book-components/Chat/Chat/useChatInputAreaAttachments.d.ts +32 -0
  65. package/esm/src/book-components/Chat/Chat/useChatInputAreaDictation.d.ts +53 -0
  66. package/esm/src/book-components/Chat/Chat/useChatInputAreaDictationPersistence.d.ts +20 -0
  67. package/esm/src/book-components/Chat/Chat/useChatInputAreaDictationSupport.d.ts +29 -0
  68. package/esm/src/book-components/Chat/Chat/useChatMessageAvatarTooltip.d.ts +31 -0
  69. package/esm/src/book-components/Chat/Chat/useChatMessageSpeechPlayback.d.ts +29 -0
  70. package/esm/src/book-components/Chat/LlmChat/defaults.d.ts +0 -3
  71. package/esm/src/book-components/Chat/MarkdownContent/MarkdownContent.d.ts +3 -3
  72. package/esm/src/book-components/Chat/MockedChat/constants.d.ts +0 -3
  73. package/esm/src/book-components/Chat/SourceChip/SourceChip.d.ts +4 -3
  74. package/esm/src/book-components/Chat/effects/components/ConfettiEffect.d.ts +3 -0
  75. package/esm/src/book-components/Chat/effects/components/HeartsEffect.d.ts +3 -0
  76. package/esm/src/book-components/Chat/effects/index.d.ts +0 -4
  77. package/esm/src/book-components/Chat/effects/utils/detectEffects.d.ts +1 -0
  78. package/esm/src/book-components/Chat/hooks/useSendMessageToLlmChat.d.ts +4 -4
  79. package/esm/src/book-components/Chat/save/_common/string_chat_format_name.d.ts +1 -0
  80. package/esm/src/book-components/Chat/save/html/htmlSaveFormatDefinition.d.ts +0 -3
  81. package/esm/src/book-components/Chat/save/index.d.ts +0 -3
  82. package/esm/src/book-components/Chat/save/pdf/buildChatPdf.d.ts +1 -0
  83. package/esm/src/book-components/Chat/save/pdf/pdfSaveFormatDefinition.d.ts +0 -4
  84. package/esm/src/book-components/Chat/types/ChatMessage.d.ts +3 -5
  85. package/esm/src/book-components/Chat/types/ChatParticipant.d.ts +0 -3
  86. package/esm/src/book-components/Chat/utils/ExportFormat.d.ts +2 -0
  87. package/esm/src/book-components/Chat/utils/citationHelpers.d.ts +4 -3
  88. package/esm/src/book-components/Chat/utils/collectTeamToolCallSummary.d.ts +1 -0
  89. package/esm/src/book-components/Chat/utils/createCitationFootnoteRenderModel.d.ts +1 -0
  90. package/esm/src/book-components/Chat/utils/exportChatHistory.d.ts +0 -3
  91. package/esm/src/book-components/Chat/utils/formatToolCallLocalTime.d.ts +2 -1
  92. package/esm/src/book-components/Chat/utils/loadAgentProfile.d.ts +12 -0
  93. package/esm/src/book-components/Chat/utils/parseCitationsFromContent.d.ts +0 -3
  94. package/esm/src/book-components/Chat/utils/parseImagePrompts.d.ts +1 -3
  95. package/esm/src/book-components/Chat/utils/sanitizeStreamingMessageContent.d.ts +14 -0
  96. package/esm/src/book-components/Chat/utils/thinkingMessageVariants.d.ts +3 -0
  97. package/esm/src/book-components/Chat/utils/timeoutToolCallPresentation.d.ts +0 -3
  98. package/esm/src/book-components/Chat/utils/toolCallParsing/extractSearchResults.d.ts +1 -0
  99. package/esm/src/book-components/Chat/utils/toolCallParsing/getToolCallResultDate.d.ts +1 -0
  100. package/esm/src/book-components/Chat/utils/toolCallParsing/getToolCallTimestamp.d.ts +1 -0
  101. package/esm/src/book-components/Chat/utils/toolCallParsing/parseRunBrowserToolResult.d.ts +1 -0
  102. package/esm/src/book-components/Chat/utils/toolCallParsing/parseTeamToolResult.d.ts +1 -0
  103. package/esm/src/book-components/Chat/utils/toolCallParsing/parseToolCallArguments.d.ts +1 -0
  104. package/esm/src/book-components/Chat/utils/toolCallParsing/parseToolCallResult.d.ts +1 -0
  105. package/esm/src/book-components/Chat/utils/toolCallParsing/resolveRunBrowserArtifactUrl.d.ts +1 -0
  106. package/esm/src/book-components/Chat/utils/walletCredentialToolCall.d.ts +3 -3
  107. package/esm/src/book-components/PromptbookAgent/PromptbookAgentIntegration.d.ts +3 -5
  108. package/esm/src/book-components/PromptbookAgent/PromptbookAgentSeamlessIntegration.d.ts +3 -5
  109. package/esm/src/book-components/Qr/BrandedQrCode.d.ts +5 -0
  110. package/esm/src/book-components/Qr/GenericQrCode.d.ts +5 -0
  111. package/esm/src/book-components/Qr/PromptbookQrCode.d.ts +5 -0
  112. package/esm/src/book-components/Qr/useQrCode.d.ts +4 -1
  113. package/esm/src/book-components/_common/Dropdown/Dropdown.d.ts +4 -0
  114. package/esm/src/book-components/_common/HamburgerMenu/HamburgerMenu.d.ts +4 -0
  115. package/esm/src/book-components/_common/MenuHoisting/MenuHoistingContext.d.ts +3 -3
  116. package/esm/src/book-components/_common/Modal/Modal.d.ts +1 -3
  117. package/esm/src/book-components/_common/Tooltip/Tooltip.d.ts +3 -0
  118. package/esm/src/book-components/icons/AboutIcon.d.ts +1 -0
  119. package/esm/src/book-components/icons/AttachmentIcon.d.ts +4 -0
  120. package/esm/src/book-components/icons/CameraIcon.d.ts +4 -0
  121. package/esm/src/book-components/icons/DownloadIcon.d.ts +1 -0
  122. package/esm/src/book-components/icons/EmailIcon.d.ts +1 -0
  123. package/esm/src/book-components/icons/MenuIcon.d.ts +1 -3
  124. package/esm/src/book-components/icons/SaveIcon.d.ts +1 -0
  125. package/esm/src/book-components/icons/SendIcon.d.ts +0 -3
  126. package/esm/src/book-components/icons/TeacherIcon.d.ts +1 -0
  127. package/esm/src/cli/$runPromptbookCli.d.ts +0 -3
  128. package/esm/src/cli/cli-commands/_boilerplate.d.ts +0 -4
  129. package/esm/src/cli/cli-commands/about.d.ts +0 -6
  130. package/esm/src/cli/cli-commands/coder/ThinkingLevel.d.ts +18 -0
  131. package/esm/src/cli/cli-commands/coder/find-fresh-emoji-tags.d.ts +0 -4
  132. package/esm/src/cli/cli-commands/coder/find-refactor-candidates.d.ts +0 -4
  133. package/esm/src/cli/cli-commands/coder/generate-boilerplates.d.ts +0 -4
  134. package/esm/src/cli/cli-commands/coder/init.d.ts +0 -4
  135. package/esm/src/cli/cli-commands/coder/run.d.ts +1 -5
  136. package/esm/src/cli/cli-commands/coder/run.test.d.ts +1 -0
  137. package/esm/src/cli/cli-commands/coder/verify.d.ts +0 -4
  138. package/esm/src/cli/cli-commands/coder.d.ts +0 -4
  139. package/esm/src/cli/cli-commands/common/handleActionErrors.d.ts +4 -0
  140. package/esm/src/cli/cli-commands/hello.d.ts +0 -5
  141. package/esm/src/cli/cli-commands/list-models.d.ts +0 -4
  142. package/esm/src/cli/cli-commands/list-scrapers.d.ts +0 -4
  143. package/esm/src/cli/cli-commands/login.d.ts +0 -5
  144. package/esm/src/cli/cli-commands/make.d.ts +1 -1
  145. package/esm/src/cli/cli-commands/prettify.d.ts +0 -6
  146. package/esm/src/cli/cli-commands/run.d.ts +0 -8
  147. package/esm/src/cli/cli-commands/runInteractiveChatbot.d.ts +1 -5
  148. package/esm/src/cli/cli-commands/start-agents-server.d.ts +0 -4
  149. package/esm/src/cli/cli-commands/start-pipelines-server.d.ts +0 -5
  150. package/esm/src/cli/cli-commands/test-command.d.ts +0 -7
  151. package/esm/src/cli/common/$provideLlmToolsForCli.d.ts +5 -0
  152. package/esm/src/cli/main.d.ts +0 -4
  153. package/esm/src/cli/promptbookCli.d.ts +0 -7
  154. package/esm/src/collection/agent-collection/AgentCollection.d.ts +0 -3
  155. package/esm/src/collection/agent-collection/constructors/agent-collection-in-supabase/AgentCollectionInSupabase.d.ts +2 -6
  156. package/esm/src/collection/agent-collection/constructors/agent-collection-in-supabase/AgentCollectionInSupabaseOptions.d.ts +3 -0
  157. package/esm/src/collection/pipeline-collection/SimplePipelineCollection.d.ts +2 -1
  158. package/esm/src/collection/pipeline-collection/constructors/createPipelineCollectionFromDirectory.d.ts +2 -5
  159. package/esm/src/collection/pipeline-collection/constructors/createPipelineCollectionFromJson.d.ts +1 -0
  160. package/esm/src/collection/pipeline-collection/constructors/createPipelineCollectionFromPromise.d.ts +4 -3
  161. package/esm/src/collection/pipeline-collection/constructors/createPipelineCollectionFromUrl.d.ts +2 -3
  162. package/esm/src/collection/pipeline-collection/constructors/createPipelineSubcollection.d.ts +1 -0
  163. package/esm/src/collection/pipeline-collection/pipelineCollectionToJson.d.ts +0 -3
  164. package/esm/src/commands/BOOK_VERSION/BookVersionCommand.d.ts +1 -0
  165. package/esm/src/commands/BOOK_VERSION/bookVersionCommandParser.d.ts +1 -0
  166. package/esm/src/commands/EXPECT/ExpectCommand.d.ts +0 -3
  167. package/esm/src/commands/EXPECT/expectCommandParser.d.ts +3 -2
  168. package/esm/src/commands/FOREACH/ForeachCommand.d.ts +1 -0
  169. package/esm/src/commands/FOREACH/foreachCommandParser.d.ts +1 -3
  170. package/esm/src/commands/FORMAT/formatCommandParser.d.ts +1 -0
  171. package/esm/src/commands/FORMFACTOR/FormfactorCommand.d.ts +1 -0
  172. package/esm/src/commands/FORMFACTOR/formfactorCommandParser.d.ts +1 -0
  173. package/esm/src/commands/JOKER/JokerCommand.d.ts +1 -0
  174. package/esm/src/commands/JOKER/jokerCommandParser.d.ts +1 -0
  175. package/esm/src/commands/KNOWLEDGE/KnowledgeCommand.d.ts +1 -0
  176. package/esm/src/commands/KNOWLEDGE/knowledgeCommandParser.d.ts +1 -3
  177. package/esm/src/commands/KNOWLEDGE/utils/knowledgeSourceContentToName.d.ts +0 -3
  178. package/esm/src/commands/KNOWLEDGE/utils/knowledgeSourceContentToName.test.d.ts +0 -3
  179. package/esm/src/commands/MODEL/ModelCommand.d.ts +1 -0
  180. package/esm/src/commands/MODEL/modelCommandParser.d.ts +1 -0
  181. package/esm/src/commands/PARAMETER/ParameterCommand.d.ts +1 -0
  182. package/esm/src/commands/PARAMETER/parameterCommandParser.d.ts +1 -0
  183. package/esm/src/commands/PERSONA/PersonaCommand.d.ts +1 -0
  184. package/esm/src/commands/PERSONA/personaCommandParser.d.ts +1 -0
  185. package/esm/src/commands/POSTPROCESS/PostprocessCommand.d.ts +1 -0
  186. package/esm/src/commands/POSTPROCESS/postprocessCommandParser.d.ts +1 -0
  187. package/esm/src/commands/SECTION/SectionCommand.d.ts +1 -0
  188. package/esm/src/commands/SECTION/sectionCommandParser.d.ts +1 -0
  189. package/esm/src/commands/URL/UrlCommand.d.ts +1 -0
  190. package/esm/src/commands/URL/urlCommandParser.d.ts +1 -0
  191. package/esm/src/commands/X_ACTION/ActionCommand.d.ts +1 -0
  192. package/esm/src/commands/X_ACTION/actionCommandParser.d.ts +1 -3
  193. package/esm/src/commands/X_INSTRUMENT/InstrumentCommand.d.ts +1 -0
  194. package/esm/src/commands/X_INSTRUMENT/instrumentCommandParser.d.ts +1 -3
  195. package/esm/src/commands/_BOILERPLATE/BoilerplateCommand.d.ts +1 -0
  196. package/esm/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts +1 -0
  197. package/esm/src/commands/_common/stringifyCommand.d.ts +1 -1
  198. package/esm/src/commands/_common/types/CommandParser.d.ts +0 -4
  199. package/esm/src/commands/index.d.ts +0 -3
  200. package/esm/src/commitments/ACTION/ACTION.d.ts +0 -3
  201. package/esm/src/commitments/CLOSED/CLOSED.d.ts +0 -3
  202. package/esm/src/commitments/CLOSED/CLOSED.test.d.ts +0 -3
  203. package/esm/src/commitments/COMPONENT/COMPONENT.d.ts +0 -3
  204. package/esm/src/commitments/DELETE/DELETE.d.ts +0 -3
  205. package/esm/src/commitments/DICTIONARY/DICTIONARY.d.ts +0 -3
  206. package/esm/src/commitments/FORMAT/FORMAT.d.ts +0 -3
  207. package/esm/src/commitments/FROM/FROM.d.ts +0 -3
  208. package/esm/src/commitments/GOAL/GOAL.d.ts +0 -3
  209. package/esm/src/commitments/IMPORT/IMPORT.d.ts +0 -3
  210. package/esm/src/commitments/LANGUAGE/LANGUAGE.d.ts +0 -3
  211. package/esm/src/commitments/MEMORY/MEMORY.d.ts +0 -3
  212. package/esm/src/commitments/MESSAGE/MESSAGE.d.ts +0 -3
  213. package/esm/src/commitments/MESSAGE_SUFFIX/MESSAGE_SUFFIX.d.ts +0 -3
  214. package/esm/src/commitments/META/META.d.ts +0 -3
  215. package/esm/src/commitments/META/META_DESCRIPTION.d.ts +0 -3
  216. package/esm/src/commitments/META_COLOR/META_COLOR.d.ts +0 -3
  217. package/esm/src/commitments/META_DISCLAIMER/META_DISCLAIMER.d.ts +0 -3
  218. package/esm/src/commitments/META_DOMAIN/META_DOMAIN.d.ts +0 -3
  219. package/esm/src/commitments/META_FONT/META_FONT.d.ts +0 -3
  220. package/esm/src/commitments/META_IMAGE/META_IMAGE.d.ts +0 -3
  221. package/esm/src/commitments/META_INPUT_PLACEHOLDER/META_INPUT_PLACEHOLDER.d.ts +0 -3
  222. package/esm/src/commitments/META_LINK/META_LINK.d.ts +0 -3
  223. package/esm/src/commitments/META_VOICE/META_VOICE.d.ts +0 -3
  224. package/esm/src/commitments/MODEL/MODEL.d.ts +0 -3
  225. package/esm/src/commitments/OPEN/OPEN.d.ts +0 -3
  226. package/esm/src/commitments/PERSONA/PERSONA.d.ts +0 -3
  227. package/esm/src/commitments/RULE/RULE.d.ts +0 -3
  228. package/esm/src/commitments/SAMPLE/SAMPLE.d.ts +0 -3
  229. package/esm/src/commitments/SCENARIO/SCENARIO.d.ts +0 -3
  230. package/esm/src/commitments/TEAM/TEAM.d.ts +0 -3
  231. package/esm/src/commitments/TEMPLATE/TEMPLATE.d.ts +0 -3
  232. package/esm/src/commitments/USE/USE.d.ts +0 -3
  233. package/esm/src/commitments/USE/aggregateUseCommitmentSystemMessages.d.ts +2 -0
  234. package/esm/src/commitments/USE_BROWSER/USE_BROWSER.d.ts +0 -3
  235. package/esm/src/commitments/USE_BROWSER/fetchUrlContent.d.ts +4 -7
  236. package/esm/src/commitments/USE_CALENDAR/USE_CALENDAR.d.ts +0 -3
  237. package/esm/src/commitments/USE_CALENDAR/calendarReference.d.ts +0 -3
  238. package/esm/src/commitments/USE_EMAIL/USE_EMAIL.d.ts +0 -3
  239. package/esm/src/commitments/USE_IMAGE_GENERATOR/USE_IMAGE_GENERATOR.d.ts +0 -3
  240. package/esm/src/commitments/USE_MCP/USE_MCP.d.ts +0 -3
  241. package/esm/src/commitments/USE_POPUP/USE_POPUP.d.ts +0 -3
  242. package/esm/src/commitments/USE_PRIVACY/USE_PRIVACY.d.ts +0 -3
  243. package/esm/src/commitments/USE_PROJECT/USE_PROJECT.d.ts +0 -3
  244. package/esm/src/commitments/USE_PROJECT/projectReference.d.ts +0 -3
  245. package/esm/src/commitments/USE_SEARCH_ENGINE/USE_SEARCH_ENGINE.d.ts +0 -3
  246. package/esm/src/commitments/USE_SPAWN/USE_SPAWN.d.ts +0 -3
  247. package/esm/src/commitments/USE_TIME/USE_TIME.d.ts +0 -3
  248. package/esm/src/commitments/USE_TIMEOUT/USE_TIMEOUT.d.ts +0 -3
  249. package/esm/src/commitments/USE_USER_LOCATION/USE_USER_LOCATION.d.ts +0 -3
  250. package/esm/src/commitments/WALLET/WALLET.d.ts +0 -3
  251. package/esm/src/commitments/WRITING_RULES/WRITING_RULES.d.ts +0 -3
  252. package/esm/src/commitments/WRITING_SAMPLE/WRITING_SAMPLE.d.ts +0 -3
  253. package/esm/src/commitments/_base/createEmptyAgentModelRequirements.d.ts +0 -3
  254. package/esm/src/commitments/_common/commitmentToolFunctions.d.ts +2 -3
  255. package/esm/src/commitments/_common/createWritingCommitmentSections.d.ts +2 -3
  256. package/esm/src/commitments/_common/getAllCommitmentDefinitions.d.ts +1 -0
  257. package/esm/src/commitments/_common/getAllCommitmentTypes.d.ts +1 -0
  258. package/esm/src/commitments/_common/getAllCommitmentsToolFunctionsForNode.d.ts +0 -4
  259. package/esm/src/commitments/_common/getCommitmentDefinition.d.ts +1 -0
  260. package/esm/src/commitments/_common/isCommitmentSupported.d.ts +1 -0
  261. package/esm/src/commitments/_common/toolExecutionEnvelope.d.ts +0 -3
  262. package/esm/src/commitments/_common/toolRuntimeContext.d.ts +3 -3
  263. package/esm/src/commitments/index.d.ts +0 -4
  264. package/esm/src/config.test.d.ts +0 -3
  265. package/esm/src/constants/streaming.d.ts +0 -3
  266. package/esm/src/constants.d.ts +0 -3
  267. package/esm/src/conversion/archive/loadArchive.d.ts +0 -3
  268. package/esm/src/conversion/archive/saveArchive.d.ts +0 -5
  269. package/esm/src/conversion/compilePipeline.d.ts +2 -7
  270. package/esm/src/conversion/compilePipelineOnRemoteServer.d.ts +2 -5
  271. package/esm/src/conversion/parsePipeline.d.ts +1 -11
  272. package/esm/src/conversion/pipelineJsonToString.d.ts +1 -7
  273. package/esm/src/conversion/prettify/prettifyPipelineString.d.ts +0 -4
  274. package/esm/src/conversion/prettify/renderPipelineMermaidOptions.d.ts +0 -7
  275. package/esm/src/conversion/utils/extractParameterNamesFromTask.d.ts +1 -3
  276. package/esm/src/conversion/validation/_importPipeline.d.ts +6 -4
  277. package/esm/src/conversion/validation/pipelineStringToJson-parseErrors.test.d.ts +0 -3
  278. package/esm/src/conversion/validation/validatePipeline-logicErrors.test.d.ts +0 -3
  279. package/esm/src/conversion/validation/validatePipeline.d.ts +3 -9
  280. package/esm/src/conversion/validation/validatePipeline.test.d.ts +0 -3
  281. package/esm/src/dialogs/simple-prompt/SimplePromptInterfaceTools.d.ts +1 -4
  282. package/esm/src/errors/0-BoilerplateError.d.ts +0 -3
  283. package/esm/src/errors/0-index.d.ts +0 -3
  284. package/esm/src/errors/DatabaseError.d.ts +0 -3
  285. package/esm/src/errors/ExpectError.d.ts +2 -1
  286. package/esm/src/errors/ParseError.d.ts +0 -3
  287. package/esm/src/errors/PipelineExecutionError.d.ts +0 -3
  288. package/esm/src/executables/$provideExecutablesForNode.d.ts +0 -5
  289. package/esm/src/executables/apps/locateLibreoffice.d.ts +0 -4
  290. package/esm/src/executables/apps/locatePandoc.d.ts +0 -4
  291. package/esm/src/executables/browsers/locateBrowser.d.ts +0 -1
  292. package/esm/src/executables/browsers/locateDefaultSystemBrowser.d.ts +0 -1
  293. package/esm/src/executables/locateApp.d.ts +0 -4
  294. package/esm/src/executables/platforms/locateAppOnLinux.d.ts +0 -4
  295. package/esm/src/executables/platforms/locateAppOnMacOs.d.ts +0 -4
  296. package/esm/src/executables/platforms/locateAppOnWindows.d.ts +0 -4
  297. package/esm/src/execution/AbstractTaskResult.d.ts +0 -4
  298. package/esm/src/execution/AvailableModel.d.ts +0 -4
  299. package/esm/src/execution/CommonToolsOptions.d.ts +0 -5
  300. package/esm/src/execution/ExecutionTask.d.ts +4 -4
  301. package/esm/src/execution/FilesystemTools.d.ts +0 -3
  302. package/esm/src/execution/LlmExecutionTools.d.ts +3 -9
  303. package/esm/src/execution/LlmExecutionToolsConstructor.d.ts +0 -3
  304. package/esm/src/execution/PipelineExecutor.d.ts +0 -3
  305. package/esm/src/execution/PipelineExecutorResult.d.ts +0 -3
  306. package/esm/src/execution/PromptResult.d.ts +1 -9
  307. package/esm/src/execution/PromptbookFetch.test-type.d.ts +0 -4
  308. package/esm/src/execution/ScriptExecutionTools.d.ts +0 -4
  309. package/esm/src/execution/Usage.d.ts +0 -3
  310. package/esm/src/execution/UserInterfaceTools.d.ts +3 -0
  311. package/esm/src/execution/assertsTaskSuccessful.d.ts +1 -3
  312. package/esm/src/execution/createPipelineExecutor/00-createPipelineExecutor.d.ts +1 -0
  313. package/esm/src/execution/createPipelineExecutor/20-executeTask.d.ts +0 -3
  314. package/esm/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +1 -3
  315. package/esm/src/execution/createPipelineExecutor/getContextForTask.d.ts +1 -0
  316. package/esm/src/execution/createPipelineExecutor/getKnowledgeForTask.d.ts +0 -4
  317. package/esm/src/execution/createPipelineExecutor/knowledgePiecesToString.d.ts +0 -1
  318. package/esm/src/execution/execution-report/ExecutionReportJson.d.ts +1 -0
  319. package/esm/src/execution/execution-report/ExecutionReportString.d.ts +0 -3
  320. package/esm/src/execution/execution-report/executionReportJsonToString.d.ts +0 -5
  321. package/esm/src/execution/translation/automatic-translate/automatic-translators/AutomaticTranslator.d.ts +3 -1
  322. package/esm/src/execution/translation/automatic-translate/automatic-translators/FakeAutomaticTranslator.d.ts +3 -1
  323. package/esm/src/execution/translation/automatic-translate/automatic-translators/TranslatorOptions.d.ts +3 -1
  324. package/esm/src/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.d.ts +2 -0
  325. package/esm/src/execution/translation/automatic-translate/translateMessages.d.ts +3 -5
  326. package/esm/src/execution/utils/$provideExecutionToolsForNode.d.ts +2 -6
  327. package/esm/src/execution/utils/checkExpectations.d.ts +2 -5
  328. package/esm/src/execution/utils/forEachAsync.d.ts +5 -1
  329. package/esm/src/execution/utils/usage-constants.d.ts +0 -3
  330. package/esm/src/execution/utils/usageToHuman.d.ts +0 -8
  331. package/esm/src/execution/utils/validatePromptResult.d.ts +1 -0
  332. package/esm/src/file-security-checkers/virustotal/VirusTotalFileSecurityChecker.d.ts +1 -0
  333. package/esm/src/formats/_common/FormatParser.d.ts +2 -9
  334. package/esm/src/formats/_common/FormatSubvalueParser.d.ts +0 -3
  335. package/esm/src/formats/csv/CsvFormatParser.d.ts +2 -8
  336. package/esm/src/formats/index.d.ts +0 -3
  337. package/esm/src/formats/json/JsonFormatParser.d.ts +0 -11
  338. package/esm/src/formats/text/TextFormatParser.d.ts +0 -9
  339. package/esm/src/formats/xml/XmlFormatParser.d.ts +0 -11
  340. package/esm/src/formfactors/_common/AbstractFormfactorDefinition.d.ts +1 -3
  341. package/esm/src/formfactors/_common/FormfactorDefinition.d.ts +1 -0
  342. package/esm/src/formfactors/index.d.ts +0 -3
  343. package/esm/src/high-level-abstractions/_common/HighLevelAbstraction.d.ts +0 -5
  344. package/esm/src/high-level-abstractions/index.d.ts +0 -4
  345. package/esm/src/high-level-abstractions/quick-chatbot/QuickChatbotHla.d.ts +0 -3
  346. package/esm/src/llm-providers/_common/register/$llmToolsMetadataRegister.d.ts +2 -3
  347. package/esm/src/llm-providers/_common/register/$llmToolsRegister.d.ts +2 -3
  348. package/esm/src/llm-providers/_common/register/$provideEnvFilename.d.ts +0 -3
  349. package/esm/src/llm-providers/_common/register/$provideLlmToolsConfigurationFromEnv.d.ts +1 -3
  350. package/esm/src/llm-providers/_common/register/$provideLlmToolsForTestingAndScriptsAndPlayground.d.ts +3 -6
  351. package/esm/src/llm-providers/_common/register/$provideLlmToolsForWizardOrCli.d.ts +3 -7
  352. package/esm/src/llm-providers/_common/register/$provideLlmToolsFromEnv.d.ts +1 -18
  353. package/esm/src/llm-providers/_common/register/$registeredLlmToolsMessage.d.ts +0 -4
  354. package/esm/src/llm-providers/_common/register/LlmToolsConfiguration.d.ts +0 -5
  355. package/esm/src/llm-providers/_common/register/LlmToolsMetadata.d.ts +0 -6
  356. package/esm/src/llm-providers/_common/register/LlmToolsOptions.d.ts +0 -4
  357. package/esm/src/llm-providers/_common/register/createLlmToolsFromConfiguration.d.ts +1 -0
  358. package/esm/src/llm-providers/_common/utils/assertUniqueModels.d.ts +0 -3
  359. package/esm/src/llm-providers/_common/utils/cache/CacheItem.d.ts +0 -3
  360. package/esm/src/llm-providers/_common/utils/cache/cacheLlmTools.d.ts +1 -0
  361. package/esm/src/llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage.d.ts +0 -4
  362. package/esm/src/llm-providers/_common/utils/count-total-usage/countUsage.d.ts +1 -0
  363. package/esm/src/llm-providers/_common/utils/count-total-usage/limitTotalUsage.d.ts +0 -7
  364. package/esm/src/llm-providers/_common/utils/removeUnsupportedModelRequirements.d.ts +4 -0
  365. package/esm/src/llm-providers/_multiple/MultipleLlmExecutionTools.d.ts +1 -0
  366. package/esm/src/llm-providers/_multiple/getSingleLlmExecutionTools.d.ts +0 -4
  367. package/esm/src/llm-providers/_multiple/joinLlmExecutionTools.d.ts +3 -7
  368. package/esm/src/llm-providers/_multiple/playground/playground.d.ts +0 -3
  369. package/esm/src/llm-providers/agent/Agent.d.ts +0 -3
  370. package/esm/src/llm-providers/agent/AgentLlmExecutionTools.d.ts +0 -4
  371. package/esm/src/llm-providers/agent/RemoteAgent.d.ts +0 -4
  372. package/esm/src/llm-providers/agent/playground/playground.d.ts +0 -6
  373. package/esm/src/llm-providers/agent/register-configuration.d.ts +0 -5
  374. package/esm/src/llm-providers/agent/register-constructor.d.ts +0 -4
  375. package/esm/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +2 -10
  376. package/esm/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions.d.ts +3 -3
  377. package/esm/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +1 -8
  378. package/esm/src/llm-providers/anthropic-claude/computeAnthropicClaudeUsage.d.ts +1 -3
  379. package/esm/src/llm-providers/anthropic-claude/computeAnthropicClaudeUsage.test.d.ts +0 -3
  380. package/esm/src/llm-providers/anthropic-claude/createAnthropicClaudeExecutionTools.d.ts +0 -7
  381. package/esm/src/llm-providers/anthropic-claude/playground/playground.d.ts +0 -5
  382. package/esm/src/llm-providers/anthropic-claude/register-configuration.d.ts +0 -3
  383. package/esm/src/llm-providers/anthropic-claude/register-constructor.d.ts +0 -5
  384. package/esm/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +0 -6
  385. package/esm/src/llm-providers/azure-openai/AzureOpenAiExecutionToolsOptions.d.ts +1 -0
  386. package/esm/src/llm-providers/azure-openai/createAzureOpenAiExecutionTools.d.ts +0 -4
  387. package/esm/src/llm-providers/azure-openai/playground/playground.d.ts +0 -4
  388. package/esm/src/llm-providers/azure-openai/register-configuration.d.ts +0 -3
  389. package/esm/src/llm-providers/azure-openai/register-constructor.d.ts +0 -4
  390. package/esm/src/llm-providers/deepseek/DeepseekExecutionToolsOptions.d.ts +1 -0
  391. package/esm/src/llm-providers/deepseek/createDeepseekExecutionTools.d.ts +0 -3
  392. package/esm/src/llm-providers/deepseek/deepseek-models.d.ts +1 -6
  393. package/esm/src/llm-providers/deepseek/register-configuration.d.ts +0 -3
  394. package/esm/src/llm-providers/deepseek/register-constructor.d.ts +0 -4
  395. package/esm/src/llm-providers/google/GoogleExecutionToolsOptions.d.ts +1 -0
  396. package/esm/src/llm-providers/google/createGoogleExecutionTools.d.ts +0 -4
  397. package/esm/src/llm-providers/google/google-models.d.ts +1 -6
  398. package/esm/src/llm-providers/google/register-configuration.d.ts +0 -3
  399. package/esm/src/llm-providers/google/register-constructor.d.ts +0 -4
  400. package/esm/src/llm-providers/mocked/$fakeTextToExpectations.d.ts +1 -5
  401. package/esm/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts +0 -4
  402. package/esm/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts +0 -3
  403. package/esm/src/llm-providers/mocked/test/joker.test.d.ts +0 -3
  404. package/esm/src/llm-providers/mocked/test/mocked-chat.test.d.ts +0 -4
  405. package/esm/src/llm-providers/mocked/test/mocked-completion.test.d.ts +0 -3
  406. package/esm/src/llm-providers/ollama/OllamaExecutionTools.d.ts +0 -3
  407. package/esm/src/llm-providers/ollama/OllamaExecutionToolsOptions.d.ts +1 -0
  408. package/esm/src/llm-providers/ollama/ollama-models.d.ts +1 -4
  409. package/esm/src/llm-providers/ollama/playground/playground.d.ts +0 -4
  410. package/esm/src/llm-providers/ollama/register-configuration.d.ts +0 -3
  411. package/esm/src/llm-providers/ollama/register-constructor.d.ts +0 -4
  412. package/esm/src/llm-providers/openai/OpenAiAgentKitExecutionTools.d.ts +10 -0
  413. package/esm/src/llm-providers/openai/OpenAiAssistantExecutionTools.d.ts +1 -8
  414. package/esm/src/llm-providers/openai/OpenAiCompatibleExecutionTools.d.ts +0 -7
  415. package/esm/src/llm-providers/openai/OpenAiCompatibleExecutionToolsOptions.d.ts +2 -0
  416. package/esm/src/llm-providers/openai/computeOpenAiUsage.d.ts +1 -3
  417. package/esm/src/llm-providers/openai/computeOpenAiUsage.test.d.ts +0 -3
  418. package/esm/src/llm-providers/openai/createOpenAiAssistantExecutionTools.d.ts +0 -4
  419. package/esm/src/llm-providers/openai/createOpenAiCompatibleExecutionTools.d.ts +0 -4
  420. package/esm/src/llm-providers/openai/createOpenAiExecutionTools.d.ts +0 -4
  421. package/esm/src/llm-providers/openai/openai-models.d.ts +1 -0
  422. package/esm/src/llm-providers/openai/openai-models.test.d.ts +0 -3
  423. package/esm/src/llm-providers/openai/playground/playground.d.ts +0 -4
  424. package/esm/src/llm-providers/openai/register-configuration.d.ts +0 -3
  425. package/esm/src/llm-providers/openai/register-constructor.d.ts +0 -4
  426. package/esm/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts +1 -9
  427. package/esm/src/llm-providers/remote/playground/playground.d.ts +0 -3
  428. package/esm/src/llm-providers/vercel/playground/playground.d.ts +0 -4
  429. package/esm/src/other/templates/getBookTemplates.d.ts +2 -5
  430. package/esm/src/personas/preparePersona.d.ts +1 -7
  431. package/esm/src/pipeline/PipelineInterface/PipelineInterface.d.ts +1 -0
  432. package/esm/src/pipeline/PipelineInterface/constants.d.ts +0 -3
  433. package/esm/src/pipeline/PipelineJson/CommonTaskJson.d.ts +0 -4
  434. package/esm/src/pipeline/PipelineJson/DialogTaskJson.d.ts +1 -3
  435. package/esm/src/pipeline/PipelineJson/Expectations.d.ts +4 -3
  436. package/esm/src/pipeline/PipelineJson/KnowledgePieceJson.d.ts +0 -4
  437. package/esm/src/pipeline/PipelineJson/KnowledgeSourceJson.d.ts +0 -3
  438. package/esm/src/pipeline/PipelineJson/PersonaJson.d.ts +0 -3
  439. package/esm/src/pipeline/PipelineJson/PreparationJson.d.ts +3 -5
  440. package/esm/src/pipeline/PipelineJson/ScriptTaskJson.d.ts +1 -4
  441. package/esm/src/pipeline/PipelineJson/SimpleTaskJson.d.ts +1 -3
  442. package/esm/src/pipeline/book-notation.d.ts +1 -4
  443. package/esm/src/pipeline/isValidPipelineString.d.ts +1 -3
  444. package/esm/src/pipeline/isValidPipelineString.test.d.ts +0 -3
  445. package/esm/src/pipeline/prompt-notation/helpers/ParameterEscaping.d.ts +5 -0
  446. package/esm/src/pipeline/prompt-notation/helpers/ParameterNaming.d.ts +1 -0
  447. package/esm/src/pipeline/prompt-notation/helpers/ParameterSection.d.ts +2 -0
  448. package/esm/src/pipeline/prompt-notation.d.ts +2 -5
  449. package/esm/src/pipeline/prompt-notation.test.d.ts +0 -3
  450. package/esm/src/pipeline/validatePipelineString.d.ts +1 -3
  451. package/esm/src/playground/permanent/_boilerplate.d.ts +0 -3
  452. package/esm/src/playground/permanent/agent-with-browser-playground.d.ts +0 -3
  453. package/esm/src/playground/permanent/error-handling-playground.d.ts +0 -3
  454. package/esm/src/playground/playground.d.ts +0 -4
  455. package/esm/src/postprocessing/utils/extractBlock.d.ts +2 -1
  456. package/esm/src/postprocessing/utils/extractJsonBlock.d.ts +2 -5
  457. package/esm/src/prepare/PrepareAndScrapeOptions.d.ts +0 -4
  458. package/esm/src/prepare/preparePipeline.d.ts +3 -2
  459. package/esm/src/prepare/preparePipelineOnRemoteServer.d.ts +2 -5
  460. package/esm/src/prepare/prepareTasks.d.ts +6 -10
  461. package/esm/src/prepare/unpreparePipeline.d.ts +1 -5
  462. package/esm/src/remote-server/RemoteServer.d.ts +3 -0
  463. package/esm/src/remote-server/openapi.d.ts +3 -4
  464. package/esm/src/remote-server/socket-types/_subtypes/Identification.d.ts +1 -5
  465. package/esm/src/remote-server/socket-types/listModels/PromptbookServer_ListModels_Request.d.ts +0 -3
  466. package/esm/src/remote-server/socket-types/listModels/PromptbookServer_ListModels_Response.d.ts +0 -3
  467. package/esm/src/remote-server/startAgentServer.d.ts +6 -4
  468. package/esm/src/remote-server/startRemoteServer.d.ts +1 -16
  469. package/esm/src/remote-server/types/RemoteClientOptions.d.ts +0 -5
  470. package/esm/src/remote-server/types/RemoteServerOptions.d.ts +10 -4
  471. package/esm/src/remote-server/ui/ServerApp.d.ts +1 -0
  472. package/esm/src/remote-server/ui/types.d.ts +3 -0
  473. package/esm/src/scrapers/_boilerplate/BoilerplateScraper.d.ts +1 -6
  474. package/esm/src/scrapers/_boilerplate/createBoilerplateScraper.d.ts +0 -3
  475. package/esm/src/scrapers/_boilerplate/playground/boilerplate-scraper-playground.d.ts +0 -3
  476. package/esm/src/scrapers/_boilerplate/register-constructor.d.ts +0 -4
  477. package/esm/src/scrapers/_boilerplate/register-metadata.d.ts +0 -3
  478. package/esm/src/scrapers/_common/Scraper.d.ts +0 -5
  479. package/esm/src/scrapers/_common/ScraperIntermediateSource.d.ts +0 -3
  480. package/esm/src/scrapers/_common/prepareKnowledgePieces.d.ts +1 -0
  481. package/esm/src/scrapers/_common/register/$provideFilesystemForNode.d.ts +0 -4
  482. package/esm/src/scrapers/_common/register/$provideScrapersForNode.d.ts +1 -4
  483. package/esm/src/scrapers/_common/register/$provideScriptingForNode.d.ts +0 -4
  484. package/esm/src/scrapers/_common/register/$registeredScrapersMessage.d.ts +0 -3
  485. package/esm/src/scrapers/_common/register/$scrapersMetadataRegister.d.ts +2 -3
  486. package/esm/src/scrapers/_common/register/$scrapersRegister.d.ts +2 -3
  487. package/esm/src/scrapers/_common/register/ScraperConstructor.d.ts +0 -3
  488. package/esm/src/scrapers/_common/utils/getScraperIntermediateSource.d.ts +0 -7
  489. package/esm/src/scrapers/_common/utils/getScraperIntermediateSource.test.d.ts +0 -3
  490. package/esm/src/scrapers/_common/utils/promptbookFetch.d.ts +0 -3
  491. package/esm/src/scrapers/document/DocumentScraper.d.ts +1 -6
  492. package/esm/src/scrapers/document/DocumentScraper.test.d.ts +0 -3
  493. package/esm/src/scrapers/document/createDocumentScraper.d.ts +0 -3
  494. package/esm/src/scrapers/document/playground/document-scraper-playground.d.ts +0 -3
  495. package/esm/src/scrapers/document/register-constructor.d.ts +0 -4
  496. package/esm/src/scrapers/document/register-metadata.d.ts +0 -3
  497. package/esm/src/scrapers/document-legacy/LegacyDocumentScraper.d.ts +1 -6
  498. package/esm/src/scrapers/document-legacy/LegacyDocumentScraper.test.d.ts +0 -3
  499. package/esm/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts +0 -3
  500. package/esm/src/scrapers/document-legacy/playground/legacy-document-scraper-playground.d.ts +0 -3
  501. package/esm/src/scrapers/document-legacy/register-constructor.d.ts +0 -4
  502. package/esm/src/scrapers/document-legacy/register-metadata.d.ts +0 -3
  503. package/esm/src/scrapers/markdown/MarkdownScraper.d.ts +1 -4
  504. package/esm/src/scrapers/markdown/MarkdownScraper.test.d.ts +0 -3
  505. package/esm/src/scrapers/markdown/createMarkdownScraper.d.ts +0 -3
  506. package/esm/src/scrapers/markdown/playground/markdown-scraper-playground.d.ts +0 -3
  507. package/esm/src/scrapers/markdown/register-constructor.d.ts +0 -4
  508. package/esm/src/scrapers/markdown/register-metadata.d.ts +0 -3
  509. package/esm/src/scrapers/markitdown/MarkitdownScraper.d.ts +1 -7
  510. package/esm/src/scrapers/markitdown/createMarkitdownScraper.d.ts +0 -4
  511. package/esm/src/scrapers/markitdown/playground/markitdown-scraper-playground.d.ts +0 -3
  512. package/esm/src/scrapers/markitdown/register-constructor.d.ts +0 -5
  513. package/esm/src/scrapers/markitdown/register-metadata.d.ts +0 -3
  514. package/esm/src/scrapers/pdf/PdfScraper.d.ts +1 -6
  515. package/esm/src/scrapers/pdf/createPdfScraper.d.ts +0 -3
  516. package/esm/src/scrapers/pdf/playground/pdf-scraper-playground.d.ts +0 -3
  517. package/esm/src/scrapers/pdf/register-constructor.d.ts +0 -4
  518. package/esm/src/scrapers/pdf/register-metadata.d.ts +0 -3
  519. package/esm/src/scrapers/website/WebsiteScraper.d.ts +1 -6
  520. package/esm/src/scrapers/website/createWebsiteScraper.d.ts +0 -3
  521. package/esm/src/scrapers/website/playground/website-scraper-playground.d.ts +0 -3
  522. package/esm/src/scrapers/website/register-constructor.d.ts +0 -4
  523. package/esm/src/scrapers/website/register-metadata.d.ts +0 -3
  524. package/esm/src/scripting/javascript/JavascriptEvalExecutionTools.d.ts +1 -5
  525. package/esm/src/scripting/javascript/JavascriptEvalExecutionTools.test.d.ts +0 -3
  526. package/esm/src/scripting/javascript/JavascriptExecutionTools.d.ts +1 -0
  527. package/esm/src/scripting/javascript/JavascriptExecutionToolsOptions.d.ts +0 -3
  528. package/esm/src/scripting/javascript/postprocessing-functions.d.ts +0 -4
  529. package/esm/src/scripting/javascript/utils/extractVariablesFromJavascript.d.ts +1 -3
  530. package/esm/src/search-engines/SearchEngine.d.ts +3 -0
  531. package/esm/src/speech-recognition/BrowserSpeechRecognition.d.ts +0 -4
  532. package/esm/src/speech-recognition/OpenAiSpeechRecognition.d.ts +2 -2
  533. package/esm/src/storage/_common/PromptbookStorage.d.ts +0 -4
  534. package/esm/src/storage/_common/PromptbookStorage.test-type.d.ts +0 -4
  535. package/esm/src/storage/env-storage/$EnvStorage.d.ts +0 -3
  536. package/esm/src/storage/file-cache-storage/FileCacheStorage.d.ts +0 -4
  537. package/esm/src/storage/local-storage/getIndexedDbStorage.d.ts +0 -3
  538. package/esm/src/storage/local-storage/getLocalStorage.d.ts +0 -3
  539. package/esm/src/storage/local-storage/getSessionStorage.d.ts +0 -3
  540. package/esm/src/storage/local-storage/utils/makePromptbookStorageFromIndexedDb.d.ts +1 -0
  541. package/esm/src/storage/local-storage/utils/makePromptbookStorageFromWebStorage.d.ts +0 -4
  542. package/esm/src/transpilers/_common/register/$bookTranspilersRegister.d.ts +1 -3
  543. package/esm/src/transpilers/formatted-book-in-markdown/register.d.ts +2 -5
  544. package/esm/src/transpilers/openai-sdk/playground/playground.d.ts +0 -3
  545. package/esm/src/transpilers/openai-sdk/register.d.ts +2 -5
  546. package/esm/src/types/Arrayable.d.ts +1 -0
  547. package/esm/src/types/InputParameters_private.d.ts +13 -0
  548. package/esm/src/types/IntermediateFilesStrategy.d.ts +0 -3
  549. package/esm/src/types/LlmCall.d.ts +0 -3
  550. package/esm/src/types/ModelRequirements.d.ts +1 -0
  551. package/esm/src/types/ModelVariant.d.ts +3 -0
  552. package/esm/src/types/Parameters.d.ts +31 -0
  553. package/esm/src/types/Parameters_private.d.ts +18 -0
  554. package/esm/src/types/Prompt.d.ts +1 -6
  555. package/esm/src/types/ReservedParameters_private.d.ts +11 -0
  556. package/esm/src/types/ToolCall.d.ts +0 -2
  557. package/esm/src/types/Updatable.d.ts +1 -3
  558. package/esm/src/types/number_bytes.d.ts +21 -0
  559. package/esm/src/types/number_id.d.ts +13 -0
  560. package/esm/src/types/number_likeness.d.ts +8 -0
  561. package/esm/src/types/number_milliseconds.d.ts +33 -0
  562. package/esm/src/types/number_percent.d.ts +18 -0
  563. package/esm/src/types/number_positive.d.ts +16 -0
  564. package/esm/src/types/number_usd.d.ts +6 -106
  565. package/esm/src/types/string_agent_hash_private.d.ts +9 -0
  566. package/esm/src/types/string_agent_name.d.ts +32 -0
  567. package/esm/src/types/string_agent_name_in_book_private.d.ts +8 -0
  568. package/esm/src/types/string_agent_name_private.d.ts +10 -0
  569. package/esm/src/types/string_agent_permanent_id_private.d.ts +11 -0
  570. package/esm/src/types/string_base64_private.d.ts +17 -0
  571. package/esm/src/types/string_business_category_name.d.ts +5 -0
  572. package/esm/src/types/string_business_category_name_private.d.ts +6 -0
  573. package/esm/src/types/string_char_private.d.ts +8 -0
  574. package/esm/src/types/string_chat_prompt_private.d.ts +9 -0
  575. package/esm/src/types/string_completion_prompt_private.d.ts +9 -0
  576. package/esm/src/types/string_email_private.d.ts +16 -0
  577. package/esm/src/types/string_host_private.d.ts +55 -0
  578. package/esm/src/types/string_markdown.d.ts +0 -1
  579. package/esm/src/types/string_mime_type_private.d.ts +18 -0
  580. package/esm/src/types/string_model_description_private.d.ts +8 -0
  581. package/esm/src/types/string_model_name.d.ts +7 -0
  582. package/esm/src/types/string_model_name_private.d.ts +8 -0
  583. package/esm/src/types/string_name.d.ts +31 -0
  584. package/esm/src/types/string_name_private.d.ts +9 -0
  585. package/esm/src/types/string_page.d.ts +15 -0
  586. package/esm/src/types/string_page_private.d.ts +9 -0
  587. package/esm/src/types/string_parameter_name.d.ts +11 -167
  588. package/esm/src/types/string_parameter_value_private.d.ts +9 -0
  589. package/esm/src/types/string_persona_description.d.ts +14 -0
  590. package/esm/src/types/string_persona_description_private.d.ts +8 -0
  591. package/esm/src/types/string_prompt.d.ts +49 -0
  592. package/esm/src/types/string_prompt_image_private.d.ts +8 -0
  593. package/esm/src/types/string_prompt_private.d.ts +8 -0
  594. package/esm/src/types/string_reserved_parameter_name_private.d.ts +11 -0
  595. package/esm/src/types/string_sha256.d.ts +2 -2
  596. package/esm/src/types/string_system_message_private.d.ts +9 -0
  597. package/esm/src/types/string_template_private.d.ts +8 -0
  598. package/esm/src/types/string_text_prompt_private.d.ts +9 -0
  599. package/esm/src/types/string_title.d.ts +8 -0
  600. package/esm/src/types/string_title_private.d.ts +9 -0
  601. package/esm/src/types/string_url.d.ts +50 -46
  602. package/esm/src/types/string_url_private.d.ts +88 -0
  603. package/esm/src/types/typeAliasEmoji.d.ts +0 -3
  604. package/esm/src/types/typeAliases.d.ts +7 -7
  605. package/esm/src/utils/DEFAULT_THINKING_MESSAGES.d.ts +5 -1
  606. package/esm/src/utils/chat/chatAttachments/appendChatAttachmentContext.d.ts +1 -0
  607. package/esm/src/utils/chat/chatAttachments/appendChatAttachmentContextWithContent.d.ts +1 -0
  608. package/esm/src/utils/chat/chatAttachments/formatChatAttachmentContentContext.d.ts +1 -0
  609. package/esm/src/utils/chat/chatAttachments/formatChatAttachmentContext.d.ts +1 -0
  610. package/esm/src/utils/chat/chatAttachments/normalizeChatAttachments.d.ts +1 -0
  611. package/esm/src/utils/chat/chatAttachments/resolveChatAttachmentContent.d.ts +1 -0
  612. package/esm/src/utils/chat/chatAttachments/resolveChatAttachmentContents.d.ts +1 -0
  613. package/esm/src/utils/chat/chatAttachments.d.ts +0 -3
  614. package/esm/src/utils/chat/constants.d.ts +0 -3
  615. package/esm/src/utils/clientVersion.d.ts +0 -3
  616. package/esm/src/utils/color/$randomColor.d.ts +0 -5
  617. package/esm/src/utils/color/css-colors.d.ts +0 -3
  618. package/esm/src/utils/color/internal-utils/hslToRgb.d.ts +0 -3
  619. package/esm/src/utils/color/internal-utils/rgbToHsl.d.ts +0 -3
  620. package/esm/src/utils/color/operators/ColorTransformer.d.ts +2 -0
  621. package/esm/src/utils/color/operators/lighten.d.ts +0 -3
  622. package/esm/src/utils/color/operators/saturate.d.ts +0 -3
  623. package/esm/src/utils/color/utils/areColorsEqual.d.ts +0 -3
  624. package/esm/src/utils/color/utils/colorDistance.d.ts +2 -2
  625. package/esm/src/utils/color/utils/colorHue.d.ts +0 -1
  626. package/esm/src/utils/color/utils/colorHueDistance.d.ts +0 -1
  627. package/esm/src/utils/color/utils/colorToDataUrl.d.ts +0 -3
  628. package/esm/src/utils/database/uniqueConstraint.d.ts +1 -3
  629. package/esm/src/utils/editable/edit-pipeline-string/addPipelineCommand.d.ts +3 -4
  630. package/esm/src/utils/editable/edit-pipeline-string/deflatePipeline.d.ts +0 -3
  631. package/esm/src/utils/editable/types/PipelineEditableSerialized.d.ts +2 -2
  632. package/esm/src/utils/editable/utils/renamePipelineParameter.d.ts +4 -3
  633. package/esm/src/utils/editable/utils/stringifyPipelineJson.d.ts +0 -6
  634. package/esm/src/utils/environment/$detectRuntimeEnvironment.d.ts +0 -3
  635. package/esm/src/utils/environment/$getGlobalScope.d.ts +1 -1
  636. package/esm/src/utils/environment/$isRunningInBrowser.d.ts +0 -3
  637. package/esm/src/utils/environment/$isRunningInJest.d.ts +0 -3
  638. package/esm/src/utils/environment/$isRunningInNode.d.ts +0 -3
  639. package/esm/src/utils/environment/$isRunningInWebWorker.d.ts +0 -3
  640. package/esm/src/utils/execCommand/$execCommand.d.ts +0 -4
  641. package/esm/src/utils/execCommand/$execCommands.d.ts +0 -3
  642. package/esm/src/utils/execCommand/ExecCommandOptions.d.ts +3 -4
  643. package/esm/src/utils/expectation-counters/constants.d.ts +0 -4
  644. package/esm/src/utils/expectation-counters/countCharacters.d.ts +0 -4
  645. package/esm/src/utils/expectation-counters/countLines.d.ts +0 -4
  646. package/esm/src/utils/expectation-counters/countPages.d.ts +0 -4
  647. package/esm/src/utils/expectation-counters/countParagraphs.d.ts +0 -4
  648. package/esm/src/utils/expectation-counters/countSentences.d.ts +0 -4
  649. package/esm/src/utils/expectation-counters/countWords.d.ts +0 -5
  650. package/esm/src/utils/expectation-counters/index.d.ts +0 -4
  651. package/esm/src/utils/files/$induceBookDownload.d.ts +0 -3
  652. package/esm/src/utils/files/$induceFileDownload.d.ts +0 -3
  653. package/esm/src/utils/files/ObjectUrl.d.ts +0 -3
  654. package/esm/src/utils/files/isDirectoryExisting.d.ts +0 -6
  655. package/esm/src/utils/files/isExecutable.d.ts +0 -4
  656. package/esm/src/utils/files/isFileExisting.d.ts +0 -5
  657. package/esm/src/utils/files/listAllFiles.d.ts +1 -5
  658. package/esm/src/utils/files/readResponseBytes.d.ts +1 -0
  659. package/esm/src/utils/knowledge/inlineKnowledgeSource.d.ts +11 -6
  660. package/esm/src/utils/knowledge/simplifyKnowledgeLabel.d.ts +2 -0
  661. package/esm/src/utils/linguistic-hash/linguisticHash.d.ts +2 -1
  662. package/esm/src/utils/linguistic-hash/linguisticHashTypes.d.ts +0 -3
  663. package/esm/src/utils/linguistic-hash/linguisticHashWords.cs.d.ts +0 -3
  664. package/esm/src/utils/linguistic-hash/linguisticHashWords.en.d.ts +0 -3
  665. package/esm/src/utils/markdown/addAutoGeneratedSection.d.ts +0 -3
  666. package/esm/src/utils/markdown/createMarkdownTable.d.ts +0 -3
  667. package/esm/src/utils/markdown/escapeMarkdownBlock.d.ts +0 -3
  668. package/esm/src/utils/markdown/extractAllBlocksFromMarkdown.d.ts +1 -3
  669. package/esm/src/utils/markdown/extractAllListItemsFromMarkdown.d.ts +1 -0
  670. package/esm/src/utils/markdown/extractOneBlockFromMarkdown.d.ts +2 -4
  671. package/esm/src/utils/markdown/humanizeAiText.d.ts +0 -3
  672. package/esm/src/utils/markdown/humanizeAiTextEllipsis.d.ts +0 -3
  673. package/esm/src/utils/markdown/humanizeAiTextEmdashed.d.ts +0 -3
  674. package/esm/src/utils/markdown/humanizeAiTextQuotes.d.ts +0 -3
  675. package/esm/src/utils/markdown/humanizeAiTextSources.d.ts +0 -3
  676. package/esm/src/utils/markdown/humanizeAiTextWhitespace.d.ts +0 -3
  677. package/esm/src/utils/markdown/prettifyMarkdown.d.ts +4 -2
  678. package/esm/src/utils/markdown/promptbookifyAiText.d.ts +0 -3
  679. package/esm/src/utils/markdown/removeMarkdownComments.d.ts +1 -0
  680. package/esm/src/utils/markdown/removeMarkdownFormatting.d.ts +1 -0
  681. package/esm/src/utils/markdown/removeMarkdownLinks.d.ts +1 -0
  682. package/esm/src/utils/markdown/trimCodeBlock.d.ts +1 -1
  683. package/esm/src/utils/markdown/trimEndOfCodeBlock.d.ts +1 -1
  684. package/esm/src/utils/misc/$getCurrentDate.d.ts +1 -0
  685. package/esm/src/utils/misc/aboutPromptbookInformation.d.ts +3 -3
  686. package/esm/src/utils/misc/computeHash.d.ts +0 -3
  687. package/esm/src/utils/misc/debounce.d.ts +2 -0
  688. package/esm/src/utils/misc/emojis.d.ts +3 -8
  689. package/esm/src/utils/misc/injectCssModuleIntoShadowRoot.d.ts +7 -2
  690. package/esm/src/utils/misc/parseNumber.d.ts +0 -4
  691. package/esm/src/utils/misc/xAboutPromptbookInformation.d.ts +3 -4
  692. package/esm/src/utils/normalization/IKeywords.d.ts +0 -3
  693. package/esm/src/utils/normalization/nameToUriPart.d.ts +1 -0
  694. package/esm/src/utils/normalization/nameToUriParts.d.ts +1 -0
  695. package/esm/src/utils/normalization/normalize-to-kebab-case.d.ts +2 -3
  696. package/esm/src/utils/normalization/normalizeTo_PascalCase.d.ts +2 -0
  697. package/esm/src/utils/normalization/normalizeTo_SCREAMING_CASE.d.ts +2 -0
  698. package/esm/src/utils/normalization/normalizeTo_camelCase.d.ts +2 -3
  699. package/esm/src/utils/normalization/normalizeTo_snake_case.d.ts +1 -0
  700. package/esm/src/utils/normalization/orderJson.d.ts +1 -0
  701. package/esm/src/utils/normalization/orderJson.test.d.ts +0 -3
  702. package/esm/src/utils/normalization/parseKeywords.d.ts +1 -4
  703. package/esm/src/utils/normalization/parseKeywordsFromString.d.ts +1 -0
  704. package/esm/src/utils/normalization/removeDiacritics.d.ts +1 -3
  705. package/esm/src/utils/normalization/removeEmojis.d.ts +1 -0
  706. package/esm/src/utils/normalization/removeQuotes.d.ts +1 -0
  707. package/esm/src/utils/normalization/searchKeywords.d.ts +1 -3
  708. package/esm/src/utils/normalization/titleToName.d.ts +1 -0
  709. package/esm/src/utils/normalization/unwrapResult.d.ts +1 -3
  710. package/esm/src/utils/organization/$sideEffect.d.ts +1 -0
  711. package/esm/src/utils/organization/TODO_USE.d.ts +1 -0
  712. package/esm/src/utils/organization/just.d.ts +1 -0
  713. package/esm/src/utils/organization/keepImported.d.ts +1 -0
  714. package/esm/src/utils/organization/keepTypeImported.d.ts +1 -0
  715. package/esm/src/utils/organization/keepUnused.d.ts +1 -0
  716. package/esm/src/utils/organization/preserve.d.ts +1 -3
  717. package/esm/src/utils/organization/really_any.d.ts +1 -0
  718. package/esm/src/utils/organization/spaceTrim.d.ts +3 -2
  719. package/esm/src/utils/parameters/extractParameterNames.d.ts +1 -0
  720. package/esm/src/utils/parameters/mapAvailableToExpectedParameters.d.ts +1 -0
  721. package/esm/src/utils/parameters/templateParameters.d.ts +2 -1
  722. package/esm/src/utils/parameters/valueToString.d.ts +2 -2
  723. package/esm/src/utils/random/$generateBookBoilerplate.d.ts +3 -3
  724. package/esm/src/utils/random/$randomAgentPersona.d.ts +1 -3
  725. package/esm/src/utils/random/$randomAgentRule.d.ts +1 -3
  726. package/esm/src/utils/random/$randomFullnameWithColor.d.ts +4 -3
  727. package/esm/src/utils/random/$randomItem.d.ts +0 -3
  728. package/esm/src/utils/random/$randomSeed.d.ts +0 -3
  729. package/esm/src/utils/random/$randomToken.d.ts +2 -5
  730. package/esm/src/utils/random/EnglishNamePool.d.ts +1 -0
  731. package/esm/src/utils/serialization/$deepFreeze.d.ts +1 -3
  732. package/esm/src/utils/serialization/checkSerializableAsJson.d.ts +1 -5
  733. package/esm/src/utils/serialization/clonePipeline.d.ts +1 -3
  734. package/esm/src/utils/serialization/deepClone.d.ts +1 -3
  735. package/esm/src/utils/serialization/exportJson.d.ts +1 -3
  736. package/esm/src/utils/serialization/isSerializableAsJson.d.ts +0 -5
  737. package/esm/src/utils/serialization/jsonStringsToJsons.d.ts +1 -4
  738. package/esm/src/utils/serialization/serializeToPromptbookJavascript.d.ts +3 -3
  739. package/esm/src/utils/sets/difference.d.ts +1 -3
  740. package/esm/src/utils/sets/intersection.d.ts +1 -0
  741. package/esm/src/utils/sets/union.d.ts +1 -0
  742. package/esm/src/utils/take/classes/TakeChain.d.ts +4 -1
  743. package/esm/src/utils/take/interfaces/ITakeChain.d.ts +5 -1
  744. package/esm/src/utils/take/interfaces/Takeable.d.ts +2 -1
  745. package/esm/src/utils/take/take.d.ts +1 -1
  746. package/esm/src/utils/validators/filePath/isRootPath.d.ts +1 -3
  747. package/esm/src/utils/validators/filePath/isRootPath.test.d.ts +0 -3
  748. package/esm/src/utils/validators/filePath/isValidFilePath.d.ts +1 -3
  749. package/esm/src/utils/validators/javascriptName/isValidJavascriptName.d.ts +1 -0
  750. package/esm/src/utils/validators/parameterName/validateParameterName.d.ts +1 -0
  751. package/esm/src/utils/validators/semanticVersion/isValidPromptbookVersion.d.ts +2 -1
  752. package/esm/src/utils/validators/url/extractUrlsFromText.d.ts +1 -0
  753. package/esm/src/utils/validators/url/isUrlOnPrivateNetwork.d.ts +1 -0
  754. package/esm/src/utils/validators/url/isValidAgentUrl.d.ts +0 -3
  755. package/esm/src/utils/validators/url/isValidPipelineUrl.d.ts +0 -3
  756. package/esm/src/utils/validators/url/normalizeDomainForMatching.d.ts +1 -0
  757. package/esm/src/version.d.ts +1 -1
  758. package/esm/src/wizard/$getCompiledBook.d.ts +0 -4
  759. package/esm/src/wizard/wizard.d.ts +1 -4
  760. package/package.json +2 -2
  761. package/umd/index.umd.js +607 -600
  762. package/umd/index.umd.js.map +1 -1
  763. package/umd/src/_packages/types.index.d.ts +94 -94
  764. package/umd/src/book-2.0/agent-source/AgentBasicInformation.d.ts +3 -4
  765. package/umd/src/book-2.0/agent-source/AgentModelRequirements.d.ts +0 -4
  766. package/umd/src/book-2.0/agent-source/createAgentModelRequirements.d.ts +7 -0
  767. package/umd/src/book-2.0/agent-source/createTeamToolName.d.ts +1 -0
  768. package/umd/src/book-2.0/agent-source/extractOpenTeacherInstructions.d.ts +1 -0
  769. package/umd/src/book-2.0/agent-source/padBook.d.ts +1 -4
  770. package/umd/src/book-2.0/agent-source/parseAgentSource.d.ts +0 -3
  771. package/umd/src/book-2.0/agent-source/parseAgentSourcePrelude.d.ts +1 -0
  772. package/umd/src/book-2.0/agent-source/parseParameters.d.ts +1 -0
  773. package/umd/src/book-2.0/agent-source/parseTeamCommitment.d.ts +0 -3
  774. package/umd/src/book-2.0/agent-source/pseudoAgentReferences.d.ts +8 -3
  775. package/umd/src/book-2.0/agent-source/string_book.d.ts +1 -0
  776. package/umd/src/book-2.0/utils/generatePlaceholderAgentProfileImageUrl.d.ts +0 -3
  777. package/umd/src/book-components/AvatarProfile/AvatarChip/AvatarChip.d.ts +0 -3
  778. package/umd/src/book-components/AvatarProfile/AvatarProfile/AvatarProfile.d.ts +0 -3
  779. package/umd/src/book-components/AvatarProfile/AvatarProfile/AvatarProfileTooltip.d.ts +4 -0
  780. package/umd/src/book-components/BookEditor/BookEditor.d.ts +0 -3
  781. package/umd/src/book-components/BookEditor/BookEditorActionbar.d.ts +4 -0
  782. package/umd/src/book-components/BookEditor/BookEditorMonaco.d.ts +2 -0
  783. package/umd/src/book-components/BookEditor/BookEditorMonacoUploadPanel.d.ts +3 -0
  784. package/umd/src/book-components/BookEditor/createDeprecatedCommitmentDiagnostics.d.ts +1 -0
  785. package/umd/src/book-components/BookEditor/useBookEditorMonacoDecorations.d.ts +6 -0
  786. package/umd/src/book-components/BookEditor/useBookEditorMonacoDiagnostics.d.ts +9 -0
  787. package/umd/src/book-components/BookEditor/useBookEditorMonacoLanguage.d.ts +7 -0
  788. package/umd/src/book-components/BookEditor/useBookEditorMonacoStyles.d.ts +3 -0
  789. package/umd/src/book-components/BookEditor/useBookEditorMonacoUploads.d.ts +24 -0
  790. package/umd/src/book-components/Chat/AgentChat/AgentChat.d.ts +0 -3
  791. package/umd/src/book-components/Chat/AgentChip/AgentChip.d.ts +6 -5
  792. package/umd/src/book-components/Chat/Chat/ChatInputAreaDictationPanel.d.ts +38 -0
  793. package/umd/src/book-components/Chat/Chat/ChatMessageItem.d.ts +1 -14
  794. package/umd/src/book-components/Chat/Chat/ChatMessageRichContent.d.ts +32 -0
  795. package/umd/src/book-components/Chat/Chat/ChatMessageToolCallChips.d.ts +22 -0
  796. package/umd/src/book-components/Chat/Chat/ChatProps.d.ts +2 -3
  797. package/umd/src/book-components/Chat/Chat/ChatSelfLearningSummary.d.ts +0 -3
  798. package/umd/src/book-components/Chat/Chat/ChatToolCallModalComponents.d.ts +0 -3
  799. package/umd/src/book-components/Chat/Chat/StreamingFeaturePlaceholder.d.ts +34 -0
  800. package/umd/src/book-components/Chat/Chat/TeamToolCallModalContent.d.ts +1 -0
  801. package/umd/src/book-components/Chat/Chat/chatCssClassNames.d.ts +1 -0
  802. package/umd/src/book-components/Chat/Chat/constants.d.ts +4 -3
  803. package/umd/src/book-components/Chat/Chat/createChatMessageToolCallRenderModel.d.ts +76 -0
  804. package/umd/src/book-components/Chat/Chat/createProgressCardChecklistMarkdown.d.ts +16 -0
  805. package/umd/src/book-components/Chat/Chat/insertDictationChunk.d.ts +16 -0
  806. package/umd/src/book-components/Chat/Chat/learnDictationDictionary.d.ts +7 -0
  807. package/umd/src/book-components/Chat/Chat/refineFinalDictationChunk.d.ts +36 -0
  808. package/umd/src/book-components/Chat/Chat/renderAdvancedToolCallDetails.d.ts +3 -0
  809. package/umd/src/book-components/Chat/Chat/renderEmailToolCallDetails.d.ts +27 -0
  810. package/umd/src/book-components/Chat/Chat/renderMemoryToolCallDetails.d.ts +32 -0
  811. package/umd/src/book-components/Chat/Chat/renderPopupToolCallDetails.d.ts +33 -0
  812. package/umd/src/book-components/Chat/Chat/renderRunBrowserToolCallDetails.d.ts +32 -0
  813. package/umd/src/book-components/Chat/Chat/renderSearchToolCallDetails.d.ts +32 -0
  814. package/umd/src/book-components/Chat/Chat/renderSelfLearningToolCallDetails.d.ts +39 -0
  815. package/umd/src/book-components/Chat/Chat/renderTimeToolCallDetails.d.ts +39 -0
  816. package/umd/src/book-components/Chat/Chat/renderTimeoutToolCallDetails.d.ts +47 -0
  817. package/umd/src/book-components/Chat/Chat/renderToolCallClockPanel.d.ts +34 -0
  818. package/umd/src/book-components/Chat/Chat/renderToolCallDetails.d.ts +3 -2
  819. package/umd/src/book-components/Chat/Chat/renderToolCallProgressPlaceholder.d.ts +30 -0
  820. package/umd/src/book-components/Chat/Chat/renderWalletCredentialToolCallDetails.d.ts +27 -0
  821. package/umd/src/book-components/Chat/Chat/resolveSpeechRecognitionUiDescriptor.d.ts +30 -0
  822. package/umd/src/book-components/Chat/Chat/resolveToolCallProgressMessage.d.ts +10 -0
  823. package/umd/src/book-components/Chat/Chat/useChatInputAreaAttachments.d.ts +32 -0
  824. package/umd/src/book-components/Chat/Chat/useChatInputAreaDictation.d.ts +53 -0
  825. package/umd/src/book-components/Chat/Chat/useChatInputAreaDictationPersistence.d.ts +20 -0
  826. package/umd/src/book-components/Chat/Chat/useChatInputAreaDictationSupport.d.ts +29 -0
  827. package/umd/src/book-components/Chat/Chat/useChatMessageAvatarTooltip.d.ts +31 -0
  828. package/umd/src/book-components/Chat/Chat/useChatMessageSpeechPlayback.d.ts +29 -0
  829. package/umd/src/book-components/Chat/LlmChat/defaults.d.ts +0 -3
  830. package/umd/src/book-components/Chat/MarkdownContent/MarkdownContent.d.ts +3 -3
  831. package/umd/src/book-components/Chat/MockedChat/constants.d.ts +0 -3
  832. package/umd/src/book-components/Chat/SourceChip/SourceChip.d.ts +4 -3
  833. package/umd/src/book-components/Chat/effects/components/ConfettiEffect.d.ts +3 -0
  834. package/umd/src/book-components/Chat/effects/components/HeartsEffect.d.ts +3 -0
  835. package/umd/src/book-components/Chat/effects/index.d.ts +0 -4
  836. package/umd/src/book-components/Chat/effects/utils/detectEffects.d.ts +1 -0
  837. package/umd/src/book-components/Chat/hooks/useSendMessageToLlmChat.d.ts +4 -4
  838. package/umd/src/book-components/Chat/save/_common/string_chat_format_name.d.ts +1 -0
  839. package/umd/src/book-components/Chat/save/html/htmlSaveFormatDefinition.d.ts +0 -3
  840. package/umd/src/book-components/Chat/save/index.d.ts +0 -3
  841. package/umd/src/book-components/Chat/save/pdf/buildChatPdf.d.ts +1 -0
  842. package/umd/src/book-components/Chat/save/pdf/pdfSaveFormatDefinition.d.ts +0 -4
  843. package/umd/src/book-components/Chat/types/ChatMessage.d.ts +3 -5
  844. package/umd/src/book-components/Chat/types/ChatParticipant.d.ts +0 -3
  845. package/umd/src/book-components/Chat/utils/ExportFormat.d.ts +2 -0
  846. package/umd/src/book-components/Chat/utils/citationHelpers.d.ts +4 -3
  847. package/umd/src/book-components/Chat/utils/collectTeamToolCallSummary.d.ts +1 -0
  848. package/umd/src/book-components/Chat/utils/createCitationFootnoteRenderModel.d.ts +1 -0
  849. package/umd/src/book-components/Chat/utils/exportChatHistory.d.ts +0 -3
  850. package/umd/src/book-components/Chat/utils/formatToolCallLocalTime.d.ts +2 -1
  851. package/umd/src/book-components/Chat/utils/loadAgentProfile.d.ts +12 -0
  852. package/umd/src/book-components/Chat/utils/parseCitationsFromContent.d.ts +0 -3
  853. package/umd/src/book-components/Chat/utils/parseImagePrompts.d.ts +1 -3
  854. package/umd/src/book-components/Chat/utils/sanitizeStreamingMessageContent.d.ts +14 -0
  855. package/umd/src/book-components/Chat/utils/thinkingMessageVariants.d.ts +3 -0
  856. package/umd/src/book-components/Chat/utils/timeoutToolCallPresentation.d.ts +0 -3
  857. package/umd/src/book-components/Chat/utils/toolCallParsing/extractSearchResults.d.ts +1 -0
  858. package/umd/src/book-components/Chat/utils/toolCallParsing/getToolCallResultDate.d.ts +1 -0
  859. package/umd/src/book-components/Chat/utils/toolCallParsing/getToolCallTimestamp.d.ts +1 -0
  860. package/umd/src/book-components/Chat/utils/toolCallParsing/parseRunBrowserToolResult.d.ts +1 -0
  861. package/umd/src/book-components/Chat/utils/toolCallParsing/parseTeamToolResult.d.ts +1 -0
  862. package/umd/src/book-components/Chat/utils/toolCallParsing/parseToolCallArguments.d.ts +1 -0
  863. package/umd/src/book-components/Chat/utils/toolCallParsing/parseToolCallResult.d.ts +1 -0
  864. package/umd/src/book-components/Chat/utils/toolCallParsing/resolveRunBrowserArtifactUrl.d.ts +1 -0
  865. package/umd/src/book-components/Chat/utils/walletCredentialToolCall.d.ts +3 -3
  866. package/umd/src/book-components/PromptbookAgent/PromptbookAgentIntegration.d.ts +3 -5
  867. package/umd/src/book-components/PromptbookAgent/PromptbookAgentSeamlessIntegration.d.ts +3 -5
  868. package/umd/src/book-components/Qr/BrandedQrCode.d.ts +5 -0
  869. package/umd/src/book-components/Qr/GenericQrCode.d.ts +5 -0
  870. package/umd/src/book-components/Qr/PromptbookQrCode.d.ts +5 -0
  871. package/umd/src/book-components/Qr/useQrCode.d.ts +4 -1
  872. package/umd/src/book-components/_common/Dropdown/Dropdown.d.ts +4 -0
  873. package/umd/src/book-components/_common/HamburgerMenu/HamburgerMenu.d.ts +4 -0
  874. package/umd/src/book-components/_common/MenuHoisting/MenuHoistingContext.d.ts +3 -3
  875. package/umd/src/book-components/_common/Modal/Modal.d.ts +1 -3
  876. package/umd/src/book-components/_common/Tooltip/Tooltip.d.ts +3 -0
  877. package/umd/src/book-components/icons/AboutIcon.d.ts +1 -0
  878. package/umd/src/book-components/icons/AttachmentIcon.d.ts +4 -0
  879. package/umd/src/book-components/icons/CameraIcon.d.ts +4 -0
  880. package/umd/src/book-components/icons/DownloadIcon.d.ts +1 -0
  881. package/umd/src/book-components/icons/EmailIcon.d.ts +1 -0
  882. package/umd/src/book-components/icons/MenuIcon.d.ts +1 -3
  883. package/umd/src/book-components/icons/SaveIcon.d.ts +1 -0
  884. package/umd/src/book-components/icons/SendIcon.d.ts +0 -3
  885. package/umd/src/book-components/icons/TeacherIcon.d.ts +1 -0
  886. package/umd/src/cli/$runPromptbookCli.d.ts +0 -3
  887. package/umd/src/cli/cli-commands/_boilerplate.d.ts +0 -4
  888. package/umd/src/cli/cli-commands/about.d.ts +0 -6
  889. package/umd/src/cli/cli-commands/coder/ThinkingLevel.d.ts +18 -0
  890. package/umd/src/cli/cli-commands/coder/find-fresh-emoji-tags.d.ts +0 -4
  891. package/umd/src/cli/cli-commands/coder/find-refactor-candidates.d.ts +0 -4
  892. package/umd/src/cli/cli-commands/coder/generate-boilerplates.d.ts +0 -4
  893. package/umd/src/cli/cli-commands/coder/init.d.ts +0 -4
  894. package/umd/src/cli/cli-commands/coder/run.d.ts +1 -5
  895. package/umd/src/cli/cli-commands/coder/run.test.d.ts +1 -0
  896. package/umd/src/cli/cli-commands/coder/verify.d.ts +0 -4
  897. package/umd/src/cli/cli-commands/coder.d.ts +0 -4
  898. package/umd/src/cli/cli-commands/common/handleActionErrors.d.ts +4 -0
  899. package/umd/src/cli/cli-commands/hello.d.ts +0 -5
  900. package/umd/src/cli/cli-commands/list-models.d.ts +0 -4
  901. package/umd/src/cli/cli-commands/list-scrapers.d.ts +0 -4
  902. package/umd/src/cli/cli-commands/login.d.ts +0 -5
  903. package/umd/src/cli/cli-commands/make.d.ts +1 -1
  904. package/umd/src/cli/cli-commands/prettify.d.ts +0 -6
  905. package/umd/src/cli/cli-commands/run.d.ts +0 -8
  906. package/umd/src/cli/cli-commands/runInteractiveChatbot.d.ts +1 -5
  907. package/umd/src/cli/cli-commands/start-agents-server.d.ts +0 -4
  908. package/umd/src/cli/cli-commands/start-pipelines-server.d.ts +0 -5
  909. package/umd/src/cli/cli-commands/test-command.d.ts +0 -7
  910. package/umd/src/cli/common/$provideLlmToolsForCli.d.ts +5 -0
  911. package/umd/src/cli/main.d.ts +0 -4
  912. package/umd/src/cli/promptbookCli.d.ts +0 -7
  913. package/umd/src/collection/agent-collection/AgentCollection.d.ts +0 -3
  914. package/umd/src/collection/agent-collection/constructors/agent-collection-in-supabase/AgentCollectionInSupabase.d.ts +2 -6
  915. package/umd/src/collection/agent-collection/constructors/agent-collection-in-supabase/AgentCollectionInSupabaseOptions.d.ts +3 -0
  916. package/umd/src/collection/pipeline-collection/SimplePipelineCollection.d.ts +2 -1
  917. package/umd/src/collection/pipeline-collection/constructors/createPipelineCollectionFromDirectory.d.ts +2 -5
  918. package/umd/src/collection/pipeline-collection/constructors/createPipelineCollectionFromJson.d.ts +1 -0
  919. package/umd/src/collection/pipeline-collection/constructors/createPipelineCollectionFromPromise.d.ts +4 -3
  920. package/umd/src/collection/pipeline-collection/constructors/createPipelineCollectionFromUrl.d.ts +2 -3
  921. package/umd/src/collection/pipeline-collection/constructors/createPipelineSubcollection.d.ts +1 -0
  922. package/umd/src/collection/pipeline-collection/pipelineCollectionToJson.d.ts +0 -3
  923. package/umd/src/commands/BOOK_VERSION/BookVersionCommand.d.ts +1 -0
  924. package/umd/src/commands/BOOK_VERSION/bookVersionCommandParser.d.ts +1 -0
  925. package/umd/src/commands/EXPECT/ExpectCommand.d.ts +0 -3
  926. package/umd/src/commands/EXPECT/expectCommandParser.d.ts +3 -2
  927. package/umd/src/commands/FOREACH/ForeachCommand.d.ts +1 -0
  928. package/umd/src/commands/FOREACH/foreachCommandParser.d.ts +1 -3
  929. package/umd/src/commands/FORMAT/formatCommandParser.d.ts +1 -0
  930. package/umd/src/commands/FORMFACTOR/FormfactorCommand.d.ts +1 -0
  931. package/umd/src/commands/FORMFACTOR/formfactorCommandParser.d.ts +1 -0
  932. package/umd/src/commands/JOKER/JokerCommand.d.ts +1 -0
  933. package/umd/src/commands/JOKER/jokerCommandParser.d.ts +1 -0
  934. package/umd/src/commands/KNOWLEDGE/KnowledgeCommand.d.ts +1 -0
  935. package/umd/src/commands/KNOWLEDGE/knowledgeCommandParser.d.ts +1 -3
  936. package/umd/src/commands/KNOWLEDGE/utils/knowledgeSourceContentToName.d.ts +0 -3
  937. package/umd/src/commands/KNOWLEDGE/utils/knowledgeSourceContentToName.test.d.ts +0 -3
  938. package/umd/src/commands/MODEL/ModelCommand.d.ts +1 -0
  939. package/umd/src/commands/MODEL/modelCommandParser.d.ts +1 -0
  940. package/umd/src/commands/PARAMETER/ParameterCommand.d.ts +1 -0
  941. package/umd/src/commands/PARAMETER/parameterCommandParser.d.ts +1 -0
  942. package/umd/src/commands/PERSONA/PersonaCommand.d.ts +1 -0
  943. package/umd/src/commands/PERSONA/personaCommandParser.d.ts +1 -0
  944. package/umd/src/commands/POSTPROCESS/PostprocessCommand.d.ts +1 -0
  945. package/umd/src/commands/POSTPROCESS/postprocessCommandParser.d.ts +1 -0
  946. package/umd/src/commands/SECTION/SectionCommand.d.ts +1 -0
  947. package/umd/src/commands/SECTION/sectionCommandParser.d.ts +1 -0
  948. package/umd/src/commands/URL/UrlCommand.d.ts +1 -0
  949. package/umd/src/commands/URL/urlCommandParser.d.ts +1 -0
  950. package/umd/src/commands/X_ACTION/ActionCommand.d.ts +1 -0
  951. package/umd/src/commands/X_ACTION/actionCommandParser.d.ts +1 -3
  952. package/umd/src/commands/X_INSTRUMENT/InstrumentCommand.d.ts +1 -0
  953. package/umd/src/commands/X_INSTRUMENT/instrumentCommandParser.d.ts +1 -3
  954. package/umd/src/commands/_BOILERPLATE/BoilerplateCommand.d.ts +1 -0
  955. package/umd/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts +1 -0
  956. package/umd/src/commands/_common/stringifyCommand.d.ts +1 -1
  957. package/umd/src/commands/_common/types/CommandParser.d.ts +0 -4
  958. package/umd/src/commands/index.d.ts +0 -3
  959. package/umd/src/commitments/ACTION/ACTION.d.ts +0 -3
  960. package/umd/src/commitments/CLOSED/CLOSED.d.ts +0 -3
  961. package/umd/src/commitments/CLOSED/CLOSED.test.d.ts +0 -3
  962. package/umd/src/commitments/COMPONENT/COMPONENT.d.ts +0 -3
  963. package/umd/src/commitments/DELETE/DELETE.d.ts +0 -3
  964. package/umd/src/commitments/DICTIONARY/DICTIONARY.d.ts +0 -3
  965. package/umd/src/commitments/FORMAT/FORMAT.d.ts +0 -3
  966. package/umd/src/commitments/FROM/FROM.d.ts +0 -3
  967. package/umd/src/commitments/GOAL/GOAL.d.ts +0 -3
  968. package/umd/src/commitments/IMPORT/IMPORT.d.ts +0 -3
  969. package/umd/src/commitments/LANGUAGE/LANGUAGE.d.ts +0 -3
  970. package/umd/src/commitments/MEMORY/MEMORY.d.ts +0 -3
  971. package/umd/src/commitments/MESSAGE/MESSAGE.d.ts +0 -3
  972. package/umd/src/commitments/MESSAGE_SUFFIX/MESSAGE_SUFFIX.d.ts +0 -3
  973. package/umd/src/commitments/META/META.d.ts +0 -3
  974. package/umd/src/commitments/META/META_DESCRIPTION.d.ts +0 -3
  975. package/umd/src/commitments/META_COLOR/META_COLOR.d.ts +0 -3
  976. package/umd/src/commitments/META_DISCLAIMER/META_DISCLAIMER.d.ts +0 -3
  977. package/umd/src/commitments/META_DOMAIN/META_DOMAIN.d.ts +0 -3
  978. package/umd/src/commitments/META_FONT/META_FONT.d.ts +0 -3
  979. package/umd/src/commitments/META_IMAGE/META_IMAGE.d.ts +0 -3
  980. package/umd/src/commitments/META_INPUT_PLACEHOLDER/META_INPUT_PLACEHOLDER.d.ts +0 -3
  981. package/umd/src/commitments/META_LINK/META_LINK.d.ts +0 -3
  982. package/umd/src/commitments/META_VOICE/META_VOICE.d.ts +0 -3
  983. package/umd/src/commitments/MODEL/MODEL.d.ts +0 -3
  984. package/umd/src/commitments/OPEN/OPEN.d.ts +0 -3
  985. package/umd/src/commitments/PERSONA/PERSONA.d.ts +0 -3
  986. package/umd/src/commitments/RULE/RULE.d.ts +0 -3
  987. package/umd/src/commitments/SAMPLE/SAMPLE.d.ts +0 -3
  988. package/umd/src/commitments/SCENARIO/SCENARIO.d.ts +0 -3
  989. package/umd/src/commitments/TEAM/TEAM.d.ts +0 -3
  990. package/umd/src/commitments/TEMPLATE/TEMPLATE.d.ts +0 -3
  991. package/umd/src/commitments/USE/USE.d.ts +0 -3
  992. package/umd/src/commitments/USE/aggregateUseCommitmentSystemMessages.d.ts +2 -0
  993. package/umd/src/commitments/USE_BROWSER/USE_BROWSER.d.ts +0 -3
  994. package/umd/src/commitments/USE_BROWSER/fetchUrlContent.d.ts +4 -7
  995. package/umd/src/commitments/USE_CALENDAR/USE_CALENDAR.d.ts +0 -3
  996. package/umd/src/commitments/USE_CALENDAR/calendarReference.d.ts +0 -3
  997. package/umd/src/commitments/USE_EMAIL/USE_EMAIL.d.ts +0 -3
  998. package/umd/src/commitments/USE_IMAGE_GENERATOR/USE_IMAGE_GENERATOR.d.ts +0 -3
  999. package/umd/src/commitments/USE_MCP/USE_MCP.d.ts +0 -3
  1000. package/umd/src/commitments/USE_POPUP/USE_POPUP.d.ts +0 -3
  1001. package/umd/src/commitments/USE_PRIVACY/USE_PRIVACY.d.ts +0 -3
  1002. package/umd/src/commitments/USE_PROJECT/USE_PROJECT.d.ts +0 -3
  1003. package/umd/src/commitments/USE_PROJECT/projectReference.d.ts +0 -3
  1004. package/umd/src/commitments/USE_SEARCH_ENGINE/USE_SEARCH_ENGINE.d.ts +0 -3
  1005. package/umd/src/commitments/USE_SPAWN/USE_SPAWN.d.ts +0 -3
  1006. package/umd/src/commitments/USE_TIME/USE_TIME.d.ts +0 -3
  1007. package/umd/src/commitments/USE_TIMEOUT/USE_TIMEOUT.d.ts +0 -3
  1008. package/umd/src/commitments/USE_USER_LOCATION/USE_USER_LOCATION.d.ts +0 -3
  1009. package/umd/src/commitments/WALLET/WALLET.d.ts +0 -3
  1010. package/umd/src/commitments/WRITING_RULES/WRITING_RULES.d.ts +0 -3
  1011. package/umd/src/commitments/WRITING_SAMPLE/WRITING_SAMPLE.d.ts +0 -3
  1012. package/umd/src/commitments/_base/createEmptyAgentModelRequirements.d.ts +0 -3
  1013. package/umd/src/commitments/_common/commitmentToolFunctions.d.ts +2 -3
  1014. package/umd/src/commitments/_common/createWritingCommitmentSections.d.ts +2 -3
  1015. package/umd/src/commitments/_common/getAllCommitmentDefinitions.d.ts +1 -0
  1016. package/umd/src/commitments/_common/getAllCommitmentTypes.d.ts +1 -0
  1017. package/umd/src/commitments/_common/getAllCommitmentsToolFunctionsForNode.d.ts +0 -4
  1018. package/umd/src/commitments/_common/getCommitmentDefinition.d.ts +1 -0
  1019. package/umd/src/commitments/_common/isCommitmentSupported.d.ts +1 -0
  1020. package/umd/src/commitments/_common/toolExecutionEnvelope.d.ts +0 -3
  1021. package/umd/src/commitments/_common/toolRuntimeContext.d.ts +3 -3
  1022. package/umd/src/commitments/index.d.ts +0 -4
  1023. package/umd/src/config.test.d.ts +0 -3
  1024. package/umd/src/constants/streaming.d.ts +0 -3
  1025. package/umd/src/constants.d.ts +0 -3
  1026. package/umd/src/conversion/archive/loadArchive.d.ts +0 -3
  1027. package/umd/src/conversion/archive/saveArchive.d.ts +0 -5
  1028. package/umd/src/conversion/compilePipeline.d.ts +2 -7
  1029. package/umd/src/conversion/compilePipelineOnRemoteServer.d.ts +2 -5
  1030. package/umd/src/conversion/parsePipeline.d.ts +1 -11
  1031. package/umd/src/conversion/pipelineJsonToString.d.ts +1 -7
  1032. package/umd/src/conversion/prettify/prettifyPipelineString.d.ts +0 -4
  1033. package/umd/src/conversion/prettify/renderPipelineMermaidOptions.d.ts +0 -7
  1034. package/umd/src/conversion/utils/extractParameterNamesFromTask.d.ts +1 -3
  1035. package/umd/src/conversion/validation/_importPipeline.d.ts +6 -4
  1036. package/umd/src/conversion/validation/pipelineStringToJson-parseErrors.test.d.ts +0 -3
  1037. package/umd/src/conversion/validation/validatePipeline-logicErrors.test.d.ts +0 -3
  1038. package/umd/src/conversion/validation/validatePipeline.d.ts +3 -9
  1039. package/umd/src/conversion/validation/validatePipeline.test.d.ts +0 -3
  1040. package/umd/src/dialogs/simple-prompt/SimplePromptInterfaceTools.d.ts +1 -4
  1041. package/umd/src/errors/0-BoilerplateError.d.ts +0 -3
  1042. package/umd/src/errors/0-index.d.ts +0 -3
  1043. package/umd/src/errors/DatabaseError.d.ts +0 -3
  1044. package/umd/src/errors/ExpectError.d.ts +2 -1
  1045. package/umd/src/errors/ParseError.d.ts +0 -3
  1046. package/umd/src/errors/PipelineExecutionError.d.ts +0 -3
  1047. package/umd/src/executables/$provideExecutablesForNode.d.ts +0 -5
  1048. package/umd/src/executables/apps/locateLibreoffice.d.ts +0 -4
  1049. package/umd/src/executables/apps/locatePandoc.d.ts +0 -4
  1050. package/umd/src/executables/browsers/locateBrowser.d.ts +0 -1
  1051. package/umd/src/executables/browsers/locateDefaultSystemBrowser.d.ts +0 -1
  1052. package/umd/src/executables/locateApp.d.ts +0 -4
  1053. package/umd/src/executables/platforms/locateAppOnLinux.d.ts +0 -4
  1054. package/umd/src/executables/platforms/locateAppOnMacOs.d.ts +0 -4
  1055. package/umd/src/executables/platforms/locateAppOnWindows.d.ts +0 -4
  1056. package/umd/src/execution/AbstractTaskResult.d.ts +0 -4
  1057. package/umd/src/execution/AvailableModel.d.ts +0 -4
  1058. package/umd/src/execution/CommonToolsOptions.d.ts +0 -5
  1059. package/umd/src/execution/ExecutionTask.d.ts +4 -4
  1060. package/umd/src/execution/FilesystemTools.d.ts +0 -3
  1061. package/umd/src/execution/LlmExecutionTools.d.ts +3 -9
  1062. package/umd/src/execution/LlmExecutionToolsConstructor.d.ts +0 -3
  1063. package/umd/src/execution/PipelineExecutor.d.ts +0 -3
  1064. package/umd/src/execution/PipelineExecutorResult.d.ts +0 -3
  1065. package/umd/src/execution/PromptResult.d.ts +1 -9
  1066. package/umd/src/execution/PromptbookFetch.test-type.d.ts +0 -4
  1067. package/umd/src/execution/ScriptExecutionTools.d.ts +0 -4
  1068. package/umd/src/execution/Usage.d.ts +0 -3
  1069. package/umd/src/execution/UserInterfaceTools.d.ts +3 -0
  1070. package/umd/src/execution/assertsTaskSuccessful.d.ts +1 -3
  1071. package/umd/src/execution/createPipelineExecutor/00-createPipelineExecutor.d.ts +1 -0
  1072. package/umd/src/execution/createPipelineExecutor/20-executeTask.d.ts +0 -3
  1073. package/umd/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +1 -3
  1074. package/umd/src/execution/createPipelineExecutor/getContextForTask.d.ts +1 -0
  1075. package/umd/src/execution/createPipelineExecutor/getKnowledgeForTask.d.ts +0 -4
  1076. package/umd/src/execution/createPipelineExecutor/knowledgePiecesToString.d.ts +0 -1
  1077. package/umd/src/execution/execution-report/ExecutionReportJson.d.ts +1 -0
  1078. package/umd/src/execution/execution-report/ExecutionReportString.d.ts +0 -3
  1079. package/umd/src/execution/execution-report/executionReportJsonToString.d.ts +0 -5
  1080. package/umd/src/execution/translation/automatic-translate/automatic-translators/AutomaticTranslator.d.ts +3 -1
  1081. package/umd/src/execution/translation/automatic-translate/automatic-translators/FakeAutomaticTranslator.d.ts +3 -1
  1082. package/umd/src/execution/translation/automatic-translate/automatic-translators/TranslatorOptions.d.ts +3 -1
  1083. package/umd/src/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.d.ts +2 -0
  1084. package/umd/src/execution/translation/automatic-translate/translateMessages.d.ts +3 -5
  1085. package/umd/src/execution/utils/$provideExecutionToolsForNode.d.ts +2 -6
  1086. package/umd/src/execution/utils/checkExpectations.d.ts +2 -5
  1087. package/umd/src/execution/utils/forEachAsync.d.ts +5 -1
  1088. package/umd/src/execution/utils/usage-constants.d.ts +0 -3
  1089. package/umd/src/execution/utils/usageToHuman.d.ts +0 -8
  1090. package/umd/src/execution/utils/validatePromptResult.d.ts +1 -0
  1091. package/umd/src/file-security-checkers/virustotal/VirusTotalFileSecurityChecker.d.ts +1 -0
  1092. package/umd/src/formats/_common/FormatParser.d.ts +2 -9
  1093. package/umd/src/formats/_common/FormatSubvalueParser.d.ts +0 -3
  1094. package/umd/src/formats/csv/CsvFormatParser.d.ts +2 -8
  1095. package/umd/src/formats/index.d.ts +0 -3
  1096. package/umd/src/formats/json/JsonFormatParser.d.ts +0 -11
  1097. package/umd/src/formats/text/TextFormatParser.d.ts +0 -9
  1098. package/umd/src/formats/xml/XmlFormatParser.d.ts +0 -11
  1099. package/umd/src/formfactors/_common/AbstractFormfactorDefinition.d.ts +1 -3
  1100. package/umd/src/formfactors/_common/FormfactorDefinition.d.ts +1 -0
  1101. package/umd/src/formfactors/index.d.ts +0 -3
  1102. package/umd/src/high-level-abstractions/_common/HighLevelAbstraction.d.ts +0 -5
  1103. package/umd/src/high-level-abstractions/index.d.ts +0 -4
  1104. package/umd/src/high-level-abstractions/quick-chatbot/QuickChatbotHla.d.ts +0 -3
  1105. package/umd/src/llm-providers/_common/register/$llmToolsMetadataRegister.d.ts +2 -3
  1106. package/umd/src/llm-providers/_common/register/$llmToolsRegister.d.ts +2 -3
  1107. package/umd/src/llm-providers/_common/register/$provideEnvFilename.d.ts +0 -3
  1108. package/umd/src/llm-providers/_common/register/$provideLlmToolsConfigurationFromEnv.d.ts +1 -3
  1109. package/umd/src/llm-providers/_common/register/$provideLlmToolsForTestingAndScriptsAndPlayground.d.ts +3 -6
  1110. package/umd/src/llm-providers/_common/register/$provideLlmToolsForWizardOrCli.d.ts +3 -7
  1111. package/umd/src/llm-providers/_common/register/$provideLlmToolsFromEnv.d.ts +1 -18
  1112. package/umd/src/llm-providers/_common/register/$registeredLlmToolsMessage.d.ts +0 -4
  1113. package/umd/src/llm-providers/_common/register/LlmToolsConfiguration.d.ts +0 -5
  1114. package/umd/src/llm-providers/_common/register/LlmToolsMetadata.d.ts +0 -6
  1115. package/umd/src/llm-providers/_common/register/LlmToolsOptions.d.ts +0 -4
  1116. package/umd/src/llm-providers/_common/register/createLlmToolsFromConfiguration.d.ts +1 -0
  1117. package/umd/src/llm-providers/_common/utils/assertUniqueModels.d.ts +0 -3
  1118. package/umd/src/llm-providers/_common/utils/cache/CacheItem.d.ts +0 -3
  1119. package/umd/src/llm-providers/_common/utils/cache/cacheLlmTools.d.ts +1 -0
  1120. package/umd/src/llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage.d.ts +0 -4
  1121. package/umd/src/llm-providers/_common/utils/count-total-usage/countUsage.d.ts +1 -0
  1122. package/umd/src/llm-providers/_common/utils/count-total-usage/limitTotalUsage.d.ts +0 -7
  1123. package/umd/src/llm-providers/_common/utils/removeUnsupportedModelRequirements.d.ts +4 -0
  1124. package/umd/src/llm-providers/_multiple/MultipleLlmExecutionTools.d.ts +1 -0
  1125. package/umd/src/llm-providers/_multiple/getSingleLlmExecutionTools.d.ts +0 -4
  1126. package/umd/src/llm-providers/_multiple/joinLlmExecutionTools.d.ts +3 -7
  1127. package/umd/src/llm-providers/_multiple/playground/playground.d.ts +0 -3
  1128. package/umd/src/llm-providers/agent/Agent.d.ts +0 -3
  1129. package/umd/src/llm-providers/agent/AgentLlmExecutionTools.d.ts +0 -4
  1130. package/umd/src/llm-providers/agent/RemoteAgent.d.ts +0 -4
  1131. package/umd/src/llm-providers/agent/playground/playground.d.ts +0 -6
  1132. package/umd/src/llm-providers/agent/register-configuration.d.ts +0 -5
  1133. package/umd/src/llm-providers/agent/register-constructor.d.ts +0 -4
  1134. package/umd/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +2 -10
  1135. package/umd/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions.d.ts +3 -3
  1136. package/umd/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +1 -8
  1137. package/umd/src/llm-providers/anthropic-claude/computeAnthropicClaudeUsage.d.ts +1 -3
  1138. package/umd/src/llm-providers/anthropic-claude/computeAnthropicClaudeUsage.test.d.ts +0 -3
  1139. package/umd/src/llm-providers/anthropic-claude/createAnthropicClaudeExecutionTools.d.ts +0 -7
  1140. package/umd/src/llm-providers/anthropic-claude/playground/playground.d.ts +0 -5
  1141. package/umd/src/llm-providers/anthropic-claude/register-configuration.d.ts +0 -3
  1142. package/umd/src/llm-providers/anthropic-claude/register-constructor.d.ts +0 -5
  1143. package/umd/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +0 -6
  1144. package/umd/src/llm-providers/azure-openai/AzureOpenAiExecutionToolsOptions.d.ts +1 -0
  1145. package/umd/src/llm-providers/azure-openai/createAzureOpenAiExecutionTools.d.ts +0 -4
  1146. package/umd/src/llm-providers/azure-openai/playground/playground.d.ts +0 -4
  1147. package/umd/src/llm-providers/azure-openai/register-configuration.d.ts +0 -3
  1148. package/umd/src/llm-providers/azure-openai/register-constructor.d.ts +0 -4
  1149. package/umd/src/llm-providers/deepseek/DeepseekExecutionToolsOptions.d.ts +1 -0
  1150. package/umd/src/llm-providers/deepseek/createDeepseekExecutionTools.d.ts +0 -3
  1151. package/umd/src/llm-providers/deepseek/deepseek-models.d.ts +1 -6
  1152. package/umd/src/llm-providers/deepseek/register-configuration.d.ts +0 -3
  1153. package/umd/src/llm-providers/deepseek/register-constructor.d.ts +0 -4
  1154. package/umd/src/llm-providers/google/GoogleExecutionToolsOptions.d.ts +1 -0
  1155. package/umd/src/llm-providers/google/createGoogleExecutionTools.d.ts +0 -4
  1156. package/umd/src/llm-providers/google/google-models.d.ts +1 -6
  1157. package/umd/src/llm-providers/google/register-configuration.d.ts +0 -3
  1158. package/umd/src/llm-providers/google/register-constructor.d.ts +0 -4
  1159. package/umd/src/llm-providers/mocked/$fakeTextToExpectations.d.ts +1 -5
  1160. package/umd/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts +0 -4
  1161. package/umd/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts +0 -3
  1162. package/umd/src/llm-providers/mocked/test/joker.test.d.ts +0 -3
  1163. package/umd/src/llm-providers/mocked/test/mocked-chat.test.d.ts +0 -4
  1164. package/umd/src/llm-providers/mocked/test/mocked-completion.test.d.ts +0 -3
  1165. package/umd/src/llm-providers/ollama/OllamaExecutionTools.d.ts +0 -3
  1166. package/umd/src/llm-providers/ollama/OllamaExecutionToolsOptions.d.ts +1 -0
  1167. package/umd/src/llm-providers/ollama/ollama-models.d.ts +1 -4
  1168. package/umd/src/llm-providers/ollama/playground/playground.d.ts +0 -4
  1169. package/umd/src/llm-providers/ollama/register-configuration.d.ts +0 -3
  1170. package/umd/src/llm-providers/ollama/register-constructor.d.ts +0 -4
  1171. package/umd/src/llm-providers/openai/OpenAiAgentKitExecutionTools.d.ts +10 -0
  1172. package/umd/src/llm-providers/openai/OpenAiAssistantExecutionTools.d.ts +1 -8
  1173. package/umd/src/llm-providers/openai/OpenAiCompatibleExecutionTools.d.ts +0 -7
  1174. package/umd/src/llm-providers/openai/OpenAiCompatibleExecutionToolsOptions.d.ts +2 -0
  1175. package/umd/src/llm-providers/openai/computeOpenAiUsage.d.ts +1 -3
  1176. package/umd/src/llm-providers/openai/computeOpenAiUsage.test.d.ts +0 -3
  1177. package/umd/src/llm-providers/openai/createOpenAiAssistantExecutionTools.d.ts +0 -4
  1178. package/umd/src/llm-providers/openai/createOpenAiCompatibleExecutionTools.d.ts +0 -4
  1179. package/umd/src/llm-providers/openai/createOpenAiExecutionTools.d.ts +0 -4
  1180. package/umd/src/llm-providers/openai/openai-models.d.ts +1 -0
  1181. package/umd/src/llm-providers/openai/openai-models.test.d.ts +0 -3
  1182. package/umd/src/llm-providers/openai/playground/playground.d.ts +0 -4
  1183. package/umd/src/llm-providers/openai/register-configuration.d.ts +0 -3
  1184. package/umd/src/llm-providers/openai/register-constructor.d.ts +0 -4
  1185. package/umd/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts +1 -9
  1186. package/umd/src/llm-providers/remote/playground/playground.d.ts +0 -3
  1187. package/umd/src/llm-providers/vercel/playground/playground.d.ts +0 -4
  1188. package/umd/src/other/templates/getBookTemplates.d.ts +2 -5
  1189. package/umd/src/personas/preparePersona.d.ts +1 -7
  1190. package/umd/src/pipeline/PipelineInterface/PipelineInterface.d.ts +1 -0
  1191. package/umd/src/pipeline/PipelineInterface/constants.d.ts +0 -3
  1192. package/umd/src/pipeline/PipelineJson/CommonTaskJson.d.ts +0 -4
  1193. package/umd/src/pipeline/PipelineJson/DialogTaskJson.d.ts +1 -3
  1194. package/umd/src/pipeline/PipelineJson/Expectations.d.ts +4 -3
  1195. package/umd/src/pipeline/PipelineJson/KnowledgePieceJson.d.ts +0 -4
  1196. package/umd/src/pipeline/PipelineJson/KnowledgeSourceJson.d.ts +0 -3
  1197. package/umd/src/pipeline/PipelineJson/PersonaJson.d.ts +0 -3
  1198. package/umd/src/pipeline/PipelineJson/PreparationJson.d.ts +3 -5
  1199. package/umd/src/pipeline/PipelineJson/ScriptTaskJson.d.ts +1 -4
  1200. package/umd/src/pipeline/PipelineJson/SimpleTaskJson.d.ts +1 -3
  1201. package/umd/src/pipeline/book-notation.d.ts +1 -4
  1202. package/umd/src/pipeline/isValidPipelineString.d.ts +1 -3
  1203. package/umd/src/pipeline/isValidPipelineString.test.d.ts +0 -3
  1204. package/umd/src/pipeline/prompt-notation/helpers/ParameterEscaping.d.ts +5 -0
  1205. package/umd/src/pipeline/prompt-notation/helpers/ParameterNaming.d.ts +1 -0
  1206. package/umd/src/pipeline/prompt-notation/helpers/ParameterSection.d.ts +2 -0
  1207. package/umd/src/pipeline/prompt-notation.d.ts +2 -5
  1208. package/umd/src/pipeline/prompt-notation.test.d.ts +0 -3
  1209. package/umd/src/pipeline/validatePipelineString.d.ts +1 -3
  1210. package/umd/src/playground/permanent/_boilerplate.d.ts +0 -3
  1211. package/umd/src/playground/permanent/agent-with-browser-playground.d.ts +0 -3
  1212. package/umd/src/playground/permanent/error-handling-playground.d.ts +0 -3
  1213. package/umd/src/playground/playground.d.ts +0 -4
  1214. package/umd/src/postprocessing/utils/extractBlock.d.ts +2 -1
  1215. package/umd/src/postprocessing/utils/extractJsonBlock.d.ts +2 -5
  1216. package/umd/src/prepare/PrepareAndScrapeOptions.d.ts +0 -4
  1217. package/umd/src/prepare/preparePipeline.d.ts +3 -2
  1218. package/umd/src/prepare/preparePipelineOnRemoteServer.d.ts +2 -5
  1219. package/umd/src/prepare/prepareTasks.d.ts +6 -10
  1220. package/umd/src/prepare/unpreparePipeline.d.ts +1 -5
  1221. package/umd/src/remote-server/RemoteServer.d.ts +3 -0
  1222. package/umd/src/remote-server/openapi.d.ts +3 -4
  1223. package/umd/src/remote-server/socket-types/_subtypes/Identification.d.ts +1 -5
  1224. package/umd/src/remote-server/socket-types/listModels/PromptbookServer_ListModels_Request.d.ts +0 -3
  1225. package/umd/src/remote-server/socket-types/listModels/PromptbookServer_ListModels_Response.d.ts +0 -3
  1226. package/umd/src/remote-server/startAgentServer.d.ts +6 -4
  1227. package/umd/src/remote-server/startRemoteServer.d.ts +1 -16
  1228. package/umd/src/remote-server/types/RemoteClientOptions.d.ts +0 -5
  1229. package/umd/src/remote-server/types/RemoteServerOptions.d.ts +10 -4
  1230. package/umd/src/remote-server/ui/ServerApp.d.ts +1 -0
  1231. package/umd/src/remote-server/ui/types.d.ts +3 -0
  1232. package/umd/src/scrapers/_boilerplate/BoilerplateScraper.d.ts +1 -6
  1233. package/umd/src/scrapers/_boilerplate/createBoilerplateScraper.d.ts +0 -3
  1234. package/umd/src/scrapers/_boilerplate/playground/boilerplate-scraper-playground.d.ts +0 -3
  1235. package/umd/src/scrapers/_boilerplate/register-constructor.d.ts +0 -4
  1236. package/umd/src/scrapers/_boilerplate/register-metadata.d.ts +0 -3
  1237. package/umd/src/scrapers/_common/Scraper.d.ts +0 -5
  1238. package/umd/src/scrapers/_common/ScraperIntermediateSource.d.ts +0 -3
  1239. package/umd/src/scrapers/_common/prepareKnowledgePieces.d.ts +1 -0
  1240. package/umd/src/scrapers/_common/register/$provideFilesystemForNode.d.ts +0 -4
  1241. package/umd/src/scrapers/_common/register/$provideScrapersForNode.d.ts +1 -4
  1242. package/umd/src/scrapers/_common/register/$provideScriptingForNode.d.ts +0 -4
  1243. package/umd/src/scrapers/_common/register/$registeredScrapersMessage.d.ts +0 -3
  1244. package/umd/src/scrapers/_common/register/$scrapersMetadataRegister.d.ts +2 -3
  1245. package/umd/src/scrapers/_common/register/$scrapersRegister.d.ts +2 -3
  1246. package/umd/src/scrapers/_common/register/ScraperConstructor.d.ts +0 -3
  1247. package/umd/src/scrapers/_common/utils/getScraperIntermediateSource.d.ts +0 -7
  1248. package/umd/src/scrapers/_common/utils/getScraperIntermediateSource.test.d.ts +0 -3
  1249. package/umd/src/scrapers/_common/utils/promptbookFetch.d.ts +0 -3
  1250. package/umd/src/scrapers/document/DocumentScraper.d.ts +1 -6
  1251. package/umd/src/scrapers/document/DocumentScraper.test.d.ts +0 -3
  1252. package/umd/src/scrapers/document/createDocumentScraper.d.ts +0 -3
  1253. package/umd/src/scrapers/document/playground/document-scraper-playground.d.ts +0 -3
  1254. package/umd/src/scrapers/document/register-constructor.d.ts +0 -4
  1255. package/umd/src/scrapers/document/register-metadata.d.ts +0 -3
  1256. package/umd/src/scrapers/document-legacy/LegacyDocumentScraper.d.ts +1 -6
  1257. package/umd/src/scrapers/document-legacy/LegacyDocumentScraper.test.d.ts +0 -3
  1258. package/umd/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts +0 -3
  1259. package/umd/src/scrapers/document-legacy/playground/legacy-document-scraper-playground.d.ts +0 -3
  1260. package/umd/src/scrapers/document-legacy/register-constructor.d.ts +0 -4
  1261. package/umd/src/scrapers/document-legacy/register-metadata.d.ts +0 -3
  1262. package/umd/src/scrapers/markdown/MarkdownScraper.d.ts +1 -4
  1263. package/umd/src/scrapers/markdown/MarkdownScraper.test.d.ts +0 -3
  1264. package/umd/src/scrapers/markdown/createMarkdownScraper.d.ts +0 -3
  1265. package/umd/src/scrapers/markdown/playground/markdown-scraper-playground.d.ts +0 -3
  1266. package/umd/src/scrapers/markdown/register-constructor.d.ts +0 -4
  1267. package/umd/src/scrapers/markdown/register-metadata.d.ts +0 -3
  1268. package/umd/src/scrapers/markitdown/MarkitdownScraper.d.ts +1 -7
  1269. package/umd/src/scrapers/markitdown/createMarkitdownScraper.d.ts +0 -4
  1270. package/umd/src/scrapers/markitdown/playground/markitdown-scraper-playground.d.ts +0 -3
  1271. package/umd/src/scrapers/markitdown/register-constructor.d.ts +0 -5
  1272. package/umd/src/scrapers/markitdown/register-metadata.d.ts +0 -3
  1273. package/umd/src/scrapers/pdf/PdfScraper.d.ts +1 -6
  1274. package/umd/src/scrapers/pdf/createPdfScraper.d.ts +0 -3
  1275. package/umd/src/scrapers/pdf/playground/pdf-scraper-playground.d.ts +0 -3
  1276. package/umd/src/scrapers/pdf/register-constructor.d.ts +0 -4
  1277. package/umd/src/scrapers/pdf/register-metadata.d.ts +0 -3
  1278. package/umd/src/scrapers/website/WebsiteScraper.d.ts +1 -6
  1279. package/umd/src/scrapers/website/createWebsiteScraper.d.ts +0 -3
  1280. package/umd/src/scrapers/website/playground/website-scraper-playground.d.ts +0 -3
  1281. package/umd/src/scrapers/website/register-constructor.d.ts +0 -4
  1282. package/umd/src/scrapers/website/register-metadata.d.ts +0 -3
  1283. package/umd/src/scripting/javascript/JavascriptEvalExecutionTools.d.ts +1 -5
  1284. package/umd/src/scripting/javascript/JavascriptEvalExecutionTools.test.d.ts +0 -3
  1285. package/umd/src/scripting/javascript/JavascriptExecutionTools.d.ts +1 -0
  1286. package/umd/src/scripting/javascript/JavascriptExecutionToolsOptions.d.ts +0 -3
  1287. package/umd/src/scripting/javascript/postprocessing-functions.d.ts +0 -4
  1288. package/umd/src/scripting/javascript/utils/extractVariablesFromJavascript.d.ts +1 -3
  1289. package/umd/src/search-engines/SearchEngine.d.ts +3 -0
  1290. package/umd/src/speech-recognition/BrowserSpeechRecognition.d.ts +0 -4
  1291. package/umd/src/speech-recognition/OpenAiSpeechRecognition.d.ts +2 -2
  1292. package/umd/src/storage/_common/PromptbookStorage.d.ts +0 -4
  1293. package/umd/src/storage/_common/PromptbookStorage.test-type.d.ts +0 -4
  1294. package/umd/src/storage/env-storage/$EnvStorage.d.ts +0 -3
  1295. package/umd/src/storage/file-cache-storage/FileCacheStorage.d.ts +0 -4
  1296. package/umd/src/storage/local-storage/getIndexedDbStorage.d.ts +0 -3
  1297. package/umd/src/storage/local-storage/getLocalStorage.d.ts +0 -3
  1298. package/umd/src/storage/local-storage/getSessionStorage.d.ts +0 -3
  1299. package/umd/src/storage/local-storage/utils/makePromptbookStorageFromIndexedDb.d.ts +1 -0
  1300. package/umd/src/storage/local-storage/utils/makePromptbookStorageFromWebStorage.d.ts +0 -4
  1301. package/umd/src/transpilers/_common/register/$bookTranspilersRegister.d.ts +1 -3
  1302. package/umd/src/transpilers/formatted-book-in-markdown/register.d.ts +2 -5
  1303. package/umd/src/transpilers/openai-sdk/playground/playground.d.ts +0 -3
  1304. package/umd/src/transpilers/openai-sdk/register.d.ts +2 -5
  1305. package/umd/src/types/Arrayable.d.ts +1 -0
  1306. package/umd/src/types/InputParameters_private.d.ts +13 -0
  1307. package/umd/src/types/IntermediateFilesStrategy.d.ts +0 -3
  1308. package/umd/src/types/LlmCall.d.ts +0 -3
  1309. package/umd/src/types/ModelRequirements.d.ts +1 -0
  1310. package/umd/src/types/ModelVariant.d.ts +3 -0
  1311. package/umd/src/types/Parameters.d.ts +31 -0
  1312. package/umd/src/types/Parameters_private.d.ts +18 -0
  1313. package/umd/src/types/Prompt.d.ts +1 -6
  1314. package/umd/src/types/ReservedParameters_private.d.ts +11 -0
  1315. package/umd/src/types/ToolCall.d.ts +0 -2
  1316. package/umd/src/types/Updatable.d.ts +1 -3
  1317. package/umd/src/types/number_bytes.d.ts +21 -0
  1318. package/umd/src/types/number_id.d.ts +13 -0
  1319. package/umd/src/types/number_likeness.d.ts +8 -0
  1320. package/umd/src/types/number_milliseconds.d.ts +33 -0
  1321. package/umd/src/types/number_percent.d.ts +18 -0
  1322. package/umd/src/types/number_positive.d.ts +16 -0
  1323. package/umd/src/types/number_usd.d.ts +6 -106
  1324. package/umd/src/types/string_agent_hash_private.d.ts +9 -0
  1325. package/umd/src/types/string_agent_name.d.ts +32 -0
  1326. package/umd/src/types/string_agent_name_in_book_private.d.ts +8 -0
  1327. package/umd/src/types/string_agent_name_private.d.ts +10 -0
  1328. package/umd/src/types/string_agent_permanent_id_private.d.ts +11 -0
  1329. package/umd/src/types/string_base64_private.d.ts +17 -0
  1330. package/umd/src/types/string_business_category_name.d.ts +5 -0
  1331. package/umd/src/types/string_business_category_name_private.d.ts +6 -0
  1332. package/umd/src/types/string_char_private.d.ts +8 -0
  1333. package/umd/src/types/string_chat_prompt_private.d.ts +9 -0
  1334. package/umd/src/types/string_completion_prompt_private.d.ts +9 -0
  1335. package/umd/src/types/string_email_private.d.ts +16 -0
  1336. package/umd/src/types/string_host_private.d.ts +55 -0
  1337. package/umd/src/types/string_markdown.d.ts +0 -1
  1338. package/umd/src/types/string_mime_type_private.d.ts +18 -0
  1339. package/umd/src/types/string_model_description_private.d.ts +8 -0
  1340. package/umd/src/types/string_model_name.d.ts +7 -0
  1341. package/umd/src/types/string_model_name_private.d.ts +8 -0
  1342. package/umd/src/types/string_name.d.ts +31 -0
  1343. package/umd/src/types/string_name_private.d.ts +9 -0
  1344. package/umd/src/types/string_page.d.ts +15 -0
  1345. package/umd/src/types/string_page_private.d.ts +9 -0
  1346. package/umd/src/types/string_parameter_name.d.ts +11 -167
  1347. package/umd/src/types/string_parameter_value_private.d.ts +9 -0
  1348. package/umd/src/types/string_persona_description.d.ts +14 -0
  1349. package/umd/src/types/string_persona_description_private.d.ts +8 -0
  1350. package/umd/src/types/string_prompt.d.ts +49 -0
  1351. package/umd/src/types/string_prompt_image_private.d.ts +8 -0
  1352. package/umd/src/types/string_prompt_private.d.ts +8 -0
  1353. package/umd/src/types/string_reserved_parameter_name_private.d.ts +11 -0
  1354. package/umd/src/types/string_sha256.d.ts +2 -2
  1355. package/umd/src/types/string_system_message_private.d.ts +9 -0
  1356. package/umd/src/types/string_template_private.d.ts +8 -0
  1357. package/umd/src/types/string_text_prompt_private.d.ts +9 -0
  1358. package/umd/src/types/string_title.d.ts +8 -0
  1359. package/umd/src/types/string_title_private.d.ts +9 -0
  1360. package/umd/src/types/string_url.d.ts +50 -46
  1361. package/umd/src/types/string_url_private.d.ts +88 -0
  1362. package/umd/src/types/typeAliasEmoji.d.ts +0 -3
  1363. package/umd/src/types/typeAliases.d.ts +7 -7
  1364. package/umd/src/utils/DEFAULT_THINKING_MESSAGES.d.ts +5 -1
  1365. package/umd/src/utils/chat/chatAttachments/appendChatAttachmentContext.d.ts +1 -0
  1366. package/umd/src/utils/chat/chatAttachments/appendChatAttachmentContextWithContent.d.ts +1 -0
  1367. package/umd/src/utils/chat/chatAttachments/formatChatAttachmentContentContext.d.ts +1 -0
  1368. package/umd/src/utils/chat/chatAttachments/formatChatAttachmentContext.d.ts +1 -0
  1369. package/umd/src/utils/chat/chatAttachments/normalizeChatAttachments.d.ts +1 -0
  1370. package/umd/src/utils/chat/chatAttachments/resolveChatAttachmentContent.d.ts +1 -0
  1371. package/umd/src/utils/chat/chatAttachments/resolveChatAttachmentContents.d.ts +1 -0
  1372. package/umd/src/utils/chat/chatAttachments.d.ts +0 -3
  1373. package/umd/src/utils/chat/constants.d.ts +0 -3
  1374. package/umd/src/utils/clientVersion.d.ts +0 -3
  1375. package/umd/src/utils/color/$randomColor.d.ts +0 -5
  1376. package/umd/src/utils/color/css-colors.d.ts +0 -3
  1377. package/umd/src/utils/color/internal-utils/hslToRgb.d.ts +0 -3
  1378. package/umd/src/utils/color/internal-utils/rgbToHsl.d.ts +0 -3
  1379. package/umd/src/utils/color/operators/ColorTransformer.d.ts +2 -0
  1380. package/umd/src/utils/color/operators/lighten.d.ts +0 -3
  1381. package/umd/src/utils/color/operators/saturate.d.ts +0 -3
  1382. package/umd/src/utils/color/utils/areColorsEqual.d.ts +0 -3
  1383. package/umd/src/utils/color/utils/colorDistance.d.ts +2 -2
  1384. package/umd/src/utils/color/utils/colorHue.d.ts +0 -1
  1385. package/umd/src/utils/color/utils/colorHueDistance.d.ts +0 -1
  1386. package/umd/src/utils/color/utils/colorToDataUrl.d.ts +0 -3
  1387. package/umd/src/utils/database/uniqueConstraint.d.ts +1 -3
  1388. package/umd/src/utils/editable/edit-pipeline-string/addPipelineCommand.d.ts +3 -4
  1389. package/umd/src/utils/editable/edit-pipeline-string/deflatePipeline.d.ts +0 -3
  1390. package/umd/src/utils/editable/types/PipelineEditableSerialized.d.ts +2 -2
  1391. package/umd/src/utils/editable/utils/renamePipelineParameter.d.ts +4 -3
  1392. package/umd/src/utils/editable/utils/stringifyPipelineJson.d.ts +0 -6
  1393. package/umd/src/utils/environment/$detectRuntimeEnvironment.d.ts +0 -3
  1394. package/umd/src/utils/environment/$getGlobalScope.d.ts +1 -1
  1395. package/umd/src/utils/environment/$isRunningInBrowser.d.ts +0 -3
  1396. package/umd/src/utils/environment/$isRunningInJest.d.ts +0 -3
  1397. package/umd/src/utils/environment/$isRunningInNode.d.ts +0 -3
  1398. package/umd/src/utils/environment/$isRunningInWebWorker.d.ts +0 -3
  1399. package/umd/src/utils/execCommand/$execCommand.d.ts +0 -4
  1400. package/umd/src/utils/execCommand/$execCommands.d.ts +0 -3
  1401. package/umd/src/utils/execCommand/ExecCommandOptions.d.ts +3 -4
  1402. package/umd/src/utils/expectation-counters/constants.d.ts +0 -4
  1403. package/umd/src/utils/expectation-counters/countCharacters.d.ts +0 -4
  1404. package/umd/src/utils/expectation-counters/countLines.d.ts +0 -4
  1405. package/umd/src/utils/expectation-counters/countPages.d.ts +0 -4
  1406. package/umd/src/utils/expectation-counters/countParagraphs.d.ts +0 -4
  1407. package/umd/src/utils/expectation-counters/countSentences.d.ts +0 -4
  1408. package/umd/src/utils/expectation-counters/countWords.d.ts +0 -5
  1409. package/umd/src/utils/expectation-counters/index.d.ts +0 -4
  1410. package/umd/src/utils/files/$induceBookDownload.d.ts +0 -3
  1411. package/umd/src/utils/files/$induceFileDownload.d.ts +0 -3
  1412. package/umd/src/utils/files/ObjectUrl.d.ts +0 -3
  1413. package/umd/src/utils/files/isDirectoryExisting.d.ts +0 -6
  1414. package/umd/src/utils/files/isExecutable.d.ts +0 -4
  1415. package/umd/src/utils/files/isFileExisting.d.ts +0 -5
  1416. package/umd/src/utils/files/listAllFiles.d.ts +1 -5
  1417. package/umd/src/utils/files/readResponseBytes.d.ts +1 -0
  1418. package/umd/src/utils/knowledge/inlineKnowledgeSource.d.ts +11 -6
  1419. package/umd/src/utils/knowledge/simplifyKnowledgeLabel.d.ts +2 -0
  1420. package/umd/src/utils/linguistic-hash/linguisticHash.d.ts +2 -1
  1421. package/umd/src/utils/linguistic-hash/linguisticHashTypes.d.ts +0 -3
  1422. package/umd/src/utils/linguistic-hash/linguisticHashWords.cs.d.ts +0 -3
  1423. package/umd/src/utils/linguistic-hash/linguisticHashWords.en.d.ts +0 -3
  1424. package/umd/src/utils/markdown/addAutoGeneratedSection.d.ts +0 -3
  1425. package/umd/src/utils/markdown/createMarkdownTable.d.ts +0 -3
  1426. package/umd/src/utils/markdown/escapeMarkdownBlock.d.ts +0 -3
  1427. package/umd/src/utils/markdown/extractAllBlocksFromMarkdown.d.ts +1 -3
  1428. package/umd/src/utils/markdown/extractAllListItemsFromMarkdown.d.ts +1 -0
  1429. package/umd/src/utils/markdown/extractOneBlockFromMarkdown.d.ts +2 -4
  1430. package/umd/src/utils/markdown/humanizeAiText.d.ts +0 -3
  1431. package/umd/src/utils/markdown/humanizeAiTextEllipsis.d.ts +0 -3
  1432. package/umd/src/utils/markdown/humanizeAiTextEmdashed.d.ts +0 -3
  1433. package/umd/src/utils/markdown/humanizeAiTextQuotes.d.ts +0 -3
  1434. package/umd/src/utils/markdown/humanizeAiTextSources.d.ts +0 -3
  1435. package/umd/src/utils/markdown/humanizeAiTextWhitespace.d.ts +0 -3
  1436. package/umd/src/utils/markdown/prettifyMarkdown.d.ts +4 -2
  1437. package/umd/src/utils/markdown/promptbookifyAiText.d.ts +0 -3
  1438. package/umd/src/utils/markdown/removeMarkdownComments.d.ts +1 -0
  1439. package/umd/src/utils/markdown/removeMarkdownFormatting.d.ts +1 -0
  1440. package/umd/src/utils/markdown/removeMarkdownLinks.d.ts +1 -0
  1441. package/umd/src/utils/markdown/trimCodeBlock.d.ts +1 -1
  1442. package/umd/src/utils/markdown/trimEndOfCodeBlock.d.ts +1 -1
  1443. package/umd/src/utils/misc/$getCurrentDate.d.ts +1 -0
  1444. package/umd/src/utils/misc/aboutPromptbookInformation.d.ts +3 -3
  1445. package/umd/src/utils/misc/computeHash.d.ts +0 -3
  1446. package/umd/src/utils/misc/debounce.d.ts +2 -0
  1447. package/umd/src/utils/misc/emojis.d.ts +3 -8
  1448. package/umd/src/utils/misc/injectCssModuleIntoShadowRoot.d.ts +7 -2
  1449. package/umd/src/utils/misc/parseNumber.d.ts +0 -4
  1450. package/umd/src/utils/misc/xAboutPromptbookInformation.d.ts +3 -4
  1451. package/umd/src/utils/normalization/IKeywords.d.ts +0 -3
  1452. package/umd/src/utils/normalization/nameToUriPart.d.ts +1 -0
  1453. package/umd/src/utils/normalization/nameToUriParts.d.ts +1 -0
  1454. package/umd/src/utils/normalization/normalize-to-kebab-case.d.ts +2 -3
  1455. package/umd/src/utils/normalization/normalizeTo_PascalCase.d.ts +2 -0
  1456. package/umd/src/utils/normalization/normalizeTo_SCREAMING_CASE.d.ts +2 -0
  1457. package/umd/src/utils/normalization/normalizeTo_camelCase.d.ts +2 -3
  1458. package/umd/src/utils/normalization/normalizeTo_snake_case.d.ts +1 -0
  1459. package/umd/src/utils/normalization/orderJson.d.ts +1 -0
  1460. package/umd/src/utils/normalization/orderJson.test.d.ts +0 -3
  1461. package/umd/src/utils/normalization/parseKeywords.d.ts +1 -4
  1462. package/umd/src/utils/normalization/parseKeywordsFromString.d.ts +1 -0
  1463. package/umd/src/utils/normalization/removeDiacritics.d.ts +1 -3
  1464. package/umd/src/utils/normalization/removeEmojis.d.ts +1 -0
  1465. package/umd/src/utils/normalization/removeQuotes.d.ts +1 -0
  1466. package/umd/src/utils/normalization/searchKeywords.d.ts +1 -3
  1467. package/umd/src/utils/normalization/titleToName.d.ts +1 -0
  1468. package/umd/src/utils/normalization/unwrapResult.d.ts +1 -3
  1469. package/umd/src/utils/organization/$sideEffect.d.ts +1 -0
  1470. package/umd/src/utils/organization/TODO_USE.d.ts +1 -0
  1471. package/umd/src/utils/organization/just.d.ts +1 -0
  1472. package/umd/src/utils/organization/keepImported.d.ts +1 -0
  1473. package/umd/src/utils/organization/keepTypeImported.d.ts +1 -0
  1474. package/umd/src/utils/organization/keepUnused.d.ts +1 -0
  1475. package/umd/src/utils/organization/preserve.d.ts +1 -3
  1476. package/umd/src/utils/organization/really_any.d.ts +1 -0
  1477. package/umd/src/utils/organization/spaceTrim.d.ts +3 -2
  1478. package/umd/src/utils/parameters/extractParameterNames.d.ts +1 -0
  1479. package/umd/src/utils/parameters/mapAvailableToExpectedParameters.d.ts +1 -0
  1480. package/umd/src/utils/parameters/templateParameters.d.ts +2 -1
  1481. package/umd/src/utils/parameters/valueToString.d.ts +2 -2
  1482. package/umd/src/utils/random/$generateBookBoilerplate.d.ts +3 -3
  1483. package/umd/src/utils/random/$randomAgentPersona.d.ts +1 -3
  1484. package/umd/src/utils/random/$randomAgentRule.d.ts +1 -3
  1485. package/umd/src/utils/random/$randomFullnameWithColor.d.ts +4 -3
  1486. package/umd/src/utils/random/$randomItem.d.ts +0 -3
  1487. package/umd/src/utils/random/$randomSeed.d.ts +0 -3
  1488. package/umd/src/utils/random/$randomToken.d.ts +2 -5
  1489. package/umd/src/utils/random/EnglishNamePool.d.ts +1 -0
  1490. package/umd/src/utils/serialization/$deepFreeze.d.ts +1 -3
  1491. package/umd/src/utils/serialization/checkSerializableAsJson.d.ts +1 -5
  1492. package/umd/src/utils/serialization/clonePipeline.d.ts +1 -3
  1493. package/umd/src/utils/serialization/deepClone.d.ts +1 -3
  1494. package/umd/src/utils/serialization/exportJson.d.ts +1 -3
  1495. package/umd/src/utils/serialization/isSerializableAsJson.d.ts +0 -5
  1496. package/umd/src/utils/serialization/jsonStringsToJsons.d.ts +1 -4
  1497. package/umd/src/utils/serialization/serializeToPromptbookJavascript.d.ts +3 -3
  1498. package/umd/src/utils/sets/difference.d.ts +1 -3
  1499. package/umd/src/utils/sets/intersection.d.ts +1 -0
  1500. package/umd/src/utils/sets/union.d.ts +1 -0
  1501. package/umd/src/utils/take/classes/TakeChain.d.ts +4 -1
  1502. package/umd/src/utils/take/interfaces/ITakeChain.d.ts +5 -1
  1503. package/umd/src/utils/take/interfaces/Takeable.d.ts +2 -1
  1504. package/umd/src/utils/take/take.d.ts +1 -1
  1505. package/umd/src/utils/validators/filePath/isRootPath.d.ts +1 -3
  1506. package/umd/src/utils/validators/filePath/isRootPath.test.d.ts +0 -3
  1507. package/umd/src/utils/validators/filePath/isValidFilePath.d.ts +1 -3
  1508. package/umd/src/utils/validators/javascriptName/isValidJavascriptName.d.ts +1 -0
  1509. package/umd/src/utils/validators/parameterName/validateParameterName.d.ts +1 -0
  1510. package/umd/src/utils/validators/semanticVersion/isValidPromptbookVersion.d.ts +2 -1
  1511. package/umd/src/utils/validators/url/extractUrlsFromText.d.ts +1 -0
  1512. package/umd/src/utils/validators/url/isUrlOnPrivateNetwork.d.ts +1 -0
  1513. package/umd/src/utils/validators/url/isValidAgentUrl.d.ts +0 -3
  1514. package/umd/src/utils/validators/url/isValidPipelineUrl.d.ts +0 -3
  1515. package/umd/src/utils/validators/url/normalizeDomainForMatching.d.ts +1 -0
  1516. package/umd/src/version.d.ts +1 -1
  1517. package/umd/src/wizard/$getCompiledBook.d.ts +0 -4
  1518. package/umd/src/wizard/wizard.d.ts +1 -4
package/esm/index.es.js CHANGED
@@ -29,7 +29,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
29
29
  * @generated
30
30
  * @see https://github.com/webgptorg/promptbook
31
31
  */
32
- const PROMPTBOOK_ENGINE_VERSION = '0.112.0-32';
32
+ const PROMPTBOOK_ENGINE_VERSION = '0.112.0-35';
33
33
  /**
34
34
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
35
35
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -39,16 +39,20 @@ const PROMPTBOOK_ENGINE_VERSION = '0.112.0-32';
39
39
  * Trims string from all 4 sides
40
40
  *
41
41
  * Note: This is a re-exported function from the `spacetrim` package which is
42
- * Developed by same author @hejny as this package
42
+ * Developed by same author @hejny as this package
43
43
  *
44
- * @public exported from `@promptbook/utils`
45
44
  * @see https://github.com/hejny/spacetrim#usage
45
+ *
46
+ * @public exported from `@promptbook/utils`
46
47
  */
47
48
  const spaceTrim = spaceTrim$1;
48
49
 
49
50
  /**
50
- * @private util of `@promptbook/color`
51
+ * Class implementing take chain.
52
+ *
51
53
  * @de
54
+ *
55
+ * @private util of `@promptbook/color`
52
56
  */
53
57
  class TakeChain {
54
58
  constructor(value) {
@@ -65,9 +69,9 @@ class TakeChain {
65
69
  *
66
70
  * @param {*} initialValue - The initial value.
67
71
  * @returns {Proxy<WithTake<TValue>>} - A proxy object with a `take` method.
72
+ * @deprecated [🤡] Use some better functional library instead of `TakeChain`
68
73
  *
69
74
  * @private util of `@promptbook/color`
70
- * @deprecated [🤡] Use some better functional library instead of `TakeChain`
71
75
  */
72
76
  function take(initialValue) {
73
77
  if (initialValue instanceof TakeChain) {
@@ -245,9 +249,7 @@ const CSS_COLORS = {
245
249
  yellow: '#ffff00',
246
250
  yellowgreen: '#9acd32',
247
251
  };
248
- /**
249
- * Note: [💞] Ignore a discrepancy between file name and entity name
250
- */
252
+ // Note: [💞] Ignore a discrepancy between file name and entity name
251
253
 
252
254
  /**
253
255
  * Validates that a channel value is a valid number within the range of 0 to 255.
@@ -277,7 +279,13 @@ function checkChannelValue(channelName, value) {
277
279
  }
278
280
  }
279
281
 
282
+ /**
283
+ * Constant for short hex lengths.
284
+ */
280
285
  const SHORT_HEX_LENGTHS = new Set([3, 4]);
286
+ /**
287
+ * Constant for long hex lengths.
288
+ */
281
289
  const LONG_HEX_LENGTHS = new Set([6, 8]);
282
290
  /**
283
291
  * Parses a hex string into RGBA channel values.
@@ -310,6 +318,9 @@ function parseHexColor(hex) {
310
318
  }
311
319
  return throwInvalidHex();
312
320
  }
321
+ /**
322
+ * Parses short hex channel.
323
+ */
313
324
  function parseShortHexChannel(char, onError) {
314
325
  if (!char) {
315
326
  return onError();
@@ -320,6 +331,9 @@ function parseShortHexChannel(char, onError) {
320
331
  }
321
332
  return parsed * 16;
322
333
  }
334
+ /**
335
+ * Parses long hex channel.
336
+ */
323
337
  function parseLongHexChannel(hex, start, onError) {
324
338
  const segment = hex.substr(start, 2);
325
339
  if (segment.length < 2) {
@@ -332,6 +346,9 @@ function parseLongHexChannel(hex, start, onError) {
332
346
  return parsed;
333
347
  }
334
348
 
349
+ /**
350
+ * Pattern matching hsl.
351
+ */
335
352
  const HSL_REGEX = /^hsl\(\s*([0-9.]+)\s*,\s*([0-9.]+)%\s*,\s*([0-9.]+)%\s*\)$/;
336
353
  /**
337
354
  * Parses an HSL string into RGBA channel values.
@@ -357,6 +374,9 @@ function parseHslColor(hsl) {
357
374
  alpha: 255,
358
375
  };
359
376
  }
377
+ /**
378
+ * Handles convert hsl to Rgb.
379
+ */
360
380
  function convertHslToRgb(h, s, l) {
361
381
  const c = (1 - Math.abs(2 * l - 1)) * s;
362
382
  const x = c * (1 - Math.abs(((h / 60) % 2) - 1));
@@ -395,7 +415,13 @@ function convertHslToRgb(h, s, l) {
395
415
  };
396
416
  }
397
417
 
418
+ /**
419
+ * Pattern matching RGB.
420
+ */
398
421
  const RGB_REGEX = /^rgb\(\s*([0-9.%-]+)\s*,\s*([0-9.%-]+)\s*,\s*([0-9.%-]+)\s*\)$/;
422
+ /**
423
+ * Pattern matching rgba.
424
+ */
399
425
  const RGBA_REGEX = /^rgba\(\s*([0-9.%-]+)\s*,\s*([0-9.%-]+)\s*,\s*([0-9.%-]+)\s*,\s*([0-9.%-]+)\s*\)$/;
400
426
  /**
401
427
  * Parses an RGB string into RGBA channel values.
@@ -437,6 +463,9 @@ function parseRgbaColor(rgba) {
437
463
  alpha: parseAlphaValue(match[4]),
438
464
  };
439
465
  }
466
+ /**
467
+ * Parses channel value.
468
+ */
440
469
  function parseChannelValue(value) {
441
470
  if (value.endsWith('%')) {
442
471
  const percent = parseFloat(value);
@@ -444,6 +473,9 @@ function parseChannelValue(value) {
444
473
  }
445
474
  return Math.round(parseFloat(value));
446
475
  }
476
+ /**
477
+ * Parses alpha value.
478
+ */
447
479
  function parseAlphaValue(value) {
448
480
  if (value.endsWith('%')) {
449
481
  const percent = parseFloat(value);
@@ -456,8 +488,17 @@ function parseAlphaValue(value) {
456
488
  return Math.round(parsed);
457
489
  }
458
490
 
491
+ /**
492
+ * Pattern matching hsl regex.
493
+ */
459
494
  const HSL_REGEX_PATTERN = /^hsl\(\s*([0-9.]+)\s*,\s*([0-9.]+)%\s*,\s*([0-9.]+)%\s*\)$/;
495
+ /**
496
+ * Pattern matching RGB regex.
497
+ */
460
498
  const RGB_REGEX_PATTERN = /^rgb\(\s*([0-9.%-]+)\s*,\s*([0-9.%-]+)\s*,\s*([0-9.%-]+)\s*\)$/;
499
+ /**
500
+ * Pattern matching rgba regex.
501
+ */
461
502
  const RGBA_REGEX_PATTERN = /^rgba\(\s*([0-9.%-]+)\s*,\s*([0-9.%-]+)\s*,\s*([0-9.%-]+)\s*,\s*([0-9.%-]+)\s*\)$/;
462
503
  /**
463
504
  * Color object represents an RGB color with alpha channel
@@ -823,9 +864,7 @@ function hslToRgb(hue, saturation, lightness) {
823
864
  }
824
865
  return [Math.round(red * 255), Math.round(green * 255), Math.round(blue * 255)];
825
866
  }
826
- /**
827
- * TODO: Properly name all used internal variables
828
- */
867
+ // TODO: Properly name all used internal variables
829
868
 
830
869
  /**
831
870
  * Converts RGB values to HSL values
@@ -871,9 +910,7 @@ function rgbToHsl(red, green, blue) {
871
910
  }
872
911
  return [hue, saturation, lightness];
873
912
  }
874
- /**
875
- * TODO: Properly name all used internal variables
876
- */
913
+ // TODO: Properly name all used internal variables
877
914
 
878
915
  /**
879
916
  * Makes color transformer which lighten the given color
@@ -891,9 +928,7 @@ function lighten(amount) {
891
928
  return Color.fromValues(r, g, b, alpha);
892
929
  };
893
930
  }
894
- /**
895
- * TODO: Maybe implement by mix+hsl
896
- */
931
+ // TODO: Maybe implement by mix+hsl
897
932
 
898
933
  /**
899
934
  * Makes color transformer which saturate the given color
@@ -911,9 +946,7 @@ function saturate(amount) {
911
946
  return Color.fromValues(r, g, b, alpha);
912
947
  };
913
948
  }
914
- /**
915
- * TODO: Maybe implement by mix+hsl
916
- */
949
+ // TODO: Maybe implement by mix+hsl
917
950
 
918
951
  /**
919
952
  * Returns the same value that is passed as argument.
@@ -926,6 +959,7 @@ function saturate(amount) {
926
959
  *
927
960
  * @param value any values
928
961
  * @returns the same values
962
+ *
929
963
  * @private within the repository
930
964
  */
931
965
  function just(value) {
@@ -1492,9 +1526,7 @@ class ActionCommitmentDefinition extends BaseCommitmentDefinition {
1492
1526
  return this.appendToSystemMessage(requirements, actionSection, '\n\n');
1493
1527
  }
1494
1528
  }
1495
- /**
1496
- * Note: [💞] Ignore a discrepancy between file name and entity name
1497
- */
1529
+ // Note: [💞] Ignore a discrepancy between file name and entity name
1498
1530
 
1499
1531
  /**
1500
1532
  * Just says that the variable is not used but should be kept
@@ -1508,6 +1540,7 @@ class ActionCommitmentDefinition extends BaseCommitmentDefinition {
1508
1540
  *
1509
1541
  * @param value any values
1510
1542
  * @returns void
1543
+ *
1511
1544
  * @private within the repository
1512
1545
  */
1513
1546
  function keepUnused(...valuesToKeep) {
@@ -1577,9 +1610,7 @@ class ClosedCommitmentDefinition extends BaseCommitmentDefinition {
1577
1610
  };
1578
1611
  }
1579
1612
  }
1580
- /**
1581
- * Note: [💞] Ignore a discrepancy between file name and entity name
1582
- */
1613
+ // Note: [💞] Ignore a discrepancy between file name and entity name
1583
1614
 
1584
1615
  /**
1585
1616
  * COMPONENT commitment definition
@@ -1638,9 +1669,7 @@ class ComponentCommitmentDefinition extends BaseCommitmentDefinition {
1638
1669
  return this.appendToSystemMessage(requirements, componentSection, '\n\n');
1639
1670
  }
1640
1671
  }
1641
- /**
1642
- * Note: [💞] Ignore a discrepancy between file name and entity name
1643
- */
1672
+ // Note: [💞] Ignore a discrepancy between file name and entity name
1644
1673
 
1645
1674
  /**
1646
1675
  * DELETE commitment definition
@@ -1762,9 +1791,7 @@ class DeleteCommitmentDefinition extends BaseCommitmentDefinition {
1762
1791
  return this.appendToSystemMessage(requirements, deleteSection, '\n\n');
1763
1792
  }
1764
1793
  }
1765
- /**
1766
- * Note: [💞] Ignore a discrepancy between file name and entity name
1767
- */
1794
+ // Note: [💞] Ignore a discrepancy between file name and entity name
1768
1795
 
1769
1796
  /**
1770
1797
  * DICTIONARY commitment definition
@@ -1868,9 +1895,7 @@ class DictionaryCommitmentDefinition extends BaseCommitmentDefinition {
1868
1895
  };
1869
1896
  }
1870
1897
  }
1871
- /**
1872
- * Note: [💞] Ignore a discrepancy between file name and entity name
1873
- */
1898
+ // Note: [💞] Ignore a discrepancy between file name and entity name
1874
1899
 
1875
1900
  /**
1876
1901
  * FORMAT commitment definition
@@ -1949,14 +1974,13 @@ class FormatCommitmentDefinition extends BaseCommitmentDefinition {
1949
1974
  return this.appendToSystemMessage(requirements, formatSection, '\n\n');
1950
1975
  }
1951
1976
  }
1952
- /**
1953
- * Note: [💞] Ignore a discrepancy between file name and entity name
1954
- */
1977
+ // Note: [💞] Ignore a discrepancy between file name and entity name
1955
1978
 
1956
1979
  /**
1957
1980
  * Orders JSON object by keys
1958
1981
  *
1959
1982
  * @returns The same type of object as the input re-ordered
1983
+ *
1960
1984
  * @public exported from `@promptbook/utils`
1961
1985
  */
1962
1986
  function orderJson(options) {
@@ -1975,6 +1999,7 @@ function orderJson(options) {
1975
1999
  * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
1976
2000
  *
1977
2001
  * @returns The same object as the input, but deeply frozen
2002
+ *
1978
2003
  * @public exported from `@promptbook/utils`
1979
2004
  */
1980
2005
  function $deepFreeze(objectValue) {
@@ -1991,9 +2016,7 @@ function $deepFreeze(objectValue) {
1991
2016
  Object.freeze(objectValue);
1992
2017
  return objectValue;
1993
2018
  }
1994
- /**
1995
- * TODO: [🧠] Is there a way how to meaningfully test this utility
1996
- */
2019
+ // TODO: [🧠] Is there a way how to meaningfully test this utility
1997
2020
 
1998
2021
  /**
1999
2022
  * This error type indicates that somewhere in the code non-Error object was thrown and it was wrapped into the `WrappedError`
@@ -2061,6 +2084,7 @@ function assertsError(whatWasThrown) {
2061
2084
  * - And much more...
2062
2085
  *
2063
2086
  * @throws UnexpectedError if the value is not serializable as JSON
2087
+ *
2064
2088
  * @public exported from `@promptbook/utils`
2065
2089
  */
2066
2090
  function checkSerializableAsJson(options) {
@@ -2175,11 +2199,9 @@ function checkSerializableAsJson(options) {
2175
2199
  `));
2176
2200
  }
2177
2201
  }
2178
- /**
2179
- * TODO: Can be return type more type-safe? like `asserts options.value is JsonValue`
2180
- * TODO: [🧠][main] !!3 In-memory cache of same values to prevent multiple checks
2181
- * Note: [🐠] This is how `checkSerializableAsJson` + `isSerializableAsJson` together can just retun true/false or rich error message
2182
- */
2202
+ // TODO: Can be return type more type-safe? like `asserts options.value is JsonValue`
2203
+ // TODO: [🧠][main] !!3 In-memory cache of same values to prevent multiple checks
2204
+ // Note: [🐠] This is how `checkSerializableAsJson` + `isSerializableAsJson` together can just retun true/false or rich error message
2183
2205
 
2184
2206
  /**
2185
2207
  * Creates a deep clone of the given object
@@ -2189,6 +2211,7 @@ function checkSerializableAsJson(options) {
2189
2211
  *
2190
2212
  * @param objectValue The object to clone.
2191
2213
  * @returns A deep, writable clone of the input object.
2214
+ *
2192
2215
  * @public exported from `@promptbook/utils`
2193
2216
  */
2194
2217
  function deepClone(objectValue) {
@@ -2205,9 +2228,7 @@ function deepClone(objectValue) {
2205
2228
  > return Object.assign({}, objectValue);
2206
2229
  */
2207
2230
  }
2208
- /**
2209
- * TODO: [🧠] Is there a way how to meaningfully test this utility
2210
- */
2231
+ // TODO: [🧠] Is there a way how to meaningfully test this utility
2211
2232
 
2212
2233
  /**
2213
2234
  * Utility to export a JSON object from a function
@@ -2220,6 +2241,7 @@ function deepClone(objectValue) {
2220
2241
  * Note: This function does not mutates the given object
2221
2242
  *
2222
2243
  * @returns The same type of object as the input but read-only and re-ordered
2244
+ *
2223
2245
  * @public exported from `@promptbook/utils`
2224
2246
  */
2225
2247
  function exportJson(options) {
@@ -2239,9 +2261,7 @@ function exportJson(options) {
2239
2261
  $deepFreeze(orderedValue);
2240
2262
  return orderedValue;
2241
2263
  }
2242
- /**
2243
- * TODO: [🧠] Is there a way how to meaningfully test this utility
2244
- */
2264
+ // TODO: [🧠] Is there a way how to meaningfully test this utility
2245
2265
 
2246
2266
  /**
2247
2267
  * Order of keys in the pipeline JSON
@@ -2352,9 +2372,7 @@ const LIMITS = {
2352
2372
  */
2353
2373
  SHORT_NAME_LENGTH: 6,
2354
2374
  };
2355
- /**
2356
- * Note: [💞] Ignore a discrepancy between file name and entity name
2357
- */
2375
+ // Note: [💞] Ignore a discrepancy between file name and entity name
2358
2376
 
2359
2377
  /**
2360
2378
  * Normalizes a given text to camelCase format.
@@ -2366,6 +2384,7 @@ const LIMITS = {
2366
2384
  * @returns The camelCase formatted string.
2367
2385
  * @example 'helloWorld'
2368
2386
  * @example 'iLovePromptbook'
2387
+ *
2369
2388
  * @public exported from `@promptbook/utils`
2370
2389
  */
2371
2390
  function normalizeTo_camelCase(text, _isFirstLetterCapital = false) {
@@ -2406,14 +2425,13 @@ function normalizeTo_camelCase(text, _isFirstLetterCapital = false) {
2406
2425
  }
2407
2426
  return normalizedName;
2408
2427
  }
2409
- /**
2410
- * TODO: [🌺] Use some intermediate util splitWords
2411
- */
2428
+ // TODO: [🌺] Use some intermediate util splitWords
2412
2429
 
2413
2430
  /**
2414
2431
  * Tests if given string is valid file path.
2415
2432
  *
2416
2433
  * Note: This does not check if the file exists only if the path is valid
2434
+ *
2417
2435
  * @public exported from `@promptbook/utils`
2418
2436
  */
2419
2437
  function isValidFilePath(filename) {
@@ -2462,9 +2480,7 @@ function isValidFilePath(filename) {
2462
2480
  }
2463
2481
  return false;
2464
2482
  }
2465
- /**
2466
- * TODO: [🍏] Implement for MacOs
2467
- */
2483
+ // TODO: [🍏] Implement for MacOs
2468
2484
 
2469
2485
  /**
2470
2486
  * Tests if given string is valid URL.
@@ -2497,6 +2513,9 @@ function isValidUrl(url) {
2497
2513
  }
2498
2514
  }
2499
2515
 
2516
+ /**
2517
+ * Collection of default diacritics removal map.
2518
+ */
2500
2519
  const defaultDiacriticsRemovalMap = [
2501
2520
  {
2502
2521
  base: 'A',
@@ -2748,6 +2767,7 @@ for (let i = 0; i < defaultDiacriticsRemovalMap.length; i++) {
2748
2767
  *
2749
2768
  * @param input The string containing diacritics to be normalized.
2750
2769
  * @returns The string with diacritics removed or normalized.
2770
+ *
2751
2771
  * @public exported from `@promptbook/utils`
2752
2772
  */
2753
2773
  function removeDiacritics(input) {
@@ -2756,9 +2776,7 @@ function removeDiacritics(input) {
2756
2776
  return DIACRITIC_VARIANTS_LETTERS[character] || character;
2757
2777
  });
2758
2778
  }
2759
- /**
2760
- * TODO: [Ж] Variant for cyrillic (and in general non-latin) letters
2761
- */
2779
+ // TODO: [Ж] Variant for cyrillic (and in general non-latin) letters
2762
2780
 
2763
2781
  /**
2764
2782
  * Converts a given text to kebab-case format.
@@ -2769,6 +2787,7 @@ function removeDiacritics(input) {
2769
2787
  * @returns The kebab-case formatted string.
2770
2788
  * @example 'hello-world'
2771
2789
  * @example 'i-love-promptbook'
2790
+ *
2772
2791
  * @public exported from `@promptbook/utils`
2773
2792
  */
2774
2793
  function normalizeToKebabCase(text) {
@@ -2809,9 +2828,7 @@ function normalizeToKebabCase(text) {
2809
2828
  normalizedName = normalizedName.replace(/-$/, '');
2810
2829
  return normalizedName;
2811
2830
  }
2812
- /**
2813
- * Note: [💞] Ignore a discrepancy between file name and entity name
2814
- */
2831
+ // Note: [💞] Ignore a discrepancy between file name and entity name
2815
2832
 
2816
2833
  /**
2817
2834
  * Removes emojis from a string and fix whitespaces
@@ -2820,6 +2837,7 @@ function normalizeToKebabCase(text) {
2820
2837
  *
2821
2838
  * @param text with emojis
2822
2839
  * @returns text without emojis
2840
+ *
2823
2841
  * @public exported from `@promptbook/utils`
2824
2842
  */
2825
2843
  function removeEmojis(text) {
@@ -2839,6 +2857,7 @@ function removeEmojis(text) {
2839
2857
  * @param value The title string to be converted to a name.
2840
2858
  * @returns A normalized name derived from the input title.
2841
2859
  * @example 'Hello World!' -> 'hello-world'
2860
+ *
2842
2861
  * @public exported from `@promptbook/utils`
2843
2862
  */
2844
2863
  function titleToName(value) {
@@ -2938,9 +2957,7 @@ class DatabaseError extends Error {
2938
2957
  Object.setPrototypeOf(this, DatabaseError.prototype);
2939
2958
  }
2940
2959
  }
2941
- /**
2942
- * TODO: [🐱‍🚀] Explain that NotFoundError ([🐱‍🚀] and other specific errors) has priority over DatabaseError in some contexts
2943
- */
2960
+ // TODO: [🐱‍🚀] Explain that NotFoundError ([🐱‍🚀] and other specific errors) has priority over DatabaseError in some contexts
2944
2961
 
2945
2962
  /**
2946
2963
  * This error type indicates that you try to use a feature that is not available in the current environment
@@ -2958,10 +2975,11 @@ class EnvironmentMismatchError extends Error {
2958
2975
  /**
2959
2976
  * This error occurs when some expectation is not met in the execution of the pipeline
2960
2977
  *
2961
- * @public exported from `@promptbook/core`
2962
2978
  * Note: Do not throw this error, its reserved for `checkExpectations` and `createPipelineExecutor` and public ONLY to be serializable through remote server
2963
2979
  * Note: Always thrown in `checkExpectations` and catched in `createPipelineExecutor` and rethrown as `PipelineExecutionError`
2964
2980
  * Note: This is a kindof subtype of PipelineExecutionError
2981
+ *
2982
+ * @public exported from `@promptbook/core`
2965
2983
  */
2966
2984
  class ExpectError extends Error {
2967
2985
  constructor(message) {
@@ -3076,9 +3094,7 @@ class ParseError extends Error {
3076
3094
  Object.setPrototypeOf(this, ParseError.prototype);
3077
3095
  }
3078
3096
  }
3079
- /**
3080
- * TODO: Maybe split `ParseError` and `ApplyError`
3081
- */
3097
+ // TODO: Maybe split `ParseError` and `ApplyError`
3082
3098
 
3083
3099
  /**
3084
3100
  * Generates random token
@@ -3086,16 +3102,15 @@ class ParseError extends Error {
3086
3102
  * Note: `$` is used to indicate that this function is not a pure function - it is not deterministic
3087
3103
  * Note: This function is cryptographically secure (it uses crypto.randomBytes internally)
3088
3104
  *
3089
- * @private internal helper function
3090
3105
  * @returns secure random token
3106
+ *
3107
+ * @private internal helper function
3091
3108
  */
3092
3109
  function $randomToken(randomness) {
3093
3110
  return randomBytes(randomness).toString('hex');
3094
3111
  }
3095
- /**
3096
- * TODO: [🤶] Maybe export through `@promptbook/utils` or `@promptbook/random` package
3097
- * TODO: Maybe use nanoid instead https://github.com/ai/nanoid
3098
- */
3112
+ // TODO: [🤶] Maybe export through `@promptbook/utils` or `@promptbook/random` package
3113
+ // TODO: Maybe use nanoid instead https://github.com/ai/nanoid
3099
3114
 
3100
3115
  /**
3101
3116
  * This error indicates errors during the execution of the pipeline
@@ -3112,9 +3127,7 @@ class PipelineExecutionError extends Error {
3112
3127
  Object.setPrototypeOf(this, PipelineExecutionError.prototype);
3113
3128
  }
3114
3129
  }
3115
- /**
3116
- * TODO: [🧠][🌂] Add id to all errors
3117
- */
3130
+ // TODO: [🧠][🌂] Add id to all errors
3118
3131
 
3119
3132
  /**
3120
3133
  * This error indicates that the promptbook object has valid syntax (=can be parsed) but contains logical errors (like circular dependencies)
@@ -3216,9 +3229,7 @@ const ALL_ERRORS = {
3216
3229
  ...PROMPTBOOK_ERRORS,
3217
3230
  ...COMMON_JAVASCRIPT_ERRORS,
3218
3231
  };
3219
- /**
3220
- * Note: [💞] Ignore a discrepancy between file name and entity name
3221
- */
3232
+ // Note: [💞] Ignore a discrepancy between file name and entity name
3222
3233
 
3223
3234
  /**
3224
3235
  * Deserializes the error object
@@ -3281,8 +3292,9 @@ function serializeError(error) {
3281
3292
  * @param array - Array to iterate over
3282
3293
  * @param options - Options for the function
3283
3294
  * @param callbackfunction - Function to call for each item
3284
- * @public exported from `@promptbook/utils`
3285
3295
  * @deprecated [🪂] Use queues instead
3296
+ *
3297
+ * @public exported from `@promptbook/utils`
3286
3298
  */
3287
3299
  async function forEachAsync(array, options, callbackfunction) {
3288
3300
  const { maxParallelCount = Infinity } = options;
@@ -3441,8 +3453,8 @@ function numberToString(value) {
3441
3453
  * This is useful and used in the `templateParameters` function
3442
3454
  *
3443
3455
  * Note: This function is not just calling `toString` method
3444
- * It's more complex and can handle this conversion specifically for LLM models
3445
- * See `VALUE_STRINGS`
3456
+ * It's more complex and can handle this conversion specifically for LLM models
3457
+ * See `VALUE_STRINGS`
3446
3458
  *
3447
3459
  * Note: There are 2 similar functions
3448
3460
  * - `valueToString` converts value to string for LLM models as human-readable string
@@ -3493,12 +3505,13 @@ function valueToString(value) {
3493
3505
  * Replaces parameters in template with values from parameters object
3494
3506
  *
3495
3507
  * Note: This function is not places strings into string,
3496
- * It's more complex and can handle this operation specifically for LLM models
3508
+ * It's more complex and can handle this operation specifically for LLM models
3497
3509
  *
3498
3510
  * @param template the template with parameters in {curly} braces
3499
3511
  * @param parameters the object with parameters
3500
3512
  * @returns the template with replaced parameters
3501
3513
  * @throws {PipelineExecutionError} if parameter is not defined, not closed, or not opened
3514
+ *
3502
3515
  * @public exported from `@promptbook/utils`
3503
3516
  */
3504
3517
  function templateParameters(template, parameters) {
@@ -3582,6 +3595,7 @@ const PROMPT_PARAMETER_ESCAPE_WITH_BRACES_PATTERN = /[{}$`]/g;
3582
3595
  * Normalizes a JSON string so it can be safely rendered without double escaping.
3583
3596
  *
3584
3597
  * @param value Candidate JSON string.
3598
+ *
3585
3599
  * @private function of ParameterEscaping
3586
3600
  */
3587
3601
  function normalizeJsonString(value) {
@@ -3596,6 +3610,7 @@ function normalizeJsonString(value) {
3596
3610
  * Hides brackets in a string to avoid confusion with template parameters.
3597
3611
  *
3598
3612
  * @param value Input string with literal brackets.
3613
+ *
3599
3614
  * @private function of ParameterEscaping
3600
3615
  */
3601
3616
  function hideBrackets(value) {
@@ -3605,6 +3620,7 @@ function hideBrackets(value) {
3605
3620
  * Restores hidden brackets.
3606
3621
  *
3607
3622
  * @param value String with hidden brackets.
3623
+ *
3608
3624
  * @private function of ParameterEscaping
3609
3625
  */
3610
3626
  function restoreBrackets(value) {
@@ -3614,6 +3630,7 @@ function restoreBrackets(value) {
3614
3630
  * Decides whether a parameter can be inlined safely.
3615
3631
  *
3616
3632
  * @param value Parameter rendered as string.
3633
+ *
3617
3634
  * @private function of ParameterEscaping
3618
3635
  */
3619
3636
  function shouldInlineParameterValue(value) {
@@ -3627,6 +3644,7 @@ function shouldInlineParameterValue(value) {
3627
3644
  *
3628
3645
  * @param value Parameter value to escape.
3629
3646
  * @param options Escape options for additional characters.
3647
+ *
3630
3648
  * @private function of ParameterEscaping
3631
3649
  */
3632
3650
  function escapePromptParameterValue(value, options) {
@@ -3652,6 +3670,7 @@ const ParameterEscaping = {
3652
3670
  * Builds numeric parameter names (1, 2, ...).
3653
3671
  *
3654
3672
  * @param index Zero-based parameter index.
3673
+ *
3655
3674
  * @private function of ParameterNaming
3656
3675
  */
3657
3676
  function buildNumericParameterName(index) {
@@ -3661,6 +3680,7 @@ function buildNumericParameterName(index) {
3661
3680
  * Builds alphabetic parameter names (a, b, ..., aa).
3662
3681
  *
3663
3682
  * @param index Zero-based parameter index.
3683
+ *
3664
3684
  * @private function of ParameterNaming
3665
3685
  */
3666
3686
  function buildAlphabeticParameterName(index) {
@@ -3677,6 +3697,7 @@ function buildAlphabeticParameterName(index) {
3677
3697
  * Converts a positive integer into a Roman numeral string.
3678
3698
  *
3679
3699
  * @param value Positive integer value.
3700
+ *
3680
3701
  * @private function of ParameterNaming
3681
3702
  */
3682
3703
  function toRomanNumeral(value) {
@@ -3709,6 +3730,7 @@ function toRomanNumeral(value) {
3709
3730
  * Builds Roman numeral parameter names (I, II, ...).
3710
3731
  *
3711
3732
  * @param index Zero-based parameter index.
3733
+ *
3712
3734
  * @private function of ParameterNaming
3713
3735
  */
3714
3736
  function buildRomanParameterName(index) {
@@ -3719,6 +3741,7 @@ function buildRomanParameterName(index) {
3719
3741
  *
3720
3742
  * @param prefix Prefix string.
3721
3743
  * @param builder Base builder function.
3744
+ *
3722
3745
  * @private function of ParameterNaming
3723
3746
  */
3724
3747
  function buildPrefixedParameterName(prefix, builder) {
@@ -3740,6 +3763,7 @@ const PARAMETER_NAME_STRATEGIES = [
3740
3763
  * Collects bracketed tokens from parameter values to avoid placeholder collisions.
3741
3764
  *
3742
3765
  * @param values Parameter values to scan.
3766
+ *
3743
3767
  * @private function of ParameterNaming
3744
3768
  */
3745
3769
  function collectBracketedParameterTokens(values) {
@@ -3760,6 +3784,7 @@ function collectBracketedParameterTokens(values) {
3760
3784
  * Builds placeholder names while avoiding collisions with parameter content.
3761
3785
  *
3762
3786
  * @param values Parameter values to scan for conflicting tokens.
3787
+ *
3763
3788
  * @private function of ParameterNaming
3764
3789
  */
3765
3790
  function buildParameterNames(values) {
@@ -3790,6 +3815,7 @@ const ParameterNaming = {
3790
3815
  * Formats the placeholder used in the prompt body for a parameter.
3791
3816
  *
3792
3817
  * @param name Parameter placeholder name.
3818
+ *
3793
3819
  * @private function of ParameterSection
3794
3820
  */
3795
3821
  function formatParameterPlaceholder(name) {
@@ -3799,6 +3825,7 @@ function formatParameterPlaceholder(name) {
3799
3825
  * Formats a single line entry for structured parameters.
3800
3826
  *
3801
3827
  * @param item Parameter entry data.
3828
+ *
3802
3829
  * @private function of ParameterSection
3803
3830
  */
3804
3831
  function formatParameterListItem(item) {
@@ -3810,6 +3837,7 @@ function formatParameterListItem(item) {
3810
3837
  * Builds the structured parameters section appended to the prompt.
3811
3838
  *
3812
3839
  * @param items Parameter entries to include.
3840
+ *
3813
3841
  * @private function of ParameterSection
3814
3842
  */
3815
3843
  function buildParametersSection(items) {
@@ -3885,6 +3913,7 @@ function isPromptString(value) {
3885
3913
  * @param strings
3886
3914
  * @param values
3887
3915
  * @returns prompt content wrapped as a PromptString
3916
+ *
3888
3917
  * @public exported from `@promptbook/utils`
3889
3918
  */
3890
3919
  function prompt(strings, ...values) {
@@ -3969,11 +3998,9 @@ function prompt(strings, ...values) {
3969
3998
  }
3970
3999
  return new PromptString(pipelineString);
3971
4000
  }
3972
- /**
3973
- * TODO: Maybe split into multiple files
3974
- * TODO: [🧠][🈴] Where is the best location for this file
3975
- * Note: [💞] Ignore a discrepancy between file name and entity name
3976
- */
4001
+ // TODO: Maybe split into multiple files
4002
+ // TODO: [🧠][🈴] Where is the best location for this file
4003
+ // Note: [💞] Ignore a discrepancy between file name and entity name
3977
4004
 
3978
4005
  /**
3979
4006
  * @@@
@@ -4010,9 +4037,7 @@ function attachClientVersionHeader(headers) {
4010
4037
  [CLIENT_VERSION_HEADER]: CLIENT_LATEST_VERSION,
4011
4038
  };
4012
4039
  }
4013
- /**
4014
- * Note: [💞] Ignore a discrepancy between file name and entity name
4015
- */
4040
+ // Note: [💞] Ignore a discrepancy between file name and entity name
4016
4041
 
4017
4042
  /**
4018
4043
  * Detects if the code is running in a browser environment in main thread (Not in a web worker)
@@ -4029,9 +4054,7 @@ function $isRunningInBrowser() {
4029
4054
  return false;
4030
4055
  }
4031
4056
  }
4032
- /**
4033
- * TODO: [🎺]
4034
- */
4057
+ // TODO: [🎺]
4035
4058
 
4036
4059
  /**
4037
4060
  * Detects if the code is running in a web worker
@@ -4051,9 +4074,7 @@ function $isRunningInWebWorker() {
4051
4074
  return false;
4052
4075
  }
4053
4076
  }
4054
- /**
4055
- * TODO: [🎺]
4056
- */
4077
+ // TODO: [🎺]
4057
4078
 
4058
4079
  /**
4059
4080
  * Number of characters per standard line with 11pt Arial font size.
@@ -4067,10 +4088,8 @@ const CHARACTERS_PER_STANDARD_LINE = 63;
4067
4088
  * @public exported from `@promptbook/utils`
4068
4089
  */
4069
4090
  const LINES_PER_STANDARD_PAGE = 44;
4070
- /**
4071
- * TODO: [🧠] Should be this `constants.ts` or `config.ts`?
4072
- * Note: [💞] Ignore a discrepancy between file name and entity name
4073
- */
4091
+ // TODO: [🧠] Should be this `constants.ts` or `config.ts`?
4092
+ // Note: [💞] Ignore a discrepancy between file name and entity name
4074
4093
 
4075
4094
  /**
4076
4095
  * Counts number of characters in the text
@@ -4086,10 +4105,8 @@ function countCharacters(text) {
4086
4105
  text = text.replace(/\p{Extended_Pictographic}(\u{200D}\p{Extended_Pictographic})*/gu, '-');
4087
4106
  return text.length;
4088
4107
  }
4089
- /**
4090
- * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
4091
- * TODO: [🧠][✌️] Make some Promptbook-native token system
4092
- */
4108
+ // TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
4109
+ // TODO: [🧠][✌️] Make some Promptbook-native token system
4093
4110
 
4094
4111
  /**
4095
4112
  * Counts number of lines in the text
@@ -4107,10 +4124,8 @@ function countLines(text) {
4107
4124
  const lines = text.split(/\r?\n/);
4108
4125
  return lines.reduce((count, line) => count + Math.max(Math.ceil(line.length / CHARACTERS_PER_STANDARD_LINE), 1), 0);
4109
4126
  }
4110
- /**
4111
- * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
4112
- * TODO: [🧠][✌️] Make some Promptbook-native token system
4113
- */
4127
+ // TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
4128
+ // TODO: [🧠][✌️] Make some Promptbook-native token system
4114
4129
 
4115
4130
  /**
4116
4131
  * Counts number of pages in the text
@@ -4122,10 +4137,8 @@ function countLines(text) {
4122
4137
  function countPages(text) {
4123
4138
  return Math.ceil(countLines(text) / LINES_PER_STANDARD_PAGE);
4124
4139
  }
4125
- /**
4126
- * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
4127
- * TODO: [🧠][✌️] Make some Promptbook-native token system
4128
- */
4140
+ // TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
4141
+ // TODO: [🧠][✌️] Make some Promptbook-native token system
4129
4142
 
4130
4143
  /**
4131
4144
  * Counts number of paragraphs in the text
@@ -4135,10 +4148,8 @@ function countPages(text) {
4135
4148
  function countParagraphs(text) {
4136
4149
  return text.split(/\n\s*\n/).filter((paragraph) => paragraph.trim() !== '').length;
4137
4150
  }
4138
- /**
4139
- * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
4140
- * TODO: [🧠][✌️] Make some Promptbook-native token system
4141
- */
4151
+ // TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
4152
+ // TODO: [🧠][✌️] Make some Promptbook-native token system
4142
4153
 
4143
4154
  /**
4144
4155
  * Split text into sentences
@@ -4156,10 +4167,8 @@ function splitIntoSentences(text) {
4156
4167
  function countSentences(text) {
4157
4168
  return splitIntoSentences(text).length;
4158
4169
  }
4159
- /**
4160
- * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
4161
- * TODO: [🧠][✌️] Make some Promptbook-native token system
4162
- */
4170
+ // TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
4171
+ // TODO: [🧠][✌️] Make some Promptbook-native token system
4163
4172
 
4164
4173
  /**
4165
4174
  * Counts number of words in the text
@@ -4173,11 +4182,9 @@ function countWords(text) {
4173
4182
  text = text.replace(/([a-z])([A-Z])/g, '$1 $2');
4174
4183
  return text.split(/[^a-zа-я0-9]+/i).filter((word) => word.length > 0).length;
4175
4184
  }
4176
- /**
4177
- * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
4178
- * TODO: [🧠][✌️] Make some Promptbook-native token system
4179
- * TODO: [✌️] `countWords` should be just `splitWords(...).length`, and all other counters should use this pattern as well
4180
- */
4185
+ // TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
4186
+ // TODO: [🧠][✌️] Make some Promptbook-native token system
4187
+ // TODO: [✌️] `countWords` should be just `splitWords(...).length`, and all other counters should use this pattern as well
4181
4188
 
4182
4189
  /**
4183
4190
  * Index of all counter functions
@@ -4192,10 +4199,8 @@ const CountUtils = {
4192
4199
  LINES: countLines,
4193
4200
  PAGES: countPages,
4194
4201
  };
4195
- /**
4196
- * TODO: [🧠][🤠] This should be probably as part of `TextFormatParser`
4197
- * Note: [💞] Ignore a discrepancy between file name and entity name
4198
- */
4202
+ // TODO: [🧠][🤠] This should be probably as part of `TextFormatParser`
4203
+ // Note: [💞] Ignore a discrepancy between file name and entity name
4199
4204
 
4200
4205
  /**
4201
4206
  * Computes SHA-256 hash of the given object
@@ -4205,9 +4210,7 @@ const CountUtils = {
4205
4210
  function computeHash(value) {
4206
4211
  return SHA256(hexEncoder.parse(spaceTrim$1(valueToString(value)))).toString( /* hex */);
4207
4212
  }
4208
- /**
4209
- * TODO: [🥬][🥬] Use this ACRY
4210
- */
4213
+ // TODO: [🥬][🥬] Use this ACRY
4211
4214
 
4212
4215
  /**
4213
4216
  * Makes first letter of a string uppercase
@@ -4384,6 +4387,9 @@ const ADJECTIVES$1 = [
4384
4387
  'prvotní',
4385
4388
  'hbitý',
4386
4389
  ];
4390
+ /**
4391
+ * Collection of nouns.
4392
+ */
4387
4393
  const NOUNS$1 = [
4388
4394
  'jablko',
4389
4395
  'nebe',
@@ -4597,6 +4603,9 @@ const NOUNS$1 = [
4597
4603
  'okno',
4598
4604
  'chodba',
4599
4605
  ];
4606
+ /**
4607
+ * Collection of verbs.
4608
+ */
4600
4609
  const VERBS$1 = [
4601
4610
  'skáče',
4602
4611
  'tančí',
@@ -4769,9 +4778,7 @@ const LINGUISTIC_HASH_WORD_LISTS_CS = {
4769
4778
  noun: NOUNS$1,
4770
4779
  verb: VERBS$1,
4771
4780
  };
4772
- /**
4773
- * Note: [💞] Ignore a discrepancy between file name and entity name
4774
- */
4781
+ // Note: [💞] Ignore a discrepancy between file name and entity name
4775
4782
 
4776
4783
  /**
4777
4784
  * @@@
@@ -5027,6 +5034,9 @@ const ADJECTIVES = [
5027
5034
  'macro',
5028
5035
  'mini',
5029
5036
  ];
5037
+ /**
5038
+ * Collection of nouns.
5039
+ */
5030
5040
  const NOUNS = [
5031
5041
  'apple',
5032
5042
  'sky',
@@ -5266,6 +5276,9 @@ const NOUNS = [
5266
5276
  'roof',
5267
5277
  'floor',
5268
5278
  ];
5279
+ /**
5280
+ * Collection of verbs.
5281
+ */
5269
5282
  const VERBS = [
5270
5283
  'jumping',
5271
5284
  'dancing',
@@ -5461,9 +5474,7 @@ const LINGUISTIC_HASH_WORD_LISTS_EN = {
5461
5474
  noun: NOUNS,
5462
5475
  verb: VERBS,
5463
5476
  };
5464
- /**
5465
- * Note: [💞] Ignore a discrepancy between file name and entity name
5466
- */
5477
+ // Note: [💞] Ignore a discrepancy between file name and entity name
5467
5478
 
5468
5479
  /**
5469
5480
  * Default language used for linguistic hashes.
@@ -5638,8 +5649,9 @@ function normalizeLinguisticHashWordCount(wordCount) {
5638
5649
  /**
5639
5650
  * Creates a human-readable hash as a short, story-like phrase.
5640
5651
  *
5641
- * @param wordCount how many words to include (defaults to {@link DEFAULT_LINGUISTIC_HASH_WORD_COUNT}, clamped to
5642
5652
  * {@link MIN_LINGUISTIC_HASH_WORD_COUNT}..{@link MAX_LINGUISTIC_HASH_WORD_COUNT})
5653
+ *
5654
+ * @param wordCount how many words to include (defaults to {@link DEFAULT_LINGUISTIC_HASH_WORD_COUNT}, clamped to
5643
5655
  * @param language optional language code (defaults to {@link DEFAULT_LINGUISTIC_HASH_LANGUAGE})
5644
5656
  *
5645
5657
  * @public exported from `@promptbook/utils`
@@ -5658,6 +5670,7 @@ async function linguisticHash(input, wordCount, language) {
5658
5670
  * Note: `$` is used to indicate that this function is not a pure function - it is not deterministic because it depends on the current time
5659
5671
  *
5660
5672
  * @returns string_date branded type
5673
+ *
5661
5674
  * @public exported from `@promptbook/utils`
5662
5675
  */
5663
5676
  function $getCurrentDate() {
@@ -5673,6 +5686,7 @@ function $getCurrentDate() {
5673
5686
  * @returns The normalized text in SCREAMING_CASE format.
5674
5687
  * @example 'HELLO_WORLD'
5675
5688
  * @example 'I_LOVE_PROMPTBOOK'
5689
+ *
5676
5690
  * @public exported from `@promptbook/utils`
5677
5691
  */
5678
5692
  function normalizeTo_SCREAMING_CASE(text) {
@@ -5742,6 +5756,7 @@ function normalizeMessageText(text) {
5742
5756
  * @returns The normalized text in snake_case format.
5743
5757
  * @example 'hello_world'
5744
5758
  * @example 'i_love_promptbook'
5759
+ *
5745
5760
  * @public exported from `@promptbook/utils`
5746
5761
  */
5747
5762
  function normalizeTo_snake_case(text) {
@@ -5770,6 +5785,7 @@ function normalizeWhitespaces(sentence) {
5770
5785
  *
5771
5786
  * @param text optionally quoted text
5772
5787
  * @returns text without quotes
5788
+ *
5773
5789
  * @public exported from `@promptbook/utils`
5774
5790
  */
5775
5791
  function unwrapResult(text, options) {
@@ -5844,15 +5860,14 @@ function unwrapResult(text, options) {
5844
5860
  return processedText;
5845
5861
  }
5846
5862
  }
5847
- /**
5848
- * TODO: [🧠] Should this also unwrap the (parenthesis)
5849
- */
5863
+ // TODO: [🧠] Should this also unwrap the (parenthesis)
5850
5864
 
5851
5865
  /**
5852
5866
  * Parses the task and returns the list of all parameter names
5853
5867
  *
5854
5868
  * @param template the string template with parameters in {curly} braces
5855
5869
  * @returns the list of parameter names
5870
+ *
5856
5871
  * @public exported from `@promptbook/utils`
5857
5872
  */
5858
5873
  function extractParameterNames(template) {
@@ -5882,7 +5897,6 @@ function extractParameterNames(template) {
5882
5897
  * - `Symbol` objects are not serializable
5883
5898
  * - And much more...
5884
5899
  *
5885
- *
5886
5900
  * @public exported from `@promptbook/utils`
5887
5901
  */
5888
5902
  function isSerializableAsJson(value) {
@@ -5894,14 +5908,12 @@ function isSerializableAsJson(value) {
5894
5908
  return false;
5895
5909
  }
5896
5910
  }
5897
- /**
5898
- * TODO: [🧠][main] !!3 In-memory cache of same values to prevent multiple checks
5899
- * TODO: [🧠][💺] Can be done this on type-level?
5900
- */
5911
+ // TODO: [🧠][main] !!3 In-memory cache of same values to prevent multiple checks
5912
+ // TODO: [🧠][💺] Can be done this on type-level?
5901
5913
 
5902
5914
  /**
5903
5915
  * Recursively converts JSON strings to JSON objects
5904
-
5916
+ *
5905
5917
  * @public exported from `@promptbook/utils`
5906
5918
  */
5907
5919
  function jsonStringsToJsons(object) {
@@ -5925,14 +5937,13 @@ function jsonStringsToJsons(object) {
5925
5937
  }
5926
5938
  return newObject;
5927
5939
  }
5928
- /**
5929
- * TODO: Type the return type correctly
5930
- */
5940
+ // TODO: Type the return type correctly
5931
5941
 
5932
5942
  /**
5933
5943
  * Create difference set of two sets.
5934
5944
  *
5935
5945
  * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
5946
+ *
5936
5947
  * @public exported from `@promptbook/utils`
5937
5948
  */
5938
5949
  function difference(a, b, isEqual = (a, b) => a === b) {
@@ -5944,14 +5955,13 @@ function difference(a, b, isEqual = (a, b) => a === b) {
5944
5955
  }
5945
5956
  return diff;
5946
5957
  }
5947
- /**
5948
- * TODO: [🧠][💯] Maybe also implement symmetricDifference
5949
- */
5958
+ // TODO: [🧠][💯] Maybe also implement symmetricDifference
5950
5959
 
5951
5960
  /**
5952
5961
  * Creates a new set with all elements that are present in either set
5953
5962
  *
5954
5963
  * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
5964
+ *
5955
5965
  * @public exported from `@promptbook/utils`
5956
5966
  */
5957
5967
  function union(...sets) {
@@ -6002,12 +6012,13 @@ function isValidSemanticVersion(version) {
6002
6012
  * Tests if given string is valid promptbook version
6003
6013
  * It looks into list of known promptbook versions.
6004
6014
  *
6005
- * @see https://www.npmjs.com/package/promptbook?activeTab=versions
6006
6015
  * Note: When you are using for example promptbook 2.0.0 and there already is promptbook 3.0.0 it don`t know about it.
6007
6016
  * Note: There are two similar functions:
6008
6017
  * - `isValidSemanticVersion` which tests any semantic version
6009
6018
  * - `isValidPromptbookVersion` *(this one)* which tests just Promptbook versions
6010
6019
  *
6020
+ * @see https://www.npmjs.com/package/promptbook?activeTab=versions
6021
+ *
6011
6022
  * @public exported from `@promptbook/utils`
6012
6023
  */
6013
6024
  function isValidPromptbookVersion(version) {
@@ -6065,6 +6076,7 @@ function isHostnameOnPrivateNetwork(hostname, options = {}) {
6065
6076
  * @param {string} url - The URL to check.
6066
6077
  * @param {IsUrlOnPrivateNetworkOptions} options - Options for the check.
6067
6078
  * @returns {boolean} Returns true if the IP address is reserved for private networks or localhost, otherwise false.
6079
+ *
6068
6080
  * @public exported from `@promptbook/utils`
6069
6081
  */
6070
6082
  function isUrlOnPrivateNetwork(url, options = {}) {
@@ -6103,9 +6115,7 @@ function isValidAgentUrl(url) {
6103
6115
  */
6104
6116
  return true;
6105
6117
  }
6106
- /**
6107
- * TODO: [🐠] Maybe more info why the URL is invalid
6108
- */
6118
+ // TODO: [🐠] Maybe more info why the URL is invalid
6109
6119
 
6110
6120
  /**
6111
6121
  * Tests if given string is valid pipeline URL URL.
@@ -6136,10 +6146,11 @@ function isValidPipelineUrl(url) {
6136
6146
  */
6137
6147
  return true;
6138
6148
  }
6149
+ // TODO: [🐠] Maybe more info why the URL is invalid
6150
+
6139
6151
  /**
6140
- * TODO: [🐠] Maybe more info why the URL is invalid
6152
+ * Collection of firstnames.
6141
6153
  */
6142
-
6143
6154
  const FIRSTNAMES = [
6144
6155
  'Paul',
6145
6156
  'George',
@@ -6176,6 +6187,9 @@ const FIRSTNAMES = [
6176
6187
  'Anthony',
6177
6188
  'Christopher',
6178
6189
  ];
6190
+ /**
6191
+ * Collection of lastnames with colors.
6192
+ */
6179
6193
  const LASTNAMES_WITH_COLORS = [
6180
6194
  { lastname: 'Green', color: '#008000' },
6181
6195
  { lastname: 'Brown', color: '#A52A2A' },
@@ -6203,6 +6217,7 @@ function pickDeterministicItem(hash, startIndex, list) {
6203
6217
  *
6204
6218
  * @param seed - Input seed used to derive a stable pseudonym.
6205
6219
  * @returns Deterministic English full name with color metadata.
6220
+ *
6206
6221
  * @private internal helper for deterministic pseudonym generation
6207
6222
  */
6208
6223
  function generateDeterministicEnglishName(seed) {
@@ -6244,6 +6259,9 @@ const VOID_PSEUDO_AGENT_ALIAS_KEYS = ['void', 'null', 'none', 'nil'];
6244
6259
  * Legacy aliases that historically behaved like `FROM VOID`.
6245
6260
  */
6246
6261
  const LEGACY_VOID_ALIASES = new Set(VOID_PSEUDO_AGENT_ALIAS_KEYS);
6262
+ /**
6263
+ * Constant for void alias entries.
6264
+ */
6247
6265
  const VOID_ALIAS_ENTRIES = VOID_PSEUDO_AGENT_ALIAS_KEYS.map((alias) => [
6248
6266
  alias,
6249
6267
  'VOID',
@@ -6292,6 +6310,7 @@ function normalizePseudoReferenceKey(rawReference) {
6292
6310
  *
6293
6311
  * @param rawReference - Raw reference token or payload.
6294
6312
  * @returns Pseudo-agent kind or `null` when the reference is not pseudo.
6313
+ *
6295
6314
  * @private internal utility of pseudo-agent resolution
6296
6315
  */
6297
6316
  function resolvePseudoAgentKindFromReference(rawReference) {
@@ -6306,6 +6325,7 @@ function resolvePseudoAgentKindFromReference(rawReference) {
6306
6325
  *
6307
6326
  * @param agentUrl - URL to inspect.
6308
6327
  * @returns Pseudo-agent kind or `null` when the URL is not pseudo.
6328
+ *
6309
6329
  * @private internal utility of pseudo-agent resolution
6310
6330
  */
6311
6331
  function resolvePseudoAgentKindFromUrl(agentUrl) {
@@ -6326,6 +6346,7 @@ function resolvePseudoAgentKindFromUrl(agentUrl) {
6326
6346
  *
6327
6347
  * @param teamCommitmentContent - TEAM commitment content after reference resolution.
6328
6348
  * @returns Deterministic English full name representing pseudo-user in that TEAM context.
6349
+ *
6329
6350
  * @private internal utility of TEAM commitment rendering
6330
6351
  */
6331
6352
  function createPseudoUserTeammateLabel(teamCommitmentContent) {
@@ -6341,6 +6362,7 @@ function createPseudoUserTeammateLabel(teamCommitmentContent) {
6341
6362
  *
6342
6363
  * @param rawReference - Raw reference content.
6343
6364
  * @returns True when the reference maps to void.
6365
+ *
6344
6366
  * @private internal utility of pseudo-agent resolution
6345
6367
  */
6346
6368
  function isVoidPseudoAgentReference(rawReference) {
@@ -6354,9 +6376,7 @@ function isVoidPseudoAgentReference(rawReference) {
6354
6376
  const normalizedReference = normalizePseudoReferenceKey(rawReference);
6355
6377
  return LEGACY_VOID_ALIASES.has(normalizedReference);
6356
6378
  }
6357
- /**
6358
- * Note: [💞] Ignore a discrepancy between file name and entity name
6359
- */
6379
+ // Note: [💞] Ignore a discrepancy between file name and entity name
6360
6380
 
6361
6381
  /**
6362
6382
  * FROM commitment definition
@@ -6435,9 +6455,7 @@ class FromCommitmentDefinition extends BaseCommitmentDefinition {
6435
6455
  };
6436
6456
  }
6437
6457
  }
6438
- /**
6439
- * Note: [💞] Ignore a discrepancy between file name and entity name
6440
- */
6458
+ // Note: [💞] Ignore a discrepancy between file name and entity name
6441
6459
 
6442
6460
  /**
6443
6461
  * GOAL commitment definition
@@ -6535,9 +6553,7 @@ class GoalCommitmentDefinition extends BaseCommitmentDefinition {
6535
6553
  return this.appendToPromptSuffix(requirementsWithGoal, goalSection);
6536
6554
  }
6537
6555
  }
6538
- /**
6539
- * Note: [💞] Ignore a discrepancy between file name and entity name
6540
- */
6556
+ // Note: [💞] Ignore a discrepancy between file name and entity name
6541
6557
 
6542
6558
  /**
6543
6559
  * IMPORT commitment definition
@@ -6616,19 +6632,26 @@ class ImportCommitmentDefinition extends BaseCommitmentDefinition {
6616
6632
  `));
6617
6633
  }
6618
6634
  }
6635
+ // Note: [💞] Ignore a discrepancy between file name and entity name
6636
+
6619
6637
  /**
6620
- * Note: [💞] Ignore a discrepancy between file name and entity name
6638
+ * Matches URL-like candidates inside arbitrary text.
6639
+ *
6640
+ * @private
6621
6641
  */
6622
-
6623
- /** @private Matches URL-like candidates inside arbitrary text. */
6624
6642
  const URL_CANDIDATE_PATTERN = /https?:\/\/[^\s<>"'`]+/g;
6625
- /** @private Trims punctuation that commonly trails URLs in prose. */
6643
+ /**
6644
+ * Trims punctuation that commonly trails URLs in prose.
6645
+ *
6646
+ * @private
6647
+ */
6626
6648
  const TRAILING_PUNCTUATION_PATTERN = /[.,!?;:'"`]+$/;
6627
6649
  /**
6628
6650
  * Extracts all valid URLs from arbitrary text while removing common trailing punctuation.
6629
6651
  *
6630
6652
  * @param text - Input text that may contain one or more URLs.
6631
6653
  * @returns Unique URLs in their first-seen order.
6654
+ *
6632
6655
  * @private utility of KNOWLEDGE parsing
6633
6656
  */
6634
6657
  function extractUrlsFromText(text) {
@@ -6658,7 +6681,9 @@ function extractUrlsFromText(text) {
6658
6681
  return urls;
6659
6682
  }
6660
6683
  /**
6661
- * @private Normalizes one extracted URL candidate by stripping trailing punctuation and unmatched closing wrappers.
6684
+ * Normalizes one extracted URL candidate by stripping trailing punctuation and unmatched closing wrappers.
6685
+ *
6686
+ * @private
6662
6687
  */
6663
6688
  function normalizeUrlCandidate(candidate) {
6664
6689
  let normalized = candidate.trim();
@@ -6678,7 +6703,9 @@ function normalizeUrlCandidate(candidate) {
6678
6703
  return normalized;
6679
6704
  }
6680
6705
  /**
6681
- * @private Removes trailing closing wrappers when they are unmatched in the candidate.
6706
+ * Removes trailing closing wrappers when they are unmatched in the candidate.
6707
+ *
6708
+ * @private
6682
6709
  */
6683
6710
  function stripTrailingUnmatchedClosing(candidate, openingChar, closingChar) {
6684
6711
  let normalized = candidate;
@@ -6693,7 +6720,9 @@ function stripTrailingUnmatchedClosing(candidate, openingChar, closingChar) {
6693
6720
  return normalized;
6694
6721
  }
6695
6722
  /**
6696
- * @private Counts character occurrences in a string.
6723
+ * Counts character occurrences in a string.
6724
+ *
6725
+ * @private
6697
6726
  */
6698
6727
  function countOccurrences(value, searchedChar) {
6699
6728
  let count = 0;
@@ -6705,14 +6734,28 @@ function countOccurrences(value, searchedChar) {
6705
6734
  return count;
6706
6735
  }
6707
6736
 
6708
- /** @private The default base name for inline knowledge files when the content lacks identifying text */
6737
+ /**
6738
+ * The default base name for inline knowledge files when the content lacks identifying text.
6739
+ *
6740
+ * @private
6741
+ */
6709
6742
  const INLINE_KNOWLEDGE_BASE_NAME = 'inline-knowledge';
6710
- /** @private The default file extension used for inline knowledge uploads */
6743
+ /**
6744
+ * The default file extension used for inline knowledge uploads.
6745
+ *
6746
+ * @private
6747
+ */
6711
6748
  const INLINE_KNOWLEDGE_EXTENSION = '.txt';
6712
- /** @private Prefix that identifies base64 data URLs */
6749
+ /**
6750
+ * Prefix that identifies base64 data URLs.
6751
+ *
6752
+ * @private
6753
+ */
6713
6754
  const DATA_URL_PREFIX = 'data:';
6714
6755
  /**
6715
- * @private Retrieves the first meaningful line from the inline content.
6756
+ * Retrieves the first meaningful line from the inline content.
6757
+ *
6758
+ * @private
6716
6759
  */
6717
6760
  function getFirstNonEmptyLine(content) {
6718
6761
  const lines = content.split(/\r?\n/);
@@ -6725,7 +6768,9 @@ function getFirstNonEmptyLine(content) {
6725
6768
  return null;
6726
6769
  }
6727
6770
  /**
6728
- * @private Determines the base file name by normalizing the first non-empty line.
6771
+ * Determines the base file name by normalizing the first non-empty line.
6772
+ *
6773
+ * @private
6729
6774
  */
6730
6775
  function deriveBaseFilename(content) {
6731
6776
  const firstLine = getFirstNonEmptyLine(content);
@@ -6736,7 +6781,9 @@ function deriveBaseFilename(content) {
6736
6781
  return normalized || INLINE_KNOWLEDGE_BASE_NAME;
6737
6782
  }
6738
6783
  /**
6739
- * @private Converts inline knowledge into the internal metadata form used for uploads.
6784
+ * Converts inline knowledge into the internal metadata form used for uploads.
6785
+ *
6786
+ * @private
6740
6787
  */
6741
6788
  function createInlineKnowledgeSourceFile(content) {
6742
6789
  const trimmedContent = content.trim();
@@ -6759,7 +6806,9 @@ function isDataUrlKnowledgeSource(source) {
6759
6806
  return typeof source === 'string' && source.startsWith(DATA_URL_PREFIX);
6760
6807
  }
6761
6808
  /**
6762
- * @private Converts a stored inline knowledge file into a data URL for backwards compatibility.
6809
+ * Converts a stored inline knowledge file into a data URL for backwards compatibility.
6810
+ *
6811
+ * @private
6763
6812
  */
6764
6813
  function inlineKnowledgeSourceToDataUrl(source) {
6765
6814
  const base64 = source.buffer.toString('base64');
@@ -6819,9 +6868,7 @@ function parseDataUrlKnowledgeSource(source) {
6819
6868
  return null;
6820
6869
  }
6821
6870
  }
6822
- /**
6823
- * Note: [💞] Ignore a discrepancy between file name and entity name
6824
- */
6871
+ // Note: [💞] Ignore a discrepancy between file name and entity name
6825
6872
 
6826
6873
  /**
6827
6874
  * KNOWLEDGE commitment definition
@@ -7025,9 +7072,7 @@ class LanguageCommitmentDefinition extends BaseCommitmentDefinition {
7025
7072
  return this.appendToSystemMessage(requirements, languageSection, '\n\n');
7026
7073
  }
7027
7074
  }
7028
- /**
7029
- * Note: [💞] Ignore a discrepancy between file name and entity name
7030
- */
7075
+ // Note: [💞] Ignore a discrepancy between file name and entity name
7031
7076
 
7032
7077
  /**
7033
7078
  * @@@
@@ -7293,6 +7338,7 @@ function serializeToolRuntimeContext(context) {
7293
7338
  *
7294
7339
  * @param listener - Listener notified about tool progress.
7295
7340
  * @returns Hidden token used to route progress updates.
7341
+ *
7296
7342
  * @private internal runtime wiring for commitment tools
7297
7343
  */
7298
7344
  function registerToolCallProgressListener(listener) {
@@ -7305,14 +7351,13 @@ function registerToolCallProgressListener(listener) {
7305
7351
  * Unregisters one in-memory progress listener.
7306
7352
  *
7307
7353
  * @param token - Token previously created by `registerToolCallProgressListener`.
7354
+ *
7308
7355
  * @private internal runtime wiring for commitment tools
7309
7356
  */
7310
7357
  function unregisterToolCallProgressListener(token) {
7311
7358
  toolCallProgressListeners.delete(token);
7312
7359
  }
7313
- /**
7314
- * Note: [💞] Ignore a discrepancy between file name and entity name
7315
- */
7360
+ // Note: [💞] Ignore a discrepancy between file name and entity name
7316
7361
 
7317
7362
  /**
7318
7363
  * Resolves runtime context from hidden tool arguments.
@@ -7673,9 +7718,7 @@ class MemoryCommitmentDefinition extends BaseCommitmentDefinition {
7673
7718
  return createMemoryToolFunctions();
7674
7719
  }
7675
7720
  }
7676
- /**
7677
- * Note: [💞] Ignore a discrepancy between file name and entity name
7678
- */
7721
+ // Note: [💞] Ignore a discrepancy between file name and entity name
7679
7722
 
7680
7723
  /**
7681
7724
  * AGENT MESSAGE commitment definition
@@ -8005,9 +8048,7 @@ class MessageCommitmentDefinition extends BaseCommitmentDefinition {
8005
8048
  return this.appendToSystemMessage(requirements, messageSection, '\n\n');
8006
8049
  }
8007
8050
  }
8008
- /**
8009
- * Note: [💞] Ignore a discrepancy between file name and entity name
8010
- */
8051
+ // Note: [💞] Ignore a discrepancy between file name and entity name
8011
8052
 
8012
8053
  /**
8013
8054
  * USER MESSAGE commitment definition
@@ -8138,9 +8179,7 @@ class MessageSuffixCommitmentDefinition extends BaseCommitmentDefinition {
8138
8179
  return requirements;
8139
8180
  }
8140
8181
  }
8141
- /**
8142
- * Note: [💞] Ignore a discrepancy between file name and entity name
8143
- */
8182
+ // Note: [💞] Ignore a discrepancy between file name and entity name
8144
8183
 
8145
8184
  /**
8146
8185
  * META commitment definition
@@ -8287,9 +8326,7 @@ class MetaCommitmentDefinition extends BaseCommitmentDefinition {
8287
8326
  return knownTypes.includes(metaType.toUpperCase());
8288
8327
  }
8289
8328
  }
8290
- /**
8291
- * Note: [💞] Ignore a discrepancy between file name and entity name
8292
- */
8329
+ // Note: [💞] Ignore a discrepancy between file name and entity name
8293
8330
 
8294
8331
  /**
8295
8332
  * META COLOR commitment definition
@@ -8385,9 +8422,7 @@ class MetaColorCommitmentDefinition extends BaseCommitmentDefinition {
8385
8422
  return trimmedContent || null;
8386
8423
  }
8387
8424
  }
8388
- /**
8389
- * Note: [💞] Ignore a discrepancy between file name and entity name
8390
- */
8425
+ // Note: [💞] Ignore a discrepancy between file name and entity name
8391
8426
 
8392
8427
  /**
8393
8428
  * META DOMAIN commitment definition
@@ -8452,9 +8487,7 @@ class MetaDomainCommitmentDefinition extends BaseCommitmentDefinition {
8452
8487
  return trimmedContent || null;
8453
8488
  }
8454
8489
  }
8455
- /**
8456
- * Note: [💞] Ignore a discrepancy between file name and entity name
8457
- */
8490
+ // Note: [💞] Ignore a discrepancy between file name and entity name
8458
8491
 
8459
8492
  /**
8460
8493
  * META DISCLAIMER commitment definition
@@ -8522,9 +8555,7 @@ class MetaDisclaimerCommitmentDefinition extends BaseCommitmentDefinition {
8522
8555
  return requirements;
8523
8556
  }
8524
8557
  }
8525
- /**
8526
- * Note: [💞] Ignore a discrepancy between file name and entity name
8527
- */
8558
+ // Note: [💞] Ignore a discrepancy between file name and entity name
8528
8559
 
8529
8560
  /**
8530
8561
  * META FONT commitment definition
@@ -8607,9 +8638,7 @@ class MetaFontCommitmentDefinition extends BaseCommitmentDefinition {
8607
8638
  return trimmedContent || null;
8608
8639
  }
8609
8640
  }
8610
- /**
8611
- * Note: [💞] Ignore a discrepancy between file name and entity name
8612
- */
8641
+ // Note: [💞] Ignore a discrepancy between file name and entity name
8613
8642
 
8614
8643
  /**
8615
8644
  * META IMAGE commitment definition
@@ -8694,9 +8723,7 @@ class MetaImageCommitmentDefinition extends BaseCommitmentDefinition {
8694
8723
  return trimmedContent || null;
8695
8724
  }
8696
8725
  }
8697
- /**
8698
- * Note: [💞] Ignore a discrepancy between file name and entity name
8699
- */
8726
+ // Note: [💞] Ignore a discrepancy between file name and entity name
8700
8727
 
8701
8728
  /**
8702
8729
  * META INPUT PLACEHOLDER commitment definition.
@@ -8759,9 +8786,7 @@ class MetaInputPlaceholderCommitmentDefinition extends BaseCommitmentDefinition
8759
8786
  return trimmedContent || null;
8760
8787
  }
8761
8788
  }
8762
- /**
8763
- * Note: [💞] Ignore a discrepancy between file name and entity name
8764
- */
8789
+ // Note: [💞] Ignore a discrepancy between file name and entity name
8765
8790
 
8766
8791
  /**
8767
8792
  * META LINK commitment definition
@@ -8868,9 +8893,7 @@ class MetaLinkCommitmentDefinition extends BaseCommitmentDefinition {
8868
8893
  }
8869
8894
  }
8870
8895
  }
8871
- /**
8872
- * Note: [💞] Ignore a discrepancy between file name and entity name
8873
- */
8896
+ // Note: [💞] Ignore a discrepancy between file name and entity name
8874
8897
 
8875
8898
  /**
8876
8899
  * META VOICE commitment definition
@@ -8939,9 +8962,7 @@ class MetaVoiceCommitmentDefinition extends BaseCommitmentDefinition {
8939
8962
  return trimmedContent || null;
8940
8963
  }
8941
8964
  }
8942
- /**
8943
- * Note: [💞] Ignore a discrepancy between file name and entity name
8944
- */
8965
+ // Note: [💞] Ignore a discrepancy between file name and entity name
8945
8966
 
8946
8967
  /**
8947
8968
  * MODEL commitment definition
@@ -9179,9 +9200,7 @@ class ModelCommitmentDefinition extends BaseCommitmentDefinition {
9179
9200
  return result;
9180
9201
  }
9181
9202
  }
9182
- /**
9183
- * Note: [💞] Ignore a discrepancy between file name and entity name
9184
- */
9203
+ // Note: [💞] Ignore a discrepancy between file name and entity name
9185
9204
 
9186
9205
  /**
9187
9206
  * NOTE commitment definition
@@ -9343,9 +9362,7 @@ class OpenCommitmentDefinition extends BaseCommitmentDefinition {
9343
9362
  };
9344
9363
  }
9345
9364
  }
9346
- /**
9347
- * Note: [💞] Ignore a discrepancy between file name and entity name
9348
- */
9365
+ // Note: [💞] Ignore a discrepancy between file name and entity name
9349
9366
 
9350
9367
  /**
9351
9368
  * PERSONA commitment definition
@@ -9484,9 +9501,7 @@ class PersonaCommitmentDefinition extends BaseCommitmentDefinition {
9484
9501
  };
9485
9502
  }
9486
9503
  }
9487
- /**
9488
- * Note: [💞] Ignore a discrepancy between file name and entity name
9489
- */
9504
+ // Note: [💞] Ignore a discrepancy between file name and entity name
9490
9505
 
9491
9506
  /**
9492
9507
  * RULE commitment definition
@@ -9567,15 +9582,14 @@ class RuleCommitmentDefinition extends BaseCommitmentDefinition {
9567
9582
  return this.appendToPromptSuffix(requirementsWithRule, ruleSection);
9568
9583
  }
9569
9584
  }
9570
- /**
9571
- * Note: [💞] Ignore a discrepancy between file name and entity name
9572
- */
9585
+ // Note: [💞] Ignore a discrepancy between file name and entity name
9573
9586
 
9574
9587
  /**
9575
9588
  * Creates the canonical system-message body for one writing-sample commitment.
9576
9589
  *
9577
9590
  * @param content - Explicit 1:1 sample text.
9578
9591
  * @returns Writing-sample guidance ready for one system-message section.
9592
+ *
9579
9593
  * @private internal utility of writing commitments
9580
9594
  */
9581
9595
  function createWritingSampleSection(content) {
@@ -9593,6 +9607,7 @@ function createWritingSampleSection(content) {
9593
9607
  *
9594
9608
  * @param content - Writing-only instructions.
9595
9609
  * @returns Writing-rules guidance ready for one system-message section.
9610
+ *
9596
9611
  * @private internal utility of writing commitments
9597
9612
  */
9598
9613
  function createWritingRulesSection(content) {
@@ -9605,9 +9620,7 @@ function createWritingRulesSection(content) {
9605
9620
  ${content}
9606
9621
  `);
9607
9622
  }
9608
- /**
9609
- * Note: [💞] Ignore a discrepancy between file name and entity name
9610
- */
9623
+ // Note: [💞] Ignore a discrepancy between file name and entity name
9611
9624
 
9612
9625
  /**
9613
9626
  * Legacy `SAMPLE` / `EXAMPLE` commitment definition.
@@ -9686,9 +9699,7 @@ class SampleCommitmentDefinition extends BaseCommitmentDefinition {
9686
9699
  return this.appendToSystemMessage(requirements, this.createSystemMessageSection('Writing sample', createWritingSampleSection(trimmedContent)), '\n\n');
9687
9700
  }
9688
9701
  }
9689
- /**
9690
- * Note: [💞] Ignore a discrepancy between file name and entity name
9691
- */
9702
+ // Note: [💞] Ignore a discrepancy between file name and entity name
9692
9703
 
9693
9704
  /**
9694
9705
  * SCENARIO commitment definition
@@ -9810,9 +9821,7 @@ class ScenarioCommitmentDefinition extends BaseCommitmentDefinition {
9810
9821
  return this.appendToSystemMessage(requirements, scenarioSection, '\n\n');
9811
9822
  }
9812
9823
  }
9813
- /**
9814
- * Note: [💞] Ignore a discrepancy between file name and entity name
9815
- */
9824
+ // Note: [💞] Ignore a discrepancy between file name and entity name
9816
9825
 
9817
9826
  /**
9818
9827
  * STYLE commitment definition
@@ -9909,6 +9918,7 @@ const TEAM_TOOL_FALLBACK_NAME = 'teammate';
9909
9918
  *
9910
9919
  * @param teammateLabel - Human-readable teammate label.
9911
9920
  * @returns Normalized teammate identifier for TEAM tool names.
9921
+ *
9912
9922
  * @private internal helper of TEAM tool-name generation
9913
9923
  */
9914
9924
  function normalizeTeammateToolNamePart(teammateLabel) {
@@ -9924,6 +9934,7 @@ function normalizeTeammateToolNamePart(teammateLabel) {
9924
9934
  * @param _teammateUrl - Canonical teammate URL (kept for API compatibility, not used).
9925
9935
  * @param teammateLabel - Human-readable teammate label used as the basis for the name.
9926
9936
  * @returns TEAM tool name derived from the label.
9937
+ *
9927
9938
  * @private internal utility of TEAM commitments and chat UI mapping
9928
9939
  */
9929
9940
  function createTeamToolName(_teammateUrl, teammateLabel) {
@@ -9931,9 +9942,21 @@ function createTeamToolName(_teammateUrl, teammateLabel) {
9931
9942
  return `${TEAM_TOOL_PREFIX}${normalizedLabel}`;
9932
9943
  }
9933
9944
 
9945
+ /**
9946
+ * Pattern matching agent URLs inside TEAM commitment content.
9947
+ */
9934
9948
  const urlRegex = /https?:\/\/[^\s]+/gi;
9949
+ /**
9950
+ * Pattern matching punctuation that often trails teammate URLs in prose.
9951
+ */
9935
9952
  const trailingPunctuationRegex = /[),.;!?]+$/;
9953
+ /**
9954
+ * Clause separators used while splitting TEAM instruction context.
9955
+ */
9936
9956
  const clauseSeparators = ['.', '?', '!', ';', ','];
9957
+ /**
9958
+ * Conjunction separators used while splitting TEAM instruction context.
9959
+ */
9937
9960
  const conjunctionSeparators = [' and ', ' or '];
9938
9961
  /**
9939
9962
  * Parses TEAM commitment content into teammates with instructions.
@@ -9981,6 +10004,9 @@ function parseTeamCommitmentContent(content, options = {}) {
9981
10004
  }
9982
10005
  return teammates;
9983
10006
  }
10007
+ /**
10008
+ * Extracts the instruction fragment associated with one teammate URL.
10009
+ */
9984
10010
  function extractInstructionContext(line, matches, matchIndex) {
9985
10011
  var _a;
9986
10012
  const match = matches[matchIndex];
@@ -10006,6 +10032,9 @@ function extractInstructionContext(line, matches, matchIndex) {
10006
10032
  }
10007
10033
  return `${prefix} ${suffix}`.trim();
10008
10034
  }
10035
+ /**
10036
+ * Trims content after the last detected clause delimiter.
10037
+ */
10009
10038
  function trimAfterLastDelimiter(text) {
10010
10039
  const match = findLastDelimiter(text);
10011
10040
  if (!match) {
@@ -10013,6 +10042,9 @@ function trimAfterLastDelimiter(text) {
10013
10042
  }
10014
10043
  return text.slice(match.index + match.length);
10015
10044
  }
10045
+ /**
10046
+ * Trims content before the last detected clause delimiter.
10047
+ */
10016
10048
  function trimBeforeLastDelimiter(text) {
10017
10049
  const cleaned = text.replace(/^[,;:]\s*/g, '');
10018
10050
  const match = findLastDelimiter(cleaned);
@@ -10021,6 +10053,9 @@ function trimBeforeLastDelimiter(text) {
10021
10053
  }
10022
10054
  return cleaned.slice(0, match.index);
10023
10055
  }
10056
+ /**
10057
+ * Finds the last clause or conjunction delimiter in a string.
10058
+ */
10024
10059
  function findLastDelimiter(text) {
10025
10060
  let bestIndex = -1;
10026
10061
  let bestLength = 0;
@@ -10044,6 +10079,9 @@ function findLastDelimiter(text) {
10044
10079
  }
10045
10080
  return { index: bestIndex, length: bestLength };
10046
10081
  }
10082
+ /**
10083
+ * Normalizes teammate instruction text after URL extraction.
10084
+ */
10047
10085
  function normalizeInstructionText(text) {
10048
10086
  if (!text) {
10049
10087
  return '';
@@ -10057,6 +10095,9 @@ function normalizeInstructionText(text) {
10057
10095
  normalized = normalizeWhitespaces(normalized).trim();
10058
10096
  return normalized;
10059
10097
  }
10098
+ /**
10099
+ * Creates a readable teammate label from an agent URL.
10100
+ */
10060
10101
  function createTeammateLabel(url) {
10061
10102
  try {
10062
10103
  const parsed = new URL(url);
@@ -10076,12 +10117,19 @@ function createTeammateLabel(url) {
10076
10117
  return url;
10077
10118
  }
10078
10119
  }
10120
+ // Note: [💞] Ignore a discrepancy between file name and entity name
10121
+
10079
10122
  /**
10080
- * Note: [💞] Ignore a discrepancy between file name and entity name
10123
+ * Map of team tool functions.
10081
10124
  */
10082
-
10083
10125
  const teamToolFunctions = {};
10126
+ /**
10127
+ * Map of team tool titles.
10128
+ */
10084
10129
  const teamToolTitles = {};
10130
+ /**
10131
+ * Constant for remote agents by Url.
10132
+ */
10085
10133
  const remoteAgentsByUrl = new Map();
10086
10134
  /**
10087
10135
  * TEAM commitment definition
@@ -10445,9 +10493,7 @@ function createTeamToolFunction(entry) {
10445
10493
  return JSON.stringify(result);
10446
10494
  };
10447
10495
  }
10448
- /**
10449
- * Note: [💞] Ignore a discrepancy between file name and entity name
10450
- */
10496
+ // Note: [💞] Ignore a discrepancy between file name and entity name
10451
10497
 
10452
10498
  /**
10453
10499
  * TEMPLATE commitment definition
@@ -10568,9 +10614,7 @@ class TemplateCommitmentDefinition extends BaseCommitmentDefinition {
10568
10614
  };
10569
10615
  }
10570
10616
  }
10571
- /**
10572
- * Note: [💞] Ignore a discrepancy between file name and entity name
10573
- */
10617
+ // Note: [💞] Ignore a discrepancy between file name and entity name
10574
10618
 
10575
10619
  /**
10576
10620
  * USE commitment definition
@@ -10682,9 +10726,7 @@ class UseCommitmentDefinition extends BaseCommitmentDefinition {
10682
10726
  return knownTypes.includes(useType.toUpperCase());
10683
10727
  }
10684
10728
  }
10685
- /**
10686
- * Note: [💞] Ignore a discrepancy between file name and entity name
10687
- */
10729
+ // Note: [💞] Ignore a discrepancy between file name and entity name
10688
10730
 
10689
10731
  /**
10690
10732
  * All `USE` commitment types currently participating in final system-message aggregation.
@@ -10707,6 +10749,7 @@ const AGGREGATED_USE_COMMITMENT_PLACEHOLDER_PREFIX = '# AGGREGATED USE COMMITMEN
10707
10749
  *
10708
10750
  * @param type - Commitment type to check.
10709
10751
  * @returns `true` when the commitment participates in `USE` system-message aggregation.
10752
+ *
10710
10753
  * @private internal utility of `aggregateUseCommitmentSystemMessages`
10711
10754
  */
10712
10755
  function isAggregatedUseCommitmentType(type) {
@@ -10717,6 +10760,7 @@ function isAggregatedUseCommitmentType(type) {
10717
10760
  *
10718
10761
  * @param type - Aggregated `USE` commitment type.
10719
10762
  * @returns Single-line placeholder comment stored in the interim system message.
10763
+ *
10720
10764
  * @private internal utility of `appendAggregatedUseCommitmentPlaceholder`
10721
10765
  */
10722
10766
  function getAggregatedUseCommitmentPlaceholder(type) {
@@ -10727,6 +10771,7 @@ function getAggregatedUseCommitmentPlaceholder(type) {
10727
10771
  *
10728
10772
  * @param additionalInstructions - Deduplicated instruction blocks collected from the agent source.
10729
10773
  * @returns Combined instruction text ready for `formatOptionalInstructionBlock`.
10774
+ *
10730
10775
  * @private internal utility of `createAggregatedUseCommitmentSystemMessage`
10731
10776
  */
10732
10777
  function combineAdditionalInstructions(additionalInstructions) {
@@ -10738,6 +10783,7 @@ function combineAdditionalInstructions(additionalInstructions) {
10738
10783
  * @param type - Aggregated `USE` commitment type.
10739
10784
  * @param additionalInstructions - Distinct additional instructions in source order.
10740
10785
  * @returns Final system-message block for the commitment type.
10786
+ *
10741
10787
  * @private internal utility of `aggregateUseCommitmentSystemMessages`
10742
10788
  */
10743
10789
  function createAggregatedUseCommitmentSystemMessage(type, additionalInstructions) {
@@ -10776,6 +10822,7 @@ function createAggregatedUseCommitmentSystemMessage(type, additionalInstructions
10776
10822
  * @param requirements - Current model requirements.
10777
10823
  * @param type - Aggregated `USE` commitment type being applied.
10778
10824
  * @returns Requirements with the placeholder inserted when it was not already present.
10825
+ *
10779
10826
  * @private internal utility of `USE` commitments
10780
10827
  */
10781
10828
  function appendAggregatedUseCommitmentPlaceholder(requirements, type) {
@@ -10799,6 +10846,7 @@ function appendAggregatedUseCommitmentPlaceholder(requirements, type) {
10799
10846
  * @param requirements - Model requirements produced by commitment-by-commitment application.
10800
10847
  * @param commitments - Filtered commitments in their original source order.
10801
10848
  * @returns Requirements with aggregated `USE` system-message sections.
10849
+ *
10802
10850
  * @private internal utility of `createAgentModelRequirementsWithCommitments`
10803
10851
  */
10804
10852
  function aggregateUseCommitmentSystemMessages(requirements, commitments) {
@@ -11091,9 +11139,7 @@ class UseBrowserCommitmentDefinition extends BaseCommitmentDefinition {
11091
11139
  };
11092
11140
  }
11093
11141
  }
11094
- /**
11095
- * Note: [💞] Ignore a discrepancy between file name and entity name
11096
- */
11142
+ // Note: [💞] Ignore a discrepancy between file name and entity name
11097
11143
 
11098
11144
  /**
11099
11145
  * Base Google Calendar API URL.
@@ -11364,9 +11410,7 @@ function removeTokenFromLine(line, token) {
11364
11410
  const filteredTokens = tokens.filter((lineToken) => lineToken.replace(/[),.;:!?]+$/g, '') !== token);
11365
11411
  return filteredTokens.join(' ').trim();
11366
11412
  }
11367
- /**
11368
- * Note: [💞] Ignore a discrepancy between file name and entity name
11369
- */
11413
+ // Note: [💞] Ignore a discrepancy between file name and entity name
11370
11414
 
11371
11415
  /**
11372
11416
  * Wallet metadata used by USE CALENDAR when resolving Google Calendar credentials.
@@ -12317,9 +12361,7 @@ function addConfiguredCalendarIfMissing(configuredCalendars, calendarReference)
12317
12361
  ...(calendarReference.tokenRef ? { tokenRef: calendarReference.tokenRef } : {}),
12318
12362
  });
12319
12363
  }
12320
- /**
12321
- * Note: [💞] Ignore a discrepancy between file name and entity name
12322
- */
12364
+ // Note: [💞] Ignore a discrepancy between file name and entity name
12323
12365
 
12324
12366
  /**
12325
12367
  * Lightweight email token matcher used for `USE EMAIL` first-line parsing.
@@ -12585,9 +12627,7 @@ function addUseEmailTools(existingTools) {
12585
12627
  },
12586
12628
  ];
12587
12629
  }
12588
- /**
12589
- * Note: [💞] Ignore a discrepancy between file name and entity name
12590
- */
12630
+ // Note: [💞] Ignore a discrepancy between file name and entity name
12591
12631
 
12592
12632
  /**
12593
12633
  * USE IMAGE GENERATOR commitment definition
@@ -12678,9 +12718,7 @@ class UseImageGeneratorCommitmentDefinition extends BaseCommitmentDefinition {
12678
12718
  `));
12679
12719
  }
12680
12720
  }
12681
- /**
12682
- * Note: [💞] Ignore a discrepancy between file name and entity name
12683
- */
12721
+ // Note: [💞] Ignore a discrepancy between file name and entity name
12684
12722
 
12685
12723
  /**
12686
12724
  * USE MCP commitment definition
@@ -12755,9 +12793,7 @@ class UseMcpCommitmentDefinition extends BaseCommitmentDefinition {
12755
12793
  };
12756
12794
  }
12757
12795
  }
12758
- /**
12759
- * Note: [💞] Ignore a discrepancy between file name and entity name
12760
- */
12796
+ // Note: [💞] Ignore a discrepancy between file name and entity name
12761
12797
 
12762
12798
  /**
12763
12799
  * USE POPUP commitment definition
@@ -12893,9 +12929,7 @@ class UsePopupCommitmentDefinition extends BaseCommitmentDefinition {
12893
12929
  };
12894
12930
  }
12895
12931
  }
12896
- /**
12897
- * Note: [💞] Ignore a discrepancy between file name and entity name
12898
- */
12932
+ // Note: [💞] Ignore a discrepancy between file name and entity name
12899
12933
 
12900
12934
  /**
12901
12935
  * Tool name used by the USE PRIVACY commitment.
@@ -13067,9 +13101,7 @@ class UsePrivacyCommitmentDefinition extends BaseCommitmentDefinition {
13067
13101
  };
13068
13102
  }
13069
13103
  }
13070
- /**
13071
- * Note: [💞] Ignore a discrepancy between file name and entity name
13072
- */
13104
+ // Note: [💞] Ignore a discrepancy between file name and entity name
13073
13105
 
13074
13106
  /* eslint-disable no-magic-numbers */
13075
13107
  /**
@@ -13876,9 +13908,7 @@ function createGitHubRepositoryReference(owner, repository, defaultBranch) {
13876
13908
  defaultBranch,
13877
13909
  };
13878
13910
  }
13879
- /**
13880
- * Note: [💞] Ignore a discrepancy between file name and entity name
13881
- */
13911
+ // Note: [💞] Ignore a discrepancy between file name and entity name
13882
13912
 
13883
13913
  /**
13884
13914
  * Wallet metadata used by USE PROJECT when resolving GitHub credentials.
@@ -14737,9 +14767,7 @@ function addConfiguredProjectIfMissing(configuredProjects, repositoryReference)
14737
14767
  defaultBranch: repositoryReference.defaultBranch,
14738
14768
  });
14739
14769
  }
14740
- /**
14741
- * Note: [💞] Ignore a discrepancy between file name and entity name
14742
- */
14770
+ // Note: [💞] Ignore a discrepancy between file name and entity name
14743
14771
 
14744
14772
  /**
14745
14773
  * A search engine implementation that uses the SerpApi to fetch Google search results.
@@ -14950,9 +14978,7 @@ class UseSearchEngineCommitmentDefinition extends BaseCommitmentDefinition {
14950
14978
  };
14951
14979
  }
14952
14980
  }
14953
- /**
14954
- * Note: [💞] Ignore a discrepancy between file name and entity name
14955
- */
14981
+ // Note: [💞] Ignore a discrepancy between file name and entity name
14956
14982
 
14957
14983
  /**
14958
14984
  * Maximum allowed source length for create-agent payloads.
@@ -15149,9 +15175,7 @@ class UseSpawnCommitmentDefinition extends BaseCommitmentDefinition {
15149
15175
  };
15150
15176
  }
15151
15177
  }
15152
- /**
15153
- * Note: [💞] Ignore a discrepancy between file name and entity name
15154
- */
15178
+ // Note: [💞] Ignore a discrepancy between file name and entity name
15155
15179
 
15156
15180
  /**
15157
15181
  * Creates system-message instructions for `USE TIMEOUT`.
@@ -15216,9 +15240,7 @@ function parseToolExecutionEnvelope(rawValue) {
15216
15240
  return null;
15217
15241
  }
15218
15242
  }
15219
- /**
15220
- * Note: [💞] Ignore a discrepancy between file name and entity name
15221
- */
15243
+ // Note: [💞] Ignore a discrepancy between file name and entity name
15222
15244
 
15223
15245
  /**
15224
15246
  * Builds a disabled timeout-tool payload.
@@ -15952,9 +15974,7 @@ class UseTimeoutCommitmentDefinition extends BaseCommitmentDefinition {
15952
15974
  return createTimeoutToolFunctions();
15953
15975
  }
15954
15976
  }
15955
- /**
15956
- * Note: [💞] Ignore a discrepancy between file name and entity name
15957
- */
15977
+ // Note: [💞] Ignore a discrepancy between file name and entity name
15958
15978
 
15959
15979
  /**
15960
15980
  * USE TIME commitment definition
@@ -16101,9 +16121,7 @@ class UseTimeCommitmentDefinition extends BaseCommitmentDefinition {
16101
16121
  };
16102
16122
  }
16103
16123
  }
16104
- /**
16105
- * Note: [💞] Ignore a discrepancy between file name and entity name
16106
- */
16124
+ // Note: [💞] Ignore a discrepancy between file name and entity name
16107
16125
 
16108
16126
  /**
16109
16127
  * Tool name used by the USE USER LOCATION commitment.
@@ -16316,9 +16334,7 @@ class UseUserLocationCommitmentDefinition extends BaseCommitmentDefinition {
16316
16334
  };
16317
16335
  }
16318
16336
  }
16319
- /**
16320
- * Note: [💞] Ignore a discrepancy between file name and entity name
16321
- */
16337
+ // Note: [💞] Ignore a discrepancy between file name and entity name
16322
16338
 
16323
16339
  /**
16324
16340
  * `WRITING RULES` commitment definition.
@@ -16394,9 +16410,7 @@ class WritingRulesCommitmentDefinition extends BaseCommitmentDefinition {
16394
16410
  return this.appendToSystemMessage(requirements, this.createSystemMessageSection('Writing rules', createWritingRulesSection(trimmedContent)), '\n\n');
16395
16411
  }
16396
16412
  }
16397
- /**
16398
- * Note: [💞] Ignore a discrepancy between file name and entity name
16399
- */
16413
+ // Note: [💞] Ignore a discrepancy between file name and entity name
16400
16414
 
16401
16415
  /**
16402
16416
  * `WRITING SAMPLE` commitment definition.
@@ -16466,9 +16480,7 @@ class WritingSampleCommitmentDefinition extends BaseCommitmentDefinition {
16466
16480
  return this.appendToSystemMessage(requirements, this.createSystemMessageSection('Writing sample', createWritingSampleSection(trimmedContent)), '\n\n');
16467
16481
  }
16468
16482
  }
16469
- /**
16470
- * Note: [💞] Ignore a discrepancy between file name and entity name
16471
- */
16483
+ // Note: [💞] Ignore a discrepancy between file name and entity name
16472
16484
 
16473
16485
  /**
16474
16486
  * Placeholder commitment definition for commitments that are not yet implemented
@@ -16629,14 +16641,13 @@ const COMMITMENT_REGISTRY = [
16629
16641
  new NotYetImplementedCommitmentDefinition('AVOIDANCE'),
16630
16642
  new NotYetImplementedCommitmentDefinition('CONTEXT'),
16631
16643
  // <- TODO: Prompt: Leverage aliases instead of duplicating commitment definitions
16632
- ];
16633
- /**
16634
- * TODO: [🧠] Maybe create through standardized $register
16635
- * Note: [💞] Ignore a discrepancy between file name and entity name
16636
- */
16644
+ ];
16645
+ // TODO: [🧠] Maybe create through standardized $register
16646
+ // Note: [💞] Ignore a discrepancy between file name and entity name
16637
16647
 
16638
16648
  /**
16639
16649
  * Gets all available commitment definitions
16650
+ *
16640
16651
  * @returns Array of all commitment definitions
16641
16652
  *
16642
16653
  * @public exported from `@promptbook/core`
@@ -16649,6 +16660,7 @@ function getAllCommitmentDefinitions() {
16649
16660
  * Collects tool functions from all commitment definitions.
16650
16661
  *
16651
16662
  * @returns Map of tool function implementations.
16663
+ *
16652
16664
  * @private internal helper for commitment tool registry
16653
16665
  */
16654
16666
  function collectCommitmentToolFunctions() {
@@ -16670,6 +16682,7 @@ function collectCommitmentToolFunctions() {
16670
16682
  *
16671
16683
  * @param getFunctions - Provider of current tool functions.
16672
16684
  * @returns Proxy exposing tool functions as properties.
16685
+ *
16673
16686
  * @private internal helper for commitment tool registry
16674
16687
  */
16675
16688
  function createToolFunctionsProxy(getFunctions) {
@@ -16707,10 +16720,11 @@ function createToolFunctionsProxy(getFunctions) {
16707
16720
  },
16708
16721
  });
16709
16722
  }
16723
+ // Note: [💞] Ignore a discrepancy between file name and entity name
16724
+
16710
16725
  /**
16711
- * Note: [💞] Ignore a discrepancy between file name and entity name
16726
+ * Constant for commitment tool functions proxy.
16712
16727
  */
16713
-
16714
16728
  const commitmentToolFunctionsProxy = createToolFunctionsProxy(collectCommitmentToolFunctions);
16715
16729
  /**
16716
16730
  * Gets all function implementations provided by all commitments
@@ -16727,7 +16741,7 @@ function getAllCommitmentsToolFunctionsForBrowser() {
16727
16741
  * Wrapper around `window.prompt` synchronous function that interacts with the user via browser prompt
16728
16742
  *
16729
16743
  * Warning: It is used for testing and mocking
16730
- * **NOT intended to use in the production** due to its synchronous nature.
16744
+ * **NOT intended to use in the production** due to its synchronous nature.
16731
16745
  *
16732
16746
  * @public exported from `@promptbook/browser`
16733
16747
  */
@@ -16756,9 +16770,7 @@ class SimplePromptInterfaceTools {
16756
16770
  return answer;
16757
16771
  }
16758
16772
  }
16759
- /**
16760
- * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
16761
- */
16773
+ // Note: [🔵] Code for browser dialog helper [SimplePromptInterfaceTools](src/dialogs/simple-prompt/SimplePromptInterfaceTools.ts) should never be published outside of `@promptbook/browser`
16762
16774
 
16763
16775
  /**
16764
16776
  * Safely retrieves the global scope object (window in browser, global in Node.js)
@@ -16766,7 +16778,7 @@ class SimplePromptInterfaceTools {
16766
16778
  *
16767
16779
  * Note: `$` is used to indicate that this function is not a pure function - it access global scope
16768
16780
  *
16769
- * @private internal function of `$Register`
16781
+ * @private internal function of `$Register`
16770
16782
  */
16771
16783
  function $getGlobalScope() {
16772
16784
  return Function('return this')();
@@ -16825,13 +16837,13 @@ class $Register {
16825
16837
  * Central point for registering and accessing different types of content scrapers.
16826
16838
  *
16827
16839
  * Note: `$` is used to indicate that this interacts with the global scope
16840
+ *
16828
16841
  * @singleton Only one instance of each register is created per build, but there can be more than one in different build modules
16842
+ *
16829
16843
  * @public exported from `@promptbook/core`
16830
16844
  */
16831
16845
  const $scrapersRegister = new $Register('scraper_constructors');
16832
- /**
16833
- * TODO: [®] DRY Register logic
16834
- */
16846
+ // TODO: [®] DRY Register logic
16835
16847
 
16836
16848
  /**
16837
16849
  * Provides a collection of scrapers optimized for browser environments.
@@ -16957,14 +16969,13 @@ class BrowserSpeechRecognition {
16957
16969
  }
16958
16970
  }
16959
16971
  }
16960
- /**
16961
- * TODO: !!!! Search ACRY for `window` and put -> [🔵]
16962
- * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
16963
- */
16972
+ // Note: [🔵] Code for browser speech-recognition adapter [BrowserSpeechRecognition](src/speech-recognition/BrowserSpeechRecognition.ts) should never be published outside of `@promptbook/browser`
16973
+ // TODO: !!!! Search ACRY for `window` and put -> [🔵]
16964
16974
 
16965
16975
  /**
16966
16976
  * Creates a PromptbookStorage backed by IndexedDB.
16967
16977
  * Uses a single object store named 'promptbook'.
16978
+ *
16968
16979
  * @private for `getIndexedDbStorage`
16969
16980
  */
16970
16981
  function makePromptbookStorageFromIndexedDb(options) {
@@ -17037,9 +17048,7 @@ function getIndexedDbStorage(options) {
17037
17048
  indexedDbStorageCache.set(cacheKey, storage);
17038
17049
  return storage;
17039
17050
  }
17040
- /**
17041
- * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
17042
- */
17051
+ // Note: [🔵] Code for browser storage helper [getIndexedDbStorage](src/storage/local-storage/getIndexedDbStorage.ts) should never be published outside of `@promptbook/browser`
17043
17052
 
17044
17053
  /**
17045
17054
  * Stringify the PipelineJson with proper formatting
@@ -17067,12 +17076,10 @@ function stringifyPipelineJson(pipeline) {
17067
17076
  pipelineJsonStringified += '\n';
17068
17077
  return pipelineJsonStringified;
17069
17078
  }
17070
- /**
17071
- * TODO: [🐝] Not Working properly @see https://promptbook.studio/examples/mixed-knowledge.book
17072
- * TODO: [🧠][0] Maybe rename to `stringifyPipelineJson`, `stringifyIndexedJson`,...
17073
- * TODO: [🧠] Maybe more elegant solution than replacing via regex
17074
- * TODO: [🍙] Make some standard order of json properties
17075
- */
17079
+ // TODO: [🐝] Not Working properly @see https://promptbook.studio/examples/mixed-knowledge.book
17080
+ // TODO: [🧠][0] Maybe rename to `stringifyPipelineJson`, `stringifyIndexedJson`,...
17081
+ // TODO: [🧠] Maybe more elegant solution than replacing via regex
17082
+ // TODO: [🍙] Make some standard order of json properties
17076
17083
 
17077
17084
  /**
17078
17085
  * Creates a Promptbook storage interface from a web storage object.
@@ -17103,10 +17110,8 @@ function makePromptbookStorageFromWebStorage(webStorage) {
17103
17110
  },
17104
17111
  };
17105
17112
  }
17106
- /**
17107
- * TODO: [🧠] Should this be named `makePromptbookStorageFromWebStorage` vs `createPromptbookStorageFromWebStorage`
17108
- * TODO: [🌗] Maybe some checkers, not all valid JSONs are desired and valid values
17109
- */
17113
+ // TODO: [🧠] Should this be named `makePromptbookStorageFromWebStorage` vs `createPromptbookStorageFromWebStorage`
17114
+ // TODO: [🌗] Maybe some checkers, not all valid JSONs are desired and valid values
17110
17115
 
17111
17116
  /**
17112
17117
  * Cache storage
@@ -17129,9 +17134,7 @@ function getLocalStorage() {
17129
17134
  promptbookLocalStorage = makePromptbookStorageFromWebStorage(localStorage);
17130
17135
  return promptbookLocalStorage;
17131
17136
  }
17132
- /**
17133
- * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
17134
- */
17137
+ // Note: [🔵] Code for browser storage helper [getLocalStorage](src/storage/local-storage/getLocalStorage.ts) should never be published outside of `@promptbook/browser`
17135
17138
 
17136
17139
  /**
17137
17140
  * Cache storage
@@ -17154,9 +17157,7 @@ function getSessionStorage() {
17154
17157
  promptbookSessionStorage = makePromptbookStorageFromWebStorage(sessionStorage);
17155
17158
  return promptbookSessionStorage;
17156
17159
  }
17157
- /**
17158
- * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
17159
- */
17160
+ // Note: [🔵] Code for browser storage helper [getSessionStorage](src/storage/local-storage/getSessionStorage.ts) should never be published outside of `@promptbook/browser`
17160
17161
 
17161
17162
  /**
17162
17163
  * Normalizes a domain-like string into a comparable hostname form.
@@ -17166,6 +17167,7 @@ function getSessionStorage() {
17166
17167
  *
17167
17168
  * @param rawDomain - Raw domain value (for example `my-agent.com` or `https://my-agent.com/path`).
17168
17169
  * @returns Normalized hostname or `null` when the value cannot be normalized.
17170
+ *
17169
17171
  * @private utility for host/domain matching
17170
17172
  */
17171
17173
  function normalizeDomainForMatching(rawDomain) {
@@ -17188,6 +17190,7 @@ function normalizeDomainForMatching(rawDomain) {
17188
17190
  *
17189
17191
  * @param value - Raw value to inspect.
17190
17192
  * @returns True when the value starts with `http://` or `https://`.
17193
+ *
17191
17194
  * @private utility for host/domain matching
17192
17195
  */
17193
17196
  function hasHttpProtocol(value) {
@@ -17233,6 +17236,7 @@ function createDefaultAgentName(agentSource) {
17233
17236
  *
17234
17237
  * @param agentSource - Raw agent source.
17235
17238
  * @returns Parsed prelude with shared line metadata.
17239
+ *
17236
17240
  * @private internal utility of book agent-source parsing
17237
17241
  */
17238
17242
  function parseAgentSourcePrelude(agentSource) {
@@ -17408,6 +17412,7 @@ function parseAgentSourceWithCommitments(agentSource) {
17408
17412
  *
17409
17413
  * @param text - Text to extract parameters from
17410
17414
  * @returns Array of parsed parameters with unified representation
17415
+ *
17411
17416
  * @public exported from `@promptbook/core`
17412
17417
  */
17413
17418
  function parseParameters(text) {
@@ -17836,9 +17841,7 @@ function normalizeMetaDomain(content) {
17836
17841
  const trimmed = spaceTrim$1(content);
17837
17842
  return normalizeDomainForMatching(trimmed) || trimmed.toLowerCase();
17838
17843
  }
17839
- /**
17840
- * TODO: [🕛] Unite `AgentBasicInformation`, `ChatParticipant`, `LlmExecutionTools` + `LlmToolsMetadata`
17841
- */
17844
+ // TODO: [🕛] Unite `AgentBasicInformation`, `ChatParticipant`, `LlmExecutionTools` + `LlmToolsMetadata`
17842
17845
 
17843
17846
  /**
17844
17847
  * Converts Blob, File or MediaSource to url using URL.createObjectURL
@@ -17911,9 +17914,7 @@ class ObjectUrl extends Registration {
17911
17914
  return new URL(this.src);
17912
17915
  }
17913
17916
  }
17914
- /**
17915
- * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
17916
- */
17917
+ // Note: [🔵] Code for browser file helper [ObjectUrl](src/utils/files/ObjectUrl.ts) should never be published outside of `@promptbook/browser`
17917
17918
 
17918
17919
  /**
17919
17920
  * Download a File in a browser
@@ -17933,9 +17934,7 @@ async function $induceFileDownload(fileOrBlobOrUrl) {
17933
17934
  link.click();
17934
17935
  await objectUrl.destroy();
17935
17936
  }
17936
- /**
17937
- * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
17938
- */
17937
+ // Note: [🔵] Code for browser file helper [$induceFileDownload](src/utils/files/$induceFileDownload.ts) should never be published outside of `@promptbook/browser`
17939
17938
 
17940
17939
  /**
17941
17940
  * Download a Book in a browser
@@ -17954,9 +17953,7 @@ async function $induceBookDownload(book) {
17954
17953
  });
17955
17954
  return /* not await */ $induceFileDownload(bookFile);
17956
17955
  }
17957
- /**
17958
- * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
17959
- */
17956
+ // Note: [🔵] Code for browser file helper [$induceBookDownload](src/utils/files/$induceBookDownload.ts) should never be published outside of `@promptbook/browser`
17960
17957
 
17961
17958
  /**
17962
17959
  * Keep-alive helpers used for streaming chat responses.
@@ -17968,12 +17965,10 @@ async function $induceBookDownload(book) {
17968
17965
  * @private internal streaming helper for Promptbook chat connections
17969
17966
  */
17970
17967
  const CHAT_STREAM_KEEP_ALIVE_TOKEN = 'STREAM_KEEP_ALIVE';
17971
- /**
17972
- * Note: [💞] Ignore a discrepancy between file name and entity name
17973
- */
17968
+ // Note: [💞] Ignore a discrepancy between file name and entity name
17974
17969
 
17975
17970
  /**
17976
- * Number of padding lines to add at the end of the book content
17971
+ * Number of padding lines to add at the end of the book content
17977
17972
  *
17978
17973
  * @public exported from `@promptbook/core`
17979
17974
  */
@@ -18010,9 +18005,7 @@ function padBook(content) {
18010
18005
  const linesToAdd = PADDING_LINES - trailingEmptyLines;
18011
18006
  return (content + '\n'.repeat(linesToAdd));
18012
18007
  }
18013
- /**
18014
- * TODO: [🧠] Maybe export
18015
- */
18008
+ // TODO: [🧠] Maybe export
18016
18009
 
18017
18010
  /**
18018
18011
  * Type guard to check if a string is a valid agent source
@@ -18042,6 +18035,7 @@ function validateBook(source) {
18042
18035
  * Default book
18043
18036
  *
18044
18037
  * @deprecated Use `$generateBookBoilerplate` instead
18038
+ *
18045
18039
  * @public exported from `@promptbook/core`
18046
18040
  */
18047
18041
  padBook(validateBook(spaceTrim$1(`
@@ -18063,6 +18057,7 @@ padBook(validateBook(spaceTrim$1(`
18063
18057
  * @param {string} pipelineString the candidate for a pipeline string
18064
18058
  * @returns {PipelineString} the same string as input, but validated as valid
18065
18059
  * @throws {ParseError} if the string is not a valid pipeline string
18060
+ *
18066
18061
  * @public exported from `@promptbook/core`
18067
18062
  */
18068
18063
  function validatePipelineString(pipelineString) {
@@ -18081,9 +18076,7 @@ function validatePipelineString(pipelineString) {
18081
18076
  // <- TODO: Implement the validation + add tests when the pipeline logic considered as invalid
18082
18077
  return pipelineString;
18083
18078
  }
18084
- /**
18085
- * TODO: [🧠][🈴] Where is the best location for this file
18086
- */
18079
+ // TODO: [🧠][🈴] Where is the best location for this file
18087
18080
 
18088
18081
  /**
18089
18082
  * Function `isValidPipelineString` will validate the if the string is a valid pipeline string
@@ -18091,6 +18084,7 @@ function validatePipelineString(pipelineString) {
18091
18084
  *
18092
18085
  * @param {string} pipelineString the candidate for a pipeline string
18093
18086
  * @returns {boolean} if the string is a valid pipeline string
18087
+ *
18094
18088
  * @public exported from `@promptbook/core`
18095
18089
  */
18096
18090
  function isValidPipelineString(pipelineString) {
@@ -18103,9 +18097,7 @@ function isValidPipelineString(pipelineString) {
18103
18097
  return false;
18104
18098
  }
18105
18099
  }
18106
- /**
18107
- * TODO: [🧠][🈴] Where is the best location for this file
18108
- */
18100
+ // TODO: [🧠][🈴] Where is the best location for this file
18109
18101
 
18110
18102
  /**
18111
18103
  * Tag function for notating a pipeline with a book\`...\ notation as template literal
@@ -18118,6 +18110,7 @@ function isValidPipelineString(pipelineString) {
18118
18110
  * @param strings The static string parts of the template literal
18119
18111
  * @param values The dynamic values embedded within the template literal used as data
18120
18112
  * @returns the pipeline string
18113
+ *
18121
18114
  * @public exported from `@promptbook/core`
18122
18115
  */
18123
18116
  function book(strings, ...values) {
@@ -18144,10 +18137,8 @@ function book(strings, ...values) {
18144
18137
  }
18145
18138
  return padBook(bookString);
18146
18139
  }
18147
- /**
18148
- * TODO: [🧠][🈴] Where is the best location for this file
18149
- * Note: [💞] Ignore a discrepancy between file name and entity name
18150
- */
18140
+ // TODO: [🧠][🈴] Where is the best location for this file
18141
+ // Note: [💞] Ignore a discrepancy between file name and entity name
18151
18142
 
18152
18143
  /**
18153
18144
  * Tool call name emitted while preparing a GPT assistant for an agent.
@@ -18192,9 +18183,7 @@ const CHAT_STREAM_WHITESPACE_DECODERS = [
18192
18183
  { token: CHAT_STREAM_WHITESPACE_TOKEN_TAB, value: '\t' },
18193
18184
  { token: CHAT_STREAM_WHITESPACE_TOKEN_SPACE, value: ' ' },
18194
18185
  ];
18195
- /**
18196
- * Note: [💞] Ignore a discrepancy between file name and entity name
18197
- */
18186
+ // Note: [💞] Ignore a discrepancy between file name and entity name
18198
18187
 
18199
18188
  /**
18200
18189
  * Converts encoded whitespace markers back into real whitespace so the UI can render the message
@@ -18212,6 +18201,9 @@ function decodeChatStreamWhitespaceFromTransport(content) {
18212
18201
  }, content);
18213
18202
  }
18214
18203
 
18204
+ /**
18205
+ * Constant for raw tool call ID fields.
18206
+ */
18215
18207
  const RAW_TOOL_CALL_ID_FIELDS = ['callId', 'call_id', 'id'];
18216
18208
  /**
18217
18209
  * Builds a deterministic idempotency key for tool calls so the UI can track updates.
@@ -18242,6 +18234,9 @@ function resolveToolCallIdempotencyKey(toolCall) {
18242
18234
  }
18243
18235
  return `fallback:${toolCall.name}`;
18244
18236
  }
18237
+ /**
18238
+ * Gets arguments key.
18239
+ */
18245
18240
  function getArgumentsKey(value) {
18246
18241
  if (typeof value === 'string') {
18247
18242
  return value;
@@ -18315,6 +18310,7 @@ function mergeToolCalls(existingToolCalls, incomingToolCalls) {
18315
18310
  * @param existingToolCall - Previous snapshot.
18316
18311
  * @param incomingToolCall - New snapshot.
18317
18312
  * @returns One merged snapshot.
18313
+ *
18318
18314
  * @private helper of `mergeToolCalls`
18319
18315
  */
18320
18316
  function mergeToolCallSnapshot(existingToolCall, incomingToolCall) {
@@ -18337,6 +18333,7 @@ function mergeToolCallSnapshot(existingToolCall, incomingToolCall) {
18337
18333
  * @param existingToolCall - Previous snapshot.
18338
18334
  * @param incomingToolCall - New snapshot.
18339
18335
  * @returns Resolved lifecycle state or `undefined` when neither snapshot provides enough data.
18336
+ *
18340
18337
  * @private helper of `mergeToolCalls`
18341
18338
  */
18342
18339
  function resolveMergedToolCallState(existingToolCall, incomingToolCall) {
@@ -18350,6 +18347,7 @@ function resolveMergedToolCallState(existingToolCall, incomingToolCall) {
18350
18347
  *
18351
18348
  * @param toolCall - Tool call snapshot to inspect.
18352
18349
  * @returns Inferred lifecycle state or `undefined`.
18350
+ *
18353
18351
  * @private helper of `mergeToolCalls`
18354
18352
  */
18355
18353
  function inferToolCallState(toolCall) {
@@ -18373,6 +18371,7 @@ function inferToolCallState(toolCall) {
18373
18371
  * @param existingValues - Previous list.
18374
18372
  * @param incomingValues - Incoming list.
18375
18373
  * @returns Deduplicated merged list or `undefined`.
18374
+ *
18376
18375
  * @private helper of `mergeToolCalls`
18377
18376
  */
18378
18377
  function mergeUnknownLists(existingValues, incomingValues) {
@@ -18399,6 +18398,7 @@ function mergeUnknownLists(existingValues, incomingValues) {
18399
18398
  *
18400
18399
  * @param value - Value to serialize.
18401
18400
  * @returns String signature.
18401
+ *
18402
18402
  * @private helper of `mergeToolCalls`
18403
18403
  */
18404
18404
  function serializeValueForMerge(value) {
@@ -18416,6 +18416,7 @@ function serializeValueForMerge(value) {
18416
18416
  *
18417
18417
  * @param toolCalls - Mutable list to deduplicate in-place.
18418
18418
  * @returns The same array after removing redundant preparation entries.
18419
+ *
18419
18420
  * @private helper of `mergeToolCalls`
18420
18421
  */
18421
18422
  function deduplicatePreparationToolCalls(toolCalls) {
@@ -18459,6 +18460,7 @@ function getAllCommitmentsToolTitles() {
18459
18460
  * Restricts an Updatable to a (2) BehaviorSubject variant
18460
18461
  *
18461
18462
  * @see Updatable
18463
+ *
18462
18464
  * @private internal utility <- TODO: [🧠] Maybe export from `@promptbook/types`
18463
18465
  */
18464
18466
  function asUpdatableSubject(value) {
@@ -18483,9 +18485,7 @@ function asUpdatableSubject(value) {
18483
18485
  return new BehaviorSubject(value);
18484
18486
  }
18485
18487
  }
18486
- /**
18487
- * TODO: [🧠] Maybe `BehaviorSubject` is too heavy for this use case, maybe just tuple `[value,setValue]` is enough
18488
- */
18488
+ // TODO: [🧠] Maybe `BehaviorSubject` is too heavy for this use case, maybe just tuple `[value,setValue]` is enough
18489
18489
 
18490
18490
  /**
18491
18491
  * Takes an item or an array of items and returns an array of items
@@ -18518,6 +18518,7 @@ const MULTIPLE_PROVIDER_PROFILE = {
18518
18518
  * Multiple LLM Execution Tools is a proxy server that uses multiple execution tools internally and exposes the executor interface externally.
18519
18519
  *
18520
18520
  * Note: Internal utility of `joinLlmExecutionTools` but exposed type
18521
+ *
18521
18522
  * @public exported from `@promptbook/core`
18522
18523
  */
18523
18524
  class MultipleLlmExecutionTools {
@@ -18680,16 +18681,16 @@ class MultipleLlmExecutionTools {
18680
18681
  * `MultipleLlmExecutionTools` object. It provides failover and aggregation logic:
18681
18682
  *
18682
18683
  * 1. **Failover**: When a model call is made, it tries providers in the order they were provided.
18683
- * If the first provider doesn't support the requested model or fails, it tries the next one.
18684
+ * If the first provider doesn't support the requested model or fails, it tries the next one.
18684
18685
  * 2. **Aggregation**: `listModels` returns a combined list of all models available from all providers.
18685
18686
  * 3. **Empty case**: If no tools are provided, it logs a warning (as Promptbook requires LLMs to function).
18686
18687
  *
18688
+ * Tip: You don't have to use this function directly, just pass an array of LlmExecutionTools to the `ExecutionTools`.
18689
+ *
18687
18690
  * @param title - A descriptive title for this collection of joined tools
18688
18691
  * @param llmExecutionTools - An array of execution tools to be joined
18689
18692
  * @returns A single unified execution tool wrapper
18690
18693
  *
18691
- * Tip: You don't have to use this function directly, just pass an array of LlmExecutionTools to the `ExecutionTools`.
18692
- *
18693
18694
  * @public exported from `@promptbook/core`
18694
18695
  */
18695
18696
  function joinLlmExecutionTools(title, ...llmExecutionTools) {
@@ -18726,10 +18727,8 @@ function joinLlmExecutionTools(title, ...llmExecutionTools) {
18726
18727
  }
18727
18728
  return new MultipleLlmExecutionTools(title || 'Multiple LLM Providers joined by `joinLlmExecutionTools`', ...llmExecutionTools);
18728
18729
  }
18729
- /**
18730
- * TODO: [🙆] `getSingleLlmExecutionTools` vs `joinLlmExecutionTools` - explain difference or pick one
18731
- * TODO: [👷‍♂️] Write a comprehensive manual about how to construct and use LLM execution tools in Promptbook
18732
- */
18730
+ // TODO: [🙆] `getSingleLlmExecutionTools` vs `joinLlmExecutionTools` - explain difference or pick one
18731
+ // TODO: [👷‍♂️] Write a comprehensive manual about how to construct and use LLM execution tools in Promptbook
18733
18732
 
18734
18733
  /**
18735
18734
  * Just returns the given `LlmExecutionTools` or joins multiple into one
@@ -18743,10 +18742,8 @@ function getSingleLlmExecutionTools(oneOrMoreLlmExecutionTools) {
18743
18742
  : joinLlmExecutionTools('Multiple LLM Providers joined by `getSingleLlmExecutionTools`', ..._llms);
18744
18743
  return llmTools;
18745
18744
  }
18746
- /**
18747
- * TODO: [🙆] `getSingleLlmExecutionTools` vs `joinLlmExecutionTools` - explain difference or pick one
18748
- * TODO: [👷‍♂️] Write a comprehensive manual about how to construct and use LLM execution tools in Promptbook
18749
- */
18745
+ // TODO: [🙆] `getSingleLlmExecutionTools` vs `joinLlmExecutionTools` - explain difference or pick one
18746
+ // TODO: [👷‍♂️] Write a comprehensive manual about how to construct and use LLM execution tools in Promptbook
18750
18747
 
18751
18748
  var PipelineCollection = [{title:"Prepare Knowledge from Markdown",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.book",formfactorName:"GENERIC",parameters:[{name:"knowledgeContent",description:"Markdown document content",isInput:true,isOutput:false},{name:"knowledgePieces",description:"The knowledge JSON object",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"knowledge",title:"Knowledge",content:"You are experienced data researcher, extract the important knowledge from the document.\n\n# Rules\n\n- Make pieces of information concise, clear, and easy to understand\n- One piece of information should be approximately 1 paragraph\n- Divide the paragraphs by markdown horizontal lines ---\n- Omit irrelevant information\n- Group redundant information\n- Write just extracted information, nothing else\n\n# The document\n\nTake information from this document:\n\n> {knowledgeContent}",resultingParameterName:"knowledgePieces",dependentParameterNames:["knowledgeContent"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sources:[{type:"BOOK",path:null,content:"# Prepare Knowledge from Markdown\n\n- PIPELINE URL `https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.book`\n- INPUT PARAMETER `{knowledgeContent}` Markdown document content\n- OUTPUT PARAMETER `{knowledgePieces}` The knowledge JSON object\n\n## Knowledge\n\n<!-- TODO: [🍆] -FORMAT JSON -->\n\n```markdown\nYou are experienced data researcher, extract the important knowledge from the document.\n\n# Rules\n\n- Make pieces of information concise, clear, and easy to understand\n- One piece of information should be approximately 1 paragraph\n- Divide the paragraphs by markdown horizontal lines ---\n- Omit irrelevant information\n- Group redundant information\n- Write just extracted information, nothing else\n\n# The document\n\nTake information from this document:\n\n> {knowledgeContent}\n```\n\n`-> {knowledgePieces}`\n"}],sourceFile:"./books/prepare-knowledge-from-markdown.book"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-keywords.book",formfactorName:"GENERIC",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"keywords",description:"Keywords separated by comma",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"knowledge",title:"Knowledge",content:"You are experienced data researcher, detect the important keywords in the document.\n\n# Rules\n\n- Write just keywords separated by comma\n\n# The document\n\nTake information from this document:\n\n> {knowledgePieceContent}",resultingParameterName:"keywords",dependentParameterNames:["knowledgePieceContent"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sources:[{type:"BOOK",path:null,content:"# Prepare Keywords\n\n- PIPELINE URL `https://promptbook.studio/promptbook/prepare-knowledge-keywords.book`\n- INPUT PARAMETER `{knowledgePieceContent}` The content\n- OUTPUT PARAMETER `{keywords}` Keywords separated by comma\n\n## Knowledge\n\n<!-- TODO: [🍆] -FORMAT JSON -->\n\n```markdown\nYou are experienced data researcher, detect the important keywords in the document.\n\n# Rules\n\n- Write just keywords separated by comma\n\n# The document\n\nTake information from this document:\n\n> {knowledgePieceContent}\n```\n\n`-> {keywords}`\n"}],sourceFile:"./books/prepare-knowledge-keywords.book"},{title:"Prepare Knowledge-piece Title",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-title.book",formfactorName:"GENERIC",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"title",description:"The title of the document",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"knowledge",title:"Knowledge",content:"You are experienced content creator, write best title for the document.\n\n# Rules\n\n- Write just title, nothing else\n- Write maximum 5 words for the title\n\n# The document\n\n> {knowledgePieceContent}",resultingParameterName:"title",expectations:{words:{min:1,max:8}},dependentParameterNames:["knowledgePieceContent"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sources:[{type:"BOOK",path:null,content:"# Prepare Knowledge-piece Title\n\n- PIPELINE URL `https://promptbook.studio/promptbook/prepare-knowledge-title.book`\n- INPUT PARAMETER `{knowledgePieceContent}` The content\n- OUTPUT PARAMETER `{title}` The title of the document\n\n## Knowledge\n\n- EXPECT MIN 1 WORD\n- EXPECT MAX 8 WORDS\n\n```markdown\nYou are experienced content creator, write best title for the document.\n\n# Rules\n\n- Write just title, nothing else\n- Write maximum 5 words for the title\n\n# The document\n\n> {knowledgePieceContent}\n```\n\n`-> {title}`\n"}],sourceFile:"./books/prepare-knowledge-title.book"},{title:"Prepare Persona",pipelineUrl:"https://promptbook.studio/promptbook/prepare-persona.book",formfactorName:"GENERIC",parameters:[{name:"availableModels",description:"List of available model names together with their descriptions as JSON",isInput:true,isOutput:false},{name:"personaDescription",description:"Description of the persona",isInput:true,isOutput:false},{name:"modelsRequirements",description:"Specific requirements for the model",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"make-model-requirements",title:"Make modelRequirements",content:"You are an experienced AI engineer, you need to find the best models for virtual assistants:\n\n## Example\n\n```json\n[\n {\n \"modelName\": \"gpt-4o\",\n \"systemMessage\": \"You are experienced AI engineer and helpful assistant.\",\n \"temperature\": 0.7\n },\n {\n \"modelName\": \"claude-3-5-sonnet\",\n \"systemMessage\": \"You are a friendly and knowledgeable chatbot.\",\n \"temperature\": 0.5\n }\n]\n```\n\n## Instructions\n\n- Your output format is JSON array\n- Sort best-fitting models first\n- Omit any models that are not suitable\n- Write just the JSON, no other text should be present\n- Array contain items with following keys:\n - `modelName`: The name of the model to use\n - `systemMessage`: The system message to provide context to the model\n - `temperature`: The sampling temperature to use\n\n### Key `modelName`\n\nHere are the available models:\n\n```json\n{availableModels}\n```\n\n### Key `systemMessage`\n\nThe system message is used to communicate instructions or provide context to the model at the beginning of a conversation. It is displayed in a different format compared to user messages, helping the model understand its role in the conversation. The system message typically guides the model's behavior, sets the tone, or specifies desired output from the model. By utilizing the system message effectively, users can steer the model towards generating more accurate and relevant responses.\n\nFor example:\n\n> You are an experienced AI engineer and helpful assistant.\n\n> You are a friendly and knowledgeable chatbot.\n\n### Key `temperature`\n\nThe sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.\n\nYou can pick a value between 0 and 2. For example:\n\n- `0.1`: Low temperature, extremely conservative and deterministic\n- `0.5`: Medium temperature, balanced between conservative and creative\n- `1.0`: High temperature, creative and bit random\n- `1.5`: Very high temperature, extremely creative and often chaotic and unpredictable\n- `2.0`: Maximum temperature, completely random and unpredictable, for some extreme creative use cases\n\n# The assistant\n\nTake this description of the persona:\n\n> {personaDescription}",resultingParameterName:"modelsRequirements",format:"JSON",dependentParameterNames:["availableModels","personaDescription"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sources:[{type:"BOOK",path:null,content:"# Prepare Persona\n\n- PIPELINE URL `https://promptbook.studio/promptbook/prepare-persona.book`\n- INPUT PARAMETER `{availableModels}` List of available model names together with their descriptions as JSON\n- INPUT PARAMETER `{personaDescription}` Description of the persona\n- OUTPUT PARAMETER `{modelsRequirements}` Specific requirements for the model\n\n## Make modelRequirements\n\n- FORMAT JSON\n\n```markdown\nYou are an experienced AI engineer, you need to find the best models for virtual assistants:\n\n## Example\n\n\\`\\`\\`json\n[\n {\n \"modelName\": \"gpt-4o\",\n \"systemMessage\": \"You are experienced AI engineer and helpful assistant.\",\n \"temperature\": 0.7\n },\n {\n \"modelName\": \"claude-3-5-sonnet\",\n \"systemMessage\": \"You are a friendly and knowledgeable chatbot.\",\n \"temperature\": 0.5\n }\n]\n\\`\\`\\`\n\n## Instructions\n\n- Your output format is JSON array\n- Sort best-fitting models first\n- Omit any models that are not suitable\n- Write just the JSON, no other text should be present\n- Array contain items with following keys:\n - `modelName`: The name of the model to use\n - `systemMessage`: The system message to provide context to the model\n - `temperature`: The sampling temperature to use\n\n### Key `modelName`\n\nHere are the available models:\n\n\\`\\`\\`json\n{availableModels}\n\\`\\`\\`\n\n### Key `systemMessage`\n\nThe system message is used to communicate instructions or provide context to the model at the beginning of a conversation. It is displayed in a different format compared to user messages, helping the model understand its role in the conversation. The system message typically guides the model's behavior, sets the tone, or specifies desired output from the model. By utilizing the system message effectively, users can steer the model towards generating more accurate and relevant responses.\n\nFor example:\n\n> You are an experienced AI engineer and helpful assistant.\n\n> You are a friendly and knowledgeable chatbot.\n\n### Key `temperature`\n\nThe sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.\n\nYou can pick a value between 0 and 2. For example:\n\n- `0.1`: Low temperature, extremely conservative and deterministic\n- `0.5`: Medium temperature, balanced between conservative and creative\n- `1.0`: High temperature, creative and bit random\n- `1.5`: Very high temperature, extremely creative and often chaotic and unpredictable\n- `2.0`: Maximum temperature, completely random and unpredictable, for some extreme creative use cases\n\n# The assistant\n\nTake this description of the persona:\n\n> {personaDescription}\n```\n\n`-> {modelsRequirements}`\n"}],sourceFile:"./books/prepare-persona.book"},{title:"Prepare Title",pipelineUrl:"https://promptbook.studio/promptbook/prepare-title.book",formfactorName:"GENERIC",parameters:[{name:"book",description:"The book to prepare the title for",isInput:true,isOutput:false},{name:"title",description:"Best title for the book",isInput:false,isOutput:true}],tasks:[{taskType:"PROMPT_TASK",name:"make-title",title:"Make title",content:"Make best title for given text which describes the workflow:\n\n## Rules\n\n- Write just title, nothing else\n- Title should be concise and clear - Write maximum ideally 2 words, maximum 5 words\n- Title starts with emoticon\n- Title should not mention the input and output of the workflow but the main purpose of the workflow\n _For example, not \"✍ Convert Knowledge-piece to title\" but \"✍ Title\"_\n\n## The workflow\n\n> {book}",resultingParameterName:"title",expectations:{words:{min:1,max:8},lines:{min:1,max:1}},dependentParameterNames:["book"]}],personas:[],preparations:[],knowledgeSources:[],knowledgePieces:[],sources:[{type:"BOOK",path:null,content:"# Prepare Title\n\n- PIPELINE URL `https://promptbook.studio/promptbook/prepare-title.book`\n- INPUT PARAMETER `{book}` The book to prepare the title for\n- OUTPUT PARAMETER `{title}` Best title for the book\n\n## Make title\n\n- EXPECT MIN 1 Word\n- EXPECT MAX 8 Words\n- EXPECT EXACTLY 1 Line\n\n```markdown\nMake best title for given text which describes the workflow:\n\n## Rules\n\n- Write just title, nothing else\n- Title should be concise and clear - Write maximum ideally 2 words, maximum 5 words\n- Title starts with emoticon\n- Title should not mention the input and output of the workflow but the main purpose of the workflow\n _For example, not \"✍ Convert Knowledge-piece to title\" but \"✍ Title\"_\n\n## The workflow\n\n> {book}\n```\n\n`-> {title}`\n"}],sourceFile:"./books/prepare-title.book"}];
18752
18749
 
@@ -18755,8 +18752,9 @@ var PipelineCollection = [{title:"Prepare Knowledge from Markdown",pipelineUrl:"
18755
18752
  *
18756
18753
  * @param content raw html code
18757
18754
  * @returns formatted html code
18758
- * @private withing the package because of HUGE size of prettier dependency
18759
18755
  * @deprecated Prettier removed from Promptbook due to package size
18756
+ *
18757
+ * @private withing the package because of HUGE size of prettier dependency
18760
18758
  */
18761
18759
  function prettifyMarkdown(content) {
18762
18760
  return (content + `\n\n<!-- Note: Prettier removed from Promptbook -->`);
@@ -18768,6 +18766,7 @@ function prettifyMarkdown(content) {
18768
18766
  * @deprecated TODO: [🥍][🧠] Backup original files in `PipelineJson` same as in Promptbook.studio
18769
18767
  * @param pipelineJson Promptbook in JSON format (.bookc)
18770
18768
  * @returns Promptbook in string format (.book.md)
18769
+ *
18771
18770
  * @public exported from `@promptbook/core`
18772
18771
  */
18773
18772
  function pipelineJsonToString(pipelineJson) {
@@ -18884,6 +18883,8 @@ function pipelineJsonToString(pipelineJson) {
18884
18883
  return validatePipelineString(pipelineString);
18885
18884
  }
18886
18885
  /**
18886
+ * Handles task parameter Json to string.
18887
+ *
18887
18888
  * @private internal utility of `pipelineJsonToString`
18888
18889
  */
18889
18890
  function taskParameterJsonToString(taskParameterJson) {
@@ -18894,13 +18895,11 @@ function taskParameterJsonToString(taskParameterJson) {
18894
18895
  }
18895
18896
  return parameterString;
18896
18897
  }
18897
- /**
18898
- * TODO: [🛋] Implement new features and commands into `pipelineJsonToString` + `taskParameterJsonToString` , use `stringifyCommand`
18899
- * TODO: [🧠] Is there a way to auto-detect missing features in pipelineJsonToString
18900
- * TODO: [🏛] Maybe make some markdown builder
18901
- * TODO: [🏛] Escape all
18902
- * TODO: [🧠] Should be in generated .book.md file GENERATOR_WARNING
18903
- */
18898
+ // TODO: [🛋] Implement new features and commands into `pipelineJsonToString` + `taskParameterJsonToString` , use `stringifyCommand`
18899
+ // TODO: [🧠] Is there a way to auto-detect missing features in pipelineJsonToString
18900
+ // TODO: [🏛] Maybe make some markdown builder
18901
+ // TODO: [🏛] Escape all
18902
+ // TODO: [🧠] Should be in generated .book.md file GENERATOR_WARNING
18904
18903
 
18905
18904
  /**
18906
18905
  * Validates PipelineJson if it is logically valid
@@ -18917,6 +18916,7 @@ function taskParameterJsonToString(taskParameterJson) {
18917
18916
  * @param pipeline valid or invalid PipelineJson
18918
18917
  * @returns the same pipeline if it is logically valid
18919
18918
  * @throws {PipelineLogicError} on logical error in the pipeline
18919
+ *
18920
18920
  * @public exported from `@promptbook/core`
18921
18921
  */
18922
18922
  function validatePipeline(pipeline) {
@@ -18941,6 +18941,8 @@ function validatePipeline(pipeline) {
18941
18941
  return pipeline;
18942
18942
  }
18943
18943
  /**
18944
+ * Validates pipeline inner function.
18945
+ *
18944
18946
  * @private internal function for `validatePipeline`
18945
18947
  */
18946
18948
  function validatePipeline_InnerFunction(pipeline) {
@@ -19185,20 +19187,19 @@ function validatePipeline_InnerFunction(pipeline) {
19185
19187
  * > * - ...
19186
19188
  * > ex port function validatePipeline(promptbook: really_unknown): asserts promptbook is PipelineJson {
19187
19189
  */
19188
- /**
19189
- * TODO: [🧳][main] !!4 Validate that all examples match expectations
19190
- * TODO: [🧳][🐝][main] !!4 Validate that knowledge is valid (non-void)
19191
- * TODO: [🧳][main] !!4 Validate that persona can be used only with CHAT variant
19192
- * TODO: [🧳][main] !!4 Validate that parameter with reserved name not used RESERVED_PARAMETER_NAMES
19193
- * TODO: [🧳][main] !!4 Validate that reserved parameter is not used as joker
19194
- * TODO: [🧠] Validation not only logic itself but imports around - files and websites and rerefenced pipelines exists
19195
- * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
19196
- */
19190
+ // TODO: [🧳][main] !!4 Validate that all examples match expectations
19191
+ // TODO: [🧳][🐝][main] !!4 Validate that knowledge is valid (non-void)
19192
+ // TODO: [🧳][main] !!4 Validate that persona can be used only with CHAT variant
19193
+ // TODO: [🧳][main] !!4 Validate that parameter with reserved name not used RESERVED_PARAMETER_NAMES
19194
+ // TODO: [🧳][main] !!4 Validate that reserved parameter is not used as joker
19195
+ // TODO: [🧠] Validation not only logic itself but imports around - files and websites and rerefenced pipelines exists
19196
+ // TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
19197
19197
 
19198
19198
  /**
19199
19199
  * Unprepare just strips the preparation data of the pipeline
19200
19200
  *
19201
19201
  * @deprecated In future version this function will be removed or deprecated
19202
+ *
19202
19203
  * @public exported from `@promptbook/core`
19203
19204
  */
19204
19205
  function unpreparePipeline(pipeline) {
@@ -19227,18 +19228,17 @@ function unpreparePipeline(pipeline) {
19227
19228
  },
19228
19229
  });
19229
19230
  }
19230
- /**
19231
- * TODO: [🧿] Maybe do same process with same granularity and subfinctions as `preparePipeline`
19232
- * TODO: Write tests for `preparePipeline`
19233
- * TODO: [🍙] Make some standard order of json properties
19234
- */
19231
+ // TODO: [🧿] Maybe do same process with same granularity and subfinctions as `preparePipeline`
19232
+ // TODO: Write tests for `preparePipeline`
19233
+ // TODO: [🍙] Make some standard order of json properties
19235
19234
 
19236
19235
  /**
19237
19236
  * Library of pipelines that groups together pipelines for an application.
19238
19237
  * This implementation is a very thin wrapper around the Array / Map of pipelines.
19239
19238
  *
19240
- * @private internal function of `createPipelineCollectionFromJson`, use `createPipelineCollectionFromJson` instead
19241
19239
  * @see https://github.com/webgptorg/pipeline#pipeline-collection
19240
+ *
19241
+ * @private internal function of `createPipelineCollectionFromJson`, use `createPipelineCollectionFromJson` instead
19242
19242
  */
19243
19243
  class SimplePipelineCollection {
19244
19244
  /**
@@ -19342,6 +19342,7 @@ class SimplePipelineCollection {
19342
19342
  *
19343
19343
  * @param promptbookSources
19344
19344
  * @returns PipelineCollection
19345
+ *
19345
19346
  * @public exported from `@promptbook/core`
19346
19347
  */
19347
19348
  function createPipelineCollectionFromJson(...promptbooks) {
@@ -19395,6 +19396,7 @@ function isPipelinePrepared(pipeline) {
19395
19396
  *
19396
19397
  * @param executionResult - The partial result of the Promptbook execution
19397
19398
  * @throws {PipelineExecutionError} If the execution is not successful or if multiple errors occurred
19399
+ *
19398
19400
  * @private internal helper function of `asPromise` method of `ExecutionTask`
19399
19401
  */
19400
19402
  function assertsTaskSuccessful(executionResult) {
@@ -19425,9 +19427,7 @@ function assertsTaskSuccessful(executionResult) {
19425
19427
  `));
19426
19428
  }
19427
19429
  }
19428
- /**
19429
- * TODO: [🧠] Can this return type be better typed than void
19430
- */
19430
+ // TODO: [🧠] Can this return type be better typed than void
19431
19431
 
19432
19432
  /**
19433
19433
  * Helper to create a new task
@@ -19618,10 +19618,8 @@ function createTask(options) {
19618
19618
  },
19619
19619
  };
19620
19620
  }
19621
- /**
19622
- * TODO: Maybe allow to terminate the task and add getter `isFinished` or `status`
19623
- * TODO: [🐚] Split into more files and make `PrepareTask` & `RemoteTask` + split the function
19624
- */
19621
+ // TODO: Maybe allow to terminate the task and add getter `isFinished` or `status`
19622
+ // TODO: [🐚] Split into more files and make `PrepareTask` & `RemoteTask` + split the function
19625
19623
 
19626
19624
  /**
19627
19625
  * Represents the uncertain value
@@ -19689,9 +19687,7 @@ const UNCERTAIN_USAGE = $deepFreeze({
19689
19687
  pagesCount: UNCERTAIN_ZERO_VALUE,
19690
19688
  },
19691
19689
  });
19692
- /**
19693
- * Note: [💞] Ignore a discrepancy between file name and entity name
19694
- */
19690
+ // Note: [💞] Ignore a discrepancy between file name and entity name
19695
19691
 
19696
19692
  /**
19697
19693
  * Function `addUsage` will add multiple usages into one
@@ -19756,6 +19752,7 @@ function addUsage(...usageItems) {
19756
19752
  *
19757
19753
  * @param llmTools - The LLM tools to be intercepted and tracked
19758
19754
  * @returns Full proxy of the tools with added usage tracking capabilities
19755
+ *
19759
19756
  * @public exported from `@promptbook/core`
19760
19757
  */
19761
19758
  function countUsage(llmTools) {
@@ -19853,13 +19850,13 @@ function countUsage(llmTools) {
19853
19850
  * Global registry for storing metadata about all available scrapers and converters.
19854
19851
  *
19855
19852
  * Note: `$` is used to indicate that this interacts with the global scope.
19853
+ *
19856
19854
  * @singleton Only one instance of each register is created per build, but there can be more in different contexts (e.g., tests).
19855
+ *
19857
19856
  * @public exported from `@promptbook/core`
19858
19857
  */
19859
19858
  const $scrapersMetadataRegister = new $Register('scrapers_metadata');
19860
- /**
19861
- * TODO: [®] DRY Register logic
19862
- */
19859
+ // TODO: [®] DRY Register logic
19863
19860
 
19864
19861
  /**
19865
19862
  * Creates a message with all registered scrapers
@@ -19944,9 +19941,7 @@ function $registeredScrapersMessage(availableScrapers) {
19944
19941
 
19945
19942
  `);
19946
19943
  }
19947
- /**
19948
- * TODO: [®] DRY Register logic
19949
- */
19944
+ // TODO: [®] DRY Register logic
19950
19945
 
19951
19946
  /**
19952
19947
  * Creates unique name for the source
@@ -19965,9 +19960,7 @@ function knowledgeSourceContentToName(knowledgeSourceContent) {
19965
19960
  // <- TODO: Use MAX_FILENAME_LENGTH
19966
19961
  return name;
19967
19962
  }
19968
- /**
19969
- * TODO: [🐱‍🐉][🧠] Make some smart crop NOT source-i-m-pavol-a-develop-... BUT source-i-m-pavol-a-developer-...
19970
- */
19963
+ // TODO: [🐱‍🐉][🧠] Make some smart crop NOT source-i-m-pavol-a-develop-... BUT source-i-m-pavol-a-developer-...
19971
19964
 
19972
19965
  /**
19973
19966
  * Converts a name to a properly formatted subfolder path for cache storage.
@@ -19998,11 +19991,9 @@ async function isFileExisting(filename, fs) {
19998
19991
  .catch(() => false);
19999
19992
  return isFile;
20000
19993
  }
20001
- /**
20002
- * Note: Not [~🟢~] because it is not directly dependent on `fs
20003
- * TODO: [🐠] This can be a validator - with variants that return true/false and variants that throw errors with meaningless messages
20004
- * TODO: [🖇] What about symlinks?
20005
- */
19994
+ // Note: Not [~🟢~] because it is not directly dependent on `fs
19995
+ // TODO: [🐠] This can be a validator - with variants that return true/false and variants that throw errors with meaningless messages
19996
+ // TODO: [🖇] What about symlinks?
20006
19997
 
20007
19998
  /**
20008
19999
  * Convert mime type to file extension
@@ -20042,9 +20033,7 @@ const promptbookFetch = async (urlOrRequest, init) => {
20042
20033
  `));
20043
20034
  }
20044
20035
  };
20045
- /**
20046
- * TODO: [🧠] Maybe rename because it is not used only for scrapers but also in `$getCompiledBook`
20047
- */
20036
+ // TODO: [🧠] Maybe rename because it is not used only for scrapers but also in `$getCompiledBook`
20048
20037
 
20049
20038
  /**
20050
20039
  * Factory function that creates a handler for processing knowledge sources.
@@ -20264,6 +20253,7 @@ async function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
20264
20253
  * Prepares the knowledge pieces
20265
20254
  *
20266
20255
  * @see https://github.com/webgptorg/promptbook/discussions/41
20256
+ *
20267
20257
  * @public exported from `@promptbook/core`
20268
20258
  */
20269
20259
  async function prepareKnowledgePieces(knowledgeSources, tools, options) {
@@ -20405,25 +20395,24 @@ async function prepareTasks(pipeline, tools, options) {
20405
20395
  });
20406
20396
  return { tasksPrepared };
20407
20397
  }
20408
- /**
20409
- * TODO: [😂] Adding knowledge should be convert to async high-level abstractions, similar thing with expectations to sync high-level abstractions
20410
- * TODO: [🧠] Add context to each task (if missing)
20411
- * TODO: [🧠] What is better name `prepareTask` or `prepareTaskAndParameters`
20412
- * TODO: [♨][main] !!3 Prepare index the examples and maybe tasks
20413
- * TODO: Write tests for `preparePipeline`
20414
- * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
20415
- * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time
20416
- * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
20417
- */
20398
+ // TODO: [😂] Adding knowledge should be convert to async high-level abstractions, similar thing with expectations to sync high-level abstractions
20399
+ // TODO: [🧠] Add context to each task (if missing)
20400
+ // TODO: [🧠] What is better name `prepareTask` or `prepareTaskAndParameters`
20401
+ // TODO: [][main] !!3 Prepare index the examples and maybe tasks
20402
+ // TODO: Write tests for `preparePipeline`
20403
+ // TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
20404
+ // TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time
20405
+ // TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
20418
20406
 
20419
20407
  /**
20420
20408
  * Prepare pipeline locally
20421
20409
  *
20422
- * @see https://github.com/webgptorg/promptbook/discussions/196
20423
- *
20424
20410
  * Note: This function does not validate logic of the pipeline
20425
20411
  * Note: This function acts as part of compilation process
20426
20412
  * Note: When the pipeline is already prepared, it returns the same pipeline
20413
+ *
20414
+ * @see https://github.com/webgptorg/promptbook/discussions/196
20415
+ *
20427
20416
  * @public exported from `@promptbook/core`
20428
20417
  */
20429
20418
  async function preparePipeline(pipeline, tools, options) {
@@ -20567,6 +20556,7 @@ async function preparePipeline(pipeline, tools, options) {
20567
20556
  * @param script from which to extract the variables
20568
20557
  * @returns the list of variable names
20569
20558
  * @throws {ParseError} if the script is invalid
20559
+ *
20570
20560
  * @public exported from `@promptbook/javascript`
20571
20561
  */
20572
20562
  function extractVariablesFromJavascript(script) {
@@ -20632,9 +20622,7 @@ function extractVariablesFromJavascript(script) {
20632
20622
  }
20633
20623
  return variables;
20634
20624
  }
20635
- /**
20636
- * TODO: [🔣] Support for multiple languages - python, java,...
20637
- */
20625
+ // TODO: [🔣] Support for multiple languages - python, java,...
20638
20626
 
20639
20627
  /**
20640
20628
  * Parses the task and returns the set of all used parameters
@@ -20642,6 +20630,7 @@ function extractVariablesFromJavascript(script) {
20642
20630
  * @param task the task with used parameters
20643
20631
  * @returns the set of parameter names
20644
20632
  * @throws {ParseError} if the script is invalid
20633
+ *
20645
20634
  * @public exported from `@promptbook/core` <- Note: [👖] This utility is so tightly interconnected with the Promptbook that it is not exported as util but in core
20646
20635
  */
20647
20636
  function extractParameterNamesFromTask(task) {
@@ -20682,9 +20671,7 @@ function extractParameterNamesFromTask(task) {
20682
20671
  }
20683
20672
  return parameterNames;
20684
20673
  }
20685
- /**
20686
- * TODO: [🔣] If script require contentLanguage
20687
- */
20674
+ // TODO: [🔣] If script require contentLanguage
20688
20675
 
20689
20676
  /**
20690
20677
  * Contains configuration options for parsing and generating CSV files, such as delimiters and quoting rules.
@@ -20717,8 +20704,9 @@ function csvParse(value /* <- TODO: string_csv */, settings, schema /* <- TODO:
20717
20704
  /**
20718
20705
  * Definition for CSV spreadsheet
20719
20706
  *
20707
+ * TODO: [🏢] Export from package `@promptbook/csv`
20708
+ *
20720
20709
  * @public exported from `@promptbook/core`
20721
- * <- TODO: [🏢] Export from package `@promptbook/csv`
20722
20710
  */
20723
20711
  const CsvFormatParser = {
20724
20712
  formatName: 'CSV',
@@ -20808,13 +20796,11 @@ const CsvFormatParser = {
20808
20796
  },
20809
20797
  ],
20810
20798
  };
20811
- /**
20812
- * TODO: [🍓] In `CsvFormatParser` implement simple `isValid`
20813
- * TODO: [🍓] In `CsvFormatParser` implement partial `canBeValid`
20814
- * TODO: [🍓] In `CsvFormatParser` implement `heal
20815
- * TODO: [🍓] In `CsvFormatParser` implement `subvalueParsers`
20816
- * TODO: [🏢] Allow to expect something inside CSV objects and other formats
20817
- */
20799
+ // TODO: [🍓] In `CsvFormatParser` implement simple `isValid`
20800
+ // TODO: [🍓] In `CsvFormatParser` implement partial `canBeValid`
20801
+ // TODO: [🍓] In `CsvFormatParser` implement `heal
20802
+ // TODO: [🍓] In `CsvFormatParser` implement `subvalueParsers`
20803
+ // TODO: [🏢] Allow to expect something inside CSV objects and other formats
20818
20804
 
20819
20805
  /**
20820
20806
  * Definition for JSON format
@@ -20835,17 +20821,15 @@ const JsonFormatParser = {
20835
20821
  },
20836
20822
  subvalueParsers: [],
20837
20823
  };
20838
- /**
20839
- * TODO: [🧠] Maybe proper instance of object
20840
- * TODO: [0] Make string_serialized_json
20841
- * TODO: [1] Make type for JSON Settings and Schema
20842
- * TODO: [🧠] What to use for validating JSONs - JSON Schema, ZoD, typescript types/interfaces,...?
20843
- * TODO: [🍓] In `JsonFormatParser` implement simple `isValid`
20844
- * TODO: [🍓] In `JsonFormatParser` implement partial `canBeValid`
20845
- * TODO: [🍓] In `JsonFormatParser` implement `heal
20846
- * TODO: [🍓] In `JsonFormatParser` implement `subvalueParsers`
20847
- * TODO: [🏢] Allow to expect something inside JSON objects and other formats
20848
- */
20824
+ // TODO: [🧠] Maybe proper instance of object
20825
+ // TODO: [0] Make string_serialized_json
20826
+ // TODO: [1] Make type for JSON Settings and Schema
20827
+ // TODO: [🧠] What to use for validating JSONs - JSON Schema, ZoD, typescript types/interfaces,...?
20828
+ // TODO: [🍓] In `JsonFormatParser` implement simple `isValid`
20829
+ // TODO: [🍓] In `JsonFormatParser` implement partial `canBeValid`
20830
+ // TODO: [🍓] In `JsonFormatParser` implement `heal
20831
+ // TODO: [🍓] In `JsonFormatParser` implement `subvalueParsers`
20832
+ // TODO: [🏢] Allow to expect something inside JSON objects and other formats
20849
20833
 
20850
20834
  /**
20851
20835
  * Definition for any text - this will be always valid
@@ -20883,15 +20867,13 @@ const TextFormatParser = {
20883
20867
  // <- TODO: [🧠][🤠] Here should be all words, characters, lines, paragraphs, pages available as subvalues
20884
20868
  ],
20885
20869
  };
20886
- /**
20887
- * TODO: [1] Make type for XML Text and Schema
20888
- * TODO: [🧠][🤠] Here should be all words, characters, lines, paragraphs, pages available as subvalues
20889
- * TODO: [🍓] In `TextFormatParser` implement simple `isValid`
20890
- * TODO: [🍓] In `TextFormatParser` implement partial `canBeValid`
20891
- * TODO: [🍓] In `TextFormatParser` implement `heal
20892
- * TODO: [🍓] In `TextFormatParser` implement `subvalueParsers`
20893
- * TODO: [🏢] Allow to expect something inside each item of list and other formats
20894
- */
20870
+ // TODO: [1] Make type for XML Text and Schema
20871
+ // TODO: [🧠][🤠] Here should be all words, characters, lines, paragraphs, pages available as subvalues
20872
+ // TODO: [🍓] In `TextFormatParser` implement simple `isValid`
20873
+ // TODO: [🍓] In `TextFormatParser` implement partial `canBeValid`
20874
+ // TODO: [🍓] In `TextFormatParser` implement `heal
20875
+ // TODO: [🍓] In `TextFormatParser` implement `subvalueParsers`
20876
+ // TODO: [🏢] Allow to expect something inside each item of list and other formats
20895
20877
 
20896
20878
  /**
20897
20879
  * Definition for XML format
@@ -20912,17 +20894,15 @@ const XmlFormatParser = {
20912
20894
  },
20913
20895
  subvalueParsers: [],
20914
20896
  };
20915
- /**
20916
- * TODO: [🧠] Maybe proper instance of object
20917
- * TODO: [0] Make string_serialized_xml
20918
- * TODO: [1] Make type for XML Settings and Schema
20919
- * TODO: [🧠] What to use for validating XMLs - XSD,...
20920
- * TODO: [🍓] In `XmlFormatParser` implement simple `isValid`
20921
- * TODO: [🍓] In `XmlFormatParser` implement partial `canBeValid`
20922
- * TODO: [🍓] In `XmlFormatParser` implement `heal
20923
- * TODO: [🍓] In `XmlFormatParser` implement `subvalueParsers`
20924
- * TODO: [🏢] Allow to expect something inside XML and other formats
20925
- */
20897
+ // TODO: [🧠] Maybe proper instance of object
20898
+ // TODO: [0] Make string_serialized_xml
20899
+ // TODO: [1] Make type for XML Settings and Schema
20900
+ // TODO: [🧠] What to use for validating XMLs - XSD,...
20901
+ // TODO: [🍓] In `XmlFormatParser` implement simple `isValid`
20902
+ // TODO: [🍓] In `XmlFormatParser` implement partial `canBeValid`
20903
+ // TODO: [🍓] In `XmlFormatParser` implement `heal
20904
+ // TODO: [🍓] In `XmlFormatParser` implement `subvalueParsers`
20905
+ // TODO: [🏢] Allow to expect something inside XML and other formats
20926
20906
 
20927
20907
  /**
20928
20908
  * Definitions for all formats supported by Promptbook
@@ -20930,9 +20910,7 @@ const XmlFormatParser = {
20930
20910
  * @private internal index of `...` <- TODO [🏢]
20931
20911
  */
20932
20912
  const FORMAT_DEFINITIONS = [JsonFormatParser, XmlFormatParser, TextFormatParser, CsvFormatParser];
20933
- /**
20934
- * Note: [💞] Ignore a discrepancy between file name and entity name
20935
- */
20913
+ // Note: [💞] Ignore a discrepancy between file name and entity name
20936
20914
 
20937
20915
  /**
20938
20916
  * Maps available parameters to expected parameters for a pipeline task.
@@ -20942,6 +20920,7 @@ const FORMAT_DEFINITIONS = [JsonFormatParser, XmlFormatParser, TextFormatParser,
20942
20920
  * 2) Then, if there are unmatched expected and available parameters, map them by order.
20943
20921
  *
20944
20922
  * @throws {PipelineExecutionError} If the number of unmatched expected and available parameters does not match, or mapping is ambiguous.
20923
+ *
20945
20924
  * @private within the repository used in `createPipelineExecutor`
20946
20925
  */
20947
20926
  function mapAvailableToExpectedParameters(options) {
@@ -21012,6 +20991,7 @@ function mapAvailableToExpectedParameters(options) {
21012
20991
  * @param markdown any valid markdown
21013
20992
  * @returns code blocks with language and content
21014
20993
  * @throws {ParseError} if block is not closed properly
20994
+ *
21015
20995
  * @public exported from `@promptbook/markdown-utils`
21016
20996
  */
21017
20997
  function extractAllBlocksFromMarkdown(markdown) {
@@ -21062,9 +21042,7 @@ function extractAllBlocksFromMarkdown(markdown) {
21062
21042
  }
21063
21043
  return codeBlocks;
21064
21044
  }
21065
- /**
21066
- * TODO: Maybe name for `blockNotation` instead of '```' and '>'
21067
- */
21045
+ // TODO: Maybe name for `blockNotation` instead of '```' and '>'
21068
21046
 
21069
21047
  /**
21070
21048
  * Extracts extracts exactly one valid JSON code block
@@ -21080,8 +21058,9 @@ function extractAllBlocksFromMarkdown(markdown) {
21080
21058
  * - `extractOneBlockFromMarkdown` extracts exactly one code block with language of the code block
21081
21059
  * - `extractAllBlocksFromMarkdown` extracts all code blocks with language of the code block
21082
21060
  *
21083
- * @public exported from `@promptbook/markdown-utils`
21084
21061
  * @throws {ParseError} if there is no valid JSON block in the markdown
21062
+ *
21063
+ * @public exported from `@promptbook/markdown-utils`
21085
21064
  */
21086
21065
  function extractJsonBlock(markdown) {
21087
21066
  if (isValidJsonString(markdown)) {
@@ -21097,10 +21076,8 @@ function extractJsonBlock(markdown) {
21097
21076
  }
21098
21077
  return jsonBlocks[0].content;
21099
21078
  }
21100
- /**
21101
- * TODO: Add some auto-healing logic + extract YAML, JSON5, TOML, etc.
21102
- * TODO: [🏢] Make this logic part of `JsonFormatParser` or `isValidJsonString`
21103
- */
21079
+ // TODO: Add some auto-healing logic + extract YAML, JSON5, TOML, etc.
21080
+ // TODO: [🏢] Make this logic part of `JsonFormatParser` or `isValidJsonString`
21104
21081
 
21105
21082
  /**
21106
21083
  * Function checkExpectations will check if the expectations on given value are met
@@ -21111,6 +21088,7 @@ function extractJsonBlock(markdown) {
21111
21088
  *
21112
21089
  * @throws {ExpectError} if the expectations are not met
21113
21090
  * @returns {void} Nothing
21091
+ *
21114
21092
  * @private internal function of `createPipelineExecutor`
21115
21093
  */
21116
21094
  function checkExpectations(expectations, value) {
@@ -21124,11 +21102,9 @@ function checkExpectations(expectations, value) {
21124
21102
  }
21125
21103
  }
21126
21104
  }
21127
- /**
21128
- * TODO: [💝] Unite object for expecting amount and format
21129
- * TODO: [🧠][🤠] This should be part of `TextFormatParser`
21130
- * Note: [💝] and [🤠] are interconnected together
21131
- */
21105
+ // TODO: [💝] Unite object for expecting amount and format
21106
+ // TODO: [🧠][🤠] This should be part of `TextFormatParser`
21107
+ // Note: [💝] and [🤠] are interconnected together
21132
21108
 
21133
21109
  /**
21134
21110
  * Validates a prompt result against expectations and format requirements.
@@ -21139,6 +21115,7 @@ function checkExpectations(expectations, value) {
21139
21115
  *
21140
21116
  * @param options - The validation options including result string, expectations, and format
21141
21117
  * @returns Validation result with processed string and validity status
21118
+ *
21142
21119
  * @private internal function of `createPipelineExecutor` and `cacheLlmTools`
21143
21120
  */
21144
21121
  function validatePromptResult(options) {
@@ -21201,6 +21178,7 @@ function validatePromptResult(options) {
21201
21178
  *
21202
21179
  * @param options - The options for execution, including task, parameters, pipeline, and configuration.
21203
21180
  * @returns The result string of the executed task.
21181
+ *
21204
21182
  * @private internal utility of `createPipelineExecutor`
21205
21183
  */
21206
21184
  async function executeAttempts(options) {
@@ -21524,9 +21502,7 @@ async function executeAttempts(options) {
21524
21502
  }
21525
21503
  return $ongoingTaskResult.$resultString;
21526
21504
  }
21527
- /**
21528
- * TODO: Break into smaller functions
21529
- */
21505
+ // TODO: Break into smaller functions
21530
21506
 
21531
21507
  /**
21532
21508
  * Executes a pipeline task that requires mapping or iterating over subvalues of a parameter (such as rows in a CSV).
@@ -21669,6 +21645,7 @@ async function executeFormatSubvalues(options) {
21669
21645
  *
21670
21646
  * @param task - The task for which the context is being generated. This should be a deeply immutable TaskJson object.
21671
21647
  * @returns The context as a string, formatted as markdown and parameter value.
21648
+ *
21672
21649
  * @private internal utility of `createPipelineExecutor`
21673
21650
  */
21674
21651
  async function getContextForTask(task) {
@@ -21706,7 +21683,6 @@ function computeCosineSimilarity(embeddingVector1, embeddingVector2) {
21706
21683
  }
21707
21684
 
21708
21685
  /**
21709
- *
21710
21686
  * @param knowledgePieces
21711
21687
  * @returns
21712
21688
  *
@@ -21787,10 +21763,8 @@ async function getKnowledgeForTask(options) {
21787
21763
  return knowledgePiecesToString(preparedPipeline.knowledgePieces);
21788
21764
  }
21789
21765
  }
21790
- /**
21791
- * TODO: [♨] Implement Better - use keyword search
21792
- * TODO: [♨] Examples of values
21793
- */
21766
+ // TODO: [♨] Implement Better - use keyword search
21767
+ // TODO: [♨] Examples of values
21794
21768
 
21795
21769
  /**
21796
21770
  * Retrieves all reserved parameters for a given pipeline task, including context, knowledge, examples, and metadata.
@@ -21943,9 +21917,7 @@ async function executeTask(options) {
21943
21917
  resultString,
21944
21918
  });
21945
21919
  }
21946
- /**
21947
- * TODO: [🤹‍♂️]
21948
- */
21920
+ // TODO: [🤹‍♂️]
21949
21921
 
21950
21922
  /**
21951
21923
  * Filters and returns only the output parameters from the provided pipeline execution options.
@@ -22275,6 +22247,7 @@ async function executePipeline(options) {
22275
22247
  *
22276
22248
  * @returns The executor function
22277
22249
  * @throws {PipelineLogicError} on logical error in the pipeline
22250
+ *
22278
22251
  * @public exported from `@promptbook/core`
22279
22252
  */
22280
22253
  function createPipelineExecutor(options) {
@@ -22428,6 +22401,7 @@ function createPipelineExecutor(options) {
22428
22401
  * Prepares the persona for the pipeline
22429
22402
  *
22430
22403
  * @see https://github.com/webgptorg/promptbook/discussions/22
22404
+ *
22431
22405
  * @public exported from `@promptbook/core`
22432
22406
  */
22433
22407
  async function preparePersona(personaDescription, tools, options) {
@@ -22484,13 +22458,11 @@ async function preparePersona(personaDescription, tools, options) {
22484
22458
  modelsRequirements,
22485
22459
  };
22486
22460
  }
22487
- /**
22488
- * TODO: [😩] DRY `preparePersona` and `selectBestModelFromAvailable`
22489
- * TODO: [🔃][main] If the persona was prepared with different version or different set of models, prepare it once again
22490
- * TODO: [🏢] Check validity of `modelName` in pipeline
22491
- * TODO: [🏢] Check validity of `systemMessage` in pipeline
22492
- * TODO: [🏢] Check validity of `temperature` in pipeline
22493
- */
22461
+ // TODO: [😩] DRY `preparePersona` and `selectBestModelFromAvailable`
22462
+ // TODO: [🔃][main] If the persona was prepared with different version or different set of models, prepare it once again
22463
+ // TODO: [🏢] Check validity of `modelName` in pipeline
22464
+ // TODO: [🏢] Check validity of `systemMessage` in pipeline
22465
+ // TODO: [🏢] Check validity of `temperature` in pipeline
22494
22466
 
22495
22467
  /**
22496
22468
  * Creates an empty/basic agent model requirements object
@@ -22525,12 +22497,11 @@ function createBasicAgentModelRequirements(agentName) {
22525
22497
  systemMessage: `You are ${agentName || 'AI Agent'}`,
22526
22498
  };
22527
22499
  }
22528
- /**
22529
- * TODO: [🐤] Deduplicate `AgentModelRequirements` and `ModelRequirements` model requirements
22530
- */
22500
+ // TODO: [🐤] Deduplicate `AgentModelRequirements` and `ModelRequirements` model requirements
22531
22501
 
22532
22502
  /**
22533
22503
  * Gets a commitment definition by its type
22504
+ *
22534
22505
  * @param type The commitment type to look up
22535
22506
  * @returns The commitment definition or null if not found
22536
22507
  *
@@ -22909,7 +22880,9 @@ async function createAgentModelRequirementsWithCommitments(agentSource, modelNam
22909
22880
  };
22910
22881
  }
22911
22882
  /**
22912
- * @private Attempts to upload inline knowledge entries, falling back to legacy data URLs when the upload fails or is not configured.
22883
+ * Attempts to upload inline knowledge entries, falling back to legacy data URLs when the upload fails or is not configured.
22884
+ *
22885
+ * @private
22913
22886
  */
22914
22887
  async function applyPendingInlineKnowledgeSources(requirements, uploader) {
22915
22888
  var _a;
@@ -22930,6 +22903,9 @@ async function applyPendingInlineKnowledgeSources(requirements, uploader) {
22930
22903
  _metadata: stripInlineKnowledgeMetadata(requirements._metadata),
22931
22904
  };
22932
22905
  }
22906
+ /**
22907
+ * Handles upload inline knowledge source with fallback.
22908
+ */
22933
22909
  async function uploadInlineKnowledgeSourceWithFallback(inlineSource, uploader) {
22934
22910
  try {
22935
22911
  return await uploader(inlineSource);
@@ -22942,6 +22918,9 @@ async function uploadInlineKnowledgeSourceWithFallback(inlineSource, uploader) {
22942
22918
  return inlineKnowledgeSourceToDataUrl(inlineSource);
22943
22919
  }
22944
22920
  }
22921
+ /**
22922
+ * Extracts inline knowledge sources.
22923
+ */
22945
22924
  function extractInlineKnowledgeSources(metadata) {
22946
22925
  if (!metadata) {
22947
22926
  return [];
@@ -22949,6 +22928,9 @@ function extractInlineKnowledgeSources(metadata) {
22949
22928
  const value = metadata.inlineKnowledgeSources;
22950
22929
  return Array.isArray(value) ? value : [];
22951
22930
  }
22931
+ /**
22932
+ * Strips inline knowledge metadata.
22933
+ */
22952
22934
  function stripInlineKnowledgeMetadata(metadata) {
22953
22935
  if (!metadata || !Object.prototype.hasOwnProperty.call(metadata, 'inlineKnowledgeSources')) {
22954
22936
  return metadata;
@@ -22999,6 +22981,7 @@ function isBinaryMimeType(mimeType) {
22999
22981
  * @param availableModels - Models that could fulfill the agent.
23000
22982
  * @param llmTools - Execution tools used when selecting a best model.
23001
22983
  * @param options - Optional hooks such as the agent reference resolver.
22984
+ *
23002
22985
  * @public exported from `@promptbook/core`
23003
22986
  */
23004
22987
  async function createAgentModelRequirements(agentSource, modelName, availableModels, llmTools, options) {
@@ -23018,6 +23001,7 @@ async function createAgentModelRequirements(agentSource, modelName, availableMod
23018
23001
  * @param agentSource The agent source to derive persona description from
23019
23002
  * @param llmTools LLM tools for preparing persona
23020
23003
  * @returns The name of the best selected model
23004
+ *
23021
23005
  * @private function of `createAgentModelRequirements`
23022
23006
  */
23023
23007
  async function selectBestModelUsingPersona(agentSource, llmTools) {
@@ -23153,6 +23137,7 @@ function normalizeChatAttachment(rawAttachment) {
23153
23137
  *
23154
23138
  * @param {unknown} rawAttachments - The raw attachments to normalize.
23155
23139
  * @returns {Array<ChatAttachment>} The normalized attachments.
23140
+ *
23156
23141
  * @public exported from `@promptbook/core`
23157
23142
  */
23158
23143
  function normalizeChatAttachments(rawAttachments) {
@@ -23197,6 +23182,7 @@ function formatChatAttachmentLine(attachment) {
23197
23182
  *
23198
23183
  * @param {ReadonlyArray<ChatAttachment>} attachments - The attachments to format.
23199
23184
  * @returns {string} The formatted context.
23185
+ *
23200
23186
  * @public exported from `@promptbook/core`
23201
23187
  */
23202
23188
  function formatChatAttachmentContext(attachments) {
@@ -23217,6 +23203,7 @@ function formatChatAttachmentContext(attachments) {
23217
23203
  * @param {number} maxBytes - Maximum number of bytes to capture.
23218
23204
  * @param {{ captureOverflowByte?: boolean }} [options] - Optional capture behavior.
23219
23205
  * @returns {Promise<{ bytes: Uint8Array }>} Captured bytes, optionally including one overflow byte.
23206
+ *
23220
23207
  * @private internal utility for bounded response reads
23221
23208
  */
23222
23209
  async function readResponseBytes(response, maxBytes, options = {}) {
@@ -23313,6 +23300,7 @@ function createAttachmentContentFailure(attachment, reason, options = {}) {
23313
23300
  * @param {number} maxInlineCharacters - Maximum number of characters to inline.
23314
23301
  * @param {ResolveChatAttachmentOptions} options - Options for resolution.
23315
23302
  * @returns {Promise<ResolvedChatAttachmentContent>} The resolved content.
23303
+ *
23316
23304
  * @private function of resolveChatAttachmentContents
23317
23305
  */
23318
23306
  async function resolveChatAttachmentContent(attachment, maxInlineCharacters, options = {}) {
@@ -23404,6 +23392,7 @@ const CHAT_ATTACHMENT_MAX_INLINE_CHARACTERS_TOTAL = 24000;
23404
23392
  * @param {ReadonlyArray<ChatAttachment>} attachments - The attachments to resolve.
23405
23393
  * @param {ResolveChatAttachmentOptions} options - Options for resolution.
23406
23394
  * @returns {Promise<Array<ResolvedChatAttachmentContent>>} The resolved contents.
23395
+ *
23407
23396
  * @public exported from `@promptbook/core`
23408
23397
  */
23409
23398
  async function resolveChatAttachmentContents(attachments, options = {}) {
@@ -23469,6 +23458,7 @@ function formatResolvedChatAttachmentContent(contentResolution) {
23469
23458
  *
23470
23459
  * @param {ReadonlyArray<ResolvedChatAttachmentContent>} resolvedContents - The resolved contents to format.
23471
23460
  * @returns {string} The formatted context.
23461
+ *
23472
23462
  * @public exported from `@promptbook/core`
23473
23463
  */
23474
23464
  function formatChatAttachmentContentContext(resolvedContents) {
@@ -23509,6 +23499,7 @@ function appendChatContextSections(messageContent, contextSections) {
23509
23499
  * @param {ReadonlyArray<ChatAttachment>} attachments - The attachments to append.
23510
23500
  * @param {ResolveChatAttachmentOptions} options - Options for resolution.
23511
23501
  * @returns {Promise<string>} The updated message content.
23502
+ *
23512
23503
  * @public exported from `@promptbook/core`
23513
23504
  */
23514
23505
  async function appendChatAttachmentContextWithContent(messageContent, attachments, options = {}) {
@@ -23537,9 +23528,7 @@ async function appendChatAttachmentContextWithContent(messageContent, attachment
23537
23528
  function humanizeAiTextEllipsis(aiText) {
23538
23529
  return aiText.replace(/[…⋯]/g, '...').replace(/\.\s+\.\s+\./g, '...');
23539
23530
  }
23540
- /**
23541
- * Note: [🏂] This function is not tested by itself but together with other cleanup functions with `humanizeAiText`
23542
- */
23531
+ // Note: [🏂] This function is not tested by itself but together with other cleanup functions with `humanizeAiText`
23543
23532
 
23544
23533
  /**
23545
23534
  * Change dash-like characters to regular dashes `—` -> `-` and remove soft hyphens
@@ -23552,9 +23541,7 @@ function humanizeAiTextEllipsis(aiText) {
23552
23541
  function humanizeAiTextEmdashed(aiText) {
23553
23542
  return aiText.replace(/\u00AD/g, '').replace(/[‐‑‒–—―−⁃﹣-]/g, '-');
23554
23543
  }
23555
- /**
23556
- * Note: [🏂] This function is not tested by itself but together with other cleanup functions with `humanizeAiText`
23557
- */
23544
+ // Note: [🏂] This function is not tested by itself but together with other cleanup functions with `humanizeAiText`
23558
23545
 
23559
23546
  /**
23560
23547
  * Change smart quotes to regular quotes
@@ -23567,9 +23554,7 @@ function humanizeAiTextEmdashed(aiText) {
23567
23554
  function humanizeAiTextQuotes(aiText) {
23568
23555
  return aiText.replace(/[“”„‟«»❝❞〝〞〟"]/g, '"').replace(/[‚‘’‛‹›❛❜'ʼ]/g, "'");
23569
23556
  }
23570
- /**
23571
- * Note: [🏂] This function is not tested by itself but together with other cleanup functions with `humanizeAiText`
23572
- */
23557
+ // Note: [🏂] This function is not tested by itself but together with other cleanup functions with `humanizeAiText`
23573
23558
 
23574
23559
  /**
23575
23560
  * Remove bracketed source citation artifacts like `\u30105:1\u2020source\u3011`.
@@ -23582,9 +23567,7 @@ function humanizeAiTextQuotes(aiText) {
23582
23567
  function humanizeAiTextSources(aiText) {
23583
23568
  return aiText.replace(/[ \t]*\u3010\s*\d+(?:\s*:\s*\d+)?\s*\u2020source\s*\u3011/g, '');
23584
23569
  }
23585
- /**
23586
- * Note: [??] This function is not tested by itself but together with other cleanup functions with `humanizeAiText`
23587
- */
23570
+ // Note: [??] This function is not tested by itself but together with other cleanup functions with `humanizeAiText`
23588
23571
 
23589
23572
  /**
23590
23573
  * Change unprintable hard spaces to regular spaces and drop zero-width spaces
@@ -23597,9 +23580,7 @@ function humanizeAiTextSources(aiText) {
23597
23580
  function humanizeAiTextWhitespace(aiText) {
23598
23581
  return aiText.replace(/[\u00A0\u1680\u2000-\u200A\u202F\u205F\u3000]/g, ' ').replace(/[\u200B\uFEFF\u2060]/g, '');
23599
23582
  }
23600
- /**
23601
- * Note: [🏂] This function is not tested by itself but together with other cleanup functions with `humanizeAiText`
23602
- */
23583
+ // Note: [🏂] This function is not tested by itself but together with other cleanup functions with `humanizeAiText`
23603
23584
 
23604
23585
  /**
23605
23586
  * Function `humanizeAiText` will remove traces of AI text generation artifacts
@@ -23618,11 +23599,11 @@ function humanizeAiText(aiText) {
23618
23599
  cleanedText = humanizeAiTextWhitespace(cleanedText);
23619
23600
  return cleanedText;
23620
23601
  }
23621
- /**
23622
- * TODO: [🧠] Maybe this should be exported from `@promptbook/utils` not `@promptbook/markdown-utils`
23623
- */
23602
+ // TODO: [🧠] Maybe this should be exported from `@promptbook/utils` not `@promptbook/markdown-utils`
23624
23603
 
23625
23604
  /**
23605
+ * Map of promptbook pseudotoken substitution.
23606
+ *
23626
23607
  * @private
23627
23608
  */
23628
23609
  const PROMPTBOOK_PSEUDOTOKEN_SUBSTITUTION = {
@@ -23670,9 +23651,7 @@ function promptbookifyAiText(text) {
23670
23651
  }
23671
23652
  return promptbookifiedTextTokens.join('');
23672
23653
  }
23673
- /**
23674
- * TODO: [🧠][✌️] Make some Promptbook-native token system
23675
- */
23654
+ // TODO: [🧠][✌️] Make some Promptbook-native token system
23676
23655
 
23677
23656
  /**
23678
23657
  * Make UncertainNumber
@@ -23728,6 +23707,7 @@ function pricing(value) {
23728
23707
  *
23729
23708
  * @see https://platform.openai.com/docs/models/
23730
23709
  * @see https://openai.com/api/pricing/
23710
+ *
23731
23711
  * @public exported from `@promptbook/openai`
23732
23712
  */
23733
23713
  const OPENAI_MODELS = exportJson({
@@ -24404,6 +24384,7 @@ const OPENAI_MODELS = exportJson({
24404
24384
  * @param rawResponse The raw response from OpenAI API
24405
24385
  * @param duration The duration of the execution
24406
24386
  * @throws {PipelineExecutionError} If the usage is not defined in the response from OpenAI
24387
+ *
24407
24388
  * @private internal utility of `OpenAiExecutionTools`
24408
24389
  */
24409
24390
  function computeOpenAiUsage(promptContent, // <- Note: Intentionally using [] to access type properties to bring jsdoc from Prompt/PromptResult to consumer
@@ -24446,15 +24427,14 @@ resultContent, rawResponse, duration = ZERO_VALUE) {
24446
24427
  },
24447
24428
  };
24448
24429
  }
24449
- /**
24450
- * TODO: [🤝] DRY Maybe some common abstraction between `computeOpenAiUsage` and `computeAnthropicClaudeUsage`
24451
- */
24430
+ // TODO: [🤝] DRY Maybe some common abstraction between `computeOpenAiUsage` and `computeAnthropicClaudeUsage`
24452
24431
 
24453
24432
  /**
24454
24433
  * Parses an OpenAI error message to identify which parameter is unsupported
24455
24434
  *
24456
24435
  * @param errorMessage The error message from OpenAI API
24457
24436
  * @returns The parameter name that is unsupported, or null if not an unsupported parameter error
24437
+ *
24458
24438
  * @private utility of LLM Tools
24459
24439
  */
24460
24440
  function parseUnsupportedParameterError(errorMessage) {
@@ -24476,6 +24456,7 @@ function parseUnsupportedParameterError(errorMessage) {
24476
24456
  * @param modelRequirements Original model requirements
24477
24457
  * @param unsupportedParameter The parameter to remove
24478
24458
  * @returns New model requirements without the unsupported parameter
24459
+ *
24479
24460
  * @private utility of LLM Tools
24480
24461
  */
24481
24462
  function removeUnsupportedModelRequirement(modelRequirements, unsupportedParameter) {
@@ -24495,8 +24476,10 @@ function removeUnsupportedModelRequirement(modelRequirements, unsupportedParamet
24495
24476
  }
24496
24477
  /**
24497
24478
  * Checks if an error is an "Unsupported value" error from OpenAI
24479
+ *
24498
24480
  * @param error The error to check
24499
24481
  * @returns true if this is an unsupported parameter error
24482
+ *
24500
24483
  * @private utility of LLM Tools
24501
24484
  */
24502
24485
  function isUnsupportedParameterError(error) {
@@ -25602,13 +25585,11 @@ class OpenAiCompatibleExecutionTools {
25602
25585
  return false;
25603
25586
  }
25604
25587
  }
25605
- /**
25606
- * TODO: [🛄] Some way how to re-wrap the errors from `OpenAiCompatibleExecutionTools`
25607
- * TODO: [🛄] Maybe make custom `OpenAiCompatibleError`
25608
- * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
25609
- * TODO: [🧠][🌰] Allow to pass `title` for tracking purposes
25610
- * TODO: [🧠][🦢] Make reverse adapter from LlmExecutionTools to OpenAI-compatible:
25611
- */
25588
+ // TODO: [🛄] Some way how to re-wrap the errors from `OpenAiCompatibleExecutionTools`
25589
+ // TODO: [🛄] Maybe make custom `OpenAiCompatibleError`
25590
+ // TODO: [🧠][🈁] Maybe use `isDeterministic` from options
25591
+ // TODO: [🧠][🌰] Allow to pass `title` for tracking purposes
25592
+ // TODO: [🧠][🦢] Make reverse adapter from LlmExecutionTools to OpenAI-compatible:
25612
25593
 
25613
25594
  /**
25614
25595
  * Profile for OpenAI provider
@@ -25676,9 +25657,21 @@ class OpenAiExecutionTools extends OpenAiCompatibleExecutionTools {
25676
25657
  }
25677
25658
  }
25678
25659
 
25660
+ /**
25661
+ * Constant for default knowledge source download timeout ms.
25662
+ */
25679
25663
  const DEFAULT_KNOWLEDGE_SOURCE_DOWNLOAD_TIMEOUT_MS = 30000;
25664
+ /**
25665
+ * Constant for default knowledge source upload timeout ms.
25666
+ */
25680
25667
  const DEFAULT_KNOWLEDGE_SOURCE_UPLOAD_TIMEOUT_MS = 900000;
25668
+ /**
25669
+ * Constant for vector store progress log interval min ms.
25670
+ */
25681
25671
  const VECTOR_STORE_PROGRESS_LOG_INTERVAL_MIN_MS = 15000;
25672
+ /**
25673
+ * Constant for vector store stall log threshold ms.
25674
+ */
25682
25675
  const VECTOR_STORE_STALL_LOG_THRESHOLD_MS = 30000;
25683
25676
  /**
25684
25677
  * Base class for OpenAI execution tools that need hosted vector stores.
@@ -26445,6 +26438,9 @@ class OpenAiVectorStoreHandler extends OpenAiExecutionTools {
26445
26438
  }
26446
26439
  }
26447
26440
 
26441
+ /**
26442
+ * Constant for default agent kit model name.
26443
+ */
26448
26444
  const DEFAULT_AGENT_KIT_MODEL_NAME = 'gpt-5.4-nano';
26449
26445
  /**
26450
26446
  * Creates one structured log entry for streamed tool-call updates.
@@ -26488,6 +26484,9 @@ function resolveFinalToolCallState$1(options) {
26488
26484
  }
26489
26485
  return 'COMPLETE';
26490
26486
  }
26487
+ /**
26488
+ * Constant for default JSON schema name.
26489
+ */
26491
26490
  const DEFAULT_JSON_SCHEMA_NAME = 'StructuredOutput';
26492
26491
  /**
26493
26492
  * File extensions considered image inputs when MIME type is missing or generic.
@@ -26643,6 +26642,7 @@ function buildJsonSchemaDefinition(jsonSchema) {
26643
26642
  *
26644
26643
  * @param responseFormat - The OpenAI `response_format` payload from the user request.
26645
26644
  * @returns An Agent output type compatible with the requested schema or `undefined` when no impact is required.
26645
+ *
26646
26646
  * @private utility of Open AI
26647
26647
  */
26648
26648
  function mapResponseFormatToAgentOutputType(responseFormat) {
@@ -27401,6 +27401,7 @@ function resolveFinalToolCallState(options) {
27401
27401
  * - `RemoteAgent` - which is an `Agent` that connects to a Promptbook Agents Server
27402
27402
  *
27403
27403
  * @deprecated Use `OpenAiAgentKitExecutionTools` instead.
27404
+ *
27404
27405
  * @public exported from `@promptbook/openai`
27405
27406
  */
27406
27407
  class OpenAiAssistantExecutionTools extends OpenAiVectorStoreHandler {
@@ -28092,14 +28093,12 @@ class OpenAiAssistantExecutionTools extends OpenAiVectorStoreHandler {
28092
28093
  * @private const of `OpenAiAssistantExecutionTools`
28093
28094
  */
28094
28095
  const DISCRIMINANT = 'OPEN_AI_ASSISTANT_V1';
28095
- /**
28096
- * TODO: !!!!! [✨🥚] Knowledge should work both with and without scrapers
28097
- * TODO: [🙎] In `OpenAiAssistantExecutionTools` Allow to create abstract assistants with `isCreatingNewAssistantsAllowed`
28098
- * TODO: [🧠][🧙‍♂️] Maybe there can be some wizard for those who want to use just OpenAI
28099
- * TODO: Maybe make custom OpenAiError
28100
- * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
28101
- * TODO: [🧠][🌰] Allow to pass `title` for tracking purposes
28102
- */
28096
+ // TODO: !!!!! [✨🥚] Knowledge should work both with and without scrapers
28097
+ // TODO: [🙎] In `OpenAiAssistantExecutionTools` Allow to create abstract assistants with `isCreatingNewAssistantsAllowed`
28098
+ // TODO: [🧠][🧙‍♂️] Maybe there can be some wizard for those who want to use just OpenAI
28099
+ // TODO: Maybe make custom OpenAiError
28100
+ // TODO: [🧠][🈁] Maybe use `isDeterministic` from options
28101
+ // TODO: [🧠][🌰] Allow to pass `title` for tracking purposes
28103
28102
 
28104
28103
  /**
28105
28104
  * Emits a progress update to signal assistant preparation before long setup work.
@@ -28576,10 +28575,8 @@ AgentLlmExecutionTools.assistantCache = new Map();
28576
28575
  * Cache of OpenAI vector stores to avoid creating duplicates
28577
28576
  */
28578
28577
  AgentLlmExecutionTools.vectorStoreCache = new Map();
28579
- /**
28580
- * TODO: [🍚] Implement Destroyable pattern to free resources
28581
- * TODO: [🧠] Adding parameter substitution support (here or should be responsibility of the underlying LLM Tools)
28582
- */
28578
+ // TODO: [🍚] Implement Destroyable pattern to free resources
28579
+ // TODO: [🧠] Adding parameter substitution support (here or should be responsibility of the underlying LLM Tools)
28583
28580
 
28584
28581
  /**
28585
28582
  * Extracts the teacher-focused instructions from the latest `OPEN` commitment in the book.
@@ -28589,6 +28586,7 @@ AgentLlmExecutionTools.vectorStoreCache = new Map();
28589
28586
  *
28590
28587
  * @param agentSource - The raw agent book source
28591
28588
  * @returns The trimmed instructions or `null` when no instructive `OPEN` commitment exists.
28589
+ *
28592
28590
  * @private Internal helper shared between self-learning and related features.
28593
28591
  */
28594
28592
  function extractOpenTeacherInstructions(agentSource) {
@@ -28796,6 +28794,7 @@ class SelfLearningManager {
28796
28794
  *
28797
28795
  * @param section Raw fragment from self-learning workflow.
28798
28796
  * @returns Trimmed fragment, or empty string when nothing remains.
28797
+ *
28799
28798
  * @private function of Agent
28800
28799
  */
28801
28800
  function normalizeBookSection(section) {
@@ -28807,6 +28806,7 @@ function normalizeBookSection(section) {
28807
28806
  * @param agentSource Current source.
28808
28807
  * @param normalizedSection Candidate fragment expected to be normalized first.
28809
28808
  * @returns True when appending would duplicate an existing fragment.
28809
+ *
28810
28810
  * @private function of Agent
28811
28811
  */
28812
28812
  function containsNormalizedBookSection(agentSource, normalizedSection) {
@@ -28821,6 +28821,7 @@ function containsNormalizedBookSection(agentSource, normalizedSection) {
28821
28821
  *
28822
28822
  * @param responseFormat Prompt response format requirements
28823
28823
  * @returns True when JSON schema mode is active
28824
+ *
28824
28825
  * @private function of Agent
28825
28826
  */
28826
28827
  function isJsonSchemaResponseFormat(responseFormat) {
@@ -28832,6 +28833,7 @@ function isJsonSchemaResponseFormat(responseFormat) {
28832
28833
  * @param content Original agent answer content
28833
28834
  * @param isJsonMode Whether the interaction requested JSON schema output
28834
28835
  * @returns Agent answer, wrapped in a formatted JSON code block when possible
28836
+ *
28835
28837
  * @private function of Agent
28836
28838
  */
28837
28839
  function formatAgentMessageForJsonMode(content, isJsonMode) {
@@ -28857,6 +28859,7 @@ function formatAgentMessageForJsonMode(content, isJsonMode) {
28857
28859
  *
28858
28860
  * @param content Text to parse as JSON
28859
28861
  * @returns Parsed JSON value or null when parsing fails
28862
+ *
28860
28863
  * @private function of Agent
28861
28864
  */
28862
28865
  function tryParseJson(content) {
@@ -28872,6 +28875,7 @@ function tryParseJson(content) {
28872
28875
  *
28873
28876
  * @param options - Normalized sample parts.
28874
28877
  * @returns Book-language sample section ready to append into agent source.
28878
+ *
28875
28879
  * @private function of Agent
28876
28880
  */
28877
28881
  function formatSelfLearningSample(options) {
@@ -28893,6 +28897,7 @@ function formatSelfLearningSample(options) {
28893
28897
  *
28894
28898
  * @param internalMessage Internal trace payload.
28895
28899
  * @returns Book-language INTERNAL MESSAGE block.
28900
+ *
28896
28901
  * @private function of Agent
28897
28902
  */
28898
28903
  function formatInternalLearningMessage(internalMessage) {
@@ -28906,6 +28911,7 @@ function formatInternalLearningMessage(internalMessage) {
28906
28911
  *
28907
28912
  * @param result Final chat result used in self-learning.
28908
28913
  * @returns Internal payloads that capture request/response/tool-call context.
28914
+ *
28909
28915
  * @private function of Agent
28910
28916
  */
28911
28917
  function buildInternalLearningMessages(result) {
@@ -28935,6 +28941,7 @@ function buildInternalLearningMessages(result) {
28935
28941
  *
28936
28942
  * @param toolCall Tool call produced during execution.
28937
28943
  * @returns Sanitized and serializable tool-call payload.
28944
+ *
28938
28945
  * @private function of Agent
28939
28946
  */
28940
28947
  function sanitizeToolCallForLearning(toolCall) {
@@ -28954,6 +28961,7 @@ function sanitizeToolCallForLearning(toolCall) {
28954
28961
  *
28955
28962
  * @param payload Internal payload to serialize.
28956
28963
  * @returns Pretty JSON string that can be embedded in BOOK.
28964
+ *
28957
28965
  * @private function of Agent
28958
28966
  */
28959
28967
  function stringifyInternalLearningPayload(payload) {
@@ -29003,6 +29011,7 @@ function createEmptySelfLearningCommitmentCounts() {
29003
29011
  * Normalizes teacher commitments into trimmed, display-ready lines.
29004
29012
  *
29005
29013
  * @param commitments Raw teacher output
29014
+ *
29006
29015
  * @private function of Agent
29007
29016
  */
29008
29017
  function getTeacherCommitmentLines(commitments) {
@@ -29015,6 +29024,7 @@ function getTeacherCommitmentLines(commitments) {
29015
29024
  * Summarizes teacher commitment lines into user-friendly counts for self-learning.
29016
29025
  *
29017
29026
  * @param lines Parsed teacher commitment lines
29027
+ *
29018
29028
  * @private function of Agent
29019
29029
  */
29020
29030
  function summarizeTeacherCommitmentLines(lines) {
@@ -29047,6 +29057,7 @@ function summarizeTeacherCommitmentLines(lines) {
29047
29057
  * @param commitments Raw teacher commitments
29048
29058
  * @param used Whether the teacher was invoked
29049
29059
  * @returns Summary of learned commitments
29060
+ *
29050
29061
  * @private function of Agent
29051
29062
  */
29052
29063
  function buildTeacherSummary(commitments, used) {
@@ -29283,9 +29294,7 @@ class Agent extends AgentLlmExecutionTools {
29283
29294
  return finalResult;
29284
29295
  }
29285
29296
  }
29286
- /**
29287
- * TODO: [🧠][😰]Agent is not working with the parameters, should it be?
29288
- */
29297
+ // TODO: [🧠][😰]Agent is not working with the parameters, should it be?
29289
29298
 
29290
29299
  /**
29291
29300
  * Parses one failed remote agent response into a structured error.
@@ -29751,10 +29760,8 @@ class RemoteAgent extends Agent {
29751
29760
  return agentResult;
29752
29761
  }
29753
29762
  }
29754
- /**
29755
- * TODO: [🧠][😰]Agent is not working with the parameters, should it be?
29756
- * TODO: !!! Agent on remote server
29757
- */
29763
+ // TODO: [🧠][😰]Agent is not working with the parameters, should it be?
29764
+ // TODO: !!! Agent on remote server
29758
29765
 
29759
29766
  var RemoteAgent$1 = /*#__PURE__*/Object.freeze({
29760
29767
  __proto__: null,