@promptbook/vercel 0.76.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (605) hide show
  1. package/README.md +413 -0
  2. package/esm/index.es.js +20 -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 +40 -0
  9. package/esm/typings/src/_packages/core.index.d.ts +228 -0
  10. package/esm/typings/src/_packages/documents.index.d.ts +8 -0
  11. package/esm/typings/src/_packages/execute-javascript.index.d.ts +8 -0
  12. package/esm/typings/src/_packages/fake-llm.index.d.ts +6 -0
  13. package/esm/typings/src/_packages/gemini.index.d.ts +2 -0
  14. package/esm/typings/src/_packages/legacy-documents.index.d.ts +8 -0
  15. package/esm/typings/src/_packages/markdown-utils.index.d.ts +48 -0
  16. package/esm/typings/src/_packages/node.index.d.ts +22 -0
  17. package/esm/typings/src/_packages/openai.index.d.ts +20 -0
  18. package/esm/typings/src/_packages/pdf.index.d.ts +8 -0
  19. package/esm/typings/src/_packages/remote-client.index.d.ts +8 -0
  20. package/esm/typings/src/_packages/remote-server.index.d.ts +6 -0
  21. package/esm/typings/src/_packages/types.index.d.ts +508 -0
  22. package/esm/typings/src/_packages/utils.index.d.ts +148 -0
  23. package/esm/typings/src/_packages/vercel.index.d.ts +2 -0
  24. package/esm/typings/src/_packages/website-crawler.index.d.ts +8 -0
  25. package/esm/typings/src/cli/cli-commands/about.d.ts +12 -0
  26. package/esm/typings/src/cli/cli-commands/hello.d.ts +12 -0
  27. package/esm/typings/src/cli/cli-commands/make.d.ts +14 -0
  28. package/esm/typings/src/cli/cli-commands/prettify.d.ts +13 -0
  29. package/esm/typings/src/cli/cli-commands/run.d.ts +15 -0
  30. package/esm/typings/src/cli/cli-commands/test-command.d.ts +14 -0
  31. package/esm/typings/src/cli/main.d.ts +16 -0
  32. package/esm/typings/src/cli/promptbookCli.d.ts +13 -0
  33. package/esm/typings/src/cli/test/ptbk.d.ts +5 -0
  34. package/esm/typings/src/cli/test/ptbk.test.d.ts +1 -0
  35. package/esm/typings/src/collection/PipelineCollection.d.ts +25 -0
  36. package/esm/typings/src/collection/SimplePipelineCollection.d.ts +37 -0
  37. package/esm/typings/src/collection/collectionToJson.d.ts +13 -0
  38. package/esm/typings/src/collection/collectionToJson.test.d.ts +7 -0
  39. package/esm/typings/src/collection/constructors/createCollectionFromDirectory.d.ts +54 -0
  40. package/esm/typings/src/collection/constructors/createCollectionFromDirectory.test.d.ts +1 -0
  41. package/esm/typings/src/collection/constructors/createCollectionFromJson.d.ts +13 -0
  42. package/esm/typings/src/collection/constructors/createCollectionFromJson.test.d.ts +1 -0
  43. package/esm/typings/src/collection/constructors/createCollectionFromPromise.d.ts +23 -0
  44. package/esm/typings/src/collection/constructors/createCollectionFromPromise.test.d.ts +1 -0
  45. package/esm/typings/src/collection/constructors/createCollectionFromUrl.d.ts +29 -0
  46. package/esm/typings/src/collection/constructors/createSubcollection.d.ts +13 -0
  47. package/esm/typings/src/commands/BOOK_VERSION/BookVersionCommand.d.ts +11 -0
  48. package/esm/typings/src/commands/BOOK_VERSION/bookVersionCommand.test.d.ts +1 -0
  49. package/esm/typings/src/commands/BOOK_VERSION/bookVersionCommandParser.d.ts +9 -0
  50. package/esm/typings/src/commands/EXPECT/ExpectCommand.d.ts +17 -0
  51. package/esm/typings/src/commands/EXPECT/expectCommand.test.d.ts +1 -0
  52. package/esm/typings/src/commands/EXPECT/expectCommandParser.d.ts +9 -0
  53. package/esm/typings/src/commands/FOREACH/ForeachCommand.d.ts +10 -0
  54. package/esm/typings/src/commands/FOREACH/ForeachJson.d.ts +27 -0
  55. package/esm/typings/src/commands/FOREACH/foreachCommand.test.d.ts +1 -0
  56. package/esm/typings/src/commands/FOREACH/foreachCommandParser.d.ts +14 -0
  57. package/esm/typings/src/commands/FORMAT/FormatCommand.d.ts +9 -0
  58. package/esm/typings/src/commands/FORMAT/formatCommand.test.d.ts +1 -0
  59. package/esm/typings/src/commands/FORMAT/formatCommandParser.d.ts +9 -0
  60. package/esm/typings/src/commands/FORMFACTOR/FormfactorCommand.d.ts +11 -0
  61. package/esm/typings/src/commands/FORMFACTOR/formfactorCommand.test.d.ts +1 -0
  62. package/esm/typings/src/commands/FORMFACTOR/formfactorCommandParser.d.ts +11 -0
  63. package/esm/typings/src/commands/JOKER/JokerCommand.d.ts +11 -0
  64. package/esm/typings/src/commands/JOKER/jokerCommand.test.d.ts +1 -0
  65. package/esm/typings/src/commands/JOKER/jokerCommandParser.d.ts +9 -0
  66. package/esm/typings/src/commands/KNOWLEDGE/KnowledgeCommand.d.ts +11 -0
  67. package/esm/typings/src/commands/KNOWLEDGE/knowledgeCommand.test.d.ts +1 -0
  68. package/esm/typings/src/commands/KNOWLEDGE/knowledgeCommandParser.d.ts +12 -0
  69. package/esm/typings/src/commands/KNOWLEDGE/utils/sourceContentToName.d.ts +11 -0
  70. package/esm/typings/src/commands/KNOWLEDGE/utils/sourceContentToName.test.d.ts +4 -0
  71. package/esm/typings/src/commands/MODEL/ModelCommand.d.ts +13 -0
  72. package/esm/typings/src/commands/MODEL/modelCommand.test.d.ts +1 -0
  73. package/esm/typings/src/commands/MODEL/modelCommandParser.d.ts +9 -0
  74. package/esm/typings/src/commands/PARAMETER/ParameterCommand.d.ts +15 -0
  75. package/esm/typings/src/commands/PARAMETER/parameterCommand.test.d.ts +1 -0
  76. package/esm/typings/src/commands/PARAMETER/parameterCommandParser.d.ts +9 -0
  77. package/esm/typings/src/commands/PERSONA/PersonaCommand.d.ts +13 -0
  78. package/esm/typings/src/commands/PERSONA/personaCommand.test.d.ts +1 -0
  79. package/esm/typings/src/commands/PERSONA/personaCommandParser.d.ts +9 -0
  80. package/esm/typings/src/commands/POSTPROCESS/PostprocessCommand.d.ts +11 -0
  81. package/esm/typings/src/commands/POSTPROCESS/postprocessCommand.test.d.ts +1 -0
  82. package/esm/typings/src/commands/POSTPROCESS/postprocessCommandParser.d.ts +9 -0
  83. package/esm/typings/src/commands/SECTION/SectionCommand.d.ts +11 -0
  84. package/esm/typings/src/commands/SECTION/sectionCommand.test.d.ts +1 -0
  85. package/esm/typings/src/commands/SECTION/sectionCommandParser.d.ts +20 -0
  86. package/esm/typings/src/commands/URL/UrlCommand.d.ts +10 -0
  87. package/esm/typings/src/commands/URL/urlCommand.test.d.ts +1 -0
  88. package/esm/typings/src/commands/URL/urlCommandParser.d.ts +9 -0
  89. package/esm/typings/src/commands/X_ACTION/ActionCommand.d.ts +9 -0
  90. package/esm/typings/src/commands/X_ACTION/actionCommand.test.d.ts +1 -0
  91. package/esm/typings/src/commands/X_ACTION/actionCommandParser.d.ts +12 -0
  92. package/esm/typings/src/commands/X_INSTRUMENT/InstrumentCommand.d.ts +9 -0
  93. package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommand.test.d.ts +1 -0
  94. package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommandParser.d.ts +12 -0
  95. package/esm/typings/src/commands/_BOILERPLATE/BoilerplateCommand.d.ts +10 -0
  96. package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommand.test.d.ts +1 -0
  97. package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts +11 -0
  98. package/esm/typings/src/commands/_common/getParserForCommand.d.ts +11 -0
  99. package/esm/typings/src/commands/_common/getParserForCommand.test.d.ts +1 -0
  100. package/esm/typings/src/commands/_common/parseCommand.d.ts +12 -0
  101. package/esm/typings/src/commands/_common/parseCommand.test.d.ts +1 -0
  102. package/esm/typings/src/commands/_common/stringifyCommand.d.ts +11 -0
  103. package/esm/typings/src/commands/_common/stringifyCommand.test.d.ts +1 -0
  104. package/esm/typings/src/commands/_common/types/Command.d.ts +6 -0
  105. package/esm/typings/src/commands/_common/types/CommandParser.d.ts +186 -0
  106. package/esm/typings/src/commands/_common/types/CommandUsagePlaces.d.ts +11 -0
  107. package/esm/typings/src/commands/index.d.ts +9 -0
  108. package/esm/typings/src/config.d.ts +238 -0
  109. package/esm/typings/src/config.test.d.ts +4 -0
  110. package/esm/typings/src/conversion/pipelineJsonToString.d.ts +17 -0
  111. package/esm/typings/src/conversion/pipelineStringToJson.d.ts +28 -0
  112. package/esm/typings/src/conversion/pipelineStringToJson.test.d.ts +1 -0
  113. package/esm/typings/src/conversion/pipelineStringToJsonSync.d.ts +29 -0
  114. package/esm/typings/src/conversion/pipelineStringToJsonSync.test.d.ts +1 -0
  115. package/esm/typings/src/conversion/prettify/PrettifyOptions.d.ts +13 -0
  116. package/esm/typings/src/conversion/prettify/prettifyPipelineString.d.ts +12 -0
  117. package/esm/typings/src/conversion/prettify/renderPipelineMermaidOptions.d.ts +30 -0
  118. package/esm/typings/src/conversion/utils/extractParameterNamesFromTask.d.ts +15 -0
  119. package/esm/typings/src/conversion/utils/extractParameterNamesFromTask.test.d.ts +1 -0
  120. package/esm/typings/src/conversion/utils/extractVariables.d.ts +14 -0
  121. package/esm/typings/src/conversion/utils/extractVariables.test.d.ts +1 -0
  122. package/esm/typings/src/conversion/utils/renameParameter.d.ts +26 -0
  123. package/esm/typings/src/conversion/utils/renameParameter.test.d.ts +1 -0
  124. package/esm/typings/src/conversion/utils/stringifyPipelineJson.d.ts +16 -0
  125. package/esm/typings/src/conversion/utils/stringifyPipelineJson.test.d.ts +1 -0
  126. package/esm/typings/src/conversion/utils/titleToName.d.ts +9 -0
  127. package/esm/typings/src/conversion/utils/titleToName.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 +40 -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/serializeError.d.ts +7 -0
  157. package/esm/typings/src/errors/utils/serializeError.test.d.ts +1 -0
  158. package/esm/typings/src/executables/$provideExecutablesForNode.d.ts +12 -0
  159. package/esm/typings/src/executables/apps/locateLibreoffice.d.ts +11 -0
  160. package/esm/typings/src/executables/apps/locateLibreoffice.test.d.ts +1 -0
  161. package/esm/typings/src/executables/apps/locatePandoc.d.ts +11 -0
  162. package/esm/typings/src/executables/apps/locatePandoc.test.d.ts +1 -0
  163. package/esm/typings/src/executables/locateApp.d.ts +33 -0
  164. package/esm/typings/src/executables/locateApp.test.d.ts +1 -0
  165. package/esm/typings/src/executables/platforms/locateAppOnLinux.d.ts +12 -0
  166. package/esm/typings/src/executables/platforms/locateAppOnMacOs.d.ts +12 -0
  167. package/esm/typings/src/executables/platforms/locateAppOnWindows.d.ts +12 -0
  168. package/esm/typings/src/execution/AvailableModel.d.ts +20 -0
  169. package/esm/typings/src/execution/CommonToolsOptions.d.ts +15 -0
  170. package/esm/typings/src/execution/EmbeddingVector.d.ts +8 -0
  171. package/esm/typings/src/execution/Executables.d.ts +18 -0
  172. package/esm/typings/src/execution/ExecutionTools.d.ts +62 -0
  173. package/esm/typings/src/execution/FilesystemTools.d.ts +9 -0
  174. package/esm/typings/src/execution/LlmExecutionTools.d.ts +61 -0
  175. package/esm/typings/src/execution/LlmExecutionToolsConstructor.d.ts +10 -0
  176. package/esm/typings/src/execution/PipelineExecutor.d.ts +19 -0
  177. package/esm/typings/src/execution/PipelineExecutorResult.d.ts +50 -0
  178. package/esm/typings/src/execution/PromptResult.d.ts +101 -0
  179. package/esm/typings/src/execution/PromptResultUsage.d.ts +33 -0
  180. package/esm/typings/src/execution/ScriptExecutionTools.d.ts +39 -0
  181. package/esm/typings/src/execution/UncertainNumber.d.ts +19 -0
  182. package/esm/typings/src/execution/UserInterfaceTools.d.ts +46 -0
  183. package/esm/typings/src/execution/assertsExecutionSuccessful.d.ts +13 -0
  184. package/esm/typings/src/execution/createPipelineExecutor/$OngoingTaskResult.d.ts +45 -0
  185. package/esm/typings/src/execution/createPipelineExecutor/00-CreatePipelineExecutorOptions.d.ts +46 -0
  186. package/esm/typings/src/execution/createPipelineExecutor/00-createPipelineExecutor.d.ts +13 -0
  187. package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts +49 -0
  188. package/esm/typings/src/execution/createPipelineExecutor/20-executeTask.d.ts +51 -0
  189. package/esm/typings/src/execution/createPipelineExecutor/30-executeFormatSubvalues.d.ts +15 -0
  190. package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +64 -0
  191. package/esm/typings/src/execution/createPipelineExecutor/filterJustOutputParameters.d.ts +34 -0
  192. package/esm/typings/src/execution/createPipelineExecutor/getContextForTask.d.ts +10 -0
  193. package/esm/typings/src/execution/createPipelineExecutor/getExamplesForTask.d.ts +10 -0
  194. package/esm/typings/src/execution/createPipelineExecutor/getKnowledgeForTask.d.ts +27 -0
  195. package/esm/typings/src/execution/createPipelineExecutor/getReservedParametersForTask.d.ts +30 -0
  196. package/esm/typings/src/execution/embeddingVectorToString.d.ts +7 -0
  197. package/esm/typings/src/execution/execution-report/ExecutionPromptReportJson.d.ts +24 -0
  198. package/esm/typings/src/execution/execution-report/ExecutionReportJson.d.ts +41 -0
  199. package/esm/typings/src/execution/execution-report/ExecutionReportString.d.ts +16 -0
  200. package/esm/typings/src/execution/execution-report/ExecutionReportStringOptions.d.ts +25 -0
  201. package/esm/typings/src/execution/execution-report/countWorkingDuration.d.ts +7 -0
  202. package/esm/typings/src/execution/execution-report/countWorkingDuration.test.d.ts +1 -0
  203. package/esm/typings/src/execution/execution-report/executionReportJsonToString.d.ts +15 -0
  204. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/AutomaticTranslator.d.ts +7 -0
  205. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/DebugAutomaticTranslator.d.ts +11 -0
  206. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/FakeAutomaticTranslator.d.ts +8 -0
  207. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/LindatAutomaticTranslator.d.ts +22 -0
  208. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/TranslatorOptions.d.ts +7 -0
  209. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.d.ts +8 -0
  210. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.test.d.ts +1 -0
  211. package/esm/typings/src/execution/translation/automatic-translate/translateMessages.d.ts +12 -0
  212. package/esm/typings/src/execution/utils/$provideExecutionToolsForNode.d.ts +13 -0
  213. package/esm/typings/src/execution/utils/addUsage.d.ts +9 -0
  214. package/esm/typings/src/execution/utils/addUsage.test.d.ts +1 -0
  215. package/esm/typings/src/execution/utils/checkExpectations.d.ts +29 -0
  216. package/esm/typings/src/execution/utils/checkExpectations.test.d.ts +1 -0
  217. package/esm/typings/src/execution/utils/computeUsageCounts.d.ts +10 -0
  218. package/esm/typings/src/execution/utils/forEachAsync.d.ts +20 -0
  219. package/esm/typings/src/execution/utils/uncertainNumber.d.ts +9 -0
  220. package/esm/typings/src/execution/utils/usage-constants.d.ts +130 -0
  221. package/esm/typings/src/execution/utils/usageToHuman.d.ts +16 -0
  222. package/esm/typings/src/execution/utils/usageToWorktime.d.ts +12 -0
  223. package/esm/typings/src/execution/utils/usageToWorktime.test.d.ts +1 -0
  224. package/esm/typings/src/expectations/drafts/isDomainNameFree.d.ts +9 -0
  225. package/esm/typings/src/expectations/drafts/isGithubNameFree.d.ts +9 -0
  226. package/esm/typings/src/formats/_common/FormatDefinition.d.ts +70 -0
  227. package/esm/typings/src/formats/_common/FormatSubvalueDefinition.d.ts +31 -0
  228. package/esm/typings/src/formats/csv/CsvFormatDefinition.d.ts +17 -0
  229. package/esm/typings/src/formats/csv/CsvFormatError.d.ts +10 -0
  230. package/esm/typings/src/formats/csv/CsvSettings.d.ts +13 -0
  231. package/esm/typings/src/formats/index.d.ts +9 -0
  232. package/esm/typings/src/formats/json/JsonFormatDefinition.d.ts +19 -0
  233. package/esm/typings/src/formats/json/utils/isValidJsonString.d.ts +6 -0
  234. package/esm/typings/src/formats/json/utils/isValidJsonString.test.d.ts +1 -0
  235. package/esm/typings/src/formats/text/TextFormatDefinition.d.ts +19 -0
  236. package/esm/typings/src/formats/xml/XmlFormatDefinition.d.ts +19 -0
  237. package/esm/typings/src/formfactors/_boilerplate/BoilerplateFormfactorDefinition.d.ts +14 -0
  238. package/esm/typings/src/formfactors/_common/AbstractFormfactorDefinition.d.ts +40 -0
  239. package/esm/typings/src/formfactors/_common/FormfactorDefinition.d.ts +8 -0
  240. package/esm/typings/src/formfactors/_common/string_formfactor_name.d.ts +5 -0
  241. package/esm/typings/src/formfactors/chatbot/ChatbotFormfactorDefinition.d.ts +45 -0
  242. package/esm/typings/src/formfactors/generator/GeneratorFormfactorDefinition.d.ts +14 -0
  243. package/esm/typings/src/formfactors/generic/GenericFormfactorDefinition.d.ts +14 -0
  244. package/esm/typings/src/formfactors/index.d.ts +113 -0
  245. package/esm/typings/src/formfactors/matcher/MatcherFormfactorDefinition.d.ts +14 -0
  246. package/esm/typings/src/formfactors/sheets/SheetsFormfactorDefinition.d.ts +25 -0
  247. package/esm/typings/src/formfactors/translator/TranslatorFormfactorDefinition.d.ts +24 -0
  248. package/esm/typings/src/llm-providers/_common/register/$llmToolsMetadataRegister.d.ts +13 -0
  249. package/esm/typings/src/llm-providers/_common/register/$llmToolsRegister.d.ts +13 -0
  250. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsConfigurationFromEnv.d.ts +24 -0
  251. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForCli.d.ts +15 -0
  252. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForTestingAndScriptsAndPlayground.d.ts +24 -0
  253. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsFromEnv.d.ts +26 -0
  254. package/esm/typings/src/llm-providers/_common/register/$registeredLlmToolsMessage.d.ts +12 -0
  255. package/esm/typings/src/llm-providers/_common/register/LlmToolsConfiguration.d.ts +23 -0
  256. package/esm/typings/src/llm-providers/_common/register/LlmToolsMetadata.d.ts +28 -0
  257. package/esm/typings/src/llm-providers/_common/register/LlmToolsOptions.d.ts +10 -0
  258. package/esm/typings/src/llm-providers/_common/register/createLlmToolsFromConfiguration.d.ts +40 -0
  259. package/esm/typings/src/llm-providers/_common/utils/cache/CacheItem.d.ts +28 -0
  260. package/esm/typings/src/llm-providers/_common/utils/cache/CacheLlmToolsOptions.d.ts +19 -0
  261. package/esm/typings/src/llm-providers/_common/utils/cache/cacheLlmTools.d.ts +19 -0
  262. package/esm/typings/src/llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage.d.ts +15 -0
  263. package/esm/typings/src/llm-providers/_common/utils/count-total-usage/countTotalUsage.d.ts +17 -0
  264. package/esm/typings/src/llm-providers/_common/utils/count-total-usage/limitTotalUsage.d.ts +36 -0
  265. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +60 -0
  266. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions.d.ts +31 -0
  267. package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +24 -0
  268. package/esm/typings/src/llm-providers/anthropic-claude/computeAnthropicClaudeUsage.d.ts +18 -0
  269. package/esm/typings/src/llm-providers/anthropic-claude/computeAnthropicClaudeUsage.test.d.ts +4 -0
  270. package/esm/typings/src/llm-providers/anthropic-claude/createAnthropicClaudeExecutionTools.d.ts +19 -0
  271. package/esm/typings/src/llm-providers/anthropic-claude/playground/playground.d.ts +7 -0
  272. package/esm/typings/src/llm-providers/anthropic-claude/register-configuration.d.ts +13 -0
  273. package/esm/typings/src/llm-providers/anthropic-claude/register-constructor.d.ts +14 -0
  274. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +63 -0
  275. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionToolsOptions.d.ts +37 -0
  276. package/esm/typings/src/llm-providers/azure-openai/createAzureOpenAiExecutionTools.d.ts +15 -0
  277. package/esm/typings/src/llm-providers/azure-openai/playground/playground.d.ts +6 -0
  278. package/esm/typings/src/llm-providers/azure-openai/register-configuration.d.ts +13 -0
  279. package/esm/typings/src/llm-providers/azure-openai/register-constructor.d.ts +14 -0
  280. package/esm/typings/src/llm-providers/mocked/$fakeTextToExpectations.d.ts +15 -0
  281. package/esm/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts +40 -0
  282. package/esm/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts +44 -0
  283. package/esm/typings/src/llm-providers/mocked/test/fakeTextToExpectations.test.d.ts +1 -0
  284. package/esm/typings/src/llm-providers/mocked/test/faked-completion.test.d.ts +1 -0
  285. package/esm/typings/src/llm-providers/mocked/test/joker.test.d.ts +4 -0
  286. package/esm/typings/src/llm-providers/mocked/test/mocked-chat.test.d.ts +5 -0
  287. package/esm/typings/src/llm-providers/mocked/test/mocked-completion.test.d.ts +4 -0
  288. package/esm/typings/src/llm-providers/multiple/MultipleLlmExecutionTools.d.ts +63 -0
  289. package/esm/typings/src/llm-providers/multiple/joinLlmExecutionTools.d.ts +21 -0
  290. package/esm/typings/src/llm-providers/multiple/playground/playground.d.ts +5 -0
  291. package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionTools.d.ts +36 -0
  292. package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionToolsOptions.d.ts +14 -0
  293. package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +84 -0
  294. package/esm/typings/src/llm-providers/openai/OpenAiExecutionToolsOptions.d.ts +20 -0
  295. package/esm/typings/src/llm-providers/openai/computeOpenAiUsage.d.ts +18 -0
  296. package/esm/typings/src/llm-providers/openai/computeOpenAiUsage.test.d.ts +4 -0
  297. package/esm/typings/src/llm-providers/openai/computeUsage.d.ts +16 -0
  298. package/esm/typings/src/llm-providers/openai/computeUsage.test.d.ts +1 -0
  299. package/esm/typings/src/llm-providers/openai/createOpenAiAssistantExecutionTools.d.ts +15 -0
  300. package/esm/typings/src/llm-providers/openai/createOpenAiExecutionTools.d.ts +15 -0
  301. package/esm/typings/src/llm-providers/openai/openai-models.d.ts +31 -0
  302. package/esm/typings/src/llm-providers/openai/playground/playground.d.ts +6 -0
  303. package/esm/typings/src/llm-providers/openai/register-configuration.d.ts +22 -0
  304. package/esm/typings/src/llm-providers/openai/register-constructor.d.ts +23 -0
  305. package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts +63 -0
  306. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Error.d.ts +7 -0
  307. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_ListModels_Request.d.ts +38 -0
  308. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_ListModels_Response.d.ts +15 -0
  309. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Prompt_Progress.d.ts +12 -0
  310. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Prompt_Request.d.ts +45 -0
  311. package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Prompt_Response.d.ts +12 -0
  312. package/esm/typings/src/llm-providers/remote/interfaces/RemoteLlmExecutionToolsOptions.d.ts +54 -0
  313. package/esm/typings/src/llm-providers/remote/interfaces/RemoteServerOptions.d.ts +73 -0
  314. package/esm/typings/src/llm-providers/remote/playground/playground.d.ts +5 -0
  315. package/esm/typings/src/llm-providers/remote/startRemoteServer.d.ts +23 -0
  316. package/esm/typings/src/personas/preparePersona.d.ts +17 -0
  317. package/esm/typings/src/pipeline/PipelineInterface/PipelineInterface.d.ts +22 -0
  318. package/esm/typings/src/pipeline/PipelineInterface/constants.d.ts +14 -0
  319. package/esm/typings/src/pipeline/PipelineInterface/getPipelineInterface.d.ts +11 -0
  320. package/esm/typings/src/pipeline/PipelineInterface/isPipelineImplementingInterface.d.ts +26 -0
  321. package/esm/typings/src/pipeline/PipelineInterface/isPipelineInterfacesEqual.d.ts +10 -0
  322. package/esm/typings/src/pipeline/PipelineJson/CommonTaskJson.d.ts +100 -0
  323. package/esm/typings/src/pipeline/PipelineJson/DialogTaskJson.d.ts +13 -0
  324. package/esm/typings/src/pipeline/PipelineJson/Expectations.d.ts +40 -0
  325. package/esm/typings/src/pipeline/PipelineJson/KnowledgePieceJson.d.ts +73 -0
  326. package/esm/typings/src/pipeline/PipelineJson/KnowledgeSourceJson.d.ts +44 -0
  327. package/esm/typings/src/pipeline/PipelineJson/ParameterJson.d.ts +98 -0
  328. package/esm/typings/src/pipeline/PipelineJson/PersonaJson.d.ts +45 -0
  329. package/esm/typings/src/pipeline/PipelineJson/PipelineJson.d.ts +102 -0
  330. package/esm/typings/src/pipeline/PipelineJson/PreparationJson.d.ts +22 -0
  331. package/esm/typings/src/pipeline/PipelineJson/PromptTaskJson.d.ts +26 -0
  332. package/esm/typings/src/pipeline/PipelineJson/ScriptTaskJson.d.ts +20 -0
  333. package/esm/typings/src/pipeline/PipelineJson/SimpleTaskJson.d.ts +13 -0
  334. package/esm/typings/src/pipeline/PipelineJson/TaskJson.d.ts +11 -0
  335. package/esm/typings/src/pipeline/PipelineString.d.ts +12 -0
  336. package/esm/typings/src/postprocessing/utils/extractBlock.d.ts +16 -0
  337. package/esm/typings/src/postprocessing/utils/extractJsonBlock.d.ts +25 -0
  338. package/esm/typings/src/postprocessing/utils/extractJsonBlock.test.d.ts +1 -0
  339. package/esm/typings/src/prepare/PrepareAndScrapeOptions.d.ts +51 -0
  340. package/esm/typings/src/prepare/isPipelinePrepared.d.ts +16 -0
  341. package/esm/typings/src/prepare/isPipelinePrepared.test.d.ts +1 -0
  342. package/esm/typings/src/prepare/preparePipeline.d.ts +20 -0
  343. package/esm/typings/src/prepare/prepareTasks.d.ts +32 -0
  344. package/esm/typings/src/prepare/unpreparePipeline.d.ts +12 -0
  345. package/esm/typings/src/scrapers/_common/Converter.d.ts +22 -0
  346. package/esm/typings/src/scrapers/_common/Scraper.d.ts +59 -0
  347. package/esm/typings/src/scrapers/_common/ScraperIntermediateSource.d.ts +11 -0
  348. package/esm/typings/src/scrapers/_common/prepareKnowledgePieces.d.ts +19 -0
  349. package/esm/typings/src/scrapers/_common/prepareKnowledgePieces.test.d.ts +1 -0
  350. package/esm/typings/src/scrapers/_common/register/$provideFilesystemForNode.d.ts +11 -0
  351. package/esm/typings/src/scrapers/_common/register/$provideScrapersForBrowser.d.ts +12 -0
  352. package/esm/typings/src/scrapers/_common/register/$provideScrapersForNode.d.ts +15 -0
  353. package/esm/typings/src/scrapers/_common/register/$registeredScrapersMessage.d.ts +13 -0
  354. package/esm/typings/src/scrapers/_common/register/$scrapersMetadataRegister.d.ts +13 -0
  355. package/esm/typings/src/scrapers/_common/register/$scrapersRegister.d.ts +13 -0
  356. package/esm/typings/src/scrapers/_common/register/ScraperAndConverterMetadata.d.ts +41 -0
  357. package/esm/typings/src/scrapers/_common/register/ScraperConstructor.d.ts +12 -0
  358. package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.d.ts +34 -0
  359. package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.test.d.ts +4 -0
  360. package/esm/typings/src/scrapers/_common/utils/makeKnowledgeSourceHandler.d.ts +11 -0
  361. package/esm/typings/src/scrapers/document/DocumentScraper.d.ts +43 -0
  362. package/esm/typings/src/scrapers/document/DocumentScraper.test.d.ts +4 -0
  363. package/esm/typings/src/scrapers/document/createDocumentScraper.d.ts +20 -0
  364. package/esm/typings/src/scrapers/document/playground/document-scraper-playground.d.ts +5 -0
  365. package/esm/typings/src/scrapers/document/register-constructor.d.ts +14 -0
  366. package/esm/typings/src/scrapers/document/register-metadata.d.ts +27 -0
  367. package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.d.ts +43 -0
  368. package/esm/typings/src/scrapers/document-legacy/LegacyDocumentScraper.test.d.ts +4 -0
  369. package/esm/typings/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts +20 -0
  370. package/esm/typings/src/scrapers/document-legacy/playground/legacy-document-scraper-playground.d.ts +5 -0
  371. package/esm/typings/src/scrapers/document-legacy/register-constructor.d.ts +14 -0
  372. package/esm/typings/src/scrapers/document-legacy/register-metadata.d.ts +27 -0
  373. package/esm/typings/src/scrapers/markdown/MarkdownScraper.d.ts +29 -0
  374. package/esm/typings/src/scrapers/markdown/MarkdownScraper.test.d.ts +4 -0
  375. package/esm/typings/src/scrapers/markdown/createMarkdownScraper.d.ts +20 -0
  376. package/esm/typings/src/scrapers/markdown/playground/markdown-scraper-playground.d.ts +5 -0
  377. package/esm/typings/src/scrapers/markdown/register-constructor.d.ts +14 -0
  378. package/esm/typings/src/scrapers/markdown/register-metadata.d.ts +27 -0
  379. package/esm/typings/src/scrapers/pdf/PdfScraper.d.ts +40 -0
  380. package/esm/typings/src/scrapers/pdf/createPdfScraper.d.ts +20 -0
  381. package/esm/typings/src/scrapers/pdf/playground/pdf-scraper-playground.d.ts +5 -0
  382. package/esm/typings/src/scrapers/pdf/register-constructor.d.ts +14 -0
  383. package/esm/typings/src/scrapers/pdf/register-metadata.d.ts +27 -0
  384. package/esm/typings/src/scrapers/website/WebsiteScraper.d.ts +50 -0
  385. package/esm/typings/src/scrapers/website/createWebsiteScraper.d.ts +20 -0
  386. package/esm/typings/src/scrapers/website/playground/website-scraper-playground.d.ts +5 -0
  387. package/esm/typings/src/scrapers/website/register-constructor.d.ts +14 -0
  388. package/esm/typings/src/scrapers/website/register-metadata.d.ts +27 -0
  389. package/esm/typings/src/scrapers/website/utils/createShowdownConverter.d.ts +7 -0
  390. package/esm/typings/src/scrapers/website/utils/createShowdownConverter.test.d.ts +1 -0
  391. package/esm/typings/src/scripting/_test/custom-function-async.test.ts.test.d.ts +1 -0
  392. package/esm/typings/src/scripting/_test/custom-function-missing.test.d.ts +1 -0
  393. package/esm/typings/src/scripting/_test/custom-function-with-dependencies.test.d.ts +1 -0
  394. package/esm/typings/src/scripting/_test/custom-function.test.d.ts +1 -0
  395. package/esm/typings/src/scripting/_test/postprocessing.test.d.ts +1 -0
  396. package/esm/typings/src/scripting/_test/script-execution-errors.test.d.ts +1 -0
  397. package/esm/typings/src/scripting/_test/script-execution-tools.test.d.ts +1 -0
  398. package/esm/typings/src/scripting/javascript/JavascriptEvalExecutionTools.d.ts +22 -0
  399. package/esm/typings/src/scripting/javascript/JavascriptEvalExecutionTools.test.d.ts +4 -0
  400. package/esm/typings/src/scripting/javascript/JavascriptExecutionTools.d.ts +8 -0
  401. package/esm/typings/src/scripting/javascript/JavascriptExecutionToolsOptions.d.ts +26 -0
  402. package/esm/typings/src/scripting/javascript/postprocessing-functions.d.ts +52 -0
  403. package/esm/typings/src/scripting/javascript/utils/preserve.d.ts +13 -0
  404. package/esm/typings/src/scripting/javascript/utils/unknownToString.d.ts +8 -0
  405. package/esm/typings/src/scripting/python/PythonExecutionTools.d.ts +18 -0
  406. package/esm/typings/src/scripting/typescript/TypescriptExecutionTools.d.ts +18 -0
  407. package/esm/typings/src/storage/_common/PromptbookStorage.d.ts +24 -0
  408. package/esm/typings/src/storage/_common/PromptbookStorage.test-type.d.ts +5 -0
  409. package/esm/typings/src/storage/blackhole/BlackholeStorage.d.ts +33 -0
  410. package/esm/typings/src/storage/file-cache-storage/FileCacheStorage.d.ts +33 -0
  411. package/esm/typings/src/storage/file-cache-storage/FileCacheStorageOptions.d.ts +10 -0
  412. package/esm/typings/src/storage/file-cache-storage/utils/nameToSubfolderPath.d.ts +7 -0
  413. package/esm/typings/src/storage/file-cache-storage/utils/nameToSubfolderPath.test.d.ts +1 -0
  414. package/esm/typings/src/storage/local-storage/getLocalStorage.d.ts +10 -0
  415. package/esm/typings/src/storage/local-storage/getSessionStorage.d.ts +10 -0
  416. package/esm/typings/src/storage/local-storage/utils/makePromptbookStorageFromWebStorage.d.ts +11 -0
  417. package/esm/typings/src/storage/memory/MemoryStorage.d.ts +33 -0
  418. package/esm/typings/src/storage/utils/PrefixStorage.d.ts +25 -0
  419. package/esm/typings/src/types/Arrayable.d.ts +10 -0
  420. package/esm/typings/src/types/IntermediateFilesStrategy.d.ts +7 -0
  421. package/esm/typings/src/types/ModelRequirements.d.ts +104 -0
  422. package/esm/typings/src/types/ModelVariant.d.ts +15 -0
  423. package/esm/typings/src/types/Prompt.d.ts +111 -0
  424. package/esm/typings/src/types/ScriptLanguage.d.ts +13 -0
  425. package/esm/typings/src/types/SectionType.d.ts +21 -0
  426. package/esm/typings/src/types/TaskProgress.d.ts +43 -0
  427. package/esm/typings/src/types/TaskType.d.ts +15 -0
  428. package/esm/typings/src/types/typeAliasEmoji.d.ts +12 -0
  429. package/esm/typings/src/types/typeAliases.d.ts +616 -0
  430. package/esm/typings/src/utils/$Register.d.ts +39 -0
  431. package/esm/typings/src/utils/$currentDate.d.ts +10 -0
  432. package/esm/typings/src/utils/FromtoItems.d.ts +19 -0
  433. package/esm/typings/src/utils/arrayableToArray.d.ts +11 -0
  434. package/esm/typings/src/utils/arrayableToArray.test.d.ts +1 -0
  435. package/esm/typings/src/utils/emojis.d.ts +24 -0
  436. package/esm/typings/src/utils/environment/$getGlobalScope.d.ts +9 -0
  437. package/esm/typings/src/utils/environment/$isRunningInBrowser.d.ts +8 -0
  438. package/esm/typings/src/utils/environment/$isRunningInNode.d.ts +8 -0
  439. package/esm/typings/src/utils/environment/$isRunningInWebWorker.d.ts +8 -0
  440. package/esm/typings/src/utils/execCommand/$execCommand.d.ts +16 -0
  441. package/esm/typings/src/utils/execCommand/$execCommandNormalizeOptions.d.ts +12 -0
  442. package/esm/typings/src/utils/execCommand/$execCommands.d.ts +18 -0
  443. package/esm/typings/src/utils/execCommand/ExecCommandOptions.d.ts +45 -0
  444. package/esm/typings/src/utils/execCommand/execCommand.test.d.ts +1 -0
  445. package/esm/typings/src/utils/execCommand/execCommandNormalizeOptions.test.d.ts +1 -0
  446. package/esm/typings/src/utils/expectation-counters/constants.d.ts +16 -0
  447. package/esm/typings/src/utils/expectation-counters/countCharacters.d.ts +7 -0
  448. package/esm/typings/src/utils/expectation-counters/countCharacters.test.d.ts +1 -0
  449. package/esm/typings/src/utils/expectation-counters/countLines.d.ts +9 -0
  450. package/esm/typings/src/utils/expectation-counters/countLines.test.d.ts +1 -0
  451. package/esm/typings/src/utils/expectation-counters/countPages.d.ts +9 -0
  452. package/esm/typings/src/utils/expectation-counters/countPages.test.d.ts +1 -0
  453. package/esm/typings/src/utils/expectation-counters/countParagraphs.d.ts +7 -0
  454. package/esm/typings/src/utils/expectation-counters/countParagraphs.test.d.ts +1 -0
  455. package/esm/typings/src/utils/expectation-counters/countSentences.d.ts +13 -0
  456. package/esm/typings/src/utils/expectation-counters/countSentences.test.d.ts +1 -0
  457. package/esm/typings/src/utils/expectation-counters/countWords.d.ts +7 -0
  458. package/esm/typings/src/utils/expectation-counters/countWords.test.d.ts +1 -0
  459. package/esm/typings/src/utils/expectation-counters/index.d.ts +12 -0
  460. package/esm/typings/src/utils/files/extensionToMimeType.d.ts +8 -0
  461. package/esm/typings/src/utils/files/extensionToMimeType.test.d.ts +1 -0
  462. package/esm/typings/src/utils/files/getFileExtension.d.ts +8 -0
  463. package/esm/typings/src/utils/files/getFileExtension.test.d.ts +1 -0
  464. package/esm/typings/src/utils/files/isDirectoryExisting.d.ts +14 -0
  465. package/esm/typings/src/utils/files/isDirectoryExisting.test.d.ts +1 -0
  466. package/esm/typings/src/utils/files/isExecutable.d.ts +11 -0
  467. package/esm/typings/src/utils/files/isFileExisting.d.ts +13 -0
  468. package/esm/typings/src/utils/files/isFileExisting.test.d.ts +1 -0
  469. package/esm/typings/src/utils/files/listAllFiles.d.ts +17 -0
  470. package/esm/typings/src/utils/files/listAllFiles.test.d.ts +1 -0
  471. package/esm/typings/src/utils/formatNumber.d.ts +6 -0
  472. package/esm/typings/src/utils/formatNumber.test.d.ts +1 -0
  473. package/esm/typings/src/utils/getCurrentIsoDate.d.ts +7 -0
  474. package/esm/typings/src/utils/markdown/addAutoGeneratedSection.d.ts +14 -0
  475. package/esm/typings/src/utils/markdown/addAutoGeneratedSection.test.d.ts +1 -0
  476. package/esm/typings/src/utils/markdown/createMarkdownChart.d.ts +38 -0
  477. package/esm/typings/src/utils/markdown/createMarkdownChart.test.d.ts +1 -0
  478. package/esm/typings/src/utils/markdown/createMarkdownTable.d.ts +11 -0
  479. package/esm/typings/src/utils/markdown/createMarkdownTable.test.d.ts +1 -0
  480. package/esm/typings/src/utils/markdown/escapeMarkdownBlock.d.ts +11 -0
  481. package/esm/typings/src/utils/markdown/escapeMarkdownBlock.test.d.ts +1 -0
  482. package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown-real.test.d.ts +1 -0
  483. package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.d.ts +36 -0
  484. package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.test.d.ts +1 -0
  485. package/esm/typings/src/utils/markdown/extractAllListItemsFromMarkdown.d.ts +15 -0
  486. package/esm/typings/src/utils/markdown/extractAllListItemsFromMarkdown.test.d.ts +1 -0
  487. package/esm/typings/src/utils/markdown/extractOneBlockFromMarkdown.d.ts +22 -0
  488. package/esm/typings/src/utils/markdown/extractOneBlockFromMarkdown.test.d.ts +1 -0
  489. package/esm/typings/src/utils/markdown/flattenMarkdown.d.ts +17 -0
  490. package/esm/typings/src/utils/markdown/flattenMarkdown.test.d.ts +1 -0
  491. package/esm/typings/src/utils/markdown/parseMarkdownSection.d.ts +34 -0
  492. package/esm/typings/src/utils/markdown/parseMarkdownSection.test.d.ts +1 -0
  493. package/esm/typings/src/utils/markdown/prettifyMarkdown.d.ts +9 -0
  494. package/esm/typings/src/utils/markdown/prettifyMarkdown.test.d.ts +1 -0
  495. package/esm/typings/src/utils/markdown/removeContentComments.d.ts +10 -0
  496. package/esm/typings/src/utils/markdown/removeContentComments.test.d.ts +1 -0
  497. package/esm/typings/src/utils/markdown/removeMarkdownFormatting.d.ts +9 -0
  498. package/esm/typings/src/utils/markdown/removeMarkdownFormatting.test.d.ts +1 -0
  499. package/esm/typings/src/utils/markdown/splitMarkdownIntoSections.d.ts +15 -0
  500. package/esm/typings/src/utils/markdown/splitMarkdownIntoSections.test.d.ts +1 -0
  501. package/esm/typings/src/utils/normalization/DIACRITIC_VARIANTS_LETTERS.d.ts +12 -0
  502. package/esm/typings/src/utils/normalization/IKeywords.d.ts +21 -0
  503. package/esm/typings/src/utils/normalization/capitalize.d.ts +6 -0
  504. package/esm/typings/src/utils/normalization/capitalize.test.d.ts +1 -0
  505. package/esm/typings/src/utils/normalization/decapitalize.d.ts +6 -0
  506. package/esm/typings/src/utils/normalization/decapitalize.test.d.ts +1 -0
  507. package/esm/typings/src/utils/normalization/isValidKeyword.d.ts +10 -0
  508. package/esm/typings/src/utils/normalization/isValidKeyword.test.d.ts +1 -0
  509. package/esm/typings/src/utils/normalization/nameToUriPart.d.ts +9 -0
  510. package/esm/typings/src/utils/normalization/nameToUriPart.test.d.ts +1 -0
  511. package/esm/typings/src/utils/normalization/nameToUriParts.d.ts +9 -0
  512. package/esm/typings/src/utils/normalization/nameToUriParts.test.d.ts +1 -0
  513. package/esm/typings/src/utils/normalization/normalize-to-kebab-case.d.ts +21 -0
  514. package/esm/typings/src/utils/normalization/normalize-to-kebab-case.test.d.ts +1 -0
  515. package/esm/typings/src/utils/normalization/normalizeTo_PascalCase.d.ts +17 -0
  516. package/esm/typings/src/utils/normalization/normalizeTo_PascalCase.test.d.ts +1 -0
  517. package/esm/typings/src/utils/normalization/normalizeTo_SCREAMING_CASE.d.ts +26 -0
  518. package/esm/typings/src/utils/normalization/normalizeTo_SCREAMING_CASE.test.d.ts +1 -0
  519. package/esm/typings/src/utils/normalization/normalizeTo_camelCase.d.ts +22 -0
  520. package/esm/typings/src/utils/normalization/normalizeTo_camelCase.test.d.ts +1 -0
  521. package/esm/typings/src/utils/normalization/normalizeTo_snake_case.d.ts +17 -0
  522. package/esm/typings/src/utils/normalization/normalizeTo_snake_case.test.d.ts +1 -0
  523. package/esm/typings/src/utils/normalization/normalizeWhitespaces.d.ts +6 -0
  524. package/esm/typings/src/utils/normalization/normalizeWhitespaces.test.d.ts +1 -0
  525. package/esm/typings/src/utils/normalization/parseKeywords.d.ts +16 -0
  526. package/esm/typings/src/utils/normalization/parseKeywords.test.d.ts +1 -0
  527. package/esm/typings/src/utils/normalization/parseKeywordsFromString.d.ts +9 -0
  528. package/esm/typings/src/utils/normalization/parseKeywordsFromString.test.d.ts +1 -0
  529. package/esm/typings/src/utils/normalization/removeDiacritics.d.ts +11 -0
  530. package/esm/typings/src/utils/normalization/removeDiacritics.test.d.ts +1 -0
  531. package/esm/typings/src/utils/normalization/searchKeywords.d.ts +10 -0
  532. package/esm/typings/src/utils/normalization/searchKeywords.test.d.ts +1 -0
  533. package/esm/typings/src/utils/organization/TODO_USE.d.ts +12 -0
  534. package/esm/typings/src/utils/organization/TODO_any.d.ts +6 -0
  535. package/esm/typings/src/utils/organization/TODO_object.d.ts +6 -0
  536. package/esm/typings/src/utils/organization/TODO_remove_as.d.ts +6 -0
  537. package/esm/typings/src/utils/organization/TODO_string.d.ts +6 -0
  538. package/esm/typings/src/utils/organization/TODO_unknown.d.ts +6 -0
  539. package/esm/typings/src/utils/organization/___and___.d.ts +7 -0
  540. package/esm/typings/src/utils/organization/___or___.d.ts +6 -0
  541. package/esm/typings/src/utils/organization/empty_object.d.ts +10 -0
  542. package/esm/typings/src/utils/organization/just.d.ts +14 -0
  543. package/esm/typings/src/utils/organization/just_empty_object.d.ts +12 -0
  544. package/esm/typings/src/utils/organization/keepUnused.d.ts +16 -0
  545. package/esm/typings/src/utils/organization/really_any.d.ts +6 -0
  546. package/esm/typings/src/utils/organization/really_unknown.d.ts +6 -0
  547. package/esm/typings/src/utils/organization/spaceTrim.d.ts +11 -0
  548. package/esm/typings/src/utils/parameters/extractParameterNames.d.ts +10 -0
  549. package/esm/typings/src/utils/parameters/extractParameterNames.test.d.ts +1 -0
  550. package/esm/typings/src/utils/parameters/mapAvailableToExpectedParameters.d.ts +27 -0
  551. package/esm/typings/src/utils/parameters/mapAvailableToExpectedParameters.test.d.ts +1 -0
  552. package/esm/typings/src/utils/parameters/replaceParameters.d.ts +12 -0
  553. package/esm/typings/src/utils/parameters/replaceParameters.test.d.ts +1 -0
  554. package/esm/typings/src/utils/parseNumber.d.ts +16 -0
  555. package/esm/typings/src/utils/parseNumber.test.d.ts +1 -0
  556. package/esm/typings/src/utils/random/$randomSeed.d.ts +9 -0
  557. package/esm/typings/src/utils/removeEmojis.d.ts +8 -0
  558. package/esm/typings/src/utils/removeEmojis.test.d.ts +1 -0
  559. package/esm/typings/src/utils/removeQuotes.d.ts +14 -0
  560. package/esm/typings/src/utils/removeQuotes.test.d.ts +1 -0
  561. package/esm/typings/src/utils/serialization/$asDeeplyFrozenSerializableJson.d.ts +17 -0
  562. package/esm/typings/src/utils/serialization/$deepFreeze.d.ts +14 -0
  563. package/esm/typings/src/utils/serialization/checkSerializableAsJson.d.ts +27 -0
  564. package/esm/typings/src/utils/serialization/clonePipeline.d.ts +13 -0
  565. package/esm/typings/src/utils/serialization/deepClone.d.ts +10 -0
  566. package/esm/typings/src/utils/serialization/isSerializableAsJson.d.ts +24 -0
  567. package/esm/typings/src/utils/serialization/isSerializableAsJson.test.d.ts +1 -0
  568. package/esm/typings/src/utils/sets/difference.d.ts +10 -0
  569. package/esm/typings/src/utils/sets/difference.test.d.ts +1 -0
  570. package/esm/typings/src/utils/sets/intersection.d.ts +7 -0
  571. package/esm/typings/src/utils/sets/intersection.test.d.ts +1 -0
  572. package/esm/typings/src/utils/sets/union.d.ts +7 -0
  573. package/esm/typings/src/utils/sets/union.test.d.ts +1 -0
  574. package/esm/typings/src/utils/trimCodeBlock.d.ts +9 -0
  575. package/esm/typings/src/utils/trimCodeBlock.test.d.ts +1 -0
  576. package/esm/typings/src/utils/trimEndOfCodeBlock.d.ts +9 -0
  577. package/esm/typings/src/utils/trimEndOfCodeBlock.test.d.ts +1 -0
  578. package/esm/typings/src/utils/unwrapResult.d.ts +37 -0
  579. package/esm/typings/src/utils/unwrapResult.test.d.ts +1 -0
  580. package/esm/typings/src/utils/validators/email/isValidEmail.d.ts +8 -0
  581. package/esm/typings/src/utils/validators/email/isValidEmail.test.d.ts +1 -0
  582. package/esm/typings/src/utils/validators/filePath/isValidFilePath.d.ts +9 -0
  583. package/esm/typings/src/utils/validators/filePath/isValidFilePath.test.d.ts +1 -0
  584. package/esm/typings/src/utils/validators/javascriptName/isValidJavascriptName.d.ts +10 -0
  585. package/esm/typings/src/utils/validators/javascriptName/isValidJavascriptName.test.d.ts +1 -0
  586. package/esm/typings/src/utils/validators/parameterName/validateParameterName.d.ts +10 -0
  587. package/esm/typings/src/utils/validators/parameterName/validateParameterName.test.d.ts +1 -0
  588. package/esm/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.d.ts +15 -0
  589. package/esm/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.test.d.ts +1 -0
  590. package/esm/typings/src/utils/validators/semanticVersion/isValidSemanticVersion.d.ts +12 -0
  591. package/esm/typings/src/utils/validators/semanticVersion/isValidSemanticVersion.test.d.ts +1 -0
  592. package/esm/typings/src/utils/validators/url/isHostnameOnPrivateNetwork.d.ts +11 -0
  593. package/esm/typings/src/utils/validators/url/isHostnameOnPrivateNetwork.test.d.ts +1 -0
  594. package/esm/typings/src/utils/validators/url/isUrlOnPrivateNetwork.d.ts +13 -0
  595. package/esm/typings/src/utils/validators/url/isUrlOnPrivateNetwork.test.d.ts +1 -0
  596. package/esm/typings/src/utils/validators/url/isValidPipelineUrl.d.ts +15 -0
  597. package/esm/typings/src/utils/validators/url/isValidPipelineUrl.test.d.ts +1 -0
  598. package/esm/typings/src/utils/validators/url/isValidUrl.d.ts +13 -0
  599. package/esm/typings/src/utils/validators/url/isValidUrl.test.d.ts +1 -0
  600. package/esm/typings/src/utils/validators/uuid/isValidUuid.d.ts +8 -0
  601. package/esm/typings/src/utils/validators/uuid/isValidUuid.test.d.ts +1 -0
  602. package/esm/typings/src/version.d.ts +18 -0
  603. package/package.json +59 -0
  604. package/umd/index.umd.js +31 -0
  605. package/umd/index.umd.js.map +1 -0
@@ -0,0 +1,2 @@
1
+ import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
2
+ export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
@@ -0,0 +1,8 @@
1
+ import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
2
+ import { createWebsiteScraper } from '../scrapers/website/createWebsiteScraper';
3
+ import { _WebsiteScraperRegistration } from '../scrapers/website/register-constructor';
4
+ import { WebsiteScraper } from '../scrapers/website/WebsiteScraper';
5
+ export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
6
+ export { createWebsiteScraper };
7
+ export { _WebsiteScraperRegistration };
8
+ export { WebsiteScraper };
@@ -0,0 +1,12 @@
1
+ import type { Command as Program } from 'commander';
2
+ /**
3
+ * Initializes `about` command for Promptbook CLI utilities
4
+ *
5
+ * @private internal function of `promptbookCli`
6
+ */
7
+ export declare function initializeAboutCommand(program: Program): void;
8
+ /**
9
+ * TODO: [🗽] Unite branding and make single place for it
10
+ * Note: [💞] Ignore a discrepancy between file name and entity name
11
+ * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
12
+ */
@@ -0,0 +1,12 @@
1
+ import type { Command as Program } from 'commander';
2
+ /**
3
+ * Initializes testing `hello` command for Promptbook CLI utilities
4
+ *
5
+ * @private internal function of `promptbookCli`
6
+ */
7
+ export declare function initializeHelloCommand(program: Program): void;
8
+ /**
9
+ * TODO: [🧠][🐣] Make here some easter egg with generated hello greeting via LLM models
10
+ * Note: [💞] Ignore a discrepancy between file name and entity name
11
+ * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
12
+ */
@@ -0,0 +1,14 @@
1
+ import type { Command as Program } from 'commander';
2
+ /**
3
+ * Initializes `make` command for Promptbook CLI utilities
4
+ *
5
+ * @private internal function of `promptbookCli`
6
+ */
7
+ export declare function initializeMakeCommand(program: Program): void;
8
+ /**
9
+ * TODO: [🥃][main] !!! Allow `ptbk make` without configuring any llm tools
10
+ * TODO: [0] DRY Javascript and typescript - Maybe make ONLY typescript and for javascript just remove types
11
+ * Note: [💞] Ignore a discrepancy between file name and entity name
12
+ * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
13
+ * TODO: [🖇] What about symlinks? Maybe flag --follow-symlinks
14
+ */
@@ -0,0 +1,13 @@
1
+ import type { Command as Program } from 'commander';
2
+ /**
3
+ * Initializes `prettify` command for Promptbook CLI utilities
4
+ *
5
+ * @private internal function of `promptbookCli`
6
+ */
7
+ export declare function initializePrettifyCommand(program: Program): void;
8
+ /**
9
+ * TODO: [😶] Unite floder listing
10
+ * Note: [💞] Ignore a discrepancy between file name and entity name
11
+ * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
12
+ * TODO: [🖇] What about symlinks? Maybe flag --follow-symlinks
13
+ */
@@ -0,0 +1,15 @@
1
+ import type { Command as Program } from 'commander';
2
+ /**
3
+ * Initializes `run` command for Promptbook CLI utilities
4
+ *
5
+ * @private internal function of `promptbookCli`
6
+ */
7
+ export declare function initializeRunCommand(program: Program): void;
8
+ /**
9
+ * TODO: !!!!! Catch and wrap all errors from CLI
10
+ * TODO: [🧠] Pass `maxExecutionAttempts`, `csvSettings`
11
+ * TODO: [🥃][main] !!! Allow `ptbk run` without configuring any llm tools
12
+ * Note: [💞] Ignore a discrepancy between file name and entity name
13
+ * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
14
+ * TODO: [🖇] What about symlinks? Maybe flag --follow-symlinks
15
+ */
@@ -0,0 +1,14 @@
1
+ import type { Command as Program } from 'commander';
2
+ /**
3
+ * Initializes `test` command for Promptbook CLI utilities
4
+ *
5
+ * @private internal function of `promptbookCli`
6
+ */
7
+ export declare function initializeTestCommand(program: Program): void;
8
+ /**
9
+ * TODO: [😶] Unite floder listing
10
+ * Note: [💞] Ignore a discrepancy between file name and entity name
11
+ * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
12
+ * TODO: [🖇] What about symlinks? Maybe flag --follow-symlinks
13
+ * Note: This is named "test-command.ts" to avoid name collision with jest unit test files
14
+ */
@@ -0,0 +1,16 @@
1
+ import { promptbookCli } from './promptbookCli';
2
+ /**
3
+ * Note: [🔺] Purpose of this file is to export CLI for production environment
4
+ */
5
+ /**
6
+ * Hidden utilities which should not be used by external consumers.
7
+ *
8
+ * @public exported from `@promptbook/cli`
9
+ */
10
+ export declare const _CLI: {
11
+ _initialize_promptbookCli: typeof promptbookCli;
12
+ };
13
+ /**
14
+ * Note: [💞] Ignore a discrepancy between file name and entity name
15
+ * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
16
+ */
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Runs CLI utilities of Promptbook package
3
+ *
4
+ * @private within the `@promptbook/cli`
5
+ */
6
+ export declare function promptbookCli(): Promise<void>;
7
+ /**
8
+ * TODO: [🧠] Maybe `run` command the default, instead of `ptbk run ./foo.book.md` -> `ptbk ./foo.book.md`
9
+ * TODO: [🥠] Do not export, its just for CLI script
10
+ * TODO: [🕌] When more functionalities, rename
11
+ * Note: 11:11
12
+ * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
13
+ */
@@ -0,0 +1,5 @@
1
+ #!/usr/bin/env ts-node
2
+ /**
3
+ * Note: [🔺] Purpose of this file is to test the CLI in development environment
4
+ */
5
+ import '../../_packages/cli.index.ts';
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,25 @@
1
+ import type { Promisable } from 'type-fest';
2
+ import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
3
+ import type { Prompt } from '../types/Prompt';
4
+ import type { string_pipeline_url } from '../types/typeAliases';
5
+ /**
6
+ * Collection that groups together pipelines, knowledge, personas, tools and actions
7
+ *
8
+ * @see @@@ https://github.com/webgptorg/pipeline#pipeline-collection
9
+ */
10
+ export type PipelineCollection = {
11
+ /**
12
+ * Gets all pipelines in the collection
13
+ */
14
+ listPipelines(): Promisable<ReadonlyArray<string_pipeline_url>>;
15
+ /**
16
+ * Gets pipeline by its URL
17
+ *
18
+ * Note: This is not a direct fetching from the URL, but a lookup in the collection
19
+ */
20
+ getPipelineByUrl(url: string_pipeline_url): Promisable<PipelineJson>;
21
+ /**
22
+ * Checks whether given prompt was defined in any pipeline in the collection
23
+ */
24
+ isResponsibleForPrompt(prompt: Prompt): Promisable<boolean>;
25
+ };
@@ -0,0 +1,37 @@
1
+ import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
2
+ import type { Prompt } from '../types/Prompt';
3
+ import type { string_pipeline_url } from '../types/typeAliases';
4
+ import type { PipelineCollection } from './PipelineCollection';
5
+ /**
6
+ * Library of pipelines that groups together pipelines for an application.
7
+ * This implementation is a very thin wrapper around the Array / Map of pipelines.
8
+ *
9
+ * @private internal function of `createCollectionFromJson`, use `createCollectionFromJson` instead
10
+ * @see https://github.com/webgptorg/pipeline#pipeline-collection
11
+ */
12
+ export declare class SimplePipelineCollection implements PipelineCollection {
13
+ private collection;
14
+ /**
15
+ * Constructs a pipeline collection from pipelines
16
+ *
17
+ * @param pipelines @@@
18
+ *
19
+ * Note: During the construction logic of all pipelines are validated
20
+ * Note: It is not recommended to use this constructor directly, use `createCollectionFromJson` *(or other variant)* instead
21
+ */
22
+ constructor(...pipelines: ReadonlyArray<PipelineJson>);
23
+ /**
24
+ * Gets all pipelines in the collection
25
+ */
26
+ listPipelines(): ReadonlyArray<string_pipeline_url>;
27
+ /**
28
+ * Gets pipeline by its URL
29
+ *
30
+ * Note: This is not a direct fetching from the URL, but a lookup in the collection
31
+ */
32
+ getPipelineByUrl(url: string_pipeline_url): PipelineJson;
33
+ /**
34
+ * Checks whether given prompt was defined in any pipeline in the collection
35
+ */
36
+ isResponsibleForPrompt(prompt: Prompt): boolean;
37
+ }
@@ -0,0 +1,13 @@
1
+ import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
2
+ import type { PipelineCollection } from './PipelineCollection';
3
+ /**
4
+ * Converts PipelineCollection to serialized JSON
5
+ *
6
+ * Note: Functions `collectionToJson` and `createCollectionFromJson` are complementary
7
+ *
8
+ * @public exported from `@promptbook/core`
9
+ */
10
+ export declare function collectionToJson(collection: PipelineCollection): Promise<ReadonlyArray<PipelineJson>>;
11
+ /**
12
+ * TODO: [🧠] Maybe clear `sourceFile` or clear when exposing through API or remote server
13
+ */
@@ -0,0 +1,7 @@
1
+ export {};
2
+ /**
3
+ * Note: [🐠] For example here URL https://example.com/pipeline.book.md is not valid
4
+ * because it is on private network BUT its very hard to debug because
5
+ * there is no error message and false return (the error) happen deep in:
6
+ * `isValidPipelineUrl` -> `isValidPipelineUrl` -> `isUrlOnPrivateNetwork`
7
+ */
@@ -0,0 +1,54 @@
1
+ import type { ExecutionTools } from '../../execution/ExecutionTools';
2
+ import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
3
+ import type { string_dirname } from '../../types/typeAliases';
4
+ import type { PipelineCollection } from '../PipelineCollection';
5
+ /**
6
+ * Options for `createCollectionFromDirectory` function
7
+ *
8
+ * Note: `rootDirname` is not needed because it is the folder in which `.book.md` file is located
9
+ * This is not same as `path` which is the first argument of `createCollectionFromDirectory` - it can be a subfolder
10
+ */
11
+ type CreatePipelineCollectionFromDirectoryOptions = Omit<PrepareAndScrapeOptions, 'rootDirname'> & {
12
+ /**
13
+ * If true, the directory is searched recursively for pipelines
14
+ *
15
+ * @default true
16
+ */
17
+ isRecursive?: boolean;
18
+ /**
19
+ * If true, the collection creation outputs information about each file it reads
20
+ *
21
+ * @default false
22
+ */
23
+ isVerbose?: boolean;
24
+ /**
25
+ * If true, directory will be scanned only when needed not during the construction
26
+ *
27
+ * @default false
28
+ */
29
+ isLazyLoaded?: boolean;
30
+ /**
31
+ * If true, whole collection creation crashes on error in any pipeline
32
+ * If true and isLazyLoaded is true, the error is thrown on first access to the pipeline
33
+ *
34
+ * @default true
35
+ */
36
+ isCrashedOnError?: boolean;
37
+ };
38
+ /**
39
+ * Constructs Pipeline from given directory
40
+ *
41
+ * Note: Works only in Node.js environment because it reads the file system
42
+ *
43
+ * @param path - path to the directory with pipelines
44
+ * @param tools - Execution tools to be used for pipeline preparation if needed - If not provided, `$provideExecutionToolsForNode` will be used
45
+ * @param options - Options for the collection creation
46
+ * @returns PipelineCollection
47
+ * @public exported from `@promptbook/node`
48
+ */
49
+ export declare function createCollectionFromDirectory(path: string_dirname, tools?: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options?: CreatePipelineCollectionFromDirectoryOptions): Promise<PipelineCollection>;
50
+ export {};
51
+ /**
52
+ * TODO: [🖇] What about symlinks? Maybe option isSymlinksFollowed
53
+ * TODO: Maybe move from `@promptbook/node` to `@promptbook/core` as we removes direct dependency on `fs`
54
+ */
@@ -0,0 +1,13 @@
1
+ import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
2
+ import type { PipelineCollection } from '../PipelineCollection';
3
+ /**
4
+ * Creates PipelineCollection from array of PipelineJson or PipelineString
5
+ *
6
+ * Note: Functions `collectionToJson` and `createCollectionFromJson` are complementary
7
+ * Note: Syntax, parsing, and logic consistency checks are performed on all sources during build
8
+ *
9
+ * @param promptbookSources
10
+ * @returns PipelineCollection
11
+ * @public exported from `@promptbook/core`
12
+ */
13
+ export declare function createCollectionFromJson(...promptbooks: ReadonlyArray<PipelineJson>): PipelineCollection;
@@ -0,0 +1,23 @@
1
+ import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
2
+ import type { PipelineCollection } from '../PipelineCollection';
3
+ /**
4
+ * Constructs Promptbook from async sources
5
+ * It can be one of the following:
6
+ * - Promise of array of PipelineJson or PipelineString
7
+ * - Factory function that returns Promise of array of PipelineJson or PipelineString
8
+ *
9
+ * Note: This is useful as internal tool for other constructor functions like
10
+ * `createCollectionFromUrl` or `createCollectionFromDirectory`
11
+ * Consider using those functions instead of this one
12
+ *
13
+ * Note: The function does NOT return promise it returns the collection directly which waits for the sources to be resolved
14
+ * when error occurs in given promise or factory function, it is thrown during `listPipelines` or `getPipelineByUrl` call
15
+ *
16
+ * Note: Consider using `createCollectionFromDirectory` or `createCollectionFromUrl`
17
+ *
18
+ * @param promptbookSourcesPromiseOrFactory
19
+ * @returns PipelineCollection
20
+ * @deprecated Do not use, it will became internal tool for other constructor functions
21
+ * @public exported from `@promptbook/core`
22
+ */
23
+ export declare function createCollectionFromPromise(promptbookSourcesPromiseOrFactory: Promise<ReadonlyArray<PipelineJson>> | (() => Promise<ReadonlyArray<PipelineJson>>)): PipelineCollection;
@@ -0,0 +1,29 @@
1
+ import type { string_url } from '../../types/typeAliases';
2
+ import type { PipelineCollection } from '../PipelineCollection';
3
+ /**
4
+ * Options for `createCollectionFromDirectory` function
5
+ */
6
+ type CreatePipelineCollectionFromUrlyOptions = {
7
+ /**
8
+ * If true, the collection creation outputs information about each file it reads
9
+ *
10
+ * @default false
11
+ */
12
+ readonly isVerbose?: boolean;
13
+ /**
14
+ * If true, directory will be scanned only when needed not during the construction
15
+ *
16
+ * @default false
17
+ */
18
+ readonly isLazyLoaded?: boolean;
19
+ };
20
+ /**
21
+ * Constructs Promptbook from remote Promptbase URL
22
+ * @returns PipelineCollection
23
+ * @public exported from `@promptbook/core`
24
+ */
25
+ export declare function createCollectionFromUrl(url: string_url | URL, options: CreatePipelineCollectionFromUrlyOptions): Promise<PipelineCollection>;
26
+ export {};
27
+ /**
28
+ * TODO: [main] !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
29
+ */
@@ -0,0 +1,13 @@
1
+ import type { string_pipeline_url } from '../../types/typeAliases';
2
+ import type { PipelineCollection } from '../PipelineCollection';
3
+ /**
4
+ * Creates PipelineCollection as a subset of another PipelineCollection
5
+ *
6
+ * Note: You can use any type of collection as a parent collection - local, remote, etc.
7
+ * Note: This is just a thin wrapper / proxy around the parent collection
8
+ *
9
+ * @param promptbookSources
10
+ * @returns PipelineCollection
11
+ * @public exported from `@promptbook/core`
12
+ */
13
+ export declare function createSubcollection(collection: PipelineCollection, predicate: (url: string_pipeline_url) => boolean): PipelineCollection;
@@ -0,0 +1,11 @@
1
+ import type { string_semantic_version } from '../../types/typeAliases';
2
+ /**
3
+ * Parsed BOOK_VERSION command
4
+ *
5
+ * @see ./bookVersionCommandParser.ts for more details
6
+ * @private within the commands folder
7
+ */
8
+ export type BookVersionCommand = {
9
+ readonly type: 'BOOK_VERSION';
10
+ readonly bookVersion: string_semantic_version;
11
+ };
@@ -0,0 +1,9 @@
1
+ import type { PipelineHeadCommandParser } from '../_common/types/CommandParser';
2
+ import type { BookVersionCommand } from './BookVersionCommand';
3
+ /**
4
+ * Parses the BOOK_VERSION command
5
+ *
6
+ * @see `documentationUrl` for more details
7
+ * @private within the commands folder
8
+ */
9
+ export declare const bookVersionCommandParser: PipelineHeadCommandParser<BookVersionCommand>;
@@ -0,0 +1,17 @@
1
+ import type { ExpectationAmount } from '../../pipeline/PipelineJson/Expectations';
2
+ import type { ExpectationUnit } from '../../pipeline/PipelineJson/Expectations';
3
+ /**
4
+ * Expect amount command describes the desired output of the task (after post-processing)
5
+ * It can set limits for the maximum/minimum length of the output, measured in characters, words, sentences, paragraphs,...
6
+ *
7
+ * Note: LLMs work with tokens, not characters, but in Promptbooks we want to use some human-recognisable and cross-model interoperable units.
8
+ */
9
+ export type ExpectCommand = {
10
+ readonly type: 'EXPECT';
11
+ readonly sign: 'EXACTLY' | 'MINIMUM' | 'MAXIMUM';
12
+ readonly unit: ExpectationUnit;
13
+ readonly amount: ExpectationAmount;
14
+ };
15
+ /**
16
+ * TODO: [🍋] Allow to `EXPECT` relative amounts like `EXPECT MAX 130% {foo} Words`
17
+ */
@@ -0,0 +1,9 @@
1
+ import type { PipelineTaskCommandParser } from '../_common/types/CommandParser';
2
+ import type { ExpectCommand } from './ExpectCommand';
3
+ /**
4
+ * Parses the expect command
5
+ *
6
+ * @see `documentationUrl` for more details
7
+ * @private within the commands folder
8
+ */
9
+ export declare const expectCommandParser: PipelineTaskCommandParser<ExpectCommand>;
@@ -0,0 +1,10 @@
1
+ import type { ForeachJson } from './ForeachJson';
2
+ /**
3
+ * Parsed FOREACH command which is used to iterate over a table of values
4
+ *
5
+ * @see ./foreachCommandParser.ts for more details
6
+ * @private within the commands folder
7
+ */
8
+ export type ForeachCommand = {
9
+ readonly type: 'FOREACH';
10
+ } & ForeachJson;
@@ -0,0 +1,27 @@
1
+ import type { string_parameter_name } from '../../types/typeAliases';
2
+ import type { TODO_string } from '../../utils/organization/TODO_string';
3
+ /**
4
+ * @@@
5
+ */
6
+ export type ForeachJson = {
7
+ /**
8
+ * @@@
9
+ */
10
+ readonly formatName: TODO_string;
11
+ /**
12
+ * @@@
13
+ */
14
+ readonly subformatName: TODO_string;
15
+ /**
16
+ * @@@
17
+ */
18
+ readonly parameterName: string_parameter_name;
19
+ /**
20
+ * @@@
21
+ */
22
+ readonly inputSubparameterNames: Array<string_parameter_name>;
23
+ /**
24
+ * @@@
25
+ */
26
+ readonly outputSubparameterName: string_parameter_name;
27
+ };
@@ -0,0 +1,14 @@
1
+ import type { PipelineTaskCommandParser } from '../_common/types/CommandParser';
2
+ import type { ForeachCommand } from './ForeachCommand';
3
+ /**
4
+ * Parses the foreach command
5
+ *
6
+ * Note: @@@ This command is used as foreach for new commands - it should NOT be used in any `.book.md` file
7
+ *
8
+ * @see `documentationUrl` for more details
9
+ * @private within the commands folder
10
+ */
11
+ export declare const foreachCommandParser: PipelineTaskCommandParser<ForeachCommand>;
12
+ /**
13
+ * TODO: [🍭] Make .book.md file with examples of the FOREACH with wrong parsing and logic
14
+ */
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Represents a command that expects a specific format.
3
+ *
4
+ * Note: [🚉] This is fully serializable as JSON
5
+ */
6
+ export type FormatCommand = {
7
+ readonly type: 'FORMAT';
8
+ readonly format: 'JSON';
9
+ };
@@ -0,0 +1,9 @@
1
+ import type { PipelineTaskCommandParser } from '../_common/types/CommandParser';
2
+ import type { FormatCommand } from './FormatCommand';
3
+ /**
4
+ * Parses the format command
5
+ *
6
+ * @see `documentationUrl` for more details
7
+ * @private within the commands folder
8
+ */
9
+ export declare const formatCommandParser: PipelineTaskCommandParser<FormatCommand>;
@@ -0,0 +1,11 @@
1
+ import type { string_formfactor_name } from '../../formfactors/_common/string_formfactor_name';
2
+ /**
3
+ * Parsed FORMFACTOR command
4
+ *
5
+ * @see ./formfactorCommandParser.ts for more details
6
+ * @private within the commands folder
7
+ */
8
+ export type FormfactorCommand = {
9
+ readonly type: 'FORMFACTOR';
10
+ readonly formfactorName: string_formfactor_name;
11
+ };
@@ -0,0 +1,11 @@
1
+ import type { PipelineHeadCommandParser } from '../_common/types/CommandParser';
2
+ import type { FormfactorCommand } from './FormfactorCommand';
3
+ /**
4
+ * Parses the formfactor command
5
+ *
6
+ * Note: @@@ This command is used as formfactor for new commands - it should NOT be used in any `.book.md` file
7
+ *
8
+ * @see `documentationUrl` for more details
9
+ * @private within the commands folder
10
+ */
11
+ export declare const formfactorCommandParser: PipelineHeadCommandParser<FormfactorCommand>;
@@ -0,0 +1,11 @@
1
+ import type { string_name } from '../../types/typeAliases';
2
+ /**
3
+ * Parsed JOKER command
4
+ *
5
+ * @see ./jokerCommandParser.ts for more details
6
+ * @private within the commands folder
7
+ */
8
+ export type JokerCommand = {
9
+ readonly type: 'JOKER';
10
+ readonly parameterName: string_name;
11
+ };
@@ -0,0 +1,9 @@
1
+ import type { PipelineTaskCommandParser } from '../_common/types/CommandParser';
2
+ import type { JokerCommand } from './JokerCommand';
3
+ /**
4
+ * Parses the joker command
5
+ *
6
+ * @see `documentationUrl` for more details
7
+ * @private within the commands folder
8
+ */
9
+ export declare const jokerCommandParser: PipelineTaskCommandParser<JokerCommand>;
@@ -0,0 +1,11 @@
1
+ import type { string_knowledge_source_content } from '../../types/typeAliases';
2
+ /**
3
+ * Parsed KNOWLEDGE command
4
+ *
5
+ * @see ./knowledgeCommandParser.ts for more details
6
+ * @private within the commands folder
7
+ */
8
+ export type KnowledgeCommand = {
9
+ readonly type: 'KNOWLEDGE';
10
+ readonly sourceContent: string_knowledge_source_content;
11
+ };
@@ -0,0 +1,12 @@
1
+ import type { PipelineHeadCommandParser } from '../_common/types/CommandParser';
2
+ import type { KnowledgeCommand } from './KnowledgeCommand';
3
+ /**
4
+ * Parses the knowledge command
5
+ *
6
+ * @see `documentationUrl` for more details
7
+ * @private within the commands folder
8
+ */
9
+ export declare const knowledgeCommandParser: PipelineHeadCommandParser<KnowledgeCommand>;
10
+ /**
11
+ * Note: [⛱] There are two types of KNOWLEDGE commands *...(read more in [⛱])*
12
+ */
@@ -0,0 +1,11 @@
1
+ import type { string_knowledge_source_content } from '../../../types/typeAliases';
2
+ import type { string_name } from '../../../types/typeAliases';
3
+ /**
4
+ * Creates unique name for the source
5
+ *
6
+ * @private within the repository
7
+ */
8
+ export declare function sourceContentToName(sourceContent: string_knowledge_source_content): string_name;
9
+ /**
10
+ * TODO: [🐱‍🐉][🧠] Make some smart crop NOT source-i-m-pavol-a-develop-... BUT source-i-m-pavol-a-developer-...
11
+ */
@@ -0,0 +1,4 @@
1
+ export {};
2
+ /**
3
+ * TODO: [🐱‍🐉][🧠] Make some smart crop NOT source-i-m-pavol-a-develop-... BUT source-i-m-pavol-a-developer-...
4
+ */