@promptbook/wizard 0.95.0

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 (738) hide show
  1. package/README.md +482 -0
  2. package/esm/index.es.js +16649 -0
  3. package/esm/index.es.js.map +1 -0
  4. package/esm/typings/books/index.d.ts +131 -0
  5. package/esm/typings/servers.d.ts +40 -0
  6. package/esm/typings/src/_packages/anthropic-claude.index.d.ts +16 -0
  7. package/esm/typings/src/_packages/azure-openai.index.d.ts +10 -0
  8. package/esm/typings/src/_packages/browser.index.d.ts +12 -0
  9. package/esm/typings/src/_packages/cli.index.d.ts +60 -0
  10. package/esm/typings/src/_packages/core.index.d.ts +296 -0
  11. package/esm/typings/src/_packages/deepseek.index.d.ts +10 -0
  12. package/esm/typings/src/_packages/documents.index.d.ts +8 -0
  13. package/esm/typings/src/_packages/editable.index.d.ts +90 -0
  14. package/esm/typings/src/_packages/fake-llm.index.d.ts +6 -0
  15. package/esm/typings/src/_packages/google.index.d.ts +12 -0
  16. package/esm/typings/src/_packages/javascript.index.d.ts +10 -0
  17. package/esm/typings/src/_packages/legacy-documents.index.d.ts +8 -0
  18. package/esm/typings/src/_packages/markdown-utils.index.d.ts +48 -0
  19. package/esm/typings/src/_packages/markitdown.index.d.ts +8 -0
  20. package/esm/typings/src/_packages/node.index.d.ts +24 -0
  21. package/esm/typings/src/_packages/ollama.index.d.ts +14 -0
  22. package/esm/typings/src/_packages/openai.index.d.ts +22 -0
  23. package/esm/typings/src/_packages/pdf.index.d.ts +14 -0
  24. package/esm/typings/src/_packages/remote-client.index.d.ts +16 -0
  25. package/esm/typings/src/_packages/remote-server.index.d.ts +12 -0
  26. package/esm/typings/src/_packages/templates.index.d.ts +4 -0
  27. package/esm/typings/src/_packages/types.index.d.ts +598 -0
  28. package/esm/typings/src/_packages/utils.index.d.ts +170 -0
  29. package/esm/typings/src/_packages/vercel.index.d.ts +6 -0
  30. package/esm/typings/src/_packages/website-crawler.index.d.ts +8 -0
  31. package/esm/typings/src/_packages/wizard.index.d.ts +60 -0
  32. package/esm/typings/src/cli/cli-commands/_boilerplate.d.ts +13 -0
  33. package/esm/typings/src/cli/cli-commands/about.d.ts +14 -0
  34. package/esm/typings/src/cli/cli-commands/common/handleActionErrors.d.ts +11 -0
  35. package/esm/typings/src/cli/cli-commands/hello.d.ts +14 -0
  36. package/esm/typings/src/cli/cli-commands/list-models.d.ts +13 -0
  37. package/esm/typings/src/cli/cli-commands/list-scrapers.d.ts +13 -0
  38. package/esm/typings/src/cli/cli-commands/login.d.ts +14 -0
  39. package/esm/typings/src/cli/cli-commands/make.d.ts +16 -0
  40. package/esm/typings/src/cli/cli-commands/prettify.d.ts +15 -0
  41. package/esm/typings/src/cli/cli-commands/run.d.ts +17 -0
  42. package/esm/typings/src/cli/cli-commands/runInteractiveChatbot.d.ts +32 -0
  43. package/esm/typings/src/cli/cli-commands/start-server.d.ts +13 -0
  44. package/esm/typings/src/cli/cli-commands/test-command.d.ts +16 -0
  45. package/esm/typings/src/cli/common/$addGlobalOptionsToCommand.d.ts +7 -0
  46. package/esm/typings/src/cli/common/$provideLlmToolsForCli.d.ts +28 -0
  47. package/esm/typings/src/cli/main.d.ts +16 -0
  48. package/esm/typings/src/cli/promptbookCli.d.ts +13 -0
  49. package/esm/typings/src/cli/test/ptbk.d.ts +5 -0
  50. package/esm/typings/src/cli/test/ptbk.test.d.ts +1 -0
  51. package/esm/typings/src/collection/PipelineCollection.d.ts +25 -0
  52. package/esm/typings/src/collection/SimplePipelineCollection.d.ts +37 -0
  53. package/esm/typings/src/collection/collectionToJson.d.ts +13 -0
  54. package/esm/typings/src/collection/collectionToJson.test.d.ts +7 -0
  55. package/esm/typings/src/collection/constructors/createCollectionFromDirectory.d.ts +65 -0
  56. package/esm/typings/src/collection/constructors/createCollectionFromDirectory.test.d.ts +1 -0
  57. package/esm/typings/src/collection/constructors/createCollectionFromJson.d.ts +13 -0
  58. package/esm/typings/src/collection/constructors/createCollectionFromJson.test.d.ts +1 -0
  59. package/esm/typings/src/collection/constructors/createCollectionFromPromise.d.ts +23 -0
  60. package/esm/typings/src/collection/constructors/createCollectionFromPromise.test.d.ts +1 -0
  61. package/esm/typings/src/collection/constructors/createCollectionFromUrl.d.ts +29 -0
  62. package/esm/typings/src/collection/constructors/createSubcollection.d.ts +13 -0
  63. package/esm/typings/src/commands/BOOK_VERSION/BookVersionCommand.d.ts +11 -0
  64. package/esm/typings/src/commands/BOOK_VERSION/bookVersionCommand.test.d.ts +1 -0
  65. package/esm/typings/src/commands/BOOK_VERSION/bookVersionCommandParser.d.ts +9 -0
  66. package/esm/typings/src/commands/EXPECT/ExpectCommand.d.ts +17 -0
  67. package/esm/typings/src/commands/EXPECT/expectCommand.test.d.ts +1 -0
  68. package/esm/typings/src/commands/EXPECT/expectCommandParser.d.ts +11 -0
  69. package/esm/typings/src/commands/FOREACH/ForeachCommand.d.ts +10 -0
  70. package/esm/typings/src/commands/FOREACH/ForeachJson.d.ts +27 -0
  71. package/esm/typings/src/commands/FOREACH/foreachCommand.test.d.ts +1 -0
  72. package/esm/typings/src/commands/FOREACH/foreachCommandParser.d.ts +12 -0
  73. package/esm/typings/src/commands/FORMAT/FormatCommand.d.ts +9 -0
  74. package/esm/typings/src/commands/FORMAT/formatCommand.test.d.ts +1 -0
  75. package/esm/typings/src/commands/FORMAT/formatCommandParser.d.ts +9 -0
  76. package/esm/typings/src/commands/FORMFACTOR/FormfactorCommand.d.ts +11 -0
  77. package/esm/typings/src/commands/FORMFACTOR/formfactorCommand.test.d.ts +1 -0
  78. package/esm/typings/src/commands/FORMFACTOR/formfactorCommandParser.d.ts +11 -0
  79. package/esm/typings/src/commands/JOKER/JokerCommand.d.ts +11 -0
  80. package/esm/typings/src/commands/JOKER/jokerCommand.test.d.ts +1 -0
  81. package/esm/typings/src/commands/JOKER/jokerCommandParser.d.ts +9 -0
  82. package/esm/typings/src/commands/KNOWLEDGE/KnowledgeCommand.d.ts +11 -0
  83. package/esm/typings/src/commands/KNOWLEDGE/knowledgeCommand.test.d.ts +1 -0
  84. package/esm/typings/src/commands/KNOWLEDGE/knowledgeCommandParser.d.ts +12 -0
  85. package/esm/typings/src/commands/KNOWLEDGE/utils/knowledgeSourceContentToName.d.ts +11 -0
  86. package/esm/typings/src/commands/KNOWLEDGE/utils/knowledgeSourceContentToName.test.d.ts +4 -0
  87. package/esm/typings/src/commands/MODEL/ModelCommand.d.ts +14 -0
  88. package/esm/typings/src/commands/MODEL/modelCommand.test.d.ts +1 -0
  89. package/esm/typings/src/commands/MODEL/modelCommandParser.d.ts +10 -0
  90. package/esm/typings/src/commands/PARAMETER/ParameterCommand.d.ts +15 -0
  91. package/esm/typings/src/commands/PARAMETER/parameterCommand.test.d.ts +1 -0
  92. package/esm/typings/src/commands/PARAMETER/parameterCommandParser.d.ts +9 -0
  93. package/esm/typings/src/commands/PERSONA/PersonaCommand.d.ts +13 -0
  94. package/esm/typings/src/commands/PERSONA/personaCommand.test.d.ts +1 -0
  95. package/esm/typings/src/commands/PERSONA/personaCommandParser.d.ts +9 -0
  96. package/esm/typings/src/commands/POSTPROCESS/PostprocessCommand.d.ts +11 -0
  97. package/esm/typings/src/commands/POSTPROCESS/postprocessCommand.test.d.ts +1 -0
  98. package/esm/typings/src/commands/POSTPROCESS/postprocessCommandParser.d.ts +9 -0
  99. package/esm/typings/src/commands/SECTION/SectionCommand.d.ts +11 -0
  100. package/esm/typings/src/commands/SECTION/sectionCommand.test.d.ts +1 -0
  101. package/esm/typings/src/commands/SECTION/sectionCommandParser.d.ts +20 -0
  102. package/esm/typings/src/commands/URL/UrlCommand.d.ts +10 -0
  103. package/esm/typings/src/commands/URL/urlCommand.test.d.ts +1 -0
  104. package/esm/typings/src/commands/URL/urlCommandParser.d.ts +9 -0
  105. package/esm/typings/src/commands/X_ACTION/ActionCommand.d.ts +9 -0
  106. package/esm/typings/src/commands/X_ACTION/actionCommand.test.d.ts +1 -0
  107. package/esm/typings/src/commands/X_ACTION/actionCommandParser.d.ts +12 -0
  108. package/esm/typings/src/commands/X_INSTRUMENT/InstrumentCommand.d.ts +9 -0
  109. package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommand.test.d.ts +1 -0
  110. package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommandParser.d.ts +12 -0
  111. package/esm/typings/src/commands/_BOILERPLATE/BoilerplateCommand.d.ts +10 -0
  112. package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommand.test.d.ts +1 -0
  113. package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts +11 -0
  114. package/esm/typings/src/commands/_common/getParserForCommand.d.ts +11 -0
  115. package/esm/typings/src/commands/_common/getParserForCommand.test.d.ts +1 -0
  116. package/esm/typings/src/commands/_common/parseCommand.d.ts +12 -0
  117. package/esm/typings/src/commands/_common/parseCommand.test.d.ts +1 -0
  118. package/esm/typings/src/commands/_common/stringifyCommand.d.ts +12 -0
  119. package/esm/typings/src/commands/_common/stringifyCommand.test.d.ts +1 -0
  120. package/esm/typings/src/commands/_common/types/Command.d.ts +6 -0
  121. package/esm/typings/src/commands/_common/types/CommandParser.d.ts +205 -0
  122. package/esm/typings/src/commands/_common/types/CommandType.d.ts +17 -0
  123. package/esm/typings/src/commands/_common/types/CommandUsagePlaces.d.ts +13 -0
  124. package/esm/typings/src/commands/index.d.ts +9 -0
  125. package/esm/typings/src/config.d.ts +313 -0
  126. package/esm/typings/src/config.test.d.ts +4 -0
  127. package/esm/typings/src/constants.d.ts +76 -0
  128. package/esm/typings/src/conversion/archive/loadArchive.d.ts +16 -0
  129. package/esm/typings/src/conversion/archive/saveArchive.d.ts +18 -0
  130. package/esm/typings/src/conversion/compilePipeline.d.ts +25 -0
  131. package/esm/typings/src/conversion/compilePipeline.test.d.ts +1 -0
  132. package/esm/typings/src/conversion/compilePipelineOnRemoteServer.d.ts +21 -0
  133. package/esm/typings/src/conversion/parsePipeline.d.ts +30 -0
  134. package/esm/typings/src/conversion/parsePipeline.test.d.ts +1 -0
  135. package/esm/typings/src/conversion/pipelineJsonToString.d.ts +18 -0
  136. package/esm/typings/src/conversion/prettify/PrettifyOptions.d.ts +13 -0
  137. package/esm/typings/src/conversion/prettify/prettifyPipelineString.d.ts +12 -0
  138. package/esm/typings/src/conversion/prettify/renderPipelineMermaidOptions.d.ts +30 -0
  139. package/esm/typings/src/conversion/utils/extractParameterNamesFromTask.d.ts +15 -0
  140. package/esm/typings/src/conversion/utils/extractParameterNamesFromTask.test.d.ts +1 -0
  141. package/esm/typings/src/conversion/validation/_importPipeline.d.ts +23 -0
  142. package/esm/typings/src/conversion/validation/pipelineStringToJson-parseErrors.test.d.ts +4 -0
  143. package/esm/typings/src/conversion/validation/validatePipeline-logicErrors.test.d.ts +4 -0
  144. package/esm/typings/src/conversion/validation/validatePipeline.d.ts +42 -0
  145. package/esm/typings/src/conversion/validation/validatePipeline.test.d.ts +4 -0
  146. package/esm/typings/src/dialogs/callback/CallbackInterfaceTools.d.ts +17 -0
  147. package/esm/typings/src/dialogs/callback/CallbackInterfaceToolsOptions.d.ts +14 -0
  148. package/esm/typings/src/dialogs/simple-prompt/SimplePromptInterfaceTools.d.ts +22 -0
  149. package/esm/typings/src/dialogs/user-interface-execution-tools.test.d.ts +1 -0
  150. package/esm/typings/src/errors/0-BoilerplateError.d.ts +12 -0
  151. package/esm/typings/src/errors/0-index.d.ts +94 -0
  152. package/esm/typings/src/errors/AbstractFormatError.d.ts +11 -0
  153. package/esm/typings/src/errors/AuthenticationError.d.ts +9 -0
  154. package/esm/typings/src/errors/CollectionError.d.ts +9 -0
  155. package/esm/typings/src/errors/EnvironmentMismatchError.d.ts +9 -0
  156. package/esm/typings/src/errors/ExpectError.d.ts +12 -0
  157. package/esm/typings/src/errors/KnowledgeScrapeError.d.ts +9 -0
  158. package/esm/typings/src/errors/LimitReachedError.d.ts +9 -0
  159. package/esm/typings/src/errors/MissingToolsError.d.ts +9 -0
  160. package/esm/typings/src/errors/NotFoundError.d.ts +9 -0
  161. package/esm/typings/src/errors/NotYetImplementedError.d.ts +9 -0
  162. package/esm/typings/src/errors/ParseError.d.ts +12 -0
  163. package/esm/typings/src/errors/PipelineExecutionError.d.ts +14 -0
  164. package/esm/typings/src/errors/PipelineLogicError.d.ts +9 -0
  165. package/esm/typings/src/errors/PipelineUrlError.d.ts +9 -0
  166. package/esm/typings/src/errors/PromptbookFetchError.d.ts +9 -0
  167. package/esm/typings/src/errors/UnexpectedError.d.ts +9 -0
  168. package/esm/typings/src/errors/WrappedError.d.ts +10 -0
  169. package/esm/typings/src/errors/assertsError.d.ts +11 -0
  170. package/esm/typings/src/errors/utils/ErrorJson.d.ts +25 -0
  171. package/esm/typings/src/errors/utils/deserializeError.d.ts +7 -0
  172. package/esm/typings/src/errors/utils/deserializeError.test.d.ts +1 -0
  173. package/esm/typings/src/errors/utils/getErrorReportUrl.d.ts +6 -0
  174. package/esm/typings/src/errors/utils/serializeError.d.ts +7 -0
  175. package/esm/typings/src/errors/utils/serializeError.test.d.ts +1 -0
  176. package/esm/typings/src/executables/$provideExecutablesForNode.d.ts +12 -0
  177. package/esm/typings/src/executables/apps/locateLibreoffice.d.ts +12 -0
  178. package/esm/typings/src/executables/apps/locateLibreoffice.test.d.ts +1 -0
  179. package/esm/typings/src/executables/apps/locatePandoc.d.ts +12 -0
  180. package/esm/typings/src/executables/apps/locatePandoc.test.d.ts +1 -0
  181. package/esm/typings/src/executables/locateApp.d.ts +33 -0
  182. package/esm/typings/src/executables/locateApp.test.d.ts +1 -0
  183. package/esm/typings/src/executables/platforms/locateAppOnLinux.d.ts +13 -0
  184. package/esm/typings/src/executables/platforms/locateAppOnMacOs.d.ts +13 -0
  185. package/esm/typings/src/executables/platforms/locateAppOnWindows.d.ts +13 -0
  186. package/esm/typings/src/execution/AbstractTaskResult.d.ts +25 -0
  187. package/esm/typings/src/execution/AvailableModel.d.ts +46 -0
  188. package/esm/typings/src/execution/CommonToolsOptions.d.ts +28 -0
  189. package/esm/typings/src/execution/EmbeddingVector.d.ts +8 -0
  190. package/esm/typings/src/execution/Executables.d.ts +18 -0
  191. package/esm/typings/src/execution/ExecutionTask.d.ts +119 -0
  192. package/esm/typings/src/execution/ExecutionTools.d.ts +69 -0
  193. package/esm/typings/src/execution/FilesystemTools.d.ts +9 -0
  194. package/esm/typings/src/execution/LlmExecutionTools.d.ts +61 -0
  195. package/esm/typings/src/execution/LlmExecutionToolsConstructor.d.ts +11 -0
  196. package/esm/typings/src/execution/PipelineExecutor.d.ts +16 -0
  197. package/esm/typings/src/execution/PipelineExecutorResult.d.ts +39 -0
  198. package/esm/typings/src/execution/PromptResult.d.ts +101 -0
  199. package/esm/typings/src/execution/PromptbookFetch.d.ts +12 -0
  200. package/esm/typings/src/execution/PromptbookFetch.test-type.d.ts +5 -0
  201. package/esm/typings/src/execution/ScriptExecutionTools.d.ts +39 -0
  202. package/esm/typings/src/execution/UncertainNumber.d.ts +19 -0
  203. package/esm/typings/src/execution/Usage.d.ts +33 -0
  204. package/esm/typings/src/execution/UserInterfaceTools.d.ts +46 -0
  205. package/esm/typings/src/execution/assertsTaskSuccessful.d.ts +14 -0
  206. package/esm/typings/src/execution/createPipelineExecutor/$OngoingTaskResult.d.ts +48 -0
  207. package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorOptions.d.ts +46 -0
  208. package/esm/typings/src/execution/createPipelineExecutor/00-createPipelineExecutor.d.ts +10 -0
  209. package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts +48 -0
  210. package/esm/typings/src/execution/createPipelineExecutor/20-executeTask.d.ts +51 -0
  211. package/esm/typings/src/execution/createPipelineExecutor/30-executeFormatSubvalues.d.ts +27 -0
  212. package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +70 -0
  213. package/esm/typings/src/execution/createPipelineExecutor/computeCosineSimilarity.d.ts +13 -0
  214. package/esm/typings/src/execution/createPipelineExecutor/filterJustOutputParameters.d.ts +35 -0
  215. package/esm/typings/src/execution/createPipelineExecutor/getContextForTask.d.ts +14 -0
  216. package/esm/typings/src/execution/createPipelineExecutor/getExamplesForTask.d.ts +10 -0
  217. package/esm/typings/src/execution/createPipelineExecutor/getKnowledgeForTask.d.ts +42 -0
  218. package/esm/typings/src/execution/createPipelineExecutor/getReservedParametersForTask.d.ts +48 -0
  219. package/esm/typings/src/execution/createPipelineExecutor/knowledgePiecesToString.d.ts +9 -0
  220. package/esm/typings/src/execution/embeddingVectorToString.d.ts +7 -0
  221. package/esm/typings/src/execution/execution-report/ExecutionPromptReportJson.d.ts +24 -0
  222. package/esm/typings/src/execution/execution-report/ExecutionReportJson.d.ts +41 -0
  223. package/esm/typings/src/execution/execution-report/ExecutionReportString.d.ts +16 -0
  224. package/esm/typings/src/execution/execution-report/ExecutionReportStringOptions.d.ts +25 -0
  225. package/esm/typings/src/execution/execution-report/countWorkingDuration.d.ts +7 -0
  226. package/esm/typings/src/execution/execution-report/countWorkingDuration.test.d.ts +1 -0
  227. package/esm/typings/src/execution/execution-report/executionReportJsonToString.d.ts +15 -0
  228. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/AutomaticTranslator.d.ts +7 -0
  229. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/DebugAutomaticTranslator.d.ts +11 -0
  230. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/FakeAutomaticTranslator.d.ts +8 -0
  231. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/LindatAutomaticTranslator.d.ts +22 -0
  232. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/TranslatorOptions.d.ts +7 -0
  233. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.d.ts +8 -0
  234. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.test.d.ts +1 -0
  235. package/esm/typings/src/execution/translation/automatic-translate/translateMessages.d.ts +12 -0
  236. package/esm/typings/src/execution/utils/$provideExecutionToolsForNode.d.ts +13 -0
  237. package/esm/typings/src/execution/utils/addUsage.d.ts +9 -0
  238. package/esm/typings/src/execution/utils/addUsage.test.d.ts +1 -0
  239. package/esm/typings/src/execution/utils/checkExpectations.d.ts +29 -0
  240. package/esm/typings/src/execution/utils/checkExpectations.test.d.ts +1 -0
  241. package/esm/typings/src/execution/utils/computeUsageCounts.d.ts +10 -0
  242. package/esm/typings/src/execution/utils/forEachAsync.d.ts +20 -0
  243. package/esm/typings/src/execution/utils/uncertainNumber.d.ts +10 -0
  244. package/esm/typings/src/execution/utils/usage-constants.d.ts +147 -0
  245. package/esm/typings/src/execution/utils/usageToHuman.d.ts +26 -0
  246. package/esm/typings/src/execution/utils/usageToWorktime.d.ts +20 -0
  247. package/esm/typings/src/execution/utils/usageToWorktime.test.d.ts +1 -0
  248. package/esm/typings/src/expectations/drafts/isDomainNameFree.d.ts +10 -0
  249. package/esm/typings/src/expectations/drafts/isGithubNameFree.d.ts +10 -0
  250. package/esm/typings/src/formats/_common/FormatParser.d.ts +72 -0
  251. package/esm/typings/src/formats/_common/FormatSubvalueParser.d.ts +66 -0
  252. package/esm/typings/src/formats/csv/CsvFormatError.d.ts +10 -0
  253. package/esm/typings/src/formats/csv/CsvFormatParser.d.ts +17 -0
  254. package/esm/typings/src/formats/csv/CsvSettings.d.ts +13 -0
  255. package/esm/typings/src/formats/csv/utils/csvParse.d.ts +12 -0
  256. package/esm/typings/src/formats/csv/utils/isValidCsvString.d.ts +9 -0
  257. package/esm/typings/src/formats/csv/utils/isValidCsvString.test.d.ts +1 -0
  258. package/esm/typings/src/formats/index.d.ts +9 -0
  259. package/esm/typings/src/formats/json/JsonFormatParser.d.ts +19 -0
  260. package/esm/typings/src/formats/json/utils/isValidJsonString.d.ts +9 -0
  261. package/esm/typings/src/formats/json/utils/isValidJsonString.test.d.ts +1 -0
  262. package/esm/typings/src/formats/json/utils/jsonParse.d.ts +8 -0
  263. package/esm/typings/src/formats/text/TextFormatParser.d.ts +19 -0
  264. package/esm/typings/src/formats/xml/XmlFormatParser.d.ts +19 -0
  265. package/esm/typings/src/formats/xml/utils/isValidXmlString.d.ts +9 -0
  266. package/esm/typings/src/formats/xml/utils/isValidXmlString.test.d.ts +1 -0
  267. package/esm/typings/src/formfactors/_boilerplate/BoilerplateFormfactorDefinition.d.ts +15 -0
  268. package/esm/typings/src/formfactors/_common/AbstractFormfactorDefinition.d.ts +49 -0
  269. package/esm/typings/src/formfactors/_common/FormfactorDefinition.d.ts +10 -0
  270. package/esm/typings/src/formfactors/_common/string_formfactor_name.d.ts +6 -0
  271. package/esm/typings/src/formfactors/chatbot/ChatbotFormfactorDefinition.d.ts +45 -0
  272. package/esm/typings/src/formfactors/completion/CompletionFormfactorDefinition.d.ts +29 -0
  273. package/esm/typings/src/formfactors/generator/GeneratorFormfactorDefinition.d.ts +25 -0
  274. package/esm/typings/src/formfactors/generic/GenericFormfactorDefinition.d.ts +14 -0
  275. package/esm/typings/src/formfactors/image-generator/ImageGeneratorFormfactorDefinition.d.ts +24 -0
  276. package/esm/typings/src/formfactors/index.d.ts +170 -0
  277. package/esm/typings/src/formfactors/matcher/MatcherFormfactorDefinition.d.ts +21 -0
  278. package/esm/typings/src/formfactors/sheets/SheetsFormfactorDefinition.d.ts +26 -0
  279. package/esm/typings/src/formfactors/translator/TranslatorFormfactorDefinition.d.ts +25 -0
  280. package/esm/typings/src/high-level-abstractions/_common/HighLevelAbstraction.d.ts +20 -0
  281. package/esm/typings/src/high-level-abstractions/implicit-formfactor/ImplicitFormfactorHla.d.ts +10 -0
  282. package/esm/typings/src/high-level-abstractions/index.d.ts +54 -0
  283. package/esm/typings/src/high-level-abstractions/quick-chatbot/QuickChatbotHla.d.ts +13 -0
  284. package/esm/typings/src/llm-providers/_common/filterModels.d.ts +15 -0
  285. package/esm/typings/src/llm-providers/_common/register/$llmToolsMetadataRegister.d.ts +13 -0
  286. package/esm/typings/src/llm-providers/_common/register/$llmToolsRegister.d.ts +13 -0
  287. package/esm/typings/src/llm-providers/_common/register/$provideEnvFilename.d.ts +12 -0
  288. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsConfigurationFromEnv.d.ts +19 -0
  289. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForTestingAndScriptsAndPlayground.d.ts +27 -0
  290. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForWizardOrCli.d.ts +59 -0
  291. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsFromEnv.d.ts +41 -0
  292. package/esm/typings/src/llm-providers/_common/register/$registeredLlmToolsMessage.d.ts +22 -0
  293. package/esm/typings/src/llm-providers/_common/register/LlmToolsConfiguration.d.ts +30 -0
  294. package/esm/typings/src/llm-providers/_common/register/LlmToolsMetadata.d.ts +58 -0
  295. package/esm/typings/src/llm-providers/_common/register/LlmToolsOptions.d.ts +17 -0
  296. package/esm/typings/src/llm-providers/_common/register/createLlmToolsFromConfiguration.d.ts +49 -0
  297. package/esm/typings/src/llm-providers/_common/register/createLlmToolsFromConfiguration.test.d.ts +1 -0
  298. package/esm/typings/src/llm-providers/_common/utils/cache/CacheItem.d.ts +33 -0
  299. package/esm/typings/src/llm-providers/_common/utils/cache/CacheLlmToolsOptions.d.ts +27 -0
  300. package/esm/typings/src/llm-providers/_common/utils/cache/cacheLlmTools.d.ts +19 -0
  301. package/esm/typings/src/llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage.d.ts +22 -0
  302. package/esm/typings/src/llm-providers/_common/utils/count-total-usage/countUsage.d.ts +17 -0
  303. package/esm/typings/src/llm-providers/_common/utils/count-total-usage/limitTotalUsage.d.ts +36 -0
  304. package/esm/typings/src/llm-providers/_common/utils/pricing.d.ts +16 -0
  305. package/esm/typings/src/llm-providers/_common/utils/pricing.test.d.ts +1 -0
  306. package/esm/typings/src/llm-providers/_multiple/MultipleLlmExecutionTools.d.ts +63 -0
  307. package/esm/typings/src/llm-providers/_multiple/joinLlmExecutionTools.d.ts +21 -0
  308. package/esm/typings/src/llm-providers/_multiple/playground/playground.d.ts +5 -0
  309. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +66 -0
  310. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions.d.ts +31 -0
  311. package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +24 -0
  312. package/esm/typings/src/llm-providers/anthropic-claude/computeAnthropicClaudeUsage.d.ts +18 -0
  313. package/esm/typings/src/llm-providers/anthropic-claude/computeAnthropicClaudeUsage.test.d.ts +4 -0
  314. package/esm/typings/src/llm-providers/anthropic-claude/createAnthropicClaudeExecutionTools.d.ts +19 -0
  315. package/esm/typings/src/llm-providers/anthropic-claude/playground/playground.d.ts +7 -0
  316. package/esm/typings/src/llm-providers/anthropic-claude/register-configuration.d.ts +14 -0
  317. package/esm/typings/src/llm-providers/anthropic-claude/register-constructor.d.ts +16 -0
  318. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +67 -0
  319. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionToolsOptions.d.ts +37 -0
  320. package/esm/typings/src/llm-providers/azure-openai/createAzureOpenAiExecutionTools.d.ts +15 -0
  321. package/esm/typings/src/llm-providers/azure-openai/playground/playground.d.ts +6 -0
  322. package/esm/typings/src/llm-providers/azure-openai/register-configuration.d.ts +14 -0
  323. package/esm/typings/src/llm-providers/azure-openai/register-constructor.d.ts +15 -0
  324. package/esm/typings/src/llm-providers/deepseek/DeepseekExecutionToolsOptions.d.ts +9 -0
  325. package/esm/typings/src/llm-providers/deepseek/createDeepseekExecutionTools.d.ts +14 -0
  326. package/esm/typings/src/llm-providers/deepseek/deepseek-models.d.ts +23 -0
  327. package/esm/typings/src/llm-providers/deepseek/register-configuration.d.ts +14 -0
  328. package/esm/typings/src/llm-providers/deepseek/register-constructor.d.ts +15 -0
  329. package/esm/typings/src/llm-providers/google/GoogleExecutionToolsOptions.d.ts +9 -0
  330. package/esm/typings/src/llm-providers/google/createGoogleExecutionTools.d.ts +14 -0
  331. package/esm/typings/src/llm-providers/google/google-models.d.ts +23 -0
  332. package/esm/typings/src/llm-providers/google/register-configuration.d.ts +14 -0
  333. package/esm/typings/src/llm-providers/google/register-constructor.d.ts +15 -0
  334. package/esm/typings/src/llm-providers/mocked/$fakeTextToExpectations.d.ts +15 -0
  335. package/esm/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts +40 -0
  336. package/esm/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts +44 -0
  337. package/esm/typings/src/llm-providers/mocked/test/fakeTextToExpectations.test.d.ts +1 -0
  338. package/esm/typings/src/llm-providers/mocked/test/faked-completion.test.d.ts +1 -0
  339. package/esm/typings/src/llm-providers/mocked/test/joker.test.d.ts +4 -0
  340. package/esm/typings/src/llm-providers/mocked/test/mocked-chat.test.d.ts +5 -0
  341. package/esm/typings/src/llm-providers/mocked/test/mocked-completion.test.d.ts +4 -0
  342. package/esm/typings/src/llm-providers/ollama/OllamaExecutionTools.d.ts +44 -0
  343. package/esm/typings/src/llm-providers/ollama/OllamaExecutionToolsOptions.d.ts +23 -0
  344. package/esm/typings/src/llm-providers/ollama/createOllamaExecutionTools.d.ts +11 -0
  345. package/esm/typings/src/llm-providers/ollama/ollama-models.d.ts +14 -0
  346. package/esm/typings/src/llm-providers/ollama/playground/playground.d.ts +6 -0
  347. package/esm/typings/src/llm-providers/ollama/register-configuration.d.ts +14 -0
  348. package/esm/typings/src/llm-providers/ollama/register-constructor.d.ts +15 -0
  349. package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionTools.d.ts +36 -0
  350. package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionToolsOptions.d.ts +14 -0
  351. package/esm/typings/src/llm-providers/openai/OpenAiCompatibleExecutionTools.d.ts +91 -0
  352. package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +38 -0
  353. package/esm/typings/src/llm-providers/openai/OpenAiExecutionToolsOptions.d.ts +11 -0
  354. package/esm/typings/src/llm-providers/openai/computeOpenAiUsage.d.ts +18 -0
  355. package/esm/typings/src/llm-providers/openai/computeOpenAiUsage.test.d.ts +4 -0
  356. package/esm/typings/src/llm-providers/openai/createOpenAiAssistantExecutionTools.d.ts +15 -0
  357. package/esm/typings/src/llm-providers/openai/createOpenAiExecutionTools.d.ts +17 -0
  358. package/esm/typings/src/llm-providers/openai/openai-models.d.ts +25 -0
  359. package/esm/typings/src/llm-providers/openai/playground/playground.d.ts +6 -0
  360. package/esm/typings/src/llm-providers/openai/register-configuration.d.ts +24 -0
  361. package/esm/typings/src/llm-providers/openai/register-constructor.d.ts +25 -0
  362. package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts +59 -0
  363. package/esm/typings/src/llm-providers/remote/playground/playground.d.ts +5 -0
  364. package/esm/typings/src/llm-providers/vercel/VercelExecutionToolsOptions.d.ts +23 -0
  365. package/esm/typings/src/llm-providers/vercel/VercelProvider.d.ts +13 -0
  366. package/esm/typings/src/llm-providers/vercel/createExecutionToolsFromVercelProvider.d.ts +8 -0
  367. package/esm/typings/src/llm-providers/vercel/playground/playground.d.ts +6 -0
  368. package/esm/typings/src/migrations/migratePipeline.d.ts +9 -0
  369. package/esm/typings/src/other/templates/getBookTemplates.d.ts +24 -0
  370. package/esm/typings/src/other/templates/getTemplatesPipelineCollection.d.ts +10 -0
  371. package/esm/typings/src/personas/preparePersona.d.ts +17 -0
  372. package/esm/typings/src/pipeline/PipelineInterface/PipelineInterface.d.ts +22 -0
  373. package/esm/typings/src/pipeline/PipelineInterface/constants.d.ts +14 -0
  374. package/esm/typings/src/pipeline/PipelineInterface/getPipelineInterface.d.ts +11 -0
  375. package/esm/typings/src/pipeline/PipelineInterface/isPipelineImplementingInterface.d.ts +27 -0
  376. package/esm/typings/src/pipeline/PipelineInterface/isPipelineInterfacesEqual.d.ts +10 -0
  377. package/esm/typings/src/pipeline/PipelineJson/CommonTaskJson.d.ts +103 -0
  378. package/esm/typings/src/pipeline/PipelineJson/DialogTaskJson.d.ts +13 -0
  379. package/esm/typings/src/pipeline/PipelineJson/Expectations.d.ts +40 -0
  380. package/esm/typings/src/pipeline/PipelineJson/KnowledgePieceJson.d.ts +73 -0
  381. package/esm/typings/src/pipeline/PipelineJson/KnowledgeSourceJson.d.ts +44 -0
  382. package/esm/typings/src/pipeline/PipelineJson/ParameterJson.d.ts +98 -0
  383. package/esm/typings/src/pipeline/PipelineJson/PersonaJson.d.ts +47 -0
  384. package/esm/typings/src/pipeline/PipelineJson/PipelineJson.d.ts +113 -0
  385. package/esm/typings/src/pipeline/PipelineJson/PreparationJson.d.ts +22 -0
  386. package/esm/typings/src/pipeline/PipelineJson/PromptTaskJson.d.ts +26 -0
  387. package/esm/typings/src/pipeline/PipelineJson/ScriptTaskJson.d.ts +20 -0
  388. package/esm/typings/src/pipeline/PipelineJson/SimpleTaskJson.d.ts +13 -0
  389. package/esm/typings/src/pipeline/PipelineJson/TaskJson.d.ts +11 -0
  390. package/esm/typings/src/pipeline/PipelineString.d.ts +11 -0
  391. package/esm/typings/src/pipeline/book-notation.d.ts +19 -0
  392. package/esm/typings/src/pipeline/isValidPipelineString.d.ts +13 -0
  393. package/esm/typings/src/pipeline/isValidPipelineString.test.d.ts +4 -0
  394. package/esm/typings/src/pipeline/prompt-notation.d.ts +31 -0
  395. package/esm/typings/src/pipeline/prompt-notation.test.d.ts +4 -0
  396. package/esm/typings/src/pipeline/validatePipelineString.d.ts +14 -0
  397. package/esm/typings/src/playground/playground.d.ts +5 -0
  398. package/esm/typings/src/postprocessing/utils/extractBlock.d.ts +16 -0
  399. package/esm/typings/src/postprocessing/utils/extractJsonBlock.d.ts +25 -0
  400. package/esm/typings/src/postprocessing/utils/extractJsonBlock.test.d.ts +1 -0
  401. package/esm/typings/src/prepare/PrepareAndScrapeOptions.d.ts +51 -0
  402. package/esm/typings/src/prepare/isPipelinePrepared.d.ts +18 -0
  403. package/esm/typings/src/prepare/isPipelinePrepared.test.d.ts +1 -0
  404. package/esm/typings/src/prepare/preparePipeline.d.ts +22 -0
  405. package/esm/typings/src/prepare/preparePipelineOnRemoteServer.d.ts +17 -0
  406. package/esm/typings/src/prepare/prepareTasks.d.ts +36 -0
  407. package/esm/typings/src/prepare/unpreparePipeline.d.ts +13 -0
  408. package/esm/typings/src/remote-server/RemoteServer.d.ts +23 -0
  409. package/esm/typings/src/remote-server/createRemoteClient.d.ts +10 -0
  410. package/esm/typings/src/remote-server/openapi-types.d.ts +626 -0
  411. package/esm/typings/src/remote-server/openapi.d.ts +581 -0
  412. package/esm/typings/src/remote-server/socket-types/_common/PromptbookServer_Error.d.ts +7 -0
  413. package/esm/typings/src/remote-server/socket-types/_subtypes/Identification.d.ts +59 -0
  414. package/esm/typings/src/remote-server/socket-types/_subtypes/identificationToPromptbookToken.d.ts +11 -0
  415. package/esm/typings/src/remote-server/socket-types/_subtypes/promptbookTokenToIdentification.d.ts +10 -0
  416. package/esm/typings/src/remote-server/socket-types/listModels/PromptbookServer_ListModels_Request.d.ts +17 -0
  417. package/esm/typings/src/remote-server/socket-types/listModels/PromptbookServer_ListModels_Response.d.ts +17 -0
  418. package/esm/typings/src/remote-server/socket-types/prepare/PromptbookServer_PreparePipeline_Request.d.ts +17 -0
  419. package/esm/typings/src/remote-server/socket-types/prepare/PromptbookServer_PreparePipeline_Response.d.ts +12 -0
  420. package/esm/typings/src/remote-server/socket-types/prompt/PromptbookServer_Prompt_Request.d.ts +17 -0
  421. package/esm/typings/src/remote-server/socket-types/prompt/PromptbookServer_Prompt_Response.d.ts +12 -0
  422. package/esm/typings/src/remote-server/startRemoteServer.d.ts +25 -0
  423. package/esm/typings/src/remote-server/types/RemoteClientOptions.d.ts +24 -0
  424. package/esm/typings/src/remote-server/types/RemoteServerOptions.d.ts +164 -0
  425. package/esm/typings/src/scrapers/_boilerplate/BoilerplateScraper.d.ts +43 -0
  426. package/esm/typings/src/scrapers/_boilerplate/createBoilerplateScraper.d.ts +20 -0
  427. package/esm/typings/src/scrapers/_boilerplate/playground/boilerplate-scraper-playground.d.ts +5 -0
  428. package/esm/typings/src/scrapers/_boilerplate/register-constructor.d.ts +15 -0
  429. package/esm/typings/src/scrapers/_boilerplate/register-metadata.d.ts +28 -0
  430. package/esm/typings/src/scrapers/_common/Converter.d.ts +25 -0
  431. package/esm/typings/src/scrapers/_common/Scraper.d.ts +60 -0
  432. package/esm/typings/src/scrapers/_common/ScraperIntermediateSource.d.ts +16 -0
  433. package/esm/typings/src/scrapers/_common/prepareKnowledgePieces.d.ts +19 -0
  434. package/esm/typings/src/scrapers/_common/prepareKnowledgePieces.test.d.ts +1 -0
  435. package/esm/typings/src/scrapers/_common/register/$provideFilesystemForNode.d.ts +12 -0
  436. package/esm/typings/src/scrapers/_common/register/$provideScrapersForBrowser.d.ts +15 -0
  437. package/esm/typings/src/scrapers/_common/register/$provideScrapersForNode.d.ts +13 -0
  438. package/esm/typings/src/scrapers/_common/register/$provideScriptingForNode.d.ts +11 -0
  439. package/esm/typings/src/scrapers/_common/register/$registeredScrapersMessage.d.ts +13 -0
  440. package/esm/typings/src/scrapers/_common/register/$scrapersMetadataRegister.d.ts +13 -0
  441. package/esm/typings/src/scrapers/_common/register/$scrapersRegister.d.ts +14 -0
  442. package/esm/typings/src/scrapers/_common/register/ScraperAndConverterMetadata.d.ts +46 -0
  443. package/esm/typings/src/scrapers/_common/register/ScraperConstructor.d.ts +13 -0
  444. package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.d.ts +35 -0
  445. package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.test.d.ts +4 -0
  446. package/esm/typings/src/scrapers/_common/utils/makeKnowledgeSourceHandler.d.ts +13 -0
  447. package/esm/typings/src/scrapers/_common/utils/promptbookFetch.d.ts +10 -0
  448. package/esm/typings/src/scrapers/document/DocumentScraper.d.ts +43 -0
  449. package/esm/typings/src/scrapers/document/DocumentScraper.test.d.ts +4 -0
  450. package/esm/typings/src/scrapers/document/createDocumentScraper.d.ts +20 -0
  451. package/esm/typings/src/scrapers/document/playground/document-scraper-playground.d.ts +5 -0
  452. package/esm/typings/src/scrapers/document/register-constructor.d.ts +15 -0
  453. package/esm/typings/src/scrapers/document/register-metadata.d.ts +28 -0
  454. package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.d.ts +43 -0
  455. package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.test.d.ts +4 -0
  456. package/esm/typings/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts +21 -0
  457. package/esm/typings/src/scrapers/document-legacy/playground/legacy-document-scraper-playground.d.ts +5 -0
  458. package/esm/typings/src/scrapers/document-legacy/register-constructor.d.ts +15 -0
  459. package/esm/typings/src/scrapers/document-legacy/register-metadata.d.ts +28 -0
  460. package/esm/typings/src/scrapers/markdown/MarkdownScraper.d.ts +29 -0
  461. package/esm/typings/src/scrapers/markdown/MarkdownScraper.test.d.ts +4 -0
  462. package/esm/typings/src/scrapers/markdown/createMarkdownScraper.d.ts +20 -0
  463. package/esm/typings/src/scrapers/markdown/playground/markdown-scraper-playground.d.ts +5 -0
  464. package/esm/typings/src/scrapers/markdown/register-constructor.d.ts +15 -0
  465. package/esm/typings/src/scrapers/markdown/register-metadata.d.ts +28 -0
  466. package/esm/typings/src/scrapers/markitdown/MarkitdownScraper.d.ts +50 -0
  467. package/esm/typings/src/scrapers/markitdown/createMarkitdownScraper.d.ts +22 -0
  468. package/esm/typings/src/scrapers/markitdown/playground/markitdown-scraper-playground.d.ts +5 -0
  469. package/esm/typings/src/scrapers/markitdown/register-constructor.d.ts +17 -0
  470. package/esm/typings/src/scrapers/markitdown/register-metadata.d.ts +28 -0
  471. package/esm/typings/src/scrapers/pdf/PdfScraper.d.ts +41 -0
  472. package/esm/typings/src/scrapers/pdf/createPdfScraper.d.ts +21 -0
  473. package/esm/typings/src/scrapers/pdf/playground/pdf-scraper-playground.d.ts +5 -0
  474. package/esm/typings/src/scrapers/pdf/register-constructor.d.ts +15 -0
  475. package/esm/typings/src/scrapers/pdf/register-metadata.d.ts +28 -0
  476. package/esm/typings/src/scrapers/website/WebsiteScraper.d.ts +50 -0
  477. package/esm/typings/src/scrapers/website/createWebsiteScraper.d.ts +21 -0
  478. package/esm/typings/src/scrapers/website/playground/website-scraper-playground.d.ts +5 -0
  479. package/esm/typings/src/scrapers/website/register-constructor.d.ts +15 -0
  480. package/esm/typings/src/scrapers/website/register-metadata.d.ts +28 -0
  481. package/esm/typings/src/scrapers/website/utils/createShowdownConverter.d.ts +7 -0
  482. package/esm/typings/src/scrapers/website/utils/createShowdownConverter.test.d.ts +1 -0
  483. package/esm/typings/src/scripting/_test/custom-function-async.test.ts.test.d.ts +1 -0
  484. package/esm/typings/src/scripting/_test/custom-function-missing.test.d.ts +1 -0
  485. package/esm/typings/src/scripting/_test/custom-function-with-dependencies.test.d.ts +1 -0
  486. package/esm/typings/src/scripting/_test/custom-function.test.d.ts +1 -0
  487. package/esm/typings/src/scripting/_test/postprocessing.test.d.ts +1 -0
  488. package/esm/typings/src/scripting/_test/script-execution-errors.test.d.ts +1 -0
  489. package/esm/typings/src/scripting/_test/script-execution-tools.test.d.ts +1 -0
  490. package/esm/typings/src/scripting/javascript/JavascriptEvalExecutionTools.d.ts +22 -0
  491. package/esm/typings/src/scripting/javascript/JavascriptEvalExecutionTools.test.d.ts +4 -0
  492. package/esm/typings/src/scripting/javascript/JavascriptExecutionTools.d.ts +8 -0
  493. package/esm/typings/src/scripting/javascript/JavascriptExecutionToolsOptions.d.ts +26 -0
  494. package/esm/typings/src/scripting/javascript/postprocessing-functions.d.ts +56 -0
  495. package/esm/typings/src/scripting/javascript/utils/extractVariablesFromJavascript.d.ts +14 -0
  496. package/esm/typings/src/scripting/javascript/utils/extractVariablesFromJavascript.test.d.ts +1 -0
  497. package/esm/typings/src/scripting/javascript/utils/extractVariablesFromScript.test.d.ts +1 -0
  498. package/esm/typings/src/scripting/javascript/utils/preserve.d.ts +14 -0
  499. package/esm/typings/src/scripting/python/PythonExecutionTools.d.ts +18 -0
  500. package/esm/typings/src/scripting/typescript/TypescriptExecutionTools.d.ts +18 -0
  501. package/esm/typings/src/storage/_common/PromptbookStorage.d.ts +24 -0
  502. package/esm/typings/src/storage/_common/PromptbookStorage.test-type.d.ts +5 -0
  503. package/esm/typings/src/storage/blackhole/BlackholeStorage.d.ts +33 -0
  504. package/esm/typings/src/storage/env-storage/$EnvStorage.d.ts +40 -0
  505. package/esm/typings/src/storage/file-cache-storage/FileCacheStorage.d.ts +40 -0
  506. package/esm/typings/src/storage/file-cache-storage/FileCacheStorageOptions.d.ts +12 -0
  507. package/esm/typings/src/storage/file-cache-storage/utils/nameToSubfolderPath.d.ts +8 -0
  508. package/esm/typings/src/storage/file-cache-storage/utils/nameToSubfolderPath.test.d.ts +1 -0
  509. package/esm/typings/src/storage/local-storage/getIndexedDbStorage.d.ts +11 -0
  510. package/esm/typings/src/storage/local-storage/getLocalStorage.d.ts +10 -0
  511. package/esm/typings/src/storage/local-storage/getSessionStorage.d.ts +10 -0
  512. package/esm/typings/src/storage/local-storage/utils/IndexedDbStorageOptions.d.ts +14 -0
  513. package/esm/typings/src/storage/local-storage/utils/makePromptbookStorageFromIndexedDb.d.ts +8 -0
  514. package/esm/typings/src/storage/local-storage/utils/makePromptbookStorageFromWebStorage.d.ts +12 -0
  515. package/esm/typings/src/storage/memory/MemoryStorage.d.ts +33 -0
  516. package/esm/typings/src/storage/utils/PrefixStorage.d.ts +25 -0
  517. package/esm/typings/src/types/Arrayable.d.ts +11 -0
  518. package/esm/typings/src/types/IntermediateFilesStrategy.d.ts +8 -0
  519. package/esm/typings/src/types/ModelRequirements.d.ts +104 -0
  520. package/esm/typings/src/types/ModelVariant.d.ts +15 -0
  521. package/esm/typings/src/types/NonEmptyArray.d.ts +8 -0
  522. package/esm/typings/src/types/Prompt.d.ts +111 -0
  523. package/esm/typings/src/types/ScriptLanguage.d.ts +13 -0
  524. package/esm/typings/src/types/SectionType.d.ts +21 -0
  525. package/esm/typings/src/types/TaskType.d.ts +15 -0
  526. package/esm/typings/src/types/typeAliasEmoji.d.ts +12 -0
  527. package/esm/typings/src/types/typeAliases.d.ts +679 -0
  528. package/esm/typings/src/utils/$Register.d.ts +40 -0
  529. package/esm/typings/src/utils/$getCurrentDate.d.ts +10 -0
  530. package/esm/typings/src/utils/FromtoItems.d.ts +19 -0
  531. package/esm/typings/src/utils/arrayableToArray.d.ts +11 -0
  532. package/esm/typings/src/utils/arrayableToArray.test.d.ts +1 -0
  533. package/esm/typings/src/utils/editable/edit-pipeline-string/addPipelineCommand.d.ts +17 -0
  534. package/esm/typings/src/utils/editable/edit-pipeline-string/addPipelineCommand.test.d.ts +1 -0
  535. package/esm/typings/src/utils/editable/edit-pipeline-string/deflatePipeline.d.ts +13 -0
  536. package/esm/typings/src/utils/editable/edit-pipeline-string/deflatePipeline.test.d.ts +1 -0
  537. package/esm/typings/src/utils/editable/edit-pipeline-string/removePipelineCommand.d.ts +22 -0
  538. package/esm/typings/src/utils/editable/edit-pipeline-string/removePipelineCommand.test.d.ts +1 -0
  539. package/esm/typings/src/utils/editable/types/PipelineEditableSerialized.d.ts +27 -0
  540. package/esm/typings/src/utils/editable/utils/isFlatPipeline.d.ts +8 -0
  541. package/esm/typings/src/utils/editable/utils/isFlatPipeline.test.d.ts +1 -0
  542. package/esm/typings/src/utils/editable/utils/renamePipelineParameter.d.ts +29 -0
  543. package/esm/typings/src/utils/editable/utils/renamePipelineParameter.test.d.ts +1 -0
  544. package/esm/typings/src/utils/editable/utils/stringifyPipelineJson.d.ts +16 -0
  545. package/esm/typings/src/utils/emojis.d.ts +24 -0
  546. package/esm/typings/src/utils/environment/$getGlobalScope.d.ts +10 -0
  547. package/esm/typings/src/utils/environment/$isRunningInBrowser.d.ts +11 -0
  548. package/esm/typings/src/utils/environment/$isRunningInJest.d.ts +11 -0
  549. package/esm/typings/src/utils/environment/$isRunningInNode.d.ts +11 -0
  550. package/esm/typings/src/utils/environment/$isRunningInWebWorker.d.ts +11 -0
  551. package/esm/typings/src/utils/execCommand/$execCommand.d.ts +16 -0
  552. package/esm/typings/src/utils/execCommand/$execCommandNormalizeOptions.d.ts +12 -0
  553. package/esm/typings/src/utils/execCommand/$execCommands.d.ts +18 -0
  554. package/esm/typings/src/utils/execCommand/ExecCommandOptions.d.ts +45 -0
  555. package/esm/typings/src/utils/execCommand/execCommand.test.d.ts +1 -0
  556. package/esm/typings/src/utils/execCommand/execCommandNormalizeOptions.test.d.ts +1 -0
  557. package/esm/typings/src/utils/expectation-counters/constants.d.ts +16 -0
  558. package/esm/typings/src/utils/expectation-counters/countCharacters.d.ts +10 -0
  559. package/esm/typings/src/utils/expectation-counters/countCharacters.test.d.ts +1 -0
  560. package/esm/typings/src/utils/expectation-counters/countLines.d.ts +12 -0
  561. package/esm/typings/src/utils/expectation-counters/countLines.test.d.ts +1 -0
  562. package/esm/typings/src/utils/expectation-counters/countPages.d.ts +12 -0
  563. package/esm/typings/src/utils/expectation-counters/countPages.test.d.ts +1 -0
  564. package/esm/typings/src/utils/expectation-counters/countParagraphs.d.ts +10 -0
  565. package/esm/typings/src/utils/expectation-counters/countParagraphs.test.d.ts +1 -0
  566. package/esm/typings/src/utils/expectation-counters/countSentences.d.ts +16 -0
  567. package/esm/typings/src/utils/expectation-counters/countSentences.test.d.ts +1 -0
  568. package/esm/typings/src/utils/expectation-counters/countWords.d.ts +10 -0
  569. package/esm/typings/src/utils/expectation-counters/countWords.test.d.ts +1 -0
  570. package/esm/typings/src/utils/expectation-counters/index.d.ts +12 -0
  571. package/esm/typings/src/utils/files/extensionToMimeType.d.ts +8 -0
  572. package/esm/typings/src/utils/files/extensionToMimeType.test.d.ts +1 -0
  573. package/esm/typings/src/utils/files/getFileExtension.d.ts +8 -0
  574. package/esm/typings/src/utils/files/getFileExtension.test.d.ts +1 -0
  575. package/esm/typings/src/utils/files/isDirectoryExisting.d.ts +14 -0
  576. package/esm/typings/src/utils/files/isDirectoryExisting.test.d.ts +1 -0
  577. package/esm/typings/src/utils/files/isExecutable.d.ts +11 -0
  578. package/esm/typings/src/utils/files/isFileExisting.d.ts +13 -0
  579. package/esm/typings/src/utils/files/isFileExisting.test.d.ts +1 -0
  580. package/esm/typings/src/utils/files/listAllFiles.d.ts +17 -0
  581. package/esm/typings/src/utils/files/listAllFiles.test.d.ts +1 -0
  582. package/esm/typings/src/utils/files/mimeTypeToExtension.d.ts +10 -0
  583. package/esm/typings/src/utils/files/mimeTypeToExtension.test.d.ts +1 -0
  584. package/esm/typings/src/utils/markdown/addAutoGeneratedSection.d.ts +14 -0
  585. package/esm/typings/src/utils/markdown/addAutoGeneratedSection.test.d.ts +1 -0
  586. package/esm/typings/src/utils/markdown/createMarkdownChart.d.ts +38 -0
  587. package/esm/typings/src/utils/markdown/createMarkdownChart.test.d.ts +1 -0
  588. package/esm/typings/src/utils/markdown/createMarkdownTable.d.ts +11 -0
  589. package/esm/typings/src/utils/markdown/createMarkdownTable.test.d.ts +1 -0
  590. package/esm/typings/src/utils/markdown/escapeMarkdownBlock.d.ts +11 -0
  591. package/esm/typings/src/utils/markdown/escapeMarkdownBlock.test.d.ts +1 -0
  592. package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown-real.test.d.ts +1 -0
  593. package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.d.ts +36 -0
  594. package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.test.d.ts +1 -0
  595. package/esm/typings/src/utils/markdown/extractAllListItemsFromMarkdown.d.ts +15 -0
  596. package/esm/typings/src/utils/markdown/extractAllListItemsFromMarkdown.test.d.ts +1 -0
  597. package/esm/typings/src/utils/markdown/extractOneBlockFromMarkdown.d.ts +22 -0
  598. package/esm/typings/src/utils/markdown/extractOneBlockFromMarkdown.test.d.ts +1 -0
  599. package/esm/typings/src/utils/markdown/flattenMarkdown.d.ts +17 -0
  600. package/esm/typings/src/utils/markdown/flattenMarkdown.test.d.ts +1 -0
  601. package/esm/typings/src/utils/markdown/parseMarkdownSection.d.ts +34 -0
  602. package/esm/typings/src/utils/markdown/parseMarkdownSection.test.d.ts +1 -0
  603. package/esm/typings/src/utils/markdown/prettifyMarkdown.d.ts +9 -0
  604. package/esm/typings/src/utils/markdown/prettifyMarkdown.test.d.ts +1 -0
  605. package/esm/typings/src/utils/markdown/removeMarkdownComments.d.ts +10 -0
  606. package/esm/typings/src/utils/markdown/removeMarkdownComments.test.d.ts +1 -0
  607. package/esm/typings/src/utils/markdown/removeMarkdownFormatting.d.ts +9 -0
  608. package/esm/typings/src/utils/markdown/removeMarkdownFormatting.test.d.ts +1 -0
  609. package/esm/typings/src/utils/markdown/splitMarkdownIntoSections.d.ts +15 -0
  610. package/esm/typings/src/utils/markdown/splitMarkdownIntoSections.test.d.ts +1 -0
  611. package/esm/typings/src/utils/normalization/DIACRITIC_VARIANTS_LETTERS.d.ts +12 -0
  612. package/esm/typings/src/utils/normalization/IKeywords.d.ts +21 -0
  613. package/esm/typings/src/utils/normalization/capitalize.d.ts +6 -0
  614. package/esm/typings/src/utils/normalization/capitalize.test.d.ts +1 -0
  615. package/esm/typings/src/utils/normalization/decapitalize.d.ts +6 -0
  616. package/esm/typings/src/utils/normalization/decapitalize.test.d.ts +1 -0
  617. package/esm/typings/src/utils/normalization/isValidKeyword.d.ts +10 -0
  618. package/esm/typings/src/utils/normalization/isValidKeyword.test.d.ts +1 -0
  619. package/esm/typings/src/utils/normalization/nameToUriPart.d.ts +9 -0
  620. package/esm/typings/src/utils/normalization/nameToUriPart.test.d.ts +1 -0
  621. package/esm/typings/src/utils/normalization/nameToUriParts.d.ts +9 -0
  622. package/esm/typings/src/utils/normalization/nameToUriParts.test.d.ts +1 -0
  623. package/esm/typings/src/utils/normalization/normalize-to-kebab-case.d.ts +21 -0
  624. package/esm/typings/src/utils/normalization/normalize-to-kebab-case.test.d.ts +1 -0
  625. package/esm/typings/src/utils/normalization/normalizeTo_PascalCase.d.ts +17 -0
  626. package/esm/typings/src/utils/normalization/normalizeTo_PascalCase.test.d.ts +1 -0
  627. package/esm/typings/src/utils/normalization/normalizeTo_SCREAMING_CASE.d.ts +26 -0
  628. package/esm/typings/src/utils/normalization/normalizeTo_SCREAMING_CASE.test.d.ts +1 -0
  629. package/esm/typings/src/utils/normalization/normalizeTo_camelCase.d.ts +22 -0
  630. package/esm/typings/src/utils/normalization/normalizeTo_camelCase.test.d.ts +1 -0
  631. package/esm/typings/src/utils/normalization/normalizeTo_snake_case.d.ts +17 -0
  632. package/esm/typings/src/utils/normalization/normalizeTo_snake_case.test.d.ts +1 -0
  633. package/esm/typings/src/utils/normalization/normalizeWhitespaces.d.ts +6 -0
  634. package/esm/typings/src/utils/normalization/normalizeWhitespaces.test.d.ts +1 -0
  635. package/esm/typings/src/utils/normalization/orderJson.d.ts +21 -0
  636. package/esm/typings/src/utils/normalization/orderJson.test.d.ts +4 -0
  637. package/esm/typings/src/utils/normalization/parseKeywords.d.ts +16 -0
  638. package/esm/typings/src/utils/normalization/parseKeywords.test.d.ts +1 -0
  639. package/esm/typings/src/utils/normalization/parseKeywordsFromString.d.ts +9 -0
  640. package/esm/typings/src/utils/normalization/parseKeywordsFromString.test.d.ts +1 -0
  641. package/esm/typings/src/utils/normalization/removeDiacritics.d.ts +11 -0
  642. package/esm/typings/src/utils/normalization/removeDiacritics.test.d.ts +1 -0
  643. package/esm/typings/src/utils/normalization/searchKeywords.d.ts +13 -0
  644. package/esm/typings/src/utils/normalization/searchKeywords.test.d.ts +1 -0
  645. package/esm/typings/src/utils/normalization/suffixUrl.d.ts +7 -0
  646. package/esm/typings/src/utils/normalization/suffixUrl.test.d.ts +1 -0
  647. package/esm/typings/src/utils/normalization/titleToName.d.ts +9 -0
  648. package/esm/typings/src/utils/normalization/titleToName.test.d.ts +1 -0
  649. package/esm/typings/src/utils/organization/$sideEffect.d.ts +9 -0
  650. package/esm/typings/src/utils/organization/TODO_USE.d.ts +12 -0
  651. package/esm/typings/src/utils/organization/TODO_any.d.ts +6 -0
  652. package/esm/typings/src/utils/organization/TODO_narrow.d.ts +6 -0
  653. package/esm/typings/src/utils/organization/TODO_object.d.ts +6 -0
  654. package/esm/typings/src/utils/organization/TODO_remove_as.d.ts +6 -0
  655. package/esm/typings/src/utils/organization/TODO_string.d.ts +6 -0
  656. package/esm/typings/src/utils/organization/TODO_unknown.d.ts +6 -0
  657. package/esm/typings/src/utils/organization/___and___.d.ts +7 -0
  658. package/esm/typings/src/utils/organization/___or___.d.ts +6 -0
  659. package/esm/typings/src/utils/organization/empty_object.d.ts +10 -0
  660. package/esm/typings/src/utils/organization/just.d.ts +14 -0
  661. package/esm/typings/src/utils/organization/just_empty_object.d.ts +12 -0
  662. package/esm/typings/src/utils/organization/keepTypeImported.d.ts +9 -0
  663. package/esm/typings/src/utils/organization/keepUnused.d.ts +16 -0
  664. package/esm/typings/src/utils/organization/really_any.d.ts +6 -0
  665. package/esm/typings/src/utils/organization/really_unknown.d.ts +6 -0
  666. package/esm/typings/src/utils/organization/spaceTrim.d.ts +11 -0
  667. package/esm/typings/src/utils/parameters/extractParameterNames.d.ts +10 -0
  668. package/esm/typings/src/utils/parameters/extractParameterNames.test.d.ts +1 -0
  669. package/esm/typings/src/utils/parameters/mapAvailableToExpectedParameters.d.ts +27 -0
  670. package/esm/typings/src/utils/parameters/mapAvailableToExpectedParameters.test.d.ts +1 -0
  671. package/esm/typings/src/utils/parameters/numberToString.d.ts +7 -0
  672. package/esm/typings/src/utils/parameters/numberToString.test.d.ts +1 -0
  673. package/esm/typings/src/utils/parameters/templateParameters.d.ts +16 -0
  674. package/esm/typings/src/utils/parameters/templateParameters.test.d.ts +1 -0
  675. package/esm/typings/src/utils/parameters/valueToString.d.ts +17 -0
  676. package/esm/typings/src/utils/parameters/valueToString.test.d.ts +1 -0
  677. package/esm/typings/src/utils/parseNumber.d.ts +16 -0
  678. package/esm/typings/src/utils/parseNumber.test.d.ts +1 -0
  679. package/esm/typings/src/utils/random/$randomSeed.d.ts +10 -0
  680. package/esm/typings/src/utils/random/$randomToken.d.ts +13 -0
  681. package/esm/typings/src/utils/removeEmojis.d.ts +8 -0
  682. package/esm/typings/src/utils/removeEmojis.test.d.ts +1 -0
  683. package/esm/typings/src/utils/removeQuotes.d.ts +14 -0
  684. package/esm/typings/src/utils/removeQuotes.test.d.ts +1 -0
  685. package/esm/typings/src/utils/serialization/$deepFreeze.d.ts +14 -0
  686. package/esm/typings/src/utils/serialization/asSerializable.d.ts +15 -0
  687. package/esm/typings/src/utils/serialization/asSerializable.test.d.ts +1 -0
  688. package/esm/typings/src/utils/serialization/checkSerializableAsJson.d.ts +45 -0
  689. package/esm/typings/src/utils/serialization/clonePipeline.d.ts +14 -0
  690. package/esm/typings/src/utils/serialization/deepClone.d.ts +14 -0
  691. package/esm/typings/src/utils/serialization/deepClone.test.d.ts +1 -0
  692. package/esm/typings/src/utils/serialization/exportJson.d.ts +29 -0
  693. package/esm/typings/src/utils/serialization/isSerializableAsJson.d.ts +25 -0
  694. package/esm/typings/src/utils/serialization/isSerializableAsJson.test.d.ts +1 -0
  695. package/esm/typings/src/utils/serialization/jsonStringsToJsons.d.ts +9 -0
  696. package/esm/typings/src/utils/serialization/jsonStringsToJsons.test.d.ts +1 -0
  697. package/esm/typings/src/utils/sets/difference.d.ts +10 -0
  698. package/esm/typings/src/utils/sets/difference.test.d.ts +1 -0
  699. package/esm/typings/src/utils/sets/intersection.d.ts +7 -0
  700. package/esm/typings/src/utils/sets/intersection.test.d.ts +1 -0
  701. package/esm/typings/src/utils/sets/union.d.ts +7 -0
  702. package/esm/typings/src/utils/sets/union.test.d.ts +1 -0
  703. package/esm/typings/src/utils/trimCodeBlock.d.ts +9 -0
  704. package/esm/typings/src/utils/trimCodeBlock.test.d.ts +1 -0
  705. package/esm/typings/src/utils/trimEndOfCodeBlock.d.ts +9 -0
  706. package/esm/typings/src/utils/trimEndOfCodeBlock.test.d.ts +1 -0
  707. package/esm/typings/src/utils/unwrapResult.d.ts +37 -0
  708. package/esm/typings/src/utils/unwrapResult.test.d.ts +1 -0
  709. package/esm/typings/src/utils/validators/email/isValidEmail.d.ts +8 -0
  710. package/esm/typings/src/utils/validators/email/isValidEmail.test.d.ts +1 -0
  711. package/esm/typings/src/utils/validators/filePath/isRootPath.d.ts +12 -0
  712. package/esm/typings/src/utils/validators/filePath/isRootPath.test.d.ts +4 -0
  713. package/esm/typings/src/utils/validators/filePath/isValidFilePath.d.ts +12 -0
  714. package/esm/typings/src/utils/validators/filePath/isValidFilePath.test.d.ts +1 -0
  715. package/esm/typings/src/utils/validators/javascriptName/isValidJavascriptName.d.ts +10 -0
  716. package/esm/typings/src/utils/validators/javascriptName/isValidJavascriptName.test.d.ts +1 -0
  717. package/esm/typings/src/utils/validators/parameterName/validateParameterName.d.ts +11 -0
  718. package/esm/typings/src/utils/validators/parameterName/validateParameterName.test.d.ts +1 -0
  719. package/esm/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.d.ts +15 -0
  720. package/esm/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.test.d.ts +1 -0
  721. package/esm/typings/src/utils/validators/semanticVersion/isValidSemanticVersion.d.ts +12 -0
  722. package/esm/typings/src/utils/validators/semanticVersion/isValidSemanticVersion.test.d.ts +1 -0
  723. package/esm/typings/src/utils/validators/url/isHostnameOnPrivateNetwork.d.ts +11 -0
  724. package/esm/typings/src/utils/validators/url/isHostnameOnPrivateNetwork.test.d.ts +1 -0
  725. package/esm/typings/src/utils/validators/url/isUrlOnPrivateNetwork.d.ts +13 -0
  726. package/esm/typings/src/utils/validators/url/isUrlOnPrivateNetwork.test.d.ts +1 -0
  727. package/esm/typings/src/utils/validators/url/isValidPipelineUrl.d.ts +15 -0
  728. package/esm/typings/src/utils/validators/url/isValidPipelineUrl.test.d.ts +1 -0
  729. package/esm/typings/src/utils/validators/url/isValidUrl.d.ts +13 -0
  730. package/esm/typings/src/utils/validators/url/isValidUrl.test.d.ts +1 -0
  731. package/esm/typings/src/utils/validators/uuid/isValidUuid.d.ts +8 -0
  732. package/esm/typings/src/utils/validators/uuid/isValidUuid.test.d.ts +1 -0
  733. package/esm/typings/src/version.d.ts +26 -0
  734. package/esm/typings/src/wizard/$getCompiledBook.d.ts +16 -0
  735. package/esm/typings/src/wizard/wizard.d.ts +68 -0
  736. package/package.json +104 -0
  737. package/umd/index.umd.js +16694 -0
  738. package/umd/index.umd.js.map +1 -0
@@ -0,0 +1,41 @@
1
+ import { MultipleLlmExecutionTools } from '../../_multiple/MultipleLlmExecutionTools';
2
+ import type { CreateLlmToolsFromConfigurationOptions } from './createLlmToolsFromConfiguration';
3
+ /**
4
+ * Automatically configures LLM tools from environment variables in Node.js
5
+ *
6
+ * This utility function detects available LLM providers based on environment variables
7
+ * and creates properly configured LLM execution tools for each detected provider.
8
+ *
9
+ * Note: This function is not cached, every call creates new instance of `MultipleLlmExecutionTools`
10
+ *
11
+ * Supports environment variables from .env files when dotenv is configured
12
+ * Note: `$` is used to indicate that this function is not a pure function - it uses filesystem to access `.env` file
13
+ *
14
+ * It looks for environment variables:
15
+ * - `process.env.OPENAI_API_KEY`
16
+ * - `process.env.ANTHROPIC_CLAUDE_API_KEY`
17
+ * - ...
18
+ *
19
+ * @param options Configuration options for the LLM tools
20
+ * @returns A unified interface containing all detected and configured LLM tools
21
+ * @public exported from `@promptbook/node`
22
+ */
23
+ export declare function $provideLlmToolsFromEnv(options?: CreateLlmToolsFromConfigurationOptions): Promise<MultipleLlmExecutionTools>;
24
+ /**
25
+ * TODO: The architecture for LLM tools configuration consists of three key functions:
26
+ * 1. `$provideLlmToolsFromEnv` - High-level function that detects available providers from env vars and returns ready-to-use LLM tools
27
+ * 2. `$provideLlmToolsConfigurationFromEnv` - Middle layer that extracts configuration objects from environment variables
28
+ * 3. `createLlmToolsFromConfiguration` - Low-level function that instantiates LLM tools from explicit configuration
29
+ *
30
+ * This layered approach allows flexibility in how tools are configured:
31
+ * - Use $provideLlmToolsFromEnv for automatic detection and setup in Node.js environments
32
+ * - Use $provideLlmToolsConfigurationFromEnv to extract config objects for modification before instantiation
33
+ * - Use createLlmToolsFromConfiguration for explicit control over tool configurations
34
+ *
35
+ * TODO: [🧠][🍛] Which name is better `$provideLlmToolsFromEnv` or `$provideLlmToolsFromEnvironment`?
36
+ * TODO: [🧠] Is there some meaningfull way how to test this util
37
+ * Note: [ðŸŸĒ] Code in this file should never be never released in packages that could be imported into browser environment
38
+ * TODO: [ðŸĨƒ] Allow `ptbk make` without llm tools
39
+ * TODO: This should be maybe not under `_common` but under `utils`
40
+ * TODO: [ÂŪ] DRY Register logic
41
+ */
@@ -0,0 +1,22 @@
1
+ import type { string_filename } from '../../../types/typeAliases';
2
+ import type { string_markdown } from '../../../types/typeAliases';
3
+ /**
4
+ * Pass the `.env` file which was used to configure LLM tools
5
+ *
6
+ * Note: `$` is used to indicate that this variable is making side effect
7
+ *
8
+ * @private internal log of `$provideLlmToolsConfigurationFromEnv` and `$registeredLlmToolsMessage`
9
+ */
10
+ export declare function $setUsedEnvFilename(filepath: string_filename): void;
11
+ /**
12
+ * Creates a message with all registered LLM tools
13
+ *
14
+ * Note: This function is used to create a (error) message when there is no constructor for some LLM provider
15
+ *
16
+ * @private internal function of `createLlmToolsFromConfiguration` and `$provideLlmToolsFromEnv`
17
+ */
18
+ export declare function $registeredLlmToolsMessage(): string_markdown;
19
+ /**
20
+ * TODO: [ÂŪ] DRY Register logic
21
+ * TODO: [🧠][⚛] Maybe pass env as argument
22
+ */
@@ -0,0 +1,30 @@
1
+ import type { string_title } from '../../../types/typeAliases';
2
+ import type { Registered } from '../../../utils/$Register';
3
+ import type { LlmToolsOptions } from './LlmToolsOptions';
4
+ /**
5
+ * Configuration definition for LLM execution tools, containing provider-specific settings
6
+ * that can be passed during runtime to instantiate and configure LLM tools properly.
7
+ *
8
+ * The Promptbook LLM tools architecture involves several related types:
9
+ * - `LlmToolsMetadata`: Contains static metadata about the tool, such as name, version, and capabilities
10
+ * - `LlmToolsConfiguration`: Runtime configuration from environment variables or settings
11
+ * - `LlmToolsOptions`: Provider-specific options for instantiating tools
12
+ * - `Registered`: The record of a registered tool in the global registry
13
+ */
14
+ export type LlmToolsConfiguration = ReadonlyArray<Registered & {
15
+ /**
16
+ * Human-readable name for this specific provider configuration
17
+ * Used in UI components and logs for identifying this particular configuration
18
+ */
19
+ readonly title: string_title;
20
+ /**
21
+ * Provider-specific configuration options used for instantiating and configuring LLM tools
22
+ * Contains values like API keys, model preferences, endpoint URLs, and other settings
23
+ */
24
+ readonly options: LlmToolsOptions;
25
+ }>;
26
+ /**
27
+ * TODO: [🧠][🌰] `title` is redundant BUT maybe allow each provider pass it's own title for tracking purposes
28
+ * TODO: Maybe instead of `LlmToolsConfiguration[number]` make `LlmToolsConfigurationItem`
29
+ * TODO: [ÂŪ] DRY Register logic
30
+ */
@@ -0,0 +1,58 @@
1
+ import { MODEL_ORDERS } from '../../../constants';
2
+ import { MODEL_TRUST_LEVELS } from '../../../constants';
3
+ import type { string_name } from '../../../types/typeAliases';
4
+ import type { string_title } from '../../../types/typeAliases';
5
+ import type { Registered } from '../../../utils/$Register';
6
+ import type { string_SCREAMING_CASE } from '../../../utils/normalization/normalizeTo_SCREAMING_CASE';
7
+ import type { LlmToolsConfiguration } from './LlmToolsConfiguration';
8
+ /**
9
+ * Metadata definition for LLM execution tools that provides information about a provider's capabilities,
10
+ * configuration options, and relationships within the registry system.
11
+ *
12
+ * The Promptbook LLM tools architecture involves several related types:
13
+ * - `LlmToolsMetadata`: Contains static metadata about the tool, such as name, version, and capabilities
14
+ * - `LlmToolsConfiguration`: Runtime configuration from environment variables or settings
15
+ * - `LlmToolsOptions`: Provider-specific options for instantiating tools
16
+ * - `Registered`: The record of a registered tool in the global registry
17
+ */
18
+ export type LlmToolsMetadata = Registered & {
19
+ /**
20
+ * Human-readable display name for the LLM provider
21
+ * Used in UI components and documentation references
22
+ */
23
+ readonly title: string_title;
24
+ /**
25
+ * How is the model is trusted?
26
+ */
27
+ readonly trustLevel: keyof typeof MODEL_TRUST_LEVELS;
28
+ /**
29
+ * How is the model provider important and should be sorted in the list of available providers?
30
+ */
31
+ readonly order: typeof MODEL_ORDERS[keyof typeof MODEL_ORDERS] | number;
32
+ /**
33
+ * List of environment variables that can be used to configure the provider
34
+ *
35
+ * If `[]`, empty array, it means that the provider is available automatically without any configuration
36
+ * If `null`, it means that the provider can not be configured via environment variables
37
+ */
38
+ readonly envVariables: ReadonlyArray<string_name & string_SCREAMING_CASE> | null;
39
+ /**
40
+ * Provides a default configuration template for this LLM provider
41
+ * Used to generate example configurations or as fallback when no specific configuration is provided
42
+ * @returns A standardized configuration object for this LLM provider
43
+ */
44
+ getBoilerplateConfiguration(): LlmToolsConfiguration[number];
45
+ /**
46
+ * Creates a provider-specific configuration object from environment variables
47
+ * Used to automatically configure LLM tools based on available environment settings
48
+ *
49
+ * @param env Dictionary of environment variables (key-value pairs)
50
+ * @returns Configuration object for this LLM provider if required variables are present, or null if configuration is not possible
51
+ */
52
+ createConfigurationFromEnv(env: Record<string_name, string>): LlmToolsConfiguration[number] | null;
53
+ };
54
+ /**
55
+ * TODO: Add configuration schema and maybe some documentation link
56
+ * TODO: Maybe constrain LlmToolsConfiguration[number] by generic to ensure that `createConfigurationFromEnv` and `getBoilerplateConfiguration` always create same `packageName` and `className`
57
+ * TODO: [ÂŪ] DRY Register logic
58
+ */
@@ -0,0 +1,17 @@
1
+ import type { TODO_object } from '../../../utils/organization/TODO_object';
2
+ /**
3
+ * Options for configuring LLM (Large Language Model) tools.
4
+ *
5
+ * This type is used to pass provider-specific options to LLM execution tools.
6
+ *
7
+ *
8
+ * The Promptbook LLM tools architecture involves several related types:
9
+ * - `LlmToolsMetadata`: Contains static metadata about the tool, such as name, version, and capabilities
10
+ * - `LlmToolsConfiguration`: Runtime configuration from environment variables or settings
11
+ * - `LlmToolsOptions`: Provider-specific options for instantiating tools
12
+ * - `Registered`: The record of a registered tool in the global registry
13
+ */
14
+ export type LlmToolsOptions = TODO_object;
15
+ /**
16
+ * TODO: [ÂŪ] DRY Register logic
17
+ */
@@ -0,0 +1,49 @@
1
+ import type { string_user_id } from '../../../types/typeAliases';
2
+ import { MultipleLlmExecutionTools } from '../../_multiple/MultipleLlmExecutionTools';
3
+ import type { LlmToolsConfiguration } from './LlmToolsConfiguration';
4
+ /**
5
+ * Options for `$provideLlmToolsFromEnv`
6
+ *
7
+ * @private internal type for `$provideLlmToolsFromEnv` and `$provideLlmToolsForTestingAndScriptsAndPlayground`
8
+ */
9
+ export type CreateLlmToolsFromConfigurationOptions = {
10
+ /**
11
+ * This will will be passed to the created `LlmExecutionTools`
12
+ *
13
+ * @default false
14
+ */
15
+ isVerbose?: boolean;
16
+ /**
17
+ * Identifier of the end user
18
+ *
19
+ * Note: This is passed to the LLM tools providers to identify misuse
20
+ */
21
+ readonly userId?: string_user_id;
22
+ };
23
+ /**
24
+ * Creates LLM execution tools from provided configuration objects
25
+ *
26
+ * Instantiates and configures LLM tool instances for each configuration entry,
27
+ * combining them into a unified interface via MultipleLlmExecutionTools.
28
+ *
29
+ * Note: This function is not cached, every call creates new instance of `MultipleLlmExecutionTools`
30
+ *
31
+ * @param configuration Array of LLM tool configurations to instantiate
32
+ * @param options Additional options for configuring the LLM tools
33
+ * @returns A unified interface combining all successfully instantiated LLM tools
34
+ * @public exported from `@promptbook/core`
35
+ */
36
+ export declare function createLlmToolsFromConfiguration(configuration: LlmToolsConfiguration, options?: CreateLlmToolsFromConfigurationOptions): MultipleLlmExecutionTools;
37
+ /**
38
+ * TODO: [🎌] Together with `createLlmToolsFromConfiguration` + 'EXECUTION_TOOLS_CLASSES' gets to `@promptbook/core` ALL model providers, make this more efficient
39
+ * TODO: [🧠][🎌] Dynamically install required providers
40
+ * TODO: We should implement an interactive configuration wizard that would:
41
+ * 1. Detect which LLM providers are available in the environment
42
+ * 2. Guide users through required configuration settings for each provider
43
+ * 3. Allow testing connections before completing setup
44
+ * 4. Generate appropriate configuration code for application integration
45
+ * TODO: [🧠][🍛] Which name is better `createLlmToolsFromConfig` or `createLlmToolsFromConfiguration`?
46
+ * TODO: [🧠] Is there some meaningfull way how to test this util
47
+ * TODO: This should be maybe not under `_common` but under `utils`
48
+ * TODO: [ÂŪ] DRY Register logic
49
+ */
@@ -0,0 +1,33 @@
1
+ import type { PromptResult } from '../../../../execution/PromptResult';
2
+ import type { Prompt } from '../../../../types/Prompt';
3
+ import type { string_date_iso8601 } from '../../../../types/typeAliases';
4
+ import type { string_semantic_version } from '../../../../types/typeAliases';
5
+ import type { string_promptbook_version } from '../../../../version';
6
+ /**
7
+ * Represents a single item stored in the LLM cache.
8
+ */
9
+ export type CacheItem = {
10
+ /**
11
+ * The date and time when the cache item was created, in ISO 8601 format.
12
+ */
13
+ date: string_date_iso8601;
14
+ /**
15
+ * The version of the Promptbook library used when this cache item was created.
16
+ */
17
+ promptbookVersion?: string_promptbook_version;
18
+ /**
19
+ * The version of the Book language used when this cache item was created.
20
+ */
21
+ bookVersion?: string_semantic_version;
22
+ /**
23
+ * The prompt that was sent to the LLM.
24
+ */
25
+ prompt: Prompt;
26
+ /**
27
+ * The response received from the LLM.
28
+ */
29
+ promptResult: PromptResult;
30
+ };
31
+ /**
32
+ * TODO: [🧠] Should be this exported alongsite `cacheLlmTools` through `@promptbook/utils` OR through `@promptbook/types`
33
+ */
@@ -0,0 +1,27 @@
1
+ import type { PromptbookStorage } from '../../../../storage/_common/PromptbookStorage';
2
+ import type { CacheItem } from './CacheItem';
3
+ /**
4
+ * Options for configuring caching behavior for LlmExecutionTools.
5
+ */
6
+ export type CacheLlmToolsOptions = {
7
+ /**
8
+ * The cache provider instance to use for storing and retrieving cached data.
9
+ *
10
+ * @default MemoryStorage
11
+ */
12
+ storage: PromptbookStorage<CacheItem>;
13
+ /**
14
+ * When set to `true`, the cache will be reloaded regardless of whether the data is already present in the cache.
15
+ * This can be useful for debugging or when you want to ensure that the latest data is always fetched.
16
+ * Data will ne still saved to the cache.
17
+ *
18
+ * @default false
19
+ */
20
+ isCacheReloaded?: boolean;
21
+ /**
22
+ * If true, the preparation logs additional information
23
+ *
24
+ * @default DEFAULT_IS_VERBOSE
25
+ */
26
+ readonly isVerbose?: boolean;
27
+ };
@@ -0,0 +1,19 @@
1
+ import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
2
+ import type { CacheLlmToolsOptions } from './CacheLlmToolsOptions';
3
+ /**
4
+ * Intercepts LLM tools and counts total usage of the tools
5
+ *
6
+ * Note: It can take extended `LlmExecutionTools` and cache the
7
+ *
8
+ * @param llmTools LLM tools to be intercepted with usage counting, it can contain extra methods like `totalUsage`
9
+ * @returns LLM tools with same functionality with added total cost counting
10
+ * @public exported from `@promptbook/core`
11
+ */
12
+ export declare function cacheLlmTools<TLlmTools extends LlmExecutionTools>(llmTools: TLlmTools, options?: Partial<CacheLlmToolsOptions>): TLlmTools;
13
+ /**
14
+ * TODO: [🧠][ðŸ’ļ] Maybe make some common abstraction `interceptLlmTools` and use here (or use javascript Proxy?)
15
+ * TODO: [🧠] Is there some meaningfull way how to test this util
16
+ * TODO: [👷‍♂ïļ] Comprehensive manual about construction of llmTools
17
+ * Detailed explanation about caching strategies and appropriate storage selection for different use cases
18
+ * Examples of how to combine multiple interceptors for advanced caching, logging, and usage tracking
19
+ */
@@ -0,0 +1,22 @@
1
+ import type { Observable } from 'rxjs';
2
+ import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
3
+ import type { Usage } from '../../../../execution/Usage';
4
+ /**
5
+ * LLM tools with option to get total usage of the execution
6
+ */
7
+ export type LlmExecutionToolsWithTotalUsage = LlmExecutionTools & {
8
+ /**
9
+ * Get total cost of the execution up to this point
10
+ */
11
+ getTotalUsage(): Usage;
12
+ /**
13
+ * Observable of total cost of the execution up to this point
14
+ *
15
+ * Note: This does report the cost of the last prompt, not the total cost of the execution up to this point
16
+ */
17
+ spending(): Observable<Usage>;
18
+ };
19
+ /**
20
+ * TODO: [👷‍♂ïļ] @@@ Manual about construction of llmTools
21
+ * Note: [ðŸĨŦ] Not using getter `get totalUsage` but `getTotalUsage` to allow this object to be proxied
22
+ */
@@ -0,0 +1,17 @@
1
+ import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
2
+ import type { LlmExecutionToolsWithTotalUsage } from './LlmExecutionToolsWithTotalUsage';
3
+ /**
4
+ * Intercepts LLM tools and counts total usage of the tools
5
+ *
6
+ * @param llmTools LLM tools to be intercepted with usage counting
7
+ * @returns LLM tools with same functionality with added total cost counting
8
+ * @public exported from `@promptbook/core`
9
+ */
10
+ export declare function countUsage(llmTools: LlmExecutionTools): LlmExecutionToolsWithTotalUsage;
11
+ /**
12
+ * TODO: [🧠][ðŸ’ļ] Maybe make some common abstraction `interceptLlmTools` and use here (or use javascript Proxy?)
13
+ * TODO: [🧠] Is there some meaningfull way how to test this util
14
+ * TODO: [🧠][ðŸŒŊ] Maybe a way how to hide ability to `get totalUsage`
15
+ * > const [llmToolsWithUsage,getUsage] = countTotalUsage(llmTools);
16
+ * TODO: [👷‍♂ïļ] @@@ Manual about construction of llmTools
17
+ */
@@ -0,0 +1,36 @@
1
+ import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
2
+ import type { Usage } from '../../../../execution/Usage';
3
+ import type { PromptbookStorage } from '../../../../storage/_common/PromptbookStorage';
4
+ import type { TODO_any } from '../../../../utils/organization/TODO_any';
5
+ import type { LlmExecutionToolsWithTotalUsage } from './LlmExecutionToolsWithTotalUsage';
6
+ /**
7
+ * Options for the `limitTotalUsage` function.
8
+ */
9
+ type LimitTotalUsageOptions = {
10
+ /**
11
+ * The usage limits to apply.
12
+ *
13
+ * @default ZERO_USAGE
14
+ */
15
+ maxTotalUsage: Usage;
16
+ /**
17
+ * The storage mechanism to use for tracking usage across multiple executions or instances.
18
+ *
19
+ * @default MemoryStorage which will not persist when the process ends
20
+ */
21
+ storage: PromptbookStorage<TODO_any>;
22
+ };
23
+ /**
24
+ * Wraps LlmExecutionTools to limit the total usage based on provided limits.
25
+ *
26
+ * @public exported from `@promptbook/core`
27
+ */
28
+ export declare function limitTotalUsage(llmTools: LlmExecutionTools, options?: Partial<LimitTotalUsageOptions>): LlmExecutionToolsWithTotalUsage;
29
+ export {};
30
+ /**
31
+ * TODO: Maybe internally use `countTotalUsage`
32
+ * TODO: [🧠][ðŸ’ļ] Maybe make some common abstraction `interceptLlmTools` and use here (or use javascript Proxy?)
33
+ * TODO: [🧠] Is there some meaningfull way how to test this util
34
+ * TODO: [🧠][ðŸŒŊ] Maybe a way how to hide ability to `get totalUsage`
35
+ * TODO: [👷‍♂ïļ] @@@ Manual about construction of llmTools
36
+ */
@@ -0,0 +1,16 @@
1
+ /**
2
+ * String value found on OpenAI and Anthropic Claude page
3
+ *
4
+ * @see https://openai.com/api/pricing/
5
+ * @see https://docs.anthropic.com/en/docs/models-overview
6
+ *
7
+ * @private within the repository, used only as internal helper for `OPENAI_MODELS` and `computeUsage`
8
+ */
9
+ type string_model_price = `$${number}.${number} / ${number}M tokens`;
10
+ /**
11
+ * Create price per one token based on the string value found on openai page
12
+ *
13
+ * @private within the repository, used only as internal helper for `OPENAI_MODELS`
14
+ */
15
+ export declare function pricing(value: string_model_price): number;
16
+ export {};
@@ -0,0 +1,63 @@
1
+ import type { AvailableModel } from '../../execution/AvailableModel';
2
+ import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
3
+ import type { ChatPromptResult } from '../../execution/PromptResult';
4
+ import type { CompletionPromptResult } from '../../execution/PromptResult';
5
+ import type { EmbeddingPromptResult } from '../../execution/PromptResult';
6
+ import type { PromptResult } from '../../execution/PromptResult';
7
+ import type { ChatPrompt } from '../../types/Prompt';
8
+ import type { CompletionPrompt } from '../../types/Prompt';
9
+ import type { EmbeddingPrompt } from '../../types/Prompt';
10
+ import type { Prompt } from '../../types/Prompt';
11
+ import type { string_markdown } from '../../types/typeAliases';
12
+ import type { string_markdown_text } from '../../types/typeAliases';
13
+ import type { string_title } from '../../types/typeAliases';
14
+ /**
15
+ * Multiple LLM Execution Tools is a proxy server that uses multiple execution tools internally and exposes the executor interface externally.
16
+ *
17
+ * Note: Internal utility of `joinLlmExecutionTools` but exposed type
18
+ * @public exported from `@promptbook/core`
19
+ */
20
+ export declare class MultipleLlmExecutionTools implements LlmExecutionTools {
21
+ /**
22
+ * Array of execution tools in order of priority
23
+ */
24
+ readonly llmExecutionTools: ReadonlyArray<LlmExecutionTools>;
25
+ /**
26
+ * Gets array of execution tools in order of priority
27
+ */
28
+ constructor(...llmExecutionTools: ReadonlyArray<LlmExecutionTools>);
29
+ get title(): string_title & string_markdown_text;
30
+ get description(): string_markdown;
31
+ /**
32
+ * Check the configuration of all execution tools
33
+ */
34
+ checkConfiguration(): Promise<void>;
35
+ /**
36
+ * List all available models that can be used
37
+ * This lists is a combination of all available models from all execution tools
38
+ */
39
+ listModels(): Promise<ReadonlyArray<AvailableModel>>;
40
+ /**
41
+ * Calls the best available chat model
42
+ */
43
+ callChatModel(prompt: ChatPrompt): Promise<ChatPromptResult>;
44
+ /**
45
+ * Calls the best available completion model
46
+ */
47
+ callCompletionModel(prompt: CompletionPrompt): Promise<CompletionPromptResult>;
48
+ /**
49
+ * Calls the best available embedding model
50
+ */
51
+ callEmbeddingModel(prompt: EmbeddingPrompt): Promise<EmbeddingPromptResult>;
52
+ /**
53
+ * Calls the best available model
54
+ *
55
+ * Note: This should be private or protected but is public to be usable with duck typing
56
+ */
57
+ callCommonModel(prompt: Prompt): Promise<PromptResult>;
58
+ }
59
+ /**
60
+ * TODO: [🧠][🎛] Aggregating multiple models - have result not only from one first available model BUT all of them
61
+ * TODO: [🏖] If no llmTools have for example not defined `callCompletionModel` this will still return object with defined `callCompletionModel` which just throws `PipelineExecutionError`, make it undefined instead
62
+ * Look how `countTotalUsage` (and `cacheLlmTools`) implements it
63
+ */
@@ -0,0 +1,21 @@
1
+ import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
2
+ import { MultipleLlmExecutionTools } from './MultipleLlmExecutionTools';
3
+ /**
4
+ * Joins multiple LLM Execution Tools into one
5
+ *
6
+ * @returns {LlmExecutionTools} Single wrapper for multiple LlmExecutionTools
7
+ *
8
+ * 0) If there is no LlmExecutionTools, it warns and returns valid but empty LlmExecutionTools
9
+ * 1) If there is only one LlmExecutionTools, it returns it wrapped in a proxy object
10
+ * 2) If there are multiple LlmExecutionTools, first will be used first, second will be used if the first hasn`t defined model variant or fails, etc.
11
+ * 3) When all LlmExecutionTools fail, it throws an error with a list of all errors merged into one
12
+ *
13
+ *
14
+ * Tip: You don't have to use this function directly, just pass an array of LlmExecutionTools to the `ExecutionTools`
15
+ *
16
+ * @public exported from `@promptbook/core`
17
+ */
18
+ export declare function joinLlmExecutionTools(...llmExecutionTools: ReadonlyArray<LlmExecutionTools>): MultipleLlmExecutionTools;
19
+ /**
20
+ * TODO: [👷‍♂ïļ] @@@ Manual about construction of llmTools
21
+ */
@@ -0,0 +1,5 @@
1
+ #!/usr/bin/env ts-node
2
+ export {};
3
+ /**
4
+ * Note: [âšŦ] Code in this file should never be published in any package
5
+ */
@@ -0,0 +1,66 @@
1
+ import Anthropic from '@anthropic-ai/sdk';
2
+ import type { AvailableModel } from '../../execution/AvailableModel';
3
+ import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
4
+ import type { ChatPromptResult } from '../../execution/PromptResult';
5
+ import type { CompletionPromptResult } from '../../execution/PromptResult';
6
+ import type { Prompt } from '../../types/Prompt';
7
+ import type { string_markdown } from '../../types/typeAliases';
8
+ import type { string_markdown_text } from '../../types/typeAliases';
9
+ import type { string_title } from '../../types/typeAliases';
10
+ import type { AnthropicClaudeExecutionToolsDirectOptions } from './AnthropicClaudeExecutionToolsOptions';
11
+ /**
12
+ * Execution Tools for calling Anthropic Claude API.
13
+ *
14
+ * @public exported from `@promptbook/anthropic-claude`
15
+ * @deprecated use `createAnthropicClaudeExecutionTools` instead
16
+ */
17
+ export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools {
18
+ protected readonly options: AnthropicClaudeExecutionToolsDirectOptions;
19
+ /**
20
+ * Anthropic Claude API client.
21
+ */
22
+ private client;
23
+ private limiter;
24
+ /**
25
+ * Creates Anthropic Claude Execution Tools.
26
+ *
27
+ * @param options which are relevant are directly passed to the Anthropic Claude client
28
+ */
29
+ constructor(options?: AnthropicClaudeExecutionToolsDirectOptions);
30
+ get title(): string_title & string_markdown_text;
31
+ get description(): string_markdown;
32
+ getClient(): Promise<Anthropic>;
33
+ /**
34
+ * Check the `options` passed to `constructor`
35
+ */
36
+ checkConfiguration(): Promise<void>;
37
+ /**
38
+ * List all available Anthropic Claude models that can be used
39
+ */
40
+ listModels(): ReadonlyArray<AvailableModel>;
41
+ /**
42
+ * Calls Anthropic Claude API to use a chat model.
43
+ */
44
+ callChatModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<ChatPromptResult>;
45
+ /**
46
+ * Calls Anthropic Claude API to use a completion model.
47
+ */
48
+ callCompletionModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<CompletionPromptResult>;
49
+ /**
50
+ * Get the model that should be used as default
51
+ */
52
+ private getDefaultModel;
53
+ /**
54
+ * Default model for chat variant.
55
+ */
56
+ private getDefaultChatModel;
57
+ }
58
+ /**
59
+ * TODO: [🍆] JSON mode
60
+ * TODO: [🧠] Maybe handle errors via transformAnthropicError (like transformAzureError)
61
+ * TODO: Maybe Create some common util for callChatModel and callCompletionModel
62
+ * TODO: Maybe make custom OpenAiError
63
+ * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
64
+ * TODO: [🧠][🌰] Allow to pass `title` for tracking purposes
65
+ * TODO: [📅] Maybe instead of `RemoteLlmExecutionToolsOptions` use `proxyWithAnonymousRemoteServer` (if implemented)
66
+ */
@@ -0,0 +1,31 @@
1
+ import type { ClientOptions } from '@anthropic-ai/sdk';
2
+ import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
3
+ import type { RemoteClientOptions } from '../../remote-server/types/RemoteClientOptions';
4
+ /**
5
+ * Options for `createAnthropicClaudeExecutionTools` and `AnthropicClaudeExecutionTools`
6
+ *
7
+ * This extends Anthropic's `ClientOptions` with are directly passed to the Anthropic client.
8
+ * @public exported from `@promptbook/anthropic-claude`
9
+ */
10
+ export type AnthropicClaudeExecutionToolsOptions = AnthropicClaudeExecutionToolsDirectOptions | AnthropicClaudeExecutionToolsProxiedOptions;
11
+ /**
12
+ * Options for directly used `AnthropicClaudeExecutionTools`
13
+ *
14
+ * This extends Anthropic's `ClientOptions` with are directly passed to the Anthropic client.
15
+ * @public exported from `@promptbook/anthropic-claude`
16
+ */
17
+ export type AnthropicClaudeExecutionToolsDirectOptions = CommonToolsOptions & ClientOptions & {
18
+ isProxied?: false;
19
+ };
20
+ /**
21
+ * Options for proxied `AnthropicClaudeExecutionTools`
22
+ *
23
+ * This extends Anthropic's `ClientOptions` with are directly passed to the Anthropic client.
24
+ * @public exported from `@promptbook/anthropic-claude`
25
+ */
26
+ export type AnthropicClaudeExecutionToolsProxiedOptions = CommonToolsOptions & ClientOptions & {
27
+ isProxied: true;
28
+ } & Pick<RemoteClientOptions<undefined>, 'remoteServerUrl'>;
29
+ /**
30
+ * TODO: [🧠][ðŸĪš] Pass `userId`
31
+ */
@@ -0,0 +1,24 @@
1
+ import type { AvailableModel } from '../../execution/AvailableModel';
2
+ import type { number_usd } from '../../types/typeAliases';
3
+ /**
4
+ * List of available Anthropic Claude models with pricing
5
+ *
6
+ * Note: Done at 2025-05-06
7
+ *
8
+ * @see https://docs.anthropic.com/en/docs/models-overview
9
+ * @public exported from `@promptbook/anthropic-claude`
10
+ */
11
+ export declare const ANTHROPIC_CLAUDE_MODELS: ReadonlyArray<AvailableModel & {
12
+ pricing?: {
13
+ readonly prompt: number_usd;
14
+ readonly output: number_usd;
15
+ };
16
+ }>;
17
+ /**
18
+ * Note: [ðŸĪ–] Add models of new variant
19
+ * TODO: [🧠][main] !!3 Add embedding models OR Anthropic has only chat+completion models?
20
+ * TODO: [🧠] Some mechanism to propagate unsureness
21
+ * TODO: [🧠][ðŸ‘Ū‍♀ïļ] Put here more info like description, isVision, trainingDateCutoff, languages, strengths ( Top-level performance, intelligence, fluency, and understanding), contextWindow,...
22
+ * TODO: [🎰] Some mechanism to auto-update available models
23
+ * Note: [💞] Ignore a discrepancy between file name and entity name
24
+ */
@@ -0,0 +1,18 @@
1
+ import type Anthropic from '@anthropic-ai/sdk';
2
+ import type { PartialDeep } from 'type-fest';
3
+ import type { Usage } from '../../execution/Usage';
4
+ import type { Prompt } from '../../types/Prompt';
5
+ /**
6
+ * Computes the usage of the Anthropic Claude API based on the response from Anthropic Claude
7
+ *
8
+ * @param promptContent The content of the prompt
9
+ * @param resultContent The content of the result (for embedding prompts or failed prompts pass empty string)
10
+ * @param rawResponse The raw response from Anthropic Claude API
11
+ * @throws {PipelineExecutionError} If the usage is not defined in the response from Anthropic Claude
12
+ * @private internal utility of `AnthropicClaudeExecutionTools`
13
+ */
14
+ export declare function computeAnthropicClaudeUsage(promptContent: Prompt['content'], // <- Note: Intentionally using [] to access type properties to bring jsdoc from Prompt/PromptResult to consumer
15
+ resultContent: string, rawResponse: PartialDeep<Pick<Anthropic.Messages.Message, 'model' | 'usage'>>): Usage;
16
+ /**
17
+ * TODO: [ðŸĪ] DRY Maybe some common abstraction between `computeOpenAiUsage` and `computeAnthropicClaudeUsage`
18
+ */
@@ -0,0 +1,4 @@
1
+ export {};
2
+ /**
3
+ * TODO: [ðŸĪ] DRY Maybe some common abstraction between `computeOpenAiUsage` and `computeAnthropicClaudeUsage`
4
+ */