@promptbook/components 0.100.0-24

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 (780) hide show
  1. package/README.md +570 -0
  2. package/esm/index.es.js +1953 -0
  3. package/esm/index.es.js.map +1 -0
  4. package/esm/typings/books/index.d.ts +131 -0
  5. package/esm/typings/servers.d.ts +40 -0
  6. package/esm/typings/src/_packages/anthropic-claude.index.d.ts +16 -0
  7. package/esm/typings/src/_packages/azure-openai.index.d.ts +10 -0
  8. package/esm/typings/src/_packages/browser.index.d.ts +12 -0
  9. package/esm/typings/src/_packages/cli.index.d.ts +64 -0
  10. package/esm/typings/src/_packages/components.index.d.ts +4 -0
  11. package/esm/typings/src/_packages/core.index.d.ts +322 -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 +638 -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/BookEditor/BookEditor.d.ts +26 -0
  71. package/esm/typings/src/cli/cli-commands/_boilerplate.d.ts +13 -0
  72. package/esm/typings/src/cli/cli-commands/about.d.ts +14 -0
  73. package/esm/typings/src/cli/cli-commands/common/handleActionErrors.d.ts +11 -0
  74. package/esm/typings/src/cli/cli-commands/hello.d.ts +14 -0
  75. package/esm/typings/src/cli/cli-commands/list-models.d.ts +13 -0
  76. package/esm/typings/src/cli/cli-commands/list-scrapers.d.ts +13 -0
  77. package/esm/typings/src/cli/cli-commands/login.d.ts +14 -0
  78. package/esm/typings/src/cli/cli-commands/make.d.ts +16 -0
  79. package/esm/typings/src/cli/cli-commands/prettify.d.ts +15 -0
  80. package/esm/typings/src/cli/cli-commands/run.d.ts +17 -0
  81. package/esm/typings/src/cli/cli-commands/runInteractiveChatbot.d.ts +32 -0
  82. package/esm/typings/src/cli/cli-commands/start-server.d.ts +13 -0
  83. package/esm/typings/src/cli/cli-commands/test-command.d.ts +16 -0
  84. package/esm/typings/src/cli/common/$addGlobalOptionsToCommand.d.ts +7 -0
  85. package/esm/typings/src/cli/common/$provideLlmToolsForCli.d.ts +28 -0
  86. package/esm/typings/src/cli/main.d.ts +16 -0
  87. package/esm/typings/src/cli/promptbookCli.d.ts +13 -0
  88. package/esm/typings/src/cli/test/ptbk.d.ts +5 -0
  89. package/esm/typings/src/cli/test/ptbk.test.d.ts +1 -0
  90. package/esm/typings/src/collection/PipelineCollection.d.ts +25 -0
  91. package/esm/typings/src/collection/SimplePipelineCollection.d.ts +37 -0
  92. package/esm/typings/src/collection/collectionToJson.d.ts +13 -0
  93. package/esm/typings/src/collection/collectionToJson.test.d.ts +7 -0
  94. package/esm/typings/src/collection/constructors/createCollectionFromDirectory.d.ts +65 -0
  95. package/esm/typings/src/collection/constructors/createCollectionFromDirectory.test.d.ts +1 -0
  96. package/esm/typings/src/collection/constructors/createCollectionFromJson.d.ts +13 -0
  97. package/esm/typings/src/collection/constructors/createCollectionFromJson.test.d.ts +1 -0
  98. package/esm/typings/src/collection/constructors/createCollectionFromPromise.d.ts +23 -0
  99. package/esm/typings/src/collection/constructors/createCollectionFromPromise.test.d.ts +1 -0
  100. package/esm/typings/src/collection/constructors/createCollectionFromUrl.d.ts +29 -0
  101. package/esm/typings/src/collection/constructors/createSubcollection.d.ts +13 -0
  102. package/esm/typings/src/commands/BOOK_VERSION/BookVersionCommand.d.ts +11 -0
  103. package/esm/typings/src/commands/BOOK_VERSION/bookVersionCommand.test.d.ts +1 -0
  104. package/esm/typings/src/commands/BOOK_VERSION/bookVersionCommandParser.d.ts +9 -0
  105. package/esm/typings/src/commands/EXPECT/ExpectCommand.d.ts +17 -0
  106. package/esm/typings/src/commands/EXPECT/expectCommand.test.d.ts +1 -0
  107. package/esm/typings/src/commands/EXPECT/expectCommandParser.d.ts +11 -0
  108. package/esm/typings/src/commands/FOREACH/ForeachCommand.d.ts +10 -0
  109. package/esm/typings/src/commands/FOREACH/ForeachJson.d.ts +27 -0
  110. package/esm/typings/src/commands/FOREACH/foreachCommand.test.d.ts +1 -0
  111. package/esm/typings/src/commands/FOREACH/foreachCommandParser.d.ts +12 -0
  112. package/esm/typings/src/commands/FORMAT/FormatCommand.d.ts +9 -0
  113. package/esm/typings/src/commands/FORMAT/formatCommand.test.d.ts +1 -0
  114. package/esm/typings/src/commands/FORMAT/formatCommandParser.d.ts +9 -0
  115. package/esm/typings/src/commands/FORMFACTOR/FormfactorCommand.d.ts +11 -0
  116. package/esm/typings/src/commands/FORMFACTOR/formfactorCommand.test.d.ts +1 -0
  117. package/esm/typings/src/commands/FORMFACTOR/formfactorCommandParser.d.ts +11 -0
  118. package/esm/typings/src/commands/JOKER/JokerCommand.d.ts +11 -0
  119. package/esm/typings/src/commands/JOKER/jokerCommand.test.d.ts +1 -0
  120. package/esm/typings/src/commands/JOKER/jokerCommandParser.d.ts +9 -0
  121. package/esm/typings/src/commands/KNOWLEDGE/KnowledgeCommand.d.ts +11 -0
  122. package/esm/typings/src/commands/KNOWLEDGE/knowledgeCommand.test.d.ts +1 -0
  123. package/esm/typings/src/commands/KNOWLEDGE/knowledgeCommandParser.d.ts +12 -0
  124. package/esm/typings/src/commands/KNOWLEDGE/utils/knowledgeSourceContentToName.d.ts +11 -0
  125. package/esm/typings/src/commands/KNOWLEDGE/utils/knowledgeSourceContentToName.test.d.ts +4 -0
  126. package/esm/typings/src/commands/MODEL/ModelCommand.d.ts +14 -0
  127. package/esm/typings/src/commands/MODEL/modelCommand.test.d.ts +1 -0
  128. package/esm/typings/src/commands/MODEL/modelCommandParser.d.ts +10 -0
  129. package/esm/typings/src/commands/PARAMETER/ParameterCommand.d.ts +15 -0
  130. package/esm/typings/src/commands/PARAMETER/parameterCommand.test.d.ts +1 -0
  131. package/esm/typings/src/commands/PARAMETER/parameterCommandParser.d.ts +9 -0
  132. package/esm/typings/src/commands/PERSONA/PersonaCommand.d.ts +13 -0
  133. package/esm/typings/src/commands/PERSONA/personaCommand.test.d.ts +1 -0
  134. package/esm/typings/src/commands/PERSONA/personaCommandParser.d.ts +9 -0
  135. package/esm/typings/src/commands/POSTPROCESS/PostprocessCommand.d.ts +11 -0
  136. package/esm/typings/src/commands/POSTPROCESS/postprocessCommand.test.d.ts +1 -0
  137. package/esm/typings/src/commands/POSTPROCESS/postprocessCommandParser.d.ts +9 -0
  138. package/esm/typings/src/commands/SECTION/SectionCommand.d.ts +11 -0
  139. package/esm/typings/src/commands/SECTION/sectionCommand.test.d.ts +1 -0
  140. package/esm/typings/src/commands/SECTION/sectionCommandParser.d.ts +20 -0
  141. package/esm/typings/src/commands/URL/UrlCommand.d.ts +10 -0
  142. package/esm/typings/src/commands/URL/urlCommand.test.d.ts +1 -0
  143. package/esm/typings/src/commands/URL/urlCommandParser.d.ts +9 -0
  144. package/esm/typings/src/commands/X_ACTION/ActionCommand.d.ts +9 -0
  145. package/esm/typings/src/commands/X_ACTION/actionCommand.test.d.ts +1 -0
  146. package/esm/typings/src/commands/X_ACTION/actionCommandParser.d.ts +12 -0
  147. package/esm/typings/src/commands/X_INSTRUMENT/InstrumentCommand.d.ts +9 -0
  148. package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommand.test.d.ts +1 -0
  149. package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommandParser.d.ts +12 -0
  150. package/esm/typings/src/commands/_BOILERPLATE/BoilerplateCommand.d.ts +10 -0
  151. package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommand.test.d.ts +1 -0
  152. package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts +11 -0
  153. package/esm/typings/src/commands/_common/getParserForCommand.d.ts +11 -0
  154. package/esm/typings/src/commands/_common/getParserForCommand.test.d.ts +1 -0
  155. package/esm/typings/src/commands/_common/parseCommand.d.ts +12 -0
  156. package/esm/typings/src/commands/_common/parseCommand.test.d.ts +1 -0
  157. package/esm/typings/src/commands/_common/stringifyCommand.d.ts +12 -0
  158. package/esm/typings/src/commands/_common/stringifyCommand.test.d.ts +1 -0
  159. package/esm/typings/src/commands/_common/types/Command.d.ts +6 -0
  160. package/esm/typings/src/commands/_common/types/CommandParser.d.ts +205 -0
  161. package/esm/typings/src/commands/_common/types/CommandType.d.ts +17 -0
  162. package/esm/typings/src/commands/_common/types/CommandUsagePlaces.d.ts +13 -0
  163. package/esm/typings/src/commands/index.d.ts +9 -0
  164. package/esm/typings/src/config.d.ts +313 -0
  165. package/esm/typings/src/config.test.d.ts +4 -0
  166. package/esm/typings/src/constants.d.ts +76 -0
  167. package/esm/typings/src/conversion/archive/loadArchive.d.ts +16 -0
  168. package/esm/typings/src/conversion/archive/saveArchive.d.ts +18 -0
  169. package/esm/typings/src/conversion/compilePipeline.d.ts +25 -0
  170. package/esm/typings/src/conversion/compilePipeline.test.d.ts +1 -0
  171. package/esm/typings/src/conversion/compilePipelineOnRemoteServer.d.ts +21 -0
  172. package/esm/typings/src/conversion/parsePipeline.d.ts +30 -0
  173. package/esm/typings/src/conversion/parsePipeline.test.d.ts +1 -0
  174. package/esm/typings/src/conversion/pipelineJsonToString.d.ts +18 -0
  175. package/esm/typings/src/conversion/prettify/PrettifyOptions.d.ts +13 -0
  176. package/esm/typings/src/conversion/prettify/prettifyPipelineString.d.ts +12 -0
  177. package/esm/typings/src/conversion/prettify/renderPipelineMermaidOptions.d.ts +30 -0
  178. package/esm/typings/src/conversion/utils/extractParameterNamesFromTask.d.ts +15 -0
  179. package/esm/typings/src/conversion/utils/extractParameterNamesFromTask.test.d.ts +1 -0
  180. package/esm/typings/src/conversion/validation/_importPipeline.d.ts +23 -0
  181. package/esm/typings/src/conversion/validation/pipelineStringToJson-parseErrors.test.d.ts +4 -0
  182. package/esm/typings/src/conversion/validation/validatePipeline-logicErrors.test.d.ts +4 -0
  183. package/esm/typings/src/conversion/validation/validatePipeline.d.ts +42 -0
  184. package/esm/typings/src/conversion/validation/validatePipeline.test.d.ts +4 -0
  185. package/esm/typings/src/dialogs/callback/CallbackInterfaceTools.d.ts +17 -0
  186. package/esm/typings/src/dialogs/callback/CallbackInterfaceToolsOptions.d.ts +14 -0
  187. package/esm/typings/src/dialogs/simple-prompt/SimplePromptInterfaceTools.d.ts +22 -0
  188. package/esm/typings/src/dialogs/user-interface-execution-tools.test.d.ts +1 -0
  189. package/esm/typings/src/errors/0-BoilerplateError.d.ts +12 -0
  190. package/esm/typings/src/errors/0-index.d.ts +94 -0
  191. package/esm/typings/src/errors/AbstractFormatError.d.ts +11 -0
  192. package/esm/typings/src/errors/AuthenticationError.d.ts +9 -0
  193. package/esm/typings/src/errors/CollectionError.d.ts +9 -0
  194. package/esm/typings/src/errors/EnvironmentMismatchError.d.ts +9 -0
  195. package/esm/typings/src/errors/ExpectError.d.ts +12 -0
  196. package/esm/typings/src/errors/KnowledgeScrapeError.d.ts +9 -0
  197. package/esm/typings/src/errors/LimitReachedError.d.ts +9 -0
  198. package/esm/typings/src/errors/MissingToolsError.d.ts +9 -0
  199. package/esm/typings/src/errors/NotFoundError.d.ts +9 -0
  200. package/esm/typings/src/errors/NotYetImplementedError.d.ts +9 -0
  201. package/esm/typings/src/errors/ParseError.d.ts +12 -0
  202. package/esm/typings/src/errors/PipelineExecutionError.d.ts +14 -0
  203. package/esm/typings/src/errors/PipelineLogicError.d.ts +9 -0
  204. package/esm/typings/src/errors/PipelineUrlError.d.ts +9 -0
  205. package/esm/typings/src/errors/PromptbookFetchError.d.ts +9 -0
  206. package/esm/typings/src/errors/UnexpectedError.d.ts +9 -0
  207. package/esm/typings/src/errors/WrappedError.d.ts +10 -0
  208. package/esm/typings/src/errors/assertsError.d.ts +11 -0
  209. package/esm/typings/src/errors/utils/ErrorJson.d.ts +25 -0
  210. package/esm/typings/src/errors/utils/deserializeError.d.ts +7 -0
  211. package/esm/typings/src/errors/utils/deserializeError.test.d.ts +1 -0
  212. package/esm/typings/src/errors/utils/getErrorReportUrl.d.ts +6 -0
  213. package/esm/typings/src/errors/utils/serializeError.d.ts +7 -0
  214. package/esm/typings/src/errors/utils/serializeError.test.d.ts +1 -0
  215. package/esm/typings/src/executables/$provideExecutablesForNode.d.ts +12 -0
  216. package/esm/typings/src/executables/apps/locateLibreoffice.d.ts +12 -0
  217. package/esm/typings/src/executables/apps/locateLibreoffice.test.d.ts +1 -0
  218. package/esm/typings/src/executables/apps/locatePandoc.d.ts +12 -0
  219. package/esm/typings/src/executables/apps/locatePandoc.test.d.ts +1 -0
  220. package/esm/typings/src/executables/locateApp.d.ts +33 -0
  221. package/esm/typings/src/executables/locateApp.test.d.ts +1 -0
  222. package/esm/typings/src/executables/platforms/locateAppOnLinux.d.ts +13 -0
  223. package/esm/typings/src/executables/platforms/locateAppOnMacOs.d.ts +13 -0
  224. package/esm/typings/src/executables/platforms/locateAppOnWindows.d.ts +13 -0
  225. package/esm/typings/src/execution/AbstractTaskResult.d.ts +25 -0
  226. package/esm/typings/src/execution/AvailableModel.d.ts +46 -0
  227. package/esm/typings/src/execution/CommonToolsOptions.d.ts +28 -0
  228. package/esm/typings/src/execution/EmbeddingVector.d.ts +8 -0
  229. package/esm/typings/src/execution/Executables.d.ts +18 -0
  230. package/esm/typings/src/execution/ExecutionTask.d.ts +119 -0
  231. package/esm/typings/src/execution/ExecutionTools.d.ts +69 -0
  232. package/esm/typings/src/execution/FilesystemTools.d.ts +9 -0
  233. package/esm/typings/src/execution/LlmExecutionTools.d.ts +61 -0
  234. package/esm/typings/src/execution/LlmExecutionToolsConstructor.d.ts +11 -0
  235. package/esm/typings/src/execution/PipelineExecutor.d.ts +16 -0
  236. package/esm/typings/src/execution/PipelineExecutorResult.d.ts +39 -0
  237. package/esm/typings/src/execution/PromptResult.d.ts +101 -0
  238. package/esm/typings/src/execution/PromptbookFetch.d.ts +12 -0
  239. package/esm/typings/src/execution/PromptbookFetch.test-type.d.ts +5 -0
  240. package/esm/typings/src/execution/ScriptExecutionTools.d.ts +39 -0
  241. package/esm/typings/src/execution/UncertainNumber.d.ts +19 -0
  242. package/esm/typings/src/execution/Usage.d.ts +33 -0
  243. package/esm/typings/src/execution/UserInterfaceTools.d.ts +46 -0
  244. package/esm/typings/src/execution/assertsTaskSuccessful.d.ts +14 -0
  245. package/esm/typings/src/execution/createPipelineExecutor/$OngoingTaskResult.d.ts +56 -0
  246. package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorOptions.d.ts +46 -0
  247. package/esm/typings/src/execution/createPipelineExecutor/00-createPipelineExecutor.d.ts +10 -0
  248. package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts +48 -0
  249. package/esm/typings/src/execution/createPipelineExecutor/20-executeTask.d.ts +51 -0
  250. package/esm/typings/src/execution/createPipelineExecutor/30-executeFormatSubvalues.d.ts +27 -0
  251. package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +70 -0
  252. package/esm/typings/src/execution/createPipelineExecutor/computeCosineSimilarity.d.ts +13 -0
  253. package/esm/typings/src/execution/createPipelineExecutor/filterJustOutputParameters.d.ts +35 -0
  254. package/esm/typings/src/execution/createPipelineExecutor/getContextForTask.d.ts +14 -0
  255. package/esm/typings/src/execution/createPipelineExecutor/getExamplesForTask.d.ts +10 -0
  256. package/esm/typings/src/execution/createPipelineExecutor/getKnowledgeForTask.d.ts +42 -0
  257. package/esm/typings/src/execution/createPipelineExecutor/getReservedParametersForTask.d.ts +48 -0
  258. package/esm/typings/src/execution/createPipelineExecutor/knowledgePiecesToString.d.ts +9 -0
  259. package/esm/typings/src/execution/embeddingVectorToString.d.ts +7 -0
  260. package/esm/typings/src/execution/execution-report/ExecutionPromptReportJson.d.ts +24 -0
  261. package/esm/typings/src/execution/execution-report/ExecutionReportJson.d.ts +41 -0
  262. package/esm/typings/src/execution/execution-report/ExecutionReportString.d.ts +16 -0
  263. package/esm/typings/src/execution/execution-report/ExecutionReportStringOptions.d.ts +25 -0
  264. package/esm/typings/src/execution/execution-report/countWorkingDuration.d.ts +7 -0
  265. package/esm/typings/src/execution/execution-report/countWorkingDuration.test.d.ts +1 -0
  266. package/esm/typings/src/execution/execution-report/executionReportJsonToString.d.ts +15 -0
  267. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/AutomaticTranslator.d.ts +7 -0
  268. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/DebugAutomaticTranslator.d.ts +11 -0
  269. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/FakeAutomaticTranslator.d.ts +8 -0
  270. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/LindatAutomaticTranslator.d.ts +22 -0
  271. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/TranslatorOptions.d.ts +7 -0
  272. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.d.ts +8 -0
  273. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.test.d.ts +1 -0
  274. package/esm/typings/src/execution/translation/automatic-translate/translateMessages.d.ts +12 -0
  275. package/esm/typings/src/execution/utils/$provideExecutionToolsForNode.d.ts +13 -0
  276. package/esm/typings/src/execution/utils/addUsage.d.ts +9 -0
  277. package/esm/typings/src/execution/utils/addUsage.test.d.ts +1 -0
  278. package/esm/typings/src/execution/utils/checkExpectations.d.ts +29 -0
  279. package/esm/typings/src/execution/utils/checkExpectations.test.d.ts +1 -0
  280. package/esm/typings/src/execution/utils/computeUsageCounts.d.ts +10 -0
  281. package/esm/typings/src/execution/utils/forEachAsync.d.ts +20 -0
  282. package/esm/typings/src/execution/utils/uncertainNumber.d.ts +10 -0
  283. package/esm/typings/src/execution/utils/usage-constants.d.ts +147 -0
  284. package/esm/typings/src/execution/utils/usageToHuman.d.ts +26 -0
  285. package/esm/typings/src/execution/utils/usageToWorktime.d.ts +20 -0
  286. package/esm/typings/src/execution/utils/usageToWorktime.test.d.ts +1 -0
  287. package/esm/typings/src/execution/utils/validatePromptResult.d.ts +53 -0
  288. package/esm/typings/src/expectations/drafts/isDomainNameFree.d.ts +10 -0
  289. package/esm/typings/src/expectations/drafts/isGithubNameFree.d.ts +10 -0
  290. package/esm/typings/src/formats/_common/FormatParser.d.ts +72 -0
  291. package/esm/typings/src/formats/_common/FormatSubvalueParser.d.ts +66 -0
  292. package/esm/typings/src/formats/csv/CsvFormatError.d.ts +10 -0
  293. package/esm/typings/src/formats/csv/CsvFormatParser.d.ts +17 -0
  294. package/esm/typings/src/formats/csv/CsvSettings.d.ts +13 -0
  295. package/esm/typings/src/formats/csv/utils/csvParse.d.ts +12 -0
  296. package/esm/typings/src/formats/csv/utils/isValidCsvString.d.ts +9 -0
  297. package/esm/typings/src/formats/csv/utils/isValidCsvString.test.d.ts +1 -0
  298. package/esm/typings/src/formats/index.d.ts +9 -0
  299. package/esm/typings/src/formats/json/JsonFormatParser.d.ts +19 -0
  300. package/esm/typings/src/formats/json/utils/isValidJsonString.d.ts +9 -0
  301. package/esm/typings/src/formats/json/utils/isValidJsonString.test.d.ts +1 -0
  302. package/esm/typings/src/formats/json/utils/jsonParse.d.ts +8 -0
  303. package/esm/typings/src/formats/text/TextFormatParser.d.ts +19 -0
  304. package/esm/typings/src/formats/xml/XmlFormatParser.d.ts +19 -0
  305. package/esm/typings/src/formats/xml/utils/isValidXmlString.d.ts +9 -0
  306. package/esm/typings/src/formats/xml/utils/isValidXmlString.test.d.ts +1 -0
  307. package/esm/typings/src/formfactors/_boilerplate/BoilerplateFormfactorDefinition.d.ts +15 -0
  308. package/esm/typings/src/formfactors/_common/AbstractFormfactorDefinition.d.ts +49 -0
  309. package/esm/typings/src/formfactors/_common/FormfactorDefinition.d.ts +10 -0
  310. package/esm/typings/src/formfactors/_common/string_formfactor_name.d.ts +6 -0
  311. package/esm/typings/src/formfactors/chatbot/ChatbotFormfactorDefinition.d.ts +45 -0
  312. package/esm/typings/src/formfactors/completion/CompletionFormfactorDefinition.d.ts +29 -0
  313. package/esm/typings/src/formfactors/generator/GeneratorFormfactorDefinition.d.ts +25 -0
  314. package/esm/typings/src/formfactors/generic/GenericFormfactorDefinition.d.ts +14 -0
  315. package/esm/typings/src/formfactors/image-generator/ImageGeneratorFormfactorDefinition.d.ts +24 -0
  316. package/esm/typings/src/formfactors/index.d.ts +170 -0
  317. package/esm/typings/src/formfactors/matcher/MatcherFormfactorDefinition.d.ts +21 -0
  318. package/esm/typings/src/formfactors/sheets/SheetsFormfactorDefinition.d.ts +26 -0
  319. package/esm/typings/src/formfactors/translator/TranslatorFormfactorDefinition.d.ts +25 -0
  320. package/esm/typings/src/high-level-abstractions/_common/HighLevelAbstraction.d.ts +20 -0
  321. package/esm/typings/src/high-level-abstractions/implicit-formfactor/ImplicitFormfactorHla.d.ts +10 -0
  322. package/esm/typings/src/high-level-abstractions/index.d.ts +54 -0
  323. package/esm/typings/src/high-level-abstractions/quick-chatbot/QuickChatbotHla.d.ts +13 -0
  324. package/esm/typings/src/llm-providers/_common/filterModels.d.ts +15 -0
  325. package/esm/typings/src/llm-providers/_common/register/$llmToolsMetadataRegister.d.ts +13 -0
  326. package/esm/typings/src/llm-providers/_common/register/$llmToolsRegister.d.ts +13 -0
  327. package/esm/typings/src/llm-providers/_common/register/$provideEnvFilename.d.ts +12 -0
  328. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsConfigurationFromEnv.d.ts +19 -0
  329. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForTestingAndScriptsAndPlayground.d.ts +27 -0
  330. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForWizardOrCli.d.ts +59 -0
  331. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsFromEnv.d.ts +41 -0
  332. package/esm/typings/src/llm-providers/_common/register/$registeredLlmToolsMessage.d.ts +22 -0
  333. package/esm/typings/src/llm-providers/_common/register/LlmToolsConfiguration.d.ts +30 -0
  334. package/esm/typings/src/llm-providers/_common/register/LlmToolsMetadata.d.ts +58 -0
  335. package/esm/typings/src/llm-providers/_common/register/LlmToolsOptions.d.ts +17 -0
  336. package/esm/typings/src/llm-providers/_common/register/createLlmToolsFromConfiguration.d.ts +49 -0
  337. package/esm/typings/src/llm-providers/_common/register/createLlmToolsFromConfiguration.test.d.ts +1 -0
  338. package/esm/typings/src/llm-providers/_common/utils/cache/CacheItem.d.ts +33 -0
  339. package/esm/typings/src/llm-providers/_common/utils/cache/CacheLlmToolsOptions.d.ts +27 -0
  340. package/esm/typings/src/llm-providers/_common/utils/cache/cacheLlmTools.d.ts +19 -0
  341. package/esm/typings/src/llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage.d.ts +22 -0
  342. package/esm/typings/src/llm-providers/_common/utils/count-total-usage/countUsage.d.ts +17 -0
  343. package/esm/typings/src/llm-providers/_common/utils/count-total-usage/limitTotalUsage.d.ts +36 -0
  344. package/esm/typings/src/llm-providers/_common/utils/pricing.d.ts +16 -0
  345. package/esm/typings/src/llm-providers/_common/utils/pricing.test.d.ts +1 -0
  346. package/esm/typings/src/llm-providers/_multiple/MultipleLlmExecutionTools.d.ts +63 -0
  347. package/esm/typings/src/llm-providers/_multiple/joinLlmExecutionTools.d.ts +21 -0
  348. package/esm/typings/src/llm-providers/_multiple/playground/playground.d.ts +5 -0
  349. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +66 -0
  350. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions.d.ts +31 -0
  351. package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +24 -0
  352. package/esm/typings/src/llm-providers/anthropic-claude/computeAnthropicClaudeUsage.d.ts +18 -0
  353. package/esm/typings/src/llm-providers/anthropic-claude/computeAnthropicClaudeUsage.test.d.ts +4 -0
  354. package/esm/typings/src/llm-providers/anthropic-claude/createAnthropicClaudeExecutionTools.d.ts +19 -0
  355. package/esm/typings/src/llm-providers/anthropic-claude/playground/playground.d.ts +7 -0
  356. package/esm/typings/src/llm-providers/anthropic-claude/register-configuration.d.ts +14 -0
  357. package/esm/typings/src/llm-providers/anthropic-claude/register-constructor.d.ts +16 -0
  358. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +67 -0
  359. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionToolsOptions.d.ts +37 -0
  360. package/esm/typings/src/llm-providers/azure-openai/createAzureOpenAiExecutionTools.d.ts +15 -0
  361. package/esm/typings/src/llm-providers/azure-openai/playground/playground.d.ts +6 -0
  362. package/esm/typings/src/llm-providers/azure-openai/register-configuration.d.ts +14 -0
  363. package/esm/typings/src/llm-providers/azure-openai/register-constructor.d.ts +15 -0
  364. package/esm/typings/src/llm-providers/deepseek/DeepseekExecutionToolsOptions.d.ts +9 -0
  365. package/esm/typings/src/llm-providers/deepseek/createDeepseekExecutionTools.d.ts +14 -0
  366. package/esm/typings/src/llm-providers/deepseek/deepseek-models.d.ts +23 -0
  367. package/esm/typings/src/llm-providers/deepseek/register-configuration.d.ts +14 -0
  368. package/esm/typings/src/llm-providers/deepseek/register-constructor.d.ts +15 -0
  369. package/esm/typings/src/llm-providers/google/GoogleExecutionToolsOptions.d.ts +9 -0
  370. package/esm/typings/src/llm-providers/google/createGoogleExecutionTools.d.ts +14 -0
  371. package/esm/typings/src/llm-providers/google/google-models.d.ts +23 -0
  372. package/esm/typings/src/llm-providers/google/register-configuration.d.ts +14 -0
  373. package/esm/typings/src/llm-providers/google/register-constructor.d.ts +15 -0
  374. package/esm/typings/src/llm-providers/mocked/$fakeTextToExpectations.d.ts +15 -0
  375. package/esm/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts +40 -0
  376. package/esm/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts +44 -0
  377. package/esm/typings/src/llm-providers/mocked/test/fakeTextToExpectations.test.d.ts +1 -0
  378. package/esm/typings/src/llm-providers/mocked/test/faked-completion.test.d.ts +1 -0
  379. package/esm/typings/src/llm-providers/mocked/test/joker.test.d.ts +4 -0
  380. package/esm/typings/src/llm-providers/mocked/test/mocked-chat.test.d.ts +5 -0
  381. package/esm/typings/src/llm-providers/mocked/test/mocked-completion.test.d.ts +4 -0
  382. package/esm/typings/src/llm-providers/ollama/OllamaExecutionTools.d.ts +44 -0
  383. package/esm/typings/src/llm-providers/ollama/OllamaExecutionToolsOptions.d.ts +23 -0
  384. package/esm/typings/src/llm-providers/ollama/createOllamaExecutionTools.d.ts +11 -0
  385. package/esm/typings/src/llm-providers/ollama/ollama-models.d.ts +14 -0
  386. package/esm/typings/src/llm-providers/ollama/playground/playground.d.ts +6 -0
  387. package/esm/typings/src/llm-providers/ollama/register-configuration.d.ts +14 -0
  388. package/esm/typings/src/llm-providers/ollama/register-constructor.d.ts +15 -0
  389. package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionTools.d.ts +36 -0
  390. package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionToolsOptions.d.ts +14 -0
  391. package/esm/typings/src/llm-providers/openai/OpenAiCompatibleExecutionTools.d.ts +91 -0
  392. package/esm/typings/src/llm-providers/openai/OpenAiCompatibleExecutionToolsOptions.d.ts +52 -0
  393. package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +38 -0
  394. package/esm/typings/src/llm-providers/openai/OpenAiExecutionToolsOptions.d.ts +9 -0
  395. package/esm/typings/src/llm-providers/openai/computeOpenAiUsage.d.ts +18 -0
  396. package/esm/typings/src/llm-providers/openai/computeOpenAiUsage.test.d.ts +4 -0
  397. package/esm/typings/src/llm-providers/openai/createOpenAiAssistantExecutionTools.d.ts +15 -0
  398. package/esm/typings/src/llm-providers/openai/createOpenAiCompatibleExecutionTools.d.ts +74 -0
  399. package/esm/typings/src/llm-providers/openai/createOpenAiExecutionTools.d.ts +17 -0
  400. package/esm/typings/src/llm-providers/openai/openai-models.d.ts +25 -0
  401. package/esm/typings/src/llm-providers/openai/playground/playground.d.ts +6 -0
  402. package/esm/typings/src/llm-providers/openai/register-configuration.d.ts +35 -0
  403. package/esm/typings/src/llm-providers/openai/register-constructor.d.ts +39 -0
  404. package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts +59 -0
  405. package/esm/typings/src/llm-providers/remote/playground/playground.d.ts +5 -0
  406. package/esm/typings/src/llm-providers/vercel/VercelExecutionToolsOptions.d.ts +23 -0
  407. package/esm/typings/src/llm-providers/vercel/VercelProvider.d.ts +13 -0
  408. package/esm/typings/src/llm-providers/vercel/createExecutionToolsFromVercelProvider.d.ts +8 -0
  409. package/esm/typings/src/llm-providers/vercel/playground/playground.d.ts +6 -0
  410. package/esm/typings/src/migrations/migratePipeline.d.ts +9 -0
  411. package/esm/typings/src/other/templates/getBookTemplates.d.ts +24 -0
  412. package/esm/typings/src/other/templates/getTemplatesPipelineCollection.d.ts +10 -0
  413. package/esm/typings/src/personas/preparePersona.d.ts +17 -0
  414. package/esm/typings/src/pipeline/PipelineInterface/PipelineInterface.d.ts +22 -0
  415. package/esm/typings/src/pipeline/PipelineInterface/constants.d.ts +14 -0
  416. package/esm/typings/src/pipeline/PipelineInterface/getPipelineInterface.d.ts +11 -0
  417. package/esm/typings/src/pipeline/PipelineInterface/isPipelineImplementingInterface.d.ts +27 -0
  418. package/esm/typings/src/pipeline/PipelineInterface/isPipelineInterfacesEqual.d.ts +10 -0
  419. package/esm/typings/src/pipeline/PipelineJson/CommonTaskJson.d.ts +103 -0
  420. package/esm/typings/src/pipeline/PipelineJson/DialogTaskJson.d.ts +13 -0
  421. package/esm/typings/src/pipeline/PipelineJson/Expectations.d.ts +40 -0
  422. package/esm/typings/src/pipeline/PipelineJson/KnowledgePieceJson.d.ts +73 -0
  423. package/esm/typings/src/pipeline/PipelineJson/KnowledgeSourceJson.d.ts +44 -0
  424. package/esm/typings/src/pipeline/PipelineJson/ParameterJson.d.ts +98 -0
  425. package/esm/typings/src/pipeline/PipelineJson/PersonaJson.d.ts +47 -0
  426. package/esm/typings/src/pipeline/PipelineJson/PipelineJson.d.ts +113 -0
  427. package/esm/typings/src/pipeline/PipelineJson/PreparationJson.d.ts +22 -0
  428. package/esm/typings/src/pipeline/PipelineJson/PromptTaskJson.d.ts +26 -0
  429. package/esm/typings/src/pipeline/PipelineJson/ScriptTaskJson.d.ts +20 -0
  430. package/esm/typings/src/pipeline/PipelineJson/SimpleTaskJson.d.ts +13 -0
  431. package/esm/typings/src/pipeline/PipelineJson/TaskJson.d.ts +11 -0
  432. package/esm/typings/src/pipeline/PipelineString.d.ts +11 -0
  433. package/esm/typings/src/pipeline/book-notation.d.ts +20 -0
  434. package/esm/typings/src/pipeline/isValidPipelineString.d.ts +13 -0
  435. package/esm/typings/src/pipeline/isValidPipelineString.test.d.ts +4 -0
  436. package/esm/typings/src/pipeline/prompt-notation.d.ts +31 -0
  437. package/esm/typings/src/pipeline/prompt-notation.test.d.ts +4 -0
  438. package/esm/typings/src/pipeline/validatePipelineString.d.ts +14 -0
  439. package/esm/typings/src/playground/playground.d.ts +5 -0
  440. package/esm/typings/src/postprocessing/utils/extractBlock.d.ts +16 -0
  441. package/esm/typings/src/postprocessing/utils/extractJsonBlock.d.ts +25 -0
  442. package/esm/typings/src/postprocessing/utils/extractJsonBlock.test.d.ts +1 -0
  443. package/esm/typings/src/prepare/PrepareAndScrapeOptions.d.ts +51 -0
  444. package/esm/typings/src/prepare/isPipelinePrepared.d.ts +18 -0
  445. package/esm/typings/src/prepare/isPipelinePrepared.test.d.ts +1 -0
  446. package/esm/typings/src/prepare/preparePipeline.d.ts +22 -0
  447. package/esm/typings/src/prepare/preparePipelineOnRemoteServer.d.ts +17 -0
  448. package/esm/typings/src/prepare/prepareTasks.d.ts +36 -0
  449. package/esm/typings/src/prepare/unpreparePipeline.d.ts +13 -0
  450. package/esm/typings/src/remote-server/RemoteServer.d.ts +23 -0
  451. package/esm/typings/src/remote-server/createRemoteClient.d.ts +10 -0
  452. package/esm/typings/src/remote-server/openapi-types.d.ts +626 -0
  453. package/esm/typings/src/remote-server/openapi.d.ts +581 -0
  454. package/esm/typings/src/remote-server/socket-types/_common/PromptbookServer_Error.d.ts +7 -0
  455. package/esm/typings/src/remote-server/socket-types/_subtypes/Identification.d.ts +59 -0
  456. package/esm/typings/src/remote-server/socket-types/_subtypes/identificationToPromptbookToken.d.ts +11 -0
  457. package/esm/typings/src/remote-server/socket-types/_subtypes/promptbookTokenToIdentification.d.ts +10 -0
  458. package/esm/typings/src/remote-server/socket-types/listModels/PromptbookServer_ListModels_Request.d.ts +17 -0
  459. package/esm/typings/src/remote-server/socket-types/listModels/PromptbookServer_ListModels_Response.d.ts +17 -0
  460. package/esm/typings/src/remote-server/socket-types/prepare/PromptbookServer_PreparePipeline_Request.d.ts +17 -0
  461. package/esm/typings/src/remote-server/socket-types/prepare/PromptbookServer_PreparePipeline_Response.d.ts +12 -0
  462. package/esm/typings/src/remote-server/socket-types/prompt/PromptbookServer_Prompt_Request.d.ts +17 -0
  463. package/esm/typings/src/remote-server/socket-types/prompt/PromptbookServer_Prompt_Response.d.ts +12 -0
  464. package/esm/typings/src/remote-server/startRemoteServer.d.ts +25 -0
  465. package/esm/typings/src/remote-server/types/RemoteClientOptions.d.ts +24 -0
  466. package/esm/typings/src/remote-server/types/RemoteServerOptions.d.ts +164 -0
  467. package/esm/typings/src/scrapers/_boilerplate/BoilerplateScraper.d.ts +43 -0
  468. package/esm/typings/src/scrapers/_boilerplate/createBoilerplateScraper.d.ts +20 -0
  469. package/esm/typings/src/scrapers/_boilerplate/playground/boilerplate-scraper-playground.d.ts +5 -0
  470. package/esm/typings/src/scrapers/_boilerplate/register-constructor.d.ts +15 -0
  471. package/esm/typings/src/scrapers/_boilerplate/register-metadata.d.ts +28 -0
  472. package/esm/typings/src/scrapers/_common/Converter.d.ts +25 -0
  473. package/esm/typings/src/scrapers/_common/Scraper.d.ts +60 -0
  474. package/esm/typings/src/scrapers/_common/ScraperIntermediateSource.d.ts +16 -0
  475. package/esm/typings/src/scrapers/_common/prepareKnowledgePieces.d.ts +19 -0
  476. package/esm/typings/src/scrapers/_common/prepareKnowledgePieces.test.d.ts +1 -0
  477. package/esm/typings/src/scrapers/_common/register/$provideFilesystemForNode.d.ts +12 -0
  478. package/esm/typings/src/scrapers/_common/register/$provideScrapersForBrowser.d.ts +15 -0
  479. package/esm/typings/src/scrapers/_common/register/$provideScrapersForNode.d.ts +13 -0
  480. package/esm/typings/src/scrapers/_common/register/$provideScriptingForNode.d.ts +11 -0
  481. package/esm/typings/src/scrapers/_common/register/$registeredScrapersMessage.d.ts +13 -0
  482. package/esm/typings/src/scrapers/_common/register/$scrapersMetadataRegister.d.ts +13 -0
  483. package/esm/typings/src/scrapers/_common/register/$scrapersRegister.d.ts +14 -0
  484. package/esm/typings/src/scrapers/_common/register/ScraperAndConverterMetadata.d.ts +46 -0
  485. package/esm/typings/src/scrapers/_common/register/ScraperConstructor.d.ts +13 -0
  486. package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.d.ts +35 -0
  487. package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.test.d.ts +4 -0
  488. package/esm/typings/src/scrapers/_common/utils/makeKnowledgeSourceHandler.d.ts +13 -0
  489. package/esm/typings/src/scrapers/_common/utils/promptbookFetch.d.ts +10 -0
  490. package/esm/typings/src/scrapers/document/DocumentScraper.d.ts +43 -0
  491. package/esm/typings/src/scrapers/document/DocumentScraper.test.d.ts +4 -0
  492. package/esm/typings/src/scrapers/document/createDocumentScraper.d.ts +20 -0
  493. package/esm/typings/src/scrapers/document/playground/document-scraper-playground.d.ts +5 -0
  494. package/esm/typings/src/scrapers/document/register-constructor.d.ts +15 -0
  495. package/esm/typings/src/scrapers/document/register-metadata.d.ts +28 -0
  496. package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.d.ts +43 -0
  497. package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.test.d.ts +4 -0
  498. package/esm/typings/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts +21 -0
  499. package/esm/typings/src/scrapers/document-legacy/playground/legacy-document-scraper-playground.d.ts +5 -0
  500. package/esm/typings/src/scrapers/document-legacy/register-constructor.d.ts +15 -0
  501. package/esm/typings/src/scrapers/document-legacy/register-metadata.d.ts +28 -0
  502. package/esm/typings/src/scrapers/markdown/MarkdownScraper.d.ts +29 -0
  503. package/esm/typings/src/scrapers/markdown/MarkdownScraper.test.d.ts +4 -0
  504. package/esm/typings/src/scrapers/markdown/createMarkdownScraper.d.ts +20 -0
  505. package/esm/typings/src/scrapers/markdown/playground/markdown-scraper-playground.d.ts +5 -0
  506. package/esm/typings/src/scrapers/markdown/register-constructor.d.ts +15 -0
  507. package/esm/typings/src/scrapers/markdown/register-metadata.d.ts +28 -0
  508. package/esm/typings/src/scrapers/markitdown/MarkitdownScraper.d.ts +50 -0
  509. package/esm/typings/src/scrapers/markitdown/createMarkitdownScraper.d.ts +22 -0
  510. package/esm/typings/src/scrapers/markitdown/playground/markitdown-scraper-playground.d.ts +5 -0
  511. package/esm/typings/src/scrapers/markitdown/register-constructor.d.ts +17 -0
  512. package/esm/typings/src/scrapers/markitdown/register-metadata.d.ts +28 -0
  513. package/esm/typings/src/scrapers/pdf/PdfScraper.d.ts +41 -0
  514. package/esm/typings/src/scrapers/pdf/createPdfScraper.d.ts +21 -0
  515. package/esm/typings/src/scrapers/pdf/playground/pdf-scraper-playground.d.ts +5 -0
  516. package/esm/typings/src/scrapers/pdf/register-constructor.d.ts +15 -0
  517. package/esm/typings/src/scrapers/pdf/register-metadata.d.ts +28 -0
  518. package/esm/typings/src/scrapers/website/WebsiteScraper.d.ts +50 -0
  519. package/esm/typings/src/scrapers/website/createWebsiteScraper.d.ts +21 -0
  520. package/esm/typings/src/scrapers/website/playground/website-scraper-playground.d.ts +5 -0
  521. package/esm/typings/src/scrapers/website/register-constructor.d.ts +15 -0
  522. package/esm/typings/src/scrapers/website/register-metadata.d.ts +28 -0
  523. package/esm/typings/src/scrapers/website/utils/createShowdownConverter.d.ts +7 -0
  524. package/esm/typings/src/scrapers/website/utils/createShowdownConverter.test.d.ts +1 -0
  525. package/esm/typings/src/scripting/_test/custom-function-async.test.ts.test.d.ts +1 -0
  526. package/esm/typings/src/scripting/_test/custom-function-missing.test.d.ts +1 -0
  527. package/esm/typings/src/scripting/_test/custom-function-with-dependencies.test.d.ts +1 -0
  528. package/esm/typings/src/scripting/_test/custom-function.test.d.ts +1 -0
  529. package/esm/typings/src/scripting/_test/postprocessing.test.d.ts +1 -0
  530. package/esm/typings/src/scripting/_test/script-execution-errors.test.d.ts +1 -0
  531. package/esm/typings/src/scripting/_test/script-execution-tools.test.d.ts +1 -0
  532. package/esm/typings/src/scripting/javascript/JavascriptEvalExecutionTools.d.ts +22 -0
  533. package/esm/typings/src/scripting/javascript/JavascriptEvalExecutionTools.test.d.ts +4 -0
  534. package/esm/typings/src/scripting/javascript/JavascriptExecutionTools.d.ts +8 -0
  535. package/esm/typings/src/scripting/javascript/JavascriptExecutionToolsOptions.d.ts +26 -0
  536. package/esm/typings/src/scripting/javascript/postprocessing-functions.d.ts +56 -0
  537. package/esm/typings/src/scripting/javascript/utils/extractVariablesFromJavascript.d.ts +14 -0
  538. package/esm/typings/src/scripting/javascript/utils/extractVariablesFromJavascript.test.d.ts +1 -0
  539. package/esm/typings/src/scripting/javascript/utils/extractVariablesFromScript.test.d.ts +1 -0
  540. package/esm/typings/src/scripting/javascript/utils/preserve.d.ts +14 -0
  541. package/esm/typings/src/scripting/python/PythonExecutionTools.d.ts +18 -0
  542. package/esm/typings/src/scripting/typescript/TypescriptExecutionTools.d.ts +18 -0
  543. package/esm/typings/src/storage/_common/PromptbookStorage.d.ts +24 -0
  544. package/esm/typings/src/storage/_common/PromptbookStorage.test-type.d.ts +5 -0
  545. package/esm/typings/src/storage/blackhole/BlackholeStorage.d.ts +33 -0
  546. package/esm/typings/src/storage/env-storage/$EnvStorage.d.ts +40 -0
  547. package/esm/typings/src/storage/file-cache-storage/FileCacheStorage.d.ts +40 -0
  548. package/esm/typings/src/storage/file-cache-storage/FileCacheStorageOptions.d.ts +12 -0
  549. package/esm/typings/src/storage/file-cache-storage/utils/nameToSubfolderPath.d.ts +8 -0
  550. package/esm/typings/src/storage/file-cache-storage/utils/nameToSubfolderPath.test.d.ts +1 -0
  551. package/esm/typings/src/storage/local-storage/getIndexedDbStorage.d.ts +11 -0
  552. package/esm/typings/src/storage/local-storage/getLocalStorage.d.ts +10 -0
  553. package/esm/typings/src/storage/local-storage/getSessionStorage.d.ts +10 -0
  554. package/esm/typings/src/storage/local-storage/utils/IndexedDbStorageOptions.d.ts +14 -0
  555. package/esm/typings/src/storage/local-storage/utils/makePromptbookStorageFromIndexedDb.d.ts +8 -0
  556. package/esm/typings/src/storage/local-storage/utils/makePromptbookStorageFromWebStorage.d.ts +12 -0
  557. package/esm/typings/src/storage/memory/MemoryStorage.d.ts +33 -0
  558. package/esm/typings/src/storage/utils/PrefixStorage.d.ts +25 -0
  559. package/esm/typings/src/types/Arrayable.d.ts +11 -0
  560. package/esm/typings/src/types/IntermediateFilesStrategy.d.ts +8 -0
  561. package/esm/typings/src/types/ModelRequirements.d.ts +104 -0
  562. package/esm/typings/src/types/ModelVariant.d.ts +15 -0
  563. package/esm/typings/src/types/NonEmptyArray.d.ts +8 -0
  564. package/esm/typings/src/types/Prompt.d.ts +111 -0
  565. package/esm/typings/src/types/ScriptLanguage.d.ts +13 -0
  566. package/esm/typings/src/types/SectionType.d.ts +21 -0
  567. package/esm/typings/src/types/TaskType.d.ts +15 -0
  568. package/esm/typings/src/types/typeAliasEmoji.d.ts +12 -0
  569. package/esm/typings/src/types/typeAliases.d.ts +685 -0
  570. package/esm/typings/src/utils/$Register.d.ts +40 -0
  571. package/esm/typings/src/utils/$getCurrentDate.d.ts +10 -0
  572. package/esm/typings/src/utils/FromtoItems.d.ts +19 -0
  573. package/esm/typings/src/utils/arrayableToArray.d.ts +11 -0
  574. package/esm/typings/src/utils/arrayableToArray.test.d.ts +1 -0
  575. package/esm/typings/src/utils/editable/edit-pipeline-string/addPipelineCommand.d.ts +17 -0
  576. package/esm/typings/src/utils/editable/edit-pipeline-string/addPipelineCommand.test.d.ts +1 -0
  577. package/esm/typings/src/utils/editable/edit-pipeline-string/deflatePipeline.d.ts +13 -0
  578. package/esm/typings/src/utils/editable/edit-pipeline-string/deflatePipeline.test.d.ts +1 -0
  579. package/esm/typings/src/utils/editable/edit-pipeline-string/removePipelineCommand.d.ts +22 -0
  580. package/esm/typings/src/utils/editable/edit-pipeline-string/removePipelineCommand.test.d.ts +1 -0
  581. package/esm/typings/src/utils/editable/types/PipelineEditableSerialized.d.ts +27 -0
  582. package/esm/typings/src/utils/editable/utils/isFlatPipeline.d.ts +8 -0
  583. package/esm/typings/src/utils/editable/utils/isFlatPipeline.test.d.ts +1 -0
  584. package/esm/typings/src/utils/editable/utils/renamePipelineParameter.d.ts +29 -0
  585. package/esm/typings/src/utils/editable/utils/renamePipelineParameter.test.d.ts +1 -0
  586. package/esm/typings/src/utils/editable/utils/stringifyPipelineJson.d.ts +16 -0
  587. package/esm/typings/src/utils/emojis.d.ts +24 -0
  588. package/esm/typings/src/utils/environment/$getGlobalScope.d.ts +10 -0
  589. package/esm/typings/src/utils/environment/$isRunningInBrowser.d.ts +11 -0
  590. package/esm/typings/src/utils/environment/$isRunningInJest.d.ts +11 -0
  591. package/esm/typings/src/utils/environment/$isRunningInNode.d.ts +11 -0
  592. package/esm/typings/src/utils/environment/$isRunningInWebWorker.d.ts +11 -0
  593. package/esm/typings/src/utils/execCommand/$execCommand.d.ts +16 -0
  594. package/esm/typings/src/utils/execCommand/$execCommandNormalizeOptions.d.ts +12 -0
  595. package/esm/typings/src/utils/execCommand/$execCommands.d.ts +18 -0
  596. package/esm/typings/src/utils/execCommand/ExecCommandOptions.d.ts +45 -0
  597. package/esm/typings/src/utils/execCommand/execCommand.test.d.ts +1 -0
  598. package/esm/typings/src/utils/execCommand/execCommandNormalizeOptions.test.d.ts +1 -0
  599. package/esm/typings/src/utils/expectation-counters/constants.d.ts +16 -0
  600. package/esm/typings/src/utils/expectation-counters/countCharacters.d.ts +10 -0
  601. package/esm/typings/src/utils/expectation-counters/countCharacters.test.d.ts +1 -0
  602. package/esm/typings/src/utils/expectation-counters/countLines.d.ts +12 -0
  603. package/esm/typings/src/utils/expectation-counters/countLines.test.d.ts +1 -0
  604. package/esm/typings/src/utils/expectation-counters/countPages.d.ts +12 -0
  605. package/esm/typings/src/utils/expectation-counters/countPages.test.d.ts +1 -0
  606. package/esm/typings/src/utils/expectation-counters/countParagraphs.d.ts +10 -0
  607. package/esm/typings/src/utils/expectation-counters/countParagraphs.test.d.ts +1 -0
  608. package/esm/typings/src/utils/expectation-counters/countSentences.d.ts +16 -0
  609. package/esm/typings/src/utils/expectation-counters/countSentences.test.d.ts +1 -0
  610. package/esm/typings/src/utils/expectation-counters/countWords.d.ts +10 -0
  611. package/esm/typings/src/utils/expectation-counters/countWords.test.d.ts +1 -0
  612. package/esm/typings/src/utils/expectation-counters/index.d.ts +12 -0
  613. package/esm/typings/src/utils/files/extensionToMimeType.d.ts +8 -0
  614. package/esm/typings/src/utils/files/extensionToMimeType.test.d.ts +1 -0
  615. package/esm/typings/src/utils/files/getFileExtension.d.ts +8 -0
  616. package/esm/typings/src/utils/files/getFileExtension.test.d.ts +1 -0
  617. package/esm/typings/src/utils/files/isDirectoryExisting.d.ts +14 -0
  618. package/esm/typings/src/utils/files/isDirectoryExisting.test.d.ts +1 -0
  619. package/esm/typings/src/utils/files/isExecutable.d.ts +11 -0
  620. package/esm/typings/src/utils/files/isFileExisting.d.ts +13 -0
  621. package/esm/typings/src/utils/files/isFileExisting.test.d.ts +1 -0
  622. package/esm/typings/src/utils/files/listAllFiles.d.ts +17 -0
  623. package/esm/typings/src/utils/files/listAllFiles.test.d.ts +1 -0
  624. package/esm/typings/src/utils/files/mimeTypeToExtension.d.ts +10 -0
  625. package/esm/typings/src/utils/files/mimeTypeToExtension.test.d.ts +1 -0
  626. package/esm/typings/src/utils/markdown/addAutoGeneratedSection.d.ts +14 -0
  627. package/esm/typings/src/utils/markdown/addAutoGeneratedSection.test.d.ts +1 -0
  628. package/esm/typings/src/utils/markdown/createMarkdownChart.d.ts +38 -0
  629. package/esm/typings/src/utils/markdown/createMarkdownChart.test.d.ts +1 -0
  630. package/esm/typings/src/utils/markdown/createMarkdownTable.d.ts +11 -0
  631. package/esm/typings/src/utils/markdown/createMarkdownTable.test.d.ts +1 -0
  632. package/esm/typings/src/utils/markdown/escapeMarkdownBlock.d.ts +11 -0
  633. package/esm/typings/src/utils/markdown/escapeMarkdownBlock.test.d.ts +1 -0
  634. package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown-real.test.d.ts +1 -0
  635. package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.d.ts +36 -0
  636. package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.test.d.ts +1 -0
  637. package/esm/typings/src/utils/markdown/extractAllListItemsFromMarkdown.d.ts +15 -0
  638. package/esm/typings/src/utils/markdown/extractAllListItemsFromMarkdown.test.d.ts +1 -0
  639. package/esm/typings/src/utils/markdown/extractOneBlockFromMarkdown.d.ts +22 -0
  640. package/esm/typings/src/utils/markdown/extractOneBlockFromMarkdown.test.d.ts +1 -0
  641. package/esm/typings/src/utils/markdown/flattenMarkdown.d.ts +17 -0
  642. package/esm/typings/src/utils/markdown/flattenMarkdown.test.d.ts +1 -0
  643. package/esm/typings/src/utils/markdown/parseMarkdownSection.d.ts +34 -0
  644. package/esm/typings/src/utils/markdown/parseMarkdownSection.test.d.ts +1 -0
  645. package/esm/typings/src/utils/markdown/prettifyMarkdown.d.ts +9 -0
  646. package/esm/typings/src/utils/markdown/prettifyMarkdown.test.d.ts +1 -0
  647. package/esm/typings/src/utils/markdown/removeMarkdownComments.d.ts +10 -0
  648. package/esm/typings/src/utils/markdown/removeMarkdownComments.test.d.ts +1 -0
  649. package/esm/typings/src/utils/markdown/removeMarkdownFormatting.d.ts +9 -0
  650. package/esm/typings/src/utils/markdown/removeMarkdownFormatting.test.d.ts +1 -0
  651. package/esm/typings/src/utils/markdown/splitMarkdownIntoSections.d.ts +15 -0
  652. package/esm/typings/src/utils/markdown/splitMarkdownIntoSections.test.d.ts +1 -0
  653. package/esm/typings/src/utils/normalization/DIACRITIC_VARIANTS_LETTERS.d.ts +12 -0
  654. package/esm/typings/src/utils/normalization/IKeywords.d.ts +21 -0
  655. package/esm/typings/src/utils/normalization/capitalize.d.ts +6 -0
  656. package/esm/typings/src/utils/normalization/capitalize.test.d.ts +1 -0
  657. package/esm/typings/src/utils/normalization/decapitalize.d.ts +6 -0
  658. package/esm/typings/src/utils/normalization/decapitalize.test.d.ts +1 -0
  659. package/esm/typings/src/utils/normalization/isValidKeyword.d.ts +10 -0
  660. package/esm/typings/src/utils/normalization/isValidKeyword.test.d.ts +1 -0
  661. package/esm/typings/src/utils/normalization/nameToUriPart.d.ts +9 -0
  662. package/esm/typings/src/utils/normalization/nameToUriPart.test.d.ts +1 -0
  663. package/esm/typings/src/utils/normalization/nameToUriParts.d.ts +9 -0
  664. package/esm/typings/src/utils/normalization/nameToUriParts.test.d.ts +1 -0
  665. package/esm/typings/src/utils/normalization/normalize-to-kebab-case.d.ts +21 -0
  666. package/esm/typings/src/utils/normalization/normalize-to-kebab-case.test.d.ts +1 -0
  667. package/esm/typings/src/utils/normalization/normalizeTo_PascalCase.d.ts +17 -0
  668. package/esm/typings/src/utils/normalization/normalizeTo_PascalCase.test.d.ts +1 -0
  669. package/esm/typings/src/utils/normalization/normalizeTo_SCREAMING_CASE.d.ts +26 -0
  670. package/esm/typings/src/utils/normalization/normalizeTo_SCREAMING_CASE.test.d.ts +1 -0
  671. package/esm/typings/src/utils/normalization/normalizeTo_camelCase.d.ts +22 -0
  672. package/esm/typings/src/utils/normalization/normalizeTo_camelCase.test.d.ts +1 -0
  673. package/esm/typings/src/utils/normalization/normalizeTo_snake_case.d.ts +17 -0
  674. package/esm/typings/src/utils/normalization/normalizeTo_snake_case.test.d.ts +1 -0
  675. package/esm/typings/src/utils/normalization/normalizeWhitespaces.d.ts +6 -0
  676. package/esm/typings/src/utils/normalization/normalizeWhitespaces.test.d.ts +1 -0
  677. package/esm/typings/src/utils/normalization/orderJson.d.ts +21 -0
  678. package/esm/typings/src/utils/normalization/orderJson.test.d.ts +4 -0
  679. package/esm/typings/src/utils/normalization/parseKeywords.d.ts +16 -0
  680. package/esm/typings/src/utils/normalization/parseKeywords.test.d.ts +1 -0
  681. package/esm/typings/src/utils/normalization/parseKeywordsFromString.d.ts +9 -0
  682. package/esm/typings/src/utils/normalization/parseKeywordsFromString.test.d.ts +1 -0
  683. package/esm/typings/src/utils/normalization/removeDiacritics.d.ts +11 -0
  684. package/esm/typings/src/utils/normalization/removeDiacritics.test.d.ts +1 -0
  685. package/esm/typings/src/utils/normalization/searchKeywords.d.ts +13 -0
  686. package/esm/typings/src/utils/normalization/searchKeywords.test.d.ts +1 -0
  687. package/esm/typings/src/utils/normalization/suffixUrl.d.ts +7 -0
  688. package/esm/typings/src/utils/normalization/suffixUrl.test.d.ts +1 -0
  689. package/esm/typings/src/utils/normalization/titleToName.d.ts +9 -0
  690. package/esm/typings/src/utils/normalization/titleToName.test.d.ts +1 -0
  691. package/esm/typings/src/utils/organization/$sideEffect.d.ts +9 -0
  692. package/esm/typings/src/utils/organization/TODO_USE.d.ts +12 -0
  693. package/esm/typings/src/utils/organization/TODO_any.d.ts +6 -0
  694. package/esm/typings/src/utils/organization/TODO_narrow.d.ts +6 -0
  695. package/esm/typings/src/utils/organization/TODO_object.d.ts +6 -0
  696. package/esm/typings/src/utils/organization/TODO_remove_as.d.ts +6 -0
  697. package/esm/typings/src/utils/organization/TODO_string.d.ts +6 -0
  698. package/esm/typings/src/utils/organization/TODO_unknown.d.ts +6 -0
  699. package/esm/typings/src/utils/organization/___and___.d.ts +7 -0
  700. package/esm/typings/src/utils/organization/___or___.d.ts +6 -0
  701. package/esm/typings/src/utils/organization/empty_object.d.ts +10 -0
  702. package/esm/typings/src/utils/organization/just.d.ts +14 -0
  703. package/esm/typings/src/utils/organization/just_empty_object.d.ts +12 -0
  704. package/esm/typings/src/utils/organization/keepTypeImported.d.ts +9 -0
  705. package/esm/typings/src/utils/organization/keepUnused.d.ts +16 -0
  706. package/esm/typings/src/utils/organization/really_any.d.ts +6 -0
  707. package/esm/typings/src/utils/organization/really_unknown.d.ts +6 -0
  708. package/esm/typings/src/utils/organization/spaceTrim.d.ts +11 -0
  709. package/esm/typings/src/utils/parameters/extractParameterNames.d.ts +10 -0
  710. package/esm/typings/src/utils/parameters/extractParameterNames.test.d.ts +1 -0
  711. package/esm/typings/src/utils/parameters/mapAvailableToExpectedParameters.d.ts +27 -0
  712. package/esm/typings/src/utils/parameters/mapAvailableToExpectedParameters.test.d.ts +1 -0
  713. package/esm/typings/src/utils/parameters/numberToString.d.ts +7 -0
  714. package/esm/typings/src/utils/parameters/numberToString.test.d.ts +1 -0
  715. package/esm/typings/src/utils/parameters/templateParameters.d.ts +16 -0
  716. package/esm/typings/src/utils/parameters/templateParameters.test.d.ts +1 -0
  717. package/esm/typings/src/utils/parameters/valueToString.d.ts +17 -0
  718. package/esm/typings/src/utils/parameters/valueToString.test.d.ts +1 -0
  719. package/esm/typings/src/utils/parseNumber.d.ts +16 -0
  720. package/esm/typings/src/utils/parseNumber.test.d.ts +1 -0
  721. package/esm/typings/src/utils/random/$randomSeed.d.ts +10 -0
  722. package/esm/typings/src/utils/random/$randomToken.d.ts +13 -0
  723. package/esm/typings/src/utils/removeEmojis.d.ts +8 -0
  724. package/esm/typings/src/utils/removeEmojis.test.d.ts +1 -0
  725. package/esm/typings/src/utils/removeQuotes.d.ts +14 -0
  726. package/esm/typings/src/utils/removeQuotes.test.d.ts +1 -0
  727. package/esm/typings/src/utils/serialization/$deepFreeze.d.ts +14 -0
  728. package/esm/typings/src/utils/serialization/asSerializable.d.ts +15 -0
  729. package/esm/typings/src/utils/serialization/asSerializable.test.d.ts +1 -0
  730. package/esm/typings/src/utils/serialization/checkSerializableAsJson.d.ts +45 -0
  731. package/esm/typings/src/utils/serialization/clonePipeline.d.ts +14 -0
  732. package/esm/typings/src/utils/serialization/deepClone.d.ts +14 -0
  733. package/esm/typings/src/utils/serialization/deepClone.test.d.ts +1 -0
  734. package/esm/typings/src/utils/serialization/exportJson.d.ts +29 -0
  735. package/esm/typings/src/utils/serialization/isSerializableAsJson.d.ts +25 -0
  736. package/esm/typings/src/utils/serialization/isSerializableAsJson.test.d.ts +1 -0
  737. package/esm/typings/src/utils/serialization/jsonStringsToJsons.d.ts +9 -0
  738. package/esm/typings/src/utils/serialization/jsonStringsToJsons.test.d.ts +1 -0
  739. package/esm/typings/src/utils/sets/difference.d.ts +10 -0
  740. package/esm/typings/src/utils/sets/difference.test.d.ts +1 -0
  741. package/esm/typings/src/utils/sets/intersection.d.ts +7 -0
  742. package/esm/typings/src/utils/sets/intersection.test.d.ts +1 -0
  743. package/esm/typings/src/utils/sets/union.d.ts +7 -0
  744. package/esm/typings/src/utils/sets/union.test.d.ts +1 -0
  745. package/esm/typings/src/utils/trimCodeBlock.d.ts +9 -0
  746. package/esm/typings/src/utils/trimCodeBlock.test.d.ts +1 -0
  747. package/esm/typings/src/utils/trimEndOfCodeBlock.d.ts +9 -0
  748. package/esm/typings/src/utils/trimEndOfCodeBlock.test.d.ts +1 -0
  749. package/esm/typings/src/utils/unwrapResult.d.ts +37 -0
  750. package/esm/typings/src/utils/unwrapResult.test.d.ts +1 -0
  751. package/esm/typings/src/utils/validators/email/isValidEmail.d.ts +8 -0
  752. package/esm/typings/src/utils/validators/email/isValidEmail.test.d.ts +1 -0
  753. package/esm/typings/src/utils/validators/filePath/isRootPath.d.ts +12 -0
  754. package/esm/typings/src/utils/validators/filePath/isRootPath.test.d.ts +4 -0
  755. package/esm/typings/src/utils/validators/filePath/isValidFilePath.d.ts +12 -0
  756. package/esm/typings/src/utils/validators/filePath/isValidFilePath.test.d.ts +1 -0
  757. package/esm/typings/src/utils/validators/javascriptName/isValidJavascriptName.d.ts +10 -0
  758. package/esm/typings/src/utils/validators/javascriptName/isValidJavascriptName.test.d.ts +1 -0
  759. package/esm/typings/src/utils/validators/parameterName/validateParameterName.d.ts +11 -0
  760. package/esm/typings/src/utils/validators/parameterName/validateParameterName.test.d.ts +1 -0
  761. package/esm/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.d.ts +15 -0
  762. package/esm/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.test.d.ts +1 -0
  763. package/esm/typings/src/utils/validators/semanticVersion/isValidSemanticVersion.d.ts +12 -0
  764. package/esm/typings/src/utils/validators/semanticVersion/isValidSemanticVersion.test.d.ts +1 -0
  765. package/esm/typings/src/utils/validators/url/isHostnameOnPrivateNetwork.d.ts +11 -0
  766. package/esm/typings/src/utils/validators/url/isHostnameOnPrivateNetwork.test.d.ts +1 -0
  767. package/esm/typings/src/utils/validators/url/isUrlOnPrivateNetwork.d.ts +13 -0
  768. package/esm/typings/src/utils/validators/url/isUrlOnPrivateNetwork.test.d.ts +1 -0
  769. package/esm/typings/src/utils/validators/url/isValidPipelineUrl.d.ts +15 -0
  770. package/esm/typings/src/utils/validators/url/isValidPipelineUrl.test.d.ts +1 -0
  771. package/esm/typings/src/utils/validators/url/isValidUrl.d.ts +13 -0
  772. package/esm/typings/src/utils/validators/url/isValidUrl.test.d.ts +1 -0
  773. package/esm/typings/src/utils/validators/uuid/isValidUuid.d.ts +8 -0
  774. package/esm/typings/src/utils/validators/uuid/isValidUuid.test.d.ts +1 -0
  775. package/esm/typings/src/version.d.ts +26 -0
  776. package/esm/typings/src/wizard/$getCompiledBook.d.ts +16 -0
  777. package/esm/typings/src/wizard/wizard.d.ts +78 -0
  778. package/package.json +100 -0
  779. package/umd/index.umd.js +1965 -0
  780. package/umd/index.umd.js.map +1 -0
@@ -0,0 +1,25 @@
1
+ import type { number_percent } from '../../types/typeAliases';
2
+ /**
3
+ * Options for `executionReportJsonToString`
4
+ *
5
+ * @public exported from `@promptbook/core`
6
+ */
7
+ export type ExecutionReportStringOptions = {
8
+ /**
9
+ * The tax rate to be applied, expressed as a percentage from 0 to 1 (=100%) or even more
10
+ */
11
+ readonly taxRate: number_percent;
12
+ /**
13
+ * The width of the charts in the report
14
+ */
15
+ readonly chartsWidth: number;
16
+ };
17
+ /**
18
+ * Default options for generating an execution report string
19
+ *
20
+ * @public exported from `@promptbook/core`
21
+ */
22
+ export declare const ExecutionReportStringOptionsDefaults: {
23
+ taxRate: number;
24
+ chartsWidth: number;
25
+ };
@@ -0,0 +1,7 @@
1
+ import type { FromtoItems } from '../../utils/FromtoItems';
2
+ /**
3
+ * Count the duration of working time
4
+ *
5
+ * @private within the repository
6
+ */
7
+ export declare function countWorkingDuration(items: FromtoItems): number;
@@ -0,0 +1,15 @@
1
+ import type { ReadonlyDeep } from 'type-fest';
2
+ import type { ExecutionReportJson } from './ExecutionReportJson';
3
+ import type { ExecutionReportString } from './ExecutionReportString';
4
+ import type { ExecutionReportStringOptions } from './ExecutionReportStringOptions';
5
+ /**
6
+ * Converts execution report from JSON to string format
7
+ *
8
+ * @public exported from `@promptbook/core`
9
+ */
10
+ export declare function executionReportJsonToString(executionReportJson: ReadonlyDeep<ExecutionReportJson>, options?: Partial<ExecutionReportStringOptions>): ExecutionReportString;
11
+ /**
12
+ * TODO: Add mermaid chart for every report
13
+ * TODO: [🧠] Allow to filter out some parts of the report by options
14
+ * TODO: [🧠] Should be in generated file GENERATOR_WARNING
15
+ */
@@ -0,0 +1,7 @@
1
+ import type { Promisable } from 'type-fest';
2
+ /**
3
+ * @private still in development [🏳]
4
+ */
5
+ export type AutomaticTranslator = {
6
+ translate(message: string): Promisable<string>;
7
+ };
@@ -0,0 +1,11 @@
1
+ import type { AutomaticTranslator } from './AutomaticTranslator';
2
+ /**
3
+ * This will wrap an automatic translator and log each translation into the console
4
+ *
5
+ * @private still in development [🏳]
6
+ */
7
+ export declare class DebugAutomaticTranslator implements AutomaticTranslator {
8
+ private readonly automaticTranslator;
9
+ constructor(automaticTranslator: AutomaticTranslator);
10
+ translate(message: string): Promise<string>;
11
+ }
@@ -0,0 +1,8 @@
1
+ import type { AutomaticTranslator } from './AutomaticTranslator';
2
+ /**
3
+ * @private still in development [🏳]
4
+ */
5
+ export declare class FakeAutomaticTranslator implements AutomaticTranslator {
6
+ constructor();
7
+ translate(message: string): string;
8
+ }
@@ -0,0 +1,22 @@
1
+ import type { AutomaticTranslator } from './AutomaticTranslator';
2
+ import type { TranslatorOptions } from './TranslatorOptions';
3
+ /**
4
+ * Options for configuring the Lindat automatic translator, including API URL and language settings.
5
+ */
6
+ type LindatAutomaticTranslatorOptions = TranslatorOptions & {
7
+ /**
8
+ * Optional URL of the Lindat translation API endpoint.
9
+ */
10
+ readonly apiUrl?: URL;
11
+ };
12
+ /**
13
+ * Automatic translator implementation using the Lindat translation API.
14
+ *
15
+ * @private still in development [🏳️]
16
+ */
17
+ export declare class LindatAutomaticTranslator implements AutomaticTranslator {
18
+ protected readonly options: LindatAutomaticTranslatorOptions;
19
+ constructor(options: LindatAutomaticTranslatorOptions);
20
+ translate(message: string): Promise<string>;
21
+ }
22
+ export {};
@@ -0,0 +1,7 @@
1
+ /**
2
+ * @private still in development [🏳]
3
+ */
4
+ export type TranslatorOptions = {
5
+ readonly from?: string;
6
+ readonly to: string;
7
+ };
@@ -0,0 +1,8 @@
1
+ /**
2
+ *
3
+ * @param message
4
+ * @returns
5
+ * @throws {PipelineExecutionError}
6
+ * @private still in development [🏳]
7
+ */
8
+ export declare function extractMultiplicatedOccurrence(message: string): string;
@@ -0,0 +1,12 @@
1
+ import type { AutomaticTranslator } from './automatic-translators/AutomaticTranslator';
2
+ import type { TranslatorOptions } from './automatic-translators/TranslatorOptions';
3
+ /**
4
+ * @private still in development [🏳]
5
+ */
6
+ export declare function translateMessages({ automaticTranslator, from, to, }: {
7
+ automaticTranslator: AutomaticTranslator;
8
+ } & TranslatorOptions): Promise<void>;
9
+ /**
10
+ * TODO: [😶] Unite folder listing
11
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
12
+ */
@@ -0,0 +1,13 @@
1
+ import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
2
+ import type { ExecutionTools } from '../ExecutionTools';
3
+ /**
4
+ * Note: There is unfortunately no equivalent for this function in the browser environment
5
+ * because it is not possible automatically detect configured LLM providers
6
+ * you need to provide them manually BUT you can help by utilities like `$provideScrapersForBrowser`
7
+ *
8
+ * @public exported from `@promptbook/node`
9
+ */
10
+ export declare function $provideExecutionToolsForNode(options?: PrepareAndScrapeOptions): Promise<ExecutionTools>;
11
+ /**
12
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
13
+ */
@@ -0,0 +1,9 @@
1
+ import type { Usage } from '../Usage';
2
+ /**
3
+ * Function `addUsage` will add multiple usages into one
4
+ *
5
+ * Note: If you provide 0 values, it returns ZERO_USAGE
6
+ *
7
+ * @public exported from `@promptbook/core`
8
+ */
9
+ export declare function addUsage(...usageItems: ReadonlyArray<Usage>): Usage;
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,29 @@
1
+ import type { Expectations } from '../../pipeline/PipelineJson/Expectations';
2
+ /**
3
+ * Function checkExpectations will check if the expectations on given value are met
4
+ *
5
+ * Note: There are two similar functions:
6
+ * - `checkExpectations` which throws an error if the expectations are not met
7
+ * - `isPassingExpectations` which returns a boolean
8
+ *
9
+ * @throws {ExpectError} if the expectations are not met
10
+ * @returns {void} Nothing
11
+ * @private internal function of `createPipelineExecutor`
12
+ */
13
+ export declare function checkExpectations(expectations: Expectations, value: string): void;
14
+ /**
15
+ * Function checkExpectations will check if the expectations on given value are met
16
+ *
17
+ * Note: There are two similar functions:
18
+ * - `checkExpectations` which throws an error if the expectations are not met
19
+ * - `isPassingExpectations` which returns a boolean
20
+ *
21
+ * @returns {boolean} True if the expectations are met
22
+ * @public exported from `@promptbook/core`
23
+ */
24
+ export declare function isPassingExpectations(expectations: Expectations, value: string): boolean;
25
+ /**
26
+ * TODO: [💝] Unite object for expecting amount and format
27
+ * TODO: [🧠][🤠] This should be part of `TextFormatParser`
28
+ * Note: [💝] and [🤠] are interconnected together
29
+ */
@@ -0,0 +1,10 @@
1
+ import type { UsageCounts } from '../Usage';
2
+ /**
3
+ * Helper of usage compute
4
+ *
5
+ * @param content the content of prompt or response
6
+ * @returns part of UsageCounts
7
+ *
8
+ * @private internal utility of LlmExecutionTools
9
+ */
10
+ export declare function computeUsageCounts(content: string): Omit<UsageCounts, 'tokensCount'>;
@@ -0,0 +1,20 @@
1
+ import type { Promisable } from 'type-fest';
2
+ type ForEachAsyncOptions = {
3
+ /**
4
+ * Maximum number of tasks running in parallel
5
+ *
6
+ * @default Infinity
7
+ */
8
+ readonly maxParallelCount?: number;
9
+ };
10
+ /**
11
+ * Async version of Array.forEach
12
+ *
13
+ * @param array - Array to iterate over
14
+ * @param options - Options for the function
15
+ * @param callbackfunction - Function to call for each item
16
+ * @public exported from `@promptbook/utils`
17
+ * @deprecated [🪂] Use queues instead
18
+ */
19
+ export declare function forEachAsync<TItem>(array: ReadonlyArray<TItem>, options: ForEachAsyncOptions, callbackfunction: (value: TItem, index: number, array: ReadonlyArray<TItem>) => Promisable<void>): Promise<void>;
20
+ export {};
@@ -0,0 +1,10 @@
1
+ import type { UncertainNumber } from '../UncertainNumber';
2
+ /**
3
+ * Make UncertainNumber
4
+ *
5
+ * @param value value of the uncertain number, if `NaN` or `undefined`, it will be set to 0 and `isUncertain=true`
6
+ * @param isUncertain if `true`, the value is uncertain, otherwise depends on the value
7
+ *
8
+ * @private utility for initializating UncertainNumber
9
+ */
10
+ export declare function uncertainNumber(value?: number | typeof NaN | undefined | null, isUncertain?: boolean): UncertainNumber;
@@ -0,0 +1,147 @@
1
+ /**
2
+ * Represents the uncertain value
3
+ *
4
+ * @public exported from `@promptbook/core`
5
+ */
6
+ export declare const ZERO_VALUE: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
7
+ readonly value: 0;
8
+ }>;
9
+ /**
10
+ * Represents the uncertain value
11
+ *
12
+ * @public exported from `@promptbook/core`
13
+ */
14
+ export declare const UNCERTAIN_ZERO_VALUE: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
15
+ readonly value: 0;
16
+ readonly isUncertain: true;
17
+ }>;
18
+ /**
19
+ * Represents the usage with no resources consumed
20
+ *
21
+ * @public exported from `@promptbook/core`
22
+ */
23
+ export declare const ZERO_USAGE: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
24
+ readonly price: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
25
+ readonly value: 0;
26
+ }>;
27
+ readonly input: {
28
+ readonly tokensCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
29
+ readonly value: 0;
30
+ }>;
31
+ readonly charactersCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
32
+ readonly value: 0;
33
+ }>;
34
+ readonly wordsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
35
+ readonly value: 0;
36
+ }>;
37
+ readonly sentencesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
38
+ readonly value: 0;
39
+ }>;
40
+ readonly linesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
41
+ readonly value: 0;
42
+ }>;
43
+ readonly paragraphsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
44
+ readonly value: 0;
45
+ }>;
46
+ readonly pagesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
47
+ readonly value: 0;
48
+ }>;
49
+ };
50
+ readonly output: {
51
+ readonly tokensCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
52
+ readonly value: 0;
53
+ }>;
54
+ readonly charactersCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
55
+ readonly value: 0;
56
+ }>;
57
+ readonly wordsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
58
+ readonly value: 0;
59
+ }>;
60
+ readonly sentencesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
61
+ readonly value: 0;
62
+ }>;
63
+ readonly linesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
64
+ readonly value: 0;
65
+ }>;
66
+ readonly paragraphsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
67
+ readonly value: 0;
68
+ }>;
69
+ readonly pagesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
70
+ readonly value: 0;
71
+ }>;
72
+ };
73
+ }>;
74
+ /**
75
+ * Represents the usage with unknown resources consumed
76
+ *
77
+ * @public exported from `@promptbook/core`
78
+ */
79
+ export declare const UNCERTAIN_USAGE: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
80
+ readonly price: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
81
+ readonly value: 0;
82
+ readonly isUncertain: true;
83
+ }>;
84
+ readonly input: {
85
+ readonly tokensCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
86
+ readonly value: 0;
87
+ readonly isUncertain: true;
88
+ }>;
89
+ readonly charactersCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
90
+ readonly value: 0;
91
+ readonly isUncertain: true;
92
+ }>;
93
+ readonly wordsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
94
+ readonly value: 0;
95
+ readonly isUncertain: true;
96
+ }>;
97
+ readonly sentencesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
98
+ readonly value: 0;
99
+ readonly isUncertain: true;
100
+ }>;
101
+ readonly linesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
102
+ readonly value: 0;
103
+ readonly isUncertain: true;
104
+ }>;
105
+ readonly paragraphsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
106
+ readonly value: 0;
107
+ readonly isUncertain: true;
108
+ }>;
109
+ readonly pagesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
110
+ readonly value: 0;
111
+ readonly isUncertain: true;
112
+ }>;
113
+ };
114
+ readonly output: {
115
+ readonly tokensCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
116
+ readonly value: 0;
117
+ readonly isUncertain: true;
118
+ }>;
119
+ readonly charactersCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
120
+ readonly value: 0;
121
+ readonly isUncertain: true;
122
+ }>;
123
+ readonly wordsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
124
+ readonly value: 0;
125
+ readonly isUncertain: true;
126
+ }>;
127
+ readonly sentencesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
128
+ readonly value: 0;
129
+ readonly isUncertain: true;
130
+ }>;
131
+ readonly linesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
132
+ readonly value: 0;
133
+ readonly isUncertain: true;
134
+ }>;
135
+ readonly paragraphsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
136
+ readonly value: 0;
137
+ readonly isUncertain: true;
138
+ }>;
139
+ readonly pagesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
140
+ readonly value: 0;
141
+ readonly isUncertain: true;
142
+ }>;
143
+ };
144
+ }>;
145
+ /**
146
+ * Note: [💞] Ignore a discrepancy between file name and entity name
147
+ */
@@ -0,0 +1,26 @@
1
+ import type { string_markdown } from '../../types/typeAliases';
2
+ import type { UncertainNumber } from '../UncertainNumber';
3
+ import type { Usage } from '../Usage';
4
+ /**
5
+ * Minimal usage information required to calculate worktime
6
+ */
7
+ type PartialUsage = Partial<Usage> & {
8
+ price: UncertainNumber;
9
+ input: Pick<Usage['input'], 'wordsCount'>;
10
+ output: Pick<Usage['output'], 'wordsCount' | 'charactersCount'>;
11
+ };
12
+ /**
13
+ * Function `usageToHuman` will take usage and convert it to human readable report
14
+ *
15
+ * @public exported from `@promptbook/core`
16
+ */
17
+ export declare function usageToHuman(usage: PartialUsage): string_markdown;
18
+ export {};
19
+ /**
20
+ * TODO: [🍓][🧞‍♂️] Use "$1" not "1 USD"
21
+ * TODO: [🍓][🧞‍♂️] Use markdown formatting like "Cost approximately **$1**"
22
+ * TODO: [🍓][🧞‍♂️] Report in minutes, seconds, days NOT 0.1 hours
23
+ * TODO: [🧠] Maybe make from `uncertainNumberToHuman` separate exported utility
24
+ * TODO: [🧠] Maybe use "~" instead of "approximately"
25
+ * TODO: [🏛] Maybe make some markdown builder
26
+ */
@@ -0,0 +1,20 @@
1
+ import type { UncertainNumber } from '../UncertainNumber';
2
+ import type { Usage } from '../Usage';
3
+ /**
4
+ * Minimal usage information required to calculate worktime
5
+ */
6
+ type PartialUsage = Pick<Usage, 'input' | 'output'> & {
7
+ input: Pick<Usage['input'], 'wordsCount'>;
8
+ output: Pick<Usage['output'], 'wordsCount'>;
9
+ };
10
+ /**
11
+ * Function usageToWorktime will take usage and estimate saved worktime in hours of reading / writing
12
+ *
13
+ * Note: This is an estimate based of these sources:
14
+ * - https://jecas.cz/doba-cteni
15
+ * - https://www.originalnitonery.cz/blog/psani-vsemi-deseti-se-muzete-naucit-i-sami-doma
16
+ *
17
+ * @public exported from `@promptbook/core`
18
+ */
19
+ export declare function usageToWorktime(usage: PartialUsage): UncertainNumber;
20
+ export {};
@@ -0,0 +1,53 @@
1
+ import type { FormatCommand } from '../../commands/FORMAT/FormatCommand';
2
+ import { ExpectError } from '../../errors/ExpectError';
3
+ import type { Expectations } from '../../pipeline/PipelineJson/Expectations';
4
+ import type { string_postprocessing_function_name } from '../../types/typeAliases';
5
+ /**
6
+ * Options for validating a prompt result
7
+ */
8
+ export interface ValidatePromptResultOptions {
9
+ /**
10
+ * The result string to validate
11
+ */
12
+ resultString: string;
13
+ /**
14
+ * Expectations for the result (word count, sentence count, etc.)
15
+ */
16
+ expectations?: Expectations;
17
+ /**
18
+ * Expected format of the result (e.g., 'JSON')
19
+ */
20
+ format?: FormatCommand['format'];
21
+ /**
22
+ * List of postprocessing function names that should be applied
23
+ * Note: This is for validation purposes only - postprocessing should be done before calling this function
24
+ */
25
+ postprocessingFunctionNames?: ReadonlyArray<string_postprocessing_function_name>;
26
+ }
27
+ /**
28
+ * Result of prompt result validation
29
+ */
30
+ export interface ValidatePromptResultResult {
31
+ /**
32
+ * Whether the result is valid (passes all expectations and format checks)
33
+ */
34
+ isValid: boolean;
35
+ /**
36
+ * The processed result string (may be modified if format extraction was needed)
37
+ */
38
+ processedResultString: string;
39
+ /**
40
+ * Error that occurred during validation, if any
41
+ */
42
+ error?: ExpectError;
43
+ }
44
+ /**
45
+ * Validates a prompt result against expectations and format requirements.
46
+ * This function provides a common abstraction for result validation that can be used
47
+ * by both execution logic and caching logic to ensure consistency.
48
+ *
49
+ * @param options - The validation options including result string, expectations, and format
50
+ * @returns Validation result with processed string and validity status
51
+ * @private internal function of `createPipelineExecutor` and `cacheLlmTools`
52
+ */
53
+ export declare function validatePromptResult(options: ValidatePromptResultOptions): ValidatePromptResultResult;
@@ -0,0 +1,10 @@
1
+ import type { PromptbookFetch } from '../../execution/PromptbookFetch';
2
+ import type { string_name } from '../../types/typeAliases';
3
+ /**
4
+ * @private still in development
5
+ */
6
+ export declare function isDomainNameFree(name: string_name, fetch: PromptbookFetch): Promise<boolean>;
7
+ /**
8
+ * TODO: [🍓][🧠] Test and implement `isDomainNameFree`
9
+ * TODO: Export via some (and probably new) NPM package
10
+ */
@@ -0,0 +1,10 @@
1
+ import type { PromptbookFetch } from '../../execution/PromptbookFetch';
2
+ import type { string_name } from '../../types/typeAliases';
3
+ /**
4
+ * @private still in development
5
+ */
6
+ export declare function isGithubNameFree(name: string_name, fetch: PromptbookFetch): Promise<boolean>;
7
+ /**
8
+ * TODO: [🍓][🧠] Test and implement `isGithubNameFree`
9
+ * TODO: Export via some (and probably new) NPM package
10
+ */
@@ -0,0 +1,72 @@
1
+ import type { string_mime_type } from '../../types/typeAliases';
2
+ import type { string_name } from '../../types/typeAliases';
3
+ import type { string_SCREAMING_CASE } from '../../utils/normalization/normalizeTo_SCREAMING_CASE';
4
+ import type { empty_object } from '../../utils/organization/empty_object';
5
+ import type { FormatSubvalueParser } from './FormatSubvalueParser';
6
+ /**
7
+ * A format definition is a set of functions that define how to validate, heal and convert response from LLM.
8
+ *
9
+ * @remarks
10
+ * - "settings" are runtime options that affect parsing (e.g., delimiter for CSV).
11
+ * - "schema" is a structural definition or contract for the data (e.g., expected fields in JSON).
12
+ *
13
+ * @see https://github.com/webgptorg/promptbook/discussions/36
14
+ * @private still in development [🏢]
15
+ */
16
+ export type FormatParser<TValue extends TPartialValue, TPartialValue extends string, TSettings extends empty_object, TSchema extends empty_object> = {
17
+ /**
18
+ * The name of the format used in .book.md files
19
+ *
20
+ * @example "JSON"
21
+ */
22
+ readonly formatName: string_name & string_SCREAMING_CASE;
23
+ /**
24
+ * Aliases for the `formatName`
25
+ */
26
+ readonly aliases?: ReadonlyArray<string_name & string_SCREAMING_CASE>;
27
+ /**
28
+ * The mime type of the format (if any)
29
+ *
30
+ * @example "application/json"
31
+ */
32
+ readonly mimeType?: string_mime_type;
33
+ /**
34
+ * Check if a value is fully valid
35
+ *
36
+ * @param value The value to check, for example "{\"foo\": true}"
37
+ * @param schema Optional schema to do extra validation
38
+ */
39
+ isValid(value: string, settings?: TSettings, schema?: TSchema): value is TValue;
40
+ /**
41
+ * Check if a first part of a value is valid
42
+ *
43
+ * @see https://github.com/webgptorg/promptbook/discussions/37
44
+ *
45
+ * @param partialValue Partial value to check, for example "{\"foo\": t"
46
+ * @param schema Optional schema to do extra validation
47
+ */
48
+ canBeValid(partialValue: string, settings?: TSettings, schema?: TSchema): partialValue is TPartialValue;
49
+ /**
50
+ * Heal a value to make it valid if possible
51
+ *
52
+ * Note: This make sense in context of LLMs that often returns slightly invalid values
53
+ * @see https://github.com/webgptorg/promptbook/discussions/31
54
+ *
55
+ * @param value The value to heal, for example "{foo: true}"
56
+ * @param scheme
57
+ * @throws {Error} If the value cannot be healed
58
+ */
59
+ heal(value: string, settings?: TSettings, scheme?: TSchema): TValue;
60
+ /**
61
+ * Parsers for extracting or mapping subvalues from the main value (e.g., rows from CSV, items from JSON array).
62
+ */
63
+ readonly subvalueParsers: ReadonlyArray<FormatSubvalueParser<TValue, TSettings>>;
64
+ };
65
+ /**
66
+ * TODO: [♏] Add some prepare hook to modify prompt according to the format
67
+ * TODO: [🍓]`name` and `aliases` should be UPPERCASE only and interpreted as case-insensitive (via normalization)
68
+ * TODO: [🍓][👨‍⚖️] Compute TPartialValue dynamically - PartialString<TValue>
69
+ * TODO: [🍓][🧠] Should execution tools be available to heal, canBeValid and isValid?
70
+ * TODO: [🍓][🧠] llm Provider Bindings
71
+ * TODO: [🍓][🔼] Export via some package
72
+ */