@promptbook/remote-server 0.72.0-0 → 0.72.0-10

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 (247) hide show
  1. package/README.md +15 -6
  2. package/esm/index.es.js +154 -40
  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 +24 -0
  6. package/esm/typings/src/_packages/core.index.d.ts +47 -15
  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 +16 -6
  11. package/esm/typings/src/_packages/openai.index.d.ts +4 -0
  12. package/esm/typings/src/_packages/pdf.index.d.ts +8 -0
  13. package/esm/typings/src/_packages/types.index.d.ts +61 -27
  14. package/esm/typings/src/_packages/utils.index.d.ts +4 -4
  15. package/esm/typings/src/_packages/website-crawler.index.d.ts +8 -0
  16. package/esm/typings/src/cli/cli-commands/about.d.ts +1 -1
  17. package/esm/typings/src/cli/cli-commands/hello.d.ts +2 -1
  18. package/esm/typings/src/cli/cli-commands/make.d.ts +1 -1
  19. package/esm/typings/src/cli/cli-commands/prettify.d.ts +2 -1
  20. package/esm/typings/src/cli/cli-commands/test-command.d.ts +13 -0
  21. package/esm/typings/src/cli/main.d.ts +1 -1
  22. package/esm/typings/src/cli/promptbookCli.d.ts +1 -1
  23. package/esm/typings/src/collection/constructors/createCollectionFromDirectory.d.ts +11 -6
  24. package/esm/typings/src/collection/constructors/createCollectionFromUrl.d.ts +1 -1
  25. package/esm/typings/src/commands/EXPECT/expectCommandParser.d.ts +1 -1
  26. package/esm/typings/src/commands/FOREACH/ForeachCommand.d.ts +3 -2
  27. package/esm/typings/src/commands/FOREACH/ForeachJson.d.ts +27 -0
  28. package/esm/typings/src/commands/FOREACH/foreachCommandParser.d.ts +2 -2
  29. package/esm/typings/src/commands/FORMAT/formatCommandParser.d.ts +1 -1
  30. package/esm/typings/src/commands/JOKER/jokerCommandParser.d.ts +1 -1
  31. package/esm/typings/src/commands/KNOWLEDGE/knowledgeCommandParser.d.ts +1 -1
  32. package/esm/typings/src/commands/KNOWLEDGE/utils/sourceContentToName.d.ts +11 -0
  33. package/esm/typings/src/commands/KNOWLEDGE/utils/sourceContentToName.test.d.ts +4 -0
  34. package/esm/typings/src/commands/MODEL/modelCommandParser.d.ts +1 -1
  35. package/esm/typings/src/commands/PARAMETER/parameterCommandParser.d.ts +1 -1
  36. package/esm/typings/src/commands/PERSONA/personaCommandParser.d.ts +1 -1
  37. package/esm/typings/src/commands/POSTPROCESS/postprocessCommandParser.d.ts +1 -1
  38. package/esm/typings/src/commands/PROMPTBOOK_VERSION/promptbookVersionCommandParser.d.ts +1 -1
  39. package/esm/typings/src/commands/TEMPLATE/templateCommandParser.d.ts +1 -1
  40. package/esm/typings/src/commands/URL/urlCommandParser.d.ts +1 -1
  41. package/esm/typings/src/commands/X_ACTION/actionCommandParser.d.ts +1 -1
  42. package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommandParser.d.ts +1 -1
  43. package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts +1 -1
  44. package/esm/typings/src/commands/_common/types/CommandParser.d.ts +16 -1
  45. package/esm/typings/src/config.d.ts +30 -1
  46. package/esm/typings/src/conversion/pipelineStringToJson.d.ts +4 -15
  47. package/esm/typings/src/conversion/pipelineStringToJsonSync.d.ts +1 -1
  48. package/esm/typings/src/conversion/prettify/renderPipelineMermaidOptions.d.ts +3 -0
  49. package/esm/typings/src/conversion/utils/extractParameterNamesFromTemplate.d.ts +2 -1
  50. package/esm/typings/src/conversion/validation/_importPipeline.d.ts +1 -1
  51. package/esm/typings/src/conversion/validation/validatePipeline.d.ts +10 -5
  52. package/esm/typings/src/{knowledge/dialogs → dialogs}/callback/CallbackInterfaceTools.d.ts +2 -2
  53. package/esm/typings/src/{knowledge/dialogs → dialogs}/callback/CallbackInterfaceToolsOptions.d.ts +3 -3
  54. package/esm/typings/src/{knowledge/dialogs → dialogs}/simple-prompt/SimplePromptInterfaceTools.d.ts +6 -6
  55. package/esm/typings/src/errors/AbstractFormatError.d.ts +11 -0
  56. package/esm/typings/src/errors/KnowledgeScrapeError.d.ts +9 -0
  57. package/esm/typings/src/errors/MissingToolsError.d.ts +9 -0
  58. package/esm/typings/src/execution/{CommonExecutionToolsOptions.d.ts → CommonToolsOptions.d.ts} +1 -1
  59. package/esm/typings/src/execution/ExecutionTools.d.ts +29 -9
  60. package/esm/typings/src/execution/FilesystemTools.d.ts +9 -0
  61. package/esm/typings/src/execution/PipelineExecutor.d.ts +1 -0
  62. package/esm/typings/src/execution/PipelineExecutorResult.d.ts +9 -8
  63. package/esm/typings/src/execution/createPipelineExecutor/$OngoingTemplateResult.d.ts +45 -0
  64. package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorOptions.d.ts +23 -0
  65. package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorSettings.d.ts +29 -0
  66. package/esm/typings/src/execution/createPipelineExecutor/00-createPipelineExecutor.d.ts +13 -0
  67. package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts +58 -0
  68. package/esm/typings/src/execution/createPipelineExecutor/20-executeTemplate.d.ts +60 -0
  69. package/esm/typings/src/execution/createPipelineExecutor/30-executeFormatSubvalues.d.ts +15 -0
  70. package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +69 -0
  71. package/esm/typings/src/execution/createPipelineExecutor/filterJustOutputParameters.d.ts +34 -0
  72. package/esm/typings/src/execution/createPipelineExecutor/getContextForTemplate.d.ts +10 -0
  73. package/esm/typings/src/execution/createPipelineExecutor/getKnowledgeForTemplate.d.ts +27 -0
  74. package/esm/typings/src/execution/createPipelineExecutor/getReservedParametersForTemplate.d.ts +30 -0
  75. package/esm/typings/src/execution/createPipelineExecutor/getSamplesForTemplate.d.ts +10 -0
  76. package/esm/typings/src/execution/embeddingVectorToString.d.ts +1 -1
  77. package/esm/typings/src/execution/translation/automatic-translate/translateMessages.d.ts +4 -0
  78. package/esm/typings/src/execution/utils/$provideExecutionToolsForNode.d.ts +13 -0
  79. package/esm/typings/src/execution/utils/checkExpectations.d.ts +2 -0
  80. package/esm/typings/src/execution/utils/forEachAsync.d.ts +1 -0
  81. package/esm/typings/src/execution/utils/usageToHuman.d.ts +3 -4
  82. package/esm/typings/src/formats/_common/FormatDefinition.d.ts +14 -15
  83. package/esm/typings/src/formats/_common/FormatSubvalueDefinition.d.ts +31 -0
  84. package/esm/typings/src/formats/csv/{ListFormatDefinition.d.ts → CsvFormatDefinition.d.ts} +6 -3
  85. package/esm/typings/src/formats/csv/CsvFormatError.d.ts +10 -0
  86. package/esm/typings/src/formats/csv/CsvSettings.d.ts +13 -0
  87. package/esm/typings/src/formats/index.d.ts +1 -1
  88. package/esm/typings/src/formats/json/JsonFormatDefinition.d.ts +4 -3
  89. package/esm/typings/src/formats/text/TextFormatDefinition.d.ts +19 -0
  90. package/esm/typings/src/formats/xml/XmlFormatDefinition.d.ts +4 -3
  91. package/esm/typings/src/llm-providers/_common/{$llmToolsMetadataRegister.d.ts → register/$llmToolsMetadataRegister.d.ts} +4 -1
  92. package/esm/typings/src/llm-providers/_common/{$llmToolsRegister.d.ts → register/$llmToolsRegister.d.ts} +5 -2
  93. package/esm/typings/src/llm-providers/_common/{createLlmToolsFromConfigurationFromEnv.d.ts → register/$provideLlmToolsConfigurationFromEnv.d.ts} +3 -3
  94. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForCli.d.ts +15 -0
  95. package/esm/typings/src/llm-providers/_common/{getLlmToolsForTestingAndScriptsAndPlayground.d.ts → register/$provideLlmToolsForTestingAndScriptsAndPlayground.d.ts} +4 -3
  96. package/esm/typings/src/llm-providers/_common/{createLlmToolsFromEnv.d.ts → register/$provideLlmToolsFromEnv.d.ts} +6 -5
  97. package/esm/typings/src/llm-providers/_common/{$registeredLlmToolsMessage.d.ts → register/$registeredLlmToolsMessage.d.ts} +5 -2
  98. package/esm/typings/src/llm-providers/_common/{LlmToolsConfiguration.d.ts → register/LlmToolsConfiguration.d.ts} +5 -4
  99. package/esm/typings/src/llm-providers/_common/{LlmToolsMetadata.d.ts → register/LlmToolsMetadata.d.ts} +5 -4
  100. package/esm/typings/src/llm-providers/_common/{LlmToolsOptions.d.ts → register/LlmToolsOptions.d.ts} +4 -1
  101. package/esm/typings/src/llm-providers/_common/{createLlmToolsFromConfiguration.d.ts → register/createLlmToolsFromConfiguration.d.ts} +5 -4
  102. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions.d.ts +5 -5
  103. package/esm/typings/src/llm-providers/anthropic-claude/playground/playground.d.ts +3 -2
  104. package/esm/typings/src/llm-providers/anthropic-claude/register-configuration.d.ts +4 -3
  105. package/esm/typings/src/llm-providers/anthropic-claude/register-constructor.d.ts +4 -3
  106. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +6 -0
  107. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionToolsOptions.d.ts +4 -3
  108. package/esm/typings/src/llm-providers/azure-openai/playground/playground.d.ts +1 -0
  109. package/esm/typings/src/llm-providers/azure-openai/register-configuration.d.ts +4 -3
  110. package/esm/typings/src/llm-providers/azure-openai/register-constructor.d.ts +4 -3
  111. package/esm/typings/src/llm-providers/langtail/LangtailExecutionTools.d.ts +1 -1
  112. package/esm/typings/src/llm-providers/langtail/playground/playground.d.ts +3 -0
  113. package/esm/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts +3 -3
  114. package/esm/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts +3 -3
  115. package/esm/typings/src/llm-providers/multiple/MultipleLlmExecutionTools.d.ts +1 -0
  116. package/esm/typings/src/llm-providers/multiple/playground/playground.d.ts +3 -0
  117. package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionTools.d.ts +2 -2
  118. package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionToolsOptions.d.ts +1 -1
  119. package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +10 -1
  120. package/esm/typings/src/llm-providers/openai/OpenAiExecutionToolsOptions.d.ts +4 -4
  121. package/esm/typings/src/llm-providers/openai/createOpenAiAssistantExecutionTools.d.ts +15 -0
  122. package/esm/typings/src/llm-providers/openai/playground/playground.d.ts +2 -1
  123. package/esm/typings/src/llm-providers/openai/register-configuration.d.ts +11 -1
  124. package/esm/typings/src/llm-providers/openai/register-constructor.d.ts +11 -1
  125. package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts +3 -3
  126. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_ListModels_Request.d.ts +16 -7
  127. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_ListModels_Response.d.ts +2 -2
  128. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Prompt_Request.d.ts +7 -13
  129. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Prompt_Response.d.ts +1 -1
  130. package/esm/typings/src/llm-providers/remote/interfaces/RemoteLlmExecutionToolsOptions.d.ts +11 -16
  131. package/esm/typings/src/llm-providers/remote/interfaces/RemoteServerOptions.d.ts +23 -9
  132. package/esm/typings/src/llm-providers/remote/playground/playground.d.ts +3 -0
  133. package/esm/typings/src/llm-providers/remote/startRemoteServer.d.ts +1 -1
  134. package/esm/typings/src/personas/preparePersona.d.ts +3 -2
  135. package/esm/typings/src/prepare/PrepareAndScrapeOptions.d.ts +68 -0
  136. package/esm/typings/src/prepare/preparePipeline.d.ts +3 -2
  137. package/esm/typings/src/prepare/prepareTemplates.d.ts +3 -2
  138. package/esm/typings/src/scrapers/_common/Converter.d.ts +22 -0
  139. package/esm/typings/src/scrapers/_common/Scraper.d.ts +66 -0
  140. package/esm/typings/src/scrapers/_common/ScraperIntermediateSource.d.ts +11 -0
  141. package/esm/typings/src/{knowledge/prepare-knowledge → scrapers}/_common/prepareKnowledgePieces.d.ts +5 -4
  142. package/esm/typings/src/scrapers/_common/register/$provideFilesystemForNode.d.ts +11 -0
  143. package/esm/typings/src/scrapers/_common/register/$provideScrapersForBrowser.d.ts +12 -0
  144. package/esm/typings/src/scrapers/_common/register/$provideScrapersForNode.d.ts +15 -0
  145. package/esm/typings/src/scrapers/_common/register/$registeredScrapersMessage.d.ts +12 -0
  146. package/esm/typings/src/scrapers/_common/register/$scrapersMetadataRegister.d.ts +13 -0
  147. package/esm/typings/src/scrapers/_common/register/$scrapersRegister.d.ts +13 -0
  148. package/esm/typings/src/scrapers/_common/register/ScraperAndConverterMetadata.d.ts +41 -0
  149. package/esm/typings/src/scrapers/_common/register/ScraperConstructor.d.ts +12 -0
  150. package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.d.ts +34 -0
  151. package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.test.d.ts +4 -0
  152. package/esm/typings/src/scrapers/_common/utils/makeKnowledgeSourceHandler.d.ts +11 -0
  153. package/esm/typings/src/scrapers/document/DocumentScraper.d.ts +43 -0
  154. package/esm/typings/src/scrapers/document/DocumentScraper.test.d.ts +4 -0
  155. package/esm/typings/src/scrapers/document/createDocumentScraper.d.ts +20 -0
  156. package/esm/typings/src/scrapers/document/playground/document-scraper-playground.d.ts +5 -0
  157. package/esm/typings/src/scrapers/document/register-constructor.d.ts +13 -0
  158. package/esm/typings/src/scrapers/document/register-metadata.d.ts +24 -0
  159. package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.d.ts +43 -0
  160. package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.test.d.ts +4 -0
  161. package/esm/typings/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts +20 -0
  162. package/esm/typings/src/scrapers/document-legacy/playground/legacy-document-scraper-playground.d.ts +5 -0
  163. package/esm/typings/src/scrapers/document-legacy/register-constructor.d.ts +13 -0
  164. package/esm/typings/src/scrapers/document-legacy/register-metadata.d.ts +24 -0
  165. package/esm/typings/src/scrapers/markdown/MarkdownScraper.d.ts +29 -0
  166. package/esm/typings/src/scrapers/markdown/createMarkdownScraper.d.ts +20 -0
  167. package/esm/typings/src/scrapers/markdown/playground/markdown-scraper-playground.d.ts +5 -0
  168. package/esm/typings/src/scrapers/markdown/register-constructor.d.ts +13 -0
  169. package/esm/typings/src/scrapers/markdown/register-metadata.d.ts +24 -0
  170. package/esm/typings/src/scrapers/pdf/PdfScraper.d.ts +40 -0
  171. package/esm/typings/src/scrapers/pdf/createPdfScraper.d.ts +20 -0
  172. package/esm/typings/src/scrapers/pdf/playground/pdf-scraper-playground.d.ts +5 -0
  173. package/esm/typings/src/scrapers/pdf/register-constructor.d.ts +13 -0
  174. package/esm/typings/src/scrapers/pdf/register-metadata.d.ts +24 -0
  175. package/esm/typings/src/scrapers/website/WebsiteScraper.d.ts +47 -0
  176. package/esm/typings/src/scrapers/website/createWebsiteScraper.d.ts +20 -0
  177. package/esm/typings/src/scrapers/website/playground/website-scraper-playground.d.ts +5 -0
  178. package/esm/typings/src/scrapers/website/register-constructor.d.ts +13 -0
  179. package/esm/typings/src/scrapers/website/register-metadata.d.ts +24 -0
  180. package/esm/typings/src/scrapers/website/utils/markdownConverter.d.ts +12 -0
  181. package/esm/typings/src/scripting/javascript/JavascriptExecutionToolsOptions.d.ts +2 -2
  182. package/esm/typings/src/scripting/python/PythonExecutionTools.d.ts +3 -3
  183. package/esm/typings/src/scripting/typescript/TypescriptExecutionTools.d.ts +3 -3
  184. package/esm/typings/src/storage/{files-storage/FilesStorage.d.ts → file-cache-storage/FileCacheStorage.d.ts} +7 -5
  185. package/esm/typings/src/storage/file-cache-storage/FileCacheStorageOptions.d.ts +10 -0
  186. package/esm/typings/src/storage/{files-storage → file-cache-storage}/utils/nameToSubfolderPath.d.ts +1 -1
  187. package/esm/typings/src/storage/local-storage/getLocalStorage.d.ts +1 -1
  188. package/esm/typings/src/storage/local-storage/getSessionStorage.d.ts +1 -1
  189. package/esm/typings/src/storage/{utils → memory/utils}/PrefixStorage.d.ts +1 -1
  190. package/esm/typings/src/storage/{utils → memory/utils}/makePromptbookStorageFromWebStorage.d.ts +1 -1
  191. package/esm/typings/src/types/PipelineJson/KnowledgeSourceJson.d.ts +9 -2
  192. package/esm/typings/src/types/PipelineJson/ParameterJson.d.ts +1 -0
  193. package/esm/typings/src/types/PipelineJson/PipelineJson.d.ts +2 -2
  194. package/esm/typings/src/types/PipelineJson/TemplateJsonCommon.d.ts +5 -0
  195. package/esm/typings/src/types/Prompt.d.ts +1 -0
  196. package/esm/typings/src/types/execution-report/executionReportJsonToString.d.ts +2 -1
  197. package/esm/typings/src/types/typeAliases.d.ts +27 -20
  198. package/esm/typings/src/utils/$Register.d.ts +19 -6
  199. package/esm/typings/src/utils/execCommand/$execCommand.d.ts +14 -0
  200. package/esm/typings/src/utils/execCommand/$execCommands.d.ts +17 -0
  201. package/esm/typings/src/utils/execCommand/IExecCommandOptions.d.ts +23 -0
  202. package/esm/typings/src/utils/execCommand/execCommandNormalizeOptions.d.ts +10 -0
  203. package/esm/typings/src/utils/expectation-counters/index.d.ts +3 -0
  204. package/esm/typings/src/utils/files/extensionToMimeType.d.ts +8 -0
  205. package/esm/typings/src/utils/files/getFileExtension.d.ts +8 -0
  206. package/esm/typings/src/utils/files/isDirectoryExisting.d.ts +14 -0
  207. package/esm/typings/src/utils/files/isFileExisting.d.ts +13 -0
  208. package/esm/typings/src/utils/files/isFileExisting.test.d.ts +1 -0
  209. package/esm/typings/src/utils/files/listAllFiles.d.ts +17 -0
  210. package/esm/typings/src/utils/files/listAllFiles.test.d.ts +1 -0
  211. package/esm/typings/src/utils/organization/{f.d.ts → empty_object.d.ts} +5 -1
  212. package/esm/typings/src/utils/organization/just_empty_object.d.ts +12 -0
  213. package/esm/typings/src/utils/{extractParameterNames.d.ts → parameters/extractParameterNames.d.ts} +2 -2
  214. package/esm/typings/src/utils/parameters/extractParameterNames.test.d.ts +1 -0
  215. package/esm/typings/src/utils/parameters/mapAvailableToExpectedParameters.d.ts +27 -0
  216. package/esm/typings/src/utils/parameters/mapAvailableToExpectedParameters.test.d.ts +1 -0
  217. package/esm/typings/src/utils/{replaceParameters.d.ts → parameters/replaceParameters.d.ts} +2 -2
  218. package/esm/typings/src/utils/parameters/replaceParameters.test.d.ts +1 -0
  219. package/esm/typings/src/utils/validators/filePath/isValidFilePath.d.ts +2 -2
  220. package/esm/typings/src/utils/validators/parameterName/validateParameterName.d.ts +10 -0
  221. package/esm/typings/src/utils/validators/parameterName/validateParameterName.test.d.ts +1 -0
  222. package/package.json +17 -13
  223. package/umd/index.umd.js +154 -40
  224. package/umd/index.umd.js.map +1 -1
  225. package/esm/typings/src/execution/createPipelineExecutor.d.ts +0 -72
  226. package/esm/typings/src/formats/list/ListFormatDefinition.d.ts +0 -16
  227. package/esm/typings/src/knowledge/prepare-knowledge/_common/Scraper.d.ts +0 -37
  228. package/esm/typings/src/knowledge/prepare-knowledge/markdown/playground/markdown-knowledge-playground.d.ts +0 -2
  229. package/esm/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.d.ts +0 -14
  230. package/esm/typings/src/knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.d.ts +0 -15
  231. package/esm/typings/src/llm-providers/_common/getLlmToolsForCli.d.ts +0 -22
  232. package/esm/typings/src/prepare/PrepareOptions.d.ts +0 -22
  233. package/esm/typings/src/storage/files-storage/FilesStorageOptions.d.ts +0 -10
  234. package/esm/typings/src/utils/files/$isDirectoryExisting.d.ts +0 -15
  235. package/esm/typings/src/utils/files/$isFileExisting.d.ts +0 -14
  236. package/esm/typings/src/utils/files/$listAllFiles.d.ts +0 -17
  237. /package/esm/typings/src/{knowledge/dialogs → dialogs}/user-interface-execution-tools.test.d.ts +0 -0
  238. /package/esm/typings/src/{knowledge/prepare-knowledge → scrapers}/_common/prepareKnowledgePieces.test.d.ts +0 -0
  239. /package/esm/typings/src/{knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.test.d.ts → scrapers/markdown/MarkdownScraper.test.d.ts} +0 -0
  240. /package/esm/typings/src/{execution/utils/usageToHuman.test.d.ts → scrapers/website/WebsiteScraper.test.d.ts} +0 -0
  241. /package/esm/typings/src/{knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.test.d.ts → scrapers/website/utils/markdownConverter.test.d.ts} +0 -0
  242. /package/esm/typings/src/storage/{files-storage → file-cache-storage}/utils/nameToSubfolderPath.test.d.ts +0 -0
  243. /package/esm/typings/src/utils/{extractParameterNames.test.d.ts → execCommand/execCommand.test.d.ts} +0 -0
  244. /package/esm/typings/src/utils/{files/$isDirectoryExisting.test.d.ts → execCommand/execCommandNormalizeOptions.test.d.ts} +0 -0
  245. /package/esm/typings/src/utils/files/{$isFileExisting.test.d.ts → extensionToMimeType.test.d.ts} +0 -0
  246. /package/esm/typings/src/utils/files/{$listAllFiles.test.d.ts → getFileExtension.test.d.ts} +0 -0
  247. /package/esm/typings/src/utils/{replaceParameters.test.d.ts → files/isDirectoryExisting.test.d.ts} +0 -0
@@ -0,0 +1,60 @@
1
+ import { Promisable, ReadonlyDeep } from 'type-fest';
2
+ import type { ExecutionReportJson } from '../../types/execution-report/ExecutionReportJson';
3
+ import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
4
+ import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
5
+ import type { TaskProgress } from '../../types/TaskProgress';
6
+ import type { Parameters } from '../../types/typeAliases';
7
+ import type { ExecutionTools } from '../ExecutionTools';
8
+ import type { CreatePipelineExecutorSettings } from './00-CreatePipelineExecutorSettings';
9
+ /**
10
+ * @@@
11
+ *
12
+ * @private internal type of `executeTemplate`
13
+ */
14
+ type executeSingleTemplateOptions = {
15
+ /**
16
+ * @@@
17
+ */
18
+ readonly currentTemplate: ReadonlyDeep<TemplateJson>;
19
+ /**
20
+ * @@@
21
+ */
22
+ readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
23
+ /**
24
+ * @@@
25
+ */
26
+ readonly parametersToPass: Readonly<Parameters>;
27
+ /**
28
+ * @@@
29
+ */
30
+ readonly tools: ExecutionTools;
31
+ /**
32
+ * @@@
33
+ */
34
+ readonly onProgress: (taskProgress: TaskProgress) => Promisable<void>;
35
+ /**
36
+ * Settings for the pipeline executor
37
+ */
38
+ readonly settings: CreatePipelineExecutorSettings;
39
+ /**
40
+ * @@@
41
+ */
42
+ readonly $executionReport: ExecutionReportJson;
43
+ /**
44
+ * @@@
45
+ */
46
+ readonly pipelineIdentification: string;
47
+ };
48
+ /**
49
+ * @@@
50
+ *
51
+ * @private internal utility of `createPipelineExecutor`
52
+ */
53
+ export declare function executeTemplate(options: executeSingleTemplateOptions): Promise<Readonly<Parameters>>;
54
+ export {};
55
+ /**
56
+ * TODO: [🤹‍♂️]
57
+ */
58
+ /**
59
+ * TODO: [🐚] Change onProgress to object that represents the running execution, can be subscribed via RxJS to and also awaited
60
+ */
@@ -0,0 +1,15 @@
1
+ import type { TODO_any } from '../../utils/organization/TODO_any';
2
+ import type { ExecuteAttemptsOptions } from './40-executeAttempts';
3
+ /**
4
+ * @@@
5
+ *
6
+ * @private internal type of `executeFormatSubvalues`
7
+ */
8
+ type ExecuteFormatCellsOptions = ExecuteAttemptsOptions;
9
+ /**
10
+ * @@@
11
+ *
12
+ * @private internal utility of `createPipelineExecutor`
13
+ */
14
+ export declare function executeFormatSubvalues(options: ExecuteFormatCellsOptions): Promise<TODO_any>;
15
+ export {};
@@ -0,0 +1,69 @@
1
+ import type { ReadonlyDeep } from 'type-fest';
2
+ import type { ExecutionReportJson } from '../../types/execution-report/ExecutionReportJson';
3
+ import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
4
+ import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
5
+ import type { Parameters } from '../../types/typeAliases';
6
+ import type { string_parameter_name } from '../../types/typeAliases';
7
+ import type { TODO_string } from '../../utils/organization/TODO_string';
8
+ import type { ExecutionTools } from '../ExecutionTools';
9
+ import type { CreatePipelineExecutorSettings } from './00-CreatePipelineExecutorSettings';
10
+ /**
11
+ * @@@
12
+ *
13
+ * @private internal type of `executeAttempts`
14
+ */
15
+ export type ExecuteAttemptsOptions = {
16
+ /**
17
+ * @@@
18
+ */
19
+ readonly jokerParameterNames: Readonly<Array<string_parameter_name>>;
20
+ /**
21
+ * @@@
22
+ */
23
+ readonly priority: number;
24
+ /**
25
+ * @@@
26
+ */
27
+ readonly maxAttempts: number;
28
+ /**
29
+ * @@@
30
+ */
31
+ readonly preparedContent: TODO_string;
32
+ /**
33
+ * @@@
34
+ */
35
+ readonly parameters: Readonly<Parameters>;
36
+ /**
37
+ * @@@
38
+ */
39
+ readonly template: ReadonlyDeep<TemplateJson>;
40
+ /**
41
+ * @@@
42
+ */
43
+ readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
44
+ /**
45
+ * @@@
46
+ */
47
+ readonly tools: ExecutionTools;
48
+ /**
49
+ * Settings for the pipeline executor
50
+ */
51
+ readonly settings: CreatePipelineExecutorSettings;
52
+ /**
53
+ * @@@
54
+ */
55
+ readonly $executionReport: ExecutionReportJson;
56
+ /**
57
+ * @@@
58
+ */
59
+ readonly pipelineIdentification: string;
60
+ };
61
+ /**
62
+ * @@@
63
+ *
64
+ * @private internal utility of `createPipelineExecutor`
65
+ */
66
+ export declare function executeAttempts(options: ExecuteAttemptsOptions): Promise<TODO_string>;
67
+ /**
68
+ * TODO: Break into smaller functions
69
+ */
@@ -0,0 +1,34 @@
1
+ import type { ReadonlyDeep } from 'type-fest';
2
+ import { PipelineExecutionError } from '../../errors/PipelineExecutionError';
3
+ import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
4
+ import type { Parameters } from '../../types/typeAliases';
5
+ /**
6
+ * @@@
7
+ *
8
+ * @private internal type of `createPipelineExecutor`
9
+ */
10
+ type FilterJustOutputParametersOptions = {
11
+ /**
12
+ * @@@
13
+ */
14
+ readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
15
+ /**
16
+ * @@@
17
+ */
18
+ readonly parametersToPass: Readonly<Parameters>;
19
+ /**
20
+ * @@@
21
+ */
22
+ readonly $warnings: PipelineExecutionError[];
23
+ /**
24
+ * @@@
25
+ */
26
+ readonly pipelineIdentification: string;
27
+ };
28
+ /**
29
+ * @@@
30
+ *
31
+ * @private internal utility of `createPipelineExecutor`
32
+ */
33
+ export declare function filterJustOutputParameters(options: FilterJustOutputParametersOptions): Parameters;
34
+ export {};
@@ -0,0 +1,10 @@
1
+ import type { ReadonlyDeep } from 'type-fest';
2
+ import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
3
+ import type { string_markdown } from '../../types/typeAliases';
4
+ import type { string_parameter_value } from '../../types/typeAliases';
5
+ /**
6
+ * @@@
7
+ *
8
+ * @private internal utility of `createPipelineExecutor`
9
+ */
10
+ export declare function getContextForTemplate(template: ReadonlyDeep<TemplateJson>): Promise<string_parameter_value & string_markdown>;
@@ -0,0 +1,27 @@
1
+ import type { ReadonlyDeep } from 'type-fest';
2
+ import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
3
+ import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
4
+ import type { string_markdown } from '../../types/typeAliases';
5
+ import type { string_parameter_value } from '../../types/typeAliases';
6
+ /**
7
+ * @@@
8
+ *
9
+ * @private internal type of `getKnowledgeForTemplate`
10
+ */
11
+ type GetKnowledgeForTemplateOptions = {
12
+ /**
13
+ * @@@
14
+ */
15
+ readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
16
+ /**
17
+ * @@@
18
+ */
19
+ readonly template: ReadonlyDeep<TemplateJson>;
20
+ };
21
+ /**
22
+ * @@@
23
+ *
24
+ * @private internal utility of `createPipelineExecutor`
25
+ */
26
+ export declare function getKnowledgeForTemplate(options: GetKnowledgeForTemplateOptions): Promise<string_parameter_value & string_markdown>;
27
+ export {};
@@ -0,0 +1,30 @@
1
+ import type { ReadonlyDeep } from 'type-fest';
2
+ import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
3
+ import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
4
+ import type { ReservedParameters } from '../../types/typeAliases';
5
+ /**
6
+ * @@@
7
+ *
8
+ * @private internal type of `getReservedParametersForTemplate`
9
+ */
10
+ type GetReservedParametersForTemplateOptions = {
11
+ /**
12
+ * @@@
13
+ */
14
+ readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
15
+ /**
16
+ * @@@
17
+ */
18
+ readonly template: ReadonlyDeep<TemplateJson>;
19
+ /**
20
+ * @@@
21
+ */
22
+ readonly pipelineIdentification: string;
23
+ };
24
+ /**
25
+ * @@@
26
+ *
27
+ * @private internal utility of `createPipelineExecutor`
28
+ */
29
+ export declare function getReservedParametersForTemplate(options: GetReservedParametersForTemplateOptions): Promise<Readonly<ReservedParameters>>;
30
+ export {};
@@ -0,0 +1,10 @@
1
+ import type { ReadonlyDeep } from 'type-fest';
2
+ import type { TemplateJson } from '../../types/PipelineJson/TemplateJson';
3
+ import type { string_markdown } from '../../types/typeAliases';
4
+ import type { string_parameter_value } from '../../types/typeAliases';
5
+ /**
6
+ * @@@
7
+ *
8
+ * @private internal utility of `createPipelineExecutor`
9
+ */
10
+ export declare function getSamplesForTemplate(template: ReadonlyDeep<TemplateJson>): Promise<string_parameter_value & string_markdown>;
@@ -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;
@@ -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
+ */
@@ -24,4 +24,6 @@ export declare function checkExpectations(expectations: Expectations, value: str
24
24
  export declare function isPassingExpectations(expectations: Expectations, value: string): boolean;
25
25
  /**
26
26
  * TODO: [💝] Unite object for expecting amount and format
27
+ * TODO: [🧠][🤠] This should be part of `TextFormatDefinition`
28
+ * Note: [💝] and [🤠] are interconnected together
27
29
  */
@@ -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
19
  export declare function forEachAsync<TItem>(array: Array<TItem>, options: ForEachAsyncOptions, callbackfunction: (value: TItem, index: number, array: Array<TItem>) => Promisable<void>): Promise<void>;
19
20
  export {};
@@ -7,11 +7,10 @@ import type { PromptResultUsage } from '../PromptResultUsage';
7
7
  */
8
8
  export declare function usageToHuman(usage: PromptResultUsage): string_markdown;
9
9
  /**
10
- * TODO: Use "$1" not "1 USD"
11
- * TODO: Use markdown formatting like "Cost approximately **$1**"
12
- * TODO: Report in minutes, seconds, days NOT 0.1 hours
10
+ * TODO: [🍓][🧞‍♂️] Use "$1" not "1 USD"
11
+ * TODO: [🍓][🧞‍♂️] Use markdown formatting like "Cost approximately **$1**"
12
+ * TODO: [🍓][🧞‍♂️] Report in minutes, seconds, days NOT 0.1 hours
13
13
  * TODO: [🧠] Maybe make from `uncertainNumberToHuman` separate exported utility
14
- * TODO: When negligible usage, report "Negligible" or just don't report it
15
14
  * TODO: [🧠] Maybe use "~" instead of "approximately"
16
15
  * TODO: [🏛] Maybe make some markdown builder
17
16
  */
@@ -1,22 +1,27 @@
1
1
  import type { string_mime_type } from '../../types/typeAliases';
2
2
  import type { string_name } from '../../types/typeAliases';
3
+ import type { string_SCREAMING_CASE } from '../../utils/normalization/normalizeTo_SCREAMING_CASE';
4
+ import type { empty_object } from '../../utils/organization/empty_object';
5
+ import type { FormatSubvalueDefinition } from './FormatSubvalueDefinition';
3
6
  /**
4
7
  * A format definition is a set of functions that define how to validate, heal and convert response from LLM
5
8
  *
9
+ * @@@ Describe setting vs schema
10
+ *
6
11
  * @see https://github.com/webgptorg/promptbook/discussions/36
7
12
  * @private still in development [🏢]
8
13
  */
9
- export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends string, TSchema extends object> = {
14
+ export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends string, TSettings extends empty_object, TSchema extends empty_object> = {
10
15
  /**
11
16
  * The name of the format used in .ptbk.md files
12
17
  *
13
18
  * @sample "JSON"
14
19
  */
15
- readonly name: string_name;
20
+ readonly formatName: string_name & string_SCREAMING_CASE;
16
21
  /**
17
- * Aliases for the name
22
+ * Aliases for the `formatName`
18
23
  */
19
- readonly aliases?: Array<string_name>;
24
+ readonly aliases?: Array<string_name & string_SCREAMING_CASE>;
20
25
  /**
21
26
  * The mime type of the format (if any)
22
27
  *
@@ -29,7 +34,7 @@ export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends
29
34
  * @param value The value to check, for example "{\"foo\": true}"
30
35
  * @param schema Optional schema to do extra validation
31
36
  */
32
- isValid(value: string, schema?: TSchema): value is TValue;
37
+ isValid(value: string, settings?: TSettings, schema?: TSchema): value is TValue;
33
38
  /**
34
39
  * Check if a first part of a value is valid
35
40
  *
@@ -38,7 +43,7 @@ export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends
38
43
  * @param partialValue Partial value to check, for example "{\"foo\": t"
39
44
  * @param schema Optional schema to do extra validation
40
45
  */
41
- canBeValid(partialValue: string, schema?: TSchema): partialValue is TPartialValue;
46
+ canBeValid(partialValue: string, settings?: TSettings, schema?: TSchema): partialValue is TPartialValue;
42
47
  /**
43
48
  * Heal a value to make it valid if possible
44
49
  *
@@ -49,17 +54,11 @@ export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends
49
54
  * @param scheme
50
55
  * @throws {Error} If the value cannot be healed
51
56
  */
52
- heal(value: string, scheme?: TSchema): TValue;
57
+ heal(value: string, settings?: TSettings, scheme?: TSchema): TValue;
53
58
  /**
54
- * Parses just the values and removes structural information
55
- *
56
- * Note: This is useful when you want to combine format expectations with counting words, characters,...
57
- *
58
- * @param value The value to check, for example "{\"name\": "John Smith"}"
59
- * @param schema Optional schema
60
- * @example "{\"name\": "John Smith"}" -> ["John Smith"]
59
+ * @@@
61
60
  */
62
- extractValues(value: string, schema?: TSchema): Array<string>;
61
+ readonly subvalueDefinitions: Array<FormatSubvalueDefinition<TValue, TSettings>>;
63
62
  };
64
63
  /**
65
64
  * TODO: [♏] Add some prepare hook to modify prompt according to the format
@@ -0,0 +1,31 @@
1
+ import type { Promisable } from 'type-fest';
2
+ import type { Parameters } from '../../types/typeAliases';
3
+ import type { string_parameter_name } from '../../types/typeAliases';
4
+ import type { string_name } from '../../types/typeAliases';
5
+ import type { string_SCREAMING_CASE } from '../../utils/normalization/normalizeTo_SCREAMING_CASE';
6
+ import type { empty_object } from '../../utils/organization/empty_object';
7
+ /**
8
+ * @@@
9
+ */
10
+ export type FormatSubvalueDefinition<TValue extends string, TSettings extends empty_object> = {
11
+ /**
12
+ * The name of the format used in .ptbk.md files
13
+ *
14
+ * @sample "CELL"
15
+ */
16
+ readonly subvalueName: string_name & string_SCREAMING_CASE;
17
+ /**
18
+ * Aliases for the `subvalueName`
19
+ */
20
+ readonly aliases?: Array<string_name & string_SCREAMING_CASE>;
21
+ /**
22
+ * Maps values
23
+ *
24
+ * For example, if you have a JSON object and you want to map all values to uppercase
25
+ * Or iterate over all CSV cells @@@
26
+ */
27
+ mapValues(value: TValue, outputParameterName: string_parameter_name, settings: TSettings, mapCallback: (subvalues: Parameters, index: number) => Promisable<string>): Promise<string>;
28
+ };
29
+ /**
30
+ * Note: [👩🏾‍🤝‍🧑🏽]
31
+ */
@@ -1,14 +1,17 @@
1
+ import type { TODO_any } from '../../utils/organization/TODO_any';
1
2
  import type { FormatDefinition } from '../_common/FormatDefinition';
3
+ import type { CsvSettings } from './CsvSettings';
2
4
  /**
3
5
  * Definition for CSV spreadsheet
4
6
  *
5
- * @private still in development [🏢]
7
+ * @public exported from `@promptbook/core`
8
+ * <- TODO: [🏢] Export from package `@promptbook/csv`
6
9
  */
7
- export declare const CsvFormatDefinition: FormatDefinition<string, string, object>;
10
+ export declare const CsvFormatDefinition: FormatDefinition<string, string, CsvSettings, TODO_any>;
8
11
  /**
9
12
  * TODO: [🍓] In `CsvFormatDefinition` implement simple `isValid`
10
13
  * TODO: [🍓] In `CsvFormatDefinition` implement partial `canBeValid`
11
14
  * TODO: [🍓] In `CsvFormatDefinition` implement `heal
12
- * TODO: [🍓] In `CsvFormatDefinition` implement `extractValues`
15
+ * TODO: [🍓] In `CsvFormatDefinition` implement `subvalueDefinitions`
13
16
  * TODO: [🏢] Allow to expect something inside CSV objects and other formats
14
17
  */
@@ -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
+ }
@@ -0,0 +1,13 @@
1
+ import type { ParseConfig, UnparseConfig } from 'papaparse';
2
+ /**
3
+ * @@@
4
+ */
5
+ export type CsvSettings = Pick<ParseConfig & UnparseConfig, 'delimiter' | 'quoteChar' | 'newline' | 'skipEmptyLines'>;
6
+ /**
7
+ * @@@
8
+ *
9
+ * @public exported from `@promptbook/core`
10
+ */
11
+ export declare const MANDATORY_CSV_SETTINGS: Readonly<{
12
+ readonly header: true;
13
+ }>;
@@ -3,4 +3,4 @@
3
3
  *
4
4
  * @private internal index of `...` <- TODO [🏢]
5
5
  */
6
- export declare const FORMAT_DEFINITIONS: import("./_common/FormatDefinition").FormatDefinition<string, string, object>[];
6
+ export declare const FORMAT_DEFINITIONS: readonly [import("./_common/FormatDefinition").FormatDefinition<string, string, any, any>, import("./_common/FormatDefinition").FormatDefinition<string, string, any, any>, import("./_common/FormatDefinition").FormatDefinition<string, string, any, any>, import("./_common/FormatDefinition").FormatDefinition<string, string, import("./csv/CsvSettings").CsvSettings, any>];
@@ -1,18 +1,19 @@
1
+ import type { TODO_any } from '../../utils/organization/TODO_any';
1
2
  import type { FormatDefinition } from '../_common/FormatDefinition';
2
3
  /**
3
4
  * Definition for JSON format
4
5
  *
5
6
  * @private still in development [🏢]
6
7
  */
7
- export declare const JsonFormatDefinition: FormatDefinition<string, string, object>;
8
+ export declare const JsonFormatDefinition: FormatDefinition<string, string, TODO_any, TODO_any>;
8
9
  /**
9
10
  * TODO: [🧠] Maybe propper instance of object
10
11
  * TODO: [0] Make string_serialized_json
11
- * TODO: [1] Make type for JSON Schema
12
+ * TODO: [1] Make type for JSON Settings and Schema
12
13
  * TODO: [🧠] What to use for validating JSONs - JSON Schema, ZoD, typescript types/interfaces,...?
13
14
  * TODO: [🍓] In `JsonFormatDefinition` implement simple `isValid`
14
15
  * TODO: [🍓] In `JsonFormatDefinition` implement partial `canBeValid`
15
16
  * TODO: [🍓] In `JsonFormatDefinition` implement `heal
16
- * TODO: [🍓] In `JsonFormatDefinition` implement `extractValues`
17
+ * TODO: [🍓] In `JsonFormatDefinition` implement `subvalueDefinitions`
17
18
  * TODO: [🏢] Allow to expect something inside JSON objects and other formats
18
19
  */
@@ -0,0 +1,19 @@
1
+ import type { TODO_any } from '../../utils/organization/TODO_any';
2
+ import type { FormatDefinition } from '../_common/FormatDefinition';
3
+ /**
4
+ * Definition for any text - this will be always valid
5
+ *
6
+ * Note: This is not useful for validation, but for splitting and mapping with `subvalueDefinitions`
7
+ *
8
+ * @public exported from `@promptbook/core`
9
+ */
10
+ export declare const TextFormatDefinition: FormatDefinition<string, string, TODO_any, TODO_any>;
11
+ /**
12
+ * TODO: [1] Make type for XML Text and Schema
13
+ * TODO: [🧠][🤠] Here should be all words, characters, lines, paragraphs, pages aviable as subvalues
14
+ * TODO: [🍓] In `TextFormatDefinition` implement simple `isValid`
15
+ * TODO: [🍓] In `TextFormatDefinition` implement partial `canBeValid`
16
+ * TODO: [🍓] In `TextFormatDefinition` implement `heal
17
+ * TODO: [🍓] In `TextFormatDefinition` implement `subvalueDefinitions`
18
+ * TODO: [🏢] Allow to expect something inside each item of list and other formats
19
+ */
@@ -1,18 +1,19 @@
1
+ import type { TODO_any } from '../../utils/organization/TODO_any';
1
2
  import type { FormatDefinition } from '../_common/FormatDefinition';
2
3
  /**
3
4
  * Definition for XML format
4
5
  *
5
6
  * @private still in development [🏢]
6
7
  */
7
- export declare const XmlFormatDefinition: FormatDefinition<string, string, object>;
8
+ export declare const XmlFormatDefinition: FormatDefinition<string, string, TODO_any, TODO_any>;
8
9
  /**
9
10
  * TODO: [🧠] Maybe propper instance of object
10
11
  * TODO: [0] Make string_serialized_xml
11
- * TODO: [1] Make type for XML Schema
12
+ * TODO: [1] Make type for XML Settings and Schema
12
13
  * TODO: [🧠] What to use for validating XMLs - XSD,...
13
14
  * TODO: [🍓] In `XmlFormatDefinition` implement simple `isValid`
14
15
  * TODO: [🍓] In `XmlFormatDefinition` implement partial `canBeValid`
15
16
  * TODO: [🍓] In `XmlFormatDefinition` implement `heal
16
- * TODO: [🍓] In `XmlFormatDefinition` implement `extractValues`
17
+ * TODO: [🍓] In `XmlFormatDefinition` implement `subvalueDefinitions`
17
18
  * TODO: [🏢] Allow to expect something inside XML and other formats
18
19
  */
@@ -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 */
@@ -0,0 +1,15 @@
1
+ import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
2
+ import type { LlmExecutionToolsWithTotalUsage } from '../utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
3
+ /**
4
+ * Returns LLM tools for CLI
5
+ *
6
+ * @private within the repository - for CLI utils
7
+ */
8
+ export declare function $provideLlmToolsForCli(options?: Pick<PrepareAndScrapeOptions, 'isCacheCleaned'>): LlmExecutionToolsWithTotalUsage;
9
+ /**
10
+ * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
11
+ * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
12
+ * TODO: [🥃] Allow `ptbk make` without llm tools
13
+ * TODO: This should be maybe not under `_common` but under `utils-internal` / `utils/internal`
14
+ * TODO: [®] DRY Register logic
15
+ */
@@ -1,6 +1,6 @@
1
- import '../../_packages/cli.index';
1
+ import '../../../_packages/cli.index';
2
+ import type { LlmExecutionToolsWithTotalUsage } from '../utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
2
3
  import type { CreateLlmToolsFromConfigurationOptions } from './createLlmToolsFromConfiguration';
3
- import type { LlmExecutionToolsWithTotalUsage } from './utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
4
4
  type GetLlmToolsForTestingAndScriptsAndPlaygroundOptions = CreateLlmToolsFromConfigurationOptions & {
5
5
  /**
6
6
  * @@@
@@ -14,10 +14,11 @@ type GetLlmToolsForTestingAndScriptsAndPlaygroundOptions = CreateLlmToolsFromCon
14
14
  *
15
15
  * @private within the repository - JUST FOR TESTS, SCRIPTS AND PLAYGROUND
16
16
  */
17
- export declare function getLlmToolsForTestingAndScriptsAndPlayground(options?: GetLlmToolsForTestingAndScriptsAndPlaygroundOptions): LlmExecutionToolsWithTotalUsage;
17
+ export declare function $provideLlmToolsForTestingAndScriptsAndPlayground(options?: GetLlmToolsForTestingAndScriptsAndPlaygroundOptions): LlmExecutionToolsWithTotalUsage;
18
18
  export {};
19
19
  /**
20
20
  * Note: [⚪] This should never be in any released package
21
21
  * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
22
22
  * TODO: This should be maybe not under `_common` but under `utils-internal` / `utils/internal`
23
+ * TODO: [®] DRY Register logic
23
24
  */