@promptbook/javascript 0.88.0-1

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 (694) hide show
  1. package/README.md +431 -0
  2. package/esm/index.es.js +1796 -0
  3. package/esm/index.es.js.map +1 -0
  4. package/esm/typings/books/index.d.ts +131 -0
  5. package/esm/typings/src/_packages/anthropic-claude.index.d.ts +16 -0
  6. package/esm/typings/src/_packages/azure-openai.index.d.ts +10 -0
  7. package/esm/typings/src/_packages/browser.index.d.ts +10 -0
  8. package/esm/typings/src/_packages/cli.index.d.ts +56 -0
  9. package/esm/typings/src/_packages/core.index.d.ts +260 -0
  10. package/esm/typings/src/_packages/deepseek.index.d.ts +8 -0
  11. package/esm/typings/src/_packages/documents.index.d.ts +8 -0
  12. package/esm/typings/src/_packages/editable.index.d.ts +90 -0
  13. package/esm/typings/src/_packages/fake-llm.index.d.ts +6 -0
  14. package/esm/typings/src/_packages/google.index.d.ts +10 -0
  15. package/esm/typings/src/_packages/javascript.index.d.ts +10 -0
  16. package/esm/typings/src/_packages/legacy-documents.index.d.ts +8 -0
  17. package/esm/typings/src/_packages/markdown-utils.index.d.ts +48 -0
  18. package/esm/typings/src/_packages/markitdown.index.d.ts +8 -0
  19. package/esm/typings/src/_packages/node.index.d.ts +24 -0
  20. package/esm/typings/src/_packages/openai.index.d.ts +20 -0
  21. package/esm/typings/src/_packages/pdf.index.d.ts +14 -0
  22. package/esm/typings/src/_packages/remote-client.index.d.ts +18 -0
  23. package/esm/typings/src/_packages/remote-server.index.d.ts +12 -0
  24. package/esm/typings/src/_packages/templates.index.d.ts +4 -0
  25. package/esm/typings/src/_packages/types.index.d.ts +564 -0
  26. package/esm/typings/src/_packages/utils.index.d.ts +162 -0
  27. package/esm/typings/src/_packages/vercel.index.d.ts +6 -0
  28. package/esm/typings/src/_packages/website-crawler.index.d.ts +8 -0
  29. package/esm/typings/src/_packages/wizzard.index.d.ts +56 -0
  30. package/esm/typings/src/cli/cli-commands/_boilerplate.d.ts +13 -0
  31. package/esm/typings/src/cli/cli-commands/about.d.ts +14 -0
  32. package/esm/typings/src/cli/cli-commands/hello.d.ts +14 -0
  33. package/esm/typings/src/cli/cli-commands/list-models.d.ts +13 -0
  34. package/esm/typings/src/cli/cli-commands/list-scrapers.d.ts +13 -0
  35. package/esm/typings/src/cli/cli-commands/make.d.ts +16 -0
  36. package/esm/typings/src/cli/cli-commands/prettify.d.ts +15 -0
  37. package/esm/typings/src/cli/cli-commands/run.d.ts +17 -0
  38. package/esm/typings/src/cli/cli-commands/runInteractiveChatbot.d.ts +32 -0
  39. package/esm/typings/src/cli/cli-commands/start-server.d.ts +13 -0
  40. package/esm/typings/src/cli/cli-commands/test-command.d.ts +16 -0
  41. package/esm/typings/src/cli/main.d.ts +16 -0
  42. package/esm/typings/src/cli/promptbookCli.d.ts +13 -0
  43. package/esm/typings/src/cli/test/ptbk.d.ts +5 -0
  44. package/esm/typings/src/cli/test/ptbk.test.d.ts +1 -0
  45. package/esm/typings/src/cli/test/ptbk2.d.ts +5 -0
  46. package/esm/typings/src/collection/PipelineCollection.d.ts +27 -0
  47. package/esm/typings/src/collection/SimplePipelineCollection.d.ts +37 -0
  48. package/esm/typings/src/collection/collectionToJson.d.ts +13 -0
  49. package/esm/typings/src/collection/collectionToJson.test.d.ts +7 -0
  50. package/esm/typings/src/collection/constructors/createCollectionFromDirectory.d.ts +65 -0
  51. package/esm/typings/src/collection/constructors/createCollectionFromDirectory.test.d.ts +1 -0
  52. package/esm/typings/src/collection/constructors/createCollectionFromJson.d.ts +13 -0
  53. package/esm/typings/src/collection/constructors/createCollectionFromJson.test.d.ts +1 -0
  54. package/esm/typings/src/collection/constructors/createCollectionFromPromise.d.ts +23 -0
  55. package/esm/typings/src/collection/constructors/createCollectionFromPromise.test.d.ts +1 -0
  56. package/esm/typings/src/collection/constructors/createCollectionFromUrl.d.ts +29 -0
  57. package/esm/typings/src/collection/constructors/createSubcollection.d.ts +13 -0
  58. package/esm/typings/src/commands/BOOK_VERSION/BookVersionCommand.d.ts +11 -0
  59. package/esm/typings/src/commands/BOOK_VERSION/bookVersionCommand.test.d.ts +1 -0
  60. package/esm/typings/src/commands/BOOK_VERSION/bookVersionCommandParser.d.ts +9 -0
  61. package/esm/typings/src/commands/EXPECT/ExpectCommand.d.ts +17 -0
  62. package/esm/typings/src/commands/EXPECT/expectCommand.test.d.ts +1 -0
  63. package/esm/typings/src/commands/EXPECT/expectCommandParser.d.ts +9 -0
  64. package/esm/typings/src/commands/FOREACH/ForeachCommand.d.ts +10 -0
  65. package/esm/typings/src/commands/FOREACH/ForeachJson.d.ts +27 -0
  66. package/esm/typings/src/commands/FOREACH/foreachCommand.test.d.ts +1 -0
  67. package/esm/typings/src/commands/FOREACH/foreachCommandParser.d.ts +14 -0
  68. package/esm/typings/src/commands/FORMAT/FormatCommand.d.ts +9 -0
  69. package/esm/typings/src/commands/FORMAT/formatCommand.test.d.ts +1 -0
  70. package/esm/typings/src/commands/FORMAT/formatCommandParser.d.ts +9 -0
  71. package/esm/typings/src/commands/FORMFACTOR/FormfactorCommand.d.ts +11 -0
  72. package/esm/typings/src/commands/FORMFACTOR/formfactorCommand.test.d.ts +1 -0
  73. package/esm/typings/src/commands/FORMFACTOR/formfactorCommandParser.d.ts +11 -0
  74. package/esm/typings/src/commands/JOKER/JokerCommand.d.ts +11 -0
  75. package/esm/typings/src/commands/JOKER/jokerCommand.test.d.ts +1 -0
  76. package/esm/typings/src/commands/JOKER/jokerCommandParser.d.ts +9 -0
  77. package/esm/typings/src/commands/KNOWLEDGE/KnowledgeCommand.d.ts +11 -0
  78. package/esm/typings/src/commands/KNOWLEDGE/knowledgeCommand.test.d.ts +1 -0
  79. package/esm/typings/src/commands/KNOWLEDGE/knowledgeCommandParser.d.ts +12 -0
  80. package/esm/typings/src/commands/KNOWLEDGE/utils/knowledgeSourceContentToName.d.ts +11 -0
  81. package/esm/typings/src/commands/KNOWLEDGE/utils/knowledgeSourceContentToName.test.d.ts +4 -0
  82. package/esm/typings/src/commands/MODEL/ModelCommand.d.ts +14 -0
  83. package/esm/typings/src/commands/MODEL/modelCommand.test.d.ts +1 -0
  84. package/esm/typings/src/commands/MODEL/modelCommandParser.d.ts +10 -0
  85. package/esm/typings/src/commands/PARAMETER/ParameterCommand.d.ts +15 -0
  86. package/esm/typings/src/commands/PARAMETER/parameterCommand.test.d.ts +1 -0
  87. package/esm/typings/src/commands/PARAMETER/parameterCommandParser.d.ts +9 -0
  88. package/esm/typings/src/commands/PERSONA/PersonaCommand.d.ts +13 -0
  89. package/esm/typings/src/commands/PERSONA/personaCommand.test.d.ts +1 -0
  90. package/esm/typings/src/commands/PERSONA/personaCommandParser.d.ts +9 -0
  91. package/esm/typings/src/commands/POSTPROCESS/PostprocessCommand.d.ts +11 -0
  92. package/esm/typings/src/commands/POSTPROCESS/postprocessCommand.test.d.ts +1 -0
  93. package/esm/typings/src/commands/POSTPROCESS/postprocessCommandParser.d.ts +9 -0
  94. package/esm/typings/src/commands/SECTION/SectionCommand.d.ts +11 -0
  95. package/esm/typings/src/commands/SECTION/sectionCommand.test.d.ts +1 -0
  96. package/esm/typings/src/commands/SECTION/sectionCommandParser.d.ts +20 -0
  97. package/esm/typings/src/commands/URL/UrlCommand.d.ts +10 -0
  98. package/esm/typings/src/commands/URL/urlCommand.test.d.ts +1 -0
  99. package/esm/typings/src/commands/URL/urlCommandParser.d.ts +9 -0
  100. package/esm/typings/src/commands/X_ACTION/ActionCommand.d.ts +9 -0
  101. package/esm/typings/src/commands/X_ACTION/actionCommand.test.d.ts +1 -0
  102. package/esm/typings/src/commands/X_ACTION/actionCommandParser.d.ts +12 -0
  103. package/esm/typings/src/commands/X_INSTRUMENT/InstrumentCommand.d.ts +9 -0
  104. package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommand.test.d.ts +1 -0
  105. package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommandParser.d.ts +12 -0
  106. package/esm/typings/src/commands/_BOILERPLATE/BoilerplateCommand.d.ts +10 -0
  107. package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommand.test.d.ts +1 -0
  108. package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts +11 -0
  109. package/esm/typings/src/commands/_common/getParserForCommand.d.ts +11 -0
  110. package/esm/typings/src/commands/_common/getParserForCommand.test.d.ts +1 -0
  111. package/esm/typings/src/commands/_common/parseCommand.d.ts +12 -0
  112. package/esm/typings/src/commands/_common/parseCommand.test.d.ts +1 -0
  113. package/esm/typings/src/commands/_common/stringifyCommand.d.ts +12 -0
  114. package/esm/typings/src/commands/_common/stringifyCommand.test.d.ts +1 -0
  115. package/esm/typings/src/commands/_common/types/Command.d.ts +6 -0
  116. package/esm/typings/src/commands/_common/types/CommandParser.d.ts +197 -0
  117. package/esm/typings/src/commands/_common/types/CommandType.d.ts +17 -0
  118. package/esm/typings/src/commands/_common/types/CommandUsagePlaces.d.ts +13 -0
  119. package/esm/typings/src/commands/index.d.ts +9 -0
  120. package/esm/typings/src/config.d.ts +285 -0
  121. package/esm/typings/src/config.test.d.ts +4 -0
  122. package/esm/typings/src/constants.d.ts +35 -0
  123. package/esm/typings/src/conversion/archive/loadArchive.d.ts +16 -0
  124. package/esm/typings/src/conversion/archive/saveArchive.d.ts +18 -0
  125. package/esm/typings/src/conversion/compilePipeline.d.ts +25 -0
  126. package/esm/typings/src/conversion/compilePipeline.test.d.ts +1 -0
  127. package/esm/typings/src/conversion/compilePipelineOnRemoteServer.d.ts +21 -0
  128. package/esm/typings/src/conversion/parsePipeline.d.ts +30 -0
  129. package/esm/typings/src/conversion/parsePipeline.test.d.ts +1 -0
  130. package/esm/typings/src/conversion/pipelineJsonToString.d.ts +18 -0
  131. package/esm/typings/src/conversion/prettify/PrettifyOptions.d.ts +13 -0
  132. package/esm/typings/src/conversion/prettify/prettifyPipelineString.d.ts +12 -0
  133. package/esm/typings/src/conversion/prettify/renderPipelineMermaidOptions.d.ts +30 -0
  134. package/esm/typings/src/conversion/utils/extractParameterNamesFromTask.d.ts +15 -0
  135. package/esm/typings/src/conversion/utils/extractParameterNamesFromTask.test.d.ts +1 -0
  136. package/esm/typings/src/conversion/validation/_importPipeline.d.ts +23 -0
  137. package/esm/typings/src/conversion/validation/pipelineStringToJson-parseErrors.test.d.ts +4 -0
  138. package/esm/typings/src/conversion/validation/validatePipeline-logicErrors.test.d.ts +4 -0
  139. package/esm/typings/src/conversion/validation/validatePipeline.d.ts +42 -0
  140. package/esm/typings/src/conversion/validation/validatePipeline.test.d.ts +4 -0
  141. package/esm/typings/src/dialogs/callback/CallbackInterfaceTools.d.ts +17 -0
  142. package/esm/typings/src/dialogs/callback/CallbackInterfaceToolsOptions.d.ts +14 -0
  143. package/esm/typings/src/dialogs/simple-prompt/SimplePromptInterfaceTools.d.ts +22 -0
  144. package/esm/typings/src/dialogs/user-interface-execution-tools.test.d.ts +1 -0
  145. package/esm/typings/src/errors/0-BoilerplateError.d.ts +12 -0
  146. package/esm/typings/src/errors/0-index.d.ts +85 -0
  147. package/esm/typings/src/errors/AbstractFormatError.d.ts +11 -0
  148. package/esm/typings/src/errors/CollectionError.d.ts +9 -0
  149. package/esm/typings/src/errors/EnvironmentMismatchError.d.ts +9 -0
  150. package/esm/typings/src/errors/ExpectError.d.ts +12 -0
  151. package/esm/typings/src/errors/KnowledgeScrapeError.d.ts +9 -0
  152. package/esm/typings/src/errors/LimitReachedError.d.ts +9 -0
  153. package/esm/typings/src/errors/MissingToolsError.d.ts +9 -0
  154. package/esm/typings/src/errors/NotFoundError.d.ts +9 -0
  155. package/esm/typings/src/errors/NotYetImplementedError.d.ts +9 -0
  156. package/esm/typings/src/errors/ParseError.d.ts +12 -0
  157. package/esm/typings/src/errors/PipelineExecutionError.d.ts +9 -0
  158. package/esm/typings/src/errors/PipelineLogicError.d.ts +9 -0
  159. package/esm/typings/src/errors/PipelineUrlError.d.ts +9 -0
  160. package/esm/typings/src/errors/UnexpectedError.d.ts +9 -0
  161. package/esm/typings/src/errors/utils/ErrorJson.d.ts +20 -0
  162. package/esm/typings/src/errors/utils/deserializeError.d.ts +7 -0
  163. package/esm/typings/src/errors/utils/deserializeError.test.d.ts +1 -0
  164. package/esm/typings/src/errors/utils/getErrorReportUrl.d.ts +6 -0
  165. package/esm/typings/src/errors/utils/serializeError.d.ts +7 -0
  166. package/esm/typings/src/errors/utils/serializeError.test.d.ts +1 -0
  167. package/esm/typings/src/executables/$provideExecutablesForNode.d.ts +12 -0
  168. package/esm/typings/src/executables/apps/locateLibreoffice.d.ts +11 -0
  169. package/esm/typings/src/executables/apps/locateLibreoffice.test.d.ts +1 -0
  170. package/esm/typings/src/executables/apps/locatePandoc.d.ts +11 -0
  171. package/esm/typings/src/executables/apps/locatePandoc.test.d.ts +1 -0
  172. package/esm/typings/src/executables/locateApp.d.ts +33 -0
  173. package/esm/typings/src/executables/locateApp.test.d.ts +1 -0
  174. package/esm/typings/src/executables/platforms/locateAppOnLinux.d.ts +12 -0
  175. package/esm/typings/src/executables/platforms/locateAppOnMacOs.d.ts +12 -0
  176. package/esm/typings/src/executables/platforms/locateAppOnWindows.d.ts +12 -0
  177. package/esm/typings/src/execution/AbstractTaskResult.d.ts +25 -0
  178. package/esm/typings/src/execution/AvailableModel.d.ts +38 -0
  179. package/esm/typings/src/execution/CommonToolsOptions.d.ts +24 -0
  180. package/esm/typings/src/execution/EmbeddingVector.d.ts +8 -0
  181. package/esm/typings/src/execution/Executables.d.ts +18 -0
  182. package/esm/typings/src/execution/ExecutionTask.d.ts +75 -0
  183. package/esm/typings/src/execution/ExecutionTools.d.ts +69 -0
  184. package/esm/typings/src/execution/FilesystemTools.d.ts +9 -0
  185. package/esm/typings/src/execution/LlmExecutionTools.d.ts +61 -0
  186. package/esm/typings/src/execution/LlmExecutionToolsConstructor.d.ts +10 -0
  187. package/esm/typings/src/execution/PipelineExecutor.d.ts +16 -0
  188. package/esm/typings/src/execution/PipelineExecutorResult.d.ts +37 -0
  189. package/esm/typings/src/execution/PromptResult.d.ts +101 -0
  190. package/esm/typings/src/execution/PromptResultUsage.d.ts +33 -0
  191. package/esm/typings/src/execution/PromptbookFetch.d.ts +12 -0
  192. package/esm/typings/src/execution/PromptbookFetch.test-type.d.ts +5 -0
  193. package/esm/typings/src/execution/ScriptExecutionTools.d.ts +39 -0
  194. package/esm/typings/src/execution/UncertainNumber.d.ts +19 -0
  195. package/esm/typings/src/execution/UserInterfaceTools.d.ts +46 -0
  196. package/esm/typings/src/execution/assertsTaskSuccessful.d.ts +14 -0
  197. package/esm/typings/src/execution/createPipelineExecutor/$OngoingTaskResult.d.ts +45 -0
  198. package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorOptions.d.ts +46 -0
  199. package/esm/typings/src/execution/createPipelineExecutor/00-createPipelineExecutor.d.ts +10 -0
  200. package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts +45 -0
  201. package/esm/typings/src/execution/createPipelineExecutor/20-executeTask.d.ts +48 -0
  202. package/esm/typings/src/execution/createPipelineExecutor/30-executeFormatSubvalues.d.ts +15 -0
  203. package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +64 -0
  204. package/esm/typings/src/execution/createPipelineExecutor/filterJustOutputParameters.d.ts +34 -0
  205. package/esm/typings/src/execution/createPipelineExecutor/getContextForTask.d.ts +10 -0
  206. package/esm/typings/src/execution/createPipelineExecutor/getExamplesForTask.d.ts +10 -0
  207. package/esm/typings/src/execution/createPipelineExecutor/getKnowledgeForTask.d.ts +27 -0
  208. package/esm/typings/src/execution/createPipelineExecutor/getReservedParametersForTask.d.ts +30 -0
  209. package/esm/typings/src/execution/embeddingVectorToString.d.ts +7 -0
  210. package/esm/typings/src/execution/execution-report/ExecutionPromptReportJson.d.ts +24 -0
  211. package/esm/typings/src/execution/execution-report/ExecutionReportJson.d.ts +41 -0
  212. package/esm/typings/src/execution/execution-report/ExecutionReportString.d.ts +16 -0
  213. package/esm/typings/src/execution/execution-report/ExecutionReportStringOptions.d.ts +25 -0
  214. package/esm/typings/src/execution/execution-report/countWorkingDuration.d.ts +7 -0
  215. package/esm/typings/src/execution/execution-report/countWorkingDuration.test.d.ts +1 -0
  216. package/esm/typings/src/execution/execution-report/executionReportJsonToString.d.ts +15 -0
  217. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/AutomaticTranslator.d.ts +7 -0
  218. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/DebugAutomaticTranslator.d.ts +11 -0
  219. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/FakeAutomaticTranslator.d.ts +8 -0
  220. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/LindatAutomaticTranslator.d.ts +22 -0
  221. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/TranslatorOptions.d.ts +7 -0
  222. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.d.ts +8 -0
  223. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.test.d.ts +1 -0
  224. package/esm/typings/src/execution/translation/automatic-translate/translateMessages.d.ts +12 -0
  225. package/esm/typings/src/execution/utils/$provideExecutionToolsForNode.d.ts +13 -0
  226. package/esm/typings/src/execution/utils/addUsage.d.ts +9 -0
  227. package/esm/typings/src/execution/utils/addUsage.test.d.ts +1 -0
  228. package/esm/typings/src/execution/utils/checkExpectations.d.ts +29 -0
  229. package/esm/typings/src/execution/utils/checkExpectations.test.d.ts +1 -0
  230. package/esm/typings/src/execution/utils/computeUsageCounts.d.ts +10 -0
  231. package/esm/typings/src/execution/utils/forEachAsync.d.ts +20 -0
  232. package/esm/typings/src/execution/utils/uncertainNumber.d.ts +9 -0
  233. package/esm/typings/src/execution/utils/usage-constants.d.ts +130 -0
  234. package/esm/typings/src/execution/utils/usageToHuman.d.ts +26 -0
  235. package/esm/typings/src/execution/utils/usageToWorktime.d.ts +20 -0
  236. package/esm/typings/src/execution/utils/usageToWorktime.test.d.ts +1 -0
  237. package/esm/typings/src/expectations/drafts/isDomainNameFree.d.ts +10 -0
  238. package/esm/typings/src/expectations/drafts/isGithubNameFree.d.ts +10 -0
  239. package/esm/typings/src/formats/_common/FormatDefinition.d.ts +70 -0
  240. package/esm/typings/src/formats/_common/FormatSubvalueDefinition.d.ts +31 -0
  241. package/esm/typings/src/formats/csv/CsvFormatDefinition.d.ts +17 -0
  242. package/esm/typings/src/formats/csv/CsvFormatError.d.ts +10 -0
  243. package/esm/typings/src/formats/csv/CsvSettings.d.ts +13 -0
  244. package/esm/typings/src/formats/index.d.ts +9 -0
  245. package/esm/typings/src/formats/json/JsonFormatDefinition.d.ts +19 -0
  246. package/esm/typings/src/formats/json/utils/isValidJsonString.d.ts +6 -0
  247. package/esm/typings/src/formats/json/utils/isValidJsonString.test.d.ts +1 -0
  248. package/esm/typings/src/formats/text/TextFormatDefinition.d.ts +19 -0
  249. package/esm/typings/src/formats/xml/XmlFormatDefinition.d.ts +19 -0
  250. package/esm/typings/src/formfactors/_boilerplate/BoilerplateFormfactorDefinition.d.ts +14 -0
  251. package/esm/typings/src/formfactors/_common/AbstractFormfactorDefinition.d.ts +40 -0
  252. package/esm/typings/src/formfactors/_common/FormfactorDefinition.d.ts +8 -0
  253. package/esm/typings/src/formfactors/_common/string_formfactor_name.d.ts +5 -0
  254. package/esm/typings/src/formfactors/chatbot/ChatbotFormfactorDefinition.d.ts +45 -0
  255. package/esm/typings/src/formfactors/generator/GeneratorFormfactorDefinition.d.ts +24 -0
  256. package/esm/typings/src/formfactors/generic/GenericFormfactorDefinition.d.ts +14 -0
  257. package/esm/typings/src/formfactors/image-generator/ImageGeneratorFormfactorDefinition.d.ts +24 -0
  258. package/esm/typings/src/formfactors/index.d.ts +145 -0
  259. package/esm/typings/src/formfactors/matcher/MatcherFormfactorDefinition.d.ts +19 -0
  260. package/esm/typings/src/formfactors/sheets/SheetsFormfactorDefinition.d.ts +25 -0
  261. package/esm/typings/src/formfactors/translator/TranslatorFormfactorDefinition.d.ts +24 -0
  262. package/esm/typings/src/high-level-abstractions/_common/HighLevelAbstraction.d.ts +20 -0
  263. package/esm/typings/src/high-level-abstractions/implicit-formfactor/ImplicitFormfactorHla.d.ts +10 -0
  264. package/esm/typings/src/high-level-abstractions/index.d.ts +54 -0
  265. package/esm/typings/src/high-level-abstractions/quick-chatbot/QuickChatbotHla.d.ts +13 -0
  266. package/esm/typings/src/llm-providers/_common/register/$llmToolsMetadataRegister.d.ts +13 -0
  267. package/esm/typings/src/llm-providers/_common/register/$llmToolsRegister.d.ts +13 -0
  268. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsConfigurationFromEnv.d.ts +25 -0
  269. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForTestingAndScriptsAndPlayground.d.ts +24 -0
  270. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForWizzardOrCli.d.ts +15 -0
  271. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsFromEnv.d.ts +27 -0
  272. package/esm/typings/src/llm-providers/_common/register/$registeredLlmToolsMessage.d.ts +22 -0
  273. package/esm/typings/src/llm-providers/_common/register/LlmToolsConfiguration.d.ts +23 -0
  274. package/esm/typings/src/llm-providers/_common/register/LlmToolsMetadata.d.ts +36 -0
  275. package/esm/typings/src/llm-providers/_common/register/LlmToolsOptions.d.ts +10 -0
  276. package/esm/typings/src/llm-providers/_common/register/createLlmToolsFromConfiguration.d.ts +40 -0
  277. package/esm/typings/src/llm-providers/_common/register/createLlmToolsFromConfiguration.test.d.ts +1 -0
  278. package/esm/typings/src/llm-providers/_common/utils/cache/CacheItem.d.ts +28 -0
  279. package/esm/typings/src/llm-providers/_common/utils/cache/CacheLlmToolsOptions.d.ts +19 -0
  280. package/esm/typings/src/llm-providers/_common/utils/cache/cacheLlmTools.d.ts +19 -0
  281. package/esm/typings/src/llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage.d.ts +15 -0
  282. package/esm/typings/src/llm-providers/_common/utils/count-total-usage/countTotalUsage.d.ts +17 -0
  283. package/esm/typings/src/llm-providers/_common/utils/count-total-usage/limitTotalUsage.d.ts +36 -0
  284. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +60 -0
  285. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions.d.ts +31 -0
  286. package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +24 -0
  287. package/esm/typings/src/llm-providers/anthropic-claude/computeAnthropicClaudeUsage.d.ts +18 -0
  288. package/esm/typings/src/llm-providers/anthropic-claude/computeAnthropicClaudeUsage.test.d.ts +4 -0
  289. package/esm/typings/src/llm-providers/anthropic-claude/createAnthropicClaudeExecutionTools.d.ts +19 -0
  290. package/esm/typings/src/llm-providers/anthropic-claude/playground/playground.d.ts +7 -0
  291. package/esm/typings/src/llm-providers/anthropic-claude/register-configuration.d.ts +14 -0
  292. package/esm/typings/src/llm-providers/anthropic-claude/register-constructor.d.ts +16 -0
  293. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +63 -0
  294. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionToolsOptions.d.ts +37 -0
  295. package/esm/typings/src/llm-providers/azure-openai/createAzureOpenAiExecutionTools.d.ts +15 -0
  296. package/esm/typings/src/llm-providers/azure-openai/playground/playground.d.ts +6 -0
  297. package/esm/typings/src/llm-providers/azure-openai/register-configuration.d.ts +14 -0
  298. package/esm/typings/src/llm-providers/azure-openai/register-constructor.d.ts +15 -0
  299. package/esm/typings/src/llm-providers/deepseek/DeepseekExecutionToolsOptions.d.ts +9 -0
  300. package/esm/typings/src/llm-providers/deepseek/createDeepseekExecutionTools.d.ts +14 -0
  301. package/esm/typings/src/llm-providers/deepseek/register-configuration.d.ts +14 -0
  302. package/esm/typings/src/llm-providers/deepseek/register-constructor.d.ts +15 -0
  303. package/esm/typings/src/llm-providers/google/GoogleExecutionToolsOptions.d.ts +9 -0
  304. package/esm/typings/src/llm-providers/google/createGoogleExecutionTools.d.ts +14 -0
  305. package/esm/typings/src/llm-providers/google/register-configuration.d.ts +14 -0
  306. package/esm/typings/src/llm-providers/google/register-constructor.d.ts +15 -0
  307. package/esm/typings/src/llm-providers/mocked/$fakeTextToExpectations.d.ts +15 -0
  308. package/esm/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts +40 -0
  309. package/esm/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts +44 -0
  310. package/esm/typings/src/llm-providers/mocked/test/fakeTextToExpectations.test.d.ts +1 -0
  311. package/esm/typings/src/llm-providers/mocked/test/faked-completion.test.d.ts +1 -0
  312. package/esm/typings/src/llm-providers/mocked/test/joker.test.d.ts +4 -0
  313. package/esm/typings/src/llm-providers/mocked/test/mocked-chat.test.d.ts +5 -0
  314. package/esm/typings/src/llm-providers/mocked/test/mocked-completion.test.d.ts +4 -0
  315. package/esm/typings/src/llm-providers/multiple/MultipleLlmExecutionTools.d.ts +63 -0
  316. package/esm/typings/src/llm-providers/multiple/joinLlmExecutionTools.d.ts +21 -0
  317. package/esm/typings/src/llm-providers/multiple/playground/playground.d.ts +5 -0
  318. package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionTools.d.ts +36 -0
  319. package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionToolsOptions.d.ts +14 -0
  320. package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +84 -0
  321. package/esm/typings/src/llm-providers/openai/OpenAiExecutionToolsOptions.d.ts +11 -0
  322. package/esm/typings/src/llm-providers/openai/computeOpenAiUsage.d.ts +18 -0
  323. package/esm/typings/src/llm-providers/openai/computeOpenAiUsage.test.d.ts +4 -0
  324. package/esm/typings/src/llm-providers/openai/computeUsage.d.ts +16 -0
  325. package/esm/typings/src/llm-providers/openai/computeUsage.test.d.ts +1 -0
  326. package/esm/typings/src/llm-providers/openai/createOpenAiAssistantExecutionTools.d.ts +15 -0
  327. package/esm/typings/src/llm-providers/openai/createOpenAiExecutionTools.d.ts +15 -0
  328. package/esm/typings/src/llm-providers/openai/openai-models.d.ts +31 -0
  329. package/esm/typings/src/llm-providers/openai/playground/playground.d.ts +6 -0
  330. package/esm/typings/src/llm-providers/openai/register-configuration.d.ts +24 -0
  331. package/esm/typings/src/llm-providers/openai/register-constructor.d.ts +25 -0
  332. package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts +59 -0
  333. package/esm/typings/src/llm-providers/remote/playground/playground.d.ts +5 -0
  334. package/esm/typings/src/llm-providers/vercel/VercelExecutionToolsOptions.d.ts +23 -0
  335. package/esm/typings/src/llm-providers/vercel/VercelProvider.d.ts +13 -0
  336. package/esm/typings/src/llm-providers/vercel/createExecutionToolsFromVercelProvider.d.ts +8 -0
  337. package/esm/typings/src/llm-providers/vercel/playground/playground.d.ts +6 -0
  338. package/esm/typings/src/other/templates/getBookTemplates.d.ts +24 -0
  339. package/esm/typings/src/other/templates/getTemplatesPipelineCollection.d.ts +10 -0
  340. package/esm/typings/src/personas/preparePersona.d.ts +17 -0
  341. package/esm/typings/src/pipeline/PipelineInterface/PipelineInterface.d.ts +22 -0
  342. package/esm/typings/src/pipeline/PipelineInterface/constants.d.ts +14 -0
  343. package/esm/typings/src/pipeline/PipelineInterface/getPipelineInterface.d.ts +11 -0
  344. package/esm/typings/src/pipeline/PipelineInterface/isPipelineImplementingInterface.d.ts +26 -0
  345. package/esm/typings/src/pipeline/PipelineInterface/isPipelineInterfacesEqual.d.ts +10 -0
  346. package/esm/typings/src/pipeline/PipelineJson/CommonTaskJson.d.ts +100 -0
  347. package/esm/typings/src/pipeline/PipelineJson/DialogTaskJson.d.ts +13 -0
  348. package/esm/typings/src/pipeline/PipelineJson/Expectations.d.ts +40 -0
  349. package/esm/typings/src/pipeline/PipelineJson/KnowledgePieceJson.d.ts +73 -0
  350. package/esm/typings/src/pipeline/PipelineJson/KnowledgeSourceJson.d.ts +44 -0
  351. package/esm/typings/src/pipeline/PipelineJson/ParameterJson.d.ts +98 -0
  352. package/esm/typings/src/pipeline/PipelineJson/PersonaJson.d.ts +45 -0
  353. package/esm/typings/src/pipeline/PipelineJson/PipelineJson.d.ts +112 -0
  354. package/esm/typings/src/pipeline/PipelineJson/PreparationJson.d.ts +22 -0
  355. package/esm/typings/src/pipeline/PipelineJson/PromptTaskJson.d.ts +26 -0
  356. package/esm/typings/src/pipeline/PipelineJson/ScriptTaskJson.d.ts +20 -0
  357. package/esm/typings/src/pipeline/PipelineJson/SimpleTaskJson.d.ts +13 -0
  358. package/esm/typings/src/pipeline/PipelineJson/TaskJson.d.ts +11 -0
  359. package/esm/typings/src/pipeline/PipelineString.d.ts +9 -0
  360. package/esm/typings/src/pipeline/book-notation.d.ts +19 -0
  361. package/esm/typings/src/pipeline/isValidPipelineString.d.ts +13 -0
  362. package/esm/typings/src/pipeline/isValidPipelineString.test.d.ts +4 -0
  363. package/esm/typings/src/pipeline/prompt-notation.d.ts +31 -0
  364. package/esm/typings/src/pipeline/prompt-notation.test.d.ts +4 -0
  365. package/esm/typings/src/pipeline/validatePipelineString.d.ts +14 -0
  366. package/esm/typings/src/postprocessing/utils/extractBlock.d.ts +16 -0
  367. package/esm/typings/src/postprocessing/utils/extractJsonBlock.d.ts +25 -0
  368. package/esm/typings/src/postprocessing/utils/extractJsonBlock.test.d.ts +1 -0
  369. package/esm/typings/src/prepare/PrepareAndScrapeOptions.d.ts +51 -0
  370. package/esm/typings/src/prepare/isPipelinePrepared.d.ts +18 -0
  371. package/esm/typings/src/prepare/isPipelinePrepared.test.d.ts +1 -0
  372. package/esm/typings/src/prepare/preparePipeline.d.ts +22 -0
  373. package/esm/typings/src/prepare/preparePipelineOnRemoteServer.d.ts +17 -0
  374. package/esm/typings/src/prepare/prepareTasks.d.ts +33 -0
  375. package/esm/typings/src/prepare/unpreparePipeline.d.ts +13 -0
  376. package/esm/typings/src/remote-server/createRemoteClient.d.ts +10 -0
  377. package/esm/typings/src/remote-server/socket-types/_common/PromptbookServer_Error.d.ts +7 -0
  378. package/esm/typings/src/remote-server/socket-types/_subtypes/PromptbookServer_Identification.d.ts +52 -0
  379. package/esm/typings/src/remote-server/socket-types/listModels/PromptbookServer_ListModels_Request.d.ts +17 -0
  380. package/esm/typings/src/remote-server/socket-types/listModels/PromptbookServer_ListModels_Response.d.ts +17 -0
  381. package/esm/typings/src/remote-server/socket-types/prepare/PromptbookServer_PreparePipeline_Request.d.ts +17 -0
  382. package/esm/typings/src/remote-server/socket-types/prepare/PromptbookServer_PreparePipeline_Response.d.ts +12 -0
  383. package/esm/typings/src/remote-server/socket-types/prompt/PromptbookServer_Prompt_Request.d.ts +17 -0
  384. package/esm/typings/src/remote-server/socket-types/prompt/PromptbookServer_Prompt_Response.d.ts +12 -0
  385. package/esm/typings/src/remote-server/startRemoteServer.d.ts +26 -0
  386. package/esm/typings/src/remote-server/types/RemoteClientOptions.d.ts +32 -0
  387. package/esm/typings/src/remote-server/types/RemoteServerOptions.d.ts +75 -0
  388. package/esm/typings/src/scrapers/_boilerplate/BoilerplateScraper.d.ts +43 -0
  389. package/esm/typings/src/scrapers/_boilerplate/createBoilerplateScraper.d.ts +20 -0
  390. package/esm/typings/src/scrapers/_boilerplate/playground/boilerplate-scraper-playground.d.ts +5 -0
  391. package/esm/typings/src/scrapers/_boilerplate/register-constructor.d.ts +15 -0
  392. package/esm/typings/src/scrapers/_boilerplate/register-metadata.d.ts +28 -0
  393. package/esm/typings/src/scrapers/_common/Converter.d.ts +23 -0
  394. package/esm/typings/src/scrapers/_common/Scraper.d.ts +59 -0
  395. package/esm/typings/src/scrapers/_common/ScraperIntermediateSource.d.ts +14 -0
  396. package/esm/typings/src/scrapers/_common/prepareKnowledgePieces.d.ts +19 -0
  397. package/esm/typings/src/scrapers/_common/prepareKnowledgePieces.test.d.ts +1 -0
  398. package/esm/typings/src/scrapers/_common/register/$provideFilesystemForNode.d.ts +11 -0
  399. package/esm/typings/src/scrapers/_common/register/$provideScrapersForBrowser.d.ts +12 -0
  400. package/esm/typings/src/scrapers/_common/register/$provideScrapersForNode.d.ts +15 -0
  401. package/esm/typings/src/scrapers/_common/register/$provideScriptingForNode.d.ts +11 -0
  402. package/esm/typings/src/scrapers/_common/register/$registeredScrapersMessage.d.ts +13 -0
  403. package/esm/typings/src/scrapers/_common/register/$scrapersMetadataRegister.d.ts +13 -0
  404. package/esm/typings/src/scrapers/_common/register/$scrapersRegister.d.ts +13 -0
  405. package/esm/typings/src/scrapers/_common/register/ScraperAndConverterMetadata.d.ts +43 -0
  406. package/esm/typings/src/scrapers/_common/register/ScraperConstructor.d.ts +12 -0
  407. package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.d.ts +34 -0
  408. package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.test.d.ts +4 -0
  409. package/esm/typings/src/scrapers/_common/utils/makeKnowledgeSourceHandler.d.ts +11 -0
  410. package/esm/typings/src/scrapers/_common/utils/scraperFetch.d.ts +10 -0
  411. package/esm/typings/src/scrapers/document/DocumentScraper.d.ts +43 -0
  412. package/esm/typings/src/scrapers/document/DocumentScraper.test.d.ts +4 -0
  413. package/esm/typings/src/scrapers/document/createDocumentScraper.d.ts +20 -0
  414. package/esm/typings/src/scrapers/document/playground/document-scraper-playground.d.ts +5 -0
  415. package/esm/typings/src/scrapers/document/register-constructor.d.ts +15 -0
  416. package/esm/typings/src/scrapers/document/register-metadata.d.ts +28 -0
  417. package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.d.ts +43 -0
  418. package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.test.d.ts +4 -0
  419. package/esm/typings/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts +20 -0
  420. package/esm/typings/src/scrapers/document-legacy/playground/legacy-document-scraper-playground.d.ts +5 -0
  421. package/esm/typings/src/scrapers/document-legacy/register-constructor.d.ts +15 -0
  422. package/esm/typings/src/scrapers/document-legacy/register-metadata.d.ts +28 -0
  423. package/esm/typings/src/scrapers/markdown/MarkdownScraper.d.ts +29 -0
  424. package/esm/typings/src/scrapers/markdown/MarkdownScraper.test.d.ts +4 -0
  425. package/esm/typings/src/scrapers/markdown/createMarkdownScraper.d.ts +20 -0
  426. package/esm/typings/src/scrapers/markdown/playground/markdown-scraper-playground.d.ts +5 -0
  427. package/esm/typings/src/scrapers/markdown/register-constructor.d.ts +15 -0
  428. package/esm/typings/src/scrapers/markdown/register-metadata.d.ts +28 -0
  429. package/esm/typings/src/scrapers/markitdown/MarkitdownScraper.d.ts +50 -0
  430. package/esm/typings/src/scrapers/markitdown/createMarkitdownScraper.d.ts +22 -0
  431. package/esm/typings/src/scrapers/markitdown/playground/markitdown-scraper-playground.d.ts +5 -0
  432. package/esm/typings/src/scrapers/markitdown/register-constructor.d.ts +17 -0
  433. package/esm/typings/src/scrapers/markitdown/register-metadata.d.ts +28 -0
  434. package/esm/typings/src/scrapers/pdf/PdfScraper.d.ts +41 -0
  435. package/esm/typings/src/scrapers/pdf/createPdfScraper.d.ts +20 -0
  436. package/esm/typings/src/scrapers/pdf/playground/pdf-scraper-playground.d.ts +5 -0
  437. package/esm/typings/src/scrapers/pdf/register-constructor.d.ts +15 -0
  438. package/esm/typings/src/scrapers/pdf/register-metadata.d.ts +28 -0
  439. package/esm/typings/src/scrapers/website/WebsiteScraper.d.ts +50 -0
  440. package/esm/typings/src/scrapers/website/createWebsiteScraper.d.ts +22 -0
  441. package/esm/typings/src/scrapers/website/playground/website-scraper-playground.d.ts +5 -0
  442. package/esm/typings/src/scrapers/website/register-constructor.d.ts +15 -0
  443. package/esm/typings/src/scrapers/website/register-metadata.d.ts +28 -0
  444. package/esm/typings/src/scrapers/website/utils/createShowdownConverter.d.ts +7 -0
  445. package/esm/typings/src/scrapers/website/utils/createShowdownConverter.test.d.ts +1 -0
  446. package/esm/typings/src/scripting/_test/custom-function-async.test.ts.test.d.ts +1 -0
  447. package/esm/typings/src/scripting/_test/custom-function-missing.test.d.ts +1 -0
  448. package/esm/typings/src/scripting/_test/custom-function-with-dependencies.test.d.ts +1 -0
  449. package/esm/typings/src/scripting/_test/custom-function.test.d.ts +1 -0
  450. package/esm/typings/src/scripting/_test/postprocessing.test.d.ts +1 -0
  451. package/esm/typings/src/scripting/_test/script-execution-errors.test.d.ts +1 -0
  452. package/esm/typings/src/scripting/_test/script-execution-tools.test.d.ts +1 -0
  453. package/esm/typings/src/scripting/javascript/JavascriptEvalExecutionTools.d.ts +22 -0
  454. package/esm/typings/src/scripting/javascript/JavascriptEvalExecutionTools.test.d.ts +4 -0
  455. package/esm/typings/src/scripting/javascript/JavascriptExecutionTools.d.ts +8 -0
  456. package/esm/typings/src/scripting/javascript/JavascriptExecutionToolsOptions.d.ts +26 -0
  457. package/esm/typings/src/scripting/javascript/postprocessing-functions.d.ts +52 -0
  458. package/esm/typings/src/scripting/javascript/utils/extractVariablesFromJavascript.d.ts +14 -0
  459. package/esm/typings/src/scripting/javascript/utils/extractVariablesFromJavascript.test.d.ts +1 -0
  460. package/esm/typings/src/scripting/javascript/utils/extractVariablesFromScript.test.d.ts +1 -0
  461. package/esm/typings/src/scripting/javascript/utils/preserve.d.ts +14 -0
  462. package/esm/typings/src/scripting/python/PythonExecutionTools.d.ts +18 -0
  463. package/esm/typings/src/scripting/typescript/TypescriptExecutionTools.d.ts +18 -0
  464. package/esm/typings/src/storage/_common/PromptbookStorage.d.ts +24 -0
  465. package/esm/typings/src/storage/_common/PromptbookStorage.test-type.d.ts +5 -0
  466. package/esm/typings/src/storage/blackhole/BlackholeStorage.d.ts +33 -0
  467. package/esm/typings/src/storage/file-cache-storage/FileCacheStorage.d.ts +33 -0
  468. package/esm/typings/src/storage/file-cache-storage/FileCacheStorageOptions.d.ts +10 -0
  469. package/esm/typings/src/storage/file-cache-storage/utils/nameToSubfolderPath.d.ts +7 -0
  470. package/esm/typings/src/storage/file-cache-storage/utils/nameToSubfolderPath.test.d.ts +1 -0
  471. package/esm/typings/src/storage/local-storage/getLocalStorage.d.ts +10 -0
  472. package/esm/typings/src/storage/local-storage/getSessionStorage.d.ts +10 -0
  473. package/esm/typings/src/storage/local-storage/utils/makePromptbookStorageFromWebStorage.d.ts +11 -0
  474. package/esm/typings/src/storage/memory/MemoryStorage.d.ts +33 -0
  475. package/esm/typings/src/storage/utils/PrefixStorage.d.ts +25 -0
  476. package/esm/typings/src/types/Arrayable.d.ts +11 -0
  477. package/esm/typings/src/types/IntermediateFilesStrategy.d.ts +7 -0
  478. package/esm/typings/src/types/ModelRequirements.d.ts +104 -0
  479. package/esm/typings/src/types/ModelVariant.d.ts +15 -0
  480. package/esm/typings/src/types/NonEmptyArray.d.ts +8 -0
  481. package/esm/typings/src/types/Prompt.d.ts +111 -0
  482. package/esm/typings/src/types/ScriptLanguage.d.ts +13 -0
  483. package/esm/typings/src/types/SectionType.d.ts +21 -0
  484. package/esm/typings/src/types/TaskType.d.ts +15 -0
  485. package/esm/typings/src/types/typeAliasEmoji.d.ts +12 -0
  486. package/esm/typings/src/types/typeAliases.d.ts +644 -0
  487. package/esm/typings/src/utils/$Register.d.ts +39 -0
  488. package/esm/typings/src/utils/$getCurrentDate.d.ts +10 -0
  489. package/esm/typings/src/utils/FromtoItems.d.ts +19 -0
  490. package/esm/typings/src/utils/arrayableToArray.d.ts +11 -0
  491. package/esm/typings/src/utils/arrayableToArray.test.d.ts +1 -0
  492. package/esm/typings/src/utils/editable/edit-pipeline-string/addPipelineCommand.d.ts +17 -0
  493. package/esm/typings/src/utils/editable/edit-pipeline-string/addPipelineCommand.test.d.ts +1 -0
  494. package/esm/typings/src/utils/editable/edit-pipeline-string/deflatePipeline.d.ts +10 -0
  495. package/esm/typings/src/utils/editable/edit-pipeline-string/deflatePipeline.test.d.ts +1 -0
  496. package/esm/typings/src/utils/editable/edit-pipeline-string/removePipelineCommand.d.ts +22 -0
  497. package/esm/typings/src/utils/editable/edit-pipeline-string/removePipelineCommand.test.d.ts +1 -0
  498. package/esm/typings/src/utils/editable/types/PipelineEditableSerialized.d.ts +27 -0
  499. package/esm/typings/src/utils/editable/utils/isFlatPipeline.d.ts +7 -0
  500. package/esm/typings/src/utils/editable/utils/isFlatPipeline.test.d.ts +1 -0
  501. package/esm/typings/src/utils/editable/utils/renamePipelineParameter.d.ts +29 -0
  502. package/esm/typings/src/utils/editable/utils/renamePipelineParameter.test.d.ts +1 -0
  503. package/esm/typings/src/utils/editable/utils/stringifyPipelineJson.d.ts +16 -0
  504. package/esm/typings/src/utils/emojis.d.ts +24 -0
  505. package/esm/typings/src/utils/environment/$getGlobalScope.d.ts +9 -0
  506. package/esm/typings/src/utils/environment/$isRunningInBrowser.d.ts +11 -0
  507. package/esm/typings/src/utils/environment/$isRunningInJest.d.ts +11 -0
  508. package/esm/typings/src/utils/environment/$isRunningInNode.d.ts +11 -0
  509. package/esm/typings/src/utils/environment/$isRunningInWebWorker.d.ts +11 -0
  510. package/esm/typings/src/utils/execCommand/$execCommand.d.ts +16 -0
  511. package/esm/typings/src/utils/execCommand/$execCommandNormalizeOptions.d.ts +12 -0
  512. package/esm/typings/src/utils/execCommand/$execCommands.d.ts +18 -0
  513. package/esm/typings/src/utils/execCommand/ExecCommandOptions.d.ts +45 -0
  514. package/esm/typings/src/utils/execCommand/execCommand.test.d.ts +1 -0
  515. package/esm/typings/src/utils/execCommand/execCommandNormalizeOptions.test.d.ts +1 -0
  516. package/esm/typings/src/utils/expectation-counters/constants.d.ts +16 -0
  517. package/esm/typings/src/utils/expectation-counters/countCharacters.d.ts +7 -0
  518. package/esm/typings/src/utils/expectation-counters/countCharacters.test.d.ts +1 -0
  519. package/esm/typings/src/utils/expectation-counters/countLines.d.ts +9 -0
  520. package/esm/typings/src/utils/expectation-counters/countLines.test.d.ts +1 -0
  521. package/esm/typings/src/utils/expectation-counters/countPages.d.ts +9 -0
  522. package/esm/typings/src/utils/expectation-counters/countPages.test.d.ts +1 -0
  523. package/esm/typings/src/utils/expectation-counters/countParagraphs.d.ts +7 -0
  524. package/esm/typings/src/utils/expectation-counters/countParagraphs.test.d.ts +1 -0
  525. package/esm/typings/src/utils/expectation-counters/countSentences.d.ts +13 -0
  526. package/esm/typings/src/utils/expectation-counters/countSentences.test.d.ts +1 -0
  527. package/esm/typings/src/utils/expectation-counters/countWords.d.ts +7 -0
  528. package/esm/typings/src/utils/expectation-counters/countWords.test.d.ts +1 -0
  529. package/esm/typings/src/utils/expectation-counters/index.d.ts +12 -0
  530. package/esm/typings/src/utils/files/extensionToMimeType.d.ts +8 -0
  531. package/esm/typings/src/utils/files/extensionToMimeType.test.d.ts +1 -0
  532. package/esm/typings/src/utils/files/getFileExtension.d.ts +8 -0
  533. package/esm/typings/src/utils/files/getFileExtension.test.d.ts +1 -0
  534. package/esm/typings/src/utils/files/isDirectoryExisting.d.ts +14 -0
  535. package/esm/typings/src/utils/files/isDirectoryExisting.test.d.ts +1 -0
  536. package/esm/typings/src/utils/files/isExecutable.d.ts +11 -0
  537. package/esm/typings/src/utils/files/isFileExisting.d.ts +13 -0
  538. package/esm/typings/src/utils/files/isFileExisting.test.d.ts +1 -0
  539. package/esm/typings/src/utils/files/listAllFiles.d.ts +17 -0
  540. package/esm/typings/src/utils/files/listAllFiles.test.d.ts +1 -0
  541. package/esm/typings/src/utils/files/mimeTypeToExtension.d.ts +10 -0
  542. package/esm/typings/src/utils/files/mimeTypeToExtension.test.d.ts +1 -0
  543. package/esm/typings/src/utils/markdown/addAutoGeneratedSection.d.ts +14 -0
  544. package/esm/typings/src/utils/markdown/addAutoGeneratedSection.test.d.ts +1 -0
  545. package/esm/typings/src/utils/markdown/createMarkdownChart.d.ts +38 -0
  546. package/esm/typings/src/utils/markdown/createMarkdownChart.test.d.ts +1 -0
  547. package/esm/typings/src/utils/markdown/createMarkdownTable.d.ts +11 -0
  548. package/esm/typings/src/utils/markdown/createMarkdownTable.test.d.ts +1 -0
  549. package/esm/typings/src/utils/markdown/escapeMarkdownBlock.d.ts +11 -0
  550. package/esm/typings/src/utils/markdown/escapeMarkdownBlock.test.d.ts +1 -0
  551. package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown-real.test.d.ts +1 -0
  552. package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.d.ts +36 -0
  553. package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.test.d.ts +1 -0
  554. package/esm/typings/src/utils/markdown/extractAllListItemsFromMarkdown.d.ts +15 -0
  555. package/esm/typings/src/utils/markdown/extractAllListItemsFromMarkdown.test.d.ts +1 -0
  556. package/esm/typings/src/utils/markdown/extractOneBlockFromMarkdown.d.ts +22 -0
  557. package/esm/typings/src/utils/markdown/extractOneBlockFromMarkdown.test.d.ts +1 -0
  558. package/esm/typings/src/utils/markdown/flattenMarkdown.d.ts +17 -0
  559. package/esm/typings/src/utils/markdown/flattenMarkdown.test.d.ts +1 -0
  560. package/esm/typings/src/utils/markdown/parseMarkdownSection.d.ts +34 -0
  561. package/esm/typings/src/utils/markdown/parseMarkdownSection.test.d.ts +1 -0
  562. package/esm/typings/src/utils/markdown/prettifyMarkdown.d.ts +9 -0
  563. package/esm/typings/src/utils/markdown/prettifyMarkdown.test.d.ts +1 -0
  564. package/esm/typings/src/utils/markdown/removeMarkdownComments.d.ts +10 -0
  565. package/esm/typings/src/utils/markdown/removeMarkdownComments.test.d.ts +1 -0
  566. package/esm/typings/src/utils/markdown/removeMarkdownFormatting.d.ts +9 -0
  567. package/esm/typings/src/utils/markdown/removeMarkdownFormatting.test.d.ts +1 -0
  568. package/esm/typings/src/utils/markdown/splitMarkdownIntoSections.d.ts +15 -0
  569. package/esm/typings/src/utils/markdown/splitMarkdownIntoSections.test.d.ts +1 -0
  570. package/esm/typings/src/utils/normalization/DIACRITIC_VARIANTS_LETTERS.d.ts +12 -0
  571. package/esm/typings/src/utils/normalization/IKeywords.d.ts +21 -0
  572. package/esm/typings/src/utils/normalization/capitalize.d.ts +6 -0
  573. package/esm/typings/src/utils/normalization/capitalize.test.d.ts +1 -0
  574. package/esm/typings/src/utils/normalization/decapitalize.d.ts +6 -0
  575. package/esm/typings/src/utils/normalization/decapitalize.test.d.ts +1 -0
  576. package/esm/typings/src/utils/normalization/isValidKeyword.d.ts +10 -0
  577. package/esm/typings/src/utils/normalization/isValidKeyword.test.d.ts +1 -0
  578. package/esm/typings/src/utils/normalization/nameToUriPart.d.ts +9 -0
  579. package/esm/typings/src/utils/normalization/nameToUriPart.test.d.ts +1 -0
  580. package/esm/typings/src/utils/normalization/nameToUriParts.d.ts +9 -0
  581. package/esm/typings/src/utils/normalization/nameToUriParts.test.d.ts +1 -0
  582. package/esm/typings/src/utils/normalization/normalize-to-kebab-case.d.ts +21 -0
  583. package/esm/typings/src/utils/normalization/normalize-to-kebab-case.test.d.ts +1 -0
  584. package/esm/typings/src/utils/normalization/normalizeTo_PascalCase.d.ts +17 -0
  585. package/esm/typings/src/utils/normalization/normalizeTo_PascalCase.test.d.ts +1 -0
  586. package/esm/typings/src/utils/normalization/normalizeTo_SCREAMING_CASE.d.ts +26 -0
  587. package/esm/typings/src/utils/normalization/normalizeTo_SCREAMING_CASE.test.d.ts +1 -0
  588. package/esm/typings/src/utils/normalization/normalizeTo_camelCase.d.ts +22 -0
  589. package/esm/typings/src/utils/normalization/normalizeTo_camelCase.test.d.ts +1 -0
  590. package/esm/typings/src/utils/normalization/normalizeTo_snake_case.d.ts +17 -0
  591. package/esm/typings/src/utils/normalization/normalizeTo_snake_case.test.d.ts +1 -0
  592. package/esm/typings/src/utils/normalization/normalizeWhitespaces.d.ts +6 -0
  593. package/esm/typings/src/utils/normalization/normalizeWhitespaces.test.d.ts +1 -0
  594. package/esm/typings/src/utils/normalization/orderJson.d.ts +21 -0
  595. package/esm/typings/src/utils/normalization/orderJson.test.d.ts +4 -0
  596. package/esm/typings/src/utils/normalization/parseKeywords.d.ts +16 -0
  597. package/esm/typings/src/utils/normalization/parseKeywords.test.d.ts +1 -0
  598. package/esm/typings/src/utils/normalization/parseKeywordsFromString.d.ts +9 -0
  599. package/esm/typings/src/utils/normalization/parseKeywordsFromString.test.d.ts +1 -0
  600. package/esm/typings/src/utils/normalization/removeDiacritics.d.ts +11 -0
  601. package/esm/typings/src/utils/normalization/removeDiacritics.test.d.ts +1 -0
  602. package/esm/typings/src/utils/normalization/searchKeywords.d.ts +10 -0
  603. package/esm/typings/src/utils/normalization/searchKeywords.test.d.ts +1 -0
  604. package/esm/typings/src/utils/normalization/suffixUrl.d.ts +7 -0
  605. package/esm/typings/src/utils/normalization/suffixUrl.test.d.ts +1 -0
  606. package/esm/typings/src/utils/normalization/titleToName.d.ts +9 -0
  607. package/esm/typings/src/utils/normalization/titleToName.test.d.ts +1 -0
  608. package/esm/typings/src/utils/organization/$sideEffect.d.ts +9 -0
  609. package/esm/typings/src/utils/organization/TODO_USE.d.ts +12 -0
  610. package/esm/typings/src/utils/organization/TODO_any.d.ts +6 -0
  611. package/esm/typings/src/utils/organization/TODO_object.d.ts +6 -0
  612. package/esm/typings/src/utils/organization/TODO_remove_as.d.ts +6 -0
  613. package/esm/typings/src/utils/organization/TODO_string.d.ts +6 -0
  614. package/esm/typings/src/utils/organization/TODO_unknown.d.ts +6 -0
  615. package/esm/typings/src/utils/organization/___and___.d.ts +7 -0
  616. package/esm/typings/src/utils/organization/___or___.d.ts +6 -0
  617. package/esm/typings/src/utils/organization/empty_object.d.ts +10 -0
  618. package/esm/typings/src/utils/organization/just.d.ts +14 -0
  619. package/esm/typings/src/utils/organization/just_empty_object.d.ts +12 -0
  620. package/esm/typings/src/utils/organization/keepTypeImported.d.ts +9 -0
  621. package/esm/typings/src/utils/organization/keepUnused.d.ts +16 -0
  622. package/esm/typings/src/utils/organization/really_any.d.ts +6 -0
  623. package/esm/typings/src/utils/organization/really_unknown.d.ts +6 -0
  624. package/esm/typings/src/utils/organization/spaceTrim.d.ts +11 -0
  625. package/esm/typings/src/utils/parameters/extractParameterNames.d.ts +10 -0
  626. package/esm/typings/src/utils/parameters/extractParameterNames.test.d.ts +1 -0
  627. package/esm/typings/src/utils/parameters/mapAvailableToExpectedParameters.d.ts +27 -0
  628. package/esm/typings/src/utils/parameters/mapAvailableToExpectedParameters.test.d.ts +1 -0
  629. package/esm/typings/src/utils/parameters/numberToString.d.ts +7 -0
  630. package/esm/typings/src/utils/parameters/numberToString.test.d.ts +1 -0
  631. package/esm/typings/src/utils/parameters/templateParameters.d.ts +16 -0
  632. package/esm/typings/src/utils/parameters/templateParameters.test.d.ts +1 -0
  633. package/esm/typings/src/utils/parameters/valueToString.d.ts +17 -0
  634. package/esm/typings/src/utils/parameters/valueToString.test.d.ts +1 -0
  635. package/esm/typings/src/utils/parseNumber.d.ts +16 -0
  636. package/esm/typings/src/utils/parseNumber.test.d.ts +1 -0
  637. package/esm/typings/src/utils/random/$randomSeed.d.ts +10 -0
  638. package/esm/typings/src/utils/random/$randomToken.d.ts +13 -0
  639. package/esm/typings/src/utils/removeEmojis.d.ts +8 -0
  640. package/esm/typings/src/utils/removeEmojis.test.d.ts +1 -0
  641. package/esm/typings/src/utils/removeQuotes.d.ts +14 -0
  642. package/esm/typings/src/utils/removeQuotes.test.d.ts +1 -0
  643. package/esm/typings/src/utils/serialization/$deepFreeze.d.ts +14 -0
  644. package/esm/typings/src/utils/serialization/asSerializable.d.ts +15 -0
  645. package/esm/typings/src/utils/serialization/asSerializable.test.d.ts +1 -0
  646. package/esm/typings/src/utils/serialization/checkSerializableAsJson.d.ts +45 -0
  647. package/esm/typings/src/utils/serialization/clonePipeline.d.ts +13 -0
  648. package/esm/typings/src/utils/serialization/deepClone.d.ts +10 -0
  649. package/esm/typings/src/utils/serialization/deepClone.test.d.ts +1 -0
  650. package/esm/typings/src/utils/serialization/exportJson.d.ts +29 -0
  651. package/esm/typings/src/utils/serialization/isSerializableAsJson.d.ts +25 -0
  652. package/esm/typings/src/utils/serialization/isSerializableAsJson.test.d.ts +1 -0
  653. package/esm/typings/src/utils/sets/difference.d.ts +10 -0
  654. package/esm/typings/src/utils/sets/difference.test.d.ts +1 -0
  655. package/esm/typings/src/utils/sets/intersection.d.ts +7 -0
  656. package/esm/typings/src/utils/sets/intersection.test.d.ts +1 -0
  657. package/esm/typings/src/utils/sets/union.d.ts +7 -0
  658. package/esm/typings/src/utils/sets/union.test.d.ts +1 -0
  659. package/esm/typings/src/utils/trimCodeBlock.d.ts +9 -0
  660. package/esm/typings/src/utils/trimCodeBlock.test.d.ts +1 -0
  661. package/esm/typings/src/utils/trimEndOfCodeBlock.d.ts +9 -0
  662. package/esm/typings/src/utils/trimEndOfCodeBlock.test.d.ts +1 -0
  663. package/esm/typings/src/utils/unwrapResult.d.ts +37 -0
  664. package/esm/typings/src/utils/unwrapResult.test.d.ts +1 -0
  665. package/esm/typings/src/utils/validators/email/isValidEmail.d.ts +8 -0
  666. package/esm/typings/src/utils/validators/email/isValidEmail.test.d.ts +1 -0
  667. package/esm/typings/src/utils/validators/filePath/isRootPath.d.ts +12 -0
  668. package/esm/typings/src/utils/validators/filePath/isRootPath.test.d.ts +4 -0
  669. package/esm/typings/src/utils/validators/filePath/isValidFilePath.d.ts +12 -0
  670. package/esm/typings/src/utils/validators/filePath/isValidFilePath.test.d.ts +1 -0
  671. package/esm/typings/src/utils/validators/javascriptName/isValidJavascriptName.d.ts +10 -0
  672. package/esm/typings/src/utils/validators/javascriptName/isValidJavascriptName.test.d.ts +1 -0
  673. package/esm/typings/src/utils/validators/parameterName/validateParameterName.d.ts +10 -0
  674. package/esm/typings/src/utils/validators/parameterName/validateParameterName.test.d.ts +1 -0
  675. package/esm/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.d.ts +15 -0
  676. package/esm/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.test.d.ts +1 -0
  677. package/esm/typings/src/utils/validators/semanticVersion/isValidSemanticVersion.d.ts +12 -0
  678. package/esm/typings/src/utils/validators/semanticVersion/isValidSemanticVersion.test.d.ts +1 -0
  679. package/esm/typings/src/utils/validators/url/isHostnameOnPrivateNetwork.d.ts +11 -0
  680. package/esm/typings/src/utils/validators/url/isHostnameOnPrivateNetwork.test.d.ts +1 -0
  681. package/esm/typings/src/utils/validators/url/isUrlOnPrivateNetwork.d.ts +13 -0
  682. package/esm/typings/src/utils/validators/url/isUrlOnPrivateNetwork.test.d.ts +1 -0
  683. package/esm/typings/src/utils/validators/url/isValidPipelineUrl.d.ts +15 -0
  684. package/esm/typings/src/utils/validators/url/isValidPipelineUrl.test.d.ts +1 -0
  685. package/esm/typings/src/utils/validators/url/isValidUrl.d.ts +13 -0
  686. package/esm/typings/src/utils/validators/url/isValidUrl.test.d.ts +1 -0
  687. package/esm/typings/src/utils/validators/uuid/isValidUuid.d.ts +8 -0
  688. package/esm/typings/src/utils/validators/uuid/isValidUuid.test.d.ts +1 -0
  689. package/esm/typings/src/version.d.ts +25 -0
  690. package/esm/typings/src/wizzard/$getCompiledBook.d.ts +16 -0
  691. package/esm/typings/src/wizzard/wizzard.d.ts +68 -0
  692. package/package.json +57 -0
  693. package/umd/index.umd.js +1810 -0
  694. package/umd/index.umd.js.map +1 -0
@@ -0,0 +1,30 @@
1
+ import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
2
+ import type { PipelineString } from '../pipeline/PipelineString';
3
+ /**
4
+ * Compile pipeline from string (markdown) format to JSON format synchronously
5
+ *
6
+ * Note: There are 3 similar functions:
7
+ * - `compilePipeline` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
8
+ * - `parsePipeline` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
9
+ * - `preparePipeline` - just one step in the compilation process
10
+ *
11
+ * Note: This function does not validate logic of the pipeline only the parsing
12
+ * Note: This function acts as compilation process
13
+ *
14
+ * @param pipelineString {Promptbook} in string markdown format (.book.md)
15
+ * @returns {Promptbook} compiled in JSON format (.bookc)
16
+ * @throws {ParseError} if the promptbook string is not valid
17
+ * @public exported from `@promptbook/core`
18
+ */
19
+ export declare function parsePipeline(pipelineString: PipelineString): PipelineJson;
20
+ /**
21
+ * TODO: [🧠] Maybe more things here can be refactored as high-level abstractions
22
+ * TODO: [main] !!4 Warn if used only sync version
23
+ * TODO: [🚞] Report here line/column of error
24
+ * TODO: Use spaceTrim more effectively
25
+ * TODO: [🧠] Parameter flags - isInput, isOutput, isInternal
26
+ * TODO: [🥞] Not optimal parsing because `splitMarkdownIntoSections` is executed twice with same string, once through `flattenMarkdown` and second directly here
27
+ * TODO: [♈] Probbably move expectations from tasks to parameters
28
+ * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
29
+ * TODO: [🍙] Make some standard order of json properties
30
+ */
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,18 @@
1
+ import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
2
+ import type { PipelineString } from '../pipeline/PipelineString';
3
+ /**
4
+ * Converts promptbook in JSON format to string format
5
+ *
6
+ * @deprecated TODO: [🥍][🧠] Backup original files in `PipelineJson` same as in Promptbook.studio
7
+ * @param pipelineJson Promptbook in JSON format (.bookc)
8
+ * @returns Promptbook in string format (.book.md)
9
+ * @public exported from `@promptbook/core`
10
+ */
11
+ export declare function pipelineJsonToString(pipelineJson: PipelineJson): PipelineString;
12
+ /**
13
+ * TODO: [🛋] Implement new features and commands into `pipelineJsonToString` + `taskParameterJsonToString` , use `stringifyCommand`
14
+ * TODO: [🧠] Is there a way to auto-detect missing features in pipelineJsonToString
15
+ * TODO: [🏛] Maybe make some markdown builder
16
+ * TODO: [🏛] Escape all
17
+ * TODO: [🧠] Should be in generated .book.md file GENERATOR_WARNING
18
+ */
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Options for `prettifyPipelineString` function
3
+ */
4
+ export type PrettifyOptions = {
5
+ /***
6
+ * If true, adds Mermaid graph to the Promptbook string
7
+ */
8
+ readonly isGraphAdded?: boolean;
9
+ /**
10
+ * If true, the string is prettifyed as markdown
11
+ */
12
+ readonly isPrettifyed?: boolean;
13
+ };
@@ -0,0 +1,12 @@
1
+ import type { PipelineString } from '../../pipeline/PipelineString';
2
+ import type { PrettifyOptions } from './PrettifyOptions';
3
+ /**
4
+ * Prettyfies Promptbook string and adds Mermaid graph
5
+ *
6
+ * @public exported from `@promptbook/core`
7
+ */
8
+ export declare function prettifyPipelineString(pipelineString: PipelineString, options: PrettifyOptions): Promise<PipelineString>;
9
+ /**
10
+ * TODO: Maybe use some Mermaid package instead of string templating
11
+ * TODO: [🕌] When more than 2 functionalities, split into separate functions
12
+ */
@@ -0,0 +1,30 @@
1
+ import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
2
+ import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
3
+ import type { string_href } from '../../types/typeAliases';
4
+ /**
5
+ * Addtional options for rendering Mermaid graph
6
+ */
7
+ export type renderPipelineMermaidOptions = {
8
+ /**
9
+ * Callback for creating from task graph node
10
+ */
11
+ linkTask?(task: TaskJson): {
12
+ href: string_href;
13
+ title: string;
14
+ } | null;
15
+ };
16
+ /**
17
+ * Creates a Mermaid graph based on the promptbook
18
+ *
19
+ * Note: The result is not wrapped in a Markdown code block
20
+ *
21
+ * @public exported from `@promptbook/utils`
22
+ */
23
+ export declare function renderPromptbookMermaid(pipelineJson: PipelineJson, options?: renderPipelineMermaidOptions): string;
24
+ /**
25
+ * TODO: [🧠] FOREACH in mermaid graph
26
+ * TODO: [🧠] Knowledge in mermaid graph
27
+ * TODO: [🧠] Personas in mermaid graph
28
+ * TODO: Maybe use some Mermaid package instead of string templating
29
+ * TODO: [🕌] When more than 2 functionalities, split into separate functions
30
+ */
@@ -0,0 +1,15 @@
1
+ import type { ReadonlyDeep } from 'type-fest';
2
+ import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
3
+ import type { string_parameter_name } from '../../types/typeAliases';
4
+ /**
5
+ * Parses the task and returns the set of all used parameters
6
+ *
7
+ * @param task the task with used parameters
8
+ * @returns the set of parameter names
9
+ * @throws {ParseError} if the script is invalid
10
+ * @public exported from `@promptbook/core` <- Note: [👖] This utility is so tightly interconnected with the Promptbook that it is not exported as util but in core
11
+ */
12
+ export declare function extractParameterNamesFromTask(task: ReadonlyDeep<Pick<TaskJson, 'title' | 'description' | 'taskType' | 'content' | 'preparedContent' | 'jokerParameterNames' | 'foreach'>>): Set<string_parameter_name>;
13
+ /**
14
+ * TODO: [🔣] If script require contentLanguage
15
+ */
@@ -0,0 +1,23 @@
1
+ import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
2
+ import type { PipelineString } from '../../pipeline/PipelineString';
3
+ /**
4
+ * Import the pipeline.book or pipeline.bookc file
5
+ *
6
+ * Note: Using here custom import to work in jest tests
7
+ * Note: Using sync version is 💩 in the production code, but it's ok here in tests
8
+ *
9
+ * @param path - The path to the file relative to examples/pipelines directory
10
+ * @private internal function of tests
11
+ */
12
+ export declare function importPipelineWithoutPreparation(path: `${string}.book`): Promise<PipelineString>;
13
+ export declare function importPipelineWithoutPreparation(path: `${string}.bookc`): Promise<PipelineJson>;
14
+ /**
15
+ * Import the pipeline.bookc file as parsed JSON
16
+ *
17
+ * @private internal function of tests
18
+ */
19
+ export declare function importPipelineJson(path: `${string}.bookc`): Promise<PipelineJson>;
20
+ /**
21
+ * Note: [💞] Ignore a discrepancy between file name and entity name
22
+ * Note: [⚫] Code in this file should never be published in any package
23
+ */
@@ -0,0 +1,4 @@
1
+ export {};
2
+ /**
3
+ * TODO: [🚏] DRY
4
+ */
@@ -0,0 +1,4 @@
1
+ export {};
2
+ /**
3
+ * TODO: [🚏] DRY
4
+ */
@@ -0,0 +1,42 @@
1
+ import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
2
+ /**
3
+ * Validates PipelineJson if it is logically valid
4
+ *
5
+ * It checks:
6
+ * - if it has correct parameters dependency
7
+ *
8
+ * It does NOT check:
9
+ * - if it is valid json
10
+ * - if it is meaningful
11
+ *
12
+ * @param pipeline valid or invalid PipelineJson
13
+ * @returns the same pipeline if it is logically valid
14
+ * @throws {PipelineLogicError} on logical error in the pipeline
15
+ * @public exported from `@promptbook/core`
16
+ */
17
+ export declare function validatePipeline(pipeline: PipelineJson): PipelineJson;
18
+ /**
19
+ * @private internal function for `validatePipeline`
20
+ */
21
+ export declare function validatePipeline_InnerFunction(pipeline: PipelineJson): void;
22
+ /**
23
+ * TODO: [🧞‍♀️] Do not allow joker + foreach
24
+ * TODO: [🧠] Work with promptbookVersion
25
+ * TODO: Use here some json-schema, Zod or something similar and change it to:
26
+ * > /**
27
+ * > * Validates PipelineJson if it is logically valid.
28
+ * > *
29
+ * > * It checks:
30
+ * > * - it has a valid structure
31
+ * > * - ...
32
+ * > ex port function validatePipeline(promptbook: really_unknown): asserts promptbook is PipelineJson {
33
+ */
34
+ /**
35
+ * TODO: [🧳][main] !!4 Validate that all examples match expectations
36
+ * TODO: [🧳][🐝][main] !!4 Validate that knowledge is valid (non-void)
37
+ * TODO: [🧳][main] !!4 Validate that persona can be used only with CHAT variant
38
+ * TODO: [🧳][main] !!4 Validate that parameter with reserved name not used RESERVED_PARAMETER_NAMES
39
+ * TODO: [🧳][main] !!4 Validate that reserved parameter is not used as joker
40
+ * TODO: [🧠] Validation not only logic itself but imports around - files and websites and rerefenced pipelines exists
41
+ * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
42
+ */
@@ -0,0 +1,4 @@
1
+ export {};
2
+ /**
3
+ * TODO: [🚏] DRY
4
+ */
@@ -0,0 +1,17 @@
1
+ import type { UserInterfaceTools } from '../../execution/UserInterfaceTools';
2
+ import type { UserInterfaceToolsPromptDialogOptions } from '../../execution/UserInterfaceTools';
3
+ import type { CallbackInterfaceToolsOptions } from './CallbackInterfaceToolsOptions';
4
+ /**
5
+ * Delagates the user interaction to a async callback function
6
+ * You need to provide your own implementation of this callback function and its bind to UI.
7
+ *
8
+ * @public exported from `@promptbook/core`
9
+ */
10
+ export declare class CallbackInterfaceTools implements UserInterfaceTools {
11
+ protected readonly options: CallbackInterfaceToolsOptions;
12
+ constructor(options: CallbackInterfaceToolsOptions);
13
+ /**
14
+ * Trigger the custom callback function
15
+ */
16
+ promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
17
+ }
@@ -0,0 +1,14 @@
1
+ import type { Promisable } from 'type-fest';
2
+ import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
3
+ import type { UserInterfaceToolsPromptDialogOptions } from '../../execution/UserInterfaceTools';
4
+ /**
5
+ * Options for `CallbackInterfaceTools`
6
+ *
7
+ * @public exported from `@promptbook/core`
8
+ */
9
+ export type CallbackInterfaceToolsOptions = CommonToolsOptions & {
10
+ /**
11
+ * The callback function to be called when promptDialog is called
12
+ */
13
+ callback(prompt: UserInterfaceToolsPromptDialogOptions): Promisable<string>;
14
+ };
@@ -0,0 +1,22 @@
1
+ import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
2
+ import type { UserInterfaceTools } from '../../execution/UserInterfaceTools';
3
+ import type { UserInterfaceToolsPromptDialogOptions } from '../../execution/UserInterfaceTools';
4
+ /**
5
+ * Wrapper around `window.prompt` synchronous function that interacts with the user via browser prompt
6
+ *
7
+ * Warning: It is used for testing and mocking
8
+ * **NOT intended to use in the production** due to its synchronous nature.
9
+ *
10
+ * @public exported from `@promptbook/browser`
11
+ */
12
+ export declare class SimplePromptInterfaceTools implements UserInterfaceTools {
13
+ protected readonly options: CommonToolsOptions;
14
+ constructor(options?: CommonToolsOptions);
15
+ /**
16
+ * Trigger window.prompt dialog
17
+ */
18
+ promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
19
+ }
20
+ /**
21
+ * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
22
+ */
@@ -0,0 +1,12 @@
1
+ /**
2
+ * This error indicates @@@
3
+ *
4
+ * @public exported from `@promptbook/core`
5
+ */
6
+ export declare class BoilerplateError extends Error {
7
+ readonly name = "BoilerplateError";
8
+ constructor(message: string);
9
+ }
10
+ /**
11
+ * TODO: @@@ Do not forget to add the error into `0-index.ts` ERRORS
12
+ */
@@ -0,0 +1,85 @@
1
+ import { CsvFormatError } from '../formats/csv/CsvFormatError';
2
+ import { AbstractFormatError } from './AbstractFormatError';
3
+ import { CollectionError } from './CollectionError';
4
+ import { EnvironmentMismatchError } from './EnvironmentMismatchError';
5
+ import { ExpectError } from './ExpectError';
6
+ import { KnowledgeScrapeError } from './KnowledgeScrapeError';
7
+ import { LimitReachedError } from './LimitReachedError';
8
+ import { MissingToolsError } from './MissingToolsError';
9
+ import { NotFoundError } from './NotFoundError';
10
+ import { NotYetImplementedError } from './NotYetImplementedError';
11
+ import { ParseError } from './ParseError';
12
+ import { PipelineExecutionError } from './PipelineExecutionError';
13
+ import { PipelineLogicError } from './PipelineLogicError';
14
+ import { PipelineUrlError } from './PipelineUrlError';
15
+ import { UnexpectedError } from './UnexpectedError';
16
+ /**
17
+ * Index of all custom errors
18
+ *
19
+ * @public exported from `@promptbook/core`
20
+ */
21
+ export declare const PROMPTBOOK_ERRORS: {
22
+ readonly AbstractFormatError: typeof AbstractFormatError;
23
+ readonly CsvFormatError: typeof CsvFormatError;
24
+ readonly CollectionError: typeof CollectionError;
25
+ readonly EnvironmentMismatchError: typeof EnvironmentMismatchError;
26
+ readonly ExpectError: typeof ExpectError;
27
+ readonly KnowledgeScrapeError: typeof KnowledgeScrapeError;
28
+ readonly LimitReachedError: typeof LimitReachedError;
29
+ readonly MissingToolsError: typeof MissingToolsError;
30
+ readonly NotFoundError: typeof NotFoundError;
31
+ readonly NotYetImplementedError: typeof NotYetImplementedError;
32
+ readonly ParseError: typeof ParseError;
33
+ readonly PipelineExecutionError: typeof PipelineExecutionError;
34
+ readonly PipelineLogicError: typeof PipelineLogicError;
35
+ readonly PipelineUrlError: typeof PipelineUrlError;
36
+ readonly UnexpectedError: typeof UnexpectedError;
37
+ };
38
+ /**
39
+ * Index of all javascript errors
40
+ *
41
+ * @private for internal usage
42
+ */
43
+ export declare const COMMON_JAVASCRIPT_ERRORS: {
44
+ readonly Error: ErrorConstructor;
45
+ readonly EvalError: EvalErrorConstructor;
46
+ readonly RangeError: RangeErrorConstructor;
47
+ readonly ReferenceError: ReferenceErrorConstructor;
48
+ readonly SyntaxError: SyntaxErrorConstructor;
49
+ readonly TypeError: TypeErrorConstructor;
50
+ readonly URIError: URIErrorConstructor;
51
+ readonly AggregateError: AggregateErrorConstructor;
52
+ };
53
+ /**
54
+ * Index of all errors
55
+ *
56
+ * @private for internal usage
57
+ */
58
+ export declare const ALL_ERRORS: {
59
+ readonly Error: ErrorConstructor;
60
+ readonly EvalError: EvalErrorConstructor;
61
+ readonly RangeError: RangeErrorConstructor;
62
+ readonly ReferenceError: ReferenceErrorConstructor;
63
+ readonly SyntaxError: SyntaxErrorConstructor;
64
+ readonly TypeError: TypeErrorConstructor;
65
+ readonly URIError: URIErrorConstructor;
66
+ readonly AggregateError: AggregateErrorConstructor;
67
+ readonly AbstractFormatError: typeof AbstractFormatError;
68
+ readonly CsvFormatError: typeof CsvFormatError;
69
+ readonly CollectionError: typeof CollectionError;
70
+ readonly EnvironmentMismatchError: typeof EnvironmentMismatchError;
71
+ readonly ExpectError: typeof ExpectError;
72
+ readonly KnowledgeScrapeError: typeof KnowledgeScrapeError;
73
+ readonly LimitReachedError: typeof LimitReachedError;
74
+ readonly MissingToolsError: typeof MissingToolsError;
75
+ readonly NotFoundError: typeof NotFoundError;
76
+ readonly NotYetImplementedError: typeof NotYetImplementedError;
77
+ readonly ParseError: typeof ParseError;
78
+ readonly PipelineExecutionError: typeof PipelineExecutionError;
79
+ readonly PipelineLogicError: typeof PipelineLogicError;
80
+ readonly PipelineUrlError: typeof PipelineUrlError;
81
+ readonly UnexpectedError: typeof UnexpectedError;
82
+ };
83
+ /**
84
+ * Note: [💞] Ignore a discrepancy between file name and entity name
85
+ */
@@ -0,0 +1,11 @@
1
+ /**
2
+ * This error indicates problems parsing the format value
3
+ *
4
+ * For example, when the format value is not a valid JSON or CSV
5
+ * This is not thrown directly but in extended classes
6
+ *
7
+ * @public exported from `@promptbook/core`
8
+ */
9
+ export declare class AbstractFormatError extends Error {
10
+ constructor(message: string);
11
+ }
@@ -0,0 +1,9 @@
1
+ /**
2
+ * This error indicates that the pipeline collection cannot be propperly loaded
3
+ *
4
+ * @public exported from `@promptbook/core`
5
+ */
6
+ export declare class CollectionError extends Error {
7
+ readonly name = "CollectionError";
8
+ constructor(message: string);
9
+ }
@@ -0,0 +1,9 @@
1
+ /**
2
+ * This error type indicates that you try to use a feature that is not available in the current environment
3
+ *
4
+ * @public exported from `@promptbook/core`
5
+ */
6
+ export declare class EnvironmentMismatchError extends Error {
7
+ readonly name = "EnvironmentMismatchError";
8
+ constructor(message: string);
9
+ }
@@ -0,0 +1,12 @@
1
+ /**
2
+ * This error occurs when some expectation is not met in the execution of the pipeline
3
+ *
4
+ * @public exported from `@promptbook/core`
5
+ * Note: Do not throw this error, its reserved for `checkExpectations` and `createPipelineExecutor` and public ONLY to be serializable through remote server
6
+ * Note: Always thrown in `checkExpectations` and catched in `createPipelineExecutor` and rethrown as `PipelineExecutionError`
7
+ * Note: This is a kindof subtype of PipelineExecutionError
8
+ */
9
+ export declare class ExpectError extends Error {
10
+ readonly name = "ExpectError";
11
+ constructor(message: string);
12
+ }
@@ -0,0 +1,9 @@
1
+ /**
2
+ * This error indicates that the promptbook can not retrieve knowledge from external sources
3
+ *
4
+ * @public exported from `@promptbook/core`
5
+ */
6
+ export declare class KnowledgeScrapeError extends Error {
7
+ readonly name = "KnowledgeScrapeError";
8
+ constructor(message: string);
9
+ }
@@ -0,0 +1,9 @@
1
+ /**
2
+ * This error type indicates that some limit was reached
3
+ *
4
+ * @public exported from `@promptbook/core`
5
+ */
6
+ export declare class LimitReachedError extends Error {
7
+ readonly name = "LimitReachedError";
8
+ constructor(message: string);
9
+ }
@@ -0,0 +1,9 @@
1
+ /**
2
+ * This error type indicates that some tools are missing for pipeline execution or preparation
3
+ *
4
+ * @public exported from `@promptbook/core`
5
+ */
6
+ export declare class MissingToolsError extends Error {
7
+ readonly name = "MissingToolsError";
8
+ constructor(message: string);
9
+ }
@@ -0,0 +1,9 @@
1
+ /**
2
+ * This error indicates that promptbook not found in the collection
3
+ *
4
+ * @public exported from `@promptbook/core`
5
+ */
6
+ export declare class NotFoundError extends Error {
7
+ readonly name = "NotFoundError";
8
+ constructor(message: string);
9
+ }
@@ -0,0 +1,9 @@
1
+ /**
2
+ * This error type indicates that some part of the code is not implemented yet
3
+ *
4
+ * @public exported from `@promptbook/core`
5
+ */
6
+ export declare class NotYetImplementedError extends Error {
7
+ readonly name = "NotYetImplementedError";
8
+ constructor(message: string);
9
+ }
@@ -0,0 +1,12 @@
1
+ /**
2
+ * This error indicates that the promptbook in a markdown format cannot be parsed into a valid promptbook object
3
+ *
4
+ * @public exported from `@promptbook/core`
5
+ */
6
+ export declare class ParseError extends Error {
7
+ readonly name = "ParseError";
8
+ constructor(message: string);
9
+ }
10
+ /**
11
+ * TODO: Maybe split `ParseError` and `ApplyError`
12
+ */
@@ -0,0 +1,9 @@
1
+ /**
2
+ * This error indicates errors during the execution of the pipeline
3
+ *
4
+ * @public exported from `@promptbook/core`
5
+ */
6
+ export declare class PipelineExecutionError extends Error {
7
+ readonly name = "PipelineExecutionError";
8
+ constructor(message: string);
9
+ }
@@ -0,0 +1,9 @@
1
+ /**
2
+ * This error indicates that the promptbook object has valid syntax (=can be parsed) but contains logical errors (like circular dependencies)
3
+ *
4
+ * @public exported from `@promptbook/core`
5
+ */
6
+ export declare class PipelineLogicError extends Error {
7
+ readonly name = "PipelineLogicError";
8
+ constructor(message: string);
9
+ }
@@ -0,0 +1,9 @@
1
+ /**
2
+ * This error indicates errors in referencing promptbooks between each other
3
+ *
4
+ * @public exported from `@promptbook/core`
5
+ */
6
+ export declare class PipelineUrlError extends Error {
7
+ readonly name = "PipelineUrlError";
8
+ constructor(message: string);
9
+ }
@@ -0,0 +1,9 @@
1
+ /**
2
+ * This error type indicates that the error should not happen and its last check before crashing with some other error
3
+ *
4
+ * @public exported from `@promptbook/core`
5
+ */
6
+ export declare class UnexpectedError extends Error {
7
+ readonly name = "UnexpectedError";
8
+ constructor(message: string);
9
+ }
@@ -0,0 +1,20 @@
1
+ import type { ALL_ERRORS } from '../0-index';
2
+ /**
3
+ * Represents a serialized error or custom Promptbook error
4
+ *
5
+ * Note: [🚉] This is fully serializable as JSON
6
+ */
7
+ export type ErrorJson = {
8
+ /**
9
+ * The type of the error
10
+ */
11
+ readonly name: keyof typeof ALL_ERRORS;
12
+ /**
13
+ * The message of the error
14
+ */
15
+ readonly message: string;
16
+ /**
17
+ * The stack trace of the error
18
+ */
19
+ readonly stack?: string;
20
+ };
@@ -0,0 +1,7 @@
1
+ import type { ErrorJson } from './ErrorJson';
2
+ /**
3
+ * Deserializes the error object
4
+ *
5
+ * @public exported from `@promptbook/utils`
6
+ */
7
+ export declare function deserializeError(error: ErrorJson): Error;
@@ -0,0 +1,6 @@
1
+ /**
2
+ * Make error report URL for the given error
3
+ *
4
+ * @private private within the repository
5
+ */
6
+ export declare function getErrorReportUrl(error: Error): URL;
@@ -0,0 +1,7 @@
1
+ import type { ErrorJson } from './ErrorJson';
2
+ /**
3
+ * Serializes an error into a [🚉] JSON-serializable object
4
+ *
5
+ * @public exported from `@promptbook/utils`
6
+ */
7
+ export declare function serializeError(error: Error): ErrorJson;
@@ -0,0 +1,12 @@
1
+ import type { Executables } from '../execution/Executables';
2
+ import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
3
+ /**
4
+ * @@@
5
+ *
6
+ * @public exported from `@promptbook/node`
7
+ */
8
+ export declare function $provideExecutablesForNode(options?: PrepareAndScrapeOptions): Promise<Executables>;
9
+ /**
10
+ * TODO: [🧠] Allow to override the executables without need to call `locatePandoc` / `locateLibreoffice` in case of provided
11
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
12
+ */
@@ -0,0 +1,11 @@
1
+ import type { string_executable_path } from '../../types/typeAliases';
2
+ /**
3
+ * @@@
4
+ *
5
+ * @private within the repository
6
+ */
7
+ export declare function locateLibreoffice(): Promise<string_executable_path | null>;
8
+ /**
9
+ * TODO: [🧠][♿] Maybe export through `@promptbook/node` OR `@promptbook/legacy-documents`
10
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
11
+ */
@@ -0,0 +1,11 @@
1
+ import type { string_executable_path } from '../../types/typeAliases';
2
+ /**
3
+ * @@@
4
+ *
5
+ * @private within the repository
6
+ */
7
+ export declare function locatePandoc(): Promise<string_executable_path | null>;
8
+ /**
9
+ * TODO: [🧠][♿] Maybe export through `@promptbook/node` OR `@promptbook/documents`
10
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
11
+ */