@promptbook/documents 0.112.0-66 → 0.112.0-70

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 (732) hide show
  1. package/README.md +3 -3
  2. package/esm/index.es.js +589 -581
  3. package/esm/index.es.js.map +1 -1
  4. package/esm/src/_packages/core.index.d.ts +2 -0
  5. package/esm/src/avatars/AvatarOrImage.d.ts +2 -1
  6. package/esm/src/avatars/avatarRenderingUtils.d.ts +1 -1
  7. package/esm/src/avatars/renderAvatarVisual.d.ts +1 -2
  8. package/esm/src/avatars/types/AvatarDefinition.d.ts +2 -1
  9. package/esm/src/avatars/types/AvatarVisualDefinition.d.ts +3 -2
  10. package/esm/src/avatars/visuals/avatar3dProjectionShared.d.ts +141 -0
  11. package/esm/src/avatars/visuals/octopus3dAvatarVisual.d.ts +7 -0
  12. package/esm/src/book-2.0/agent-source/AgentBasicInformation.d.ts +5 -1
  13. package/esm/src/book-2.0/agent-source/AgentModelRequirements.d.ts +3 -2
  14. package/esm/src/book-2.0/agent-source/AgentSourceParseResult.d.ts +1 -1
  15. package/esm/src/book-2.0/agent-source/computeAgentHash.d.ts +2 -2
  16. package/esm/src/book-2.0/agent-source/createAgentModelRequirements.d.ts +4 -1
  17. package/esm/src/book-2.0/agent-source/createAgentModelRequirementsWithCommitments.d.ts +1 -1
  18. package/esm/src/book-2.0/agent-source/createDefaultAgentName.d.ts +2 -2
  19. package/esm/src/book-2.0/agent-source/normalizeAgentName.d.ts +1 -1
  20. package/esm/src/book-2.0/agent-source/parseAgentSourcePrelude.d.ts +1 -1
  21. package/esm/src/book-2.0/agent-source/parseTeamCommitment.d.ts +1 -1
  22. package/esm/src/book-2.0/book-language-documentation/createStandaloneBookLanguageMarkdown.d.ts +1 -1
  23. package/esm/src/book-2.0/utils/generatePlaceholderAgentProfileImageUrl.d.ts +3 -1
  24. package/esm/src/book-3.0/Book.d.ts +33 -0
  25. package/esm/src/book-components/AvatarProfile/AvatarChip/AvatarChip.d.ts +1 -1
  26. package/esm/src/book-components/AvatarProfile/AvatarProfile/AvatarProfile.d.ts +1 -1
  27. package/esm/src/book-components/BookEditor/BookEditor.d.ts +4 -1
  28. package/esm/src/book-components/BookEditor/BookEditorActionbar.d.ts +1 -1
  29. package/esm/src/book-components/Chat/AgentChip/AgentChip.d.ts +1 -1
  30. package/esm/src/book-components/Chat/Chat/ChatMessageItem.d.ts +2 -2
  31. package/esm/src/book-components/Chat/Chat/ChatMessageList.d.ts +1 -1
  32. package/esm/src/book-components/Chat/Chat/ChatMessageRichContent.d.ts +1 -1
  33. package/esm/src/book-components/Chat/Chat/ChatProps.d.ts +4 -4
  34. package/esm/src/book-components/Chat/Chat/ChatRatingModal.d.ts +1 -1
  35. package/esm/src/book-components/Chat/Chat/ChatToolCallModalContent.d.ts +2 -2
  36. package/esm/src/book-components/Chat/Chat/TeamToolCallModalContent.d.ts +2 -2
  37. package/esm/src/book-components/Chat/Chat/createChatMessageToolCallRenderModel.d.ts +2 -2
  38. package/esm/src/book-components/Chat/Chat/renderToolCallDetails.d.ts +1 -1
  39. package/esm/src/book-components/Chat/Chat/resolveRunBrowserToolCallDetailsState.d.ts +1 -1
  40. package/esm/src/book-components/Chat/Chat/useChatInputAreaDictation.d.ts +1 -1
  41. package/esm/src/book-components/Chat/Chat/useChatInputAreaDictationPersistence.d.ts +1 -1
  42. package/esm/src/book-components/Chat/Chat/useChatInputAreaDictationSupport.d.ts +1 -1
  43. package/esm/src/book-components/Chat/Chat/useChatToolCallModalState.d.ts +3 -3
  44. package/esm/src/book-components/Chat/LlmChat/LlmChatProps.d.ts +2 -2
  45. package/esm/src/book-components/Chat/LlmChat/useLlmChatMessageHandler.d.ts +1 -1
  46. package/esm/src/book-components/Chat/MarkdownContent/MarkdownContent.d.ts +1 -1
  47. package/esm/src/book-components/Chat/hooks/useChatRatings.d.ts +2 -2
  48. package/esm/src/book-components/Chat/save/_common/ChatSaveFormatDefinition.d.ts +2 -1
  49. package/esm/src/book-components/Chat/types/ChatMessage.d.ts +6 -2
  50. package/esm/src/book-components/Chat/types/ChatParticipant.d.ts +5 -3
  51. package/esm/src/book-components/Chat/utils/citationHelpers.d.ts +1 -1
  52. package/esm/src/book-components/Chat/utils/collectTeamToolCallSummary.d.ts +1 -1
  53. package/esm/src/book-components/Chat/utils/createCitationFootnoteRenderModel.d.ts +1 -1
  54. package/esm/src/book-components/Chat/utils/getToolCallChipletInfo.d.ts +2 -2
  55. package/esm/src/book-components/Chat/utils/loadAgentProfile.d.ts +2 -1
  56. package/esm/src/book-components/Chat/utils/resolveCitationUrl.d.ts +1 -1
  57. package/esm/src/book-components/PromptbookAgent/PromptbookAgentIntegration.d.ts +1 -1
  58. package/esm/src/book-components/PromptbookAgent/PromptbookAgentSeamlessIntegration.d.ts +1 -1
  59. package/esm/src/book-components/Qr/useQrCode.d.ts +1 -1
  60. package/esm/src/book-components/_common/react-utils/classNames.d.ts +1 -1
  61. package/esm/src/cli/cli-commands/agent/agentProjectPaths.d.ts +2 -2
  62. package/esm/src/cli/cli-commands/agent/initializeAgentRunnerCommand.d.ts +22 -0
  63. package/esm/src/cli/cli-commands/agent/runMultiple.d.ts +10 -0
  64. package/esm/src/cli/cli-commands/agent.d.ts +3 -2
  65. package/esm/src/cli/cli-commands/coder/ensureCoderGitignoreFile.d.ts +1 -1
  66. package/esm/src/cli/cli-commands/coder/initializeCoderProjectConfiguration.d.ts +1 -1
  67. package/esm/src/cli/cli-commands/common/promptRunnerCliOptions.d.ts +1 -1
  68. package/esm/src/cli/common/$provideLlmToolsForCli.d.ts +1 -1
  69. package/esm/src/collection/agent-collection/constructors/agent-collection-in-supabase/AgentCollectionInSupabase.d.ts +3 -3
  70. package/esm/src/collection/agent-collection/constructors/agent-collection-in-supabase/prepareAgentSourceForPersistence.d.ts +1 -1
  71. package/esm/src/collection/pipeline-collection/PipelineCollection.d.ts +1 -1
  72. package/esm/src/collection/pipeline-collection/SimplePipelineCollection.d.ts +1 -1
  73. package/esm/src/collection/pipeline-collection/constructors/createPipelineCollectionFromDirectory.d.ts +2 -1
  74. package/esm/src/collection/pipeline-collection/constructors/createPipelineCollectionFromUrl.d.ts +1 -1
  75. package/esm/src/collection/pipeline-collection/constructors/createPipelineSubcollection.d.ts +1 -1
  76. package/esm/src/commands/BOOK_VERSION/BookVersionCommand.d.ts +1 -1
  77. package/esm/src/commands/FOREACH/ForeachJson.d.ts +1 -1
  78. package/esm/src/commands/JOKER/JokerCommand.d.ts +1 -1
  79. package/esm/src/commands/KNOWLEDGE/KnowledgeCommand.d.ts +1 -1
  80. package/esm/src/commands/KNOWLEDGE/utils/knowledgeSourceContentToName.d.ts +2 -2
  81. package/esm/src/commands/PARAMETER/ParameterCommand.d.ts +2 -2
  82. package/esm/src/commands/PERSONA/PersonaCommand.d.ts +2 -2
  83. package/esm/src/commands/POSTPROCESS/PostprocessCommand.d.ts +1 -1
  84. package/esm/src/commands/_common/parseCommand.d.ts +1 -1
  85. package/esm/src/commands/_common/stringifyCommand.d.ts +1 -1
  86. package/esm/src/commands/_common/types/CommandParser.d.ts +2 -1
  87. package/esm/src/commitments/MEMORY/MEMORY.d.ts +2 -2
  88. package/esm/src/commitments/MEMORY/MemoryToolRuntimeAdapter.d.ts +1 -1
  89. package/esm/src/commitments/MEMORY/createMemoryToolFunctions.d.ts +1 -1
  90. package/esm/src/commitments/MEMORY/getMemoryToolTitles.d.ts +1 -1
  91. package/esm/src/commitments/MEMORY/resolveMemoryRuntimeContext.d.ts +1 -1
  92. package/esm/src/commitments/TEAM/TEAM.d.ts +2 -2
  93. package/esm/src/commitments/USE_BROWSER/USE_BROWSER.d.ts +2 -2
  94. package/esm/src/commitments/USE_BROWSER/resolveRunBrowserToolForNode.d.ts +1 -1
  95. package/esm/src/commitments/USE_CALENDAR/USE_CALENDAR.d.ts +1 -1
  96. package/esm/src/commitments/USE_CALENDAR/createUseCalendarToolFunctions.d.ts +1 -1
  97. package/esm/src/commitments/USE_CALENDAR/getUseCalendarToolTitles.d.ts +1 -1
  98. package/esm/src/commitments/USE_CALENDAR/resolveUseCalendarToolRuntimeOrWalletCredentialResult.d.ts +1 -1
  99. package/esm/src/commitments/USE_DEEPSEARCH/USE_DEEPSEARCH.d.ts +2 -2
  100. package/esm/src/commitments/USE_EMAIL/USE_EMAIL.d.ts +2 -2
  101. package/esm/src/commitments/USE_EMAIL/resolveSendEmailToolForNode.d.ts +1 -1
  102. package/esm/src/commitments/USE_POPUP/USE_POPUP.d.ts +2 -2
  103. package/esm/src/commitments/USE_PRIVACY/USE_PRIVACY.d.ts +2 -2
  104. package/esm/src/commitments/USE_PROJECT/USE_PROJECT.d.ts +1 -1
  105. package/esm/src/commitments/USE_PROJECT/createUseProjectToolFunctions.d.ts +1 -1
  106. package/esm/src/commitments/USE_PROJECT/getUseProjectToolTitles.d.ts +1 -1
  107. package/esm/src/commitments/USE_PROJECT/resolveUseProjectToolRuntimeOrWalletCredentialResult.d.ts +1 -1
  108. package/esm/src/commitments/USE_SEARCH_ENGINE/USE_SEARCH_ENGINE.d.ts +2 -2
  109. package/esm/src/commitments/USE_SPAWN/USE_SPAWN.d.ts +2 -2
  110. package/esm/src/commitments/USE_SPAWN/resolveSpawnAgentToolForNode.d.ts +1 -1
  111. package/esm/src/commitments/USE_TIME/USE_TIME.d.ts +2 -2
  112. package/esm/src/commitments/USE_TIMEOUT/TimeoutToolRuntimeAdapter.d.ts +1 -1
  113. package/esm/src/commitments/USE_TIMEOUT/USE_TIMEOUT.d.ts +2 -2
  114. package/esm/src/commitments/USE_TIMEOUT/createTimeoutToolFunctions.d.ts +1 -1
  115. package/esm/src/commitments/USE_TIMEOUT/resolveTimeoutRuntimeContext.d.ts +1 -1
  116. package/esm/src/commitments/USE_USER_LOCATION/USE_USER_LOCATION.d.ts +2 -2
  117. package/esm/src/commitments/WALLET/WALLET.d.ts +1 -1
  118. package/esm/src/commitments/WALLET/WalletToolRuntimeAdapter.d.ts +1 -1
  119. package/esm/src/commitments/WALLET/createWalletToolFunctions.d.ts +1 -1
  120. package/esm/src/commitments/WALLET/getWalletToolTitles.d.ts +1 -1
  121. package/esm/src/commitments/WALLET/resolveWalletRuntimeContext.d.ts +1 -1
  122. package/esm/src/commitments/_base/BaseCommitmentDefinition.d.ts +2 -2
  123. package/esm/src/commitments/_base/CommitmentDefinition.d.ts +2 -2
  124. package/esm/src/commitments/_common/commitmentToolFunctions.d.ts +2 -2
  125. package/esm/src/commitments/_common/createSerpSearchToolFunction.d.ts +1 -1
  126. package/esm/src/commitments/_common/getAllCommitmentsToolFunctionsForNode.d.ts +1 -1
  127. package/esm/src/commitments/_common/getAllCommitmentsToolTitles.d.ts +1 -1
  128. package/esm/src/commitments/_common/getGroupedCommitmentDefinitions.d.ts +1 -1
  129. package/esm/src/commitments/_common/toolExecutionEnvelope.d.ts +1 -1
  130. package/esm/src/commitments/_common/toolRuntimeContext.d.ts +1 -1
  131. package/esm/src/config.d.ts +5 -1
  132. package/esm/src/conversion/archive/loadArchive.d.ts +1 -1
  133. package/esm/src/conversion/archive/saveArchive.d.ts +1 -1
  134. package/esm/src/conversion/prettify/renderPipelineMermaidOptions.d.ts +1 -1
  135. package/esm/src/conversion/utils/extractParameterNamesFromTask.d.ts +1 -1
  136. package/esm/src/errors/PipelineExecutionError.d.ts +1 -1
  137. package/esm/src/errors/utils/ErrorJson.d.ts +1 -1
  138. package/esm/src/executables/apps/locateLibreoffice.d.ts +1 -1
  139. package/esm/src/executables/apps/locatePandoc.d.ts +1 -1
  140. package/esm/src/executables/apps/locateVscode.d.ts +1 -1
  141. package/esm/src/executables/browsers/locateBrowser.d.ts +1 -1
  142. package/esm/src/executables/browsers/locateChrome.d.ts +1 -1
  143. package/esm/src/executables/browsers/locateDefaultSystemBrowser.d.ts +1 -1
  144. package/esm/src/executables/browsers/locateEdge.d.ts +1 -1
  145. package/esm/src/executables/browsers/locateFirefox.d.ts +1 -1
  146. package/esm/src/executables/browsers/locateInternetExplorer.d.ts +1 -1
  147. package/esm/src/executables/browsers/locateSafari.d.ts +1 -1
  148. package/esm/src/executables/locateApp.d.ts +1 -1
  149. package/esm/src/executables/platforms/locateAppOnLinux.d.ts +1 -1
  150. package/esm/src/executables/platforms/locateAppOnMacOs.d.ts +1 -1
  151. package/esm/src/executables/platforms/locateAppOnWindows.d.ts +1 -1
  152. package/esm/src/execution/AbstractTaskResult.d.ts +1 -1
  153. package/esm/src/execution/AvailableModel.d.ts +5 -1
  154. package/esm/src/execution/CommonToolsOptions.d.ts +1 -1
  155. package/esm/src/execution/Executables.d.ts +1 -1
  156. package/esm/src/execution/ExecutionTask.d.ts +3 -2
  157. package/esm/src/execution/LlmExecutionTools.d.ts +2 -1
  158. package/esm/src/execution/PipelineExecutor.d.ts +1 -1
  159. package/esm/src/execution/PipelineExecutorResult.d.ts +2 -2
  160. package/esm/src/execution/PromptResult.d.ts +3 -1
  161. package/esm/src/execution/PromptbookFetch.d.ts +1 -1
  162. package/esm/src/execution/ScriptExecutionTools.d.ts +2 -2
  163. package/esm/src/execution/UncertainNumber.d.ts +2 -2
  164. package/esm/src/execution/UserInterfaceTools.d.ts +1 -2
  165. package/esm/src/execution/createPipelineExecutor/10-executePipeline.d.ts +1 -1
  166. package/esm/src/execution/createPipelineExecutor/20-executeTask.d.ts +1 -1
  167. package/esm/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +2 -1
  168. package/esm/src/execution/createPipelineExecutor/filterJustOutputParameters.d.ts +1 -1
  169. package/esm/src/execution/createPipelineExecutor/getContextForTask.d.ts +2 -2
  170. package/esm/src/execution/createPipelineExecutor/getExamplesForTask.d.ts +2 -2
  171. package/esm/src/execution/createPipelineExecutor/getKnowledgeForTask.d.ts +3 -1
  172. package/esm/src/execution/createPipelineExecutor/getReservedParametersForTask.d.ts +1 -2
  173. package/esm/src/execution/execution-report/ExecutionReportJson.d.ts +3 -3
  174. package/esm/src/execution/execution-report/ExecutionReportStringOptions.d.ts +1 -1
  175. package/esm/src/execution/utils/usageToHuman.d.ts +1 -1
  176. package/esm/src/execution/utils/validatePromptResult.d.ts +1 -1
  177. package/esm/src/file-security-checkers/FileSecurityCheckResult.d.ts +2 -1
  178. package/esm/src/file-security-checkers/FileSecurityChecker.d.ts +3 -1
  179. package/esm/src/file-security-checkers/virustotal/VirusTotalFileSecurityChecker.d.ts +1 -1
  180. package/esm/src/formats/_common/FormatParser.d.ts +2 -2
  181. package/esm/src/formats/_common/FormatSubvalueParser.d.ts +2 -3
  182. package/esm/src/formats/csv/utils/csvParse.d.ts +1 -1
  183. package/esm/src/formfactors/_common/AbstractFormfactorDefinition.d.ts +2 -3
  184. package/esm/src/import-plugins/FileImportPlugin.d.ts +1 -1
  185. package/esm/src/llm-providers/_common/register/$provideEnvFilename.d.ts +1 -1
  186. package/esm/src/llm-providers/_common/register/$provideLlmToolsForWizardOrCli.d.ts +3 -2
  187. package/esm/src/llm-providers/_common/register/$registeredLlmToolsMessage.d.ts +2 -1
  188. package/esm/src/llm-providers/_common/register/LlmToolsConfiguration.d.ts +1 -1
  189. package/esm/src/llm-providers/_common/register/LlmToolsMetadata.d.ts +2 -1
  190. package/esm/src/llm-providers/_common/register/createLlmToolsFromConfiguration.d.ts +3 -1
  191. package/esm/src/llm-providers/_common/utils/assertUniqueModels.d.ts +1 -1
  192. package/esm/src/llm-providers/_common/utils/cache/CacheItem.d.ts +2 -2
  193. package/esm/src/llm-providers/_multiple/MultipleLlmExecutionTools.d.ts +2 -1
  194. package/esm/src/llm-providers/_multiple/joinLlmExecutionTools.d.ts +2 -1
  195. package/esm/src/llm-providers/agent/Agent.d.ts +6 -2
  196. package/esm/src/llm-providers/agent/AgentLlmExecutionTools.d.ts +3 -1
  197. package/esm/src/llm-providers/agent/RemoteAgent.d.ts +2 -2
  198. package/esm/src/llm-providers/agent/RemoteAgentOptions.d.ts +1 -1
  199. package/esm/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +2 -1
  200. package/esm/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +1 -1
  201. package/esm/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +2 -1
  202. package/esm/src/llm-providers/azure-openai/AzureOpenAiExecutionToolsOptions.d.ts +2 -3
  203. package/esm/src/llm-providers/deepseek/deepseek-models.d.ts +1 -1
  204. package/esm/src/llm-providers/google/google-models.d.ts +1 -1
  205. package/esm/src/llm-providers/mocked/$fakeTextToExpectations.d.ts +1 -1
  206. package/esm/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts +2 -1
  207. package/esm/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts +2 -1
  208. package/esm/src/llm-providers/ollama/OllamaExecutionTools.d.ts +2 -1
  209. package/esm/src/llm-providers/openai/OpenAiAgentKitExecutionTools.d.ts +3 -2
  210. package/esm/src/llm-providers/openai/OpenAiAgentKitExecutionToolsOptions.d.ts +1 -1
  211. package/esm/src/llm-providers/openai/OpenAiAssistantExecutionTools.d.ts +3 -1
  212. package/esm/src/llm-providers/openai/OpenAiAssistantExecutionToolsOptions.d.ts +1 -1
  213. package/esm/src/llm-providers/openai/OpenAiCompatibleExecutionTools.d.ts +3 -1
  214. package/esm/src/llm-providers/openai/OpenAiExecutionTools.d.ts +2 -1
  215. package/esm/src/llm-providers/openai/OpenAiVectorStoreHandler.d.ts +2 -2
  216. package/esm/src/llm-providers/openai/createOpenAiCompatibleExecutionTools.d.ts +3 -1
  217. package/esm/src/llm-providers/openai/utils/OpenAiCompatibleUnsupportedParameterRetrier.d.ts +1 -1
  218. package/esm/src/llm-providers/openai/utils/callOpenAiCompatibleChatModel.d.ts +2 -1
  219. package/esm/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts +2 -1
  220. package/esm/src/other/templates/getBookTemplates.d.ts +1 -1
  221. package/esm/src/personas/preparePersona.d.ts +1 -1
  222. package/esm/src/pipeline/PipelineJson/CommonTaskJson.d.ts +4 -8
  223. package/esm/src/pipeline/PipelineJson/Expectations.d.ts +1 -2
  224. package/esm/src/pipeline/PipelineJson/KnowledgePieceJson.d.ts +4 -6
  225. package/esm/src/pipeline/PipelineJson/KnowledgeSourceJson.d.ts +3 -3
  226. package/esm/src/pipeline/PipelineJson/ParameterJson.d.ts +2 -3
  227. package/esm/src/pipeline/PipelineJson/PersonaJson.d.ts +3 -3
  228. package/esm/src/pipeline/PipelineJson/PipelineJson.d.ts +6 -9
  229. package/esm/src/pipeline/PipelineJson/PreparationJson.d.ts +1 -1
  230. package/esm/src/pipeline/PipelineJson/PromptTaskJson.d.ts +1 -1
  231. package/esm/src/pipeline/prompt-notation.d.ts +1 -1
  232. package/esm/src/postprocessing/utils/extractBlock.d.ts +1 -1
  233. package/esm/src/postprocessing/utils/extractJsonBlock.d.ts +1 -2
  234. package/esm/src/prepare/PrepareAndScrapeOptions.d.ts +1 -1
  235. package/esm/src/remote-server/socket-types/_subtypes/Identification.d.ts +2 -2
  236. package/esm/src/remote-server/socket-types/_subtypes/identificationToPromptbookToken.d.ts +1 -1
  237. package/esm/src/remote-server/socket-types/_subtypes/promptbookTokenToIdentification.d.ts +1 -1
  238. package/esm/src/remote-server/startAgentServer.d.ts +1 -1
  239. package/esm/src/remote-server/types/RemoteClientOptions.d.ts +1 -1
  240. package/esm/src/remote-server/types/RemoteServerOptions.d.ts +2 -1
  241. package/esm/src/scrapers/_common/Scraper.d.ts +4 -4
  242. package/esm/src/scrapers/_common/ScraperIntermediateSource.d.ts +1 -1
  243. package/esm/src/scrapers/_common/register/$registeredScrapersMessage.d.ts +1 -1
  244. package/esm/src/scrapers/_common/register/ScraperAndConverterMetadata.d.ts +3 -1
  245. package/esm/src/scrapers/_common/utils/getScraperIntermediateSource.d.ts +1 -1
  246. package/esm/src/scrapers/website/WebsiteScraper.d.ts +2 -3
  247. package/esm/src/scripting/javascript/JavascriptExecutionToolsOptions.d.ts +2 -2
  248. package/esm/src/scripting/javascript/utils/extractVariablesFromJavascript.d.ts +2 -2
  249. package/esm/src/search-engines/SearchEngine.d.ts +2 -1
  250. package/esm/src/search-engines/SearchResult.d.ts +1 -1
  251. package/esm/src/search-engines/bing/BingSearchEngine.d.ts +2 -1
  252. package/esm/src/search-engines/dummy/DummySearchEngine.d.ts +2 -1
  253. package/esm/src/search-engines/google/GoogleSearchEngine.d.ts +2 -1
  254. package/esm/src/search-engines/serp/SerpSearchEngine.d.ts +2 -1
  255. package/esm/src/storage/file-cache-storage/FileCacheStorageOptions.d.ts +1 -1
  256. package/esm/src/storage/file-cache-storage/utils/nameToSubfolderPath.d.ts +1 -1
  257. package/esm/src/storage/local-storage/utils/IndexedDbStorageOptions.d.ts +1 -1
  258. package/esm/src/transpilers/_common/BookTranspiler.d.ts +4 -2
  259. package/esm/src/transpilers/_common/createTranspiledTeamRuntimeSection.d.ts +1 -1
  260. package/esm/src/transpilers/_common/formatUsedToolFunctions.d.ts +1 -1
  261. package/esm/src/transpilers/agent-os/AgentOsTranspiler.d.ts +1 -1
  262. package/esm/src/transpilers/anthropic-claude-managed/AnthropicClaudeManagedTranspiler.d.ts +1 -1
  263. package/esm/src/transpilers/anthropic-claude-sdk/AnthropicClaudeSdkTranspiler.d.ts +1 -1
  264. package/esm/src/transpilers/e2b/E2BTranspiler.d.ts +1 -1
  265. package/esm/src/transpilers/formatted-book-in-markdown/FormattedBookInMarkdownTranspiler.d.ts +1 -1
  266. package/esm/src/transpilers/openai-agents/OpenAiAgentsTranspiler.d.ts +1 -1
  267. package/esm/src/transpilers/openai-sdk/OpenAiSdkTranspiler.d.ts +1 -1
  268. package/esm/src/types/LlmCall.d.ts +1 -1
  269. package/esm/src/types/LlmToolDefinition.d.ts +2 -1
  270. package/esm/src/types/Message.d.ts +4 -3
  271. package/esm/src/types/ModelRequirements.d.ts +4 -2
  272. package/esm/src/types/Prompt.d.ts +7 -12
  273. package/esm/src/types/SpeechRecognition.d.ts +1 -1
  274. package/esm/src/types/ToolCall.d.ts +1 -1
  275. package/esm/src/types/string_email.d.ts +1 -1
  276. package/esm/src/types/string_host.d.ts +1 -1
  277. package/esm/src/types/string_person_fullname.d.ts +1 -1
  278. package/esm/src/types/string_token.d.ts +1 -1
  279. package/esm/src/utils/agents/resolveAgentAvatarImageUrl.d.ts +2 -1
  280. package/esm/src/utils/color/Color.d.ts +2 -1
  281. package/esm/src/utils/color/internal-utils/hslToRgb.d.ts +2 -3
  282. package/esm/src/utils/color/internal-utils/rgbToHsl.d.ts +2 -3
  283. package/esm/src/utils/color/operators/darken.d.ts +1 -1
  284. package/esm/src/utils/color/operators/grayscale.d.ts +1 -1
  285. package/esm/src/utils/color/operators/lighten.d.ts +1 -1
  286. package/esm/src/utils/color/operators/mixWithColor.d.ts +1 -1
  287. package/esm/src/utils/color/operators/saturate.d.ts +1 -1
  288. package/esm/src/utils/color/parsers/parseHexColor.d.ts +1 -1
  289. package/esm/src/utils/color/parsers/parseHslColor.d.ts +1 -1
  290. package/esm/src/utils/color/parsers/parseRgbColor.d.ts +1 -1
  291. package/esm/src/utils/color/utils/colorToDataUrl.d.ts +3 -1
  292. package/esm/src/utils/editable/edit-pipeline-string/addPipelineCommand.d.ts +1 -1
  293. package/esm/src/utils/editable/types/PipelineEditableSerialized.d.ts +1 -1
  294. package/esm/src/utils/editable/utils/renamePipelineParameter.d.ts +1 -1
  295. package/esm/src/utils/editable/utils/stringifyPipelineJson.d.ts +1 -1
  296. package/esm/src/utils/files/$induceFileDownload.d.ts +1 -1
  297. package/esm/src/utils/files/ObjectUrl.d.ts +2 -1
  298. package/esm/src/utils/files/extensionToMimeType.d.ts +2 -2
  299. package/esm/src/utils/files/getFileExtension.d.ts +2 -2
  300. package/esm/src/utils/files/isDirectoryExisting.d.ts +1 -1
  301. package/esm/src/utils/files/isFileExisting.d.ts +1 -1
  302. package/esm/src/utils/files/listAllFiles.d.ts +1 -1
  303. package/esm/src/utils/files/mimeTypeToExtension.d.ts +2 -2
  304. package/esm/src/utils/filesystem/promptbookTemporaryPath.d.ts +27 -0
  305. package/esm/src/utils/filesystem/promptbookTemporaryPath.test.d.ts +1 -0
  306. package/esm/src/utils/knowledge/inlineKnowledgeSource.d.ts +3 -1
  307. package/esm/src/utils/markdown/addAutoGeneratedSection.d.ts +2 -2
  308. package/esm/src/utils/markdown/createMarkdownChart.d.ts +1 -1
  309. package/esm/src/utils/markdown/createMarkdownTable.d.ts +1 -2
  310. package/esm/src/utils/markdown/escapeMarkdownBlock.d.ts +1 -1
  311. package/esm/src/utils/markdown/extractAllBlocksFromMarkdown.d.ts +1 -1
  312. package/esm/src/utils/markdown/extractAllListItemsFromMarkdown.d.ts +1 -1
  313. package/esm/src/utils/markdown/extractOneBlockFromMarkdown.d.ts +1 -1
  314. package/esm/src/utils/markdown/flattenMarkdown.d.ts +1 -1
  315. package/esm/src/utils/markdown/humanizeAiText.d.ts +1 -1
  316. package/esm/src/utils/markdown/humanizeAiTextEllipsis.d.ts +1 -1
  317. package/esm/src/utils/markdown/humanizeAiTextEmdashed.d.ts +1 -1
  318. package/esm/src/utils/markdown/humanizeAiTextQuotes.d.ts +1 -1
  319. package/esm/src/utils/markdown/humanizeAiTextSources.d.ts +1 -1
  320. package/esm/src/utils/markdown/humanizeAiTextWhitespace.d.ts +1 -1
  321. package/esm/src/utils/markdown/parseMarkdownSection.d.ts +1 -1
  322. package/esm/src/utils/markdown/prettifyMarkdown.d.ts +1 -1
  323. package/esm/src/utils/markdown/promptbookifyAiText.d.ts +1 -1
  324. package/esm/src/utils/markdown/removeMarkdownComments.d.ts +1 -2
  325. package/esm/src/utils/markdown/removeMarkdownFormatting.d.ts +1 -1
  326. package/esm/src/utils/markdown/splitMarkdownIntoSections.d.ts +1 -1
  327. package/esm/src/utils/misc/$Register.d.ts +1 -1
  328. package/esm/src/utils/misc/$getCurrentDate.d.ts +1 -1
  329. package/esm/src/utils/misc/aboutPromptbookInformation.d.ts +1 -1
  330. package/esm/src/utils/misc/computeHash.d.ts +2 -2
  331. package/esm/src/utils/misc/injectCssModuleIntoShadowRoot.d.ts +1 -1
  332. package/esm/src/utils/normalization/suffixUrl.d.ts +1 -1
  333. package/esm/src/utils/organization/keepImported.d.ts +1 -1
  334. package/esm/src/utils/parameters/extractParameterNames.d.ts +2 -2
  335. package/esm/src/utils/parameters/mapAvailableToExpectedParameters.d.ts +1 -1
  336. package/esm/src/utils/parameters/numberToString.d.ts +1 -1
  337. package/esm/src/utils/parameters/templateParameters.d.ts +2 -1
  338. package/esm/src/utils/parameters/valueToString.d.ts +1 -1
  339. package/esm/src/utils/random/$generateBookBoilerplate.d.ts +1 -1
  340. package/esm/src/utils/random/$randomAgentPersona.d.ts +1 -1
  341. package/esm/src/utils/random/$randomAgentRule.d.ts +1 -1
  342. package/esm/src/utils/random/$randomFullnameWithColor.d.ts +1 -1
  343. package/esm/src/utils/random/$randomSeed.d.ts +1 -1
  344. package/esm/src/utils/random/$randomToken.d.ts +1 -1
  345. package/esm/src/utils/random/NamePool.d.ts +1 -1
  346. package/esm/src/utils/serialization/checkSerializableAsJson.d.ts +1 -1
  347. package/esm/src/utils/serialization/serializeToPromptbookJavascript.d.ts +1 -1
  348. package/esm/src/utils/toolCalls/mergeToolCalls.d.ts +1 -1
  349. package/esm/src/utils/validators/email/isValidEmail.d.ts +1 -1
  350. package/esm/src/utils/validators/filePath/isRootPath.d.ts +1 -2
  351. package/esm/src/utils/validators/filePath/isValidFilePath.d.ts +1 -1
  352. package/esm/src/utils/validators/javascriptName/isValidJavascriptName.d.ts +1 -1
  353. package/esm/src/utils/validators/parameterName/validateParameterName.d.ts +1 -1
  354. package/esm/src/utils/validators/semanticVersion/isValidSemanticVersion.d.ts +1 -1
  355. package/esm/src/utils/validators/url/isHostnameOnPrivateNetwork.d.ts +1 -1
  356. package/esm/src/utils/validators/url/isUrlOnPrivateNetwork.d.ts +2 -2
  357. package/esm/src/utils/validators/url/isValidAgentUrl.d.ts +1 -1
  358. package/esm/src/utils/validators/url/isValidPipelineUrl.d.ts +1 -1
  359. package/esm/src/utils/validators/url/isValidUrl.d.ts +1 -1
  360. package/esm/src/utils/validators/uuid/isValidUuid.d.ts +1 -1
  361. package/esm/src/version.d.ts +1 -1
  362. package/esm/src/wizard/$getCompiledBook.d.ts +2 -1
  363. package/esm/src/wizard/wizard.d.ts +4 -1
  364. package/package.json +2 -2
  365. package/umd/index.umd.js +590 -582
  366. package/umd/index.umd.js.map +1 -1
  367. package/umd/src/_packages/core.index.d.ts +2 -0
  368. package/umd/src/avatars/AvatarOrImage.d.ts +2 -1
  369. package/umd/src/avatars/avatarRenderingUtils.d.ts +1 -1
  370. package/umd/src/avatars/renderAvatarVisual.d.ts +1 -2
  371. package/umd/src/avatars/types/AvatarDefinition.d.ts +2 -1
  372. package/umd/src/avatars/types/AvatarVisualDefinition.d.ts +3 -2
  373. package/umd/src/avatars/visuals/avatar3dProjectionShared.d.ts +141 -0
  374. package/umd/src/avatars/visuals/octopus3dAvatarVisual.d.ts +7 -0
  375. package/umd/src/book-2.0/agent-source/AgentBasicInformation.d.ts +5 -1
  376. package/umd/src/book-2.0/agent-source/AgentModelRequirements.d.ts +3 -2
  377. package/umd/src/book-2.0/agent-source/AgentSourceParseResult.d.ts +1 -1
  378. package/umd/src/book-2.0/agent-source/computeAgentHash.d.ts +2 -2
  379. package/umd/src/book-2.0/agent-source/createAgentModelRequirements.d.ts +4 -1
  380. package/umd/src/book-2.0/agent-source/createAgentModelRequirementsWithCommitments.d.ts +1 -1
  381. package/umd/src/book-2.0/agent-source/createDefaultAgentName.d.ts +2 -2
  382. package/umd/src/book-2.0/agent-source/normalizeAgentName.d.ts +1 -1
  383. package/umd/src/book-2.0/agent-source/parseAgentSourcePrelude.d.ts +1 -1
  384. package/umd/src/book-2.0/agent-source/parseTeamCommitment.d.ts +1 -1
  385. package/umd/src/book-2.0/book-language-documentation/createStandaloneBookLanguageMarkdown.d.ts +1 -1
  386. package/umd/src/book-2.0/utils/generatePlaceholderAgentProfileImageUrl.d.ts +3 -1
  387. package/umd/src/book-3.0/Book.d.ts +33 -0
  388. package/umd/src/book-3.0/Book.test.d.ts +1 -0
  389. package/umd/src/book-components/AvatarProfile/AvatarChip/AvatarChip.d.ts +1 -1
  390. package/umd/src/book-components/AvatarProfile/AvatarProfile/AvatarProfile.d.ts +1 -1
  391. package/umd/src/book-components/BookEditor/BookEditor.d.ts +4 -1
  392. package/umd/src/book-components/BookEditor/BookEditorActionbar.d.ts +1 -1
  393. package/umd/src/book-components/Chat/AgentChip/AgentChip.d.ts +1 -1
  394. package/umd/src/book-components/Chat/Chat/ChatMessageItem.d.ts +2 -2
  395. package/umd/src/book-components/Chat/Chat/ChatMessageList.d.ts +1 -1
  396. package/umd/src/book-components/Chat/Chat/ChatMessageRichContent.d.ts +1 -1
  397. package/umd/src/book-components/Chat/Chat/ChatProps.d.ts +4 -4
  398. package/umd/src/book-components/Chat/Chat/ChatRatingModal.d.ts +1 -1
  399. package/umd/src/book-components/Chat/Chat/ChatToolCallModalContent.d.ts +2 -2
  400. package/umd/src/book-components/Chat/Chat/TeamToolCallModalContent.d.ts +2 -2
  401. package/umd/src/book-components/Chat/Chat/createChatMessageToolCallRenderModel.d.ts +2 -2
  402. package/umd/src/book-components/Chat/Chat/renderToolCallDetails.d.ts +1 -1
  403. package/umd/src/book-components/Chat/Chat/resolveRunBrowserToolCallDetailsState.d.ts +1 -1
  404. package/umd/src/book-components/Chat/Chat/useChatInputAreaDictation.d.ts +1 -1
  405. package/umd/src/book-components/Chat/Chat/useChatInputAreaDictationPersistence.d.ts +1 -1
  406. package/umd/src/book-components/Chat/Chat/useChatInputAreaDictationSupport.d.ts +1 -1
  407. package/umd/src/book-components/Chat/Chat/useChatToolCallModalState.d.ts +3 -3
  408. package/umd/src/book-components/Chat/LlmChat/LlmChatProps.d.ts +2 -2
  409. package/umd/src/book-components/Chat/LlmChat/useLlmChatMessageHandler.d.ts +1 -1
  410. package/umd/src/book-components/Chat/MarkdownContent/MarkdownContent.d.ts +1 -1
  411. package/umd/src/book-components/Chat/hooks/useChatRatings.d.ts +2 -2
  412. package/umd/src/book-components/Chat/save/_common/ChatSaveFormatDefinition.d.ts +2 -1
  413. package/umd/src/book-components/Chat/types/ChatMessage.d.ts +6 -2
  414. package/umd/src/book-components/Chat/types/ChatParticipant.d.ts +5 -3
  415. package/umd/src/book-components/Chat/utils/citationHelpers.d.ts +1 -1
  416. package/umd/src/book-components/Chat/utils/collectTeamToolCallSummary.d.ts +1 -1
  417. package/umd/src/book-components/Chat/utils/createCitationFootnoteRenderModel.d.ts +1 -1
  418. package/umd/src/book-components/Chat/utils/getToolCallChipletInfo.d.ts +2 -2
  419. package/umd/src/book-components/Chat/utils/loadAgentProfile.d.ts +2 -1
  420. package/umd/src/book-components/Chat/utils/resolveCitationUrl.d.ts +1 -1
  421. package/umd/src/book-components/PromptbookAgent/PromptbookAgentIntegration.d.ts +1 -1
  422. package/umd/src/book-components/PromptbookAgent/PromptbookAgentSeamlessIntegration.d.ts +1 -1
  423. package/umd/src/book-components/Qr/useQrCode.d.ts +1 -1
  424. package/umd/src/book-components/_common/react-utils/classNames.d.ts +1 -1
  425. package/umd/src/cli/cli-commands/agent/agentProjectPaths.d.ts +2 -2
  426. package/umd/src/cli/cli-commands/agent/initializeAgentRunnerCommand.d.ts +22 -0
  427. package/umd/src/cli/cli-commands/agent/runMultiple.d.ts +10 -0
  428. package/umd/src/cli/cli-commands/agent.d.ts +3 -2
  429. package/umd/src/cli/cli-commands/coder/ensureCoderGitignoreFile.d.ts +1 -1
  430. package/umd/src/cli/cli-commands/coder/initializeCoderProjectConfiguration.d.ts +1 -1
  431. package/umd/src/cli/cli-commands/common/promptRunnerCliOptions.d.ts +1 -1
  432. package/umd/src/cli/common/$provideLlmToolsForCli.d.ts +1 -1
  433. package/umd/src/cli/other/install.test.d.ts +1 -0
  434. package/umd/src/collection/agent-collection/constructors/agent-collection-in-supabase/AgentCollectionInSupabase.d.ts +3 -3
  435. package/umd/src/collection/agent-collection/constructors/agent-collection-in-supabase/prepareAgentSourceForPersistence.d.ts +1 -1
  436. package/umd/src/collection/pipeline-collection/PipelineCollection.d.ts +1 -1
  437. package/umd/src/collection/pipeline-collection/SimplePipelineCollection.d.ts +1 -1
  438. package/umd/src/collection/pipeline-collection/constructors/createPipelineCollectionFromDirectory.d.ts +2 -1
  439. package/umd/src/collection/pipeline-collection/constructors/createPipelineCollectionFromUrl.d.ts +1 -1
  440. package/umd/src/collection/pipeline-collection/constructors/createPipelineSubcollection.d.ts +1 -1
  441. package/umd/src/commands/BOOK_VERSION/BookVersionCommand.d.ts +1 -1
  442. package/umd/src/commands/FOREACH/ForeachJson.d.ts +1 -1
  443. package/umd/src/commands/JOKER/JokerCommand.d.ts +1 -1
  444. package/umd/src/commands/KNOWLEDGE/KnowledgeCommand.d.ts +1 -1
  445. package/umd/src/commands/KNOWLEDGE/utils/knowledgeSourceContentToName.d.ts +2 -2
  446. package/umd/src/commands/PARAMETER/ParameterCommand.d.ts +2 -2
  447. package/umd/src/commands/PERSONA/PersonaCommand.d.ts +2 -2
  448. package/umd/src/commands/POSTPROCESS/PostprocessCommand.d.ts +1 -1
  449. package/umd/src/commands/_common/parseCommand.d.ts +1 -1
  450. package/umd/src/commands/_common/stringifyCommand.d.ts +1 -1
  451. package/umd/src/commands/_common/types/CommandParser.d.ts +2 -1
  452. package/umd/src/commitments/MEMORY/MEMORY.d.ts +2 -2
  453. package/umd/src/commitments/MEMORY/MemoryToolRuntimeAdapter.d.ts +1 -1
  454. package/umd/src/commitments/MEMORY/createMemoryToolFunctions.d.ts +1 -1
  455. package/umd/src/commitments/MEMORY/getMemoryToolTitles.d.ts +1 -1
  456. package/umd/src/commitments/MEMORY/resolveMemoryRuntimeContext.d.ts +1 -1
  457. package/umd/src/commitments/TEAM/TEAM.d.ts +2 -2
  458. package/umd/src/commitments/USE_BROWSER/USE_BROWSER.d.ts +2 -2
  459. package/umd/src/commitments/USE_BROWSER/resolveRunBrowserToolForNode.d.ts +1 -1
  460. package/umd/src/commitments/USE_CALENDAR/USE_CALENDAR.d.ts +1 -1
  461. package/umd/src/commitments/USE_CALENDAR/createUseCalendarToolFunctions.d.ts +1 -1
  462. package/umd/src/commitments/USE_CALENDAR/getUseCalendarToolTitles.d.ts +1 -1
  463. package/umd/src/commitments/USE_CALENDAR/resolveUseCalendarToolRuntimeOrWalletCredentialResult.d.ts +1 -1
  464. package/umd/src/commitments/USE_DEEPSEARCH/USE_DEEPSEARCH.d.ts +2 -2
  465. package/umd/src/commitments/USE_EMAIL/USE_EMAIL.d.ts +2 -2
  466. package/umd/src/commitments/USE_EMAIL/resolveSendEmailToolForNode.d.ts +1 -1
  467. package/umd/src/commitments/USE_POPUP/USE_POPUP.d.ts +2 -2
  468. package/umd/src/commitments/USE_PRIVACY/USE_PRIVACY.d.ts +2 -2
  469. package/umd/src/commitments/USE_PROJECT/USE_PROJECT.d.ts +1 -1
  470. package/umd/src/commitments/USE_PROJECT/createUseProjectToolFunctions.d.ts +1 -1
  471. package/umd/src/commitments/USE_PROJECT/getUseProjectToolTitles.d.ts +1 -1
  472. package/umd/src/commitments/USE_PROJECT/resolveUseProjectToolRuntimeOrWalletCredentialResult.d.ts +1 -1
  473. package/umd/src/commitments/USE_SEARCH_ENGINE/USE_SEARCH_ENGINE.d.ts +2 -2
  474. package/umd/src/commitments/USE_SPAWN/USE_SPAWN.d.ts +2 -2
  475. package/umd/src/commitments/USE_SPAWN/resolveSpawnAgentToolForNode.d.ts +1 -1
  476. package/umd/src/commitments/USE_TIME/USE_TIME.d.ts +2 -2
  477. package/umd/src/commitments/USE_TIMEOUT/TimeoutToolRuntimeAdapter.d.ts +1 -1
  478. package/umd/src/commitments/USE_TIMEOUT/USE_TIMEOUT.d.ts +2 -2
  479. package/umd/src/commitments/USE_TIMEOUT/createTimeoutToolFunctions.d.ts +1 -1
  480. package/umd/src/commitments/USE_TIMEOUT/resolveTimeoutRuntimeContext.d.ts +1 -1
  481. package/umd/src/commitments/USE_USER_LOCATION/USE_USER_LOCATION.d.ts +2 -2
  482. package/umd/src/commitments/WALLET/WALLET.d.ts +1 -1
  483. package/umd/src/commitments/WALLET/WalletToolRuntimeAdapter.d.ts +1 -1
  484. package/umd/src/commitments/WALLET/createWalletToolFunctions.d.ts +1 -1
  485. package/umd/src/commitments/WALLET/getWalletToolTitles.d.ts +1 -1
  486. package/umd/src/commitments/WALLET/resolveWalletRuntimeContext.d.ts +1 -1
  487. package/umd/src/commitments/_base/BaseCommitmentDefinition.d.ts +2 -2
  488. package/umd/src/commitments/_base/CommitmentDefinition.d.ts +2 -2
  489. package/umd/src/commitments/_common/commitmentToolFunctions.d.ts +2 -2
  490. package/umd/src/commitments/_common/createSerpSearchToolFunction.d.ts +1 -1
  491. package/umd/src/commitments/_common/getAllCommitmentsToolFunctionsForNode.d.ts +1 -1
  492. package/umd/src/commitments/_common/getAllCommitmentsToolTitles.d.ts +1 -1
  493. package/umd/src/commitments/_common/getGroupedCommitmentDefinitions.d.ts +1 -1
  494. package/umd/src/commitments/_common/toolExecutionEnvelope.d.ts +1 -1
  495. package/umd/src/commitments/_common/toolRuntimeContext.d.ts +1 -1
  496. package/umd/src/config.d.ts +5 -1
  497. package/umd/src/conversion/archive/loadArchive.d.ts +1 -1
  498. package/umd/src/conversion/archive/saveArchive.d.ts +1 -1
  499. package/umd/src/conversion/prettify/renderPipelineMermaidOptions.d.ts +1 -1
  500. package/umd/src/conversion/utils/extractParameterNamesFromTask.d.ts +1 -1
  501. package/umd/src/errors/PipelineExecutionError.d.ts +1 -1
  502. package/umd/src/errors/utils/ErrorJson.d.ts +1 -1
  503. package/umd/src/executables/apps/locateLibreoffice.d.ts +1 -1
  504. package/umd/src/executables/apps/locatePandoc.d.ts +1 -1
  505. package/umd/src/executables/apps/locateVscode.d.ts +1 -1
  506. package/umd/src/executables/browsers/locateBrowser.d.ts +1 -1
  507. package/umd/src/executables/browsers/locateChrome.d.ts +1 -1
  508. package/umd/src/executables/browsers/locateDefaultSystemBrowser.d.ts +1 -1
  509. package/umd/src/executables/browsers/locateEdge.d.ts +1 -1
  510. package/umd/src/executables/browsers/locateFirefox.d.ts +1 -1
  511. package/umd/src/executables/browsers/locateInternetExplorer.d.ts +1 -1
  512. package/umd/src/executables/browsers/locateSafari.d.ts +1 -1
  513. package/umd/src/executables/locateApp.d.ts +1 -1
  514. package/umd/src/executables/platforms/locateAppOnLinux.d.ts +1 -1
  515. package/umd/src/executables/platforms/locateAppOnMacOs.d.ts +1 -1
  516. package/umd/src/executables/platforms/locateAppOnWindows.d.ts +1 -1
  517. package/umd/src/execution/AbstractTaskResult.d.ts +1 -1
  518. package/umd/src/execution/AvailableModel.d.ts +5 -1
  519. package/umd/src/execution/CommonToolsOptions.d.ts +1 -1
  520. package/umd/src/execution/Executables.d.ts +1 -1
  521. package/umd/src/execution/ExecutionTask.d.ts +3 -2
  522. package/umd/src/execution/LlmExecutionTools.d.ts +2 -1
  523. package/umd/src/execution/PipelineExecutor.d.ts +1 -1
  524. package/umd/src/execution/PipelineExecutorResult.d.ts +2 -2
  525. package/umd/src/execution/PromptResult.d.ts +3 -1
  526. package/umd/src/execution/PromptbookFetch.d.ts +1 -1
  527. package/umd/src/execution/ScriptExecutionTools.d.ts +2 -2
  528. package/umd/src/execution/UncertainNumber.d.ts +2 -2
  529. package/umd/src/execution/UserInterfaceTools.d.ts +1 -2
  530. package/umd/src/execution/createPipelineExecutor/10-executePipeline.d.ts +1 -1
  531. package/umd/src/execution/createPipelineExecutor/20-executeTask.d.ts +1 -1
  532. package/umd/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +2 -1
  533. package/umd/src/execution/createPipelineExecutor/filterJustOutputParameters.d.ts +1 -1
  534. package/umd/src/execution/createPipelineExecutor/getContextForTask.d.ts +2 -2
  535. package/umd/src/execution/createPipelineExecutor/getExamplesForTask.d.ts +2 -2
  536. package/umd/src/execution/createPipelineExecutor/getKnowledgeForTask.d.ts +3 -1
  537. package/umd/src/execution/createPipelineExecutor/getReservedParametersForTask.d.ts +1 -2
  538. package/umd/src/execution/execution-report/ExecutionReportJson.d.ts +3 -3
  539. package/umd/src/execution/execution-report/ExecutionReportStringOptions.d.ts +1 -1
  540. package/umd/src/execution/utils/usageToHuman.d.ts +1 -1
  541. package/umd/src/execution/utils/validatePromptResult.d.ts +1 -1
  542. package/umd/src/file-security-checkers/FileSecurityCheckResult.d.ts +2 -1
  543. package/umd/src/file-security-checkers/FileSecurityChecker.d.ts +3 -1
  544. package/umd/src/file-security-checkers/virustotal/VirusTotalFileSecurityChecker.d.ts +1 -1
  545. package/umd/src/formats/_common/FormatParser.d.ts +2 -2
  546. package/umd/src/formats/_common/FormatSubvalueParser.d.ts +2 -3
  547. package/umd/src/formats/csv/utils/csvParse.d.ts +1 -1
  548. package/umd/src/formfactors/_common/AbstractFormfactorDefinition.d.ts +2 -3
  549. package/umd/src/import-plugins/FileImportPlugin.d.ts +1 -1
  550. package/umd/src/llm-providers/_common/register/$provideEnvFilename.d.ts +1 -1
  551. package/umd/src/llm-providers/_common/register/$provideLlmToolsForWizardOrCli.d.ts +3 -2
  552. package/umd/src/llm-providers/_common/register/$registeredLlmToolsMessage.d.ts +2 -1
  553. package/umd/src/llm-providers/_common/register/LlmToolsConfiguration.d.ts +1 -1
  554. package/umd/src/llm-providers/_common/register/LlmToolsMetadata.d.ts +2 -1
  555. package/umd/src/llm-providers/_common/register/createLlmToolsFromConfiguration.d.ts +3 -1
  556. package/umd/src/llm-providers/_common/utils/assertUniqueModels.d.ts +1 -1
  557. package/umd/src/llm-providers/_common/utils/cache/CacheItem.d.ts +2 -2
  558. package/umd/src/llm-providers/_multiple/MultipleLlmExecutionTools.d.ts +2 -1
  559. package/umd/src/llm-providers/_multiple/joinLlmExecutionTools.d.ts +2 -1
  560. package/umd/src/llm-providers/agent/Agent.d.ts +6 -2
  561. package/umd/src/llm-providers/agent/AgentLlmExecutionTools.d.ts +3 -1
  562. package/umd/src/llm-providers/agent/RemoteAgent.d.ts +2 -2
  563. package/umd/src/llm-providers/agent/RemoteAgentOptions.d.ts +1 -1
  564. package/umd/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +2 -1
  565. package/umd/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +1 -1
  566. package/umd/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +2 -1
  567. package/umd/src/llm-providers/azure-openai/AzureOpenAiExecutionToolsOptions.d.ts +2 -3
  568. package/umd/src/llm-providers/deepseek/deepseek-models.d.ts +1 -1
  569. package/umd/src/llm-providers/google/google-models.d.ts +1 -1
  570. package/umd/src/llm-providers/mocked/$fakeTextToExpectations.d.ts +1 -1
  571. package/umd/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts +2 -1
  572. package/umd/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts +2 -1
  573. package/umd/src/llm-providers/ollama/OllamaExecutionTools.d.ts +2 -1
  574. package/umd/src/llm-providers/openai/OpenAiAgentKitExecutionTools.d.ts +3 -2
  575. package/umd/src/llm-providers/openai/OpenAiAgentKitExecutionToolsOptions.d.ts +1 -1
  576. package/umd/src/llm-providers/openai/OpenAiAssistantExecutionTools.d.ts +3 -1
  577. package/umd/src/llm-providers/openai/OpenAiAssistantExecutionToolsOptions.d.ts +1 -1
  578. package/umd/src/llm-providers/openai/OpenAiCompatibleExecutionTools.d.ts +3 -1
  579. package/umd/src/llm-providers/openai/OpenAiExecutionTools.d.ts +2 -1
  580. package/umd/src/llm-providers/openai/OpenAiVectorStoreHandler.d.ts +2 -2
  581. package/umd/src/llm-providers/openai/createOpenAiCompatibleExecutionTools.d.ts +3 -1
  582. package/umd/src/llm-providers/openai/utils/OpenAiCompatibleUnsupportedParameterRetrier.d.ts +1 -1
  583. package/umd/src/llm-providers/openai/utils/callOpenAiCompatibleChatModel.d.ts +2 -1
  584. package/umd/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts +2 -1
  585. package/umd/src/other/templates/getBookTemplates.d.ts +1 -1
  586. package/umd/src/personas/preparePersona.d.ts +1 -1
  587. package/umd/src/pipeline/PipelineJson/CommonTaskJson.d.ts +4 -8
  588. package/umd/src/pipeline/PipelineJson/Expectations.d.ts +1 -2
  589. package/umd/src/pipeline/PipelineJson/KnowledgePieceJson.d.ts +4 -6
  590. package/umd/src/pipeline/PipelineJson/KnowledgeSourceJson.d.ts +3 -3
  591. package/umd/src/pipeline/PipelineJson/ParameterJson.d.ts +2 -3
  592. package/umd/src/pipeline/PipelineJson/PersonaJson.d.ts +3 -3
  593. package/umd/src/pipeline/PipelineJson/PipelineJson.d.ts +6 -9
  594. package/umd/src/pipeline/PipelineJson/PreparationJson.d.ts +1 -1
  595. package/umd/src/pipeline/PipelineJson/PromptTaskJson.d.ts +1 -1
  596. package/umd/src/pipeline/prompt-notation.d.ts +1 -1
  597. package/umd/src/postprocessing/utils/extractBlock.d.ts +1 -1
  598. package/umd/src/postprocessing/utils/extractJsonBlock.d.ts +1 -2
  599. package/umd/src/prepare/PrepareAndScrapeOptions.d.ts +1 -1
  600. package/umd/src/remote-server/socket-types/_subtypes/Identification.d.ts +2 -2
  601. package/umd/src/remote-server/socket-types/_subtypes/identificationToPromptbookToken.d.ts +1 -1
  602. package/umd/src/remote-server/socket-types/_subtypes/promptbookTokenToIdentification.d.ts +1 -1
  603. package/umd/src/remote-server/startAgentServer.d.ts +1 -1
  604. package/umd/src/remote-server/types/RemoteClientOptions.d.ts +1 -1
  605. package/umd/src/remote-server/types/RemoteServerOptions.d.ts +2 -1
  606. package/umd/src/scrapers/_common/Scraper.d.ts +4 -4
  607. package/umd/src/scrapers/_common/ScraperIntermediateSource.d.ts +1 -1
  608. package/umd/src/scrapers/_common/register/$registeredScrapersMessage.d.ts +1 -1
  609. package/umd/src/scrapers/_common/register/ScraperAndConverterMetadata.d.ts +3 -1
  610. package/umd/src/scrapers/_common/utils/getScraperIntermediateSource.d.ts +1 -1
  611. package/umd/src/scrapers/website/WebsiteScraper.d.ts +2 -3
  612. package/umd/src/scripting/javascript/JavascriptExecutionToolsOptions.d.ts +2 -2
  613. package/umd/src/scripting/javascript/utils/extractVariablesFromJavascript.d.ts +2 -2
  614. package/umd/src/search-engines/SearchEngine.d.ts +2 -1
  615. package/umd/src/search-engines/SearchResult.d.ts +1 -1
  616. package/umd/src/search-engines/bing/BingSearchEngine.d.ts +2 -1
  617. package/umd/src/search-engines/dummy/DummySearchEngine.d.ts +2 -1
  618. package/umd/src/search-engines/google/GoogleSearchEngine.d.ts +2 -1
  619. package/umd/src/search-engines/serp/SerpSearchEngine.d.ts +2 -1
  620. package/umd/src/storage/file-cache-storage/FileCacheStorageOptions.d.ts +1 -1
  621. package/umd/src/storage/file-cache-storage/utils/nameToSubfolderPath.d.ts +1 -1
  622. package/umd/src/storage/local-storage/utils/IndexedDbStorageOptions.d.ts +1 -1
  623. package/umd/src/transpilers/_common/BookTranspiler.d.ts +4 -2
  624. package/umd/src/transpilers/_common/createTranspiledTeamRuntimeSection.d.ts +1 -1
  625. package/umd/src/transpilers/_common/formatUsedToolFunctions.d.ts +1 -1
  626. package/umd/src/transpilers/agent-os/AgentOsTranspiler.d.ts +1 -1
  627. package/umd/src/transpilers/anthropic-claude-managed/AnthropicClaudeManagedTranspiler.d.ts +1 -1
  628. package/umd/src/transpilers/anthropic-claude-sdk/AnthropicClaudeSdkTranspiler.d.ts +1 -1
  629. package/umd/src/transpilers/e2b/E2BTranspiler.d.ts +1 -1
  630. package/umd/src/transpilers/formatted-book-in-markdown/FormattedBookInMarkdownTranspiler.d.ts +1 -1
  631. package/umd/src/transpilers/openai-agents/OpenAiAgentsTranspiler.d.ts +1 -1
  632. package/umd/src/transpilers/openai-sdk/OpenAiSdkTranspiler.d.ts +1 -1
  633. package/umd/src/types/LlmCall.d.ts +1 -1
  634. package/umd/src/types/LlmToolDefinition.d.ts +2 -1
  635. package/umd/src/types/Message.d.ts +4 -3
  636. package/umd/src/types/ModelRequirements.d.ts +4 -2
  637. package/umd/src/types/Prompt.d.ts +7 -12
  638. package/umd/src/types/SpeechRecognition.d.ts +1 -1
  639. package/umd/src/types/ToolCall.d.ts +1 -1
  640. package/umd/src/types/string_email.d.ts +1 -1
  641. package/umd/src/types/string_host.d.ts +1 -1
  642. package/umd/src/types/string_person_fullname.d.ts +1 -1
  643. package/umd/src/types/string_token.d.ts +1 -1
  644. package/umd/src/utils/agents/resolveAgentAvatarImageUrl.d.ts +2 -1
  645. package/umd/src/utils/color/Color.d.ts +2 -1
  646. package/umd/src/utils/color/internal-utils/hslToRgb.d.ts +2 -3
  647. package/umd/src/utils/color/internal-utils/rgbToHsl.d.ts +2 -3
  648. package/umd/src/utils/color/operators/darken.d.ts +1 -1
  649. package/umd/src/utils/color/operators/grayscale.d.ts +1 -1
  650. package/umd/src/utils/color/operators/lighten.d.ts +1 -1
  651. package/umd/src/utils/color/operators/mixWithColor.d.ts +1 -1
  652. package/umd/src/utils/color/operators/saturate.d.ts +1 -1
  653. package/umd/src/utils/color/parsers/parseHexColor.d.ts +1 -1
  654. package/umd/src/utils/color/parsers/parseHslColor.d.ts +1 -1
  655. package/umd/src/utils/color/parsers/parseRgbColor.d.ts +1 -1
  656. package/umd/src/utils/color/utils/colorToDataUrl.d.ts +3 -1
  657. package/umd/src/utils/editable/edit-pipeline-string/addPipelineCommand.d.ts +1 -1
  658. package/umd/src/utils/editable/types/PipelineEditableSerialized.d.ts +1 -1
  659. package/umd/src/utils/editable/utils/renamePipelineParameter.d.ts +1 -1
  660. package/umd/src/utils/editable/utils/stringifyPipelineJson.d.ts +1 -1
  661. package/umd/src/utils/files/$induceFileDownload.d.ts +1 -1
  662. package/umd/src/utils/files/ObjectUrl.d.ts +2 -1
  663. package/umd/src/utils/files/extensionToMimeType.d.ts +2 -2
  664. package/umd/src/utils/files/getFileExtension.d.ts +2 -2
  665. package/umd/src/utils/files/isDirectoryExisting.d.ts +1 -1
  666. package/umd/src/utils/files/isFileExisting.d.ts +1 -1
  667. package/umd/src/utils/files/listAllFiles.d.ts +1 -1
  668. package/umd/src/utils/files/mimeTypeToExtension.d.ts +2 -2
  669. package/umd/src/utils/filesystem/promptbookTemporaryPath.d.ts +27 -0
  670. package/umd/src/utils/filesystem/promptbookTemporaryPath.test.d.ts +1 -0
  671. package/umd/src/utils/knowledge/inlineKnowledgeSource.d.ts +3 -1
  672. package/umd/src/utils/markdown/addAutoGeneratedSection.d.ts +2 -2
  673. package/umd/src/utils/markdown/createMarkdownChart.d.ts +1 -1
  674. package/umd/src/utils/markdown/createMarkdownTable.d.ts +1 -2
  675. package/umd/src/utils/markdown/escapeMarkdownBlock.d.ts +1 -1
  676. package/umd/src/utils/markdown/extractAllBlocksFromMarkdown.d.ts +1 -1
  677. package/umd/src/utils/markdown/extractAllListItemsFromMarkdown.d.ts +1 -1
  678. package/umd/src/utils/markdown/extractOneBlockFromMarkdown.d.ts +1 -1
  679. package/umd/src/utils/markdown/flattenMarkdown.d.ts +1 -1
  680. package/umd/src/utils/markdown/humanizeAiText.d.ts +1 -1
  681. package/umd/src/utils/markdown/humanizeAiTextEllipsis.d.ts +1 -1
  682. package/umd/src/utils/markdown/humanizeAiTextEmdashed.d.ts +1 -1
  683. package/umd/src/utils/markdown/humanizeAiTextQuotes.d.ts +1 -1
  684. package/umd/src/utils/markdown/humanizeAiTextSources.d.ts +1 -1
  685. package/umd/src/utils/markdown/humanizeAiTextWhitespace.d.ts +1 -1
  686. package/umd/src/utils/markdown/parseMarkdownSection.d.ts +1 -1
  687. package/umd/src/utils/markdown/prettifyMarkdown.d.ts +1 -1
  688. package/umd/src/utils/markdown/promptbookifyAiText.d.ts +1 -1
  689. package/umd/src/utils/markdown/removeMarkdownComments.d.ts +1 -2
  690. package/umd/src/utils/markdown/removeMarkdownFormatting.d.ts +1 -1
  691. package/umd/src/utils/markdown/splitMarkdownIntoSections.d.ts +1 -1
  692. package/umd/src/utils/misc/$Register.d.ts +1 -1
  693. package/umd/src/utils/misc/$getCurrentDate.d.ts +1 -1
  694. package/umd/src/utils/misc/aboutPromptbookInformation.d.ts +1 -1
  695. package/umd/src/utils/misc/computeHash.d.ts +2 -2
  696. package/umd/src/utils/misc/injectCssModuleIntoShadowRoot.d.ts +1 -1
  697. package/umd/src/utils/normalization/suffixUrl.d.ts +1 -1
  698. package/umd/src/utils/organization/keepImported.d.ts +1 -1
  699. package/umd/src/utils/parameters/extractParameterNames.d.ts +2 -2
  700. package/umd/src/utils/parameters/mapAvailableToExpectedParameters.d.ts +1 -1
  701. package/umd/src/utils/parameters/numberToString.d.ts +1 -1
  702. package/umd/src/utils/parameters/templateParameters.d.ts +2 -1
  703. package/umd/src/utils/parameters/valueToString.d.ts +1 -1
  704. package/umd/src/utils/random/$generateBookBoilerplate.d.ts +1 -1
  705. package/umd/src/utils/random/$randomAgentPersona.d.ts +1 -1
  706. package/umd/src/utils/random/$randomAgentRule.d.ts +1 -1
  707. package/umd/src/utils/random/$randomFullnameWithColor.d.ts +1 -1
  708. package/umd/src/utils/random/$randomSeed.d.ts +1 -1
  709. package/umd/src/utils/random/$randomToken.d.ts +1 -1
  710. package/umd/src/utils/random/NamePool.d.ts +1 -1
  711. package/umd/src/utils/serialization/checkSerializableAsJson.d.ts +1 -1
  712. package/umd/src/utils/serialization/serializeToPromptbookJavascript.d.ts +1 -1
  713. package/umd/src/utils/toolCalls/mergeToolCalls.d.ts +1 -1
  714. package/umd/src/utils/validators/email/isValidEmail.d.ts +1 -1
  715. package/umd/src/utils/validators/filePath/isRootPath.d.ts +1 -2
  716. package/umd/src/utils/validators/filePath/isValidFilePath.d.ts +1 -1
  717. package/umd/src/utils/validators/javascriptName/isValidJavascriptName.d.ts +1 -1
  718. package/umd/src/utils/validators/parameterName/validateParameterName.d.ts +1 -1
  719. package/umd/src/utils/validators/semanticVersion/isValidSemanticVersion.d.ts +1 -1
  720. package/umd/src/utils/validators/url/isHostnameOnPrivateNetwork.d.ts +1 -1
  721. package/umd/src/utils/validators/url/isUrlOnPrivateNetwork.d.ts +2 -2
  722. package/umd/src/utils/validators/url/isValidAgentUrl.d.ts +1 -1
  723. package/umd/src/utils/validators/url/isValidPipelineUrl.d.ts +1 -1
  724. package/umd/src/utils/validators/url/isValidUrl.d.ts +1 -1
  725. package/umd/src/utils/validators/uuid/isValidUuid.d.ts +1 -1
  726. package/umd/src/version.d.ts +1 -1
  727. package/umd/src/wizard/$getCompiledBook.d.ts +2 -1
  728. package/umd/src/wizard/wizard.d.ts +4 -1
  729. package/esm/src/utils/files/getPromptbookTempPath.d.ts +0 -24
  730. package/umd/src/utils/files/getPromptbookTempPath.d.ts +0 -24
  731. /package/esm/src/{utils/files/getPromptbookTempPath.test.d.ts → book-3.0/Book.test.d.ts} +0 -0
  732. /package/{umd/src/utils/files/getPromptbookTempPath.test.d.ts → esm/src/cli/other/install.test.d.ts} +0 -0
package/esm/index.es.js CHANGED
@@ -1,14 +1,14 @@
1
1
  import { mkdir, rm, readFile } from 'fs/promises';
2
2
  import { spaceTrim as spaceTrim$1 } from 'spacetrim';
3
- import { posix, basename, join, dirname, isAbsolute } from 'path';
4
3
  import { spawn } from 'child_process';
5
4
  import colors from 'colors';
6
5
  import { forTime } from 'waitasecond';
7
- import { SHA256 } from 'crypto-js';
8
- import hexEncoder from 'crypto-js/enc-hex';
9
6
  import { randomBytes } from 'crypto';
10
7
  import { Subject } from 'rxjs';
8
+ import hexEncoder from 'crypto-js/enc-hex';
11
9
  import sha256 from 'crypto-js/sha256';
10
+ import { basename, join, dirname, isAbsolute } from 'path';
11
+ import { SHA256 } from 'crypto-js';
12
12
  import { lookup, extension } from 'mime-types';
13
13
  import { parse, unparse } from 'papaparse';
14
14
 
@@ -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-66';
29
+ const PROMPTBOOK_ENGINE_VERSION = '0.112.0-70';
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
@@ -964,27 +964,33 @@ function saturate(amount) {
964
964
  // TODO: Maybe implement by mix+hsl
965
965
 
966
966
  /**
967
- * Relative directory name without the `./` prefix for Git ignore rules and glob patterns.
967
+ * Stable root directory used for Promptbook-owned temporary files and caches.
968
968
  *
969
- * @private internal utility for Promptbook-owned temp files
969
+ * @private internal utility for Promptbook temporary folders
970
970
  */
971
- const PROMPTBOOK_TEMP_DIRECTORY_NAME = '.promptbook';
971
+ const PROMPTBOOK_TEMPORARY_DIRECTORY = '.promptbook';
972
972
  /**
973
- * Builds one project-relative path inside the shared Promptbook working directory.
973
+ * Builds one normalized project-relative path inside Promptbook's dedicated temporary root.
974
974
  *
975
- * @private internal utility for Promptbook-owned temp files
975
+ * The returned path intentionally uses `/` separators so the same helper can be reused from
976
+ * Node.js and edge-safe code without depending on the Node `path` module.
977
+ *
978
+ * @private internal utility for Promptbook temporary folders
976
979
  */
977
- function getPromptbookTempPath(...pathSegments) {
978
- return `./${getPromptbookTempPosixPath(...pathSegments)}`;
980
+ function getPromptbookTemporaryPath(...pathSegments) {
981
+ const normalizedPathSegments = pathSegments.flatMap(splitPathSegments).filter(Boolean);
982
+ return [PROMPTBOOK_TEMPORARY_DIRECTORY, ...normalizedPathSegments].join('/');
979
983
  }
980
984
  /**
981
- * Builds one POSIX path fragment inside the shared Promptbook working directory for globs and generated text files.
982
- *
983
- * @private internal utility for Promptbook-owned temp files
985
+ * Normalizes one raw path segment into slash-delimited pieces without empty items.
984
986
  */
985
- function getPromptbookTempPosixPath(...pathSegments) {
986
- return posix.join(PROMPTBOOK_TEMP_DIRECTORY_NAME, ...pathSegments);
987
+ function splitPathSegments(pathSegment) {
988
+ return pathSegment
989
+ .split(/[\\/]+/u)
990
+ .map((segment) => segment.trim())
991
+ .filter(Boolean);
987
992
  }
993
+ // Note: [💞] Ignore a discrepancy between file name and entity name
988
994
 
989
995
  /**
990
996
  * Returns the same value that is passed as argument.
@@ -1168,7 +1174,7 @@ const DEFAULT_MAX_EXECUTION_ATTEMPTS = 7; // <- TODO: [🤹‍♂️]
1168
1174
  *
1169
1175
  * @public exported from `@promptbook/core`
1170
1176
  */
1171
- const DEFAULT_DOWNLOAD_CACHE_DIRNAME = getPromptbookTempPath('download-cache');
1177
+ const DEFAULT_DOWNLOAD_CACHE_DIRNAME = `./${getPromptbookTemporaryPath('download-cache')}`;
1172
1178
  /**
1173
1179
  * Where to store the cache of executions for promptbook CLI
1174
1180
  *
@@ -1176,7 +1182,7 @@ const DEFAULT_DOWNLOAD_CACHE_DIRNAME = getPromptbookTempPath('download-cache');
1176
1182
  *
1177
1183
  * @public exported from `@promptbook/core`
1178
1184
  */
1179
- getPromptbookTempPath('execution-cache');
1185
+ `./${getPromptbookTemporaryPath('execution-cache')}`;
1180
1186
  /**
1181
1187
  * Where to store the scrape cache
1182
1188
  *
@@ -1184,7 +1190,7 @@ getPromptbookTempPath('execution-cache');
1184
1190
  *
1185
1191
  * @public exported from `@promptbook/core`
1186
1192
  */
1187
- const DEFAULT_SCRAPE_CACHE_DIRNAME = getPromptbookTempPath('scrape-cache');
1193
+ const DEFAULT_SCRAPE_CACHE_DIRNAME = `./${getPromptbookTemporaryPath('scrape-cache')}`;
1188
1194
  // <- TODO: [🧜‍♂️]
1189
1195
  /**
1190
1196
  * Default settings for parsing and generating CSV files in Promptbook.
@@ -1564,343 +1570,33 @@ async function isFileExisting(filename, fs) {
1564
1570
  // TODO: [🐠] This can be a validator - with variants that return true/false and variants that throw errors with meaningless messages
1565
1571
  // TODO: [🖇] What about symlinks?
1566
1572
 
1573
+ 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"}];
1574
+
1567
1575
  /**
1568
- * Converts a name to a properly formatted subfolder path for cache storage.
1569
- * Handles normalization and path formatting to create consistent cache directory structures.
1576
+ * Checks if value is valid email
1570
1577
  *
1571
- * @private for `FileCacheStorage`
1578
+ * @public exported from `@promptbook/utils`
1572
1579
  */
1573
- function nameToSubfolderPath(name) {
1574
- return [name.substr(0, 1).toLowerCase(), name.substr(1, 1).toLowerCase()];
1580
+ function isValidEmail(email) {
1581
+ if (typeof email !== 'string') {
1582
+ return false;
1583
+ }
1584
+ if (email.split(/\r?\n/).length > 1) {
1585
+ return false;
1586
+ }
1587
+ return /^.+@.+\..+$/.test(email);
1575
1588
  }
1576
1589
 
1577
1590
  /**
1578
- * Collection of default diacritics removal map.
1579
- */
1580
- const defaultDiacriticsRemovalMap = [
1581
- {
1582
- base: 'A',
1583
- letters: '\u0041\u24B6\uFF21\u00C0\u00C1\u00C2\u1EA6\u1EA4\u1EAA\u1EA8\u00C3\u0100\u0102\u1EB0\u1EAE\u1EB4\u1EB2\u0226\u01E0\u00C4\u01DE\u1EA2\u00C5\u01FA\u01CD\u0200\u0202\u1EA0\u1EAC\u1EB6\u1E00\u0104\u023A\u2C6F',
1584
- },
1585
- { base: 'AA', letters: '\uA732' },
1586
- { base: 'AE', letters: '\u00C6\u01FC\u01E2' },
1587
- { base: 'AO', letters: '\uA734' },
1588
- { base: 'AU', letters: '\uA736' },
1589
- { base: 'AV', letters: '\uA738\uA73A' },
1590
- { base: 'AY', letters: '\uA73C' },
1591
- {
1592
- base: 'B',
1593
- letters: '\u0042\u24B7\uFF22\u1E02\u1E04\u1E06\u0243\u0182\u0181',
1594
- },
1595
- {
1596
- base: 'C',
1597
- letters: '\u0043\u24B8\uFF23\u0106\u0108\u010A\u010C\u00C7\u1E08\u0187\u023B\uA73E',
1598
- },
1599
- {
1600
- base: 'D',
1601
- letters: '\u0044\u24B9\uFF24\u1E0A\u010E\u1E0C\u1E10\u1E12\u1E0E\u0110\u018B\u018A\u0189\uA779\u00D0',
1602
- },
1603
- { base: 'DZ', letters: '\u01F1\u01C4' },
1604
- { base: 'Dz', letters: '\u01F2\u01C5' },
1605
- {
1606
- base: 'E',
1607
- letters: '\u0045\u24BA\uFF25\u00C8\u00C9\u00CA\u1EC0\u1EBE\u1EC4\u1EC2\u1EBC\u0112\u1E14\u1E16\u0114\u0116\u00CB\u1EBA\u011A\u0204\u0206\u1EB8\u1EC6\u0228\u1E1C\u0118\u1E18\u1E1A\u0190\u018E',
1608
- },
1609
- { base: 'F', letters: '\u0046\u24BB\uFF26\u1E1E\u0191\uA77B' },
1610
- {
1611
- base: 'G',
1612
- letters: '\u0047\u24BC\uFF27\u01F4\u011C\u1E20\u011E\u0120\u01E6\u0122\u01E4\u0193\uA7A0\uA77D\uA77E',
1613
- },
1614
- {
1615
- base: 'H',
1616
- letters: '\u0048\u24BD\uFF28\u0124\u1E22\u1E26\u021E\u1E24\u1E28\u1E2A\u0126\u2C67\u2C75\uA78D',
1617
- },
1618
- {
1619
- base: 'I',
1620
- letters: '\u0049\u24BE\uFF29\u00CC\u00CD\u00CE\u0128\u012A\u012C\u0130\u00CF\u1E2E\u1EC8\u01CF\u0208\u020A\u1ECA\u012E\u1E2C\u0197',
1621
- },
1622
- { base: 'J', letters: '\u004A\u24BF\uFF2A\u0134\u0248' },
1623
- {
1624
- base: 'K',
1625
- letters: '\u004B\u24C0\uFF2B\u1E30\u01E8\u1E32\u0136\u1E34\u0198\u2C69\uA740\uA742\uA744\uA7A2',
1626
- },
1627
- {
1628
- base: 'L',
1629
- letters: '\u004C\u24C1\uFF2C\u013F\u0139\u013D\u1E36\u1E38\u013B\u1E3C\u1E3A\u0141\u023D\u2C62\u2C60\uA748\uA746\uA780',
1630
- },
1631
- { base: 'LJ', letters: '\u01C7' },
1632
- { base: 'Lj', letters: '\u01C8' },
1633
- { base: 'M', letters: '\u004D\u24C2\uFF2D\u1E3E\u1E40\u1E42\u2C6E\u019C' },
1634
- {
1635
- base: 'N',
1636
- letters: '\u004E\u24C3\uFF2E\u01F8\u0143\u00D1\u1E44\u0147\u1E46\u0145\u1E4A\u1E48\u0220\u019D\uA790\uA7A4',
1637
- },
1638
- { base: 'NJ', letters: '\u01CA' },
1639
- { base: 'Nj', letters: '\u01CB' },
1640
- {
1641
- base: 'O',
1642
- letters: '\u004F\u24C4\uFF2F\u00D2\u00D3\u00D4\u1ED2\u1ED0\u1ED6\u1ED4\u00D5\u1E4C\u022C\u1E4E\u014C\u1E50\u1E52\u014E\u022E\u0230\u00D6\u022A\u1ECE\u0150\u01D1\u020C\u020E\u01A0\u1EDC\u1EDA\u1EE0\u1EDE\u1EE2\u1ECC\u1ED8\u01EA\u01EC\u00D8\u01FE\u0186\u019F\uA74A\uA74C',
1643
- },
1644
- { base: 'OI', letters: '\u01A2' },
1645
- { base: 'OO', letters: '\uA74E' },
1646
- { base: 'OU', letters: '\u0222' },
1647
- { base: 'OE', letters: '\u008C\u0152' },
1648
- { base: 'oe', letters: '\u009C\u0153' },
1649
- {
1650
- base: 'P',
1651
- letters: '\u0050\u24C5\uFF30\u1E54\u1E56\u01A4\u2C63\uA750\uA752\uA754',
1652
- },
1653
- { base: 'Q', letters: '\u0051\u24C6\uFF31\uA756\uA758\u024A' },
1654
- {
1655
- base: 'R',
1656
- letters: '\u0052\u24C7\uFF32\u0154\u1E58\u0158\u0210\u0212\u1E5A\u1E5C\u0156\u1E5E\u024C\u2C64\uA75A\uA7A6\uA782',
1657
- },
1658
- {
1659
- base: 'S',
1660
- letters: '\u0053\u24C8\uFF33\u1E9E\u015A\u1E64\u015C\u1E60\u0160\u1E66\u1E62\u1E68\u0218\u015E\u2C7E\uA7A8\uA784',
1661
- },
1662
- {
1663
- base: 'T',
1664
- letters: '\u0054\u24C9\uFF34\u1E6A\u0164\u1E6C\u021A\u0162\u1E70\u1E6E\u0166\u01AC\u01AE\u023E\uA786',
1665
- },
1666
- { base: 'TZ', letters: '\uA728' },
1667
- {
1668
- base: 'U',
1669
- letters: '\u0055\u24CA\uFF35\u00D9\u00DA\u00DB\u0168\u1E78\u016A\u1E7A\u016C\u00DC\u01DB\u01D7\u01D5\u01D9\u1EE6\u016E\u0170\u01D3\u0214\u0216\u01AF\u1EEA\u1EE8\u1EEE\u1EEC\u1EF0\u1EE4\u1E72\u0172\u1E76\u1E74\u0244',
1670
- },
1671
- { base: 'V', letters: '\u0056\u24CB\uFF36\u1E7C\u1E7E\u01B2\uA75E\u0245' },
1672
- { base: 'VY', letters: '\uA760' },
1673
- {
1674
- base: 'W',
1675
- letters: '\u0057\u24CC\uFF37\u1E80\u1E82\u0174\u1E86\u1E84\u1E88\u2C72',
1676
- },
1677
- { base: 'X', letters: '\u0058\u24CD\uFF38\u1E8A\u1E8C' },
1678
- {
1679
- base: 'Y',
1680
- letters: '\u0059\u24CE\uFF39\u1EF2\u00DD\u0176\u1EF8\u0232\u1E8E\u0178\u1EF6\u1EF4\u01B3\u024E\u1EFE',
1681
- },
1682
- {
1683
- base: 'Z',
1684
- letters: '\u005A\u24CF\uFF3A\u0179\u1E90\u017B\u017D\u1E92\u1E94\u01B5\u0224\u2C7F\u2C6B\uA762',
1685
- },
1686
- {
1687
- base: 'a',
1688
- letters: '\u0061\u24D0\uFF41\u1E9A\u00E0\u00E1\u00E2\u1EA7\u1EA5\u1EAB\u1EA9\u00E3\u0101\u0103\u1EB1\u1EAF\u1EB5\u1EB3\u0227\u01E1\u00E4\u01DF\u1EA3\u00E5\u01FB\u01CE\u0201\u0203\u1EA1\u1EAD\u1EB7\u1E01\u0105\u2C65\u0250',
1689
- },
1690
- { base: 'aa', letters: '\uA733' },
1691
- { base: 'ae', letters: '\u00E6\u01FD\u01E3' },
1692
- { base: 'ao', letters: '\uA735' },
1693
- { base: 'au', letters: '\uA737' },
1694
- { base: 'av', letters: '\uA739\uA73B' },
1695
- { base: 'ay', letters: '\uA73D' },
1696
- {
1697
- base: 'b',
1698
- letters: '\u0062\u24D1\uFF42\u1E03\u1E05\u1E07\u0180\u0183\u0253',
1699
- },
1700
- {
1701
- base: 'c',
1702
- letters: '\u0063\u24D2\uFF43\u0107\u0109\u010B\u010D\u00E7\u1E09\u0188\u023C\uA73F\u2184',
1703
- },
1704
- {
1705
- base: 'd',
1706
- letters: '\u0064\u24D3\uFF44\u1E0B\u010F\u1E0D\u1E11\u1E13\u1E0F\u0111\u018C\u0256\u0257\uA77A',
1707
- },
1708
- { base: 'dz', letters: '\u01F3\u01C6' },
1709
- {
1710
- base: 'e',
1711
- letters: '\u0065\u24D4\uFF45\u00E8\u00E9\u00EA\u1EC1\u1EBF\u1EC5\u1EC3\u1EBD\u0113\u1E15\u1E17\u0115\u0117\u00EB\u1EBB\u011B\u0205\u0207\u1EB9\u1EC7\u0229\u1E1D\u0119\u1E19\u1E1B\u0247\u025B\u01DD',
1712
- },
1713
- { base: 'f', letters: '\u0066\u24D5\uFF46\u1E1F\u0192\uA77C' },
1714
- {
1715
- base: 'g',
1716
- letters: '\u0067\u24D6\uFF47\u01F5\u011D\u1E21\u011F\u0121\u01E7\u0123\u01E5\u0260\uA7A1\u1D79\uA77F',
1717
- },
1718
- {
1719
- base: 'h',
1720
- letters: '\u0068\u24D7\uFF48\u0125\u1E23\u1E27\u021F\u1E25\u1E29\u1E2B\u1E96\u0127\u2C68\u2C76\u0265',
1721
- },
1722
- { base: 'hv', letters: '\u0195' },
1723
- {
1724
- base: 'i',
1725
- letters: '\u0069\u24D8\uFF49\u00EC\u00ED\u00EE\u0129\u012B\u012D\u00EF\u1E2F\u1EC9\u01D0\u0209\u020B\u1ECB\u012F\u1E2D\u0268\u0131',
1726
- },
1727
- { base: 'j', letters: '\u006A\u24D9\uFF4A\u0135\u01F0\u0249' },
1728
- {
1729
- base: 'k',
1730
- letters: '\u006B\u24DA\uFF4B\u1E31\u01E9\u1E33\u0137\u1E35\u0199\u2C6A\uA741\uA743\uA745\uA7A3',
1731
- },
1732
- {
1733
- base: 'l',
1734
- letters: '\u006C\u24DB\uFF4C\u0140\u013A\u013E\u1E37\u1E39\u013C\u1E3D\u1E3B\u017F\u0142\u019A\u026B\u2C61\uA749\uA781\uA747',
1735
- },
1736
- { base: 'lj', letters: '\u01C9' },
1737
- { base: 'm', letters: '\u006D\u24DC\uFF4D\u1E3F\u1E41\u1E43\u0271\u026F' },
1738
- {
1739
- base: 'n',
1740
- letters: '\u006E\u24DD\uFF4E\u01F9\u0144\u00F1\u1E45\u0148\u1E47\u0146\u1E4B\u1E49\u019E\u0272\u0149\uA791\uA7A5',
1741
- },
1742
- { base: 'nj', letters: '\u01CC' },
1743
- {
1744
- base: 'o',
1745
- letters: '\u006F\u24DE\uFF4F\u00F2\u00F3\u00F4\u1ED3\u1ED1\u1ED7\u1ED5\u00F5\u1E4D\u022D\u1E4F\u014D\u1E51\u1E53\u014F\u022F\u0231\u00F6\u022B\u1ECF\u0151\u01D2\u020D\u020F\u01A1\u1EDD\u1EDB\u1EE1\u1EDF\u1EE3\u1ECD\u1ED9\u01EB\u01ED\u00F8\u01FF\u0254\uA74B\uA74D\u0275',
1746
- },
1747
- { base: 'oi', letters: '\u01A3' },
1748
- { base: 'ou', letters: '\u0223' },
1749
- { base: 'oo', letters: '\uA74F' },
1750
- {
1751
- base: 'p',
1752
- letters: '\u0070\u24DF\uFF50\u1E55\u1E57\u01A5\u1D7D\uA751\uA753\uA755',
1753
- },
1754
- { base: 'q', letters: '\u0071\u24E0\uFF51\u024B\uA757\uA759' },
1755
- {
1756
- base: 'r',
1757
- letters: '\u0072\u24E1\uFF52\u0155\u1E59\u0159\u0211\u0213\u1E5B\u1E5D\u0157\u1E5F\u024D\u027D\uA75B\uA7A7\uA783',
1758
- },
1759
- {
1760
- base: 's',
1761
- letters: '\u0073\u24E2\uFF53\u00DF\u015B\u1E65\u015D\u1E61\u0161\u1E67\u1E63\u1E69\u0219\u015F\u023F\uA7A9\uA785\u1E9B',
1762
- },
1763
- {
1764
- base: 't',
1765
- letters: '\u0074\u24E3\uFF54\u1E6B\u1E97\u0165\u1E6D\u021B\u0163\u1E71\u1E6F\u0167\u01AD\u0288\u2C66\uA787',
1766
- },
1767
- { base: 'tz', letters: '\uA729' },
1768
- {
1769
- base: 'u',
1770
- letters: '\u0075\u24E4\uFF55\u00F9\u00FA\u00FB\u0169\u1E79\u016B\u1E7B\u016D\u00FC\u01DC\u01D8\u01D6\u01DA\u1EE7\u016F\u0171\u01D4\u0215\u0217\u01B0\u1EEB\u1EE9\u1EEF\u1EED\u1EF1\u1EE5\u1E73\u0173\u1E77\u1E75\u0289',
1771
- },
1772
- { base: 'v', letters: '\u0076\u24E5\uFF56\u1E7D\u1E7F\u028B\uA75F\u028C' },
1773
- { base: 'vy', letters: '\uA761' },
1774
- {
1775
- base: 'w',
1776
- letters: '\u0077\u24E6\uFF57\u1E81\u1E83\u0175\u1E87\u1E85\u1E98\u1E89\u2C73',
1777
- },
1778
- { base: 'x', letters: '\u0078\u24E7\uFF58\u1E8B\u1E8D' },
1779
- {
1780
- base: 'y',
1781
- letters: '\u0079\u24E8\uFF59\u1EF3\u00FD\u0177\u1EF9\u0233\u1E8F\u00FF\u1EF7\u1E99\u1EF5\u01B4\u024F\u1EFF',
1782
- },
1783
- {
1784
- base: 'z',
1785
- letters: '\u007A\u24E9\uFF5A\u017A\u1E91\u017C\u017E\u1E93\u1E95\u01B6\u0225\u0240\u2C6C\uA763',
1786
- },
1787
- ];
1788
- /**
1789
- * Map of letters from diacritic variant to diacritless variant
1790
- * Contains lowercase and uppercase separatelly
1591
+ * Tests if given string is valid file path.
1791
1592
  *
1792
- * > "á" => "a"
1793
- * > "ě" => "e"
1794
- * > "Ă" => "A"
1795
- * > ...
1593
+ * Note: This does not check if the file exists only if the path is valid
1796
1594
  *
1797
1595
  * @public exported from `@promptbook/utils`
1798
1596
  */
1799
- const DIACRITIC_VARIANTS_LETTERS = {};
1800
- // tslint:disable-next-line: prefer-for-of
1801
- for (let i = 0; i < defaultDiacriticsRemovalMap.length; i++) {
1802
- const letters = defaultDiacriticsRemovalMap[i].letters;
1803
- // tslint:disable-next-line: prefer-for-of
1804
- for (let j = 0; j < letters.length; j++) {
1805
- DIACRITIC_VARIANTS_LETTERS[letters[j]] = defaultDiacriticsRemovalMap[i].base;
1806
- }
1807
- }
1808
- // <- TODO: [🍓] Put to maker function to save execution time if not needed
1809
- /*
1810
- @see https://stackoverflow.com/questions/990904/remove-accents-diacritics-in-a-string-in-javascript
1811
- Licensed under the Apache License, Version 2.0 (the "License");
1812
- you may not use this file except in compliance with the License.
1813
- You may obtain a copy of the License at
1814
-
1815
- http://www.apache.org/licenses/LICENSE-2.0
1816
-
1817
- Unless required by applicable law or agreed to in writing, software
1818
- distributed under the License is distributed on an "AS IS" BASIS,
1819
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1820
- See the License for the specific language governing permissions and
1821
- limitations under the License.
1822
- */
1823
-
1824
- /**
1825
- * Removes diacritic marks (accents) from characters in a string.
1826
- *
1827
- * Note: [🔂] This function is idempotent.
1828
- *
1829
- * @param input The string containing diacritics to be normalized.
1830
- * @returns The string with diacritics removed or normalized.
1831
- *
1832
- * @public exported from `@promptbook/utils`
1833
- */
1834
- function removeDiacritics(input) {
1835
- /*eslint no-control-regex: "off"*/
1836
- return input.replace(/[^\u0000-\u007E]/g, (character) => {
1837
- return DIACRITIC_VARIANTS_LETTERS[character] || character;
1838
- });
1839
- }
1840
- // TODO: [Ж] Variant for cyrillic (and in general non-latin) letters
1841
-
1842
- /**
1843
- * Converts a given text to kebab-case format.
1844
- *
1845
- * Note: [🔂] This function is idempotent.
1846
- *
1847
- * @param text The text to be converted.
1848
- * @returns The kebab-case formatted string.
1849
- * @example 'hello-world'
1850
- * @example 'i-love-promptbook'
1851
- *
1852
- * @public exported from `@promptbook/utils`
1853
- */
1854
- function normalizeToKebabCase(text) {
1855
- text = removeDiacritics(text);
1856
- let charType;
1857
- let lastCharType = 'OTHER';
1858
- let normalizedName = '';
1859
- for (const char of text) {
1860
- let normalizedChar;
1861
- if (/^[a-z]$/.test(char)) {
1862
- charType = 'LOWERCASE';
1863
- normalizedChar = char;
1864
- }
1865
- else if (/^[A-Z]$/.test(char)) {
1866
- charType = 'UPPERCASE';
1867
- normalizedChar = char.toLowerCase();
1868
- }
1869
- else if (/^[0-9]$/.test(char)) {
1870
- charType = 'NUMBER';
1871
- normalizedChar = char;
1872
- }
1873
- else {
1874
- charType = 'OTHER';
1875
- normalizedChar = '-';
1876
- }
1877
- if (charType !== lastCharType &&
1878
- !(lastCharType === 'UPPERCASE' && charType === 'LOWERCASE') &&
1879
- !(lastCharType === 'NUMBER') &&
1880
- !(charType === 'NUMBER')) {
1881
- normalizedName += '-';
1882
- }
1883
- normalizedName += normalizedChar;
1884
- lastCharType = charType;
1885
- }
1886
- normalizedName = normalizedName.split(/-+/g).join('-');
1887
- normalizedName = normalizedName.split(/-?\/-?/g).join('/');
1888
- normalizedName = normalizedName.replace(/^-/, '');
1889
- normalizedName = normalizedName.replace(/-$/, '');
1890
- return normalizedName;
1891
- }
1892
- // Note: [💞] Ignore a discrepancy between file name and entity name
1893
-
1894
- /**
1895
- * Tests if given string is valid file path.
1896
- *
1897
- * Note: This does not check if the file exists only if the path is valid
1898
- *
1899
- * @public exported from `@promptbook/utils`
1900
- */
1901
- function isValidFilePath(filename) {
1902
- if (typeof filename !== 'string') {
1903
- return false;
1597
+ function isValidFilePath(filename) {
1598
+ if (typeof filename !== 'string') {
1599
+ return false;
1904
1600
  }
1905
1601
  if (filename.split(/\r?\n/).length > 1) {
1906
1602
  return false;
@@ -1977,137 +1673,6 @@ function isValidUrl(url) {
1977
1673
  }
1978
1674
  }
1979
1675
 
1980
- /**
1981
- * Removes emojis from a string and fix whitespaces
1982
- *
1983
- * Note: [🔂] This function is idempotent.
1984
- *
1985
- * @param text with emojis
1986
- * @returns text without emojis
1987
- *
1988
- * @public exported from `@promptbook/utils`
1989
- */
1990
- function removeEmojis(text) {
1991
- // Replace emojis (and also ZWJ sequence) with hyphens
1992
- text = text.replace(/(\p{Extended_Pictographic})\p{Modifier_Symbol}/gu, '$1');
1993
- text = text.replace(/(\p{Extended_Pictographic})[\u{FE00}-\u{FE0F}]/gu, '$1');
1994
- text = text.replace(/(\p{Extended_Pictographic})(\u{200D}\p{Extended_Pictographic})*/gu, '$1');
1995
- text = text.replace(/\p{Extended_Pictographic}/gu, '');
1996
- return text;
1997
- }
1998
-
1999
- /**
2000
- * Converts a title string into a normalized name.
2001
- *
2002
- * Note: [🔂] This function is idempotent.
2003
- *
2004
- * @param value The title string to be converted to a name.
2005
- * @returns A normalized name derived from the input title.
2006
- * @example 'Hello World!' -> 'hello-world'
2007
- *
2008
- * @public exported from `@promptbook/utils`
2009
- */
2010
- function titleToName(value) {
2011
- if (isValidUrl(value)) {
2012
- value = value.replace(/^https?:\/\//, '');
2013
- value = value.replace(/\.html$/, '');
2014
- }
2015
- else if (isValidFilePath(value)) {
2016
- value = basename(value);
2017
- // Note: Keeping extension in the name
2018
- }
2019
- value = value.split('/').join('-');
2020
- value = removeEmojis(value);
2021
- value = normalizeToKebabCase(value);
2022
- // TODO: [🧠] Maybe warn or add some padding to short name which are not good identifiers
2023
- return value;
2024
- }
2025
-
2026
- /**
2027
- * Retrieves an intermediate source for a scraper based on the knowledge source.
2028
- * Manages the caching and retrieval of intermediate scraper results for optimized performance.
2029
- *
2030
- * @private as internal utility for scrapers
2031
- */
2032
- async function getScraperIntermediateSource(source, options) {
2033
- const { filename: sourceFilename, url } = source;
2034
- const { rootDirname, cacheDirname, intermediateFilesStrategy, extension, isVerbose } = options;
2035
- // TODO: [👬] DRY
2036
- const hash = SHA256(
2037
- // <- TODO: [🥬] Encapsulate sha256 to some private utility function
2038
- hexEncoder.parse(sourceFilename || url || 'untitled'))
2039
- .toString( /* hex */)
2040
- .substring(0, 20);
2041
- // <- TODO: [🥬] Make some system for hashes and ids of promptbook
2042
- const semanticName = normalizeToKebabCase(titleToName((sourceFilename || url || '').split('intermediate').join(''))).substring(0, 20);
2043
- // <- TODO: [🐱‍🐉]
2044
- const pieces = ['intermediate', semanticName, hash].filter((piece) => piece !== '');
2045
- const name = pieces.join('-').split('--').join('-');
2046
- const cacheFilename = join(process.cwd(), cacheDirname, ...nameToSubfolderPath(hash /* <- TODO: [🎎] Maybe add some SHA256 prefix */), name)
2047
- .split('\\')
2048
- .join('/') +
2049
- '.' +
2050
- extension;
2051
- // Note: Try to create cache directory, but don't fail if filesystem has issues
2052
- try {
2053
- await mkdir(dirname(cacheFilename), { recursive: true });
2054
- }
2055
- catch (error) {
2056
- // Note: If we can't create cache directory, continue without it
2057
- // This handles read-only filesystems, permission issues, and missing parent directories
2058
- if (error instanceof Error &&
2059
- (error.message.includes('EROFS') ||
2060
- error.message.includes('read-only') ||
2061
- error.message.includes('EACCES') ||
2062
- error.message.includes('EPERM') ||
2063
- error.message.includes('ENOENT'))) ;
2064
- else {
2065
- // Re-throw other unexpected errors
2066
- throw error;
2067
- }
2068
- }
2069
- let isDestroyed = true;
2070
- const fileHandler = {
2071
- filename: cacheFilename,
2072
- get isDestroyed() {
2073
- return isDestroyed;
2074
- },
2075
- async destroy() {
2076
- if (intermediateFilesStrategy === 'HIDE_AND_CLEAN') {
2077
- if (isVerbose) {
2078
- console.info('legacyDocumentScraper: Clening cache');
2079
- }
2080
- await rm(cacheFilename);
2081
- // TODO: [🐿][🧠] Maybe remove empty folders
2082
- }
2083
- isDestroyed = true;
2084
- },
2085
- };
2086
- return fileHandler;
2087
- }
2088
- // 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
2089
- // Note: Not using `FileCacheStorage` for two reasons:
2090
- // 1. Need to store more than serialized JSONs.
2091
- // 2. Need to switch between a `rootDirname` and `cacheDirname` <- TODO: [😡]
2092
- // TODO: [🐱‍🐉][🧠] Make some smart crop
2093
-
2094
- 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"}];
2095
-
2096
- /**
2097
- * Checks if value is valid email
2098
- *
2099
- * @public exported from `@promptbook/utils`
2100
- */
2101
- function isValidEmail(email) {
2102
- if (typeof email !== 'string') {
2103
- return false;
2104
- }
2105
- if (email.split(/\r?\n/).length > 1) {
2106
- return false;
2107
- }
2108
- return /^.+@.+\..+$/.test(email);
2109
- }
2110
-
2111
1676
  /**
2112
1677
  * This error indicates that the promptbook in a markdown format cannot be parsed into a valid promptbook object
2113
1678
  *
@@ -2257,11 +1822,11 @@ function capitalize(word) {
2257
1822
  */
2258
1823
  function pipelineJsonToString(pipelineJson) {
2259
1824
  const { title, pipelineUrl, bookVersion, description, parameters, tasks } = pipelineJson;
2260
- let pipelineString = `# ${title}`;
2261
- if (description) {
2262
- pipelineString += '\n\n';
2263
- pipelineString += description;
2264
- }
1825
+ let pipelineString = spaceTrim$1((block) => `
1826
+ # ${title}
1827
+
1828
+ ${block(description || '')}
1829
+ `);
2265
1830
  const commands = [];
2266
1831
  if (pipelineUrl) {
2267
1832
  commands.push(`PIPELINE URL ${pipelineUrl}`);
@@ -2277,20 +1842,17 @@ function pipelineJsonToString(pipelineJson) {
2277
1842
  for (const parameter of parameters.filter(({ isOutput }) => isOutput)) {
2278
1843
  commands.push(`OUTPUT PARAMETER ${taskParameterJsonToString(parameter)}`);
2279
1844
  }
2280
- pipelineString += '\n\n';
2281
- pipelineString += commands.map((command) => `- ${command}`).join('\n');
1845
+ pipelineString = spaceTrim$1((block) => `
1846
+ ${block(pipelineString)}
1847
+
1848
+ ${block(commands.map((command) => `- ${command}`).join('\n'))}
1849
+ `);
2282
1850
  for (const task of tasks) {
2283
1851
  const {
2284
1852
  /* Note: Not using:> name, */
2285
1853
  title, description,
2286
1854
  /* Note: dependentParameterNames, */
2287
1855
  jokerParameterNames: jokers, taskType, content, postprocessingFunctionNames: postprocessing, expectations, format, resultingParameterName, } = task;
2288
- pipelineString += '\n\n';
2289
- pipelineString += `## ${title}`;
2290
- if (description) {
2291
- pipelineString += '\n\n';
2292
- pipelineString += description;
2293
- }
2294
1856
  const commands = [];
2295
1857
  let contentLanguage = 'text';
2296
1858
  if (taskType === 'PROMPT_TASK') {
@@ -2353,18 +1915,23 @@ function pipelineJsonToString(pipelineJson) {
2353
1915
  commands.push(`FORMAT JSON`);
2354
1916
  }
2355
1917
  } /* not else */
2356
- pipelineString += '\n\n';
2357
- pipelineString += commands.map((command) => `- ${command}`).join('\n');
2358
- pipelineString += '\n\n';
2359
- pipelineString += '```' + contentLanguage;
2360
- pipelineString += '\n';
2361
- pipelineString += spaceTrim$1(content);
2362
- // <- TODO: [main] !!3 Escape
2363
- // <- TODO: [🧠] Some clear strategy how to spaceTrim the blocks
2364
- pipelineString += '\n';
2365
- pipelineString += '```';
2366
- pipelineString += '\n\n';
2367
- pipelineString += `\`-> {${resultingParameterName}}\``; // <- TODO: [main] !!3 If the parameter here has description, add it and use taskParameterJsonToString
1918
+ pipelineString = spaceTrim$1((block) => `
1919
+ ${block(pipelineString)}
1920
+
1921
+ ## ${title}
1922
+
1923
+ ${block(description || '')}
1924
+
1925
+ ${block(commands.map((command) => `- ${command}`).join('\n'))}
1926
+
1927
+ \`\`\`${contentLanguage}
1928
+ ${block(spaceTrim$1(content))}
1929
+ \`\`\`
1930
+
1931
+ \`-> {${resultingParameterName}}\`
1932
+ `); // <- TODO: [main] !!3 If the parameter here has description, add it and use taskParameterJsonToString
1933
+ // <- TODO: [main] !!3 Escape
1934
+ // <- TODO: [🧠] Some clear strategy how to spaceTrim the blocks
2368
1935
  }
2369
1936
  return validatePipelineString(pipelineString);
2370
1937
  }
@@ -4648,95 +4215,412 @@ const $scrapersMetadataRegister = new $Register('scrapers_metadata');
4648
4215
  *
4649
4216
  * @singleton Only one instance of each register is created per build, but there can be more than one in different build modules
4650
4217
  *
4651
- * @public exported from `@promptbook/core`
4218
+ * @public exported from `@promptbook/core`
4219
+ */
4220
+ const $scrapersRegister = new $Register('scraper_constructors');
4221
+ // TODO: [®] DRY Register logic
4222
+
4223
+ /**
4224
+ * Creates a message with all registered scrapers
4225
+ *
4226
+ * Note: This function is used to create a (error) message when there is no scraper for particular mime type
4227
+ *
4228
+ * @private internal function of `createScrapersFromConfiguration` and `createScrapersFromEnv`
4229
+ */
4230
+ function $registeredScrapersMessage(availableScrapers) {
4231
+ /**
4232
+ * Mixes registered scrapers from $scrapersMetadataRegister and $scrapersRegister
4233
+ */
4234
+ const all = [];
4235
+ for (const { packageName, className, mimeTypes, documentationUrl, isAvailableInBrowser, } of $scrapersMetadataRegister.list()) {
4236
+ if (all.some((item) => item.packageName === packageName && item.className === className)) {
4237
+ continue;
4238
+ }
4239
+ all.push({ packageName, className, mimeTypes, documentationUrl, isAvailableInBrowser });
4240
+ }
4241
+ for (const { packageName, className, mimeTypes, documentationUrl, isAvailableInBrowser, } of $scrapersRegister.list()) {
4242
+ if (all.some((item) => item.packageName === packageName && item.className === className)) {
4243
+ continue;
4244
+ }
4245
+ all.push({ packageName, className, mimeTypes, documentationUrl, isAvailableInBrowser });
4246
+ }
4247
+ for (const { metadata } of availableScrapers) {
4248
+ all.push(metadata);
4249
+ }
4250
+ const metadata = all.map((metadata) => {
4251
+ const isMetadataAviailable = $scrapersMetadataRegister
4252
+ .list()
4253
+ .find(({ packageName, className }) => metadata.packageName === packageName && metadata.className === className);
4254
+ const isInstalled = $scrapersRegister
4255
+ .list()
4256
+ .find(({ packageName, className }) => metadata.packageName === packageName && metadata.className === className);
4257
+ const isAvailableInTools = availableScrapers.some(({ metadata: { packageName, className } }) => metadata.packageName === packageName && metadata.className === className);
4258
+ return { ...metadata, isMetadataAviailable, isInstalled, isAvailableInTools };
4259
+ });
4260
+ if (metadata.length === 0) {
4261
+ return spaceTrim$1(`
4262
+ **No scrapers are available**
4263
+
4264
+ This is a unexpected behavior, you are probably using some broken version of Promptbook
4265
+ At least there should be available the metadata of the scrapers
4266
+ `);
4267
+ }
4268
+ return spaceTrim$1((block) => `
4269
+ Available scrapers are:
4270
+ ${block(metadata
4271
+ .map(({ packageName, className, isMetadataAviailable, isInstalled, mimeTypes, isAvailableInBrowser, isAvailableInTools, }, i) => {
4272
+ const more = [];
4273
+ // TODO: [🧠] Maybe use `documentationUrl`
4274
+ if (isMetadataAviailable) {
4275
+ more.push(`⬜ Metadata registered`);
4276
+ } // not else
4277
+ if (isInstalled) {
4278
+ more.push(`🟩 Installed`);
4279
+ } // not else
4280
+ if (isAvailableInTools) {
4281
+ more.push(`🟦 Available in tools`);
4282
+ } // not else
4283
+ if (!isMetadataAviailable && isInstalled) {
4284
+ more.push(`When no metadata registered but scraper is installed, it is an unexpected behavior`);
4285
+ } // not else
4286
+ if (!isInstalled && isAvailableInTools) {
4287
+ more.push(`When the scraper is not installed but available in tools, it is an unexpected compatibility behavior`);
4288
+ } // not else
4289
+ if (!isAvailableInBrowser) {
4290
+ more.push(`Not usable in browser`);
4291
+ }
4292
+ const moreText = more.length === 0 ? '' : ` *(${more.join('; ')})*`;
4293
+ return `${i + 1}) \`${className}\` from \`${packageName}\` compatible to scrape ${mimeTypes
4294
+ .map((mimeType) => `"${mimeType}"`)
4295
+ .join(', ')}${moreText}`;
4296
+ })
4297
+ .join('\n'))}
4298
+
4299
+ Legend:
4300
+ - ⬜ **Metadata registered** means that Promptbook knows about the scraper, it is similar to registration in some registry
4301
+ - 🟩 **Installed** means that you have imported package with particular scraper
4302
+ - 🟦 **Available in tools** means that you have passed scraper as dependency into prepare or execution process
4303
+
4304
+ `);
4305
+ }
4306
+ // TODO: [®] DRY Register logic
4307
+
4308
+ /**
4309
+ * Collection of default diacritics removal map.
4310
+ */
4311
+ const defaultDiacriticsRemovalMap = [
4312
+ {
4313
+ base: 'A',
4314
+ letters: '\u0041\u24B6\uFF21\u00C0\u00C1\u00C2\u1EA6\u1EA4\u1EAA\u1EA8\u00C3\u0100\u0102\u1EB0\u1EAE\u1EB4\u1EB2\u0226\u01E0\u00C4\u01DE\u1EA2\u00C5\u01FA\u01CD\u0200\u0202\u1EA0\u1EAC\u1EB6\u1E00\u0104\u023A\u2C6F',
4315
+ },
4316
+ { base: 'AA', letters: '\uA732' },
4317
+ { base: 'AE', letters: '\u00C6\u01FC\u01E2' },
4318
+ { base: 'AO', letters: '\uA734' },
4319
+ { base: 'AU', letters: '\uA736' },
4320
+ { base: 'AV', letters: '\uA738\uA73A' },
4321
+ { base: 'AY', letters: '\uA73C' },
4322
+ {
4323
+ base: 'B',
4324
+ letters: '\u0042\u24B7\uFF22\u1E02\u1E04\u1E06\u0243\u0182\u0181',
4325
+ },
4326
+ {
4327
+ base: 'C',
4328
+ letters: '\u0043\u24B8\uFF23\u0106\u0108\u010A\u010C\u00C7\u1E08\u0187\u023B\uA73E',
4329
+ },
4330
+ {
4331
+ base: 'D',
4332
+ letters: '\u0044\u24B9\uFF24\u1E0A\u010E\u1E0C\u1E10\u1E12\u1E0E\u0110\u018B\u018A\u0189\uA779\u00D0',
4333
+ },
4334
+ { base: 'DZ', letters: '\u01F1\u01C4' },
4335
+ { base: 'Dz', letters: '\u01F2\u01C5' },
4336
+ {
4337
+ base: 'E',
4338
+ letters: '\u0045\u24BA\uFF25\u00C8\u00C9\u00CA\u1EC0\u1EBE\u1EC4\u1EC2\u1EBC\u0112\u1E14\u1E16\u0114\u0116\u00CB\u1EBA\u011A\u0204\u0206\u1EB8\u1EC6\u0228\u1E1C\u0118\u1E18\u1E1A\u0190\u018E',
4339
+ },
4340
+ { base: 'F', letters: '\u0046\u24BB\uFF26\u1E1E\u0191\uA77B' },
4341
+ {
4342
+ base: 'G',
4343
+ letters: '\u0047\u24BC\uFF27\u01F4\u011C\u1E20\u011E\u0120\u01E6\u0122\u01E4\u0193\uA7A0\uA77D\uA77E',
4344
+ },
4345
+ {
4346
+ base: 'H',
4347
+ letters: '\u0048\u24BD\uFF28\u0124\u1E22\u1E26\u021E\u1E24\u1E28\u1E2A\u0126\u2C67\u2C75\uA78D',
4348
+ },
4349
+ {
4350
+ base: 'I',
4351
+ letters: '\u0049\u24BE\uFF29\u00CC\u00CD\u00CE\u0128\u012A\u012C\u0130\u00CF\u1E2E\u1EC8\u01CF\u0208\u020A\u1ECA\u012E\u1E2C\u0197',
4352
+ },
4353
+ { base: 'J', letters: '\u004A\u24BF\uFF2A\u0134\u0248' },
4354
+ {
4355
+ base: 'K',
4356
+ letters: '\u004B\u24C0\uFF2B\u1E30\u01E8\u1E32\u0136\u1E34\u0198\u2C69\uA740\uA742\uA744\uA7A2',
4357
+ },
4358
+ {
4359
+ base: 'L',
4360
+ letters: '\u004C\u24C1\uFF2C\u013F\u0139\u013D\u1E36\u1E38\u013B\u1E3C\u1E3A\u0141\u023D\u2C62\u2C60\uA748\uA746\uA780',
4361
+ },
4362
+ { base: 'LJ', letters: '\u01C7' },
4363
+ { base: 'Lj', letters: '\u01C8' },
4364
+ { base: 'M', letters: '\u004D\u24C2\uFF2D\u1E3E\u1E40\u1E42\u2C6E\u019C' },
4365
+ {
4366
+ base: 'N',
4367
+ letters: '\u004E\u24C3\uFF2E\u01F8\u0143\u00D1\u1E44\u0147\u1E46\u0145\u1E4A\u1E48\u0220\u019D\uA790\uA7A4',
4368
+ },
4369
+ { base: 'NJ', letters: '\u01CA' },
4370
+ { base: 'Nj', letters: '\u01CB' },
4371
+ {
4372
+ base: 'O',
4373
+ letters: '\u004F\u24C4\uFF2F\u00D2\u00D3\u00D4\u1ED2\u1ED0\u1ED6\u1ED4\u00D5\u1E4C\u022C\u1E4E\u014C\u1E50\u1E52\u014E\u022E\u0230\u00D6\u022A\u1ECE\u0150\u01D1\u020C\u020E\u01A0\u1EDC\u1EDA\u1EE0\u1EDE\u1EE2\u1ECC\u1ED8\u01EA\u01EC\u00D8\u01FE\u0186\u019F\uA74A\uA74C',
4374
+ },
4375
+ { base: 'OI', letters: '\u01A2' },
4376
+ { base: 'OO', letters: '\uA74E' },
4377
+ { base: 'OU', letters: '\u0222' },
4378
+ { base: 'OE', letters: '\u008C\u0152' },
4379
+ { base: 'oe', letters: '\u009C\u0153' },
4380
+ {
4381
+ base: 'P',
4382
+ letters: '\u0050\u24C5\uFF30\u1E54\u1E56\u01A4\u2C63\uA750\uA752\uA754',
4383
+ },
4384
+ { base: 'Q', letters: '\u0051\u24C6\uFF31\uA756\uA758\u024A' },
4385
+ {
4386
+ base: 'R',
4387
+ letters: '\u0052\u24C7\uFF32\u0154\u1E58\u0158\u0210\u0212\u1E5A\u1E5C\u0156\u1E5E\u024C\u2C64\uA75A\uA7A6\uA782',
4388
+ },
4389
+ {
4390
+ base: 'S',
4391
+ letters: '\u0053\u24C8\uFF33\u1E9E\u015A\u1E64\u015C\u1E60\u0160\u1E66\u1E62\u1E68\u0218\u015E\u2C7E\uA7A8\uA784',
4392
+ },
4393
+ {
4394
+ base: 'T',
4395
+ letters: '\u0054\u24C9\uFF34\u1E6A\u0164\u1E6C\u021A\u0162\u1E70\u1E6E\u0166\u01AC\u01AE\u023E\uA786',
4396
+ },
4397
+ { base: 'TZ', letters: '\uA728' },
4398
+ {
4399
+ base: 'U',
4400
+ letters: '\u0055\u24CA\uFF35\u00D9\u00DA\u00DB\u0168\u1E78\u016A\u1E7A\u016C\u00DC\u01DB\u01D7\u01D5\u01D9\u1EE6\u016E\u0170\u01D3\u0214\u0216\u01AF\u1EEA\u1EE8\u1EEE\u1EEC\u1EF0\u1EE4\u1E72\u0172\u1E76\u1E74\u0244',
4401
+ },
4402
+ { base: 'V', letters: '\u0056\u24CB\uFF36\u1E7C\u1E7E\u01B2\uA75E\u0245' },
4403
+ { base: 'VY', letters: '\uA760' },
4404
+ {
4405
+ base: 'W',
4406
+ letters: '\u0057\u24CC\uFF37\u1E80\u1E82\u0174\u1E86\u1E84\u1E88\u2C72',
4407
+ },
4408
+ { base: 'X', letters: '\u0058\u24CD\uFF38\u1E8A\u1E8C' },
4409
+ {
4410
+ base: 'Y',
4411
+ letters: '\u0059\u24CE\uFF39\u1EF2\u00DD\u0176\u1EF8\u0232\u1E8E\u0178\u1EF6\u1EF4\u01B3\u024E\u1EFE',
4412
+ },
4413
+ {
4414
+ base: 'Z',
4415
+ letters: '\u005A\u24CF\uFF3A\u0179\u1E90\u017B\u017D\u1E92\u1E94\u01B5\u0224\u2C7F\u2C6B\uA762',
4416
+ },
4417
+ {
4418
+ base: 'a',
4419
+ letters: '\u0061\u24D0\uFF41\u1E9A\u00E0\u00E1\u00E2\u1EA7\u1EA5\u1EAB\u1EA9\u00E3\u0101\u0103\u1EB1\u1EAF\u1EB5\u1EB3\u0227\u01E1\u00E4\u01DF\u1EA3\u00E5\u01FB\u01CE\u0201\u0203\u1EA1\u1EAD\u1EB7\u1E01\u0105\u2C65\u0250',
4420
+ },
4421
+ { base: 'aa', letters: '\uA733' },
4422
+ { base: 'ae', letters: '\u00E6\u01FD\u01E3' },
4423
+ { base: 'ao', letters: '\uA735' },
4424
+ { base: 'au', letters: '\uA737' },
4425
+ { base: 'av', letters: '\uA739\uA73B' },
4426
+ { base: 'ay', letters: '\uA73D' },
4427
+ {
4428
+ base: 'b',
4429
+ letters: '\u0062\u24D1\uFF42\u1E03\u1E05\u1E07\u0180\u0183\u0253',
4430
+ },
4431
+ {
4432
+ base: 'c',
4433
+ letters: '\u0063\u24D2\uFF43\u0107\u0109\u010B\u010D\u00E7\u1E09\u0188\u023C\uA73F\u2184',
4434
+ },
4435
+ {
4436
+ base: 'd',
4437
+ letters: '\u0064\u24D3\uFF44\u1E0B\u010F\u1E0D\u1E11\u1E13\u1E0F\u0111\u018C\u0256\u0257\uA77A',
4438
+ },
4439
+ { base: 'dz', letters: '\u01F3\u01C6' },
4440
+ {
4441
+ base: 'e',
4442
+ letters: '\u0065\u24D4\uFF45\u00E8\u00E9\u00EA\u1EC1\u1EBF\u1EC5\u1EC3\u1EBD\u0113\u1E15\u1E17\u0115\u0117\u00EB\u1EBB\u011B\u0205\u0207\u1EB9\u1EC7\u0229\u1E1D\u0119\u1E19\u1E1B\u0247\u025B\u01DD',
4443
+ },
4444
+ { base: 'f', letters: '\u0066\u24D5\uFF46\u1E1F\u0192\uA77C' },
4445
+ {
4446
+ base: 'g',
4447
+ letters: '\u0067\u24D6\uFF47\u01F5\u011D\u1E21\u011F\u0121\u01E7\u0123\u01E5\u0260\uA7A1\u1D79\uA77F',
4448
+ },
4449
+ {
4450
+ base: 'h',
4451
+ letters: '\u0068\u24D7\uFF48\u0125\u1E23\u1E27\u021F\u1E25\u1E29\u1E2B\u1E96\u0127\u2C68\u2C76\u0265',
4452
+ },
4453
+ { base: 'hv', letters: '\u0195' },
4454
+ {
4455
+ base: 'i',
4456
+ letters: '\u0069\u24D8\uFF49\u00EC\u00ED\u00EE\u0129\u012B\u012D\u00EF\u1E2F\u1EC9\u01D0\u0209\u020B\u1ECB\u012F\u1E2D\u0268\u0131',
4457
+ },
4458
+ { base: 'j', letters: '\u006A\u24D9\uFF4A\u0135\u01F0\u0249' },
4459
+ {
4460
+ base: 'k',
4461
+ letters: '\u006B\u24DA\uFF4B\u1E31\u01E9\u1E33\u0137\u1E35\u0199\u2C6A\uA741\uA743\uA745\uA7A3',
4462
+ },
4463
+ {
4464
+ base: 'l',
4465
+ letters: '\u006C\u24DB\uFF4C\u0140\u013A\u013E\u1E37\u1E39\u013C\u1E3D\u1E3B\u017F\u0142\u019A\u026B\u2C61\uA749\uA781\uA747',
4466
+ },
4467
+ { base: 'lj', letters: '\u01C9' },
4468
+ { base: 'm', letters: '\u006D\u24DC\uFF4D\u1E3F\u1E41\u1E43\u0271\u026F' },
4469
+ {
4470
+ base: 'n',
4471
+ letters: '\u006E\u24DD\uFF4E\u01F9\u0144\u00F1\u1E45\u0148\u1E47\u0146\u1E4B\u1E49\u019E\u0272\u0149\uA791\uA7A5',
4472
+ },
4473
+ { base: 'nj', letters: '\u01CC' },
4474
+ {
4475
+ base: 'o',
4476
+ letters: '\u006F\u24DE\uFF4F\u00F2\u00F3\u00F4\u1ED3\u1ED1\u1ED7\u1ED5\u00F5\u1E4D\u022D\u1E4F\u014D\u1E51\u1E53\u014F\u022F\u0231\u00F6\u022B\u1ECF\u0151\u01D2\u020D\u020F\u01A1\u1EDD\u1EDB\u1EE1\u1EDF\u1EE3\u1ECD\u1ED9\u01EB\u01ED\u00F8\u01FF\u0254\uA74B\uA74D\u0275',
4477
+ },
4478
+ { base: 'oi', letters: '\u01A3' },
4479
+ { base: 'ou', letters: '\u0223' },
4480
+ { base: 'oo', letters: '\uA74F' },
4481
+ {
4482
+ base: 'p',
4483
+ letters: '\u0070\u24DF\uFF50\u1E55\u1E57\u01A5\u1D7D\uA751\uA753\uA755',
4484
+ },
4485
+ { base: 'q', letters: '\u0071\u24E0\uFF51\u024B\uA757\uA759' },
4486
+ {
4487
+ base: 'r',
4488
+ letters: '\u0072\u24E1\uFF52\u0155\u1E59\u0159\u0211\u0213\u1E5B\u1E5D\u0157\u1E5F\u024D\u027D\uA75B\uA7A7\uA783',
4489
+ },
4490
+ {
4491
+ base: 's',
4492
+ letters: '\u0073\u24E2\uFF53\u00DF\u015B\u1E65\u015D\u1E61\u0161\u1E67\u1E63\u1E69\u0219\u015F\u023F\uA7A9\uA785\u1E9B',
4493
+ },
4494
+ {
4495
+ base: 't',
4496
+ letters: '\u0074\u24E3\uFF54\u1E6B\u1E97\u0165\u1E6D\u021B\u0163\u1E71\u1E6F\u0167\u01AD\u0288\u2C66\uA787',
4497
+ },
4498
+ { base: 'tz', letters: '\uA729' },
4499
+ {
4500
+ base: 'u',
4501
+ letters: '\u0075\u24E4\uFF55\u00F9\u00FA\u00FB\u0169\u1E79\u016B\u1E7B\u016D\u00FC\u01DC\u01D8\u01D6\u01DA\u1EE7\u016F\u0171\u01D4\u0215\u0217\u01B0\u1EEB\u1EE9\u1EEF\u1EED\u1EF1\u1EE5\u1E73\u0173\u1E77\u1E75\u0289',
4502
+ },
4503
+ { base: 'v', letters: '\u0076\u24E5\uFF56\u1E7D\u1E7F\u028B\uA75F\u028C' },
4504
+ { base: 'vy', letters: '\uA761' },
4505
+ {
4506
+ base: 'w',
4507
+ letters: '\u0077\u24E6\uFF57\u1E81\u1E83\u0175\u1E87\u1E85\u1E98\u1E89\u2C73',
4508
+ },
4509
+ { base: 'x', letters: '\u0078\u24E7\uFF58\u1E8B\u1E8D' },
4510
+ {
4511
+ base: 'y',
4512
+ letters: '\u0079\u24E8\uFF59\u1EF3\u00FD\u0177\u1EF9\u0233\u1E8F\u00FF\u1EF7\u1E99\u1EF5\u01B4\u024F\u1EFF',
4513
+ },
4514
+ {
4515
+ base: 'z',
4516
+ letters: '\u007A\u24E9\uFF5A\u017A\u1E91\u017C\u017E\u1E93\u1E95\u01B6\u0225\u0240\u2C6C\uA763',
4517
+ },
4518
+ ];
4519
+ /**
4520
+ * Map of letters from diacritic variant to diacritless variant
4521
+ * Contains lowercase and uppercase separatelly
4522
+ *
4523
+ * > "á" => "a"
4524
+ * > "ě" => "e"
4525
+ * > "Ă" => "A"
4526
+ * > ...
4527
+ *
4528
+ * @public exported from `@promptbook/utils`
4529
+ */
4530
+ const DIACRITIC_VARIANTS_LETTERS = {};
4531
+ // tslint:disable-next-line: prefer-for-of
4532
+ for (let i = 0; i < defaultDiacriticsRemovalMap.length; i++) {
4533
+ const letters = defaultDiacriticsRemovalMap[i].letters;
4534
+ // tslint:disable-next-line: prefer-for-of
4535
+ for (let j = 0; j < letters.length; j++) {
4536
+ DIACRITIC_VARIANTS_LETTERS[letters[j]] = defaultDiacriticsRemovalMap[i].base;
4537
+ }
4538
+ }
4539
+ // <- TODO: [🍓] Put to maker function to save execution time if not needed
4540
+ /*
4541
+ @see https://stackoverflow.com/questions/990904/remove-accents-diacritics-in-a-string-in-javascript
4542
+ Licensed under the Apache License, Version 2.0 (the "License");
4543
+ you may not use this file except in compliance with the License.
4544
+ You may obtain a copy of the License at
4545
+
4546
+ http://www.apache.org/licenses/LICENSE-2.0
4547
+
4548
+ Unless required by applicable law or agreed to in writing, software
4549
+ distributed under the License is distributed on an "AS IS" BASIS,
4550
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
4551
+ See the License for the specific language governing permissions and
4552
+ limitations under the License.
4553
+ */
4554
+
4555
+ /**
4556
+ * Removes diacritic marks (accents) from characters in a string.
4557
+ *
4558
+ * Note: [🔂] This function is idempotent.
4559
+ *
4560
+ * @param input The string containing diacritics to be normalized.
4561
+ * @returns The string with diacritics removed or normalized.
4562
+ *
4563
+ * @public exported from `@promptbook/utils`
4652
4564
  */
4653
- const $scrapersRegister = new $Register('scraper_constructors');
4654
- // TODO: [®] DRY Register logic
4565
+ function removeDiacritics(input) {
4566
+ /*eslint no-control-regex: "off"*/
4567
+ return input.replace(/[^\u0000-\u007E]/g, (character) => {
4568
+ return DIACRITIC_VARIANTS_LETTERS[character] || character;
4569
+ });
4570
+ }
4571
+ // TODO: [Ж] Variant for cyrillic (and in general non-latin) letters
4655
4572
 
4656
4573
  /**
4657
- * Creates a message with all registered scrapers
4574
+ * Converts a given text to kebab-case format.
4658
4575
  *
4659
- * Note: This function is used to create a (error) message when there is no scraper for particular mime type
4576
+ * Note: [🔂] This function is idempotent.
4660
4577
  *
4661
- * @private internal function of `createScrapersFromConfiguration` and `createScrapersFromEnv`
4578
+ * @param text The text to be converted.
4579
+ * @returns The kebab-case formatted string.
4580
+ * @example 'hello-world'
4581
+ * @example 'i-love-promptbook'
4582
+ *
4583
+ * @public exported from `@promptbook/utils`
4662
4584
  */
4663
- function $registeredScrapersMessage(availableScrapers) {
4664
- /**
4665
- * Mixes registered scrapers from $scrapersMetadataRegister and $scrapersRegister
4666
- */
4667
- const all = [];
4668
- for (const { packageName, className, mimeTypes, documentationUrl, isAvailableInBrowser, } of $scrapersMetadataRegister.list()) {
4669
- if (all.some((item) => item.packageName === packageName && item.className === className)) {
4670
- continue;
4585
+ function normalizeToKebabCase(text) {
4586
+ text = removeDiacritics(text);
4587
+ let charType;
4588
+ let lastCharType = 'OTHER';
4589
+ let normalizedName = '';
4590
+ for (const char of text) {
4591
+ let normalizedChar;
4592
+ if (/^[a-z]$/.test(char)) {
4593
+ charType = 'LOWERCASE';
4594
+ normalizedChar = char;
4671
4595
  }
4672
- all.push({ packageName, className, mimeTypes, documentationUrl, isAvailableInBrowser });
4673
- }
4674
- for (const { packageName, className, mimeTypes, documentationUrl, isAvailableInBrowser, } of $scrapersRegister.list()) {
4675
- if (all.some((item) => item.packageName === packageName && item.className === className)) {
4676
- continue;
4596
+ else if (/^[A-Z]$/.test(char)) {
4597
+ charType = 'UPPERCASE';
4598
+ normalizedChar = char.toLowerCase();
4677
4599
  }
4678
- all.push({ packageName, className, mimeTypes, documentationUrl, isAvailableInBrowser });
4679
- }
4680
- for (const { metadata } of availableScrapers) {
4681
- all.push(metadata);
4682
- }
4683
- const metadata = all.map((metadata) => {
4684
- const isMetadataAviailable = $scrapersMetadataRegister
4685
- .list()
4686
- .find(({ packageName, className }) => metadata.packageName === packageName && metadata.className === className);
4687
- const isInstalled = $scrapersRegister
4688
- .list()
4689
- .find(({ packageName, className }) => metadata.packageName === packageName && metadata.className === className);
4690
- const isAvailableInTools = availableScrapers.some(({ metadata: { packageName, className } }) => metadata.packageName === packageName && metadata.className === className);
4691
- return { ...metadata, isMetadataAviailable, isInstalled, isAvailableInTools };
4692
- });
4693
- if (metadata.length === 0) {
4694
- return spaceTrim$1(`
4695
- **No scrapers are available**
4696
-
4697
- This is a unexpected behavior, you are probably using some broken version of Promptbook
4698
- At least there should be available the metadata of the scrapers
4699
- `);
4700
- }
4701
- return spaceTrim$1((block) => `
4702
- Available scrapers are:
4703
- ${block(metadata
4704
- .map(({ packageName, className, isMetadataAviailable, isInstalled, mimeTypes, isAvailableInBrowser, isAvailableInTools, }, i) => {
4705
- const more = [];
4706
- // TODO: [🧠] Maybe use `documentationUrl`
4707
- if (isMetadataAviailable) {
4708
- more.push(`⬜ Metadata registered`);
4709
- } // not else
4710
- if (isInstalled) {
4711
- more.push(`🟩 Installed`);
4712
- } // not else
4713
- if (isAvailableInTools) {
4714
- more.push(`🟦 Available in tools`);
4715
- } // not else
4716
- if (!isMetadataAviailable && isInstalled) {
4717
- more.push(`When no metadata registered but scraper is installed, it is an unexpected behavior`);
4718
- } // not else
4719
- if (!isInstalled && isAvailableInTools) {
4720
- more.push(`When the scraper is not installed but available in tools, it is an unexpected compatibility behavior`);
4721
- } // not else
4722
- if (!isAvailableInBrowser) {
4723
- more.push(`Not usable in browser`);
4600
+ else if (/^[0-9]$/.test(char)) {
4601
+ charType = 'NUMBER';
4602
+ normalizedChar = char;
4724
4603
  }
4725
- const moreText = more.length === 0 ? '' : ` *(${more.join('; ')})*`;
4726
- return `${i + 1}) \`${className}\` from \`${packageName}\` compatible to scrape ${mimeTypes
4727
- .map((mimeType) => `"${mimeType}"`)
4728
- .join(', ')}${moreText}`;
4729
- })
4730
- .join('\n'))}
4731
-
4732
- Legend:
4733
- - **Metadata registered** means that Promptbook knows about the scraper, it is similar to registration in some registry
4734
- - 🟩 **Installed** means that you have imported package with particular scraper
4735
- - 🟦 **Available in tools** means that you have passed scraper as dependency into prepare or execution process
4736
-
4737
- `);
4604
+ else {
4605
+ charType = 'OTHER';
4606
+ normalizedChar = '-';
4607
+ }
4608
+ if (charType !== lastCharType &&
4609
+ !(lastCharType === 'UPPERCASE' && charType === 'LOWERCASE') &&
4610
+ !(lastCharType === 'NUMBER') &&
4611
+ !(charType === 'NUMBER')) {
4612
+ normalizedName += '-';
4613
+ }
4614
+ normalizedName += normalizedChar;
4615
+ lastCharType = charType;
4616
+ }
4617
+ normalizedName = normalizedName.split(/-+/g).join('-');
4618
+ normalizedName = normalizedName.split(/-?\/-?/g).join('/');
4619
+ normalizedName = normalizedName.replace(/^-/, '');
4620
+ normalizedName = normalizedName.replace(/-$/, '');
4621
+ return normalizedName;
4738
4622
  }
4739
- // TODO: [®] DRY Register logic
4623
+ // Note: [💞] Ignore a discrepancy between file name and entity name
4740
4624
 
4741
4625
  /**
4742
4626
  * Creates unique name for the source
@@ -4757,6 +4641,16 @@ function knowledgeSourceContentToName(knowledgeSourceContent) {
4757
4641
  }
4758
4642
  // TODO: [🐱‍🐉][🧠] Make some smart crop NOT source-i-m-pavol-a-develop-... BUT source-i-m-pavol-a-developer-...
4759
4643
 
4644
+ /**
4645
+ * Converts a name to a properly formatted subfolder path for cache storage.
4646
+ * Handles normalization and path formatting to create consistent cache directory structures.
4647
+ *
4648
+ * @private for `FileCacheStorage`
4649
+ */
4650
+ function nameToSubfolderPath(name) {
4651
+ return [name.substr(0, 1).toLowerCase(), name.substr(1, 1).toLowerCase()];
4652
+ }
4653
+
4760
4654
  /**
4761
4655
  * Convert file extension to mime type
4762
4656
  *
@@ -4777,6 +4671,52 @@ function mimeTypeToExtension(value) {
4777
4671
  return extension(value) || null;
4778
4672
  }
4779
4673
 
4674
+ /**
4675
+ * Removes emojis from a string and fix whitespaces
4676
+ *
4677
+ * Note: [🔂] This function is idempotent.
4678
+ *
4679
+ * @param text with emojis
4680
+ * @returns text without emojis
4681
+ *
4682
+ * @public exported from `@promptbook/utils`
4683
+ */
4684
+ function removeEmojis(text) {
4685
+ // Replace emojis (and also ZWJ sequence) with hyphens
4686
+ text = text.replace(/(\p{Extended_Pictographic})\p{Modifier_Symbol}/gu, '$1');
4687
+ text = text.replace(/(\p{Extended_Pictographic})[\u{FE00}-\u{FE0F}]/gu, '$1');
4688
+ text = text.replace(/(\p{Extended_Pictographic})(\u{200D}\p{Extended_Pictographic})*/gu, '$1');
4689
+ text = text.replace(/\p{Extended_Pictographic}/gu, '');
4690
+ return text;
4691
+ }
4692
+
4693
+ /**
4694
+ * Converts a title string into a normalized name.
4695
+ *
4696
+ * Note: [🔂] This function is idempotent.
4697
+ *
4698
+ * @param value The title string to be converted to a name.
4699
+ * @returns A normalized name derived from the input title.
4700
+ * @example 'Hello World!' -> 'hello-world'
4701
+ *
4702
+ * @public exported from `@promptbook/utils`
4703
+ */
4704
+ function titleToName(value) {
4705
+ if (isValidUrl(value)) {
4706
+ value = value.replace(/^https?:\/\//, '');
4707
+ value = value.replace(/\.html$/, '');
4708
+ }
4709
+ else if (isValidFilePath(value)) {
4710
+ value = basename(value);
4711
+ // Note: Keeping extension in the name
4712
+ }
4713
+ value = value.split('/').join('-');
4714
+ value = removeEmojis(value);
4715
+ value = normalizeToKebabCase(value);
4716
+ // TODO: [🧠] Maybe warn or add some padding to short name which are not good identifiers
4717
+ return value;
4718
+ }
4719
+
4780
4720
  /**
4781
4721
  * The built-in `fetch' function with a lightweight error handling wrapper as default fetch function used in Promptbook scrapers
4782
4722
  *
@@ -7888,6 +7828,74 @@ class MarkdownScraper {
7888
7828
  // TODO: [🪂] Do it in parallel 11:11
7889
7829
  // Note: No need to aggregate usage here, it is done by intercepting the llmTools
7890
7830
 
7831
+ /**
7832
+ * Retrieves an intermediate source for a scraper based on the knowledge source.
7833
+ * Manages the caching and retrieval of intermediate scraper results for optimized performance.
7834
+ *
7835
+ * @private as internal utility for scrapers
7836
+ */
7837
+ async function getScraperIntermediateSource(source, options) {
7838
+ const { filename: sourceFilename, url } = source;
7839
+ const { rootDirname, cacheDirname, intermediateFilesStrategy, extension, isVerbose } = options;
7840
+ // TODO: [👬] DRY
7841
+ const hash = SHA256(
7842
+ // <- TODO: [🥬] Encapsulate sha256 to some private utility function
7843
+ hexEncoder.parse(sourceFilename || url || 'untitled'))
7844
+ .toString( /* hex */)
7845
+ .substring(0, 20);
7846
+ // <- TODO: [🥬] Make some system for hashes and ids of promptbook
7847
+ const semanticName = normalizeToKebabCase(titleToName((sourceFilename || url || '').split('intermediate').join(''))).substring(0, 20);
7848
+ // <- TODO: [🐱‍🐉]
7849
+ const pieces = ['intermediate', semanticName, hash].filter((piece) => piece !== '');
7850
+ const name = pieces.join('-').split('--').join('-');
7851
+ const cacheFilename = join(process.cwd(), cacheDirname, ...nameToSubfolderPath(hash /* <- TODO: [🎎] Maybe add some SHA256 prefix */), name)
7852
+ .split('\\')
7853
+ .join('/') +
7854
+ '.' +
7855
+ extension;
7856
+ // Note: Try to create cache directory, but don't fail if filesystem has issues
7857
+ try {
7858
+ await mkdir(dirname(cacheFilename), { recursive: true });
7859
+ }
7860
+ catch (error) {
7861
+ // Note: If we can't create cache directory, continue without it
7862
+ // This handles read-only filesystems, permission issues, and missing parent directories
7863
+ if (error instanceof Error &&
7864
+ (error.message.includes('EROFS') ||
7865
+ error.message.includes('read-only') ||
7866
+ error.message.includes('EACCES') ||
7867
+ error.message.includes('EPERM') ||
7868
+ error.message.includes('ENOENT'))) ;
7869
+ else {
7870
+ // Re-throw other unexpected errors
7871
+ throw error;
7872
+ }
7873
+ }
7874
+ let isDestroyed = true;
7875
+ const fileHandler = {
7876
+ filename: cacheFilename,
7877
+ get isDestroyed() {
7878
+ return isDestroyed;
7879
+ },
7880
+ async destroy() {
7881
+ if (intermediateFilesStrategy === 'HIDE_AND_CLEAN') {
7882
+ if (isVerbose) {
7883
+ console.info('legacyDocumentScraper: Clening cache');
7884
+ }
7885
+ await rm(cacheFilename);
7886
+ // TODO: [🐿][🧠] Maybe remove empty folders
7887
+ }
7888
+ isDestroyed = true;
7889
+ },
7890
+ };
7891
+ return fileHandler;
7892
+ }
7893
+ // 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
7894
+ // Note: Not using `FileCacheStorage` for two reasons:
7895
+ // 1. Need to store more than serialized JSONs.
7896
+ // 2. Need to switch between a `rootDirname` and `cacheDirname` <- TODO: [😡]
7897
+ // TODO: [🐱‍🐉][🧠] Make some smart crop
7898
+
7891
7899
  /**
7892
7900
  * Metadata of the scraper
7893
7901
  *