@promptbook/wizard 0.95.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (738) hide show
  1. package/README.md +482 -0
  2. package/esm/index.es.js +16649 -0
  3. package/esm/index.es.js.map +1 -0
  4. package/esm/typings/books/index.d.ts +131 -0
  5. package/esm/typings/servers.d.ts +40 -0
  6. package/esm/typings/src/_packages/anthropic-claude.index.d.ts +16 -0
  7. package/esm/typings/src/_packages/azure-openai.index.d.ts +10 -0
  8. package/esm/typings/src/_packages/browser.index.d.ts +12 -0
  9. package/esm/typings/src/_packages/cli.index.d.ts +60 -0
  10. package/esm/typings/src/_packages/core.index.d.ts +296 -0
  11. package/esm/typings/src/_packages/deepseek.index.d.ts +10 -0
  12. package/esm/typings/src/_packages/documents.index.d.ts +8 -0
  13. package/esm/typings/src/_packages/editable.index.d.ts +90 -0
  14. package/esm/typings/src/_packages/fake-llm.index.d.ts +6 -0
  15. package/esm/typings/src/_packages/google.index.d.ts +12 -0
  16. package/esm/typings/src/_packages/javascript.index.d.ts +10 -0
  17. package/esm/typings/src/_packages/legacy-documents.index.d.ts +8 -0
  18. package/esm/typings/src/_packages/markdown-utils.index.d.ts +48 -0
  19. package/esm/typings/src/_packages/markitdown.index.d.ts +8 -0
  20. package/esm/typings/src/_packages/node.index.d.ts +24 -0
  21. package/esm/typings/src/_packages/ollama.index.d.ts +14 -0
  22. package/esm/typings/src/_packages/openai.index.d.ts +22 -0
  23. package/esm/typings/src/_packages/pdf.index.d.ts +14 -0
  24. package/esm/typings/src/_packages/remote-client.index.d.ts +16 -0
  25. package/esm/typings/src/_packages/remote-server.index.d.ts +12 -0
  26. package/esm/typings/src/_packages/templates.index.d.ts +4 -0
  27. package/esm/typings/src/_packages/types.index.d.ts +598 -0
  28. package/esm/typings/src/_packages/utils.index.d.ts +170 -0
  29. package/esm/typings/src/_packages/vercel.index.d.ts +6 -0
  30. package/esm/typings/src/_packages/website-crawler.index.d.ts +8 -0
  31. package/esm/typings/src/_packages/wizard.index.d.ts +60 -0
  32. package/esm/typings/src/cli/cli-commands/_boilerplate.d.ts +13 -0
  33. package/esm/typings/src/cli/cli-commands/about.d.ts +14 -0
  34. package/esm/typings/src/cli/cli-commands/common/handleActionErrors.d.ts +11 -0
  35. package/esm/typings/src/cli/cli-commands/hello.d.ts +14 -0
  36. package/esm/typings/src/cli/cli-commands/list-models.d.ts +13 -0
  37. package/esm/typings/src/cli/cli-commands/list-scrapers.d.ts +13 -0
  38. package/esm/typings/src/cli/cli-commands/login.d.ts +14 -0
  39. package/esm/typings/src/cli/cli-commands/make.d.ts +16 -0
  40. package/esm/typings/src/cli/cli-commands/prettify.d.ts +15 -0
  41. package/esm/typings/src/cli/cli-commands/run.d.ts +17 -0
  42. package/esm/typings/src/cli/cli-commands/runInteractiveChatbot.d.ts +32 -0
  43. package/esm/typings/src/cli/cli-commands/start-server.d.ts +13 -0
  44. package/esm/typings/src/cli/cli-commands/test-command.d.ts +16 -0
  45. package/esm/typings/src/cli/common/$addGlobalOptionsToCommand.d.ts +7 -0
  46. package/esm/typings/src/cli/common/$provideLlmToolsForCli.d.ts +28 -0
  47. package/esm/typings/src/cli/main.d.ts +16 -0
  48. package/esm/typings/src/cli/promptbookCli.d.ts +13 -0
  49. package/esm/typings/src/cli/test/ptbk.d.ts +5 -0
  50. package/esm/typings/src/cli/test/ptbk.test.d.ts +1 -0
  51. package/esm/typings/src/collection/PipelineCollection.d.ts +25 -0
  52. package/esm/typings/src/collection/SimplePipelineCollection.d.ts +37 -0
  53. package/esm/typings/src/collection/collectionToJson.d.ts +13 -0
  54. package/esm/typings/src/collection/collectionToJson.test.d.ts +7 -0
  55. package/esm/typings/src/collection/constructors/createCollectionFromDirectory.d.ts +65 -0
  56. package/esm/typings/src/collection/constructors/createCollectionFromDirectory.test.d.ts +1 -0
  57. package/esm/typings/src/collection/constructors/createCollectionFromJson.d.ts +13 -0
  58. package/esm/typings/src/collection/constructors/createCollectionFromJson.test.d.ts +1 -0
  59. package/esm/typings/src/collection/constructors/createCollectionFromPromise.d.ts +23 -0
  60. package/esm/typings/src/collection/constructors/createCollectionFromPromise.test.d.ts +1 -0
  61. package/esm/typings/src/collection/constructors/createCollectionFromUrl.d.ts +29 -0
  62. package/esm/typings/src/collection/constructors/createSubcollection.d.ts +13 -0
  63. package/esm/typings/src/commands/BOOK_VERSION/BookVersionCommand.d.ts +11 -0
  64. package/esm/typings/src/commands/BOOK_VERSION/bookVersionCommand.test.d.ts +1 -0
  65. package/esm/typings/src/commands/BOOK_VERSION/bookVersionCommandParser.d.ts +9 -0
  66. package/esm/typings/src/commands/EXPECT/ExpectCommand.d.ts +17 -0
  67. package/esm/typings/src/commands/EXPECT/expectCommand.test.d.ts +1 -0
  68. package/esm/typings/src/commands/EXPECT/expectCommandParser.d.ts +11 -0
  69. package/esm/typings/src/commands/FOREACH/ForeachCommand.d.ts +10 -0
  70. package/esm/typings/src/commands/FOREACH/ForeachJson.d.ts +27 -0
  71. package/esm/typings/src/commands/FOREACH/foreachCommand.test.d.ts +1 -0
  72. package/esm/typings/src/commands/FOREACH/foreachCommandParser.d.ts +12 -0
  73. package/esm/typings/src/commands/FORMAT/FormatCommand.d.ts +9 -0
  74. package/esm/typings/src/commands/FORMAT/formatCommand.test.d.ts +1 -0
  75. package/esm/typings/src/commands/FORMAT/formatCommandParser.d.ts +9 -0
  76. package/esm/typings/src/commands/FORMFACTOR/FormfactorCommand.d.ts +11 -0
  77. package/esm/typings/src/commands/FORMFACTOR/formfactorCommand.test.d.ts +1 -0
  78. package/esm/typings/src/commands/FORMFACTOR/formfactorCommandParser.d.ts +11 -0
  79. package/esm/typings/src/commands/JOKER/JokerCommand.d.ts +11 -0
  80. package/esm/typings/src/commands/JOKER/jokerCommand.test.d.ts +1 -0
  81. package/esm/typings/src/commands/JOKER/jokerCommandParser.d.ts +9 -0
  82. package/esm/typings/src/commands/KNOWLEDGE/KnowledgeCommand.d.ts +11 -0
  83. package/esm/typings/src/commands/KNOWLEDGE/knowledgeCommand.test.d.ts +1 -0
  84. package/esm/typings/src/commands/KNOWLEDGE/knowledgeCommandParser.d.ts +12 -0
  85. package/esm/typings/src/commands/KNOWLEDGE/utils/knowledgeSourceContentToName.d.ts +11 -0
  86. package/esm/typings/src/commands/KNOWLEDGE/utils/knowledgeSourceContentToName.test.d.ts +4 -0
  87. package/esm/typings/src/commands/MODEL/ModelCommand.d.ts +14 -0
  88. package/esm/typings/src/commands/MODEL/modelCommand.test.d.ts +1 -0
  89. package/esm/typings/src/commands/MODEL/modelCommandParser.d.ts +10 -0
  90. package/esm/typings/src/commands/PARAMETER/ParameterCommand.d.ts +15 -0
  91. package/esm/typings/src/commands/PARAMETER/parameterCommand.test.d.ts +1 -0
  92. package/esm/typings/src/commands/PARAMETER/parameterCommandParser.d.ts +9 -0
  93. package/esm/typings/src/commands/PERSONA/PersonaCommand.d.ts +13 -0
  94. package/esm/typings/src/commands/PERSONA/personaCommand.test.d.ts +1 -0
  95. package/esm/typings/src/commands/PERSONA/personaCommandParser.d.ts +9 -0
  96. package/esm/typings/src/commands/POSTPROCESS/PostprocessCommand.d.ts +11 -0
  97. package/esm/typings/src/commands/POSTPROCESS/postprocessCommand.test.d.ts +1 -0
  98. package/esm/typings/src/commands/POSTPROCESS/postprocessCommandParser.d.ts +9 -0
  99. package/esm/typings/src/commands/SECTION/SectionCommand.d.ts +11 -0
  100. package/esm/typings/src/commands/SECTION/sectionCommand.test.d.ts +1 -0
  101. package/esm/typings/src/commands/SECTION/sectionCommandParser.d.ts +20 -0
  102. package/esm/typings/src/commands/URL/UrlCommand.d.ts +10 -0
  103. package/esm/typings/src/commands/URL/urlCommand.test.d.ts +1 -0
  104. package/esm/typings/src/commands/URL/urlCommandParser.d.ts +9 -0
  105. package/esm/typings/src/commands/X_ACTION/ActionCommand.d.ts +9 -0
  106. package/esm/typings/src/commands/X_ACTION/actionCommand.test.d.ts +1 -0
  107. package/esm/typings/src/commands/X_ACTION/actionCommandParser.d.ts +12 -0
  108. package/esm/typings/src/commands/X_INSTRUMENT/InstrumentCommand.d.ts +9 -0
  109. package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommand.test.d.ts +1 -0
  110. package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommandParser.d.ts +12 -0
  111. package/esm/typings/src/commands/_BOILERPLATE/BoilerplateCommand.d.ts +10 -0
  112. package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommand.test.d.ts +1 -0
  113. package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts +11 -0
  114. package/esm/typings/src/commands/_common/getParserForCommand.d.ts +11 -0
  115. package/esm/typings/src/commands/_common/getParserForCommand.test.d.ts +1 -0
  116. package/esm/typings/src/commands/_common/parseCommand.d.ts +12 -0
  117. package/esm/typings/src/commands/_common/parseCommand.test.d.ts +1 -0
  118. package/esm/typings/src/commands/_common/stringifyCommand.d.ts +12 -0
  119. package/esm/typings/src/commands/_common/stringifyCommand.test.d.ts +1 -0
  120. package/esm/typings/src/commands/_common/types/Command.d.ts +6 -0
  121. package/esm/typings/src/commands/_common/types/CommandParser.d.ts +205 -0
  122. package/esm/typings/src/commands/_common/types/CommandType.d.ts +17 -0
  123. package/esm/typings/src/commands/_common/types/CommandUsagePlaces.d.ts +13 -0
  124. package/esm/typings/src/commands/index.d.ts +9 -0
  125. package/esm/typings/src/config.d.ts +313 -0
  126. package/esm/typings/src/config.test.d.ts +4 -0
  127. package/esm/typings/src/constants.d.ts +76 -0
  128. package/esm/typings/src/conversion/archive/loadArchive.d.ts +16 -0
  129. package/esm/typings/src/conversion/archive/saveArchive.d.ts +18 -0
  130. package/esm/typings/src/conversion/compilePipeline.d.ts +25 -0
  131. package/esm/typings/src/conversion/compilePipeline.test.d.ts +1 -0
  132. package/esm/typings/src/conversion/compilePipelineOnRemoteServer.d.ts +21 -0
  133. package/esm/typings/src/conversion/parsePipeline.d.ts +30 -0
  134. package/esm/typings/src/conversion/parsePipeline.test.d.ts +1 -0
  135. package/esm/typings/src/conversion/pipelineJsonToString.d.ts +18 -0
  136. package/esm/typings/src/conversion/prettify/PrettifyOptions.d.ts +13 -0
  137. package/esm/typings/src/conversion/prettify/prettifyPipelineString.d.ts +12 -0
  138. package/esm/typings/src/conversion/prettify/renderPipelineMermaidOptions.d.ts +30 -0
  139. package/esm/typings/src/conversion/utils/extractParameterNamesFromTask.d.ts +15 -0
  140. package/esm/typings/src/conversion/utils/extractParameterNamesFromTask.test.d.ts +1 -0
  141. package/esm/typings/src/conversion/validation/_importPipeline.d.ts +23 -0
  142. package/esm/typings/src/conversion/validation/pipelineStringToJson-parseErrors.test.d.ts +4 -0
  143. package/esm/typings/src/conversion/validation/validatePipeline-logicErrors.test.d.ts +4 -0
  144. package/esm/typings/src/conversion/validation/validatePipeline.d.ts +42 -0
  145. package/esm/typings/src/conversion/validation/validatePipeline.test.d.ts +4 -0
  146. package/esm/typings/src/dialogs/callback/CallbackInterfaceTools.d.ts +17 -0
  147. package/esm/typings/src/dialogs/callback/CallbackInterfaceToolsOptions.d.ts +14 -0
  148. package/esm/typings/src/dialogs/simple-prompt/SimplePromptInterfaceTools.d.ts +22 -0
  149. package/esm/typings/src/dialogs/user-interface-execution-tools.test.d.ts +1 -0
  150. package/esm/typings/src/errors/0-BoilerplateError.d.ts +12 -0
  151. package/esm/typings/src/errors/0-index.d.ts +94 -0
  152. package/esm/typings/src/errors/AbstractFormatError.d.ts +11 -0
  153. package/esm/typings/src/errors/AuthenticationError.d.ts +9 -0
  154. package/esm/typings/src/errors/CollectionError.d.ts +9 -0
  155. package/esm/typings/src/errors/EnvironmentMismatchError.d.ts +9 -0
  156. package/esm/typings/src/errors/ExpectError.d.ts +12 -0
  157. package/esm/typings/src/errors/KnowledgeScrapeError.d.ts +9 -0
  158. package/esm/typings/src/errors/LimitReachedError.d.ts +9 -0
  159. package/esm/typings/src/errors/MissingToolsError.d.ts +9 -0
  160. package/esm/typings/src/errors/NotFoundError.d.ts +9 -0
  161. package/esm/typings/src/errors/NotYetImplementedError.d.ts +9 -0
  162. package/esm/typings/src/errors/ParseError.d.ts +12 -0
  163. package/esm/typings/src/errors/PipelineExecutionError.d.ts +14 -0
  164. package/esm/typings/src/errors/PipelineLogicError.d.ts +9 -0
  165. package/esm/typings/src/errors/PipelineUrlError.d.ts +9 -0
  166. package/esm/typings/src/errors/PromptbookFetchError.d.ts +9 -0
  167. package/esm/typings/src/errors/UnexpectedError.d.ts +9 -0
  168. package/esm/typings/src/errors/WrappedError.d.ts +10 -0
  169. package/esm/typings/src/errors/assertsError.d.ts +11 -0
  170. package/esm/typings/src/errors/utils/ErrorJson.d.ts +25 -0
  171. package/esm/typings/src/errors/utils/deserializeError.d.ts +7 -0
  172. package/esm/typings/src/errors/utils/deserializeError.test.d.ts +1 -0
  173. package/esm/typings/src/errors/utils/getErrorReportUrl.d.ts +6 -0
  174. package/esm/typings/src/errors/utils/serializeError.d.ts +7 -0
  175. package/esm/typings/src/errors/utils/serializeError.test.d.ts +1 -0
  176. package/esm/typings/src/executables/$provideExecutablesForNode.d.ts +12 -0
  177. package/esm/typings/src/executables/apps/locateLibreoffice.d.ts +12 -0
  178. package/esm/typings/src/executables/apps/locateLibreoffice.test.d.ts +1 -0
  179. package/esm/typings/src/executables/apps/locatePandoc.d.ts +12 -0
  180. package/esm/typings/src/executables/apps/locatePandoc.test.d.ts +1 -0
  181. package/esm/typings/src/executables/locateApp.d.ts +33 -0
  182. package/esm/typings/src/executables/locateApp.test.d.ts +1 -0
  183. package/esm/typings/src/executables/platforms/locateAppOnLinux.d.ts +13 -0
  184. package/esm/typings/src/executables/platforms/locateAppOnMacOs.d.ts +13 -0
  185. package/esm/typings/src/executables/platforms/locateAppOnWindows.d.ts +13 -0
  186. package/esm/typings/src/execution/AbstractTaskResult.d.ts +25 -0
  187. package/esm/typings/src/execution/AvailableModel.d.ts +46 -0
  188. package/esm/typings/src/execution/CommonToolsOptions.d.ts +28 -0
  189. package/esm/typings/src/execution/EmbeddingVector.d.ts +8 -0
  190. package/esm/typings/src/execution/Executables.d.ts +18 -0
  191. package/esm/typings/src/execution/ExecutionTask.d.ts +119 -0
  192. package/esm/typings/src/execution/ExecutionTools.d.ts +69 -0
  193. package/esm/typings/src/execution/FilesystemTools.d.ts +9 -0
  194. package/esm/typings/src/execution/LlmExecutionTools.d.ts +61 -0
  195. package/esm/typings/src/execution/LlmExecutionToolsConstructor.d.ts +11 -0
  196. package/esm/typings/src/execution/PipelineExecutor.d.ts +16 -0
  197. package/esm/typings/src/execution/PipelineExecutorResult.d.ts +39 -0
  198. package/esm/typings/src/execution/PromptResult.d.ts +101 -0
  199. package/esm/typings/src/execution/PromptbookFetch.d.ts +12 -0
  200. package/esm/typings/src/execution/PromptbookFetch.test-type.d.ts +5 -0
  201. package/esm/typings/src/execution/ScriptExecutionTools.d.ts +39 -0
  202. package/esm/typings/src/execution/UncertainNumber.d.ts +19 -0
  203. package/esm/typings/src/execution/Usage.d.ts +33 -0
  204. package/esm/typings/src/execution/UserInterfaceTools.d.ts +46 -0
  205. package/esm/typings/src/execution/assertsTaskSuccessful.d.ts +14 -0
  206. package/esm/typings/src/execution/createPipelineExecutor/$OngoingTaskResult.d.ts +48 -0
  207. package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorOptions.d.ts +46 -0
  208. package/esm/typings/src/execution/createPipelineExecutor/00-createPipelineExecutor.d.ts +10 -0
  209. package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts +48 -0
  210. package/esm/typings/src/execution/createPipelineExecutor/20-executeTask.d.ts +51 -0
  211. package/esm/typings/src/execution/createPipelineExecutor/30-executeFormatSubvalues.d.ts +27 -0
  212. package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +70 -0
  213. package/esm/typings/src/execution/createPipelineExecutor/computeCosineSimilarity.d.ts +13 -0
  214. package/esm/typings/src/execution/createPipelineExecutor/filterJustOutputParameters.d.ts +35 -0
  215. package/esm/typings/src/execution/createPipelineExecutor/getContextForTask.d.ts +14 -0
  216. package/esm/typings/src/execution/createPipelineExecutor/getExamplesForTask.d.ts +10 -0
  217. package/esm/typings/src/execution/createPipelineExecutor/getKnowledgeForTask.d.ts +42 -0
  218. package/esm/typings/src/execution/createPipelineExecutor/getReservedParametersForTask.d.ts +48 -0
  219. package/esm/typings/src/execution/createPipelineExecutor/knowledgePiecesToString.d.ts +9 -0
  220. package/esm/typings/src/execution/embeddingVectorToString.d.ts +7 -0
  221. package/esm/typings/src/execution/execution-report/ExecutionPromptReportJson.d.ts +24 -0
  222. package/esm/typings/src/execution/execution-report/ExecutionReportJson.d.ts +41 -0
  223. package/esm/typings/src/execution/execution-report/ExecutionReportString.d.ts +16 -0
  224. package/esm/typings/src/execution/execution-report/ExecutionReportStringOptions.d.ts +25 -0
  225. package/esm/typings/src/execution/execution-report/countWorkingDuration.d.ts +7 -0
  226. package/esm/typings/src/execution/execution-report/countWorkingDuration.test.d.ts +1 -0
  227. package/esm/typings/src/execution/execution-report/executionReportJsonToString.d.ts +15 -0
  228. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/AutomaticTranslator.d.ts +7 -0
  229. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/DebugAutomaticTranslator.d.ts +11 -0
  230. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/FakeAutomaticTranslator.d.ts +8 -0
  231. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/LindatAutomaticTranslator.d.ts +22 -0
  232. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/TranslatorOptions.d.ts +7 -0
  233. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.d.ts +8 -0
  234. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.test.d.ts +1 -0
  235. package/esm/typings/src/execution/translation/automatic-translate/translateMessages.d.ts +12 -0
  236. package/esm/typings/src/execution/utils/$provideExecutionToolsForNode.d.ts +13 -0
  237. package/esm/typings/src/execution/utils/addUsage.d.ts +9 -0
  238. package/esm/typings/src/execution/utils/addUsage.test.d.ts +1 -0
  239. package/esm/typings/src/execution/utils/checkExpectations.d.ts +29 -0
  240. package/esm/typings/src/execution/utils/checkExpectations.test.d.ts +1 -0
  241. package/esm/typings/src/execution/utils/computeUsageCounts.d.ts +10 -0
  242. package/esm/typings/src/execution/utils/forEachAsync.d.ts +20 -0
  243. package/esm/typings/src/execution/utils/uncertainNumber.d.ts +10 -0
  244. package/esm/typings/src/execution/utils/usage-constants.d.ts +147 -0
  245. package/esm/typings/src/execution/utils/usageToHuman.d.ts +26 -0
  246. package/esm/typings/src/execution/utils/usageToWorktime.d.ts +20 -0
  247. package/esm/typings/src/execution/utils/usageToWorktime.test.d.ts +1 -0
  248. package/esm/typings/src/expectations/drafts/isDomainNameFree.d.ts +10 -0
  249. package/esm/typings/src/expectations/drafts/isGithubNameFree.d.ts +10 -0
  250. package/esm/typings/src/formats/_common/FormatParser.d.ts +72 -0
  251. package/esm/typings/src/formats/_common/FormatSubvalueParser.d.ts +66 -0
  252. package/esm/typings/src/formats/csv/CsvFormatError.d.ts +10 -0
  253. package/esm/typings/src/formats/csv/CsvFormatParser.d.ts +17 -0
  254. package/esm/typings/src/formats/csv/CsvSettings.d.ts +13 -0
  255. package/esm/typings/src/formats/csv/utils/csvParse.d.ts +12 -0
  256. package/esm/typings/src/formats/csv/utils/isValidCsvString.d.ts +9 -0
  257. package/esm/typings/src/formats/csv/utils/isValidCsvString.test.d.ts +1 -0
  258. package/esm/typings/src/formats/index.d.ts +9 -0
  259. package/esm/typings/src/formats/json/JsonFormatParser.d.ts +19 -0
  260. package/esm/typings/src/formats/json/utils/isValidJsonString.d.ts +9 -0
  261. package/esm/typings/src/formats/json/utils/isValidJsonString.test.d.ts +1 -0
  262. package/esm/typings/src/formats/json/utils/jsonParse.d.ts +8 -0
  263. package/esm/typings/src/formats/text/TextFormatParser.d.ts +19 -0
  264. package/esm/typings/src/formats/xml/XmlFormatParser.d.ts +19 -0
  265. package/esm/typings/src/formats/xml/utils/isValidXmlString.d.ts +9 -0
  266. package/esm/typings/src/formats/xml/utils/isValidXmlString.test.d.ts +1 -0
  267. package/esm/typings/src/formfactors/_boilerplate/BoilerplateFormfactorDefinition.d.ts +15 -0
  268. package/esm/typings/src/formfactors/_common/AbstractFormfactorDefinition.d.ts +49 -0
  269. package/esm/typings/src/formfactors/_common/FormfactorDefinition.d.ts +10 -0
  270. package/esm/typings/src/formfactors/_common/string_formfactor_name.d.ts +6 -0
  271. package/esm/typings/src/formfactors/chatbot/ChatbotFormfactorDefinition.d.ts +45 -0
  272. package/esm/typings/src/formfactors/completion/CompletionFormfactorDefinition.d.ts +29 -0
  273. package/esm/typings/src/formfactors/generator/GeneratorFormfactorDefinition.d.ts +25 -0
  274. package/esm/typings/src/formfactors/generic/GenericFormfactorDefinition.d.ts +14 -0
  275. package/esm/typings/src/formfactors/image-generator/ImageGeneratorFormfactorDefinition.d.ts +24 -0
  276. package/esm/typings/src/formfactors/index.d.ts +170 -0
  277. package/esm/typings/src/formfactors/matcher/MatcherFormfactorDefinition.d.ts +21 -0
  278. package/esm/typings/src/formfactors/sheets/SheetsFormfactorDefinition.d.ts +26 -0
  279. package/esm/typings/src/formfactors/translator/TranslatorFormfactorDefinition.d.ts +25 -0
  280. package/esm/typings/src/high-level-abstractions/_common/HighLevelAbstraction.d.ts +20 -0
  281. package/esm/typings/src/high-level-abstractions/implicit-formfactor/ImplicitFormfactorHla.d.ts +10 -0
  282. package/esm/typings/src/high-level-abstractions/index.d.ts +54 -0
  283. package/esm/typings/src/high-level-abstractions/quick-chatbot/QuickChatbotHla.d.ts +13 -0
  284. package/esm/typings/src/llm-providers/_common/filterModels.d.ts +15 -0
  285. package/esm/typings/src/llm-providers/_common/register/$llmToolsMetadataRegister.d.ts +13 -0
  286. package/esm/typings/src/llm-providers/_common/register/$llmToolsRegister.d.ts +13 -0
  287. package/esm/typings/src/llm-providers/_common/register/$provideEnvFilename.d.ts +12 -0
  288. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsConfigurationFromEnv.d.ts +19 -0
  289. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForTestingAndScriptsAndPlayground.d.ts +27 -0
  290. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForWizardOrCli.d.ts +59 -0
  291. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsFromEnv.d.ts +41 -0
  292. package/esm/typings/src/llm-providers/_common/register/$registeredLlmToolsMessage.d.ts +22 -0
  293. package/esm/typings/src/llm-providers/_common/register/LlmToolsConfiguration.d.ts +30 -0
  294. package/esm/typings/src/llm-providers/_common/register/LlmToolsMetadata.d.ts +58 -0
  295. package/esm/typings/src/llm-providers/_common/register/LlmToolsOptions.d.ts +17 -0
  296. package/esm/typings/src/llm-providers/_common/register/createLlmToolsFromConfiguration.d.ts +49 -0
  297. package/esm/typings/src/llm-providers/_common/register/createLlmToolsFromConfiguration.test.d.ts +1 -0
  298. package/esm/typings/src/llm-providers/_common/utils/cache/CacheItem.d.ts +33 -0
  299. package/esm/typings/src/llm-providers/_common/utils/cache/CacheLlmToolsOptions.d.ts +27 -0
  300. package/esm/typings/src/llm-providers/_common/utils/cache/cacheLlmTools.d.ts +19 -0
  301. package/esm/typings/src/llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage.d.ts +22 -0
  302. package/esm/typings/src/llm-providers/_common/utils/count-total-usage/countUsage.d.ts +17 -0
  303. package/esm/typings/src/llm-providers/_common/utils/count-total-usage/limitTotalUsage.d.ts +36 -0
  304. package/esm/typings/src/llm-providers/_common/utils/pricing.d.ts +16 -0
  305. package/esm/typings/src/llm-providers/_common/utils/pricing.test.d.ts +1 -0
  306. package/esm/typings/src/llm-providers/_multiple/MultipleLlmExecutionTools.d.ts +63 -0
  307. package/esm/typings/src/llm-providers/_multiple/joinLlmExecutionTools.d.ts +21 -0
  308. package/esm/typings/src/llm-providers/_multiple/playground/playground.d.ts +5 -0
  309. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +66 -0
  310. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions.d.ts +31 -0
  311. package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +24 -0
  312. package/esm/typings/src/llm-providers/anthropic-claude/computeAnthropicClaudeUsage.d.ts +18 -0
  313. package/esm/typings/src/llm-providers/anthropic-claude/computeAnthropicClaudeUsage.test.d.ts +4 -0
  314. package/esm/typings/src/llm-providers/anthropic-claude/createAnthropicClaudeExecutionTools.d.ts +19 -0
  315. package/esm/typings/src/llm-providers/anthropic-claude/playground/playground.d.ts +7 -0
  316. package/esm/typings/src/llm-providers/anthropic-claude/register-configuration.d.ts +14 -0
  317. package/esm/typings/src/llm-providers/anthropic-claude/register-constructor.d.ts +16 -0
  318. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +67 -0
  319. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionToolsOptions.d.ts +37 -0
  320. package/esm/typings/src/llm-providers/azure-openai/createAzureOpenAiExecutionTools.d.ts +15 -0
  321. package/esm/typings/src/llm-providers/azure-openai/playground/playground.d.ts +6 -0
  322. package/esm/typings/src/llm-providers/azure-openai/register-configuration.d.ts +14 -0
  323. package/esm/typings/src/llm-providers/azure-openai/register-constructor.d.ts +15 -0
  324. package/esm/typings/src/llm-providers/deepseek/DeepseekExecutionToolsOptions.d.ts +9 -0
  325. package/esm/typings/src/llm-providers/deepseek/createDeepseekExecutionTools.d.ts +14 -0
  326. package/esm/typings/src/llm-providers/deepseek/deepseek-models.d.ts +23 -0
  327. package/esm/typings/src/llm-providers/deepseek/register-configuration.d.ts +14 -0
  328. package/esm/typings/src/llm-providers/deepseek/register-constructor.d.ts +15 -0
  329. package/esm/typings/src/llm-providers/google/GoogleExecutionToolsOptions.d.ts +9 -0
  330. package/esm/typings/src/llm-providers/google/createGoogleExecutionTools.d.ts +14 -0
  331. package/esm/typings/src/llm-providers/google/google-models.d.ts +23 -0
  332. package/esm/typings/src/llm-providers/google/register-configuration.d.ts +14 -0
  333. package/esm/typings/src/llm-providers/google/register-constructor.d.ts +15 -0
  334. package/esm/typings/src/llm-providers/mocked/$fakeTextToExpectations.d.ts +15 -0
  335. package/esm/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts +40 -0
  336. package/esm/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts +44 -0
  337. package/esm/typings/src/llm-providers/mocked/test/fakeTextToExpectations.test.d.ts +1 -0
  338. package/esm/typings/src/llm-providers/mocked/test/faked-completion.test.d.ts +1 -0
  339. package/esm/typings/src/llm-providers/mocked/test/joker.test.d.ts +4 -0
  340. package/esm/typings/src/llm-providers/mocked/test/mocked-chat.test.d.ts +5 -0
  341. package/esm/typings/src/llm-providers/mocked/test/mocked-completion.test.d.ts +4 -0
  342. package/esm/typings/src/llm-providers/ollama/OllamaExecutionTools.d.ts +44 -0
  343. package/esm/typings/src/llm-providers/ollama/OllamaExecutionToolsOptions.d.ts +23 -0
  344. package/esm/typings/src/llm-providers/ollama/createOllamaExecutionTools.d.ts +11 -0
  345. package/esm/typings/src/llm-providers/ollama/ollama-models.d.ts +14 -0
  346. package/esm/typings/src/llm-providers/ollama/playground/playground.d.ts +6 -0
  347. package/esm/typings/src/llm-providers/ollama/register-configuration.d.ts +14 -0
  348. package/esm/typings/src/llm-providers/ollama/register-constructor.d.ts +15 -0
  349. package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionTools.d.ts +36 -0
  350. package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionToolsOptions.d.ts +14 -0
  351. package/esm/typings/src/llm-providers/openai/OpenAiCompatibleExecutionTools.d.ts +91 -0
  352. package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +38 -0
  353. package/esm/typings/src/llm-providers/openai/OpenAiExecutionToolsOptions.d.ts +11 -0
  354. package/esm/typings/src/llm-providers/openai/computeOpenAiUsage.d.ts +18 -0
  355. package/esm/typings/src/llm-providers/openai/computeOpenAiUsage.test.d.ts +4 -0
  356. package/esm/typings/src/llm-providers/openai/createOpenAiAssistantExecutionTools.d.ts +15 -0
  357. package/esm/typings/src/llm-providers/openai/createOpenAiExecutionTools.d.ts +17 -0
  358. package/esm/typings/src/llm-providers/openai/openai-models.d.ts +25 -0
  359. package/esm/typings/src/llm-providers/openai/playground/playground.d.ts +6 -0
  360. package/esm/typings/src/llm-providers/openai/register-configuration.d.ts +24 -0
  361. package/esm/typings/src/llm-providers/openai/register-constructor.d.ts +25 -0
  362. package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts +59 -0
  363. package/esm/typings/src/llm-providers/remote/playground/playground.d.ts +5 -0
  364. package/esm/typings/src/llm-providers/vercel/VercelExecutionToolsOptions.d.ts +23 -0
  365. package/esm/typings/src/llm-providers/vercel/VercelProvider.d.ts +13 -0
  366. package/esm/typings/src/llm-providers/vercel/createExecutionToolsFromVercelProvider.d.ts +8 -0
  367. package/esm/typings/src/llm-providers/vercel/playground/playground.d.ts +6 -0
  368. package/esm/typings/src/migrations/migratePipeline.d.ts +9 -0
  369. package/esm/typings/src/other/templates/getBookTemplates.d.ts +24 -0
  370. package/esm/typings/src/other/templates/getTemplatesPipelineCollection.d.ts +10 -0
  371. package/esm/typings/src/personas/preparePersona.d.ts +17 -0
  372. package/esm/typings/src/pipeline/PipelineInterface/PipelineInterface.d.ts +22 -0
  373. package/esm/typings/src/pipeline/PipelineInterface/constants.d.ts +14 -0
  374. package/esm/typings/src/pipeline/PipelineInterface/getPipelineInterface.d.ts +11 -0
  375. package/esm/typings/src/pipeline/PipelineInterface/isPipelineImplementingInterface.d.ts +27 -0
  376. package/esm/typings/src/pipeline/PipelineInterface/isPipelineInterfacesEqual.d.ts +10 -0
  377. package/esm/typings/src/pipeline/PipelineJson/CommonTaskJson.d.ts +103 -0
  378. package/esm/typings/src/pipeline/PipelineJson/DialogTaskJson.d.ts +13 -0
  379. package/esm/typings/src/pipeline/PipelineJson/Expectations.d.ts +40 -0
  380. package/esm/typings/src/pipeline/PipelineJson/KnowledgePieceJson.d.ts +73 -0
  381. package/esm/typings/src/pipeline/PipelineJson/KnowledgeSourceJson.d.ts +44 -0
  382. package/esm/typings/src/pipeline/PipelineJson/ParameterJson.d.ts +98 -0
  383. package/esm/typings/src/pipeline/PipelineJson/PersonaJson.d.ts +47 -0
  384. package/esm/typings/src/pipeline/PipelineJson/PipelineJson.d.ts +113 -0
  385. package/esm/typings/src/pipeline/PipelineJson/PreparationJson.d.ts +22 -0
  386. package/esm/typings/src/pipeline/PipelineJson/PromptTaskJson.d.ts +26 -0
  387. package/esm/typings/src/pipeline/PipelineJson/ScriptTaskJson.d.ts +20 -0
  388. package/esm/typings/src/pipeline/PipelineJson/SimpleTaskJson.d.ts +13 -0
  389. package/esm/typings/src/pipeline/PipelineJson/TaskJson.d.ts +11 -0
  390. package/esm/typings/src/pipeline/PipelineString.d.ts +11 -0
  391. package/esm/typings/src/pipeline/book-notation.d.ts +19 -0
  392. package/esm/typings/src/pipeline/isValidPipelineString.d.ts +13 -0
  393. package/esm/typings/src/pipeline/isValidPipelineString.test.d.ts +4 -0
  394. package/esm/typings/src/pipeline/prompt-notation.d.ts +31 -0
  395. package/esm/typings/src/pipeline/prompt-notation.test.d.ts +4 -0
  396. package/esm/typings/src/pipeline/validatePipelineString.d.ts +14 -0
  397. package/esm/typings/src/playground/playground.d.ts +5 -0
  398. package/esm/typings/src/postprocessing/utils/extractBlock.d.ts +16 -0
  399. package/esm/typings/src/postprocessing/utils/extractJsonBlock.d.ts +25 -0
  400. package/esm/typings/src/postprocessing/utils/extractJsonBlock.test.d.ts +1 -0
  401. package/esm/typings/src/prepare/PrepareAndScrapeOptions.d.ts +51 -0
  402. package/esm/typings/src/prepare/isPipelinePrepared.d.ts +18 -0
  403. package/esm/typings/src/prepare/isPipelinePrepared.test.d.ts +1 -0
  404. package/esm/typings/src/prepare/preparePipeline.d.ts +22 -0
  405. package/esm/typings/src/prepare/preparePipelineOnRemoteServer.d.ts +17 -0
  406. package/esm/typings/src/prepare/prepareTasks.d.ts +36 -0
  407. package/esm/typings/src/prepare/unpreparePipeline.d.ts +13 -0
  408. package/esm/typings/src/remote-server/RemoteServer.d.ts +23 -0
  409. package/esm/typings/src/remote-server/createRemoteClient.d.ts +10 -0
  410. package/esm/typings/src/remote-server/openapi-types.d.ts +626 -0
  411. package/esm/typings/src/remote-server/openapi.d.ts +581 -0
  412. package/esm/typings/src/remote-server/socket-types/_common/PromptbookServer_Error.d.ts +7 -0
  413. package/esm/typings/src/remote-server/socket-types/_subtypes/Identification.d.ts +59 -0
  414. package/esm/typings/src/remote-server/socket-types/_subtypes/identificationToPromptbookToken.d.ts +11 -0
  415. package/esm/typings/src/remote-server/socket-types/_subtypes/promptbookTokenToIdentification.d.ts +10 -0
  416. package/esm/typings/src/remote-server/socket-types/listModels/PromptbookServer_ListModels_Request.d.ts +17 -0
  417. package/esm/typings/src/remote-server/socket-types/listModels/PromptbookServer_ListModels_Response.d.ts +17 -0
  418. package/esm/typings/src/remote-server/socket-types/prepare/PromptbookServer_PreparePipeline_Request.d.ts +17 -0
  419. package/esm/typings/src/remote-server/socket-types/prepare/PromptbookServer_PreparePipeline_Response.d.ts +12 -0
  420. package/esm/typings/src/remote-server/socket-types/prompt/PromptbookServer_Prompt_Request.d.ts +17 -0
  421. package/esm/typings/src/remote-server/socket-types/prompt/PromptbookServer_Prompt_Response.d.ts +12 -0
  422. package/esm/typings/src/remote-server/startRemoteServer.d.ts +25 -0
  423. package/esm/typings/src/remote-server/types/RemoteClientOptions.d.ts +24 -0
  424. package/esm/typings/src/remote-server/types/RemoteServerOptions.d.ts +164 -0
  425. package/esm/typings/src/scrapers/_boilerplate/BoilerplateScraper.d.ts +43 -0
  426. package/esm/typings/src/scrapers/_boilerplate/createBoilerplateScraper.d.ts +20 -0
  427. package/esm/typings/src/scrapers/_boilerplate/playground/boilerplate-scraper-playground.d.ts +5 -0
  428. package/esm/typings/src/scrapers/_boilerplate/register-constructor.d.ts +15 -0
  429. package/esm/typings/src/scrapers/_boilerplate/register-metadata.d.ts +28 -0
  430. package/esm/typings/src/scrapers/_common/Converter.d.ts +25 -0
  431. package/esm/typings/src/scrapers/_common/Scraper.d.ts +60 -0
  432. package/esm/typings/src/scrapers/_common/ScraperIntermediateSource.d.ts +16 -0
  433. package/esm/typings/src/scrapers/_common/prepareKnowledgePieces.d.ts +19 -0
  434. package/esm/typings/src/scrapers/_common/prepareKnowledgePieces.test.d.ts +1 -0
  435. package/esm/typings/src/scrapers/_common/register/$provideFilesystemForNode.d.ts +12 -0
  436. package/esm/typings/src/scrapers/_common/register/$provideScrapersForBrowser.d.ts +15 -0
  437. package/esm/typings/src/scrapers/_common/register/$provideScrapersForNode.d.ts +13 -0
  438. package/esm/typings/src/scrapers/_common/register/$provideScriptingForNode.d.ts +11 -0
  439. package/esm/typings/src/scrapers/_common/register/$registeredScrapersMessage.d.ts +13 -0
  440. package/esm/typings/src/scrapers/_common/register/$scrapersMetadataRegister.d.ts +13 -0
  441. package/esm/typings/src/scrapers/_common/register/$scrapersRegister.d.ts +14 -0
  442. package/esm/typings/src/scrapers/_common/register/ScraperAndConverterMetadata.d.ts +46 -0
  443. package/esm/typings/src/scrapers/_common/register/ScraperConstructor.d.ts +13 -0
  444. package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.d.ts +35 -0
  445. package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.test.d.ts +4 -0
  446. package/esm/typings/src/scrapers/_common/utils/makeKnowledgeSourceHandler.d.ts +13 -0
  447. package/esm/typings/src/scrapers/_common/utils/promptbookFetch.d.ts +10 -0
  448. package/esm/typings/src/scrapers/document/DocumentScraper.d.ts +43 -0
  449. package/esm/typings/src/scrapers/document/DocumentScraper.test.d.ts +4 -0
  450. package/esm/typings/src/scrapers/document/createDocumentScraper.d.ts +20 -0
  451. package/esm/typings/src/scrapers/document/playground/document-scraper-playground.d.ts +5 -0
  452. package/esm/typings/src/scrapers/document/register-constructor.d.ts +15 -0
  453. package/esm/typings/src/scrapers/document/register-metadata.d.ts +28 -0
  454. package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.d.ts +43 -0
  455. package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.test.d.ts +4 -0
  456. package/esm/typings/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts +21 -0
  457. package/esm/typings/src/scrapers/document-legacy/playground/legacy-document-scraper-playground.d.ts +5 -0
  458. package/esm/typings/src/scrapers/document-legacy/register-constructor.d.ts +15 -0
  459. package/esm/typings/src/scrapers/document-legacy/register-metadata.d.ts +28 -0
  460. package/esm/typings/src/scrapers/markdown/MarkdownScraper.d.ts +29 -0
  461. package/esm/typings/src/scrapers/markdown/MarkdownScraper.test.d.ts +4 -0
  462. package/esm/typings/src/scrapers/markdown/createMarkdownScraper.d.ts +20 -0
  463. package/esm/typings/src/scrapers/markdown/playground/markdown-scraper-playground.d.ts +5 -0
  464. package/esm/typings/src/scrapers/markdown/register-constructor.d.ts +15 -0
  465. package/esm/typings/src/scrapers/markdown/register-metadata.d.ts +28 -0
  466. package/esm/typings/src/scrapers/markitdown/MarkitdownScraper.d.ts +50 -0
  467. package/esm/typings/src/scrapers/markitdown/createMarkitdownScraper.d.ts +22 -0
  468. package/esm/typings/src/scrapers/markitdown/playground/markitdown-scraper-playground.d.ts +5 -0
  469. package/esm/typings/src/scrapers/markitdown/register-constructor.d.ts +17 -0
  470. package/esm/typings/src/scrapers/markitdown/register-metadata.d.ts +28 -0
  471. package/esm/typings/src/scrapers/pdf/PdfScraper.d.ts +41 -0
  472. package/esm/typings/src/scrapers/pdf/createPdfScraper.d.ts +21 -0
  473. package/esm/typings/src/scrapers/pdf/playground/pdf-scraper-playground.d.ts +5 -0
  474. package/esm/typings/src/scrapers/pdf/register-constructor.d.ts +15 -0
  475. package/esm/typings/src/scrapers/pdf/register-metadata.d.ts +28 -0
  476. package/esm/typings/src/scrapers/website/WebsiteScraper.d.ts +50 -0
  477. package/esm/typings/src/scrapers/website/createWebsiteScraper.d.ts +21 -0
  478. package/esm/typings/src/scrapers/website/playground/website-scraper-playground.d.ts +5 -0
  479. package/esm/typings/src/scrapers/website/register-constructor.d.ts +15 -0
  480. package/esm/typings/src/scrapers/website/register-metadata.d.ts +28 -0
  481. package/esm/typings/src/scrapers/website/utils/createShowdownConverter.d.ts +7 -0
  482. package/esm/typings/src/scrapers/website/utils/createShowdownConverter.test.d.ts +1 -0
  483. package/esm/typings/src/scripting/_test/custom-function-async.test.ts.test.d.ts +1 -0
  484. package/esm/typings/src/scripting/_test/custom-function-missing.test.d.ts +1 -0
  485. package/esm/typings/src/scripting/_test/custom-function-with-dependencies.test.d.ts +1 -0
  486. package/esm/typings/src/scripting/_test/custom-function.test.d.ts +1 -0
  487. package/esm/typings/src/scripting/_test/postprocessing.test.d.ts +1 -0
  488. package/esm/typings/src/scripting/_test/script-execution-errors.test.d.ts +1 -0
  489. package/esm/typings/src/scripting/_test/script-execution-tools.test.d.ts +1 -0
  490. package/esm/typings/src/scripting/javascript/JavascriptEvalExecutionTools.d.ts +22 -0
  491. package/esm/typings/src/scripting/javascript/JavascriptEvalExecutionTools.test.d.ts +4 -0
  492. package/esm/typings/src/scripting/javascript/JavascriptExecutionTools.d.ts +8 -0
  493. package/esm/typings/src/scripting/javascript/JavascriptExecutionToolsOptions.d.ts +26 -0
  494. package/esm/typings/src/scripting/javascript/postprocessing-functions.d.ts +56 -0
  495. package/esm/typings/src/scripting/javascript/utils/extractVariablesFromJavascript.d.ts +14 -0
  496. package/esm/typings/src/scripting/javascript/utils/extractVariablesFromJavascript.test.d.ts +1 -0
  497. package/esm/typings/src/scripting/javascript/utils/extractVariablesFromScript.test.d.ts +1 -0
  498. package/esm/typings/src/scripting/javascript/utils/preserve.d.ts +14 -0
  499. package/esm/typings/src/scripting/python/PythonExecutionTools.d.ts +18 -0
  500. package/esm/typings/src/scripting/typescript/TypescriptExecutionTools.d.ts +18 -0
  501. package/esm/typings/src/storage/_common/PromptbookStorage.d.ts +24 -0
  502. package/esm/typings/src/storage/_common/PromptbookStorage.test-type.d.ts +5 -0
  503. package/esm/typings/src/storage/blackhole/BlackholeStorage.d.ts +33 -0
  504. package/esm/typings/src/storage/env-storage/$EnvStorage.d.ts +40 -0
  505. package/esm/typings/src/storage/file-cache-storage/FileCacheStorage.d.ts +40 -0
  506. package/esm/typings/src/storage/file-cache-storage/FileCacheStorageOptions.d.ts +12 -0
  507. package/esm/typings/src/storage/file-cache-storage/utils/nameToSubfolderPath.d.ts +8 -0
  508. package/esm/typings/src/storage/file-cache-storage/utils/nameToSubfolderPath.test.d.ts +1 -0
  509. package/esm/typings/src/storage/local-storage/getIndexedDbStorage.d.ts +11 -0
  510. package/esm/typings/src/storage/local-storage/getLocalStorage.d.ts +10 -0
  511. package/esm/typings/src/storage/local-storage/getSessionStorage.d.ts +10 -0
  512. package/esm/typings/src/storage/local-storage/utils/IndexedDbStorageOptions.d.ts +14 -0
  513. package/esm/typings/src/storage/local-storage/utils/makePromptbookStorageFromIndexedDb.d.ts +8 -0
  514. package/esm/typings/src/storage/local-storage/utils/makePromptbookStorageFromWebStorage.d.ts +12 -0
  515. package/esm/typings/src/storage/memory/MemoryStorage.d.ts +33 -0
  516. package/esm/typings/src/storage/utils/PrefixStorage.d.ts +25 -0
  517. package/esm/typings/src/types/Arrayable.d.ts +11 -0
  518. package/esm/typings/src/types/IntermediateFilesStrategy.d.ts +8 -0
  519. package/esm/typings/src/types/ModelRequirements.d.ts +104 -0
  520. package/esm/typings/src/types/ModelVariant.d.ts +15 -0
  521. package/esm/typings/src/types/NonEmptyArray.d.ts +8 -0
  522. package/esm/typings/src/types/Prompt.d.ts +111 -0
  523. package/esm/typings/src/types/ScriptLanguage.d.ts +13 -0
  524. package/esm/typings/src/types/SectionType.d.ts +21 -0
  525. package/esm/typings/src/types/TaskType.d.ts +15 -0
  526. package/esm/typings/src/types/typeAliasEmoji.d.ts +12 -0
  527. package/esm/typings/src/types/typeAliases.d.ts +679 -0
  528. package/esm/typings/src/utils/$Register.d.ts +40 -0
  529. package/esm/typings/src/utils/$getCurrentDate.d.ts +10 -0
  530. package/esm/typings/src/utils/FromtoItems.d.ts +19 -0
  531. package/esm/typings/src/utils/arrayableToArray.d.ts +11 -0
  532. package/esm/typings/src/utils/arrayableToArray.test.d.ts +1 -0
  533. package/esm/typings/src/utils/editable/edit-pipeline-string/addPipelineCommand.d.ts +17 -0
  534. package/esm/typings/src/utils/editable/edit-pipeline-string/addPipelineCommand.test.d.ts +1 -0
  535. package/esm/typings/src/utils/editable/edit-pipeline-string/deflatePipeline.d.ts +13 -0
  536. package/esm/typings/src/utils/editable/edit-pipeline-string/deflatePipeline.test.d.ts +1 -0
  537. package/esm/typings/src/utils/editable/edit-pipeline-string/removePipelineCommand.d.ts +22 -0
  538. package/esm/typings/src/utils/editable/edit-pipeline-string/removePipelineCommand.test.d.ts +1 -0
  539. package/esm/typings/src/utils/editable/types/PipelineEditableSerialized.d.ts +27 -0
  540. package/esm/typings/src/utils/editable/utils/isFlatPipeline.d.ts +8 -0
  541. package/esm/typings/src/utils/editable/utils/isFlatPipeline.test.d.ts +1 -0
  542. package/esm/typings/src/utils/editable/utils/renamePipelineParameter.d.ts +29 -0
  543. package/esm/typings/src/utils/editable/utils/renamePipelineParameter.test.d.ts +1 -0
  544. package/esm/typings/src/utils/editable/utils/stringifyPipelineJson.d.ts +16 -0
  545. package/esm/typings/src/utils/emojis.d.ts +24 -0
  546. package/esm/typings/src/utils/environment/$getGlobalScope.d.ts +10 -0
  547. package/esm/typings/src/utils/environment/$isRunningInBrowser.d.ts +11 -0
  548. package/esm/typings/src/utils/environment/$isRunningInJest.d.ts +11 -0
  549. package/esm/typings/src/utils/environment/$isRunningInNode.d.ts +11 -0
  550. package/esm/typings/src/utils/environment/$isRunningInWebWorker.d.ts +11 -0
  551. package/esm/typings/src/utils/execCommand/$execCommand.d.ts +16 -0
  552. package/esm/typings/src/utils/execCommand/$execCommandNormalizeOptions.d.ts +12 -0
  553. package/esm/typings/src/utils/execCommand/$execCommands.d.ts +18 -0
  554. package/esm/typings/src/utils/execCommand/ExecCommandOptions.d.ts +45 -0
  555. package/esm/typings/src/utils/execCommand/execCommand.test.d.ts +1 -0
  556. package/esm/typings/src/utils/execCommand/execCommandNormalizeOptions.test.d.ts +1 -0
  557. package/esm/typings/src/utils/expectation-counters/constants.d.ts +16 -0
  558. package/esm/typings/src/utils/expectation-counters/countCharacters.d.ts +10 -0
  559. package/esm/typings/src/utils/expectation-counters/countCharacters.test.d.ts +1 -0
  560. package/esm/typings/src/utils/expectation-counters/countLines.d.ts +12 -0
  561. package/esm/typings/src/utils/expectation-counters/countLines.test.d.ts +1 -0
  562. package/esm/typings/src/utils/expectation-counters/countPages.d.ts +12 -0
  563. package/esm/typings/src/utils/expectation-counters/countPages.test.d.ts +1 -0
  564. package/esm/typings/src/utils/expectation-counters/countParagraphs.d.ts +10 -0
  565. package/esm/typings/src/utils/expectation-counters/countParagraphs.test.d.ts +1 -0
  566. package/esm/typings/src/utils/expectation-counters/countSentences.d.ts +16 -0
  567. package/esm/typings/src/utils/expectation-counters/countSentences.test.d.ts +1 -0
  568. package/esm/typings/src/utils/expectation-counters/countWords.d.ts +10 -0
  569. package/esm/typings/src/utils/expectation-counters/countWords.test.d.ts +1 -0
  570. package/esm/typings/src/utils/expectation-counters/index.d.ts +12 -0
  571. package/esm/typings/src/utils/files/extensionToMimeType.d.ts +8 -0
  572. package/esm/typings/src/utils/files/extensionToMimeType.test.d.ts +1 -0
  573. package/esm/typings/src/utils/files/getFileExtension.d.ts +8 -0
  574. package/esm/typings/src/utils/files/getFileExtension.test.d.ts +1 -0
  575. package/esm/typings/src/utils/files/isDirectoryExisting.d.ts +14 -0
  576. package/esm/typings/src/utils/files/isDirectoryExisting.test.d.ts +1 -0
  577. package/esm/typings/src/utils/files/isExecutable.d.ts +11 -0
  578. package/esm/typings/src/utils/files/isFileExisting.d.ts +13 -0
  579. package/esm/typings/src/utils/files/isFileExisting.test.d.ts +1 -0
  580. package/esm/typings/src/utils/files/listAllFiles.d.ts +17 -0
  581. package/esm/typings/src/utils/files/listAllFiles.test.d.ts +1 -0
  582. package/esm/typings/src/utils/files/mimeTypeToExtension.d.ts +10 -0
  583. package/esm/typings/src/utils/files/mimeTypeToExtension.test.d.ts +1 -0
  584. package/esm/typings/src/utils/markdown/addAutoGeneratedSection.d.ts +14 -0
  585. package/esm/typings/src/utils/markdown/addAutoGeneratedSection.test.d.ts +1 -0
  586. package/esm/typings/src/utils/markdown/createMarkdownChart.d.ts +38 -0
  587. package/esm/typings/src/utils/markdown/createMarkdownChart.test.d.ts +1 -0
  588. package/esm/typings/src/utils/markdown/createMarkdownTable.d.ts +11 -0
  589. package/esm/typings/src/utils/markdown/createMarkdownTable.test.d.ts +1 -0
  590. package/esm/typings/src/utils/markdown/escapeMarkdownBlock.d.ts +11 -0
  591. package/esm/typings/src/utils/markdown/escapeMarkdownBlock.test.d.ts +1 -0
  592. package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown-real.test.d.ts +1 -0
  593. package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.d.ts +36 -0
  594. package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.test.d.ts +1 -0
  595. package/esm/typings/src/utils/markdown/extractAllListItemsFromMarkdown.d.ts +15 -0
  596. package/esm/typings/src/utils/markdown/extractAllListItemsFromMarkdown.test.d.ts +1 -0
  597. package/esm/typings/src/utils/markdown/extractOneBlockFromMarkdown.d.ts +22 -0
  598. package/esm/typings/src/utils/markdown/extractOneBlockFromMarkdown.test.d.ts +1 -0
  599. package/esm/typings/src/utils/markdown/flattenMarkdown.d.ts +17 -0
  600. package/esm/typings/src/utils/markdown/flattenMarkdown.test.d.ts +1 -0
  601. package/esm/typings/src/utils/markdown/parseMarkdownSection.d.ts +34 -0
  602. package/esm/typings/src/utils/markdown/parseMarkdownSection.test.d.ts +1 -0
  603. package/esm/typings/src/utils/markdown/prettifyMarkdown.d.ts +9 -0
  604. package/esm/typings/src/utils/markdown/prettifyMarkdown.test.d.ts +1 -0
  605. package/esm/typings/src/utils/markdown/removeMarkdownComments.d.ts +10 -0
  606. package/esm/typings/src/utils/markdown/removeMarkdownComments.test.d.ts +1 -0
  607. package/esm/typings/src/utils/markdown/removeMarkdownFormatting.d.ts +9 -0
  608. package/esm/typings/src/utils/markdown/removeMarkdownFormatting.test.d.ts +1 -0
  609. package/esm/typings/src/utils/markdown/splitMarkdownIntoSections.d.ts +15 -0
  610. package/esm/typings/src/utils/markdown/splitMarkdownIntoSections.test.d.ts +1 -0
  611. package/esm/typings/src/utils/normalization/DIACRITIC_VARIANTS_LETTERS.d.ts +12 -0
  612. package/esm/typings/src/utils/normalization/IKeywords.d.ts +21 -0
  613. package/esm/typings/src/utils/normalization/capitalize.d.ts +6 -0
  614. package/esm/typings/src/utils/normalization/capitalize.test.d.ts +1 -0
  615. package/esm/typings/src/utils/normalization/decapitalize.d.ts +6 -0
  616. package/esm/typings/src/utils/normalization/decapitalize.test.d.ts +1 -0
  617. package/esm/typings/src/utils/normalization/isValidKeyword.d.ts +10 -0
  618. package/esm/typings/src/utils/normalization/isValidKeyword.test.d.ts +1 -0
  619. package/esm/typings/src/utils/normalization/nameToUriPart.d.ts +9 -0
  620. package/esm/typings/src/utils/normalization/nameToUriPart.test.d.ts +1 -0
  621. package/esm/typings/src/utils/normalization/nameToUriParts.d.ts +9 -0
  622. package/esm/typings/src/utils/normalization/nameToUriParts.test.d.ts +1 -0
  623. package/esm/typings/src/utils/normalization/normalize-to-kebab-case.d.ts +21 -0
  624. package/esm/typings/src/utils/normalization/normalize-to-kebab-case.test.d.ts +1 -0
  625. package/esm/typings/src/utils/normalization/normalizeTo_PascalCase.d.ts +17 -0
  626. package/esm/typings/src/utils/normalization/normalizeTo_PascalCase.test.d.ts +1 -0
  627. package/esm/typings/src/utils/normalization/normalizeTo_SCREAMING_CASE.d.ts +26 -0
  628. package/esm/typings/src/utils/normalization/normalizeTo_SCREAMING_CASE.test.d.ts +1 -0
  629. package/esm/typings/src/utils/normalization/normalizeTo_camelCase.d.ts +22 -0
  630. package/esm/typings/src/utils/normalization/normalizeTo_camelCase.test.d.ts +1 -0
  631. package/esm/typings/src/utils/normalization/normalizeTo_snake_case.d.ts +17 -0
  632. package/esm/typings/src/utils/normalization/normalizeTo_snake_case.test.d.ts +1 -0
  633. package/esm/typings/src/utils/normalization/normalizeWhitespaces.d.ts +6 -0
  634. package/esm/typings/src/utils/normalization/normalizeWhitespaces.test.d.ts +1 -0
  635. package/esm/typings/src/utils/normalization/orderJson.d.ts +21 -0
  636. package/esm/typings/src/utils/normalization/orderJson.test.d.ts +4 -0
  637. package/esm/typings/src/utils/normalization/parseKeywords.d.ts +16 -0
  638. package/esm/typings/src/utils/normalization/parseKeywords.test.d.ts +1 -0
  639. package/esm/typings/src/utils/normalization/parseKeywordsFromString.d.ts +9 -0
  640. package/esm/typings/src/utils/normalization/parseKeywordsFromString.test.d.ts +1 -0
  641. package/esm/typings/src/utils/normalization/removeDiacritics.d.ts +11 -0
  642. package/esm/typings/src/utils/normalization/removeDiacritics.test.d.ts +1 -0
  643. package/esm/typings/src/utils/normalization/searchKeywords.d.ts +13 -0
  644. package/esm/typings/src/utils/normalization/searchKeywords.test.d.ts +1 -0
  645. package/esm/typings/src/utils/normalization/suffixUrl.d.ts +7 -0
  646. package/esm/typings/src/utils/normalization/suffixUrl.test.d.ts +1 -0
  647. package/esm/typings/src/utils/normalization/titleToName.d.ts +9 -0
  648. package/esm/typings/src/utils/normalization/titleToName.test.d.ts +1 -0
  649. package/esm/typings/src/utils/organization/$sideEffect.d.ts +9 -0
  650. package/esm/typings/src/utils/organization/TODO_USE.d.ts +12 -0
  651. package/esm/typings/src/utils/organization/TODO_any.d.ts +6 -0
  652. package/esm/typings/src/utils/organization/TODO_narrow.d.ts +6 -0
  653. package/esm/typings/src/utils/organization/TODO_object.d.ts +6 -0
  654. package/esm/typings/src/utils/organization/TODO_remove_as.d.ts +6 -0
  655. package/esm/typings/src/utils/organization/TODO_string.d.ts +6 -0
  656. package/esm/typings/src/utils/organization/TODO_unknown.d.ts +6 -0
  657. package/esm/typings/src/utils/organization/___and___.d.ts +7 -0
  658. package/esm/typings/src/utils/organization/___or___.d.ts +6 -0
  659. package/esm/typings/src/utils/organization/empty_object.d.ts +10 -0
  660. package/esm/typings/src/utils/organization/just.d.ts +14 -0
  661. package/esm/typings/src/utils/organization/just_empty_object.d.ts +12 -0
  662. package/esm/typings/src/utils/organization/keepTypeImported.d.ts +9 -0
  663. package/esm/typings/src/utils/organization/keepUnused.d.ts +16 -0
  664. package/esm/typings/src/utils/organization/really_any.d.ts +6 -0
  665. package/esm/typings/src/utils/organization/really_unknown.d.ts +6 -0
  666. package/esm/typings/src/utils/organization/spaceTrim.d.ts +11 -0
  667. package/esm/typings/src/utils/parameters/extractParameterNames.d.ts +10 -0
  668. package/esm/typings/src/utils/parameters/extractParameterNames.test.d.ts +1 -0
  669. package/esm/typings/src/utils/parameters/mapAvailableToExpectedParameters.d.ts +27 -0
  670. package/esm/typings/src/utils/parameters/mapAvailableToExpectedParameters.test.d.ts +1 -0
  671. package/esm/typings/src/utils/parameters/numberToString.d.ts +7 -0
  672. package/esm/typings/src/utils/parameters/numberToString.test.d.ts +1 -0
  673. package/esm/typings/src/utils/parameters/templateParameters.d.ts +16 -0
  674. package/esm/typings/src/utils/parameters/templateParameters.test.d.ts +1 -0
  675. package/esm/typings/src/utils/parameters/valueToString.d.ts +17 -0
  676. package/esm/typings/src/utils/parameters/valueToString.test.d.ts +1 -0
  677. package/esm/typings/src/utils/parseNumber.d.ts +16 -0
  678. package/esm/typings/src/utils/parseNumber.test.d.ts +1 -0
  679. package/esm/typings/src/utils/random/$randomSeed.d.ts +10 -0
  680. package/esm/typings/src/utils/random/$randomToken.d.ts +13 -0
  681. package/esm/typings/src/utils/removeEmojis.d.ts +8 -0
  682. package/esm/typings/src/utils/removeEmojis.test.d.ts +1 -0
  683. package/esm/typings/src/utils/removeQuotes.d.ts +14 -0
  684. package/esm/typings/src/utils/removeQuotes.test.d.ts +1 -0
  685. package/esm/typings/src/utils/serialization/$deepFreeze.d.ts +14 -0
  686. package/esm/typings/src/utils/serialization/asSerializable.d.ts +15 -0
  687. package/esm/typings/src/utils/serialization/asSerializable.test.d.ts +1 -0
  688. package/esm/typings/src/utils/serialization/checkSerializableAsJson.d.ts +45 -0
  689. package/esm/typings/src/utils/serialization/clonePipeline.d.ts +14 -0
  690. package/esm/typings/src/utils/serialization/deepClone.d.ts +14 -0
  691. package/esm/typings/src/utils/serialization/deepClone.test.d.ts +1 -0
  692. package/esm/typings/src/utils/serialization/exportJson.d.ts +29 -0
  693. package/esm/typings/src/utils/serialization/isSerializableAsJson.d.ts +25 -0
  694. package/esm/typings/src/utils/serialization/isSerializableAsJson.test.d.ts +1 -0
  695. package/esm/typings/src/utils/serialization/jsonStringsToJsons.d.ts +9 -0
  696. package/esm/typings/src/utils/serialization/jsonStringsToJsons.test.d.ts +1 -0
  697. package/esm/typings/src/utils/sets/difference.d.ts +10 -0
  698. package/esm/typings/src/utils/sets/difference.test.d.ts +1 -0
  699. package/esm/typings/src/utils/sets/intersection.d.ts +7 -0
  700. package/esm/typings/src/utils/sets/intersection.test.d.ts +1 -0
  701. package/esm/typings/src/utils/sets/union.d.ts +7 -0
  702. package/esm/typings/src/utils/sets/union.test.d.ts +1 -0
  703. package/esm/typings/src/utils/trimCodeBlock.d.ts +9 -0
  704. package/esm/typings/src/utils/trimCodeBlock.test.d.ts +1 -0
  705. package/esm/typings/src/utils/trimEndOfCodeBlock.d.ts +9 -0
  706. package/esm/typings/src/utils/trimEndOfCodeBlock.test.d.ts +1 -0
  707. package/esm/typings/src/utils/unwrapResult.d.ts +37 -0
  708. package/esm/typings/src/utils/unwrapResult.test.d.ts +1 -0
  709. package/esm/typings/src/utils/validators/email/isValidEmail.d.ts +8 -0
  710. package/esm/typings/src/utils/validators/email/isValidEmail.test.d.ts +1 -0
  711. package/esm/typings/src/utils/validators/filePath/isRootPath.d.ts +12 -0
  712. package/esm/typings/src/utils/validators/filePath/isRootPath.test.d.ts +4 -0
  713. package/esm/typings/src/utils/validators/filePath/isValidFilePath.d.ts +12 -0
  714. package/esm/typings/src/utils/validators/filePath/isValidFilePath.test.d.ts +1 -0
  715. package/esm/typings/src/utils/validators/javascriptName/isValidJavascriptName.d.ts +10 -0
  716. package/esm/typings/src/utils/validators/javascriptName/isValidJavascriptName.test.d.ts +1 -0
  717. package/esm/typings/src/utils/validators/parameterName/validateParameterName.d.ts +11 -0
  718. package/esm/typings/src/utils/validators/parameterName/validateParameterName.test.d.ts +1 -0
  719. package/esm/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.d.ts +15 -0
  720. package/esm/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.test.d.ts +1 -0
  721. package/esm/typings/src/utils/validators/semanticVersion/isValidSemanticVersion.d.ts +12 -0
  722. package/esm/typings/src/utils/validators/semanticVersion/isValidSemanticVersion.test.d.ts +1 -0
  723. package/esm/typings/src/utils/validators/url/isHostnameOnPrivateNetwork.d.ts +11 -0
  724. package/esm/typings/src/utils/validators/url/isHostnameOnPrivateNetwork.test.d.ts +1 -0
  725. package/esm/typings/src/utils/validators/url/isUrlOnPrivateNetwork.d.ts +13 -0
  726. package/esm/typings/src/utils/validators/url/isUrlOnPrivateNetwork.test.d.ts +1 -0
  727. package/esm/typings/src/utils/validators/url/isValidPipelineUrl.d.ts +15 -0
  728. package/esm/typings/src/utils/validators/url/isValidPipelineUrl.test.d.ts +1 -0
  729. package/esm/typings/src/utils/validators/url/isValidUrl.d.ts +13 -0
  730. package/esm/typings/src/utils/validators/url/isValidUrl.test.d.ts +1 -0
  731. package/esm/typings/src/utils/validators/uuid/isValidUuid.d.ts +8 -0
  732. package/esm/typings/src/utils/validators/uuid/isValidUuid.test.d.ts +1 -0
  733. package/esm/typings/src/version.d.ts +26 -0
  734. package/esm/typings/src/wizard/$getCompiledBook.d.ts +16 -0
  735. package/esm/typings/src/wizard/wizard.d.ts +68 -0
  736. package/package.json +104 -0
  737. package/umd/index.umd.js +16694 -0
  738. package/umd/index.umd.js.map +1 -0
@@ -0,0 +1,65 @@
1
+ import type { ExecutionTools } from '../../execution/ExecutionTools';
2
+ import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
3
+ import type { string_dirname } from '../../types/typeAliases';
4
+ import type { string_pipeline_root_url } from '../../types/typeAliases';
5
+ import type { PipelineCollection } from '../PipelineCollection';
6
+ /**
7
+ * Options for `createCollectionFromDirectory` function
8
+ *
9
+ * Note: `rootDirname` is not needed because it is the folder in which `.book` or `.book` file is located
10
+ * This is not same as `path` which is the first argument of `createCollectionFromDirectory` - it can be a subfolder
11
+ */
12
+ type CreatePipelineCollectionFromDirectoryOptions = Omit<PrepareAndScrapeOptions, 'rootDirname'> & {
13
+ /**
14
+ * If true, the directory is searched recursively for pipelines
15
+ *
16
+ * @default true
17
+ */
18
+ isRecursive?: boolean;
19
+ /**
20
+ * If true, the collection creation outputs information about each file it reads
21
+ *
22
+ * @default false
23
+ */
24
+ isVerbose?: boolean;
25
+ /**
26
+ * This will be used as a root URL for all pipelines in the collection
27
+ *
28
+ * It has 2 purposes:
29
+ * 1) Every pipeline in the collection is checked if it is a child of `rootUrl`
30
+ * 2) If the pipeline does not have a URL, it is created from the `rootUrl` and path to the pipeline
31
+ *
32
+ * @default false
33
+ */
34
+ rootUrl?: string_pipeline_root_url;
35
+ /**
36
+ * If true, directory will be scanned only when needed not during the construction
37
+ *
38
+ * @default false
39
+ */
40
+ isLazyLoaded?: boolean;
41
+ /**
42
+ * If true, whole collection creation crashes on error in any pipeline
43
+ * If true and isLazyLoaded is true, the error is thrown on first access to the pipeline
44
+ *
45
+ * @default true
46
+ */
47
+ isCrashedOnError?: boolean;
48
+ };
49
+ /**
50
+ * Constructs Pipeline from given directory
51
+ *
52
+ * Note: Works only in Node.js environment because it reads the file system
53
+ *
54
+ * @param rootPath - path to the directory with pipelines
55
+ * @param tools - Execution tools to be used for pipeline preparation if needed - If not provided, `$provideExecutionToolsForNode` will be used
56
+ * @param options - Options for the collection creation
57
+ * @returns PipelineCollection
58
+ * @public exported from `@promptbook/node`
59
+ */
60
+ export declare function createCollectionFromDirectory(rootPath: string_dirname, tools?: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options?: CreatePipelineCollectionFromDirectoryOptions): Promise<PipelineCollection>;
61
+ export {};
62
+ /**
63
+ * TODO: [🖇] What about symlinks? Maybe option isSymlinksFollowed
64
+ * TODO: Maybe move from `@promptbook/node` to `@promptbook/core` as we removes direct dependency on `fs`
65
+ */
@@ -0,0 +1,13 @@
1
+ import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
2
+ import type { PipelineCollection } from '../PipelineCollection';
3
+ /**
4
+ * Creates PipelineCollection from array of PipelineJson or PipelineString
5
+ *
6
+ * Note: Functions `collectionToJson` and `createCollectionFromJson` are complementary
7
+ * Note: Syntax, parsing, and logic consistency checks are performed on all sources during build
8
+ *
9
+ * @param promptbookSources
10
+ * @returns PipelineCollection
11
+ * @public exported from `@promptbook/core`
12
+ */
13
+ export declare function createCollectionFromJson(...promptbooks: ReadonlyArray<PipelineJson>): PipelineCollection;
@@ -0,0 +1,23 @@
1
+ import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
2
+ import type { PipelineCollection } from '../PipelineCollection';
3
+ /**
4
+ * Constructs Promptbook from async sources
5
+ * It can be one of the following:
6
+ * - Promise of array of PipelineJson or PipelineString
7
+ * - Factory function that returns Promise of array of PipelineJson or PipelineString
8
+ *
9
+ * Note: This is useful as internal tool for other constructor functions like
10
+ * `createCollectionFromUrl` or `createCollectionFromDirectory`
11
+ * Consider using those functions instead of this one
12
+ *
13
+ * Note: The function does NOT return promise it returns the collection directly which waits for the sources to be resolved
14
+ * when error occurs in given promise or factory function, it is thrown during `listPipelines` or `getPipelineByUrl` call
15
+ *
16
+ * Note: Consider using `createCollectionFromDirectory` or `createCollectionFromUrl`
17
+ *
18
+ * @param promptbookSourcesPromiseOrFactory
19
+ * @returns PipelineCollection
20
+ * @deprecated Do not use, it will became internal tool for other constructor functions
21
+ * @public exported from `@promptbook/core`
22
+ */
23
+ export declare function createCollectionFromPromise(promptbookSourcesPromiseOrFactory: Promise<ReadonlyArray<PipelineJson>> | (() => Promise<ReadonlyArray<PipelineJson>>)): PipelineCollection;
@@ -0,0 +1,29 @@
1
+ import type { string_url } from '../../types/typeAliases';
2
+ import type { PipelineCollection } from '../PipelineCollection';
3
+ /**
4
+ * Options for `createCollectionFromDirectory` function
5
+ */
6
+ type CreatePipelineCollectionFromUrlyOptions = {
7
+ /**
8
+ * If true, the collection creation outputs information about each file it reads
9
+ *
10
+ * @default false
11
+ */
12
+ readonly isVerbose?: boolean;
13
+ /**
14
+ * If true, directory will be scanned only when needed not during the construction
15
+ *
16
+ * @default false
17
+ */
18
+ readonly isLazyLoaded?: boolean;
19
+ };
20
+ /**
21
+ * Constructs Promptbook from remote Promptbase URL
22
+ * @returns PipelineCollection
23
+ * @public exported from `@promptbook/core`
24
+ */
25
+ export declare function createCollectionFromUrl(url: string_url | URL, options: CreatePipelineCollectionFromUrlyOptions): Promise<PipelineCollection>;
26
+ export {};
27
+ /**
28
+ * TODO: [main] !!4 [🧠] Library precompilation and do not mix markdown and json promptbooks
29
+ */
@@ -0,0 +1,13 @@
1
+ import type { string_pipeline_url } from '../../types/typeAliases';
2
+ import type { PipelineCollection } from '../PipelineCollection';
3
+ /**
4
+ * Creates PipelineCollection as a subset of another PipelineCollection
5
+ *
6
+ * Note: You can use any type of collection as a parent collection - local, remote, etc.
7
+ * Note: This is just a thin wrapper / proxy around the parent collection
8
+ *
9
+ * @param promptbookSources
10
+ * @returns PipelineCollection
11
+ * @public exported from `@promptbook/core`
12
+ */
13
+ export declare function createSubcollection(collection: PipelineCollection, predicate: (url: string_pipeline_url) => boolean): PipelineCollection;
@@ -0,0 +1,11 @@
1
+ import type { string_semantic_version } from '../../types/typeAliases';
2
+ /**
3
+ * Parsed BOOK_VERSION command
4
+ *
5
+ * @see ./bookVersionCommandParser.ts for more details
6
+ * @public exported from `@promptbook/editable`
7
+ */
8
+ export type BookVersionCommand = {
9
+ readonly type: 'BOOK_VERSION';
10
+ readonly bookVersion: string_semantic_version;
11
+ };
@@ -0,0 +1,9 @@
1
+ import type { PipelineHeadCommandParser } from '../_common/types/CommandParser';
2
+ import type { BookVersionCommand } from './BookVersionCommand';
3
+ /**
4
+ * Parses the BOOK_VERSION command
5
+ *
6
+ * @see `documentationUrl` for more details
7
+ * @public exported from `@promptbook/editable`
8
+ */
9
+ export declare const bookVersionCommandParser: PipelineHeadCommandParser<BookVersionCommand>;
@@ -0,0 +1,17 @@
1
+ import type { ExpectationAmount } from '../../pipeline/PipelineJson/Expectations';
2
+ import type { ExpectationUnit } from '../../pipeline/PipelineJson/Expectations';
3
+ /**
4
+ * Expect amount command describes the desired output of the task (after post-processing)
5
+ * It can set limits for the maximum/minimum length of the output, measured in characters, words, sentences, paragraphs,...
6
+ *
7
+ * Note: LLMs work with tokens, not characters, but in Promptbooks we want to use some human-recognisable and cross-model interoperable units.
8
+ */
9
+ export type ExpectCommand = {
10
+ readonly type: 'EXPECT';
11
+ readonly sign: 'EXACTLY' | 'MINIMUM' | 'MAXIMUM';
12
+ readonly unit: ExpectationUnit;
13
+ readonly amount: ExpectationAmount;
14
+ };
15
+ /**
16
+ * TODO: [🍋] Allow to `EXPECT` relative amounts like `EXPECT MAX 130% {foo} Words`
17
+ */
@@ -0,0 +1,11 @@
1
+ import type { PipelineTaskCommandParser } from '../_common/types/CommandParser';
2
+ import type { ExpectCommand } from './ExpectCommand';
3
+ /**
4
+ import { WrappedError } from '../../errors/WrappedError';
5
+ import { assertsError } from '../../errors/assertsError';
6
+ * Parses the expect command
7
+ *
8
+ * @see `documentationUrl` for more details
9
+ * @public exported from `@promptbook/editable`
10
+ */
11
+ export declare const expectCommandParser: PipelineTaskCommandParser<ExpectCommand>;
@@ -0,0 +1,10 @@
1
+ import type { ForeachJson } from './ForeachJson';
2
+ /**
3
+ * Parsed FOREACH command which is used to iterate over a table of values
4
+ *
5
+ * @see ./foreachCommandParser.ts for more details
6
+ * @public exported from `@promptbook/editable`
7
+ */
8
+ export type ForeachCommand = {
9
+ readonly type: 'FOREACH';
10
+ } & ForeachJson;
@@ -0,0 +1,27 @@
1
+ import type { string_parameter_name } from '../../types/typeAliases';
2
+ import type { TODO_string } from '../../utils/organization/TODO_string';
3
+ /**
4
+ * Information for the FOREACH command, describing how to iterate over a parameter's subvalues in a pipeline task.
5
+ */
6
+ export type ForeachJson = {
7
+ /**
8
+ * The name of the format to use for parsing the parameter (e.g., 'CSV').
9
+ */
10
+ readonly formatName: TODO_string;
11
+ /**
12
+ * The name of the subformat to use (e.g., CSV Rows).
13
+ */
14
+ readonly subformatName: TODO_string;
15
+ /**
16
+ * The name of the parameter to iterate over.
17
+ */
18
+ readonly parameterName: string_parameter_name;
19
+ /**
20
+ * The names of the subparameters (e.g., name of the CSV rows)
21
+ */
22
+ readonly inputSubparameterNames: Array<string_parameter_name>;
23
+ /**
24
+ * The name of the subparameters (e.g., name of the CSV rows)
25
+ */
26
+ readonly outputSubparameterName: string_parameter_name;
27
+ };
@@ -0,0 +1,12 @@
1
+ import type { PipelineTaskCommandParser } from '../_common/types/CommandParser';
2
+ import type { ForeachCommand } from './ForeachCommand';
3
+ /**
4
+ * Parses the foreach command
5
+ *
6
+ * @see `documentationUrl` for more details
7
+ * @public exported from `@promptbook/editable`
8
+ */
9
+ export declare const foreachCommandParser: PipelineTaskCommandParser<ForeachCommand>;
10
+ /**
11
+ * TODO: [🍭] Make .book.md file with examples of the FOREACH with wrong parsing and logic
12
+ */
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Represents a command that expects a specific format.
3
+ *
4
+ * Note: [🚉] This is fully serializable as JSON
5
+ */
6
+ export type FormatCommand = {
7
+ readonly type: 'FORMAT';
8
+ readonly format: 'JSON';
9
+ };
@@ -0,0 +1,9 @@
1
+ import type { PipelineTaskCommandParser } from '../_common/types/CommandParser';
2
+ import type { FormatCommand } from './FormatCommand';
3
+ /**
4
+ * Parses the format command
5
+ *
6
+ * @see `documentationUrl` for more details
7
+ * @public exported from `@promptbook/editable`
8
+ */
9
+ export declare const formatCommandParser: PipelineTaskCommandParser<FormatCommand>;
@@ -0,0 +1,11 @@
1
+ import type { string_formfactor_name } from '../../formfactors/_common/string_formfactor_name';
2
+ /**
3
+ * Parsed FORMFACTOR command
4
+ *
5
+ * @see ./formfactorCommandParser.ts for more details
6
+ * @public exported from `@promptbook/editable`
7
+ */
8
+ export type FormfactorCommand = {
9
+ readonly type: 'FORMFACTOR';
10
+ readonly formfactorName: string_formfactor_name;
11
+ };
@@ -0,0 +1,11 @@
1
+ import type { PipelineHeadCommandParser } from '../_common/types/CommandParser';
2
+ import type { FormfactorCommand } from './FormfactorCommand';
3
+ /**
4
+ * Parses the formfactor command
5
+ *
6
+ * Note: This command is used as a formfactor for new commands and defines the app type format - it should NOT be used in any `.book` file
7
+ *
8
+ * @see `documentationUrl` for more details
9
+ * @public exported from `@promptbook/editable`
10
+ */
11
+ export declare const formfactorCommandParser: PipelineHeadCommandParser<FormfactorCommand>;
@@ -0,0 +1,11 @@
1
+ import type { string_name } from '../../types/typeAliases';
2
+ /**
3
+ * Parsed JOKER command
4
+ *
5
+ * @see ./jokerCommandParser.ts for more details
6
+ * @public exported from `@promptbook/editable`
7
+ */
8
+ export type JokerCommand = {
9
+ readonly type: 'JOKER';
10
+ readonly parameterName: string_name;
11
+ };
@@ -0,0 +1,9 @@
1
+ import type { PipelineTaskCommandParser } from '../_common/types/CommandParser';
2
+ import type { JokerCommand } from './JokerCommand';
3
+ /**
4
+ * Parses the joker command
5
+ *
6
+ * @see `documentationUrl` for more details
7
+ * @public exported from `@promptbook/editable`
8
+ */
9
+ export declare const jokerCommandParser: PipelineTaskCommandParser<JokerCommand>;
@@ -0,0 +1,11 @@
1
+ import type { string_knowledge_source_content } from '../../types/typeAliases';
2
+ /**
3
+ * Parsed KNOWLEDGE command
4
+ *
5
+ * @see ./knowledgeCommandParser.ts for more details
6
+ * @public exported from `@promptbook/editable`
7
+ */
8
+ export type KnowledgeCommand = {
9
+ readonly type: 'KNOWLEDGE';
10
+ readonly knowledgeSourceContent: string_knowledge_source_content;
11
+ };
@@ -0,0 +1,12 @@
1
+ import type { PipelineHeadCommandParser } from '../_common/types/CommandParser';
2
+ import type { KnowledgeCommand } from './KnowledgeCommand';
3
+ /**
4
+ * Parses the knowledge command
5
+ *
6
+ * @see `documentationUrl` for more details
7
+ * @public exported from `@promptbook/editable`
8
+ */
9
+ export declare const knowledgeCommandParser: PipelineHeadCommandParser<KnowledgeCommand>;
10
+ /**
11
+ * Note: [⛱] There are two types of KNOWLEDGE commands *...(read more in [⛱])*
12
+ */
@@ -0,0 +1,11 @@
1
+ import type { string_knowledge_source_content } from '../../../types/typeAliases';
2
+ import type { string_name } from '../../../types/typeAliases';
3
+ /**
4
+ * Creates unique name for the source
5
+ *
6
+ * @public exported from `@promptbook/editable`
7
+ */
8
+ export declare function knowledgeSourceContentToName(knowledgeSourceContent: string_knowledge_source_content): string_name;
9
+ /**
10
+ * TODO: [🐱‍🐉][🧠] Make some smart crop NOT source-i-m-pavol-a-develop-... BUT source-i-m-pavol-a-developer-...
11
+ */
@@ -0,0 +1,4 @@
1
+ export {};
2
+ /**
3
+ * TODO: [🐱‍🐉][🧠] Make some smart crop NOT source-i-m-pavol-a-develop-... BUT source-i-m-pavol-a-developer-...
4
+ */
@@ -0,0 +1,14 @@
1
+ import type { ModelRequirements } from '../../types/ModelRequirements';
2
+ import type { TODO_any } from '../../utils/organization/TODO_any';
3
+ /**
4
+ * Parsed MODEL command
5
+ *
6
+ * @see ./modelCommandParser.ts for more details
7
+ * @deprecated Option to manually set the model requirements is not recommended to use, use `PERSONA` instead
8
+ * @public exported from `@promptbook/editable`
9
+ */
10
+ export type ModelCommand = {
11
+ readonly type: 'MODEL';
12
+ readonly key: keyof ModelRequirements;
13
+ readonly value: TODO_any;
14
+ };
@@ -0,0 +1,10 @@
1
+ import type { PipelineBothCommandParser } from '../_common/types/CommandParser';
2
+ import type { ModelCommand } from './ModelCommand';
3
+ /**
4
+ * Parses the model command
5
+ *
6
+ * @see `documentationUrl` for more details
7
+ * @deprecated Option to manually set the model requirements is not recommended to use, use `PERSONA` instead
8
+ * @public exported from `@promptbook/editable`
9
+ */
10
+ export declare const modelCommandParser: PipelineBothCommandParser<ModelCommand>;
@@ -0,0 +1,15 @@
1
+ import type { string_markdown_text } from '../../types/typeAliases';
2
+ import type { string_name } from '../../types/typeAliases';
3
+ /**
4
+ * Parsed PARAMETER command
5
+ *
6
+ * @see ./parameterCommandParser.ts for more details
7
+ * @public exported from `@promptbook/editable`
8
+ */
9
+ export type ParameterCommand = {
10
+ readonly type: 'PARAMETER';
11
+ readonly isInput: boolean;
12
+ readonly isOutput: boolean;
13
+ readonly parameterName: string_name;
14
+ readonly parameterDescription: string_markdown_text | null;
15
+ };
@@ -0,0 +1,9 @@
1
+ import type { PipelineBothCommandParser } from '../_common/types/CommandParser';
2
+ import type { ParameterCommand } from './ParameterCommand';
3
+ /**
4
+ * Parses the parameter command
5
+ *
6
+ * @see `documentationUrl` for more details
7
+ * @public exported from `@promptbook/editable`
8
+ */
9
+ export declare const parameterCommandParser: PipelineBothCommandParser<ParameterCommand>;
@@ -0,0 +1,13 @@
1
+ import type { string_name } from '../../types/typeAliases';
2
+ import type { string_persona_description } from '../../types/typeAliases';
3
+ /**
4
+ * Parsed PERSONA command
5
+ *
6
+ * @see ./personaCommandParser.ts for more details
7
+ * @public exported from `@promptbook/editable`
8
+ */
9
+ export type PersonaCommand = {
10
+ readonly type: 'PERSONA';
11
+ readonly personaName: string_name;
12
+ readonly personaDescription: string_persona_description | null;
13
+ };
@@ -0,0 +1,9 @@
1
+ import type { PipelineBothCommandParser } from '../_common/types/CommandParser';
2
+ import type { PersonaCommand } from './PersonaCommand';
3
+ /**
4
+ * Parses the persona command
5
+ *
6
+ * @see `documentationUrl` for more details
7
+ * @public exported from `@promptbook/editable`
8
+ */
9
+ export declare const personaCommandParser: PipelineBothCommandParser<PersonaCommand>;
@@ -0,0 +1,11 @@
1
+ import type { string_name } from '../../types/typeAliases';
2
+ /**
3
+ * Parsed POSTPROCESS command
4
+ *
5
+ * @see ./postprocessCommandParser.ts for more details
6
+ * @public exported from `@promptbook/editable`
7
+ */
8
+ export type PostprocessCommand = {
9
+ readonly type: 'POSTPROCESS';
10
+ readonly functionName: string_name;
11
+ };
@@ -0,0 +1,9 @@
1
+ import type { PipelineTaskCommandParser } from '../_common/types/CommandParser';
2
+ import type { PostprocessCommand } from './PostprocessCommand';
3
+ /**
4
+ * Parses the postprocess command
5
+ *
6
+ * @see `documentationUrl` for more details
7
+ * @public exported from `@promptbook/editable`
8
+ */
9
+ export declare const postprocessCommandParser: PipelineTaskCommandParser<PostprocessCommand>;
@@ -0,0 +1,11 @@
1
+ import type { SectionType } from '../../types/SectionType';
2
+ /**
3
+ * Parsed SECTION command
4
+ *
5
+ * @see ./sectionCommandParser.ts for more details
6
+ * @public exported from `@promptbook/editable`
7
+ */
8
+ export type SectionCommand = {
9
+ readonly type: 'SECTION';
10
+ readonly taskType: SectionType;
11
+ };
@@ -0,0 +1,20 @@
1
+ import type { PipelineTaskCommandParser } from '../_common/types/CommandParser';
2
+ import type { SectionCommand } from './SectionCommand';
3
+ /**
4
+ * Parses the section command
5
+ *
6
+ * @see `documentationUrl` for more details
7
+ * @public exported from `@promptbook/editable`
8
+ */
9
+ export declare const sectionCommandParser: PipelineTaskCommandParser<SectionCommand>;
10
+ /**
11
+ * Note: [⛱] There are two types of KNOWLEDGE, ACTION and INSTRUMENT commands:
12
+ * 1) There are commands `KNOWLEDGE`, `ACTION` and `INSTRUMENT` used in the pipeline head, they just define the knowledge, action or instrument as single line after the command
13
+ * - KNOWLEDGE Look at https://en.wikipedia.org/wiki/Artificial_intelligence
14
+ * 2) `KNOWLEDGE SECTION` which has short form `KNOWLEDGE` is used in the sectiom, does not refer the line itself, but the content of the section block
15
+ * - KNOWLEDGE SECTION
16
+ *
17
+ * ```
18
+ * Look at https://en.wikipedia.org/wiki/Artificial_intelligence
19
+ * ```
20
+ */
@@ -0,0 +1,10 @@
1
+ /**
2
+ * Parsed URL command
3
+ *
4
+ * @see ./urlCommandParser.ts for more details
5
+ * @public exported from `@promptbook/editable`
6
+ */
7
+ export type UrlCommand = {
8
+ readonly type: 'URL';
9
+ readonly pipelineUrl: URL;
10
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,9 @@
1
+ import type { PipelineHeadCommandParser } from '../_common/types/CommandParser';
2
+ import type { UrlCommand } from './UrlCommand';
3
+ /**
4
+ * Parses the url command
5
+ *
6
+ * @see `documentationUrl` for more details
7
+ * @public exported from `@promptbook/editable`
8
+ */
9
+ export declare const urlCommandParser: PipelineHeadCommandParser<UrlCommand>;
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Parsed ACTION command
3
+ *
4
+ * @see ./actionCommandParser.ts for more details
5
+ * @public exported from `@promptbook/editable`
6
+ */
7
+ export type ActionCommand = {
8
+ readonly type: 'ACTION';
9
+ };
@@ -0,0 +1,12 @@
1
+ import type { PipelineHeadCommandParser } from '../_common/types/CommandParser';
2
+ import type { ActionCommand } from './ActionCommand';
3
+ /**
4
+ * Parses the action command
5
+ *
6
+ * @see `documentationUrl` for more details
7
+ * @public exported from `@promptbook/editable`
8
+ */
9
+ export declare const actionCommandParser: PipelineHeadCommandParser<ActionCommand>;
10
+ /**
11
+ * Note: [⛱] There are two types of ACTION commands *...(read more in [⛱])*
12
+ */
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Parsed INSTRUMENT command
3
+ *
4
+ * @see ./instrumentCommandParser.ts for more details
5
+ * @public exported from `@promptbook/editable`
6
+ */
7
+ export type InstrumentCommand = {
8
+ readonly type: 'INSTRUMENT';
9
+ };