@promptbook/editable 0.81.0-5

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 (638) hide show
  1. package/README.md +421 -0
  2. package/esm/index.es.js +629 -0
  3. package/esm/index.es.js.map +1 -0
  4. package/esm/typings/books/index.d.ts +78 -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 +44 -0
  9. package/esm/typings/src/_packages/core.index.d.ts +236 -0
  10. package/esm/typings/src/_packages/documents.index.d.ts +8 -0
  11. package/esm/typings/src/_packages/editable.index.d.ts +10 -0
  12. package/esm/typings/src/_packages/execute-javascript.index.d.ts +8 -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/legacy-documents.index.d.ts +8 -0
  16. package/esm/typings/src/_packages/markdown-utils.index.d.ts +48 -0
  17. package/esm/typings/src/_packages/node.index.d.ts +22 -0
  18. package/esm/typings/src/_packages/openai.index.d.ts +20 -0
  19. package/esm/typings/src/_packages/pdf.index.d.ts +8 -0
  20. package/esm/typings/src/_packages/remote-client.index.d.ts +8 -0
  21. package/esm/typings/src/_packages/remote-server.index.d.ts +6 -0
  22. package/esm/typings/src/_packages/templates.index.d.ts +4 -0
  23. package/esm/typings/src/_packages/types.index.d.ts +528 -0
  24. package/esm/typings/src/_packages/utils.index.d.ts +150 -0
  25. package/esm/typings/src/_packages/vercel.index.d.ts +6 -0
  26. package/esm/typings/src/_packages/website-crawler.index.d.ts +8 -0
  27. package/esm/typings/src/cli/cli-commands/about.d.ts +12 -0
  28. package/esm/typings/src/cli/cli-commands/hello.d.ts +12 -0
  29. package/esm/typings/src/cli/cli-commands/list-models.d.ts +11 -0
  30. package/esm/typings/src/cli/cli-commands/make.d.ts +14 -0
  31. package/esm/typings/src/cli/cli-commands/prettify.d.ts +13 -0
  32. package/esm/typings/src/cli/cli-commands/run.d.ts +15 -0
  33. package/esm/typings/src/cli/cli-commands/runInteractiveChatbot.d.ts +32 -0
  34. package/esm/typings/src/cli/cli-commands/test-command.d.ts +14 -0
  35. package/esm/typings/src/cli/main.d.ts +16 -0
  36. package/esm/typings/src/cli/promptbookCli.d.ts +13 -0
  37. package/esm/typings/src/cli/test/ptbk.d.ts +5 -0
  38. package/esm/typings/src/cli/test/ptbk.test.d.ts +1 -0
  39. package/esm/typings/src/collection/PipelineCollection.d.ts +25 -0
  40. package/esm/typings/src/collection/SimplePipelineCollection.d.ts +37 -0
  41. package/esm/typings/src/collection/collectionToJson.d.ts +13 -0
  42. package/esm/typings/src/collection/collectionToJson.test.d.ts +7 -0
  43. package/esm/typings/src/collection/constructors/createCollectionFromDirectory.d.ts +54 -0
  44. package/esm/typings/src/collection/constructors/createCollectionFromDirectory.test.d.ts +1 -0
  45. package/esm/typings/src/collection/constructors/createCollectionFromJson.d.ts +13 -0
  46. package/esm/typings/src/collection/constructors/createCollectionFromJson.test.d.ts +1 -0
  47. package/esm/typings/src/collection/constructors/createCollectionFromPromise.d.ts +23 -0
  48. package/esm/typings/src/collection/constructors/createCollectionFromPromise.test.d.ts +1 -0
  49. package/esm/typings/src/collection/constructors/createCollectionFromUrl.d.ts +29 -0
  50. package/esm/typings/src/collection/constructors/createSubcollection.d.ts +13 -0
  51. package/esm/typings/src/commands/BOOK_VERSION/BookVersionCommand.d.ts +11 -0
  52. package/esm/typings/src/commands/BOOK_VERSION/bookVersionCommand.test.d.ts +1 -0
  53. package/esm/typings/src/commands/BOOK_VERSION/bookVersionCommandParser.d.ts +9 -0
  54. package/esm/typings/src/commands/EXPECT/ExpectCommand.d.ts +17 -0
  55. package/esm/typings/src/commands/EXPECT/expectCommand.test.d.ts +1 -0
  56. package/esm/typings/src/commands/EXPECT/expectCommandParser.d.ts +9 -0
  57. package/esm/typings/src/commands/FOREACH/ForeachCommand.d.ts +10 -0
  58. package/esm/typings/src/commands/FOREACH/ForeachJson.d.ts +27 -0
  59. package/esm/typings/src/commands/FOREACH/foreachCommand.test.d.ts +1 -0
  60. package/esm/typings/src/commands/FOREACH/foreachCommandParser.d.ts +14 -0
  61. package/esm/typings/src/commands/FORMAT/FormatCommand.d.ts +9 -0
  62. package/esm/typings/src/commands/FORMAT/formatCommand.test.d.ts +1 -0
  63. package/esm/typings/src/commands/FORMAT/formatCommandParser.d.ts +9 -0
  64. package/esm/typings/src/commands/FORMFACTOR/FormfactorCommand.d.ts +11 -0
  65. package/esm/typings/src/commands/FORMFACTOR/formfactorCommand.test.d.ts +1 -0
  66. package/esm/typings/src/commands/FORMFACTOR/formfactorCommandParser.d.ts +11 -0
  67. package/esm/typings/src/commands/JOKER/JokerCommand.d.ts +11 -0
  68. package/esm/typings/src/commands/JOKER/jokerCommand.test.d.ts +1 -0
  69. package/esm/typings/src/commands/JOKER/jokerCommandParser.d.ts +9 -0
  70. package/esm/typings/src/commands/KNOWLEDGE/KnowledgeCommand.d.ts +11 -0
  71. package/esm/typings/src/commands/KNOWLEDGE/knowledgeCommand.test.d.ts +1 -0
  72. package/esm/typings/src/commands/KNOWLEDGE/knowledgeCommandParser.d.ts +12 -0
  73. package/esm/typings/src/commands/KNOWLEDGE/utils/sourceContentToName.d.ts +11 -0
  74. package/esm/typings/src/commands/KNOWLEDGE/utils/sourceContentToName.test.d.ts +4 -0
  75. package/esm/typings/src/commands/MODEL/ModelCommand.d.ts +13 -0
  76. package/esm/typings/src/commands/MODEL/modelCommand.test.d.ts +1 -0
  77. package/esm/typings/src/commands/MODEL/modelCommandParser.d.ts +9 -0
  78. package/esm/typings/src/commands/PARAMETER/ParameterCommand.d.ts +15 -0
  79. package/esm/typings/src/commands/PARAMETER/parameterCommand.test.d.ts +1 -0
  80. package/esm/typings/src/commands/PARAMETER/parameterCommandParser.d.ts +9 -0
  81. package/esm/typings/src/commands/PERSONA/PersonaCommand.d.ts +13 -0
  82. package/esm/typings/src/commands/PERSONA/personaCommand.test.d.ts +1 -0
  83. package/esm/typings/src/commands/PERSONA/personaCommandParser.d.ts +9 -0
  84. package/esm/typings/src/commands/POSTPROCESS/PostprocessCommand.d.ts +11 -0
  85. package/esm/typings/src/commands/POSTPROCESS/postprocessCommand.test.d.ts +1 -0
  86. package/esm/typings/src/commands/POSTPROCESS/postprocessCommandParser.d.ts +9 -0
  87. package/esm/typings/src/commands/SECTION/SectionCommand.d.ts +11 -0
  88. package/esm/typings/src/commands/SECTION/sectionCommand.test.d.ts +1 -0
  89. package/esm/typings/src/commands/SECTION/sectionCommandParser.d.ts +20 -0
  90. package/esm/typings/src/commands/URL/UrlCommand.d.ts +10 -0
  91. package/esm/typings/src/commands/URL/urlCommand.test.d.ts +1 -0
  92. package/esm/typings/src/commands/URL/urlCommandParser.d.ts +9 -0
  93. package/esm/typings/src/commands/X_ACTION/ActionCommand.d.ts +9 -0
  94. package/esm/typings/src/commands/X_ACTION/actionCommand.test.d.ts +1 -0
  95. package/esm/typings/src/commands/X_ACTION/actionCommandParser.d.ts +12 -0
  96. package/esm/typings/src/commands/X_INSTRUMENT/InstrumentCommand.d.ts +9 -0
  97. package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommand.test.d.ts +1 -0
  98. package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommandParser.d.ts +12 -0
  99. package/esm/typings/src/commands/_BOILERPLATE/BoilerplateCommand.d.ts +10 -0
  100. package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommand.test.d.ts +1 -0
  101. package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts +11 -0
  102. package/esm/typings/src/commands/_common/getParserForCommand.d.ts +11 -0
  103. package/esm/typings/src/commands/_common/getParserForCommand.test.d.ts +1 -0
  104. package/esm/typings/src/commands/_common/parseCommand.d.ts +12 -0
  105. package/esm/typings/src/commands/_common/parseCommand.test.d.ts +1 -0
  106. package/esm/typings/src/commands/_common/stringifyCommand.d.ts +11 -0
  107. package/esm/typings/src/commands/_common/stringifyCommand.test.d.ts +1 -0
  108. package/esm/typings/src/commands/_common/types/Command.d.ts +6 -0
  109. package/esm/typings/src/commands/_common/types/CommandParser.d.ts +189 -0
  110. package/esm/typings/src/commands/_common/types/CommandType.d.ts +17 -0
  111. package/esm/typings/src/commands/_common/types/CommandUsagePlaces.d.ts +11 -0
  112. package/esm/typings/src/commands/index.d.ts +9 -0
  113. package/esm/typings/src/config.d.ts +227 -0
  114. package/esm/typings/src/config.test.d.ts +4 -0
  115. package/esm/typings/src/constants.d.ts +35 -0
  116. package/esm/typings/src/conversion/compilePipeline.d.ts +28 -0
  117. package/esm/typings/src/conversion/compilePipeline.test.d.ts +1 -0
  118. package/esm/typings/src/conversion/pipelineJsonToString.d.ts +18 -0
  119. package/esm/typings/src/conversion/precompilePipeline.d.ts +30 -0
  120. package/esm/typings/src/conversion/precompilePipeline.test.d.ts +1 -0
  121. package/esm/typings/src/conversion/prettify/PrettifyOptions.d.ts +13 -0
  122. package/esm/typings/src/conversion/prettify/prettifyPipelineString.d.ts +12 -0
  123. package/esm/typings/src/conversion/prettify/renderPipelineMermaidOptions.d.ts +30 -0
  124. package/esm/typings/src/conversion/utils/extractParameterNamesFromTask.d.ts +15 -0
  125. package/esm/typings/src/conversion/utils/extractParameterNamesFromTask.test.d.ts +1 -0
  126. package/esm/typings/src/conversion/utils/extractVariablesFromScript.d.ts +14 -0
  127. package/esm/typings/src/conversion/utils/extractVariablesFromScript.test.d.ts +1 -0
  128. package/esm/typings/src/conversion/validation/_importPipeline.d.ts +30 -0
  129. package/esm/typings/src/conversion/validation/pipelineStringToJson-parseErrors.test.d.ts +4 -0
  130. package/esm/typings/src/conversion/validation/validatePipeline-logicErrors.test.d.ts +4 -0
  131. package/esm/typings/src/conversion/validation/validatePipeline.d.ts +42 -0
  132. package/esm/typings/src/conversion/validation/validatePipeline.test.d.ts +4 -0
  133. package/esm/typings/src/dialogs/callback/CallbackInterfaceTools.d.ts +17 -0
  134. package/esm/typings/src/dialogs/callback/CallbackInterfaceToolsOptions.d.ts +14 -0
  135. package/esm/typings/src/dialogs/simple-prompt/SimplePromptInterfaceTools.d.ts +22 -0
  136. package/esm/typings/src/dialogs/user-interface-execution-tools.test.d.ts +1 -0
  137. package/esm/typings/src/errors/0-BoilerplateError.d.ts +12 -0
  138. package/esm/typings/src/errors/0-index.d.ts +85 -0
  139. package/esm/typings/src/errors/AbstractFormatError.d.ts +11 -0
  140. package/esm/typings/src/errors/CollectionError.d.ts +9 -0
  141. package/esm/typings/src/errors/EnvironmentMismatchError.d.ts +9 -0
  142. package/esm/typings/src/errors/ExpectError.d.ts +12 -0
  143. package/esm/typings/src/errors/KnowledgeScrapeError.d.ts +9 -0
  144. package/esm/typings/src/errors/LimitReachedError.d.ts +9 -0
  145. package/esm/typings/src/errors/MissingToolsError.d.ts +9 -0
  146. package/esm/typings/src/errors/NotFoundError.d.ts +9 -0
  147. package/esm/typings/src/errors/NotYetImplementedError.d.ts +9 -0
  148. package/esm/typings/src/errors/ParseError.d.ts +12 -0
  149. package/esm/typings/src/errors/PipelineExecutionError.d.ts +9 -0
  150. package/esm/typings/src/errors/PipelineLogicError.d.ts +9 -0
  151. package/esm/typings/src/errors/PipelineUrlError.d.ts +9 -0
  152. package/esm/typings/src/errors/UnexpectedError.d.ts +9 -0
  153. package/esm/typings/src/errors/utils/ErrorJson.d.ts +20 -0
  154. package/esm/typings/src/errors/utils/deserializeError.d.ts +7 -0
  155. package/esm/typings/src/errors/utils/deserializeError.test.d.ts +1 -0
  156. package/esm/typings/src/errors/utils/getErrorReportUrl.d.ts +6 -0
  157. package/esm/typings/src/errors/utils/serializeError.d.ts +7 -0
  158. package/esm/typings/src/errors/utils/serializeError.test.d.ts +1 -0
  159. package/esm/typings/src/executables/$provideExecutablesForNode.d.ts +12 -0
  160. package/esm/typings/src/executables/apps/locateLibreoffice.d.ts +11 -0
  161. package/esm/typings/src/executables/apps/locateLibreoffice.test.d.ts +1 -0
  162. package/esm/typings/src/executables/apps/locatePandoc.d.ts +11 -0
  163. package/esm/typings/src/executables/apps/locatePandoc.test.d.ts +1 -0
  164. package/esm/typings/src/executables/locateApp.d.ts +33 -0
  165. package/esm/typings/src/executables/locateApp.test.d.ts +1 -0
  166. package/esm/typings/src/executables/platforms/locateAppOnLinux.d.ts +12 -0
  167. package/esm/typings/src/executables/platforms/locateAppOnMacOs.d.ts +12 -0
  168. package/esm/typings/src/executables/platforms/locateAppOnWindows.d.ts +12 -0
  169. package/esm/typings/src/execution/AvailableModel.d.ts +38 -0
  170. package/esm/typings/src/execution/CommonToolsOptions.d.ts +24 -0
  171. package/esm/typings/src/execution/EmbeddingVector.d.ts +8 -0
  172. package/esm/typings/src/execution/Executables.d.ts +18 -0
  173. package/esm/typings/src/execution/ExecutionTools.d.ts +69 -0
  174. package/esm/typings/src/execution/FilesystemTools.d.ts +9 -0
  175. package/esm/typings/src/execution/LlmExecutionTools.d.ts +61 -0
  176. package/esm/typings/src/execution/LlmExecutionToolsConstructor.d.ts +10 -0
  177. package/esm/typings/src/execution/PipelineExecutor.d.ts +19 -0
  178. package/esm/typings/src/execution/PipelineExecutorResult.d.ts +50 -0
  179. package/esm/typings/src/execution/PromptResult.d.ts +101 -0
  180. package/esm/typings/src/execution/PromptResultUsage.d.ts +33 -0
  181. package/esm/typings/src/execution/PromptbookFetch.d.ts +5 -0
  182. package/esm/typings/src/execution/PromptbookFetch.test-type.d.ts +5 -0
  183. package/esm/typings/src/execution/ScriptExecutionTools.d.ts +39 -0
  184. package/esm/typings/src/execution/UncertainNumber.d.ts +19 -0
  185. package/esm/typings/src/execution/UserInterfaceTools.d.ts +46 -0
  186. package/esm/typings/src/execution/assertsExecutionSuccessful.d.ts +13 -0
  187. package/esm/typings/src/execution/createPipelineExecutor/$OngoingTaskResult.d.ts +45 -0
  188. package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorOptions.d.ts +46 -0
  189. package/esm/typings/src/execution/createPipelineExecutor/00-createPipelineExecutor.d.ts +13 -0
  190. package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts +49 -0
  191. package/esm/typings/src/execution/createPipelineExecutor/20-executeTask.d.ts +51 -0
  192. package/esm/typings/src/execution/createPipelineExecutor/30-executeFormatSubvalues.d.ts +15 -0
  193. package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +64 -0
  194. package/esm/typings/src/execution/createPipelineExecutor/filterJustOutputParameters.d.ts +34 -0
  195. package/esm/typings/src/execution/createPipelineExecutor/getContextForTask.d.ts +10 -0
  196. package/esm/typings/src/execution/createPipelineExecutor/getExamplesForTask.d.ts +10 -0
  197. package/esm/typings/src/execution/createPipelineExecutor/getKnowledgeForTask.d.ts +27 -0
  198. package/esm/typings/src/execution/createPipelineExecutor/getReservedParametersForTask.d.ts +30 -0
  199. package/esm/typings/src/execution/embeddingVectorToString.d.ts +7 -0
  200. package/esm/typings/src/execution/execution-report/ExecutionPromptReportJson.d.ts +24 -0
  201. package/esm/typings/src/execution/execution-report/ExecutionReportJson.d.ts +41 -0
  202. package/esm/typings/src/execution/execution-report/ExecutionReportString.d.ts +16 -0
  203. package/esm/typings/src/execution/execution-report/ExecutionReportStringOptions.d.ts +25 -0
  204. package/esm/typings/src/execution/execution-report/countWorkingDuration.d.ts +7 -0
  205. package/esm/typings/src/execution/execution-report/countWorkingDuration.test.d.ts +1 -0
  206. package/esm/typings/src/execution/execution-report/executionReportJsonToString.d.ts +15 -0
  207. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/AutomaticTranslator.d.ts +7 -0
  208. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/DebugAutomaticTranslator.d.ts +11 -0
  209. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/FakeAutomaticTranslator.d.ts +8 -0
  210. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/LindatAutomaticTranslator.d.ts +22 -0
  211. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/TranslatorOptions.d.ts +7 -0
  212. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.d.ts +8 -0
  213. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.test.d.ts +1 -0
  214. package/esm/typings/src/execution/translation/automatic-translate/translateMessages.d.ts +12 -0
  215. package/esm/typings/src/execution/utils/$provideExecutionToolsForNode.d.ts +13 -0
  216. package/esm/typings/src/execution/utils/addUsage.d.ts +9 -0
  217. package/esm/typings/src/execution/utils/addUsage.test.d.ts +1 -0
  218. package/esm/typings/src/execution/utils/checkExpectations.d.ts +29 -0
  219. package/esm/typings/src/execution/utils/checkExpectations.test.d.ts +1 -0
  220. package/esm/typings/src/execution/utils/computeUsageCounts.d.ts +10 -0
  221. package/esm/typings/src/execution/utils/forEachAsync.d.ts +20 -0
  222. package/esm/typings/src/execution/utils/uncertainNumber.d.ts +9 -0
  223. package/esm/typings/src/execution/utils/usage-constants.d.ts +130 -0
  224. package/esm/typings/src/execution/utils/usageToHuman.d.ts +16 -0
  225. package/esm/typings/src/execution/utils/usageToWorktime.d.ts +12 -0
  226. package/esm/typings/src/execution/utils/usageToWorktime.test.d.ts +1 -0
  227. package/esm/typings/src/expectations/drafts/isDomainNameFree.d.ts +10 -0
  228. package/esm/typings/src/expectations/drafts/isGithubNameFree.d.ts +10 -0
  229. package/esm/typings/src/formats/_common/FormatDefinition.d.ts +70 -0
  230. package/esm/typings/src/formats/_common/FormatSubvalueDefinition.d.ts +31 -0
  231. package/esm/typings/src/formats/csv/CsvFormatDefinition.d.ts +17 -0
  232. package/esm/typings/src/formats/csv/CsvFormatError.d.ts +10 -0
  233. package/esm/typings/src/formats/csv/CsvSettings.d.ts +13 -0
  234. package/esm/typings/src/formats/index.d.ts +9 -0
  235. package/esm/typings/src/formats/json/JsonFormatDefinition.d.ts +19 -0
  236. package/esm/typings/src/formats/json/utils/isValidJsonString.d.ts +6 -0
  237. package/esm/typings/src/formats/json/utils/isValidJsonString.test.d.ts +1 -0
  238. package/esm/typings/src/formats/text/TextFormatDefinition.d.ts +19 -0
  239. package/esm/typings/src/formats/xml/XmlFormatDefinition.d.ts +19 -0
  240. package/esm/typings/src/formfactors/_boilerplate/BoilerplateFormfactorDefinition.d.ts +14 -0
  241. package/esm/typings/src/formfactors/_common/AbstractFormfactorDefinition.d.ts +40 -0
  242. package/esm/typings/src/formfactors/_common/FormfactorDefinition.d.ts +8 -0
  243. package/esm/typings/src/formfactors/_common/string_formfactor_name.d.ts +5 -0
  244. package/esm/typings/src/formfactors/chatbot/ChatbotFormfactorDefinition.d.ts +45 -0
  245. package/esm/typings/src/formfactors/generator/GeneratorFormfactorDefinition.d.ts +19 -0
  246. package/esm/typings/src/formfactors/generic/GenericFormfactorDefinition.d.ts +14 -0
  247. package/esm/typings/src/formfactors/index.d.ts +123 -0
  248. package/esm/typings/src/formfactors/matcher/MatcherFormfactorDefinition.d.ts +19 -0
  249. package/esm/typings/src/formfactors/sheets/SheetsFormfactorDefinition.d.ts +25 -0
  250. package/esm/typings/src/formfactors/translator/TranslatorFormfactorDefinition.d.ts +24 -0
  251. package/esm/typings/src/high-level-abstractions/_common/HighLevelAbstraction.d.ts +20 -0
  252. package/esm/typings/src/high-level-abstractions/implicit-formfactor/ImplicitFormfactorHla.d.ts +10 -0
  253. package/esm/typings/src/high-level-abstractions/index.d.ts +44 -0
  254. package/esm/typings/src/high-level-abstractions/quick-chatbot/QuickChatbotHla.d.ts +10 -0
  255. package/esm/typings/src/llm-providers/_common/register/$llmToolsMetadataRegister.d.ts +13 -0
  256. package/esm/typings/src/llm-providers/_common/register/$llmToolsRegister.d.ts +13 -0
  257. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsConfigurationFromEnv.d.ts +25 -0
  258. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForCli.d.ts +15 -0
  259. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForTestingAndScriptsAndPlayground.d.ts +24 -0
  260. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsFromEnv.d.ts +27 -0
  261. package/esm/typings/src/llm-providers/_common/register/$registeredLlmToolsMessage.d.ts +13 -0
  262. package/esm/typings/src/llm-providers/_common/register/LlmToolsConfiguration.d.ts +23 -0
  263. package/esm/typings/src/llm-providers/_common/register/LlmToolsMetadata.d.ts +36 -0
  264. package/esm/typings/src/llm-providers/_common/register/LlmToolsOptions.d.ts +10 -0
  265. package/esm/typings/src/llm-providers/_common/register/createLlmToolsFromConfiguration.d.ts +40 -0
  266. package/esm/typings/src/llm-providers/_common/register/createLlmToolsFromConfiguration.test.d.ts +1 -0
  267. package/esm/typings/src/llm-providers/_common/utils/cache/CacheItem.d.ts +28 -0
  268. package/esm/typings/src/llm-providers/_common/utils/cache/CacheLlmToolsOptions.d.ts +19 -0
  269. package/esm/typings/src/llm-providers/_common/utils/cache/cacheLlmTools.d.ts +19 -0
  270. package/esm/typings/src/llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage.d.ts +15 -0
  271. package/esm/typings/src/llm-providers/_common/utils/count-total-usage/countTotalUsage.d.ts +17 -0
  272. package/esm/typings/src/llm-providers/_common/utils/count-total-usage/limitTotalUsage.d.ts +36 -0
  273. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +60 -0
  274. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions.d.ts +31 -0
  275. package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +24 -0
  276. package/esm/typings/src/llm-providers/anthropic-claude/computeAnthropicClaudeUsage.d.ts +18 -0
  277. package/esm/typings/src/llm-providers/anthropic-claude/computeAnthropicClaudeUsage.test.d.ts +4 -0
  278. package/esm/typings/src/llm-providers/anthropic-claude/createAnthropicClaudeExecutionTools.d.ts +19 -0
  279. package/esm/typings/src/llm-providers/anthropic-claude/playground/playground.d.ts +7 -0
  280. package/esm/typings/src/llm-providers/anthropic-claude/register-configuration.d.ts +13 -0
  281. package/esm/typings/src/llm-providers/anthropic-claude/register-constructor.d.ts +14 -0
  282. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +63 -0
  283. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionToolsOptions.d.ts +37 -0
  284. package/esm/typings/src/llm-providers/azure-openai/createAzureOpenAiExecutionTools.d.ts +15 -0
  285. package/esm/typings/src/llm-providers/azure-openai/playground/playground.d.ts +6 -0
  286. package/esm/typings/src/llm-providers/azure-openai/register-configuration.d.ts +13 -0
  287. package/esm/typings/src/llm-providers/azure-openai/register-constructor.d.ts +14 -0
  288. package/esm/typings/src/llm-providers/google/GoogleExecutionToolsOptions.d.ts +9 -0
  289. package/esm/typings/src/llm-providers/google/createGoogleExecutionTools.d.ts +14 -0
  290. package/esm/typings/src/llm-providers/google/register-configuration.d.ts +13 -0
  291. package/esm/typings/src/llm-providers/google/register-constructor.d.ts +14 -0
  292. package/esm/typings/src/llm-providers/mocked/$fakeTextToExpectations.d.ts +15 -0
  293. package/esm/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts +40 -0
  294. package/esm/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts +44 -0
  295. package/esm/typings/src/llm-providers/mocked/test/fakeTextToExpectations.test.d.ts +1 -0
  296. package/esm/typings/src/llm-providers/mocked/test/faked-completion.test.d.ts +1 -0
  297. package/esm/typings/src/llm-providers/mocked/test/joker.test.d.ts +4 -0
  298. package/esm/typings/src/llm-providers/mocked/test/mocked-chat.test.d.ts +5 -0
  299. package/esm/typings/src/llm-providers/mocked/test/mocked-completion.test.d.ts +4 -0
  300. package/esm/typings/src/llm-providers/multiple/MultipleLlmExecutionTools.d.ts +63 -0
  301. package/esm/typings/src/llm-providers/multiple/joinLlmExecutionTools.d.ts +21 -0
  302. package/esm/typings/src/llm-providers/multiple/playground/playground.d.ts +5 -0
  303. package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionTools.d.ts +36 -0
  304. package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionToolsOptions.d.ts +14 -0
  305. package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +84 -0
  306. package/esm/typings/src/llm-providers/openai/OpenAiExecutionToolsOptions.d.ts +11 -0
  307. package/esm/typings/src/llm-providers/openai/computeOpenAiUsage.d.ts +18 -0
  308. package/esm/typings/src/llm-providers/openai/computeOpenAiUsage.test.d.ts +4 -0
  309. package/esm/typings/src/llm-providers/openai/computeUsage.d.ts +16 -0
  310. package/esm/typings/src/llm-providers/openai/computeUsage.test.d.ts +1 -0
  311. package/esm/typings/src/llm-providers/openai/createOpenAiAssistantExecutionTools.d.ts +15 -0
  312. package/esm/typings/src/llm-providers/openai/createOpenAiExecutionTools.d.ts +15 -0
  313. package/esm/typings/src/llm-providers/openai/openai-models.d.ts +31 -0
  314. package/esm/typings/src/llm-providers/openai/playground/playground.d.ts +6 -0
  315. package/esm/typings/src/llm-providers/openai/register-configuration.d.ts +22 -0
  316. package/esm/typings/src/llm-providers/openai/register-constructor.d.ts +23 -0
  317. package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts +63 -0
  318. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Error.d.ts +7 -0
  319. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_ListModels_Request.d.ts +38 -0
  320. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_ListModels_Response.d.ts +15 -0
  321. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Prompt_Progress.d.ts +12 -0
  322. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Prompt_Request.d.ts +45 -0
  323. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Prompt_Response.d.ts +12 -0
  324. package/esm/typings/src/llm-providers/remote/interfaces/RemoteLlmExecutionToolsOptions.d.ts +54 -0
  325. package/esm/typings/src/llm-providers/remote/interfaces/RemoteServerOptions.d.ts +73 -0
  326. package/esm/typings/src/llm-providers/remote/playground/playground.d.ts +5 -0
  327. package/esm/typings/src/llm-providers/remote/startRemoteServer.d.ts +23 -0
  328. package/esm/typings/src/llm-providers/vercel/VercelExecutionToolsOptions.d.ts +23 -0
  329. package/esm/typings/src/llm-providers/vercel/VercelProvider.d.ts +13 -0
  330. package/esm/typings/src/llm-providers/vercel/createExecutionToolsFromVercelProvider.d.ts +8 -0
  331. package/esm/typings/src/llm-providers/vercel/playground/playground.d.ts +6 -0
  332. package/esm/typings/src/personas/preparePersona.d.ts +17 -0
  333. package/esm/typings/src/pipeline/PipelineInterface/PipelineInterface.d.ts +22 -0
  334. package/esm/typings/src/pipeline/PipelineInterface/constants.d.ts +14 -0
  335. package/esm/typings/src/pipeline/PipelineInterface/getPipelineInterface.d.ts +11 -0
  336. package/esm/typings/src/pipeline/PipelineInterface/isPipelineImplementingInterface.d.ts +26 -0
  337. package/esm/typings/src/pipeline/PipelineInterface/isPipelineInterfacesEqual.d.ts +10 -0
  338. package/esm/typings/src/pipeline/PipelineJson/CommonTaskJson.d.ts +100 -0
  339. package/esm/typings/src/pipeline/PipelineJson/DialogTaskJson.d.ts +13 -0
  340. package/esm/typings/src/pipeline/PipelineJson/Expectations.d.ts +40 -0
  341. package/esm/typings/src/pipeline/PipelineJson/KnowledgePieceJson.d.ts +73 -0
  342. package/esm/typings/src/pipeline/PipelineJson/KnowledgeSourceJson.d.ts +44 -0
  343. package/esm/typings/src/pipeline/PipelineJson/ParameterJson.d.ts +98 -0
  344. package/esm/typings/src/pipeline/PipelineJson/PersonaJson.d.ts +45 -0
  345. package/esm/typings/src/pipeline/PipelineJson/PipelineJson.d.ts +102 -0
  346. package/esm/typings/src/pipeline/PipelineJson/PreparationJson.d.ts +22 -0
  347. package/esm/typings/src/pipeline/PipelineJson/PromptTaskJson.d.ts +26 -0
  348. package/esm/typings/src/pipeline/PipelineJson/ScriptTaskJson.d.ts +20 -0
  349. package/esm/typings/src/pipeline/PipelineJson/SimpleTaskJson.d.ts +13 -0
  350. package/esm/typings/src/pipeline/PipelineJson/TaskJson.d.ts +11 -0
  351. package/esm/typings/src/pipeline/PipelineString.d.ts +12 -0
  352. package/esm/typings/src/postprocessing/utils/extractBlock.d.ts +16 -0
  353. package/esm/typings/src/postprocessing/utils/extractJsonBlock.d.ts +25 -0
  354. package/esm/typings/src/postprocessing/utils/extractJsonBlock.test.d.ts +1 -0
  355. package/esm/typings/src/prepare/PrepareAndScrapeOptions.d.ts +51 -0
  356. package/esm/typings/src/prepare/isPipelinePrepared.d.ts +16 -0
  357. package/esm/typings/src/prepare/isPipelinePrepared.test.d.ts +1 -0
  358. package/esm/typings/src/prepare/preparePipeline.d.ts +20 -0
  359. package/esm/typings/src/prepare/prepareTasks.d.ts +33 -0
  360. package/esm/typings/src/prepare/unpreparePipeline.d.ts +13 -0
  361. package/esm/typings/src/scrapers/_common/Converter.d.ts +22 -0
  362. package/esm/typings/src/scrapers/_common/Scraper.d.ts +59 -0
  363. package/esm/typings/src/scrapers/_common/ScraperIntermediateSource.d.ts +11 -0
  364. package/esm/typings/src/scrapers/_common/prepareKnowledgePieces.d.ts +19 -0
  365. package/esm/typings/src/scrapers/_common/prepareKnowledgePieces.test.d.ts +1 -0
  366. package/esm/typings/src/scrapers/_common/register/$provideFilesystemForNode.d.ts +11 -0
  367. package/esm/typings/src/scrapers/_common/register/$provideScrapersForBrowser.d.ts +12 -0
  368. package/esm/typings/src/scrapers/_common/register/$provideScrapersForNode.d.ts +15 -0
  369. package/esm/typings/src/scrapers/_common/register/$registeredScrapersMessage.d.ts +13 -0
  370. package/esm/typings/src/scrapers/_common/register/$scrapersMetadataRegister.d.ts +13 -0
  371. package/esm/typings/src/scrapers/_common/register/$scrapersRegister.d.ts +13 -0
  372. package/esm/typings/src/scrapers/_common/register/ScraperAndConverterMetadata.d.ts +41 -0
  373. package/esm/typings/src/scrapers/_common/register/ScraperConstructor.d.ts +12 -0
  374. package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.d.ts +34 -0
  375. package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.test.d.ts +4 -0
  376. package/esm/typings/src/scrapers/_common/utils/makeKnowledgeSourceHandler.d.ts +11 -0
  377. package/esm/typings/src/scrapers/_common/utils/scraperFetch.d.ts +7 -0
  378. package/esm/typings/src/scrapers/document/DocumentScraper.d.ts +43 -0
  379. package/esm/typings/src/scrapers/document/DocumentScraper.test.d.ts +4 -0
  380. package/esm/typings/src/scrapers/document/createDocumentScraper.d.ts +20 -0
  381. package/esm/typings/src/scrapers/document/playground/document-scraper-playground.d.ts +5 -0
  382. package/esm/typings/src/scrapers/document/register-constructor.d.ts +14 -0
  383. package/esm/typings/src/scrapers/document/register-metadata.d.ts +27 -0
  384. package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.d.ts +43 -0
  385. package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.test.d.ts +4 -0
  386. package/esm/typings/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts +20 -0
  387. package/esm/typings/src/scrapers/document-legacy/playground/legacy-document-scraper-playground.d.ts +5 -0
  388. package/esm/typings/src/scrapers/document-legacy/register-constructor.d.ts +14 -0
  389. package/esm/typings/src/scrapers/document-legacy/register-metadata.d.ts +27 -0
  390. package/esm/typings/src/scrapers/markdown/MarkdownScraper.d.ts +29 -0
  391. package/esm/typings/src/scrapers/markdown/MarkdownScraper.test.d.ts +4 -0
  392. package/esm/typings/src/scrapers/markdown/createMarkdownScraper.d.ts +20 -0
  393. package/esm/typings/src/scrapers/markdown/playground/markdown-scraper-playground.d.ts +5 -0
  394. package/esm/typings/src/scrapers/markdown/register-constructor.d.ts +14 -0
  395. package/esm/typings/src/scrapers/markdown/register-metadata.d.ts +27 -0
  396. package/esm/typings/src/scrapers/pdf/PdfScraper.d.ts +40 -0
  397. package/esm/typings/src/scrapers/pdf/createPdfScraper.d.ts +20 -0
  398. package/esm/typings/src/scrapers/pdf/playground/pdf-scraper-playground.d.ts +5 -0
  399. package/esm/typings/src/scrapers/pdf/register-constructor.d.ts +14 -0
  400. package/esm/typings/src/scrapers/pdf/register-metadata.d.ts +27 -0
  401. package/esm/typings/src/scrapers/website/WebsiteScraper.d.ts +50 -0
  402. package/esm/typings/src/scrapers/website/createWebsiteScraper.d.ts +20 -0
  403. package/esm/typings/src/scrapers/website/playground/website-scraper-playground.d.ts +5 -0
  404. package/esm/typings/src/scrapers/website/register-constructor.d.ts +14 -0
  405. package/esm/typings/src/scrapers/website/register-metadata.d.ts +27 -0
  406. package/esm/typings/src/scrapers/website/utils/createShowdownConverter.d.ts +7 -0
  407. package/esm/typings/src/scrapers/website/utils/createShowdownConverter.test.d.ts +1 -0
  408. package/esm/typings/src/scripting/_test/custom-function-async.test.ts.test.d.ts +1 -0
  409. package/esm/typings/src/scripting/_test/custom-function-missing.test.d.ts +1 -0
  410. package/esm/typings/src/scripting/_test/custom-function-with-dependencies.test.d.ts +1 -0
  411. package/esm/typings/src/scripting/_test/custom-function.test.d.ts +1 -0
  412. package/esm/typings/src/scripting/_test/postprocessing.test.d.ts +1 -0
  413. package/esm/typings/src/scripting/_test/script-execution-errors.test.d.ts +1 -0
  414. package/esm/typings/src/scripting/_test/script-execution-tools.test.d.ts +1 -0
  415. package/esm/typings/src/scripting/javascript/JavascriptEvalExecutionTools.d.ts +22 -0
  416. package/esm/typings/src/scripting/javascript/JavascriptEvalExecutionTools.test.d.ts +4 -0
  417. package/esm/typings/src/scripting/javascript/JavascriptExecutionTools.d.ts +8 -0
  418. package/esm/typings/src/scripting/javascript/JavascriptExecutionToolsOptions.d.ts +26 -0
  419. package/esm/typings/src/scripting/javascript/postprocessing-functions.d.ts +52 -0
  420. package/esm/typings/src/scripting/javascript/utils/preserve.d.ts +13 -0
  421. package/esm/typings/src/scripting/javascript/utils/unknownToString.d.ts +8 -0
  422. package/esm/typings/src/scripting/python/PythonExecutionTools.d.ts +18 -0
  423. package/esm/typings/src/scripting/typescript/TypescriptExecutionTools.d.ts +18 -0
  424. package/esm/typings/src/storage/_common/PromptbookStorage.d.ts +24 -0
  425. package/esm/typings/src/storage/_common/PromptbookStorage.test-type.d.ts +5 -0
  426. package/esm/typings/src/storage/blackhole/BlackholeStorage.d.ts +33 -0
  427. package/esm/typings/src/storage/file-cache-storage/FileCacheStorage.d.ts +33 -0
  428. package/esm/typings/src/storage/file-cache-storage/FileCacheStorageOptions.d.ts +10 -0
  429. package/esm/typings/src/storage/file-cache-storage/utils/nameToSubfolderPath.d.ts +7 -0
  430. package/esm/typings/src/storage/file-cache-storage/utils/nameToSubfolderPath.test.d.ts +1 -0
  431. package/esm/typings/src/storage/local-storage/getLocalStorage.d.ts +10 -0
  432. package/esm/typings/src/storage/local-storage/getSessionStorage.d.ts +10 -0
  433. package/esm/typings/src/storage/local-storage/utils/makePromptbookStorageFromWebStorage.d.ts +11 -0
  434. package/esm/typings/src/storage/memory/MemoryStorage.d.ts +33 -0
  435. package/esm/typings/src/storage/utils/PrefixStorage.d.ts +25 -0
  436. package/esm/typings/src/types/Arrayable.d.ts +10 -0
  437. package/esm/typings/src/types/IntermediateFilesStrategy.d.ts +7 -0
  438. package/esm/typings/src/types/ModelRequirements.d.ts +104 -0
  439. package/esm/typings/src/types/ModelVariant.d.ts +15 -0
  440. package/esm/typings/src/types/Prompt.d.ts +111 -0
  441. package/esm/typings/src/types/ScriptLanguage.d.ts +13 -0
  442. package/esm/typings/src/types/SectionType.d.ts +21 -0
  443. package/esm/typings/src/types/TaskProgress.d.ts +43 -0
  444. package/esm/typings/src/types/TaskType.d.ts +15 -0
  445. package/esm/typings/src/types/typeAliasEmoji.d.ts +12 -0
  446. package/esm/typings/src/types/typeAliases.d.ts +622 -0
  447. package/esm/typings/src/utils/$Register.d.ts +39 -0
  448. package/esm/typings/src/utils/$getCurrentDate.d.ts +10 -0
  449. package/esm/typings/src/utils/FromtoItems.d.ts +19 -0
  450. package/esm/typings/src/utils/arrayableToArray.d.ts +11 -0
  451. package/esm/typings/src/utils/arrayableToArray.test.d.ts +1 -0
  452. package/esm/typings/src/utils/editable/types/PipelineEditableSerialized.d.ts +42 -0
  453. package/esm/typings/src/utils/editable/utils/removePipelineCommand.d.ts +22 -0
  454. package/esm/typings/src/utils/editable/utils/removePipelineCommand.test.d.ts +1 -0
  455. package/esm/typings/src/utils/editable/utils/renamePipelineParameter.d.ts +26 -0
  456. package/esm/typings/src/utils/editable/utils/renamePipelineParameter.test.d.ts +1 -0
  457. package/esm/typings/src/utils/editable/utils/stringifyPipelineJson.d.ts +16 -0
  458. package/esm/typings/src/utils/editable/utils/stringifyPipelineJson.test.d.ts +1 -0
  459. package/esm/typings/src/utils/emojis.d.ts +24 -0
  460. package/esm/typings/src/utils/environment/$getGlobalScope.d.ts +9 -0
  461. package/esm/typings/src/utils/environment/$isRunningInBrowser.d.ts +8 -0
  462. package/esm/typings/src/utils/environment/$isRunningInJest.d.ts +8 -0
  463. package/esm/typings/src/utils/environment/$isRunningInNode.d.ts +8 -0
  464. package/esm/typings/src/utils/environment/$isRunningInWebWorker.d.ts +8 -0
  465. package/esm/typings/src/utils/execCommand/$execCommand.d.ts +16 -0
  466. package/esm/typings/src/utils/execCommand/$execCommandNormalizeOptions.d.ts +12 -0
  467. package/esm/typings/src/utils/execCommand/$execCommands.d.ts +18 -0
  468. package/esm/typings/src/utils/execCommand/ExecCommandOptions.d.ts +45 -0
  469. package/esm/typings/src/utils/execCommand/execCommand.test.d.ts +1 -0
  470. package/esm/typings/src/utils/execCommand/execCommandNormalizeOptions.test.d.ts +1 -0
  471. package/esm/typings/src/utils/expectation-counters/constants.d.ts +16 -0
  472. package/esm/typings/src/utils/expectation-counters/countCharacters.d.ts +7 -0
  473. package/esm/typings/src/utils/expectation-counters/countCharacters.test.d.ts +1 -0
  474. package/esm/typings/src/utils/expectation-counters/countLines.d.ts +9 -0
  475. package/esm/typings/src/utils/expectation-counters/countLines.test.d.ts +1 -0
  476. package/esm/typings/src/utils/expectation-counters/countPages.d.ts +9 -0
  477. package/esm/typings/src/utils/expectation-counters/countPages.test.d.ts +1 -0
  478. package/esm/typings/src/utils/expectation-counters/countParagraphs.d.ts +7 -0
  479. package/esm/typings/src/utils/expectation-counters/countParagraphs.test.d.ts +1 -0
  480. package/esm/typings/src/utils/expectation-counters/countSentences.d.ts +13 -0
  481. package/esm/typings/src/utils/expectation-counters/countSentences.test.d.ts +1 -0
  482. package/esm/typings/src/utils/expectation-counters/countWords.d.ts +7 -0
  483. package/esm/typings/src/utils/expectation-counters/countWords.test.d.ts +1 -0
  484. package/esm/typings/src/utils/expectation-counters/index.d.ts +12 -0
  485. package/esm/typings/src/utils/files/extensionToMimeType.d.ts +8 -0
  486. package/esm/typings/src/utils/files/extensionToMimeType.test.d.ts +1 -0
  487. package/esm/typings/src/utils/files/getFileExtension.d.ts +8 -0
  488. package/esm/typings/src/utils/files/getFileExtension.test.d.ts +1 -0
  489. package/esm/typings/src/utils/files/isDirectoryExisting.d.ts +14 -0
  490. package/esm/typings/src/utils/files/isDirectoryExisting.test.d.ts +1 -0
  491. package/esm/typings/src/utils/files/isExecutable.d.ts +11 -0
  492. package/esm/typings/src/utils/files/isFileExisting.d.ts +13 -0
  493. package/esm/typings/src/utils/files/isFileExisting.test.d.ts +1 -0
  494. package/esm/typings/src/utils/files/listAllFiles.d.ts +17 -0
  495. package/esm/typings/src/utils/files/listAllFiles.test.d.ts +1 -0
  496. package/esm/typings/src/utils/formatNumber.d.ts +6 -0
  497. package/esm/typings/src/utils/formatNumber.test.d.ts +1 -0
  498. package/esm/typings/src/utils/getBookTemplate.d.ts +12 -0
  499. package/esm/typings/src/utils/markdown/addAutoGeneratedSection.d.ts +14 -0
  500. package/esm/typings/src/utils/markdown/addAutoGeneratedSection.test.d.ts +1 -0
  501. package/esm/typings/src/utils/markdown/createMarkdownChart.d.ts +38 -0
  502. package/esm/typings/src/utils/markdown/createMarkdownChart.test.d.ts +1 -0
  503. package/esm/typings/src/utils/markdown/createMarkdownTable.d.ts +11 -0
  504. package/esm/typings/src/utils/markdown/createMarkdownTable.test.d.ts +1 -0
  505. package/esm/typings/src/utils/markdown/escapeMarkdownBlock.d.ts +11 -0
  506. package/esm/typings/src/utils/markdown/escapeMarkdownBlock.test.d.ts +1 -0
  507. package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown-real.test.d.ts +1 -0
  508. package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.d.ts +36 -0
  509. package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.test.d.ts +1 -0
  510. package/esm/typings/src/utils/markdown/extractAllListItemsFromMarkdown.d.ts +15 -0
  511. package/esm/typings/src/utils/markdown/extractAllListItemsFromMarkdown.test.d.ts +1 -0
  512. package/esm/typings/src/utils/markdown/extractOneBlockFromMarkdown.d.ts +22 -0
  513. package/esm/typings/src/utils/markdown/extractOneBlockFromMarkdown.test.d.ts +1 -0
  514. package/esm/typings/src/utils/markdown/flattenMarkdown.d.ts +17 -0
  515. package/esm/typings/src/utils/markdown/flattenMarkdown.test.d.ts +1 -0
  516. package/esm/typings/src/utils/markdown/parseMarkdownSection.d.ts +34 -0
  517. package/esm/typings/src/utils/markdown/parseMarkdownSection.test.d.ts +1 -0
  518. package/esm/typings/src/utils/markdown/prettifyMarkdown.d.ts +9 -0
  519. package/esm/typings/src/utils/markdown/prettifyMarkdown.test.d.ts +1 -0
  520. package/esm/typings/src/utils/markdown/removeContentComments.d.ts +10 -0
  521. package/esm/typings/src/utils/markdown/removeContentComments.test.d.ts +1 -0
  522. package/esm/typings/src/utils/markdown/removeMarkdownFormatting.d.ts +9 -0
  523. package/esm/typings/src/utils/markdown/removeMarkdownFormatting.test.d.ts +1 -0
  524. package/esm/typings/src/utils/markdown/splitMarkdownIntoSections.d.ts +15 -0
  525. package/esm/typings/src/utils/markdown/splitMarkdownIntoSections.test.d.ts +1 -0
  526. package/esm/typings/src/utils/normalization/DIACRITIC_VARIANTS_LETTERS.d.ts +12 -0
  527. package/esm/typings/src/utils/normalization/IKeywords.d.ts +21 -0
  528. package/esm/typings/src/utils/normalization/capitalize.d.ts +6 -0
  529. package/esm/typings/src/utils/normalization/capitalize.test.d.ts +1 -0
  530. package/esm/typings/src/utils/normalization/decapitalize.d.ts +6 -0
  531. package/esm/typings/src/utils/normalization/decapitalize.test.d.ts +1 -0
  532. package/esm/typings/src/utils/normalization/isValidKeyword.d.ts +10 -0
  533. package/esm/typings/src/utils/normalization/isValidKeyword.test.d.ts +1 -0
  534. package/esm/typings/src/utils/normalization/nameToUriPart.d.ts +9 -0
  535. package/esm/typings/src/utils/normalization/nameToUriPart.test.d.ts +1 -0
  536. package/esm/typings/src/utils/normalization/nameToUriParts.d.ts +9 -0
  537. package/esm/typings/src/utils/normalization/nameToUriParts.test.d.ts +1 -0
  538. package/esm/typings/src/utils/normalization/normalize-to-kebab-case.d.ts +21 -0
  539. package/esm/typings/src/utils/normalization/normalize-to-kebab-case.test.d.ts +1 -0
  540. package/esm/typings/src/utils/normalization/normalizeTo_PascalCase.d.ts +17 -0
  541. package/esm/typings/src/utils/normalization/normalizeTo_PascalCase.test.d.ts +1 -0
  542. package/esm/typings/src/utils/normalization/normalizeTo_SCREAMING_CASE.d.ts +26 -0
  543. package/esm/typings/src/utils/normalization/normalizeTo_SCREAMING_CASE.test.d.ts +1 -0
  544. package/esm/typings/src/utils/normalization/normalizeTo_camelCase.d.ts +22 -0
  545. package/esm/typings/src/utils/normalization/normalizeTo_camelCase.test.d.ts +1 -0
  546. package/esm/typings/src/utils/normalization/normalizeTo_snake_case.d.ts +17 -0
  547. package/esm/typings/src/utils/normalization/normalizeTo_snake_case.test.d.ts +1 -0
  548. package/esm/typings/src/utils/normalization/normalizeWhitespaces.d.ts +6 -0
  549. package/esm/typings/src/utils/normalization/normalizeWhitespaces.test.d.ts +1 -0
  550. package/esm/typings/src/utils/normalization/orderJson.d.ts +21 -0
  551. package/esm/typings/src/utils/normalization/orderJson.test.d.ts +4 -0
  552. package/esm/typings/src/utils/normalization/parseKeywords.d.ts +16 -0
  553. package/esm/typings/src/utils/normalization/parseKeywords.test.d.ts +1 -0
  554. package/esm/typings/src/utils/normalization/parseKeywordsFromString.d.ts +9 -0
  555. package/esm/typings/src/utils/normalization/parseKeywordsFromString.test.d.ts +1 -0
  556. package/esm/typings/src/utils/normalization/removeDiacritics.d.ts +11 -0
  557. package/esm/typings/src/utils/normalization/removeDiacritics.test.d.ts +1 -0
  558. package/esm/typings/src/utils/normalization/searchKeywords.d.ts +10 -0
  559. package/esm/typings/src/utils/normalization/searchKeywords.test.d.ts +1 -0
  560. package/esm/typings/src/utils/normalization/titleToName.d.ts +9 -0
  561. package/esm/typings/src/utils/normalization/titleToName.test.d.ts +1 -0
  562. package/esm/typings/src/utils/organization/TODO_USE.d.ts +12 -0
  563. package/esm/typings/src/utils/organization/TODO_any.d.ts +6 -0
  564. package/esm/typings/src/utils/organization/TODO_object.d.ts +6 -0
  565. package/esm/typings/src/utils/organization/TODO_remove_as.d.ts +6 -0
  566. package/esm/typings/src/utils/organization/TODO_string.d.ts +6 -0
  567. package/esm/typings/src/utils/organization/TODO_unknown.d.ts +6 -0
  568. package/esm/typings/src/utils/organization/___and___.d.ts +7 -0
  569. package/esm/typings/src/utils/organization/___or___.d.ts +6 -0
  570. package/esm/typings/src/utils/organization/empty_object.d.ts +10 -0
  571. package/esm/typings/src/utils/organization/just.d.ts +14 -0
  572. package/esm/typings/src/utils/organization/just_empty_object.d.ts +12 -0
  573. package/esm/typings/src/utils/organization/keepTypeImported.d.ts +9 -0
  574. package/esm/typings/src/utils/organization/keepUnused.d.ts +16 -0
  575. package/esm/typings/src/utils/organization/really_any.d.ts +6 -0
  576. package/esm/typings/src/utils/organization/really_unknown.d.ts +6 -0
  577. package/esm/typings/src/utils/organization/spaceTrim.d.ts +11 -0
  578. package/esm/typings/src/utils/parameters/extractParameterNames.d.ts +10 -0
  579. package/esm/typings/src/utils/parameters/extractParameterNames.test.d.ts +1 -0
  580. package/esm/typings/src/utils/parameters/mapAvailableToExpectedParameters.d.ts +27 -0
  581. package/esm/typings/src/utils/parameters/mapAvailableToExpectedParameters.test.d.ts +1 -0
  582. package/esm/typings/src/utils/parameters/templateParameters.d.ts +12 -0
  583. package/esm/typings/src/utils/parameters/templateParameters.test.d.ts +1 -0
  584. package/esm/typings/src/utils/parseNumber.d.ts +16 -0
  585. package/esm/typings/src/utils/parseNumber.test.d.ts +1 -0
  586. package/esm/typings/src/utils/random/$randomSeed.d.ts +9 -0
  587. package/esm/typings/src/utils/removeEmojis.d.ts +8 -0
  588. package/esm/typings/src/utils/removeEmojis.test.d.ts +1 -0
  589. package/esm/typings/src/utils/removeQuotes.d.ts +14 -0
  590. package/esm/typings/src/utils/removeQuotes.test.d.ts +1 -0
  591. package/esm/typings/src/utils/serialization/$deepFreeze.d.ts +14 -0
  592. package/esm/typings/src/utils/serialization/asSerializable.d.ts +11 -0
  593. package/esm/typings/src/utils/serialization/asSerializable.test.d.ts +1 -0
  594. package/esm/typings/src/utils/serialization/checkSerializableAsJson.d.ts +45 -0
  595. package/esm/typings/src/utils/serialization/clonePipeline.d.ts +13 -0
  596. package/esm/typings/src/utils/serialization/deepClone.d.ts +10 -0
  597. package/esm/typings/src/utils/serialization/deepClone.test.d.ts +1 -0
  598. package/esm/typings/src/utils/serialization/exportJson.d.ts +29 -0
  599. package/esm/typings/src/utils/serialization/isSerializableAsJson.d.ts +25 -0
  600. package/esm/typings/src/utils/serialization/isSerializableAsJson.test.d.ts +1 -0
  601. package/esm/typings/src/utils/sets/difference.d.ts +10 -0
  602. package/esm/typings/src/utils/sets/difference.test.d.ts +1 -0
  603. package/esm/typings/src/utils/sets/intersection.d.ts +7 -0
  604. package/esm/typings/src/utils/sets/intersection.test.d.ts +1 -0
  605. package/esm/typings/src/utils/sets/union.d.ts +7 -0
  606. package/esm/typings/src/utils/sets/union.test.d.ts +1 -0
  607. package/esm/typings/src/utils/trimCodeBlock.d.ts +9 -0
  608. package/esm/typings/src/utils/trimCodeBlock.test.d.ts +1 -0
  609. package/esm/typings/src/utils/trimEndOfCodeBlock.d.ts +9 -0
  610. package/esm/typings/src/utils/trimEndOfCodeBlock.test.d.ts +1 -0
  611. package/esm/typings/src/utils/unwrapResult.d.ts +37 -0
  612. package/esm/typings/src/utils/unwrapResult.test.d.ts +1 -0
  613. package/esm/typings/src/utils/validators/email/isValidEmail.d.ts +8 -0
  614. package/esm/typings/src/utils/validators/email/isValidEmail.test.d.ts +1 -0
  615. package/esm/typings/src/utils/validators/filePath/isValidFilePath.d.ts +9 -0
  616. package/esm/typings/src/utils/validators/filePath/isValidFilePath.test.d.ts +1 -0
  617. package/esm/typings/src/utils/validators/javascriptName/isValidJavascriptName.d.ts +10 -0
  618. package/esm/typings/src/utils/validators/javascriptName/isValidJavascriptName.test.d.ts +1 -0
  619. package/esm/typings/src/utils/validators/parameterName/validateParameterName.d.ts +10 -0
  620. package/esm/typings/src/utils/validators/parameterName/validateParameterName.test.d.ts +1 -0
  621. package/esm/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.d.ts +15 -0
  622. package/esm/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.test.d.ts +1 -0
  623. package/esm/typings/src/utils/validators/semanticVersion/isValidSemanticVersion.d.ts +12 -0
  624. package/esm/typings/src/utils/validators/semanticVersion/isValidSemanticVersion.test.d.ts +1 -0
  625. package/esm/typings/src/utils/validators/url/isHostnameOnPrivateNetwork.d.ts +11 -0
  626. package/esm/typings/src/utils/validators/url/isHostnameOnPrivateNetwork.test.d.ts +1 -0
  627. package/esm/typings/src/utils/validators/url/isUrlOnPrivateNetwork.d.ts +13 -0
  628. package/esm/typings/src/utils/validators/url/isUrlOnPrivateNetwork.test.d.ts +1 -0
  629. package/esm/typings/src/utils/validators/url/isValidPipelineUrl.d.ts +15 -0
  630. package/esm/typings/src/utils/validators/url/isValidPipelineUrl.test.d.ts +1 -0
  631. package/esm/typings/src/utils/validators/url/isValidUrl.d.ts +13 -0
  632. package/esm/typings/src/utils/validators/url/isValidUrl.test.d.ts +1 -0
  633. package/esm/typings/src/utils/validators/uuid/isValidUuid.d.ts +8 -0
  634. package/esm/typings/src/utils/validators/uuid/isValidUuid.test.d.ts +1 -0
  635. package/esm/typings/src/version.d.ts +18 -0
  636. package/package.json +63 -0
  637. package/umd/index.umd.js +645 -0
  638. package/umd/index.umd.js.map +1 -0
@@ -0,0 +1,73 @@
1
+ import type { Promisable } from 'type-fest';
2
+ import type { PipelineCollection } from '../../../collection/PipelineCollection';
3
+ import type { CommonToolsOptions } from '../../../execution/CommonToolsOptions';
4
+ import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
5
+ import type { string_app_id } from '../../../types/typeAliases';
6
+ import type { string_uri } from '../../../types/typeAliases';
7
+ import type { string_user_id } from '../../../types/typeAliases';
8
+ /**
9
+ * @@@
10
+ *
11
+ * There are two modes of remote server:
12
+ *
13
+ * 1) **Application mode** Server will recieve `collection` and execute prompts only from this collection
14
+ * 2) **Anonymous mode** Server will recieve full `LlmToolsConfiguration` (with api keys) and just acts as a proxy
15
+ * In anonymous mode, `collection` will be ignored and any prompt will be executed
16
+ *
17
+ * You can enable both modes at the same time.
18
+ *
19
+ * @public exported from `@promptbook/remote-client`
20
+ * @public exported from `@promptbook/remote-server`
21
+ */
22
+ export type RemoteServerOptions<TCustomOptions> = CommonToolsOptions & {
23
+ /**
24
+ * Port on which the server will listen
25
+ */
26
+ readonly port: number;
27
+ /**
28
+ * Path for the Socket.io server to listen
29
+ *
30
+ * @default '/socket.io'
31
+ * @example '/promptbook/socket.io'
32
+ */
33
+ readonly path: string_uri;
34
+ } & (AnonymousRemoteServerOptions | CollectionRemoteServerOptions<TCustomOptions> | (AnonymousRemoteServerOptions & CollectionRemoteServerOptions<TCustomOptions>));
35
+ export type AnonymousRemoteServerOptions = {
36
+ /**
37
+ * Enable anonymous mode
38
+ */
39
+ readonly isAnonymousModeAllowed: true;
40
+ };
41
+ export type CollectionRemoteServerOptions<TCustomOptions> = {
42
+ /**
43
+ * Enable application mode
44
+ */
45
+ readonly isApplicationModeAllowed: true;
46
+ /**
47
+ * Promptbook collection to use
48
+ *
49
+ * This is used to check validity of the prompt to prevent misuse
50
+ */
51
+ readonly collection: PipelineCollection;
52
+ /**
53
+ * Creates llm execution tools for each client
54
+ */
55
+ createLlmExecutionTools(options: CollectionRemoteServerClientOptions<TCustomOptions>): Promisable<LlmExecutionTools>;
56
+ };
57
+ export type CollectionRemoteServerClientOptions<TCustomOptions> = {
58
+ /**
59
+ * @@@
60
+ */
61
+ readonly appId: string_app_id | null;
62
+ /**
63
+ * @@@
64
+ */
65
+ readonly userId?: string_user_id;
66
+ /**
67
+ * @@@
68
+ */
69
+ readonly customOptions?: TCustomOptions;
70
+ };
71
+ /**
72
+ * TODO: Constrain anonymous mode for specific models / providers
73
+ */
@@ -0,0 +1,5 @@
1
+ #!/usr/bin/env ts-node
2
+ import '../../openai/register-constructor';
3
+ /**
4
+ * Note: [⚫] Code in this file should never be published in any package
5
+ */
@@ -0,0 +1,23 @@
1
+ import type { IDestroyable } from 'destroyable';
2
+ import type { RemoteServerOptions } from './interfaces/RemoteServerOptions';
3
+ /**
4
+ * Remote server is a proxy server that uses its execution tools internally and exposes the executor interface externally.
5
+ *
6
+ * You can simply use `RemoteExecutionTools` on client-side javascript and connect to your remote server.
7
+ * This is useful to make all logic on browser side but not expose your API keys or no need to use customer's GPU.
8
+ *
9
+ * @see https://github.com/webgptorg/promptbook#remote-server
10
+ * @public exported from `@promptbook/remote-server`
11
+ */
12
+ export declare function startRemoteServer<TCustomOptions = undefined>(options: RemoteServerOptions<TCustomOptions>): IDestroyable;
13
+ /**
14
+ * TODO: Maybe use `$exportJson`
15
+ * TODO: [🧠][πŸ›] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
16
+ * TODO: [βš–] Expose the collection to be able to connect to same collection via createCollectionFromUrl
17
+ * TODO: Handle progress - support streaming
18
+ * TODO: [πŸ—―] Do not hang up immediately but wait until client closes OR timeout
19
+ * TODO: [πŸ—―] Timeout on chat to free up resources
20
+ * TODO: [πŸƒ] Pass here some security token to prevent malitious usage and/or DDoS
21
+ * TODO: [0] Set unavailable models as undefined in `RemoteLlmExecutionTools` NOT throw error here
22
+ * TODO: Constrain anonymous mode for specific models / providers
23
+ */
@@ -0,0 +1,23 @@
1
+ import type { AvailableModel } from '../../execution/AvailableModel';
2
+ import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
3
+ import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
4
+ import type { VercelProvider } from './VercelProvider';
5
+ /**
6
+ * Options for `createExecutionToolsFromVercelProvider`
7
+ *
8
+ * @public exported from `@promptbook/google`
9
+ */
10
+ export type VercelExecutionToolsOptions = CommonToolsOptions & Pick<LlmExecutionTools, 'title' | 'description'> & {
11
+ /**
12
+ * Vercel provider for the execution tools
13
+ */
14
+ readonly vercelProvider: VercelProvider;
15
+ /**
16
+ * List of available models for given Vercel provider
17
+ */
18
+ readonly availableModels: ReadonlyArray<AvailableModel>;
19
+ /**
20
+ * Additional settings for chat models when calling `vercelProvider.chat('model-name', settings)`
21
+ */
22
+ readonly additionalChatSettings?: Partial<Parameters<VercelProvider['chat']>[1]>;
23
+ };
@@ -0,0 +1,13 @@
1
+ import type { createGoogleGenerativeAI } from '@ai-sdk/google';
2
+ import type { createOpenAI } from '@ai-sdk/openai';
3
+ /**
4
+ * This is common interface for all v1 Vercel providers
5
+ *
6
+ * @public exported from `@promptbook/vercel`
7
+ */
8
+ export type VercelProvider = ReturnType<typeof createOpenAI> | ReturnType<typeof createGoogleGenerativeAI>;
9
+ /**
10
+ * ^^^^
11
+ * TODO: Is there some way to get the type of the provider directly,
12
+ * NOT this stupid way via inferring the return type from a specific vercel provider⁉
13
+ */
@@ -0,0 +1,8 @@
1
+ import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
2
+ import type { VercelExecutionToolsOptions } from './VercelExecutionToolsOptions';
3
+ /**
4
+ * Adapter which creates Promptbook execution tools from Vercel provider
5
+ *
6
+ * @public exported from `@promptbook/vercel`
7
+ */
8
+ export declare function createExecutionToolsFromVercelProvider(options: VercelExecutionToolsOptions): LlmExecutionTools;
@@ -0,0 +1,6 @@
1
+ #!/usr/bin/env ts-node
2
+ export {};
3
+ /**
4
+ * TODO: [main] !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
5
+ * Note: [⚫] Code in this file should never be published in any package
6
+ */
@@ -0,0 +1,17 @@
1
+ import type { ExecutionTools } from '../execution/ExecutionTools';
2
+ import type { PersonaPreparedJson } from '../pipeline/PipelineJson/PersonaJson';
3
+ import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
4
+ import type { string_persona_description } from '../types/typeAliases';
5
+ /**
6
+ * Prepares the persona for the pipeline
7
+ *
8
+ * @see https://github.com/webgptorg/promptbook/discussions/22
9
+ * @public exported from `@promptbook/core`
10
+ */
11
+ export declare function preparePersona(personaDescription: string_persona_description, tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions): Promise<PersonaPreparedJson['modelRequirements']>;
12
+ /**
13
+ * TODO: [πŸ”ƒ][main] !! If the persona was prepared with different version or different set of models, prepare it once again
14
+ * TODO: [🏒] !! Check validity of `modelName` in pipeline
15
+ * TODO: [🏒] !! Check validity of `systemMessage` in pipeline
16
+ * TODO: [🏒] !! Check validity of `temperature` in pipeline
17
+ */
@@ -0,0 +1,22 @@
1
+ import type { InputParameterJson } from '../PipelineJson/ParameterJson';
2
+ import type { OutputParameterJson } from '../PipelineJson/ParameterJson';
3
+ /**
4
+ * @@@
5
+ *
6
+ * Note: [πŸš‰] This is fully serializable as JSON
7
+ * @see https://github.com/webgptorg/promptbook/discussions/171
8
+ */
9
+ export type PipelineInterface = {
10
+ /**
11
+ * @@@
12
+ *
13
+ * Note: Sorted alphabetically
14
+ */
15
+ readonly inputParameters: ReadonlyArray<InputParameterJson>;
16
+ /**
17
+ * @@@
18
+ *
19
+ * Note: Sorted alphabetically
20
+ */
21
+ readonly outputParameters: ReadonlyArray<OutputParameterJson>;
22
+ };
@@ -0,0 +1,14 @@
1
+ /**
2
+ * @@@
3
+ *
4
+ * @see https://github.com/webgptorg/promptbook/discussions/171
5
+ *
6
+ * @public exported from `@promptbook/core`
7
+ */
8
+ export declare const GENERIC_PIPELINE_INTERFACE: {
9
+ readonly inputParameters: readonly [];
10
+ readonly outputParameters: readonly [];
11
+ };
12
+ /**
13
+ * Note: [πŸ’ž] Ignore a discrepancy between file name and entity name
14
+ */
@@ -0,0 +1,11 @@
1
+ import type { PipelineJson } from '../PipelineJson/PipelineJson';
2
+ import type { PipelineInterface } from './PipelineInterface';
3
+ /**
4
+ * @@@
5
+ *
6
+ * @deprecated https://github.com/webgptorg/promptbook/pull/186
7
+ * @see https://github.com/webgptorg/promptbook/discussions/171
8
+ *
9
+ * @public exported from `@promptbook/core`
10
+ */
11
+ export declare function getPipelineInterface(pipeline: PipelineJson): PipelineInterface;
@@ -0,0 +1,26 @@
1
+ import type { PipelineJson } from '../PipelineJson/PipelineJson';
2
+ import type { PipelineInterface } from './PipelineInterface';
3
+ /**
4
+ * @@@
5
+ *
6
+ * @see https://github.com/webgptorg/promptbook/discussions/171
7
+ */
8
+ export type IsPipelineImplementingInterfaceOptions = {
9
+ /**
10
+ * @@@
11
+ */
12
+ pipeline: PipelineJson;
13
+ /**
14
+ * @@@
15
+ */
16
+ pipelineInterface: PipelineInterface;
17
+ };
18
+ /**
19
+ * @@@
20
+ *
21
+ * @deprecated https://github.com/webgptorg/promptbook/pull/186
22
+ * @see https://github.com/webgptorg/promptbook/discussions/171
23
+ *
24
+ * @public exported from `@promptbook/core`
25
+ */
26
+ export declare function isPipelineImplementingInterface(options: IsPipelineImplementingInterfaceOptions): boolean;
@@ -0,0 +1,10 @@
1
+ import type { PipelineInterface } from './PipelineInterface';
2
+ /**
3
+ * @@@
4
+ *
5
+ * @deprecated https://github.com/webgptorg/promptbook/pull/186
6
+ * @see https://github.com/webgptorg/promptbook/discussions/171
7
+ *
8
+ * @public exported from `@promptbook/core`
9
+ */
10
+ export declare function isPipelineInterfacesEqual(pipelineInterface1: PipelineInterface, pipelineInterface2: PipelineInterface): boolean;
@@ -0,0 +1,100 @@
1
+ import type { ForeachJson } from '../../commands/FOREACH/ForeachJson';
2
+ import type { FormatCommand } from '../../commands/FORMAT/FormatCommand';
3
+ import type { SectionType } from '../../types/SectionType';
4
+ import type { string_javascript } from '../../types/typeAliases';
5
+ import type { string_markdown } from '../../types/typeAliases';
6
+ import type { string_markdown_text } from '../../types/typeAliases';
7
+ import type { string_name } from '../../types/typeAliases';
8
+ import type { string_parameter_name } from '../../types/typeAliases';
9
+ import type { string_postprocessing_function_name } from '../../types/typeAliases';
10
+ import type { string_prompt } from '../../types/typeAliases';
11
+ import type { string_template } from '../../types/typeAliases';
12
+ import type { Expectations } from './Expectations';
13
+ /**
14
+ * Common properties of all tasks
15
+ */
16
+ export type CommonTaskJson = {
17
+ /**
18
+ * Name of the task
19
+ * - It must be unique across the pipeline
20
+ * - It should start uppercase and can contain letters and numbers
21
+ * - The pipelineUrl together with hash and name are used to identify the task in the pipeline
22
+ */
23
+ readonly name: string_name;
24
+ /**
25
+ * Title of the task
26
+ * It can use simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
27
+ */
28
+ readonly title: string;
29
+ /**
30
+ * Description of the task
31
+ * It can use multiple paragraphs of simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
32
+ */
33
+ readonly description?: string_markdown_text;
34
+ /**
35
+ * List of parameter names that are used in the task and must be defined before the task is executed
36
+ *
37
+ * Note: Joker is one of the dependent parameters
38
+ */
39
+ readonly dependentParameterNames: Array<string_parameter_name>;
40
+ /**
41
+ * If theese parameters meet the expectations requirements, they are used instead of executing this task
42
+ *
43
+ * @see https://github.com/webgptorg/promptbook/discussions/66
44
+ */
45
+ readonly jokerParameterNames?: Array<string_parameter_name>;
46
+ /**
47
+ * @@@
48
+ */
49
+ readonly foreach?: ForeachJson;
50
+ /**
51
+ * Type of the execution
52
+ * This determines if the task is send to LLM, user or some scripting evaluation
53
+ */
54
+ readonly taskType: SectionType;
55
+ /**
56
+ * Content of the task with {placeholders} for parameters
57
+ *
58
+ * @@@ content vs preparedContent
59
+ */
60
+ readonly content: (string_prompt | string_javascript | string_markdown) & string_template;
61
+ /**
62
+ * @@@ Content of the task with {placeholders} for parameters
63
+ *
64
+ * @@@ content vs preparedContent
65
+ *
66
+ * @default "{content}"
67
+ */
68
+ readonly preparedContent?: (string_prompt | string_javascript | string_markdown) & string_template;
69
+ /**
70
+ * List of postprocessing steps that are executed after the task
71
+ *
72
+ * @see https://github.com/webgptorg/promptbook/discussions/31
73
+ */
74
+ readonly postprocessingFunctionNames?: Array<string_postprocessing_function_name>;
75
+ /**
76
+ * Expect this amount of each unit in the answer
77
+ *
78
+ * For example 5 words, 3 sentences, 2 paragraphs, ...
79
+ *
80
+ * Note: Expectations are performed after all postprocessing steps
81
+ * @see https://github.com/webgptorg/promptbook/discussions/30
82
+ */
83
+ readonly expectations?: Expectations;
84
+ /**
85
+ * Expect this format of the answer
86
+ *
87
+ * Note: Expectations are performed after all postprocessing steps
88
+ * @see https://github.com/webgptorg/promptbook/discussions/30
89
+ * @deprecated [πŸ’]
90
+ */
91
+ readonly format?: FormatCommand['format'];
92
+ /**
93
+ * Name of the parameter that is the result of the task
94
+ */
95
+ readonly resultingParameterName: string_name;
96
+ };
97
+ /**
98
+ * TODO: use one helper type> (string_prompt | string_javascript | string_markdown) & string_template
99
+ * TODO: [β™ˆ] Probbably move expectations from tasks to parameters
100
+ */
@@ -0,0 +1,13 @@
1
+ import type { CommonTaskJson } from './CommonTaskJson';
2
+ /**
3
+ * Task for prompt to user
4
+ *
5
+ * Note: [πŸš‰] This is fully serializable as JSON
6
+ * @see https://github.com/webgptorg/promptbook/discussions/76
7
+ */
8
+ export type DialogTaskJson = CommonTaskJson & {
9
+ readonly taskType: 'DIALOG_TASK';
10
+ };
11
+ /**
12
+ * TODO: [πŸ™] Make some standard order of json properties
13
+ */
@@ -0,0 +1,40 @@
1
+ import type { TupleToUnion } from 'type-fest';
2
+ import type { number_integer } from '../../types/typeAliases';
3
+ import type { number_positive } from '../../types/typeAliases';
4
+ /**
5
+ * Expect this amount of each unit in the answer
6
+ *
7
+ * For example 5 words, 3 sentences, 2 paragraphs, ...
8
+ *
9
+ * Note: Expectations are performed after all postprocessing steps
10
+ * Note: [πŸš‰] This is fully serializable as JSON
11
+ * @see https://github.com/webgptorg/promptbook/discussions/30
12
+ */
13
+ export type Expectations = Partial<Record<Lowercase<ExpectationUnit>, {
14
+ readonly min?: ExpectationAmount;
15
+ readonly max?: ExpectationAmount;
16
+ }>>;
17
+ /**
18
+ * Unit of text measurement
19
+ *
20
+ * Note: [πŸš‰] This is fully serializable as JSON
21
+ * @see https://github.com/webgptorg/promptbook/discussions/30
22
+ */
23
+ export type ExpectationUnit = TupleToUnion<typeof EXPECTATION_UNITS>;
24
+ /**
25
+ * Units of text measurement
26
+ *
27
+ * @see https://github.com/webgptorg/promptbook/discussions/30
28
+ * @public exported from `@promptbook/core`
29
+ */
30
+ export declare const EXPECTATION_UNITS: readonly ["CHARACTERS", "WORDS", "SENTENCES", "LINES", "PARAGRAPHS", "PAGES"];
31
+ /**
32
+ * Amount of text measurement
33
+ *
34
+ * Note: [πŸš‰] This is fully serializable as JSON
35
+ * @see https://github.com/webgptorg/promptbook/discussions/30
36
+ */
37
+ export type ExpectationAmount = number_integer & (number_positive | 0);
38
+ /**
39
+ * TODO: [πŸ’] Unite object for expecting amount and format - remove format
40
+ */
@@ -0,0 +1,73 @@
1
+ import type { EmbeddingVector } from '../../execution/EmbeddingVector';
2
+ import type { number_id } from '../../types/typeAliases';
3
+ import type { number_linecol_number } from '../../types/typeAliases';
4
+ import type { string_markdown } from '../../types/typeAliases';
5
+ import type { string_markdown_text } from '../../types/typeAliases';
6
+ import type { string_model_name } from '../../types/typeAliases';
7
+ import type { string_name } from '../../types/typeAliases';
8
+ import type { string_keyword } from '../../utils/normalization/IKeywords';
9
+ /**
10
+ * Defines one piece of knowledge in the pipeline
11
+ *
12
+ * Note: Knowledge piece is by definition prepared
13
+ *
14
+ * Note: [πŸš‰] This is fully serializable as JSON
15
+ *
16
+ * @see https://github.com/webgptorg/promptbook/discussions/41
17
+ */
18
+ export type KnowledgePiecePreparedJson = {
19
+ /**
20
+ * Unique name of the knowledge piece based on the title
21
+ */
22
+ readonly name?: string_name;
23
+ /**
24
+ * Short title for the information
25
+ */
26
+ readonly title?: string_markdown_text;
27
+ /**
28
+ * The information in markdown format
29
+ */
30
+ readonly content?: string_markdown;
31
+ /**
32
+ * List of sources where the information comes from
33
+ */
34
+ readonly sources: ReadonlyArray<{
35
+ /**
36
+ * Identifier of the source
37
+ */
38
+ readonly name: string_name;
39
+ /**
40
+ * Line number
41
+ */
42
+ readonly line?: number_linecol_number;
43
+ /**
44
+ * Column number
45
+ */
46
+ readonly column?: number_linecol_number;
47
+ }>;
48
+ /**
49
+ * List of keywords that are associated with the knowledge piece
50
+ */
51
+ readonly keywords: ReadonlyArray<string_keyword>;
52
+ /**
53
+ * List of models embeddings that are associated with the knowledge piece
54
+ */
55
+ readonly index: ReadonlyArray<{
56
+ /**
57
+ * Model name which generated the embedding
58
+ */
59
+ readonly modelName: string_model_name;
60
+ /**
61
+ * Embedding vector of the knowledge piece
62
+ */
63
+ readonly position: EmbeddingVector;
64
+ }>;
65
+ /**
66
+ * List of preparation ids that were used to prepare this knowledge piece
67
+ */
68
+ readonly preparationIds: ReadonlyArray<number_id>;
69
+ };
70
+ /**
71
+ * TODO: [πŸ™] Make some standard order of json properties
72
+ * Note: [πŸ’ž] Ignore a discrepancy between file name and entity name
73
+ */
@@ -0,0 +1,44 @@
1
+ import type { number_id } from '../../types/typeAliases';
2
+ import type { string_knowledge_source_content } from '../../types/typeAliases';
3
+ import type { string_name } from '../../types/typeAliases';
4
+ /**
5
+ * Defines one source of knowledge in the pipeline
6
+ * For example, a source of information, a fact, a quote, a definition, website, etc.
7
+ *
8
+ * Note: [πŸš‰] This is fully serializable as JSON
9
+ *
10
+ * @see https://github.com/webgptorg/promptbook/discussions/41
11
+ */
12
+ export type KnowledgeSourceJson = {
13
+ /**
14
+ * Unique identifier of the knowledge source
15
+ */
16
+ readonly name: string_name;
17
+ /**
18
+ * Source of one knowledge
19
+ *
20
+ * It can be a link, a relative path to file or direct text or combination of those
21
+ *
22
+ * For example `"https://pavolhejny.com/"`
23
+ * For example `"./pavol-hejny-cv.pdf"`
24
+ * For example `"Pavol HejnΓ½ has web https://pavolhejny.com/"`
25
+ * For example `"Pavol HejnΓ½ is web developer and creator of Promptbook and Collboard"`
26
+ */
27
+ readonly sourceContent: string_knowledge_source_content;
28
+ };
29
+ /**
30
+ * Defines one source of knowledge in the pipeline after it has been prepared
31
+ *
32
+ * Note: [πŸš‰] This is fully serializable as JSON
33
+ *
34
+ * @see https://github.com/webgptorg/promptbook/discussions/41
35
+ */
36
+ export type KnowledgeSourcePreparedJson = KnowledgeSourceJson & {
37
+ /**
38
+ * List of preparation ids that were used to prepare this knowledge source to knowledge pieces
39
+ */
40
+ readonly preparationIds: ReadonlyArray<number_id>;
41
+ };
42
+ /**
43
+ * TODO: [πŸ™] Make some standard order of json properties
44
+ */
@@ -0,0 +1,98 @@
1
+ import type { string_markdown_text } from '../../types/typeAliases';
2
+ import type { string_parameter_name } from '../../types/typeAliases';
3
+ import type { string_parameter_value } from '../../types/typeAliases';
4
+ /**
5
+ * Describes one parameter of the pipeline
6
+ *
7
+ * Note: [πŸš‰] This is fully serializable as JSON
8
+ */
9
+ export type ParameterJson = InputParameterJson | IntermediateParameterJson | OutputParameterJson;
10
+ /**
11
+ * Describes input parameter of the pipeline
12
+ *
13
+ * πŸ”΄ -> βšͺ -> βšͺ
14
+ *
15
+ * Note: [πŸš‰] This is fully serializable as JSON
16
+ */
17
+ export type InputParameterJson = CommonParameterJson & {
18
+ /**
19
+ * The parameter is input of the pipeline
20
+ */
21
+ readonly isInput: true;
22
+ /**
23
+ * The parameter is NOT output of the pipeline
24
+ */
25
+ readonly isOutput: false;
26
+ };
27
+ /**
28
+ * Describes intermediate parameter of the pipeline
29
+ *
30
+ * βšͺ -> πŸ”΄ -> βšͺ
31
+ *
32
+ * Note: [πŸš‰] This is fully serializable as JSON
33
+ */
34
+ export type IntermediateParameterJson = CommonParameterJson & {
35
+ /**
36
+ * The parameter is NOT input of the pipeline
37
+ */
38
+ readonly isInput: false;
39
+ /**
40
+ * The parameter is NOT output of the pipeline
41
+ */
42
+ readonly isOutput: false;
43
+ };
44
+ /**
45
+ * Describes output parameter of the pipeline
46
+ *
47
+ * βšͺ -> βšͺ -> πŸ”΄
48
+ *
49
+ * Note: [πŸš‰] This is fully serializable as JSON
50
+ */
51
+ export type OutputParameterJson = CommonParameterJson & {
52
+ /**
53
+ * The parameter is NOT input of the pipeline
54
+ */
55
+ readonly isInput: false;
56
+ /**
57
+ * The parameter is output of the pipeline
58
+ */
59
+ readonly isOutput: true;
60
+ };
61
+ /**
62
+ * Describes commons of one parameter of the pipeline
63
+ *
64
+ * Note: [πŸš‰] This is fully serializable as JSON
65
+ */
66
+ export type CommonParameterJson = {
67
+ /**
68
+ * Name of the parameter
69
+ * - It must be unique across the pipeline
70
+ * - It should start lowercase and contain letters and numbers
71
+ */
72
+ readonly name: string_parameter_name;
73
+ /**
74
+ * The parameter is input of the pipeline
75
+ */
76
+ readonly isInput: boolean;
77
+ /**
78
+ * The parameter is output of the pipeline
79
+ */
80
+ readonly isOutput: boolean;
81
+ /**
82
+ * Description of the parameter
83
+ * - It can use simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
84
+ */
85
+ readonly description?: string_markdown_text;
86
+ /**
87
+ * Example values of the parameter
88
+ * Note: This values won't be actually used as some default values, but they are just for better understanding of the parameter
89
+ */
90
+ readonly exampleValues?: Array<string_parameter_value>;
91
+ };
92
+ /**
93
+ * TODO: [🧠][πŸ›΄][β™ˆ] Maybe add type + expectations into the intefrace, like "a person name"
94
+ * [πŸ›΄] @see https://github.com/webgptorg/promptbook/discussions/53
95
+ * TODO: [🧠] Should be here registered subparameters from foreach or not?
96
+ * TODO: [β™ˆ] Probbably move expectations from tasks to parameters
97
+ * TODO: [πŸ™] Make some standard order of json properties
98
+ */