@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,27 @@
1
+ import type { ReadonlyDeep } from 'type-fest';
2
+ import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
3
+ import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
4
+ import type { string_markdown } from '../../types/typeAliases';
5
+ import type { string_parameter_value } from '../../types/typeAliases';
6
+ /**
7
+ * @@@
8
+ *
9
+ * @private internal type of `getKnowledgeFoTask`
10
+ */
11
+ type GetKnowledgeForTaskOptions = {
12
+ /**
13
+ * @@@
14
+ */
15
+ readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
16
+ /**
17
+ * @@@
18
+ */
19
+ readonly task: ReadonlyDeep<TaskJson>;
20
+ };
21
+ /**
22
+ * @@@
23
+ *
24
+ * @private internal utility of `createPipelineExecutor`
25
+ */
26
+ export declare function getKnowledgeForTask(options: GetKnowledgeForTaskOptions): Promise<string_parameter_value & string_markdown>;
27
+ export {};
@@ -0,0 +1,30 @@
1
+ import type { ReadonlyDeep } from 'type-fest';
2
+ import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
3
+ import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
4
+ import type { ReservedParameters } from '../../types/typeAliases';
5
+ /**
6
+ * @@@
7
+ *
8
+ * @private internal type of `getReservedParametersForTask`
9
+ */
10
+ type GetReservedParametersForTaskOptions = {
11
+ /**
12
+ * @@@
13
+ */
14
+ readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
15
+ /**
16
+ * @@@
17
+ */
18
+ readonly task: ReadonlyDeep<TaskJson>;
19
+ /**
20
+ * @@@
21
+ */
22
+ readonly pipelineIdentification: string;
23
+ };
24
+ /**
25
+ * @@@
26
+ *
27
+ * @private internal utility of `createPipelineExecutor`
28
+ */
29
+ export declare function getReservedParametersForTask(options: GetReservedParametersForTaskOptions): Promise<Readonly<ReservedParameters>>;
30
+ export {};
@@ -0,0 +1,7 @@
1
+ import type { EmbeddingVector } from './EmbeddingVector';
2
+ /**
3
+ * Pretty print an embedding vector for logging
4
+ *
5
+ * @public exported from `@promptbook/core`
6
+ */
7
+ export declare function embeddingVectorToString(embeddingVector: Readonly<EmbeddingVector>): string;
@@ -0,0 +1,24 @@
1
+ import type { ErrorJson } from '../../errors/utils/ErrorJson';
2
+ import type { Prompt } from '../../types/Prompt';
3
+ import type { PromptResult } from '../PromptResult';
4
+ /**
5
+ * Report of single prompt execution
6
+ *
7
+ * Note: [🚉] This is fully serializable as JSON
8
+ */
9
+ export type ExecutionPromptReportJson = {
10
+ /**
11
+ * The prompt wich was executed
12
+ */
13
+ readonly prompt: Omit<Prompt, 'pipelineUrl'>;
14
+ /**
15
+ * Result of the prompt execution (if not failed during LLM execution)
16
+ */
17
+ readonly result?: PromptResult;
18
+ /**
19
+ * The error which occured during LLM execution or during postprocessing or expectation checking
20
+ *
21
+ * Note: It makes sense to have both error and result defined, for example when the result not pass expectations
22
+ */
23
+ readonly error?: ErrorJson;
24
+ };
@@ -0,0 +1,41 @@
1
+ import type { string_markdown_text } from '../../types/typeAliases';
2
+ import type { string_pipeline_url } from '../../types/typeAliases';
3
+ import type { string_semantic_version } from '../../types/typeAliases';
4
+ import type { ExecutionPromptReportJson } from './ExecutionPromptReportJson';
5
+ /**
6
+ * ExecutionReport is result of executing one promptbook
7
+ * It is kind of a variant of the promptbook usefull for debugging, logging and transparency for users.
8
+ *
9
+ * It can have 2 formats:
10
+ * - **.md file** created from the **JSON** format
11
+ * - _(this)_ **JSON** format
12
+ *
13
+ * Note: [🚉] This is fully serializable as JSON
14
+ * @see https://github.com/webgptorg/promptbook#execution-report
15
+ */
16
+ export type ExecutionReportJson = {
17
+ /**
18
+ * Unique identifier of the pipeline from promptbook which was executed
19
+ */
20
+ readonly pipelineUrl?: string_pipeline_url;
21
+ /**
22
+ * Title of from promptbook which was executed
23
+ */
24
+ readonly title?: string;
25
+ /**
26
+ * Version from promptbook which was executed
27
+ */
28
+ readonly promptbookUsedVersion: string_semantic_version;
29
+ /**
30
+ * Version from promptbook which was requested by promptbook
31
+ */
32
+ readonly promptbookRequestedVersion?: string_semantic_version;
33
+ /**
34
+ * Description of the promptbook which was executed
35
+ */
36
+ readonly description?: string_markdown_text;
37
+ /**
38
+ * Sequence of tasks in order which were executed
39
+ */
40
+ readonly promptExecutions: ReadonlyArray<ExecutionPromptReportJson>;
41
+ };
@@ -0,0 +1,16 @@
1
+ /**
2
+ * ExecutionReport is result of executing one promptbook
3
+ * It is kind of a variant of the promptbook usefull for debugging, logging and transparency for users.
4
+ *
5
+ * It can have 2 formats:
6
+ * - _(this)_ **.md file** created from the **JSON** format
7
+ * - **JSON** format
8
+ *
9
+ * @see https://github.com/webgptorg/promptbook#execution-report
10
+ */
11
+ export type ExecutionReportString = string & {
12
+ readonly _type: 'ExecutionReportString';
13
+ };
14
+ /**
15
+ * TODO: Better validation or remove branded type and make it just string
16
+ */
@@ -0,0 +1,25 @@
1
+ import type { number_percent } from '../../types/typeAliases';
2
+ /**
3
+ * Options for `executionReportJsonToString`
4
+ *
5
+ * @public exported from `@promptbook/core`
6
+ */
7
+ export type ExecutionReportStringOptions = {
8
+ /**
9
+ * The tax rate to be applied, expressed as a percentage from 0 to 1 (=100%) or even more
10
+ */
11
+ readonly taxRate: number_percent;
12
+ /**
13
+ * The width of the charts in the report
14
+ */
15
+ readonly chartsWidth: number;
16
+ };
17
+ /**
18
+ * Default options for generating an execution report string
19
+ *
20
+ * @public exported from `@promptbook/core`
21
+ */
22
+ export declare const ExecutionReportStringOptionsDefaults: {
23
+ taxRate: number;
24
+ chartsWidth: number;
25
+ };
@@ -0,0 +1,7 @@
1
+ import type { FromtoItems } from '../../utils/FromtoItems';
2
+ /**
3
+ * Count the duration of working time
4
+ *
5
+ * @private within the repository
6
+ */
7
+ export declare function countWorkingDuration(items: FromtoItems): number;
@@ -0,0 +1,15 @@
1
+ import type { ReadonlyDeep } from 'type-fest';
2
+ import type { ExecutionReportJson } from './ExecutionReportJson';
3
+ import type { ExecutionReportString } from './ExecutionReportString';
4
+ import type { ExecutionReportStringOptions } from './ExecutionReportStringOptions';
5
+ /**
6
+ * Converts execution report from JSON to string format
7
+ *
8
+ * @public exported from `@promptbook/core`
9
+ */
10
+ export declare function executionReportJsonToString(executionReportJson: ReadonlyDeep<ExecutionReportJson>, options?: Partial<ExecutionReportStringOptions>): ExecutionReportString;
11
+ /**
12
+ * TODO: Add mermaid chart for every report
13
+ * TODO: [🧠] Allow to filter out some parts of the report by options
14
+ * TODO: [🧠] Should be in generated file GENERATOR_WARNING
15
+ */
@@ -0,0 +1,7 @@
1
+ import type { Promisable } from 'type-fest';
2
+ /**
3
+ * @private still in development [🏳]
4
+ */
5
+ export type AutomaticTranslator = {
6
+ translate(message: string): Promisable<string>;
7
+ };
@@ -0,0 +1,11 @@
1
+ import type { AutomaticTranslator } from './AutomaticTranslator';
2
+ /**
3
+ * This will wrap an automatic translator and log each translation into the console
4
+ *
5
+ * @private still in development [🏳]
6
+ */
7
+ export declare class DebugAutomaticTranslator implements AutomaticTranslator {
8
+ private readonly automaticTranslator;
9
+ constructor(automaticTranslator: AutomaticTranslator);
10
+ translate(message: string): Promise<string>;
11
+ }
@@ -0,0 +1,8 @@
1
+ import type { AutomaticTranslator } from './AutomaticTranslator';
2
+ /**
3
+ * @private still in development [🏳]
4
+ */
5
+ export declare class FakeAutomaticTranslator implements AutomaticTranslator {
6
+ constructor();
7
+ translate(message: string): string;
8
+ }
@@ -0,0 +1,22 @@
1
+ import type { AutomaticTranslator } from './AutomaticTranslator';
2
+ import type { TranslatorOptions } from './TranslatorOptions';
3
+ /**
4
+ * @@@
5
+ */
6
+ type LindatAutomaticTranslatorOptions = TranslatorOptions & {
7
+ /**
8
+ * @@@
9
+ */
10
+ readonly apiUrl?: URL;
11
+ };
12
+ /**
13
+ * @@@
14
+ *
15
+ * @private still in development [🏳]
16
+ */
17
+ export declare class LindatAutomaticTranslator implements AutomaticTranslator {
18
+ protected readonly options: LindatAutomaticTranslatorOptions;
19
+ constructor(options: LindatAutomaticTranslatorOptions);
20
+ translate(message: string): Promise<string>;
21
+ }
22
+ export {};
@@ -0,0 +1,7 @@
1
+ /**
2
+ * @private still in development [🏳]
3
+ */
4
+ export type TranslatorOptions = {
5
+ readonly from?: string;
6
+ readonly to: string;
7
+ };
@@ -0,0 +1,8 @@
1
+ /**
2
+ *
3
+ * @param message
4
+ * @returns
5
+ * @throws {PipelineExecutionError}
6
+ * @private still in development [🏳]
7
+ */
8
+ export declare function extractMultiplicatedOccurrence(message: string): string;
@@ -0,0 +1,12 @@
1
+ import type { AutomaticTranslator } from './automatic-translators/AutomaticTranslator';
2
+ import type { TranslatorOptions } from './automatic-translators/TranslatorOptions';
3
+ /**
4
+ * @private still in development [🏳]
5
+ */
6
+ export declare function translateMessages({ automaticTranslator, from, to, }: {
7
+ automaticTranslator: AutomaticTranslator;
8
+ } & TranslatorOptions): Promise<void>;
9
+ /**
10
+ * TODO: [😶] Unite floder listing
11
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
12
+ */
@@ -0,0 +1,13 @@
1
+ import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
2
+ import type { ExecutionTools } from '../ExecutionTools';
3
+ /**
4
+ * Note: There is unfortunately no equivalent for this function in the browser environment
5
+ * because it is not possible automatically detect configured LLM providers
6
+ * you need to provide them manually BUT you can help by utilities like `$provideScrapersForBrowser`
7
+ *
8
+ * @public exported from `@promptbook/node`
9
+ */
10
+ export declare function $provideExecutionToolsForNode(options?: PrepareAndScrapeOptions): Promise<ExecutionTools>;
11
+ /**
12
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
13
+ */
@@ -0,0 +1,9 @@
1
+ import type { PromptResultUsage } from '../PromptResultUsage';
2
+ /**
3
+ * Function `addUsage` will add multiple usages into one
4
+ *
5
+ * Note: If you provide 0 values, it returns ZERO_USAGE
6
+ *
7
+ * @public exported from `@promptbook/core`
8
+ */
9
+ export declare function addUsage(...usageItems: ReadonlyArray<PromptResultUsage>): PromptResultUsage;
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,29 @@
1
+ import type { Expectations } from '../../pipeline/PipelineJson/Expectations';
2
+ /**
3
+ * Function checkExpectations will check if the expectations on given value are met
4
+ *
5
+ * Note: There are two simmilar functions:
6
+ * - `checkExpectations` which throws an error if the expectations are not met
7
+ * - `isPassingExpectations` which returns a boolean
8
+ *
9
+ * @throws {ExpectError} if the expectations are not met
10
+ * @returns {void} Nothing
11
+ * @private internal function of `createPipelineExecutor`
12
+ */
13
+ export declare function checkExpectations(expectations: Expectations, value: string): void;
14
+ /**
15
+ * Function checkExpectations will check if the expectations on given value are met
16
+ *
17
+ * Note: There are two simmilar functions:
18
+ * - `checkExpectations` which throws an error if the expectations are not met
19
+ * - `isPassingExpectations` which returns a boolean
20
+ *
21
+ * @returns {boolean} True if the expectations are met
22
+ * @public exported from `@promptbook/core`
23
+ */
24
+ export declare function isPassingExpectations(expectations: Expectations, value: string): boolean;
25
+ /**
26
+ * TODO: [💝] Unite object for expecting amount and format
27
+ * TODO: [🧠][🤠] This should be part of `TextFormatDefinition`
28
+ * Note: [💝] and [🤠] are interconnected together
29
+ */
@@ -0,0 +1,10 @@
1
+ import type { PromptResultUsageCounts } from '../PromptResultUsage';
2
+ /**
3
+ * Helper of usage compute
4
+ *
5
+ * @param content the content of prompt or response
6
+ * @returns part of PromptResultUsageCounts
7
+ *
8
+ * @private internal utility of LlmExecutionTools
9
+ */
10
+ export declare function computeUsageCounts(content: string): Omit<PromptResultUsageCounts, 'tokensCount'>;
@@ -0,0 +1,20 @@
1
+ import type { Promisable } from 'type-fest';
2
+ type ForEachAsyncOptions = {
3
+ /**
4
+ * Maximum number of tasks running in parallel
5
+ *
6
+ * @default Infinity
7
+ */
8
+ readonly maxParallelCount?: number;
9
+ };
10
+ /**
11
+ * Async version of Array.forEach
12
+ *
13
+ * @param array - Array to iterate over
14
+ * @param options - Options for the function
15
+ * @param callbackfunction - Function to call for each item
16
+ * @public exported from `@promptbook/utils`
17
+ * @deprecated [🪂] Use queues instead
18
+ */
19
+ export declare function forEachAsync<TItem>(array: ReadonlyArray<TItem>, options: ForEachAsyncOptions, callbackfunction: (value: TItem, index: number, array: ReadonlyArray<TItem>) => Promisable<void>): Promise<void>;
20
+ export {};
@@ -0,0 +1,9 @@
1
+ import type { UncertainNumber } from '../UncertainNumber';
2
+ /**
3
+ * Make UncertainNumber
4
+ *
5
+ * @param value
6
+ *
7
+ * @private utility for initializating UncertainNumber
8
+ */
9
+ export declare function uncertainNumber(value?: number | typeof NaN | undefined | null): UncertainNumber;
@@ -0,0 +1,130 @@
1
+ /**
2
+ * Represents the usage with no resources consumed
3
+ *
4
+ * @public exported from `@promptbook/core`
5
+ */
6
+ export declare const ZERO_USAGE: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
7
+ readonly price: {
8
+ readonly value: 0;
9
+ };
10
+ readonly input: {
11
+ readonly tokensCount: {
12
+ readonly value: 0;
13
+ };
14
+ readonly charactersCount: {
15
+ readonly value: 0;
16
+ };
17
+ readonly wordsCount: {
18
+ readonly value: 0;
19
+ };
20
+ readonly sentencesCount: {
21
+ readonly value: 0;
22
+ };
23
+ readonly linesCount: {
24
+ readonly value: 0;
25
+ };
26
+ readonly paragraphsCount: {
27
+ readonly value: 0;
28
+ };
29
+ readonly pagesCount: {
30
+ readonly value: 0;
31
+ };
32
+ };
33
+ readonly output: {
34
+ readonly tokensCount: {
35
+ readonly value: 0;
36
+ };
37
+ readonly charactersCount: {
38
+ readonly value: 0;
39
+ };
40
+ readonly wordsCount: {
41
+ readonly value: 0;
42
+ };
43
+ readonly sentencesCount: {
44
+ readonly value: 0;
45
+ };
46
+ readonly linesCount: {
47
+ readonly value: 0;
48
+ };
49
+ readonly paragraphsCount: {
50
+ readonly value: 0;
51
+ };
52
+ readonly pagesCount: {
53
+ readonly value: 0;
54
+ };
55
+ };
56
+ }>;
57
+ /**
58
+ * Represents the usage with unknown resources consumed
59
+ *
60
+ * @public exported from `@promptbook/core`
61
+ */
62
+ export declare const UNCERTAIN_USAGE: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
63
+ readonly price: {
64
+ readonly value: 0;
65
+ readonly isUncertain: true;
66
+ };
67
+ readonly input: {
68
+ readonly tokensCount: {
69
+ readonly value: 0;
70
+ readonly isUncertain: true;
71
+ };
72
+ readonly charactersCount: {
73
+ readonly value: 0;
74
+ readonly isUncertain: true;
75
+ };
76
+ readonly wordsCount: {
77
+ readonly value: 0;
78
+ readonly isUncertain: true;
79
+ };
80
+ readonly sentencesCount: {
81
+ readonly value: 0;
82
+ readonly isUncertain: true;
83
+ };
84
+ readonly linesCount: {
85
+ readonly value: 0;
86
+ readonly isUncertain: true;
87
+ };
88
+ readonly paragraphsCount: {
89
+ readonly value: 0;
90
+ readonly isUncertain: true;
91
+ };
92
+ readonly pagesCount: {
93
+ readonly value: 0;
94
+ readonly isUncertain: true;
95
+ };
96
+ };
97
+ readonly output: {
98
+ readonly tokensCount: {
99
+ readonly value: 0;
100
+ readonly isUncertain: true;
101
+ };
102
+ readonly charactersCount: {
103
+ readonly value: 0;
104
+ readonly isUncertain: true;
105
+ };
106
+ readonly wordsCount: {
107
+ readonly value: 0;
108
+ readonly isUncertain: true;
109
+ };
110
+ readonly sentencesCount: {
111
+ readonly value: 0;
112
+ readonly isUncertain: true;
113
+ };
114
+ readonly linesCount: {
115
+ readonly value: 0;
116
+ readonly isUncertain: true;
117
+ };
118
+ readonly paragraphsCount: {
119
+ readonly value: 0;
120
+ readonly isUncertain: true;
121
+ };
122
+ readonly pagesCount: {
123
+ readonly value: 0;
124
+ readonly isUncertain: true;
125
+ };
126
+ };
127
+ }>;
128
+ /**
129
+ * Note: [💞] Ignore a discrepancy between file name and entity name
130
+ */
@@ -0,0 +1,16 @@
1
+ import type { string_markdown } from '../../types/typeAliases';
2
+ import type { PromptResultUsage } from '../PromptResultUsage';
3
+ /**
4
+ * Function `usageToHuman` will take usage and convert it to human readable report
5
+ *
6
+ * @public exported from `@promptbook/core`
7
+ */
8
+ export declare function usageToHuman(usage: PromptResultUsage): string_markdown;
9
+ /**
10
+ * TODO: [🍓][🧞‍♂️] Use "$1" not "1 USD"
11
+ * TODO: [🍓][🧞‍♂️] Use markdown formatting like "Cost approximately **$1**"
12
+ * TODO: [🍓][🧞‍♂️] Report in minutes, seconds, days NOT 0.1 hours
13
+ * TODO: [🧠] Maybe make from `uncertainNumberToHuman` separate exported utility
14
+ * TODO: [🧠] Maybe use "~" instead of "approximately"
15
+ * TODO: [🏛] Maybe make some markdown builder
16
+ */
@@ -0,0 +1,12 @@
1
+ import type { PromptResultUsage } from '../PromptResultUsage';
2
+ import type { UncertainNumber } from '../UncertainNumber';
3
+ /**
4
+ * Function usageToWorktime will take usage and estimate saved worktime in hours of reading / writing
5
+ *
6
+ * Note: This is an estimate based of theese sources:
7
+ * - https://jecas.cz/doba-cteni
8
+ * - https://www.originalnitonery.cz/blog/psani-vsemi-deseti-se-muzete-naucit-i-sami-doma
9
+ *
10
+ * @public exported from `@promptbook/core`
11
+ */
12
+ export declare function usageToWorktime(usage: PromptResultUsage): UncertainNumber;
@@ -0,0 +1,9 @@
1
+ import type { string_name } from '../../types/typeAliases';
2
+ /**
3
+ * @private still in development
4
+ */
5
+ export declare function isDomainNameFree(name: string_name): Promise<boolean>;
6
+ /**
7
+ * TODO: [🍓][🧠] Test and implement `isDomainNameFree`
8
+ * TODO: Export via some (and probably new) NPM package
9
+ */
@@ -0,0 +1,9 @@
1
+ import type { string_name } from '../../types/typeAliases';
2
+ /**
3
+ * @private still in development
4
+ */
5
+ export declare function isGithubNameFree(name: string_name): Promise<boolean>;
6
+ /**
7
+ * TODO: [🍓][🧠] Test and implement `isGithubNameFree`
8
+ * TODO: Export via some (and probably new) NPM package
9
+ */
@@ -0,0 +1,70 @@
1
+ import type { string_mime_type } from '../../types/typeAliases';
2
+ import type { string_name } from '../../types/typeAliases';
3
+ import type { string_SCREAMING_CASE } from '../../utils/normalization/normalizeTo_SCREAMING_CASE';
4
+ import type { empty_object } from '../../utils/organization/empty_object';
5
+ import type { FormatSubvalueDefinition } from './FormatSubvalueDefinition';
6
+ /**
7
+ * A format definition is a set of functions that define how to validate, heal and convert response from LLM
8
+ *
9
+ * @@@ Describe setting vs schema
10
+ *
11
+ * @see https://github.com/webgptorg/promptbook/discussions/36
12
+ * @private still in development [🏢]
13
+ */
14
+ export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends string, TSettings extends empty_object, TSchema extends empty_object> = {
15
+ /**
16
+ * The name of the format used in .book.md files
17
+ *
18
+ * @example "JSON"
19
+ */
20
+ readonly formatName: string_name & string_SCREAMING_CASE;
21
+ /**
22
+ * Aliases for the `formatName`
23
+ */
24
+ readonly aliases?: ReadonlyArray<string_name & string_SCREAMING_CASE>;
25
+ /**
26
+ * The mime type of the format (if any)
27
+ *
28
+ * @example "application/json"
29
+ */
30
+ readonly mimeType?: string_mime_type;
31
+ /**
32
+ * Check if a value is fully valid
33
+ *
34
+ * @param value The value to check, for example "{\"foo\": true}"
35
+ * @param schema Optional schema to do extra validation
36
+ */
37
+ isValid(value: string, settings?: TSettings, schema?: TSchema): value is TValue;
38
+ /**
39
+ * Check if a first part of a value is valid
40
+ *
41
+ * @see https://github.com/webgptorg/promptbook/discussions/37
42
+ *
43
+ * @param partialValue Partial value to check, for example "{\"foo\": t"
44
+ * @param schema Optional schema to do extra validation
45
+ */
46
+ canBeValid(partialValue: string, settings?: TSettings, schema?: TSchema): partialValue is TPartialValue;
47
+ /**
48
+ * Heal a value to make it valid if possible
49
+ *
50
+ * Note: This make sense in context of LLMs that often returns slightly invalid values
51
+ * @see https://github.com/webgptorg/promptbook/discussions/31
52
+ *
53
+ * @param value The value to heal, for example "{foo: true}"
54
+ * @param scheme
55
+ * @throws {Error} If the value cannot be healed
56
+ */
57
+ heal(value: string, settings?: TSettings, scheme?: TSchema): TValue;
58
+ /**
59
+ * @@@
60
+ */
61
+ readonly subvalueDefinitions: ReadonlyArray<FormatSubvalueDefinition<TValue, TSettings>>;
62
+ };
63
+ /**
64
+ * TODO: [♏] Add some prepare hook to modify prompt according to the format
65
+ * TODO: [🍓]`name` and `aliases` should be UPPERCASE only and interpreted as case-insensitive (via normalization)
66
+ * TODO: [🍓][👨‍⚖️] Compute TPartialValue dynamically - PartialString<TValue>
67
+ * TODO: [🍓][🧠] Should execution tools be aviable to heal, canBeValid and isValid?
68
+ * TODO: [🍓][🧠] llm Provider Bindings
69
+ * TODO: [🍓][🔼] Export via some package
70
+ */