@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
@@ -7,16 +7,20 @@ import type { PipelineTemplateCommandParser } from '../commands/_common/types/Co
7
7
  import type { CommandParserInput } from '../commands/_common/types/CommandParser';
8
8
  import type { CommandUsagePlace } from '../commands/_common/types/CommandUsagePlaces';
9
9
  import type { ExpectCommand } from '../commands/EXPECT/ExpectCommand';
10
+ import type { ForeachJson } from '../commands/FOREACH/ForeachJson';
10
11
  import type { FormatCommand } from '../commands/FORMAT/FormatCommand';
11
12
  import type { TemplateType } from '../commands/TEMPLATE/TemplateTypes';
12
- import type { PipelineStringToJsonOptions } from '../conversion/pipelineStringToJson';
13
13
  import type { PrettifyOptions } from '../conversion/prettify/PrettifyOptions';
14
14
  import type { renderPipelineMermaidOptions } from '../conversion/prettify/renderPipelineMermaidOptions';
15
+ import type { CallbackInterfaceToolsOptions } from '../dialogs/callback/CallbackInterfaceToolsOptions';
15
16
  import type { ErrorJson } from '../errors/utils/ErrorJson';
16
17
  import type { AvailableModel } from '../execution/AvailableModel';
17
- import type { CommonExecutionToolsOptions } from '../execution/CommonExecutionToolsOptions';
18
+ import type { CommonToolsOptions } from '../execution/CommonToolsOptions';
19
+ import type { CreatePipelineExecutorOptions } from '../execution/createPipelineExecutor/00-CreatePipelineExecutorOptions';
20
+ import type { CreatePipelineExecutorSettings } from '../execution/createPipelineExecutor/00-CreatePipelineExecutorSettings';
18
21
  import type { EmbeddingVector } from '../execution/EmbeddingVector';
19
22
  import type { ExecutionTools } from '../execution/ExecutionTools';
23
+ import type { FilesystemTools } from '../execution/FilesystemTools';
20
24
  import type { LlmExecutionTools } from '../execution/LlmExecutionTools';
21
25
  import type { LlmExecutionToolsConstructor } from '../execution/LlmExecutionToolsConstructor';
22
26
  import type { PipelineExecutor } from '../execution/PipelineExecutor';
@@ -32,10 +36,11 @@ import type { ScriptExecutionToolsExecuteOptions } from '../execution/ScriptExec
32
36
  import type { UncertainNumber } from '../execution/UncertainNumber';
33
37
  import type { UserInterfaceTools } from '../execution/UserInterfaceTools';
34
38
  import type { UserInterfaceToolsPromptDialogOptions } from '../execution/UserInterfaceTools';
35
- import type { CallbackInterfaceToolsOptions } from '../knowledge/dialogs/callback/CallbackInterfaceToolsOptions';
36
- import type { LlmToolsConfiguration } from '../llm-providers/_common/LlmToolsConfiguration';
37
- import type { LlmToolsMetadata } from '../llm-providers/_common/LlmToolsMetadata';
38
- import type { LlmToolsOptions } from '../llm-providers/_common/LlmToolsOptions';
39
+ import type { FormatSubvalueDefinition } from '../formats/_common/FormatSubvalueDefinition';
40
+ import type { CsvSettings } from '../formats/csv/CsvSettings';
41
+ import type { LlmToolsConfiguration } from '../llm-providers/_common/register/LlmToolsConfiguration';
42
+ import type { LlmToolsMetadata } from '../llm-providers/_common/register/LlmToolsMetadata';
43
+ import type { LlmToolsOptions } from '../llm-providers/_common/register/LlmToolsOptions';
39
44
  import type { CacheItem } from '../llm-providers/_common/utils/cache/CacheItem';
40
45
  import type { CacheLlmToolsOptions } from '../llm-providers/_common/utils/cache/CacheLlmToolsOptions';
41
46
  import type { LlmExecutionToolsWithTotalUsage } from '../llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
@@ -61,11 +66,18 @@ import type { RemoteLlmExecutionToolsOptions } from '../llm-providers/remote/int
61
66
  import type { RemoteServerOptions } from '../llm-providers/remote/interfaces/RemoteServerOptions';
62
67
  import type { AnonymousRemoteServerOptions } from '../llm-providers/remote/interfaces/RemoteServerOptions';
63
68
  import type { CollectionRemoteServerOptions } from '../llm-providers/remote/interfaces/RemoteServerOptions';
64
- import type { PrepareOptions } from '../prepare/PrepareOptions';
69
+ import type { CollectionRemoteServerClientOptions } from '../llm-providers/remote/interfaces/RemoteServerOptions';
70
+ import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
71
+ import type { Converter } from '../scrapers/_common/Converter';
72
+ import type { ScraperAndConverterMetadata } from '../scrapers/_common/register/ScraperAndConverterMetadata';
73
+ import type { ScraperConstructor } from '../scrapers/_common/register/ScraperConstructor';
74
+ import type { Scraper } from '../scrapers/_common/Scraper';
75
+ import type { ScraperSourceHandler } from '../scrapers/_common/Scraper';
76
+ import type { ScraperIntermediateSource } from '../scrapers/_common/ScraperIntermediateSource';
65
77
  import type { JavascriptExecutionToolsOptions } from '../scripting/javascript/JavascriptExecutionToolsOptions';
66
78
  import type { PostprocessingFunction } from '../scripting/javascript/JavascriptExecutionToolsOptions';
67
79
  import type { PromptbookStorage } from '../storage/_common/PromptbookStorage';
68
- import type { FilesStorageOptions } from '../storage/files-storage/FilesStorageOptions';
80
+ import type { FileCacheStorageOptions } from '../storage/file-cache-storage/FileCacheStorageOptions';
69
81
  import type { ExecutionPromptReportJson } from '../types/execution-report/ExecutionPromptReportJson';
70
82
  import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
71
83
  import type { ExecutionReportString } from '../types/execution-report/ExecutionReportString';
@@ -148,27 +160,27 @@ import type { string_data_url } from '../types/typeAliases';
148
160
  import type { string_base64 } from '../types/typeAliases';
149
161
  import type { string_href } from '../types/typeAliases';
150
162
  import type { string_url_image } from '../types/typeAliases';
163
+ import type { string_executable_path } from '../types/typeAliases';
151
164
  import type { string_uri } from '../types/typeAliases';
152
165
  import type { string_uri_part } from '../types/typeAliases';
153
- import type { string_uriid } from '../types/typeAliases';
154
166
  import type { string_hostname } from '../types/typeAliases';
155
167
  import type { string_host } from '../types/typeAliases';
156
168
  import type { string_protocol } from '../types/typeAliases';
157
169
  import type { string_email } from '../types/typeAliases';
158
170
  import type { string_emails } from '../types/typeAliases';
159
171
  import type { string_uuid } from '../types/typeAliases';
172
+ import type { string_app_id } from '../types/typeAliases';
160
173
  import type { string_user_id } from '../types/typeAliases';
161
174
  import type { string_sha256 } from '../types/typeAliases';
162
175
  import type { string_semantic_version } from '../types/typeAliases';
163
176
  import type { string_version_dependency } from '../types/typeAliases';
164
177
  import type { string_file_extension } from '../types/typeAliases';
165
- import type { string_file_absolute_path } from '../types/typeAliases';
166
- import type { string_file_relative_path } from '../types/typeAliases';
167
- import type { string_file_path } from '../types/typeAliases';
168
- import type { string_folder_absolute_path } from '../types/typeAliases';
169
- import type { string_folder_relative_path } from '../types/typeAliases';
170
- import type { string_folder_path } from '../types/typeAliases';
178
+ import type { string_absolute_filename } from '../types/typeAliases';
179
+ import type { string_relative_filename } from '../types/typeAliases';
171
180
  import type { string_filename } from '../types/typeAliases';
181
+ import type { string_absolute_dirname } from '../types/typeAliases';
182
+ import type { string_relative_dirname } from '../types/typeAliases';
183
+ import type { string_dirname } from '../types/typeAliases';
172
184
  import type { string_person_fullname } from '../types/typeAliases';
173
185
  import type { string_person_profile } from '../types/typeAliases';
174
186
  import type { string_license } from '../types/typeAliases';
@@ -180,6 +192,7 @@ import type { string_translate_name_not_normalized } from '../types/typeAliases'
180
192
  import type { string_translate_language } from '../types/typeAliases';
181
193
  import type { string_javascript_name } from '../types/typeAliases';
182
194
  import type { string_postprocessing_function_name } from '../types/typeAliases';
195
+ import type { id } from '../types/typeAliases';
183
196
  import type { string_token } from '../types/typeAliases';
184
197
  import type { string_license_token } from '../types/typeAliases';
185
198
  import type { string_password } from '../types/typeAliases';
@@ -211,6 +224,9 @@ import type { number_megabytes } from '../types/typeAliases';
211
224
  import type { number_gigabytes } from '../types/typeAliases';
212
225
  import type { number_terabytes } from '../types/typeAliases';
213
226
  import type { Registered } from '../utils/$Register';
227
+ import type { Registration } from '../utils/$Register';
228
+ import type { IExecCommandOptions } from '../utils/execCommand/IExecCommandOptions';
229
+ import type { IExecCommandOptionsAdvanced } from '../utils/execCommand/IExecCommandOptions';
214
230
  import type { FromtoItems } from '../utils/FromtoItems';
215
231
  import type { CodeBlock } from '../utils/markdown/extractAllBlocksFromMarkdown';
216
232
  import type { MarkdownSection } from '../utils/markdown/parseMarkdownSection';
@@ -221,6 +237,7 @@ import type { string_camelCase } from '../utils/normalization/normalizeTo_camelC
221
237
  import type { string_PascalCase } from '../utils/normalization/normalizeTo_PascalCase';
222
238
  import type { string_SCREAMING_CASE } from '../utils/normalization/normalizeTo_SCREAMING_CASE';
223
239
  import type { string_snake_case } from '../utils/normalization/normalizeTo_snake_case';
240
+ import type { empty_object } from '../utils/organization/empty_object';
224
241
  import type { really_any } from '../utils/organization/really_any';
225
242
  import type { TODO_any } from '../utils/organization/TODO_any';
226
243
  import type { string_promptbook_version } from '../version';
@@ -233,16 +250,20 @@ export type { PipelineTemplateCommandParser };
233
250
  export type { CommandParserInput };
234
251
  export type { CommandUsagePlace };
235
252
  export type { ExpectCommand };
253
+ export type { ForeachJson };
236
254
  export type { FormatCommand };
237
255
  export type { TemplateType };
238
- export type { PipelineStringToJsonOptions };
239
256
  export type { PrettifyOptions };
240
257
  export type { renderPipelineMermaidOptions };
258
+ export type { CallbackInterfaceToolsOptions };
241
259
  export type { ErrorJson };
242
260
  export type { AvailableModel };
243
- export type { CommonExecutionToolsOptions };
261
+ export type { CommonToolsOptions };
262
+ export type { CreatePipelineExecutorOptions };
263
+ export type { CreatePipelineExecutorSettings };
244
264
  export type { EmbeddingVector };
245
265
  export type { ExecutionTools };
266
+ export type { FilesystemTools };
246
267
  export type { LlmExecutionTools };
247
268
  export type { LlmExecutionToolsConstructor };
248
269
  export type { PipelineExecutor };
@@ -258,7 +279,8 @@ export type { ScriptExecutionToolsExecuteOptions };
258
279
  export type { UncertainNumber };
259
280
  export type { UserInterfaceTools };
260
281
  export type { UserInterfaceToolsPromptDialogOptions };
261
- export type { CallbackInterfaceToolsOptions };
282
+ export type { FormatSubvalueDefinition };
283
+ export type { CsvSettings };
262
284
  export type { LlmToolsConfiguration };
263
285
  export type { LlmToolsMetadata };
264
286
  export type { LlmToolsOptions };
@@ -287,11 +309,18 @@ export type { RemoteLlmExecutionToolsOptions };
287
309
  export type { RemoteServerOptions };
288
310
  export type { AnonymousRemoteServerOptions };
289
311
  export type { CollectionRemoteServerOptions };
290
- export type { PrepareOptions };
312
+ export type { CollectionRemoteServerClientOptions };
313
+ export type { PrepareAndScrapeOptions };
314
+ export type { Converter };
315
+ export type { ScraperAndConverterMetadata };
316
+ export type { ScraperConstructor };
317
+ export type { Scraper };
318
+ export type { ScraperSourceHandler };
319
+ export type { ScraperIntermediateSource };
291
320
  export type { JavascriptExecutionToolsOptions };
292
321
  export type { PostprocessingFunction };
293
322
  export type { PromptbookStorage };
294
- export type { FilesStorageOptions };
323
+ export type { FileCacheStorageOptions };
295
324
  export type { ExecutionPromptReportJson };
296
325
  export type { ExecutionReportJson };
297
326
  export type { ExecutionReportString };
@@ -374,27 +403,27 @@ export type { string_data_url };
374
403
  export type { string_base64 };
375
404
  export type { string_href };
376
405
  export type { string_url_image };
406
+ export type { string_executable_path };
377
407
  export type { string_uri };
378
408
  export type { string_uri_part };
379
- export type { string_uriid };
380
409
  export type { string_hostname };
381
410
  export type { string_host };
382
411
  export type { string_protocol };
383
412
  export type { string_email };
384
413
  export type { string_emails };
385
414
  export type { string_uuid };
415
+ export type { string_app_id };
386
416
  export type { string_user_id };
387
417
  export type { string_sha256 };
388
418
  export type { string_semantic_version };
389
419
  export type { string_version_dependency };
390
420
  export type { string_file_extension };
391
- export type { string_file_absolute_path };
392
- export type { string_file_relative_path };
393
- export type { string_file_path };
394
- export type { string_folder_absolute_path };
395
- export type { string_folder_relative_path };
396
- export type { string_folder_path };
421
+ export type { string_absolute_filename };
422
+ export type { string_relative_filename };
397
423
  export type { string_filename };
424
+ export type { string_absolute_dirname };
425
+ export type { string_relative_dirname };
426
+ export type { string_dirname };
398
427
  export type { string_person_fullname };
399
428
  export type { string_person_profile };
400
429
  export type { string_license };
@@ -406,6 +435,7 @@ export type { string_translate_name_not_normalized };
406
435
  export type { string_translate_language };
407
436
  export type { string_javascript_name };
408
437
  export type { string_postprocessing_function_name };
438
+ export type { id };
409
439
  export type { string_token };
410
440
  export type { string_license_token };
411
441
  export type { string_password };
@@ -437,6 +467,9 @@ export type { number_megabytes };
437
467
  export type { number_gigabytes };
438
468
  export type { number_terabytes };
439
469
  export type { Registered };
470
+ export type { Registration };
471
+ export type { IExecCommandOptions };
472
+ export type { IExecCommandOptionsAdvanced };
440
473
  export type { FromtoItems };
441
474
  export type { CodeBlock };
442
475
  export type { MarkdownSection };
@@ -447,6 +480,7 @@ export type { string_camelCase };
447
480
  export type { string_PascalCase };
448
481
  export type { string_SCREAMING_CASE };
449
482
  export type { string_snake_case };
483
+ export type { empty_object };
450
484
  export type { really_any };
451
485
  export type { TODO_any };
452
486
  export type { string_promptbook_version };
@@ -20,7 +20,6 @@ import { splitIntoSentences } from '../utils/expectation-counters/countSentences
20
20
  import { countSentences } from '../utils/expectation-counters/countSentences';
21
21
  import { countWords } from '../utils/expectation-counters/countWords';
22
22
  import { CountUtils } from '../utils/expectation-counters/index';
23
- import { extractParameterNames } from '../utils/extractParameterNames';
24
23
  import { capitalize } from '../utils/normalization/capitalize';
25
24
  import { decapitalize } from '../utils/normalization/decapitalize';
26
25
  import { DIACRITIC_VARIANTS_LETTERS } from '../utils/normalization/DIACRITIC_VARIANTS_LETTERS';
@@ -43,11 +42,12 @@ import { parseKeywords } from '../utils/normalization/parseKeywords';
43
42
  import { parseKeywordsFromString } from '../utils/normalization/parseKeywordsFromString';
44
43
  import { removeDiacritics } from '../utils/normalization/removeDiacritics';
45
44
  import { searchKeywords } from '../utils/normalization/searchKeywords';
45
+ import { extractParameterNames } from '../utils/parameters/extractParameterNames';
46
+ import { replaceParameters } from '../utils/parameters/replaceParameters';
46
47
  import { parseNumber } from '../utils/parseNumber';
47
48
  import { $randomSeed } from '../utils/random/$randomSeed';
48
49
  import { removeEmojis } from '../utils/removeEmojis';
49
50
  import { removeQuotes } from '../utils/removeQuotes';
50
- import { replaceParameters } from '../utils/replaceParameters';
51
51
  import { $deepFreeze } from '../utils/serialization/$deepFreeze';
52
52
  import { checkSerializableAsJson } from '../utils/serialization/checkSerializableAsJson';
53
53
  import { clonePipeline } from '../utils/serialization/clonePipeline';
@@ -91,7 +91,6 @@ export { splitIntoSentences };
91
91
  export { countSentences };
92
92
  export { countWords };
93
93
  export { CountUtils };
94
- export { extractParameterNames };
95
94
  export { capitalize };
96
95
  export { decapitalize };
97
96
  export { DIACRITIC_VARIANTS_LETTERS };
@@ -114,11 +113,12 @@ export { parseKeywords };
114
113
  export { parseKeywordsFromString };
115
114
  export { removeDiacritics };
116
115
  export { searchKeywords };
116
+ export { extractParameterNames };
117
+ export { replaceParameters };
117
118
  export { parseNumber };
118
119
  export { $randomSeed };
119
120
  export { removeEmojis };
120
121
  export { removeQuotes };
121
- export { replaceParameters };
122
122
  export { $deepFreeze };
123
123
  export { checkSerializableAsJson };
124
124
  export { clonePipeline };
@@ -0,0 +1,8 @@
1
+ import { PROMPTBOOK_VERSION } from '../version';
2
+ import { createWebsiteScraper } from '../scrapers/website/createWebsiteScraper';
3
+ import { _WebsiteScraperRegistration } from '../scrapers/website/register-constructor';
4
+ import { WebsiteScraper } from '../scrapers/website/WebsiteScraper';
5
+ export { PROMPTBOOK_VERSION };
6
+ export { createWebsiteScraper };
7
+ export { _WebsiteScraperRegistration };
8
+ export { WebsiteScraper };
@@ -7,5 +7,5 @@ import type { Command as Program } from 'commander';
7
7
  export declare function initializeAboutCommand(program: Program): void;
8
8
  /**
9
9
  * TODO: [🗽] Unite branding and make single place for it
10
- * Note: [🟡] This code should never be published outside of `@promptbook/cli`
10
+ * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
11
11
  */
@@ -6,5 +6,6 @@ import type { Command as Program } from 'commander';
6
6
  */
7
7
  export declare function initializeHelloCommand(program: Program): void;
8
8
  /**
9
- * Note: [🟡] This code should never be published outside of `@promptbook/cli`
9
+ * TODO: [🧠][🐣] Make here some easter egg with generated hello greeting via LLM models
10
+ * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
10
11
  */
@@ -9,6 +9,6 @@ export declare function initializeMakeCommand(program: Program): void;
9
9
  * TODO: [🥃][main] !!! Allow `ptbk make` without configuring any llm tools
10
10
  * TODO: Maybe remove this command - "about" command should be enough?
11
11
  * TODO: [0] DRY Javascript and typescript - Maybe make ONLY typescript and for javascript just remove types
12
- * Note: [🟡] This code should never be published outside of `@promptbook/cli`
12
+ * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
13
13
  * TODO: [🖇] What about symlinks? Maybe flag --follow-symlinks
14
14
  */
@@ -6,6 +6,7 @@ import type { Command as Program } from 'commander';
6
6
  */
7
7
  export declare function initializePrettifyCommand(program: Program): void;
8
8
  /**
9
- * Note: [🟡] This code should never be published outside of `@promptbook/cli`
9
+ * TODO: [😶] Unite floder listing
10
+ * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
10
11
  * TODO: [🖇] What about symlinks? Maybe flag --follow-symlinks
11
12
  */
@@ -0,0 +1,13 @@
1
+ import type { Command as Program } from 'commander';
2
+ /**
3
+ * Initializes `test` command for Promptbook CLI utilities
4
+ *
5
+ * @private internal function of `promptbookCli`
6
+ */
7
+ export declare function initializeTestCommand(program: Program): void;
8
+ /**
9
+ * TODO: [😶] Unite floder listing
10
+ * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
11
+ * TODO: [🖇] What about symlinks? Maybe flag --follow-symlinks
12
+ * Note: This is named "test-command.ts" to avoid name collision with jest unit test files
13
+ */
@@ -8,5 +8,5 @@ export declare const _CLI: {
8
8
  _initialize: typeof promptbookCli;
9
9
  };
10
10
  /**
11
- * Note: [🟡] This code should never be published outside of `@promptbook/cli`
11
+ * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
12
12
  */
@@ -8,5 +8,5 @@ export declare function promptbookCli(): Promise<void>;
8
8
  * TODO: [🥠] Do not export, its just for CLI script
9
9
  * TODO: [🕌] When more functionalities, rename
10
10
  * Note: 11:11
11
- * Note: [🟡] This code should never be published outside of `@promptbook/cli`
11
+ * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
12
12
  */
@@ -1,10 +1,14 @@
1
- import type { PipelineStringToJsonOptions } from '../../conversion/pipelineStringToJson';
2
- import type { string_folder_path } from '../../types/typeAliases';
1
+ import type { ExecutionTools } from '../../execution/ExecutionTools';
2
+ import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
3
+ import type { string_dirname } from '../../types/typeAliases';
3
4
  import type { PipelineCollection } from '../PipelineCollection';
4
5
  /**
5
6
  * Options for `createCollectionFromDirectory` function
7
+ *
8
+ * Note: `rootDirname` is not needed because it is the folder in which `.ptbk.md` file is located
9
+ * This is not same as `path` which is the first argument of `createCollectionFromDirectory` - it can be a subfolder
6
10
  */
7
- type CreatePipelineCollectionFromDirectoryOptions = PipelineStringToJsonOptions & {
11
+ type CreatePipelineCollectionFromDirectoryOptions = Omit<PrepareAndScrapeOptions, 'rootDirname'> & {
8
12
  /**
9
13
  * If true, the directory is searched recursively for pipelines
10
14
  *
@@ -37,13 +41,14 @@ type CreatePipelineCollectionFromDirectoryOptions = PipelineStringToJsonOptions
37
41
  * Note: Works only in Node.js environment because it reads the file system
38
42
  *
39
43
  * @param path - path to the directory with pipelines
40
- * @param options - Misc options for the collection
44
+ * @param tools - Execution tools to be used for pipeline preparation if needed - If not provided, `$provideExecutionToolsForNode` will be used
45
+ * @param options - Options for the collection creation
41
46
  * @returns PipelineCollection
42
47
  * @public exported from `@promptbook/node`
43
48
  */
44
- export declare function createCollectionFromDirectory(path: string_folder_path, options?: CreatePipelineCollectionFromDirectoryOptions): Promise<PipelineCollection>;
49
+ export declare function createCollectionFromDirectory(path: string_dirname, tools?: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options?: CreatePipelineCollectionFromDirectoryOptions): Promise<PipelineCollection>;
45
50
  export {};
46
51
  /**
47
- * Note: [🟢] This code should never be published outside of `@promptbook/node` and `@promptbook/cli` and `@promptbook/cli`
48
52
  * TODO: [🖇] What about symlinks? Maybe option isSymlinksFollowed
53
+ * TODO: Maybe move from `@promptbook/node` to `@promptbook/core` as we removes direct dependency on `fs`
49
54
  */
@@ -25,5 +25,5 @@ type CreatePipelineCollectionFromUrlyOptions = {
25
25
  export declare function createCollectionFromUrl(url: string_url | URL, options: CreatePipelineCollectionFromUrlyOptions): Promise<PipelineCollection>;
26
26
  export {};
27
27
  /**
28
- * TODO:[main] !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
28
+ * TODO: [main] !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
29
29
  */
@@ -3,7 +3,7 @@ import type { ExpectCommand } from './ExpectCommand';
3
3
  /**
4
4
  * Parses the expect command
5
5
  *
6
- * @see ./EXPECT-README.md for more details
6
+ * @see `documentationUrl` for more details
7
7
  * @private within the commands folder
8
8
  */
9
9
  export declare const expectCommandParser: PipelineTemplateCommandParser<ExpectCommand>;
@@ -1,9 +1,10 @@
1
+ import type { ForeachJson } from './ForeachJson';
1
2
  /**
2
- * Parsed FOREACH command <- Write [🍭]
3
+ * Parsed FOREACH command which is used to iterate over a table of values
3
4
  *
4
5
  * @see ./foreachCommandParser.ts for more details
5
6
  * @private within the commands folder
6
7
  */
7
8
  export type ForeachCommand = {
8
9
  readonly type: 'FOREACH';
9
- };
10
+ } & ForeachJson;
@@ -0,0 +1,27 @@
1
+ import type { string_parameter_name } from '../../types/typeAliases';
2
+ import type { TODO_string } from '../../utils/organization/TODO_string';
3
+ /**
4
+ * @@@
5
+ */
6
+ export type ForeachJson = {
7
+ /**
8
+ * @@@
9
+ */
10
+ readonly formatName: TODO_string;
11
+ /**
12
+ * @@@
13
+ */
14
+ readonly subformatName: TODO_string;
15
+ /**
16
+ * @@@
17
+ */
18
+ readonly parameterName: string_parameter_name;
19
+ /**
20
+ * @@@
21
+ */
22
+ readonly inputSubparameterNames: Array<string_parameter_name>;
23
+ /**
24
+ * @@@
25
+ */
26
+ readonly outputSubparameterName: string_parameter_name;
27
+ };
@@ -5,10 +5,10 @@ import type { ForeachCommand } from './ForeachCommand';
5
5
  *
6
6
  * Note: @@@ This command is used as foreach for new commands - it should NOT be used in any `.ptbk.md` file
7
7
  *
8
- * @see ./FOREACH-README.md for more details <- TODO: @@@ Write theese README files OR remove this link + add annotation here (to all commands)
8
+ * @see `documentationUrl` for more details
9
9
  * @private within the commands folder
10
10
  */
11
11
  export declare const foreachCommandParser: PipelineTemplateCommandParser<ForeachCommand>;
12
12
  /**
13
- * TODO: [🍭] Make .ptbk.md file with examples of the FOREACH command and also with wrong parsing and logic
13
+ * TODO: [🍭] Make .ptbk.md file with examples of the FOREACH with wrong parsing and logic
14
14
  */
@@ -3,7 +3,7 @@ import type { FormatCommand } from './FormatCommand';
3
3
  /**
4
4
  * Parses the format command
5
5
  *
6
- * @see ./FORMAT-README.md for more details
6
+ * @see `documentationUrl` for more details
7
7
  * @private within the commands folder
8
8
  */
9
9
  export declare const formatCommandParser: PipelineTemplateCommandParser<FormatCommand>;
@@ -3,7 +3,7 @@ import type { JokerCommand } from './JokerCommand';
3
3
  /**
4
4
  * Parses the joker command
5
5
  *
6
- * @see ./JOKER-README.md for more details
6
+ * @see `documentationUrl` for more details
7
7
  * @private within the commands folder
8
8
  */
9
9
  export declare const jokerCommandParser: PipelineTemplateCommandParser<JokerCommand>;
@@ -3,7 +3,7 @@ import type { KnowledgeCommand } from './KnowledgeCommand';
3
3
  /**
4
4
  * Parses the knowledge command
5
5
  *
6
- * @see ./KNOWLEDGE-README.md for more details
6
+ * @see `documentationUrl` for more details
7
7
  * @private within the commands folder
8
8
  */
9
9
  export declare const knowledgeCommandParser: PipelineHeadCommandParser<KnowledgeCommand>;
@@ -0,0 +1,11 @@
1
+ import type { string_knowledge_source_content } from '../../../types/typeAliases';
2
+ import type { string_name } from '../../../types/typeAliases';
3
+ /**
4
+ * Creates unique name for the source
5
+ *
6
+ * @private within the repository
7
+ */
8
+ export declare function sourceContentToName(sourceContent: string_knowledge_source_content): string_name;
9
+ /**
10
+ * TODO: [🐱‍🐉][🧠] Make some smart crop NOT source-i-m-pavol-a-develop-... BUT source-i-m-pavol-a-developer-...
11
+ */
@@ -0,0 +1,4 @@
1
+ export {};
2
+ /**
3
+ * TODO: [🐱‍🐉][🧠] Make some smart crop NOT source-i-m-pavol-a-develop-... BUT source-i-m-pavol-a-developer-...
4
+ */
@@ -3,7 +3,7 @@ import type { ModelCommand } from './ModelCommand';
3
3
  /**
4
4
  * Parses the model command
5
5
  *
6
- * @see ./MODEL-README.md for more details
6
+ * @see `documentationUrl` for more details
7
7
  * @private within the commands folder
8
8
  */
9
9
  export declare const modelCommandParser: PipelineBothCommandParser<ModelCommand>;
@@ -3,7 +3,7 @@ import type { ParameterCommand } from './ParameterCommand';
3
3
  /**
4
4
  * Parses the parameter command
5
5
  *
6
- * @see ./PARAMETER-README.md for more details
6
+ * @see `documentationUrl` for more details
7
7
  * @private within the commands folder
8
8
  */
9
9
  export declare const parameterCommandParser: PipelineBothCommandParser<ParameterCommand>;
@@ -3,7 +3,7 @@ import type { PersonaCommand } from './PersonaCommand';
3
3
  /**
4
4
  * Parses the persona command
5
5
  *
6
- * @see ./PERSONA-README.md for more details
6
+ * @see `documentationUrl` for more details
7
7
  * @private within the commands folder
8
8
  */
9
9
  export declare const personaCommandParser: PipelineBothCommandParser<PersonaCommand>;
@@ -3,7 +3,7 @@ import type { PostprocessCommand } from './PostprocessCommand';
3
3
  /**
4
4
  * Parses the postprocess command
5
5
  *
6
- * @see ./POSTPROCESS-README.md for more details
6
+ * @see `documentationUrl` for more details
7
7
  * @private within the commands folder
8
8
  */
9
9
  export declare const postprocessCommandParser: PipelineTemplateCommandParser<PostprocessCommand>;
@@ -3,7 +3,7 @@ import type { PromptbookVersionCommand } from './PromptbookVersionCommand';
3
3
  /**
4
4
  * Parses the PROMPTBOOK_VERSION command
5
5
  *
6
- * @see ./PROMPTBOOK_VERSION-README.md for more details
6
+ * @see `documentationUrl` for more details
7
7
  * @private within the commands folder
8
8
  */
9
9
  export declare const promptbookVersionCommandParser: PipelineHeadCommandParser<PromptbookVersionCommand>;
@@ -3,7 +3,7 @@ import type { TemplateCommand } from './TemplateCommand';
3
3
  /**
4
4
  * Parses the template command
5
5
  *
6
- * @see ./TEMPLATE-README.md for more details
6
+ * @see `documentationUrl` for more details
7
7
  * @private within the commands folder
8
8
  */
9
9
  export declare const templateCommandParser: PipelineTemplateCommandParser<TemplateCommand>;
@@ -3,7 +3,7 @@ import type { UrlCommand } from './UrlCommand';
3
3
  /**
4
4
  * Parses the url command
5
5
  *
6
- * @see ./URL-README.md for more details
6
+ * @see `documentationUrl` for more details
7
7
  * @private within the commands folder
8
8
  */
9
9
  export declare const urlCommandParser: PipelineHeadCommandParser<UrlCommand>;
@@ -3,7 +3,7 @@ import type { ActionCommand } from './ActionCommand';
3
3
  /**
4
4
  * Parses the action command
5
5
  *
6
- * @see ./ACTION-README.md for more details
6
+ * @see `documentationUrl` for more details
7
7
  * @private within the commands folder
8
8
  */
9
9
  export declare const actionCommandParser: PipelineHeadCommandParser<ActionCommand>;
@@ -3,7 +3,7 @@ import type { InstrumentCommand } from './InstrumentCommand';
3
3
  /**
4
4
  * Parses the instrument command
5
5
  *
6
- * @see ./INSTRUMENT-README.md for more details
6
+ * @see `documentationUrl` for more details
7
7
  * @private within the commands folder
8
8
  */
9
9
  export declare const instrumentCommandParser: PipelineHeadCommandParser<InstrumentCommand>;
@@ -5,7 +5,7 @@ import type { BoilerplateCommand } from './BoilerplateCommand';
5
5
  *
6
6
  * Note: @@@ This command is used as boilerplate for new commands - it should NOT be used in any `.ptbk.md` file
7
7
  *
8
- * @see ./BOILERPLATE-README.md for more details <- TODO: @@@ Write theese README files OR remove this link + add annotation here (to all commands)
8
+ * @see `documentationUrl` for more details
9
9
  * @private within the commands folder
10
10
  */
11
11
  export declare const boilerplateCommandParser: PipelineBothCommandParser<BoilerplateCommand>;