@promptbook/documents 0.112.0-34 → 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 (1476) hide show
  1. package/README.md +18 -0
  2. package/esm/index.es.js +272 -306
  3. package/esm/index.es.js.map +1 -1
  4. package/esm/src/_packages/types.index.d.ts +45 -45
  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 +4 -8
  34. package/esm/src/book-components/Chat/Chat/ChatProps.d.ts +2 -3
  35. package/esm/src/book-components/Chat/Chat/ChatSelfLearningSummary.d.ts +0 -3
  36. package/esm/src/book-components/Chat/Chat/ChatToolCallModalComponents.d.ts +0 -3
  37. package/esm/src/book-components/Chat/Chat/StreamingFeaturePlaceholder.d.ts +1 -0
  38. package/esm/src/book-components/Chat/Chat/TeamToolCallModalContent.d.ts +1 -0
  39. package/esm/src/book-components/Chat/Chat/chatCssClassNames.d.ts +1 -0
  40. package/esm/src/book-components/Chat/Chat/constants.d.ts +4 -3
  41. package/esm/src/book-components/Chat/Chat/insertDictationChunk.d.ts +16 -0
  42. package/esm/src/book-components/Chat/Chat/learnDictationDictionary.d.ts +7 -0
  43. package/esm/src/book-components/Chat/Chat/refineFinalDictationChunk.d.ts +36 -0
  44. package/esm/src/book-components/Chat/Chat/renderAdvancedToolCallDetails.d.ts +3 -0
  45. package/esm/src/book-components/Chat/Chat/renderEmailToolCallDetails.d.ts +1 -0
  46. package/esm/src/book-components/Chat/Chat/renderMemoryToolCallDetails.d.ts +1 -0
  47. package/esm/src/book-components/Chat/Chat/renderPopupToolCallDetails.d.ts +1 -0
  48. package/esm/src/book-components/Chat/Chat/renderRunBrowserToolCallDetails.d.ts +1 -0
  49. package/esm/src/book-components/Chat/Chat/renderSearchToolCallDetails.d.ts +1 -0
  50. package/esm/src/book-components/Chat/Chat/renderSelfLearningToolCallDetails.d.ts +1 -0
  51. package/esm/src/book-components/Chat/Chat/renderTimeToolCallDetails.d.ts +1 -0
  52. package/esm/src/book-components/Chat/Chat/renderTimeoutToolCallDetails.d.ts +1 -0
  53. package/esm/src/book-components/Chat/Chat/renderToolCallClockPanel.d.ts +1 -0
  54. package/esm/src/book-components/Chat/Chat/renderToolCallDetails.d.ts +1 -0
  55. package/esm/src/book-components/Chat/Chat/renderToolCallProgressPlaceholder.d.ts +1 -0
  56. package/esm/src/book-components/Chat/Chat/renderWalletCredentialToolCallDetails.d.ts +1 -0
  57. package/esm/src/book-components/Chat/Chat/resolveSpeechRecognitionUiDescriptor.d.ts +30 -0
  58. package/esm/src/book-components/Chat/Chat/resolveToolCallProgressMessage.d.ts +1 -0
  59. package/esm/src/book-components/Chat/Chat/useChatInputAreaDictation.d.ts +7 -30
  60. package/esm/src/book-components/Chat/Chat/useChatInputAreaDictationPersistence.d.ts +20 -0
  61. package/esm/src/book-components/Chat/Chat/useChatInputAreaDictationSupport.d.ts +29 -0
  62. package/esm/src/book-components/Chat/LlmChat/defaults.d.ts +0 -3
  63. package/esm/src/book-components/Chat/MarkdownContent/MarkdownContent.d.ts +3 -3
  64. package/esm/src/book-components/Chat/MockedChat/constants.d.ts +0 -3
  65. package/esm/src/book-components/Chat/SourceChip/SourceChip.d.ts +4 -3
  66. package/esm/src/book-components/Chat/effects/components/ConfettiEffect.d.ts +3 -0
  67. package/esm/src/book-components/Chat/effects/components/HeartsEffect.d.ts +3 -0
  68. package/esm/src/book-components/Chat/effects/index.d.ts +0 -4
  69. package/esm/src/book-components/Chat/effects/utils/detectEffects.d.ts +1 -0
  70. package/esm/src/book-components/Chat/hooks/useSendMessageToLlmChat.d.ts +4 -4
  71. package/esm/src/book-components/Chat/save/_common/string_chat_format_name.d.ts +1 -0
  72. package/esm/src/book-components/Chat/save/html/htmlSaveFormatDefinition.d.ts +0 -3
  73. package/esm/src/book-components/Chat/save/index.d.ts +0 -3
  74. package/esm/src/book-components/Chat/save/pdf/buildChatPdf.d.ts +1 -0
  75. package/esm/src/book-components/Chat/save/pdf/pdfSaveFormatDefinition.d.ts +0 -4
  76. package/esm/src/book-components/Chat/types/ChatMessage.d.ts +3 -5
  77. package/esm/src/book-components/Chat/types/ChatParticipant.d.ts +0 -3
  78. package/esm/src/book-components/Chat/utils/ExportFormat.d.ts +2 -0
  79. package/esm/src/book-components/Chat/utils/citationHelpers.d.ts +4 -3
  80. package/esm/src/book-components/Chat/utils/collectTeamToolCallSummary.d.ts +1 -0
  81. package/esm/src/book-components/Chat/utils/createCitationFootnoteRenderModel.d.ts +1 -0
  82. package/esm/src/book-components/Chat/utils/exportChatHistory.d.ts +0 -3
  83. package/esm/src/book-components/Chat/utils/formatToolCallLocalTime.d.ts +2 -1
  84. package/esm/src/book-components/Chat/utils/loadAgentProfile.d.ts +12 -0
  85. package/esm/src/book-components/Chat/utils/parseCitationsFromContent.d.ts +0 -3
  86. package/esm/src/book-components/Chat/utils/parseImagePrompts.d.ts +1 -3
  87. package/esm/src/book-components/Chat/utils/sanitizeStreamingMessageContent.d.ts +14 -0
  88. package/esm/src/book-components/Chat/utils/thinkingMessageVariants.d.ts +3 -0
  89. package/esm/src/book-components/Chat/utils/timeoutToolCallPresentation.d.ts +0 -3
  90. package/esm/src/book-components/Chat/utils/toolCallParsing/extractSearchResults.d.ts +1 -0
  91. package/esm/src/book-components/Chat/utils/toolCallParsing/getToolCallResultDate.d.ts +1 -0
  92. package/esm/src/book-components/Chat/utils/toolCallParsing/getToolCallTimestamp.d.ts +1 -0
  93. package/esm/src/book-components/Chat/utils/toolCallParsing/parseRunBrowserToolResult.d.ts +1 -0
  94. package/esm/src/book-components/Chat/utils/toolCallParsing/parseTeamToolResult.d.ts +1 -0
  95. package/esm/src/book-components/Chat/utils/toolCallParsing/parseToolCallArguments.d.ts +1 -0
  96. package/esm/src/book-components/Chat/utils/toolCallParsing/parseToolCallResult.d.ts +1 -0
  97. package/esm/src/book-components/Chat/utils/toolCallParsing/resolveRunBrowserArtifactUrl.d.ts +1 -0
  98. package/esm/src/book-components/Chat/utils/walletCredentialToolCall.d.ts +3 -3
  99. package/esm/src/book-components/PromptbookAgent/PromptbookAgentIntegration.d.ts +3 -5
  100. package/esm/src/book-components/PromptbookAgent/PromptbookAgentSeamlessIntegration.d.ts +3 -5
  101. package/esm/src/book-components/Qr/BrandedQrCode.d.ts +5 -0
  102. package/esm/src/book-components/Qr/GenericQrCode.d.ts +5 -0
  103. package/esm/src/book-components/Qr/PromptbookQrCode.d.ts +5 -0
  104. package/esm/src/book-components/Qr/useQrCode.d.ts +4 -1
  105. package/esm/src/book-components/_common/Dropdown/Dropdown.d.ts +4 -0
  106. package/esm/src/book-components/_common/HamburgerMenu/HamburgerMenu.d.ts +4 -0
  107. package/esm/src/book-components/_common/MenuHoisting/MenuHoistingContext.d.ts +3 -3
  108. package/esm/src/book-components/_common/Modal/Modal.d.ts +1 -3
  109. package/esm/src/book-components/_common/Tooltip/Tooltip.d.ts +3 -0
  110. package/esm/src/book-components/icons/AboutIcon.d.ts +1 -0
  111. package/esm/src/book-components/icons/AttachmentIcon.d.ts +4 -0
  112. package/esm/src/book-components/icons/CameraIcon.d.ts +4 -0
  113. package/esm/src/book-components/icons/DownloadIcon.d.ts +1 -0
  114. package/esm/src/book-components/icons/EmailIcon.d.ts +1 -0
  115. package/esm/src/book-components/icons/MenuIcon.d.ts +1 -3
  116. package/esm/src/book-components/icons/SaveIcon.d.ts +1 -0
  117. package/esm/src/book-components/icons/SendIcon.d.ts +0 -3
  118. package/esm/src/book-components/icons/TeacherIcon.d.ts +1 -0
  119. package/esm/src/cli/$runPromptbookCli.d.ts +0 -1
  120. package/esm/src/cli/cli-commands/_boilerplate.d.ts +0 -2
  121. package/esm/src/cli/cli-commands/about.d.ts +0 -6
  122. package/esm/src/cli/cli-commands/coder/ThinkingLevel.d.ts +18 -0
  123. package/esm/src/cli/cli-commands/coder/find-fresh-emoji-tags.d.ts +0 -2
  124. package/esm/src/cli/cli-commands/coder/find-refactor-candidates.d.ts +0 -2
  125. package/esm/src/cli/cli-commands/coder/generate-boilerplates.d.ts +0 -2
  126. package/esm/src/cli/cli-commands/coder/init.d.ts +0 -2
  127. package/esm/src/cli/cli-commands/coder/run.d.ts +1 -3
  128. package/esm/src/cli/cli-commands/coder/run.test.d.ts +1 -0
  129. package/esm/src/cli/cli-commands/coder/verify.d.ts +0 -2
  130. package/esm/src/cli/cli-commands/coder.d.ts +0 -2
  131. package/esm/src/cli/cli-commands/common/handleActionErrors.d.ts +4 -0
  132. package/esm/src/cli/cli-commands/hello.d.ts +0 -5
  133. package/esm/src/cli/cli-commands/list-models.d.ts +0 -2
  134. package/esm/src/cli/cli-commands/list-scrapers.d.ts +0 -2
  135. package/esm/src/cli/cli-commands/login.d.ts +0 -5
  136. package/esm/src/cli/cli-commands/prettify.d.ts +0 -6
  137. package/esm/src/cli/cli-commands/run.d.ts +0 -8
  138. package/esm/src/cli/cli-commands/runInteractiveChatbot.d.ts +1 -5
  139. package/esm/src/cli/cli-commands/start-agents-server.d.ts +0 -2
  140. package/esm/src/cli/cli-commands/start-pipelines-server.d.ts +0 -5
  141. package/esm/src/cli/cli-commands/test-command.d.ts +0 -7
  142. package/esm/src/cli/common/$provideLlmToolsForCli.d.ts +5 -0
  143. package/esm/src/cli/main.d.ts +0 -2
  144. package/esm/src/cli/promptbookCli.d.ts +0 -7
  145. package/esm/src/collection/agent-collection/AgentCollection.d.ts +0 -3
  146. package/esm/src/collection/agent-collection/constructors/agent-collection-in-supabase/AgentCollectionInSupabase.d.ts +2 -6
  147. package/esm/src/collection/agent-collection/constructors/agent-collection-in-supabase/AgentCollectionInSupabaseOptions.d.ts +3 -0
  148. package/esm/src/collection/pipeline-collection/SimplePipelineCollection.d.ts +2 -1
  149. package/esm/src/collection/pipeline-collection/constructors/createPipelineCollectionFromDirectory.d.ts +2 -5
  150. package/esm/src/collection/pipeline-collection/constructors/createPipelineCollectionFromJson.d.ts +1 -0
  151. package/esm/src/collection/pipeline-collection/constructors/createPipelineCollectionFromPromise.d.ts +4 -3
  152. package/esm/src/collection/pipeline-collection/constructors/createPipelineCollectionFromUrl.d.ts +2 -3
  153. package/esm/src/collection/pipeline-collection/constructors/createPipelineSubcollection.d.ts +1 -0
  154. package/esm/src/collection/pipeline-collection/pipelineCollectionToJson.d.ts +0 -3
  155. package/esm/src/commands/BOOK_VERSION/BookVersionCommand.d.ts +1 -0
  156. package/esm/src/commands/BOOK_VERSION/bookVersionCommandParser.d.ts +1 -0
  157. package/esm/src/commands/EXPECT/ExpectCommand.d.ts +0 -3
  158. package/esm/src/commands/EXPECT/expectCommandParser.d.ts +3 -2
  159. package/esm/src/commands/FOREACH/ForeachCommand.d.ts +1 -0
  160. package/esm/src/commands/FOREACH/foreachCommandParser.d.ts +1 -3
  161. package/esm/src/commands/FORMAT/formatCommandParser.d.ts +1 -0
  162. package/esm/src/commands/FORMFACTOR/FormfactorCommand.d.ts +1 -0
  163. package/esm/src/commands/FORMFACTOR/formfactorCommandParser.d.ts +1 -0
  164. package/esm/src/commands/JOKER/JokerCommand.d.ts +1 -0
  165. package/esm/src/commands/JOKER/jokerCommandParser.d.ts +1 -0
  166. package/esm/src/commands/KNOWLEDGE/KnowledgeCommand.d.ts +1 -0
  167. package/esm/src/commands/KNOWLEDGE/knowledgeCommandParser.d.ts +1 -3
  168. package/esm/src/commands/KNOWLEDGE/utils/knowledgeSourceContentToName.d.ts +0 -3
  169. package/esm/src/commands/KNOWLEDGE/utils/knowledgeSourceContentToName.test.d.ts +0 -3
  170. package/esm/src/commands/MODEL/ModelCommand.d.ts +1 -0
  171. package/esm/src/commands/MODEL/modelCommandParser.d.ts +1 -0
  172. package/esm/src/commands/PARAMETER/ParameterCommand.d.ts +1 -0
  173. package/esm/src/commands/PARAMETER/parameterCommandParser.d.ts +1 -0
  174. package/esm/src/commands/PERSONA/PersonaCommand.d.ts +1 -0
  175. package/esm/src/commands/PERSONA/personaCommandParser.d.ts +1 -0
  176. package/esm/src/commands/POSTPROCESS/PostprocessCommand.d.ts +1 -0
  177. package/esm/src/commands/POSTPROCESS/postprocessCommandParser.d.ts +1 -0
  178. package/esm/src/commands/SECTION/SectionCommand.d.ts +1 -0
  179. package/esm/src/commands/SECTION/sectionCommandParser.d.ts +1 -0
  180. package/esm/src/commands/URL/UrlCommand.d.ts +1 -0
  181. package/esm/src/commands/URL/urlCommandParser.d.ts +1 -0
  182. package/esm/src/commands/X_ACTION/ActionCommand.d.ts +1 -0
  183. package/esm/src/commands/X_ACTION/actionCommandParser.d.ts +1 -3
  184. package/esm/src/commands/X_INSTRUMENT/InstrumentCommand.d.ts +1 -0
  185. package/esm/src/commands/X_INSTRUMENT/instrumentCommandParser.d.ts +1 -3
  186. package/esm/src/commands/_BOILERPLATE/BoilerplateCommand.d.ts +1 -0
  187. package/esm/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts +1 -0
  188. package/esm/src/commands/_common/stringifyCommand.d.ts +1 -1
  189. package/esm/src/commands/_common/types/CommandParser.d.ts +0 -4
  190. package/esm/src/commands/index.d.ts +0 -3
  191. package/esm/src/commitments/ACTION/ACTION.d.ts +0 -3
  192. package/esm/src/commitments/CLOSED/CLOSED.d.ts +0 -3
  193. package/esm/src/commitments/CLOSED/CLOSED.test.d.ts +0 -3
  194. package/esm/src/commitments/COMPONENT/COMPONENT.d.ts +0 -3
  195. package/esm/src/commitments/DELETE/DELETE.d.ts +0 -3
  196. package/esm/src/commitments/DICTIONARY/DICTIONARY.d.ts +0 -3
  197. package/esm/src/commitments/FORMAT/FORMAT.d.ts +0 -3
  198. package/esm/src/commitments/FROM/FROM.d.ts +0 -3
  199. package/esm/src/commitments/GOAL/GOAL.d.ts +0 -3
  200. package/esm/src/commitments/IMPORT/IMPORT.d.ts +0 -3
  201. package/esm/src/commitments/LANGUAGE/LANGUAGE.d.ts +0 -3
  202. package/esm/src/commitments/MEMORY/MEMORY.d.ts +0 -3
  203. package/esm/src/commitments/MESSAGE/MESSAGE.d.ts +0 -3
  204. package/esm/src/commitments/MESSAGE_SUFFIX/MESSAGE_SUFFIX.d.ts +0 -3
  205. package/esm/src/commitments/META/META.d.ts +0 -3
  206. package/esm/src/commitments/META/META_DESCRIPTION.d.ts +0 -3
  207. package/esm/src/commitments/META_COLOR/META_COLOR.d.ts +0 -3
  208. package/esm/src/commitments/META_DISCLAIMER/META_DISCLAIMER.d.ts +0 -3
  209. package/esm/src/commitments/META_DOMAIN/META_DOMAIN.d.ts +0 -3
  210. package/esm/src/commitments/META_FONT/META_FONT.d.ts +0 -3
  211. package/esm/src/commitments/META_IMAGE/META_IMAGE.d.ts +0 -3
  212. package/esm/src/commitments/META_INPUT_PLACEHOLDER/META_INPUT_PLACEHOLDER.d.ts +0 -3
  213. package/esm/src/commitments/META_LINK/META_LINK.d.ts +0 -3
  214. package/esm/src/commitments/META_VOICE/META_VOICE.d.ts +0 -3
  215. package/esm/src/commitments/MODEL/MODEL.d.ts +0 -3
  216. package/esm/src/commitments/OPEN/OPEN.d.ts +0 -3
  217. package/esm/src/commitments/PERSONA/PERSONA.d.ts +0 -3
  218. package/esm/src/commitments/RULE/RULE.d.ts +0 -3
  219. package/esm/src/commitments/SAMPLE/SAMPLE.d.ts +0 -3
  220. package/esm/src/commitments/SCENARIO/SCENARIO.d.ts +0 -3
  221. package/esm/src/commitments/TEAM/TEAM.d.ts +0 -3
  222. package/esm/src/commitments/TEMPLATE/TEMPLATE.d.ts +0 -3
  223. package/esm/src/commitments/USE/USE.d.ts +0 -3
  224. package/esm/src/commitments/USE/aggregateUseCommitmentSystemMessages.d.ts +2 -0
  225. package/esm/src/commitments/USE_BROWSER/USE_BROWSER.d.ts +0 -3
  226. package/esm/src/commitments/USE_BROWSER/fetchUrlContent.d.ts +4 -5
  227. package/esm/src/commitments/USE_CALENDAR/USE_CALENDAR.d.ts +0 -3
  228. package/esm/src/commitments/USE_CALENDAR/calendarReference.d.ts +0 -3
  229. package/esm/src/commitments/USE_EMAIL/USE_EMAIL.d.ts +0 -3
  230. package/esm/src/commitments/USE_IMAGE_GENERATOR/USE_IMAGE_GENERATOR.d.ts +0 -3
  231. package/esm/src/commitments/USE_MCP/USE_MCP.d.ts +0 -3
  232. package/esm/src/commitments/USE_POPUP/USE_POPUP.d.ts +0 -3
  233. package/esm/src/commitments/USE_PRIVACY/USE_PRIVACY.d.ts +0 -3
  234. package/esm/src/commitments/USE_PROJECT/USE_PROJECT.d.ts +0 -3
  235. package/esm/src/commitments/USE_PROJECT/projectReference.d.ts +0 -3
  236. package/esm/src/commitments/USE_SEARCH_ENGINE/USE_SEARCH_ENGINE.d.ts +0 -3
  237. package/esm/src/commitments/USE_SPAWN/USE_SPAWN.d.ts +0 -3
  238. package/esm/src/commitments/USE_TIME/USE_TIME.d.ts +0 -3
  239. package/esm/src/commitments/USE_TIMEOUT/USE_TIMEOUT.d.ts +0 -3
  240. package/esm/src/commitments/USE_USER_LOCATION/USE_USER_LOCATION.d.ts +0 -3
  241. package/esm/src/commitments/WALLET/WALLET.d.ts +0 -3
  242. package/esm/src/commitments/WRITING_RULES/WRITING_RULES.d.ts +0 -3
  243. package/esm/src/commitments/WRITING_SAMPLE/WRITING_SAMPLE.d.ts +0 -3
  244. package/esm/src/commitments/_base/createEmptyAgentModelRequirements.d.ts +0 -3
  245. package/esm/src/commitments/_common/commitmentToolFunctions.d.ts +2 -3
  246. package/esm/src/commitments/_common/createWritingCommitmentSections.d.ts +2 -3
  247. package/esm/src/commitments/_common/getAllCommitmentDefinitions.d.ts +1 -0
  248. package/esm/src/commitments/_common/getAllCommitmentTypes.d.ts +1 -0
  249. package/esm/src/commitments/_common/getAllCommitmentsToolFunctionsForNode.d.ts +0 -4
  250. package/esm/src/commitments/_common/getCommitmentDefinition.d.ts +1 -0
  251. package/esm/src/commitments/_common/isCommitmentSupported.d.ts +1 -0
  252. package/esm/src/commitments/_common/toolExecutionEnvelope.d.ts +0 -3
  253. package/esm/src/commitments/_common/toolRuntimeContext.d.ts +3 -3
  254. package/esm/src/commitments/index.d.ts +0 -4
  255. package/esm/src/config.test.d.ts +0 -3
  256. package/esm/src/constants/streaming.d.ts +0 -3
  257. package/esm/src/constants.d.ts +0 -3
  258. package/esm/src/conversion/archive/loadArchive.d.ts +0 -1
  259. package/esm/src/conversion/archive/saveArchive.d.ts +0 -5
  260. package/esm/src/conversion/compilePipeline.d.ts +2 -7
  261. package/esm/src/conversion/compilePipelineOnRemoteServer.d.ts +2 -5
  262. package/esm/src/conversion/parsePipeline.d.ts +1 -11
  263. package/esm/src/conversion/pipelineJsonToString.d.ts +1 -7
  264. package/esm/src/conversion/prettify/prettifyPipelineString.d.ts +0 -4
  265. package/esm/src/conversion/prettify/renderPipelineMermaidOptions.d.ts +0 -7
  266. package/esm/src/conversion/utils/extractParameterNamesFromTask.d.ts +1 -3
  267. package/esm/src/conversion/validation/_importPipeline.d.ts +6 -2
  268. package/esm/src/conversion/validation/pipelineStringToJson-parseErrors.test.d.ts +0 -3
  269. package/esm/src/conversion/validation/validatePipeline-logicErrors.test.d.ts +0 -3
  270. package/esm/src/conversion/validation/validatePipeline.d.ts +3 -9
  271. package/esm/src/conversion/validation/validatePipeline.test.d.ts +0 -3
  272. package/esm/src/dialogs/simple-prompt/SimplePromptInterfaceTools.d.ts +1 -2
  273. package/esm/src/errors/0-BoilerplateError.d.ts +0 -3
  274. package/esm/src/errors/0-index.d.ts +0 -3
  275. package/esm/src/errors/DatabaseError.d.ts +0 -3
  276. package/esm/src/errors/ExpectError.d.ts +2 -1
  277. package/esm/src/errors/ParseError.d.ts +0 -3
  278. package/esm/src/errors/PipelineExecutionError.d.ts +0 -3
  279. package/esm/src/executables/$provideExecutablesForNode.d.ts +0 -5
  280. package/esm/src/executables/apps/locateLibreoffice.d.ts +0 -2
  281. package/esm/src/executables/apps/locatePandoc.d.ts +0 -2
  282. package/esm/src/executables/browsers/locateBrowser.d.ts +0 -1
  283. package/esm/src/executables/browsers/locateDefaultSystemBrowser.d.ts +0 -1
  284. package/esm/src/executables/locateApp.d.ts +0 -2
  285. package/esm/src/executables/platforms/locateAppOnLinux.d.ts +0 -2
  286. package/esm/src/executables/platforms/locateAppOnMacOs.d.ts +0 -2
  287. package/esm/src/executables/platforms/locateAppOnWindows.d.ts +0 -2
  288. package/esm/src/execution/AbstractTaskResult.d.ts +0 -4
  289. package/esm/src/execution/AvailableModel.d.ts +0 -4
  290. package/esm/src/execution/CommonToolsOptions.d.ts +0 -5
  291. package/esm/src/execution/ExecutionTask.d.ts +4 -4
  292. package/esm/src/execution/FilesystemTools.d.ts +0 -3
  293. package/esm/src/execution/LlmExecutionTools.d.ts +3 -9
  294. package/esm/src/execution/LlmExecutionToolsConstructor.d.ts +0 -3
  295. package/esm/src/execution/PipelineExecutor.d.ts +0 -3
  296. package/esm/src/execution/PipelineExecutorResult.d.ts +0 -3
  297. package/esm/src/execution/PromptResult.d.ts +1 -9
  298. package/esm/src/execution/PromptbookFetch.test-type.d.ts +0 -4
  299. package/esm/src/execution/ScriptExecutionTools.d.ts +0 -4
  300. package/esm/src/execution/Usage.d.ts +0 -3
  301. package/esm/src/execution/UserInterfaceTools.d.ts +3 -0
  302. package/esm/src/execution/assertsTaskSuccessful.d.ts +1 -3
  303. package/esm/src/execution/createPipelineExecutor/00-createPipelineExecutor.d.ts +1 -0
  304. package/esm/src/execution/createPipelineExecutor/20-executeTask.d.ts +0 -3
  305. package/esm/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +1 -3
  306. package/esm/src/execution/createPipelineExecutor/getContextForTask.d.ts +1 -0
  307. package/esm/src/execution/createPipelineExecutor/getKnowledgeForTask.d.ts +0 -4
  308. package/esm/src/execution/createPipelineExecutor/knowledgePiecesToString.d.ts +0 -1
  309. package/esm/src/execution/execution-report/ExecutionReportJson.d.ts +1 -0
  310. package/esm/src/execution/execution-report/ExecutionReportString.d.ts +0 -3
  311. package/esm/src/execution/execution-report/executionReportJsonToString.d.ts +0 -5
  312. package/esm/src/execution/translation/automatic-translate/automatic-translators/AutomaticTranslator.d.ts +3 -1
  313. package/esm/src/execution/translation/automatic-translate/automatic-translators/FakeAutomaticTranslator.d.ts +3 -1
  314. package/esm/src/execution/translation/automatic-translate/automatic-translators/TranslatorOptions.d.ts +3 -1
  315. package/esm/src/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.d.ts +2 -0
  316. package/esm/src/execution/translation/automatic-translate/translateMessages.d.ts +3 -3
  317. package/esm/src/execution/utils/$provideExecutionToolsForNode.d.ts +2 -4
  318. package/esm/src/execution/utils/checkExpectations.d.ts +2 -5
  319. package/esm/src/execution/utils/forEachAsync.d.ts +5 -1
  320. package/esm/src/execution/utils/usage-constants.d.ts +0 -3
  321. package/esm/src/execution/utils/usageToHuman.d.ts +0 -8
  322. package/esm/src/execution/utils/validatePromptResult.d.ts +1 -0
  323. package/esm/src/file-security-checkers/virustotal/VirusTotalFileSecurityChecker.d.ts +1 -0
  324. package/esm/src/formats/_common/FormatParser.d.ts +2 -9
  325. package/esm/src/formats/_common/FormatSubvalueParser.d.ts +0 -3
  326. package/esm/src/formats/csv/CsvFormatParser.d.ts +2 -8
  327. package/esm/src/formats/index.d.ts +0 -3
  328. package/esm/src/formats/json/JsonFormatParser.d.ts +0 -11
  329. package/esm/src/formats/text/TextFormatParser.d.ts +0 -9
  330. package/esm/src/formats/xml/XmlFormatParser.d.ts +0 -11
  331. package/esm/src/formfactors/_common/AbstractFormfactorDefinition.d.ts +1 -3
  332. package/esm/src/formfactors/_common/FormfactorDefinition.d.ts +1 -0
  333. package/esm/src/formfactors/index.d.ts +0 -3
  334. package/esm/src/high-level-abstractions/_common/HighLevelAbstraction.d.ts +0 -5
  335. package/esm/src/high-level-abstractions/index.d.ts +0 -4
  336. package/esm/src/high-level-abstractions/quick-chatbot/QuickChatbotHla.d.ts +0 -3
  337. package/esm/src/llm-providers/_common/register/$llmToolsMetadataRegister.d.ts +2 -3
  338. package/esm/src/llm-providers/_common/register/$llmToolsRegister.d.ts +2 -3
  339. package/esm/src/llm-providers/_common/register/$provideEnvFilename.d.ts +0 -1
  340. package/esm/src/llm-providers/_common/register/$provideLlmToolsConfigurationFromEnv.d.ts +1 -1
  341. package/esm/src/llm-providers/_common/register/$provideLlmToolsForTestingAndScriptsAndPlayground.d.ts +3 -6
  342. package/esm/src/llm-providers/_common/register/$provideLlmToolsForWizardOrCli.d.ts +3 -7
  343. package/esm/src/llm-providers/_common/register/$provideLlmToolsFromEnv.d.ts +1 -16
  344. package/esm/src/llm-providers/_common/register/$registeredLlmToolsMessage.d.ts +0 -4
  345. package/esm/src/llm-providers/_common/register/LlmToolsConfiguration.d.ts +0 -5
  346. package/esm/src/llm-providers/_common/register/LlmToolsMetadata.d.ts +0 -6
  347. package/esm/src/llm-providers/_common/register/LlmToolsOptions.d.ts +0 -4
  348. package/esm/src/llm-providers/_common/register/createLlmToolsFromConfiguration.d.ts +1 -0
  349. package/esm/src/llm-providers/_common/utils/assertUniqueModels.d.ts +0 -3
  350. package/esm/src/llm-providers/_common/utils/cache/CacheItem.d.ts +0 -3
  351. package/esm/src/llm-providers/_common/utils/cache/cacheLlmTools.d.ts +1 -0
  352. package/esm/src/llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage.d.ts +0 -4
  353. package/esm/src/llm-providers/_common/utils/count-total-usage/countUsage.d.ts +1 -0
  354. package/esm/src/llm-providers/_common/utils/count-total-usage/limitTotalUsage.d.ts +0 -7
  355. package/esm/src/llm-providers/_common/utils/removeUnsupportedModelRequirements.d.ts +4 -0
  356. package/esm/src/llm-providers/_multiple/MultipleLlmExecutionTools.d.ts +1 -0
  357. package/esm/src/llm-providers/_multiple/getSingleLlmExecutionTools.d.ts +0 -4
  358. package/esm/src/llm-providers/_multiple/joinLlmExecutionTools.d.ts +3 -7
  359. package/esm/src/llm-providers/_multiple/playground/playground.d.ts +0 -1
  360. package/esm/src/llm-providers/agent/Agent.d.ts +0 -3
  361. package/esm/src/llm-providers/agent/AgentLlmExecutionTools.d.ts +0 -4
  362. package/esm/src/llm-providers/agent/RemoteAgent.d.ts +0 -4
  363. package/esm/src/llm-providers/agent/playground/playground.d.ts +0 -6
  364. package/esm/src/llm-providers/agent/register-configuration.d.ts +0 -5
  365. package/esm/src/llm-providers/agent/register-constructor.d.ts +0 -4
  366. package/esm/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +2 -10
  367. package/esm/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions.d.ts +3 -3
  368. package/esm/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +1 -8
  369. package/esm/src/llm-providers/anthropic-claude/computeAnthropicClaudeUsage.d.ts +1 -3
  370. package/esm/src/llm-providers/anthropic-claude/computeAnthropicClaudeUsage.test.d.ts +0 -3
  371. package/esm/src/llm-providers/anthropic-claude/createAnthropicClaudeExecutionTools.d.ts +0 -7
  372. package/esm/src/llm-providers/anthropic-claude/playground/playground.d.ts +0 -5
  373. package/esm/src/llm-providers/anthropic-claude/register-configuration.d.ts +0 -3
  374. package/esm/src/llm-providers/anthropic-claude/register-constructor.d.ts +0 -5
  375. package/esm/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +0 -6
  376. package/esm/src/llm-providers/azure-openai/AzureOpenAiExecutionToolsOptions.d.ts +1 -0
  377. package/esm/src/llm-providers/azure-openai/createAzureOpenAiExecutionTools.d.ts +0 -4
  378. package/esm/src/llm-providers/azure-openai/playground/playground.d.ts +0 -2
  379. package/esm/src/llm-providers/azure-openai/register-configuration.d.ts +0 -3
  380. package/esm/src/llm-providers/azure-openai/register-constructor.d.ts +0 -4
  381. package/esm/src/llm-providers/deepseek/DeepseekExecutionToolsOptions.d.ts +1 -0
  382. package/esm/src/llm-providers/deepseek/createDeepseekExecutionTools.d.ts +0 -3
  383. package/esm/src/llm-providers/deepseek/deepseek-models.d.ts +1 -6
  384. package/esm/src/llm-providers/deepseek/register-configuration.d.ts +0 -3
  385. package/esm/src/llm-providers/deepseek/register-constructor.d.ts +0 -4
  386. package/esm/src/llm-providers/google/GoogleExecutionToolsOptions.d.ts +1 -0
  387. package/esm/src/llm-providers/google/createGoogleExecutionTools.d.ts +0 -4
  388. package/esm/src/llm-providers/google/google-models.d.ts +1 -6
  389. package/esm/src/llm-providers/google/register-configuration.d.ts +0 -3
  390. package/esm/src/llm-providers/google/register-constructor.d.ts +0 -4
  391. package/esm/src/llm-providers/mocked/$fakeTextToExpectations.d.ts +1 -5
  392. package/esm/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts +0 -4
  393. package/esm/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts +0 -3
  394. package/esm/src/llm-providers/mocked/test/joker.test.d.ts +0 -3
  395. package/esm/src/llm-providers/mocked/test/mocked-chat.test.d.ts +0 -4
  396. package/esm/src/llm-providers/mocked/test/mocked-completion.test.d.ts +0 -3
  397. package/esm/src/llm-providers/ollama/OllamaExecutionTools.d.ts +0 -3
  398. package/esm/src/llm-providers/ollama/OllamaExecutionToolsOptions.d.ts +1 -0
  399. package/esm/src/llm-providers/ollama/ollama-models.d.ts +1 -4
  400. package/esm/src/llm-providers/ollama/playground/playground.d.ts +0 -2
  401. package/esm/src/llm-providers/ollama/register-configuration.d.ts +0 -3
  402. package/esm/src/llm-providers/ollama/register-constructor.d.ts +0 -4
  403. package/esm/src/llm-providers/openai/OpenAiAgentKitExecutionTools.d.ts +10 -0
  404. package/esm/src/llm-providers/openai/OpenAiAssistantExecutionTools.d.ts +1 -8
  405. package/esm/src/llm-providers/openai/OpenAiCompatibleExecutionTools.d.ts +0 -7
  406. package/esm/src/llm-providers/openai/OpenAiCompatibleExecutionToolsOptions.d.ts +2 -0
  407. package/esm/src/llm-providers/openai/computeOpenAiUsage.d.ts +1 -3
  408. package/esm/src/llm-providers/openai/computeOpenAiUsage.test.d.ts +0 -3
  409. package/esm/src/llm-providers/openai/createOpenAiAssistantExecutionTools.d.ts +0 -4
  410. package/esm/src/llm-providers/openai/createOpenAiCompatibleExecutionTools.d.ts +0 -4
  411. package/esm/src/llm-providers/openai/createOpenAiExecutionTools.d.ts +0 -4
  412. package/esm/src/llm-providers/openai/openai-models.d.ts +1 -0
  413. package/esm/src/llm-providers/openai/openai-models.test.d.ts +0 -3
  414. package/esm/src/llm-providers/openai/playground/playground.d.ts +0 -2
  415. package/esm/src/llm-providers/openai/register-configuration.d.ts +0 -3
  416. package/esm/src/llm-providers/openai/register-constructor.d.ts +0 -4
  417. package/esm/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts +1 -9
  418. package/esm/src/llm-providers/remote/playground/playground.d.ts +0 -1
  419. package/esm/src/llm-providers/vercel/playground/playground.d.ts +0 -2
  420. package/esm/src/other/templates/getBookTemplates.d.ts +2 -5
  421. package/esm/src/personas/preparePersona.d.ts +1 -7
  422. package/esm/src/pipeline/PipelineInterface/PipelineInterface.d.ts +1 -0
  423. package/esm/src/pipeline/PipelineInterface/constants.d.ts +0 -3
  424. package/esm/src/pipeline/PipelineJson/CommonTaskJson.d.ts +0 -4
  425. package/esm/src/pipeline/PipelineJson/DialogTaskJson.d.ts +1 -3
  426. package/esm/src/pipeline/PipelineJson/Expectations.d.ts +4 -3
  427. package/esm/src/pipeline/PipelineJson/KnowledgePieceJson.d.ts +0 -4
  428. package/esm/src/pipeline/PipelineJson/KnowledgeSourceJson.d.ts +0 -3
  429. package/esm/src/pipeline/PipelineJson/PersonaJson.d.ts +0 -3
  430. package/esm/src/pipeline/PipelineJson/PreparationJson.d.ts +3 -5
  431. package/esm/src/pipeline/PipelineJson/ScriptTaskJson.d.ts +1 -4
  432. package/esm/src/pipeline/PipelineJson/SimpleTaskJson.d.ts +1 -3
  433. package/esm/src/pipeline/book-notation.d.ts +1 -4
  434. package/esm/src/pipeline/isValidPipelineString.d.ts +1 -3
  435. package/esm/src/pipeline/isValidPipelineString.test.d.ts +0 -3
  436. package/esm/src/pipeline/prompt-notation/helpers/ParameterEscaping.d.ts +5 -0
  437. package/esm/src/pipeline/prompt-notation/helpers/ParameterNaming.d.ts +1 -0
  438. package/esm/src/pipeline/prompt-notation/helpers/ParameterSection.d.ts +2 -0
  439. package/esm/src/pipeline/prompt-notation.d.ts +2 -5
  440. package/esm/src/pipeline/prompt-notation.test.d.ts +0 -3
  441. package/esm/src/pipeline/validatePipelineString.d.ts +1 -3
  442. package/esm/src/playground/permanent/_boilerplate.d.ts +0 -1
  443. package/esm/src/playground/permanent/agent-with-browser-playground.d.ts +0 -1
  444. package/esm/src/playground/permanent/error-handling-playground.d.ts +0 -1
  445. package/esm/src/playground/playground.d.ts +0 -2
  446. package/esm/src/postprocessing/utils/extractBlock.d.ts +2 -1
  447. package/esm/src/postprocessing/utils/extractJsonBlock.d.ts +2 -5
  448. package/esm/src/prepare/PrepareAndScrapeOptions.d.ts +0 -4
  449. package/esm/src/prepare/preparePipeline.d.ts +3 -2
  450. package/esm/src/prepare/preparePipelineOnRemoteServer.d.ts +2 -5
  451. package/esm/src/prepare/prepareTasks.d.ts +6 -10
  452. package/esm/src/prepare/unpreparePipeline.d.ts +1 -5
  453. package/esm/src/remote-server/RemoteServer.d.ts +3 -0
  454. package/esm/src/remote-server/openapi.d.ts +3 -4
  455. package/esm/src/remote-server/socket-types/_subtypes/Identification.d.ts +1 -5
  456. package/esm/src/remote-server/socket-types/listModels/PromptbookServer_ListModels_Request.d.ts +0 -3
  457. package/esm/src/remote-server/socket-types/listModels/PromptbookServer_ListModels_Response.d.ts +0 -3
  458. package/esm/src/remote-server/startAgentServer.d.ts +6 -2
  459. package/esm/src/remote-server/startRemoteServer.d.ts +1 -15
  460. package/esm/src/remote-server/types/RemoteClientOptions.d.ts +0 -5
  461. package/esm/src/remote-server/types/RemoteServerOptions.d.ts +10 -4
  462. package/esm/src/remote-server/ui/ServerApp.d.ts +1 -0
  463. package/esm/src/remote-server/ui/types.d.ts +3 -0
  464. package/esm/src/scrapers/_boilerplate/BoilerplateScraper.d.ts +1 -4
  465. package/esm/src/scrapers/_boilerplate/createBoilerplateScraper.d.ts +0 -3
  466. package/esm/src/scrapers/_boilerplate/playground/boilerplate-scraper-playground.d.ts +0 -1
  467. package/esm/src/scrapers/_boilerplate/register-constructor.d.ts +0 -4
  468. package/esm/src/scrapers/_boilerplate/register-metadata.d.ts +0 -3
  469. package/esm/src/scrapers/_common/Scraper.d.ts +0 -5
  470. package/esm/src/scrapers/_common/ScraperIntermediateSource.d.ts +0 -3
  471. package/esm/src/scrapers/_common/prepareKnowledgePieces.d.ts +1 -0
  472. package/esm/src/scrapers/_common/register/$provideFilesystemForNode.d.ts +0 -2
  473. package/esm/src/scrapers/_common/register/$provideScrapersForNode.d.ts +1 -2
  474. package/esm/src/scrapers/_common/register/$provideScriptingForNode.d.ts +0 -2
  475. package/esm/src/scrapers/_common/register/$registeredScrapersMessage.d.ts +0 -3
  476. package/esm/src/scrapers/_common/register/$scrapersMetadataRegister.d.ts +2 -3
  477. package/esm/src/scrapers/_common/register/$scrapersRegister.d.ts +2 -3
  478. package/esm/src/scrapers/_common/register/ScraperConstructor.d.ts +0 -3
  479. package/esm/src/scrapers/_common/utils/getScraperIntermediateSource.d.ts +0 -7
  480. package/esm/src/scrapers/_common/utils/getScraperIntermediateSource.test.d.ts +0 -3
  481. package/esm/src/scrapers/_common/utils/promptbookFetch.d.ts +0 -3
  482. package/esm/src/scrapers/document/DocumentScraper.d.ts +1 -6
  483. package/esm/src/scrapers/document/DocumentScraper.test.d.ts +0 -3
  484. package/esm/src/scrapers/document/createDocumentScraper.d.ts +0 -3
  485. package/esm/src/scrapers/document/playground/document-scraper-playground.d.ts +0 -1
  486. package/esm/src/scrapers/document/register-constructor.d.ts +0 -4
  487. package/esm/src/scrapers/document/register-metadata.d.ts +0 -3
  488. package/esm/src/scrapers/document-legacy/LegacyDocumentScraper.d.ts +1 -6
  489. package/esm/src/scrapers/document-legacy/LegacyDocumentScraper.test.d.ts +0 -3
  490. package/esm/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts +0 -3
  491. package/esm/src/scrapers/document-legacy/playground/legacy-document-scraper-playground.d.ts +0 -1
  492. package/esm/src/scrapers/document-legacy/register-constructor.d.ts +0 -4
  493. package/esm/src/scrapers/document-legacy/register-metadata.d.ts +0 -3
  494. package/esm/src/scrapers/markdown/MarkdownScraper.d.ts +1 -4
  495. package/esm/src/scrapers/markdown/MarkdownScraper.test.d.ts +0 -3
  496. package/esm/src/scrapers/markdown/createMarkdownScraper.d.ts +0 -3
  497. package/esm/src/scrapers/markdown/playground/markdown-scraper-playground.d.ts +0 -1
  498. package/esm/src/scrapers/markdown/register-constructor.d.ts +0 -4
  499. package/esm/src/scrapers/markdown/register-metadata.d.ts +0 -3
  500. package/esm/src/scrapers/markitdown/MarkitdownScraper.d.ts +1 -7
  501. package/esm/src/scrapers/markitdown/createMarkitdownScraper.d.ts +0 -4
  502. package/esm/src/scrapers/markitdown/playground/markitdown-scraper-playground.d.ts +0 -1
  503. package/esm/src/scrapers/markitdown/register-constructor.d.ts +0 -5
  504. package/esm/src/scrapers/markitdown/register-metadata.d.ts +0 -3
  505. package/esm/src/scrapers/pdf/PdfScraper.d.ts +1 -6
  506. package/esm/src/scrapers/pdf/createPdfScraper.d.ts +0 -3
  507. package/esm/src/scrapers/pdf/playground/pdf-scraper-playground.d.ts +0 -1
  508. package/esm/src/scrapers/pdf/register-constructor.d.ts +0 -4
  509. package/esm/src/scrapers/pdf/register-metadata.d.ts +0 -3
  510. package/esm/src/scrapers/website/WebsiteScraper.d.ts +1 -6
  511. package/esm/src/scrapers/website/createWebsiteScraper.d.ts +0 -3
  512. package/esm/src/scrapers/website/playground/website-scraper-playground.d.ts +0 -1
  513. package/esm/src/scrapers/website/register-constructor.d.ts +0 -4
  514. package/esm/src/scrapers/website/register-metadata.d.ts +0 -3
  515. package/esm/src/scripting/javascript/JavascriptEvalExecutionTools.d.ts +1 -5
  516. package/esm/src/scripting/javascript/JavascriptEvalExecutionTools.test.d.ts +0 -3
  517. package/esm/src/scripting/javascript/JavascriptExecutionTools.d.ts +1 -0
  518. package/esm/src/scripting/javascript/JavascriptExecutionToolsOptions.d.ts +0 -3
  519. package/esm/src/scripting/javascript/postprocessing-functions.d.ts +0 -4
  520. package/esm/src/scripting/javascript/utils/extractVariablesFromJavascript.d.ts +1 -3
  521. package/esm/src/search-engines/SearchEngine.d.ts +3 -0
  522. package/esm/src/speech-recognition/BrowserSpeechRecognition.d.ts +0 -2
  523. package/esm/src/speech-recognition/OpenAiSpeechRecognition.d.ts +2 -2
  524. package/esm/src/storage/_common/PromptbookStorage.d.ts +0 -4
  525. package/esm/src/storage/_common/PromptbookStorage.test-type.d.ts +0 -4
  526. package/esm/src/storage/env-storage/$EnvStorage.d.ts +0 -3
  527. package/esm/src/storage/file-cache-storage/FileCacheStorage.d.ts +0 -2
  528. package/esm/src/storage/local-storage/getIndexedDbStorage.d.ts +0 -1
  529. package/esm/src/storage/local-storage/getLocalStorage.d.ts +0 -1
  530. package/esm/src/storage/local-storage/getSessionStorage.d.ts +0 -1
  531. package/esm/src/storage/local-storage/utils/makePromptbookStorageFromIndexedDb.d.ts +1 -0
  532. package/esm/src/storage/local-storage/utils/makePromptbookStorageFromWebStorage.d.ts +0 -4
  533. package/esm/src/transpilers/_common/register/$bookTranspilersRegister.d.ts +1 -3
  534. package/esm/src/transpilers/formatted-book-in-markdown/register.d.ts +2 -5
  535. package/esm/src/transpilers/openai-sdk/playground/playground.d.ts +0 -1
  536. package/esm/src/transpilers/openai-sdk/register.d.ts +2 -5
  537. package/esm/src/types/Arrayable.d.ts +1 -0
  538. package/esm/src/types/InputParameters_private.d.ts +4 -2
  539. package/esm/src/types/IntermediateFilesStrategy.d.ts +0 -3
  540. package/esm/src/types/LlmCall.d.ts +0 -3
  541. package/esm/src/types/ModelRequirements.d.ts +1 -0
  542. package/esm/src/types/ModelVariant.d.ts +3 -0
  543. package/esm/src/types/Parameters.d.ts +31 -0
  544. package/esm/src/types/Parameters_private.d.ts +4 -2
  545. package/esm/src/types/Prompt.d.ts +1 -6
  546. package/esm/src/types/ReservedParameters_private.d.ts +2 -1
  547. package/esm/src/types/ToolCall.d.ts +0 -2
  548. package/esm/src/types/Updatable.d.ts +1 -3
  549. package/esm/src/types/string_agent_hash_private.d.ts +1 -1
  550. package/esm/src/types/string_agent_name.d.ts +32 -0
  551. package/esm/src/types/string_agent_name_in_book_private.d.ts +1 -1
  552. package/esm/src/types/string_agent_name_private.d.ts +2 -1
  553. package/esm/src/types/string_agent_permanent_id_private.d.ts +2 -1
  554. package/esm/src/types/string_business_category_name.d.ts +5 -0
  555. package/esm/src/types/string_business_category_name_private.d.ts +1 -1
  556. package/esm/src/types/string_char_private.d.ts +1 -1
  557. package/esm/src/types/string_chat_prompt_private.d.ts +1 -1
  558. package/esm/src/types/string_completion_prompt_private.d.ts +1 -1
  559. package/esm/src/types/string_markdown.d.ts +0 -1
  560. package/esm/src/types/string_mime_type_private.d.ts +1 -0
  561. package/esm/src/types/string_model_description_private.d.ts +1 -1
  562. package/esm/src/types/string_model_name.d.ts +7 -0
  563. package/esm/src/types/string_model_name_private.d.ts +1 -1
  564. package/esm/src/types/string_name.d.ts +31 -0
  565. package/esm/src/types/string_name_private.d.ts +1 -1
  566. package/esm/src/types/string_page.d.ts +15 -0
  567. package/esm/src/types/string_page_private.d.ts +1 -1
  568. package/esm/src/types/string_parameter_name.d.ts +11 -210
  569. package/esm/src/types/string_parameter_value_private.d.ts +1 -1
  570. package/esm/src/types/string_persona_description.d.ts +14 -0
  571. package/esm/src/types/string_persona_description_private.d.ts +1 -1
  572. package/esm/src/types/string_prompt.d.ts +49 -0
  573. package/esm/src/types/string_prompt_image_private.d.ts +1 -1
  574. package/esm/src/types/string_prompt_private.d.ts +1 -1
  575. package/esm/src/types/string_reserved_parameter_name_private.d.ts +1 -1
  576. package/esm/src/types/string_sha256.d.ts +2 -2
  577. package/esm/src/types/string_system_message_private.d.ts +1 -1
  578. package/esm/src/types/string_template_private.d.ts +1 -1
  579. package/esm/src/types/string_text_prompt_private.d.ts +1 -1
  580. package/esm/src/types/string_title.d.ts +8 -0
  581. package/esm/src/types/string_title_private.d.ts +1 -1
  582. package/esm/src/types/typeAliasEmoji.d.ts +0 -3
  583. package/esm/src/types/typeAliases.d.ts +0 -6
  584. package/esm/src/utils/DEFAULT_THINKING_MESSAGES.d.ts +5 -1
  585. package/esm/src/utils/chat/chatAttachments/appendChatAttachmentContext.d.ts +1 -0
  586. package/esm/src/utils/chat/chatAttachments/appendChatAttachmentContextWithContent.d.ts +1 -0
  587. package/esm/src/utils/chat/chatAttachments/formatChatAttachmentContentContext.d.ts +1 -0
  588. package/esm/src/utils/chat/chatAttachments/formatChatAttachmentContext.d.ts +1 -0
  589. package/esm/src/utils/chat/chatAttachments/normalizeChatAttachments.d.ts +1 -0
  590. package/esm/src/utils/chat/chatAttachments/resolveChatAttachmentContent.d.ts +1 -0
  591. package/esm/src/utils/chat/chatAttachments/resolveChatAttachmentContents.d.ts +1 -0
  592. package/esm/src/utils/chat/chatAttachments.d.ts +0 -3
  593. package/esm/src/utils/chat/constants.d.ts +0 -3
  594. package/esm/src/utils/clientVersion.d.ts +0 -3
  595. package/esm/src/utils/color/$randomColor.d.ts +0 -5
  596. package/esm/src/utils/color/css-colors.d.ts +0 -3
  597. package/esm/src/utils/color/internal-utils/hslToRgb.d.ts +0 -3
  598. package/esm/src/utils/color/internal-utils/rgbToHsl.d.ts +0 -3
  599. package/esm/src/utils/color/operators/ColorTransformer.d.ts +2 -0
  600. package/esm/src/utils/color/operators/lighten.d.ts +0 -3
  601. package/esm/src/utils/color/operators/saturate.d.ts +0 -3
  602. package/esm/src/utils/color/utils/areColorsEqual.d.ts +0 -3
  603. package/esm/src/utils/color/utils/colorDistance.d.ts +2 -2
  604. package/esm/src/utils/color/utils/colorHue.d.ts +0 -1
  605. package/esm/src/utils/color/utils/colorHueDistance.d.ts +0 -1
  606. package/esm/src/utils/color/utils/colorToDataUrl.d.ts +0 -3
  607. package/esm/src/utils/database/uniqueConstraint.d.ts +1 -3
  608. package/esm/src/utils/editable/edit-pipeline-string/addPipelineCommand.d.ts +3 -4
  609. package/esm/src/utils/editable/edit-pipeline-string/deflatePipeline.d.ts +0 -3
  610. package/esm/src/utils/editable/types/PipelineEditableSerialized.d.ts +2 -2
  611. package/esm/src/utils/editable/utils/renamePipelineParameter.d.ts +4 -3
  612. package/esm/src/utils/editable/utils/stringifyPipelineJson.d.ts +0 -6
  613. package/esm/src/utils/environment/$detectRuntimeEnvironment.d.ts +0 -3
  614. package/esm/src/utils/environment/$getGlobalScope.d.ts +1 -1
  615. package/esm/src/utils/environment/$isRunningInBrowser.d.ts +0 -3
  616. package/esm/src/utils/environment/$isRunningInJest.d.ts +0 -3
  617. package/esm/src/utils/environment/$isRunningInNode.d.ts +0 -3
  618. package/esm/src/utils/environment/$isRunningInWebWorker.d.ts +0 -3
  619. package/esm/src/utils/execCommand/$execCommand.d.ts +0 -2
  620. package/esm/src/utils/execCommand/$execCommands.d.ts +0 -1
  621. package/esm/src/utils/execCommand/ExecCommandOptions.d.ts +3 -4
  622. package/esm/src/utils/expectation-counters/constants.d.ts +0 -4
  623. package/esm/src/utils/expectation-counters/countCharacters.d.ts +0 -4
  624. package/esm/src/utils/expectation-counters/countLines.d.ts +0 -4
  625. package/esm/src/utils/expectation-counters/countPages.d.ts +0 -4
  626. package/esm/src/utils/expectation-counters/countParagraphs.d.ts +0 -4
  627. package/esm/src/utils/expectation-counters/countSentences.d.ts +0 -4
  628. package/esm/src/utils/expectation-counters/countWords.d.ts +0 -5
  629. package/esm/src/utils/expectation-counters/index.d.ts +0 -4
  630. package/esm/src/utils/files/$induceBookDownload.d.ts +0 -1
  631. package/esm/src/utils/files/$induceFileDownload.d.ts +0 -1
  632. package/esm/src/utils/files/ObjectUrl.d.ts +0 -1
  633. package/esm/src/utils/files/isDirectoryExisting.d.ts +0 -6
  634. package/esm/src/utils/files/isExecutable.d.ts +0 -4
  635. package/esm/src/utils/files/isFileExisting.d.ts +0 -5
  636. package/esm/src/utils/files/listAllFiles.d.ts +1 -5
  637. package/esm/src/utils/files/readResponseBytes.d.ts +1 -0
  638. package/esm/src/utils/knowledge/inlineKnowledgeSource.d.ts +11 -6
  639. package/esm/src/utils/knowledge/simplifyKnowledgeLabel.d.ts +2 -0
  640. package/esm/src/utils/linguistic-hash/linguisticHash.d.ts +2 -1
  641. package/esm/src/utils/linguistic-hash/linguisticHashTypes.d.ts +0 -3
  642. package/esm/src/utils/linguistic-hash/linguisticHashWords.cs.d.ts +0 -3
  643. package/esm/src/utils/linguistic-hash/linguisticHashWords.en.d.ts +0 -3
  644. package/esm/src/utils/markdown/addAutoGeneratedSection.d.ts +0 -3
  645. package/esm/src/utils/markdown/createMarkdownTable.d.ts +0 -3
  646. package/esm/src/utils/markdown/escapeMarkdownBlock.d.ts +0 -3
  647. package/esm/src/utils/markdown/extractAllBlocksFromMarkdown.d.ts +1 -3
  648. package/esm/src/utils/markdown/extractAllListItemsFromMarkdown.d.ts +1 -0
  649. package/esm/src/utils/markdown/extractOneBlockFromMarkdown.d.ts +2 -4
  650. package/esm/src/utils/markdown/humanizeAiText.d.ts +0 -3
  651. package/esm/src/utils/markdown/humanizeAiTextEllipsis.d.ts +0 -3
  652. package/esm/src/utils/markdown/humanizeAiTextEmdashed.d.ts +0 -3
  653. package/esm/src/utils/markdown/humanizeAiTextQuotes.d.ts +0 -3
  654. package/esm/src/utils/markdown/humanizeAiTextSources.d.ts +0 -3
  655. package/esm/src/utils/markdown/humanizeAiTextWhitespace.d.ts +0 -3
  656. package/esm/src/utils/markdown/prettifyMarkdown.d.ts +4 -2
  657. package/esm/src/utils/markdown/promptbookifyAiText.d.ts +0 -3
  658. package/esm/src/utils/markdown/removeMarkdownComments.d.ts +1 -0
  659. package/esm/src/utils/markdown/removeMarkdownFormatting.d.ts +1 -0
  660. package/esm/src/utils/markdown/removeMarkdownLinks.d.ts +1 -0
  661. package/esm/src/utils/markdown/trimCodeBlock.d.ts +1 -1
  662. package/esm/src/utils/markdown/trimEndOfCodeBlock.d.ts +1 -1
  663. package/esm/src/utils/misc/$getCurrentDate.d.ts +1 -0
  664. package/esm/src/utils/misc/aboutPromptbookInformation.d.ts +3 -3
  665. package/esm/src/utils/misc/computeHash.d.ts +0 -3
  666. package/esm/src/utils/misc/debounce.d.ts +2 -0
  667. package/esm/src/utils/misc/emojis.d.ts +3 -8
  668. package/esm/src/utils/misc/injectCssModuleIntoShadowRoot.d.ts +7 -2
  669. package/esm/src/utils/misc/parseNumber.d.ts +0 -4
  670. package/esm/src/utils/misc/xAboutPromptbookInformation.d.ts +3 -4
  671. package/esm/src/utils/normalization/IKeywords.d.ts +0 -3
  672. package/esm/src/utils/normalization/nameToUriPart.d.ts +1 -0
  673. package/esm/src/utils/normalization/nameToUriParts.d.ts +1 -0
  674. package/esm/src/utils/normalization/normalize-to-kebab-case.d.ts +2 -3
  675. package/esm/src/utils/normalization/normalizeTo_PascalCase.d.ts +2 -0
  676. package/esm/src/utils/normalization/normalizeTo_SCREAMING_CASE.d.ts +2 -0
  677. package/esm/src/utils/normalization/normalizeTo_camelCase.d.ts +2 -3
  678. package/esm/src/utils/normalization/normalizeTo_snake_case.d.ts +1 -0
  679. package/esm/src/utils/normalization/orderJson.d.ts +1 -0
  680. package/esm/src/utils/normalization/orderJson.test.d.ts +0 -3
  681. package/esm/src/utils/normalization/parseKeywords.d.ts +1 -4
  682. package/esm/src/utils/normalization/parseKeywordsFromString.d.ts +1 -0
  683. package/esm/src/utils/normalization/removeDiacritics.d.ts +1 -3
  684. package/esm/src/utils/normalization/removeEmojis.d.ts +1 -0
  685. package/esm/src/utils/normalization/removeQuotes.d.ts +1 -0
  686. package/esm/src/utils/normalization/searchKeywords.d.ts +1 -3
  687. package/esm/src/utils/normalization/titleToName.d.ts +1 -0
  688. package/esm/src/utils/normalization/unwrapResult.d.ts +1 -3
  689. package/esm/src/utils/organization/$sideEffect.d.ts +1 -0
  690. package/esm/src/utils/organization/TODO_USE.d.ts +1 -0
  691. package/esm/src/utils/organization/just.d.ts +1 -0
  692. package/esm/src/utils/organization/keepImported.d.ts +1 -0
  693. package/esm/src/utils/organization/keepTypeImported.d.ts +1 -0
  694. package/esm/src/utils/organization/keepUnused.d.ts +1 -0
  695. package/esm/src/utils/organization/preserve.d.ts +1 -3
  696. package/esm/src/utils/organization/really_any.d.ts +1 -0
  697. package/esm/src/utils/organization/spaceTrim.d.ts +3 -2
  698. package/esm/src/utils/parameters/extractParameterNames.d.ts +1 -0
  699. package/esm/src/utils/parameters/mapAvailableToExpectedParameters.d.ts +1 -0
  700. package/esm/src/utils/parameters/templateParameters.d.ts +2 -1
  701. package/esm/src/utils/parameters/valueToString.d.ts +2 -2
  702. package/esm/src/utils/random/$generateBookBoilerplate.d.ts +3 -3
  703. package/esm/src/utils/random/$randomAgentPersona.d.ts +1 -3
  704. package/esm/src/utils/random/$randomAgentRule.d.ts +1 -3
  705. package/esm/src/utils/random/$randomFullnameWithColor.d.ts +4 -3
  706. package/esm/src/utils/random/$randomItem.d.ts +0 -3
  707. package/esm/src/utils/random/$randomSeed.d.ts +0 -3
  708. package/esm/src/utils/random/$randomToken.d.ts +2 -5
  709. package/esm/src/utils/random/EnglishNamePool.d.ts +1 -0
  710. package/esm/src/utils/serialization/$deepFreeze.d.ts +1 -3
  711. package/esm/src/utils/serialization/checkSerializableAsJson.d.ts +1 -5
  712. package/esm/src/utils/serialization/clonePipeline.d.ts +1 -3
  713. package/esm/src/utils/serialization/deepClone.d.ts +1 -3
  714. package/esm/src/utils/serialization/exportJson.d.ts +1 -3
  715. package/esm/src/utils/serialization/isSerializableAsJson.d.ts +0 -5
  716. package/esm/src/utils/serialization/jsonStringsToJsons.d.ts +1 -4
  717. package/esm/src/utils/serialization/serializeToPromptbookJavascript.d.ts +3 -3
  718. package/esm/src/utils/sets/difference.d.ts +1 -3
  719. package/esm/src/utils/sets/intersection.d.ts +1 -0
  720. package/esm/src/utils/sets/union.d.ts +1 -0
  721. package/esm/src/utils/take/classes/TakeChain.d.ts +4 -1
  722. package/esm/src/utils/take/interfaces/ITakeChain.d.ts +5 -1
  723. package/esm/src/utils/take/interfaces/Takeable.d.ts +2 -1
  724. package/esm/src/utils/take/take.d.ts +1 -1
  725. package/esm/src/utils/validators/filePath/isRootPath.d.ts +1 -3
  726. package/esm/src/utils/validators/filePath/isRootPath.test.d.ts +0 -3
  727. package/esm/src/utils/validators/filePath/isValidFilePath.d.ts +1 -3
  728. package/esm/src/utils/validators/javascriptName/isValidJavascriptName.d.ts +1 -0
  729. package/esm/src/utils/validators/parameterName/validateParameterName.d.ts +1 -0
  730. package/esm/src/utils/validators/semanticVersion/isValidPromptbookVersion.d.ts +2 -1
  731. package/esm/src/utils/validators/url/extractUrlsFromText.d.ts +1 -0
  732. package/esm/src/utils/validators/url/isUrlOnPrivateNetwork.d.ts +1 -0
  733. package/esm/src/utils/validators/url/isValidAgentUrl.d.ts +0 -3
  734. package/esm/src/utils/validators/url/isValidPipelineUrl.d.ts +0 -3
  735. package/esm/src/utils/validators/url/normalizeDomainForMatching.d.ts +1 -0
  736. package/esm/src/version.d.ts +1 -1
  737. package/esm/src/wizard/$getCompiledBook.d.ts +0 -2
  738. package/esm/src/wizard/wizard.d.ts +1 -2
  739. package/package.json +2 -2
  740. package/umd/index.umd.js +272 -306
  741. package/umd/index.umd.js.map +1 -1
  742. package/umd/src/_packages/types.index.d.ts +45 -45
  743. package/umd/src/book-2.0/agent-source/AgentBasicInformation.d.ts +3 -4
  744. package/umd/src/book-2.0/agent-source/AgentModelRequirements.d.ts +0 -4
  745. package/umd/src/book-2.0/agent-source/createAgentModelRequirements.d.ts +7 -0
  746. package/umd/src/book-2.0/agent-source/createTeamToolName.d.ts +1 -0
  747. package/umd/src/book-2.0/agent-source/extractOpenTeacherInstructions.d.ts +1 -0
  748. package/umd/src/book-2.0/agent-source/padBook.d.ts +1 -4
  749. package/umd/src/book-2.0/agent-source/parseAgentSource.d.ts +0 -3
  750. package/umd/src/book-2.0/agent-source/parseAgentSourcePrelude.d.ts +1 -0
  751. package/umd/src/book-2.0/agent-source/parseParameters.d.ts +1 -0
  752. package/umd/src/book-2.0/agent-source/parseTeamCommitment.d.ts +0 -3
  753. package/umd/src/book-2.0/agent-source/pseudoAgentReferences.d.ts +8 -3
  754. package/umd/src/book-2.0/agent-source/string_book.d.ts +1 -0
  755. package/umd/src/book-2.0/utils/generatePlaceholderAgentProfileImageUrl.d.ts +0 -3
  756. package/umd/src/book-components/AvatarProfile/AvatarChip/AvatarChip.d.ts +0 -3
  757. package/umd/src/book-components/AvatarProfile/AvatarProfile/AvatarProfile.d.ts +0 -3
  758. package/umd/src/book-components/AvatarProfile/AvatarProfile/AvatarProfileTooltip.d.ts +4 -0
  759. package/umd/src/book-components/BookEditor/BookEditor.d.ts +0 -3
  760. package/umd/src/book-components/BookEditor/BookEditorActionbar.d.ts +4 -0
  761. package/umd/src/book-components/BookEditor/BookEditorMonaco.d.ts +2 -0
  762. package/umd/src/book-components/BookEditor/BookEditorMonacoUploadPanel.d.ts +3 -0
  763. package/umd/src/book-components/BookEditor/createDeprecatedCommitmentDiagnostics.d.ts +1 -0
  764. package/umd/src/book-components/BookEditor/useBookEditorMonacoDecorations.d.ts +6 -0
  765. package/umd/src/book-components/BookEditor/useBookEditorMonacoDiagnostics.d.ts +9 -0
  766. package/umd/src/book-components/BookEditor/useBookEditorMonacoLanguage.d.ts +7 -0
  767. package/umd/src/book-components/BookEditor/useBookEditorMonacoStyles.d.ts +3 -0
  768. package/umd/src/book-components/BookEditor/useBookEditorMonacoUploads.d.ts +24 -0
  769. package/umd/src/book-components/Chat/AgentChat/AgentChat.d.ts +0 -3
  770. package/umd/src/book-components/Chat/AgentChip/AgentChip.d.ts +6 -5
  771. package/umd/src/book-components/Chat/Chat/ChatInputAreaDictationPanel.d.ts +4 -8
  772. package/umd/src/book-components/Chat/Chat/ChatProps.d.ts +2 -3
  773. package/umd/src/book-components/Chat/Chat/ChatSelfLearningSummary.d.ts +0 -3
  774. package/umd/src/book-components/Chat/Chat/ChatToolCallModalComponents.d.ts +0 -3
  775. package/umd/src/book-components/Chat/Chat/StreamingFeaturePlaceholder.d.ts +1 -0
  776. package/umd/src/book-components/Chat/Chat/TeamToolCallModalContent.d.ts +1 -0
  777. package/umd/src/book-components/Chat/Chat/chatCssClassNames.d.ts +1 -0
  778. package/umd/src/book-components/Chat/Chat/constants.d.ts +4 -3
  779. package/umd/src/book-components/Chat/Chat/insertDictationChunk.d.ts +16 -0
  780. package/umd/src/book-components/Chat/Chat/learnDictationDictionary.d.ts +7 -0
  781. package/umd/src/book-components/Chat/Chat/refineFinalDictationChunk.d.ts +36 -0
  782. package/umd/src/book-components/Chat/Chat/renderAdvancedToolCallDetails.d.ts +3 -0
  783. package/umd/src/book-components/Chat/Chat/renderEmailToolCallDetails.d.ts +1 -0
  784. package/umd/src/book-components/Chat/Chat/renderMemoryToolCallDetails.d.ts +1 -0
  785. package/umd/src/book-components/Chat/Chat/renderPopupToolCallDetails.d.ts +1 -0
  786. package/umd/src/book-components/Chat/Chat/renderRunBrowserToolCallDetails.d.ts +1 -0
  787. package/umd/src/book-components/Chat/Chat/renderSearchToolCallDetails.d.ts +1 -0
  788. package/umd/src/book-components/Chat/Chat/renderSelfLearningToolCallDetails.d.ts +1 -0
  789. package/umd/src/book-components/Chat/Chat/renderTimeToolCallDetails.d.ts +1 -0
  790. package/umd/src/book-components/Chat/Chat/renderTimeoutToolCallDetails.d.ts +1 -0
  791. package/umd/src/book-components/Chat/Chat/renderToolCallClockPanel.d.ts +1 -0
  792. package/umd/src/book-components/Chat/Chat/renderToolCallDetails.d.ts +1 -0
  793. package/umd/src/book-components/Chat/Chat/renderToolCallProgressPlaceholder.d.ts +1 -0
  794. package/umd/src/book-components/Chat/Chat/renderWalletCredentialToolCallDetails.d.ts +1 -0
  795. package/umd/src/book-components/Chat/Chat/resolveSpeechRecognitionUiDescriptor.d.ts +30 -0
  796. package/umd/src/book-components/Chat/Chat/resolveToolCallProgressMessage.d.ts +1 -0
  797. package/umd/src/book-components/Chat/Chat/useChatInputAreaDictation.d.ts +7 -30
  798. package/umd/src/book-components/Chat/Chat/useChatInputAreaDictationPersistence.d.ts +20 -0
  799. package/umd/src/book-components/Chat/Chat/useChatInputAreaDictationSupport.d.ts +29 -0
  800. package/umd/src/book-components/Chat/LlmChat/defaults.d.ts +0 -3
  801. package/umd/src/book-components/Chat/MarkdownContent/MarkdownContent.d.ts +3 -3
  802. package/umd/src/book-components/Chat/MockedChat/constants.d.ts +0 -3
  803. package/umd/src/book-components/Chat/SourceChip/SourceChip.d.ts +4 -3
  804. package/umd/src/book-components/Chat/effects/components/ConfettiEffect.d.ts +3 -0
  805. package/umd/src/book-components/Chat/effects/components/HeartsEffect.d.ts +3 -0
  806. package/umd/src/book-components/Chat/effects/index.d.ts +0 -4
  807. package/umd/src/book-components/Chat/effects/utils/detectEffects.d.ts +1 -0
  808. package/umd/src/book-components/Chat/hooks/useSendMessageToLlmChat.d.ts +4 -4
  809. package/umd/src/book-components/Chat/save/_common/string_chat_format_name.d.ts +1 -0
  810. package/umd/src/book-components/Chat/save/html/htmlSaveFormatDefinition.d.ts +0 -3
  811. package/umd/src/book-components/Chat/save/index.d.ts +0 -3
  812. package/umd/src/book-components/Chat/save/pdf/buildChatPdf.d.ts +1 -0
  813. package/umd/src/book-components/Chat/save/pdf/pdfSaveFormatDefinition.d.ts +0 -4
  814. package/umd/src/book-components/Chat/types/ChatMessage.d.ts +3 -5
  815. package/umd/src/book-components/Chat/types/ChatParticipant.d.ts +0 -3
  816. package/umd/src/book-components/Chat/utils/ExportFormat.d.ts +2 -0
  817. package/umd/src/book-components/Chat/utils/citationHelpers.d.ts +4 -3
  818. package/umd/src/book-components/Chat/utils/collectTeamToolCallSummary.d.ts +1 -0
  819. package/umd/src/book-components/Chat/utils/createCitationFootnoteRenderModel.d.ts +1 -0
  820. package/umd/src/book-components/Chat/utils/exportChatHistory.d.ts +0 -3
  821. package/umd/src/book-components/Chat/utils/formatToolCallLocalTime.d.ts +2 -1
  822. package/umd/src/book-components/Chat/utils/loadAgentProfile.d.ts +12 -0
  823. package/umd/src/book-components/Chat/utils/parseCitationsFromContent.d.ts +0 -3
  824. package/umd/src/book-components/Chat/utils/parseImagePrompts.d.ts +1 -3
  825. package/umd/src/book-components/Chat/utils/sanitizeStreamingMessageContent.d.ts +14 -0
  826. package/umd/src/book-components/Chat/utils/thinkingMessageVariants.d.ts +3 -0
  827. package/umd/src/book-components/Chat/utils/timeoutToolCallPresentation.d.ts +0 -3
  828. package/umd/src/book-components/Chat/utils/toolCallParsing/extractSearchResults.d.ts +1 -0
  829. package/umd/src/book-components/Chat/utils/toolCallParsing/getToolCallResultDate.d.ts +1 -0
  830. package/umd/src/book-components/Chat/utils/toolCallParsing/getToolCallTimestamp.d.ts +1 -0
  831. package/umd/src/book-components/Chat/utils/toolCallParsing/parseRunBrowserToolResult.d.ts +1 -0
  832. package/umd/src/book-components/Chat/utils/toolCallParsing/parseTeamToolResult.d.ts +1 -0
  833. package/umd/src/book-components/Chat/utils/toolCallParsing/parseToolCallArguments.d.ts +1 -0
  834. package/umd/src/book-components/Chat/utils/toolCallParsing/parseToolCallResult.d.ts +1 -0
  835. package/umd/src/book-components/Chat/utils/toolCallParsing/resolveRunBrowserArtifactUrl.d.ts +1 -0
  836. package/umd/src/book-components/Chat/utils/walletCredentialToolCall.d.ts +3 -3
  837. package/umd/src/book-components/PromptbookAgent/PromptbookAgentIntegration.d.ts +3 -5
  838. package/umd/src/book-components/PromptbookAgent/PromptbookAgentSeamlessIntegration.d.ts +3 -5
  839. package/umd/src/book-components/Qr/BrandedQrCode.d.ts +5 -0
  840. package/umd/src/book-components/Qr/GenericQrCode.d.ts +5 -0
  841. package/umd/src/book-components/Qr/PromptbookQrCode.d.ts +5 -0
  842. package/umd/src/book-components/Qr/useQrCode.d.ts +4 -1
  843. package/umd/src/book-components/_common/Dropdown/Dropdown.d.ts +4 -0
  844. package/umd/src/book-components/_common/HamburgerMenu/HamburgerMenu.d.ts +4 -0
  845. package/umd/src/book-components/_common/MenuHoisting/MenuHoistingContext.d.ts +3 -3
  846. package/umd/src/book-components/_common/Modal/Modal.d.ts +1 -3
  847. package/umd/src/book-components/_common/Tooltip/Tooltip.d.ts +3 -0
  848. package/umd/src/book-components/icons/AboutIcon.d.ts +1 -0
  849. package/umd/src/book-components/icons/AttachmentIcon.d.ts +4 -0
  850. package/umd/src/book-components/icons/CameraIcon.d.ts +4 -0
  851. package/umd/src/book-components/icons/DownloadIcon.d.ts +1 -0
  852. package/umd/src/book-components/icons/EmailIcon.d.ts +1 -0
  853. package/umd/src/book-components/icons/MenuIcon.d.ts +1 -3
  854. package/umd/src/book-components/icons/SaveIcon.d.ts +1 -0
  855. package/umd/src/book-components/icons/SendIcon.d.ts +0 -3
  856. package/umd/src/book-components/icons/TeacherIcon.d.ts +1 -0
  857. package/umd/src/cli/$runPromptbookCli.d.ts +0 -1
  858. package/umd/src/cli/cli-commands/_boilerplate.d.ts +0 -2
  859. package/umd/src/cli/cli-commands/about.d.ts +0 -6
  860. package/umd/src/cli/cli-commands/coder/ThinkingLevel.d.ts +18 -0
  861. package/umd/src/cli/cli-commands/coder/find-fresh-emoji-tags.d.ts +0 -2
  862. package/umd/src/cli/cli-commands/coder/find-refactor-candidates.d.ts +0 -2
  863. package/umd/src/cli/cli-commands/coder/generate-boilerplates.d.ts +0 -2
  864. package/umd/src/cli/cli-commands/coder/init.d.ts +0 -2
  865. package/umd/src/cli/cli-commands/coder/run.d.ts +1 -3
  866. package/umd/src/cli/cli-commands/coder/run.test.d.ts +1 -0
  867. package/umd/src/cli/cli-commands/coder/verify.d.ts +0 -2
  868. package/umd/src/cli/cli-commands/coder.d.ts +0 -2
  869. package/umd/src/cli/cli-commands/common/handleActionErrors.d.ts +4 -0
  870. package/umd/src/cli/cli-commands/hello.d.ts +0 -5
  871. package/umd/src/cli/cli-commands/list-models.d.ts +0 -2
  872. package/umd/src/cli/cli-commands/list-scrapers.d.ts +0 -2
  873. package/umd/src/cli/cli-commands/login.d.ts +0 -5
  874. package/umd/src/cli/cli-commands/prettify.d.ts +0 -6
  875. package/umd/src/cli/cli-commands/run.d.ts +0 -8
  876. package/umd/src/cli/cli-commands/runInteractiveChatbot.d.ts +1 -5
  877. package/umd/src/cli/cli-commands/start-agents-server.d.ts +0 -2
  878. package/umd/src/cli/cli-commands/start-pipelines-server.d.ts +0 -5
  879. package/umd/src/cli/cli-commands/test-command.d.ts +0 -7
  880. package/umd/src/cli/common/$provideLlmToolsForCli.d.ts +5 -0
  881. package/umd/src/cli/main.d.ts +0 -2
  882. package/umd/src/cli/promptbookCli.d.ts +0 -7
  883. package/umd/src/collection/agent-collection/AgentCollection.d.ts +0 -3
  884. package/umd/src/collection/agent-collection/constructors/agent-collection-in-supabase/AgentCollectionInSupabase.d.ts +2 -6
  885. package/umd/src/collection/agent-collection/constructors/agent-collection-in-supabase/AgentCollectionInSupabaseOptions.d.ts +3 -0
  886. package/umd/src/collection/pipeline-collection/SimplePipelineCollection.d.ts +2 -1
  887. package/umd/src/collection/pipeline-collection/constructors/createPipelineCollectionFromDirectory.d.ts +2 -5
  888. package/umd/src/collection/pipeline-collection/constructors/createPipelineCollectionFromJson.d.ts +1 -0
  889. package/umd/src/collection/pipeline-collection/constructors/createPipelineCollectionFromPromise.d.ts +4 -3
  890. package/umd/src/collection/pipeline-collection/constructors/createPipelineCollectionFromUrl.d.ts +2 -3
  891. package/umd/src/collection/pipeline-collection/constructors/createPipelineSubcollection.d.ts +1 -0
  892. package/umd/src/collection/pipeline-collection/pipelineCollectionToJson.d.ts +0 -3
  893. package/umd/src/commands/BOOK_VERSION/BookVersionCommand.d.ts +1 -0
  894. package/umd/src/commands/BOOK_VERSION/bookVersionCommandParser.d.ts +1 -0
  895. package/umd/src/commands/EXPECT/ExpectCommand.d.ts +0 -3
  896. package/umd/src/commands/EXPECT/expectCommandParser.d.ts +3 -2
  897. package/umd/src/commands/FOREACH/ForeachCommand.d.ts +1 -0
  898. package/umd/src/commands/FOREACH/foreachCommandParser.d.ts +1 -3
  899. package/umd/src/commands/FORMAT/formatCommandParser.d.ts +1 -0
  900. package/umd/src/commands/FORMFACTOR/FormfactorCommand.d.ts +1 -0
  901. package/umd/src/commands/FORMFACTOR/formfactorCommandParser.d.ts +1 -0
  902. package/umd/src/commands/JOKER/JokerCommand.d.ts +1 -0
  903. package/umd/src/commands/JOKER/jokerCommandParser.d.ts +1 -0
  904. package/umd/src/commands/KNOWLEDGE/KnowledgeCommand.d.ts +1 -0
  905. package/umd/src/commands/KNOWLEDGE/knowledgeCommandParser.d.ts +1 -3
  906. package/umd/src/commands/KNOWLEDGE/utils/knowledgeSourceContentToName.d.ts +0 -3
  907. package/umd/src/commands/KNOWLEDGE/utils/knowledgeSourceContentToName.test.d.ts +0 -3
  908. package/umd/src/commands/MODEL/ModelCommand.d.ts +1 -0
  909. package/umd/src/commands/MODEL/modelCommandParser.d.ts +1 -0
  910. package/umd/src/commands/PARAMETER/ParameterCommand.d.ts +1 -0
  911. package/umd/src/commands/PARAMETER/parameterCommandParser.d.ts +1 -0
  912. package/umd/src/commands/PERSONA/PersonaCommand.d.ts +1 -0
  913. package/umd/src/commands/PERSONA/personaCommandParser.d.ts +1 -0
  914. package/umd/src/commands/POSTPROCESS/PostprocessCommand.d.ts +1 -0
  915. package/umd/src/commands/POSTPROCESS/postprocessCommandParser.d.ts +1 -0
  916. package/umd/src/commands/SECTION/SectionCommand.d.ts +1 -0
  917. package/umd/src/commands/SECTION/sectionCommandParser.d.ts +1 -0
  918. package/umd/src/commands/URL/UrlCommand.d.ts +1 -0
  919. package/umd/src/commands/URL/urlCommandParser.d.ts +1 -0
  920. package/umd/src/commands/X_ACTION/ActionCommand.d.ts +1 -0
  921. package/umd/src/commands/X_ACTION/actionCommandParser.d.ts +1 -3
  922. package/umd/src/commands/X_INSTRUMENT/InstrumentCommand.d.ts +1 -0
  923. package/umd/src/commands/X_INSTRUMENT/instrumentCommandParser.d.ts +1 -3
  924. package/umd/src/commands/_BOILERPLATE/BoilerplateCommand.d.ts +1 -0
  925. package/umd/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts +1 -0
  926. package/umd/src/commands/_common/stringifyCommand.d.ts +1 -1
  927. package/umd/src/commands/_common/types/CommandParser.d.ts +0 -4
  928. package/umd/src/commands/index.d.ts +0 -3
  929. package/umd/src/commitments/ACTION/ACTION.d.ts +0 -3
  930. package/umd/src/commitments/CLOSED/CLOSED.d.ts +0 -3
  931. package/umd/src/commitments/CLOSED/CLOSED.test.d.ts +0 -3
  932. package/umd/src/commitments/COMPONENT/COMPONENT.d.ts +0 -3
  933. package/umd/src/commitments/DELETE/DELETE.d.ts +0 -3
  934. package/umd/src/commitments/DICTIONARY/DICTIONARY.d.ts +0 -3
  935. package/umd/src/commitments/FORMAT/FORMAT.d.ts +0 -3
  936. package/umd/src/commitments/FROM/FROM.d.ts +0 -3
  937. package/umd/src/commitments/GOAL/GOAL.d.ts +0 -3
  938. package/umd/src/commitments/IMPORT/IMPORT.d.ts +0 -3
  939. package/umd/src/commitments/LANGUAGE/LANGUAGE.d.ts +0 -3
  940. package/umd/src/commitments/MEMORY/MEMORY.d.ts +0 -3
  941. package/umd/src/commitments/MESSAGE/MESSAGE.d.ts +0 -3
  942. package/umd/src/commitments/MESSAGE_SUFFIX/MESSAGE_SUFFIX.d.ts +0 -3
  943. package/umd/src/commitments/META/META.d.ts +0 -3
  944. package/umd/src/commitments/META/META_DESCRIPTION.d.ts +0 -3
  945. package/umd/src/commitments/META_COLOR/META_COLOR.d.ts +0 -3
  946. package/umd/src/commitments/META_DISCLAIMER/META_DISCLAIMER.d.ts +0 -3
  947. package/umd/src/commitments/META_DOMAIN/META_DOMAIN.d.ts +0 -3
  948. package/umd/src/commitments/META_FONT/META_FONT.d.ts +0 -3
  949. package/umd/src/commitments/META_IMAGE/META_IMAGE.d.ts +0 -3
  950. package/umd/src/commitments/META_INPUT_PLACEHOLDER/META_INPUT_PLACEHOLDER.d.ts +0 -3
  951. package/umd/src/commitments/META_LINK/META_LINK.d.ts +0 -3
  952. package/umd/src/commitments/META_VOICE/META_VOICE.d.ts +0 -3
  953. package/umd/src/commitments/MODEL/MODEL.d.ts +0 -3
  954. package/umd/src/commitments/OPEN/OPEN.d.ts +0 -3
  955. package/umd/src/commitments/PERSONA/PERSONA.d.ts +0 -3
  956. package/umd/src/commitments/RULE/RULE.d.ts +0 -3
  957. package/umd/src/commitments/SAMPLE/SAMPLE.d.ts +0 -3
  958. package/umd/src/commitments/SCENARIO/SCENARIO.d.ts +0 -3
  959. package/umd/src/commitments/TEAM/TEAM.d.ts +0 -3
  960. package/umd/src/commitments/TEMPLATE/TEMPLATE.d.ts +0 -3
  961. package/umd/src/commitments/USE/USE.d.ts +0 -3
  962. package/umd/src/commitments/USE/aggregateUseCommitmentSystemMessages.d.ts +2 -0
  963. package/umd/src/commitments/USE_BROWSER/USE_BROWSER.d.ts +0 -3
  964. package/umd/src/commitments/USE_BROWSER/fetchUrlContent.d.ts +4 -5
  965. package/umd/src/commitments/USE_CALENDAR/USE_CALENDAR.d.ts +0 -3
  966. package/umd/src/commitments/USE_CALENDAR/calendarReference.d.ts +0 -3
  967. package/umd/src/commitments/USE_EMAIL/USE_EMAIL.d.ts +0 -3
  968. package/umd/src/commitments/USE_IMAGE_GENERATOR/USE_IMAGE_GENERATOR.d.ts +0 -3
  969. package/umd/src/commitments/USE_MCP/USE_MCP.d.ts +0 -3
  970. package/umd/src/commitments/USE_POPUP/USE_POPUP.d.ts +0 -3
  971. package/umd/src/commitments/USE_PRIVACY/USE_PRIVACY.d.ts +0 -3
  972. package/umd/src/commitments/USE_PROJECT/USE_PROJECT.d.ts +0 -3
  973. package/umd/src/commitments/USE_PROJECT/projectReference.d.ts +0 -3
  974. package/umd/src/commitments/USE_SEARCH_ENGINE/USE_SEARCH_ENGINE.d.ts +0 -3
  975. package/umd/src/commitments/USE_SPAWN/USE_SPAWN.d.ts +0 -3
  976. package/umd/src/commitments/USE_TIME/USE_TIME.d.ts +0 -3
  977. package/umd/src/commitments/USE_TIMEOUT/USE_TIMEOUT.d.ts +0 -3
  978. package/umd/src/commitments/USE_USER_LOCATION/USE_USER_LOCATION.d.ts +0 -3
  979. package/umd/src/commitments/WALLET/WALLET.d.ts +0 -3
  980. package/umd/src/commitments/WRITING_RULES/WRITING_RULES.d.ts +0 -3
  981. package/umd/src/commitments/WRITING_SAMPLE/WRITING_SAMPLE.d.ts +0 -3
  982. package/umd/src/commitments/_base/createEmptyAgentModelRequirements.d.ts +0 -3
  983. package/umd/src/commitments/_common/commitmentToolFunctions.d.ts +2 -3
  984. package/umd/src/commitments/_common/createWritingCommitmentSections.d.ts +2 -3
  985. package/umd/src/commitments/_common/getAllCommitmentDefinitions.d.ts +1 -0
  986. package/umd/src/commitments/_common/getAllCommitmentTypes.d.ts +1 -0
  987. package/umd/src/commitments/_common/getAllCommitmentsToolFunctionsForNode.d.ts +0 -4
  988. package/umd/src/commitments/_common/getCommitmentDefinition.d.ts +1 -0
  989. package/umd/src/commitments/_common/isCommitmentSupported.d.ts +1 -0
  990. package/umd/src/commitments/_common/toolExecutionEnvelope.d.ts +0 -3
  991. package/umd/src/commitments/_common/toolRuntimeContext.d.ts +3 -3
  992. package/umd/src/commitments/index.d.ts +0 -4
  993. package/umd/src/config.test.d.ts +0 -3
  994. package/umd/src/constants/streaming.d.ts +0 -3
  995. package/umd/src/constants.d.ts +0 -3
  996. package/umd/src/conversion/archive/loadArchive.d.ts +0 -1
  997. package/umd/src/conversion/archive/saveArchive.d.ts +0 -5
  998. package/umd/src/conversion/compilePipeline.d.ts +2 -7
  999. package/umd/src/conversion/compilePipelineOnRemoteServer.d.ts +2 -5
  1000. package/umd/src/conversion/parsePipeline.d.ts +1 -11
  1001. package/umd/src/conversion/pipelineJsonToString.d.ts +1 -7
  1002. package/umd/src/conversion/prettify/prettifyPipelineString.d.ts +0 -4
  1003. package/umd/src/conversion/prettify/renderPipelineMermaidOptions.d.ts +0 -7
  1004. package/umd/src/conversion/utils/extractParameterNamesFromTask.d.ts +1 -3
  1005. package/umd/src/conversion/validation/_importPipeline.d.ts +6 -2
  1006. package/umd/src/conversion/validation/pipelineStringToJson-parseErrors.test.d.ts +0 -3
  1007. package/umd/src/conversion/validation/validatePipeline-logicErrors.test.d.ts +0 -3
  1008. package/umd/src/conversion/validation/validatePipeline.d.ts +3 -9
  1009. package/umd/src/conversion/validation/validatePipeline.test.d.ts +0 -3
  1010. package/umd/src/dialogs/simple-prompt/SimplePromptInterfaceTools.d.ts +1 -2
  1011. package/umd/src/errors/0-BoilerplateError.d.ts +0 -3
  1012. package/umd/src/errors/0-index.d.ts +0 -3
  1013. package/umd/src/errors/DatabaseError.d.ts +0 -3
  1014. package/umd/src/errors/ExpectError.d.ts +2 -1
  1015. package/umd/src/errors/ParseError.d.ts +0 -3
  1016. package/umd/src/errors/PipelineExecutionError.d.ts +0 -3
  1017. package/umd/src/executables/$provideExecutablesForNode.d.ts +0 -5
  1018. package/umd/src/executables/apps/locateLibreoffice.d.ts +0 -2
  1019. package/umd/src/executables/apps/locatePandoc.d.ts +0 -2
  1020. package/umd/src/executables/browsers/locateBrowser.d.ts +0 -1
  1021. package/umd/src/executables/browsers/locateDefaultSystemBrowser.d.ts +0 -1
  1022. package/umd/src/executables/locateApp.d.ts +0 -2
  1023. package/umd/src/executables/platforms/locateAppOnLinux.d.ts +0 -2
  1024. package/umd/src/executables/platforms/locateAppOnMacOs.d.ts +0 -2
  1025. package/umd/src/executables/platforms/locateAppOnWindows.d.ts +0 -2
  1026. package/umd/src/execution/AbstractTaskResult.d.ts +0 -4
  1027. package/umd/src/execution/AvailableModel.d.ts +0 -4
  1028. package/umd/src/execution/CommonToolsOptions.d.ts +0 -5
  1029. package/umd/src/execution/ExecutionTask.d.ts +4 -4
  1030. package/umd/src/execution/FilesystemTools.d.ts +0 -3
  1031. package/umd/src/execution/LlmExecutionTools.d.ts +3 -9
  1032. package/umd/src/execution/LlmExecutionToolsConstructor.d.ts +0 -3
  1033. package/umd/src/execution/PipelineExecutor.d.ts +0 -3
  1034. package/umd/src/execution/PipelineExecutorResult.d.ts +0 -3
  1035. package/umd/src/execution/PromptResult.d.ts +1 -9
  1036. package/umd/src/execution/PromptbookFetch.test-type.d.ts +0 -4
  1037. package/umd/src/execution/ScriptExecutionTools.d.ts +0 -4
  1038. package/umd/src/execution/Usage.d.ts +0 -3
  1039. package/umd/src/execution/UserInterfaceTools.d.ts +3 -0
  1040. package/umd/src/execution/assertsTaskSuccessful.d.ts +1 -3
  1041. package/umd/src/execution/createPipelineExecutor/00-createPipelineExecutor.d.ts +1 -0
  1042. package/umd/src/execution/createPipelineExecutor/20-executeTask.d.ts +0 -3
  1043. package/umd/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +1 -3
  1044. package/umd/src/execution/createPipelineExecutor/getContextForTask.d.ts +1 -0
  1045. package/umd/src/execution/createPipelineExecutor/getKnowledgeForTask.d.ts +0 -4
  1046. package/umd/src/execution/createPipelineExecutor/knowledgePiecesToString.d.ts +0 -1
  1047. package/umd/src/execution/execution-report/ExecutionReportJson.d.ts +1 -0
  1048. package/umd/src/execution/execution-report/ExecutionReportString.d.ts +0 -3
  1049. package/umd/src/execution/execution-report/executionReportJsonToString.d.ts +0 -5
  1050. package/umd/src/execution/translation/automatic-translate/automatic-translators/AutomaticTranslator.d.ts +3 -1
  1051. package/umd/src/execution/translation/automatic-translate/automatic-translators/FakeAutomaticTranslator.d.ts +3 -1
  1052. package/umd/src/execution/translation/automatic-translate/automatic-translators/TranslatorOptions.d.ts +3 -1
  1053. package/umd/src/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.d.ts +2 -0
  1054. package/umd/src/execution/translation/automatic-translate/translateMessages.d.ts +3 -3
  1055. package/umd/src/execution/utils/$provideExecutionToolsForNode.d.ts +2 -4
  1056. package/umd/src/execution/utils/checkExpectations.d.ts +2 -5
  1057. package/umd/src/execution/utils/forEachAsync.d.ts +5 -1
  1058. package/umd/src/execution/utils/usage-constants.d.ts +0 -3
  1059. package/umd/src/execution/utils/usageToHuman.d.ts +0 -8
  1060. package/umd/src/execution/utils/validatePromptResult.d.ts +1 -0
  1061. package/umd/src/file-security-checkers/virustotal/VirusTotalFileSecurityChecker.d.ts +1 -0
  1062. package/umd/src/formats/_common/FormatParser.d.ts +2 -9
  1063. package/umd/src/formats/_common/FormatSubvalueParser.d.ts +0 -3
  1064. package/umd/src/formats/csv/CsvFormatParser.d.ts +2 -8
  1065. package/umd/src/formats/index.d.ts +0 -3
  1066. package/umd/src/formats/json/JsonFormatParser.d.ts +0 -11
  1067. package/umd/src/formats/text/TextFormatParser.d.ts +0 -9
  1068. package/umd/src/formats/xml/XmlFormatParser.d.ts +0 -11
  1069. package/umd/src/formfactors/_common/AbstractFormfactorDefinition.d.ts +1 -3
  1070. package/umd/src/formfactors/_common/FormfactorDefinition.d.ts +1 -0
  1071. package/umd/src/formfactors/index.d.ts +0 -3
  1072. package/umd/src/high-level-abstractions/_common/HighLevelAbstraction.d.ts +0 -5
  1073. package/umd/src/high-level-abstractions/index.d.ts +0 -4
  1074. package/umd/src/high-level-abstractions/quick-chatbot/QuickChatbotHla.d.ts +0 -3
  1075. package/umd/src/llm-providers/_common/register/$llmToolsMetadataRegister.d.ts +2 -3
  1076. package/umd/src/llm-providers/_common/register/$llmToolsRegister.d.ts +2 -3
  1077. package/umd/src/llm-providers/_common/register/$provideEnvFilename.d.ts +0 -1
  1078. package/umd/src/llm-providers/_common/register/$provideLlmToolsConfigurationFromEnv.d.ts +1 -1
  1079. package/umd/src/llm-providers/_common/register/$provideLlmToolsForTestingAndScriptsAndPlayground.d.ts +3 -6
  1080. package/umd/src/llm-providers/_common/register/$provideLlmToolsForWizardOrCli.d.ts +3 -7
  1081. package/umd/src/llm-providers/_common/register/$provideLlmToolsFromEnv.d.ts +1 -16
  1082. package/umd/src/llm-providers/_common/register/$registeredLlmToolsMessage.d.ts +0 -4
  1083. package/umd/src/llm-providers/_common/register/LlmToolsConfiguration.d.ts +0 -5
  1084. package/umd/src/llm-providers/_common/register/LlmToolsMetadata.d.ts +0 -6
  1085. package/umd/src/llm-providers/_common/register/LlmToolsOptions.d.ts +0 -4
  1086. package/umd/src/llm-providers/_common/register/createLlmToolsFromConfiguration.d.ts +1 -0
  1087. package/umd/src/llm-providers/_common/utils/assertUniqueModels.d.ts +0 -3
  1088. package/umd/src/llm-providers/_common/utils/cache/CacheItem.d.ts +0 -3
  1089. package/umd/src/llm-providers/_common/utils/cache/cacheLlmTools.d.ts +1 -0
  1090. package/umd/src/llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage.d.ts +0 -4
  1091. package/umd/src/llm-providers/_common/utils/count-total-usage/countUsage.d.ts +1 -0
  1092. package/umd/src/llm-providers/_common/utils/count-total-usage/limitTotalUsage.d.ts +0 -7
  1093. package/umd/src/llm-providers/_common/utils/removeUnsupportedModelRequirements.d.ts +4 -0
  1094. package/umd/src/llm-providers/_multiple/MultipleLlmExecutionTools.d.ts +1 -0
  1095. package/umd/src/llm-providers/_multiple/getSingleLlmExecutionTools.d.ts +0 -4
  1096. package/umd/src/llm-providers/_multiple/joinLlmExecutionTools.d.ts +3 -7
  1097. package/umd/src/llm-providers/_multiple/playground/playground.d.ts +0 -1
  1098. package/umd/src/llm-providers/agent/Agent.d.ts +0 -3
  1099. package/umd/src/llm-providers/agent/AgentLlmExecutionTools.d.ts +0 -4
  1100. package/umd/src/llm-providers/agent/RemoteAgent.d.ts +0 -4
  1101. package/umd/src/llm-providers/agent/playground/playground.d.ts +0 -6
  1102. package/umd/src/llm-providers/agent/register-configuration.d.ts +0 -5
  1103. package/umd/src/llm-providers/agent/register-constructor.d.ts +0 -4
  1104. package/umd/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +2 -10
  1105. package/umd/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions.d.ts +3 -3
  1106. package/umd/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +1 -8
  1107. package/umd/src/llm-providers/anthropic-claude/computeAnthropicClaudeUsage.d.ts +1 -3
  1108. package/umd/src/llm-providers/anthropic-claude/computeAnthropicClaudeUsage.test.d.ts +0 -3
  1109. package/umd/src/llm-providers/anthropic-claude/createAnthropicClaudeExecutionTools.d.ts +0 -7
  1110. package/umd/src/llm-providers/anthropic-claude/playground/playground.d.ts +0 -5
  1111. package/umd/src/llm-providers/anthropic-claude/register-configuration.d.ts +0 -3
  1112. package/umd/src/llm-providers/anthropic-claude/register-constructor.d.ts +0 -5
  1113. package/umd/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +0 -6
  1114. package/umd/src/llm-providers/azure-openai/AzureOpenAiExecutionToolsOptions.d.ts +1 -0
  1115. package/umd/src/llm-providers/azure-openai/createAzureOpenAiExecutionTools.d.ts +0 -4
  1116. package/umd/src/llm-providers/azure-openai/playground/playground.d.ts +0 -2
  1117. package/umd/src/llm-providers/azure-openai/register-configuration.d.ts +0 -3
  1118. package/umd/src/llm-providers/azure-openai/register-constructor.d.ts +0 -4
  1119. package/umd/src/llm-providers/deepseek/DeepseekExecutionToolsOptions.d.ts +1 -0
  1120. package/umd/src/llm-providers/deepseek/createDeepseekExecutionTools.d.ts +0 -3
  1121. package/umd/src/llm-providers/deepseek/deepseek-models.d.ts +1 -6
  1122. package/umd/src/llm-providers/deepseek/register-configuration.d.ts +0 -3
  1123. package/umd/src/llm-providers/deepseek/register-constructor.d.ts +0 -4
  1124. package/umd/src/llm-providers/google/GoogleExecutionToolsOptions.d.ts +1 -0
  1125. package/umd/src/llm-providers/google/createGoogleExecutionTools.d.ts +0 -4
  1126. package/umd/src/llm-providers/google/google-models.d.ts +1 -6
  1127. package/umd/src/llm-providers/google/register-configuration.d.ts +0 -3
  1128. package/umd/src/llm-providers/google/register-constructor.d.ts +0 -4
  1129. package/umd/src/llm-providers/mocked/$fakeTextToExpectations.d.ts +1 -5
  1130. package/umd/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts +0 -4
  1131. package/umd/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts +0 -3
  1132. package/umd/src/llm-providers/mocked/test/joker.test.d.ts +0 -3
  1133. package/umd/src/llm-providers/mocked/test/mocked-chat.test.d.ts +0 -4
  1134. package/umd/src/llm-providers/mocked/test/mocked-completion.test.d.ts +0 -3
  1135. package/umd/src/llm-providers/ollama/OllamaExecutionTools.d.ts +0 -3
  1136. package/umd/src/llm-providers/ollama/OllamaExecutionToolsOptions.d.ts +1 -0
  1137. package/umd/src/llm-providers/ollama/ollama-models.d.ts +1 -4
  1138. package/umd/src/llm-providers/ollama/playground/playground.d.ts +0 -2
  1139. package/umd/src/llm-providers/ollama/register-configuration.d.ts +0 -3
  1140. package/umd/src/llm-providers/ollama/register-constructor.d.ts +0 -4
  1141. package/umd/src/llm-providers/openai/OpenAiAgentKitExecutionTools.d.ts +10 -0
  1142. package/umd/src/llm-providers/openai/OpenAiAssistantExecutionTools.d.ts +1 -8
  1143. package/umd/src/llm-providers/openai/OpenAiCompatibleExecutionTools.d.ts +0 -7
  1144. package/umd/src/llm-providers/openai/OpenAiCompatibleExecutionToolsOptions.d.ts +2 -0
  1145. package/umd/src/llm-providers/openai/computeOpenAiUsage.d.ts +1 -3
  1146. package/umd/src/llm-providers/openai/computeOpenAiUsage.test.d.ts +0 -3
  1147. package/umd/src/llm-providers/openai/createOpenAiAssistantExecutionTools.d.ts +0 -4
  1148. package/umd/src/llm-providers/openai/createOpenAiCompatibleExecutionTools.d.ts +0 -4
  1149. package/umd/src/llm-providers/openai/createOpenAiExecutionTools.d.ts +0 -4
  1150. package/umd/src/llm-providers/openai/openai-models.d.ts +1 -0
  1151. package/umd/src/llm-providers/openai/openai-models.test.d.ts +0 -3
  1152. package/umd/src/llm-providers/openai/playground/playground.d.ts +0 -2
  1153. package/umd/src/llm-providers/openai/register-configuration.d.ts +0 -3
  1154. package/umd/src/llm-providers/openai/register-constructor.d.ts +0 -4
  1155. package/umd/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts +1 -9
  1156. package/umd/src/llm-providers/remote/playground/playground.d.ts +0 -1
  1157. package/umd/src/llm-providers/vercel/playground/playground.d.ts +0 -2
  1158. package/umd/src/other/templates/getBookTemplates.d.ts +2 -5
  1159. package/umd/src/personas/preparePersona.d.ts +1 -7
  1160. package/umd/src/pipeline/PipelineInterface/PipelineInterface.d.ts +1 -0
  1161. package/umd/src/pipeline/PipelineInterface/constants.d.ts +0 -3
  1162. package/umd/src/pipeline/PipelineJson/CommonTaskJson.d.ts +0 -4
  1163. package/umd/src/pipeline/PipelineJson/DialogTaskJson.d.ts +1 -3
  1164. package/umd/src/pipeline/PipelineJson/Expectations.d.ts +4 -3
  1165. package/umd/src/pipeline/PipelineJson/KnowledgePieceJson.d.ts +0 -4
  1166. package/umd/src/pipeline/PipelineJson/KnowledgeSourceJson.d.ts +0 -3
  1167. package/umd/src/pipeline/PipelineJson/PersonaJson.d.ts +0 -3
  1168. package/umd/src/pipeline/PipelineJson/PreparationJson.d.ts +3 -5
  1169. package/umd/src/pipeline/PipelineJson/ScriptTaskJson.d.ts +1 -4
  1170. package/umd/src/pipeline/PipelineJson/SimpleTaskJson.d.ts +1 -3
  1171. package/umd/src/pipeline/book-notation.d.ts +1 -4
  1172. package/umd/src/pipeline/isValidPipelineString.d.ts +1 -3
  1173. package/umd/src/pipeline/isValidPipelineString.test.d.ts +0 -3
  1174. package/umd/src/pipeline/prompt-notation/helpers/ParameterEscaping.d.ts +5 -0
  1175. package/umd/src/pipeline/prompt-notation/helpers/ParameterNaming.d.ts +1 -0
  1176. package/umd/src/pipeline/prompt-notation/helpers/ParameterSection.d.ts +2 -0
  1177. package/umd/src/pipeline/prompt-notation.d.ts +2 -5
  1178. package/umd/src/pipeline/prompt-notation.test.d.ts +0 -3
  1179. package/umd/src/pipeline/validatePipelineString.d.ts +1 -3
  1180. package/umd/src/playground/permanent/_boilerplate.d.ts +0 -1
  1181. package/umd/src/playground/permanent/agent-with-browser-playground.d.ts +0 -1
  1182. package/umd/src/playground/permanent/error-handling-playground.d.ts +0 -1
  1183. package/umd/src/playground/playground.d.ts +0 -2
  1184. package/umd/src/postprocessing/utils/extractBlock.d.ts +2 -1
  1185. package/umd/src/postprocessing/utils/extractJsonBlock.d.ts +2 -5
  1186. package/umd/src/prepare/PrepareAndScrapeOptions.d.ts +0 -4
  1187. package/umd/src/prepare/preparePipeline.d.ts +3 -2
  1188. package/umd/src/prepare/preparePipelineOnRemoteServer.d.ts +2 -5
  1189. package/umd/src/prepare/prepareTasks.d.ts +6 -10
  1190. package/umd/src/prepare/unpreparePipeline.d.ts +1 -5
  1191. package/umd/src/remote-server/RemoteServer.d.ts +3 -0
  1192. package/umd/src/remote-server/openapi.d.ts +3 -4
  1193. package/umd/src/remote-server/socket-types/_subtypes/Identification.d.ts +1 -5
  1194. package/umd/src/remote-server/socket-types/listModels/PromptbookServer_ListModels_Request.d.ts +0 -3
  1195. package/umd/src/remote-server/socket-types/listModels/PromptbookServer_ListModels_Response.d.ts +0 -3
  1196. package/umd/src/remote-server/startAgentServer.d.ts +6 -2
  1197. package/umd/src/remote-server/startRemoteServer.d.ts +1 -15
  1198. package/umd/src/remote-server/types/RemoteClientOptions.d.ts +0 -5
  1199. package/umd/src/remote-server/types/RemoteServerOptions.d.ts +10 -4
  1200. package/umd/src/remote-server/ui/ServerApp.d.ts +1 -0
  1201. package/umd/src/remote-server/ui/types.d.ts +3 -0
  1202. package/umd/src/scrapers/_boilerplate/BoilerplateScraper.d.ts +1 -4
  1203. package/umd/src/scrapers/_boilerplate/createBoilerplateScraper.d.ts +0 -3
  1204. package/umd/src/scrapers/_boilerplate/playground/boilerplate-scraper-playground.d.ts +0 -1
  1205. package/umd/src/scrapers/_boilerplate/register-constructor.d.ts +0 -4
  1206. package/umd/src/scrapers/_boilerplate/register-metadata.d.ts +0 -3
  1207. package/umd/src/scrapers/_common/Scraper.d.ts +0 -5
  1208. package/umd/src/scrapers/_common/ScraperIntermediateSource.d.ts +0 -3
  1209. package/umd/src/scrapers/_common/prepareKnowledgePieces.d.ts +1 -0
  1210. package/umd/src/scrapers/_common/register/$provideFilesystemForNode.d.ts +0 -2
  1211. package/umd/src/scrapers/_common/register/$provideScrapersForNode.d.ts +1 -2
  1212. package/umd/src/scrapers/_common/register/$provideScriptingForNode.d.ts +0 -2
  1213. package/umd/src/scrapers/_common/register/$registeredScrapersMessage.d.ts +0 -3
  1214. package/umd/src/scrapers/_common/register/$scrapersMetadataRegister.d.ts +2 -3
  1215. package/umd/src/scrapers/_common/register/$scrapersRegister.d.ts +2 -3
  1216. package/umd/src/scrapers/_common/register/ScraperConstructor.d.ts +0 -3
  1217. package/umd/src/scrapers/_common/utils/getScraperIntermediateSource.d.ts +0 -7
  1218. package/umd/src/scrapers/_common/utils/getScraperIntermediateSource.test.d.ts +0 -3
  1219. package/umd/src/scrapers/_common/utils/promptbookFetch.d.ts +0 -3
  1220. package/umd/src/scrapers/document/DocumentScraper.d.ts +1 -6
  1221. package/umd/src/scrapers/document/DocumentScraper.test.d.ts +0 -3
  1222. package/umd/src/scrapers/document/createDocumentScraper.d.ts +0 -3
  1223. package/umd/src/scrapers/document/playground/document-scraper-playground.d.ts +0 -1
  1224. package/umd/src/scrapers/document/register-constructor.d.ts +0 -4
  1225. package/umd/src/scrapers/document/register-metadata.d.ts +0 -3
  1226. package/umd/src/scrapers/document-legacy/LegacyDocumentScraper.d.ts +1 -6
  1227. package/umd/src/scrapers/document-legacy/LegacyDocumentScraper.test.d.ts +0 -3
  1228. package/umd/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts +0 -3
  1229. package/umd/src/scrapers/document-legacy/playground/legacy-document-scraper-playground.d.ts +0 -1
  1230. package/umd/src/scrapers/document-legacy/register-constructor.d.ts +0 -4
  1231. package/umd/src/scrapers/document-legacy/register-metadata.d.ts +0 -3
  1232. package/umd/src/scrapers/markdown/MarkdownScraper.d.ts +1 -4
  1233. package/umd/src/scrapers/markdown/MarkdownScraper.test.d.ts +0 -3
  1234. package/umd/src/scrapers/markdown/createMarkdownScraper.d.ts +0 -3
  1235. package/umd/src/scrapers/markdown/playground/markdown-scraper-playground.d.ts +0 -1
  1236. package/umd/src/scrapers/markdown/register-constructor.d.ts +0 -4
  1237. package/umd/src/scrapers/markdown/register-metadata.d.ts +0 -3
  1238. package/umd/src/scrapers/markitdown/MarkitdownScraper.d.ts +1 -7
  1239. package/umd/src/scrapers/markitdown/createMarkitdownScraper.d.ts +0 -4
  1240. package/umd/src/scrapers/markitdown/playground/markitdown-scraper-playground.d.ts +0 -1
  1241. package/umd/src/scrapers/markitdown/register-constructor.d.ts +0 -5
  1242. package/umd/src/scrapers/markitdown/register-metadata.d.ts +0 -3
  1243. package/umd/src/scrapers/pdf/PdfScraper.d.ts +1 -6
  1244. package/umd/src/scrapers/pdf/createPdfScraper.d.ts +0 -3
  1245. package/umd/src/scrapers/pdf/playground/pdf-scraper-playground.d.ts +0 -1
  1246. package/umd/src/scrapers/pdf/register-constructor.d.ts +0 -4
  1247. package/umd/src/scrapers/pdf/register-metadata.d.ts +0 -3
  1248. package/umd/src/scrapers/website/WebsiteScraper.d.ts +1 -6
  1249. package/umd/src/scrapers/website/createWebsiteScraper.d.ts +0 -3
  1250. package/umd/src/scrapers/website/playground/website-scraper-playground.d.ts +0 -1
  1251. package/umd/src/scrapers/website/register-constructor.d.ts +0 -4
  1252. package/umd/src/scrapers/website/register-metadata.d.ts +0 -3
  1253. package/umd/src/scripting/javascript/JavascriptEvalExecutionTools.d.ts +1 -5
  1254. package/umd/src/scripting/javascript/JavascriptEvalExecutionTools.test.d.ts +0 -3
  1255. package/umd/src/scripting/javascript/JavascriptExecutionTools.d.ts +1 -0
  1256. package/umd/src/scripting/javascript/JavascriptExecutionToolsOptions.d.ts +0 -3
  1257. package/umd/src/scripting/javascript/postprocessing-functions.d.ts +0 -4
  1258. package/umd/src/scripting/javascript/utils/extractVariablesFromJavascript.d.ts +1 -3
  1259. package/umd/src/search-engines/SearchEngine.d.ts +3 -0
  1260. package/umd/src/speech-recognition/BrowserSpeechRecognition.d.ts +0 -2
  1261. package/umd/src/speech-recognition/OpenAiSpeechRecognition.d.ts +2 -2
  1262. package/umd/src/storage/_common/PromptbookStorage.d.ts +0 -4
  1263. package/umd/src/storage/_common/PromptbookStorage.test-type.d.ts +0 -4
  1264. package/umd/src/storage/env-storage/$EnvStorage.d.ts +0 -3
  1265. package/umd/src/storage/file-cache-storage/FileCacheStorage.d.ts +0 -2
  1266. package/umd/src/storage/local-storage/getIndexedDbStorage.d.ts +0 -1
  1267. package/umd/src/storage/local-storage/getLocalStorage.d.ts +0 -1
  1268. package/umd/src/storage/local-storage/getSessionStorage.d.ts +0 -1
  1269. package/umd/src/storage/local-storage/utils/makePromptbookStorageFromIndexedDb.d.ts +1 -0
  1270. package/umd/src/storage/local-storage/utils/makePromptbookStorageFromWebStorage.d.ts +0 -4
  1271. package/umd/src/transpilers/_common/register/$bookTranspilersRegister.d.ts +1 -3
  1272. package/umd/src/transpilers/formatted-book-in-markdown/register.d.ts +2 -5
  1273. package/umd/src/transpilers/openai-sdk/playground/playground.d.ts +0 -1
  1274. package/umd/src/transpilers/openai-sdk/register.d.ts +2 -5
  1275. package/umd/src/types/Arrayable.d.ts +1 -0
  1276. package/umd/src/types/InputParameters_private.d.ts +4 -2
  1277. package/umd/src/types/IntermediateFilesStrategy.d.ts +0 -3
  1278. package/umd/src/types/LlmCall.d.ts +0 -3
  1279. package/umd/src/types/ModelRequirements.d.ts +1 -0
  1280. package/umd/src/types/ModelVariant.d.ts +3 -0
  1281. package/umd/src/types/Parameters.d.ts +31 -0
  1282. package/umd/src/types/Parameters_private.d.ts +4 -2
  1283. package/umd/src/types/Prompt.d.ts +1 -6
  1284. package/umd/src/types/ReservedParameters_private.d.ts +2 -1
  1285. package/umd/src/types/ToolCall.d.ts +0 -2
  1286. package/umd/src/types/Updatable.d.ts +1 -3
  1287. package/umd/src/types/string_agent_hash_private.d.ts +1 -1
  1288. package/umd/src/types/string_agent_name.d.ts +32 -0
  1289. package/umd/src/types/string_agent_name_in_book_private.d.ts +1 -1
  1290. package/umd/src/types/string_agent_name_private.d.ts +2 -1
  1291. package/umd/src/types/string_agent_permanent_id_private.d.ts +2 -1
  1292. package/umd/src/types/string_business_category_name.d.ts +5 -0
  1293. package/umd/src/types/string_business_category_name_private.d.ts +1 -1
  1294. package/umd/src/types/string_char_private.d.ts +1 -1
  1295. package/umd/src/types/string_chat_prompt_private.d.ts +1 -1
  1296. package/umd/src/types/string_completion_prompt_private.d.ts +1 -1
  1297. package/umd/src/types/string_markdown.d.ts +0 -1
  1298. package/umd/src/types/string_mime_type_private.d.ts +1 -0
  1299. package/umd/src/types/string_model_description_private.d.ts +1 -1
  1300. package/umd/src/types/string_model_name.d.ts +7 -0
  1301. package/umd/src/types/string_model_name_private.d.ts +1 -1
  1302. package/umd/src/types/string_name.d.ts +31 -0
  1303. package/umd/src/types/string_name_private.d.ts +1 -1
  1304. package/umd/src/types/string_page.d.ts +15 -0
  1305. package/umd/src/types/string_page_private.d.ts +1 -1
  1306. package/umd/src/types/string_parameter_name.d.ts +11 -210
  1307. package/umd/src/types/string_parameter_value_private.d.ts +1 -1
  1308. package/umd/src/types/string_persona_description.d.ts +14 -0
  1309. package/umd/src/types/string_persona_description_private.d.ts +1 -1
  1310. package/umd/src/types/string_prompt.d.ts +49 -0
  1311. package/umd/src/types/string_prompt_image_private.d.ts +1 -1
  1312. package/umd/src/types/string_prompt_private.d.ts +1 -1
  1313. package/umd/src/types/string_reserved_parameter_name_private.d.ts +1 -1
  1314. package/umd/src/types/string_sha256.d.ts +2 -2
  1315. package/umd/src/types/string_system_message_private.d.ts +1 -1
  1316. package/umd/src/types/string_template_private.d.ts +1 -1
  1317. package/umd/src/types/string_text_prompt_private.d.ts +1 -1
  1318. package/umd/src/types/string_title.d.ts +8 -0
  1319. package/umd/src/types/string_title_private.d.ts +1 -1
  1320. package/umd/src/types/typeAliasEmoji.d.ts +0 -3
  1321. package/umd/src/types/typeAliases.d.ts +0 -6
  1322. package/umd/src/utils/DEFAULT_THINKING_MESSAGES.d.ts +5 -1
  1323. package/umd/src/utils/chat/chatAttachments/appendChatAttachmentContext.d.ts +1 -0
  1324. package/umd/src/utils/chat/chatAttachments/appendChatAttachmentContextWithContent.d.ts +1 -0
  1325. package/umd/src/utils/chat/chatAttachments/formatChatAttachmentContentContext.d.ts +1 -0
  1326. package/umd/src/utils/chat/chatAttachments/formatChatAttachmentContext.d.ts +1 -0
  1327. package/umd/src/utils/chat/chatAttachments/normalizeChatAttachments.d.ts +1 -0
  1328. package/umd/src/utils/chat/chatAttachments/resolveChatAttachmentContent.d.ts +1 -0
  1329. package/umd/src/utils/chat/chatAttachments/resolveChatAttachmentContents.d.ts +1 -0
  1330. package/umd/src/utils/chat/chatAttachments.d.ts +0 -3
  1331. package/umd/src/utils/chat/constants.d.ts +0 -3
  1332. package/umd/src/utils/clientVersion.d.ts +0 -3
  1333. package/umd/src/utils/color/$randomColor.d.ts +0 -5
  1334. package/umd/src/utils/color/css-colors.d.ts +0 -3
  1335. package/umd/src/utils/color/internal-utils/hslToRgb.d.ts +0 -3
  1336. package/umd/src/utils/color/internal-utils/rgbToHsl.d.ts +0 -3
  1337. package/umd/src/utils/color/operators/ColorTransformer.d.ts +2 -0
  1338. package/umd/src/utils/color/operators/lighten.d.ts +0 -3
  1339. package/umd/src/utils/color/operators/saturate.d.ts +0 -3
  1340. package/umd/src/utils/color/utils/areColorsEqual.d.ts +0 -3
  1341. package/umd/src/utils/color/utils/colorDistance.d.ts +2 -2
  1342. package/umd/src/utils/color/utils/colorHue.d.ts +0 -1
  1343. package/umd/src/utils/color/utils/colorHueDistance.d.ts +0 -1
  1344. package/umd/src/utils/color/utils/colorToDataUrl.d.ts +0 -3
  1345. package/umd/src/utils/database/uniqueConstraint.d.ts +1 -3
  1346. package/umd/src/utils/editable/edit-pipeline-string/addPipelineCommand.d.ts +3 -4
  1347. package/umd/src/utils/editable/edit-pipeline-string/deflatePipeline.d.ts +0 -3
  1348. package/umd/src/utils/editable/types/PipelineEditableSerialized.d.ts +2 -2
  1349. package/umd/src/utils/editable/utils/renamePipelineParameter.d.ts +4 -3
  1350. package/umd/src/utils/editable/utils/stringifyPipelineJson.d.ts +0 -6
  1351. package/umd/src/utils/environment/$detectRuntimeEnvironment.d.ts +0 -3
  1352. package/umd/src/utils/environment/$getGlobalScope.d.ts +1 -1
  1353. package/umd/src/utils/environment/$isRunningInBrowser.d.ts +0 -3
  1354. package/umd/src/utils/environment/$isRunningInJest.d.ts +0 -3
  1355. package/umd/src/utils/environment/$isRunningInNode.d.ts +0 -3
  1356. package/umd/src/utils/environment/$isRunningInWebWorker.d.ts +0 -3
  1357. package/umd/src/utils/execCommand/$execCommand.d.ts +0 -2
  1358. package/umd/src/utils/execCommand/$execCommands.d.ts +0 -1
  1359. package/umd/src/utils/execCommand/ExecCommandOptions.d.ts +3 -4
  1360. package/umd/src/utils/expectation-counters/constants.d.ts +0 -4
  1361. package/umd/src/utils/expectation-counters/countCharacters.d.ts +0 -4
  1362. package/umd/src/utils/expectation-counters/countLines.d.ts +0 -4
  1363. package/umd/src/utils/expectation-counters/countPages.d.ts +0 -4
  1364. package/umd/src/utils/expectation-counters/countParagraphs.d.ts +0 -4
  1365. package/umd/src/utils/expectation-counters/countSentences.d.ts +0 -4
  1366. package/umd/src/utils/expectation-counters/countWords.d.ts +0 -5
  1367. package/umd/src/utils/expectation-counters/index.d.ts +0 -4
  1368. package/umd/src/utils/files/$induceBookDownload.d.ts +0 -1
  1369. package/umd/src/utils/files/$induceFileDownload.d.ts +0 -1
  1370. package/umd/src/utils/files/ObjectUrl.d.ts +0 -1
  1371. package/umd/src/utils/files/isDirectoryExisting.d.ts +0 -6
  1372. package/umd/src/utils/files/isExecutable.d.ts +0 -4
  1373. package/umd/src/utils/files/isFileExisting.d.ts +0 -5
  1374. package/umd/src/utils/files/listAllFiles.d.ts +1 -5
  1375. package/umd/src/utils/files/readResponseBytes.d.ts +1 -0
  1376. package/umd/src/utils/knowledge/inlineKnowledgeSource.d.ts +11 -6
  1377. package/umd/src/utils/knowledge/simplifyKnowledgeLabel.d.ts +2 -0
  1378. package/umd/src/utils/linguistic-hash/linguisticHash.d.ts +2 -1
  1379. package/umd/src/utils/linguistic-hash/linguisticHashTypes.d.ts +0 -3
  1380. package/umd/src/utils/linguistic-hash/linguisticHashWords.cs.d.ts +0 -3
  1381. package/umd/src/utils/linguistic-hash/linguisticHashWords.en.d.ts +0 -3
  1382. package/umd/src/utils/markdown/addAutoGeneratedSection.d.ts +0 -3
  1383. package/umd/src/utils/markdown/createMarkdownTable.d.ts +0 -3
  1384. package/umd/src/utils/markdown/escapeMarkdownBlock.d.ts +0 -3
  1385. package/umd/src/utils/markdown/extractAllBlocksFromMarkdown.d.ts +1 -3
  1386. package/umd/src/utils/markdown/extractAllListItemsFromMarkdown.d.ts +1 -0
  1387. package/umd/src/utils/markdown/extractOneBlockFromMarkdown.d.ts +2 -4
  1388. package/umd/src/utils/markdown/humanizeAiText.d.ts +0 -3
  1389. package/umd/src/utils/markdown/humanizeAiTextEllipsis.d.ts +0 -3
  1390. package/umd/src/utils/markdown/humanizeAiTextEmdashed.d.ts +0 -3
  1391. package/umd/src/utils/markdown/humanizeAiTextQuotes.d.ts +0 -3
  1392. package/umd/src/utils/markdown/humanizeAiTextSources.d.ts +0 -3
  1393. package/umd/src/utils/markdown/humanizeAiTextWhitespace.d.ts +0 -3
  1394. package/umd/src/utils/markdown/prettifyMarkdown.d.ts +4 -2
  1395. package/umd/src/utils/markdown/promptbookifyAiText.d.ts +0 -3
  1396. package/umd/src/utils/markdown/removeMarkdownComments.d.ts +1 -0
  1397. package/umd/src/utils/markdown/removeMarkdownFormatting.d.ts +1 -0
  1398. package/umd/src/utils/markdown/removeMarkdownLinks.d.ts +1 -0
  1399. package/umd/src/utils/markdown/trimCodeBlock.d.ts +1 -1
  1400. package/umd/src/utils/markdown/trimEndOfCodeBlock.d.ts +1 -1
  1401. package/umd/src/utils/misc/$getCurrentDate.d.ts +1 -0
  1402. package/umd/src/utils/misc/aboutPromptbookInformation.d.ts +3 -3
  1403. package/umd/src/utils/misc/computeHash.d.ts +0 -3
  1404. package/umd/src/utils/misc/debounce.d.ts +2 -0
  1405. package/umd/src/utils/misc/emojis.d.ts +3 -8
  1406. package/umd/src/utils/misc/injectCssModuleIntoShadowRoot.d.ts +7 -2
  1407. package/umd/src/utils/misc/parseNumber.d.ts +0 -4
  1408. package/umd/src/utils/misc/xAboutPromptbookInformation.d.ts +3 -4
  1409. package/umd/src/utils/normalization/IKeywords.d.ts +0 -3
  1410. package/umd/src/utils/normalization/nameToUriPart.d.ts +1 -0
  1411. package/umd/src/utils/normalization/nameToUriParts.d.ts +1 -0
  1412. package/umd/src/utils/normalization/normalize-to-kebab-case.d.ts +2 -3
  1413. package/umd/src/utils/normalization/normalizeTo_PascalCase.d.ts +2 -0
  1414. package/umd/src/utils/normalization/normalizeTo_SCREAMING_CASE.d.ts +2 -0
  1415. package/umd/src/utils/normalization/normalizeTo_camelCase.d.ts +2 -3
  1416. package/umd/src/utils/normalization/normalizeTo_snake_case.d.ts +1 -0
  1417. package/umd/src/utils/normalization/orderJson.d.ts +1 -0
  1418. package/umd/src/utils/normalization/orderJson.test.d.ts +0 -3
  1419. package/umd/src/utils/normalization/parseKeywords.d.ts +1 -4
  1420. package/umd/src/utils/normalization/parseKeywordsFromString.d.ts +1 -0
  1421. package/umd/src/utils/normalization/removeDiacritics.d.ts +1 -3
  1422. package/umd/src/utils/normalization/removeEmojis.d.ts +1 -0
  1423. package/umd/src/utils/normalization/removeQuotes.d.ts +1 -0
  1424. package/umd/src/utils/normalization/searchKeywords.d.ts +1 -3
  1425. package/umd/src/utils/normalization/titleToName.d.ts +1 -0
  1426. package/umd/src/utils/normalization/unwrapResult.d.ts +1 -3
  1427. package/umd/src/utils/organization/$sideEffect.d.ts +1 -0
  1428. package/umd/src/utils/organization/TODO_USE.d.ts +1 -0
  1429. package/umd/src/utils/organization/just.d.ts +1 -0
  1430. package/umd/src/utils/organization/keepImported.d.ts +1 -0
  1431. package/umd/src/utils/organization/keepTypeImported.d.ts +1 -0
  1432. package/umd/src/utils/organization/keepUnused.d.ts +1 -0
  1433. package/umd/src/utils/organization/preserve.d.ts +1 -3
  1434. package/umd/src/utils/organization/really_any.d.ts +1 -0
  1435. package/umd/src/utils/organization/spaceTrim.d.ts +3 -2
  1436. package/umd/src/utils/parameters/extractParameterNames.d.ts +1 -0
  1437. package/umd/src/utils/parameters/mapAvailableToExpectedParameters.d.ts +1 -0
  1438. package/umd/src/utils/parameters/templateParameters.d.ts +2 -1
  1439. package/umd/src/utils/parameters/valueToString.d.ts +2 -2
  1440. package/umd/src/utils/random/$generateBookBoilerplate.d.ts +3 -3
  1441. package/umd/src/utils/random/$randomAgentPersona.d.ts +1 -3
  1442. package/umd/src/utils/random/$randomAgentRule.d.ts +1 -3
  1443. package/umd/src/utils/random/$randomFullnameWithColor.d.ts +4 -3
  1444. package/umd/src/utils/random/$randomItem.d.ts +0 -3
  1445. package/umd/src/utils/random/$randomSeed.d.ts +0 -3
  1446. package/umd/src/utils/random/$randomToken.d.ts +2 -5
  1447. package/umd/src/utils/random/EnglishNamePool.d.ts +1 -0
  1448. package/umd/src/utils/serialization/$deepFreeze.d.ts +1 -3
  1449. package/umd/src/utils/serialization/checkSerializableAsJson.d.ts +1 -5
  1450. package/umd/src/utils/serialization/clonePipeline.d.ts +1 -3
  1451. package/umd/src/utils/serialization/deepClone.d.ts +1 -3
  1452. package/umd/src/utils/serialization/exportJson.d.ts +1 -3
  1453. package/umd/src/utils/serialization/isSerializableAsJson.d.ts +0 -5
  1454. package/umd/src/utils/serialization/jsonStringsToJsons.d.ts +1 -4
  1455. package/umd/src/utils/serialization/serializeToPromptbookJavascript.d.ts +3 -3
  1456. package/umd/src/utils/sets/difference.d.ts +1 -3
  1457. package/umd/src/utils/sets/intersection.d.ts +1 -0
  1458. package/umd/src/utils/sets/union.d.ts +1 -0
  1459. package/umd/src/utils/take/classes/TakeChain.d.ts +4 -1
  1460. package/umd/src/utils/take/interfaces/ITakeChain.d.ts +5 -1
  1461. package/umd/src/utils/take/interfaces/Takeable.d.ts +2 -1
  1462. package/umd/src/utils/take/take.d.ts +1 -1
  1463. package/umd/src/utils/validators/filePath/isRootPath.d.ts +1 -3
  1464. package/umd/src/utils/validators/filePath/isRootPath.test.d.ts +0 -3
  1465. package/umd/src/utils/validators/filePath/isValidFilePath.d.ts +1 -3
  1466. package/umd/src/utils/validators/javascriptName/isValidJavascriptName.d.ts +1 -0
  1467. package/umd/src/utils/validators/parameterName/validateParameterName.d.ts +1 -0
  1468. package/umd/src/utils/validators/semanticVersion/isValidPromptbookVersion.d.ts +2 -1
  1469. package/umd/src/utils/validators/url/extractUrlsFromText.d.ts +1 -0
  1470. package/umd/src/utils/validators/url/isUrlOnPrivateNetwork.d.ts +1 -0
  1471. package/umd/src/utils/validators/url/isValidAgentUrl.d.ts +0 -3
  1472. package/umd/src/utils/validators/url/isValidPipelineUrl.d.ts +0 -3
  1473. package/umd/src/utils/validators/url/normalizeDomainForMatching.d.ts +1 -0
  1474. package/umd/src/version.d.ts +1 -1
  1475. package/umd/src/wizard/$getCompiledBook.d.ts +0 -2
  1476. package/umd/src/wizard/wizard.d.ts +1 -2
package/esm/index.es.js CHANGED
@@ -26,7 +26,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
26
26
  * @generated
27
27
  * @see https://github.com/webgptorg/promptbook
28
28
  */
29
- const PROMPTBOOK_ENGINE_VERSION = '0.112.0-34';
29
+ const PROMPTBOOK_ENGINE_VERSION = '0.112.0-35';
30
30
  /**
31
31
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
32
32
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -44,6 +44,7 @@ const PROMPTBOOK_ENGINE_VERSION = '0.112.0-34';
44
44
  *
45
45
  * @param value any values
46
46
  * @returns void
47
+ *
47
48
  * @private within the repository
48
49
  */
49
50
  function keepUnused(...valuesToKeep) {
@@ -53,16 +54,20 @@ function keepUnused(...valuesToKeep) {
53
54
  * Trims string from all 4 sides
54
55
  *
55
56
  * Note: This is a re-exported function from the `spacetrim` package which is
56
- * Developed by same author @hejny as this package
57
+ * Developed by same author @hejny as this package
57
58
  *
58
- * @public exported from `@promptbook/utils`
59
59
  * @see https://github.com/hejny/spacetrim#usage
60
+ *
61
+ * @public exported from `@promptbook/utils`
60
62
  */
61
63
  const spaceTrim = spaceTrim$1;
62
64
 
63
65
  /**
64
- * @private util of `@promptbook/color`
66
+ * Class implementing take chain.
67
+ *
65
68
  * @de
69
+ *
70
+ * @private util of `@promptbook/color`
66
71
  */
67
72
  class TakeChain {
68
73
  constructor(value) {
@@ -79,9 +84,9 @@ class TakeChain {
79
84
  *
80
85
  * @param {*} initialValue - The initial value.
81
86
  * @returns {Proxy<WithTake<TValue>>} - A proxy object with a `take` method.
87
+ * @deprecated [🤡] Use some better functional library instead of `TakeChain`
82
88
  *
83
89
  * @private util of `@promptbook/color`
84
- * @deprecated [🤡] Use some better functional library instead of `TakeChain`
85
90
  */
86
91
  function take(initialValue) {
87
92
  if (initialValue instanceof TakeChain) {
@@ -259,9 +264,7 @@ const CSS_COLORS = {
259
264
  yellow: '#ffff00',
260
265
  yellowgreen: '#9acd32',
261
266
  };
262
- /**
263
- * Note: [💞] Ignore a discrepancy between file name and entity name
264
- */
267
+ // Note: [💞] Ignore a discrepancy between file name and entity name
265
268
 
266
269
  /**
267
270
  * Validates that a channel value is a valid number within the range of 0 to 255.
@@ -291,7 +294,13 @@ function checkChannelValue(channelName, value) {
291
294
  }
292
295
  }
293
296
 
297
+ /**
298
+ * Constant for short hex lengths.
299
+ */
294
300
  const SHORT_HEX_LENGTHS = new Set([3, 4]);
301
+ /**
302
+ * Constant for long hex lengths.
303
+ */
295
304
  const LONG_HEX_LENGTHS = new Set([6, 8]);
296
305
  /**
297
306
  * Parses a hex string into RGBA channel values.
@@ -324,6 +333,9 @@ function parseHexColor(hex) {
324
333
  }
325
334
  return throwInvalidHex();
326
335
  }
336
+ /**
337
+ * Parses short hex channel.
338
+ */
327
339
  function parseShortHexChannel(char, onError) {
328
340
  if (!char) {
329
341
  return onError();
@@ -334,6 +346,9 @@ function parseShortHexChannel(char, onError) {
334
346
  }
335
347
  return parsed * 16;
336
348
  }
349
+ /**
350
+ * Parses long hex channel.
351
+ */
337
352
  function parseLongHexChannel(hex, start, onError) {
338
353
  const segment = hex.substr(start, 2);
339
354
  if (segment.length < 2) {
@@ -346,6 +361,9 @@ function parseLongHexChannel(hex, start, onError) {
346
361
  return parsed;
347
362
  }
348
363
 
364
+ /**
365
+ * Pattern matching hsl.
366
+ */
349
367
  const HSL_REGEX = /^hsl\(\s*([0-9.]+)\s*,\s*([0-9.]+)%\s*,\s*([0-9.]+)%\s*\)$/;
350
368
  /**
351
369
  * Parses an HSL string into RGBA channel values.
@@ -371,6 +389,9 @@ function parseHslColor(hsl) {
371
389
  alpha: 255,
372
390
  };
373
391
  }
392
+ /**
393
+ * Handles convert hsl to Rgb.
394
+ */
374
395
  function convertHslToRgb(h, s, l) {
375
396
  const c = (1 - Math.abs(2 * l - 1)) * s;
376
397
  const x = c * (1 - Math.abs(((h / 60) % 2) - 1));
@@ -409,7 +430,13 @@ function convertHslToRgb(h, s, l) {
409
430
  };
410
431
  }
411
432
 
433
+ /**
434
+ * Pattern matching RGB.
435
+ */
412
436
  const RGB_REGEX = /^rgb\(\s*([0-9.%-]+)\s*,\s*([0-9.%-]+)\s*,\s*([0-9.%-]+)\s*\)$/;
437
+ /**
438
+ * Pattern matching rgba.
439
+ */
413
440
  const RGBA_REGEX = /^rgba\(\s*([0-9.%-]+)\s*,\s*([0-9.%-]+)\s*,\s*([0-9.%-]+)\s*,\s*([0-9.%-]+)\s*\)$/;
414
441
  /**
415
442
  * Parses an RGB string into RGBA channel values.
@@ -451,6 +478,9 @@ function parseRgbaColor(rgba) {
451
478
  alpha: parseAlphaValue(match[4]),
452
479
  };
453
480
  }
481
+ /**
482
+ * Parses channel value.
483
+ */
454
484
  function parseChannelValue(value) {
455
485
  if (value.endsWith('%')) {
456
486
  const percent = parseFloat(value);
@@ -458,6 +488,9 @@ function parseChannelValue(value) {
458
488
  }
459
489
  return Math.round(parseFloat(value));
460
490
  }
491
+ /**
492
+ * Parses alpha value.
493
+ */
461
494
  function parseAlphaValue(value) {
462
495
  if (value.endsWith('%')) {
463
496
  const percent = parseFloat(value);
@@ -470,8 +503,17 @@ function parseAlphaValue(value) {
470
503
  return Math.round(parsed);
471
504
  }
472
505
 
506
+ /**
507
+ * Pattern matching hsl regex.
508
+ */
473
509
  const HSL_REGEX_PATTERN = /^hsl\(\s*([0-9.]+)\s*,\s*([0-9.]+)%\s*,\s*([0-9.]+)%\s*\)$/;
510
+ /**
511
+ * Pattern matching RGB regex.
512
+ */
474
513
  const RGB_REGEX_PATTERN = /^rgb\(\s*([0-9.%-]+)\s*,\s*([0-9.%-]+)\s*,\s*([0-9.%-]+)\s*\)$/;
514
+ /**
515
+ * Pattern matching rgba regex.
516
+ */
475
517
  const RGBA_REGEX_PATTERN = /^rgba\(\s*([0-9.%-]+)\s*,\s*([0-9.%-]+)\s*,\s*([0-9.%-]+)\s*,\s*([0-9.%-]+)\s*\)$/;
476
518
  /**
477
519
  * Color object represents an RGB color with alpha channel
@@ -837,9 +879,7 @@ function hslToRgb(hue, saturation, lightness) {
837
879
  }
838
880
  return [Math.round(red * 255), Math.round(green * 255), Math.round(blue * 255)];
839
881
  }
840
- /**
841
- * TODO: Properly name all used internal variables
842
- */
882
+ // TODO: Properly name all used internal variables
843
883
 
844
884
  /**
845
885
  * Converts RGB values to HSL values
@@ -885,9 +925,7 @@ function rgbToHsl(red, green, blue) {
885
925
  }
886
926
  return [hue, saturation, lightness];
887
927
  }
888
- /**
889
- * TODO: Properly name all used internal variables
890
- */
928
+ // TODO: Properly name all used internal variables
891
929
 
892
930
  /**
893
931
  * Makes color transformer which lighten the given color
@@ -905,9 +943,7 @@ function lighten(amount) {
905
943
  return Color.fromValues(r, g, b, alpha);
906
944
  };
907
945
  }
908
- /**
909
- * TODO: Maybe implement by mix+hsl
910
- */
946
+ // TODO: Maybe implement by mix+hsl
911
947
 
912
948
  /**
913
949
  * Makes color transformer which saturate the given color
@@ -925,9 +961,7 @@ function saturate(amount) {
925
961
  return Color.fromValues(r, g, b, alpha);
926
962
  };
927
963
  }
928
- /**
929
- * TODO: Maybe implement by mix+hsl
930
- */
964
+ // TODO: Maybe implement by mix+hsl
931
965
 
932
966
  /**
933
967
  * Returns the same value that is passed as argument.
@@ -940,6 +974,7 @@ function saturate(amount) {
940
974
  *
941
975
  * @param value any values
942
976
  * @returns the same values
977
+ *
943
978
  * @private within the repository
944
979
  */
945
980
  function just(value) {
@@ -1298,9 +1333,7 @@ function $isRunningInNode() {
1298
1333
  return false;
1299
1334
  }
1300
1335
  }
1301
- /**
1302
- * TODO: [🎺]
1303
- */
1336
+ // TODO: [🎺]
1304
1337
 
1305
1338
  /**
1306
1339
  * Normalize options for `execCommand` and `execCommands`
@@ -1368,7 +1401,6 @@ function $execCommandNormalizeOptions(options) {
1368
1401
  /**
1369
1402
  * Run one command in a shell
1370
1403
  *
1371
- *
1372
1404
  * Note: There are 2 similar functions in the codebase:
1373
1405
  * - `$execCommand` which runs a single command
1374
1406
  * - `$execCommands` which runs multiple commands
@@ -1467,7 +1499,7 @@ function $execCommand(options) {
1467
1499
  }
1468
1500
  });
1469
1501
  }
1470
- /** Note: [🟢] Code for Node command-execution helper [$execCommand](src/utils/execCommand/$execCommand.ts) should never be published into packages that could be imported into browser environment */
1502
+ // Note: [🟢] Code for Node command-execution helper [$execCommand](src/utils/execCommand/$execCommand.ts) should never be published into packages that could be imported into browser environment
1471
1503
 
1472
1504
  /**
1473
1505
  * Get the file extension from a file name
@@ -1498,11 +1530,9 @@ async function isFileExisting(filename, fs) {
1498
1530
  .catch(() => false);
1499
1531
  return isFile;
1500
1532
  }
1501
- /**
1502
- * Note: Not [~🟢~] because it is not directly dependent on `fs
1503
- * TODO: [🐠] This can be a validator - with variants that return true/false and variants that throw errors with meaningless messages
1504
- * TODO: [🖇] What about symlinks?
1505
- */
1533
+ // Note: Not [~🟢~] because it is not directly dependent on `fs
1534
+ // TODO: [🐠] This can be a validator - with variants that return true/false and variants that throw errors with meaningless messages
1535
+ // TODO: [🖇] What about symlinks?
1506
1536
 
1507
1537
  /**
1508
1538
  * Converts a name to a properly formatted subfolder path for cache storage.
@@ -1514,6 +1544,9 @@ function nameToSubfolderPath(name) {
1514
1544
  return [name.substr(0, 1).toLowerCase(), name.substr(1, 1).toLowerCase()];
1515
1545
  }
1516
1546
 
1547
+ /**
1548
+ * Collection of default diacritics removal map.
1549
+ */
1517
1550
  const defaultDiacriticsRemovalMap = [
1518
1551
  {
1519
1552
  base: 'A',
@@ -1765,6 +1798,7 @@ for (let i = 0; i < defaultDiacriticsRemovalMap.length; i++) {
1765
1798
  *
1766
1799
  * @param input The string containing diacritics to be normalized.
1767
1800
  * @returns The string with diacritics removed or normalized.
1801
+ *
1768
1802
  * @public exported from `@promptbook/utils`
1769
1803
  */
1770
1804
  function removeDiacritics(input) {
@@ -1773,9 +1807,7 @@ function removeDiacritics(input) {
1773
1807
  return DIACRITIC_VARIANTS_LETTERS[character] || character;
1774
1808
  });
1775
1809
  }
1776
- /**
1777
- * TODO: [Ж] Variant for cyrillic (and in general non-latin) letters
1778
- */
1810
+ // TODO: [Ж] Variant for cyrillic (and in general non-latin) letters
1779
1811
 
1780
1812
  /**
1781
1813
  * Converts a given text to kebab-case format.
@@ -1786,6 +1818,7 @@ function removeDiacritics(input) {
1786
1818
  * @returns The kebab-case formatted string.
1787
1819
  * @example 'hello-world'
1788
1820
  * @example 'i-love-promptbook'
1821
+ *
1789
1822
  * @public exported from `@promptbook/utils`
1790
1823
  */
1791
1824
  function normalizeToKebabCase(text) {
@@ -1826,14 +1859,13 @@ function normalizeToKebabCase(text) {
1826
1859
  normalizedName = normalizedName.replace(/-$/, '');
1827
1860
  return normalizedName;
1828
1861
  }
1829
- /**
1830
- * Note: [💞] Ignore a discrepancy between file name and entity name
1831
- */
1862
+ // Note: [💞] Ignore a discrepancy between file name and entity name
1832
1863
 
1833
1864
  /**
1834
1865
  * Tests if given string is valid file path.
1835
1866
  *
1836
1867
  * Note: This does not check if the file exists only if the path is valid
1868
+ *
1837
1869
  * @public exported from `@promptbook/utils`
1838
1870
  */
1839
1871
  function isValidFilePath(filename) {
@@ -1882,9 +1914,7 @@ function isValidFilePath(filename) {
1882
1914
  }
1883
1915
  return false;
1884
1916
  }
1885
- /**
1886
- * TODO: [🍏] Implement for MacOs
1887
- */
1917
+ // TODO: [🍏] Implement for MacOs
1888
1918
 
1889
1919
  /**
1890
1920
  * Tests if given string is valid URL.
@@ -1924,6 +1954,7 @@ function isValidUrl(url) {
1924
1954
  *
1925
1955
  * @param text with emojis
1926
1956
  * @returns text without emojis
1957
+ *
1927
1958
  * @public exported from `@promptbook/utils`
1928
1959
  */
1929
1960
  function removeEmojis(text) {
@@ -1943,6 +1974,7 @@ function removeEmojis(text) {
1943
1974
  * @param value The title string to be converted to a name.
1944
1975
  * @returns A normalized name derived from the input title.
1945
1976
  * @example 'Hello World!' -> 'hello-world'
1977
+ *
1946
1978
  * @public exported from `@promptbook/utils`
1947
1979
  */
1948
1980
  function titleToName(value) {
@@ -2023,13 +2055,11 @@ async function getScraperIntermediateSource(source, options) {
2023
2055
  };
2024
2056
  return fileHandler;
2025
2057
  }
2026
- /** Note: [🟢] Code for Node scraper helper [getScraperIntermediateSource](src/scrapers/_common/utils/getScraperIntermediateSource.ts) should never be published into packages that could be imported into browser environment */
2027
- /**
2028
- * Note: Not using `FileCacheStorage` for two reasons:
2029
- * 1) Need to store more than serialized JSONs
2030
- * 2) Need to switch between a `rootDirname` and `cacheDirname` <- TODO: [😡]
2031
- * TODO: [🐱‍🐉][🧠] Make some smart crop
2032
- */
2058
+ // Note: [🟢] Code for Node scraper helper [getScraperIntermediateSource](src/scrapers/_common/utils/getScraperIntermediateSource.ts) should never be published into packages that could be imported into browser environment
2059
+ // Note: Not using `FileCacheStorage` for two reasons:
2060
+ // 1. Need to store more than serialized JSONs.
2061
+ // 2. Need to switch between a `rootDirname` and `cacheDirname` <- TODO: [😡]
2062
+ // TODO: [🐱‍🐉][🧠] Make some smart crop
2033
2063
 
2034
2064
  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"}];
2035
2065
 
@@ -2060,9 +2090,7 @@ class ParseError extends Error {
2060
2090
  Object.setPrototypeOf(this, ParseError.prototype);
2061
2091
  }
2062
2092
  }
2063
- /**
2064
- * TODO: Maybe split `ParseError` and `ApplyError`
2065
- */
2093
+ // TODO: Maybe split `ParseError` and `ApplyError`
2066
2094
 
2067
2095
  /**
2068
2096
  * This error type indicates that somewhere in the code non-Error object was thrown and it was wrapped into the `WrappedError`
@@ -2143,6 +2171,7 @@ function isValidJsonString(value /* <- [👨‍⚖️] */) {
2143
2171
  * @param {string} pipelineString the candidate for a pipeline string
2144
2172
  * @returns {PipelineString} the same string as input, but validated as valid
2145
2173
  * @throws {ParseError} if the string is not a valid pipeline string
2174
+ *
2146
2175
  * @public exported from `@promptbook/core`
2147
2176
  */
2148
2177
  function validatePipelineString(pipelineString) {
@@ -2161,17 +2190,16 @@ function validatePipelineString(pipelineString) {
2161
2190
  // <- TODO: Implement the validation + add tests when the pipeline logic considered as invalid
2162
2191
  return pipelineString;
2163
2192
  }
2164
- /**
2165
- * TODO: [🧠][🈴] Where is the best location for this file
2166
- */
2193
+ // TODO: [🧠][🈴] Where is the best location for this file
2167
2194
 
2168
2195
  /**
2169
2196
  * Prettify the html code
2170
2197
  *
2171
2198
  * @param content raw html code
2172
2199
  * @returns formatted html code
2173
- * @private withing the package because of HUGE size of prettier dependency
2174
2200
  * @deprecated Prettier removed from Promptbook due to package size
2201
+ *
2202
+ * @private withing the package because of HUGE size of prettier dependency
2175
2203
  */
2176
2204
  function prettifyMarkdown(content) {
2177
2205
  return (content + `\n\n<!-- Note: Prettier removed from Promptbook -->`);
@@ -2194,6 +2222,7 @@ function capitalize(word) {
2194
2222
  * @deprecated TODO: [🥍][🧠] Backup original files in `PipelineJson` same as in Promptbook.studio
2195
2223
  * @param pipelineJson Promptbook in JSON format (.bookc)
2196
2224
  * @returns Promptbook in string format (.book.md)
2225
+ *
2197
2226
  * @public exported from `@promptbook/core`
2198
2227
  */
2199
2228
  function pipelineJsonToString(pipelineJson) {
@@ -2310,6 +2339,8 @@ function pipelineJsonToString(pipelineJson) {
2310
2339
  return validatePipelineString(pipelineString);
2311
2340
  }
2312
2341
  /**
2342
+ * Handles task parameter Json to string.
2343
+ *
2313
2344
  * @private internal utility of `pipelineJsonToString`
2314
2345
  */
2315
2346
  function taskParameterJsonToString(taskParameterJson) {
@@ -2320,18 +2351,17 @@ function taskParameterJsonToString(taskParameterJson) {
2320
2351
  }
2321
2352
  return parameterString;
2322
2353
  }
2323
- /**
2324
- * TODO: [🛋] Implement new features and commands into `pipelineJsonToString` + `taskParameterJsonToString` , use `stringifyCommand`
2325
- * TODO: [🧠] Is there a way to auto-detect missing features in pipelineJsonToString
2326
- * TODO: [🏛] Maybe make some markdown builder
2327
- * TODO: [🏛] Escape all
2328
- * TODO: [🧠] Should be in generated .book.md file GENERATOR_WARNING
2329
- */
2354
+ // TODO: [🛋] Implement new features and commands into `pipelineJsonToString` + `taskParameterJsonToString` , use `stringifyCommand`
2355
+ // TODO: [🧠] Is there a way to auto-detect missing features in pipelineJsonToString
2356
+ // TODO: [🏛] Maybe make some markdown builder
2357
+ // TODO: [🏛] Escape all
2358
+ // TODO: [🧠] Should be in generated .book.md file GENERATOR_WARNING
2330
2359
 
2331
2360
  /**
2332
2361
  * Orders JSON object by keys
2333
2362
  *
2334
2363
  * @returns The same type of object as the input re-ordered
2364
+ *
2335
2365
  * @public exported from `@promptbook/utils`
2336
2366
  */
2337
2367
  function orderJson(options) {
@@ -2350,6 +2380,7 @@ function orderJson(options) {
2350
2380
  * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
2351
2381
  *
2352
2382
  * @returns The same object as the input, but deeply frozen
2383
+ *
2353
2384
  * @public exported from `@promptbook/utils`
2354
2385
  */
2355
2386
  function $deepFreeze(objectValue) {
@@ -2366,9 +2397,7 @@ function $deepFreeze(objectValue) {
2366
2397
  Object.freeze(objectValue);
2367
2398
  return objectValue;
2368
2399
  }
2369
- /**
2370
- * TODO: [🧠] Is there a way how to meaningfully test this utility
2371
- */
2400
+ // TODO: [🧠] Is there a way how to meaningfully test this utility
2372
2401
 
2373
2402
  /**
2374
2403
  * Checks if the value is [🚉] serializable as JSON
@@ -2388,6 +2417,7 @@ function $deepFreeze(objectValue) {
2388
2417
  * - And much more...
2389
2418
  *
2390
2419
  * @throws UnexpectedError if the value is not serializable as JSON
2420
+ *
2391
2421
  * @public exported from `@promptbook/utils`
2392
2422
  */
2393
2423
  function checkSerializableAsJson(options) {
@@ -2502,11 +2532,9 @@ function checkSerializableAsJson(options) {
2502
2532
  `));
2503
2533
  }
2504
2534
  }
2505
- /**
2506
- * TODO: Can be return type more type-safe? like `asserts options.value is JsonValue`
2507
- * TODO: [🧠][main] !!3 In-memory cache of same values to prevent multiple checks
2508
- * Note: [🐠] This is how `checkSerializableAsJson` + `isSerializableAsJson` together can just retun true/false or rich error message
2509
- */
2535
+ // TODO: Can be return type more type-safe? like `asserts options.value is JsonValue`
2536
+ // TODO: [🧠][main] !!3 In-memory cache of same values to prevent multiple checks
2537
+ // Note: [🐠] This is how `checkSerializableAsJson` + `isSerializableAsJson` together can just retun true/false or rich error message
2510
2538
 
2511
2539
  /**
2512
2540
  * Creates a deep clone of the given object
@@ -2516,6 +2544,7 @@ function checkSerializableAsJson(options) {
2516
2544
  *
2517
2545
  * @param objectValue The object to clone.
2518
2546
  * @returns A deep, writable clone of the input object.
2547
+ *
2519
2548
  * @public exported from `@promptbook/utils`
2520
2549
  */
2521
2550
  function deepClone(objectValue) {
@@ -2532,9 +2561,7 @@ function deepClone(objectValue) {
2532
2561
  > return Object.assign({}, objectValue);
2533
2562
  */
2534
2563
  }
2535
- /**
2536
- * TODO: [🧠] Is there a way how to meaningfully test this utility
2537
- */
2564
+ // TODO: [🧠] Is there a way how to meaningfully test this utility
2538
2565
 
2539
2566
  /**
2540
2567
  * Utility to export a JSON object from a function
@@ -2547,6 +2574,7 @@ function deepClone(objectValue) {
2547
2574
  * Note: This function does not mutates the given object
2548
2575
  *
2549
2576
  * @returns The same type of object as the input but read-only and re-ordered
2577
+ *
2550
2578
  * @public exported from `@promptbook/utils`
2551
2579
  */
2552
2580
  function exportJson(options) {
@@ -2566,9 +2594,7 @@ function exportJson(options) {
2566
2594
  $deepFreeze(orderedValue);
2567
2595
  return orderedValue;
2568
2596
  }
2569
- /**
2570
- * TODO: [🧠] Is there a way how to meaningfully test this utility
2571
- */
2597
+ // TODO: [🧠] Is there a way how to meaningfully test this utility
2572
2598
 
2573
2599
  /**
2574
2600
  * Order of keys in the pipeline JSON
@@ -2628,9 +2654,7 @@ const RESERVED_PARAMETER_NAMES = exportJson({
2628
2654
  // <- TODO: Add [emoji] + instructions ACRY when adding new reserved parameter
2629
2655
  ],
2630
2656
  });
2631
- /**
2632
- * Note: [💞] Ignore a discrepancy between file name and entity name
2633
- */
2657
+ // Note: [💞] Ignore a discrepancy between file name and entity name
2634
2658
 
2635
2659
  /**
2636
2660
  * This error indicates that the promptbook object has valid syntax (=can be parsed) but contains logical errors (like circular dependencies)
@@ -2668,12 +2692,13 @@ function isValidSemanticVersion(version) {
2668
2692
  * Tests if given string is valid promptbook version
2669
2693
  * It looks into list of known promptbook versions.
2670
2694
  *
2671
- * @see https://www.npmjs.com/package/promptbook?activeTab=versions
2672
2695
  * 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.
2673
2696
  * Note: There are two similar functions:
2674
2697
  * - `isValidSemanticVersion` which tests any semantic version
2675
2698
  * - `isValidPromptbookVersion` *(this one)* which tests just Promptbook versions
2676
2699
  *
2700
+ * @see https://www.npmjs.com/package/promptbook?activeTab=versions
2701
+ *
2677
2702
  * @public exported from `@promptbook/utils`
2678
2703
  */
2679
2704
  function isValidPromptbookVersion(version) {
@@ -2716,9 +2741,7 @@ function isValidPipelineUrl(url) {
2716
2741
  */
2717
2742
  return true;
2718
2743
  }
2719
- /**
2720
- * TODO: [🐠] Maybe more info why the URL is invalid
2721
- */
2744
+ // TODO: [🐠] Maybe more info why the URL is invalid
2722
2745
 
2723
2746
  /**
2724
2747
  * Validates PipelineJson if it is logically valid
@@ -2735,6 +2758,7 @@ function isValidPipelineUrl(url) {
2735
2758
  * @param pipeline valid or invalid PipelineJson
2736
2759
  * @returns the same pipeline if it is logically valid
2737
2760
  * @throws {PipelineLogicError} on logical error in the pipeline
2761
+ *
2738
2762
  * @public exported from `@promptbook/core`
2739
2763
  */
2740
2764
  function validatePipeline(pipeline) {
@@ -2759,6 +2783,8 @@ function validatePipeline(pipeline) {
2759
2783
  return pipeline;
2760
2784
  }
2761
2785
  /**
2786
+ * Validates pipeline inner function.
2787
+ *
2762
2788
  * @private internal function for `validatePipeline`
2763
2789
  */
2764
2790
  function validatePipeline_InnerFunction(pipeline) {
@@ -3003,15 +3029,13 @@ function validatePipeline_InnerFunction(pipeline) {
3003
3029
  * > * - ...
3004
3030
  * > ex port function validatePipeline(promptbook: really_unknown): asserts promptbook is PipelineJson {
3005
3031
  */
3006
- /**
3007
- * TODO: [🧳][main] !!4 Validate that all examples match expectations
3008
- * TODO: [🧳][🐝][main] !!4 Validate that knowledge is valid (non-void)
3009
- * TODO: [🧳][main] !!4 Validate that persona can be used only with CHAT variant
3010
- * TODO: [🧳][main] !!4 Validate that parameter with reserved name not used RESERVED_PARAMETER_NAMES
3011
- * TODO: [🧳][main] !!4 Validate that reserved parameter is not used as joker
3012
- * TODO: [🧠] Validation not only logic itself but imports around - files and websites and rerefenced pipelines exists
3013
- * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
3014
- */
3032
+ // TODO: [🧳][main] !!4 Validate that all examples match expectations
3033
+ // TODO: [🧳][🐝][main] !!4 Validate that knowledge is valid (non-void)
3034
+ // TODO: [🧳][main] !!4 Validate that persona can be used only with CHAT variant
3035
+ // TODO: [🧳][main] !!4 Validate that parameter with reserved name not used RESERVED_PARAMETER_NAMES
3036
+ // TODO: [🧳][main] !!4 Validate that reserved parameter is not used as joker
3037
+ // TODO: [🧠] Validation not only logic itself but imports around - files and websites and rerefenced pipelines exists
3038
+ // TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
3015
3039
 
3016
3040
  /**
3017
3041
  * This error indicates that promptbook not found in the collection
@@ -3044,6 +3068,7 @@ class PipelineUrlError extends Error {
3044
3068
  *
3045
3069
  * @param template the string template with parameters in {curly} braces
3046
3070
  * @returns the list of parameter names
3071
+ *
3047
3072
  * @public exported from `@promptbook/utils`
3048
3073
  */
3049
3074
  function extractParameterNames(template) {
@@ -3060,6 +3085,7 @@ function extractParameterNames(template) {
3060
3085
  * Unprepare just strips the preparation data of the pipeline
3061
3086
  *
3062
3087
  * @deprecated In future version this function will be removed or deprecated
3088
+ *
3063
3089
  * @public exported from `@promptbook/core`
3064
3090
  */
3065
3091
  function unpreparePipeline(pipeline) {
@@ -3088,18 +3114,17 @@ function unpreparePipeline(pipeline) {
3088
3114
  },
3089
3115
  });
3090
3116
  }
3091
- /**
3092
- * TODO: [🧿] Maybe do same process with same granularity and subfinctions as `preparePipeline`
3093
- * TODO: Write tests for `preparePipeline`
3094
- * TODO: [🍙] Make some standard order of json properties
3095
- */
3117
+ // TODO: [🧿] Maybe do same process with same granularity and subfinctions as `preparePipeline`
3118
+ // TODO: Write tests for `preparePipeline`
3119
+ // TODO: [🍙] Make some standard order of json properties
3096
3120
 
3097
3121
  /**
3098
3122
  * Library of pipelines that groups together pipelines for an application.
3099
3123
  * This implementation is a very thin wrapper around the Array / Map of pipelines.
3100
3124
  *
3101
- * @private internal function of `createPipelineCollectionFromJson`, use `createPipelineCollectionFromJson` instead
3102
3125
  * @see https://github.com/webgptorg/pipeline#pipeline-collection
3126
+ *
3127
+ * @private internal function of `createPipelineCollectionFromJson`, use `createPipelineCollectionFromJson` instead
3103
3128
  */
3104
3129
  class SimplePipelineCollection {
3105
3130
  /**
@@ -3203,6 +3228,7 @@ class SimplePipelineCollection {
3203
3228
  *
3204
3229
  * @param promptbookSources
3205
3230
  * @returns PipelineCollection
3231
+ *
3206
3232
  * @public exported from `@promptbook/core`
3207
3233
  */
3208
3234
  function createPipelineCollectionFromJson(...promptbooks) {
@@ -3215,16 +3241,15 @@ function createPipelineCollectionFromJson(...promptbooks) {
3215
3241
  * Note: `$` is used to indicate that this function is not a pure function - it is not deterministic
3216
3242
  * Note: This function is cryptographically secure (it uses crypto.randomBytes internally)
3217
3243
  *
3218
- * @private internal helper function
3219
3244
  * @returns secure random token
3245
+ *
3246
+ * @private internal helper function
3220
3247
  */
3221
3248
  function $randomToken(randomness) {
3222
3249
  return randomBytes(randomness).toString('hex');
3223
3250
  }
3224
- /**
3225
- * TODO: [🤶] Maybe export through `@promptbook/utils` or `@promptbook/random` package
3226
- * TODO: Maybe use nanoid instead https://github.com/ai/nanoid
3227
- */
3251
+ // TODO: [🤶] Maybe export through `@promptbook/utils` or `@promptbook/random` package
3252
+ // TODO: Maybe use nanoid instead https://github.com/ai/nanoid
3228
3253
 
3229
3254
  /**
3230
3255
  * This error indicates errors during the execution of the pipeline
@@ -3241,9 +3266,7 @@ class PipelineExecutionError extends Error {
3241
3266
  Object.setPrototypeOf(this, PipelineExecutionError.prototype);
3242
3267
  }
3243
3268
  }
3244
- /**
3245
- * TODO: [🧠][🌂] Add id to all errors
3246
- */
3269
+ // TODO: [🧠][🌂] Add id to all errors
3247
3270
 
3248
3271
  /**
3249
3272
  * Determine if the pipeline is fully prepared
@@ -3366,17 +3389,16 @@ class DatabaseError extends Error {
3366
3389
  Object.setPrototypeOf(this, DatabaseError.prototype);
3367
3390
  }
3368
3391
  }
3369
- /**
3370
- * TODO: [🐱‍🚀] Explain that NotFoundError ([🐱‍🚀] and other specific errors) has priority over DatabaseError in some contexts
3371
- */
3392
+ // TODO: [🐱‍🚀] Explain that NotFoundError ([🐱‍🚀] and other specific errors) has priority over DatabaseError in some contexts
3372
3393
 
3373
3394
  /**
3374
3395
  * This error occurs when some expectation is not met in the execution of the pipeline
3375
3396
  *
3376
- * @public exported from `@promptbook/core`
3377
3397
  * Note: Do not throw this error, its reserved for `checkExpectations` and `createPipelineExecutor` and public ONLY to be serializable through remote server
3378
3398
  * Note: Always thrown in `checkExpectations` and catched in `createPipelineExecutor` and rethrown as `PipelineExecutionError`
3379
3399
  * Note: This is a kindof subtype of PipelineExecutionError
3400
+ *
3401
+ * @public exported from `@promptbook/core`
3380
3402
  */
3381
3403
  class ExpectError extends Error {
3382
3404
  constructor(message) {
@@ -3509,9 +3531,7 @@ const ALL_ERRORS = {
3509
3531
  ...PROMPTBOOK_ERRORS,
3510
3532
  ...COMMON_JAVASCRIPT_ERRORS,
3511
3533
  };
3512
- /**
3513
- * Note: [💞] Ignore a discrepancy between file name and entity name
3514
- */
3534
+ // Note: [💞] Ignore a discrepancy between file name and entity name
3515
3535
 
3516
3536
  /**
3517
3537
  * Serializes an error into a [🚉] JSON-serializable object
@@ -3580,7 +3600,7 @@ function jsonParse(value) {
3580
3600
 
3581
3601
  /**
3582
3602
  * Recursively converts JSON strings to JSON objects
3583
-
3603
+ *
3584
3604
  * @public exported from `@promptbook/utils`
3585
3605
  */
3586
3606
  function jsonStringsToJsons(object) {
@@ -3604,9 +3624,7 @@ function jsonStringsToJsons(object) {
3604
3624
  }
3605
3625
  return newObject;
3606
3626
  }
3607
- /**
3608
- * TODO: Type the return type correctly
3609
- */
3627
+ // TODO: Type the return type correctly
3610
3628
 
3611
3629
  /**
3612
3630
  * Deserializes the error object
@@ -3641,6 +3659,7 @@ function deserializeError(error, isStackAddedToMessage = true) {
3641
3659
  *
3642
3660
  * @param executionResult - The partial result of the Promptbook execution
3643
3661
  * @throws {PipelineExecutionError} If the execution is not successful or if multiple errors occurred
3662
+ *
3644
3663
  * @private internal helper function of `asPromise` method of `ExecutionTask`
3645
3664
  */
3646
3665
  function assertsTaskSuccessful(executionResult) {
@@ -3671,9 +3690,7 @@ function assertsTaskSuccessful(executionResult) {
3671
3690
  `));
3672
3691
  }
3673
3692
  }
3674
- /**
3675
- * TODO: [🧠] Can this return type be better typed than void
3676
- */
3693
+ // TODO: [🧠] Can this return type be better typed than void
3677
3694
 
3678
3695
  /**
3679
3696
  * Helper to create a new task
@@ -3864,10 +3881,8 @@ function createTask(options) {
3864
3881
  },
3865
3882
  };
3866
3883
  }
3867
- /**
3868
- * TODO: Maybe allow to terminate the task and add getter `isFinished` or `status`
3869
- * TODO: [🐚] Split into more files and make `PrepareTask` & `RemoteTask` + split the function
3870
- */
3884
+ // TODO: Maybe allow to terminate the task and add getter `isFinished` or `status`
3885
+ // TODO: [🐚] Split into more files and make `PrepareTask` & `RemoteTask` + split the function
3871
3886
 
3872
3887
  /**
3873
3888
  * Represents the uncertain value
@@ -3935,9 +3950,7 @@ const UNCERTAIN_USAGE = $deepFreeze({
3935
3950
  pagesCount: UNCERTAIN_ZERO_VALUE,
3936
3951
  },
3937
3952
  });
3938
- /**
3939
- * Note: [💞] Ignore a discrepancy between file name and entity name
3940
- */
3953
+ // Note: [💞] Ignore a discrepancy between file name and entity name
3941
3954
 
3942
3955
  /**
3943
3956
  * Async version of Array.forEach
@@ -3945,8 +3958,9 @@ const UNCERTAIN_USAGE = $deepFreeze({
3945
3958
  * @param array - Array to iterate over
3946
3959
  * @param options - Options for the function
3947
3960
  * @param callbackfunction - Function to call for each item
3948
- * @public exported from `@promptbook/utils`
3949
3961
  * @deprecated [🪂] Use queues instead
3962
+ *
3963
+ * @public exported from `@promptbook/utils`
3950
3964
  */
3951
3965
  async function forEachAsync(array, options, callbackfunction) {
3952
3966
  const { maxParallelCount = Infinity } = options;
@@ -4031,6 +4045,7 @@ function addUsage(...usageItems) {
4031
4045
  *
4032
4046
  * @param llmTools - The LLM tools to be intercepted and tracked
4033
4047
  * @returns Full proxy of the tools with added usage tracking capabilities
4048
+ *
4034
4049
  * @public exported from `@promptbook/core`
4035
4050
  */
4036
4051
  function countUsage(llmTools) {
@@ -4155,6 +4170,7 @@ const MULTIPLE_PROVIDER_PROFILE = {
4155
4170
  * Multiple LLM Execution Tools is a proxy server that uses multiple execution tools internally and exposes the executor interface externally.
4156
4171
  *
4157
4172
  * Note: Internal utility of `joinLlmExecutionTools` but exposed type
4173
+ *
4158
4174
  * @public exported from `@promptbook/core`
4159
4175
  */
4160
4176
  class MultipleLlmExecutionTools {
@@ -4317,16 +4333,16 @@ class MultipleLlmExecutionTools {
4317
4333
  * `MultipleLlmExecutionTools` object. It provides failover and aggregation logic:
4318
4334
  *
4319
4335
  * 1. **Failover**: When a model call is made, it tries providers in the order they were provided.
4320
- * If the first provider doesn't support the requested model or fails, it tries the next one.
4336
+ * If the first provider doesn't support the requested model or fails, it tries the next one.
4321
4337
  * 2. **Aggregation**: `listModels` returns a combined list of all models available from all providers.
4322
4338
  * 3. **Empty case**: If no tools are provided, it logs a warning (as Promptbook requires LLMs to function).
4323
4339
  *
4340
+ * Tip: You don't have to use this function directly, just pass an array of LlmExecutionTools to the `ExecutionTools`.
4341
+ *
4324
4342
  * @param title - A descriptive title for this collection of joined tools
4325
4343
  * @param llmExecutionTools - An array of execution tools to be joined
4326
4344
  * @returns A single unified execution tool wrapper
4327
4345
  *
4328
- * Tip: You don't have to use this function directly, just pass an array of LlmExecutionTools to the `ExecutionTools`.
4329
- *
4330
4346
  * @public exported from `@promptbook/core`
4331
4347
  */
4332
4348
  function joinLlmExecutionTools(title, ...llmExecutionTools) {
@@ -4363,10 +4379,8 @@ function joinLlmExecutionTools(title, ...llmExecutionTools) {
4363
4379
  }
4364
4380
  return new MultipleLlmExecutionTools(title || 'Multiple LLM Providers joined by `joinLlmExecutionTools`', ...llmExecutionTools);
4365
4381
  }
4366
- /**
4367
- * TODO: [🙆] `getSingleLlmExecutionTools` vs `joinLlmExecutionTools` - explain difference or pick one
4368
- * TODO: [👷‍♂️] Write a comprehensive manual about how to construct and use LLM execution tools in Promptbook
4369
- */
4382
+ // TODO: [🙆] `getSingleLlmExecutionTools` vs `joinLlmExecutionTools` - explain difference or pick one
4383
+ // TODO: [👷‍♂️] Write a comprehensive manual about how to construct and use LLM execution tools in Promptbook
4370
4384
 
4371
4385
  /**
4372
4386
  * Just returns the given `LlmExecutionTools` or joins multiple into one
@@ -4380,15 +4394,14 @@ function getSingleLlmExecutionTools(oneOrMoreLlmExecutionTools) {
4380
4394
  : joinLlmExecutionTools('Multiple LLM Providers joined by `getSingleLlmExecutionTools`', ..._llms);
4381
4395
  return llmTools;
4382
4396
  }
4383
- /**
4384
- * TODO: [🙆] `getSingleLlmExecutionTools` vs `joinLlmExecutionTools` - explain difference or pick one
4385
- * TODO: [👷‍♂️] Write a comprehensive manual about how to construct and use LLM execution tools in Promptbook
4386
- */
4397
+ // TODO: [🙆] `getSingleLlmExecutionTools` vs `joinLlmExecutionTools` - explain difference or pick one
4398
+ // TODO: [👷‍♂️] Write a comprehensive manual about how to construct and use LLM execution tools in Promptbook
4387
4399
 
4388
4400
  /**
4389
4401
  * Prepares the persona for the pipeline
4390
4402
  *
4391
4403
  * @see https://github.com/webgptorg/promptbook/discussions/22
4404
+ *
4392
4405
  * @public exported from `@promptbook/core`
4393
4406
  */
4394
4407
  async function preparePersona(personaDescription, tools, options) {
@@ -4445,13 +4458,11 @@ async function preparePersona(personaDescription, tools, options) {
4445
4458
  modelsRequirements,
4446
4459
  };
4447
4460
  }
4448
- /**
4449
- * TODO: [😩] DRY `preparePersona` and `selectBestModelFromAvailable`
4450
- * TODO: [🔃][main] If the persona was prepared with different version or different set of models, prepare it once again
4451
- * TODO: [🏢] Check validity of `modelName` in pipeline
4452
- * TODO: [🏢] Check validity of `systemMessage` in pipeline
4453
- * TODO: [🏢] Check validity of `temperature` in pipeline
4454
- */
4461
+ // TODO: [😩] DRY `preparePersona` and `selectBestModelFromAvailable`
4462
+ // TODO: [🔃][main] If the persona was prepared with different version or different set of models, prepare it once again
4463
+ // TODO: [🏢] Check validity of `modelName` in pipeline
4464
+ // TODO: [🏢] Check validity of `systemMessage` in pipeline
4465
+ // TODO: [🏢] Check validity of `temperature` in pipeline
4455
4466
 
4456
4467
  /**
4457
4468
  * Safely retrieves the global scope object (window in browser, global in Node.js)
@@ -4459,7 +4470,7 @@ async function preparePersona(personaDescription, tools, options) {
4459
4470
  *
4460
4471
  * Note: `$` is used to indicate that this function is not a pure function - it access global scope
4461
4472
  *
4462
- * @private internal function of `$Register`
4473
+ * @private internal function of `$Register`
4463
4474
  */
4464
4475
  function $getGlobalScope() {
4465
4476
  return Function('return this')();
@@ -4474,6 +4485,7 @@ function $getGlobalScope() {
4474
4485
  * @returns The normalized text in SCREAMING_CASE format.
4475
4486
  * @example 'HELLO_WORLD'
4476
4487
  * @example 'I_LOVE_PROMPTBOOK'
4488
+ *
4477
4489
  * @public exported from `@promptbook/utils`
4478
4490
  */
4479
4491
  function normalizeTo_SCREAMING_CASE(text) {
@@ -4531,6 +4543,7 @@ function normalizeTo_SCREAMING_CASE(text) {
4531
4543
  * @returns The normalized text in snake_case format.
4532
4544
  * @example 'hello_world'
4533
4545
  * @example 'i_love_promptbook'
4546
+ *
4534
4547
  * @public exported from `@promptbook/utils`
4535
4548
  */
4536
4549
  function normalizeTo_snake_case(text) {
@@ -4589,26 +4602,26 @@ class $Register {
4589
4602
  * Global registry for storing metadata about all available scrapers and converters.
4590
4603
  *
4591
4604
  * Note: `$` is used to indicate that this interacts with the global scope.
4605
+ *
4592
4606
  * @singleton Only one instance of each register is created per build, but there can be more in different contexts (e.g., tests).
4607
+ *
4593
4608
  * @public exported from `@promptbook/core`
4594
4609
  */
4595
4610
  const $scrapersMetadataRegister = new $Register('scrapers_metadata');
4596
- /**
4597
- * TODO: [®] DRY Register logic
4598
- */
4611
+ // TODO: [®] DRY Register logic
4599
4612
 
4600
4613
  /**
4601
4614
  * Registry for all available scrapers in the system.
4602
4615
  * Central point for registering and accessing different types of content scrapers.
4603
4616
  *
4604
4617
  * Note: `$` is used to indicate that this interacts with the global scope
4618
+ *
4605
4619
  * @singleton Only one instance of each register is created per build, but there can be more than one in different build modules
4620
+ *
4606
4621
  * @public exported from `@promptbook/core`
4607
4622
  */
4608
4623
  const $scrapersRegister = new $Register('scraper_constructors');
4609
- /**
4610
- * TODO: [®] DRY Register logic
4611
- */
4624
+ // TODO: [®] DRY Register logic
4612
4625
 
4613
4626
  /**
4614
4627
  * Creates a message with all registered scrapers
@@ -4693,9 +4706,7 @@ function $registeredScrapersMessage(availableScrapers) {
4693
4706
 
4694
4707
  `);
4695
4708
  }
4696
- /**
4697
- * TODO: [®] DRY Register logic
4698
- */
4709
+ // TODO: [®] DRY Register logic
4699
4710
 
4700
4711
  /**
4701
4712
  * Creates unique name for the source
@@ -4714,9 +4725,7 @@ function knowledgeSourceContentToName(knowledgeSourceContent) {
4714
4725
  // <- TODO: Use MAX_FILENAME_LENGTH
4715
4726
  return name;
4716
4727
  }
4717
- /**
4718
- * TODO: [🐱‍🐉][🧠] Make some smart crop NOT source-i-m-pavol-a-develop-... BUT source-i-m-pavol-a-developer-...
4719
- */
4728
+ // TODO: [🐱‍🐉][🧠] Make some smart crop NOT source-i-m-pavol-a-develop-... BUT source-i-m-pavol-a-developer-...
4720
4729
 
4721
4730
  /**
4722
4731
  * Convert file extension to mime type
@@ -4765,9 +4774,7 @@ const promptbookFetch = async (urlOrRequest, init) => {
4765
4774
  `));
4766
4775
  }
4767
4776
  };
4768
- /**
4769
- * TODO: [🧠] Maybe rename because it is not used only for scrapers but also in `$getCompiledBook`
4770
- */
4777
+ // TODO: [🧠] Maybe rename because it is not used only for scrapers but also in `$getCompiledBook`
4771
4778
 
4772
4779
  /**
4773
4780
  * Factory function that creates a handler for processing knowledge sources.
@@ -4987,6 +4994,7 @@ async function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
4987
4994
  * Prepares the knowledge pieces
4988
4995
  *
4989
4996
  * @see https://github.com/webgptorg/promptbook/discussions/41
4997
+ *
4990
4998
  * @public exported from `@promptbook/core`
4991
4999
  */
4992
5000
  async function prepareKnowledgePieces(knowledgeSources, tools, options) {
@@ -5128,25 +5136,24 @@ async function prepareTasks(pipeline, tools, options) {
5128
5136
  });
5129
5137
  return { tasksPrepared };
5130
5138
  }
5131
- /**
5132
- * TODO: [😂] Adding knowledge should be convert to async high-level abstractions, similar thing with expectations to sync high-level abstractions
5133
- * TODO: [🧠] Add context to each task (if missing)
5134
- * TODO: [🧠] What is better name `prepareTask` or `prepareTaskAndParameters`
5135
- * TODO: [♨][main] !!3 Prepare index the examples and maybe tasks
5136
- * TODO: Write tests for `preparePipeline`
5137
- * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
5138
- * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time
5139
- * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
5140
- */
5139
+ // TODO: [😂] Adding knowledge should be convert to async high-level abstractions, similar thing with expectations to sync high-level abstractions
5140
+ // TODO: [🧠] Add context to each task (if missing)
5141
+ // TODO: [🧠] What is better name `prepareTask` or `prepareTaskAndParameters`
5142
+ // TODO: [][main] !!3 Prepare index the examples and maybe tasks
5143
+ // TODO: Write tests for `preparePipeline`
5144
+ // TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
5145
+ // TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time
5146
+ // TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
5141
5147
 
5142
5148
  /**
5143
5149
  * Prepare pipeline locally
5144
5150
  *
5145
- * @see https://github.com/webgptorg/promptbook/discussions/196
5146
- *
5147
5151
  * Note: This function does not validate logic of the pipeline
5148
5152
  * Note: This function acts as part of compilation process
5149
5153
  * Note: When the pipeline is already prepared, it returns the same pipeline
5154
+ *
5155
+ * @see https://github.com/webgptorg/promptbook/discussions/196
5156
+ *
5150
5157
  * @public exported from `@promptbook/core`
5151
5158
  */
5152
5159
  async function preparePipeline(pipeline, tools, options) {
@@ -5317,8 +5324,8 @@ function numberToString(value) {
5317
5324
  * This is useful and used in the `templateParameters` function
5318
5325
  *
5319
5326
  * Note: This function is not just calling `toString` method
5320
- * It's more complex and can handle this conversion specifically for LLM models
5321
- * See `VALUE_STRINGS`
5327
+ * It's more complex and can handle this conversion specifically for LLM models
5328
+ * See `VALUE_STRINGS`
5322
5329
  *
5323
5330
  * Note: There are 2 similar functions
5324
5331
  * - `valueToString` converts value to string for LLM models as human-readable string
@@ -5371,6 +5378,7 @@ function valueToString(value) {
5371
5378
  * @param script from which to extract the variables
5372
5379
  * @returns the list of variable names
5373
5380
  * @throws {ParseError} if the script is invalid
5381
+ *
5374
5382
  * @public exported from `@promptbook/javascript`
5375
5383
  */
5376
5384
  function extractVariablesFromJavascript(script) {
@@ -5436,9 +5444,7 @@ function extractVariablesFromJavascript(script) {
5436
5444
  }
5437
5445
  return variables;
5438
5446
  }
5439
- /**
5440
- * TODO: [🔣] Support for multiple languages - python, java,...
5441
- */
5447
+ // TODO: [🔣] Support for multiple languages - python, java,...
5442
5448
 
5443
5449
  /**
5444
5450
  * Parses the task and returns the set of all used parameters
@@ -5446,6 +5452,7 @@ function extractVariablesFromJavascript(script) {
5446
5452
  * @param task the task with used parameters
5447
5453
  * @returns the set of parameter names
5448
5454
  * @throws {ParseError} if the script is invalid
5455
+ *
5449
5456
  * @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
5450
5457
  */
5451
5458
  function extractParameterNamesFromTask(task) {
@@ -5486,14 +5493,13 @@ function extractParameterNamesFromTask(task) {
5486
5493
  }
5487
5494
  return parameterNames;
5488
5495
  }
5489
- /**
5490
- * TODO: [🔣] If script require contentLanguage
5491
- */
5496
+ // TODO: [🔣] If script require contentLanguage
5492
5497
 
5493
5498
  /**
5494
5499
  * Create difference set of two sets.
5495
5500
  *
5496
5501
  * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
5502
+ *
5497
5503
  * @public exported from `@promptbook/utils`
5498
5504
  */
5499
5505
  function difference(a, b, isEqual = (a, b) => a === b) {
@@ -5505,14 +5511,13 @@ function difference(a, b, isEqual = (a, b) => a === b) {
5505
5511
  }
5506
5512
  return diff;
5507
5513
  }
5508
- /**
5509
- * TODO: [🧠][💯] Maybe also implement symmetricDifference
5510
- */
5514
+ // TODO: [🧠][💯] Maybe also implement symmetricDifference
5511
5515
 
5512
5516
  /**
5513
5517
  * Creates a new set with all elements that are present in either set
5514
5518
  *
5515
5519
  * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
5520
+ *
5516
5521
  * @public exported from `@promptbook/utils`
5517
5522
  */
5518
5523
  function union(...sets) {
@@ -5578,8 +5583,9 @@ function isValidCsvString(value) {
5578
5583
  /**
5579
5584
  * Definition for CSV spreadsheet
5580
5585
  *
5586
+ * TODO: [🏢] Export from package `@promptbook/csv`
5587
+ *
5581
5588
  * @public exported from `@promptbook/core`
5582
- * <- TODO: [🏢] Export from package `@promptbook/csv`
5583
5589
  */
5584
5590
  const CsvFormatParser = {
5585
5591
  formatName: 'CSV',
@@ -5669,13 +5675,11 @@ const CsvFormatParser = {
5669
5675
  },
5670
5676
  ],
5671
5677
  };
5672
- /**
5673
- * TODO: [🍓] In `CsvFormatParser` implement simple `isValid`
5674
- * TODO: [🍓] In `CsvFormatParser` implement partial `canBeValid`
5675
- * TODO: [🍓] In `CsvFormatParser` implement `heal
5676
- * TODO: [🍓] In `CsvFormatParser` implement `subvalueParsers`
5677
- * TODO: [🏢] Allow to expect something inside CSV objects and other formats
5678
- */
5678
+ // TODO: [🍓] In `CsvFormatParser` implement simple `isValid`
5679
+ // TODO: [🍓] In `CsvFormatParser` implement partial `canBeValid`
5680
+ // TODO: [🍓] In `CsvFormatParser` implement `heal
5681
+ // TODO: [🍓] In `CsvFormatParser` implement `subvalueParsers`
5682
+ // TODO: [🏢] Allow to expect something inside CSV objects and other formats
5679
5683
 
5680
5684
  /**
5681
5685
  * Definition for JSON format
@@ -5696,17 +5700,15 @@ const JsonFormatParser = {
5696
5700
  },
5697
5701
  subvalueParsers: [],
5698
5702
  };
5699
- /**
5700
- * TODO: [🧠] Maybe proper instance of object
5701
- * TODO: [0] Make string_serialized_json
5702
- * TODO: [1] Make type for JSON Settings and Schema
5703
- * TODO: [🧠] What to use for validating JSONs - JSON Schema, ZoD, typescript types/interfaces,...?
5704
- * TODO: [🍓] In `JsonFormatParser` implement simple `isValid`
5705
- * TODO: [🍓] In `JsonFormatParser` implement partial `canBeValid`
5706
- * TODO: [🍓] In `JsonFormatParser` implement `heal
5707
- * TODO: [🍓] In `JsonFormatParser` implement `subvalueParsers`
5708
- * TODO: [🏢] Allow to expect something inside JSON objects and other formats
5709
- */
5703
+ // TODO: [🧠] Maybe proper instance of object
5704
+ // TODO: [0] Make string_serialized_json
5705
+ // TODO: [1] Make type for JSON Settings and Schema
5706
+ // TODO: [🧠] What to use for validating JSONs - JSON Schema, ZoD, typescript types/interfaces,...?
5707
+ // TODO: [🍓] In `JsonFormatParser` implement simple `isValid`
5708
+ // TODO: [🍓] In `JsonFormatParser` implement partial `canBeValid`
5709
+ // TODO: [🍓] In `JsonFormatParser` implement `heal
5710
+ // TODO: [🍓] In `JsonFormatParser` implement `subvalueParsers`
5711
+ // TODO: [🏢] Allow to expect something inside JSON objects and other formats
5710
5712
 
5711
5713
  /**
5712
5714
  * Definition for any text - this will be always valid
@@ -5744,15 +5746,13 @@ const TextFormatParser = {
5744
5746
  // <- TODO: [🧠][🤠] Here should be all words, characters, lines, paragraphs, pages available as subvalues
5745
5747
  ],
5746
5748
  };
5747
- /**
5748
- * TODO: [1] Make type for XML Text and Schema
5749
- * TODO: [🧠][🤠] Here should be all words, characters, lines, paragraphs, pages available as subvalues
5750
- * TODO: [🍓] In `TextFormatParser` implement simple `isValid`
5751
- * TODO: [🍓] In `TextFormatParser` implement partial `canBeValid`
5752
- * TODO: [🍓] In `TextFormatParser` implement `heal
5753
- * TODO: [🍓] In `TextFormatParser` implement `subvalueParsers`
5754
- * TODO: [🏢] Allow to expect something inside each item of list and other formats
5755
- */
5749
+ // TODO: [1] Make type for XML Text and Schema
5750
+ // TODO: [🧠][🤠] Here should be all words, characters, lines, paragraphs, pages available as subvalues
5751
+ // TODO: [🍓] In `TextFormatParser` implement simple `isValid`
5752
+ // TODO: [🍓] In `TextFormatParser` implement partial `canBeValid`
5753
+ // TODO: [🍓] In `TextFormatParser` implement `heal
5754
+ // TODO: [🍓] In `TextFormatParser` implement `subvalueParsers`
5755
+ // TODO: [🏢] Allow to expect something inside each item of list and other formats
5756
5756
 
5757
5757
  /**
5758
5758
  * Function to check if a string is valid XML
@@ -5797,17 +5797,15 @@ const XmlFormatParser = {
5797
5797
  },
5798
5798
  subvalueParsers: [],
5799
5799
  };
5800
- /**
5801
- * TODO: [🧠] Maybe proper instance of object
5802
- * TODO: [0] Make string_serialized_xml
5803
- * TODO: [1] Make type for XML Settings and Schema
5804
- * TODO: [🧠] What to use for validating XMLs - XSD,...
5805
- * TODO: [🍓] In `XmlFormatParser` implement simple `isValid`
5806
- * TODO: [🍓] In `XmlFormatParser` implement partial `canBeValid`
5807
- * TODO: [🍓] In `XmlFormatParser` implement `heal
5808
- * TODO: [🍓] In `XmlFormatParser` implement `subvalueParsers`
5809
- * TODO: [🏢] Allow to expect something inside XML and other formats
5810
- */
5800
+ // TODO: [🧠] Maybe proper instance of object
5801
+ // TODO: [0] Make string_serialized_xml
5802
+ // TODO: [1] Make type for XML Settings and Schema
5803
+ // TODO: [🧠] What to use for validating XMLs - XSD,...
5804
+ // TODO: [🍓] In `XmlFormatParser` implement simple `isValid`
5805
+ // TODO: [🍓] In `XmlFormatParser` implement partial `canBeValid`
5806
+ // TODO: [🍓] In `XmlFormatParser` implement `heal
5807
+ // TODO: [🍓] In `XmlFormatParser` implement `subvalueParsers`
5808
+ // TODO: [🏢] Allow to expect something inside XML and other formats
5811
5809
 
5812
5810
  /**
5813
5811
  * Definitions for all formats supported by Promptbook
@@ -5815,9 +5813,7 @@ const XmlFormatParser = {
5815
5813
  * @private internal index of `...` <- TODO [🏢]
5816
5814
  */
5817
5815
  const FORMAT_DEFINITIONS = [JsonFormatParser, XmlFormatParser, TextFormatParser, CsvFormatParser];
5818
- /**
5819
- * Note: [💞] Ignore a discrepancy between file name and entity name
5820
- */
5816
+ // Note: [💞] Ignore a discrepancy between file name and entity name
5821
5817
 
5822
5818
  /**
5823
5819
  * Maps available parameters to expected parameters for a pipeline task.
@@ -5827,6 +5823,7 @@ const FORMAT_DEFINITIONS = [JsonFormatParser, XmlFormatParser, TextFormatParser,
5827
5823
  * 2) Then, if there are unmatched expected and available parameters, map them by order.
5828
5824
  *
5829
5825
  * @throws {PipelineExecutionError} If the number of unmatched expected and available parameters does not match, or mapping is ambiguous.
5826
+ *
5830
5827
  * @private within the repository used in `createPipelineExecutor`
5831
5828
  */
5832
5829
  function mapAvailableToExpectedParameters(options) {
@@ -5889,12 +5886,13 @@ function mapAvailableToExpectedParameters(options) {
5889
5886
  * Replaces parameters in template with values from parameters object
5890
5887
  *
5891
5888
  * Note: This function is not places strings into string,
5892
- * It's more complex and can handle this operation specifically for LLM models
5889
+ * It's more complex and can handle this operation specifically for LLM models
5893
5890
  *
5894
5891
  * @param template the template with parameters in {curly} braces
5895
5892
  * @param parameters the object with parameters
5896
5893
  * @returns the template with replaced parameters
5897
5894
  * @throws {PipelineExecutionError} if parameter is not defined, not closed, or not opened
5895
+ *
5898
5896
  * @public exported from `@promptbook/utils`
5899
5897
  */
5900
5898
  function templateParameters(template, parameters) {
@@ -5968,6 +5966,7 @@ function templateParameters(template, parameters) {
5968
5966
  * @param markdown any valid markdown
5969
5967
  * @returns code blocks with language and content
5970
5968
  * @throws {ParseError} if block is not closed properly
5969
+ *
5971
5970
  * @public exported from `@promptbook/markdown-utils`
5972
5971
  */
5973
5972
  function extractAllBlocksFromMarkdown(markdown) {
@@ -6018,9 +6017,7 @@ function extractAllBlocksFromMarkdown(markdown) {
6018
6017
  }
6019
6018
  return codeBlocks;
6020
6019
  }
6021
- /**
6022
- * TODO: Maybe name for `blockNotation` instead of '```' and '>'
6023
- */
6020
+ // TODO: Maybe name for `blockNotation` instead of '```' and '>'
6024
6021
 
6025
6022
  /**
6026
6023
  * Extracts extracts exactly one valid JSON code block
@@ -6036,8 +6033,9 @@ function extractAllBlocksFromMarkdown(markdown) {
6036
6033
  * - `extractOneBlockFromMarkdown` extracts exactly one code block with language of the code block
6037
6034
  * - `extractAllBlocksFromMarkdown` extracts all code blocks with language of the code block
6038
6035
  *
6039
- * @public exported from `@promptbook/markdown-utils`
6040
6036
  * @throws {ParseError} if there is no valid JSON block in the markdown
6037
+ *
6038
+ * @public exported from `@promptbook/markdown-utils`
6041
6039
  */
6042
6040
  function extractJsonBlock(markdown) {
6043
6041
  if (isValidJsonString(markdown)) {
@@ -6053,10 +6051,8 @@ function extractJsonBlock(markdown) {
6053
6051
  }
6054
6052
  return jsonBlocks[0].content;
6055
6053
  }
6056
- /**
6057
- * TODO: Add some auto-healing logic + extract YAML, JSON5, TOML, etc.
6058
- * TODO: [🏢] Make this logic part of `JsonFormatParser` or `isValidJsonString`
6059
- */
6054
+ // TODO: Add some auto-healing logic + extract YAML, JSON5, TOML, etc.
6055
+ // TODO: [🏢] Make this logic part of `JsonFormatParser` or `isValidJsonString`
6060
6056
 
6061
6057
  /**
6062
6058
  * Counts number of characters in the text
@@ -6072,10 +6068,8 @@ function countCharacters(text) {
6072
6068
  text = text.replace(/\p{Extended_Pictographic}(\u{200D}\p{Extended_Pictographic})*/gu, '-');
6073
6069
  return text.length;
6074
6070
  }
6075
- /**
6076
- * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
6077
- * TODO: [🧠][✌️] Make some Promptbook-native token system
6078
- */
6071
+ // TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
6072
+ // TODO: [🧠][✌️] Make some Promptbook-native token system
6079
6073
 
6080
6074
  /**
6081
6075
  * Number of characters per standard line with 11pt Arial font size.
@@ -6089,10 +6083,8 @@ const CHARACTERS_PER_STANDARD_LINE = 63;
6089
6083
  * @public exported from `@promptbook/utils`
6090
6084
  */
6091
6085
  const LINES_PER_STANDARD_PAGE = 44;
6092
- /**
6093
- * TODO: [🧠] Should be this `constants.ts` or `config.ts`?
6094
- * Note: [💞] Ignore a discrepancy between file name and entity name
6095
- */
6086
+ // TODO: [🧠] Should be this `constants.ts` or `config.ts`?
6087
+ // Note: [💞] Ignore a discrepancy between file name and entity name
6096
6088
 
6097
6089
  /**
6098
6090
  * Counts number of lines in the text
@@ -6110,10 +6102,8 @@ function countLines(text) {
6110
6102
  const lines = text.split(/\r?\n/);
6111
6103
  return lines.reduce((count, line) => count + Math.max(Math.ceil(line.length / CHARACTERS_PER_STANDARD_LINE), 1), 0);
6112
6104
  }
6113
- /**
6114
- * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
6115
- * TODO: [🧠][✌️] Make some Promptbook-native token system
6116
- */
6105
+ // TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
6106
+ // TODO: [🧠][✌️] Make some Promptbook-native token system
6117
6107
 
6118
6108
  /**
6119
6109
  * Counts number of pages in the text
@@ -6125,10 +6115,8 @@ function countLines(text) {
6125
6115
  function countPages(text) {
6126
6116
  return Math.ceil(countLines(text) / LINES_PER_STANDARD_PAGE);
6127
6117
  }
6128
- /**
6129
- * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
6130
- * TODO: [🧠][✌️] Make some Promptbook-native token system
6131
- */
6118
+ // TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
6119
+ // TODO: [🧠][✌️] Make some Promptbook-native token system
6132
6120
 
6133
6121
  /**
6134
6122
  * Counts number of paragraphs in the text
@@ -6138,10 +6126,8 @@ function countPages(text) {
6138
6126
  function countParagraphs(text) {
6139
6127
  return text.split(/\n\s*\n/).filter((paragraph) => paragraph.trim() !== '').length;
6140
6128
  }
6141
- /**
6142
- * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
6143
- * TODO: [🧠][✌️] Make some Promptbook-native token system
6144
- */
6129
+ // TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
6130
+ // TODO: [🧠][✌️] Make some Promptbook-native token system
6145
6131
 
6146
6132
  /**
6147
6133
  * Split text into sentences
@@ -6159,10 +6145,8 @@ function splitIntoSentences(text) {
6159
6145
  function countSentences(text) {
6160
6146
  return splitIntoSentences(text).length;
6161
6147
  }
6162
- /**
6163
- * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
6164
- * TODO: [🧠][✌️] Make some Promptbook-native token system
6165
- */
6148
+ // TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
6149
+ // TODO: [🧠][✌️] Make some Promptbook-native token system
6166
6150
 
6167
6151
  /**
6168
6152
  * Counts number of words in the text
@@ -6176,11 +6160,9 @@ function countWords(text) {
6176
6160
  text = text.replace(/([a-z])([A-Z])/g, '$1 $2');
6177
6161
  return text.split(/[^a-zа-я0-9]+/i).filter((word) => word.length > 0).length;
6178
6162
  }
6179
- /**
6180
- * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
6181
- * TODO: [🧠][✌️] Make some Promptbook-native token system
6182
- * TODO: [✌️] `countWords` should be just `splitWords(...).length`, and all other counters should use this pattern as well
6183
- */
6163
+ // TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
6164
+ // TODO: [🧠][✌️] Make some Promptbook-native token system
6165
+ // TODO: [✌️] `countWords` should be just `splitWords(...).length`, and all other counters should use this pattern as well
6184
6166
 
6185
6167
  /**
6186
6168
  * Index of all counter functions
@@ -6195,10 +6177,8 @@ const CountUtils = {
6195
6177
  LINES: countLines,
6196
6178
  PAGES: countPages,
6197
6179
  };
6198
- /**
6199
- * TODO: [🧠][🤠] This should be probably as part of `TextFormatParser`
6200
- * Note: [💞] Ignore a discrepancy between file name and entity name
6201
- */
6180
+ // TODO: [🧠][🤠] This should be probably as part of `TextFormatParser`
6181
+ // Note: [💞] Ignore a discrepancy between file name and entity name
6202
6182
 
6203
6183
  /**
6204
6184
  * Function checkExpectations will check if the expectations on given value are met
@@ -6209,6 +6189,7 @@ const CountUtils = {
6209
6189
  *
6210
6190
  * @throws {ExpectError} if the expectations are not met
6211
6191
  * @returns {void} Nothing
6192
+ *
6212
6193
  * @private internal function of `createPipelineExecutor`
6213
6194
  */
6214
6195
  function checkExpectations(expectations, value) {
@@ -6222,11 +6203,9 @@ function checkExpectations(expectations, value) {
6222
6203
  }
6223
6204
  }
6224
6205
  }
6225
- /**
6226
- * TODO: [💝] Unite object for expecting amount and format
6227
- * TODO: [🧠][🤠] This should be part of `TextFormatParser`
6228
- * Note: [💝] and [🤠] are interconnected together
6229
- */
6206
+ // TODO: [💝] Unite object for expecting amount and format
6207
+ // TODO: [🧠][🤠] This should be part of `TextFormatParser`
6208
+ // Note: [💝] and [🤠] are interconnected together
6230
6209
 
6231
6210
  /**
6232
6211
  * Validates a prompt result against expectations and format requirements.
@@ -6237,6 +6216,7 @@ function checkExpectations(expectations, value) {
6237
6216
  *
6238
6217
  * @param options - The validation options including result string, expectations, and format
6239
6218
  * @returns Validation result with processed string and validity status
6219
+ *
6240
6220
  * @private internal function of `createPipelineExecutor` and `cacheLlmTools`
6241
6221
  */
6242
6222
  function validatePromptResult(options) {
@@ -6299,6 +6279,7 @@ function validatePromptResult(options) {
6299
6279
  *
6300
6280
  * @param options - The options for execution, including task, parameters, pipeline, and configuration.
6301
6281
  * @returns The result string of the executed task.
6282
+ *
6302
6283
  * @private internal utility of `createPipelineExecutor`
6303
6284
  */
6304
6285
  async function executeAttempts(options) {
@@ -6622,9 +6603,7 @@ async function executeAttempts(options) {
6622
6603
  }
6623
6604
  return $ongoingTaskResult.$resultString;
6624
6605
  }
6625
- /**
6626
- * TODO: Break into smaller functions
6627
- */
6606
+ // TODO: Break into smaller functions
6628
6607
 
6629
6608
  /**
6630
6609
  * Executes a pipeline task that requires mapping or iterating over subvalues of a parameter (such as rows in a CSV).
@@ -6767,6 +6746,7 @@ async function executeFormatSubvalues(options) {
6767
6746
  *
6768
6747
  * @param task - The task for which the context is being generated. This should be a deeply immutable TaskJson object.
6769
6748
  * @returns The context as a string, formatted as markdown and parameter value.
6749
+ *
6770
6750
  * @private internal utility of `createPipelineExecutor`
6771
6751
  */
6772
6752
  async function getContextForTask(task) {
@@ -6804,7 +6784,6 @@ function computeCosineSimilarity(embeddingVector1, embeddingVector2) {
6804
6784
  }
6805
6785
 
6806
6786
  /**
6807
- *
6808
6787
  * @param knowledgePieces
6809
6788
  * @returns
6810
6789
  *
@@ -6885,10 +6864,8 @@ async function getKnowledgeForTask(options) {
6885
6864
  return knowledgePiecesToString(preparedPipeline.knowledgePieces);
6886
6865
  }
6887
6866
  }
6888
- /**
6889
- * TODO: [♨] Implement Better - use keyword search
6890
- * TODO: [♨] Examples of values
6891
- */
6867
+ // TODO: [♨] Implement Better - use keyword search
6868
+ // TODO: [♨] Examples of values
6892
6869
 
6893
6870
  /**
6894
6871
  * Retrieves all reserved parameters for a given pipeline task, including context, knowledge, examples, and metadata.
@@ -7041,9 +7018,7 @@ async function executeTask(options) {
7041
7018
  resultString,
7042
7019
  });
7043
7020
  }
7044
- /**
7045
- * TODO: [🤹‍♂️]
7046
- */
7021
+ // TODO: [🤹‍♂️]
7047
7022
 
7048
7023
  /**
7049
7024
  * Filters and returns only the output parameters from the provided pipeline execution options.
@@ -7373,6 +7348,7 @@ async function executePipeline(options) {
7373
7348
  *
7374
7349
  * @returns The executor function
7375
7350
  * @throws {PipelineLogicError} on logical error in the pipeline
7351
+ *
7376
7352
  * @public exported from `@promptbook/core`
7377
7353
  */
7378
7354
  function createPipelineExecutor(options) {
@@ -7547,14 +7523,13 @@ const markdownScraperMetadata = $deepFreeze({
7547
7523
  * @public exported from `@promptbook/cli`
7548
7524
  */
7549
7525
  $scrapersMetadataRegister.register(markdownScraperMetadata);
7550
- /**
7551
- * Note: [💞] Ignore a discrepancy between file name and entity name
7552
- */
7526
+ // Note: [💞] Ignore a discrepancy between file name and entity name
7553
7527
 
7554
7528
  /**
7555
7529
  * Scraper for markdown files
7556
7530
  *
7557
7531
  * @see `documentationUrl` for more details
7532
+ *
7558
7533
  * @public exported from `@promptbook/markdown-utils`
7559
7534
  */
7560
7535
  class MarkdownScraper {
@@ -7687,10 +7662,8 @@ class MarkdownScraper {
7687
7662
  return knowledge;
7688
7663
  }
7689
7664
  }
7690
- /**
7691
- * TODO: [🪂] Do it in parallel 11:11
7692
- * Note: No need to aggregate usage here, it is done by intercepting the llmTools
7693
- */
7665
+ // TODO: [🪂] Do it in parallel 11:11
7666
+ // Note: No need to aggregate usage here, it is done by intercepting the llmTools
7694
7667
 
7695
7668
  /**
7696
7669
  * Metadata of the scraper
@@ -7717,15 +7690,14 @@ const documentScraperMetadata = $deepFreeze({
7717
7690
  * @public exported from `@promptbook/cli`
7718
7691
  */
7719
7692
  $scrapersMetadataRegister.register(documentScraperMetadata);
7720
- /**
7721
- * Note: [💞] Ignore a discrepancy between file name and entity name
7722
- */
7693
+ // Note: [💞] Ignore a discrepancy between file name and entity name
7723
7694
 
7724
7695
  // TODO: [🏳‍🌈] Finally take pick of .json vs .ts
7725
7696
  /**
7726
7697
  * Scraper of .docx and .odt files
7727
7698
  *
7728
7699
  * @see `documentationUrl` for more details
7700
+ *
7729
7701
  * @public exported from `@promptbook/documents`
7730
7702
  */
7731
7703
  class DocumentScraper {
@@ -7821,12 +7793,10 @@ class DocumentScraper {
7821
7793
  return knowledge;
7822
7794
  }
7823
7795
  }
7824
- /** Note: [🟢] Code for Node scraper implementation [DocumentScraper](src/scrapers/document/DocumentScraper.ts) should never be published into packages that could be imported into browser environment */
7825
- /**
7826
- * TODO: [👣] Converted documents can act as cached items - there is no need to run conversion each time
7827
- * TODO: [🪂] Do it in parallel 11:11
7828
- * Note: No need to aggregate usage here, it is done by intercepting the llmTools
7829
- */
7796
+ // Note: [🟢] Code for Node scraper implementation [DocumentScraper](src/scrapers/document/DocumentScraper.ts) should never be published into packages that could be imported into browser environment
7797
+ // TODO: [👣] Converted documents can act as cached items - there is no need to run conversion each time
7798
+ // TODO: [🪂] Do it in parallel 11:11
7799
+ // Note: No need to aggregate usage here, it is done by intercepting the llmTools
7830
7800
 
7831
7801
  /**
7832
7802
  * Creates a scraper for document content.
@@ -7836,9 +7806,7 @@ class DocumentScraper {
7836
7806
  const createDocumentScraper = Object.assign((tools, options) => {
7837
7807
  return new DocumentScraper(tools, options);
7838
7808
  }, documentScraperMetadata); /* <- Note: [🤛] */
7839
- /**
7840
- * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
7841
- */
7809
+ // TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
7842
7810
 
7843
7811
  /**
7844
7812
  * Registration of known scraper
@@ -7850,10 +7818,8 @@ const createDocumentScraper = Object.assign((tools, options) => {
7850
7818
  * @public exported from `@promptbook/cli`
7851
7819
  */
7852
7820
  const _DocumentScraperRegistration = $scrapersRegister.register(createDocumentScraper);
7853
- /**
7854
- * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
7855
- * Note: [💞] Ignore a discrepancy between file name and entity name
7856
- */
7821
+ // TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
7822
+ // Note: [💞] Ignore a discrepancy between file name and entity name
7857
7823
 
7858
7824
  export { BOOK_LANGUAGE_VERSION, DocumentScraper, PROMPTBOOK_ENGINE_VERSION, _DocumentScraperRegistration, createDocumentScraper };
7859
7825
  //# sourceMappingURL=index.es.js.map