@promptbook/color 0.100.0-48

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 (839) hide show
  1. package/README.md +481 -0
  2. package/esm/index.es.js +1040 -0
  3. package/esm/index.es.js.map +1 -0
  4. package/esm/typings/books/index.d.ts +131 -0
  5. package/esm/typings/src/_packages/anthropic-claude.index.d.ts +16 -0
  6. package/esm/typings/src/_packages/azure-openai.index.d.ts +10 -0
  7. package/esm/typings/src/_packages/browser.index.d.ts +12 -0
  8. package/esm/typings/src/_packages/cli.index.d.ts +64 -0
  9. package/esm/typings/src/_packages/color.index.d.ts +50 -0
  10. package/esm/typings/src/_packages/components.index.d.ts +32 -0
  11. package/esm/typings/src/_packages/core.index.d.ts +328 -0
  12. package/esm/typings/src/_packages/deepseek.index.d.ts +10 -0
  13. package/esm/typings/src/_packages/documents.index.d.ts +8 -0
  14. package/esm/typings/src/_packages/editable.index.d.ts +90 -0
  15. package/esm/typings/src/_packages/fake-llm.index.d.ts +6 -0
  16. package/esm/typings/src/_packages/google.index.d.ts +12 -0
  17. package/esm/typings/src/_packages/javascript.index.d.ts +10 -0
  18. package/esm/typings/src/_packages/legacy-documents.index.d.ts +8 -0
  19. package/esm/typings/src/_packages/markdown-utils.index.d.ts +48 -0
  20. package/esm/typings/src/_packages/markitdown.index.d.ts +8 -0
  21. package/esm/typings/src/_packages/node.index.d.ts +24 -0
  22. package/esm/typings/src/_packages/ollama.index.d.ts +14 -0
  23. package/esm/typings/src/_packages/openai.index.d.ts +32 -0
  24. package/esm/typings/src/_packages/pdf.index.d.ts +14 -0
  25. package/esm/typings/src/_packages/remote-client.index.d.ts +16 -0
  26. package/esm/typings/src/_packages/remote-server.index.d.ts +12 -0
  27. package/esm/typings/src/_packages/templates.index.d.ts +4 -0
  28. package/esm/typings/src/_packages/types.index.d.ts +656 -0
  29. package/esm/typings/src/_packages/utils.index.d.ts +170 -0
  30. package/esm/typings/src/_packages/vercel.index.d.ts +6 -0
  31. package/esm/typings/src/_packages/website-crawler.index.d.ts +8 -0
  32. package/esm/typings/src/_packages/wizard.index.d.ts +64 -0
  33. package/esm/typings/src/book-2.0/agent-source/parseAgentSource.d.ts +30 -0
  34. package/esm/typings/src/book-2.0/agent-source/parseAgentSource.test.d.ts +1 -0
  35. package/esm/typings/src/book-2.0/agent-source/string_book.d.ts +26 -0
  36. package/esm/typings/src/book-2.0/commitments/ACTION/ACTION.d.ts +38 -0
  37. package/esm/typings/src/book-2.0/commitments/FORMAT/FORMAT.d.ts +39 -0
  38. package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/FrontendRAGService.d.ts +48 -0
  39. package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/KNOWLEDGE.d.ts +51 -0
  40. package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/RAGService.d.ts +54 -0
  41. package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/processors/BaseKnowledgeProcessor.d.ts +45 -0
  42. package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/processors/PdfProcessor.d.ts +31 -0
  43. package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/processors/ProcessorFactory.d.ts +23 -0
  44. package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/processors/TextProcessor.d.ts +18 -0
  45. package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/types.d.ts +56 -0
  46. package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/utils/ragHelper.d.ts +34 -0
  47. package/esm/typings/src/book-2.0/commitments/META_IMAGE/META_IMAGE.d.ts +44 -0
  48. package/esm/typings/src/book-2.0/commitments/META_LINK/META_LINK.d.ts +56 -0
  49. package/esm/typings/src/book-2.0/commitments/MODEL/MODEL.d.ts +39 -0
  50. package/esm/typings/src/book-2.0/commitments/NOTE/NOTE.d.ts +49 -0
  51. package/esm/typings/src/book-2.0/commitments/PERSONA/PERSONA.d.ts +46 -0
  52. package/esm/typings/src/book-2.0/commitments/RULE/RULE.d.ts +44 -0
  53. package/esm/typings/src/book-2.0/commitments/SAMPLE/SAMPLE.d.ts +44 -0
  54. package/esm/typings/src/book-2.0/commitments/STYLE/STYLE.d.ts +38 -0
  55. package/esm/typings/src/book-2.0/commitments/_base/BaseCommitmentDefinition.d.ts +52 -0
  56. package/esm/typings/src/book-2.0/commitments/_base/BookCommitment.d.ts +5 -0
  57. package/esm/typings/src/book-2.0/commitments/_base/CommitmentDefinition.d.ts +48 -0
  58. package/esm/typings/src/book-2.0/commitments/_base/NotYetImplementedCommitmentDefinition.d.ts +22 -0
  59. package/esm/typings/src/book-2.0/commitments/_base/createEmptyAgentModelRequirements.d.ts +19 -0
  60. package/esm/typings/src/book-2.0/commitments/_misc/AgentModelRequirements.d.ts +37 -0
  61. package/esm/typings/src/book-2.0/commitments/_misc/AgentSourceParseResult.d.ts +18 -0
  62. package/esm/typings/src/book-2.0/commitments/_misc/ParsedCommitment.d.ts +22 -0
  63. package/esm/typings/src/book-2.0/commitments/_misc/createAgentModelRequirements.d.ts +61 -0
  64. package/esm/typings/src/book-2.0/commitments/_misc/createAgentModelRequirementsWithCommitments.d.ts +35 -0
  65. package/esm/typings/src/book-2.0/commitments/_misc/createCommitmentRegex.d.ts +20 -0
  66. package/esm/typings/src/book-2.0/commitments/_misc/parseAgentSourceWithCommitments.d.ts +24 -0
  67. package/esm/typings/src/book-2.0/commitments/_misc/removeCommentsFromSystemMessage.d.ts +11 -0
  68. package/esm/typings/src/book-2.0/commitments/index.d.ts +56 -0
  69. package/esm/typings/src/book-2.0/utils/profileImageUtils.d.ts +39 -0
  70. package/esm/typings/src/book-components/AvatarProfile/AvatarChip/AvatarChip.d.ts +35 -0
  71. package/esm/typings/src/book-components/AvatarProfile/AvatarChip/AvatarChipFromSource.d.ts +21 -0
  72. package/esm/typings/src/book-components/AvatarProfile/AvatarChip/index.d.ts +2 -0
  73. package/esm/typings/src/book-components/AvatarProfile/AvatarProfile/AvatarProfile.d.ts +26 -0
  74. package/esm/typings/src/book-components/AvatarProfile/AvatarProfile/AvatarProfileFromSource.d.ts +19 -0
  75. package/esm/typings/src/book-components/BookEditor/BookEditor.d.ts +35 -0
  76. package/esm/typings/src/book-components/BookEditor/BookEditorInner.d.ts +15 -0
  77. package/esm/typings/src/book-components/BookEditor/config.d.ts +10 -0
  78. package/esm/typings/src/book-components/BookEditor/injectCssModuleIntoShadowRoot.d.ts +11 -0
  79. package/esm/typings/src/book-components/Chat/Chat/Chat.d.ts +130 -0
  80. package/esm/typings/src/book-components/Chat/interfaces/ChatMessage.d.ts +16 -0
  81. package/esm/typings/src/book-components/Chat/interfaces/ChatParticipant.d.ts +32 -0
  82. package/esm/typings/src/book-components/Chat/utils/ExportFormat.d.ts +4 -0
  83. package/esm/typings/src/book-components/Chat/utils/addUtmParamsToUrl.d.ts +7 -0
  84. package/esm/typings/src/book-components/Chat/utils/createShortLinkForChat.d.ts +7 -0
  85. package/esm/typings/src/book-components/Chat/utils/downloadFile.d.ts +6 -0
  86. package/esm/typings/src/book-components/Chat/utils/exportChatHistory.d.ts +9 -0
  87. package/esm/typings/src/book-components/Chat/utils/generatePdfContent.d.ts +8 -0
  88. package/esm/typings/src/book-components/Chat/utils/generateQrDataUrl.d.ts +7 -0
  89. package/esm/typings/src/book-components/Chat/utils/getPromptbookBranding.d.ts +6 -0
  90. package/esm/typings/src/book-components/Chat/utils/messagesToHtml.d.ts +8 -0
  91. package/esm/typings/src/book-components/Chat/utils/messagesToJson.d.ts +7 -0
  92. package/esm/typings/src/book-components/Chat/utils/messagesToMarkdown.d.ts +8 -0
  93. package/esm/typings/src/book-components/Chat/utils/messagesToText.d.ts +8 -0
  94. package/esm/typings/src/book-components/_common/react-utils/classNames.d.ts +7 -0
  95. package/esm/typings/src/book-components/_common/react-utils/collectCssTextsForClass.d.ts +7 -0
  96. package/esm/typings/src/book-components/_common/react-utils/escapeHtml.d.ts +6 -0
  97. package/esm/typings/src/book-components/_common/react-utils/escapeRegex.d.ts +6 -0
  98. package/esm/typings/src/cli/cli-commands/_boilerplate.d.ts +13 -0
  99. package/esm/typings/src/cli/cli-commands/about.d.ts +14 -0
  100. package/esm/typings/src/cli/cli-commands/common/handleActionErrors.d.ts +11 -0
  101. package/esm/typings/src/cli/cli-commands/hello.d.ts +14 -0
  102. package/esm/typings/src/cli/cli-commands/list-models.d.ts +13 -0
  103. package/esm/typings/src/cli/cli-commands/list-scrapers.d.ts +13 -0
  104. package/esm/typings/src/cli/cli-commands/login.d.ts +14 -0
  105. package/esm/typings/src/cli/cli-commands/make.d.ts +16 -0
  106. package/esm/typings/src/cli/cli-commands/prettify.d.ts +15 -0
  107. package/esm/typings/src/cli/cli-commands/run.d.ts +17 -0
  108. package/esm/typings/src/cli/cli-commands/runInteractiveChatbot.d.ts +32 -0
  109. package/esm/typings/src/cli/cli-commands/start-server.d.ts +13 -0
  110. package/esm/typings/src/cli/cli-commands/test-command.d.ts +16 -0
  111. package/esm/typings/src/cli/common/$addGlobalOptionsToCommand.d.ts +7 -0
  112. package/esm/typings/src/cli/common/$provideLlmToolsForCli.d.ts +28 -0
  113. package/esm/typings/src/cli/main.d.ts +16 -0
  114. package/esm/typings/src/cli/promptbookCli.d.ts +13 -0
  115. package/esm/typings/src/cli/test/ptbk.d.ts +5 -0
  116. package/esm/typings/src/cli/test/ptbk.test.d.ts +1 -0
  117. package/esm/typings/src/collection/PipelineCollection.d.ts +25 -0
  118. package/esm/typings/src/collection/SimplePipelineCollection.d.ts +37 -0
  119. package/esm/typings/src/collection/collectionToJson.d.ts +13 -0
  120. package/esm/typings/src/collection/collectionToJson.test.d.ts +7 -0
  121. package/esm/typings/src/collection/constructors/createCollectionFromDirectory.d.ts +65 -0
  122. package/esm/typings/src/collection/constructors/createCollectionFromDirectory.test.d.ts +1 -0
  123. package/esm/typings/src/collection/constructors/createCollectionFromJson.d.ts +13 -0
  124. package/esm/typings/src/collection/constructors/createCollectionFromJson.test.d.ts +1 -0
  125. package/esm/typings/src/collection/constructors/createCollectionFromPromise.d.ts +23 -0
  126. package/esm/typings/src/collection/constructors/createCollectionFromPromise.test.d.ts +1 -0
  127. package/esm/typings/src/collection/constructors/createCollectionFromUrl.d.ts +29 -0
  128. package/esm/typings/src/collection/constructors/createSubcollection.d.ts +13 -0
  129. package/esm/typings/src/commands/BOOK_VERSION/BookVersionCommand.d.ts +11 -0
  130. package/esm/typings/src/commands/BOOK_VERSION/bookVersionCommand.test.d.ts +1 -0
  131. package/esm/typings/src/commands/BOOK_VERSION/bookVersionCommandParser.d.ts +9 -0
  132. package/esm/typings/src/commands/EXPECT/ExpectCommand.d.ts +17 -0
  133. package/esm/typings/src/commands/EXPECT/expectCommand.test.d.ts +1 -0
  134. package/esm/typings/src/commands/EXPECT/expectCommandParser.d.ts +11 -0
  135. package/esm/typings/src/commands/FOREACH/ForeachCommand.d.ts +10 -0
  136. package/esm/typings/src/commands/FOREACH/ForeachJson.d.ts +27 -0
  137. package/esm/typings/src/commands/FOREACH/foreachCommand.test.d.ts +1 -0
  138. package/esm/typings/src/commands/FOREACH/foreachCommandParser.d.ts +12 -0
  139. package/esm/typings/src/commands/FORMAT/FormatCommand.d.ts +9 -0
  140. package/esm/typings/src/commands/FORMAT/formatCommand.test.d.ts +1 -0
  141. package/esm/typings/src/commands/FORMAT/formatCommandParser.d.ts +9 -0
  142. package/esm/typings/src/commands/FORMFACTOR/FormfactorCommand.d.ts +11 -0
  143. package/esm/typings/src/commands/FORMFACTOR/formfactorCommand.test.d.ts +1 -0
  144. package/esm/typings/src/commands/FORMFACTOR/formfactorCommandParser.d.ts +11 -0
  145. package/esm/typings/src/commands/JOKER/JokerCommand.d.ts +11 -0
  146. package/esm/typings/src/commands/JOKER/jokerCommand.test.d.ts +1 -0
  147. package/esm/typings/src/commands/JOKER/jokerCommandParser.d.ts +9 -0
  148. package/esm/typings/src/commands/KNOWLEDGE/KnowledgeCommand.d.ts +11 -0
  149. package/esm/typings/src/commands/KNOWLEDGE/knowledgeCommand.test.d.ts +1 -0
  150. package/esm/typings/src/commands/KNOWLEDGE/knowledgeCommandParser.d.ts +12 -0
  151. package/esm/typings/src/commands/KNOWLEDGE/utils/knowledgeSourceContentToName.d.ts +11 -0
  152. package/esm/typings/src/commands/KNOWLEDGE/utils/knowledgeSourceContentToName.test.d.ts +4 -0
  153. package/esm/typings/src/commands/MODEL/ModelCommand.d.ts +14 -0
  154. package/esm/typings/src/commands/MODEL/modelCommand.test.d.ts +1 -0
  155. package/esm/typings/src/commands/MODEL/modelCommandParser.d.ts +10 -0
  156. package/esm/typings/src/commands/PARAMETER/ParameterCommand.d.ts +15 -0
  157. package/esm/typings/src/commands/PARAMETER/parameterCommand.test.d.ts +1 -0
  158. package/esm/typings/src/commands/PARAMETER/parameterCommandParser.d.ts +9 -0
  159. package/esm/typings/src/commands/PERSONA/PersonaCommand.d.ts +13 -0
  160. package/esm/typings/src/commands/PERSONA/personaCommand.test.d.ts +1 -0
  161. package/esm/typings/src/commands/PERSONA/personaCommandParser.d.ts +9 -0
  162. package/esm/typings/src/commands/POSTPROCESS/PostprocessCommand.d.ts +11 -0
  163. package/esm/typings/src/commands/POSTPROCESS/postprocessCommand.test.d.ts +1 -0
  164. package/esm/typings/src/commands/POSTPROCESS/postprocessCommandParser.d.ts +9 -0
  165. package/esm/typings/src/commands/SECTION/SectionCommand.d.ts +11 -0
  166. package/esm/typings/src/commands/SECTION/sectionCommand.test.d.ts +1 -0
  167. package/esm/typings/src/commands/SECTION/sectionCommandParser.d.ts +20 -0
  168. package/esm/typings/src/commands/URL/UrlCommand.d.ts +10 -0
  169. package/esm/typings/src/commands/URL/urlCommand.test.d.ts +1 -0
  170. package/esm/typings/src/commands/URL/urlCommandParser.d.ts +9 -0
  171. package/esm/typings/src/commands/X_ACTION/ActionCommand.d.ts +9 -0
  172. package/esm/typings/src/commands/X_ACTION/actionCommand.test.d.ts +1 -0
  173. package/esm/typings/src/commands/X_ACTION/actionCommandParser.d.ts +12 -0
  174. package/esm/typings/src/commands/X_INSTRUMENT/InstrumentCommand.d.ts +9 -0
  175. package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommand.test.d.ts +1 -0
  176. package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommandParser.d.ts +12 -0
  177. package/esm/typings/src/commands/_BOILERPLATE/BoilerplateCommand.d.ts +10 -0
  178. package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommand.test.d.ts +1 -0
  179. package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts +11 -0
  180. package/esm/typings/src/commands/_common/getParserForCommand.d.ts +11 -0
  181. package/esm/typings/src/commands/_common/getParserForCommand.test.d.ts +1 -0
  182. package/esm/typings/src/commands/_common/parseCommand.d.ts +12 -0
  183. package/esm/typings/src/commands/_common/parseCommand.test.d.ts +1 -0
  184. package/esm/typings/src/commands/_common/stringifyCommand.d.ts +12 -0
  185. package/esm/typings/src/commands/_common/stringifyCommand.test.d.ts +1 -0
  186. package/esm/typings/src/commands/_common/types/Command.d.ts +6 -0
  187. package/esm/typings/src/commands/_common/types/CommandParser.d.ts +205 -0
  188. package/esm/typings/src/commands/_common/types/CommandType.d.ts +17 -0
  189. package/esm/typings/src/commands/_common/types/CommandUsagePlaces.d.ts +13 -0
  190. package/esm/typings/src/commands/index.d.ts +9 -0
  191. package/esm/typings/src/config.d.ts +332 -0
  192. package/esm/typings/src/config.test.d.ts +4 -0
  193. package/esm/typings/src/constants.d.ts +76 -0
  194. package/esm/typings/src/conversion/archive/loadArchive.d.ts +16 -0
  195. package/esm/typings/src/conversion/archive/saveArchive.d.ts +18 -0
  196. package/esm/typings/src/conversion/compilePipeline.d.ts +25 -0
  197. package/esm/typings/src/conversion/compilePipeline.test.d.ts +1 -0
  198. package/esm/typings/src/conversion/compilePipelineOnRemoteServer.d.ts +21 -0
  199. package/esm/typings/src/conversion/parsePipeline.d.ts +30 -0
  200. package/esm/typings/src/conversion/parsePipeline.test.d.ts +1 -0
  201. package/esm/typings/src/conversion/pipelineJsonToString.d.ts +18 -0
  202. package/esm/typings/src/conversion/prettify/PrettifyOptions.d.ts +13 -0
  203. package/esm/typings/src/conversion/prettify/prettifyPipelineString.d.ts +12 -0
  204. package/esm/typings/src/conversion/prettify/renderPipelineMermaidOptions.d.ts +30 -0
  205. package/esm/typings/src/conversion/utils/extractParameterNamesFromTask.d.ts +15 -0
  206. package/esm/typings/src/conversion/utils/extractParameterNamesFromTask.test.d.ts +1 -0
  207. package/esm/typings/src/conversion/validation/_importPipeline.d.ts +23 -0
  208. package/esm/typings/src/conversion/validation/pipelineStringToJson-parseErrors.test.d.ts +4 -0
  209. package/esm/typings/src/conversion/validation/validatePipeline-logicErrors.test.d.ts +4 -0
  210. package/esm/typings/src/conversion/validation/validatePipeline.d.ts +42 -0
  211. package/esm/typings/src/conversion/validation/validatePipeline.test.d.ts +4 -0
  212. package/esm/typings/src/dialogs/callback/CallbackInterfaceTools.d.ts +17 -0
  213. package/esm/typings/src/dialogs/callback/CallbackInterfaceToolsOptions.d.ts +14 -0
  214. package/esm/typings/src/dialogs/simple-prompt/SimplePromptInterfaceTools.d.ts +22 -0
  215. package/esm/typings/src/dialogs/user-interface-execution-tools.test.d.ts +1 -0
  216. package/esm/typings/src/errors/0-BoilerplateError.d.ts +12 -0
  217. package/esm/typings/src/errors/0-index.d.ts +94 -0
  218. package/esm/typings/src/errors/AbstractFormatError.d.ts +11 -0
  219. package/esm/typings/src/errors/AuthenticationError.d.ts +9 -0
  220. package/esm/typings/src/errors/CollectionError.d.ts +9 -0
  221. package/esm/typings/src/errors/EnvironmentMismatchError.d.ts +9 -0
  222. package/esm/typings/src/errors/ExpectError.d.ts +12 -0
  223. package/esm/typings/src/errors/KnowledgeScrapeError.d.ts +9 -0
  224. package/esm/typings/src/errors/LimitReachedError.d.ts +9 -0
  225. package/esm/typings/src/errors/MissingToolsError.d.ts +9 -0
  226. package/esm/typings/src/errors/NotFoundError.d.ts +9 -0
  227. package/esm/typings/src/errors/NotYetImplementedError.d.ts +9 -0
  228. package/esm/typings/src/errors/ParseError.d.ts +12 -0
  229. package/esm/typings/src/errors/PipelineExecutionError.d.ts +14 -0
  230. package/esm/typings/src/errors/PipelineLogicError.d.ts +9 -0
  231. package/esm/typings/src/errors/PipelineUrlError.d.ts +9 -0
  232. package/esm/typings/src/errors/PromptbookFetchError.d.ts +9 -0
  233. package/esm/typings/src/errors/UnexpectedError.d.ts +9 -0
  234. package/esm/typings/src/errors/WrappedError.d.ts +10 -0
  235. package/esm/typings/src/errors/assertsError.d.ts +11 -0
  236. package/esm/typings/src/errors/utils/ErrorJson.d.ts +25 -0
  237. package/esm/typings/src/errors/utils/deserializeError.d.ts +7 -0
  238. package/esm/typings/src/errors/utils/deserializeError.test.d.ts +1 -0
  239. package/esm/typings/src/errors/utils/getErrorReportUrl.d.ts +6 -0
  240. package/esm/typings/src/errors/utils/serializeError.d.ts +7 -0
  241. package/esm/typings/src/errors/utils/serializeError.test.d.ts +1 -0
  242. package/esm/typings/src/executables/$provideExecutablesForNode.d.ts +12 -0
  243. package/esm/typings/src/executables/apps/locateLibreoffice.d.ts +12 -0
  244. package/esm/typings/src/executables/apps/locateLibreoffice.test.d.ts +1 -0
  245. package/esm/typings/src/executables/apps/locatePandoc.d.ts +12 -0
  246. package/esm/typings/src/executables/apps/locatePandoc.test.d.ts +1 -0
  247. package/esm/typings/src/executables/locateApp.d.ts +33 -0
  248. package/esm/typings/src/executables/locateApp.test.d.ts +1 -0
  249. package/esm/typings/src/executables/platforms/locateAppOnLinux.d.ts +13 -0
  250. package/esm/typings/src/executables/platforms/locateAppOnMacOs.d.ts +13 -0
  251. package/esm/typings/src/executables/platforms/locateAppOnWindows.d.ts +13 -0
  252. package/esm/typings/src/execution/AbstractTaskResult.d.ts +25 -0
  253. package/esm/typings/src/execution/AvailableModel.d.ts +50 -0
  254. package/esm/typings/src/execution/CommonToolsOptions.d.ts +28 -0
  255. package/esm/typings/src/execution/EmbeddingVector.d.ts +8 -0
  256. package/esm/typings/src/execution/Executables.d.ts +18 -0
  257. package/esm/typings/src/execution/ExecutionTask.d.ts +145 -0
  258. package/esm/typings/src/execution/ExecutionTools.d.ts +69 -0
  259. package/esm/typings/src/execution/FilesystemTools.d.ts +9 -0
  260. package/esm/typings/src/execution/LlmExecutionTools.d.ts +61 -0
  261. package/esm/typings/src/execution/LlmExecutionToolsConstructor.d.ts +11 -0
  262. package/esm/typings/src/execution/PipelineExecutor.d.ts +16 -0
  263. package/esm/typings/src/execution/PipelineExecutorResult.d.ts +39 -0
  264. package/esm/typings/src/execution/PromptResult.d.ts +101 -0
  265. package/esm/typings/src/execution/PromptbookFetch.d.ts +12 -0
  266. package/esm/typings/src/execution/PromptbookFetch.test-type.d.ts +5 -0
  267. package/esm/typings/src/execution/ScriptExecutionTools.d.ts +39 -0
  268. package/esm/typings/src/execution/UncertainNumber.d.ts +19 -0
  269. package/esm/typings/src/execution/Usage.d.ts +33 -0
  270. package/esm/typings/src/execution/UserInterfaceTools.d.ts +46 -0
  271. package/esm/typings/src/execution/assertsTaskSuccessful.d.ts +14 -0
  272. package/esm/typings/src/execution/createPipelineExecutor/$OngoingTaskResult.d.ts +56 -0
  273. package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorOptions.d.ts +46 -0
  274. package/esm/typings/src/execution/createPipelineExecutor/00-createPipelineExecutor.d.ts +10 -0
  275. package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts +48 -0
  276. package/esm/typings/src/execution/createPipelineExecutor/20-executeTask.d.ts +51 -0
  277. package/esm/typings/src/execution/createPipelineExecutor/30-executeFormatSubvalues.d.ts +27 -0
  278. package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +75 -0
  279. package/esm/typings/src/execution/createPipelineExecutor/computeCosineSimilarity.d.ts +13 -0
  280. package/esm/typings/src/execution/createPipelineExecutor/filterJustOutputParameters.d.ts +35 -0
  281. package/esm/typings/src/execution/createPipelineExecutor/getContextForTask.d.ts +14 -0
  282. package/esm/typings/src/execution/createPipelineExecutor/getExamplesForTask.d.ts +10 -0
  283. package/esm/typings/src/execution/createPipelineExecutor/getKnowledgeForTask.d.ts +42 -0
  284. package/esm/typings/src/execution/createPipelineExecutor/getReservedParametersForTask.d.ts +48 -0
  285. package/esm/typings/src/execution/createPipelineExecutor/knowledgePiecesToString.d.ts +9 -0
  286. package/esm/typings/src/execution/embeddingVectorToString.d.ts +7 -0
  287. package/esm/typings/src/execution/execution-report/ExecutionPromptReportJson.d.ts +24 -0
  288. package/esm/typings/src/execution/execution-report/ExecutionReportJson.d.ts +41 -0
  289. package/esm/typings/src/execution/execution-report/ExecutionReportString.d.ts +16 -0
  290. package/esm/typings/src/execution/execution-report/ExecutionReportStringOptions.d.ts +25 -0
  291. package/esm/typings/src/execution/execution-report/countWorkingDuration.d.ts +7 -0
  292. package/esm/typings/src/execution/execution-report/countWorkingDuration.test.d.ts +1 -0
  293. package/esm/typings/src/execution/execution-report/executionReportJsonToString.d.ts +15 -0
  294. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/AutomaticTranslator.d.ts +7 -0
  295. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/DebugAutomaticTranslator.d.ts +11 -0
  296. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/FakeAutomaticTranslator.d.ts +8 -0
  297. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/LindatAutomaticTranslator.d.ts +22 -0
  298. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/TranslatorOptions.d.ts +7 -0
  299. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.d.ts +8 -0
  300. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.test.d.ts +1 -0
  301. package/esm/typings/src/execution/translation/automatic-translate/translateMessages.d.ts +12 -0
  302. package/esm/typings/src/execution/utils/$provideExecutionToolsForNode.d.ts +13 -0
  303. package/esm/typings/src/execution/utils/addUsage.d.ts +9 -0
  304. package/esm/typings/src/execution/utils/addUsage.test.d.ts +1 -0
  305. package/esm/typings/src/execution/utils/checkExpectations.d.ts +29 -0
  306. package/esm/typings/src/execution/utils/checkExpectations.test.d.ts +1 -0
  307. package/esm/typings/src/execution/utils/computeUsageCounts.d.ts +10 -0
  308. package/esm/typings/src/execution/utils/forEachAsync.d.ts +20 -0
  309. package/esm/typings/src/execution/utils/uncertainNumber.d.ts +10 -0
  310. package/esm/typings/src/execution/utils/usage-constants.d.ts +147 -0
  311. package/esm/typings/src/execution/utils/usageToHuman.d.ts +26 -0
  312. package/esm/typings/src/execution/utils/usageToWorktime.d.ts +20 -0
  313. package/esm/typings/src/execution/utils/usageToWorktime.test.d.ts +1 -0
  314. package/esm/typings/src/execution/utils/validatePromptResult.d.ts +53 -0
  315. package/esm/typings/src/expectations/drafts/isDomainNameFree.d.ts +10 -0
  316. package/esm/typings/src/expectations/drafts/isGithubNameFree.d.ts +10 -0
  317. package/esm/typings/src/formats/_common/FormatParser.d.ts +72 -0
  318. package/esm/typings/src/formats/_common/FormatSubvalueParser.d.ts +66 -0
  319. package/esm/typings/src/formats/csv/CsvFormatError.d.ts +10 -0
  320. package/esm/typings/src/formats/csv/CsvFormatParser.d.ts +17 -0
  321. package/esm/typings/src/formats/csv/CsvSettings.d.ts +13 -0
  322. package/esm/typings/src/formats/csv/utils/csvParse.d.ts +12 -0
  323. package/esm/typings/src/formats/csv/utils/isValidCsvString.d.ts +9 -0
  324. package/esm/typings/src/formats/csv/utils/isValidCsvString.test.d.ts +1 -0
  325. package/esm/typings/src/formats/index.d.ts +9 -0
  326. package/esm/typings/src/formats/json/JsonFormatParser.d.ts +19 -0
  327. package/esm/typings/src/formats/json/utils/isValidJsonString.d.ts +9 -0
  328. package/esm/typings/src/formats/json/utils/isValidJsonString.test.d.ts +1 -0
  329. package/esm/typings/src/formats/json/utils/jsonParse.d.ts +8 -0
  330. package/esm/typings/src/formats/text/TextFormatParser.d.ts +19 -0
  331. package/esm/typings/src/formats/xml/XmlFormatParser.d.ts +19 -0
  332. package/esm/typings/src/formats/xml/utils/isValidXmlString.d.ts +9 -0
  333. package/esm/typings/src/formats/xml/utils/isValidXmlString.test.d.ts +1 -0
  334. package/esm/typings/src/formfactors/_boilerplate/BoilerplateFormfactorDefinition.d.ts +15 -0
  335. package/esm/typings/src/formfactors/_common/AbstractFormfactorDefinition.d.ts +49 -0
  336. package/esm/typings/src/formfactors/_common/FormfactorDefinition.d.ts +10 -0
  337. package/esm/typings/src/formfactors/_common/string_formfactor_name.d.ts +6 -0
  338. package/esm/typings/src/formfactors/chatbot/ChatbotFormfactorDefinition.d.ts +45 -0
  339. package/esm/typings/src/formfactors/completion/CompletionFormfactorDefinition.d.ts +29 -0
  340. package/esm/typings/src/formfactors/generator/GeneratorFormfactorDefinition.d.ts +25 -0
  341. package/esm/typings/src/formfactors/generic/GenericFormfactorDefinition.d.ts +14 -0
  342. package/esm/typings/src/formfactors/image-generator/ImageGeneratorFormfactorDefinition.d.ts +24 -0
  343. package/esm/typings/src/formfactors/index.d.ts +170 -0
  344. package/esm/typings/src/formfactors/matcher/MatcherFormfactorDefinition.d.ts +21 -0
  345. package/esm/typings/src/formfactors/sheets/SheetsFormfactorDefinition.d.ts +26 -0
  346. package/esm/typings/src/formfactors/translator/TranslatorFormfactorDefinition.d.ts +25 -0
  347. package/esm/typings/src/high-level-abstractions/_common/HighLevelAbstraction.d.ts +20 -0
  348. package/esm/typings/src/high-level-abstractions/implicit-formfactor/ImplicitFormfactorHla.d.ts +10 -0
  349. package/esm/typings/src/high-level-abstractions/index.d.ts +54 -0
  350. package/esm/typings/src/high-level-abstractions/quick-chatbot/QuickChatbotHla.d.ts +13 -0
  351. package/esm/typings/src/llm-providers/_common/filterModels.d.ts +15 -0
  352. package/esm/typings/src/llm-providers/_common/register/$llmToolsMetadataRegister.d.ts +13 -0
  353. package/esm/typings/src/llm-providers/_common/register/$llmToolsRegister.d.ts +13 -0
  354. package/esm/typings/src/llm-providers/_common/register/$provideEnvFilename.d.ts +12 -0
  355. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsConfigurationFromEnv.d.ts +19 -0
  356. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForTestingAndScriptsAndPlayground.d.ts +27 -0
  357. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForWizardOrCli.d.ts +59 -0
  358. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsFromEnv.d.ts +41 -0
  359. package/esm/typings/src/llm-providers/_common/register/$registeredLlmToolsMessage.d.ts +22 -0
  360. package/esm/typings/src/llm-providers/_common/register/LlmToolsConfiguration.d.ts +30 -0
  361. package/esm/typings/src/llm-providers/_common/register/LlmToolsMetadata.d.ts +58 -0
  362. package/esm/typings/src/llm-providers/_common/register/LlmToolsOptions.d.ts +17 -0
  363. package/esm/typings/src/llm-providers/_common/register/createLlmToolsFromConfiguration.d.ts +49 -0
  364. package/esm/typings/src/llm-providers/_common/register/createLlmToolsFromConfiguration.test.d.ts +1 -0
  365. package/esm/typings/src/llm-providers/_common/utils/cache/CacheItem.d.ts +33 -0
  366. package/esm/typings/src/llm-providers/_common/utils/cache/CacheLlmToolsOptions.d.ts +27 -0
  367. package/esm/typings/src/llm-providers/_common/utils/cache/cacheLlmTools.d.ts +19 -0
  368. package/esm/typings/src/llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage.d.ts +22 -0
  369. package/esm/typings/src/llm-providers/_common/utils/count-total-usage/countUsage.d.ts +17 -0
  370. package/esm/typings/src/llm-providers/_common/utils/count-total-usage/limitTotalUsage.d.ts +36 -0
  371. package/esm/typings/src/llm-providers/_common/utils/pricing.d.ts +16 -0
  372. package/esm/typings/src/llm-providers/_common/utils/pricing.test.d.ts +1 -0
  373. package/esm/typings/src/llm-providers/_multiple/MultipleLlmExecutionTools.d.ts +63 -0
  374. package/esm/typings/src/llm-providers/_multiple/joinLlmExecutionTools.d.ts +21 -0
  375. package/esm/typings/src/llm-providers/_multiple/playground/playground.d.ts +5 -0
  376. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +61 -0
  377. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions.d.ts +31 -0
  378. package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +24 -0
  379. package/esm/typings/src/llm-providers/anthropic-claude/computeAnthropicClaudeUsage.d.ts +18 -0
  380. package/esm/typings/src/llm-providers/anthropic-claude/computeAnthropicClaudeUsage.test.d.ts +4 -0
  381. package/esm/typings/src/llm-providers/anthropic-claude/createAnthropicClaudeExecutionTools.d.ts +19 -0
  382. package/esm/typings/src/llm-providers/anthropic-claude/playground/playground.d.ts +7 -0
  383. package/esm/typings/src/llm-providers/anthropic-claude/register-configuration.d.ts +14 -0
  384. package/esm/typings/src/llm-providers/anthropic-claude/register-constructor.d.ts +16 -0
  385. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +67 -0
  386. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionToolsOptions.d.ts +37 -0
  387. package/esm/typings/src/llm-providers/azure-openai/createAzureOpenAiExecutionTools.d.ts +15 -0
  388. package/esm/typings/src/llm-providers/azure-openai/playground/playground.d.ts +6 -0
  389. package/esm/typings/src/llm-providers/azure-openai/register-configuration.d.ts +14 -0
  390. package/esm/typings/src/llm-providers/azure-openai/register-constructor.d.ts +15 -0
  391. package/esm/typings/src/llm-providers/deepseek/DeepseekExecutionToolsOptions.d.ts +9 -0
  392. package/esm/typings/src/llm-providers/deepseek/createDeepseekExecutionTools.d.ts +14 -0
  393. package/esm/typings/src/llm-providers/deepseek/deepseek-models.d.ts +23 -0
  394. package/esm/typings/src/llm-providers/deepseek/register-configuration.d.ts +14 -0
  395. package/esm/typings/src/llm-providers/deepseek/register-constructor.d.ts +15 -0
  396. package/esm/typings/src/llm-providers/google/GoogleExecutionToolsOptions.d.ts +9 -0
  397. package/esm/typings/src/llm-providers/google/createGoogleExecutionTools.d.ts +14 -0
  398. package/esm/typings/src/llm-providers/google/google-models.d.ts +23 -0
  399. package/esm/typings/src/llm-providers/google/register-configuration.d.ts +14 -0
  400. package/esm/typings/src/llm-providers/google/register-constructor.d.ts +15 -0
  401. package/esm/typings/src/llm-providers/mocked/$fakeTextToExpectations.d.ts +15 -0
  402. package/esm/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts +40 -0
  403. package/esm/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts +44 -0
  404. package/esm/typings/src/llm-providers/mocked/test/fakeTextToExpectations.test.d.ts +1 -0
  405. package/esm/typings/src/llm-providers/mocked/test/faked-completion.test.d.ts +1 -0
  406. package/esm/typings/src/llm-providers/mocked/test/joker.test.d.ts +4 -0
  407. package/esm/typings/src/llm-providers/mocked/test/mocked-chat.test.d.ts +5 -0
  408. package/esm/typings/src/llm-providers/mocked/test/mocked-completion.test.d.ts +4 -0
  409. package/esm/typings/src/llm-providers/ollama/OllamaExecutionTools.d.ts +44 -0
  410. package/esm/typings/src/llm-providers/ollama/OllamaExecutionToolsOptions.d.ts +23 -0
  411. package/esm/typings/src/llm-providers/ollama/createOllamaExecutionTools.d.ts +11 -0
  412. package/esm/typings/src/llm-providers/ollama/ollama-models.d.ts +14 -0
  413. package/esm/typings/src/llm-providers/ollama/playground/playground.d.ts +6 -0
  414. package/esm/typings/src/llm-providers/ollama/register-configuration.d.ts +14 -0
  415. package/esm/typings/src/llm-providers/ollama/register-constructor.d.ts +15 -0
  416. package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionTools.d.ts +36 -0
  417. package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionToolsOptions.d.ts +14 -0
  418. package/esm/typings/src/llm-providers/openai/OpenAiCompatibleExecutionTools.d.ts +99 -0
  419. package/esm/typings/src/llm-providers/openai/OpenAiCompatibleExecutionToolsOptions.d.ts +52 -0
  420. package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +38 -0
  421. package/esm/typings/src/llm-providers/openai/OpenAiExecutionToolsOptions.d.ts +9 -0
  422. package/esm/typings/src/llm-providers/openai/computeOpenAiUsage.d.ts +18 -0
  423. package/esm/typings/src/llm-providers/openai/computeOpenAiUsage.test.d.ts +4 -0
  424. package/esm/typings/src/llm-providers/openai/createOpenAiAssistantExecutionTools.d.ts +15 -0
  425. package/esm/typings/src/llm-providers/openai/createOpenAiCompatibleExecutionTools.d.ts +74 -0
  426. package/esm/typings/src/llm-providers/openai/createOpenAiExecutionTools.d.ts +17 -0
  427. package/esm/typings/src/llm-providers/openai/openai-models.d.ts +25 -0
  428. package/esm/typings/src/llm-providers/openai/playground/playground.d.ts +6 -0
  429. package/esm/typings/src/llm-providers/openai/register-configuration.d.ts +35 -0
  430. package/esm/typings/src/llm-providers/openai/register-constructor.d.ts +39 -0
  431. package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts +59 -0
  432. package/esm/typings/src/llm-providers/remote/playground/playground.d.ts +5 -0
  433. package/esm/typings/src/llm-providers/vercel/VercelExecutionToolsOptions.d.ts +23 -0
  434. package/esm/typings/src/llm-providers/vercel/VercelProvider.d.ts +13 -0
  435. package/esm/typings/src/llm-providers/vercel/createExecutionToolsFromVercelProvider.d.ts +8 -0
  436. package/esm/typings/src/llm-providers/vercel/playground/playground.d.ts +6 -0
  437. package/esm/typings/src/migrations/migratePipeline.d.ts +9 -0
  438. package/esm/typings/src/other/templates/getBookTemplates.d.ts +24 -0
  439. package/esm/typings/src/other/templates/getTemplatesPipelineCollection.d.ts +10 -0
  440. package/esm/typings/src/personas/preparePersona.d.ts +17 -0
  441. package/esm/typings/src/pipeline/PipelineInterface/PipelineInterface.d.ts +22 -0
  442. package/esm/typings/src/pipeline/PipelineInterface/constants.d.ts +14 -0
  443. package/esm/typings/src/pipeline/PipelineInterface/getPipelineInterface.d.ts +11 -0
  444. package/esm/typings/src/pipeline/PipelineInterface/isPipelineImplementingInterface.d.ts +27 -0
  445. package/esm/typings/src/pipeline/PipelineInterface/isPipelineInterfacesEqual.d.ts +10 -0
  446. package/esm/typings/src/pipeline/PipelineJson/CommonTaskJson.d.ts +103 -0
  447. package/esm/typings/src/pipeline/PipelineJson/DialogTaskJson.d.ts +13 -0
  448. package/esm/typings/src/pipeline/PipelineJson/Expectations.d.ts +40 -0
  449. package/esm/typings/src/pipeline/PipelineJson/KnowledgePieceJson.d.ts +73 -0
  450. package/esm/typings/src/pipeline/PipelineJson/KnowledgeSourceJson.d.ts +44 -0
  451. package/esm/typings/src/pipeline/PipelineJson/ParameterJson.d.ts +98 -0
  452. package/esm/typings/src/pipeline/PipelineJson/PersonaJson.d.ts +47 -0
  453. package/esm/typings/src/pipeline/PipelineJson/PipelineJson.d.ts +113 -0
  454. package/esm/typings/src/pipeline/PipelineJson/PreparationJson.d.ts +22 -0
  455. package/esm/typings/src/pipeline/PipelineJson/PromptTaskJson.d.ts +26 -0
  456. package/esm/typings/src/pipeline/PipelineJson/ScriptTaskJson.d.ts +20 -0
  457. package/esm/typings/src/pipeline/PipelineJson/SimpleTaskJson.d.ts +13 -0
  458. package/esm/typings/src/pipeline/PipelineJson/TaskJson.d.ts +11 -0
  459. package/esm/typings/src/pipeline/PipelineString.d.ts +11 -0
  460. package/esm/typings/src/pipeline/book-notation.d.ts +20 -0
  461. package/esm/typings/src/pipeline/isValidPipelineString.d.ts +13 -0
  462. package/esm/typings/src/pipeline/isValidPipelineString.test.d.ts +4 -0
  463. package/esm/typings/src/pipeline/prompt-notation.d.ts +31 -0
  464. package/esm/typings/src/pipeline/prompt-notation.test.d.ts +4 -0
  465. package/esm/typings/src/pipeline/validatePipelineString.d.ts +14 -0
  466. package/esm/typings/src/playground/permanent/error-handling-playground.d.ts +5 -0
  467. package/esm/typings/src/playground/playground.d.ts +5 -0
  468. package/esm/typings/src/postprocessing/utils/extractBlock.d.ts +16 -0
  469. package/esm/typings/src/postprocessing/utils/extractJsonBlock.d.ts +25 -0
  470. package/esm/typings/src/postprocessing/utils/extractJsonBlock.test.d.ts +1 -0
  471. package/esm/typings/src/prepare/PrepareAndScrapeOptions.d.ts +51 -0
  472. package/esm/typings/src/prepare/isPipelinePrepared.d.ts +18 -0
  473. package/esm/typings/src/prepare/isPipelinePrepared.test.d.ts +1 -0
  474. package/esm/typings/src/prepare/preparePipeline.d.ts +22 -0
  475. package/esm/typings/src/prepare/preparePipelineOnRemoteServer.d.ts +17 -0
  476. package/esm/typings/src/prepare/prepareTasks.d.ts +36 -0
  477. package/esm/typings/src/prepare/unpreparePipeline.d.ts +13 -0
  478. package/esm/typings/src/remote-server/RemoteServer.d.ts +23 -0
  479. package/esm/typings/src/remote-server/createRemoteClient.d.ts +10 -0
  480. package/esm/typings/src/remote-server/openapi-types.d.ts +626 -0
  481. package/esm/typings/src/remote-server/openapi.d.ts +581 -0
  482. package/esm/typings/src/remote-server/socket-types/_common/PromptbookServer_Error.d.ts +7 -0
  483. package/esm/typings/src/remote-server/socket-types/_subtypes/Identification.d.ts +59 -0
  484. package/esm/typings/src/remote-server/socket-types/_subtypes/identificationToPromptbookToken.d.ts +11 -0
  485. package/esm/typings/src/remote-server/socket-types/_subtypes/promptbookTokenToIdentification.d.ts +10 -0
  486. package/esm/typings/src/remote-server/socket-types/listModels/PromptbookServer_ListModels_Request.d.ts +17 -0
  487. package/esm/typings/src/remote-server/socket-types/listModels/PromptbookServer_ListModels_Response.d.ts +17 -0
  488. package/esm/typings/src/remote-server/socket-types/prepare/PromptbookServer_PreparePipeline_Request.d.ts +17 -0
  489. package/esm/typings/src/remote-server/socket-types/prepare/PromptbookServer_PreparePipeline_Response.d.ts +12 -0
  490. package/esm/typings/src/remote-server/socket-types/prompt/PromptbookServer_Prompt_Request.d.ts +17 -0
  491. package/esm/typings/src/remote-server/socket-types/prompt/PromptbookServer_Prompt_Response.d.ts +12 -0
  492. package/esm/typings/src/remote-server/startRemoteServer.d.ts +25 -0
  493. package/esm/typings/src/remote-server/types/RemoteClientOptions.d.ts +24 -0
  494. package/esm/typings/src/remote-server/types/RemoteServerOptions.d.ts +164 -0
  495. package/esm/typings/src/scrapers/_boilerplate/BoilerplateScraper.d.ts +43 -0
  496. package/esm/typings/src/scrapers/_boilerplate/createBoilerplateScraper.d.ts +20 -0
  497. package/esm/typings/src/scrapers/_boilerplate/playground/boilerplate-scraper-playground.d.ts +5 -0
  498. package/esm/typings/src/scrapers/_boilerplate/register-constructor.d.ts +15 -0
  499. package/esm/typings/src/scrapers/_boilerplate/register-metadata.d.ts +28 -0
  500. package/esm/typings/src/scrapers/_common/Converter.d.ts +25 -0
  501. package/esm/typings/src/scrapers/_common/Scraper.d.ts +60 -0
  502. package/esm/typings/src/scrapers/_common/ScraperIntermediateSource.d.ts +16 -0
  503. package/esm/typings/src/scrapers/_common/prepareKnowledgePieces.d.ts +19 -0
  504. package/esm/typings/src/scrapers/_common/prepareKnowledgePieces.test.d.ts +1 -0
  505. package/esm/typings/src/scrapers/_common/register/$provideFilesystemForNode.d.ts +12 -0
  506. package/esm/typings/src/scrapers/_common/register/$provideScrapersForBrowser.d.ts +15 -0
  507. package/esm/typings/src/scrapers/_common/register/$provideScrapersForNode.d.ts +13 -0
  508. package/esm/typings/src/scrapers/_common/register/$provideScriptingForNode.d.ts +11 -0
  509. package/esm/typings/src/scrapers/_common/register/$registeredScrapersMessage.d.ts +13 -0
  510. package/esm/typings/src/scrapers/_common/register/$scrapersMetadataRegister.d.ts +13 -0
  511. package/esm/typings/src/scrapers/_common/register/$scrapersRegister.d.ts +14 -0
  512. package/esm/typings/src/scrapers/_common/register/ScraperAndConverterMetadata.d.ts +46 -0
  513. package/esm/typings/src/scrapers/_common/register/ScraperConstructor.d.ts +13 -0
  514. package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.d.ts +35 -0
  515. package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.test.d.ts +4 -0
  516. package/esm/typings/src/scrapers/_common/utils/makeKnowledgeSourceHandler.d.ts +13 -0
  517. package/esm/typings/src/scrapers/_common/utils/promptbookFetch.d.ts +10 -0
  518. package/esm/typings/src/scrapers/document/DocumentScraper.d.ts +43 -0
  519. package/esm/typings/src/scrapers/document/DocumentScraper.test.d.ts +4 -0
  520. package/esm/typings/src/scrapers/document/createDocumentScraper.d.ts +20 -0
  521. package/esm/typings/src/scrapers/document/playground/document-scraper-playground.d.ts +5 -0
  522. package/esm/typings/src/scrapers/document/register-constructor.d.ts +15 -0
  523. package/esm/typings/src/scrapers/document/register-metadata.d.ts +28 -0
  524. package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.d.ts +43 -0
  525. package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.test.d.ts +4 -0
  526. package/esm/typings/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts +21 -0
  527. package/esm/typings/src/scrapers/document-legacy/playground/legacy-document-scraper-playground.d.ts +5 -0
  528. package/esm/typings/src/scrapers/document-legacy/register-constructor.d.ts +15 -0
  529. package/esm/typings/src/scrapers/document-legacy/register-metadata.d.ts +28 -0
  530. package/esm/typings/src/scrapers/markdown/MarkdownScraper.d.ts +29 -0
  531. package/esm/typings/src/scrapers/markdown/MarkdownScraper.test.d.ts +4 -0
  532. package/esm/typings/src/scrapers/markdown/createMarkdownScraper.d.ts +20 -0
  533. package/esm/typings/src/scrapers/markdown/playground/markdown-scraper-playground.d.ts +5 -0
  534. package/esm/typings/src/scrapers/markdown/register-constructor.d.ts +15 -0
  535. package/esm/typings/src/scrapers/markdown/register-metadata.d.ts +28 -0
  536. package/esm/typings/src/scrapers/markitdown/MarkitdownScraper.d.ts +50 -0
  537. package/esm/typings/src/scrapers/markitdown/createMarkitdownScraper.d.ts +22 -0
  538. package/esm/typings/src/scrapers/markitdown/playground/markitdown-scraper-playground.d.ts +5 -0
  539. package/esm/typings/src/scrapers/markitdown/register-constructor.d.ts +17 -0
  540. package/esm/typings/src/scrapers/markitdown/register-metadata.d.ts +28 -0
  541. package/esm/typings/src/scrapers/pdf/PdfScraper.d.ts +41 -0
  542. package/esm/typings/src/scrapers/pdf/createPdfScraper.d.ts +21 -0
  543. package/esm/typings/src/scrapers/pdf/playground/pdf-scraper-playground.d.ts +5 -0
  544. package/esm/typings/src/scrapers/pdf/register-constructor.d.ts +15 -0
  545. package/esm/typings/src/scrapers/pdf/register-metadata.d.ts +28 -0
  546. package/esm/typings/src/scrapers/website/WebsiteScraper.d.ts +50 -0
  547. package/esm/typings/src/scrapers/website/createWebsiteScraper.d.ts +21 -0
  548. package/esm/typings/src/scrapers/website/playground/website-scraper-playground.d.ts +5 -0
  549. package/esm/typings/src/scrapers/website/register-constructor.d.ts +15 -0
  550. package/esm/typings/src/scrapers/website/register-metadata.d.ts +28 -0
  551. package/esm/typings/src/scrapers/website/utils/createShowdownConverter.d.ts +7 -0
  552. package/esm/typings/src/scrapers/website/utils/createShowdownConverter.test.d.ts +1 -0
  553. package/esm/typings/src/scripting/_test/custom-function-async.test.ts.test.d.ts +1 -0
  554. package/esm/typings/src/scripting/_test/custom-function-missing.test.d.ts +1 -0
  555. package/esm/typings/src/scripting/_test/custom-function-with-dependencies.test.d.ts +1 -0
  556. package/esm/typings/src/scripting/_test/custom-function.test.d.ts +1 -0
  557. package/esm/typings/src/scripting/_test/postprocessing.test.d.ts +1 -0
  558. package/esm/typings/src/scripting/_test/script-execution-errors.test.d.ts +1 -0
  559. package/esm/typings/src/scripting/_test/script-execution-tools.test.d.ts +1 -0
  560. package/esm/typings/src/scripting/javascript/JavascriptEvalExecutionTools.d.ts +22 -0
  561. package/esm/typings/src/scripting/javascript/JavascriptEvalExecutionTools.test.d.ts +4 -0
  562. package/esm/typings/src/scripting/javascript/JavascriptExecutionTools.d.ts +8 -0
  563. package/esm/typings/src/scripting/javascript/JavascriptExecutionToolsOptions.d.ts +26 -0
  564. package/esm/typings/src/scripting/javascript/postprocessing-functions.d.ts +56 -0
  565. package/esm/typings/src/scripting/javascript/utils/extractVariablesFromJavascript.d.ts +14 -0
  566. package/esm/typings/src/scripting/javascript/utils/extractVariablesFromJavascript.test.d.ts +1 -0
  567. package/esm/typings/src/scripting/javascript/utils/extractVariablesFromScript.test.d.ts +1 -0
  568. package/esm/typings/src/scripting/python/PythonExecutionTools.d.ts +18 -0
  569. package/esm/typings/src/scripting/typescript/TypescriptExecutionTools.d.ts +18 -0
  570. package/esm/typings/src/storage/_common/PromptbookStorage.d.ts +24 -0
  571. package/esm/typings/src/storage/_common/PromptbookStorage.test-type.d.ts +5 -0
  572. package/esm/typings/src/storage/blackhole/BlackholeStorage.d.ts +33 -0
  573. package/esm/typings/src/storage/env-storage/$EnvStorage.d.ts +40 -0
  574. package/esm/typings/src/storage/file-cache-storage/FileCacheStorage.d.ts +40 -0
  575. package/esm/typings/src/storage/file-cache-storage/FileCacheStorageOptions.d.ts +12 -0
  576. package/esm/typings/src/storage/file-cache-storage/utils/nameToSubfolderPath.d.ts +8 -0
  577. package/esm/typings/src/storage/file-cache-storage/utils/nameToSubfolderPath.test.d.ts +1 -0
  578. package/esm/typings/src/storage/local-storage/getIndexedDbStorage.d.ts +11 -0
  579. package/esm/typings/src/storage/local-storage/getLocalStorage.d.ts +10 -0
  580. package/esm/typings/src/storage/local-storage/getSessionStorage.d.ts +10 -0
  581. package/esm/typings/src/storage/local-storage/utils/IndexedDbStorageOptions.d.ts +14 -0
  582. package/esm/typings/src/storage/local-storage/utils/makePromptbookStorageFromIndexedDb.d.ts +8 -0
  583. package/esm/typings/src/storage/local-storage/utils/makePromptbookStorageFromWebStorage.d.ts +12 -0
  584. package/esm/typings/src/storage/memory/MemoryStorage.d.ts +33 -0
  585. package/esm/typings/src/storage/utils/PrefixStorage.d.ts +25 -0
  586. package/esm/typings/src/types/Arrayable.d.ts +11 -0
  587. package/esm/typings/src/types/IntermediateFilesStrategy.d.ts +8 -0
  588. package/esm/typings/src/types/ModelRequirements.d.ts +102 -0
  589. package/esm/typings/src/types/ModelVariant.d.ts +15 -0
  590. package/esm/typings/src/types/NonEmptyArray.d.ts +8 -0
  591. package/esm/typings/src/types/Prompt.d.ts +111 -0
  592. package/esm/typings/src/types/ScriptLanguage.d.ts +13 -0
  593. package/esm/typings/src/types/SectionType.d.ts +21 -0
  594. package/esm/typings/src/types/TaskType.d.ts +15 -0
  595. package/esm/typings/src/types/typeAliasEmoji.d.ts +12 -0
  596. package/esm/typings/src/types/typeAliases.d.ts +685 -0
  597. package/esm/typings/src/utils/$Register.d.ts +40 -0
  598. package/esm/typings/src/utils/$getCurrentDate.d.ts +10 -0
  599. package/esm/typings/src/utils/FromtoItems.d.ts +19 -0
  600. package/esm/typings/src/utils/arrayableToArray.d.ts +11 -0
  601. package/esm/typings/src/utils/arrayableToArray.test.d.ts +1 -0
  602. package/esm/typings/src/utils/color/$randomColor.d.ts +11 -0
  603. package/esm/typings/src/utils/color/Color.d.ts +180 -0
  604. package/esm/typings/src/utils/color/css-colors.d.ts +159 -0
  605. package/esm/typings/src/utils/color/internal-utils/checkChannelValue.d.ts +14 -0
  606. package/esm/typings/src/utils/color/internal-utils/hslToRgb.d.ts +17 -0
  607. package/esm/typings/src/utils/color/internal-utils/rgbToHsl.d.ts +17 -0
  608. package/esm/typings/src/utils/color/operators/ColorTransformer.d.ts +5 -0
  609. package/esm/typings/src/utils/color/operators/darken.d.ts +9 -0
  610. package/esm/typings/src/utils/color/operators/furthest.d.ts +16 -0
  611. package/esm/typings/src/utils/color/operators/grayscale.d.ts +9 -0
  612. package/esm/typings/src/utils/color/operators/lighten.d.ts +12 -0
  613. package/esm/typings/src/utils/color/operators/mixWithColor.d.ts +11 -0
  614. package/esm/typings/src/utils/color/operators/nearest.d.ts +10 -0
  615. package/esm/typings/src/utils/color/operators/negative.d.ts +7 -0
  616. package/esm/typings/src/utils/color/operators/negativeLightness.d.ts +7 -0
  617. package/esm/typings/src/utils/color/operators/withAlpha.d.ts +9 -0
  618. package/esm/typings/src/utils/color/utils/areColorsEqual.d.ts +14 -0
  619. package/esm/typings/src/utils/color/utils/colorDistance.d.ts +21 -0
  620. package/esm/typings/src/utils/color/utils/colorHue.d.ts +11 -0
  621. package/esm/typings/src/utils/color/utils/colorHueDistance.d.ts +11 -0
  622. package/esm/typings/src/utils/color/utils/colorHueDistance.test.d.ts +1 -0
  623. package/esm/typings/src/utils/color/utils/colorLuminance.d.ts +9 -0
  624. package/esm/typings/src/utils/color/utils/colorSatulightion.d.ts +7 -0
  625. package/esm/typings/src/utils/color/utils/colorSaturation.d.ts +9 -0
  626. package/esm/typings/src/utils/color/utils/colorToDataUrl.d.ts +10 -0
  627. package/esm/typings/src/utils/color/utils/mixColors.d.ts +11 -0
  628. package/esm/typings/src/utils/editable/edit-pipeline-string/addPipelineCommand.d.ts +17 -0
  629. package/esm/typings/src/utils/editable/edit-pipeline-string/addPipelineCommand.test.d.ts +1 -0
  630. package/esm/typings/src/utils/editable/edit-pipeline-string/deflatePipeline.d.ts +13 -0
  631. package/esm/typings/src/utils/editable/edit-pipeline-string/deflatePipeline.test.d.ts +1 -0
  632. package/esm/typings/src/utils/editable/edit-pipeline-string/removePipelineCommand.d.ts +22 -0
  633. package/esm/typings/src/utils/editable/edit-pipeline-string/removePipelineCommand.test.d.ts +1 -0
  634. package/esm/typings/src/utils/editable/types/PipelineEditableSerialized.d.ts +27 -0
  635. package/esm/typings/src/utils/editable/utils/isFlatPipeline.d.ts +8 -0
  636. package/esm/typings/src/utils/editable/utils/isFlatPipeline.test.d.ts +1 -0
  637. package/esm/typings/src/utils/editable/utils/renamePipelineParameter.d.ts +29 -0
  638. package/esm/typings/src/utils/editable/utils/renamePipelineParameter.test.d.ts +1 -0
  639. package/esm/typings/src/utils/editable/utils/stringifyPipelineJson.d.ts +16 -0
  640. package/esm/typings/src/utils/emojis.d.ts +24 -0
  641. package/esm/typings/src/utils/environment/$getGlobalScope.d.ts +10 -0
  642. package/esm/typings/src/utils/environment/$isRunningInBrowser.d.ts +11 -0
  643. package/esm/typings/src/utils/environment/$isRunningInJest.d.ts +11 -0
  644. package/esm/typings/src/utils/environment/$isRunningInNode.d.ts +11 -0
  645. package/esm/typings/src/utils/environment/$isRunningInWebWorker.d.ts +11 -0
  646. package/esm/typings/src/utils/execCommand/$execCommand.d.ts +16 -0
  647. package/esm/typings/src/utils/execCommand/$execCommandNormalizeOptions.d.ts +12 -0
  648. package/esm/typings/src/utils/execCommand/$execCommands.d.ts +18 -0
  649. package/esm/typings/src/utils/execCommand/ExecCommandOptions.d.ts +45 -0
  650. package/esm/typings/src/utils/execCommand/execCommand.test.d.ts +1 -0
  651. package/esm/typings/src/utils/execCommand/execCommandNormalizeOptions.test.d.ts +1 -0
  652. package/esm/typings/src/utils/expectation-counters/constants.d.ts +16 -0
  653. package/esm/typings/src/utils/expectation-counters/countCharacters.d.ts +10 -0
  654. package/esm/typings/src/utils/expectation-counters/countCharacters.test.d.ts +1 -0
  655. package/esm/typings/src/utils/expectation-counters/countLines.d.ts +12 -0
  656. package/esm/typings/src/utils/expectation-counters/countLines.test.d.ts +1 -0
  657. package/esm/typings/src/utils/expectation-counters/countPages.d.ts +12 -0
  658. package/esm/typings/src/utils/expectation-counters/countPages.test.d.ts +1 -0
  659. package/esm/typings/src/utils/expectation-counters/countParagraphs.d.ts +10 -0
  660. package/esm/typings/src/utils/expectation-counters/countParagraphs.test.d.ts +1 -0
  661. package/esm/typings/src/utils/expectation-counters/countSentences.d.ts +16 -0
  662. package/esm/typings/src/utils/expectation-counters/countSentences.test.d.ts +1 -0
  663. package/esm/typings/src/utils/expectation-counters/countWords.d.ts +10 -0
  664. package/esm/typings/src/utils/expectation-counters/countWords.test.d.ts +1 -0
  665. package/esm/typings/src/utils/expectation-counters/index.d.ts +12 -0
  666. package/esm/typings/src/utils/files/extensionToMimeType.d.ts +8 -0
  667. package/esm/typings/src/utils/files/extensionToMimeType.test.d.ts +1 -0
  668. package/esm/typings/src/utils/files/getFileExtension.d.ts +8 -0
  669. package/esm/typings/src/utils/files/getFileExtension.test.d.ts +1 -0
  670. package/esm/typings/src/utils/files/isDirectoryExisting.d.ts +14 -0
  671. package/esm/typings/src/utils/files/isDirectoryExisting.test.d.ts +1 -0
  672. package/esm/typings/src/utils/files/isExecutable.d.ts +11 -0
  673. package/esm/typings/src/utils/files/isFileExisting.d.ts +13 -0
  674. package/esm/typings/src/utils/files/isFileExisting.test.d.ts +1 -0
  675. package/esm/typings/src/utils/files/listAllFiles.d.ts +17 -0
  676. package/esm/typings/src/utils/files/listAllFiles.test.d.ts +1 -0
  677. package/esm/typings/src/utils/files/mimeTypeToExtension.d.ts +10 -0
  678. package/esm/typings/src/utils/files/mimeTypeToExtension.test.d.ts +1 -0
  679. package/esm/typings/src/utils/markdown/addAutoGeneratedSection.d.ts +14 -0
  680. package/esm/typings/src/utils/markdown/addAutoGeneratedSection.test.d.ts +1 -0
  681. package/esm/typings/src/utils/markdown/createMarkdownChart.d.ts +38 -0
  682. package/esm/typings/src/utils/markdown/createMarkdownChart.test.d.ts +1 -0
  683. package/esm/typings/src/utils/markdown/createMarkdownTable.d.ts +11 -0
  684. package/esm/typings/src/utils/markdown/createMarkdownTable.test.d.ts +1 -0
  685. package/esm/typings/src/utils/markdown/escapeMarkdownBlock.d.ts +11 -0
  686. package/esm/typings/src/utils/markdown/escapeMarkdownBlock.test.d.ts +1 -0
  687. package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown-real.test.d.ts +1 -0
  688. package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.d.ts +36 -0
  689. package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.test.d.ts +1 -0
  690. package/esm/typings/src/utils/markdown/extractAllListItemsFromMarkdown.d.ts +15 -0
  691. package/esm/typings/src/utils/markdown/extractAllListItemsFromMarkdown.test.d.ts +1 -0
  692. package/esm/typings/src/utils/markdown/extractOneBlockFromMarkdown.d.ts +22 -0
  693. package/esm/typings/src/utils/markdown/extractOneBlockFromMarkdown.test.d.ts +1 -0
  694. package/esm/typings/src/utils/markdown/flattenMarkdown.d.ts +17 -0
  695. package/esm/typings/src/utils/markdown/flattenMarkdown.test.d.ts +1 -0
  696. package/esm/typings/src/utils/markdown/parseMarkdownSection.d.ts +34 -0
  697. package/esm/typings/src/utils/markdown/parseMarkdownSection.test.d.ts +1 -0
  698. package/esm/typings/src/utils/markdown/prettifyMarkdown.d.ts +9 -0
  699. package/esm/typings/src/utils/markdown/prettifyMarkdown.test.d.ts +1 -0
  700. package/esm/typings/src/utils/markdown/removeMarkdownComments.d.ts +10 -0
  701. package/esm/typings/src/utils/markdown/removeMarkdownComments.test.d.ts +1 -0
  702. package/esm/typings/src/utils/markdown/removeMarkdownFormatting.d.ts +9 -0
  703. package/esm/typings/src/utils/markdown/removeMarkdownFormatting.test.d.ts +1 -0
  704. package/esm/typings/src/utils/markdown/splitMarkdownIntoSections.d.ts +15 -0
  705. package/esm/typings/src/utils/markdown/splitMarkdownIntoSections.test.d.ts +1 -0
  706. package/esm/typings/src/utils/normalization/DIACRITIC_VARIANTS_LETTERS.d.ts +12 -0
  707. package/esm/typings/src/utils/normalization/IKeywords.d.ts +21 -0
  708. package/esm/typings/src/utils/normalization/capitalize.d.ts +6 -0
  709. package/esm/typings/src/utils/normalization/capitalize.test.d.ts +1 -0
  710. package/esm/typings/src/utils/normalization/decapitalize.d.ts +6 -0
  711. package/esm/typings/src/utils/normalization/decapitalize.test.d.ts +1 -0
  712. package/esm/typings/src/utils/normalization/isValidKeyword.d.ts +10 -0
  713. package/esm/typings/src/utils/normalization/isValidKeyword.test.d.ts +1 -0
  714. package/esm/typings/src/utils/normalization/nameToUriPart.d.ts +9 -0
  715. package/esm/typings/src/utils/normalization/nameToUriPart.test.d.ts +1 -0
  716. package/esm/typings/src/utils/normalization/nameToUriParts.d.ts +9 -0
  717. package/esm/typings/src/utils/normalization/nameToUriParts.test.d.ts +1 -0
  718. package/esm/typings/src/utils/normalization/normalize-to-kebab-case.d.ts +21 -0
  719. package/esm/typings/src/utils/normalization/normalize-to-kebab-case.test.d.ts +1 -0
  720. package/esm/typings/src/utils/normalization/normalizeTo_PascalCase.d.ts +17 -0
  721. package/esm/typings/src/utils/normalization/normalizeTo_PascalCase.test.d.ts +1 -0
  722. package/esm/typings/src/utils/normalization/normalizeTo_SCREAMING_CASE.d.ts +26 -0
  723. package/esm/typings/src/utils/normalization/normalizeTo_SCREAMING_CASE.test.d.ts +1 -0
  724. package/esm/typings/src/utils/normalization/normalizeTo_camelCase.d.ts +22 -0
  725. package/esm/typings/src/utils/normalization/normalizeTo_camelCase.test.d.ts +1 -0
  726. package/esm/typings/src/utils/normalization/normalizeTo_snake_case.d.ts +17 -0
  727. package/esm/typings/src/utils/normalization/normalizeTo_snake_case.test.d.ts +1 -0
  728. package/esm/typings/src/utils/normalization/normalizeWhitespaces.d.ts +6 -0
  729. package/esm/typings/src/utils/normalization/normalizeWhitespaces.test.d.ts +1 -0
  730. package/esm/typings/src/utils/normalization/orderJson.d.ts +21 -0
  731. package/esm/typings/src/utils/normalization/orderJson.test.d.ts +4 -0
  732. package/esm/typings/src/utils/normalization/parseKeywords.d.ts +16 -0
  733. package/esm/typings/src/utils/normalization/parseKeywords.test.d.ts +1 -0
  734. package/esm/typings/src/utils/normalization/parseKeywordsFromString.d.ts +9 -0
  735. package/esm/typings/src/utils/normalization/parseKeywordsFromString.test.d.ts +1 -0
  736. package/esm/typings/src/utils/normalization/removeDiacritics.d.ts +11 -0
  737. package/esm/typings/src/utils/normalization/removeDiacritics.test.d.ts +1 -0
  738. package/esm/typings/src/utils/normalization/searchKeywords.d.ts +13 -0
  739. package/esm/typings/src/utils/normalization/searchKeywords.test.d.ts +1 -0
  740. package/esm/typings/src/utils/normalization/suffixUrl.d.ts +7 -0
  741. package/esm/typings/src/utils/normalization/suffixUrl.test.d.ts +1 -0
  742. package/esm/typings/src/utils/normalization/titleToName.d.ts +9 -0
  743. package/esm/typings/src/utils/normalization/titleToName.test.d.ts +1 -0
  744. package/esm/typings/src/utils/organization/$sideEffect.d.ts +9 -0
  745. package/esm/typings/src/utils/organization/TODO_USE.d.ts +12 -0
  746. package/esm/typings/src/utils/organization/TODO_any.d.ts +6 -0
  747. package/esm/typings/src/utils/organization/TODO_narrow.d.ts +6 -0
  748. package/esm/typings/src/utils/organization/TODO_object.d.ts +6 -0
  749. package/esm/typings/src/utils/organization/TODO_remove_as.d.ts +6 -0
  750. package/esm/typings/src/utils/organization/TODO_string.d.ts +6 -0
  751. package/esm/typings/src/utils/organization/TODO_unknown.d.ts +6 -0
  752. package/esm/typings/src/utils/organization/___and___.d.ts +7 -0
  753. package/esm/typings/src/utils/organization/___or___.d.ts +6 -0
  754. package/esm/typings/src/utils/organization/empty_object.d.ts +10 -0
  755. package/esm/typings/src/utils/organization/just.d.ts +14 -0
  756. package/esm/typings/src/utils/organization/just_empty_object.d.ts +12 -0
  757. package/esm/typings/src/utils/organization/keepTypeImported.d.ts +9 -0
  758. package/esm/typings/src/utils/organization/keepUnused.d.ts +16 -0
  759. package/esm/typings/src/utils/organization/preserve.d.ts +21 -0
  760. package/esm/typings/src/utils/organization/really_any.d.ts +6 -0
  761. package/esm/typings/src/utils/organization/really_unknown.d.ts +6 -0
  762. package/esm/typings/src/utils/organization/spaceTrim.d.ts +11 -0
  763. package/esm/typings/src/utils/parameters/extractParameterNames.d.ts +10 -0
  764. package/esm/typings/src/utils/parameters/extractParameterNames.test.d.ts +1 -0
  765. package/esm/typings/src/utils/parameters/mapAvailableToExpectedParameters.d.ts +27 -0
  766. package/esm/typings/src/utils/parameters/mapAvailableToExpectedParameters.test.d.ts +1 -0
  767. package/esm/typings/src/utils/parameters/numberToString.d.ts +7 -0
  768. package/esm/typings/src/utils/parameters/numberToString.test.d.ts +1 -0
  769. package/esm/typings/src/utils/parameters/templateParameters.d.ts +16 -0
  770. package/esm/typings/src/utils/parameters/templateParameters.test.d.ts +1 -0
  771. package/esm/typings/src/utils/parameters/valueToString.d.ts +17 -0
  772. package/esm/typings/src/utils/parameters/valueToString.test.d.ts +1 -0
  773. package/esm/typings/src/utils/parseNumber.d.ts +16 -0
  774. package/esm/typings/src/utils/parseNumber.test.d.ts +1 -0
  775. package/esm/typings/src/utils/random/$randomSeed.d.ts +10 -0
  776. package/esm/typings/src/utils/random/$randomToken.d.ts +13 -0
  777. package/esm/typings/src/utils/removeEmojis.d.ts +8 -0
  778. package/esm/typings/src/utils/removeEmojis.test.d.ts +1 -0
  779. package/esm/typings/src/utils/removeQuotes.d.ts +14 -0
  780. package/esm/typings/src/utils/removeQuotes.test.d.ts +1 -0
  781. package/esm/typings/src/utils/serialization/$deepFreeze.d.ts +14 -0
  782. package/esm/typings/src/utils/serialization/asSerializable.d.ts +15 -0
  783. package/esm/typings/src/utils/serialization/asSerializable.test.d.ts +1 -0
  784. package/esm/typings/src/utils/serialization/checkSerializableAsJson.d.ts +45 -0
  785. package/esm/typings/src/utils/serialization/clonePipeline.d.ts +14 -0
  786. package/esm/typings/src/utils/serialization/deepClone.d.ts +14 -0
  787. package/esm/typings/src/utils/serialization/deepClone.test.d.ts +1 -0
  788. package/esm/typings/src/utils/serialization/exportJson.d.ts +29 -0
  789. package/esm/typings/src/utils/serialization/isSerializableAsJson.d.ts +25 -0
  790. package/esm/typings/src/utils/serialization/isSerializableAsJson.test.d.ts +1 -0
  791. package/esm/typings/src/utils/serialization/jsonStringsToJsons.d.ts +9 -0
  792. package/esm/typings/src/utils/serialization/jsonStringsToJsons.test.d.ts +1 -0
  793. package/esm/typings/src/utils/sets/difference.d.ts +10 -0
  794. package/esm/typings/src/utils/sets/difference.test.d.ts +1 -0
  795. package/esm/typings/src/utils/sets/intersection.d.ts +7 -0
  796. package/esm/typings/src/utils/sets/intersection.test.d.ts +1 -0
  797. package/esm/typings/src/utils/sets/union.d.ts +7 -0
  798. package/esm/typings/src/utils/sets/union.test.d.ts +1 -0
  799. package/esm/typings/src/utils/take/classes/TakeChain.d.ts +11 -0
  800. package/esm/typings/src/utils/take/interfaces/ITakeChain.d.ts +12 -0
  801. package/esm/typings/src/utils/take/interfaces/Takeable.d.ts +7 -0
  802. package/esm/typings/src/utils/take/take.d.ts +12 -0
  803. package/esm/typings/src/utils/take/take.test.d.ts +1 -0
  804. package/esm/typings/src/utils/trimCodeBlock.d.ts +9 -0
  805. package/esm/typings/src/utils/trimCodeBlock.test.d.ts +1 -0
  806. package/esm/typings/src/utils/trimEndOfCodeBlock.d.ts +9 -0
  807. package/esm/typings/src/utils/trimEndOfCodeBlock.test.d.ts +1 -0
  808. package/esm/typings/src/utils/unwrapResult.d.ts +37 -0
  809. package/esm/typings/src/utils/unwrapResult.test.d.ts +1 -0
  810. package/esm/typings/src/utils/validators/email/isValidEmail.d.ts +8 -0
  811. package/esm/typings/src/utils/validators/email/isValidEmail.test.d.ts +1 -0
  812. package/esm/typings/src/utils/validators/filePath/isRootPath.d.ts +12 -0
  813. package/esm/typings/src/utils/validators/filePath/isRootPath.test.d.ts +4 -0
  814. package/esm/typings/src/utils/validators/filePath/isValidFilePath.d.ts +12 -0
  815. package/esm/typings/src/utils/validators/filePath/isValidFilePath.test.d.ts +1 -0
  816. package/esm/typings/src/utils/validators/javascriptName/isValidJavascriptName.d.ts +10 -0
  817. package/esm/typings/src/utils/validators/javascriptName/isValidJavascriptName.test.d.ts +1 -0
  818. package/esm/typings/src/utils/validators/parameterName/validateParameterName.d.ts +11 -0
  819. package/esm/typings/src/utils/validators/parameterName/validateParameterName.test.d.ts +1 -0
  820. package/esm/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.d.ts +15 -0
  821. package/esm/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.test.d.ts +1 -0
  822. package/esm/typings/src/utils/validators/semanticVersion/isValidSemanticVersion.d.ts +12 -0
  823. package/esm/typings/src/utils/validators/semanticVersion/isValidSemanticVersion.test.d.ts +1 -0
  824. package/esm/typings/src/utils/validators/url/isHostnameOnPrivateNetwork.d.ts +11 -0
  825. package/esm/typings/src/utils/validators/url/isHostnameOnPrivateNetwork.test.d.ts +1 -0
  826. package/esm/typings/src/utils/validators/url/isUrlOnPrivateNetwork.d.ts +13 -0
  827. package/esm/typings/src/utils/validators/url/isUrlOnPrivateNetwork.test.d.ts +1 -0
  828. package/esm/typings/src/utils/validators/url/isValidPipelineUrl.d.ts +15 -0
  829. package/esm/typings/src/utils/validators/url/isValidPipelineUrl.test.d.ts +1 -0
  830. package/esm/typings/src/utils/validators/url/isValidUrl.d.ts +13 -0
  831. package/esm/typings/src/utils/validators/url/isValidUrl.test.d.ts +1 -0
  832. package/esm/typings/src/utils/validators/uuid/isValidUuid.d.ts +8 -0
  833. package/esm/typings/src/utils/validators/uuid/isValidUuid.test.d.ts +1 -0
  834. package/esm/typings/src/version.d.ts +26 -0
  835. package/esm/typings/src/wizard/$getCompiledBook.d.ts +16 -0
  836. package/esm/typings/src/wizard/wizard.d.ts +78 -0
  837. package/package.json +96 -0
  838. package/umd/index.umd.js +1074 -0
  839. package/umd/index.umd.js.map +1 -0
@@ -0,0 +1,11 @@
1
+ import type { Registered } from '../utils/$Register';
2
+ import type { TODO_any } from '../utils/organization/TODO_any';
3
+ import type { LlmExecutionTools } from './LlmExecutionTools';
4
+ /**
5
+ * Type representing a constructor for LLM execution tools, which are used to interact with language models.
6
+ * Combines registration metadata with a factory function for creating LLM tool instances.
7
+ */
8
+ export type LlmExecutionToolsConstructor = Registered & ((options: TODO_any) => LlmExecutionTools);
9
+ /**
10
+ * TODO: [๐ŸŽถ] Naming "constructor" vs "creator" vs "factory"
11
+ */
@@ -0,0 +1,16 @@
1
+ import type { InputParameters } from '../types/typeAliases';
2
+ import type { ExecutionTask } from './ExecutionTask';
3
+ /**
4
+ * Executor is a simple async function that takes INPUT PARAMETERs and returns result parameters _(along with all intermediate parameters and INPUT PARAMETERs = it extends input object)_.
5
+ * Executor is made by combining execution tools and pipeline collection.
6
+ *
7
+ * It can be created with `createPipelineExecutor` function.
8
+ *
9
+ * @see https://github.com/webgptorg/promptbook#executor
10
+ */
11
+ export type PipelineExecutor = {
12
+ (inputParameters: InputParameters): ExecutionTask;
13
+ };
14
+ /**
15
+ * TODO: [๐Ÿง ] Should this file be in /execution or /types folder?
16
+ */
@@ -0,0 +1,39 @@
1
+ import { ReadonlyDeep } from 'type-fest';
2
+ import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
3
+ import type { Parameters } from '../types/typeAliases';
4
+ import type { AbstractTaskResult } from './AbstractTaskResult';
5
+ import type { ExecutionReportJson } from './execution-report/ExecutionReportJson';
6
+ import type { Usage } from './Usage';
7
+ /**
8
+ * The result of executing a pipeline
9
+ *
10
+ * Note: [๐Ÿš‰] This is fully serializable as JSON
11
+ */
12
+ export type PipelineExecutorResult = AbstractTaskResult & {
13
+ /**
14
+ * Result parameters of the execution
15
+ *
16
+ * Note: If the execution was not successful, there are only some of the result parameters
17
+ */
18
+ readonly outputParameters: Readonly<Parameters>;
19
+ /**
20
+ * Added usage of whole execution, detailed usage is available in `executionReport`
21
+ */
22
+ readonly usage: ReadonlyDeep<Usage>;
23
+ /**
24
+ * The report of the execution with all details
25
+ *
26
+ * Note: If the execution fails unexpectedly, this will be `null`
27
+ */
28
+ readonly executionReport: ReadonlyDeep<ExecutionReportJson> | null;
29
+ /**
30
+ * The prepared pipeline that was used for the execution
31
+ *
32
+ * Note: If you called `createPipelineExecutor` with fully prepared pipeline, this is the same object as this pipeline
33
+ * If you passed not fully prepared pipeline, this is same pipeline but fully prepared
34
+ */
35
+ readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
36
+ };
37
+ /**
38
+ * TODO: [๐Ÿง ] Should this file be in /execution or /types folder?
39
+ */
@@ -0,0 +1,101 @@
1
+ import type { string_date_iso8601 } from '../types/typeAliases';
2
+ import type { string_model_name } from '../types/typeAliases';
3
+ import type { string_prompt } from '../types/typeAliases';
4
+ import type { TODO_object } from '../utils/organization/TODO_object';
5
+ import type { EmbeddingVector } from './EmbeddingVector';
6
+ import type { Usage } from './Usage';
7
+ /**
8
+ * Prompt result is the simplest concept of execution.
9
+ * It is the result of executing one prompt _(NOT a template)_.
10
+ *
11
+ * @see https://github.com/webgptorg/promptbook#prompt-result
12
+ */
13
+ export type PromptResult = CompletionPromptResult | ChatPromptResult | EmbeddingPromptResult;
14
+ /**
15
+ * Completion prompt result
16
+ *
17
+ * Note:It contains only the newly generated text NOT the whole completion
18
+ * Note: [๐Ÿš‰] This is fully serializable as JSON
19
+ */
20
+ export type CompletionPromptResult = CommonPromptResult;
21
+ /**
22
+ *Chat prompt result
23
+ *
24
+ * Note: [๐Ÿš‰] This is fully serializable as JSON
25
+ */
26
+ export type ChatPromptResult = CommonPromptResult & {};
27
+ /**
28
+ * Embedding prompt result
29
+ *
30
+ * Note: [๐Ÿš‰] This is fully serializable as JSON
31
+ */
32
+ export type EmbeddingPromptResult = Omit<CommonPromptResult, 'content'> & {
33
+ /**
34
+ * The response from the model
35
+ */
36
+ content: EmbeddingVector;
37
+ };
38
+ /**
39
+ * Common properties for all prompt results
40
+ *
41
+ * Note: [๐Ÿš‰] This is fully serializable as JSON
42
+ *
43
+ * @private just abstract the common properties of the prompt results
44
+ */
45
+ export type CommonPromptResult = {
46
+ /**
47
+ * Exact text response from the model
48
+ */
49
+ readonly content: string;
50
+ /**
51
+ * Name of the model used to generate the response
52
+ */
53
+ readonly modelName: string_model_name;
54
+ /**
55
+ * Timing
56
+ */
57
+ readonly timing: {
58
+ /**
59
+ * Start of the execution
60
+ */
61
+ readonly start: string_date_iso8601;
62
+ /**
63
+ * First token generated
64
+ */
65
+ readonly firstToken?: string_date_iso8601;
66
+ /**
67
+ * End of the execution
68
+ */
69
+ readonly complete: string_date_iso8601;
70
+ };
71
+ /**
72
+ * Usage of the prompt execution
73
+ */
74
+ readonly usage: Usage;
75
+ /**
76
+ * Exact text of the prompt (with all replacements)
77
+ *
78
+ * Note: This contains redundant information
79
+ */
80
+ readonly rawPromptContent: string_prompt;
81
+ /**
82
+ * Raw request to the model
83
+ *
84
+ * Note: This contains redundant information
85
+ */
86
+ readonly rawRequest: TODO_object | null;
87
+ /**
88
+ * Raw response from the model
89
+ *
90
+ * Note: This contains redundant information
91
+ */
92
+ readonly rawResponse: TODO_object;
93
+ };
94
+ /**
95
+ * TODO: [๐Ÿง ] Maybe timing more accurate then seconds?
96
+ * TODO: [๐Ÿง ] Should here be link to the prompt?
97
+ * TODO: [๐Ÿง ] Maybe type `rawResponse` properly - not onject but OpenAI.result.whatever
98
+ * TODO: [๐Ÿง ] Maybe remove redundant raw.choices.text
99
+ * TODO: Log raw even if prompt failed - log the raw error
100
+ * TODO: [๐Ÿณ] Add `TranslationPromptResult`
101
+ */
@@ -0,0 +1,12 @@
1
+ import type { string_url } from '../types/typeAliases';
2
+ /**
3
+ * Fetch function used in Promptbook engine
4
+ *
5
+ * In most cases it is just native `fetch` function with a lightweight error handling wrapper
6
+ * But it can be replaced with any other fetch function, polyfill, custom implementation, security layer, etc.
7
+ *
8
+ * It is used in these places:
9
+ * - Fetching knowledge sources
10
+ * - Callbacks from remote server
11
+ */
12
+ export type PromptbookFetch = (url: string_url, init?: RequestInit) => Promise<Response>;
@@ -0,0 +1,5 @@
1
+ export {};
2
+ /**
3
+ * Note: [โšช] This should never be in any released package
4
+ * TODO: Is this a good pattern to do type testing?
5
+ */
@@ -0,0 +1,39 @@
1
+ import type { ScriptLanguage } from '../types/ScriptLanguage';
2
+ import type { Parameters } from '../types/typeAliases';
3
+ import type { string_script } from '../types/typeAliases';
4
+ /**
5
+ * Represents all the tools needed to execute `SCRIPT` tasks
6
+ *
7
+ * @see https://github.com/webgptorg/promptbook#script-execution-tools
8
+ */
9
+ export type ScriptExecutionTools = {
10
+ execute(options: ScriptExecutionToolsExecuteOptions): Promise<string>;
11
+ };
12
+ /**
13
+ * Input for the script execution
14
+ */
15
+ export type ScriptExecutionToolsExecuteOptions = {
16
+ /**
17
+ * Language of the script
18
+ */
19
+ readonly scriptLanguage: ScriptLanguage;
20
+ /**
21
+ * Parameters for the script
22
+ * These parameters are passed to the script as variables
23
+ * For example: { "name": "John" } => const name = "John";
24
+ */
25
+ readonly parameters: Parameters;
26
+ /**
27
+ * The content of the script to execute
28
+ * - It can be a single statement
29
+ * - It can be multiple statements separated by semicolon and return
30
+ * - It can be a function (but you need to call it)
31
+ * - It can be IIFE (immediately invoked function expression)
32
+ * - It can use the parameters as variables and functions from global scope
33
+ */
34
+ readonly script: string_script;
35
+ };
36
+ /**
37
+ * TODO: [๐Ÿง ][๐Ÿ’™] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
38
+ * TODO: [๐Ÿง ][๐Ÿช] Should be common things like types, utils in folder containing A,B,C,.. or else outside this listing folder?
39
+ */
@@ -0,0 +1,19 @@
1
+ import type { number_positive } from '../types/typeAliases';
2
+ import type { number_usd } from '../types/typeAliases';
3
+ /**
4
+ * Number which can be uncertain
5
+ *
6
+ * Note: [๐Ÿš‰] This is fully serializable as JSON
7
+ * Note: If the value is completelly unknown, the value 0 and isUncertain is true
8
+ * Note: Not using NaN or null because it looses the value which is better to be uncertain then not to be at all
9
+ */
10
+ export type UncertainNumber = {
11
+ /**
12
+ * The numeric value
13
+ */
14
+ readonly value: number_usd & (number_positive | 0);
15
+ /**
16
+ * Is the value uncertain
17
+ */
18
+ readonly isUncertain?: true;
19
+ };
@@ -0,0 +1,33 @@
1
+ import type { KebabCase } from 'type-fest';
2
+ import type { ExpectationUnit } from '../pipeline/PipelineJson/Expectations';
3
+ import type { UncertainNumber } from './UncertainNumber';
4
+ /**
5
+ * Usage statistics for one or more prompt results
6
+ *
7
+ * Note: [๐Ÿš‰] This is fully serializable as JSON
8
+ */
9
+ export type Usage = {
10
+ /**
11
+ * Cost of the execution in USD
12
+ *
13
+ * Note: If the cost is unknown, the value 0 and isUncertain is true
14
+ */
15
+ readonly price: UncertainNumber;
16
+ /**
17
+ * Number of whatever used in the input aka. `prompt_tokens`
18
+ */
19
+ readonly input: UsageCounts;
20
+ /**
21
+ * Number of tokens used in the output aka. `completion_tokens`
22
+ */
23
+ readonly output: UsageCounts;
24
+ };
25
+ /**
26
+ * Record of all possible measurable units
27
+ *
28
+ * Note: [๐Ÿš‰] This is fully serializable as JSON
29
+ */
30
+ export type UsageCounts = Record<`${KebabCase<'TOKENS' | ExpectationUnit>}Count`, UncertainNumber>;
31
+ /**
32
+ * TODO: [๐Ÿ™] Make some standard order of json properties
33
+ */
@@ -0,0 +1,46 @@
1
+ import type { number_integer } from '../types/typeAliases';
2
+ import type { number_positive } from '../types/typeAliases';
3
+ /**
4
+ * Represents all the tools needed to interact with the user.
5
+ *
6
+ * @see https://github.com/webgptorg/promptbook#user-interface-tools
7
+ */
8
+ export type UserInterfaceTools = {
9
+ /**
10
+ * Asks the user to answer a free-text (multi-line) question
11
+ *
12
+ * @param options the question to ask
13
+ * @returns the answer from the user
14
+ */
15
+ promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
16
+ };
17
+ export type UserInterfaceToolsPromptDialogOptions = {
18
+ /**
19
+ * Prompt title
20
+ *
21
+ * Note: This is not a prompt to language model but a prompt to the user
22
+ * @example "Your name"
23
+ */
24
+ readonly promptTitle: string;
25
+ /**
26
+ * Prompt message
27
+ *
28
+ * Note: This is not a prompt to language model but a prompt to the user
29
+ * @example "Please enter your name, including your last name, title, etc."
30
+ */
31
+ readonly promptMessage: string;
32
+ /**
33
+ * Default value for the input/textarea
34
+ */
35
+ readonly defaultValue: string | null;
36
+ /**
37
+ * Placeholder for the input/textarea
38
+ */
39
+ readonly placeholder?: string;
40
+ /**
41
+ * Priority of the prompt
42
+ *
43
+ * Note: This would be reflected for example into the UI z-index of the prompt modal
44
+ */
45
+ readonly priority: number_integer & number_positive;
46
+ };
@@ -0,0 +1,14 @@
1
+ import type { PipelineExecutorResult } from './PipelineExecutorResult';
2
+ /**
3
+ * Asserts that the execution of a Promptbook is successful
4
+ *
5
+ * Note: If there are only warnings, the execution is still successful but the warnings are logged in the console
6
+ *
7
+ * @param executionResult - The partial result of the Promptbook execution
8
+ * @throws {PipelineExecutionError} If the execution is not successful or if multiple errors occurred
9
+ * @private internal helper function of `asPromise` method of `ExecutionTask`
10
+ */
11
+ export declare function assertsTaskSuccessful(executionResult: Pick<PipelineExecutorResult, 'isSuccessful' | 'errors' | 'warnings'>): void;
12
+ /**
13
+ * TODO: [๐Ÿง ] Can this return type be better typed than void
14
+ */
@@ -0,0 +1,56 @@
1
+ import { ExpectError } from '../../errors/ExpectError';
2
+ import type { Prompt } from '../../types/Prompt';
3
+ import type { ChatPromptResult } from '../PromptResult';
4
+ import type { CompletionPromptResult } from '../PromptResult';
5
+ import type { EmbeddingPromptResult } from '../PromptResult';
6
+ import type { PromptResult } from '../PromptResult';
7
+ /**
8
+ * Represents the ongoing result of a pipeline task execution
9
+ *
10
+ * Used internally by the pipeline executor to track state during execution attempts
11
+ *
12
+ * @private internal utility of `createPipelineExecutor`
13
+ */
14
+ export type $OngoingTaskResult = {
15
+ /**
16
+ * The prompt object used for the current execution attempt, if applicable.
17
+ */
18
+ $prompt?: Prompt;
19
+ /**
20
+ * The result of a chat model execution, if applicable.
21
+ */
22
+ $chatResult?: ChatPromptResult;
23
+ /**
24
+ * The result of a completion model execution, if applicable.
25
+ */
26
+ $completionResult?: CompletionPromptResult;
27
+ /**
28
+ * The result of an embedding model execution, if applicable.
29
+ * Note: [๐Ÿค–] Embedding results are less common in standard pipelines.
30
+ */
31
+ $embeddingResult?: EmbeddingPromptResult;
32
+ /**
33
+ * The final result object for the task, or null if not yet available.
34
+ */
35
+ $result: PromptResult | null;
36
+ /**
37
+ * The result string produced by the task, or null if not yet available.
38
+ */
39
+ $resultString: string | null;
40
+ /**
41
+ * The last expectation error encountered, or null if none.
42
+ */
43
+ $expectError: ExpectError | null;
44
+ /**
45
+ * List of errors encountered during script postprocessing or execution.
46
+ */
47
+ $scriptPipelineExecutionErrors: Array<Error>;
48
+ /**
49
+ * Array of all failed attempts, storing both the result string and the error for each failure
50
+ */
51
+ $failedResults: Array<{
52
+ attemptIndex: number;
53
+ result: string | null;
54
+ error: ExpectError;
55
+ }>;
56
+ };
@@ -0,0 +1,46 @@
1
+ import type { CsvSettings } from '../../formats/csv/CsvSettings';
2
+ import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
3
+ import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
4
+ import type { ExecutionTools } from '../ExecutionTools';
5
+ /**
6
+ * Options for `createPipelineExecutor`
7
+ */
8
+ export type CreatePipelineExecutorOptions = PrepareAndScrapeOptions & {
9
+ /**
10
+ * The pipeline to be executed
11
+ */
12
+ readonly pipeline: PipelineJson;
13
+ /**
14
+ * The execution tools to be used during the execution of the pipeline
15
+ */
16
+ readonly tools: ExecutionTools;
17
+ /**
18
+ * When executor does not satisfy expectations it will be retried this amount of times
19
+ *
20
+ * @default MAX_EXECUTION_ATTEMPTS
21
+ */
22
+ readonly maxExecutionAttempts?: number;
23
+ /**
24
+ * Settings for CSV format
25
+ *
26
+ * @default DEFAULT_CSV_SETTINGS
27
+ */
28
+ readonly csvSettings?: CsvSettings;
29
+ /**
30
+ * If you pass fully prepared pipeline, this does not matter
31
+ *
32
+ * Otherwise:
33
+ * If false or not set, warning is shown when pipeline is not prepared
34
+ * If true, warning is suppressed
35
+ *
36
+ * @default false
37
+ */
38
+ readonly isNotPreparedWarningSuppressed?: boolean;
39
+ };
40
+ /**
41
+ * TODO: [๐ŸงŽ][๐Ÿง ] Move `csvSettings` to some better place
42
+ * 1) either to some dependency in `ExecutionTools`
43
+ * 2) or make here container for multiple formats
44
+ * 3) or make the setting more universal and which just sets things like `delimiter` and `quote` without specifying the format
45
+ * TODO: [๐Ÿคนโ€โ™‚๏ธ] More granular setting for limits of execution + better waiting for queue
46
+ */
@@ -0,0 +1,10 @@
1
+ import type { PipelineExecutor } from '../PipelineExecutor';
2
+ import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
3
+ /**
4
+ * Creates executor function from pipeline and execution tools.
5
+ *
6
+ * @returns The executor function
7
+ * @throws {PipelineLogicError} on logical error in the pipeline
8
+ * @public exported from `@promptbook/core`
9
+ */
10
+ export declare function createPipelineExecutor(options: CreatePipelineExecutorOptions): PipelineExecutor;
@@ -0,0 +1,48 @@
1
+ import type { PartialDeep, Promisable, ReadonlyDeep } from 'type-fest';
2
+ import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
3
+ import type { InputParameters } from '../../types/typeAliases';
4
+ import type { PipelineExecutorResult } from '../PipelineExecutorResult';
5
+ import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
6
+ /**
7
+ * Options for executing an entire pipeline, including input parameters, pipeline context, and progress callbacks.
8
+ *
9
+ * @private internal type of `executePipeline`
10
+ */
11
+ type ExecutePipelineOptions = Required<CreatePipelineExecutorOptions> & {
12
+ /**
13
+ * The input parameters provided by the user for pipeline execution.
14
+ */
15
+ readonly inputParameters: Readonly<InputParameters>;
16
+ /**
17
+ * Optional callback invoked with partial results as the pipeline execution progresses.
18
+ */
19
+ onProgress?(newOngoingResult: PartialDeep<PipelineExecutorResult>): Promisable<void>;
20
+ /**
21
+ * The pipeline definition to execute.
22
+ */
23
+ readonly pipeline: PipelineJson;
24
+ /**
25
+ * The prepared and validated pipeline, ready for execution.
26
+ */
27
+ readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
28
+ /**
29
+ * Callback to update the prepared pipeline reference after preparation.
30
+ */
31
+ setPreparedPipeline(preparedPipeline: ReadonlyDeep<PipelineJson>): void;
32
+ /**
33
+ * String identifier for the pipeline, used in error messages and reporting.
34
+ */
35
+ readonly pipelineIdentification: string;
36
+ };
37
+ /**
38
+ * Executes an entire pipeline, resolving tasks in dependency order, handling errors, and reporting progress.
39
+ *
40
+ * Note: This is not a `PipelineExecutor` (which is bound to a single pipeline), but a utility function used by `createPipelineExecutor` to create a `PipelineExecutor`.
41
+ *
42
+ * @param options - Options for execution, including input parameters, pipeline, and callbacks.
43
+ * @returns The result of the pipeline execution, including output parameters, errors, and usage statistics.
44
+ *
45
+ * @private internal utility of `createPipelineExecutor`
46
+ */
47
+ export declare function executePipeline(options: ExecutePipelineOptions): Promise<PipelineExecutorResult>;
48
+ export {};
@@ -0,0 +1,51 @@
1
+ import type { PartialDeep, Promisable, ReadonlyDeep, WritableDeep } from 'type-fest';
2
+ import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
3
+ import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
4
+ import type { Parameters } from '../../types/typeAliases';
5
+ import type { ExecutionReportJson } from '../execution-report/ExecutionReportJson';
6
+ import type { PipelineExecutorResult } from '../PipelineExecutorResult';
7
+ import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
8
+ /**
9
+ * Options for executing a single pipeline task, including task details, pipeline context, parameters, and callbacks.
10
+ *
11
+ * @private internal type of `executeTask`
12
+ */
13
+ type executeSingleTaskOptions = Required<CreatePipelineExecutorOptions> & {
14
+ /**
15
+ * The task to be executed.
16
+ */
17
+ readonly currentTask: ReadonlyDeep<TaskJson>;
18
+ /**
19
+ * The pipeline in which the task resides, fully prepared and validated.
20
+ */
21
+ readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
22
+ /**
23
+ * The parameters to pass to the task execution.
24
+ */
25
+ readonly parametersToPass: Readonly<Parameters>;
26
+ /**
27
+ * Callback invoked with partial results as the execution progresses.
28
+ */
29
+ onProgress(newOngoingResult: PartialDeep<PipelineExecutorResult>): Promisable<void>;
30
+ /**
31
+ * Mutable execution report object for tracking execution details.
32
+ */
33
+ readonly $executionReport: WritableDeep<ExecutionReportJson>;
34
+ /**
35
+ * String identifier for the pipeline, used in error messages and reporting.
36
+ */
37
+ readonly pipelineIdentification: string;
38
+ };
39
+ /**
40
+ * Executes a single task within a pipeline, handling parameter validation, error checking, and progress reporting.
41
+ *
42
+ * @param options - Options for execution, including the task, pipeline, parameters, and callbacks.
43
+ * @returns The output parameters produced by the task.
44
+ *
45
+ * @private internal utility of `createPipelineExecutor`
46
+ */
47
+ export declare function executeTask(options: executeSingleTaskOptions): Promise<Readonly<Parameters>>;
48
+ export {};
49
+ /**
50
+ * TODO: [๐Ÿคนโ€โ™‚๏ธ]
51
+ */
@@ -0,0 +1,27 @@
1
+ import type { PartialDeep, Promisable } from 'type-fest';
2
+ import type { TODO_any } from '../../utils/organization/TODO_any';
3
+ import type { PipelineExecutorResult } from '../PipelineExecutorResult';
4
+ import type { ExecuteAttemptsOptions } from './40-executeAttempts';
5
+ /**
6
+ * Options for executing a pipeline task that involves formatting subvalues (e.g., iterating over CSV rows).
7
+ * Extends ExecuteAttemptsOptions with a progress callback.
8
+ *
9
+ * @private internal type of `executeFormatSubvalues`
10
+ */
11
+ type ExecuteFormatCellsOptions = ExecuteAttemptsOptions & {
12
+ /**
13
+ * Callback invoked with partial results as the execution progresses.
14
+ */
15
+ onProgress(newOngoingResult: PartialDeep<PipelineExecutorResult>): Promisable<void>;
16
+ };
17
+ /**
18
+ * Executes a pipeline task that requires mapping or iterating over subvalues of a parameter (such as rows in a CSV).
19
+ * Handles format and subformat resolution, error handling, and progress reporting.
20
+ *
21
+ * @param options - Options for execution, including task details and progress callback.
22
+ * @returns The result of the subvalue mapping or execution attempts.
23
+ *
24
+ * @private internal utility of `createPipelineExecutor`
25
+ */
26
+ export declare function executeFormatSubvalues(options: ExecuteFormatCellsOptions): Promise<TODO_any>;
27
+ export {};
@@ -0,0 +1,75 @@
1
+ import type { PartialDeep, Promisable, ReadonlyDeep, WritableDeep } from 'type-fest';
2
+ import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
3
+ import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
4
+ import type { Parameters } from '../../types/typeAliases';
5
+ import type { string_parameter_name } from '../../types/typeAliases';
6
+ import type { TODO_string } from '../../utils/organization/TODO_string';
7
+ import type { ExecutionReportJson } from '../execution-report/ExecutionReportJson';
8
+ import type { PipelineExecutorResult } from '../PipelineExecutorResult';
9
+ import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
10
+ /**
11
+ * Options for executing attempts of a pipeline task, including configuration for jokers, priority,
12
+ * maximum attempts, prepared content, parameters, the task itself, the prepared pipeline, execution report,
13
+ * and pipeline identification. Used internally by the pipeline executor.
14
+ *
15
+ * @private internal type of `executeAttempts`
16
+ */
17
+ export type ExecuteAttemptsOptions = Required<Omit<CreatePipelineExecutorOptions, 'pipeline'>> & {
18
+ /**
19
+ * Names of parameters that act as jokers, which can be used to bypass normal execution if their value meets requirements.
20
+ */
21
+ readonly jokerParameterNames: Readonly<ReadonlyArray<string_parameter_name>>;
22
+ /**
23
+ * Priority of the current execution attempt, used to influence UI or execution order.
24
+ */
25
+ readonly priority: number;
26
+ /**
27
+ * Maximum number of attempts allowed for this task, including retries and joker attempts.
28
+ * Note: [๐Ÿ’‚] There are two distinct variables
29
+ * 1) `maxExecutionAttempts` - attempts for LLM model
30
+ * 2) `maxAttempts` - attempts for any task (LLM, SCRIPT, DIALOG, etc.)
31
+ */
32
+ readonly maxAttempts: number;
33
+ /**
34
+ * The content prepared for execution, with parameters already substituted.
35
+ */
36
+ readonly preparedContent: TODO_string;
37
+ /**
38
+ * The parameters provided for this execution attempt.
39
+ */
40
+ readonly parameters: Readonly<Parameters>;
41
+ /**
42
+ * The task being executed, as a deeply immutable TaskJson object.
43
+ * Note: Naming should be unified between `task` and `currentTask`.
44
+ */
45
+ readonly task: ReadonlyDeep<TaskJson>;
46
+ /**
47
+ * The pipeline structure prepared for execution, as a deeply immutable PipelineJson object.
48
+ */
49
+ readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
50
+ /**
51
+ * Callback invoked with partial results as the execution progresses.
52
+ */
53
+ onProgress(newOngoingResult: PartialDeep<PipelineExecutorResult>): Promisable<void>;
54
+ /**
55
+ * The execution report object, which is updated during execution.
56
+ */
57
+ readonly $executionReport: WritableDeep<ExecutionReportJson>;
58
+ /**
59
+ * String identifier for the pipeline, used for logging and error reporting.
60
+ */
61
+ readonly pipelineIdentification: string;
62
+ };
63
+ /**
64
+ * Executes a pipeline task with multiple attempts, including joker and retry logic. Handles different task types
65
+ * (prompt, script, dialog, etc.), applies postprocessing, checks expectations, and updates the execution report.
66
+ * Throws errors if execution fails after all attempts.
67
+ *
68
+ * @param options - The options for execution, including task, parameters, pipeline, and configuration.
69
+ * @returns The result string of the executed task.
70
+ * @private internal utility of `createPipelineExecutor`
71
+ */
72
+ export declare function executeAttempts(options: ExecuteAttemptsOptions): Promise<TODO_string>;
73
+ /**
74
+ * TODO: Break into smaller functions
75
+ */