@promptbook/browser 0.72.0-2 → 0.72.0-26

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 (261) hide show
  1. package/README.md +11 -1
  2. package/esm/index.es.js +247 -6
  3. package/esm/index.es.js.map +1 -1
  4. package/esm/typings/src/_packages/browser.index.d.ts +3 -1
  5. package/esm/typings/src/_packages/cli.index.d.ts +20 -0
  6. package/esm/typings/src/_packages/core.index.d.ts +56 -28
  7. package/esm/typings/src/_packages/documents.index.d.ts +8 -0
  8. package/esm/typings/src/_packages/legacy-documents.index.d.ts +8 -0
  9. package/esm/typings/src/_packages/markdown-utils.index.d.ts +6 -0
  10. package/esm/typings/src/_packages/node.index.d.ts +18 -6
  11. package/esm/typings/src/_packages/pdf.index.d.ts +8 -0
  12. package/esm/typings/src/_packages/types.index.d.ts +57 -33
  13. package/esm/typings/src/_packages/utils.index.d.ts +2 -2
  14. package/esm/typings/src/_packages/website-crawler.index.d.ts +8 -0
  15. package/esm/typings/src/cli/cli-commands/about.d.ts +1 -1
  16. package/esm/typings/src/cli/cli-commands/hello.d.ts +2 -1
  17. package/esm/typings/src/cli/cli-commands/make.d.ts +1 -1
  18. package/esm/typings/src/cli/cli-commands/prettify.d.ts +2 -1
  19. package/esm/typings/src/cli/cli-commands/test-command.d.ts +13 -0
  20. package/esm/typings/src/cli/main.d.ts +1 -1
  21. package/esm/typings/src/cli/promptbookCli.d.ts +1 -1
  22. package/esm/typings/src/collection/PipelineCollection.d.ts +1 -1
  23. package/esm/typings/src/collection/SimplePipelineCollection.d.ts +2 -2
  24. package/esm/typings/src/collection/collectionToJson.d.ts +1 -1
  25. package/esm/typings/src/collection/constructors/createCollectionFromDirectory.d.ts +11 -6
  26. package/esm/typings/src/collection/constructors/createCollectionFromJson.d.ts +1 -1
  27. package/esm/typings/src/collection/constructors/createCollectionFromPromise.d.ts +1 -1
  28. package/esm/typings/src/collection/constructors/createCollectionFromUrl.d.ts +1 -1
  29. package/esm/typings/src/commands/EXPECT/expectCommandParser.d.ts +1 -1
  30. package/esm/typings/src/commands/FOREACH/ForeachJson.d.ts +5 -1
  31. package/esm/typings/src/commands/FOREACH/foreachCommandParser.d.ts +1 -1
  32. package/esm/typings/src/commands/FORMAT/formatCommandParser.d.ts +1 -1
  33. package/esm/typings/src/commands/JOKER/jokerCommandParser.d.ts +1 -1
  34. package/esm/typings/src/commands/KNOWLEDGE/knowledgeCommandParser.d.ts +1 -1
  35. package/esm/typings/src/commands/KNOWLEDGE/utils/sourceContentToName.d.ts +11 -0
  36. package/esm/typings/src/commands/KNOWLEDGE/utils/sourceContentToName.test.d.ts +4 -0
  37. package/esm/typings/src/commands/MODEL/modelCommandParser.d.ts +1 -1
  38. package/esm/typings/src/commands/PARAMETER/parameterCommandParser.d.ts +1 -1
  39. package/esm/typings/src/commands/PERSONA/personaCommandParser.d.ts +1 -1
  40. package/esm/typings/src/commands/POSTPROCESS/postprocessCommandParser.d.ts +1 -1
  41. package/esm/typings/src/commands/PROMPTBOOK_VERSION/promptbookVersionCommandParser.d.ts +1 -1
  42. package/esm/typings/src/commands/TEMPLATE/templateCommandParser.d.ts +1 -1
  43. package/esm/typings/src/commands/URL/urlCommandParser.d.ts +1 -1
  44. package/esm/typings/src/commands/X_ACTION/actionCommandParser.d.ts +1 -1
  45. package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommandParser.d.ts +1 -1
  46. package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts +1 -1
  47. package/esm/typings/src/commands/_common/types/CommandParser.d.ts +5 -5
  48. package/esm/typings/src/config.d.ts +35 -12
  49. package/esm/typings/src/conversion/pipelineStringToJson.d.ts +4 -15
  50. package/esm/typings/src/conversion/pipelineStringToJsonSync.d.ts +1 -1
  51. package/esm/typings/src/conversion/validation/_importPipeline.d.ts +1 -1
  52. package/esm/typings/src/conversion/validation/validatePipeline.d.ts +5 -5
  53. package/esm/typings/src/{knowledge/dialogs → dialogs}/callback/CallbackInterfaceTools.d.ts +2 -2
  54. package/esm/typings/src/{knowledge/dialogs → dialogs}/callback/CallbackInterfaceToolsOptions.d.ts +3 -3
  55. package/esm/typings/src/{knowledge/dialogs → dialogs}/simple-prompt/SimplePromptInterfaceTools.d.ts +6 -6
  56. package/esm/typings/src/errors/AbstractFormatError.d.ts +11 -0
  57. package/esm/typings/src/errors/KnowledgeScrapeError.d.ts +9 -0
  58. package/esm/typings/src/errors/MissingToolsError.d.ts +9 -0
  59. package/esm/typings/src/executables/$provideExecutablesForNode.d.ts +12 -0
  60. package/esm/typings/src/executables/apps/locateLibreoffice.d.ts +11 -0
  61. package/esm/typings/src/executables/apps/locatePandoc.d.ts +11 -0
  62. package/esm/typings/src/executables/locateApp.d.ts +33 -0
  63. package/esm/typings/src/executables/platforms/locateAppOnLinux.d.ts +12 -0
  64. package/esm/typings/src/executables/platforms/locateAppOnMacOs.d.ts +12 -0
  65. package/esm/typings/src/executables/platforms/locateAppOnWindows.d.ts +12 -0
  66. package/esm/typings/src/execution/{CommonExecutionToolsOptions.d.ts → CommonToolsOptions.d.ts} +1 -1
  67. package/esm/typings/src/execution/EmbeddingVector.d.ts +1 -1
  68. package/esm/typings/src/execution/Executables.d.ts +18 -0
  69. package/esm/typings/src/execution/ExecutionTools.d.ts +35 -9
  70. package/esm/typings/src/execution/FilesystemTools.d.ts +9 -0
  71. package/esm/typings/src/execution/LlmExecutionTools.d.ts +2 -2
  72. package/esm/typings/src/execution/PipelineExecutor.d.ts +1 -0
  73. package/esm/typings/src/execution/PipelineExecutorResult.d.ts +2 -2
  74. package/esm/typings/src/execution/assertsExecutionSuccessful.d.ts +3 -2
  75. package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorOptions.d.ts +31 -5
  76. package/esm/typings/src/execution/createPipelineExecutor/00-createPipelineExecutor.d.ts +3 -0
  77. package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts +6 -12
  78. package/esm/typings/src/execution/createPipelineExecutor/20-executeTemplate.d.ts +7 -18
  79. package/esm/typings/src/execution/createPipelineExecutor/{30-executeFormatCells.d.ts → 30-executeFormatSubvalues.d.ts} +2 -6
  80. package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +9 -19
  81. package/esm/typings/src/execution/embeddingVectorToString.d.ts +1 -1
  82. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/LindatAutomaticTranslator.d.ts +11 -3
  83. package/esm/typings/src/execution/translation/automatic-translate/translateMessages.d.ts +4 -0
  84. package/esm/typings/src/execution/utils/$provideExecutionToolsForNode.d.ts +13 -0
  85. package/esm/typings/src/execution/utils/addUsage.d.ts +1 -1
  86. package/esm/typings/src/execution/utils/forEachAsync.d.ts +2 -1
  87. package/esm/typings/src/formats/_common/FormatDefinition.d.ts +2 -2
  88. package/esm/typings/src/formats/_common/FormatSubvalueDefinition.d.ts +3 -2
  89. package/esm/typings/src/formats/csv/CsvFormatError.d.ts +10 -0
  90. package/esm/typings/src/llm-providers/_common/{$llmToolsMetadataRegister.d.ts → register/$llmToolsMetadataRegister.d.ts} +4 -1
  91. package/esm/typings/src/llm-providers/_common/{$llmToolsRegister.d.ts → register/$llmToolsRegister.d.ts} +5 -2
  92. package/esm/typings/src/llm-providers/_common/{createLlmToolsFromConfigurationFromEnv.d.ts → register/$provideLlmToolsConfigurationFromEnv.d.ts} +3 -3
  93. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForCli.d.ts +15 -0
  94. package/esm/typings/src/llm-providers/_common/{getLlmToolsForTestingAndScriptsAndPlayground.d.ts → register/$provideLlmToolsForTestingAndScriptsAndPlayground.d.ts} +4 -3
  95. package/esm/typings/src/llm-providers/_common/{createLlmToolsFromEnv.d.ts → register/$provideLlmToolsFromEnv.d.ts} +6 -5
  96. package/esm/typings/src/llm-providers/_common/{$registeredLlmToolsMessage.d.ts → register/$registeredLlmToolsMessage.d.ts} +5 -2
  97. package/esm/typings/src/llm-providers/_common/{LlmToolsConfiguration.d.ts → register/LlmToolsConfiguration.d.ts} +6 -5
  98. package/esm/typings/src/llm-providers/_common/{LlmToolsMetadata.d.ts → register/LlmToolsMetadata.d.ts} +5 -4
  99. package/esm/typings/src/llm-providers/_common/{LlmToolsOptions.d.ts → register/LlmToolsOptions.d.ts} +4 -1
  100. package/esm/typings/src/llm-providers/_common/{createLlmToolsFromConfiguration.d.ts → register/createLlmToolsFromConfiguration.d.ts} +12 -4
  101. package/esm/typings/src/llm-providers/_common/utils/cache/CacheLlmToolsOptions.d.ts +4 -1
  102. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +1 -1
  103. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions.d.ts +5 -5
  104. package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +1 -1
  105. package/esm/typings/src/llm-providers/anthropic-claude/playground/playground.d.ts +3 -2
  106. package/esm/typings/src/llm-providers/anthropic-claude/register-configuration.d.ts +4 -3
  107. package/esm/typings/src/llm-providers/anthropic-claude/register-constructor.d.ts +4 -3
  108. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +7 -1
  109. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionToolsOptions.d.ts +4 -3
  110. package/esm/typings/src/llm-providers/azure-openai/playground/playground.d.ts +1 -0
  111. package/esm/typings/src/llm-providers/azure-openai/register-configuration.d.ts +4 -3
  112. package/esm/typings/src/llm-providers/azure-openai/register-constructor.d.ts +4 -3
  113. package/esm/typings/src/llm-providers/langtail/LangtailExecutionTools.d.ts +1 -1
  114. package/esm/typings/src/llm-providers/langtail/playground/playground.d.ts +3 -0
  115. package/esm/typings/src/llm-providers/mocked/$fakeTextToExpectations.d.ts +1 -1
  116. package/esm/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts +4 -4
  117. package/esm/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts +4 -4
  118. package/esm/typings/src/llm-providers/multiple/MultipleLlmExecutionTools.d.ts +4 -4
  119. package/esm/typings/src/llm-providers/multiple/joinLlmExecutionTools.d.ts +1 -1
  120. package/esm/typings/src/llm-providers/multiple/playground/playground.d.ts +3 -0
  121. package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionTools.d.ts +1 -2
  122. package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +2 -2
  123. package/esm/typings/src/llm-providers/openai/OpenAiExecutionToolsOptions.d.ts +4 -4
  124. package/esm/typings/src/llm-providers/openai/openai-models.d.ts +1 -1
  125. package/esm/typings/src/llm-providers/openai/playground/playground.d.ts +2 -1
  126. package/esm/typings/src/llm-providers/openai/register-configuration.d.ts +5 -4
  127. package/esm/typings/src/llm-providers/openai/register-constructor.d.ts +5 -4
  128. package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts +4 -4
  129. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_ListModels_Request.d.ts +16 -7
  130. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_ListModels_Response.d.ts +4 -4
  131. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Prompt_Request.d.ts +7 -13
  132. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Prompt_Response.d.ts +3 -3
  133. package/esm/typings/src/llm-providers/remote/interfaces/RemoteLlmExecutionToolsOptions.d.ts +11 -16
  134. package/esm/typings/src/llm-providers/remote/interfaces/RemoteServerOptions.d.ts +24 -9
  135. package/esm/typings/src/llm-providers/remote/playground/playground.d.ts +3 -0
  136. package/esm/typings/src/llm-providers/remote/startRemoteServer.d.ts +1 -1
  137. package/esm/typings/src/personas/preparePersona.d.ts +3 -2
  138. package/esm/typings/src/prepare/PrepareAndScrapeOptions.d.ts +49 -0
  139. package/esm/typings/src/prepare/preparePipeline.d.ts +3 -2
  140. package/esm/typings/src/prepare/prepareTemplates.d.ts +4 -3
  141. package/esm/typings/src/scrapers/_common/Converter.d.ts +22 -0
  142. package/esm/typings/src/scrapers/_common/Scraper.d.ts +59 -0
  143. package/esm/typings/src/scrapers/_common/ScraperIntermediateSource.d.ts +11 -0
  144. package/esm/typings/src/{knowledge/prepare-knowledge → scrapers}/_common/prepareKnowledgePieces.d.ts +5 -4
  145. package/esm/typings/src/scrapers/_common/register/$provideFilesystemForNode.d.ts +11 -0
  146. package/esm/typings/src/scrapers/_common/register/$provideScrapersForBrowser.d.ts +12 -0
  147. package/esm/typings/src/scrapers/_common/register/$provideScrapersForNode.d.ts +15 -0
  148. package/esm/typings/src/scrapers/_common/register/$registeredScrapersMessage.d.ts +12 -0
  149. package/esm/typings/src/scrapers/_common/register/$scrapersMetadataRegister.d.ts +13 -0
  150. package/esm/typings/src/scrapers/_common/register/$scrapersRegister.d.ts +13 -0
  151. package/esm/typings/src/scrapers/_common/register/ScraperAndConverterMetadata.d.ts +41 -0
  152. package/esm/typings/src/scrapers/_common/register/ScraperConstructor.d.ts +12 -0
  153. package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.d.ts +34 -0
  154. package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.test.d.ts +4 -0
  155. package/esm/typings/src/scrapers/_common/utils/makeKnowledgeSourceHandler.d.ts +11 -0
  156. package/esm/typings/src/scrapers/document/DocumentScraper.d.ts +43 -0
  157. package/esm/typings/src/scrapers/document/DocumentScraper.test.d.ts +4 -0
  158. package/esm/typings/src/scrapers/document/createDocumentScraper.d.ts +20 -0
  159. package/esm/typings/src/scrapers/document/playground/document-scraper-playground.d.ts +5 -0
  160. package/esm/typings/src/scrapers/document/register-constructor.d.ts +13 -0
  161. package/esm/typings/src/scrapers/document/register-metadata.d.ts +24 -0
  162. package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.d.ts +43 -0
  163. package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.test.d.ts +4 -0
  164. package/esm/typings/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts +20 -0
  165. package/esm/typings/src/scrapers/document-legacy/playground/legacy-document-scraper-playground.d.ts +5 -0
  166. package/esm/typings/src/scrapers/document-legacy/register-constructor.d.ts +13 -0
  167. package/esm/typings/src/scrapers/document-legacy/register-metadata.d.ts +24 -0
  168. package/esm/typings/src/scrapers/markdown/MarkdownScraper.d.ts +29 -0
  169. package/esm/typings/src/scrapers/markdown/createMarkdownScraper.d.ts +20 -0
  170. package/esm/typings/src/scrapers/markdown/playground/markdown-scraper-playground.d.ts +5 -0
  171. package/esm/typings/src/scrapers/markdown/register-constructor.d.ts +13 -0
  172. package/esm/typings/src/scrapers/markdown/register-metadata.d.ts +24 -0
  173. package/esm/typings/src/scrapers/pdf/PdfScraper.d.ts +40 -0
  174. package/esm/typings/src/scrapers/pdf/createPdfScraper.d.ts +20 -0
  175. package/esm/typings/src/scrapers/pdf/playground/pdf-scraper-playground.d.ts +5 -0
  176. package/esm/typings/src/scrapers/pdf/register-constructor.d.ts +13 -0
  177. package/esm/typings/src/scrapers/pdf/register-metadata.d.ts +24 -0
  178. package/esm/typings/src/scrapers/website/WebsiteScraper.d.ts +46 -0
  179. package/esm/typings/src/scrapers/website/createWebsiteScraper.d.ts +20 -0
  180. package/esm/typings/src/scrapers/website/playground/website-scraper-playground.d.ts +5 -0
  181. package/esm/typings/src/scrapers/website/register-constructor.d.ts +13 -0
  182. package/esm/typings/src/scrapers/website/register-metadata.d.ts +24 -0
  183. package/esm/typings/src/scripting/javascript/JavascriptExecutionToolsOptions.d.ts +2 -2
  184. package/esm/typings/src/scripting/javascript/utils/preserve.d.ts +1 -1
  185. package/esm/typings/src/scripting/python/PythonExecutionTools.d.ts +3 -3
  186. package/esm/typings/src/scripting/typescript/TypescriptExecutionTools.d.ts +3 -3
  187. package/esm/typings/src/storage/{files-storage/FilesStorage.d.ts → file-cache-storage/FileCacheStorage.d.ts} +7 -5
  188. package/esm/typings/src/storage/file-cache-storage/FileCacheStorageOptions.d.ts +10 -0
  189. package/esm/typings/src/storage/{files-storage → file-cache-storage}/utils/nameToSubfolderPath.d.ts +2 -2
  190. package/esm/typings/src/storage/local-storage/getLocalStorage.d.ts +1 -1
  191. package/esm/typings/src/storage/local-storage/getSessionStorage.d.ts +1 -1
  192. package/esm/typings/src/storage/{utils → memory/utils}/PrefixStorage.d.ts +1 -1
  193. package/esm/typings/src/storage/{utils → memory/utils}/makePromptbookStorageFromWebStorage.d.ts +1 -1
  194. package/esm/typings/src/types/Arrayable.d.ts +1 -1
  195. package/esm/typings/src/types/IntermediateFilesStrategy.d.ts +7 -0
  196. package/esm/typings/src/types/PipelineJson/KnowledgePieceJson.d.ts +4 -4
  197. package/esm/typings/src/types/PipelineJson/KnowledgeSourceJson.d.ts +10 -3
  198. package/esm/typings/src/types/PipelineJson/ParameterJson.d.ts +1 -1
  199. package/esm/typings/src/types/PipelineJson/PersonaJson.d.ts +1 -1
  200. package/esm/typings/src/types/PipelineJson/PipelineJson.d.ts +2 -2
  201. package/esm/typings/src/types/PipelineJson/TemplateJsonCommon.d.ts +2 -2
  202. package/esm/typings/src/types/Prompt.d.ts +2 -1
  203. package/esm/typings/src/types/execution-report/ExecutionReportJson.d.ts +1 -4
  204. package/esm/typings/src/types/execution-report/executionReportJsonToString.d.ts +2 -1
  205. package/esm/typings/src/types/typeAliases.d.ts +27 -20
  206. package/esm/typings/src/utils/$Register.d.ts +20 -7
  207. package/esm/typings/src/utils/FromtoItems.d.ts +1 -1
  208. package/esm/typings/src/utils/arrayableToArray.d.ts +1 -1
  209. package/esm/typings/src/utils/emojis.d.ts +1 -1
  210. package/esm/typings/src/utils/execCommand/$execCommand.d.ts +14 -0
  211. package/esm/typings/src/utils/execCommand/$execCommands.d.ts +17 -0
  212. package/esm/typings/src/utils/execCommand/ExecCommandOptions.d.ts +19 -0
  213. package/esm/typings/src/utils/execCommand/execCommandNormalizeOptions.d.ts +10 -0
  214. package/esm/typings/src/utils/execCommand/execCommandNormalizeOptions.test.d.ts +1 -0
  215. package/esm/typings/src/utils/expectation-counters/countSentences.d.ts +1 -1
  216. package/esm/typings/src/utils/files/extensionToMimeType.d.ts +8 -0
  217. package/esm/typings/src/utils/files/extensionToMimeType.test.d.ts +1 -0
  218. package/esm/typings/src/utils/files/getFileExtension.d.ts +8 -0
  219. package/esm/typings/src/utils/files/getFileExtension.test.d.ts +1 -0
  220. package/esm/typings/src/utils/files/isDirectoryExisting.d.ts +14 -0
  221. package/esm/typings/src/utils/files/isDirectoryExisting.test.d.ts +1 -0
  222. package/esm/typings/src/utils/files/isExecutable.d.ts +11 -0
  223. package/esm/typings/src/utils/files/isFileExisting.d.ts +13 -0
  224. package/esm/typings/src/utils/files/isFileExisting.test.d.ts +1 -0
  225. package/esm/typings/src/utils/files/listAllFiles.d.ts +17 -0
  226. package/esm/typings/src/utils/files/listAllFiles.test.d.ts +1 -0
  227. package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.d.ts +1 -1
  228. package/esm/typings/src/utils/markdown/splitMarkdownIntoSections.d.ts +1 -1
  229. package/esm/typings/src/utils/normalization/IKeywords.d.ts +2 -2
  230. package/esm/typings/src/utils/normalization/parseKeywords.d.ts +2 -2
  231. package/esm/typings/src/utils/normalization/parseKeywordsFromString.d.ts +2 -2
  232. package/esm/typings/src/utils/normalization/searchKeywords.d.ts +2 -2
  233. package/esm/typings/src/utils/organization/TODO_USE.d.ts +1 -1
  234. package/esm/typings/src/utils/organization/keepUnused.d.ts +1 -1
  235. package/esm/typings/src/utils/random/$randomSeed.d.ts +1 -1
  236. package/esm/typings/src/utils/sets/intersection.d.ts +1 -1
  237. package/esm/typings/src/utils/sets/union.d.ts +1 -1
  238. package/esm/typings/src/utils/unwrapResult.d.ts +4 -4
  239. package/esm/typings/src/utils/validators/filePath/isValidFilePath.d.ts +2 -2
  240. package/package.json +4 -3
  241. package/umd/index.umd.js +247 -5
  242. package/umd/index.umd.js.map +1 -1
  243. package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorSettings.d.ts +0 -40
  244. package/esm/typings/src/knowledge/prepare-knowledge/_common/Scraper.d.ts +0 -37
  245. package/esm/typings/src/knowledge/prepare-knowledge/markdown/playground/markdown-knowledge-playground.d.ts +0 -2
  246. package/esm/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.d.ts +0 -14
  247. package/esm/typings/src/knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.d.ts +0 -15
  248. package/esm/typings/src/llm-providers/_common/getLlmToolsForCli.d.ts +0 -22
  249. package/esm/typings/src/prepare/PrepareOptions.d.ts +0 -22
  250. package/esm/typings/src/storage/files-storage/FilesStorageOptions.d.ts +0 -10
  251. package/esm/typings/src/utils/files/$isDirectoryExisting.d.ts +0 -15
  252. package/esm/typings/src/utils/files/$isFileExisting.d.ts +0 -14
  253. package/esm/typings/src/utils/files/$listAllFiles.d.ts +0 -17
  254. /package/esm/typings/src/{knowledge/dialogs → dialogs}/user-interface-execution-tools.test.d.ts +0 -0
  255. /package/esm/typings/src/{knowledge/prepare-knowledge/_common/prepareKnowledgePieces.test.d.ts → executables/apps/locateLibreoffice.test.d.ts} +0 -0
  256. /package/esm/typings/src/{knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.test.d.ts → executables/apps/locatePandoc.test.d.ts} +0 -0
  257. /package/esm/typings/src/{storage/files-storage/utils/nameToSubfolderPath.test.d.ts → executables/locateApp.test.d.ts} +0 -0
  258. /package/esm/typings/src/{utils/files/$isDirectoryExisting.test.d.ts → scrapers/_common/prepareKnowledgePieces.test.d.ts} +0 -0
  259. /package/esm/typings/src/{knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.test.d.ts → scrapers/markdown/MarkdownScraper.test.d.ts} +0 -0
  260. /package/esm/typings/src/{utils/files/$isFileExisting.test.d.ts → storage/file-cache-storage/utils/nameToSubfolderPath.test.d.ts} +0 -0
  261. /package/esm/typings/src/utils/{files/$listAllFiles.test.d.ts → execCommand/execCommand.test.d.ts} +0 -0
@@ -0,0 +1,12 @@
1
+ import type { LocateAppOptions } from '../locateApp';
2
+ import type { string_executable_path } from '../../types/typeAliases';
3
+ /**
4
+ * @@@
5
+ *
6
+ * @private within the repository
7
+ */
8
+ export declare function locateAppOnLinux({ appName, linuxWhich, }: Pick<Required<LocateAppOptions>, 'appName' | 'linuxWhich'>): Promise<string_executable_path>;
9
+ /**
10
+ * TODO: [🧠][♿] Maybe export through `@promptbook/node`
11
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
12
+ */
@@ -0,0 +1,12 @@
1
+ import type { string_executable_path } from '../../types/typeAliases';
2
+ import type { LocateAppOptions } from '../locateApp';
3
+ /**
4
+ * @@@
5
+ *
6
+ * @private within the repository
7
+ */
8
+ export declare function locateAppOnMacOs({ appName, macOsName, }: Pick<Required<LocateAppOptions>, 'appName' | 'macOsName'>): Promise<string_executable_path>;
9
+ /**
10
+ * TODO: [🧠][♿] Maybe export through `@promptbook/node`
11
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
12
+ */
@@ -0,0 +1,12 @@
1
+ import type { string_executable_path } from '../../types/typeAliases';
2
+ import type { LocateAppOptions } from '../locateApp';
3
+ /**
4
+ * @@@
5
+ *
6
+ * @private within the repository
7
+ */
8
+ export declare function locateAppOnWindows({ appName, windowsSuffix, }: Pick<Required<LocateAppOptions>, 'appName' | 'windowsSuffix'>): Promise<string_executable_path>;
9
+ /**
10
+ * TODO: [🧠][♿] Maybe export through `@promptbook/node`
11
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
12
+ */
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * Note: Keep it public to allow people to make their own execution tools
5
5
  */
6
- export type CommonExecutionToolsOptions = {
6
+ export type CommonToolsOptions = {
7
7
  /**
8
8
  * If true, the internal executions will be logged
9
9
  */
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * Represents a vector in an latent space of the embedding model
3
3
  */
4
- export type EmbeddingVector = Array<number>;
4
+ export type EmbeddingVector = ReadonlyArray<number>;
5
5
  /**
6
6
  * TODO: Figure out how to use NPM package xyzt
7
7
  * Not using IVectorData due to HUGE dimensionality
@@ -0,0 +1,18 @@
1
+ import type { string_executable_path } from '../types/typeAliases';
2
+ /**
3
+ * Paths to the external programs executables
4
+ */
5
+ export type Executables = {
6
+ /**
7
+ * Path to the `pandoc` executable
8
+ *
9
+ * @example 'C:/Users/me/AppData/Local/Pandoc/pandoc.exe'
10
+ */
11
+ pandocPath?: string_executable_path;
12
+ /**
13
+ * Path to the LibreOffice executable
14
+ *
15
+ * @example 'C:/Program Files/LibreOffice/program/swriter.exe'
16
+ */
17
+ libreOfficePath?: string_executable_path;
18
+ };
@@ -1,4 +1,7 @@
1
+ import type { Scraper } from '../scrapers/_common/Scraper';
1
2
  import type { Arrayable } from '../types/Arrayable';
3
+ import type { Executables } from './Executables';
4
+ import type { FilesystemTools } from './FilesystemTools';
2
5
  import type { LlmExecutionTools } from './LlmExecutionTools';
3
6
  import type { ScriptExecutionTools } from './ScriptExecutionTools';
4
7
  import type { UserInterfaceTools } from './UserInterfaceTools';
@@ -9,28 +12,51 @@ import type { UserInterfaceTools } from './UserInterfaceTools';
9
12
  */
10
13
  export type ExecutionTools = {
11
14
  /**
12
- * Tools for executing prompts to large language models like GPT-4
15
+ * Tools for executing prompts in large language models
13
16
  *
14
- * Tip: Use `createLlmToolsFromEnv()` to use all available LLM providers you configured
15
- * @see https://github.com/webgptorg/promptbook/?tab=readme-ov-file#llm-execution-tools
17
+ * Tip: Use `$provideLlmToolsFromEnv` to use all available LLM providers you configured
18
+ *
19
+ * @default [] - If not provided, no LLM execution will be possible - it does not make sense in most cases
20
+ */
21
+ readonly llm?: Arrayable<LlmExecutionTools>;
22
+ /**
23
+ * Tools for filesystem operations
24
+ *
25
+ * Tip: Use `$provideFilesystemForNode` to use filesystem in Node.js
26
+ *
27
+ * @default undefined - If not provided, no filesystem operations will be possible
28
+ */
29
+ readonly fs?: FilesystemTools;
30
+ /**
31
+ * Scrapers for extracting knowledge from external sources
32
+ *
33
+ * Tip: Use `$provideExecutablesForNode`
34
+ *
35
+ * @default [] - If not provided, no external knowledge extraction will be possible
36
+ */
37
+ readonly executables?: Executables;
38
+ /**
39
+ * Scrapers for extracting knowledge from external sources
40
+ *
41
+ * Tip: Use `$provideScrapersForNode` OR `$provideScrapersForBrowser` to use all available scrapers
42
+ *
43
+ * @default [] - If not provided, no external knowledge extraction will be possible
16
44
  */
17
- llm?: Arrayable<LlmExecutionTools>;
45
+ readonly scrapers?: Arrayable<Scraper>;
18
46
  /**
19
47
  * Tools for executing scripts
20
48
  *
21
49
  * Note: You can pass multiple ScriptExecutionTools, they will be tried one by one until one of them supports the script
22
50
  * If none of them supports the script, an error is thrown
23
- * Tip: Use here `new JavascriptExecutionTools()`
51
+ * Tip: Use here `new JavascriptExecutionTools`
24
52
  *
25
- * @see https://github.com/webgptorg/promptbook/?tab=readme-ov-file#script-execution-tools
26
53
  * @default [] - If not provided, no script execution will be possible
27
54
  */
28
- script?: Arrayable<ScriptExecutionTools>;
55
+ readonly script?: Arrayable<ScriptExecutionTools>;
29
56
  /**
30
57
  * Tools for interacting with the user
31
58
  *
32
59
  * Note: When undefined, the user interface is disabled and promptbook which requires user interaction will fail
33
- * @see https://github.com/webgptorg/promptbook/?tab=readme-ov-file#user-interface-tools
34
60
  */
35
- userInterface?: UserInterfaceTools;
61
+ readonly userInterface?: UserInterfaceTools;
36
62
  };
@@ -0,0 +1,9 @@
1
+ /// <reference types="node" />
2
+ import type fs from 'fs/promises';
3
+ /**
4
+ * Container for all the tools needed to manipulate with filesystem
5
+ */
6
+ export type FilesystemTools = Pick<typeof fs, 'access' | 'constants' | 'readFile' | 'stat' | 'readdir'>;
7
+ /**
8
+ * TODO: Implement destroyable pattern to free resources
9
+ */
@@ -37,7 +37,7 @@ export type LlmExecutionTools = {
37
37
  /**
38
38
  * List all available models that can be used
39
39
  */
40
- listModels(): Promisable<Array<AvailableModel>>;
40
+ listModels(): Promisable<ReadonlyArray<AvailableModel>>;
41
41
  /**
42
42
  * Calls a chat model
43
43
  */
@@ -52,7 +52,7 @@ export type LlmExecutionTools = {
52
52
  callEmbeddingModel?(prompt: Prompt): Promise<EmbeddingPromptResult>;
53
53
  };
54
54
  /**
55
- * TODO: Implement destroyable pattern to free resources
55
+ * TODO: [🍚] Implement destroyable pattern to free resources
56
56
  * TODO: [🏳] Add `callTranslationModel`
57
57
  * TODO: [🧠] Emulation of one type of model with another one - emuate chat with completion; emulate translation with chat
58
58
  * TODO: [🍓][♐] Some heuristic to pick the best model in listed models
@@ -14,5 +14,6 @@ export type PipelineExecutor = {
14
14
  (inputParameters: Parameters, onProgress?: (taskProgress: TaskProgress) => Promisable<void>): Promise<PipelineExecutorResult>;
15
15
  };
16
16
  /**
17
+ * TODO: [🐚] Change onProgress to object that represents the running execution, can be subscribed via RxJS to and also awaited
17
18
  * TODO: [🧠] Should this file be in /execution or /types folder?
18
19
  */
@@ -27,11 +27,11 @@ export type PipelineExecutorResult = {
27
27
  /**
28
28
  * Errors that occured during the execution, details are aviable in `executionReport`
29
29
  */
30
- readonly errors: ReadonlyDeep<Array<ErrorJson>>;
30
+ readonly errors: ReadonlyDeep<ReadonlyArray<ErrorJson>>;
31
31
  /**
32
32
  * Warnings that occured during the execution, details are aviable in `executionReport`
33
33
  */
34
- readonly warnings: ReadonlyDeep<Array<ErrorJson>>;
34
+ readonly warnings: ReadonlyDeep<ReadonlyArray<ErrorJson>>;
35
35
  /**
36
36
  * The report of the execution with all details
37
37
  */
@@ -1,4 +1,4 @@
1
- import type { PipelineExecutor } from './PipelineExecutor';
1
+ import type { PipelineExecutorResult } from './PipelineExecutorResult';
2
2
  /**
3
3
  * Asserts that the execution of a Promptbook is successful
4
4
  *
@@ -6,7 +6,8 @@ import type { PipelineExecutor } from './PipelineExecutor';
6
6
  * @throws {PipelineExecutionError} If the execution is not successful or if multiple errors occurred
7
7
  * @public exported from `@promptbook/core`
8
8
  */
9
- export declare function assertsExecutionSuccessful(executionResult: Pick<Awaited<ReturnType<PipelineExecutor>>, 'isSuccessful' | 'errors'>): void;
9
+ export declare function assertsExecutionSuccessful(executionResult: Pick<PipelineExecutorResult, 'isSuccessful' | 'errors'>): void;
10
10
  /**
11
+ * TODO: [🐚] This function should be removed OR changed OR be completely rewritten
11
12
  * TODO: [🧠] Can this return type be better typed than void
12
13
  */
@@ -1,10 +1,11 @@
1
+ import type { CsvSettings } from '../../formats/csv/CsvSettings';
2
+ import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
1
3
  import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
2
4
  import type { ExecutionTools } from '../ExecutionTools';
3
- import type { CreatePipelineExecutorSettings } from './00-CreatePipelineExecutorSettings';
4
5
  /**
5
6
  * Options for `createPipelineExecutor`
6
7
  */
7
- export interface CreatePipelineExecutorOptions {
8
+ export type CreatePipelineExecutorOptions = PrepareAndScrapeOptions & {
8
9
  /**
9
10
  * The pipeline to be executed
10
11
  */
@@ -14,7 +15,32 @@ export interface CreatePipelineExecutorOptions {
14
15
  */
15
16
  readonly tools: ExecutionTools;
16
17
  /**
17
- * Optional settings for the pipeline executor
18
+ * When executor does not satisfy expectations it will be retried this amount of times
19
+ *
20
+ * @default MAX_EXECUTION_ATTEMPTS
18
21
  */
19
- readonly settings?: Partial<CreatePipelineExecutorSettings>;
20
- }
22
+ readonly maxExecutionAttempts?: number;
23
+ /**
24
+ * Settings for CSV format
25
+ *
26
+ * @default DEFAULT_CSV_SETTINGS
27
+ */
28
+ readonly csvSettings?: CsvSettings;
29
+ /**
30
+ * If you pass fully prepared pipeline, this does not matter
31
+ *
32
+ * Otherwise:
33
+ * If false or not set, warning is shown when pipeline is not prepared
34
+ * If true, warning is suppressed
35
+ *
36
+ * @default false
37
+ */
38
+ readonly isNotPreparedWarningSupressed?: boolean;
39
+ };
40
+ /**
41
+ * TODO: [🧎][🧠] Move `csvSettings` to some better place
42
+ * 1) either to some dependency in `ExecutionTools`
43
+ * 2) or make here container for multiple formats
44
+ * 3) or make the setting more universal and which just sets things like `delimiter` and `quote` without specifying the format
45
+ * TODO: [🤹‍♂️] More granular setting for limits of execution + better waiting for queue
46
+ */
@@ -8,3 +8,6 @@ import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorO
8
8
  * @public exported from `@promptbook/core`
9
9
  */
10
10
  export declare function createPipelineExecutor(options: CreatePipelineExecutorOptions): PipelineExecutor;
11
+ /**
12
+ * TODO: [🐚] Change onProgress to object that represents the running execution, can be subscribed via RxJS to and also awaited
13
+ */
@@ -2,23 +2,18 @@ import type { Promisable, ReadonlyDeep } from 'type-fest';
2
2
  import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
3
3
  import type { TaskProgress } from '../../types/TaskProgress';
4
4
  import type { Parameters } from '../../types/typeAliases';
5
- import type { ExecutionTools } from '../ExecutionTools';
6
5
  import type { PipelineExecutorResult } from '../PipelineExecutorResult';
7
- import type { CreatePipelineExecutorSettings } from './00-CreatePipelineExecutorSettings';
6
+ import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
8
7
  /**
9
8
  * @@@
10
9
  *
11
- * @private internal type of `executePipelinex`
10
+ * @private internal type of `executePipeline`
12
11
  */
13
- type ExecutePipelineOptions = {
12
+ type ExecutePipelineOptions = CreatePipelineExecutorOptions & {
14
13
  /**
15
14
  * @@@
16
15
  */
17
16
  readonly inputParameters: Readonly<Parameters>;
18
- /**
19
- * @@@
20
- */
21
- readonly tools: ExecutionTools;
22
17
  /**
23
18
  * @@@
24
19
  */
@@ -39,10 +34,6 @@ type ExecutePipelineOptions = {
39
34
  * @@@
40
35
  */
41
36
  readonly pipelineIdentification: string;
42
- /**
43
- * Settings for the pipeline executor
44
- */
45
- readonly settings: CreatePipelineExecutorSettings;
46
37
  };
47
38
  /**
48
39
  * @@@
@@ -53,3 +44,6 @@ type ExecutePipelineOptions = {
53
44
  */
54
45
  export declare function executePipeline(options: ExecutePipelineOptions): Promise<PipelineExecutorResult>;
55
46
  export {};
47
+ /**
48
+ * TODO: [🐚] Change onProgress to object that represents the running execution, can be subscribed via RxJS to and also awaited
49
+ */
@@ -1,18 +1,16 @@
1
- import { Promisable, ReadonlyDeep } from 'type-fest';
2
- import { MultipleLlmExecutionTools } from '../../llm-providers/multiple/MultipleLlmExecutionTools';
1
+ import type { Promisable, ReadonlyDeep, WritableDeep } from 'type-fest';
3
2
  import type { ExecutionReportJson } from '../../types/execution-report/ExecutionReportJson';
4
3
  import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
5
4
  import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
6
5
  import type { TaskProgress } from '../../types/TaskProgress';
7
6
  import type { Parameters } from '../../types/typeAliases';
8
- import type { ExecutionTools } from '../ExecutionTools';
9
- import type { CreatePipelineExecutorSettings } from './00-CreatePipelineExecutorSettings';
7
+ import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
10
8
  /**
11
9
  * @@@
12
10
  *
13
11
  * @private internal type of `executeTemplate`
14
12
  */
15
- type executeSingleTemplateOptions = {
13
+ type executeSingleTemplateOptions = CreatePipelineExecutorOptions & {
16
14
  /**
17
15
  * @@@
18
16
  */
@@ -25,26 +23,14 @@ type executeSingleTemplateOptions = {
25
23
  * @@@
26
24
  */
27
25
  readonly parametersToPass: Readonly<Parameters>;
28
- /**
29
- * @@@
30
- */
31
- readonly tools: Omit<ExecutionTools, 'llm'>;
32
- /**
33
- * @@@
34
- */
35
- readonly llmTools: MultipleLlmExecutionTools;
36
26
  /**
37
27
  * @@@
38
28
  */
39
29
  readonly onProgress: (taskProgress: TaskProgress) => Promisable<void>;
40
- /**
41
- * Settings for the pipeline executor
42
- */
43
- readonly settings: CreatePipelineExecutorSettings;
44
30
  /**
45
31
  * @@@
46
32
  */
47
- readonly $executionReport: ExecutionReportJson;
33
+ readonly $executionReport: WritableDeep<ExecutionReportJson>;
48
34
  /**
49
35
  * @@@
50
36
  */
@@ -60,3 +46,6 @@ export {};
60
46
  /**
61
47
  * TODO: [🤹‍♂️]
62
48
  */
49
+ /**
50
+ * TODO: [🐚] Change onProgress to object that represents the running execution, can be subscribed via RxJS to and also awaited
51
+ */
@@ -3,7 +3,7 @@ import type { ExecuteAttemptsOptions } from './40-executeAttempts';
3
3
  /**
4
4
  * @@@
5
5
  *
6
- * @private internal type of `executeFormatCells`
6
+ * @private internal type of `executeFormatSubvalues`
7
7
  */
8
8
  type ExecuteFormatCellsOptions = ExecuteAttemptsOptions;
9
9
  /**
@@ -11,9 +11,5 @@ type ExecuteFormatCellsOptions = ExecuteAttemptsOptions;
11
11
  *
12
12
  * @private internal utility of `createPipelineExecutor`
13
13
  */
14
- export declare function executeFormatCells(options: ExecuteFormatCellsOptions): Promise<TODO_any>;
14
+ export declare function executeFormatSubvalues(options: ExecuteFormatCellsOptions): Promise<TODO_any>;
15
15
  export {};
16
- /**
17
- * TODO: !!!!!! Make pipelineIdentification more precise
18
- * TODO: !!!!!! How FOREACH execution looks in the report
19
- */
@@ -1,29 +1,31 @@
1
- import type { ReadonlyDeep } from 'type-fest';
2
- import { MultipleLlmExecutionTools } from '../../llm-providers/multiple/MultipleLlmExecutionTools';
1
+ import type { ReadonlyDeep, WritableDeep } from 'type-fest';
3
2
  import type { ExecutionReportJson } from '../../types/execution-report/ExecutionReportJson';
4
3
  import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
5
4
  import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
6
5
  import type { Parameters } from '../../types/typeAliases';
7
6
  import type { string_parameter_name } from '../../types/typeAliases';
8
7
  import type { TODO_string } from '../../utils/organization/TODO_string';
9
- import type { ExecutionTools } from '../ExecutionTools';
10
- import type { CreatePipelineExecutorSettings } from './00-CreatePipelineExecutorSettings';
8
+ import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
11
9
  /**
12
10
  * @@@
13
11
  *
14
12
  * @private internal type of `executeAttempts`
15
13
  */
16
- export type ExecuteAttemptsOptions = {
14
+ export type ExecuteAttemptsOptions = Omit<CreatePipelineExecutorOptions, 'pipeline'> & {
17
15
  /**
18
16
  * @@@
19
17
  */
20
- readonly jokerParameterNames: Readonly<Array<string_parameter_name>>;
18
+ readonly jokerParameterNames: Readonly<ReadonlyArray<string_parameter_name>>;
21
19
  /**
22
20
  * @@@
23
21
  */
24
22
  readonly priority: number;
25
23
  /**
26
24
  * @@@
25
+ *
26
+ * Note: [💂] There are two distinct variabiles
27
+ * 1) `maxExecutionAttempts` - the amount of attempts LLM model
28
+ * 2) `maxAttempts` - the amount of attempts for any template - LLM, SCRIPT, DIALOG, etc.
27
29
  */
28
30
  readonly maxAttempts: number;
29
31
  /**
@@ -45,19 +47,7 @@ export type ExecuteAttemptsOptions = {
45
47
  /**
46
48
  * @@@
47
49
  */
48
- readonly tools: Omit<ExecutionTools, 'llm'>;
49
- /**
50
- * @@@
51
- */
52
- readonly llmTools: MultipleLlmExecutionTools;
53
- /**
54
- * Settings for the pipeline executor
55
- */
56
- readonly settings: CreatePipelineExecutorSettings;
57
- /**
58
- * @@@
59
- */
60
- readonly $executionReport: ExecutionReportJson;
50
+ readonly $executionReport: WritableDeep<ExecutionReportJson>;
61
51
  /**
62
52
  * @@@
63
53
  */
@@ -4,4 +4,4 @@ import type { EmbeddingVector } from './EmbeddingVector';
4
4
  *
5
5
  * @public exported from `@promptbook/core`
6
6
  */
7
- export declare function embeddingVectorToString(embeddingVector: EmbeddingVector): string;
7
+ export declare function embeddingVectorToString(embeddingVector: Readonly<EmbeddingVector>): string;
@@ -1,9 +1,17 @@
1
1
  import type { AutomaticTranslator } from './AutomaticTranslator';
2
2
  import type { TranslatorOptions } from './TranslatorOptions';
3
- interface LindatAutomaticTranslatorOptions extends TranslatorOptions {
4
- apiUrl?: URL;
5
- }
6
3
  /**
4
+ * @@@
5
+ */
6
+ type LindatAutomaticTranslatorOptions = TranslatorOptions & {
7
+ /**
8
+ * @@@
9
+ */
10
+ readonly apiUrl?: URL;
11
+ };
12
+ /**
13
+ * @@@
14
+ *
7
15
  * @private still in development [🏳]
8
16
  */
9
17
  export declare class LindatAutomaticTranslator implements AutomaticTranslator {
@@ -6,3 +6,7 @@ import type { TranslatorOptions } from './automatic-translators/TranslatorOption
6
6
  export declare function translateMessages({ automaticTranslator, from, to, }: {
7
7
  automaticTranslator: AutomaticTranslator;
8
8
  } & TranslatorOptions): Promise<void>;
9
+ /**
10
+ * TODO: [😶] Unite floder listing
11
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
12
+ */
@@ -0,0 +1,13 @@
1
+ import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
2
+ import type { ExecutionTools } from '../ExecutionTools';
3
+ /**
4
+ * Note: There is unfortunately no equivalent for this function in the browser environment
5
+ * because it is not possible automatically detect configured LLM providers
6
+ * you need to provide them manually BUT you can help by utilities like `$provideScrapersForBrowser`
7
+ *
8
+ * @public exported from `@promptbook/node`
9
+ */
10
+ export declare function $provideExecutionToolsForNode(options?: PrepareAndScrapeOptions): Promise<ExecutionTools>;
11
+ /**
12
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
13
+ */
@@ -6,4 +6,4 @@ import type { PromptResultUsage } from '../PromptResultUsage';
6
6
  *
7
7
  * @public exported from `@promptbook/core`
8
8
  */
9
- export declare function addUsage(...usageItems: Array<PromptResultUsage>): PromptResultUsage;
9
+ export declare function addUsage(...usageItems: ReadonlyArray<PromptResultUsage>): PromptResultUsage;
@@ -14,6 +14,7 @@ type ForEachAsyncOptions = {
14
14
  * @param options - Options for the function
15
15
  * @param callbackfunction - Function to call for each item
16
16
  * @public exported from `@promptbook/utils`
17
+ * @deprecated [🪂] Use queues instead
17
18
  */
18
- export declare function forEachAsync<TItem>(array: Array<TItem>, options: ForEachAsyncOptions, callbackfunction: (value: TItem, index: number, array: Array<TItem>) => Promisable<void>): Promise<void>;
19
+ export declare function forEachAsync<TItem>(array: ReadonlyArray<TItem>, options: ForEachAsyncOptions, callbackfunction: (value: TItem, index: number, array: ReadonlyArray<TItem>) => Promisable<void>): Promise<void>;
19
20
  export {};
@@ -21,7 +21,7 @@ export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends
21
21
  /**
22
22
  * Aliases for the `formatName`
23
23
  */
24
- readonly aliases?: Array<string_name & string_SCREAMING_CASE>;
24
+ readonly aliases?: ReadonlyArray<string_name & string_SCREAMING_CASE>;
25
25
  /**
26
26
  * The mime type of the format (if any)
27
27
  *
@@ -58,7 +58,7 @@ export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends
58
58
  /**
59
59
  * @@@
60
60
  */
61
- readonly subvalueDefinitions: Array<FormatSubvalueDefinition<TValue, TSettings>>;
61
+ readonly subvalueDefinitions: ReadonlyArray<FormatSubvalueDefinition<TValue, TSettings>>;
62
62
  };
63
63
  /**
64
64
  * TODO: [♏] Add some prepare hook to modify prompt according to the format
@@ -1,6 +1,7 @@
1
1
  import type { Promisable } from 'type-fest';
2
2
  import type { Parameters } from '../../types/typeAliases';
3
3
  import type { string_name } from '../../types/typeAliases';
4
+ import type { string_parameter_name } from '../../types/typeAliases';
4
5
  import type { string_SCREAMING_CASE } from '../../utils/normalization/normalizeTo_SCREAMING_CASE';
5
6
  import type { empty_object } from '../../utils/organization/empty_object';
6
7
  /**
@@ -16,14 +17,14 @@ export type FormatSubvalueDefinition<TValue extends string, TSettings extends em
16
17
  /**
17
18
  * Aliases for the `subvalueName`
18
19
  */
19
- readonly aliases?: Array<string_name & string_SCREAMING_CASE>;
20
+ readonly aliases?: ReadonlyArray<string_name & string_SCREAMING_CASE>;
20
21
  /**
21
22
  * Maps values
22
23
  *
23
24
  * For example, if you have a JSON object and you want to map all values to uppercase
24
25
  * Or iterate over all CSV cells @@@
25
26
  */
26
- mapValues(value: TValue, settings: TSettings, mapCallback: (subvalues: Parameters, index: number) => Promisable<string>): Promise<string>;
27
+ mapValues(value: TValue, outputParameterName: string_parameter_name, settings: TSettings, mapCallback: (subvalues: Parameters, index: number) => Promisable<string>): Promise<string>;
27
28
  };
28
29
  /**
29
30
  * Note: [👩🏾‍🤝‍🧑🏽]
@@ -0,0 +1,10 @@
1
+ import { AbstractFormatError } from "../../errors/AbstractFormatError";
2
+ /**
3
+ * This error indicates problem with parsing of CSV
4
+ *
5
+ * @public exported from `@promptbook/core`
6
+ */
7
+ export declare class CsvFormatError extends AbstractFormatError {
8
+ readonly name = "CsvFormatError";
9
+ constructor(message: string);
10
+ }
@@ -1,4 +1,4 @@
1
- import { $Register } from '../../utils/$Register';
1
+ import { $Register } from '../../../utils/$Register';
2
2
  import type { LlmToolsMetadata } from './LlmToolsMetadata';
3
3
  /**
4
4
  * @@@
@@ -8,3 +8,6 @@ import type { LlmToolsMetadata } from './LlmToolsMetadata';
8
8
  * @public exported from `@promptbook/core`
9
9
  */
10
10
  export declare const $llmToolsMetadataRegister: $Register<LlmToolsMetadata>;
11
+ /**
12
+ * TODO: [®] DRY Register logic
13
+ */
@@ -1,5 +1,5 @@
1
- import type { LlmExecutionToolsConstructor } from '../../execution/LlmExecutionToolsConstructor';
2
- import { $Register } from '../../utils/$Register';
1
+ import type { LlmExecutionToolsConstructor } from '../../../execution/LlmExecutionToolsConstructor';
2
+ import { $Register } from '../../../utils/$Register';
3
3
  /**
4
4
  * @@@
5
5
  *
@@ -8,3 +8,6 @@ import { $Register } from '../../utils/$Register';
8
8
  * @public exported from `@promptbook/core`
9
9
  */
10
10
  export declare const $llmToolsRegister: $Register<LlmExecutionToolsConstructor>;
11
+ /**
12
+ * TODO: [®] DRY Register logic
13
+ */
@@ -11,14 +11,14 @@ import type { LlmToolsConfiguration } from './LlmToolsConfiguration';
11
11
  * @returns @@@
12
12
  * @public exported from `@promptbook/node`
13
13
  */
14
- export declare function createLlmToolsFromConfigurationFromEnv(): LlmToolsConfiguration;
14
+ export declare function $provideLlmToolsConfigurationFromEnv(): LlmToolsConfiguration;
15
15
  /**
16
16
  * TODO: [🧠][🪁] Maybe do allow to do auto-install if package not registered and not found
17
17
  * TODO: Add Azure OpenAI
18
18
  * TODO: [🧠][🍛]
19
19
  * TODO: [🧠] Is there some meaningfull way how to test this util
20
- * Note: [🟢] This code should never be published outside of `@promptbook/node` and `@promptbook/cli` and `@promptbook/cli`
20
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
21
21
  * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
22
22
  * TODO: This should be maybe not under `_common` but under `utils`
23
23
  * TODO: [🧠] Maybe pass env as argument
24
- */
24
+ * TODO: [®] DRY Register logic */